@chordcommerce/analytics 1.21.1 → 1.22.0-beta.1

package/dist/client/identifiers.js

@@ -0,0 +1,131 @@
+/**
+ * Shopify Identifier Sync
+ *
+ * Syncs CDP anonymous ID and Google Client ID to Shopify cart attributes.
+ * This enables server-side events (webhooks) to correlate with client-side tracking.
+ */
+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());
+    });
+};
+/**
+ * Get a cookie value by name
+ */
+export const getCookie = (name) => {
+    var _a;
+    if (typeof document === 'undefined')
+        return undefined;
+    return (_a = document.cookie
+        .split('; ')
+        .find((row) => row.startsWith(`${name}=`))) === null || _a === void 0 ? void 0 : _a.split('=')[1];
+};
+/**
+ * Get default identifiers (CDP anonymous ID and Google Client ID)
+ */
+export const getDefaultIdentifiers = () => {
+    const attributes = {};
+    try {
+        // CDP anonymous ID (Jitsu/Chord CDP)
+        const anonymousId = getCookie('__eventn_id');
+        if (anonymousId) {
+            // eslint-disable-next-line no-underscore-dangle
+            attributes._cdpAnonymousId = anonymousId;
+        }
+        // Google Client ID (strip the "GA1.1." or similar prefix)
+        const gaCookie = getCookie('_ga');
+        if (gaCookie) {
+            const googleClientId = gaCookie.substring(6);
+            if (googleClientId) {
+                // eslint-disable-next-line no-underscore-dangle
+                attributes._googleClientId = googleClientId;
+            }
+        }
+    }
+    catch (e) {
+        // eslint-disable-next-line no-console
+        console.error('[Chord Analytics]: Error getting identifiers:', e);
+    }
+    return attributes;
+};
+/**
+ * Construct a URL for Shopify AJAX API calls
+ */
+const constructUrl = (path, baseUrl, localePath) => {
+    var _a, _b;
+    const defaultBaseUrl = typeof window !== 'undefined' ? (_a = window.location) === null || _a === void 0 ? void 0 : _a.origin : undefined;
+    // Access Shopify.routes.root for locale-aware URLs (cast needed as Window.Shopify type is partial)
+    const shopify = window === null || window === void 0 ? void 0 : window.Shopify;
+    const defaultLocalePath = ((_b = shopify === null || shopify === void 0 ? void 0 : shopify.routes) === null || _b === void 0 ? void 0 : _b.root) || '/';
+    const resolvedBaseUrl = baseUrl !== null && baseUrl !== void 0 ? baseUrl : defaultBaseUrl;
+    const resolvedLocalePath = localePath !== null && localePath !== void 0 ? localePath : defaultLocalePath;
+    const pathWithLocale = `${resolvedLocalePath}${path}`;
+    if (!resolvedBaseUrl) {
+        return pathWithLocale.startsWith('/')
+            ? pathWithLocale
+            : `/${pathWithLocale}`;
+    }
+    return new URL(pathWithLocale, resolvedBaseUrl);
+};
+/**
+ * Fetch the current Shopify cart
+ */
+export const getShopifyCart = (baseUrl, localePath) => __awaiter(void 0, void 0, void 0, function* () {
+    const url = constructUrl('cart.js', baseUrl, localePath);
+    const response = yield fetch(url);
+    if (!response.ok) {
+        throw new Error(`Failed to fetch cart: ${response.status}`);
+    }
+    return response.json();
+});
+/**
+ * Update Shopify cart attributes
+ */
+export const updateShopifyCartAttributes = (attributes, baseUrl, localePath) => __awaiter(void 0, void 0, void 0, function* () {
+    const url = constructUrl('cart/update.js', baseUrl, localePath);
+    const response = yield fetch(url, {
+        method: 'POST',
+        headers: {
+            'Content-Type': 'application/json',
+        },
+        body: JSON.stringify({ attributes }),
+    });
+    if (!response.ok) {
+        throw new Error(`Failed to update cart attributes: ${response.status}`);
+    }
+    return response.json();
+});
+/**
+ * Sync identifiers to Shopify cart attributes.
+ *
+ * This function:
+ * 1. Gets the current cart
+ * 2. Checks if identifiers already exist
+ * 3. If not, updates the cart with the identifiers
+ *
+ * @returns The updated cart, or undefined if no update was needed
+ */
+export const syncIdentifiersToCart = (options = {}) => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        const { baseUrl, localePath, identifiers = getDefaultIdentifiers } = options;
+        const cart = yield getShopifyCart(baseUrl, localePath);
+        const attributesToAdd = identifiers();
+        // Check if all identifiers already exist with correct values
+        const identifiersAlreadyExist = Object.keys(attributesToAdd).every((key) => { var _a; return ((_a = cart === null || cart === void 0 ? void 0 : cart.attributes) === null || _a === void 0 ? void 0 : _a[key]) === attributesToAdd[key]; });
+        if (identifiersAlreadyExist) {
+            return undefined;
+        }
+        // Update cart with new identifiers
+        const updatedCart = yield updateShopifyCartAttributes(attributesToAdd, baseUrl, localePath);
+        return updatedCart;
+    }
+    catch (e) {
+        // eslint-disable-next-line no-console
+        console.error('[Chord Analytics]: Error syncing identifiers to cart:', e);
+        return undefined;
+    }
+});

package/dist/client/index.d.ts

@@ -1,5 +1,6 @@
 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, OrderCompletedInput, SubscriptionCancelledInput, NavigationClickedInput, PaymentInfoEnteredInput } from '../types/index.js';
 import { AnalyticsMiddleware } from '../types/client.js';
+import { type IdentifierSyncOptions, type ShopifyCart } from './identifiers.js';
 export interface ChordAnalyticsSnippet {
     _loadOptions: ChordAnalyticsOptions<ObjectTypes>;
     invoked: boolean;
@@ -151,6 +152,36 @@ export declare class ChordAnalytics<T extends ObjectTypes = ObjectTypes> {
      */
     private sendPageEvent;
     reset: () => Promise<void>;
+    /**
+     * Handler for postMessage events from the Shopify Web Pixel sandbox.
+     * Bound to the instance for proper `this` context and cleanup.
+     */
+    private webPixelMessageHandler;
+    /**
+     * Set up a listener for postMessage events from the Shopify Web Pixel sandbox.
+     * This allows the lightweight web pixel (running in Shopify's sandboxed iframe)
+     * to forward analytics events to this ChordAnalytics instance on the storefront.
+     *
+     * The lightweight web pixel sends messages in the format:
+     * - { source: 'chord-web-pixel', type: 'track', payload: [eventName, properties] }
+     * - { source: 'chord-web-pixel', type: 'identify', payload: [userId, traits] }
+     * - { source: 'chord-web-pixel', type: 'page', payload: [properties] }
+     *
+     * @returns A cleanup function to remove the listener
+     */
+    setupWebPixelListener: () => (() => void);
+    /**
+     * Sync CDP anonymous ID and Google Client ID to Shopify cart attributes.
+     * This enables server-side events (webhooks) to correlate with client-side tracking.
+     *
+     * By default, syncs:
+     * - `_cdpAnonymousId`: from the `__eventn_id` cookie (Chord/Jitsu CDP)
+     * - `_googleClientId`: from the `_ga` cookie (Google Analytics)
+     *
+     * @param options - Optional configuration for the sync
+     * @returns The updated cart, or undefined if no update was needed or an error occurred
+     */
+    syncIdentifiersToCart: (options?: IdentifierSyncOptions) => Promise<ShopifyCart | undefined>;
     trackCartViewed: (props: CartViewedInput<T>, options?: AnyOptions) => Promise<void>;
     trackCheckoutStarted: (props: CheckoutStartedInput<T>, options?: AnyOptions) => Promise<void>;
     trackCheckoutStepCompleted: (props: CheckoutStepCompletedInput, options?: AnyOptions) => Promise<void>;