@elliemae/pui-app-bridge 2.9.9 → 2.17.0

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

@@ -1,16 +1,8 @@
 import { History } from 'history';
 import { DefaultTheme } from 'styled-components';
 import { ScriptingObjectTypes, Events } from '@elliemae/pui-scripting-object';
-import type { EventListeners } from '@elliemae/microfe-common';
-import { ScriptingObjects, SubscribeParam, UnsubscribeParam } from './common.js';
+import type { EventListeners, ScriptingObjects, SubscribeParam, UnsubscribeParam } from '@elliemae/microfe-common';
 import { FrameOptions } from '../frame.js';
-/**
- * event listner callback function
- * @typeParam T - type of the data
- * @param message - message
- * @param data - data
- */
-export type SubscriptionListener<T> = (message: string, data?: T) => void;
 export type AppWindowSize = {
     appId: string;
     size: {
@@ -22,11 +14,34 @@ export type AppWindowSize = {
  * Parameters to open a guest application
  */
 export type OpenAppParams = {
+    /**
+     * Unique identifier for the application
+     * This should be a globally unique identifier to avoid conflicts
+     * across different applications in the micro frontend ecosystem.
+     */
     id: string;
+    /**
+     * iframe options for the application
+     */
     frameOptions?: Partial<FrameOptions>;
+    /**
+     * browser history object to use for navigation
+     */
     history?: History;
+    /**
+     * ui theme for the application
+     */
     theme?: DefaultTheme;
-    allowedScriptingObjects?: string[];
+    /**
+     * home route for the application
+     */
+    homeRoute?: string;
+    /**
+     * default route to navigate to when the application is opened.
+     * by default it is the home route defined by the application.
+     * This setting is useful only when the application doesn't share parent history
+     */
+    initialRoute?: string;
 };
 /**
  * Interface to connect and communicate with parent host
@@ -38,41 +53,26 @@ export interface IMicroFEHost<AppObjects extends ScriptingObjects = Partial<Scri
      * application release version
      */
     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
-     * @returns token to be used to unsubscribe
+     * add listener to the scripting object event
+     * @param {SubscribeParam<EventId, EventType>} params - parameters to add event listener
+     * @returns subscription id
      */
-    subscribe<T>(eventId: string | symbol, listener: SubscriptionListener<T>): string;
+    subscribe: <EventId extends Extract<keyof AppEvents, string>>(params: SubscribeParam<EventId, AppEvents[EventId]>) => 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]
+     * removes listener from the scripting object event
+     * @param {UnsubscribeParam<EventId>} params - parameters to remove event listener
      */
-    unsubscribe(token: string, eventId?: string): void;
+    unsubscribe: <EventId extends Extract<keyof AppEvents, string>>(params: UnsubscribeParam<EventId>) => void;
 }

package/dist/types/lib/typings/window.d.ts

@@ -3,7 +3,7 @@ import { Logger } from '@elliemae/pui-diagnostics';
 import { IMicroFEGuest } from './guest.js';
 import { IMicroFEHost } from './host.js';
 export type EMUI = {
-    [key: string]: Omit<IMicroFEGuest, 'guestWindow'>;
+    [key: string]: Omit<IMicroFEGuest, 'guestWindow'> | Omit<IMicroFEGuest, 'guestWindow'>[];
 } & {
     _BASE_PATH: string;
     _ASSET_PATH: string;
@@ -11,6 +11,11 @@ export type EMUI = {
     MicroAppHost?: IMicroFEHost;
     logger?: Logger;
     appId?: string;
+    registerApp?: (options: {
+        appId: string;
+        app: IMicroFEGuest;
+    }) => void;
+    unregisterApp?: (instanceId: string) => void;
 };
 declare global {
     interface Window {

package/dist/types/lib/utils.d.ts

@@ -1,4 +1,11 @@
+import { IApplication } from '@elliemae/pui-scripting-object';
+import { Logger } from '@elliemae/pui-diagnostics';
 export declare const removeDoubleSlash: (url: string) => string;
 export declare const getAbsoluteUrl: (url: string) => string;
 export declare const appendTrailingSlash: (url: string) => string;
+export declare const appendPath: (base: string, path: string) => string;
 export declare const isJSDOM: () => boolean;
+export declare const startKeepSessionAlive: ({ appObj, logger, }: {
+    appObj: IApplication;
+    logger: Logger;
+}) => void;