@elliemae/pui-scripting-object 1.7.0 → 1.8.0

package/dist/cjs/analytics.js

@@ -0,0 +1,16 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+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 analytics_exports = {};
+module.exports = __toCommonJS(analytics_exports);

package/dist/cjs/index.js

@@ -28,3 +28,6 @@ __reExport(lib_exports, require("./session.js"), module.exports);
 __reExport(lib_exports, require("./transaction.js"), module.exports);
 __reExport(lib_exports, require("./transactiontemplate.js"), module.exports);
 __reExport(lib_exports, require("./userAccessRights.js"), module.exports);
+__reExport(lib_exports, require("./route.js"), module.exports);
+__reExport(lib_exports, require("./view.js"), module.exports);
+__reExport(lib_exports, require("./analytics.js"), module.exports);

package/dist/cjs/loanv2.js

@@ -18,11 +18,21 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var loanv2_exports = {};
 __export(loanv2_exports, {
+  CommitErrorStatus: () => CommitErrorStatus,
   FieldErrorType: () => FieldErrorType
 });
 module.exports = __toCommonJS(loanv2_exports);
 var FieldErrorType = /* @__PURE__ */ ((FieldErrorType2) => {
   FieldErrorType2["ACCESS"] = "access";
   FieldErrorType2["VALUE"] = "value";
+  FieldErrorType2["SERIALIZATION"] = "serialization";
+  FieldErrorType2["DATA"] = "data";
+  FieldErrorType2["CONFLICT"] = "conflict";
   return FieldErrorType2;
 })(FieldErrorType || {});
+var CommitErrorStatus = /* @__PURE__ */ ((CommitErrorStatus2) => {
+  CommitErrorStatus2["FIELDERROR"] = "field_error";
+  CommitErrorStatus2["LOCK_INVALID_OR_REMOVED"] = "lock_invalid_or_removed";
+  CommitErrorStatus2["WORKSPACE_READ_ONLY"] = "workspace_read_only";
+  return CommitErrorStatus2;
+})(CommitErrorStatus || {});

package/dist/cjs/route.js

@@ -0,0 +1,16 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+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 route_exports = {};
+module.exports = __toCommonJS(route_exports);

package/dist/cjs/scriptingObjectTypes.js

@@ -0,0 +1,16 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+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 scriptingObjectTypes_exports = {};
+module.exports = __toCommonJS(scriptingObjectTypes_exports);

package/dist/cjs/view.js

@@ -0,0 +1,16 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+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 view_exports = {};
+module.exports = __toCommonJS(view_exports);

package/dist/esm/index.js

@@ -11,3 +11,6 @@ export * from "./session.js";
 export * from "./transaction.js";
 export * from "./transactiontemplate.js";
 export * from "./userAccessRights.js";
+export * from "./route.js";
+export * from "./view.js";
+export * from "./analytics.js";

package/dist/esm/loanv2.js

@@ -1,8 +1,18 @@
 var FieldErrorType = /* @__PURE__ */ ((FieldErrorType2) => {
   FieldErrorType2["ACCESS"] = "access";
   FieldErrorType2["VALUE"] = "value";
+  FieldErrorType2["SERIALIZATION"] = "serialization";
+  FieldErrorType2["DATA"] = "data";
+  FieldErrorType2["CONFLICT"] = "conflict";
   return FieldErrorType2;
 })(FieldErrorType || {});
+var CommitErrorStatus = /* @__PURE__ */ ((CommitErrorStatus2) => {
+  CommitErrorStatus2["FIELDERROR"] = "field_error";
+  CommitErrorStatus2["LOCK_INVALID_OR_REMOVED"] = "lock_invalid_or_removed";
+  CommitErrorStatus2["WORKSPACE_READ_ONLY"] = "workspace_read_only";
+  return CommitErrorStatus2;
+})(CommitErrorStatus || {});
 export {
+  CommitErrorStatus,
   FieldErrorType
 };

package/dist/types/analytics.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Business analytics event to be sent
+ */
+export declare type BAEvent = {
+    event: string;
+    [key: string]: string;
+};
+/**
+ * Methods and events to send and receive business analytics events
+ */
+export interface IAnalytics {
+    /**
+     * send business analytics event
+     *
+     * @param event business event to be sent
+     */
+    sendBAEvent(event: BAEvent): void;
+}

package/dist/types/application.d.ts

@@ -97,6 +97,12 @@ export interface IApplication {
      * @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>;
 }
 export declare type AppLoginListener = () => void;
 export declare type AppActionCompletedListener = (name: string) => void;

package/dist/types/index.d.ts

@@ -11,3 +11,7 @@ export * from './session.js';
 export * from './transaction.js';
 export * from './transactiontemplate.js';
 export * from './userAccessRights.js';
+export * from './route.js';
+export * from './view.js';
+export * from './analytics.js';
+export type { ScriptingObjectTypes } from './scriptingObjectTypes.js';

package/dist/types/loanv2.d.ts

@@ -1,17 +1,30 @@
 import { ILoan, LoanObject } from './loan.js';
 export declare enum FieldErrorType {
     /**
-     * access related error
+     * access related violations
      */
     ACCESS = "access",
     /**
-     * errors related to Field Data Entry Rules violation of the Active Ruleset
+     * Violation of a field data entry rule.
+     * Thrown only when value gets applied to the loan and will remain until user fixes the value
      */
-    VALUE = "value"
+    VALUE = "value",
+    /**
+     * Error during de\serialization of the field value
+     */
+    SERIALIZATION = "serialization",
+    /**
+     * Error due to invalid data like valid RuleActionType is not implemented
+     */
+    DATA = "data",
+    /**
+     * Error due to invalid user data based on current state of the loan
+     * This does not get applied to the loan
+     */
+    CONFLICT = "conflict"
 }
 export declare type FieldErrors = {
     id: string;
-    contractPath: string;
     type: FieldErrorType;
     description: string;
 };
@@ -21,6 +34,30 @@ export declare type SetFieldResponse = {
      */
     errors: FieldErrors[];
 };
+export declare enum CommitErrorStatus {
+    FIELDERROR = "field_error",
+    LOCK_INVALID_OR_REMOVED = "lock_invalid_or_removed",
+    WORKSPACE_READ_ONLY = "workspace_read_only"
+}
+/**
+ * Error representing a commit failure
+ */
+export declare type CommitError = Error & {
+    status: CommitErrorStatus;
+    /**
+     * List of violated rules that failed the commit
+     */
+    ruleViolations: {
+        /**
+         * fields not meeting various field rules
+         */
+        fieldErrors: FieldErrors[];
+    };
+};
+export declare type FieldIDToContractPath = {
+    fieldId: string;
+    contractPath: string;
+};
 /**
  * All operations on a loan are stateful.  This means loan changes are not committed until the loan.commit is called
  */
@@ -28,15 +65,24 @@ 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
+     * @returns {Promise<CommitResponse>}
+     * @throws {Error} if operation fails due to network errors
+     * @throws {CommitError} if operation fails due to business / functional rules
      *
      * #### Product Compatibility:
      * | | Encompass | Encompass Web | TPO | Consumer Connect |
      * :-----:|:-----: |:-----: |:-----: |:-----: |
      * | commit |  ✖️ |  ✖️ |  ✖️ |  ✖️ |
      */
-    commit(): Promise<LoanObject>;
+    commit(): Promise<void>;
+    /**
+     * Get the contract path for the given field ids
+     *
+     * @param fieldIds list of field ids for which loan contract path is required
+     * @returns list of field ids and their loan contract paths
+     * @throws {Error} if operation fails due to network errors
+     */
+    getContractPath(fieldIds: string[]): Promise<FieldIDToContractPath[]>;
     /**
      * Syncs the loan workspace with any changes made by other users
      * #### Product Compatibility:

package/dist/types/route.d.ts

@@ -0,0 +1,7 @@
+import { To } from 'history';
+/**
+ * Methods and events to view, modify & get notified about parent window url navigation
+ */
+export interface IRoute {
+    navigate(path: To, state?: any): Promise<void>;
+}

package/dist/types/script.d.ts

@@ -1,4 +1,28 @@
+/**
+ * Scripting object interface
+ */
 export interface IScript {
+    /**
+     * get scripting object by name
+     *
+     * @param name scripting object name
+     */
     getObject<T>(name: string): Promise<T>;
-    subscribe(objName: string, eventName: string, listener: () => void | boolean): Promise<void>;
+    /**
+     * subscribe to an scripting object event
+     *
+     * @returns token to be used to unsubscribe
+     * @param objName scripting object name
+     * @param eventName event name
+     * @param listener callback function to be called when the event is fired
+     */
+    subscribe(objName: string, eventName: string, listener: (ev: any) => any): string;
+    /**
+     * unsubscribe from an scripting object event
+     *
+     * @param objName scripting object name
+     * @param eventName event name
+     * @param token unique token returned by subscribe
+     */
+    unsubscribe(objName: string, eventName: string, token: string): void;
 }

package/dist/types/scriptingObjectTypes.d.ts

@@ -0,0 +1,24 @@
+import { ILoan } from './loan.js';
+import { ILoanV2 } from './loanv2.js';
+import { IApplication } from './application.js';
+import { IAuth } from './auth.js';
+import { ISession } from './session.js';
+import { ITransaction } from './transaction.js';
+import { ITransactionTemplate } from './transactiontemplate.js';
+import { IForm } from './form.js';
+import { IGlobal } from './global.js';
+import { IHttp } from './http.js';
+import { IAnalytics } from './analytics.js';
+export declare type ScriptingObjectTypes = {
+    Application: IApplication;
+    Analytics: IAnalytics;
+    Auth: IAuth;
+    Form: IForm;
+    Global: IGlobal;
+    Http: IHttp;
+    Loan: ILoan;
+    LoanV2: ILoanV2;
+    Session: ISession;
+    Transaction: ITransaction;
+    TransactionTemplate: ITransactionTemplate;
+};

package/dist/types/session.d.ts

@@ -1,4 +1,18 @@
+/**
+ * Methods and events to view, modify & get notified about parent window session storage
+ */
 export interface ISession {
+    /**
+     * set a value in the session storage
+     *
+     * @param key unique key to store the value
+     * @param value value to be stored
+     */
     set(key: string, value: string): Promise<void>;
+    /**
+     * get a value from the session storage
+     *
+     * @param key unique key to retrieve the value
+     */
     get(key: string): Promise<string>;
 }

package/dist/types/view.d.ts

@@ -0,0 +1,41 @@
+import { BreakPoint } from '@elliemae/pui-theme';
+/**
+ * window viewport size
+ */
+export declare type ViewportSize = {
+    width: number;
+    height: number;
+};
+/**
+ * parent window resize event handler
+ */
+export declare type ResizeEventListener = (entries: ResizeObserverEntry) => void;
+/**
+ * parent window breakpoint change event handler
+ */
+export declare type BreakpointChangeEventListener = (breakpoint: BreakPoint) => void;
+/**
+ * Methods and events to view, modify & get notified about parent's window attributes
+ */
+export interface IView {
+    /**
+     * Get the current breakpoint of the parent window
+     */
+    getBreakpoint(): Promise<BreakPoint>;
+    /**
+     * Get the current viewport size of the parent window
+     */
+    getViewPortSize(): Promise<ViewportSize>;
+    /**
+     * parent window resize event
+     *
+     * @param eventHandler event handler to be called when the parent window is resized
+     */
+    onResizeEvent(eventHandler: ResizeEventListener): string;
+    /**
+     * parent window breakpoint change event
+     *
+     * @param eventHandler event handler to be called when the parent window's breakpoint changes
+     */
+    onBreakpointChangeEvent(eventHandler: BreakpointChangeEventListener): string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/pui-scripting-object",
-  "version": "1.7.0",
+  "version": "1.8.0",
   "description": "Typescript defintions for Scripting Objects",
   "sideEffects": false,
   "main": "./dist/cjs/index.js",
@@ -58,12 +58,14 @@
   },
   "devDependencies": {
     "@elliemae/browserslist-config-elliemae-latest-browsers": "~1.5.0",
-    "@elliemae/pui-cli": "~7.6.1",
+    "@elliemae/pui-cli": "~7.9.0",
     "@elliemae/pui-doc-gen": "~1.3.0",
+    "@elliemae/pui-theme": "~2.6.0",
     "@types/styled-components": "~5.1.26",
+    "history": "~5.3.0",
     "redux": "~4.2.0",
     "redux-saga": "~1.2.1",
-    "styled-components": "~5.3.5"
+    "styled-components": "~5.3.6"
   },
   "peerDependencies": {}
 }

package/dist/cjs/index.pug

@@ -1,19 +0,0 @@
-
-doctype html
-html(lang='en')
-  head
-    meta(charset='UTF-8')
-    meta(name='viewport' content='width=device-width, initial-scale=1.0')
-    meta(http-equiv='X-UA-Compatible' content='ie=edge')
-    title #{htmlWebpackPlugin.options.libraryName}
-  body
-    p This library #{htmlWebpackPlugin.options.libraryName} exposes the following properties
-    ul#libraryAttributes
-    script(lang='javascript').
-      window.onload = function() {
-        const attribNode = document.getElementById('libraryAttributes');
-        if (attribNode) {
-        attribNode.innerHTML = Object.keys(window['#{htmlWebpackPlugin.options.libraryName}'] || {}).reduce((value, attribute) => value += `<li>${attribute}</li>`, '');
-        }
-      }
-

package/dist/esm/index.pug

@@ -1,19 +0,0 @@
-
-doctype html
-html(lang='en')
-  head
-    meta(charset='UTF-8')
-    meta(name='viewport' content='width=device-width, initial-scale=1.0')
-    meta(http-equiv='X-UA-Compatible' content='ie=edge')
-    title #{htmlWebpackPlugin.options.libraryName}
-  body
-    p This library #{htmlWebpackPlugin.options.libraryName} exposes the following properties
-    ul#libraryAttributes
-    script(lang='javascript').
-      window.onload = function() {
-        const attribNode = document.getElementById('libraryAttributes');
-        if (attribNode) {
-        attribNode.innerHTML = Object.keys(window['#{htmlWebpackPlugin.options.libraryName}'] || {}).reduce((value, attribute) => value += `<li>${attribute}</li>`, '');
-        }
-      }
-