@elliemae/pui-scripting-object 1.46.4 → 1.48.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/cjs/index.js CHANGED
@@ -25,14 +25,11 @@ __reExport(lib_exports, require("./objects/loan.js"), module.exports);
25
25
  __reExport(lib_exports, require("./objects/loanv2.js"), module.exports);
26
26
  __reExport(lib_exports, require("./objects/memStorage.js"), module.exports);
27
27
  __reExport(lib_exports, require("./objects/module.js"), module.exports);
28
- __reExport(lib_exports, require("./objects/route.js"), module.exports);
29
28
  __reExport(lib_exports, require("./objects/service.js"), module.exports);
30
29
  __reExport(lib_exports, require("./objects/session.js"), module.exports);
31
30
  __reExport(lib_exports, require("./objects/transaction.js"), module.exports);
32
- __reExport(lib_exports, require("./objects/transactionv2.js"), module.exports);
33
31
  __reExport(lib_exports, require("./objects/transactionTemplate.js"), module.exports);
34
32
  __reExport(lib_exports, require("./objects/userAccessRights.js"), module.exports);
35
- __reExport(lib_exports, require("./objects/view.js"), module.exports);
36
33
  __reExport(lib_exports, require("./objects/shared.js"), module.exports);
37
34
  __reExport(lib_exports, require("./event.js"), module.exports);
38
35
  __reExport(lib_exports, require("./scriptingObject.js"), module.exports);
@@ -18,9 +18,10 @@ var __copyProps = (to, from, except, desc) => {
18
18
  var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
19
19
  var application_exports = {};
20
20
  __export(application_exports, {
21
- ApplicationExtensionType: () => ApplicationExtensionType,
21
+ FormType: () => FormType,
22
22
  LogLevels: () => LogLevels,
23
23
  ModalSize: () => ModalSize,
24
+ ModalType: () => ModalType,
24
25
  OpenMode: () => OpenMode,
25
26
  OpenType: () => OpenType
26
27
  });
@@ -34,11 +35,6 @@ var LogLevels = /* @__PURE__ */ ((LogLevels2) => {
34
35
  LogLevels2[LogLevels2["FATAL"] = 60] = "FATAL";
35
36
  return LogLevels2;
36
37
  })(LogLevels || {});
37
- var ApplicationExtensionType = /* @__PURE__ */ ((ApplicationExtensionType2) => {
38
- ApplicationExtensionType2["TOOL"] = "TOOL";
39
- ApplicationExtensionType2["MENU"] = "MENU";
40
- return ApplicationExtensionType2;
41
- })(ApplicationExtensionType || {});
42
38
  var OpenType = /* @__PURE__ */ ((OpenType2) => {
43
39
  OpenType2["MODULE"] = "MODULE";
44
40
  return OpenType2;
@@ -52,5 +48,22 @@ var ModalSize = /* @__PURE__ */ ((ModalSize2) => {
52
48
  ModalSize2["SMALL"] = "sm";
53
49
  ModalSize2["MEDIUM"] = "md";
54
50
  ModalSize2["LARGE"] = "lg";
51
+ ModalSize2["EXTRA_LARGE"] = "xl";
55
52
  return ModalSize2;
56
53
  })(ModalSize || {});
54
+ var FormType = /* @__PURE__ */ ((FormType2) => {
55
+ FormType2["STANDARD_FORM"] = "STANDARD_FORM";
56
+ FormType2["CUSTOM_FORM"] = "CUSTOM_FORM";
57
+ return FormType2;
58
+ })(FormType || {});
59
+ var ModalType = /* @__PURE__ */ ((ModalType2) => {
60
+ ModalType2["FORM"] = "FORM";
61
+ ModalType2["TOOL"] = "TOOL";
62
+ ModalType2["DOCUMENT"] = "DOCUMENT";
63
+ ModalType2["URL"] = "URL";
64
+ ModalType2["WARNING"] = "WARNING";
65
+ ModalType2["ERROR"] = "ERROR";
66
+ ModalType2["SUCCESS"] = "SUCCESS";
67
+ ModalType2["INFO"] = "INFO";
68
+ return ModalType2;
69
+ })(ModalType || {});
@@ -19,6 +19,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
19
19
  var loan_exports = {};
20
20
  __export(loan_exports, {
21
21
  EditModes: () => EditModes,
22
+ LoanCollection: () => LoanCollection,
22
23
  LoanLevelActions: () => LoanLevelActions,
23
24
  RecordActions: () => RecordActions,
24
25
  RecordViewType: () => RecordViewType
@@ -44,6 +45,56 @@ var LoanLevelActions = /* @__PURE__ */ ((LoanLevelActions2) => {
44
45
  LoanLevelActions2["COPY_BORROWER_TO_TAX_REQUEST"] = "copyBorrowerToTaxRequest";
45
46
  return LoanLevelActions2;
46
47
  })(LoanLevelActions || {});
48
+ var LoanCollection = /* @__PURE__ */ ((LoanCollection2) => {
49
+ LoanCollection2["AffiliatedBusinessArrangements"] = "AB0000";
50
+ LoanCollection2["AlternateNameBorrower"] = "URLABAKA0000";
51
+ LoanCollection2["AlternateNameCoBorrower"] = "URLACAKA0000";
52
+ LoanCollection2["BorrowerCreditReports"] = "BCRED0000";
53
+ LoanCollection2["BorrowerEmployer"] = "BE0000";
54
+ LoanCollection2["BorrowerResidence"] = "BR0000";
55
+ LoanCollection2["CoBorrowerCreditReports"] = "CCRED0000";
56
+ LoanCollection2["CoBorrowerEmployer"] = "CE0000";
57
+ LoanCollection2["CoBorrowerResidence"] = "CR0000";
58
+ LoanCollection2["DepositoryInformation"] = "DD0000";
59
+ LoanCollection2["Disclosures"] = "DISC0000";
60
+ LoanCollection2["EarlyCheck"] = "EC0000";
61
+ LoanCollection2["Escrow"] = "HUD0000";
62
+ LoanCollection2["GiftOrGrant"] = "URLARGG0000";
63
+ LoanCollection2["GoodFaithChangeOfCircumstance"] = "XCOC0000";
64
+ LoanCollection2["GSERepAndWarrantTracker"] = "TQLGSE0000";
65
+ LoanCollection2["HomeCounselingProvider"] = "HC0000";
66
+ LoanCollection2["IRS4506Record"] = "AR0000";
67
+ LoanCollection2["IRS4506TRecord"] = "IR0000";
68
+ LoanCollection2["ItemizedEscrowPayment"] = "AEA0000";
69
+ LoanCollection2["LiabilityInformation"] = "FL0000";
70
+ LoanCollection2["LoanPrograms"] = "LP0000";
71
+ LoanCollection2["MortgageProperty"] = "FM0000";
72
+ LoanCollection2["NonBorrowingOwnerFileContact"] = "NBOC0000";
73
+ LoanCollection2["NYFees"] = "NYFEES0000";
74
+ LoanCollection2["OtherAssets"] = "URLAROA0000";
75
+ LoanCollection2["OtherBorrowerEmployer"] = "FBE0000";
76
+ LoanCollection2["OtherCoBorrowerEmployer"] = "FCE0000";
77
+ LoanCollection2["OtherIncome"] = "URLAROIS0000";
78
+ LoanCollection2["OtherLiabilitiesOrDepository"] = "URLAROL0000";
79
+ LoanCollection2["PropertyValuations"] = "PVAL0000";
80
+ LoanCollection2["REGZDrawRepayPeriodDraw"] = "HTD0000";
81
+ LoanCollection2["REGZDrawRepayPeriodRepay"] = "HTR0000";
82
+ LoanCollection2["Riders"] = "RIDER0000";
83
+ LoanCollection2["Scenarios"] = "SCEN0000";
84
+ LoanCollection2["SettlementServiceProvider"] = "SP0000";
85
+ LoanCollection2["SpecialFeatureCodes"] = "SFC0000";
86
+ LoanCollection2["TQLBorrower4506TOrders"] = "TQL4506T0000";
87
+ LoanCollection2["TQLComplianceOrdersLastAlert"] = "TQLCOMPLIANCEALERT0000";
88
+ LoanCollection2["TQLDocumentDeliveredToInvestor"] = "TQLDOCDATE0000";
89
+ LoanCollection2["TQLFraudOrders"] = "TQLFRAUDALERT0000";
90
+ LoanCollection2["TrustAccountTransactionDescription"] = "TA0000";
91
+ LoanCollection2["UCDAdjustmentType"] = "UNFL0000";
92
+ LoanCollection2["Valuation"] = "VAL0000";
93
+ LoanCollection2["VerificationOfAdditionalLoans"] = "URLARAL0000";
94
+ LoanCollection2["VestingParty"] = "TR0000";
95
+ LoanCollection2["CorrespondentOtherInsurances"] = "CORROI0000";
96
+ return LoanCollection2;
97
+ })(LoanCollection || {});
47
98
  var EditModes = /* @__PURE__ */ ((EditModes2) => {
48
99
  EditModes2["READ_ONLY"] = "READONLY";
49
100
  EditModes2["EDIT"] = "EDIT";
@@ -3,10 +3,6 @@ var __defProp = Object.defineProperty;
3
3
  var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
4
4
  var __getOwnPropNames = Object.getOwnPropertyNames;
5
5
  var __hasOwnProp = Object.prototype.hasOwnProperty;
6
- var __export = (target, all) => {
7
- for (var name in all)
8
- __defProp(target, name, { get: all[name], enumerable: true });
9
- };
10
6
  var __copyProps = (to, from, except, desc) => {
11
7
  if (from && typeof from === "object" || typeof from === "function") {
12
8
  for (let key of __getOwnPropNames(from))
@@ -17,21 +13,4 @@ var __copyProps = (to, from, except, desc) => {
17
13
  };
18
14
  var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
19
15
  var module_exports = {};
20
- __export(module_exports, {
21
- DialogSize: () => DialogSize,
22
- DialogType: () => DialogType
23
- });
24
16
  module.exports = __toCommonJS(module_exports);
25
- var DialogType = /* @__PURE__ */ ((DialogType2) => {
26
- DialogType2["WARNING"] = "warning";
27
- DialogType2["ERROR"] = "error";
28
- DialogType2["SUCCESS"] = "success";
29
- DialogType2["INFO"] = "info";
30
- return DialogType2;
31
- })(DialogType || {});
32
- var DialogSize = /* @__PURE__ */ ((DialogSize2) => {
33
- DialogSize2["SMALL"] = "small";
34
- DialogSize2["MEDIUM"] = "medium";
35
- DialogSize2["LARGE"] = "large";
36
- return DialogSize2;
37
- })(DialogSize || {});
@@ -32,12 +32,9 @@ var ScriptingObjectNames = /* @__PURE__ */ ((ScriptingObjectNames2) => {
32
32
  ScriptingObjectNames2["LoanV2"] = "loanV2";
33
33
  ScriptingObjectNames2["MemStorage"] = "memstorage";
34
34
  ScriptingObjectNames2["Module"] = "module";
35
- ScriptingObjectNames2["Route"] = "route";
36
35
  ScriptingObjectNames2["Service"] = "service";
37
36
  ScriptingObjectNames2["Session"] = "session";
38
37
  ScriptingObjectNames2["Transaction"] = "transaction";
39
- ScriptingObjectNames2["TransactionV2"] = "transactionV2";
40
38
  ScriptingObjectNames2["TransactionTemplate"] = "transactionTemplate";
41
- ScriptingObjectNames2["View"] = "view";
42
39
  return ScriptingObjectNames2;
43
40
  })(ScriptingObjectNames || {});
package/dist/esm/index.js CHANGED
@@ -8,14 +8,11 @@ export * from "./objects/loan.js";
8
8
  export * from "./objects/loanv2.js";
9
9
  export * from "./objects/memStorage.js";
10
10
  export * from "./objects/module.js";
11
- export * from "./objects/route.js";
12
11
  export * from "./objects/service.js";
13
12
  export * from "./objects/session.js";
14
13
  export * from "./objects/transaction.js";
15
- export * from "./objects/transactionv2.js";
16
14
  export * from "./objects/transactionTemplate.js";
17
15
  export * from "./objects/userAccessRights.js";
18
- export * from "./objects/view.js";
19
16
  export * from "./objects/shared.js";
20
17
  export * from "./event.js";
21
18
  export * from "./scriptingObject.js";
@@ -7,11 +7,6 @@ var LogLevels = /* @__PURE__ */ ((LogLevels2) => {
7
7
  LogLevels2[LogLevels2["FATAL"] = 60] = "FATAL";
8
8
  return LogLevels2;
9
9
  })(LogLevels || {});
10
- var ApplicationExtensionType = /* @__PURE__ */ ((ApplicationExtensionType2) => {
11
- ApplicationExtensionType2["TOOL"] = "TOOL";
12
- ApplicationExtensionType2["MENU"] = "MENU";
13
- return ApplicationExtensionType2;
14
- })(ApplicationExtensionType || {});
15
10
  var OpenType = /* @__PURE__ */ ((OpenType2) => {
16
11
  OpenType2["MODULE"] = "MODULE";
17
12
  return OpenType2;
@@ -25,12 +20,30 @@ var ModalSize = /* @__PURE__ */ ((ModalSize2) => {
25
20
  ModalSize2["SMALL"] = "sm";
26
21
  ModalSize2["MEDIUM"] = "md";
27
22
  ModalSize2["LARGE"] = "lg";
23
+ ModalSize2["EXTRA_LARGE"] = "xl";
28
24
  return ModalSize2;
29
25
  })(ModalSize || {});
26
+ var FormType = /* @__PURE__ */ ((FormType2) => {
27
+ FormType2["STANDARD_FORM"] = "STANDARD_FORM";
28
+ FormType2["CUSTOM_FORM"] = "CUSTOM_FORM";
29
+ return FormType2;
30
+ })(FormType || {});
31
+ var ModalType = /* @__PURE__ */ ((ModalType2) => {
32
+ ModalType2["FORM"] = "FORM";
33
+ ModalType2["TOOL"] = "TOOL";
34
+ ModalType2["DOCUMENT"] = "DOCUMENT";
35
+ ModalType2["URL"] = "URL";
36
+ ModalType2["WARNING"] = "WARNING";
37
+ ModalType2["ERROR"] = "ERROR";
38
+ ModalType2["SUCCESS"] = "SUCCESS";
39
+ ModalType2["INFO"] = "INFO";
40
+ return ModalType2;
41
+ })(ModalType || {});
30
42
  export {
31
- ApplicationExtensionType,
43
+ FormType,
32
44
  LogLevels,
33
45
  ModalSize,
46
+ ModalType,
34
47
  OpenMode,
35
48
  OpenType
36
49
  };
@@ -18,6 +18,56 @@ var LoanLevelActions = /* @__PURE__ */ ((LoanLevelActions2) => {
18
18
  LoanLevelActions2["COPY_BORROWER_TO_TAX_REQUEST"] = "copyBorrowerToTaxRequest";
19
19
  return LoanLevelActions2;
20
20
  })(LoanLevelActions || {});
21
+ var LoanCollection = /* @__PURE__ */ ((LoanCollection2) => {
22
+ LoanCollection2["AffiliatedBusinessArrangements"] = "AB0000";
23
+ LoanCollection2["AlternateNameBorrower"] = "URLABAKA0000";
24
+ LoanCollection2["AlternateNameCoBorrower"] = "URLACAKA0000";
25
+ LoanCollection2["BorrowerCreditReports"] = "BCRED0000";
26
+ LoanCollection2["BorrowerEmployer"] = "BE0000";
27
+ LoanCollection2["BorrowerResidence"] = "BR0000";
28
+ LoanCollection2["CoBorrowerCreditReports"] = "CCRED0000";
29
+ LoanCollection2["CoBorrowerEmployer"] = "CE0000";
30
+ LoanCollection2["CoBorrowerResidence"] = "CR0000";
31
+ LoanCollection2["DepositoryInformation"] = "DD0000";
32
+ LoanCollection2["Disclosures"] = "DISC0000";
33
+ LoanCollection2["EarlyCheck"] = "EC0000";
34
+ LoanCollection2["Escrow"] = "HUD0000";
35
+ LoanCollection2["GiftOrGrant"] = "URLARGG0000";
36
+ LoanCollection2["GoodFaithChangeOfCircumstance"] = "XCOC0000";
37
+ LoanCollection2["GSERepAndWarrantTracker"] = "TQLGSE0000";
38
+ LoanCollection2["HomeCounselingProvider"] = "HC0000";
39
+ LoanCollection2["IRS4506Record"] = "AR0000";
40
+ LoanCollection2["IRS4506TRecord"] = "IR0000";
41
+ LoanCollection2["ItemizedEscrowPayment"] = "AEA0000";
42
+ LoanCollection2["LiabilityInformation"] = "FL0000";
43
+ LoanCollection2["LoanPrograms"] = "LP0000";
44
+ LoanCollection2["MortgageProperty"] = "FM0000";
45
+ LoanCollection2["NonBorrowingOwnerFileContact"] = "NBOC0000";
46
+ LoanCollection2["NYFees"] = "NYFEES0000";
47
+ LoanCollection2["OtherAssets"] = "URLAROA0000";
48
+ LoanCollection2["OtherBorrowerEmployer"] = "FBE0000";
49
+ LoanCollection2["OtherCoBorrowerEmployer"] = "FCE0000";
50
+ LoanCollection2["OtherIncome"] = "URLAROIS0000";
51
+ LoanCollection2["OtherLiabilitiesOrDepository"] = "URLAROL0000";
52
+ LoanCollection2["PropertyValuations"] = "PVAL0000";
53
+ LoanCollection2["REGZDrawRepayPeriodDraw"] = "HTD0000";
54
+ LoanCollection2["REGZDrawRepayPeriodRepay"] = "HTR0000";
55
+ LoanCollection2["Riders"] = "RIDER0000";
56
+ LoanCollection2["Scenarios"] = "SCEN0000";
57
+ LoanCollection2["SettlementServiceProvider"] = "SP0000";
58
+ LoanCollection2["SpecialFeatureCodes"] = "SFC0000";
59
+ LoanCollection2["TQLBorrower4506TOrders"] = "TQL4506T0000";
60
+ LoanCollection2["TQLComplianceOrdersLastAlert"] = "TQLCOMPLIANCEALERT0000";
61
+ LoanCollection2["TQLDocumentDeliveredToInvestor"] = "TQLDOCDATE0000";
62
+ LoanCollection2["TQLFraudOrders"] = "TQLFRAUDALERT0000";
63
+ LoanCollection2["TrustAccountTransactionDescription"] = "TA0000";
64
+ LoanCollection2["UCDAdjustmentType"] = "UNFL0000";
65
+ LoanCollection2["Valuation"] = "VAL0000";
66
+ LoanCollection2["VerificationOfAdditionalLoans"] = "URLARAL0000";
67
+ LoanCollection2["VestingParty"] = "TR0000";
68
+ LoanCollection2["CorrespondentOtherInsurances"] = "CORROI0000";
69
+ return LoanCollection2;
70
+ })(LoanCollection || {});
21
71
  var EditModes = /* @__PURE__ */ ((EditModes2) => {
22
72
  EditModes2["READ_ONLY"] = "READONLY";
23
73
  EditModes2["EDIT"] = "EDIT";
@@ -25,6 +75,7 @@ var EditModes = /* @__PURE__ */ ((EditModes2) => {
25
75
  })(EditModes || {});
26
76
  export {
27
77
  EditModes,
78
+ LoanCollection,
28
79
  LoanLevelActions,
29
80
  RecordActions,
30
81
  RecordViewType
@@ -1,17 +0,0 @@
1
- var DialogType = /* @__PURE__ */ ((DialogType2) => {
2
- DialogType2["WARNING"] = "warning";
3
- DialogType2["ERROR"] = "error";
4
- DialogType2["SUCCESS"] = "success";
5
- DialogType2["INFO"] = "info";
6
- return DialogType2;
7
- })(DialogType || {});
8
- var DialogSize = /* @__PURE__ */ ((DialogSize2) => {
9
- DialogSize2["SMALL"] = "small";
10
- DialogSize2["MEDIUM"] = "medium";
11
- DialogSize2["LARGE"] = "large";
12
- return DialogSize2;
13
- })(DialogSize || {});
14
- export {
15
- DialogSize,
16
- DialogType
17
- };
@@ -9,13 +9,10 @@ var ScriptingObjectNames = /* @__PURE__ */ ((ScriptingObjectNames2) => {
9
9
  ScriptingObjectNames2["LoanV2"] = "loanV2";
10
10
  ScriptingObjectNames2["MemStorage"] = "memstorage";
11
11
  ScriptingObjectNames2["Module"] = "module";
12
- ScriptingObjectNames2["Route"] = "route";
13
12
  ScriptingObjectNames2["Service"] = "service";
14
13
  ScriptingObjectNames2["Session"] = "session";
15
14
  ScriptingObjectNames2["Transaction"] = "transaction";
16
- ScriptingObjectNames2["TransactionV2"] = "transactionV2";
17
15
  ScriptingObjectNames2["TransactionTemplate"] = "transactionTemplate";
18
- ScriptingObjectNames2["View"] = "view";
19
16
  return ScriptingObjectNames2;
20
17
  })(ScriptingObjectNames || {});
21
18
  export {
@@ -9,14 +9,11 @@ export * from './objects/loan.js';
9
9
  export * from './objects/loanv2.js';
10
10
  export * from './objects/memStorage.js';
11
11
  export * from './objects/module.js';
12
- export * from './objects/route.js';
13
12
  export * from './objects/service.js';
14
13
  export * from './objects/session.js';
15
14
  export * from './objects/transaction.js';
16
- export * from './objects/transactionv2.js';
17
15
  export * from './objects/transactionTemplate.js';
18
16
  export * from './objects/userAccessRights.js';
19
- export * from './objects/view.js';
20
17
  export * from './objects/shared.js';
21
18
  export * from './event.js';
22
19
  export * from './scriptingObject.js';
@@ -6,17 +6,39 @@ import { NavigationType } from './shared.js';
6
6
  * Log levels
7
7
  */
8
8
  export declare enum LogLevels {
9
+ /**
10
+ * debug log level
11
+ */
9
12
  DEBUG = 10,
13
+ /**
14
+ * info log level
15
+ */
10
16
  INFO = 20,
17
+ /**
18
+ * audit log level
19
+ */
11
20
  AUDIT = 30,
21
+ /**
22
+ * warning log level
23
+ */
12
24
  WARN = 40,
25
+ /**
26
+ * error log level
27
+ */
13
28
  ERROR = 50,
29
+ /**
30
+ * fatal log level
31
+ */
14
32
  FATAL = 60
15
33
  }
16
34
  /**
17
35
  * log message
18
36
  */
19
37
  export type LogMessage = {
38
+ /**
39
+ * application name
40
+ */
41
+ appName: string;
20
42
  /**
21
43
  * message string
22
44
  */
@@ -48,34 +70,6 @@ export type AppInfo = {
48
70
  */
49
71
  encompassVersion: string;
50
72
  };
51
- /**
52
- * Application extension type
53
- */
54
- export declare enum ApplicationExtensionType {
55
- TOOL = "TOOL",
56
- MENU = "MENU"
57
- }
58
- /**
59
- * metadata about the application extension
60
- */
61
- export type ApplicationExtension = {
62
- /**
63
- * type of application extension
64
- */
65
- type: ApplicationExtensionType;
66
- /**
67
- * display text of the application extension
68
- */
69
- text: string;
70
- /**
71
- * url where the application extension is hosted
72
- */
73
- url: string;
74
- /**
75
- * custom options for the application extension
76
- */
77
- options?: Record<string, string>;
78
- };
79
73
  /**
80
74
  * set of query options to get company settings
81
75
  */
@@ -178,28 +172,130 @@ export declare enum ModalSize {
178
172
  /**
179
173
  * large modal
180
174
  */
181
- LARGE = "lg"
175
+ LARGE = "lg",
176
+ /**
177
+ * extra large modal
178
+ */
179
+ EXTRA_LARGE = "xl"
180
+ }
181
+ /**
182
+ * additional options for warning / success / error / info modal
183
+ */
184
+ export type ModalData = {
185
+ /**
186
+ * title of the dialog
187
+ */
188
+ title: string;
189
+ /**
190
+ * message to be displayed in the body of the dialog
191
+ */
192
+ body: string;
193
+ /**
194
+ * list of actions that are avilable to user for providing feedback.
195
+ *
196
+ * these actions are displayed as buttons in the dialog
197
+ *
198
+ * default action is 'ok'
199
+ * @example ['retry', 'cancel']
200
+ */
201
+ actions?: string[];
202
+ /**
203
+ * link to the help documentation
204
+ */
205
+ helpLink?: string;
206
+ /**
207
+ * unique id that identifies the session / transaction
208
+ */
209
+ correlationId?: string;
210
+ /**
211
+ * error code
212
+ */
213
+ code?: string;
214
+ };
215
+ /**
216
+ * type of the form
217
+ */
218
+ export declare enum FormType {
219
+ /**
220
+ * standard form
221
+ */
222
+ STANDARD_FORM = "STANDARD_FORM",
223
+ /**
224
+ * custom form
225
+ */
226
+ CUSTOM_FORM = "CUSTOM_FORM"
227
+ }
228
+ /**
229
+ * type of the modal
230
+ */
231
+ export declare enum ModalType {
232
+ /**
233
+ * modal with form
234
+ */
235
+ FORM = "FORM",
236
+ /**
237
+ * modal with tool
238
+ */
239
+ TOOL = "TOOL",
240
+ /**
241
+ * modal with document
242
+ */
243
+ DOCUMENT = "DOCUMENT",
244
+ /**
245
+ * modal that opens a URL
246
+ */
247
+ URL = "URL",
248
+ /**
249
+ * modal with warning message
250
+ */
251
+ WARNING = "WARNING",
252
+ /**
253
+ * modal with error message
254
+ */
255
+ ERROR = "ERROR",
256
+ /**
257
+ * modal with success message
258
+ */
259
+ SUCCESS = "SUCCESS",
260
+ /**
261
+ * modal with info message
262
+ */
263
+ INFO = "INFO"
182
264
  }
183
265
  /**
184
266
  * modal options
185
267
  */
186
- export type OpenModalOptions = {
268
+ export type ModalOptions = {
187
269
  /**
188
270
  * target item
271
+ *
272
+ * optional for warning / success / error / info modal
189
273
  */
190
- target: string;
274
+ target?: string;
191
275
  /**
192
- * name
276
+ * name of the form or tool
277
+ *
278
+ * optional for warning / success / error / info modal
193
279
  */
194
280
  name: string;
195
281
  /**
196
282
  * type of the modal
197
283
  */
198
- type?: string;
284
+ type: ModalType;
199
285
  /**
200
286
  * size of the modal
287
+ * @default ModalSize.EXTRA_LARGE
288
+ */
289
+ size?: ModalSize;
290
+ /**
291
+ * form type
292
+ */
293
+ formType?: FormType;
294
+ /**
295
+ * additional data to display warning / success / error / info modal
296
+ *
201
297
  */
202
- size: ModalSize;
298
+ data?: ModalData;
203
299
  };
204
300
  /**
205
301
  * capabilities exposed by the application
@@ -318,6 +414,10 @@ export type ModuleOpenInfo = {
318
414
  * @example urn:encompass:loanapp
319
415
  */
320
416
  moduleId: string;
417
+ /**
418
+ * mode to open the module. Default is IFRAME
419
+ */
420
+ openMode: OpenMode;
321
421
  };
322
422
  /**
323
423
  * event handler that handles module open event
@@ -385,11 +485,6 @@ export interface IApplication extends IScriptingObject {
385
485
  * close a modal
386
486
  */
387
487
  closeModal(): Promise<void>;
388
- /**
389
- * extends the application with a new menu item or tool
390
- * @param extensionObj properties of the extension
391
- */
392
- extend(extensionObj: ApplicationExtension): Promise<void>;
393
488
  /**
394
489
  * Get the context of the application
395
490
  * @returns application context
@@ -421,7 +516,7 @@ export interface IApplication extends IScriptingObject {
421
516
  * get persona Access information for the current user
422
517
  * @returns persona access information as key value pairs
423
518
  */
424
- getPersonaAccess(): Promise<Record<string, string>>;
519
+ getPersonaAccess(): Promise<Record<string, unknown>>;
425
520
  /**
426
521
  * get policy details for the current user
427
522
  * @returns policy details as key value pairs
@@ -433,10 +528,6 @@ export interface IApplication extends IScriptingObject {
433
528
  * @throws {Error} if operation fails
434
529
  */
435
530
  getUserAccessRights(): Promise<UserAccessRights>;
436
- /**
437
- * hide wait spinner
438
- */
439
- hideSpinner(): Promise<void>;
440
531
  /**
441
532
  * renew the user session
442
533
  */
@@ -474,8 +565,9 @@ export interface IApplication extends IScriptingObject {
474
565
  /**
475
566
  * open a modal
476
567
  * @param options modal properties
568
+ * @returns user selected modal action as string
477
569
  */
478
- openModal(options: OpenModalOptions): Promise<void>;
570
+ openModal(options: ModalOptions): Promise<string>;
479
571
  /**
480
572
  * Perform an action
481
573
  * @param action action name
@@ -487,26 +579,10 @@ export interface IApplication extends IScriptingObject {
487
579
  * @param options Print options
488
580
  */
489
581
  print(options: PrintOptions): Promise<void>;
490
- /**
491
- * show error message to user
492
- * @param message error message to display
493
- */
494
- showError(message: string): Promise<void>;
495
- /**
496
- * show wait spinner
497
- * @param message message to display
498
- */
499
- showSpinner(message: string): Promise<void>;
500
582
  /**
501
583
  * get supportability of an action
502
584
  * @param name action name
503
585
  * @returns true if the action is supported
504
586
  */
505
587
  supportsAction(name: string): Promise<boolean>;
506
- /**
507
- * get navigability to a particular page or screen
508
- * @param name page or screen name
509
- * @returns true if the page or screen is navigable
510
- */
511
- supportsNavigateTo(name: string): Promise<boolean>;
512
588
  }