@shopify/hydrogen 2023.7.2 → 2023.7.3

package/dist/development/index.cjs

@@ -164,7 +164,9 @@ function CacheLong(overrideOptions) {
   return {
     mode: PUBLIC,
     maxAge: 3600,
+    // 1 hour
     staleWhileRevalidate: 82800,
+    // 23 Hours
     ...overrideOptions
   };
 }
@@ -218,7 +220,7 @@ async function setItem(cache, request, response, userCacheOptions) {
   );
   response.headers.set("cache-control", paddedCacheControlString);
   response.headers.set("real-cache-control", cacheControlString);
-  response.headers.set("cache-put-date", new Date().toUTCString());
+  response.headers.set("cache-put-date", (/* @__PURE__ */ new Date()).toUTCString());
   await cache.put(request, response);
 }
 async function deleteItem(cache, request) {
@@ -235,7 +237,7 @@ function calculateAge(response, responseDate) {
       responseMaxAge = parseFloat(maxAgeMatch[1]);
     }
   }
-  const ageInMs = new Date().valueOf() - new Date(responseDate).valueOf();
+  const ageInMs = (/* @__PURE__ */ new Date()).valueOf() - new Date(responseDate).valueOf();
   return [ageInMs / 1e3, responseMaxAge];
 }
 function isStale(request, response) {
@@ -321,6 +323,7 @@ async function runWithCache(cacheKey, actionFn, {
     return actionFn();
   }
   const key = hashKey([
+    // '__HYDROGEN_CACHE_ID__', // TODO purgeQueryCacheOnBuild
     ...typeof cacheKey === "string" ? [cacheKey] : cacheKey
   ]);
   const cachedItem = await getItemFromCache(cacheInstance, key);
@@ -419,7 +422,7 @@ var warnOnce = (string) => {
 };
 
 // src/version.ts
-var LIB_VERSION = "2023.7.2";
+var LIB_VERSION = "2023.7.3";
 
 // src/storefront.ts
 var StorefrontApiError = class extends Error {
@@ -537,6 +540,20 @@ function createStorefrontClient(options) {
   }
   return {
     storefront: {
+      /**
+       * Sends a GraphQL query to the Storefront API.
+       *
+       * Example:
+       *
+       * ```js
+       * async function loader ({context: {storefront}}) {
+       *   const data = await storefront.query('query { ... }', {
+       *     variables: {},
+       *     cache: storefront.CacheLong()
+       *   });
+       * }
+       * ```
+       */
       query: (query, payload) => {
         query = minifyQuery(query);
         if (isMutationRE.test(query)) {
@@ -546,6 +563,19 @@ function createStorefrontClient(options) {
         }
         return fetchStorefrontApi({ ...payload, query });
       },
+      /**
+       * Sends a GraphQL mutation to the Storefront API.
+       *
+       * Example:
+       *
+       * ```js
+       * async function loader ({context: {storefront}}) {
+       *   await storefront.mutate('mutation { ... }', {
+       *     variables: {},
+       *   });
+       * }
+       * ```
+       */
       mutate: (mutation, payload) => {
         mutation = minifyQuery(mutation);
         if (isQueryRE.test(mutation)) {
@@ -565,6 +595,25 @@ function createStorefrontClient(options) {
       getPrivateTokenHeaders,
       getShopifyDomain,
       getApiUrl: getStorefrontApiUrl,
+      /**
+       * Wether it's a GraphQL error returned in the Storefront API response.
+       *
+       * Example:
+       *
+       * ```js
+       * async function loader ({context: {storefront}}) {
+       *   try {
+       *     await storefront.query(...);
+       *   } catch(error) {
+       *     if (storefront.isApiError(error)) {
+       *       // ...
+       *     }
+       *
+       *     throw error;
+       *   }
+       * }
+       * ```
+       */
       isApiError: isStorefrontApiError,
       i18n: i18n ?? defaultI18n
     }
@@ -787,11 +836,11 @@ var graphiqlLoader = async function graphiqlLoader2({
     <script
       crossorigin
       src="https://unpkg.com/react@18/umd/react.development.js"
-    ><\/script>
+    ></script>
     <script
       crossorigin
       src="https://unpkg.com/react-dom@18/umd/react-dom.development.js"
-    ><\/script>
+    ></script>
     <link rel="stylesheet" href="https://unpkg.com/graphiql@3/graphiql.min.css" />
   </head>
 
@@ -800,7 +849,7 @@ var graphiqlLoader = async function graphiqlLoader2({
     <script
       src="https://unpkg.com/graphiql@3/graphiql.min.js"
       type="application/javascript"
-    ><\/script>
+    ></script>
     <script>
       const windowUrl = new URL(document.URL);
 
@@ -830,7 +879,7 @@ var graphiqlLoader = async function graphiqlLoader2({
           variables
         }),
       );
-    <\/script>
+    </script>
   </body>
 </html>
   `,
@@ -1013,6 +1062,7 @@ function generateSeoTags(seoInput) {
               type: "application/ld+json",
               children: JSON.stringify(block)
             },
+            // @ts-expect-error
             `json-ld-${block?.["@type"] || block?.name || index++}`
           );
           tagResults.push(tag);
@@ -1398,18 +1448,17 @@ function CartForm({
   route
 }) {
   const fetcher = react$1.useFetcher();
-  return /* @__PURE__ */ jsxRuntime.jsxs(fetcher.Form, {
-    action: route || "",
-    method: "post",
-    children: [
-      (action || inputs) && /* @__PURE__ */ jsxRuntime.jsx("input", {
+  return /* @__PURE__ */ jsxRuntime.jsxs(fetcher.Form, { action: route || "", method: "post", children: [
+    (action || inputs) && /* @__PURE__ */ jsxRuntime.jsx(
+      "input",
+      {
         type: "hidden",
         name: INPUT_NAME,
         value: JSON.stringify({ action, inputs })
-      }),
-      typeof children === "function" ? children(fetcher) : children
-    ]
-  });
+      }
+    ),
+    typeof children === "function" ? children(fetcher) : children
+  ] });
 }
 CartForm.INPUT_NAME = INPUT_NAME;
 CartForm.ACTIONS = {
@@ -2125,7 +2174,10 @@ function VariantSelector({
             )
           );
           const currentParam = searchParams.get(option.name);
-          const calculatedActiveValue = currentParam ? currentParam === value : false;
+          const calculatedActiveValue = currentParam ? (
+            // If a URL parameter exists for the current option, check if it equals the current value
+            currentParam === value
+          ) : false;
           if (calculatedActiveValue) {
             activeValue = value;
           }
@@ -2168,22 +2220,25 @@ function useVariantPath(handle) {
     const searchParams = new URLSearchParams(search);
     return {
       searchParams,
+      // If the current pathname matches the product page, we need to make sure
+      // that we append to the current search params. Otherwise all the search
+      // params can be generated new.
       alreadyOnProductPage: path === pathname,
       path
     };
   }, [pathname, search, handle]);
 }
-//! @see https://shopify.dev/docs/api/storefront/2023-07/mutations/cartMetafieldDelete
-//! @see https://shopify.dev/docs/api/storefront/latest/mutations/cartBuyerIdentityUpdate
-//! @see https://shopify.dev/docs/api/storefront/latest/mutations/cartDiscountCodesUpdate
-//! @see https://shopify.dev/docs/api/storefront/latest/mutations/cartMetafieldsSet
-//! @see https://shopify.dev/docs/api/storefront/latest/mutations/cartNoteUpdate
-//! @see https://shopify.dev/docs/api/storefront/latest/mutations/cartSelectedDeliveryOptionsUpdate
-//! @see https://shopify.dev/docs/api/storefront/latest/queries/cart
 //! @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
-//! @see: https://shopify.dev/docs/api/storefront/latest/mutations/cartLinesRemove
 //! @see: https://shopify.dev/docs/api/storefront/latest/mutations/cartLinesUpdate
+//! @see: https://shopify.dev/docs/api/storefront/latest/mutations/cartLinesRemove
+//! @see https://shopify.dev/docs/api/storefront/latest/mutations/cartDiscountCodesUpdate
+//! @see https://shopify.dev/docs/api/storefront/latest/mutations/cartBuyerIdentityUpdate
+//! @see https://shopify.dev/docs/api/storefront/latest/mutations/cartNoteUpdate
+//! @see https://shopify.dev/docs/api/storefront/latest/mutations/cartSelectedDeliveryOptionsUpdate
+//! @see https://shopify.dev/docs/api/storefront/latest/mutations/cartMetafieldsSet
+//! @see https://shopify.dev/docs/api/storefront/2023-07/mutations/cartMetafieldDelete
 
 Object.defineProperty(exports, 'AnalyticsEventName', {
   enumerable: true,