@workadventure/iframe-api-typings 1.25.6 → 1.25.8

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

@@ -3,11 +3,11 @@ export declare const isSetVariableEvent: z.ZodObject<{
     key: z.ZodString;
     value: z.ZodUnknown;
 }, "strip", z.ZodTypeAny, {
-    value?: unknown;
     key: string;
-}, {
     value?: unknown;
+}, {
     key: string;
+    value?: unknown;
 }>;
 export declare const isSetVariableIframeEvent: z.ZodObject<{
     type: z.ZodLiteral<"setVariable">;
@@ -15,26 +15,26 @@ export declare const isSetVariableIframeEvent: z.ZodObject<{
         key: z.ZodString;
         value: z.ZodUnknown;
     }, "strip", z.ZodTypeAny, {
-        value?: unknown;
         key: string;
-    }, {
         value?: unknown;
+    }, {
         key: string;
+        value?: unknown;
     }>;
 }, "strip", z.ZodTypeAny, {
     type: "setVariable";
     data: {
-        value?: unknown;
         key: string;
+        value?: unknown;
     };
 }, {
     type: "setVariable";
     data: {
-        value?: unknown;
         key: string;
+        value?: unknown;
     };
 }>;
 /**
  * A message sent from the iFrame to the game to change the value of the property of the layer
  */
-export declare type SetVariableEvent = z.infer<typeof isSetVariableEvent>;
+export type SetVariableEvent = z.infer<typeof isSetVariableEvent>;

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

@@ -0,0 +1,24 @@
+import { z } from "zod";
+export declare const isSettingsEvent: z.ZodObject<{
+    notification: z.ZodBoolean;
+    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 type SettingsEvent = z.infer<typeof isSettingsEvent>;

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

@@ -9,4 +9,4 @@ export declare const isShowBusinessCardEvent: z.ZodObject<{
 /**
  * A message sent from the iFrame to the game to emit a notification.
  */
-export declare type ShowBusinessCardEvent = z.infer<typeof isShowBusinessCardEvent>;
+export type ShowBusinessCardEvent = z.infer<typeof isShowBusinessCardEvent>;

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

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

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

@@ -0,0 +1,12 @@
+import { z } from "zod";
+export declare const isTeleportPlayerToEventConfig: z.ZodObject<{
+    x: z.ZodNumber;
+    y: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    x: number;
+    y: number;
+}, {
+    x: number;
+    y: number;
+}>;
+export type TeleportPlayerToEvent = z.infer<typeof isTeleportPlayerToEventConfig>;

package/play/src/front/Api/Events/Ui/BannerEvent.d.ts

@@ -0,0 +1,42 @@
+import { z } from "zod";
+export declare const isBannerEvent: z.ZodObject<{
+    id: z.ZodString;
+    text: z.ZodString;
+    bgColor: z.ZodOptional<z.ZodString>;
+    textColor: z.ZodOptional<z.ZodString>;
+    closable: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+    timeToClose: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+    link: z.ZodOptional<z.ZodObject<{
+        url: z.ZodString;
+        label: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        url: string;
+        label: string;
+    }, {
+        url: string;
+        label: string;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    text: string;
+    id: string;
+    link?: {
+        url: string;
+        label: string;
+    } | undefined;
+    closable?: boolean | undefined;
+    bgColor?: string | undefined;
+    textColor?: string | undefined;
+    timeToClose?: number | undefined;
+}, {
+    text: string;
+    id: string;
+    link?: {
+        url: string;
+        label: string;
+    } | undefined;
+    closable?: boolean | undefined;
+    bgColor?: string | undefined;
+    textColor?: string | undefined;
+    timeToClose?: number | undefined;
+}>;
+export type BannerEvent = z.infer<typeof isBannerEvent>;

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

@@ -0,0 +1,38 @@
+import { z } from "zod";
+export declare const isAddActionBarButtonEvent: z.ZodObject<{
+    id: z.ZodString;
+    label: z.ZodOptional<z.ZodString>;
+    toolTip: z.ZodOptional<z.ZodString>;
+    bgColor: z.ZodOptional<z.ZodString>;
+    textColor: z.ZodOptional<z.ZodString>;
+    imageSrc: z.ZodOptional<z.ZodString>;
+    isGradient: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    isGradient: boolean;
+    label?: string | undefined;
+    toolTip?: string | undefined;
+    bgColor?: string | undefined;
+    textColor?: string | undefined;
+    imageSrc?: string | undefined;
+}, {
+    id: string;
+    label?: string | undefined;
+    toolTip?: string | undefined;
+    bgColor?: string | undefined;
+    textColor?: string | undefined;
+    imageSrc?: string | undefined;
+    isGradient?: boolean | undefined;
+}>;
+export type AddButtonActionBarEvent = z.infer<typeof isAddActionBarButtonEvent>;
+export type AddActionButtonActionBarEvent = AddButtonActionBarEvent;
+export type AddClassicButtonActionBarEvent = AddButtonActionBarEvent;
+export type AddActionsButtonActionBarEventCallback = (event: AddButtonActionBarEvent) => void;
+export declare const isRemoveButtonActionBarEvent: z.ZodObject<{
+    id: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+}, {
+    id: string;
+}>;
+export type RemoveButtonActionBarEvent = z.infer<typeof isRemoveButtonActionBarEvent>;

package/{Api/Events/Ui/MenuRegisterEvent.d.ts → play/src/front/Api/Events/Ui/MenuEvents.d.ts}

@@ -3,19 +3,22 @@ import { z } from "zod";
  * A message sent from a script to the game to remove a custom menu from the menu
  */
 export declare const isUnregisterMenuEvent: z.ZodObject<{
-    name: z.ZodString;
+    key: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    name: string;
+    key: string;
 }, {
-    name: string;
+    key: string;
 }>;
-export declare type UnregisterMenuEvent = z.infer<typeof isUnregisterMenuEvent>;
+export type UnregisterMenuEvent = z.infer<typeof isUnregisterMenuEvent>;
 export declare const isMenuRegisterOptions: z.ZodObject<{
     allowApi: z.ZodBoolean;
+    allow: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     allowApi: boolean;
+    allow?: string | undefined;
 }, {
     allowApi: boolean;
+    allow?: string | undefined;
 }>;
 /**
  * A message sent from a script to the game to add a custom menu from the menu
@@ -23,24 +26,43 @@ export declare const isMenuRegisterOptions: z.ZodObject<{
 export declare const isMenuRegisterEvent: z.ZodObject<{
     name: z.ZodString;
     iframe: z.ZodOptional<z.ZodString>;
+    key: z.ZodString;
     options: z.ZodObject<{
         allowApi: z.ZodBoolean;
+        allow: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         allowApi: boolean;
+        allow?: string | undefined;
     }, {
         allowApi: boolean;
+        allow?: string | undefined;
     }>;
 }, "strip", z.ZodTypeAny, {
-    iframe?: string | undefined;
     options: {
         allowApi: boolean;
+        allow?: string | undefined;
     };
     name: string;
-}, {
+    key: string;
     iframe?: string | undefined;
+}, {
     options: {
         allowApi: boolean;
+        allow?: string | undefined;
     };
     name: string;
+    key: string;
+    iframe?: string | undefined;
+}>;
+export type MenuRegisterEvent = z.infer<typeof isMenuRegisterEvent>;
+/**
+ * A message sent from a script to the game to open a menu
+ */
+export declare const isOpenMenuEvent: z.ZodObject<{
+    key: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    key: string;
+}, {
+    key: string;
 }>;
-export declare type MenuRegisterEvent = z.infer<typeof isMenuRegisterEvent>;
+export type OpenMenuEvent = z.infer<typeof isOpenMenuEvent>;

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

@@ -9,4 +9,4 @@ export declare const isMenuItemClickedEvent: z.ZodObject<{
 /**
  * A message sent from the game to the iFrame when a menu item is clicked.
  */
-export declare type MenuItemClickedEvent = z.infer<typeof isMenuItemClickedEvent>;
+export type MenuItemClickedEvent = z.infer<typeof isMenuItemClickedEvent>;

package/play/src/front/Api/Events/Ui/PlayVideoEvent.d.ts

@@ -0,0 +1,67 @@
+import { z } from "zod";
+export declare const isVideoConfig: z.ZodObject<{
+    /**
+     * Whether the video should loop.
+     */
+    loop: z.ZodOptional<z.ZodBoolean>;
+    /**
+     * The name displayed at the bottom left of the video.
+     */
+    name: z.ZodOptional<z.ZodString>;
+    /**
+     * A link to the avatar of the speaker, displayed at the bottom left of the video.
+     */
+    avatar: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    name?: string | undefined;
+    loop?: boolean | undefined;
+    avatar?: string | undefined;
+}, {
+    name?: string | undefined;
+    loop?: boolean | undefined;
+    avatar?: string | undefined;
+}>;
+export declare const isPlayVideoEvent: z.ZodObject<{
+    url: z.ZodString;
+    config: z.ZodOptional<z.ZodObject<{
+        /**
+         * Whether the video should loop.
+         */
+        loop: z.ZodOptional<z.ZodBoolean>;
+        /**
+         * The name displayed at the bottom left of the video.
+         */
+        name: z.ZodOptional<z.ZodString>;
+        /**
+         * A link to the avatar of the speaker, displayed at the bottom left of the video.
+         */
+        avatar: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        name?: string | undefined;
+        loop?: boolean | undefined;
+        avatar?: string | undefined;
+    }, {
+        name?: string | undefined;
+        loop?: boolean | undefined;
+        avatar?: string | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    url: string;
+    config?: {
+        name?: string | undefined;
+        loop?: boolean | undefined;
+        avatar?: string | undefined;
+    } | undefined;
+}, {
+    url: string;
+    config?: {
+        name?: string | undefined;
+        loop?: boolean | undefined;
+        avatar?: string | undefined;
+    } | undefined;
+}>;
+/**
+ * A message sent from the iFrame to the game to add a message in the chat.
+ */
+export type PlayVideoEvent = z.infer<typeof isPlayVideoEvent>;
+export type VideoConfig = z.infer<typeof isVideoConfig>;

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

@@ -2,7 +2,7 @@ import { z } from "zod";
 export declare const triggerActionMessage = "triggerActionMessage";
 export declare const removeActionMessage = "removeActionMessage";
 export declare const isActionMessageType: z.ZodEnum<["message", "warning"]>;
-export declare type ActionMessageType = z.infer<typeof isActionMessageType>;
+export type ActionMessageType = z.infer<typeof isActionMessageType>;
 export declare const isTriggerActionMessageEvent: z.ZodObject<{
     message: z.ZodString;
     uuid: z.ZodString;
@@ -16,7 +16,7 @@ export declare const isTriggerActionMessageEvent: z.ZodObject<{
     type: "message" | "warning";
     uuid: string;
 }>;
-export declare type TriggerActionMessageEvent = z.infer<typeof isTriggerActionMessageEvent>;
+export type TriggerActionMessageEvent = z.infer<typeof isTriggerActionMessageEvent>;
 export declare const isMessageReferenceEvent: z.ZodObject<{
     uuid: z.ZodString;
 }, "strip", z.ZodTypeAny, {
@@ -24,4 +24,4 @@ export declare const isMessageReferenceEvent: z.ZodObject<{
 }, {
     uuid: string;
 }>;
-export declare type MessageReferenceEvent = z.infer<typeof isMessageReferenceEvent>;
+export type MessageReferenceEvent = z.infer<typeof isMessageReferenceEvent>;

package/play/src/front/Api/Events/Ui/TriggerPlayerMessageEvent.d.ts

@@ -0,0 +1,27 @@
+import { z } from "zod";
+export declare const triggerPlayerMessage = "triggerPlayerMessage";
+export declare const removePlayerMessage = "removePlayerMessage";
+export declare const isPlayerMessageType: z.ZodEnum<["message"]>;
+export type PlayerMessageType = z.infer<typeof isPlayerMessageType>;
+export declare const isTriggerPlayerMessageEvent: z.ZodObject<{
+    message: z.ZodString;
+    uuid: z.ZodString;
+    type: z.ZodEnum<["message"]>;
+}, "strip", z.ZodTypeAny, {
+    message: string;
+    type: "message";
+    uuid: string;
+}, {
+    message: string;
+    type: "message";
+    uuid: string;
+}>;
+export type TriggerPlayerMessageEvent = z.infer<typeof isTriggerPlayerMessageEvent>;
+export declare const isMessageReferenceEvent: z.ZodObject<{
+    uuid: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    uuid: string;
+}, {
+    uuid: string;
+}>;
+export type MessageReferenceEvent = z.infer<typeof isMessageReferenceEvent>;