@elliemae/pui-scripting-object 1.42.2 → 1.43.0

package/dist/cjs/objects/loan.js

@@ -18,6 +18,7 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var loan_exports = {};
 __export(loan_exports, {
+  EditModes: () => EditModes,
   LoanLevelActions: () => LoanLevelActions,
   RecordActions: () => RecordActions,
   RecordViewType: () => RecordViewType
@@ -43,3 +44,8 @@ var LoanLevelActions = /* @__PURE__ */ ((LoanLevelActions2) => {
   LoanLevelActions2["COPY_BORROWER_TO_TAX_REQUEST"] = "copyBorrowerToTaxRequest";
   return LoanLevelActions2;
 })(LoanLevelActions || {});
+var EditModes = /* @__PURE__ */ ((EditModes2) => {
+  EditModes2["READ_ONLY"] = "READONLY";
+  EditModes2["EDIT"] = "EDIT";
+  return EditModes2;
+})(EditModes || {});

package/dist/cjs/objects/module.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))
@@ -13,4 +17,12 @@ var __copyProps = (to, from, except, desc) => {
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var module_exports = {};
+__export(module_exports, {
+  ModuleOpenMode: () => ModuleOpenMode
+});
 module.exports = __toCommonJS(module_exports);
+var ModuleOpenMode = /* @__PURE__ */ ((ModuleOpenMode2) => {
+  ModuleOpenMode2["POPUP"] = "POPUP";
+  ModuleOpenMode2["INLINE"] = "INLINE";
+  return ModuleOpenMode2;
+})(ModuleOpenMode || {});

package/dist/esm/objects/loan.js

@@ -18,7 +18,13 @@ var LoanLevelActions = /* @__PURE__ */ ((LoanLevelActions2) => {
   LoanLevelActions2["COPY_BORROWER_TO_TAX_REQUEST"] = "copyBorrowerToTaxRequest";
   return LoanLevelActions2;
 })(LoanLevelActions || {});
+var EditModes = /* @__PURE__ */ ((EditModes2) => {
+  EditModes2["READ_ONLY"] = "READONLY";
+  EditModes2["EDIT"] = "EDIT";
+  return EditModes2;
+})(EditModes || {});
 export {
+  EditModes,
   LoanLevelActions,
   RecordActions,
   RecordViewType

package/dist/esm/objects/module.js

@@ -0,0 +1,8 @@
+var ModuleOpenMode = /* @__PURE__ */ ((ModuleOpenMode2) => {
+  ModuleOpenMode2["POPUP"] = "POPUP";
+  ModuleOpenMode2["INLINE"] = "INLINE";
+  return ModuleOpenMode2;
+})(ModuleOpenMode || {});
+export {
+  ModuleOpenMode
+};

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

@@ -1,4 +1,8 @@
 import { IScriptingObject } from '../scriptingObject.js';
+/**
+ * Error thrown when the microapp / customization is not authorized to receive child token
+ */
+export type UnAuthorizedError = Error;
 /**
  * Personas information
  */
@@ -147,10 +151,11 @@ export interface IAuth extends IScriptingObject {
      */
     createAuthCode(clientId: string, redirectUri: string, scope: string): Promise<string>;
     /**
-     * Get child access token for the given plugin
+     * Get child access token for the given microapp / customization
      * Host implementing this scripting object method,
      * should able to find out the caller of this api and request necessary child token
      * @returns access token with the api base url
+     * @throws {UnAuthorizedError} if the customization, requesting the token, doesn not have active subscription to developer connect product
      */
     getAccessToken(): Promise<TokenInfo>;
     /**

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

@@ -254,6 +254,33 @@ export type LoanApplicationSelectedListener = (params: {
     eventParams: Record<string, never>;
     eventOptions?: Record<string, unknown>;
 }) => void;
+/**
+ * List of supported edit modes
+ */
+export declare enum EditModes {
+    /**
+     * read only mode
+     */
+    READ_ONLY = "READONLY",
+    /**
+     * edit mode
+     */
+    EDIT = "EDIT"
+}
+/**
+ * options for setting loan edit mode
+ */
+export type EditModeOptions = {
+    /**
+     * edit mode type
+     */
+    mode: EditModes;
+    /**
+     * module requesting the edit mode change. urn format
+     * @example urn:encompass:efolder
+     */
+    moduleId: string;
+};
 /**
  * Events supported by Loan scripting object
  */
@@ -396,7 +423,11 @@ export interface ILoan extends IScriptingObject {
      */
     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
+     * 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
      */
@@ -421,7 +452,9 @@ export interface ILoan extends IScriptingObject {
      */
     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.
+     * 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>>;
@@ -433,7 +466,9 @@ export interface ILoan extends IScriptingObject {
     getField(id: string): Promise<string>;
     /**
      * get options for loan fields / custom form controls
+     *
      * supports both standard & custom loan fields.
+     *
      * control Ids takes precedence over field Ids.
      * @param {FieldOptionsParam} param parameter for getting field options
      * @returns array of field options for each field / control id
@@ -497,6 +532,15 @@ export interface ILoan extends IScriptingObject {
      * @param options options for setting current application
      */
     setCurrentApplication(options: CurrentApplicationOptions): Promise<void>;
+    /**
+     * Set UI edit mode for the loan.
+     *
+     * It doesn't apply loan level lock.
+     *
+     * Use this api to prevent current user from making edits to the loan file, while a compliance based workflow is in progress
+     * @param options options for setting edit mode
+     */
+    setEditMode(options: EditModeOptions): Promise<void>;
     /**
      * Set the values of one or more fields on the Loan.
      * @param fields list of field ids and their values
@@ -504,6 +548,7 @@ export interface ILoan extends IScriptingObject {
     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 options for updating records
      * @returns array of record ids or loan view entity

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

@@ -25,6 +25,62 @@ export type ErrorData = {
      */
     correlationId?: string;
 };
+/**
+ * module open mode
+ */
+export declare enum ModuleOpenMode {
+    /**
+     * open the module in a new popup window
+     */
+    POPUP = "POPUP",
+    /**
+     * open the module in the same window
+     */
+    INLINE = "INLINE"
+}
+/**
+ * open module options
+ */
+export type OpenModuleOptions = {
+    /**
+     * module id in urn format
+     * @example urn:encompass:loanapp
+     */
+    moduleId: string;
+    /**
+     * mode to open the module
+     * @default INLINE
+     */
+    mode?: ModuleOpenMode;
+    /**
+     * module parameters as key-value pairs
+     */
+    parameters?: Record<string, unknown>;
+};
+/**
+ * MicroApp module specific parameters
+ */
+export type ModuleParameters = {
+    /**
+     * module id in urn format
+     * @example urn:encompass:loanapp
+     */
+    moduleId: string;
+    /**
+     * additional parameters as key-value pairs
+     */
+    [key: string]: unknown;
+};
+/**
+ * module unload event info
+ */
+export type ModuleUnloadInfo = {
+    /**
+     * module that triggered the unload event in urn format
+     * @example urn:encompass:loanapp
+     */
+    moduleId: string;
+};
 /**
  * event handler that handles module unload event
  * @param params event parameters
@@ -37,7 +93,32 @@ export type ErrorData = {
 export type ModuleUnLoadingListener = (params: {
     obj: IModule;
     eventName: string;
-    eventParams: Record<string, never>;
+    eventParams: ModuleUnloadInfo;
+    eventOptions?: Record<string, unknown>;
+}) => boolean;
+/**
+ * module close event info
+ */
+export type ModuleCloseInfo = {
+    /**
+     * module that triggered the close event in urn format
+     * @example urn:encompass:loanapp
+     */
+    moduleId: string;
+};
+/**
+ * event handler that handles module close event
+ * @param params event parameters
+ * @param params.obj module object reference
+ * @param params.eventName event name
+ * @param params.eventParams Module close info
+ * @param params.eventOptions additional options related to the event
+ * @returns true to allow module unload, false otherwise
+ */
+export type ModuleCloseListener = (params: {
+    obj: IModule;
+    eventName: string;
+    eventParams: ModuleCloseInfo;
     eventOptions?: Record<string, unknown>;
 }) => boolean;
 /**
@@ -50,11 +131,17 @@ export type ModuleEvents = {
      * Use {@link ModuleUnLoadingListener} to handle this event
      */
     'module.unloading': ModuleUnLoadingListener;
+    /**
+     * event fired when the module to be closed
+     *
+     * Use {@link ModuleCloseListener} to handle this event
+     */
+    'module.close': ModuleCloseListener;
 };
 /**
  * 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
  */
@@ -66,17 +153,33 @@ export interface IModule extends IScriptingObject {
      */
     readonly Unloading: IEvent;
     /**
-     * get microapp module-specific capabilities or settings defined by the host application. Helps to define the style and/or behavior of the module
+     * event fired when the module to be closed
+     *
+     * Use {@link ModuleCloseListener} to handle this event
+     */
+    readonly Close: IEvent;
+    /**
+     * get microapp module-specific capabilities or settings defined by the host application.
+     *
+     * Helps to define the style and/or behavior of the module
      * @returns capabilities or settings as key-value pairs
      */
     getCapabilities(): Promise<Record<string, unknown>>;
     /**
      * get microapp module-specific parameters.
+     *
      * For example, a lender may select a set of loans within the host application which must be passed to a module
      * that implements a specific workflow for those loans
      * @returns parameters as key-value pairs
      */
-    getParameters(): Promise<Record<string, unknown>>;
+    getParameters(): Promise<ModuleParameters>;
+    /**
+     * open another microapp module
+     *
+     * if parent module doesn't host the requested module, it will bubble up the request to its parent
+     * @param options module open options
+     */
+    open(options: OpenModuleOptions): Promise<void>;
     /**
      * unload the microapp module from the host application
      */