@genesislcap/foundation-errors 10.3.1 → 11.3.0

package/dist/esm/error-builder.js

@@ -1,37 +1,93 @@
 import { LogLevel } from '@genesislcap/foundation-utils';
+/**
+ * ErrorBuilder to build ErrorStructure
+ * @public
+ */
 export class ErrorBuilder {
+    /**
+     * Add title to error
+     * @public
+     * @param title - string
+     * @returns
+     */
     withTitle(title) {
         this.title = title;
         return this;
     }
+    /**
+     * Add error details to error
+     * @public
+     * @param errorDetails - string
+     * @returns
+     */
     withErrorDetails(errorDetails) {
         this.errorDetails = errorDetails;
         return this;
     }
+    /**
+     * Add log level to error
+     * @public
+     * @returns
+     */
     withLogLevel(logLevel) {
         this.logLevel = logLevel;
         return this;
     }
+    /**
+     * Add alert to error
+     * @public
+     * @param alert - boolean
+     * @returns
+     */
     withAlert(alert) {
         this.alert = alert;
         return this;
     }
+    /**
+     * Add notification to error
+     * @public
+     * @param notification - {@link ErrorNotification}
+     * @returns
+     */
     withNotification(notification) {
         this.notification = notification;
         return this;
     }
+    /**
+     * Add banner to error
+     * @public
+     * @param banner - {@link ErrorBanner}
+     * @returns
+     */
     withBanner(banner) {
         this.banner = banner;
         return this;
     }
+    /**
+     * Add snackbar to error
+     * @public
+     * @param snackbar - {@link Snackbar}
+     * @returns
+     */
     withSnackbar(snackbar) {
         this.snackbar = snackbar;
         return this;
     }
+    /**
+     * Add dialog to error
+     * @public
+     * @param dialog - {@link ErrorDialog}
+     * @returns
+     */
     withDialog(dialog) {
         this.dialog = dialog;
         return this;
     }
+    /**
+     * Build ErrorStructure
+     * @public
+     * @returns
+     */
     build() {
         if (!this.title) {
             throw new Error('Title is required');
@@ -70,5 +126,8 @@ export class ErrorBuilder {
         return errorStructure;
     }
 }
+/**
+ * Returns a new ErrorBuilder instance
+ * @public
+ */
 export const getErrorBuilder = () => new ErrorBuilder();
-//# sourceMappingURL=error-builder.js.map

package/dist/esm/error-launcher.js

@@ -1,8 +1,8 @@
+import { createLogger } from '@genesislcap/foundation-utils';
+import { showDialog } from './dialog';
 import { getErrorDetails, getLoglevel } from './error-util';
 import { showNotification } from './notification';
-import { showDialog } from './dialog';
 import { showSnackbar } from './snackbar';
-import { createLogger } from '@genesislcap/foundation-utils';
 const logger = createLogger('foundation-error');
 const errorTypeToComponentMap = {
     alert: (error) => {
@@ -31,4 +31,3 @@ export const showError = (error, tagName) => {
         }
     });
 };
-//# sourceMappingURL=error-launcher.js.map

package/dist/esm/error-util.js

@@ -40,4 +40,3 @@ export const getErrorContainer = (id, tagName) => {
     }
     return container;
 };
-//# sourceMappingURL=error-util.js.map

package/dist/esm/index.federated.js

@@ -1,2 +1 @@
 import('./index');
-//# sourceMappingURL=index.federated.js.map

package/dist/esm/index.js

@@ -6,4 +6,3 @@ export * from './dialog';
 export * from './snackbar';
 export * from './error-util';
 export * from './error-launcher';
-//# sourceMappingURL=index.js.map

package/dist/esm/logger.js

@@ -1,3 +1,2 @@
 import { createLogger } from '@genesislcap/foundation-utils';
 export const logger = createLogger('foundation-errors');
-//# sourceMappingURL=logger.js.map

package/dist/esm/notification/index.js

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

package/dist/esm/notification/notification-builder.js

@@ -1,16 +1,42 @@
+/**
+ * NotificationBuilder to build ErrorNotification
+ * @public
+ */
 export class NotificationBuilder {
+    /**
+     * Add auto close to notification
+     * @public
+     * @param autoClose - boolean
+     * @returns
+     */
     withAutoClose(autoClose) {
         this.autoClose = autoClose;
         return this;
     }
+    /**
+     * Add close timeout to notification
+     * @public
+     * @param closeTimeout - number
+     * @returns
+     */
     withCloseTimeout(closeTimeout) {
         this.closeTimeout = closeTimeout;
         return this;
     }
+    /**
+     * 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) {
         this.type = type;
         return this;
     }
+    /**
+     * Build notification
+     * @returns ErrorNotification
+     */
     build() {
         let notification = {};
         if (this.autoClose) {
@@ -25,5 +51,8 @@ export class NotificationBuilder {
         return notification;
     }
 }
+/**
+ * Get notification builder instance
+ * @public
+ */
 export const getNotificationBuilder = () => new NotificationBuilder();
-//# sourceMappingURL=notification-builder.js.map

package/dist/esm/notification/notification-launcher.js

@@ -1,7 +1,7 @@
 import { getErrorContainer } from '../error-util';
 /**
  * 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
@@ -37,4 +37,3 @@ export const showNotification = (error, tagName) => {
     toastNotify.appendChild(errorDate);
     container.appendChild(toastNotify);
 };
-//# sourceMappingURL=notification-launcher.js.map

package/dist/esm/snackbar/index.js

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

package/dist/esm/snackbar/snackbar-builder.js

@@ -1,8 +1,12 @@
+/**
+ * SnackbarBuilder to build Snackbar
+ * @public
+ */
 export class SnackbarBuilder {
     /**
-     * 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) {
@@ -12,9 +16,9 @@ export class SnackbarBuilder {
     /**
      * Add confirming action to snackbar
      * @public
-     * @param confirmingAction
+     * @param confirmingAction - {@link ConfirmingAction}
      * @returns
-     * */
+     */
     withConfirmingAction(confirmingAction) {
         if (!this.confirmingActions) {
             this.confirmingActions = [];
@@ -26,7 +30,7 @@ export class SnackbarBuilder {
      * Build snackbar
      * @public
      * @returns Snackbar
-     * */
+     */
     build() {
         let snackbar = {};
         if (this.confirmingActions) {
@@ -38,5 +42,8 @@ export class SnackbarBuilder {
         return snackbar;
     }
 }
+/**
+ * Get snackbar builder instance
+ * @public
+ */
 export const getSnackbarBuilder = () => new SnackbarBuilder();
-//# sourceMappingURL=snackbar-builder.js.map

package/dist/esm/snackbar/snackbar-launcher.js

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

package/dist/esm/types.js

@@ -1,5 +1,8 @@
+/**
+ * @public
+ * enum for different types of error boundary events
+ */
 export var ErrorBoundaryEvent;
 (function (ErrorBoundaryEvent) {
     ErrorBoundaryEvent["ERROR_BOUNDARY_EVENT"] = "error-boundary-event";
 })(ErrorBoundaryEvent || (ErrorBoundaryEvent = {}));
-//# sourceMappingURL=types.js.map