@nok-integration/storefront-react 0.25.0 → 0.26.0

package/dist/index.d.ts

@@ -319,6 +319,151 @@ declare function CartSheetProvider({ children }: {
 export { CartSheetProvider as CartSheet }
 export { CartSheetProvider }
 
+/**
+ * Cart totals: the standard pricing breakdown, plus what came off.
+ *
+ * `discount` is **additive** — `Pricing` itself is untouched, because it is shared with
+ * surfaces that have no concept of one and must not grow a field they cannot populate.
+ */
+declare const CartTotals: z.ZodObject<{
+    subtotal: z.ZodObject<{
+        amount: z.ZodNumber;
+        currency: z.ZodString;
+    }, "strict", z.ZodTypeAny, {
+        amount: number;
+        currency: string;
+    }, {
+        amount: number;
+        currency: string;
+    }>;
+    shipping: z.ZodObject<{
+        amount: z.ZodNumber;
+        currency: z.ZodString;
+    }, "strict", z.ZodTypeAny, {
+        amount: number;
+        currency: string;
+    }, {
+        amount: number;
+        currency: string;
+    }>;
+    tax: z.ZodObject<{
+        amount: z.ZodNumber;
+        currency: z.ZodString;
+    }, "strict", z.ZodTypeAny, {
+        amount: number;
+        currency: string;
+    }, {
+        amount: number;
+        currency: string;
+    }>;
+    total: z.ZodObject<{
+        amount: z.ZodNumber;
+        currency: z.ZodString;
+    }, "strict", z.ZodTypeAny, {
+        amount: number;
+        currency: string;
+    }, {
+        amount: number;
+        currency: string;
+    }>;
+} & {
+    /**
+     * What came off across the whole basket, as a **positive** amount. Absent means nothing
+     * did; a zero is never sent.
+     *
+     * Positive rather than signed, and the surface that draws it owns the minus sign —
+     * exactly as `OrderTotals.discount` does. A signed field invites a reader to add it to a
+     * running total, and nothing here is a running total: every figure is server-computed
+     * and `total` is never derived by a consumer from the parts.
+     *
+     * Kept out of `subtotal` deliberately. The design lists a subtotal and a discount as two
+     * rows because the fan is owed both figures, and folding the saving into the subtotal
+     * loses the one they came for.
+     */
+    discount: z.ZodOptional<z.ZodObject<{
+        amount: z.ZodNumber;
+        currency: z.ZodString;
+    }, "strict", z.ZodTypeAny, {
+        amount: number;
+        currency: string;
+    }, {
+        amount: number;
+        currency: string;
+    }>>;
+    /**
+     * The lines at their undiscounted prices: each line's `compare_at_unit_price` where it
+     * has one, otherwise its `unit_price`, times its quantity. Present exactly when
+     * `discount` is, and absent means it equals `subtotal`.
+     *
+     * This is the figure the summary's Subtotal row draws above the Discount row, so the
+     * rows read top to bottom: `subtotal_before_discount` − `discount` = `subtotal`, and
+     * `total` is `subtotal` plus shipping and tax. `subtotal` itself keeps its meaning — what
+     * the lines cost now — because the hand-off and analytics read it as the basket's value.
+     */
+    subtotal_before_discount: z.ZodOptional<z.ZodObject<{
+        amount: z.ZodNumber;
+        currency: z.ZodString;
+    }, "strict", z.ZodTypeAny, {
+        amount: number;
+        currency: string;
+    }, {
+        amount: number;
+        currency: string;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    subtotal: {
+        amount: number;
+        currency: string;
+    };
+    shipping: {
+        amount: number;
+        currency: string;
+    };
+    tax: {
+        amount: number;
+        currency: string;
+    };
+    total: {
+        amount: number;
+        currency: string;
+    };
+    discount?: {
+        amount: number;
+        currency: string;
+    } | undefined;
+    subtotal_before_discount?: {
+        amount: number;
+        currency: string;
+    } | undefined;
+}, {
+    subtotal: {
+        amount: number;
+        currency: string;
+    };
+    shipping: {
+        amount: number;
+        currency: string;
+    };
+    tax: {
+        amount: number;
+        currency: string;
+    };
+    total: {
+        amount: number;
+        currency: string;
+    };
+    discount?: {
+        amount: number;
+        currency: string;
+    } | undefined;
+    subtotal_before_discount?: {
+        amount: number;
+        currency: string;
+    } | undefined;
+}>;
+
+declare type CartTotals = z.infer<typeof CartTotals>;
+
 /**
  * Opens the cart as a bottom sheet.
  *
@@ -2710,6 +2855,10 @@ declare function createClient(options: ClientOptions): {
                     amount: number;
                     currency: string;
                 } | undefined;
+                subtotal_before_discount?: {
+                    amount: number;
+                    currency: string;
+                } | undefined;
             };
             locked?: {
                 reason: "checkout_handoff";
@@ -2769,6 +2918,10 @@ declare function createClient(options: ClientOptions): {
                     amount: number;
                     currency: string;
                 } | undefined;
+                subtotal_before_discount?: {
+                    amount: number;
+                    currency: string;
+                } | undefined;
             };
             locked?: {
                 reason: "checkout_handoff";
@@ -2828,6 +2981,10 @@ declare function createClient(options: ClientOptions): {
                     amount: number;
                     currency: string;
                 } | undefined;
+                subtotal_before_discount?: {
+                    amount: number;
+                    currency: string;
+                } | undefined;
             };
             locked?: {
                 reason: "checkout_handoff";
@@ -2887,6 +3044,10 @@ declare function createClient(options: ClientOptions): {
                     amount: number;
                     currency: string;
                 } | undefined;
+                subtotal_before_discount?: {
+                    amount: number;
+                    currency: string;
+                } | undefined;
             };
             locked?: {
                 reason: "checkout_handoff";
@@ -2946,6 +3107,10 @@ declare function createClient(options: ClientOptions): {
                     amount: number;
                     currency: string;
                 } | undefined;
+                subtotal_before_discount?: {
+                    amount: number;
+                    currency: string;
+                } | undefined;
             };
             locked?: {
                 reason: "checkout_handoff";
@@ -3368,6 +3533,10 @@ declare function createClient(options: ClientOptions): {
                     amount: number;
                     currency: string;
                 } | undefined;
+                subtotal_before_discount?: {
+                    amount: number;
+                    currency: string;
+                } | undefined;
             };
             locked?: {
                 reason: "checkout_handoff";
@@ -4551,7 +4720,12 @@ export declare interface OrderStatusBadgeProps {
 export declare function OrderSummary({ pricing, deferred, hidden, rows, discount, collapsible, }: OrderSummaryProps): JSX.Element;
 
 export declare interface OrderSummaryProps {
-    pricing: Pricing;
+    /**
+     * The figures to draw. A cart's `totals` also carries `subtotal_before_discount`, which
+     * the Subtotal row shows whenever the Discount row is drawn, so the rows read
+     * Subtotal − Discount = Total exactly as the engine sent them.
+     */
+    pricing: Pricing & Partial<Pick<CartTotals, 'subtotal_before_discount'>>;
     /**
      * Row order and wording, where a surface's design differs from the cart's.
      *
@@ -5211,7 +5385,7 @@ declare type ProductPromo = z.infer<typeof ProductPromo>;
  * 165:220 image (radius-6) with a TOP PICK flag top-left and a green sale badge
  * bottom-left; below sit the title (2-line clamp) and price with a struck was-price.
  */
-export declare function ProductTile({ product, priority, size }: ProductTileProps): JSX.Element;
+export declare function ProductTile({ product, priority, size, flag }: ProductTileProps): JSX.Element;
 
 export declare interface ProductTileProps {
     product: Product;
@@ -5222,6 +5396,8 @@ export declare interface ProductTileProps {
      * a taller 343:457 image and an 18px title (Figma `size=large`).
      */
     size?: 'default' | 'large';
+    /** The flag over the image, in place of the product's first badge. */
+    flag?: string;
 }
 
 /** `GET /v1/catalog/products` — a single purchasable variant of a product. */