@chordcommerce/analytics 1.22.2 → 1.23.0-beta.1

package/dist/cjs/client/consent/cookiebot.d.ts

@@ -0,0 +1,31 @@
+import type { ConsentConfiguration } from '../../types/index.js';
+declare global {
+    interface Window {
+        Cookiebot?: CookiebotApi;
+    }
+}
+/**
+ * Cookiebot's consent state. `method` describes how consent was given
+ * ('implied' | 'explicit' | null) and is intentionally excluded from categories.
+ */
+interface CookiebotConsent {
+    necessary: boolean;
+    preferences: boolean;
+    statistics: boolean;
+    marketing: boolean;
+    method?: string | null;
+}
+interface CookiebotApi {
+    consent: CookiebotConsent;
+    consented: boolean;
+    declined: boolean;
+    hasResponse: boolean;
+}
+export declare const cookiebotConsentAdapter: () => {
+    getCurrentConsent: () => ConsentConfiguration;
+    handleConsentUpdates: (updateCdpConsent: (consent: ConsentConfiguration) => void) => void;
+    userCanBeTracked: () => boolean;
+    getCategories: () => Record<string, boolean>;
+    isConsentReady: () => boolean;
+};
+export {};

package/dist/cjs/client/consent/cookiebot.js

@@ -0,0 +1,96 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cookiebotConsentAdapter = void 0;
+/**
+ * The four standard Cookiebot consent categories.
+ */
+var CONSENT_CATEGORIES = [
+    'necessary',
+    'preferences',
+    'statistics',
+    'marketing',
+];
+/**
+ * Returns the Cookiebot global API if it is fully loaded.
+ *
+ * Duck-types on the `consent` object since window.Cookiebot may exist before
+ * the consent state has been populated. The explicit `api.consent` truthiness
+ * check is required because `typeof null === 'object'`, so a null consent would
+ * otherwise pass the guard and crash downstream reads.
+ */
+var getApi = function () {
+    var api = window.Cookiebot;
+    if (api &&
+        typeof api === 'object' &&
+        api.consent &&
+        typeof api.consent === 'object') {
+        return api;
+    }
+    return undefined;
+};
+/**
+ * Returns the user's current Cookiebot consent categories.
+ * Reads FRESH from Cookiebot each time - no caching!
+ */
+var getCategories = function () {
+    var api = getApi();
+    if (!api)
+        return {};
+    return CONSENT_CATEGORIES.reduce(function (acc, category) {
+        acc[category] = !!api.consent[category];
+        return acc;
+    }, {});
+};
+/**
+ * Returns whether the user can currently be tracked.
+ * Requires statistics consent (Cookiebot's analytics category) to be granted.
+ * Intentionally does not gate on `hasResponse`, so implied-consent setups —
+ * where statistics is allowed without an explicit banner interaction — are
+ * tracked immediately rather than blocked until the visitor clicks.
+ */
+var userCanBeTracked = function () {
+    var api = getApi();
+    if (!api)
+        return false;
+    return !!api.consent.statistics;
+};
+/**
+ * Returns the user's current consent configuration.
+ */
+var getCurrentConsent = function () {
+    var api = getApi();
+    if (!api)
+        return {};
+    return {
+        consentCategories: getCategories(),
+    };
+};
+/**
+ * Handles subsequent changes to consent configuration.
+ * CookiebotOnConsentReady fires on both accept and decline, so it covers the
+ * full set of consent transitions with a single listener.
+ */
+var handleConsentUpdates = function (updateCdpConsent) {
+    window.addEventListener('CookiebotOnConsentReady', function () {
+        updateCdpConsent(getCurrentConsent());
+    });
+};
+var cookiebotConsentAdapter = function () {
+    return {
+        getCurrentConsent: getCurrentConsent,
+        handleConsentUpdates: handleConsentUpdates,
+        userCanBeTracked: userCanBeTracked,
+        getCategories: getCategories,
+        // Consent is ready once the visitor has responded to the banner (accept or
+        // decline) OR statistics is already granted (implied-consent setups, where
+        // consent is auto-granted without a banner click). Gating on hasResponse
+        // alone would queue implied-consent events indefinitely; gating on
+        // statistics alone would strand declined-statistics visitors. Requiring
+        // either preserves the opt-in "hold until the visitor decides" behavior.
+        isConsentReady: function () {
+            var api = getApi();
+            return !!api && (api.hasResponse || !!api.consent.statistics);
+        },
+    };
+};
+exports.cookiebotConsentAdapter = cookiebotConsentAdapter;

package/dist/cjs/client/consent/index.js

@@ -37,6 +37,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.addCdpConsent = void 0;
+var cookiebot_js_1 = require("./cookiebot.js");
 var ketch_js_1 = require("./ketch.js");
 var onetrust_js_1 = require("./onetrust.js");
 var shopify_js_1 = require("./shopify.js");
@@ -53,6 +54,8 @@ var addCdpConsent = function (options) {
     var getAdapter = function () {
         var _a;
         switch ((_a = options.consent) === null || _a === void 0 ? void 0 : _a.toLowerCase()) {
+            case 'cookiebot':
+                return (0, cookiebot_js_1.cookiebotConsentAdapter)();
             case 'ketch':
                 return (0, ketch_js_1.ketchConsentAdapter)();
             case 'onetrust':

package/dist/cjs/types/client.d.ts

@@ -30,7 +30,7 @@ export interface ChordAnalyticsOptions<T extends ObjectTypes = ObjectTypes> {
     cdp?: AnyAnalytics | (() => AnyAnalytics);
     cdpDomain?: string;
     cdpWriteKey?: string;
-    consent?: 'ketch' | 'onetrust' | 'shopify' | 'segment';
+    consent?: 'cookiebot' | 'ketch' | 'onetrust' | 'shopify' | 'segment';
     awaitConsent?: boolean;
     debug?: boolean;
     enableLogging?: boolean;

package/dist/client/consent/cookiebot.d.ts

@@ -0,0 +1,31 @@
+import type { ConsentConfiguration } from '../../types/index.js';
+declare global {
+    interface Window {
+        Cookiebot?: CookiebotApi;
+    }
+}
+/**
+ * Cookiebot's consent state. `method` describes how consent was given
+ * ('implied' | 'explicit' | null) and is intentionally excluded from categories.
+ */
+interface CookiebotConsent {
+    necessary: boolean;
+    preferences: boolean;
+    statistics: boolean;
+    marketing: boolean;
+    method?: string | null;
+}
+interface CookiebotApi {
+    consent: CookiebotConsent;
+    consented: boolean;
+    declined: boolean;
+    hasResponse: boolean;
+}
+export declare const cookiebotConsentAdapter: () => {
+    getCurrentConsent: () => ConsentConfiguration;
+    handleConsentUpdates: (updateCdpConsent: (consent: ConsentConfiguration) => void) => void;
+    userCanBeTracked: () => boolean;
+    getCategories: () => Record<string, boolean>;
+    isConsentReady: () => boolean;
+};
+export {};

package/dist/client/consent/cookiebot.js

@@ -0,0 +1,92 @@
+/**
+ * The four standard Cookiebot consent categories.
+ */
+const CONSENT_CATEGORIES = [
+    'necessary',
+    'preferences',
+    'statistics',
+    'marketing',
+];
+/**
+ * Returns the Cookiebot global API if it is fully loaded.
+ *
+ * Duck-types on the `consent` object since window.Cookiebot may exist before
+ * the consent state has been populated. The explicit `api.consent` truthiness
+ * check is required because `typeof null === 'object'`, so a null consent would
+ * otherwise pass the guard and crash downstream reads.
+ */
+const getApi = () => {
+    const api = window.Cookiebot;
+    if (api &&
+        typeof api === 'object' &&
+        api.consent &&
+        typeof api.consent === 'object') {
+        return api;
+    }
+    return undefined;
+};
+/**
+ * Returns the user's current Cookiebot consent categories.
+ * Reads FRESH from Cookiebot each time - no caching!
+ */
+const getCategories = () => {
+    const api = getApi();
+    if (!api)
+        return {};
+    return CONSENT_CATEGORIES.reduce((acc, category) => {
+        acc[category] = !!api.consent[category];
+        return acc;
+    }, {});
+};
+/**
+ * Returns whether the user can currently be tracked.
+ * Requires statistics consent (Cookiebot's analytics category) to be granted.
+ * Intentionally does not gate on `hasResponse`, so implied-consent setups —
+ * where statistics is allowed without an explicit banner interaction — are
+ * tracked immediately rather than blocked until the visitor clicks.
+ */
+const userCanBeTracked = () => {
+    const api = getApi();
+    if (!api)
+        return false;
+    return !!api.consent.statistics;
+};
+/**
+ * Returns the user's current consent configuration.
+ */
+const getCurrentConsent = () => {
+    const api = getApi();
+    if (!api)
+        return {};
+    return {
+        consentCategories: getCategories(),
+    };
+};
+/**
+ * Handles subsequent changes to consent configuration.
+ * CookiebotOnConsentReady fires on both accept and decline, so it covers the
+ * full set of consent transitions with a single listener.
+ */
+const handleConsentUpdates = (updateCdpConsent) => {
+    window.addEventListener('CookiebotOnConsentReady', () => {
+        updateCdpConsent(getCurrentConsent());
+    });
+};
+export const cookiebotConsentAdapter = () => {
+    return {
+        getCurrentConsent,
+        handleConsentUpdates,
+        userCanBeTracked,
+        getCategories,
+        // Consent is ready once the visitor has responded to the banner (accept or
+        // decline) OR statistics is already granted (implied-consent setups, where
+        // consent is auto-granted without a banner click). Gating on hasResponse
+        // alone would queue implied-consent events indefinitely; gating on
+        // statistics alone would strand declined-statistics visitors. Requiring
+        // either preserves the opt-in "hold until the visitor decides" behavior.
+        isConsentReady: () => {
+            const api = getApi();
+            return !!api && (api.hasResponse || !!api.consent.statistics);
+        },
+    };
+};

package/dist/client/consent/index.js

@@ -7,6 +7,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+import { cookiebotConsentAdapter } from './cookiebot.js';
 import { ketchConsentAdapter } from './ketch.js';
 import { onetrustConsentAdapter } from './onetrust.js';
 import { shopifyConsentAdapter } from './shopify.js';
@@ -23,6 +24,8 @@ export const addCdpConsent = (options) => {
     const getAdapter = () => {
         var _a;
         switch ((_a = options.consent) === null || _a === void 0 ? void 0 : _a.toLowerCase()) {
+            case 'cookiebot':
+                return cookiebotConsentAdapter();
             case 'ketch':
                 return ketchConsentAdapter();
             case 'onetrust':

package/dist/types/client.d.ts

@@ -30,7 +30,7 @@ export interface ChordAnalyticsOptions<T extends ObjectTypes = ObjectTypes> {
     cdp?: AnyAnalytics | (() => AnyAnalytics);
     cdpDomain?: string;
     cdpWriteKey?: string;
-    consent?: 'ketch' | 'onetrust' | 'shopify' | 'segment';
+    consent?: 'cookiebot' | 'ketch' | 'onetrust' | 'shopify' | 'segment';
     awaitConsent?: boolean;
     debug?: boolean;
     enableLogging?: boolean;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@chordcommerce/analytics",
   "description": "Chord Commerce event tracking",
-  "version": "1.22.2",
+  "version": "1.23.0-beta.1",
   "author": "Chord Commerce <help@chord.co> (https://www.chord.co)",
   "type": "module",
   "main": "dist/index.js",