@workadventure/iframe-api-typings 1.20.2 → 1.21.0

package/libs/shared-utils/src/Events/ChatEvent.d.ts

@@ -3,11 +3,11 @@ 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";
+    author?: string | undefined;
 }>;
 export declare const isSendBubbleChatMessageOptions: z.ZodObject<{
     scope: z.ZodLiteral<"bubble">;
@@ -20,11 +20,11 @@ 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";
+    author?: string | undefined;
 }>, z.ZodObject<{
     scope: z.ZodLiteral<"bubble">;
 }, "strip", z.ZodTypeAny, {
@@ -38,11 +38,11 @@ export declare const isChatEvent: z.ZodObject<{
         scope: z.ZodLiteral<"local">;
         author: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
-        author?: string | undefined;
         scope: "local";
-    }, {
         author?: string | undefined;
+    }, {
         scope: "local";
+        author?: string | undefined;
     }>, z.ZodObject<{
         scope: z.ZodLiteral<"bubble">;
     }, "strip", z.ZodTypeAny, {
@@ -53,16 +53,16 @@ export declare const isChatEvent: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     message: string;
     options: {
-        author?: string | undefined;
         scope: "local";
+        author?: string | undefined;
     } | {
         scope: "bubble";
     };
 }, {
     message: string;
     options: {
-        author?: string | undefined;
         scope: "local";
+        author?: string | undefined;
     } | {
         scope: "bubble";
     };
@@ -75,19 +75,19 @@ export declare const isAuthor: z.ZodObject<{
     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;
+    color?: string | undefined;
 }>;
 export declare enum ChatMessageTypes {
     text = 1,
@@ -99,6 +99,7 @@ export declare enum ChatMessageTypes {
 }
 export declare const isChatMessageTypes: z.ZodNativeEnum<typeof ChatMessageTypes>;
 export declare const isChatMessage: z.ZodObject<{
+    id: z.ZodOptional<z.ZodString>;
     type: z.ZodNativeEnum<typeof ChatMessageTypes>;
     date: z.ZodDate;
     author: z.ZodOptional<z.ZodNullable<z.ZodObject<{
@@ -109,51 +110,53 @@ export declare const isChatMessage: z.ZodObject<{
         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;
+        color?: string | undefined;
     }>>>;
     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, {
+    type: ChatMessageTypes;
+    date: Date;
     author?: {
-        color?: string | undefined;
         name: string;
         active: boolean;
         isMe: boolean;
         jid: string;
         isMember: boolean;
+        color?: string | undefined;
     } | null | undefined;
     text?: string[] | null | undefined;
     name?: string | null | undefined;
+    id?: string | undefined;
     targets?: (string | null)[] | null | undefined;
+}, {
     type: ChatMessageTypes;
     date: Date;
-}, {
     author?: {
-        color?: string | undefined;
         name: string;
         active: boolean;
         isMe: boolean;
         jid: string;
         isMember: boolean;
+        color?: string | undefined;
     } | null | undefined;
     text?: string[] | null | undefined;
     name?: string | null | undefined;
+    id?: string | undefined;
     targets?: (string | null)[] | null | undefined;
-    type: ChatMessageTypes;
-    date: Date;
 }>;
 export type ChatMessage = z.infer<typeof isChatMessage>;
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@workadventure/iframe-api-typings",
-  "version": "v1.20.2",
+  "version": "v1.21.0",
   "description": "Typescript typings for WorkAdventure iFrame API",
   "main": "iframe_api.js",
   "types": "iframe_api.d.ts",
@@ -12,6 +12,6 @@
   },
   "dependencies": {
     "rxjs": "^6.6.3",
-    "zod": "^3.14.3"
+    "zod": "^3.23.8"
   }
 }

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

@@ -16,33 +16,34 @@ export declare const isAddPlayerEvent: 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;
 }>;
 export declare const isRemotePlayerChangedEvent: z.ZodObject<{
     name: z.ZodOptional<z.ZodString>;
-    outlineColor: z.ZodOptional<z.ZodOptional<z.ZodNumber>>;
-    availabilityStatus: z.ZodOptional<z.ZodString>;
     position: z.ZodOptional<z.ZodObject<{
         x: z.ZodNumber;
         y: z.ZodNumber;
@@ -53,28 +54,33 @@ export declare const isRemotePlayerChangedEvent: z.ZodObject<{
         x: number;
         y: number;
     }>>;
-    variables: z.ZodOptional<z.ZodMap<z.ZodString, z.ZodUnknown>>;
     playerId: z.ZodNumber;
+    variables: z.ZodOptional<z.ZodMap<z.ZodString, z.ZodUnknown>>;
+    availabilityStatus: z.ZodOptional<z.ZodString>;
+    outlineColor: z.ZodOptional<z.ZodOptional<z.ZodNumber>>;
+    chatID: z.ZodNullable<z.ZodOptional<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
+    playerId: number;
     name?: string | undefined;
-    outlineColor?: number | undefined;
-    availabilityStatus?: string | undefined;
     position?: {
         x: number;
         y: number;
     } | undefined;
     variables?: Map<string, unknown> | undefined;
-    playerId: number;
+    availabilityStatus?: string | undefined;
+    outlineColor?: number | undefined;
+    chatID?: string | null | undefined;
 }, {
+    playerId: number;
     name?: string | undefined;
-    outlineColor?: number | undefined;
-    availabilityStatus?: string | undefined;
     position?: {
         x: number;
         y: number;
     } | undefined;
     variables?: Map<string, unknown> | undefined;
-    playerId: number;
+    availabilityStatus?: string | undefined;
+    outlineColor?: number | undefined;
+    chatID?: string | null | undefined;
 }>;
 /**
  * A message sent from the game to the iFrame to notify a new player arrived in our viewport

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

@@ -3,11 +3,11 @@ export declare const isAskPositionEvent: z.ZodObject<{
     uuid: z.ZodString;
     playUri: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    playUri: string;
     uuid: string;
-}, {
     playUri: string;
+}, {
     uuid: string;
+    playUri: string;
 }>;
 /**
  * A message sent from the iFrame to the game to ask the position of the user with uuid and walk to him.

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

@@ -3,11 +3,11 @@ export declare const isCameraFollowPlayerEvent: z.ZodObject<{
     smooth: z.ZodBoolean;
     duration: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
-    duration?: number | undefined;
     smooth: boolean;
-}, {
     duration?: number | undefined;
+}, {
     smooth: boolean;
+    duration?: number | undefined;
 }>;
 /**
  * A message sent from the iFrame to the game to make the camera follow player.

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

@@ -8,21 +8,21 @@ export declare const isCameraSetEvent: z.ZodObject<{
     smooth: z.ZodBoolean;
     duration: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
-    height?: number | undefined;
-    width?: number | undefined;
-    duration?: number | undefined;
     x: number;
     y: number;
     lock: boolean;
     smooth: boolean;
-}, {
     height?: number | undefined;
     width?: number | undefined;
     duration?: number | undefined;
+}, {
     x: number;
     y: number;
     lock: boolean;
     smooth: boolean;
+    height?: number | undefined;
+    width?: number | undefined;
+    duration?: number | undefined;
 }>;
 /**
  * A message sent from the iFrame to the game to change the camera position.

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

@@ -6,17 +6,17 @@ export declare const isDynamicAreaEvent: z.ZodObject<{
     width: z.ZodOptional<z.ZodNumber>;
     height: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
+    name: string;
     height?: number | undefined;
     width?: number | undefined;
     x?: number | undefined;
     y?: number | undefined;
-    name: string;
 }, {
+    name: string;
     height?: number | undefined;
     width?: number | undefined;
     x?: number | undefined;
     y?: number | undefined;
-    name: string;
 }>;
 /**
  * A message sent from the iFrame to the game to modify an embedded website
@@ -31,14 +31,14 @@ export declare const isCreateDynamicAreaEvent: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     height: number;
     width: number;
+    name: string;
     x: number;
     y: number;
-    name: string;
 }, {
     height: number;
     width: number;
+    name: string;
     x: number;
     y: number;
-    name: string;
 }>;
 export type CreateDynamicAreaEvent = z.infer<typeof isCreateDynamicAreaEvent>;

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

@@ -29,29 +29,29 @@ export declare const isEmbeddedWebsiteEvent: z.ZodObject<{
     origin: z.ZodOptional<z.ZodEnum<["player", "map"]>>;
     scale: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
+    name: string;
     url?: string | undefined;
     height?: number | undefined;
     width?: number | undefined;
+    allowApi?: boolean | undefined;
     x?: number | undefined;
     y?: number | undefined;
-    allowApi?: boolean | undefined;
     visible?: boolean | undefined;
     allow?: string | undefined;
     origin?: "map" | "player" | undefined;
     scale?: number | undefined;
-    name: string;
 }, {
+    name: string;
     url?: string | undefined;
     height?: number | undefined;
     width?: number | undefined;
+    allowApi?: boolean | undefined;
     x?: number | undefined;
     y?: number | undefined;
-    allowApi?: boolean | undefined;
     visible?: boolean | undefined;
     allow?: string | undefined;
     origin?: "map" | "player" | undefined;
     scale?: number | undefined;
-    name: string;
 }>;
 /**
  * A message sent from the iFrame to the game to modify an embedded website
@@ -82,11 +82,6 @@ export declare const isCreateEmbeddedWebsiteEvent: z.ZodObject<{
     origin: z.ZodOptional<z.ZodEnum<["player", "map"]>>;
     scale: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
-    allowApi?: boolean | undefined;
-    visible?: boolean | undefined;
-    allow?: string | undefined;
-    origin?: "map" | "player" | undefined;
-    scale?: number | undefined;
     url: string;
     name: string;
     position: {
@@ -95,12 +90,12 @@ export declare const isCreateEmbeddedWebsiteEvent: z.ZodObject<{
         x: number;
         y: number;
     };
-}, {
     allowApi?: boolean | undefined;
     visible?: boolean | undefined;
     allow?: string | undefined;
     origin?: "map" | "player" | undefined;
     scale?: number | undefined;
+}, {
     url: string;
     name: string;
     position: {
@@ -109,5 +104,10 @@ export declare const isCreateEmbeddedWebsiteEvent: z.ZodObject<{
         x: number;
         y: number;
     };
+    allowApi?: boolean | undefined;
+    visible?: boolean | undefined;
+    allow?: string | undefined;
+    origin?: "map" | "player" | undefined;
+    scale?: number | undefined;
 }>;
 export type CreateEmbeddedWebsiteEvent = z.infer<typeof isCreateEmbeddedWebsiteEvent>;

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

@@ -16,37 +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;
+    roomId: string;
+    hashParameters: Record<string, string>;
+    mapUrl: string;
+    nickname: string;
+    tags: string[];
+    isLogged: boolean;
     uuid?: string | undefined;
-    variables?: unknown;
-    userRoomToken?: string | undefined;
     language?: string | undefined;
     playerId?: number | 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>;
+    mapUrl: string;
     nickname: string;
-}, {
-    metadata?: unknown;
+    tags: string[];
     uuid?: string | undefined;
-    variables?: unknown;
-    userRoomToken?: string | undefined;
-    isLogged?: boolean | undefined;
     language?: string | undefined;
     playerId?: number | undefined;
     startLayerName?: string | undefined;
+    variables?: unknown;
     playerVariables?: unknown;
+    userRoomToken?: string | undefined;
+    metadata?: unknown;
     iframeId?: string | undefined;
-    tags: string[];
-    roomId: string;
-    mapUrl: string;
-    hashParameters: Record<string, string>;
-    nickname: string;
+    isLogged?: boolean | undefined;
 }>;
 /**
  * A message sent from the game to the iFrame when the gameState is received by the script

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

@@ -7,19 +7,19 @@ export declare const isHasPlayerMovedEvent: z.ZodObject<{
     oldX: z.ZodOptional<z.ZodNumber>;
     oldY: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
-    oldX?: number | undefined;
-    oldY?: number | undefined;
     x: number;
     y: number;
     direction: "left" | "right" | "up" | "down";
     moving: boolean;
-}, {
     oldX?: number | undefined;
     oldY?: number | undefined;
+}, {
     x: number;
     y: number;
     direction: "left" | "right" | "up" | "down";
     moving: boolean;
+    oldX?: number | undefined;
+    oldY?: number | undefined;
 }>;
 /**
  * A message sent from the game to the iFrame to notify a movement from the current player.