@flareapp/js 2.9.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,5 +1,5 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-const require_catchWindowErrors = require('./catchWindowErrors-cR2D7kju.cjs');
+const require_catchWindowErrors = require('./catchWindowErrors-zf246a2G.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-CkFI5Vwv.mjs";
 import { Api, Flare as Flare$1, FrameworkName, GlobalScopeProvider } from "@flareapp/core";
 
 //#region src/browser.ts

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

@@ -1056,7 +1056,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.10.0" : "?";
 
 //#endregion
 //#region src/tracing/utils/instrumentationGuard.ts

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

@@ -1056,7 +1056,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.10.0" : "?";
 
 //#endregion
 //#region src/tracing/utils/instrumentationGuard.ts

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-zf246a2G.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-CkFI5Vwv.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.10.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.10.0"
     },
     "devDependencies": {
         "@flareapp/test-helpers": "*",