@shopify/hydrogen 2024.4.1 → 2024.4.2

package/dist/production/index.d.cts

@@ -1,6 +1,6 @@
 import { createStorefrontClient as createStorefrontClient$1, StorefrontClientProps, ShopPayButton as ShopPayButton$1 } from '@shopify/hydrogen-react';
 export { AnalyticsEventName, AnalyticsPageType, ClientBrowserParameters, ExternalVideo, IMAGE_FRAGMENT, Image, MediaFile, ModelViewer, Money, ParsedMetafields, ShopifyAnalytics as SendShopifyAnalyticsEvent, ShopifyAddToCart, ShopifyAddToCartPayload, ShopifyAnalyticsPayload, ShopifyAnalyticsProduct, ShopifyCookies, ShopifyPageView, ShopifyPageViewPayload, ShopifySalesChannel, StorefrontApiResponse, StorefrontApiResponseError, StorefrontApiResponseOk, StorefrontApiResponseOkPartial, StorefrontApiResponsePartial, Video, customerAccountApiCustomScalars, flattenConnection, getClientBrowserParameters, getShopifyCookies, parseGid, parseMetafield, sendShopifyAnalytics, storefrontApiCustomScalars, useLoadScript, useMoney, useShopifyCookies } from '@shopify/hydrogen-react';
-import { LanguageCode, CountryCode, Maybe, PageInfo, CartMetafieldsSetInput, Cart, Scalars, CartUserError, MetafieldsSetUserError, MetafieldDeleteUserError, AttributeInput, CartBuyerIdentityInput, CartInput, CartLineInput, CartLineUpdateInput, CartSelectedDeliveryOptionInput, ProductOption, ProductVariantConnection, ProductVariant, SelectedOptionInput, CartLine, ComponentizableCartLine, Product, CurrencyCode } from '@shopify/hydrogen-react/storefront-api-types';
+import { LanguageCode, CountryCode, Maybe, PageInfo, BuyerInput, CartMetafieldsSetInput, Cart, Scalars, CartUserError, MetafieldsSetUserError, MetafieldDeleteUserError, AttributeInput, CartBuyerIdentityInput, CartInput, CartLineInput, CartLineUpdateInput, CartSelectedDeliveryOptionInput, ProductOption, ProductVariantConnection, ProductVariant, SelectedOptionInput, CartLine, ComponentizableCartLine, Product, CurrencyCode } from '@shopify/hydrogen-react/storefront-api-types';
 import { ExecutionArgs } from 'graphql';
 import { LoaderFunctionArgs, LoaderFunction, SerializeFrom, SessionData, FlashSessionData, Session, SessionStorage } from '@remix-run/server-runtime';
 import * as react from 'react';
@@ -238,14 +238,7 @@ Useful in type utilities, such as checking if something does not occur.
 
 @example
 ```
-import type {IsNever} from 'type-fest';
-
-type And<A, B> =
-	A extends true
-		? B extends true
-			? true
-			: false
-		: false;
+import type {IsNever, And} from 'type-fest';
 
 // https://github.com/andnp/SimplyTyped/blob/master/src/types/strings.ts
 type AreStringsEqual<A extends string, B extends string> =
@@ -1039,8 +1032,10 @@ type RequestEventPayload = {
     displayName?: string;
 };
 
+declare const CUSTOMER_ACCOUNT_SESSION_KEY = "customerAccount";
+
 interface HydrogenSessionData {
-  customerAccount: {
+  [CUSTOMER_ACCOUNT_SESSION_KEY]: {
     accessToken?: string;
     expiresAt?: string;
     refreshToken?: string;
@@ -1050,6 +1045,8 @@ interface HydrogenSessionData {
     state?: string;
     redirectPath?: string;
   };
+  // for B2B buyer context
+  [BUYER_SESSION_KEY]: Partial<BuyerInput>;
 }
 
 interface HydrogenSession<
@@ -1090,6 +1087,7 @@ declare global {
 
 type DataFunctionValue = Response | NonNullable<unknown> | null;
 type JsonGraphQLError = ReturnType<GraphQLError['toJSON']>;
+type Buyer = Partial<BuyerInput>;
 type CustomerAPIResponse<ReturnType> = {
     data: ReturnType;
     errors: Array<{
@@ -1159,6 +1157,10 @@ type CustomerAccount = {
     mutate: <OverrideReturnType extends any = never, RawGqlString extends string = string>(mutation: RawGqlString, ...options: ClientVariablesInRestParams<CustomerAccountMutations, RawGqlString>) => Promise<Omit<CustomerAPIResponse<ClientReturn<CustomerAccountMutations, RawGqlString, OverrideReturnType>>, 'errors'> & {
         errors?: JsonGraphQLError[];
     }>;
+    /** UNSTABLE feature. Set buyer information into session.*/
+    UNSTABLE_setBuyer: (buyer: Buyer) => void;
+    /** UNSTABLE feature. Get buyer token and company location id from session.*/
+    UNSTABLE_getBuyer: () => Promise<Buyer>;
 };
 type CustomerAccountOptions = {
     /** The client requires a session to persist the auth and refresh token. By default Hydrogen ships with cookie session storage, but you can use [another session storage](https://remix.run/docs/en/main/utils/sessions) implementation.  */
@@ -1179,9 +1181,11 @@ type CustomerAccountOptions = {
     customAuthStatusHandler?: () => DataFunctionValue;
     /** Whether it should print GraphQL errors automatically. Defaults to true */
     logErrors?: boolean | ((error?: Error) => boolean);
+    /** UNSTABLE feature, this will eventually goes away. If true then we will exchange customerAccessToken for storefrontCustomerAccessToken. */
+    unstableB2b?: boolean;
 };
 
-declare function createCustomerAccountClient({ session, customerAccountId, customerAccountUrl, customerApiVersion, request, waitUntil, authUrl, customAuthStatusHandler, logErrors, }: CustomerAccountOptions): CustomerAccount;
+declare function createCustomerAccountClient({ session, customerAccountId, customerAccountUrl, customerApiVersion, request, waitUntil, authUrl, customAuthStatusHandler, logErrors, unstableB2b, }: CustomerAccountOptions): CustomerAccount;
 
 /**
  * A custom Remix loader handler that fetches the changelog.json from GitHub.
@@ -1223,6 +1227,10 @@ type CartQueryOptions = {
      * The cart fragment to override the one used in this query.
      */
     cartFragment?: string;
+    /**
+     * The customer account instance created by [`createCustomerAccount`](docs/api/hydrogen/latest/customer/createcustomeraccount).
+     */
+    customerAccount?: CustomerAccount;
 };
 type CartReturn = Cart & {
     errors?: StorefrontApiErrors;
@@ -1555,6 +1563,26 @@ declare function VariantSelector({ handle, options, variants: _variants, product
     children?: ReactNode;
 }>;
 type GetSelectedProductOptions = (request: Request) => SelectedOptionInput[];
+/**
+ * Extract searchParams from a Request instance and return an array of selected options.
+ * @param request - The Request instance to extract searchParams from.
+ * @returns An array of selected options.
+ * @example Basic usage:
+ * ```tsx
+ *
+ * import {getSelectedProductOptions} from '@shopify/hydrogen';
+ *
+ * // Given a request url of `/products/product-handle?color=red&size=large`
+ *
+ * const selectedOptions = getSelectedProductOptions(request);
+ *
+ * // selectedOptions will equal:
+ * // [
+ * //   {name: 'color', value: 'red'},
+ * //   {name: 'size', value: 'large'}
+ * // ]
+ * ```
+ **/
 declare const getSelectedProductOptions: GetSelectedProductOptions;
 
 declare const useNonce: () => string | undefined;
@@ -1787,7 +1815,7 @@ type SetConsentHeadlessParams = VisitorConsent & CustomerPrivacyConsentConfig &
 **/
 type CustomerPrivacy$1 = {
     currentVisitorConsent: () => VisitorConsent;
-    userCanBeTracked: () => boolean;
+    preferencesProcessingAllowed: () => boolean;
     saleOfDataAllowed: () => boolean;
     marketingAllowed: () => boolean;
     analyticsProcessingAllowed: () => boolean;
@@ -1809,6 +1837,8 @@ type CustomerPrivacyApiProps = {
     withPrivacyBanner?: boolean;
     /** Callback to be called when visitor consent is collected. */
     onVisitorConsentCollected?: (consent: VisitorConsentCollected) => void;
+    /** Callback to be call when customer privacy api is ready. */
+    onReady?: () => void;
 };
 declare function useCustomerPrivacy(props: CustomerPrivacyApiProps): void;
 declare function getCustomerPrivacy(): any;
@@ -1828,7 +1858,7 @@ type AnalyticsProviderProps = {
     children?: ReactNode;
     /** The cart or cart promise to track for cart analytics. When there is a difference between the state of the cart, `AnalyticsProvider` will trigger a `cart_updated` event. It will also produce `product_added_to_cart` and `product_removed_from_cart` based on cart line quantity and cart line id changes. */
     cart: Promise<CartReturn | null> | CartReturn | null;
-    /** An optional function to set wether the user can be tracked. Defaults to Customer Privacy API's `window.Shopify.customerPrivacy.userCanBeTracked()`. */
+    /** An optional function to set wether the user can be tracked. Defaults to Customer Privacy API's `window.Shopify.customerPrivacy.analyticsProcessingAllowed()`. */
     canTrack?: () => boolean;
     /** An optional custom payload to pass to all events. e.g language/locale/currency. */
     customData?: Record<string, unknown>;
@@ -1836,9 +1866,11 @@ type AnalyticsProviderProps = {
     shop: Promise<ShopAnalytics | null> | ShopAnalytics | null;
     /** The customer privacy consent configuration and options. */
     consent: CustomerPrivacyApiProps;
+    /** Disable throwing errors when required props are missing. */
+    disableThrowOnError?: boolean;
 };
 type AnalyticsContextValue = {
-    /** A function to tell you the current state of if the user can be tracked by analytics. Defaults to Customer Privacy API's `window.Shopify.customerPrivacy.userCanBeTracked()`. */
+    /** A function to tell you the current state of if the user can be tracked by analytics. Defaults to Customer Privacy API's `window.Shopify.customerPrivacy.analyticsProcessingAllowed()`. */
     canTrack: NonNullable<AnalyticsProviderProps['canTrack']>;
     /** The current cart state. */
     cart: Awaited<AnalyticsProviderProps['cart']>;
@@ -1874,7 +1906,7 @@ declare function publish(event: typeof AnalyticsEvent.CART_UPDATED, payload: Car
 declare function publish(event: typeof AnalyticsEvent.PRODUCT_ADD_TO_CART, payload: CartLineUpdatePayload): void;
 declare function publish(event: typeof AnalyticsEvent.PRODUCT_REMOVED_FROM_CART, payload: CartLineUpdatePayload): void;
 declare function publish(event: typeof AnalyticsEvent.CUSTOM_EVENT, payload: OtherData): void;
-declare function AnalyticsProvider({ canTrack: customCanTrack, cart: currentCart, children, consent, customData, shop: shopProp, }: AnalyticsProviderProps): JSX.Element;
+declare function AnalyticsProvider({ canTrack: customCanTrack, cart: currentCart, children, consent, customData, shop: shopProp, disableThrowOnError, }: AnalyticsProviderProps): JSX.Element;
 declare function useAnalytics(): AnalyticsContextValue;
 type ShopAnalyticsProps = {
     /**

package/dist/production/index.d.ts

@@ -1,6 +1,6 @@
 import { createStorefrontClient as createStorefrontClient$1, StorefrontClientProps, ShopPayButton as ShopPayButton$1 } from '@shopify/hydrogen-react';
 export { AnalyticsEventName, AnalyticsPageType, ClientBrowserParameters, ExternalVideo, IMAGE_FRAGMENT, Image, MediaFile, ModelViewer, Money, ParsedMetafields, ShopifyAnalytics as SendShopifyAnalyticsEvent, ShopifyAddToCart, ShopifyAddToCartPayload, ShopifyAnalyticsPayload, ShopifyAnalyticsProduct, ShopifyCookies, ShopifyPageView, ShopifyPageViewPayload, ShopifySalesChannel, StorefrontApiResponse, StorefrontApiResponseError, StorefrontApiResponseOk, StorefrontApiResponseOkPartial, StorefrontApiResponsePartial, Video, customerAccountApiCustomScalars, flattenConnection, getClientBrowserParameters, getShopifyCookies, parseGid, parseMetafield, sendShopifyAnalytics, storefrontApiCustomScalars, useLoadScript, useMoney, useShopifyCookies } from '@shopify/hydrogen-react';
-import { LanguageCode, CountryCode, Maybe, PageInfo, CartMetafieldsSetInput, Cart, Scalars, CartUserError, MetafieldsSetUserError, MetafieldDeleteUserError, AttributeInput, CartBuyerIdentityInput, CartInput, CartLineInput, CartLineUpdateInput, CartSelectedDeliveryOptionInput, ProductOption, ProductVariantConnection, ProductVariant, SelectedOptionInput, CartLine, ComponentizableCartLine, Product, CurrencyCode } from '@shopify/hydrogen-react/storefront-api-types';
+import { LanguageCode, CountryCode, Maybe, PageInfo, BuyerInput, CartMetafieldsSetInput, Cart, Scalars, CartUserError, MetafieldsSetUserError, MetafieldDeleteUserError, AttributeInput, CartBuyerIdentityInput, CartInput, CartLineInput, CartLineUpdateInput, CartSelectedDeliveryOptionInput, ProductOption, ProductVariantConnection, ProductVariant, SelectedOptionInput, CartLine, ComponentizableCartLine, Product, CurrencyCode } from '@shopify/hydrogen-react/storefront-api-types';
 import { ExecutionArgs } from 'graphql';
 import { LoaderFunctionArgs, LoaderFunction, SerializeFrom, SessionData, FlashSessionData, Session, SessionStorage } from '@remix-run/server-runtime';
 import * as react from 'react';
@@ -238,14 +238,7 @@ Useful in type utilities, such as checking if something does not occur.
 
 @example
 ```
-import type {IsNever} from 'type-fest';
-
-type And<A, B> =
-	A extends true
-		? B extends true
-			? true
-			: false
-		: false;
+import type {IsNever, And} from 'type-fest';
 
 // https://github.com/andnp/SimplyTyped/blob/master/src/types/strings.ts
 type AreStringsEqual<A extends string, B extends string> =
@@ -1039,8 +1032,10 @@ type RequestEventPayload = {
     displayName?: string;
 };
 
+declare const CUSTOMER_ACCOUNT_SESSION_KEY = "customerAccount";
+
 interface HydrogenSessionData {
-  customerAccount: {
+  [CUSTOMER_ACCOUNT_SESSION_KEY]: {
     accessToken?: string;
     expiresAt?: string;
     refreshToken?: string;
@@ -1050,6 +1045,8 @@ interface HydrogenSessionData {
     state?: string;
     redirectPath?: string;
   };
+  // for B2B buyer context
+  [BUYER_SESSION_KEY]: Partial<BuyerInput>;
 }
 
 interface HydrogenSession<
@@ -1090,6 +1087,7 @@ declare global {
 
 type DataFunctionValue = Response | NonNullable<unknown> | null;
 type JsonGraphQLError = ReturnType<GraphQLError['toJSON']>;
+type Buyer = Partial<BuyerInput>;
 type CustomerAPIResponse<ReturnType> = {
     data: ReturnType;
     errors: Array<{
@@ -1159,6 +1157,10 @@ type CustomerAccount = {
     mutate: <OverrideReturnType extends any = never, RawGqlString extends string = string>(mutation: RawGqlString, ...options: ClientVariablesInRestParams<CustomerAccountMutations, RawGqlString>) => Promise<Omit<CustomerAPIResponse<ClientReturn<CustomerAccountMutations, RawGqlString, OverrideReturnType>>, 'errors'> & {
         errors?: JsonGraphQLError[];
     }>;
+    /** UNSTABLE feature. Set buyer information into session.*/
+    UNSTABLE_setBuyer: (buyer: Buyer) => void;
+    /** UNSTABLE feature. Get buyer token and company location id from session.*/
+    UNSTABLE_getBuyer: () => Promise<Buyer>;
 };
 type CustomerAccountOptions = {
     /** The client requires a session to persist the auth and refresh token. By default Hydrogen ships with cookie session storage, but you can use [another session storage](https://remix.run/docs/en/main/utils/sessions) implementation.  */
@@ -1179,9 +1181,11 @@ type CustomerAccountOptions = {
     customAuthStatusHandler?: () => DataFunctionValue;
     /** Whether it should print GraphQL errors automatically. Defaults to true */
     logErrors?: boolean | ((error?: Error) => boolean);
+    /** UNSTABLE feature, this will eventually goes away. If true then we will exchange customerAccessToken for storefrontCustomerAccessToken. */
+    unstableB2b?: boolean;
 };
 
-declare function createCustomerAccountClient({ session, customerAccountId, customerAccountUrl, customerApiVersion, request, waitUntil, authUrl, customAuthStatusHandler, logErrors, }: CustomerAccountOptions): CustomerAccount;
+declare function createCustomerAccountClient({ session, customerAccountId, customerAccountUrl, customerApiVersion, request, waitUntil, authUrl, customAuthStatusHandler, logErrors, unstableB2b, }: CustomerAccountOptions): CustomerAccount;
 
 /**
  * A custom Remix loader handler that fetches the changelog.json from GitHub.
@@ -1223,6 +1227,10 @@ type CartQueryOptions = {
      * The cart fragment to override the one used in this query.
      */
     cartFragment?: string;
+    /**
+     * The customer account instance created by [`createCustomerAccount`](docs/api/hydrogen/latest/customer/createcustomeraccount).
+     */
+    customerAccount?: CustomerAccount;
 };
 type CartReturn = Cart & {
     errors?: StorefrontApiErrors;
@@ -1555,6 +1563,26 @@ declare function VariantSelector({ handle, options, variants: _variants, product
     children?: ReactNode;
 }>;
 type GetSelectedProductOptions = (request: Request) => SelectedOptionInput[];
+/**
+ * Extract searchParams from a Request instance and return an array of selected options.
+ * @param request - The Request instance to extract searchParams from.
+ * @returns An array of selected options.
+ * @example Basic usage:
+ * ```tsx
+ *
+ * import {getSelectedProductOptions} from '@shopify/hydrogen';
+ *
+ * // Given a request url of `/products/product-handle?color=red&size=large`
+ *
+ * const selectedOptions = getSelectedProductOptions(request);
+ *
+ * // selectedOptions will equal:
+ * // [
+ * //   {name: 'color', value: 'red'},
+ * //   {name: 'size', value: 'large'}
+ * // ]
+ * ```
+ **/
 declare const getSelectedProductOptions: GetSelectedProductOptions;
 
 declare const useNonce: () => string | undefined;
@@ -1787,7 +1815,7 @@ type SetConsentHeadlessParams = VisitorConsent & CustomerPrivacyConsentConfig &
 **/
 type CustomerPrivacy$1 = {
     currentVisitorConsent: () => VisitorConsent;
-    userCanBeTracked: () => boolean;
+    preferencesProcessingAllowed: () => boolean;
     saleOfDataAllowed: () => boolean;
     marketingAllowed: () => boolean;
     analyticsProcessingAllowed: () => boolean;
@@ -1809,6 +1837,8 @@ type CustomerPrivacyApiProps = {
     withPrivacyBanner?: boolean;
     /** Callback to be called when visitor consent is collected. */
     onVisitorConsentCollected?: (consent: VisitorConsentCollected) => void;
+    /** Callback to be call when customer privacy api is ready. */
+    onReady?: () => void;
 };
 declare function useCustomerPrivacy(props: CustomerPrivacyApiProps): void;
 declare function getCustomerPrivacy(): any;
@@ -1828,7 +1858,7 @@ type AnalyticsProviderProps = {
     children?: ReactNode;
     /** The cart or cart promise to track for cart analytics. When there is a difference between the state of the cart, `AnalyticsProvider` will trigger a `cart_updated` event. It will also produce `product_added_to_cart` and `product_removed_from_cart` based on cart line quantity and cart line id changes. */
     cart: Promise<CartReturn | null> | CartReturn | null;
-    /** An optional function to set wether the user can be tracked. Defaults to Customer Privacy API's `window.Shopify.customerPrivacy.userCanBeTracked()`. */
+    /** An optional function to set wether the user can be tracked. Defaults to Customer Privacy API's `window.Shopify.customerPrivacy.analyticsProcessingAllowed()`. */
     canTrack?: () => boolean;
     /** An optional custom payload to pass to all events. e.g language/locale/currency. */
     customData?: Record<string, unknown>;
@@ -1836,9 +1866,11 @@ type AnalyticsProviderProps = {
     shop: Promise<ShopAnalytics | null> | ShopAnalytics | null;
     /** The customer privacy consent configuration and options. */
     consent: CustomerPrivacyApiProps;
+    /** Disable throwing errors when required props are missing. */
+    disableThrowOnError?: boolean;
 };
 type AnalyticsContextValue = {
-    /** A function to tell you the current state of if the user can be tracked by analytics. Defaults to Customer Privacy API's `window.Shopify.customerPrivacy.userCanBeTracked()`. */
+    /** A function to tell you the current state of if the user can be tracked by analytics. Defaults to Customer Privacy API's `window.Shopify.customerPrivacy.analyticsProcessingAllowed()`. */
     canTrack: NonNullable<AnalyticsProviderProps['canTrack']>;
     /** The current cart state. */
     cart: Awaited<AnalyticsProviderProps['cart']>;
@@ -1874,7 +1906,7 @@ declare function publish(event: typeof AnalyticsEvent.CART_UPDATED, payload: Car
 declare function publish(event: typeof AnalyticsEvent.PRODUCT_ADD_TO_CART, payload: CartLineUpdatePayload): void;
 declare function publish(event: typeof AnalyticsEvent.PRODUCT_REMOVED_FROM_CART, payload: CartLineUpdatePayload): void;
 declare function publish(event: typeof AnalyticsEvent.CUSTOM_EVENT, payload: OtherData): void;
-declare function AnalyticsProvider({ canTrack: customCanTrack, cart: currentCart, children, consent, customData, shop: shopProp, }: AnalyticsProviderProps): JSX.Element;
+declare function AnalyticsProvider({ canTrack: customCanTrack, cart: currentCart, children, consent, customData, shop: shopProp, disableThrowOnError, }: AnalyticsProviderProps): JSX.Element;
 declare function useAnalytics(): AnalyticsContextValue;
 type ShopAnalyticsProps = {
     /**