@shopify/hydrogen 2024.7.2 → 2024.7.4

package/dist/development/index.js

@@ -1,4 +1,4 @@
-import { createStorefrontClient as createStorefrontClient$1, SHOPIFY_STOREFRONT_ID_HEADER, getShopifyCookies, SHOPIFY_Y, SHOPIFY_STOREFRONT_Y_HEADER, SHOPIFY_S, SHOPIFY_STOREFRONT_S_HEADER, flattenConnection, ShopPayButton as ShopPayButton$1, useLoadScript, RichText as RichText$1, useShopifyCookies, sendShopifyAnalytics, AnalyticsEventName, AnalyticsPageType, parseGid, getClientBrowserParameters } from '@shopify/hydrogen-react';
+import { useLoadScript, createStorefrontClient as createStorefrontClient$1, SHOPIFY_STOREFRONT_ID_HEADER, getShopifyCookies, SHOPIFY_Y, SHOPIFY_STOREFRONT_Y_HEADER, SHOPIFY_S, SHOPIFY_STOREFRONT_S_HEADER, flattenConnection, ShopPayButton as ShopPayButton$1, RichText as RichText$1, useShopifyCookies, sendShopifyAnalytics, AnalyticsEventName, AnalyticsPageType, parseGid, getClientBrowserParameters } from '@shopify/hydrogen-react';
 export { AnalyticsEventName, AnalyticsPageType, ExternalVideo, IMAGE_FRAGMENT, Image, MediaFile, ModelViewer, Money, ShopifySalesChannel, Video, customerAccountApiCustomScalars, flattenConnection, getClientBrowserParameters, getShopifyCookies, parseGid, parseMetafield, sendShopifyAnalytics, storefrontApiCustomScalars, useLoadScript, useMoney, useShopifyCookies } from '@shopify/hydrogen-react';
 import { lazy, createContext, forwardRef, useMemo, createElement, Suspense, Fragment, useRef, useEffect, useState, useContext } from 'react';
 import { useMatches, useLocation, useNavigation, Link, useNavigate, useFetcher, useFetchers } from '@remix-run/react';
@@ -417,7 +417,7 @@ var errorOnce = (string) => {
 };
 
 // src/version.ts
-var LIB_VERSION = "2024.7.2";
+var LIB_VERSION = "2024.7.4";
 
 // src/utils/graphql.ts
 function minifyQuery(string) {
@@ -806,7 +806,10 @@ function formatAPIResult(data, errors2) {
 
 // src/utils/request.ts
 function getHeader(request, key) {
-  const value = request.headers?.get?.(key) ?? request.headers?.[key];
+  return getHeaderValue(request.headers, key);
+}
+function getHeaderValue(headers, key) {
+  const value = headers?.get?.(key) ?? headers?.[key];
   return typeof value === "string" ? value : null;
 }
 function getDebugHeaders(request) {
@@ -817,11 +820,8 @@ function getDebugHeaders(request) {
 }
 
 // src/cache/create-with-cache.ts
-function createWithCache({
-  cache,
-  waitUntil,
-  request
-}) {
+function createWithCache(cacheOptions) {
+  const { cache, waitUntil, request } = cacheOptions;
   return function withCache(cacheKey, strategy, actionFn) {
     return runWithCache(cacheKey, actionFn, {
       strategy,
@@ -1721,7 +1721,7 @@ function Seo({ debug }) {
   const matches = useMatches();
   const location = useLocation();
   console.warn(
-    "[h2:warn:Seo] The `<Seo/>` component is deprecated. Use `getSeoMeta` instead.\nSee: https://shopify.dev/docs/api/hydrogen/2024-01/utilities/getseometa"
+    "[h2:warn:Seo] The `<Seo/>` component is deprecated. Use `getSeoMeta` instead.\nSee: https://shopify.dev/docs/api/hydrogen/2024-07/utilities/getseometa"
   );
   const seoConfig = useMemo(() => {
     return matches.flatMap((match) => {
@@ -2480,6 +2480,11 @@ function createCustomerAccountClient({
       `[h2:warn:createCustomerAccountClient] You are using Customer Account API version ${customerApiVersion} when this version of Hydrogen was built for ${DEFAULT_CUSTOMER_API_VERSION}.`
     );
   }
+  if (!session) {
+    console.warn(
+      `[h2:warn:createCustomerAccountClient] session is required to use Customer Account API. Ensure the session object passed in exist.`
+    );
+  }
   if (!request?.url) {
     throw new Error(
       "[h2:error:createCustomerAccountClient] The request object does not contain a URL."
@@ -3475,7 +3480,7 @@ var CART_METAFIELD_DELETE_MUTATION = () => `#graphql
   }
 `;
 var cartGetIdDefault = (requestHeaders) => {
-  const cookies = parse(requestHeaders.get("Cookie") || "");
+  const cookies = parse(getHeaderValue(requestHeaders, "Cookie") || "");
   return () => {
     return cookies.cart ? `gid://shopify/Cart/${cookies.cart}` : void 0;
   };
@@ -3894,10 +3899,34 @@ function addCspDirective(currentValue, value) {
 }
 var Script = forwardRef(
   (props, ref) => {
+    const { waitForHydration, src, ...rest } = props;
+    if (waitForHydration) return /* @__PURE__ */ jsx(LazyScript, { src, options: rest });
     const nonce = useNonce();
-    return /* @__PURE__ */ jsx("script", { suppressHydrationWarning: true, ...props, nonce, ref });
+    return /* @__PURE__ */ jsx(
+      "script",
+      {
+        suppressHydrationWarning: true,
+        ...rest,
+        src,
+        nonce,
+        ref
+      }
+    );
   }
 );
+function LazyScript({
+  src,
+  options
+}) {
+  if (!src)
+    throw new Error(
+      "`waitForHydration` with the Script component requires a `src` prop"
+    );
+  useLoadScript(src, {
+    attributes: options
+  });
+  return null;
+}
 function useOptimisticData(identifier) {
   const fetchers = useFetchers();
   const data = {};
@@ -4111,6 +4140,7 @@ function ShopifyAnalytics({
   const { subscribe: subscribe2, register: register2, canTrack } = useAnalytics();
   const [shopifyReady, setShopifyReady] = useState(false);
   const [privacyReady, setPrivacyReady] = useState(false);
+  const init = useRef(false);
   const { ready: shopifyAnalyticsReady } = register2("Internal_Shopify_Analytics");
   const { ready: customerPrivacyReady } = register2(
     "Internal_Shopify_CustomerPrivacy"
@@ -4139,6 +4169,8 @@ function ShopifyAnalytics({
     checkoutDomain
   });
   useEffect(() => {
+    if (init.current) return;
+    init.current = true;
     subscribe2(AnalyticsEvent.PAGE_VIEWED, pageViewHandler);
     subscribe2(AnalyticsEvent.PRODUCT_VIEWED, productViewHandler);
     subscribe2(AnalyticsEvent.COLLECTION_VIEWED, collectionViewHandler);
@@ -4592,7 +4624,6 @@ function AnalyticsProvider({
   consent,
   customData = {},
   shop: shopProp = null,
-  disableThrowOnError = false,
   cookieDomain
 }) {
   const listenerSet = useRef(false);
@@ -4753,6 +4784,84 @@ var RichText = function(props) {
     }
   );
 };
+
+// src/createHydrogenContext.ts
+function createHydrogenContext(options) {
+  const {
+    env,
+    request,
+    cache,
+    waitUntil,
+    i18n,
+    session,
+    logErrors,
+    storefront: storefrontOptions = {},
+    customerAccount: customerAccountOptions,
+    cart: cartOptions = {}
+  } = options;
+  if (!session) {
+    console.warn(
+      `[h2:warn:createHydrogenContext] A session object is required to create hydrogen context.`
+    );
+  }
+  const { storefront } = createStorefrontClient({
+    // share options
+    cache,
+    waitUntil,
+    i18n,
+    logErrors,
+    // storefrontOptions
+    storefrontHeaders: storefrontOptions.headers || getStorefrontHeaders(request),
+    storefrontApiVersion: storefrontOptions.apiVersion,
+    // defaults
+    storefrontId: env.PUBLIC_STOREFRONT_ID,
+    storeDomain: env.PUBLIC_STORE_DOMAIN,
+    privateStorefrontToken: env.PRIVATE_STOREFRONT_API_TOKEN,
+    publicStorefrontToken: env.PUBLIC_STOREFRONT_API_TOKEN
+  });
+  const customerAccount = createCustomerAccountClient({
+    // share options
+    session,
+    request,
+    waitUntil,
+    logErrors,
+    // customerAccountOptions
+    customerApiVersion: customerAccountOptions?.apiVersion,
+    authUrl: customerAccountOptions?.authUrl,
+    customAuthStatusHandler: customerAccountOptions?.customAuthStatusHandler,
+    unstableB2b: customerAccountOptions?.unstableB2b,
+    // defaults
+    customerAccountId: env.PUBLIC_CUSTOMER_ACCOUNT_API_CLIENT_ID,
+    customerAccountUrl: env.PUBLIC_CUSTOMER_ACCOUNT_API_URL
+  });
+  const cart = createCartHandler({
+    // cartOptions
+    getCartId: cartOptions.getId || cartGetIdDefault(request.headers),
+    setCartId: cartOptions.setId || cartSetIdDefault(),
+    cartQueryFragment: cartOptions.queryFragment,
+    cartMutateFragment: cartOptions.mutateFragment,
+    customMethods: cartOptions.customMethods,
+    // defaults
+    storefront,
+    customerAccount
+  });
+  return {
+    storefront,
+    customerAccount,
+    cart,
+    env,
+    waitUntil,
+    session
+  };
+}
+function getStorefrontHeaders(request) {
+  return {
+    requestGroupId: getHeader(request, "request-id"),
+    buyerIp: getHeader(request, "oxygen-buyer-ip"),
+    cookie: getHeader(request, "cookie"),
+    purpose: getHeader(request, "purpose")
+  };
+}
 //! @see: https://shopify.dev/docs/api/storefront/latest/mutations/cartCreate
 //! @see https://shopify.dev/docs/api/storefront/latest/queries/cart
 //! @see: https://shopify.dev/docs/api/storefront/latest/mutations/cartLinesAdd
@@ -4765,6 +4874,6 @@ var RichText = function(props) {
 //! @see https://shopify.dev/docs/api/storefront/latest/mutations/cartMetafieldsSet
 //! @see https://shopify.dev/docs/api/storefront/2024-07/mutations/cartMetafieldDelete
 
-export { Analytics, AnalyticsEvent, CacheCustom, CacheLong, CacheNone, CacheShort, CartForm, InMemoryCache, OptimisticInput, Pagination, RichText, Script, Seo, ShopPayButton, VariantSelector, cartAttributesUpdateDefault, cartBuyerIdentityUpdateDefault, cartCreateDefault, cartDiscountCodesUpdateDefault, cartGetDefault, cartGetIdDefault, cartLinesAddDefault, cartLinesRemoveDefault, cartLinesUpdateDefault, cartMetafieldDeleteDefault, cartMetafieldsSetDefault, cartNoteUpdateDefault, cartSelectedDeliveryOptionsUpdateDefault, cartSetIdDefault, changelogHandler, createCartHandler, createContentSecurityPolicy, createCustomerAccountClient, createStorefrontClient, createWithCache, formatAPIResult, generateCacheControlHeader, getCustomerPrivacy, getPaginationVariables, getSelectedProductOptions, getSeoMeta, getShopAnalytics, graphiqlLoader, storefrontRedirect, useAnalytics, useCustomerPrivacy, useNonce, useOptimisticCart, useOptimisticData, useOptimisticVariant };
+export { Analytics, AnalyticsEvent, CacheCustom, CacheLong, CacheNone, CacheShort, CartForm, InMemoryCache, OptimisticInput, Pagination, RichText, Script, Seo, ShopPayButton, VariantSelector, cartAttributesUpdateDefault, cartBuyerIdentityUpdateDefault, cartCreateDefault, cartDiscountCodesUpdateDefault, cartGetDefault, cartGetIdDefault, cartLinesAddDefault, cartLinesRemoveDefault, cartLinesUpdateDefault, cartMetafieldDeleteDefault, cartMetafieldsSetDefault, cartNoteUpdateDefault, cartSelectedDeliveryOptionsUpdateDefault, cartSetIdDefault, changelogHandler, createCartHandler, createContentSecurityPolicy, createCustomerAccountClient, createHydrogenContext, createStorefrontClient, createWithCache, formatAPIResult, generateCacheControlHeader, getCustomerPrivacy, getPaginationVariables, getSelectedProductOptions, getSeoMeta, getShopAnalytics, graphiqlLoader, storefrontRedirect, useAnalytics, useCustomerPrivacy, useNonce, useOptimisticCart, useOptimisticData, useOptimisticVariant };
 //# sourceMappingURL=out.js.map
 //# sourceMappingURL=index.js.map