@elliemae/pui-scripting-object 1.4.0 → 1.5.0

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/types/auth.d.ts

@@ -1,3 +1,4 @@
+import { UserAccessRights } from './userAccessRights';
 export declare type Personas = {
     entityId: string;
     entityType: string;
@@ -32,4 +33,5 @@ export interface IAuth {
     createAuthCode(clientId: string): Promise<string>;
     getAccessToken(appInfo: PluginInfo): Promise<TokenInfo>;
     getUser(): Promise<User>;
+    getUserAccessRights(): Promise<UserAccessRights>;
 }

package/dist/types/loan.d.ts

@@ -27,7 +27,17 @@ export interface ILoan {
      */
     all(): Promise<Record<string, any>>;
     apply(loan: Record<string, string>): Promise<void>;
-    commit(): Promise<void>;
+    /**
+     * Commits changes to the Loan object
+     *
+     * @returns v3 Loan Object
+     *
+     * #### 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

package/dist/types/userAccessRights.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/pui-scripting-object",
-  "version": "1.4.0",
+  "version": "1.5.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.4.0",
+    "@elliemae/pui-doc-gen": "~1.2.1",
     "@types/styled-components": "~5.1.26",
     "redux": "~4.2.0",
     "redux-saga": "~1.2.1",