@elliemae/pui-app-bridge 2.28.6 → 2.29.0-alpha.0

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

@@ -1,9 +1,9 @@
-import { Logger } from '@elliemae/pui-diagnostics';
-import { Events, ScriptingObjectTypes, IScriptingObjectProxy } from '@elliemae/pui-scripting-object';
-import { EventListeners, AddScriptingObjectParams, DispatchEventParam, EventOptions, ScriptingObjects } from '@elliemae/microfe-common';
-import { IMicroFEGuest } from './typings/guest.js';
-import { OpenAppParams } from './typings/host.js';
-import { ValueOf } from './typings/common.js';
+import type { Logger } from '@elliemae/pui-diagnostics';
+import { type Events, type ScriptingObjectTypes, type IScriptingObjectProxy } from '@elliemae/pui-scripting-object';
+import { type EventListeners, type AddScriptingObjectParams, type DispatchEventParam, type EventOptions, type ScriptingObjects } from '@elliemae/microfe-common';
+import type { IMicroFEGuest } from './typings/guest.js';
+import type { OpenAppParams } from './typings/host.js';
+import type { ValueOf } from './typings/common.js';
 /**
  * AppBridge constructor parameter
  */

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

@@ -1,4 +1,4 @@
-import { IMicroFEGuest } from './typings/guest.js';
+import type { IMicroFEGuest } from './typings/guest.js';
 export declare class CAppRegistry {
     #private;
     constructor();

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

@@ -1,4 +1,4 @@
-import { SecurityContext } from '../typings/common.js';
+import type { SecurityContext } from '../typings/common.js';
 /**
  * service configuration
  */

package/dist/types/lib/config/microFE.d.ts

@@ -1,5 +1,5 @@
-import { AppInfo } from '../typings/appInfo.js';
-import { CAppConfig } from './app.js';
+import type { AppInfo } from '../typings/appInfo.js';
+import { type CAppConfig } from './app.js';
 export declare class CMicroFEConfig {
     #private;
     init: ({ version, appConfig, }: {

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

@@ -1,5 +1,5 @@
-import { Logger } from '@elliemae/pui-diagnostics';
-import { IScriptingObject, Events } from '@elliemae/pui-scripting-object';
+import type { Logger } from '@elliemae/pui-diagnostics';
+import type { IScriptingObject, Events, IScriptingObjectProxy } from '@elliemae/pui-scripting-object';
 import type { EventListeners, Listener, SubscribeParam, UnsubscribeParam, DispatchEventParam, EventOptions, FilterCriteria } from '@elliemae/microfe-common';
 /**
  * details of an event listener
@@ -12,7 +12,7 @@ type EventListenerDetails = {
     /**
      * event listener
      */
-    callback: Listener<any, any, any, any>;
+    callback: Listener<IScriptingObjectProxy, Record<string, unknown>, Record<string, unknown>, unknown>;
     /**
      * subscription id
      */

package/dist/types/lib/loaders/script.d.ts

@@ -1,4 +1,4 @@
-import { Logger } from '@elliemae/pui-diagnostics';
+import type { Logger } from '@elliemae/pui-diagnostics';
 export declare const APP_SCRIPT_ID_PREFIX = "ice-script-";
 type LoadOptions = {
     name: string;

package/dist/types/lib/loaders/style.d.ts

@@ -1,4 +1,4 @@
-import { Logger } from '@elliemae/pui-diagnostics';
+import type { Logger } from '@elliemae/pui-diagnostics';
 export declare const APP_STYLE_ID_PREFIX = "ice-style-";
 type LoadOptions = {
     name: string;

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

@@ -1,9 +1,8 @@
-import { Events, ScriptingObjectTypes } from '@elliemae/pui-scripting-object';
-import { Logger } from '@elliemae/pui-diagnostics';
-import type { EventListeners, GuestContext, SubscribeParam, UnsubscribeParam } from '@elliemae/microfe-common';
-import { ScriptingObjectManager, ScriptingObjects } from '@elliemae/microfe-common';
-import { EventManager } from './eventManager.js';
-import { IMicroFEHost, AppWindowSize } from './typings/host.js';
+import type { Events, ScriptingObjectTypes } from '@elliemae/pui-scripting-object';
+import type { Logger } from '@elliemae/pui-diagnostics';
+import type { EventListeners, GuestContext, SubscribeParam, UnsubscribeParam, ScriptingObjectManager, ScriptingObjects } from '@elliemae/microfe-common';
+import type { EventManager } from './eventManager.js';
+import type { IMicroFEHost, AppWindowSize } from './typings/host.js';
 /**
  * Constructor parameters for the host application
  */

package/dist/types/lib/tests/scriptingObjects/analytics.d.ts

@@ -1,12 +1,12 @@
-import { IAnalytics, BAEvent, TimingOptions, PerfMark } from '@elliemae/pui-scripting-object';
+import type { IAnalytics, BAEvent, TimingOptions, PerfMark } from '@elliemae/pui-scripting-object';
 import { ScriptingObject } from '@elliemae/microfe-common';
 export declare class Analytics extends ScriptingObject implements IAnalytics {
     constructor();
-    deleteTimingEventSamplingRatio: (names: string[]) => void;
+    deleteTimingEventSamplingRatio: (_names: string[]) => void;
     getAllTimingEventSamplingRatios: () => {};
-    getTimingEventSamplingRatio: (names: string[]) => {};
-    setTimingEventSamplingRatio: (ratios: Record<string, number>) => void;
-    sendBAEvent: (event: BAEvent) => Promise<void>;
+    getTimingEventSamplingRatio: (_names: string[]) => {};
+    setTimingEventSamplingRatio: (_ratios: Record<string, number>) => void;
+    sendBAEvent: (_event: BAEvent) => Promise<void>;
     startTiming: (name: string, options: TimingOptions) => Promise<PerformanceMark>;
     endTiming: (start: string | PerfMark, options: TimingOptions) => Promise<void>;
 }

package/dist/types/lib/tests/scriptingObjects/appraisalServiceModule.d.ts

@@ -1,12 +1,15 @@
-import { IModule, Listener, Events, LogLevels, LogMessage } from '@elliemae/pui-scripting-object';
+import { type IModule, type Listener, type Events, type LogLevels, type LogMessage } from '@elliemae/pui-scripting-object';
 import { ScriptingObject, Event } from '@elliemae/microfe-common';
+export type AppraisalOnSavedEventParams = {
+    loanId: string;
+    tags?: string | string[];
+    creditScore?: number | string;
+};
 export type AppraisalServiceEvents = {
     'appraisalservice.onprecommit': Listener<AppraisalService, {
         loanId: string;
     }, Record<string, unknown>, boolean>;
-    'appraisalservice.onsaved': Listener<AppraisalService, {
-        loanId: string;
-    }, Record<string, unknown>, void>;
+    'appraisalservice.onsaved': Listener<AppraisalService, AppraisalOnSavedEventParams, Record<string, unknown>, void>;
 };
 export declare class AppraisalService extends ScriptingObject implements IModule {
     #private;
@@ -31,6 +34,6 @@ export declare class AppraisalService extends ScriptingObject implements IModule
     saveLoan: () => Promise<void>;
     commit: () => Promise<unknown>;
     delete: () => never;
-    log: (message: string | LogMessage, level: keyof typeof LogLevels) => Promise<void>;
+    log: (_message: string | LogMessage, _level: keyof typeof LogLevels) => Promise<void>;
     unload: () => Promise<void>;
 }

package/dist/types/lib/tests/scriptingObjects/global.d.ts

@@ -1,4 +1,4 @@
-import { Events, IGlobal } from '@elliemae/pui-scripting-object';
+import type { Events, IGlobal } from '@elliemae/pui-scripting-object';
 import { ScriptingObject, Event } from '@elliemae/microfe-common';
 export declare class Global extends ScriptingObject implements IGlobal {
     #private;

package/dist/types/lib/tests/server.d.ts

@@ -1 +1 @@
-export declare const initServer: () => import("msw/lib/glossary-2792c6da").K;
+export declare const initServer: () => import("msw/node").SetupServer;

package/dist/types/lib/tests/serverHandlers.d.ts

@@ -1,4 +1,4 @@
-import { RestHandler, DefaultBodyType, MockedRequest } from 'msw';
+import { type RestHandler, type DefaultBodyType, type MockedRequest } from 'msw';
 type Handlers = Array<RestHandler<MockedRequest<DefaultBodyType>>>;
 export declare const getServerHandlers: () => Handlers;
 export declare const serverHandlers: RestHandler<MockedRequest<DefaultBodyType>>[];

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

@@ -1,5 +1,8 @@
-import { rest } from 'msw';
-import { InitParams, MountParams } from '../index.js';
+import type { rest } from 'msw';
+import { ScriptingObject } from '@elliemae/microfe-common';
+import type { InitParams, MountParams } from '../index.js';
+import type { IMicroFEGuest } from '../typings/guest.js';
+import type { EMUI } from '../typings/window.js';
 export type Params = Parameters<Parameters<typeof rest.get>[1]>;
 export type TestGuestWindow = Window & typeof globalThis & {
     __TEST__: {
@@ -7,6 +10,65 @@ export type TestGuestWindow = Window & typeof globalThis & {
         mountOptions: MountParams;
     };
 };
+/** Minimal guest registration payload for registry tests. */
+export type MockGuestApp = Partial<Omit<IMicroFEGuest, 'guestWindow' | 'init' | 'mount' | 'unmount'>> & {
+    uuid: string;
+    init?: jest.Mock | (() => Promise<void>);
+    mount?: jest.Mock;
+};
+export type TestIframeWindow = Window & {
+    emui: EMUI;
+};
+export declare const getIframeWindow: (frame: HTMLIFrameElement) => TestIframeWindow;
+export declare const getEmuiApps: (emui: EMUI, appId: string) => Array<Omit<IMicroFEGuest, "guestWindow">>;
+export declare const setEmuiAppEntry: (emui: EMUI, appId: string, entry: MockGuestApp) => void;
+export declare const clearWindowEmui: () => void;
+/** Module scripting object shape used in self-initialize tests. */
+export type TestModuleScriptingObject = {
+    getParameters: () => Promise<{
+        moduleId: string;
+        homeRoute: string;
+    }>;
+    _setUnloadHandler?: (handler: () => Promise<void>) => void;
+};
+export declare const createTestModuleSO: () => ScriptingObject & TestModuleScriptingObject;
+export declare const expectInitHistoryShape: (history: InitParams["history"]) => void;
+export declare const expectInitThemeShape: (theme: InitParams["theme"]) => void;
+export declare const expectInitLoggerShape: (initLogger: InitParams["logger"]) => void;
+export declare const snapshotInitOptionsPayload: (initOptions: InitParams) => {
+    logger: undefined;
+    history: {
+        action: import("history").Action;
+        location: import("history").Location;
+    } | undefined;
+    theme: {
+        breakpoints: import("@elliemae/pui-theme").BreakPoints;
+        colors: import("node_modules/@elliemae/pui-theme/dist/types/lib/theme-type.js").Colors;
+        fontSizes: import("node_modules/@elliemae/pui-theme/dist/types/lib/theme-type.js").FontSizes;
+        fontWeights: import("node_modules/@elliemae/pui-theme/dist/types/lib/theme-type.js").FontWeights;
+        fonts: import("node_modules/@elliemae/pui-theme/dist/types/lib/theme-type.js").Fonts;
+        letterSpacings: import("node_modules/@elliemae/pui-theme/dist/types/lib/theme-type.js").LetterSpacings;
+        lineHeights: import("node_modules/@elliemae/pui-theme/dist/types/lib/theme-type.js").LineHeights;
+        shadows: {
+            xs: string;
+            s: string;
+            m: string;
+            l: string;
+            xl: string;
+        };
+        space: import("node_modules/@elliemae/pui-theme/dist/types/lib/theme-type.js").Space;
+        zIndex: import("node_modules/@elliemae/pui-theme/dist/types/lib/theme-type.js").ZIndex;
+    } | undefined;
+    host: import("../index.js").IMicroFEHost<Partial<import("@elliemae/pui-scripting-object").ScriptingObjectTypes>, import("@elliemae/pui-scripting-object").Events>;
+    hostName?: string;
+    hostUrl?: string;
+    manifestPath?: string;
+    homeRoute?: string;
+    initialRoute?: import("history").To;
+    prevState?: Record<string, unknown> | null;
+    hostBreakpoint?: import("@elliemae/pui-theme").BreakPoint;
+    hostViewportSize?: import("../typings/guest.js").ViewportSize;
+};
 export declare const getMajorMinorVersion: (version: string) => string;
 export declare const sendJS: (res: Params[1], ctx: Params[2], filePath: string) => Promise<import("msw").MockedResponse<import("msw").DefaultBodyType>>;
 export declare const sendJSText: (res: Params[1], ctx: Params[2], fileContent: string) => Promise<import("msw").MockedResponse<import("msw").DefaultBodyType>>;

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

@@ -1,4 +1,4 @@
-import { LaunchMode } from '../config/app.js';
+import type { LaunchMode } from '../config/app.js';
 export type AppInfo = {
     id: string;
     name: string;

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

@@ -1,4 +1,14 @@
+import type { CallerInfo, GuestContext } from '@elliemae/microfe-common';
 export type ValueOf<T> = T[keyof T];
+/** Context attached to scripting object function invocations. */
+export type CallContext = {
+    guest?: GuestContext;
+    callChain?: CallerInfo[];
+};
+/** Function that may carry host-verified caller context. */
+export type CallableWithCallContext = ((...args: unknown[]) => unknown) & {
+    callContext?: CallContext;
+};
 /**
  * security context under which the guest application is running
  */

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

@@ -1,10 +1,10 @@
-import { History, To } from 'history';
-import { DefaultTheme } from 'styled-components';
-import { Logger } from '@elliemae/pui-diagnostics';
-import { BreakPoint } from '@elliemae/pui-theme';
-import { ScriptingObjectTypes, Events } from '@elliemae/pui-scripting-object';
+import type { History, To } from 'history';
+import type { DefaultTheme } from 'styled-components';
+import type { Logger } from '@elliemae/pui-diagnostics';
+import type { BreakPoint } from '@elliemae/pui-theme';
+import type { ScriptingObjectTypes, Events } from '@elliemae/pui-scripting-object';
 import type { EventListeners, ScriptingObjects } from '@elliemae/microfe-common';
-import { IMicroFEHost } from './host.js';
+import type { IMicroFEHost } from './host.js';
 /**
  * Viewport size
  */

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

@@ -1,8 +1,8 @@
-import { History } from 'history';
-import { DefaultTheme } from 'styled-components';
-import { ScriptingObjectTypes, Events } from '@elliemae/pui-scripting-object';
+import type { History } from 'history';
+import type { DefaultTheme } from 'styled-components';
+import type { ScriptingObjectTypes, Events } from '@elliemae/pui-scripting-object';
 import type { EventListeners, ScriptingObjects, SubscribeParam, UnsubscribeParam } from '@elliemae/microfe-common';
-import { FrameOptions } from '../frame.js';
+import type { FrameOptions } from '../frame.js';
 export type AppWindowSize = {
     appId: string;
     size: {

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

@@ -1,2 +1,2 @@
-import { IScriptingObject } from '@elliemae/pui-scripting-object';
+import type { IScriptingObject } from '@elliemae/pui-scripting-object';
 export type ScriptingObjects = Record<string, IScriptingObject>;

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

@@ -1,7 +1,7 @@
-import { BreakPoint } from '@elliemae/pui-theme';
-import { Logger } from '@elliemae/pui-diagnostics';
-import { IMicroFEGuest } from './guest.js';
-import { IMicroFEHost } from './host.js';
+import { type BreakPoint } from '@elliemae/pui-theme';
+import type { Logger } from '@elliemae/pui-diagnostics';
+import type { IMicroFEGuest } from './guest.js';
+import type { IMicroFEHost } from './host.js';
 export type EMUI = {
     [key: string]: Omit<IMicroFEGuest, 'guestWindow'> | Omit<IMicroFEGuest, 'guestWindow'>[];
 } & {