@chordcommerce/analytics 1.17.1 → 1.18.0

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

@@ -0,0 +1,155 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+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;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+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 attempt, checkAndWait;
+        return __generator(this, function (_a) {
+            attempt = 0;
+            checkAndWait = function () { return __awaiter(void 0, void 0, void 0, function () {
+                var api, delay_1;
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0:
+                            api = getApi();
+                            if (api &&
+                                typeof api === 'object' &&
+                                api.customPreferences &&
+                                typeof api.customPreferences === 'object' &&
+                                Object.keys(api.customPreferences).length > 0) {
+                                return [2 /*return*/, api];
+                            }
+                            if (!(attempt < maxRetries)) return [3 /*break*/, 2];
+                            delay_1 = baseDelay * Math.pow(2, attempt);
+                            return [4 /*yield*/, new Promise(function (resolve) {
+                                    setTimeout(resolve, delay_1);
+                                })];
+                        case 1:
+                            _a.sent();
+                            attempt++;
+                            return [2 /*return*/, checkAndWait()];
+                        case 2: return [2 /*return*/, null];
+                    }
+                });
+            }); };
+            return [2 /*return*/, checkAndWait()];
+        });
+    });
+};
+/**
+ * Returns whether the user can currently be tracked.
+ */
+var userCanBeTracked = function () { return __awaiter(void 0, void 0, void 0, function () {
+    var api;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0: return [4 /*yield*/, waitForApi()];
+            case 1:
+                api = _a.sent();
+                return [2 /*return*/, (!!api &&
+                        !!(api.customPreferences.functional &&
+                            api.customPreferences.marketingAndAnalytics))];
+        }
+    });
+}); };
+/**
+ * Returns the user's current consent configuration.
+ */
+var getCurrentConsent = function () { return __awaiter(void 0, void 0, void 0, function () {
+    var api;
+    var _a;
+    return __generator(this, function (_b) {
+        switch (_b.label) {
+            case 0: return [4 /*yield*/, waitForApi()];
+            case 1:
+                api = _b.sent();
+                if (!api)
+                    return [2 /*return*/, {}];
+                _a = {
+                    consentCategories: __assign(__assign({}, api.customPreferences), api.destinationPreferences)
+                };
+                return [4 /*yield*/, userCanBeTracked()];
+            case 2: return [2 /*return*/, (_a.dontSend = !(_b.sent()),
+                    _a)];
+        }
+    });
+}); };
+/**
+ * Handles subsequent changes to consent configuration.
+ */
+var handleConsentUpdates = function (updateCdpConsent) {
+    document.addEventListener('chord-cdp:consent-updated', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var _a;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    _a = updateCdpConsent;
+                    return [4 /*yield*/, getCurrentConsent()];
+                case 1:
+                    _a.apply(void 0, [_b.sent()]);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+};
+var segmentConsentAdapter = function () {
+    return {
+        getCurrentConsent: getCurrentConsent,
+        handleConsentUpdates: handleConsentUpdates,
+        userCanBeTracked: userCanBeTracked,
+    };
+};
+exports.segmentConsentAdapter = segmentConsentAdapter;

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

@@ -0,0 +1,21 @@
+import type { ConsentConfiguration } from '../../types/index.js';
+declare global {
+    interface Window {
+        Shopify?: {
+            customerPrivacy?: ShopifyCustomerPrivacyApi;
+        };
+    }
+}
+interface ShopifyCustomerPrivacyApi {
+    getRegion: () => string;
+    analyticsProcessingAllowed: () => boolean;
+    marketingAllowed: () => boolean;
+    preferencesProcessingAllowed: () => boolean;
+    saleOfDataAllowed: () => boolean;
+}
+export declare const shopifyConsentAdapter: () => {
+    getCurrentConsent: () => ConsentConfiguration;
+    handleConsentUpdates: (updateCdpConsent: (consent: ConsentConfiguration) => void) => void;
+    userCanBeTracked: () => boolean;
+};
+export {};

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

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.shopifyConsentAdapter = void 0;
+/**
+ * Returns Shopify's Customer Privacy API.
+ */
+var getApi = function () { var _a; return (_a = window.Shopify) === null || _a === void 0 ? void 0 : _a.customerPrivacy; };
+/**
+ * Returns whether the user can currently be tracked.
+ */
+var userCanBeTracked = function () {
+    var api = getApi();
+    if (!api)
+        return false;
+    return !!(api.getRegion() &&
+        api.analyticsProcessingAllowed() &&
+        api.marketingAllowed());
+};
+/**
+ * Returns the user's current consent configuration.
+ */
+var getCurrentConsent = function () {
+    var api = getApi();
+    if (!api)
+        return {};
+    return {
+        consentCategories: {
+            analytics: api.analyticsProcessingAllowed(),
+            marketing: api.marketingAllowed(),
+            preferences: api.preferencesProcessingAllowed(),
+            sale_of_data: api.saleOfDataAllowed(),
+        },
+        dontSend: !userCanBeTracked(),
+    };
+};
+/**
+ * Handles subsequent changes to consent configuration.
+ */
+var handleConsentUpdates = function (updateCdpConsent) {
+    document.addEventListener('visitorConsentCollected', function () {
+        updateCdpConsent(getCurrentConsent());
+    });
+};
+var shopifyConsentAdapter = function () {
+    return {
+        getCurrentConsent: getCurrentConsent,
+        handleConsentUpdates: handleConsentUpdates,
+        userCanBeTracked: userCanBeTracked,
+    };
+};
+exports.shopifyConsentAdapter = shopifyConsentAdapter;

package/dist/cjs/client/index.d.ts

@@ -0,0 +1,111 @@
+import type { AnyAnalytics, EventProperties, Options, ValidateResult, ChordAnalyticsOptions, AnyOptions, CartViewedInput, IdentifyTraits, CheckoutStartedInput, CheckoutStepCompletedInput, CheckoutStepViewedInput, EmailCapturedInput, ProductListViewedInput, ProductListFilteredInput, ProductAddedInput, ProductClickedInput, VariantClickedInput, ProductRemovedInput, ProductViewedInput, ProductsSearchedInput, CouponAppliedInput, CouponDeniedInput, CouponEnteredInput, CouponRemovedInput, SignedInInput, SignedOutInput, SignedUpInput, LoginStartedInput, ObjectTypes, SubscriptionCancelledInput, NavigationClickedInput, PaymentInfoEnteredInput } from '../types/index.js';
+import { AnalyticsMiddleware } from '../types/client.js';
+export interface ChordAnalyticsSnippet {
+    _loadOptions: ChordAnalyticsOptions<ObjectTypes>;
+    invoked: boolean;
+    methods: string[];
+    queue: any[];
+    factory: (method: string) => () => ChordAnalytics;
+    load: () => void;
+    SNIPPET_VERSION: string;
+}
+export declare class ChordAnalytics<T extends ObjectTypes = ObjectTypes> {
+    /**
+     * Allows snippet.js to detect whether this library has been initialized yet.
+     */
+    initialize: true;
+    /**
+     * Allows snippet.js to detect whether the snippet has started running yet.
+     */
+    invoked: true;
+    /**
+     * Options for ChordAnalytics.
+     */
+    options: ChordAnalyticsOptions<T>;
+    /**
+     * Middleware to be applied to the event properties
+     */
+    middleware: any[];
+    /**
+     * Promise that resolves when CDP is ready
+     */
+    private cdpReadyPromise;
+    constructor(options: ChordAnalyticsOptions<T>);
+    /**
+     * Initialize CDP snippet and wait for it to be ready
+     */
+    private initializeCdp;
+    /**
+     * Set debug mode for Chord Analytics
+     * @param enabled - Whether debug mode should be enabled
+     */
+    setDebugMode: (enabled: boolean) => void;
+    cdp: () => AnyAnalytics;
+    ccdp: () => AnyAnalytics;
+    logger: (message?: any, ...optionalParams: any[]) => void;
+    /**
+     * Validate the body of a `track` event against the Chord tracking plan.
+     */
+    validate: (event: string, props: EventProperties) => ValidateResult[];
+    /**
+     * Generate the event `meta` property.
+     */
+    meta: () => {
+        ownership: {
+            oms_id: string;
+            store_id: string;
+            tenant_id: string;
+        };
+        version: {
+            major: number;
+            minor: number;
+            patch: number;
+        };
+        i18n: import("../types/client.js").i18nMetadata;
+        platform: import("../types/client.js").platformMetadata;
+        store: import("../types/client.js").storeMetadata;
+    };
+    addSourceMiddleware: (func: AnalyticsMiddleware) => void;
+    /**
+     * Send a `track` event to the CDP with any event name and properties.
+     */
+    track: (event: string, props?: EventProperties, options?: Options) => Promise<void>;
+    /**
+     * Send an `identify` event to the CDP with user id and traits.
+     */
+    identify: {
+        (userId?: string, traits?: IdentifyTraits, options?: AnyOptions): void;
+        (traits?: IdentifyTraits, options?: AnyOptions): void;
+    };
+    /**
+     * Send a `page` event to the CDP.
+     */
+    page: {
+        (props?: Record<string, any>): void;
+    };
+    reset: () => void;
+    trackCartViewed: (props: CartViewedInput<T>, options?: AnyOptions) => Promise<void>;
+    trackCheckoutStarted: (props: CheckoutStartedInput<T>, options?: AnyOptions) => Promise<void>;
+    trackCheckoutStepCompleted: (props: CheckoutStepCompletedInput, options?: AnyOptions) => Promise<void>;
+    trackCheckoutStepViewed: (props: CheckoutStepViewedInput, options?: AnyOptions) => Promise<void>;
+    trackCouponApplied: (props: CouponAppliedInput, options?: AnyOptions) => Promise<void>;
+    trackCouponDenied: (props: CouponDeniedInput, options?: AnyOptions) => Promise<void>;
+    trackCouponEntered: (props: CouponEnteredInput, options?: AnyOptions) => Promise<void>;
+    trackCouponRemoved: (props: CouponRemovedInput, options?: AnyOptions) => Promise<void>;
+    trackEmailCaptured: (props: EmailCapturedInput, options?: AnyOptions) => Promise<void>;
+    trackProductAdded: (props: ProductAddedInput<T>, options?: AnyOptions) => Promise<void>;
+    trackProductClicked: (props: ProductClickedInput<T>, options?: AnyOptions) => Promise<void>;
+    trackVariantClicked: (props: VariantClickedInput<T>, options?: AnyOptions) => Promise<void>;
+    trackProductListFiltered: (props: ProductListFilteredInput, options?: AnyOptions) => Promise<void>;
+    trackProductListViewed: (props: ProductListViewedInput<T>, options?: AnyOptions) => Promise<void>;
+    trackProductRemoved: (props: ProductRemovedInput<T>, options?: AnyOptions) => Promise<void>;
+    trackProductViewed: (props: ProductViewedInput<T>, options?: AnyOptions) => Promise<void>;
+    trackProductsSearched: (props: ProductsSearchedInput, options?: AnyOptions) => Promise<void>;
+    trackSignedIn: (props: SignedInInput, options?: AnyOptions) => Promise<void>;
+    trackSignedOut: (props?: SignedOutInput, options?: AnyOptions) => Promise<void>;
+    trackSignedUp: (props?: SignedUpInput, options?: AnyOptions) => Promise<void>;
+    trackLoginStarted: (props: LoginStartedInput, options?: AnyOptions) => Promise<void>;
+    trackSubscriptionCancelled: (props: SubscriptionCancelledInput, options?: AnyOptions) => Promise<void>;
+    trackNavigationClicked: (props: NavigationClickedInput, options?: AnyOptions) => Promise<void>;
+    trackPaymentInfoEntered: (props: PaymentInfoEnteredInput, options?: AnyOptions) => Promise<void>;
+}