@workadventure/iframe-api-typings 1.18.11 → 1.19.0

package/package.json

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

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

@@ -1,9 +1,12 @@
 import { z } from "zod";
 export declare const isCameraFollowPlayerEvent: z.ZodObject<{
     smooth: z.ZodBoolean;
+    duration: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
+    duration?: number | undefined;
     smooth: boolean;
 }, {
+    duration?: number | undefined;
     smooth: boolean;
 }>;
 /**

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

@@ -6,9 +6,11 @@ export declare const isCameraSetEvent: z.ZodObject<{
     height: z.ZodOptional<z.ZodNumber>;
     lock: z.ZodBoolean;
     smooth: z.ZodBoolean;
+    duration: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
     height?: number | undefined;
     width?: number | undefined;
+    duration?: number | undefined;
     x: number;
     y: number;
     lock: boolean;
@@ -16,6 +18,7 @@ export declare const isCameraSetEvent: z.ZodObject<{
 }, {
     height?: number | undefined;
     width?: number | undefined;
+    duration?: number | undefined;
     x: number;
     y: number;
     lock: boolean;

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

@@ -209,19 +209,24 @@ export declare const isIframeEventWrapper: z.ZodUnion<[z.ZodObject<{
     type: z.ZodLiteral<"cameraFollowPlayer">;
     data: z.ZodObject<{
         smooth: z.ZodBoolean;
+        duration: z.ZodOptional<z.ZodNumber>;
     }, "strip", z.ZodTypeAny, {
+        duration?: number | undefined;
         smooth: boolean;
     }, {
+        duration?: number | undefined;
         smooth: boolean;
     }>;
 }, "strip", z.ZodTypeAny, {
     type: "cameraFollowPlayer";
     data: {
+        duration?: number | undefined;
         smooth: boolean;
     };
 }, {
     type: "cameraFollowPlayer";
     data: {
+        duration?: number | undefined;
         smooth: boolean;
     };
 }>, z.ZodObject<{
@@ -233,9 +238,11 @@ export declare const isIframeEventWrapper: z.ZodUnion<[z.ZodObject<{
         height: z.ZodOptional<z.ZodNumber>;
         lock: z.ZodBoolean;
         smooth: z.ZodBoolean;
+        duration: z.ZodOptional<z.ZodNumber>;
     }, "strip", z.ZodTypeAny, {
         height?: number | undefined;
         width?: number | undefined;
+        duration?: number | undefined;
         x: number;
         y: number;
         lock: boolean;
@@ -243,6 +250,7 @@ export declare const isIframeEventWrapper: z.ZodUnion<[z.ZodObject<{
     }, {
         height?: number | undefined;
         width?: number | undefined;
+        duration?: number | undefined;
         x: number;
         y: number;
         lock: boolean;
@@ -253,6 +261,7 @@ export declare const isIframeEventWrapper: z.ZodUnion<[z.ZodObject<{
     data: {
         height?: number | undefined;
         width?: number | undefined;
+        duration?: number | undefined;
         x: number;
         y: number;
         lock: boolean;
@@ -263,6 +272,7 @@ export declare const isIframeEventWrapper: z.ZodUnion<[z.ZodObject<{
     data: {
         height?: number | undefined;
         width?: number | undefined;
+        duration?: number | undefined;
         x: number;
         y: number;
         lock: boolean;
@@ -1489,6 +1499,96 @@ export declare const isIframeEventWrapper: z.ZodUnion<[z.ZodObject<{
         name: string;
         uuid: string;
     };
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"disableMapEditor">;
+    data: z.ZodUndefined;
+}, "strip", z.ZodTypeAny, {
+    data?: undefined;
+    type: "disableMapEditor";
+}, {
+    data?: undefined;
+    type: "disableMapEditor";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"restoreMapEditor">;
+    data: z.ZodUndefined;
+}, "strip", z.ZodTypeAny, {
+    data?: undefined;
+    type: "restoreMapEditor";
+}, {
+    data?: undefined;
+    type: "restoreMapEditor";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"disableScreenSharing">;
+    data: z.ZodUndefined;
+}, "strip", z.ZodTypeAny, {
+    data?: undefined;
+    type: "disableScreenSharing";
+}, {
+    data?: undefined;
+    type: "disableScreenSharing";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"restoreScreenSharing">;
+    data: z.ZodUndefined;
+}, "strip", z.ZodTypeAny, {
+    data?: undefined;
+    type: "restoreScreenSharing";
+}, {
+    data?: undefined;
+    type: "restoreScreenSharing";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"disableRightClick">;
+    data: z.ZodUndefined;
+}, "strip", z.ZodTypeAny, {
+    data?: undefined;
+    type: "disableRightClick";
+}, {
+    data?: undefined;
+    type: "disableRightClick";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"restoreRightClick">;
+    data: z.ZodUndefined;
+}, "strip", z.ZodTypeAny, {
+    data?: undefined;
+    type: "restoreRightClick";
+}, {
+    data?: undefined;
+    type: "restoreRightClick";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"disableWheelZoom">;
+    data: z.ZodUndefined;
+}, "strip", z.ZodTypeAny, {
+    data?: undefined;
+    type: "disableWheelZoom";
+}, {
+    data?: undefined;
+    type: "disableWheelZoom";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"restoreWheelZoom">;
+    data: z.ZodUndefined;
+}, "strip", z.ZodTypeAny, {
+    data?: undefined;
+    type: "restoreWheelZoom";
+}, {
+    data?: undefined;
+    type: "restoreWheelZoom";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"disableInviteUserButton">;
+    data: z.ZodUndefined;
+}, "strip", z.ZodTypeAny, {
+    data?: undefined;
+    type: "disableInviteUserButton";
+}, {
+    data?: undefined;
+    type: "disableInviteUserButton";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"restoreInviteUserButton">;
+    data: z.ZodUndefined;
+}, "strip", z.ZodTypeAny, {
+    data?: undefined;
+    type: "restoreInviteUserButton";
+}, {
+    data?: undefined;
+    type: "restoreInviteUserButton";
 }>]>;
 export type IframeEvent = z.infer<typeof isIframeEventWrapper>;
 export declare const isIframeResponseEvent: z.ZodUnion<[z.ZodObject<{
@@ -1830,6 +1930,210 @@ export declare const isIframeResponseEvent: z.ZodUnion<[z.ZodObject<{
 }, {
     data?: undefined;
     type: "leaveProximityMeetingEvent";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"onFollowed">;
+    data: z.ZodObject<{
+        user: z.ZodObject<{
+            playerId: z.ZodNumber;
+            name: z.ZodString;
+            userUuid: z.ZodString;
+            availabilityStatus: z.ZodString;
+            outlineColor: z.ZodOptional<z.ZodNumber>;
+            position: z.ZodObject<{
+                x: z.ZodNumber;
+                y: z.ZodNumber;
+            }, "strip", z.ZodTypeAny, {
+                x: number;
+                y: number;
+            }, {
+                x: number;
+                y: number;
+            }>;
+            variables: z.ZodMap<z.ZodString, z.ZodUnknown>;
+        }, "strip", z.ZodTypeAny, {
+            outlineColor?: number | undefined;
+            name: string;
+            availabilityStatus: string;
+            position: {
+                x: number;
+                y: number;
+            };
+            userUuid: string;
+            variables: Map<string, unknown>;
+            playerId: number;
+        }, {
+            outlineColor?: number | undefined;
+            name: string;
+            availabilityStatus: string;
+            position: {
+                x: number;
+                y: number;
+            };
+            userUuid: string;
+            variables: Map<string, unknown>;
+            playerId: number;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        user: {
+            outlineColor?: number | undefined;
+            name: string;
+            availabilityStatus: string;
+            position: {
+                x: number;
+                y: number;
+            };
+            userUuid: string;
+            variables: Map<string, unknown>;
+            playerId: number;
+        };
+    }, {
+        user: {
+            outlineColor?: number | undefined;
+            name: string;
+            availabilityStatus: string;
+            position: {
+                x: number;
+                y: number;
+            };
+            userUuid: string;
+            variables: Map<string, unknown>;
+            playerId: number;
+        };
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "onFollowed";
+    data: {
+        user: {
+            outlineColor?: number | undefined;
+            name: string;
+            availabilityStatus: string;
+            position: {
+                x: number;
+                y: number;
+            };
+            userUuid: string;
+            variables: Map<string, unknown>;
+            playerId: number;
+        };
+    };
+}, {
+    type: "onFollowed";
+    data: {
+        user: {
+            outlineColor?: number | undefined;
+            name: string;
+            availabilityStatus: string;
+            position: {
+                x: number;
+                y: number;
+            };
+            userUuid: string;
+            variables: Map<string, unknown>;
+            playerId: number;
+        };
+    };
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"onUnfollowed">;
+    data: z.ZodObject<{
+        user: z.ZodObject<{
+            playerId: z.ZodNumber;
+            name: z.ZodString;
+            userUuid: z.ZodString;
+            availabilityStatus: z.ZodString;
+            outlineColor: z.ZodOptional<z.ZodNumber>;
+            position: z.ZodObject<{
+                x: z.ZodNumber;
+                y: z.ZodNumber;
+            }, "strip", z.ZodTypeAny, {
+                x: number;
+                y: number;
+            }, {
+                x: number;
+                y: number;
+            }>;
+            variables: z.ZodMap<z.ZodString, z.ZodUnknown>;
+        }, "strip", z.ZodTypeAny, {
+            outlineColor?: number | undefined;
+            name: string;
+            availabilityStatus: string;
+            position: {
+                x: number;
+                y: number;
+            };
+            userUuid: string;
+            variables: Map<string, unknown>;
+            playerId: number;
+        }, {
+            outlineColor?: number | undefined;
+            name: string;
+            availabilityStatus: string;
+            position: {
+                x: number;
+                y: number;
+            };
+            userUuid: string;
+            variables: Map<string, unknown>;
+            playerId: number;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        user: {
+            outlineColor?: number | undefined;
+            name: string;
+            availabilityStatus: string;
+            position: {
+                x: number;
+                y: number;
+            };
+            userUuid: string;
+            variables: Map<string, unknown>;
+            playerId: number;
+        };
+    }, {
+        user: {
+            outlineColor?: number | undefined;
+            name: string;
+            availabilityStatus: string;
+            position: {
+                x: number;
+                y: number;
+            };
+            userUuid: string;
+            variables: Map<string, unknown>;
+            playerId: number;
+        };
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "onUnfollowed";
+    data: {
+        user: {
+            outlineColor?: number | undefined;
+            name: string;
+            availabilityStatus: string;
+            position: {
+                x: number;
+                y: number;
+            };
+            userUuid: string;
+            variables: Map<string, unknown>;
+            playerId: number;
+        };
+    };
+}, {
+    type: "onUnfollowed";
+    data: {
+        user: {
+            outlineColor?: number | undefined;
+            name: string;
+            availabilityStatus: string;
+            position: {
+                x: number;
+                y: number;
+            };
+            userUuid: string;
+            variables: Map<string, unknown>;
+            playerId: number;
+        };
+    };
 }>, z.ZodObject<{
     type: z.ZodLiteral<"enterEvent">;
     data: z.ZodObject<{
@@ -3874,6 +4178,14 @@ export declare const iframeQueryMapTypeGuards: {
         }>;
         answer: z.ZodUndefined;
     };
+    followMe: {
+        query: z.ZodUndefined;
+        answer: z.ZodUndefined;
+    };
+    stopLeading: {
+        query: z.ZodUndefined;
+        answer: z.ZodUndefined;
+    };
 };
 type IframeQueryMapTypeGuardsType = typeof iframeQueryMapTypeGuards;
 type UnknownToVoid<T> = undefined extends T ? void : T;
@@ -3891,15 +4203,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";
-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">;
-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">;
+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 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">;
+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 isIframeErrorAnswerEvent: z.ZodObject<{
     id: z.ZodNumber;
     type: z.ZodString;

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

@@ -1,15 +1,19 @@
 import type { Observable } from "rxjs";
 import { Subject } from "rxjs";
-export declare abstract class AbstractWorkadventureStateCommands {
+export declare abstract class AbstractWorkadventureStateCommands<State extends {
+    [key: string]: unknown;
+}> {
     protected setVariableResolvers: Subject<{
         value?: unknown;
         key: string;
     }>;
-    protected variables: Map<string, unknown>;
-    protected variableSubscribers: Map<string, Subject<unknown>>;
+    protected variables: Partial<State>;
+    protected variableSubscribers: Partial<{
+        [K in keyof State]: Subject<State[K]>;
+    }>;
     protected constructor();
     initVariables(_variables: Map<string, unknown>): void;
-    loadVariable(key: string): unknown;
-    hasVariable(key: string): boolean;
-    onVariableChange(key: string): Observable<unknown>;
+    loadVariable<K extends keyof State>(key: K): State[K] | undefined;
+    hasVariable<K extends keyof State>(key: K): boolean;
+    onVariableChange<K extends keyof State>(key: K): Observable<State[K]>;
 }

package/play/src/front/Api/Iframe/Player/ProximityMeeting.d.ts

@@ -2,6 +2,12 @@ import { Subject } from "rxjs";
 import { IframeApiContribution } from "../IframeApiContribution";
 import { RemotePlayer } from "../Players/RemotePlayer";
 export declare class WorkadventureProximityMeetingCommands extends IframeApiContribution<WorkadventureProximityMeetingCommands> {
+    private joinStream;
+    private participantJoinStream;
+    private participantLeaveStream;
+    private followedStream;
+    private unfollowedStream;
+    private leaveStream;
     callbacks: ({
         type: "joinProximityMeetingEvent";
         callback: (event: {
@@ -53,6 +59,38 @@ export declare class WorkadventureProximityMeetingCommands extends IframeApiCont
     } | {
         type: "leaveProximityMeetingEvent";
         callback: (event: undefined) => void;
+    } | {
+        type: "onFollowed";
+        callback: (event: {
+            user: {
+                outlineColor?: number | undefined;
+                name: string;
+                availabilityStatus: string;
+                position: {
+                    x: number;
+                    y: number;
+                };
+                userUuid: string;
+                variables: Map<string, unknown>;
+                playerId: number;
+            };
+        }) => void;
+    } | {
+        type: "onUnfollowed";
+        callback: (event: {
+            user: {
+                outlineColor?: number | undefined;
+                name: string;
+                availabilityStatus: string;
+                position: {
+                    x: number;
+                    y: number;
+                };
+                userUuid: string;
+                variables: Map<string, unknown>;
+                playerId: number;
+            };
+        }) => void;
     })[];
     /**
      * Detecting when the user enter on a meeting.
@@ -77,10 +115,26 @@ export declare class WorkadventureProximityMeetingCommands extends IframeApiCont
     onParticipantLeave(): Subject<RemotePlayer>;
     /**
      * Detecting when the user leave on a meeting.
-     * {@link https://workadventu.re/map-building/api-player.md#detecting-when-the-user-entersleaves-a-meeting | Website documentation}
+     * {@link https://docs.workadventu.re/developer/map-scripting/references/api-player/#detecting-when-the-user-entersleaves-a-meeting | Website documentation}
      */
     onLeave(): Subject<void>;
+    /**
+     * Play a sound to all players in the current meeting.
+     * {@link https://docs.workadventu.re/developer/map-scripting/references/api-player/#playing-a-sound-to-players-in-the-same-meeting | Website documentation}
+     */
     playSound(url: string): Promise<void>;
+    /**
+     * Ask all players in the current meeting to follow the player.
+     * Note that unlike with the "follow" mode in the UI, the other players will automatically follow the player.
+     */
+    followMe(): Promise<void>;
+    stopLeading(): Promise<void>;
+    /**
+     * Triggered when a player starts following us.
+     */
+    onFollowed(): Subject<RemotePlayer>;
+    /**
+     * Triggered when a player stops following us.
+     */
+    onUnfollowed(): Subject<RemotePlayer>;
 }
-declare const _default: WorkadventureProximityMeetingCommands;
-export default _default;

package/play/src/front/Api/Iframe/Players/RemotePlayer.d.ts

@@ -3,7 +3,7 @@ import { Subject } from "rxjs";
 import type { AddPlayerEvent } from "../../Events/AddPlayerEvent";
 import type { PlayerPosition } from "../../Events/PlayerPosition";
 import { ActionsMenuAction } from "../ui";
-export declare const remotePlayers: Map<number, RemotePlayer>;
+import { PublicPlayerState, ReadOnlyPublicPlayerState } from "../PublicPlayerState";
 export interface RemotePlayerInterface {
     /**
      * A unique ID for this player. Each character on the map has a unique ID
@@ -33,18 +33,13 @@ export interface RemotePlayerInterface {
     /**
      * An object storing players variables
      */
-    readonly state: ReadOnlyState;
+    readonly state: ReadOnlyPublicPlayerState;
     /**
      * Send an event to the player.
      * Remote player can listen to this event using `WA.event.on(key).subscribe((event) => { ... })`.
      */
     sendEvent(key: string, value: unknown): Promise<void>;
 }
-export type ReadOnlyState = {
-    onVariableChange(key: string): Observable<unknown>;
-} & {
-    readonly [key: string]: unknown;
-};
 export declare class RemotePlayer implements RemotePlayerInterface {
     private _playerId;
     private _name;
@@ -54,7 +49,7 @@ export declare class RemotePlayer implements RemotePlayerInterface {
     private _position;
     private _variables;
     private _variablesSubjects;
-    readonly state: ReadOnlyState;
+    readonly state: ReadOnlyPublicPlayerState;
     private actions;
     constructor(addPlayerEvent: AddPlayerEvent);
     get playerId(): number;
@@ -75,7 +70,7 @@ export declare class RemotePlayer implements RemotePlayerInterface {
         y: number;
     }>;
     destroy(): void;
-    setVariable(name: string, value: unknown): void;
+    setVariable<K extends keyof PublicPlayerState>(name: K, value: PublicPlayerState[K]): void;
     addAction(key: string, callback: () => void): ActionsMenuAction;
     callAction(key: string): void;
     removeAction(key: string): void;

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

@@ -0,0 +1,7 @@
+/**
+ * PrivatePlayerState is the part of the state of a player that is secret (not shared with other players).
+ * The interface is empty. It is meant to be extended by the ScriptingAPI developers to add custom properties.
+ */
+export interface PrivatePlayerState {
+    [key: string]: unknown;
+}

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

@@ -0,0 +1,11 @@
+import { Observable } from "rxjs";
+/**
+ * PublicPlayerState is the part of the state of a player that is shared with other players.
+ * The interface is empty. It is meant to be extended by the ScriptingAPI developers to add custom properties.
+ */
+export interface PublicPlayerState {
+    [key: string]: unknown;
+}
+export type ReadOnlyPublicPlayerState = Readonly<PublicPlayerState> & {
+    onVariableChange<K extends keyof PublicPlayerState>(key: K): Observable<PublicPlayerState[K]>;
+};

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

@@ -0,0 +1,7 @@
+/**
+ * RoomState is the state of a room (i.e. the type associated with the room variables).
+ * The interface is empty. It is meant to be extended by the ScriptingAPI developers to add custom properties.
+ */
+export interface RoomState {
+    [key: string]: unknown;
+}

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

@@ -18,7 +18,7 @@ export declare class WorkAdventureCameraCommands extends IframeApiContribution<W
      *
      * @param smooth Smooth transition
      */
-    followPlayer(smooth?: boolean): void;
+    followPlayer(smooth?: boolean, duration?: number): void;
     /**
      * Set camera to look at given spot. Setting width and height will adjust zoom.
      * Set lock to true to lock camera in this position.
@@ -32,7 +32,7 @@ export declare class WorkAdventureCameraCommands extends IframeApiContribution<W
      * @param {boolean} lock Zoom locked
      * @param {boolean} smooth Smooth transition
      */
-    set(x: number, y: number, width?: number, height?: number, lock?: boolean, smooth?: boolean): void;
+    set(x: number, y: number, width?: number, height?: number, lock?: boolean, smooth?: boolean, duration?: number): void;
     /**
      * Listens to updates of the camera viewport.
      * It will trigger for every update of the camera's properties (position or scale for instance).

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

@@ -2,10 +2,13 @@ import { Subscription } from "rxjs";
 import { SendChatMessageOptions } from "@workadventure/shared-utils";
 import { IframeApiContribution } from "./IframeApiContribution";
 import { RemotePlayerInterface } from "./Players/RemotePlayer";
+import { PublicPlayerState } from "./PublicPlayerState";
 export interface OnChatMessageOptions {
     scope: "local" | "bubble";
 }
-export declare class WorkadventureChatCommands extends IframeApiContribution<WorkadventureChatCommands> {
+export declare class WorkadventureChatCommands<PublicState extends {
+    [key: string]: unknown;
+}> extends IframeApiContribution<WorkadventureChatCommands<PublicState>> {
     callbacks: {
         type: "userInputChat";
         callback: (event: {
@@ -62,5 +65,5 @@ export declare class WorkadventureChatCommands extends IframeApiContribution<Wor
         author: RemotePlayerInterface | undefined;
     }) => void, options?: OnChatMessageOptions): Subscription;
 }
-declare const _default: WorkadventureChatCommands;
+declare const _default: WorkadventureChatCommands<PublicPlayerState>;
 export default _default;

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

@@ -51,6 +51,56 @@ export declare class WorkadventureControlsCommands extends IframeApiContribution
      * {@link https://workadventu.re/map-building/api-controls.md#disabling--restoring-proximity-meeting | Website documentation}
      */
     restorePlayerProximityMeeting(): void;
+    /**
+     * Disable map editor mode.
+     * {@link https://workadventu.re/map-building/api-controls.md#disabling--restoring-map-editor | Website documentation}
+     */
+    disableMapEditor(): void;
+    /**
+     * Restore map editor mode.
+     * {@link https://workadventu.re/map-building/api-controls.md#disabling--restoring-map-editor | Website documentation}
+     */
+    restoreMapEditor(): void;
+    /**
+     * Disable screen sharing.
+     * {@link https://workadventu.re/map-building/api-controls.md#disabling--restoring-screen-sharing | Website documentation}
+     */
+    disableScreenSharing(): void;
+    /**
+     * Restore screen sharing.
+     * {@link https://workadventu.re/map-building/api-controls.md#disabling--restoring-screen-sharing | Website documentation}
+     */
+    restoreScreenSharing(): void;
+    /**
+     * Disable wheel zoom.
+     * {@link https://workadventu.re/map-building/api-controls.md#disabling--restoring-wheel-zoom | Website documentation}
+     */
+    disableWheelZoom(): void;
+    /**
+     * Restore wheel zoom.
+     * {@link https://workadventu.re/map-building/api-controls.md#disabling--restoring-wheel-zoom | Website documentation}
+     */
+    restoreWheelZoom(): void;
+    /**
+     * Disable Right Click.
+     * {@link https://workadventu.re/map-building/api-controls.md#disabling--restoring-right-click | Website documentation}
+     */
+    disableRightClick(): void;
+    /**
+     * Restore Right Click.
+     * {@link https://workadventu.re/map-building/api-controls.md#disabling--restoring-right-click | Website documentation}
+     */
+    restoreRightClick(): void;
+    /**
+     * Disable invite button.
+     * {@link https://workadventu.re/map-building/api-controls.md#disabling--restoring-invite-button | Website documentation}
+     */
+    disableInviteButton(): void;
+    /**
+     * Restore invite button.
+     * {@link https://workadventu.re/map-building/api-controls.md#disabling--restoring-invite-user-button | Website documentation}
+     */
+    restoreInviteButton(): void;
 }
 declare const _default: WorkadventureControlsCommands;
 export default _default;

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

@@ -1,7 +1,7 @@
 import { Subscription } from "rxjs";
 import type { HasPlayerMovedEventCallback } from "../Events/HasPlayerMovedEvent";
 import { IframeApiContribution } from "./IframeApiContribution";
-import type { WorkadventureProximityMeetingCommands } from "./Player/ProximityMeeting";
+import { WorkadventureProximityMeetingCommands } from "./Player/ProximityMeeting";
 export declare const setPlayerName: (name: string) => void;
 export declare const setPlayerLanguage: (language: string | undefined) => void;
 export declare const setTags: (_tags: string[]) => void;
@@ -10,9 +10,8 @@ export declare const setPlayerId: (_id: number | undefined) => void;
 export declare const setUuid: (_uuid: string | undefined) => void;
 export declare const setIsLogged: (_isLogged: boolean | undefined) => void;
 export declare class WorkadventurePlayerCommands extends IframeApiContribution<WorkadventurePlayerCommands> {
-    readonly state: import("./playerState").WorkadventurePlayerStateCommands & {
-        [key: string]: unknown;
-    };
+    readonly state: import("./playerState").WorkadventurePlayerStateCommands & import("./PublicPlayerState").PublicPlayerState & import("./PrivatePlayerState").PrivatePlayerState;
+    private _proximityMeeting;
     callbacks: {
         type: "hasPlayerMoved";
         callback: (event: {

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

@@ -1,5 +1,8 @@
 import { AbstractWorkadventureStateCommands } from "./AbstractState";
-export declare class WorkadventurePlayerStateCommands extends AbstractWorkadventureStateCommands {
+import { PrivatePlayerState } from "./PrivatePlayerState";
+import { PublicPlayerState } from "./PublicPlayerState";
+type PlayerState = PublicPlayerState & PrivatePlayerState;
+export declare class WorkadventurePlayerStateCommands extends AbstractWorkadventureStateCommands<PlayerState> {
     constructor();
     callbacks: {
         type: "setPlayerVariable";
@@ -8,13 +11,12 @@ export declare class WorkadventurePlayerStateCommands extends AbstractWorkadvent
             key: string;
         }) => void;
     }[];
-    saveVariable(key: string, value: unknown, options?: {
+    saveVariable<K extends keyof PlayerState & string>(key: K, value: PlayerState[K], options?: {
         public?: boolean;
         persist?: boolean;
         ttl?: number;
         scope?: "world" | "room";
     }): Promise<void>;
 }
-export declare const playerState: WorkadventurePlayerStateCommands & {
-    [key: string]: unknown;
-};
+export declare const playerState: WorkadventurePlayerStateCommands & PublicPlayerState & PrivatePlayerState;
+export {};

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

@@ -2,13 +2,22 @@ import type { Observable } from "rxjs";
 import { IframeApiContribution } from "./IframeApiContribution";
 import type { RemotePlayerInterface, RemotePlayerMoved } from "./Players/RemotePlayer";
 import { RemotePlayer } from "./Players/RemotePlayer";
-export interface PlayerVariableChanged {
+import { PublicPlayerState } from "./PublicPlayerState";
+export interface PlayerVariableChanged<V> {
     player: RemotePlayer;
-    value: unknown;
+    value: V;
 }
 export declare class WorkadventurePlayersCommands extends IframeApiContribution<WorkadventurePlayersCommands> {
     private trackingPlayers;
     private trackingMovement;
+    private sharedPlayersVariableStream;
+    private remotePlayers;
+    private _newRemotePlayersStream;
+    private newRemotePlayersStream;
+    private _removeRemotePlayersStream;
+    private removeRemotePlayersStream;
+    private _playersMovedStream;
+    private playersMovedStream;
     callbacks: ({
         type: "setSharedPlayerVariable";
         callback: (event: {
@@ -77,7 +86,7 @@ export declare class WorkadventurePlayersCommands extends IframeApiContribution<
      *
      * If you are looking to listen for variable changes of only one player, look at `RemotePlayer.onVariableChange` instead.
      */
-    onVariableChange(variableName: string): Observable<PlayerVariableChanged>;
+    onVariableChange<K extends keyof PublicPlayerState>(variableName: K): Observable<PlayerVariableChanged<PublicPlayerState[K]>>;
     /**
      * Listens to new remote players.
      * These will be triggered when a remote player is entering our "zone" (zone ~= viewport)

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

@@ -1,5 +1,6 @@
 import { AbstractWorkadventureStateCommands } from "./AbstractState";
-export declare class WorkadventureStateCommands extends AbstractWorkadventureStateCommands {
+import { RoomState } from "./RoomState";
+export declare class WorkadventureStateCommands extends AbstractWorkadventureStateCommands<RoomState> {
     constructor();
     callbacks: {
         type: "setVariable";
@@ -8,8 +9,6 @@ export declare class WorkadventureStateCommands extends AbstractWorkadventureSta
             key: string;
         }) => void;
     }[];
-    saveVariable(key: string, value: unknown): Promise<void>;
+    saveVariable<K extends keyof RoomState & string>(key: K, value: RoomState[K]): Promise<void>;
 }
-export declare function createState(): WorkadventureStateCommands & {
-    [key: string]: unknown;
-};
+export declare function createState(): WorkadventureStateCommands & RoomState;

package/play/src/iframe_api.d.ts

@@ -16,19 +16,20 @@ export type { TileDescriptor } from "./front/Api/Iframe/room";
 export type { ScriptingEvent } from "./front/Api/Iframe/AbstractEvent";
 export type { RemotePlayerInterface } from "./front/Api/Iframe/Players/RemotePlayer";
 export type { SendChatMessageOptions, SendLocalChatMessageOptions, SendBubbleChatMessageOptions, } from "../../libs/shared-utils/src/Events/ChatEvent";
+export type { RoomState } from "./front/Api/Iframe/RoomState";
+export type { PrivatePlayerState } from "./front/Api/Iframe/PrivatePlayerState";
+export type { PublicPlayerState } from "./front/Api/Iframe/PublicPlayerState";
 declare const wa: {
     ui: import("./front/Api/Iframe/ui").WorkAdventureUiCommands;
     nav: import("./front/Api/Iframe/nav").WorkadventureNavigationCommands;
     controls: import("./front/Api/Iframe/controls").WorkadventureControlsCommands;
-    chat: import("./front/Api/Iframe/chat").WorkadventureChatCommands;
+    chat: import("./front/Api/Iframe/chat").WorkadventureChatCommands<import("./front/Api/Iframe/PublicPlayerState").PublicPlayerState>;
     sound: import("./front/Api/Iframe/sound").WorkadventureSoundCommands;
     room: import("./front/Api/Iframe/room").WorkadventureRoomCommands;
     player: import("./front/Api/Iframe/player").WorkadventurePlayerCommands;
     players: import("./front/Api/Iframe/players").WorkadventurePlayersCommands;
     camera: import("./front/Api/Iframe/camera").WorkAdventureCameraCommands;
-    state: import("./front/Api/Iframe/state").WorkadventureStateCommands & {
-        [key: string]: unknown;
-    };
+    state: import("./front/Api/Iframe/state").WorkadventureStateCommands & import("./front/Api/Iframe/RoomState").RoomState;
     event: import("./front/Api/Iframe/event").WorkadventureEventCommands;
     /**
      * When your script / iFrame loads WorkAdventure, it takes a few milliseconds for your