@ecomiq/storefront 2.1.3 → 3.0.0

package/dist/account.d.ts

@@ -0,0 +1,240 @@
+import { OrderRequestIntent } from "./form-contracts.js";
+import { RouterContextProvider } from "react-router";
+import { CustomerAddressUpsertInput, CustomerOrderList, CustomerOrderStatusFilter } from "@ecomiq/core";
+export type AddressActionData = {
+  error: string | null;
+};
+export type ProfileActionData = {
+  saved: boolean;
+  error: string | null;
+};
+export type OrderRequestActionData = {
+  sent: OrderRequestIntent | null;
+  error: string | null;
+};
+export declare function readCustomerAddress(form: FormData, countryCode: string): CustomerAddressUpsertInput;
+export declare function loadAccount(request: Request, context: Readonly<RouterContextProvider>): Promise<{
+  name: string;
+}>;
+export type OrderFilters = {
+  q: string;
+  status: CustomerOrderStatusFilter | null;
+  sort: "newest" | "oldest";
+  view: "list" | "grid";
+};
+export type OrdersData = {
+  orders: CustomerOrderList;
+  next: string | null;
+  filters: OrderFilters;
+};
+export declare function readOrderFilters(url: URL): OrderFilters;
+/** The query string of the orders list for these filters, without the default values. */
+export declare function orderFiltersQuery(filters: OrderFilters): URLSearchParams;
+export declare function loadOrders(request: Request, context: Readonly<RouterContextProvider>): Promise<OrdersData>;
+export declare function loadOrder(request: Request, context: Readonly<RouterContextProvider>, id: string): Promise<{
+  order: {
+    id: string;
+    orderNumber: string;
+    orderGroup: string | null;
+    status: string;
+    step?: "cancelled" | "confirmed" | "delivered" | "outForDelivery" | "pending" | "shipped" | undefined;
+    total: number;
+    totalPaid: number;
+    currencyCode: string;
+    orderDate: string;
+    createdOn: string;
+    updatedOn: string | null;
+    paymentAt: string | null;
+    subTotal: number;
+    discount: number;
+    shipping: number;
+    tax: number;
+    email: string | null;
+    phone: string | null;
+    identificationType?: string | null | undefined;
+    identificationNumber?: string | null | undefined;
+    identificationCountryCode?: string | null | undefined;
+    firstName: string | null;
+    lastName: string | null;
+    shippingAddress: {
+      name: string | null;
+      company: string | null;
+      address1: string;
+      address2: string | null;
+      city: string;
+      countryCode: string;
+      province: string | null;
+      postalCode: string | null;
+      district: string | null;
+      phone: string | null;
+      latitude: number | null;
+      longitude: number | null;
+      metadata: Record<string, unknown>;
+    };
+    shippingAddressSummary: string | null;
+    billingAddress: {
+      name: string | null;
+      company: string | null;
+      address1: string;
+      address2: string | null;
+      city: string;
+      countryCode: string;
+      province: string | null;
+      postalCode: string | null;
+      district: string | null;
+      phone: string | null;
+      latitude: number | null;
+      longitude: number | null;
+      metadata: Record<string, unknown>;
+    };
+    items: {
+      id: string;
+      orderId: string;
+      productId: string | null;
+      variantId: string | null;
+      title: string;
+      subtitle: string | null;
+      thumbnail: string | null;
+      variantTitle: string | null;
+      productHandle: string | null;
+      productUrl: string | null;
+      quantity: number;
+      unitPrice: number;
+      total: number;
+      status: string;
+      step?: "cancelled" | "confirmed" | "delivered" | "outForDelivery" | "pending" | "shipped" | undefined;
+      carrierName?: string | null | undefined;
+      trackingNumber?: string | null | undefined;
+      trackingLink?: string | null | undefined;
+      shippedAt?: string | null | undefined;
+      deliveredAt?: string | null | undefined;
+      returnableQuantity: number;
+    }[];
+    payments: {
+      id: string;
+      paymentMethod: string;
+      paymentCode: string;
+      cardBrand?: string | null | undefined;
+      cardLast4?: string | null | undefined;
+      installments?: number | null | undefined;
+      amount: number;
+      paymentStatus: string | null;
+      receiptUrl: string | null;
+      createdOn: string;
+    }[];
+    statusTimeline: {
+      key: string;
+      label: string;
+      occurredAt: string;
+      description: string | null;
+      status: string | null;
+      source: string;
+    }[];
+    shipments: {
+      carrierName: string | null;
+      trackingNumber: string | null;
+      trackingLink: string | null;
+    }[];
+    paymentPath?: string | null | undefined;
+    returnStatus?: string | null | undefined;
+    returnDeadline?: string | null | undefined;
+    canRequestReturn: boolean;
+    cancellationRequestedAt?: string | null | undefined;
+    canRequestCancellation: boolean;
+  };
+}>;
+/** Return or cancellation request the customer sends from an order of their account. */
+export declare function orderRequestAction(request: Request, context: Readonly<RouterContextProvider>, orderId: string): Promise<import("react-router").UNSAFE_DataWithResponseInit<OrderRequestActionData> | {
+  sent: "cancel";
+  error: null;
+} | {
+  sent: "return";
+  error: null;
+}>;
+export declare function loadAddresses(request: Request, context: Readonly<RouterContextProvider>): Promise<{
+  addresses: {
+    id: string;
+    addressKey: string;
+    department: string | null;
+    addressNumber: string | null;
+    province: string | null;
+    district: string | null;
+    phone: string | null;
+    cellPhone: string | null;
+    addressLine: string;
+    reference: string | null;
+    countryIsoCode: string;
+    postalCode: string | null;
+    latitude: number | null;
+    longitude: number | null;
+    hasCoordinates: boolean;
+    isDefault: boolean;
+  }[];
+  countries: {
+    code: string;
+    name: string;
+  }[];
+}>;
+export declare function addressAction(request: Request, context: Readonly<RouterContextProvider>): Promise<import("react-router").UNSAFE_DataWithResponseInit<AddressActionData> | {
+  error: null;
+}>;
+export declare function loadProfile(request: Request, context: Readonly<RouterContextProvider>): Promise<{
+  me: {
+    id: string;
+    storeId: string;
+    email: string | null;
+    firstName: string | null;
+    lastName: string | null;
+    phone: string | null;
+    identificationNumber: string | null;
+    identificationType: string | null;
+    identificationCountryCode?: string | null | undefined;
+    entityName: string | null;
+    dateOfBirth: string | null;
+    gender: string;
+    countryIsoCode: string | null;
+    role: string | null;
+    companyName: string | null;
+    consent: boolean;
+    userId: string | null;
+    customerType: string;
+    status: string;
+    isVerified: boolean;
+    entityIdentificationNumber: string | null;
+    defaultAddressId: string | null;
+    metadata: Record<string, unknown> | null;
+    totalOrders: number;
+    avgOrders: number;
+    lastOrderId: string | null;
+    lastOrderDate: string | null;
+    loyaltyPoints: number;
+    addresses: {
+      id: string;
+      addressKey: string;
+      department: string | null;
+      addressNumber: string | null;
+      province: string | null;
+      district: string | null;
+      phone: string | null;
+      cellPhone: string | null;
+      addressLine: string;
+      reference: string | null;
+      countryIsoCode: string;
+      postalCode: string | null;
+      latitude: number | null;
+      longitude: number | null;
+      hasCoordinates: boolean;
+      isDefault: boolean;
+    }[];
+    createdOn: string;
+    updatedOn: string | null;
+  };
+  countries: {
+    code: string;
+    name: string;
+  }[];
+}>;
+export declare function profileAction(request: Request, context: Readonly<RouterContextProvider>): Promise<import("react-router").UNSAFE_DataWithResponseInit<ProfileActionData> | {
+  saved: true;
+  error: null;
+}>;

package/dist/address-defaults-BqjRhS82.js

@@ -0,0 +1,14 @@
+// src/address-defaults.ts
+function addressDefaults(address) {
+	if (!address) return {};
+	return {
+		country: address.countryIsoCode,
+		department: address.department,
+		province: address.province,
+		district: address.district,
+		line: address.addressLine,
+		reference: address.reference,
+		phone: address.cellPhone ?? address.phone
+	};
+}
+export { addressDefaults };

package/dist/address-defaults.d.ts

@@ -0,0 +1,11 @@
+import { CustomerAddress } from "@ecomiq/core";
+export type AddressDefaults = {
+  country?: string | null;
+  department?: string | null;
+  province?: string | null;
+  district?: string | null;
+  line?: string | null;
+  reference?: string | null;
+  phone?: string | null;
+};
+export declare function addressDefaults(address: CustomerAddress | null | undefined): AddressDefaults;

package/dist/analytics/analytics-CG1Qagwl.js

@@ -0,0 +1,148 @@
+import { currentConsent } from "./consent-B13rBpBs.js";
+import { expiredPurchaseCookie, readPurchase } from "./cookies-pLozllyB.js";
+import { itemsValue } from "./events-Dt81tIp1.js";
+import { configureTracker, startTracker, track } from "./tracker-p4yaoOyk.js";
+import { useLocation, useMatches, useRouteLoaderData } from "react-router";
+import { useEffect, useRef } from "react";
+// src/analytics/analytics.tsx
+const ONCE_STORAGE = "ecomiq_analytics_once";
+const sentOnce = /* @__PURE__ */ new Set();
+const purchases = /* @__PURE__ */ new Set();
+function firstTime(key, remember) {
+	if (sentOnce.has(key)) return false;
+	sentOnce.add(key);
+	if (!remember) return true;
+	try {
+		const stored = (sessionStorage.getItem(ONCE_STORAGE) ?? "").split(" ").filter((value) => value !== "");
+		if (stored.includes(key)) return false;
+		sessionStorage.setItem(ONCE_STORAGE, [...stored.slice(-19), key].join(" "));
+	} catch {
+		return true;
+	}
+	return true;
+}
+function pageKey(location) {
+	const params = new URLSearchParams(location.search);
+	params.delete("variant");
+	return `${location.pathname}?${params}`;
+}
+function pageAnalytics(matches) {
+	return matches.flatMap((match) => {
+		if (match.id === "root") return [];
+		const analytics = match.loaderData?.analytics;
+		if (analytics === void 0 || analytics === null) return [];
+		return [analytics];
+	});
+}
+function trackPurchase(location, paid) {
+	const purchase = readPurchase(document.cookie);
+	if (purchase === null) return;
+	if (!(location.pathname === "/checkout/done" && new URLSearchParams(location.search).get("order") === purchase.orderId) && !paid.includes(purchase.orderId)) return;
+	document.cookie = expiredPurchaseCookie();
+	if (purchases.has(purchase.orderId)) return;
+	purchases.add(purchase.orderId);
+	const { orderId, currency, value, tax, shipping, items } = purchase;
+	track({
+		name: "purchase",
+		params: {
+			transaction_id: orderId,
+			currency,
+			value,
+			tax,
+			shipping,
+			items
+		}
+	});
+}
+function quantities(items) {
+	const lines = /* @__PURE__ */ new Map();
+	for (const item of items) {
+		const key = `${item.item_id}\u0000${item.item_variant ?? ""}`;
+		lines.set(key, {
+			...item,
+			quantity: (lines.get(key)?.quantity ?? 0) + (item.quantity ?? 1)
+		});
+	}
+	return lines;
+}
+function changed(from, to) {
+	const before = quantities(from);
+	const changes = [];
+	for (const [key, item] of quantities(to)) {
+		const quantity = item.quantity - (before.get(key)?.quantity ?? 0);
+		if (quantity > 0) changes.push({
+			...item,
+			quantity
+		});
+	}
+	return changes;
+}
+function cartEvents(previous, next) {
+	const events = [];
+	const added = changed(previous, next);
+	const removed = changed(next, previous);
+	if (added.length > 0) events.push({
+		name: "add_to_cart",
+		params: {
+			value: itemsValue(added),
+			items: added
+		}
+	});
+	if (removed.length > 0) events.push({
+		name: "remove_from_cart",
+		params: {
+			value: itemsValue(removed),
+			items: removed
+		}
+	});
+	return events;
+}
+function Analytics() {
+	const config = useRouteLoaderData("root")?.analytics ?? null;
+	const location = useLocation();
+	const matches = useMatches();
+	const enabled = config !== null;
+	const page = pageKey(location);
+	const pages = pageAnalytics(matches);
+	const paid = pages.flatMap((analytics) => analytics.paid === void 0 ? [] : [analytics.paid]).join(" ");
+	const cart = config?.cart ?? null;
+	const previousCart = useRef(void 0);
+	useEffect(() => {
+		if (config !== null) configureTracker(config);
+	}, [config]);
+	useEffect(() => {
+		if (enabled) return startTracker();
+	}, [enabled]);
+	useEffect(() => {
+		if (!enabled) return;
+		const consent = currentConsent();
+		if (consent !== null && !consent.analytics && !consent.marketing) return;
+		track({
+			name: "page_view",
+			params: {
+				page_location: new URL(`${location.pathname}${location.search}`, window.location.origin).href,
+				page_title: document.title
+			}
+		});
+		for (const analytics of pages) {
+			if (analytics.once !== void 0 && !firstTime(analytics.once, consent !== null)) continue;
+			for (const event of analytics.events) track(event);
+		}
+	}, [enabled, page]);
+	useEffect(() => {
+		if (enabled) trackPurchase(location, paid.split(" "));
+	}, [
+		enabled,
+		page,
+		paid
+	]);
+	useEffect(() => {
+		if (!enabled) return;
+		const previous = previousCart.current;
+		previousCart.current = cart;
+		if (previous === void 0 || cart === null) return;
+		for (const event of cartEvents(previous ?? [], cart)) track(event);
+	}, [enabled, cart]);
+	return null;
+}
+export { Analytics };

package/dist/analytics/analytics.d.ts

@@ -0,0 +1 @@
+export declare function Analytics(): null;

package/dist/analytics/config-DJr-GRhs.js

@@ -0,0 +1,62 @@
+import { worker } from "../worker-CNi-gzCu.js";
+import { readConsent } from "./cookies-pLozllyB.js";
+import { cartItem } from "./events-Dt81tIp1.js";
+// src/analytics/config.ts
+const PRIVACY_PAGE = "privacidad";
+const NOTICE_VERSION = 2;
+function filled(value) {
+	const trimmed = value?.trim() ?? "";
+	if (trimmed === "") return null;
+	return trimmed;
+}
+function customScripts(settings) {
+	const { enabled, head, bodyEnd } = settings.cms.settings.customScripts;
+	const scripts = {
+		head: filled(head),
+		bodyEnd: filled(bodyEnd)
+	};
+	if (!enabled || scripts.head === null && scripts.bodyEnd === null) return null;
+	return scripts;
+}
+function trackingTools(settings) {
+	const { tracking } = settings.cms.settings;
+	const tools = {
+		googleAnalytics: filled(tracking.googleAnalyticsMeasurementId),
+		googleTagManager: filled(tracking.googleTagManagerContainerId),
+		metaPixel: filled(tracking.metaPixelId),
+		scripts: customScripts(settings)
+	};
+	if (tools.googleAnalytics === null && tools.googleTagManager === null && tools.metaPixel === null && tools.scripts === null) return null;
+	return tools;
+}
+function privacyPage(settings) {
+	return settings.cms.pages.find((page) => page.slug === PRIVACY_PAGE);
+}
+function consentVersion(tools, settings) {
+	let used = "";
+	if (tools.googleAnalytics !== null) used += "g";
+	if (tools.googleTagManager !== null) used += "t";
+	if (tools.metaPixel !== null) used += "m";
+	if (tools.scripts !== null) used += "s";
+	return `${NOTICE_VERSION}.${used}.${privacyPage(settings)?.version ?? 0}`;
+}
+function readAnalytics(context, settings, cart) {
+	if (context.get(worker).env.ECOMIQ_PREVIEW === "1") return null;
+	const tools = trackingTools(settings);
+	if (tools === null) return null;
+	return {
+		...tools,
+		currency: settings.store.currency,
+		language: settings.store.language,
+		privacy: privacyPage(settings) === void 0 ? null : `/pages/${PRIVACY_PAGE}`,
+		consentVersion: consentVersion(tools, settings),
+		cart: cart === null ? null : cart.items.map(cartItem)
+	};
+}
+function trackingConsented(request, settings) {
+	const tools = trackingTools(settings);
+	const consent = readConsent(request.headers.get("Cookie"));
+	if (tools === null || consent === null || consent.version !== consentVersion(tools, settings)) return false;
+	return consent.analytics || consent.marketing;
+}
+export { readAnalytics, trackingConsented };

package/dist/analytics/config.d.ts

@@ -0,0 +1,22 @@
+import { AnalyticsItem } from "./events.js";
+import { RouterContextProvider } from "react-router";
+import { StorefrontCart, StorefrontSettings } from "@ecomiq/core";
+type AnalyticsScripts = {
+  head: string | null;
+  bodyEnd: string | null;
+};
+type TrackingTools = {
+  googleAnalytics: string | null;
+  googleTagManager: string | null;
+  metaPixel: string | null;
+  scripts: AnalyticsScripts | null;
+};
+export type AnalyticsConfig = TrackingTools & {
+  currency: string;
+  language: string;
+  privacy: string | null;
+  consentVersion: string;
+  cart: AnalyticsItem[] | null;
+};
+export declare function readAnalytics(context: Readonly<RouterContextProvider>, settings: StorefrontSettings, cart: StorefrontCart | null): AnalyticsConfig | null;
+export {};

package/dist/analytics/consent-B13rBpBs.js

@@ -0,0 +1,57 @@
+import { consentCookie, cookieDomains, readConsent, revokedCookies } from "./cookies-pLozllyB.js";
+// src/analytics/consent.ts
+const CONSENT_EVENT = "ecomiq:consent";
+const CONSENT_OPEN_EVENT = "ecomiq:consent-open";
+let terms = null;
+function consentPurposes(config) {
+	const generic = config.googleTagManager !== null || config.scripts !== null;
+	return {
+		analytics: config.googleAnalytics !== null || generic,
+		marketing: config.metaPixel !== null || generic
+	};
+}
+function currentConsent() {
+	const stored = readConsent(document.cookie);
+	if (terms === null || stored === null || stored.version !== terms.version) return null;
+	return stored;
+}
+function setConsent(choice) {
+	if (terms === null) return;
+	const consent = {
+		analytics: terms.analytics && choice.analytics === true,
+		marketing: terms.marketing && choice.marketing === true,
+		version: terms.version,
+		date: (/* @__PURE__ */ new Date()).toISOString()
+	};
+	document.cookie = consentCookie(consent);
+	for (const name of revokedCookies(document.cookie, consent)) for (const domain of cookieDomains(location.hostname)) document.cookie = `${name}=; Max-Age=0; Path=/${domain === null ? "" : `; Domain=${domain}`}`;
+	window.dispatchEvent(new CustomEvent(CONSENT_EVENT, { detail: consent }));
+}
+function installConsent(config) {
+	terms = {
+		...consentPurposes(config),
+		version: config.consentVersion
+	};
+	const api = window.ecomiq?.consent ?? {
+		get: currentConsent,
+		set: setConsent
+	};
+	window.ecomiq = {
+		...window.ecomiq,
+		consent: api
+	};
+	return api;
+}
+function onConsent(listener) {
+	const handle = (event) => listener(event.detail);
+	window.addEventListener(CONSENT_EVENT, handle);
+	return () => window.removeEventListener(CONSENT_EVENT, handle);
+}
+function openConsent() {
+	window.dispatchEvent(new Event(CONSENT_OPEN_EVENT));
+}
+function onConsentOpen(listener) {
+	window.addEventListener(CONSENT_OPEN_EVENT, listener);
+	return () => window.removeEventListener(CONSENT_OPEN_EVENT, listener);
+}
+export { consentPurposes, currentConsent, installConsent, onConsent, onConsentOpen, openConsent };