@workadventure/iframe-api-typings 1.24.9 → 1.24.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@workadventure/iframe-api-typings",
-  "version": "v1.24.9",
+  "version": "v1.24.11",
   "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

@@ -1164,21 +1164,18 @@ export declare const isIframeEventWrapper: z.ZodUnion<[z.ZodObject<{
         title: z.ZodDefault<z.ZodOptional<z.ZodString>>;
         position: z.ZodDefault<z.ZodOptional<z.ZodEnum<["right", "left", "center"]>>>;
         allowApi: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
-        allowFullScreen: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
     }, "strip", z.ZodTypeAny, {
         title: string;
         allowApi: boolean;
         position: "left" | "right" | "center";
         allow: string | null;
         src: string;
-        allowFullScreen: boolean;
     }, {
         src: string;
         title?: string | undefined;
         allowApi?: boolean | undefined;
         position?: "left" | "right" | "center" | undefined;
         allow?: string | null | undefined;
-        allowFullScreen?: boolean | undefined;
     }>;
 }, "strip", z.ZodTypeAny, {
     type: "openModal";
@@ -1188,7 +1185,6 @@ export declare const isIframeEventWrapper: z.ZodUnion<[z.ZodObject<{
         position: "left" | "right" | "center";
         allow: string | null;
         src: string;
-        allowFullScreen: boolean;
     };
 }, {
     type: "openModal";
@@ -1198,7 +1194,6 @@ export declare const isIframeEventWrapper: z.ZodUnion<[z.ZodObject<{
         allowApi?: boolean | undefined;
         position?: "left" | "right" | "center" | undefined;
         allow?: string | null | undefined;
-        allowFullScreen?: boolean | undefined;
     };
 }>, z.ZodObject<{
     type: z.ZodLiteral<"closeModal">;
@@ -1220,52 +1215,57 @@ export declare const isIframeEventWrapper: z.ZodUnion<[z.ZodObject<{
     data?: undefined;
 }>, z.ZodObject<{
     type: z.ZodLiteral<"addButtonActionBar">;
-    data: z.ZodObject<{
+    data: z.ZodUnion<[z.ZodObject<{
         id: z.ZodString;
-        label: z.ZodOptional<z.ZodString>;
-        toolTip: z.ZodOptional<z.ZodString>;
-        bgColor: z.ZodOptional<z.ZodString>;
-        textColor: z.ZodOptional<z.ZodString>;
-        imageSrc: z.ZodOptional<z.ZodString>;
-        isGradient: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+        label: z.ZodString;
+        type: z.ZodDefault<z.ZodOptional<z.ZodEnum<["button"]>>>;
     }, "strip", z.ZodTypeAny, {
+        type: "button";
+        label: string;
         id: string;
-        isGradient: boolean;
-        label?: string | undefined;
-        toolTip?: string | undefined;
-        bgColor?: string | undefined;
-        textColor?: string | undefined;
-        imageSrc?: string | undefined;
     }, {
+        label: string;
         id: string;
-        label?: string | undefined;
-        toolTip?: string | undefined;
-        bgColor?: string | undefined;
-        textColor?: string | undefined;
-        imageSrc?: string | undefined;
-        isGradient?: boolean | undefined;
-    }>;
+        type?: "button" | undefined;
+    }>, z.ZodObject<{
+        id: z.ZodString;
+        type: z.ZodEnum<["action"]>;
+        imageSrc: z.ZodString;
+        toolTip: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: "action";
+        id: string;
+        imageSrc: string;
+        toolTip: string;
+    }, {
+        type: "action";
+        id: string;
+        imageSrc: string;
+        toolTip: string;
+    }>]>;
 }, "strip", z.ZodTypeAny, {
     type: "addButtonActionBar";
     data: {
+        type: "button";
+        label: string;
         id: string;
-        isGradient: boolean;
-        label?: string | undefined;
-        toolTip?: string | undefined;
-        bgColor?: string | undefined;
-        textColor?: string | undefined;
-        imageSrc?: string | undefined;
+    } | {
+        type: "action";
+        id: string;
+        imageSrc: string;
+        toolTip: string;
     };
 }, {
     type: "addButtonActionBar";
     data: {
+        label: string;
         id: string;
-        label?: string | undefined;
-        toolTip?: string | undefined;
-        bgColor?: string | undefined;
-        textColor?: string | undefined;
-        imageSrc?: string | undefined;
-        isGradient?: boolean | undefined;
+        type?: "button" | undefined;
+    } | {
+        type: "action";
+        id: string;
+        imageSrc: string;
+        toolTip: string;
     };
 }>, z.ZodObject<{
     type: z.ZodLiteral<"removeButtonActionBar">;
@@ -3202,14 +3202,59 @@ export declare const isIframeResponseEvent: z.ZodUnion<[z.ZodObject<{
         }[];
     };
 }>, z.ZodObject<{
-    type: z.ZodLiteral<"buttonActionBarTriggered">;
-    data: z.ZodString;
+    type: z.ZodLiteral<"buttonActionBarTrigger">;
+    data: z.ZodUnion<[z.ZodObject<{
+        id: z.ZodString;
+        label: z.ZodString;
+        type: z.ZodDefault<z.ZodOptional<z.ZodEnum<["button"]>>>;
+    }, "strip", z.ZodTypeAny, {
+        type: "button";
+        label: string;
+        id: string;
+    }, {
+        label: string;
+        id: string;
+        type?: "button" | undefined;
+    }>, z.ZodObject<{
+        id: z.ZodString;
+        type: z.ZodEnum<["action"]>;
+        imageSrc: z.ZodString;
+        toolTip: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: "action";
+        id: string;
+        imageSrc: string;
+        toolTip: string;
+    }, {
+        type: "action";
+        id: string;
+        imageSrc: string;
+        toolTip: string;
+    }>]>;
 }, "strip", z.ZodTypeAny, {
-    type: "buttonActionBarTriggered";
-    data: string;
+    type: "buttonActionBarTrigger";
+    data: {
+        type: "button";
+        label: string;
+        id: string;
+    } | {
+        type: "action";
+        id: string;
+        imageSrc: string;
+        toolTip: string;
+    };
 }, {
-    type: "buttonActionBarTriggered";
-    data: string;
+    type: "buttonActionBarTrigger";
+    data: {
+        label: string;
+        id: string;
+        type?: "button" | undefined;
+    } | {
+        type: "action";
+        id: string;
+        imageSrc: string;
+        toolTip: string;
+    };
 }>, z.ZodObject<{
     type: z.ZodLiteral<"modalCloseTrigger">;
     data: z.ZodObject<{
@@ -3218,21 +3263,18 @@ export declare const isIframeResponseEvent: z.ZodUnion<[z.ZodObject<{
         title: z.ZodDefault<z.ZodOptional<z.ZodString>>;
         position: z.ZodDefault<z.ZodOptional<z.ZodEnum<["right", "left", "center"]>>>;
         allowApi: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
-        allowFullScreen: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
     }, "strip", z.ZodTypeAny, {
         title: string;
         allowApi: boolean;
         position: "left" | "right" | "center";
         allow: string | null;
         src: string;
-        allowFullScreen: boolean;
     }, {
         src: string;
         title?: string | undefined;
         allowApi?: boolean | undefined;
         position?: "left" | "right" | "center" | undefined;
         allow?: string | null | undefined;
-        allowFullScreen?: boolean | undefined;
     }>;
 }, "strip", z.ZodTypeAny, {
     type: "modalCloseTrigger";
@@ -3242,7 +3284,6 @@ export declare const isIframeResponseEvent: z.ZodUnion<[z.ZodObject<{
         position: "left" | "right" | "center";
         allow: string | null;
         src: string;
-        allowFullScreen: boolean;
     };
 }, {
     type: "modalCloseTrigger";
@@ -3252,7 +3293,6 @@ export declare const isIframeResponseEvent: z.ZodUnion<[z.ZodObject<{
         allowApi?: boolean | undefined;
         position?: "left" | "right" | "center" | undefined;
         allow?: string | null | undefined;
-        allowFullScreen?: boolean | undefined;
     };
 }>, z.ZodObject<{
     type: z.ZodLiteral<"banUser">;
@@ -4267,43 +4307,6 @@ export declare const iframeQueryMapTypeGuards: {
             data?: unknown;
         }>;
     };
-    playVideo: {
-        query: z.ZodObject<{
-            url: z.ZodString;
-            config: z.ZodOptional<z.ZodObject<{
-                loop: z.ZodOptional<z.ZodBoolean>;
-                name: z.ZodOptional<z.ZodString>;
-                avatar: z.ZodOptional<z.ZodString>;
-            }, "strip", z.ZodTypeAny, {
-                name?: string | undefined;
-                loop?: boolean | undefined;
-                avatar?: string | undefined;
-            }, {
-                name?: string | undefined;
-                loop?: boolean | undefined;
-                avatar?: string | undefined;
-            }>>;
-        }, "strip", z.ZodTypeAny, {
-            url: string;
-            config?: {
-                name?: string | undefined;
-                loop?: boolean | undefined;
-                avatar?: string | undefined;
-            } | undefined;
-        }, {
-            url: string;
-            config?: {
-                name?: string | undefined;
-                loop?: boolean | undefined;
-                avatar?: string | undefined;
-            } | undefined;
-        }>;
-        answer: z.ZodString;
-    };
-    stopVideo: {
-        query: z.ZodString;
-        answer: z.ZodUndefined;
-    };
 };
 type IframeQueryMapTypeGuardsType = typeof iframeQueryMapTypeGuards;
 type UnknownToVoid<T> = undefined extends T ? void : T;

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

@@ -5,21 +5,18 @@ export declare const isModalEvent: z.ZodObject<{
     title: z.ZodDefault<z.ZodOptional<z.ZodString>>;
     position: z.ZodDefault<z.ZodOptional<z.ZodEnum<["right", "left", "center"]>>>;
     allowApi: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
-    allowFullScreen: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
 }, "strip", z.ZodTypeAny, {
     title: string;
     allowApi: boolean;
     position: "left" | "right" | "center";
     allow: string | null;
     src: string;
-    allowFullScreen: boolean;
 }, {
     src: string;
     title?: string | undefined;
     allowApi?: boolean | undefined;
     position?: "left" | "right" | "center" | undefined;
     allow?: string | null | undefined;
-    allowFullScreen?: boolean | undefined;
 }>;
 /**
  * A message sent from the iFrame to the game to emit a notification.

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

@@ -9,6 +9,4 @@ export declare const isAppendPCMDataEvent: z.ZodObject<{
 /**
  * Appends PCM data to the stream played to all players in the current bubble.
  */
-export type AppendPCMDataEvent = {
-    data: Float32Array<ArrayBufferLike>;
-};
+export type AppendPCMDataEvent = z.infer<typeof isAppendPCMDataEvent>;

package/play/src/front/Api/Events/Ui/ButtonActionBarEvent.d.ts

@@ -1,32 +1,64 @@
 import { z } from "zod";
-export declare const isAddActionBarButtonEvent: z.ZodObject<{
+export declare const isAddClassicButtonActionBarEvent: z.ZodObject<{
     id: z.ZodString;
-    label: z.ZodOptional<z.ZodString>;
-    toolTip: z.ZodOptional<z.ZodString>;
-    bgColor: z.ZodOptional<z.ZodString>;
-    textColor: z.ZodOptional<z.ZodString>;
-    imageSrc: z.ZodOptional<z.ZodString>;
-    isGradient: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    label: z.ZodString;
+    type: z.ZodDefault<z.ZodOptional<z.ZodEnum<["button"]>>>;
 }, "strip", z.ZodTypeAny, {
+    type: "button";
+    label: string;
     id: string;
-    isGradient: boolean;
-    label?: string | undefined;
-    toolTip?: string | undefined;
-    bgColor?: string | undefined;
-    textColor?: string | undefined;
-    imageSrc?: string | undefined;
 }, {
+    label: string;
     id: string;
-    label?: string | undefined;
-    toolTip?: string | undefined;
-    bgColor?: string | undefined;
-    textColor?: string | undefined;
-    imageSrc?: string | undefined;
-    isGradient?: boolean | undefined;
+    type?: "button" | undefined;
 }>;
-export type AddButtonActionBarEvent = z.infer<typeof isAddActionBarButtonEvent>;
-export type AddActionButtonActionBarEvent = AddButtonActionBarEvent;
-export type AddClassicButtonActionBarEvent = AddButtonActionBarEvent;
+export declare const isAddActionButtonActionBarEvent: z.ZodObject<{
+    id: z.ZodString;
+    type: z.ZodEnum<["action"]>;
+    imageSrc: z.ZodString;
+    toolTip: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "action";
+    id: string;
+    imageSrc: string;
+    toolTip: string;
+}, {
+    type: "action";
+    id: string;
+    imageSrc: string;
+    toolTip: string;
+}>;
+export declare const isAddButtonActionBarEvent: z.ZodUnion<[z.ZodObject<{
+    id: z.ZodString;
+    label: z.ZodString;
+    type: z.ZodDefault<z.ZodOptional<z.ZodEnum<["button"]>>>;
+}, "strip", z.ZodTypeAny, {
+    type: "button";
+    label: string;
+    id: string;
+}, {
+    label: string;
+    id: string;
+    type?: "button" | undefined;
+}>, z.ZodObject<{
+    id: z.ZodString;
+    type: z.ZodEnum<["action"]>;
+    imageSrc: z.ZodString;
+    toolTip: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "action";
+    id: string;
+    imageSrc: string;
+    toolTip: string;
+}, {
+    type: "action";
+    id: string;
+    imageSrc: string;
+    toolTip: string;
+}>]>;
+export type AddButtonActionBarEvent = z.infer<typeof isAddButtonActionBarEvent>;
+export type AddActionButtonActionBarEvent = z.infer<typeof isAddActionButtonActionBarEvent>;
+export type AddClassicButtonActionBarEvent = z.infer<typeof isAddClassicButtonActionBarEvent>;
 export type AddActionsButtonActionBarEventCallback = (event: AddButtonActionBarEvent) => void;
 export declare const isRemoveButtonActionBarEvent: z.ZodObject<{
     id: z.ZodString;

package/play/src/front/Api/Iframe/Ui/ButtonActionBar.d.ts

@@ -1,20 +1,44 @@
 import { AddButtonActionBarEvent } from "../../Events/Ui/ButtonActionBarEvent";
 import { IframeApiContribution } from "../IframeApiContribution";
 export type ButtonActionBarClickedCallback = (buttonActionBar: AddButtonActionBarEvent) => void;
-export type ActionBarButtonDescriptor = AddButtonActionBarEvent & {
+declare const ActionBarButtonType: {
+    readonly button: "button";
+    readonly action: "action";
+};
+type ActionBarButtonType = (typeof ActionBarButtonType)[keyof typeof ActionBarButtonType];
+export type ActionBarClassicButtonDescriptor = {
+    id: string;
+    label: string;
+    type?: ActionBarButtonType;
+    callback?: ButtonActionBarClickedCallback;
+};
+export type ActionBarActionButtonDescriptor = {
+    id: string;
+    type: ActionBarButtonType;
+    imageSrc: string;
+    toolTip: string;
     callback?: ButtonActionBarClickedCallback;
 };
 export declare class WorkAdventureButtonActionBarCommands extends IframeApiContribution<WorkAdventureButtonActionBarCommands> {
     private _callbacks;
     callbacks: {
-        type: "buttonActionBarTriggered";
-        callback: (event: string) => void;
+        type: "buttonActionBarTrigger";
+        callback: (event: {
+            type: "button";
+            label: string;
+            id: string;
+        } | {
+            type: "action";
+            id: string;
+            imageSrc: string;
+            toolTip: string;
+        }) => void;
     }[];
     /**
      * Add action bar button
      * {@link http://workadventure.localhost/map-building/api-ui.md#add-action-bar | Website documentation}
      */
-    addButton(descriptor: ActionBarButtonDescriptor): void;
+    addButton(descriptor: ActionBarClassicButtonDescriptor | ActionBarActionButtonDescriptor): void;
     /**
      * Remove action bar button
      * {@link http://workadventure.localhost/map-building/api-ui.md#remove-action-bar | Website documentation}

package/play/src/front/Api/Iframe/Ui/Modal.d.ts

@@ -10,7 +10,6 @@ export declare class WorkadventureModalCommands extends IframeApiContribution<Wo
             position: "left" | "right" | "center";
             allow: string | null;
             src: string;
-            allowFullScreen: boolean;
         }) => void;
     }[];
     /**

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

@@ -1,7 +1,6 @@
 import type { Observable } from "rxjs";
 import { Subject } from "rxjs";
 import type { RequireOnlyOne } from "../types";
-import { VideoConfig } from "../Events/Ui/PlayVideoEvent";
 import { IframeApiContribution } from "./IframeApiContribution";
 import type { ButtonDescriptor } from "./Ui/ButtonDescriptor";
 import { Popup } from "./Ui/Popup";
@@ -13,7 +12,6 @@ import { RemotePlayer } from "./Players/RemotePlayer";
 import type { WorkadventureModalCommands } from "./Ui/Modal";
 import { WorkAdventureButtonActionBarCommands } from "./Ui/ButtonActionBar";
 import { WorkadventureBannerCommands } from "./Ui/Banner";
-import { Video } from "./Ui/Video";
 interface MenuDescriptor {
     callback?: (commandDescriptor: string) => void;
     iframe?: string;
@@ -146,10 +144,6 @@ export declare class WorkAdventureUiCommands extends IframeApiContribution<WorkA
     get modal(): WorkadventureModalCommands;
     get actionBar(): WorkAdventureButtonActionBarCommands;
     get banner(): WorkadventureBannerCommands;
-    /**
-     * Plays a video as if the video was a player talking to us.
-     */
-    playVideo(videoUrl: string, config?: VideoConfig): Promise<Video>;
 }
 declare const _default: WorkAdventureUiCommands;
 export default _default;

package/play/src/front/Api/Events/Ui/PlayVideoEvent.d.ts

@@ -1,67 +0,0 @@
-import { z } from "zod";
-export declare const isVideoConfig: z.ZodObject<{
-    /**
-     * Whether the video should loop.
-     */
-    loop: z.ZodOptional<z.ZodBoolean>;
-    /**
-     * The name displayed at the bottom left of the video.
-     */
-    name: z.ZodOptional<z.ZodString>;
-    /**
-     * A link to the avatar of the speaker, displayed at the bottom left of the video.
-     */
-    avatar: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    name?: string | undefined;
-    loop?: boolean | undefined;
-    avatar?: string | undefined;
-}, {
-    name?: string | undefined;
-    loop?: boolean | undefined;
-    avatar?: string | undefined;
-}>;
-export declare const isPlayVideoEvent: z.ZodObject<{
-    url: z.ZodString;
-    config: z.ZodOptional<z.ZodObject<{
-        /**
-         * Whether the video should loop.
-         */
-        loop: z.ZodOptional<z.ZodBoolean>;
-        /**
-         * The name displayed at the bottom left of the video.
-         */
-        name: z.ZodOptional<z.ZodString>;
-        /**
-         * A link to the avatar of the speaker, displayed at the bottom left of the video.
-         */
-        avatar: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        name?: string | undefined;
-        loop?: boolean | undefined;
-        avatar?: string | undefined;
-    }, {
-        name?: string | undefined;
-        loop?: boolean | undefined;
-        avatar?: string | undefined;
-    }>>;
-}, "strip", z.ZodTypeAny, {
-    url: string;
-    config?: {
-        name?: string | undefined;
-        loop?: boolean | undefined;
-        avatar?: string | undefined;
-    } | undefined;
-}, {
-    url: string;
-    config?: {
-        name?: string | undefined;
-        loop?: boolean | undefined;
-        avatar?: string | undefined;
-    } | undefined;
-}>;
-/**
- * A message sent from the iFrame to the game to add a message in the chat.
- */
-export type PlayVideoEvent = z.infer<typeof isPlayVideoEvent>;
-export type VideoConfig = z.infer<typeof isVideoConfig>;

package/play/src/front/Api/Iframe/Ui/Video.d.ts

@@ -1,5 +0,0 @@
-export declare class Video {
-    private id;
-    constructor(id: string);
-    stop(): Promise<void>;
-}