@elliemae/pui-scripting-object 1.11.0 → 1.13.0

package/dist/cjs/objects/application.js

@@ -19,10 +19,21 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var application_exports = {};
 __export(application_exports, {
   ApplicationExtensionType: () => ApplicationExtensionType,
+  LogLevel: () => LogLevel,
   ModalSize: () => ModalSize,
   NavigationType: () => NavigationType
 });
 module.exports = __toCommonJS(application_exports);
+var LogLevel = /* @__PURE__ */ ((LogLevel2) => {
+  LogLevel2["TRACE"] = "TRACE";
+  LogLevel2["DEBUG"] = "DEBUG";
+  LogLevel2["INFO"] = "INFO";
+  LogLevel2["AUDIT"] = "AUDIT";
+  LogLevel2["WARN"] = "WARN";
+  LogLevel2["ERROR"] = "ERROR";
+  LogLevel2["FATAL"] = "FATAL";
+  return LogLevel2;
+})(LogLevel || {});
 var ApplicationExtensionType = /* @__PURE__ */ ((ApplicationExtensionType2) => {
   ApplicationExtensionType2["TOOL"] = "TOOL";
   ApplicationExtensionType2["MENU"] = "MENU";

package/dist/cjs/objects/module.js

@@ -3,10 +3,6 @@ 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))
@@ -17,17 +13,4 @@ var __copyProps = (to, from, except, desc) => {
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var module_exports = {};
-__export(module_exports, {
-  LogLevel: () => LogLevel
-});
 module.exports = __toCommonJS(module_exports);
-var LogLevel = /* @__PURE__ */ ((LogLevel2) => {
-  LogLevel2["TRACE"] = "TRACE";
-  LogLevel2["DEBUG"] = "DEBUG";
-  LogLevel2["INFO"] = "INFO";
-  LogLevel2["AUDIT"] = "AUDIT";
-  LogLevel2["WARN"] = "WARN";
-  LogLevel2["ERROR"] = "ERROR";
-  LogLevel2["FATAL"] = "FATAL";
-  return LogLevel2;
-})(LogLevel || {});

package/dist/esm/objects/application.js

@@ -1,3 +1,13 @@
+var LogLevel = /* @__PURE__ */ ((LogLevel2) => {
+  LogLevel2["TRACE"] = "TRACE";
+  LogLevel2["DEBUG"] = "DEBUG";
+  LogLevel2["INFO"] = "INFO";
+  LogLevel2["AUDIT"] = "AUDIT";
+  LogLevel2["WARN"] = "WARN";
+  LogLevel2["ERROR"] = "ERROR";
+  LogLevel2["FATAL"] = "FATAL";
+  return LogLevel2;
+})(LogLevel || {});
 var ApplicationExtensionType = /* @__PURE__ */ ((ApplicationExtensionType2) => {
   ApplicationExtensionType2["TOOL"] = "TOOL";
   ApplicationExtensionType2["MENU"] = "MENU";
@@ -20,6 +30,7 @@ var ModalSize = /* @__PURE__ */ ((ModalSize2) => {
 })(ModalSize || {});
 export {
   ApplicationExtensionType,
+  LogLevel,
   ModalSize,
   NavigationType
 };

package/dist/esm/objects/module.js

@@ -1,13 +0,0 @@
-var LogLevel = /* @__PURE__ */ ((LogLevel2) => {
-  LogLevel2["TRACE"] = "TRACE";
-  LogLevel2["DEBUG"] = "DEBUG";
-  LogLevel2["INFO"] = "INFO";
-  LogLevel2["AUDIT"] = "AUDIT";
-  LogLevel2["WARN"] = "WARN";
-  LogLevel2["ERROR"] = "ERROR";
-  LogLevel2["FATAL"] = "FATAL";
-  return LogLevel2;
-})(LogLevel || {});
-export {
-  LogLevel
-};

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

@@ -1,3 +1,12 @@
+export declare enum LogLevel {
+    TRACE = "TRACE",
+    DEBUG = "DEBUG",
+    INFO = "INFO",
+    AUDIT = "AUDIT",
+    WARN = "WARN",
+    ERROR = "ERROR",
+    FATAL = "FATAL"
+}
 export declare type AppInfo = {
     id: string;
     name: string;
@@ -173,6 +182,13 @@ export interface IApplication {
      * @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
+     */
+    log(message: string, logLevel: LogLevel): Promise<void>;
 }
 /**
  * event handler that handles user login event

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

@@ -1,47 +1,33 @@
-export declare enum LogLevel {
-    TRACE = "TRACE",
-    DEBUG = "DEBUG",
-    INFO = "INFO",
-    AUDIT = "AUDIT",
-    WARN = "WARN",
-    ERROR = "ERROR",
-    FATAL = "FATAL"
-}
 /**
- * Methods to bootstraps feature modules
+ * Exposes MicroApp module specific methods
  */
 export interface IModule {
     /**
-     * get module-specific JavaScript object that can be used to communicate additional capabilities to the module
+     * get microapp module-specific capabilities or settings defined by the host application. Helps to define the style and/or behavior of the module
      *
-     * @returns key-value pairs of module-specific JavaScript objects
+     * @returns capabilities or settings as key-value pairs
      */
     getCapabilities(): Promise<Record<string, string>>;
     /**
-     * Get startup parameters for the module
+     * 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 startup parameters as key-value pairs
+     * @returns parameters as key-value pairs
      */
-    getParameters(): Promise<Record<string, string>>;
+    getParameters(): Promise<Record<string, string | number | boolean>>;
     /**
-     * unload the module from the host application
+     * unload the microapp module from the host application
      */
     unload(): Promise<void>;
-    /**
-     * log a message to host application's logs
-     *
-     * @param message message to log
-     * @param logLevel level of the log message
-     */
-    log(message: string, logLevel: LogLevel): Promise<void>;
 }
 /**
  * event handler that handles module unload event
  *
- * @param id unique id of the module that is being unloaded
+ * @param id unique id of the app that is being unloaded
  * @returns true if the module can be unloaded, false otherwise
  */
-export declare type ModuleUnLoadingListener = (id: string) => boolean;
+export declare type ModuleUnLoadingListener = (appId: string) => boolean;
 /**
  * events that notifies the module's lifecycle
  */

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

@@ -14,7 +14,7 @@ export declare enum OriginContext {
 /**
  * transaction origination context
  */
-export declare type OriginInfo = {
+export declare type OriginDetails = {
     /**
      * Temporary session token that grants authorization for a partner
      * integration to access transaction origination information via the REST API's /partner/v2/origins/:id endpoint
@@ -73,3 +73,69 @@ export declare type TransactionEvent = {
      */
     resources: Array<TransactionResource>;
 };
+/**
+ * details about the transaction
+ */
+export declare type TransactionDetails = {
+    /**
+     * details about the transaction that is created / updated
+     */
+    request: {
+        /**
+         * The type of transaction request being initiated for the subject product.
+         * This must be one of the supported values for the request type that your application
+         * is configured to support - based on which its data entitlements are scoped.
+         */
+        type: string;
+        /**
+         * The specific set of selectable options that apply to the specific
+         * type of transaction request, as modeled by your application
+         */
+        options?: Record<string, string | boolean | number>;
+        /**
+         * The collection of file attachments - referred to as resource objects in the
+         * EPC API - to be attached to the transaction request.
+         * The id, name, and mimeType attribute needed for each resource object
+         * in the collection can be created in one of two ways:
+         *  Your application utilized the transaction.createResource method to build a custom file upload experience, and the user invoked this functionality and uploaded a file from their local drive.
+         *  Your application utilized the application.performAction("getAvailableResources") method to launch the host application's file explorer, and the user invoked this functionality and attached a file[s] from the host application.
+         * Once the resource objects are collected from these methods,
+         * be sure to echo them back to the EPC platform when creating a transaction!
+         */
+        resources: Array<TransactionResource>;
+    };
+};
+/**
+ * details of the transaction resource
+ */
+export declare type ResourceDetails = {
+    /**
+     * resource id
+     */
+    id: string;
+    /**
+     * urn of the target upload location
+     */
+    respository: string;
+    /**
+     * name of the resource
+     */
+    name: string;
+    /**
+     * url to stream the resource
+     */
+    location: string;
+    /**
+     * authorization header to upload the resource
+     */
+    authorizationHeader: string;
+};
+/**
+ * name of the document to be uploaded
+ */
+export declare type ResourceOptions = {
+    /**
+     * name of the document
+     */
+    name: string;
+};

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

@@ -1,4 +1,4 @@
-import { OriginInfo, TransactionResource, TransactionEvent } from './shared.js';
+import { ResourceDetails, TransactionDetails, TransactionEvent, OriginDetails, ResourceOptions } from './shared.js';
 /**
  * details about the transaction that is created / updated
  */
@@ -8,69 +8,6 @@ export declare type TransactionInfo = {
      */
     id: string | null;
 };
-/**
- * information about the transaction to be initiated
- */
-export declare type TransactionOptions = {
-    request: {
-        /**
-         * The type of transaction request being initiated for the subject product.
-         * This must be one of the supported values for the request type that your application
-         * is configured to support - based on which its data entitlements are scoped.
-         */
-        type: string;
-        /**
-         * The specific set of selectable options that apply to the specific
-         * type of transaction request, as modeled by your application
-         */
-        options?: Record<string, string | boolean | number>;
-        /**
-         * The collection of file attachments - referred to as resource objects in the
-         * EPC API - to be attached to the transaction request.
-         * The id, name, and mimeType attribute needed for each resource object
-         * in the collection can be created in one of two ways:
-         *  Your application utilized the transaction.createResource method to build a custom file upload experience, and the user invoked this functionality and uploaded a file from their local drive.
-         *  Your application utilized the application.performAction("getAvailableResources") method to launch the host application's file explorer, and the user invoked this functionality and attached a file[s] from the host application.
-         * Once the resource objects are collected from these methods,
-         * be sure to echo them back to the EPC platform when creating a transaction!
-         */
-        resources: Array<TransactionResource>;
-    };
-};
-/**
- * resource name to be uploaded
- */
-export declare type TransactionResourceFile = {
-    /**
-     * name of the file
-     */
-    name: string;
-};
-/**
- * response object of createResource method
- */
-export declare type TransactionResourceResponse = {
-    /**
-     * resource id
-     */
-    id: string;
-    /**
-     * urn of the target upload location
-     */
-    respository: string;
-    /**
-     * name of the resource
-     */
-    name: string;
-    /**
-     * url to stream the resource
-     */
-    location: string;
-    /**
-     * authorization header to upload the resource
-     */
-    authorizationHeader: string;
-};
 /**
  * Provides your applications lender/borrower-facing view with the necessary handles to model your application's
  * transactional interaction with the EPC platform.
@@ -87,7 +24,7 @@ export interface ITransaction {
      *
      * @returns transaction origination information
      */
-    getOrigin(): Promise<OriginInfo>;
+    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:
@@ -96,7 +33,7 @@ export interface ITransaction {
      *
      * @returns transaction origination information
      */
-    refreshOrigin(): Promise<OriginInfo>;
+    refreshOrigin(): Promise<OriginDetails>;
     /**
      * Allow Lenders to use your integration to upload files from their
      * local drive as an attachment to a new transaction.
@@ -106,14 +43,14 @@ export interface ITransaction {
      * @param options details of the resource to be uploaded
      * @returns location and authorization header to upload the resource
      */
-    createResource(options: TransactionResourceFile): Promise<TransactionResourceResponse>;
+    createResource(options: ResourceOptions): Promise<ResourceDetails>;
     /**
      * initiate a new transaction with your integration
      *
      * @param options details of the transaction to be initiated
      * @returns transaction id
      */
-    create(options: TransactionOptions): Promise<TransactionInfo>;
+    create(options: TransactionDetails): Promise<TransactionInfo>;
     /**
      * Set the transaction in whose context you want to invoke methods that operate on an existing transaction.
      * The subject transaction must be one that was created for the current loan and EPC product.
@@ -190,7 +127,7 @@ export interface ITransaction {
      * @param options transaction details
      * @returns transaction id
      */
-    update(options: TransactionOptions): Promise<TransactionInfo>;
+    update(options: TransactionDetails): Promise<TransactionInfo>;
     /**
      * Allow Lenders to initiate an event/message for the subject transaction with your integration
      *

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

@@ -1,70 +1,4 @@
-import { OriginInfo, TransactionResource, TransactionEvent } from './shared.js';
-/**
- * details about the transaction
- */
-export declare type TransactionDetails = {
-    /**
-     * details about the transaction that is created / updated
-     */
-    request: {
-        /**
-         * The type of transaction request being initiated for the subject product.
-         * This must be one of the supported values for the request type that your application
-         * is configured to support - based on which its data entitlements are scoped.
-         */
-        type: string;
-        /**
-         * The specific set of selectable options that apply to the specific
-         * type of transaction request, as modeled by your application
-         */
-        options?: Record<string, string | boolean | number>;
-        /**
-         * The collection of file attachments - referred to as resource objects in the
-         * EPC API - to be attached to the transaction request.
-         * The id, name, and mimeType attribute needed for each resource object
-         * in the collection can be created in one of two ways:
-         *  Your application utilized the transaction.createResource method to build a custom file upload experience, and the user invoked this functionality and uploaded a file from their local drive.
-         *  Your application utilized the application.performAction("getAvailableResources") method to launch the host application's file explorer, and the user invoked this functionality and attached a file[s] from the host application.
-         * Once the resource objects are collected from these methods,
-         * be sure to echo them back to the EPC platform when creating a transaction!
-         */
-        resources: Array<TransactionResource>;
-    };
-};
-/**
- * name of the document to be uploaded
- */
-export declare type ResourceOptions = {
-    /**
-     * name of the document
-     */
-    name: string;
-};
-/**
- * response object of createResource method
- */
-export declare type CreateResourceResponse = {
-    /**
-     * resource id
-     */
-    id: string;
-    /**
-     * urn of the target upload location
-     */
-    respository: string;
-    /**
-     * name of the resource
-     */
-    name: string;
-    /**
-     * url to stream the resource
-     */
-    location: string;
-    /**
-     * authorization header to upload the resource
-     */
-    authorizationHeader: string;
-};
+import { OriginDetails, TransactionDetails, TransactionEvent, ResourceDetails, ResourceOptions } from './shared.js';
 /**
  * Provides your applications lender/borrower-facing view with the necessary handles to model your application's
  * transactional interaction with the EPC platform.
@@ -75,61 +9,73 @@ export declare type CreateResourceResponse = {
  */
 export interface ITransactionV2 {
     /**
-     * Get transaction's origination and context
+     * create new transaction
      *
-     * @param id - unique identifier for the transaction
-     * @returns transaction origination information and null if the transaction is not found
+     * @param options details of the transaction to be created
+     * @returns transaction id
+     * @throws error when transaction creation fails
      */
-    getOrigin(id: string): Promise<OriginInfo | null>;
+    create(options: TransactionDetails): Promise<string>;
     /**
-     * Refresh transaction origination context, if current one expires.
+     * send event for the subject transaction
      *
      * @param id - unique identifier for the transaction
-     * @returns transaction origination information or null if the transaction is not found
+     * @param options details of the event/message to be initiated
+     * @returns transaction event id
+     * @throws error when event creation fails, TransactionNotFound error for invalid transaction id
      */
-    refreshOrigin(id: string): Promise<OriginInfo | null>;
+    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
+     * @throws error when resource can not be created, TransactionNotFound error for invalid transaction id
      */
-    createResource(id: string, options: ResourceOptions): Promise<CreateResourceResponse | null>;
+    createResource(id: string, options: ResourceOptions): Promise<ResourceDetails>;
     /**
-     * create new transaction
+     * get details about the transaction
      *
-     * @param options details of the transaction to be created
-     * @returns transaction id
+     * @param id - unique identifier for the transaction
+     * @returns transaction details
+     * @throws TransactionNotFound error for invalid transaction id
      */
-    create(options: TransactionDetails): Promise<string>;
+    get(id: string): Promise<TransactionDetails>;
     /**
-     * update existing transaction.
+     * Get transaction's origination and context
      *
      * @param id - unique identifier for the transaction
-     * @param options transaction details to be updated
-     * @returns transaction id and null if the transaction is not found
+     * @returns transaction origination information
+     * @throws TransactinNotFound error for invalid transaction id
      */
-    update(id: string, options: TransactionDetails): Promise<void | null>;
+    getOrigin(id: string): Promise<OriginDetails>;
     /**
-     * send event for the subject transaction
+     * refresh transaction origination context, if current one expires.
      *
      * @param id - unique identifier for the transaction
-     * @param options details of the event/message to be initiated
-     * @returns transaction event id
+     * @returns transaction origination information
+     * @throws TransactionNotFound error for invalid transaction id
      */
-    createEvent(id: string, options: TransactionEvent): Promise<string>;
+    refreshOrigin(id: string): Promise<OriginDetails>;
     /**
-     * Navigate your users back to where they left off in the host Encompass application,
-     * after they are done interacting with your application's user-interface
+     * 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
+     */
+    update(id: string, options: TransactionDetails): Promise<void>;
+    /**
+     * clean up
      */
-    close(): Promise<void>;
+    close(id: string): Promise<void>;
     /**
      * cancel the
      * This signals a cancelation outcome to the host application -
      * how this is handled by the host upon user navigation can vary across applications
      */
-    cancel(): Promise<void>;
+    cancel(id: string): Promise<void>;
     /**
      * Navigate your users back to where they left off in the host Encompass application,
      * after their has been an error (application error or workflow error) on your integrations user-interface.

package/package.json

@@ -1,11 +1,20 @@
 {
   "name": "@elliemae/pui-scripting-object",
-  "version": "1.11.0",
+  "version": "1.13.0",
   "description": "Typescript defintions for Scripting Objects",
   "sideEffects": false,
   "main": "./dist/cjs/index.js",
   "module": "./dist/es/index.js",
-  "typings": "./dist/types/index.d.ts",
+  "unpkg": "./dist/umd/index.js",
+  "jsdelivr": "./dist/imd/index.js",
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/es/index.js",
+      "require": "./dist/cjs/index.js"
+    }
+  },
   "files": [
     "dist",
     "build"
@@ -18,7 +27,7 @@
     "url": "https://git.elliemae.io/platform-ui/pui-scripting-object.git"
   },
   "engines": {
-    "pnpm": ">=6",
+    "pnpm": ">=7",
     "node": ">=16"
   },
   "author": "ICE",
@@ -58,7 +67,7 @@
   },
   "devDependencies": {
     "@elliemae/browserslist-config-elliemae-latest-browsers": "~1.5.0",
-    "@elliemae/pui-cli": "~7.10.3",
+    "@elliemae/pui-cli": "~7.12.2",
     "@elliemae/pui-doc-gen": "~1.3.0",
     "@elliemae/pui-theme": "~2.6.0",
     "@types/styled-components": "~5.1.26",