@elliemae/pui-scripting-object 1.25.0 → 1.27.0

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

@@ -1,5 +1,6 @@
 import { IEvent, Listener } from '../event.js';
 import { IScriptingObject } from '../scriptingObject.js';
+import { UserAccessRights } from './userAccessRights.js';
 /**
  * Log levels
  */
@@ -222,10 +223,17 @@ export interface IApplication extends IScriptingObject {
      */
     getPoliciesDetails(): Promise<Record<string, string>>;
     /**
+     * @deprecated use getUserAccessRights instead
      * get persona Access information for the current user
      * @returns persona access information as key value pairs
      */
     getPersonaAccess(): Promise<Record<string, string>>;
+    /**
+     * Get access rights for the current user
+     * @returns user access rights (effective rights)
+     * @throws {Error} if operation fails
+     */
+    getUserAccessRights(): Promise<UserAccessRights>;
     /**
      * Prints given document
      * @param options Print options

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

@@ -1,5 +1,4 @@
 import { IScriptingObject } from '../scriptingObject.js';
-import { UserAccessRights } from './userAccessRights.js';
 export type Personas = {
     entityId: string;
     entityType: string;
@@ -115,10 +114,4 @@ export interface IAuth extends IScriptingObject {
      * @returns user information
      */
     getUser(): Promise<User>;
-    /**
-     * Get access rights for the current user
-     * @returns user access rights
-     * @throws {Error} if operation fails
-     */
-    getUserAccessRights(): Promise<UserAccessRights>;
 }

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

@@ -31,15 +31,50 @@ export type ServiceSetup = {
     category: ServiceSetupCategory;
 };
 /**
- * options to launch service order integration
+ * options to launch service order integration by category
  */
-export type LaunchOptions = {
+export type LaunchCategoryOptions = {
     /**
      * 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 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;
+};
+/**
+ * options to launch service order integration by specific service setup
+ */
+export type LaunchServiceSetupOptions = {
+    /**
+     * 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
      */
@@ -93,22 +128,29 @@ export interface IService extends IScriptingObject {
      */
     getEligibleServices: (category: ServiceSetupCategory, providerId?: string) => Promise<Array<ServiceSetup>>;
     /**
-     * select a service setup from the list of eligible service setups
-     * @param {ServiceSetupCategory} category - service setup category
-     * @param providerId - unique id of the service setup provider
-     * @returns {ServiceSetup} service setup chosen by the user. Null if no service setup is chosen
+     * launch a service intergration for a specific category 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 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 |  ✖️ |  ✖️ |  ✖️ |  ✖️ |
      */
-    selectServiceSetup: (category: ServiceSetupCategory, providerId?: string) => Promise<ServiceSetup>;
+    launchByCategory: (category: string, options: LaunchCategoryOptions) => Promise<void>;
     /**
-     * launch the default or specific service intergration 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
+     * 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 serviceSetupId - unique id of the service setup
-     * @param {LaunchOptions} options - options for launching the service order integration
-     * @throws Error if the service setup is not found or user is not authorized to open the integration
+     * @param {LaunchServiceSetupOptions} options - options for launching the service order integration
      * @returns None
      *
      * #### Product Compatibility:
@@ -116,5 +158,5 @@ export interface IService extends IScriptingObject {
      * :-----:|:-----: |:-----: |:-----: |:-----: |
      * | all |  ✖️ |  ✖️ |  ✖️ |  ✖️ |
      */
-    launch: (serviceSetupId: string, options: LaunchOptions) => Promise<void>;
+    launchByServiceSetup: (serviceSetupId: string, options: LaunchServiceSetupOptions) => Promise<void>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/pui-scripting-object",
-  "version": "1.25.0",
+  "version": "1.27.0",
   "description": "Typescript defintions for Scripting Objects",
   "sideEffects": false,
   "main": "./dist/cjs/index.js",
@@ -67,7 +67,7 @@
   },
   "devDependencies": {
     "@elliemae/browserslist-config-elliemae-latest-browsers": "~1.7.0",
-    "@elliemae/pui-cli": "~8.13.0",
+    "@elliemae/pui-cli": "~8.13.1",
     "@elliemae/pui-doc-gen": "~1.7.1",
     "@elliemae/pui-theme": "~2.7.0",
     "@types/styled-components": "~5.1.26",