@workadventure/iframe-api-typings 1.25.6 → 1.25.8

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

@@ -0,0 +1,116 @@
+import { IframeApiContribution } from "./IframeApiContribution";
+export declare class WorkadventureControlsCommands extends IframeApiContribution<WorkadventureControlsCommands> {
+    callbacks: never[];
+    /**
+     *  Disable player controls.
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#disabling--restoring-controls | Website documentation}
+     */
+    disablePlayerControls(): void;
+    /**
+     * Restore player controls.
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#disabling--restoring-controls | Website documentation}
+     */
+    restorePlayerControls(): void;
+    /**
+     * Turn off player microphone.
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#turn-off-webcam-or-microphone | Website documentation}
+     */
+    turnOffMicrophone(): void;
+    /**
+     * Turn off player webcam.
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#turn-off-webcam-or-microphone | Website documentation}
+     */
+    turnOffWebcam(): void;
+    /**
+     * Disable player microphone.
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#disabling--restoring-webcam-or-microphone | Website documentation}
+     */
+    disableMicrophone(): void;
+    /**
+     * Restore player microphone.
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#disabling--restoring-webcam-or-microphone | Website documentation}
+     */
+    restoreMicrophone(): void;
+    /**
+     * Disable player webcam.
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#disabling--restoring-webcam-or-microphone | Website documentation}
+     */
+    disableWebcam(): void;
+    /**
+     * Disable player webcam.
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#disabling--restoring-webcam-or-microphone | Website documentation}
+     */
+    restoreWebcam(): void;
+    /**
+     * Disable proximity meetings.
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#disabling--restoring-proximity-meeting | Website documentation}
+     */
+    disablePlayerProximityMeeting(): void;
+    /**
+     * Restore proximity meettings.
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#disabling--restoring-proximity-meeting | Website documentation}
+     */
+    restorePlayerProximityMeeting(): void;
+    /**
+     * Disable map editor mode.
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#disabling--restoring-map-editor | Website documentation}
+     */
+    disableMapEditor(): void;
+    /**
+     * Restore map editor mode.
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#disabling--restoring-map-editor | Website documentation}
+     */
+    restoreMapEditor(): void;
+    /**
+     * Disable screen sharing.
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#disabling--restoring-screen-sharing | Website documentation}
+     */
+    disableScreenSharing(): void;
+    /**
+     * Restore screen sharing.
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#disabling--restoring-screen-sharing | Website documentation}
+     */
+    restoreScreenSharing(): void;
+    /**
+     * Disable wheel zoom.
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#disabling--restoring-wheel-zoom | Website documentation}
+     */
+    disableWheelZoom(): void;
+    /**
+     * Restore wheel zoom.
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#disabling--restoring-wheel-zoom | Website documentation}
+     */
+    restoreWheelZoom(): void;
+    /**
+     * Disable Right Click.
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#disabling--restoring-right-click | Website documentation}
+     */
+    disableRightClick(): void;
+    /**
+     * Restore Right Click.
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#disabling--restoring-right-click | Website documentation}
+     */
+    restoreRightClick(): void;
+    /**
+     * Disable invite button.
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#disabling--restoring-invite-button | Website documentation}
+     */
+    disableInviteButton(): void;
+    /**
+     * Restore invite button.
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#disabling--restoring-invite-user-button | Website documentation}
+     */
+    restoreInviteButton(): void;
+    /**
+     * Disable room list.
+     * {@link https://docs.workadventu.re/map-building/api-controls.md#disabling--restoring-room-list | Website documentation}
+     */
+    disableRoomList(): void;
+    /**
+     * Restore room list.
+     * {@link https://docs.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/event.d.ts

@@ -0,0 +1,15 @@
+import { AbstractWorkadventureEventCommands } from "./AbstractEvent";
+export declare class WorkadventureEventCommands extends AbstractWorkadventureEventCommands {
+    constructor();
+    callbacks: {
+        type: "receiveEvent";
+        callback: (event: {
+            name: string;
+            data?: unknown;
+            senderId?: number | undefined;
+        }) => void;
+    }[];
+    broadcast(name: string, data: unknown): Promise<void>;
+}
+declare const _default: WorkadventureEventCommands;
+export default _default;

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

@@ -0,0 +1,52 @@
+import type { Observable } from "rxjs";
+import { IframeApiContribution } from "./IframeApiContribution";
+import { MapEditorArea } from "./MapEditor/MapEditorArea";
+declare class WorkadventureMapEditorAreaCommands extends IframeApiContribution<WorkadventureMapEditorAreaCommands> {
+    callbacks: ({
+        type: "enterMapEditorAreaEvent";
+        callback: (event: {
+            name: string;
+        }) => void;
+    } | {
+        type: "leaveMapEditorAreaEvent";
+        callback: (event: {
+            name: string;
+        }) => void;
+    })[];
+    /**
+     * Listens to the position of the current user. The event is triggered when the user enters a given area.
+     * {@link https://docs.workadventu.re/map-building/api-mapeditor.md#detecting-when-the-user-entersleaves-an-area | Website documentation}
+     *
+     * @param {string} areaName Area name
+     * @returns {Subject<void>} An observable fired when someone enters the area
+     */
+    onEnter(areaName: string): Observable<void>;
+    /**
+     * Listens to the position of the current user. The event is triggered when the user leaves a given area.
+     * {@link https://docs.workadventu.re/map-building/api-mapeditor.md#detecting-when-the-user-entersleaves-an-area | Website documentation}
+     *
+     * @param {string} areaName Area name
+     * @returns {Subject<void>} An observable fired when someone leaves the area
+     */
+    onLeave(areaName: string): Observable<void>;
+    private wamMapCache;
+    /**
+     * Returns a promise that resolves to the WAM map file.
+     * The WAM is cached in memory.
+     *
+     * @returns {Promise<WAMFileFormat>} Map in Tiled JSON format
+     */
+    private getWamMap;
+    /**
+     * Returns a list of areas defined in the map editor.
+     *
+     * @returns {Promise<MapEditorArea[]>} List of areas
+     */
+    list(): Promise<MapEditorArea[]>;
+}
+export declare class WorkadventureMapEditorCommands extends IframeApiContribution<WorkadventureMapEditorCommands> {
+    callbacks: never[];
+    get area(): WorkadventureMapEditorAreaCommands;
+}
+declare const _default: WorkadventureMapEditorCommands;
+export default _default;

package/{Api → play/src/front/Api}/Iframe/nav.d.ts

@@ -8,14 +8,14 @@ export declare class WorkadventureNavigationCommands extends IframeApiContributi
     callbacks: never[];
     /**
      * Opens the webpage at "url" in your browser, in a new tab.
-     * {@link https://workadventu.re/map-building/api-nav.md#opening-a-web-page-in-a-new-tab | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-nav.md#opening-a-web-page-in-a-new-tab | Website documentation}
      *
      * @param {string} url Url of the web page
      */
     openTab(url: string): void;
     /**
      * Opens the webpage at "url" in your browser in place of WorkAdventure. WorkAdventure will be completely unloaded.
-     * {@link https://workadventu.re/map-building/api-nav.md#opening-a-web-page-in-the-current-tab | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-nav.md#opening-a-web-page-in-the-current-tab | Website documentation}
      *
      * @param {string} url Url of the web page
      */
@@ -23,14 +23,14 @@ export declare class WorkadventureNavigationCommands extends IframeApiContributi
     /**
      * Load the map at url without unloading workadventure.
      * relative urls: "../subFolder/map.json[#start-layer-name]" global urls: "/_/global/domain/path/map.json[#start-layer-name]"
-     * {@link https://workadventu.re/map-building/api-nav.md#going-to-a-different-map-from-the-script | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-nav.md#going-to-a-different-map-from-the-script | Website documentation}
      *
      * @param {string} url Url of the web page
      */
     goToRoom(url: string): void;
     /**
      * Opens the webpage at "url" in an iFrame (on the right side of the screen) or close that iFrame.
-     * {@link https://workadventu.re/map-building/api-nav.md#openingclosing-web-page-in-co-websites | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-nav.md#openingclosing-web-page-in-co-websites | Website documentation}
      *
      * @param {string} url Url of the web page
      * @param {boolean|undefined} allowApi  Allows the webpage to use the "IFrame API" and execute script (it is equivalent to putting the openWebsiteAllowApi property in the map)
@@ -44,7 +44,7 @@ export declare class WorkadventureNavigationCommands extends IframeApiContributi
     openCoWebSite(url: string, allowApi?: boolean, allowPolicy?: string, widthPercent?: number, position?: number, closable?: boolean, lazy?: boolean): Promise<CoWebsite>;
     /**
      * Get all opened co-websites with their ids and positions.
-     * {@link https://workadventu.re/map-building/api-nav.md#get-all-co-websites | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-nav.md#get-all-co-websites | Website documentation}
      *
      * @returns {CoWebsite[]} All Cowebsites
      */
@@ -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/{Api → play/src/front/Api}/Iframe/player.d.ts

@@ -1,5 +1,6 @@
-import { IframeApiContribution } from "./IframeApiContribution";
+import { Subscription } from "rxjs";
 import type { HasPlayerMovedEventCallback } from "../Events/HasPlayerMovedEvent";
+import { IframeApiContribution } from "./IframeApiContribution";
 import { WorkadventureProximityMeetingCommands } from "./Player/ProximityMeeting";
 export declare const setPlayerName: (name: string) => void;
 export declare const setPlayerLanguage: (language: string | undefined) => void;
@@ -7,25 +8,25 @@ export declare const setTags: (_tags: string[]) => void;
 export declare const setUserRoomToken: (token: string | undefined) => void;
 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: {
-            oldX?: number | undefined;
-            oldY?: number | undefined;
             x: number;
             y: number;
             direction: "left" | "right" | "up" | "down";
             moving: boolean;
+            oldX?: number | undefined;
+            oldY?: number | undefined;
         }) => void;
     }[];
     /**
      * Get the player name.
      * Important: You need to wait for the end of the initialization before accessing.
-     * {@link https://workadventu.re/map-building/api-player.md#get-the-player-name | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-player.md#get-the-player-name | Website documentation}
      *
      * @returns {string} Player name
      */
@@ -33,7 +34,7 @@ export declare class WorkadventurePlayerCommands extends IframeApiContribution<W
     /**
      * Get the player UUID.
      * Important: You need to wait for the end of the initialization before accessing.
-     * {@link https://workadventu.re/map-building/api-player.md#get-the-player-uuid | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-player.md#get-the-player-uuid | Website documentation}
      * @deprecated Use WA.player.uuid instead
      *
      * @returns {string|undefined} Player UUID
@@ -42,7 +43,7 @@ export declare class WorkadventurePlayerCommands extends IframeApiContribution<W
     /**
      * Get the player id.
      * Important: You need to wait for the end of the initialization before accessing.
-     * {@link https://workadventu.re/map-building/api-player.md#get-the-player-id | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-player.md#get-the-player-id | Website documentation}
      *
      * @returns {number} Player id
      */
@@ -50,7 +51,7 @@ export declare class WorkadventurePlayerCommands extends IframeApiContribution<W
     /**
      * Get the player UUID.
      * Important: You need to wait for the end of the initialization before accessing.
-     * {@link https://workadventu.re/map-building/api-player.md#get-the-player-uuid | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-player.md#get-the-player-uuid | Website documentation}
      *
      * @returns {string|undefined} Player UUID
      */
@@ -58,7 +59,7 @@ export declare class WorkadventurePlayerCommands extends IframeApiContribution<W
     /**
      * Get the player language.
      * Important: You need to wait for the end of the initialization before accessing.
-     * {@link https://workadventu.re/map-building/api-player.md#get-the-player-language | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-player.md#get-the-player-language | Website documentation}
      *
      * @returns {string} Player language
      */
@@ -66,7 +67,7 @@ export declare class WorkadventurePlayerCommands extends IframeApiContribution<W
     /**
      * Get the player tags.
      * Important: You need to wait for the end of the initialization before accessing.
-     * {@link https://workadventu.re/map-building/api-player.md#get-the-tags-of-the-player | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-player.md#get-the-tags-of-the-player | Website documentation}
      *
      * @returns {string[]} Player tags
      */
@@ -74,7 +75,7 @@ export declare class WorkadventurePlayerCommands extends IframeApiContribution<W
     /**
      * Get the player position.
      * Important: You need to wait for the end of the initialization before accessing.
-     * {@link https://workadventu.re/map-building/api-player.md#get-the-position-of-the-player | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-player.md#get-the-position-of-the-player | Website documentation}
      *
      * @returns {Position} Player position
      */
@@ -82,14 +83,15 @@ export declare class WorkadventurePlayerCommands extends IframeApiContribution<W
     /**
      * Listens to the movement of the current user and calls the callback.
      * Sends an event when the user stops moving, changes direction and every 200ms when moving in the same direction.
-     * {@link https://workadventu.re/map-building/api-player.md#listen-to-player-movement | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-player.md#listen-to-player-movement | Website documentation}
      *
      * @param {HasPlayerMovedEventCallback} callback Function that will be called when the current player is moving. It contains the event
+     * @return {Subscription} Subscription to the stream. Use ".unsubscribe()" to stop listening.
      */
-    onPlayerMove(callback: HasPlayerMovedEventCallback): void;
+    onPlayerMove(callback: HasPlayerMovedEventCallback): Subscription;
     /**
-     * Player will try to find shortest path to the destination point and proceed to move there.
-     * {@link https://workadventu.re/map-building/api-player.md#move-player-to-position | Website documentation}
+     * Player will try to find the shortest path to the destination point and proceed to move there.
+     * {@link https://docs.workadventu.re/map-building/api-player.md#move-player-to-position | Website documentation}
      *
      * @param {number} x Horizontal position
      * @param {number} y Vertical position
@@ -101,6 +103,7 @@ export declare class WorkadventurePlayerCommands extends IframeApiContribution<W
         y: number;
         cancelled: boolean;
     }>;
+    teleport(x: number, y: number): Promise<void>;
     /**
      * This token can be used by third party services to authenticate a player and prove that the player is in a given room.
      * The token is generated by the administration panel linked to WorkAdventure.
@@ -109,14 +112,14 @@ export declare class WorkadventurePlayerCommands extends IframeApiContribution<W
      *
      * If you are using the self-hosted version of WorkAdventure and you developed your own administration panel, the token can be anything.
      * By default, self-hosted versions of WorkAdventure don't come with an administration panel, so the token string will be empty.
-     * {@link https://workadventu.re/map-building/api-player.md#get-the-user-room-token-of-the-player | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-player.md#get-the-user-room-token-of-the-player | Website documentation}
      *
      * @returns {string|undefined} User room token
      */
     get userRoomToken(): string | undefined;
     /**
      * Display a thin line around your player's name (the "outline").
-     * {@link https://workadventu.re/map-building/api-player.md#set-the-outline-color-of-the-player | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-player.md#set-the-outline-color-of-the-player | Website documentation}
      *
      * @param {number} red
      * @param {number} green
@@ -126,14 +129,31 @@ export declare class WorkadventurePlayerCommands extends IframeApiContribution<W
     setOutlineColor(red: number, green: number, blue: number): Promise<void>;
     /**
      * Remove the thin line around your player's name (the "outline").
-     * {@link https://workadventu.re/map-building/api-player.md#set-the-outline-color-of-the-player | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-player.md#set-the-outline-color-of-the-player | Website documentation}
      *
      * @returns {Promise<void>} Promise to await to known when the outline has been removed
      */
     removeOutlineColor(): Promise<void>;
     get proximityMeeting(): WorkadventureProximityMeetingCommands;
+    /**
+     * Get a value to provide connected status for the current player.
+     * Important: You need to wait for the end of the initialization before accessing.
+     * {@link https://docs.workadventu.re/map-building/api-player.md#get-the-tags-of-the-player | Website documentation}
+     *
+     * @returns {boolean} Player tags
+     */
+    get isLogged(): boolean;
+    /**
+     * Get a base64 string of the Woka image of the current player.
+     * The Woka is in "still" position facing south.
+     * @returns {Promise<string>}
+     * {@link https://docs.workadventu.re/map-building/api-player.md#get-the-woka-of-the-player | Website documentation}
+     *
+     * @returns {Promise<string>} Current player woka in base64
+     */
+    getWokaPicture(): Promise<string>;
 }
-export declare type Position = {
+export type Position = {
     x: number;
     y: number;
 };

package/{Api → play/src/front/Api}/Iframe/playerState.d.ts

@@ -1,20 +1,22 @@
 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";
         callback: (event: {
-            value?: unknown;
             key: string;
+            value?: unknown;
         }) => 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 & PlayerState;
+export {};

package/{Api → play/src/front/Api}/Iframe/players.d.ts

@@ -1,33 +1,44 @@
+import type { Observable } from "rxjs";
 import { IframeApiContribution } from "./IframeApiContribution";
-import { Observable } from "rxjs";
-import { RemotePlayer, RemotePlayerInterface, RemotePlayerMoved } from "./Players/RemotePlayer";
-export interface PlayerVariableChanged {
+import type { RemotePlayerInterface, RemotePlayerMoved } from "./Players/RemotePlayer";
+import { RemotePlayer } from "./Players/RemotePlayer";
+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: {
-            value?: unknown;
             playerId: number;
             key: string;
+            value?: unknown;
         }) => void;
     } | {
         type: "addRemotePlayer";
         callback: (event: {
-            outlineColor?: number | undefined;
+            name: string;
             position: {
                 x: number;
                 y: number;
             };
-            name: string;
             playerId: number;
             variables: Map<string, unknown>;
             userUuid: string;
             availabilityStatus: string;
+            outlineColor?: number | undefined;
+            chatID?: string | null | undefined;
         }) => void;
     } | {
         type: "removeRemotePlayer";
@@ -35,21 +46,22 @@ export declare class WorkadventurePlayersCommands extends IframeApiContribution<
     } | {
         type: "remotePlayerChanged";
         callback: (event: {
+            playerId: number;
+            name?: string | undefined;
             position?: {
                 x: number;
                 y: number;
             } | undefined;
-            name?: string | undefined;
             variables?: Map<string, unknown> | undefined;
             availabilityStatus?: string | undefined;
             outlineColor?: number | undefined;
-            playerId: number;
+            chatID?: string | null | undefined;
         }) => void;
     })[];
     private registerRemotePlayer;
     /**
      * Start the tracking players. You need to call this method before being able to listen to players positions.
-     * {@link https://workadventu.re/map-building/api-players.md#enabling-players-tracking | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-players.md#enabling-players-tracking | Website documentation}
      *
      * ```ts
      * await WA.players.configureTracking({
@@ -66,23 +78,23 @@ export declare class WorkadventurePlayersCommands extends IframeApiContribution<
     }): Promise<void>;
     /**
      * Listens to a given variable change on all available players.
-     * {@link https://workadventu.re/map-building/api-players.md#listen-to-a-remote-player-variable-changes | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-players.md#listen-to-a-remote-player-variable-changes | Website documentation}
      *
      * ```ts
      * WA.players.onVariableChange("score").subscribe({ player, value } => {
-     *     console.log("Score for player", player.name, "has been updated to", value);
+     *     console.info("Score for player", player.name, "has been updated to", value);
      * });
      * ```
      *
      * 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)
      * This means this will NOT be triggered when a remote player enters the map, but when the remote player is
      * getting visible.
-     * {@link https://workadventu.re/map-building/api-players.md#tracking-players-in-real-time | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-players.md#tracking-players-in-real-time | Website documentation}
      *
      * Usage:
      *
@@ -96,7 +108,7 @@ export declare class WorkadventurePlayersCommands extends IframeApiContribution<
      * These will be triggered when a remote player is leaving our "zone" (zone ~= viewport)
      * This means this will be triggered when a remote player leaves the map, but ALSO when the remote player is
      * walking away and is no longer visible.
-     * {@link https://workadventu.re/map-building/api-players.md#tracking-players-in-real-time | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-players.md#tracking-players-in-real-time | Website documentation}
      *
      * Usage:
      *
@@ -108,7 +120,7 @@ export declare class WorkadventurePlayersCommands extends IframeApiContribution<
     /**
      * Listens to movement from all players who are in our zone (zone ~= viewport)
      * This means this may NOT be triggered when a remote player moves but is far away from us.
-     * {@link https://workadventu.re/map-building/api-players.md#tracking-players-movement | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-players.md#tracking-players-movement | Website documentation}
      *
      * Usage:
      *
@@ -119,7 +131,7 @@ export declare class WorkadventurePlayersCommands extends IframeApiContribution<
     get onPlayerMoves(): Observable<RemotePlayerMoved>;
     /**
      * Returns a RemotePlayer by its id.
-     * {@link https://workadventu.re/map-building/api-players.md#getting-a-remote-player-by-id | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-players.md#getting-a-remote-player-by-id | Website documentation}
      *
      * Note: if the same user is connected twice, it will be considered as 2 different players with 2 different IDs.
      */
@@ -127,7 +139,7 @@ export declare class WorkadventurePlayersCommands extends IframeApiContribution<
     /**
      * Returns the list of all nearby remote players.
      * The list only contains the players in the same zone as the current player (where zone ~= viewport).
-     * {@link https://workadventu.re/map-building/api-players.md#getting-a-list-of-players-around-me | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-players.md#getting-a-list-of-players-around-me | Website documentation}
      */
     list(): IterableIterator<RemotePlayerInterface>;
 }

package/{Api → play/src/front/Api}/Iframe/registeredCallbacks.d.ts

@@ -1,4 +1,4 @@
-import { IframeResponseEvent } from "../../Api/Events/IframeEvent";
+import type { IframeResponseEvent } from "../Events/IframeEvent";
 export declare const registeredCallbacks: {
     [K in IframeResponseEvent["type"]]?: ((event: Extract<IframeResponseEvent, {
         type: K;