@workadventure/iframe-api-typings 1.7.0 → 1.8.0

package/Api/Events/CameraFollowPlayerEvent.d.ts

@@ -0,0 +1,8 @@
+import * as tg from "generic-type-guard";
+export declare const isCameraFollowPlayerEvent: tg.TypeGuard<object & {
+    smooth: boolean;
+}>;
+/**
+ * A message sent from the iFrame to the game to make the camera follow player.
+ */
+export declare type CameraFollowPlayerEvent = tg.GuardedType<typeof isCameraFollowPlayerEvent>;

package/Api/Events/CameraSetEvent.d.ts

@@ -0,0 +1,13 @@
+import * as tg from "generic-type-guard";
+export declare const isCameraSetEvent: tg.TypeGuard<object & {
+    x: number;
+    y: number;
+    width: number | undefined;
+    height: number | undefined;
+    lock: boolean;
+    smooth: boolean;
+}>;
+/**
+ * A message sent from the iFrame to the game to change the camera position.
+ */
+export declare type CameraSetEvent = tg.GuardedType<typeof isCameraSetEvent>;

package/Api/Events/EmbeddedWebsiteEvent.d.ts

@@ -16,6 +16,8 @@ export declare const isEmbeddedWebsiteEvent: tg.TypeGuard<object & {
     y: number;
     width: number;
     height: number;
+    origin: "player" | "map";
+    scale: number;
 }>>;
 export declare const isCreateEmbeddedWebsiteEvent: tg.TypeGuard<object & {
     name: string;
@@ -30,6 +32,8 @@ export declare const isCreateEmbeddedWebsiteEvent: tg.TypeGuard<object & {
     visible: boolean;
     allowApi: boolean;
     allow: string;
+    origin: "player" | "map";
+    scale: number;
 }>>;
 /**
  * A message sent from the iFrame to the game to modify an embedded website

package/Api/Events/GameStateEvent.d.ts

@@ -3,10 +3,12 @@ export declare const isGameStateEvent: tg.TypeGuard<object & {
     roomId: string;
     mapUrl: string;
     nickname: string;
+    language: string | undefined;
     uuid: string | undefined;
     startLayerName: string | null;
     tags: string[];
     variables: object;
+    playerVariables: object;
     userRoomToken: string | undefined;
 }>;
 /**

package/Api/Events/IframeEvent.d.ts

@@ -21,7 +21,10 @@ import type { LoadTilesetEvent } from "./LoadTilesetEvent";
 import type { MessageReferenceEvent } from "./ui/TriggerActionMessageEvent";
 import type { MenuRegisterEvent, UnregisterMenuEvent } from "./ui/MenuRegisterEvent";
 import type { ChangeLayerEvent } from "./ChangeLayerEvent";
+import type { WasCameraUpdatedEvent } from "./WasCameraUpdatedEvent";
 import type { ChangeZoneEvent } from "./ChangeZoneEvent";
+import type { CameraSetEvent } from "./CameraSetEvent";
+import type { CameraFollowPlayerEvent } from "./CameraFollowPlayerEvent";
 export interface TypedMessageEvent<T> extends MessageEvent {
     data: T;
 }
@@ -31,6 +34,8 @@ export interface TypedMessageEvent<T> extends MessageEvent {
 export declare type IframeEventMap = {
     loadPage: LoadPageEvent;
     chat: ChatEvent;
+    cameraFollowPlayer: CameraFollowPlayerEvent;
+    cameraSet: CameraSetEvent;
     openPopup: OpenPopupEvent;
     closePopup: ClosePopupEvent;
     openTab: OpenTabEvent;
@@ -40,6 +45,7 @@ export declare type IframeEventMap = {
     displayBubble: null;
     removeBubble: null;
     onPlayerMove: undefined;
+    onCameraUpdate: undefined;
     showLayer: LayerEvent;
     hideLayer: LayerEvent;
     setProperty: SetPropertyEvent;
@@ -68,6 +74,7 @@ export interface IframeResponseEventMap {
     leaveZoneEvent: ChangeZoneEvent;
     buttonClickedEvent: ButtonClickedEvent;
     hasPlayerMoved: HasPlayerMovedEvent;
+    wasCameraUpdated: WasCameraUpdatedEvent;
     menuItemClicked: MenuItemClickedEvent;
     setVariable: SetVariableEvent;
     messageTriggered: MessageReferenceEvent;
@@ -90,10 +97,12 @@ export declare const iframeQueryMapTypeGuards: {
             roomId: string;
             mapUrl: string;
             nickname: string;
+            language: string | undefined;
             uuid: string | undefined;
             startLayerName: string | null;
             tags: string[];
             variables: object;
+            playerVariables: object;
             userRoomToken: string | undefined;
         }>;
     };
@@ -107,6 +116,7 @@ export declare const iframeQueryMapTypeGuards: {
         query: tg.TypeGuard<object & {
             key: string;
             value: unknown;
+            target: "global" | "player";
         }>;
         answer: tg.TypeGuard<undefined>;
     };
@@ -121,18 +131,19 @@ export declare const iframeQueryMapTypeGuards: {
             url: string;
             allowApi: boolean | undefined;
             allowPolicy: string | undefined;
+            widthPercent: number | undefined;
             position: number | undefined;
+            closable: boolean | undefined;
+            lazy: boolean | undefined;
         }>;
         answer: tg.TypeGuard<object & {
             id: string;
-            position: number;
         }>;
     };
     getCoWebsites: {
         query: tg.TypeGuard<undefined>;
         answer: tg.TypeGuard<(object & {
             id: string;
-            position: number;
         })[]>;
     };
     closeCoWebsite: {
@@ -172,6 +183,8 @@ export declare const iframeQueryMapTypeGuards: {
             visible: boolean;
             allowApi: boolean;
             allow: string;
+            origin: "player" | "map";
+            scale: number;
         }>>;
     };
     deleteEmbeddedWebsite: {
@@ -192,6 +205,8 @@ export declare const iframeQueryMapTypeGuards: {
             visible: boolean;
             allowApi: boolean;
             allow: string;
+            origin: "player" | "map";
+            scale: number;
         }>>;
         answer: tg.TypeGuard<undefined>;
     };
@@ -207,6 +222,25 @@ export declare const iframeQueryMapTypeGuards: {
         query: tg.TypeGuard<undefined>;
         answer: tg.TypeGuard<undefined>;
     };
+    getPlayerPosition: {
+        query: tg.TypeGuard<undefined>;
+        answer: tg.TypeGuard<object & {
+            x: number;
+            y: number;
+        }>;
+    };
+    movePlayerTo: {
+        query: tg.TypeGuard<object & {
+            x: number;
+            y: number;
+            speed: number | undefined;
+        }>;
+        answer: tg.TypeGuard<object & {
+            x: number;
+            y: number;
+            cancelled: boolean;
+        }>;
+    };
 };
 declare type GuardedType<T> = T extends (x: unknown) => x is infer T ? T : never;
 declare type IframeQueryMapTypeGuardsType = typeof iframeQueryMapTypeGuards;
@@ -225,9 +259,9 @@ export interface IframeQueryWrapper<T extends keyof IframeQueryMap> {
     id: number;
     query: IframeQuery<T>;
 }
-export declare const isIframeQueryKey: (type: string) => type is "getState" | "getMapData" | "setVariable" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "triggerActionMessage" | "removeActionMessage" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite" | "setPlayerOutline" | "removePlayerOutline";
-export declare const isIframeQuery: (event: any) => event is IframeQuery<"getState" | "getMapData" | "setVariable" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "triggerActionMessage" | "removeActionMessage" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite" | "setPlayerOutline" | "removePlayerOutline">;
-export declare const isIframeQueryWrapper: (event: any) => event is IframeQueryWrapper<"getState" | "getMapData" | "setVariable" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "triggerActionMessage" | "removeActionMessage" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite" | "setPlayerOutline" | "removePlayerOutline">;
+export declare const isIframeQueryKey: (type: string) => type is "getState" | "getMapData" | "setVariable" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "triggerActionMessage" | "removeActionMessage" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite" | "setPlayerOutline" | "removePlayerOutline" | "getPlayerPosition" | "movePlayerTo";
+export declare const isIframeQuery: (event: any) => event is IframeQuery<"getState" | "getMapData" | "setVariable" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "triggerActionMessage" | "removeActionMessage" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite" | "setPlayerOutline" | "removePlayerOutline" | "getPlayerPosition" | "movePlayerTo">;
+export declare const isIframeQueryWrapper: (event: any) => event is IframeQueryWrapper<"getState" | "getMapData" | "setVariable" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "triggerActionMessage" | "removeActionMessage" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite" | "setPlayerOutline" | "removePlayerOutline" | "getPlayerPosition" | "movePlayerTo">;
 export interface IframeAnswerEvent<T extends keyof IframeQueryMap> {
     id: number;
     type: T;
@@ -236,7 +270,7 @@ export interface IframeAnswerEvent<T extends keyof IframeQueryMap> {
 export declare const isIframeAnswerEvent: (event: {
     type?: string;
     id?: number;
-}) => event is IframeAnswerEvent<"getState" | "getMapData" | "setVariable" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "triggerActionMessage" | "removeActionMessage" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite" | "setPlayerOutline" | "removePlayerOutline">;
+}) => event is IframeAnswerEvent<"getState" | "getMapData" | "setVariable" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "triggerActionMessage" | "removeActionMessage" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite" | "setPlayerOutline" | "removePlayerOutline" | "getPlayerPosition" | "movePlayerTo">;
 export interface IframeErrorAnswerEvent {
     id: number;
     type: keyof IframeQueryMap;

package/Api/Events/MovePlayerToEvent.d.ts

@@ -0,0 +1,7 @@
+import * as tg from "generic-type-guard";
+export declare const isMovePlayerToEventConfig: tg.TypeGuard<object & {
+    x: number;
+    y: number;
+    speed: number | undefined;
+}>;
+export declare type MovePlayerToEvent = tg.GuardedType<typeof isMovePlayerToEventConfig>;

package/Api/Events/MovePlayerToEventAnswer.d.ts

@@ -0,0 +1,7 @@
+import * as tg from "generic-type-guard";
+export declare const isMovePlayerToEventAnswer: tg.TypeGuard<object & {
+    x: number;
+    y: number;
+    cancelled: boolean;
+}>;
+export declare type MovePlayerToEventAnswer = tg.GuardedType<typeof isMovePlayerToEventAnswer>;

package/Api/Events/OpenCoWebsiteEvent.d.ts

@@ -3,11 +3,13 @@ export declare const isOpenCoWebsiteEvent: tg.TypeGuard<object & {
     url: string;
     allowApi: boolean | undefined;
     allowPolicy: string | undefined;
+    widthPercent: number | undefined;
     position: number | undefined;
+    closable: boolean | undefined;
+    lazy: boolean | undefined;
 }>;
 export declare const isCoWebsite: tg.TypeGuard<object & {
     id: string;
-    position: number;
 }>;
 /**
  * A message sent from the iFrame to the game to add a message in the chat.

package/Api/Events/PlayerPosition.d.ts

@@ -0,0 +1,6 @@
+import * as tg from "generic-type-guard";
+export declare const isPlayerPosition: tg.TypeGuard<object & {
+    x: number;
+    y: number;
+}>;
+export declare type PlayerPosition = tg.GuardedType<typeof isPlayerPosition>;

package/Api/Events/SetVariableEvent.d.ts

@@ -2,6 +2,7 @@ import * as tg from "generic-type-guard";
 export declare const isSetVariableEvent: tg.TypeGuard<object & {
     key: string;
     value: unknown;
+    target: "global" | "player";
 }>;
 /**
  * A message sent from the iFrame to the game to change the value of the property of the layer
@@ -12,5 +13,6 @@ export declare const isSetVariableIframeEvent: tg.TypeGuard<object & {
     data: object & {
         key: string;
         value: unknown;
+        target: "global" | "player";
     };
 }>;

package/Api/Events/WasCameraUpdatedEvent.d.ts

@@ -0,0 +1,13 @@
+import * as tg from "generic-type-guard";
+export declare const isWasCameraUpdatedEvent: tg.TypeGuard<object & {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    zoom: number;
+}>;
+/**
+ * A message sent from the game to the iFrame to notify a movement from the camera.
+ */
+export declare type WasCameraUpdatedEvent = tg.GuardedType<typeof isWasCameraUpdatedEvent>;
+export declare type WasCameraUpdatedEventCallback = (event: WasCameraUpdatedEvent) => void;

package/Api/IframeListener.d.ts

@@ -1,6 +1,7 @@
 import { IframeQueryMap, IframeResponseEvent, IframeResponseEventMap } from "./Events/IframeEvent";
 import type { HasPlayerMovedEvent } from "./Events/HasPlayerMovedEvent";
 import type { SetVariableEvent } from "./Events/SetVariableEvent";
+import type { WasCameraUpdatedEvent } from "./Events/WasCameraUpdatedEvent";
 declare type AnswererCallback<T extends keyof IframeQueryMap> = (query: IframeQueryMap[T]["query"], source: MessageEventSource | null) => IframeQueryMap[T]["answer"] | PromiseLike<IframeQueryMap[T]["answer"]>;
 /**
  * Listens to messages from iframes and turn those messages into easy to use observables.
@@ -25,6 +26,19 @@ declare class IframeListener {
     readonly loadPageStream: import("rxjs").Observable<string>;
     private readonly _disablePlayerControlStream;
     readonly disablePlayerControlStream: import("rxjs").Observable<void>;
+    private readonly _cameraSetStream;
+    readonly cameraSetStream: import("rxjs").Observable<object & {
+        x: number;
+        y: number;
+        width: number | undefined;
+        height: number | undefined;
+        lock: boolean;
+        smooth: boolean;
+    }>;
+    private readonly _cameraFollowPlayerStream;
+    readonly cameraFollowPlayerStream: import("rxjs").Observable<object & {
+        smooth: boolean;
+    }>;
     private readonly _enablePlayerControlStream;
     readonly enablePlayerControlStream: import("rxjs").Observable<void>;
     private readonly _closePopupStream;
@@ -70,6 +84,10 @@ declare class IframeListener {
     readonly loadSoundStream: import("rxjs").Observable<object & {
         url: string;
     }>;
+    private readonly _trackCameraUpdateStream;
+    readonly trackCameraUpdateStream: import("rxjs").Observable<object & {
+        url: string;
+    }>;
     private readonly _setTilesStream;
     readonly setTilesStream: import("rxjs").Observable<(object & {
         x: number;
@@ -89,6 +107,8 @@ declare class IframeListener {
         y: number;
         width: number;
         height: number;
+        origin: "player" | "map";
+        scale: number;
     }>>;
     private readonly iframes;
     private readonly iframeCloseCallbacks;
@@ -101,7 +121,7 @@ declare class IframeListener {
      */
     registerIframe(iframe: HTMLIFrameElement): void;
     unregisterIframe(iframe: HTMLIFrameElement): void;
-    registerScript(scriptUrl: string): Promise<void>;
+    registerScript(scriptUrl: string, enableModuleMode?: boolean): Promise<void>;
     private getBaseUrl;
     getBaseUrlFromSource(source: MessageEventSource): string;
     private static getIFrameId;
@@ -114,6 +134,7 @@ declare class IframeListener {
     sendEnterZoneEvent(zoneName: string): void;
     sendLeaveZoneEvent(zoneName: string): void;
     hasPlayerMoved(event: HasPlayerMovedEvent): void;
+    sendCameraUpdated(event: WasCameraUpdatedEvent): void;
     sendButtonClickedEvent(popupId: number, buttonId: number): void;
     setVariable(setVariableEvent: SetVariableEvent): void;
     sendActionMessageTriggered(uuid: string): void;

package/Api/iframe/Room/EmbeddedWebsite.d.ts

@@ -7,11 +7,21 @@ export declare class EmbeddedWebsite {
     private _allow;
     private _allowApi;
     private _position;
+    private readonly origin;
+    private _scale;
     constructor(config: CreateEmbeddedWebsiteEvent);
+    get url(): string;
     set url(url: string);
+    get visible(): boolean;
     set visible(visible: boolean);
+    get x(): number;
     set x(x: number);
+    get y(): number;
     set y(y: number);
+    get width(): number;
     set width(width: number);
+    get height(): number;
     set height(height: number);
+    get scale(): number;
+    set scale(scale: number);
 }

package/Api/iframe/camera.d.ts

@@ -0,0 +1,11 @@
+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>[];
+    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/nav.d.ts

@@ -1,8 +1,7 @@
 import { IframeApiContribution } from "./IframeApiContribution";
 export declare class CoWebsite {
     private readonly id;
-    readonly position: number;
-    constructor(id: string, position: number);
+    constructor(id: string);
     close(): Promise<void>;
 }
 export declare class WorkadventureNavigationCommands extends IframeApiContribution<WorkadventureNavigationCommands> {
@@ -10,7 +9,7 @@ export declare class WorkadventureNavigationCommands extends IframeApiContributi
     openTab(url: string): void;
     goToPage(url: string): void;
     goToRoom(url: string): void;
-    openCoWebSite(url: string, allowApi?: boolean, allowPolicy?: string, position?: number): Promise<CoWebsite>;
+    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

package/Api/iframe/player.d.ts

@@ -1,18 +1,33 @@
 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: import("./IframeApiContribution").IframeCallbackContribution<keyof import("../Events/IframeEvent").IframeResponseEventMap>[];
     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/state.d.ts

@@ -1,14 +1,18 @@
 import { Observable } from "rxjs";
 import { IframeApiContribution } from "./IframeApiContribution";
-export declare const initVariables: (_variables: Map<string, unknown>) => void;
 export declare class WorkadventureStateCommands extends IframeApiContribution<WorkadventureStateCommands> {
+    private target;
+    private setVariableResolvers;
+    private variables;
+    private variableSubscribers;
+    constructor(target: "global" | "player");
     callbacks: import("./IframeApiContribution").IframeCallbackContribution<keyof import("../Events/IframeEvent").IframeResponseEventMap>[];
+    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>;
 }
-declare const proxyCommand: WorkadventureStateCommands & {
+export declare function createState(target: "global" | "player"): WorkadventureStateCommands & {
     [key: string]: unknown;
 };
-export default proxyCommand;

package/iframe_api.d.ts

@@ -1,3 +1,4 @@
+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";
@@ -9,6 +10,7 @@ declare const wa: {
     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 & {
         [key: string]: unknown;
     };
@@ -52,11 +54,11 @@ declare const wa: {
     /**
      * @deprecated Use WA.nav.openCoWebSite instead
      */
-    openCoWebSite(url: string, allowApi?: boolean, allowPolicy?: string): void;
+    openCoWebSite(url: string, allowApi?: boolean, allowPolicy?: string): Promise<CoWebsite>;
     /**
      * @deprecated Use WA.nav.closeCoWebSite instead
      */
-    closeCoWebSite(): void;
+    closeCoWebSite(): Promise<void>;
     /**
      * @deprecated Use WA.ui.openPopup instead
      */

package/package.json

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