@workadventure/iframe-api-typings 1.17.7 → 1.18.1

package/iframe_api.d.ts

@@ -1,122 +1 @@
-import type { CoWebsite } from "./front/Api/Iframe/nav";
-import type { ButtonDescriptor } from "./front/Api/Iframe/Ui/ButtonDescriptor";
-import type { Popup } from "./front/Api/Iframe/Ui/Popup";
-import type { Sound } from "./front/Api/Iframe/Sound/Sound";
-export type { CreateUIWebsiteEvent, ModifyUIWebsiteEvent, UIWebsiteEvent, UIWebsiteCSSValue, UIWebsiteMargin, UIWebsitePosition, UIWebsiteSize, ViewportPositionHorizontal, ViewportPositionVertical, } from "./front/Api/Events/Ui/UIWebsiteEvent";
-export type { CreateEmbeddedWebsiteEvent, ModifyEmbeddedWebsiteEvent, Rectangle, } from "./front/Api/Events/EmbeddedWebsiteEvent";
-export type { UIWebsite } from "./front/Api/Iframe/Ui/UIWebsite";
-export type { Menu } from "./front/Api/Iframe/Ui/Menu";
-export type { ActionMessage } from "./front/Api/Iframe/Ui/ActionMessage";
-export type { EmbeddedWebsite } from "./front/Api/Iframe/Room/EmbeddedWebsite";
-export type { Area } from "./front/Api/Iframe/Area/Area";
-export type { ActionsMenuAction } from "./front/Api/Iframe/ui";
-export type { TileDescriptor } from "./front/Api/Iframe/room";
-declare const wa: {
-    ui: import("./front/Api/Iframe/ui").WorkAdventureUiCommands;
-    nav: import("./front/Api/Iframe/nav").WorkadventureNavigationCommands;
-    controls: import("./front/Api/Iframe/controls").WorkadventureControlsCommands;
-    chat: import("./front/Api/Iframe/chat").WorkadventureChatCommands;
-    sound: import("./front/Api/Iframe/sound").WorkadventureSoundCommands;
-    room: import("./front/Api/Iframe/room").WorkadventureRoomCommands;
-    player: import("./front/Api/Iframe/player").WorkadventurePlayerCommands;
-    players: import("./front/Api/Iframe/players").WorkadventurePlayersCommands;
-    camera: import("./front/Api/Iframe/camera").WorkAdventureCameraCommands;
-    state: import("./front/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 username, 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;
-    /**
-     * The iframeId (only set if the code is executed from a UIWebsite iframe)
-     * Important: You need to wait for the end of the initialization before accessing.
-     * {@link https://workadventu.re/map-building/api-ui.md#get-ui-website-by-id | Website documentation}
-     *
-     * @returns {string|undefined} IframeId
-     */
-    readonly iframeId: string | undefined;
-    /**
-     * @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 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,165 @@
+import { z } from "zod";
+export declare const isSendLocalChatMessageOptions: z.ZodObject<{
+    scope: z.ZodLiteral<"local">;
+    author: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    author?: string | undefined;
+    scope: "local";
+}, {
+    author?: string | undefined;
+    scope: "local";
+}>;
+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, {
+    author?: string | undefined;
+    scope: "local";
+}, {
+    author?: string | undefined;
+    scope: "local";
+}>, 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, {
+        author?: string | undefined;
+        scope: "local";
+    }, {
+        author?: string | undefined;
+        scope: "local";
+    }>, z.ZodObject<{
+        scope: z.ZodLiteral<"bubble">;
+    }, "strip", z.ZodTypeAny, {
+        scope: "bubble";
+    }, {
+        scope: "bubble";
+    }>]>;
+}, "strip", z.ZodTypeAny, {
+    message: string;
+    options: {
+        author?: string | undefined;
+        scope: "local";
+    } | {
+        scope: "bubble";
+    };
+}, {
+    message: string;
+    options: {
+        author?: string | undefined;
+        scope: "local";
+    } | {
+        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, {
+    color?: string | undefined;
+    name: string;
+    active: boolean;
+    isMe: boolean;
+    jid: string;
+    isMember: boolean;
+}, {
+    color?: string | undefined;
+    name: string;
+    active: boolean;
+    isMe: boolean;
+    jid: string;
+    isMember: boolean;
+}>;
+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<{
+    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, {
+        color?: string | undefined;
+        name: string;
+        active: boolean;
+        isMe: boolean;
+        jid: string;
+        isMember: boolean;
+    }, {
+        color?: string | undefined;
+        name: string;
+        active: boolean;
+        isMe: boolean;
+        jid: string;
+        isMember: boolean;
+    }>>>;
+    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, {
+    author?: {
+        color?: string | undefined;
+        name: string;
+        active: boolean;
+        isMe: boolean;
+        jid: string;
+        isMember: boolean;
+    } | null | undefined;
+    text?: string[] | null | undefined;
+    name?: string | null | undefined;
+    targets?: (string | null)[] | null | undefined;
+    type: ChatMessageTypes;
+    date: Date;
+}, {
+    author?: {
+        color?: string | undefined;
+        name: string;
+        active: boolean;
+        isMe: boolean;
+        jid: string;
+        isMember: boolean;
+    } | null | undefined;
+    text?: string[] | null | undefined;
+    name?: string | null | undefined;
+    targets?: (string | null)[] | null | undefined;
+    type: ChatMessageTypes;
+    date: Date;
+}>;
+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.17.7",
+  "version": "v1.18.1",
   "description": "Typescript typings for WorkAdventure iFrame API",
   "main": "iframe_api.js",
   "types": "iframe_api.d.ts",

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

@@ -1,6 +1,7 @@
 import { z } from "zod";
 export declare const isGameStateEvent: z.ZodObject<{
     roomId: z.ZodString;
+    hashParameters: z.ZodRecord<z.ZodString, z.ZodString>;
     mapUrl: z.ZodString;
     nickname: z.ZodString;
     language: z.ZodOptional<z.ZodString>;
@@ -15,35 +16,37 @@ export declare const isGameStateEvent: z.ZodObject<{
     iframeId: z.ZodOptional<z.ZodString>;
     isLogged: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
 }, "strip", z.ZodTypeAny, {
+    metadata?: unknown;
+    variables?: unknown;
+    userRoomToken?: string | undefined;
+    uuid?: string | undefined;
     language?: string | undefined;
     playerId?: number | undefined;
-    uuid?: string | undefined;
     startLayerName?: string | undefined;
-    variables?: unknown;
     playerVariables?: unknown;
-    userRoomToken?: string | undefined;
-    metadata?: unknown;
     iframeId?: string | undefined;
+    tags: string[];
     roomId: string;
+    isLogged: boolean;
     mapUrl: string;
+    hashParameters: Record<string, string>;
     nickname: string;
-    tags: string[];
-    isLogged: boolean;
 }, {
+    metadata?: unknown;
+    variables?: unknown;
+    userRoomToken?: string | undefined;
+    isLogged?: boolean | undefined;
+    uuid?: string | undefined;
     language?: string | undefined;
     playerId?: number | undefined;
-    uuid?: string | undefined;
     startLayerName?: string | undefined;
-    variables?: unknown;
     playerVariables?: unknown;
-    userRoomToken?: string | undefined;
-    metadata?: unknown;
     iframeId?: string | undefined;
-    isLogged?: boolean | undefined;
+    tags: string[];
     roomId: string;
     mapUrl: string;
+    hashParameters: Record<string, string>;
     nickname: string;
-    tags: string[];
 }>;
 /**
  * A message sent from the game to the iFrame when the gameState is received by the script