@genesislcap/foundation-notifications 14.52.2 → 14.53.0

package/dist/foundation-notifications.d.ts

@@ -240,6 +240,25 @@ export declare class NotificationBuilder {
     build(): NotificationStructure;
 }
 
+/**
+ * Interface for notify data
+ * @public
+ */
+export declare interface NotificationDataRow {
+    ALERT_ID: string;
+    CREATED_AT: number;
+    DETAILS: {
+        OPERATION: string;
+        ROW_REF: string;
+    };
+    HEADER: string;
+    MESSAGE: string;
+    NOTIFY_SEVERITY: NotificationSeverity;
+    EXPIRY?: null;
+    SENDER?: null;
+    USER_NAME: string;
+}
+
 /**
  * @internal
  */
@@ -255,6 +274,12 @@ export declare enum NotificationEvent {
     NOTIFICATION_EVENT = "notification-event"
 }
 
+/**
+ * type for notification severity
+ * @public
+ */
+export declare type NotificationSeverity = 'Information' | 'Warning' | 'Serious' | 'Critical';
+
 /**
  * Interface for Structure
  *  @public
@@ -381,6 +406,8 @@ export declare interface Toast {
     readonly type?: NotificationType;
     readonly autoClose?: boolean;
     readonly closeTimeout?: number;
+    readonly details?: NotificationDataRow;
+    readonly buttons?: ToastButton[];
 }
 
 /**
@@ -391,6 +418,8 @@ export declare class ToastBuilder {
     private autoClose;
     private closeTimeout;
     private type;
+    private details;
+    private buttons;
     /**
      * Add position to toast
      * @public
@@ -419,6 +448,20 @@ export declare class ToastBuilder {
      * @returns
      */
     withType(type: NotificationType): ToastBuilder;
+    /**
+     * Add details data to notifications
+     * @public
+     * @param details - NotificationDataRow
+     * @returns
+     */
+    withDetails(details: NotificationDataRow): ToastBuilder;
+    /**
+     * Add buttons to notifications
+     * @public
+     * @param buttons - ToastButton[]
+     * @returns
+     */
+    withButtons(buttons: ToastButton[]): ToastBuilder;
     /**
      * Build notification
      * @returns Toast
@@ -426,6 +469,22 @@ export declare class ToastBuilder {
     build(): Toast;
 }
 
+/**
+ * Interface for ToastButton
+ * @public
+ */
+export declare interface ToastButton {
+    action({ details, element }: {
+        details: NotificationDataRow;
+        element: HTMLElement;
+    }): void;
+    condition({ details }?: {
+        details: NotificationDataRow;
+    }): boolean;
+    placeholder?: string;
+    appearance?: string;
+}
+
 /**
  * @public
  * type for notification position

package/docs/api/foundation-notifications.md

@@ -28,9 +28,11 @@
 |  [ConfirmingAction](./foundation-notifications.confirmingaction.md) | Interface for Confirming Action configuration |
 |  [Dialog](./foundation-notifications.dialog.md) | Interface for Dialog configuration |
 |  [DismissingAction](./foundation-notifications.dismissingaction.md) | Interface for Dismissing Action configuration |
+|  [NotificationDataRow](./foundation-notifications.notificationdatarow.md) | Interface for notify data |
 |  [NotificationStructure](./foundation-notifications.notificationstructure.md) | Interface for Structure |
 |  [Snackbar](./foundation-notifications.snackbar.md) | Interface for Snackbar configuration |
 |  [Toast](./foundation-notifications.toast.md) | Interface for Toast configuration |
+|  [ToastButton](./foundation-notifications.toastbutton.md) | Interface for ToastButton |
 
 ## Variables
 
@@ -52,6 +54,7 @@
 
 |  Type Alias | Description |
 |  --- | --- |
+|  [NotificationSeverity](./foundation-notifications.notificationseverity.md) | type for notification severity |
 |  [NotificationType](./foundation-notifications.notificationtype.md) | type for notification |
 |  [SnackbarType](./foundation-notifications.snackbartype.md) | type for snackbar type |
 |  [ToastPosition](./foundation-notifications.toastposition.md) | type for notification position |

package/docs/api/foundation-notifications.notificationdatarow.alert_id.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [NotificationDataRow](./foundation-notifications.notificationdatarow.md) &gt; [ALERT\_ID](./foundation-notifications.notificationdatarow.alert_id.md)
+
+## NotificationDataRow.ALERT\_ID property
+
+**Signature:**
+
+```typescript
+ALERT_ID: string;
+```

package/docs/api/foundation-notifications.notificationdatarow.created_at.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [NotificationDataRow](./foundation-notifications.notificationdatarow.md) &gt; [CREATED\_AT](./foundation-notifications.notificationdatarow.created_at.md)
+
+## NotificationDataRow.CREATED\_AT property
+
+**Signature:**
+
+```typescript
+CREATED_AT: number;
+```

package/docs/api/foundation-notifications.notificationdatarow.details.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [NotificationDataRow](./foundation-notifications.notificationdatarow.md) &gt; [DETAILS](./foundation-notifications.notificationdatarow.details.md)
+
+## NotificationDataRow.DETAILS property
+
+**Signature:**
+
+```typescript
+DETAILS: {
+        OPERATION: string;
+        ROW_REF: string;
+    };
+```

package/docs/api/foundation-notifications.notificationdatarow.expiry.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [NotificationDataRow](./foundation-notifications.notificationdatarow.md) &gt; [EXPIRY](./foundation-notifications.notificationdatarow.expiry.md)
+
+## NotificationDataRow.EXPIRY property
+
+**Signature:**
+
+```typescript
+EXPIRY?: null;
+```

package/docs/api/foundation-notifications.notificationdatarow.header.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [NotificationDataRow](./foundation-notifications.notificationdatarow.md) &gt; [HEADER](./foundation-notifications.notificationdatarow.header.md)
+
+## NotificationDataRow.HEADER property
+
+**Signature:**
+
+```typescript
+HEADER: string;
+```

package/docs/api/foundation-notifications.notificationdatarow.md

@@ -0,0 +1,28 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [NotificationDataRow](./foundation-notifications.notificationdatarow.md)
+
+## NotificationDataRow interface
+
+Interface for notify data
+
+**Signature:**
+
+```typescript
+export interface NotificationDataRow 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [ALERT\_ID](./foundation-notifications.notificationdatarow.alert_id.md) |  | string |  |
+|  [CREATED\_AT](./foundation-notifications.notificationdatarow.created_at.md) |  | number |  |
+|  [DETAILS](./foundation-notifications.notificationdatarow.details.md) |  | { OPERATION: string; ROW\_REF: string; } |  |
+|  [EXPIRY?](./foundation-notifications.notificationdatarow.expiry.md) |  | null | _(Optional)_ |
+|  [HEADER](./foundation-notifications.notificationdatarow.header.md) |  | string |  |
+|  [MESSAGE](./foundation-notifications.notificationdatarow.message.md) |  | string |  |
+|  [NOTIFY\_SEVERITY](./foundation-notifications.notificationdatarow.notify_severity.md) |  | [NotificationSeverity](./foundation-notifications.notificationseverity.md) |  |
+|  [SENDER?](./foundation-notifications.notificationdatarow.sender.md) |  | null | _(Optional)_ |
+|  [USER\_NAME](./foundation-notifications.notificationdatarow.user_name.md) |  | string |  |
+

package/docs/api/foundation-notifications.notificationdatarow.message.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [NotificationDataRow](./foundation-notifications.notificationdatarow.md) &gt; [MESSAGE](./foundation-notifications.notificationdatarow.message.md)
+
+## NotificationDataRow.MESSAGE property
+
+**Signature:**
+
+```typescript
+MESSAGE: string;
+```

package/docs/api/foundation-notifications.notificationdatarow.notify_severity.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [NotificationDataRow](./foundation-notifications.notificationdatarow.md) &gt; [NOTIFY\_SEVERITY](./foundation-notifications.notificationdatarow.notify_severity.md)
+
+## NotificationDataRow.NOTIFY\_SEVERITY property
+
+**Signature:**
+
+```typescript
+NOTIFY_SEVERITY: NotificationSeverity;
+```

package/docs/api/foundation-notifications.notificationdatarow.sender.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [NotificationDataRow](./foundation-notifications.notificationdatarow.md) &gt; [SENDER](./foundation-notifications.notificationdatarow.sender.md)
+
+## NotificationDataRow.SENDER property
+
+**Signature:**
+
+```typescript
+SENDER?: null;
+```

package/docs/api/foundation-notifications.notificationdatarow.user_name.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [NotificationDataRow](./foundation-notifications.notificationdatarow.md) &gt; [USER\_NAME](./foundation-notifications.notificationdatarow.user_name.md)
+
+## NotificationDataRow.USER\_NAME property
+
+**Signature:**
+
+```typescript
+USER_NAME: string;
+```

package/docs/api/foundation-notifications.notificationseverity.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [NotificationSeverity](./foundation-notifications.notificationseverity.md)
+
+## NotificationSeverity type
+
+type for notification severity
+
+**Signature:**
+
+```typescript
+export type NotificationSeverity = 'Information' | 'Warning' | 'Serious' | 'Critical';
+```

package/docs/api/foundation-notifications.toast.buttons.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [Toast](./foundation-notifications.toast.md) &gt; [buttons](./foundation-notifications.toast.buttons.md)
+
+## Toast.buttons property
+
+**Signature:**
+
+```typescript
+readonly buttons?: ToastButton[];
+```

package/docs/api/foundation-notifications.toast.details.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [Toast](./foundation-notifications.toast.md) &gt; [details](./foundation-notifications.toast.details.md)
+
+## Toast.details property
+
+**Signature:**
+
+```typescript
+readonly details?: NotificationDataRow;
+```

package/docs/api/foundation-notifications.toast.md

@@ -17,7 +17,9 @@ export interface Toast
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
 |  [autoClose?](./foundation-notifications.toast.autoclose.md) | <code>readonly</code> | boolean | _(Optional)_ |
+|  [buttons?](./foundation-notifications.toast.buttons.md) | <code>readonly</code> | [ToastButton](./foundation-notifications.toastbutton.md)<!-- -->\[\] | _(Optional)_ |
 |  [closeTimeout?](./foundation-notifications.toast.closetimeout.md) | <code>readonly</code> | number | _(Optional)_ |
+|  [details?](./foundation-notifications.toast.details.md) | <code>readonly</code> | [NotificationDataRow](./foundation-notifications.notificationdatarow.md) | _(Optional)_ |
 |  [position?](./foundation-notifications.toast.position.md) | <code>readonly</code> | [ToastPosition](./foundation-notifications.toastposition.md) | _(Optional)_ |
 |  [type?](./foundation-notifications.toast.type.md) | <code>readonly</code> | [NotificationType](./foundation-notifications.notificationtype.md) | _(Optional)_ |
 

package/docs/api/foundation-notifications.toastbuilder.md

@@ -17,7 +17,9 @@ export declare class ToastBuilder
 |  --- | --- | --- |
 |  [build()](./foundation-notifications.toastbuilder.build.md) |  | Build notification |
 |  [withAutoClose(autoClose)](./foundation-notifications.toastbuilder.withautoclose.md) |  | Add auto close to notification |
+|  [withButtons(buttons)](./foundation-notifications.toastbuilder.withbuttons.md) |  | Add buttons to notifications |
 |  [withCloseTimeout(closeTimeout)](./foundation-notifications.toastbuilder.withclosetimeout.md) |  | Add close timeout to notification |
+|  [withDetails(details)](./foundation-notifications.toastbuilder.withdetails.md) |  | Add details data to notifications |
 |  [withPosition(position)](./foundation-notifications.toastbuilder.withposition.md) |  | Add position to toast |
 |  [withType(type)](./foundation-notifications.toastbuilder.withtype.md) |  | Add type to notification, if the type is anything other than 'warning' or 'success' do not add it |
 

package/docs/api/foundation-notifications.toastbuilder.withbuttons.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [ToastBuilder](./foundation-notifications.toastbuilder.md) &gt; [withButtons](./foundation-notifications.toastbuilder.withbuttons.md)
+
+## ToastBuilder.withButtons() method
+
+Add buttons to notifications
+
+**Signature:**
+
+```typescript
+withButtons(buttons: ToastButton[]): ToastBuilder;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  buttons | [ToastButton](./foundation-notifications.toastbutton.md)<!-- -->\[\] | ToastButton\[\] |
+
+**Returns:**
+
+[ToastBuilder](./foundation-notifications.toastbuilder.md)
+
+

package/docs/api/foundation-notifications.toastbuilder.withdetails.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [ToastBuilder](./foundation-notifications.toastbuilder.md) &gt; [withDetails](./foundation-notifications.toastbuilder.withdetails.md)
+
+## ToastBuilder.withDetails() method
+
+Add details data to notifications
+
+**Signature:**
+
+```typescript
+withDetails(details: NotificationDataRow): ToastBuilder;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  details | [NotificationDataRow](./foundation-notifications.notificationdatarow.md) | NotificationDataRow |
+
+**Returns:**
+
+[ToastBuilder](./foundation-notifications.toastbuilder.md)
+
+

package/docs/api/foundation-notifications.toastbutton.action.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [ToastButton](./foundation-notifications.toastbutton.md) &gt; [action](./foundation-notifications.toastbutton.action.md)
+
+## ToastButton.action() method
+
+**Signature:**
+
+```typescript
+action({ details, element }: {
+        details: NotificationDataRow;
+        element: HTMLElement;
+    }): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  { details, element } | { details: [NotificationDataRow](./foundation-notifications.notificationdatarow.md)<!-- -->; element: HTMLElement; } |  |
+
+**Returns:**
+
+void
+

package/docs/api/foundation-notifications.toastbutton.appearance.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [ToastButton](./foundation-notifications.toastbutton.md) &gt; [appearance](./foundation-notifications.toastbutton.appearance.md)
+
+## ToastButton.appearance property
+
+**Signature:**
+
+```typescript
+appearance?: string;
+```

package/docs/api/foundation-notifications.toastbutton.condition.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [ToastButton](./foundation-notifications.toastbutton.md) &gt; [condition](./foundation-notifications.toastbutton.condition.md)
+
+## ToastButton.condition() method
+
+**Signature:**
+
+```typescript
+condition({ details }?: {
+        details: NotificationDataRow;
+    }): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  { details } | { details: [NotificationDataRow](./foundation-notifications.notificationdatarow.md)<!-- -->; } | _(Optional)_ |
+
+**Returns:**
+
+boolean
+

package/docs/api/foundation-notifications.toastbutton.md

@@ -0,0 +1,28 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [ToastButton](./foundation-notifications.toastbutton.md)
+
+## ToastButton interface
+
+Interface for ToastButton
+
+**Signature:**
+
+```typescript
+export interface ToastButton 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [appearance?](./foundation-notifications.toastbutton.appearance.md) |  | string | _(Optional)_ |
+|  [placeholder?](./foundation-notifications.toastbutton.placeholder.md) |  | string | _(Optional)_ |
+
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [action({ details, element })](./foundation-notifications.toastbutton.action.md) |  |
+|  [condition({ details })](./foundation-notifications.toastbutton.condition.md) |  |
+

package/docs/api/foundation-notifications.toastbutton.placeholder.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [ToastButton](./foundation-notifications.toastbutton.md) &gt; [placeholder](./foundation-notifications.toastbutton.placeholder.md)
+
+## ToastButton.placeholder property
+
+**Signature:**
+
+```typescript
+placeholder?: string;
+```

package/docs/api-report.md

@@ -99,6 +99,31 @@ export class NotificationBuilder {
     withToast(toast: Toast): NotificationBuilder;
 }
 
+// @public
+export interface NotificationDataRow {
+    // (undocumented)
+    ALERT_ID: string;
+    // (undocumented)
+    CREATED_AT: number;
+    // (undocumented)
+    DETAILS: {
+        OPERATION: string;
+        ROW_REF: string;
+    };
+    // (undocumented)
+    EXPIRY?: null;
+    // (undocumented)
+    HEADER: string;
+    // (undocumented)
+    MESSAGE: string;
+    // (undocumented)
+    NOTIFY_SEVERITY: NotificationSeverity;
+    // (undocumented)
+    SENDER?: null;
+    // (undocumented)
+    USER_NAME: string;
+}
+
 // Warning: (ae-internal-missing-underscore) The name "NotificationElement" should be prefixed with an underscore because the declaration is marked as @internal
 //
 // @internal (undocumented)
@@ -112,6 +137,9 @@ export enum NotificationEvent {
     NOTIFICATION_EVENT = "notification-event"
 }
 
+// @public
+export type NotificationSeverity = 'Information' | 'Warning' | 'Serious' | 'Critical';
+
 // @public
 export interface NotificationStructure {
     // (undocumented)
@@ -179,8 +207,12 @@ export interface Toast {
     // (undocumented)
     readonly autoClose?: boolean;
     // (undocumented)
+    readonly buttons?: ToastButton[];
+    // (undocumented)
     readonly closeTimeout?: number;
     // (undocumented)
+    readonly details?: NotificationDataRow;
+    // (undocumented)
     readonly position?: ToastPosition;
     // (undocumented)
     readonly type?: NotificationType;
@@ -190,11 +222,30 @@ export interface Toast {
 export class ToastBuilder {
     build(): Toast;
     withAutoClose(autoClose: boolean): ToastBuilder;
+    withButtons(buttons: ToastButton[]): ToastBuilder;
     withCloseTimeout(closeTimeout: number): ToastBuilder;
+    withDetails(details: NotificationDataRow): ToastBuilder;
     withPosition(position: ToastPosition): ToastBuilder;
     withType(type: NotificationType): ToastBuilder;
 }
 
+// @public
+export interface ToastButton {
+    // (undocumented)
+    action({ details, element }: {
+        details: NotificationDataRow;
+        element: HTMLElement;
+    }): void;
+    // (undocumented)
+    appearance?: string;
+    // (undocumented)
+    condition({ details }?: {
+        details: NotificationDataRow;
+    }): boolean;
+    // (undocumented)
+    placeholder?: string;
+}
+
 // @public
 export type ToastPosition = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-notifications",
   "description": "Genesis Foundation UI Notifications Utils",
-  "version": "14.52.2",
+  "version": "14.53.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -37,11 +37,11 @@
     "test:debug": "genx test --debug"
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.52.2",
-    "@genesislcap/genx": "14.52.2"
+    "@genesislcap/foundation-testing": "14.53.0",
+    "@genesislcap/genx": "14.53.0"
   },
   "dependencies": {
-    "@genesislcap/foundation-utils": "14.52.2",
+    "@genesislcap/foundation-utils": "14.53.0",
     "@microsoft/fast-element": "^1.7.0",
     "tslib": "^2.3.1"
   },
@@ -53,5 +53,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "9ee4ddde47ecc9d5065be29bf7560e66b4839878"
+  "gitHead": "026e0655a3e50a4ab8db54d701c2abcd74c4bf9b"
 }