@elliemae/pui-scripting-object 1.6.1 → 1.7.0

package/dist/cjs/index.js

@@ -21,6 +21,7 @@ __reExport(lib_exports, require("./form.js"), module.exports);
 __reExport(lib_exports, require("./global.js"), module.exports);
 __reExport(lib_exports, require("./http.js"), module.exports);
 __reExport(lib_exports, require("./loan.js"), module.exports);
+__reExport(lib_exports, require("./loanv2.js"), module.exports);
 __reExport(lib_exports, require("./module.js"), module.exports);
 __reExport(lib_exports, require("./script.js"), module.exports);
 __reExport(lib_exports, require("./session.js"), module.exports);

package/dist/cjs/loan.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,14 @@ var __copyProps = (to, from, except, desc) => {
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var loan_exports = {};
+__export(loan_exports, {
+  LoanLevelActions: () => LoanLevelActions
+});
 module.exports = __toCommonJS(loan_exports);
+var LoanLevelActions = /* @__PURE__ */ ((LoanLevelActions2) => {
+  LoanLevelActions2["UPDATE_CORRESPONDENT_BALANCE"] = "updateCorrespondentBalance";
+  LoanLevelActions2["UPDATE_CORRESPONDENT_FEES"] = "updateCorrespondentFees";
+  LoanLevelActions2["COPY_ITEMIZATION_TO_STATE_DISCLOSURE"] = "copyItemizationToStateDisclosure";
+  LoanLevelActions2["CALCULATE_EEM_MORTGAGE"] = "calculateEEMMortgage";
+  return LoanLevelActions2;
+})(LoanLevelActions || {});

package/dist/cjs/loanv2.js

@@ -0,0 +1,28 @@
+"use strict";
+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))
+      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 loanv2_exports = {};
+__export(loanv2_exports, {
+  FieldErrorType: () => FieldErrorType
+});
+module.exports = __toCommonJS(loanv2_exports);
+var FieldErrorType = /* @__PURE__ */ ((FieldErrorType2) => {
+  FieldErrorType2["ACCESS"] = "access";
+  FieldErrorType2["VALUE"] = "value";
+  return FieldErrorType2;
+})(FieldErrorType || {});

package/dist/esm/index.js

@@ -4,6 +4,7 @@ export * from "./form.js";
 export * from "./global.js";
 export * from "./http.js";
 export * from "./loan.js";
+export * from "./loanv2.js";
 export * from "./module.js";
 export * from "./script.js";
 export * from "./session.js";

package/dist/esm/loan.js

@@ -0,0 +1,10 @@
+var LoanLevelActions = /* @__PURE__ */ ((LoanLevelActions2) => {
+  LoanLevelActions2["UPDATE_CORRESPONDENT_BALANCE"] = "updateCorrespondentBalance";
+  LoanLevelActions2["UPDATE_CORRESPONDENT_FEES"] = "updateCorrespondentFees";
+  LoanLevelActions2["COPY_ITEMIZATION_TO_STATE_DISCLOSURE"] = "copyItemizationToStateDisclosure";
+  LoanLevelActions2["CALCULATE_EEM_MORTGAGE"] = "calculateEEMMortgage";
+  return LoanLevelActions2;
+})(LoanLevelActions || {});
+export {
+  LoanLevelActions
+};

package/dist/esm/loanv2.js

@@ -0,0 +1,8 @@
+var FieldErrorType = /* @__PURE__ */ ((FieldErrorType2) => {
+  FieldErrorType2["ACCESS"] = "access";
+  FieldErrorType2["VALUE"] = "value";
+  return FieldErrorType2;
+})(FieldErrorType || {});
+export {
+  FieldErrorType
+};

package/dist/types/index.d.ts

@@ -4,6 +4,7 @@ export * from './form.js';
 export * from './global.js';
 export * from './http.js';
 export * from './loan.js';
+export * from './loanv2.js';
 export * from './module.js';
 export * from './script.js';
 export * from './session.js';

package/dist/types/loan.d.ts

@@ -11,9 +11,13 @@ export declare type FieldOptions = {
      */
     value: string;
 };
-export declare type SetFieldResponse = {
-    failed: string[];
-};
+export declare type LoanObject = Record<string, any>;
+export declare enum LoanLevelActions {
+    UPDATE_CORRESPONDENT_BALANCE = "updateCorrespondentBalance",
+    UPDATE_CORRESPONDENT_FEES = "updateCorrespondentFees",
+    COPY_ITEMIZATION_TO_STATE_DISCLOSURE = "copyItemizationToStateDisclosure",
+    CALCULATE_EEM_MORTGAGE = "calculateEEMMortgage"
+}
 /**
  * The Loan object provides methods for interacting with an open loan in the application's editor screen(s).
  */
@@ -28,20 +32,20 @@ export interface ILoan {
      * :-----:|:-----: |:-----: |:-----: |:-----: |
      * | all |  ✔ |  ✔ |  ✔ |  ✖️ |
      */
-    all(): Promise<Record<string, any>>;
-    apply(loan: Record<string, string>): Promise<void>;
+    all(): Promise<LoanObject>;
     /**
-     * Commit all pending changes for the current loan
-     *
-     * @returns v3 Loan Object
-     * @throws {Error} if the loan is not in a valid state or if there are business rule violations
+     * Applies a partial loan object to the current loan,
+     */
+    apply(loan: LoanObject): Promise<void>;
+    /**
+     * Commit all pending changes on the current loan
      *
      * #### Product Compatibility:
      * | | Encompass | Encompass Web | TPO | Consumer Connect |
      * :-----:|:-----: |:-----: |:-----: |:-----: |
      * | all |  ✔ |  ✔ |  ✔ |  ✖️ |
      */
-    commit(): Promise<Record<string, any>>;
+    commit(): Promise<void>;
     getField(id: string): Promise<string>;
     /**
      * get options for list of fields
@@ -83,30 +87,86 @@ export interface ILoan {
      * ```
      */
     getFieldOptions(fieldIds: string[]): Promise<Record<string, FieldOptions[]>>;
+    /**
+     * Returns the value of a single field using its field ID.
+     *
+     * @param ids The field ID of the fields to retrieve.
+     */
     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
-     * @returns list of field ids that failed to set
-     * @throws {Error} if operation fails due to network error
      */
-    setFields(fields: Record<string, string>): Promise<SetFieldResponse>;
+    setFields(fields: Record<string, string>): Promise<void>;
+    /**
+     * Syncs the loan workspace with any changes made by other users.
+     */
     merge(): Promise<void>;
+    /**
+     * 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
+     */
     getCurrentApplication(): Promise<Record<string, string>>;
-    execAction(type: string): Promise<void>;
+    /**
+     * Execute loan level action, this is specific to v3 stateful implementation
+     */
+    execAction(type: LoanLevelActions): 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>>;
     getLockSnapshot(): Promise<Record<string, string>>;
 }
+/**
+ * This event is fired prior to saving and 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
+ */
 export declare type LoanPreCommitListener = (cause: string) => boolean;
+/**
+ * This event is fired after pending changes to the loan are committed
+ */
 export declare type LoanCommittedListener = (cause: string) => void;
+/**
+ * This event is fired for each change made by the user in the UI
+ */
 export declare type LoanChangeListener = () => void;
+/**
+ * This event is fired after the loan is sync'ed within any saved state made outside of the user's workspace. This event should fire after any call to calculate() or merge(), assuming any changes are made to the loan
+ */
 export declare type LoanSyncListener = () => void;
+/**
+ * Fired after the loan is opened and ready for user interaction
+ */
 export declare type LoanOpenListener = () => void;
+/**
+ * Fired just prior to closing the loan in the UI
+ */
 export declare type LoanCloseListener = () => boolean;
+/**
+ * This event is fired after a milestone is completed by the user and committed to the server
+ */
 export declare type LoanMilestoneCompletedListener = (name: string) => void;
+/**
+ * This event is fired when the user attempts to complete a milestone and allows for custom validation, and cancellation, of the process
+ */
 export declare type LoanPreMilestoneCompleteListener = (name: string) => boolean;
+/**
+ * This event is fired when a borrower pair changes
+ */
 export declare type LoanApplicationSelectedListener = () => void;

package/dist/types/loanv2.d.ts

@@ -0,0 +1,61 @@
+import { ILoan, LoanObject } from './loan.js';
+export declare enum FieldErrorType {
+    /**
+     * access related error
+     */
+    ACCESS = "access",
+    /**
+     * errors related to Field Data Entry Rules violation of the Active Ruleset
+     */
+    VALUE = "value"
+}
+export declare type FieldErrors = {
+    id: string;
+    contractPath: string;
+    type: FieldErrorType;
+    description: string;
+};
+export declare type SetFieldResponse = {
+    /**
+     * List of fields not meeting data, access or required rule criteria
+     */
+    errors: FieldErrors[];
+};
+/**
+ * All operations on a loan are stateful.  This means loan changes are not committed until the loan.commit is called
+ */
+export interface ILoanV2 extends Omit<ILoan, 'commit' | 'setFields' | 'merge'> {
+    /**
+     * Commit all pending changes on the current loan
+     *
+     * @returns v3 Loan Object
+     * @throws {Error} if the loan is not in a valid state or if there are business rule violations
+     *
+     * #### Product Compatibility:
+     * | | Encompass | Encompass Web | TPO | Consumer Connect |
+     * :-----:|:-----: |:-----: |:-----: |:-----: |
+     * | commit |  ✖️ |  ✖️ |  ✖️ |  ✖️ |
+     */
+    commit(): Promise<LoanObject>;
+    /**
+     * Syncs the loan workspace with any changes made by other users
+     * #### Product Compatibility:
+     * | | Encompass | Encompass Web | TPO | Consumer Connect |
+     * :-----:|:-----: |:-----: |:-----: |:-----: |
+     * | merge |  ✖️ |  ✖️ |  ✖️ |  ✖️ |
+     */
+    merge(): Promise<LoanObject>;
+    /**
+     * Set the values of one or more fields on the Loan.
+     *
+     * @param fields list of field ids and their values
+     * @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/package.json

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