@jetshop/core 5.13.1 → 5.13.11-0

package/analytics/trackerRegistry.d.ts

@@ -1,101 +1,101 @@
-import { AnalyticsConfig } from '@jetshop/core/analytics/AnalyticsProvider';
-import { Product, Cart, ProductVariant } from '@jetshop/core/types';
-import TypedEventEmitter from 'typed-emitter';
-export interface TrackingFunctionContext {
-    trackerRegistry: TrackerRegistry;
-    emit: (event: string, props: any) => void;
-    list?: string;
-}
-export interface TrackProductProps {
-    action: 'view' | 'remove' | 'add' | 'click' | 'heed_recommendation';
-    product: Product;
-    selectedVariation?: ProductVariant;
-    list?: string;
-    listName?: string;
-    index?: number;
-    /** The quantity of items added/removed from cart */
-    quantity?: number;
-    category: string;
-}
-export interface TrackCartProps {
-    cart: Cart;
-    callback?: (response?: Response) => void;
-}
-export interface TrackListProps {
-    listName: string;
-    products: Product[];
-    category: string;
-}
-export interface TrackPageProps {
-    pathname: string;
-    title: string;
-}
-export interface TrackExperimentProps {
-    id: string;
-    variant: number;
-}
-export interface TrackUserProps {
-    userId: string;
-}
-export interface TrackAddToWishListProps {
-    articleNumber: string;
-    productName: string;
-}
-export interface TrackingProps {
-    trackProduct: TrackProductProps;
-    trackCartCheckout: TrackCartProps;
-    trackCart: TrackCartProps;
-    trackList: TrackListProps;
-    trackPageView: TrackPageProps;
-    trackExperiment: TrackExperimentProps;
-    trackUser: TrackUserProps;
-    trackLogin: null;
-    trackRegister: null;
-    trackAddToWishList: TrackAddToWishListProps;
-}
-export interface InitOptions {
-    trackerRegistry: TrackerRegistry;
-}
-export interface BaseTrackingEvents {
-    trackProduct: (props: TrackProductProps, context: TrackingFunctionContext, eventId?: string) => void;
-    trackCartCheckout: (props: TrackCartProps, context: TrackingFunctionContext, eventId?: string, callback?: (response: Response) => void) => void;
-    trackCart: (props: TrackCartProps, context: TrackingFunctionContext, eventId?: string) => void;
-    trackList: (props: TrackListProps, context: TrackingFunctionContext, eventId?: string) => void;
-    trackPageView: (props: TrackPageProps, context: TrackingFunctionContext, eventId?: string) => void;
-    trackExperiment: (props: TrackExperimentProps, context: TrackingFunctionContext, eventId?: string) => void;
-    trackUser: (props: TrackUserProps, context: TrackingFunctionContext, eventId?: string) => void;
-    trackLogin: (props: any, context: TrackingFunctionContext, eventId?: string) => void;
-    trackRegister: (props: any, context: TrackingFunctionContext, eventId?: string) => void;
-    trackAddToWishList: (props: TrackAddToWishListProps, context: TrackingFunctionContext, eventId?: string) => void;
-}
-export interface TrackingEvents extends BaseTrackingEvents {
-    [key: string]: (props: any, context: TrackingFunctionContext, eventId?: string) => void;
-}
-export declare const trackingEvents: (keyof BaseTrackingEvents)[];
-export interface Tracker extends Partial<BaseTrackingEvents> {
-    name: string;
-    initBrowser?: (opts: InitOptions) => void;
-}
-export declare type TrackerRegistryEventEmitter = TypedEventEmitter<TrackingEvents>;
-export interface TrackerRegistry {
-    on<E extends keyof TrackingEvents>(event: E, args: TrackingEvents[E], opts?: {
-        name?: string;
-    }): void;
-    emit<E extends keyof TrackingEvents>(event: E, props: any, context: TrackingFunctionContext, eventId?: string): boolean;
-    /**
-     * Add `Tracker` to registry.
-     * - Auto-binds built-in events (see `TrackingEvents`)
-     * - Runs `initBrowser`
-     */
-    add: (tracker: Tracker) => void;
-}
-export declare function createServerTracker({ currency, useArticleNumberAsId, pixelId, token }: {
-    currency: string;
-    useArticleNumberAsId: boolean;
-    pixelId?: string;
-    token?: string;
-}): Tracker;
-export declare function trackerRegistry({ config, inServer }: {
-    config: AnalyticsConfig;
-    inServer: boolean;
-}): TrackerRegistry;
+import { AnalyticsConfig } from '@jetshop/core/analytics/AnalyticsProvider';
+import { Product, Cart, ProductVariant } from '@jetshop/core/types';
+import TypedEventEmitter from 'typed-emitter';
+export interface TrackingFunctionContext {
+    trackerRegistry: TrackerRegistry;
+    emit: (event: string, props: any) => void;
+    list?: string;
+}
+export interface TrackProductProps {
+    action: 'view' | 'remove' | 'add' | 'click' | 'heed_recommendation';
+    product: Product;
+    selectedVariation?: ProductVariant;
+    list?: string;
+    listName?: string;
+    index?: number;
+    /** The quantity of items added/removed from cart */
+    quantity?: number;
+    category: string;
+}
+export interface TrackCartProps {
+    cart: Cart;
+    callback?: (response?: Response) => void;
+}
+export interface TrackListProps {
+    listName: string;
+    products: Product[];
+    category: string;
+}
+export interface TrackPageProps {
+    pathname: string;
+    title: string;
+}
+export interface TrackExperimentProps {
+    id: string;
+    variant: number;
+}
+export interface TrackUserProps {
+    userId: string;
+}
+export interface TrackAddToWishListProps {
+    articleNumber: string;
+    productName: string;
+}
+export interface TrackingProps {
+    trackProduct: TrackProductProps;
+    trackCartCheckout: TrackCartProps;
+    trackCart: TrackCartProps;
+    trackList: TrackListProps;
+    trackPageView: TrackPageProps;
+    trackExperiment: TrackExperimentProps;
+    trackUser: TrackUserProps;
+    trackLogin: null;
+    trackRegister: null;
+    trackAddToWishList: TrackAddToWishListProps;
+}
+export interface InitOptions {
+    trackerRegistry: TrackerRegistry;
+}
+export interface BaseTrackingEvents {
+    trackProduct: (props: TrackProductProps, context: TrackingFunctionContext, eventId?: string) => void;
+    trackCartCheckout: (props: TrackCartProps, context: TrackingFunctionContext, eventId?: string, callback?: (response: Response) => void) => void;
+    trackCart: (props: TrackCartProps, context: TrackingFunctionContext, eventId?: string) => void;
+    trackList: (props: TrackListProps, context: TrackingFunctionContext, eventId?: string) => void;
+    trackPageView: (props: TrackPageProps, context: TrackingFunctionContext, eventId?: string) => void;
+    trackExperiment: (props: TrackExperimentProps, context: TrackingFunctionContext, eventId?: string) => void;
+    trackUser: (props: TrackUserProps, context: TrackingFunctionContext, eventId?: string) => void;
+    trackLogin: (props: any, context: TrackingFunctionContext, eventId?: string) => void;
+    trackRegister: (props: any, context: TrackingFunctionContext, eventId?: string) => void;
+    trackAddToWishList: (props: TrackAddToWishListProps, context: TrackingFunctionContext, eventId?: string) => void;
+}
+export interface TrackingEvents extends BaseTrackingEvents {
+    [key: string]: (props: any, context: TrackingFunctionContext, eventId?: string) => void;
+}
+export declare const trackingEvents: (keyof BaseTrackingEvents)[];
+export interface Tracker extends Partial<BaseTrackingEvents> {
+    name: string;
+    initBrowser?: (opts: InitOptions) => void;
+}
+export declare type TrackerRegistryEventEmitter = TypedEventEmitter<TrackingEvents>;
+export interface TrackerRegistry {
+    on<E extends keyof TrackingEvents>(event: E, args: TrackingEvents[E], opts?: {
+        name?: string;
+    }): void;
+    emit<E extends keyof TrackingEvents>(event: E, props: any, context: TrackingFunctionContext, eventId?: string): boolean;
+    /**
+     * Add `Tracker` to registry.
+     * - Auto-binds built-in events (see `TrackingEvents`)
+     * - Runs `initBrowser`
+     */
+    add: (tracker: Tracker) => void;
+}
+export declare function createServerTracker({ currency, useArticleNumberAsId, pixelId, token }: {
+    currency: string;
+    useArticleNumberAsId: boolean;
+    pixelId?: string;
+    token?: string;
+}): Tracker;
+export declare function trackerRegistry({ config, inServer }: {
+    config: AnalyticsConfig;
+    inServer: boolean;
+}): TrackerRegistry;

package/analytics/trackerRegistry.js

@@ -1,220 +1,220 @@
-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 eventemitter3 from 'eventemitter3';
-export const trackingEvents = [
-    'trackProduct',
-    'trackCartCheckout',
-    'trackCart',
-    'trackList',
-    'trackPageView',
-    'trackExperiment',
-    'trackUser',
-    'trackLogin',
-    'trackRegister',
-    'trackAddToWishList'
-];
-export function createServerTracker({ currency, useArticleNumberAsId, pixelId, token }) {
-    const defaults = {
-        useArticleNumberAsId,
-        currency,
-        pixelId,
-        token
-    };
-    const serverTracker = {
-        name: 'server',
-        trackProduct(props, context, eventId) {
-            fetch(`/_event?event=trackProduct`, {
-                method: 'POST',
-                headers: {
-                    'Content-Type': 'application/json'
-                },
-                body: JSON.stringify(Object.assign(Object.assign({}, defaults), { eventId,
-                    props,
-                    context, location: window.location.href }))
-            });
-        },
-        trackCartCheckout(props, context, eventId) {
-            return __awaiter(this, void 0, void 0, function* () {
-                try {
-                    yield fetch(`/_event?event=trackCartCheckout`, {
-                        method: 'POST',
-                        headers: {
-                            'Content-Type': 'application/json'
-                        },
-                        body: JSON.stringify(Object.assign(Object.assign({}, defaults), { eventId, props: { cart: props.cart }, context, location: window.location.href }))
-                    });
-                }
-                finally {
-                    props.callback();
-                }
-            });
-        },
-        trackCart(props, context, eventId) {
-            fetch(`/_event?event=trackCart`, {
-                method: 'POST',
-                headers: {
-                    'Content-Type': 'application/json'
-                },
-                body: JSON.stringify(Object.assign(Object.assign({}, defaults), { eventId,
-                    props,
-                    context, location: window.location.href }))
-            });
-        },
-        trackList(props, context, eventId) {
-            fetch(`/_event?event=trackList`, {
-                method: 'POST',
-                headers: {
-                    'Content-Type': 'application/json'
-                },
-                body: JSON.stringify(Object.assign(Object.assign({}, defaults), { eventId, props: {
-                        listName: props.listName,
-                        products: props.products.map((product) => ({
-                            articleNumber: product.articleNumber,
-                            id: product.id,
-                            price: product.price,
-                            name: product.name,
-                            previousPrice: product.previousPrice
-                        }))
-                    }, context, location: window.location.href }))
-            });
-        },
-        trackPageView(props, context, eventId) {
-            fetch(`/_event?event=trackPageView`, {
-                method: 'POST',
-                headers: {
-                    'Content-Type': 'application/json'
-                },
-                body: JSON.stringify(Object.assign(Object.assign({}, defaults), { eventId,
-                    props,
-                    context, location: window.location.href }))
-            });
-        },
-        trackExperiment(props, context, eventId) {
-            fetch(`/_event?event=trackExperiment`, {
-                method: 'POST',
-                headers: {
-                    'Content-Type': 'application/json'
-                },
-                body: JSON.stringify(Object.assign(Object.assign({}, defaults), { eventId,
-                    props,
-                    context, location: window.location.href }))
-            });
-        },
-        trackUser(props, context, eventId) {
-            fetch(`/_event?event=trackUser`, {
-                method: 'POST',
-                headers: {
-                    'Content-Type': 'application/json'
-                },
-                body: JSON.stringify(Object.assign(Object.assign({}, defaults), { eventId,
-                    props,
-                    context, location: window.location.href }))
-            });
-        },
-        trackLogin(_props, context, eventId) {
-            fetch(`/_event?event=trackLogin`, {
-                method: 'POST',
-                headers: {
-                    'Content-Type': 'application/json'
-                },
-                body: JSON.stringify({
-                    eventId,
-                    currency,
-                    context,
-                    location: window.location.href
-                })
-            });
-        },
-        trackRegister(_props, context, eventId) {
-            fetch(`/_event?event=trackRegister`, {
-                method: 'POST',
-                headers: {
-                    'Content-Type': 'application/json'
-                },
-                body: JSON.stringify({
-                    eventId,
-                    currency,
-                    context,
-                    location: window.location.href
-                })
-            });
-        },
-        trackAddToWishList(props, context, eventId) {
-            fetch(`/_event?event=trackAddToWishList`, {
-                method: 'POST',
-                headers: {
-                    'Content-Type': 'application/json'
-                },
-                body: JSON.stringify(Object.assign(Object.assign({}, defaults), { eventId,
-                    props,
-                    context, location: window.location.href }))
-            });
-        }
-    };
-    return serverTracker;
-}
-export function trackerRegistry({ config, inServer }) {
-    const trackers = [];
-    const initialized = false;
-    const events = new eventemitter3();
-    const registry = {
-        on(event, listeners, { name } = {}) {
-            return events.on(event.toString(), (...args) => __awaiter(this, void 0, void 0, function* () {
-                try {
-                    return yield listeners.apply(this, args);
-                }
-                catch (err) {
-                    console.error(`Error triggering ${event}:${name}`, {
-                        err
-                    });
-                }
-            }));
-        },
-        emit(event, props, context, eventId) {
-            return events.emit(event.toString(), props, context, eventId);
-        },
-        add(tracker) {
-            if (trackers.find(({ name }) => name === tracker.name)) {
-                throw new Error(`Tracker with name "${tracker.name}" is already registered`);
-            }
-            if (initialized) {
-                throw new Error(`Tried adding tracker "${tracker.name}" after trackers already have been initialized.`);
-            }
-            trackers.push(tracker);
-            // Auto-bind built-in events
-            trackingEvents.forEach((method) => {
-                if (tracker[method]) {
-                    registry.on(method, tracker[method], { name: tracker.name });
-                }
-            });
-            if (inServer) {
-                return;
-            }
-            if (!tracker.initBrowser) {
-                return;
-            }
-            if (typeof (config === null || config === void 0 ? void 0 : config.trackingAllowed) === null || !config.trackingAllowed) {
-                return;
-            }
-            const opts = { config, trackerRegistry: registry };
-            try {
-                tracker.initBrowser(opts);
-            }
-            catch (err) {
-                console.error(`Error ${tracker.name}:initBrowser`, {
-                    err,
-                    opts
-                });
-            }
-        }
-    };
-    return registry;
-}
+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 eventemitter3 from 'eventemitter3';
+export const trackingEvents = [
+    'trackProduct',
+    'trackCartCheckout',
+    'trackCart',
+    'trackList',
+    'trackPageView',
+    'trackExperiment',
+    'trackUser',
+    'trackLogin',
+    'trackRegister',
+    'trackAddToWishList'
+];
+export function createServerTracker({ currency, useArticleNumberAsId, pixelId, token }) {
+    const defaults = {
+        useArticleNumberAsId,
+        currency,
+        pixelId,
+        token
+    };
+    const serverTracker = {
+        name: 'server',
+        trackProduct(props, context, eventId) {
+            fetch(`/_event?event=trackProduct`, {
+                method: 'POST',
+                headers: {
+                    'Content-Type': 'application/json'
+                },
+                body: JSON.stringify(Object.assign(Object.assign({}, defaults), { eventId,
+                    props,
+                    context, location: window.location.href }))
+            });
+        },
+        trackCartCheckout(props, context, eventId) {
+            return __awaiter(this, void 0, void 0, function* () {
+                try {
+                    yield fetch(`/_event?event=trackCartCheckout`, {
+                        method: 'POST',
+                        headers: {
+                            'Content-Type': 'application/json'
+                        },
+                        body: JSON.stringify(Object.assign(Object.assign({}, defaults), { eventId, props: { cart: props.cart }, context, location: window.location.href }))
+                    });
+                }
+                finally {
+                    props.callback();
+                }
+            });
+        },
+        trackCart(props, context, eventId) {
+            fetch(`/_event?event=trackCart`, {
+                method: 'POST',
+                headers: {
+                    'Content-Type': 'application/json'
+                },
+                body: JSON.stringify(Object.assign(Object.assign({}, defaults), { eventId,
+                    props,
+                    context, location: window.location.href }))
+            });
+        },
+        trackList(props, context, eventId) {
+            fetch(`/_event?event=trackList`, {
+                method: 'POST',
+                headers: {
+                    'Content-Type': 'application/json'
+                },
+                body: JSON.stringify(Object.assign(Object.assign({}, defaults), { eventId, props: {
+                        listName: props.listName,
+                        products: props.products.map((product) => ({
+                            articleNumber: product.articleNumber,
+                            id: product.id,
+                            price: product.price,
+                            name: product.name,
+                            previousPrice: product.previousPrice
+                        }))
+                    }, context, location: window.location.href }))
+            });
+        },
+        trackPageView(props, context, eventId) {
+            fetch(`/_event?event=trackPageView`, {
+                method: 'POST',
+                headers: {
+                    'Content-Type': 'application/json'
+                },
+                body: JSON.stringify(Object.assign(Object.assign({}, defaults), { eventId,
+                    props,
+                    context, location: window.location.href }))
+            });
+        },
+        trackExperiment(props, context, eventId) {
+            fetch(`/_event?event=trackExperiment`, {
+                method: 'POST',
+                headers: {
+                    'Content-Type': 'application/json'
+                },
+                body: JSON.stringify(Object.assign(Object.assign({}, defaults), { eventId,
+                    props,
+                    context, location: window.location.href }))
+            });
+        },
+        trackUser(props, context, eventId) {
+            fetch(`/_event?event=trackUser`, {
+                method: 'POST',
+                headers: {
+                    'Content-Type': 'application/json'
+                },
+                body: JSON.stringify(Object.assign(Object.assign({}, defaults), { eventId,
+                    props,
+                    context, location: window.location.href }))
+            });
+        },
+        trackLogin(_props, context, eventId) {
+            fetch(`/_event?event=trackLogin`, {
+                method: 'POST',
+                headers: {
+                    'Content-Type': 'application/json'
+                },
+                body: JSON.stringify({
+                    eventId,
+                    currency,
+                    context,
+                    location: window.location.href
+                })
+            });
+        },
+        trackRegister(_props, context, eventId) {
+            fetch(`/_event?event=trackRegister`, {
+                method: 'POST',
+                headers: {
+                    'Content-Type': 'application/json'
+                },
+                body: JSON.stringify({
+                    eventId,
+                    currency,
+                    context,
+                    location: window.location.href
+                })
+            });
+        },
+        trackAddToWishList(props, context, eventId) {
+            fetch(`/_event?event=trackAddToWishList`, {
+                method: 'POST',
+                headers: {
+                    'Content-Type': 'application/json'
+                },
+                body: JSON.stringify(Object.assign(Object.assign({}, defaults), { eventId,
+                    props,
+                    context, location: window.location.href }))
+            });
+        }
+    };
+    return serverTracker;
+}
+export function trackerRegistry({ config, inServer }) {
+    const trackers = [];
+    const initialized = false;
+    const events = new eventemitter3();
+    const registry = {
+        on(event, listeners, { name } = {}) {
+            return events.on(event.toString(), (...args) => __awaiter(this, void 0, void 0, function* () {
+                try {
+                    return yield listeners.apply(this, args);
+                }
+                catch (err) {
+                    console.error(`Error triggering ${event}:${name}`, {
+                        err
+                    });
+                }
+            }));
+        },
+        emit(event, props, context, eventId) {
+            return events.emit(event.toString(), props, context, eventId);
+        },
+        add(tracker) {
+            if (trackers.find(({ name }) => name === tracker.name)) {
+                throw new Error(`Tracker with name "${tracker.name}" is already registered`);
+            }
+            if (initialized) {
+                throw new Error(`Tried adding tracker "${tracker.name}" after trackers already have been initialized.`);
+            }
+            trackers.push(tracker);
+            // Auto-bind built-in events
+            trackingEvents.forEach((method) => {
+                if (tracker[method]) {
+                    registry.on(method, tracker[method], { name: tracker.name });
+                }
+            });
+            if (inServer) {
+                return;
+            }
+            if (!tracker.initBrowser) {
+                return;
+            }
+            if (typeof (config === null || config === void 0 ? void 0 : config.trackingAllowed) === null || !config.trackingAllowed) {
+                return;
+            }
+            const opts = { config, trackerRegistry: registry };
+            try {
+                tracker.initBrowser(opts);
+            }
+            catch (err) {
+                console.error(`Error ${tracker.name}:initBrowser`, {
+                    err,
+                    opts
+                });
+            }
+        }
+    };
+    return registry;
+}
 //# sourceMappingURL=trackerRegistry.js.map