@genesislcap/foundation-errors 13.2.0 → 13.3.0

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

@@ -0,0 +1,10 @@
+import { ErrorStructure } from '../types';
+/**
+ * Shows the error dialog
+ * @public
+ * @param error - The ErrorStructure object
+ * @param tagName - The tag name to create prefix for the design system provider & error component
+ * @returns
+ * */
+export declare const showBanner: (error: ErrorStructure, tagName: String, errorBoundary: HTMLElement) => void;
+//# sourceMappingURL=error-banner-launcher.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"error-banner-launcher.d.ts","sourceRoot":"","sources":["../../../src/banner/error-banner-launcher.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAsB,MAAM,UAAU,CAAC;AAE9D;;;;;;KAMK;AACL,eAAO,MAAM,UAAU,UACd,cAAc,WACZ,MAAM,iBACA,WAAW,KACzB,IAaF,CAAC"}

package/dist/dts/banner/index.d.ts

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

package/dist/dts/banner/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/banner/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/banner/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC"}

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

@@ -4,7 +4,8 @@ import { ErrorStructure } from './types';
  * @public
  * @param error - The ErrorStructure object
  * @param tagName - The tag name to create prefix for the design system provider *
+ * @param errorBoundary - The error boundary element
  * @returns
  * */
-export declare const showError: (error: ErrorStructure, tagName: String) => void;
+export declare const showError: (error: ErrorStructure, tagName: String, errorBoundary?: HTMLElement) => void;
 //# sourceMappingURL=error-launcher.d.ts.map

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":"AAKA,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAazC;;;;;;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":"AAMA,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAczC;;;;;;;KAOK;AACL,eAAO,MAAM,SAAS,UACb,cAAc,WACZ,MAAM,kBACC,WAAW,KAC1B,IAWF,CAAC"}

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

@@ -22,4 +22,11 @@ export declare const getLoglevel: (details: ErrorStructure) => LogLevel;
  * @returns
  */
 export declare const getErrorContainer: (id: string, tagName: String) => HTMLElement;
+/**
+ * Get the error banner anchor to attach the banner to
+ * @public
+ * @param element - The element to start searching from
+ * @returns
+ */
+export declare const getErrorBannerAnchor: (element: any) => HTMLElement | null;
 //# sourceMappingURL=error-util.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"error-util.d.ts","sourceRoot":"","sources":["../../src/error-util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAEzC;;;;;GAKG;AACH,eAAO,MAAM,eAAe,YAAa,cAAc,KAAG,MAIzD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,WAAW,YAAa,cAAc,KAAG,QAErD,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,OAAQ,MAAM,WAAW,MAAM,KAAG,WAa/D,CAAC"}
+{"version":3,"file":"error-util.d.ts","sourceRoot":"","sources":["../../src/error-util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAEzC;;;;;GAKG;AACH,eAAO,MAAM,eAAe,YAAa,cAAc,KAAG,MAIzD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,WAAW,YAAa,cAAc,KAAG,QAErD,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,OAAQ,MAAM,WAAW,MAAM,KAAG,WAa/D,CAAC;AAEF;;;;;GAKG;AAEH,eAAO,MAAM,oBAAoB,YAAa,GAAG,KAAG,WAAW,GAAG,IAUjE,CAAC"}

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

@@ -0,0 +1,22 @@
+import { getErrorBannerAnchor } from '../error-util';
+/**
+ * Shows the error dialog
+ * @public
+ * @param error - The ErrorStructure object
+ * @param tagName - The tag name to create prefix for the design system provider & error component
+ * @returns
+ * */
+export const showBanner = (error, tagName, errorBoundary) => {
+    var _a;
+    const tagPrefix = tagName.split('-')[0];
+    const banner = document.createElement(`${tagPrefix}-error-banner`);
+    const container = getErrorBannerAnchor(errorBoundary);
+    if (((_a = container === null || container === void 0 ? void 0 : container.children) === null || _a === void 0 ? void 0 : _a.length) > 0) {
+        banner.style.position = 'absolute';
+        banner.style.top = '0';
+        banner.style.left = '0';
+        banner.style.width = '100%';
+    }
+    container.appendChild(banner);
+    banner.error = error;
+};

package/dist/esm/banner/index.js

@@ -1 +1,2 @@
 export * from './error-banner-builder';
+export * from './error-banner-launcher';

package/dist/esm/error-launcher.js

@@ -1,4 +1,5 @@
 import { createLogger } from '@genesislcap/foundation-utils';
+import { showBanner } from './banner';
 import { showDialog } from './dialog';
 import { getErrorDetails, getLoglevel } from './error-util';
 import { showNotification } from './notification';
@@ -11,15 +12,17 @@ const errorTypeToComponentMap = {
     notification: showNotification,
     dialog: showDialog,
     snackbar: showSnackbar,
+    banner: showBanner,
 };
 /**
  * Shows the error in the appropriate component
  * @public
  * @param error - The ErrorStructure object
  * @param tagName - The tag name to create prefix for the design system provider *
+ * @param errorBoundary - The error boundary element
  * @returns
  * */
-export const showError = (error, tagName) => {
+export const showError = (error, tagName, errorBoundary) => {
     logger.log({
         message: getErrorDetails(error),
         level: getLoglevel(error),
@@ -27,7 +30,7 @@ export const showError = (error, tagName) => {
     const keys = Object.keys((error === null || error === void 0 ? void 0 : error.config) || {});
     keys.forEach((key) => {
         if (errorTypeToComponentMap[key]) {
-            errorTypeToComponentMap[key](error, tagName);
+            errorTypeToComponentMap[key](error, tagName, errorBoundary);
         }
     });
 };

package/dist/esm/error-util.js

@@ -40,3 +40,28 @@ export const getErrorContainer = (id, tagName) => {
     }
     return container;
 };
+/**
+ * Get the error banner anchor to attach the banner to
+ * @public
+ * @param element - The element to start searching from
+ * @returns
+ */
+export const getErrorBannerAnchor = (element) => {
+    var _a, _b;
+    while (element && !(element instanceof ShadowRoot)) {
+        const anchor = (_a = element === null || element === void 0 ? void 0 : element.getRootNode()) === null || _a === void 0 ? void 0 : _a.getElementById('error-banner-anchor');
+        if (anchor) {
+            anchor.style.position = 'relative';
+            return anchor;
+        }
+        element = (_b = element === null || element === void 0 ? void 0 : element.getRootNode()) === null || _b === void 0 ? void 0 : _b.host;
+    }
+    return createErrorBannerContainer();
+};
+const createErrorBannerContainer = () => {
+    const anchor = document.createElement('div');
+    anchor.setAttribute('id', 'error-banner-anchor');
+    anchor.style.position = 'relative';
+    document.body.insertBefore(anchor, document.body.firstChild);
+    return anchor;
+};

package/dist/foundation-errors.api.json

@@ -1580,6 +1580,38 @@
           ],
           "extendsTokenRanges": []
         },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@genesislcap/foundation-errors!getErrorBannerAnchor:var",
+          "docComment": "/**\n * Get the error banner anchor to attach the banner to\n *\n * @param element - The element to start searching from\n *\n * @returns \n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "getErrorBannerAnchor: "
+            },
+            {
+              "kind": "Content",
+              "text": "(element: any) => "
+            },
+            {
+              "kind": "Reference",
+              "text": "HTMLElement",
+              "canonicalReference": "!HTMLElement:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " | null"
+            }
+          ],
+          "fileUrlPath": "src/error-util.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "getErrorBannerAnchor",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 4
+          }
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/foundation-errors!getErrorBannerBuilder:var",
@@ -2025,10 +2057,60 @@
           ],
           "implementsTokenRanges": []
         },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@genesislcap/foundation-errors!showBanner:var",
+          "docComment": "/**\n * Shows the error dialog\n *\n * @param error - The ErrorStructure object\n *\n * @param tagName - The tag name to create prefix for the design system provider & error component\n *\n * @returns \n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "showBanner: "
+            },
+            {
+              "kind": "Content",
+              "text": "(error: "
+            },
+            {
+              "kind": "Reference",
+              "text": "ErrorStructure",
+              "canonicalReference": "@genesislcap/foundation-errors!ErrorStructure:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", tagName: "
+            },
+            {
+              "kind": "Reference",
+              "text": "String",
+              "canonicalReference": "!String:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", errorBoundary: "
+            },
+            {
+              "kind": "Reference",
+              "text": "HTMLElement",
+              "canonicalReference": "!HTMLElement:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ") => void"
+            }
+          ],
+          "fileUrlPath": "src/banner/error-banner-launcher.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "showBanner",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 8
+          }
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/foundation-errors!showError:var",
-          "docComment": "/**\n * Shows the error in the appropriate component\n *\n * @param error - The ErrorStructure object\n *\n * @param tagName - The tag name to create prefix for the design system provider *\n *\n * @returns \n *\n * @public\n */\n",
+          "docComment": "/**\n * Shows the error in the appropriate component\n *\n * @param error - The ErrorStructure object\n *\n * @param tagName - The tag name to create prefix for the design system provider *\n *\n * @param errorBoundary - The error boundary element\n *\n * @returns \n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -2052,6 +2134,15 @@
               "text": "String",
               "canonicalReference": "!String:interface"
             },
+            {
+              "kind": "Content",
+              "text": ", errorBoundary?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "HTMLElement",
+              "canonicalReference": "!HTMLElement:interface"
+            },
             {
               "kind": "Content",
               "text": ") => void"
@@ -2063,7 +2154,7 @@
           "name": "showError",
           "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 6
+            "endIndex": 8
           }
         },
         {

package/dist/foundation-errors.d.ts

@@ -229,6 +229,14 @@ export declare interface ErrorStructure {
     };
 }
 
+/**
+ * Get the error banner anchor to attach the banner to
+ * @public
+ * @param element - The element to start searching from
+ * @returns
+ */
+export declare const getErrorBannerAnchor: (element: any) => HTMLElement | null;
+
 /**
  * Get error banner builder instance
  * @public
@@ -320,6 +328,15 @@ export declare class NotificationBuilder {
     build(): ErrorNotification;
 }
 
+/**
+ * Shows the error dialog
+ * @public
+ * @param error - The ErrorStructure object
+ * @param tagName - The tag name to create prefix for the design system provider & error component
+ * @returns
+ * */
+export declare const showBanner: (error: ErrorStructure, tagName: String, errorBoundary: HTMLElement) => void;
+
 /**
  * Shows the error dialog
  * @internal
@@ -334,9 +351,10 @@ export declare const showDialog: (error: ErrorStructure, tagName: String) => voi
  * @public
  * @param error - The ErrorStructure object
  * @param tagName - The tag name to create prefix for the design system provider *
+ * @param errorBoundary - The error boundary element
  * @returns
  * */
-export declare const showError: (error: ErrorStructure, tagName: String) => void;
+export declare const showError: (error: ErrorStructure, tagName: String, errorBoundary?: HTMLElement) => void;
 
 /**
  * Shows the error notification

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [getErrorBannerAnchor](./foundation-errors.geterrorbanneranchor.md)
+
+## getErrorBannerAnchor variable
+
+Get the error banner anchor to attach the banner to
+
+**Signature:**
+
+```typescript
+getErrorBannerAnchor: (element: any) => HTMLElement | null
+```

package/docs/api/foundation-errors.md

@@ -36,6 +36,7 @@
 
 |  Variable | Description |
 |  --- | --- |
+|  [getErrorBannerAnchor](./foundation-errors.geterrorbanneranchor.md) | Get the error banner anchor to attach the banner to |
 |  [getErrorBannerBuilder](./foundation-errors.geterrorbannerbuilder.md) | Get error banner builder instance |
 |  [getErrorBuilder](./foundation-errors.geterrorbuilder.md) | Returns a new ErrorBuilder instance |
 |  [getErrorContainer](./foundation-errors.geterrorcontainer.md) | Get/Create the error container in the DOM |
@@ -44,6 +45,7 @@
 |  [getLoglevel](./foundation-errors.getloglevel.md) | Retrieves the log level from an ErrorStructure object |
 |  [getNotificationBuilder](./foundation-errors.getnotificationbuilder.md) | Get notification builder instance |
 |  [getSnackbarBuilder](./foundation-errors.getsnackbarbuilder.md) | Get snackbar builder instance |
+|  [showBanner](./foundation-errors.showbanner.md) | Shows the error dialog |
 |  [showError](./foundation-errors.showerror.md) | Shows the error in the appropriate component |
 
 ## Type Aliases

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [showBanner](./foundation-errors.showbanner.md)
+
+## showBanner variable
+
+Shows the error dialog
+
+**Signature:**
+
+```typescript
+showBanner: (error: ErrorStructure, tagName: String, errorBoundary: HTMLElement) => void
+```

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

@@ -9,5 +9,5 @@ Shows the error in the appropriate component
 **Signature:**
 
 ```typescript
-showError: (error: ErrorStructure, tagName: String) => void
+showError: (error: ErrorStructure, tagName: String, errorBoundary?: HTMLElement) => void
 ```

package/docs/api-report.md

@@ -117,6 +117,9 @@ export interface ErrorStructure {
     readonly title: string;
 }
 
+// @public
+export const getErrorBannerAnchor: (element: any) => HTMLElement | null;
+
 // @public
 export const getErrorBannerBuilder: () => ErrorBannerBuilder;
 
@@ -149,13 +152,16 @@ export class 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) => void;
+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
 //

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-errors",
   "description": "Genesis Foundation UI Error Utils",
-  "version": "13.2.0",
+  "version": "13.3.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -45,7 +45,7 @@
     "test:unit:watch": "watchlist src test -- npm run test:unit"
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "^13.2.0",
+    "@genesislcap/foundation-testing": "^13.3.0",
     "@module-federation/dashboard-plugin": "2.3.0",
     "@pixability-ui/federated-types": "^0.2.0",
     "@playwright/test": "^1.18.1",
@@ -83,7 +83,7 @@
     "webpack-merge": "^5.7.3"
   },
   "dependencies": {
-    "@genesislcap/foundation-utils": "^13.2.0",
+    "@genesislcap/foundation-utils": "^13.3.0",
     "@microsoft/fast-element": "^1.7.0",
     "tslib": "^2.3.1"
   },
@@ -95,5 +95,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "9edee19ccfbd785feccc855c576741fa53664b60"
+  "gitHead": "e747be94876490deba62943d376f6e919dbb8cc2"
 }