@genesislcap/foundation-errors 14.408.0 → 14.409.0

package/docs/api/foundation-errors.snackbarbuilder.md

@@ -1,76 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [SnackbarBuilder](./foundation-errors.snackbarbuilder.md)
-
-## SnackbarBuilder class
-
-SnackbarBuilder to build Snackbar
-
-**Signature:**
-
-```typescript
-export declare class SnackbarBuilder 
-```
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[build()](./foundation-errors.snackbarbuilder.build.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Build snackbar
-
-
-</td></tr>
-<tr><td>
-
-[withConfirmingAction(confirmingAction)](./foundation-errors.snackbarbuilder.withconfirmingaction.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Add confirming action to snackbar
-
-
-</td></tr>
-<tr><td>
-
-[withType(type)](./foundation-errors.snackbarbuilder.withtype.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Add type to snackbar, if the type is anything other than 'error' do not add it
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-errors.snackbarbuilder.withconfirmingaction.md

@@ -1,55 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [SnackbarBuilder](./foundation-errors.snackbarbuilder.md) &gt; [withConfirmingAction](./foundation-errors.snackbarbuilder.withconfirmingaction.md)
-
-## SnackbarBuilder.withConfirmingAction() method
-
-Add confirming action to snackbar
-
-**Signature:**
-
-```typescript
-withConfirmingAction(confirmingAction: ConfirmingAction): SnackbarBuilder;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-confirmingAction
-
-
-</td><td>
-
-[ConfirmingAction](./foundation-errors.confirmingaction.md)
-
-
-</td><td>
-
-[ConfirmingAction](./foundation-errors.confirmingaction.md)
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-[SnackbarBuilder](./foundation-errors.snackbarbuilder.md)
-
-

package/docs/api/foundation-errors.snackbarbuilder.withtype.md

@@ -1,55 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [SnackbarBuilder](./foundation-errors.snackbarbuilder.md) &gt; [withType](./foundation-errors.snackbarbuilder.withtype.md)
-
-## SnackbarBuilder.withType() method
-
-Add type to snackbar, if the type is anything other than 'error' do not add it
-
-**Signature:**
-
-```typescript
-withType(type: SnackbarType): SnackbarBuilder;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-type
-
-
-</td><td>
-
-[SnackbarType](./foundation-errors.snackbartype.md)
-
-
-</td><td>
-
-[SnackbarType](./foundation-errors.snackbartype.md)
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-[SnackbarBuilder](./foundation-errors.snackbarbuilder.md)
-
-

package/docs/api/foundation-errors.snackbartype.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [SnackbarType](./foundation-errors.snackbartype.md)
-
-## SnackbarType type
-
-type for snackbar type
-
-**Signature:**
-
-```typescript
-export type SnackbarType = 'error' | 'success';
-```

package/docs/api/index.md

@@ -1,30 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md)
-
-## API Reference
-
-## Packages
-
-<table><thead><tr><th>
-
-Package
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[@genesislcap/foundation-errors](./foundation-errors.md)
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api-report copy.md

@@ -1,202 +0,0 @@
-## API Report File for "@genesislcap/foundation-errors"
-
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
-
-```ts
-
-import { LogLevel } from '@genesislcap/foundation-logger';
-
-// @public
-export interface ConfirmingAction {
-    // (undocumented)
-    readonly action: Function;
-    // (undocumented)
-    readonly label: String;
-}
-
-// @public
-export interface DismissingAction {
-    // (undocumented)
-    readonly action?: Function;
-    // (undocumented)
-    readonly label: String;
-}
-
-// @public
-export interface ErrorBanner {
-    // (undocumented)
-    readonly confirmingActions?: Array<ConfirmingAction>;
-    // (undocumented)
-    readonly dismissingAction?: DismissingAction;
-}
-
-// @public
-export class ErrorBannerBuilder {
-    build(): ErrorBanner;
-    withConfirmingAction(confirmingAction: ConfirmingAction): ErrorBannerBuilder;
-    withDismissingAction(dismissingAction: DismissingAction): ErrorBannerBuilder;
-}
-
-// @public
-export enum ErrorBoundaryEvent {
-    // (undocumented)
-    ERROR_BOUNDARY_EVENT = "error-boundary-event"
-}
-
-// @public
-export class ErrorBuilder {
-    build(): ErrorStructure;
-    withAlert(alert: boolean): ErrorBuilder;
-    withBanner(banner: ErrorBanner): ErrorBuilder;
-    withDialog(dialog: ErrorDialog): ErrorBuilder;
-    withErrorDetails(errorDetails: string): ErrorBuilder;
-    withLogLevel(logLevel: LogLevel): ErrorBuilder;
-    withNotification(notification: ErrorNotification): ErrorBuilder;
-    withSnackbar(snackbar: Snackbar): ErrorBuilder;
-    withTitle(title: string): ErrorBuilder;
-}
-
-// @public
-export interface ErrorDialog {
-    // (undocumented)
-    readonly confirmingActions?: Array<ConfirmingAction>;
-    // (undocumented)
-    readonly dismissingAction?: DismissingAction;
-}
-
-// @public
-export class ErrorDialogBuilder {
-    build(): ErrorDialog;
-    withConfirmingAction(confirmingAction: ConfirmingAction): ErrorDialogBuilder;
-    withDismissingAction(dismissingAction: DismissingAction): ErrorDialogBuilder;
-}
-
-// Warning: (ae-internal-missing-underscore) The name "ErrorDialogElement" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal (undocumented)
-export type ErrorDialogElement = ErrorElement & {
-    show: Function;
-};
-
-// Warning: (ae-internal-missing-underscore) The name "ErrorElement" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal (undocumented)
-export type ErrorElement = HTMLElement & {
-    error: ErrorStructure;
-};
-
-// @public
-export interface ErrorNotification {
-    // (undocumented)
-    readonly autoClose?: boolean;
-    // (undocumented)
-    readonly closeTimeout?: number;
-    // (undocumented)
-    readonly position?: ErrorNotificationPosition;
-    // (undocumented)
-    readonly type?: ErrorNotificationType;
-}
-
-// @public
-export type ErrorNotificationPosition = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
-
-// @public
-export type ErrorNotificationType = 'warning' | 'success';
-
-// @public
-export interface ErrorStructure {
-    // (undocumented)
-    readonly config?: {
-        readonly logLevel?: LogLevel;
-        readonly alert?: boolean;
-        readonly notification?: ErrorNotification;
-        readonly banner?: ErrorBanner;
-        readonly snackbar?: Snackbar;
-        readonly dialog?: ErrorDialog;
-    };
-    // (undocumented)
-    readonly errorDetails: string;
-    // (undocumented)
-    readonly logLevel?: LogLevel;
-    // (undocumented)
-    readonly title: string;
-}
-
-// @public
-export const getErrorBannerAnchor: (element: any) => HTMLElement | null;
-
-// @public
-export const getErrorBannerBuilder: () => ErrorBannerBuilder;
-
-// @public
-export const getErrorBuilder: () => ErrorBuilder;
-
-// @public
-export const getErrorContainer: (id: string, tagName: String) => HTMLElement;
-
-// @public
-export const getErrorDetails: (details: ErrorStructure) => string;
-
-// @public
-export const getErrorDialogBuilder: () => ErrorDialogBuilder;
-
-// @public
-export const getLoglevel: (details: ErrorStructure) => LogLevel;
-
-// @public
-export const getNotificationBuilder: () => NotificationBuilder;
-
-// @public
-export const getSnackbarBuilder: () => SnackbarBuilder;
-
-// @public
-export class NotificationBuilder {
-    build(): ErrorNotification;
-    withAutoClose(autoClose: boolean): NotificationBuilder;
-    withCloseTimeout(closeTimeout: number): NotificationBuilder;
-    withPosition(position: ErrorNotificationPosition): NotificationBuilder;
-    withType(type: ErrorNotificationType): NotificationBuilder;
-}
-
-// @public
-export const showBanner: (error: ErrorStructure, tagName: String, errorBoundary: 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: (error: ErrorStructure, tagName: String) => void;
-
-// @public
-export const showError: (error: ErrorStructure, tagName: String, errorBoundary?: HTMLElement) => void;
-
-// Warning: (ae-internal-missing-underscore) The name "showNotification" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal
-export const showNotification: (error: ErrorStructure, 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: (error: ErrorStructure, tagName: String) => void;
-
-// @public
-export interface Snackbar {
-    // (undocumented)
-    readonly confirmingActions?: Array<ConfirmingAction>;
-    // (undocumented)
-    readonly type?: SnackbarType;
-}
-
-// @public
-export class SnackbarBuilder {
-    build(): Snackbar;
-    withConfirmingAction(confirmingAction: ConfirmingAction): SnackbarBuilder;
-    withType(type: SnackbarType): SnackbarBuilder;
-}
-
-// @public
-export type SnackbarType = 'error';
-
-// (No @packageDocumentation comment for this package)
-
-```

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

@@ -1,202 +0,0 @@
-## API Report File for "@genesislcap/foundation-errors"
-
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
-
-```ts
-
-import { LogLevel } from '@genesislcap/foundation-logger';
-
-// @public
-export interface ConfirmingAction {
-    // (undocumented)
-    readonly action: Function;
-    // (undocumented)
-    readonly label: String;
-}
-
-// @public
-export interface DismissingAction {
-    // (undocumented)
-    readonly action?: Function;
-    // (undocumented)
-    readonly label: String;
-}
-
-// @public
-export interface ErrorBanner {
-    // (undocumented)
-    readonly confirmingActions?: Array<ConfirmingAction>;
-    // (undocumented)
-    readonly dismissingAction?: DismissingAction;
-}
-
-// @public
-export class ErrorBannerBuilder {
-    build(): ErrorBanner;
-    withConfirmingAction(confirmingAction: ConfirmingAction): ErrorBannerBuilder;
-    withDismissingAction(dismissingAction: DismissingAction): ErrorBannerBuilder;
-}
-
-// @public
-export enum ErrorBoundaryEvent {
-    // (undocumented)
-    ERROR_BOUNDARY_EVENT = "error-boundary-event"
-}
-
-// @public
-export class ErrorBuilder {
-    build(): ErrorStructure;
-    withAlert(alert: boolean): ErrorBuilder;
-    withBanner(banner: ErrorBanner): ErrorBuilder;
-    withDialog(dialog: ErrorDialog): ErrorBuilder;
-    withErrorDetails(errorDetails: string): ErrorBuilder;
-    withLogLevel(logLevel: LogLevel): ErrorBuilder;
-    withNotification(notification: ErrorNotification): ErrorBuilder;
-    withSnackbar(snackbar: Snackbar): ErrorBuilder;
-    withTitle(title: string): ErrorBuilder;
-}
-
-// @public
-export interface ErrorDialog {
-    // (undocumented)
-    readonly confirmingActions?: Array<ConfirmingAction>;
-    // (undocumented)
-    readonly dismissingAction?: DismissingAction;
-}
-
-// @public
-export class ErrorDialogBuilder {
-    build(): ErrorDialog;
-    withConfirmingAction(confirmingAction: ConfirmingAction): ErrorDialogBuilder;
-    withDismissingAction(dismissingAction: DismissingAction): ErrorDialogBuilder;
-}
-
-// Warning: (ae-internal-missing-underscore) The name "ErrorDialogElement" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal (undocumented)
-export type ErrorDialogElement = ErrorElement & {
-    show: Function;
-};
-
-// Warning: (ae-internal-missing-underscore) The name "ErrorElement" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal (undocumented)
-export type ErrorElement = HTMLElement & {
-    error: ErrorStructure;
-};
-
-// @public
-export interface ErrorNotification {
-    // (undocumented)
-    readonly autoClose?: boolean;
-    // (undocumented)
-    readonly closeTimeout?: number;
-    // (undocumented)
-    readonly position?: ErrorNotificationPosition;
-    // (undocumented)
-    readonly type?: ErrorNotificationType;
-}
-
-// @public
-export type ErrorNotificationPosition = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
-
-// @public
-export type ErrorNotificationType = 'warning' | 'success';
-
-// @public
-export interface ErrorStructure {
-    // (undocumented)
-    readonly config?: {
-        readonly logLevel?: LogLevel;
-        readonly alert?: boolean;
-        readonly notification?: ErrorNotification;
-        readonly banner?: ErrorBanner;
-        readonly snackbar?: Snackbar;
-        readonly dialog?: ErrorDialog;
-    };
-    // (undocumented)
-    readonly errorDetails: string;
-    // (undocumented)
-    readonly logLevel?: LogLevel;
-    // (undocumented)
-    readonly title: string;
-}
-
-// @public
-export const getErrorBannerAnchor: (element: any) => HTMLElement | null;
-
-// @public
-export const getErrorBannerBuilder: () => ErrorBannerBuilder;
-
-// @public
-export const getErrorBuilder: () => ErrorBuilder;
-
-// @public
-export const getErrorContainer: (id: string, tagName: String) => HTMLElement;
-
-// @public
-export const getErrorDetails: (details: ErrorStructure) => string;
-
-// @public
-export const getErrorDialogBuilder: () => ErrorDialogBuilder;
-
-// @public
-export const getLoglevel: (details: ErrorStructure) => LogLevel;
-
-// @public
-export const getNotificationBuilder: () => NotificationBuilder;
-
-// @public
-export const getSnackbarBuilder: () => SnackbarBuilder;
-
-// @public
-export class NotificationBuilder {
-    build(): ErrorNotification;
-    withAutoClose(autoClose: boolean): NotificationBuilder;
-    withCloseTimeout(closeTimeout: number): NotificationBuilder;
-    withPosition(position: ErrorNotificationPosition): NotificationBuilder;
-    withType(type: ErrorNotificationType): NotificationBuilder;
-}
-
-// @public
-export const showBanner: (error: ErrorStructure, tagName: String, errorBoundary: 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: (error: ErrorStructure, tagName: String) => void;
-
-// @public
-export const showError: (error: ErrorStructure, tagName: String, errorBoundary?: HTMLElement) => void;
-
-// Warning: (ae-internal-missing-underscore) The name "showNotification" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal
-export const showNotification: (error: ErrorStructure, 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: (error: ErrorStructure, tagName: String) => void;
-
-// @public
-export interface Snackbar {
-    // (undocumented)
-    readonly confirmingActions?: Array<ConfirmingAction>;
-    // (undocumented)
-    readonly type?: SnackbarType;
-}
-
-// @public
-export class SnackbarBuilder {
-    build(): Snackbar;
-    withConfirmingAction(confirmingAction: ConfirmingAction): SnackbarBuilder;
-    withType(type: SnackbarType): SnackbarBuilder;
-}
-
-// @public
-export type SnackbarType = 'error' | 'success';
-
-// (No @packageDocumentation comment for this package)
-
-```