@elliemae/pui-scripting-object 1.4.0 → 1.6.0

package/dist/cjs/index.js

@@ -26,3 +26,4 @@ __reExport(lib_exports, require("./script.js"), module.exports);
 __reExport(lib_exports, require("./session.js"), module.exports);
 __reExport(lib_exports, require("./transaction.js"), module.exports);
 __reExport(lib_exports, require("./transactiontemplate.js"), module.exports);
+__reExport(lib_exports, require("./userAccessRights.js"), module.exports);

package/dist/cjs/userAccessRights.js

@@ -0,0 +1,16 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var userAccessRights_exports = {};
+module.exports = __toCommonJS(userAccessRights_exports);

package/dist/esm/index.js

@@ -9,3 +9,4 @@ export * from "./script.js";
 export * from "./session.js";
 export * from "./transaction.js";
 export * from "./transactiontemplate.js";
+export * from "./userAccessRights.js";

package/dist/types/auth.d.ts

@@ -1,3 +1,4 @@
+import { UserAccessRights } from './userAccessRights';
 export declare type Personas = {
     entityId: string;
     entityType: string;
@@ -32,4 +33,11 @@ export interface IAuth {
     createAuthCode(clientId: string): Promise<string>;
     getAccessToken(appInfo: PluginInfo): Promise<TokenInfo>;
     getUser(): Promise<User>;
+    /**
+     * Get access rights for the current user
+     *
+     * @returns user access rights
+     * @throws {Error} if operation fails
+     */
+    getUserAccessRights(): Promise<UserAccessRights>;
 }

package/dist/types/index.d.ts

@@ -9,3 +9,4 @@ export * from './script.js';
 export * from './session.js';
 export * from './transaction.js';
 export * from './transactiontemplate.js';
+export * from './userAccessRights.js';

package/dist/types/loan.d.ts

@@ -11,12 +11,15 @@ export declare type FieldOptions = {
      */
     value: string;
 };
+export declare type SetFieldResponse = {
+    failed: string[];
+};
 /**
  * The Loan object provides methods for interacting with an open loan in the application's editor screen(s).
  */
 export interface ILoan {
     /**
-     * Gets entire Loan object
+     * Get entire Loan object
      *
      * @returns v3 Loan Object
      *
@@ -27,7 +30,18 @@ export interface ILoan {
      */
     all(): Promise<Record<string, any>>;
     apply(loan: Record<string, string>): Promise<void>;
-    commit(): Promise<void>;
+    /**
+     * Commit all pending changes for the current loan
+     *
+     * @returns v3 Loan Object
+     * @throws {Error} if the loan is not in a valid state or if there are business rule violations
+     *
+     * #### Product Compatibility:
+     * | | Encompass | Encompass Web | TPO | Consumer Connect |
+     * :-----:|:-----: |:-----: |:-----: |:-----: |
+     * | all |  ✔ |  ✔ |  ✔ |  ✖️ |
+     */
+    commit(): Promise<Record<string, any>>;
     getField(id: string): Promise<string>;
     /**
      * get options for list of fields
@@ -70,7 +84,14 @@ export interface ILoan {
      */
     getFieldOptions(fieldIds: string[]): Promise<Record<string, FieldOptions[]>>;
     getFields(ids: string[]): Promise<Record<string, string>>;
-    setFields(fields: Record<string, string>): Promise<void>;
+    /**
+     * Set the values of one or more fields on the Loan.
+     *
+     * @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
+     */
+    setFields(fields: Record<string, string>): Promise<SetFieldResponse>;
     merge(): Promise<void>;
     isReadOnly(): Promise<boolean>;
     applyLock(fieldId: string, lock: boolean): Promise<void>;

package/dist/types/userAccessRights.d.ts

@@ -0,0 +1,361 @@
+export declare type UserAccessRights = {
+    access: string[];
+    additionalServices: AdditionalServices;
+    ausTracking: AusTracking;
+    borrowerContacts: BorrowerContacts;
+    businessContacts: BusinessContacts;
+    businessRules: BusinessRules;
+    closingDocs: string[];
+    companyUserSetup: CompanyUserSetup;
+    contacts: Contacts;
+    contactSetup: ContactSetup;
+    consumerConnect: string[];
+    dashboard: Dashboard;
+    disclosureTracking: DisclosureTracking;
+    docsSetup: DocsSetup;
+    documents: Documents;
+    dynamicDataManagement: DynamicDataManagement;
+    eDisclosures: EDisclosures;
+    eFolderHistory: EFolderHistory;
+    eFolderSetup: EFolderSetup;
+    externalSettings: string[];
+    eVault: EVault;
+    fileContacts: FileContacts;
+    forms: Form[];
+    gseServices: GseServices;
+    home: string[];
+    importLoans: ImportLoan[];
+    services: Service[];
+    itemizationFee: string[];
+    loan: string[];
+    loanSetup: LoanSetup;
+    manageServiceProviders: ManageServiceProviders;
+    milestoneWorkflowManagement: MilestoneWorkflowManagement;
+    moveLoans: MoveLoans;
+    personalSettings: string[];
+    personalTemplates: PersonalTemplates;
+    pipeline: Pipeline;
+    exportServices: ExportServices;
+    postClosingConditions: PostClosingConditions;
+    preliminaryConditions: PreliminaryConditions;
+    purchaseConditions: PurchaseConditions;
+    reports: string[];
+    print: Print;
+    secondarySetup: SecondarySetup;
+    deliveryConditions: DeliveryConditions;
+    settings: string[];
+    smartClient: string[];
+    systemAdministration: SystemAdministration;
+    tablesAndFees: TablesAndFees;
+    tools: Tool[];
+    tpoCompanyDetails: TpoCompanyDetails;
+    tpoConnectSiteSettings: TpoConnectSiteSettings;
+    tpoContacts: TpoContacts;
+    tpoFees: TpoFees;
+    tpoInformation: TpoInformation;
+    tpoOrganizationSettings: TpoOrganizationSettings;
+    tqlServices: TqlServices;
+    trades: Trades;
+    underwritingConditions: UnderwritingConditions;
+    enhancedConditions: EnhancedConditions;
+    loConnectTasks: LoConnectTasks;
+    encompassWebServices: EncompassWebServices;
+    underwritingCenter: UnderwritingCenter;
+};
+export declare type AdditionalServices = {
+    access: boolean;
+    rights: string[];
+};
+export declare type AusTracking = {
+    access: boolean;
+    rights: string[];
+};
+export declare type BorrowerContacts = {
+    access: boolean;
+    rights: string[];
+};
+export declare type BusinessContacts = {
+    access: boolean;
+    rights: string[];
+};
+export declare type BusinessRules = {
+    access: boolean;
+    rights: string[];
+};
+export declare type CompanyUserSetup = {
+    access: boolean;
+    rights: string[];
+};
+export declare type Contacts = {
+    access: boolean;
+    rights: string[];
+};
+export declare type ContactSetup = {
+    access: boolean;
+    rights: string[];
+};
+export declare type Dashboard = {
+    access: boolean;
+    rights: string[];
+};
+export declare type DisclosureTracking = {
+    access: boolean;
+    rights: string[];
+};
+export declare type DocsSetup = {
+    access: boolean;
+    rights: string[];
+};
+export declare type Documents = {
+    access: boolean;
+    rights: string[];
+    protectedDocuments: string[];
+    unprotectedDocuments: string[];
+    unassignedFiles: string[];
+};
+export declare type DynamicDataManagement = {
+    access: boolean;
+    rights: string[];
+};
+export declare type EDisclosures = {
+    access: boolean;
+    rights: string[];
+};
+export declare type EFolderHistory = {
+    access: boolean;
+};
+export declare type EFolderSetup = {
+    access: boolean;
+    rights: string[];
+};
+export declare type EVault = {
+    eVaultPortal: EVaultPortal;
+};
+export declare type EVaultPortal = {
+    access: boolean;
+    rights: string[];
+};
+export declare type FileContacts = {
+    access: boolean;
+    rights: string[];
+    grantWriteAccess: GrantWriteAccess;
+};
+export declare type GrantWriteAccess = {
+    access: boolean;
+    loanTeam: LoanTeam[];
+};
+export declare type LoanTeam = {
+    role: Role;
+};
+export declare type Role = {
+    entityId: string;
+    entityName: string;
+    entityType: string;
+};
+export declare type Form = {
+    entityId: string;
+    entityName: string;
+    entityType: string;
+};
+export declare type GseServices = {
+    access: boolean;
+    rights: string[];
+};
+export declare type ImportLoan = {
+    entityId: string;
+    entityType: string;
+};
+export declare type Service = {
+    category: string;
+    accessSetting: string;
+    defaultAccess: string;
+};
+export declare type LoanSetup = {
+    access: boolean;
+    rights: string[];
+};
+export declare type ManageServiceProviders = {
+    accessSetting: string;
+    rights: string[];
+};
+export declare type MilestoneWorkflowManagement = {
+    acceptFiles: AcceptFile[];
+    returnFiles: ReturnFile[];
+    changeExpectedDate: ChangeExpectedDate[];
+    finishMilestones: FinishMilestone[];
+    assignLoanTeamMembers: AssignLoanTeamMember[];
+    editComments: EditComment[];
+};
+export declare type AcceptFile = {
+    entityId: string;
+    entityName: string;
+    entityType: string;
+};
+export declare type ReturnFile = {
+    entityId: string;
+    entityName: string;
+    entityType: string;
+};
+export declare type ChangeExpectedDate = {
+    entityId: string;
+    entityName: string;
+    entityType: string;
+};
+export declare type FinishMilestone = {
+    entityId: string;
+    entityName: string;
+    entityType: string;
+};
+export declare type AssignLoanTeamMember = {
+    milestone: Milestone;
+    role?: Role2;
+};
+export declare type Milestone = {
+    entityId: string;
+    entityName: string;
+    entityType: string;
+};
+export declare type Role2 = {
+    entityId: string;
+    entityName: string;
+    entityType: string;
+};
+export declare type EditComment = {
+    entityId: string;
+    entityName: string;
+    entityType: string;
+};
+export declare type MoveLoans = {
+    access: boolean;
+    moveFrom: MoveFrom[];
+    moveTo: MoveTo[];
+};
+export declare type MoveFrom = {
+    entityId: string;
+    entityType: string;
+};
+export declare type MoveTo = {
+    entityId: string;
+    entityType: string;
+};
+export declare type PersonalTemplates = {
+    access: boolean;
+    rights: string[];
+};
+export declare type Pipeline = {
+    access: boolean;
+    pipelineTasks: string[];
+    pipelineViews: PipelineView[];
+    nonAccessibleColumns: any[];
+};
+export declare type PipelineView = {
+    entityId: string;
+    entityName: string;
+    entityType: string;
+};
+export declare type ExportServices = {
+    accessSetting: string;
+    defaultAccess: string;
+};
+export declare type PostClosingConditions = {
+    access: boolean;
+    rights: string[];
+};
+export declare type PreliminaryConditions = {
+    access: boolean;
+    rights: string[];
+};
+export declare type PurchaseConditions = {
+    access: boolean;
+    rights: string[];
+};
+export declare type Print = {
+    access: boolean;
+    rights: string[];
+};
+export declare type SecondarySetup = {
+    access: boolean;
+    rights: string[];
+};
+export declare type DeliveryConditions = {
+    access: boolean;
+    rights: string[];
+};
+export declare type SystemAdministration = {
+    access: boolean;
+    rights: string[];
+};
+export declare type TablesAndFees = {
+    access: boolean;
+    rights: string[];
+};
+export declare type Tool = {
+    entityName: string;
+};
+export declare type TpoCompanyDetails = {
+    access: boolean;
+    rights: string[];
+};
+export declare type TpoConnectSiteSettings = {
+    access: boolean;
+    rights: string[];
+};
+export declare type TpoContacts = {
+    access: boolean;
+    rights: string[];
+};
+export declare type TpoFees = {
+    access: boolean;
+    rights: string[];
+};
+export declare type TpoInformation = {
+    access: boolean;
+    rights: string[];
+};
+export declare type TpoOrganizationSettings = {
+    access: boolean;
+    rights: string[];
+};
+export declare type TqlServices = {
+    access: boolean;
+    rights: string[];
+};
+export declare type Trades = {
+    access: boolean;
+    rights: string[];
+};
+export declare type UnderwritingConditions = {
+    access: boolean;
+    rights: string[];
+};
+export declare type EnhancedConditions = {
+    access: boolean;
+    conditionType: ConditionType;
+};
+export declare type ConditionType = {
+    'Investor Delivery': string[];
+    'Post-Closing': string[];
+    Preliminary: string[];
+    Underwriting: string[];
+};
+export declare type LoConnectTasks = {
+    access: boolean;
+    rights: string[];
+    customForms: any[];
+    customTools: any[];
+    globalApplications: any[];
+    standardWebForms: StandardWebForm[];
+};
+export declare type StandardWebForm = {
+    formName: string;
+    access: boolean;
+    formID: number;
+};
+export declare type EncompassWebServices = {
+    access: boolean;
+    rights: string[];
+};
+export declare type UnderwritingCenter = {
+    access: boolean;
+    rights: string[];
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/pui-scripting-object",
-  "version": "1.4.0",
+  "version": "1.6.0",
   "description": "Typescript defintions for Scripting Objects",
   "sideEffects": false,
   "main": "./dist/cjs/index.js",
@@ -58,8 +58,8 @@
   },
   "devDependencies": {
     "@elliemae/browserslist-config-elliemae-latest-browsers": "~1.5.0",
-    "@elliemae/pui-cli": "~7.3.0",
-    "@elliemae/pui-doc-gen": "~1.1.0",
+    "@elliemae/pui-cli": "~7.5.0",
+    "@elliemae/pui-doc-gen": "~1.2.1",
     "@types/styled-components": "~5.1.26",
     "redux": "~4.2.0",
     "redux-saga": "~1.2.1",