@genesislcap/foundation-notifications 14.408.0 → 14.409.0

package/docs/api-report.md.api.md

@@ -1,428 +0,0 @@
-## API Report File for "@genesislcap/foundation-notifications"
-
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
-
-```ts
-
-import { GenesisElement } from '@genesislcap/web-core';
-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)
-    readonly confirmingActions?: Array<ConfirmingAction>;
-    // (undocumented)
-    readonly dismissingAction?: DismissingAction;
-}
-
-// @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 const configureNotifications: (config: Partial<NotifyContainerConfig>) => void;
-
-// @public
-export interface ConfirmingAction {
-    // (undocumented)
-    readonly action: Function;
-    // (undocumented)
-    readonly label: String;
-}
-
-// @public
-export interface Dialog {
-    // (undocumented)
-    readonly confirmingActions?: Array<ConfirmingAction>;
-    // (undocumented)
-    readonly dismissingAction?: DismissingAction;
-}
-
-// @public @deprecated
-export class DialogBuilder {
-    // @deprecated
-    build(): Dialog;
-    // @deprecated
-    withConfirmingAction(confirmingAction: ConfirmingAction): DialogBuilder;
-    // @deprecated
-    withDismissingAction(dismissingAction: DismissingAction): DialogBuilder;
-}
-
-// Warning: (ae-internal-missing-underscore) The name "DialogElement" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal (undocumented)
-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)
-    readonly action?: Function;
-    // (undocumented)
-    readonly label: String;
-}
-
-// @public
-export const getBannerAnchor: (element: any) => HTMLElement | null;
-
-// @public @deprecated
-export const getBannerBuilder: () => BannerBuilder;
-
-// @public @deprecated
-export const getDialogBuilder: () => DialogBuilder;
-
-// @public
-export const getLoglevel: (details: NotificationStructure) => LogLevel;
-
-// @public @deprecated
-export const getNotificationBuilder: () => NotificationBuilder;
-
-// @public
-export const getNotificationContainer: (id: string, tagName: String) => HTMLElement;
-
-// @public
-export const getNotificationDetails: (details: NotificationStructure) => string;
-
-// @public @deprecated
-export const getSnackbarBuilder: () => SnackbarBuilder;
-
-// @public @deprecated
-export const getToastBuilder: () => ToastBuilder;
-
-// @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;
-}
-
-// @public
-export interface NotificationDataRow {
-    // (undocumented)
-    ALERT_ID: string;
-    // (undocumented)
-    CREATED_AT: number;
-    // (undocumented)
-    DETAILS: {
-        OPERATION: string;
-        ROW_REF: string;
-    };
-    // (undocumented)
-    EXPIRY?: number;
-    // (undocumented)
-    HEADER: string;
-    // (undocumented)
-    MESSAGE: string;
-    // (undocumented)
-    NOTIFY_SEVERITY: NotificationSeverity;
-    // (undocumented)
-    SENDER?: null;
-    // (undocumented)
-    TABLE_ENTITY_ID: string;
-    // (undocumented)
-    TOPIC: string;
-    // (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)
-export type NotificationElement = HTMLElement & {
-    notification: NotificationStructure;
-};
-
-// @public
-export enum NotificationEvent {
-    // (undocumented)
-    NOTIFICATION_EVENT = "notification-event"
-}
-
-// @public
-export type NotificationSeverity = 'Information' | 'Warning' | 'Serious' | 'Critical';
-
-// @public
-export interface NotificationStructure {
-    // (undocumented)
-    readonly body: string;
-    // (undocumented)
-    readonly config?: {
-        readonly logLevel?: LogLevel;
-        readonly alert?: boolean;
-        readonly toast?: Toast;
-        readonly banner?: Banner;
-        readonly snackbar?: Snackbar;
-        readonly dialog?: Dialog;
-    };
-    // (undocumented)
-    readonly createdAt?: Date;
-    // (undocumented)
-    readonly iconName?: string;
-    // (undocumented)
-    readonly logLevel?: LogLevel;
-    // (undocumented)
-    readonly title?: string;
-}
-
-// @public
-export type NotificationType = 'error' | 'warning' | 'success';
-
-// @public (undocumented)
-export class NotifyContainer extends GenesisElement implements NotifyContainerConfig {
-    // (undocumented)
-    allowCloseAll: boolean;
-    // (undocumented)
-    allowManualCollapse: boolean;
-    // @internal (undocumented)
-    connectedCallback(): void;
-    // (undocumented)
-    designSystemPrefix: string;
-    // (undocumented)
-    disconnectedCallback(): void;
-    // @internal (undocumented)
-    handleCloseAll(): void;
-    // @internal (undocumented)
-    handleContainerClick(): void;
-    // @internal (undocumented)
-    handleToggleCollapse(): void;
-    // (undocumented)
-    notificationInterval: number;
-    // @internal (undocumented)
-    notificationIntervalChanged(_oldValue: number, newValue: number): void;
-    // (undocumented)
-    position: ToastPosition;
-    // (undocumented)
-    showCount: boolean;
-    // (undocumented)
-    slottedNodes: Node[];
-    // @internal (undocumented)
-    slottedNodesChanged(): void;
-    // (undocumented)
-    sortFn?: (a: HTMLElement, b: HTMLElement) => number;
-    // @internal (undocumented)
-    sortFnChanged(): void;
-    // (undocumented)
-    stackCollapsed: boolean;
-    // (undocumented)
-    stackThreshold: number;
-}
-
-// @public (undocumented)
-export interface NotifyContainerConfig {
-    allowCloseAll: boolean;
-    allowManualCollapse: boolean;
-    designSystemPrefix: string;
-    notificationInterval: number;
-    position: ToastPosition;
-    showCount: boolean;
-    sortFn?: (a: HTMLElement, b: HTMLElement) => number;
-    stackThreshold: number;
-}
-
-// @public
-export const showBanner: (notificationStructure: NotificationStructure, tagName: String, notificationBoundary: HTMLElement) => void;
-
-// 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: (notificationStructure: NotificationStructure, tagName: String, notificationBoundary?: HTMLElement) => 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, notificationBoundary?: HTMLElement) => void;
-
-// @public
-export const showNotificationSnackbar: (configuration: SnackbarStructure, tagName: String) => void;
-
-// @public
-export const showNotificationToast: (configuration: ToastStructure, tagName: String, notificationContainer?: HTMLElement) => 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: (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
-//
-// @internal
-export const showToast: (notificationStructure: NotificationStructure, tagName: String, notificationContainer?: HTMLElement) => void;
-
-// @public
-export interface Snackbar {
-    // (undocumented)
-    readonly autoClose?: boolean;
-    // (undocumented)
-    readonly closeTimeout?: number;
-    // (undocumented)
-    readonly confirmingActions?: Array<ConfirmingAction>;
-    // (undocumented)
-    readonly type?: SnackbarType;
-}
-
-// @public @deprecated
-export class SnackbarBuilder {
-    // @deprecated
-    build(): Snackbar;
-    // @deprecated
-    withConfirmingAction(confirmingAction: ConfirmingAction): SnackbarBuilder;
-    // @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' | 'success';
-
-// @public
-export const sortNotificationBySeverity: (a: HTMLElement, b: HTMLElement) => number;
-
-// @public
-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;
-}
-
-// @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;
-}
-
-// @public
-export interface ToastButton {
-    // (undocumented)
-    action({ details, buttonElement, toastElement, }: {
-        details: NotificationDataRow;
-        buttonElement: HTMLElement;
-        toastElement: any;
-    }): 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';
-
-// @public
-export interface ToastStructure {
-    // (undocumented)
-    readonly body: string;
-    // (undocumented)
-    readonly createdAt?: Date;
-    // (undocumented)
-    readonly iconName?: string;
-    // (undocumented)
-    readonly logLevel?: LogLevel;
-    // (undocumented)
-    readonly title: string;
-    // (undocumented)
-    readonly toast?: Toast;
-}
-
-// (No @packageDocumentation comment for this package)
-
-```