@genesislcap/foundation-notifications 14.114.2 → 14.115.0

package/docs/api/foundation-notifications.toaststructure.loglevel.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; [ToastStructure](./foundation-notifications.toaststructure.md) &gt; [logLevel](./foundation-notifications.toaststructure.loglevel.md)
+
+## ToastStructure.logLevel property
+
+**Signature:**
+
+```typescript
+readonly logLevel?: LogLevel;
+```

package/docs/api/foundation-notifications.toaststructure.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; [ToastStructure](./foundation-notifications.toaststructure.md)
+
+## ToastStructure interface
+
+Interface for Toast Structure
+
+**Signature:**
+
+```typescript
+export interface ToastStructure 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [body](./foundation-notifications.toaststructure.body.md) | <code>readonly</code> | string |  |
+|  [createdAt?](./foundation-notifications.toaststructure.createdat.md) | <code>readonly</code> | Date | _(Optional)_ |
+|  [logLevel?](./foundation-notifications.toaststructure.loglevel.md) | <code>readonly</code> | LogLevel | _(Optional)_ |
+|  [title](./foundation-notifications.toaststructure.title.md) | <code>readonly</code> | string |  |
+|  [toast?](./foundation-notifications.toaststructure.toast.md) | <code>readonly</code> | [Toast](./foundation-notifications.toast.md) | _(Optional)_ |
+

package/docs/api/foundation-notifications.toaststructure.title.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; [ToastStructure](./foundation-notifications.toaststructure.md) &gt; [title](./foundation-notifications.toaststructure.title.md)
+
+## ToastStructure.title property
+
+**Signature:**
+
+```typescript
+readonly title: string;
+```

package/docs/api/foundation-notifications.toaststructure.toast.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; [ToastStructure](./foundation-notifications.toaststructure.md) &gt; [toast](./foundation-notifications.toaststructure.toast.md)
+
+## ToastStructure.toast property
+
+**Signature:**
+
+```typescript
+readonly toast?: Toast;
+```

package/docs/api-report.md

@@ -6,6 +6,16 @@
 
 import { LogLevel } from '@genesislcap/foundation-logger';
 
+// @public
+export interface AlertStructure {
+    // (undocumented)
+    readonly body: string;
+    // (undocumented)
+    readonly logLevel?: LogLevel;
+    // (undocumented)
+    readonly title: string;
+}
+
 // @public
 export interface Banner {
     // (undocumented)
@@ -14,13 +24,26 @@ export interface Banner {
     readonly dismissingAction?: DismissingAction;
 }
 
-// @public
+// @public @deprecated
 export class BannerBuilder {
+    // @deprecated
     build(): Banner;
+    // @deprecated
     withConfirmingAction(confirmingAction: ConfirmingAction): BannerBuilder;
+    // @deprecated
     withDismissingAction(dismissingAction: DismissingAction): BannerBuilder;
 }
 
+// @public
+export interface BannerStructure {
+    // (undocumented)
+    readonly banner?: Banner;
+    // (undocumented)
+    readonly body: string;
+    // (undocumented)
+    readonly logLevel?: LogLevel;
+}
+
 // @public
 export interface ConfirmingAction {
     // (undocumented)
@@ -37,10 +60,13 @@ export interface Dialog {
     readonly dismissingAction?: DismissingAction;
 }
 
-// @public
+// @public @deprecated
 export class DialogBuilder {
+    // @deprecated
     build(): Dialog;
+    // @deprecated
     withConfirmingAction(confirmingAction: ConfirmingAction): DialogBuilder;
+    // @deprecated
     withDismissingAction(dismissingAction: DismissingAction): DialogBuilder;
 }
 
@@ -51,6 +77,18 @@ export type DialogElement = NotificationElement & {
     show: Function;
 };
 
+// @public
+export interface DialogStructure {
+    // (undocumented)
+    readonly body: string;
+    // (undocumented)
+    readonly dialog?: Dialog;
+    // (undocumented)
+    readonly logLevel?: LogLevel;
+    // (undocumented)
+    readonly title: string;
+}
+
 // @public
 export interface DismissingAction {
     // (undocumented)
@@ -62,16 +100,16 @@ export interface DismissingAction {
 // @public
 export const getBannerAnchor: (element: any) => HTMLElement | null;
 
-// @public
+// @public @deprecated
 export const getBannerBuilder: () => BannerBuilder;
 
-// @public
+// @public @deprecated
 export const getDialogBuilder: () => DialogBuilder;
 
 // @public
 export const getLoglevel: (details: NotificationStructure) => LogLevel;
 
-// @public
+// @public @deprecated
 export const getNotificationBuilder: () => NotificationBuilder;
 
 // @public
@@ -80,23 +118,33 @@ export const getNotificationContainer: (id: string, tagName: String) => HTMLElem
 // @public
 export const getNotificationDetails: (details: NotificationStructure) => string;
 
-// @public
+// @public @deprecated
 export const getSnackbarBuilder: () => SnackbarBuilder;
 
-// @public
+// @public @deprecated
 export const getToastBuilder: () => ToastBuilder;
 
-// @public
+// @public @deprecated
 export class NotificationBuilder {
+    // @deprecated
     build(): NotificationStructure;
+    // @deprecated
     withAlert(alert: boolean): NotificationBuilder;
+    // @deprecated
     withBanner(banner: Banner): NotificationBuilder;
+    // @deprecated
     withBody(body: string): NotificationBuilder;
+    // @deprecated
     withCreatedAt(createdAt: Date): NotificationBuilder;
+    // @deprecated
     withDialog(dialog: Dialog): NotificationBuilder;
+    // @deprecated
     withLogLevel(logLevel: LogLevel): NotificationBuilder;
+    // @deprecated
     withSnackbar(snackbar: Snackbar): NotificationBuilder;
+    // @deprecated
     withTitle(title: string): NotificationBuilder;
+    // @deprecated
     withToast(toast: Toast): NotificationBuilder;
 }
 
@@ -163,7 +211,7 @@ export interface NotificationStructure {
     // (undocumented)
     readonly logLevel?: LogLevel;
     // (undocumented)
-    readonly title: string;
+    readonly title?: string;
 }
 
 // @public
@@ -175,15 +223,33 @@ export const showBanner: (notificationStructure: NotificationStructure, tagName:
 // Warning: (ae-internal-missing-underscore) The name "showDialog" should be prefixed with an underscore because the declaration is marked as @internal
 //
 // @internal
-export const showDialog: (notification: NotificationStructure, tagName: String) => void;
+export const showDialog: (notificationStructure: NotificationStructure, tagName: String) => void;
+
+// @public
+export const showLoggerLogLevel: (notificationStructure: NotificationStructure) => void;
 
 // @public
 export const showNotification: (notificationStructure: NotificationStructure, tagName: String, notificationBoundary?: HTMLElement) => void;
 
+// @public
+export const showNotificationAlert: (configuration: AlertStructure) => void;
+
+// @public
+export const showNotificationBanner: (configuration: BannerStructure, tagName: String, notificationBoundary?: HTMLElement) => void;
+
+// @public
+export const showNotificationDialog: (configuration: DialogStructure, tagName: String) => void;
+
+// @public
+export const showNotificationSnackbar: (configuration: SnackbarStructure, tagName: String) => void;
+
+// @public
+export const showNotificationToast: (configuration: ToastStructure, tagName: String) => void;
+
 // Warning: (ae-internal-missing-underscore) The name "showSnackbar" should be prefixed with an underscore because the declaration is marked as @internal
 //
 // @internal
-export const showSnackbar: (notification: NotificationStructure, tagName: String) => void;
+export const showSnackbar: (notificationStructure: NotificationStructure, tagName: String) => void;
 
 // Warning: (ae-internal-missing-underscore) The name "showToast" should be prefixed with an underscore because the declaration is marked as @internal
 //
@@ -198,14 +264,26 @@ export interface Snackbar {
     readonly type?: SnackbarType;
 }
 
-// @public
+// @public @deprecated
 export class SnackbarBuilder {
+    // @deprecated
     build(): Snackbar;
+    // @deprecated
     withConfirmingAction(confirmingAction: ConfirmingAction): SnackbarBuilder;
-    // (undocumented)
+    // @deprecated (undocumented)
     withType(type: SnackbarType): SnackbarBuilder;
 }
 
+// @public
+export interface SnackbarStructure {
+    // (undocumented)
+    readonly body: string;
+    // (undocumented)
+    readonly logLevel?: LogLevel;
+    // (undocumented)
+    readonly snackbar?: Snackbar;
+}
+
 // @public
 export type SnackbarType = 'error';
 
@@ -225,14 +303,21 @@ export interface Toast {
     readonly type?: NotificationType;
 }
 
-// @public (undocumented)
+// @public @deprecated (undocumented)
 export class ToastBuilder {
+    // @deprecated
     build(): Toast;
+    // @deprecated
     withAutoClose(autoClose: boolean): ToastBuilder;
+    // @deprecated
     withButtons(buttons: ToastButton[]): ToastBuilder;
+    // @deprecated
     withCloseTimeout(closeTimeout: number): ToastBuilder;
+    // @deprecated
     withDetails(details: NotificationDataRow): ToastBuilder;
+    // @deprecated
     withPosition(position: ToastPosition): ToastBuilder;
+    // @deprecated
     withType(type: NotificationType): ToastBuilder;
 }
 
@@ -257,6 +342,20 @@ export interface ToastButton {
 // @public
 export type ToastPosition = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
 
+// @public
+export interface ToastStructure {
+    // (undocumented)
+    readonly body: string;
+    // (undocumented)
+    readonly createdAt?: Date;
+    // (undocumented)
+    readonly logLevel?: LogLevel;
+    // (undocumented)
+    readonly title: string;
+    // (undocumented)
+    readonly toast?: Toast;
+}
+
 // (No @packageDocumentation comment for this package)
 
 ```

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-notifications",
   "description": "Genesis Foundation UI Notifications Utils",
-  "version": "14.114.2",
+  "version": "14.115.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -40,12 +40,12 @@
     "test:debug": "genx test --debug"
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.114.2",
-    "@genesislcap/genx": "14.114.2",
+    "@genesislcap/foundation-testing": "14.115.0",
+    "@genesislcap/genx": "14.115.0",
     "rimraf": "^3.0.2"
   },
   "dependencies": {
-    "@genesislcap/foundation-logger": "14.114.2",
+    "@genesislcap/foundation-logger": "14.115.0",
     "tslib": "^2.3.1"
   },
   "repository": {
@@ -56,5 +56,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "02163870a122149dde27eefaec7554e06362e3a1"
+  "gitHead": "51edda70c230e7bd0d1a168126a9a9d9efddba63"
 }