@elliemae/pui-scripting-object 1.47.0 → 1.48.1

package/dist/cjs/index.js

@@ -25,14 +25,11 @@ __reExport(lib_exports, require("./objects/loan.js"), module.exports);
 __reExport(lib_exports, require("./objects/loanv2.js"), module.exports);
 __reExport(lib_exports, require("./objects/memStorage.js"), module.exports);
 __reExport(lib_exports, require("./objects/module.js"), module.exports);
-__reExport(lib_exports, require("./objects/route.js"), module.exports);
 __reExport(lib_exports, require("./objects/service.js"), module.exports);
 __reExport(lib_exports, require("./objects/session.js"), module.exports);
 __reExport(lib_exports, require("./objects/transaction.js"), module.exports);
-__reExport(lib_exports, require("./objects/transactionv2.js"), module.exports);
 __reExport(lib_exports, require("./objects/transactionTemplate.js"), module.exports);
 __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);
 __reExport(lib_exports, require("./event.js"), module.exports);
 __reExport(lib_exports, require("./scriptingObject.js"), module.exports);

package/dist/cjs/objects/application.js

@@ -18,7 +18,6 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var application_exports = {};
 __export(application_exports, {
-  ApplicationExtensionType: () => ApplicationExtensionType,
   FormType: () => FormType,
   LogLevels: () => LogLevels,
   ModalSize: () => ModalSize,
@@ -36,11 +35,6 @@ var LogLevels = /* @__PURE__ */ ((LogLevels2) => {
   LogLevels2[LogLevels2["FATAL"] = 60] = "FATAL";
   return LogLevels2;
 })(LogLevels || {});
-var ApplicationExtensionType = /* @__PURE__ */ ((ApplicationExtensionType2) => {
-  ApplicationExtensionType2["TOOL"] = "TOOL";
-  ApplicationExtensionType2["MENU"] = "MENU";
-  return ApplicationExtensionType2;
-})(ApplicationExtensionType || {});
 var OpenType = /* @__PURE__ */ ((OpenType2) => {
   OpenType2["MODULE"] = "MODULE";
   return OpenType2;

package/dist/cjs/objects/loan.js

@@ -19,6 +19,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var loan_exports = {};
 __export(loan_exports, {
   EditModes: () => EditModes,
+  LoanCollection: () => LoanCollection,
   LoanLevelActions: () => LoanLevelActions,
   RecordActions: () => RecordActions,
   RecordViewType: () => RecordViewType
@@ -44,6 +45,56 @@ var LoanLevelActions = /* @__PURE__ */ ((LoanLevelActions2) => {
   LoanLevelActions2["COPY_BORROWER_TO_TAX_REQUEST"] = "copyBorrowerToTaxRequest";
   return LoanLevelActions2;
 })(LoanLevelActions || {});
+var LoanCollection = /* @__PURE__ */ ((LoanCollection2) => {
+  LoanCollection2["AffiliatedBusinessArrangements"] = "AB0000";
+  LoanCollection2["AlternateNameBorrower"] = "URLABAKA0000";
+  LoanCollection2["AlternateNameCoBorrower"] = "URLACAKA0000";
+  LoanCollection2["BorrowerCreditReports"] = "BCRED0000";
+  LoanCollection2["BorrowerEmployer"] = "BE0000";
+  LoanCollection2["BorrowerResidence"] = "BR0000";
+  LoanCollection2["CoBorrowerCreditReports"] = "CCRED0000";
+  LoanCollection2["CoBorrowerEmployer"] = "CE0000";
+  LoanCollection2["CoBorrowerResidence"] = "CR0000";
+  LoanCollection2["DepositoryInformation"] = "DD0000";
+  LoanCollection2["Disclosures"] = "DISC0000";
+  LoanCollection2["EarlyCheck"] = "EC0000";
+  LoanCollection2["Escrow"] = "HUD0000";
+  LoanCollection2["GiftOrGrant"] = "URLARGG0000";
+  LoanCollection2["GoodFaithChangeOfCircumstance"] = "XCOC0000";
+  LoanCollection2["GSERepAndWarrantTracker"] = "TQLGSE0000";
+  LoanCollection2["HomeCounselingProvider"] = "HC0000";
+  LoanCollection2["IRS4506Record"] = "AR0000";
+  LoanCollection2["IRS4506TRecord"] = "IR0000";
+  LoanCollection2["ItemizedEscrowPayment"] = "AEA0000";
+  LoanCollection2["LiabilityInformation"] = "FL0000";
+  LoanCollection2["LoanPrograms"] = "LP0000";
+  LoanCollection2["MortgageProperty"] = "FM0000";
+  LoanCollection2["NonBorrowingOwnerFileContact"] = "NBOC0000";
+  LoanCollection2["NYFees"] = "NYFEES0000";
+  LoanCollection2["OtherAssets"] = "URLAROA0000";
+  LoanCollection2["OtherBorrowerEmployer"] = "FBE0000";
+  LoanCollection2["OtherCoBorrowerEmployer"] = "FCE0000";
+  LoanCollection2["OtherIncome"] = "URLAROIS0000";
+  LoanCollection2["OtherLiabilitiesOrDepository"] = "URLAROL0000";
+  LoanCollection2["PropertyValuations"] = "PVAL0000";
+  LoanCollection2["REGZDrawRepayPeriodDraw"] = "HTD0000";
+  LoanCollection2["REGZDrawRepayPeriodRepay"] = "HTR0000";
+  LoanCollection2["Riders"] = "RIDER0000";
+  LoanCollection2["Scenarios"] = "SCEN0000";
+  LoanCollection2["SettlementServiceProvider"] = "SP0000";
+  LoanCollection2["SpecialFeatureCodes"] = "SFC0000";
+  LoanCollection2["TQLBorrower4506TOrders"] = "TQL4506T0000";
+  LoanCollection2["TQLComplianceOrdersLastAlert"] = "TQLCOMPLIANCEALERT0000";
+  LoanCollection2["TQLDocumentDeliveredToInvestor"] = "TQLDOCDATE0000";
+  LoanCollection2["TQLFraudOrders"] = "TQLFRAUDALERT0000";
+  LoanCollection2["TrustAccountTransactionDescription"] = "TA0000";
+  LoanCollection2["UCDAdjustmentType"] = "UNFL0000";
+  LoanCollection2["Valuation"] = "VAL0000";
+  LoanCollection2["VerificationOfAdditionalLoans"] = "URLARAL0000";
+  LoanCollection2["VestingParty"] = "TR0000";
+  LoanCollection2["CorrespondentOtherInsurances"] = "CORROI0000";
+  return LoanCollection2;
+})(LoanCollection || {});
 var EditModes = /* @__PURE__ */ ((EditModes2) => {
   EditModes2["READ_ONLY"] = "READONLY";
   EditModes2["EDIT"] = "EDIT";

package/dist/cjs/scriptingObjectList.js

@@ -32,12 +32,9 @@ var ScriptingObjectNames = /* @__PURE__ */ ((ScriptingObjectNames2) => {
   ScriptingObjectNames2["LoanV2"] = "loanV2";
   ScriptingObjectNames2["MemStorage"] = "memstorage";
   ScriptingObjectNames2["Module"] = "module";
-  ScriptingObjectNames2["Route"] = "route";
   ScriptingObjectNames2["Service"] = "service";
   ScriptingObjectNames2["Session"] = "session";
   ScriptingObjectNames2["Transaction"] = "transaction";
-  ScriptingObjectNames2["TransactionV2"] = "transactionV2";
   ScriptingObjectNames2["TransactionTemplate"] = "transactionTemplate";
-  ScriptingObjectNames2["View"] = "view";
   return ScriptingObjectNames2;
 })(ScriptingObjectNames || {});

package/dist/esm/index.js

@@ -8,14 +8,11 @@ export * from "./objects/loan.js";
 export * from "./objects/loanv2.js";
 export * from "./objects/memStorage.js";
 export * from "./objects/module.js";
-export * from "./objects/route.js";
 export * from "./objects/service.js";
 export * from "./objects/session.js";
 export * from "./objects/transaction.js";
-export * from "./objects/transactionv2.js";
 export * from "./objects/transactionTemplate.js";
 export * from "./objects/userAccessRights.js";
-export * from "./objects/view.js";
 export * from "./objects/shared.js";
 export * from "./event.js";
 export * from "./scriptingObject.js";

package/dist/esm/objects/application.js

@@ -7,11 +7,6 @@ var LogLevels = /* @__PURE__ */ ((LogLevels2) => {
   LogLevels2[LogLevels2["FATAL"] = 60] = "FATAL";
   return LogLevels2;
 })(LogLevels || {});
-var ApplicationExtensionType = /* @__PURE__ */ ((ApplicationExtensionType2) => {
-  ApplicationExtensionType2["TOOL"] = "TOOL";
-  ApplicationExtensionType2["MENU"] = "MENU";
-  return ApplicationExtensionType2;
-})(ApplicationExtensionType || {});
 var OpenType = /* @__PURE__ */ ((OpenType2) => {
   OpenType2["MODULE"] = "MODULE";
   return OpenType2;
@@ -45,7 +40,6 @@ var ModalType = /* @__PURE__ */ ((ModalType2) => {
   return ModalType2;
 })(ModalType || {});
 export {
-  ApplicationExtensionType,
   FormType,
   LogLevels,
   ModalSize,

package/dist/esm/objects/loan.js

@@ -18,6 +18,56 @@ var LoanLevelActions = /* @__PURE__ */ ((LoanLevelActions2) => {
   LoanLevelActions2["COPY_BORROWER_TO_TAX_REQUEST"] = "copyBorrowerToTaxRequest";
   return LoanLevelActions2;
 })(LoanLevelActions || {});
+var LoanCollection = /* @__PURE__ */ ((LoanCollection2) => {
+  LoanCollection2["AffiliatedBusinessArrangements"] = "AB0000";
+  LoanCollection2["AlternateNameBorrower"] = "URLABAKA0000";
+  LoanCollection2["AlternateNameCoBorrower"] = "URLACAKA0000";
+  LoanCollection2["BorrowerCreditReports"] = "BCRED0000";
+  LoanCollection2["BorrowerEmployer"] = "BE0000";
+  LoanCollection2["BorrowerResidence"] = "BR0000";
+  LoanCollection2["CoBorrowerCreditReports"] = "CCRED0000";
+  LoanCollection2["CoBorrowerEmployer"] = "CE0000";
+  LoanCollection2["CoBorrowerResidence"] = "CR0000";
+  LoanCollection2["DepositoryInformation"] = "DD0000";
+  LoanCollection2["Disclosures"] = "DISC0000";
+  LoanCollection2["EarlyCheck"] = "EC0000";
+  LoanCollection2["Escrow"] = "HUD0000";
+  LoanCollection2["GiftOrGrant"] = "URLARGG0000";
+  LoanCollection2["GoodFaithChangeOfCircumstance"] = "XCOC0000";
+  LoanCollection2["GSERepAndWarrantTracker"] = "TQLGSE0000";
+  LoanCollection2["HomeCounselingProvider"] = "HC0000";
+  LoanCollection2["IRS4506Record"] = "AR0000";
+  LoanCollection2["IRS4506TRecord"] = "IR0000";
+  LoanCollection2["ItemizedEscrowPayment"] = "AEA0000";
+  LoanCollection2["LiabilityInformation"] = "FL0000";
+  LoanCollection2["LoanPrograms"] = "LP0000";
+  LoanCollection2["MortgageProperty"] = "FM0000";
+  LoanCollection2["NonBorrowingOwnerFileContact"] = "NBOC0000";
+  LoanCollection2["NYFees"] = "NYFEES0000";
+  LoanCollection2["OtherAssets"] = "URLAROA0000";
+  LoanCollection2["OtherBorrowerEmployer"] = "FBE0000";
+  LoanCollection2["OtherCoBorrowerEmployer"] = "FCE0000";
+  LoanCollection2["OtherIncome"] = "URLAROIS0000";
+  LoanCollection2["OtherLiabilitiesOrDepository"] = "URLAROL0000";
+  LoanCollection2["PropertyValuations"] = "PVAL0000";
+  LoanCollection2["REGZDrawRepayPeriodDraw"] = "HTD0000";
+  LoanCollection2["REGZDrawRepayPeriodRepay"] = "HTR0000";
+  LoanCollection2["Riders"] = "RIDER0000";
+  LoanCollection2["Scenarios"] = "SCEN0000";
+  LoanCollection2["SettlementServiceProvider"] = "SP0000";
+  LoanCollection2["SpecialFeatureCodes"] = "SFC0000";
+  LoanCollection2["TQLBorrower4506TOrders"] = "TQL4506T0000";
+  LoanCollection2["TQLComplianceOrdersLastAlert"] = "TQLCOMPLIANCEALERT0000";
+  LoanCollection2["TQLDocumentDeliveredToInvestor"] = "TQLDOCDATE0000";
+  LoanCollection2["TQLFraudOrders"] = "TQLFRAUDALERT0000";
+  LoanCollection2["TrustAccountTransactionDescription"] = "TA0000";
+  LoanCollection2["UCDAdjustmentType"] = "UNFL0000";
+  LoanCollection2["Valuation"] = "VAL0000";
+  LoanCollection2["VerificationOfAdditionalLoans"] = "URLARAL0000";
+  LoanCollection2["VestingParty"] = "TR0000";
+  LoanCollection2["CorrespondentOtherInsurances"] = "CORROI0000";
+  return LoanCollection2;
+})(LoanCollection || {});
 var EditModes = /* @__PURE__ */ ((EditModes2) => {
   EditModes2["READ_ONLY"] = "READONLY";
   EditModes2["EDIT"] = "EDIT";
@@ -25,6 +75,7 @@ var EditModes = /* @__PURE__ */ ((EditModes2) => {
 })(EditModes || {});
 export {
   EditModes,
+  LoanCollection,
   LoanLevelActions,
   RecordActions,
   RecordViewType

package/dist/esm/scriptingObjectList.js

@@ -9,13 +9,10 @@ var ScriptingObjectNames = /* @__PURE__ */ ((ScriptingObjectNames2) => {
   ScriptingObjectNames2["LoanV2"] = "loanV2";
   ScriptingObjectNames2["MemStorage"] = "memstorage";
   ScriptingObjectNames2["Module"] = "module";
-  ScriptingObjectNames2["Route"] = "route";
   ScriptingObjectNames2["Service"] = "service";
   ScriptingObjectNames2["Session"] = "session";
   ScriptingObjectNames2["Transaction"] = "transaction";
-  ScriptingObjectNames2["TransactionV2"] = "transactionV2";
   ScriptingObjectNames2["TransactionTemplate"] = "transactionTemplate";
-  ScriptingObjectNames2["View"] = "view";
   return ScriptingObjectNames2;
 })(ScriptingObjectNames || {});
 export {

package/dist/types/lib/index.d.ts

@@ -9,14 +9,11 @@ export * from './objects/loan.js';
 export * from './objects/loanv2.js';
 export * from './objects/memStorage.js';
 export * from './objects/module.js';
-export * from './objects/route.js';
 export * from './objects/service.js';
 export * from './objects/session.js';
 export * from './objects/transaction.js';
-export * from './objects/transactionv2.js';
 export * from './objects/transactionTemplate.js';
 export * from './objects/userAccessRights.js';
-export * from './objects/view.js';
 export * from './objects/shared.js';
 export * from './event.js';
 export * from './scriptingObject.js';

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

@@ -35,6 +35,10 @@ export declare enum LogLevels {
  * log message
  */
 export type LogMessage = {
+    /**
+     * application name
+     */
+    appName: string;
     /**
      * message string
      */
@@ -66,34 +70,6 @@ export type AppInfo = {
      */
     encompassVersion: string;
 };
-/**
- * Application extension type
- */
-export declare enum ApplicationExtensionType {
-    TOOL = "TOOL",
-    MENU = "MENU"
-}
-/**
- * metadata about the application extension
- */
-export 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>;
-};
 /**
  * set of query options to get company settings
  */
@@ -438,6 +414,10 @@ export type ModuleOpenInfo = {
      * @example urn:encompass:loanapp
      */
     moduleId: string;
+    /**
+     * mode to open the module. Default is IFRAME
+     */
+    openMode: OpenMode;
 };
 /**
  * event handler that handles module open event
@@ -505,11 +485,6 @@ export interface IApplication extends IScriptingObject {
      * close a modal
      */
     closeModal(): Promise<void>;
-    /**
-     * extends the application with a new menu item or tool
-     * @param extensionObj properties of the extension
-     */
-    extend(extensionObj: ApplicationExtension): Promise<void>;
     /**
      * Get the context of the application
      * @returns application context
@@ -541,7 +516,7 @@ export interface IApplication extends IScriptingObject {
      * get persona Access information for the current user
      * @returns persona access information as key value pairs
      */
-    getPersonaAccess(): Promise<Record<string, string>>;
+    getPersonaAccess(): Promise<Record<string, unknown>>;
     /**
      * get policy details for the current user
      * @returns policy details as key value pairs
@@ -553,10 +528,6 @@ export interface IApplication extends IScriptingObject {
      * @throws {Error} if operation fails
      */
     getUserAccessRights(): Promise<UserAccessRights>;
-    /**
-     * hide wait spinner
-     */
-    hideSpinner(): Promise<void>;
     /**
      * renew the user session
      */
@@ -608,26 +579,10 @@ export interface IApplication extends IScriptingObject {
      * @param options Print options
      */
     print(options: PrintOptions): Promise<void>;
-    /**
-     * show error message to user
-     * @param message error message to display
-     */
-    showError(message: string): Promise<void>;
-    /**
-     * show wait spinner
-     * @param message message to display
-     */
-    showSpinner(message: string): Promise<void>;
     /**
      * get supportability of an action
      * @param name action name
      * @returns true if the action is supported
      */
     supportsAction(name: string): Promise<boolean>;
-    /**
-     * get navigability to a particular page or screen
-     * @param name page or screen name
-     * @returns true if the page or screen is navigable
-     */
-    supportsNavigateTo(name: string): Promise<boolean>;
 }

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

@@ -7,8 +7,19 @@ export type UnAuthorizedError = Error;
  * Personas information
  */
 export type Personas = {
+    /**
+     * unique identifier for the persona
+     */
     entityId: string;
+    /**
+     * type of the entity
+     * @example 'Persona'
+     */
     entityType: string;
+    /**
+     * name of the entity
+     * @example 'Loan Officer'
+     */
     entityName: string;
 };
 /**
@@ -148,6 +159,10 @@ export interface IAuth extends IScriptingObject {
      * @param redirectUri redirect url of the plugin / microapp
      * @param scope scope of the plugin / microapp
      * @returns auth code
+     * @example
+     * ```javascript
+     * const authCode = await auth.createAuthCode('abc', 'https://clientx.com', 'lp');
+     * ```
      */
     createAuthCode(clientId: string, redirectUri: string, scope: string): Promise<string>;
     /**
@@ -156,6 +171,10 @@ export interface IAuth extends IScriptingObject {
      * 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
+     * @example
+     * ```javascript
+     * const token = await auth.getAccessToken();
+     * ```
      */
     getAccessToken(): Promise<TokenInfo>;
     /**