@workadventure/iframe-api-typings 1.10.2 → 1.11.0

package/Api/Events/OpenPopupEvent.d.ts

@@ -24,16 +24,16 @@ export declare const isOpenPopupEvent: z.ZodObject<{
         label: string;
     }>, "many">;
 }, "strip", z.ZodTypeAny, {
-    popupId: number;
     message: string;
+    popupId: number;
     targetObject: string;
     buttons: {
         className?: string | undefined;
         label: string;
     }[];
 }, {
-    popupId: number;
     message: string;
+    popupId: number;
     targetObject: string;
     buttons: {
         className?: string | undefined;

package/Api/Events/RemotePlayerClickedEvent.d.ts

@@ -1,10 +1,16 @@
 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.

package/Api/Events/SetAreaPropertyEvent.d.ts

@@ -0,0 +1,18 @@
+import { z } from "zod";
+export declare const isSetAreaPropertyEvent: z.ZodObject<{
+    areaName: z.ZodString;
+    propertyName: z.ZodString;
+    propertyValue: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
+}, "strip", z.ZodTypeAny, {
+    propertyValue?: string | number | boolean | undefined;
+    propertyName: string;
+    areaName: string;
+}, {
+    propertyValue?: string | number | boolean | undefined;
+    propertyName: string;
+    areaName: string;
+}>;
+/**
+ * A message sent from the iFrame to the game to change the value of the property of the area
+ */
+export declare type SetAreaPropertyEvent = z.infer<typeof isSetAreaPropertyEvent>;

package/Api/Events/ui/UIWebsite.d.ts

@@ -7,15 +7,15 @@ export declare const isUIWebsiteMargin: z.ZodObject<{
     left: z.ZodOptional<z.ZodString>;
     right: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
-    right?: string | undefined;
-    left?: string | undefined;
     top?: string | undefined;
     bottom?: string | undefined;
-}, {
-    right?: string | undefined;
     left?: string | undefined;
+    right?: string | undefined;
+}, {
     top?: string | undefined;
     bottom?: string | undefined;
+    left?: string | undefined;
+    right?: string | undefined;
 }>;
 export declare type UIWebsiteMargin = z.infer<typeof isUIWebsiteMargin>;
 export declare const isViewportPositionVertical: z.ZodEnum<["top", "middle", "bottom"]>;
@@ -27,10 +27,10 @@ export declare const isUIWebsitePosition: z.ZodObject<{
     horizontal: z.ZodEnum<["left", "middle", "right"]>;
 }, "strip", z.ZodTypeAny, {
     vertical: "top" | "middle" | "bottom";
-    horizontal: "right" | "left" | "middle";
+    horizontal: "middle" | "left" | "right";
 }, {
     vertical: "top" | "middle" | "bottom";
-    horizontal: "right" | "left" | "middle";
+    horizontal: "middle" | "left" | "right";
 }>;
 export declare type UIWebsitePosition = z.infer<typeof isUIWebsitePosition>;
 export declare const isUIWebsiteSize: z.ZodObject<{
@@ -54,10 +54,10 @@ export declare const isCreateUIWebsiteEvent: z.ZodObject<{
         horizontal: z.ZodEnum<["left", "middle", "right"]>;
     }, "strip", z.ZodTypeAny, {
         vertical: "top" | "middle" | "bottom";
-        horizontal: "right" | "left" | "middle";
+        horizontal: "middle" | "left" | "right";
     }, {
         vertical: "top" | "middle" | "bottom";
-        horizontal: "right" | "left" | "middle";
+        horizontal: "middle" | "left" | "right";
     }>;
     size: z.ZodObject<{
         height: z.ZodString;
@@ -75,30 +75,30 @@ export declare const isCreateUIWebsiteEvent: z.ZodObject<{
         left: z.ZodOptional<z.ZodString>;
         right: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
-        right?: string | undefined;
-        left?: string | undefined;
         top?: string | undefined;
         bottom?: string | undefined;
-    }, {
-        right?: string | undefined;
         left?: string | undefined;
+        right?: string | undefined;
+    }, {
         top?: string | undefined;
         bottom?: string | undefined;
+        left?: string | undefined;
+        right?: string | undefined;
     }>>;
 }, "strip", z.ZodTypeAny, {
     allowApi?: boolean | undefined;
     allowPolicy?: string | undefined;
     visible?: boolean | undefined;
     margin?: {
-        right?: string | undefined;
-        left?: string | undefined;
         top?: string | undefined;
         bottom?: string | undefined;
+        left?: string | undefined;
+        right?: string | undefined;
     } | undefined;
     url: string;
     position: {
         vertical: "top" | "middle" | "bottom";
-        horizontal: "right" | "left" | "middle";
+        horizontal: "middle" | "left" | "right";
     };
     size: {
         width: string;
@@ -109,15 +109,15 @@ export declare const isCreateUIWebsiteEvent: z.ZodObject<{
     allowPolicy?: string | undefined;
     visible?: boolean | undefined;
     margin?: {
-        right?: string | undefined;
-        left?: string | undefined;
         top?: string | undefined;
         bottom?: string | undefined;
+        left?: string | undefined;
+        right?: string | undefined;
     } | undefined;
     url: string;
     position: {
         vertical: "top" | "middle" | "bottom";
-        horizontal: "right" | "left" | "middle";
+        horizontal: "middle" | "left" | "right";
     };
     size: {
         width: string;
@@ -134,10 +134,10 @@ export declare const isModifyUIWebsiteEvent: z.ZodObject<{
         horizontal: z.ZodEnum<["left", "middle", "right"]>;
     }, "strip", z.ZodTypeAny, {
         vertical: "top" | "middle" | "bottom";
-        horizontal: "right" | "left" | "middle";
+        horizontal: "middle" | "left" | "right";
     }, {
         vertical: "top" | "middle" | "bottom";
-        horizontal: "right" | "left" | "middle";
+        horizontal: "middle" | "left" | "right";
     }>>;
     size: z.ZodOptional<z.ZodObject<{
         height: z.ZodString;
@@ -155,21 +155,21 @@ export declare const isModifyUIWebsiteEvent: z.ZodObject<{
         left: z.ZodOptional<z.ZodString>;
         right: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
-        right?: string | undefined;
-        left?: string | undefined;
         top?: string | undefined;
         bottom?: string | undefined;
-    }, {
-        right?: string | undefined;
         left?: string | undefined;
+        right?: string | undefined;
+    }, {
         top?: string | undefined;
         bottom?: string | undefined;
+        left?: string | undefined;
+        right?: string | undefined;
     }>>;
 }, "strip", z.ZodTypeAny, {
     url?: string | undefined;
     position?: {
         vertical: "top" | "middle" | "bottom";
-        horizontal: "right" | "left" | "middle";
+        horizontal: "middle" | "left" | "right";
     } | undefined;
     visible?: boolean | undefined;
     size?: {
@@ -177,17 +177,17 @@ export declare const isModifyUIWebsiteEvent: z.ZodObject<{
         height: string;
     } | undefined;
     margin?: {
-        right?: string | undefined;
-        left?: string | undefined;
         top?: string | undefined;
         bottom?: string | undefined;
+        left?: string | undefined;
+        right?: string | undefined;
     } | undefined;
     id: string;
 }, {
     url?: string | undefined;
     position?: {
         vertical: "top" | "middle" | "bottom";
-        horizontal: "right" | "left" | "middle";
+        horizontal: "middle" | "left" | "right";
     } | undefined;
     visible?: boolean | undefined;
     size?: {
@@ -195,10 +195,10 @@ export declare const isModifyUIWebsiteEvent: z.ZodObject<{
         height: string;
     } | undefined;
     margin?: {
-        right?: string | undefined;
-        left?: string | undefined;
         top?: string | undefined;
         bottom?: string | undefined;
+        left?: string | undefined;
+        right?: string | undefined;
     } | undefined;
     id: string;
 }>;
@@ -214,10 +214,10 @@ export declare const isUIWebsite: z.ZodObject<{
         horizontal: z.ZodEnum<["left", "middle", "right"]>;
     }, "strip", z.ZodTypeAny, {
         vertical: "top" | "middle" | "bottom";
-        horizontal: "right" | "left" | "middle";
+        horizontal: "middle" | "left" | "right";
     }, {
         vertical: "top" | "middle" | "bottom";
-        horizontal: "right" | "left" | "middle";
+        horizontal: "middle" | "left" | "right";
     }>;
     size: z.ZodObject<{
         height: z.ZodString;
@@ -235,29 +235,29 @@ export declare const isUIWebsite: z.ZodObject<{
         left: z.ZodOptional<z.ZodString>;
         right: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
-        right?: string | undefined;
-        left?: string | undefined;
         top?: string | undefined;
         bottom?: string | undefined;
-    }, {
-        right?: string | undefined;
         left?: string | undefined;
+        right?: string | undefined;
+    }, {
         top?: string | undefined;
         bottom?: string | undefined;
+        left?: string | undefined;
+        right?: string | undefined;
     }>>;
 }, "strip", z.ZodTypeAny, {
     margin?: {
-        right?: string | undefined;
-        left?: string | undefined;
         top?: string | undefined;
         bottom?: string | undefined;
+        left?: string | undefined;
+        right?: string | undefined;
     } | undefined;
     url: string;
     allowApi: boolean;
     allowPolicy: string;
     position: {
         vertical: "top" | "middle" | "bottom";
-        horizontal: "right" | "left" | "middle";
+        horizontal: "middle" | "left" | "right";
     };
     id: string;
     visible: boolean;
@@ -267,17 +267,17 @@ export declare const isUIWebsite: z.ZodObject<{
     };
 }, {
     margin?: {
-        right?: string | undefined;
-        left?: string | undefined;
         top?: string | undefined;
         bottom?: string | undefined;
+        left?: string | undefined;
+        right?: string | undefined;
     } | undefined;
     url: string;
     allowApi: boolean;
     allowPolicy: string;
     position: {
         vertical: "top" | "middle" | "bottom";
-        horizontal: "right" | "left" | "middle";
+        horizontal: "middle" | "left" | "right";
     };
     id: string;
     visible: boolean;

package/Api/iframe/Area/Area.d.ts

@@ -0,0 +1,22 @@
+import { ITiledMapObject } from "../../../Phaser/Map/ITiledMap";
+import { CreateAreaEvent } from "../../Events/CreateAreaEvent";
+export declare type IArea = Omit<ITiledMapObject, "id" | "gid" | "visible" | "rotation" | "ellipse" | "polygon" | "polyline">;
+export declare class Area implements IArea {
+    private config;
+    readonly name: string;
+    readonly type: string;
+    private _x;
+    private _y;
+    private _width;
+    private _height;
+    constructor(config: CreateAreaEvent);
+    setProperty(propertyName: string, propertyValue: string | number | boolean | undefined): void;
+    set x(x: number);
+    set y(y: number);
+    set width(width: number);
+    set height(height: number);
+    get x(): number;
+    get y(): number;
+    get width(): number;
+    get height(): number;
+}

package/Api/iframe/IframeApiContribution.d.ts

@@ -1,25 +1,17 @@
-import { z } from "zod";
-import type { IframeEvent, IframeQuery, IframeQueryMap, IframeResponseEventMap } from "../Events/IframeEvent";
+import type { IframeEvent, IframeQuery, IframeQueryMap } from "../Events/IframeEvent";
 export declare function sendToWorkadventure(content: IframeEvent): void;
 export declare const answerPromises: Map<number, {
     resolve: (value: IframeQueryMap[keyof IframeQueryMap]["answer"] | PromiseLike<IframeQueryMap[keyof IframeQueryMap]["answer"]>) => void;
     reject: (reason?: any) => void;
 }>;
 export declare function queryWorkadventure<T extends keyof IframeQueryMap>(content: IframeQuery<T>): Promise<IframeQueryMap[T]["answer"]>;
-export interface IframeCallback<Key extends keyof IframeResponseEventMap, T = IframeResponseEventMap[Key], Guard = z.ZodType<T>> {
-    typeChecker: Guard;
-    callback: (payloadData: T) => void;
-}
-export interface IframeCallbackContribution<Key extends keyof IframeResponseEventMap> extends IframeCallback<Key> {
-    type: Key;
-}
 /**
  * !! be aware that the implemented attributes (addMethodsAtRoot and subObjectIdentifier) must be readonly
  *
  *
  */
 export declare abstract class IframeApiContribution<T extends {
-    callbacks: Array<IframeCallbackContribution<keyof IframeResponseEventMap>>;
+    callbacks: unknown[];
 }> {
     abstract callbacks: T["callbacks"];
 }

package/Api/iframe/area.d.ts

@@ -0,0 +1,25 @@
+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

@@ -2,7 +2,16 @@ import { IframeApiContribution } from "./IframeApiContribution";
 import { Subject } from "rxjs";
 import type { WasCameraUpdatedEvent } from "../Events/WasCameraUpdatedEvent";
 export declare class WorkAdventureCameraCommands extends IframeApiContribution<WorkAdventureCameraCommands> {
-    callbacks: import("./IframeApiContribution").IframeCallbackContribution<keyof import("../Events/IframeEvent").IframeResponseEventMap>[];
+    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>;

package/Api/iframe/chat.d.ts

@@ -1,6 +1,11 @@
 import { IframeApiContribution } from "./IframeApiContribution";
 export declare class WorkadventureChatCommands extends IframeApiContribution<WorkadventureChatCommands> {
-    callbacks: import("./IframeApiContribution").IframeCallbackContribution<keyof import("../Events/IframeEvent").IframeResponseEventMap>[];
+    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.

package/Api/iframe/player.d.ts

@@ -9,7 +9,17 @@ export declare class WorkadventurePlayerCommands extends IframeApiContribution<W
     readonly state: import("./state").WorkadventureStateCommands & {
         [key: string]: unknown;
     };
-    callbacks: import("./IframeApiContribution").IframeCallbackContribution<keyof import("../Events/IframeEvent").IframeResponseEventMap>[];
+    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;

package/Api/iframe/registeredCallbacks.d.ts

@@ -1,7 +1,17 @@
-import type { IframeResponseEventMap } from "../../Api/Events/IframeEvent";
-import type { IframeCallback } from "../../Api/iframe/IframeApiContribution";
-import type { IframeCallbackContribution } from "../../Api/iframe/IframeApiContribution";
+import { IframeResponseEvent } from "../../Api/Events/IframeEvent";
 export declare const registeredCallbacks: {
-    [K in keyof IframeResponseEventMap]?: IframeCallback<K>;
+    [K in IframeResponseEvent["type"]]?: (event: Extract<IframeResponseEvent, {
+        type: K;
+    }>["data"]) => void;
+};
+export declare function apiCallback<T extends IframeResponseEvent["type"]>(callbackData: {
+    type: T;
+    callback: (event: Extract<IframeResponseEvent, {
+        type: T;
+    }>["data"]) => void;
+}): {
+    type: T;
+    callback: (event: Extract<IframeResponseEvent, {
+        type: T;
+    }>["data"]) => void;
 };
-export declare function apiCallback<T extends keyof IframeResponseEventMap>(callbackData: IframeCallbackContribution<T>): IframeCallbackContribution<keyof IframeResponseEventMap>;

package/Api/iframe/room.d.ts

@@ -2,6 +2,7 @@ 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;
@@ -11,7 +12,27 @@ interface TileDescriptor {
 export declare const setRoomId: (id: string) => void;
 export declare const setMapURL: (url: string) => void;
 export declare class WorkadventureRoomCommands extends IframeApiContribution<WorkadventureRoomCommands> {
-    callbacks: import("./IframeApiContribution").IframeCallbackContribution<keyof import("../Events/IframeEvent").IframeResponseEventMap>[];
+    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
      */
@@ -31,6 +52,7 @@ export declare class WorkadventureRoomCommands extends IframeApiContribution<Wor
     get mapURL(): string;
     loadTileset(url: string): Promise<number>;
     get website(): WorkadventureRoomWebsiteCommands;
+    get area(): WorkadventureAreaCommands;
 }
 declare const _default: WorkadventureRoomCommands;
 export default _default;

package/Api/iframe/state.d.ts

@@ -6,7 +6,14 @@ export declare class WorkadventureStateCommands extends IframeApiContribution<Wo
     private variables;
     private variableSubscribers;
     constructor(target: "global" | "player");
-    callbacks: import("./IframeApiContribution").IframeCallbackContribution<keyof import("../Events/IframeEvent").IframeResponseEventMap>[];
+    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;

package/Api/iframe/ui.d.ts

@@ -4,6 +4,7 @@ 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";
 interface MenuDescriptor {
@@ -17,13 +18,12 @@ export interface ActionMessageOptions {
     type?: "message" | "warning";
     callback: () => void;
 }
-export interface RemotePlayerInterface {
-    addAction(key: string, callback: Function): void;
-}
-export declare class RemotePlayer implements RemotePlayerInterface {
-    private id;
+export declare class RemotePlayer {
+    readonly id: number;
+    readonly uuid: string;
+    readonly name: string;
     private actions;
-    constructor(id: number);
+    constructor(remotePlayer: RemotePlayerClickedEvent);
     addAction(key: string, callback: Function): ActionsMenuAction;
     callAction(key: string): void;
     removeAction(key: string): void;
@@ -37,11 +37,40 @@ export declare class ActionsMenuAction {
     remove(): void;
 }
 export declare class WorkAdventureUiCommands extends IframeApiContribution<WorkAdventureUiCommands> {
-    readonly _onRemotePlayerClicked: Subject<RemotePlayerInterface>;
-    readonly onRemotePlayerClicked: Observable<RemotePlayerInterface>;
+    readonly _onRemotePlayerClicked: Subject<RemotePlayer>;
+    readonly onRemotePlayerClicked: Observable<RemotePlayer>;
     private currentlyClickedRemotePlayer?;
     constructor();
-    callbacks: import("./IframeApiContribution").IframeCallbackContribution<keyof import("../Events/IframeEvent").IframeResponseEventMap>[];
+    callbacks: ({
+        type: "buttonClickedEvent";
+        callback: (event: {
+            popupId: number;
+            buttonId: number;
+        }) => void;
+    } | {
+        type: "menuItemClicked";
+        callback: (event: {
+            menuItem: string;
+        }) => void;
+    } | {
+        type: "messageTriggered";
+        callback: (event: {
+            uuid: string;
+        }) => void;
+    } | {
+        type: "remotePlayerClickedEvent";
+        callback: (event: {
+            id: number;
+            name: string;
+            uuid: string;
+        }) => void;
+    } | {
+        type: "actionsMenuActionClickedEvent";
+        callback: (event: {
+            id: number;
+            actionName: string;
+        }) => void;
+    })[];
     addActionsMenuKeyToRemotePlayer(id: number, actionKey: string): void;
     removeActionsMenuKeyFromRemotePlayer(id: number, actionKey: string): void;
     openPopup(targetObject: string, message: string, buttons: ButtonDescriptor[]): Popup;

package/package.json

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