@elliemae/pui-scripting-object 1.40.3 → 1.41.0

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

@@ -56,7 +56,7 @@ export type LaunchCategoryOptions = {
          */
         targetType: NavigationType;
         /**
-         * additional query parameters to be passed to the redirect location. For example, if rediret requested to services area with targetParams { "key1": "value1", "key2": "value2"}, the url will have querystring as services?query={"transactionId":123, "orderId":456, "key1": "value1", "key2": "value2"}
+         * additional query parameters to be passed to the redirect location. For example, if rediret requested to services area with targetParams \\{ 'key1': 'value1', 'key2': 'value2'\\}, the url will have querystring as services?query=\\{'transactionId':123, 'orderId':456, 'key1': 'value1', 'key2': 'value2'\\}
          */
         targetParams?: Record<string, string>;
     };
@@ -106,7 +106,7 @@ export type LaunchServiceSetupOptions = {
          */
         targetType: NavigationType;
         /**
-         * additional query parameters to be passed to the redirect location. For example, if rediret requested to services area with targetParams { "key1": "value1", "key2": "value2"}, the url will have querystring as services?query={"transactionId":123, "orderId":456, "key1": "value1", "key2": "value2"}
+         * additional query parameters to be passed to the redirect location. For example, if rediret requested to services area with targetParams \\{ 'key1': 'value1', 'key2': 'value2'\\}, the url will have querystring as services?query=\\{'transactionId':123, 'orderId':456, 'key1': 'value1', 'key2': 'value2'\\}
          */
         targetParams?: Record<string, string>;
     };
@@ -152,7 +152,7 @@ export type LaunchProviderOptions = {
          */
         targetType: NavigationType;
         /**
-         * additional query parameters to be passed to the redirect location. For example, if rediret requested to services area with targetParams { "key1": "value1", "key2": "value2"}, the url will have querystring as services?query={"transactionId":123, "orderId":456, "key1": "value1", "key2": "value2"}
+         * additional query parameters to be passed to the redirect location. For example, if rediret requested to services area with targetParams \\{ 'key1': 'value1', 'key2': 'value2'\\}, the url will have querystring as services?query=\\{'transactionId':123, 'orderId':456, 'key1': 'value1', 'key2': 'value2'\\}
          */
         targetParams?: Record<string, string>;
     };
@@ -178,10 +178,6 @@ export type LaunchProviderOptions = {
  * Enables applications to place service orders, independent of SLP (Service Landing Page) application
  * Errors thrown by the service order integration will be returned to the caller of this Scripting Object method
  *
- * #### Product Compatibility:
- * | | Encompass | Encompass Web | TPO | Consumer Connect |
- * :-----:|:-----: |:-----: |:-----: |:-----: |
- * | all |  ✖️ |  ✔ |  ✖️ |  ✖️ |
  */
 export interface IService extends IScriptingObject {
     /**
@@ -189,11 +185,6 @@ export interface IService extends IScriptingObject {
      * @param {ServiceSetupCategory} category - service setup category
      * @param providerId - unique id of the service setup provider
      * @returns {Array<ServiceSetup>} list of service setups matching the input criteria. Empty list if no service setups are found
-     *
-     * #### Product Compatibility:
-     * | | Encompass | Encompass Web | TPO | Consumer Connect |
-     * :-----:|:-----: |:-----: |:-----: |:-----: |
-     * | all |  ✖️ |  ✔ |  ✖️ |  ✖️ |
      */
     getEligibleServices: (category: ServiceSetupCategory, providerId?: string) => Promise<Array<ServiceSetup>>;
     /**
@@ -205,61 +196,46 @@ export interface IService extends IScriptingObject {
      *
      * After the integration flow is complete, user will be redirected to the location provided in the input parameter.
      *
-     * Service order transaction id (transactionId) and service order id (orderId) will be appended as query parameters to the url incase of new order. For example, if rediret requested to services area, the url will have querystring as services?query={"transactionId":123, "orderId":456}
+     * Service order transaction id (transactionId) and service order id (orderId) will be appended as query parameters to the url incase of new order. For example, if rediret requested to services area, the url will have querystring as services?query=\\{'transactionId':123, 'orderId':456\\}
      *
      * Supports EPC & EVP service order integrations
      * @param category - name of the service category
      * @param {LaunchCategoryOptions} options - options for launching the service order integration
      * @returns None
-     *
-     * #### Product Compatibility:
-     * | | Encompass | Encompass Web | TPO | Consumer Connect |
-     * :-----:|:-----: |:-----: |:-----: |:-----: |
-     * | all |  ✖️ |  ✔ |  ✖️ |  ✖️ |
      */
     launchByCategory: (category: string, options: LaunchCategoryOptions) => Promise<void>;
     /**
-     * Launch a service intergration for a specific service setup to place a new service order or view existing order.
+     * Launch a service intergration for a specific provider to place a new service order or view existing order
      *
      * Commit all unsaved loan changes using loan.commit, before calling this method.
      *
-     * This method will unload the current microapp and navigate to the service order integration.
+     * This method will unload the current microapp and navigate to the service order integration
      *
      * After the integration flow is complete, user will be redirected to the location provided in the input parameter.
      *
-     * Service order transaction id (transactionId) and service order id (orderId) will be appended as query parameters to the url incase of new order. For example, if rediret requested to services area, the url will have querystring as services?query={"transactionId":123, "orderId":456}
+     * Service order transaction id (transactionId) and service order id (orderId) will be appended as query parameters to the url incase of new order. For example, if rediret requested to services area, the url will have querystring as services?query=\\{'transactionId':123, 'orderId':456\\}
      *
      * Supports EPC & EVP service order integrations
-     * @param serviceSetupId - unique id of the service setup
-     * @param {LaunchServiceSetupOptions} options - options for launching the service order integration
+     * @param providerId - unique id of the service provider
+     * @param {LaunchProviderOptions} options - options for launching the service order integration
      * @returns None
-     *
-     * #### Product Compatibility:
-     * | | Encompass | Encompass Web | TPO | Consumer Connect |
-     * :-----:|:-----: |:-----: |:-----: |:-----: |
-     * | all |  ✖️ |  ✔ |  ✖️ |  ✖️ |
      */
-    launchByServiceSetup: (serviceSetupId: string, options: LaunchServiceSetupOptions) => Promise<void>;
+    launchByProvider: (providerId: string, options: LaunchProviderOptions) => Promise<void>;
     /**
-     * Launch a service intergration for a specific provider to place a new service order or view existing order
+     * Launch a service intergration for a specific service setup to place a new service order or view existing order.
      *
      * Commit all unsaved loan changes using loan.commit, before calling this method.
      *
-     * This method will unload the current microapp and navigate to the service order integration
+     * This method will unload the current microapp and navigate to the service order integration.
      *
      * After the integration flow is complete, user will be redirected to the location provided in the input parameter.
      *
-     * Service order transaction id (transactionId) and service order id (orderId) will be appended as query parameters to the url incase of new order. For example, if rediret requested to services area, the url will have querystring as services?query={"transactionId":123, "orderId":456}
+     * Service order transaction id (transactionId) and service order id (orderId) will be appended as query parameters to the url incase of new order. For example, if rediret requested to services area, the url will have querystring as services?query=\\{'transactionId':123, 'orderId':456\\}
      *
      * Supports EPC & EVP service order integrations
-     * @param providerId - unique id of the service provider
-     * @param {LaunchProviderOptions} options - options for launching the service order integration
+     * @param serviceSetupId - unique id of the service setup
+     * @param {LaunchServiceSetupOptions} options - options for launching the service order integration
      * @returns None
-     *
-     * #### Product Compatibility:
-     * | | Encompass | Encompass Web | TPO | Consumer Connect |
-     * :-----:|:-----: |:-----: |:-----: |:-----: |
-     * | all |  ✖️ |  ✖️ |  ✖️ |  ✖️ |
      */
-    launchByProvider: (providerId: string, options: LaunchProviderOptions) => Promise<void>;
+    launchByServiceSetup: (serviceSetupId: string, options: LaunchServiceSetupOptions) => Promise<void>;
 }

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

@@ -3,15 +3,16 @@ import { IScriptingObject } from '../scriptingObject.js';
  * store and retrieves values in host application's session storage
  */
 export interface ISession extends IScriptingObject {
+    /**
+     * get a value from the session storage
+     * @param key unique key to retrieve the value
+     * @returns value stored in the session storage
+     */
+    get(key: string): Promise<string>;
     /**
      * set a value in the session storage
      * @param key unique key to store the value
      * @param value value to be stored
      */
     set(key: string, value: string): Promise<void>;
-    /**
-     * get a value from the session storage
-     * @param key unique key to retrieve the value
-     */
-    get(key: string): Promise<string>;
 }

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

@@ -19,20 +19,30 @@ export type TransactionInfo = {
  */
 export interface ITransaction extends IScriptingObject {
     /**
-     * Provide the necessary information for your application's user-interface to:
-     * Access transaction origination information and bootstrap its user interaction
-     * Know if it was launched in the context of an existing transaction, so it can present the relevant view
-     * @returns transaction origination information
+     * Navigate your users back to where they left off in the host Encompass application,
+     * after they have canceled an interaction with your application's user-interface without having
+     * initiated a transaction request (or any other related task) that they were working on.
+     * This signals a cancelation outcome to the host Encompass application -
+     * how this is handled by the host upon user navigation can vary across applications
      */
-    getOrigin(): Promise<OriginDetails>;
+    cancel(): Promise<void>;
     /**
-     * Refresh your application's transaction origination context - if your current one expires.
-     * This method returns a new originId and partnerAccessToken - which your application back-end can use to retrieve a refreshed transaction origin:
-     * A fresh snapshot of the loan data your application is entitled to receive in a transaction origin
-     * A a fresh snapshot of the user's credential set configured by their Administrator for use with your application
-     * @returns transaction origination information
+     * Navigate your users back to where they left off in the host Encompass application,
+     * after they are done interacting with your application's user-interface
      */
-    refreshOrigin(): Promise<OriginDetails>;
+    close(): Promise<void>;
+    /**
+     * initiate a new transaction with your integration
+     * @param options details of the transaction to be initiated
+     * @returns transaction id
+     */
+    create(options: TransactionDetails): Promise<TransactionInfo>;
+    /**
+     * Allow Lenders to initiate an event/message for the subject transaction with your integration
+     * @param options details of the event/message to be initiated
+     * @returns transaction event id
+     */
+    createEvent(options: TransactionEvent): Promise<TransactionInfo>;
     /**
      * Allow Lenders to use your integration to upload files from their
      * local drive as an attachment to a new transaction.
@@ -43,11 +53,52 @@ export interface ITransaction extends IScriptingObject {
      */
     createResource(options: ResourceOptions): Promise<ResourceDetails>;
     /**
-     * initiate a new transaction with your integration
-     * @param options details of the transaction to be initiated
-     * @returns transaction id
+     * Navigate your users back to where they left off in the host Encompass application,
+     * after their has been an error (application error or workflow error) on your integrations user-interface.
+     * This signals an error outcome to the host Encompass application -
+     * how this is handled by the host upon user navigation can vary across applications
      */
-    create(options: TransactionDetails): Promise<TransactionInfo>;
+    error(): Promise<void>;
+    /**
+     * Retrieve the transaction in whose context your integration is operating in, utilized by methods that operate on an existing transaction.
+     * The methods that currently fall into this category are:
+     * transaction.update
+     * transaction.createEvent
+     * Although integrations are free to set the transactional context they are operating in
+     * (using the transaction.set method) , which may be necessary when providing views that
+     * allow users to switch between and perform actions on multiple transactions,
+     * the host application implicitly alters the transactional context in certain scenarios:
+     *
+     * Implicit transaction context setting!
+     * If your integration is launched by a user in the context of an existing transaction,
+     * such as from the services page on Loan Officer Connect, the document icon on the services
+     * side-nav in Encompass Desktop or on a loan application in Consumer Connect is set to said transaction.
+     * Every time a new transaction is created during a user's interaction with your integration,
+     * the context is set to the last created transaction.
+     * If the integration was initially launched in the context of an existing transaction,
+     * the transaction.getOrigin method will always return the original transactionId the integration was launched
+     * in the context of, no matter how many times the transaction is set in the current interaction.
+     * You can leverage this to track the initial transaction context for a user interaction
+     *
+     * The current transactional context your integration operates in can be queried using the transaction.get method
+     * @returns transaction id details
+     */
+    get(): Promise<TransactionInfo>;
+    /**
+     * Provide the necessary information for your application's user-interface to:
+     * Access transaction origination information and bootstrap its user interaction
+     * Know if it was launched in the context of an existing transaction, so it can present the relevant view
+     * @returns transaction origination information
+     */
+    getOrigin(): Promise<OriginDetails>;
+    /**
+     * Refresh your application's transaction origination context - if your current one expires.
+     * This method returns a new originId and partnerAccessToken - which your application back-end can use to retrieve a refreshed transaction origin:
+     * A fresh snapshot of the loan data your application is entitled to receive in a transaction origin
+     * A a fresh snapshot of the user's credential set configured by their Administrator for use with your application
+     * @returns transaction origination information
+     */
+    refreshOrigin(): Promise<OriginDetails>;
     /**
      * Set the transaction in whose context you want to invoke methods that operate on an existing transaction.
      * The subject transaction must be one that was created for the current loan and EPC product.
@@ -77,31 +128,6 @@ export interface ITransaction extends IScriptingObject {
      * @returns transaction that has been set
      */
     set(options: TransactionInfo): Promise<TransactionInfo>;
-    /**
-     * Retrieve the transaction in whose context your integration is operating in, utilized by methods that operate on an existing transaction.
-     * The methods that currently fall into this category are:
-     * transaction.update
-     * transaction.createEvent
-     * Although integrations are free to set the transactional context they are operating in
-     * (using the transaction.set method) , which may be necessary when providing views that
-     * allow users to switch between and perform actions on multiple transactions,
-     * the host application implicitly alters the transactional context in certain scenarios:
-     *
-     * Implicit transaction context setting!
-     * If your integration is launched by a user in the context of an existing transaction,
-     * such as from the services page on Loan Officer Connect, the document icon on the services
-     * side-nav in Encompass Desktop or on a loan application in Consumer Connect is set to said transaction.
-     * Every time a new transaction is created during a user's interaction with your integration,
-     * the context is set to the last created transaction.
-     * If the integration was initially launched in the context of an existing transaction,
-     * the transaction.getOrigin method will always return the original transactionId the integration was launched
-     * in the context of, no matter how many times the transaction is set in the current interaction.
-     * You can leverage this to track the initial transaction context for a user interaction
-     *
-     * The current transactional context your integration operates in can be queried using the transaction.get method
-     * @returns transaction id details
-     */
-    get(): Promise<TransactionInfo>;
     /**
      * Allow Lenders to update an existing transaction by attaching new resources or updating
      * the request options associated with the transaction.
@@ -122,30 +148,4 @@ export interface ITransaction extends IScriptingObject {
      * @returns transaction id
      */
     update(options: TransactionDetails): Promise<TransactionInfo>;
-    /**
-     * Allow Lenders to initiate an event/message for the subject transaction with your integration
-     * @param options details of the event/message to be initiated
-     * @returns transaction event id
-     */
-    createEvent(options: TransactionEvent): Promise<TransactionInfo>;
-    /**
-     * Navigate your users back to where they left off in the host Encompass application,
-     * after they are done interacting with your application's user-interface
-     */
-    close(): Promise<void>;
-    /**
-     * Navigate your users back to where they left off in the host Encompass application,
-     * after they have canceled an interaction with your application's user-interface without having
-     * initiated a transaction request (or any other related task) that they were working on.
-     * This signals a cancelation outcome to the host Encompass application -
-     * how this is handled by the host upon user navigation can vary across applications
-     */
-    cancel(): Promise<void>;
-    /**
-     * Navigate your users back to where they left off in the host Encompass application,
-     * after their has been an error (application error or workflow error) on your integrations user-interface.
-     * This signals an error outcome to the host Encompass application -
-     * how this is handled by the host upon user navigation can vary across applications
-     */
-    error(): Promise<void>;
 }

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

@@ -45,6 +45,12 @@ export type TransactionTemplateDetails = {
  * which they can associate with a 1-click/automated ordering business condition set.
  */
 export interface ITransactionTemplate extends IScriptingObject {
+    /**
+     * Navigate the administrator users back to where they left off in the
+     * Loan Officer Connect services management application, after they are done interacting
+     * with your application's administrator-facing user-interface
+     */
+    close(): Promise<void>;
     /**
      * Discover if your administrator-facing view has been rendered in the context of an existing
      * transaction request template (in edit mode) or a new transaction request template (in create mode).
@@ -66,10 +72,4 @@ export interface ITransactionTemplate extends IScriptingObject {
      * @returns success
      */
     save(options: TransactionTemplateDetails): Promise<string>;
-    /**
-     * Navigate the administrator users back to where they left off in the
-     * Loan Officer Connect services management application, after they are done interacting
-     * with your application's administrator-facing user-interface
-     */
-    close(): Promise<void>;
 }

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

@@ -26,6 +26,13 @@ export declare enum CompleteReason {
  * create events/messages for a transaction, and more.
  */
 export interface ITransactionV2 extends IScriptingObject {
+    /**
+     * notify host on completion of user interaction with the transaction
+     * so that host can perform any necessary post user interaction processing / cleanup.
+     * @param id - unique identifier for the transaction
+     * @param reason reason for completing the transaction user interaction
+     */
+    completeUserInteraction(id: string, reason: CompleteReason): Promise<void>;
     /**
      * create new transaction
      * @param options details of the transaction to be created
@@ -41,6 +48,13 @@ export interface ITransactionV2 extends IScriptingObject {
      * @throws error when event creation fails, TransactionNotFound error for invalid transaction id
      */
     createEvent(id: string, options: TransactionEvent): Promise<string>;
+    /**
+     * Creates new origin and context.
+     * @param withLoanData - include loan data in the origin cache
+     * @returns service setup origination information
+     * @throws OriginNotFound error when origin is not found
+     */
+    createOrigin(withLoanData: boolean): Promise<OriginDetails>;
     /**
      * get necessary details to upload document for specific transaction
      * @param id - unique identifier for the transaction
@@ -56,13 +70,6 @@ export interface ITransactionV2 extends IScriptingObject {
      * @throws TransactionNotFound error for invalid transaction id
      */
     get(id: string): Promise<TransactionDetails>;
-    /**
-     * Creates new origin and context.
-     * @param withLoanData - include loan data in the origin cache
-     * @returns service setup origination information
-     * @throws OriginNotFound error when origin is not found
-     */
-    createOrigin(withLoanData: boolean): Promise<OriginDetails>;
     /**
      * update existing transaction.
      * @param id - unique identifier for the transaction
@@ -70,11 +77,4 @@ export interface ITransactionV2 extends IScriptingObject {
      * @throws error when transaction update fails, TransactionNotFound error for invalid transaction id
      */
     update(id: string, options: TransactionDetails): Promise<void>;
-    /**
-     * notify host on completion of user interaction with the transaction
-     * so that host can perform any necessary post user interaction processing / cleanup.
-     * @param id - unique identifier for the transaction
-     * @param reason reason for completing the transaction user interaction
-     */
-    completeUserInteraction(id: string, reason: CompleteReason): Promise<void>;
 }

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

@@ -1,5 +1,5 @@
 import { BreakPoint } from '@elliemae/pui-theme';
-import { IEvent, Listener } from '../event.js';
+import { IEvent } from '../event.js';
 import { IScriptingObject } from '../scriptingObject.js';
 /**
  * window viewport size
@@ -8,6 +8,9 @@ export type ViewportSize = {
     width: number;
     height: number;
 };
+/**
+ * window viewport size information
+ */
 type ViewportSizeInfo = {
     /**
      * details about the resize event
@@ -16,9 +19,22 @@ type ViewportSizeInfo = {
 };
 /**
  * parent window resize event handler
+ * @param params event parameters
+ * @param params.obj view object reference
+ * @param params.eventName event name
+ * @param params.eventParams view port info
+ * @param params.eventOptions additional options related to the event
+ */
+export type ViewResizeListener = (params: {
+    obj: IView;
+    eventName: string;
+    eventParams: ViewportSizeInfo;
+    eventOptions?: Record<string, unknown>;
+}) => void;
+/**
+ * window breakpoint information
  */
-export type ViewResizeListener = Listener<IView, ViewportSizeInfo, Record<string, unknown>, void>;
-type BreakpointInfo = {
+export type BreakpointInfo = {
     /**
      * current breakpoint of the parent window
      */
@@ -26,36 +42,61 @@ type BreakpointInfo = {
 };
 /**
  * parent window breakpoint change event handler
+ * @param params event parameters
+ * @param params.obj view object reference
+ * @param params.eventName event name
+ * @param params.eventParams window breakpoint info
+ * @param params.eventOptions additional options related to the event
+ */
+export type BreakpointChangeListener = (params: {
+    obj: IView;
+    eventName: string;
+    eventParams: BreakpointInfo;
+    eventOptions?: Record<string, unknown>;
+}) => void;
+/**
+ * events related to the window
  */
-export type BreakpointChangeListener = Listener<IView, BreakpointInfo, Record<string, unknown>, void>;
 export type ViewEvents = {
-    /**
-     * eent is fired when the parent window is resized
-     */
-    'view.resize': ViewResizeListener;
     /**
      * event is fired when the parent window's breakpoint changes
+     *
+     * Use {@link BreakpointChangeListener} to handle this event
      */
     'view.breakpointChange': BreakpointChangeListener;
+    /**
+     * eent is fired when the parent window is resized
+     *
+     * Use {@link ViewResizeListener} to handle this event
+     */
+    'view.resize': ViewResizeListener;
 };
 /**
- * Methods view, modify parent's window attributes
+ * APIs to interact with the window / viewport
+ *
+ * See {@link ViewEvents} for supported events
  */
 export interface IView extends IScriptingObject {
-    /**
-     * event fired when the window is resized
-     */
-    readonly Resize: IEvent;
     /**
      * event fired when the window breakpoint changes
+     *
+     * Use {@link BreakpointChangeListener} to handle this event
      */
     readonly BreakpointChange: IEvent;
+    /**
+     * event fired when the window is resized
+     *
+     * Use {@link ViewResizeListener} to handle this event
+     */
+    readonly Resize: IEvent;
     /**
      * Get the current breakpoint of the parent window
+     * @returns current breakpoint
      */
     getBreakpoint(): Promise<BreakPoint>;
     /**
      * Get the current viewport size of the parent window
+     * @returns viewport size
      */
     getViewPortSize(): Promise<ViewportSize>;
 }