@chordcommerce/analytics 1.10.0 → 1.11.0

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 { ketchConsentAdapter } from './ketch.js';
 import { shopifyConsentAdapter } from './shopify.js';
 export const addCdpConsent = (options) => {
     let adapter;
@@ -16,6 +17,8 @@ export const addCdpConsent = (options) => {
     const getAdapter = () => {
         var _a;
         switch ((_a = options.consent) === null || _a === void 0 ? void 0 : _a.toLowerCase()) {
+            case 'ketch':
+                return ketchConsentAdapter();
             case 'shopify':
                 return shopifyConsentAdapter();
             default:
@@ -55,9 +58,10 @@ export const addCdpConsent = (options) => {
         adapter = getAdapter();
         if (adapter === null)
             return Promise.resolve(false);
+        yield shouldLoadCdp();
         updateCdpConsent(adapter === null || adapter === void 0 ? void 0 : adapter.getCurrentConsent());
         adapter === null || adapter === void 0 ? void 0 : adapter.handleConsentUpdates(updateCdpConsent);
-        return shouldLoadCdp();
+        return Promise.resolve(true);
     });
     return {
         init,

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

@@ -0,0 +1,16 @@
+import type { ConsentConfiguration } from '../../types/index.js';
+declare global {
+    interface Window {
+        ketch?: (action: string, eventName: string, handler: () => void) => undefined;
+        ketchConsent?: KetchConsentCategories;
+    }
+}
+interface KetchConsentCategories {
+    [key: string]: boolean;
+}
+export declare const ketchConsentAdapter: () => {
+    getCurrentConsent: () => ConsentConfiguration;
+    handleConsentUpdates: (updateCdpConsent: (consent: ConsentConfiguration) => void) => void;
+    userCanBeTracked: () => boolean;
+};
+export {};

package/dist/client/consent/ketch.js

@@ -0,0 +1,38 @@
+/**
+ * Returns Ketch's consent categories.
+ */
+const getApi = () => window.ketch && window.ketchConsent;
+/**
+ * Returns whether the user can currently be tracked.
+ */
+const userCanBeTracked = () => {
+    const api = getApi();
+    return api && !!Object.keys(api).length;
+};
+/**
+ * Returns the user's current consent configuration.
+ */
+const getCurrentConsent = () => {
+    const api = getApi();
+    if (!api)
+        return {};
+    return {
+        consentCategories: Object.assign({}, api),
+        dontSend: !userCanBeTracked(),
+    };
+};
+/**
+ * Handles subsequent changes to consent configuration.
+ */
+const handleConsentUpdates = (updateCdpConsent) => {
+    window.ketch('addListener', 'consent', () => {
+        updateCdpConsent(getCurrentConsent());
+    });
+};
+export const ketchConsentAdapter = () => {
+    return {
+        getCurrentConsent,
+        handleConsentUpdates,
+        userCanBeTracked,
+    };
+};

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?: 'shopify';
+    consent?: 'ketch' | 'shopify';
     debug?: boolean;
     enableLogging?: boolean;
     formatters: ChordAnalyticsFormatters<T>;

package/package.json

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