@elliemae/pui-scripting-object 1.16.4 → 1.16.6

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

@@ -3,7 +3,7 @@ import { IScriptingObject } from '../scriptingObject.js';
 /**
  * option name and its value
  */
-export declare type FieldOptions = {
+export type FieldOptions = {
     /**
      * option name
      */
@@ -16,14 +16,14 @@ export declare type FieldOptions = {
 /**
  * v3 loan object
  */
-export declare type LoanObject = Record<string, unknown>;
+export 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"
 }
-declare type CommitInfo = {
+type CommitInfo = {
     /**
      * cause of commit event
      */
@@ -34,181 +34,85 @@ declare type CommitInfo = {
  *
  * @returns true if precommit is allowed, false otherwise
  */
-export declare type LoanPreCommitListener = Listener<ILoan, CommitInfo, Record<string, unknown>, boolean>;
+export type LoanPreCommitListener = Listener<ILoan, CommitInfo, Record<string, unknown>, boolean>;
 /**
  * event to notify loan precommit operation
  */
 export interface ILoanPreCommitEvent extends IEvent {
-    /**
-     * 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 parameters
      */
     readonly params: CommitInfo;
-    /**
-     * subscribe to the event
-     */
-    subscribe: (callback: LoanPreCommitListener) => string;
 }
 /**
  * event handler for loan commited event
  *
  */
-export declare type LoanCommittedListener = Listener<ILoan, CommitInfo, Record<string, unknown>, void>;
+export type LoanCommittedListener = Listener<ILoan, CommitInfo, Record<string, unknown>, void>;
 /**
  * event to notify loan committed operation
  */
 export interface ILoanCommittedEvent extends IEvent {
-    /**
-     * 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 parameters
      */
     readonly params: CommitInfo;
-    /**
-     * subscribe to the event
-     */
-    subscribe: (callback: LoanCommittedListener) => string;
 }
 /**
  * event handler for loan data change event
  */
-export declare type LoanChangeListener = Listener<ILoan, Record<string, never>, Record<string, unknown>, void>;
+export type LoanChangeListener = Listener<ILoan, Record<string, never>, Record<string, unknown>, void>;
 /**
  * event to notify loan change operation
  */
 export interface ILoanChangeEvent extends IEvent {
-    /**
-     * 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 parameters
      */
     readonly params: Record<string, never>;
-    /**
-     * subscribe to the event
-     */
-    subscribe: (callback: LoanChangeListener) => string;
 }
 /**
  * event handler for loan sync event
  */
-export declare type LoanSyncListener = Listener<ILoan, Record<string, never>, Record<string, unknown>, void>;
+export type LoanSyncListener = Listener<ILoan, Record<string, never>, Record<string, unknown>, void>;
 /**
  * event to notify loan sync operation
  */
 export interface ILoanSyncEvent extends IEvent {
-    /**
-     * 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 parameters
      */
     readonly params: Record<string, never>;
-    /**
-     * subscribe to the event
-     */
-    subscribe: (callback: LoanSyncListener) => string;
 }
 /**
  * event handler for loan open event
  */
-export declare type LoanOpenListener = Listener<ILoan, Record<string, never>, Record<string, unknown>, void>;
+export type LoanOpenListener = Listener<ILoan, Record<string, never>, Record<string, unknown>, void>;
 /**
  * event to notify loan open operation
  */
 export interface ILoanOpenEvent extends IEvent {
-    /**
-     * 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 parameters
      */
     readonly params: Record<string, never>;
-    /**
-     * subscribe to the event
-     */
-    subscribe: (callback: LoanOpenListener) => string;
 }
 /**
  * event handler for loan close event
  *
  * @returns true if loan close is allowed, false otherwise
  */
-export declare type LoanCloseListener = Listener<ILoan, Record<string, never>, Record<string, unknown>, void>;
+export type LoanCloseListener = Listener<ILoan, Record<string, never>, Record<string, unknown>, void>;
 /**
  * event to notify loan close operation
  */
 export interface ILoanCloseEvent extends IEvent {
-    /**
-     * 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 parameters
      */
     readonly params: Record<string, never>;
-    /**
-     * subscribe to the event
-     */
-    subscribe: (callback: LoanCloseListener) => string;
 }
-declare type MilestoneInfo = {
+type MilestoneInfo = {
     /**
      * milestone name
      */
@@ -217,92 +121,88 @@ declare type MilestoneInfo = {
 /**
  * event handler for loan milestone completed event
  */
-export declare type LoanMilestoneCompletedListener = Listener<ILoan, MilestoneInfo, Record<string, unknown>, void>;
+export type LoanMilestoneCompletedListener = Listener<ILoan, MilestoneInfo, Record<string, unknown>, void>;
 /**
  * event to notify loan milestone completed operation
  */
 export interface ILoanMilestoneCompletedEvent extends IEvent {
-    /**
-     * 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 parameters
      */
     readonly params: MilestoneInfo;
-    /**
-     * subscribe to the event
-     */
-    subscribe: (callback: LoanMilestoneCompletedListener) => string;
 }
 /**
  * event handler for loan pre milestone complete event
  *
  * @returns true if milestone complete is allowed, false otherwise
  */
-export declare type LoanPreMilestoneCompleteListener = Listener<ILoan, MilestoneInfo, Record<string, unknown>, boolean>;
+export type LoanPreMilestoneCompleteListener = Listener<ILoan, MilestoneInfo, Record<string, unknown>, boolean>;
 /**
  * event to notify loan pre milestone complete operation
  */
 export interface ILoanPreMilestoneCompleteEvent extends IEvent {
-    /**
-     * 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 parameters
      */
     readonly params: MilestoneInfo;
-    /**
-     * subscribe to the event
-     */
-    subscribe: (callback: LoanPreMilestoneCompleteListener) => string;
 }
 /**
  * event handler for loan application selected event
  */
-export declare type LoanApplicationSelectedListener = Listener<ILoan, Record<string, never>, Record<string, unknown>, void>;
+export type LoanApplicationSelectedListener = Listener<ILoan, Record<string, never>, Record<string, unknown>, void>;
 /**
  * event to notify loan application selected operation
  */
 export interface ILoanApplicationSelectedEvent extends IEvent {
     /**
-     * event name
+     * event parameters
      */
-    readonly name: 'ApplicationSelected';
+    readonly params: Record<string, never>;
+}
+/**
+ * events supported by Loan scripting object
+ */
+export type LoanEvents = {
     /**
-     * scripting object from where the event is fired
+     * 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
      */
-    readonly objectId: 'Loan';
+    'loan.precommit': LoanPreCommitListener;
     /**
-     * event does not require feedback from listeners
+     * event is fired after pending changes to the loan are committed
      */
-    readonly requiresFeedback: false;
+    'loan.committed': LoanCommittedListener;
     /**
-     * event parameters
+     * event is fired for each change made by the user in the UI
      */
-    readonly params: Record<string, never>;
+    'loan.change': LoanChangeListener;
     /**
-     * subscribe to the event
+     * event is fired after the loan is sync'ed within any saved state made outside of the user's workspace.
      */
-    subscribe: (callback: LoanApplicationSelectedListener) => string;
-}
+    '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;
+};
 /**
  * Methods for interacting with an open loan in the application
  */
@@ -310,39 +210,57 @@ export interface ILoan extends IScriptingObject {
     /**
      * event fired when the loan is ready to commit
      */
-    readonly PreCommit: ILoanPreCommitEvent;
+    readonly PreCommit: {
+        new (): ILoanPreCommitEvent;
+    };
     /**
      * event fired when the loan is committed
      */
-    readonly Committed: ILoanCommittedEvent;
+    readonly Committed: {
+        new (): ILoanCommittedEvent;
+    };
     /**
      * event fired when the loan is changed
      */
-    readonly Change: ILoanChangeEvent;
+    readonly Change: {
+        new (): ILoanChangeEvent;
+    };
     /**
      * event fired when the loan is synced
      */
-    readonly Sync: ILoanSyncEvent;
+    readonly Sync: {
+        new (): ILoanSyncEvent;
+    };
     /**
      * event fired when the loan is opened
      */
-    readonly Open: ILoanOpenEvent;
+    readonly Open: {
+        new (): ILoanOpenEvent;
+    };
     /**
      * event fired when the loan is closed
      */
-    readonly Close: ILoanCloseEvent;
+    readonly Close: {
+        new (): ILoanCloseEvent;
+    };
     /**
      * event fired when the loan milestone is completed
      */
-    readonly MilestoneCompleted: ILoanMilestoneCompletedEvent;
+    readonly MilestoneCompleted: {
+        new (): ILoanMilestoneCompletedEvent;
+    };
     /**
      * event fired when the loan is ready to complete milestone
      */
-    readonly PreMilestoneComplete: ILoanPreMilestoneCompleteEvent;
+    readonly PreMilestoneComplete: {
+        new (): ILoanPreMilestoneCompleteEvent;
+    };
     /**
      * event fired when the loan application is selected
      */
-    readonly ApplicationSelected: ILoanApplicationSelectedEvent;
+    readonly ApplicationSelected: {
+        new (): ILoanApplicationSelectedEvent;
+    };
     /**
      * Get complete Loan object
      *

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

@@ -29,7 +29,7 @@ export declare enum FieldErrorType {
 /**
  * Field error object
  */
-export declare type FieldErrors = {
+export type FieldErrors = {
     /**
      * field id
      */
@@ -46,7 +46,7 @@ export declare type FieldErrors = {
 /**
  * Return type of setField method
  */
-export declare type SetFieldResponse = {
+export type SetFieldResponse = {
     /**
      * List of fields not meeting data, access or required rule criteria
      */
@@ -72,7 +72,7 @@ export declare enum CommitErrorStatus {
 /**
  * Error representing a commit failure
  */
-export declare type CommitError = Error & {
+export type CommitError = Error & {
     status: CommitErrorStatus;
     /**
      * List of violated rules that failed the commit
@@ -87,7 +87,7 @@ export declare type CommitError = Error & {
 /**
  * Map of field ids to their loan contract path
  */
-export declare type FieldIDToContractPath = {
+export type FieldIDToContractPath = {
     fieldId: string;
     contractPath: string;
 };
@@ -98,7 +98,7 @@ export interface ILoanV2 extends Omit<ILoan, 'commit' | 'setFields' | 'merge'> {
     /**
      * Commit all pending changes on the current loan
      *
-     * @returns {Promise<CommitResponse>}
+     * @returns {Promise<void>}
      * @throws {Error} if operation fails due to network errors
      * @throws {CommitError} if operation fails due to business / functional rules
      *

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

@@ -6,32 +6,27 @@ import { IScriptingObject } from '../scriptingObject.js';
  * @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 = Listener<IModule, Record<string, never>, Record<string, unknown>, boolean>;
+export type ModuleUnLoadingListener = Listener<IModule, Record<string, never>, Record<string, unknown>, boolean>;
 /**
  * Module unloading event
  */
 export interface IModuleUnloadingEvent extends IEvent {
-    /**
-     * event name
-     */
-    readonly name: 'Unloading';
-    /**
-     * scripting object from where the event was triggered
-     */
-    readonly objectId: 'Module';
-    /**
-     * response needed from event listeners
-     */
-    readonly requiresFeedback: true;
     /**
      * event parameters
      */
-    readonly params: Record<string, never>;
+    readonly Params: Record<string, never>;
+}
+/**
+ * events that notifies the module's lifecycle
+ */
+export type ModuleEvents = {
     /**
-     * subscribe to the event
+     * event fired when the module is unloading
+     *
+     * @returns true if the module can be unloaded, false otherwise
      */
-    subscribe: (callback: ModuleUnLoadingListener) => string;
-}
+    'module.unloading': ModuleUnLoadingListener;
+};
 /**
  * Exposes MicroApp module specific methods
  * This is an abstract interface and needs to be extended by the module
@@ -40,10 +35,10 @@ export interface IModuleUnloadingEvent extends IEvent {
 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;
+    readonly Unloading: {
+        new (): IModuleUnloadingEvent;
+    };
     /**
      * get microapp module-specific capabilities or settings defined by the host application. Helps to define the style and/or behavior of the module
      *

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

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

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

@@ -8,7 +8,7 @@ declare enum ServiceSetupCategory {
 /**
  * details of a service setup
  */
-declare type ServiceSetup = {
+type ServiceSetup = {
     /**
      * service setup id
      */
@@ -29,7 +29,7 @@ declare type ServiceSetup = {
 /**
  * options to open the service order integration
  */
-declare type OpenOptions = {
+type OpenOptions = {
     /**
      * context of the application that is opening the service order integration
      * urn patterned string

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

@@ -14,7 +14,7 @@ export declare enum OriginContext {
 /**
  * transaction origination context
  */
-export declare type OriginDetails = {
+export type OriginDetails = {
     /**
      * Temporary session token that grants authorization for a partner
      * integration to access transaction origination information via the REST API's /partner/v2/origins/:id endpoint
@@ -33,7 +33,7 @@ export declare type OriginDetails = {
 /**
  * file attachment information
  */
-export declare type TransactionResource = {
+export type TransactionResource = {
     /**
      * unique identifier for the file attachment
      */
@@ -47,7 +47,7 @@ export declare type TransactionResource = {
      */
     mimeType: string;
 };
-export declare type TransactionEvent = {
+export type TransactionEvent = {
     /**
      * event name
      */
@@ -68,7 +68,7 @@ export declare type TransactionEvent = {
 /**
  * details about the transaction
  */
-export declare type TransactionDetails = {
+export type TransactionDetails = {
     /**
      * details about the transaction that is created / updated
      */
@@ -100,7 +100,7 @@ export declare type TransactionDetails = {
 /**
  * details of the transaction resource
  */
-export declare type ResourceDetails = {
+export type ResourceDetails = {
     /**
      * resource id
      */
@@ -125,7 +125,7 @@ export declare type ResourceDetails = {
 /**
  * name of the document to be uploaded
  */
-export declare type ResourceOptions = {
+export type ResourceOptions = {
     /**
      * name of the document
      */

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

@@ -3,7 +3,7 @@ import { ResourceDetails, TransactionDetails, TransactionEvent, OriginDetails, R
 /**
  * details about the transaction that is created / updated
  */
-export declare type TransactionInfo = {
+export type TransactionInfo = {
     /**
      * unique identifier for the transaction
      */

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

@@ -2,7 +2,7 @@ import { IScriptingObject } from '../scriptingObject.js';
 /**
  * Transaction request object
  */
-export declare type TransactionRequest = {
+export type TransactionRequest = {
     /**
      * The type of transaction request being templated for the subject product.
      * This must be one of the supported values for the request type that your application is configured to support,
@@ -31,7 +31,7 @@ export declare type TransactionRequest = {
  * (registered as the $.interfaceUrl property in the product configuration),
  * wherein the transaction and application objects are available for use as applicable.
  */
-export declare type TransactionTemplateDetails = {
+export type TransactionTemplateDetails = {
     /**
      * The listed name for the transaction template - as auto-generated, or as provided
      * by the lender administrator when the template was created