@elliemae/pui-scripting-object 1.1.0 → 1.3.1

package/dist/types/application.d.ts

@@ -1,17 +1,17 @@
-export interface AppInfo {
+export declare type AppInfo = {
     id: string;
     name: string;
-}
+};
 export declare enum ApplicationExtensionType {
     TOOL = "TOOL",
     MENU = "MENU"
 }
-export interface ApplicationExtension {
+export declare type ApplicationExtension = {
     type: ApplicationExtensionType;
     text: string;
     url: string;
     options?: Record<string, string>;
-}
+};
 export declare enum NavigationType {
     STANDARD_FORM = "STANDARD_FORM",
     STANDARD_TOOL = "STANDARD_TOOL",
@@ -20,43 +20,52 @@ export declare enum NavigationType {
     GLOBAL_CUSTOM_TOOL = "GLOBAL_CUSTOM_TOOL",
     OTHER = "OTHER"
 }
-export interface NavigationOptions {
+export declare type NavigationOptions = {
     target: string;
     type: NavigationType;
     context?: Record<string, string>;
-}
-export interface OpenOptions {
+};
+export declare type OpenOptions = {
     target: string;
     type?: string;
-}
+};
 export declare enum ModalSize {
     SMALL = "sm",
     MEDIUM = "md",
     LARGE = "lg"
 }
-export interface OpenModalOptions {
+export declare type OpenModalOptions = {
     target: string;
     name: string;
     type?: string;
     size: ModalSize;
-}
-export interface Capabilities {
+};
+export declare type Capabilities = {
     supprotedActions: Array<string>;
     supportedFeatures: Array<string>;
-}
-export interface Route {
+};
+export declare type Route = {
     url: string;
     type: NavigationType;
     name: string;
     id: string;
-}
-export interface Environment {
+};
+export declare type Environment = {
     apiHost: string;
-}
-export interface ApplicationContext {
+};
+export declare type ApplicationContext = {
     env: Environment;
     route: Route;
-}
+};
+/**
+ * Options for printing the document
+ */
+export declare type PrintOptions = {
+    /**
+     * document to print
+     */
+    blob: Blob;
+};
 /**
  * The Application Object allows for access to application-level UI elements, behaviors and events
  */
@@ -82,6 +91,12 @@ export interface IApplication {
     hideSpinner(): Promise<void>;
     getPoliciesDetails(): Promise<Record<string, string>>;
     getPersonaAccess(): Promise<Record<string, string>>;
+    /**
+     * Prints given document
+     *
+     * @param options Print options
+     */
+    print(options: PrintOptions): Promise<void>;
 }
 export declare type AppLoginListener = () => void;
 export declare type AppActionCompletedListener = (name: string) => void;

package/dist/types/auth.d.ts

@@ -1,9 +1,9 @@
-export interface Personas {
+export declare type Personas = {
     entityId: string;
     entityType: string;
     entityName: string;
-}
-export interface User {
+};
+export declare type User = {
     id: string;
     realm: string;
     firstName: string;
@@ -13,20 +13,20 @@ export interface User {
     personas: Array<Personas>;
     clientId: string;
     email: string;
-}
+};
 export declare enum TokenType {
     BEARER = "Bearer"
 }
-export interface PluginInfo {
+export declare type PluginInfo = {
     clientId: string;
     redirectUrl: string;
     scope: TokenType;
-}
-export interface TokenInfo {
+};
+export declare type TokenInfo = {
     accessToken: string;
     tokenType: TokenType;
     apiBaseUrl: string;
-}
+};
 export interface IAuth {
     tokenUrl: string;
     createAuthCode(clientId: string): Promise<string>;

package/dist/types/form.d.ts

@@ -1,7 +1,7 @@
-export interface FormDescriptor {
+export declare type FormDescriptor = {
     id: string;
     name: string;
-}
+};
 export interface IForm {
     getDescriptor(): Promise<FormDescriptor>;
     getControl(id: string): Promise<any>;

package/dist/types/loan.d.ts

@@ -1,8 +1,74 @@
+/**
+ * option name and its value
+ */
+export declare type FieldOptions = {
+    /**
+     * option name
+     */
+    name: string;
+    /**
+     * option value
+     */
+    value: string;
+};
+/**
+ * The Loan object provides methods for interacting with an open loan in the application's editor screen(s).
+ */
 export interface ILoan {
-    all(): Promise<Record<string, string>>;
+    /**
+     * Gets entire Loan object
+     *
+     * @returns v3 Loan Object
+     *
+     * #### Product Compatibility:
+     * | | Encompass | Encompass Web | TPO | Consumer Connect |
+     * :-----:|:-----: |:-----: |:-----: |:-----: |
+     * | all |  ✔ |  ✔ |  ✔ |  ✖️ |
+     */
+    all(): Promise<Record<string, any>>;
     apply(loan: Record<string, string>): Promise<void>;
     commit(): Promise<void>;
     getField(id: string): Promise<string>;
+    /**
+     * get options for list of fields
+     *
+     * @param fieldIds array of field ids to get field options
+     * @returns array of field options for each field id
+     *
+     * #### Example
+     *
+     *  Get Field options for set of field Ids
+     *  ```ts
+     *  const fieldOptions = await loan.getFieldOptions(['1543', '1544']);
+     *  ```
+     *
+     * Following is a sample field options for field Id 1543:
+     * ```
+     *  1543: [
+     *   {
+     *     value: 'Manual Underwriting',
+     *     name: 'Manual Underwriting'
+     *   },
+     *   {
+     *     value: 'DU',
+     *     name: 'DU'
+     *   },
+     *   {
+     *     value: 'LP',
+     *     name: 'LP'
+     *   },
+     *   {
+     *     value: 'LQA',
+     *     name: 'LQA'
+     *   },
+     *   {
+     *     value: 'Other',
+     *     name: 'Other'
+     *   }
+     * ]
+     * ```
+     */
+    getFieldOptions(fieldIds: string[]): Promise<Record<string, FieldOptions[]>>;
     getFields(ids: string[]): Promise<Record<string, string>>;
     setFields(fields: Record<string, string>): Promise<void>;
     merge(): Promise<void>;

package/dist/types/transaction.d.ts

@@ -1,43 +1,43 @@
-export interface OriginInfo {
+export declare type OriginInfo = {
     partnerAccessToken: string;
     id: string;
     transactionId?: string;
-}
-export interface TransactionInfo {
+};
+export declare type TransactionInfo = {
     id: string | null;
-}
-export interface TransactionResource {
+};
+export declare type TransactionResource = {
     id: string;
     name: string;
     repository: string;
     mimeType: string;
-}
-export interface TransactionOptions {
+};
+export declare type TransactionOptions = {
     scope?: Array<string>;
     request: {
         type: string;
         options?: Record<string, string>;
         resources: Array<TransactionResource>;
     };
-}
-export interface TransactionResourceFile {
+};
+export declare type TransactionResourceFile = {
     name: string;
     source: string;
-}
-export interface TransactionResourceResponse {
+};
+export declare type TransactionResourceResponse = {
     id: string;
     respository: string;
     name: string;
     location: string;
     authorizationHeader: string;
     mimeType: string;
-}
-export interface TransactionEvent {
+};
+export declare type TransactionEvent = {
     text: string;
     type: string;
     comments: string;
     resources: Array<TransactionResource>;
-}
+};
 export interface ITransaction {
     getOrigin(): Promise<OriginInfo>;
     refreshOrigin(): Promise<OriginInfo>;

package/dist/types/transactiontemplate.d.ts

@@ -1,10 +1,10 @@
-export interface TransactionRequest {
+export declare type TransactionRequest = {
     type: string;
     options?: Record<string, string>;
-}
-export interface TransactionTemplateOptions {
+};
+export declare type TransactionTemplateOptions = {
     request: Array<TransactionRequest>;
-}
+};
 export interface ITransactionTemplate {
     get(): Promise<TransactionTemplateOptions | null>;
     save(options: TransactionTemplateOptions): Promise<string>;

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@elliemae/pui-scripting-object",
-  "version": "1.1.0",
+  "version": "1.3.1",
   "description": "Typescript defintions for Scripting Objects",
   "sideEffects": false,
   "main": "./dist/cjs/index.js",
   "module": "./dist/es/index.js",
   "typings": "./dist/types/lib/index.d.ts",
   "files": [
-    "dist"
+    "dist",
+    "build"
   ],
   "publishConfig": {
     "access": "public"
@@ -25,6 +26,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/public",
+    "docs:version": "docusaurus docs:version",
+    "docs:serve": "docusaurus serve",
     "gendoc": "pui-cli gendoc",
     "lint": "pui-cli lint",
     "lint:fix": "pui-cli lint --fix",
@@ -35,7 +40,7 @@
     "storybook:build": "exit 0",
     "storybook:docs:build": "exit 0",
     "storybook:prod": "exit 0",
-    "setup": "rimraf -r node_modules && rimraf pnpm-lock.yaml && pnpm i",
+    "setup": "rimraf node_modules && rimraf pnpm-lock.yaml && pnpm i",
     "test": "pui-cli test -p",
     "test:fix": "pui-cli test -f",
     "test:watch": "jest --watch",
@@ -53,7 +58,8 @@
   },
   "devDependencies": {
     "@elliemae/browserslist-config-elliemae-latest-browsers": "~1.5.0",
-    "@elliemae/pui-cli": "7.0.0",
+    "@elliemae/pui-cli": "~7.1.0",
+    "@elliemae/pui-doc-gen": "~1.0.7",
     "@types/styled-components": "~5.1.26",
     "redux": "~4.2.0",
     "redux-saga": "~1.2.0",