@elliemae/pui-scripting-object 1.50.2 → 1.51.1

package/dist/cjs/objects/application.js

@@ -22,7 +22,8 @@ __export(application_exports, {
   ModalSize: () => ModalSize,
   ModalType: () => ModalType,
   OpenMode: () => OpenMode,
-  OpenType: () => OpenType
+  OpenType: () => OpenType,
+  ToastType: () => ToastType
 });
 module.exports = __toCommonJS(application_exports);
 var OpenType = /* @__PURE__ */ ((OpenType2) => {
@@ -57,3 +58,10 @@ var ModalType = /* @__PURE__ */ ((ModalType2) => {
   ModalType2["INFO"] = "INFO";
   return ModalType2;
 })(ModalType || {});
+var ToastType = /* @__PURE__ */ ((ToastType2) => {
+  ToastType2["SUCCESS"] = "success";
+  ToastType2["ERROR"] = "error";
+  ToastType2["WARNING"] = "warning";
+  ToastType2["INFO"] = "info";
+  return ToastType2;
+})(ToastType || {});

package/dist/esm/objects/application.js

@@ -30,10 +30,18 @@ var ModalType = /* @__PURE__ */ ((ModalType2) => {
   ModalType2["INFO"] = "INFO";
   return ModalType2;
 })(ModalType || {});
+var ToastType = /* @__PURE__ */ ((ToastType2) => {
+  ToastType2["SUCCESS"] = "success";
+  ToastType2["ERROR"] = "error";
+  ToastType2["WARNING"] = "warning";
+  ToastType2["INFO"] = "info";
+  return ToastType2;
+})(ToastType || {});
 export {
   FormType,
   ModalSize,
   ModalType,
   OpenMode,
-  OpenType
+  OpenType,
+  ToastType
 };

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

@@ -133,24 +133,23 @@ export declare enum ModalSize {
     EXTRA_LARGE = "xl"
 }
 /**
- * additional options for warning / success / error / info modal
+ * content for warning / success / error / info modal types
  */
-export type ModalData = {
+export type ModalContent = {
     /**
-     * title of the dialog
+     * title of the modal
      */
     title: string;
     /**
-     * message to be displayed in the body of the dialog
+     * message to be displayed in the body of the modal
      */
     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']
+     * these actions are displayed as buttons in the modal
+     * @example ['ok', 'cancel']
+     * @default ['ok']
      */
     actions?: string[];
     /**
@@ -168,6 +167,7 @@ export type ModalData = {
 };
 /**
  * type of the form
+ * @enum
  */
 export declare enum FormType {
     /**
@@ -181,6 +181,7 @@ export declare enum FormType {
 }
 /**
  * type of the modal
+ * @enum
  */
 export declare enum ModalType {
     /**
@@ -223,33 +224,78 @@ export type ModalOptions = {
     /**
      * target item
      *
-     * optional for warning / success / error / info modal
+     * optional for warning / success / error / info modal type
      */
     target?: string;
     /**
      * name of the form or tool
      *
-     * optional for warning / success / error / info modal
+     * optional for warning / success / error / info modal type
      */
-    name: string;
+    name?: string;
     /**
+     * {@link ModalType}
+     *
      * type of the modal
      */
     type: ModalType;
     /**
+     * {@link ModalSize}
+     *
      * size of the modal
      * @default ModalSize.EXTRA_LARGE
      */
     size?: ModalSize;
     /**
+     * {@link FormType}
+     *
      * form type
      */
     formType?: FormType;
     /**
-     * additional data to display warning / success / error / info modal
+     * {@link ModalContent}
      *
+     * content to display in warning / success / error / info modal types
      */
-    data?: ModalData;
+    data?: ModalContent;
+};
+/**
+ * toast message type
+ * @enum
+ */
+export declare enum ToastType {
+    /**
+     * success message
+     */
+    SUCCESS = "success",
+    /**
+     * error message
+     */
+    ERROR = "error",
+    /**
+     * warning message
+     */
+    WARNING = "warning",
+    /**
+     * info message
+     */
+    INFO = "info"
+}
+/**
+ * options for toast message
+ */
+export type ToastOptions = {
+    /**
+     * title of the toast message
+     */
+    message: string;
+    /**
+     * {@link ToastType}
+     *
+     * type of the toast message
+     * @default ToastType.INFO
+     */
+    type: ToastType;
 };
 /**
  * capabilities exposed by the application
@@ -264,6 +310,9 @@ export type Capabilities = {
      */
     supportedFeatures: Array<string>;
 };
+/**
+ * navigation type
+ */
 export type Route = {
     /**
      * url of the route
@@ -513,7 +562,23 @@ export interface IApplication extends IScriptingObject {
     /**
      * open a modal
      * @param options modal properties
-     * @returns user selected modal action as string
+     * @returns action selected by the user
+     * @example
+     * ```typescript
+     * const result = await application.openModal({
+     *  type: ModalType.WARNING,
+     *  data: {
+     *   title: 'Warning',
+     *   body: 'This operation is final and cannot be reversed. Do you want to proceed?',
+     *   actions: ['Ok', 'Cancel']
+     *  }
+     * });
+     * if (result === 'Ok') {
+     *  // user clicked Ok
+     * } else {
+     *  // user clicked Cancel
+     * }
+     * ```
      */
     openModal(options: ModalOptions): Promise<string>;
     /**
@@ -527,6 +592,18 @@ export interface IApplication extends IScriptingObject {
      * @param options Print options
      */
     print(options: PrintOptions): Promise<void>;
+    /**
+     * show toast message
+     * @param options toast options
+     * @example
+     * ```typescript
+     * await application.showToast({
+     *  message: 'Hello World',
+     *  type: ToastType.INFO
+     * });
+     * ```
+     */
+    showToast(options: ToastOptions): Promise<void>;
     /**
      * get supportability of an action
      * @param name action name