# createHydrogenContext The `createHydrogenContext` function creates the context object required to use Hydrogen utilities throughout a Hydrogen project. ### Example code ```jsx import {createHydrogenContext} from '@shopify/hydrogen'; import * as remixBuild from '@remix-run/dev/server-build'; import { createRequestHandler, createCookieSessionStorage, } from '@shopify/remix-oxygen'; export default { async fetch(request, env, executionContext) { const waitUntil = executionContext.waitUntil.bind(executionContext); const [cache, session] = await Promise.all([ caches.open('hydrogen'), AppSession.init(request, [env.SESSION_SECRET]), ]); /* Create context objects required to use Hydrogen with your credentials and options */ const hydrogenContext = createHydrogenContext({ /* Environment variables from the fetch function */ env, /* Request object from the fetch function */ request, /* Cache API instance */ cache, /* Runtime utility in serverless environments */ waitUntil, session, }); const handleRequest = createRequestHandler({ build: remixBuild, mode: process.env.NODE_ENV, /* Inject the customer account client in the Remix context */ getLoadContext: () => ({...hydrogenContext}), }); const response = await handleRequest(request); if (session.isPending) { response.headers.set('Set-Cookie', await session.commit()); } return response; }, }; class AppSession { isPending = false; static async init(request, secrets) { const storage = createCookieSessionStorage({ cookie: { name: 'session', httpOnly: true, path: '/', sameSite: 'lax', secrets, }, }); const session = await storage.getSession(request.headers.get('Cookie')); return new this(storage, session); } get(key) { return this.session.get(key); } destroy() { return this.sessionStorage.destroySession(this.session); } flash(key, value) { this.session.flash(key, value); } unset(key) { this.isPending = true; this.session.unset(key); } set(key, value) { this.isPending = true; this.session.set(key, value); } commit() { this.isPending = false; return this.sessionStorage.commitSession(this.session); } } ``` ```tsx import {createHydrogenContext, type HydrogenSession} from '@shopify/hydrogen'; import * as remixBuild from '@remix-run/dev/server-build'; import { createRequestHandler, createCookieSessionStorage, type SessionStorage, type Session, } from '@shopify/remix-oxygen'; export default { async fetch(request: Request, env: Env, executionContext: ExecutionContext) { const waitUntil = executionContext.waitUntil.bind(executionContext); const [cache, session] = await Promise.all([ caches.open('hydrogen'), AppSession.init(request, [env.SESSION_SECRET]), ]); /* Create context objects required to use Hydrogen with your credentials and options */ const hydrogenContext = createHydrogenContext({ /* Environment variables from the fetch function */ env, /* Request object from the fetch function */ request, /* Cache API instance */ cache, /* Runtime utility in serverless environments */ waitUntil, session, }); const handleRequest = createRequestHandler({ build: remixBuild, mode: process.env.NODE_ENV, /* Inject the customer account client in the Remix context */ getLoadContext: () => ({...hydrogenContext}), }); const response = await handleRequest(request); if (session.isPending) { response.headers.set('Set-Cookie', await session.commit()); } return response; }, }; class AppSession implements HydrogenSession { public isPending = false; constructor( private sessionStorage: SessionStorage, private session: Session, ) {} static async init(request: Request, secrets: string[]) { const storage = createCookieSessionStorage({ cookie: { name: 'session', httpOnly: true, path: '/', sameSite: 'lax', secrets, }, }); const session = await storage.getSession(request.headers.get('Cookie')); return new this(storage, session); } get(key: string) { return this.session.get(key); } destroy() { return this.sessionStorage.destroySession(this.session); } flash(key: string, value: any) { this.session.flash(key, value); } unset(key: string) { this.isPending = true; this.session.unset(key); } set(key: string, value: any) { this.isPending = true; this.session.set(key, value); } commit() { this.isPending = false; return this.sessionStorage.commitSession(this.session); } } ``` ## createHydrogenContext(options) ### HydrogenContextOptionsForDocs ### cache An instance that implements the [Cache API](https://developer.mozilla.org/en-US/docs/Web/API/Cache) ### cart Cart handler overwrite options. See documentation for createCartHandler for more information. ### customerAccount Customer Account client overwrite options. See documentation for createCustomerAccountClient for more information. ### env ### i18n An object containing a country code and language code ### logErrors Whether it should print GraphQL errors automatically. Defaults to true ### request ### session 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. ### storefront Storefront client overwrite options. See documentation for createStorefrontClient for more information. ### waitUntil 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. ### Headers Headers ### CrossRuntimeRequest ### headers ### method ### url ## Related - [createHydrogenContext](/docs/api/hydrogen/2024-10/utilities/createhydrogencontext) ## Returns ### HydrogenContext ### cart A collection of utilities used to interact with the cart. ### customerAccount A GraphQL client for querying the [Customer Account API](https://shopify.dev/docs/api/customer). It also provides methods to authenticate and check if the user is logged in. ### env ### session 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. ### storefront A GraphQL client for querying the [Storefront API](https://shopify.dev/docs/api/storefront). ### waitUntil 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. ### CustomMethodsBase Record ### HydrogenCartCustom Omit & TCustomMethods ### HydrogenCart ### addLines ### create ### deleteMetafield ### get ### getCartId ### removeLines ### setCartId ### setMetafields ### updateAttributes ### updateBuyerIdentity ### updateDiscountCodes ### updateGiftCardCodes ### updateLines ### updateNote ### updateSelectedDeliveryOption ### Headers Headers ### CustomerAccount ### authorize 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. ### getAccessToken Returns CustomerAccessToken if the customer is logged in. It also run a expiry check and does a token refresh if needed. ### getApiUrl Creates the fully-qualified URL to your store's GraphQL endpoint. ### handleAuthStatus Check for a not logged in customer and redirect customer to login page. The redirect can be overwritten with `customAuthStatusHandler` option. ### isLoggedIn Returns if the customer is logged in. It also checks if the access token is expired and refreshes it if needed. ### login Start the OAuth login flow. This function should be called and returned from a Remix action. 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) ### logout 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. ### mutate Execute a GraphQL mutation against the Customer Account API. This method execute `handleAuthStatus()` ahead of mutation. ### query Execute a GraphQL query against the Customer Account API. This method execute `handleAuthStatus()` ahead of query. ### UNSTABLE_getBuyer UNSTABLE feature. Get buyer token and company location id from session. ### UNSTABLE_setBuyer UNSTABLE feature. Set buyer information into session. ### DataFunctionValue Response | NonNullable | null ### LoginOptions ### uiLocales ### LogoutOptions ### headers ### postLogoutRedirectUri ### CustomerAccountMutations export interface CustomerAccountMutations { // Example of how a generated mutation type looks like: // '#graphql mutation m1 {...}': {return: M1Mutation; variables: M1MutationVariables}; } ### CustomerAPIResponse ### data ### errors ### extensions ### GraphQLError ### locations If an error can be associated to a particular point in the requested GraphQL document, it should contain a list of locations. ### path 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. ### extensions Reserved for implementors to extend the protocol however they see fit, and hence there are no additional restrictions on its contents. ### toString 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]`. ### toJSON Note: toJSON` is internally used by `JSON.stringify(...)`. The most common scenario when this error instance is going to be stringified is when it's passed to Remix' `json` and `defer` functions: e.g. `defer({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. ### __@toStringTag@690 ### name ### message ### stack ### CustomerAccountQueries export interface CustomerAccountQueries { // Example of how a generated query type looks like: // '#graphql query q1 {...}': {return: Q1Query; variables: Q1QueryVariables}; } ### Storefront Interface to interact with the Storefront API. ### cache ### CacheCustom ### CacheLong ### CacheNone ### CacheShort ### generateCacheControlHeader ### getApiUrl ### getPrivateTokenHeaders ### getPublicTokenHeaders ### getShopifyDomain ### i18n ### mutate ### query ### AllCacheOptions Override options for a cache strategy. ### maxAge The maximum amount of time in seconds that a resource will be considered fresh. See `max-age` in the [MDN docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control#:~:text=Response%20Directives-,max%2Dage,-The%20max%2Dage). ### mode The caching mode, generally `public`, `private`, or `no-store`. ### sMaxAge Similar to `maxAge` but specific to shared caches. See `s-maxage` in the [MDN docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control#s-maxage). ### staleIfError Indicate that the cache should serve the stale response if an error occurs while revalidating the cache. See `stale-if-error` in the [MDN docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control#stale-if-error). ### staleWhileRevalidate Indicate that the cache should serve the stale response in the background while revalidating the cache. See `stale-while-revalidate` in the [MDN docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control#stale-while-revalidate). ### NoStoreStrategy ### mode ### StorefrontMutations Maps all the mutations found in the project to variables and return types. export interface StorefrontMutations { // Example of how a generated mutation type looks like: // '#graphql mutation m1 {...}': {return: M1Mutation; variables: M1MutationVariables}; } ### AutoAddedVariableNames 'country' | 'language' ### StorefrontCommonExtraParams ### displayName ### headers ### storefrontApiVersion ### StorefrontError ### errors ### StorefrontApiErrors JsonGraphQLError[] | undefined ### JsonGraphQLError ReturnType ### StorefrontQueries Maps all the queries found in the project to variables and return types. export interface StorefrontQueries { // Example of how a generated query type looks like: // '#graphql query q1 {...}': {return: Q1Query; variables: Q1QueryVariables}; } ### StorefrontQueryOptions StorefrontCommonExtraParams & { query: string; mutation?: never; cache?: CachingStrategy; } ### CachingStrategy Use the `CachingStrategy` to define a custom caching mechanism for your data. Or use one of the pre-defined caching strategies: CacheNone, CacheShort, CacheLong. ### maxAge The maximum amount of time in seconds that a resource will be considered fresh. See `max-age` in the [MDN docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control#:~:text=Response%20Directives-,max%2Dage,-The%20max%2Dage). ### mode The caching mode, generally `public`, `private`, or `no-store`. ### sMaxAge Similar to `maxAge` but specific to shared caches. See `s-maxage` in the [MDN docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control#s-maxage). ### staleIfError Indicate that the cache should serve the stale response if an error occurs while revalidating the cache. See `stale-if-error` in the [MDN docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control#stale-if-error). ### staleWhileRevalidate Indicate that the cache should serve the stale response in the background while revalidating the cache. See `stale-while-revalidate` in the [MDN docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control#stale-while-revalidate). ## Related - [createHydrogenContext](/docs/api/hydrogen/2024-10/utilities/createhydrogencontext)