@shopify/hydrogen 0.23.0 → 0.24.0

package/dist/esnext/foundation/ServerRequestProvider/ServerRequestProvider.js

@@ -9,14 +9,20 @@ function requestCacheRSC() {
     return new Map();
 }
 requestCacheRSC.key = Symbol.for('HYDROGEN_REQUEST');
+function getInternalReactDispatcher() {
+    // @ts-ignore
+    return React.__SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED
+        .ReactCurrentDispatcher.current;
+}
+function isRsc() {
+    // This method is only available during RSC
+    return __HYDROGEN_TEST__ || !!getInternalReactDispatcher().getCacheForType;
+}
 // Note: use this only during RSC/Flight rendering. The React dispatcher
 // for SSR/Fizz rendering does not implement getCacheForType.
 function getCacheForType(resource) {
     var _a;
-    const dispatcher = 
-    // @ts-ignore
-    React.__SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED
-        .ReactCurrentDispatcher.current;
+    const dispatcher = getInternalReactDispatcher();
     // @ts-ignore
     if (__HYDROGEN_TEST__ && !dispatcher.getCacheForType) {
         // Jest does not have access to the RSC runtime, mock it here:
@@ -25,8 +31,8 @@ function getCacheForType(resource) {
     }
     return dispatcher.getCacheForType(resource);
 }
-export function ServerRequestProvider({ isRSC, request, children, }) {
-    if (isRSC) {
+export function ServerRequestProvider({ request, children, }) {
+    if (isRsc()) {
         // Save the request object in a React cache that is
         // scoped to this current rendering.
         const requestCache = getCacheForType(requestCacheRSC);
@@ -38,20 +44,11 @@ export function ServerRequestProvider({ isRSC, request, children, }) {
     return (React.createElement(RequestContextSSR.Provider, { value: request }, children));
 }
 export function useServerRequest() {
-    let request;
-    try {
-        // This cache only works during RSC rendering:
-        // @ts-ignore
-        const cache = getCacheForType(requestCacheRSC);
-        request = cache ? cache.get(requestCacheRSC.key) : null;
-    }
-    catch (_a) {
-        // If RSC cache failed it means this is not an RSC request.
-        // Try getting SSR context instead:
-        request = useContext(RequestContextSSR); // eslint-disable-line react-hooks/rules-of-hooks
-    }
+    var _a;
+    const request = isRsc()
+        ? (_a = getCacheForType(requestCacheRSC)) === null || _a === void 0 ? void 0 : _a.get(requestCacheRSC.key)
+        : useContext(RequestContextSSR); // eslint-disable-line react-hooks/rules-of-hooks
     if (!request) {
-        // @ts-ignore
         if (__HYDROGEN_TEST__) {
             // Unit tests are not wrapped in ServerRequestProvider.
             // This mocks it, instead of providing it in every test.

package/dist/esnext/foundation/useQuery/hooks.d.ts

@@ -34,3 +34,4 @@ queryOptions?: HydrogenUseQueryOptions): {
     data: T;
     error?: undefined;
 };
+export declare function shouldPreloadQuery(queryOptions?: HydrogenUseQueryOptions): boolean;

package/dist/esnext/foundation/useQuery/hooks.js

@@ -1,7 +1,7 @@
 import { getLoggerWithContext, collectQueryCacheControlHeaders, collectQueryTimings, } from '../../utilities/log';
 import { deleteItemFromCache, generateSubRequestCacheControlHeader, getItemFromCache, isStale, setItemInCache, } from '../Cache/cache-sub-request';
 import { useRequestCacheData, useServerRequest } from '../ServerRequestProvider';
-import { CacheSeconds } from '../Cache/strategies';
+import { CacheSeconds, NO_STORE } from '../Cache/strategies';
 /**
  * The `useQuery` hook executes an asynchronous operation like `fetch` in a way that
  * supports [Suspense](https://reactjs.org/docs/concurrent-mode-suspense.html). You can use this
@@ -24,7 +24,7 @@ queryOptions) {
     ];
     const fetcher = cachedQueryFnBuilder(withCacheIdKey, queryFn, queryOptions);
     collectQueryTimings(request, withCacheIdKey, 'requested');
-    if (queryOptions === null || queryOptions === void 0 ? void 0 : queryOptions.preload) {
+    if (shouldPreloadQuery(queryOptions)) {
         request.savePreloadQuery({
             preload: queryOptions === null || queryOptions === void 0 ? void 0 : queryOptions.preload,
             key: withCacheIdKey,
@@ -33,6 +33,20 @@ queryOptions) {
     }
     return useRequestCacheData(withCacheIdKey, fetcher);
 }
+export function shouldPreloadQuery(queryOptions) {
+    var _a, _b;
+    if (!queryOptions)
+        return true;
+    const hasCacheOverride = typeof ((_a = queryOptions === null || queryOptions === void 0 ? void 0 : queryOptions.cache) === null || _a === void 0 ? void 0 : _a.mode) !== 'undefined';
+    const hasPreloadOverride = typeof (queryOptions === null || queryOptions === void 0 ? void 0 : queryOptions.preload) !== 'undefined';
+    const cacheValue = (_b = queryOptions === null || queryOptions === void 0 ? void 0 : queryOptions.cache) === null || _b === void 0 ? void 0 : _b.mode;
+    const preloadValue = queryOptions === null || queryOptions === void 0 ? void 0 : queryOptions.preload;
+    // If preload is explicitly defined, then it takes precedence
+    if (hasPreloadOverride) {
+        return !!preloadValue;
+    }
+    return hasCacheOverride ? cacheValue !== NO_STORE : true;
+}
 function cachedQueryFnBuilder(key, queryFn, queryOptions) {
     var _a;
     const resolvedQueryOptions = {

package/dist/esnext/foundation/useRequestContext/index.d.ts

@@ -0,0 +1,15 @@
+declare type ScopedContext = Record<string, any>;
+/**
+ * Provides access to the current request context.
+ * @param scope - An optional string used to scope the request context. It is recommended to
+ * prevent modifying the properties added by other plugins.
+ * @returns A request-scoped object that can be modified to provide and consume information
+ * across different React components in the tree.
+ * @example
+ * ```js
+ * import {useRequestContext} from '@shopify/hydrogen';
+ * useRequestContext('my-plugin-name');
+ * ```
+ */
+export declare function useRequestContext<T extends ScopedContext>(scope?: string): T;
+export {};

package/dist/esnext/foundation/useRequestContext/index.js

@@ -0,0 +1,23 @@
+import { META_ENV_SSR, useEnvContext } from '../ssr-interop';
+/**
+ * Provides access to the current request context.
+ * @param scope - An optional string used to scope the request context. It is recommended to
+ * prevent modifying the properties added by other plugins.
+ * @returns A request-scoped object that can be modified to provide and consume information
+ * across different React components in the tree.
+ * @example
+ * ```js
+ * import {useRequestContext} from '@shopify/hydrogen';
+ * useRequestContext('my-plugin-name');
+ * ```
+ */
+export function useRequestContext(scope = 'default') {
+    if (__HYDROGEN_DEV__ && !META_ENV_SSR) {
+        throw new Error('useRequestContext can only be used in the server');
+    }
+    const scopes = useEnvContext((req) => req.ctx.scopes);
+    if (!scopes.has(scope)) {
+        scopes.set(scope, Object.create(null));
+    }
+    return scopes.get(scope);
+}

package/dist/esnext/hooks/useCartLine/useCartLine.d.ts

@@ -7,15 +7,25 @@ export declare function useCartLine(): {
     attributes: ({
         __typename?: "Attribute" | undefined;
     } & Pick<import("../../storefront-api-types").Attribute, "key" | "value">)[];
+    estimatedCost: {
+        __typename?: "CartLineEstimatedCost" | undefined;
+    } & {
+        totalAmount: {
+            __typename?: "MoneyV2" | undefined;
+        } & Pick<import("../../storefront-api-types").MoneyV2, "amount" | "currencyCode">;
+        compareAtAmount?: import("../../storefront-api-types").Maybe<{
+            __typename?: "MoneyV2" | undefined;
+        } & Pick<import("../../storefront-api-types").MoneyV2, "amount" | "currencyCode">> | undefined;
+    };
     merchandise: {
         __typename?: "ProductVariant" | undefined;
     } & Pick<import("../../storefront-api-types").ProductVariant, "id" | "title" | "availableForSale" | "requiresShipping"> & {
         compareAtPriceV2?: import("../../storefront-api-types").Maybe<{
             __typename?: "MoneyV2" | undefined;
-        } & Pick<import("../../storefront-api-types").MoneyV2, "currencyCode" | "amount">> | undefined;
+        } & Pick<import("../../storefront-api-types").MoneyV2, "amount" | "currencyCode">> | undefined;
         priceV2: {
             __typename?: "MoneyV2" | undefined;
-        } & Pick<import("../../storefront-api-types").MoneyV2, "currencyCode" | "amount">;
+        } & Pick<import("../../storefront-api-types").MoneyV2, "amount" | "currencyCode">;
         image?: import("../../storefront-api-types").Maybe<{
             __typename?: "Image" | undefined;
         } & Pick<import("../../storefront-api-types").Image, "id" | "height" | "width" | "url" | "altText">> | undefined;

package/dist/esnext/hooks/useProductOptions/types.d.ts

@@ -3,7 +3,7 @@ import type { PartialDeep } from 'type-fest';
 export declare type SelectedOptions = {
     [key: string]: string;
 };
-export declare type SelectVariantCallback = (variant: ProductVariantType) => void;
+export declare type SelectVariantCallback = (variant: ProductVariantType | null) => void;
 export declare type SelectOptionCallback = (name: SelectedOptionType['name'], value: SelectedOptionType['value']) => void;
 export declare type SelectOptionsCallback = (options: SelectedOptions) => void;
 export declare type OptionsInStockCallback = (name: SelectedOptionType['name'], value: SelectedOptionType['value']) => boolean;

package/dist/esnext/index.d.ts

@@ -20,6 +20,7 @@ export { log, type Logger } from './utilities/log';
 export { LocalizationProvider } from './components/LocalizationProvider/LocalizationProvider.server';
 export { ShopifyProvider } from './foundation/ShopifyProvider/ShopifyProvider.server';
 export { generateCacheControlHeader, NoStore, CacheSeconds, CacheMinutes, CacheHours, CacheDays, CacheWeeks, CacheMonths, CacheCustom, } from './foundation/Cache/strategies';
+export { useRequestContext } from './foundation/useRequestContext';
 export { useServerAnalytics } from './foundation/Analytics/hook';
 export { ShopifyAnalytics } from './foundation/Analytics/connectors/Shopify/ShopifyAnalytics.server';
 export { ShopifyAnalyticsConstants } from './foundation/Analytics/connectors/Shopify/const';
@@ -38,3 +39,5 @@ export { CartQuery } from './components/CartProvider/cart-queries';
  * Override the client version of `fetchSync` with the server version.
  */
 export { fetchSync } from './foundation/fetchSync/server/fetchSync';
+export { type HydrogenRequest } from './foundation/HydrogenRequest/HydrogenRequest.server';
+export { type HydrogenResponse } from './foundation/HydrogenResponse/HydrogenResponse.server';

package/dist/esnext/index.js

@@ -20,6 +20,7 @@ export { log } from './utilities/log';
 export { LocalizationProvider } from './components/LocalizationProvider/LocalizationProvider.server';
 export { ShopifyProvider } from './foundation/ShopifyProvider/ShopifyProvider.server';
 export { generateCacheControlHeader, NoStore, CacheSeconds, CacheMinutes, CacheHours, CacheDays, CacheWeeks, CacheMonths, CacheCustom, } from './foundation/Cache/strategies';
+export { useRequestContext } from './foundation/useRequestContext';
 export { useServerAnalytics } from './foundation/Analytics/hook';
 export { ShopifyAnalytics } from './foundation/Analytics/connectors/Shopify/ShopifyAnalytics.server';
 export { ShopifyAnalyticsConstants } from './foundation/Analytics/connectors/Shopify/const';