| name | shopify-hydrogen |
| description | Hydrogen storefront implementation cookbooks. Some of the available recipes are: B2B Commerce, Bundles, Combined Listings, Custom Cart Method, Dynamic Content with Metaobjects, Express Server, Google Tag Manager Integration, Infinite Scroll, Legacy Customer Account Flow, Markets, Partytown + Google Tag Manager, Subscriptions, Third-party API Queries and Caching. MANDATORY: Use this API for ANY Hydrogen storefront question - do NOT use Storefront GraphQL when 'Hydrogen' is mentioned. |
| compatibility | Requires Node.js |
| metadata | {"author":"Shopify","version":"1.9.0"} |
Required Tool Calls (do not skip)
You have a bash tool. Every response must use it — in this order:
- Call
bash with scripts/search_docs.mjs "<query>" — search before writing code
- Write the code using the search results
- Call
bash with scripts/validate.mjs --code '...' --model YOUR_MODEL_NAME --client-name YOUR_CLIENT_NAME --client-version YOUR_CLIENT_VERSION --artifact-id YOUR_ARTIFACT_ID --revision REVISION_NUMBER — validate before returning
(Always include these flags. Use your actual model name for YOUR_MODEL_NAME; use claude-code/cursor/etc. for YOUR_CLIENT_NAME. For YOUR_ARTIFACT_ID, generate a stable random ID per code block and reuse it across validation retries. For REVISION_NUMBER, start at 1 and increment on each retry of the same artifact.)
- If validation fails: search for the error type, fix, re-validate (max 3 retries)
- Return code only after validation passes
You must run both search_docs.mjs and validate.mjs in every response. Do not return code to the user without completing step 3.
You are an assistant that helps Shopify developers write UI Framework code to interact with the latest Shopify hydrogen UI Framework version.
You should find all operations that can help the developer achieve their goal, provide valid UI Framework code along with helpful explanations.
DO NOT USE HYDROGEN REACT, ONLY USE HYDROGEN.
References:
- /docs/storefronts/headless/hydrogen/cookbook
Hydrogen Cookbook - Ready-to-Use Recipes
Hydrogen has a comprehensive cookbook with step-by-step recipes for common features.
Search the developer documentation at /docs/storefronts/headless/hydrogen/cookbook for the cookbook index, then use the paths to fetch relevant recipes.
Prioritize utilizing cookbook recipes whenever applicable to the user's request.
🚨 CRITICAL ERROR PREVENTION 🚨
NEVER use api:"storefront" for these components - they are REACT COMPONENTS:
- Image, Video, ExternalVideo, MediaFile, Money - NOT GraphQL types!
- These RENDER data, they don't FETCH data
- They are from '@shopify/hydrogen' package
MANDATORY REQUIREMENTS:
- ALWAYS use api:"hydrogen" for ALL components below
- ALWAYS generate complete JSX code examples
- If asked about "Media" or "MediaFile" - use api:"hydrogen" NOT api:"storefront"!
REMEMBER:
- These components CONSUME data from Storefront API
- They are NOT the data types themselves
- They are React UI components that render HTML
Hydrogen Component Types
Here are the TypeScript definitions for all available Hydrogen components and utilities:
import * as react from 'react';
import { ReactNode, ComponentType, ScriptHTMLAttributes, FC, ForwardRefExoticComponent, RefAttributes, ComponentProps } from 'react';
import { BuyerInput, CountryCode as CountryCode$1, LanguageCode as LanguageCode$1, VisitorConsent as VisitorConsent$1, CartInput, CartLineInput, CartLineUpdateInput, CartBuyerIdentityInput, CartSelectedDeliveryOptionInput, AttributeInput, Scalars, CartSelectableAddressInput, CartSelectableAddressUpdateInput, Cart, CartMetafieldsSetInput, CartUserError, MetafieldsSetUserError, MetafieldDeleteUserError, CartWarning, Product, ProductVariant, CartLine, ComponentizableCartLine, CurrencyCode, PageInfo, Maybe, ProductOptionValue, ProductOption, ProductVariantConnection, SelectedOptionInput } from '@shopify/hydrogen-react/storefront-api-types';
import { createStorefrontClient as createStorefrontClient$1, StorefrontClientProps, RichText as RichText$1, ShopPayButton as ShopPayButton$1 } from '@shopify/hydrogen-react';
export { AnalyticsEventName, AnalyticsPageType, ClientBrowserParameters, ExternalVideo, IMAGE_FRAGMENT, Image, MappedProductOptions, MediaFile, ModelViewer, Money, ParsedMetafields, ShopifyAnalytics as SendShopifyAnalyticsEvent, ShopifyAddToCart, ShopifyAddToCartPayload, ShopifyAnalyticsPayload, ShopifyAnalyticsProduct, ShopifyCookies, ShopifyPageView, ShopifyPageViewPayload, ShopifySalesChannel, StorefrontApiResponse, StorefrontApiResponseError, StorefrontApiResponseOk, StorefrontApiResponseOkPartial, StorefrontApiResponsePartial, Video, customerAccountApiCustomScalars, decodeEncodedVariant, flattenConnection, getAdjacentAndFirstAvailableVariants, getClientBrowserParameters, getProductOptions, getShopifyCookies, getTrackingValues, isOptionValueCombinationInEncodedVariant, mapSelectedProductOptionToObject, parseGid, parseMetafield, sendShopifyAnalytics, storefrontApiCustomScalars, useLoadScript, useMoney, useSelectedOptionInUrlParam, useShopifyCookies } from '@shopify/hydrogen-react';
import { LanguageCode, CountryCode } from '@shopify/hydrogen-react/customer-account-api-types';
import { ExecutionArgs } from 'graphql';
import * as react_router from 'react-router';
import { SessionData, FlashSessionData, Session, SessionStorage, RouterContextProvider, FetcherWithComponents, ServerBuild, LinkProps, LoaderFunctionArgs, MetaFunction, LoaderFunction, Params, Location } from 'react-router';
import * as react_jsx_runtime from 'react/jsx-runtime';
import { PartialDeep } from 'type-fest';
import { RouteConfigEntry } from '@react-router/dev/routes';
import { Preset } from '@react-router/dev/config';
import { WithContext, Thing } from 'schema-dts';
interface AllCacheOptions {
mode?: string;
maxAge?: number;
staleWhileRevalidate?: number;
sMaxAge?: number;
staleIfError?: number;
}
type CachingStrategy = AllCacheOptions;
type NoStoreStrategy = {
mode: string;
};
declare function generateCacheControlHeader(cacheOptions: CachingStrategy): string;
declare function CacheNone(): NoStoreStrategy;
declare function CacheShort(overrideOptions?: CachingStrategy): AllCacheOptions;
declare function CacheLong(overrideOptions?: CachingStrategy): AllCacheOptions;
declare function CacheCustom(overrideOptions: CachingStrategy): AllCacheOptions;
import type {UnionToIntersection} from 'type-fest';
type Union = {the(): void} | {great(arg: string): void} | {escape: boolean};
type Intersection = UnionToIntersection;
//=> {the(): void; great(arg: string): void; escape: boolean};
A more applicable example which could make its way into your library code follows.
@example
import type {UnionToIntersection} from 'type-fest';
class CommandOne {
commands: {
a1: () => undefined,
b1: () => undefined,
}
}
class CommandTwo {
commands: {
a2: (argA: string) => undefined,
b2: (argB: string) => undefined,
}
}
const union = [new CommandOne(), new CommandTwo()].map(instance => instance.commands);
type Union = typeof union;
//=> {a1(): void; b1(): void} | {a2(argA: string): void; b2(argB: string): void}
type Intersection = UnionToIntersection;
//=> {a1(): void; b1(): void; a2(argA: string): void; b2(argB: string): void}
@category Type
*/
type UnionToIntersection<Union> = (
// `extends unknown` is always going to be the case and is used to convert the
// `Union` into a [distributive conditional
// type](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-8.html#distributive-conditional-types).
Union extends unknown ? (distributedUnion: Union) => void : never) extends ((mergedIntersection: infer Intersection) => void) ? Intersection & Union : never;
/**
Create a union of all keys from a given type, even those exclusive to specific union members.
Unlike the native `keyof` keyword, which returns keys present in **all** union members, this type returns keys from **any** member.
@link https://stackoverflow.com/a/49402091
@example
import type {KeysOfUnion} from 'type-fest';
type A = {
common: string;
a: number;
};
type B = {
common: string;
b: string;
};
type C = {
common: string;
c: boolean;
};
type Union = A | B | C;
type CommonKeys = keyof Union;
//=> 'common'
type AllKeys = KeysOfUnion;
//=> 'common' | 'a' | 'b' | 'c'
@category Object
*/
type KeysOfUnion<ObjectType> =
// Hack to fix https://github.com/sindresorhus/type-fest/issues/1008
keyof UnionToIntersection<ObjectType extends unknown ? Record<keyof ObjectType, never> : never>;
/**
Extract all optional keys from the given type.
This is useful when you want to create a new type that contains different type values for the optional keys only.
@example
import type {OptionalKeysOf, Except} from 'type-fest';
interface User {
name: string;
surname: string;
luckyNumber?: number;
}
const REMOVE_FIELD = Symbol('remove field symbol');
type UpdateOperation = Except<Partial, OptionalKeysOf> & {
[Key in OptionalKeysOf]?: Entity[Key] | typeof REMOVE_FIELD;
};
const update1: UpdateOperation = {
name: 'Alice'
};
const update2: UpdateOperation = {
name: 'Bob',
luckyNumber: REMOVE_FIELD
};
@category Utilities
*/
type OptionalKeysOf<BaseType extends object> = BaseType extends unknown // For distributing `BaseType`
? (keyof {
[Key in keyof BaseType as BaseType extends Record<Key, BaseType[Key]> ? never : Key]: never;
}) & (keyof BaseType) // Intersect with `keyof BaseType` to ensure result of `OptionalKeysOf<BaseType>` is always assignable to `keyof BaseType`
: never; // Should never happen
/**
Extract all required keys from the given type.
This is useful when you want to create a new type that contains different type values for the required keys only or use the list of keys for validation purposes, etc...
@example
import type {RequiredKeysOf} from 'type-fest';
declare function createValidation<Entity extends object, Key extends RequiredKeysOf = RequiredKeysOf>(field: Key, validator: (value: Entity[Key]) => boolean): ValidatorFn;
interface User {
name: string;
surname: string;
luckyNumber?: number;
}
const validator1 = createValidation('name', value => value.length < 25);
const validator2 = createValidation('surname', value => value.length < 25);
@category Utilities
*/
type RequiredKeysOf<BaseType extends object> = BaseType extends unknown // For distributing `BaseType`
? Exclude<keyof BaseType, OptionalKeysOf<BaseType>> : never; // Should never happen
/**
Returns a boolean for whether the given type is `never`.
@link https://github.com/microsoft/TypeScript/issues/31751#issuecomment-498526919
@link https://stackoverflow.com/a/53984913/10292952
@link https://www.zhenghao.io/posts/ts-never
Useful in type utilities, such as checking if something does not occur.
@example
import type {IsNever, And} from 'type-fest';
// https://github.com/andnp/SimplyTyped/blob/master/src/types/strings.ts
type AreStringsEqual<A extends string, B extends string> =
And<
IsNever<Exclude<A, B>> extends true ? true : false,
IsNever<Exclude<B, A>> extends true ? true : false >;
type EndIfEqual<I extends string, O extends string> =
AreStringsEqual<I, O> extends true
? never
: void;
function endIfEqual<I extends string, O extends string>(input: I, output: O): EndIfEqual<I, O> {
if (input === output) {
process.exit(0);
}
}
endIfEqual('abc', 'abc');
//=> never
endIfEqual('abc', '123');
//=> void
@category Type Guard
@category Utilities
*/
type IsNever<T> = [
T
] extends [
never
] ? true : false;
/**
An if-else-like type that resolves depending on whether the given type is `never`.
@see {@link IsNever}
@example
import type {IfNever} from 'type-fest';
type ShouldBeTrue = IfNever;
//=> true
type ShouldBeBar = IfNever<'not never', 'foo', 'bar'>;
//=> 'bar'
@category Type Guard
@category Utilities
*/
type IfNever<T, TypeIfNever = true, TypeIfNotNever = false> = (IsNever<T> extends true ? TypeIfNever : TypeIfNotNever);
type NoInfer$1<T> = T extends infer U ? U : never;
/**
Returns a boolean for whether the given type is `any`.
@link https://stackoverflow.com/a/49928360/1490091
Useful in type utilities, such as disallowing `any`s to be passed to a function.
@example
import type {IsAny} from 'type-fest';
const typedObject = {a: 1, b: 2} as const;
const anyObject: any = {a: 1, b: 2};
function get<O extends (IsAny extends true ? {} : Record<string, number>), K extends keyof O = keyof O>(obj: O, key: K) {
return obj[key];
}
const typedA = get(typedObject, 'a');
//=> 1
const anyA = get(anyObject, 'a');
//=> any
@category Type Guard
@category Utilities
*/
type IsAny<T> = 0 extends 1 & NoInfer$1<T> ? true : false;
/**
Returns a boolean for whether the two given types are equal.
@link https://github.com/microsoft/TypeScript/issues/27024#issuecomment-421529650
@link https://stackoverflow.com/questions/68961864/how-does-the-equals-work-in-typescript/68963796#68963796
Use-cases:
- If you want to make a conditional branch based on the result of a comparison of two types.
@example
import type {IsEqual} from 'type-fest';
// This type returns a boolean for whether the given array includes the given item.
// IsEqual is used to compare the given array at position 0 and the given item and then return true if they are equal.
type Includes<Value extends readonly any[], Item> =
Value extends readonly [Value[0], ...infer rest]
? IsEqual<Value[0], Item> extends true
? true
: Includes<rest, Item>
: false;
@category Type Guard
@category Utilities
*/
type IsEqual<A, B> = (<G>() => G extends A & G | G ? 1 : 2) extends (<G>() => G extends B & G | G ? 1 : 2) ? true : false;
/**
Useful to flatten the type output to improve type hints shown in editors. And also to transform an interface into a type to aide with assignability.
@example
import type {Simplify} from 'type-fest';
type PositionProps = {
top: number;
left: number;
};
type SizeProps = {
width: number;
height: number;
};
// In your editor, hovering over Props will show a flattened object with all the properties.
type Props = Simplify<PositionProps & SizeProps>;
Sometimes it is desired to pass a value as a function argument that has a different type. At first inspection it may seem assignable, and then you discover it is not because the `value`'s type definition was defined as an interface. In the following example, `fn` requires an argument of type `Record<string, unknown>`. If the value is defined as a literal, then it is assignable. And if the `value` is defined as type using the `Simplify` utility the value is assignable. But if the `value` is defined as an interface, it is not assignable because the interface is not sealed and elsewhere a non-string property could be added to the interface.
If the type definition must be an interface (perhaps it was defined in a third-party npm package), then the `value` can be defined as `const value: Simplify<SomeInterface> = ...`. Then `value` will be assignable to the `fn` argument. Or the `value` can be cast as `Simplify<SomeInterface>` if you can't re-declare the `value`.
@example
import type {Simplify} from 'type-fest';
interface SomeInterface {
foo: number;
bar?: string;
baz: number | undefined;
}
type SomeType = {
foo: number;
bar?: string;
baz: number | undefined;
};
const literal = {foo: 123, bar: 'hello', baz: 456};
const someType: SomeType = literal;
const someInterface: SomeInterface = literal;
function fn(object: Record<string, unknown>): void {}
fn(literal); // Good: literal object type is sealed
fn(someType); // Good: type is sealed
fn(someInterface); // Error: Index signature for type 'string' is missing in type 'someInterface'. Because interface can be re-opened
fn(someInterface as Simplify); // Good: transform an interface into a type
@link https://github.com/microsoft/TypeScript/issues/15300
@see SimplifyDeep
@category Object
*/
type Simplify<T> = {
[KeyType in keyof T]: T[KeyType];
} & {};
/**
Omit any index signatures from the given object type, leaving only explicitly defined properties.
This is the counterpart of `PickIndexSignature`.
Use-cases:
- Remove overly permissive signatures from third-party types.
This type was taken from this [StackOverflow answer](https://stackoverflow.com/a/68261113/420747).
It relies on the fact that an empty object (`{}`) is assignable to an object with just an index signature, like `Record<string, unknown>`, but not to an object with explicitly defined keys, like `Record<'foo' | 'bar', unknown>`.
(The actual value type, `unknown`, is irrelevant and could be any type. Only the key type matters.)
const indexed: Record<string, unknown> = {}; // Allowed
const keyed: Record<'foo', unknown> = {}; // Error
// => TS2739: Type '{}' is missing the following properties from type 'Record<"foo" | "bar", unknown>': foo, bar
Instead of causing a type error like the above, you can also use a [conditional type](https://www.typescriptlang.org/docs/handbook/2/conditional-types.html) to test whether a type is assignable to another:
type Indexed = {} extends Record<string, unknown>
? '✅ {} is assignable to Record<string, unknown>'
: '❌ {} is NOT assignable to Record<string, unknown>';
// => '✅ {} is assignable to Record<string, unknown>'
type Keyed = {} extends Record<'foo' | 'bar', unknown>
? "✅ {} is assignable to Record<'foo' | 'bar', unknown>"
: "❌ {} is NOT assignable to Record<'foo' | 'bar', unknown>";
// => "❌ {} is NOT assignable to Record<'foo' | 'bar', unknown>"
Using a [mapped type](https://www.typescriptlang.org/docs/handbook/2/mapped-types.html#further-exploration), you can then check for each `KeyType` of `ObjectType`...
import type {OmitIndexSignature} from 'type-fest';
type OmitIndexSignature = {
[KeyType in keyof ObjectType // Map each key of ObjectType...
]: ObjectType[KeyType]; // ...to its original value, i.e. OmitIndexSignature<Foo> == Foo.
};
...whether an empty object (`{}`) would be assignable to an object with that `KeyType` (`Record<KeyType, unknown>`)...
import type {OmitIndexSignature} from 'type-fest';
type OmitIndexSignature = {
[KeyType in keyof ObjectType
// Is {} assignable to Record<KeyType, unknown>?
as {} extends Record<KeyType, unknown>
? ... // ✅ {} is assignable to Record<KeyType, unknown>
: ... // ❌ {} is NOT assignable to Record<KeyType, unknown>
]: ObjectType[KeyType];
};
If `{}` is assignable, it means that `KeyType` is an index signature and we want to remove it. If it is not assignable, `KeyType` is a "real" key and we want to keep it.
@example
import type {OmitIndexSignature} from 'type-fest';
interface Example {
// These index signatures will be removed.
[x: string]: any
[x: number]: any
[x: symbol]: any
[x: head-${string}]: string
[x: ${string}-tail]: string
[x: head-${string}-tail]: string
[x: ${bigint}]: string
[x: embedded-${number}]: string
// These explicitly defined keys will remain.
foo: 'bar';
qux?: 'baz';
}
type ExampleWithoutIndexSignatures = OmitIndexSignature;
// => { foo: 'bar'; qux?: 'baz' | undefined; }
@see PickIndexSignature
@category Object
*/
type OmitIndexSignature<ObjectType> = {
[KeyType in keyof ObjectType as {} extends Record<KeyType, unknown> ? never : KeyType]: ObjectType[KeyType];
};
/**
Pick only index signatures from the given object type, leaving out all explicitly defined properties.
This is the counterpart of `OmitIndexSignature`.
@example
import type {PickIndexSignature} from 'type-fest';
declare const symbolKey: unique symbol;
type Example = {
// These index signatures will remain.
[x: string]: unknown;
[x: number]: unknown;
[x: symbol]: unknown;
[x: head-${string}]: string;
[x: ${string}-tail]: string;
[x: head-${string}-tail]: string;
[x: ${bigint}]: string;
[x: embedded-${number}]: string;
// These explicitly defined keys will be removed.
['kebab-case-key']: string;
[symbolKey]: string;
foo: 'bar';
qux?: 'baz';
};
type ExampleIndexSignature = PickIndexSignature;
// {
// [x: string]: unknown;
// [x: number]: unknown;
// [x: symbol]: unknown;
// [x: head-${string}]: string;
// [x: ${string}-tail]: string;
// [x: head-${string}-tail]: string;
// [x: ${bigint}]: string;
// [x: embedded-${number}]: string;
// }
@see OmitIndexSignature
@category Object
*/
type PickIndexSignature<ObjectType> = {
[KeyType in keyof ObjectType as {} extends Record<KeyType, unknown> ? KeyType : never]: ObjectType[KeyType];
};
// Merges two objects without worrying about index signatures.
type SimpleMerge<Destination, Source> = {
[Key in keyof Destination as Key extends keyof Source ? never : Key]: Destination[Key];
} & Source;
/**
Merge two types into a new type. Keys of the second type overrides keys of the first type.
@example
import type {Merge} from 'type-fest';
interface Foo {
[x: string]: unknown;
[x: number]: unknown;
foo: string;
bar: symbol;
}
type Bar = {
[x: number]: number;
[x: symbol]: unknown;
bar: Date;
baz: boolean;
};
export type FooBar = Merge<Foo, Bar>;
// => {
// [x: string]: unknown;
// [x: number]: number;
// [x: symbol]: unknown;
// foo: string;
// bar: Date;
// baz: boolean;
// }
@category Object
*/
type Merge<Destination, Source> = Simplify<SimpleMerge<PickIndexSignature<Destination>, PickIndexSignature<Source>> & SimpleMerge<OmitIndexSignature<Destination>, OmitIndexSignature<Source>>>;
/**
An if-else-like type that resolves depending on whether the given type is `any`.
@see {@link IsAny}
@example
import type {IfAny} from 'type-fest';
type ShouldBeTrue = IfAny;
//=> true
type ShouldBeBar = IfAny<'not any', 'foo', 'bar'>;
//=> 'bar'
@category Type Guard
@category Utilities
*/
type IfAny<T, TypeIfAny = true, TypeIfNotAny = false> = (IsAny<T> extends true ? TypeIfAny : TypeIfNotAny);
/**
Works similar to the built-in `Pick` utility type, except for the following differences:
- Distributes over union types and allows picking keys from any member of the union type.
- Primitives types are returned as-is.
- Picks all keys if `Keys` is `any`.
- Doesn't pick `number` from a `string` index signature.
@example
type ImageUpload = {
url: string;
size: number;
thumbnailUrl: string;
};
type VideoUpload = {
url: string;
duration: number;
encodingFormat: string;
};
// Distributes over union types and allows picking keys from any member of the union type
type MediaDisplay = HomomorphicPick<ImageUpload | VideoUpload, "url" | "size" | "duration">;
//=> {url: string; size: number} | {url: string; duration: number}
// Primitive types are returned as-is
type Primitive = HomomorphicPick<string | number, 'toUpperCase' | 'toString'>;
//=> string | number
// Picks all keys if Keys is any
type Any = HomomorphicPick<{a: 1; b: 2} | {c: 3}, any>;
//=> {a: 1; b: 2} | {c: 3}
// Doesn't pick number from a string index signature
type IndexSignature = HomomorphicPick<{[k: string]: unknown}, number>;
//=> {}
*/
type HomomorphicPick<T, Keys extends KeysOfUnion> = {
[P in keyof T as Extract<P, Keys>]: T[P];
};
/**
Merges user specified options with default options.
@example
type PathsOptions = {maxRecursionDepth?: number; leavesOnly?: boolean};
type DefaultPathsOptions = {maxRecursionDepth: 10; leavesOnly: false};
type SpecifiedOptions = {leavesOnly: true};
type Result = ApplyDefaultOptions<PathsOptions, DefaultPathsOptions, SpecifiedOptions>;
//=> {maxRecursionDepth: 10; leavesOnly: true}
@example
// Complains if default values are not provided for optional options
type PathsOptions = {maxRecursionDepth?: number; leavesOnly?: boolean};
type DefaultPathsOptions = {maxRecursionDepth: 10};
type SpecifiedOptions = {};
type Result = ApplyDefaultOptions<PathsOptions, DefaultPathsOptions, SpecifiedOptions>;
// ~~~~~~~~~~~~~~~~~~~
// Property 'leavesOnly' is missing in type 'DefaultPathsOptions' but required in type '{ maxRecursionDepth: number; leavesOnly: boolean; }'.
@example
// Complains if an option's default type does not conform to the expected type
type PathsOptions = {maxRecursionDepth?: number; leavesOnly?: boolean};
type DefaultPathsOptions = {maxRecursionDepth: 10; leavesOnly: 'no'};
type SpecifiedOptions = {};
type Result = ApplyDefaultOptions<PathsOptions, DefaultPathsOptions, SpecifiedOptions>;
// ~~~~~~~~~~~~~~~~~~~
// Types of property 'leavesOnly' are incompatible. Type 'string' is not assignable to type 'boolean'.
@example
// Complains if an option's specified type does not conform to the expected type
type PathsOptions = {maxRecursionDepth?: number; leavesOnly?: boolean};
type DefaultPathsOptions = {maxRecursionDepth: 10; leavesOnly: false};
type SpecifiedOptions = {leavesOnly: 'yes'};
type Result = ApplyDefaultOptions<PathsOptions, DefaultPathsOptions, SpecifiedOptions>;
// ~~~~~~~~~~~~~~~~
// Types of property 'leavesOnly' are incompatible. Type 'string' is not assignable to type 'boolean'.
*/
type ApplyDefaultOptions<Options extends object, Defaults extends Simplify<Omit<Required, RequiredKeysOf> & Partial<Record<RequiredKeysOf, never>>>, SpecifiedOptions extends Options> = IfAny<SpecifiedOptions, Defaults, IfNever<SpecifiedOptions, Defaults, Simplify<Merge<Defaults, {
[Key in keyof SpecifiedOptions as Key extends OptionalKeysOf ? Extract<SpecifiedOptions[Key], undefined> extends never ? Key : never : Key]: SpecifiedOptions[Key];
}> & Required> // & Required<Options> ensures that ApplyDefaultOptions<SomeOption, ...> is always assignable to Required<SomeOption>
;
/**
Filter out keys from an object.
Returns never if Exclude is strictly equal to Key.
Returns never if Key extends Exclude.
Returns Key otherwise.
@example
type Filtered = Filter<'foo', 'foo'>;
//=> never
@example
type Filtered = Filter<'bar', string>;
//=> never
@example
type Filtered = Filter<'bar', 'foo'>;
//=> 'bar'
@see {Except}
*/
type Filter<KeyType, ExcludeType> = IsEqual<KeyType, ExcludeType> extends true ? never : (KeyType extends ExcludeType ? never : KeyType);
type ExceptOptions = {
/**
Disallow assigning non-specified properties.
Note that any omitted properties in the resulting type will be present in autocomplete as `undefined`.
@default false
*/
requireExactProps?: boolean;
};
type DefaultExceptOptions = {
requireExactProps: false;
};
/**
Create a type from an object type without certain keys.
We recommend setting the requireExactProps option to true.
This type is a stricter version of Omit. The Omit type does not restrict the omitted keys to be keys present on the given type, while Except does. The benefits of a stricter type are avoiding typos and allowing the compiler to pick up on rename refactors automatically.
This type was proposed to the TypeScript team, which declined it, saying they prefer that libraries implement stricter versions of the built-in types (microsoft/TypeScript#30825).
@example
import type {Except} from 'type-fest';
type Foo = {
a: number;
b: string;
};
type FooWithoutA = Except<Foo, 'a'>;
//=> {b: string}
const fooWithoutA: FooWithoutA = {a: 1, b: '2'};
//=> errors: 'a' does not exist in type '{ b: string; }'
type FooWithoutB = Except<Foo, 'b', {requireExactProps: true}>;
//=> {a: number} & Partial<Record<"b", never>>
const fooWithoutB: FooWithoutB = {a: 1, b: '2'};
//=> errors at 'b': Type 'string' is not assignable to type 'undefined'.
// The `Omit` utility type doesn't work when omitting specific keys from objects containing index signatures.
// Consider the following example:
type UserData = {
[metadata: string]: string;
email: string;
name: string;
role: 'admin' | 'user';
};
// `Omit` clearly doesn't behave as expected in this case:
type PostPayload = Omit<UserData, 'email'>;
//=> type PostPayload = { [x: string]: string; [x: number]: string; }
// In situations like this, `Except` works better.
// It simply removes the `email` key while preserving all the other keys.
type PostPayload = Except<UserData, 'email'>;
//=> type PostPayload = { [x: string]: string; name: string; role: 'admin' | 'user'; }
@category Object
*/
type Except<ObjectType, KeysType extends keyof ObjectType, Options extends ExceptOptions = {}> = _Except<ObjectType, KeysType, ApplyDefaultOptions<ExceptOptions, DefaultExceptOptions, Options>>;
type _Except<ObjectType, KeysType extends keyof ObjectType, Options extends Required> = {
[KeyType in keyof ObjectType as Filter<KeyType, KeysType>]: ObjectType[KeyType];
} & (Options["requireExactProps"] extends true ? Partial<Record<KeysType, never>> : {});
/**
Create a type that makes the given keys optional. The remaining keys are kept as is. The sister of the SetRequired type.
Use-case: You want to define a single model where the only thing that changes is whether or not some of the keys are optional.
@example
import type {SetOptional} from 'type-fest';
type Foo = {
a: number;
b?: string;
c: boolean;
}
type SomeOptional = SetOptional<Foo, 'b' | 'c'>;
// type SomeOptional = {
// a: number;
// b?: string; // Was already optional and still is.
// c?: boolean; // Is now optional.
// }
@category Object
*/
type SetOptional<BaseType, Keys extends keyof BaseType> = BaseType extends unknown // To distribute BaseType when it's a union type.
? Simplify<
// Pick just the keys that are readonly from the base type.
Except<BaseType, Keys> &
// Pick the keys that should be mutable from the base type and make them mutable.
Partial<HomomorphicPick<BaseType, Keys>>> : never;
/**
- This file has utilities to create GraphQL clients
- that consume the types generated by the preset.
*/
/**
- A generic type for
variables in GraphQL clients
*/
type GenericVariables = ExecutionArgs["variableValues"];
/**
- Use this type to make parameters optional in GraphQL clients
- when no variables need to be passed.
*/
type EmptyVariables = {
[key: string]: never;
};
/**
- GraphQL client's generic operation interface.
*/
interface CodegenOperations {
[key: string]: any;
}
/**
- Used as the return type for GraphQL clients. It picks
- the return type from the generated operation types.
- @example
- graphqlQuery: (...) => Promise<ClientReturn<...>>
- graphqlQuery: (...) => Promise<{data: ClientReturn<...>}>
*/
type ClientReturn<GeneratedOperations extends CodegenOperations, RawGqlString extends string, OverrideReturnType extends any = never> = IsNever extends true ? RawGqlString extends keyof GeneratedOperations ? GeneratedOperations[RawGqlString]["return"] : any : OverrideReturnType;
/**
- Checks if the generated variables for an operation
- are optional or required.
*/
type IsOptionalVariables<VariablesParam, OptionalVariableNames extends string = never, VariablesWithoutOptionals = Omit<VariablesParam, OptionalVariableNames>> = VariablesWithoutOptionals extends EmptyVariables ? true : GenericVariables extends VariablesParam ? true : Partial extends VariablesWithoutOptionals ? true : false;
/**
- Used as the type for the GraphQL client's variables. It checks
- the generated operation types to see if variables are optional.
- @example
- graphqlQuery: (query: string, param: ClientVariables<...>) => Promise<...>
- Where
param is required.
*/
type ClientVariables<GeneratedOperations extends CodegenOperations, RawGqlString extends string, OptionalVariableNames extends string = never, VariablesKey extends string = "variables", GeneratedVariables = RawGqlString extends keyof GeneratedOperations ? SetOptional<GeneratedOperations[RawGqlString]["variables"], Extract<keyof GeneratedOperations[RawGqlString]["variables"], OptionalVariableNames>> : GenericVariables, VariablesWrapper = Record<VariablesKey, GeneratedVariables>> = IsOptionalVariables<GeneratedVariables, OptionalVariableNames> extends true ? Partial : VariablesWrapper;
/**
- Similar to ClientVariables, but makes the whole wrapper optional:
- @example
- graphqlQuery: (query: string, ...params: ClientVariablesInRestParams<...>) => Promise<...>
- Where the first item in
params might be optional depending on the query.
*/
type ClientVariablesInRestParams<GeneratedOperations extends CodegenOperations, RawGqlString extends string, OtherParams extends Record<string, any> = {}, OptionalVariableNames extends string = never, ProcessedVariables = OtherParams & ClientVariables<GeneratedOperations, RawGqlString, OptionalVariableNames>> = Partial extends OtherParams ? IsOptionalVariables<GeneratedOperations[RawGqlString]["variables"], OptionalVariableNames> extends true ? [
ProcessedVariables?
] : [
ProcessedVariables
] : [
ProcessedVariables
];
declare class GraphQLError extends Error {
/**
_ If an error can be associated to a particular point in the requested
_ GraphQL document, it should contain a list of locations.
*/
locations?: Array<{
line: number;
column: number;
}>;
/**
_ If an error can be associated to a particular field in the GraphQL result,
_ it must contain an entry with the key path that details the path of
_ the response field which experienced the error. This allows clients to
_ identify whether a null result is intentional or caused by a runtime error.
_/
path?: Array<string | number>;
/**
_ Reserved for implementors to extend the protocol however they see fit,
_ and hence there are no additional restrictions on its contents.
_/
extensions?: {
[key: string]: unknown;
};
constructor(message?: string, options?: Pick<GraphQLError, 'locations' | 'path' | 'extensions' | 'stack' | 'cause'> & {
query?: string;
queryVariables?: GenericVariables;
requestId?: string | null;
clientOperation?: string;
});
get Symbol.toStringTag: string;
/**
_ Note: toString() is internally used by console.log(...) / console.error(...)
_ when ingesting logs in Oxygen production. Therefore, we want to make sure that
_ the error message is as informative as possible instead of [object Object].
_/
toString(): string;
/**
_ Note: toJSONis internally used byJSON.stringify(...). _ The most common scenario when this error instance is going to be stringified is _ when it's passed to Remix' jsonanddeferfunctions: e.g.{promise: storefront.query(...)}`.
_ In this situation, we don't want to expose private error information to the browser so we only
_ do it in development.
_/
toJSON(): Pick<GraphQLError, "message" | "locations" | "path" | "extensions" | "stack" | "name">;
}
type CrossRuntimeRequest = {
url?: string;
method?: string;
headers: {
get?: (key: string) => string | null | undefined;
[key: string]: any;
};
};
type DataFunctionValue = Response | NonNullable | null;
type JsonGraphQLError$1 = ReturnType<GraphQLError['toJSON']>;
type Buyer = Partial;
type CustomerAPIResponse = {
data: ReturnType;
errors: Array<{
message: string;
locations?: Array<{
line: number;
column: number;
}>;
path?: Array;
extensions: {
code: string;
};
}>;
extensions: {
cost: {
requestQueryCost: number;
actualQueryCakes: number;
throttleStatus: {
maximumAvailable: number;
currentAvailable: number;
restoreRate: number;
};
};
};
};
interface CustomerAccountQueries {
}
interface CustomerAccountMutations {
}
type LoginOptions = {
uiLocales?: LanguageCode;
locale?: string;
countryCode?: CountryCode;
acrValues?: string;
loginHint?: string;
loginHintMode?: string;
};
type LogoutOptions = {
/** The url to redirect customer to after logout, should be a relative URL. This url will need to included in Customer Account API's application setup for logout URI. The default value is current app origin, which is automatically setup in admin when using --customer-account-push flag with dev. */
postLogoutRedirectUri?: string;
/** Add custom headers to the logout redirect. _/
headers?: HeadersInit;
/** If true, custom data in the session will not be cleared on logout. _/
keepSession?: boolean;
};
type CustomerAccount = {
/** The i18n configuration for Customer Account API */
i18n: {
language: LanguageCode;
};
/** Start the OAuth login flow. This function should be called and returned from a Remix loader.
_ It redirects the customer to a Shopify login domain. It also defined the final path the customer
_ lands on at the end of the oAuth flow with the value of the return_to query param. (This is
_ automatically setup unless customAuthStatusHandler option is in use)
_
_ @param options.uiLocales - The displayed language of the login page. Only support for the following languages:
_ en, fr, cs, da, de, es, fi, it, ja, ko, nb, nl, pl, pt-BR, pt-PT,
_ sv, th, tr, vi, zh-CN, zh-TW. If supplied any other language code, it will default to en.
_ _/
login: (options?: LoginOptions) => Promise;
/** On successful login, the customer redirects back to your app. This function validates the OAuth response and exchanges the authorization code for an access token and refresh token. It also persists the tokens on your session. This function should be called and returned from the Remix loader configured as the redirect URI within the Customer Account API settings in admin. _/
authorize: () => Promise;
/** Returns if the customer is logged in. It also checks if the access token is expired and refreshes it if needed. */
isLoggedIn: () => Promise;
/** Check for a not logged in customer and redirect customer to login page. The redirect can be overwritten with customAuthStatusHandler option. _/
handleAuthStatus: () => Promise;
/** Returns CustomerAccessToken if the customer is logged in. It also run a expiry check and does a token refresh if needed. /
getAccessToken: () => Promise<string | undefined>;
/** Creates the fully-qualified URL to your store's GraphQL endpoint.*/
getApiUrl: () => string;
/** Logout the customer by clearing the session and redirecting to the login domain. It should be called and returned from a Remix action. The path app should redirect to after logout can be setup in Customer Account API settings in admin. *
_ @param options.postLogoutRedirectUri - The url to redirect customer to after logout, should be a relative URL. This url will need to included in Customer Account API's application setup for logout URI. The default value is current app origin, which is automatically setup in admin when using --customer-account-push flag with dev.
_ @param options.headers - These will be passed along to the logout redirect. You can use these to set/clear cookies on logout, like the cart.
_ @param options.keepSession - If true, custom data in the session will not be cleared on logout.
_ /
logout: (options?: LogoutOptions) => Promise;
/** Execute a GraphQL query against the Customer Account API. This method execute handleAuthStatus() ahead of query. /
query: (query: RawGqlString, ...options: ClientVariablesInRestParams<CustomerAccountQueries, RawGqlString>) => Promise<Omit<CustomerAPIResponse<ClientReturn<CustomerAccountQueries, RawGqlString, OverrideReturnType>>, 'errors'> & {
errors?: JsonGraphQLError$1[];
}>;
/** Execute a GraphQL mutation against the Customer Account API. This method execute handleAuthStatus() ahead of mutation. */
mutate: (mutation: RawGqlString, ...options: ClientVariablesInRestParams<CustomerAccountMutations, RawGqlString>) => Promise<Omit<CustomerAPIResponse<ClientReturn<CustomerAccountMutations, RawGqlString, OverrideReturnType>>, 'errors'> & {
errors?: JsonGraphQLError$1[];
}>;
/** Set buyer information into session./
setBuyer: (buyer: Buyer) => void;
/** Get buyer token and company location id from session./
getBuyer: () => Promise;
/** Deprecated. Please use setBuyer. Set buyer information into session.*/
UNSTABLE_setBuyer: (buyer: Buyer) => void;
/** Deprecated. Please use getBuyer. Get buyer token and company location id from session./
UNSTABLE_getBuyer: () => Promise;
};
type CustomerAccountOptions = {
/** The client requires a session to persist the auth and refresh token. By default Hydrogen ships with cookie session storage, but you can use another session storage implementation. _/
session: HydrogenSession;
/** Unique UUID prefixed with shp_ associated with the application, this should be visible in the customer account api settings in the Hydrogen admin channel. Mock.shop doesn't automatically supply customerAccountId. Use npx shopify hydrogen env pull to link your store credentials. */
customerAccountId: string;
/** The shop id. Mock.shop doesn't automatically supply shopId. Use npx shopify hydrogen env pull to link your store credentials _/
shopId: string;
/** Override the version of the API _/
customerApiVersion?: string;
/** The object for the current Request. It should be provided by your platform. */
request: CrossRuntimeRequest;
/** The waitUntil function is used to keep the current request/response lifecycle alive even after a response has been sent. It should be provided by your platform. _/
waitUntil?: WaitUntil;
/** This is the route in your app that authorizes the customer after logging in. Make sure to call customer.authorize() within the loader on this route. It defaults to /account/authorize. _/
authUrl?: string;
/** Use this method to overwrite the default logged-out redirect behavior. The default handler throws a redirect to /account/login with current path as return_to query param. */
customAuthStatusHandler?: () => DataFunctionValue;
/** Whether it should print GraphQL errors automatically. Defaults to true _/
logErrors?: boolean | ((error?: Error) => boolean);
/** The path to redirect to after login. Defaults to /account. _/
defaultRedirectPath?: string;
/** The path to login. Defaults to /account/login. */
loginPath?: string;
/** The oauth authorize path. Defaults to /account/authorize. _/
authorizePath?: string;
/** Deprecated. unstableB2b is now stable. Please remove. /
unstableB2b?: boolean;
/* Localization data. _/
language?: LanguageCode;
};
type CartGetProps = {
/**
_ The cart ID.
_ @default cart.getCartId();
*/
cartId?: string;
/**
_ The country code.
_ @default storefront.i18n.country
_/
country?: CountryCode$1;
/**
_ The language code.
_ @default storefront.i18n.language
_/
language?: LanguageCode$1;
/**
_ The number of cart lines to be returned.
_ @default 100
*/
numCartLines?: number;
/**
_ Visitor consent preferences for the Storefront API's @inContext directive.
_
_ Most Hydrogen storefronts do NOT need this. If you're using Hydrogen's
_ analytics provider or Shopify's Customer Privacy API (including third-party
_ consent services integrated with it), consent is handled automatically.
_
_ This option exists for Storefront API parity and is primarily intended for
_ non-Hydrogen integrations like Checkout Kit that manage consent outside
_ Shopify's standard consent flow.
_
_ When provided, consent is encoded into the cart's checkoutUrl via the _cs parameter.
_/
visitorConsent?: VisitorConsent$1;
};
type CartGetFunction = (cartInput?: CartGetProps) => Promise<CartReturn | null>;
type CartGetOptions = CartQueryOptions & {
/**
_ The customer account client instance created by createCustomerAccountClient.
_/
customerAccount?: CustomerAccount;
};
declare function cartGetDefault({ storefront, customerAccount, getCartId, cartFragment, }: CartGetOptions): CartGetFunction;
type CartCreateFunction = (input: CartInput, optionalParams?: CartOptionalInput) => Promise;
declare function cartCreateDefault(options: CartQueryOptions): CartCreateFunction;
type CartLinesAddFunction = (lines: Array, optionalParams?: CartOptionalInput) => Promise;
declare function cartLinesAddDefault(options: CartQueryOptions): CartLinesAddFunction;
type CartLinesUpdateFunction = (lines: CartLineUpdateInput[], optionalParams?: CartOptionalInput) => Promise;
declare function cartLinesUpdateDefault(options: CartQueryOptions): CartLinesUpdateFunction;
type CartLinesRemoveFunction = (lineIds: string[], optionalParams?: CartOptionalInput) => Promise;
declare function cartLinesRemoveDefault(options: CartQueryOptions): CartLinesRemoveFunction;
type CartDiscountCodesUpdateFunction = (discountCodes: string[], optionalParams?: CartOptionalInput) => Promise;
declare function cartDiscountCodesUpdateDefault(options: CartQueryOptions): CartDiscountCodesUpdateFunction;
type CartBuyerIdentityUpdateFunction = (buyerIdentity: CartBuyerIdentityInput, optionalParams?: CartOptionalInput) => Promise;
declare function cartBuyerIdentityUpdateDefault(options: CartQueryOptions): CartBuyerIdentityUpdateFunction;
type CartNoteUpdateFunction = (note: string, optionalParams?: CartOptionalInput) => Promise;
declare function cartNoteUpdateDefault(options: CartQueryOptions): CartNoteUpdateFunction;
type CartSelectedDeliveryOptionsUpdateFunction = (selectedDeliveryOptions: CartSelectedDeliveryOptionInput[], optionalParams?: CartOptionalInput) => Promise;
declare function cartSelectedDeliveryOptionsUpdateDefault(options: CartQueryOptions): CartSelectedDeliveryOptionsUpdateFunction;
type CartAttributesUpdateFunction = (attributes: AttributeInput[], optionalParams?: CartOptionalInput) => Promise;
declare function cartAttributesUpdateDefault(options: CartQueryOptions): CartAttributesUpdateFunction;
type CartMetafieldsSetFunction = (metafields: MetafieldWithoutOwnerId[], optionalParams?: CartOptionalInput) => Promise;
declare function cartMetafieldsSetDefault(options: CartQueryOptions): CartMetafieldsSetFunction;
type CartMetafieldDeleteFunction = (key: Scalars['String']['input'], optionalParams?: CartOptionalInput) => Promise;
declare function cartMetafieldDeleteDefault(options: CartQueryOptions): CartMetafieldDeleteFunction;
type CartGiftCardCodesUpdateFunction = (giftCardCodes: string[], optionalParams?: CartOptionalInput) => Promise;
/**
- Updates (replaces) gift card codes in the cart.
- To add codes without replacing, use
cartGiftCardCodesAdd (API 2025-10+).
- @param {CartQueryOptions} options - Cart query options including storefront client and cart fragment.
- @returns {CartGiftCardCodesUpdateFunction} - Function accepting gift card codes array and optional parameters.
- @example Replace all gift card codes
- const updateGiftCardCodes = cartGiftCardCodesUpdateDefault({ storefront, getCartId });
- await updateGiftCardCodes(['SUMMER2025', 'WELCOME10']);
*/
declare function cartGiftCardCodesUpdateDefault(options: CartQueryOptions): CartGiftCardCodesUpdateFunction;
type CartGiftCardCodesAddFunction = (giftCardCodes: string[], optionalParams?: CartOptionalInput) => Promise;
/**
- Adds gift card codes to the cart without replacing existing ones.
- This function sends a mutation to the Storefront API to add one or more gift card codes to the cart.
- Unlike
cartGiftCardCodesUpdate which replaces all codes, this mutation appends new codes to existing ones.
- @param {CartQueryOptions} options - The options for the cart query, including the storefront API client and cart fragment.
- @returns {CartGiftCardCodesAddFunction} - A function that takes an array of gift card codes and optional parameters, and returns the result of the API call.
- @example Add gift card codes
- const addGiftCardCodes = cartGiftCardCodesAddDefault({ storefront, getCartId });
- await addGiftCardCodes(['SUMMER2025', 'WELCOME10']);
*/
declare function cartGiftCardCodesAddDefault(options: CartQueryOptions): CartGiftCardCodesAddFunction;
type CartGiftCardCodesRemoveFunction = (appliedGiftCardIds: string[], optionalParams?: CartOptionalInput) => Promise;
declare function cartGiftCardCodesRemoveDefault(options: CartQueryOptions): CartGiftCardCodesRemoveFunction;
type CartDeliveryAddressesAddFunction = (addresses: Array, optionalParams?: CartOptionalInput) => Promise;
/**
type CartDeliveryAddressesRemoveFunction = (addressIds: Array<Scalars['ID']['input']> | Array, optionalParams?: CartOptionalInput) => Promise;
/**
- Removes delivery addresses from the cart.
- This function sends a mutation to the storefront API to remove one or more delivery addresses from the cart.
- It returns the result of the mutation, including any errors that occurred.
- @param {CartQueryOptions} options - The options for the cart query, including the storefront API client and cart fragment.
- @returns {CartDeliveryAddressRemoveFunction} - A function that takes an array of address IDs and optional parameters, and returns the result of the API call.
- @example
- const removeDeliveryAddresses = cartDeliveryAddressesRemoveDefault({ storefront, getCartId });
- const result = await removeDeliveryAddresses([
- "gid://shopify//10079785100"
- ],
- { someOptionalParam: 'value' });
*/
declare function cartDeliveryAddressesRemoveDefault(options: CartQueryOptions): CartDeliveryAddressesRemoveFunction;
type CartDeliveryAddressesUpdateFunction = (addresses: Array, optionalParams?: CartOptionalInput) => Promise;
/**
- Updates delivery addresses in the cart.
- Pass an empty array to clear all delivery addresses from the cart.
- @param {CartQueryOptions} options - The options for the cart query, including the storefront API client and cart fragment.
- @returns {CartDeliveryAddressUpdateFunction} - A function that takes an array of addresses and optional parameters, and returns the result of the API call.
- @example Clear all delivery addresses
- const updateAddresses = cartDeliveryAddressesUpdateDefault(cartQueryOptions);
- await updateAddresses([]);
- @example Update specific delivery addresses
- const updateAddresses = cartDeliveryAddressesUpdateDefault(cartQueryOptions);
- await updateAddresses([
{
"address": {
"copyFromCustomerAddressId": "gid://shopify//10079785100",
"deliveryAddress": {
"address1": "",
"address2": "",
"city": "",
"company": "",
"countryCode": "AC",
"firstName": "",
"lastName": "",
"phone": "",
"provinceCode": "",
"zip": ""
}
},
"id": "gid://shopify//10079785100",
"oneTimeUse": true,
"selected": true,
"validationStrategy": "COUNTRY_CODE_ONLY"
}
],{ someOptionalParam: 'value' });
*/
declare function cartDeliveryAddressesUpdateDefault(options: CartQueryOptions): CartDeliveryAddressesUpdateFunction;
type CartDeliveryAddressesReplaceFunction = (addresses: Array, optionalParams?: CartOptionalInput) => Promise;
/**
- Replaces all delivery addresses on the cart.
- This function sends a mutation to the storefront API to replace all delivery addresses on the cart
- with the provided addresses. It returns the result of the mutation, including any errors that occurred.
- @param {CartQueryOptions} options - The options for the cart query, including the storefront API client and cart fragment.
- @returns {CartDeliveryAddressesReplaceFunction} - A function that takes an array of addresses and optional parameters, and returns the result of the API call.
- @example
- const replaceDeliveryAddresses = cartDeliveryAddressesReplaceDefault({ storefront, getCartId });
- const result = await replaceDeliveryAddresses([
- {
-
address: {
-
deliveryAddress: {
-
address1: '123 Main St',
-
city: 'Anytown',
-
countryCode: 'US'
-
}
-
},
-
selected: true
- }
- ], { someOptionalParam: 'value' }
- );
*/
declare function cartDeliveryAddressesReplaceDefault(options: CartQueryOptions): CartDeliveryAddressesReplaceFunction;
type CartHandlerOptions = {
storefront: Storefront;
customerAccount?: CustomerAccount;
getCartId: () => string | undefined;
setCartId: (cartId: string) => Headers;
cartQueryFragment?: string;
cartMutateFragment?: string;
buyerIdentity?: CartBuyerIdentityInput;
};
type CustomMethodsBase = Record<string, Function>;
type CartHandlerOptionsWithCustom = CartHandlerOptions & {
customMethods?: TCustomMethods;
};
type HydrogenCart = {
get: ReturnType;
getCartId: () => string | undefined;
setCartId: (cartId: string) => Headers;
create: ReturnType;
addLines: ReturnType;
updateLines: ReturnType;
removeLines: ReturnType;
updateDiscountCodes: ReturnType;
updateGiftCardCodes: ReturnType;
addGiftCardCodes: ReturnType;
removeGiftCardCodes: ReturnType;
updateBuyerIdentity: ReturnType;
updateNote: ReturnType;
updateSelectedDeliveryOption: ReturnType;
updateAttributes: ReturnType;
setMetafields: ReturnType;
deleteMetafield: ReturnType;
/**
_ Adds delivery addresses to the cart.
_
_ This function sends a mutation to the storefront API to add one or more delivery addresses to the cart.
_ It returns the result of the mutation, including any errors that occurred. *
_ @param {CartQueryOptions} options - The options for the cart query, including the storefront API client and cart fragment.
_ @returns {ReturnType} - A function that takes an array of addresses and optional parameters, and returns the result of the API call. *
_ @example
_ const result = await cart.addDeliveryAddresses(
_ [
_ {
_ address1: '123 Main St',
_ city: 'Anytown',
_ countryCode: 'US'
_ }
_ ],
_ { someOptionalParam: 'value' }
_ );
_/
addDeliveryAddresses: ReturnType;
/**
_ Removes delivery addresses from the cart.
_
_ This function sends a mutation to the storefront API to remove one or more delivery addresses from the cart.
_ It returns the result of the mutation, including any errors that occurred. *
_ @param {CartQueryOptions} options - The options for the cart query, including the storefront API client and cart fragment.
_ @returns {CartDeliveryAddressRemoveFunction} - A function that takes an array of address IDs and optional parameters, and returns the result of the API call. *
_ @example
_ const result = await cart.removeDeliveryAddresses([
- "gid://shopify//10079785100"
- ],
_ { someOptionalParam: 'value' });
_/
removeDeliveryAddresses: ReturnType;
/**
_ Updates delivery addresses in the cart.
_
_ This function sends a mutation to the storefront API to update one or more delivery addresses in the cart.
_ It returns the result of the mutation, including any errors that occurred. *
_ @param {CartQueryOptions} options - The options for the cart query, including the storefront API client and cart fragment.
_ @returns {CartDeliveryAddressUpdateFunction} - A function that takes an array of addresses and optional parameters, and returns the result of the API call. *
_ const result = await cart.updateDeliveryAddresses([
{
"address": {
"copyFromCustomerAddressId": "gid://shopify//10079785100",
"deliveryAddress": {
"address1": "",
"address2": "",
"city": "",
"company": "",
"countryCode": "AC",
"firstName": "",
"lastName": "",
"phone": "",
"provinceCode": "",
"zip": ""
}
},
"id": "gid://shopify//10079785100",
"oneTimeUse": true,
"selected": true,
"validationStrategy": "COUNTRY_CODE_ONLY"
}
],{ someOptionalParam: 'value' });
_/
updateDeliveryAddresses: ReturnType;
/**
_ Replaces all delivery addresses on the cart.
_
_ This function sends a mutation to the storefront API to replace all delivery addresses on the cart
_ with the provided addresses. It returns the result of the mutation, including any errors that occurred. *
_ @param {CartQueryOptions} options - The options for the cart query, including the storefront API client and cart fragment.
_ @returns {CartDeliveryAddressesReplaceFunction} - A function that takes an array of addresses and optional parameters, and returns the result of the API call. *
_ @example
_ const result = await cart.replaceDeliveryAddresses([
- {
- address: {
- deliveryAddress: {
- address1: '123 Main St',
- city: 'Anytown',
- countryCode: 'US'
- }
- },
- selected: true
- }
- ], { someOptionalParam: 'value' });
*/
replaceDeliveryAddresses: ReturnType;
};
type HydrogenCartCustom<TCustomMethods extends Partial & CustomMethodsBase> = Omit<HydrogenCart, keyof TCustomMethods> & TCustomMethods;
declare function createCartHandler(options: CartHandlerOptions): HydrogenCart;
declare function createCartHandler(options: CartHandlerOptionsWithCustom): HydrogenCartCustom;
type RequestEventPayload = {
__fromVite?: boolean;
url: string;
eventType: 'request' | 'subrequest';
requestId?: string | null;
purpose?: string | null;
startTime: number;
endTime?: number;
cacheStatus?: 'MISS' | 'HIT' | 'STALE' | 'PUT';
waitUntil?: WaitUntil;
graphql?: string | null;
stackInfo?: {
file?: string;
func?: string;
line?: number;
column?: number;
};
responsePayload?: any;
responseInit?: Omit<ResponseInit, 'headers'> & {
headers?: [string, string][];
};
cache?: {
status?: string;
strategy?: string;
key?: string | readonly unknown[];
};
displayName?: string;
};
declare const CUSTOMER_ACCOUNT_SESSION_KEY = "customerAccount";
declare const BUYER_SESSION_KEY = "buyer";
interface HydrogenSessionData {
[CUSTOMER_ACCOUNT_SESSION_KEY]: {
accessToken?: string;
expiresAt?: string;
refreshToken?: string;
codeVerifier?: string;
idToken?: string;
nonce?: string;
state?: string;
redirectPath?: string;
};
// for B2B buyer context
[BUYER_SESSION_KEY]: Partial;
}
interface HydrogenSession<
Data = SessionData,
FlashData = FlashSessionData,
{
get: Session<HydrogenSessionData & Data, FlashData>['get'];
set: Session<HydrogenSessionData & Data, FlashData>['set'];
unset: Session<HydrogenSessionData & Data, FlashData>['unset'];
commit: () => ReturnType<
SessionStorage<HydrogenSessionData & Data, FlashData>['commitSession']
;
destroy?: () => ReturnType<
SessionStorage<HydrogenSessionData & Data, FlashData>['destroySession']
;
isPending?: boolean;
}
type WaitUntil = (promise: Promise) => void;
interface HydrogenEnv {
SESSION_SECRET: string;
PUBLIC_STOREFRONT_API_TOKEN: string;
PRIVATE_STOREFRONT_API_TOKEN: string;
PUBLIC_STORE_DOMAIN: string;
PUBLIC_STOREFRONT_ID: string;
PUBLIC_CUSTOMER_ACCOUNT_API_CLIENT_ID: string;
PUBLIC_CUSTOMER_ACCOUNT_API_URL: string;
PUBLIC_CHECKOUT_DOMAIN: string;
SHOP_ID: string;
}
type StorefrontHeaders = {
/** A unique ID that correlates all sub-requests together. */
requestGroupId: string | null;
/** The IP address of the client. _/
buyerIp: string | null;
/** The signature of the client's IP address for verification. _/
buyerIpSig: string | null;
/** The cookie header from the client */
cookie: string | null;
/** The sec-purpose or purpose header value */
purpose: string | null;
};
interface HydrogenRouterContextProvider<
TSession extends HydrogenSession = HydrogenSession,
TCustomMethods extends CustomMethodsBase | undefined = {},
TI18n extends I18nBase = I18nBase,
TEnv extends HydrogenEnv = Env,
extends RouterContextProvider {
/** A GraphQL client for querying the Storefront API */
storefront: Storefront;
/** A GraphQL client for querying the Customer Account API _/
customerAccount: CustomerAccount;
/** A collection of utilities used to interact with the cart _/
cart: TCustomMethods extends CustomMethodsBase
? HydrogenCartCustom<TCustomMethods>
: HydrogenCart;
/** Environment variables from the fetch function */
env: TEnv;
/** The waitUntil function for keeping requests alive _/
waitUntil?: WaitUntil;
/** Session implementation _/
session: TSession;
}
declare global {
interface Window {
privacyBanner: PrivacyBanner;
Shopify: {
customerPrivacy: CustomerPrivacy;
};
}
interface Document {
addEventListener(
type: K,
listener: (this: Document, ev: CustomEventMap[K]) => void,
): void;
removeEventListener(
type: K,
listener: (this: Document, ev: CustomEventMap[K]) => void,
): void;
dispatchEvent(ev: CustomEventMap[K]): void;
}
var **H2O_LOG_EVENT: undefined | ((event: RequestEventPayload) => void);
var **remix_devServerHooks:
| undefined
| {getCriticalCss: (...args: unknown[]) => any};
}
type I18nBase = {
language: LanguageCode$1 | LanguageCode;
country: CountryCode$1;
};
type JsonGraphQLError = ReturnType<GraphQLError['toJSON']>;
type StorefrontApiErrors = JsonGraphQLError[] | undefined;
type StorefrontError = {
errors?: StorefrontApiErrors;
};
/**
- Wraps all the returned utilities from
createStorefrontClient.
*/
type StorefrontClient = {
storefront: Storefront;
};
/**
- Maps all the queries found in the project to variables and return types.
*/
interface StorefrontQueries {
}
/**
- Maps all the mutations found in the project to variables and return types.
*/
interface StorefrontMutations {
}
type AutoAddedVariableNames = 'country' | 'language';
type StorefrontCommonExtraParams = {
headers?: HeadersInit;
storefrontApiVersion?: string;
displayName?: string;
};
/**
- Interface to interact with the Storefront API.
_/
type Storefront = {
query: (query: RawGqlString, ...options: ClientVariablesInRestParams<StorefrontQueries, RawGqlString, StorefrontCommonExtraParams & Pick<StorefrontQueryOptions, 'cache'>, AutoAddedVariableNames>) => Promise<ClientReturn<StorefrontQueries, RawGqlString, OverrideReturnType> & StorefrontError>;
mutate: (mutation: RawGqlString, ...options: ClientVariablesInRestParams<StorefrontMutations, RawGqlString, StorefrontCommonExtraParams, AutoAddedVariableNames>) => Promise<ClientReturn<StorefrontMutations, RawGqlString, OverrideReturnType> & StorefrontError>;
cache?: Cache;
CacheNone: typeof CacheNone;
CacheLong: typeof CacheLong;
CacheShort: typeof CacheShort;
CacheCustom: typeof CacheCustom;
generateCacheControlHeader: typeof generateCacheControlHeader;
getPublicTokenHeaders: ReturnType<typeof createStorefrontClient$1>['getPublicTokenHeaders'];
getPrivateTokenHeaders: ReturnType<typeof createStorefrontClient$1>['getPrivateTokenHeaders'];
getShopifyDomain: ReturnType<typeof createStorefrontClient$1>['getShopifyDomain'];
getApiUrl: ReturnType<typeof createStorefrontClient$1>['getStorefrontApiUrl'];
i18n: TI18n;
getHeaders: () => Record<string, string>;
/**
_ Checks if the request URL matches the Storefront API GraphQL endpoint.
_/
isStorefrontApiUrl: (request: {
url?: string;
}) => boolean;
/**
_ Forwards the request to the Storefront API.
_ It reads the API version from the request URL.
_/
forward: (request: Request, options?: Pick<StorefrontCommonExtraParams, 'storefrontApiVersion'>) => Promise;
/**
_ Sets the collected subrequest headers in the response.
_ Useful to forward the cookies and server-timing headers
_ from server subrequests to the browser.
_/
setCollectedSubrequestHeaders: (response: {
headers: Headers;
}) => void;
};
type HydrogenClientProps = {
/** Storefront API headers. If on Oxygen, use
getStorefrontHeaders() _/
storefrontHeaders?: StorefrontHeaders;
/** An instance that implements the Cache API _/
cache?: Cache;
/** The globally unique identifier for the Shop */
storefrontId?: string;
/** The waitUntil function is used to keep the current request/response lifecycle alive even after a response has been sent. It should be provided by your platform. _/
waitUntil?: WaitUntil;
/** An object containing a country code and language code _/
i18n?: TI18n;
/** Whether it should print GraphQL errors automatically. Defaults to true */
logErrors?: boolean | ((error?: Error) => boolean);
};
type CreateStorefrontClientOptions = HydrogenClientProps & StorefrontClientProps;
type StorefrontQueryOptions = StorefrontCommonExtraParams & {
query: string;
mutation?: never;
cache?: CachingStrategy;
};
/**
- This function extends
createStorefrontClient from Hydrogen React. The additional arguments enable internationalization (i18n), caching, and other features particular to Remix and Oxygen.
- Learn more about data fetching in Hydrogen.
_/
declare function createStorefrontClient(options: CreateStorefrontClientOptions): StorefrontClient;
declare function formatAPIResult(data: T, errors: StorefrontApiErrors): T & StorefrontError;
type CreateStorefrontClientForDocs = {
storefront?: StorefrontForDoc;
};
type StorefrontForDoc = {
/** The function to run a query on Storefront API. _/
query?: <TData = any>(query: string, options: StorefrontQueryOptionsForDocs) => Promise<TData & StorefrontError>;
/** The function to run a mutation on Storefront API. */
mutate?: <TData = any>(mutation: string, options: StorefrontMutationOptionsForDocs) => Promise<TData & StorefrontError>;
/** The cache instance passed in from the
createStorefrontClient argument. _/
cache?: Cache;
/** Re-export of CacheNone. _/
CacheNone?: typeof CacheNone;
/** Re-export of CacheLong. */
CacheLong?: typeof CacheLong;
/** Re-export of CacheShort. _/
CacheShort?: typeof CacheShort;
/** Re-export of CacheCustom. /
CacheCustom?: typeof CacheCustom;
/** Re-export of 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. /
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./
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. */
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./
getApiUrl?: ReturnType<typeof createStorefrontClient$1>['getStorefrontApiUrl'];
/** The i18n object passed in from the createStorefrontClient argument. _/
i18n?: TI18n;
};
type StorefrontQueryOptionsForDocs = {
/** The variables for the GraphQL query statement. */
variables?: Record<string, unknown>;
/** The cache strategy for this query. Default to max-age=1, stale-while-revalidate=86399. _/
cache?: CachingStrategy;
/** Additional headers for this query. _/
headers?: HeadersInit;
/** Override the Storefront API version for this query. */
storefrontApiVersion?: string;
/** The name of the query for debugging in the Subrequest Profiler. _/
displayName?: string;
};
type StorefrontMutationOptionsForDocs = {
/** The variables for the GraphQL mutation statement. _/
variables?: Record<string, unknown>;
/** Additional headers for this query. */
headers?: HeadersInit;
/** Override the Storefront API version for this query. _/
storefrontApiVersion?: string;
/** The name of the query for debugging in the Subrequest Profiler. _/
displayName?: string;
};
type CartOptionalInput = {
/**
_ The cart id.
_ @default cart.getCartId();
*/
cartId?: Scalars['ID']['input'];
/**
_ The country code.
_ @default storefront.i18n.country
_/
country?: CountryCode$1;
/**
_ The language code.
_ @default storefront.i18n.language
_/
language?: LanguageCode$1;
/**
- Visitor consent preferences for the Storefront API's @inContext directive.
- * Most Hydrogen storefronts do NOT need this. If you're using Hydrogen's
_ analytics provider or Shopify's Customer Privacy API (including third-party
_ consent services integrated with it), consent is handled automatically. *
_ This option exists for Storefront API parity and is primarily intended for
_ non-Hydrogen integrations like Checkout Kit that manage consent outside
_ Shopify's standard consent flow.
_
_ When provided, consent is encoded into the cart's checkoutUrl via the _cs parameter.
_ @see https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/in-context
*/
visitorConsent?: VisitorConsent$1;
};
type MetafieldWithoutOwnerId = Omit<CartMetafieldsSetInput, 'ownerId'>;
type CartQueryOptions = {
/**
_ The storefront client instance created by
createStorefrontClient.
_/
storefront: Storefront;
/**
_ A function that returns the cart ID.
_/
getCartId: () => string | undefined;
/**
_ The cart fragment to override the one used in this query.
_/
cartFragment?: string;
/**
_ The customer account instance created by createCustomerAccount.
_/
customerAccount?: CustomerAccount;
};
type CartReturn = Cart & {
errors?: StorefrontApiErrors;
};
type CartQueryData = {
cart: Cart;
userErrors?: CartUserError[] | MetafieldsSetUserError[] | MetafieldDeleteUserError[];
warnings?: CartWarning[];
};
type CartQueryDataReturn = CartQueryData & {
errors?: StorefrontApiErrors;
};
type CartQueryReturn = (requiredParams: T, optionalParams?: CartOptionalInput) => Promise;
declare const AnalyticsEvent: {
PAGE*VIEWED: "page_viewed";
PRODUCT_VIEWED: "product_viewed";
COLLECTION_VIEWED: "collection_viewed";
CART_VIEWED: "cart_viewed";
SEARCH_VIEWED: "search_viewed";
CART_UPDATED: "cart_updated";
PRODUCT_ADD_TO_CART: "product_added_to_cart";
PRODUCT_REMOVED_FROM_CART: "product_removed_from_cart";
CUSTOM_EVENT: custom*${string};
};
type OtherData = {
/** Any other data that should be included in the event. */
[key: string]: unknown;
};
type BasePayload = {
/** The shop data passed in from the AnalyticsProvider. _/
shop: ShopAnalytics | null;
/** The custom data passed in from the AnalyticsProvider. _/
customData?: AnalyticsProviderProps['customData'];
};
type UrlPayload = {
/** The url location of when this event is collected. */
url: string;
};
type ProductPayload = {
/** The product id. _/
id: Product['id'];
/** The product title. _/
title: Product['title'];
/** The displaying variant price. */
price: ProductVariant['price']['amount'];
/** The product vendor. _/
vendor: Product['vendor'];
/** The displaying variant id. _/
variantId: ProductVariant['id'];
/** The displaying variant title. */
variantTitle: ProductVariant['title'];
/** The quantity of product. _/
quantity: number;
/** The product sku. _/
sku?: ProductVariant['sku'];
/** The product type. */
productType?: Product['productType'];
};
type ProductsPayload = {
/** The products associated with this event. _/
products: Array<ProductPayload & OtherData>;
};
type CollectionPayloadDetails = {
/** The collection id. _/
id: string;
/** The collection handle. */
handle: string;
};
type CollectionPayload = {
collection: CollectionPayloadDetails;
};
type SearchPayload = {
/** The search term used for the search results page _/
searchTerm: string;
/** The search results _/
searchResults?: any;
};
type CartPayload = {
/** The current cart state. */
cart: CartReturn | null;
/** The previous cart state. _/
prevCart: CartReturn | null;
};
type CartLinePayload = {
/** The previous state of the cart line that got updated. /
prevLine?: CartLine | ComponentizableCartLine;
/* The current state of the cart line that got updated. _/
currentLine?: CartLine | ComponentizableCartLine;
};
type CollectionViewPayload = CollectionPayload & UrlPayload & BasePayload;
type ProductViewPayload = ProductsPayload & UrlPayload & BasePayload;
type CartViewPayload = CartPayload & UrlPayload & BasePayload;
type PageViewPayload = UrlPayload & BasePayload;
type SearchViewPayload = SearchPayload & UrlPayload & BasePayload;
type CartUpdatePayload = CartPayload & BasePayload & OtherData;
type CartLineUpdatePayload = CartLinePayload & CartPayload & BasePayload & OtherData;
type CustomEventPayload = BasePayload & OtherData;
type BasicViewProps = {
data?: OtherData;
customData?: OtherData;
};
type ProductViewProps = {
data: ProductsPayload;
customData?: OtherData;
};
type CollectionViewProps = {
data: CollectionPayload;
customData?: OtherData;
};
type SearchViewProps = {
data?: SearchPayload;
customData?: OtherData;
};
type CustomViewProps = {
type: typeof AnalyticsEvent.CUSTOM_EVENT;
data?: OtherData;
customData?: OtherData;
};
declare function AnalyticsProductView(props: ProductViewProps): react_jsx_runtime.JSX.Element;
declare function AnalyticsCollectionView(props: CollectionViewProps): react_jsx_runtime.JSX.Element;
declare function AnalyticsCartView(props: BasicViewProps): react_jsx_runtime.JSX.Element;
declare function AnalyticsSearchView(props: SearchViewProps): react_jsx_runtime.JSX.Element;
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
