@workadventure/iframe-api-typings 1.25.6 → 1.25.7

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

@@ -0,0 +1,164 @@
+import { Observable, Subject } from "rxjs";
+import { IframeApiContribution } from "../IframeApiContribution";
+import { RemotePlayer } from "../Players/RemotePlayer";
+import { AudioStream } from "./AudioStream";
+export declare class WorkadventureProximityMeetingCommands extends IframeApiContribution<WorkadventureProximityMeetingCommands> {
+    private joinStream;
+    private participantJoinStream;
+    private participantLeaveStream;
+    private followedStream;
+    private unfollowedStream;
+    private leaveStream;
+    private pcmDataStream;
+    callbacks: ({
+        type: "joinProximityMeetingEvent";
+        callback: (event: {
+            users: {
+                name: string;
+                position: {
+                    x: number;
+                    y: number;
+                };
+                playerId: number;
+                variables: Map<string, unknown>;
+                userUuid: string;
+                availabilityStatus: string;
+                outlineColor?: number | undefined;
+                chatID?: string | null | undefined;
+            }[];
+        }) => void;
+    } | {
+        type: "participantJoinProximityMeetingEvent";
+        callback: (event: {
+            user: {
+                name: string;
+                position: {
+                    x: number;
+                    y: number;
+                };
+                playerId: number;
+                variables: Map<string, unknown>;
+                userUuid: string;
+                availabilityStatus: string;
+                outlineColor?: number | undefined;
+                chatID?: string | null | undefined;
+            };
+        }) => void;
+    } | {
+        type: "participantLeaveProximityMeetingEvent";
+        callback: (event: {
+            user: {
+                name: string;
+                position: {
+                    x: number;
+                    y: number;
+                };
+                playerId: number;
+                variables: Map<string, unknown>;
+                userUuid: string;
+                availabilityStatus: string;
+                outlineColor?: number | undefined;
+                chatID?: string | null | undefined;
+            };
+        }) => void;
+    } | {
+        type: "leaveProximityMeetingEvent";
+        callback: (event: undefined) => void;
+    } | {
+        type: "onFollowed";
+        callback: (event: {
+            user: {
+                name: string;
+                position: {
+                    x: number;
+                    y: number;
+                };
+                playerId: number;
+                variables: Map<string, unknown>;
+                userUuid: string;
+                availabilityStatus: string;
+                outlineColor?: number | undefined;
+                chatID?: string | null | undefined;
+            };
+        }) => void;
+    } | {
+        type: "onUnfollowed";
+        callback: (event: {
+            user: {
+                name: string;
+                position: {
+                    x: number;
+                    y: number;
+                };
+                playerId: number;
+                variables: Map<string, unknown>;
+                userUuid: string;
+                availabilityStatus: string;
+                outlineColor?: number | undefined;
+                chatID?: string | null | undefined;
+            };
+        }) => void;
+    } | {
+        type: "appendPCMData";
+        callback: (event: {
+            data: Float32Array<ArrayBuffer>;
+        }) => void;
+    })[];
+    /**
+     * Detecting when the user enter on a meeting.
+     * {@link https://docs.workadventu.re/map-building/api-player.md#detecting-when-the-user-entersleaves-a-meeting | Website documentation}
+     *
+     * @returns {Subject<RemotePlayer[]>} Observable who return the joined users
+     */
+    onJoin(): Subject<RemotePlayer[]>;
+    /**
+     * Detecting when a participant joined on the current meeting.
+     * {@link https://docs.workadventu.re/map-building/api-player.md#detecting-when-a-participant-entersleaves-the-current-meeting | Website documentation}
+     *
+     * @returns {Subject<RemotePlayer>} Observable who return the joined user
+     */
+    onParticipantJoin(): Subject<RemotePlayer>;
+    /**
+     * Detecting when a participant left on the current meeting.
+     * {@link https://docs.workadventu.re/map-building/api-player.md#detecting-when-a-participant-entersleaves-the-current-meeting | Website documentation}
+     *
+     * @returns {Subject<RemotePlayer>} Observable who return the left user
+     */
+    onParticipantLeave(): Subject<RemotePlayer>;
+    /**
+     * Detecting when the user leave on a meeting.
+     * {@link https://docs.workadventu.re/developer/map-scripting/references/api-player/#detecting-when-the-user-entersleaves-a-meeting | Website documentation}
+     */
+    onLeave(): Subject<void>;
+    /**
+     * Play a sound to all players in the current meeting.
+     * {@link https://docs.workadventu.re/developer/map-scripting/references/api-player/#playing-a-sound-to-players-in-the-same-meeting | Website documentation}
+     */
+    playSound(url: string): Promise<void>;
+    /**
+     * Starts an audio stream played to all players in the current meeting.
+     * {@link https://docs.workadventu.re/developer/map-scripting/references/api-player/#audio-streams | Website documentation}
+     * @param {number} sampleRate - The sample rate of the audio stream expressed in Hertz.
+     */
+    startAudioStream(sampleRate: number): Promise<AudioStream>;
+    /**
+     * Listen to the audio stream played sent by all players.
+     * The voice of all players in the bubble is merged in a single stream that is regularly sent to the callback.
+     * @param {number} sampleRate - The sample rate of the audio stream expressed in Hertz.
+     */
+    listenToAudioStream(sampleRate: number): Observable<Float32Array>;
+    /**
+     * Ask all players in the current meeting to follow the player.
+     * Note that unlike with the "follow" mode in the UI, the other players will automatically follow the player.
+     */
+    followMe(): Promise<void>;
+    stopLeading(): Promise<void>;
+    /**
+     * Triggered when a player starts following us.
+     */
+    onFollowed(): Subject<RemotePlayer>;
+    /**
+     * Triggered when a player stops following us.
+     */
+    onUnfollowed(): Subject<RemotePlayer>;
+}

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

@@ -1,8 +1,9 @@
-import { AddPlayerEvent } from "../../Events/AddPlayerEvent";
-import { Observable, Subject } from "rxjs";
-import { PlayerPosition } from "../../Events/PlayerPosition";
+import type { Observable } from "rxjs";
+import { Subject } from "rxjs";
+import type { AddPlayerEvent } from "../../Events/AddPlayerEvent";
+import type { PlayerPosition } from "../../Events/PlayerPosition";
 import { ActionsMenuAction } from "../ui";
-export declare const remotePlayers: Map<number, RemotePlayer>;
+import { PublicPlayerState, ReadOnlyPublicPlayerState } from "../PublicPlayerState";
 export interface RemotePlayerInterface {
     /**
      * A unique ID for this player. Each character on the map has a unique ID
@@ -32,13 +33,13 @@ export interface RemotePlayerInterface {
     /**
      * An object storing players variables
      */
-    readonly state: ReadOnlyState;
+    readonly state: ReadOnlyPublicPlayerState;
+    /**
+     * Send an event to the player.
+     * Remote player can listen to this event using `WA.event.on(key).subscribe((event) => { ... })`.
+     */
+    sendEvent(key: string, value: unknown): Promise<void>;
 }
-export declare type ReadOnlyState = {
-    onVariableChange(key: string): Observable<unknown>;
-} & {
-    readonly [key: string]: unknown;
-};
 export declare class RemotePlayer implements RemotePlayerInterface {
     private _playerId;
     private _name;
@@ -48,7 +49,7 @@ export declare class RemotePlayer implements RemotePlayerInterface {
     private _position;
     private _variables;
     private _variablesSubjects;
-    readonly state: ReadOnlyState;
+    readonly state: ReadOnlyPublicPlayerState;
     private actions;
     constructor(addPlayerEvent: AddPlayerEvent);
     get playerId(): number;
@@ -69,10 +70,11 @@ export declare class RemotePlayer implements RemotePlayerInterface {
         y: number;
     }>;
     destroy(): void;
-    setVariable(name: string, value: unknown): void;
+    setVariable<K extends keyof PublicPlayerState>(name: K, value: PublicPlayerState[K]): void;
     addAction(key: string, callback: () => void): ActionsMenuAction;
     callAction(key: string): void;
     removeAction(key: string): void;
+    sendEvent(name: string, data: unknown): Promise<void>;
 }
 export interface RemotePlayerMoved {
     player: RemotePlayerInterface;

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

@@ -0,0 +1,7 @@
+/**
+ * PrivatePlayerState is the part of the state of a player that is secret (not shared with other players).
+ * The interface is empty. It is meant to be extended by the ScriptingAPI developers to add custom properties.
+ */
+export interface PrivatePlayerState {
+    [key: string]: unknown;
+}

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

@@ -0,0 +1,11 @@
+import { Observable } from "rxjs";
+/**
+ * PublicPlayerState is the part of the state of a player that is shared with other players.
+ * The interface is empty. It is meant to be extended by the ScriptingAPI developers to add custom properties.
+ */
+export interface PublicPlayerState {
+    [key: string]: unknown;
+}
+export type ReadOnlyPublicPlayerState = Readonly<PublicPlayerState> & {
+    onVariableChange<K extends keyof PublicPlayerState>(key: K): Observable<PublicPlayerState[K]>;
+};

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

@@ -4,10 +4,7 @@ export declare class EmbeddedWebsite {
     readonly name: string;
     private _url;
     private _visible;
-    private _allow;
-    private _allowApi;
     private _position;
-    private readonly origin;
     private _scale;
     constructor(config: CreateEmbeddedWebsiteEvent);
     get url(): string;

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

@@ -0,0 +1,7 @@
+/**
+ * RoomState is the state of a room (i.e. the type associated with the room variables).
+ * The interface is empty. It is meant to be extended by the ScriptingAPI developers to add custom properties.
+ */
+export interface RoomState {
+    [key: string]: unknown;
+}

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

@@ -1,7 +1,7 @@
 /**
  * A copy of the SoundConfig type from Phaser
  */
-export declare type SoundConfig = {
+export type SoundConfig = {
     /**
      * Boolean indicating whether the sound should be muted or not.
      */

package/play/src/front/Api/Iframe/Ui/Banner.d.ts

@@ -0,0 +1,21 @@
+import { IframeApiContribution } from "../IframeApiContribution";
+import { BannerEvent } from "./../../Events/Ui/BannerEvent";
+export declare class WorkadventureBannerCommands extends IframeApiContribution<WorkadventureBannerCommands> {
+    callbacks: never[];
+    /**
+     * Open banner message with link
+     *
+     * {@link http://workadventure.localhost/map-building/api-ui.md#open-banner | Website documentation}
+     * @param bannerEvent
+     * @returns
+     */
+    openBanner(bannerEvent: BannerEvent): void;
+    /**
+     * Close banner message
+     * {@link http://workadventure.localhost/map-building/api-ui.md#close-banner | Website documentation}
+     * @returns
+     */
+    closeBanner(): void;
+}
+declare const _default: WorkadventureBannerCommands;
+export default _default;

package/play/src/front/Api/Iframe/Ui/ButtonActionBar.d.ts

@@ -0,0 +1,25 @@
+import { AddButtonActionBarEvent } from "../../Events/Ui/ButtonActionBarEvent";
+import { IframeApiContribution } from "../IframeApiContribution";
+export type ButtonActionBarClickedCallback = (buttonActionBar: AddButtonActionBarEvent) => void;
+export type ActionBarButtonDescriptor = AddButtonActionBarEvent & {
+    callback?: ButtonActionBarClickedCallback;
+};
+export declare class WorkAdventureButtonActionBarCommands extends IframeApiContribution<WorkAdventureButtonActionBarCommands> {
+    private _callbacks;
+    callbacks: {
+        type: "buttonActionBarTriggered";
+        callback: (event: string) => void;
+    }[];
+    /**
+     * Add action bar button
+     * {@link http://workadventure.localhost/map-building/api-ui.md#add-action-bar | Website documentation}
+     */
+    addButton(descriptor: ActionBarButtonDescriptor): void;
+    /**
+     * Remove action bar button
+     * {@link http://workadventure.localhost/map-building/api-ui.md#remove-action-bar | Website documentation}
+     */
+    removeButton(id: string): void;
+}
+declare const _default: WorkAdventureButtonActionBarCommands;
+export default _default;

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

@@ -1,5 +1,5 @@
 import type { Popup } from "./Popup";
-export declare type ButtonClickedCallback = (popup: Popup) => void;
+export type ButtonClickedCallback = (popup: Popup) => void;
 export interface ButtonDescriptor {
     /**
      * The label of the button

package/play/src/front/Api/Iframe/Ui/Menu.d.ts

@@ -0,0 +1,12 @@
+export declare class Menu {
+    private key;
+    constructor(key: string);
+    /**
+     * remove the menu
+     */
+    remove(): void;
+    /**
+     * Programmatically open the menu (only works if the menu has been defined with the "iframe" property)
+     */
+    open(): void;
+}

package/play/src/front/Api/Iframe/Ui/Modal.d.ts

@@ -0,0 +1,28 @@
+import { IframeApiContribution } from "../IframeApiContribution";
+import type { ModalEvent } from "../../Events/ModalEvent";
+export declare class WorkadventureModalCommands extends IframeApiContribution<WorkadventureModalCommands> {
+    private _closeCallback?;
+    callbacks: {
+        type: "modalCloseTrigger";
+        callback: (event: {
+            title: string;
+            allowApi: boolean;
+            position: "left" | "right" | "center";
+            allow: string | null;
+            src: string;
+            allowFullScreen: boolean;
+        }) => void;
+    }[];
+    /**
+     * Open instantly the modal window.
+     * {@link http://workadventure.localhost/map-building/api-ui.md#open-the-modal-iframe | Website documentation}
+     */
+    openModal(modalEvent: ModalEvent, closeCallback?: (arg: ModalEvent) => void): void;
+    /**
+     * Close instantly the modal window.
+     * {@link http://workadventure.localhost/map-building/api-ui.md#close-the-chat-window | Website documentation}
+     */
+    closeModal(): void;
+}
+declare const _default: WorkadventureModalCommands;
+export default _default;

package/play/src/front/Api/Iframe/Ui/PlayerMessage.d.ts

@@ -0,0 +1,12 @@
+import type { PlayerMessageOptions } from "../ui";
+export declare class PlayerMessage {
+    private onRemove;
+    readonly uuid: string;
+    private readonly type;
+    private readonly message;
+    private readonly callback;
+    constructor(playerMessageOptions: PlayerMessageOptions, onRemove: () => void);
+    private create;
+    remove(): Promise<void>;
+    triggerCallback(): void;
+}

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

@@ -1,4 +1,4 @@
-import { CreateUIWebsiteEvent, UIWebsiteMargin, UIWebsitePosition, UIWebsiteSize, UIWebsite as UIWebsiteCore } from "../../Events/Ui/UIWebsite";
+import type { CreateUIWebsiteEvent, UIWebsiteMargin, UIWebsitePosition, UIWebsiteSize, UIWebsiteEvent } from "../../Events/Ui/UIWebsiteEvent";
 import { IframeApiContribution } from "../IframeApiContribution";
 export declare class UIWebsite {
     readonly id: string;
@@ -9,7 +9,7 @@ export declare class UIWebsite {
     private _position;
     private _size;
     private _margin;
-    constructor(config: UIWebsiteCore);
+    constructor(config: UIWebsiteEvent);
     get url(): string;
     set url(url: string);
     get visible(): boolean;
@@ -28,7 +28,7 @@ export declare class UIWebsiteCommands extends IframeApiContribution<UIWebsiteCo
     callbacks: never[];
     /**
      * Open an iFrame that is fixed in the viewport. Use this for advanced popups, additional buttons in the UI, HUD, etc... Returns a promise of a UIWebsite instance.
-     * {@link https://workadventu.re/map-building/api-ui.md#display-a-ui-website | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-ui.md#display-a-ui-website | Website documentation}
      *
      * @param {CreateUIWebsiteEvent} createUIWebsite The details of the UIWebsite to create
      * @returns {Promise<UIWebsite>} Promise to return a UIWebsite
@@ -36,11 +36,18 @@ export declare class UIWebsiteCommands extends IframeApiContribution<UIWebsiteCo
     open(createUIWebsite: CreateUIWebsiteEvent): Promise<UIWebsite>;
     /**
      * Returns all UI websites (iframes positionned on the viewport)
-     * {@link https://workadventu.re/map-building/api-ui.md#get-all-ui-websites | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-ui.md#get-all-ui-websites | Website documentation}
      *
      * @returns {Promise<UIWebsite[]>} Promise to return all UI websites
      */
     getAll(): Promise<UIWebsite[]>;
+    /**
+     * Returns one UI website (iframe positionned on the viewport) by ID.
+     * {@link https://docs.workadventu.re/map-building/api-ui.md#get-all-ui-websites | Website documentation}
+     * @param {string} id The id of the UIWebsite
+     * @returns {Promise<UIWebsite | undefined>} Promise to return UI website
+     */
+    getById(id: string): Promise<UIWebsite | undefined>;
 }
 declare const _default: UIWebsiteCommands;
 export default _default;

package/play/src/front/Api/Iframe/Ui/Video.d.ts

@@ -0,0 +1,5 @@
+export declare class Video {
+    private id;
+    constructor(id: string);
+    stop(): Promise<void>;
+}

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

@@ -1,5 +1,5 @@
-import { Observable } from "rxjs";
-import { CreateAreaEvent } from "../Events/CreateAreaEvent";
+import type { Observable } from "rxjs";
+import type { CreateDynamicAreaEvent } from "../Events/CreateDynamicAreaEvent";
 import { Area } from "./Area/Area";
 import { IframeApiContribution } from "./IframeApiContribution";
 export declare class WorkadventureAreaCommands extends IframeApiContribution<WorkadventureAreaCommands> {
@@ -16,23 +16,23 @@ export declare class WorkadventureAreaCommands extends IframeApiContribution<Wor
     })[];
     /**
      * Create a new Area object (currently limited to rectangular shapes).
-     * {@link https://workadventu.re/map-building/api-room.md#create-area | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-room.md#create-area | Website documentation}
      *
      * @param {{name: string, x: number, y: number, width: number, height: number}} createAreaEvent Define the name, position and size of the area
      * @returns {Area} Area object
      */
-    create(createAreaEvent: CreateAreaEvent): Area;
+    create(createAreaEvent: CreateDynamicAreaEvent): Area;
     /**
      * Get an existing Area object.
-     * {@link https://workadventu.re/map-building/api-room.md#get-an-area | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-room.md#get-an-area | Website documentation}
      *
      * @param {string} name Name of the area searched
      * @returns {Area} Area found
      */
     get(name: string): Promise<Area>;
     /**
-     * Delete Area by it's name.
-     * {@link https://workadventu.re/map-building/api-room.md#delete-area | Website documentation}
+     * Delete Area by its name.
+     * {@link https://docs.workadventu.re/map-building/api-room.md#delete-area | Website documentation}
      *
      * @param {string} name Area name
      * @returns {Promise<void>} Promise resolved when the removing is finished
@@ -40,7 +40,7 @@ export declare class WorkadventureAreaCommands extends IframeApiContribution<Wor
     delete(name: string): Promise<void>;
     /**
      * Listens to the position of the current user. The event is triggered when the user enters a given area.
-     * {@link https://workadventu.re/map-building/api-room.md#detecting-when-the-user-entersleaves-an-area | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-room.md#detecting-when-the-user-entersleaves-an-area | Website documentation}
      *
      * @param {string} areaName Area name
      * @returns {Subject<void>} An observable fired when someone enters the area
@@ -48,7 +48,7 @@ export declare class WorkadventureAreaCommands extends IframeApiContribution<Wor
     onEnter(areaName: string): Observable<void>;
     /**
      * Listens to the position of the current user. The event is triggered when the user leaves a given area.
-     * {@link https://workadventu.re/map-building/api-room.md#detecting-when-the-user-entersleaves-an-area | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-room.md#detecting-when-the-user-entersleaves-an-area | Website documentation}
      *
      * @param {string} areaName Area name
      * @returns {Subject<void>} An observable fired when someone leaves the area

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

@@ -1,29 +1,29 @@
-import { IframeApiContribution } from "./IframeApiContribution";
-import { Observable } from "rxjs";
+import type { Observable } from "rxjs";
 import type { WasCameraUpdatedEvent } from "../Events/WasCameraUpdatedEvent";
+import { IframeApiContribution } from "./IframeApiContribution";
 export declare class WorkAdventureCameraCommands extends IframeApiContribution<WorkAdventureCameraCommands> {
     callbacks: {
         type: "wasCameraUpdated";
         callback: (event: {
+            height: number;
+            width: number;
             x: number;
             y: number;
-            width: number;
-            height: number;
             zoom: number;
         }) => void;
     }[];
     /**
      * Set camera to follow the player.
-     * {@link https://workadventu.re/map-building/api-camera.md#start-following-player | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-camera.md#start-following-player | Website documentation}
      *
      * @param smooth Smooth transition
      */
-    followPlayer(smooth?: boolean): void;
+    followPlayer(smooth?: boolean, duration?: number): void;
     /**
      * Set camera to look at given spot. Setting width and height will adjust zoom.
      * Set lock to true to lock camera in this position.
      * Set smooth to true for smooth transition.
-     * {@link https://workadventu.re/map-building/api-camera.md#set-spot-for-camera-to-look-at | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-camera.md#set-spot-for-camera-to-look-at | Website documentation}
      *
      * @param {number} x Horizontal position
      * @param {number} y Vertical position
@@ -32,11 +32,11 @@ export declare class WorkAdventureCameraCommands extends IframeApiContribution<W
      * @param {boolean} lock Zoom locked
      * @param {boolean} smooth Smooth transition
      */
-    set(x: number, y: number, width?: number, height?: number, lock?: boolean, smooth?: boolean): void;
+    set(x: number, y: number, width?: number, height?: number, lock?: boolean, smooth?: boolean, duration?: number): void;
     /**
      * Listens to updates of the camera viewport.
      * It will trigger for every update of the camera's properties (position or scale for instance).
-     * {@link https://workadventu.re/map-building/api-camera.md#listen-to-camera-updates | Website documentation}
+     * {@link https://docs.workadventu.re/map-building/api-camera.md#listen-to-camera-updates | Website documentation}
      *
      * @returns {Subject<WasCameraUpdatedEvent>} An observable firing event when the camera is updated
      */

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

@@ -0,0 +1,69 @@
+import { Subscription } from "rxjs";
+import { SendChatMessageOptions } from "@workadventure/shared-utils";
+import { IframeApiContribution } from "./IframeApiContribution";
+import { RemotePlayerInterface } from "./Players/RemotePlayer";
+import { PublicPlayerState } from "./PublicPlayerState";
+export interface OnChatMessageOptions {
+    scope: "local" | "bubble";
+}
+export declare class WorkadventureChatCommands<PublicState extends {
+    [key: string]: unknown;
+}> extends IframeApiContribution<WorkadventureChatCommands<PublicState>> {
+    callbacks: {
+        type: "userInputChat";
+        callback: (event: {
+            message: string;
+            senderId?: string | undefined;
+        }) => void;
+    }[];
+    /**
+     * Open instantly the chat window.
+     * {@link https://docs.workadventu.re/map-building/api-chat.md#open-the-chat-window | Website documentation}
+     */
+    open(): void;
+    /**
+     * Close instantly the chat window.
+     * {@link https://docs.workadventu.re/map-building/api-chat.md#close-the-chat-window | Website documentation}
+     */
+    close(): void;
+    /**
+     * Sends a message in the chat.
+     * {@link https://docs.workadventu.re/developer/map-scripting/references/api-chat#sending-a-message-in-the-chat | Website documentation}
+     *
+     * @param {string} message Message to be displayed in the chat
+     * @param {SendChatMessageOptions|string|undefined} options Decides if the message is sent only to the local users or to all users in the bubble. In undefined, the message is sent to the local user only. If the message is sent locally, you can decide an "author" name to be displayed in the chat. It does not have to be a real user. If a string is passed instead of an object, it will be used as the Name displayed for the author of the message (and the message type will automatically by "local"). Using a string instead of an object is deprecated.
+     */
+    sendChatMessage(message: string, options?: string | SendChatMessageOptions): void;
+    /**
+     * Simulates a user is currently typing a message in the chat.
+     *
+     * If the scope is "bubble", the typing indicator will be displayed in the chat of all users in the bubble (except the current user)
+     * If the scope is "local", the typing indicator will be displayed in the chat of the current user only (and will appear to come from the user whose name is "author")
+     *
+     * @param options
+     */
+    startTyping(options: SendChatMessageOptions): void;
+    /**
+     * Simulates a user has stopped typing a message in the chat.
+     *
+     * If the scope is "bubble", the typing indicator will be removed in the chat of all users in the bubble (except the current user)
+     * If the scope is "local", the typing indicator will be removed in the chat of the current user only (and will appear to come from the user whose name is "author")
+     *
+     * @param options
+     */
+    stopTyping(options: SendChatMessageOptions): void;
+    /**
+     * Listens to messages typed in the chat history.
+     * {@link https://docs.workadventu.re/map-building/api-chat.md#listening-to-messages-from-the-chat | Website documentation}
+     *
+     * @param {function(message: string, event: { authorId: number|undefined, author: RemotePlayerInterface|undefined }): void} callback Function that will be called when a message is received. It contains the message typed by the user
+     * @param {OnChatMessageOptions} options Options to decide if we listen only to messages from the local user (default) or from all users in the bubble.
+     * @return {Subscription} Subscription to the chat message. Call ".unsubscribe()" to stop listening to the chat.
+     */
+    onChatMessage(callback: (message: string, event: {
+        authorId: number | undefined;
+        author: RemotePlayerInterface | undefined;
+    }) => void, options?: OnChatMessageOptions): Subscription;
+}
+declare const _default: WorkadventureChatCommands<PublicPlayerState>;
+export default _default;