@elliemae/pui-scripting-object 1.46.3 → 1.47.0

package/dist/cjs/objects/application.js

@@ -19,8 +19,10 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var application_exports = {};
 __export(application_exports, {
   ApplicationExtensionType: () => ApplicationExtensionType,
+  FormType: () => FormType,
   LogLevels: () => LogLevels,
   ModalSize: () => ModalSize,
+  ModalType: () => ModalType,
   OpenMode: () => OpenMode,
   OpenType: () => OpenType
 });
@@ -52,5 +54,22 @@ var ModalSize = /* @__PURE__ */ ((ModalSize2) => {
   ModalSize2["SMALL"] = "sm";
   ModalSize2["MEDIUM"] = "md";
   ModalSize2["LARGE"] = "lg";
+  ModalSize2["EXTRA_LARGE"] = "xl";
   return ModalSize2;
 })(ModalSize || {});
+var FormType = /* @__PURE__ */ ((FormType2) => {
+  FormType2["STANDARD_FORM"] = "STANDARD_FORM";
+  FormType2["CUSTOM_FORM"] = "CUSTOM_FORM";
+  return FormType2;
+})(FormType || {});
+var ModalType = /* @__PURE__ */ ((ModalType2) => {
+  ModalType2["FORM"] = "FORM";
+  ModalType2["TOOL"] = "TOOL";
+  ModalType2["DOCUMENT"] = "DOCUMENT";
+  ModalType2["URL"] = "URL";
+  ModalType2["WARNING"] = "WARNING";
+  ModalType2["ERROR"] = "ERROR";
+  ModalType2["SUCCESS"] = "SUCCESS";
+  ModalType2["INFO"] = "INFO";
+  return ModalType2;
+})(ModalType || {});

package/dist/cjs/objects/module.js

@@ -3,10 +3,6 @@ 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))
@@ -17,21 +13,4 @@ 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

@@ -25,12 +25,31 @@ var ModalSize = /* @__PURE__ */ ((ModalSize2) => {
   ModalSize2["SMALL"] = "sm";
   ModalSize2["MEDIUM"] = "md";
   ModalSize2["LARGE"] = "lg";
+  ModalSize2["EXTRA_LARGE"] = "xl";
   return ModalSize2;
 })(ModalSize || {});
+var FormType = /* @__PURE__ */ ((FormType2) => {
+  FormType2["STANDARD_FORM"] = "STANDARD_FORM";
+  FormType2["CUSTOM_FORM"] = "CUSTOM_FORM";
+  return FormType2;
+})(FormType || {});
+var ModalType = /* @__PURE__ */ ((ModalType2) => {
+  ModalType2["FORM"] = "FORM";
+  ModalType2["TOOL"] = "TOOL";
+  ModalType2["DOCUMENT"] = "DOCUMENT";
+  ModalType2["URL"] = "URL";
+  ModalType2["WARNING"] = "WARNING";
+  ModalType2["ERROR"] = "ERROR";
+  ModalType2["SUCCESS"] = "SUCCESS";
+  ModalType2["INFO"] = "INFO";
+  return ModalType2;
+})(ModalType || {});
 export {
   ApplicationExtensionType,
+  FormType,
   LogLevels,
   ModalSize,
+  ModalType,
   OpenMode,
   OpenType
 };

package/dist/esm/objects/module.js

@@ -1,17 +0,0 @@
-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

@@ -6,11 +6,29 @@ import { NavigationType } from './shared.js';
  * Log levels
  */
 export declare enum LogLevels {
+    /**
+     * debug log level
+     */
     DEBUG = 10,
+    /**
+     * info log level
+     */
     INFO = 20,
+    /**
+     * audit log level
+     */
     AUDIT = 30,
+    /**
+     * warning log level
+     */
     WARN = 40,
+    /**
+     * error log level
+     */
     ERROR = 50,
+    /**
+     * fatal log level
+     */
     FATAL = 60
 }
 /**
@@ -178,28 +196,130 @@ export declare enum ModalSize {
     /**
      * large modal
      */
-    LARGE = "lg"
+    LARGE = "lg",
+    /**
+     * extra large modal
+     */
+    EXTRA_LARGE = "xl"
+}
+/**
+ * additional options for warning / success / error / info modal
+ */
+export type ModalData = {
+    /**
+     * title of the dialog
+     */
+    title: string;
+    /**
+     * message to be displayed in the body of the dialog
+     */
+    body: 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[];
+    /**
+     * link to the help documentation
+     */
+    helpLink?: string;
+    /**
+     * unique id that identifies the session / transaction
+     */
+    correlationId?: string;
+    /**
+     * error code
+     */
+    code?: string;
+};
+/**
+ * type of the form
+ */
+export declare enum FormType {
+    /**
+     * standard form
+     */
+    STANDARD_FORM = "STANDARD_FORM",
+    /**
+     * custom form
+     */
+    CUSTOM_FORM = "CUSTOM_FORM"
+}
+/**
+ * type of the modal
+ */
+export declare enum ModalType {
+    /**
+     * modal with form
+     */
+    FORM = "FORM",
+    /**
+     * modal with tool
+     */
+    TOOL = "TOOL",
+    /**
+     * modal with document
+     */
+    DOCUMENT = "DOCUMENT",
+    /**
+     * modal that opens a URL
+     */
+    URL = "URL",
+    /**
+     * modal with warning message
+     */
+    WARNING = "WARNING",
+    /**
+     * modal with error message
+     */
+    ERROR = "ERROR",
+    /**
+     * modal with success message
+     */
+    SUCCESS = "SUCCESS",
+    /**
+     * modal with info message
+     */
+    INFO = "INFO"
 }
 /**
  * modal options
  */
-export type OpenModalOptions = {
+export type ModalOptions = {
     /**
      * target item
+     *
+     * optional for warning / success / error / info modal
      */
-    target: string;
+    target?: string;
     /**
-     * name
+     * name of the form or tool
+     *
+     * optional for warning / success / error / info modal
      */
     name: string;
     /**
      * type of the modal
      */
-    type?: string;
+    type: ModalType;
     /**
      * size of the modal
+     * @default ModalSize.EXTRA_LARGE
+     */
+    size?: ModalSize;
+    /**
+     * form type
+     */
+    formType?: FormType;
+    /**
+     * additional data to display warning / success / error / info modal
+     *
      */
-    size: ModalSize;
+    data?: ModalData;
 };
 /**
  * capabilities exposed by the application
@@ -446,7 +566,7 @@ export interface IApplication extends IScriptingObject {
      * @param message log message
      * @param logLevel log level
      */
-    log(message: LogMessage | string, logLevel: LogLevels): Promise<void>;
+    log(message: LogMessage | string, logLevel: keyof typeof LogLevels): Promise<void>;
     /**
      * navigate to a location in the application
      * @param options navigation options
@@ -474,8 +594,9 @@ export interface IApplication extends IScriptingObject {
     /**
      * open a modal
      * @param options modal properties
+     * @returns user selected modal action as string
      */
-    openModal(options: OpenModalOptions): Promise<void>;
+    openModal(options: ModalOptions): Promise<string>;
     /**
      * Perform an action
      * @param action action name

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

@@ -1,64 +1,5 @@
 import { IEvent } from '../event.js';
 import { IScriptingObject } from '../scriptingObject.js';
-/**
- * type of dialog to display in the hosting application
- */
-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 = {
-    /**
-     * type of dialog to display
-     */
-    type: DialogType;
-    /**
-     * size of the dialog to display
-     */
-    size: DialogSize;
-    /**
-     * title of the dialog
-     */
-    title: string;
-    /**
-     * message to be displayed in the body of the dialog
-     */
-    body: string;
-    /**
-     * link to the help documentation
-     */
-    helpLink?: string;
-    /**
-     * 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
  */
@@ -177,24 +118,4 @@ export interface IModule extends IScriptingObject {
      * unload the microapp module from the host application
      */
     unload(): Promise<void>;
-    /**
-     * open a dialog in hosting application to display an error, success or info message and related help link
-     *
-     * 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>;
 }