October 2024 release: Storefront API 2024-10

Welcome to Hydrogen's October 2024 release.

This release supports the latest Storefront API (2024-10) and contains quality-of-life tweaks, bug fixes and optimizations.

Cart updates (breaking)

The Storefront API now handles inventory errors about stock levels differently. We’ve updated Hydrogen to support these changes. See the upgrade guide in the release notes or watch the demo video.

Product option updates (breaking)

A new type ProductOptionValue has been added to the Storefront API. This field deprecates the existing values and provides richer option value information including swatches. See the upgrade guide in the release notes. 

Hydrogen supports worker compatibility date (breaking)

Starting from this major version, on each deploy to Oxygen, Hydrogen will be on Cloudflare worker compatibility date 2024-10-01. Onwards, Hydrogen will update worker compatibility date on every SFAPI release. There is no specific project update that you need to do in order to get this feature. However, please ensure your project is working properly in an Oxygen deployment when updating to this Hydrogen version. (#2380)

Shopify cookie banner no longer is the default skeleton set up (breaking)

If you are using Shopify’s cookie banner to handle user consent in your app, you will need to update your app to set withPrivacyBanner: true in your consent config. Without this update to your project, the Shopify cookie banner will not appear. See the upgrade guide in the release notes.

Update createWithCache (breaking)

We made breaking change updates to createWithCache. It was too easy for developers to make mistakes on caching undesired results on the original implementation. See the upgrade guide in the release notes.

Sitemaps (stable)

We’re excited to officially release the improved sitemaps APIs. See the upgrade guide in the release notes.

Decode product variant encoding functions

Introducing decodeEncodingVariant and isOptionValueCombinationInEncodedVariant utility functions for parsing product.encodedVariantExistence and product.encodedVariantAvailability fields. The two newly introduced product variant encodings are in support of 2k variants and combine listings. (#2425)

Route Warnings

Introducing route warnings. On project build, Shopify CLI will now warn you about certain reserved route paths that have been implemented in your project, but will be overridden because these routes are reserved by Oxygen. (#2613)

Updates, optimizations, and fixes

• Analytics fixes (#2538)
• Hydrogen supports worker compatibility date (#2380)
• Optimistic cart banner (#2502)
• Aside improvements (#2503)
• Use datalist for query suggestions (#2506)
• Remove unstable re-exports from remix-oxygen package (#2551)
• Update MiniOxygen to latest workerd version (#2567)
• <Image/> local asset fix (#2573)
• Update <ProductPrice> to remove deprecated code usage for priceV2 and compareAtPriceV2. Remove export for getCustomerprivacy (#2601)
• Remove deprecated --worker Shopify CLI flag (#2603)
• Allow generated codegen files to be placed anywhere in the directory (#2600)
• Add optional headers param for customer logout redirect (#2602)

Community contributions continue to flow in - a big thanks to @frontsideair, @weotch, @coryagami for their PRs this month!

To take advantage of all the latest features and improvements in Hydrogen, just run npx shopify hydrogen upgrade. That’s it for the October release — see you in December!