@chordcommerce/analytics 1.24.2 → 1.24.4

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

@@ -171,7 +171,7 @@ var addCdpConsent = function (options) {
      * or null if consent setup failed or was blocked.
      */
     var init = function () { return __awaiter(void 0, void 0, void 0, function () {
-        var canBeTracked, error_2;
+        var canBeTracked, error_2, error_3;
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0:
@@ -182,29 +182,38 @@ var addCdpConsent = function (options) {
                         console.error("Consent management adapter \"".concat(options.consent, "\" is not supported."));
                         return [2 /*return*/, null];
                     }
-                    if (!options.awaitConsent) return [3 /*break*/, 2];
+                    if (!options.awaitConsent) return [3 /*break*/, 6];
                     if (options.debug && options.enableLogging) {
                         console.log('[Chord Analytics DEBUG]: awaitConsent is true, checking if user can be tracked');
                     }
                     return [4 /*yield*/, checkUserCanBeTracked()];
                 case 1:
                     canBeTracked = _a.sent();
-                    if (!canBeTracked) {
-                        if (options.debug && options.enableLogging) {
-                            console.log('[Chord Analytics DEBUG]: User cannot be tracked, returning null');
-                        }
-                        return [2 /*return*/, null];
+                    if (!!canBeTracked) return [3 /*break*/, 6];
+                    if (options.debug && options.enableLogging) {
+                        console.log('[Chord Analytics DEBUG]: User cannot be tracked, returning null');
                     }
                     _a.label = 2;
                 case 2:
                     _a.trys.push([2, 4, , 5]);
                     return [4 /*yield*/, setupConsentManagement()];
-                case 3: return [2 /*return*/, _a.sent()];
+                case 3:
+                    _a.sent();
+                    return [3 /*break*/, 5];
                 case 4:
                     error_2 = _a.sent();
                     console.error('Error setting up consent management:', error_2);
+                    return [3 /*break*/, 5];
+                case 5: return [2 /*return*/, null];
+                case 6:
+                    _a.trys.push([6, 8, , 9]);
+                    return [4 /*yield*/, setupConsentManagement()];
+                case 7: return [2 /*return*/, _a.sent()];
+                case 8:
+                    error_3 = _a.sent();
+                    console.error('Error setting up consent management:', error_3);
                     return [2 /*return*/, null];
-                case 5: return [2 /*return*/];
+                case 9: return [2 /*return*/];
             }
         });
     }); };

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

@@ -2,7 +2,11 @@ import type { ConsentConfiguration } from '../../types/index.js';
 declare global {
     interface Window {
         Shopify?: {
-            customerPrivacy?: ShopifyCustomerPrivacyApi;
+            customerPrivacy?: Partial<ShopifyCustomerPrivacyApi>;
+            loadFeatures?: (features: {
+                name: string;
+                version: string;
+            }[], callback?: (error?: unknown) => void) => void;
         };
     }
 }

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

@@ -2,36 +2,81 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.shopifyConsentAdapter = void 0;
 /**
- * Returns Shopify's Customer Privacy API.
+ * Returns Shopify's Customer Privacy API, or undefined until its methods load.
+ *
+ * Shopify puts a placeholder `customerPrivacy` object on every storefront that
+ * holds only cached values. The methods appear once a script requests the
+ * `consent-tracking-api` feature, so the placeholder alone is not usable.
  */
-var getApi = function () { var _a; return (_a = window.Shopify) === null || _a === void 0 ? void 0 : _a.customerPrivacy; };
+var getApi = function () {
+    var _a;
+    var api = (_a = window.Shopify) === null || _a === void 0 ? void 0 : _a.customerPrivacy;
+    if (typeof (api === null || api === void 0 ? void 0 : api.analyticsProcessingAllowed) !== 'function' ||
+        typeof api.marketingAllowed !== 'function' ||
+        typeof api.preferencesProcessingAllowed !== 'function' ||
+        typeof api.saleOfDataAllowed !== 'function') {
+        return undefined;
+    }
+    return api;
+};
+/**
+ * Requests the Customer Privacy API from Shopify when no other script has.
+ * CMPs such as CookieYes load it themselves; Shopify's own banner does not
+ * expose it, which left every event waiting on a consent check that threw.
+ */
+var loadApi = function () {
+    var _a;
+    if (getApi() || typeof ((_a = window.Shopify) === null || _a === void 0 ? void 0 : _a.loadFeatures) !== 'function')
+        return;
+    try {
+        window.Shopify.loadFeatures([{ name: 'consent-tracking-api', version: '0.1' }], function (error) {
+            // eslint-disable-next-line no-console
+            if (error)
+                console.error('Could not load Shopify consent API', error);
+        });
+    }
+    catch (error) {
+        // eslint-disable-next-line no-console
+        console.error('Could not load Shopify consent API', error);
+    }
+};
 /**
  * Returns whether the user can currently be tracked.
+ *
+ * Region is deliberately not checked: Shopify returns an empty region for
+ * visitors it hasn't geolocated (e.g. US visitors who never see a banner),
+ * even when analytics and marketing are both allowed. Opt-in regions already
+ * report both as not allowed until the visitor accepts.
  */
 var userCanBeTracked = function () {
     var api = getApi();
     if (!api)
         return false;
-    return !!(api.getRegion() &&
-        api.analyticsProcessingAllowed() &&
-        api.marketingAllowed());
+    return !!(api.analyticsProcessingAllowed() && api.marketingAllowed());
 };
 /**
- * Returns the user's current consent configuration.
+ * Returns the user's current consent categories, or an empty object until the
+ * API has loaded.
  */
-var getCurrentConsent = function () {
+var getCategories = function () {
     var api = getApi();
     if (!api)
         return {};
     return {
-        consentCategories: {
-            analytics: api.analyticsProcessingAllowed(),
-            marketing: api.marketingAllowed(),
-            preferences: api.preferencesProcessingAllowed(),
-            sale_of_data: api.saleOfDataAllowed(),
-        },
+        analytics: api.analyticsProcessingAllowed(),
+        marketing: api.marketingAllowed(),
+        preferences: api.preferencesProcessingAllowed(),
+        sale_of_data: api.saleOfDataAllowed(),
     };
 };
+/**
+ * Returns the user's current consent configuration.
+ */
+var getCurrentConsent = function () {
+    if (!getApi())
+        return {};
+    return { consentCategories: getCategories() };
+};
 /**
  * Handles subsequent changes to consent configuration.
  */
@@ -41,22 +86,29 @@ var handleConsentUpdates = function (updateCdpConsent) {
     });
 };
 var shopifyConsentAdapter = function () {
+    // Requested once per adapter. Retried from isConsentReady() because the
+    // SDK can start before Shopify defines loadFeatures.
+    var apiRequested = false;
+    var requestApi = function () {
+        var _a;
+        if (apiRequested || typeof ((_a = window.Shopify) === null || _a === void 0 ? void 0 : _a.loadFeatures) !== 'function') {
+            return;
+        }
+        apiRequested = true;
+        loadApi();
+    };
+    requestApi();
     return {
         getCurrentConsent: getCurrentConsent,
         handleConsentUpdates: handleConsentUpdates,
         userCanBeTracked: userCanBeTracked,
-        getCategories: function () {
-            var api = getApi();
-            if (!api)
-                return {};
-            return {
-                analytics: api.analyticsProcessingAllowed(),
-                marketing: api.marketingAllowed(),
-                preferences: api.preferencesProcessingAllowed(),
-                sale_of_data: api.saleOfDataAllowed(),
-            };
+        getCategories: getCategories,
+        isConsentReady: function () {
+            if (getApi())
+                return true;
+            requestApi();
+            return false;
         },
-        isConsentReady: function () { return !!getApi(); },
     };
 };
 exports.shopifyConsentAdapter = shopifyConsentAdapter;

package/dist/client/consent/index.js

@@ -136,6 +136,14 @@ export const addCdpConsent = (options) => {
                 if (options.debug && options.enableLogging) {
                     console.log('[Chord Analytics DEBUG]: User cannot be tracked, returning null');
                 }
+                // Still listen for consent changes, so a visitor who accepts after
+                // the timeout is picked up instead of being lost for the whole visit.
+                try {
+                    yield setupConsentManagement();
+                }
+                catch (error) {
+                    console.error('Error setting up consent management:', error);
+                }
                 return null;
             }
         }

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

@@ -2,7 +2,11 @@ import type { ConsentConfiguration } from '../../types/index.js';
 declare global {
     interface Window {
         Shopify?: {
-            customerPrivacy?: ShopifyCustomerPrivacyApi;
+            customerPrivacy?: Partial<ShopifyCustomerPrivacyApi>;
+            loadFeatures?: (features: {
+                name: string;
+                version: string;
+            }[], callback?: (error?: unknown) => void) => void;
         };
     }
 }

package/dist/client/consent/shopify.js

@@ -1,34 +1,79 @@
 /**
- * Returns Shopify's Customer Privacy API.
+ * Returns Shopify's Customer Privacy API, or undefined until its methods load.
+ *
+ * Shopify puts a placeholder `customerPrivacy` object on every storefront that
+ * holds only cached values. The methods appear once a script requests the
+ * `consent-tracking-api` feature, so the placeholder alone is not usable.
  */
-const getApi = () => { var _a; return (_a = window.Shopify) === null || _a === void 0 ? void 0 : _a.customerPrivacy; };
+const getApi = () => {
+    var _a;
+    const api = (_a = window.Shopify) === null || _a === void 0 ? void 0 : _a.customerPrivacy;
+    if (typeof (api === null || api === void 0 ? void 0 : api.analyticsProcessingAllowed) !== 'function' ||
+        typeof api.marketingAllowed !== 'function' ||
+        typeof api.preferencesProcessingAllowed !== 'function' ||
+        typeof api.saleOfDataAllowed !== 'function') {
+        return undefined;
+    }
+    return api;
+};
+/**
+ * Requests the Customer Privacy API from Shopify when no other script has.
+ * CMPs such as CookieYes load it themselves; Shopify's own banner does not
+ * expose it, which left every event waiting on a consent check that threw.
+ */
+const loadApi = () => {
+    var _a;
+    if (getApi() || typeof ((_a = window.Shopify) === null || _a === void 0 ? void 0 : _a.loadFeatures) !== 'function')
+        return;
+    try {
+        window.Shopify.loadFeatures([{ name: 'consent-tracking-api', version: '0.1' }], (error) => {
+            // eslint-disable-next-line no-console
+            if (error)
+                console.error('Could not load Shopify consent API', error);
+        });
+    }
+    catch (error) {
+        // eslint-disable-next-line no-console
+        console.error('Could not load Shopify consent API', error);
+    }
+};
 /**
  * Returns whether the user can currently be tracked.
+ *
+ * Region is deliberately not checked: Shopify returns an empty region for
+ * visitors it hasn't geolocated (e.g. US visitors who never see a banner),
+ * even when analytics and marketing are both allowed. Opt-in regions already
+ * report both as not allowed until the visitor accepts.
  */
 const userCanBeTracked = () => {
     const api = getApi();
     if (!api)
         return false;
-    return !!(api.getRegion() &&
-        api.analyticsProcessingAllowed() &&
-        api.marketingAllowed());
+    return !!(api.analyticsProcessingAllowed() && api.marketingAllowed());
 };
 /**
- * Returns the user's current consent configuration.
+ * Returns the user's current consent categories, or an empty object until the
+ * API has loaded.
  */
-const getCurrentConsent = () => {
+const getCategories = () => {
     const api = getApi();
     if (!api)
         return {};
     return {
-        consentCategories: {
-            analytics: api.analyticsProcessingAllowed(),
-            marketing: api.marketingAllowed(),
-            preferences: api.preferencesProcessingAllowed(),
-            sale_of_data: api.saleOfDataAllowed(),
-        },
+        analytics: api.analyticsProcessingAllowed(),
+        marketing: api.marketingAllowed(),
+        preferences: api.preferencesProcessingAllowed(),
+        sale_of_data: api.saleOfDataAllowed(),
     };
 };
+/**
+ * Returns the user's current consent configuration.
+ */
+const getCurrentConsent = () => {
+    if (!getApi())
+        return {};
+    return { consentCategories: getCategories() };
+};
 /**
  * Handles subsequent changes to consent configuration.
  */
@@ -38,21 +83,28 @@ const handleConsentUpdates = (updateCdpConsent) => {
     });
 };
 export const shopifyConsentAdapter = () => {
+    // Requested once per adapter. Retried from isConsentReady() because the
+    // SDK can start before Shopify defines loadFeatures.
+    let apiRequested = false;
+    const requestApi = () => {
+        var _a;
+        if (apiRequested || typeof ((_a = window.Shopify) === null || _a === void 0 ? void 0 : _a.loadFeatures) !== 'function') {
+            return;
+        }
+        apiRequested = true;
+        loadApi();
+    };
+    requestApi();
     return {
         getCurrentConsent,
         handleConsentUpdates,
         userCanBeTracked,
-        getCategories: () => {
-            const api = getApi();
-            if (!api)
-                return {};
-            return {
-                analytics: api.analyticsProcessingAllowed(),
-                marketing: api.marketingAllowed(),
-                preferences: api.preferencesProcessingAllowed(),
-                sale_of_data: api.saleOfDataAllowed(),
-            };
+        getCategories,
+        isConsentReady: () => {
+            if (getApi())
+                return true;
+            requestApi();
+            return false;
         },
-        isConsentReady: () => !!getApi(),
     };
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@chordcommerce/analytics",
   "description": "Chord Commerce event tracking",
-  "version": "1.24.2",
+  "version": "1.24.4",
   "author": "Chord Commerce <help@chord.co> (https://www.chord.co)",
   "repository": {
     "type": "git",