@elliemae/pui-scripting-object 1.33.0 → 1.34.1

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

@@ -42,6 +42,8 @@ export type LaunchCategoryOptions = {
     source: string;
     /**
      * url to redirect to after the service order integration flow is complete
+     * url should be relative to the current loan context.
+     * For example to redirect to service landing page that has absolute url as https://encompass.ice.com/pipeline/loan/d4ef4c0a-5456-4e72-bf94-269eb2ccde18/services, the redirect url should be services
      */
     redirectUrl: string;
     /**
@@ -104,6 +106,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 +200,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,8 +1,9 @@
 {
   "name": "@elliemae/pui-scripting-object",
-  "version": "1.33.0",
+  "version": "1.34.1",
   "description": "Typescript defintions for Scripting Objects",
   "sideEffects": false,
+  "type": "module",
   "main": "./dist/cjs/index.js",
   "module": "./dist/es/index.js",
   "unpkg": "./dist/umd/index.js",
@@ -66,16 +67,15 @@
     "sonar56x": true
   },
   "devDependencies": {
-    "@elliemae/browserslist-config-elliemae-latest-browsers": "~1.8.0",
-    "@elliemae/pui-cli": "~8.30.0",
+    "@elliemae/browserslist-config-elliemae-latest-browsers": "~1.9.0",
+    "@elliemae/pui-cli": "~8.32.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",
     "redux-saga": "~1.3.0",
     "styled-components": "~5.3.11"
   },
-  "peerDependencies": {},
-  "type": "module"
+  "peerDependencies": {}
 }