@elliemae/pui-scripting-object 1.28.0 → 1.29.0

package/dist/cjs/objects/loan.js

@@ -18,9 +18,23 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var loan_exports = {};
 __export(loan_exports, {
-  LoanLevelActions: () => LoanLevelActions
+  LoanLevelActions: () => LoanLevelActions,
+  RecordActions: () => RecordActions,
+  RecordViewType: () => RecordViewType
 });
 module.exports = __toCommonJS(loan_exports);
+var RecordActions = /* @__PURE__ */ ((RecordActions2) => {
+  RecordActions2["ADD"] = "add";
+  RecordActions2["UPDATE"] = "update";
+  RecordActions2["DELETE"] = "delete";
+  RecordActions2["REPLACE"] = "replace";
+  return RecordActions2;
+})(RecordActions || {});
+var RecordViewType = /* @__PURE__ */ ((RecordViewType2) => {
+  RecordViewType2["ID"] = "id";
+  RecordViewType2["ENTITY"] = "entity";
+  return RecordViewType2;
+})(RecordViewType || {});
 var LoanLevelActions = /* @__PURE__ */ ((LoanLevelActions2) => {
   LoanLevelActions2["UPDATE_CORRESPONDENT_BALANCE"] = "updateCorrespondentBalance";
   LoanLevelActions2["UPDATE_CORRESPONDENT_FEES"] = "updateCorrespondentFees";

package/dist/esm/objects/loan.js

@@ -1,3 +1,15 @@
+var RecordActions = /* @__PURE__ */ ((RecordActions2) => {
+  RecordActions2["ADD"] = "add";
+  RecordActions2["UPDATE"] = "update";
+  RecordActions2["DELETE"] = "delete";
+  RecordActions2["REPLACE"] = "replace";
+  return RecordActions2;
+})(RecordActions || {});
+var RecordViewType = /* @__PURE__ */ ((RecordViewType2) => {
+  RecordViewType2["ID"] = "id";
+  RecordViewType2["ENTITY"] = "entity";
+  return RecordViewType2;
+})(RecordViewType || {});
 var LoanLevelActions = /* @__PURE__ */ ((LoanLevelActions2) => {
   LoanLevelActions2["UPDATE_CORRESPONDENT_BALANCE"] = "updateCorrespondentBalance";
   LoanLevelActions2["UPDATE_CORRESPONDENT_FEES"] = "updateCorrespondentFees";
@@ -6,5 +18,7 @@ var LoanLevelActions = /* @__PURE__ */ ((LoanLevelActions2) => {
   return LoanLevelActions2;
 })(LoanLevelActions || {});
 export {
-  LoanLevelActions
+  LoanLevelActions,
+  RecordActions,
+  RecordViewType
 };

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

@@ -37,6 +37,62 @@ export type CurrentApplicationOptions = {
      */
     borrowerPairId: string;
 };
+/**
+ * loan record actions
+ */
+export declare enum RecordActions {
+    /**
+     * add record action
+     */
+    ADD = "add",
+    /**
+     * update record action
+     */
+    UPDATE = "update",
+    /**
+     * delete record action
+     */
+    DELETE = "delete",
+    /**
+     * replace record action
+     */
+    REPLACE = "replace"
+}
+/**
+ * loan record view types
+ */
+export declare enum RecordViewType {
+    /**
+     * id view type
+     */
+    ID = "id",
+    /**
+     * entity view type
+     */
+    ENTITY = "entity"
+}
+export type LoanRecord = unknown;
+/**
+ * options for updating records
+ */
+export type RecordOptions = {
+    /**
+     * operation to be performed on record
+     */
+    action: RecordActions;
+    /**
+     * loan v3 contract path
+     */
+    contractPath: string;
+    /**
+     * records to be updated
+     */
+    data: Array<LoanRecord>;
+    /**
+     * record view type
+     */
+    view: RecordViewType;
+};
 /**
  * v3 loan object
  */
@@ -290,11 +346,12 @@ export interface ILoan extends IScriptingObject {
     getCurrentApplication(): Promise<Record<string, string>>;
     /**
      * Update data for current application
-     * @param options
+     * @param options {CurrentApplicationOptions} options for setting current application
      */
     setCurrentApplication(options: CurrentApplicationOptions): Promise<void>;
     /**
      * Execute loan level action, this is specific to v3 stateful implementation
+     * @param type {LoanLevelActions} type of action to be executed
      */
     execAction(type: LoanLevelActions): Promise<LoanObject>;
     /**
@@ -302,6 +359,16 @@ export interface ILoan extends IScriptingObject {
      * @param name collection template name
      */
     getCollection(name: string): Promise<Record<string, string>>;
+    /**
+     * get snapshot of loan object
+     */
     getLockSnapshot(): Promise<Record<string, string>>;
+    /**
+     * insert, delete, update, replace different loand record types.
+     * scope includes log and non-log record types
+     * @param options {RecordOptions} options for updating records
+     * @returns array of record ids or loan view entity
+     */
+    updateRecords(options: RecordOptions): Promise<Array<string> | Array<unknown>>;
 }
 export {};

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

@@ -11,15 +11,14 @@ 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
      */
-    set(clientId: string, key: string, value: unknown): Promise<void>;
+    set(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
      */
-    get(clientId: string, key: string): Promise<unknown>;
+    get(key: string): Promise<unknown>;
 }

package/package.json

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