@decocms/apps-magento 8.1.0-next.0 → 8.1.0-next.2

package/src/utils/client/types.ts

@@ -1,270 +0,0 @@
-/**
- * Magento REST API response shapes — the subset of types from
- * `deco-cx/apps/magento/utils/client/types.ts` that the port has
- * reached so far. Extended as more loaders/actions land.
- *
- * Keep field names **exactly** as Magento returns them (mostly
- * snake_case, occasional camelCase from carbono-customer). Consumer
- * sites already render against these shapes — any rename is a
- * breaking change at the storefront, not just the API boundary.
- */
-
-// ---------------------------------------------------------------------------
-// Customer / user section payloads (added by the user+wishlist port)
-// ---------------------------------------------------------------------------
-
-/**
- * `customer` slice of `/customer/section/load?sections=customer,…`.
- * Magento returns this on every authenticated section call.
- */
-export interface Customer {
-	data_id: number;
-	fullname?: string;
-	firstname?: string;
-}
-
-/**
- * `carbono-customer` slice. A storefront-specific overlay that mirrors the
- * `customer` slice plus a website/store id pair and a normalized email.
- * Other magento sites that don't run the Carbono module will get this
- * absent; loaders/user.ts checks for it before mapping to a Person.
- */
-export interface CarbonoCustomer {
-	websiteId?: string;
-	email?: string;
-	customerId?: string;
-	data_id: number;
-}
-
-/**
- * `cart` slice of the customer section bundle — minimal projection of
- * the cart that the minicart island renders before the full cart loader
- * has resolved. Not the same as the full Cart payload from
- * `/V1/carts/:cartId` (which lives in MagentoCart in types.ts).
- */
-export interface CartUser {
-	summary_count: number;
-	subtotalAmount: number | null;
-	subtotal: string;
-	possible_onepage_checkout: boolean;
-	items: [];
-	isGuestCheckoutAllowed: boolean;
-	website_id: string;
-	storeId: string;
-	adyen_payment_methods: unknown[];
-	extra_actions: string;
-	cart_empty_message: string;
-	subtotal_incl_tax: string;
-	subtotal_excl_tax: string;
-	mpFSBCartTotal: unknown | null;
-	data_id: number;
-	minicart_improvements: MinicartImprovements;
-}
-
-export interface MinicartImprovements {
-	coupon_code: string | null;
-	country_id: string;
-	api_base_url: string;
-	is_logged_in: boolean;
-	quote_id: string;
-	base_url: string;
-}
-
-/**
- * Bundle shape returned by
- * `GET /:site/customer/section/load?sections=customer,carbono-customer,wishlist,…`.
- * Keys are optional because the caller picks which sections to request.
- */
-export interface CustomerSectionLoad {
-	customer?: Customer;
-	"carbono-customer"?: CarbonoCustomer;
-	cart?: CartUser;
-	wishlist?: Wishlist;
-}
-
-// ---------------------------------------------------------------------------
-// Wishlist payloads
-// ---------------------------------------------------------------------------
-
-export interface Wishlist {
-	counter: string;
-	items: WishlistItem[];
-	counter_number: number;
-	data_id: number;
-}
-
-export interface WishlistItem {
-	image: WishlistItemImage;
-	product_sku: string;
-	product_id: string;
-	product_url: string;
-	product_name: string;
-	product_price: string;
-	product_is_saleable_and_visible: boolean;
-	product_has_required_options: boolean;
-	add_to_cart_params: string;
-	delete_item_params: string;
-}
-
-export interface WishlistItemImage {
-	template: string;
-	src: string;
-	width: number;
-	height: number;
-	alt: string;
-}
-
-// ---------------------------------------------------------------------------
-// Shared attribute/category shapes (added by the transform port)
-// ---------------------------------------------------------------------------
-
-export interface CustomAttribute {
-	attribute_code: string;
-	value: string | string[];
-}
-
-export interface CategoryLink {
-	position: number;
-	category_id: string;
-}
-
-export interface MagentoCategory {
-	id: number;
-	parent_id: number;
-	name: string;
-	is_active: boolean;
-	position: number;
-	level: number;
-	children: string;
-	created_at: string;
-	updated_at: string;
-	path: string;
-	include_in_menu: boolean;
-	custom_attributes: CustomAttribute[];
-}
-
-// ---------------------------------------------------------------------------
-// Product detail shapes (used by PDP / PLP / list loaders)
-// ---------------------------------------------------------------------------
-
-export interface MagentoPriceInfo {
-	final_price: number;
-	max_price: number;
-	max_regular_price: number;
-	minimal_regular_price: number;
-	special_price: number | null;
-	minimal_price: number;
-	regular_price: number;
-	formatted_prices: {
-		final_price: string;
-		max_price: string;
-		minimal_price: string;
-		max_regular_price: string;
-		minimal_regular_price: string | null;
-		special_price: string | null;
-		regular_price: string;
-	};
-	extension_attributes: {
-		msrp: {
-			msrp_price: string;
-			is_applicable: string;
-			is_shown_price_on_gesture: string;
-			msrp_message: string;
-			explanation_message: string;
-		};
-		tax_adjustments: {
-			final_price: number;
-			max_price: number;
-			max_regular_price: number;
-			minimal_regular_price: number;
-			special_price: number;
-			minimal_price: number;
-			regular_price: number;
-			formatted_prices: {
-				final_price: string;
-				max_price: string;
-				minimal_price: string;
-				max_regular_price: string;
-				minimal_regular_price: string | null;
-				special_price: string;
-				regular_price: string;
-			};
-		};
-		weee_attributes: unknown[];
-		weee_adjustment: string;
-	};
-}
-
-export interface MagentoStock {
-	item_id: number;
-	product_id: number;
-	stock_id: number;
-	qty?: number;
-	is_in_stock?: boolean;
-	is_qty_decimal?: boolean;
-	show_default_notification_message?: boolean;
-	use_config_min_qty?: boolean;
-	min_qty?: number;
-	use_config_min_sale_qty?: boolean;
-	min_sale_qty?: number;
-	use_config_max_sale_qty?: boolean;
-	max_sale_qty?: number;
-	use_config_backorders?: boolean;
-	backorders?: number;
-	use_config_notify_stock_qty?: boolean;
-	notify_stock_qty?: number;
-	use_config_qty_increments?: boolean;
-	qty_increments?: number;
-	use_config_enable_qty_inc?: boolean;
-	enable_qty_increments?: boolean;
-	use_config_manage_stock?: boolean;
-	manage_stock?: boolean;
-	low_stock_date?: string | null;
-	is_decimal_divided?: boolean;
-	stock_status_changed_auto?: number;
-}
-
-export interface MagentoImage {
-	url: string;
-	code: string;
-	height: number;
-	width: number;
-	label: string;
-	resized_width: number;
-	resized_height: number;
-	disabled: boolean;
-}
-
-export interface MediaEntry {
-	id: number;
-	media_type: string;
-	label: string | null;
-	position: number;
-	disabled: boolean;
-	types: string[];
-	file: string;
-}
-
-export interface MagentoProduct {
-	id: number;
-	sku: string;
-	name: string;
-	price: number;
-	status: number;
-	visibility: number;
-	type_id: string;
-	created_at: string;
-	updated_at: string;
-	weight: number;
-	url: string;
-	extension_attributes: {
-		website_ids?: number[];
-		category_links: CategoryLink[];
-		stock_item?: MagentoStock;
-	};
-	custom_attributes: CustomAttribute[];
-	price_info?: MagentoPriceInfo;
-	currency_code?: string;
-	images?: MagentoImage[];
-	media_gallery_entries?: MediaEntry[];
-}

package/src/utils/constants.ts

@@ -1,126 +0,0 @@
-/**
- * Magento constants — ported verbatim from
- * `deco-cx/apps/magento/utils/constants.ts`.
- *
- * Keep this file boring and append-only. Magento's REST and GraphQL
- * payloads rely on these identifiers as-is (URL_KEY for PDP slug
- * matching, GRAND_TOTAL/SUBTOTAL/… for the totals composition that
- * cart.ts pulls, IN_STOCK/OUT_OF_STOCK for schema.org availability).
- * Mutating any of these values would silently break consumer sites
- * that already render against them.
- */
-
-import type { FiltersGraphQL } from "../client";
-
-// ---------------------------------------------------------------------------
-// SWR fetch-cache tuning (consumed by utils/fetchCache.ts via the shared
-// `createFetchCache` in @decocms/blocks/sdk/fetchCache). Mirrors the shape of
-// VTEX's constants so Magento's cache posture is tuned in one place.
-// ---------------------------------------------------------------------------
-
-/** Max distinct cache keys kept in memory; oldest `createdAt` evicted first. */
-export const FETCH_CACHE_MAX_ENTRIES = 500;
-
-/** How long a cached Magento response stays FRESH, keyed by status class. */
-export const FETCH_CACHE_FRESH_TTL_MS = {
-	/** 2xx — 3 min. Catalog/price data doesn't need to be second-fresh. */
-	success: 180_000,
-	/** 404 — 10s. A just-published product shouldn't 404 for long. */
-	notFound: 10_000,
-	/** 5xx — never treated as a good cache hit. */
-	serverError: 0,
-} as const;
-
-/** Stale-if-error window: serve last-good this long past freshness on outage. */
-export const FETCH_CACHE_STALE_IF_ERROR_MS = 86_400_000; // 24h
-
-/** Inflight-slot backstop: bounds how long one hung fetch holds a dedup slot. */
-export const FETCH_CACHE_INFLIGHT_BACKSTOP_MS = 15_000;
-
-export const URL_KEY = "url_key";
-
-// Schema.org availability mapping (used by utils/transform.ts to
-// produce Offer.availability — kept here so transform doesn't import
-// schema.org strings as magic literals).
-export const IN_STOCK = "https://schema.org/InStock";
-export const OUT_OF_STOCK = "https://schema.org/OutOfStock";
-
-// Rating bounds used by `utils/transform.ts` (and the review/rating
-// loaders that follow) when mapping Magento's integer-rating scale
-// into schema.org `AggregateRating`'s 1–5 range.
-export const MAX_RATING_VALUE = 5;
-export const MIN_RATING_VALUE = 1;
-
-/**
- * Default filter mapping consumed by `utils/graphql.ts:filtersFromUrlGraphQL`.
- * Each entry pairs a Magento attribute slug with the comparison operator
- * the storefront's URL filters use. Sites can extend this via the
- * `customFilters` prop on PLP/list loaders without forking the array.
- */
-export const DEFAULT_GRAPHQL_FILTERS: FiltersGraphQL[] = [
-	{ value: "activity", type: "EQUAL" },
-	{ value: "category_gear", type: "EQUAL" },
-	{ value: "category_id", type: "EQUAL" },
-	{ value: "category_uid", type: "EQUAL" },
-	{ value: "category_url_path", type: "EQUAL" },
-	{ value: "climate", type: "EQUAL" },
-	{ value: "collar", type: "EQUAL" },
-	{ value: "color", type: "EQUAL" },
-	{ value: "description", type: "MATCH" },
-	{ value: "eco_collection", type: "EQUAL" },
-	{ value: "erin_recommends", type: "EQUAL" },
-	{ value: "features_bags", type: "EQUAL" },
-	{ value: "format", type: "EQUAL" },
-	{ value: "gender", type: "EQUAL" },
-	{ value: "material", type: "EQUAL" },
-	{ value: "name", type: "MATCH" },
-	{ value: "new", type: "EQUAL" },
-	{ value: "pattern", type: "EQUAL" },
-	{ value: "performance_fabric", type: "EQUAL" },
-	{ value: "price", type: "RANGE" },
-	{ value: "purpose", type: "EQUAL" },
-	{ value: "sale", type: "EQUAL" },
-	{ value: "short_description", type: "MATCH" },
-	{ value: "size", type: "EQUAL" },
-	{ value: "sku", type: "EQUAL" },
-	{ value: "sleeve", type: "EQUAL" },
-	{ value: "strap_bags", type: "EQUAL" },
-	{ value: "style_bags", type: "EQUAL" },
-	{ value: "style_bottom", type: "EQUAL" },
-	{ value: "style_general", type: "EQUAL" },
-	{ value: "url_key", type: "EQUAL" },
-];
-
-/**
- * Query-string keys that should be stripped before forwarding a request
- * URL to Magento (e.g. when computing a cache key or building a
- * paginated request). Mirrors the Fresh-era REMOVABLE_URL_SEARCHPARAMS.
- */
-export const REMOVABLE_URL_SEARCHPARAMS = ["p", "product_list_order"];
-
-// ---------------------------------------------------------------------------
-// Cart totals composition — field names sent to Magento's
-// /V1/carts/:cartId/totals?fields=… endpoint. The cart loader joins
-// these into the `fields` query param to keep the response narrow.
-// ---------------------------------------------------------------------------
-
-export const GRAND_TOTAL = "grand_total";
-export const SUBTOTAL = "subtotal";
-export const DISCOUNT_AMOUNT = "discount_amount";
-export const BASE_DISCOUNT_AMOUNT = "base_discount_amount";
-export const SHIPPING_AMOUNT = "shipping_amount";
-export const BASE_SHIPPING_AMOUNT = "base_shipping_amount";
-export const SHIPPING_DISCOUNT_AMOUNT = "shipping_discount_amount";
-export const COUPON_CODE = "coupon_code";
-export const BASE_CURRENCY_CODE = "base_currency_code";
-
-// ---------------------------------------------------------------------------
-// Cookie names — single source of truth so loaders/actions/middleware
-// don't drift on string literals (Magento is case-sensitive about
-// these and a typo produces a silent anonymous-session bug).
-// ---------------------------------------------------------------------------
-
-export const SESSION_COOKIE = "PHPSESSID";
-export const CUSTOMER_COOKIE = "dataservices_customer_id";
-export const CART_COOKIE = "dataservices_cart_id";
-export const FORM_KEY_COOKIE = "form_key";

package/src/utils/fetchCache.ts

@@ -1,55 +0,0 @@
-/**
- * Magento SWR fetch cache — a thin binding over the shared, instrumented
- * `createFetchCache` in `@decocms/blocks/sdk/fetchCache`.
- *
- * Same shared implementation VTEX uses (in-flight dedup, stale-while-
- * revalidate, stale-if-error, inflight backstop), wired with Magento's tuning
- * constants and the `provider: "magento"` label. Every call emits
- * `deco.cache.requests{layer="swr",profile="magento"}` automatically.
- *
- * Cache key is caller-supplied (not required to be a URL): REST GETs key by
- * their URL; GraphQL POSTs can key by a hash of `query + variables`. Callers
- * pass the closure that performs the actual `magentoFetch`, so a HIT never
- * touches the network.
- */
-
-import {
-  createFetchCache,
-  type FetchCacheOptions as SharedFetchCacheOptions,
-} from "@decocms/blocks/sdk/fetchCache";
-import {
-  FETCH_CACHE_FRESH_TTL_MS,
-  FETCH_CACHE_INFLIGHT_BACKSTOP_MS,
-  FETCH_CACHE_MAX_ENTRIES,
-  FETCH_CACHE_STALE_IF_ERROR_MS,
-} from "./constants";
-
-export type FetchCacheOptions = SharedFetchCacheOptions;
-
-const cache = createFetchCache({
-  provider: "magento",
-  maxEntries: FETCH_CACHE_MAX_ENTRIES,
-  freshTtlMs: FETCH_CACHE_FRESH_TTL_MS,
-  staleIfErrorMs: FETCH_CACHE_STALE_IF_ERROR_MS,
-  inflightBackstopMs: FETCH_CACHE_INFLIGHT_BACKSTOP_MS,
-});
-
-/**
- * Wrap a Magento GET with SWR caching + in-flight dedup. Returns the parsed
- * JSON body, or `null` for cacheable non-2xx responses (e.g. 404). 5xx throw.
- */
-export function magentoCachedFetch<T>(
-  cacheKey: string,
-  doFetch: () => Promise<Response>,
-  opts?: FetchCacheOptions,
-): Promise<T | null> {
-  return cache.fetchWithCache<T>(cacheKey, doFetch, opts);
-}
-
-export function clearFetchCache() {
-  cache.clear();
-}
-
-export function getFetchCacheStats() {
-  return cache.getStats();
-}

package/src/utils/graphql-types.ts

@@ -1,99 +0,0 @@
-/**
- * Magento GraphQL request input types used by the product loaders.
- *
- * Subset of `deco-cx/apps/magento/utils/clientGraphql/types.ts` that the
- * port has reached so far — extended as more loaders land. These mirror
- * Magento's GraphQL schema for product search/sort/filter so the
- * storefront's URL params translate cleanly into GraphQL variables.
- */
-
-/**
- * Magento ProductAttributeFilterInput shape — keys are Magento
- * attribute codes; values are one of the three filter-type unions.
- * Maps to: `filter: ProductAttributeFilterInput!`
- */
-export interface ProductFilterInput {
-	[key: string]: FilterEqualTypeInput | FilterMatchTypeInput | FilterRangeTypeInput;
-}
-
-/**
- * Magento `FilterEqualTypeInput` — for exact-match attributes (sku,
- * sale, color, size, etc.). `in` lets you OR multiple values; the
- * single-value `eq` form is also accepted by the Magento schema and is
- * the shape `transformFilterValueGraphQL` emits.
- */
-export interface FilterEqualTypeInput {
-	in?: string[];
-	eq?: string;
-}
-
-/**
- * Magento `FilterMatchTypeInput` — substring-match attributes (name,
- * description, short_description).
- */
-export interface FilterMatchTypeInput {
-	match: string;
-}
-
-/**
- * Magento `FilterRangeTypeInput` — numeric ranges (price). Both bounds
- * are strings in the schema; ranges in URL params come as `from_to`.
- */
-export interface FilterRangeTypeInput {
-	from: string;
-	to: string;
-}
-
-/**
- * Magento `ProductAttributeSortInput` — one entry per sortable
- * attribute keyed by attribute code, ordered ASC or DESC.
- */
-export interface ProductSortInput {
-	[key: string]: "ASC" | "DESC";
-}
-
-/**
- * Built-in sort options surfaced in the CMS admin. Custom options can
- * be added by sites via `CustomProductSortOption`.
- */
-export interface DefaultProductSortOption {
-	value: "name" | "position" | "price" | "relevance";
-}
-
-export interface CustomProductSortOption {
-	value: string;
-}
-
-/**
- * Shared sort-prop shape used by PLP / list / relatedProducts loaders.
- */
-export interface ProductSort {
-	/** @title Order by */
-	sortBy: DefaultProductSortOption | CustomProductSortOption;
-	/** @title Sequency */
-	order: "ASC" | "DESC";
-}
-
-/**
- * Loader-supplied filter (vs URL-derived). The site can hard-code
- * filters in the CMS section config and they layer on top of whatever
- * the user picked from URL params.
- */
-export interface FilterProps {
-	name: string;
-	type: FilterEqualTypeInput | FilterMatchTypeInput | FilterRangeTypeInput;
-}
-
-/**
- * Custom-fields toggle used by `getCustomFields()` to decide which
- * Magento product attributes to project from a query.
- */
-export interface CustomFields {
-	/**
-	 * @description Search for global custom fields defined in App settings
-	 * @default false
-	 */
-	active: boolean;
-	/** @description Will override global custom fields defined in App settings */
-	overrideList?: string[];
-}

package/src/utils/graphql.ts

@@ -1,155 +0,0 @@
-/**
- * GraphQL helpers for Magento product loaders.
- *
- * Ported from `deco-cx/apps/magento/utils/graphql.ts` (Fresh/Deno
- * prod). Pure functions — no I/O, no client state — so behavior is
- * pinned by `__tests__/graphql.test.ts` and shared across PDP, PLP,
- * list, and relatedProducts loaders.
- *
- *  - `transformSortGraphQL(ProductSort)` → `ProductSortInput`
- *  - `transformFilterGraphQL(url, customFilters, fromLoader)` →
- *    `ProductFilterInput` — merges URL-derived + loader-derived filters.
- *  - `transformFilterValueGraphQL(value, type)` → typed Filter*Input.
- *  - `formatUrlSuffix(str)` → ensures a path ends with `/` (used as
- *    `defaultPath` for the Magento URL rewrite resolver).
- *  - `getCustomFields(CustomFields, fallback)` → resolved custom
- *    attribute list for product projection.
- */
-
-import type { FiltersGraphQL } from "../client";
-import { DEFAULT_GRAPHQL_FILTERS } from "./constants";
-import type {
-	CustomFields,
-	FilterEqualTypeInput,
-	FilterMatchTypeInput,
-	FilterProps,
-	FilterRangeTypeInput,
-	ProductFilterInput,
-	ProductSort,
-	ProductSortInput,
-} from "./graphql-types";
-
-export const typeChecker = <T extends object>(v: T, prop: keyof T): boolean => prop in v;
-
-export const transformSortGraphQL = ({
-	sortBy,
-	order,
-}: Partial<ProductSort>): ProductSortInput | undefined => {
-	if (!sortBy) {
-		return undefined;
-	}
-	return {
-		[sortBy.value]: order ?? "ASC",
-	};
-};
-
-/**
- * Compose the GraphQL `filter` payload from two sources, in order:
- *
- *   1. URL search params crossed against `DEFAULT_GRAPHQL_FILTERS`
- *      (+ any `customFilters` the site extends with).
- *   2. Explicit `fromLoader` filters the CMS section pinned at config
- *      time.
- *
- * Loader-derived filters shadow URL-derived ones on key collisions
- * (intentional — a section that hard-codes `sale=true` should ignore
- * any conflicting URL hint).
- */
-export const transformFilterGraphQL = (
-	url: URL,
-	customFilters?: Array<FiltersGraphQL>,
-	fromLoader?: Array<FilterProps>,
-): ProductFilterInput | undefined => ({
-	...filtersFromUrlGraphQL(url, customFilters),
-	...filtersFromLoaderGraphQL(fromLoader),
-});
-
-export const filtersFromLoaderGraphQL = (
-	fromLoader?: Array<FilterProps>,
-): ProductFilterInput | undefined =>
-	fromLoader?.reduce<ProductFilterInput>(
-		(acc, f) => ({
-			...acc,
-			[f.name]: f.type,
-		}),
-		{},
-	) ?? {};
-
-export const filtersFromUrlGraphQL = (
-	url: URL,
-	customFilters?: Array<FiltersGraphQL>,
-): ProductFilterInput =>
-	DEFAULT_GRAPHQL_FILTERS.concat(customFilters ?? []).reduce<ProductFilterInput>(
-		(acc, { type, value }) => {
-			const fromUrl = url.searchParams.get(value);
-			if (!fromUrl) {
-				return acc;
-			}
-			return {
-				...acc,
-				[value]: transformFilterValueGraphQL(fromUrl, type),
-			};
-		},
-		{},
-	);
-
-export const transformFilterValueGraphQL = (
-	value: string,
-	type: "EQUAL" | "MATCH" | "RANGE",
-): FilterEqualTypeInput | FilterMatchTypeInput | FilterRangeTypeInput => {
-	if (type === "EQUAL") {
-		return { eq: value } as FilterEqualTypeInput;
-	}
-
-	if (type === "MATCH") {
-		return { match: value } as FilterMatchTypeInput;
-	}
-
-	if (type === "RANGE") {
-		const splitterIndex = value.indexOf("_");
-		return {
-			from: value.substring(0, splitterIndex),
-			to: value.substring(splitterIndex + 1),
-		} as FilterRangeTypeInput;
-	}
-
-	return {} as FilterEqualTypeInput;
-};
-
-/**
- * Normalize a URL path into the form Magento's
- * `urlResolver(url: "<path>/")` expects:
- *   - Strip a single leading slash (the resolver doesn't want it).
- *   - Ensure the path ends with `/`.
- *
- * Used by PLP / PDP / list / relatedProducts loaders as `defaultPath`
- * when `useSuffix` is enabled.
- */
-export const formatUrlSuffix = (str: string): string => {
-	let s = str;
-	if (s.startsWith("/")) s = s.slice(1);
-	if (!s.endsWith("/")) s = `${s}/`;
-	return s;
-};
-
-/**
- * Resolve which custom-attribute list a loader should request:
- *
- *  - disabled (`active: false`) → undefined (loader projects nothing custom).
- *  - explicit override list set → return that list as-is.
- *  - otherwise → fall back to the global list provided by the loader.
- */
-export const getCustomFields = (
-	{ active, overrideList }: CustomFields = { active: false, overrideList: [] },
-	customFields?: Array<string>,
-): Array<string> | undefined => {
-	if (!active) {
-		return undefined;
-	}
-
-	if (overrideList && overrideList.length > 0) {
-		return overrideList;
-	}
-
-	return customFields;
-};