@elliemae/pui-scripting-object 1.44.1 → 1.46.0

package/dist/cjs/objects/application.js

@@ -21,7 +21,8 @@ __export(application_exports, {
   ApplicationExtensionType: () => ApplicationExtensionType,
   LogLevel: () => LogLevel,
   ModalSize: () => ModalSize,
-  ModuleOpenMode: () => ModuleOpenMode
+  ModuleOpenMode: () => ModuleOpenMode,
+  OpenType: () => OpenType
 });
 module.exports = __toCommonJS(application_exports);
 var LogLevel = /* @__PURE__ */ ((LogLevel2) => {
@@ -39,14 +40,18 @@ var ApplicationExtensionType = /* @__PURE__ */ ((ApplicationExtensionType2) => {
   ApplicationExtensionType2["MENU"] = "MENU";
   return ApplicationExtensionType2;
 })(ApplicationExtensionType || {});
+var OpenType = /* @__PURE__ */ ((OpenType2) => {
+  OpenType2["MODULE"] = "MODULE";
+  return OpenType2;
+})(OpenType || {});
+var ModuleOpenMode = /* @__PURE__ */ ((ModuleOpenMode2) => {
+  ModuleOpenMode2["POPUP"] = "POPUP";
+  ModuleOpenMode2["INLINE"] = "INLINE";
+  return ModuleOpenMode2;
+})(ModuleOpenMode || {});
 var ModalSize = /* @__PURE__ */ ((ModalSize2) => {
   ModalSize2["SMALL"] = "sm";
   ModalSize2["MEDIUM"] = "md";
   ModalSize2["LARGE"] = "lg";
   return ModalSize2;
 })(ModalSize || {});
-var ModuleOpenMode = /* @__PURE__ */ ((ModuleOpenMode2) => {
-  ModuleOpenMode2["POPUP"] = "POPUP";
-  ModuleOpenMode2["INLINE"] = "INLINE";
-  return ModuleOpenMode2;
-})(ModuleOpenMode || {});

package/dist/cjs/objects/module.js

@@ -3,6 +3,10 @@ var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
 var __copyProps = (to, from, except, desc) => {
   if (from && typeof from === "object" || typeof from === "function") {
     for (let key of __getOwnPropNames(from))
@@ -13,4 +17,21 @@ var __copyProps = (to, from, except, desc) => {
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var module_exports = {};
+__export(module_exports, {
+  DialogSize: () => DialogSize,
+  DialogType: () => DialogType
+});
 module.exports = __toCommonJS(module_exports);
+var DialogType = /* @__PURE__ */ ((DialogType2) => {
+  DialogType2["WARNING"] = "warning";
+  DialogType2["ERROR"] = "error";
+  DialogType2["SUCCESS"] = "success";
+  DialogType2["INFO"] = "info";
+  return DialogType2;
+})(DialogType || {});
+var DialogSize = /* @__PURE__ */ ((DialogSize2) => {
+  DialogSize2["SMALL"] = "small";
+  DialogSize2["MEDIUM"] = "medium";
+  DialogSize2["LARGE"] = "large";
+  return DialogSize2;
+})(DialogSize || {});

package/dist/esm/objects/application.js

@@ -13,20 +13,25 @@ var ApplicationExtensionType = /* @__PURE__ */ ((ApplicationExtensionType2) => {
   ApplicationExtensionType2["MENU"] = "MENU";
   return ApplicationExtensionType2;
 })(ApplicationExtensionType || {});
+var OpenType = /* @__PURE__ */ ((OpenType2) => {
+  OpenType2["MODULE"] = "MODULE";
+  return OpenType2;
+})(OpenType || {});
+var ModuleOpenMode = /* @__PURE__ */ ((ModuleOpenMode2) => {
+  ModuleOpenMode2["POPUP"] = "POPUP";
+  ModuleOpenMode2["INLINE"] = "INLINE";
+  return ModuleOpenMode2;
+})(ModuleOpenMode || {});
 var ModalSize = /* @__PURE__ */ ((ModalSize2) => {
   ModalSize2["SMALL"] = "sm";
   ModalSize2["MEDIUM"] = "md";
   ModalSize2["LARGE"] = "lg";
   return ModalSize2;
 })(ModalSize || {});
-var ModuleOpenMode = /* @__PURE__ */ ((ModuleOpenMode2) => {
-  ModuleOpenMode2["POPUP"] = "POPUP";
-  ModuleOpenMode2["INLINE"] = "INLINE";
-  return ModuleOpenMode2;
-})(ModuleOpenMode || {});
 export {
   ApplicationExtensionType,
   LogLevel,
   ModalSize,
-  ModuleOpenMode
+  ModuleOpenMode,
+  OpenType
 };

package/dist/esm/objects/module.js

@@ -0,0 +1,17 @@
+var DialogType = /* @__PURE__ */ ((DialogType2) => {
+  DialogType2["WARNING"] = "warning";
+  DialogType2["ERROR"] = "error";
+  DialogType2["SUCCESS"] = "success";
+  DialogType2["INFO"] = "info";
+  return DialogType2;
+})(DialogType || {});
+var DialogSize = /* @__PURE__ */ ((DialogSize2) => {
+  DialogSize2["SMALL"] = "small";
+  DialogSize2["MEDIUM"] = "medium";
+  DialogSize2["LARGE"] = "large";
+  return DialogSize2;
+})(DialogSize || {});
+export {
+  DialogSize,
+  DialogType
+};

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

@@ -96,15 +96,64 @@ export type NavigationOptions = {
      */
     context?: Record<string, string>;
 };
+/**
+ * entity options (used by EPC)
+ */
+export type EntityOptions = {
+    /**
+     * type of the entity
+     */
+    entityType: string;
+    /**
+     * id of the entity
+     */
+    entityId: string;
+};
+/**
+ * type of the item to open
+ */
+export declare enum OpenType {
+    /**
+     * opens the given module or fires applicaiton.moduleopen event for other modules to handle
+     */
+    MODULE = "MODULE"
+}
+/**
+ * module open mode
+ */
+export declare enum ModuleOpenMode {
+    /**
+     * open the module in a new popup window
+     */
+    POPUP = "POPUP",
+    /**
+     * open the module in the same window (iframe)
+     */
+    INLINE = "INLINE"
+}
 export type OpenOptions = {
     /**
      * target item
      */
-    target: string;
+    target: string | EntityOptions;
     /**
-     * type of the item
+     * type of the item to open
      */
-    type?: string;
+    type?: string | OpenType;
+    /**
+     * urn of the module to open
+     * @example urn:encompass:loanapp
+     */
+    moduleId?: string;
+    /**
+     * mode to open the module
+     * @default INLINE
+     */
+    moduleOpenMode?: ModuleOpenMode;
+    /**
+     * module parameters as key-value pairs
+     */
+    moduleParameters?: Record<string, unknown>;
 };
 /**
  * size of the modal
@@ -144,33 +193,6 @@ export type OpenModalOptions = {
      */
     size: ModalSize;
 };
-/**
- * module open mode
- */
-export declare enum ModuleOpenMode {
-    /**
-     * open the module in a new popup window
-     */
-    POPUP = "POPUP",
-    /**
-     * open the module in the same window
-     */
-    INLINE = "INLINE"
-}
-/**
- * open module options
- */
-export type OpenModuleOptions = {
-    /**
-     * mode to open the module
-     * @default INLINE
-     */
-    mode?: ModuleOpenMode;
-    /**
-     * module parameters as key-value pairs
-     */
-    parameters?: Record<string, unknown>;
-};
 /**
  * capabilities exposed by the application
  */
@@ -294,14 +316,14 @@ export type ModuleOpenInfo = {
  * @param params event parameters
  * @param params.obj module object reference
  * @param params.eventName event name
- * @param params.eventParams Application open info
+ * @param params.eventParams information about the module to be opened along with parameters
  * @param params.eventOptions additional options related to the event
  * @returns true if module is valid and can be opened, false otherwise
  */
 export type ModuleOpenListener = (params: {
     obj: IApplication;
     eventName: string;
-    eventParams: ModuleOpenInfo;
+    eventParams: ModuleOpenInfo & Record<string, unknown>;
     eventOptions?: Record<string, unknown>;
 }) => boolean;
 /**
@@ -432,13 +454,6 @@ export interface IApplication extends IScriptingObject {
      * @param options modal properties
      */
     openModal(options: OpenModalOptions): Promise<void>;
-    /**
-     * Open a module inline or in a popup
-     * @param moduleId module id in urn format. example: urn:encompass:loanapp
-     * @param options module open options
-     * @returns true if the module is valid, false otherwise
-     */
-    openModule(moduleId: string, options: OpenModuleOptions): Promise<boolean>;
     /**
      * Perform an action
      * @param action action name

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

@@ -1,29 +1,63 @@
 import { IEvent } from '../event.js';
 import { IScriptingObject } from '../scriptingObject.js';
 /**
- * error data to be displayed in the error dialog
+ * type of dialog to display in the hosting application
  */
-export type ErrorData = {
+export declare enum DialogType {
+    WARNING = "warning",
+    ERROR = "error",
+    SUCCESS = "success",
+    INFO = "info"
+}
+/**
+ * size of the dialog to display in the hosting application
+ */
+export declare enum DialogSize {
+    SMALL = "small",
+    MEDIUM = "medium",
+    LARGE = "large"
+}
+/**
+ * Options to display a dialog in the hosting application
+ */
+export type DialogOptions = {
     /**
-     * short description of the error
+     * type of dialog to display
      */
-    message: string;
+    type: DialogType;
     /**
-     * error code, if any
+     * size of the dialog to display
      */
-    code?: string;
+    size: DialogSize;
+    /**
+     * title of the dialog
+     */
+    title: string;
     /**
-     * detailed description of the error
+     * message to be displayed in the body of the dialog
      */
-    details: string;
+    body: string;
     /**
      * link to the help documentation
      */
     helpLink?: string;
     /**
-     * unique id to identify the session / transaction, if any
+     * unique id that identifies the session / transaction
      */
     correlationId?: string;
+    /**
+     * error code
+     */
+    code?: string;
+    /**
+     * list of actions that are avilable to user for providing feedback.
+     *
+     * these actions are displayed as buttons in the dialog
+     *
+     * default action is 'ok'
+     * @example ['retry', 'cancel']
+     */
+    actions?: string[];
 };
 /**
  * MicroApp module specific parameters
@@ -144,11 +178,23 @@ export interface IModule extends IScriptingObject {
      */
     unload(): Promise<void>;
     /**
-     * open a dialog in hosting application to display an error message and related help link
+     * open a dialog in hosting application to display an error, success or info 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 data error message to be displayed
-     * @returns a promise that resolves when the dialog is closed
-     */
-    showError(data: ErrorData): Promise<void>;
+     * Accessibility Consideration: 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 options data to be displayed
+     * @returns a promise that resolves when the dialog is closed along with the user action as string (in-case sensitive). For example, 'ok', 'retry', 'cancel'
+     * @example
+     * ```typescript
+     *  await module.showDialog({
+     *    type: DialogType.ERROR,
+     *    size: DialogSize.MEDIUM,
+     *    message: 'CoreLogic Error',
+     *    details: 'An error occurred while processing the credit request',
+     *    helpLink: 'https://example.com/help',
+     *    correlationId: '1234567890'
+     *    code: 'CL-1001'
+     *  });
+     * ```
+     */
+    showDialog(options: DialogOptions): Promise<string>;
 }