@genesislcap/foundation-errors 10.3.1 → 11.3.1

package/dist/foundation-errors.d.ts

@@ -1,32 +1,73 @@
 import { LogLevel } from '@genesislcap/foundation-utils';
 
+/**
+ * Interface for Confirming Action configuration
+ * @public
+ */
 export declare interface ConfirmingAction {
     readonly label: String;
     readonly action: Function;
 }
 
+/**
+ * Interface for Dismissing Action configuration
+ * @public
+ */
 export declare interface DismissingAction {
     readonly label: String;
     readonly action?: Function;
 }
 
+/**
+ * Interface for Error Banner configuration
+ * @public
+ */
 export declare interface ErrorBanner {
     readonly dismissingAction?: DismissingAction;
     readonly confirmingActions?: Array<ConfirmingAction>;
 }
 
+/**
+ * ErrorBannerBuilder to build ErrorBanner
+ * @public
+ */
 export declare class ErrorBannerBuilder {
     private dismissingAction;
     private confirmingActions;
+    /**
+     * Add dismissing action to ErrorBanner
+     * @public
+     * @param dismissingAction - {@link DismissingAction}
+     * @returns
+     */
     withDismissingAction(dismissingAction: DismissingAction): ErrorBannerBuilder;
+    /**
+     * Add confirming action to ErrorBanner
+     * @public
+     * @param confirmingAction - {@link ConfirmingAction}
+     * @returns
+     */
     withConfirmingAction(confirmingAction: ConfirmingAction): ErrorBannerBuilder;
+    /**
+     * Build ErrorBanner
+     * @public
+     * @returns ErrorBanner
+     */
     build(): ErrorBanner;
 }
 
+/**
+ * @public
+ * enum for different types of error boundary events
+ */
 export declare enum ErrorBoundaryEvent {
     ERROR_BOUNDARY_EVENT = "error-boundary-event"
 }
 
+/**
+ * ErrorBuilder to build ErrorStructure
+ * @public
+ */
 export declare class ErrorBuilder {
     private title;
     private errorDetails;
@@ -36,44 +77,141 @@ export declare class ErrorBuilder {
     private banner;
     private snackbar;
     private dialog;
+    /**
+     * Add title to error
+     * @public
+     * @param title - string
+     * @returns
+     */
     withTitle(title: string): ErrorBuilder;
+    /**
+     * Add error details to error
+     * @public
+     * @param errorDetails - string
+     * @returns
+     */
     withErrorDetails(errorDetails: string): ErrorBuilder;
+    /**
+     * Add log level to error
+     * @public
+     * @returns
+     */
     withLogLevel(logLevel: LogLevel): ErrorBuilder;
+    /**
+     * Add alert to error
+     * @public
+     * @param alert - boolean
+     * @returns
+     */
     withAlert(alert: boolean): ErrorBuilder;
+    /**
+     * Add notification to error
+     * @public
+     * @param notification - {@link ErrorNotification}
+     * @returns
+     */
     withNotification(notification: ErrorNotification): ErrorBuilder;
+    /**
+     * Add banner to error
+     * @public
+     * @param banner - {@link ErrorBanner}
+     * @returns
+     */
     withBanner(banner: ErrorBanner): ErrorBuilder;
+    /**
+     * Add snackbar to error
+     * @public
+     * @param snackbar - {@link Snackbar}
+     * @returns
+     */
     withSnackbar(snackbar: Snackbar): ErrorBuilder;
+    /**
+     * Add dialog to error
+     * @public
+     * @param dialog - {@link ErrorDialog}
+     * @returns
+     */
     withDialog(dialog: ErrorDialog): ErrorBuilder;
+    /**
+     * Build ErrorStructure
+     * @public
+     * @returns
+     */
     build(): ErrorStructure;
 }
 
+/**
+ * Interface for Error Dialog configuration
+ * @public
+ */
 export declare interface ErrorDialog {
     readonly confirmingActions?: Array<ConfirmingAction>;
     readonly dismissingAction?: DismissingAction;
 }
 
+/**
+ * ErrorDialogBuilder class
+ * @public
+ */
 export declare class ErrorDialogBuilder {
     private dismissingAction;
     private confirmingActions;
+    /**
+     * Add dismissing action to ErrorDialog
+     * @public
+     * @param dismissingAction - {@link DismissingAction}
+     * @returns
+     */
     withDismissingAction(dismissingAction: DismissingAction): ErrorDialogBuilder;
+    /**
+     * Add confirming action to ErrorDialog
+     * @public
+     * @param confirmingAction - {@link ConfirmingAction}
+     * @returns
+     */
     withConfirmingAction(confirmingAction: ConfirmingAction): ErrorDialogBuilder;
+    /**
+     * Build ErrorDialog
+     * @public
+     * @returns ErrorDialog
+     */
     build(): ErrorDialog;
 }
 
+/**
+ * @internal
+ */
 export declare type ErrorDialogElement = ErrorElement & {
     show: Function;
 };
 
+/**
+ * @internal
+ */
 export declare type ErrorElement = HTMLElement & {
     error: ErrorStructure;
 };
 
+/**
+ * Interface for Error Notification configuration
+ * @public
+ */
 export declare interface ErrorNotification {
-    readonly type?: 'warning' | 'success' | '';
+    readonly type?: ErrorNotificationType;
     readonly autoClose?: boolean;
     readonly closeTimeout?: number;
 }
 
+/**
+ * @public
+ * type for error notification type
+ */
+export declare type ErrorNotificationType = 'warning' | 'success';
+
+/**
+ * Interface for Error Structure
+ *  @public
+ */
 export declare interface ErrorStructure {
     readonly title: string;
     readonly errorDetails: string;
@@ -91,8 +229,16 @@ export declare interface ErrorStructure {
     };
 }
 
+/**
+ * Get error banner builder instance
+ * @public
+ */
 export declare const getErrorBannerBuilder: () => ErrorBannerBuilder;
 
+/**
+ * Returns a new ErrorBuilder instance
+ * @public
+ */
 export declare const getErrorBuilder: () => ErrorBuilder;
 
 /**
@@ -112,6 +258,10 @@ export declare const getErrorContainer: (id: string, tagName: String) => HTMLEle
  */
 export declare const getErrorDetails: (details: ErrorStructure) => string;
 
+/**
+ * Returns an instance of ErrorDialogBuilder
+ * @public
+ */
 export declare const getErrorDialogBuilder: () => ErrorDialogBuilder;
 
 /**
@@ -122,23 +272,57 @@ export declare const getErrorDialogBuilder: () => ErrorDialogBuilder;
  */
 export declare const getLoglevel: (details: ErrorStructure) => LogLevel;
 
+/**
+ * Get notification builder instance
+ * @public
+ */
 export declare const getNotificationBuilder: () => NotificationBuilder;
 
+/**
+ * Get snackbar builder instance
+ * @public
+ */
 export declare const getSnackbarBuilder: () => SnackbarBuilder;
 
+/**
+ * NotificationBuilder to build ErrorNotification
+ * @public
+ */
 export declare class NotificationBuilder {
     private autoClose;
     private closeTimeout;
     private type;
+    /**
+     * Add auto close to notification
+     * @public
+     * @param autoClose - boolean
+     * @returns
+     */
     withAutoClose(autoClose: boolean): NotificationBuilder;
+    /**
+     * Add close timeout to notification
+     * @public
+     * @param closeTimeout - number
+     * @returns
+     */
     withCloseTimeout(closeTimeout: number): NotificationBuilder;
-    withType(type: 'warning' | 'success' | ''): NotificationBuilder;
+    /**
+     * Add type to notification, if the type is anything other than 'warning' or 'success' do not add it
+     * @public
+     * @param type - {@link ErrorNotificationType}
+     * @returns
+     */
+    withType(type: ErrorNotificationType): NotificationBuilder;
+    /**
+     * Build notification
+     * @returns ErrorNotification
+     */
     build(): ErrorNotification;
 }
 
 /**
  * Shows the error dialog
- * @public
+ * @internal
  * @param error - The ErrorStructure object
  * @param tagName - The tag name to create prefix for the design system provider & error component
  * @returns
@@ -156,7 +340,7 @@ export declare const showError: (error: ErrorStructure, tagName: String) => void
 
 /**
  * Shows the error notification
- * @public
+ * @internal
  * @param error - The ErrorStructure object
  * @param tagName - The tag name to create prefix for the design system provider & error component
  * @returns
@@ -165,41 +349,55 @@ export declare const showNotification: (error: ErrorStructure, tagName: String)
 
 /**
  * Shows the snackbar
- * @public
+ * @internal
  * @param error - The ErrorStructure object
  * @param tagName - The tag name to create prefix for the design system provider & error component
  * @returns
  * */
 export declare const showSnackbar: (error: ErrorStructure, tagName: String) => void;
 
+/**
+ * Interface for Error Snackbar configuration
+ * @public
+ */
 export declare interface Snackbar {
-    readonly type?: 'error' | '';
+    readonly type?: SnackbarType;
     readonly confirmingActions?: Array<ConfirmingAction>;
 }
 
+/**
+ * SnackbarBuilder to build Snackbar
+ * @public
+ */
 export declare class SnackbarBuilder {
     private confirmingActions;
     private type;
     /**
-     * Add type to snackbar
+     * Add type to snackbar, if the type is anything other than 'error' do not add it
      * @public
-     * @param type
+     * @param type - {@link SnackbarType}
      * @returns
      */
-    withType(type: 'error' | ''): SnackbarBuilder;
+    withType(type: SnackbarType): SnackbarBuilder;
     /**
      * Add confirming action to snackbar
      * @public
-     * @param confirmingAction
+     * @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';
+
 export { }

package/docs/.gitattributes

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

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

@@ -4,6 +4,8 @@
 
 ## ConfirmingAction interface
 
+Interface for Confirming Action configuration
+
 **Signature:**
 
 ```typescript

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

@@ -4,6 +4,8 @@
 
 ## DismissingAction interface
 
+Interface for Dismissing Action configuration
+
 **Signature:**
 
 ```typescript

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

@@ -4,6 +4,8 @@
 
 ## ErrorBanner interface
 
+Interface for Error Banner configuration
+
 **Signature:**
 
 ```typescript

package/docs/api/foundation-errors.errorbannerbuilder.build.md

@@ -4,6 +4,8 @@
 
 ## ErrorBannerBuilder.build() method
 
+Build ErrorBanner
+
 **Signature:**
 
 ```typescript
@@ -13,3 +15,5 @@ build(): ErrorBanner;
 
 [ErrorBanner](./foundation-errors.errorbanner.md)
 
+ErrorBanner
+

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

@@ -4,6 +4,8 @@
 
 ## ErrorBannerBuilder class
 
+ErrorBannerBuilder to build ErrorBanner
+
 **Signature:**
 
 ```typescript
@@ -14,7 +16,7 @@ export declare class ErrorBannerBuilder
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
-|  [build()](./foundation-errors.errorbannerbuilder.build.md) |  |  |
-|  [withConfirmingAction(confirmingAction)](./foundation-errors.errorbannerbuilder.withconfirmingaction.md) |  |  |
-|  [withDismissingAction(dismissingAction)](./foundation-errors.errorbannerbuilder.withdismissingaction.md) |  |  |
+|  [build()](./foundation-errors.errorbannerbuilder.build.md) |  | Build ErrorBanner |
+|  [withConfirmingAction(confirmingAction)](./foundation-errors.errorbannerbuilder.withconfirmingaction.md) |  | Add confirming action to ErrorBanner |
+|  [withDismissingAction(dismissingAction)](./foundation-errors.errorbannerbuilder.withdismissingaction.md) |  | Add dismissing action to ErrorBanner |
 

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

@@ -4,6 +4,8 @@
 
 ## ErrorBannerBuilder.withConfirmingAction() method
 
+Add confirming action to ErrorBanner
+
 **Signature:**
 
 ```typescript
@@ -14,9 +16,10 @@ withConfirmingAction(confirmingAction: ConfirmingAction): ErrorBannerBuilder;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  confirmingAction | [ConfirmingAction](./foundation-errors.confirmingaction.md) |  |
+|  confirmingAction | [ConfirmingAction](./foundation-errors.confirmingaction.md) | [ConfirmingAction](./foundation-errors.confirmingaction.md) |
 
 **Returns:**
 
 [ErrorBannerBuilder](./foundation-errors.errorbannerbuilder.md)
 
+

package/docs/api/foundation-errors.errorbannerbuilder.withdismissingaction.md

@@ -4,6 +4,8 @@
 
 ## ErrorBannerBuilder.withDismissingAction() method
 
+Add dismissing action to ErrorBanner
+
 **Signature:**
 
 ```typescript
@@ -14,9 +16,10 @@ withDismissingAction(dismissingAction: DismissingAction): ErrorBannerBuilder;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  dismissingAction | [DismissingAction](./foundation-errors.dismissingaction.md) |  |
+|  dismissingAction | [DismissingAction](./foundation-errors.dismissingaction.md) | [DismissingAction](./foundation-errors.dismissingaction.md) |
 
 **Returns:**
 
 [ErrorBannerBuilder](./foundation-errors.errorbannerbuilder.md)
 
+

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

@@ -4,6 +4,8 @@
 
 ## ErrorBoundaryEvent enum
 
+enum for different types of error boundary events
+
 **Signature:**
 
 ```typescript

package/docs/api/foundation-errors.errorbuilder.build.md

@@ -4,6 +4,8 @@
 
 ## ErrorBuilder.build() method
 
+Build ErrorStructure
+
 **Signature:**
 
 ```typescript
@@ -13,3 +15,4 @@ build(): ErrorStructure;
 
 [ErrorStructure](./foundation-errors.errorstructure.md)
 
+

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

@@ -4,6 +4,8 @@
 
 ## ErrorBuilder class
 
+ErrorBuilder to build ErrorStructure
+
 **Signature:**
 
 ```typescript
@@ -14,13 +16,13 @@ export declare class ErrorBuilder
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
-|  [build()](./foundation-errors.errorbuilder.build.md) |  |  |
-|  [withAlert(alert)](./foundation-errors.errorbuilder.withalert.md) |  |  |
-|  [withBanner(banner)](./foundation-errors.errorbuilder.withbanner.md) |  |  |
-|  [withDialog(dialog)](./foundation-errors.errorbuilder.withdialog.md) |  |  |
-|  [withErrorDetails(errorDetails)](./foundation-errors.errorbuilder.witherrordetails.md) |  |  |
-|  [withLogLevel(logLevel)](./foundation-errors.errorbuilder.withloglevel.md) |  |  |
-|  [withNotification(notification)](./foundation-errors.errorbuilder.withnotification.md) |  |  |
-|  [withSnackbar(snackbar)](./foundation-errors.errorbuilder.withsnackbar.md) |  |  |
-|  [withTitle(title)](./foundation-errors.errorbuilder.withtitle.md) |  |  |
+|  [build()](./foundation-errors.errorbuilder.build.md) |  | Build ErrorStructure |
+|  [withAlert(alert)](./foundation-errors.errorbuilder.withalert.md) |  | Add alert to error |
+|  [withBanner(banner)](./foundation-errors.errorbuilder.withbanner.md) |  | Add banner to error |
+|  [withDialog(dialog)](./foundation-errors.errorbuilder.withdialog.md) |  | Add dialog to error |
+|  [withErrorDetails(errorDetails)](./foundation-errors.errorbuilder.witherrordetails.md) |  | Add error details to error |
+|  [withLogLevel(logLevel)](./foundation-errors.errorbuilder.withloglevel.md) |  | Add log level to error |
+|  [withNotification(notification)](./foundation-errors.errorbuilder.withnotification.md) |  | Add notification to error |
+|  [withSnackbar(snackbar)](./foundation-errors.errorbuilder.withsnackbar.md) |  | Add snackbar to error |
+|  [withTitle(title)](./foundation-errors.errorbuilder.withtitle.md) |  | Add title to error |
 

package/docs/api/foundation-errors.errorbuilder.withalert.md

@@ -4,6 +4,8 @@
 
 ## ErrorBuilder.withAlert() method
 
+Add alert to error
+
 **Signature:**
 
 ```typescript
@@ -14,9 +16,10 @@ withAlert(alert: boolean): ErrorBuilder;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  alert | boolean |  |
+|  alert | boolean | boolean |
 
 **Returns:**
 
 [ErrorBuilder](./foundation-errors.errorbuilder.md)
 
+

package/docs/api/foundation-errors.errorbuilder.withbanner.md

@@ -4,6 +4,8 @@
 
 ## ErrorBuilder.withBanner() method
 
+Add banner to error
+
 **Signature:**
 
 ```typescript
@@ -14,9 +16,10 @@ withBanner(banner: ErrorBanner): ErrorBuilder;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  banner | [ErrorBanner](./foundation-errors.errorbanner.md) |  |
+|  banner | [ErrorBanner](./foundation-errors.errorbanner.md) | [ErrorBanner](./foundation-errors.errorbanner.md) |
 
 **Returns:**
 
 [ErrorBuilder](./foundation-errors.errorbuilder.md)
 
+

package/docs/api/foundation-errors.errorbuilder.withdialog.md

@@ -4,6 +4,8 @@
 
 ## ErrorBuilder.withDialog() method
 
+Add dialog to error
+
 **Signature:**
 
 ```typescript
@@ -14,9 +16,10 @@ withDialog(dialog: ErrorDialog): ErrorBuilder;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  dialog | [ErrorDialog](./foundation-errors.errordialog.md) |  |
+|  dialog | [ErrorDialog](./foundation-errors.errordialog.md) | [ErrorDialog](./foundation-errors.errordialog.md) |
 
 **Returns:**
 
 [ErrorBuilder](./foundation-errors.errorbuilder.md)
 
+

package/docs/api/foundation-errors.errorbuilder.witherrordetails.md

@@ -4,6 +4,8 @@
 
 ## ErrorBuilder.withErrorDetails() method
 
+Add error details to error
+
 **Signature:**
 
 ```typescript
@@ -14,9 +16,10 @@ withErrorDetails(errorDetails: string): ErrorBuilder;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  errorDetails | string |  |
+|  errorDetails | string | string |
 
 **Returns:**
 
 [ErrorBuilder](./foundation-errors.errorbuilder.md)
 
+

package/docs/api/foundation-errors.errorbuilder.withloglevel.md

@@ -4,6 +4,8 @@
 
 ## ErrorBuilder.withLogLevel() method
 
+Add log level to error
+
 **Signature:**
 
 ```typescript
@@ -20,3 +22,4 @@ withLogLevel(logLevel: LogLevel): ErrorBuilder;
 
 [ErrorBuilder](./foundation-errors.errorbuilder.md)
 
+

package/docs/api/foundation-errors.errorbuilder.withnotification.md

@@ -4,6 +4,8 @@
 
 ## ErrorBuilder.withNotification() method
 
+Add notification to error
+
 **Signature:**
 
 ```typescript
@@ -14,9 +16,10 @@ withNotification(notification: ErrorNotification): ErrorBuilder;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  notification | [ErrorNotification](./foundation-errors.errornotification.md) |  |
+|  notification | [ErrorNotification](./foundation-errors.errornotification.md) | [ErrorNotification](./foundation-errors.errornotification.md) |
 
 **Returns:**
 
 [ErrorBuilder](./foundation-errors.errorbuilder.md)
 
+

package/docs/api/foundation-errors.errorbuilder.withsnackbar.md

@@ -4,6 +4,8 @@
 
 ## ErrorBuilder.withSnackbar() method
 
+Add snackbar to error
+
 **Signature:**
 
 ```typescript
@@ -14,9 +16,10 @@ withSnackbar(snackbar: Snackbar): ErrorBuilder;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  snackbar | [Snackbar](./foundation-errors.snackbar.md) |  |
+|  snackbar | [Snackbar](./foundation-errors.snackbar.md) | [Snackbar](./foundation-errors.snackbar.md) |
 
 **Returns:**
 
 [ErrorBuilder](./foundation-errors.errorbuilder.md)
 
+