@workadventure/iframe-api-typings 1.5.6 → 1.6.0

package/Api/Events/ChangeLayerEvent.d.ts

@@ -0,0 +1,8 @@
+import * as tg from "generic-type-guard";
+export declare const isChangeLayerEvent: tg.TypeGuard<object & {
+    name: string;
+}>;
+/**
+ * A message sent from the game to the iFrame when a user enters or leaves a layer.
+ */
+export declare type ChangeLayerEvent = tg.GuardedType<typeof isChangeLayerEvent>;

package/Api/Events/CloseCoWebsiteEvent.d.ts

@@ -0,0 +1,8 @@
+import * as tg from "generic-type-guard";
+export declare const isCloseCoWebsite: tg.TypeGuard<object & {
+    id: string | undefined;
+}>;
+/**
+ * A message sent from the iFrame to the game to add a message in the chat.
+ */
+export declare type CloseCoWebsiteEvent = tg.GuardedType<typeof isCloseCoWebsite>;

package/Api/Events/HasPlayerMovedEvent.d.ts

@@ -4,6 +4,8 @@ export declare const isHasPlayerMovedEvent: tg.TypeGuard<object & {
     moving: boolean;
     x: number;
     y: number;
+    oldX: number | undefined;
+    oldY: number | undefined;
 }>;
 /**
  * A message sent from the game to the iFrame to notify a movement from the current player.

package/Api/Events/IframeEvent.d.ts

@@ -5,7 +5,6 @@ import type { ClosePopupEvent } from "./ClosePopupEvent";
 import type { EnterLeaveEvent } from "./EnterLeaveEvent";
 import type { GoToPageEvent } from "./GoToPageEvent";
 import type { LoadPageEvent } from "./LoadPageEvent";
-import type { OpenCoWebSiteEvent } from "./OpenCoWebSiteEvent";
 import type { OpenPopupEvent } from "./OpenPopupEvent";
 import type { OpenTabEvent } from "./OpenTabEvent";
 import type { UserInputChatEvent } from "./UserInputChatEvent";
@@ -21,6 +20,7 @@ import type { EmbeddedWebsite } from "../iframe/Room/EmbeddedWebsite";
 import type { LoadTilesetEvent } from "./LoadTilesetEvent";
 import type { MessageReferenceEvent } from "./ui/TriggerActionMessageEvent";
 import type { MenuRegisterEvent, UnregisterMenuEvent } from "./ui/MenuRegisterEvent";
+import type { ChangeLayerEvent } from "./ChangeLayerEvent";
 export interface TypedMessageEvent<T> extends MessageEvent {
     data: T;
 }
@@ -34,8 +34,6 @@ export declare type IframeEventMap = {
     closePopup: ClosePopupEvent;
     openTab: OpenTabEvent;
     goToPage: GoToPageEvent;
-    openCoWebSite: OpenCoWebSiteEvent;
-    closeCoWebSite: null;
     disablePlayerControls: null;
     restorePlayerControls: null;
     displayBubble: null;
@@ -63,6 +61,8 @@ export interface IframeResponseEventMap {
     userInputChat: UserInputChatEvent;
     enterEvent: EnterLeaveEvent;
     leaveEvent: EnterLeaveEvent;
+    enterLayerEvent: ChangeLayerEvent;
+    leaveLayerEvent: ChangeLayerEvent;
     buttonClickedEvent: ButtonClickedEvent;
     hasPlayerMoved: HasPlayerMovedEvent;
     menuItemClicked: MenuItemClickedEvent;
@@ -112,6 +112,33 @@ export declare const iframeQueryMapTypeGuards: {
         }>;
         answer: tg.TypeGuard<number>;
     };
+    openCoWebsite: {
+        query: tg.TypeGuard<object & {
+            url: string;
+            allowApi: boolean | undefined;
+            allowPolicy: string | undefined;
+            position: number | undefined;
+        }>;
+        answer: tg.TypeGuard<object & {
+            id: string;
+            position: number;
+        }>;
+    };
+    getCoWebsites: {
+        query: tg.TypeGuard<undefined>;
+        answer: tg.TypeGuard<(object & {
+            id: string;
+            position: number;
+        })[]>;
+    };
+    closeCoWebsite: {
+        query: tg.TypeGuard<string>;
+        answer: tg.TypeGuard<undefined>;
+    };
+    closeCoWebsites: {
+        query: tg.TypeGuard<undefined>;
+        answer: tg.TypeGuard<undefined>;
+    };
     triggerActionMessage: {
         query: tg.TypeGuard<object & {
             message: string;
@@ -182,9 +209,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" | "triggerActionMessage" | "removeActionMessage" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite";
-export declare const isIframeQuery: (event: any) => event is IframeQuery<"getState" | "getMapData" | "setVariable" | "loadTileset" | "triggerActionMessage" | "removeActionMessage" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite">;
-export declare const isIframeQueryWrapper: (event: any) => event is IframeQueryWrapper<"getState" | "getMapData" | "setVariable" | "loadTileset" | "triggerActionMessage" | "removeActionMessage" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite">;
+export declare const isIframeQueryKey: (type: string) => type is "getState" | "getMapData" | "setVariable" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "triggerActionMessage" | "removeActionMessage" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite";
+export declare const isIframeQuery: (event: any) => event is IframeQuery<"getState" | "getMapData" | "setVariable" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "triggerActionMessage" | "removeActionMessage" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite">;
+export declare const isIframeQueryWrapper: (event: any) => event is IframeQueryWrapper<"getState" | "getMapData" | "setVariable" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "triggerActionMessage" | "removeActionMessage" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite">;
 export interface IframeAnswerEvent<T extends keyof IframeQueryMap> {
     id: number;
     type: T;
@@ -193,7 +220,7 @@ export interface IframeAnswerEvent<T extends keyof IframeQueryMap> {
 export declare const isIframeAnswerEvent: (event: {
     type?: string;
     id?: number;
-}) => event is IframeAnswerEvent<"getState" | "getMapData" | "setVariable" | "loadTileset" | "triggerActionMessage" | "removeActionMessage" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite">;
+}) => event is IframeAnswerEvent<"getState" | "getMapData" | "setVariable" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "triggerActionMessage" | "removeActionMessage" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite">;
 export interface IframeErrorAnswerEvent {
     id: number;
     type: keyof IframeQueryMap;

package/Api/Events/OpenCoWebsiteEvent.d.ts

@@ -0,0 +1,15 @@
+import * as tg from "generic-type-guard";
+export declare const isOpenCoWebsiteEvent: tg.TypeGuard<object & {
+    url: string;
+    allowApi: boolean | undefined;
+    allowPolicy: string | undefined;
+    position: number | 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.
+ */
+export declare type OpenCoWebsiteEvent = tg.GuardedType<typeof isOpenCoWebsiteEvent>;

package/Api/IframeListener.d.ts

@@ -23,12 +23,6 @@ declare class IframeListener {
     }>;
     private readonly _loadPageStream;
     readonly loadPageStream: import("rxjs").Observable<string>;
-    private readonly _openCoWebSiteStream;
-    readonly openCoWebSiteStream: import("rxjs").Observable<object & {
-        url: string;
-        allowApi: boolean;
-        allowPolicy: string;
-    }>;
     private readonly _disablePlayerControlStream;
     readonly disablePlayerControlStream: import("rxjs").Observable<void>;
     private readonly _enablePlayerControlStream;
@@ -109,11 +103,14 @@ declare class IframeListener {
     unregisterIframe(iframe: HTMLIFrameElement): void;
     registerScript(scriptUrl: string): Promise<void>;
     private getBaseUrl;
+    getBaseUrlFromSource(source: MessageEventSource): string;
     private static getIFrameId;
     unregisterScript(scriptUrl: string): void;
     sendUserInputChat(message: string): void;
     sendEnterEvent(name: string): void;
     sendLeaveEvent(name: string): void;
+    sendEnterLayerEvent(layerName: string): void;
+    sendLeaveLayerEvent(layerName: string): void;
     hasPlayerMoved(event: HasPlayerMovedEvent): void;
     sendButtonClickedEvent(popupId: number, buttonId: number): void;
     setVariable(setVariableEvent: SetVariableEvent): void;

package/Api/ScriptUtils.d.ts

@@ -2,8 +2,6 @@ import type { ChatEvent } from "./Events/ChatEvent";
 declare class ScriptUtils {
     openTab(url: string): void;
     goToPage(url: string): void;
-    openCoWebsite(url: string, base: string, api: boolean, policy: string): void;
-    closeCoWebSite(): void;
     sendAnonymousChat(chatEvent: ChatEvent): void;
 }
 export declare const scriptUtils: ScriptUtils;

package/Api/iframe/nav.d.ts

@@ -1,11 +1,21 @@
 import { IframeApiContribution } from "./IframeApiContribution";
+export declare class CoWebsite {
+    private readonly id;
+    readonly position: number;
+    constructor(id: string, position: number);
+    close(): Promise<void>;
+}
 export declare class WorkadventureNavigationCommands extends IframeApiContribution<WorkadventureNavigationCommands> {
     callbacks: never[];
     openTab(url: string): void;
     goToPage(url: string): void;
     goToRoom(url: string): void;
-    openCoWebSite(url: string, allowApi?: boolean, allowPolicy?: string): void;
-    closeCoWebSite(): void;
+    openCoWebSite(url: string, allowApi?: boolean, allowPolicy?: string, position?: number): Promise<CoWebsite>;
+    getCoWebSites(): Promise<CoWebsite[]>;
+    /**
+     * @deprecated Use closeCoWebsites instead to close all co-websites
+     */
+    closeCoWebSite(): Promise<void>;
 }
 declare const _default: WorkadventureNavigationCommands;
 export default _default;

package/Api/iframe/room.d.ts

@@ -1,3 +1,4 @@
+import { Subject } from "rxjs";
 import { IframeApiContribution } from "./IframeApiContribution";
 import type { ITiledMap } from "../../Phaser/Map/ITiledMap";
 import type { WorkadventureRoomWebsiteCommands } from "./website";
@@ -11,8 +12,16 @@ 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>[];
+    /**
+     * @deprecated Use onEnterLayer instead
+     */
     onEnterZone(name: string, callback: () => void): void;
+    /**
+     * @deprecated Use onLeaveLayer instead
+     */
     onLeaveZone(name: string, callback: () => void): void;
+    onEnterLayer(layerName: string): Subject<void>;
+    onLeaveLayer(layerName: string): Subject<void>;
     showLayer(layerName: string): void;
     hideLayer(layerName: string): void;
     setProperty(layerName: string, propertyName: string, propertyValue: string | number | boolean | undefined): void;

package/package.json

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

package/Api/Events/OpenCoWebSiteEvent.d.ts

@@ -1,10 +0,0 @@
-import * as tg from "generic-type-guard";
-export declare const isOpenCoWebsite: tg.TypeGuard<object & {
-    url: string;
-    allowApi: boolean;
-    allowPolicy: string;
-}>;
-/**
- * A message sent from the iFrame to the game to add a message in the chat.
- */
-export declare type OpenCoWebSiteEvent = tg.GuardedType<typeof isOpenCoWebsite>;