@elliemae/pui-scripting-object 1.34.5 → 1.35.1

package/dist/cjs/objects/application.js

@@ -20,8 +20,7 @@ var application_exports = {};
 __export(application_exports, {
   ApplicationExtensionType: () => ApplicationExtensionType,
   LogLevel: () => LogLevel,
-  ModalSize: () => ModalSize,
-  NavigationType: () => NavigationType
+  ModalSize: () => ModalSize
 });
 module.exports = __toCommonJS(application_exports);
 var LogLevel = /* @__PURE__ */ ((LogLevel2) => {
@@ -39,15 +38,6 @@ var ApplicationExtensionType = /* @__PURE__ */ ((ApplicationExtensionType2) => {
   ApplicationExtensionType2["MENU"] = "MENU";
   return ApplicationExtensionType2;
 })(ApplicationExtensionType || {});
-var NavigationType = /* @__PURE__ */ ((NavigationType2) => {
-  NavigationType2["STANDARD_FORM"] = "STANDARD_FORM";
-  NavigationType2["STANDARD_TOOL"] = "STANDARD_TOOL";
-  NavigationType2["CUSTOM_FORM"] = "CUSTOM_FORM";
-  NavigationType2["CUSTOM_TOOL"] = "CUSTOM_TOOL";
-  NavigationType2["GLOBAL_CUSTOM_TOOL"] = "GLOBAL_CUSTOM_TOOL";
-  NavigationType2["OTHER"] = "OTHER";
-  return NavigationType2;
-})(NavigationType || {});
 var ModalSize = /* @__PURE__ */ ((ModalSize2) => {
   ModalSize2["SMALL"] = "sm";
   ModalSize2["MEDIUM"] = "md";

package/dist/cjs/objects/shared.js

@@ -18,6 +18,7 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var shared_exports = {};
 __export(shared_exports, {
+  NavigationType: () => NavigationType,
   OriginContext: () => OriginContext
 });
 module.exports = __toCommonJS(shared_exports);
@@ -26,3 +27,12 @@ var OriginContext = /* @__PURE__ */ ((OriginContext2) => {
   OriginContext2["CONSUMER"] = "consumer";
   return OriginContext2;
 })(OriginContext || {});
+var NavigationType = /* @__PURE__ */ ((NavigationType2) => {
+  NavigationType2["STANDARD_FORM"] = "STANDARD_FORM";
+  NavigationType2["STANDARD_TOOL"] = "STANDARD_TOOL";
+  NavigationType2["CUSTOM_FORM"] = "CUSTOM_FORM";
+  NavigationType2["CUSTOM_TOOL"] = "CUSTOM_TOOL";
+  NavigationType2["GLOBAL_CUSTOM_TOOL"] = "GLOBAL_CUSTOM_TOOL";
+  NavigationType2["OTHER"] = "OTHER";
+  return NavigationType2;
+})(NavigationType || {});

package/dist/esm/objects/application.js

@@ -13,15 +13,6 @@ var ApplicationExtensionType = /* @__PURE__ */ ((ApplicationExtensionType2) => {
   ApplicationExtensionType2["MENU"] = "MENU";
   return ApplicationExtensionType2;
 })(ApplicationExtensionType || {});
-var NavigationType = /* @__PURE__ */ ((NavigationType2) => {
-  NavigationType2["STANDARD_FORM"] = "STANDARD_FORM";
-  NavigationType2["STANDARD_TOOL"] = "STANDARD_TOOL";
-  NavigationType2["CUSTOM_FORM"] = "CUSTOM_FORM";
-  NavigationType2["CUSTOM_TOOL"] = "CUSTOM_TOOL";
-  NavigationType2["GLOBAL_CUSTOM_TOOL"] = "GLOBAL_CUSTOM_TOOL";
-  NavigationType2["OTHER"] = "OTHER";
-  return NavigationType2;
-})(NavigationType || {});
 var ModalSize = /* @__PURE__ */ ((ModalSize2) => {
   ModalSize2["SMALL"] = "sm";
   ModalSize2["MEDIUM"] = "md";
@@ -31,6 +22,5 @@ var ModalSize = /* @__PURE__ */ ((ModalSize2) => {
 export {
   ApplicationExtensionType,
   LogLevel,
-  ModalSize,
-  NavigationType
+  ModalSize
 };

package/dist/esm/objects/shared.js

@@ -3,6 +3,16 @@ var OriginContext = /* @__PURE__ */ ((OriginContext2) => {
   OriginContext2["CONSUMER"] = "consumer";
   return OriginContext2;
 })(OriginContext || {});
+var NavigationType = /* @__PURE__ */ ((NavigationType2) => {
+  NavigationType2["STANDARD_FORM"] = "STANDARD_FORM";
+  NavigationType2["STANDARD_TOOL"] = "STANDARD_TOOL";
+  NavigationType2["CUSTOM_FORM"] = "CUSTOM_FORM";
+  NavigationType2["CUSTOM_TOOL"] = "CUSTOM_TOOL";
+  NavigationType2["GLOBAL_CUSTOM_TOOL"] = "GLOBAL_CUSTOM_TOOL";
+  NavigationType2["OTHER"] = "OTHER";
+  return NavigationType2;
+})(NavigationType || {});
 export {
+  NavigationType,
   OriginContext
 };

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

@@ -1,6 +1,7 @@
 import { IEvent, Listener } from '../event.js';
 import { IScriptingObject } from '../scriptingObject.js';
 import { UserAccessRights } from './userAccessRights.js';
+import { NavigationType } from './shared.js';
 /**
  * Log levels
  */
@@ -67,27 +68,18 @@ export type CompanySettingsQueryOptions = {
      */
     attribute?: string;
 };
-/**
- * Types of navigations
- */
-export declare enum NavigationType {
-    STANDARD_FORM = "STANDARD_FORM",
-    STANDARD_TOOL = "STANDARD_TOOL",
-    CUSTOM_FORM = "CUSTOM_FORM",
-    CUSTOM_TOOL = "CUSTOM_TOOL",
-    GLOBAL_CUSTOM_TOOL = "GLOBAL_CUSTOM_TOOL",
-    OTHER = "OTHER"
-}
 /**
  * navigation options
  */
 export type NavigationOptions = {
     /**
-     * target url
+     * name of the location to navigate to
+     * @example Services, Secondary Registration etc.,
      */
     target: string;
     /**
-     * type of the navigation
+     * type of the location to navigate to
+     * @example NavigationType.STANDARD_FORM
      */
     type: NavigationType;
     /**
@@ -262,8 +254,8 @@ export interface IApplication extends IScriptingObject {
      */
     extend(extensionObj: ApplicationExtension): Promise<void>;
     /**
-     * navigate to a new application route / url
-     * @param options target url and type of navigation
+     * navigate to a location in the application
+     * @param options navigation options
      */
     navigate(options: NavigationOptions): Promise<void>;
     performAction(action: string, options: Record<string, string>): Promise<void>;

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

@@ -9,6 +9,9 @@ export type User = {
      * unique identifier for the user
      */
     id: string;
+    /**
+     * legacy tenant id
+     */
     realm: string;
     /**
      * user's first name
@@ -54,6 +57,10 @@ export type User = {
      * NMLS number
      */
     nmlsOriginatorId: string;
+    /**
+     * instance id
+     */
+    instanceId: string;
 };
 /**
  * token type

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

@@ -1,4 +1,5 @@
 import { IScriptingObject } from '../scriptingObject.js';
+import { NavigationType } from './shared.js';
 /**
  * type of service setup categories
  */
@@ -41,13 +42,20 @@ 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;
+     * location to redirect to after the service order integration flow is complete.
+     */
+    redirectParams: {
+        /**
+         * name of redirect location
+         * @example Services, Secondary Registration etc.,
+         */
+        targetName: string;
+        /**
+         * type of redirect location
+         * @example NavigationType.STANDARD_FORM
+         */
+        targetType: NavigationType;
+    };
     /**
      * unique id of the existing service order transaction
      */
@@ -76,13 +84,20 @@ export type LaunchServiceSetupOptions = {
      */
     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;
+     * location to redirect to after the service order integration flow is complete.
+     */
+    redirectParams: {
+        /**
+         * name of redirect location
+         * @example Services, Secondary Registration etc.,
+         */
+        targetName: string;
+        /**
+         * type of redirect location
+         * @example NavigationType.STANDARD_FORM
+         */
+        targetType: NavigationType;
+    };
     /**
      * unique id of the partner
      */
@@ -123,13 +138,20 @@ export type LaunchProviderOptions = {
      */
     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;
+     * location to redirect to after the service order integration flow is complete.
+     */
+    redirectParams: {
+        /**
+         * name of redirect location
+         * @example Services, Secondary Registration etc.,
+         */
+        targetName: string;
+        /**
+         * type of redirect location
+         * @example NavigationType.STANDARD_FORM
+         */
+        targetType: NavigationType;
+    };
     /**
      * unique id of the partner
      */
@@ -185,9 +207,9 @@ export interface IService extends IScriptingObject {
      *
      * 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.
+     * 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 redirect url incase of new order. For example, if redirectUrl is services, the final url will be services?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?transactionId=123&orderId=456
      *
      * Supports EPC & EVP service order integrations
      * @param category - name of the service category
@@ -207,9 +229,9 @@ export interface IService extends IScriptingObject {
      *
      * 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.
+     * 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 redirect url incase of new order. For example, if redirectUrl is services, the final url will be services?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?transactionId=123&orderId=456
      *
      * Supports EPC & EVP service order integrations
      * @param serviceSetupId - unique id of the service setup
@@ -229,9 +251,9 @@ export interface IService extends IScriptingObject {
      *
      * 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.
+     * 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 redirect url incase of new order. For example, if redirectUrl is services, the final url will be services?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?transactionId=123&orderId=456
      *
      * Supports EPC & EVP service order integrations
      * @param providerId - unique id of the service provider

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

@@ -131,3 +131,32 @@ export type ResourceOptions = {
      */
     name: string;
 };
+/**
+ * areas in the application where the user can navigate to
+ */
+export declare enum NavigationType {
+    /**
+     * standard form
+     */
+    STANDARD_FORM = "STANDARD_FORM",
+    /**
+     * standard tool
+     */
+    STANDARD_TOOL = "STANDARD_TOOL",
+    /**
+     * custom form
+     */
+    CUSTOM_FORM = "CUSTOM_FORM",
+    /**
+     * custom tool
+     */
+    CUSTOM_TOOL = "CUSTOM_TOOL",
+    /**
+     * global custom tool
+     */
+    GLOBAL_CUSTOM_TOOL = "GLOBAL_CUSTOM_TOOL",
+    /**
+     * other
+     */
+    OTHER = "OTHER"
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/pui-scripting-object",
-  "version": "1.34.5",
+  "version": "1.35.1",
   "description": "Typescript defintions for Scripting Objects",
   "sideEffects": false,
   "type": "module",
@@ -67,7 +67,7 @@
   },
   "devDependencies": {
     "@elliemae/browserslist-config-elliemae-latest-browsers": "~1.9.0",
-    "@elliemae/pui-cli": "~8.32.0",
+    "@elliemae/pui-cli": "~8.33.0",
     "@elliemae/pui-doc-gen": "~2.0.1",
     "@elliemae/pui-theme": "~2.9.3",
     "@types/styled-components": "~5.1.34",