@workadventure/iframe-api-typings 1.16.11 → 1.17.1

package/front/Api/Events/JoinMucEvent.d.ts

@@ -5,14 +5,14 @@ export declare const isJoinMucEvent: z.ZodObject<{
     type: z.ZodString;
     subscribe: z.ZodBoolean;
 }, "strip", z.ZodTypeAny, {
+    url: string;
     type: string;
     name: string;
-    url: string;
     subscribe: boolean;
 }, {
+    url: string;
     type: string;
     name: string;
-    url: string;
     subscribe: boolean;
 }>;
 /**

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

@@ -6,16 +6,16 @@ export declare const isModalEvent: z.ZodObject<{
     position: z.ZodDefault<z.ZodOptional<z.ZodEnum<["right", "left", "center"]>>>;
     allowApi: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
 }, "strip", z.ZodTypeAny, {
+    title: string;
     allowApi: boolean;
     position: "left" | "right" | "center";
     allow: string | null;
     src: string;
-    title: string;
 }, {
+    title?: string | undefined;
     allowApi?: boolean | undefined;
     position?: "left" | "right" | "center" | undefined;
     allow?: string | null | undefined;
-    title?: string | undefined;
     src: string;
 }>;
 /**

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

@@ -17,25 +17,25 @@ export declare const isBannerEvent: z.ZodObject<{
         label: string;
     }>>;
 }, "strip", z.ZodTypeAny, {
-    bgColor?: string | undefined;
-    textColor?: string | undefined;
     link?: {
         url: string;
         label: string;
     } | undefined;
+    bgColor?: string | undefined;
+    textColor?: string | undefined;
     text: string;
     closable: boolean;
     id: string;
     timeToClose: number;
 }, {
-    closable?: boolean | undefined;
-    bgColor?: string | undefined;
-    textColor?: string | undefined;
-    timeToClose?: number | undefined;
     link?: {
         url: string;
         label: string;
     } | undefined;
+    closable?: boolean | undefined;
+    bgColor?: string | undefined;
+    textColor?: string | undefined;
+    timeToClose?: number | undefined;
     text: string;
     id: string;
 }>;

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

@@ -5,12 +5,12 @@ export declare const isAddClassicButtonActionBarEvent: z.ZodObject<{
     type: z.ZodDefault<z.ZodOptional<z.ZodEnum<["button"]>>>;
 }, "strip", z.ZodTypeAny, {
     type: "button";
-    id: string;
     label: string;
+    id: string;
 }, {
     type?: "button" | undefined;
-    id: string;
     label: string;
+    id: string;
 }>;
 export declare const isAddActionButtonActionBarEvent: z.ZodObject<{
     id: z.ZodString;
@@ -34,12 +34,12 @@ export declare const isAddButtonActionBarEvent: z.ZodUnion<[z.ZodObject<{
     type: z.ZodDefault<z.ZodOptional<z.ZodEnum<["button"]>>>;
 }, "strip", z.ZodTypeAny, {
     type: "button";
-    id: string;
     label: string;
+    id: string;
 }, {
     type?: "button" | undefined;
-    id: string;
     label: string;
+    id: string;
 }>, z.ZodObject<{
     id: z.ZodString;
     type: z.ZodEnum<["action"]>;

package/front/Api/Events/Ui/UIWebsiteEvent.d.ts

@@ -7,14 +7,14 @@ export declare const isUIWebsiteMargin: z.ZodObject<{
     left: z.ZodOptional<z.ZodString>;
     right: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
+    left?: string | undefined;
     top?: string | undefined;
     bottom?: string | undefined;
-    left?: string | undefined;
     right?: string | undefined;
 }, {
+    left?: string | undefined;
     top?: string | undefined;
     bottom?: string | undefined;
-    left?: string | undefined;
     right?: string | undefined;
 }>;
 export type UIWebsiteMargin = z.infer<typeof isUIWebsiteMargin>;
@@ -37,11 +37,11 @@ export declare const isUIWebsiteSize: z.ZodObject<{
     height: z.ZodString;
     width: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    width: string;
     height: string;
-}, {
     width: string;
+}, {
     height: string;
+    width: string;
 }>;
 export type UIWebsiteSize = z.infer<typeof isUIWebsiteSize>;
 export declare const isCreateUIWebsiteEvent: z.ZodObject<{
@@ -63,11 +63,11 @@ export declare const isCreateUIWebsiteEvent: z.ZodObject<{
         height: z.ZodString;
         width: z.ZodString;
     }, "strip", z.ZodTypeAny, {
-        width: string;
         height: string;
-    }, {
         width: string;
+    }, {
         height: string;
+        width: string;
     }>;
     margin: z.ZodOptional<z.ZodObject<{
         top: z.ZodOptional<z.ZodOptional<z.ZodString>>;
@@ -75,14 +75,14 @@ export declare const isCreateUIWebsiteEvent: z.ZodObject<{
         left: z.ZodOptional<z.ZodOptional<z.ZodString>>;
         right: z.ZodOptional<z.ZodOptional<z.ZodString>>;
     }, "strip", z.ZodTypeAny, {
+        left?: string | undefined;
         top?: string | undefined;
         bottom?: string | undefined;
-        left?: string | undefined;
         right?: string | undefined;
     }, {
+        left?: string | undefined;
         top?: string | undefined;
         bottom?: string | undefined;
-        left?: string | undefined;
         right?: string | undefined;
     }>>;
 }, "strip", z.ZodTypeAny, {
@@ -90,9 +90,9 @@ export declare const isCreateUIWebsiteEvent: z.ZodObject<{
     allowPolicy?: string | undefined;
     visible?: boolean | undefined;
     margin?: {
+        left?: string | undefined;
         top?: string | undefined;
         bottom?: string | undefined;
-        left?: string | undefined;
         right?: string | undefined;
     } | undefined;
     url: string;
@@ -101,17 +101,17 @@ export declare const isCreateUIWebsiteEvent: z.ZodObject<{
         horizontal: "left" | "right" | "middle";
     };
     size: {
-        width: string;
         height: string;
+        width: string;
     };
 }, {
     allowApi?: boolean | undefined;
     allowPolicy?: string | undefined;
     visible?: boolean | undefined;
     margin?: {
+        left?: string | undefined;
         top?: string | undefined;
         bottom?: string | undefined;
-        left?: string | undefined;
         right?: string | undefined;
     } | undefined;
     url: string;
@@ -120,8 +120,8 @@ export declare const isCreateUIWebsiteEvent: z.ZodObject<{
         horizontal: "left" | "right" | "middle";
     };
     size: {
-        width: string;
         height: string;
+        width: string;
     };
 }>;
 export type CreateUIWebsiteEvent = z.infer<typeof isCreateUIWebsiteEvent>;
@@ -143,11 +143,11 @@ export declare const isModifyUIWebsiteEvent: z.ZodObject<{
         height: z.ZodString;
         width: z.ZodString;
     }, "strip", z.ZodTypeAny, {
-        width: string;
         height: string;
-    }, {
         width: string;
+    }, {
         height: string;
+        width: string;
     }>>;
     margin: z.ZodOptional<z.ZodObject<{
         top: z.ZodOptional<z.ZodOptional<z.ZodString>>;
@@ -155,14 +155,14 @@ export declare const isModifyUIWebsiteEvent: z.ZodObject<{
         left: z.ZodOptional<z.ZodOptional<z.ZodString>>;
         right: z.ZodOptional<z.ZodOptional<z.ZodString>>;
     }, "strip", z.ZodTypeAny, {
+        left?: string | undefined;
         top?: string | undefined;
         bottom?: string | undefined;
-        left?: string | undefined;
         right?: string | undefined;
     }, {
+        left?: string | undefined;
         top?: string | undefined;
         bottom?: string | undefined;
-        left?: string | undefined;
         right?: string | undefined;
     }>>;
 }, "strip", z.ZodTypeAny, {
@@ -173,13 +173,13 @@ export declare const isModifyUIWebsiteEvent: z.ZodObject<{
     } | undefined;
     visible?: boolean | undefined;
     size?: {
-        width: string;
         height: string;
+        width: string;
     } | undefined;
     margin?: {
+        left?: string | undefined;
         top?: string | undefined;
         bottom?: string | undefined;
-        left?: string | undefined;
         right?: string | undefined;
     } | undefined;
     id: string;
@@ -191,13 +191,13 @@ export declare const isModifyUIWebsiteEvent: z.ZodObject<{
     } | undefined;
     visible?: boolean | undefined;
     size?: {
-        width: string;
         height: string;
+        width: string;
     } | undefined;
     margin?: {
+        left?: string | undefined;
         top?: string | undefined;
         bottom?: string | undefined;
-        left?: string | undefined;
         right?: string | undefined;
     } | undefined;
     id: string;
@@ -223,11 +223,11 @@ export declare const isUIWebsiteEvent: z.ZodObject<{
         height: z.ZodString;
         width: z.ZodString;
     }, "strip", z.ZodTypeAny, {
-        width: string;
         height: string;
-    }, {
         width: string;
+    }, {
         height: string;
+        width: string;
     }>;
     margin: z.ZodOptional<z.ZodObject<{
         top: z.ZodOptional<z.ZodOptional<z.ZodString>>;
@@ -235,21 +235,21 @@ export declare const isUIWebsiteEvent: z.ZodObject<{
         left: z.ZodOptional<z.ZodOptional<z.ZodString>>;
         right: z.ZodOptional<z.ZodOptional<z.ZodString>>;
     }, "strip", z.ZodTypeAny, {
+        left?: string | undefined;
         top?: string | undefined;
         bottom?: string | undefined;
-        left?: string | undefined;
         right?: string | undefined;
     }, {
+        left?: string | undefined;
         top?: string | undefined;
         bottom?: string | undefined;
-        left?: string | undefined;
         right?: string | undefined;
     }>>;
 }, "strip", z.ZodTypeAny, {
     margin?: {
+        left?: string | undefined;
         top?: string | undefined;
         bottom?: string | undefined;
-        left?: string | undefined;
         right?: string | undefined;
     } | undefined;
     url: string;
@@ -262,14 +262,14 @@ export declare const isUIWebsiteEvent: z.ZodObject<{
     id: string;
     visible: boolean;
     size: {
-        width: string;
         height: string;
+        width: string;
     };
 }, {
     margin?: {
+        left?: string | undefined;
         top?: string | undefined;
         bottom?: string | undefined;
-        left?: string | undefined;
         right?: string | undefined;
     } | undefined;
     url: string;
@@ -282,8 +282,8 @@ export declare const isUIWebsiteEvent: z.ZodObject<{
     id: string;
     visible: boolean;
     size: {
-        width: string;
         height: string;
+        width: string;
     };
 }>;
 export type UIWebsiteEvent = z.infer<typeof isUIWebsiteEvent>;

package/front/Api/Events/WasCameraUpdatedEvent.d.ts

@@ -6,16 +6,16 @@ export declare const isWasCameraUpdatedEvent: z.ZodObject<{
     height: z.ZodNumber;
     zoom: z.ZodNumber;
 }, "strip", z.ZodTypeAny, {
+    height: number;
+    width: number;
     x: number;
     y: number;
-    width: number;
-    height: number;
     zoom: number;
 }, {
+    height: number;
+    width: number;
     x: number;
     y: number;
-    width: number;
-    height: number;
     zoom: number;
 }>;
 /**

package/front/Api/Events/XmppSettingsMessageEvent.d.ts

@@ -7,24 +7,24 @@ export declare const isXmppSettingsMessageEvent: z.ZodObject<{
         type: z.ZodString;
         subscribe: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
     }, "strip", z.ZodTypeAny, {
+        url: string;
         type: string;
         name: string;
-        url: string;
         subscribe: boolean;
     }, {
         subscribe?: boolean | undefined;
+        url: string;
         type: string;
         name: string;
-        url: string;
     }>, "many">;
     jabberId: z.ZodString;
     jabberPassword: z.ZodString;
 }, "strip", z.ZodTypeAny, {
     conferenceDomain: string;
     rooms: {
+        url: string;
         type: string;
         name: string;
-        url: string;
         subscribe: boolean;
     }[];
     jabberId: string;
@@ -33,9 +33,9 @@ export declare const isXmppSettingsMessageEvent: z.ZodObject<{
     conferenceDomain: string;
     rooms: {
         subscribe?: boolean | undefined;
+        url: string;
         type: string;
         name: string;
-        url: string;
     }[];
     jabberId: string;
     jabberPassword: string;

package/front/Api/Iframe/Ui/ButtonActionBar.d.ts

@@ -25,8 +25,8 @@ export declare class WorkAdventureButtonActionBarCommands extends IframeApiContr
         type: "buttonActionBarTrigger";
         callback: (event: {
             type: "button";
-            id: string;
             label: string;
+            id: string;
         } | {
             type: "action";
             id: string;

package/front/Api/Iframe/Ui/Modal.d.ts

@@ -5,11 +5,11 @@ export declare class WorkadventureModalCommands extends IframeApiContribution<Wo
     callbacks: {
         type: "modalCloseTrigger";
         callback: (event: {
+            title: string;
             allowApi: boolean;
             position: "left" | "right" | "center";
             allow: string | null;
             src: string;
-            title: string;
         }) => void;
     }[];
     /**

package/front/Api/Iframe/camera.d.ts

@@ -5,10 +5,10 @@ export declare class WorkAdventureCameraCommands extends IframeApiContribution<W
     callbacks: {
         type: "wasCameraUpdated";
         callback: (event: {
+            height: number;
+            width: number;
             x: number;
             y: number;
-            width: number;
-            height: number;
             zoom: number;
         }) => void;
     }[];

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

@@ -89,7 +89,7 @@ export declare class WorkadventurePlayerCommands extends IframeApiContribution<W
      */
     onPlayerMove(callback: HasPlayerMovedEventCallback): void;
     /**
-     * Player will try to find shortest path to the destination point and proceed to move there.
+     * Player will try to find the shortest path to the destination point and proceed to move there.
      * {@link https://workadventu.re/map-building/api-player.md#move-player-to-position | Website documentation}
      *
      * @param {number} x Horizontal position

package/front/Api/Iframe/players.d.ts

@@ -71,7 +71,7 @@ export declare class WorkadventurePlayersCommands extends IframeApiContribution<
      *
      * ```ts
      * WA.players.onVariableChange("score").subscribe({ player, value } => {
-     *     console.log("Score for player", player.name, "has been updated to", value);
+     *     console.info("Score for player", player.name, "has been updated to", value);
      * });
      * ```
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@workadventure/iframe-api-typings",
-  "version": "v1.16.11",
+  "version": "v1.17.1",
   "description": "Typescript typings for WorkAdventure iFrame API",
   "main": "iframe_api.js",
   "types": "iframe_api.d.ts",