@elliemae/pui-scripting-object 1.40.4 → 1.41.0

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

@@ -1,4 +1,4 @@
-import { IEvent, Listener } from '../event.js';
+import { IEvent } from '../event.js';
 import { IScriptingObject } from '../scriptingObject.js';
 /**
  * Parameters for getting field options
@@ -107,40 +107,105 @@ export declare enum LoanLevelActions {
     CALCULATE_EEM_MORTGAGE = "calculateEEMMortgage",
     COPY_BORROWER_TO_TAX_REQUEST = "copyBorrowerToTaxRequest"
 }
-type CommitInfo = {
+/**
+ * Loan commit event parameters
+ */
+export type CommitInfo = {
     /**
      * cause of commit event
      */
     cause: string;
 };
 /**
- * event handler for loan precommit event
- * @returns true if precommit is allowed, false otherwise
+ * Event handler for loan precommit event
+ * @param params event parameters
+ * @param params.obj loan object reference
+ * @param params.eventName event name
+ * @param params.eventParams commit info
+ * @param params.eventOptions additional options related to the event
+ * @returns true to allow pre-commit, false otherwise
  */
-export type LoanPreCommitListener = Listener<ILoan, CommitInfo, Record<string, unknown>, boolean>;
+export type LoanPreCommitListener = (params: {
+    obj: ILoan;
+    eventName: string;
+    eventParams: CommitInfo;
+    eventOptions?: Record<string, unknown>;
+}) => boolean;
 /**
- * event handler for loan commited event
- *
+ * Event handler for loan commited event
+ * @param params event parameters
+ * @param params.obj loan object reference
+ * @param params.eventName event name
+ * @param params.eventParams commit info
+ * @param params.eventOptions additional options related to the event
  */
-export type LoanCommittedListener = Listener<ILoan, CommitInfo, Record<string, unknown>, void>;
+export type LoanCommittedListener = (params: {
+    obj: ILoan;
+    eventName: string;
+    eventParams: CommitInfo;
+    eventOptions?: Record<string, unknown>;
+}) => void;
 /**
- * event handler for loan data change event
+ * Event handler for loan data change event
+ * @param params event parameters
+ * @param params.obj loan object reference
+ * @param params.eventName event name
+ * @param params.eventParams loan data change info
+ * @param params.eventOptions additional options related to the event
  */
-export type LoanChangeListener = Listener<ILoan, Record<string, never>, Record<string, unknown>, void>;
+export type LoanChangeListener = (params: {
+    obj: ILoan;
+    eventName: string;
+    eventParams: Record<string, never>;
+    eventOptions?: Record<string, unknown>;
+}) => void;
 /**
- * event handler for loan sync event
+ * Event handler for loan sync event
+ * @param params event parameters
+ * @param params.obj loan object reference
+ * @param params.eventName event name
+ * @param params.eventParams loan sync info
+ * @param params.eventOptions additional options related to the event
  */
-export type LoanSyncListener = Listener<ILoan, Record<string, never>, Record<string, unknown>, void>;
+export type LoanSyncListener = (params: {
+    obj: ILoan;
+    eventName: string;
+    eventParams: Record<string, never>;
+    eventOptions?: Record<string, unknown>;
+}) => void;
 /**
  * event handler for loan open event
+ * @param params event parameters
+ * @param params.obj loan object reference
+ * @param params.eventName event name
+ * @param params.eventParams loan open info
+ * @param params.eventOptions additional options related to the event
  */
-export type LoanOpenListener = Listener<ILoan, Record<string, never>, Record<string, unknown>, void>;
+export type LoanOpenListener = (params: {
+    obj: ILoan;
+    eventName: string;
+    eventParams: Record<string, never>;
+    eventOptions?: Record<string, unknown>;
+}) => void;
 /**
  * event handler for loan close event
- * @returns true if loan close is allowed, false otherwise
+ * @param params event parameters
+ * @param params.obj loan object reference
+ * @param params.eventName event name
+ * @param params.eventParams loan close info
+ * @param params.eventOptions additional options related to the event
+ * @returns true to close the loan, false otherwise
+ */
+export type LoanCloseListener = (params: {
+    obj: ILoan;
+    eventName: string;
+    eventParams: Record<string, never>;
+    eventOptions?: Record<string, unknown>;
+}) => boolean;
+/**
+ * Milestone related information
  */
-export type LoanCloseListener = Listener<ILoan, Record<string, never>, Record<string, unknown>, void>;
-type MilestoneInfo = {
+export type MilestoneInfo = {
     /**
      * milestone name
      */
@@ -148,124 +213,218 @@ type MilestoneInfo = {
 };
 /**
  * event handler for loan milestone completed event
+ * @param params event parameters
+ * @param params.obj loan object reference
+ * @param params.eventName event name
+ * @param params.eventParams milestone info
+ * @param params.eventOptions additional options related to the event
  */
-export type LoanMilestoneCompletedListener = Listener<ILoan, MilestoneInfo, Record<string, unknown>, void>;
+export type LoanMilestoneCompletedListener = (params: {
+    obj: ILoan;
+    eventName: string;
+    eventParams: MilestoneInfo;
+    eventOptions?: Record<string, unknown>;
+}) => void;
 /**
  * event handler for loan pre milestone complete event
- * @returns true if milestone complete is allowed, false otherwise
+ * @param params event parameters
+ * @param params.obj loan object reference
+ * @param params.eventName event name
+ * @param params.eventParams milestone info
+ * @param params.eventOptions additional options related to the event
+ * @returns true to allow milestone completion, false otherwise
  */
-export type LoanPreMilestoneCompleteListener = Listener<ILoan, MilestoneInfo, Record<string, unknown>, boolean>;
+export type LoanPreMilestoneCompleteListener = (params: {
+    obj: ILoan;
+    eventName: string;
+    eventParams: MilestoneInfo;
+    eventOptions?: Record<string, unknown>;
+}) => boolean;
 /**
  * event handler for loan application selected event
+ * @param params event parameters
+ * @param params.obj loan object reference
+ * @param params.eventName event name
+ * @param params.eventParams Selected application info
+ * @param params.eventOptions additional options related to the event
  */
-export type LoanApplicationSelectedListener = Listener<ILoan, Record<string, never>, Record<string, unknown>, void>;
+export type LoanApplicationSelectedListener = (params: {
+    obj: ILoan;
+    eventName: string;
+    eventParams: Record<string, never>;
+    eventOptions?: Record<string, unknown>;
+}) => void;
 /**
- * events supported by Loan scripting object
+ * Events supported by Loan scripting object
  */
 export 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
+     * Event is fired when a borrower pair changes
+     *
+     * Use {@link LoanApplicationSelectedListener} to handle this event
+     *
      */
-    'loan.precommit': LoanPreCommitListener;
+    'loan.applicationselected': LoanApplicationSelectedListener;
     /**
-     * event is fired after pending changes to the loan are committed
+     * Event is fired for each change made by the user in the UI
+     *
+     * Use {@link LoanChangeListener} to handle this event
+     *
      */
-    'loan.committed': LoanCommittedListener;
+    'loan.change': LoanChangeListener;
     /**
-     * event is fired for each change made by the user in the UI
+     * Event is fired after pending changes to the loan are committed
+     *
+     * Use {@link LoanCommittedListener} to handle this event
+     *
      */
-    'loan.change': LoanChangeListener;
+    'loan.committed': LoanCommittedListener;
     /**
-     * event is fired after the loan is sync'ed within any saved state made outside of the user's workspace.
+     * Event is fired just prior to closing the loan in the UI
+     *
+     * Use {@link LoanCloseListener} to handle this event
+     *
      */
-    'loan.sync': LoanSyncListener;
+    'loan.close': LoanCloseListener;
     /**
-     * event is fired after the loan is opened and ready for user interaction
+     * Event is fired after a milestone is completed by the user and committed to the server
+     *
+     * Use {@link LoanMilestoneCompletedListener} to handle this event
+     *
      */
-    'loan.open': LoanOpenListener;
+    'loan.milestoneCompleted': LoanMilestoneCompletedListener;
     /**
-     * event is fired just prior to closing the loan in the UI
+     * Event is fired after the loan is opened and ready for user interaction
+     *
+     * Use {@link LoanOpenListener} to handle this event
+     *
      */
-    'loan.close': LoanCloseListener;
+    'loan.open': LoanOpenListener;
     /**
-     * event is fired after a milestone is completed by the user and committed to the server
+     * 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
+     *
+     * Use {@link LoanPreCommitListener} to handle this event
+     *
      */
-    'loan.milestoneCompleted': LoanMilestoneCompletedListener;
+    'loan.precommit': LoanPreCommitListener;
     /**
-     * event is fired when the user attempts to complete a milestone and allows for custom validation,
+     * Event is fired when the user attempts to complete a milestone and allows for custom validation,
      * and cancellation, of the process
+     *
+     * Use {@link LoanPreMilestoneCompleteListener} to handle this event
+     *
      */
     'loan.premilestoneComplete': LoanPreMilestoneCompleteListener;
     /**
-     * event is fired when a borrower pair changes
+     * Event is fired after the loan is sync'ed within any saved state made outside of the user's workspace.
+     *
+     * use {@link LoanSyncListener} to handle this event
+     *
      */
-    'loan.applicationselected': LoanApplicationSelectedListener;
+    'loan.sync': LoanSyncListener;
 };
 /**
- * Methods for interacting with an open loan in the application
+ * Methods & Events for interacting with an open loan in the application
+ *
+ * See {@link LoanEvents} for supported events
  */
 export interface ILoan extends IScriptingObject {
     /**
-     * event fired when the loan is ready to commit
+     * event fired when the loan application is selected
+     *
+     * Use {@link LoanApplicationSelectedListener} to handle this event
      */
-    readonly PreCommit: IEvent;
+    readonly ApplicationSelected: IEvent;
     /**
-     * event fired when the loan is committed
+     * event fired when the loan is closed
+     *
+     * Use {@link LoanCloseListener} to handle this event
      */
-    readonly Committed: IEvent;
+    readonly Close: IEvent;
     /**
      * event fired when the loan is changed
+     *
+     * Use {@link LoanChangeListener} to handle this event
      */
     readonly Change: IEvent;
     /**
-     * event fired when the loan is synced
+     * event fired when the loan is committed
+     *
+     * Use {@link LoanCommittedListener} to handle this event
      */
-    readonly Sync: IEvent;
+    readonly Committed: IEvent;
     /**
-     * event fired when the loan is opened
+     * event fired when the loan milestone is completed
+     *
+     * Use {@link LoanMilestoneCompletedListener} to handle this event
      */
-    readonly Open: IEvent;
+    readonly MilestoneCompleted: IEvent;
     /**
-     * event fired when the loan is closed
+     * event fired when the loan is opened
+     *
+     * Use {@link LoanOpenListener} to handle this event
      */
-    readonly Close: IEvent;
+    readonly Open: IEvent;
     /**
-     * event fired when the loan milestone is completed
+     * event fired when the loan is ready to commit
+     *
+     * Use {@link LoanPreCommitListener} handles this event
      */
-    readonly MilestoneCompleted: IEvent;
+    readonly PreCommit: IEvent;
     /**
      * event fired when the loan is ready to complete milestone
+     *
+     * Use {@link LoanPreMilestoneCompleteListener} to handle this event
      */
     readonly PreMilestoneComplete: IEvent;
     /**
-     * event fired when the loan application is selected
+     * event fired when the loan is synced
+     *
+     * Use {@link LoanSyncListener} to handle this event
      */
-    readonly ApplicationSelected: IEvent;
+    readonly Sync: IEvent;
     /**
      * Get complete Loan object
      * @returns v3 Loan Object
-     *
-     * #### Product Compatibility:
-     * | | Encompass | Encompass Web | TPO | Consumer Connect |
-     * :-----:|:-----: |:-----: |:-----: |:-----: |
-     * | all |  ✔ |  ✔ |  ✔ |  ✖️ |
      */
     all(): Promise<LoanObject>;
     /**
      * Applies a partial loan object to the current loan,
      */
     apply(loan: LoanObject): Promise<void>;
+    /**
+     * Applies or removes the calculation lock on a loan field. In this way you can enable or disable the lock on a loan field programmatically. Parameters are: ID of the field you want to apply or remove the calculation lock and the status you want to set the lock to
+     * @param fieldId ID of the field you want to apply or remove the calculation lock
+     * @param lock
+     */
+    applyLock(fieldId: string, lock: boolean): Promise<void>;
+    /**
+     * Executes calculations and business rules
+     */
+    calculate(): Promise<void>;
     /**
      * Commit all pending changes on the current loan
      *
-     * #### Product Compatibility:
-     * | | Encompass | Encompass Web | TPO | Consumer Connect |
-     * :-----:|:-----: |:-----: |:-----: |:-----: |
-     * | all |  ✔ |  ✔ |  ✔ |  ✖️ |
      */
     commit(): Promise<void>;
+    /**
+     * Execute loan level action, this is specific to v3 stateful implementation
+     * @param type type of action to be executed
+     * @param params additional parameters for the action
+     */
+    execAction(type: LoanLevelActions, params?: Record<string, unknown>): Promise<LoanObject>;
+    /**
+     * Returns an object with current application selected
+     */
+    getCurrentApplication(): Promise<Record<string, string>>;
+    /**
+     * Returns an object reference of type LoanCollection. Argument "name" is required & used to get specific collection like BorrowerEmployer, Escrow etc.
+     * @param name collection template name
+     */
+    getCollection(name: string): Promise<Record<string, string>>;
     /**
      * get value of the given field id
      * @param id field id
@@ -322,58 +481,32 @@ export interface ILoan extends IScriptingObject {
      */
     getFields(ids: string[]): Promise<Record<string, string>>;
     /**
-     * Set the values of one or more fields on the Loan.
-     * @param fields list of field ids and their values
-     */
-    setFields(fields: Record<string, string>): Promise<void>;
-    /**
-     * Syncs the loan workspace with any changes made by other users.
+     * get snapshot of loan object
      */
-    merge(): Promise<void>;
+    getLockSnapshot(): Promise<Record<string, string>>;
     /**
      * Indicates if the loan is editable or in a read-only state.
      */
     isReadOnly(): Promise<boolean>;
     /**
-     * Applies or removes the calculation lock on a loan field. In this way you can enable or disable the lock on a loan field programmatically. Parameters are: ID of the field you want to apply or remove the calculation lock and the status you want to set the lock to
-     * @param fieldId ID of the field you want to apply or remove the calculation lock
-     * @param lock
-     */
-    applyLock(fieldId: string, lock: boolean): Promise<void>;
-    /**
-     * Executes calculations and business rules
-     */
-    calculate(): Promise<void>;
-    /**
-     * Returns an object with current application selected
+     * Syncs the loan workspace with any changes made by other users.
      */
-    getCurrentApplication(): Promise<Record<string, string>>;
+    merge(): Promise<void>;
     /**
      * Update data for current application
-     * @param options {CurrentApplicationOptions} options for setting current application
+     * @param options options for setting current application
      */
     setCurrentApplication(options: CurrentApplicationOptions): Promise<void>;
     /**
-     * Execute loan level action, this is specific to v3 stateful implementation
-     * @param type {LoanLevelActions} type of action to be executed
-     * @param params {Record<string, unknown>} additional parameters for the action
-     */
-    execAction(type: LoanLevelActions, params?: Record<string, unknown>): Promise<LoanObject>;
-    /**
-     * Returns an object reference of type LoanCollection. Argument "name" is required & used to get specific collection like BorrowerEmployer, Escrow etc.
-     * @param name collection template name
-     */
-    getCollection(name: string): Promise<Record<string, string>>;
-    /**
-     * get snapshot of loan object
+     * Set the values of one or more fields on the Loan.
+     * @param fields list of field ids and their values
      */
-    getLockSnapshot(): Promise<Record<string, string>>;
+    setFields(fields: Record<string, string>): Promise<void>;
     /**
      * insert, delete, update, replace different loand record types.
      * scope includes log and non-log record types
-     * @param options {RecordOptions} options for updating records
+     * @param options options for updating records
      * @returns array of record ids or loan view entity
      */
     updateRecords(options: RecordOptions): Promise<Array<string> | Array<unknown>>;
 }
-export {};

package/dist/types/lib/objects/loanv2.d.ts

@@ -93,6 +93,8 @@ export type FieldIDToContractPath = {
 };
 /**
  * All operations on a loan are stateful.  This means loan changes are not committed until the loan.commit is called
+ *
+ * See {@link LoanEvents} for supported events
  */
 export interface ILoanV2 extends Omit<ILoan, 'commit' | 'setFields' | 'merge'> {
     /**
@@ -107,11 +109,6 @@ export interface ILoanV2 extends Omit<ILoan, 'commit' | 'setFields' | 'merge'> {
      * if operation fails due to business / functional rules
      * @throws Error
      * if operation fails due to network errors
-     *
-     * #### Product Compatibility:
-     * | | Encompass | Encompass Web | TPO | Consumer Connect |
-     * :-----:|:-----: |:-----: |:-----: |:-----: |
-     * | commit |  ✖️ |  ✖️ |  ✖️ |  ✖️ |
      */
     commit(): Promise<void>;
     /**
@@ -130,11 +127,6 @@ export interface ILoanV2 extends Omit<ILoan, 'commit' | 'setFields' | 'merge'> {
      * @returns {Promise<LoanObject>} loan object
      * @throws Error
      * if operation fails due to network error
-     *
-     * #### Product Compatibility:
-     * | | Encompass | Encompass Web | TPO | Consumer Connect |
-     * :-----:|:-----: |:-----: |:-----: |:-----: |
-     * | merge |  ✖️ |  ✖️ |  ✖️ |  ✖️ |
      */
     merge(): Promise<LoanObject>;
     /**
@@ -143,11 +135,6 @@ export interface ILoanV2 extends Omit<ILoan, 'commit' | 'setFields' | 'merge'> {
      * @returns list of field ids that failed to set
      * @throws Error
      * if operation fails due to network error
-     *
-     * #### Product Compatibility:
-     * | | Encompass | Encompass Web | TPO | Consumer Connect |
-     * :-----:|:-----: |:-----: |:-----: |:-----: |
-     * | setFields |  ✖️ |  ✖️ |  ✖️ |  ✖️ |
      */
     setFields(fields: Record<string, string>): Promise<SetFieldResponse>;
 }

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

@@ -9,16 +9,16 @@ import { IScriptingObject } from '../scriptingObject.js';
  *
  */
 export interface IMemStorage extends IScriptingObject {
-    /**
-     * set a value in memory for given key
-     * @param key unique key to store the value
-     * @param value value to be stored. value should be JSON serializable
-     */
-    set(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(key: string): Promise<unknown>;
+    /**
+     * set a value in memory for given key
+     * @param key unique key to store the value
+     * @param value value to be stored. value should be JSON serializable
+     */
+    set(key: string, value: unknown): Promise<void>;
 }

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

@@ -1,9 +1,9 @@
-import { IEvent, Listener } from '../event.js';
+import { IEvent } from '../event.js';
 import { IScriptingObject } from '../scriptingObject.js';
 /**
  * error data to be displayed in the error dialog
  */
-export interface ErrorData {
+export type ErrorData = {
     /**
      * short description of the error
      */
@@ -24,20 +24,30 @@ export interface ErrorData {
      * unique id to identify the session / transaction, if any
      */
     correlationId?: string;
-}
+};
 /**
  * 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
+ * @param params event parameters
+ * @param params.obj module object reference
+ * @param params.eventName event name
+ * @param params.eventParams Module unload info
+ * @param params.eventOptions additional options related to the event
+ * @returns true to allow module unload, false otherwise
  */
-export type ModuleUnLoadingListener = Listener<IModule, Record<string, never>, Record<string, unknown>, boolean>;
+export type ModuleUnLoadingListener = (params: {
+    obj: IModule;
+    eventName: string;
+    eventParams: Record<string, never>;
+    eventOptions?: Record<string, unknown>;
+}) => boolean;
 /**
  * events that notifies the module's lifecycle
  */
 export type ModuleEvents = {
     /**
      * event fired when the module is unloading
-     * @returns true if the module can be unloaded, false otherwise
+     *
+     * Use {@link ModuleUnLoadingListener} to handle this event
      */
     'module.unloading': ModuleUnLoadingListener;
 };
@@ -45,10 +55,14 @@ export type ModuleEvents = {
  * 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'
+ *
+ * See {@link ModuleEvents} for supported events
  */
 export interface IModule extends IScriptingObject {
     /**
      * event fired when the module is unloading
+     *
+     * Use {@link ModuleUnLoadingListener} to handle this event
      */
     readonly Unloading: IEvent;
     /**
@@ -71,8 +85,8 @@ export interface IModule extends IScriptingObject {
      * open a dialog in hosting application to display an error message and related help link
      *
      * Note: once the dialog is closed, caller need to set the focus back to the link or button that opened the dialog to ensure keyboard navigation works as expected
-     * @param error {ErrorData} error message to be displayed
-     * @returns {Promise<void>} a promise that resolves when the dialog is closed
+     * @param data error message to be displayed
+     * @returns a promise that resolves when the dialog is closed
      */
     showError(data: ErrorData): Promise<void>;
 }

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

@@ -7,7 +7,7 @@ export interface IRoute extends IScriptingObject {
     /**
      * navigate to a new url
      * @param path path to navigate to
-     * @param state
+     * @param state state to be passed to the new path
      */
     navigate(path: To, state?: unknown): Promise<void>;
 }