@decocms/apps-shopify 8.1.0-next.0 → 8.1.0-next.1

package/src/loaders/ProductListingPage.ts

@@ -1,172 +0,0 @@
-import type { ProductListingPage } from "@decocms/apps-commerce/types";
-import { getShopifyClient } from "../client";
-import { ProductsByCollection, SearchProducts } from "../utils/storefront/queries";
-import { type ProductShopify, toFilter, toProduct } from "../utils/transform";
-import type { Metafield } from "../utils/types";
-import {
-	getFiltersByUrl,
-	searchSortOptions,
-	searchSortShopify,
-	sortOptions,
-	sortShopify,
-} from "../utils/utils";
-
-interface PageInfo {
-	hasNextPage: boolean;
-	hasPreviousPage: boolean;
-	endCursor?: string;
-	startCursor?: string;
-}
-
-interface FilterNode {
-	id: string;
-	label: string;
-	type: string;
-	values: Array<{ id: string; label: string; count: number; input: string }>;
-}
-
-interface ProductConnection {
-	nodes: ProductShopify[];
-	pageInfo: PageInfo;
-	filters?: FilterNode[];
-}
-
-export interface Props {
-	query?: string;
-	collectionName?: string;
-	count: number;
-	metafields?: Metafield[];
-	pageOffset?: number;
-	page?: number;
-	startCursor?: string;
-	endCursor?: string;
-	pageHref?: string;
-}
-
-export default async function productListingPageLoader(
-	props: Props,
-	url?: URL,
-): Promise<ProductListingPage | null> {
-	const pageUrl = url ?? new URL(props.pageHref || "https://localhost");
-	const client = getShopifyClient();
-
-	const count = props.count ?? 12;
-	const query = props.query || pageUrl.searchParams.get("q") || "";
-	const currentPageoffset = props.pageOffset ?? 1;
-	const pageParam = pageUrl.searchParams.get("page")
-		? Number(pageUrl.searchParams.get("page")) - currentPageoffset
-		: 0;
-	const page = props.page || pageParam;
-	const endCursor = props.endCursor || pageUrl.searchParams.get("endCursor") || "";
-	const startCursor = props.startCursor || pageUrl.searchParams.get("startCursor") || "";
-	const metafields = props.metafields || [];
-
-	const isSearch = Boolean(query);
-	let hasNextPage = false;
-	let hasPreviousPage = false;
-	let shopifyProducts: ProductConnection | undefined;
-	let shopifyFilters: FilterNode[] | undefined;
-	let records: number | undefined;
-	let collectionTitle: string | undefined;
-	let collectionDescription: string | undefined;
-
-	const sort = pageUrl.searchParams.get("sort") ?? "";
-
-	if (isSearch) {
-		const data = await client.query<{
-			search: ProductConnection & { totalCount?: number; productFilters?: FilterNode[] };
-		}>(SearchProducts, {
-			...(!endCursor && { first: count }),
-			...(endCursor && { last: count }),
-			...(startCursor && { after: startCursor }),
-			...(endCursor && { before: endCursor }),
-			query,
-			productFilters: getFiltersByUrl(pageUrl),
-			identifiers: metafields,
-			...searchSortShopify[sort],
-		});
-
-		shopifyProducts = data.search;
-		shopifyFilters = data.search?.productFilters;
-		records = data.search?.totalCount;
-		hasNextPage = Boolean(data.search?.pageInfo.hasNextPage);
-		hasPreviousPage = Boolean(data.search?.pageInfo.hasPreviousPage);
-	} else {
-		const pathname = props.collectionName || pageUrl.pathname.split("/")[1];
-
-		const data = await client.query<{
-			collection?: {
-				title?: string;
-				description?: string;
-				products: ProductConnection;
-			};
-		}>(ProductsByCollection, {
-			...(!endCursor && { first: count }),
-			...(endCursor && { last: count }),
-			...(startCursor && { after: startCursor }),
-			...(endCursor && { before: endCursor }),
-			identifiers: metafields,
-			handle: pathname,
-			filters: getFiltersByUrl(pageUrl),
-			...sortShopify[sort],
-		});
-
-		shopifyProducts = data.collection?.products;
-		shopifyFilters = data.collection?.products?.filters;
-		hasNextPage = Boolean(data.collection?.products.pageInfo.hasNextPage);
-		hasPreviousPage = Boolean(data.collection?.products.pageInfo.hasPreviousPage);
-		collectionTitle = data.collection?.title;
-		collectionDescription = data.collection?.description;
-	}
-
-	const products = shopifyProducts?.nodes?.map((p) => toProduct(p, p.variants.nodes[0], pageUrl));
-
-	const nextPage = new URLSearchParams(pageUrl.searchParams);
-	const previousPage = new URLSearchParams(pageUrl.searchParams);
-
-	if (hasNextPage) {
-		nextPage.set("page", (page + currentPageoffset + 1).toString());
-		nextPage.set("startCursor", shopifyProducts?.pageInfo.endCursor ?? "");
-		nextPage.delete("endCursor");
-	}
-
-	if (hasPreviousPage) {
-		previousPage.set("page", (page + currentPageoffset - 1).toString());
-		previousPage.set("endCursor", shopifyProducts?.pageInfo.startCursor ?? "");
-		previousPage.delete("startCursor");
-	}
-
-	const filters = shopifyFilters?.map((filter) => toFilter(filter, pageUrl));
-	const currentPage = page + currentPageoffset;
-
-	return {
-		"@type": "ProductListingPage",
-		breadcrumb: {
-			"@type": "BreadcrumbList",
-			itemListElement: [
-				{
-					"@type": "ListItem" as const,
-					name: isSearch ? query : pageUrl.pathname.split("/")[1],
-					item: isSearch ? pageUrl.href : pageUrl.pathname,
-					position: 2,
-				},
-			],
-			numberOfItems: 1,
-		},
-		filters: filters ?? [],
-		products: products ?? [],
-		pageInfo: {
-			nextPage: hasNextPage ? `?${nextPage}` : undefined,
-			previousPage: hasPreviousPage ? `?${previousPage}` : undefined,
-			currentPage,
-			records,
-			recordPerPage: count,
-		},
-		sortOptions: isSearch ? searchSortOptions : sortOptions,
-		seo: {
-			title: collectionTitle || "",
-			description: collectionDescription || "",
-			canonical: `${pageUrl.origin}${pageUrl.pathname}${page >= 1 ? `?page=${page}` : ""}`,
-		},
-	};
-}

package/src/loaders/RelatedProducts.ts

@@ -1,42 +0,0 @@
-import type { Product } from "@decocms/apps-commerce/types";
-import { getShopifyClient } from "../client";
-import { GetProduct, ProductRecommendations } from "../utils/storefront/queries";
-import { type ProductShopify, toProduct } from "../utils/transform";
-import type { Metafield } from "../utils/types";
-
-export interface Props {
-	slug: string;
-	count?: number;
-	metafields?: Metafield[];
-}
-
-export default async function relatedProductsLoader(
-	props: Props,
-	url?: URL,
-): Promise<Product[] | null> {
-	const client = getShopifyClient();
-	const { slug, count = 10, metafields = [] } = props;
-
-	const splitted = slug?.split("-") ?? [];
-	const maybeSkuId = Number(splitted[splitted.length - 1]);
-	const handle = splitted.slice(0, maybeSkuId ? -1 : undefined).join("-");
-
-	const productData = await client.query<{ product?: ProductShopify }>(GetProduct, {
-		handle,
-		identifiers: metafields,
-	});
-
-	if (!productData?.product) return [];
-
-	const data = await client.query<{
-		productRecommendations?: ProductShopify[];
-	}>(ProductRecommendations, { productId: productData.product.id, identifiers: metafields });
-
-	if (!data?.productRecommendations) return [];
-
-	const baseUrl = url ?? new URL("https://localhost");
-
-	return data.productRecommendations
-		.map((p) => toProduct(p, p.variants.nodes[0], baseUrl))
-		.slice(0, count);
-}

package/src/loaders/cart.ts

@@ -1,74 +0,0 @@
-import { getShopifyClient } from "../client";
-import { getCartCookie, setCartCookie } from "../utils/cart";
-import { CreateCart, GetCart } from "../utils/storefront/queries";
-
-export interface CartLine {
-	id: string;
-	quantity: number;
-	merchandise: {
-		id: string;
-		title: string;
-		image?: { url: string; altText?: string | null } | null;
-		product: { title: string; handle: string; onlineStoreUrl?: string | null };
-		price: { amount: string; currencyCode: string };
-	};
-	discountAllocations?: Array<{
-		code?: string;
-		discountedAmount?: { amount: string; currencyCode: string };
-	}>;
-	cost?: {
-		totalAmount: { amount: string; currencyCode: string };
-		subtotalAmount: { amount: string; currencyCode: string };
-		amountPerQuantity?: { amount: string; currencyCode: string };
-		compareAtAmountPerQuantity?: { amount: string; currencyCode: string } | null;
-	};
-}
-
-export interface ShopifyCart {
-	id: string;
-	checkoutUrl: string;
-	totalQuantity: number;
-	lines: { nodes: CartLine[] };
-	cost: {
-		totalTaxAmount?: { amount: string; currencyCode: string };
-		subtotalAmount: { amount: string; currencyCode: string };
-		totalAmount: { amount: string; currencyCode: string };
-		checkoutChargeAmount?: { amount: string; currencyCode: string };
-	};
-	discountCodes?: Array<{ applicable: boolean; code: string }>;
-	discountAllocations?: Array<{
-		discountedAmount: { amount: string; currencyCode: string };
-	}>;
-}
-
-export async function getCart(
-	requestHeaders: Headers,
-	responseHeaders?: Headers,
-): Promise<ShopifyCart | null> {
-	const client = getShopifyClient();
-	const maybeCartId = getCartCookie(requestHeaders);
-
-	const cartId =
-		maybeCartId ??
-		(await client
-			.query<{ payload?: { cart?: { id: string } } }>(CreateCart)
-			.then((data) => data.payload?.cart?.id));
-
-	if (!cartId) throw new Error("Missing cart id");
-
-	const cart = await client
-		.query<{ cart?: ShopifyCart }>(GetCart, { id: decodeURIComponent(cartId) })
-		.then((data) => data.cart ?? null);
-
-	if (responseHeaders) {
-		setCartCookie(responseHeaders, cartId);
-	}
-
-	return cart;
-}
-
-export async function createCart(): Promise<string | null> {
-	const client = getShopifyClient();
-	const data = await client.query<{ payload?: { cart?: { id: string } } }>(CreateCart);
-	return data?.payload?.cart?.id ?? null;
-}

package/src/loaders/shop.ts

@@ -1,35 +0,0 @@
-import { getShopifyClient } from "../client";
-import { GetShopInfo } from "../utils/storefront/queries";
-import type { Metafield } from "../utils/types";
-
-export interface Shop {
-	name: string;
-	description?: string;
-	privacyPolicy?: { title: string; body: string };
-	refundPolicy?: { title: string; body: string };
-	shippingPolicy?: { title: string; body: string };
-	subscriptionPolicy?: { title: string; body: string };
-	termsOfService?: { title: string; body: string };
-	metafields?: Array<{
-		description?: string | null;
-		key: string;
-		namespace: string;
-		type: string;
-		value: string;
-		reference?: { image?: { url: string } } | null;
-		references?: { edges: Array<{ node: { image?: { url: string } } }> } | null;
-	} | null>;
-}
-
-export interface Props {
-	metafields?: Metafield[];
-}
-
-export default async function shopLoader(props?: Props): Promise<Shop> {
-	const client = getShopifyClient();
-	const metafields = props?.metafields || [];
-
-	const data = await client.query<{ shop: Shop }>(GetShopInfo, { identifiers: metafields });
-
-	return data.shop;
-}

package/src/loaders/user.ts

@@ -1,39 +0,0 @@
-import { getShopifyClient } from "../client";
-import { FetchCustomerInfo } from "../utils/storefront/queries";
-import { getUserCookie } from "../utils/user";
-
-export interface ShopifyUser {
-	"@id": string;
-	email: string;
-	givenName: string;
-	familyName: string;
-}
-
-export default async function userLoader(requestHeaders: Headers): Promise<ShopifyUser | null> {
-	const client = getShopifyClient();
-	const customerAccessToken = getUserCookie(requestHeaders);
-
-	if (!customerAccessToken) return null;
-
-	try {
-		const data = await client.query<{
-			customer?: {
-				id: string;
-				email?: string | null;
-				firstName?: string | null;
-				lastName?: string | null;
-			};
-		}>(FetchCustomerInfo, { customerAccessToken });
-
-		if (!data.customer) return null;
-
-		return {
-			"@id": data.customer.id,
-			email: data.customer.email ?? "",
-			givenName: data.customer.firstName ?? "",
-			familyName: data.customer.lastName ?? "",
-		};
-	} catch {
-		return null;
-	}
-}

package/src/manifest.gen.ts

@@ -1,39 +0,0 @@
-// AUTO-GENERATED by scripts/generate-manifests.ts — DO NOT EDIT
-// This file is checked into source control and updated via: npm run generate:manifests
-
-import * as actions_cart_addItems from "./actions/cart/addItems";
-import * as actions_cart_updateCoupons from "./actions/cart/updateCoupons";
-import * as actions_cart_updateItems from "./actions/cart/updateItems";
-import * as actions_user_signIn from "./actions/user/signIn";
-import * as actions_user_signUp from "./actions/user/signUp";
-import * as loaders_cart from "./loaders/cart";
-import * as loaders_ProductDetailsPage from "./loaders/ProductDetailsPage";
-import * as loaders_ProductList from "./loaders/ProductList";
-import * as loaders_ProductListingPage from "./loaders/ProductListingPage";
-import * as loaders_RelatedProducts from "./loaders/RelatedProducts";
-import * as loaders_shop from "./loaders/shop";
-import * as loaders_user from "./loaders/user";
-
-const manifest = {
-	name: "shopify",
-	loaders: {
-		"shopify/loaders/ProductDetailsPage": loaders_ProductDetailsPage,
-		"shopify/loaders/ProductList": loaders_ProductList,
-		"shopify/loaders/ProductListingPage": loaders_ProductListingPage,
-		"shopify/loaders/RelatedProducts": loaders_RelatedProducts,
-		"shopify/loaders/cart": loaders_cart,
-		"shopify/loaders/shop": loaders_shop,
-		"shopify/loaders/user": loaders_user,
-	},
-	actions: {
-		"shopify/actions/cart/addItems": actions_cart_addItems,
-		"shopify/actions/cart/updateCoupons": actions_cart_updateCoupons,
-		"shopify/actions/cart/updateItems": actions_cart_updateItems,
-		"shopify/actions/user/signIn": actions_user_signIn,
-		"shopify/actions/user/signUp": actions_user_signUp,
-	},
-	sections: {},
-} as const;
-
-export type Manifest = typeof manifest;
-export default manifest;

package/src/mod.ts

@@ -1,67 +0,0 @@
-/**
- * Shopify app module — standard autoconfig contract.
- *
- * Exports `configure` following the AppModContract pattern.
- * The framework's `autoconfigApps()` calls these generically.
- *
- * @example
- * ```ts
- * import * as shopifyApp from "@decocms/apps/shopify/mod";
- *
- * const app = await shopifyApp.configure(blocks["deco-shopify"], resolveSecret);
- * if (app) {
- *   // app.manifest, app.state are available
- * }
- * ```
- */
-
-import type { AppDefinition, ResolveSecretFn } from "@decocms/apps-commerce/app-types";
-import { configureShopify, type ShopifyConfig } from "./client";
-import manifest from "./manifest.gen";
-
-// -------------------------------------------------------------------------
-// State
-// -------------------------------------------------------------------------
-
-export interface ShopifyState {
-	config: ShopifyConfig;
-}
-
-// -------------------------------------------------------------------------
-// Configure
-// -------------------------------------------------------------------------
-
-/**
- * Configure the Shopify app from CMS block data.
- * Returns an AppDefinition or null if required fields are missing.
- */
-export async function configure(
-	block: Record<string, unknown>,
-	resolveSecret: ResolveSecretFn,
-): Promise<AppDefinition<ShopifyState> | null> {
-	if (!block?.storeName) return null;
-
-	const storefrontAccessToken =
-		(await resolveSecret(block.storefrontAccessToken, "SHOPIFY_STOREFRONT_TOKEN")) ??
-		(typeof block.storefrontAccessToken === "string" ? block.storefrontAccessToken : null);
-
-	if (!storefrontAccessToken) return null;
-
-	const config: ShopifyConfig = {
-		storeName: block.storeName as string,
-		storefrontAccessToken,
-		publicUrl: block.publicUrl as string | undefined,
-	};
-
-	// Bridge: maintain global singleton for backward compat
-	configureShopify(config);
-
-	return {
-		name: "shopify",
-		manifest,
-		state: { config },
-	};
-}
-
-/** Placeholder preview for CMS editor — evolves when admin supports it. */
-export const preview = undefined;

package/src/registry.ts

@@ -1,9 +0,0 @@
-import type { AppRegistryEntry } from "@decocms/apps-commerce/registry";
-
-export const SHOPIFY_REGISTRY_ENTRY: AppRegistryEntry = {
-	blockKey: "deco-shopify",
-	module: () => import("./mod"),
-	displayName: "Shopify",
-	category: "commerce",
-	description: "Shopify Storefront API commerce integration",
-};

package/src/utils/__tests__/instrumentedFetch.test.ts

@@ -1,84 +0,0 @@
-/**
- * Smoke tests for the pre-wired Shopify fetch factory. Same wiring
- * assertions as `vtex/utils/__tests__/instrumentedFetch.test.ts`.
- */
-
-import { configureMeter, type MeterAdapter } from "@decocms/blocks/sdk/observability";
-import { afterEach, describe, expect, it, vi } from "vitest";
-import { createShopifyFetch } from "../instrumentedFetch";
-
-type Labels = Record<string, string | number | boolean>;
-
-function captureHistogram(): {
-	calls: { name: string; value: number; attrs: Labels }[];
-	meter: MeterAdapter;
-} {
-	const calls: { name: string; value: number; attrs: Labels }[] = [];
-	const meter: MeterAdapter = {
-		counterInc: vi.fn(),
-		gaugeSet: vi.fn(),
-		histogramRecord: (name, value, attrs) => {
-			calls.push({ name, value, attrs: attrs ?? {} });
-		},
-	};
-	return { calls, meter };
-}
-
-describe("createShopifyFetch", () => {
-	afterEach(() => {
-		vi.restoreAllMocks();
-		configureMeter({
-			counterInc: () => {},
-			gaugeSet: () => {},
-			histogramRecord: () => {},
-		});
-	});
-
-	it("emits http.client.request.duration with provider=shopify on success", async () => {
-		const { calls, meter } = captureHistogram();
-		configureMeter(meter);
-
-		const baseFetch = vi.fn(async () => new Response("{}", { status: 200 }));
-		const fetchFn = createShopifyFetch({ baseFetch: baseFetch as typeof fetch });
-
-		await fetchFn("https://store.myshopify.com/api/2025-04/graphql.json", { method: "POST" });
-
-		expect(calls).toHaveLength(1);
-		expect(calls[0].name).toBe("http.client.request.duration");
-		expect(calls[0].attrs).toMatchObject({
-			provider: "shopify",
-			operation: "storefront.graphql",
-			status_class: "2xx",
-		});
-	});
-
-	it("honors init.operation (used by the GraphQL client to stamp <OperationName>)", async () => {
-		const { calls, meter } = captureHistogram();
-		configureMeter(meter);
-
-		const baseFetch = vi.fn(async () => new Response("{}", { status: 200 }));
-		const fetchFn = createShopifyFetch({ baseFetch: baseFetch as typeof fetch });
-
-		await fetchFn("https://store.myshopify.com/api/2025-04/graphql.json", {
-			method: "POST",
-			operation: "ProductBySlug",
-		});
-
-		expect(calls[0].attrs.operation).toBe("ProductBySlug");
-	});
-
-	it("skips histogram emission when disableHistogram is true", async () => {
-		const { calls, meter } = captureHistogram();
-		configureMeter(meter);
-
-		const baseFetch = vi.fn(async () => new Response("{}", { status: 200 }));
-		const fetchFn = createShopifyFetch({
-			baseFetch: baseFetch as typeof fetch,
-			disableHistogram: true,
-		});
-
-		await fetchFn("https://store.myshopify.com/api/2025-04/graphql.json", { method: "POST" });
-
-		expect(calls).toHaveLength(0);
-	});
-});

package/src/utils/__tests__/operationRouter.test.ts

@@ -1,56 +0,0 @@
-import { describe, expect, it } from "vitest";
-import { shopifyOperationRouter } from "../operationRouter";
-
-describe("shopifyOperationRouter", () => {
-	const store = "https://acme.myshopify.com";
-
-	it("recognizes the storefront GraphQL endpoint", () => {
-		expect(shopifyOperationRouter(`${store}/api/2025-04/graphql.json`, "POST")).toBe(
-			"storefront.graphql",
-		);
-	});
-
-	it("recognizes the admin GraphQL endpoint", () => {
-		expect(shopifyOperationRouter(`${store}/admin/api/2025-04/graphql.json`, "POST")).toBe(
-			"admin.graphql",
-		);
-	});
-
-	it("maps admin REST product / order / customer / inventory endpoints", () => {
-		expect(shopifyOperationRouter(`${store}/admin/api/2025-04/products.json`, "GET")).toBe(
-			"admin.products",
-		);
-		expect(shopifyOperationRouter(`${store}/admin/api/2025-04/orders/123.json`, "GET")).toBe(
-			"admin.orders",
-		);
-		expect(shopifyOperationRouter(`${store}/admin/api/2025-04/customers.json`, "GET")).toBe(
-			"admin.customers",
-		);
-		expect(shopifyOperationRouter(`${store}/admin/api/2025-04/inventory_levels.json`, "GET")).toBe(
-			"admin.inventory",
-		);
-	});
-
-	it("maps storefront checkout + cart endpoints", () => {
-		expect(shopifyOperationRouter(`${store}/api/2025-04/checkouts/abc.json`, "POST")).toBe(
-			"storefront.checkout",
-		);
-		expect(shopifyOperationRouter(`${store}/cart.js`, "GET")).toBe("storefront.cart");
-		expect(shopifyOperationRouter(`${store}/cart/add.js`, "POST")).toBe("storefront.cart");
-	});
-
-	it("returns undefined for unrecognized paths", () => {
-		expect(shopifyOperationRouter(`${store}/random/path`, "GET")).toBeUndefined();
-	});
-
-	it("does not throw on unparseable URLs", () => {
-		expect(shopifyOperationRouter("not-a-url", "GET")).toBeUndefined();
-		expect(shopifyOperationRouter("/api/2025-04/graphql.json", "POST")).toBe("storefront.graphql");
-	});
-
-	it("is case-insensitive on method (no behavioral impact today; future-proofing)", () => {
-		expect(shopifyOperationRouter(`${store}/api/2025-04/graphql.json`, "post")).toBe(
-			"storefront.graphql",
-		);
-	});
-});