@godaddy/gd-commerce-storefront 0.6.0 → 0.8.0

package/dist/index.d.ts

@@ -304,6 +304,23 @@ declare function getPrimaryImageUrl(item: MediaObjectContainer | null | undefine
 declare function getProductAttributes(skuGroup: SKUGroup | null | undefined): StorefrontProductAttribute[];
 /** The product's display name: its label, then its name. */
 declare function getProductName(skuGroup: SKUGroup): string;
+/** Lowercases a label for use mid-sentence, leaving acronyms alone: "Size" becomes "size", "US Size" stays. */
+declare const inSentence: (label: string) => string;
+/** Whether `compareAt` is above `price`, so the price is a sale price. */
+declare function isOnSale(price: number | null | undefined, compareAt: number | null | undefined): boolean;
+/**
+ * Whether some SKU's compare-at price is above that SKU's own price. Without every SKU's price, only a product whose
+ * lowest compare-at price is above its highest price is certainly on sale, so other products show no badge.
+ */
+declare function isProductOnSale(product: SKUGroup | null | undefined): boolean;
+/**
+ * The compare-at price that belongs with the product's starting price, so a struck-through price never pairs one
+ * SKU's price with another SKU's compare-at price. With every SKU and its price loaded, the cheapest SKUs must share
+ * one compare-at price above their price. Otherwise the product needs a single price and a single compare-at price.
+ */
+declare function getStartingCompareAt(product: SKUGroup | null | undefined): number | null;
+/** The SKU's attribute value names, or `null` when the response does not include them. */
+declare function getSkuAttributeValueNames(sku: SKU | null | undefined): string[] | null;
 //#endregion
 //#region src/part.d.ts
 /** Replacement content for a part's text: content, or a function of the part's state. */
@@ -311,12 +328,18 @@ type PartLabel<State> = ReactNode | ((state: State) => ReactNode);
 //#endregion
 //#region src/cart.d.ts
 interface CartButtonProps {
-  /** Replaces the label and count. A function receives the item count. Keep the count in the label. */
+  /**
+   * Replaces the bag icon and count badge with a visible label. A function receives the item count. Keep the count in
+   * the label.
+   */
   children?: PartLabel<{
     itemCount: number;
   }>;
 }
-/** Opens the cart drawer and shows the item count. */
+/**
+ * Opens the cart drawer: a bag icon with a count badge that pops when the count changes. Its accessible name is
+ * "Cart, 2 items". With `children`, a labeled button instead.
+ */
 declare function CartButton({
   children
 }?: CartButtonProps): ReactElement;
@@ -334,12 +357,7 @@ interface AddToCartButtonProps {
   /** Replaces the label. A function receives `busy` and `soldOut`; the button keeps its rules either way. */
   children?: PartLabel<AddToCartLabelState>;
 }
-declare function AddToCartButton({
-  sku,
-  name,
-  quantity,
-  children
-}: AddToCartButtonProps): ReactElement;
+declare function AddToCartButton(props: AddToCartButtonProps): ReactElement;
 //#endregion
 //#region src/cart-state.d.ts
 /** One cart line, for custom cart parts. */
@@ -417,7 +435,10 @@ declare function CartDrawerRoot({
   children,
   className
 }: CartDrawerRootProps): ReactElement;
-/** "Your cart", or "Sample cart" before a store is connected, as an H2. In the drawer it names the dialog. */
+/**
+ * "Your cart", or "Sample cart" before a store is connected, as an H2, with the item count once there are items.
+ * In the drawer it names the dialog.
+ */
 declare function CartTitle({
   className,
   children
@@ -467,7 +488,7 @@ declare function CartItemImage({
 declare function CartItemName({
   className
 }: CartPartProps): ReactElement;
-/** The selected options, one per line, such as "Color: Blue". Renders nothing without options. */
+/** The selected options on one line, such as "Color: Blue · Size: M". Renders nothing without options. */
 declare function CartItemOptions({
   className
 }: CartPartProps): ReactElement | null;
@@ -506,7 +527,7 @@ declare function CartSubtotal({
   className
 }: CartPartProps): ReactElement | null;
 /**
- * "Shipping, taxes, and discounts are calculated at checkout." Has the stable
+ * A row under the subtotal: "Shipping, taxes & discounts", "Calculated at checkout". Has the stable
  * `commerce-cart-checkout-adjustments-note` class. Renders nothing for samples or an empty cart.
  */
 declare function CartCheckoutNote({
@@ -520,6 +541,14 @@ declare function CartCheckout({
   className,
   children
 }: CartActionPartProps): ReactElement | null;
+/**
+ * "Continue shopping": closes the drawer, or on a cart page links to the catalog. Renders nothing for an empty cart,
+ * whose `CartEmpty` links to the catalog.
+ */
+declare function CartContinueShopping({
+  className,
+  children
+}: CartTextPartProps): ReactElement | null;
 /** The packaged cart drawer. Compose `CartDrawerRoot` and the cart parts for a custom drawer. */
 declare function CartDrawer(): ReactElement;
 //#endregion
@@ -588,7 +617,9 @@ declare function CatalogEmpty({
   className,
   children
 }: CatalogEmptyProps): ReactElement | null;
-/** First-page and next-page buttons. Renders nothing for samples, which have one page. */
+/**
+ * First-page and next-page buttons. Renders nothing when there is only one page, including for samples.
+ */
 declare function CatalogPagination({
   className
 }: CatalogPartProps): ReactElement | null;
@@ -619,6 +650,8 @@ interface CommerceContextValue {
   connectionError: string | null;
   retryConnection: () => void;
   theme: StorefrontTheme;
+  /** The host's swatch lookup, or `undefined` when options render as buttons. */
+  getSwatch: GetSwatch | undefined;
   config: StorefrontConfig;
   /** The BCP 47 locale that prices are formatted in, such as `en-US`. */
   locale: string;
@@ -654,13 +687,33 @@ type StorefrontTheme = CSSProperties & {
   '--commerce-surface'?: string;
   '--commerce-text'?: string;
   '--commerce-radius'?: string;
+  /** Fills the Sale badge. Defaults to a red that white text reads on. */
+  '--commerce-sale'?: string;
+  /** Text on the Sale badge. Defaults to white. */
+  '--commerce-on-sale'?: string;
 };
+/** The attribute value a host can give a swatch, such as `{ attribute: 'color', name: 'forest', label: 'Forest' }`. */
+interface SwatchValue {
+  readonly attribute: string;
+  readonly name: string;
+  readonly label: string;
+}
+/**
+ * Returns a CSS `background` for a value, such as `'#3f6352'` or `'url(/swatches/linen.png) center / cover'`, or
+ * nothing for no swatch. An attribute shows swatches only when every value has one.
+ */
+type GetSwatch = (value: SwatchValue) => string | null | undefined;
 interface CommerceProviderProps {
   children: ReactNode;
   catalogPath?: string;
   productPath?: string;
   /** Applied to storefront surfaces and the portalled cart drawer. */
   theme?: StorefrontTheme;
+  /**
+   * Swatches for attribute values, off by default. Attributes whose values all have a swatch render as swatches on
+   * the product page, and cards show them as dots. See `GetSwatch`.
+   */
+  getSwatch?: GetSwatch;
   /** Set only when your server has enabled checkout and this return route exists. */
   checkoutSuccessPath?: string;
   /**
@@ -724,6 +777,7 @@ declare function CommerceProvider({
   productPath,
   checkoutSuccessPath,
   theme,
+  getSwatch,
   locale,
   onItemAdded,
   onEvent
@@ -796,10 +850,24 @@ declare function ProductCardTitle({
 declare function ProductCardDescription({
   className
 }: ProductCardPartProps): ReactElement | null;
-/** The product's price, or its price range when variants differ. */
+/**
+ * "Sale" when some SKU's compare-at price is above that SKU's price. Without SKU prices, as in the catalog list, only
+ * when the lowest compare-at price is above the highest price. Renders nothing otherwise, or for samples.
+ */
+declare function ProductCardBadge({
+  className
+}: ProductCardPartProps): ReactElement | null;
+/** The product's price, or its price range when variants differ. A single price on sale shows its compare-at price. */
 declare function ProductCardPrice({
   className
 }: ProductCardPartProps): ReactElement;
+/**
+ * Dots for the first attribute whose values all have a swatch from the provider's `getSwatch`, such as colors.
+ * Renders nothing without `getSwatch`, for samples, or when no attribute has swatches.
+ */
+declare function ProductCardSwatches({
+  className
+}: ProductCardPartProps): ReactElement | null;
 /** What a card action label can depend on. Only `add` can be busy or sold out. */
 interface ProductCardActionLabelState extends AddToCartLabelState {
   /** `add` adds directly; `choose-options` and `view-product` link to the product page. */
@@ -850,11 +918,20 @@ interface ProductDetailsOptionValueState {
   readonly name: string;
   readonly label: string;
   readonly selected: boolean;
+  /**
+   * Every SKU with this value and the other selected values has tracked stock used up. `false` when that is not
+   * known, such as for a product with more SKUs than the page loads.
+   */
+  readonly soldOut: boolean;
+  /** The CSS background from the provider's `getSwatch`, or `null`. */
+  readonly swatch: string | null;
 }
 interface ProductDetailsOptionState {
   readonly name: string;
   readonly label: string;
   readonly selected: string | null;
+  /** Nothing is selected and the shopper pressed add, so the control should show an error. */
+  readonly missing: boolean;
   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;
@@ -899,7 +976,7 @@ declare function ProductDetailsRoot({
 /** The packaged product page for `${productPath}/:productId`. Compose the parts for a custom layout. */
 declare function ProductDetails(): ReactElement;
 interface ProductDetailsBackLinkProps extends ProductDetailsPartProps {
-  /** Replaces "← Back to shop". */
+  /** Replaces the chevron and "Back to shop". */
   children?: ReactNode;
 }
 /** A link to the catalog. */
@@ -911,11 +988,21 @@ declare function ProductDetailsBackLink({
 declare function ProductDetailsGallery({
   className
 }: ProductDetailsPartProps): ReactElement;
+/**
+ * "Sale" when the verified SKU's compare-at price is above its price, or, before then, when some SKU's is. Renders
+ * nothing otherwise.
+ */
+declare function ProductDetailsBadge({
+  className
+}: ProductDetailsPartProps): ReactElement | null;
 /** 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. */
+/**
+ * The verified SKU's price and compare-at price, or the product's starting price. Before a SKU is verified, the
+ * compare-at price shows only when it belongs to the cheapest SKUs, so it never pairs prices from different SKUs.
+ */
 declare function ProductDetailsPrice({
   className
 }: ProductDetailsPartProps): ReactElement;
@@ -925,11 +1012,11 @@ declare function ProductDetailsDescription({
 }: ProductDetailsPartProps): ReactElement;
 //#endregion
 //#region src/product-purchase.d.ts
-/** The packaged purchase area: options, status, availability, quantity, and add to cart. */
+/** The packaged purchase area: options, status, quantity, add to cart, and availability. */
 declare function ProductDetailsPurchase({
   className
 }: ProductDetailsPartProps): ReactElement;
-/** A select for every product attribute, or the SKU list for products without attributes. */
+/** A control for every product attribute, or the SKU list for products without attributes. */
 declare function ProductDetailsOptions({
   className
 }: ProductDetailsPartProps): ReactElement | null;
@@ -937,12 +1024,18 @@ 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. */
+/**
+ * One product attribute: buttons, swatches when the provider's `getSwatch` gives every value one, or a select for
+ * more than eight values. Use `useProductDetailsOption` for 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. */
+/**
+ * The single message explaining why the selection is not purchasable. Renders nothing when ready, or before every
+ * option is chosen, when the add button names the next one.
+ */
 declare function ProductDetailsPurchaseStatus({
   className
 }: ProductDetailsPartProps): ReactElement | null;
@@ -950,21 +1043,55 @@ declare function ProductDetailsPurchaseStatus({
 declare function ProductDetailsAvailability({
   className
 }: ProductDetailsPartProps): ReactElement | null;
-/** Quantity for the verified SKU, with a message when it cannot be added. Renders nothing until a SKU is verified. */
+/**
+ * A quantity stepper, capped at the verified SKU's stock, with a message when a typed quantity cannot be added.
+ * Disabled while the verified SKU is sold out.
+ */
 declare function ProductDetailsQuantity({
   className
-}: ProductDetailsPartProps): ReactElement | null;
+}: ProductDetailsPartProps): ReactElement;
 interface ProductDetailsAddToCartProps extends ProductDetailsPartProps {
   /** Replaces the button label. A function receives `busy` and `soldOut`; the button keeps its rules either way. */
   children?: PartLabel<AddToCartLabelState>;
 }
-/** Adds the verified SKU and quantity. While disabled, its accessible description says why. */
+/**
+ * Adds the verified SKU and quantity, labeled with the total, such as "Add to cart · $64.00". Until every option is
+ * chosen it names the next one, such as "Select size", and pressing it marks the missing options and focuses the
+ * first. While the selection is checked or unavailable it is disabled, and its accessible description says why.
+ */
 declare function ProductDetailsAddToCart({
   className,
   children
 }: ProductDetailsAddToCartProps): ReactElement;
 //#endregion
+//#region src/related-products.d.ts
+interface RelatedProductsProps {
+  /** The product to leave out. Defaults to the route's `:productId` parameter. */
+  productId?: string;
+  /** The H2. Defaults to "You may also like". */
+  title?: ReactNode;
+  /** The most products to show, a whole number from 1 to 24. Defaults to 4. */
+  limit?: number;
+  /** Added to the root `<section>`. */
+  className?: string;
+  /** One card, rendered for every product. Defaults to the packaged card. */
+  children?: ReactNode;
+}
+/**
+ * Other products from the catalog's first page, leaving out the current one. Optional and separate from
+ * `ProductDetails`: place it wherever it fits, such as after the product page. There is no related-products API, so
+ * the products are the catalog's first ones. Renders nothing until they load, when none are left, if the request
+ * fails, or while no store is connected.
+ */
+declare function RelatedProducts({
+  productId: productIdProp,
+  title,
+  limit,
+  className,
+  children
+}: RelatedProductsProps): ReactElement | null;
+//#endregion
 //#region src/storefront-surface.d.ts
 declare function CommerceStatus(): ReactElement | null;
 //#endregion
-export { AddToCartButton, type AddToCartButtonProps, AddToCartItemInput, type AddToCartLabelState, type AddedCartItem, ApiError, type CartActionPartProps, CartAddress, CartButton, type CartButtonProps, CartCheckout, CartCheckoutNote, CartClose, CartDescription, CartDiscount, CartDrawer, CartDrawerRoot, type CartDrawerRootProps, CartEmpty, type CartEmptyProps, CartItemImage, CartItemName, CartItemOptions, CartItemPrice, CartItemQuantity, CartItemRemove, CartItemRoot, type CartItemRootProps, type CartItemState, CartItems, type CartItemsProps, CartLineItem, CartLineItemDetails, CartNote, CartNotices, CartOrder, type CartPartProps, CartRoot, type CartRootProps, CartSelectedAddon, CartSelectedAddonValue, CartSelectedOption, CartShippingInfo, type CartState, CartSubtotal, CartSummary, type CartSummaryProps, CartSummaryTotals, CartTax, type CartTextPartProps, CartTitle, Catalog, CatalogEmpty, type CatalogEmptyProps, CatalogHeader, type CatalogHeaderProps, CatalogPagination, type CatalogPartProps, CatalogProducts, type CatalogProductsProps, type CatalogProps, CatalogRoot, type CatalogRootProps, CatalogSummary, type CommerceContextValue, type CommerceEvent, type CommerceOperation, CommerceProvider, type CommerceProviderProps, CommerceStatus, CommerceStorefront, Connection, ConnectionEdge, DraftOrderContext, InventoryCount, LabelFilter, LineItemTotals, MediaObject, Money, OrderTotals, PageInfo, type PartLabel, PriceRange, ProductCard, ProductCardAction, type ProductCardActionLabelState, type ProductCardActionProps, ProductCardDescription, ProductCardImage, type ProductCardPartProps, ProductCardPrice, type ProductCardProps, ProductCardRoot, type ProductCardRootProps, type ProductCardState, ProductCardTitle, ProductDetails, ProductDetailsAddToCart, type ProductDetailsAddToCartProps, ProductDetailsAvailability, ProductDetailsBackLink, type ProductDetailsBackLinkProps, ProductDetailsDescription, type ProductDetailsErrorState, 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, ProductImage, type ProductImageProps, 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, getProductName, getSingleMatchedSku, getSingleMatchedSkuId, money, useCart, useCartItem, useCommerce, useMoney, useProductCard, useProductDetails, useProductDetailsOption };
+export { AddToCartButton, type AddToCartButtonProps, AddToCartItemInput, type AddToCartLabelState, type AddedCartItem, ApiError, type CartActionPartProps, CartAddress, CartButton, type CartButtonProps, CartCheckout, CartCheckoutNote, CartClose, CartContinueShopping, CartDescription, CartDiscount, CartDrawer, CartDrawerRoot, type CartDrawerRootProps, CartEmpty, type CartEmptyProps, CartItemImage, CartItemName, CartItemOptions, CartItemPrice, CartItemQuantity, CartItemRemove, CartItemRoot, type CartItemRootProps, type CartItemState, CartItems, type CartItemsProps, CartLineItem, CartLineItemDetails, CartNote, CartNotices, CartOrder, type CartPartProps, CartRoot, type CartRootProps, CartSelectedAddon, CartSelectedAddonValue, CartSelectedOption, CartShippingInfo, type CartState, CartSubtotal, CartSummary, type CartSummaryProps, CartSummaryTotals, CartTax, type CartTextPartProps, CartTitle, Catalog, CatalogEmpty, type CatalogEmptyProps, CatalogHeader, type CatalogHeaderProps, CatalogPagination, type CatalogPartProps, CatalogProducts, type CatalogProductsProps, type CatalogProps, CatalogRoot, type CatalogRootProps, CatalogSummary, type CommerceContextValue, type CommerceEvent, type CommerceOperation, CommerceProvider, type CommerceProviderProps, CommerceStatus, CommerceStorefront, Connection, ConnectionEdge, DraftOrderContext, type GetSwatch, InventoryCount, LabelFilter, LineItemTotals, MediaObject, Money, OrderTotals, PageInfo, type PartLabel, PriceRange, ProductCard, ProductCardAction, type ProductCardActionLabelState, type ProductCardActionProps, ProductCardBadge, ProductCardDescription, ProductCardImage, type ProductCardPartProps, ProductCardPrice, type ProductCardProps, ProductCardRoot, type ProductCardRootProps, type ProductCardState, ProductCardSwatches, ProductCardTitle, ProductDetails, ProductDetailsAddToCart, type ProductDetailsAddToCartProps, ProductDetailsAvailability, ProductDetailsBackLink, type ProductDetailsBackLinkProps, ProductDetailsBadge, ProductDetailsDescription, type ProductDetailsErrorState, 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, ProductImage, type ProductImageProps, RelatedProducts, type RelatedProductsProps, SKU, SKUAttributeValue, SKUGroup, SKUGroupAttribute, SKUGroupAttributeValue, SKUGroupSKU, SKUPrice, SkuGroupResult, SkuGroupVariables, SkuGroupsResult, SkuGroupsVariables, SkuResult, SkuVariables, type StorefrontConfig, StorefrontProductAttribute, StorefrontProductAttributeValue, type StorefrontTheme, StringInFilter, type SwatchValue, addToCart, getAvailableInventoryQuantity, getCartSummaryTotals, getImageUrls, getLabeledSkuOptions, getPrimaryImageUrl, getProductAttributes, getProductName, getSingleMatchedSku, getSingleMatchedSkuId, getSkuAttributeValueNames, getStartingCompareAt, inSentence, isOnSale, isProductOnSale, money, useCart, useCartItem, useCommerce, useMoney, useProductCard, useProductDetails, useProductDetailsOption };