@workadventure/iframe-api-typings 1.11.4 → 1.12.1

package/Api/Events/AddPlayerEvent.d.ts

@@ -0,0 +1,86 @@
+import { z } from "zod";
+export declare const isAddPlayerEvent: z.ZodObject<{
+    playerId: z.ZodNumber;
+    name: z.ZodString;
+    userUuid: z.ZodString;
+    availabilityStatus: z.ZodString;
+    outlineColor: z.ZodOptional<z.ZodNumber>;
+    position: z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        x: number;
+        y: number;
+    }, {
+        x: number;
+        y: number;
+    }>;
+    variables: z.ZodMap<z.ZodString, z.ZodUnknown>;
+}, "strip", z.ZodTypeAny, {
+    outlineColor?: number | undefined;
+    position: {
+        x: number;
+        y: number;
+    };
+    name: string;
+    playerId: number;
+    variables: Map<string, unknown>;
+    userUuid: string;
+    availabilityStatus: string;
+}, {
+    outlineColor?: number | undefined;
+    position: {
+        x: number;
+        y: number;
+    };
+    name: string;
+    playerId: number;
+    variables: Map<string, unknown>;
+    userUuid: string;
+    availabilityStatus: string;
+}>;
+export declare const isRemotePlayerChangedEvent: z.ZodObject<{
+    position: z.ZodOptional<z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        x: number;
+        y: number;
+    }, {
+        x: number;
+        y: number;
+    }>>;
+    name: z.ZodOptional<z.ZodString>;
+    playerId: z.ZodNumber;
+    variables: z.ZodOptional<z.ZodMap<z.ZodString, z.ZodUnknown>>;
+    availabilityStatus: z.ZodOptional<z.ZodString>;
+    outlineColor: z.ZodOptional<z.ZodOptional<z.ZodNumber>>;
+}, "strip", z.ZodTypeAny, {
+    position?: {
+        x: number;
+        y: number;
+    } | undefined;
+    name?: string | undefined;
+    variables?: Map<string, unknown> | undefined;
+    availabilityStatus?: string | undefined;
+    outlineColor?: number | undefined;
+    playerId: number;
+}, {
+    position?: {
+        x: number;
+        y: number;
+    } | undefined;
+    name?: string | undefined;
+    variables?: Map<string, unknown> | undefined;
+    availabilityStatus?: string | undefined;
+    outlineColor?: number | undefined;
+    playerId: number;
+}>;
+/**
+ * A message sent from the game to the iFrame to notify a new player arrived in our viewport
+ */
+export declare type AddPlayerEvent = z.infer<typeof isAddPlayerEvent>;
+/**
+ * A message sent from the game to the iFrame to notify a player has changed (moved / changed name, etc...)
+ */
+export declare type RemotePlayerChangedEvent = z.infer<typeof isRemotePlayerChangedEvent>;

package/Api/Events/AskPositionEvent.d.ts

@@ -0,0 +1,15 @@
+import { z } from "zod";
+export declare const isAskPositionEvent: z.ZodObject<{
+    uuid: z.ZodString;
+    playUri: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    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.
+ */
+export declare type AskPositionEvent = z.infer<typeof isAskPositionEvent>;

package/Api/Events/ChatEvent.d.ts

@@ -9,6 +9,35 @@ export declare const isChatEvent: z.ZodObject<{
     message: string;
     author: string;
 }>;
+export declare enum ChatMessageTypes {
+    text = 1,
+    me = 2,
+    userIncoming = 3,
+    userOutcoming = 4,
+    userWriting = 5,
+    userStopWriting = 6
+}
+export declare const isChatMessageTypes: z.ZodNativeEnum<typeof ChatMessageTypes>;
+export declare const isChatMessage: z.ZodObject<{
+    type: z.ZodNativeEnum<typeof ChatMessageTypes>;
+    date: z.ZodDate;
+    author: 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.ZodNullable<z.ZodString>, "many">>>;
+}, "strip", z.ZodTypeAny, {
+    author?: string | null | undefined;
+    text?: (string | null)[] | null | undefined;
+    targets?: (string | null)[] | null | undefined;
+    type: ChatMessageTypes;
+    date: Date;
+}, {
+    author?: string | null | undefined;
+    text?: (string | null)[] | null | undefined;
+    targets?: (string | null)[] | null | undefined;
+    type: ChatMessageTypes;
+    date: Date;
+}>;
+export declare type ChatMessage = z.infer<typeof isChatMessage>;
 /**
  * A message sent from the iFrame to the game to add a message in the chat.
  */

package/Api/Events/ChatVisibilityEvent.d.ts

@@ -0,0 +1,9 @@
+import { z } from "zod";
+export declare const isChatVisibilityEvent: z.ZodObject<{
+    visibility: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    visibility: boolean;
+}, {
+    visibility: boolean;
+}>;
+export declare type ChatVisibilityEvent = z.infer<typeof isChatVisibilityEvent>;

package/Api/Events/EnablePlayersTrackingEvent.d.ts

@@ -0,0 +1,15 @@
+import { z } from "zod";
+export declare const isEnablePlayersTrackingEvent: z.ZodObject<{
+    players: z.ZodBoolean;
+    movement: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    players: boolean;
+    movement: boolean;
+}, {
+    players: boolean;
+    movement: boolean;
+}>;
+/**
+ * A message sent from the game to the iFrame to notify the game that the iframe is interested in tracking users.
+ */
+export declare type EnablePlayersTrackingEvent = z.infer<typeof isEnablePlayersTrackingEvent>;

package/Api/Events/GameStateEvent.d.ts

@@ -4,30 +4,36 @@ export declare const isGameStateEvent: z.ZodObject<{
     mapUrl: z.ZodString;
     nickname: z.ZodString;
     language: z.ZodOptional<z.ZodString>;
+    playerId: z.ZodOptional<z.ZodNumber>;
     uuid: z.ZodOptional<z.ZodString>;
     startLayerName: z.ZodOptional<z.ZodString>;
     tags: z.ZodArray<z.ZodString, "many">;
     variables: z.ZodUnknown;
     playerVariables: z.ZodUnknown;
     userRoomToken: z.ZodOptional<z.ZodString>;
+    metadata: z.ZodOptional<z.ZodUnknown>;
 }, "strip", z.ZodTypeAny, {
     language?: string | undefined;
+    playerId?: number | undefined;
     uuid?: string | undefined;
     startLayerName?: string | undefined;
     variables?: unknown;
     playerVariables?: unknown;
     userRoomToken?: string | undefined;
+    metadata?: unknown;
     roomId: string;
     mapUrl: string;
     nickname: string;
     tags: string[];
 }, {
     language?: string | undefined;
+    playerId?: number | undefined;
     uuid?: string | undefined;
     startLayerName?: string | undefined;
     variables?: unknown;
     playerVariables?: unknown;
     userRoomToken?: string | undefined;
+    metadata?: unknown;
     roomId: string;
     mapUrl: string;
     nickname: string;