@workadventure/iframe-api-typings 1.19.7 → 1.20.0

package/package.json

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

package/play/src/front/Api/Events/GameStateEvent.d.ts

@@ -17,9 +17,9 @@ export declare const isGameStateEvent: z.ZodObject<{
     isLogged: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
 }, "strip", z.ZodTypeAny, {
     metadata?: unknown;
+    uuid?: string | undefined;
     variables?: unknown;
     userRoomToken?: string | undefined;
-    uuid?: string | undefined;
     language?: string | undefined;
     playerId?: number | undefined;
     startLayerName?: string | undefined;
@@ -33,10 +33,10 @@ export declare const isGameStateEvent: z.ZodObject<{
     nickname: string;
 }, {
     metadata?: unknown;
+    uuid?: string | undefined;
     variables?: unknown;
     userRoomToken?: string | undefined;
     isLogged?: boolean | undefined;
-    uuid?: string | undefined;
     language?: string | undefined;
     playerId?: number | undefined;
     startLayerName?: string | undefined;

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

@@ -1589,6 +1589,24 @@ export declare const isIframeEventWrapper: z.ZodUnion<[z.ZodObject<{
 }, {
     data?: undefined;
     type: "restoreInviteUserButton";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"disableRoomList">;
+    data: z.ZodUndefined;
+}, "strip", z.ZodTypeAny, {
+    data?: undefined;
+    type: "disableRoomList";
+}, {
+    data?: undefined;
+    type: "disableRoomList";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"restoreRoomList">;
+    data: z.ZodUndefined;
+}, "strip", z.ZodTypeAny, {
+    data?: undefined;
+    type: "restoreRoomList";
+}, {
+    data?: undefined;
+    type: "restoreRoomList";
 }>]>;
 export type IframeEvent = z.infer<typeof isIframeEventWrapper>;
 export declare const isIframeResponseEvent: z.ZodUnion<[z.ZodObject<{
@@ -3323,9 +3341,9 @@ export declare const iframeQueryMapTypeGuards: {
             isLogged: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
         }, "strip", z.ZodTypeAny, {
             metadata?: unknown;
+            uuid?: string | undefined;
             variables?: unknown;
             userRoomToken?: string | undefined;
-            uuid?: string | undefined;
             language?: string | undefined;
             playerId?: number | undefined;
             startLayerName?: string | undefined;
@@ -3339,10 +3357,10 @@ export declare const iframeQueryMapTypeGuards: {
             nickname: string;
         }, {
             metadata?: unknown;
+            uuid?: string | undefined;
             variables?: unknown;
             userRoomToken?: string | undefined;
             isLogged?: boolean | undefined;
-            uuid?: string | undefined;
             language?: string | undefined;
             playerId?: number | undefined;
             startLayerName?: string | undefined;
@@ -3501,6 +3519,22 @@ export declare const iframeQueryMapTypeGuards: {
         }>;
         answer: z.ZodUndefined;
     };
+    triggerPlayerMessage: {
+        query: z.ZodObject<{
+            message: z.ZodString;
+            uuid: z.ZodString;
+            type: z.ZodEnum<["message", "warning"]>;
+        }, "strip", z.ZodTypeAny, {
+            message: string;
+            type: "message" | "warning";
+            uuid: string;
+        }, {
+            message: string;
+            type: "message" | "warning";
+            uuid: string;
+        }>;
+        answer: z.ZodUndefined;
+    };
     removeActionMessage: {
         query: z.ZodObject<{
             uuid: z.ZodString;
@@ -3511,6 +3545,16 @@ export declare const iframeQueryMapTypeGuards: {
         }>;
         answer: z.ZodUndefined;
     };
+    removePlayerMessage: {
+        query: z.ZodObject<{
+            uuid: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            uuid: string;
+        }, {
+            uuid: string;
+        }>;
+        answer: z.ZodUndefined;
+    };
     getEmbeddedWebsite: {
         query: z.ZodString;
         answer: z.ZodObject<{
@@ -4203,15 +4247,15 @@ export interface IframeQueryWrapper<T extends keyof IframeQueryMap> {
     id: number;
     query: IframeQuery<T>;
 }
-export declare const isIframeQueryKey: (type: string) => type is "setVariable" | "triggerActionMessage" | "removeActionMessage" | "dispatchEvent" | "modifyArea" | "setPlayerVariable" | "getState" | "getMapData" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "goToLogin" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite" | "createArea" | "getArea" | "deleteArea" | "setPlayerOutline" | "removePlayerOutline" | "getPlayerPosition" | "movePlayerTo" | "teleportPlayerTo" | "openUIWebsite" | "closeUIWebsite" | "getUIWebsites" | "getUIWebsiteById" | "enablePlayersTracking" | "getWoka" | "playSoundInBubble" | "followMe" | "stopLeading";
-export declare const isIframeQuery: (event: any) => event is IframeQuery<"setVariable" | "triggerActionMessage" | "removeActionMessage" | "dispatchEvent" | "modifyArea" | "setPlayerVariable" | "getState" | "getMapData" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "goToLogin" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite" | "createArea" | "getArea" | "deleteArea" | "setPlayerOutline" | "removePlayerOutline" | "getPlayerPosition" | "movePlayerTo" | "teleportPlayerTo" | "openUIWebsite" | "closeUIWebsite" | "getUIWebsites" | "getUIWebsiteById" | "enablePlayersTracking" | "getWoka" | "playSoundInBubble" | "followMe" | "stopLeading">;
-export declare const isIframeQueryWrapper: (event: any) => event is IframeQueryWrapper<"setVariable" | "triggerActionMessage" | "removeActionMessage" | "dispatchEvent" | "modifyArea" | "setPlayerVariable" | "getState" | "getMapData" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "goToLogin" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite" | "createArea" | "getArea" | "deleteArea" | "setPlayerOutline" | "removePlayerOutline" | "getPlayerPosition" | "movePlayerTo" | "teleportPlayerTo" | "openUIWebsite" | "closeUIWebsite" | "getUIWebsites" | "getUIWebsiteById" | "enablePlayersTracking" | "getWoka" | "playSoundInBubble" | "followMe" | "stopLeading">;
+export declare const isIframeQueryKey: (type: string) => type is "setVariable" | "triggerActionMessage" | "removeActionMessage" | "dispatchEvent" | "modifyArea" | "setPlayerVariable" | "getState" | "getMapData" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "goToLogin" | "triggerPlayerMessage" | "removePlayerMessage" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite" | "createArea" | "getArea" | "deleteArea" | "setPlayerOutline" | "removePlayerOutline" | "getPlayerPosition" | "movePlayerTo" | "teleportPlayerTo" | "openUIWebsite" | "closeUIWebsite" | "getUIWebsites" | "getUIWebsiteById" | "enablePlayersTracking" | "getWoka" | "playSoundInBubble" | "followMe" | "stopLeading";
+export declare const isIframeQuery: (event: any) => event is IframeQuery<"setVariable" | "triggerActionMessage" | "removeActionMessage" | "dispatchEvent" | "modifyArea" | "setPlayerVariable" | "getState" | "getMapData" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "goToLogin" | "triggerPlayerMessage" | "removePlayerMessage" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite" | "createArea" | "getArea" | "deleteArea" | "setPlayerOutline" | "removePlayerOutline" | "getPlayerPosition" | "movePlayerTo" | "teleportPlayerTo" | "openUIWebsite" | "closeUIWebsite" | "getUIWebsites" | "getUIWebsiteById" | "enablePlayersTracking" | "getWoka" | "playSoundInBubble" | "followMe" | "stopLeading">;
+export declare const isIframeQueryWrapper: (event: any) => event is IframeQueryWrapper<"setVariable" | "triggerActionMessage" | "removeActionMessage" | "dispatchEvent" | "modifyArea" | "setPlayerVariable" | "getState" | "getMapData" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "goToLogin" | "triggerPlayerMessage" | "removePlayerMessage" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite" | "createArea" | "getArea" | "deleteArea" | "setPlayerOutline" | "removePlayerOutline" | "getPlayerPosition" | "movePlayerTo" | "teleportPlayerTo" | "openUIWebsite" | "closeUIWebsite" | "getUIWebsites" | "getUIWebsiteById" | "enablePlayersTracking" | "getWoka" | "playSoundInBubble" | "followMe" | "stopLeading">;
 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" | "dispatchEvent" | "modifyArea" | "setPlayerVariable" | "getState" | "getMapData" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "goToLogin" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite" | "createArea" | "getArea" | "deleteArea" | "setPlayerOutline" | "removePlayerOutline" | "getPlayerPosition" | "movePlayerTo" | "teleportPlayerTo" | "openUIWebsite" | "closeUIWebsite" | "getUIWebsites" | "getUIWebsiteById" | "enablePlayersTracking" | "getWoka" | "playSoundInBubble" | "followMe" | "stopLeading">;
+export declare const isIframeAnswerEvent: (event: any) => event is IframeAnswerEvent<"setVariable" | "triggerActionMessage" | "removeActionMessage" | "dispatchEvent" | "modifyArea" | "setPlayerVariable" | "getState" | "getMapData" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "goToLogin" | "triggerPlayerMessage" | "removePlayerMessage" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite" | "createArea" | "getArea" | "deleteArea" | "setPlayerOutline" | "removePlayerOutline" | "getPlayerPosition" | "movePlayerTo" | "teleportPlayerTo" | "openUIWebsite" | "closeUIWebsite" | "getUIWebsites" | "getUIWebsiteById" | "enablePlayersTracking" | "getWoka" | "playSoundInBubble" | "followMe" | "stopLeading">;
 export declare const isIframeErrorAnswerEvent: z.ZodObject<{
     id: z.ZodNumber;
     type: z.ZodString;

package/play/src/front/Api/Events/Ui/TriggerPlayerMessageEvent.d.ts

@@ -0,0 +1,27 @@
+import { z } from "zod";
+export declare const triggerPlayerMessage = "triggerPlayerMessage";
+export declare const removePlayerMessage = "removePlayerMessage";
+export declare const isPlayerMessageType: z.ZodEnum<["message"]>;
+export type PlayerMessageType = z.infer<typeof isPlayerMessageType>;
+export declare const isTriggerPlayerMessageEvent: z.ZodObject<{
+    message: z.ZodString;
+    uuid: z.ZodString;
+    type: z.ZodEnum<["message"]>;
+}, "strip", z.ZodTypeAny, {
+    message: string;
+    type: "message";
+    uuid: string;
+}, {
+    message: string;
+    type: "message";
+    uuid: string;
+}>;
+export type TriggerPlayerMessageEvent = z.infer<typeof isTriggerPlayerMessageEvent>;
+export declare const isMessageReferenceEvent: z.ZodObject<{
+    uuid: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    uuid: string;
+}, {
+    uuid: string;
+}>;
+export type MessageReferenceEvent = z.infer<typeof isMessageReferenceEvent>;

package/play/src/front/Api/Iframe/Ui/PlayerMessage.d.ts

@@ -0,0 +1,12 @@
+import type { PlayerMessageOptions } from "../ui";
+export declare class PlayerMessage {
+    private onRemove;
+    readonly uuid: string;
+    private readonly type;
+    private readonly message;
+    private readonly callback;
+    constructor(playerMessageOptions: PlayerMessageOptions, onRemove: () => void);
+    private create;
+    remove(): Promise<void>;
+    triggerCallback(): void;
+}

package/play/src/front/Api/Iframe/controls.d.ts

@@ -101,6 +101,16 @@ export declare class WorkadventureControlsCommands extends IframeApiContribution
      * {@link https://workadventu.re/map-building/api-controls.md#disabling--restoring-invite-user-button | Website documentation}
      */
     restoreInviteButton(): void;
+    /**
+     * Disable room list.
+     * {@link https://workadventu.re/map-building/api-controls.md#disabling--restoring-room-list | Website documentation}
+     */
+    disableRoomList(): void;
+    /**
+     * Restore room list.
+     * {@link https://workadventu.re/map-building/api-controls.md#disabling--restoring-room-list | Website documentation}
+     */
+    restoreRoomList(): void;
 }
 declare const _default: WorkadventureControlsCommands;
 export default _default;

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

@@ -5,6 +5,7 @@ import { IframeApiContribution } from "./IframeApiContribution";
 import type { ButtonDescriptor } from "./Ui/ButtonDescriptor";
 import { Popup } from "./Ui/Popup";
 import { ActionMessage } from "./Ui/ActionMessage";
+import { PlayerMessage } from "./Ui/PlayerMessage";
 import { Menu } from "./Ui/Menu";
 import type { UIWebsiteCommands } from "./Ui/UIWebsite";
 import { RemotePlayer } from "./Players/RemotePlayer";
@@ -26,6 +27,11 @@ export interface ActionMessageOptions {
     type?: "message" | "warning";
     callback: () => void;
 }
+export interface PlayerMessageOptions {
+    message: string;
+    type?: "message";
+    callback: () => void;
+}
 export declare class ActionsMenuAction {
     private remotePlayer;
     private key;
@@ -121,6 +127,14 @@ export declare class WorkAdventureUiCommands extends IframeApiContribution<WorkA
      * @returns {ActionMessage} Trigger action message
      */
     displayActionMessage(actionMessageOptions: ActionMessageOptions): ActionMessage;
+    /**
+     * Displays a player message at the top of the user head (that will disappear when space bar is pressed).
+     * {@link https://workadventu.re/map-building/api-ui.md#awaiting-user-confirmation-with-space-bar | Website documentation}
+     *
+     * @param {PlayerMessageOptions} playerMessageOptions player options
+     * @returns {PlayerMessage} Trigger player message
+     */
+    displayPlayerMessage(playerMessageOptions: PlayerMessageOptions): PlayerMessage;
     get website(): UIWebsiteCommands;
     get modal(): WorkadventureModalCommands;
     get actionBar(): WorkAdventureButtonActionBarCommands;