@workadventure/iframe-api-typings 1.6.2 → 1.7.1

package/Api/Events/ChangeZoneEvent.d.ts

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

package/Api/Events/ColorEvent.d.ts

@@ -0,0 +1,10 @@
+import * as tg from "generic-type-guard";
+export declare const isColorEvent: tg.TypeGuard<object & {
+    red: number;
+    green: number;
+    blue: number;
+}>;
+/**
+ * A message sent from the iFrame to the game to dynamically set the outline of the player.
+ */
+export declare type ColorEvent = tg.GuardedType<typeof isColorEvent>;

package/Api/Events/EmbeddedWebsiteEvent.d.ts

@@ -21,10 +21,10 @@ export declare const isCreateEmbeddedWebsiteEvent: tg.TypeGuard<object & {
     name: string;
     url: string;
     position: object & {
-        x: any;
-        y: any;
-        width: any;
-        height: any;
+        x: number;
+        y: number;
+        width: number;
+        height: number;
     };
 } & Partial<{
     visible: boolean;

package/Api/Events/GameStateEvent.d.ts

@@ -7,6 +7,7 @@ export declare const isGameStateEvent: tg.TypeGuard<object & {
     startLayerName: string | null;
     tags: string[];
     variables: 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,6 +21,7 @@ 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";
 export interface TypedMessageEvent<T> extends MessageEvent {
     data: T;
 }
@@ -63,6 +64,8 @@ export interface IframeResponseEventMap {
     leaveEvent: EnterLeaveEvent;
     enterLayerEvent: ChangeLayerEvent;
     leaveLayerEvent: ChangeLayerEvent;
+    enterZoneEvent: ChangeZoneEvent;
+    leaveZoneEvent: ChangeZoneEvent;
     buttonClickedEvent: ButtonClickedEvent;
     hasPlayerMoved: HasPlayerMovedEvent;
     menuItemClicked: MenuItemClickedEvent;
@@ -91,6 +94,7 @@ export declare const iframeQueryMapTypeGuards: {
             startLayerName: string | null;
             tags: string[];
             variables: object;
+            userRoomToken: string | undefined;
         }>;
     };
     getMapData: {
@@ -159,10 +163,10 @@ export declare const iframeQueryMapTypeGuards: {
             name: string;
             url: string;
             position: object & {
-                x: any;
-                y: any;
-                width: any;
-                height: any;
+                x: number;
+                y: number;
+                width: number;
+                height: number;
             };
         } & Partial<{
             visible: boolean;
@@ -179,10 +183,10 @@ export declare const iframeQueryMapTypeGuards: {
             name: string;
             url: string;
             position: object & {
-                x: any;
-                y: any;
-                width: any;
-                height: any;
+                x: number;
+                y: number;
+                width: number;
+                height: number;
             };
         } & Partial<{
             visible: boolean;
@@ -191,6 +195,18 @@ export declare const iframeQueryMapTypeGuards: {
         }>>;
         answer: tg.TypeGuard<undefined>;
     };
+    setPlayerOutline: {
+        query: tg.TypeGuard<object & {
+            red: number;
+            green: number;
+            blue: number;
+        }>;
+        answer: tg.TypeGuard<undefined>;
+    };
+    removePlayerOutline: {
+        query: tg.TypeGuard<undefined>;
+        answer: tg.TypeGuard<undefined>;
+    };
 };
 declare type GuardedType<T> = T extends (x: unknown) => x is infer T ? T : never;
 declare type IframeQueryMapTypeGuardsType = typeof iframeQueryMapTypeGuards;
@@ -209,9 +225,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";
-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 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 interface IframeAnswerEvent<T extends keyof IframeQueryMap> {
     id: number;
     type: T;
@@ -220,7 +236,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">;
+}) => event is IframeAnswerEvent<"getState" | "getMapData" | "setVariable" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "triggerActionMessage" | "removeActionMessage" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite" | "setPlayerOutline" | "removePlayerOutline">;
 export interface IframeErrorAnswerEvent {
     id: number;
     type: keyof IframeQueryMap;

package/Api/Events/OpenPopupEvent.d.ts

@@ -4,8 +4,8 @@ export declare const isOpenPopupEvent: tg.TypeGuard<object & {
     targetObject: string;
     message: string;
     buttons: (object & {
-        label: any;
-        className: any;
+        label: string;
+        className: string | undefined;
     })[];
 }>;
 /**

package/Api/Events/PlaySoundEvent.d.ts

@@ -2,13 +2,13 @@ import * as tg from "generic-type-guard";
 export declare const isPlaySoundEvent: tg.TypeGuard<object & {
     url: string;
     config: (object & {
-        volume: any;
-        loop: any;
-        mute: any;
-        rate: any;
-        detune: any;
-        seek: any;
-        delay: any;
+        volume: number | undefined;
+        loop: boolean | undefined;
+        mute: boolean | undefined;
+        rate: number | undefined;
+        detune: number | undefined;
+        seek: number | undefined;
+        delay: number | undefined;
     }) | undefined;
 }>;
 /**

package/Api/Events/SetVariableEvent.d.ts

@@ -10,7 +10,7 @@ export declare type SetVariableEvent = tg.GuardedType<typeof isSetVariableEvent>
 export declare const isSetVariableIframeEvent: tg.TypeGuard<object & {
     type: "setVariable";
     data: object & {
-        key: any;
-        value: any;
+        key: string;
+        value: unknown;
     };
 }>;

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

@@ -16,7 +16,7 @@ export declare const isMenuRegisterEvent: tg.TypeGuard<object & {
     name: string;
     iframe: string | undefined;
     options: object & {
-        allowApi: any;
+        allowApi: boolean;
     };
 }>;
 export declare type MenuRegisterEvent = tg.GuardedType<typeof isMenuRegisterEvent>;

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

@@ -2,13 +2,13 @@ import * as tg from "generic-type-guard";
 export declare const isTriggerMessageHandlerEvent: tg.PartialTypeGuard<unknown, (object & {
     type: "triggerActionMessage";
     data: object & {
-        message: any;
-        uuid: any;
-        type: any;
+        message: string;
+        uuid: string;
+        type: "message" | "warning";
     };
 }) | (object & {
     type: "removeActionMessage";
     data: object & {
-        uuid: any;
+        uuid: string;
     };
 })>;

package/Api/IframeListener.d.ts

@@ -13,8 +13,8 @@ declare class IframeListener {
         targetObject: string;
         message: string;
         buttons: (object & {
-            label: any;
-            className: any;
+            label: string;
+            className: string | undefined;
         })[];
     }>;
     private readonly _openTabStream;
@@ -53,13 +53,13 @@ declare class IframeListener {
     readonly playSoundStream: import("rxjs").Observable<object & {
         url: string;
         config: (object & {
-            volume: any;
-            loop: any;
-            mute: any;
-            rate: any;
-            detune: any;
-            seek: any;
-            delay: any;
+            volume: number | undefined;
+            loop: boolean | undefined;
+            mute: boolean | undefined;
+            rate: number | undefined;
+            detune: number | undefined;
+            seek: number | undefined;
+            delay: number | undefined;
         }) | undefined;
     }>;
     private readonly _stopSoundStream;
@@ -111,6 +111,8 @@ declare class IframeListener {
     sendLeaveEvent(name: string): void;
     sendEnterLayerEvent(layerName: string): void;
     sendLeaveLayerEvent(layerName: string): void;
+    sendEnterZoneEvent(zoneName: string): void;
+    sendLeaveZoneEvent(zoneName: string): void;
     hasPlayerMoved(event: HasPlayerMovedEvent): void;
     sendButtonClickedEvent(popupId: number, buttonId: number): void;
     setVariable(setVariableEvent: SetVariableEvent): void;

package/Api/iframe/player.d.ts

@@ -2,6 +2,7 @@ import { IframeApiContribution } from "./IframeApiContribution";
 import type { HasPlayerMovedEventCallback } from "../Events/HasPlayerMovedEvent";
 export declare const setPlayerName: (name: string) => 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> {
     callbacks: import("./IframeApiContribution").IframeCallbackContribution<keyof import("../Events/IframeEvent").IframeResponseEventMap>[];
@@ -9,6 +10,9 @@ export declare class WorkadventurePlayerCommands extends IframeApiContribution<W
     get name(): string;
     get tags(): string[];
     get id(): string | undefined;
+    get userRoomToken(): string | undefined;
+    setOutlineColor(red: number, green: number, blue: number): Promise<void>;
+    removeOutlineColor(): Promise<void>;
 }
 declare const _default: WorkadventurePlayerCommands;
 export default _default;

package/package.json

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