@workadventure/iframe-api-typings 1.20.2 → 1.21.1

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

@@ -7,16 +7,16 @@ export declare const isModalEvent: z.ZodObject<{
     allowApi: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
 }, "strip", z.ZodTypeAny, {
     title: string;
-    position: "left" | "right" | "center";
-    src: string;
     allowApi: boolean;
+    position: "left" | "right" | "center";
     allow: string | null;
+    src: string;
 }, {
+    src: string;
     title?: string | undefined;
-    position?: "left" | "right" | "center" | undefined;
     allowApi?: boolean | undefined;
+    position?: "left" | "right" | "center" | undefined;
     allow?: string | null | undefined;
-    src: string;
 }>;
 /**
  * A message sent from the iFrame to the game to emit a notification.

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

@@ -4,12 +4,12 @@ export declare const isMovePlayerToEventConfig: z.ZodObject<{
     y: z.ZodNumber;
     speed: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
-    speed?: number | undefined;
     x: number;
     y: number;
-}, {
     speed?: number | undefined;
+}, {
     x: number;
     y: number;
+    speed?: number | undefined;
 }>;
 export type MovePlayerToEvent = z.infer<typeof isMovePlayerToEventConfig>;

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

@@ -8,21 +8,21 @@ export declare const isOpenCoWebsiteEvent: z.ZodObject<{
     closable: z.ZodOptional<z.ZodBoolean>;
     lazy: z.ZodOptional<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
-    position?: number | undefined;
+    url: string;
     allowApi?: boolean | undefined;
     allowPolicy?: string | undefined;
     widthPercent?: number | undefined;
+    position?: number | undefined;
     closable?: boolean | undefined;
     lazy?: boolean | undefined;
-    url: string;
 }, {
-    position?: number | undefined;
+    url: string;
     allowApi?: boolean | undefined;
     allowPolicy?: string | undefined;
     widthPercent?: number | undefined;
+    position?: number | undefined;
     closable?: boolean | undefined;
     lazy?: boolean | undefined;
-    url: string;
 }>;
 export declare const isCoWebsite: z.ZodObject<{
     id: z.ZodString;

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

@@ -3,11 +3,11 @@ export declare const isButtonDescriptor: z.ZodObject<{
     label: z.ZodString;
     className: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
-    className?: string | undefined;
     label: string;
-}, {
     className?: string | undefined;
+}, {
     label: string;
+    className?: string | undefined;
 }>;
 export declare const isOpenPopupEvent: z.ZodObject<{
     popupId: z.ZodNumber;
@@ -17,27 +17,27 @@ export declare const isOpenPopupEvent: z.ZodObject<{
         label: z.ZodString;
         className: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
-        className?: string | undefined;
         label: string;
-    }, {
         className?: string | undefined;
+    }, {
         label: string;
+        className?: string | undefined;
     }>, "many">;
 }, "strip", z.ZodTypeAny, {
     message: string;
     popupId: number;
     targetObject: string;
     buttons: {
-        className?: string | undefined;
         label: string;
+        className?: string | undefined;
     }[];
 }, {
     message: string;
     popupId: number;
     targetObject: string;
     buttons: {
-        className?: string | undefined;
         label: string;
+        className?: string | undefined;
     }[];
 }>;
 /**

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

@@ -52,6 +52,7 @@ export declare const isPlaySoundEvent: z.ZodObject<{
         delay?: number | undefined;
     }>>;
 }, "strip", z.ZodTypeAny, {
+    url: string;
     config?: {
         volume?: number | undefined;
         loop?: boolean | undefined;
@@ -61,8 +62,8 @@ export declare const isPlaySoundEvent: z.ZodObject<{
         seek?: number | undefined;
         delay?: number | undefined;
     } | undefined;
-    url: string;
 }, {
+    url: string;
     config?: {
         volume?: number | undefined;
         loop?: boolean | undefined;
@@ -72,7 +73,6 @@ export declare const isPlaySoundEvent: z.ZodObject<{
         seek?: number | undefined;
         delay?: number | undefined;
     } | undefined;
-    url: string;
 }>;
 /**
  * A message sent from the iFrame to the game to add a message in the chat.

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

@@ -17,54 +17,59 @@ export declare const isJoinProximityMeetingEvent: 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;
-        availabilityStatus: string;
         position: {
             x: number;
             y: number;
         };
-        userUuid: string;
-        variables: Map<string, unknown>;
         playerId: number;
-    }, {
+        variables: Map<string, unknown>;
+        userUuid: string;
+        availabilityStatus: string;
         outlineColor?: number | undefined;
+        chatID?: string | null | undefined;
+    }, {
         name: string;
-        availabilityStatus: string;
         position: {
             x: number;
             y: number;
         };
-        userUuid: string;
-        variables: Map<string, unknown>;
         playerId: number;
+        variables: Map<string, unknown>;
+        userUuid: string;
+        availabilityStatus: string;
+        outlineColor?: number | undefined;
+        chatID?: string | null | undefined;
     }>, "many">;
 }, "strip", z.ZodTypeAny, {
     users: {
-        outlineColor?: number | undefined;
         name: string;
-        availabilityStatus: string;
         position: {
             x: number;
             y: number;
         };
-        userUuid: string;
-        variables: Map<string, unknown>;
         playerId: number;
+        variables: Map<string, unknown>;
+        userUuid: string;
+        availabilityStatus: string;
+        outlineColor?: number | undefined;
+        chatID?: string | null | undefined;
     }[];
 }, {
     users: {
-        outlineColor?: number | undefined;
         name: string;
-        availabilityStatus: string;
         position: {
             x: number;
             y: number;
         };
-        userUuid: string;
-        variables: Map<string, unknown>;
         playerId: number;
+        variables: Map<string, unknown>;
+        userUuid: string;
+        availabilityStatus: string;
+        outlineColor?: number | undefined;
+        chatID?: string | null | undefined;
     }[];
 }>;
 export type JoinProximityMeetingEvent = z.infer<typeof isJoinProximityMeetingEvent>;

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

@@ -17,54 +17,59 @@ export declare const isParticipantProximityMeetingEvent: 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;
-        availabilityStatus: string;
         position: {
             x: number;
             y: number;
         };
-        userUuid: string;
-        variables: Map<string, unknown>;
         playerId: number;
-    }, {
+        variables: Map<string, unknown>;
+        userUuid: string;
+        availabilityStatus: string;
         outlineColor?: number | undefined;
+        chatID?: string | null | undefined;
+    }, {
         name: string;
-        availabilityStatus: string;
         position: {
             x: number;
             y: number;
         };
-        userUuid: string;
-        variables: Map<string, unknown>;
         playerId: number;
+        variables: Map<string, unknown>;
+        userUuid: string;
+        availabilityStatus: string;
+        outlineColor?: number | undefined;
+        chatID?: string | null | undefined;
     }>;
 }, "strip", z.ZodTypeAny, {
     user: {
-        outlineColor?: number | undefined;
         name: string;
-        availabilityStatus: string;
         position: {
             x: number;
             y: number;
         };
-        userUuid: string;
-        variables: Map<string, unknown>;
         playerId: number;
+        variables: Map<string, unknown>;
+        userUuid: string;
+        availabilityStatus: string;
+        outlineColor?: number | undefined;
+        chatID?: string | null | undefined;
     };
 }, {
     user: {
-        outlineColor?: number | undefined;
         name: string;
-        availabilityStatus: string;
         position: {
             x: number;
             y: number;
         };
-        userUuid: string;
-        variables: Map<string, unknown>;
         playerId: number;
+        variables: Map<string, unknown>;
+        userUuid: string;
+        availabilityStatus: string;
+        outlineColor?: number | undefined;
+        chatID?: string | null | undefined;
     };
 }>;
 export type ParticipantProximityMeetingEvent = z.infer<typeof isParticipantProximityMeetingEvent>;

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

@@ -4,13 +4,13 @@ export declare const isReceiveEventEvent: z.ZodObject<{
     data: z.ZodUnknown;
     senderId: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
+    name: string;
     data?: unknown;
     senderId?: number | undefined;
-    name: string;
 }, {
+    name: string;
     data?: unknown;
     senderId?: number | undefined;
-    name: string;
 }>;
 export declare const isReceiveEventIframeEvent: z.ZodObject<{
     type: z.ZodLiteral<"receiveEvent">;
@@ -19,27 +19,27 @@ export declare const isReceiveEventIframeEvent: z.ZodObject<{
         data: z.ZodUnknown;
         senderId: z.ZodOptional<z.ZodNumber>;
     }, "strip", z.ZodTypeAny, {
+        name: string;
         data?: unknown;
         senderId?: number | undefined;
-        name: string;
     }, {
+        name: string;
         data?: unknown;
         senderId?: number | undefined;
-        name: string;
     }>;
 }, "strip", z.ZodTypeAny, {
     type: "receiveEvent";
     data: {
+        name: string;
         data?: unknown;
         senderId?: number | undefined;
-        name: string;
     };
 }, {
     type: "receiveEvent";
     data: {
+        name: string;
         data?: unknown;
         senderId?: number | undefined;
-        name: string;
     };
 }>;
 /**

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

@@ -4,13 +4,13 @@ export declare const isSendEventEvent: z.ZodObject<{
     data: z.ZodUnknown;
     targetUserIds: z.ZodOptional<z.ZodArray<z.ZodNumber, "many">>;
 }, "strip", z.ZodTypeAny, {
+    name: string;
     data?: unknown;
     targetUserIds?: number[] | undefined;
-    name: string;
 }, {
+    name: string;
     data?: unknown;
     targetUserIds?: number[] | undefined;
-    name: string;
 }>;
 export declare const isSendEventIframeEvent: z.ZodObject<{
     type: z.ZodLiteral<"dispatchEvent">;
@@ -19,27 +19,27 @@ export declare const isSendEventIframeEvent: z.ZodObject<{
         data: z.ZodUnknown;
         targetUserIds: z.ZodOptional<z.ZodArray<z.ZodNumber, "many">>;
     }, "strip", z.ZodTypeAny, {
+        name: string;
         data?: unknown;
         targetUserIds?: number[] | undefined;
-        name: string;
     }, {
+        name: string;
         data?: unknown;
         targetUserIds?: number[] | undefined;
-        name: string;
     }>;
 }, "strip", z.ZodTypeAny, {
     type: "dispatchEvent";
     data: {
+        name: string;
         data?: unknown;
         targetUserIds?: number[] | undefined;
-        name: string;
     };
 }, {
     type: "dispatchEvent";
     data: {
+        name: string;
         data?: unknown;
         targetUserIds?: number[] | undefined;
-        name: string;
     };
 }>;
 /**

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

@@ -4,13 +4,13 @@ export declare const isSetAreaPropertyEvent: z.ZodObject<{
     propertyName: z.ZodString;
     propertyValue: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
 }, "strip", z.ZodTypeAny, {
-    propertyValue?: string | number | boolean | undefined;
     propertyName: string;
     areaName: string;
-}, {
     propertyValue?: string | number | boolean | undefined;
+}, {
     propertyName: string;
     areaName: string;
+    propertyValue?: string | number | boolean | undefined;
 }>;
 /**
  * A message sent from the iFrame to the game to change the value of the property of the area

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

@@ -7,19 +7,19 @@ export declare const isSetPlayerVariableEvent: z.ZodObject<{
     ttl: z.ZodOptional<z.ZodNumber>;
     scope: z.ZodUnion<[z.ZodLiteral<"room">, z.ZodLiteral<"world">]>;
 }, "strip", z.ZodTypeAny, {
-    value?: unknown;
-    ttl?: number | undefined;
+    scope: "room" | "world";
     key: string;
     public: boolean;
     persist: boolean;
-    scope: "room" | "world";
-}, {
     value?: unknown;
     ttl?: number | undefined;
+}, {
+    scope: "room" | "world";
     key: string;
     public: boolean;
     persist: boolean;
-    scope: "room" | "world";
+    value?: unknown;
+    ttl?: number | undefined;
 }>;
 /**
  * A message sent from the iFrame to the game to set a variable related to the player

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

@@ -4,13 +4,13 @@ export declare const isSetPropertyEvent: z.ZodObject<{
     propertyName: z.ZodString;
     propertyValue: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
 }, "strip", z.ZodTypeAny, {
-    propertyValue?: string | number | boolean | undefined;
     layerName: string;
     propertyName: string;
-}, {
     propertyValue?: string | number | boolean | undefined;
+}, {
     layerName: string;
     propertyName: string;
+    propertyValue?: string | number | boolean | undefined;
 }>;
 /**
  * A message sent from the iFrame to the game to change the value of the property of the layer

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

@@ -4,13 +4,13 @@ export declare const isSetSharedPlayerVariableEvent: z.ZodObject<{
     value: z.ZodUnknown;
     playerId: z.ZodNumber;
 }, "strip", z.ZodTypeAny, {
-    value?: unknown;
-    key: string;
     playerId: number;
-}, {
-    value?: unknown;
     key: string;
+    value?: unknown;
+}, {
     playerId: number;
+    key: string;
+    value?: unknown;
 }>;
 /**
  * A message sent from the game to the iframe to change the value of a player variable

package/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,23 +15,23 @@ 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;
     };
 }>;
 /**

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

@@ -7,18 +7,18 @@ export declare const isSettingsEvent: z.ZodObject<{
     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;
-    notification: boolean;
-    chatSounds: boolean;
 }>;
 export type SettingsEvent = z.infer<typeof isSettingsEvent>;

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

@@ -17,6 +17,8 @@ export declare const isBannerEvent: z.ZodObject<{
         label: string;
     }>>;
 }, "strip", z.ZodTypeAny, {
+    text: string;
+    id: string;
     link?: {
         url: string;
         label: string;
@@ -25,9 +27,9 @@ export declare const isBannerEvent: z.ZodObject<{
     bgColor?: string | undefined;
     textColor?: string | undefined;
     timeToClose?: number | undefined;
+}, {
     text: string;
     id: string;
-}, {
     link?: {
         url: string;
         label: string;
@@ -36,7 +38,5 @@ export declare const isBannerEvent: z.ZodObject<{
     bgColor?: string | undefined;
     textColor?: string | undefined;
     timeToClose?: number | undefined;
-    text: string;
-    id: string;
 }>;
 export type BannerEvent = z.infer<typeof isBannerEvent>;

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

@@ -8,9 +8,9 @@ export declare const isAddClassicButtonActionBarEvent: z.ZodObject<{
     label: string;
     id: string;
 }, {
-    type?: "button" | undefined;
     label: string;
     id: string;
+    type?: "button" | undefined;
 }>;
 export declare const isAddActionButtonActionBarEvent: z.ZodObject<{
     id: z.ZodString;
@@ -37,9 +37,9 @@ export declare const isAddButtonActionBarEvent: z.ZodUnion<[z.ZodObject<{
     label: string;
     id: string;
 }, {
-    type?: "button" | undefined;
     label: string;
     id: string;
+    type?: "button" | undefined;
 }>, z.ZodObject<{
     id: z.ZodString;
     type: z.ZodEnum<["action"]>;

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

@@ -32,19 +32,19 @@ export declare const isMenuRegisterEvent: z.ZodObject<{
         allowApi: boolean;
     }>;
 }, "strip", z.ZodTypeAny, {
-    iframe?: string | undefined;
     options: {
         allowApi: boolean;
     };
-    key: string;
     name: string;
-}, {
+    key: string;
     iframe?: string | undefined;
+}, {
     options: {
         allowApi: boolean;
     };
-    key: string;
     name: string;
+    key: string;
+    iframe?: string | undefined;
 }>;
 export type MenuRegisterEvent = z.infer<typeof isMenuRegisterEvent>;
 /**