@workadventure/iframe-api-typings 1.25.6 → 1.25.8

package/iframe_api.d.ts

@@ -1,111 +1 @@
-import { CoWebsite } from "./Api/Iframe/nav";
-import type { ButtonDescriptor } from "./Api/Iframe/Ui/ButtonDescriptor";
-import type { Popup } from "./Api/Iframe/Ui/Popup";
-import type { Sound } from "./Api/Iframe/Sound/Sound";
-export type { UIWebsite } from "./Api/Iframe/Ui/UIWebsite";
-export type { Menu } from "./Api/Iframe/Ui/Menu";
-export type { ActionMessage } from "./Api/Iframe/Ui/ActionMessage";
-export type { EmbeddedWebsite } from "./Api/Iframe/Room/EmbeddedWebsite";
-export type { Area } from "./Api/Iframe/Area/Area";
-export type { ActionsMenuAction } from "./Api/Iframe/ui";
-declare const wa: {
-    ui: import("./Api/Iframe/ui").WorkAdventureUiCommands;
-    nav: import("./Api/Iframe/nav").WorkadventureNavigationCommands;
-    controls: import("./Api/Iframe/controls").WorkadventureControlsCommands;
-    chat: import("./Api/Iframe/chat").WorkadventureChatCommands;
-    sound: import("./Api/Iframe/sound").WorkadventureSoundCommands;
-    room: import("./Api/Iframe/room").WorkadventureRoomCommands;
-    player: import("./Api/Iframe/player").WorkadventurePlayerCommands;
-    players: import("./Api/Iframe/players").WorkadventurePlayersCommands;
-    camera: import("./Api/Iframe/camera").WorkAdventureCameraCommands;
-    state: import("./Api/Iframe/state").WorkadventureStateCommands & {
-        [key: string]: unknown;
-    };
-    /**
-     * When your script / iFrame loads WorkAdventure, it takes a few milliseconds for your
-     * script / iFrame to exchange data with WorkAdventure. You should wait for the WorkAdventure
-     * API to be fully ready using the WA.onInit() method.
-     * {@link https://workadventu.re/map-building/api-start.md#waiting-for-workadventure-api-to-be-available | Website documentation}
-     *
-     * Some properties (like the current user name, or the room ID) are not available until WA.onInit has completed.
-     *
-     * @returns {void}
-     */
-    onInit(): Promise<void>;
-    /**
-     * The metadata sent by the administration website.
-     * Important: You need to wait for the end of the initialization before accessing.
-     * {@link https://workadventu.re/map-building/api-metadata.md | Website documentation}
-     *
-     * @returns {unknown|undefined} Metadata
-     */
-    readonly metadata: unknown;
-    /**
-     * @deprecated Use WA.chat.sendChatMessage instead
-     */
-    sendChatMessage(message: string, author: string): void;
-    /**
-     * @deprecated Use WA.chat.disablePlayerControls instead
-     */
-    disablePlayerControls(): void;
-    /**
-     * @deprecated Use WA.controls.restorePlayerControls instead
-     */
-    restorePlayerControls(): void;
-    /**
-     * @deprecated Use WA.ui.displayBubble instead
-     */
-    displayBubble(): void;
-    /**
-     * @deprecated Use WA.ui.removeBubble instead
-     */
-    removeBubble(): void;
-    /**
-     * @deprecated Use WA.nav.openTab instead
-     */
-    openTab(url: string): void;
-    /**
-     * @deprecated Use WA.sound.loadSound instead
-     */
-    loadSound(url: string): Sound;
-    /**
-     * @deprecated Use WA.nav.goToPage instead
-     */
-    goToPage(url: string): void;
-    /**
-     * @deprecated Use WA.nav.goToRoom instead
-     */
-    goToRoom(url: string): void;
-    /**
-     * @deprecated Use WA.nav.openCoWebSite instead
-     */
-    openCoWebSite(url: string, allowApi?: boolean, allowPolicy?: string): Promise<CoWebsite>;
-    /**
-     * @deprecated Use WA.nav.closeCoWebSite instead
-     */
-    closeCoWebSite(): Promise<void>;
-    /**
-     * @deprecated Use WA.ui.openPopup instead
-     */
-    openPopup(targetObject: string, message: string, buttons: ButtonDescriptor[]): Popup;
-    /**
-     * @deprecated Use WA.chat.onChatMessage instead
-     */
-    onChatMessage(callback: (message: string) => void): void;
-    /**
-     * @deprecated Use WA.room.onEnterZone instead
-     */
-    onEnterZone(name: string, callback: () => void): void;
-    /**
-     * @deprecated Use WA.room.onLeaveZone instead
-     */
-    onLeaveZone(name: string, callback: () => void): void;
-};
-export declare type WorkAdventureApi = typeof wa;
-export type { Sound, Popup, ButtonDescriptor, CoWebsite };
-declare global {
-    interface Window {
-        WA: WorkAdventureApi;
-    }
-    let WA: WorkAdventureApi;
-}
+export type * from "./play/src/iframe_api";

package/libs/shared-utils/src/Events/ChatEvent.d.ts

@@ -0,0 +1,168 @@
+import { z } from "zod";
+export declare const isSendLocalChatMessageOptions: z.ZodObject<{
+    scope: z.ZodLiteral<"local">;
+    author: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    scope: "local";
+    author?: string | undefined;
+}, {
+    scope: "local";
+    author?: string | undefined;
+}>;
+export declare const isSendBubbleChatMessageOptions: z.ZodObject<{
+    scope: z.ZodLiteral<"bubble">;
+}, "strip", z.ZodTypeAny, {
+    scope: "bubble";
+}, {
+    scope: "bubble";
+}>;
+export declare const isSendChatMessageOptions: z.ZodUnion<[z.ZodObject<{
+    scope: z.ZodLiteral<"local">;
+    author: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    scope: "local";
+    author?: string | undefined;
+}, {
+    scope: "local";
+    author?: string | undefined;
+}>, z.ZodObject<{
+    scope: z.ZodLiteral<"bubble">;
+}, "strip", z.ZodTypeAny, {
+    scope: "bubble";
+}, {
+    scope: "bubble";
+}>]>;
+export declare const isChatEvent: z.ZodObject<{
+    message: z.ZodString;
+    options: z.ZodUnion<[z.ZodObject<{
+        scope: z.ZodLiteral<"local">;
+        author: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        scope: "local";
+        author?: string | undefined;
+    }, {
+        scope: "local";
+        author?: string | undefined;
+    }>, z.ZodObject<{
+        scope: z.ZodLiteral<"bubble">;
+    }, "strip", z.ZodTypeAny, {
+        scope: "bubble";
+    }, {
+        scope: "bubble";
+    }>]>;
+}, "strip", z.ZodTypeAny, {
+    message: string;
+    options: {
+        scope: "local";
+        author?: string | undefined;
+    } | {
+        scope: "bubble";
+    };
+}, {
+    message: string;
+    options: {
+        scope: "local";
+        author?: string | undefined;
+    } | {
+        scope: "bubble";
+    };
+}>;
+export declare const isAuthor: z.ZodObject<{
+    name: z.ZodString;
+    active: z.ZodBoolean;
+    isMe: z.ZodBoolean;
+    jid: z.ZodString;
+    isMember: z.ZodBoolean;
+    color: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    active: boolean;
+    isMe: boolean;
+    jid: string;
+    isMember: boolean;
+    color?: string | undefined;
+}, {
+    name: string;
+    active: boolean;
+    isMe: boolean;
+    jid: string;
+    isMember: boolean;
+    color?: string | undefined;
+}>;
+export declare enum ChatMessageTypes {
+    text = 1,
+    me = 2,
+    userIncoming = 3,
+    userOutcoming = 4,
+    userWriting = 5,
+    userStopWriting = 6
+}
+export declare const isChatMessageTypes: z.ZodNativeEnum<typeof ChatMessageTypes>;
+export declare const isChatMessage: z.ZodObject<{
+    id: z.ZodOptional<z.ZodString>;
+    type: z.ZodNativeEnum<typeof ChatMessageTypes>;
+    date: z.ZodDate;
+    author: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        name: z.ZodString;
+        active: z.ZodBoolean;
+        isMe: z.ZodBoolean;
+        jid: z.ZodString;
+        isMember: z.ZodBoolean;
+        color: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        active: boolean;
+        isMe: boolean;
+        jid: string;
+        isMember: boolean;
+        color?: string | undefined;
+    }, {
+        name: string;
+        active: boolean;
+        isMe: boolean;
+        jid: string;
+        isMember: boolean;
+        color?: string | undefined;
+    }>>>;
+    name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    targets: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNullable<z.ZodString>, "many">>>;
+    text: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString, "many">>>;
+}, "strip", z.ZodTypeAny, {
+    type: ChatMessageTypes;
+    date: Date;
+    author?: {
+        name: string;
+        active: boolean;
+        isMe: boolean;
+        jid: string;
+        isMember: boolean;
+        color?: string | undefined;
+    } | null | undefined;
+    text?: string[] | null | undefined;
+    name?: string | null | undefined;
+    id?: string | undefined;
+    targets?: (string | null)[] | null | undefined;
+}, {
+    type: ChatMessageTypes;
+    date: Date;
+    author?: {
+        name: string;
+        active: boolean;
+        isMe: boolean;
+        jid: string;
+        isMember: boolean;
+        color?: string | undefined;
+    } | null | undefined;
+    text?: string[] | null | undefined;
+    name?: string | null | undefined;
+    id?: string | undefined;
+    targets?: (string | null)[] | null | undefined;
+}>;
+export type ChatMessage = z.infer<typeof isChatMessage>;
+/**
+ * A message sent from the iFrame to the game to add a message in the chat.
+ */
+export type ChatEvent = z.infer<typeof isChatEvent>;
+export type SendLocalChatMessageOptions = z.infer<typeof isSendLocalChatMessageOptions>;
+export type SendBubbleChatMessageOptions = z.infer<typeof isSendBubbleChatMessageOptions>;
+export type SendChatMessageOptions = z.infer<typeof isSendChatMessageOptions>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@workadventure/iframe-api-typings",
-  "version": "v1.25.6",
+  "version": "v1.25.8",
   "description": "Typescript typings for WorkAdventure iFrame API",
   "main": "iframe_api.js",
   "types": "iframe_api.d.ts",
@@ -12,6 +12,6 @@
   },
   "dependencies": {
     "rxjs": "^6.6.3",
-    "zod": "^3.14.3"
+    "zod": "^3.23.8"
   }
 }

package/{Api → play/src/front/Api}/Events/ActionsMenuActionClickedEvent.d.ts

@@ -9,5 +9,5 @@ export declare const isActionsMenuActionClickedEvent: z.ZodObject<{
     id: number;
     actionName: string;
 }>;
-export declare type ActionsMenuActionClickedEvent = z.infer<typeof isActionsMenuActionClickedEvent>;
-export declare type ActionsMenuActionClickedEventCallback = (event: ActionsMenuActionClickedEvent) => void;
+export type ActionsMenuActionClickedEvent = z.infer<typeof isActionsMenuActionClickedEvent>;
+export type ActionsMenuActionClickedEventCallback = (event: ActionsMenuActionClickedEvent) => void;

package/{Api → play/src/front/Api}/Events/AddActionsMenuKeyToRemotePlayerEvent.d.ts

@@ -9,5 +9,5 @@ export declare const isAddActionsMenuKeyToRemotePlayerEvent: z.ZodObject<{
     id: number;
     actionKey: string;
 }>;
-export declare type AddActionsMenuKeyToRemotePlayerEvent = z.infer<typeof isAddActionsMenuKeyToRemotePlayerEvent>;
-export declare type AddActionsMenuKeyToRemotePlayerEventCallback = (event: AddActionsMenuKeyToRemotePlayerEvent) => void;
+export type AddActionsMenuKeyToRemotePlayerEvent = z.infer<typeof isAddActionsMenuKeyToRemotePlayerEvent>;
+export type AddActionsMenuKeyToRemotePlayerEventCallback = (event: AddActionsMenuKeyToRemotePlayerEvent) => void;

package/{Api → play/src/front/Api}/Events/AddPlayerEvent.d.ts

@@ -16,30 +16,34 @@ export declare const isAddPlayerEvent: z.ZodObject<{
         y: number;
     }>;
     variables: z.ZodMap<z.ZodString, z.ZodUnknown>;
+    chatID: z.ZodNullable<z.ZodOptional<z.ZodString>>;
 }, "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;
+    chatID?: string | null | undefined;
+}, {
+    name: string;
     position: {
         x: number;
         y: number;
     };
-    name: string;
     playerId: number;
     variables: Map<string, unknown>;
     userUuid: string;
     availabilityStatus: string;
+    outlineColor?: number | undefined;
+    chatID?: string | null | undefined;
 }>;
 export declare const isRemotePlayerChangedEvent: z.ZodObject<{
+    name: z.ZodOptional<z.ZodString>;
     position: z.ZodOptional<z.ZodObject<{
         x: z.ZodNumber;
         y: z.ZodNumber;
@@ -50,37 +54,39 @@ export declare const isRemotePlayerChangedEvent: z.ZodObject<{
         x: number;
         y: number;
     }>>;
-    name: z.ZodOptional<z.ZodString>;
     playerId: z.ZodNumber;
     variables: z.ZodOptional<z.ZodMap<z.ZodString, z.ZodUnknown>>;
     availabilityStatus: z.ZodOptional<z.ZodString>;
     outlineColor: z.ZodOptional<z.ZodOptional<z.ZodNumber>>;
+    chatID: z.ZodNullable<z.ZodOptional<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
+    playerId: number;
+    name?: string | undefined;
     position?: {
         x: number;
         y: number;
     } | undefined;
-    name?: string | undefined;
     variables?: Map<string, unknown> | undefined;
     availabilityStatus?: string | undefined;
     outlineColor?: number | undefined;
-    playerId: number;
+    chatID?: string | null | undefined;
 }, {
+    playerId: number;
+    name?: string | undefined;
     position?: {
         x: number;
         y: number;
     } | undefined;
-    name?: string | undefined;
     variables?: Map<string, unknown> | undefined;
     availabilityStatus?: string | undefined;
     outlineColor?: number | undefined;
-    playerId: number;
+    chatID?: string | null | undefined;
 }>;
 /**
  * A message sent from the game to the iFrame to notify a new player arrived in our viewport
  */
-export declare type AddPlayerEvent = z.infer<typeof isAddPlayerEvent>;
+export type AddPlayerEvent = z.infer<typeof isAddPlayerEvent>;
 /**
  * A message sent from the game to the iFrame to notify a player has changed (moved / changed name, etc...)
  */
-export declare type RemotePlayerChangedEvent = z.infer<typeof isRemotePlayerChangedEvent>;
+export type RemotePlayerChangedEvent = z.infer<typeof isRemotePlayerChangedEvent>;

package/{Api → play/src/front/Api}/Events/AskPositionEvent.d.ts

@@ -12,4 +12,4 @@ export declare const isAskPositionEvent: z.ZodObject<{
 /**
  * A message sent from the iFrame to the game to ask the position of the user with uuid and walk to him.
  */
-export declare type AskPositionEvent = z.infer<typeof isAskPositionEvent>;
+export type AskPositionEvent = z.infer<typeof isAskPositionEvent>;

package/{Api → play/src/front/Api}/Events/ButtonClickedEvent.d.ts

@@ -12,4 +12,4 @@ export declare const isButtonClickedEvent: z.ZodObject<{
 /**
  * A message sent from the game to the iFrame when a user enters or leaves a zone marked with the "zone" property.
  */
-export declare type ButtonClickedEvent = z.infer<typeof isButtonClickedEvent>;
+export type ButtonClickedEvent = z.infer<typeof isButtonClickedEvent>;

package/{Api → play/src/front/Api}/Events/CameraFollowPlayerEvent.d.ts

@@ -1,12 +1,15 @@
 import { z } from "zod";
 export declare const isCameraFollowPlayerEvent: z.ZodObject<{
     smooth: z.ZodBoolean;
+    duration: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
     smooth: boolean;
+    duration?: number | undefined;
 }, {
     smooth: boolean;
+    duration?: number | undefined;
 }>;
 /**
  * A message sent from the iFrame to the game to make the camera follow player.
  */
-export declare type CameraFollowPlayerEvent = z.infer<typeof isCameraFollowPlayerEvent>;
+export type CameraFollowPlayerEvent = z.infer<typeof isCameraFollowPlayerEvent>;

package/{Api → play/src/front/Api}/Events/CameraSetEvent.d.ts

@@ -6,22 +6,25 @@ export declare const isCameraSetEvent: z.ZodObject<{
     height: z.ZodOptional<z.ZodNumber>;
     lock: z.ZodBoolean;
     smooth: z.ZodBoolean;
+    duration: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
-    width?: number | undefined;
-    height?: number | undefined;
     x: number;
     y: number;
     lock: boolean;
     smooth: boolean;
-}, {
-    width?: number | undefined;
     height?: number | undefined;
+    width?: number | undefined;
+    duration?: number | undefined;
+}, {
     x: number;
     y: number;
     lock: boolean;
     smooth: boolean;
+    height?: number | undefined;
+    width?: number | undefined;
+    duration?: number | undefined;
 }>;
 /**
  * A message sent from the iFrame to the game to change the camera position.
  */
-export declare type CameraSetEvent = z.infer<typeof isCameraSetEvent>;
+export type CameraSetEvent = z.infer<typeof isCameraSetEvent>;

package/{Api → play/src/front/Api}/Events/ChangeAreaEvent.d.ts

@@ -9,4 +9,4 @@ export declare const isChangeAreaEvent: z.ZodObject<{
 /**
  * A message sent from the game to the iFrame when a user enters or leaves an area.
  */
-export declare type ChangeAreaEvent = z.infer<typeof isChangeAreaEvent>;
+export type ChangeAreaEvent = z.infer<typeof isChangeAreaEvent>;

package/{Api → play/src/front/Api}/Events/ChangeLayerEvent.d.ts

@@ -9,4 +9,4 @@ export declare const isChangeLayerEvent: z.ZodObject<{
 /**
  * A message sent from the game to the iFrame when a user enters or leaves a layer.
  */
-export declare type ChangeLayerEvent = z.infer<typeof isChangeLayerEvent>;
+export type ChangeLayerEvent = z.infer<typeof isChangeLayerEvent>;

package/{Api → play/src/front/Api}/Events/ChatVisibilityEvent.d.ts

@@ -6,4 +6,4 @@ export declare const isChatVisibilityEvent: z.ZodObject<{
 }, {
     visibility: boolean;
 }>;
-export declare type ChatVisibilityEvent = z.infer<typeof isChatVisibilityEvent>;
+export type ChatVisibilityEvent = z.infer<typeof isChatVisibilityEvent>;

package/{Api → play/src/front/Api}/Events/ClosePopupEvent.d.ts

@@ -9,4 +9,4 @@ export declare const isClosePopupEvent: z.ZodObject<{
 /**
  * A message sent from the iFrame to the game to add a message in the chat.
  */
-export declare type ClosePopupEvent = z.infer<typeof isClosePopupEvent>;
+export type ClosePopupEvent = z.infer<typeof isClosePopupEvent>;

package/{Api → play/src/front/Api}/Events/ColorEvent.d.ts

@@ -15,4 +15,4 @@ export declare const isColorEvent: z.ZodObject<{
 /**
  * A message sent from the iFrame to the game to dynamically set the outline of the player.
  */
-export declare type ColorEvent = z.infer<typeof isColorEvent>;
+export type ColorEvent = z.infer<typeof isColorEvent>;

package/{Api/Events/CreateAreaEvent.d.ts → play/src/front/Api/Events/CreateDynamicAreaEvent.d.ts}

@@ -1,44 +1,44 @@
 import { z } from "zod";
-export declare const isAreaEvent: z.ZodObject<{
+export declare const isDynamicAreaEvent: z.ZodObject<{
     name: z.ZodString;
     x: z.ZodOptional<z.ZodNumber>;
     y: z.ZodOptional<z.ZodNumber>;
     width: z.ZodOptional<z.ZodNumber>;
     height: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
+    name: string;
+    height?: number | undefined;
+    width?: number | undefined;
     x?: number | undefined;
     y?: number | undefined;
-    width?: number | undefined;
-    height?: number | undefined;
-    name: string;
 }, {
+    name: string;
+    height?: number | undefined;
+    width?: number | undefined;
     x?: number | undefined;
     y?: number | undefined;
-    width?: number | undefined;
-    height?: number | undefined;
-    name: string;
 }>;
 /**
  * A message sent from the iFrame to the game to modify an embedded website
  */
-export declare type ModifyAreaEvent = z.infer<typeof isAreaEvent>;
-export declare const isCreateAreaEvent: z.ZodObject<{
+export type ModifyDynamicAreaEvent = z.infer<typeof isDynamicAreaEvent>;
+export declare const isCreateDynamicAreaEvent: z.ZodObject<{
     name: z.ZodString;
     x: z.ZodNumber;
     y: z.ZodNumber;
     width: z.ZodNumber;
     height: z.ZodNumber;
 }, "strip", z.ZodTypeAny, {
+    height: number;
+    width: number;
     name: string;
     x: number;
     y: number;
-    width: number;
-    height: number;
 }, {
+    height: number;
+    width: number;
     name: string;
     x: number;
     y: number;
-    width: number;
-    height: number;
 }>;
-export declare type CreateAreaEvent = z.infer<typeof isCreateAreaEvent>;
+export type CreateDynamicAreaEvent = z.infer<typeof isCreateDynamicAreaEvent>;