@chordcommerce/analytics 1.5.1

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Chord Commerce
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,86 @@
+# `@chordcommerce/analytics`
+
+The `@chordcommerce/analytics` library provides simple methods for sending tracking events to Chord from your website, with an optional debugging mode to validate event properties.
+
+`@chordcommerce/analytics` is intended to be installed alongside a customer data platform (CDP) tracking library like Segment's [analytics.js](https://www.npmjs.com/package/@segment/analytics-next). `@chordcommerce/analytics` sends Chord tracking events to the CDP tracking library, so they’re available for all connected integrations.
+
+Visit [docs.chord.co](https://docs.chord.co/analytics-getting-started) for guides, examples, and an API reference.
+
+## **Requirements**
+
+A CDP Javascript library must be installed in your project. Currently, only Segment's [analytics.js](https://www.npmjs.com/package/@segment/analytics-next) library is supported.
+
+## **Installation**
+
+To install `@chordcommerce/analytics`, run the following command in your project directory:
+
+```bash
+npm install @chordcommerce/analytics
+# or
+yarn add @chordcommerce/analytics
+```
+
+## **Usage**
+
+First, ensure that a CDP Javascript library is installed and configured in your project. Then, initialize `@chordcommerce/analytics` as follows:
+
+```jsx
+import ChordAnalytics from '@chordcommerce/analytics'
+
+const chord = new ChordAnalytics(options) // see below for configuration options
+
+chord.trackCartViewed({ cart }) // sends a "Cart Viewed" event to the CDP
+```
+
+## Configuration
+
+`@chordcommerce/analytics` can be initialized with the following options:
+
+| Property        | Required | Description                                                                                                                                                                                                                                                                                                      |
+| --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `cdp`           | true     | 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`. If omitted, no tracking events are sent. |
+| `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.                                                                                                                      |
+| `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.                                                                                                                                                                                                                                                                           |
+| `stripNull`     | false    | Defaults to `true`. When set to `true`, event properties with a `null` value are removed. CDPs typically treat `null` and `undefined` as separate values, so be sure you intend to send `null` values before setting to false.                                                                                   |
+
+**Metadata**
+
+| Property                      | Required | Description                                                                                                                       |
+| ----------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------- |
+| `metadata.i18n.currency`      | true     | The order currency in ISO 4217 currency code, uppercase. For example, `USD`.                                                      |
+| `metadata.i18n.locale`        | true     | The order locale. For example, `en-US`.                                                                                           |
+| `metadata.ownership.omsId`    | true     | A UUID assigned by Chord.                                                                                                         |
+| `metadata.ownership.storeId`  | true     | A UUID assigned by Chord.                                                                                                         |
+| `metadata.ownership.tenantId` | true     | A UUID assigned by Chord.                                                                                                         |
+| `metadata.platform.name`      | true     | The e-commerce platform used. For example, `Shopify`.                                                                             |
+| `metadata.platform.type`      | true     | The type of platform where the event originated. Either `web` or `pos`.                                                           |
+| `metadata.store.domain`       | true     | The domain of the site where the event originated. For Shopify, this should be the store slug that comes before `.myshopify.com`. |
+
+### **Formatters**
+
+Formatters are Javascript functions that are used to construct tracking event properties. There are two types of formatters, objects and events. You must define object formatters. Event formatters are optional. See [Chord’s documentation](https://docs.chord.co/analytics-getting-started#fgWx7) for more details and example formatters.
+
+**Object Formatters**
+
+A formatter must be provided for each of the four core data types that are used in Chord events. This formatter function transforms input data into the type Chord expects. See [Chord’s documentation](https://docs.chord.co/analytics-getting-started#XhUB5) for more details on object formatters.
+
+| Property                      | Required | Description                                 |
+| ----------------------------- | -------- | ------------------------------------------- |
+| `formatters.objects.cart`     | true     | A function that creates a cart object.      |
+| `formatters.objects.checkout` | true     | A function that creates a checkout object.  |
+| `formatters.objects.lineItem` | true     | A function that creates a line item object. |
+| `formatters.objects.product`  | true     | A function that creates a product object.   |
+
+**Event Formatters**
+
+A formatter can be provided for each event. This formatter is used to transform the event properties of a specific event after Chord constructs the event, just before it's sent to the CDP. See [Chord’s documentation](https://docs.chord.co/analytics-getting-started#jquZe) for more details on event formatters.
+
+## API Reference
+
+See [Chord’s documentation](https://docs.chord.co/analytics-getting-started) for a full API reference.
+
+## **Support**
+
+For support with setup and configuration, please contact Chord directly at **help@chord.co**.

package/dist/client/index.d.ts

@@ -0,0 +1,84 @@
+import type { AnyAnalytics, EventProperties, Options, ValidateResult, ChordAnalyticsOptions, AnyOptions, CartViewedInput, IdentifyTraits, CheckoutStartedInput, EmailCapturedInput, ProductListViewedInput, ProductListFilteredInput, ProductAddedInput, ProductClickedInput, ProductRemovedInput, ProductViewedInput, ProductsSearchedInput, CouponAppliedInput, CouponDeniedInput, CouponEnteredInput, CouponRemovedInput, SignedInInput, SignedOutInput, SignedUpInput } from '../types/index.js';
+export interface ChordAnalyticsSnippet {
+    _loadOptions: ChordAnalyticsOptions;
+    invoked: boolean;
+    methods: string[];
+    queue: any[];
+    factory: (method: string) => () => ChordAnalytics;
+    load: () => void;
+    SNIPPET_VERSION: string;
+}
+export declare class ChordAnalytics {
+    /**
+     * 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;
+    constructor(options: ChordAnalyticsOptions);
+    cdp: () => 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;
+    };
+    /**
+     * 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: {
+        (): void;
+    };
+    reset: () => void;
+    trackCartViewed: (props: CartViewedInput, options?: AnyOptions) => Promise<void>;
+    trackCheckoutStarted: (props: CheckoutStartedInput, 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, options?: AnyOptions) => Promise<void>;
+    trackProductClicked: (props: ProductClickedInput, options?: AnyOptions) => Promise<void>;
+    trackProductListFiltered: (props: ProductListFilteredInput, options?: AnyOptions) => Promise<void>;
+    trackProductListViewed: (props: ProductListViewedInput, options?: AnyOptions) => Promise<void>;
+    trackProductRemoved: (props: ProductRemovedInput, options?: AnyOptions) => Promise<void>;
+    trackProductViewed: (props: ProductViewedInput, 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>;
+}

package/dist/client/index.js

@@ -0,0 +1,412 @@
+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());
+    });
+};
+import { eventSchemas } from '../validators/index.js';
+import { pruneNullValues } from '../utils.js';
+export class ChordAnalytics {
+    constructor(options) {
+        /**
+         * Allows snippet.js to detect whether this library has been initialized yet.
+         */
+        this.initialize = true;
+        /**
+         * Allows snippet.js to detect whether the snippet has started running yet.
+         */
+        this.invoked = true;
+        /*
+         * Return the CDP instance provided in `options.cdp`.
+         */
+        this.cdp = () => {
+            var _a;
+            const a = (_a = this.options) === null || _a === void 0 ? void 0 : _a.cdp;
+            if (typeof a === 'function')
+                return a();
+            return a;
+        };
+        /*
+         * Log a message to the console if `options.enableLogging` is true.
+         */
+        this.logger = (message, ...optionalParams) => {
+            if (!this.options.enableLogging)
+                return;
+            // eslint-disable-next-line no-console
+            console.log(message, ...optionalParams);
+        };
+        /**
+         * Validate the body of a `track` event against the Chord tracking plan.
+         */
+        this.validate = (event, props) => {
+            if (!event) {
+                this.logger('No event name provided');
+                return [{ success: false }];
+            }
+            const schema = event && eventSchemas[event];
+            if (!schema)
+                return [{ success: true, data: props }];
+            return schema.map((s) => s.safeParse(props));
+        };
+        /**
+         * Generate the event `meta` property.
+         */
+        this.meta = () => {
+            var _a, _b, _c, _d, _e, _f;
+            return Object.assign(Object.assign({}, this.options.metadata), { ownership: {
+                    oms_id: (_b = (_a = this.options.metadata) === null || _a === void 0 ? void 0 : _a.ownership) === null || _b === void 0 ? void 0 : _b.omsId,
+                    store_id: (_d = (_c = this.options.metadata) === null || _c === void 0 ? void 0 : _c.ownership) === null || _d === void 0 ? void 0 : _d.storeId,
+                    tenant_id: (_f = (_e = this.options.metadata) === null || _e === void 0 ? void 0 : _e.ownership) === null || _f === void 0 ? void 0 : _f.tenantId,
+                }, version: {
+                    // TODO: make this dynamic
+                    major: 3,
+                    minor: 0,
+                    patch: 0,
+                } });
+        };
+        /**
+         * Send a `track` event to the CDP with any event name and properties.
+         */
+        this.track = (event, props, options) => {
+            if (!event)
+                this.logger('No event name provided');
+            const formattedProps = this.options.stripNull && props ? pruneNullValues(props) : props;
+            const finalEventProps = Object.assign(Object.assign({}, formattedProps), { meta: this.meta() });
+            if (this.options.debug) {
+                this.validate(event, finalEventProps).forEach((valid) => {
+                    if (!valid.success) {
+                        this.logger('Chord tracking plan violation', valid.error);
+                    }
+                });
+            }
+            return new Promise((resolve) => {
+                try {
+                    const a = this.cdp();
+                    if (a && typeof a.track === 'function') {
+                        a.track(event, finalEventProps, options, () => resolve());
+                    }
+                }
+                catch (error) {
+                    this.logger(error);
+                }
+            });
+        };
+        /**
+         * Send an `identify` event to the CDP with user id and traits.
+         */
+        this.identify = (...props) => {
+            try {
+                const a = this.cdp();
+                if (a && typeof a.identify === 'function') {
+                    a.identify(...props);
+                }
+            }
+            catch (error) {
+                this.logger(error);
+            }
+        };
+        /**
+         * Send a `page` event to the CDP.
+         */
+        this.page = () => {
+            try {
+                const a = this.cdp();
+                if (a && typeof a.page === 'function') {
+                    a.page({ meta: this.meta() });
+                }
+            }
+            catch (error) {
+                this.logger(error);
+            }
+        };
+        this.reset = () => {
+            try {
+                const a = this.cdp();
+                if (a && typeof a.reset === 'function') {
+                    a.reset();
+                }
+            }
+            catch (error) {
+                this.logger(error);
+            }
+        };
+        // TODO: Add support for props.products
+        this.trackCartViewed = (props, options) => __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+            const cart = (_d = (_c = (_b = (_a = this.options) === null || _a === void 0 ? void 0 : _a.formatters) === null || _b === void 0 ? void 0 : _b.objects) === null || _c === void 0 ? void 0 : _c.cart) === null || _d === void 0 ? void 0 : _d.call(_c, {
+                cart: props === null || props === void 0 ? void 0 : props.cart,
+            });
+            const payload = {
+                cart_id: cart === null || cart === void 0 ? void 0 : cart.cart_id,
+                currency: cart === null || cart === void 0 ? void 0 : cart.currency,
+                products: cart === null || cart === void 0 ? void 0 : cart.products,
+                value: cart === null || cart === void 0 ? void 0 : cart.value,
+            };
+            if ((_g = (_f = (_e = this.options) === null || _e === void 0 ? void 0 : _e.formatters) === null || _f === void 0 ? void 0 : _f.events) === null || _g === void 0 ? void 0 : _g.cartViewed) {
+                const formattedPayload = (_k = (_j = (_h = this.options) === null || _h === void 0 ? void 0 : _h.formatters) === null || _j === void 0 ? void 0 : _j.events) === null || _k === void 0 ? void 0 : _k.cartViewed(props, payload);
+                return this.track('Cart Viewed', formattedPayload, options);
+            }
+            return this.track('Cart Viewed', payload, options);
+        });
+        // TODO: Add support for props.products
+        this.trackCheckoutStarted = (props, options) => __awaiter(this, void 0, void 0, function* () {
+            var _l, _m, _o, _p, _q, _r, _s;
+            const formatter = (_o = (_m = (_l = this.options) === null || _l === void 0 ? void 0 : _l.formatters) === null || _m === void 0 ? void 0 : _m.events) === null || _o === void 0 ? void 0 : _o.checkoutStarted;
+            const checkout = (_s = (_r = (_q = (_p = this.options) === null || _p === void 0 ? void 0 : _p.formatters) === null || _q === void 0 ? void 0 : _q.objects) === null || _r === void 0 ? void 0 : _r.checkout) === null || _s === void 0 ? void 0 : _s.call(_r, {
+                checkout: props === null || props === void 0 ? void 0 : props.checkout,
+            });
+            const payload = checkout;
+            if (typeof formatter === 'function') {
+                const formattedPayload = formatter(props, payload);
+                return this.track('Checkout Started', formattedPayload, options);
+            }
+            return this.track('Checkout Started', payload, options);
+        });
+        this.trackCouponApplied = (props, options) => __awaiter(this, void 0, void 0, function* () {
+            var _t, _u, _v;
+            const formatter = (_v = (_u = (_t = this.options) === null || _t === void 0 ? void 0 : _t.formatters) === null || _u === void 0 ? void 0 : _u.events) === null || _v === void 0 ? void 0 : _v.couponApplied;
+            const payload = {
+                cart_id: props === null || props === void 0 ? void 0 : props.cartId,
+                coupon_id: props === null || props === void 0 ? void 0 : props.couponId,
+                coupon_name: props === null || props === void 0 ? void 0 : props.couponName,
+                discount: props === null || props === void 0 ? void 0 : props.discount,
+                order_id: props === null || props === void 0 ? void 0 : props.orderId,
+            };
+            if (typeof formatter === 'function') {
+                const formattedPayload = formatter(props, payload);
+                return this.track('Coupon Applied', formattedPayload, options);
+            }
+            return this.track('Coupon Applied', payload, options);
+        });
+        this.trackCouponDenied = (props, options) => __awaiter(this, void 0, void 0, function* () {
+            var _w, _x, _y;
+            const formatter = (_y = (_x = (_w = this.options) === null || _w === void 0 ? void 0 : _w.formatters) === null || _x === void 0 ? void 0 : _x.events) === null || _y === void 0 ? void 0 : _y.couponDenied;
+            const payload = {
+                cart_id: props === null || props === void 0 ? void 0 : props.cartId,
+                coupon_id: props === null || props === void 0 ? void 0 : props.couponId,
+                coupon_name: props === null || props === void 0 ? void 0 : props.couponName,
+                order_id: props === null || props === void 0 ? void 0 : props.orderId,
+                reason: props === null || props === void 0 ? void 0 : props.reason,
+            };
+            if (typeof formatter === 'function') {
+                const formattedPayload = formatter(props, payload);
+                return this.track('Coupon Denied', formattedPayload, options);
+            }
+            return this.track('Coupon Denied', payload, options);
+        });
+        this.trackCouponEntered = (props, options) => __awaiter(this, void 0, void 0, function* () {
+            var _z, _0, _1;
+            const formatter = (_1 = (_0 = (_z = this.options) === null || _z === void 0 ? void 0 : _z.formatters) === null || _0 === void 0 ? void 0 : _0.events) === null || _1 === void 0 ? void 0 : _1.couponEntered;
+            const payload = {
+                cart_id: props === null || props === void 0 ? void 0 : props.cartId,
+                coupon_id: props === null || props === void 0 ? void 0 : props.couponId,
+                coupon_name: props === null || props === void 0 ? void 0 : props.couponName,
+                order_id: props === null || props === void 0 ? void 0 : props.orderId,
+            };
+            if (typeof formatter === 'function') {
+                const formattedPayload = formatter(props, payload);
+                return this.track('Coupon Entered', formattedPayload, options);
+            }
+            return this.track('Coupon Entered', payload, options);
+        });
+        this.trackCouponRemoved = (props, options) => __awaiter(this, void 0, void 0, function* () {
+            var _2, _3, _4;
+            const formatter = (_4 = (_3 = (_2 = this.options) === null || _2 === void 0 ? void 0 : _2.formatters) === null || _3 === void 0 ? void 0 : _3.events) === null || _4 === void 0 ? void 0 : _4.couponRemoved;
+            const payload = {
+                cart_id: props === null || props === void 0 ? void 0 : props.cartId,
+                coupon_id: props === null || props === void 0 ? void 0 : props.couponId,
+                coupon_name: props === null || props === void 0 ? void 0 : props.couponName,
+                discount: props === null || props === void 0 ? void 0 : props.discount,
+                order_id: props === null || props === void 0 ? void 0 : props.orderId,
+            };
+            if (typeof formatter === 'function') {
+                const formattedPayload = formatter(props, payload);
+                return this.track('Coupon Removed', formattedPayload, options);
+            }
+            return this.track('Coupon Removed', payload, options);
+        });
+        this.trackEmailCaptured = (props, options) => __awaiter(this, void 0, void 0, function* () {
+            var _5, _6, _7;
+            const formatter = (_7 = (_6 = (_5 = this.options) === null || _5 === void 0 ? void 0 : _5.formatters) === null || _6 === void 0 ? void 0 : _6.events) === null || _7 === void 0 ? void 0 : _7.emailCaptured;
+            const payload = {
+                email: props === null || props === void 0 ? void 0 : props.email,
+                placement_component: props === null || props === void 0 ? void 0 : props.placementComponent,
+                placement_page: props === null || props === void 0 ? void 0 : props.placementPage,
+            };
+            if (typeof formatter === 'function') {
+                const formattedPayload = formatter(props, payload);
+                return this.track('Email Captured', formattedPayload, options);
+            }
+            return this.track('Email Captured', payload, options);
+        });
+        this.trackProductAdded = (props, options) => __awaiter(this, void 0, void 0, function* () {
+            var _8, _9, _10, _11, _12, _13, _14, _15, _16, _17, _18, _19;
+            const formatter = (_10 = (_9 = (_8 = this.options) === null || _8 === void 0 ? void 0 : _8.formatters) === null || _9 === void 0 ? void 0 : _9.events) === null || _10 === void 0 ? void 0 : _10.productAdded;
+            const product = (_14 = (_13 = (_12 = (_11 = this.options) === null || _11 === void 0 ? void 0 : _11.formatters) === null || _12 === void 0 ? void 0 : _12.objects) === null || _13 === void 0 ? void 0 : _13.product) === null || _14 === void 0 ? void 0 : _14.call(_13, props === null || props === void 0 ? void 0 : props.product);
+            const cart = (_18 = (_17 = (_16 = (_15 = this.options) === null || _15 === void 0 ? void 0 : _15.formatters) === null || _16 === void 0 ? void 0 : _16.objects) === null || _17 === void 0 ? void 0 : _17.cart) === null || _18 === void 0 ? void 0 : _18.call(_17, {
+                cart: props === null || props === void 0 ? void 0 : props.cart,
+            });
+            const quantity = ((_19 = props === null || props === void 0 ? void 0 : props.product) === null || _19 === void 0 ? void 0 : _19.quantity) || 1;
+            const payload = Object.assign(Object.assign({}, product), { cart_id: cart.cart_id, currency: cart.currency, products: [Object.assign(Object.assign({}, product), { quantity })], total: product.price * (quantity || 1), value: product.price * (quantity || 1) });
+            if (typeof formatter === 'function') {
+                const formattedPayload = formatter(props, payload);
+                return this.track('Product Added', formattedPayload, options);
+            }
+            return this.track('Product Added', payload, options);
+        });
+        this.trackProductClicked = (props, options) => __awaiter(this, void 0, void 0, function* () {
+            var _20, _21, _22, _23, _24, _25, _26, _27, _28, _29, _30, _31, _32;
+            const formatter = (_22 = (_21 = (_20 = this.options) === null || _20 === void 0 ? void 0 : _20.formatters) === null || _21 === void 0 ? void 0 : _21.events) === null || _22 === void 0 ? void 0 : _22.productClicked;
+            const product = (_26 = (_25 = (_24 = (_23 = this.options) === null || _23 === void 0 ? void 0 : _23.formatters) === null || _24 === void 0 ? void 0 : _24.objects) === null || _25 === void 0 ? void 0 : _25.product) === null || _26 === void 0 ? void 0 : _26.call(_25, props === null || props === void 0 ? void 0 : props.product);
+            const cart = (_30 = (_29 = (_28 = (_27 = this.options) === null || _27 === void 0 ? void 0 : _27.formatters) === null || _28 === void 0 ? void 0 : _28.objects) === null || _29 === void 0 ? void 0 : _29.cart) === null || _30 === void 0 ? void 0 : _30.call(_29, {
+                cart: props === null || props === void 0 ? void 0 : props.cart,
+            });
+            const quantity = ((_31 = props === null || props === void 0 ? void 0 : props.product) === null || _31 === void 0 ? void 0 : _31.quantity) || 1;
+            const payload = Object.assign(Object.assign({}, product), { cart_id: cart.cart_id, currency: cart.currency, item_list_id: (_32 = props === null || props === void 0 ? void 0 : props.listId) === null || _32 === void 0 ? void 0 : _32.toString(), item_list_name: props === null || props === void 0 ? void 0 : props.listName, products: [Object.assign(Object.assign({}, product), { quantity })] });
+            if (typeof formatter === 'function') {
+                const formattedPayload = formatter(props, payload);
+                return this.track('Product Clicked', formattedPayload, options);
+            }
+            return this.track('Product Clicked', payload, options);
+        });
+        this.trackProductListFiltered = (props, options) => __awaiter(this, void 0, void 0, function* () {
+            var _33, _34, _35, _36, _37;
+            const formatter = (_35 = (_34 = (_33 = this.options) === null || _33 === void 0 ? void 0 : _33.formatters) === null || _34 === void 0 ? void 0 : _34.events) === null || _35 === void 0 ? void 0 : _35.productListFiltered;
+            const payload = {
+                category: props === null || props === void 0 ? void 0 : props.category,
+                filters: props === null || props === void 0 ? void 0 : props.filters,
+                list_id: (_36 = props === null || props === void 0 ? void 0 : props.listId) === null || _36 === void 0 ? void 0 : _36.toString(),
+                item_list_id: (_37 = props === null || props === void 0 ? void 0 : props.listId) === null || _37 === void 0 ? void 0 : _37.toString(),
+                item_list_name: props === null || props === void 0 ? void 0 : props.listName,
+                sorts: props === null || props === void 0 ? void 0 : props.sorts,
+            };
+            if (typeof formatter === 'function') {
+                const formattedPayload = formatter(props, payload);
+                return this.track('Product List Filtered', formattedPayload, options);
+            }
+            return this.track('Product List Filtered', payload, options);
+        });
+        this.trackProductListViewed = (props, options) => __awaiter(this, void 0, void 0, function* () {
+            var _38, _39, _40, _41, _42, _43;
+            const formatter = (_40 = (_39 = (_38 = this.options) === null || _38 === void 0 ? void 0 : _38.formatters) === null || _39 === void 0 ? void 0 : _39.events) === null || _40 === void 0 ? void 0 : _40.productListViewed;
+            const payload = {
+                category: props === null || props === void 0 ? void 0 : props.category,
+                list_id: (_41 = props === null || props === void 0 ? void 0 : props.listId) === null || _41 === void 0 ? void 0 : _41.toString(),
+                item_list_id: (_42 = props === null || props === void 0 ? void 0 : props.listId) === null || _42 === void 0 ? void 0 : _42.toString(),
+                item_list_name: props === null || props === void 0 ? void 0 : props.listName,
+                products: (_43 = props === null || props === void 0 ? void 0 : props.products) === null || _43 === void 0 ? void 0 : _43.map((p, i) => {
+                    var _a, _b, _c, _d;
+                    return (_d = (_c = (_b = (_a = this.options) === null || _a === void 0 ? void 0 : _a.formatters) === null || _b === void 0 ? void 0 : _b.objects) === null || _c === void 0 ? void 0 : _c.product) === null || _d === void 0 ? void 0 : _d.call(_c, Object.assign(Object.assign({}, p), { position: i + 1 }));
+                }),
+                value: 0, // TODO: remove from tracking plan
+            };
+            if (typeof formatter === 'function') {
+                const formattedPayload = formatter(props, payload);
+                return this.track('Product List Viewed', formattedPayload, options);
+            }
+            return this.track('Product List Viewed', payload, options);
+        });
+        this.trackProductRemoved = (props, options) => __awaiter(this, void 0, void 0, function* () {
+            var _44, _45, _46, _47, _48, _49, _50, _51, _52, _53, _54, _55, _56, _57, _58;
+            const formatter = (_46 = (_45 = (_44 = this.options) === null || _44 === void 0 ? void 0 : _44.formatters) === null || _45 === void 0 ? void 0 : _45.events) === null || _46 === void 0 ? void 0 : _46.productRemoved;
+            /*
+            const product = this.options?.formatters?.objects?.product?.({
+              position: props?.position,
+              product: props?.product,
+              quantity: props?.quantity,
+              variantId: props?.variantId,
+            })
+            */
+            const lineItem = (_50 = (_49 = (_48 = (_47 = this.options) === null || _47 === void 0 ? void 0 : _47.formatters) === null || _48 === void 0 ? void 0 : _48.objects) === null || _49 === void 0 ? void 0 : _49.lineItem) === null || _50 === void 0 ? void 0 : _50.call(_49, {
+                lineItem: props === null || props === void 0 ? void 0 : props.lineItem,
+            });
+            const cart = (_54 = (_53 = (_52 = (_51 = this.options) === null || _51 === void 0 ? void 0 : _51.formatters) === null || _52 === void 0 ? void 0 : _52.objects) === null || _53 === void 0 ? void 0 : _53.cart) === null || _54 === void 0 ? void 0 : _54.call(_53, {
+                cart: props === null || props === void 0 ? void 0 : props.cart,
+            });
+            const payload = Object.assign(Object.assign({}, lineItem), { cart_id: cart.cart_id, currency: cart.currency, products: [lineItem], total: ((_55 = lineItem === null || lineItem === void 0 ? void 0 : lineItem.price) !== null && _55 !== void 0 ? _55 : 0) * ((_56 = lineItem === null || lineItem === void 0 ? void 0 : lineItem.quantity) !== null && _56 !== void 0 ? _56 : 1), value: ((_57 = lineItem === null || lineItem === void 0 ? void 0 : lineItem.price) !== null && _57 !== void 0 ? _57 : 0) * ((_58 = lineItem === null || lineItem === void 0 ? void 0 : lineItem.quantity) !== null && _58 !== void 0 ? _58 : 1) });
+            if (typeof formatter === 'function') {
+                const formattedPayload = formatter(props, payload);
+                return this.track('Product Removed', formattedPayload, options);
+            }
+            return this.track('Product Removed', payload, options);
+        });
+        this.trackProductViewed = (props, options) => __awaiter(this, void 0, void 0, function* () {
+            var _59, _60, _61, _62, _63, _64, _65, _66, _67, _68, _69, _70, _71;
+            const formatter = (_61 = (_60 = (_59 = this.options) === null || _59 === void 0 ? void 0 : _59.formatters) === null || _60 === void 0 ? void 0 : _60.events) === null || _61 === void 0 ? void 0 : _61.productViewed;
+            const product = (_65 = (_64 = (_63 = (_62 = this.options) === null || _62 === void 0 ? void 0 : _62.formatters) === null || _63 === void 0 ? void 0 : _63.objects) === null || _64 === void 0 ? void 0 : _64.product) === null || _65 === void 0 ? void 0 : _65.call(_64, props === null || props === void 0 ? void 0 : props.product);
+            const cart = (_69 = (_68 = (_67 = (_66 = this.options) === null || _66 === void 0 ? void 0 : _66.formatters) === null || _67 === void 0 ? void 0 : _67.objects) === null || _68 === void 0 ? void 0 : _68.cart) === null || _69 === void 0 ? void 0 : _69.call(_68, {
+                cart: props === null || props === void 0 ? void 0 : props.cart,
+            });
+            const quantity = ((_70 = props === null || props === void 0 ? void 0 : props.product) === null || _70 === void 0 ? void 0 : _70.quantity) || 1;
+            const payload = Object.assign(Object.assign({}, product), { cart_id: cart.cart_id, currency: cart.currency, products: [Object.assign(Object.assign({}, product), { quantity })], value: product.price * (((_71 = props === null || props === void 0 ? void 0 : props.product) === null || _71 === void 0 ? void 0 : _71.quantity) || 1) });
+            if (typeof formatter === 'function') {
+                const formattedPayload = formatter(props, payload);
+                return this.track('Product Viewed', formattedPayload, options);
+            }
+            return this.track('Product Viewed', payload, options);
+        });
+        this.trackProductsSearched = (props, options) => __awaiter(this, void 0, void 0, function* () {
+            var _72, _73, _74, _75;
+            const formatter = (_74 = (_73 = (_72 = this.options) === null || _72 === void 0 ? void 0 : _72.formatters) === null || _73 === void 0 ? void 0 : _73.events) === null || _74 === void 0 ? void 0 : _74.productsSearched;
+            const payload = {
+                currency: props === null || props === void 0 ? void 0 : props.currency,
+                price: typeof (props === null || props === void 0 ? void 0 : props.price) !== 'undefined' ? Number(props === null || props === void 0 ? void 0 : props.price) : undefined,
+                product_id: (_75 = props === null || props === void 0 ? void 0 : props.productId) === null || _75 === void 0 ? void 0 : _75.toString(),
+                quantity: props === null || props === void 0 ? void 0 : props.quantity,
+                query: props === null || props === void 0 ? void 0 : props.query,
+            };
+            if (typeof formatter === 'function') {
+                const formattedPayload = formatter(props, payload);
+                return this.track('Products Searched', formattedPayload, options);
+            }
+            return this.track('Products Searched', payload, options);
+        });
+        this.trackSignedIn = (props, options) => __awaiter(this, void 0, void 0, function* () {
+            var _76, _77, _78;
+            const formatter = (_78 = (_77 = (_76 = this.options) === null || _76 === void 0 ? void 0 : _76.formatters) === null || _77 === void 0 ? void 0 : _77.events) === null || _78 === void 0 ? void 0 : _78.signedIn;
+            const payload = {
+                email: props === null || props === void 0 ? void 0 : props.email,
+                method: props === null || props === void 0 ? void 0 : props.method,
+            };
+            if (typeof formatter === 'function') {
+                const formattedPayload = formatter(props, payload);
+                return this.track('Signed In', formattedPayload, options);
+            }
+            return this.track('Signed In', payload, options);
+        });
+        this.trackSignedOut = (props, options) => __awaiter(this, void 0, void 0, function* () {
+            var _79, _80, _81;
+            const formatter = (_81 = (_80 = (_79 = this.options) === null || _79 === void 0 ? void 0 : _79.formatters) === null || _80 === void 0 ? void 0 : _80.events) === null || _81 === void 0 ? void 0 : _81.signedOut;
+            const payload = {
+                email: props === null || props === void 0 ? void 0 : props.email,
+            };
+            if (typeof formatter === 'function') {
+                const formattedPayload = formatter(props || {}, payload);
+                return this.track('Signed Out', formattedPayload, options);
+            }
+            return this.track('Signed Out', payload, options);
+        });
+        this.trackSignedUp = (props, options) => __awaiter(this, void 0, void 0, function* () {
+            var _82, _83, _84;
+            const formatter = (_84 = (_83 = (_82 = this.options) === null || _82 === void 0 ? void 0 : _82.formatters) === null || _83 === void 0 ? void 0 : _83.events) === null || _84 === void 0 ? void 0 : _84.signedUp;
+            const payload = {
+                email: props === null || props === void 0 ? void 0 : props.email,
+                method: props === null || props === void 0 ? void 0 : props.method,
+            };
+            if (typeof formatter === 'function') {
+                const formattedPayload = formatter(props || {}, payload);
+                return this.track('Signed Up', formattedPayload, options);
+            }
+            return this.track('Signed Up', payload, options);
+        });
+        const defaults = {
+            debug: false,
+            enableLogging: true,
+            stripNull: true,
+        };
+        this.options = Object.assign(Object.assign({}, defaults), options);
+    }
+}

package/dist/index.d.ts

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

package/dist/index.js

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