@elliemae/pui-scripting-object 1.32.3 → 1.34.0

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

@@ -1,5 +1,30 @@
 import { IEvent, Listener } from '../event.js';
 import { IScriptingObject } from '../scriptingObject.js';
+/**
+ * error data to be displayed in the error dialog
+ */
+export interface ErrorData {
+    /**
+     * short description of the error
+     */
+    message: string;
+    /**
+     * error code, if any
+     */
+    code?: string;
+    /**
+     * detailed description of the error
+     */
+    details: string;
+    /**
+     * link to the help documentation
+     */
+    helpLink?: string;
+    /**
+     * unique id to identify the session / transaction, if any
+     */
+    correlationId?: string;
+}
 /**
  * event handler that handles module unload event
  * @param id unique id of the app that is being unloaded
@@ -42,4 +67,12 @@ export interface IModule extends IScriptingObject {
      * unload the microapp module from the host application
      */
     unload(): Promise<void>;
+    /**
+     * open a dialog in hosting application to display an error message and related help link
+     *
+     * Note: once the dialog is closed, caller need to set the focus back to the link or button that opened the dialog to ensure keyboard navigation works as expected
+     * @param error {ErrorData} error message to be displayed
+     * @returns {Promise<void>} a promise that resolves when the dialog is closed
+     */
+    showError(data: ErrorData): Promise<void>;
 }

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

@@ -104,6 +104,45 @@ export type LaunchServiceSetupOptions = {
      */
     additionalData?: any;
 };
+/**
+ * options to launch service order integration by specific service provider
+ */
+export type LaunchProviderOptions = {
+    /**
+     * source application context that is launching the service order integration
+     * urn patterned string
+     * example: urn:elli:services:getpricing
+     */
+    source: string;
+    /**
+     * url to redirect to after the service order integration flow is complete
+     */
+    redirectUrl: string;
+    /**
+     * unique id of the partner
+     */
+    partnerId: string;
+    /**
+     * name of the product
+     */
+    productName: string;
+    /**
+     * unique id of the existing service order transaction
+     */
+    transactionId?: string;
+    /**
+     * unique id of the existing service order
+     */
+    serviceOrderId?: string;
+    /**
+     * settings to be passed to the service order integration
+     */
+    settings?: any;
+    /**
+     * additional data needed for the service order integration
+     */
+    additionalData?: any;
+};
 /**
  * Scripting object to work with service orders, such as launching a service order integration etc.,
  * Enables applications to place service orders, independent of SLP (Service Landing Page) application
@@ -159,4 +198,20 @@ export interface IService extends IScriptingObject {
      * | all |  ✖️ |  ✖️ |  ✖️ |  ✖️ |
      */
     launchByServiceSetup: (serviceSetupId: string, options: LaunchServiceSetupOptions) => Promise<void>;
+    /**
+     * launch a service intergration for a specific provider to place a new service order or view existing order
+     * This method will unload the current microapp and navigate to the service order integration
+     * after the integration flow is complete, user will be redirected back to the url provided in the options.
+     * redirect url will be appended with query parameters containing the service order transaction id and service order id incase of new order
+     * Supports EPC & EVP service order integrations
+     * @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 |  ✖️ |  ✖️ |  ✖️ |  ✖️ |
+     */
+    launchByProvider: (providerId: string, options: LaunchProviderOptions) => Promise<void>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/pui-scripting-object",
-  "version": "1.32.3",
+  "version": "1.34.0",
   "description": "Typescript defintions for Scripting Objects",
   "sideEffects": false,
   "type": "module",
@@ -67,10 +67,10 @@
     "sonar56x": true
   },
   "devDependencies": {
-    "@elliemae/browserslist-config-elliemae-latest-browsers": "~1.8.0",
+    "@elliemae/browserslist-config-elliemae-latest-browsers": "~1.9.0",
     "@elliemae/pui-cli": "~8.30.0",
     "@elliemae/pui-doc-gen": "~2.0.1",
-    "@elliemae/pui-theme": "~2.7.0",
+    "@elliemae/pui-theme": "~2.9.3",
     "@types/styled-components": "~5.1.34",
     "history": "~5.3.0",
     "redux": "~4.2.1",