@elliemae/pui-app-bridge 2.3.1 → 2.4.0

package/dist/types/appBridge.d.ts

@@ -10,14 +10,12 @@ import { ScriptingObjects, DispatchEventParam, ValueOf } from './typings/common.
 export type AppBridgeParams = {
     /**
      * Base url of the application config file
-     *
      * @defaultValue document base url
      * @example https://encompass.ice.com/
      */
     appConfigBaseUrl?: string;
     /**
      * release version of the product
-     *
      * @defaultValue latest
      */
     version?: string;
@@ -28,7 +26,6 @@ export type AppBridgeParams = {
 };
 /**
  * AppBridge implementation. This class is responsible for creating & managing the Micro FrontEnd Guest instances. It also exposes scripting objects to all the Micro FrontEnd Guests.
- *
  * @typeParam AppObjects - type of the scripting objects that the application supports
  * @typeParam AppEvents - type of the events that the application supports
  */
@@ -36,13 +33,11 @@ export declare class CAppBridge<AppObjects extends ScriptingObjects = Partial<Sc
     #private;
     /**
      * Create a new instance of the AppBridge
-     *
      * @param {AppBridgeParams} params - parameter for the constructor
      */
     constructor(params: AppBridgeParams);
     /**
      * registers scripting object to the host
-     *
      * @param {ValueOf<AppObjects>} so scripting object
      * @param {AddScriptingObjectParams} params params to add scripting object
      */
@@ -53,26 +48,22 @@ export declare class CAppBridge<AppObjects extends ScriptingObjects = Partial<Sc
     closeAllApps: () => Promise<void>;
     /**
      * Close guest micro frontend application
-     *
      * @param id unique id of guest application
      */
     closeApp: (id: string) => Promise<void>;
     /**
      * dispatch event to guest microfrontend application
-     *
      * @param {DispatchEventParams<EventId, Params>} params - event parameters
      */
     dispatchEvent: <EventId extends Extract<keyof AppEvents, string>, Params extends Parameters<AppEvents[EventId]>[0]["eventParams"]>(params: DispatchEventParam<EventId, Params>) => Promise<void | any[]>;
     /**
      * Get guest by id
-     *
      * @param id unique id of guest
      * @returns guest instance
      */
     getGuest: <T extends IMicroFEGuest<Partial<ScriptingObjectTypes>, Events>>(id: string) => T | null;
     /**
      * Get list of active guests
-     *
      * @returns list of active guests
      */
     getGuests: () => IMicroFEGuest<Partial<ScriptingObjectTypes>, Events>[];
@@ -82,20 +73,17 @@ export declare class CAppBridge<AppObjects extends ScriptingObjects = Partial<Sc
     init: () => Promise<void>;
     /**
      * Mount guest micro frontend application into DOM
-     *
      * @param id unique id of guest micro frontend application
      * @throws Error if application with given id is not found in configuration
      */
     mountApp: (id: string) => Promise<void>;
     /**
      * Open guest micro frontend application
-     *
      * @param {OpenAppParams} params - options to open guest application
      */
     openApp: (params: OpenAppParams) => Promise<IMicroFEGuest<Partial<ScriptingObjectTypes>, Events> | undefined>;
     /**
      * emit event to all subscribers (deprecated)
-     *
      * @deprecated use dispatchEvent instead
      * @param eventId unique id of the event. The format is <scripting object name>.<event name>
      * @param data data to be sent to the subscribers of the event
@@ -108,13 +96,11 @@ export declare class CAppBridge<AppObjects extends ScriptingObjects = Partial<Sc
     removeAllEventListeners: () => void;
     /**
      * removes scripting object from the host
-     *
      * @param objectId unique id of the scripting object
      */
     removeScriptingObject: (objectId: Extract<keyof AppObjects, string>) => void;
     /**
      * Unmount guest micro frontend application from DOM
-     *
      * @param id unique id of guest micro frontend application
      * @throws Error if application with given id is not found in configuration
      */

package/dist/types/config/app.d.ts

@@ -113,7 +113,6 @@ export declare class CAppConfig {
     });
     /**
      * Get value for the given app config key
-     *
      * @param key key to get value for
      * @param defaultValue default value to return if key is not found
      * @returns value for the given key
@@ -121,7 +120,6 @@ export declare class CAppConfig {
     get: <Type>(key?: string, defaultValue?: unknown) => Type;
     /**
      * Set value for the given app config key
-     *
      * @param key key to set value for
      * @param value value to set
      * @returns app config instance
@@ -129,14 +127,12 @@ export declare class CAppConfig {
     set: <Type>(key: string, value: Type) => IAppConfig;
     /**
      * Check if the given key exists in app config
-     *
      * @param key key to check
      * @returns true if key exists
      */
     has: (key?: string) => boolean;
     /**
      * load application configuration from the given asset path
-     *
      * @param assetPath url path to load app config from
      * @param configUrl
      */

package/dist/types/eventManager.d.ts

@@ -42,19 +42,16 @@ export declare class EventManager<AppEvents extends EventListeners = Events> {
     #private;
     /**
      * dispatch an event
-     *
      * @param {DispatchEventParam<EventId, Params>} param - parameters for dispatching an event
      */
     dispatchEvent: <EventId extends Extract<keyof AppEvents, string>, Params extends Parameters<AppEvents[EventId]>[0]["eventParams"]>(param: DispatchEventParam<EventId, Params>) => Promise<void | any[]>;
     /**
      * Subscribe to an event
-     *
      * @param {SubscribeParam<EventId, AppEvents[EventId]>} param - parameters for subscribing to an event
      */
     subscribe: <EventId extends Extract<keyof AppEvents, string>>(param: SubscribeParam<EventId, AppEvents[EventId]>) => string;
     /**
      * Unsubscribe from an event
-     *
      * @param {UnsubscribeParam<EventId>} param - parameters for unsubscribing from an event
      */
     unsubscribe: <EventId extends Extract<keyof AppEvents, string>>(param: UnsubscribeParam<EventId>) => void;

package/dist/types/microfeHost.d.ts

@@ -32,7 +32,6 @@ export type CMicroFEHostParams<AppObjects extends ScriptingObjects, AppEvents ex
 };
 /**
  * Represents a host micro frontend application
- *
  * @typeParam AppObjects - scripting objects that are published by the host application
  * @typeParam AppEvents - events that are published by the host application
  */
@@ -40,26 +39,22 @@ export declare class CMicroFEHost<AppObjects extends ScriptingObjects = Partial<
     #private;
     /**
      * Create new instance of the host frontend application
-     *
      * @param {CMicroFEHostParams} params - constructor parameters
      */
     constructor(params: CMicroFEHostParams<AppObjects, AppEvents>);
     /**
      * add listener to the scripting object event
-     *
      * @param {SubscribeParam<EventId, EventListener>} params - parameters to add event listener
      * @returns subscription id
      */
     addEventListener: <EventId extends Extract<keyof AppEvents, string>>(params: SubscribeParam<EventId, AppEvents[EventId]>) => string;
     /**
      * application release version
-     *
      * @returns release version
      */
     get version(): string;
     /**
      * Get reference to the scripting object (or proxy) by name
-     *
      * @param name unique name of the scripting object
      * @param objectId
      * @returns scripting object reference
@@ -67,19 +62,16 @@ export declare class CMicroFEHost<AppObjects extends ScriptingObjects = Partial<
     getObject: <ObjectId extends Extract<keyof AppObjects, string>>(objectId: ObjectId) => Promise<Awaited<AppObjects[ObjectId]> | null>;
     /**
      * removes listener from the scripting object event
-     *
      * @param {UnsubscribeParam<EventId>} params - parameters to remove event listener
      */
     removeEventListener: <EventId extends Extract<keyof AppEvents, string>>(params: UnsubscribeParam<EventId>) => void;
     /**
      * set the size of the guest application iframe window
-     *
      * @param {AppWindowSize} appSize window size of the application
      */
     setAppWindowSize: (appSize: AppWindowSize) => void;
     /**
      * subscribe to an scripting object event (deprecated)
-     *
      * @param eventId unique id of the event. The format is <scripting object name>.<event name>
      * @param listener callback function to be called when the event is fired
      * @returns token to be used to unsubscribe
@@ -87,7 +79,6 @@ export declare class CMicroFEHost<AppObjects extends ScriptingObjects = Partial<
     subscribe: <T>(eventId: string | symbol, listener: SubscriptionListener<T>) => string;
     /**
      * unsubscribe from an scripting object event (deprecated)
-     *
      * @param token unique token returned by subscribe
      * @param eventId unique id of the event. The format is <scripting object name>.<event name>
      */

package/dist/types/typings/guest.d.ts

@@ -87,7 +87,6 @@ export type MountParams = {
 };
 /**
  * Interface to connect and communicate with microfrontend guest application
- *
  * @typeParam AppObjects - scripting object types
  * @typeParam AppEvents - scripting object events
  */
@@ -98,19 +97,16 @@ export interface IMicroFEGuest<AppObjects extends ScriptingObjects = Partial<Scr
     readonly guestWindow: Window;
     /**
      * initialize the guest micro frontend application
-     *
      * @param {InitParams} params guest initailization options
      */
     init(params: InitParams<AppObjects, AppEvents>): Promise<void>;
     /**
      * mount application to the window DOM
-     *
      * @param {MountParams} params application dom mount options
      */
     mount(params: MountParams): Promise<void>;
     /**
      * unmount application from the DOM
-     *
      * @param {MountParams} params DOM unmount options
      * @returns application state serialized as JSON
      */

package/dist/types/typings/host.d.ts

@@ -6,7 +6,6 @@ import { ScriptingObjects, SubscribeParam, UnsubscribeParam } from './common.js'
 import { FrameOptions } from '../frame.js';
 /**
  * event listner callback function
- *
  * @typeParam T - type of the data
  * @param message - message
  * @param data - data
@@ -31,7 +30,6 @@ export type OpenAppParams = {
 };
 /**
  * Interface to connect and communicate with parent host
- *
  * @typeParam AppObjects - type of the scripting objects that the application supports
  * @typeParam AppEvents - type of the events that the application supports
  */
@@ -42,33 +40,28 @@ export interface IMicroFEHost<AppObjects extends ScriptingObjects = Partial<Scri
     version: string;
     /**
      * add listener to the scripting object event
-     *
      * @param {SubscribeParam<EventId, EventType>} params - parameters to add event listener
      * @returns subscription id
      */
     addEventListener: <EventId extends Extract<keyof AppEvents, string>>(params: SubscribeParam<EventId, AppEvents[EventId]>) => string;
     /**
      * Get reference to the scripting object (or proxy) by name
-     *
      * @param name unique name of the scripting object
      * @returns scripting object reference
      */
     getObject<ObjectId extends Extract<keyof AppObjects, string>>(objectId: ObjectId): Promise<AppObjects[ObjectId] | null>;
     /**
      * removes listener from the scripting object event
-     *
      * @param {UnsubscribeParam<EventId>} params - parameters to remove event listener
      */
     removeEventListener: <EventId extends Extract<keyof AppEvents, string>>(params: UnsubscribeParam<EventId>) => void;
     /**
      * set the size of the guest application iframe window
-     *
      * @param {AppWindowSize} appSize window size of the application
      */
     setAppWindowSize(appSize: AppWindowSize): void;
     /**
      * subscribe to an scripting object event (deprecated)
-     *
      * @deprecated use addEventListener instead
      * @param eventId unique id of the event. The format is <scripting object name>.<event name>
      * @param listener callback function to be called when the event is fired
@@ -77,7 +70,6 @@ export interface IMicroFEHost<AppObjects extends ScriptingObjects = Partial<Scri
     subscribe<T>(eventId: string | symbol, listener: SubscriptionListener<T>): string;
     /**
      * unsubscribe from an scripting object event (deprecated)
-     *
      * @deprecated use removeEventListener instead
      * @param token unique token returned by subscribe
      * @param eventId unique id of the event. The format is <scripting object name>.<event name>