@elliemae/pui-scripting-object 1.40.4 → 1.41.1

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

@@ -1,4 +1,4 @@
-import { IEvent, Listener } from '../event.js';
+import { IEvent } from '../event.js';
 import { IScriptingObject } from '../scriptingObject.js';
 import { UserAccessRights } from './userAccessRights.js';
 import { NavigationType } from './shared.js';
@@ -206,13 +206,19 @@ export type PrintOptions = {
      */
     blob: Blob;
 };
-type UserInfo = {
+/**
+ * User information
+ */
+export type UserInfo = {
     /**
      * user id
      */
     userId: string;
 };
-type ActionInfo = {
+/**
+ * Action information
+ */
+export type ActionInfo = {
     /**
      * name of the action
      */
@@ -220,121 +226,154 @@ type ActionInfo = {
 };
 /**
  * event handler that handles user login event
+ * @param params event parameters
+ * @param params.obj application object reference
+ * @param params.eventName event name
+ * @param params.eventParams logged in user info
+ * @param params.eventOptions additional options related to the event
  */
-export type ApplicationLoginListener = Listener<IApplication, UserInfo, Record<string, unknown>, void>;
+export type ApplicationLoginListener = (params: {
+    obj: IApplication;
+    eventName: string;
+    eventParams: UserInfo;
+    eventOptions?: Record<string, unknown>;
+}) => void;
 /**
  * event handler that handles action completed event
+ * @param params event parameters
+ * @param params.obj application object reference
+ * @param params.eventName event name
+ * @param params.eventParams action info
+ * @param params.eventOptions additional options related to the event
+ */
+export type ApplicationActionCompletedListener = (params: {
+    obj: IApplication;
+    eventName: string;
+    eventParams: ActionInfo;
+    eventOptions?: Record<string, unknown>;
+}) => void;
+/**
+ * events related to the application
  */
-export type ApplicationActionCompletedListener = Listener<IApplication, ActionInfo, Record<string, unknown>, void>;
 export type ApplicationEvents = {
-    /**
-     * event fired when the user logs in
-     */
-    'application.login': ApplicationLoginListener;
     /**
      * event fired when an action is completed. actions are executed through the performAction method
+     *
+     * Use {@link ApplicationActionCompletedListener} to handle this event
      */
     'application.actioncompleted': ApplicationActionCompletedListener;
+    /**
+     * event fired when the user logs in
+     *
+     * Use {@link ApplicationLoginListener} to handle this event
+     */
+    'application.login': ApplicationLoginListener;
 };
 /**
  * Allows access to application-level UI elements, behaviors and events
+ *
+ * See {@link ApplicationEvents} for supported events
  */
 export interface IApplication extends IScriptingObject {
+    /**
+     * notifies action completion
+     *
+     * Use {@link ApplicationActionCompletedListener} to handle this event
+     */
+    readonly ActionCompleted: IEvent;
     /**
      * notifies user login
+     *
+     * Use {@link ApplicationLoginListener} to handle this event
      */
     readonly Login: IEvent;
     /**
-     * notifies action completion
+     * close a modal
      */
-    readonly ActionCompleted: IEvent;
+    closeModal(): Promise<void>;
     /**
-     * Gets descriptor for the Application
-     * @returns application descriptor
+     * extends the application with a new menu item or tool
+     * @param extensionObj properties of the extension
      */
-    getDescriptior(): Promise<DescriptorInfo>;
+    extend(extensionObj: ApplicationExtension): Promise<void>;
     /**
      * Get the context of the application
      * @returns application context
      */
     getApplicationContext(): Promise<ApplicationContext>;
     /**
-     * Get additional information about the application
-     * @returns application info
-     */
-    getInfo(): Promise<AppInfo>;
-    /**
-     * extends the application with a new menu item or tool
-     * @param extensionObj properties of the extension
+     * Get the capabilities of the application
+     * @returns capabilities as key-value pairs
      */
-    extend(extensionObj: ApplicationExtension): Promise<void>;
+    getCapabilities(): Promise<Capabilities>;
     /**
-     * navigate to a location in the application
-     * @param options navigation options
+     * get company settings for a particular category
+     * @param options options to query company settings
+     * @returns company settings as key value pairs. Null if category is not found
      */
-    navigate(options: NavigationOptions): Promise<void>;
-    performAction(action: string, options: Record<string, string>): Promise<void>;
+    getCompanySettings(options: CompanySettingsQueryOptions): Promise<Record<string, unknown> | null>;
     /**
-     * open a page or document
-     * @param options target and type of the document to open
+     * Gets descriptor for the Application
+     * @returns application descriptor
      */
-    open(options: OpenOptions): Promise<void>;
+    getDescriptor(): Promise<DescriptorInfo>;
     /**
-     * open a modal
-     * @param options modal properties
+     * Get additional information about the application
+     * @returns application info
      */
-    openModal(options: OpenModalOptions): Promise<void>;
+    getInfo(): Promise<AppInfo>;
     /**
-     * close a modal
+     * @deprecated use getUserAccessRights instead
+     * get persona Access information for the current user
+     * @returns persona access information as key value pairs
      */
-    closeModal(): Promise<void>;
+    getPersonaAccess(): Promise<Record<string, string>>;
     /**
-     * get supportability of an action
-     * @param name action name
-     * @returns true if the action is supported
+     * get policy details for the current user
+     * @returns policy details as key value pairs
      */
-    supportsAction(name: string): Promise<boolean>;
+    getPoliciesDetails(): Promise<Record<string, string>>;
     /**
-     * get navigability to a particular page or screen
-     * @param name page or screen name
-     * @returns true if the page or screen is navigable
+     * Get access rights for the current user
+     * @returns user access rights (effective rights)
+     * @throws {Error} if operation fails
      */
-    supportsNavigateTo(name: string): Promise<boolean>;
+    getUserAccessRights(): Promise<UserAccessRights>;
     /**
-     * Get the capabilities of the application
-     * @returns capabilities as key-value pairs
+     * hide wait spinner
      */
-    getCapabilities(): Promise<Capabilities>;
+    hideSpinner(): Promise<void>;
     /**
      * renew the user session
      */
     keepSessionAlive(): Promise<void>;
     /**
-     * show wait spinner
-     * @param message message to display
+     * log a message to host application's logs
+     * @param message message to log
+     * @param logLevel level of the log message
      */
-    showSpinner(message: string): Promise<void>;
+    log(message: string, logLevel: LogLevel): Promise<void>;
     /**
-     * hide wait spinner
+     * navigate to a location in the application
+     * @param options navigation options
      */
-    hideSpinner(): Promise<void>;
+    navigate(options: NavigationOptions): Promise<void>;
     /**
-     * get policy details for the current user
-     * @returns policy details as key value pairs
+     * open a page or document
+     * @param options target and type of the document to open
      */
-    getPoliciesDetails(): Promise<Record<string, string>>;
+    open(options: OpenOptions): Promise<void>;
     /**
-     * @deprecated use getUserAccessRights instead
-     * get persona Access information for the current user
-     * @returns persona access information as key value pairs
+     * open a modal
+     * @param options modal properties
      */
-    getPersonaAccess(): Promise<Record<string, string>>;
+    openModal(options: OpenModalOptions): Promise<void>;
     /**
-     * Get access rights for the current user
-     * @returns user access rights (effective rights)
-     * @throws {Error} if operation fails
+     * Perform an action
+     * @param action action name
+     * @param options additional options
      */
-    getUserAccessRights(): Promise<UserAccessRights>;
+    performAction(action: string, options: Record<string, string>): Promise<void>;
     /**
      * Prints given document
      * @param options Print options
@@ -346,16 +385,20 @@ export interface IApplication extends IScriptingObject {
      */
     showError(message: string): Promise<void>;
     /**
-     * log a message to host application's logs
-     * @param message message to log
-     * @param logLevel level of the log message
+     * show wait spinner
+     * @param message message to display
      */
-    log(message: string, logLevel: LogLevel): Promise<void>;
+    showSpinner(message: string): Promise<void>;
     /**
-     * get company settings for a particular category
-     * @param options {CompanySettingsQueryOptions} options to query company settings
-     * @returns company settings as key value pairs. Null if category is not found
+     * get supportability of an action
+     * @param name action name
+     * @returns true if the action is supported
+     */
+    supportsAction(name: string): Promise<boolean>;
+    /**
+     * get navigability to a particular page or screen
+     * @param name page or screen name
+     * @returns true if the page or screen is navigable
      */
-    getCompanySettings(options: CompanySettingsQueryOptions): Promise<Record<string, any> | null>;
+    supportsNavigateTo(name: string): Promise<boolean>;
 }
-export {};

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

@@ -1,9 +1,15 @@
 import { IScriptingObject } from '../scriptingObject.js';
+/**
+ * Personas information
+ */
 export type Personas = {
     entityId: string;
     entityType: string;
     entityName: string;
 };
+/**
+ * User information
+ */
 export type User = {
     /**
      * unique identifier for the user
@@ -84,6 +90,9 @@ export declare enum SCOPE {
      */
     Analyzer = "Analyzer"
 }
+/**
+ * Plugin information
+ */
 export type PluginInfo = {
     /**
      * unique identifier for the plugin
@@ -98,6 +107,9 @@ export type PluginInfo = {
      */
     scope: SCOPE;
 };
+/**
+ * Token information
+ */
 export type TokenInfo = {
     /**
      * child access token

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

@@ -1,10 +1,22 @@
-import { IEvent, Listener } from '../event.js';
+import { IEvent } from '../event.js';
 import { IScriptingObject } from '../scriptingObject.js';
+/**
+ * metadata about the form descriptor
+ */
 export type FormDescriptor = {
+    /**
+     * unique id of the form
+     */
     id: string;
+    /**
+     * name of the form
+     */
     name: string;
 };
-type FormInfo = {
+/**
+ * metadata about the form
+ */
+export type FormInfo = {
     /**
      * unique id of the form
      */
@@ -12,47 +24,76 @@ type FormInfo = {
 };
 /**
  * event handler for form load event
+ * @param params event parameters
+ * @param params.obj form object reference
+ * @param params.eventName event name
+ * @param params.eventParams form info
+ * @param params.eventOptions additional options related to the event
  */
-export type FormLoadListener = Listener<IForm, FormInfo, Record<string, unknown>, void>;
+export type FormLoadListener = (params: {
+    obj: IForm;
+    eventName: string;
+    eventParams: FormInfo;
+    eventOptions?: Record<string, unknown>;
+}) => void;
 /**
  * event handler for form unload event
+ * @param params event parameters
+ * @param params.obj form object reference
+ * @param params.eventName event name
+ * @param params.eventParams form info
+ * @param params.eventOptions additional options related to the event
  */
-export type FormUnloadListener = Listener<IForm, FormInfo, Record<string, unknown>, void>;
+export type FormUnloadListener = (params: {
+    obj: IForm;
+    eventName: string;
+    eventParams: FormInfo;
+    eventOptions?: Record<string, unknown>;
+}) => void;
 /**
  * events that notifies the form's lifecycle
  */
 export type FormEvents = {
     /**
      * form is loaded and ready for user interaction
+     *
+     * Use {@link FormLoadListener} to handle this event
      */
     'form.load': FormLoadListener;
     /**
      * form is unloaded and no longer available for user interaction
+     *
+     * Use {@link FormUnloadListener} to handle this event
      */
     'form.unload': FormUnloadListener;
 };
 /**
  * Methods to get information about the custom form
+ *
+ * See {@link FormEvents} for supported events
  */
 export interface IForm extends IScriptingObject {
     /**
      * event fired when the form is loaded
+     *
+     * Use {@link FormLoadListener} to handle this event
      */
     readonly Load: IEvent;
     /**
      * event fired when the form is unloaded
+     *
+     * Use {@link FormUnloadListener} to handle this event
      */
     readonly Unload: IEvent;
-    /**
-     * get metadata of the form
-     * @returns form metadata
-     */
-    getDescriptor(): Promise<FormDescriptor>;
     /**
      * get reference to the form's input control
      * @param id form id
      * @returns form input control object
      */
     getControl(id: string): Promise<unknown>;
+    /**
+     * get metadata of the form
+     * @returns form metadata
+     */
+    getDescriptor(): Promise<FormDescriptor>;
 }
-export {};

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

@@ -1,6 +1,9 @@
-import { IEvent, Listener } from '../event.js';
+import { IEvent } from '../event.js';
 import { IScriptingObject } from '../scriptingObject.js';
-type StateInfo = {
+/**
+ * state information
+ */
+export type StateInfo = {
     /**
      * name of the key for which the value changed
      */
@@ -8,14 +11,26 @@ type StateInfo = {
 };
 /**
  * event handler for global state change event
+ * @param params event parameters
+ * @param params.obj global object reference
+ * @param params.eventName event name
+ * @param params.eventParams state info
+ * @param params.eventOptions additional options related to the event
  */
-export type GlobalChangeListener = Listener<IGlobal, StateInfo, Record<string, unknown>, void>;
+export type GlobalChangeListener = (params: {
+    obj: IGlobal;
+    eventName: string;
+    eventParams: StateInfo;
+    eventOptions?: Record<string, unknown>;
+}) => void;
 /**
  * events fired from Global scripting object
  */
 export type GlobalEvents = {
     /**
      * event fired when a value changes in the global store
+     *
+     * Use {@link GlobalChangeListener} to handle this event
      */
     'global.change': GlobalChangeListener;
 };
@@ -26,7 +41,7 @@ export type GlobalEvents = {
  *
  * The implementation of this object should write the global state data to the host application's sessionStore,
  * but should ensure that the state is isolated away from the host application's state variables. This should be done by creating
- * naming conventions for the global keyspaces, e.g. ssf.global.<key>.
+ * naming conventions for the global keyspaces, e.g. ssf.global.[key].
  *
  * In order to ensure that guest applications cannot consume significant amounts of sessionStorage, restrictions should be placed on
  * the number and size of the stored session state. In particular, we can start with these values:
@@ -34,23 +49,26 @@ export type GlobalEvents = {
  * Total global state should be limited to 50 values
  * This will ensure that no guest can consume more than 250 KB of sessionStorage
  *
+ * See {@link GlobalEvents} for supported events
  */
 export interface IGlobal extends IScriptingObject {
     /**
      * event fired when the global state changes
+     *
+     * Use {@link GlobalChangeListener} to handle this event
      */
     readonly Change: IEvent;
     /**
-     * set a value in the global store
+     * get a value from the global store
      * @param key unique key to identify the value
-     * @param value value to be stored
+     * @returns value stored in the global store
      */
-    set(key: string, value: unknown): Promise<void>;
+    get(key: string): Promise<string>;
     /**
-     * get a value from the global store
+     * set a value in the global store
      * @param key unique key to identify the value
-     * @returns value stored in the global store
+     * @param value value to be stored
+     * @param overwrite if true, overwrite the value if it already exists. Default is false
      */
-    get(key: string): Promise<unknown>;
+    set(key: string, value: unknown, overwrite?: boolean): Promise<void>;
 }
-export {};

package/dist/types/lib/objects/http.d.ts

@@ -6,21 +6,21 @@ import { IScriptingObject } from '../scriptingObject.js';
  */
 export interface IHttp extends IScriptingObject {
     /**
-     * get http request
+     * delete http request
      * @param url url to make the call to
      * @param headersOrAccessToken http headers object or access token to be used for the call
      * @returns http response object
      * @throws error if the http call fails with non 2xx status code
      */
-    get(url: string, headersOrAccessToken?: string | Record<string, string>): Promise<Response>;
+    delete(url: string, headersOrAccessToken?: string | Record<string, string>): Promise<Response>;
     /**
-     * post http request
+     * get http request
      * @param url url to make the call to
      * @param headersOrAccessToken http headers object or access token to be used for the call
      * @returns http response object
      * @throws error if the http call fails with non 2xx status code
      */
-    post(url: string, headersOrAccessToken?: string | Record<string, string>, content?: string | Record<string, string>): Promise<Response>;
+    get(url: string, headersOrAccessToken?: string | Record<string, string>): Promise<Response>;
     /**
      * patch http request
      * @param url url to make the call to
@@ -30,19 +30,19 @@ export interface IHttp extends IScriptingObject {
      */
     patch(url: string, headersOrAccessToken?: string | Record<string, string>, content?: string | Record<string, string>): Promise<Response>;
     /**
-     * put http request
+     * post http request
      * @param url url to make the call to
      * @param headersOrAccessToken http headers object or access token to be used for the call
      * @returns http response object
      * @throws error if the http call fails with non 2xx status code
      */
-    put(url: string, headersOrAccessToken?: string | Record<string, string>, content?: string | Record<string, string>): Promise<Response>;
+    post(url: string, headersOrAccessToken?: string | Record<string, string>, content?: string | Record<string, string>): Promise<Response>;
     /**
-     * delete http request
+     * put http request
      * @param url url to make the call to
      * @param headersOrAccessToken http headers object or access token to be used for the call
      * @returns http response object
      * @throws error if the http call fails with non 2xx status code
      */
-    delete(url: string, headersOrAccessToken?: string | Record<string, string>): Promise<Response>;
+    put(url: string, headersOrAccessToken?: string | Record<string, string>, content?: string | Record<string, string>): Promise<Response>;
 }