@elliemae/pui-scripting-object 1.32.3 → 1.33.0

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

@@ -1,5 +1,30 @@
 import { IEvent, Listener } from '../event.js';
 import { IScriptingObject } from '../scriptingObject.js';
+/**
+ * error data to be displayed in the error dialog
+ */
+export interface ErrorData {
+    /**
+     * short description of the error
+     */
+    message: string;
+    /**
+     * error code, if any
+     */
+    code?: string;
+    /**
+     * detailed description of the error
+     */
+    details: string;
+    /**
+     * link to the help documentation
+     */
+    helpLink?: string;
+    /**
+     * unique id to identify the session / transaction, if any
+     */
+    correlationId?: string;
+}
 /**
  * event handler that handles module unload event
  * @param id unique id of the app that is being unloaded
@@ -42,4 +67,12 @@ 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 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 error {ErrorData} error message to be displayed
+     * @returns {Promise<void>} a promise that resolves when the dialog is closed
+     */
+    showError(data: ErrorData): Promise<void>;
 }

package/package.json

@@ -1,9 +1,8 @@
 {
   "name": "@elliemae/pui-scripting-object",
-  "version": "1.32.3",
+  "version": "1.33.0",
   "description": "Typescript defintions for Scripting Objects",
   "sideEffects": false,
-  "type": "module",
   "main": "./dist/cjs/index.js",
   "module": "./dist/es/index.js",
   "unpkg": "./dist/umd/index.js",
@@ -77,5 +76,6 @@
     "redux-saga": "~1.3.0",
     "styled-components": "~5.3.11"
   },
-  "peerDependencies": {}
+  "peerDependencies": {},
+  "type": "module"
 }