@elliemae/pui-scripting-object 1.50.0 → 1.50.2

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.
@@ -25,6 +25,19 @@ export type TimingOptions = {
25
25
  */
26
26
  appUrl: string;
27
27
  };
28
+ /**
29
+ * Performance mark
30
+ */
31
+ export type PerfMark = {
32
+ /**
33
+ * name of the performance mark
34
+ */
35
+ name: string;
36
+ /**
37
+ * start time of the performance mark
38
+ */
39
+ startTime: number;
40
+ };
28
41
  /**
29
42
  * Methods to collect various business analytics & performance related events and report the same
30
43
  */
@@ -38,9 +51,9 @@ export interface IAnalytics extends IScriptingObject {
38
51
  * start timing measure
39
52
  * @param name unique name for the timing measurement. If a measurement with the same name is already running, it will be replaced
40
53
  * @param options additional details related to the measurement
41
- * @returns a promise that resolves to a PerformanceMeasure object
54
+ * @returns a promise that resolves to a performance mark object
42
55
  */
43
- startTiming(name: string, options: TimingOptions): Promise<PerformanceMeasure>;
56
+ startTiming(name: string, options: TimingOptions): Promise<PerfMark>;
44
57
  /**
45
58
  * end timing measure
46
59
  * @param start name used to start timing measure or return value of the startTiming method
@@ -58,5 +71,5 @@ export interface IAnalytics extends IScriptingObject {
58
71
  * await analytics.endTiming('LongTask', { appId: 'loanApp', appUrl: 'https://loanApp.com' });
59
72
  * ```
60
73
  */
61
- endTiming(start: string | PerformanceMeasure, options: TimingOptions): Promise<void>;
74
+ endTiming(start: string | PerfMark, options: TimingOptions): Promise<void>;
62
75
  }
@@ -327,9 +327,80 @@ export type LoanEditModeChangeListener = (params: {
327
327
  */
328
328
  export type MilestoneInfo = {
329
329
  /**
330
- * milestone name
330
+ * Unique identifier for the milestone
331
+ */
332
+ milestoneId: string;
333
+ /**
334
+ * Information about the loan associate
335
+ */
336
+ loanAssociate: {
337
+ /**
338
+ * Role information of the loan associate
339
+ */
340
+ role: {
341
+ /**
342
+ * Unique identifier for the role
343
+ */
344
+ entityId: string;
345
+ /**
346
+ * Name of the role
347
+ */
348
+ entityName: string;
349
+ /**
350
+ * Type of the entity (e.g., Role)
351
+ */
352
+ entityType: string;
353
+ };
354
+ /**
355
+ * Indicates if the loan associate has write access
356
+ */
357
+ writeAccess: boolean;
358
+ };
359
+ /**
360
+ * Name of the milestone
331
361
  */
332
362
  name: string;
363
+ /**
364
+ * User associated with the milestone (can be null)
365
+ */
366
+ user: null | unknown;
367
+ /**
368
+ * Role information for the milestone
369
+ */
370
+ role: {
371
+ /**
372
+ * Unique identifier for the role
373
+ */
374
+ entityId: string;
375
+ /**
376
+ * Name of the role
377
+ */
378
+ entityName: string;
379
+ /**
380
+ * Type of the entity (e.g., Role)
381
+ */
382
+ entityType: string;
383
+ };
384
+ /**
385
+ * Indicates if the role is required for the milestone
386
+ */
387
+ roleRequired: boolean;
388
+ /**
389
+ * Indicates if the milestone is marked as done
390
+ */
391
+ doneIndicator: boolean;
392
+ /**
393
+ * Indicates if the milestone has been reviewed
394
+ */
395
+ reviewedIndicator: boolean;
396
+ /**
397
+ * Number of days to finish the milestone
398
+ */
399
+ daysToFinish: number;
400
+ /**
401
+ * Date by which the milestone should be finished (ISO 8601 format)
402
+ */
403
+ daysToFinishDate: string;
333
404
  };
334
405
  /**
335
406
  * Selected application related information
@@ -162,6 +162,7 @@ export interface IModule extends IScriptingObject {
162
162
  getParameters(): Promise<ModuleParameters>;
163
163
  /**
164
164
  * log a message to host application's logs
165
+ * @deprecated use Application.log instead
165
166
  * @param message log message
166
167
  * @param logLevel log level
167
168
  */