@workadventure/iframe-api-typings 1.26.10 → 1.26.11

package/package.json

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

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

@@ -9,12 +9,15 @@ export declare const iframeMessagePortTypeGuards: {
         data: z.ZodObject<{
             spaceName: z.ZodString;
             filterType: z.ZodEnum<["everyone", "streaming"]>;
+            propertiesToSync: z.ZodArray<z.ZodString, "many">;
         }, "strip", z.ZodTypeAny, {
             spaceName: string;
             filterType: "everyone" | "streaming";
+            propertiesToSync: string[];
         }, {
             spaceName: string;
             filterType: "everyone" | "streaming";
+            propertiesToSync: string[];
         }>;
         iframeEvents: z.ZodUnion<[z.ZodObject<{
             type: z.ZodLiteral<"watch">;

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

@@ -1,5 +1,5 @@
-import { IframeEvent, IframeQuery, IframeQueryMap } from "../Events/IframeEvent";
 import { IframeMessagePortData, IframeMessagePortMap } from "../Events/MessagePortEvents";
+import { IframeEvent, IframeQuery, IframeQueryMap } from "../Events/IframeEvent";
 import { CheckedIframeMessagePort } from "./CheckedIframeMessagePort";
 export declare function sendToWorkadventure(content: IframeEvent, transfer?: Transferable[]): void;
 export declare const answerPromises: Map<number, {
@@ -10,7 +10,11 @@ export declare const answerPromisesMessagePort: Map<number, {
     resolve: () => void;
     reject: (reason?: any) => void;
 }>;
-export declare function queryWorkadventure<T extends keyof IframeQueryMap>(content: IframeQuery<T>, transfer?: Transferable[]): Promise<IframeQueryMap[T]["answer"]>;
+export declare function queryWorkadventure<T extends keyof IframeQueryMap>(content: IframeQuery<T>, options?: {
+    transfer?: Transferable[];
+    signal?: AbortSignal;
+    timeout?: number | null;
+}): Promise<IframeQueryMap[T]["answer"]>;
 export declare function openMessagePort<K extends keyof IframeMessagePortMap>(type: K, data: IframeMessagePortData<K>["data"]): Promise<CheckedIframeMessagePort<K>>;
 /**
  * !! be aware that the implemented attributes (addMethodsAtRoot and subObjectIdentifier) must be readonly

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

@@ -14,9 +14,10 @@ export declare class WorkAdventureSpacesCommands extends IframeApiContribution<W
      * {@link https://docs.workadventu.re/map-building/api-spaces.md#start-following-player | Website documentation}
      *
      * @param {string} spaceName Name of the space to join
-     * @param {("everyone"|"streaming")} filterType Type of filter to apply when joining the space. THis must match the filter decided by the first person joining the space.
+     * @param {("everyone"|"streaming")} filterType Type of filter to apply when joining the space. This must match the filter decided by the first person joining the space.
+     * @param {string[]} propertiesToSync List of properties to listen to. You will be notified if any of these properties change when synchronizing in the space.
      */
-    joinSpace(spaceName: string, filterType: "everyone" | "streaming"): Promise<Space>;
+    joinSpace(spaceName: string, filterType: "everyone" | "streaming", propertiesToSync: string[]): Promise<Space>;
 }
 declare const _default: WorkAdventureSpacesCommands;
 export default _default;