@chordcommerce/analytics 1.11.0 → 1.12.0

package/dist/client/consent/index.js

@@ -8,6 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { ketchConsentAdapter } from './ketch.js';
+import { onetrustConsentAdapter } from './onetrust.js';
 import { shopifyConsentAdapter } from './shopify.js';
 export const addCdpConsent = (options) => {
     let adapter;
@@ -19,6 +20,8 @@ export const addCdpConsent = (options) => {
         switch ((_a = options.consent) === null || _a === void 0 ? void 0 : _a.toLowerCase()) {
             case 'ketch':
                 return ketchConsentAdapter();
+            case 'onetrust':
+                return onetrustConsentAdapter();
             case 'shopify':
                 return shopifyConsentAdapter();
             default:

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

@@ -0,0 +1,22 @@
+import type { ConsentConfiguration } from '../../types/index.js';
+declare global {
+    interface Window {
+        OneTrust?: OneTrustApi;
+        OnetrustActiveGroups?: string;
+    }
+}
+interface OneTrustApi {
+    OnConsentChanged: (callback: () => void) => void;
+    GetDomainData: () => {
+        Groups: OneTrustGroup[];
+    };
+}
+interface OneTrustGroup {
+    CustomGroupId: string;
+}
+export declare const onetrustConsentAdapter: () => {
+    getCurrentConsent: () => ConsentConfiguration;
+    handleConsentUpdates: (updateCdpConsent: (consent: ConsentConfiguration) => void) => void;
+    userCanBeTracked: () => boolean;
+};
+export {};

package/dist/client/consent/onetrust.js

@@ -0,0 +1,56 @@
+/**
+ * Returns OneTrust's API.
+ */
+const getApi = () => {
+    const oneTrust = window.OneTrust;
+    if (oneTrust &&
+        typeof oneTrust === 'object' &&
+        'OnConsentChanged' in oneTrust &&
+        'GetDomainData' in oneTrust) {
+        return oneTrust;
+    }
+    return undefined;
+};
+/**
+ * Returns whether the user can currently be tracked.
+ */
+const userCanBeTracked = () => {
+    // Always loads, a la `consentModel: 'opt-out'` in the Segment wrapper.
+    const api = getApi();
+    return !!api;
+};
+/**
+ * Returns the user's current consent configuration.
+ */
+const getCurrentConsent = () => {
+    const api = getApi();
+    const activeGroups = window.OnetrustActiveGroups;
+    if (!api || !activeGroups || typeof activeGroups !== 'string')
+        return {};
+    const activeGroupIds = new Set(activeGroups.trim().split(',').filter(Boolean));
+    return {
+        consentCategories: api
+            .GetDomainData()
+            .Groups.reduce((acc, { CustomGroupId }) => {
+            const groupId = CustomGroupId.trim();
+            acc[groupId] = activeGroupIds.has(groupId);
+            return acc;
+        }, {}),
+        dontSend: !userCanBeTracked(),
+    };
+};
+/**
+ * Handles subsequent changes to consent configuration.
+ */
+const handleConsentUpdates = (updateCdpConsent) => {
+    getApi().OnConsentChanged(() => {
+        updateCdpConsent(getCurrentConsent());
+    });
+};
+export const onetrustConsentAdapter = () => {
+    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?: 'ketch' | 'shopify';
+    consent?: 'ketch' | 'onetrust' | '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.11.0",
+  "version": "1.12.0",
   "author": "Chord Commerce <help@chord.co> (https://www.chord.co)",
   "type": "module",
   "main": "dist/index.js",