medusa-storefront-analytics 1.2.0

package/README.md

@@ -0,0 +1,57 @@
+# medusa-storefront-analytics
+
+Layered analytics for Medusa storefronts. **Core** defines adapters; **providers** implement GTM; **events** expose domain helpers.
+
+## Layers
+
+```
+events/reviews.ts     → emitReviewSubmitted(adapter, { productId, productName, rating })
+events/forms.ts       → emitContactFormSubmitted, emitLeadCaptured
+providers/gtm.ts      → createGtmAnalyticsAdapter() → dataLayer pushes
+core/types.ts         → StorefrontAnalyticsAdapter interface
+core/compose.ts       → composeAnalyticsAdapters([gtm, custom])
+```
+
+## Review submitted event
+
+```ts
+import { createGtmAnalyticsAdapter, emitReviewSubmitted } from "medusa-storefront-analytics";
+
+const analytics = createGtmAnalyticsAdapter();
+
+emitReviewSubmitted(analytics, {
+  productId: "prod_123",
+  productName: "Kids Hoodie",
+  rating: 5,
+  reviewTitle: "Great fit",
+  isUpdate: false,
+});
+```
+
+**dataLayer pushes:**
+
+- `event: "review_submitted"` with `product_id`, `product_name`, `rating`, `review_title`
+- `event: "form_submit"` (legacy) with `form_type: "product_review_submit"` for existing GTM tags
+
+## Storefront wiring
+
+```ts
+// lib/adapters/analytics.ts
+import { createGtmAnalyticsAdapter } from "medusa-storefront-analytics";
+export const storefrontAnalytics = createGtmAnalyticsAdapter();
+```
+
+```tsx
+<SubmitReviewModal analytics={storefrontAnalytics} ... />
+```
+
+## Compose multiple backends
+
+```ts
+import { composeAnalyticsAdapters, createGtmAnalyticsAdapter } from "medusa-storefront-analytics";
+
+export const storefrontAnalytics = composeAnalyticsAdapters([
+  createGtmAnalyticsAdapter(),
+  { trackReviewSubmitted(p) { console.log("review", p); } },
+]);
+```

package/dist/core/compose.d.ts

@@ -0,0 +1,6 @@
+import { StorefrontAnalyticsAdapter } from './types';
+
+/**
+ * Fan-out to multiple adapters (e.g. GTM + custom logger).
+ */
+export declare function composeAnalyticsAdapters(adapters: StorefrontAnalyticsAdapter[]): StorefrontAnalyticsAdapter;

package/dist/core/noop-adapter.d.ts

@@ -0,0 +1,3 @@
+import { StorefrontAnalyticsAdapter } from './types';
+
+export declare const noopAnalyticsAdapter: StorefrontAnalyticsAdapter;

package/dist/core/types.d.ts

@@ -0,0 +1,31 @@
+/** Shared product reference for ecommerce / UGC events */
+export interface ProductRef {
+    productId: string;
+    productName: string;
+}
+export interface ReviewSubmittedPayload extends ProductRef {
+    rating: number;
+    /** Review title entered by the customer */
+    reviewTitle?: string;
+    /** True when an existing review was updated */
+    isUpdate: boolean;
+}
+export interface FormSubmittedPayload {
+    form_type: string;
+    formType?: string;
+    [key: string]: unknown;
+}
+/**
+ * Port implemented by each site (GTM, Meta, custom). Domain helpers call these methods.
+ */
+export interface StorefrontAnalyticsAdapter {
+    trackReviewSubmitted(payload: ReviewSubmittedPayload): void;
+    trackReviewUpdated?(payload: ReviewSubmittedPayload): void;
+    trackFormSubmitted?(payload: FormSubmittedPayload): void;
+    trackEvent?(eventName: string, data?: Record<string, unknown>): void;
+}
+export type AnalyticsEventMap = {
+    review_submitted: ReviewSubmittedPayload;
+    review_updated: ReviewSubmittedPayload;
+    form_submit: FormSubmittedPayload;
+};

package/dist/ecommerce/ga4-ecommerce.d.ts

@@ -0,0 +1,65 @@
+import { META_STANDARD_EVENTS, EcommercePayload, GA4Item, MetaStandardEventName } from '../events/meta-events';
+
+export { META_STANDARD_EVENTS, type EcommercePayload, type GA4Item, type MetaStandardEventName, };
+type CartLineLike = {
+    id: string;
+    variant_id?: string;
+    title?: string;
+    product_title?: string;
+    quantity: number;
+    total?: number;
+};
+type CartLike = {
+    items?: CartLineLike[];
+    total?: number;
+    currency_code?: string;
+    region?: {
+        currency_code?: string;
+    };
+};
+export declare function trackMetaStandardEvent(metaEvent: MetaStandardEventName, params?: Record<string, unknown>): void;
+export declare function cartToEcommercePayload(cart: CartLike | null): EcommercePayload | null;
+export declare function trackAddToCart(payload: EcommercePayload): void;
+export declare function trackRemoveFromCart(payload: EcommercePayload): void;
+export declare function trackViewCart(payload: EcommercePayload): void;
+export declare function trackViewItem(payload: EcommercePayload): void;
+export declare function trackViewItemList(payload: {
+    list_id?: string;
+    list_name?: string;
+    items: GA4Item[];
+}): void;
+export declare function markInitiateCheckoutFired(cartId: string): void;
+export declare function wasInitiateCheckoutFired(cartId: string, maxAgeMs?: number): boolean;
+export declare function trackInitiateCheckoutFromCart(payload: EcommercePayload, cartId?: string): void;
+export declare function trackBeginCheckout(payload: EcommercePayload): void;
+export declare function trackAddShippingInfo(payload: EcommercePayload): void;
+export declare function trackAddPaymentInfo(payload: EcommercePayload, extra?: Record<string, unknown>): void;
+export declare function trackPurchase(payload: {
+    transaction_id: string;
+    currency: string;
+    value: number;
+    tax?: number;
+    shipping?: number;
+    items: GA4Item[];
+}): void;
+export declare function trackAddToWishlist(params: {
+    content_ids: string[];
+    currency?: string;
+    value?: number;
+}): void;
+export declare function trackCompleteRegistration(params?: {
+    status?: string;
+    method?: string;
+}): void;
+export declare function trackContact(params?: {
+    form_type?: string;
+}): void;
+export declare function trackLead(params?: {
+    form_type?: string;
+}): void;
+export declare function trackSearch(searchString: string): void;
+export declare function trackHeroCtaClick(params: {
+    label?: string;
+    link?: string;
+}): void;
+export declare function trackCartNavClick(cart: CartLike | null): void;

package/dist/events/forms.d.ts

@@ -0,0 +1,11 @@
+import { FormSubmittedPayload, StorefrontAnalyticsAdapter } from '../core/types';
+
+export declare function emitFormSubmitted(analytics: StorefrontAnalyticsAdapter | undefined, payload: FormSubmittedPayload): void;
+export declare function emitContactFormSubmitted(analytics: StorefrontAnalyticsAdapter | undefined, params?: {
+    formType?: string;
+    [key: string]: unknown;
+}): void;
+export declare function emitLeadCaptured(analytics: StorefrontAnalyticsAdapter | undefined, params?: {
+    formType?: string;
+    [key: string]: unknown;
+}): void;

package/dist/events/meta-events.d.ts

@@ -0,0 +1,27 @@
+/** Meta Pixel standard event names (fbq second argument) */
+export declare const META_STANDARD_EVENTS: {
+    readonly AddPaymentInfo: "AddPaymentInfo";
+    readonly AddToCart: "AddToCart";
+    readonly AddToWishlist: "AddToWishlist";
+    readonly CompleteRegistration: "CompleteRegistration";
+    readonly Contact: "Contact";
+    readonly InitiateCheckout: "InitiateCheckout";
+    readonly Lead: "Lead";
+    readonly Purchase: "Purchase";
+    readonly Search: "Search";
+    readonly ViewContent: "ViewContent";
+};
+export type MetaStandardEventName = (typeof META_STANDARD_EVENTS)[keyof typeof META_STANDARD_EVENTS];
+export type GA4Item = {
+    item_id: string;
+    item_name: string;
+    price?: number;
+    quantity?: number;
+    index?: number;
+    item_variant?: string;
+};
+export type EcommercePayload = {
+    currency: string;
+    value: number;
+    items: GA4Item[];
+};

package/dist/events/reviews.d.ts

@@ -0,0 +1,8 @@
+import { ReviewSubmittedPayload, StorefrontAnalyticsAdapter } from '../core/types';
+
+/**
+ * Domain helper: call after a review is successfully saved.
+ */
+export declare function emitReviewSubmitted(analytics: StorefrontAnalyticsAdapter | undefined, payload: Omit<ReviewSubmittedPayload, "isUpdate"> & {
+    isUpdate?: boolean;
+}): void;

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+export type { AnalyticsEventMap, FormSubmittedPayload, ProductRef, ReviewSubmittedPayload, StorefrontAnalyticsAdapter, } from './core/types';
+export { noopAnalyticsAdapter } from './core/noop-adapter';
+export { composeAnalyticsAdapters } from './core/compose';
+export { createGtmAnalyticsAdapter, defaultStorefrontAnalytics, pushToDataLayer, trackGtmEvent, trackEvent, initGTM, type GtmAnalyticsAdapterOptions, } from './providers/gtm';
+export { emitReviewSubmitted } from './events/reviews';
+export { emitContactFormSubmitted, emitFormSubmitted, emitLeadCaptured, } from './events/forms';
+export { META_STANDARD_EVENTS, type EcommercePayload, type GA4Item, type MetaStandardEventName, } from './events/meta-events';
+export { META_PIXEL_DATALAYER_EVENT, fireMetaPixelEvent, fireMetaEcommerceEvent, fireMetaPurchase, } from './providers/meta-pixel';
+export { META_EXPLICIT_KEY, disableMetaPixelAutoConfig, installMetaPixelGuard, } from './providers/meta-pixel-guard';
+export { cartToEcommercePayload, markInitiateCheckoutFired, trackAddPaymentInfo, trackAddShippingInfo, trackAddToCart, trackAddToWishlist, trackBeginCheckout, trackCartNavClick, trackCompleteRegistration, trackContact, trackHeroCtaClick, trackInitiateCheckoutFromCart, trackLead, trackMetaStandardEvent, trackPurchase, trackRemoveFromCart, trackSearch, trackViewCart, trackViewItem, trackViewItemList, wasInitiateCheckoutFired, } from './ecommerce/ga4-ecommerce';

package/dist/providers/gtm.d.ts

@@ -0,0 +1,23 @@
+import { StorefrontAnalyticsAdapter } from '../core/types';
+
+declare global {
+    interface Window {
+        dataLayer?: Record<string, unknown>[];
+    }
+}
+export declare function pushToDataLayer(data: Record<string, unknown>): void;
+export declare function trackGtmEvent(eventName: string, params?: Record<string, unknown>): void;
+export interface GtmAnalyticsAdapterOptions {
+    /** Also push legacy `form_submit` events (for existing GTM triggers) */
+    legacyFormSubmit?: boolean;
+}
+/**
+ * Default GTM / dataLayer adapter for Medusa storefronts.
+ */
+export declare function createGtmAnalyticsAdapter(options?: GtmAnalyticsAdapterOptions): StorefrontAnalyticsAdapter;
+/** Default GTM adapter (legacy form_submit + review events). */
+export declare const defaultStorefrontAnalytics: StorefrontAnalyticsAdapter;
+/** @deprecated Use createGtmAnalyticsAdapter */
+export declare const initGTM: (id: string) => void;
+/** @deprecated Use trackGtmEvent */
+export declare const trackEvent: typeof trackGtmEvent;

package/dist/providers/meta-pixel-guard.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Blocks Meta automatic mis-classification (e.g. Subscribe on non-newsletter clicks).
+ * Only events fired via fireMetaPixelEvent() include __cm_explicit and pass through.
+ */
+export declare const META_EXPLICIT_KEY = "__cm_explicit";
+/** Disable Meta pixel automatic event configuration (button scraping, etc.) */
+export declare function disableMetaPixelAutoConfig(): boolean;
+/** Call once on app load; retries until GTM/pixel has initialized fbq */
+export declare function installMetaPixelGuard(): void;

package/dist/providers/meta-pixel.d.ts

@@ -0,0 +1,9 @@
+import { META_STANDARD_EVENTS, EcommercePayload, MetaStandardEventName } from '../events/meta-events';
+
+export { META_STANDARD_EVENTS, type MetaStandardEventName, type EcommercePayload };
+export declare const META_PIXEL_DATALAYER_EVENT = "meta_pixel_track";
+export declare function fireMetaPixelEvent(metaEvent: MetaStandardEventName, params?: Record<string, unknown>): void;
+export declare function fireMetaEcommerceEvent(metaEvent: MetaStandardEventName, payload: EcommercePayload, extra?: Record<string, unknown>): void;
+export declare function fireMetaPurchase(payload: EcommercePayload & {
+    transaction_id: string;
+}): void;

package/dist/ui-library.js

@@ -0,0 +1,420 @@
+const D = {
+  trackReviewSubmitted: () => {
+  },
+  trackReviewUpdated: () => {
+  },
+  trackFormSubmitted: () => {
+  },
+  trackEvent: () => {
+  }
+};
+function V(t) {
+  const e = t.filter(Boolean);
+  return {
+    trackReviewSubmitted(n) {
+      e.forEach((i) => i.trackReviewSubmitted(n));
+    },
+    trackReviewUpdated(n) {
+      e.forEach((i) => {
+        var r;
+        return (r = i.trackReviewUpdated) == null ? void 0 : r.call(i, n);
+      });
+    },
+    trackFormSubmitted(n) {
+      e.forEach((i) => {
+        var r;
+        return (r = i.trackFormSubmitted) == null ? void 0 : r.call(i, n);
+      });
+    },
+    trackEvent(n, i) {
+      e.forEach((r) => {
+        var u;
+        return (u = r.trackEvent) == null ? void 0 : u.call(r, n, i);
+      });
+    }
+  };
+}
+function p(t) {
+  typeof window > "u" || (window.dataLayer = window.dataLayer || [], window.dataLayer.push(t));
+}
+function f(t, e) {
+  p({
+    event: t,
+    ...e
+  });
+}
+function C(t = {}) {
+  const { legacyFormSubmit: e = !0 } = t, n = (i, r) => {
+    f(r, {
+      product_id: i.productId,
+      product_name: i.productName,
+      rating: i.rating,
+      review_title: i.reviewTitle,
+      is_update: i.isUpdate
+    }), e && f("form_submit", {
+      form_type: r === "review_updated" ? "product_review_update" : "product_review_submit",
+      product_id: i.productId,
+      product_name: i.productName,
+      rating: i.rating
+    });
+  };
+  return {
+    trackReviewSubmitted(i) {
+      n({ ...i, isUpdate: !1 }, "review_submitted");
+    },
+    trackReviewUpdated(i) {
+      n({ ...i, isUpdate: !0 }, "review_updated");
+    },
+    trackFormSubmitted(i) {
+      f("form_submit", i);
+    },
+    trackEvent: f
+  };
+}
+const $ = C({
+  legacyFormSubmit: !0
+}), j = (t) => {
+  if (typeof window > "u") return;
+  p({
+    "gtm.start": (/* @__PURE__ */ new Date()).getTime(),
+    event: "gtm.js"
+  });
+  const e = document.getElementsByTagName("script")[0], n = document.createElement("script");
+  n.async = !0, n.src = `https://www.googletagmanager.com/gtm.js?id=${t}`, e != null && e.parentNode && e.parentNode.insertBefore(n, e);
+}, B = f;
+function G(t, e) {
+  if (!t) return;
+  const n = {
+    productId: e.productId,
+    productName: e.productName,
+    rating: e.rating,
+    reviewTitle: e.reviewTitle,
+    isUpdate: e.isUpdate ?? !1
+  };
+  n.isUpdate && t.trackReviewUpdated ? t.trackReviewUpdated(n) : t.trackReviewSubmitted(n);
+}
+function k(t, e) {
+  var n, i;
+  (n = t == null ? void 0 : t.trackFormSubmitted) == null || n.call(t, e), (i = t == null ? void 0 : t.trackEvent) == null || i.call(t, "form_submit", e);
+}
+function W(t, e) {
+  k(t, {
+    form_type: (e == null ? void 0 : e.formType) ?? "contact_us_form",
+    ...e
+  });
+}
+function K(t, e) {
+  var n;
+  t && ((n = t.trackEvent) == null || n.call(t, "Lead", {
+    form_type: (e == null ? void 0 : e.formType) ?? "newsletter_signup",
+    ...e
+  }), k(t, {
+    form_type: (e == null ? void 0 : e.formType) ?? "lead",
+    ...e
+  }));
+}
+const o = {
+  AddPaymentInfo: "AddPaymentInfo",
+  AddToCart: "AddToCart",
+  AddToWishlist: "AddToWishlist",
+  CompleteRegistration: "CompleteRegistration",
+  Contact: "Contact",
+  InitiateCheckout: "InitiateCheckout",
+  Lead: "Lead",
+  Purchase: "Purchase",
+  Search: "Search",
+  ViewContent: "ViewContent"
+}, s = "__cm_explicit";
+function E() {
+  if (typeof window > "u") return !1;
+  const t = window.fbq;
+  if (typeof t != "function") return !1;
+  try {
+    t("set", "autoConfig", !1);
+  } catch {
+  }
+  return !0;
+}
+function T(t, e) {
+  if (typeof t != "string") return !1;
+  if (t === "Subscribe") {
+    const n = e;
+    return !(n != null && n[s]);
+  }
+  return !1;
+}
+function A() {
+  if (typeof window > "u") return !1;
+  const t = window, e = t.fbq;
+  if (typeof e != "function" || t.__cmFbqPatched) return !0;
+  const n = e, i = function(...r) {
+    if (!(r[0] === "track" && T(r[1], r[2])))
+      return n.apply(this, r);
+  };
+  return Object.assign(i, n), t.fbq = i, t._fbq && (t._fbq = i), t.__cmFbqPatched = !0, !0;
+}
+function w() {
+  if (typeof window > "u") return !1;
+  const t = window;
+  if (!t.dataLayer || t.__cmDataLayerPatched) return !0;
+  const e = t.dataLayer.push.bind(t.dataLayer);
+  return t.dataLayer.push = function(...n) {
+    const i = n.filter((r) => {
+      if (!r || typeof r != "object") return !0;
+      const u = r;
+      return !(u.meta_event === "Subscribe" && !u[s] || u.event === "subscribe" && !u[s]);
+    });
+    return e(...i);
+  }, t.__cmDataLayerPatched = !0, !0;
+}
+function O() {
+  if (typeof window > "u") return;
+  w();
+  let t = 0;
+  const e = 60, n = () => {
+    w();
+    const i = A();
+    i && E(), !i && ++t < e && setTimeout(n, 250);
+  };
+  n();
+}
+const S = "meta_pixel_track";
+function I(t) {
+  return (t ?? "INR").toUpperCase();
+}
+function L(t) {
+  const e = t.items ?? [], n = e.reduce((i, r) => i + (r.quantity ?? 1), 0);
+  return {
+    currency: I(t.currency),
+    value: t.value,
+    content_ids: e.map((i) => String(i.item_id)),
+    content_type: "product",
+    contents: e.map((i) => ({
+      id: String(i.item_id),
+      quantity: i.quantity ?? 1,
+      item_price: i.price ?? 0
+    })),
+    num_items: n
+  };
+}
+function R(t, e) {
+  if (typeof window > "u") return;
+  const n = window;
+  n.dataLayer = n.dataLayer || [], n.dataLayer.push({
+    event: S,
+    meta_event: t,
+    [s]: !0,
+    ...e
+  });
+}
+function h(t, e = {}) {
+  if (R(t, e), typeof window > "u") return;
+  const n = window.fbq;
+  typeof n == "function" && n("track", t, { ...e, [s]: !0 });
+}
+function _(t, e, n) {
+  h(t, { ...L(e), ...n });
+}
+function q(t) {
+  const { transaction_id: e, ...n } = t;
+  _(o.Purchase, n, {
+    order_id: e
+  });
+}
+const P = {
+  add_to_cart: o.AddToCart,
+  view_item: o.ViewContent,
+  view_cart: o.ViewContent,
+  begin_checkout: o.InitiateCheckout,
+  add_payment_info: o.AddPaymentInfo,
+  purchase: o.Purchase
+};
+function v(t) {
+  if (typeof window > "u") return;
+  const e = window;
+  e.dataLayer = e.dataLayer || [], e.dataLayer.push({ ecommerce: null }), e.dataLayer.push(t);
+}
+function m(t) {
+  return (t ?? "INR").toUpperCase();
+}
+function b(t) {
+  const e = t.items ?? [], n = e.reduce((i, r) => i + (r.quantity ?? 1), 0);
+  return {
+    currency: m(t.currency),
+    value: t.value,
+    content_ids: e.map((i) => String(i.item_id)),
+    content_type: "product",
+    contents: e.map((i) => ({
+      id: String(i.item_id),
+      quantity: i.quantity ?? 1,
+      item_price: i.price ?? 0
+    })),
+    num_items: n
+  };
+}
+function d(t, e, n) {
+  const i = m(e.currency), r = { ...e, currency: i }, u = b({ ...e, currency: i });
+  v({
+    event: t,
+    ecommerce: r,
+    ...u,
+    ...n
+  });
+  const c = P[t];
+  c && (t === "purchase" && (n != null && n.transaction_id) ? q({
+    ...e,
+    currency: i,
+    transaction_id: String(n.transaction_id)
+  }) : _(c, { ...e, currency: i }, n));
+}
+function a(t, e) {
+  h(t, e ?? {});
+}
+function F(t) {
+  var r, u;
+  if (!((r = t == null ? void 0 : t.items) != null && r.length)) return null;
+  const e = m(t.currency_code ?? ((u = t.region) == null ? void 0 : u.currency_code)), n = (t.total ?? 0) / 100, i = t.items.map((c, y) => {
+    const g = c.total && c.quantity ? c.total / c.quantity : 0;
+    return {
+      item_id: c.variant_id ?? c.id,
+      item_name: c.title ?? c.product_title ?? "",
+      price: g / 100,
+      quantity: c.quantity,
+      index: y
+    };
+  });
+  return { currency: e, value: n, items: i };
+}
+function X(t) {
+  d("add_to_cart", t);
+}
+function Y(t) {
+  d("remove_from_cart", t);
+}
+function N(t) {
+  d("view_cart", t);
+}
+function z(t) {
+  d("view_item", t);
+}
+function H(t) {
+  const e = b({
+    currency: "INR",
+    value: 0,
+    items: t.items
+  });
+  v({
+    event: "view_item_list",
+    ecommerce: t,
+    ...e
+  }), _(o.ViewContent, {
+    currency: "INR",
+    value: 0,
+    items: t.items
+  });
+}
+const l = "meta_initiate_checkout_";
+function M(t) {
+  typeof window > "u" || sessionStorage.setItem(`${l}${t}`, String(Date.now()));
+}
+function x(t, e = 6e4) {
+  if (typeof window > "u") return !1;
+  const n = sessionStorage.getItem(`${l}${t}`);
+  return n ? Date.now() - Number(n) < e : !1;
+}
+function J(t, e) {
+  U(t), e && M(e);
+}
+function U(t) {
+  d("begin_checkout", t);
+}
+function Q(t) {
+  d("add_shipping_info", t);
+}
+function Z(t, e) {
+  d("add_payment_info", t, e);
+}
+function tt(t) {
+  const { transaction_id: e, ...n } = t;
+  d("purchase", n, {
+    transaction_id: e,
+    order_id: e
+  });
+}
+function et(t) {
+  a(o.AddToWishlist, {
+    content_ids: t.content_ids,
+    content_type: "product",
+    currency: m(t.currency),
+    value: t.value ?? 0
+  });
+}
+function nt(t) {
+  a(o.CompleteRegistration, t);
+}
+function it(t) {
+  a(o.Contact, t);
+}
+function rt(t) {
+  a(o.Lead, t);
+}
+function ot(t) {
+  a(o.Search, {
+    search_string: t
+  });
+}
+function ct(t) {
+  a(o.ViewContent, {
+    content_type: "cta",
+    content_name: t.label || "shop_now",
+    content_category: "hero_banner",
+    ...t.link ? { content_url: t.link } : {}
+  });
+}
+function ut(t) {
+  const e = F(t);
+  e && N(e);
+}
+export {
+  s as META_EXPLICIT_KEY,
+  S as META_PIXEL_DATALAYER_EVENT,
+  o as META_STANDARD_EVENTS,
+  F as cartToEcommercePayload,
+  V as composeAnalyticsAdapters,
+  C as createGtmAnalyticsAdapter,
+  $ as defaultStorefrontAnalytics,
+  E as disableMetaPixelAutoConfig,
+  W as emitContactFormSubmitted,
+  k as emitFormSubmitted,
+  K as emitLeadCaptured,
+  G as emitReviewSubmitted,
+  _ as fireMetaEcommerceEvent,
+  h as fireMetaPixelEvent,
+  q as fireMetaPurchase,
+  j as initGTM,
+  O as installMetaPixelGuard,
+  M as markInitiateCheckoutFired,
+  D as noopAnalyticsAdapter,
+  p as pushToDataLayer,
+  Z as trackAddPaymentInfo,
+  Q as trackAddShippingInfo,
+  X as trackAddToCart,
+  et as trackAddToWishlist,
+  U as trackBeginCheckout,
+  ut as trackCartNavClick,
+  nt as trackCompleteRegistration,
+  it as trackContact,
+  B as trackEvent,
+  f as trackGtmEvent,
+  ct as trackHeroCtaClick,
+  J as trackInitiateCheckoutFromCart,
+  rt as trackLead,
+  a as trackMetaStandardEvent,
+  tt as trackPurchase,
+  Y as trackRemoveFromCart,
+  ot as trackSearch,
+  N as trackViewCart,
+  z as trackViewItem,
+  H as trackViewItemList,
+  x as wasInitiateCheckoutFired
+};

package/dist/ui-library.umd.cjs

@@ -0,0 +1 @@
+(function(r,_){typeof exports=="object"&&typeof module<"u"?_(exports):typeof define=="function"&&define.amd?define(["exports"],_):(r=typeof globalThis<"u"?globalThis:r||self,_(r.MedusaStorefrontAnalytics={}))})(this,function(r){"use strict";const _={trackReviewSubmitted:()=>{},trackReviewUpdated:()=>{},trackFormSubmitted:()=>{},trackEvent:()=>{}};function R(t){const e=t.filter(Boolean);return{trackReviewSubmitted(n){e.forEach(i=>i.trackReviewSubmitted(n))},trackReviewUpdated(n){e.forEach(i=>{var c;return(c=i.trackReviewUpdated)==null?void 0:c.call(i,n)})},trackFormSubmitted(n){e.forEach(i=>{var c;return(c=i.trackFormSubmitted)==null?void 0:c.call(i,n)})},trackEvent(n,i){e.forEach(c=>{var a;return(a=c.trackEvent)==null?void 0:a.call(c,n,i)})}}}function h(t){typeof window>"u"||(window.dataLayer=window.dataLayer||[],window.dataLayer.push(t))}function m(t,e){h({event:t,...e})}function C(t={}){const{legacyFormSubmit:e=!0}=t,n=(i,c)=>{m(c,{product_id:i.productId,product_name:i.productName,rating:i.rating,review_title:i.reviewTitle,is_update:i.isUpdate}),e&&m("form_submit",{form_type:c==="review_updated"?"product_review_update":"product_review_submit",product_id:i.productId,product_name:i.productName,rating:i.rating})};return{trackReviewSubmitted(i){n({...i,isUpdate:!1},"review_submitted")},trackReviewUpdated(i){n({...i,isUpdate:!0},"review_updated")},trackFormSubmitted(i){m("form_submit",i)},trackEvent:m}}const M=C({legacyFormSubmit:!0}),F=t=>{if(typeof window>"u")return;h({"gtm.start":new Date().getTime(),event:"gtm.js"});const e=document.getElementsByTagName("script")[0],n=document.createElement("script");n.async=!0,n.src=`https://www.googletagmanager.com/gtm.js?id=${t}`,e!=null&&e.parentNode&&e.parentNode.insertBefore(n,e)},q=m;function N(t,e){if(!t)return;const n={productId:e.productId,productName:e.productName,rating:e.rating,reviewTitle:e.reviewTitle,isUpdate:e.isUpdate??!1};n.isUpdate&&t.trackReviewUpdated?t.trackReviewUpdated(n):t.trackReviewSubmitted(n)}function l(t,e){var n,i;(n=t==null?void 0:t.trackFormSubmitted)==null||n.call(t,e),(i=t==null?void 0:t.trackEvent)==null||i.call(t,"form_submit",e)}function V(t,e){l(t,{form_type:(e==null?void 0:e.formType)??"contact_us_form",...e})}function D(t,e){var n;t&&((n=t.trackEvent)==null||n.call(t,"Lead",{form_type:(e==null?void 0:e.formType)??"newsletter_signup",...e}),l(t,{form_type:(e==null?void 0:e.formType)??"lead",...e}))}const o={AddPaymentInfo:"AddPaymentInfo",AddToCart:"AddToCart",AddToWishlist:"AddToWishlist",CompleteRegistration:"CompleteRegistration",Contact:"Contact",InitiateCheckout:"InitiateCheckout",Lead:"Lead",Purchase:"Purchase",Search:"Search",ViewContent:"ViewContent"},s="__cm_explicit";function E(){if(typeof window>"u")return!1;const t=window.fbq;if(typeof t!="function")return!1;try{t("set","autoConfig",!1)}catch{}return!0}function U(t,e){if(typeof t!="string")return!1;if(t==="Subscribe"){const n=e;return!(n!=null&&n[s])}return!1}function G(){if(typeof window>"u")return!1;const t=window,e=t.fbq;if(typeof e!="function"||t.__cmFbqPatched)return!0;const n=e,i=function(...c){if(!(c[0]==="track"&&U(c[1],c[2])))return n.apply(this,c)};return Object.assign(i,n),t.fbq=i,t._fbq&&(t._fbq=i),t.__cmFbqPatched=!0,!0}function b(){if(typeof window>"u")return!1;const t=window;if(!t.dataLayer||t.__cmDataLayerPatched)return!0;const e=t.dataLayer.push.bind(t.dataLayer);return t.dataLayer.push=function(...n){const i=n.filter(c=>{if(!c||typeof c!="object")return!0;const a=c;return!(a.meta_event==="Subscribe"&&!a[s]||a.event==="subscribe"&&!a[s])});return e(...i)},t.__cmDataLayerPatched=!0,!0}function j(){if(typeof window>"u")return;b();let t=0;const e=60,n=()=>{b();const i=G();i&&E(),!i&&++t<e&&setTimeout(n,250)};n()}const y="meta_pixel_track";function $(t){return(t??"INR").toUpperCase()}function B(t){const e=t.items??[],n=e.reduce((i,c)=>i+(c.quantity??1),0);return{currency:$(t.currency),value:t.value,content_ids:e.map(i=>String(i.item_id)),content_type:"product",contents:e.map(i=>({id:String(i.item_id),quantity:i.quantity??1,item_price:i.price??0})),num_items:n}}function W(t,e){if(typeof window>"u")return;const n=window;n.dataLayer=n.dataLayer||[],n.dataLayer.push({event:y,meta_event:t,[s]:!0,...e})}function v(t,e={}){if(W(t,e),typeof window>"u")return;const n=window.fbq;typeof n=="function"&&n("track",t,{...e,[s]:!0})}function w(t,e,n){v(t,{...B(e),...n})}function p(t){const{transaction_id:e,...n}=t;w(o.Purchase,n,{order_id:e})}const X={add_to_cart:o.AddToCart,view_item:o.ViewContent,view_cart:o.ViewContent,begin_checkout:o.InitiateCheckout,add_payment_info:o.AddPaymentInfo,purchase:o.Purchase};function A(t){if(typeof window>"u")return;const e=window;e.dataLayer=e.dataLayer||[],e.dataLayer.push({ecommerce:null}),e.dataLayer.push(t)}function k(t){return(t??"INR").toUpperCase()}function T(t){const e=t.items??[],n=e.reduce((i,c)=>i+(c.quantity??1),0);return{currency:k(t.currency),value:t.value,content_ids:e.map(i=>String(i.item_id)),content_type:"product",contents:e.map(i=>({id:String(i.item_id),quantity:i.quantity??1,item_price:i.price??0})),num_items:n}}function d(t,e,n){const i=k(e.currency),c={...e,currency:i},a=T({...e,currency:i});A({event:t,ecommerce:c,...a,...n});const u=X[t];u&&(t==="purchase"&&(n!=null&&n.transaction_id)?p({...e,currency:i,transaction_id:String(n.transaction_id)}):w(u,{...e,currency:i},n))}function f(t,e){v(t,e??{})}function g(t){var c,a;if(!((c=t==null?void 0:t.items)!=null&&c.length))return null;const e=k(t.currency_code??((a=t.region)==null?void 0:a.currency_code)),n=(t.total??0)/100,i=t.items.map((u,ut)=>{const at=u.total&&u.quantity?u.total/u.quantity:0;return{item_id:u.variant_id??u.id,item_name:u.title??u.product_title??"",price:at/100,quantity:u.quantity,index:ut}});return{currency:e,value:n,items:i}}function Y(t){d("add_to_cart",t)}function K(t){d("remove_from_cart",t)}function S(t){d("view_cart",t)}function O(t){d("view_item",t)}function H(t){const e=T({currency:"INR",value:0,items:t.items});A({event:"view_item_list",ecommerce:t,...e}),w(o.ViewContent,{currency:"INR",value:0,items:t.items})}const I="meta_initiate_checkout_";function L(t){typeof window>"u"||sessionStorage.setItem(`${I}${t}`,String(Date.now()))}function z(t,e=6e4){if(typeof window>"u")return!1;const n=sessionStorage.getItem(`${I}${t}`);return n?Date.now()-Number(n)<e:!1}function J(t,e){P(t),e&&L(e)}function P(t){d("begin_checkout",t)}function Q(t){d("add_shipping_info",t)}function Z(t,e){d("add_payment_info",t,e)}function x(t){const{transaction_id:e,...n}=t;d("purchase",n,{transaction_id:e,order_id:e})}function tt(t){f(o.AddToWishlist,{content_ids:t.content_ids,content_type:"product",currency:k(t.currency),value:t.value??0})}function et(t){f(o.CompleteRegistration,t)}function nt(t){f(o.Contact,t)}function it(t){f(o.Lead,t)}function rt(t){f(o.Search,{search_string:t})}function ct(t){f(o.ViewContent,{content_type:"cta",content_name:t.label||"shop_now",content_category:"hero_banner",...t.link?{content_url:t.link}:{}})}function ot(t){const e=g(t);e&&S(e)}r.META_EXPLICIT_KEY=s,r.META_PIXEL_DATALAYER_EVENT=y,r.META_STANDARD_EVENTS=o,r.cartToEcommercePayload=g,r.composeAnalyticsAdapters=R,r.createGtmAnalyticsAdapter=C,r.defaultStorefrontAnalytics=M,r.disableMetaPixelAutoConfig=E,r.emitContactFormSubmitted=V,r.emitFormSubmitted=l,r.emitLeadCaptured=D,r.emitReviewSubmitted=N,r.fireMetaEcommerceEvent=w,r.fireMetaPixelEvent=v,r.fireMetaPurchase=p,r.initGTM=F,r.installMetaPixelGuard=j,r.markInitiateCheckoutFired=L,r.noopAnalyticsAdapter=_,r.pushToDataLayer=h,r.trackAddPaymentInfo=Z,r.trackAddShippingInfo=Q,r.trackAddToCart=Y,r.trackAddToWishlist=tt,r.trackBeginCheckout=P,r.trackCartNavClick=ot,r.trackCompleteRegistration=et,r.trackContact=nt,r.trackEvent=q,r.trackGtmEvent=m,r.trackHeroCtaClick=ct,r.trackInitiateCheckoutFromCart=J,r.trackLead=it,r.trackMetaStandardEvent=f,r.trackPurchase=x,r.trackRemoveFromCart=K,r.trackSearch=rt,r.trackViewCart=S,r.trackViewItem=O,r.trackViewItemList=H,r.wasInitiateCheckoutFired=z,Object.defineProperty(r,Symbol.toStringTag,{value:"Module"})});

package/package.json

@@ -0,0 +1,44 @@
+{
+    "name": "medusa-storefront-analytics",
+    "version": "1.2.0",
+    "description": "Layered storefront analytics (GTM dataLayer) with reusable domain events for reviews, forms, and more.",
+    "author": "SmartByte Labs",
+    "license": "MIT",
+    "keywords": ["medusa", "storefront", "analytics", "gtm", "dataLayer", "reviews"],
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/SmartByteLabs/medusa-ui-components.git",
+        "directory": "medusa-storefront-analytics"
+    },
+    "publishConfig": {
+        "access": "public"
+    },
+    "type": "module",
+    "sideEffects": ["dist/**/*.js"],
+    "main": "./dist/ui-library.umd.cjs",
+    "module": "./dist/ui-library.js",
+    "types": "./dist/index.d.ts",
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "import": "./dist/ui-library.js",
+            "require": "./dist/ui-library.umd.cjs",
+            "default": "./dist/ui-library.js"
+        },
+        "./gtm": {
+            "types": "./dist/providers/gtm.d.ts",
+            "import": "./dist/ui-library.js",
+            "default": "./dist/ui-library.js"
+        }
+    },
+    "files": ["dist"],
+    "scripts": {
+        "build": "tsc && vite build",
+        "dev": "vite build --watch"
+    },
+    "devDependencies": {
+        "typescript": "^5.0.0",
+        "vite": "^5.0.0",
+        "vite-plugin-dts": "^3.0.0"
+    }
+}