@genesislcap/foundation-notifications 14.50.2-alpha-f13a8e3.0

package/dist/foundation-notifications.d.ts

@@ -0,0 +1,435 @@
+import { LogLevel } from '@genesislcap/foundation-utils';
+
+/**
+ * Interface for Banner configuration
+ * @public
+ */
+export declare interface Banner {
+    readonly dismissingAction?: DismissingAction;
+    readonly confirmingActions?: Array<ConfirmingAction>;
+}
+
+/**
+ * BannerBuilder
+ * @public
+ */
+export declare class BannerBuilder {
+    private dismissingAction;
+    private confirmingActions;
+    /**
+     * Add dismissing action to Banner
+     * @public
+     * @param dismissingAction - {@link DismissingAction}
+     * @returns
+     */
+    withDismissingAction(dismissingAction: DismissingAction): BannerBuilder;
+    /**
+     * Add confirming action to Banner
+     * @public
+     * @param confirmingAction - {@link ConfirmingAction}
+     * @returns
+     */
+    withConfirmingAction(confirmingAction: ConfirmingAction): BannerBuilder;
+    /**
+     * Build Banner
+     * @public
+     * @returns Banner
+     */
+    build(): Banner;
+}
+
+/**
+ * Interface for Confirming Action configuration
+ * @public
+ */
+export declare interface ConfirmingAction {
+    readonly label: String;
+    readonly action: Function;
+}
+
+/**
+ * Interface for Dialog configuration
+ * @public
+ */
+export declare interface Dialog {
+    readonly confirmingActions?: Array<ConfirmingAction>;
+    readonly dismissingAction?: DismissingAction;
+}
+
+/**
+ * DialogBuilder class
+ * @public
+ */
+export declare class DialogBuilder {
+    private dismissingAction;
+    private confirmingActions;
+    /**
+     * Add dismissing action to Dialog
+     * @public
+     * @param dismissingAction - {@link DismissingAction}
+     * @returns
+     */
+    withDismissingAction(dismissingAction: DismissingAction): DialogBuilder;
+    /**
+     * Add confirming action to Dialog
+     * @public
+     * @param confirmingAction - {@link ConfirmingAction}
+     * @returns
+     */
+    withConfirmingAction(confirmingAction: ConfirmingAction): DialogBuilder;
+    /**
+     * Build Dialog
+     * @public
+     * @returns Dialog
+     */
+    build(): Dialog;
+}
+
+/**
+ * @internal
+ */
+export declare type DialogElement = NotificationElement & {
+    show: Function;
+};
+
+/**
+ * Interface for Dismissing Action configuration
+ * @public
+ */
+export declare interface DismissingAction {
+    readonly label: String;
+    readonly action?: Function;
+}
+
+/**
+ * Get the banner anchor to attach the banner to
+ * @public
+ * @param element - The element to start searching from
+ * @returns
+ */
+export declare const getBannerAnchor: (element: any) => HTMLElement | null;
+
+/**
+ * Get banner builder instance
+ * @public
+ */
+export declare const getBannerBuilder: () => BannerBuilder;
+
+/**
+ * Returns an instance of DialogBuilder
+ * @public
+ */
+export declare const getDialogBuilder: () => DialogBuilder;
+
+/**
+ * Retrieves the log level from an NotificationStructure object
+ * @public
+ * @param details - The NotificationStructure object
+ * @returns The log level or the default value (LogLevel.Debug) if not present
+ */
+export declare const getLoglevel: (details: NotificationStructure) => LogLevel;
+
+/**
+ * Returns a new NotificationBuilder instance
+ * @public
+ */
+export declare const getNotificationBuilder: () => NotificationBuilder;
+
+/**
+ * Get/Create the error container in the DOM
+ * @public
+ * @param id - The id of the container
+ * @param tagName - The tag name to create prefix for the design system provider
+ * @returns
+ */
+export declare const getNotificationContainer: (id: string, tagName: String) => HTMLElement;
+
+/**
+ * Retrieves the notification details from an NotificationStructure object
+ * @public
+ * @param details - The NotificationStructure object
+ * @returns The title and body concatenated as a string, or default values ('Error: Something went wrong') if not present
+ */
+export declare const getNotificationDetails: (details: NotificationStructure) => string;
+
+/**
+ * Get snackbar builder instance
+ * @public
+ */
+export declare const getSnackbarBuilder: () => SnackbarBuilder;
+
+/**
+ * Get notification builder instance
+ * @public
+ */
+export declare const getToastBuilder: () => ToastBuilder;
+
+/**
+ * NotificationBuilder to build NotificationStructure
+ * @public
+ */
+export declare class NotificationBuilder {
+    private title;
+    private body;
+    private logLevel;
+    private alert;
+    private toast;
+    private banner;
+    private snackbar;
+    private dialog;
+    /**
+     * Add title to notification
+     * @public
+     * @param title - string
+     * @returns
+     */
+    withTitle(title: string): NotificationBuilder;
+    /**
+     * Add body details to notification
+     * @public
+     * @param body - string
+     * @returns
+     */
+    withBody(body: string): NotificationBuilder;
+    /**
+     * Add log level to notification
+     * @public
+     * @returns
+     */
+    withLogLevel(logLevel: LogLevel): NotificationBuilder;
+    /**
+     * Add alert to notification
+     * @public
+     * @param alert - boolean
+     * @returns
+     */
+    withAlert(alert: boolean): NotificationBuilder;
+    /**
+     * Add toast to notification
+     * @public
+     * @param notification - {@link Toast}
+     * @returns
+     */
+    withToast(toast: Toast): NotificationBuilder;
+    /**
+     * Add banner to notification
+     * @public
+     * @param banner - {@link Banner}
+     * @returns
+     */
+    withBanner(banner: Banner): NotificationBuilder;
+    /**
+     * Add snackbar to notification
+     * @public
+     * @param snackbar - {@link Snackbar}
+     * @returns
+     */
+    withSnackbar(snackbar: Snackbar): NotificationBuilder;
+    /**
+     * Add dialog to notification
+     * @public
+     * @param dialog - {@link Dialog}
+     * @returns
+     */
+    withDialog(dialog: Dialog): NotificationBuilder;
+    /**
+     * Build NotificationStructure
+     * @public
+     * @returns
+     */
+    build(): NotificationStructure;
+}
+
+/**
+ * @internal
+ */
+export declare type NotificationElement = HTMLElement & {
+    notification: NotificationStructure;
+};
+
+/**
+ * @public
+ * enum for different types of notification events
+ */
+export declare enum NotificationEvent {
+    NOTIFICATION_EVENT = "notification-event"
+}
+
+/**
+ * Interface for Structure
+ *  @public
+ */
+export declare interface NotificationStructure {
+    readonly title: string;
+    readonly body: string;
+    readonly logLevel?: LogLevel;
+    readonly config?: {
+        /**
+         * @deprecated Use logLevel from the top level instead
+         */
+        readonly logLevel?: LogLevel;
+        readonly alert?: boolean;
+        readonly toast?: Toast;
+        readonly banner?: Banner;
+        readonly snackbar?: Snackbar;
+        readonly dialog?: Dialog;
+    };
+}
+
+/**
+ * @public
+ * type for notification
+ */
+export declare type NotificationType = 'error' | 'warning' | 'success';
+
+/**
+ * Shows the notificationStructure dialog
+ * @public
+ * @param notificationStructure - The NotificationStructure object
+ * @param tagName - The tag name to create prefix for the design system provider & notificationStructure component
+ * @param notificationBoundary - target listener for the notification
+ * @returns
+ * */
+export declare const showBanner: (notificationStructure: NotificationStructure, tagName: String, notificationBoundary: HTMLElement) => void;
+
+/**
+ * Shows the dialog
+ * @internal
+ * @param notification - The NotificationStructure object
+ * @param tagName - The tag name to create prefix for the design system provider & notification component
+ * @returns
+ * */
+export declare const showDialog: (notification: NotificationStructure, tagName: String) => void;
+
+/**
+ * Shows the notificationStructure in the appropriate component
+ * @public
+ * @param notificationStructure - The NotificationStructure object
+ * @param tagName - The tag name to create prefix for the design system provider *
+ * @param notificationBoundary - The notificationStructure boundary element
+ * @returns
+ * */
+export declare const showNotification: (notificationStructure: NotificationStructure, tagName: String, notificationBoundary?: HTMLElement) => void;
+
+/**
+ * Shows the snackbar
+ * @internal
+ * @param notification - The NotificationStructure object
+ * @param tagName - The tag name to create prefix for the design system provider & notification component
+ * @returns
+ * */
+export declare const showSnackbar: (notification: NotificationStructure, tagName: String) => void;
+
+/**
+ * Shows the notificationStructure
+ * @internal
+ * @param notificationStructure - The NotificationStructure object
+ * @param tagName - The tag name to create prefix for the design system provider & notificationStructure component
+ * @returns
+ * */
+export declare const showToast: (notificationStructure: NotificationStructure, tagName: String) => void;
+
+/**
+ * Interface for Snackbar configuration
+ * @public
+ */
+export declare interface Snackbar {
+    readonly type?: SnackbarType;
+    readonly confirmingActions?: Array<ConfirmingAction>;
+}
+
+/**
+ * SnackbarBuilder to build Snackbar
+ * @public
+ */
+export declare class SnackbarBuilder {
+    private confirmingActions;
+    private type;
+    /**
+     * @public
+     * @param type - {@link SnackbarType}
+     * @returns
+     */
+    withType(type: SnackbarType): SnackbarBuilder;
+    /**
+     * Add confirming action to snackbar
+     * @public
+     * @param confirmingAction - {@link ConfirmingAction}
+     * @returns
+     */
+    withConfirmingAction(confirmingAction: ConfirmingAction): SnackbarBuilder;
+    /**
+     * Build snackbar
+     * @public
+     * @returns Snackbar
+     */
+    build(): Snackbar;
+}
+
+/**
+ * @public
+ * type for snackbar type
+ */
+export declare type SnackbarType = 'error';
+
+/**
+ * Interface for Toast configuration
+ * @public
+ */
+export declare interface Toast {
+    readonly position?: ToastPosition;
+    readonly type?: NotificationType;
+    readonly autoClose?: boolean;
+    readonly closeTimeout?: number;
+}
+
+/**
+ * @public
+ */
+export declare class ToastBuilder {
+    private position;
+    private autoClose;
+    private closeTimeout;
+    private type;
+    /**
+     * Add position to toast
+     * @public
+     * @param position - {@link ToastPosition}
+     * @returns
+     */
+    withPosition(position: ToastPosition): ToastBuilder;
+    /**
+     * Add auto close to notification
+     * @public
+     * @param autoClose - boolean
+     * @returns
+     */
+    withAutoClose(autoClose: boolean): ToastBuilder;
+    /**
+     * Add close timeout to notification
+     * @public
+     * @param closeTimeout - number
+     * @returns
+     */
+    withCloseTimeout(closeTimeout: number): ToastBuilder;
+    /**
+     * Add type to notification, if the type is anything other than 'warning' or 'success' do not add it
+     * @public
+     * @param type - {@link NotificationType}
+     * @returns
+     */
+    withType(type: NotificationType): ToastBuilder;
+    /**
+     * Build notification
+     * @returns Toast
+     */
+    build(): Toast;
+}
+
+/**
+ * @public
+ * type for notification position
+ */
+export declare type ToastPosition = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
+
+export { }

package/docs/.gitattributes

@@ -0,0 +1,2 @@
+*.md -diff
+*.md linguist-generated

package/docs/api/foundation-notifications.banner.confirmingactions.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; [Banner](./foundation-notifications.banner.md) &gt; [confirmingActions](./foundation-notifications.banner.confirmingactions.md)
+
+## Banner.confirmingActions property
+
+**Signature:**
+
+```typescript
+readonly confirmingActions?: Array<ConfirmingAction>;
+```

package/docs/api/foundation-notifications.banner.dismissingaction.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; [Banner](./foundation-notifications.banner.md) &gt; [dismissingAction](./foundation-notifications.banner.dismissingaction.md)
+
+## Banner.dismissingAction property
+
+**Signature:**
+
+```typescript
+readonly dismissingAction?: DismissingAction;
+```

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

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [Banner](./foundation-notifications.banner.md)
+
+## Banner interface
+
+Interface for Banner configuration
+
+**Signature:**
+
+```typescript
+export interface Banner 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [confirmingActions?](./foundation-notifications.banner.confirmingactions.md) | <code>readonly</code> | Array&lt;[ConfirmingAction](./foundation-notifications.confirmingaction.md)<!-- -->&gt; | _(Optional)_ |
+|  [dismissingAction?](./foundation-notifications.banner.dismissingaction.md) | <code>readonly</code> | [DismissingAction](./foundation-notifications.dismissingaction.md) | _(Optional)_ |
+

package/docs/api/foundation-notifications.bannerbuilder.build.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [BannerBuilder](./foundation-notifications.bannerbuilder.md) &gt; [build](./foundation-notifications.bannerbuilder.build.md)
+
+## BannerBuilder.build() method
+
+Build Banner
+
+**Signature:**
+
+```typescript
+build(): Banner;
+```
+**Returns:**
+
+[Banner](./foundation-notifications.banner.md)
+
+Banner
+

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

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [BannerBuilder](./foundation-notifications.bannerbuilder.md)
+
+## BannerBuilder class
+
+BannerBuilder
+
+**Signature:**
+
+```typescript
+export declare class BannerBuilder 
+```
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [build()](./foundation-notifications.bannerbuilder.build.md) |  | Build Banner |
+|  [withConfirmingAction(confirmingAction)](./foundation-notifications.bannerbuilder.withconfirmingaction.md) |  | Add confirming action to Banner |
+|  [withDismissingAction(dismissingAction)](./foundation-notifications.bannerbuilder.withdismissingaction.md) |  | Add dismissing action to Banner |
+

package/docs/api/foundation-notifications.bannerbuilder.withconfirmingaction.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; [BannerBuilder](./foundation-notifications.bannerbuilder.md) &gt; [withConfirmingAction](./foundation-notifications.bannerbuilder.withconfirmingaction.md)
+
+## BannerBuilder.withConfirmingAction() method
+
+Add confirming action to Banner
+
+**Signature:**
+
+```typescript
+withConfirmingAction(confirmingAction: ConfirmingAction): BannerBuilder;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  confirmingAction | [ConfirmingAction](./foundation-notifications.confirmingaction.md) | [ConfirmingAction](./foundation-notifications.confirmingaction.md) |
+
+**Returns:**
+
+[BannerBuilder](./foundation-notifications.bannerbuilder.md)
+
+

package/docs/api/foundation-notifications.bannerbuilder.withdismissingaction.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; [BannerBuilder](./foundation-notifications.bannerbuilder.md) &gt; [withDismissingAction](./foundation-notifications.bannerbuilder.withdismissingaction.md)
+
+## BannerBuilder.withDismissingAction() method
+
+Add dismissing action to Banner
+
+**Signature:**
+
+```typescript
+withDismissingAction(dismissingAction: DismissingAction): BannerBuilder;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  dismissingAction | [DismissingAction](./foundation-notifications.dismissingaction.md) | [DismissingAction](./foundation-notifications.dismissingaction.md) |
+
+**Returns:**
+
+[BannerBuilder](./foundation-notifications.bannerbuilder.md)
+
+

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

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

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

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [ConfirmingAction](./foundation-notifications.confirmingaction.md)
+
+## ConfirmingAction interface
+
+Interface for Confirming Action configuration
+
+**Signature:**
+
+```typescript
+export interface ConfirmingAction 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [action](./foundation-notifications.confirmingaction.action.md) | <code>readonly</code> | Function |  |
+|  [label](./foundation-notifications.confirmingaction.label.md) | <code>readonly</code> | String |  |
+

package/docs/api/foundation-notifications.dialog.confirmingactions.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; [Dialog](./foundation-notifications.dialog.md) &gt; [confirmingActions](./foundation-notifications.dialog.confirmingactions.md)
+
+## Dialog.confirmingActions property
+
+**Signature:**
+
+```typescript
+readonly confirmingActions?: Array<ConfirmingAction>;
+```

package/docs/api/foundation-notifications.dialog.dismissingaction.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; [Dialog](./foundation-notifications.dialog.md) &gt; [dismissingAction](./foundation-notifications.dialog.dismissingaction.md)
+
+## Dialog.dismissingAction property
+
+**Signature:**
+
+```typescript
+readonly dismissingAction?: DismissingAction;
+```

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

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [Dialog](./foundation-notifications.dialog.md)
+
+## Dialog interface
+
+Interface for Dialog configuration
+
+**Signature:**
+
+```typescript
+export interface Dialog 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [confirmingActions?](./foundation-notifications.dialog.confirmingactions.md) | <code>readonly</code> | Array&lt;[ConfirmingAction](./foundation-notifications.confirmingaction.md)<!-- -->&gt; | _(Optional)_ |
+|  [dismissingAction?](./foundation-notifications.dialog.dismissingaction.md) | <code>readonly</code> | [DismissingAction](./foundation-notifications.dismissingaction.md) | _(Optional)_ |
+

package/docs/api/foundation-notifications.dialogbuilder.build.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-notifications](./foundation-notifications.md) &gt; [DialogBuilder](./foundation-notifications.dialogbuilder.md) &gt; [build](./foundation-notifications.dialogbuilder.build.md)
+
+## DialogBuilder.build() method
+
+Build Dialog
+
+**Signature:**
+
+```typescript
+build(): Dialog;
+```
+**Returns:**
+
+[Dialog](./foundation-notifications.dialog.md)
+
+Dialog
+