@workadventure/iframe-api-typings 1.14.5 → 1.14.8

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

@@ -1137,6 +1137,49 @@ export declare const isIframeEventWrapper: z.ZodUnion<[z.ZodObject<{
 }, {
     data?: undefined;
     type: "redirectPricing";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"addButtonActionBar">;
+    data: z.ZodObject<{
+        id: z.ZodString;
+        label: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        label: string;
+    }, {
+        id: string;
+        label: string;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "addButtonActionBar";
+    data: {
+        id: string;
+        label: string;
+    };
+}, {
+    type: "addButtonActionBar";
+    data: {
+        id: string;
+        label: string;
+    };
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"removeButtonActionBar">;
+    data: z.ZodObject<{
+        id: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+    }, {
+        id: string;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "removeButtonActionBar";
+    data: {
+        id: string;
+    };
+}, {
+    type: "removeButtonActionBar";
+    data: {
+        id: string;
+    };
 }>]>;
 export declare type IframeEvent = z.infer<typeof isIframeEventWrapper>;
 export declare const isIframeResponseEvent: z.ZodUnion<[z.ZodObject<{
@@ -2352,6 +2395,69 @@ export declare const isIframeResponseEvent: z.ZodUnion<[z.ZodObject<{
 }, {
     type: "updateWritingStatusChatList";
     data: (string | null)[];
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"buttonActionBarTrigger">;
+    data: z.ZodObject<{
+        id: z.ZodString;
+        label: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        label: string;
+    }, {
+        id: string;
+        label: string;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "buttonActionBarTrigger";
+    data: {
+        id: string;
+        label: string;
+    };
+}, {
+    type: "buttonActionBarTrigger";
+    data: {
+        id: string;
+        label: string;
+    };
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"modalCloseTrigger">;
+    data: z.ZodObject<{
+        src: z.ZodString;
+        allow: z.ZodDefault<z.ZodNullable<z.ZodOptional<z.ZodString>>>;
+        title: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+        position: z.ZodDefault<z.ZodOptional<z.ZodEnum<["right", "left", "center"]>>>;
+        allowApi: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    }, "strip", z.ZodTypeAny, {
+        allowApi: boolean;
+        position: "left" | "right" | "center";
+        allow: string | null;
+        src: string;
+        title: string;
+    }, {
+        allowApi?: boolean | undefined;
+        position?: "left" | "right" | "center" | undefined;
+        allow?: string | null | undefined;
+        title?: string | undefined;
+        src: string;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "modalCloseTrigger";
+    data: {
+        allowApi: boolean;
+        position: "left" | "right" | "center";
+        allow: string | null;
+        src: string;
+        title: string;
+    };
+}, {
+    type: "modalCloseTrigger";
+    data: {
+        allowApi?: boolean | undefined;
+        position?: "left" | "right" | "center" | undefined;
+        allow?: string | null | undefined;
+        title?: string | undefined;
+        src: string;
+    };
 }>]>;
 export declare type IframeResponseEvent = z.infer<typeof isIframeResponseEvent>;
 export declare const isLookingLikeIframeEventWrapper: z.ZodObject<{

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

@@ -0,0 +1,21 @@
+import { z } from "zod";
+export declare const isAddButtonActionBarEvent: z.ZodObject<{
+    id: z.ZodString;
+    label: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    label: string;
+}, {
+    id: string;
+    label: string;
+}>;
+export declare type AddButtonActionBarEvent = z.infer<typeof isAddButtonActionBarEvent>;
+export declare type AddActionsButtonActionBarEventCallback = (event: AddButtonActionBarEvent) => void;
+export declare const isRemoveButtonActionBarEvent: z.ZodObject<{
+    id: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+}, {
+    id: string;
+}>;
+export declare type RemoveButtonActionBarEvent = z.infer<typeof isRemoveButtonActionBarEvent>;

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

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

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

@@ -1,15 +1,25 @@
 import { IframeApiContribution } from "../IframeApiContribution";
 import type { ModalEvent } from "../../Events/ModalEvent";
 export declare class WorkadventureModalCommands extends IframeApiContribution<WorkadventureModalCommands> {
-    callbacks: never[];
+    private _closeCallback?;
+    callbacks: {
+        type: "modalCloseTrigger";
+        callback: (event: {
+            allowApi: boolean;
+            position: "left" | "right" | "center";
+            allow: string | null;
+            src: string;
+            title: string;
+        }) => void;
+    }[];
     /**
-     * Open instantly the chat window.
-     * {@link https://workadventu.re/map-building/api-chat.md#open-the-modal-window | Website documentation}
+     * Open instantly the modal window.
+     * {@link http://workadventure.localhost/map-building/api-ui.md#open-the-modal-iframe | Website documentation}
      */
-    openModal(modalEvent: ModalEvent): void;
+    openModal(modalEvent: ModalEvent, closeCallback?: (arg: ModalEvent) => void): void;
     /**
-     * Close instantly the chat window.
-     * {@link https://workadventu.re/map-building/api-chat.md#close-the-modal-window | Website documentation}
+     * Close instantly the modal window.
+     * {@link http://workadventure.localhost/map-building/api-ui.md#close-the-chat-window | Website documentation}
      */
     closeModal(): void;
 }

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

@@ -9,6 +9,7 @@ import { Subject } from "rxjs";
 import type { UIWebsiteCommands } from "./Ui/UIWebsite";
 import { RemotePlayer } from "./Players/RemotePlayer";
 import type { WorkadventureModalCommands } from "./Ui/Modal";
+import { WorkAdventureButtonActionBarCommands } from "./Ui/ButtonActionBar";
 interface MenuDescriptor {
     callback?: (commandDescriptor: string) => void;
     iframe?: string;
@@ -111,6 +112,7 @@ export declare class WorkAdventureUiCommands extends IframeApiContribution<WorkA
     displayActionMessage(actionMessageOptions: ActionMessageOptions): ActionMessage;
     get website(): UIWebsiteCommands;
     get modal(): WorkadventureModalCommands;
+    get actionBar(): WorkAdventureButtonActionBarCommands;
 }
 declare const _default: WorkAdventureUiCommands;
 export default _default;

package/package.json

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