Merge branch 'menu-command-api' of github.com:jonnytest1/workadventure into metadataScriptingApi

front/src/Api/Events/IframeEvent.ts

@@ -5,6 +5,8 @@ import type { ChatEvent } from './ChatEvent';
 import type { ClosePopupEvent } from './ClosePopupEvent';
 import type { EnterLeaveEvent } from './EnterLeaveEvent';
 import type { GoToPageEvent } from './GoToPageEvent';
+import type { MenuItemClickedEvent } from './MenuItemClickedEvent';
+import type { MenuItemRegisterEvent } from './MenuItemRegisterEvent';
 import type { HasPlayerMovedEvent } from './HasPlayerMovedEvent';
 import type { OpenCoWebSiteEvent } from './OpenCoWebSiteEvent';
 import type { OpenPopupEvent } from './OpenPopupEvent';
@@ -21,6 +23,7 @@ export interface TypedMessageEvent<T> extends MessageEvent {
 export type IframeEventMap = {
     getState: GameStateEvent,
     // updateTile: UpdateTileEvent
+    registerMenuCommand: MenuItemRegisterEvent
     chat: ChatEvent,
     openPopup: OpenPopupEvent
     closePopup: ClosePopupEvent
@@ -56,6 +59,7 @@ export interface IframeResponseEventMap {
     gameState: GameStateEvent
     hasPlayerMoved: HasPlayerMovedEvent
     dataLayer: DataLayerEvent
+    menuItemClicked: MenuItemClickedEvent
 }
 export interface IframeResponseEvent<T extends keyof IframeResponseEventMap> {
     type: T;

front/src/Api/Events/MenuItemClickedEvent.ts

@@ -0,0 +1,10 @@
+import * as tg from "generic-type-guard";
+
+export const isMenuItemClickedEvent =
+    new tg.IsInterface().withProperties({
+        menuItem: tg.isString
+    }).get();
+/**
+ * A message sent from the game to the iFrame when a menu item is clicked.
+ */
+export type MenuItemClickedEvent = tg.GuardedType<typeof isMenuItemClickedEvent>;

front/src/Api/Events/MenuItemRegisterEvent.ts

@@ -0,0 +1,10 @@
+import * as tg from "generic-type-guard";
+
+export const isMenuItemRegisterEvent =
+    new tg.IsInterface().withProperties({
+        menutItem: tg.isString
+    }).get();
+/**
+ * A message sent from the iFrame to the game to add a new menu item.
+ */
+export type MenuItemRegisterEvent = tg.GuardedType<typeof isMenuItemRegisterEvent>;

front/src/Api/IframeListener.ts

@@ -17,7 +17,8 @@ import type { GameStateEvent } from './Events/GameStateEvent';
 import type { HasPlayerMovedEvent } from './Events/HasPlayerMovedEvent';
 import { Math } from 'phaser';
 import type { DataLayerEvent } from "./Events/DataLayerEvent";
-
+import { isMenuItemRegisterEvent } from './Events/MenuItemRegisterEvent';
+import type { MenuItemClickedEvent } from './Events/MenuItemClickedEvent';
 
 
 /**
@@ -74,6 +75,8 @@ class IframeListener {
     private readonly _dataLayerChangeStream: Subject<void> = new Subject();
     public readonly dataLayerChangeStream = this._dataLayerChangeStream.asObservable();
 
+    private readonly _registerMenuCommandStream: Subject<string> = new Subject();
+    public readonly registerMenuCommandStream = this._registerMenuCommandStream.asObservable();
     private readonly iframes = new Set<HTMLIFrameElement>();
     private readonly scripts = new Map<string, HTMLIFrameElement>();
     private sendPlayerMove: boolean = false;
@@ -140,6 +143,8 @@ class IframeListener {
                     this.sendPlayerMove = true
                 } else if (payload.type == "getDataLayer") {
                     this._dataLayerChangeStream.next();
+                } else if (payload.type == "registerMenuCommand" && isMenuItemRegisterEvent(payload.data)) {
+                    this._registerMenuCommandStream.next(payload.data.menutItem)
                 }
             }
         }, false);
@@ -237,6 +242,15 @@ class IframeListener {
         this.scripts.delete(scriptUrl);
     }
 
+    sendMenuClickedEvent(menuItem: string) {
+        this.postMessage({
+            'type': 'menuItemClicked',
+            'data': {
+                menuItem: menuItem,
+            } as MenuItemClickedEvent
+        });
+    }
+
     sendUserInputChat(message: string) {
         this.postMessage({
             'type': 'userInputChat',