@elliemae/pui-scripting-object 1.33.0 → 1.34.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -42,6 +42,8 @@ export type LaunchCategoryOptions = {
42
42
  source: string;
43
43
  /**
44
44
  * url to redirect to after the service order integration flow is complete
45
+ * url should be relative to the current loan context.
46
+ * 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
45
47
  */
46
48
  redirectUrl: string;
47
49
  /**
@@ -104,6 +106,45 @@ export type LaunchServiceSetupOptions = {
104
106
  */
105
107
  additionalData?: any;
106
108
  };
109
+ /**
110
+ * options to launch service order integration by specific service provider
111
+ */
112
+ export type LaunchProviderOptions = {
113
+ /**
114
+ * source application context that is launching the service order integration
115
+ * urn patterned string
116
+ * example: urn:elli:services:getpricing
117
+ */
118
+ source: string;
119
+ /**
120
+ * url to redirect to after the service order integration flow is complete
121
+ */
122
+ redirectUrl: string;
123
+ /**
124
+ * unique id of the partner
125
+ */
126
+ partnerId: string;
127
+ /**
128
+ * name of the product
129
+ */
130
+ productName: string;
131
+ /**
132
+ * unique id of the existing service order transaction
133
+ */
134
+ transactionId?: string;
135
+ /**
136
+ * unique id of the existing service order
137
+ */
138
+ serviceOrderId?: string;
139
+ /**
140
+ * settings to be passed to the service order integration
141
+ */
142
+ settings?: any;
143
+ /**
144
+ * additional data needed for the service order integration
145
+ */
146
+ additionalData?: any;
147
+ };
107
148
  /**
108
149
  * Scripting object to work with service orders, such as launching a service order integration etc.,
109
150
  * Enables applications to place service orders, independent of SLP (Service Landing Page) application
@@ -159,4 +200,20 @@ export interface IService extends IScriptingObject {
159
200
  * | all | ✖️ | ✖️ | ✖️ | ✖️ |
160
201
  */
161
202
  launchByServiceSetup: (serviceSetupId: string, options: LaunchServiceSetupOptions) => Promise<void>;
203
+ /**
204
+ * launch a service intergration for a specific provider to place a new service order or view existing order
205
+ * This method will unload the current microapp and navigate to the service order integration
206
+ * after the integration flow is complete, user will be redirected back to the url provided in the options.
207
+ * redirect url will be appended with query parameters containing the service order transaction id and service order id incase of new order
208
+ * Supports EPC & EVP service order integrations
209
+ * @param providerId - unique id of the service provider
210
+ * @param {LaunchProviderOptions} options - options for launching the service order integration
211
+ * @returns None
212
+ *
213
+ * #### Product Compatibility:
214
+ * | | Encompass | Encompass Web | TPO | Consumer Connect |
215
+ * :-----:|:-----: |:-----: |:-----: |:-----: |
216
+ * | all | ✖️ | ✖️ | ✖️ | ✖️ |
217
+ */
218
+ launchByProvider: (providerId: string, options: LaunchProviderOptions) => Promise<void>;
162
219
  }
package/package.json CHANGED
@@ -1,8 +1,9 @@
1
1
  {
2
2
  "name": "@elliemae/pui-scripting-object",
3
- "version": "1.33.0",
3
+ "version": "1.34.1",
4
4
  "description": "Typescript defintions for Scripting Objects",
5
5
  "sideEffects": false,
6
+ "type": "module",
6
7
  "main": "./dist/cjs/index.js",
7
8
  "module": "./dist/es/index.js",
8
9
  "unpkg": "./dist/umd/index.js",
@@ -66,16 +67,15 @@
66
67
  "sonar56x": true
67
68
  },
68
69
  "devDependencies": {
69
- "@elliemae/browserslist-config-elliemae-latest-browsers": "~1.8.0",
70
- "@elliemae/pui-cli": "~8.30.0",
70
+ "@elliemae/browserslist-config-elliemae-latest-browsers": "~1.9.0",
71
+ "@elliemae/pui-cli": "~8.32.0",
71
72
  "@elliemae/pui-doc-gen": "~2.0.1",
72
- "@elliemae/pui-theme": "~2.7.0",
73
+ "@elliemae/pui-theme": "~2.9.3",
73
74
  "@types/styled-components": "~5.1.34",
74
75
  "history": "~5.3.0",
75
76
  "redux": "~4.2.1",
76
77
  "redux-saga": "~1.3.0",
77
78
  "styled-components": "~5.3.11"
78
79
  },
79
- "peerDependencies": {},
80
- "type": "module"
80
+ "peerDependencies": {}
81
81
  }