@flareapp/js 2.11.0 → 2.12.1

package/dist/index.cjs

@@ -1,5 +1,5 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-const require_catchWindowErrors = require('./catchWindowErrors-BgmDgTlR.cjs');
+const require_catchWindowErrors = require('./catchWindowErrors-BSJfXoWb.cjs');
 const require_browser = require('./browser.cjs');
 let _flareapp_core = require("@flareapp/core");
 

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { E as createFlareResolver } from "./spanTypes-TMgJEZ7G.cjs";
+import { E as createFlareResolver } from "./spanTypes-Cdgtuu6-.cjs";
 import { Flare } from "./browser.cjs";
 import { AttributeValue, Attributes, Config, ContextCollector, DEFAULT_URL_DENYLIST, EntryPointHandler, FileReader, FlushFn, FlushScheduler, Framework, FrameworkName, GlobalScopeProvider, Glow, Logger, MessageLevel, NullFileReader, OverriddenGrouping, Report, Scope, ScopeProvider, SdkInfo, SpanEvent, StackFrame, User, convertToError, redactObjectValues, redactUrlQuery, redactUrlQuery as redactFullPath, resolveDenylist, toCustomContext } from "@flareapp/core";
 

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { E as createFlareResolver } from "./spanTypes-7-nEycOc.mjs";
+import { E as createFlareResolver } from "./spanTypes-RYeFN_pN.mjs";
 import { Flare } from "./browser.mjs";
 import { AttributeValue, Attributes, Config, ContextCollector, DEFAULT_URL_DENYLIST, EntryPointHandler, FileReader, FlushFn, FlushScheduler, Framework, FrameworkName, GlobalScopeProvider, Glow, Logger, MessageLevel, NullFileReader, OverriddenGrouping, Report, Scope, ScopeProvider, SdkInfo, SpanEvent, StackFrame, User, convertToError, redactObjectValues, redactUrlQuery, redactUrlQuery as redactFullPath, resolveDenylist, toCustomContext } from "@flareapp/core";
 

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { n as createFlareResolver, t as catchWindowErrors } from "./catchWindowErrors-I_8ksYoj.mjs";
+import { n as createFlareResolver, t as catchWindowErrors } from "./catchWindowErrors-C9vXZjft.mjs";
 import { Flare } from "./browser.mjs";
 import { DEFAULT_URL_DENYLIST, FrameworkName, GlobalScopeProvider, Logger, NullFileReader, Scope, convertToError, redactObjectValues, redactUrlQuery, redactUrlQuery as redactFullPath, resolveDenylist, toCustomContext } from "@flareapp/core";
 

package/dist/{spanTypes-TMgJEZ7G.d.cts → spanTypes-Cdgtuu6-.d.cts}

@@ -3,11 +3,10 @@ import { Attributes, BrowserSpanType, Config, ContextCollector, FileReader, Flus
 
 //#region src/createFlareResolver.d.ts
 /**
- * Builds a per-package Flare resolver: `registerDefaultFlare` (wired once by the web entry) and
- * `resolveFlare` (called at wiring time). Each call holds its own default-provider state. The check
- * that warns about the Electron `__flare` bridge uses `packageName` in its message;
- * `injectInstruction` replaces the closing hint for packages whose advice differs (for example
- * svelte, which points at the preprocessor's importSource).
+ * Builds a per-package Flare resolver: `registerDefaultFlare` (set once by the web entry) and
+ * `resolveFlare` (called at wiring time). Each call keeps its own default-provider state.
+ * `packageName` names the package in the Electron-bridge warning; `injectInstruction` overrides the
+ * closing hint for packages with different advice (for example Svelte's preprocessor importSource).
  */
 declare function createFlareResolver(config: {
   packageName: string;
@@ -45,9 +44,7 @@ declare class BrowserFlushScheduler implements FlushScheduler {
 //#region src/instrumentation/navigation/types.d.ts
 type RouteName = {
   name: string;
-  source: 'route' | 'url';
-  /** Where the navigation ends. Set on a redirect so the final url is reported; leave out to keep
-   *  the url the root opened with. */
+  source: 'route' | 'url'; /** Where the navigation ends. Set on a redirect so the report uses the final url, not the url the root opened with. */
   url?: string;
 };
 type NavigationSource = {
@@ -63,12 +60,17 @@ type NavigationSource = {
 //#endregion
 //#region src/instrumentation/navigation/utils.d.ts
 declare function currentPath(): string;
+/** The whole address, query string included. */
 declare function currentHref(): string;
+/**
+ * Prefers the router's route template (`/product/:id`) over the raw path, so all urls of one route
+ * group together. If `derive` throws, the fallback path is used instead of breaking the app.
+ */
 declare function routeName(derive: () => string | undefined, fallbackPath: string, url?: string): RouteName;
 /**
- * `build` is the router's own href builder (vue-router `resolve`, React Router `createHref`). It puts
- * the app's base path and hash prefix back. Without it, an app served from `/app/` reports
- * `/product/p01` instead of `/app/product/p01`. If `build` throws, we use `fallback`.
+ * `build` is the router's own href builder (vue-router `resolve`, React Router `createHref`). It restores
+ * the app's base path and hash prefix, so an app served from `/app/` reports `/app/product/p01` instead
+ * of `/product/p01`. Falls back to `fallbackHref` if `build` throws.
  */
 declare function resolveHref(build: () => string | null | undefined, fallbackHref: string): string | undefined;
 //#endregion
@@ -82,16 +84,17 @@ declare function registerNavigationSource(): NavigationSource;
 //#endregion
 //#region src/tracing/utils/absoluteHref.d.ts
 /**
- * Resolve a router-reported href against the page we are on. Returns the `URL`, so a caller that
- * wants the pathname as well as the href does not parse it a second time.
+ * Resolves a router-reported href against the current page. Returns the `URL`, so a caller that also
+ * wants the pathname does not have to parse it again.
  *
- * Undefined outside a browser or for an unparseable href, so the caller can leave its attribute alone.
+ * Returns undefined outside a browser or for an unparseable href, so the caller can leave its
+ * attribute alone.
  */
 declare function absoluteUrl(href: string | null | undefined): URL | undefined;
 /**
- * The href form of `absoluteUrl`. Pass one built by the router's own `createHref`/`resolve` (see
- * `resolveHref`), not a bare path: routers strip the app's base path, so `origin + path` yields an
- * address the server does not have.
+ * The href form of `absoluteUrl`. Pass a value built by the router's own `createHref`/`resolve`, not
+ * a bare path — routers strip the app's base path, so `origin + path` gives an address the server
+ * does not have.
  */
 declare function absoluteHref(href: string | null | undefined): string | undefined;
 //#endregion
@@ -103,16 +106,16 @@ declare function safeInvoke(fn: (() => void) | null | undefined): void;
 /** Hands one teardown to `instrumentOnce`. Accepts nothing, for a listener an install chose to skip. */
 type TrackTeardown = (teardown: (() => void) | null | undefined) => void;
 /**
- * Instrument `target` at most once at a time, tearing down any prior instrumentation of the same object
- * first. Vite HMR re-runs boot code against a router that survives the reload, so without this every
- * cycle appends another listener set that is never removed. Keyed on the object, so a genuinely new
+ * Instruments `target` at most once at a time, tearing down any prior instrumentation of the same
+ * object first. Vite HMR re-runs boot code against a router that survives the reload, so without this
+ * every cycle would add another listener set that is never removed. Keyed on the object, so a new
  * router is unaffected.
  *
- * `install` hands each teardown to `track` as it produces it. A router's own `subscribe` / `on` / guard
- * registration can throw, and `install` runs during the host's bootstrap, so a throw part-way through
- * unwinds what already succeeded (newest first) and stops here rather than reaching the host.
+ * `install` hands each teardown to `track` as it produces it. A router's `subscribe`/`on`/guard call
+ * can throw during the host's bootstrap, so a throw part-way through unwinds what already succeeded
+ * (newest first) instead of reaching the host.
  *
- * @returns the cleanup, or a no-op when the install failed and already unwound itself.
+ * @returns The cleanup function, or a no-op if install failed and already unwound itself.
  */
 declare function instrumentOnce<T extends object>(target: T, install: (track: TrackTeardown) => void): () => void;
 //#endregion
@@ -124,16 +127,16 @@ type ComponentTraceContext = {
 /** Unix nanos on the same clock the tracer uses for span timestamps. */
 declare const nowNano: typeof defaultNowNano;
 /**
- * Reserved up front so descendants can point at a span before it is recorded. Null when the trace is at
- * its span cap: descendants record before this span does, so an id the cap will refuse orphans them.
+ * Reserved up front so descendants can point at a span before it is recorded. Null when the trace
+ * is at its span cap, since descendants record before this span does and would be orphaned.
  */
 declare function reserveSpanId(traceId?: string): string | null;
 /** The root a top-level component nests under. Null when tracing is off or no root is recording. */
 declare function activeComponentRoot(): ComponentTraceContext | null;
 /**
- * An ancestor's context is only usable while it still belongs to the live trace. A profiled component
- * that survives a navigation (a layout around a swapped page body) froze its context under the pageload
- * trace, and `recordComponentSpan` would drop anything pointing at that closed root.
+ * An ancestor's context is only usable while it still belongs to the live trace. A component that
+ * survives a navigation (a layout around a swapped page body) froze its context under the old
+ * pageload trace, and `recordComponentSpan` would drop anything pointing at that closed root.
  */
 declare function resolveComponentParent(inherited: ComponentTraceContext | null | undefined, live: ComponentTraceContext | null): ComponentTraceContext | null;
 /** What a profiler hands back for one component mount. */
@@ -146,9 +149,9 @@ type ComponentSpanRecord = {
   attributes?: Attributes;
 };
 /**
- * Records only while the reserved root is still the live recording root, and drops the span otherwise.
- * Dropping avoids starting a fresh TraceState for a dead trace, which would re-run the sampler, and
- * avoids adding a child to a root that already shipped.
+ * Records only while the reserved root is still the live recording root, and drops the span
+ * otherwise. Dropping avoids re-running the sampler for a dead trace and avoids adding a child to
+ * a root that already shipped.
  */
 declare function recordComponentSpan(record: ComponentSpanRecord): void;
 //#endregion

package/dist/{spanTypes-7-nEycOc.d.mts → spanTypes-RYeFN_pN.d.mts}

@@ -3,11 +3,10 @@ import { Attributes, BrowserSpanType as BrowserSpanType$1, Config, ContextCollec
 
 //#region src/createFlareResolver.d.ts
 /**
- * Builds a per-package Flare resolver: `registerDefaultFlare` (wired once by the web entry) and
- * `resolveFlare` (called at wiring time). Each call holds its own default-provider state. The check
- * that warns about the Electron `__flare` bridge uses `packageName` in its message;
- * `injectInstruction` replaces the closing hint for packages whose advice differs (for example
- * svelte, which points at the preprocessor's importSource).
+ * Builds a per-package Flare resolver: `registerDefaultFlare` (set once by the web entry) and
+ * `resolveFlare` (called at wiring time). Each call keeps its own default-provider state.
+ * `packageName` names the package in the Electron-bridge warning; `injectInstruction` overrides the
+ * closing hint for packages with different advice (for example Svelte's preprocessor importSource).
  */
 declare function createFlareResolver(config: {
   packageName: string;
@@ -45,9 +44,7 @@ declare class BrowserFlushScheduler implements FlushScheduler {
 //#region src/instrumentation/navigation/types.d.ts
 type RouteName = {
   name: string;
-  source: 'route' | 'url';
-  /** Where the navigation ends. Set on a redirect so the final url is reported; leave out to keep
-   *  the url the root opened with. */
+  source: 'route' | 'url'; /** Where the navigation ends. Set on a redirect so the report uses the final url, not the url the root opened with. */
   url?: string;
 };
 type NavigationSource = {
@@ -63,12 +60,17 @@ type NavigationSource = {
 //#endregion
 //#region src/instrumentation/navigation/utils.d.ts
 declare function currentPath(): string;
+/** The whole address, query string included. */
 declare function currentHref(): string;
+/**
+ * Prefers the router's route template (`/product/:id`) over the raw path, so all urls of one route
+ * group together. If `derive` throws, the fallback path is used instead of breaking the app.
+ */
 declare function routeName(derive: () => string | undefined, fallbackPath: string, url?: string): RouteName;
 /**
- * `build` is the router's own href builder (vue-router `resolve`, React Router `createHref`). It puts
- * the app's base path and hash prefix back. Without it, an app served from `/app/` reports
- * `/product/p01` instead of `/app/product/p01`. If `build` throws, we use `fallback`.
+ * `build` is the router's own href builder (vue-router `resolve`, React Router `createHref`). It restores
+ * the app's base path and hash prefix, so an app served from `/app/` reports `/app/product/p01` instead
+ * of `/product/p01`. Falls back to `fallbackHref` if `build` throws.
  */
 declare function resolveHref(build: () => string | null | undefined, fallbackHref: string): string | undefined;
 //#endregion
@@ -82,16 +84,17 @@ declare function registerNavigationSource(): NavigationSource;
 //#endregion
 //#region src/tracing/utils/absoluteHref.d.ts
 /**
- * Resolve a router-reported href against the page we are on. Returns the `URL`, so a caller that
- * wants the pathname as well as the href does not parse it a second time.
+ * Resolves a router-reported href against the current page. Returns the `URL`, so a caller that also
+ * wants the pathname does not have to parse it again.
  *
- * Undefined outside a browser or for an unparseable href, so the caller can leave its attribute alone.
+ * Returns undefined outside a browser or for an unparseable href, so the caller can leave its
+ * attribute alone.
  */
 declare function absoluteUrl(href: string | null | undefined): URL | undefined;
 /**
- * The href form of `absoluteUrl`. Pass one built by the router's own `createHref`/`resolve` (see
- * `resolveHref`), not a bare path: routers strip the app's base path, so `origin + path` yields an
- * address the server does not have.
+ * The href form of `absoluteUrl`. Pass a value built by the router's own `createHref`/`resolve`, not
+ * a bare path — routers strip the app's base path, so `origin + path` gives an address the server
+ * does not have.
  */
 declare function absoluteHref(href: string | null | undefined): string | undefined;
 //#endregion
@@ -103,16 +106,16 @@ declare function safeInvoke(fn: (() => void) | null | undefined): void;
 /** Hands one teardown to `instrumentOnce`. Accepts nothing, for a listener an install chose to skip. */
 type TrackTeardown = (teardown: (() => void) | null | undefined) => void;
 /**
- * Instrument `target` at most once at a time, tearing down any prior instrumentation of the same object
- * first. Vite HMR re-runs boot code against a router that survives the reload, so without this every
- * cycle appends another listener set that is never removed. Keyed on the object, so a genuinely new
+ * Instruments `target` at most once at a time, tearing down any prior instrumentation of the same
+ * object first. Vite HMR re-runs boot code against a router that survives the reload, so without this
+ * every cycle would add another listener set that is never removed. Keyed on the object, so a new
  * router is unaffected.
  *
- * `install` hands each teardown to `track` as it produces it. A router's own `subscribe` / `on` / guard
- * registration can throw, and `install` runs during the host's bootstrap, so a throw part-way through
- * unwinds what already succeeded (newest first) and stops here rather than reaching the host.
+ * `install` hands each teardown to `track` as it produces it. A router's `subscribe`/`on`/guard call
+ * can throw during the host's bootstrap, so a throw part-way through unwinds what already succeeded
+ * (newest first) instead of reaching the host.
  *
- * @returns the cleanup, or a no-op when the install failed and already unwound itself.
+ * @returns The cleanup function, or a no-op if install failed and already unwound itself.
  */
 declare function instrumentOnce<T extends object>(target: T, install: (track: TrackTeardown) => void): () => void;
 //#endregion
@@ -124,16 +127,16 @@ type ComponentTraceContext = {
 /** Unix nanos on the same clock the tracer uses for span timestamps. */
 declare const nowNano: typeof defaultNowNano;
 /**
- * Reserved up front so descendants can point at a span before it is recorded. Null when the trace is at
- * its span cap: descendants record before this span does, so an id the cap will refuse orphans them.
+ * Reserved up front so descendants can point at a span before it is recorded. Null when the trace
+ * is at its span cap, since descendants record before this span does and would be orphaned.
  */
 declare function reserveSpanId(traceId?: string): string | null;
 /** The root a top-level component nests under. Null when tracing is off or no root is recording. */
 declare function activeComponentRoot(): ComponentTraceContext | null;
 /**
- * An ancestor's context is only usable while it still belongs to the live trace. A profiled component
- * that survives a navigation (a layout around a swapped page body) froze its context under the pageload
- * trace, and `recordComponentSpan` would drop anything pointing at that closed root.
+ * An ancestor's context is only usable while it still belongs to the live trace. A component that
+ * survives a navigation (a layout around a swapped page body) froze its context under the old
+ * pageload trace, and `recordComponentSpan` would drop anything pointing at that closed root.
  */
 declare function resolveComponentParent(inherited: ComponentTraceContext | null | undefined, live: ComponentTraceContext | null): ComponentTraceContext | null;
 /** What a profiler hands back for one component mount. */
@@ -146,9 +149,9 @@ type ComponentSpanRecord = {
   attributes?: Attributes;
 };
 /**
- * Records only while the reserved root is still the live recording root, and drops the span otherwise.
- * Dropping avoids starting a fresh TraceState for a dead trace, which would re-run the sampler, and
- * avoids adding a child to a root that already shipped.
+ * Records only while the reserved root is still the live recording root, and drops the span
+ * otherwise. Dropping avoids re-running the sampler for a dead trace and avoids adding a child to
+ * a root that already shipped.
  */
 declare function recordComponentSpan(record: ComponentSpanRecord): void;
 //#endregion

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@flareapp/js",
-    "version": "2.11.0",
+    "version": "2.12.1",
     "description": "JavaScript client for flareapp.io",
     "homepage": "https://flareapp.io",
     "bugs": {
@@ -59,7 +59,7 @@
         "release": "release-it"
     },
     "dependencies": {
-        "@flareapp/core": "2.11.0"
+        "@flareapp/core": "2.12.1"
     },
     "devDependencies": {
         "@flareapp/test-helpers": "*",