@shopify/hydrogen 2026.1.4 → 2026.4.1

package/dist/production/index.d.ts

@@ -45,25 +45,30 @@ type CachingStrategy = AllCacheOptions;
 type NoStoreStrategy = {
     mode: string;
 };
+/** @publicDocs */
 declare function generateCacheControlHeader(cacheOptions: CachingStrategy): string;
 /**
  *
  * @public
+ * @publicDocs
  */
 declare function CacheNone(): NoStoreStrategy;
 /**
  *
  * @public
+ * @publicDocs
  */
 declare function CacheShort(overrideOptions?: CachingStrategy): AllCacheOptions;
 /**
  *
  * @public
+ * @publicDocs
  */
 declare function CacheLong(overrideOptions?: CachingStrategy): AllCacheOptions;
 /**
  *
  * @public
+ * @publicDocs
  */
 declare function CacheCustom(overrideOptions: CachingStrategy): AllCacheOptions;
 
@@ -1115,39 +1120,51 @@ type CartGetOptions = CartQueryOptions & {
      */
     customerAccount?: CustomerAccount;
 };
+/** @publicDocs */
 declare function cartGetDefault({ storefront, customerAccount, getCartId, cartFragment, }: CartGetOptions): CartGetFunction;
 
 type CartCreateFunction = (input: CartInput, optionalParams?: CartOptionalInput) => Promise<CartQueryDataReturn>;
+/** @publicDocs */
 declare function cartCreateDefault(options: CartQueryOptions): CartCreateFunction;
 
 type CartLinesAddFunction = (lines: Array<CartLineInput>, optionalParams?: CartOptionalInput) => Promise<CartQueryDataReturn>;
+/** @publicDocs */
 declare function cartLinesAddDefault(options: CartQueryOptions): CartLinesAddFunction;
 
 type CartLinesUpdateFunction = (lines: CartLineUpdateInput[], optionalParams?: CartOptionalInput) => Promise<CartQueryDataReturn>;
+/** @publicDocs */
 declare function cartLinesUpdateDefault(options: CartQueryOptions): CartLinesUpdateFunction;
 
 type CartLinesRemoveFunction = (lineIds: string[], optionalParams?: CartOptionalInput) => Promise<CartQueryDataReturn>;
+/** @publicDocs */
 declare function cartLinesRemoveDefault(options: CartQueryOptions): CartLinesRemoveFunction;
 
 type CartDiscountCodesUpdateFunction = (discountCodes: string[], optionalParams?: CartOptionalInput) => Promise<CartQueryDataReturn>;
+/** @publicDocs */
 declare function cartDiscountCodesUpdateDefault(options: CartQueryOptions): CartDiscountCodesUpdateFunction;
 
 type CartBuyerIdentityUpdateFunction = (buyerIdentity: CartBuyerIdentityInput, optionalParams?: CartOptionalInput) => Promise<CartQueryDataReturn>;
+/** @publicDocs */
 declare function cartBuyerIdentityUpdateDefault(options: CartQueryOptions): CartBuyerIdentityUpdateFunction;
 
 type CartNoteUpdateFunction = (note: string, optionalParams?: CartOptionalInput) => Promise<CartQueryDataReturn>;
+/** @publicDocs */
 declare function cartNoteUpdateDefault(options: CartQueryOptions): CartNoteUpdateFunction;
 
 type CartSelectedDeliveryOptionsUpdateFunction = (selectedDeliveryOptions: CartSelectedDeliveryOptionInput[], optionalParams?: CartOptionalInput) => Promise<CartQueryDataReturn>;
+/** @publicDocs */
 declare function cartSelectedDeliveryOptionsUpdateDefault(options: CartQueryOptions): CartSelectedDeliveryOptionsUpdateFunction;
 
 type CartAttributesUpdateFunction = (attributes: AttributeInput[], optionalParams?: CartOptionalInput) => Promise<CartQueryDataReturn>;
+/** @publicDocs */
 declare function cartAttributesUpdateDefault(options: CartQueryOptions): CartAttributesUpdateFunction;
 
 type CartMetafieldsSetFunction = (metafields: MetafieldWithoutOwnerId[], optionalParams?: CartOptionalInput) => Promise<CartQueryDataReturn>;
+/** @publicDocs */
 declare function cartMetafieldsSetDefault(options: CartQueryOptions): CartMetafieldsSetFunction;
 
 type CartMetafieldDeleteFunction = (key: Scalars['String']['input'], optionalParams?: CartOptionalInput) => Promise<CartQueryDataReturn>;
+/** @publicDocs */
 declare function cartMetafieldDeleteDefault(options: CartQueryOptions): CartMetafieldDeleteFunction;
 
 type CartGiftCardCodesUpdateFunction = (giftCardCodes: string[], optionalParams?: CartOptionalInput) => Promise<CartQueryDataReturn>;
@@ -1162,6 +1179,7 @@ type CartGiftCardCodesUpdateFunction = (giftCardCodes: string[], optionalParams?
  * @example Replace all gift card codes
  * const updateGiftCardCodes = cartGiftCardCodesUpdateDefault({ storefront, getCartId });
  * await updateGiftCardCodes(['SUMMER2025', 'WELCOME10']);
+ * @publicDocs
  */
 declare function cartGiftCardCodesUpdateDefault(options: CartQueryOptions): CartGiftCardCodesUpdateFunction;
 
@@ -1178,10 +1196,12 @@ type CartGiftCardCodesAddFunction = (giftCardCodes: string[], optionalParams?: C
  * @example Add gift card codes
  * const addGiftCardCodes = cartGiftCardCodesAddDefault({ storefront, getCartId });
  * await addGiftCardCodes(['SUMMER2025', 'WELCOME10']);
+ * @publicDocs
  */
 declare function cartGiftCardCodesAddDefault(options: CartQueryOptions): CartGiftCardCodesAddFunction;
 
 type CartGiftCardCodesRemoveFunction = (appliedGiftCardIds: string[], optionalParams?: CartOptionalInput) => Promise<CartQueryDataReturn>;
+/** @publicDocs */
 declare function cartGiftCardCodesRemoveDefault(options: CartQueryOptions): CartGiftCardCodesRemoveFunction;
 
 type CartDeliveryAddressesAddFunction = (addresses: Array<CartSelectableAddressInput>, optionalParams?: CartOptionalInput) => Promise<CartQueryDataReturn>;
@@ -1205,6 +1225,7 @@ type CartDeliveryAddressesAddFunction = (addresses: Array<CartSelectableAddressI
  *    }
  *  ], { someOptionalParam: 'value' }
  * );
+ * @publicDocs
  */
 declare function cartDeliveryAddressesAddDefault(options: CartQueryOptions): CartDeliveryAddressesAddFunction;
 
@@ -1224,6 +1245,7 @@ type CartDeliveryAddressesRemoveFunction = (addressIds: Array<Scalars['ID']['inp
  *   "gid://shopify/<objectName>/10079785100"
  * ],
  * { someOptionalParam: 'value' });
+ * @publicDocs
  */
 declare function cartDeliveryAddressesRemoveDefault(options: CartQueryOptions): CartDeliveryAddressesRemoveFunction;
 
@@ -1265,6 +1287,7 @@ type CartDeliveryAddressesUpdateFunction = (addresses: Array<CartSelectableAddre
       "validationStrategy": "COUNTRY_CODE_ONLY"
     }
   ],{ someOptionalParam: 'value' });
+ * @publicDocs
  */
 declare function cartDeliveryAddressesUpdateDefault(options: CartQueryOptions): CartDeliveryAddressesUpdateFunction;
 
@@ -1293,6 +1316,7 @@ type CartDeliveryAddressesReplaceFunction = (addresses: Array<CartSelectableAddr
  *    }
  *  ], { someOptionalParam: 'value' }
  * );
+ * @publicDocs
  */
 declare function cartDeliveryAddressesReplaceDefault(options: CartQueryOptions): CartDeliveryAddressesReplaceFunction;
 
@@ -1425,11 +1449,11 @@ type HydrogenCart = {
     replaceDeliveryAddresses: ReturnType<typeof cartDeliveryAddressesReplaceDefault>;
 };
 type HydrogenCartCustom<TCustomMethods extends Partial<HydrogenCart> & CustomMethodsBase> = Omit<HydrogenCart, keyof TCustomMethods> & TCustomMethods;
+/** @publicDocs */
 declare function createCartHandler(options: CartHandlerOptions): HydrogenCart;
 declare function createCartHandler<TCustomMethods extends CustomMethodsBase>(options: CartHandlerOptionsWithCustom<TCustomMethods>): HydrogenCartCustom<TCustomMethods>;
 
 type RequestEventPayload = {
-    __fromVite?: boolean;
     url: string;
     eventType: 'request' | 'subrequest';
     requestId?: string | null;
@@ -1460,6 +1484,102 @@ type RequestEventPayload = {
 declare const CUSTOMER_ACCOUNT_SESSION_KEY = "customerAccount";
 declare const BUYER_SESSION_KEY = "buyer";
 
+type ConsentStatus = boolean | undefined;
+type VisitorConsent = {
+    marketing: ConsentStatus;
+    analytics: ConsentStatus;
+    preferences: ConsentStatus;
+    sale_of_data: ConsentStatus;
+};
+type VisitorConsentCollected = {
+    analyticsAllowed: boolean;
+    firstPartyMarketingAllowed: boolean;
+    marketingAllowed: boolean;
+    preferencesAllowed: boolean;
+    saleOfDataAllowed: boolean;
+    thirdPartyMarketingAllowed: boolean;
+};
+type CustomerPrivacyApiLoaded = boolean;
+type CustomerPrivacyConsentConfig = {
+    checkoutRootDomain: string;
+    storefrontRootDomain?: string;
+    storefrontAccessToken: string;
+    country?: CountryCode$1;
+    /** The privacyBanner refers to `language` as `locale`  */
+    locale?: LanguageCode$1;
+};
+type SetConsentHeadlessParams = VisitorConsent & CustomerPrivacyConsentConfig & {
+    headlessStorefront?: boolean;
+};
+/**
+  Ideally this type should come from the Custoemr Privacy API sdk
+  analyticsProcessingAllowed -
+  currentVisitorConsent
+  doesMerchantSupportGranularConsent
+  firstPartyMarketingAllowed
+  getCCPAConsent
+  getTrackingConsent
+  marketingAllowed
+  preferencesProcessingAllowed
+  saleOfDataAllowed
+  saleOfDataRegion
+  setTrackingConsent
+  shouldShowBanner
+  shouldShowGDPRBanner
+  thirdPartyMarketingAllowed
+**/
+type OriginalCustomerPrivacy = {
+    currentVisitorConsent: () => VisitorConsent;
+    preferencesProcessingAllowed: () => boolean;
+    saleOfDataAllowed: () => boolean;
+    marketingAllowed: () => boolean;
+    analyticsProcessingAllowed: () => boolean;
+    setTrackingConsent: (consent: SetConsentHeadlessParams, callback: (data: {
+        error: string;
+    } | undefined) => void) => void;
+    shouldShowBanner: () => boolean;
+};
+type CustomerPrivacy = Omit<OriginalCustomerPrivacy, 'setTrackingConsent'> & {
+    setTrackingConsent: (consent: VisitorConsent, // we have already applied the headlessStorefront in the override
+    callback: (data: {
+        error: string;
+    } | undefined) => void) => void;
+};
+type PrivacyBanner = {
+    loadBanner: (options?: Partial<CustomerPrivacyConsentConfig>) => void;
+    showPreferences: (options?: Partial<CustomerPrivacyConsentConfig>) => void;
+};
+interface CustomEventMap$1 {
+    visitorConsentCollected: CustomEvent<VisitorConsentCollected>;
+    customerPrivacyApiLoaded: CustomEvent<CustomerPrivacyApiLoaded>;
+}
+type CustomerPrivacyApiProps = {
+    /** The production shop checkout domain url.  */
+    checkoutDomain: string;
+    /** The storefront access token for the shop. */
+    storefrontAccessToken: string;
+    /** Whether to load the Shopify privacy banner as configured in Shopify admin. Defaults to true. */
+    withPrivacyBanner?: boolean;
+    /** Country code for the shop. */
+    country?: CountryCode$1;
+    /** Language code for the shop. */
+    locale?: LanguageCode$1;
+    /** Callback to be called when visitor consent is collected. */
+    onVisitorConsentCollected?: (consent: VisitorConsentCollected) => void;
+    /** Callback to be call when customer privacy api is ready. */
+    onReady?: () => void;
+    /**
+     * Whether consent libraries can use same-domain requests to the Storefront API.
+     * Defaults to true if the standard route proxy is enabled in Hydrogen server.
+     */
+    sameDomainForStorefrontApi?: boolean;
+};
+/** @publicDocs */
+declare function useCustomerPrivacy(props: CustomerPrivacyApiProps): {
+    customerPrivacy: CustomerPrivacy | null;
+    privacyBanner?: PrivacyBanner | null;
+};
+
 interface HydrogenSessionData {
   [CUSTOMER_ACCOUNT_SESSION_KEY]: {
     accessToken?: string;
@@ -1544,7 +1664,9 @@ declare global {
   interface Window {
     privacyBanner: PrivacyBanner;
     Shopify: {
-      customerPrivacy: CustomerPrivacy;
+      customerPrivacy?: Partial<CustomerPrivacy> & {
+        backendConsentEnabled?: boolean;
+      };
     };
   }
   interface Document {
@@ -1664,12 +1786,14 @@ type StorefrontQueryOptions = StorefrontCommonExtraParams & {
     cache?: CachingStrategy;
 };
 /**
- *  This function extends `createStorefrontClient` from [Hydrogen React](/docs/api/hydrogen-react/2026-01/utilities/createstorefrontclient). The additional arguments enable internationalization (i18n), caching, and other features particular to Remix and Oxygen.
+ *  This function extends `createStorefrontClient` from [Hydrogen React](/docs/api/hydrogen-react/2026-04/utilities/createstorefrontclient). The additional arguments enable internationalization (i18n), caching, and other features particular to Remix and Oxygen.
  *
  *  Learn more about [data fetching in Hydrogen](/docs/custom-storefronts/hydrogen/data-fetching/fetch-data).
+ * @publicDocs
  */
 declare function createStorefrontClient<TI18n extends I18nBase>(options: CreateStorefrontClientOptions<TI18n>): StorefrontClient<TI18n>;
 declare function formatAPIResult<T>(data: T, errors: StorefrontApiErrors): T & StorefrontError;
+/** @publicDocs */
 type CreateStorefrontClientForDocs<TI18n extends I18nBase> = {
     storefront?: StorefrontForDoc<TI18n>;
 };
@@ -1690,13 +1814,13 @@ type StorefrontForDoc<TI18n extends I18nBase = I18nBase> = {
     CacheCustom?: typeof CacheCustom;
     /** Re-export of [`generateCacheControlHeader`](/docs/api/hydrogen/utilities/generatecachecontrolheader). */
     generateCacheControlHeader?: typeof generateCacheControlHeader;
-    /** Returns an object that contains headers that are needed for each query to Storefront API GraphQL endpoint. See [`getPublicTokenHeaders` in Hydrogen React](/docs/api/hydrogen-react/2026-01/utilities/createstorefrontclient#:~:text=%27graphql%27.-,getPublicTokenHeaders,-(props%3F%3A) for more details. */
+    /** Returns an object that contains headers that are needed for each query to Storefront API GraphQL endpoint. See [`getPublicTokenHeaders` in Hydrogen React](/docs/api/hydrogen-react/2026-04/utilities/createstorefrontclient#:~:text=%27graphql%27.-,getPublicTokenHeaders,-(props%3F%3A) for more details. */
     getPublicTokenHeaders?: ReturnType<typeof createStorefrontClient$1>['getPublicTokenHeaders'];
-    /** Returns an object that contains headers that are needed for each query to Storefront API GraphQL endpoint for API calls made from a server. See [`getPrivateTokenHeaders` in  Hydrogen React](/docs/api/hydrogen-react/2026-01/utilities/createstorefrontclient#:~:text=storefrontApiVersion-,getPrivateTokenHeaders,-(props%3F%3A) for more details.*/
+    /** Returns an object that contains headers that are needed for each query to Storefront API GraphQL endpoint for API calls made from a server. See [`getPrivateTokenHeaders` in  Hydrogen React](/docs/api/hydrogen-react/2026-04/utilities/createstorefrontclient#:~:text=storefrontApiVersion-,getPrivateTokenHeaders,-(props%3F%3A) for more details.*/
     getPrivateTokenHeaders?: ReturnType<typeof createStorefrontClient$1>['getPrivateTokenHeaders'];
-    /** Creates the fully-qualified URL to your myshopify.com domain. See [`getShopifyDomain` in  Hydrogen React](/docs/api/hydrogen-react/2026-01/utilities/createstorefrontclient#:~:text=StorefrontClientReturn-,getShopifyDomain,-(props%3F%3A) for more details. */
+    /** Creates the fully-qualified URL to your myshopify.com domain. See [`getShopifyDomain` in  Hydrogen React](/docs/api/hydrogen-react/2026-04/utilities/createstorefrontclient#:~:text=StorefrontClientReturn-,getShopifyDomain,-(props%3F%3A) for more details. */
     getShopifyDomain?: ReturnType<typeof createStorefrontClient$1>['getShopifyDomain'];
-    /** Creates the fully-qualified URL to your store's GraphQL endpoint. See [`getStorefrontApiUrl` in  Hydrogen React](/docs/api/hydrogen-react/2026-01/utilities/createstorefrontclient#:~:text=storeDomain-,getStorefrontApiUrl,-(props%3F%3A) for more details.*/
+    /** Creates the fully-qualified URL to your store's GraphQL endpoint. See [`getStorefrontApiUrl` in  Hydrogen React](/docs/api/hydrogen-react/2026-04/utilities/createstorefrontclient#:~:text=storeDomain-,getStorefrontApiUrl,-(props%3F%3A) for more details.*/
     getApiUrl?: ReturnType<typeof createStorefrontClient$1>['getStorefrontApiUrl'];
     /** The `i18n` object passed in from the `createStorefrontClient` argument. */
     i18n?: TI18n;
@@ -1894,107 +2018,17 @@ type CustomViewProps = {
     data?: OtherData;
     customData?: OtherData;
 };
+/** @publicDocs */
 declare function AnalyticsProductView(props: ProductViewProps): react_jsx_runtime.JSX.Element;
+/** @publicDocs */
 declare function AnalyticsCollectionView(props: CollectionViewProps): react_jsx_runtime.JSX.Element;
+/** @publicDocs */
 declare function AnalyticsCartView(props: BasicViewProps): react_jsx_runtime.JSX.Element;
+/** @publicDocs */
 declare function AnalyticsSearchView(props: SearchViewProps): react_jsx_runtime.JSX.Element;
+/** @publicDocs */
 declare function AnalyticsCustomView(props: CustomViewProps): react_jsx_runtime.JSX.Element;
 
-type ConsentStatus = boolean | undefined;
-type VisitorConsent = {
-    marketing: ConsentStatus;
-    analytics: ConsentStatus;
-    preferences: ConsentStatus;
-    sale_of_data: ConsentStatus;
-};
-type VisitorConsentCollected = {
-    analyticsAllowed: boolean;
-    firstPartyMarketingAllowed: boolean;
-    marketingAllowed: boolean;
-    preferencesAllowed: boolean;
-    saleOfDataAllowed: boolean;
-    thirdPartyMarketingAllowed: boolean;
-};
-type CustomerPrivacyApiLoaded = boolean;
-type CustomerPrivacyConsentConfig = {
-    checkoutRootDomain: string;
-    storefrontRootDomain?: string;
-    storefrontAccessToken: string;
-    country?: CountryCode$1;
-    /** The privacyBanner refers to `language` as `locale`  */
-    locale?: LanguageCode$1;
-};
-type SetConsentHeadlessParams = VisitorConsent & CustomerPrivacyConsentConfig & {
-    headlessStorefront?: boolean;
-};
-/**
-  Ideally this type should come from the Custoemr Privacy API sdk
-  analyticsProcessingAllowed -
-  currentVisitorConsent
-  doesMerchantSupportGranularConsent
-  firstPartyMarketingAllowed
-  getCCPAConsent
-  getTrackingConsent
-  marketingAllowed
-  preferencesProcessingAllowed
-  saleOfDataAllowed
-  saleOfDataRegion
-  setTrackingConsent
-  shouldShowBanner
-  shouldShowGDPRBanner
-  thirdPartyMarketingAllowed
-**/
-type OriginalCustomerPrivacy = {
-    currentVisitorConsent: () => VisitorConsent;
-    preferencesProcessingAllowed: () => boolean;
-    saleOfDataAllowed: () => boolean;
-    marketingAllowed: () => boolean;
-    analyticsProcessingAllowed: () => boolean;
-    setTrackingConsent: (consent: SetConsentHeadlessParams, callback: (data: {
-        error: string;
-    } | undefined) => void) => void;
-    shouldShowBanner: () => boolean;
-};
-type CustomerPrivacy$1 = Omit<OriginalCustomerPrivacy, 'setTrackingConsent'> & {
-    setTrackingConsent: (consent: VisitorConsent, // we have already applied the headlessStorefront in the override
-    callback: (data: {
-        error: string;
-    } | undefined) => void) => void;
-};
-type PrivacyBanner$1 = {
-    loadBanner: (options?: Partial<CustomerPrivacyConsentConfig>) => void;
-    showPreferences: (options?: Partial<CustomerPrivacyConsentConfig>) => void;
-};
-interface CustomEventMap$1 {
-    visitorConsentCollected: CustomEvent<VisitorConsentCollected>;
-    customerPrivacyApiLoaded: CustomEvent<CustomerPrivacyApiLoaded>;
-}
-type CustomerPrivacyApiProps = {
-    /** The production shop checkout domain url.  */
-    checkoutDomain: string;
-    /** The storefront access token for the shop. */
-    storefrontAccessToken: string;
-    /** Whether to load the Shopify privacy banner as configured in Shopify admin. Defaults to true. */
-    withPrivacyBanner?: boolean;
-    /** Country code for the shop. */
-    country?: CountryCode$1;
-    /** Language code for the shop. */
-    locale?: LanguageCode$1;
-    /** Callback to be called when visitor consent is collected. */
-    onVisitorConsentCollected?: (consent: VisitorConsentCollected) => void;
-    /** Callback to be call when customer privacy api is ready. */
-    onReady?: () => void;
-    /**
-     * Whether consent libraries can use same-domain requests to the Storefront API.
-     * Defaults to true if the standard route proxy is enabled in Hydrogen server.
-     */
-    sameDomainForStorefrontApi?: boolean;
-};
-declare function useCustomerPrivacy(props: CustomerPrivacyApiProps): {
-    customerPrivacy: CustomerPrivacy$1 | null;
-    privacyBanner?: PrivacyBanner$1 | null;
-};
-
 type ShopAnalytics = {
     /** The shop ID. */
     shopId: string;
@@ -2008,6 +2042,7 @@ type ShopAnalytics = {
 type Consent = Partial<Pick<CustomerPrivacyApiProps, 'checkoutDomain' | 'sameDomainForStorefrontApi' | 'storefrontAccessToken' | 'withPrivacyBanner' | 'country'>> & {
     language?: LanguageCode$1;
 };
+/** @publicDocs */
 type AnalyticsProviderProps = {
     /** React children to render. */
     children?: ReactNode;
@@ -2046,9 +2081,9 @@ type AnalyticsContextValue = {
     /** A function to subscribe to analytics events. */
     subscribe: typeof subscribe;
     /** The privacy banner SDK methods with the config applied */
-    privacyBanner: PrivacyBanner$1 | null;
+    privacyBanner: PrivacyBanner | null;
     /** The customer privacy SDK methods with the config applied */
-    customerPrivacy: CustomerPrivacy$1 | null;
+    customerPrivacy: CustomerPrivacy | null;
 };
 declare function subscribe(event: typeof AnalyticsEvent.PAGE_VIEWED, callback: (payload: PageViewPayload) => void): void;
 declare function subscribe(event: typeof AnalyticsEvent.PRODUCT_VIEWED, callback: (payload: ProductViewPayload) => void): void;
@@ -2068,6 +2103,7 @@ declare function publish(event: typeof AnalyticsEvent.PRODUCT_ADD_TO_CART, paylo
 declare function publish(event: typeof AnalyticsEvent.PRODUCT_REMOVED_FROM_CART, payload: CartLineUpdatePayload): void;
 declare function publish(event: typeof AnalyticsEvent.CUSTOM_EVENT, payload: OtherData): void;
 declare function AnalyticsProvider({ canTrack: customCanTrack, cart: currentCart, children, consent, customData, shop: shopProp, cookieDomain, }: AnalyticsProviderProps): JSX.Element;
+/** @publicDocs */
 declare function useAnalytics(): AnalyticsContextValue;
 type ShopAnalyticsProps = {
     /**
@@ -2079,6 +2115,7 @@ type ShopAnalyticsProps = {
      */
     publicStorefrontId: string;
 };
+/** @publicDocs */
 declare function getShopAnalytics({ storefront, publicStorefrontId, }: ShopAnalyticsProps): Promise<ShopAnalytics | null>;
 declare const Analytics: {
     CartView: typeof AnalyticsCartView;
@@ -2139,6 +2176,7 @@ type WithCache = {
         response: Response;
     }>;
 };
+/** @publicDocs */
 declare function createWithCache(cacheOptions: CreateWithCacheOptions): WithCache;
 
 /**
@@ -2146,6 +2184,7 @@ declare function createWithCache(cacheOptions: CreateWithCacheOptions): WithCach
  * It only supports the `cache-control` header.
  * It does NOT support `age` or `expires` headers.
  * @see https://developer.mozilla.org/en-US/docs/Web/API/Cache
+ * @publicDocs
  */
 declare class InMemoryCache implements Cache {
     #private;
@@ -2408,6 +2447,7 @@ type CartFormCommonProps = {
 type CartActionInputProps = CartAttributesUpdateProps | CartBuyerIdentityUpdateProps | CartCreateProps | CartDiscountCodesUpdateProps | CartGiftCardCodesUpdateProps | CartGiftCardCodesAddProps | CartGiftCardCodesRemoveProps | CartLinesAddProps | CartLinesUpdateProps | CartLinesRemoveProps | CartNoteUpdateProps | CartSelectedDeliveryOptionsUpdateProps | CartMetafieldsSetProps | CartMetafieldDeleteProps | CartDeliveryAddressesAddProps | CartDeliveryAddressesRemoveProps | CartDeliveryAddressesUpdateProps | CartDeliveryAddressesReplaceProps | CartCustomProps;
 type CartActionInput = CartAttributesUpdateRequire | CartBuyerIdentityUpdateRequire | CartCreateRequire | CartDiscountCodesUpdateRequire | CartGiftCardCodesUpdateRequire | CartGiftCardCodesAddRequire | CartGiftCardCodesRemoveRequire | CartLinesAddRequire | CartLinesUpdateRequire | CartLinesRemoveRequire | CartNoteUpdateRequire | CartSelectedDeliveryOptionsUpdateRequire | CartMetafieldsSetRequire | CartMetafieldDeleteRequire | CartDeliveryAddressesAddRequire | CartDeliveryAddressesRemoveRequire | CartDeliveryAddressesUpdateRequire | CartDeliveryAddressesReplaceRequire | CartCustomRequire;
 type CartFormProps = CartActionInputProps & CartFormCommonProps;
+/** @publicDocs */
 declare function CartForm({ children, action, inputs, route, fetcherKey, }: CartFormProps): JSX.Element;
 declare namespace CartForm {
     var INPUT_NAME: string;
@@ -2434,6 +2474,7 @@ declare namespace CartForm {
     var getFormInput: (formData: FormData) => CartActionInput;
 }
 
+/** @publicDocs */
 declare const cartGetIdDefault: (requestHeaders: CrossRuntimeRequest["headers"]) => () => string | undefined;
 
 type CookieOptions = {
@@ -2445,6 +2486,7 @@ type CookieOptions = {
     domain?: string;
     path?: string;
 };
+/** @publicDocs */
 declare const cartSetIdDefault: (cookieOptions?: CookieOptions) => (cartId: string) => Headers;
 
 type LikeACart = {
@@ -2475,6 +2517,7 @@ type OptimisticCart<T = CartReturn> = T extends undefined | null ? // This is th
  * @param cart The cart object from `context.cart.get()` returned by a server loader.
  *
  * @returns A new cart object augmented with optimistic state for `lines` and `totalQuantity`. Each cart line item that is optimistically added includes an `isOptimistic` property. Also if the cart has _any_ optimistic state, a root property `isOptimistic` will be set to `true`.
+ * @publicDocs
  */
 declare function useOptimisticCart<DefaultCart = {
     lines?: {
@@ -2510,6 +2553,7 @@ declare function changelogHandler({ request, changelogUrl, }: {
  *   const cart = context.get(hydrogenContext.cart);
  * }
  * ```
+ * @publicDocs
  */
 declare const hydrogenContext: {
     readonly storefront: react_router.RouterContext<Storefront<I18nBase>>;
@@ -2590,6 +2634,7 @@ interface HydrogenContext<TSession extends HydrogenSession = HydrogenSession, TC
     /** Any cookie implementation. By default Hydrogen ships with cookie session storage, but you can use [another session storage](https://remix.run/docs/en/main/utils/sessions) implementation.  */
     session: TSession;
 }
+/** @publicDocs */
 declare function createHydrogenContext<TSession extends HydrogenSession, TCustomMethods extends CustomMethodsBase | undefined = {}, TI18n extends I18nBase = I18nBase, TEnv extends HydrogenEnv = Env, TAdditionalContext extends Record<string, any> = {}>(options: HydrogenContextOptions<TSession, TCustomMethods, TI18n, TEnv>, additionalContext?: TAdditionalContext): HydrogenRouterContextProvider<TSession, TCustomMethods, TI18n, TEnv> & TAdditionalContext;
 
 type CreateRequestHandlerOptions<Context = unknown> = {
@@ -2615,20 +2660,15 @@ type CreateRequestHandlerOptions<Context = unknown> = {
      * @default true
      */
     collectTrackingInformation?: boolean;
-    /**
-     * Whether to proxy standard routes such as `/api/.../graphql.json` (Storefront API).
-     * You can disable this if you are handling these routes yourself. Ensure that
-     * the proxy works if you rely on Hydrogen's built-in behaviors such as analytics.
-     * @default true
-     */
-    proxyStandardRoutes?: boolean;
 };
 /**
  * Creates a request handler for Hydrogen apps using React Router.
+ * @publicDocs
  */
-declare function createRequestHandler<Context = unknown>({ build, mode, poweredByHeader, getLoadContext, collectTrackingInformation, proxyStandardRoutes, }: CreateRequestHandlerOptions<Context>): (request: Request) => Promise<Response>;
+declare function createRequestHandler<Context = unknown>({ build, mode, poweredByHeader, getLoadContext, collectTrackingInformation, }: CreateRequestHandlerOptions<Context>): (request: Request) => Promise<Response>;
 
 declare const NonceProvider: react.Provider<string | undefined>;
+/** @publicDocs */
 declare const useNonce: () => string | undefined;
 type ContentSecurityPolicy = {
     /** A randomly generated nonce string that should be passed to any custom `script` element */
@@ -2678,6 +2718,7 @@ type ShopProp = {
 };
 /**
  * @param directives - Pass custom [content security policy directives](https://content-security-policy.com/). This is important if you load content in your app from third-party domains.
+ * @publicDocs
  */
 declare function createContentSecurityPolicy(props?: CreateContentSecurityPolicy & ShopProp): ContentSecurityPolicy;
 
@@ -2687,12 +2728,15 @@ interface HydrogenScriptProps {
 }
 interface ScriptAttributes extends ScriptHTMLAttributes<HTMLScriptElement> {
 }
+/** @publicDocs */
 declare const Script: react.ForwardRefExoticComponent<HydrogenScriptProps & ScriptAttributes & react.RefAttributes<HTMLScriptElement>>;
 
+/** @publicDocs */
 declare function createCustomerAccountClient({ session, customerAccountId, shopId, customerApiVersion, request, waitUntil, authUrl, customAuthStatusHandler, logErrors, loginPath, authorizePath, defaultRedirectPath, language, useCustomAuthDomain, }: CustomerAccountOptions): CustomerAccount;
 
 declare function hydrogenRoutes(currentRoutes: Array<RouteConfigEntry>): Promise<Array<RouteConfigEntry>>;
 
+/** @publicDocs */
 declare function useOptimisticData<T>(identifier: string): T;
 type OptimisticInputProps = {
     /**
@@ -2706,6 +2750,7 @@ type OptimisticInputProps = {
      */
     data: Record<string, unknown>;
 };
+/** @publicDocs */
 declare function OptimisticInput({ id, data }: OptimisticInputProps): react_jsx_runtime.JSX.Element;
 
 declare global {
@@ -2765,6 +2810,7 @@ type PaginationRenderProp<NodesType> = FC<PaginationInfo<NodesType>>;
  *
  * @prop connection The response from `storefront.query` for a paginated request. Make sure the query is passed pagination variables and that the query has `pageInfo` with `hasPreviousPage`, `hasNextpage`, `startCursor`, and `endCursor` defined.
  * @prop children A render prop that includes pagination data and helpers.
+ * @publicDocs
  */
 declare function Pagination<NodesType>({ connection, children, namespace, }: PaginationProps<NodesType>): ReturnType<FC>;
 /**
@@ -2772,6 +2818,7 @@ declare function Pagination<NodesType>({ connection, children, namespace, }: Pag
  * @param options Options for how to configure the pagination variables. Includes the ability to change how many nodes are within each page as well as a namespace to avoid URL param conflicts when using multiple `Pagination` components on a single page.
  *
  * @returns Variables to be used with the `storefront.query` function
+ * @publicDocs
  */
 declare function getPaginationVariables(request: Request, options?: {
     pageBy: number;
@@ -2793,6 +2840,7 @@ type OptimisticProductVariants = Array<PartialDeep<ProductVariant>> | Promise<Ar
  * @param selectedVariant The `selectedVariant` field queried with `variantBySelectedOptions`.
  * @param variants The available product variants for the product. This can be an array of variants, a promise that resolves to an array of variants, or an object with a `product` key that contains the variants.
  * @returns A new product object where the `selectedVariant` property is set to the variant that matches the current URL search params. If no variant is found, the original product object is returned. The `isOptimistic` property is set to `true` if the `selectedVariant` has been optimistically changed.
+ * @publicDocs
  */
 declare function useOptimisticVariant<SelectedVariant = OptimisticVariantInput, Variants = OptimisticProductVariants>(selectedVariant: SelectedVariant, variants: Variants): OptimisticVariant<SelectedVariant>;
 
@@ -2827,9 +2875,9 @@ type VariantOptionValue = {
 type VariantSelectorProps = {
     /** The product handle for all of the variants */
     handle: string;
-    /** Product options from the [Storefront API](/docs/api/storefront/2026-01/objects/ProductOption). Make sure both `name` and `values` are a part of your query. */
+    /** Product options from the [Storefront API](/docs/api/storefront/2026-04/objects/ProductOption). Make sure both `name` and `values` are a part of your query. */
     options: Array<PartialProductOption> | undefined;
-    /** Product variants from the [Storefront API](/docs/api/storefront/2026-01/objects/ProductVariant). You only need to pass this prop if you want to show product availability. If a product option combination is not found within `variants`, it is assumed to be available. Make sure to include `availableForSale` and `selectedOptions.name` and `selectedOptions.value`. */
+    /** Product variants from the [Storefront API](/docs/api/storefront/2026-04/objects/ProductVariant). You only need to pass this prop if you want to show product availability. If a product option combination is not found within `variants`, it is assumed to be available. Make sure to include `availableForSale` and `selectedOptions.name` and `selectedOptions.value`. */
     variants?: PartialDeep<ProductVariantConnection> | Array<PartialDeep<ProductVariant>>;
     /** By default all products are under /products. Use this prop to provide a custom path. */
     productPath?: string;
@@ -2848,10 +2896,12 @@ type VariantSelectorProps = {
  * [getAdjacentAndFirstAvailableVariants](https://shopify.dev/docs/api/hydrogen/latest/utilities/getadjacentandfirstavailablevariants) utils instead.
  * and [useSelectedOptionInUrlParam](https://shopify.dev/docs/api/hydrogen/latest/utilities/useselectedoptioninurlparam)
  * For a full implementation see the Skeleton template [routes/product.$handle.tsx](https://github.com/Shopify/hydrogen/blob/main/templates/skeleton/app/routes/products.%24handle.tsx).
+ * @publicDocs
  */
 declare function VariantSelector({ handle, options: _options, variants: _variants, productPath, waitForNavigation, selectedVariant, children, }: VariantSelectorProps): react.FunctionComponentElement<{
     children?: ReactNode | undefined;
 }>;
+/** @publicDocs */
 type GetSelectedProductOptions = (request: Request) => SelectedOptionInput[];
 /**
  * Extract searchParams from a Request instance and return an array of selected options.
@@ -2872,6 +2922,7 @@ type GetSelectedProductOptions = (request: Request) => SelectedOptionInput[];
  * //   {name: 'size', value: 'large'}
  * // ]
  * ```
+ * @publicDocs
  **/
 declare const getSelectedProductOptions: GetSelectedProductOptions;
 
@@ -2919,7 +2970,9 @@ declare function hydrogenPreset(): Preset;
 
 declare const RichText: typeof RichText$1;
 
+/** @publicDocs */
 type GraphiQLLoader = (args: LoaderFunctionArgs) => Promise<Response>;
+/** @publicDocs */
 declare const graphiqlLoader: GraphiQLLoader;
 
 type StorefrontRedirect = {
@@ -2941,6 +2994,7 @@ type StorefrontRedirect = {
  * conditionally redirecting after a 404 response.
  *
  * @see {@link https://help.shopify.com/en/manual/online-store/menus-and-links/url-redirect Creating URL redirects in Shopify}
+ * @publicDocs
  */
 declare function storefrontRedirect(options: StorefrontRedirect): Promise<Response>;
 
@@ -3212,6 +3266,7 @@ type GetSeoMetaReturn = ReturnType<MetaFunction>;
 type Optional<T> = T | null | undefined;
 /**
  * Generate a Remix meta array from one or more SEO configuration objects. This is useful to pass SEO configuration for the parent route(s) and the current route. Similar to `Object.assign()`, each property is overwritten based on the object order. The exception is `jsonLd`, which is preserved so that each route has it's own independent jsonLd meta data.
+ * @publicDocs
  */
 declare function getSeoMeta(...seoInputs: Optional<SeoConfig>[]): GetSeoMetaReturn;
 
@@ -3232,6 +3287,7 @@ interface SeoProps {
 }
 /**
  * @deprecated - use `getSeoMeta` instead
+ * @publicDocs
  */
 declare function Seo({ debug }: SeoProps): react.FunctionComponentElement<{
     children?: react.ReactNode | undefined;
@@ -3252,6 +3308,7 @@ interface SitemapIndexOptions {
 }
 /**
  * Generate a sitemap index that links to separate sitemaps for each resource type. Returns a standard Response object.
+ * @publicDocs
  */
 declare function getSitemapIndex(options: SitemapIndexOptions): Promise<Response>;
 interface GetSiteMapOptions {
@@ -3280,7 +3337,8 @@ interface GetSiteMapOptions {
 }
 /**
  * Generate a sitemap for a specific resource type.
+ * @publicDocs
  */
 declare function getSitemap(options: GetSiteMapOptions): Promise<Response>;
 
-export { Analytics, AnalyticsEvent, CacheCustom, type CacheKey, CacheLong, CacheNone, CacheShort, type CachingStrategy, type CartActionInput, CartForm, type CartLineUpdatePayload, type CartQueryDataReturn, type CartQueryOptions, type CartQueryReturn, type CartReturn, type CartUpdatePayload, type CartViewPayload, type CollectionViewPayload, type ConsentStatus, type CookieOptions, type CreateStorefrontClientForDocs, type CreateStorefrontClientOptions, type CustomEventMap$1 as CustomEventMap, type CustomerAccount, type CustomerAccountMutations, type CustomerAccountQueries, type CustomerPrivacy$1 as CustomerPrivacy, type CustomerPrivacyApiProps, type CustomerPrivacyConsentConfig, type HydrogenCart, type HydrogenCartCustom, type HydrogenContext, type HydrogenEnv, type HydrogenRouterContextProvider, type HydrogenSession, type HydrogenSessionData, type I18nBase, InMemoryCache, type MetafieldWithoutOwnerId, type NoStoreStrategy, NonceProvider, type OptimisticCart, type OptimisticCartLine, type OptimisticCartLineInput, OptimisticInput, type PageViewPayload, Pagination, type PrivacyBanner$1 as PrivacyBanner, type ProductViewPayload, RichText, Script, type SearchViewPayload, Seo, type SeoConfig, type SeoHandleFunction, type SetConsentHeadlessParams, type ShopAnalytics, ShopPayButton, type Storefront, type StorefrontApiErrors, type StorefrontClient, type StorefrontForDoc, type StorefrontMutationOptionsForDocs, type StorefrontMutations, type StorefrontQueries, type StorefrontQueryOptionsForDocs, type VariantOption, type VariantOptionValue, VariantSelector, type VisitorConsent, type VisitorConsentCollected, type WithCache, cartAttributesUpdateDefault, cartBuyerIdentityUpdateDefault, cartCreateDefault, cartDiscountCodesUpdateDefault, cartGetDefault, cartGetIdDefault, cartGiftCardCodesAddDefault, cartGiftCardCodesRemoveDefault, cartGiftCardCodesUpdateDefault, cartLinesAddDefault, cartLinesRemoveDefault, cartLinesUpdateDefault, cartMetafieldDeleteDefault, cartMetafieldsSetDefault, cartNoteUpdateDefault, cartSelectedDeliveryOptionsUpdateDefault, cartSetIdDefault, changelogHandler, createCartHandler, createContentSecurityPolicy, createCustomerAccountClient, createHydrogenContext, createRequestHandler, createStorefrontClient, createWithCache, formatAPIResult, generateCacheControlHeader, getPaginationVariables, getSelectedProductOptions, getSeoMeta, getShopAnalytics, getSitemap, getSitemapIndex, graphiqlLoader, hydrogenContext, hydrogenPreset, hydrogenRoutes, storefrontRedirect, useAnalytics, useCustomerPrivacy, useNonce, useOptimisticCart, useOptimisticData, useOptimisticVariant };
+export { Analytics, AnalyticsEvent, CacheCustom, type CacheKey, CacheLong, CacheNone, CacheShort, type CachingStrategy, type CartActionInput, CartForm, type CartLineUpdatePayload, type CartQueryDataReturn, type CartQueryOptions, type CartQueryReturn, type CartReturn, type CartUpdatePayload, type CartViewPayload, type CollectionViewPayload, type ConsentStatus, type CookieOptions, type CreateStorefrontClientForDocs, type CreateStorefrontClientOptions, type CustomEventMap$1 as CustomEventMap, type CustomerAccount, type CustomerAccountMutations, type CustomerAccountQueries, type CustomerPrivacy, type CustomerPrivacyApiProps, type CustomerPrivacyConsentConfig, type HydrogenCart, type HydrogenCartCustom, type HydrogenContext, type HydrogenEnv, type HydrogenRouterContextProvider, type HydrogenSession, type HydrogenSessionData, type I18nBase, InMemoryCache, type MetafieldWithoutOwnerId, type NoStoreStrategy, NonceProvider, type OptimisticCart, type OptimisticCartLine, type OptimisticCartLineInput, OptimisticInput, type PageViewPayload, Pagination, type PrivacyBanner, type ProductViewPayload, RichText, Script, type SearchViewPayload, Seo, type SeoConfig, type SeoHandleFunction, type SetConsentHeadlessParams, type ShopAnalytics, ShopPayButton, type Storefront, type StorefrontApiErrors, type StorefrontClient, type StorefrontForDoc, type StorefrontMutationOptionsForDocs, type StorefrontMutations, type StorefrontQueries, type StorefrontQueryOptionsForDocs, type VariantOption, type VariantOptionValue, VariantSelector, type VisitorConsent, type VisitorConsentCollected, type WithCache, cartAttributesUpdateDefault, cartBuyerIdentityUpdateDefault, cartCreateDefault, cartDiscountCodesUpdateDefault, cartGetDefault, cartGetIdDefault, cartGiftCardCodesAddDefault, cartGiftCardCodesRemoveDefault, cartGiftCardCodesUpdateDefault, cartLinesAddDefault, cartLinesRemoveDefault, cartLinesUpdateDefault, cartMetafieldDeleteDefault, cartMetafieldsSetDefault, cartNoteUpdateDefault, cartSelectedDeliveryOptionsUpdateDefault, cartSetIdDefault, changelogHandler, createCartHandler, createContentSecurityPolicy, createCustomerAccountClient, createHydrogenContext, createRequestHandler, createStorefrontClient, createWithCache, formatAPIResult, generateCacheControlHeader, getPaginationVariables, getSelectedProductOptions, getSeoMeta, getShopAnalytics, getSitemap, getSitemapIndex, graphiqlLoader, hydrogenContext, hydrogenPreset, hydrogenRoutes, storefrontRedirect, useAnalytics, useCustomerPrivacy, useNonce, useOptimisticCart, useOptimisticData, useOptimisticVariant };