@chordcommerce/analytics 1.24.3 → 1.24.5

package/README.md

@@ -47,7 +47,7 @@ const { ChordPixel } = require('@chordcommerce/analytics/dist/cjs')
 | `cdp`           | false    | _Required when using a CDP other than Chord._ A reference to the CDP library, or a function that returns a reference to the CDP library. For example, if using Segment's [analytics.js](https://www.npmjs.com/package/@segment/analytics-next) library, this could be `window.analytics` or `() => window.analytics`. |
 | `cdpDomain`     | false    | _Required when using Chord CDP._ The Chord CDP domain. To be provided by the Chord team.                                                                                                                                                                                                                              |
 | `cdpWriteKey`   | false    | _Required when using Chord CDP._ The Chord CDP write key. To be provided by the Chord team.                                                                                                                                                                                                                           |
-| `debug`         | false    | Defaults to `false`. When set to `true`, events are validated against Chord's tracking plan and errors are logged. We recommend enabling this for development and disabling for production.                                                                                                                           |
+| `debug`         | false    | Defaults to `false`. When set to `true`, events are validated against Chord's tracking plan and errors are logged. Validation uses zod 4. We recommend enabling this for development and disabling for production.                                                                                                    |
 | `enableLogging` | false    | Defaults to `true`. When set to `true`, errors are logged using `console.log`.                                                                                                                                                                                                                                        |
 | `formatters`    | true     | Functions that are used to construct tracking events. There are two types of formatters, objects and events. `formatters.objects` is required. See below for details.                                                                                                                                                 |
 | `metadata`      | true     | Event metadata. See below for details.                                                                                                                                                                                                                                                                                |

package/dist/cjs/client/cdp.js

@@ -10,8 +10,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");

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

@@ -9,8 +9,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");

package/dist/cjs/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/cjs/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/cjs/client/consent/segment.js

@@ -20,8 +20,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
@@ -46,17 +46,30 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.segmentConsentAdapter = void 0;
 var getApi = function () { return window.segmentConsent; };
 /**
  * Waits for the Segment consent API to be populated with retry logic.
  */
-var waitForApi = function (maxRetries, baseDelay) {
-    if (maxRetries === void 0) { maxRetries = 10; }
-    if (baseDelay === void 0) { baseDelay = 100; }
-    return __awaiter(void 0, void 0, void 0, function () {
+var waitForApi = function () {
+    var args_1 = [];
+    for (var _i = 0; _i < arguments.length; _i++) {
+        args_1[_i] = arguments[_i];
+    }
+    return __awaiter(void 0, __spreadArray([], args_1, true), void 0, function (maxRetries, baseDelay) {
         var attempt, checkAndWait;
+        if (maxRetries === void 0) { maxRetries = 10; }
+        if (baseDelay === void 0) { baseDelay = 100; }
         return __generator(this, function (_a) {
             attempt = 0;
             checkAndWait = function () { return __awaiter(void 0, void 0, void 0, function () {

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,9 +2,44 @@
 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;
+    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 getApi = function () { var _a; return (_a = window.Shopify) === null || _a === void 0 ? void 0 : _a.customerPrivacy; };
+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.
  *
@@ -20,21 +55,28 @@ var userCanBeTracked = function () {
     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.
  */
@@ -44,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/cjs/client/index.js

@@ -20,8 +20,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
@@ -743,10 +743,14 @@ var ChordAnalytics = /** @class */ (function () {
          * Send a `page` event to the CDP.
          * If consent is not ready, the event is queued until consent is available.
          */
-        this.page = function (options, props) {
-            if (props === void 0) { props = {}; }
-            return __awaiter(_this, void 0, void 0, function () {
+        this.page = function (options_1) {
+            var args_1 = [];
+            for (var _i = 1; _i < arguments.length; _i++) {
+                args_1[_i - 1] = arguments[_i];
+            }
+            return __awaiter(_this, __spreadArray([options_1], args_1, true), void 0, function (options, props) {
                 var gate;
+                if (props === void 0) { props = {}; }
                 return __generator(this, function (_a) {
                     switch (_a.label) {
                         case 0:
@@ -772,10 +776,14 @@ var ChordAnalytics = /** @class */ (function () {
         /**
          * Internal method to actually send a page event to CDP.
          */
-        this.sendPageEvent = function (options, props) {
-            if (props === void 0) { props = {}; }
-            return __awaiter(_this, void 0, void 0, function () {
+        this.sendPageEvent = function (options_1) {
+            var args_1 = [];
+            for (var _i = 1; _i < arguments.length; _i++) {
+                args_1[_i - 1] = arguments[_i];
+            }
+            return __awaiter(_this, __spreadArray([options_1], args_1, true), void 0, function (options, props) {
                 var _this = this;
+                if (props === void 0) { props = {}; }
                 return __generator(this, function (_a) {
                     switch (_a.label) {
                         case 0:

package/dist/cjs/client/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.normalizeCDPDomain = void 0;
+exports.normalizeCDPDomain = normalizeCDPDomain;
 function normalizeCDPDomain(cdpDomain) {
     var domain = cdpDomain.replace(/\/+$/, '');
     if (domain.endsWith('/p.js')) {
@@ -9,4 +9,3 @@ function normalizeCDPDomain(cdpDomain) {
     }
     return domain;
 }
-exports.normalizeCDPDomain = normalizeCDPDomain;

package/dist/cjs/utils.d.ts

@@ -27,4 +27,4 @@ export declare const isPromise: (value: unknown) => value is Promise<unknown>;
  * The timer is cleared either way, so a promise that settles quickly does not
  * leave a pending timeout behind.
  */
-export declare const withTimeout: <T>(promise: Promise<T>, ms: number) => Promise<typeof TIMED_OUT | T>;
+export declare const withTimeout: <T>(promise: Promise<T>, ms: number) => Promise<T | typeof TIMED_OUT>;

package/dist/cjs/utils.js

@@ -9,8 +9,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");

package/dist/cjs/validators/custom.d.ts

@@ -1,43 +1,9 @@
-import { z } from 'zod';
-export declare const productInProductsSchema: z.ZodEffects<z.ZodObject<{
+import * as z from 'zod';
+export declare const productInProductsSchema: z.ZodObject<{
     product_id: z.ZodString;
     sku: z.ZodString;
     products: z.ZodArray<z.ZodObject<{
         product_id: z.ZodString;
         sku: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        product_id?: string;
-        sku?: string;
-    }, {
-        product_id?: string;
-        sku?: string;
-    }>, "many">;
-}, "strip", z.ZodTypeAny, {
-    product_id?: string;
-    sku?: string;
-    products?: {
-        product_id?: string;
-        sku?: string;
-    }[];
-}, {
-    product_id?: string;
-    sku?: string;
-    products?: {
-        product_id?: string;
-        sku?: string;
-    }[];
-}>, {
-    product_id?: string;
-    sku?: string;
-    products?: {
-        product_id?: string;
-        sku?: string;
-    }[];
-}, {
-    product_id?: string;
-    sku?: string;
-    products?: {
-        product_id?: string;
-        sku?: string;
-    }[];
-}>;
+    }, z.z.core.$strip>>;
+}, z.z.core.$strip>;

package/dist/cjs/validators/custom.js

@@ -1,12 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.productInProductsSchema = void 0;
-var zod_1 = require("zod");
-exports.productInProductsSchema = zod_1.z
+var z = require("zod");
+exports.productInProductsSchema = z
     .object({
-    product_id: zod_1.z.string(),
-    sku: zod_1.z.string(),
-    products: zod_1.z.array(zod_1.z.object({ product_id: zod_1.z.string(), sku: zod_1.z.string() })),
+    product_id: z.string(),
+    sku: z.string(),
+    products: z.array(z.object({ product_id: z.string(), sku: z.string() })),
 })
     .refine(function (event) {
     var productInCart = event.products.find(function (p) {