@workadventure/iframe-api-typings 1.11.3 → 1.12.1

package/Api/Events/JoinMucEvent.d.ts

@@ -0,0 +1,21 @@
+import { z } from "zod";
+export declare const isJoinMucEvent: z.ZodObject<{
+    url: z.ZodString;
+    name: z.ZodString;
+    type: z.ZodString;
+    subscribe: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    type: string;
+    url: string;
+    name: string;
+    subscribe: boolean;
+}, {
+    type: string;
+    url: string;
+    name: string;
+    subscribe: boolean;
+}>;
+/**
+ * A message sent from the iFrame to the game to change the camera position.
+ */
+export declare type JoinMucEvent = z.infer<typeof isJoinMucEvent>;

package/Api/Events/LeaveMucEvent.d.ts

@@ -0,0 +1,12 @@
+import { z } from "zod";
+export declare const isLeaveMucEvent: z.ZodObject<{
+    url: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    url: string;
+}, {
+    url: string;
+}>;
+/**
+ * A message sent from the iFrame to the game to change the camera position.
+ */
+export declare type LeaveMucEvent = z.infer<typeof isLeaveMucEvent>;

package/Api/Events/NotificationEvent.d.ts

@@ -0,0 +1,18 @@
+import { z } from "zod";
+export declare const isNotificationEvent: z.ZodObject<{
+    userName: z.ZodString;
+    notificationType: z.ZodNumber;
+    forum: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    forum?: string | null | undefined;
+    userName: string;
+    notificationType: number;
+}, {
+    forum?: string | null | undefined;
+    userName: string;
+    notificationType: number;
+}>;
+/**
+ * A message sent from the iFrame to the game to emit a notification.
+ */
+export declare type NotificationEvent = z.infer<typeof isNotificationEvent>;

package/Api/Events/ProximityMeeting/JoinProximityMeetingEvent.d.ts

@@ -0,0 +1,70 @@
+import { z } from "zod";
+export declare const isJoinProximityMeetingEvent: z.ZodObject<{
+    users: z.ZodArray<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;
+        position: {
+            x: number;
+            y: number;
+        };
+        name: string;
+        playerId: number;
+        variables: Map<string, unknown>;
+        userUuid: string;
+        availabilityStatus: string;
+    }, {
+        outlineColor?: number | undefined;
+        position: {
+            x: number;
+            y: number;
+        };
+        name: string;
+        playerId: number;
+        variables: Map<string, unknown>;
+        userUuid: string;
+        availabilityStatus: string;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    users: {
+        outlineColor?: number | undefined;
+        position: {
+            x: number;
+            y: number;
+        };
+        name: string;
+        playerId: number;
+        variables: Map<string, unknown>;
+        userUuid: string;
+        availabilityStatus: string;
+    }[];
+}, {
+    users: {
+        outlineColor?: number | undefined;
+        position: {
+            x: number;
+            y: number;
+        };
+        name: string;
+        playerId: number;
+        variables: Map<string, unknown>;
+        userUuid: string;
+        availabilityStatus: string;
+    }[];
+}>;
+export declare type JoinProximityMeetingEvent = z.infer<typeof isJoinProximityMeetingEvent>;

package/Api/Events/ProximityMeeting/ParticipantProximityMeetingEvent.d.ts

@@ -0,0 +1,70 @@
+import { z } from "zod";
+export declare const isParticipantProximityMeetingEvent: 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;
+        position: {
+            x: number;
+            y: number;
+        };
+        name: string;
+        playerId: number;
+        variables: Map<string, unknown>;
+        userUuid: string;
+        availabilityStatus: string;
+    }, {
+        outlineColor?: number | undefined;
+        position: {
+            x: number;
+            y: number;
+        };
+        name: string;
+        playerId: number;
+        variables: Map<string, unknown>;
+        userUuid: string;
+        availabilityStatus: string;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    user: {
+        outlineColor?: number | undefined;
+        position: {
+            x: number;
+            y: number;
+        };
+        name: string;
+        playerId: number;
+        variables: Map<string, unknown>;
+        userUuid: string;
+        availabilityStatus: string;
+    };
+}, {
+    user: {
+        outlineColor?: number | undefined;
+        position: {
+            x: number;
+            y: number;
+        };
+        name: string;
+        playerId: number;
+        variables: Map<string, unknown>;
+        userUuid: string;
+        availabilityStatus: string;
+    };
+}>;
+export declare type ParticipantProximityMeetingEvent = z.infer<typeof isParticipantProximityMeetingEvent>;

package/Api/Events/SetPlayerVariableEvent.d.ts

@@ -0,0 +1,27 @@
+import { z } from "zod";
+export declare const isSetPlayerVariableEvent: z.ZodObject<{
+    key: z.ZodString;
+    value: z.ZodUnknown;
+    public: z.ZodBoolean;
+    persist: z.ZodBoolean;
+    ttl: z.ZodOptional<z.ZodNumber>;
+    scope: z.ZodUnion<[z.ZodLiteral<"room">, z.ZodLiteral<"world">]>;
+}, "strip", z.ZodTypeAny, {
+    value?: unknown;
+    ttl?: number | undefined;
+    key: string;
+    public: boolean;
+    persist: boolean;
+    scope: "room" | "world";
+}, {
+    value?: unknown;
+    ttl?: number | undefined;
+    key: string;
+    public: boolean;
+    persist: boolean;
+    scope: "room" | "world";
+}>;
+/**
+ * A message sent from the iFrame to the game to set a variable related to the player
+ */
+export declare type SetPlayerVariableEvent = z.infer<typeof isSetPlayerVariableEvent>;

package/Api/Events/SetSharedPlayerVariableEvent.d.ts

@@ -0,0 +1,18 @@
+import { z } from "zod";
+export declare const isSetSharedPlayerVariableEvent: z.ZodObject<{
+    key: z.ZodString;
+    value: z.ZodUnknown;
+    playerId: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    value?: unknown;
+    playerId: number;
+    key: string;
+}, {
+    value?: unknown;
+    playerId: number;
+    key: string;
+}>;
+/**
+ * A message sent from the iFrame to the game to change the value of the property of the layer
+ */
+export declare type SetSharedPlayerVariableEvent = z.infer<typeof isSetSharedPlayerVariableEvent>;

package/Api/Events/SetVariableEvent.d.ts

@@ -2,44 +2,36 @@ import { z } from "zod";
 export declare const isSetVariableEvent: z.ZodObject<{
     key: z.ZodString;
     value: z.ZodUnknown;
-    target: z.ZodEnum<["global", "player"]>;
 }, "strip", z.ZodTypeAny, {
     value?: unknown;
     key: string;
-    target: "global" | "player";
 }, {
     value?: unknown;
     key: string;
-    target: "global" | "player";
 }>;
 export declare const isSetVariableIframeEvent: z.ZodObject<{
-    type: z.ZodEnum<["setVariable"]>;
+    type: z.ZodLiteral<"setVariable">;
     data: z.ZodObject<{
         key: z.ZodString;
         value: z.ZodUnknown;
-        target: z.ZodEnum<["global", "player"]>;
     }, "strip", z.ZodTypeAny, {
         value?: unknown;
         key: string;
-        target: "global" | "player";
     }, {
         value?: unknown;
         key: string;
-        target: "global" | "player";
     }>;
 }, "strip", z.ZodTypeAny, {
     type: "setVariable";
     data: {
         value?: unknown;
         key: string;
-        target: "global" | "player";
     };
 }, {
     type: "setVariable";
     data: {
         value?: unknown;
         key: string;
-        target: "global" | "player";
     };
 }>;
 /**

package/Api/Events/SettingsEvent.d.ts

@@ -0,0 +1,12 @@
+import { z } from "zod";
+export declare const isSettingsEvent: z.ZodObject<{
+    notification: z.ZodBoolean;
+    chatSounds: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    notification: boolean;
+    chatSounds: boolean;
+}, {
+    notification: boolean;
+    chatSounds: boolean;
+}>;
+export declare type SettingsEvent = z.infer<typeof isSettingsEvent>;

package/Api/Events/ShowBusinessCardEvent.d.ts

@@ -0,0 +1,12 @@
+import { z } from "zod";
+export declare const isShowBusinessCardEvent: z.ZodObject<{
+    visitCardUrl: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    visitCardUrl: string;
+}, {
+    visitCardUrl: string;
+}>;
+/**
+ * A message sent from the iFrame to the game to emit a notification.
+ */
+export declare type ShowBusinessCardEvent = z.infer<typeof isShowBusinessCardEvent>;

package/Api/Iframe/AbstractState.d.ts

@@ -0,0 +1,14 @@
+import { Observable, Subject } from "rxjs";
+export declare abstract class AbstractWorkadventureStateCommands {
+    protected setVariableResolvers: Subject<{
+        value?: unknown;
+        key: string;
+    }>;
+    protected variables: Map<string, unknown>;
+    private variableSubscribers;
+    protected constructor();
+    initVariables(_variables: Map<string, unknown>): void;
+    loadVariable(key: string): unknown;
+    hasVariable(key: string): boolean;
+    onVariableChange(key: string): Observable<unknown>;
+}

package/Api/Iframe/Player/ProximityMeeting.d.ts

@@ -0,0 +1,85 @@
+import { Subject } from "rxjs";
+import { IframeApiContribution } from "../IframeApiContribution";
+import { RemotePlayer } from "../Players/RemotePlayer";
+export declare class WorkadventureProximityMeetingCommands extends IframeApiContribution<WorkadventureProximityMeetingCommands> {
+    callbacks: ({
+        type: "joinProximityMeetingEvent";
+        callback: (event: {
+            users: {
+                outlineColor?: number | undefined;
+                position: {
+                    x: number;
+                    y: number;
+                };
+                name: string;
+                playerId: number;
+                variables: Map<string, unknown>;
+                userUuid: string;
+                availabilityStatus: string;
+            }[];
+        }) => void;
+    } | {
+        type: "participantJoinProximityMeetingEvent";
+        callback: (event: {
+            user: {
+                outlineColor?: number | undefined;
+                position: {
+                    x: number;
+                    y: number;
+                };
+                name: string;
+                playerId: number;
+                variables: Map<string, unknown>;
+                userUuid: string;
+                availabilityStatus: string;
+            };
+        }) => void;
+    } | {
+        type: "participantLeaveProximityMeetingEvent";
+        callback: (event: {
+            user: {
+                outlineColor?: number | undefined;
+                position: {
+                    x: number;
+                    y: number;
+                };
+                name: string;
+                playerId: number;
+                variables: Map<string, unknown>;
+                userUuid: string;
+                availabilityStatus: string;
+            };
+        }) => void;
+    } | {
+        type: "leaveProximityMeetingEvent";
+        callback: (event: undefined) => void;
+    })[];
+    /**
+     * Detecting when the user enter on a meeting.
+     * {@link https://workadventu.re/map-building/api-player.md#detecting-when-the-user-entersleaves-a-meeting | Website documentation}
+     *
+     * @returns {Subject<RemotePlayer[]>} Observable who return the joined users
+     */
+    onJoin(): Subject<RemotePlayer[]>;
+    /**
+     * Detecting when a participant joined on the current meeting.
+     * {@link https://workadventu.re/map-building/api-player.md#detecting-when-a-participant-entersleaves-the-current-meeting | Website documentation}
+     *
+     * @returns {Subject<RemotePlayer>} Observable who return the joined user
+     */
+    onParticipantJoin(): Subject<RemotePlayer>;
+    /**
+     * Detecting when a participant left on the current meeting.
+     * {@link https://workadventu.re/map-building/api-player.md#detecting-when-a-participant-entersleaves-the-current-meeting | Website documentation}
+     *
+     * @returns {Subject<RemotePlayer>} Observable who return the left user
+     */
+    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}
+     */
+    onLeave(): Subject<void>;
+}
+declare const _default: WorkadventureProximityMeetingCommands;
+export default _default;

package/Api/Iframe/Players/RemotePlayer.d.ts

@@ -0,0 +1,81 @@
+import { AddPlayerEvent } from "../../Events/AddPlayerEvent";
+import { Observable, Subject } from "rxjs";
+import { PlayerPosition } from "../../Events/PlayerPosition";
+import { ActionsMenuAction } from "../ui";
+export declare const remotePlayers: Map<number, RemotePlayer>;
+export interface RemotePlayerInterface {
+    /**
+     * A unique ID for this player. Each character on the map has a unique ID
+     */
+    readonly playerId: number;
+    /**
+     * The displayed name for this player
+     */
+    readonly name: string;
+    /**
+     * A unique ID for the user. Unlike the "id", 2 characters can have the same UUID if they belong to the same user
+     * (i.e. if the same user logged twice using 2 different tabs)
+     */
+    readonly uuid: string;
+    /**
+     * The color of the outline around the player's name
+     */
+    readonly outlineColor: number | undefined;
+    /**
+     * The position of the current player, expressed in game pixels, relative to the top - left of the map.
+     */
+    readonly position: PlayerPosition;
+    /**
+     * A stream updated with the position of this current player.
+     */
+    readonly position$: Observable<PlayerPosition>;
+    /**
+     * An object storing players variables
+     */
+    readonly state: ReadOnlyState;
+}
+export declare type ReadOnlyState = {
+    onVariableChange(key: string): Observable<unknown>;
+} & {
+    readonly [key: string]: unknown;
+};
+export declare class RemotePlayer implements RemotePlayerInterface {
+    private _playerId;
+    private _name;
+    private _userUuid;
+    private _availabilityStatus;
+    private _outlineColor;
+    private _position;
+    private _variables;
+    private _variablesSubjects;
+    readonly state: ReadOnlyState;
+    private actions;
+    constructor(addPlayerEvent: AddPlayerEvent);
+    get playerId(): number;
+    get name(): string;
+    get uuid(): string;
+    /**
+     * Todo
+     */
+    get outlineColor(): number | undefined;
+    get position(): PlayerPosition;
+    set position(_position: PlayerPosition);
+    readonly _position$: Subject<{
+        x: number;
+        y: number;
+    }>;
+    readonly position$: Observable<{
+        x: number;
+        y: number;
+    }>;
+    destroy(): void;
+    setVariable(name: string, value: unknown): void;
+    addAction(key: string, callback: () => void): ActionsMenuAction;
+    callAction(key: string): void;
+    removeAction(key: string): void;
+}
+export interface RemotePlayerMoved {
+    player: RemotePlayerInterface;
+    newPosition: PlayerPosition;
+    oldPosition: PlayerPosition;
+}

package/Api/Iframe/Sound/Sound.d.ts

@@ -0,0 +1,43 @@
+/**
+ * A copy of the SoundConfig type from Phaser
+ */
+export declare type SoundConfig = {
+    /**
+     * Boolean indicating whether the sound should be muted or not.
+     */
+    mute?: boolean;
+    /**
+     * A value between 0 (silence) and 1 (full volume).
+     */
+    volume?: number;
+    /**
+     * Defines the speed at which the sound should be played.
+     */
+    rate?: number;
+    /**
+     * Represents detuning of sound in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).
+     */
+    detune?: number;
+    /**
+     * Position of playback for this sound, in seconds.
+     */
+    seek?: number;
+    /**
+     * Whether or not the sound or current sound marker should loop.
+     */
+    loop?: boolean;
+    /**
+     * Time, in seconds, that should elapse before the sound actually starts its playback.
+     */
+    delay?: number;
+    /**
+     * A value between -1 (full left pan) and 1 (full right pan). 0 means no pan.
+     */
+    pan?: number;
+};
+export declare class Sound {
+    private url;
+    constructor(url: string);
+    play(config: SoundConfig | undefined): string;
+    stop(): string;
+}

package/Api/{iframe → Iframe}/Ui/UIWebsite.d.ts

@@ -1,4 +1,4 @@
-import { CreateUIWebsiteEvent, UIWebsiteMargin, UIWebsitePosition, UIWebsiteSize, UIWebsite as UIWebsiteCore } from "../../Events/ui/UIWebsite";
+import { CreateUIWebsiteEvent, UIWebsiteMargin, UIWebsitePosition, UIWebsiteSize, UIWebsite as UIWebsiteCore } from "../../Events/Ui/UIWebsite";
 import { IframeApiContribution } from "../IframeApiContribution";
 export declare class UIWebsite {
     readonly id: string;
@@ -26,7 +26,20 @@ export declare class UIWebsite {
 }
 export declare class UIWebsiteCommands extends IframeApiContribution<UIWebsiteCommands> {
     callbacks: never[];
+    /**
+     * Open an iFrame that is fixed in the viewport. Use this for advanced popups, additional buttons in the UI, HUD, etc... Returns a promise of a UIWebsite instance.
+     * {@link https://workadventu.re/map-building/api-ui.md#display-a-ui-website | Website documentation}
+     *
+     * @param {CreateUIWebsiteEvent} createUIWebsite The details of the UIWebsite to create
+     * @returns {Promise<UIWebsite>} Promise to return a UIWebsite
+     */
     open(createUIWebsite: CreateUIWebsiteEvent): Promise<UIWebsite>;
+    /**
+     * Returns all UI websites (iframes positionned on the viewport)
+     * {@link https://workadventu.re/map-building/api-ui.md#get-all-ui-websites | Website documentation}
+     *
+     * @returns {Promise<UIWebsite[]>} Promise to return all UI websites
+     */
     getAll(): Promise<UIWebsite[]>;
 }
 declare const _default: UIWebsiteCommands;

package/Api/Iframe/area.d.ts

@@ -0,0 +1,59 @@
+import { Observable } from "rxjs";
+import { CreateAreaEvent } 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 a new Area object (currently limited to rectangular shapes).
+     * {@link https://workadventu.re/map-building/api-room.md#create-area | Website documentation}
+     *
+     * @param {{name: string, x: number, y: number, width: number, height: number}} createAreaEvent Define the name, position and size of the area
+     * @returns {Area} Area object
+     */
+    create(createAreaEvent: CreateAreaEvent): Area;
+    /**
+     * Get an existing Area object.
+     * {@link https://workadventu.re/map-building/api-room.md#get-an-area | Website documentation}
+     *
+     * @param {string} name Name of the area searched
+     * @returns {Area} Area found
+     */
+    get(name: string): Promise<Area>;
+    /**
+     * Delete Area by it's name.
+     * {@link https://workadventu.re/map-building/api-room.md#delete-area | Website documentation}
+     *
+     * @param {string} name Area name
+     * @returns {Promise<void>} Promise resolved when the removing is finished
+     */
+    delete(name: string): Promise<void>;
+    /**
+     * Listens to the position of the current user. The event is triggered when the user enters a given area.
+     * {@link https://workadventu.re/map-building/api-room.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://workadventu.re/map-building/api-room.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>;
+}
+declare const _default: WorkadventureAreaCommands;
+export default _default;