@elliemae/pui-scripting-object 1.14.0 → 1.16.0

package/dist/cjs/{events.js → event.js}

@@ -12,5 +12,5 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var events_exports = {};
-module.exports = __toCommonJS(events_exports);
+var event_exports = {};
+module.exports = __toCommonJS(event_exports);

package/dist/cjs/index.js

@@ -3,6 +3,10 @@ var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
 var __copyProps = (to, from, except, desc) => {
   if (from && typeof from === "object" || typeof from === "function") {
     for (let key of __getOwnPropNames(from))
@@ -14,8 +18,13 @@ var __copyProps = (to, from, except, desc) => {
 var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var lib_exports = {};
+__export(lib_exports, {
+  IEvent: () => import_event.IEvent,
+  IScriptingObject: () => import_scriptingObject.IScriptingObject,
+  IScriptingObjectProxy: () => import_scriptingObject.IScriptingObjectProxy,
+  Listener: () => import_event.Listener
+});
 module.exports = __toCommonJS(lib_exports);
-__reExport(lib_exports, require("./script.js"), module.exports);
 __reExport(lib_exports, require("./objects/analytics.js"), module.exports);
 __reExport(lib_exports, require("./objects/application.js"), module.exports);
 __reExport(lib_exports, require("./objects/auth.js"), module.exports);
@@ -35,3 +44,5 @@ __reExport(lib_exports, require("./objects/transactionTemplate.js"), module.expo
 __reExport(lib_exports, require("./objects/userAccessRights.js"), module.exports);
 __reExport(lib_exports, require("./objects/view.js"), module.exports);
 __reExport(lib_exports, require("./objects/shared.js"), module.exports);
+var import_event = require("./event.js");
+var import_scriptingObject = require("./scriptingObject.js");

package/dist/cjs/remotingScriptingObject.js

@@ -0,0 +1,16 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var remotingScriptingObject_exports = {};
+module.exports = __toCommonJS(remotingScriptingObject_exports);

package/dist/cjs/{script.js → scriptingObject.js}

@@ -12,5 +12,5 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var script_exports = {};
-module.exports = __toCommonJS(script_exports);
+var scriptingObject_exports = {};
+module.exports = __toCommonJS(scriptingObject_exports);

package/dist/cjs/{scriptingObjectTypes.js → scriptingObjectList.js}

@@ -12,5 +12,5 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var scriptingObjectTypes_exports = {};
-module.exports = __toCommonJS(scriptingObjectTypes_exports);
+var scriptingObjectList_exports = {};
+module.exports = __toCommonJS(scriptingObjectList_exports);

package/dist/esm/index.js

@@ -1,4 +1,3 @@
-export * from "./script.js";
 export * from "./objects/analytics.js";
 export * from "./objects/application.js";
 export * from "./objects/auth.js";
@@ -18,3 +17,11 @@ export * from "./objects/transactionTemplate.js";
 export * from "./objects/userAccessRights.js";
 export * from "./objects/view.js";
 export * from "./objects/shared.js";
+import { IEvent, Listener } from "./event.js";
+import { IScriptingObjectProxy, IScriptingObject } from "./scriptingObject.js";
+export {
+  IEvent,
+  IScriptingObject,
+  IScriptingObjectProxy,
+  Listener
+};

package/dist/types/event.d.ts

@@ -0,0 +1,43 @@
+import { IScriptingObjectProxy, IScriptingObject } from './scriptingObject.js';
+/**
+ * callback for event
+ */
+export declare type Listener<SO extends IScriptingObjectProxy, Params extends Record<string, unknown>, Options extends Record<string, unknown>, ReturnType> = ({ obj, eventName, eventParams, eventOptions, }: {
+    obj: SO;
+    eventName: string;
+    eventParams: Params;
+    eventOptions: Options;
+}) => ReturnType;
+/**
+ * base class for events
+ */
+export interface IEvent<SO extends IScriptingObjectProxy, Params extends Record<string, unknown>, Options extends Record<string, unknown>, ReturnType> {
+    /**
+     * name of the event
+     */
+    readonly name: string;
+    /**
+     * id of the scripting object from where the event was triggered
+     */
+    readonly objectId: string;
+    /**
+     * event requiers a response from its listeners
+     */
+    readonly requiresFeedback: boolean;
+    /**
+     * parameters associated with the event
+     */
+    readonly params: Params;
+    /**
+     * scripting object from where the event was triggered
+     */
+    readonly scriptingObject: IScriptingObject;
+    /**
+     * subscribe to the event
+     */
+    subscribe: (callback: Listener<SO, Params, Options, ReturnType>) => string;
+    /**
+     * unsubscribe from the event
+     */
+    unsubscribe: (subscriptionId: string) => void;
+}

package/dist/types/index.d.ts

@@ -1,4 +1,3 @@
-export * from './script.js';
 export * from './objects/analytics.js';
 export * from './objects/application.js';
 export * from './objects/auth.js';
@@ -18,5 +17,6 @@ export * from './objects/transactionTemplate.js';
 export * from './objects/userAccessRights.js';
 export * from './objects/view.js';
 export * from './objects/shared.js';
-export type { ScriptingObjectEvents } from './events.js';
-export type { ScriptingObjectTypes } from './scriptingObjectTypes.js';
+export { IEvent, Listener } from './event.js';
+export { IScriptingObjectProxy, IScriptingObject } from './scriptingObject.js';
+export type { ScriptingObjects } from './scriptingObjectList.js';

package/dist/types/objects/application.d.ts

@@ -1,3 +1,8 @@
+import { IEvent } from '../event.js';
+import { IScriptingObject } from '../scriptingObject.js';
+/**
+ * Log levels
+ */
 export declare enum LogLevel {
     TRACE = "TRACE",
     DEBUG = "DEBUG",
@@ -7,18 +12,39 @@ export declare enum LogLevel {
     ERROR = "ERROR",
     FATAL = "FATAL"
 }
+/**
+ * metadata about the application
+ */
 export declare type AppInfo = {
     id: string;
     name: string;
 };
+/**
+ * Application extension type
+ */
 export declare enum ApplicationExtensionType {
     TOOL = "TOOL",
     MENU = "MENU"
 }
+/**
+ * metadata about the application extension
+ */
 export declare type ApplicationExtension = {
+    /**
+     * type of application extension
+     */
     type: ApplicationExtensionType;
+    /**
+     * display text of the application extension
+     */
     text: string;
+    /**
+     * url where the application extension is hosted
+     */
     url: string;
+    /**
+     * custom options for the application extension
+     */
     options?: Record<string, string>;
 };
 /**
@@ -36,9 +62,6 @@ export declare enum NavigationType {
  * navigation options
  */
 export declare type NavigationOptions = {
-    /**
-     *
-     */
     target: string;
     type: NavigationType;
     context?: Record<string, string>;
@@ -47,6 +70,9 @@ export declare type OpenOptions = {
     target: string;
     type?: string;
 };
+/**
+ * size of the modal
+ */
 export declare enum ModalSize {
     SMALL = "sm",
     MEDIUM = "md",
@@ -84,10 +110,56 @@ export declare type PrintOptions = {
      */
     blob: Blob;
 };
+/**
+ * event fired when the user logs in
+ */
+export interface IApplicationLoginEvent extends IEvent<IApplication, {
+    userId: string;
+}, Record<string, unknown>, void> {
+    /**
+     * event name
+     */
+    readonly name: 'Login';
+    /**
+     * scripting object from where the event is fired
+     */
+    readonly objectId: 'Application';
+    /**
+     * event does not require feedback from listeners
+     */
+    readonly requiresFeedback: false;
+}
+/**
+ * event fired when an action is completed. actions are executed through the performAction method
+ */
+export interface IApplicationActionCompletedEvent extends IEvent<IApplication, {
+    name: string;
+}, Record<string, unknown>, void> {
+    /**
+     * event name
+     */
+    readonly name: 'ActionCompleted';
+    /**
+     * scripting object from where the event is fired
+     */
+    readonly objectId: 'Application';
+    /**
+     * event does not require feedback from listeners
+     */
+    readonly requiresFeedback: false;
+}
 /**
  * Allows access to application-level UI elements, behaviors and events
  */
-export interface IApplication {
+export interface IApplication extends IScriptingObject {
+    /**
+     * notifies user login
+     */
+    readonly Login: IApplicationLoginEvent;
+    /**
+     * notifies action completion
+     */
+    readonly ActionCompleted: IApplicationActionCompletedEvent;
     /**
      * Gets descriptor for the Application
      *
@@ -190,25 +262,3 @@ export interface IApplication {
      */
     log(message: string, logLevel: LogLevel): Promise<void>;
 }
-/**
- * event handler that handles user login event
- *
- * @param userId unique identifier of the user
- */
-export declare type AppLoginListener = (userId: string) => void;
-/**
- * event handler that handles action completed event
- *
- * @param name action name
- */
-export declare type AppActionCompletedListener = (name: string) => void;
-export declare type ApplicationEvents = {
-    /**
-     * event fired when the user logs in
-     */
-    'application.login': AppLoginListener;
-    /**
-     * event fired when an action is completed. actions are executed through the performAction method
-     */
-    'application.actionCompleted': AppActionCompletedListener;
-};

package/dist/types/objects/auth.d.ts

@@ -1,4 +1,5 @@
-import { UserAccessRights } from './userAccessRights';
+import { IScriptingObject } from '../scriptingObject.js';
+import { UserAccessRights } from './userAccessRights.js';
 export declare type Personas = {
     entityId: string;
     entityType: string;
@@ -70,7 +71,7 @@ export declare type TokenInfo = {
 /**
  * Methods to get information about the user and access token
  */
-export interface IAuth {
+export interface IAuth extends IScriptingObject {
     /**
      * Deprecated: use getAccessToken method instead
      *

package/dist/types/objects/form.d.ts

@@ -1,11 +1,59 @@
+import { IEvent } from '../event.js';
+import { IScriptingObject } from '../scriptingObject.js';
 export declare type FormDescriptor = {
     id: string;
     name: string;
 };
+/**
+ * event to notify form load operation
+ */
+export interface IFormLoadEvent extends IEvent<IForm, {
+    id: string;
+}, Record<string, unknown>, void> {
+    /**
+     * event name
+     */
+    readonly name: 'Load';
+    /**
+     * scripting object from where the event is fired
+     */
+    readonly objectId: 'Form';
+    /**
+     * event does not require feedback from listeners
+     */
+    readonly requiresFeedback: false;
+}
+/**
+ * event to notify form unload operation
+ */
+export interface IFormUnLoadEvent extends IEvent<IForm, {
+    id: string;
+}, Record<string, unknown>, void> {
+    /**
+     * event name
+     */
+    readonly name: 'UnLoad';
+    /**
+     * scripting object from where the event is fired
+     */
+    readonly objectId: 'Form';
+    /**
+     * event does not require feedback from listeners
+     */
+    readonly requiresFeedback: false;
+}
 /**
  * Methods to get information about the custom form
  */
-export interface IForm {
+export interface IForm extends IScriptingObject {
+    /**
+     * event fired when the form is loaded
+     */
+    readonly Load: IFormLoadEvent;
+    /**
+     * event fired when the form is unloaded
+     */
+    readonly UnLoad: IFormUnLoadEvent;
     /**
      * get metadata of the form
      *
@@ -18,30 +66,5 @@ export interface IForm {
      * @param id form id
      * @returns form input control object
      */
-    getControl(id: string): Promise<any>;
+    getControl(id: string): Promise<unknown>;
 }
-/**
- * event handler for form load event
- *
- * @param id unique id of the form that is loaded
- */
-export declare type FormLoadListener = (id: string) => void;
-/**
- * event handler for form unload event
- *
- * @param id unique id of the form that is unloaded
- */
-export declare type FormUnloadListener = (id: string) => void;
-/**
- * events that notifies the form's lifecycle
- */
-export declare type FormEvents = {
-    /**
-     * form is loaded and ready for user interaction
-     */
-    'form.load': FormLoadListener;
-    /**
-     * form is unloaded and no longer available for user interaction
-     */
-    'form.unload': FormUnloadListener;
-};

package/dist/types/objects/global.d.ts

@@ -1,3 +1,24 @@
+import { IEvent } from '../event.js';
+import { IScriptingObject } from '../scriptingObject.js';
+/**
+ * event to notify change in global state
+ */
+export interface IGlobalChangeEvent extends IEvent<IGlobal, {
+    key: string;
+}, Record<string, unknown>, void> {
+    /**
+     * event name
+     */
+    readonly name: 'Change';
+    /**
+     * scripting object from where the event is fired
+     */
+    readonly objectId: 'Global';
+    /**
+     * event does not require feedback from listeners
+     */
+    readonly requiresFeedback: false;
+}
 /**
  * The Global object allows for data to be shared between custom forms/tools/plugins within a user's session.
  * Unlike the Session scripting object, where data is isolated to be visible/accessible only by the form/plugin that writes the variables,
@@ -14,34 +35,23 @@
  * This will ensure that no guest can consume more than 250 KB of sessionStorage
  *
  */
-export interface IGlobal {
+export interface IGlobal extends IScriptingObject {
+    /**
+     * event fired when the global state changes
+     */
+    readonly Change: IGlobalChangeEvent;
     /**
      * set a value in the global store
      *
      * @param key unique key to identify the value
      * @param value value to be stored
      */
-    set(key: string, value: any): Promise<void>;
+    set(key: string, value: unknown): Promise<void>;
     /**
      * get a value from the global store
      *
      * @param key unique key to identify the value
      * @returns value stored in the global store
      */
-    get(key: string): Promise<any>;
+    get(key: string): Promise<unknown>;
 }
-/**
- * event handler for global state change event
- *
- * @param key name of the key for which the value changed
- */
-export declare type GlobalStateChangeListener = (key: string) => void;
-/**
- * events fired from Global scripting object
- */
-export declare type GlobalEvents = {
-    /**
-     * event fired when a value changes in the global store
-     */
-    'global.change': GlobalStateChangeListener;
-};

package/dist/types/objects/http.d.ts

@@ -1,9 +1,10 @@
+import { IScriptingObject } from '../scriptingObject.js';
 /**
  * Provides methods to make call-outs to to external systems via HTTPS.
  * By exposing this object from the host, it ensures that the call will bear the "Origin" header of the host application.
  * This is critical for situations where the guest's code is running in a strict-mode sandbox (where the "allowSameOrigin" flag is false).
  */
-export interface IHttp {
+export interface IHttp extends IScriptingObject {
     /**
      * get http request
      *

package/dist/types/objects/loan.d.ts

@@ -1,3 +1,5 @@
+import { IEvent } from '../event.js';
+import { IScriptingObject } from '../scriptingObject.js';
 /**
  * option name and its value
  */
@@ -14,17 +16,214 @@ export declare type FieldOptions = {
 /**
  * v3 loan object
  */
-export declare type LoanObject = Record<string, any>;
+export declare type LoanObject = Record<string, unknown>;
 export declare enum LoanLevelActions {
     UPDATE_CORRESPONDENT_BALANCE = "updateCorrespondentBalance",
     UPDATE_CORRESPONDENT_FEES = "updateCorrespondentFees",
     COPY_ITEMIZATION_TO_STATE_DISCLOSURE = "copyItemizationToStateDisclosure",
     CALCULATE_EEM_MORTGAGE = "calculateEEMMortgage"
 }
+/**
+ * event to notify loan precommit operation
+ */
+export interface ILoanPreCommitEvent extends IEvent<ILoan, {
+    cause: string;
+}, Record<string, unknown>, boolean> {
+    /**
+     * event name
+     */
+    readonly name: 'PreCommit';
+    /**
+     * scripting object from where the event is fired
+     */
+    readonly objectId: 'Loan';
+    /**
+     * event requires feedback from listeners
+     */
+    readonly requiresFeedback: true;
+}
+/**
+ * event to notify loan committed operation
+ */
+export interface ILoanCommittedEvent extends IEvent<ILoan, {
+    cause: string;
+}, Record<string, unknown>, void> {
+    /**
+     * event name
+     */
+    readonly name: 'Committed';
+    /**
+     * scripting object from where the event is fired
+     */
+    readonly objectId: 'Loan';
+    /**
+     * event does not require feedback from listeners
+     */
+    readonly requiresFeedback: false;
+}
+/**
+ * event to notify loan change operation
+ */
+export interface ILoanChangeEvent extends IEvent<ILoan, Record<string, never>, Record<string, unknown>, void> {
+    /**
+     * event name
+     */
+    readonly name: 'Chanage';
+    /**
+     * scripting object from where the event is fired
+     */
+    readonly objectId: 'Loan';
+    /**
+     * event does not require feedback from listeners
+     */
+    readonly requiresFeedback: false;
+}
+/**
+ * event to notify loan sync operation
+ */
+export interface ILoanSyncEvent extends IEvent<ILoan, Record<string, never>, Record<string, unknown>, void> {
+    /**
+     * event name
+     */
+    readonly name: 'Sync';
+    /**
+     * scripting object from where the event is fired
+     */
+    readonly objectId: 'Loan';
+    /**
+     * event does not require feedback from listeners
+     */
+    readonly requiresFeedback: false;
+}
+/**
+ * event to notify loan open operation
+ */
+export interface ILoanOpenEvent extends IEvent<ILoan, Record<string, never>, Record<string, unknown>, void> {
+    /**
+     * event name
+     */
+    readonly name: 'Open';
+    /**
+     *  scripting object from where the event is fired
+     */
+    readonly objectId: 'Loan';
+    /**
+     * event does not require feedback from listeners
+     */
+    readonly requiresFeedback: false;
+}
+/**
+ * event to notify loan close operation
+ */
+export interface ILoanCloseEvent extends IEvent<ILoan, Record<string, never>, Record<string, unknown>, void> {
+    /**
+     * event name
+     */
+    readonly name: 'Close';
+    /**
+     * scripting object from where the event is fired
+     */
+    readonly objectId: 'Loan';
+    /**
+     * event does not require feedback from listeners
+     */
+    readonly requiresFeedback: false;
+}
+/**
+ * event to notify loan milestone completed operation
+ */
+export interface ILoanMilestoneCompletedEvent extends IEvent<ILoan, {
+    name: string;
+}, Record<string, unknown>, void> {
+    /**
+     * event name
+     */
+    readonly name: 'MilestoneCompleted';
+    /**
+     * scripting object from where the event is fired
+     */
+    readonly objectId: 'Loan';
+    /**
+     * event does not require feedback from listeners
+     */
+    readonly requiresFeedback: false;
+}
+/**
+ * event to notify loan pre milestone complete operation
+ */
+export interface ILoanPreMilestoneCompleteEvent extends IEvent<ILoan, {
+    name: string;
+}, Record<string, unknown>, boolean> {
+    /**
+     * event name
+     */
+    readonly name: 'PreMilestoneComplete';
+    /**
+     * scripting object from where the event is fired
+     */
+    readonly objectId: 'Loan';
+    /**
+     * event requires feedback from listeners
+     */
+    readonly requiresFeedback: true;
+}
+/**
+ * event to notify loan application selected operation
+ */
+export interface ILoanApplicationSelectedEvent extends IEvent<ILoan, Record<string, never>, Record<string, unknown>, void> {
+    /**
+     * event name
+     */
+    readonly name: 'ApplicationSelected';
+    /**
+     * scripting object from where the event is fired
+     */
+    readonly objectId: 'Loan';
+    /**
+     * event does not require feedback from listeners
+     */
+    readonly requiresFeedback: false;
+}
 /**
  * Methods for interacting with an open loan in the application
  */
-export interface ILoan {
+export interface ILoan extends IScriptingObject {
+    /**
+     * event fired when the loan is ready to commit
+     */
+    readonly PreCommit: ILoanPreCommitEvent;
+    /**
+     * event fired when the loan is committed
+     */
+    readonly Committed: ILoanCommittedEvent;
+    /**
+     * event fired when the loan is changed
+     */
+    readonly Change: ILoanChangeEvent;
+    /**
+     * event fired when the loan is synced
+     */
+    readonly Sync: ILoanSyncEvent;
+    /**
+     * event fired when the loan is opened
+     */
+    readonly Open: ILoanOpenEvent;
+    /**
+     * event fired when the loan is closed
+     */
+    readonly Close: ILoanCloseEvent;
+    /**
+     * event fired when the loan milestone is completed
+     */
+    readonly MilestoneCompleted: ILoanMilestoneCompletedEvent;
+    /**
+     * event fired when the loan is ready to complete milestone
+     */
+    readonly PreMilestoneComplete: ILoanPreMilestoneCompleteEvent;
+    /**
+     * event fired when the loan application is selected
+     */
+    readonly ApplicationSelected: ILoanApplicationSelectedEvent;
     /**
      * Get complete Loan object
      *
@@ -143,94 +342,3 @@ export interface ILoan {
     getCollection(name: string): Promise<Record<string, string>>;
     getLockSnapshot(): Promise<Record<string, string>>;
 }
-/**
- * event handler for loan precommit event
- *
- * @param cause cause of precommit event
- * @returns true if precommit is allowed, false otherwise
- */
-export declare type LoanPreCommitListener = (cause: string) => boolean;
-/**
- * event handler for loan commited event
- *
- * @param cause cause of commit event
- */
-export declare type LoanCommittedListener = (cause: string) => void;
-/**
- * event handler for loan data change event
- */
-export declare type LoanChangeListener = () => void;
-/**
- * event handler for loan sync event
- */
-export declare type LoanSyncListener = () => void;
-/**
- * event handler for loan open event
- */
-export declare type LoanOpenListener = () => void;
-/**
- * event handler for loan close event
- *
- * @returns true if loan close is allowed, false otherwise
- */
-export declare type LoanCloseListener = () => boolean;
-/**
- * event handler for loan milestone completed event
- *
- * @param name milestone name
- */
-export declare type LoanMilestoneCompletedListener = (name: string) => void;
-/**
- * event handler for loan pre milestone complete event
- *
- * @returns true if milestone complete is allowed, false otherwise
- */
-export declare type LoanPreMilestoneCompleteListener = (name: string) => boolean;
-/**
- * event handler for loan application selected event
- */
-export declare type LoanApplicationSelectedListener = () => void;
-/**
- * events supported by Loan scripting object
- */
-export declare type LoanEvents = {
-    /**
-     * event is fired prior to saving any pending changes to the loan.
-     * The guest can use this event to perform custom validation and,
-     * via the feedback mechanism, prevent the loan from being saved
-     */
-    'loan.precommit': LoanPreCommitListener;
-    /**
-     * event is fired after pending changes to the loan are committed
-     */
-    'loan.committed': LoanCommittedListener;
-    /**
-     * event is fired for each change made by the user in the UI
-     */
-    'loan.change': LoanChangeListener;
-    /**
-     * event is fired after the loan is sync'ed within any saved state made outside of the user's workspace.
-     */
-    'loan.sync': LoanSyncListener;
-    /**
-     * event is fired after the loan is opened and ready for user interaction
-     */
-    'loan.open': LoanOpenListener;
-    /**
-     * event is fired just prior to closing the loan in the UI
-     */
-    'loan.close': LoanCloseListener;
-    /**
-     * event is fired after a milestone is completed by the user and committed to the server
-     */
-    'loan.milestoneCompleted': LoanMilestoneCompletedListener;
-    /**
-     * event is fired when the user attempts to complete a milestone and allows for custom validation,
-     * and cancellation, of the process
-     */
-    'loan.premilestoneComplete': LoanPreMilestoneCompleteListener;
-    /**
-     * event is fired when a borrower pair changes
-     */
-    'loan.applicationselected': LoanApplicationSelectedListener;
-};

package/dist/types/objects/memStorage.d.ts

@@ -1,3 +1,4 @@
+import { IScriptingObject } from '../scriptingObject.js';
 /**
  * get or set values in host application javascript memory
  * values stored in memory are not persisted across sessions
@@ -7,7 +8,7 @@
  * that means, two microapps can use same key to store different values. Thier values will not collide.
  *
  */
-export interface IMemStorage {
+export interface IMemStorage extends IScriptingObject {
     /**
      * set a value in memory for given key
      *
@@ -15,12 +16,12 @@ export interface IMemStorage {
      * @param key unique key to store the value
      * @param value value to be stored. value should be JSON serializable
      */
-    set(clientId: string, key: string, value: any): Promise<void>;
+    set(clientId: string, key: string, value: unknown): Promise<void>;
     /**
      * get a value from memory for given key and microapp id
      *
      * @param key unique key to retrieve the value
      * @returns value stored in memory
      */
-    get(clientId: string, key: string): Promise<any>;
+    get(clientId: string, key: string): Promise<unknown>;
 }

package/dist/types/objects/module.d.ts

@@ -1,7 +1,34 @@
+import { IEvent } from '../event.js';
+import { IScriptingObject } from '../scriptingObject.js';
+/**
+ * Module unloading event
+ */
+export interface IModuleUnloadingEvent extends IEvent<IModule, Record<string, never>, Record<string, unknown>, boolean> {
+    /**
+     * event name
+     */
+    readonly name: 'Unloading';
+    /**
+     * scripting object from where the event was triggered
+     */
+    readonly objectId: 'Module';
+    /**
+     * response needed from event listeners
+     */
+    readonly requiresFeedback: true;
+}
 /**
  * Exposes MicroApp module specific methods
+ * This is an abstract interface and needs to be extended by the module
+ * users should avoid creating Scripting object with name 'Module'
  */
-export interface IModule {
+export interface IModule extends IScriptingObject {
+    /**
+     * event fired when the module is unloading
+     *
+     * @returns true if the module can be unloaded, false otherwise
+     */
+    readonly Unloading: IModuleUnloadingEvent;
     /**
      * get microapp module-specific capabilities or settings defined by the host application. Helps to define the style and/or behavior of the module
      *
@@ -21,21 +48,3 @@ export interface IModule {
      */
     unload(): Promise<void>;
 }
-/**
- * event handler that handles module unload event
- *
- * @param id unique id of the app that is being unloaded
- * @returns true if the module can be unloaded, false otherwise
- */
-export declare type ModuleUnLoadingListener = (appId: string) => boolean;
-/**
- * events that notifies the module's lifecycle
- */
-export declare type ModuleEvents = {
-    /**
-     * event fired when the module is unloading
-     *
-     * @returns true if the module can be unloaded, false otherwise
-     */
-    'module.unloading': ModuleUnLoadingListener;
-};

package/dist/types/objects/route.d.ts

@@ -1,7 +1,8 @@
 import { To } from 'history';
+import { IScriptingObject } from '../scriptingObject.js';
 /**
  * Methods to view, modify & get notified about parent window url navigation
  */
-export interface IRoute {
-    navigate(path: To, state?: any): Promise<void>;
+export interface IRoute extends IScriptingObject {
+    navigate(path: To, state?: unknown): Promise<void>;
 }

package/dist/types/objects/service.d.ts

@@ -1,3 +1,4 @@
+import { IScriptingObject } from '../scriptingObject.js';
 /**
  * type of service setup categories
  */
@@ -39,7 +40,7 @@ declare type OpenOptions = {
 /**
  * Methods for interacting with the Service orders
  */
-export interface IService {
+export interface IService extends IScriptingObject {
     /**
      * Get the service setup for the current user and loan
      *

package/dist/types/objects/session.d.ts

@@ -1,7 +1,8 @@
+import { IScriptingObject } from '../scriptingObject.js';
 /**
  * store and retrieves values in host application's session storage
  */
-export interface ISession {
+export interface ISession extends IScriptingObject {
     /**
      * set a value in the session storage
      *

package/dist/types/objects/transaction.d.ts

@@ -1,3 +1,4 @@
+import { IScriptingObject } from '../scriptingObject.js';
 import { ResourceDetails, TransactionDetails, TransactionEvent, OriginDetails, ResourceOptions } from './shared.js';
 /**
  * details about the transaction that is created / updated
@@ -16,7 +17,7 @@ export declare type TransactionInfo = {
  * update an existing transaction,
  * create events/messages for a transaction, and more.
  */
-export interface ITransaction {
+export interface ITransaction extends IScriptingObject {
     /**
      * Provide the necessary information for your application's user-interface to:
      *  Access transaction origination information and bootstrap its user interaction

package/dist/types/objects/transactionTemplate.d.ts

@@ -1,3 +1,4 @@
+import { IScriptingObject } from '../scriptingObject.js';
 /**
  * Transaction request object
  */
@@ -14,7 +15,7 @@ export declare type TransactionRequest = {
      * This can be used to select from which bureaus to order a borrower's credit score for a Credit integration,
      * or how many days of income information to pull for a borrower in the case of a Verification of Income/Employment integration
      */
-    options?: Record<string, any>;
+    options?: Record<string, unknown>;
 };
 /**
  * Transaction Template object
@@ -43,7 +44,7 @@ export declare type TransactionTemplateDetails = {
  * for enabling Lender administrators to create transaction request templates,
  * which they can associate with a 1-click/automated ordering business condition set.
  */
-export interface ITransactionTemplate {
+export interface ITransactionTemplate extends IScriptingObject {
     /**
      * Discover if your administrator-facing view has been rendered in the context of an existing
      * transaction request template (in edit mode) or a new transaction request template (in create mode).

package/dist/types/objects/transactionv2.d.ts

@@ -1,3 +1,4 @@
+import { IScriptingObject } from '../scriptingObject.js';
 import { OriginDetails, TransactionDetails, TransactionEvent, ResourceDetails, ResourceOptions } from './shared.js';
 /**
  * reason for completing the user interaction with the transaction
@@ -24,7 +25,7 @@ export declare enum CompleteReason {
  * update an existing transaction,
  * create events/messages for a transaction, and more.
  */
-export interface ITransactionV2 {
+export interface ITransactionV2 extends IScriptingObject {
     /**
      * create new transaction
      *

package/dist/types/objects/userAccessRights.d.ts

@@ -249,7 +249,7 @@ export declare type Pipeline = {
     access: boolean;
     pipelineTasks: string[];
     pipelineViews: PipelineView[];
-    nonAccessibleColumns: any[];
+    nonAccessibleColumns: unknown[];
 };
 export declare type PipelineView = {
     entityId: string;
@@ -344,9 +344,9 @@ export declare type ConditionType = {
 export declare type LoConnectTasks = {
     access: boolean;
     rights: string[];
-    customForms: any[];
-    customTools: any[];
-    globalApplications: any[];
+    customForms: unknown[];
+    customTools: unknown[];
+    globalApplications: unknown[];
     standardWebForms: StandardWebForm[];
 };
 export declare type StandardWebForm = {

package/dist/types/objects/view.d.ts

@@ -1,4 +1,6 @@
 import { BreakPoint } from '@elliemae/pui-theme';
+import { IEvent } from '../event.js';
+import { IScriptingObject } from '../scriptingObject.js';
 /**
  * window viewport size
  */
@@ -7,37 +9,61 @@ export declare type ViewportSize = {
     height: number;
 };
 /**
- * Methods view, modify parent's window attributes
+ * event to notify window viewport resize operation
  */
-export interface IView {
+export interface IViewResizeEvent extends IEvent<IView, {
+    entries: ResizeObserverEntry;
+}, Record<string, unknown>, void> {
     /**
-     * Get the current breakpoint of the parent window
+     * event name
      */
-    getBreakpoint(): Promise<BreakPoint>;
+    readonly name: 'Resize';
     /**
-     * Get the current viewport size of the parent window
+     * scripting object from where the event is fired
      */
-    getViewPortSize(): Promise<ViewportSize>;
+    readonly objectId: 'View';
+    /**
+     * event does not require feedback from listeners
+     */
+    readonly requiresFeedback: false;
 }
 /**
- * parent window resize event handler
- *
- * @param entries details about the resize event
+ * event to notify window viewport breakpoint change
  */
-export declare type ResizeEventListener = (entries: ResizeObserverEntry) => void;
+export interface IViewBreakpointChangeEvent extends IEvent<IView, {
+    breakpoint: BreakPoint;
+}, Record<string, unknown>, void> {
+    /**
+     * event name
+     */
+    readonly name: 'BreakpointChange';
+    /**
+     * scripting object from where the event is fired
+     */
+    readonly objectId: 'View';
+    /**
+     * event does not require feedback from listeners
+     */
+    readonly requiresFeedback: false;
+}
 /**
- * parent window breakpoint change event handler
- *
- * @param breakpoint current breakpoint of the parent window
+ * Methods view, modify parent's window attributes
  */
-export declare type BreakpointChangeEventListener = (breakpoint: BreakPoint) => void;
-export declare type ViewEvents = {
+export interface IView extends IScriptingObject {
     /**
-     * eent is fired when the parent window is resized
+     * event fired when the window is resized
      */
-    'view.resize': ResizeEventListener;
+    readonly Resize: IViewResizeEvent;
     /**
-     * event is fired when the parent window's breakpoint changes
+     * event fired when the window breakpoint changes
      */
-    'view.breakpointChange': BreakpointChangeEventListener;
-};
+    readonly BreakpointChange: IViewBreakpointChangeEvent;
+    /**
+     * Get the current breakpoint of the parent window
+     */
+    getBreakpoint(): Promise<BreakPoint>;
+    /**
+     * Get the current viewport size of the parent window
+     */
+    getViewPortSize(): Promise<ViewportSize>;
+}

package/dist/types/remotingScriptingObject.d.ts

@@ -0,0 +1,21 @@
+/**
+ * serialized scripting object
+ */
+export declare type RemotingScriptingObject = {
+    /**
+     * id of the scripting object
+     */
+    readonly objectId: string;
+    /**
+     * type of the scripting object
+     */
+    readonly objectType: string;
+    /**
+     * array of public functions exposed from the scripting object
+     */
+    readonly functions: Array<string>;
+    /**
+     * array of public events exposed from the scripting object
+     */
+    readonly events: Array<string>;
+};

package/dist/types/scriptingObject.d.ts

@@ -0,0 +1,15 @@
+import { RemotingScriptingObject } from './remotingScriptingObject.js';
+/**
+ * base type for scripting object proxy
+ */
+export interface IScriptingObjectProxy {
+    readonly id: string;
+    readonly objectType: string;
+}
+/**
+ * base type for scripting object
+ */
+export interface IScriptingObject extends IScriptingObjectProxy {
+    _toJSON(): RemotingScriptingObject;
+    _dispose?(): void;
+}

package/dist/types/{scriptingObjectTypes.d.ts → scriptingObjectList.d.ts}

@@ -13,9 +13,11 @@ import { IAnalytics } from './objects/analytics.js';
 import { IMemStorage } from './objects/memStorage.js';
 import { IView } from './objects/view.js';
 import { IRoute } from './objects/route.js';
-import { IModule } from './objects/module.js';
 import { IService } from './objects/service.js';
-export declare type ScriptingObjectTypes = {
+/**
+ * list of scripting object names and their types
+ */
+export declare type ScriptingObjects = {
     Analytics: IAnalytics;
     Application: IApplication;
     Auth: IAuth;
@@ -25,7 +27,6 @@ export declare type ScriptingObjectTypes = {
     Loan: ILoan;
     LoanV2: ILoanV2;
     MemStorage: IMemStorage;
-    Module: IModule;
     Route: IRoute;
     Service: IService;
     Session: ISession;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/pui-scripting-object",
-  "version": "1.14.0",
+  "version": "1.16.0",
   "description": "Typescript defintions for Scripting Objects",
   "sideEffects": false,
   "main": "./dist/cjs/index.js",

package/dist/types/events.d.ts

@@ -1,7 +0,0 @@
-import { FormEvents } from './objects/form.js';
-import { ApplicationEvents } from './objects/application.js';
-import { GlobalEvents } from './objects/global.js';
-import { ModuleEvents } from './objects/module.js';
-import { LoanEvents } from './objects/loan.js';
-import { ViewEvents } from './objects/view.js';
-export declare type ScriptingObjectEvents = FormEvents & ApplicationEvents & GlobalEvents & ModuleEvents & LoanEvents & ViewEvents;

package/dist/types/script.d.ts

@@ -1,28 +0,0 @@
-/**
- * Scripting object interface
- */
-export interface IScript {
-    /**
-     * get scripting object by name
-     *
-     * @param name scripting object name
-     */
-    getObject<T>(name: string): Promise<T>;
-    /**
-     * subscribe to an scripting object event
-     *
-     * @returns token to be used to unsubscribe
-     * @param objName scripting object name
-     * @param eventName event name
-     * @param listener callback function to be called when the event is fired
-     */
-    subscribe(objName: string, eventName: string, listener: (ev: any) => any): string;
-    /**
-     * unsubscribe from an scripting object event
-     *
-     * @param objName scripting object name
-     * @param eventName event name
-     * @param token unique token returned by subscribe
-     */
-    unsubscribe(objName: string, eventName: string, token: string): void;
-}