@workadventure/iframe-api-typings 1.16.7 → 1.16.10

package/front/Api/Events/IframeEvent.d.ts

@@ -652,6 +652,7 @@ export declare const isIframeEventWrapper: z.ZodUnion<[z.ZodObject<{
     data: z.ZodObject<{
         name: z.ZodString;
         iframe: z.ZodOptional<z.ZodString>;
+        key: z.ZodString;
         options: z.ZodObject<{
             allowApi: z.ZodBoolean;
         }, "strip", z.ZodTypeAny, {
@@ -665,12 +666,14 @@ export declare const isIframeEventWrapper: z.ZodUnion<[z.ZodObject<{
             allowApi: boolean;
         };
         name: string;
+        key: string;
     }, {
         iframe?: string | undefined;
         options: {
             allowApi: boolean;
         };
         name: string;
+        key: string;
     }>;
 }, "strip", z.ZodTypeAny, {
     type: "registerMenu";
@@ -680,6 +683,7 @@ export declare const isIframeEventWrapper: z.ZodUnion<[z.ZodObject<{
             allowApi: boolean;
         };
         name: string;
+        key: string;
     };
 }, {
     type: "registerMenu";
@@ -689,25 +693,45 @@ export declare const isIframeEventWrapper: z.ZodUnion<[z.ZodObject<{
             allowApi: boolean;
         };
         name: string;
+        key: string;
     };
 }>, z.ZodObject<{
     type: z.ZodLiteral<"unregisterMenu">;
     data: z.ZodObject<{
-        name: z.ZodString;
+        key: z.ZodString;
     }, "strip", z.ZodTypeAny, {
-        name: string;
+        key: string;
     }, {
-        name: string;
+        key: string;
     }>;
 }, "strip", z.ZodTypeAny, {
     type: "unregisterMenu";
     data: {
-        name: string;
+        key: string;
     };
 }, {
     type: "unregisterMenu";
     data: {
-        name: string;
+        key: string;
+    };
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"openMenu">;
+    data: z.ZodObject<{
+        key: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        key: string;
+    }, {
+        key: string;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "openMenu";
+    data: {
+        key: string;
+    };
+}, {
+    type: "openMenu";
+    data: {
+        key: string;
     };
 }>, z.ZodObject<{
     type: z.ZodLiteral<"setTiles">;
@@ -2777,6 +2801,10 @@ export declare const iframeQueryMapTypeGuards: {
         query: z.ZodUndefined;
         answer: z.ZodUndefined;
     };
+    goToLogin: {
+        query: z.ZodUndefined;
+        answer: z.ZodUndefined;
+    };
     triggerActionMessage: {
         query: z.ZodObject<{
             message: z.ZodString;
@@ -3464,15 +3492,15 @@ export interface IframeQueryWrapper<T extends keyof IframeQueryMap> {
     id: number;
     query: IframeQuery<T>;
 }
-export declare const isIframeQueryKey: (type: string) => type is "setVariable" | "triggerActionMessage" | "removeActionMessage" | "modifyArea" | "setPlayerVariable" | "getState" | "getMapData" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite" | "createArea" | "getArea" | "deleteArea" | "setPlayerOutline" | "removePlayerOutline" | "getPlayerPosition" | "movePlayerTo" | "openUIWebsite" | "closeUIWebsite" | "getUIWebsites" | "getUIWebsiteById" | "enablePlayersTracking" | "getWoka";
-export declare const isIframeQuery: (event: any) => event is IframeQuery<"setVariable" | "triggerActionMessage" | "removeActionMessage" | "modifyArea" | "setPlayerVariable" | "getState" | "getMapData" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite" | "createArea" | "getArea" | "deleteArea" | "setPlayerOutline" | "removePlayerOutline" | "getPlayerPosition" | "movePlayerTo" | "openUIWebsite" | "closeUIWebsite" | "getUIWebsites" | "getUIWebsiteById" | "enablePlayersTracking" | "getWoka">;
-export declare const isIframeQueryWrapper: (event: any) => event is IframeQueryWrapper<"setVariable" | "triggerActionMessage" | "removeActionMessage" | "modifyArea" | "setPlayerVariable" | "getState" | "getMapData" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite" | "createArea" | "getArea" | "deleteArea" | "setPlayerOutline" | "removePlayerOutline" | "getPlayerPosition" | "movePlayerTo" | "openUIWebsite" | "closeUIWebsite" | "getUIWebsites" | "getUIWebsiteById" | "enablePlayersTracking" | "getWoka">;
+export declare const isIframeQueryKey: (type: string) => type is "setVariable" | "triggerActionMessage" | "removeActionMessage" | "modifyArea" | "setPlayerVariable" | "getState" | "getMapData" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "goToLogin" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite" | "createArea" | "getArea" | "deleteArea" | "setPlayerOutline" | "removePlayerOutline" | "getPlayerPosition" | "movePlayerTo" | "openUIWebsite" | "closeUIWebsite" | "getUIWebsites" | "getUIWebsiteById" | "enablePlayersTracking" | "getWoka";
+export declare const isIframeQuery: (event: any) => event is IframeQuery<"setVariable" | "triggerActionMessage" | "removeActionMessage" | "modifyArea" | "setPlayerVariable" | "getState" | "getMapData" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "goToLogin" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite" | "createArea" | "getArea" | "deleteArea" | "setPlayerOutline" | "removePlayerOutline" | "getPlayerPosition" | "movePlayerTo" | "openUIWebsite" | "closeUIWebsite" | "getUIWebsites" | "getUIWebsiteById" | "enablePlayersTracking" | "getWoka">;
+export declare const isIframeQueryWrapper: (event: any) => event is IframeQueryWrapper<"setVariable" | "triggerActionMessage" | "removeActionMessage" | "modifyArea" | "setPlayerVariable" | "getState" | "getMapData" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "goToLogin" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite" | "createArea" | "getArea" | "deleteArea" | "setPlayerOutline" | "removePlayerOutline" | "getPlayerPosition" | "movePlayerTo" | "openUIWebsite" | "closeUIWebsite" | "getUIWebsites" | "getUIWebsiteById" | "enablePlayersTracking" | "getWoka">;
 export interface IframeAnswerEvent<T extends keyof IframeQueryMap> {
     id: number;
     type: T;
     data: IframeQueryMap[T]["answer"];
 }
-export declare const isIframeAnswerEvent: (event: any) => event is IframeAnswerEvent<"setVariable" | "triggerActionMessage" | "removeActionMessage" | "modifyArea" | "setPlayerVariable" | "getState" | "getMapData" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite" | "createArea" | "getArea" | "deleteArea" | "setPlayerOutline" | "removePlayerOutline" | "getPlayerPosition" | "movePlayerTo" | "openUIWebsite" | "closeUIWebsite" | "getUIWebsites" | "getUIWebsiteById" | "enablePlayersTracking" | "getWoka">;
+export declare const isIframeAnswerEvent: (event: any) => event is IframeAnswerEvent<"setVariable" | "triggerActionMessage" | "removeActionMessage" | "modifyArea" | "setPlayerVariable" | "getState" | "getMapData" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "goToLogin" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite" | "createArea" | "getArea" | "deleteArea" | "setPlayerOutline" | "removePlayerOutline" | "getPlayerPosition" | "movePlayerTo" | "openUIWebsite" | "closeUIWebsite" | "getUIWebsites" | "getUIWebsiteById" | "enablePlayersTracking" | "getWoka">;
 export declare const isIframeErrorAnswerEvent: z.ZodObject<{
     id: z.ZodNumber;
     type: z.ZodString;

package/front/Api/Events/Ui/{MenuRegisterEvent.d.ts → MenuEvents.d.ts}

@@ -3,11 +3,11 @@ import { z } from "zod";
  * A message sent from a script to the game to remove a custom menu from the menu
  */
 export declare const isUnregisterMenuEvent: z.ZodObject<{
-    name: z.ZodString;
+    key: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    name: string;
+    key: string;
 }, {
-    name: string;
+    key: string;
 }>;
 export type UnregisterMenuEvent = z.infer<typeof isUnregisterMenuEvent>;
 export declare const isMenuRegisterOptions: z.ZodObject<{
@@ -23,6 +23,7 @@ export declare const isMenuRegisterOptions: z.ZodObject<{
 export declare const isMenuRegisterEvent: z.ZodObject<{
     name: z.ZodString;
     iframe: z.ZodOptional<z.ZodString>;
+    key: z.ZodString;
     options: z.ZodObject<{
         allowApi: z.ZodBoolean;
     }, "strip", z.ZodTypeAny, {
@@ -36,11 +37,24 @@ export declare const isMenuRegisterEvent: z.ZodObject<{
         allowApi: boolean;
     };
     name: string;
+    key: string;
 }, {
     iframe?: string | undefined;
     options: {
         allowApi: boolean;
     };
     name: string;
+    key: string;
 }>;
 export type MenuRegisterEvent = z.infer<typeof isMenuRegisterEvent>;
+/**
+ * A message sent from a script to the game to open a menu
+ */
+export declare const isOpenMenuEvent: z.ZodObject<{
+    key: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    key: string;
+}, {
+    key: string;
+}>;
+export type OpenMenuEvent = z.infer<typeof isOpenMenuEvent>;

package/front/Api/Iframe/Ui/Menu.d.ts

@@ -1,8 +1,12 @@
 export declare class Menu {
-    private menuName;
-    constructor(menuName: string);
+    private key;
+    constructor(key: string);
     /**
      * remove the menu
      */
     remove(): void;
+    /**
+     * Programmatically open the menu (only works if the menu has been defined with the "iframe" property)
+     */
+    open(): void;
 }

package/front/Api/Iframe/nav.d.ts

@@ -53,6 +53,10 @@ export declare class WorkadventureNavigationCommands extends IframeApiContributi
      * @deprecated Use closeCoWebsites instead to close all co-websites
      */
     closeCoWebSite(): Promise<void>;
+    /**
+     * Redirect the user to the OIDC login page
+     */
+    goToLogin(): Promise<void>;
 }
 declare const _default: WorkadventureNavigationCommands;
 export default _default;

package/front/Api/Iframe/ui.d.ts

@@ -15,6 +15,10 @@ interface MenuDescriptor {
     callback?: (commandDescriptor: string) => void;
     iframe?: string;
     allowApi?: boolean;
+    /**
+     * A unique technical key identifying this menu
+     */
+    key?: string;
 }
 export type MenuOptions = RequireOnlyOne<MenuDescriptor, "callback" | "iframe">;
 export interface ActionMessageOptions {
@@ -91,6 +95,12 @@ export declare class WorkAdventureUiCommands extends IframeApiContribution<WorkA
      * @returns {Menu} Menu created
      */
     registerMenuCommand(commandDescriptor: string, options: MenuOptions | ((commandDescriptor: string) => void)): Menu;
+    /**
+     * Retrieves a menu from its key.
+     * Keys are set when the menu is created with `registerMenuCommand`
+     * In addition, the standard menus have the following keys: "settings", "profile", "invite", "credit", "globalMessages", "contact", "report"
+     */
+    getMenuCommand(key: string): Promise<Menu>;
     addActionsMenuKeyToRemotePlayer(id: number, actionKey: string): void;
     removeActionsMenuKeyFromRemotePlayer(id: number, actionKey: string): void;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@workadventure/iframe-api-typings",
-  "version": "v1.16.7",
+  "version": "v1.16.10",
   "description": "Typescript typings for WorkAdventure iFrame API",
   "main": "iframe_api.js",
   "types": "iframe_api.d.ts",