@chordcommerce/analytics 1.17.1 → 1.18.0

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

@@ -0,0 +1 @@
+export declare function normalizeCDPDomain(cdpDomain: string): string;

package/dist/cjs/client/utils.js

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

package/dist/cjs/index.d.ts

@@ -0,0 +1,2 @@
+export * from './client/index.js';
+export * from './types/index.js';

package/dist/cjs/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./client/index.js"), exports);
+__exportStar(require("./types/index.js"), exports);

package/dist/cjs/setupTests.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cjs/setupTests.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// eslint-disable-next-line import/no-extraneous-dependencies
+var globals_1 = require("@jest/globals");
+// Make jest available globally
+globalThis.jest = globals_1.jest;

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

@@ -0,0 +1,96 @@
+import type { EventProperties, AnalyticsSnippet, Analytics, AnalyticsBrowser, Options } from '@segment/analytics-next';
+import { ChordAnalyticsFormatters } from './formatters.js';
+export interface ValidateResult {
+    success: boolean;
+    error?: any[];
+    data?: any;
+}
+export interface ObjectTypes {
+    Cart: any;
+    Checkout: any;
+    LineItem: any;
+    Product: any;
+}
+export type AnyAnalytics = AnalyticsSnippet | Analytics | AnalyticsBrowser | ChordAnalyticsQueue;
+export type AnyOptions = Options;
+export type AnyProduct = {
+    [key: string]: unknown;
+};
+export type AnyCart = {
+    [key: string]: unknown;
+};
+export type AnyCheckout = {
+    [key: string]: unknown;
+};
+export type AnyId = string | number;
+export type AnyLineItem = {
+    [key: string]: unknown;
+};
+export interface ChordAnalyticsOptions<T extends ObjectTypes = ObjectTypes> {
+    cdp?: AnyAnalytics | (() => AnyAnalytics);
+    cdpDomain?: string;
+    cdpWriteKey?: string;
+    consent?: 'ketch' | 'onetrust' | 'shopify' | 'segment';
+    awaitConsent?: boolean;
+    debug?: boolean;
+    enableLogging?: boolean;
+    formatters: ChordAnalyticsFormatters<T>;
+    namespace?: string;
+    stripNull?: boolean;
+    metadata: EventMetadata;
+    awaitConsentTimeout?: number;
+    middleware?: Array<() => void>;
+}
+export interface EventMetadata {
+    i18n: i18nMetadata;
+    ownership: ownershipMetadata;
+    platform: platformMetadata;
+    store: storeMetadata;
+    version?: versionMetadata;
+}
+export interface i18nMetadata {
+    currency: string;
+    locale: string;
+}
+export interface ownershipMetadata {
+    omsId: string;
+    storeId: string;
+    tenantId: string;
+}
+export interface platformMetadata {
+    name: string;
+    type: string;
+}
+export interface versionMetadata {
+    major: number;
+    minor: number;
+    patch: number;
+}
+export interface storeMetadata {
+    domain: string;
+}
+export type ChordAnalyticsQueue = {
+    track: (...args: any[]) => void;
+    identify: (...args: any[]) => void;
+    page: (...args: any[]) => void;
+    reset: (...args: any[]) => void;
+};
+type PageContext = {
+    search: string;
+    searchParams: Record<string, string>;
+};
+type MiddlewarePayload = {
+    obj: {
+        properties?: EventProperties;
+        event: string;
+        context: {
+            page: PageContext;
+        };
+    };
+};
+type MiddlewareArgs = {
+    payload: MiddlewarePayload;
+    next: <T>(arg: T) => T;
+};
+export type AnalyticsMiddleware = (args: MiddlewareArgs) => Partial<EventProperties> | void;
+export {};

package/dist/cjs/types/client.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/types/consent.d.ts

@@ -0,0 +1,11 @@
+export interface ConsentAdapter {
+    getCurrentConsent: () => ConsentConfiguration | Promise<ConsentConfiguration>;
+    handleConsentUpdates: (fn: (ConsentConfiguration: any) => void) => void;
+    userCanBeTracked: () => boolean | Promise<boolean>;
+}
+export interface ConsentConfiguration {
+    consentCategories?: {
+        [key: string]: boolean;
+    };
+    dontSend?: boolean;
+}

package/dist/cjs/types/consent.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/types/formatters.d.ts

@@ -0,0 +1,114 @@
+import type { CartViewed, CheckoutStarted, CheckoutStepCompleted, CheckoutStepViewed, ProductAdded, ProductClicked, VariantClicked, ProductViewed, ProductListViewed, CouponApplied, CouponDenied, CouponEntered, CouponRemoved, EmailCaptured, ProductListFiltered, ProductRemoved, ProductsSearched, SignedIn, SignedOut, SignedUp, LoginStarted, SubscriptionCancelled, NavigationClicked, PaymentInfoEntered } from './typewriter.js';
+import type { Cart, Checkout, LineItem, Product } from './objects.js';
+import type { CartInput, CheckoutInput, CheckoutStepCompletedInput, CheckoutStepViewedInput, LineItemInput, ProductInput, CartViewedInput, CheckoutStartedInput, ProductAddedInput, ProductClickedInput, VariantClickedInput, ProductViewedInput, ProductListViewedInput, ProductListFilteredInput, ProductRemovedInput, CouponAppliedInput, CouponDeniedInput, CouponEnteredInput, CouponRemovedInput, EmailCapturedInput, ProductsSearchedInput, SignedInInput, SignedOutInput, SignedUpInput, LoginStartedInput, SubscriptionCancelledInput, NavigationClickedInput, PaymentInfoEnteredInput } from './input.js';
+import type { ObjectTypes } from './client.js';
+export type CartFormatter<T = ObjectTypes['Cart']> = (props: CartInput<T>) => Cart;
+export type CheckoutFormatter<T = ObjectTypes['Checkout']> = (props: CheckoutInput<T>) => Checkout;
+export type LineItemFormatter<T = ObjectTypes['LineItem']> = (props: LineItemInput<T>) => LineItem;
+export type ProductFormatter<T = ObjectTypes['Product']> = (props: ProductInput<T>) => Product;
+export interface CartViewedFormatter<T extends ObjectTypes = ObjectTypes> {
+    (props: CartViewedInput<T>, event: CartViewed): CartViewed;
+}
+export interface CheckoutStartedFormatter<T extends ObjectTypes = ObjectTypes> {
+    (props: CheckoutStartedInput<T>, event: CheckoutStarted): CheckoutStarted;
+}
+export interface CheckoutStepCompletedFormatter {
+    (props: CheckoutStepCompletedInput, event: CheckoutStepCompleted): CheckoutStepCompleted;
+}
+export interface CheckoutStepViewedFormatter {
+    (props: CheckoutStepViewedInput, event: CheckoutStepViewed): CheckoutStepViewed;
+}
+export interface CouponAppliedFormatter {
+    (props: CouponAppliedInput, event: CouponApplied): CouponApplied;
+}
+export interface CouponDeniedFormatter {
+    (props: CouponDeniedInput, event: CouponDenied): CouponDenied;
+}
+export interface CouponEnteredFormatter {
+    (props: CouponEnteredInput, event: CouponEntered): CouponEntered;
+}
+export interface CouponRemovedFormatter {
+    (props: CouponRemovedInput, event: CouponRemoved): CouponRemoved;
+}
+export interface EmailCapturedFormatter {
+    (props: EmailCapturedInput, event: EmailCaptured): EmailCaptured;
+}
+export interface ProductAddedFormatter<T extends ObjectTypes = ObjectTypes> {
+    (props: ProductAddedInput<T>, event: ProductAdded): ProductAdded;
+}
+export interface ProductClickedFormatter<T extends ObjectTypes = ObjectTypes> {
+    (props: ProductClickedInput<T>, event: ProductClicked): ProductClicked;
+}
+export interface VariantClickedFormatter<T extends ObjectTypes = ObjectTypes> {
+    (props: VariantClickedInput<T>, event: VariantClicked): VariantClicked;
+}
+export interface ProductListFilteredFormatter {
+    (props: ProductListFilteredInput, event: ProductListFiltered): ProductListFiltered;
+}
+export interface ProductListViewedFormatter<T extends ObjectTypes = ObjectTypes> {
+    (props: ProductListViewedInput<T>, event: ProductListViewed): ProductListViewed;
+}
+export interface ProductRemovedFormatter<T extends ObjectTypes = ObjectTypes> {
+    (props: ProductRemovedInput<T>, event: ProductRemoved): ProductRemoved;
+}
+export interface ProductViewedFormatter<T extends ObjectTypes = ObjectTypes> {
+    (props: ProductViewedInput<T>, event: ProductViewed): ProductViewed;
+}
+export interface ProductsSearchedFormatter {
+    (props: ProductsSearchedInput, event: ProductsSearched): ProductsSearched;
+}
+export interface SignedInFormatter {
+    (props: SignedInInput, event: SignedIn): SignedIn;
+}
+export interface SignedOutFormatter {
+    (props: SignedOutInput, event: SignedOut): SignedOut;
+}
+export interface SignedUpFormatter {
+    (props: SignedUpInput, event: SignedUp): SignedUp;
+}
+export interface LoginStartedFormatter {
+    (props: LoginStartedInput, event: LoginStarted): LoginStarted;
+}
+export interface SubscriptionCancelledFormatter {
+    (props: SubscriptionCancelledInput, event: SubscriptionCancelled): SubscriptionCancelled;
+}
+export interface NavigationClickedFormatter {
+    (props: NavigationClickedInput, event: NavigationClicked): NavigationClicked;
+}
+export interface PaymentInfoEnteredFormatter {
+    (props: PaymentInfoEnteredInput, event: PaymentInfoEntered): PaymentInfoEntered;
+}
+export interface ChordAnalyticsFormatters<T extends ObjectTypes = ObjectTypes> {
+    events?: {
+        cartViewed?: CartViewedFormatter<T>;
+        checkoutStarted?: CheckoutStartedFormatter<T>;
+        checkoutStepCompleted?: CheckoutStepCompletedFormatter;
+        checkoutStepViewed?: CheckoutStepViewedFormatter;
+        couponApplied?: CouponAppliedFormatter;
+        couponDenied?: CouponDeniedFormatter;
+        couponEntered?: CouponEnteredFormatter;
+        couponRemoved?: CouponRemovedFormatter;
+        emailCaptured?: EmailCapturedFormatter;
+        productAdded?: ProductAddedFormatter<T>;
+        productClicked?: ProductClickedFormatter<T>;
+        variantClicked?: VariantClickedFormatter<T>;
+        productListFiltered?: ProductListFilteredFormatter;
+        productListViewed?: ProductListViewedFormatter<T>;
+        productRemoved?: ProductRemovedFormatter<T>;
+        productViewed?: ProductViewedFormatter<T>;
+        productsSearched?: ProductsSearchedFormatter;
+        signedIn?: SignedInFormatter;
+        signedOut?: SignedOutFormatter;
+        signedUp?: SignedUpFormatter;
+        loginStarted?: LoginStartedFormatter;
+        subscriptionCancelled?: SubscriptionCancelledFormatter;
+        navigationClicked?: NavigationClickedFormatter;
+        paymentInfoEntered?: PaymentInfoEnteredFormatter;
+    };
+    objects: {
+        cart: CartFormatter<T['Cart']>;
+        checkout: CheckoutFormatter<T['Checkout']>;
+        lineItem: LineItemFormatter<T['LineItem']>;
+        product: ProductFormatter<T['Product']>;
+    };
+}

package/dist/cjs/types/formatters.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,7 @@
+export type { AnalyticsSnippet, Analytics, AnalyticsBrowser, EventProperties, Options, } from '@segment/analytics-next';
+export * from './objects.js';
+export * from './typewriter.js';
+export * from './client.js';
+export * from './consent.js';
+export * from './input.js';
+export * from './formatters.js';

package/dist/cjs/types/index.js

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./objects.js"), exports);
+__exportStar(require("./typewriter.js"), exports);
+__exportStar(require("./client.js"), exports);
+__exportStar(require("./consent.js"), exports);
+__exportStar(require("./input.js"), exports);
+__exportStar(require("./formatters.js"), exports);