Files
shopify-template/hooks/use-shopify-cart.ts
T
Rami BitarandClaude Opus 5 f8c3ef9e0e Move Storefront queries onto @shopify/hydrogen preview client
Replaces the hand-rolled shopifyFetch wrapper and raw query strings with
the hydrogen preview package (0.0.0-preview-116d5d7-20260730141607), the
same build pinned in hydrogen-preview/.

- services/shopify/client: createStorefrontClient({type: "public"}) with a
  static request context. Two module-scoped clients — uncached for carts,
  products and customers; revalidate-3600 for shop policies — using the
  client's custom fetch option to carry Next's caching hints.
- graphql/*: every document wrapped in gql(), fragments composed via the
  second argument instead of string interpolation, and $country/$language
  declared with @inContext so hydrogen injects them.
- shopifyFetch keeps its {query, variables} call shape so call sites are
  unchanged, but is now generic over the document, so data is inferred. It
  re-raises GraphQL errors, which hydrogen returns rather than throws.

Env var names, the 2025-07 API version pin, and the client-side fetching
architecture are unchanged.

Turning on type coverage surfaced real defects, not just annotations:

- hydrogen gql check caught $discountCodes: [String!] used where the field
  requires [String!]!.
- Cart and customer mutation payloads are nullable and were dereferenced
  unconditionally, so a failed mutation threw a TypeError. Adds a shared
  unwrapCartPayload helper (collapsing five copies of the same userErrors
  check) and explicit null handling in the customer service, so a null
  payload reads as an error rather than success with no errors.
- Search results are a Product | Page | Article union; adds __typename to
  the queries and narrows on it.
- Widens nullable fields (altText, image, customer.email, totalTaxAmount)
  in the domain interfaces and in the structural duplicates some
  components declare locally.

Adds a typecheck script (tsc --noEmit && hydrogen gql check); it passes
with 0 errors. Two deprecation warnings are left alone as acting on them
would change behaviour: ProductOption.values and CartCost.totalTaxAmount.

Verified against mock.shop: build prerenders the policy pages through the
cached client, and in the browser the product grid, search with facets,
collection filter round-trip, add-to-cart and quantity update all work.
Customer account flows are untested — they need real credentials.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01JaxgqPbFxLsSuLPZom2kdC
2026-08-08 10:24:38 -04:00

433 lines
11 KiB
TypeScript

'use client';
import { create } from 'zustand';
import { shopifyFetch } from '@/services/shopify/client';
import {
CREATE_CART_MUTATION,
ADD_CART_LINES_MUTATION,
UPDATE_CART_LINES_MUTATION,
REMOVE_CART_LINES_MUTATION,
UPDATE_CART_DISCOUNT_CODES_MUTATION,
GET_CART_QUERY,
} from '@/graphql/cart';
import { useEffect } from 'react';
// ─── Types ───────────────────────────────────────────────────────────
export interface CartLineInput {
merchandiseId: string;
quantity: number;
}
export interface CartLineUpdateInput {
id: string;
quantity: number;
}
interface CartLine {
id: string;
quantity: number;
cost: {
totalAmount: {
amount: string;
currencyCode: string;
};
};
merchandise: {
id: string;
title: string;
selectedOptions: Array<{
name: string;
value: string;
}>;
price: {
amount: string;
currencyCode: string;
};
image?: {
id?: string | null;
url: string;
altText?: string | null;
width?: number | null;
height?: number | null;
} | null;
product: {
id: string;
title: string;
handle: string;
vendor?: string;
};
};
}
export interface CartDiscountCode {
code: string;
applicable: boolean;
}
export interface Cart {
id: string;
checkoutUrl: string;
totalQuantity: number;
discountCodes?: CartDiscountCode[];
cost: {
subtotalAmount: {
amount: string;
currencyCode: string;
};
totalAmount: {
amount: string;
currencyCode: string;
};
totalTaxAmount?: {
amount: string;
currencyCode: string;
} | null;
};
lines: {
edges: Array<{
node: CartLine;
}>;
};
}
// ─── Shopify API functions ───────────────────────────────────────────
/**
* Every cart mutation returns the same `{ cart, userErrors }` payload, and both
* the payload and the cart inside it are nullable — Shopify returns no cart when
* the mutation could not be applied. Callers want a cart or an exception.
*/
function unwrapCartPayload<T>(
payload:
| {
cart?: T | null;
userErrors: ReadonlyArray<{ message: string }>;
}
| null
| undefined
): T {
if (payload?.userErrors.length) {
throw new Error(payload.userErrors[0].message);
}
if (!payload?.cart) {
throw new Error('Cart update failed. Please try again.');
}
return payload.cart;
}
async function createCartApi(lines: CartLineInput[] = []): Promise<Cart> {
const response = await shopifyFetch({
query: CREATE_CART_MUTATION,
variables: { lines: lines.length > 0 ? lines : null },
});
return unwrapCartPayload(response.data.cartCreate);
}
async function addCartLinesApi(
cartId: string,
lines: CartLineInput[]
): Promise<Cart> {
const response = await shopifyFetch({
query: ADD_CART_LINES_MUTATION,
variables: { cartId, lines },
});
return unwrapCartPayload(response.data.cartLinesAdd);
}
async function updateCartLinesApi(
cartId: string,
lines: CartLineUpdateInput[]
): Promise<Cart> {
const response = await shopifyFetch({
query: UPDATE_CART_LINES_MUTATION,
variables: { cartId, lines },
});
return unwrapCartPayload(response.data.cartLinesUpdate);
}
async function removeCartLinesApi(
cartId: string,
lineIds: string[]
): Promise<Cart> {
const response = await shopifyFetch({
query: REMOVE_CART_LINES_MUTATION,
variables: { cartId, lineIds },
});
return unwrapCartPayload(response.data.cartLinesRemove);
}
async function updateCartDiscountCodesApi(
cartId: string,
discountCodes: string[]
): Promise<Cart> {
const response = await shopifyFetch({
query: UPDATE_CART_DISCOUNT_CODES_MUTATION,
variables: { cartId, discountCodes },
});
return unwrapCartPayload(response.data.cartDiscountCodesUpdate);
}
async function getCartApi(cartId: string): Promise<Cart | null> {
const response = await shopifyFetch({
query: GET_CART_QUERY,
variables: { cartId },
});
return response.data.cart;
}
export function redirectToCheckout(checkoutUrl: string): void {
if (checkoutUrl) {
window.location.href = checkoutUrl;
}
}
// ─── Zustand Store ───────────────────────────────────────────────────
const CART_ID_KEY = 'cartId';
interface CartState {
// State
isOpen: boolean;
cartId: string | null;
cart: Cart | null;
loading: boolean;
error: string | null;
_initialized: boolean;
// Computed (derived in the hook)
// items, itemCount, totalAmount, checkoutUrl
// Actions
openCart: () => void;
closeCart: () => void;
toggleCart: () => void;
initCart: () => void;
addItem: (variantId: string, quantity?: number) => Promise<Cart>;
removeItem: (lineId: string) => Promise<Cart>;
updateItemQuantity: (lineId: string, quantity: number) => Promise<Cart>;
applyDiscountCode: (code: string) => Promise<Cart>;
refreshCart: () => Promise<void>;
}
export const useCartStore = create<CartState>((set, get) => ({
// Initial state
isOpen: false,
cartId: null,
cart: null,
loading: true,
error: null,
_initialized: false,
// UI actions
openCart: () => set({ isOpen: true }),
closeCart: () => set({ isOpen: false }),
toggleCart: () => set((s) => ({ isOpen: !s.isOpen })),
// Initialize cart from localStorage
initCart: () => {
if (get()._initialized) return;
set({ _initialized: true });
if (typeof window === 'undefined') return;
const storedCartId = localStorage.getItem(CART_ID_KEY);
if (!storedCartId) {
set({ loading: false });
return;
}
set({ loading: true });
getCartApi(storedCartId)
.then((fetchedCart) => {
if (fetchedCart) {
set({ cart: fetchedCart, cartId: storedCartId, loading: false });
} else {
localStorage.removeItem(CART_ID_KEY);
set({ cartId: null, cart: null, loading: false });
}
})
.catch(() => {
localStorage.removeItem(CART_ID_KEY);
set({
cartId: null,
cart: null,
loading: false,
error: 'Failed to fetch cart',
});
});
},
// Add item to cart (creates cart if needed)
addItem: async (variantId: string, quantity: number = 1) => {
try {
set({ loading: true, error: null });
// Get or create cart
let currentCartId = get().cartId;
if (!currentCartId) {
const storedCartId = localStorage.getItem(CART_ID_KEY);
if (storedCartId) {
currentCartId = storedCartId;
set({ cartId: storedCartId });
} else {
const newCart = await createCartApi();
localStorage.setItem(CART_ID_KEY, newCart.id);
set({ cart: newCart, cartId: newCart.id });
currentCartId = newCart.id;
}
}
const updatedCart = await addCartLinesApi(currentCartId, [
{ merchandiseId: variantId, quantity },
]);
set({ cart: updatedCart, loading: false });
return updatedCart;
} catch (err) {
const errorMessage =
err instanceof Error ? err.message : 'Failed to add item to cart';
set({ error: errorMessage, loading: false });
throw err;
}
},
// Remove item from cart
removeItem: async (lineId: string) => {
const { cartId } = get();
if (!cartId) throw new Error('No cart exists');
try {
set({ loading: true, error: null });
const updatedCart = await removeCartLinesApi(cartId, [lineId]);
set({ cart: updatedCart, loading: false });
return updatedCart;
} catch (err) {
const errorMessage =
err instanceof Error ? err.message : 'Failed to remove item from cart';
set({ error: errorMessage, loading: false });
throw err;
}
},
// Update item quantity
updateItemQuantity: async (lineId: string, quantity: number) => {
const { cartId, removeItem } = get();
if (!cartId) throw new Error('No cart exists');
if (quantity <= 0) {
return removeItem(lineId);
}
try {
set({ loading: true, error: null });
const updatedCart = await updateCartLinesApi(cartId, [
{ id: lineId, quantity },
]);
set({ cart: updatedCart, loading: false });
return updatedCart;
} catch (err) {
const errorMessage =
err instanceof Error ? err.message : 'Failed to update item quantity';
set({ error: errorMessage, loading: false });
throw err;
}
},
// Apply a discount code. Shopify accepts unknown codes and reports them back
// as `applicable: false`, so callers should check the returned cart.
applyDiscountCode: async (code: string) => {
const { cartId } = get();
if (!cartId) throw new Error('No cart exists');
try {
set({ loading: true, error: null });
const trimmed = code.trim();
const updatedCart = await updateCartDiscountCodesApi(
cartId,
trimmed ? [trimmed] : []
);
set({ cart: updatedCart, loading: false });
return updatedCart;
} catch (err) {
const errorMessage =
err instanceof Error ? err.message : 'Failed to apply discount code';
set({ error: errorMessage, loading: false });
throw err;
}
},
// Refresh cart from Shopify
refreshCart: async () => {
const storedCartId = localStorage.getItem(CART_ID_KEY);
if (!storedCartId) {
set({ loading: false });
return;
}
try {
set({ loading: true, error: null });
const fetchedCart = await getCartApi(storedCartId);
if (fetchedCart) {
set({ cart: fetchedCart, cartId: storedCartId, loading: false });
} else {
localStorage.removeItem(CART_ID_KEY);
set({ cartId: null, cart: null, loading: false });
}
} catch (err) {
localStorage.removeItem(CART_ID_KEY);
set({
cartId: null,
cart: null,
loading: false,
error: 'Failed to fetch cart',
});
}
},
}));
// ─── Hook (backwards-compatible API) ─────────────────────────────────
export function useShopifyCart() {
const store = useCartStore();
// Initialize cart safely in an effect, not during render
useEffect(() => {
if (!store._initialized) {
store.initCart();
}
}, []);
const items = store.cart?.lines?.edges?.map((edge) => edge.node) ?? [];
const itemCount = items.reduce((sum, item) => sum + item.quantity, 0);
const totalAmount = parseFloat(store.cart?.cost?.totalAmount?.amount ?? '0');
const checkoutUrl = store.cart?.checkoutUrl ?? null;
return {
isOpen: store.isOpen,
openCart: store.openCart,
closeCart: store.closeCart,
toggleCart: store.toggleCart,
cartId: store.cartId,
cart: store.cart,
items,
itemCount,
totalAmount,
checkoutUrl,
loading: store.loading,
error: store.error,
addItem: store.addItem,
removeItem: store.removeItem,
updateItemQuantity: store.updateItemQuantity,
applyDiscountCode: store.applyDiscountCode,
refreshCart: store.refreshCart,
};
}