@elliemae/pui-scripting-object 1.13.0 → 1.14.0

package/dist/cjs/objects/transactionv2.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,13 @@ var __copyProps = (to, from, except, desc) => {
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var transactionv2_exports = {};
+__export(transactionv2_exports, {
+  CompleteReason: () => CompleteReason
+});
 module.exports = __toCommonJS(transactionv2_exports);
+var CompleteReason = /* @__PURE__ */ ((CompleteReason2) => {
+  CompleteReason2["CLOSE"] = "close";
+  CompleteReason2["CANCEL"] = "cancel";
+  CompleteReason2["ERROR"] = "error";
+  return CompleteReason2;
+})(CompleteReason || {});

package/dist/esm/objects/transactionv2.js

@@ -0,0 +1,9 @@
+var CompleteReason = /* @__PURE__ */ ((CompleteReason2) => {
+  CompleteReason2["CLOSE"] = "close";
+  CompleteReason2["CANCEL"] = "cancel";
+  CompleteReason2["ERROR"] = "error";
+  return CompleteReason2;
+})(CompleteReason || {});
+export {
+  CompleteReason
+};

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

@@ -25,14 +25,6 @@ export declare type OriginDetails = {
      * 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
      */

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

@@ -1,4 +1,21 @@
 import { OriginDetails, TransactionDetails, TransactionEvent, ResourceDetails, ResourceOptions } from './shared.js';
+/**
+ * reason for completing the user interaction with the transaction
+ */
+export declare enum CompleteReason {
+    /**
+     * user completed interaction with the transaction
+     */
+    CLOSE = "close",
+    /**
+     * user cancelled the interaction with transaction
+     */
+    CANCEL = "cancel",
+    /**
+     * interaction with the transaction errored out
+     */
+    ERROR = "error"
+}
 /**
  * Provides your applications lender/borrower-facing view with the necessary handles to model your application's
  * transactional interaction with the EPC platform.
@@ -43,21 +60,18 @@ export interface ITransactionV2 {
      */
     get(id: string): Promise<TransactionDetails>;
     /**
-     * Get transaction's origination and context
+     * Get origination and context
      *
-     * @param id - unique identifier for the transaction
-     * @returns transaction origination information
-     * @throws TransactinNotFound error for invalid transaction id
+     * @returns service setup origination information
+     * @throws OriginNotFound error when origin is not found
      */
-    getOrigin(id: string): Promise<OriginDetails>;
+    getOrigin(): Promise<OriginDetails>;
     /**
-     * refresh transaction origination context, if current one expires.
+     * refresh origination context, if current one expires.
      *
-     * @param id - unique identifier for the transaction
-     * @returns transaction origination information
-     * @throws TransactionNotFound error for invalid transaction id
+     * @returns origination information
      */
-    refreshOrigin(id: string): Promise<OriginDetails>;
+    refreshOrigin(): Promise<OriginDetails>;
     /**
      * update existing transaction.
      *
@@ -67,20 +81,11 @@ export interface ITransactionV2 {
      */
     update(id: string, options: TransactionDetails): Promise<void>;
     /**
-     * clean up
-     */
-    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(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.
-     * This signals an error outcome to the host Encompass application -
-     * how this is handled by the host upon user navigation can vary across applications
+     * 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
      */
-    error(): Promise<void>;
+    completeUserInteraction(id: string, reason: CompleteReason): Promise<void>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/pui-scripting-object",
-  "version": "1.13.0",
+  "version": "1.14.0",
   "description": "Typescript defintions for Scripting Objects",
   "sideEffects": false,
   "main": "./dist/cjs/index.js",
@@ -67,7 +67,7 @@
   },
   "devDependencies": {
     "@elliemae/browserslist-config-elliemae-latest-browsers": "~1.5.0",
-    "@elliemae/pui-cli": "~7.12.2",
+    "@elliemae/pui-cli": "~7.14.1",
     "@elliemae/pui-doc-gen": "~1.3.0",
     "@elliemae/pui-theme": "~2.6.0",
     "@types/styled-components": "~5.1.26",