@workadventure/iframe-api-typings 1.26.16 → 1.27.2

package/package.json

@@ -1,10 +1,13 @@
 {
   "name": "@workadventure/iframe-api-typings",
-  "version": "v1.26.16",
+  "version": "v1.27.2",
   "description": "Typescript typings for WorkAdventure iFrame API",
   "main": "iframe_api.js",
   "types": "iframe_api.d.ts",
-  "repository": "https://github.com/thecodingmachine/workadventure/",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/workadventure/workadventure.git"
+  },
   "author": "David Négrier <d.negrier@thecodingmachine.com>",
   "license": "MIT",
   "publishConfig": {

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

@@ -1228,6 +1228,7 @@ export declare const isIframeEventWrapper: z.ZodUnion<[z.ZodObject<{
         textColor: z.ZodOptional<z.ZodString>;
         imageSrc: z.ZodOptional<z.ZodString>;
         isGradient: z.ZodOptional<z.ZodBoolean>;
+        location: z.ZodOptional<z.ZodEnum<["top", "appsMenu", "buildMenu", "profileMenu"]>>;
     }, "strip", z.ZodTypeAny, {
         id: string;
         label?: string | undefined;
@@ -1236,6 +1237,7 @@ export declare const isIframeEventWrapper: z.ZodUnion<[z.ZodObject<{
         textColor?: string | undefined;
         imageSrc?: string | undefined;
         isGradient?: boolean | undefined;
+        location?: "top" | "appsMenu" | "buildMenu" | "profileMenu" | undefined;
     }, {
         id: string;
         label?: string | undefined;
@@ -1244,6 +1246,7 @@ export declare const isIframeEventWrapper: z.ZodUnion<[z.ZodObject<{
         textColor?: string | undefined;
         imageSrc?: string | undefined;
         isGradient?: boolean | undefined;
+        location?: "top" | "appsMenu" | "buildMenu" | "profileMenu" | undefined;
     }>;
 }, "strip", z.ZodTypeAny, {
     type: "addButtonActionBar";
@@ -1255,6 +1258,7 @@ export declare const isIframeEventWrapper: z.ZodUnion<[z.ZodObject<{
         textColor?: string | undefined;
         imageSrc?: string | undefined;
         isGradient?: boolean | undefined;
+        location?: "top" | "appsMenu" | "buildMenu" | "profileMenu" | undefined;
     };
 }, {
     type: "addButtonActionBar";
@@ -1266,6 +1270,7 @@ export declare const isIframeEventWrapper: z.ZodUnion<[z.ZodObject<{
         textColor?: string | undefined;
         imageSrc?: string | undefined;
         isGradient?: boolean | undefined;
+        location?: "top" | "appsMenu" | "buildMenu" | "profileMenu" | undefined;
     };
 }>, z.ZodObject<{
     type: z.ZodLiteral<"removeButtonActionBar">;

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/Events/Ui/ButtonActionBarEvent.d.ts

@@ -7,6 +7,7 @@ export declare const isAddActionBarButtonEvent: z.ZodObject<{
     textColor: z.ZodOptional<z.ZodString>;
     imageSrc: z.ZodOptional<z.ZodString>;
     isGradient: z.ZodOptional<z.ZodBoolean>;
+    location: z.ZodOptional<z.ZodEnum<["top", "appsMenu", "buildMenu", "profileMenu"]>>;
 }, "strip", z.ZodTypeAny, {
     id: string;
     label?: string | undefined;
@@ -15,6 +16,7 @@ export declare const isAddActionBarButtonEvent: z.ZodObject<{
     textColor?: string | undefined;
     imageSrc?: string | undefined;
     isGradient?: boolean | undefined;
+    location?: "top" | "appsMenu" | "buildMenu" | "profileMenu" | undefined;
 }, {
     id: string;
     label?: string | undefined;
@@ -23,6 +25,7 @@ export declare const isAddActionBarButtonEvent: z.ZodObject<{
     textColor?: string | undefined;
     imageSrc?: string | undefined;
     isGradient?: boolean | undefined;
+    location?: "top" | "appsMenu" | "buildMenu" | "profileMenu" | undefined;
 }>;
 export type AddButtonActionBarEvent = z.infer<typeof isAddActionBarButtonEvent>;
 export type AddActionButtonActionBarEvent = AddButtonActionBarEvent;

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/Player/AudioStream.d.ts

@@ -1,4 +1,9 @@
 export declare class AudioStream {
+    /**
+     * Append raw PCM audio data to the audio stream.
+     * The promise resolves when the sound is played. If the audio buffer is reset with resetAudioBuffer before
+     * the data was played, the promise will reject.
+     */
     appendAudioData(float32Array: Float32Array): Promise<void>;
     resetAudioBuffer(): Promise<void>;
     close(): Promise<void>;

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;