@workadventure/iframe-api-typings 1.29.3 → 1.30.0

package/package.json

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

@@ -1572,6 +1572,25 @@ export declare const isIframeEventWrapper: z.ZodUnion<[z.ZodObject<{
 }, {
     type: "stopListeningToStreamInBubble";
     data?: undefined;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"setStatus">;
+    data: z.ZodObject<{
+        status: z.ZodUnion<[z.ZodLiteral<"ONLINE">, z.ZodLiteral<"BUSY">, z.ZodLiteral<"DO_NOT_DISTURB">, z.ZodLiteral<"BACK_IN_A_MOMENT">]>;
+    }, "strip", z.ZodTypeAny, {
+        status: "ONLINE" | "BUSY" | "DO_NOT_DISTURB" | "BACK_IN_A_MOMENT";
+    }, {
+        status: "ONLINE" | "BUSY" | "DO_NOT_DISTURB" | "BACK_IN_A_MOMENT";
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "setStatus";
+    data: {
+        status: "ONLINE" | "BUSY" | "DO_NOT_DISTURB" | "BACK_IN_A_MOMENT";
+    };
+}, {
+    type: "setStatus";
+    data: {
+        status: "ONLINE" | "BUSY" | "DO_NOT_DISTURB" | "BACK_IN_A_MOMENT";
+    };
 }>]>;
 export type IframeEvent = z.infer<typeof isIframeEventWrapper>;
 export declare const isIframeResponseEvent: z.ZodUnion<[z.ZodObject<{

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

@@ -0,0 +1,24 @@
+import { z } from "zod";
+/**
+ * Event to set the player's availability status
+ *
+ * Supported statuses:
+ * - ONLINE: Clear any custom status (default state)
+ * - BUSY: User is busy
+ * - DO_NOT_DISTURB: User does not want to be disturbed
+ * - BACK_IN_A_MOMENT: User is temporarily away
+ *
+ * Note: SILENT and AWAY are auto-managed by the system and cannot be set directly.
+ * Attempting to set them will result in a console warning.
+ */
+export declare const isSetStatusEvent: z.ZodObject<{
+    status: z.ZodUnion<[z.ZodLiteral<"ONLINE">, z.ZodLiteral<"BUSY">, z.ZodLiteral<"DO_NOT_DISTURB">, z.ZodLiteral<"BACK_IN_A_MOMENT">]>;
+}, "strip", z.ZodTypeAny, {
+    status: "ONLINE" | "BUSY" | "DO_NOT_DISTURB" | "BACK_IN_A_MOMENT";
+}, {
+    status: "ONLINE" | "BUSY" | "DO_NOT_DISTURB" | "BACK_IN_A_MOMENT";
+}>;
+/**
+ * A message sent from the iFrame to the game to set the player's status.
+ */
+export type SetStatusEvent = z.infer<typeof isSetStatusEvent>;

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

@@ -152,6 +152,21 @@ export declare class WorkadventurePlayerCommands extends IframeApiContribution<W
      * @returns {Promise<string>} Current player woka in base64
      */
     getWokaPicture(): Promise<string>;
+    /**
+     * Set the availability status of the current player.
+     *
+     * Supported statuses:
+     * - "ONLINE": Clear any custom status (default state)
+     * - "BUSY": Indicate the player is busy
+     * - "DO_NOT_DISTURB": Indicate the player does not want to be disturbed
+     * - "BACK_IN_A_MOMENT": Indicate the player is temporarily away
+     *
+     * {@link https://docs.workadventu.re/map-building/api-player.md#set-the-status-of-the-player | Website documentation}
+     *
+     * @param {string} status The status to set. Allowed values: "ONLINE", "BUSY", "DO_NOT_DISTURB", "BACK_IN_A_MOMENT"
+     * @returns {void}
+     */
+    setStatus(status: "ONLINE" | "BUSY" | "DO_NOT_DISTURB" | "BACK_IN_A_MOMENT"): void;
 }
 export type Position = {
     x: number;