@elliemae/pui-scripting-object 1.10.1 → 1.11.0

package/dist/cjs/index.js

@@ -30,6 +30,8 @@ __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);

package/dist/cjs/objects/shared.js

@@ -0,0 +1,28 @@
+"use strict";
+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))
+      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 shared_exports = {};
+__export(shared_exports, {
+  OriginContext: () => OriginContext
+});
+module.exports = __toCommonJS(shared_exports);
+var OriginContext = /* @__PURE__ */ ((OriginContext2) => {
+  OriginContext2["LENDER"] = "lender";
+  OriginContext2["CONSUMER"] = "consumer";
+  return OriginContext2;
+})(OriginContext || {});

package/dist/cjs/objects/transaction.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,12 +13,4 @@ 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/transactionv2.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 transactionv2_exports = {};
+module.exports = __toCommonJS(transactionv2_exports);

package/dist/esm/index.js

@@ -13,6 +13,8 @@ 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";

package/dist/esm/objects/shared.js

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

package/dist/esm/objects/transaction.js

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

package/dist/types/index.d.ts

@@ -13,8 +13,10 @@ 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 type { ScriptingObjectEvents } from './events.js';
 export type { ScriptingObjectTypes } from './scriptingObjectTypes.js';

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

@@ -0,0 +1,75 @@
+/**
+ * user type context
+ */
+export declare enum OriginContext {
+    /**
+     * user interface is being presented to a user in a lending enterprise
+     */
+    LENDER = "lender",
+    /**
+     * user interface is being presented to a consumer/borrower
+     */
+    CONSUMER = "consumer"
+}
+/**
+ * transaction origination context
+ */
+export declare type OriginInfo = {
+    /**
+     * 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
+     */
+    partnerAccessToken: string;
+    /**
+     * Unique identifier for the transaction origination information snapshot accessible
+     * via the REST API's /partner/v2/origins/:id endpoint
+     */
+    id: string;
+    /**
+     * Unique identifier for the transaction in whose context the
+     * partner integrations user-interface is being launched.
+     * This is only available in the situation where your integration
+     * is being launched in the context of an existing transaction,
+     * and can be used to decide the appropriate view to display to users
+     */
+    transactionId?: string;
+    /**
+     * The user type in whose context your integration is being launched
+     */
+    context: OriginContext;
+};
+/**
+ * file attachment information
+ */
+export declare type TransactionResource = {
+    /**
+     * unique identifier for the file attachment
+     */
+    id: string;
+    /**
+     * name of the file attachment
+     */
+    name: string;
+    /**
+     * mime type of the file attachment
+     */
+    mimeType: string;
+};
+export declare type TransactionEvent = {
+    /**
+     * event name
+     */
+    text: string;
+    /**
+     * urn representing the event type
+     */
+    type: string;
+    /**
+     * comments related to event
+     */
+    comments: string;
+    /**
+     * list of file attachments related to event
+     */
+    resources: Array<TransactionResource>;
+};

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

@@ -1,43 +1,4 @@
-/**
- * user type context
- */
-export declare enum OriginContext {
-    /**
-     * user interface is being presented to a user in a lending enterprise
-     */
-    LENDER = "lender",
-    /**
-     * user interface is being presented to a consumer/borrower
-     */
-    CONSUMER = "consumer"
-}
-/**
- * transaction origination context
- */
-export declare type OriginInfo = {
-    /**
-     * 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
-     */
-    partnerAccessToken: string;
-    /**
-     * Unique identifier for the transaction origination information snapshot accessible
-     * via the REST API's /partner/v2/origins/:id endpoint
-     */
-    id: string;
-    /**
-     * Unique identifier for the transaction in whose context the
-     * partner integrations user-interface is being launched.
-     * This is only available in the situation where your integration
-     * is being launched in the context of an existing transaction,
-     * and can be used to decide the appropriate view to display to users
-     */
-    transactionId?: string;
-    /**
-     * The user type in whose context your integration is being launched
-     */
-    context: OriginContext;
-};
+import { OriginInfo, TransactionResource, TransactionEvent } from './shared.js';
 /**
  * details about the transaction that is created / updated
  */
@@ -47,23 +8,6 @@ export declare type TransactionInfo = {
      */
     id: string | null;
 };
-/**
- * file attachment information
- */
-export declare type TransactionResource = {
-    /**
-     * unique identifier for the file attachment
-     */
-    id: string;
-    /**
-     * name of the file attachment
-     */
-    name: string;
-    /**
-     * mime type of the file attachment
-     */
-    mimeType: string;
-};
 /**
  * information about the transaction to be initiated
  */
@@ -127,24 +71,6 @@ export declare type TransactionResourceResponse = {
      */
     authorizationHeader: string;
 };
-export declare type TransactionEvent = {
-    /**
-     * event name
-     */
-    text: string;
-    /**
-     * urn representing the event type
-     */
-    type: string;
-    /**
-     * comments related to event
-     */
-    comments: string;
-    /**
-     * list of file attachments related to event
-     */
-    resources: Array<TransactionResource>;
-};
 /**
  * Provides your applications lender/borrower-facing view with the necessary handles to model your application's
  * transactional interaction with the EPC platform.

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

@@ -0,0 +1,140 @@
+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;
+};
+/**
+ * Provides your applications lender/borrower-facing view with the necessary handles to model your application's
+ * transactional interaction with the EPC platform.
+ * Allows access to an interactive session's origination context,
+ * create a new transaction,
+ * update an existing transaction,
+ * create events/messages for a transaction, and more.
+ */
+export interface ITransactionV2 {
+    /**
+     * Get transaction's origination and context
+     *
+     * @param id - unique identifier for the transaction
+     * @returns transaction origination information and null if the transaction is not found
+     */
+    getOrigin(id: string): Promise<OriginInfo | null>;
+    /**
+     * Refresh transaction origination context, if current one expires.
+     *
+     * @param id - unique identifier for the transaction
+     * @returns transaction origination information or null if the transaction is not found
+     */
+    refreshOrigin(id: string): Promise<OriginInfo | null>;
+    /**
+     * 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
+     */
+    createResource(id: string, options: ResourceOptions): Promise<CreateResourceResponse | null>;
+    /**
+     * create new transaction
+     *
+     * @param options details of the transaction to be created
+     * @returns transaction id
+     */
+    create(options: TransactionDetails): Promise<string>;
+    /**
+     * update existing transaction.
+     *
+     * @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
+     */
+    update(id: string, options: TransactionDetails): Promise<void | null>;
+    /**
+     * 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
+     */
+    createEvent(id: string, options: TransactionEvent): Promise<string>;
+    /**
+     * 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
+     */
+    close(): 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>;
+    /**
+     * 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.
+     * This signals an error outcome to the host Encompass application -
+     * how this is handled by the host upon user navigation can vary across applications
+     */
+    error(): Promise<void>;
+}

package/dist/types/scriptingObjectTypes.d.ts

@@ -4,6 +4,7 @@ import { IApplication } from './objects/application.js';
 import { IAuth } from './objects/auth.js';
 import { ISession } from './objects/session.js';
 import { ITransaction } from './objects/transaction.js';
+import { ITransactionV2 } from './objects/transactionv2.js';
 import { ITransactionTemplate } from './objects/transactionTemplate.js';
 import { IForm } from './objects/form.js';
 import { IGlobal } from './objects/global.js';
@@ -29,6 +30,7 @@ export declare type ScriptingObjectTypes = {
     Service: IService;
     Session: ISession;
     Transaction: ITransaction;
+    TransactionV2: ITransactionV2;
     TransactionTemplate: ITransactionTemplate;
     View: IView;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/pui-scripting-object",
-  "version": "1.10.1",
+  "version": "1.11.0",
   "description": "Typescript defintions for Scripting Objects",
   "sideEffects": false,
   "main": "./dist/cjs/index.js",