@workadventure/iframe-api-typings 1.14.3 → 1.14.7

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

@@ -6,13 +6,13 @@ export declare const isJoinMucEvent: z.ZodObject<{
     subscribe: z.ZodBoolean;
 }, "strip", z.ZodTypeAny, {
     type: string;
-    url: string;
     name: string;
+    url: string;
     subscribe: boolean;
 }, {
     type: string;
-    url: string;
     name: string;
+    url: string;
     subscribe: boolean;
 }>;
 /**

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

@@ -2,7 +2,7 @@ import { z } from "zod";
 export declare const isModalEvent: z.ZodObject<{
     src: z.ZodString;
     allow: z.ZodDefault<z.ZodNullable<z.ZodOptional<z.ZodString>>>;
-    tiltle: z.ZodDefault<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, {
@@ -10,12 +10,12 @@ export declare const isModalEvent: z.ZodObject<{
     position: "left" | "right" | "center";
     allow: string | null;
     src: string;
-    tiltle: string;
+    title: string;
 }, {
     allowApi?: boolean | undefined;
     position?: "left" | "right" | "center" | undefined;
     allow?: string | null | undefined;
-    tiltle?: string | undefined;
+    title?: string | undefined;
     src: string;
 }>;
 /**

package/front/Api/Events/ProximityMeeting/JoinProximityMeetingEvent.d.ts

@@ -19,22 +19,22 @@ export declare const isJoinProximityMeetingEvent: z.ZodObject<{
         variables: z.ZodMap<z.ZodString, z.ZodUnknown>;
     }, "strip", z.ZodTypeAny, {
         outlineColor?: number | undefined;
+        name: string;
         position: {
             x: number;
             y: number;
         };
-        name: string;
         playerId: number;
         variables: Map<string, unknown>;
         userUuid: string;
         availabilityStatus: string;
     }, {
         outlineColor?: number | undefined;
+        name: string;
         position: {
             x: number;
             y: number;
         };
-        name: string;
         playerId: number;
         variables: Map<string, unknown>;
         userUuid: string;
@@ -43,11 +43,11 @@ export declare const isJoinProximityMeetingEvent: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     users: {
         outlineColor?: number | undefined;
+        name: string;
         position: {
             x: number;
             y: number;
         };
-        name: string;
         playerId: number;
         variables: Map<string, unknown>;
         userUuid: string;
@@ -56,11 +56,11 @@ export declare const isJoinProximityMeetingEvent: z.ZodObject<{
 }, {
     users: {
         outlineColor?: number | undefined;
+        name: string;
         position: {
             x: number;
             y: number;
         };
-        name: string;
         playerId: number;
         variables: Map<string, unknown>;
         userUuid: string;

package/front/Api/Events/ProximityMeeting/ParticipantProximityMeetingEvent.d.ts

@@ -19,22 +19,22 @@ export declare const isParticipantProximityMeetingEvent: z.ZodObject<{
         variables: z.ZodMap<z.ZodString, z.ZodUnknown>;
     }, "strip", z.ZodTypeAny, {
         outlineColor?: number | undefined;
+        name: string;
         position: {
             x: number;
             y: number;
         };
-        name: string;
         playerId: number;
         variables: Map<string, unknown>;
         userUuid: string;
         availabilityStatus: string;
     }, {
         outlineColor?: number | undefined;
+        name: string;
         position: {
             x: number;
             y: number;
         };
-        name: string;
         playerId: number;
         variables: Map<string, unknown>;
         userUuid: string;
@@ -43,11 +43,11 @@ export declare const isParticipantProximityMeetingEvent: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     user: {
         outlineColor?: number | undefined;
+        name: string;
         position: {
             x: number;
             y: number;
         };
-        name: string;
         playerId: number;
         variables: Map<string, unknown>;
         userUuid: string;
@@ -56,11 +56,11 @@ export declare const isParticipantProximityMeetingEvent: z.ZodObject<{
 }, {
     user: {
         outlineColor?: number | undefined;
+        name: string;
         position: {
             x: number;
             y: number;
         };
-        name: string;
         playerId: number;
         variables: Map<string, unknown>;
         userUuid: string;

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

@@ -4,15 +4,21 @@ export declare const isSettingsEvent: z.ZodObject<{
     chatSounds: z.ZodBoolean;
     enableChat: z.ZodBoolean;
     enableChatUpload: z.ZodBoolean;
+    enableChatOnlineList: z.ZodBoolean;
+    enableChatDisconnectedList: z.ZodBoolean;
 }, "strip", z.ZodTypeAny, {
     notification: boolean;
     chatSounds: boolean;
     enableChat: boolean;
     enableChatUpload: boolean;
+    enableChatOnlineList: boolean;
+    enableChatDisconnectedList: boolean;
 }, {
     notification: boolean;
     chatSounds: boolean;
     enableChat: boolean;
     enableChatUpload: boolean;
+    enableChatOnlineList: boolean;
+    enableChatDisconnectedList: boolean;
 }>;
 export declare type SettingsEvent = z.infer<typeof isSettingsEvent>;

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/Events/XmppSettingsMessageEvent.d.ts

@@ -9,14 +9,14 @@ export declare const isXmppSettingsMessageEvent: z.ZodObject<{
         subscribe: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
     }, "strip", z.ZodTypeAny, {
         type: string;
-        url: string;
         name: string;
+        url: string;
         subscribe: boolean;
     }, {
         subscribe?: boolean | undefined;
         type: string;
-        url: string;
         name: string;
+        url: string;
     }>, "many">;
     jabberId: z.ZodString;
     jabberPassword: z.ZodString;
@@ -25,8 +25,8 @@ export declare const isXmppSettingsMessageEvent: z.ZodObject<{
     conferenceDomain: string;
     rooms: {
         type: string;
-        url: string;
         name: string;
+        url: string;
         subscribe: boolean;
     }[];
     jabberId: string;
@@ -37,8 +37,8 @@ export declare const isXmppSettingsMessageEvent: z.ZodObject<{
     rooms: {
         subscribe?: boolean | undefined;
         type: string;
-        url: string;
         name: string;
+        url: string;
     }[];
     jabberId: string;
     jabberPassword: string;

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

@@ -7,11 +7,11 @@ export declare class WorkadventureProximityMeetingCommands extends IframeApiCont
         callback: (event: {
             users: {
                 outlineColor?: number | undefined;
+                name: string;
                 position: {
                     x: number;
                     y: number;
                 };
-                name: string;
                 playerId: number;
                 variables: Map<string, unknown>;
                 userUuid: string;
@@ -23,11 +23,11 @@ export declare class WorkadventureProximityMeetingCommands extends IframeApiCont
         callback: (event: {
             user: {
                 outlineColor?: number | undefined;
+                name: string;
                 position: {
                     x: number;
                     y: number;
                 };
-                name: string;
                 playerId: number;
                 variables: Map<string, unknown>;
                 userUuid: string;
@@ -39,11 +39,11 @@ export declare class WorkadventureProximityMeetingCommands extends IframeApiCont
         callback: (event: {
             user: {
                 outlineColor?: number | undefined;
+                name: string;
                 position: {
                     x: number;
                     y: number;
                 };
-                name: string;
                 playerId: number;
                 variables: Map<string, unknown>;
                 userUuid: string;

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

@@ -0,0 +1,31 @@
+import { AddButtonActionBarEvent } from "../../Events/Ui/ButtonActionBarEvent";
+import { IframeApiContribution } from "../IframeApiContribution";
+export declare type ButtonActionBarClickedCallback = (buttonActionBar: AddButtonActionBarEvent) => void;
+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}
+     *
+     * @param id
+     * @param label
+     * @param callback
+     */
+    addButton(id: string, label: string, callback?: ButtonActionBarClickedCallback): void;
+    /**
+     * Remove action bar button
+     * {@link http://workadventure.localhost/map-building/api-ui.md#remove-action-bar | Website documentation}
+     *
+     * @param id
+     */
+    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/players.d.ts

@@ -20,11 +20,11 @@ export declare class WorkadventurePlayersCommands extends IframeApiContribution<
         type: "addRemotePlayer";
         callback: (event: {
             outlineColor?: number | undefined;
+            name: string;
             position: {
                 x: number;
                 y: number;
             };
-            name: string;
             playerId: number;
             variables: Map<string, unknown>;
             userUuid: string;
@@ -36,11 +36,11 @@ export declare class WorkadventurePlayersCommands extends IframeApiContribution<
     } | {
         type: "remotePlayerChanged";
         callback: (event: {
+            name?: string | undefined;
             position?: {
                 x: number;
                 y: number;
             } | undefined;
-            name?: string | undefined;
             variables?: Map<string, unknown> | undefined;
             availabilityStatus?: string | undefined;
             outlineColor?: number | undefined;

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;
@@ -53,11 +54,11 @@ export declare class WorkAdventureUiCommands extends IframeApiContribution<WorkA
         type: "remotePlayerClickedEvent";
         callback: (event: {
             outlineColor?: number | undefined;
+            name: string;
             position: {
                 x: number;
                 y: number;
             };
-            name: string;
             playerId: number;
             variables: Map<string, unknown>;
             userUuid: 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.3",
+  "version": "v1.14.7",
   "description": "Typescript typings for WorkAdventure iFrame API",
   "main": "iframe_api.js",
   "types": "iframe_api.d.ts",