@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.
@@ -1,64 +1,5 @@
1
1
  import { IEvent } from '../event.js';
2
2
  import { IScriptingObject } from '../scriptingObject.js';
3
- /**
4
- * type of dialog to display in the hosting application
5
- */
6
- export declare enum DialogType {
7
- WARNING = "warning",
8
- ERROR = "error",
9
- SUCCESS = "success",
10
- INFO = "info"
11
- }
12
- /**
13
- * size of the dialog to display in the hosting application
14
- */
15
- export declare enum DialogSize {
16
- SMALL = "small",
17
- MEDIUM = "medium",
18
- LARGE = "large"
19
- }
20
- /**
21
- * Options to display a dialog in the hosting application
22
- */
23
- export type DialogOptions = {
24
- /**
25
- * type of dialog to display
26
- */
27
- type: DialogType;
28
- /**
29
- * size of the dialog to display
30
- */
31
- size: DialogSize;
32
- /**
33
- * title of the dialog
34
- */
35
- title: string;
36
- /**
37
- * message to be displayed in the body of the dialog
38
- */
39
- body: string;
40
- /**
41
- * link to the help documentation
42
- */
43
- helpLink?: string;
44
- /**
45
- * unique id that identifies the session / transaction
46
- */
47
- correlationId?: string;
48
- /**
49
- * error code
50
- */
51
- code?: string;
52
- /**
53
- * list of actions that are avilable to user for providing feedback.
54
- *
55
- * these actions are displayed as buttons in the dialog
56
- *
57
- * default action is 'ok'
58
- * @example ['retry', 'cancel']
59
- */
60
- actions?: string[];
61
- };
62
3
  /**
63
4
  * MicroApp module specific parameters
64
5
  */
@@ -177,24 +118,4 @@ export interface IModule extends IScriptingObject {
177
118
  * unload the microapp module from the host application
178
119
  */
179
120
  unload(): Promise<void>;
180
- /**
181
- * open a dialog in hosting application to display an error, success or info message and related help link
182
- *
183
- * Accessibility Consideration: once the dialog is closed, caller need to set the focus back to the link or button that opened the dialog to ensure keyboard navigation works as expected
184
- * @param options data to be displayed
185
- * @returns a promise that resolves when the dialog is closed along with the user action as string (in-case sensitive). For example, 'ok', 'retry', 'cancel'
186
- * @example
187
- * ```typescript
188
- * await module.showDialog({
189
- * type: DialogType.ERROR,
190
- * size: DialogSize.MEDIUM,
191
- * message: 'CoreLogic Error',
192
- * details: 'An error occurred while processing the credit request',
193
- * helpLink: 'https://example.com/help',
194
- * correlationId: '1234567890'
195
- * code: 'CL-1001'
196
- * });
197
- * ```
198
- */
199
- showDialog(options: DialogOptions): Promise<string>;
200
121
  }
@@ -4,10 +4,9 @@ import { FormEvents, IForm } from './objects/form.js';
4
4
  import { GlobalEvents, IGlobal } from './objects/global.js';
5
5
  import { LoanEvents, ILoan } from './objects/loan.js';
6
6
  import { ModuleEvents, IModule } from './objects/module.js';
7
- import { ViewEvents, IView } from './objects/view.js';
8
7
  type KeysMatching<T extends object, V> = {
9
8
  [K in keyof T]-?: [V] extends [T[K]] ? K : never;
10
9
  }[keyof T];
11
- export type Events = ApplicationEvents & FormEvents & GlobalEvents & LoanEvents & ModuleEvents & ViewEvents;
12
- export type EventObjects = KeysMatching<IApplication, IEvent> | KeysMatching<IForm, IEvent> | KeysMatching<IGlobal, IEvent> | KeysMatching<ILoan, IEvent> | KeysMatching<IModule, IEvent> | KeysMatching<IView, IEvent>;
10
+ export type Events = ApplicationEvents & FormEvents & GlobalEvents & LoanEvents & ModuleEvents;
11
+ export type EventObjects = KeysMatching<IApplication, IEvent> | KeysMatching<IForm, IEvent> | KeysMatching<IGlobal, IEvent> | KeysMatching<ILoan, IEvent> | KeysMatching<IModule, IEvent>;
13
12
  export {};
@@ -4,7 +4,6 @@ import { IApplication } from './objects/application.js';
4
4
  import { IAuth } from './objects/auth.js';
5
5
  import { ISession } from './objects/session.js';
6
6
  import { ITransaction } from './objects/transaction.js';
7
- import { ITransactionV2 } from './objects/transactionv2.js';
8
7
  import { ITransactionTemplate } from './objects/transactionTemplate.js';
9
8
  import { IForm } from './objects/form.js';
10
9
  import { IGlobal } from './objects/global.js';
@@ -12,8 +11,6 @@ import { IHttp } from './objects/http.js';
12
11
  import { IAnalytics } from './objects/analytics.js';
13
12
  import { IMemStorage } from './objects/memStorage.js';
14
13
  import { IModule } from './objects/module.js';
15
- import { IView } from './objects/view.js';
16
- import { IRoute } from './objects/route.js';
17
14
  import { IService } from './objects/service.js';
18
15
  /**
19
16
  * list of scripting object names and their types
@@ -29,13 +26,10 @@ export type ScriptingObjectTypes = {
29
26
  LoanV2: ILoanV2;
30
27
  MemStorage: IMemStorage;
31
28
  Module: IModule;
32
- Route: IRoute;
33
29
  Service: IService;
34
30
  Session: ISession;
35
31
  Transaction: ITransaction;
36
- TransactionV2: ITransactionV2;
37
32
  TransactionTemplate: ITransactionTemplate;
38
- View: IView;
39
33
  };
40
34
  export declare const enum ScriptingObjectNames {
41
35
  Analytics = "analytics",
@@ -48,11 +42,8 @@ export declare const enum ScriptingObjectNames {
48
42
  LoanV2 = "loanV2",
49
43
  MemStorage = "memstorage",
50
44
  Module = "module",
51
- Route = "route",
52
45
  Service = "service",
53
46
  Session = "session",
54
47
  Transaction = "transaction",
55
- TransactionV2 = "transactionV2",
56
- TransactionTemplate = "transactionTemplate",
57
- View = "view"
48
+ TransactionTemplate = "transactionTemplate"
58
49
  }