@elliemae/pui-scripting-object 1.17.0 → 1.18.0

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

@@ -98,9 +98,16 @@ export interface ILoanV2 extends Omit<ILoan, 'commit' | 'setFields' | 'merge'> {
     /**
      * Commit all pending changes on the current loan
      *
-     * @returns {Promise<void>}
-     * @throws {Error} if operation fails due to network errors
-     * @throws {CommitError} if operation fails due to business / functional rules
+     * {@link LoanEvents}
+     * loan.precommit event is fired before the commit is executed. If any of the event listeners return false, the commit will be aborted. Exception thrown by event listeners will be ignored. Event listeners have 60 seconds to complete their execution. After 60 seconds, the commit will proceed, if none of the listeners returned false.
+     *
+     * {@link LoanEvents}
+     * loan.committed event is fired after the commit is successful.
+     *
+     * @throws RuleValidationError
+     * if operation fails due to business / functional rules
+     * @throws Error
+     * if operation fails due to network errors
      *
      * #### Product Compatibility:
      * | | Encompass | Encompass Web | TPO | Consumer Connect |
@@ -113,11 +120,20 @@ export interface ILoanV2 extends Omit<ILoan, 'commit' | 'setFields' | 'merge'> {
      *
      * @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} if operation fails due to network errors
+     * @throws Error
+     * if operation fails due to network errors
      */
     getContractPath(fieldIds: string[]): Promise<FieldIDToContractPath[]>;
     /**
      * Syncs the loan workspace with any changes made by other users
+     *
+     * {@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
+     *
      * #### Product Compatibility:
      * | | Encompass | Encompass Web | TPO | Consumer Connect |
      * :-----:|:-----: |:-----: |:-----: |:-----: |
@@ -129,7 +145,8 @@ export interface ILoanV2 extends Omit<ILoan, 'commit' | 'setFields' | 'merge'> {
      *
      * @param fields list of field ids and their values
      * @returns list of field ids that failed to set
-     * @throws {Error} if operation fails due to network error
+     * @throws Error
+     * if operation fails due to network error
      *
      * #### Product Compatibility:
      * | | Encompass | Encompass Web | TPO | Consumer Connect |

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

@@ -63,10 +63,11 @@ export interface ITransactionV2 extends IScriptingObject {
     /**
      * 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
      */
-    createOrigin(): Promise<OriginDetails>;
+    createOrigin(withLoanData: boolean): Promise<OriginDetails>;
     /**
      * update existing transaction.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/pui-scripting-object",
-  "version": "1.17.0",
+  "version": "1.18.0",
   "description": "Typescript defintions for Scripting Objects",
   "sideEffects": false,
   "main": "./dist/cjs/index.js",
@@ -67,13 +67,13 @@
   },
   "devDependencies": {
     "@elliemae/browserslist-config-elliemae-latest-browsers": "~1.6.0",
-    "@elliemae/pui-cli": "~7.18.0",
-    "@elliemae/pui-doc-gen": "~1.3.0",
+    "@elliemae/pui-cli": "~7.22.0",
+    "@elliemae/pui-doc-gen": "~1.4.1",
     "@elliemae/pui-theme": "~2.6.0",
     "@types/styled-components": "~5.1.26",
     "history": "~5.3.0",
     "redux": "~4.2.0",
-    "redux-saga": "~1.2.1",
+    "redux-saga": "~1.2.2",
     "styled-components": "~5.3.6"
   },
   "peerDependencies": {}