@elliemae/pui-scripting-object 1.20.1 → 1.20.2

package/dist/cjs/objects/service.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,6 +17,9 @@ var __copyProps = (to, from, except, desc) => {
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var service_exports = {};
+__export(service_exports, {
+  ServiceSetupCategory: () => ServiceSetupCategory
+});
 module.exports = __toCommonJS(service_exports);
 var ServiceSetupCategory = /* @__PURE__ */ ((ServiceSetupCategory2) => {
   ServiceSetupCategory2["APPRAISAL"] = "Appraisal";

package/dist/esm/objects/service.js

@@ -2,3 +2,6 @@ var ServiceSetupCategory = /* @__PURE__ */ ((ServiceSetupCategory2) => {
   ServiceSetupCategory2["APPRAISAL"] = "Appraisal";
   return ServiceSetupCategory2;
 })(ServiceSetupCategory || {});
+export {
+  ServiceSetupCategory
+};

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

@@ -18,7 +18,6 @@ export type BAEvent = {
 export interface IAnalytics extends IScriptingObject {
     /**
      * send business analytics event
-     *
      * @param event business event to be sent
      */
     sendBAEvent(event: BAEvent): void;

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

@@ -154,7 +154,6 @@ export interface IApplication extends IScriptingObject {
     readonly ActionCompleted: IEvent;
     /**
      * Gets descriptor for the Application
-     *
      * @returns application descriptor
      */
     getDescriptior(): Promise<AppInfo>;
@@ -164,26 +163,22 @@ export interface IApplication extends IScriptingObject {
     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>;
@@ -193,21 +188,18 @@ export interface IApplication extends IScriptingObject {
     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>;
@@ -217,7 +209,6 @@ export interface IApplication extends IScriptingObject {
     keepSessionAlive(): Promise<void>;
     /**
      * show wait spinner
-     *
      * @param message message to display
      */
     showSpinner(message: string): Promise<void>;
@@ -227,31 +218,26 @@ export interface IApplication extends IScriptingObject {
     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
-     *
      * @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>;
     /**
      * log a message to host application's logs
-     *
      * @param message message to log
      * @param logLevel level of the log message
      */

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

@@ -45,13 +45,11 @@ export interface IForm extends IScriptingObject {
     readonly Unload: IEvent;
     /**
      * 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
      */

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

@@ -42,14 +42,12 @@ export interface IGlobal extends IScriptingObject {
     readonly Change: IEvent;
     /**
      * 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: unknown): Promise<void>;
     /**
      * get a value from the global store
-     *
      * @param key unique key to identify the value
      * @returns value stored in the global store
      */

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

@@ -7,7 +7,6 @@ import { IScriptingObject } from '../scriptingObject.js';
 export interface IHttp extends IScriptingObject {
     /**
      * get http request
-     *
      * @param url url to make the call to
      * @param headersOrAccessToken http headers object or access token to be used for the call
      * @returns http response object
@@ -16,7 +15,6 @@ export interface IHttp extends IScriptingObject {
     get(url: string, headersOrAccessToken?: HeadersInit | string): Promise<Response>;
     /**
      * post http request
-     *
      * @param url url to make the call to
      * @param headersOrAccessToken http headers object or access token to be used for the call
      * @returns http response object
@@ -25,7 +23,6 @@ export interface IHttp extends IScriptingObject {
     post(url: string, content: string | Record<string, string>, headersOrAccessToken?: HeadersInit | string): Promise<Response>;
     /**
      * patch http request
-     *
      * @param url url to make the call to
      * @param headersOrAccessToken http headers object or access token to be used for the call
      * @returns http response object
@@ -34,7 +31,6 @@ export interface IHttp extends IScriptingObject {
     patch(url: string, content: string | Record<string, string>, headersOrAccessToken?: HeadersInit | string): Promise<Response>;
     /**
      * put http request
-     *
      * @param url url to make the call to
      * @param headersOrAccessToken http headers object or access token to be used for the call
      * @returns http response object
@@ -43,7 +39,6 @@ export interface IHttp extends IScriptingObject {
     put(url: string, content: string | Record<string, string>, headersOrAccessToken?: HeadersInit | string): Promise<Response>;
     /**
      * delete http request
-     *
      * @param url url to make the call to
      * @param headersOrAccessToken http headers object or access token to be used for the call
      * @returns http response object

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

@@ -6,13 +6,11 @@ import { IScriptingObject } from '../scriptingObject.js';
 export type FieldOptionsParam = {
     /**
      * list of field Ids
-     *
      * @example ['1001', '1002']
      */
     fieldIds?: string[];
     /**
      * list of control Ids
-     *
      * @example ['1001', '1002']
      */
     controlIds?: string[];
@@ -57,7 +55,6 @@ type CommitInfo = {
 };
 /**
  * event handler for loan precommit event
- *
  * @returns true if precommit is allowed, false otherwise
  */
 export type LoanPreCommitListener = Listener<ILoan, CommitInfo, Record<string, unknown>, boolean>;
@@ -80,7 +77,6 @@ export type LoanSyncListener = Listener<ILoan, Record<string, never>, Record<str
 export type LoanOpenListener = Listener<ILoan, Record<string, never>, Record<string, unknown>, void>;
 /**
  * event handler for loan close event
- *
  * @returns true if loan close is allowed, false otherwise
  */
 export type LoanCloseListener = Listener<ILoan, Record<string, never>, Record<string, unknown>, void>;
@@ -96,7 +92,6 @@ type MilestoneInfo = {
 export type LoanMilestoneCompletedListener = Listener<ILoan, MilestoneInfo, Record<string, unknown>, void>;
 /**
  * event handler for loan pre milestone complete event
- *
  * @returns true if milestone complete is allowed, false otherwise
  */
 export type LoanPreMilestoneCompleteListener = Listener<ILoan, MilestoneInfo, Record<string, unknown>, boolean>;
@@ -190,7 +185,6 @@ export interface ILoan extends IScriptingObject {
     readonly ApplicationSelected: IEvent;
     /**
      * Get complete Loan object
-     *
      * @returns v3 Loan Object
      *
      * #### Product Compatibility:
@@ -214,7 +208,6 @@ export interface ILoan extends IScriptingObject {
     commit(): Promise<void>;
     /**
      * get value of the given field id
-     *
      * @param id field id
      * @returns field value
      */
@@ -223,7 +216,6 @@ export interface ILoan extends IScriptingObject {
      * 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
      *
@@ -266,13 +258,11 @@ export interface ILoan extends IScriptingObject {
     getFieldOptions(param: FieldOptionsParam): 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
      */
     setFields(fields: Record<string, string>): Promise<void>;
@@ -286,7 +276,6 @@ export interface ILoan extends IScriptingObject {
     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
      */
@@ -301,7 +290,6 @@ export interface ILoan extends IScriptingObject {
     getCurrentApplication(): Promise<Record<string, string>>;
     /**
      * Update data for current application
-     *
      * @param options
      */
     setCurrentApplication(options: CurrentApplicationOptions): Promise<void>;
@@ -311,7 +299,6 @@ export interface ILoan extends IScriptingObject {
     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>>;

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

@@ -103,7 +103,6 @@ export interface ILoanV2 extends Omit<ILoan, 'commit' | 'setFields' | 'merge'> {
      *
      * {@link LoanEvents}
      * loan.committed event is fired after the commit is successful.
-     *
      * @throws RuleValidationError
      * if operation fails due to business / functional rules
      * @throws Error
@@ -117,7 +116,6 @@ export interface ILoanV2 extends Omit<ILoan, 'commit' | 'setFields' | 'merge'> {
     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
@@ -129,7 +127,6 @@ export interface ILoanV2 extends Omit<ILoan, 'commit' | 'setFields' | 'merge'> {
      *
      * {@link LoanEvents}
      * loan.sync event is fired after the sync is successful.
-     *
      * @returns {Promise<LoanObject>} loan object
      * @throws Error
      * if operation fails due to network error
@@ -142,7 +139,6 @@ export interface ILoanV2 extends Omit<ILoan, 'commit' | 'setFields' | '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

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

@@ -11,7 +11,6 @@ import { IScriptingObject } from '../scriptingObject.js';
 export interface IMemStorage extends IScriptingObject {
     /**
      * set a value in memory for given key
-     *
      * @param clientId unique identifier assigned to the microapp
      * @param key unique key to store the value
      * @param value value to be stored. value should be JSON serializable
@@ -19,7 +18,6 @@ export interface IMemStorage extends IScriptingObject {
     set(clientId: string, key: string, value: unknown): Promise<void>;
     /**
      * get a value from memory for given key and microapp id
-     *
      * @param key unique key to retrieve the value
      * @returns value stored in memory
      */

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

@@ -2,7 +2,6 @@ import { IEvent, Listener } from '../event.js';
 import { IScriptingObject } from '../scriptingObject.js';
 /**
  * event handler that handles module unload event
- *
  * @param id unique id of the app that is being unloaded
  * @returns true if the module can be unloaded, false otherwise
  */
@@ -13,7 +12,6 @@ export type ModuleUnLoadingListener = Listener<IModule, Record<string, never>, R
 export type ModuleEvents = {
     /**
      * event fired when the module is unloading
-     *
      * @returns true if the module can be unloaded, false otherwise
      */
     'module.unloading': ModuleUnLoadingListener;
@@ -30,7 +28,6 @@ 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
-     *
      * @returns capabilities or settings as key-value pairs
      */
     getCapabilities(): Promise<Record<string, unknown>>;
@@ -38,7 +35,6 @@ export interface IModule extends IScriptingObject {
      * 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>>;

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

@@ -6,7 +6,6 @@ import { IScriptingObject } from '../scriptingObject.js';
 export interface IRoute extends IScriptingObject {
     /**
      * navigate to a new url
-     *
      * @param path path to navigate to
      * @param state
      */

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

@@ -2,13 +2,13 @@ import { IScriptingObject } from '../scriptingObject.js';
 /**
  * type of service setup categories
  */
-declare enum ServiceSetupCategory {
+export declare enum ServiceSetupCategory {
     APPRAISAL = "Appraisal"
 }
 /**
  * details of a service setup
  */
-type ServiceSetup = {
+export type ServiceSetup = {
     /**
      * service setup id
      */
@@ -27,9 +27,9 @@ type ServiceSetup = {
     category: ServiceSetupCategory;
 };
 /**
- * options to open the service order integration
+ * options to create service order
  */
-type OpenOptions = {
+export type CreateOrderOptions = {
     /**
      * context of the application that is opening the service order integration
      * urn patterned string
@@ -42,20 +42,28 @@ type OpenOptions = {
  */
 export interface IService extends IScriptingObject {
     /**
-     * Get the service setup for the current user and loan
-     *
-     * @param category - The category of the service setup
+     * get the service setup for the current user and loan
+     * @param {ServiceSetupCategory} category - service setup category
      * @param providerId - The provider id of the service setup
-     * @returns list of service setups matching the input criteria. Empty list if no service setups are found
+     * @returns {Array<ServiceSetup>} list of service setups matching the input criteria. Empty list if no service setups are found
+     *
+     * #### Product Compatibility:
+     * | | Encompass | Encompass Web | TPO | Consumer Connect |
+     * :-----:|:-----: |:-----: |:-----: |:-----: |
+     * | all |  ✖️ |  ✖️ |  ✖️ |  ✖️ |
      */
     getEligibleServices: (category: ServiceSetupCategory, providerId?: string) => Promise<Array<ServiceSetup>>;
     /**
-     * open default or specific service intergration to place an order
-     *
-     * @param serviceSetupId - id of the service setup
-     * @param options - options for opening the service integration
+     * open default or specific service intergration to create an order
+     * @param serviceSetupId - unique id of the service setup
+     * @param {CreateOrderOptions} options - options for creating the order
      * @throws Error if the service setup is not found or user is not authorized to open the integration
+     * @returns None
+     *
+     * #### Product Compatibility:
+     * | | Encompass | Encompass Web | TPO | Consumer Connect |
+     * :-----:|:-----: |:-----: |:-----: |:-----: |
+     * | all |  ✖️ |  ✖️ |  ✖️ |  ✖️ |
      */
-    createOrder: (serviceSetupId: string, options: OpenOptions) => Promise<void>;
+    createOrder: (serviceSetupId: string, options: CreateOrderOptions) => Promise<void>;
 }
-export {};

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

@@ -5,14 +5,12 @@ import { IScriptingObject } from '../scriptingObject.js';
 export interface ISession extends IScriptingObject {
     /**
      * 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/objects/transaction.d.ts

@@ -20,18 +20,16 @@ export type TransactionInfo = {
 export interface ITransaction extends IScriptingObject {
     /**
      * Provide the necessary information for your application's user-interface to:
-     *  Access transaction origination information and bootstrap its user interaction
-     *  Know if it was launched in the context of an existing transaction, so it can present the relevant view
-     *
+     * Access transaction origination information and bootstrap its user interaction
+     * Know if it was launched in the context of an existing transaction, so it can present the relevant view
      * @returns transaction origination information
      */
     getOrigin(): Promise<OriginDetails>;
     /**
      * Refresh your application's transaction origination context - if your current one expires.
      * This method returns a new originId and partnerAccessToken - which your application back-end can use to retrieve a refreshed transaction origin:
-     *  A fresh snapshot of the loan data your application is entitled to receive in a transaction origin
-     *  A a fresh snapshot of the user's credential set configured by their Administrator for use with your application
-     *
+     * A fresh snapshot of the loan data your application is entitled to receive in a transaction origin
+     * A a fresh snapshot of the user's credential set configured by their Administrator for use with your application
      * @returns transaction origination information
      */
     refreshOrigin(): Promise<OriginDetails>;
@@ -40,14 +38,12 @@ export interface ITransaction extends IScriptingObject {
      * local drive as an attachment to a new transaction.
      * This method returns a URL and authorization token,
      * which are to be used to stream the selected file as binary content to the EPC platform
-     *
      * @param options details of the resource to be uploaded
      * @returns location and authorization header to upload the resource
      */
     createResource(options: ResourceOptions): Promise<ResourceDetails>;
     /**
      * initiate a new transaction with your integration
-     *
      * @param options details of the transaction to be initiated
      * @returns transaction id
      */
@@ -77,7 +73,6 @@ export interface ITransaction extends IScriptingObject {
      * You can leverage this to track the initial transaction context for a user interaction
      *
      * The current transactional context that your integration is operating in can be queried using the transaction.get method.
-     *
      * @param options transaction details
      * @returns transaction that has been set
      */
@@ -104,7 +99,6 @@ export interface ITransaction extends IScriptingObject {
      * You can leverage this to track the initial transaction context for a user interaction
      *
      * The current transactional context your integration operates in can be queried using the transaction.get method
-     *
      * @returns transaction id details
      */
     get(): Promise<TransactionInfo>;
@@ -124,14 +118,12 @@ export interface ITransaction extends IScriptingObject {
      * If you need to support the ability for a lender to change the request type for a transaction they have initiated,
      * the initial transaction must be canceled via a transaction response status update (using the REST API),
      * and the lender must initiate a new transaction request with the updated type
-     *
      * @param options transaction details
      * @returns transaction id
      */
     update(options: TransactionDetails): Promise<TransactionInfo>;
     /**
      * Allow Lenders to initiate an event/message for the subject transaction with your integration
-     *
      * @param options details of the event/message to be initiated
      * @returns transaction event id
      */

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

@@ -56,14 +56,12 @@ export interface ITransactionTemplate extends IScriptingObject {
      *
      * Otherwise, if your application is launched in the context of a new transaction request template,
      * this method will return a null response.
-     *
      * @returns transactionTemplate object in edit mode, or null in create mode
      */
     get(): Promise<TransactionTemplateDetails | null>;
     /**
      * Create a new transaction request template, containing a defined request type and set of request options,
      * that Lender administrators can associate with a 1-click/automated ordering business condition set.
-     *
      * @param options details of the transaction template to be created
      * @returns success
      */

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

@@ -28,7 +28,6 @@ export declare enum CompleteReason {
 export interface ITransactionV2 extends IScriptingObject {
     /**
      * create new transaction
-     *
      * @param options details of the transaction to be created
      * @returns transaction id
      * @throws error when transaction creation fails
@@ -36,7 +35,6 @@ export interface ITransactionV2 extends IScriptingObject {
     create(options: TransactionDetails): Promise<string>;
     /**
      * send event for the subject transaction
-     *
      * @param id - unique identifier for the transaction
      * @param options details of the event/message to be initiated
      * @returns transaction event id
@@ -45,7 +43,6 @@ export interface ITransactionV2 extends IScriptingObject {
     createEvent(id: string, options: TransactionEvent): Promise<string>;
     /**
      * get necessary details to upload document for specific transaction
-     *
      * @param id - unique identifier for the transaction
      * @param options details of the document to be uploaded
      * @returns details about the location where to upload the document
@@ -54,7 +51,6 @@ export interface ITransactionV2 extends IScriptingObject {
     createResource(id: string, options: ResourceOptions): Promise<ResourceDetails>;
     /**
      * get details about the transaction
-     *
      * @param id - unique identifier for the transaction
      * @returns transaction details
      * @throws TransactionNotFound error for invalid transaction id
@@ -62,7 +58,6 @@ export interface ITransactionV2 extends IScriptingObject {
     get(id: string): Promise<TransactionDetails>;
     /**
      * Creates new origin and context.
-     *
      * @param withLoanData - include loan data in the origin cache
      * @returns service setup origination information
      * @throws OriginNotFound error when origin is not found
@@ -70,7 +65,6 @@ export interface ITransactionV2 extends IScriptingObject {
     createOrigin(withLoanData: boolean): Promise<OriginDetails>;
     /**
      * update existing transaction.
-     *
      * @param id - unique identifier for the transaction
      * @param options transaction details to be updated
      * @throws error when transaction update fails, TransactionNotFound error for invalid transaction id
@@ -79,7 +73,6 @@ export interface ITransactionV2 extends IScriptingObject {
     /**
      * notify host on completion of user interaction with the transaction
      * so that host can perform any necessary post user interaction processing / cleanup.
-     *
      * @param id - unique identifier for the transaction
      * @param reason reason for completing the transaction user interaction
      */

package/package.json

@@ -1,9 +1,8 @@
 {
   "name": "@elliemae/pui-scripting-object",
-  "version": "1.20.1",
+  "version": "1.20.2",
   "description": "Typescript defintions for Scripting Objects",
   "sideEffects": false,
-  "type": "module",
   "main": "./dist/cjs/index.js",
   "module": "./dist/es/index.js",
   "unpkg": "./dist/umd/index.js",
@@ -68,7 +67,7 @@
   },
   "devDependencies": {
     "@elliemae/browserslist-config-elliemae-latest-browsers": "~1.7.0",
-    "@elliemae/pui-cli": "~8.9.0",
+    "@elliemae/pui-cli": "~8.12.0",
     "@elliemae/pui-doc-gen": "~1.6.4",
     "@elliemae/pui-theme": "~2.7.0",
     "@types/styled-components": "~5.1.26",
@@ -77,5 +76,6 @@
     "redux-saga": "~1.2.3",
     "styled-components": "~5.3.10"
   },
-  "peerDependencies": {}
+  "peerDependencies": {},
+  "type": "module"
 }