@godaddy/gd-commerce-storefront 0.1.3 → 0.3.0

package/README.md

@@ -84,9 +84,9 @@ A connection failure leaves the surrounding application and its state mounted. C
 
 The stylesheet includes all required utilities and scopes them to the package's surfaces. The build removes CSS layer wrappers in their declared order, so the exported CSS can pass through a host Tailwind v3 PostCSS pipeline without `@tailwind` directives. Import it directly; consumers do not need to copy or rewrite the CSS. It does not add a global reset or require dependency scanning by a host Tailwind build. The `theme` prop reaches the drawer even though it is portalled into `document.body`.
 
-By default, `.commerce-storefront` wrappers do not paint a background and inherit the host's text color. Set page and section backgrounds on the host application's layout elements. `--commerce-surface` colors controls and the opaque cart drawer, and supplies the base for muted colors; it does not color component wrappers. Set `--commerce-surface` and `--commerce-text` together to adapt controls and the drawer to a dark theme. Avoid setting wrapper backgrounds through CSS or the `theme` prop's `background`, `backgroundColor`, or `backgroundImage` properties, which can still override the transparent default. Descendants inherit the surface text and body font instead of global heading styles. Keep text, controls and focus indicators accessible when changing colors. Utility class names and internal markup are not a customization API.
+By default, `.commerce-storefront` wrappers do not paint a background and inherit the host's text color. Set page and section backgrounds on the host application's layout elements. `--commerce-surface` colors controls and the opaque cart drawer, and supplies the base for muted colors; it does not color component wrappers. Set `--commerce-surface` and `--commerce-text` together to adapt controls and the drawer to a dark theme. Avoid setting wrapper backgrounds through CSS or the `theme` prop's `background`, `backgroundColor`, or `backgroundImage` properties, which can still override the transparent default. Descendants inherit the surface text and body font instead of global heading styles. Keep text, controls and focus indicators accessible when changing colors. Internal utility class names and markup are not a customization API; use the [product parts](#custom-product-layouts) to change a product page's layout.
 
-The first release uses English UI text and `en-US` currency formatting. Catalog title and description are configurable. Full localization and arbitrary component slots are outside this initial API.
+The first release uses English UI text and `en-US` currency formatting. Catalog title and description are configurable. Full localization is outside this initial API.
 
 ## Compatibility
 
@@ -101,6 +101,7 @@ The repository example uses React Router 7. Follow each router version's own Rea
 | `CommerceStorefront` | Recommended integration: provider and one drawer |
 | `Catalog` | Six products per cursor page, with `title`, `description`, and `showHeader` props |
 | `ProductDetails` | Reads `:productId`; validates URL option selections against catalog results |
+| `ProductDetailsRoot` and product parts | Build a [custom product layout](#custom-product-layouts) with the same rules as `ProductDetails` |
 | `ProductCard` | Renders one `SKUGroup` with direct add or a product-details link |
 | `CartButton` | Opens the shared drawer and displays item count |
 | `AddToCartButton` | Adds a verified `sku`, `name`, and optional integer `quantity` |
@@ -112,6 +113,71 @@ The package exports TypeScript catalog/cart response types and selection/summary
 
 `Catalog` renders its `title` as an H1 by default. When the host page owns its semantic heading, render that page H1 and pass `showHeader={false}` so the document still has exactly one H1.
 
+## Custom product layouts
+
+`ProductDetails` is the recommended product page. When its layout does not fit, compose the same parts inside `ProductDetailsRoot`. The root loads the route's `:productId` and shows the connection, loading, error and not-found states itself, so parts render only once the product exists. This is the packaged layout, written out:
+
+```tsx
+import {
+  ProductDetailsBackLink, ProductDetailsDescription, ProductDetailsGallery, ProductDetailsPrice,
+  ProductDetailsPurchase, ProductDetailsRoot, ProductDetailsTitle,
+} from '@godaddy/gd-commerce-storefront';
+
+<ProductDetailsRoot>
+  <ProductDetailsBackLink className='mb-8 sm:mb-10' />
+  <div className='grid items-start gap-8 lg:grid-cols-12 lg:gap-12'>
+    <ProductDetailsGallery className='min-w-0 lg:col-span-7' />
+    <div className='min-w-0 lg:col-span-5 lg:py-4'>
+      <ProductDetailsTitle />
+      <ProductDetailsPrice className='mt-6' />
+      <ProductDetailsDescription className='my-8' />
+      <ProductDetailsPurchase className='border-t border-neutral-200 pt-8' />
+    </div>
+  </div>
+</ProductDetailsRoot>
+```
+
+The grid, spacing and border classes come from your own stylesheet in a custom layout. Without them, the parts stack in one column with no space between them.
+
+Add your own elements between parts, reorder them, or leave out display parts. `ProductDetailsPurchase` renders the purchase parts below in order. Replace it with individual parts to place options apart from the add button:
+
+| Part | Renders |
+| --- | --- |
+| `ProductDetailsOptions` | A select for every attribute, or the SKU list for products without attributes |
+| `ProductDetailsOption` | A select for one attribute, by `attribute` name; nothing when the product lacks it |
+| `ProductDetailsPurchaseStatus` | The one message explaining why the selection is not purchasable yet; nothing when ready |
+| `ProductDetailsAvailability`, `ProductDetailsQuantity` | Stock and quantity for the verified SKU; nothing before verification |
+| `ProductDetailsAddToCart` | Adds the verified SKU and quantity; before a SKU is verified, its accessible description gives the reason |
+
+Every part is named `ProductDetails*` because it works only inside `ProductDetailsRoot`. `AddToCartButton` is the standalone button for a SKU you already have.
+
+Parts read state from the root and take no product, SKU, price or quantity props. Whatever the layout, only a server-verified SKU can be added, and changing a selection resets the quantity and image. Every part throws if it is rendered outside `ProductDetailsRoot`. In development builds, if no control is rendered for an attribute the product requires, a console warning names the missing ones. A control that mounts later, such as one in a closed accordion, can trigger it; the product becomes purchasable once the control renders. Products without attributes but with several SKUs need `ProductDetailsOptions` or `ProductDetailsPurchase`. Parts can be rendered more than once, such as in a sticky mobile purchase bar; each copy gets its own element IDs.
+
+Every part accepts `className`, which is added to the part's outer element, a wrapper the package's CSS reset leaves alone. Host classes there control margin, padding, border, color, width and grid placement, including layered utilities such as Tailwind v4's. The packaged layout sets its spacing and grid placement this way. Elements inside the part, such as the title's `<h1>`, keep the package's own styles: a host font size on `ProductDetailsTitle` does not change the heading's size, but a host color does reach it, because the heading inherits its color.
+
+Two hooks support custom parts inside the root:
+
+- `useProductDetails()` returns read-only `product`, `name`, `selectedSku`, `quantity`, `availableQuantity`, `images` and `status` (`incomplete`, `checking`, `variant-error`, `unavailable`, `not-purchasable` or `ready`). `selectedSku` is set only when `status` is `ready`.
+- `useProductDetailsOption(attribute)` returns `{ name, label, selected, values, select }` for building swatches or buttons, or `null` when the product has no such attribute. `select(value)` accepts only that attribute's value names, or `null` to clear. Other values are ignored. A hook-based control counts toward the layout check.
+
+```tsx
+function ColorSwatches() {
+  const color = useProductDetailsOption('color');
+  if (!color) return null;
+  return (
+    <div role='group' aria-label={color.label}>
+      {color.values.map((value) => (
+        <button key={value.name} type='button' aria-pressed={value.selected} onClick={() => color.select(value.name)}>
+          {value.label}
+        </button>
+      ))}
+    </div>
+  );
+}
+```
+
+Parts are flat named exports, not properties such as `ProductDetails.Title`, so each one is an ordinary module export.
+
 ## How it works
 
 Products are SKU groups. The package purchases only an unambiguous SKU, verifies all selected attributes through the server, uses SKU prices/images, and distinguishes untracked inventory from sold-out inventory. Server-side inventory and pricing checks remain mandatory.
@@ -144,3 +210,45 @@ Build before testing: artifact tests check the compiled JavaScript and shipped C
 ## License
 
 [MIT](LICENSE.md).
+
+### Before a store is connected
+
+A site can mount the same components before it has a connected store:
+
+```tsx
+<CommerceStorefront theme={theme}>
+  <Header><CartButton /></Header>
+  <Catalog sampleProducts />
+</CommerceStorefront>
+```
+
+`Catalog.sampleProducts` defaults to `false`. It allows six built-in sample products
+(Product 1–6, $10–$60 USD) **only** when `/api/commerce/config` reports `state: 'unbound'`.
+When a store is connected, the server reports a different state and the components show real
+products. You do not need to change props or the component tree. The prop has no effect while
+a store is connected. Real empty catalogs and errors never fall back to samples.
+
+The sample cart supports adding items, changing quantities (1–999), removing items, and an
+example subtotal. It uses the existing drawer and theme, keeps its items during navigation under
+the shared provider, and resets on reload, unmount, or any change away from `unbound`. It uses no
+live cart storage and makes no product, cart, checkout, or upstream Commerce requests.
+Configuration reads continue. Sample entries are not SKUs or draft orders and never move into a
+real cart. Checkout is unavailable, including direct `useCommerce().checkout()` calls.
+
+`useCommerce().connection` now includes `unbound` and `connecting` in addition to `loading`,
+`ready`, and `error`. Only `ready` means a usable store connection. The public `cart` and live
+mutation methods apply only to the connected store; sample cart data is internal. A catalog
+without `sampleProducts`, and direct product-detail visits, show the unconnected state.
+Sample grids and drawers have the attribute `data-commerce-source="sample"`.
+
+The provider reads configuration on mount and focus, and every five seconds while the page is
+visible and the state is `unbound` or `connecting`. The first failed refresh hides samples and
+clears the sample cart; a later `unbound` response starts an empty sample cart. While
+connecting, refresh failures keep the connecting state for up to 60 seconds before showing
+the error. Polling stops
+when the state is `ready`; focus and explicit retry still refresh configuration.
+
+Use a server that reports connection state before you enable `sampleProducts`. Successful
+config responses without `state` still mean ready. A server that does not report `unbound`
+never shows samples. See the [server contract](docs/server-api.md) for the host's
+responsibilities.

package/dist/index.d.ts

@@ -325,12 +325,14 @@ interface CatalogProps {
   title?: string;
   description?: string;
   showHeader?: boolean;
+  /** Permit built-in examples only while the host confirms this site is unbound. */
+  sampleProducts?: boolean;
 }
 declare function Catalog(props: CatalogProps): ReactElement;
 //#endregion
 //#region src/commerce-provider.d.ts
 interface CommerceContextValue {
-  connection: 'loading' | 'ready' | 'error';
+  connection: 'loading' | 'unbound' | 'connecting' | 'ready' | 'error';
   connectionError: string | null;
   retryConnection: () => void;
   theme: StorefrontTheme;
@@ -385,10 +387,115 @@ declare function CommerceStorefront({
   ...props
 }: CommerceProviderProps): react_jsx_runtime0.JSX.Element;
 //#endregion
+//#region src/product-details-context.d.ts
+/** Where the shopper is in choosing a purchasable SKU. Only `ready` has a verified `selectedSku`. */
+type ProductDetailsStatus = 'incomplete' | 'checking' | 'variant-error' | 'unavailable' | 'not-purchasable' | 'ready';
+/** Read-only product state for custom parts rendered inside `ProductDetailsRoot`. */
+interface ProductDetailsState {
+  readonly product: SKUGroup;
+  readonly name: string;
+  /** Set only after the server verifies the full selection. */
+  readonly selectedSku: SKU | null;
+  readonly quantity: number;
+  /** `null` means inventory is not tracked; `0` means sold out. */
+  readonly availableQuantity: number | null;
+  readonly status: ProductDetailsStatus;
+  readonly images: readonly string[];
+}
+/** Props shared by every product part. `className` is added to the part's outer element. */
+interface ProductDetailsPartProps {
+  className?: string;
+}
+/** Read the current product, verified SKU, and purchase status from inside `ProductDetailsRoot`. */
+declare function useProductDetails(): ProductDetailsState;
+interface ProductDetailsOptionValueState {
+  readonly name: string;
+  readonly label: string;
+  readonly selected: boolean;
+}
+interface ProductDetailsOptionState {
+  readonly name: string;
+  readonly label: string;
+  readonly selected: string | null;
+  readonly values: readonly ProductDetailsOptionValueState[];
+  /** Accepts only this attribute's own value names, or `null` to clear. Other values are ignored. */
+  readonly select: (value: string | null) => void;
+}
+/**
+ * Build a custom control for one product attribute. Returns `null` when the product has no such attribute.
+ * A selection is never purchasable until the server verifies it.
+ */
+declare function useProductDetailsOption(attribute: string): ProductDetailsOptionState | null;
+interface ProductDetailsRootProps {
+  children: ReactNode;
+  /** Added to the root `<article>`. */
+  className?: string;
+}
+/** Loads the product for the route's `:productId` and provides state to product parts. */
+declare function ProductDetailsRoot({
+  children,
+  className
+}: ProductDetailsRootProps): ReactElement;
+//#endregion
 //#region src/product-details.d.ts
+/** The packaged product page for `${productPath}/:productId`. Compose the parts for a custom layout. */
 declare function ProductDetails(): ReactElement;
+declare function ProductDetailsBackLink({
+  className
+}: ProductDetailsPartProps): ReactElement;
+/** Main image with thumbnails; the selected SKU's images replace the product's when present. */
+declare function ProductDetailsGallery({
+  className
+}: ProductDetailsPartProps): ReactElement;
+/** The product name as the page's H1. */
+declare function ProductDetailsTitle({
+  className
+}: ProductDetailsPartProps): ReactElement;
+/** The verified SKU's price and compare-at price, or the product's starting price. */
+declare function ProductDetailsPrice({
+  className
+}: ProductDetailsPartProps): ReactElement;
+/** The verified SKU's description, or the product's. */
+declare function ProductDetailsDescription({
+  className
+}: ProductDetailsPartProps): ReactElement;
+//#endregion
+//#region src/product-purchase.d.ts
+/** The packaged purchase area: options, status, availability, quantity, and add to cart. */
+declare function ProductDetailsPurchase({
+  className
+}: ProductDetailsPartProps): ReactElement;
+/** A select for every product attribute, or the SKU list for products without attributes. */
+declare function ProductDetailsOptions({
+  className
+}: ProductDetailsPartProps): ReactElement | null;
+interface ProductDetailsOptionProps extends ProductDetailsPartProps {
+  /** The attribute `name`, such as `color`. Renders nothing when the product has no such attribute. */
+  attribute: string;
+}
+/** A select for one product attribute. Use `useProductDetailsOption` for swatches or other custom controls. */
+declare function ProductDetailsOption({
+  attribute,
+  className
+}: ProductDetailsOptionProps): ReactElement | null;
+/** The single message explaining why the selection is not yet purchasable. Renders nothing when ready. */
+declare function ProductDetailsPurchaseStatus({
+  className
+}: ProductDetailsPartProps): ReactElement | null;
+/** Stock for the verified SKU. Renders nothing until a SKU is verified. */
+declare function ProductDetailsAvailability({
+  className
+}: ProductDetailsPartProps): ReactElement | null;
+/** Quantity for the verified SKU. Renders nothing until a SKU is verified. */
+declare function ProductDetailsQuantity({
+  className
+}: ProductDetailsPartProps): ReactElement | null;
+/** Adds the verified SKU and quantity. While disabled, its accessible description says why. */
+declare function ProductDetailsAddToCart({
+  className
+}: ProductDetailsPartProps): ReactElement;
 //#endregion
 //#region src/storefront-surface.d.ts
 declare function CommerceStatus(): ReactElement | null;
 //#endregion
-export { AddToCartButton, AddToCartItemInput, ApiError, CartAddress, CartButton, CartDiscount, CartDrawer, CartLineItem, CartLineItemDetails, CartNote, CartOrder, CartSelectedAddon, CartSelectedAddonValue, CartSelectedOption, CartShippingInfo, CartSummaryTotals, CartTax, Catalog, type CatalogProps, type CommerceContextValue, CommerceProvider, type CommerceProviderProps, CommerceStatus, CommerceStorefront, Connection, ConnectionEdge, DraftOrderContext, InventoryCount, LabelFilter, LineItemTotals, MediaObject, Money, OrderTotals, PageInfo, PriceRange, ProductCard, ProductDetails, ProductDetailsVariablesInput, ProductGridVariablesInput, SKU, SKUAttributeValue, SKUGroup, SKUGroupAttribute, SKUGroupAttributeValue, SKUGroupSKU, SKUPrice, SkuGroupResult, SkuGroupVariables, SkuGroupsResult, SkuGroupsVariables, SkuResult, SkuVariables, type StorefrontConfig, StorefrontProductAttribute, StorefrontProductAttributeValue, type StorefrontTheme, StringInFilter, addToCart, getAvailableInventoryQuantity, getCartSummaryTotals, getImageUrls, getLabeledSkuOptions, getPrimaryImageUrl, getProductAttributes, getSingleMatchedSku, getSingleMatchedSkuId, money, useCommerce };
+export { AddToCartButton, AddToCartItemInput, ApiError, CartAddress, CartButton, CartDiscount, CartDrawer, CartLineItem, CartLineItemDetails, CartNote, CartOrder, CartSelectedAddon, CartSelectedAddonValue, CartSelectedOption, CartShippingInfo, CartSummaryTotals, CartTax, Catalog, type CatalogProps, type CommerceContextValue, CommerceProvider, type CommerceProviderProps, CommerceStatus, CommerceStorefront, Connection, ConnectionEdge, DraftOrderContext, InventoryCount, LabelFilter, LineItemTotals, MediaObject, Money, OrderTotals, PageInfo, PriceRange, ProductCard, ProductDetails, ProductDetailsAddToCart, ProductDetailsAvailability, ProductDetailsBackLink, ProductDetailsDescription, ProductDetailsGallery, ProductDetailsOption, type ProductDetailsOptionProps, type ProductDetailsOptionState, type ProductDetailsOptionValueState, ProductDetailsOptions, type ProductDetailsPartProps, ProductDetailsPrice, ProductDetailsPurchase, ProductDetailsPurchaseStatus, ProductDetailsQuantity, ProductDetailsRoot, type ProductDetailsRootProps, type ProductDetailsState, type ProductDetailsStatus, ProductDetailsTitle, ProductDetailsVariablesInput, ProductGridVariablesInput, SKU, SKUAttributeValue, SKUGroup, SKUGroupAttribute, SKUGroupAttributeValue, SKUGroupSKU, SKUPrice, SkuGroupResult, SkuGroupVariables, SkuGroupsResult, SkuGroupsVariables, SkuResult, SkuVariables, type StorefrontConfig, StorefrontProductAttribute, StorefrontProductAttributeValue, type StorefrontTheme, StringInFilter, addToCart, getAvailableInventoryQuantity, getCartSummaryTotals, getImageUrls, getLabeledSkuOptions, getPrimaryImageUrl, getProductAttributes, getSingleMatchedSku, getSingleMatchedSkuId, money, useCommerce, useProductDetails, useProductDetailsOption };