@shopify/hydrogen 2026.4.0 → 2026.4.1

package/dist/production/index.d.cts

@@ -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;
@@ -1550,6 +1574,7 @@ type CustomerPrivacyApiProps = {
      */
     sameDomainForStorefrontApi?: boolean;
 };
+/** @publicDocs */
 declare function useCustomerPrivacy(props: CustomerPrivacyApiProps): {
     customerPrivacy: CustomerPrivacy | null;
     privacyBanner?: PrivacyBanner | null;
@@ -1764,9 +1789,11 @@ type StorefrontQueryOptions = StorefrontCommonExtraParams & {
  *  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>;
 };
@@ -1991,10 +2018,15 @@ 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 ShopAnalytics = {
@@ -2010,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;
@@ -2070,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 = {
     /**
@@ -2081,6 +2115,7 @@ type ShopAnalyticsProps = {
      */
     publicStorefrontId: string;
 };
+/** @publicDocs */
 declare function getShopAnalytics({ storefront, publicStorefrontId, }: ShopAnalyticsProps): Promise<ShopAnalytics | null>;
 declare const Analytics: {
     CartView: typeof AnalyticsCartView;
@@ -2141,6 +2176,7 @@ type WithCache = {
         response: Response;
     }>;
 };
+/** @publicDocs */
 declare function createWithCache(cacheOptions: CreateWithCacheOptions): WithCache;
 
 /**
@@ -2148,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;
@@ -2410,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;
@@ -2436,6 +2474,7 @@ declare namespace CartForm {
     var getFormInput: (formData: FormData) => CartActionInput;
 }
 
+/** @publicDocs */
 declare const cartGetIdDefault: (requestHeaders: CrossRuntimeRequest["headers"]) => () => string | undefined;
 
 type CookieOptions = {
@@ -2447,6 +2486,7 @@ type CookieOptions = {
     domain?: string;
     path?: string;
 };
+/** @publicDocs */
 declare const cartSetIdDefault: (cookieOptions?: CookieOptions) => (cartId: string) => Headers;
 
 type LikeACart = {
@@ -2477,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?: {
@@ -2512,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>>;
@@ -2592,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> = {
@@ -2620,10 +2663,12 @@ type CreateRequestHandlerOptions<Context = unknown> = {
 };
 /**
  * Creates a request handler for Hydrogen apps using React Router.
+ * @publicDocs
  */
 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 */
@@ -2673,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;
 
@@ -2682,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 = {
     /**
@@ -2701,6 +2750,7 @@ type OptimisticInputProps = {
      */
     data: Record<string, unknown>;
 };
+/** @publicDocs */
 declare function OptimisticInput({ id, data }: OptimisticInputProps): react_jsx_runtime.JSX.Element;
 
 declare global {
@@ -2760,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>;
 /**
@@ -2767,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;
@@ -2788,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>;
 
@@ -2843,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.
@@ -2867,6 +2922,7 @@ type GetSelectedProductOptions = (request: Request) => SelectedOptionInput[];
  * //   {name: 'size', value: 'large'}
  * // ]
  * ```
+ * @publicDocs
  **/
 declare const getSelectedProductOptions: GetSelectedProductOptions;
 
@@ -2914,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 = {
@@ -2936,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>;
 
@@ -3207,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;
 
@@ -3227,6 +3287,7 @@ interface SeoProps {
 }
 /**
  * @deprecated - use `getSeoMeta` instead
+ * @publicDocs
  */
 declare function Seo({ debug }: SeoProps): react.FunctionComponentElement<{
     children?: react.ReactNode | undefined;
@@ -3247,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 {
@@ -3275,6 +3337,7 @@ interface GetSiteMapOptions {
 }
 /**
  * Generate a sitemap for a specific resource type.
+ * @publicDocs
  */
 declare function getSitemap(options: GetSiteMapOptions): Promise<Response>;