@flareapp/js 2.9.0 → 2.11.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,5 +1,5 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-const require_catchWindowErrors = require('./catchWindowErrors-cR2D7kju.cjs');
+const require_catchWindowErrors = require('./catchWindowErrors-BgmDgTlR.cjs');
 let _flareapp_core = require("@flareapp/core");
 
 //#region src/browser.ts

package/dist/browser.mjs

@@ -1,4 +1,4 @@
-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-C0gSVGiF.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-I_8ksYoj.mjs";
 import { Api, Flare as Flare$1, FrameworkName, GlobalScopeProvider } from "@flareapp/core";
 
 //#region src/browser.ts

package/dist/{catchWindowErrors-cR2D7kju.cjs → catchWindowErrors-BgmDgTlR.cjs}

@@ -995,6 +995,86 @@ function cookie(denylist) {
 	return { "http.request.cookies": cookies };
 }
 
+//#endregion
+//#region src/browser/context/deviceReaders.ts
+const EFFECTIVE_TYPES = [
+	"slow-2g",
+	"2g",
+	"3g",
+	"4g"
+];
+function readScreen() {
+	if (typeof screen === "undefined" || typeof screen.width !== "number" || typeof screen.height !== "number") return null;
+	const scale = typeof devicePixelRatio === "number" ? devicePixelRatio : void 0;
+	return scale != null ? {
+		width: screen.width,
+		height: screen.height,
+		scale
+	} : {
+		width: screen.width,
+		height: screen.height
+	};
+}
+function readNetwork(nav) {
+	const network = {};
+	if (typeof nav.onLine === "boolean") network.online = nav.onLine;
+	const connection = nav.connection;
+	if (connection) {
+		const { effectiveType, downlink, rtt } = connection;
+		if (effectiveType && EFFECTIVE_TYPES.includes(effectiveType)) network.effectiveType = effectiveType;
+		if (typeof downlink === "number") network.downlinkMbps = downlink;
+		if (typeof rtt === "number") network.rttMs = rtt;
+	}
+	return Object.keys(network).length > 0 ? network : null;
+}
+function readTimezone() {
+	try {
+		return Intl.DateTimeFormat().resolvedOptions().timeZone || void 0;
+	} catch {
+		return;
+	}
+}
+
+//#endregion
+//#region src/browser/context/deviceInfo.ts
+/** Reads what the User-Agent lacks: hardware, screen, network. Static reads cached; screen and network per call. */
+var BrowserDeviceInfoProvider = class {
+	staticInfo = null;
+	collect() {
+		if (typeof window === "undefined" || typeof navigator === "undefined") return {};
+		const nav = navigator;
+		const info = {};
+		const staticInfo = this.readStatic(nav);
+		const screen = readScreen();
+		const device = {
+			...staticInfo.device,
+			...screen ? { screen } : {}
+		};
+		if (Object.keys(device).length > 0) info.device = device;
+		if (staticInfo.locale) info.locale = staticInfo.locale;
+		const network = readNetwork(nav);
+		if (network) info.network = network;
+		return info;
+	}
+	readStatic(nav) {
+		if (this.staticInfo) return this.staticInfo;
+		const device = {};
+		if (typeof nav.deviceMemory === "number") device.memoryGb = nav.deviceMemory;
+		if (typeof nav.hardwareConcurrency === "number") device.cpuCores = nav.hardwareConcurrency;
+		const locale = {};
+		if (nav.language) locale.language = nav.language;
+		const timezone = readTimezone();
+		if (timezone) locale.timezone = timezone;
+		this.staticInfo = {
+			device: Object.keys(device).length > 0 ? device : void 0,
+			locale: Object.keys(locale).length > 0 ? locale : void 0
+		};
+		return this.staticInfo;
+	}
+};
+/** Shared singleton so the static read is cached across reports. */
+const browserDeviceInfoProvider = new BrowserDeviceInfoProvider();
+
 //#endregion
 //#region src/browser/context/request.ts
 /**
@@ -1030,6 +1110,7 @@ function browserEntryPoint(config, urlOverride) {
 }
 const collectBrowser = (config) => {
 	const attrs = { ...browserEntryPoint(config) };
+	Object.assign(attrs, (0, _flareapp_core.deviceInfoToAttributes)(browserDeviceInfoProvider.collect()));
 	if (typeof window === "undefined") return attrs;
 	if (window?.location?.hostname) attrs["host.name"] = window.location.hostname;
 	Object.assign(attrs, request(config.urlDenylist));
@@ -1056,7 +1137,7 @@ var FetchFileReader = class {
 
 //#endregion
 //#region src/env/index.ts
-const CLIENT_VERSION = typeof process !== "undefined" && true ? "2.9.0" : "?";
+const CLIENT_VERSION = typeof process !== "undefined" && true ? "2.11.0" : "?";
 
 //#endregion
 //#region src/tracing/utils/instrumentationGuard.ts
@@ -1113,12 +1194,10 @@ function instrumentOnce(target, install) {
 //#region src/browser/context/collectBrowserSpanContext.ts
 /**
 * Entry point plus request identity for a pageload/navigation root. Deliberately leaner than the report
-* context: no cookies, no structured query params, no host.name (that is resource-level). Captured at
-* span start, so a long-lived root reflects the page it represents rather than the page at close.
+* context. Captured at span start, so a long-lived root reflects the page it represents rather than the
+* page at close.
 *
-* @param hrefOverride destination href for a router that reports where it is going before the URL
-* commits. Only the URL-derived keys come from it; the rest always reflect the live document. An
-* unparseable override falls back to the live location instead of throwing into root creation.
+* @param hrefOverride destination href for a router that reports where it is going before the URL commits.
 */
 function collectBrowserSpanContext(config, hrefOverride) {
 	if (typeof window === "undefined") return {};
@@ -1131,12 +1210,6 @@ function collectBrowserSpanContext(config, hrefOverride) {
 /**
 * Updates a root's url after a redirect, or when a newer navigation replaces this one. The root opened
 * with the first destination, so without this it reports a page the user never reached.
-*
-* Does not touch `flare.entry_point.handler.identifier` or `http.route`. Those hold the route template,
-* and reading them back from the href would turn `/product/[id]` into `/product/p01`.
-*
-* Always sets `url.query`, even to an empty string. You can overwrite a span attribute but not remove
-* it, so going from `/a?x=1` to `/b` would otherwise keep the old query.
 */
 function browserSpanUrlAttributes(config, href) {
 	if (typeof window === "undefined") return {};

package/dist/{catchWindowErrors-C0gSVGiF.mjs → catchWindowErrors-I_8ksYoj.mjs}

@@ -1,4 +1,4 @@
-import { BrowserSpanEventType, BrowserSpanType, BrowserSpanType as BrowserSpanType$1, SpanStatusCode, breadcrumbUrl, buildTraceparent, defaultNowNano, redactUrlQuery, routeRejection, spanId, urlAttributes } from "@flareapp/core";
+import { BrowserSpanEventType, BrowserSpanType, BrowserSpanType as BrowserSpanType$1, SpanStatusCode, breadcrumbUrl, buildTraceparent, defaultNowNano, deviceInfoToAttributes, redactUrlQuery, routeRejection, spanId, urlAttributes } from "@flareapp/core";
 
 //#region src/breadcrumbs/utils/documentEvent.ts
 function onDocumentEvent(name, handle) {
@@ -995,6 +995,86 @@ function cookie(denylist) {
 	return { "http.request.cookies": cookies };
 }
 
+//#endregion
+//#region src/browser/context/deviceReaders.ts
+const EFFECTIVE_TYPES = [
+	"slow-2g",
+	"2g",
+	"3g",
+	"4g"
+];
+function readScreen() {
+	if (typeof screen === "undefined" || typeof screen.width !== "number" || typeof screen.height !== "number") return null;
+	const scale = typeof devicePixelRatio === "number" ? devicePixelRatio : void 0;
+	return scale != null ? {
+		width: screen.width,
+		height: screen.height,
+		scale
+	} : {
+		width: screen.width,
+		height: screen.height
+	};
+}
+function readNetwork(nav) {
+	const network = {};
+	if (typeof nav.onLine === "boolean") network.online = nav.onLine;
+	const connection = nav.connection;
+	if (connection) {
+		const { effectiveType, downlink, rtt } = connection;
+		if (effectiveType && EFFECTIVE_TYPES.includes(effectiveType)) network.effectiveType = effectiveType;
+		if (typeof downlink === "number") network.downlinkMbps = downlink;
+		if (typeof rtt === "number") network.rttMs = rtt;
+	}
+	return Object.keys(network).length > 0 ? network : null;
+}
+function readTimezone() {
+	try {
+		return Intl.DateTimeFormat().resolvedOptions().timeZone || void 0;
+	} catch {
+		return;
+	}
+}
+
+//#endregion
+//#region src/browser/context/deviceInfo.ts
+/** Reads what the User-Agent lacks: hardware, screen, network. Static reads cached; screen and network per call. */
+var BrowserDeviceInfoProvider = class {
+	staticInfo = null;
+	collect() {
+		if (typeof window === "undefined" || typeof navigator === "undefined") return {};
+		const nav = navigator;
+		const info = {};
+		const staticInfo = this.readStatic(nav);
+		const screen = readScreen();
+		const device = {
+			...staticInfo.device,
+			...screen ? { screen } : {}
+		};
+		if (Object.keys(device).length > 0) info.device = device;
+		if (staticInfo.locale) info.locale = staticInfo.locale;
+		const network = readNetwork(nav);
+		if (network) info.network = network;
+		return info;
+	}
+	readStatic(nav) {
+		if (this.staticInfo) return this.staticInfo;
+		const device = {};
+		if (typeof nav.deviceMemory === "number") device.memoryGb = nav.deviceMemory;
+		if (typeof nav.hardwareConcurrency === "number") device.cpuCores = nav.hardwareConcurrency;
+		const locale = {};
+		if (nav.language) locale.language = nav.language;
+		const timezone = readTimezone();
+		if (timezone) locale.timezone = timezone;
+		this.staticInfo = {
+			device: Object.keys(device).length > 0 ? device : void 0,
+			locale: Object.keys(locale).length > 0 ? locale : void 0
+		};
+		return this.staticInfo;
+	}
+};
+/** Shared singleton so the static read is cached across reports. */
+const browserDeviceInfoProvider = new BrowserDeviceInfoProvider();
+
 //#endregion
 //#region src/browser/context/request.ts
 /**
@@ -1030,6 +1110,7 @@ function browserEntryPoint(config, urlOverride) {
 }
 const collectBrowser = (config) => {
 	const attrs = { ...browserEntryPoint(config) };
+	Object.assign(attrs, deviceInfoToAttributes(browserDeviceInfoProvider.collect()));
 	if (typeof window === "undefined") return attrs;
 	if (window?.location?.hostname) attrs["host.name"] = window.location.hostname;
 	Object.assign(attrs, request(config.urlDenylist));
@@ -1056,7 +1137,7 @@ var FetchFileReader = class {
 
 //#endregion
 //#region src/env/index.ts
-const CLIENT_VERSION = typeof process !== "undefined" && true ? "2.9.0" : "?";
+const CLIENT_VERSION = typeof process !== "undefined" && true ? "2.11.0" : "?";
 
 //#endregion
 //#region src/tracing/utils/instrumentationGuard.ts
@@ -1113,12 +1194,10 @@ function instrumentOnce(target, install) {
 //#region src/browser/context/collectBrowserSpanContext.ts
 /**
 * Entry point plus request identity for a pageload/navigation root. Deliberately leaner than the report
-* context: no cookies, no structured query params, no host.name (that is resource-level). Captured at
-* span start, so a long-lived root reflects the page it represents rather than the page at close.
+* context. Captured at span start, so a long-lived root reflects the page it represents rather than the
+* page at close.
 *
-* @param hrefOverride destination href for a router that reports where it is going before the URL
-* commits. Only the URL-derived keys come from it; the rest always reflect the live document. An
-* unparseable override falls back to the live location instead of throwing into root creation.
+* @param hrefOverride destination href for a router that reports where it is going before the URL commits.
 */
 function collectBrowserSpanContext(config, hrefOverride) {
 	if (typeof window === "undefined") return {};
@@ -1131,12 +1210,6 @@ function collectBrowserSpanContext(config, hrefOverride) {
 /**
 * Updates a root's url after a redirect, or when a newer navigation replaces this one. The root opened
 * with the first destination, so without this it reports a page the user never reached.
-*
-* Does not touch `flare.entry_point.handler.identifier` or `http.route`. Those hold the route template,
-* and reading them back from the href would turn `/product/[id]` into `/product/p01`.
-*
-* Always sets `url.query`, even to an empty string. You can overwrite a span attribute but not remove
-* it, so going from `/a?x=1` to `/b` would otherwise keep the old query.
 */
 function browserSpanUrlAttributes(config, href) {
 	if (typeof window === "undefined") return {};

package/dist/index.cjs

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

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { n as createFlareResolver, t as catchWindowErrors } from "./catchWindowErrors-C0gSVGiF.mjs";
+import { n as createFlareResolver, t as catchWindowErrors } from "./catchWindowErrors-I_8ksYoj.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/package.json

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