@elliemae/pui-scripting-object 1.32.2 → 1.33.0

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

@@ -17,7 +17,13 @@ export declare enum LogLevel {
  * metadata about the application
  */
 export type AppInfo = {
+    /**
+     * unique id of the application
+     */
     id: string;
+    /**
+     * name of the application
+     */
     name: string;
 };
 /**
@@ -48,6 +54,19 @@ export type ApplicationExtension = {
      */
     options?: Record<string, string>;
 };
+/**
+ * set of query options to get company settings
+ */
+export type CompanySettingsQueryOptions = {
+    /**
+     * category name
+     */
+    category: string;
+    /**
+     * attribute name
+     */
+    attribute?: string;
+};
 /**
  * Types of navigations
  */
@@ -63,12 +82,27 @@ export declare enum NavigationType {
  * navigation options
  */
 export type NavigationOptions = {
+    /**
+     * target url
+     */
     target: string;
+    /**
+     * type of the navigation
+     */
     type: NavigationType;
+    /**
+     * context for the navigation
+     */
     context?: Record<string, string>;
 };
 export type OpenOptions = {
+    /**
+     * target item
+     */
     target: string;
+    /**
+     * type of the item
+     */
     type?: string;
 };
 /**
@@ -140,11 +174,26 @@ export type Route = {
      */
     id: string;
 };
+/**
+ * environment details
+ */
 export type Environment = {
+    /**
+     * api domain
+     */
     apiHost: string;
 };
+/**
+ * application context
+ */
 export type ApplicationContext = {
+    /**
+     * environment details
+     */
     env: Environment;
+    /**
+     * current route
+     */
     route: Route;
 };
 /**
@@ -297,9 +346,9 @@ export interface IApplication extends IScriptingObject {
     log(message: string, logLevel: LogLevel): Promise<void>;
     /**
      * get company settings for a particular category
-     * @param category category name
+     * @param options {CompanySettingsQueryOptions} options to query company settings
      * @returns company settings as key value pairs. Null if category is not found
      */
-    getCompanySettings(category: string): Promise<Record<string, any> | null>;
+    getCompanySettings(options: CompanySettingsQueryOptions): Promise<Record<string, any> | null>;
 }
 export {};

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.2",
+  "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",
@@ -68,7 +67,7 @@
   },
   "devDependencies": {
     "@elliemae/browserslist-config-elliemae-latest-browsers": "~1.8.0",
-    "@elliemae/pui-cli": "~8.29.0",
+    "@elliemae/pui-cli": "~8.30.0",
     "@elliemae/pui-doc-gen": "~2.0.1",
     "@elliemae/pui-theme": "~2.7.0",
     "@types/styled-components": "~5.1.34",
@@ -77,5 +76,6 @@
     "redux-saga": "~1.3.0",
     "styled-components": "~5.3.11"
   },
-  "peerDependencies": {}
+  "peerDependencies": {},
+  "type": "module"
 }