@elliemae/pui-scripting-object 1.8.0 → 1.9.0

package/dist/cjs/events.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 events_exports = {};
+module.exports = __toCommonJS(events_exports);

package/dist/cjs/index.js

@@ -15,19 +15,20 @@ var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "defau
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var lib_exports = {};
 module.exports = __toCommonJS(lib_exports);
-__reExport(lib_exports, require("./auth.js"), module.exports);
-__reExport(lib_exports, require("./application.js"), module.exports);
-__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);
-__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);
+__reExport(lib_exports, require("./objects/analytics.js"), module.exports);
+__reExport(lib_exports, require("./objects/application.js"), module.exports);
+__reExport(lib_exports, require("./objects/auth.js"), module.exports);
+__reExport(lib_exports, require("./objects/form.js"), module.exports);
+__reExport(lib_exports, require("./objects/global.js"), module.exports);
+__reExport(lib_exports, require("./objects/http.js"), module.exports);
+__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/session.js"), module.exports);
+__reExport(lib_exports, require("./objects/transaction.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);

package/dist/cjs/objects/memStorage.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 memStorage_exports = {};
+module.exports = __toCommonJS(memStorage_exports);

package/dist/cjs/{transaction.js → objects/transaction.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 transaction_exports = {};
+__export(transaction_exports, {
+  OriginContext: () => OriginContext
+});
 module.exports = __toCommonJS(transaction_exports);
+var OriginContext = /* @__PURE__ */ ((OriginContext2) => {
+  OriginContext2["LENDER"] = "lender";
+  OriginContext2["CONSUMER"] = "consumer";
+  return OriginContext2;
+})(OriginContext || {});

package/dist/cjs/objects/transactionTemplate.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 transactionTemplate_exports = {};
+module.exports = __toCommonJS(transactionTemplate_exports);

package/dist/esm/index.js

@@ -1,16 +1,17 @@
-export * from "./auth.js";
-export * from "./application.js";
-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";
-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 * from "./objects/analytics.js";
+export * from "./objects/application.js";
+export * from "./objects/auth.js";
+export * from "./objects/form.js";
+export * from "./objects/global.js";
+export * from "./objects/http.js";
+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/session.js";
+export * from "./objects/transaction.js";
+export * from "./objects/transactionTemplate.js";
+export * from "./objects/userAccessRights.js";
+export * from "./objects/view.js";

package/dist/esm/objects/transaction.js

@@ -0,0 +1,8 @@
+var OriginContext = /* @__PURE__ */ ((OriginContext2) => {
+  OriginContext2["LENDER"] = "lender";
+  OriginContext2["CONSUMER"] = "consumer";
+  return OriginContext2;
+})(OriginContext || {});
+export {
+  OriginContext
+};

package/dist/types/events.d.ts

@@ -0,0 +1,7 @@
+import { FormEvents } from './objects/form.js';
+import { ApplicationEvents } from './objects/application.js';
+import { GlobalEvents } from './objects/global.js';
+import { ModuleEvents } from './objects/module.js';
+import { LoanEvents } from './objects/loan.js';
+import { ViewEvents } from './objects/view.js';
+export declare type ScriptingObjectEvents = FormEvents & ApplicationEvents & GlobalEvents & ModuleEvents & LoanEvents & ViewEvents;

package/dist/types/index.d.ts

@@ -1,17 +1,19 @@
-export * from './auth.js';
-export * from './application.js';
-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';
-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 * from './objects/analytics.js';
+export * from './objects/application.js';
+export * from './objects/auth.js';
+export * from './objects/form.js';
+export * from './objects/global.js';
+export * from './objects/http.js';
+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/session.js';
+export * from './objects/transaction.js';
+export * from './objects/transactionTemplate.js';
+export * from './objects/userAccessRights.js';
+export * from './objects/view.js';
+export type { ScriptingObjectEvents } from './events.js';
 export type { ScriptingObjectTypes } from './scriptingObjectTypes.js';

package/dist/types/{analytics.d.ts → objects/analytics.d.ts}

@@ -2,7 +2,13 @@
  * Business analytics event to be sent
  */
 export declare type BAEvent = {
+    /**
+     * name of the analytic event
+     */
     event: string;
+    /**
+     * custom properties to be sent with the event
+     */
     [key: string]: string;
 };
 /**

package/dist/types/{application.d.ts → objects/application.d.ts}

@@ -12,6 +12,9 @@ export declare type ApplicationExtension = {
     url: string;
     options?: Record<string, string>;
 };
+/**
+ * Types of navigations
+ */
 export declare enum NavigationType {
     STANDARD_FORM = "STANDARD_FORM",
     STANDARD_TOOL = "STANDARD_TOOL",
@@ -20,7 +23,13 @@ export declare enum NavigationType {
     GLOBAL_CUSTOM_TOOL = "GLOBAL_CUSTOM_TOOL",
     OTHER = "OTHER"
 }
+/**
+ * navigation options
+ */
 export declare type NavigationOptions = {
+    /**
+     *
+     */
     target: string;
     type: NavigationType;
     context?: Record<string, string>;
@@ -67,7 +76,7 @@ export declare type PrintOptions = {
     blob: Blob;
 };
 /**
- * The Application Object allows for access to application-level UI elements, behaviors and events
+ * Allows access to application-level UI elements, behaviors and events
  */
 export interface IApplication {
     /**
@@ -77,19 +86,80 @@ export interface IApplication {
      */
     getDescriptior(): Promise<AppInfo>;
     getApplicationContext(): Promise<ApplicationContext>;
+    /**
+     * extends the application with a new menu item or tool
+     *
+     * @param extensionObj properties of the extension
+     */
     extend(extensionObj: ApplicationExtension): Promise<void>;
+    /**
+     * navigate to a new application route / url
+     *
+     * @param options target url and type of navigation
+     */
     navigate(options: NavigationOptions): Promise<void>;
     performAction(action: string, options: Record<string, string>): Promise<void>;
+    /**
+     * open a page or document
+     *
+     * @param options target and type of the document to open
+     */
     open(options: OpenOptions): Promise<void>;
+    /**
+     * open a modal
+     *
+     * @param options modal properties
+     */
     openModal(options: OpenModalOptions): Promise<void>;
+    /**
+     * close a modal
+     */
     closeModal(): 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>;
+    /**
+     * Get the capabilities of the application
+     *
+     * @returns capabilities as key-value pairs
+     */
     getCapabilities(): Promise<Capabilities>;
+    /**
+     * renew the user session
+     */
     keepSessionAlive(): Promise<void>;
+    /**
+     * show wait spinner
+     *
+     * @param message message to display
+     */
     showSpinner(message: string): Promise<void>;
+    /**
+     * hide wait spinner
+     */
     hideSpinner(): Promise<void>;
+    /**
+     * get policy details for the current user
+     *
+     * @returns policy details as key value pairs
+     */
     getPoliciesDetails(): Promise<Record<string, string>>;
+    /**
+     * get persona Access information for the current user
+     *
+     * @returns persona access information as key value pairs
+     */
     getPersonaAccess(): Promise<Record<string, string>>;
     /**
      * Prints given document
@@ -104,5 +174,25 @@ export interface IApplication {
      */
     showError(message: string): Promise<void>;
 }
-export declare type AppLoginListener = () => void;
+/**
+ * event handler that handles user login event
+ *
+ * @param userId unique identifier of the user
+ */
+export declare type AppLoginListener = (userId: string) => void;
+/**
+ * event handler that handles action completed event
+ *
+ * @param name action name
+ */
 export declare type AppActionCompletedListener = (name: string) => void;
+export declare type ApplicationEvents = {
+    /**
+     * event fired when the user logs in
+     */
+    'application.login': AppLoginListener;
+    /**
+     * event fired when an action is completed. actions are executed through the performAction method
+     */
+    'application.actionCompleted': AppActionCompletedListener;
+};

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

@@ -0,0 +1,105 @@
+import { UserAccessRights } from './userAccessRights';
+export declare type Personas = {
+    entityId: string;
+    entityType: string;
+    entityName: string;
+};
+export declare type User = {
+    /**
+     * unique identifier for the user
+     */
+    id: string;
+    realm: string;
+    /**
+     * user's first name
+     */
+    firstName: string;
+    /**
+     * user's last name
+     */
+    lastName: string;
+    /**
+     * user's phone number
+     */
+    phone: string;
+    /**
+     * user's cell phone number
+     */
+    cellPhone: string;
+    personas: Array<Personas>;
+    /**
+     * encompass client Id
+     */
+    clientId: string;
+    /**
+     * user's email address
+     */
+    email: string;
+};
+export declare enum TokenType {
+    BEARER = "Bearer"
+}
+export declare type PluginInfo = {
+    /**
+     * unique identifier for the plugin
+     */
+    clientId: string;
+    /**
+     * redirect url for the plugin
+     */
+    redirectUrl: string;
+    /**
+     * type of token
+     */
+    scope: TokenType;
+};
+export declare type TokenInfo = {
+    /**
+     * child access token
+     */
+    accessToken: string;
+    /**
+     * type of token
+     */
+    tokenType: TokenType;
+    /**
+     * base url of the api endpoint
+     */
+    apiBaseUrl: string;
+};
+/**
+ * Methods to get information about the user and access token
+ */
+export interface IAuth {
+    /**
+     * Deprecated: use getAccessToken method instead
+     *
+     * Generates a new Auth Code for the caller which can be exchanged for
+     * an Access Token using the Client Secret associated with the given OAuth Client ID.
+     * In certain contexts, the Auth token is tied to the currently logged in user's identity
+     *
+     * @param clientId unique identifier of the plugin
+     * @returns auth code
+     */
+    createAuthCode(clientId: string): Promise<string>;
+    /**
+     * Get child access token for the given plugin
+     *
+     * @param appInfo metadata about the plugin requesting the access token
+     * @returns access token with the api base url
+     */
+    getAccessToken(appInfo: PluginInfo): Promise<TokenInfo>;
+    /**
+     * Get current logged in user information
+     *
+     * @returns user information
+     */
+    getUser(): Promise<User>;
+    /**
+     * Get access rights for the current user
+     *
+     * @returns user access rights
+     * @throws {Error} if operation fails
+     */
+    getUserAccessRights(): Promise<UserAccessRights>;
+}

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

@@ -0,0 +1,47 @@
+export declare type FormDescriptor = {
+    id: string;
+    name: string;
+};
+/**
+ * Methods to get information about the custom form
+ */
+export interface IForm {
+    /**
+     * get metadata of the form
+     *
+     * @returns form metadata
+     */
+    getDescriptor(): Promise<FormDescriptor>;
+    /**
+     * get reference to the form's input control
+     *
+     * @param id form id
+     * @returns form input control object
+     */
+    getControl(id: string): Promise<any>;
+}
+/**
+ * event handler for form load event
+ *
+ * @param id unique id of the form that is loaded
+ */
+export declare type FormLoadListener = (id: string) => void;
+/**
+ * event handler for form unload event
+ *
+ * @param id unique id of the form that is unloaded
+ */
+export declare type FormUnloadListener = (id: string) => void;
+/**
+ * events that notifies the form's lifecycle
+ */
+export declare type FormEvents = {
+    /**
+     * form is loaded and ready for user interaction
+     */
+    'form.load': FormLoadListener;
+    /**
+     * form is unloaded and no longer available for user interaction
+     */
+    'form.unload': FormUnloadListener;
+};

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

@@ -0,0 +1,47 @@
+/**
+ * The Global object allows for data to be shared between custom forms/tools/plugins within a user's session.
+ * Unlike the Session scripting object, where data is isolated to be visible/accessible only by the form/plugin that writes the variables,
+ * values written to the Global store are visible to all such customizations
+ *
+ * The implementation of this object should write the global state data to the host application's sessionStore,
+ * but should ensure that the state is isolated away from the host application's state variables. This should be done by creating
+ * naming conventions for the global keyspaces, e.g. ssf.global.<key>.
+ *
+ * In order to ensure that guest applications cannot consume significant amounts of sessionStorage, restrictions should be placed on
+ * the number and size of the stored session state. In particular, we can start with these values:
+ * Each valueObj, when stringified, cannot exceed 5 KB
+ * Total global state should be limited to 50 values
+ * This will ensure that no guest can consume more than 250 KB of sessionStorage
+ *
+ */
+export interface IGlobal {
+    /**
+     * set a value in the global store
+     *
+     * @param key unique key to identify the value
+     * @param value value to be stored
+     */
+    set(key: string, value: any): Promise<void>;
+    /**
+     * get a value from the global store
+     *
+     * @param key unique key to identify the value
+     * @returns value stored in the global store
+     */
+    get(key: string): Promise<any>;
+}
+/**
+ * event handler for global state change event
+ *
+ * @param key name of the key for which the value changed
+ */
+export declare type GlobalStateChangeListener = (key: string) => void;
+/**
+ * events fired from Global scripting object
+ */
+export declare type GlobalEvents = {
+    /**
+     * event fired when a value changes in the global store
+     */
+    'global.change': GlobalStateChangeListener;
+};