@elliemae/pui-scripting-object 1.5.0 → 1.6.1

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/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

@@ -33,5 +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
      *
@@ -28,9 +31,10 @@ export interface ILoan {
     all(): Promise<Record<string, any>>;
     apply(loan: Record<string, string>): Promise<void>;
     /**
-     * Commits changes to the Loan object
+     * 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 |
@@ -80,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

@@ -1,4 +1,4 @@
-export interface UserAccessRights {
+export declare type UserAccessRights = {
     access: string[];
     additionalServices: AdditionalServices;
     ausTracking: AusTracking;
@@ -61,301 +61,301 @@ export interface UserAccessRights {
     loConnectTasks: LoConnectTasks;
     encompassWebServices: EncompassWebServices;
     underwritingCenter: UnderwritingCenter;
-}
-export interface AdditionalServices {
+};
+export declare type AdditionalServices = {
     access: boolean;
     rights: string[];
-}
-export interface AusTracking {
+};
+export declare type AusTracking = {
     access: boolean;
     rights: string[];
-}
-export interface BorrowerContacts {
+};
+export declare type BorrowerContacts = {
     access: boolean;
     rights: string[];
-}
-export interface BusinessContacts {
+};
+export declare type BusinessContacts = {
     access: boolean;
     rights: string[];
-}
-export interface BusinessRules {
+};
+export declare type BusinessRules = {
     access: boolean;
     rights: string[];
-}
-export interface CompanyUserSetup {
+};
+export declare type CompanyUserSetup = {
     access: boolean;
     rights: string[];
-}
-export interface Contacts {
+};
+export declare type Contacts = {
     access: boolean;
     rights: string[];
-}
-export interface ContactSetup {
+};
+export declare type ContactSetup = {
     access: boolean;
     rights: string[];
-}
-export interface Dashboard {
+};
+export declare type Dashboard = {
     access: boolean;
     rights: string[];
-}
-export interface DisclosureTracking {
+};
+export declare type DisclosureTracking = {
     access: boolean;
     rights: string[];
-}
-export interface DocsSetup {
+};
+export declare type DocsSetup = {
     access: boolean;
     rights: string[];
-}
-export interface Documents {
+};
+export declare type Documents = {
     access: boolean;
     rights: string[];
     protectedDocuments: string[];
     unprotectedDocuments: string[];
     unassignedFiles: string[];
-}
-export interface DynamicDataManagement {
+};
+export declare type DynamicDataManagement = {
     access: boolean;
     rights: string[];
-}
-export interface EDisclosures {
+};
+export declare type EDisclosures = {
     access: boolean;
     rights: string[];
-}
-export interface EFolderHistory {
+};
+export declare type EFolderHistory = {
     access: boolean;
-}
-export interface EFolderSetup {
+};
+export declare type EFolderSetup = {
     access: boolean;
     rights: string[];
-}
-export interface EVault {
+};
+export declare type EVault = {
     eVaultPortal: EVaultPortal;
-}
-export interface EVaultPortal {
+};
+export declare type EVaultPortal = {
     access: boolean;
     rights: string[];
-}
-export interface FileContacts {
+};
+export declare type FileContacts = {
     access: boolean;
     rights: string[];
     grantWriteAccess: GrantWriteAccess;
-}
-export interface GrantWriteAccess {
+};
+export declare type GrantWriteAccess = {
     access: boolean;
     loanTeam: LoanTeam[];
-}
-export interface LoanTeam {
+};
+export declare type LoanTeam = {
     role: Role;
-}
-export interface Role {
+};
+export declare type Role = {
     entityId: string;
     entityName: string;
     entityType: string;
-}
-export interface Form {
+};
+export declare type Form = {
     entityId: string;
     entityName: string;
     entityType: string;
-}
-export interface GseServices {
+};
+export declare type GseServices = {
     access: boolean;
     rights: string[];
-}
-export interface ImportLoan {
+};
+export declare type ImportLoan = {
     entityId: string;
     entityType: string;
-}
-export interface Service {
+};
+export declare type Service = {
     category: string;
     accessSetting: string;
     defaultAccess: string;
-}
-export interface LoanSetup {
+};
+export declare type LoanSetup = {
     access: boolean;
     rights: string[];
-}
-export interface ManageServiceProviders {
+};
+export declare type ManageServiceProviders = {
     accessSetting: string;
     rights: string[];
-}
-export interface MilestoneWorkflowManagement {
+};
+export declare type MilestoneWorkflowManagement = {
     acceptFiles: AcceptFile[];
     returnFiles: ReturnFile[];
     changeExpectedDate: ChangeExpectedDate[];
     finishMilestones: FinishMilestone[];
     assignLoanTeamMembers: AssignLoanTeamMember[];
     editComments: EditComment[];
-}
-export interface AcceptFile {
+};
+export declare type AcceptFile = {
     entityId: string;
     entityName: string;
     entityType: string;
-}
-export interface ReturnFile {
+};
+export declare type ReturnFile = {
     entityId: string;
     entityName: string;
     entityType: string;
-}
-export interface ChangeExpectedDate {
+};
+export declare type ChangeExpectedDate = {
     entityId: string;
     entityName: string;
     entityType: string;
-}
-export interface FinishMilestone {
+};
+export declare type FinishMilestone = {
     entityId: string;
     entityName: string;
     entityType: string;
-}
-export interface AssignLoanTeamMember {
+};
+export declare type AssignLoanTeamMember = {
     milestone: Milestone;
     role?: Role2;
-}
-export interface Milestone {
+};
+export declare type Milestone = {
     entityId: string;
     entityName: string;
     entityType: string;
-}
-export interface Role2 {
+};
+export declare type Role2 = {
     entityId: string;
     entityName: string;
     entityType: string;
-}
-export interface EditComment {
+};
+export declare type EditComment = {
     entityId: string;
     entityName: string;
     entityType: string;
-}
-export interface MoveLoans {
+};
+export declare type MoveLoans = {
     access: boolean;
     moveFrom: MoveFrom[];
     moveTo: MoveTo[];
-}
-export interface MoveFrom {
+};
+export declare type MoveFrom = {
     entityId: string;
     entityType: string;
-}
-export interface MoveTo {
+};
+export declare type MoveTo = {
     entityId: string;
     entityType: string;
-}
-export interface PersonalTemplates {
+};
+export declare type PersonalTemplates = {
     access: boolean;
     rights: string[];
-}
-export interface Pipeline {
+};
+export declare type Pipeline = {
     access: boolean;
     pipelineTasks: string[];
     pipelineViews: PipelineView[];
     nonAccessibleColumns: any[];
-}
-export interface PipelineView {
+};
+export declare type PipelineView = {
     entityId: string;
     entityName: string;
     entityType: string;
-}
-export interface ExportServices {
+};
+export declare type ExportServices = {
     accessSetting: string;
     defaultAccess: string;
-}
-export interface PostClosingConditions {
+};
+export declare type PostClosingConditions = {
     access: boolean;
     rights: string[];
-}
-export interface PreliminaryConditions {
+};
+export declare type PreliminaryConditions = {
     access: boolean;
     rights: string[];
-}
-export interface PurchaseConditions {
+};
+export declare type PurchaseConditions = {
     access: boolean;
     rights: string[];
-}
-export interface Print {
+};
+export declare type Print = {
     access: boolean;
     rights: string[];
-}
-export interface SecondarySetup {
+};
+export declare type SecondarySetup = {
     access: boolean;
     rights: string[];
-}
-export interface DeliveryConditions {
+};
+export declare type DeliveryConditions = {
     access: boolean;
     rights: string[];
-}
-export interface SystemAdministration {
+};
+export declare type SystemAdministration = {
     access: boolean;
     rights: string[];
-}
-export interface TablesAndFees {
+};
+export declare type TablesAndFees = {
     access: boolean;
     rights: string[];
-}
-export interface Tool {
+};
+export declare type Tool = {
     entityName: string;
-}
-export interface TpoCompanyDetails {
+};
+export declare type TpoCompanyDetails = {
     access: boolean;
     rights: string[];
-}
-export interface TpoConnectSiteSettings {
+};
+export declare type TpoConnectSiteSettings = {
     access: boolean;
     rights: string[];
-}
-export interface TpoContacts {
+};
+export declare type TpoContacts = {
     access: boolean;
     rights: string[];
-}
-export interface TpoFees {
+};
+export declare type TpoFees = {
     access: boolean;
     rights: string[];
-}
-export interface TpoInformation {
+};
+export declare type TpoInformation = {
     access: boolean;
     rights: string[];
-}
-export interface TpoOrganizationSettings {
+};
+export declare type TpoOrganizationSettings = {
     access: boolean;
     rights: string[];
-}
-export interface TqlServices {
+};
+export declare type TqlServices = {
     access: boolean;
     rights: string[];
-}
-export interface Trades {
+};
+export declare type Trades = {
     access: boolean;
     rights: string[];
-}
-export interface UnderwritingConditions {
+};
+export declare type UnderwritingConditions = {
     access: boolean;
     rights: string[];
-}
-export interface EnhancedConditions {
+};
+export declare type EnhancedConditions = {
     access: boolean;
     conditionType: ConditionType;
-}
-export interface ConditionType {
+};
+export declare type ConditionType = {
     'Investor Delivery': string[];
     'Post-Closing': string[];
     Preliminary: string[];
     Underwriting: string[];
-}
-export interface LoConnectTasks {
+};
+export declare type LoConnectTasks = {
     access: boolean;
     rights: string[];
     customForms: any[];
     customTools: any[];
     globalApplications: any[];
     standardWebForms: StandardWebForm[];
-}
-export interface StandardWebForm {
+};
+export declare type StandardWebForm = {
     formName: string;
     access: boolean;
     formID: number;
-}
-export interface EncompassWebServices {
+};
+export declare type EncompassWebServices = {
     access: boolean;
     rights: string[];
-}
-export interface UnderwritingCenter {
+};
+export declare type UnderwritingCenter = {
     access: boolean;
     rights: string[];
-}
+};

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@elliemae/pui-scripting-object",
-  "version": "1.5.0",
+  "version": "1.6.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",
+  "typings": "./dist/types/index.d.ts",
   "files": [
     "dist",
     "build"
@@ -58,8 +58,8 @@
   },
   "devDependencies": {
     "@elliemae/browserslist-config-elliemae-latest-browsers": "~1.5.0",
-    "@elliemae/pui-cli": "~7.4.0",
-    "@elliemae/pui-doc-gen": "~1.2.1",
+    "@elliemae/pui-cli": "~7.6.1",
+    "@elliemae/pui-doc-gen": "~1.3.0",
     "@types/styled-components": "~5.1.26",
     "redux": "~4.2.0",
     "redux-saga": "~1.2.1",