@shopify/hydrogen 2026.1.4 → 2026.4.1

package/dist/oxygen/index.d.ts

@@ -1,4 +1,5 @@
 import { ServerBuild } from 'react-router';
+import { CountryCode, LanguageCode } from '@shopify/hydrogen-react/storefront-api-types';
 
 type CreateRequestHandlerOptions<Context = unknown> = {
     /** React Router's server build */
@@ -23,21 +24,14 @@ type CreateRequestHandlerOptions<Context = unknown> = {
      * @default true
      */
     collectTrackingInformation?: boolean;
-    /**
-     * Whether to proxy standard routes such as `/api/.../graphql.json` (Storefront API).
-     * You can disable this if you are handling these routes yourself. Ensure that
-     * the proxy works if you rely on Hydrogen's built-in behaviors such as analytics.
-     * @default true
-     */
-    proxyStandardRoutes?: boolean;
 };
 /**
  * Creates a request handler for Hydrogen apps using React Router.
+ * @publicDocs
  */
-declare function createRequestHandler<Context = unknown>({ build, mode, poweredByHeader, getLoadContext, collectTrackingInformation, proxyStandardRoutes, }: CreateRequestHandlerOptions<Context>): (request: Request) => Promise<Response>;
+declare function createRequestHandler<Context = unknown>({ build, mode, poweredByHeader, getLoadContext, collectTrackingInformation, }: CreateRequestHandlerOptions<Context>): (request: Request) => Promise<Response>;
 
 type RequestEventPayload = {
-    __fromVite?: boolean;
     url: string;
     eventType: 'request' | 'subrequest';
     requestId?: string | null;
@@ -65,6 +59,63 @@ type RequestEventPayload = {
     displayName?: string;
 };
 
+type ConsentStatus = boolean | undefined;
+type VisitorConsent = {
+    marketing: ConsentStatus;
+    analytics: ConsentStatus;
+    preferences: ConsentStatus;
+    sale_of_data: ConsentStatus;
+};
+type CustomerPrivacyConsentConfig = {
+    checkoutRootDomain: string;
+    storefrontRootDomain?: string;
+    storefrontAccessToken: string;
+    country?: CountryCode;
+    /** The privacyBanner refers to `language` as `locale`  */
+    locale?: LanguageCode;
+};
+type SetConsentHeadlessParams = VisitorConsent & CustomerPrivacyConsentConfig & {
+    headlessStorefront?: boolean;
+};
+/**
+  Ideally this type should come from the Custoemr Privacy API sdk
+  analyticsProcessingAllowed -
+  currentVisitorConsent
+  doesMerchantSupportGranularConsent
+  firstPartyMarketingAllowed
+  getCCPAConsent
+  getTrackingConsent
+  marketingAllowed
+  preferencesProcessingAllowed
+  saleOfDataAllowed
+  saleOfDataRegion
+  setTrackingConsent
+  shouldShowBanner
+  shouldShowGDPRBanner
+  thirdPartyMarketingAllowed
+**/
+type OriginalCustomerPrivacy = {
+    currentVisitorConsent: () => VisitorConsent;
+    preferencesProcessingAllowed: () => boolean;
+    saleOfDataAllowed: () => boolean;
+    marketingAllowed: () => boolean;
+    analyticsProcessingAllowed: () => boolean;
+    setTrackingConsent: (consent: SetConsentHeadlessParams, callback: (data: {
+        error: string;
+    } | undefined) => void) => void;
+    shouldShowBanner: () => boolean;
+};
+type CustomerPrivacy = Omit<OriginalCustomerPrivacy, 'setTrackingConsent'> & {
+    setTrackingConsent: (consent: VisitorConsent, // we have already applied the headlessStorefront in the override
+    callback: (data: {
+        error: string;
+    } | undefined) => void) => void;
+};
+type PrivacyBanner = {
+    loadBanner: (options?: Partial<CustomerPrivacyConsentConfig>) => void;
+    showPreferences: (options?: Partial<CustomerPrivacyConsentConfig>) => void;
+};
+
 type WaitUntil = (promise: Promise<unknown>) => void;
 
 type StorefrontHeaders = {
@@ -84,7 +135,9 @@ declare global {
   interface Window {
     privacyBanner: PrivacyBanner;
     Shopify: {
-      customerPrivacy: CustomerPrivacy;
+      customerPrivacy?: Partial<CustomerPrivacy> & {
+        backendConsentEnabled?: boolean;
+      };
     };
   }
   interface Document {

package/dist/oxygen/index.js

@@ -27,23 +27,13 @@ function appendServerTimingHeader(response, values) {
   }
 }
 
-// src/utils/warning.ts
-var warnings = /* @__PURE__ */ new Set();
-var warnOnce = (string) => {
-  if (!warnings.has(string)) {
-    console.warn(string);
-    warnings.add(string);
-  }
-};
-
 // src/createRequestHandler.ts
 function createRequestHandler({
   build,
   mode,
   poweredByHeader = true,
   getLoadContext,
-  collectTrackingInformation = true,
-  proxyStandardRoutes = true
+  collectTrackingInformation = true
 }) {
   const handleRequest = createReactRouterRequestHandler(build, mode);
   const appendPoweredByHeader = poweredByHeader ? (response) => response.headers.append("powered-by", "Shopify, Hydrogen") : void 0;
@@ -65,32 +55,28 @@ function createRequestHandler({
     }
     const context = await getLoadContext?.(request);
     const storefront = context?.storefront || context?.get?.(storefrontContext);
-    if (proxyStandardRoutes) {
-      if (!storefront) {
-        warnOnce(
-          "[h2:createRequestHandler] Storefront instance is required to proxy standard routes."
-        );
-      }
-      if (storefront?.isStorefrontApiUrl(request)) {
-        const response2 = await storefront.forward(request);
-        appendPoweredByHeader?.(response2);
-        return response2;
-      }
-      if (storefront?.isMcpUrl(request)) {
-        const response2 = await storefront.forwardMcp(request);
-        appendPoweredByHeader?.(response2);
-        return response2;
-      }
+    if (!storefront) {
+      throw new Error(
+        "[h2:createRequestHandler] Storefront instance is required in the load context. Make sure to use createHydrogenContext() or provide a storefront instance via getLoadContext."
+      );
+    }
+    if (storefront.isStorefrontApiUrl(request)) {
+      const response2 = await storefront.forward(request);
+      appendPoweredByHeader?.(response2);
+      return response2;
+    }
+    if (storefront.isMcpUrl(request)) {
+      const response2 = await storefront.forwardMcp(request);
+      appendPoweredByHeader?.(response2);
+      return response2;
     }
     const response = await handleRequest(request, context);
-    if (storefront && proxyStandardRoutes) {
-      if (collectTrackingInformation) {
-        storefront.setCollectedSubrequestHeaders(response);
-      }
-      const fetchDest = request.headers.get("sec-fetch-dest");
-      if (fetchDest && fetchDest === "document" || request.headers.get("accept")?.includes("text/html")) {
-        appendServerTimingHeader(response, { [HYDROGEN_SFAPI_PROXY_KEY]: "1" });
-      }
+    if (collectTrackingInformation) {
+      storefront.setCollectedSubrequestHeaders(response);
+    }
+    const fetchDest = request.headers.get("sec-fetch-dest");
+    if (fetchDest && fetchDest === "document" || request.headers.get("accept")?.includes("text/html")) {
+      appendServerTimingHeader(response, { [HYDROGEN_SFAPI_PROXY_KEY]: "1" });
     }
     appendPoweredByHeader?.(response);
     return response;