@behio/storefront-sdk 2.13.0 → 2.14.1

package/dist/react.d.ts

@@ -564,7 +564,7 @@ interface ProductLabel {
     id: string;
     slug: string;
     name: string;
-    color?: string;
+    color?: string | null;
     /** Merchant icon name. Render a trusted local icon, with a safe fallback. */
     iconName?: string | null;
 }
@@ -594,9 +594,9 @@ interface ProductListItem {
     id: string;
     slug: string;
     name: string;
-    shortDescription?: string;
+    shortDescription?: string | null;
     sku: string;
-    gtin?: string;
+    gtin?: string | null;
     /** `null` when prices are gated behind login for guests (B2B mode). */
     price: ProductPrice | null;
     inStock: boolean;
@@ -685,6 +685,9 @@ interface ProductListItem {
         url: string;
         alt: string | null;
         order: number;
+        /** COVER | LISTING | HOVER | GALLERY when the cover came from a roled
+         *  product image; absent when it came from the inventory gallery (SDK 2.14.0). */
+        role?: string;
     } | null;
     labels: ProductLabel[];
     isFeatured: boolean;
@@ -899,7 +902,19 @@ interface ProductDetail extends ProductListItem {
      *  null when uncapped or the shop hides stock counts. Cap the PDP quantity
      *  stepper with it, it is exactly the cart rule. SDK 2.13.0. */
     maxPurchasableQuantity?: number | null;
-    longDescription?: string;
+    /**
+     * @deprecated Not sent on the product detail, only on list cards. Use
+     * `media` (or `images`) for the gallery.
+     */
+    image?: ProductListItem["image"];
+    /** @deprecated Not sent on the product detail, only on list cards. */
+    hoverImageUrl?: string | null;
+    /**
+     * @deprecated Not sent on the product detail, only on list cards. Read the
+     * PDP promotions with `catalog.getProductPromotions(slug)`.
+     */
+    activePromotion?: ProductPromotionSummary | null;
+    longDescription?: string | null;
     /**
      * @deprecated Legacy per-listing images. Prefer `media`. Each carries its
      * `role` (COVER | LISTING | HOVER | GALLERY) so the storefront can pick a
@@ -907,7 +922,7 @@ interface ProductDetail extends ProductListItem {
      */
     images: Array<{
         url: string;
-        alt?: string;
+        alt?: string | null;
         order: number;
         role?: string;
     }>;
@@ -975,6 +990,10 @@ interface ProductDetail extends ProductListItem {
         ogDescription?: string | null;
         ogImage?: string | null;
     };
+    /**
+     * @deprecated Never sent by the API. Load a group with
+     * `catalog.getProductGroup(slug)`.
+     */
     productGroups?: Array<{
         slug: string;
         name: string;
@@ -996,8 +1015,8 @@ interface Category {
     id: string;
     slug: string;
     name: string;
-    description?: string;
-    imageUrl?: string;
+    description?: string | null;
+    imageUrl?: string | null;
     children: Category[];
     productCount?: number;
 }
@@ -1060,11 +1079,18 @@ interface Menu {
     locale: string;
     items: MenuItem[];
 }
-interface CategoryDetail extends Category {
+interface CategoryDetail extends Omit<Category, "children"> {
+    /**
+     * @deprecated Never sent on the category detail (it was typed as always
+     * present, so `children.map` crashed). Read subcategories from
+     * `catalog.getCategories()`.
+     */
+    children?: Category[];
     /**
      * SEO/Open Graph for the category page. Matches the backend's nested `seo`
      * shape (the old flat `seoTitle`/`seoDescription` never matched what the API
-     * returned). `keywords` is always null for categories.
+     * returned). `keywords` is always null for categories. Null when the
+     * category has no text in the requested language (SDK 2.14.0 types it).
      */
     seo?: {
         title?: string | null;
@@ -1073,7 +1099,7 @@ interface CategoryDetail extends Category {
         ogTitle?: string | null;
         ogDescription?: string | null;
         ogImage?: string | null;
-    };
+    } | null;
 }
 /**
  * One available filter, derived from a curated parameter the merchant marked
@@ -1091,7 +1117,7 @@ interface FilterField {
     groupSlug: string;
     groupName: string;
     unit?: string | null;
-    values?: string[];
+    values?: string[] | null;
 }
 interface FacetValue {
     /** Raw stored value (normalized), for exact filtering. */
@@ -1342,7 +1368,7 @@ interface CartItemProduct {
      *  arbitrary translation row, so this could come back in another language. */
     name: string;
     sku: string;
-    imageUrl?: string;
+    imageUrl?: string | null;
     inStock: boolean;
     /** Pieces left for an "only X left" note on the cart line; null when the
      *  shop does not track stock, hides the nudge or has plenty. SDK 2.13.0. */
@@ -1440,7 +1466,7 @@ interface Cart {
      *  200 net" was 20, now it is 24.20 at 21 %). It lowers base and VAT, see
      *  `taxBreakdown` and `vatTotal`. */
     discountTotal: number;
-    discount?: CartDiscount;
+    discount?: CartDiscount | null;
     /** Auto-apply promotion discount lines (sale/BOGO). */
     appliedPromotions: CartPromotion[];
     /** Sum of `appliedPromotions[].discountAmount`; already reflected in `grandTotal`. */
@@ -1645,6 +1671,12 @@ interface CheckoutInput {
      * guests. See `customer.getLoyalty()` for the available balance.
      */
     redeemLoyaltyPoints?: number;
+    /**
+     * Cart session to order. The SDK sends it in the `X-Cart-Session` header on
+     * its own, so leave it out; the body field is for clients without the
+     * header (SDK 2.14.0 documents it, the backend has always accepted it).
+     */
+    sessionToken?: string;
 }
 type OrderStatus = (typeof OrderStatuses)[keyof typeof OrderStatuses];
 type PaymentStatus = (typeof PaymentStatuses)[keyof typeof PaymentStatuses];
@@ -1660,6 +1692,8 @@ interface OrderListItem {
     createdAt: number;
 }
 interface OrderItem {
+    /** Order line id (SDK 2.14.0). */
+    id?: string;
     productName: string;
     sku: string;
     /** Photo snapshot from checkout, or the product's current photo. */
@@ -1671,9 +1705,23 @@ interface OrderItem {
     productSlug?: string | null;
     quantity: number;
     unitPrice: number;
+    /** VAT rate of the line in percent, e.g. 21 (SDK 2.14.0). */
+    taxRate?: number;
+    /** VAT of the whole line (SDK 2.14.0). */
+    taxAmount?: number;
     totalPrice: number;
     totalPriceWithTax: number;
 }
+/** A discount code applied to an order (SDK 2.14.0). */
+interface OrderDiscount {
+    code: string;
+    /** PERCENTAGE, FIXED_AMOUNT or FREE_SHIPPING. */
+    type: string;
+    /** Percent or amount as configured on the code. */
+    value: number;
+    /** Money the code took off this order. */
+    appliedAmount: number;
+}
 /**
  * PII-minimized order view returned by `orders.track(token)`. The tracking
  * token is shared in URLs and e-mails, so this deliberately omits full
@@ -1726,9 +1774,14 @@ interface OrderShipment {
     createdAt: number;
 }
 interface OrderStatusHistory {
-    fromStatus?: OrderStatus;
+    /** Null for the first entry of an order. */
+    fromStatus?: OrderStatus | null;
     toStatus: OrderStatus;
-    note?: string;
+    note?: string | null;
+    /**
+     * @deprecated Never sent: who changed the status is internal to the shop.
+     * Kept only so existing templates keep compiling.
+     */
     changedBy?: string;
     createdAt: number;
 }
@@ -1765,8 +1818,8 @@ interface OrderDetail extends OrderListItem {
     shippingAddress: CheckoutAddress;
     billingAddress: CheckoutAddress;
     email: string;
-    phone?: string;
-    customerNote?: string;
+    phone?: string | null;
+    customerNote?: string | null;
     subtotal: number;
     /** Goods VAT before order discounts (goods subtotal = `subtotal` + `taxTotal`). */
     taxTotal: number;
@@ -1788,6 +1841,12 @@ interface OrderDetail extends OrderListItem {
     discountTotal: number;
     fulfillmentStatus: FulfillmentStatus;
     statusHistory: OrderStatusHistory[];
+    /** Discount codes applied to the order (SDK 2.14.0). */
+    discounts?: OrderDiscount[];
+    /**
+     * @deprecated Not sent on the order detail. Only `checkout.createOrder()`
+     * returns it, see `CheckoutResult.trackingToken`.
+     */
     trackingToken?: string;
     /**
      * Digital product delivery (GAP-07): download grants for any digital assets
@@ -2107,10 +2166,12 @@ interface DownloadUrl {
 interface CustomerProfile {
     id: string;
     email: string;
-    firstName?: string;
-    lastName?: string;
-    phone?: string;
+    firstName?: string | null;
+    lastName?: string | null;
+    phone?: string | null;
     emailVerified: boolean;
+    /** Registration time (Unix ms). */
+    createdAt?: number;
     /**
      * B2B approval gate (GAP-19). `false` = the account is awaiting merchant
      * approval (or was deactivated) — show a "pending approval" banner and gate
@@ -2126,7 +2187,8 @@ interface CustomerAddress {
     isDefault: boolean;
     firstName: string;
     lastName: string;
-    company?: string;
+    /** Null when not set. Send null on update to clear it. */
+    company?: string | null;
     street: string;
     city: string;
     zip: string;
@@ -2144,7 +2206,8 @@ interface CustomerAddress {
     vatIdValid?: boolean | null;
     /** When the VAT ID was last checked (ms). Read-only. */
     vatIdCheckedAt?: number | null;
-    phone?: string;
+    /** Null when not set. Send null on update to clear it. */
+    phone?: string | null;
 }
 interface Page {
     slug: string;
@@ -3199,6 +3262,7 @@ declare class BehioStorefront {
         visitorId: string;
         email: string;
     }): Promise<SdkResult<{
+        /** Single-use code for the offered product, issued by this call. */
         code: string;
         percent: number;
         expiresAt: number;
@@ -3965,6 +4029,8 @@ interface AddressDetail {
     formattedAddress: string;
     lat: number;
     lng: number;
+    /** Set (and the address fields empty) when the request had no `placeId`. */
+    error?: string | null;
 }
 declare class AddressModule {
     private client;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@behio/storefront-sdk",
-  "version": "2.13.0",
+  "version": "2.14.1",
   "description": "TypeScript SDK for Behio headless e-commerce: core client + React hooks",
   "author": "Behio",
   "license": "MIT",