@elliemae/pui-scripting-object 1.19.1 → 1.20.0

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

@@ -1,5 +1,22 @@
 import { IEvent, Listener } from '../event.js';
 import { IScriptingObject } from '../scriptingObject.js';
+/**
+ * Parameters for getting field options
+ */
+export type FieldOptionsParam = {
+    /**
+     * list of field Ids
+     *
+     * @example ['1001', '1002']
+     */
+    fieldIds?: string[];
+    /**
+     * list of control Ids
+     *
+     * @example ['1001', '1002']
+     */
+    controlIds?: string[];
+};
 /**
  * option name and its value
  */
@@ -203,16 +220,21 @@ export interface ILoan extends IScriptingObject {
      */
     getField(id: string): Promise<string>;
     /**
-     * get options for list of fields
+     * get options for loan fields / custom form controls
+     * supports both standard & custom loan fields.
+     * control Ids takes precedence over field Ids.
      *
-     * @param fieldIds array of field ids to get field options
-     * @returns array of field options for each field id
+     * @param {FieldOptionsParam} param parameter for getting field options
+     * @returns array of field options for each field / control id
      *
      * #### Example
      *
-     *  Get Field options for set of field Ids
      *  ```ts
-     *  const fieldOptions = await loan.getFieldOptions(['1543', '1544']);
+     *  const fieldOptions = await loan.getFieldOptions({ fieldIds: ['1543', '1544'] });
+     *  ```
+     *
+     *  ```ts
+     *  const fieldOptions = await loan.getFieldOptions({ controlIds: ['111', '112'] });
      *  ```
      *
      * Following is a sample field options for field Id 1543:
@@ -241,7 +263,7 @@ export interface ILoan extends IScriptingObject {
      * ]
      * ```
      */
-    getFieldOptions(fieldIds: string[]): Promise<Record<string, FieldOptions[]>>;
+    getFieldOptions(param: FieldOptionsParam): Promise<Record<string, FieldOptions[]>>;
     /**
      * Returns the value of a single field using its field ID.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/pui-scripting-object",
-  "version": "1.19.1",
+  "version": "1.20.0",
   "description": "Typescript defintions for Scripting Objects",
   "sideEffects": false,
   "type": "module",
@@ -36,10 +36,10 @@
   "scripts": {
     "build": "pui-cli pack -p -t node",
     "build:dev": "pui-cli pack -t node",
-    "docs:start": "docusaurus start",
-    "docs:build": "docusaurus build --out-dir build/docs",
-    "docs:version": "docusaurus docs:version",
-    "docs:serve": "docusaurus serve",
+    "docs:start": "pui-doc-gen start",
+    "docs:build": "pui-doc-gen build",
+    "docs:version": "pui-doc-gen version",
+    "docs:serve": "pui-doc-gen serve",
     "gendoc": "pui-cli gendoc",
     "lint": "pui-cli lint",
     "lint:fix": "pui-cli lint --fix",
@@ -67,15 +67,15 @@
     "sonar56x": true
   },
   "devDependencies": {
-    "@elliemae/browserslist-config-elliemae-latest-browsers": "~1.6.0",
-    "@elliemae/pui-cli": "~8.0.0",
+    "@elliemae/browserslist-config-elliemae-latest-browsers": "~1.7.0",
+    "@elliemae/pui-cli": "~8.5.2",
     "@elliemae/pui-doc-gen": "~1.6.4",
-    "@elliemae/pui-theme": "~2.6.0",
+    "@elliemae/pui-theme": "~2.7.0",
     "@types/styled-components": "~5.1.26",
     "history": "~5.3.0",
     "redux": "~4.2.1",
-    "redux-saga": "~1.2.2",
-    "styled-components": "~5.3.6"
+    "redux-saga": "~1.2.3",
+    "styled-components": "~5.3.9"
   },
   "peerDependencies": {}
 }