@workadventure/iframe-api-typings 1.14.7 → 1.15.3

package/front/Api/Iframe/Players/RemotePlayer.d.ts

@@ -35,7 +35,7 @@ export interface RemotePlayerInterface {
      */
     readonly state: ReadOnlyState;
 }
-export declare type ReadOnlyState = {
+export type ReadOnlyState = {
     onVariableChange(key: string): Observable<unknown>;
 } & {
     readonly [key: string]: unknown;

package/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/front/Api/Iframe/Ui/Banner.d.ts

@@ -0,0 +1,21 @@
+import { BannerEvent } from "./../../Events/Ui/BannerEvent";
+import { IframeApiContribution } from "../IframeApiContribution";
+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/front/Api/Iframe/Ui/ButtonActionBar.d.ts

@@ -1,29 +1,47 @@
 import { AddButtonActionBarEvent } from "../../Events/Ui/ButtonActionBarEvent";
 import { IframeApiContribution } from "../IframeApiContribution";
-export declare type ButtonActionBarClickedCallback = (buttonActionBar: AddButtonActionBarEvent) => void;
+export type ButtonActionBarClickedCallback = (buttonActionBar: AddButtonActionBarEvent) => void;
+declare const ActionBarButtonType: {
+    readonly button: "button";
+    readonly action: "action";
+};
+type ActionBarButtonType = (typeof ActionBarButtonType)[keyof typeof ActionBarButtonType];
+export type ActionBarClassicButtonDescriptor = {
+    id: string;
+    label: string;
+    type?: ActionBarButtonType;
+    callback?: ButtonActionBarClickedCallback;
+};
+export type ActionBarActionButtonDescriptor = {
+    id: string;
+    type: ActionBarButtonType;
+    imageSrc: string;
+    toolTip: string;
+    callback?: ButtonActionBarClickedCallback;
+};
 export declare class WorkAdventureButtonActionBarCommands extends IframeApiContribution<WorkAdventureButtonActionBarCommands> {
     private _callbacks;
     callbacks: {
         type: "buttonActionBarTrigger";
         callback: (event: {
+            type: "button";
             id: string;
             label: string;
+        } | {
+            type: "action";
+            id: string;
+            imageSrc: string;
+            toolTip: string;
         }) => void;
     }[];
     /**
      * Add action bar button
      * {@link http://workadventure.localhost/map-building/api-ui.md#add-action-bar | Website documentation}
-     *
-     * @param id
-     * @param label
-     * @param callback
      */
-    addButton(id: string, label: string, callback?: ButtonActionBarClickedCallback): void;
+    addButton(descriptor: ActionBarClassicButtonDescriptor | ActionBarActionButtonDescriptor): void;
     /**
      * Remove action bar button
      * {@link http://workadventure.localhost/map-building/api-ui.md#remove-action-bar | Website documentation}
-     *
-     * @param id
      */
     removeButton(id: string): void;
 }

package/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/front/Api/Iframe/Ui/UIWebsite.d.ts

@@ -41,6 +41,13 @@ export declare class UIWebsiteCommands extends IframeApiContribution<UIWebsiteCo
      * @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://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/front/Api/Iframe/player.d.ts

@@ -151,7 +151,7 @@ export declare class WorkadventurePlayerCommands extends IframeApiContribution<W
      */
     getWokaPicture(): Promise<string>;
 }
-export declare type Position = {
+export type Position = {
     x: number;
     y: number;
 };

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

@@ -10,12 +10,13 @@ import type { UIWebsiteCommands } from "./Ui/UIWebsite";
 import { RemotePlayer } from "./Players/RemotePlayer";
 import type { WorkadventureModalCommands } from "./Ui/Modal";
 import { WorkAdventureButtonActionBarCommands } from "./Ui/ButtonActionBar";
+import { WorkadventureBannerCommands } from "./Ui/Banner";
 interface MenuDescriptor {
     callback?: (commandDescriptor: string) => void;
     iframe?: string;
     allowApi?: boolean;
 }
-export declare type MenuOptions = RequireOnlyOne<MenuDescriptor, "callback" | "iframe">;
+export type MenuOptions = RequireOnlyOne<MenuDescriptor, "callback" | "iframe">;
 export interface ActionMessageOptions {
     message: string;
     type?: "message" | "warning";
@@ -113,6 +114,7 @@ export declare class WorkAdventureUiCommands extends IframeApiContribution<WorkA
     get website(): UIWebsiteCommands;
     get modal(): WorkadventureModalCommands;
     get actionBar(): WorkAdventureButtonActionBarCommands;
+    get banner(): WorkadventureBannerCommands;
 }
 declare const _default: WorkAdventureUiCommands;
 export default _default;

package/front/Api/types.d.ts

@@ -1,3 +1,3 @@
-export declare type RequireOnlyOne<T, keys extends keyof T = keyof T> = Pick<T, Exclude<keyof T, keys>> & {
+export type RequireOnlyOne<T, keys extends keyof T = keyof T> = Pick<T, Exclude<keyof T, keys>> & {
     [K in keys]-?: Required<Pick<T, K>> & Partial<Record<Exclude<keys, K>, undefined>>;
 }[keys];

package/iframe_api.d.ts

@@ -40,6 +40,14 @@ declare const wa: {
      * @returns {unknown|undefined} Metadata
      */
     readonly metadata: unknown;
+    /**
+     * The iframeId (only set if the code is executed from a UIWebsite iframe)
+     * Important: You need to wait for the end of the initialization before accessing.
+     * {@link https://workadventu.re/map-building/api-ui.md#get-ui-website-by-id | Website documentation}
+     *
+     * @returns {string|undefined} IframeId
+     */
+    readonly iframeId: string | undefined;
     /**
      * @deprecated Use WA.chat.sendChatMessage instead
      */
@@ -101,7 +109,7 @@ declare const wa: {
      */
     onLeaveZone(name: string, callback: () => void): void;
 };
-export declare type WorkAdventureApi = typeof wa;
+export type WorkAdventureApi = typeof wa;
 export type { Sound, Popup, ButtonDescriptor, CoWebsite };
 declare global {
     interface Window {

package/package.json

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