workadventure/front/src/iframe_api.ts

import type { ChatEvent } from "./Api/Events/ChatEvent";
import { IframeEvent, IframeEventMap, isIframeResponseEventWrapper } from "./Api/Events/IframeEvent";
import { isUserInputChatEvent, UserInputChatEvent } from "./Api/Events/UserInputChatEvent";
import { Subject } from "rxjs";
import { EnterLeaveEvent, isEnterLeaveEvent } from "./Api/Events/EnterLeaveEvent";
import type { OpenPopupEvent } from "./Api/Events/OpenPopupEvent";
import { isButtonClickedEvent } from "./Api/Events/ButtonClickedEvent";
import type { ClosePopupEvent } from "./Api/Events/ClosePopupEvent";
import type { OpenTabEvent } from "./Api/Events/OpenTabEvent";
import type { GoToPageEvent } from "./Api/Events/GoToPageEvent";
import type { OpenCoWebSiteEvent } from "./Api/Events/OpenCoWebSiteEvent";
import type { LayerEvent } from "./Api/Events/LayerEvent";
import type { SetPropertyEvent } from "./Api/Events/setPropertyEvent";
import { GameStateEvent, isGameStateEvent } from './Api/Events/GameStateEvent';
import { HasPlayerMovedEvent, HasPlayerMovedEventCallback, isHasPlayerMovedEvent } from './Api/Events/HasPlayerMovedEvent';
import { DataLayerEvent, isDataLayerEvent } from "./Api/Events/DataLayerEvent";
import type { ITiledMap } from "./Phaser/Map/ITiledMap";
import type { MenuItemRegisterEvent } from "./Api/Events/MenuItemRegisterEvent";
import { isMenuItemClickedEvent } from "./Api/Events/MenuItemClickedEvent";
import type { PlaySoundEvent } from "./Api/Events/PlaySoundEvent";
import type  { StopSoundEvent } from "./Api/Events/StopSoundEvent";
import type { LoadSoundEvent } from "./Api/Events/LoadSoundEvent";
import SoundConfig = Phaser.Types.Sound.SoundConfig;

interface WorkAdventureApi {
    sendChatMessage(message: string, author: string): void;
    onChatMessage(callback: (message: string) => void): void;
    onEnterZone(name: string, callback: () => void): void;
    onLeaveZone(name: string, callback: () => void): void;
    openPopup(targetObject: string, message: string, buttons: ButtonDescriptor[]): Popup;
    openTab(url: string): void;
    goToPage(url: string): void;
    openCoWebSite(url: string): void;
    closeCoWebSite(): void;
    disablePlayerControls() : void;
    restorePlayerControls() : void;
    displayBubble() : void;
    removeBubble() : void;
    showLayer(layer: string) : void;
    hideLayer(layer: string) : void;
    setProperty(layerName: string, propertyName: string, propertyValue: string | number | boolean | undefined): void;
    disablePlayerControls(): void;
    restorePlayerControls(): void;
    displayBubble(): void;
    removeBubble(): void;
    loadSound(url : string): Sound;
    registerMenuCommand(commandDescriptor: string, callback: (commandDescriptor: string) => void): void
    getCurrentUser(): Promise<User>
    getCurrentRoom(): Promise<Room>
    onPlayerMove(callback: (playerMovedEvent: HasPlayerMovedEvent) => void): void
}

interface User {
    id: string | undefined
    nickName: string | null
    tags: string[]
}

interface Room {
    id: string
    mapUrl: string
    map: ITiledMap
    startLayer: string | null
}

declare global {
    // eslint-disable-next-line no-var
    var WA: WorkAdventureApi

}

type ChatMessageCallback = (message: string) => void;
type ButtonClickedCallback = (popup: Popup) => void;

const userInputChatStream: Subject<UserInputChatEvent> = new Subject();
const enterStreams: Map<string, Subject<EnterLeaveEvent>> = new Map<string, Subject<EnterLeaveEvent>>();
const leaveStreams: Map<string, Subject<EnterLeaveEvent>> = new Map<string, Subject<EnterLeaveEvent>>();
const popups: Map<number, Popup> = new Map<number, Popup>();
const popupCallbacks: Map<number, Map<number, ButtonClickedCallback>> = new Map<number, Map<number, ButtonClickedCallback>>();
const menuCallbacks: Map<string, (command: string) => void> = new Map()
let popupId = 0;
interface ButtonDescriptor {
    /**
     * The label of the button
     */
    label: string,
    /**
     * The type of the button. Can be one of "normal", "primary", "success", "warning", "error", "disabled"
     */
    className?: "normal" | "primary" | "success" | "warning" | "error" | "disabled",
    /**
     * Callback called if the button is pressed
     */
    callback: ButtonClickedCallback,
}

export class Popup {
    constructor(private id: number) {
    }

    /**
     * Closes the popup
     */
    public close(): void {
        window.parent.postMessage({
            'type': 'closePopup',
            'data': {
                'popupId': this.id,
            } as ClosePopupEvent
        }, '*');
    }
}

export class Sound {
    constructor(private url: string) {
        window.parent.postMessage({
            "type" : 'loadSound',
            "data": {
                url: this.url,
            } as LoadSoundEvent

        },'*');
    }

    public play(config : SoundConfig) {
        window.parent.postMessage({
            "type" : 'playSound',
            "data": {
                url: this.url,
                config
            } as PlaySoundEvent

        },'*');
        return this.url;
    }
    public stop() {
        window.parent.postMessage({
            "type" : 'stopSound',
            "data": {
                url: this.url,
            } as StopSoundEvent

        },'*');
        return this.url;
    }

}

function getGameState(): Promise<GameStateEvent> {
    if (immutableData) {
        return Promise.resolve(immutableData);
    }
    else {
        return new Promise<GameStateEvent>((resolver, thrower) => {
            gameStateResolver.push(resolver);
            window.parent.postMessage({
                type: "getState"
            }, "*")
        })
    }
}

function getDataLayer(): Promise<DataLayerEvent> {
    return new Promise<DataLayerEvent>((resolver, thrower) => {
        dataLayerResolver.push(resolver);
        postToParent({
            type: "getDataLayer",
            data: undefined
        })
    })
}

const gameStateResolver: Array<(event: GameStateEvent) => void> = []
const dataLayerResolver: Array<(event: DataLayerEvent) => void> = []
let immutableData: GameStateEvent;

const callbackPlayerMoved: Array<(event: HasPlayerMovedEvent) => void> = []

function postToParent(content: IframeEvent<keyof IframeEventMap>) {
    window.parent.postMessage(content, "*")
}

window.WA = {

    onPlayerMove(callback: HasPlayerMovedEventCallback): void {
        callbackPlayerMoved.push(callback);
        postToParent({
            type: "onPlayerMove",
            data: undefined
        })
    },

    getCurrentUser(): Promise<User> {
        return getGameState().then((gameState) => {
            return {id: gameState.uuid, nickName: gameState.nickname, tags: gameState.tags};
        })
    },

    getCurrentRoom(): Promise<Room> {
        return getGameState().then((gameState) => {
            return getDataLayer().then((mapJson) => {
                return {id: gameState.roomId, map: mapJson.data as ITiledMap, mapUrl: gameState.mapUrl, startLayer: gameState.startLayerName};
            })
        })
    },

    /**
     * Send a message in the chat.
     * Only the local user will receive this message.
     */
    sendChatMessage(message: string, author: string) {
        window.parent.postMessage({
            'type': 'chat',
            'data': {
                'message': message,
                'author': author
            } as ChatEvent
        }, '*');
    },

    showLayer(layer: string) : void {
      window.parent.postMessage({
          'type' : 'showLayer',
          'data' : {
              'name' : layer
          } as LayerEvent
      }, '*');
    },

    hideLayer(layer: string) : void {
        window.parent.postMessage({
            'type' : 'hideLayer',
            'data' : {
                'name' : layer
            } as LayerEvent
        }, '*');
    },

    setProperty(layerName: string, propertyName: string, propertyValue: string | number | boolean | undefined): void {
        window.parent.postMessage({
           'type' : 'setProperty',
           'data' : {
               'layerName' : layerName,
               'propertyName' : propertyName,
               'propertyValue' : propertyValue
           } as SetPropertyEvent
        }, '*');
    },

    disablePlayerControls(): void {
        window.parent.postMessage({ 'type': 'disablePlayerControls' }, '*');
    },

    restorePlayerControls(): void {
        window.parent.postMessage({ 'type': 'restorePlayerControls' }, '*');
    },

    displayBubble(): void {
        window.parent.postMessage({ 'type': 'displayBubble' }, '*');
    },

    removeBubble(): void {
        window.parent.postMessage({ 'type': 'removeBubble' }, '*');
    },

    openTab(url: string): void {
        window.parent.postMessage({
            "type": 'openTab',
            "data": {
                url
            } as OpenTabEvent
        }, '*');
    },

    loadSound(url: string) : Sound {
        return new Sound(url);
    },

    goToPage(url : string) : void{
        window.parent.postMessage({
            "type": 'goToPage',
            "data": {
                url
            } as GoToPageEvent
        }, '*');
    },

    openCoWebSite(url: string): void {
        window.parent.postMessage({
            "type": 'openCoWebSite',
            "data": {
                url
            } as OpenCoWebSiteEvent
        }, '*');
    },

    closeCoWebSite(): void {
        window.parent.postMessage({
            "type": 'closeCoWebSite'
        }, '*');
    },

    openPopup(targetObject: string, message: string, buttons: ButtonDescriptor[]): Popup {
        popupId++;
        const popup = new Popup(popupId);
        const btnMap = new Map<number, () => void>();
        popupCallbacks.set(popupId, btnMap);
        let id = 0;
        for (const button of buttons) {
            const callback = button.callback;
            if (callback) {
                btnMap.set(id, () => {
                    callback(popup);
                });
            }
            id++;
        }


        window.parent.postMessage({
            'type': 'openPopup',
            'data': {
                popupId,
                targetObject,
                message,
                buttons: buttons.map((button) => {
                    return {
                        label: button.label,
                        className: button.className
                    };
                })
            } as OpenPopupEvent
        }, '*');

        popups.set(popupId, popup)
        return popup;
    },

    registerMenuCommand(commandDescriptor: string, callback: (commandDescriptor: string) => void): void {
        menuCallbacks.set(commandDescriptor, callback);
        window.parent.postMessage({
            'type': 'registerMenuCommand',
            'data': {
                menutItem: commandDescriptor
            } as MenuItemRegisterEvent
        }, '*');
    },
    /**
     * Listen to messages sent by the local user, in the chat.
     */
    onChatMessage(callback: ChatMessageCallback): void {
        userInputChatStream.subscribe((userInputChatEvent) => {
            callback(userInputChatEvent.message);
        });
    },
    onEnterZone(name: string, callback: () => void): void {
        let subject = enterStreams.get(name);
        if (subject === undefined) {
            subject = new Subject<EnterLeaveEvent>();
            enterStreams.set(name, subject);
        }
        subject.subscribe(callback);
    },
    onLeaveZone(name: string, callback: () => void): void {
        let subject = leaveStreams.get(name);
        if (subject === undefined) {
            subject = new Subject<EnterLeaveEvent>();
            leaveStreams.set(name, subject);
        }
        subject.subscribe(callback);
    },
}

window.addEventListener('message', message => {
    if (message.source !== window.parent) {
        return; // Skip message in this event listener
    }

    const payload = message.data;

    console.debug(payload);

    if (isIframeResponseEventWrapper(payload)) {
        const payloadData = payload.data;
        if (payload.type === 'userInputChat' && isUserInputChatEvent(payloadData)) {
            userInputChatStream.next(payloadData);
        } else if (payload.type === 'enterEvent' && isEnterLeaveEvent(payloadData)) {
            enterStreams.get(payloadData.name)?.next();
        } else if (payload.type === 'leaveEvent' && isEnterLeaveEvent(payloadData)) {
            leaveStreams.get(payloadData.name)?.next();
        } else if (payload.type === 'buttonClickedEvent' && isButtonClickedEvent(payloadData)) {
            const callback = popupCallbacks.get(payloadData.popupId)?.get(payloadData.buttonId);
            const popup = popups.get(payloadData.popupId);
            if (popup === undefined) {
                throw new Error('Could not find popup with ID "' + payloadData.popupId + '"');
            }
            if (callback) {
                callback(popup);
            }
        } else if (payload.type == "gameState" && isGameStateEvent(payloadData)) {
            gameStateResolver.forEach(resolver => {
                resolver(payloadData);
            })
            immutableData = payloadData;
        } else if (payload.type == "hasPlayerMoved" && isHasPlayerMovedEvent(payloadData)) {
            callbackPlayerMoved.forEach(callback => {
                callback(payloadData);
            })
        } else if (payload.type == "dataLayer" && isDataLayerEvent(payloadData)) {
            dataLayerResolver.forEach(resolver => {
                resolver(payloadData);
            })
        } else if (payload.type == "menuItemClicked" && isMenuItemClickedEvent(payloadData)) {
            const callback = menuCallbacks.get(payloadData.menuItem);
            if (callback) {
                callback(payloadData.menuItem)
            }
        }
    }

    // ...
});