@flareapp/js 2.8.0 → 2.10.0

package/README.md

@@ -37,6 +37,49 @@ flare.setUser({
 
 Recognised fields: `id` (→ `user.id`), `email` (→ `user.email`), `fullName` (→ `user.full_name`), `ipAddress` (→ `client.address`). Any extra keys are collected under `user.attributes`. Pass `null` to clear the user on logout: `flare.setUser(null)`.
 
+## Cookie consent and GDPR
+
+The client can run behind a consent tool. When consent is off, it sends nothing. Before consent, it does not even assemble a report.
+
+The switch is one method:
+
+```javascript
+flare.setConsent(true); // allow sending
+flare.setConsent(false); // stop sending, and drop anything captured earlier
+```
+
+Recommended flow: do not call `flare.light(key)` until consent is granted. With no key, nothing sends, so this covers the moment before your consent code runs. Use `setConsent` for withdrawal and re-grant, because once the key is set it is the only clean off switch.
+
+```javascript
+import { flare } from '@flareapp/js';
+
+// Cookiebot example. OneTrust exposes OptanonWrapper; the idea is the same.
+window.addEventListener('CookiebotOnAccept', () => {
+    flare.light('your-project-key'); // first grant: start the client
+    flare.setConsent(true); // and allow sending
+});
+
+window.addEventListener('CookiebotOnDecline', () => {
+    flare.setConsent(false); // withdrawal: stop all sends, drop buffers
+});
+```
+
+If you set the key at boot instead of waiting, start with consent off, then turn it on when the user accepts:
+
+```javascript
+import { flare } from '@flareapp/js';
+
+flare.configure({ hasConsent: false }); // start off, before anything can send
+flare.light('your-project-key');
+
+window.addEventListener('CookiebotOnAccept', () => flare.setConsent(true));
+window.addEventListener('CookiebotOnDecline', () => flare.setConsent(false));
+```
+
+Put `configure({ hasConsent: false })` first, right after the import, so the gate is off before an early uncaught error can assemble a report.
+
+Consent defaults to on, so setups without a consent tool are unchanged. `setConsent(false)` stops data leaving the browser. It does not remove the `fetch` and `XHR` patches that tracing and breadcrumbs install, because those only read in memory and never send on their own. To remove those too, call `flare.configure({ enableTracing: false, enableBreadcrumbs: false })`.
+
 ## Logging
 
 Beyond errors, the client can send structured logs. Logs are opt-in: enable them with `enableLogs`, then call any of

package/dist/browser.cjs

@@ -1,58 +1,71 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-const require_componentProfiler = require('./componentProfiler-C6qY96Bt.cjs');
+const require_catchWindowErrors = require('./catchWindowErrors-zf246a2G.cjs');
 let _flareapp_core = require("@flareapp/core");
 
 //#region src/browser.ts
 var Flare = class extends _flareapp_core.Flare {
-	constructor(api = new _flareapp_core.Api(), contextCollector = require_componentProfiler.collectBrowser, fileReader = new require_componentProfiler.FetchFileReader(), scopeProvider = new _flareapp_core.GlobalScopeProvider()) {
-		super(api, contextCollector, fileReader, scopeProvider, new require_componentProfiler.BrowserFlushScheduler());
+	constructor(api = new _flareapp_core.Api(), contextCollector = require_catchWindowErrors.collectBrowser, fileReader = new require_catchWindowErrors.FetchFileReader(), scopeProvider = new _flareapp_core.GlobalScopeProvider()) {
+		super(api, contextCollector, fileReader, scopeProvider, new require_catchWindowErrors.BrowserFlushScheduler());
 		this.setSdkInfo({
 			name: "@flareapp/js",
-			version: require_componentProfiler.CLIENT_VERSION
+			version: require_catchWindowErrors.CLIENT_VERSION
 		});
 		this.setFramework({ name: _flareapp_core.FrameworkName.Js });
 	}
+	/** Held so a later disable can give the mutation slot back. */
+	removeTracingSubscription = null;
+	stopBreadcrumbs = null;
 	configure(config) {
 		const wasTracing = this.config.enableTracing;
+		const wasBreadcrumbs = this.config.enableBreadcrumbs;
 		super.configure(config);
 		const nowTracing = this.config.enableTracing;
+		const nowBreadcrumbs = this.config.enableBreadcrumbs;
+		if (!wasBreadcrumbs && nowBreadcrumbs) this.stopBreadcrumbs = require_catchWindowErrors.startBreadcrumbs({
+			config: () => this.config,
+			record: (type, attributes, startTimeUnixNano) => this.addBreadcrumb(type, attributes, startTimeUnixNano)
+		});
+		else if (wasBreadcrumbs && !nowBreadcrumbs) {
+			this.stopBreadcrumbs?.();
+			this.stopBreadcrumbs = null;
+		}
 		if (!wasTracing && nowTracing) {
-			require_componentProfiler.instrumentFetch(this);
-			require_componentProfiler.instrumentXHR(this);
-			require_componentProfiler.startBrowserTracing(this);
+			this.removeTracingSubscription = require_catchWindowErrors.withRequestPatches(() => require_catchWindowErrors.traceRequests(this, require_catchWindowErrors.browserUrlContext()));
+			require_catchWindowErrors.startBrowserTracing(this);
 		} else if (wasTracing && !nowTracing) {
-			require_componentProfiler.stopBrowserTracing();
-			require_componentProfiler.unpatchFetch();
-			require_componentProfiler.unpatchXHR();
+			require_catchWindowErrors.stopBrowserTracing();
+			this.removeTracingSubscription?.();
+			this.removeTracingSubscription = null;
 		}
 		return this;
 	}
 };
 
 //#endregion
-exports.BrowserFlushScheduler = require_componentProfiler.BrowserFlushScheduler;
+exports.BrowserFlushScheduler = require_catchWindowErrors.BrowserFlushScheduler;
 Object.defineProperty(exports, 'BrowserSpanType', {
   enumerable: true,
   get: function () {
     return _flareapp_core.BrowserSpanType;
   }
 });
-exports.FetchFileReader = require_componentProfiler.FetchFileReader;
+exports.FetchFileReader = require_catchWindowErrors.FetchFileReader;
 exports.Flare = Flare;
-exports.absoluteHref = require_componentProfiler.absoluteHref;
-exports.absoluteUrl = require_componentProfiler.absoluteUrl;
-exports.activeComponentRoot = require_componentProfiler.activeComponentRoot;
-exports.catchWindowErrors = require_componentProfiler.catchWindowErrors;
-exports.collectBrowser = require_componentProfiler.collectBrowser;
-exports.createFlareResolver = require_componentProfiler.createFlareResolver;
-exports.currentPath = require_componentProfiler.currentPath;
-exports.instrumentOnce = require_componentProfiler.instrumentOnce;
-exports.insulate = require_componentProfiler.insulate;
-exports.nowNano = require_componentProfiler.nowNano;
-exports.recordComponentSpan = require_componentProfiler.recordComponentSpan;
-exports.registerNavigationSource = require_componentProfiler.registerNavigationSource;
-exports.reserveSpanId = require_componentProfiler.reserveSpanId;
-exports.resolveComponentParent = require_componentProfiler.resolveComponentParent;
-exports.resolveHref = require_componentProfiler.resolveHref;
-exports.routeName = require_componentProfiler.routeName;
-exports.safeInvoke = require_componentProfiler.safeInvoke;
+exports.absoluteHref = require_catchWindowErrors.absoluteHref;
+exports.absoluteUrl = require_catchWindowErrors.absoluteUrl;
+exports.activeComponentRoot = require_catchWindowErrors.activeComponentRoot;
+exports.catchWindowErrors = require_catchWindowErrors.catchWindowErrors;
+exports.collectBrowser = require_catchWindowErrors.collectBrowser;
+exports.createFlareResolver = require_catchWindowErrors.createFlareResolver;
+exports.currentHref = require_catchWindowErrors.currentHref;
+exports.currentPath = require_catchWindowErrors.currentPath;
+exports.instrumentOnce = require_catchWindowErrors.instrumentOnce;
+exports.insulate = require_catchWindowErrors.insulate;
+exports.nowNano = require_catchWindowErrors.nowNano;
+exports.recordComponentSpan = require_catchWindowErrors.recordComponentSpan;
+exports.registerNavigationSource = require_catchWindowErrors.registerNavigationSource;
+exports.reserveSpanId = require_catchWindowErrors.reserveSpanId;
+exports.resolveComponentParent = require_catchWindowErrors.resolveComponentParent;
+exports.resolveHref = require_catchWindowErrors.resolveHref;
+exports.routeName = require_catchWindowErrors.routeName;
+exports.safeInvoke = require_catchWindowErrors.safeInvoke;

package/dist/browser.d.cts

@@ -1,10 +1,13 @@
-import { C as collectBrowser, S as FetchFileReader, T as createFlareResolver, _ as RouteName, a as nowNano, b as routeName, c as resolveComponentParent, d as TrackTeardown, f as instrumentOnce, g as NavigationSource, h as registerNavigationSource, i as activeComponentRoot, l as absoluteHref, m as safeInvoke, n as ComponentSpanRecord, o as recordComponentSpan, p as insulate, r as ComponentTraceContext, s as reserveSpanId, t as BrowserSpanType, u as absoluteUrl, v as currentPath, w as catchWindowErrors, x as BrowserFlushScheduler, y as resolveHref } from "./spanTypes-iA1RdfLw.cjs";
+import { C as FetchFileReader, E as createFlareResolver, S as BrowserFlushScheduler, T as catchWindowErrors, _ as currentPath, a as nowNano, b as NavigationSource, c as resolveComponentParent, d as insulate, f as safeInvoke, g as currentHref, h as registerNavigationSource, i as activeComponentRoot, l as TrackTeardown, m as absoluteUrl, n as ComponentSpanRecord, o as recordComponentSpan, p as absoluteHref, r as ComponentTraceContext, s as reserveSpanId, t as BrowserSpanType, u as instrumentOnce, v as resolveHref, w as collectBrowser, x as RouteName, y as routeName } from "./spanTypes-TMgJEZ7G.cjs";
 import { Api, Config, ContextCollector, FileReader, Flare as Flare$1, ScopeProvider } from "@flareapp/core";
 
 //#region src/browser.d.ts
 declare class Flare extends Flare$1 {
   constructor(api?: Api, contextCollector?: ContextCollector, fileReader?: FileReader, scopeProvider?: ScopeProvider);
+  /** Held so a later disable can give the mutation slot back. */
+  private removeTracingSubscription;
+  private stopBreadcrumbs;
   configure(config: Partial<Config>): this;
 }
 //#endregion
-export { BrowserFlushScheduler, BrowserSpanType, type ComponentSpanRecord, type ComponentTraceContext, FetchFileReader, Flare, type NavigationSource, type RouteName, type TrackTeardown, absoluteHref, absoluteUrl, activeComponentRoot, catchWindowErrors, collectBrowser, createFlareResolver, currentPath, instrumentOnce, insulate, nowNano, recordComponentSpan, registerNavigationSource, reserveSpanId, resolveComponentParent, resolveHref, routeName, safeInvoke };
+export { BrowserFlushScheduler, BrowserSpanType, type ComponentSpanRecord, type ComponentTraceContext, FetchFileReader, Flare, type NavigationSource, type RouteName, type TrackTeardown, absoluteHref, absoluteUrl, activeComponentRoot, catchWindowErrors, collectBrowser, createFlareResolver, currentHref, currentPath, instrumentOnce, insulate, nowNano, recordComponentSpan, registerNavigationSource, reserveSpanId, resolveComponentParent, resolveHref, routeName, safeInvoke };

package/dist/browser.d.mts

@@ -1,10 +1,13 @@
-import { C as collectBrowser, S as FetchFileReader, T as createFlareResolver, _ as RouteName, a as nowNano, b as routeName, c as resolveComponentParent, d as TrackTeardown, f as instrumentOnce, g as NavigationSource, h as registerNavigationSource, i as activeComponentRoot, l as absoluteHref, m as safeInvoke, n as ComponentSpanRecord, o as recordComponentSpan, p as insulate, r as ComponentTraceContext, s as reserveSpanId, t as BrowserSpanType, u as absoluteUrl, v as currentPath, w as catchWindowErrors, x as BrowserFlushScheduler, y as resolveHref } from "./spanTypes-CjF1_Uqi.mjs";
+import { C as FetchFileReader, E as createFlareResolver, S as BrowserFlushScheduler, T as catchWindowErrors, _ as currentPath, a as nowNano, b as NavigationSource, c as resolveComponentParent, d as insulate, f as safeInvoke, g as currentHref, h as registerNavigationSource, i as activeComponentRoot, l as TrackTeardown, m as absoluteUrl, n as ComponentSpanRecord, o as recordComponentSpan, p as absoluteHref, r as ComponentTraceContext, s as reserveSpanId, t as BrowserSpanType, u as instrumentOnce, v as resolveHref, w as collectBrowser, x as RouteName, y as routeName } from "./spanTypes-7-nEycOc.mjs";
 import { Api, Config, ContextCollector, FileReader, Flare as Flare$1, ScopeProvider } from "@flareapp/core";
 
 //#region src/browser.d.ts
 declare class Flare extends Flare$1 {
   constructor(api?: Api, contextCollector?: ContextCollector, fileReader?: FileReader, scopeProvider?: ScopeProvider);
+  /** Held so a later disable can give the mutation slot back. */
+  private removeTracingSubscription;
+  private stopBreadcrumbs;
   configure(config: Partial<Config>): this;
 }
 //#endregion
-export { BrowserFlushScheduler, BrowserSpanType, type ComponentSpanRecord, type ComponentTraceContext, FetchFileReader, Flare, type NavigationSource, type RouteName, type TrackTeardown, absoluteHref, absoluteUrl, activeComponentRoot, catchWindowErrors, collectBrowser, createFlareResolver, currentPath, instrumentOnce, insulate, nowNano, recordComponentSpan, registerNavigationSource, reserveSpanId, resolveComponentParent, resolveHref, routeName, safeInvoke };
+export { BrowserFlushScheduler, BrowserSpanType, type ComponentSpanRecord, type ComponentTraceContext, FetchFileReader, Flare, type NavigationSource, type RouteName, type TrackTeardown, absoluteHref, absoluteUrl, activeComponentRoot, catchWindowErrors, collectBrowser, createFlareResolver, currentHref, currentPath, instrumentOnce, insulate, nowNano, recordComponentSpan, registerNavigationSource, reserveSpanId, resolveComponentParent, resolveHref, routeName, safeInvoke };

package/dist/browser.mjs

@@ -1,4 +1,4 @@
-import { C as safeInvoke, D as BrowserFlushScheduler, E as collectBrowser, S as insulate, T as FetchFileReader, _ as unpatchXHR, a as resolveComponentParent, b as BrowserSpanType, c as registerNavigationSource, d as currentPath, f as resolveHref, g as instrumentXHR, h as absoluteUrl, i as reserveSpanId, l as startBrowserTracing, m as absoluteHref, n as nowNano, o as catchWindowErrors, p as routeName, r as recordComponentSpan, s as createFlareResolver, t as activeComponentRoot, u as stopBrowserTracing, v as instrumentFetch, w as CLIENT_VERSION, x as instrumentOnce, y as unpatchFetch } from "./componentProfiler-CoH2m13n.mjs";
+import { C as currentHref, D as absoluteHref, E as routeName, O as absoluteUrl, S as registerNavigationSource, T as resolveHref, _ as BrowserFlushScheduler, a as recordComponentSpan, b as browserUrlContext, c as startBrowserTracing, d as instrumentOnce, f as insulate, g as collectBrowser, h as FetchFileReader, i as nowNano, l as stopBrowserTracing, m as CLIENT_VERSION, n as createFlareResolver, o as reserveSpanId, p as safeInvoke, r as activeComponentRoot, s as resolveComponentParent, t as catchWindowErrors, u as BrowserSpanType, v as startBreadcrumbs, w as currentPath, x as withRequestPatches, y as traceRequests } from "./catchWindowErrors-CkFI5Vwv.mjs";
 import { Api, Flare as Flare$1, FrameworkName, GlobalScopeProvider } from "@flareapp/core";
 
 //#region src/browser.ts
@@ -11,22 +11,34 @@ var Flare = class extends Flare$1 {
 		});
 		this.setFramework({ name: FrameworkName.Js });
 	}
+	/** Held so a later disable can give the mutation slot back. */
+	removeTracingSubscription = null;
+	stopBreadcrumbs = null;
 	configure(config) {
 		const wasTracing = this.config.enableTracing;
+		const wasBreadcrumbs = this.config.enableBreadcrumbs;
 		super.configure(config);
 		const nowTracing = this.config.enableTracing;
+		const nowBreadcrumbs = this.config.enableBreadcrumbs;
+		if (!wasBreadcrumbs && nowBreadcrumbs) this.stopBreadcrumbs = startBreadcrumbs({
+			config: () => this.config,
+			record: (type, attributes, startTimeUnixNano) => this.addBreadcrumb(type, attributes, startTimeUnixNano)
+		});
+		else if (wasBreadcrumbs && !nowBreadcrumbs) {
+			this.stopBreadcrumbs?.();
+			this.stopBreadcrumbs = null;
+		}
 		if (!wasTracing && nowTracing) {
-			instrumentFetch(this);
-			instrumentXHR(this);
+			this.removeTracingSubscription = withRequestPatches(() => traceRequests(this, browserUrlContext()));
 			startBrowserTracing(this);
 		} else if (wasTracing && !nowTracing) {
 			stopBrowserTracing();
-			unpatchFetch();
-			unpatchXHR();
+			this.removeTracingSubscription?.();
+			this.removeTracingSubscription = null;
 		}
 		return this;
 	}
 };
 
 //#endregion
-export { BrowserFlushScheduler, BrowserSpanType, FetchFileReader, Flare, absoluteHref, absoluteUrl, activeComponentRoot, catchWindowErrors, collectBrowser, createFlareResolver, currentPath, instrumentOnce, insulate, nowNano, recordComponentSpan, registerNavigationSource, reserveSpanId, resolveComponentParent, resolveHref, routeName, safeInvoke };
+export { BrowserFlushScheduler, BrowserSpanType, FetchFileReader, Flare, absoluteHref, absoluteUrl, activeComponentRoot, catchWindowErrors, collectBrowser, createFlareResolver, currentHref, currentPath, instrumentOnce, insulate, nowNano, recordComponentSpan, registerNavigationSource, reserveSpanId, resolveComponentParent, resolveHref, routeName, safeInvoke };