@genesislcap/foundation-react-utils 15.46.6-alpha-6d1bd2f25.0 → 15.46.6-alpha-606571609.0

package/README.md

@@ -53,15 +53,15 @@ the theme was generated against.
 HOC) wraps a single tile, so a crash replaces only that tile. Both render a fallback with a
 reference ID, copyable diagnostics and a Retry button that remounts the children.
 
-Every caught error is passed to the optional `onError` callback as an `ErrorBoundaryReport`
-(`error`, `componentStack`, `referenceId`, `scope`, `title`, `tileRegistration`). Use it to send
-errors to a monitoring service; this package takes no dependency on one.
+With `setupErrorMonitoring` from `@genesislcap/foundation-utils`, caught errors are reported with
+their reference ID, scope, title, tile registration and component stack, and nothing else is
+needed:
 
 ```tsx
 import { AppErrorBoundary, onCaughtError } from '@genesislcap/foundation-react-utils';
 
 createRoot(el, { onCaughtError }).render(
-  <AppErrorBoundary onError={({ error, ...extra }) => Sentry.captureException(error, { extra })}>
+  <AppErrorBoundary>
     <App />
   </AppErrorBoundary>,
 );
@@ -70,23 +70,28 @@ createRoot(el, { onCaughtError }).render(
 ```tsx
 import { TileErrorBoundary, withTileErrorBoundary } from '@genesislcap/foundation-react-utils';
 
-<TileErrorBoundary title="Trade Blotter" tileRegistration="tradeBlotter" onError={report}>
+<TileErrorBoundary title="Trade Blotter" tileRegistration="tradeBlotter">
   <TradeBlotter />
 </TileErrorBoundary>;
 
-export const TradeBlotterTile = withTileErrorBoundary(TradeBlotter, 'Trade Blotter', 'tradeBlotter', report);
+export const TradeBlotterTile = withTileErrorBoundary(TradeBlotter, 'Trade Blotter', 'tradeBlotter');
 ```
 
+To handle caught errors yourself, pass `onError`. It receives an `ErrorBoundaryReport` (`error`,
+`componentStack`, `referenceId`, `scope`, `title`, `tileRegistration`). `withTileErrorBoundary`
+takes it as a fourth argument.
+
 Pass `onCaughtError` to `createRoot`. By default React 19 logs every error a boundary catches to
 `console.error` before the boundary runs, so a console-capturing monitoring tool reports the bare
 error first and can drop or duplicate the boundary's own report. `onCaughtError` skips that log
 for these boundaries, and still logs errors caught by any other boundary.
 
 Without `onError`, a boundary logs each caught error through a foundation logger named
-`ERROR_BOUNDARY_LOGGER_NAME`, which a global log reporter (`addGlobalLogReporter` from
-`@genesislcap/foundation-logger`) receives. With `onError` set, the boundary doesn't log the error,
-so an app that reports through both `onError` and a global reporter gets each error once. If
-`onError` throws, the boundary logs the original error and the handler's error, so neither is lost.
+`ERROR_BOUNDARY_LOGGER_NAME`: the error, then an object with its reference ID, scope, title, tile
+registration and component stack. A global log reporter (`addGlobalLogReporter` from
+`@genesislcap/foundation-logger`) receives it, which is how `setupErrorMonitoring` reports it. With
+`onError` set, the boundary doesn't log the error, so it isn't reported twice. If `onError` throws,
+the boundary logs the original error and the handler's error, so neither is lost.
 
 The fallback reads its colours and fonts from `--eb-*` CSS custom properties (`--eb-bg`,
 `--eb-surface`, `--eb-text`, `--eb-text-muted`, `--eb-border`, `--eb-accent`, `--eb-error`,

package/dist/custom-elements.json

@@ -381,29 +381,6 @@
         }
       ]
     },
-    {
-      "kind": "javascript-module",
-      "path": "src/flexlayout/index.ts",
-      "declarations": [],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "*",
-          "declaration": {
-            "name": "*",
-            "package": "flexlayout-react"
-          }
-        },
-        {
-          "kind": "js",
-          "name": "installRapidFlexLayoutReactStyles",
-          "declaration": {
-            "name": "installRapidFlexLayoutReactStyles",
-            "module": "src/flexlayout/index.ts"
-          }
-        }
-      ]
-    },
     {
       "kind": "javascript-module",
       "path": "src/router/index.ts",
@@ -648,6 +625,29 @@
           }
         }
       ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/flexlayout/index.ts",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "flexlayout-react"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "installRapidFlexLayoutReactStyles",
+          "declaration": {
+            "name": "installRapidFlexLayoutReactStyles",
+            "module": "src/flexlayout/index.ts"
+          }
+        }
+      ]
     }
   ]
 }

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

@@ -1,8 +1,10 @@
 import type { ComponentType, FC, ReactNode } from 'react';
 import type { RootOptions } from 'react-dom/client';
 /**
- * Name of the logger the error boundaries log through. They log a caught error only when no
- * `onError` handler is set, or when the handler throws.
+ * Name of the logger the error boundaries log through. They log a caught error, followed by its
+ * reference ID, scope, title, tile registration and component stack, only when no `onError`
+ * handler is set or when the handler throws. `setupErrorMonitoring` from foundation-utils reports
+ * these logs, so apps using it don't need an `onError`.
  * @public
  */
 export declare const ERROR_BOUNDARY_LOGGER_NAME = "foundation-react-utils:error-boundary";

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

@@ -1 +1 @@
-{"version":3,"file":"error-boundary.d.ts","sourceRoot":"","sources":["../../../src/error-boundary/error-boundary.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAa,EAAE,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AACrE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAGpD;;;;GAIG;AACH,eAAO,MAAM,0BAA0B,0CAA0C,CAAC;AAIlF;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,aAAa,GAAG,MAAM,CAAC;AAExD;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,KAAK,EAAE,KAAK,CAAC;IACb,cAAc,EAAE,MAAM,CAAC;IACvB,0FAA0F;IAC1F,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,kBAAkB,CAAC;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAAG,CAAC,MAAM,EAAE,mBAAmB,KAAK,IAAI,CAAC;AAE9E;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,CAAC,EAAE,yBAAyB,CAAC;IACpC,QAAQ,EAAE,SAAS,CAAC;CACrB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,yDAAyD;IACzD,KAAK,EAAE,MAAM,CAAC;IACd,oCAAoC;IACpC,gBAAgB,EAAE,MAAM,CAAC;IACzB,OAAO,CAAC,EAAE,yBAAyB,CAAC;IACpC,QAAQ,EAAE,SAAS,CAAC;CACrB,CAAC;AAsPF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,gBAAgB,EAAE,EAAE,CAAC,qBAAqB,CAItD,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,EAAE,EAAE,CAAC,sBAAsB,CAcxD,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,qBAAqB,GAAI,CAAC,SAAS,MAAM,EACpD,kBAAkB,aAAa,CAAC,CAAC,CAAC,EAClC,OAAO,MAAM,EACb,kBAAkB,MAAM,EACxB,UAAU,yBAAyB,KAClC,EAAE,CAAC,CAAC,CAUN,CAAC;AAOF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,aAAa,EAAE,WAAW,CAAC,WAAW,CAAC,eAAe,CAAC,CAKnE,CAAC"}
+{"version":3,"file":"error-boundary.d.ts","sourceRoot":"","sources":["../../../src/error-boundary/error-boundary.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAa,EAAE,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AACrE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAGpD;;;;;;GAMG;AACH,eAAO,MAAM,0BAA0B,0CAA0C,CAAC;AAIlF;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,aAAa,GAAG,MAAM,CAAC;AAExD;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,KAAK,EAAE,KAAK,CAAC;IACb,cAAc,EAAE,MAAM,CAAC;IACvB,0FAA0F;IAC1F,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,kBAAkB,CAAC;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAAG,CAAC,MAAM,EAAE,mBAAmB,KAAK,IAAI,CAAC;AAE9E;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,CAAC,EAAE,yBAAyB,CAAC;IACpC,QAAQ,EAAE,SAAS,CAAC;CACrB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,yDAAyD;IACzD,KAAK,EAAE,MAAM,CAAC;IACd,oCAAoC;IACpC,gBAAgB,EAAE,MAAM,CAAC;IACzB,OAAO,CAAC,EAAE,yBAAyB,CAAC;IACpC,QAAQ,EAAE,SAAS,CAAC;CACrB,CAAC;AAwPF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,gBAAgB,EAAE,EAAE,CAAC,qBAAqB,CAItD,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,EAAE,EAAE,CAAC,sBAAsB,CAcxD,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,qBAAqB,GAAI,CAAC,SAAS,MAAM,EACpD,kBAAkB,aAAa,CAAC,CAAC,CAAC,EAClC,OAAO,MAAM,EACb,kBAAkB,MAAM,EACxB,UAAU,yBAAyB,KAClC,EAAE,CAAC,CAAC,CAUN,CAAC;AAOF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,aAAa,EAAE,WAAW,CAAC,WAAW,CAAC,eAAe,CAAC,CAKnE,CAAC"}

package/dist/esm/error-boundary/error-boundary.js

@@ -5,8 +5,10 @@ import { createLogger } from '@genesislcap/foundation-logger';
 import { Component, useState } from 'react';
 import { errorBoundaryStyles } from './error-boundary-styles';
 /**
- * Name of the logger the error boundaries log through. They log a caught error only when no
- * `onError` handler is set, or when the handler throws.
+ * Name of the logger the error boundaries log through. They log a caught error, followed by its
+ * reference ID, scope, title, tile registration and component stack, only when no `onError`
+ * handler is set or when the handler throws. `setupErrorMonitoring` from foundation-utils reports
+ * these logs, so apps using it don't need an `onError`.
  * @public
  */
 export const ERROR_BOUNDARY_LOGGER_NAME = 'foundation-react-utils:error-boundary';
@@ -106,11 +108,13 @@ class BaseErrorBoundary extends Component {
         const { referenceId } = this.state;
         this.setState({ componentStack });
         recordReport(normalized, componentStack);
-        const logCaughtError = () => logger.error(`[${scope}] error boundary captured an error`, {
+        // The error comes first so a global log reporter can report it as an exception, with the
+        // context object attached (see `setupErrorMonitoring` in foundation-utils).
+        const logCaughtError = () => logger.error(`[${scope}] error boundary captured an error`, normalized, {
             referenceId,
+            scope,
             title,
             tileRegistration,
-            error: normalized,
             componentStack,
         });
         // With a handler set, the handler reports the error, so logging it as well would send it to

package/dist/foundation-react-utils.api.json

@@ -500,7 +500,7 @@
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/foundation-react-utils!ERROR_BOUNDARY_LOGGER_NAME:var",
-          "docComment": "/**\n * Name of the logger the error boundaries log through. They log a caught error only when no `onError` handler is set, or when the handler throws.\n *\n * @public\n */\n",
+          "docComment": "/**\n * Name of the logger the error boundaries log through. They log a caught error, followed by its reference ID, scope, title, tile registration and component stack, only when no `onError` handler is set or when the handler throws. `setupErrorMonitoring` from foundation-utils reports these logs, so apps using it don't need an `onError`.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",

package/dist/foundation-react-utils.d.ts

@@ -238,8 +238,10 @@ export declare function createReactRenderer(Component: ComponentType<RendererCon
 }): RendererEntry;
 
 /**
- * Name of the logger the error boundaries log through. They log a caught error only when no
- * `onError` handler is set, or when the handler throws.
+ * Name of the logger the error boundaries log through. They log a caught error, followed by its
+ * reference ID, scope, title, tile registration and component stack, only when no `onError`
+ * handler is set or when the handler throws. `setupErrorMonitoring` from foundation-utils reports
+ * these logs, so apps using it don't need an `onError`.
  * @public
  */
 export declare const ERROR_BOUNDARY_LOGGER_NAME = "foundation-react-utils:error-boundary";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-react-utils",
   "description": "Genesis Foundation React Utils",
-  "version": "15.46.6-alpha-6d1bd2f25.0",
+  "version": "15.46.6-alpha-606571609.0",
   "sideEffects": [
     "./dist/esm/flexlayout/index.js"
   ],
@@ -56,12 +56,12 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "15.46.6-alpha-6d1bd2f25.0",
-    "@genesislcap/genx": "15.46.6-alpha-6d1bd2f25.0",
-    "@genesislcap/ts-builder": "15.46.6-alpha-6d1bd2f25.0",
-    "@genesislcap/uvu-playwright-builder": "15.46.6-alpha-6d1bd2f25.0",
-    "@genesislcap/vite-builder": "15.46.6-alpha-6d1bd2f25.0",
-    "@genesislcap/webpack-builder": "15.46.6-alpha-6d1bd2f25.0",
+    "@genesislcap/foundation-testing": "15.46.6-alpha-606571609.0",
+    "@genesislcap/genx": "15.46.6-alpha-606571609.0",
+    "@genesislcap/ts-builder": "15.46.6-alpha-606571609.0",
+    "@genesislcap/uvu-playwright-builder": "15.46.6-alpha-606571609.0",
+    "@genesislcap/vite-builder": "15.46.6-alpha-606571609.0",
+    "@genesislcap/webpack-builder": "15.46.6-alpha-606571609.0",
     "react-router-dom": "^7.1.3"
   },
   "peerDependencies": {
@@ -75,11 +75,11 @@
     }
   },
   "dependencies": {
-    "@genesislcap/foundation-forms": "15.46.6-alpha-6d1bd2f25.0",
-    "@genesislcap/foundation-layout": "15.46.6-alpha-6d1bd2f25.0",
-    "@genesislcap/foundation-logger": "15.46.6-alpha-6d1bd2f25.0",
-    "@genesislcap/rapid-design-system": "15.46.6-alpha-6d1bd2f25.0",
-    "@genesislcap/web-core": "15.46.6-alpha-6d1bd2f25.0",
+    "@genesislcap/foundation-forms": "15.46.6-alpha-606571609.0",
+    "@genesislcap/foundation-layout": "15.46.6-alpha-606571609.0",
+    "@genesislcap/foundation-logger": "15.46.6-alpha-606571609.0",
+    "@genesislcap/rapid-design-system": "15.46.6-alpha-606571609.0",
+    "@genesislcap/web-core": "15.46.6-alpha-606571609.0",
     "@jsonforms/core": "^3.2.1",
     "@r2wc/core": "1.3.1",
     "@r2wc/react-to-web-component": "^2.0.2",