@elliemae/pui-scripting-object 1.16.0 → 1.16.2

package/dist/types/event.d.ts

@@ -6,12 +6,12 @@ export declare type Listener<SO extends IScriptingObjectProxy, Params extends Re
     obj: SO;
     eventName: string;
     eventParams: Params;
-    eventOptions: Options;
+    eventOptions?: Options;
 }) => ReturnType;
 /**
  * base class for events
  */
-export interface IEvent<SO extends IScriptingObjectProxy, Params extends Record<string, unknown>, Options extends Record<string, unknown>, ReturnType> {
+export interface IEvent {
     /**
      * name of the event
      */
@@ -27,7 +27,7 @@ export interface IEvent<SO extends IScriptingObjectProxy, Params extends Record<
     /**
      * parameters associated with the event
      */
-    readonly params: Params;
+    readonly params: Record<string, unknown>;
     /**
      * scripting object from where the event was triggered
      */
@@ -35,7 +35,7 @@ export interface IEvent<SO extends IScriptingObjectProxy, Params extends Record<
     /**
      * subscribe to the event
      */
-    subscribe: (callback: Listener<SO, Params, Options, ReturnType>) => string;
+    subscribe: (callback: Listener<IScriptingObject, Record<string, unknown>, Record<string, unknown>, any>) => string;
     /**
      * unsubscribe from the event
      */

package/dist/types/objects/application.d.ts

@@ -1,4 +1,4 @@
-import { IEvent } from '../event.js';
+import { IEvent, Listener } from '../event.js';
 import { IScriptingObject } from '../scriptingObject.js';
 /**
  * Log levels
@@ -110,12 +110,26 @@ export declare type PrintOptions = {
      */
     blob: Blob;
 };
+declare type UserInfo = {
+    /**
+     * user id
+     */
+    userId: string;
+};
+declare type ActionInfo = {
+    /**
+     * name of the action
+     */
+    name: string;
+};
+/**
+ * event handler that handles user login event
+ */
+export declare type ApplicationLoginListener = Listener<IApplication, UserInfo, Record<string, unknown>, void>;
 /**
  * event fired when the user logs in
  */
-export interface IApplicationLoginEvent extends IEvent<IApplication, {
-    userId: string;
-}, Record<string, unknown>, void> {
+export interface IApplicationLoginEvent extends IEvent {
     /**
      * event name
      */
@@ -128,13 +142,23 @@ export interface IApplicationLoginEvent extends IEvent<IApplication, {
      * event does not require feedback from listeners
      */
     readonly requiresFeedback: false;
+    /**
+     * event parameters
+     */
+    readonly params: UserInfo;
+    /**
+     * subscribe to the event
+     */
+    subscribe: (callback: ApplicationLoginListener) => string;
 }
+/**
+ * event handler that handles action completed event
+ */
+export declare type ApplicationActionCompletedListener = Listener<IApplication, ActionInfo, Record<string, unknown>, void>;
 /**
  * event fired when an action is completed. actions are executed through the performAction method
  */
-export interface IApplicationActionCompletedEvent extends IEvent<IApplication, {
-    name: string;
-}, Record<string, unknown>, void> {
+export interface IApplicationActionCompletedEvent extends IEvent {
     /**
      * event name
      */
@@ -147,6 +171,14 @@ export interface IApplicationActionCompletedEvent extends IEvent<IApplication, {
      * event does not require feedback from listeners
      */
     readonly requiresFeedback: false;
+    /**
+     * event parameters
+     */
+    readonly params: ActionInfo;
+    /**
+     * subscribe to the event
+     */
+    subscribe: (callback: ApplicationActionCompletedListener) => string;
 }
 /**
  * Allows access to application-level UI elements, behaviors and events
@@ -262,3 +294,4 @@ export interface IApplication extends IScriptingObject {
      */
     log(message: string, logLevel: LogLevel): Promise<void>;
 }
+export {};

package/dist/types/objects/form.d.ts

@@ -1,15 +1,27 @@
-import { IEvent } from '../event.js';
+import { IEvent, Listener } from '../event.js';
 import { IScriptingObject } from '../scriptingObject.js';
 export declare type FormDescriptor = {
     id: string;
     name: string;
 };
+declare type FormInfo = {
+    /**
+     * unique id of the form
+     */
+    id: string;
+};
+/**
+ * event handler for form load event
+ */
+export declare type FormLoadListener = Listener<IForm, FormInfo, Record<string, unknown>, void>;
+/**
+ * event handler for form unload event
+ */
+export declare type FormUnLoadListener = Listener<IForm, FormInfo, Record<string, unknown>, void>;
 /**
  * event to notify form load operation
  */
-export interface IFormLoadEvent extends IEvent<IForm, {
-    id: string;
-}, Record<string, unknown>, void> {
+export interface IFormLoadEvent extends IEvent {
     /**
      * event name
      */
@@ -22,13 +34,19 @@ export interface IFormLoadEvent extends IEvent<IForm, {
      * event does not require feedback from listeners
      */
     readonly requiresFeedback: false;
+    /**
+     * event parameters
+     */
+    readonly params: FormInfo;
+    /**
+     * subscribe to the event
+     */
+    subscribe: (callback: FormLoadListener) => string;
 }
 /**
  * event to notify form unload operation
  */
-export interface IFormUnLoadEvent extends IEvent<IForm, {
-    id: string;
-}, Record<string, unknown>, void> {
+export interface IFormUnLoadEvent extends IEvent {
     /**
      * event name
      */
@@ -41,6 +59,14 @@ export interface IFormUnLoadEvent extends IEvent<IForm, {
      * event does not require feedback from listeners
      */
     readonly requiresFeedback: false;
+    /**
+     * event parameters
+     */
+    readonly params: FormInfo;
+    /**
+     * subscribe to the event
+     */
+    subscribe: (callback: FormUnLoadListener) => string;
 }
 /**
  * Methods to get information about the custom form
@@ -68,3 +94,4 @@ export interface IForm extends IScriptingObject {
      */
     getControl(id: string): Promise<unknown>;
 }
+export {};

package/dist/types/objects/global.d.ts

@@ -1,11 +1,19 @@
-import { IEvent } from '../event.js';
+import { IEvent, Listener } from '../event.js';
 import { IScriptingObject } from '../scriptingObject.js';
+declare type StateInfo = {
+    /**
+     * name of the key for which the value changed
+     */
+    key: string;
+};
+/**
+ * event handler for global state change event
+ */
+export declare type GlobalChangeListener = Listener<IGlobal, StateInfo, Record<string, unknown>, void>;
 /**
  * event to notify change in global state
  */
-export interface IGlobalChangeEvent extends IEvent<IGlobal, {
-    key: string;
-}, Record<string, unknown>, void> {
+export interface IGlobalChangeEvent extends IEvent {
     /**
      * event name
      */
@@ -18,6 +26,14 @@ export interface IGlobalChangeEvent extends IEvent<IGlobal, {
      * event does not require feedback from listeners
      */
     readonly requiresFeedback: false;
+    /**
+     * event parameters
+     */
+    readonly params: StateInfo;
+    /**
+     * subscribe to the event
+     */
+    subscribe: (callback: GlobalChangeListener) => string;
 }
 /**
  * The Global object allows for data to be shared between custom forms/tools/plugins within a user's session.
@@ -55,3 +71,4 @@ export interface IGlobal extends IScriptingObject {
      */
     get(key: string): Promise<unknown>;
 }
+export {};

package/dist/types/objects/loan.d.ts

@@ -1,4 +1,4 @@
-import { IEvent } from '../event.js';
+import { IEvent, Listener } from '../event.js';
 import { IScriptingObject } from '../scriptingObject.js';
 /**
  * option name and its value
@@ -23,12 +23,22 @@ export declare enum LoanLevelActions {
     COPY_ITEMIZATION_TO_STATE_DISCLOSURE = "copyItemizationToStateDisclosure",
     CALCULATE_EEM_MORTGAGE = "calculateEEMMortgage"
 }
+declare type CommitInfo = {
+    /**
+     * cause of commit event
+     */
+    cause: string;
+};
+/**
+ * event handler for loan precommit event
+ *
+ * @returns true if precommit is allowed, false otherwise
+ */
+export declare type LoanPreCommitListener = Listener<ILoan, CommitInfo, Record<string, unknown>, boolean>;
 /**
  * event to notify loan precommit operation
  */
-export interface ILoanPreCommitEvent extends IEvent<ILoan, {
-    cause: string;
-}, Record<string, unknown>, boolean> {
+export interface ILoanPreCommitEvent extends IEvent {
     /**
      * event name
      */
@@ -41,13 +51,24 @@ export interface ILoanPreCommitEvent extends IEvent<ILoan, {
      * event requires feedback from listeners
      */
     readonly requiresFeedback: true;
+    /**
+     * event parameters
+     */
+    readonly params: CommitInfo;
+    /**
+     * subscribe to the event
+     */
+    subscribe: (callback: LoanPreCommitListener) => string;
 }
+/**
+ * event handler for loan commited event
+ *
+ */
+export declare type LoanCommittedListener = Listener<ILoan, CommitInfo, Record<string, unknown>, void>;
 /**
  * event to notify loan committed operation
  */
-export interface ILoanCommittedEvent extends IEvent<ILoan, {
-    cause: string;
-}, Record<string, unknown>, void> {
+export interface ILoanCommittedEvent extends IEvent {
     /**
      * event name
      */
@@ -60,11 +81,23 @@ export interface ILoanCommittedEvent extends IEvent<ILoan, {
      * event does not require feedback from listeners
      */
     readonly requiresFeedback: false;
+    /**
+     * event parameters
+     */
+    readonly params: CommitInfo;
+    /**
+     * subscribe to the event
+     */
+    subscribe: (callback: LoanCommittedListener) => string;
 }
+/**
+ * event handler for loan data change event
+ */
+export declare type LoanChangeListener = Listener<ILoan, Record<string, never>, Record<string, unknown>, void>;
 /**
  * event to notify loan change operation
  */
-export interface ILoanChangeEvent extends IEvent<ILoan, Record<string, never>, Record<string, unknown>, void> {
+export interface ILoanChangeEvent extends IEvent {
     /**
      * event name
      */
@@ -77,11 +110,23 @@ export interface ILoanChangeEvent extends IEvent<ILoan, Record<string, never>, R
      * event does not require feedback from listeners
      */
     readonly requiresFeedback: false;
+    /**
+     * event parameters
+     */
+    readonly params: Record<string, never>;
+    /**
+     * subscribe to the event
+     */
+    subscribe: (callback: LoanChangeListener) => string;
 }
+/**
+ * event handler for loan sync event
+ */
+export declare type LoanSyncListener = Listener<ILoan, Record<string, never>, Record<string, unknown>, void>;
 /**
  * event to notify loan sync operation
  */
-export interface ILoanSyncEvent extends IEvent<ILoan, Record<string, never>, Record<string, unknown>, void> {
+export interface ILoanSyncEvent extends IEvent {
     /**
      * event name
      */
@@ -94,11 +139,23 @@ export interface ILoanSyncEvent extends IEvent<ILoan, Record<string, never>, Rec
      * event does not require feedback from listeners
      */
     readonly requiresFeedback: false;
+    /**
+     * event parameters
+     */
+    readonly params: Record<string, never>;
+    /**
+     * subscribe to the event
+     */
+    subscribe: (callback: LoanSyncListener) => string;
 }
+/**
+ * event handler for loan open event
+ */
+export declare type LoanOpenListener = Listener<ILoan, Record<string, never>, Record<string, unknown>, void>;
 /**
  * event to notify loan open operation
  */
-export interface ILoanOpenEvent extends IEvent<ILoan, Record<string, never>, Record<string, unknown>, void> {
+export interface ILoanOpenEvent extends IEvent {
     /**
      * event name
      */
@@ -111,11 +168,25 @@ export interface ILoanOpenEvent extends IEvent<ILoan, Record<string, never>, Rec
      * event does not require feedback from listeners
      */
     readonly requiresFeedback: false;
+    /**
+     * event parameters
+     */
+    readonly params: Record<string, never>;
+    /**
+     * subscribe to the event
+     */
+    subscribe: (callback: LoanOpenListener) => string;
 }
+/**
+ * event handler for loan close event
+ *
+ * @returns true if loan close is allowed, false otherwise
+ */
+export declare type LoanCloseListener = Listener<ILoan, Record<string, never>, Record<string, unknown>, void>;
 /**
  * event to notify loan close operation
  */
-export interface ILoanCloseEvent extends IEvent<ILoan, Record<string, never>, Record<string, unknown>, void> {
+export interface ILoanCloseEvent extends IEvent {
     /**
      * event name
      */
@@ -128,13 +199,29 @@ export interface ILoanCloseEvent extends IEvent<ILoan, Record<string, never>, Re
      * event does not require feedback from listeners
      */
     readonly requiresFeedback: false;
+    /**
+     * event parameters
+     */
+    readonly params: Record<string, never>;
+    /**
+     * subscribe to the event
+     */
+    subscribe: (callback: LoanCloseListener) => string;
 }
+declare type MilestoneInfo = {
+    /**
+     * milestone name
+     */
+    name: string;
+};
+/**
+ * event handler for loan milestone completed event
+ */
+export declare type LoanMilestoneCompletedListener = Listener<ILoan, MilestoneInfo, Record<string, unknown>, void>;
 /**
  * event to notify loan milestone completed operation
  */
-export interface ILoanMilestoneCompletedEvent extends IEvent<ILoan, {
-    name: string;
-}, Record<string, unknown>, void> {
+export interface ILoanMilestoneCompletedEvent extends IEvent {
     /**
      * event name
      */
@@ -147,13 +234,25 @@ export interface ILoanMilestoneCompletedEvent extends IEvent<ILoan, {
      * event does not require feedback from listeners
      */
     readonly requiresFeedback: false;
+    /**
+     * event parameters
+     */
+    readonly params: MilestoneInfo;
+    /**
+     * subscribe to the event
+     */
+    subscribe: (callback: LoanMilestoneCompletedListener) => string;
 }
+/**
+ * event handler for loan pre milestone complete event
+ *
+ * @returns true if milestone complete is allowed, false otherwise
+ */
+export declare type LoanPreMilestoneCompleteListener = Listener<ILoan, MilestoneInfo, Record<string, unknown>, boolean>;
 /**
  * event to notify loan pre milestone complete operation
  */
-export interface ILoanPreMilestoneCompleteEvent extends IEvent<ILoan, {
-    name: string;
-}, Record<string, unknown>, boolean> {
+export interface ILoanPreMilestoneCompleteEvent extends IEvent {
     /**
      * event name
      */
@@ -166,11 +265,23 @@ export interface ILoanPreMilestoneCompleteEvent extends IEvent<ILoan, {
      * event requires feedback from listeners
      */
     readonly requiresFeedback: true;
+    /**
+     * event parameters
+     */
+    readonly params: MilestoneInfo;
+    /**
+     * subscribe to the event
+     */
+    subscribe: (callback: LoanPreMilestoneCompleteListener) => string;
 }
+/**
+ * event handler for loan application selected event
+ */
+export declare type LoanApplicationSelectedListener = Listener<ILoan, Record<string, never>, Record<string, unknown>, void>;
 /**
  * event to notify loan application selected operation
  */
-export interface ILoanApplicationSelectedEvent extends IEvent<ILoan, Record<string, never>, Record<string, unknown>, void> {
+export interface ILoanApplicationSelectedEvent extends IEvent {
     /**
      * event name
      */
@@ -183,6 +294,14 @@ export interface ILoanApplicationSelectedEvent extends IEvent<ILoan, Record<stri
      * event does not require feedback from listeners
      */
     readonly requiresFeedback: false;
+    /**
+     * event parameters
+     */
+    readonly params: Record<string, never>;
+    /**
+     * subscribe to the event
+     */
+    subscribe: (callback: LoanApplicationSelectedListener) => string;
 }
 /**
  * Methods for interacting with an open loan in the application
@@ -342,3 +461,4 @@ export interface ILoan extends IScriptingObject {
     getCollection(name: string): Promise<Record<string, string>>;
     getLockSnapshot(): Promise<Record<string, string>>;
 }
+export {};

package/dist/types/objects/module.d.ts

@@ -1,9 +1,16 @@
-import { IEvent } from '../event.js';
+import { IEvent, Listener } from '../event.js';
 import { IScriptingObject } from '../scriptingObject.js';
+/**
+ * event handler that handles module unload event
+ *
+ * @param id unique id of the app that is being unloaded
+ * @returns true if the module can be unloaded, false otherwise
+ */
+export declare type ModuleUnLoadingListener = Listener<IModule, Record<string, never>, Record<string, unknown>, boolean>;
 /**
  * Module unloading event
  */
-export interface IModuleUnloadingEvent extends IEvent<IModule, Record<string, never>, Record<string, unknown>, boolean> {
+export interface IModuleUnloadingEvent extends IEvent {
     /**
      * event name
      */
@@ -16,6 +23,14 @@ export interface IModuleUnloadingEvent extends IEvent<IModule, Record<string, ne
      * response needed from event listeners
      */
     readonly requiresFeedback: true;
+    /**
+     * event parameters
+     */
+    readonly params: Record<string, never>;
+    /**
+     * subscribe to the event
+     */
+    subscribe: (callback: ModuleUnLoadingListener) => string;
 }
 /**
  * Exposes MicroApp module specific methods

package/dist/types/objects/view.d.ts

@@ -1,5 +1,5 @@
 import { BreakPoint } from '@elliemae/pui-theme';
-import { IEvent } from '../event.js';
+import { IEvent, Listener } from '../event.js';
 import { IScriptingObject } from '../scriptingObject.js';
 /**
  * window viewport size
@@ -8,12 +8,20 @@ export declare type ViewportSize = {
     width: number;
     height: number;
 };
+declare type ViewportSizeInfo = {
+    /**
+     * details about the resize event
+     */
+    entires: ResizeObserverEntry;
+};
+/**
+ * parent window resize event handler
+ */
+export declare type ViewResizeListener = Listener<IView, ViewportSizeInfo, Record<string, unknown>, void>;
 /**
  * event to notify window viewport resize operation
  */
-export interface IViewResizeEvent extends IEvent<IView, {
-    entries: ResizeObserverEntry;
-}, Record<string, unknown>, void> {
+export interface IViewResizeEvent extends IEvent {
     /**
      * event name
      */
@@ -26,13 +34,29 @@ export interface IViewResizeEvent extends IEvent<IView, {
      * event does not require feedback from listeners
      */
     readonly requiresFeedback: false;
+    /**
+     * event parameters
+     */
+    readonly params: ViewportSizeInfo;
+    /**
+     * subscribe to the event
+     */
+    subscribe: (callback: ViewResizeListener) => string;
 }
+declare type BreakpointInfo = {
+    /**
+     * current breakpoint of the parent window
+     */
+    breakpoint: BreakPoint;
+};
+/**
+ * parent window breakpoint change event handler
+ */
+export declare type BreakpointChangeListener = Listener<IView, BreakpointInfo, Record<string, unknown>, void>;
 /**
  * event to notify window viewport breakpoint change
  */
-export interface IViewBreakpointChangeEvent extends IEvent<IView, {
-    breakpoint: BreakPoint;
-}, Record<string, unknown>, void> {
+export interface IViewBreakpointChangeEvent extends IEvent {
     /**
      * event name
      */
@@ -45,6 +69,14 @@ export interface IViewBreakpointChangeEvent extends IEvent<IView, {
      * event does not require feedback from listeners
      */
     readonly requiresFeedback: false;
+    /**
+     * event parameters
+     */
+    readonly params: BreakpointInfo;
+    /**
+     * subscribe to the event
+     */
+    subscribe: (callback: BreakpointChangeListener) => string;
 }
 /**
  * Methods view, modify parent's window attributes
@@ -67,3 +99,4 @@ export interface IView extends IScriptingObject {
      */
     getViewPortSize(): Promise<ViewportSize>;
 }
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/pui-scripting-object",
-  "version": "1.16.0",
+  "version": "1.16.2",
   "description": "Typescript defintions for Scripting Objects",
   "sideEffects": false,
   "main": "./dist/cjs/index.js",