@workadventure/iframe-api-typings 1.20.2 → 1.21.1

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

@@ -9,13 +9,13 @@ export declare const isUIWebsiteMargin: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     left?: string | undefined;
     top?: string | undefined;
-    right?: string | undefined;
     bottom?: string | undefined;
+    right?: string | undefined;
 }, {
     left?: string | undefined;
     top?: string | undefined;
-    right?: string | undefined;
     bottom?: string | undefined;
+    right?: string | undefined;
 }>;
 export type UIWebsiteMargin = z.infer<typeof isUIWebsiteMargin>;
 export declare const isViewportPositionVertical: z.ZodEnum<["top", "middle", "bottom"]>;
@@ -77,24 +77,15 @@ export declare const isCreateUIWebsiteEvent: z.ZodObject<{
     }, "strip", z.ZodTypeAny, {
         left?: string | undefined;
         top?: string | undefined;
-        right?: string | undefined;
         bottom?: string | undefined;
+        right?: string | undefined;
     }, {
         left?: string | undefined;
         top?: string | undefined;
-        right?: string | undefined;
         bottom?: string | undefined;
+        right?: string | undefined;
     }>>;
 }, "strip", z.ZodTypeAny, {
-    allowApi?: boolean | undefined;
-    allowPolicy?: string | undefined;
-    visible?: boolean | undefined;
-    margin?: {
-        left?: string | undefined;
-        top?: string | undefined;
-        right?: string | undefined;
-        bottom?: string | undefined;
-    } | undefined;
     url: string;
     position: {
         vertical: "top" | "bottom" | "middle";
@@ -104,16 +95,16 @@ export declare const isCreateUIWebsiteEvent: z.ZodObject<{
         height: string;
         width: string;
     };
-}, {
     allowApi?: boolean | undefined;
     allowPolicy?: string | undefined;
     visible?: boolean | undefined;
     margin?: {
         left?: string | undefined;
         top?: string | undefined;
-        right?: string | undefined;
         bottom?: string | undefined;
+        right?: string | undefined;
     } | undefined;
+}, {
     url: string;
     position: {
         vertical: "top" | "bottom" | "middle";
@@ -123,6 +114,15 @@ export declare const isCreateUIWebsiteEvent: z.ZodObject<{
         height: string;
         width: string;
     };
+    allowApi?: boolean | undefined;
+    allowPolicy?: string | undefined;
+    visible?: boolean | undefined;
+    margin?: {
+        left?: string | undefined;
+        top?: string | undefined;
+        bottom?: string | undefined;
+        right?: string | undefined;
+    } | undefined;
 }>;
 export type CreateUIWebsiteEvent = z.infer<typeof isCreateUIWebsiteEvent>;
 export declare const isModifyUIWebsiteEvent: z.ZodObject<{
@@ -157,15 +157,16 @@ export declare const isModifyUIWebsiteEvent: z.ZodObject<{
     }, "strip", z.ZodTypeAny, {
         left?: string | undefined;
         top?: string | undefined;
-        right?: string | undefined;
         bottom?: string | undefined;
+        right?: string | undefined;
     }, {
         left?: string | undefined;
         top?: string | undefined;
-        right?: string | undefined;
         bottom?: string | undefined;
+        right?: string | undefined;
     }>>;
 }, "strip", z.ZodTypeAny, {
+    id: string;
     url?: string | undefined;
     position?: {
         vertical: "top" | "bottom" | "middle";
@@ -179,11 +180,11 @@ export declare const isModifyUIWebsiteEvent: z.ZodObject<{
     margin?: {
         left?: string | undefined;
         top?: string | undefined;
-        right?: string | undefined;
         bottom?: string | undefined;
+        right?: string | undefined;
     } | undefined;
-    id: string;
 }, {
+    id: string;
     url?: string | undefined;
     position?: {
         vertical: "top" | "bottom" | "middle";
@@ -197,10 +198,9 @@ export declare const isModifyUIWebsiteEvent: z.ZodObject<{
     margin?: {
         left?: string | undefined;
         top?: string | undefined;
-        right?: string | undefined;
         bottom?: string | undefined;
+        right?: string | undefined;
     } | undefined;
-    id: string;
 }>;
 export type ModifyUIWebsiteEvent = z.infer<typeof isModifyUIWebsiteEvent>;
 export declare const isUIWebsiteEvent: z.ZodObject<{
@@ -237,53 +237,53 @@ export declare const isUIWebsiteEvent: z.ZodObject<{
     }, "strip", z.ZodTypeAny, {
         left?: string | undefined;
         top?: string | undefined;
-        right?: string | undefined;
         bottom?: string | undefined;
+        right?: string | undefined;
     }, {
         left?: string | undefined;
         top?: string | undefined;
-        right?: string | undefined;
         bottom?: string | undefined;
+        right?: string | undefined;
     }>>;
 }, "strip", z.ZodTypeAny, {
-    margin?: {
-        left?: string | undefined;
-        top?: string | undefined;
-        right?: string | undefined;
-        bottom?: string | undefined;
-    } | undefined;
     url: string;
     id: string;
+    allowApi: boolean;
+    allowPolicy: string;
     position: {
         vertical: "top" | "bottom" | "middle";
         horizontal: "left" | "right" | "middle";
     };
-    allowApi: boolean;
-    allowPolicy: string;
     visible: boolean;
     size: {
         height: string;
         width: string;
     };
-}, {
     margin?: {
         left?: string | undefined;
         top?: string | undefined;
-        right?: string | undefined;
         bottom?: string | undefined;
+        right?: string | undefined;
     } | undefined;
+}, {
     url: string;
     id: string;
+    allowApi: boolean;
+    allowPolicy: string;
     position: {
         vertical: "top" | "bottom" | "middle";
         horizontal: "left" | "right" | "middle";
     };
-    allowApi: boolean;
-    allowPolicy: string;
     visible: boolean;
     size: {
         height: string;
         width: string;
     };
+    margin?: {
+        left?: string | undefined;
+        top?: string | undefined;
+        bottom?: string | undefined;
+        right?: string | undefined;
+    } | undefined;
 }>;
 export type UIWebsiteEvent = z.infer<typeof isUIWebsiteEvent>;

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

@@ -3,11 +3,11 @@ export declare const isUserInputChatEvent: z.ZodObject<{
     message: z.ZodString;
     senderId: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
-    senderId?: number | undefined;
     message: string;
-}, {
     senderId?: number | undefined;
+}, {
     message: string;
+    senderId?: number | undefined;
 }>;
 /**
  * A message sent from the game to the iFrame when a user types a message in the chat.

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

@@ -4,14 +4,14 @@ import { ReceiveEventEvent } from "../Events/ReceiveEventEvent";
 export type ScriptingEvent = ReceiveEventEvent;
 export declare abstract class AbstractWorkadventureEventCommands {
     protected receivedEventResolvers: Subject<{
+        name: string;
         data?: unknown;
         senderId?: number | undefined;
-        name: string;
     }>;
     protected eventSubscribers: Map<string, Subject<{
+        name: string;
         data?: unknown;
         senderId?: number | undefined;
-        name: string;
     }>>;
     protected constructor();
     on(key: string): Observable<ScriptingEvent>;

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

@@ -4,8 +4,8 @@ export declare abstract class AbstractWorkadventureStateCommands<State extends {
     [key: string]: unknown;
 }> {
     protected setVariableResolvers: Subject<{
-        value?: unknown;
         key: string;
+        value?: unknown;
     }>;
     protected variables: Partial<State>;
     protected variableSubscribers: Partial<{

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

@@ -12,48 +12,51 @@ export declare class WorkadventureProximityMeetingCommands extends IframeApiCont
         type: "joinProximityMeetingEvent";
         callback: (event: {
             users: {
-                outlineColor?: number | undefined;
                 name: string;
-                availabilityStatus: string;
                 position: {
                     x: number;
                     y: number;
                 };
-                userUuid: string;
-                variables: Map<string, unknown>;
                 playerId: number;
+                variables: Map<string, unknown>;
+                userUuid: string;
+                availabilityStatus: string;
+                outlineColor?: number | undefined;
+                chatID?: string | null | undefined;
             }[];
         }) => void;
     } | {
         type: "participantJoinProximityMeetingEvent";
         callback: (event: {
             user: {
-                outlineColor?: number | undefined;
                 name: string;
-                availabilityStatus: string;
                 position: {
                     x: number;
                     y: number;
                 };
-                userUuid: string;
-                variables: Map<string, unknown>;
                 playerId: number;
+                variables: Map<string, unknown>;
+                userUuid: string;
+                availabilityStatus: string;
+                outlineColor?: number | undefined;
+                chatID?: string | null | undefined;
             };
         }) => void;
     } | {
         type: "participantLeaveProximityMeetingEvent";
         callback: (event: {
             user: {
-                outlineColor?: number | undefined;
                 name: string;
-                availabilityStatus: string;
                 position: {
                     x: number;
                     y: number;
                 };
-                userUuid: string;
-                variables: Map<string, unknown>;
                 playerId: number;
+                variables: Map<string, unknown>;
+                userUuid: string;
+                availabilityStatus: string;
+                outlineColor?: number | undefined;
+                chatID?: string | null | undefined;
             };
         }) => void;
     } | {
@@ -63,32 +66,34 @@ export declare class WorkadventureProximityMeetingCommands extends IframeApiCont
         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;
+                variables: Map<string, unknown>;
+                userUuid: string;
+                availabilityStatus: string;
+                outlineColor?: number | undefined;
+                chatID?: string | null | undefined;
             };
         }) => 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;
+                variables: Map<string, unknown>;
+                userUuid: string;
+                availabilityStatus: string;
+                outlineColor?: number | undefined;
+                chatID?: string | null | undefined;
             };
         }) => void;
     })[];

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

@@ -6,10 +6,10 @@ export declare class WorkadventureModalCommands extends IframeApiContribution<Wo
         type: "modalCloseTrigger";
         callback: (event: {
             title: string;
-            position: "left" | "right" | "center";
-            src: string;
             allowApi: boolean;
+            position: "left" | "right" | "center";
             allow: string | null;
+            src: string;
         }) => void;
     }[];
     /**

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

@@ -12,8 +12,8 @@ export declare class WorkadventureChatCommands<PublicState extends {
     callbacks: {
         type: "userInputChat";
         callback: (event: {
-            senderId?: number | undefined;
             message: string;
+            senderId?: number | undefined;
         }) => void;
     }[];
     /**

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

@@ -4,9 +4,9 @@ export declare class WorkadventureEventCommands extends AbstractWorkadventureEve
     callbacks: {
         type: "receiveEvent";
         callback: (event: {
+            name: string;
             data?: unknown;
             senderId?: number | undefined;
-            name: string;
         }) => void;
     }[];
     broadcast(name: string, data: unknown): Promise<void>;

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

@@ -0,0 +1,37 @@
+import type { Observable } from "rxjs";
+import { IframeApiContribution } from "./IframeApiContribution";
+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://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://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>;
+}
+export declare class WorkadventureMapEditorCommands extends IframeApiContribution<WorkadventureMapEditorCommands> {
+    callbacks: never[];
+    get area(): WorkadventureMapEditorAreaCommands;
+}
+declare const _default: WorkadventureMapEditorCommands;
+export default _default;

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

@@ -15,12 +15,12 @@ export declare class WorkadventurePlayerCommands extends IframeApiContribution<W
     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;
     }[];
     /**

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

@@ -7,8 +7,8 @@ export declare class WorkadventurePlayerStateCommands extends AbstractWorkadvent
     callbacks: {
         type: "setPlayerVariable";
         callback: (event: {
-            value?: unknown;
             key: string;
+            value?: unknown;
         }) => void;
     }[];
     saveVariable<K extends keyof PlayerState & string>(key: K, value: PlayerState[K], options?: {

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

@@ -21,23 +21,24 @@ export declare class WorkadventurePlayersCommands extends IframeApiContribution<
     callbacks: ({
         type: "setSharedPlayerVariable";
         callback: (event: {
-            value?: unknown;
-            key: string;
             playerId: number;
+            key: string;
+            value?: unknown;
         }) => void;
     } | {
         type: "addRemotePlayer";
         callback: (event: {
-            outlineColor?: number | undefined;
             name: string;
-            availabilityStatus: string;
             position: {
                 x: number;
                 y: number;
             };
-            userUuid: string;
-            variables: Map<string, unknown>;
             playerId: number;
+            variables: Map<string, unknown>;
+            userUuid: string;
+            availabilityStatus: string;
+            outlineColor?: number | undefined;
+            chatID?: string | null | undefined;
         }) => void;
     } | {
         type: "removeRemotePlayer";
@@ -45,15 +46,16 @@ export declare class WorkadventurePlayersCommands extends IframeApiContribution<
     } | {
         type: "remotePlayerChanged";
         callback: (event: {
+            playerId: number;
             name?: string | undefined;
-            outlineColor?: number | undefined;
-            availabilityStatus?: string | undefined;
             position?: {
                 x: number;
                 y: number;
             } | undefined;
             variables?: Map<string, unknown> | undefined;
-            playerId: number;
+            availabilityStatus?: string | undefined;
+            outlineColor?: number | undefined;
+            chatID?: string | null | undefined;
         }) => void;
     })[];
     private registerRemotePlayer;

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

@@ -5,8 +5,8 @@ export declare class WorkadventureStateCommands extends AbstractWorkadventureSta
     callbacks: {
         type: "setVariable";
         callback: (event: {
-            value?: unknown;
             key: string;
+            value?: unknown;
         }) => void;
     }[];
     saveVariable<K extends keyof RoomState & string>(key: K, value: RoomState[K]): Promise<void>;

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

@@ -64,16 +64,17 @@ export declare class WorkAdventureUiCommands extends IframeApiContribution<WorkA
     } | {
         type: "remotePlayerClickedEvent";
         callback: (event: {
-            outlineColor?: number | undefined;
             name: string;
-            availabilityStatus: string;
             position: {
                 x: number;
                 y: number;
             };
-            userUuid: string;
-            variables: Map<string, unknown>;
             playerId: number;
+            variables: Map<string, unknown>;
+            userUuid: string;
+            availabilityStatus: string;
+            outlineColor?: number | undefined;
+            chatID?: string | null | undefined;
         }) => void;
     } | {
         type: "actionsMenuActionClickedEvent";

package/play/src/iframe_api.d.ts

@@ -31,6 +31,7 @@ declare const wa: {
     camera: import("./front/Api/Iframe/camera").WorkAdventureCameraCommands;
     state: import("./front/Api/Iframe/state").WorkadventureStateCommands & import("./front/Api/Iframe/RoomState").RoomState;
     event: import("./front/Api/Iframe/event").WorkadventureEventCommands;
+    mapEditor: import("./front/Api/Iframe/mapEditor").WorkadventureMapEditorCommands;
     /**
      * 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

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

@@ -1,18 +0,0 @@
-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 type NotificationEvent = z.infer<typeof isNotificationEvent>;