@workadventure/iframe-api-typings 1.11.4 → 1.12.1

package/Api/Iframe/state.d.ts

@@ -0,0 +1,15 @@
+import { AbstractWorkadventureStateCommands } from "./AbstractState";
+export declare class WorkadventureStateCommands extends AbstractWorkadventureStateCommands {
+    constructor();
+    callbacks: {
+        type: "setVariable";
+        callback: (event: {
+            value?: unknown;
+            key: string;
+        }) => void;
+    }[];
+    saveVariable(key: string, value: unknown): Promise<void>;
+}
+export declare function createState(): WorkadventureStateCommands & {
+    [key: string]: unknown;
+};

package/Api/{iframe → Iframe}/ui.d.ts

@@ -4,9 +4,9 @@ import { Popup } from "./Ui/Popup";
 import { ActionMessage } from "./Ui/ActionMessage";
 import { Menu } from "./Ui/Menu";
 import type { RequireOnlyOne } from "../types";
-import { RemotePlayerClickedEvent } from "../Events/RemotePlayerClickedEvent";
 import { Observable, Subject } from "rxjs";
 import type { UIWebsiteCommands } from "./Ui/UIWebsite";
+import { RemotePlayer } from "./Players/RemotePlayer";
 interface MenuDescriptor {
     callback?: (commandDescriptor: string) => void;
     iframe?: string;
@@ -18,16 +18,6 @@ export interface ActionMessageOptions {
     type?: "message" | "warning";
     callback: () => void;
 }
-export declare class RemotePlayer {
-    readonly id: number;
-    readonly uuid: string;
-    readonly name: string;
-    private actions;
-    constructor(remotePlayer: RemotePlayerClickedEvent);
-    addAction(key: string, callback: () => void): ActionsMenuAction;
-    callAction(key: string): void;
-    removeAction(key: string): void;
-}
 export declare class ActionsMenuAction {
     private remotePlayer;
     private key;
@@ -60,9 +50,16 @@ export declare class WorkAdventureUiCommands extends IframeApiContribution<WorkA
     } | {
         type: "remotePlayerClickedEvent";
         callback: (event: {
-            id: number;
+            outlineColor?: number | undefined;
+            position: {
+                x: number;
+                y: number;
+            };
             name: string;
-            uuid: string;
+            playerId: number;
+            variables: Map<string, unknown>;
+            userUuid: string;
+            availabilityStatus: string;
         }) => void;
     } | {
         type: "actionsMenuActionClickedEvent";
@@ -71,12 +68,44 @@ export declare class WorkAdventureUiCommands extends IframeApiContribution<WorkA
             actionName: string;
         }) => void;
     })[];
-    addActionsMenuKeyToRemotePlayer(id: number, actionKey: string): void;
-    removeActionsMenuKeyFromRemotePlayer(id: number, actionKey: string): void;
+    /**
+     * Open a popup in front of the game.
+     * {@link https://workadventu.re/map-building/api-ui.md#opening-a-popup | Website documentation}
+     *
+     * @param {string} targetObject Targeted object name
+     * @param {string} message Message to display
+     * @param {ButtonDescriptor[]} buttons Buttons displayed below popup
+     * @returns {Popup} Popup created
+     */
     openPopup(targetObject: string, message: string, buttons: ButtonDescriptor[]): Popup;
+    /**
+     * Add a custom menu item containing the text commandDescriptor in the navbar of the menu. options attribute accepts an object.
+     * {@link https://workadventu.re/map-building/api-ui.md#add-custom-menu | Website documentation}
+     *
+     * @param {string} commandDescriptor Command description
+     * @param {MenuOptions | ((commandDescriptor: string) => void)} options Manu options
+     * @returns {Menu} Menu created
+     */
     registerMenuCommand(commandDescriptor: string, options: MenuOptions | ((commandDescriptor: string) => void)): Menu;
+    addActionsMenuKeyToRemotePlayer(id: number, actionKey: string): void;
+    removeActionsMenuKeyFromRemotePlayer(id: number, actionKey: string): void;
+    /**
+     * Display a bubble like in proximity meeting (Draft function).
+     * Todo: enhanced bubble functions behaviors
+     */
     displayBubble(): void;
+    /**
+     * Remove a bubble like in proximity meeting.
+     * Todo: enhanced bubble functions behaviors
+     */
     removeBubble(): void;
+    /**
+     * Displays a message at the bottom of the screen (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 {ActionMessageOptions} actionMessageOptions Action options
+     * @returns {ActionMessage} Trigger action message
+     */
     displayActionMessage(actionMessageOptions: ActionMessageOptions): ActionMessage;
     get website(): UIWebsiteCommands;
 }

package/Api/Iframe/website.d.ts

@@ -0,0 +1,32 @@
+import { IframeApiContribution } from "./IframeApiContribution";
+import { EmbeddedWebsite } from "./Room/EmbeddedWebsite";
+import type { CreateEmbeddedWebsiteEvent } from "../Events/EmbeddedWebsiteEvent";
+export declare class WorkadventureRoomWebsiteCommands extends IframeApiContribution<WorkadventureRoomWebsiteCommands> {
+    callbacks: never[];
+    /**
+     * You can get an instance of an embedded website by using the WA.room.website.get() method. It returns a promise of an EmbeddedWebsite instance.
+     * {@link https://workadventu.re/map-building/api-room.md#getting-an-instance-of-a-website-already-embedded-in-the-map | Website documentation}
+     *
+     * @param {string} objectName Object name
+     * @returns {Promise<EmbeddedWebsite>} Promise to get a embed website
+     */
+    get(objectName: string): Promise<EmbeddedWebsite>;
+    /**
+     * You can create an instance of an embedded website by using the WA.room.website.create() method. It returns an EmbeddedWebsite instance.
+     * {@link https://workadventu.re/map-building/api-room.md#adding-a-new-website-in-a-map | Website documentation}
+     *
+     * @param createEmbeddedWebsiteEvent
+     * @returns {EmbeddedWebsite} Created embed website
+     */
+    create(createEmbeddedWebsiteEvent: CreateEmbeddedWebsiteEvent): EmbeddedWebsite;
+    /**
+     * Use WA.room.website.delete to completely remove an embedded website from your map.
+     * {@link https://workadventu.re/map-building/api-room.md#deleting-a-website-from-a-map | Website documentation}
+     *
+     * @param {string} objectName Object name
+     * @returns {Promise<void>} Promise to away to known when the object has been deleted
+     */
+    delete(objectName: string): Promise<void>;
+}
+declare const _default: WorkadventureRoomWebsiteCommands;
+export default _default;

package/iframe_api.d.ts

@@ -1,26 +1,45 @@
-import { CoWebsite } from "./Api/iframe/nav";
-import type { ButtonDescriptor } from "./Api/iframe/Ui/ButtonDescriptor";
-import type { Popup } from "./Api/iframe/Ui/Popup";
-import type { Sound } from "./Api/iframe/Sound/Sound";
-export type { UIWebsite } from "./Api/iframe/Ui/UIWebsite";
-export type { Menu } from "./Api/iframe/Ui/Menu";
-export type { ActionMessage } from "./Api/iframe/Ui/ActionMessage";
-export type { EmbeddedWebsite } from "./Api/iframe/Room/EmbeddedWebsite";
-export type { Area } from "./Api/iframe/Area/Area";
-export type { RemotePlayer, ActionsMenuAction } from "./Api/iframe/ui";
+import { CoWebsite } from "./Api/Iframe/nav";
+import type { ButtonDescriptor } from "./Api/Iframe/Ui/ButtonDescriptor";
+import type { Popup } from "./Api/Iframe/Ui/Popup";
+import type { Sound } from "./Api/Iframe/Sound/Sound";
+export type { UIWebsite } from "./Api/Iframe/Ui/UIWebsite";
+export type { Menu } from "./Api/Iframe/Ui/Menu";
+export type { ActionMessage } from "./Api/Iframe/Ui/ActionMessage";
+export type { EmbeddedWebsite } from "./Api/Iframe/Room/EmbeddedWebsite";
+export type { Area } from "./Api/Iframe/Area/Area";
+export type { ActionsMenuAction } from "./Api/Iframe/ui";
 declare const wa: {
-    ui: import("./Api/iframe/ui").WorkAdventureUiCommands;
-    nav: import("./Api/iframe/nav").WorkadventureNavigationCommands;
-    controls: import("./Api/iframe/controls").WorkadventureControlsCommands;
-    chat: import("./Api/iframe/chat").WorkadventureChatCommands;
-    sound: import("./Api/iframe/sound").WorkadventureSoundCommands;
-    room: import("./Api/iframe/room").WorkadventureRoomCommands;
-    player: import("./Api/iframe/player").WorkadventurePlayerCommands;
-    camera: import("./Api/iframe/camera").WorkAdventureCameraCommands;
-    state: import("./Api/iframe/state").WorkadventureStateCommands & {
+    ui: import("./Api/Iframe/ui").WorkAdventureUiCommands;
+    nav: import("./Api/Iframe/nav").WorkadventureNavigationCommands;
+    controls: import("./Api/Iframe/controls").WorkadventureControlsCommands;
+    chat: import("./Api/Iframe/chat").WorkadventureChatCommands;
+    sound: import("./Api/Iframe/sound").WorkadventureSoundCommands;
+    room: import("./Api/Iframe/room").WorkadventureRoomCommands;
+    player: import("./Api/Iframe/player").WorkadventurePlayerCommands;
+    players: import("./Api/Iframe/players").WorkadventurePlayersCommands;
+    camera: import("./Api/Iframe/camera").WorkAdventureCameraCommands;
+    state: import("./Api/Iframe/state").WorkadventureStateCommands & {
         [key: string]: unknown;
     };
+    /**
+     * When your script / iFrame loads WorkAdventure, it takes a few milliseconds for your
+     * script / iFrame to exchange data with WorkAdventure. You should wait for the WorkAdventure
+     * API to be fully ready using the WA.onInit() method.
+     * {@link https://workadventu.re/map-building/api-start.md#waiting-for-workadventure-api-to-be-available | Website documentation}
+     *
+     * Some properties (like the current user name, or the room ID) are not available until WA.onInit has completed.
+     *
+     * @returns {void}
+     */
     onInit(): Promise<void>;
+    /**
+     * The metadata sent by the administration website.
+     * Important: You need to wait for the end of the initialization before accessing.
+     * {@link https://workadventu.re/map-building/api-metadata.md | Website documentation}
+     *
+     * @returns {unknown|undefined} Metadata
+     */
+    readonly metadata: unknown;
     /**
      * @deprecated Use WA.chat.sendChatMessage instead
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@workadventure/iframe-api-typings",
-  "version": "v1.11.4",
+  "version": "v1.12.1",
   "description": "Typescript typings for WorkAdventure iFrame API",
   "main": "iframe_api.js",
   "types": "iframe_api.d.ts",
@@ -11,6 +11,7 @@
     "access": "public"
   },
   "dependencies": {
-    "rxjs": "^6.6.3"
+    "rxjs": "^6.6.3",
+    "zod": "^3.14.3"
   }
 }

package/Api/Events/RemotePlayerClickedEvent.d.ts

@@ -1,19 +0,0 @@
-import { z } from "zod";
-export declare const isRemotePlayerClickedEvent: z.ZodObject<{
-    id: z.ZodNumber;
-    uuid: z.ZodString;
-    name: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    id: number;
-    name: string;
-    uuid: string;
-}, {
-    id: number;
-    name: string;
-    uuid: string;
-}>;
-/**
- * A message sent from the game to the iFrame when RemotePlayer is clicked.
- */
-export declare type RemotePlayerClickedEvent = z.infer<typeof isRemotePlayerClickedEvent>;
-export declare type RemotePlayerClickedEventCallback = (event: RemotePlayerClickedEvent) => void;

package/Api/iframe/Sound/Sound.d.ts

@@ -1,8 +0,0 @@
-/// <reference types="phaser" />
-import SoundConfig = Phaser.Types.Sound.SoundConfig;
-export declare class Sound {
-    private url;
-    constructor(url: string);
-    play(config: SoundConfig | undefined): string;
-    stop(): string;
-}

package/Api/iframe/area.d.ts

@@ -1,25 +0,0 @@
-import { Subject } from "rxjs";
-import { CreateAreaEvent, ModifyAreaEvent } from "../Events/CreateAreaEvent";
-import { Area } from "./Area/Area";
-import { IframeApiContribution } from "./IframeApiContribution";
-export declare class WorkadventureAreaCommands extends IframeApiContribution<WorkadventureAreaCommands> {
-    callbacks: ({
-        type: "enterAreaEvent";
-        callback: (event: {
-            name: string;
-        }) => void;
-    } | {
-        type: "leaveAreaEvent";
-        callback: (event: {
-            name: string;
-        }) => void;
-    })[];
-    create(createAreaEvent: CreateAreaEvent): Area;
-    get(name: string): Promise<Area>;
-    delete(name: string): Promise<void>;
-    modify(modifyAreaEvent: ModifyAreaEvent): void;
-    onEnter(areaName: string): Subject<void>;
-    onLeave(areaName: string): Subject<void>;
-}
-declare const _default: WorkadventureAreaCommands;
-export default _default;

package/Api/iframe/camera.d.ts

@@ -1,20 +0,0 @@
-import { IframeApiContribution } from "./IframeApiContribution";
-import { Subject } from "rxjs";
-import type { WasCameraUpdatedEvent } from "../Events/WasCameraUpdatedEvent";
-export declare class WorkAdventureCameraCommands extends IframeApiContribution<WorkAdventureCameraCommands> {
-    callbacks: {
-        type: "wasCameraUpdated";
-        callback: (event: {
-            x: number;
-            y: number;
-            width: number;
-            height: number;
-            zoom: number;
-        }) => void;
-    }[];
-    set(x: number, y: number, width?: number, height?: number, lock?: boolean, smooth?: boolean): void;
-    followPlayer(smooth?: boolean): void;
-    onCameraUpdate(): Subject<WasCameraUpdatedEvent>;
-}
-declare const _default: WorkAdventureCameraCommands;
-export default _default;

package/Api/iframe/chat.d.ts

@@ -1,16 +0,0 @@
-import { IframeApiContribution } from "./IframeApiContribution";
-export declare class WorkadventureChatCommands extends IframeApiContribution<WorkadventureChatCommands> {
-    callbacks: {
-        type: "userInputChat";
-        callback: (event: {
-            message: string;
-        }) => void;
-    }[];
-    sendChatMessage(message: string, author: string): void;
-    /**
-     * Listen to messages sent by the local user, in the chat.
-     */
-    onChatMessage(callback: (message: string) => void): void;
-}
-declare const _default: WorkadventureChatCommands;
-export default _default;

package/Api/iframe/controls.d.ts

@@ -1,10 +0,0 @@
-import { IframeApiContribution } from "./IframeApiContribution";
-export declare class WorkadventureControlsCommands extends IframeApiContribution<WorkadventureControlsCommands> {
-    callbacks: never[];
-    disablePlayerControls(): void;
-    restorePlayerControls(): void;
-    disablePlayerProximityMeeting(): void;
-    restorePlayerProximityMeeting(): void;
-}
-declare const _default: WorkadventureControlsCommands;
-export default _default;

package/Api/iframe/nav.d.ts

@@ -1,20 +0,0 @@
-import { IframeApiContribution } from "./IframeApiContribution";
-export declare class CoWebsite {
-    private readonly id;
-    constructor(id: string);
-    close(): Promise<void>;
-}
-export declare class WorkadventureNavigationCommands extends IframeApiContribution<WorkadventureNavigationCommands> {
-    callbacks: never[];
-    openTab(url: string): void;
-    goToPage(url: string): void;
-    goToRoom(url: string): void;
-    openCoWebSite(url: string, allowApi?: boolean, allowPolicy?: string, widthPercent?: number, position?: number, closable?: boolean, lazy?: boolean): Promise<CoWebsite>;
-    getCoWebSites(): Promise<CoWebsite[]>;
-    /**
-     * @deprecated Use closeCoWebsites instead to close all co-websites
-     */
-    closeCoWebSite(): Promise<void>;
-}
-declare const _default: WorkadventureNavigationCommands;
-export default _default;

package/Api/iframe/player.d.ts

@@ -1,43 +0,0 @@
-import { IframeApiContribution } from "./IframeApiContribution";
-import type { HasPlayerMovedEventCallback } from "../Events/HasPlayerMovedEvent";
-export declare const setPlayerName: (name: string) => void;
-export declare const setPlayerLanguage: (language: string | undefined) => void;
-export declare const setTags: (_tags: string[]) => void;
-export declare const setUserRoomToken: (token: string | undefined) => void;
-export declare const setUuid: (_uuid: string | undefined) => void;
-export declare class WorkadventurePlayerCommands extends IframeApiContribution<WorkadventurePlayerCommands> {
-    readonly state: import("./state").WorkadventureStateCommands & {
-        [key: string]: unknown;
-    };
-    callbacks: {
-        type: "hasPlayerMoved";
-        callback: (event: {
-            oldX?: number | undefined;
-            oldY?: number | undefined;
-            x: number;
-            y: number;
-            direction: "left" | "right" | "up" | "down";
-            moving: boolean;
-        }) => void;
-    }[];
-    onPlayerMove(callback: HasPlayerMovedEventCallback): void;
-    get name(): string;
-    get language(): string;
-    get tags(): string[];
-    get id(): string | undefined;
-    getPosition(): Promise<Position>;
-    moveTo(x: number, y: number, speed?: number): Promise<{
-        x: number;
-        y: number;
-        cancelled: boolean;
-    }>;
-    get userRoomToken(): string | undefined;
-    setOutlineColor(red: number, green: number, blue: number): Promise<void>;
-    removeOutlineColor(): Promise<void>;
-}
-export declare type Position = {
-    x: number;
-    y: number;
-};
-declare const _default: WorkadventurePlayerCommands;
-export default _default;

package/Api/iframe/room.d.ts

@@ -1,58 +0,0 @@
-import { Subject } from "rxjs";
-import { IframeApiContribution } from "./IframeApiContribution";
-import type { ITiledMap } from "../../Phaser/Map/ITiledMap";
-import type { WorkadventureRoomWebsiteCommands } from "./website";
-import { WorkadventureAreaCommands } from "./area";
-interface TileDescriptor {
-    x: number;
-    y: number;
-    tile: number | string | null;
-    layer: string;
-}
-export declare const setRoomId: (id: string) => void;
-export declare const setMapURL: (url: string) => void;
-export declare class WorkadventureRoomCommands extends IframeApiContribution<WorkadventureRoomCommands> {
-    callbacks: ({
-        type: "enterEvent";
-        callback: (event: {
-            name: string;
-        }) => void;
-    } | {
-        type: "leaveEvent";
-        callback: (event: {
-            name: string;
-        }) => void;
-    } | {
-        type: "enterLayerEvent";
-        callback: (event: {
-            name: string;
-        }) => void;
-    } | {
-        type: "leaveLayerEvent";
-        callback: (event: {
-            name: string;
-        }) => void;
-    })[];
-    /**
-     * @deprecated Use onEnterLayer instead
-     */
-    onEnterZone(name: string, callback: () => void): void;
-    /**
-     * @deprecated Use onLeaveLayer instead
-     */
-    onLeaveZone(name: string, callback: () => void): void;
-    onEnterLayer(layerName: string): Subject<void>;
-    onLeaveLayer(layerName: string): Subject<void>;
-    showLayer(layerName: string): void;
-    hideLayer(layerName: string): void;
-    setProperty(layerName: string, propertyName: string, propertyValue: string | number | boolean | undefined): void;
-    getTiledMap(): Promise<ITiledMap>;
-    setTiles(tiles: TileDescriptor[]): void;
-    get id(): string;
-    get mapURL(): string;
-    loadTileset(url: string): Promise<number>;
-    get website(): WorkadventureRoomWebsiteCommands;
-    get area(): WorkadventureAreaCommands;
-}
-declare const _default: WorkadventureRoomCommands;
-export default _default;

package/Api/iframe/sound.d.ts

@@ -1,8 +0,0 @@
-import { IframeApiContribution } from "./IframeApiContribution";
-import { Sound } from "./Sound/Sound";
-export declare class WorkadventureSoundCommands extends IframeApiContribution<WorkadventureSoundCommands> {
-    callbacks: never[];
-    loadSound(url: string): Sound;
-}
-declare const _default: WorkadventureSoundCommands;
-export default _default;

package/Api/iframe/state.d.ts

@@ -1,25 +0,0 @@
-import { Observable } from "rxjs";
-import { IframeApiContribution } from "./IframeApiContribution";
-export declare class WorkadventureStateCommands extends IframeApiContribution<WorkadventureStateCommands> {
-    private target;
-    private setVariableResolvers;
-    private variables;
-    private variableSubscribers;
-    constructor(target: "global" | "player");
-    callbacks: {
-        type: "setVariable";
-        callback: (event: {
-            value?: unknown;
-            key: string;
-            target: "global" | "player";
-        }) => void;
-    }[];
-    initVariables(_variables: Map<string, unknown>): void;
-    saveVariable(key: string, value: unknown): Promise<void>;
-    loadVariable(key: string): unknown;
-    hasVariable(key: string): boolean;
-    onVariableChange(key: string): Observable<unknown>;
-}
-export declare function createState(target: "global" | "player"): WorkadventureStateCommands & {
-    [key: string]: unknown;
-};

package/Api/iframe/website.d.ts

@@ -1,11 +0,0 @@
-import { IframeApiContribution } from "./IframeApiContribution";
-import { EmbeddedWebsite } from "./Room/EmbeddedWebsite";
-import type { CreateEmbeddedWebsiteEvent } from "../Events/EmbeddedWebsiteEvent";
-export declare class WorkadventureRoomWebsiteCommands extends IframeApiContribution<WorkadventureRoomWebsiteCommands> {
-    callbacks: never[];
-    get(objectName: string): Promise<EmbeddedWebsite>;
-    create(createEmbeddedWebsiteEvent: CreateEmbeddedWebsiteEvent): EmbeddedWebsite;
-    delete(objectName: string): Promise<void>;
-}
-declare const _default: WorkadventureRoomWebsiteCommands;
-export default _default;