@workadventure/iframe-api-typings 1.7.2 → 1.8.2

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/GameStateEvent.d.ts

@@ -3,12 +3,13 @@ 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;
-    userRoomToken: string | undefined;
     playerVariables: object;
+    userRoomToken: string | undefined;
 }>;
 /**
  * A message sent from the game to the iFrame when the gameState is received by the script

package/Api/Events/IframeEvent.d.ts

@@ -21,8 +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 { ChangeZoneEvent } from "./ChangeZoneEvent";
 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;
 }
@@ -32,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;
@@ -93,12 +97,13 @@ export declare const iframeQueryMapTypeGuards: {
             roomId: string;
             mapUrl: string;
             nickname: string;
+            language: string | undefined;
             uuid: string | undefined;
             startLayerName: string | null;
             tags: string[];
             variables: object;
-            userRoomToken: string | undefined;
             playerVariables: object;
+            userRoomToken: string | undefined;
         }>;
     };
     getMapData: {
@@ -126,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: {
@@ -223,6 +229,18 @@ export declare const iframeQueryMapTypeGuards: {
             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;
@@ -241,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" | "getPlayerPosition";
-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">;
-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">;
+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;
@@ -252,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" | "getPlayerPosition">;
+}) => 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/IframeListener.d.ts

@@ -26,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;
@@ -108,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;

package/Api/iframe/camera.d.ts

@@ -3,6 +3,8 @@ 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;

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,6 +1,7 @@
 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;
@@ -11,9 +12,15 @@ export declare class WorkadventurePlayerCommands extends IframeApiContribution<W
     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>;

package/package.json

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