@elliemae/pui-scripting-object 1.16.5 → 1.16.7

package/dist/cjs/index.js

@@ -3,10 +3,6 @@ var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
 var __copyProps = (to, from, except, desc) => {
   if (from && typeof from === "object" || typeof from === "function") {
     for (let key of __getOwnPropNames(from))
@@ -18,12 +14,6 @@ var __copyProps = (to, from, except, desc) => {
 var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var lib_exports = {};
-__export(lib_exports, {
-  IEvent: () => import_event.IEvent,
-  IScriptingObject: () => import_scriptingObject.IScriptingObject,
-  IScriptingObjectProxy: () => import_scriptingObject.IScriptingObjectProxy,
-  Listener: () => import_event.Listener
-});
 module.exports = __toCommonJS(lib_exports);
 __reExport(lib_exports, require("./objects/analytics.js"), module.exports);
 __reExport(lib_exports, require("./objects/application.js"), module.exports);
@@ -44,5 +34,8 @@ __reExport(lib_exports, require("./objects/transactionTemplate.js"), module.expo
 __reExport(lib_exports, require("./objects/userAccessRights.js"), module.exports);
 __reExport(lib_exports, require("./objects/view.js"), module.exports);
 __reExport(lib_exports, require("./objects/shared.js"), module.exports);
-var import_event = require("./event.js");
-var import_scriptingObject = require("./scriptingObject.js");
+__reExport(lib_exports, require("./event.js"), module.exports);
+__reExport(lib_exports, require("./scriptingObject.js"), module.exports);
+__reExport(lib_exports, require("./remotingScriptingObject.js"), module.exports);
+__reExport(lib_exports, require("./scriptingObjectList.js"), module.exports);
+__reExport(lib_exports, require("./scriptingObjectEventList.js"), module.exports);

package/dist/cjs/scriptingObjectEventList.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 scriptingObjectEventList_exports = {};
+module.exports = __toCommonJS(scriptingObjectEventList_exports);

package/dist/cjs/scriptingObjectList.js

@@ -3,6 +3,10 @@ var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
 var __copyProps = (to, from, except, desc) => {
   if (from && typeof from === "object" || typeof from === "function") {
     for (let key of __getOwnPropNames(from))
@@ -13,4 +17,27 @@ var __copyProps = (to, from, except, desc) => {
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var scriptingObjectList_exports = {};
+__export(scriptingObjectList_exports, {
+  ScriptingObjectNames: () => ScriptingObjectNames
+});
 module.exports = __toCommonJS(scriptingObjectList_exports);
+var ScriptingObjectNames = /* @__PURE__ */ ((ScriptingObjectNames2) => {
+  ScriptingObjectNames2["Analytics"] = "analytics";
+  ScriptingObjectNames2["Application"] = "application";
+  ScriptingObjectNames2["Auth"] = "auth";
+  ScriptingObjectNames2["Form"] = "form";
+  ScriptingObjectNames2["Global"] = "global";
+  ScriptingObjectNames2["Http"] = "http";
+  ScriptingObjectNames2["Loan"] = "loan";
+  ScriptingObjectNames2["LoanV2"] = "loanV2";
+  ScriptingObjectNames2["MemStorage"] = "memstorage";
+  ScriptingObjectNames2["Module"] = "module";
+  ScriptingObjectNames2["Route"] = "route";
+  ScriptingObjectNames2["Service"] = "service";
+  ScriptingObjectNames2["Session"] = "session";
+  ScriptingObjectNames2["Transaction"] = "transaction";
+  ScriptingObjectNames2["TransactionV2"] = "transactionV2";
+  ScriptingObjectNames2["TransactionTemplate"] = "transactionTemplate";
+  ScriptingObjectNames2["View"] = "view";
+  return ScriptingObjectNames2;
+})(ScriptingObjectNames || {});

package/dist/esm/index.js

@@ -17,11 +17,8 @@ export * from "./objects/transactionTemplate.js";
 export * from "./objects/userAccessRights.js";
 export * from "./objects/view.js";
 export * from "./objects/shared.js";
-import { IEvent, Listener } from "./event.js";
-import { IScriptingObjectProxy, IScriptingObject } from "./scriptingObject.js";
-export {
-  IEvent,
-  IScriptingObject,
-  IScriptingObjectProxy,
-  Listener
-};
+export * from "./event.js";
+export * from "./scriptingObject.js";
+export * from "./remotingScriptingObject.js";
+export * from "./scriptingObjectList.js";
+export * from "./scriptingObjectEventList.js";

package/dist/esm/scriptingObjectList.js

@@ -0,0 +1,23 @@
+var ScriptingObjectNames = /* @__PURE__ */ ((ScriptingObjectNames2) => {
+  ScriptingObjectNames2["Analytics"] = "analytics";
+  ScriptingObjectNames2["Application"] = "application";
+  ScriptingObjectNames2["Auth"] = "auth";
+  ScriptingObjectNames2["Form"] = "form";
+  ScriptingObjectNames2["Global"] = "global";
+  ScriptingObjectNames2["Http"] = "http";
+  ScriptingObjectNames2["Loan"] = "loan";
+  ScriptingObjectNames2["LoanV2"] = "loanV2";
+  ScriptingObjectNames2["MemStorage"] = "memstorage";
+  ScriptingObjectNames2["Module"] = "module";
+  ScriptingObjectNames2["Route"] = "route";
+  ScriptingObjectNames2["Service"] = "service";
+  ScriptingObjectNames2["Session"] = "session";
+  ScriptingObjectNames2["Transaction"] = "transaction";
+  ScriptingObjectNames2["TransactionV2"] = "transactionV2";
+  ScriptingObjectNames2["TransactionTemplate"] = "transactionTemplate";
+  ScriptingObjectNames2["View"] = "view";
+  return ScriptingObjectNames2;
+})(ScriptingObjectNames || {});
+export {
+  ScriptingObjectNames
+};

package/dist/types/event.d.ts

@@ -2,7 +2,7 @@ import { IScriptingObjectProxy, IScriptingObject } from './scriptingObject.js';
 /**
  * callback for event
  */
-export declare type Listener<SO extends IScriptingObjectProxy, Params extends Record<string, unknown>, Options extends Record<string, unknown>, ReturnType> = ({ obj, eventName, eventParams, eventOptions, }: {
+export type Listener<SO extends IScriptingObjectProxy, Params extends Record<string, unknown>, Options extends Record<string, unknown>, ReturnType> = ({ obj, eventName, eventParams, eventOptions, }: {
     obj: SO;
     eventName: string;
     eventParams: Params;
@@ -12,6 +12,10 @@ export declare type Listener<SO extends IScriptingObjectProxy, Params extends Re
  * base class for events
  */
 export interface IEvent {
+    /**
+     * unique id of the event
+     */
+    readonly id: string;
     /**
      * name of the event
      */
@@ -32,12 +36,4 @@ export interface IEvent {
      * scripting object from where the event was triggered
      */
     readonly scriptingObject: IScriptingObject;
-    /**
-     * subscribe to the event
-     */
-    subscribe: (callback: Listener<IScriptingObject, Record<string, unknown>, Record<string, unknown>, any>) => string;
-    /**
-     * unsubscribe from the event
-     */
-    unsubscribe: (subscriptionId: string) => void;
 }

package/dist/types/index.d.ts

@@ -17,7 +17,8 @@ export * from './objects/transactionTemplate.js';
 export * from './objects/userAccessRights.js';
 export * from './objects/view.js';
 export * from './objects/shared.js';
-export { IEvent, Listener } from './event.js';
-export { IScriptingObjectProxy, IScriptingObject } from './scriptingObject.js';
-export type { RemotingScriptingObject } from './remotingScriptingObject.js';
-export type { ScriptingObjects } from './scriptingObjectList.js';
+export * from './event.js';
+export * from './scriptingObject.js';
+export * from './remotingScriptingObject.js';
+export * from './scriptingObjectList.js';
+export * from './scriptingObjectEventList.js';

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

@@ -2,7 +2,7 @@ import { IScriptingObject } from '../scriptingObject.js';
 /**
  * Business analytics event to be sent
  */
-export declare type BAEvent = {
+export type BAEvent = {
     /**
      * name of the analytic event
      */

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

@@ -15,7 +15,7 @@ export declare enum LogLevel {
 /**
  * metadata about the application
  */
-export declare type AppInfo = {
+export type AppInfo = {
     id: string;
     name: string;
 };
@@ -29,7 +29,7 @@ export declare enum ApplicationExtensionType {
 /**
  * metadata about the application extension
  */
-export declare type ApplicationExtension = {
+export type ApplicationExtension = {
     /**
      * type of application extension
      */
@@ -61,12 +61,12 @@ export declare enum NavigationType {
 /**
  * navigation options
  */
-export declare type NavigationOptions = {
+export type NavigationOptions = {
     target: string;
     type: NavigationType;
     context?: Record<string, string>;
 };
-export declare type OpenOptions = {
+export type OpenOptions = {
     target: string;
     type?: string;
 };
@@ -78,45 +78,45 @@ export declare enum ModalSize {
     MEDIUM = "md",
     LARGE = "lg"
 }
-export declare type OpenModalOptions = {
+export type OpenModalOptions = {
     target: string;
     name: string;
     type?: string;
     size: ModalSize;
 };
-export declare type Capabilities = {
+export type Capabilities = {
     supprotedActions: Array<string>;
     supportedFeatures: Array<string>;
 };
-export declare type Route = {
+export type Route = {
     url: string;
     type: NavigationType;
     name: string;
     id: string;
 };
-export declare type Environment = {
+export type Environment = {
     apiHost: string;
 };
-export declare type ApplicationContext = {
+export type ApplicationContext = {
     env: Environment;
     route: Route;
 };
 /**
  * Options for printing the document
  */
-export declare type PrintOptions = {
+export type PrintOptions = {
     /**
      * document to print
      */
     blob: Blob;
 };
-declare type UserInfo = {
+type UserInfo = {
     /**
      * user id
      */
     userId: string;
 };
-declare type ActionInfo = {
+type ActionInfo = {
     /**
      * name of the action
      */
@@ -125,60 +125,38 @@ declare type ActionInfo = {
 /**
  * event handler that handles user login event
  */
-export declare type ApplicationLoginListener = Listener<IApplication, UserInfo, Record<string, unknown>, void>;
+export type ApplicationLoginListener = Listener<IApplication, UserInfo, Record<string, unknown>, void>;
 /**
  * event fired when the user logs in
  */
 export interface IApplicationLoginEvent extends IEvent {
-    /**
-     * event name
-     */
-    readonly name: 'Login';
-    /**
-     * scripting object from where the event is fired
-     */
-    readonly objectId: 'Application';
-    /**
-     * 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 {
+export type ApplicationActionCompletedListener = Listener<IApplication, ActionInfo, Record<string, unknown>, void>;
+export type ApplicationEvents = {
     /**
-     * event name
+     * event fired when the user logs in
      */
-    readonly name: 'ActionCompleted';
+    'application.login': ApplicationLoginListener;
     /**
-     * scripting object from where the event is fired
+     * event fired when an action is completed. actions are executed through the performAction method
      */
-    readonly objectId: 'Application';
-    /**
-     * event does not require feedback from listeners
-     */
-    readonly requiresFeedback: false;
+    'application.actioncompleted': ApplicationActionCompletedListener;
+};
+/**
+ * event fired when an action is completed. actions are executed through the performAction method
+ */
+export interface IApplicationActionCompletedEvent extends IEvent {
     /**
      * event parameters
      */
     readonly params: ActionInfo;
-    /**
-     * subscribe to the event
-     */
-    subscribe: (callback: ApplicationActionCompletedListener) => string;
 }
 /**
  * Allows access to application-level UI elements, behaviors and events
@@ -187,17 +165,24 @@ export interface IApplication extends IScriptingObject {
     /**
      * notifies user login
      */
-    readonly Login: IApplicationLoginEvent;
+    readonly Login: {
+        new (): IApplicationLoginEvent;
+    };
     /**
      * notifies action completion
      */
-    readonly ActionCompleted: IApplicationActionCompletedEvent;
+    readonly ActionCompleted: {
+        new (): IApplicationActionCompletedEvent;
+    };
     /**
      * Gets descriptor for the Application
      *
      * @returns application descriptor
      */
     getDescriptior(): Promise<AppInfo>;
+    /**
+     * Get the context of the application
+     */
     getApplicationContext(): Promise<ApplicationContext>;
     /**
      * extends the application with a new menu item or tool

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

@@ -1,11 +1,11 @@
 import { IScriptingObject } from '../scriptingObject.js';
 import { UserAccessRights } from './userAccessRights.js';
-export declare type Personas = {
+export type Personas = {
     entityId: string;
     entityType: string;
     entityName: string;
 };
-export declare type User = {
+export type User = {
     /**
      * unique identifier for the user
      */
@@ -40,7 +40,7 @@ export declare type User = {
 export declare enum TokenType {
     BEARER = "Bearer"
 }
-export declare type PluginInfo = {
+export type PluginInfo = {
     /**
      * unique identifier for the plugin
      */
@@ -54,7 +54,7 @@ export declare type PluginInfo = {
      */
     scope: TokenType;
 };
-export declare type TokenInfo = {
+export type TokenInfo = {
     /**
      * child access token
      */

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

@@ -1,10 +1,10 @@
 import { IEvent, Listener } from '../event.js';
 import { IScriptingObject } from '../scriptingObject.js';
-export declare type FormDescriptor = {
+export type FormDescriptor = {
     id: string;
     name: string;
 };
-declare type FormInfo = {
+type FormInfo = {
     /**
      * unique id of the form
      */
@@ -13,61 +13,42 @@ declare type FormInfo = {
 /**
  * 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>;
+export type FormLoadListener = Listener<IForm, FormInfo, Record<string, unknown>, void>;
 /**
  * event to notify form load operation
  */
 export interface IFormLoadEvent extends IEvent {
-    /**
-     * event name
-     */
-    readonly name: 'Load';
-    /**
-     * scripting object from where the event is fired
-     */
-    readonly objectId: 'Form';
-    /**
-     * event does not require feedback from listeners
-     */
-    readonly requiresFeedback: false;
     /**
      * event parameters
      */
     readonly params: FormInfo;
-    /**
-     * subscribe to the event
-     */
-    subscribe: (callback: FormLoadListener) => string;
 }
+/**
+ * event handler for form unload event
+ */
+export type FormUnloadListener = Listener<IForm, FormInfo, Record<string, unknown>, void>;
 /**
  * event to notify form unload operation
  */
-export interface IFormUnLoadEvent extends IEvent {
-    /**
-     * event name
-     */
-    readonly name: 'UnLoad';
-    /**
-     * scripting object from where the event is fired
-     */
-    readonly objectId: 'Form';
-    /**
-     * event does not require feedback from listeners
-     */
-    readonly requiresFeedback: false;
+export interface IFormUnloadEvent extends IEvent {
     /**
      * event parameters
      */
     readonly params: FormInfo;
+}
+/**
+ * events that notifies the form's lifecycle
+ */
+export type FormEvents = {
     /**
-     * subscribe to the event
+     * form is loaded and ready for user interaction
      */
-    subscribe: (callback: FormUnLoadListener) => string;
-}
+    'form.load': FormLoadListener;
+    /**
+     * form is unloaded and no longer available for user interaction
+     */
+    'form.unload': FormUnloadListener;
+};
 /**
  * Methods to get information about the custom form
  */
@@ -75,11 +56,15 @@ export interface IForm extends IScriptingObject {
     /**
      * event fired when the form is loaded
      */
-    readonly Load: IFormLoadEvent;
+    readonly Load: {
+        new (): IFormLoadEvent;
+    };
     /**
      * event fired when the form is unloaded
      */
-    readonly UnLoad: IFormUnLoadEvent;
+    readonly Unload: {
+        new (): IFormUnloadEvent;
+    };
     /**
      * get metadata of the form
      *

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

@@ -1,6 +1,6 @@
 import { IEvent, Listener } from '../event.js';
 import { IScriptingObject } from '../scriptingObject.js';
-declare type StateInfo = {
+type StateInfo = {
     /**
      * name of the key for which the value changed
      */
@@ -9,32 +9,25 @@ declare type StateInfo = {
 /**
  * event handler for global state change event
  */
-export declare type GlobalChangeListener = Listener<IGlobal, StateInfo, Record<string, unknown>, void>;
+export type GlobalChangeListener = Listener<IGlobal, StateInfo, Record<string, unknown>, void>;
 /**
  * event to notify change in global state
  */
 export interface IGlobalChangeEvent extends IEvent {
-    /**
-     * event name
-     */
-    readonly name: 'Change';
-    /**
-     * scripting object from where the event is fired
-     */
-    readonly objectId: 'Global';
-    /**
-     * event does not require feedback from listeners
-     */
-    readonly requiresFeedback: false;
     /**
      * event parameters
      */
     readonly params: StateInfo;
+}
+/**
+ * events fired from Global scripting object
+ */
+export type GlobalEvents = {
     /**
-     * subscribe to the event
+     * event fired when a value changes in the global store
      */
-    subscribe: (callback: GlobalChangeListener) => string;
-}
+    'global.change': GlobalChangeListener;
+};
 /**
  * The Global object allows for data to be shared between custom forms/tools/plugins within a user's session.
  * Unlike the Session scripting object, where data is isolated to be visible/accessible only by the form/plugin that writes the variables,
@@ -55,7 +48,9 @@ export interface IGlobal extends IScriptingObject {
     /**
      * event fired when the global state changes
      */
-    readonly Change: IGlobalChangeEvent;
+    readonly Change: {
+        new (): IGlobalChangeEvent;
+    };
     /**
      * set a value in the global store
      *