@workadventure/iframe-api-typings 1.25.6 → 1.25.8

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

@@ -1,49 +1,49 @@
 import { z } from "zod";
 export declare const isUIWebsiteCSSValue: z.ZodString;
-export declare type UIWebsiteCSSValue = z.infer<typeof isUIWebsiteCSSValue>;
+export type UIWebsiteCSSValue = z.infer<typeof isUIWebsiteCSSValue>;
 export declare const isUIWebsiteMargin: z.ZodObject<{
     top: z.ZodOptional<z.ZodString>;
     bottom: z.ZodOptional<z.ZodString>;
     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 declare type UIWebsiteMargin = z.infer<typeof isUIWebsiteMargin>;
+export type UIWebsiteMargin = z.infer<typeof isUIWebsiteMargin>;
 export declare const isViewportPositionVertical: z.ZodEnum<["top", "middle", "bottom"]>;
-export declare type ViewportPositionVertical = z.infer<typeof isViewportPositionVertical>;
+export type ViewportPositionVertical = z.infer<typeof isViewportPositionVertical>;
 export declare const isViewportPositionHorizontal: z.ZodEnum<["left", "middle", "right"]>;
-export declare type ViewportPositionHorizontal = z.infer<typeof isViewportPositionHorizontal>;
+export type ViewportPositionHorizontal = z.infer<typeof isViewportPositionHorizontal>;
 export declare const isUIWebsitePosition: z.ZodObject<{
     vertical: z.ZodEnum<["top", "middle", "bottom"]>;
     horizontal: z.ZodEnum<["left", "middle", "right"]>;
 }, "strip", z.ZodTypeAny, {
-    vertical: "top" | "middle" | "bottom";
-    horizontal: "middle" | "left" | "right";
+    vertical: "top" | "bottom" | "middle";
+    horizontal: "left" | "right" | "middle";
 }, {
-    vertical: "top" | "middle" | "bottom";
-    horizontal: "middle" | "left" | "right";
+    vertical: "top" | "bottom" | "middle";
+    horizontal: "left" | "right" | "middle";
 }>;
-export declare type UIWebsitePosition = z.infer<typeof isUIWebsitePosition>;
+export type UIWebsitePosition = z.infer<typeof isUIWebsitePosition>;
 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 declare type UIWebsiteSize = z.infer<typeof isUIWebsiteSize>;
+export type UIWebsiteSize = z.infer<typeof isUIWebsiteSize>;
 export declare const isCreateUIWebsiteEvent: z.ZodObject<{
     url: z.ZodString;
     visible: z.ZodOptional<z.ZodBoolean>;
@@ -53,78 +53,78 @@ export declare const isCreateUIWebsiteEvent: z.ZodObject<{
         vertical: z.ZodEnum<["top", "middle", "bottom"]>;
         horizontal: z.ZodEnum<["left", "middle", "right"]>;
     }, "strip", z.ZodTypeAny, {
-        vertical: "top" | "middle" | "bottom";
-        horizontal: "middle" | "left" | "right";
+        vertical: "top" | "bottom" | "middle";
+        horizontal: "left" | "right" | "middle";
     }, {
-        vertical: "top" | "middle" | "bottom";
-        horizontal: "middle" | "left" | "right";
+        vertical: "top" | "bottom" | "middle";
+        horizontal: "left" | "right" | "middle";
     }>;
     size: 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.ZodString>;
-        bottom: z.ZodOptional<z.ZodString>;
-        left: z.ZodOptional<z.ZodString>;
-        right: z.ZodOptional<z.ZodString>;
+        top: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+        bottom: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+        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, {
+    url: string;
+    position: {
+        vertical: "top" | "bottom" | "middle";
+        horizontal: "left" | "right" | "middle";
+    };
+    size: {
+        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;
     position: {
-        vertical: "top" | "middle" | "bottom";
-        horizontal: "middle" | "left" | "right";
+        vertical: "top" | "bottom" | "middle";
+        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;
-    position: {
-        vertical: "top" | "middle" | "bottom";
-        horizontal: "middle" | "left" | "right";
-    };
-    size: {
-        width: string;
-        height: string;
-    };
 }>;
-export declare type CreateUIWebsiteEvent = z.infer<typeof isCreateUIWebsiteEvent>;
+export type CreateUIWebsiteEvent = z.infer<typeof isCreateUIWebsiteEvent>;
 export declare const isModifyUIWebsiteEvent: z.ZodObject<{
     id: z.ZodString;
     url: z.ZodOptional<z.ZodString>;
@@ -133,77 +133,77 @@ export declare const isModifyUIWebsiteEvent: z.ZodObject<{
         vertical: z.ZodEnum<["top", "middle", "bottom"]>;
         horizontal: z.ZodEnum<["left", "middle", "right"]>;
     }, "strip", z.ZodTypeAny, {
-        vertical: "top" | "middle" | "bottom";
-        horizontal: "middle" | "left" | "right";
+        vertical: "top" | "bottom" | "middle";
+        horizontal: "left" | "right" | "middle";
     }, {
-        vertical: "top" | "middle" | "bottom";
-        horizontal: "middle" | "left" | "right";
+        vertical: "top" | "bottom" | "middle";
+        horizontal: "left" | "right" | "middle";
     }>>;
     size: z.ZodOptional<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.ZodString>;
-        bottom: z.ZodOptional<z.ZodString>;
-        left: z.ZodOptional<z.ZodString>;
-        right: z.ZodOptional<z.ZodString>;
+        top: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+        bottom: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+        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, {
+    id: string;
     url?: string | undefined;
     position?: {
-        vertical: "top" | "middle" | "bottom";
-        horizontal: "middle" | "left" | "right";
+        vertical: "top" | "bottom" | "middle";
+        horizontal: "left" | "right" | "middle";
     } | 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;
 }, {
+    id: string;
     url?: string | undefined;
     position?: {
-        vertical: "top" | "middle" | "bottom";
-        horizontal: "middle" | "left" | "right";
+        vertical: "top" | "bottom" | "middle";
+        horizontal: "left" | "right" | "middle";
     } | 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;
 }>;
-export declare type ModifyUIWebsiteEvent = z.infer<typeof isModifyUIWebsiteEvent>;
-export declare const isUIWebsite: z.ZodObject<{
+export type ModifyUIWebsiteEvent = z.infer<typeof isModifyUIWebsiteEvent>;
+export declare const isUIWebsiteEvent: z.ZodObject<{
     id: z.ZodString;
     url: z.ZodString;
     visible: z.ZodBoolean;
@@ -213,77 +213,77 @@ export declare const isUIWebsite: z.ZodObject<{
         vertical: z.ZodEnum<["top", "middle", "bottom"]>;
         horizontal: z.ZodEnum<["left", "middle", "right"]>;
     }, "strip", z.ZodTypeAny, {
-        vertical: "top" | "middle" | "bottom";
-        horizontal: "middle" | "left" | "right";
+        vertical: "top" | "bottom" | "middle";
+        horizontal: "left" | "right" | "middle";
     }, {
-        vertical: "top" | "middle" | "bottom";
-        horizontal: "middle" | "left" | "right";
+        vertical: "top" | "bottom" | "middle";
+        horizontal: "left" | "right" | "middle";
     }>;
     size: 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.ZodString>;
-        bottom: z.ZodOptional<z.ZodString>;
-        left: z.ZodOptional<z.ZodString>;
-        right: z.ZodOptional<z.ZodString>;
+        top: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+        bottom: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+        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?: {
-        top?: string | undefined;
-        bottom?: string | undefined;
-        left?: string | undefined;
-        right?: string | undefined;
-    } | undefined;
     url: string;
+    id: string;
     allowApi: boolean;
     allowPolicy: string;
     position: {
-        vertical: "top" | "middle" | "bottom";
-        horizontal: "middle" | "left" | "right";
+        vertical: "top" | "bottom" | "middle";
+        horizontal: "left" | "right" | "middle";
     };
-    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;
+    id: string;
     allowApi: boolean;
     allowPolicy: string;
     position: {
-        vertical: "top" | "middle" | "bottom";
-        horizontal: "middle" | "left" | "right";
+        vertical: "top" | "bottom" | "middle";
+        horizontal: "left" | "right" | "middle";
     };
-    id: string;
     visible: boolean;
     size: {
-        width: string;
         height: string;
+        width: string;
     };
+    margin?: {
+        left?: string | undefined;
+        top?: string | undefined;
+        bottom?: string | undefined;
+        right?: string | undefined;
+    } | undefined;
 }>;
-export declare type UIWebsite = z.infer<typeof isUIWebsite>;
+export type UIWebsiteEvent = z.infer<typeof isUIWebsiteEvent>;

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

@@ -1,12 +1,15 @@
 import { z } from "zod";
 export declare const isUserInputChatEvent: z.ZodObject<{
     message: z.ZodString;
+    senderId: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     message: string;
+    senderId?: string | undefined;
 }, {
     message: string;
+    senderId?: string | undefined;
 }>;
 /**
  * A message sent from the game to the iFrame when a user types a message in the chat.
  */
-export declare type UserInputChatEvent = z.infer<typeof isUserInputChatEvent>;
+export type UserInputChatEvent = z.infer<typeof isUserInputChatEvent>;

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

@@ -0,0 +1,12 @@
+import { z } from "zod";
+export declare const isWamMapDataEvent: z.ZodObject<{
+    data: z.ZodUnknown;
+}, "strip", z.ZodTypeAny, {
+    data?: unknown;
+}, {
+    data?: unknown;
+}>;
+/**
+ * A message sent from the game to the iFrame with the content of the WAM file. We don't type the content of the WAM file for performance reasons.
+ */
+export type MapDataEvent = z.infer<typeof isWamMapDataEvent>;

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

@@ -6,20 +6,20 @@ 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;
 }>;
 /**
  * A message sent from the game to the iFrame to notify a movement from the camera.
  */
-export declare type WasCameraUpdatedEvent = z.infer<typeof isWasCameraUpdatedEvent>;
-export declare type WasCameraUpdatedEventCallback = (event: WasCameraUpdatedEvent) => void;
+export type WasCameraUpdatedEvent = z.infer<typeof isWasCameraUpdatedEvent>;
+export type WasCameraUpdatedEventCallback = (event: WasCameraUpdatedEvent) => void;

package/play/src/front/Api/Iframe/AbstractEvent.d.ts

@@ -0,0 +1,18 @@
+import type { Observable } from "rxjs";
+import { Subject } from "rxjs";
+import { ReceiveEventEvent } from "../Events/ReceiveEventEvent";
+export type ScriptingEvent = ReceiveEventEvent;
+export declare abstract class AbstractWorkadventureEventCommands {
+    protected receivedEventResolvers: Subject<{
+        name: string;
+        data?: unknown;
+        senderId?: number | undefined;
+    }>;
+    protected eventSubscribers: Map<string, Subject<{
+        name: string;
+        data?: unknown;
+        senderId?: number | undefined;
+    }>>;
+    protected constructor();
+    on(key: string): Observable<ScriptingEvent>;
+}

package/play/src/front/Api/Iframe/AbstractState.d.ts

@@ -0,0 +1,19 @@
+import type { Observable } from "rxjs";
+import { Subject } from "rxjs";
+export declare abstract class AbstractWorkadventureStateCommands<State extends {
+    [key: string]: unknown;
+}> {
+    protected setVariableResolvers: Subject<{
+        key: string;
+        value?: unknown;
+    }>;
+    protected variables: Partial<State>;
+    protected variableSubscribers: Partial<{
+        [K in keyof State]: Subject<State[K]>;
+    }>;
+    protected constructor();
+    initVariables(_variables: Map<string, unknown>): void;
+    loadVariable<K extends keyof State>(key: K): State[K] | undefined;
+    hasVariable<K extends keyof State>(key: K): boolean;
+    onVariableChange<K extends keyof State>(key: K): Observable<State[K]>;
+}

package/{Api → play/src/front/Api}/Iframe/Area/Area.d.ts

@@ -1,15 +1,16 @@
-import { ITiledMapObject } from "@workadventure/tiled-map-type-guard";
-import { CreateAreaEvent } from "../../Events/CreateAreaEvent";
-export declare type IArea = Omit<ITiledMapObject, "id" | "gid" | "visible" | "rotation" | "ellipse" | "polygon" | "polyline">;
+import type { ITiledMapObject } from "@workadventure/tiled-map-type-guard";
+import type { CreateDynamicAreaEvent } from "../../Events/CreateDynamicAreaEvent";
+export type IArea = Omit<ITiledMapObject, "id" | "gid" | "visible" | "rotation" | "ellipse" | "polygon" | "polyline">;
 export declare class Area implements IArea {
     private config;
     readonly name: string;
     readonly type: string;
+    readonly class: string;
     private _x;
     private _y;
     private _width;
     private _height;
-    constructor(config: CreateAreaEvent);
+    constructor(config: CreateDynamicAreaEvent);
     setProperty(propertyName: string, propertyValue: string | number | boolean | undefined): void;
     get x(): number;
     set x(x: number);

package/{Api → play/src/front/Api}/Iframe/IframeApiContribution.d.ts

@@ -1,10 +1,10 @@
 import type { IframeEvent, IframeQuery, IframeQueryMap } from "../Events/IframeEvent";
-export declare function sendToWorkadventure(content: IframeEvent): void;
+export declare function sendToWorkadventure(content: IframeEvent, transfer?: Transferable[]): void;
 export declare const answerPromises: Map<number, {
     resolve: (value: IframeQueryMap[keyof IframeQueryMap]["answer"] | PromiseLike<IframeQueryMap[keyof IframeQueryMap]["answer"]>) => void;
     reject: (reason?: any) => void;
 }>;
-export declare function queryWorkadventure<T extends keyof IframeQueryMap>(content: IframeQuery<T>): Promise<IframeQueryMap[T]["answer"]>;
+export declare function queryWorkadventure<T extends keyof IframeQueryMap>(content: IframeQuery<T>, transfer?: Transferable[]): Promise<IframeQueryMap[T]["answer"]>;
 /**
  * !! be aware that the implemented attributes (addMethodsAtRoot and subObjectIdentifier) must be readonly
  *

package/play/src/front/Api/Iframe/MapEditor/MapEditorArea.d.ts

@@ -0,0 +1,12 @@
+import { AreaData } from "@workadventure/map-editor";
+export interface MapEditorArea {
+    id: string;
+    name: string;
+    description: string | undefined;
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    searchable: boolean | undefined;
+}
+export declare function toMapEditorArea(area: AreaData): MapEditorArea;

package/play/src/front/Api/Iframe/Player/AudioStream.d.ts

@@ -0,0 +1,5 @@
+export declare class AudioStream {
+    appendAudioData(float32Array: Float32Array): Promise<void>;
+    resetAudioBuffer(): Promise<void>;
+    close(): Promise<void>;
+}