@elliemae/pui-scripting-object 1.43.0 → 1.43.1

package/dist/cjs/objects/application.js

@@ -20,7 +20,8 @@ var application_exports = {};
 __export(application_exports, {
   ApplicationExtensionType: () => ApplicationExtensionType,
   LogLevel: () => LogLevel,
-  ModalSize: () => ModalSize
+  ModalSize: () => ModalSize,
+  ModuleOpenMode: () => ModuleOpenMode
 });
 module.exports = __toCommonJS(application_exports);
 var LogLevel = /* @__PURE__ */ ((LogLevel2) => {
@@ -44,3 +45,8 @@ var ModalSize = /* @__PURE__ */ ((ModalSize2) => {
   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,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,12 +13,4 @@ var __copyProps = (to, from, except, desc) => {
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var module_exports = {};
-__export(module_exports, {
-  ModuleOpenMode: () => ModuleOpenMode
-});
 module.exports = __toCommonJS(module_exports);
-var ModuleOpenMode = /* @__PURE__ */ ((ModuleOpenMode2) => {
-  ModuleOpenMode2["POPUP"] = "POPUP";
-  ModuleOpenMode2["INLINE"] = "INLINE";
-  return ModuleOpenMode2;
-})(ModuleOpenMode || {});

package/dist/esm/objects/application.js

@@ -19,8 +19,14 @@ var ModalSize = /* @__PURE__ */ ((ModalSize2) => {
   ModalSize2["LARGE"] = "lg";
   return ModalSize2;
 })(ModalSize || {});
+var ModuleOpenMode = /* @__PURE__ */ ((ModuleOpenMode2) => {
+  ModuleOpenMode2["POPUP"] = "POPUP";
+  ModuleOpenMode2["INLINE"] = "INLINE";
+  return ModuleOpenMode2;
+})(ModuleOpenMode || {});
 export {
   ApplicationExtensionType,
   LogLevel,
-  ModalSize
+  ModalSize,
+  ModuleOpenMode
 };

package/dist/esm/objects/module.js

@@ -1,8 +0,0 @@
-var ModuleOpenMode = /* @__PURE__ */ ((ModuleOpenMode2) => {
-  ModuleOpenMode2["POPUP"] = "POPUP";
-  ModuleOpenMode2["INLINE"] = "INLINE";
-  return ModuleOpenMode2;
-})(ModuleOpenMode || {});
-export {
-  ModuleOpenMode
-};

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

@@ -144,6 +144,38 @@ 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 = {
+    /**
+     * module to be opened in urn format
+     * @example urn:encompass:loanapp
+     */
+    moduleId: string;
+    /**
+     * mode to open the module
+     * @default INLINE
+     */
+    mode?: ModuleOpenMode;
+    /**
+     * module parameters as key-value pairs
+     */
+    parameters?: Record<string, unknown>;
+};
 /**
  * capabilities exposed by the application
  */
@@ -368,6 +400,12 @@ export interface IApplication extends IScriptingObject {
      * @param options modal properties
      */
     openModal(options: OpenModalOptions): Promise<void>;
+    /**
+     * Open a module inline or in a popup
+     * @param options module open options
+     * @returns false if the module is not found, true otherwise
+     */
+    openModule(options: OpenModuleOptions): Promise<boolean>;
     /**
      * Perform an action
      * @param action action name

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

@@ -26,138 +26,141 @@ export type ErrorData = {
     correlationId?: string;
 };
 /**
- * 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
+ * MicroApp module specific parameters
  */
-export type OpenModuleOptions = {
+export type ModuleParameters = {
     /**
      * module id in urn format
      * @example urn:encompass:loanapp
      */
     moduleId: string;
     /**
-     * mode to open the module
-     * @default INLINE
-     */
-    mode?: ModuleOpenMode;
-    /**
-     * module parameters as key-value pairs
+     * additional parameters as key-value pairs
      */
-    parameters?: Record<string, unknown>;
+    [key: string]: unknown;
 };
 /**
- * MicroApp module specific parameters
+ * module close event info
  */
-export type ModuleParameters = {
+export type ModuleCloseInfo = {
     /**
-     * module id in urn format
+     * module that triggered the close event in urn format
      * @example urn:encompass:loanapp
      */
     moduleId: string;
-    /**
-     * additional parameters as key-value pairs
-     */
-    [key: string]: unknown;
 };
 /**
- * module unload event info
+ * event handler that handles module close event
+ * @param params event parameters
+ * @param params.obj module object reference
+ * @param params.eventName event name
+ * @param params.eventParams Module close info
+ * @param params.eventOptions additional options related to the event
+ * @returns true to allow module unload, false otherwise
  */
-export type ModuleUnloadInfo = {
+export type ModuleCloseListener = (params: {
+    obj: IModule;
+    eventName: string;
+    eventParams: ModuleCloseInfo;
+    eventOptions?: Record<string, unknown>;
+}) => boolean;
+/**
+ * module open event info
+ */
+export type ModuleOpenInfo = {
     /**
-     * module that triggered the unload event in urn format
+     * module to be opened in urn format
      * @example urn:encompass:loanapp
      */
     moduleId: string;
 };
 /**
- * event handler that handles module unload event
+ * event handler that handles module open event
  * @param params event parameters
  * @param params.obj module object reference
  * @param params.eventName event name
- * @param params.eventParams Module unload info
+ * @param params.eventParams Module open info
  * @param params.eventOptions additional options related to the event
- * @returns true to allow module unload, false otherwise
+ * @returns true if module is valid and can be opened, false otherwise
  */
-export type ModuleUnLoadingListener = (params: {
+export type ModuleOpenListener = (params: {
     obj: IModule;
     eventName: string;
-    eventParams: ModuleUnloadInfo;
+    eventParams: ModuleOpenInfo;
     eventOptions?: Record<string, unknown>;
 }) => boolean;
 /**
- * module close event info
+ * module unload event info
  */
-export type ModuleCloseInfo = {
+export type ModuleUnloadInfo = {
     /**
-     * module that triggered the close event in urn format
+     * module that triggered the unload event in urn format
      * @example urn:encompass:loanapp
      */
     moduleId: string;
 };
 /**
- * event handler that handles module close event
+ * event handler that handles module unload event
  * @param params event parameters
  * @param params.obj module object reference
  * @param params.eventName event name
- * @param params.eventParams Module close info
+ * @param params.eventParams Module unload info
  * @param params.eventOptions additional options related to the event
  * @returns true to allow module unload, false otherwise
  */
-export type ModuleCloseListener = (params: {
+export type ModuleUnLoadingListener = (params: {
     obj: IModule;
     eventName: string;
-    eventParams: ModuleCloseInfo;
+    eventParams: ModuleUnloadInfo;
     eventOptions?: Record<string, unknown>;
 }) => boolean;
 /**
  * events that notifies the module's lifecycle
  */
 export type ModuleEvents = {
-    /**
-     * event fired when the module is unloading
-     *
-     * Use {@link ModuleUnLoadingListener} to handle this event
-     */
-    'module.unloading': ModuleUnLoadingListener;
     /**
      * event fired when the module to be closed
      *
      * Use {@link ModuleCloseListener} to handle this event
      */
     'module.close': ModuleCloseListener;
+    /**
+     * event fired when the module to be opened
+     *
+     * Use {@link ModuleOpenListener} to handle this event
+     */
+    'module.open': ModuleOpenListener;
+    /**
+     * event fired when the module is unloading
+     *
+     * Use {@link ModuleUnLoadingListener} to handle this event
+     */
+    'module.unloading': ModuleUnLoadingListener;
 };
 /**
  * Exposes MicroApp module specific methods
  *
- * This is an abstract interface and needs to be extended by the module
- *
  * See {@link ModuleEvents} for supported events
  */
 export interface IModule extends IScriptingObject {
-    /**
-     * event fired when the module is unloading
-     *
-     * Use {@link ModuleUnLoadingListener} to handle this event
-     */
-    readonly Unloading: IEvent;
     /**
      * event fired when the module to be closed
      *
      * Use {@link ModuleCloseListener} to handle this event
      */
     readonly Close: IEvent;
+    /**
+     * event fired when the module to be opened
+     *
+     * Use {@link ModuleOpenListener} to handle this event
+     */
+    readonly Open: IEvent;
+    /**
+     * event fired when the module is unloading
+     *
+     * Use {@link ModuleUnLoadingListener} to handle this event
+     */
+    readonly Unloading: IEvent;
     /**
      * get microapp module-specific capabilities or settings defined by the host application.
      *
@@ -173,13 +176,6 @@ export interface IModule extends IScriptingObject {
      * @returns parameters as key-value pairs
      */
     getParameters(): Promise<ModuleParameters>;
-    /**
-     * open another microapp module
-     *
-     * if parent module doesn't host the requested module, it will bubble up the request to its parent
-     * @param options module open options
-     */
-    open(options: OpenModuleOptions): Promise<void>;
     /**
      * unload the microapp module from the host application
      */