@shopify/hydrogen-react 2026.1.2 → 2026.4.1

package/dist/types/CartLineQuantityAdjustButton.d.ts

@@ -8,6 +8,7 @@ type CartLineQuantityAdjustButtonProps<AsType extends React.ElementType = 'butto
  * The `<CartLineQuantityAdjustButton />` component renders a button that adjusts the cart line's quantity when pressed.
  *
  * It must be a descendent of `<CartLineProvider/>` and `<CartProvider/>`.
+ * @publicDocs
  */
 export declare function CartLineQuantityAdjustButton<AsType extends React.ElementType = 'button'>(props: CartLineQuantityAdjustButtonProps<AsType>): JSX.Element;
 export {};

package/dist/types/CartProvider.d.ts

@@ -1,9 +1,14 @@
 import { CartBuyerIdentityInput, CountryCode, LanguageCode, Cart as CartType } from './storefront-api-types.js';
-import { CartWithActions } from './cart-types.js';
+import { CartWithActions, CartWithActionsDocs } from './cart-types.js';
 import { PartialDeep } from 'type-fest';
 export declare const CartContext: import("react").Context<CartWithActions | null>;
+/**
+ * `useCart` hook must be a descendent of a `CartProvider` component.
+ * @publicDocs */
+export type UseCartDocs = () => CartWithActionsDocs;
 /**
  * The `useCart` hook provides access to the cart object. It must be a descendent of a `CartProvider` component.
+ * @publicDocs
  */
 export declare function useCart(): CartWithActions;
 type CartProviderProps = {
@@ -43,11 +48,11 @@ type CartProviderProps = {
     onAttributesUpdateComplete?: () => void;
     /** A callback that is invoked when the process to update the cart discount codes completes */
     onDiscountCodesUpdateComplete?: () => void;
-    /** An object with fields that correspond to the Storefront API's [Cart object](https://shopify.dev/api/storefront/2026-01/objects/cart). */
+    /** An object with fields that correspond to the Storefront API's [Cart object](https://shopify.dev/api/storefront/2026-04/objects/cart). */
     data?: PartialDeep<CartType, {
         recurseIntoArrays: true;
     }>;
-    /** A fragment used to query the Storefront API's [Cart object](https://shopify.dev/api/storefront/2026-01/objects/cart) for all queries and mutations. A default value is used if no argument is provided. */
+    /** A fragment used to query the Storefront API's [Cart object](https://shopify.dev/api/storefront/2026-04/objects/cart) for all queries and mutations. A default value is used if no argument is provided. */
     cartFragment?: string;
     /** A customer access token that's accessible on the server if there's a customer login. */
     customerAccessToken?: CartBuyerIdentityInput['customerAccessToken'];
@@ -65,6 +70,7 @@ type CartProviderProps = {
  * There are also props that trigger when a call to the Storefront API is completed, such as `onLineAddComplete={}` when the fetch request for adding a line to the cart completes.
  *
  * The `CartProvider` component must be a descendant of the `ShopifyProvider` component.
+ * @publicDocs
  */
 export declare function CartProvider({ children, numCartLines, onCreate, onLineAdd, onLineRemove, onLineUpdate, onNoteUpdate, onBuyerIdentityUpdate, onAttributesUpdate, onDiscountCodesUpdate, onCreateComplete, onLineAddComplete, onLineRemoveComplete, onLineUpdateComplete, onNoteUpdateComplete, onBuyerIdentityUpdateComplete, onAttributesUpdateComplete, onDiscountCodesUpdateComplete, data: cart, cartFragment, customerAccessToken, countryCode, languageCode, }: CartProviderProps): JSX.Element;
 /**

package/dist/types/ExternalVideo.d.ts

@@ -1,6 +1,9 @@
 import type { ExternalVideo as ExternalVideoType } from './storefront-api-types.js';
 import type { PartialDeep } from 'type-fest';
 import { IframeHTMLAttributes } from 'react';
+/**
+ * Takes in the same props as a native `<iframe>` element, except for `src`.
+ * @publicDocs */
 export interface ExternalVideoBaseProps {
     /**
      * An object with fields that correspond to the Storefront API's [ExternalVideo object](https://shopify.dev/api/storefront/reference/products/externalvideo).
@@ -18,6 +21,7 @@ export type ExternalVideoProps = Omit<IframeHTMLAttributes<HTMLIFrameElement>, '
 /**
  * The `ExternalVideo` component renders an embedded video for the Storefront
  * API's [ExternalVideo object](https://shopify.dev/api/storefront/reference/products/externalvideo).
+ * @publicDocs
  */
 export declare const ExternalVideo: import("react").ForwardRefExoticComponent<Omit<IframeHTMLAttributes<HTMLIFrameElement>, "src"> & ExternalVideoBaseProps & import("react").RefAttributes<HTMLIFrameElement>>;
 interface YouTube {

package/dist/types/Image.d.ts

@@ -23,6 +23,7 @@ export type LoaderParams = {
 };
 export type Loader = (params: LoaderParams) => string;
 type Crop = 'center' | 'top' | 'bottom' | 'left' | 'right';
+/** @publicDocs */
 export type HydrogenImageProps = React.ComponentPropsWithRef<'img'> & HydrogenImageBaseProps;
 type HydrogenImageBaseProps = {
     /** The aspect ratio of the image, in the format of `width/height`.
@@ -42,7 +43,7 @@ type HydrogenImageBaseProps = {
      * @defaultValue `center`
      */
     crop?: Crop;
-    /** Data mapping to the [Storefront API `Image`](https://shopify.dev/docs/api/storefront/2026-01/objects/Image) object. Must be an Image object.
+    /** Data mapping to the [Storefront API `Image`](https://shopify.dev/docs/api/storefront/2026-04/objects/Image) object. Must be an Image object.
      *
      * @example
      * ```
@@ -117,6 +118,7 @@ export declare const IMAGE_FRAGMENT = "#graphql\n  fragment Image on Image {\n
  * ```
  *
  * {@link https://shopify.dev/docs/api/hydrogen-react/components/image}
+ * @publicDocs
  */
 export declare const Image: React.ForwardRefExoticComponent<Omit<HydrogenImageProps, "ref"> & React.RefAttributes<HTMLImageElement>>;
 export declare function shopifyLoader({ src, width, height, crop }: LoaderParams): string;

package/dist/types/MediaFile.d.ts

@@ -6,6 +6,9 @@ import type { MediaEdge as MediaEdgeType } from './storefront-api-types.js';
 import type { PartialDeep } from 'type-fest';
 import type { ModelViewerElement } from '@google/model-viewer/lib/model-viewer.js';
 type BaseProps = React.HTMLAttributes<HTMLImageElement | HTMLVideoElement | HTMLIFrameElement | ModelViewerElement>;
+/**
+ * MediaFile renders an `Image`, `Video`, `ExternalVideo`, or `ModelViewer` component. Use the `mediaOptions` prop to customize the props sent to each of these components.
+ * @publicDocs */
 export interface MediaFileProps extends BaseProps {
     /** An object with fields that correspond to the Storefront API's [Media object](https://shopify.dev/api/storefront/reference/products/media). */
     data: PartialDeep<MediaEdgeType['node'], {
@@ -28,6 +31,7 @@ type MediaOptions = {
  * The `MediaFile` component renders the media for the Storefront API's
  * [Media object](https://shopify.dev/api/storefront/reference/products/media). It renders an `Image`, a
  * `Video`, an `ExternalVideo`, or a `ModelViewer` depending on the `__typename` of the `data` prop.
+ * @publicDocs
  */
 export declare function MediaFile({ data, mediaOptions, ...passthroughProps }: MediaFileProps): JSX.Element | null;
 export {};

package/dist/types/ModelViewer.d.ts

@@ -14,7 +14,7 @@ type ModelViewerProps = Omit<PartialDeep<JSX.IntrinsicElements['model-viewer'],
     recurseIntoArrays: true;
 }>, 'src'> & ModelViewerBaseProps;
 type ModelViewerBaseProps = {
-    /** An object with fields that correspond to the Storefront API's [Model3D object](https://shopify.dev/api/storefront/2026-01/objects/model3d). */
+    /** An object with fields that correspond to the Storefront API's [Model3D object](https://shopify.dev/api/storefront/2026-04/objects/model3d). */
     data: PartialDeep<Model3d, {
         recurseIntoArrays: true;
     }>;
@@ -52,6 +52,7 @@ type ModelViewerBaseProps = {
  * The `model-viewer` custom element is lazily downloaded through a dynamically-injected `<script type="module">` tag when the `<ModelViewer />` component is rendered
  *
  * ModelViewer is using version `1.21.1` of the `@google/model-viewer` library.
+ * @publicDocs
  */
 export declare function ModelViewer(props: ModelViewerProps): JSX.Element | null;
 export {};

package/dist/types/Money.d.ts

@@ -11,7 +11,7 @@ type MoneyV2 = StorefrontApiMoneyV2 | CustomerAccountApiMoneyV2;
 export interface MoneyPropsBase<ComponentGeneric extends React.ElementType> {
     /** An HTML tag or React Component to be rendered as the base element wrapper. The default is `div`. */
     as?: ComponentGeneric;
-    /** An object with fields that correspond to the [Storefront API's MoneyV2 object](https://shopify.dev/docs/api/storefront/2026-01/objects/MoneyV2) or [Customer Account API's MoneyV2 object](https://shopify.dev/docs/api/customer/2026-01/objects/moneyv2). */
+    /** An object with fields that correspond to the [Storefront API's MoneyV2 object](https://shopify.dev/docs/api/storefront/2026-04/objects/MoneyV2) or [Customer Account API's MoneyV2 object](https://shopify.dev/docs/api/customer/2026-04/objects/moneyv2). */
     data: PartialDeep<MoneyV2, {
         recurseIntoArrays: true;
     }>;
@@ -19,7 +19,7 @@ export interface MoneyPropsBase<ComponentGeneric extends React.ElementType> {
     withoutCurrency?: boolean;
     /** Whether to remove trailing zeros (fractional money) from the output. */
     withoutTrailingZeros?: boolean;
-    /** A [UnitPriceMeasurement object](https://shopify.dev/api/storefront/2026-01/objects/unitpricemeasurement). */
+    /** A [UnitPriceMeasurement object](https://shopify.dev/api/storefront/2026-04/objects/unitpricemeasurement). */
     measurement?: PartialDeep<UnitPriceMeasurement, {
         recurseIntoArrays: true;
     }>;
@@ -28,8 +28,8 @@ export interface MoneyPropsBase<ComponentGeneric extends React.ElementType> {
 }
 export type MoneyProps<ComponentGeneric extends React.ElementType> = MoneyPropsBase<ComponentGeneric> & (ComponentGeneric extends keyof React.JSX.IntrinsicElements ? Omit<React.ComponentPropsWithoutRef<ComponentGeneric>, keyof MoneyPropsBase<ComponentGeneric>> : React.ComponentPropsWithoutRef<ComponentGeneric>);
 /**
- * The `Money` component renders a string of the [Storefront API's MoneyV2 object](https://shopify.dev/docs/api/storefront/2026-01/objects/MoneyV2)
- * or the [Customer Account API's MoneyV2 object](https://shopify.dev/docs/api/customer/2026-01/objects/moneyv2)
+ * The `Money` component renders a string of the [Storefront API's MoneyV2 object](https://shopify.dev/docs/api/storefront/2026-04/objects/MoneyV2)
+ * or the [Customer Account API's MoneyV2 object](https://shopify.dev/docs/api/customer/2026-04/objects/moneyv2)
  * according to the `locale` in the `ShopifyProvider` component.
  * &nbsp;
  * @see {@link https://shopify.dev/api/hydrogen/components/money}
@@ -59,6 +59,7 @@ export type MoneyProps<ComponentGeneric extends React.ElementType> = MoneyPropsB
  *   measurementSeparator=" per "
  * />
  * ```
+ * @publicDocs
  */
 export declare function Money<ComponentGeneric extends React.ElementType = 'div'>({ data, as, withoutCurrency, withoutTrailingZeros, measurement, measurementSeparator, ...passthroughProps }: MoneyProps<ComponentGeneric>): JSX.Element;
 export {};

package/dist/types/ProductPrice.d.ts

@@ -16,7 +16,9 @@ export interface ProductPriceProps {
 /**
  * The `ProductPrice` component renders a `Money` component with the product
  * [`priceRange`](https://shopify.dev/api/storefront/reference/products/productpricerange)'s `maxVariantPrice` or `minVariantPrice`, for either the regular price or compare at price range.
+ * @publicDocs
  */
 export declare function ProductPrice<ComponentGeneric extends React.ElementType = 'div'>(props: ProductPriceProps & Omit<MoneyProps<ComponentGeneric>, 'data' | 'measurement'>): JSX.Element | null;
+/** @publicDocs */
 export interface ProductPricePropsForDocs<AsType extends React.ElementType = 'div'> extends Omit<MoneyPropsBase<AsType>, 'data' | 'measurement'>, ProductPriceProps {
 }

package/dist/types/ProductProvider.d.ts

@@ -22,10 +22,12 @@ interface ProductProviderProps {
  * `<ProductProvider />` is a context provider that enables use of the `useProduct()` hook.
  *
  * It helps manage selected options and variants for a product.
+ * @publicDocs
  */
 export declare function ProductProvider({ children, data: product, initialVariantId: explicitVariantId, }: ProductProviderProps): JSX.Element;
 /**
  * Provides access to the context value provided by `<ProductProvider />`. Must be a descendent of `<ProductProvider />`.
+ * @publicDocs
  */
 export declare function useProduct(): ProductHookValue;
 export interface OptionWithValues {

package/dist/types/RichText.d.ts

@@ -9,6 +9,8 @@ export interface RichTextPropsBase<ComponentGeneric extends React.ElementType> {
     /** Remove rich text formatting and render plain text */
     plain?: boolean;
 }
+/** @publicDocs */
 export declare function RichText<ComponentGeneric extends React.ElementType = 'div'>({ as, data, plain, components, ...passthroughProps }: RichTextProps<ComponentGeneric>): JSX.Element;
 export type RichTextProps<ComponentGeneric extends React.ElementType> = RichTextPropsBase<ComponentGeneric> & Omit<React.ComponentPropsWithoutRef<ComponentGeneric>, keyof RichTextPropsBase<ComponentGeneric>>;
+/** @publicDocs */
 export type RichTextPropsForDocs<AsType extends React.ElementType = 'div'> = RichTextPropsBase<AsType>;

package/dist/types/ShopPayButton.d.ts

@@ -43,6 +43,7 @@ declare global {
  * The `ShopPayButton` component renders a button that redirects to the Shop Pay checkout.
  * It renders a [`<shop-pay-button>`](https://shopify.dev/custom-storefronts/tools/web-components) custom element, for which it will lazy-load the source code automatically.
  * It relies on the `<ShopProvider>` context provider.
+ * @publicDocs
  */
 export declare function ShopPayButton({ channel, variantIds, className, variantIdsAndQuantities, width, storeDomain: _storeDomain, }: ShopPayButtonProps): JSX.Element;
 export declare const MissingStoreDomainErrorMessage = "You must pass a \"storeDomain\" prop to the \"ShopPayButton\" component, or wrap it in a \"ShopifyProvider\" component.";

package/dist/types/ShopifyProvider.d.ts

@@ -3,10 +3,12 @@ import type { LanguageCode, CountryCode } from './storefront-api-types.js';
 export declare const defaultShopifyContext: ShopifyContextValue;
 /**
  * The `<ShopifyProvider/>` component enables use of the `useShop()` hook. The component should wrap your app.
+ * @publicDocs
  */
 export declare function ShopifyProvider({ children, ...shopifyConfig }: ShopifyProviderProps): JSX.Element;
 /**
  * Provides access to the `shopifyConfig` prop of `<ShopifyProvider/>`. Must be a descendent of `<ShopifyProvider/>`.
+ * @publicDocs
  */
 export declare function useShop(): ShopifyContextValue;
 export interface ShopifyProviderBase {

package/dist/types/Video.d.ts

@@ -2,8 +2,9 @@ import { type HTMLAttributes } from 'react';
 import { shopifyLoader } from './Image.js';
 import type { Video as VideoType } from './storefront-api-types.js';
 import type { PartialDeep } from 'type-fest';
+/** @publicDocs */
 export interface VideoProps {
-    /** An object with fields that correspond to the Storefront API's [Video object](https://shopify.dev/api/storefront/2026-01/objects/video). */
+    /** An object with fields that correspond to the Storefront API's [Video object](https://shopify.dev/api/storefront/2026-04/objects/video). */
     data: PartialDeep<VideoType, {
         recurseIntoArrays: true;
     }>;
@@ -16,5 +17,6 @@ export interface VideoProps {
 }
 /**
  * The `Video` component renders a `video` for the Storefront API's [Video object](https://shopify.dev/api/storefront/reference/products/video).
+ * @publicDocs
  */
 export declare const Video: import("react").ForwardRefExoticComponent<Omit<import("react").ClassAttributes<HTMLVideoElement> & import("react").VideoHTMLAttributes<HTMLVideoElement> & VideoProps, "ref"> & import("react").RefAttributes<HTMLVideoElement>>;

package/dist/types/analytics-constants.d.ts

@@ -16,12 +16,18 @@ export declare const ShopifyAppId: {
  * These duplicated interface declaration is so that we can generate proper documentation
  * for these public facing constants
  */
+/**
+ * Analytics event names accepted by Shopify analytics.
+ * @publicDocs */
 export interface AnalyticsEventName {
     /** Page view */
     PAGE_VIEW: 'PAGE_VIEW';
     /** Add to cart */
     ADD_TO_CART: 'ADD_TO_CART';
 }
+/**
+ * Analytics page type values accepted by Shopify analytics.
+ * @publicDocs */
 export interface AnalyticsPageType {
     article: 'article';
     blog: 'blog';
@@ -46,6 +52,9 @@ export interface AnalyticsPageType {
     policy: 'policy';
     search: 'search';
 }
+/**
+ * Analytics sales channel values accepted by Shopify analytics.
+ * @publicDocs */
 export interface ShopifySalesChannel {
     /** Shopify Hydrogen sales channel */
     hydrogen: 'hydrogen';

package/dist/types/analytics-types.d.ts

@@ -180,6 +180,7 @@ export type ShopifyAnalyticsPayload = ShopifyPageViewPayload | ShopifyAddToCartP
  */
 export type ShopifyAnalyticsPayloadWithPrivacyFields = ShopifyPageViewPayloadWithPrivacyFields | ShopifyAddToCartPayloadWithPrivacyFields;
 export type ShopifyAnalytics = ShopifyPageView | ShopifyAddToCart;
+/** Shopify cookies names */
 export type ShopifyCookies = {
     /** Shopify unique user token: Value of `_shopify_y` cookie. */
     [SHOPIFY_Y]: string;

package/dist/types/analytics-utils.d.ts

@@ -19,6 +19,7 @@ export declare function schemaWrapper(schemaId: string, payload: ShopifyMonorail
  *  * const {id, resource} = parseGid('gid://shopify/Cart/abc123')
  * // => id = "abc123", resource = 'Cart'
  * ```
+ * @publicDocs
  **/
 export declare function parseGid(gid: string | undefined): ShopifyGid;
 /**

package/dist/types/analytics.d.ts

@@ -1,9 +1,14 @@
 import type { ClientBrowserParameters, ShopifyAnalytics } from './analytics-types.js';
 /**
- * Set user and session cookies and refresh the expiry time
+ * Set user and session cookies and refresh the expiry time. If `event.payload.hasUserConsent` is false, no analytics event will happen.
  * @param event - The analytics event.
  * @param shopDomain - The Online Store domain to sent Shopify analytics under the same
  *   top level domain.
+ * @publicDocs
  */
 export declare function sendShopifyAnalytics(event: ShopifyAnalytics, shopDomain?: string): Promise<void>;
+/**
+ * If executed on server, this method will return empty string for each field.
+ * @publicDocs
+ */
 export declare function getClientBrowserParameters(): ClientBrowserParameters;

package/dist/types/cart-queries.d.ts

@@ -1,10 +1,14 @@
-export declare const CartLineAdd: (cartFragment: string) => string;
-export declare const CartCreate: (cartFragment: string) => string;
-export declare const CartLineRemove: (cartFragment: string) => string;
-export declare const CartLineUpdate: (cartFragment: string) => string;
-export declare const CartNoteUpdate: (cartFragment: string) => string;
-export declare const CartBuyerIdentityUpdate: (cartFragment: string) => string;
-export declare const CartAttributesUpdate: (cartFragment: string) => string;
-export declare const CartDiscountCodesUpdate: (cartFragment: string) => string;
-export declare const CartQuery: (cartFragment: string) => string;
+type CartQueryOptions = {
+    includeVisitorConsent?: boolean;
+};
+export declare const CartLineAdd: (cartFragment: string, options?: CartQueryOptions) => string;
+export declare const CartCreate: (cartFragment: string, options?: CartQueryOptions) => string;
+export declare const CartLineRemove: (cartFragment: string, options?: CartQueryOptions) => string;
+export declare const CartLineUpdate: (cartFragment: string, options?: CartQueryOptions) => string;
+export declare const CartNoteUpdate: (cartFragment: string, options?: CartQueryOptions) => string;
+export declare const CartBuyerIdentityUpdate: (cartFragment: string, options?: CartQueryOptions) => string;
+export declare const CartAttributesUpdate: (cartFragment: string, options?: CartQueryOptions) => string;
+export declare const CartDiscountCodesUpdate: (cartFragment: string, options?: CartQueryOptions) => string;
+export declare const CartQuery: (cartFragment: string, options?: CartQueryOptions) => string;
 export declare const defaultCartFragment = "\n  fragment CartFragment on Cart {\n    id\n    checkoutUrl\n    totalQuantity\n    buyerIdentity {\n      countryCode\n      customer {\n        id\n        email\n        firstName\n        lastName\n        displayName\n      }\n      email\n      phone\n    }\n    lines(first: $numCartLines) {\n      edges {\n        node {\n          id\n          quantity\n          attributes {\n            key\n            value\n          }\n          cost {\n            totalAmount {\n              amount\n              currencyCode\n            }\n            compareAtAmountPerQuantity {\n              amount\n              currencyCode\n            }\n          }\n          merchandise {\n            ... on ProductVariant {\n              id\n              availableForSale\n              compareAtPrice {\n                ...MoneyFragment\n              }\n              price {\n                ...MoneyFragment\n              }\n              requiresShipping\n              title\n              image {\n                ...ImageFragment\n              }\n              product {\n                handle\n                title\n                id\n              }\n              selectedOptions {\n                name\n                value\n              }\n            }\n          }\n        }\n      }\n    }\n    cost {\n      subtotalAmount {\n        ...MoneyFragment\n      }\n      totalAmount {\n        ...MoneyFragment\n      }\n      totalDutyAmount {\n        ...MoneyFragment\n      }\n      totalTaxAmount {\n        ...MoneyFragment\n      }\n    }\n    note\n    attributes {\n      key\n      value\n    }\n    discountCodes {\n      code\n      applicable\n    }\n  }\n\n  fragment MoneyFragment on MoneyV2 {\n    currencyCode\n    amount\n  }\n  fragment ImageFragment on Image {\n    id\n    url\n    altText\n    width\n    height\n  }\n";
+export {};

package/dist/types/codegen.helpers.d.ts

@@ -1,7 +1,8 @@
 /**
  * Meant to be used with GraphQL CodeGen to type the Storefront API's custom scalars correctly.
- * Reference for the GraphQL types: https://shopify.dev/docs/api/storefront/2026-01/scalars/HTML
+ * Reference for the GraphQL types: https://shopify.dev/docs/api/storefront/2026-04/scalars/HTML
  * Note: JSON is generated as 'unknown' by default.
+ * @publicDocs
  */
 export declare const storefrontApiCustomScalars: {
     DateTime: string;
@@ -13,8 +14,9 @@ export declare const storefrontApiCustomScalars: {
 };
 /**
  * Meant to be used with GraphQL CodeGen to type the Storefront API's custom scalars correctly.
- * Reference for the GraphQL types: https://shopify.dev/docs/api/customer/2026-01/scalars/HTML
+ * Reference for the GraphQL types: https://shopify.dev/docs/api/customer/2026-04/scalars/HTML
  * Note: JSON is generated as 'unknown' by default.
+ * @publicDocs
  */
 export declare const customerAccountApiCustomScalars: {
     DateTime: string;

package/dist/types/cookies-utils.d.ts

@@ -2,7 +2,8 @@ import { ShopifyCookies } from './analytics-types.js';
 export declare function buildUUID(): string;
 export declare function hexTime(): string;
 /**
- * Gets the values of _shopify_y and _shopify_s cookies from the provided cookie string.
+ * Gets the values of _shopify_y and _shopify_s cookies from the provided cookie string. If the Shopify cookies doesn't exist, this method will return an empty string for each missing cookie.
  * @deprecated Use getTrackingValues instead.
+ * @publicDocs
  */
 export declare function getShopifyCookies(cookies: string): ShopifyCookies;

package/dist/types/customer-account-api-types.d.ts

@@ -1,6 +1,6 @@
 /**
  * THIS FILE IS AUTO-GENERATED, DO NOT EDIT
- * Based on Customer Account API 2026-01
+ * Based on Customer Account API 2026-04
  * If changes need to happen to the types defined in this file, then generally the Storefront API needs to update. After it's updated, you can run `npm run graphql-types`.
  * Except custom Scalars, which are defined in the `codegen.ts` file
  */
@@ -2906,6 +2906,8 @@ export type DraftOrder = Node & {
   currencyCode: CurrencyCode;
   /** The customer who placed the order. */
   customer?: Maybe<Customer>;
+  /** List of discounts applied to the draft order. */
+  discountApplications: DiscountApplicationConnection;
   /** The discount information for the draft order. */
   discountInformation: DraftOrderDiscountInformation;
   /** The email address of the customer, which is used to send notifications to. */
@@ -2965,11 +2967,21 @@ export type DraftOrder = Node & {
   updatedAt: Scalars['DateTime']['output'];
 };
 
+/** A draft order for the customer. Any fields related to money are in the presentment currency. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
+export type DraftOrderDiscountApplicationsArgs = {
+  after?: InputMaybe<Scalars['String']['input']>;
+  before?: InputMaybe<Scalars['String']['input']>;
+  first?: InputMaybe<Scalars['Int']['input']>;
+  last?: InputMaybe<Scalars['Int']['input']>;
+  reverse?: InputMaybe<Scalars['Boolean']['input']>;
+};
+
 /** A draft order for the customer. Any fields related to money are in the presentment currency. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data). */
 export type DraftOrderLineItemsArgs = {
   after?: InputMaybe<Scalars['String']['input']>;
   before?: InputMaybe<Scalars['String']['input']>;
   first?: InputMaybe<Scalars['Int']['input']>;
+  flattenComponents?: InputMaybe<Scalars['Boolean']['input']>;
   last?: InputMaybe<Scalars['Int']['input']>;
   reverse?: InputMaybe<Scalars['Boolean']['input']>;
 };
@@ -3037,6 +3049,10 @@ export type DraftOrderConnection = {
 /** The discount information associated with a draft order. */
 export type DraftOrderDiscountInformation = {
   __typename?: 'DraftOrderDiscountInformation';
+  /** The discount information for the draft order, including line_level discount applications. */
+  allAppliedDiscounts: Array<OrderAllDiscounts>;
+  /** The order level discount information for the draft order. */
+  allOrderLevelAppliedDiscounts: Array<OrderAllDiscounts>;
   /** The order-level discount applied to the draft order. */
   appliedDiscount?: Maybe<DraftOrderAppliedDiscount>;
   /** The total discounts applied to the draft order. */
@@ -3055,6 +3071,12 @@ export type DraftOrderEdge = {
 /** A line item included in a draft order. */
 export type DraftOrderLineItem = Node & {
   __typename?: 'DraftOrderLineItem';
+  /** The discounted total divided by the quantity, resulting in an average per-unit price reduction. */
+  approximateDiscountedUnitPrice: MoneyV2;
+  /** The list of components for this draft order line item. */
+  components: Array<DraftOrderLineItem>;
+  /** List of discounts allocated to the draft order line item. */
+  discountAllocations: Array<DiscountAllocation>;
   /** The discount information for the draft order line item. */
   discountInformation: DraftOrderLineItemDiscountInformation;
   /** The total price of the line item after discounts have been applied. */

package/dist/types/flatten-connection.d.ts

@@ -4,6 +4,7 @@ import type { PartialDeep } from 'type-fest';
  * The utility works with either `nodes` or `edges.node`.
  *
  * If `connection` is null or undefined, will return an empty array instead in production. In development, an error will be thrown.
+ * @publicDocs
  */
 export declare function flattenConnection<ConnectionGeneric extends PartialDeep<ConnectionEdges, {
     recurseIntoArrays: true;
@@ -36,8 +37,10 @@ type ConnectionEdges = {
 type ConnectionNodes = {
     nodes: Array<unknown>;
 };
+/** @publicDocs */
 export interface ConnectionGenericForDoc {
     connection?: ConnectionEdges | ConnectionNodes;
 }
+/** @publicDocs */
 export type FlattenConnectionReturnForDoc = unknown[];
 export {};

package/dist/types/getProductOptions.d.ts

@@ -30,6 +30,7 @@ type MappedProductOptionValue = ProductOptionValue & ProductOptionValueState;
  *    Color: 'Red',
  *    Size: 'Medium',
  *  \}
+ * @publicDocs
  */
 export declare function mapSelectedProductOptionToObject(options: Pick<SelectedOption, 'name' | 'value'>[]): Record<string, string>;
 export type MappedProductOptions = Omit<ProductOption, 'optionValues'> & {
@@ -39,11 +40,13 @@ export declare function checkProductParam(product: RecursivePartial<Product>, ch
 /**
  * Finds all the variants provided by adjacentVariants, options.optionValues.firstAvailableVariant,
  * and selectedOrFirstAvailableVariant and return them in a single array
+ * @publicDocs
  */
 export declare function getAdjacentAndFirstAvailableVariants(product: RecursivePartial<Product>): ProductVariant[];
 /**
  * Returns a product options array with its relevant information
  * about the variant
+ * @publicDocs
  */
 export declare function getProductOptions(product: RecursivePartial<Product>): MappedProductOptions[];
 export {};

package/dist/types/load-script.d.ts

@@ -4,9 +4,11 @@ type LoadScriptOptions = {
     attributes?: Record<string, string>;
 };
 export declare function loadScript(src: string, options?: LoadScriptOptions): Promise<boolean>;
-type LoadScriptParams = Parameters<typeof loadScript>;
+/** @publicDocs */
+export type LoadScriptParams = Parameters<typeof loadScript>;
 /**
  * The `useLoadScript` hook loads an external script tag in the browser. It allows React components to lazy-load large third-party dependencies.
+ * @publicDocs
  */
 export declare function useLoadScript(url: LoadScriptParams[0], options?: LoadScriptParams[1]): ScriptState;
 type ScriptState = 'loading' | 'done' | 'error';

package/dist/types/optionValueDecoder.d.ts

@@ -9,21 +9,24 @@
  *  - `-` indicates a continuous range of option values. ex: `0 1-3 4`. Ranges are only present encoded in the final option value position, so for example the trie for the set [[0,0,0],[0,0,1], ..., [0,2,2]] will be structured as `0:0:0-2,1:0-2,2:0-2`, not `0:0-2:0-2`.
  */
 import { Product } from './storefront-api-types.js';
+/** @publicDocs */
 export type IsOptionValueCombinationInEncodedVariant = (targetOptionValueCombination: number[], encodedVariantField: string) => boolean;
 /**
  * Determine whether an option value combination is present in an encoded option value string. Function is memoized by encodedVariantField.
  *
  * @param targetOptionValueCombination - Indices of option values to look up in the encoded option value string. A partial set of indices may be passed to determine whether a node or any children is present. For example, if a product has 3 options, passing [0] will return true if any option value combination for the first option's option value is present in the encoded string.
- * @param encodedVariantField - Encoded option value string from the Storefront API, e.g. [product.encodedVariantExistence](/docs/api/storefront/2026-01/objects/Product#field-encodedvariantexistence) or [product.encodedVariantAvailability](/docs/api/storefront/2026-01/objects/Product#field-encodedvariantavailability)
+ * @param encodedVariantField - Encoded option value string from the Storefront API, e.g. [product.encodedVariantExistence](/docs/api/storefront/2026-04/objects/Product#field-encodedvariantexistence) or [product.encodedVariantAvailability](/docs/api/storefront/2026-04/objects/Product#field-encodedvariantavailability)
  * @returns - True if a full or partial targetOptionValueIndices is present in the encoded option value string, false otherwise.
+ * @publicDocs
  */
 export declare const isOptionValueCombinationInEncodedVariant: IsOptionValueCombinationInEncodedVariant;
 type EncodedVariantField = Product['encodedVariantAvailability'] | Product['encodedVariantExistence'];
 type DecodedOptionValues = number[][];
 /**
  * For an encoded option value string, decode into option value combinations. Entries represent a valid combination formatted as an array of option value positions.
- * @param encodedVariantField - Encoded option value string from the Storefront API, e.g. [product.encodedVariantExistence](/docs/api/storefront/2026-01/objects/Product#field-encodedvariantexistence) or [product.encodedVariantAvailability](/docs/api/storefront/2026-01/objects/Product#field-encodedvariantavailability)
+ * @param encodedVariantField - Encoded option value string from the Storefront API, e.g. [product.encodedVariantExistence](/docs/api/storefront/2026-04/objects/Product#field-encodedvariantexistence) or [product.encodedVariantAvailability](/docs/api/storefront/2026-04/objects/Product#field-encodedvariantavailability)
  * @returns Decoded option value combinations
+ * @publicDocs
  */
 export declare function decodeEncodedVariant(encodedVariantField: EncodedVariantField): DecodedOptionValues;
 export {};

package/dist/types/parse-metafield.d.ts

@@ -9,6 +9,7 @@ import { RootASTNode as RichTextRootASTNode } from './RichText.types.js';
  * ```
  * parseMetafield<ParsedMetafields['boolean']>({type: 'boolean', value: 'false'}
  * ```
+ * @publicDocs
  */
 export declare function parseMetafield<ReturnGeneric>(metafield: PartialDeep<MetafieldBaseType, {
     recurseIntoArrays: true;

package/dist/types/storefront-api-constants.d.ts

@@ -1 +1 @@
-export declare const SFAPI_VERSION = "2026-01";
+export declare const SFAPI_VERSION = "2026-04";