@workadventure/iframe-api-typings 1.17.6 → 1.17.7

package/front/Api/Iframe/chat.d.ts

@@ -1,3 +1,4 @@
+import { Subscription } from "rxjs";
 import { IframeApiContribution } from "./IframeApiContribution";
 export declare class WorkadventureChatCommands extends IframeApiContribution<WorkadventureChatCommands> {
     callbacks: {
@@ -29,8 +30,9 @@ export declare class WorkadventureChatCommands extends IframeApiContribution<Wor
      * {@link https://workadventu.re/map-building/api-chat.md#listening-to-messages-from-the-chat | Website documentation}
      *
      * @param {function(string): void} callback Function that will be called when a message is received. It contains the message typed by the user
+     * @return {Subscription} Subscription to the chat message. Call ".unsubscribe()" to stop listening to the chat.
      */
-    onChatMessage(callback: (message: string) => void): void;
+    onChatMessage(callback: (message: string) => void): Subscription;
 }
 declare const _default: WorkadventureChatCommands;
 export default _default;

package/front/Api/Iframe/player.d.ts

@@ -1,3 +1,4 @@
+import { Subscription } from "rxjs";
 import type { HasPlayerMovedEventCallback } from "../Events/HasPlayerMovedEvent";
 import { IframeApiContribution } from "./IframeApiContribution";
 import type { WorkadventureProximityMeetingCommands } from "./Player/ProximityMeeting";
@@ -86,8 +87,9 @@ export declare class WorkadventurePlayerCommands extends IframeApiContribution<W
      * {@link https://workadventu.re/map-building/api-player.md#listen-to-player-movement | Website documentation}
      *
      * @param {HasPlayerMovedEventCallback} callback Function that will be called when the current player is moving. It contains the event
+     * @return {Subscription} Subscription to the stream. Use ".unsubscribe()" to stop listening.
      */
-    onPlayerMove(callback: HasPlayerMovedEventCallback): void;
+    onPlayerMove(callback: HasPlayerMovedEventCallback): Subscription;
     /**
      * Player will try to find the shortest path to the destination point and proceed to move there.
      * {@link https://workadventu.re/map-building/api-player.md#move-player-to-position | Website documentation}

package/front/Api/Iframe/room.d.ts

@@ -1,4 +1,5 @@
 import type { Observable } from "rxjs";
+import { Subscription } from "rxjs";
 import type { ITiledMap } from "@workadventure/tiled-map-type-guard";
 import { IframeApiContribution } from "./IframeApiContribution";
 import type { WorkadventureRoomWebsiteCommands } from "./website";
@@ -36,11 +37,11 @@ export declare class WorkadventureRoomCommands extends IframeApiContribution<Wor
     /**
      * @deprecated Use onEnterLayer instead
      */
-    onEnterZone(name: string, callback: () => void): void;
+    onEnterZone(name: string, callback: () => void): Subscription;
     /**
      * @deprecated Use onLeaveLayer instead
      */
-    onLeaveZone(name: string, callback: () => void): void;
+    onLeaveZone(name: string, callback: () => void): Subscription;
     /**
      * Listens to the position of the current user. The event is triggered when the user enters a given layer.
      * {@link https://workadventu.re/map-building/api-room.md#detecting-when-the-user-entersleaves-a-layer | Website documentation}

package/package.json

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