@genesislcap/foundation-utils 15.46.5 → 15.46.6-alpha-606571609.0

package/dist/custom-elements.json

@@ -71,6 +71,14 @@
             "package": "./error"
           }
         },
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./error-monitoring"
+          }
+        },
         {
           "kind": "js",
           "name": "*",
@@ -673,6 +681,21 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/encoding/index.ts",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./base64"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/decorators/index.ts",
@@ -728,7 +751,7 @@
     },
     {
       "kind": "javascript-module",
-      "path": "src/encoding/index.ts",
+      "path": "src/env/index.ts",
       "declarations": [],
       "exports": [
         {
@@ -736,22 +759,15 @@
           "name": "*",
           "declaration": {
             "name": "*",
-            "package": "./base64"
+            "package": "./is-dev"
           }
-        }
-      ]
-    },
-    {
-      "kind": "javascript-module",
-      "path": "src/env/index.ts",
-      "declarations": [],
-      "exports": [
+        },
         {
           "kind": "js",
           "name": "*",
           "declaration": {
             "name": "*",
-            "package": "./is-dev"
+            "package": "./runtime-config"
           }
         },
         {
@@ -786,6 +802,69 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/env/runtime-config.ts",
+      "declarations": [
+        {
+          "kind": "variable",
+          "name": "DEFAULT_RUNTIME_CONFIG_URL",
+          "type": {
+            "text": "string"
+          },
+          "default": "'/env.json'",
+          "description": "The default URL fetchRuntimeConfig reads from.",
+          "privacy": "public"
+        },
+        {
+          "kind": "function",
+          "name": "fetchRuntimeConfig",
+          "return": {
+            "type": {
+              "text": ""
+            }
+          },
+          "parameters": [
+            {
+              "name": "url",
+              "default": "DEFAULT_RUNTIME_CONFIG_URL",
+              "type": {
+                "text": "string"
+              },
+              "description": "The config URL. Defaults to {@link DEFAULT_RUNTIME_CONFIG_URL}.\n * "
+            },
+            {
+              "name": "fallback",
+              "default": "{}",
+              "type": {
+                "text": "Partial<T>"
+              },
+              "description": "Values to use when the config can't be read, and defaults for keys it omits."
+            }
+          ],
+          "description": "Fetches per-deployment JSON config, such as an error-monitoring DSN or environment name, that\ncan't be baked in at build time because the same image is promoted across environments.",
+          "privacy": "public"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "DEFAULT_RUNTIME_CONFIG_URL",
+          "declaration": {
+            "name": "DEFAULT_RUNTIME_CONFIG_URL",
+            "module": "src/env/runtime-config.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "fetchRuntimeConfig",
+          "declaration": {
+            "name": "fetchRuntimeConfig",
+            "module": "src/env/runtime-config.ts"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/env/variables.ts",
@@ -1439,6 +1518,175 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/error-monitoring/error-monitoring.ts",
+      "declarations": [
+        {
+          "kind": "function",
+          "name": "createErrorMonitoringReporter",
+          "return": {
+            "type": {
+              "text": "ConsolaReporter"
+            }
+          },
+          "parameters": [
+            {
+              "name": "client",
+              "type": {
+                "text": "ErrorMonitoringClient"
+              },
+              "description": "The monitoring client."
+            },
+            {
+              "name": "{ breadcrumbs = true }",
+              "default": "{}",
+              "type": {
+                "text": "Pick<ErrorMonitoringOptions, 'breadcrumbs'>"
+              }
+            },
+            {
+              "description": "Set `breadcrumbs: false` to skip breadcrumbs.",
+              "name": "options"
+            }
+          ],
+          "description": "Creates a global log reporter that sends foundation logger output to a monitoring client.",
+          "privacy": "public"
+        },
+        {
+          "kind": "function",
+          "name": "isFoundationLoggerConsoleBreadcrumb",
+          "return": {
+            "type": {
+              "text": "boolean"
+            }
+          },
+          "parameters": [
+            {
+              "name": "breadcrumb",
+              "type": {
+                "text": "ErrorMonitoringBreadcrumb"
+              }
+            }
+          ],
+          "description": "True for a console breadcrumb written by a foundation logger.",
+          "privacy": "public"
+        },
+        {
+          "kind": "function",
+          "name": "setupErrorMonitoring",
+          "return": {
+            "type": {
+              "text": ""
+            }
+          },
+          "parameters": [
+            {
+              "name": "client",
+              "type": {
+                "text": "ErrorMonitoringClient"
+              },
+              "description": "The monitoring SDK (for example the Sentry namespace) or an adapter for one."
+            },
+            {
+              "name": "options",
+              "default": "{}",
+              "type": {
+                "text": "ErrorMonitoringOptions"
+              },
+              "description": "Config location and keys, and extra init options."
+            }
+          ],
+          "description": "Sets up error monitoring for a Genesis app in one call.",
+          "privacy": "public"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "createErrorMonitoringReporter",
+          "declaration": {
+            "name": "createErrorMonitoringReporter",
+            "module": "src/error-monitoring/error-monitoring.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "isFoundationLoggerConsoleBreadcrumb",
+          "declaration": {
+            "name": "isFoundationLoggerConsoleBreadcrumb",
+            "module": "src/error-monitoring/error-monitoring.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "setupErrorMonitoring",
+          "declaration": {
+            "name": "setupErrorMonitoring",
+            "module": "src/error-monitoring/error-monitoring.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/error-monitoring/format-log-args.ts",
+      "declarations": [
+        {
+          "kind": "function",
+          "name": "formatLogArgs",
+          "return": {
+            "type": {
+              "text": "string"
+            }
+          },
+          "parameters": [
+            {
+              "name": "args",
+              "type": {
+                "text": "readonly unknown[]"
+              },
+              "description": "The arguments passed to the logger."
+            }
+          ],
+          "description": "Builds a readable one-line message from a log call's arguments.",
+          "privacy": "public"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "formatLogArgs",
+          "declaration": {
+            "name": "formatLogArgs",
+            "module": "src/error-monitoring/format-log-args.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/error-monitoring/index.ts",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./error-monitoring"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./format-log-args"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/feature-flags/featureFlags.ts",

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

@@ -1,3 +1,4 @@
 export * from './is-dev';
+export * from './runtime-config';
 export * from './variables';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/env/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/env/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,kBAAkB,CAAC;AACjC,cAAc,aAAa,CAAC"}

package/dist/dts/env/runtime-config.d.ts

@@ -0,0 +1,29 @@
+/**
+ * The default URL {@link fetchRuntimeConfig} reads from.
+ * @public
+ */
+export declare const DEFAULT_RUNTIME_CONFIG_URL = "/env.json";
+/**
+ * Fetches per-deployment JSON config, such as an error-monitoring DSN or environment name, that
+ * can't be baked in at build time because the same image is promoted across environments.
+ *
+ * @remarks
+ * Never rejects. Resolves to `fallback` when the request fails (network error, non-2xx status
+ * such as a 404) or the body isn't a JSON object. The last case covers an SPA fallback that serves
+ * `index.html` with a 200 for unknown paths. On success, the fetched values are shallow-merged over
+ * `fallback`. The request bypasses the HTTP cache so a redeployed config is picked up on reload.
+ *
+ * @example
+ * ```ts
+ * type EnvConfig = { sentryDsn: string; environment: string };
+ * const { sentryDsn, environment = 'local' } = await fetchRuntimeConfig<EnvConfig>();
+ * if (sentryDsn) Sentry.init({ dsn: sentryDsn, environment });
+ * ```
+ *
+ * @param url - The config URL. Defaults to {@link DEFAULT_RUNTIME_CONFIG_URL}.
+ * @param fallback - Values to use when the config can't be read, and defaults for keys it omits.
+ * @returns The fetched config merged over `fallback`, or `fallback` alone.
+ * @public
+ */
+export declare function fetchRuntimeConfig<T extends object>(url?: string, fallback?: Partial<T>): Promise<Partial<T>>;
+//# sourceMappingURL=runtime-config.d.ts.map

package/dist/dts/env/runtime-config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtime-config.d.ts","sourceRoot":"","sources":["../../../src/env/runtime-config.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,eAAO,MAAM,0BAA0B,cAAc,CAAC;AAKtD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAsB,kBAAkB,CAAC,CAAC,SAAS,MAAM,EACvD,GAAG,GAAE,MAAmC,EACxC,QAAQ,GAAE,OAAO,CAAC,CAAC,CAAM,GACxB,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAerB"}

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

@@ -0,0 +1,147 @@
+import type { ConsolaReporter } from '@genesislcap/foundation-logger';
+/**
+ * Severity of a monitoring event or breadcrumb.
+ * @public
+ */
+export type ErrorMonitoringLevel = 'fatal' | 'error' | 'warning' | 'info' | 'debug';
+/**
+ * Context sent with a captured exception or message.
+ * @public
+ */
+export interface ErrorMonitoringContext {
+    level?: ErrorMonitoringLevel;
+    tags?: Record<string, string>;
+    extra?: Record<string, unknown>;
+}
+/**
+ * A breadcrumb: a record of something that happened before an event.
+ * @public
+ */
+export interface ErrorMonitoringBreadcrumb {
+    category?: string;
+    level?: string;
+    message?: string;
+    data?: Record<string, unknown>;
+}
+/**
+ * Options {@link setupErrorMonitoring} passes to the client's `init`.
+ *
+ * @remarks
+ * The names match Sentry's `init` options. Any other keys from `initOptions` are passed through.
+ * @public
+ */
+export interface ErrorMonitoringInitOptions {
+    dsn: string;
+    environment: string;
+    /** How deep logged objects are serialised. Defaults to 10, so nested Genesis NACK entries survive. */
+    normalizeDepth?: number;
+    /** Drops the console breadcrumbs foundation loggers write; see {@link isFoundationLoggerConsoleBreadcrumb}. */
+    beforeBreadcrumb?: <B extends ErrorMonitoringBreadcrumb>(breadcrumb: B) => B | null;
+    [key: string]: unknown;
+}
+/**
+ * Extra options for the client's `init`, merged into what {@link setupErrorMonitoring} passes.
+ * @public
+ */
+export interface ErrorMonitoringExtraInitOptions {
+    normalizeDepth?: number;
+    /** Runs after the built-in filter, for breadcrumbs it keeps. */
+    beforeBreadcrumb?: (breadcrumb: ErrorMonitoringBreadcrumb) => ErrorMonitoringBreadcrumb | null;
+    [key: string]: unknown;
+}
+/**
+ * An error-monitoring SDK, or an adapter for one. The method names and shapes match the Sentry
+ * browser SDKs, so `import * as Sentry from '@sentry/react'` can be passed as is.
+ * @public
+ */
+export interface ErrorMonitoringClient {
+    captureException(error: unknown, context?: ErrorMonitoringContext): unknown;
+    captureMessage(message: string, context?: ErrorMonitoringContext): unknown;
+    addBreadcrumb?(breadcrumb: ErrorMonitoringBreadcrumb & {
+        level?: ErrorMonitoringLevel;
+    }): unknown;
+    init?(options: ErrorMonitoringInitOptions): unknown;
+}
+/**
+ * Options for {@link setupErrorMonitoring}.
+ * @public
+ */
+export interface ErrorMonitoringOptions {
+    /** Per-deployment JSON config holding the DSN and environment. Defaults to `/env.json`. */
+    configUrl?: string;
+    /** Config key holding the DSN. Defaults to `sentryDsn`. */
+    dsnKey?: string;
+    /** Config key holding the environment name. Defaults to `environmentType`. */
+    environmentKey?: string;
+    /** Environment used when the config doesn't name one. Defaults to `local`. */
+    defaultEnvironment?: string;
+    /** Extra options merged into what the client's `init` receives, e.g. Sentry's `dataCollection`. */
+    initOptions?: ErrorMonitoringExtraInitOptions;
+    /** Initialises the client in place of calling `client.init`. */
+    init?: (options: ErrorMonitoringInitOptions) => unknown;
+    /** Records non-error foundation logs as breadcrumbs. Defaults to `true`. */
+    breadcrumbs?: boolean;
+}
+/**
+ * Creates a global log reporter that sends foundation logger output to a monitoring client.
+ *
+ * @remarks
+ * `error` and `fatal` logs become events: an exception when an `Error` was logged, otherwise a
+ * message built with {@link formatLogArgs}. Each is tagged with the logger name, and plain-object
+ * arguments (such as an error boundary's reference ID and component stack) are merged into its
+ * extra data alongside the raw arguments. Other logs become breadcrumbs unless `breadcrumbs` is
+ * `false`. A failing client never breaks logging.
+ *
+ * {@link setupErrorMonitoring} registers this for you; use it directly to wire a client by hand.
+ *
+ * @param client - The monitoring client.
+ * @param options - Set `breadcrumbs: false` to skip breadcrumbs.
+ * @public
+ */
+export declare const createErrorMonitoringReporter: (client: ErrorMonitoringClient, { breadcrumbs }?: Pick<ErrorMonitoringOptions, "breadcrumbs">) => ConsolaReporter;
+/**
+ * True for a console breadcrumb written by a foundation logger.
+ *
+ * @remarks
+ * consola's browser output starts with a `%c` badge, and SDKs that record console calls join the
+ * arguments with `String()`, so these breadcrumbs arrive as CSS and `[object Object]`. The
+ * reporter from {@link createErrorMonitoringReporter} records the same logs readably.
+ * @public
+ */
+export declare const isFoundationLoggerConsoleBreadcrumb: (breadcrumb: ErrorMonitoringBreadcrumb) => boolean;
+/**
+ * Sets up error monitoring for a Genesis app in one call.
+ *
+ * @remarks
+ * Reads the DSN and environment from per-deployment config (`/env.json` by default) with
+ * {@link fetchRuntimeConfig}, so one image can be promoted across environments. Without a DSN it
+ * does nothing and resolves `false`, as in local development. Otherwise it:
+ *
+ * - initialises the client (`client.init`, or `options.init`) with the DSN, environment,
+ *   `normalizeDepth: 10`, a `beforeBreadcrumb` that drops unreadable foundation logger console
+ *   breadcrumbs, and any `initOptions`;
+ * - registers a global log reporter ({@link createErrorMonitoringReporter}), so errors logged by
+ *   every foundation logger, including those Genesis packages create at import time, are reported
+ *   with their structured arguments, and other logs become readable breadcrumbs.
+ *
+ * Errors caught by the foundation-react-utils `AppErrorBoundary` and `TileErrorBoundary` are logged
+ * with their reference ID and component stack, so they are reported too without an `onError`.
+ * Pair them with `onCaughtError` on the React root.
+ *
+ * Calling it again replaces the previous reporter, or removes it if the new call finds no DSN.
+ *
+ * @example
+ * ```ts
+ * import * as Sentry from '@sentry/react';
+ * import { setupErrorMonitoring } from '@genesislcap/foundation-utils';
+ *
+ * setupErrorMonitoring(Sentry);
+ * ```
+ *
+ * @param client - The monitoring SDK (for example the Sentry namespace) or an adapter for one.
+ * @param options - Config location and keys, and extra init options.
+ * @returns Whether monitoring was enabled.
+ * @public
+ */
+export declare function setupErrorMonitoring(client: ErrorMonitoringClient, options?: ErrorMonitoringOptions): Promise<boolean>;
+//# sourceMappingURL=error-monitoring.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"error-monitoring.d.ts","sourceRoot":"","sources":["../../../src/error-monitoring/error-monitoring.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AAItE;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,OAAO,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,CAAC;AAEpF;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,KAAK,CAAC,EAAE,oBAAoB,CAAC;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAChC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,0BAA0B;IACzC,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,CAAC;IACpB,sGAAsG;IACtG,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,+GAA+G;IAC/G,gBAAgB,CAAC,EAAE,CAAC,CAAC,SAAS,yBAAyB,EAAE,UAAU,EAAE,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;IACpF,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,+BAA+B;IAC9C,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,gEAAgE;IAChE,gBAAgB,CAAC,EAAE,CAAC,UAAU,EAAE,yBAAyB,KAAK,yBAAyB,GAAG,IAAI,CAAC;IAC/F,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,gBAAgB,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC;IAC5E,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC;IAC3E,aAAa,CAAC,CAAC,UAAU,EAAE,yBAAyB,GAAG;QAAE,KAAK,CAAC,EAAE,oBAAoB,CAAA;KAAE,GAAG,OAAO,CAAC;IAClG,IAAI,CAAC,CAAC,OAAO,EAAE,0BAA0B,GAAG,OAAO,CAAC;CACrD;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,2FAA2F;IAC3F,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,2DAA2D;IAC3D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,8EAA8E;IAC9E,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,8EAA8E;IAC9E,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,mGAAmG;IACnG,WAAW,CAAC,EAAE,+BAA+B,CAAC;IAC9C,gEAAgE;IAChE,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,0BAA0B,KAAK,OAAO,CAAC;IACxD,4EAA4E;IAC5E,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAwBD;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,6BAA6B,GACxC,QAAQ,qBAAqB,EAC7B,kBAAwB,IAAI,CAAC,sBAAsB,EAAE,aAAa,CAAM,KACvE,eA6BD,CAAC;AAEH;;;;;;;;GAQG;AACH,eAAO,MAAM,mCAAmC,GAC9C,YAAY,yBAAyB,KACpC,OAGF,CAAC;AAIF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,wBAAsB,oBAAoB,CACxC,MAAM,EAAE,qBAAqB,EAC7B,OAAO,GAAE,sBAA2B,GACnC,OAAO,CAAC,OAAO,CAAC,CAwClB"}

package/dist/dts/error-monitoring/format-log-args.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Builds a readable one-line message from a log call's arguments.
+ *
+ * @remarks
+ * Objects, such as a Genesis NACK, are JSON-encoded rather than becoming `[object Object]`.
+ * Circular references are marked, functions and classes are named, errors contribute their message,
+ * and the result is capped at 2000 characters.
+ *
+ * @param args - The arguments passed to the logger.
+ * @public
+ */
+export declare const formatLogArgs: (args: readonly unknown[]) => string;
+//# sourceMappingURL=format-log-args.d.ts.map

package/dist/dts/error-monitoring/format-log-args.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"format-log-args.d.ts","sourceRoot":"","sources":["../../../src/error-monitoring/format-log-args.ts"],"names":[],"mappings":"AAoCA;;;;;;;;;;GAUG;AACH,eAAO,MAAM,aAAa,GAAI,MAAM,SAAS,OAAO,EAAE,KAAG,MAMxB,CAAC"}

package/dist/dts/error-monitoring/index.d.ts

@@ -0,0 +1,3 @@
+export * from './error-monitoring';
+export * from './format-log-args';
+//# sourceMappingURL=index.d.ts.map

package/dist/dts/error-monitoring/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/error-monitoring/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC"}

package/dist/dts/index.d.ts

@@ -6,6 +6,7 @@ export * from './directives';
 export * from './encoding';
 export * from './env';
 export * from './error';
+export * from './error-monitoring';
 export * from './feature-flags';
 export * from './formatters';
 export * from './logger';

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,QAAQ,CAAC;AACvB,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,OAAO,CAAC;AACtB,cAAc,SAAS,CAAC;AACxB,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC;AACxB,cAAc,eAAe,CAAC;AAC9B,cAAc,oBAAoB,CAAC;AACnC,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,QAAQ,CAAC;AACvB,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,OAAO,CAAC;AACtB,cAAc,SAAS,CAAC;AACxB,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC;AACxB,cAAc,eAAe,CAAC;AAC9B,cAAc,oBAAoB,CAAC;AACnC,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC"}

package/dist/esm/env/index.js

@@ -1,2 +1,3 @@
 export * from './is-dev';
+export * from './runtime-config';
 export * from './variables';

package/dist/esm/env/runtime-config.js

@@ -0,0 +1,48 @@
+import { __awaiter } from "tslib";
+/**
+ * The default URL {@link fetchRuntimeConfig} reads from.
+ * @public
+ */
+export const DEFAULT_RUNTIME_CONFIG_URL = '/env.json';
+const isPlainObject = (value) => typeof value === 'object' && value !== null && !Array.isArray(value);
+/**
+ * Fetches per-deployment JSON config, such as an error-monitoring DSN or environment name, that
+ * can't be baked in at build time because the same image is promoted across environments.
+ *
+ * @remarks
+ * Never rejects. Resolves to `fallback` when the request fails (network error, non-2xx status
+ * such as a 404) or the body isn't a JSON object. The last case covers an SPA fallback that serves
+ * `index.html` with a 200 for unknown paths. On success, the fetched values are shallow-merged over
+ * `fallback`. The request bypasses the HTTP cache so a redeployed config is picked up on reload.
+ *
+ * @example
+ * ```ts
+ * type EnvConfig = { sentryDsn: string; environment: string };
+ * const { sentryDsn, environment = 'local' } = await fetchRuntimeConfig<EnvConfig>();
+ * if (sentryDsn) Sentry.init({ dsn: sentryDsn, environment });
+ * ```
+ *
+ * @param url - The config URL. Defaults to {@link DEFAULT_RUNTIME_CONFIG_URL}.
+ * @param fallback - Values to use when the config can't be read, and defaults for keys it omits.
+ * @returns The fetched config merged over `fallback`, or `fallback` alone.
+ * @public
+ */
+export function fetchRuntimeConfig() {
+    return __awaiter(this, arguments, void 0, function* (url = DEFAULT_RUNTIME_CONFIG_URL, fallback = {}) {
+        try {
+            const response = yield fetch(url, {
+                cache: 'no-store',
+                headers: { Accept: 'application/json' },
+            });
+            if (!response.ok) {
+                return fallback;
+            }
+            // Parse the text rather than trusting Content-Type: an SPA fallback may answer with HTML.
+            const config = JSON.parse(yield response.text());
+            return isPlainObject(config) ? Object.assign(Object.assign({}, fallback), config) : fallback;
+        }
+        catch (_a) {
+            return fallback;
+        }
+    });
+}