@chordcommerce/analytics 1.24.3 → 1.24.5

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

@@ -109,5 +109,5 @@ export declare const getNormalizedCategories: () => Record<string, boolean>;
  * @param model - OneTrust consent model name
  * @returns 'opt-in' or 'opt-out'
  */
-export declare const coerceConsentModel: (model: OtConsentModel | string) => 'opt-in' | 'opt-out';
+export declare const coerceConsentModel: (model: OtConsentModel | string) => "opt-in" | "opt-out";
 export {};

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

@@ -5,6 +5,6 @@ export declare const onetrustConsentAdapter: (options: ChordAnalyticsOptions) =>
     userCanBeTracked: () => boolean;
     getCategories: () => Record<string, boolean>;
     isConsentReady: () => boolean;
-    getConsentModel: () => 'opt-in' | 'opt-out';
-    getApi: () => import("./onetrust-api.js").OneTrustGlobal;
+    getConsentModel: () => "opt-in" | "opt-out";
+    getApi: () => import("./onetrust-api.js").OneTrustGlobal | undefined;
 };

package/dist/client/consent/segment.js

@@ -11,7 +11,7 @@ const getApi = () => window.segmentConsent;
 /**
  * Waits for the Segment consent API to be populated with retry logic.
  */
-const waitForApi = (maxRetries = 10, baseDelay = 100) => __awaiter(void 0, void 0, void 0, function* () {
+const waitForApi = (...args_1) => __awaiter(void 0, [...args_1], void 0, function* (maxRetries = 10, baseDelay = 100) {
     let attempt = 0;
     const checkAndWait = () => __awaiter(void 0, void 0, void 0, function* () {
         const api = getApi();

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,7 +1,42 @@
 /**
- * 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;
+    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 getApi = () => { var _a; return (_a = window.Shopify) === null || _a === void 0 ? void 0 : _a.customerPrivacy; };
+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.
  *
@@ -17,21 +52,28 @@ const userCanBeTracked = () => {
     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.
  */
@@ -41,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(),
     };
 };