@workadventure/iframe-api-typings 1.22.2 → 1.23.0

package/package.json

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

package/play/src/front/Api/Events/IframeEvent.d.ts

@@ -1560,6 +1560,34 @@ export declare const isIframeEventWrapper: z.ZodUnion<[z.ZodObject<{
 }, {
     type: "restoreRoomList";
     data?: undefined;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"startListeningToStreamInBubble">;
+    data: z.ZodObject<{
+        sampleRate: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        sampleRate: number;
+    }, {
+        sampleRate: number;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "startListeningToStreamInBubble";
+    data: {
+        sampleRate: number;
+    };
+}, {
+    type: "startListeningToStreamInBubble";
+    data: {
+        sampleRate: number;
+    };
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"stopListeningToStreamInBubble">;
+    data: z.ZodUndefined;
+}, "strip", z.ZodTypeAny, {
+    type: "stopListeningToStreamInBubble";
+    data?: undefined;
+}, {
+    type: "stopListeningToStreamInBubble";
+    data?: undefined;
 }>]>;
 export type IframeEvent = z.infer<typeof isIframeEventWrapper>;
 export declare const isIframeResponseEvent: z.ZodUnion<[z.ZodObject<{
@@ -3283,6 +3311,25 @@ export declare const isIframeResponseEvent: z.ZodUnion<[z.ZodObject<{
         name: string;
         uuid: string;
     };
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"appendPCMData">;
+    data: z.ZodObject<{
+        data: z.ZodType<Float32Array, z.ZodTypeDef, Float32Array>;
+    }, "strip", z.ZodTypeAny, {
+        data: Float32Array;
+    }, {
+        data: Float32Array;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "appendPCMData";
+    data: {
+        data: Float32Array;
+    };
+}, {
+    type: "appendPCMData";
+    data: {
+        data: Float32Array;
+    };
 }>]>;
 export type IframeResponseEvent = z.infer<typeof isIframeResponseEvent>;
 export declare const isLookingLikeIframeEventWrapper: z.ZodObject<{
@@ -4207,6 +4254,34 @@ export declare const iframeQueryMapTypeGuards: {
         }>;
         answer: z.ZodUndefined;
     };
+    startStreamInBubble: {
+        query: z.ZodObject<{
+            sampleRate: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            sampleRate: number;
+        }, {
+            sampleRate: number;
+        }>;
+        answer: z.ZodUndefined;
+    };
+    stopStreamInBubble: {
+        query: z.ZodUndefined;
+        answer: z.ZodUndefined;
+    };
+    appendPCMData: {
+        query: z.ZodObject<{
+            data: z.ZodType<Float32Array, z.ZodTypeDef, Float32Array>;
+        }, "strip", z.ZodTypeAny, {
+            data: Float32Array;
+        }, {
+            data: Float32Array;
+        }>;
+        answer: z.ZodUndefined;
+    };
+    resetAudioBuffer: {
+        query: z.ZodUndefined;
+        answer: z.ZodUndefined;
+    };
     followMe: {
         query: z.ZodUndefined;
         answer: z.ZodUndefined;
@@ -4215,6 +4290,16 @@ export declare const iframeQueryMapTypeGuards: {
         query: z.ZodUndefined;
         answer: z.ZodUndefined;
     };
+    getWamMapData: {
+        query: z.ZodUndefined;
+        answer: z.ZodObject<{
+            data: z.ZodUnknown;
+        }, "strip", z.ZodTypeAny, {
+            data?: unknown;
+        }, {
+            data?: unknown;
+        }>;
+    };
 };
 type IframeQueryMapTypeGuardsType = typeof iframeQueryMapTypeGuards;
 type UnknownToVoid<T> = undefined extends T ? void : T;
@@ -4232,15 +4317,15 @@ export interface IframeQueryWrapper<T extends keyof IframeQueryMap> {
     id: number;
     query: IframeQuery<T>;
 }
-export declare const isIframeQueryKey: (type: string) => type is "setVariable" | "triggerActionMessage" | "removeActionMessage" | "dispatchEvent" | "modifyArea" | "setPlayerVariable" | "getState" | "getMapData" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "goToLogin" | "triggerPlayerMessage" | "removePlayerMessage" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite" | "createArea" | "getArea" | "deleteArea" | "setPlayerOutline" | "removePlayerOutline" | "getPlayerPosition" | "movePlayerTo" | "teleportPlayerTo" | "openUIWebsite" | "closeUIWebsite" | "getUIWebsites" | "getUIWebsiteById" | "enablePlayersTracking" | "getWoka" | "playSoundInBubble" | "followMe" | "stopLeading";
-export declare const isIframeQuery: (event: any) => event is IframeQuery<"setVariable" | "triggerActionMessage" | "removeActionMessage" | "dispatchEvent" | "modifyArea" | "setPlayerVariable" | "getState" | "getMapData" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "goToLogin" | "triggerPlayerMessage" | "removePlayerMessage" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite" | "createArea" | "getArea" | "deleteArea" | "setPlayerOutline" | "removePlayerOutline" | "getPlayerPosition" | "movePlayerTo" | "teleportPlayerTo" | "openUIWebsite" | "closeUIWebsite" | "getUIWebsites" | "getUIWebsiteById" | "enablePlayersTracking" | "getWoka" | "playSoundInBubble" | "followMe" | "stopLeading">;
-export declare const isIframeQueryWrapper: (event: any) => event is IframeQueryWrapper<"setVariable" | "triggerActionMessage" | "removeActionMessage" | "dispatchEvent" | "modifyArea" | "setPlayerVariable" | "getState" | "getMapData" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "goToLogin" | "triggerPlayerMessage" | "removePlayerMessage" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite" | "createArea" | "getArea" | "deleteArea" | "setPlayerOutline" | "removePlayerOutline" | "getPlayerPosition" | "movePlayerTo" | "teleportPlayerTo" | "openUIWebsite" | "closeUIWebsite" | "getUIWebsites" | "getUIWebsiteById" | "enablePlayersTracking" | "getWoka" | "playSoundInBubble" | "followMe" | "stopLeading">;
+export declare const isIframeQueryKey: (type: string) => type is "setVariable" | "triggerActionMessage" | "removeActionMessage" | "dispatchEvent" | "modifyArea" | "setPlayerVariable" | "appendPCMData" | "getState" | "getMapData" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "goToLogin" | "triggerPlayerMessage" | "removePlayerMessage" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite" | "createArea" | "getArea" | "deleteArea" | "setPlayerOutline" | "removePlayerOutline" | "getPlayerPosition" | "movePlayerTo" | "teleportPlayerTo" | "openUIWebsite" | "closeUIWebsite" | "getUIWebsites" | "getUIWebsiteById" | "enablePlayersTracking" | "getWoka" | "playSoundInBubble" | "startStreamInBubble" | "stopStreamInBubble" | "resetAudioBuffer" | "followMe" | "stopLeading" | "getWamMapData";
+export declare const isIframeQuery: (event: any) => event is IframeQuery<"setVariable" | "triggerActionMessage" | "removeActionMessage" | "dispatchEvent" | "modifyArea" | "setPlayerVariable" | "appendPCMData" | "getState" | "getMapData" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "goToLogin" | "triggerPlayerMessage" | "removePlayerMessage" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite" | "createArea" | "getArea" | "deleteArea" | "setPlayerOutline" | "removePlayerOutline" | "getPlayerPosition" | "movePlayerTo" | "teleportPlayerTo" | "openUIWebsite" | "closeUIWebsite" | "getUIWebsites" | "getUIWebsiteById" | "enablePlayersTracking" | "getWoka" | "playSoundInBubble" | "startStreamInBubble" | "stopStreamInBubble" | "resetAudioBuffer" | "followMe" | "stopLeading" | "getWamMapData">;
+export declare const isIframeQueryWrapper: (event: any) => event is IframeQueryWrapper<"setVariable" | "triggerActionMessage" | "removeActionMessage" | "dispatchEvent" | "modifyArea" | "setPlayerVariable" | "appendPCMData" | "getState" | "getMapData" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "goToLogin" | "triggerPlayerMessage" | "removePlayerMessage" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite" | "createArea" | "getArea" | "deleteArea" | "setPlayerOutline" | "removePlayerOutline" | "getPlayerPosition" | "movePlayerTo" | "teleportPlayerTo" | "openUIWebsite" | "closeUIWebsite" | "getUIWebsites" | "getUIWebsiteById" | "enablePlayersTracking" | "getWoka" | "playSoundInBubble" | "startStreamInBubble" | "stopStreamInBubble" | "resetAudioBuffer" | "followMe" | "stopLeading" | "getWamMapData">;
 export interface IframeAnswerEvent<T extends keyof IframeQueryMap> {
     id: number;
     type: T;
     data: IframeQueryMap[T]["answer"];
 }
-export declare const isIframeAnswerEvent: (event: any) => event is IframeAnswerEvent<"setVariable" | "triggerActionMessage" | "removeActionMessage" | "dispatchEvent" | "modifyArea" | "setPlayerVariable" | "getState" | "getMapData" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "goToLogin" | "triggerPlayerMessage" | "removePlayerMessage" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite" | "createArea" | "getArea" | "deleteArea" | "setPlayerOutline" | "removePlayerOutline" | "getPlayerPosition" | "movePlayerTo" | "teleportPlayerTo" | "openUIWebsite" | "closeUIWebsite" | "getUIWebsites" | "getUIWebsiteById" | "enablePlayersTracking" | "getWoka" | "playSoundInBubble" | "followMe" | "stopLeading">;
+export declare const isIframeAnswerEvent: (event: any) => event is IframeAnswerEvent<"setVariable" | "triggerActionMessage" | "removeActionMessage" | "dispatchEvent" | "modifyArea" | "setPlayerVariable" | "appendPCMData" | "getState" | "getMapData" | "loadTileset" | "openCoWebsite" | "getCoWebsites" | "closeCoWebsite" | "closeCoWebsites" | "goToLogin" | "triggerPlayerMessage" | "removePlayerMessage" | "getEmbeddedWebsite" | "deleteEmbeddedWebsite" | "createEmbeddedWebsite" | "createArea" | "getArea" | "deleteArea" | "setPlayerOutline" | "removePlayerOutline" | "getPlayerPosition" | "movePlayerTo" | "teleportPlayerTo" | "openUIWebsite" | "closeUIWebsite" | "getUIWebsites" | "getUIWebsiteById" | "enablePlayersTracking" | "getWoka" | "playSoundInBubble" | "startStreamInBubble" | "stopStreamInBubble" | "resetAudioBuffer" | "followMe" | "stopLeading" | "getWamMapData">;
 export declare const isIframeErrorAnswerEvent: z.ZodObject<{
     id: z.ZodNumber;
     type: z.ZodString;

package/play/src/front/Api/Events/ProximityMeeting/AppendPCMDataEvent.d.ts

@@ -0,0 +1,12 @@
+import { z } from "zod";
+export declare const isAppendPCMDataEvent: z.ZodObject<{
+    data: z.ZodType<Float32Array, z.ZodTypeDef, Float32Array>;
+}, "strip", z.ZodTypeAny, {
+    data: Float32Array;
+}, {
+    data: Float32Array;
+}>;
+/**
+ * Appends PCM data to the stream played to all players in the current bubble.
+ */
+export type AppendPCMDataEvent = z.infer<typeof isAppendPCMDataEvent>;

package/play/src/front/Api/Events/ProximityMeeting/StartStreamInBubbleEvent.d.ts

@@ -0,0 +1,13 @@
+import { z } from "zod";
+export declare const isStartStreamInBubbleEvent: z.ZodObject<{
+    sampleRate: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    sampleRate: number;
+}, {
+    sampleRate: number;
+}>;
+/**
+ * A message sent from the iFrame to the game to start a stream to all starters in a bubble.
+ * The sampleRate is the sample rate of the audio stream expressed in Hertz.
+ */
+export type StartStreamInBubbleEvent = z.infer<typeof isStartStreamInBubbleEvent>;

package/play/src/front/Api/Events/WamMapDataEvent.d.ts

@@ -0,0 +1,12 @@
+import { z } from "zod";
+export declare const isWamMapDataEvent: z.ZodObject<{
+    data: z.ZodUnknown;
+}, "strip", z.ZodTypeAny, {
+    data?: unknown;
+}, {
+    data?: unknown;
+}>;
+/**
+ * A message sent from the game to the iFrame with the content of the WAM file. We don't type the content of the WAM file for performance reasons.
+ */
+export type MapDataEvent = z.infer<typeof isWamMapDataEvent>;

package/play/src/front/Api/Iframe/IframeApiContribution.d.ts

@@ -1,10 +1,10 @@
 import type { IframeEvent, IframeQuery, IframeQueryMap } from "../Events/IframeEvent";
-export declare function sendToWorkadventure(content: IframeEvent): void;
+export declare function sendToWorkadventure(content: IframeEvent, transfer?: Transferable[]): 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 declare function queryWorkadventure<T extends keyof IframeQueryMap>(content: IframeQuery<T>, transfer?: Transferable[]): Promise<IframeQueryMap[T]["answer"]>;
 /**
  * !! be aware that the implemented attributes (addMethodsAtRoot and subObjectIdentifier) must be readonly
  *

package/play/src/front/Api/Iframe/MapEditor/MapEditorArea.d.ts

@@ -0,0 +1,12 @@
+import { AreaData } from "@workadventure/map-editor";
+export interface MapEditorArea {
+    id: string;
+    name: string;
+    description: string | undefined;
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    searchable: boolean | undefined;
+}
+export declare function toMapEditorArea(area: AreaData): MapEditorArea;

package/play/src/front/Api/Iframe/Player/AudioStream.d.ts

@@ -0,0 +1,5 @@
+export declare class AudioStream {
+    appendAudioData(float32Array: Float32Array): Promise<void>;
+    resetAudioBuffer(): Promise<void>;
+    close(): Promise<void>;
+}

package/play/src/front/Api/Iframe/Player/ProximityMeeting.d.ts

@@ -1,6 +1,7 @@
-import { Subject } from "rxjs";
+import { Observable, Subject } from "rxjs";
 import { IframeApiContribution } from "../IframeApiContribution";
 import { RemotePlayer } from "../Players/RemotePlayer";
+import { AudioStream } from "./AudioStream";
 export declare class WorkadventureProximityMeetingCommands extends IframeApiContribution<WorkadventureProximityMeetingCommands> {
     private joinStream;
     private participantJoinStream;
@@ -8,6 +9,7 @@ export declare class WorkadventureProximityMeetingCommands extends IframeApiCont
     private followedStream;
     private unfollowedStream;
     private leaveStream;
+    private pcmDataStream;
     callbacks: ({
         type: "joinProximityMeetingEvent";
         callback: (event: {
@@ -96,6 +98,11 @@ export declare class WorkadventureProximityMeetingCommands extends IframeApiCont
                 chatID?: string | null | undefined;
             };
         }) => void;
+    } | {
+        type: "appendPCMData";
+        callback: (event: {
+            data: Float32Array;
+        }) => void;
     })[];
     /**
      * Detecting when the user enter on a meeting.
@@ -128,6 +135,18 @@ export declare class WorkadventureProximityMeetingCommands extends IframeApiCont
      * {@link https://docs.workadventu.re/developer/map-scripting/references/api-player/#playing-a-sound-to-players-in-the-same-meeting | Website documentation}
      */
     playSound(url: string): Promise<void>;
+    /**
+     * Starts an audio stream played to all players in the current meeting.
+     * {@link https://docs.workadventu.re/developer/map-scripting/references/api-player/#audio-streams | Website documentation}
+     * @param {number} sampleRate - The sample rate of the audio stream expressed in Hertz.
+     */
+    startAudioStream(sampleRate: number): Promise<AudioStream>;
+    /**
+     * Listen to the audio stream played sent by all players.
+     * The voice of all players in the bubble is merged in a single stream that is regularly sent to the callback.
+     * @param {number} sampleRate - The sample rate of the audio stream expressed in Hertz.
+     */
+    listenToAudioStream(sampleRate: number): Observable<Float32Array>;
     /**
      * Ask all players in the current meeting to follow the player.
      * Note that unlike with the "follow" mode in the UI, the other players will automatically follow the player.

package/play/src/front/Api/Iframe/area.d.ts

@@ -31,7 +31,7 @@ export declare class WorkadventureAreaCommands extends IframeApiContribution<Wor
      */
     get(name: string): Promise<Area>;
     /**
-     * Delete Area by it's name.
+     * Delete Area by its name.
      * {@link https://docs.workadventu.re/map-building/api-room.md#delete-area | Website documentation}
      *
      * @param {string} name Area name

package/play/src/front/Api/Iframe/mapEditor.d.ts

@@ -1,5 +1,6 @@
 import type { Observable } from "rxjs";
 import { IframeApiContribution } from "./IframeApiContribution";
+import { MapEditorArea } from "./MapEditor/MapEditorArea";
 declare class WorkadventureMapEditorAreaCommands extends IframeApiContribution<WorkadventureMapEditorAreaCommands> {
     callbacks: ({
         type: "enterMapEditorAreaEvent";
@@ -28,6 +29,20 @@ declare class WorkadventureMapEditorAreaCommands extends IframeApiContribution<W
      * @returns {Subject<void>} An observable fired when someone leaves the area
      */
     onLeave(areaName: string): Observable<void>;
+    private wamMapCache;
+    /**
+     * Returns a promise that resolves to the WAM map file.
+     * The WAM is cached in memory.
+     *
+     * @returns {Promise<WAMFileFormat>} Map in Tiled JSON format
+     */
+    private getWamMap;
+    /**
+     * Returns a list of areas defined in the map editor.
+     *
+     * @returns {Promise<MapEditorArea[]>} List of areas
+     */
+    list(): Promise<MapEditorArea[]>;
 }
 export declare class WorkadventureMapEditorCommands extends IframeApiContribution<WorkadventureMapEditorCommands> {
     callbacks: never[];