@genesislcap/foundation-errors 10.3.1 → 11.3.0

package/README.md

@@ -1,5 +1,62 @@
 # Genesis Foundation UI Error Utils
 
+[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/)
+[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](https://www.typescriptlang.org/)
+
+### [API Docs](./docs/api/index.md)
+
+### Usage
+
+* The App need to create Error boundary component at top of the component tree.
+
+* Any child under Error boundary component can dispatch custom Error event
+
+* The custom event is handled by Error boundary component and based on event payload
+  it displays error on different Error component
+
+### Current Implementation support following Error Components
+
+* Alert
+* Toast
+* Banner
+* Snack bar
+* Dialog
+
+## Set-up
+
+### Basic install
+
+To enable this module in your application, follow the steps below.
+
+1. Add `@genesislcap/foundation-errors` as a dependency in your **package.json** file. Whenever you change the dependencies of your project, ensure you run the `$ npm run bootstrap` command again. You can find more information in the [package.json basics](https://learn.genesis.global/secure/web/basics/package-json-basics/) page.
+
+```javascript
+{
+  ...
+  "dependencies": {
+    "@genesislcap/foundation-errors": "latest"
+  },
+  ...
+}
+```
+### Creating and dispatching Error Events
+
+Creating and dispatching Error event with payload to show in Toast/Notification component
+
+```javascript
+$emit(
+  ErrorBoundaryEvent.ERROR_BOUNDARY_EVENT,
+  getErrorBuilder()
+    .withTitle(err.CODE)
+    .withErrorDetails(getErrorFormat(err))
+    .withNotification(
+      getNotificationBuilder()
+        .withType('warning')
+        .withAutoClose(true)
+        .withCloseTimeout(notificationCloseTimeout)
+        .build())
+    .build())
+```
 ## License
 
 Note: this project provides front end dependencies and uses licensed components listed in the next section, thus licenses for those components are required during development. Contact [Genesis Global](https://genesis.global/contact-us/) for more details.

package/dist/dts/banner/error-banner-builder.d.ts

@@ -1,10 +1,35 @@
 import { ErrorBanner, DismissingAction, ConfirmingAction } from '../types';
+/**
+ * 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;
 }
+/**
+ * Get error banner builder instance
+ * @public
+ */
 export declare const getErrorBannerBuilder: () => ErrorBannerBuilder;
 //# sourceMappingURL=error-banner-builder.d.ts.map

package/dist/dts/banner/error-banner-builder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"error-banner-builder.d.ts","sourceRoot":"","sources":["../../../src/banner/error-banner-builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE3E,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,gBAAgB,CAAmB;IAC3C,OAAO,CAAC,iBAAiB,CAA0B;IAE5C,oBAAoB,CAAC,gBAAgB,EAAE,gBAAgB,GAAG,kBAAkB;IAK5E,oBAAoB,CAAC,gBAAgB,EAAE,gBAAgB,GAAG,kBAAkB;IAQ5E,KAAK,IAAI,WAAW;CAY5B;AAED,eAAO,MAAM,qBAAqB,QAAO,kBAA8C,CAAC"}
+{"version":3,"file":"error-banner-builder.d.ts","sourceRoot":"","sources":["../../../src/banner/error-banner-builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE3E;;;GAGG;AACH,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,gBAAgB,CAAmB;IAC3C,OAAO,CAAC,iBAAiB,CAA0B;IAEnD;;;;;OAKG;IACI,oBAAoB,CAAC,gBAAgB,EAAE,gBAAgB,GAAG,kBAAkB;IAKnF;;;;;OAKG;IACI,oBAAoB,CAAC,gBAAgB,EAAE,gBAAgB,GAAG,kBAAkB;IAQnF;;;;OAIG;IACI,KAAK,IAAI,WAAW;CAY5B;AAED;;;GAGG;AACH,eAAO,MAAM,qBAAqB,QAAO,kBAA8C,CAAC"}

package/dist/dts/dialog/error-dialog-builder.d.ts

@@ -1,10 +1,35 @@
 import { ErrorDialog, DismissingAction, ConfirmingAction } from '../types';
+/**
+ * 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;
 }
+/**
+ * Returns an instance of ErrorDialogBuilder
+ * @public
+ */
 export declare const getErrorDialogBuilder: () => ErrorDialogBuilder;
 //# sourceMappingURL=error-dialog-builder.d.ts.map

package/dist/dts/dialog/error-dialog-builder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"error-dialog-builder.d.ts","sourceRoot":"","sources":["../../../src/dialog/error-dialog-builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE3E,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,gBAAgB,CAAmB;IAC3C,OAAO,CAAC,iBAAiB,CAA0B;IAE5C,oBAAoB,CAAC,gBAAgB,EAAE,gBAAgB,GAAG,kBAAkB;IAK5E,oBAAoB,CAAC,gBAAgB,EAAE,gBAAgB,GAAG,kBAAkB;IAQ5E,KAAK,IAAI,WAAW;CAU5B;AAED,eAAO,MAAM,qBAAqB,QAAO,kBAA8C,CAAC"}
+{"version":3,"file":"error-dialog-builder.d.ts","sourceRoot":"","sources":["../../../src/dialog/error-dialog-builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE3E;;;GAGG;AACH,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,gBAAgB,CAAmB;IAC3C,OAAO,CAAC,iBAAiB,CAA0B;IAEnD;;;;;OAKG;IACI,oBAAoB,CAAC,gBAAgB,EAAE,gBAAgB,GAAG,kBAAkB;IAKnF;;;;;OAKG;IACI,oBAAoB,CAAC,gBAAgB,EAAE,gBAAgB,GAAG,kBAAkB;IAQnF;;;;OAIG;IACI,KAAK,IAAI,WAAW;CAU5B;AAED;;;GAGG;AACH,eAAO,MAAM,qBAAqB,QAAO,kBAA8C,CAAC"}

package/dist/dts/dialog/error-dialog-launcher.d.ts

@@ -1,7 +1,7 @@
 import { ErrorStructure } from '../types';
 /**
  * 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

package/dist/dts/dialog/error-dialog-launcher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"error-dialog-launcher.d.ts","sourceRoot":"","sources":["../../../src/dialog/error-dialog-launcher.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAsB,MAAM,UAAU,CAAC;AAG9D;;;;;;KAMK;AACL,eAAO,MAAM,UAAU,UAAW,cAAc,WAAW,MAAM,KAAG,IAOnE,CAAC"}
+{"version":3,"file":"error-dialog-launcher.d.ts","sourceRoot":"","sources":["../../../src/dialog/error-dialog-launcher.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAsB,MAAM,UAAU,CAAC;AAE9D;;;;;;KAMK;AACL,eAAO,MAAM,UAAU,UAAW,cAAc,WAAW,MAAM,KAAG,IAOnE,CAAC"}

package/dist/dts/error-builder.d.ts

@@ -1,5 +1,9 @@
 import { LogLevel } from '@genesislcap/foundation-utils';
 import { ErrorStructure, ErrorBanner, ErrorDialog, ErrorNotification, Snackbar } from './types';
+/**
+ * ErrorBuilder to build ErrorStructure
+ * @public
+ */
 export declare class ErrorBuilder {
     private title;
     private errorDetails;
@@ -9,15 +13,71 @@ 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;
 }
+/**
+ * Returns a new ErrorBuilder instance
+ * @public
+ */
 export declare const getErrorBuilder: () => ErrorBuilder;
 //# sourceMappingURL=error-builder.d.ts.map

package/dist/dts/error-builder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"error-builder.d.ts","sourceRoot":"","sources":["../../src/error-builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AACzD,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,WAAW,EAAE,iBAAiB,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAEhG,qBAAa,YAAY;IACvB,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,QAAQ,CAAW;IAC3B,OAAO,CAAC,KAAK,CAAU;IACvB,OAAO,CAAC,YAAY,CAAoB;IACxC,OAAO,CAAC,MAAM,CAAc;IAC5B,OAAO,CAAC,QAAQ,CAAW;IAC3B,OAAO,CAAC,MAAM,CAAc;IAErB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY;IAKtC,gBAAgB,CAAC,YAAY,EAAE,MAAM,GAAG,YAAY;IAKpD,YAAY,CAAC,QAAQ,EAAE,QAAQ,GAAG,YAAY;IAK9C,SAAS,CAAC,KAAK,EAAE,OAAO,GAAG,YAAY;IAKvC,gBAAgB,CAAC,YAAY,EAAE,iBAAiB,GAAG,YAAY;IAK/D,UAAU,CAAC,MAAM,EAAE,WAAW,GAAG,YAAY;IAK7C,YAAY,CAAC,QAAQ,EAAE,QAAQ,GAAG,YAAY;IAK9C,UAAU,CAAC,MAAM,EAAE,WAAW,GAAG,YAAY;IAK7C,KAAK,IAAI,cAAc;CA8C/B;AAED,eAAO,MAAM,eAAe,QAAO,YAAkC,CAAC"}
+{"version":3,"file":"error-builder.d.ts","sourceRoot":"","sources":["../../src/error-builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AACzD,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,WAAW,EAAE,iBAAiB,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAEhG;;;GAGG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,QAAQ,CAAW;IAC3B,OAAO,CAAC,KAAK,CAAU;IACvB,OAAO,CAAC,YAAY,CAAoB;IACxC,OAAO,CAAC,MAAM,CAAc;IAC5B,OAAO,CAAC,QAAQ,CAAW;IAC3B,OAAO,CAAC,MAAM,CAAc;IAE5B;;;;;OAKG;IACI,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY;IAK7C;;;;;OAKG;IACI,gBAAgB,CAAC,YAAY,EAAE,MAAM,GAAG,YAAY;IAK3D;;;;OAIG;IACI,YAAY,CAAC,QAAQ,EAAE,QAAQ,GAAG,YAAY;IAKrD;;;;;OAKG;IACI,SAAS,CAAC,KAAK,EAAE,OAAO,GAAG,YAAY;IAK9C;;;;;OAKG;IACI,gBAAgB,CAAC,YAAY,EAAE,iBAAiB,GAAG,YAAY;IAKtE;;;;;OAKG;IACI,UAAU,CAAC,MAAM,EAAE,WAAW,GAAG,YAAY;IAKpD;;;;;OAKG;IACI,YAAY,CAAC,QAAQ,EAAE,QAAQ,GAAG,YAAY;IAKrD;;;;;OAKG;IACI,UAAU,CAAC,MAAM,EAAE,WAAW,GAAG,YAAY;IAKpD;;;;OAIG;IACI,KAAK,IAAI,cAAc;CA8C/B;AAED;;;GAGG;AACH,eAAO,MAAM,eAAe,QAAO,YAAkC,CAAC"}

package/dist/dts/error-launcher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"error-launcher.d.ts","sourceRoot":"","sources":["../../src/error-launcher.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAkBzC;;;;;;KAMK;AACL,eAAO,MAAM,SAAS,UAAW,cAAc,WAAW,MAAM,KAAG,IAWlE,CAAC"}
+{"version":3,"file":"error-launcher.d.ts","sourceRoot":"","sources":["../../src/error-launcher.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAazC;;;;;;KAMK;AACL,eAAO,MAAM,SAAS,UAAW,cAAc,WAAW,MAAM,KAAG,IAWlE,CAAC"}

package/dist/dts/logger.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/logger.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,MAAM,gDAAoC,CAAC"}
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/logger.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,MAAM,gDAAoC,CAAC"}

package/dist/dts/notification/notification-builder.d.ts

@@ -1,12 +1,42 @@
-import { ErrorNotification } from '../types';
+import { ErrorNotification, ErrorNotificationType } from '../types';
+/**
+ * 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;
 }
+/**
+ * Get notification builder instance
+ * @public
+ */
 export declare const getNotificationBuilder: () => NotificationBuilder;
 //# sourceMappingURL=notification-builder.d.ts.map

package/dist/dts/notification/notification-builder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"notification-builder.d.ts","sourceRoot":"","sources":["../../../src/notification/notification-builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAE7C,qBAAa,mBAAmB;IAC9B,OAAO,CAAC,SAAS,CAAU;IAC3B,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,IAAI,CAA6B;IAElC,aAAa,CAAC,SAAS,EAAE,OAAO,GAAG,mBAAmB;IAKtD,gBAAgB,CAAC,YAAY,EAAE,MAAM,GAAG,mBAAmB;IAK3D,QAAQ,CAAC,IAAI,EAAE,SAAS,GAAG,SAAS,GAAG,EAAE,GAAG,mBAAmB;IAK/D,KAAK,IAAI,iBAAiB;CAalC;AAED,eAAO,MAAM,sBAAsB,QAAO,mBAAgD,CAAC"}
+{"version":3,"file":"notification-builder.d.ts","sourceRoot":"","sources":["../../../src/notification/notification-builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AAEpE;;;GAGG;AACH,qBAAa,mBAAmB;IAC9B,OAAO,CAAC,SAAS,CAAU;IAC3B,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,IAAI,CAAwB;IAEpC;;;;;OAKG;IACI,aAAa,CAAC,SAAS,EAAE,OAAO,GAAG,mBAAmB;IAK7D;;;;;OAKG;IACI,gBAAgB,CAAC,YAAY,EAAE,MAAM,GAAG,mBAAmB;IAKlE;;;;;OAKG;IACI,QAAQ,CAAC,IAAI,EAAE,qBAAqB,GAAG,mBAAmB;IAKjE;;;OAGG;IACI,KAAK,IAAI,iBAAiB;CAalC;AAED;;;GAGG;AACH,eAAO,MAAM,sBAAsB,QAAO,mBAAgD,CAAC"}

package/dist/dts/notification/notification-launcher.d.ts

@@ -1,7 +1,7 @@
 import { ErrorStructure } from '../types';
 /**
  * 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

package/dist/dts/notification/notification-launcher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"notification-launcher.d.ts","sourceRoot":"","sources":["../../../src/notification/notification-launcher.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAG1C;;;;;;KAMK;AACL,eAAO,MAAM,gBAAgB,UAAW,cAAc,WAAW,MAAM,KAAG,IAmCzE,CAAC"}
+{"version":3,"file":"notification-launcher.d.ts","sourceRoot":"","sources":["../../../src/notification/notification-launcher.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAE1C;;;;;;KAMK;AACL,eAAO,MAAM,gBAAgB,UAAW,cAAc,WAAW,MAAM,KAAG,IAmCzE,CAAC"}

package/dist/dts/snackbar/snackbar-builder.d.ts

@@ -1,27 +1,35 @@
-import { Snackbar, ConfirmingAction } from '../types';
+import { Snackbar, ConfirmingAction, SnackbarType } from '../types';
+/**
+ * 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;
 }
+/**
+ * Get snackbar builder instance
+ * @public
+ */
 export declare const getSnackbarBuilder: () => SnackbarBuilder;
 //# sourceMappingURL=snackbar-builder.d.ts.map

package/dist/dts/snackbar/snackbar-builder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"snackbar-builder.d.ts","sourceRoot":"","sources":["../../../src/snackbar/snackbar-builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAEtD,qBAAa,eAAe;IAC1B,OAAO,CAAC,iBAAiB,CAA0B;IACnD,OAAO,CAAC,IAAI,CAAe;IAE3B;;;;;OAKG;IACI,QAAQ,CAAC,IAAI,EAAE,OAAO,GAAG,EAAE,GAAG,eAAe;IAKpD;;;;;SAKK;IAEE,oBAAoB,CAAC,gBAAgB,EAAE,gBAAgB,GAAG,eAAe;IAQhF;;;;SAIK;IAEE,KAAK,IAAI,QAAQ;CAUzB;AAED,eAAO,MAAM,kBAAkB,QAAO,eAAwC,CAAC"}
+{"version":3,"file":"snackbar-builder.d.ts","sourceRoot":"","sources":["../../../src/snackbar/snackbar-builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAEpE;;;GAGG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,iBAAiB,CAA0B;IACnD,OAAO,CAAC,IAAI,CAAe;IAE3B;;;;;OAKG;IACI,QAAQ,CAAC,IAAI,EAAE,YAAY,GAAG,eAAe;IAKpD;;;;;OAKG;IACI,oBAAoB,CAAC,gBAAgB,EAAE,gBAAgB,GAAG,eAAe;IAQhF;;;;OAIG;IACI,KAAK,IAAI,QAAQ;CAUzB;AAED;;;GAGG;AACH,eAAO,MAAM,kBAAkB,QAAO,eAAwC,CAAC"}

package/dist/dts/snackbar/snackbar-launcher.d.ts

@@ -1,7 +1,7 @@
 import { ErrorStructure } from '../types';
 /**
  * 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

package/dist/dts/snackbar/snackbar-launcher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"snackbar-launcher.d.ts","sourceRoot":"","sources":["../../../src/snackbar/snackbar-launcher.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAgB,MAAM,UAAU,CAAC;AAGxD;;;;;;KAMK;AACL,eAAO,MAAM,YAAY,UAAW,cAAc,WAAW,MAAM,KAAG,IAMrE,CAAC"}
+{"version":3,"file":"snackbar-launcher.d.ts","sourceRoot":"","sources":["../../../src/snackbar/snackbar-launcher.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAgB,MAAM,UAAU,CAAC;AAExD;;;;;;KAMK;AACL,eAAO,MAAM,YAAY,UAAW,cAAc,WAAW,MAAM,KAAG,IAMrE,CAAC"}

package/dist/dts/types.d.ts

@@ -1,32 +1,74 @@
 import { LogLevel } from '@genesislcap/foundation-utils';
+/**
+ * @public
+ * enum for different types of error boundary events
+ */
 export declare enum ErrorBoundaryEvent {
     ERROR_BOUNDARY_EVENT = "error-boundary-event"
 }
+/**
+ * @public
+ * type for error notification type
+ */
+export type ErrorNotificationType = 'warning' | 'success';
+/**
+ * Interface for Error Notification configuration
+ * @public
+ */
 export interface ErrorNotification {
-    readonly type?: 'warning' | 'success' | '';
+    readonly type?: ErrorNotificationType;
     readonly autoClose?: boolean;
     readonly closeTimeout?: number;
 }
+/**
+ * Interface for Dismissing Action configuration
+ * @public
+ */
 export interface DismissingAction {
     readonly label: String;
     readonly action?: Function;
 }
+/**
+ * Interface for Confirming Action configuration
+ * @public
+ */
 export interface ConfirmingAction {
     readonly label: String;
     readonly action: Function;
 }
+/**
+ * Interface for Error Dialog configuration
+ * @public
+ */
 export interface ErrorDialog {
     readonly confirmingActions?: Array<ConfirmingAction>;
     readonly dismissingAction?: DismissingAction;
 }
+/**
+ * Interface for Error Banner configuration
+ * @public
+ */
 export interface ErrorBanner {
     readonly dismissingAction?: DismissingAction;
     readonly confirmingActions?: Array<ConfirmingAction>;
 }
+/**
+ * @public
+ * type for snackbar type
+ */
+export type SnackbarType = 'error';
+/**
+ * Interface for Error Snackbar configuration
+ * @public
+ */
 export interface Snackbar {
-    readonly type?: 'error' | '';
+    readonly type?: SnackbarType;
     readonly confirmingActions?: Array<ConfirmingAction>;
 }
+/**
+ * Interface for Error Structure
+ *  @public
+ */
 export interface ErrorStructure {
     readonly title: string;
     readonly errorDetails: string;
@@ -43,9 +85,15 @@ export interface ErrorStructure {
         readonly dialog?: ErrorDialog;
     };
 }
+/**
+ * @internal
+ */
 export type ErrorElement = HTMLElement & {
     error: ErrorStructure;
 };
+/**
+ * @internal
+ */
 export type ErrorDialogElement = ErrorElement & {
     show: Function;
 };

package/dist/dts/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AAEzD,oBAAY,kBAAkB;IAC5B,oBAAoB,yBAAyB;CAC9C;AAED,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,IAAI,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,EAAE,CAAC;IAC3C,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAC7B,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC;CAC5B;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC;CAC3B;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,iBAAiB,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;IACrD,QAAQ,CAAC,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CAC9C;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IAC7C,QAAQ,CAAC,iBAAiB,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;CACtD;AACD,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,GAAG,EAAE,CAAC;IAC7B,QAAQ,CAAC,iBAAiB,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;CACtD;AACD,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAC7B,QAAQ,CAAC,MAAM,CAAC,EAAE;QAChB;;WAEG;QACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC;QAC7B,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;QACzB,QAAQ,CAAC,YAAY,CAAC,EAAE,iBAAiB,CAAC;QAC1C,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC;QAC9B,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC;QAC7B,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC;KAC/B,CAAC;CACH;AAED,MAAM,MAAM,YAAY,GAAG,WAAW,GAAG;IAAE,KAAK,EAAE,cAAc,CAAA;CAAE,CAAC;AACnE,MAAM,MAAM,kBAAkB,GAAG,YAAY,GAAG;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AAEzD;;;GAGG;AACH,oBAAY,kBAAkB;IAC5B,oBAAoB,yBAAyB;CAC9C;AAED;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG,SAAS,GAAG,SAAS,CAAC;AAE1D;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,IAAI,CAAC,EAAE,qBAAqB,CAAC;IACtC,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAC7B,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,iBAAiB,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;IACrD,QAAQ,CAAC,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CAC9C;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IAC7C,QAAQ,CAAC,iBAAiB,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;CACtD;AAED;;;GAGG;AAEH,MAAM,MAAM,YAAY,GAAG,OAAO,CAAC;AACnC;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,IAAI,CAAC,EAAE,YAAY,CAAC;IAC7B,QAAQ,CAAC,iBAAiB,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;CACtD;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAC7B,QAAQ,CAAC,MAAM,CAAC,EAAE;QAChB;;WAEG;QACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC;QAC7B,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;QACzB,QAAQ,CAAC,YAAY,CAAC,EAAE,iBAAiB,CAAC;QAC1C,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC;QAC9B,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC;QAC7B,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC;KAC/B,CAAC;CACH;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,WAAW,GAAG;IAAE,KAAK,EAAE,cAAc,CAAA;CAAE,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,YAAY,GAAG;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,CAAC"}

package/dist/esm/banner/error-banner-builder.js

@@ -1,8 +1,24 @@
+/**
+ * ErrorBannerBuilder to build ErrorBanner
+ * @public
+ */
 export class ErrorBannerBuilder {
+    /**
+     * Add dismissing action to ErrorBanner
+     * @public
+     * @param dismissingAction - {@link DismissingAction}
+     * @returns
+     */
     withDismissingAction(dismissingAction) {
         this.dismissingAction = dismissingAction;
         return this;
     }
+    /**
+     * Add confirming action to ErrorBanner
+     * @public
+     * @param confirmingAction - {@link ConfirmingAction}
+     * @returns
+     */
     withConfirmingAction(confirmingAction) {
         if (!this.confirmingActions) {
             this.confirmingActions = [];
@@ -10,6 +26,11 @@ export class ErrorBannerBuilder {
         this.confirmingActions.push(confirmingAction);
         return this;
     }
+    /**
+     * Build ErrorBanner
+     * @public
+     * @returns ErrorBanner
+     */
     build() {
         let errorBanner = {};
         if (this.dismissingAction) {
@@ -21,5 +42,8 @@ export class ErrorBannerBuilder {
         return errorBanner;
     }
 }
+/**
+ * Get error banner builder instance
+ * @public
+ */
 export const getErrorBannerBuilder = () => new ErrorBannerBuilder();
-//# sourceMappingURL=error-banner-builder.js.map

package/dist/esm/banner/index.js

@@ -1,2 +1 @@
 export * from './error-banner-builder';
-//# sourceMappingURL=index.js.map

package/dist/esm/dialog/error-dialog-builder.js

@@ -1,8 +1,24 @@
+/**
+ * ErrorDialogBuilder class
+ * @public
+ */
 export class ErrorDialogBuilder {
+    /**
+     * Add dismissing action to ErrorDialog
+     * @public
+     * @param dismissingAction - {@link DismissingAction}
+     * @returns
+     */
     withDismissingAction(dismissingAction) {
         this.dismissingAction = dismissingAction;
         return this;
     }
+    /**
+     * Add confirming action to ErrorDialog
+     * @public
+     * @param confirmingAction - {@link ConfirmingAction}
+     * @returns
+     */
     withConfirmingAction(confirmingAction) {
         if (!this.confirmingActions) {
             this.confirmingActions = [];
@@ -10,6 +26,11 @@ export class ErrorDialogBuilder {
         this.confirmingActions.push(confirmingAction);
         return this;
     }
+    /**
+     * Build ErrorDialog
+     * @public
+     * @returns ErrorDialog
+     */
     build() {
         let errorDialog = {};
         if (this.dismissingAction) {
@@ -21,5 +42,8 @@ export class ErrorDialogBuilder {
         return errorDialog;
     }
 }
+/**
+ * Returns an instance of ErrorDialogBuilder
+ * @public
+ */
 export const getErrorDialogBuilder = () => new ErrorDialogBuilder();
-//# sourceMappingURL=error-dialog-builder.js.map

package/dist/esm/dialog/error-dialog-launcher.js

@@ -1,7 +1,7 @@
 import { getErrorContainer } from '../error-util';
 /**
  * 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
@@ -14,4 +14,3 @@ export const showDialog = (error, tagName) => {
     dialog.error = error;
     dialog.show();
 };
-//# sourceMappingURL=error-dialog-launcher.js.map

package/dist/esm/dialog/index.js

@@ -1,3 +1,2 @@
 export * from './error-dialog-builder';
 export * from './error-dialog-launcher';
-//# sourceMappingURL=index.js.map