@shopify/hydrogen-react 0.0.0-next-7fb60a6 → 0.0.0-next-819c4bf

package/dist/types/index.d.ts

@@ -1,3 +1,6 @@
+export { useCartFetch, useInstantCheckout } from './cart-hooks.js';
+export type { CartState, CartStatus, Cart, CartWithActions, CartAction, } from './cart-types.js';
+export { CartProvider, useCart } from './CartProvider.js';
 export { ExternalVideo } from './ExternalVideo.js';
 export { flattenConnection } from './flatten-connection.js';
 export { Image } from './Image.js';

package/dist/types/useCartAPIStateMachine.d.ts

@@ -0,0 +1,25 @@
+import { StateMachine } from '@xstate/fsm';
+import { Cart, CartMachineActionEvent, CartMachineContext, CartMachineEvent, CartMachineFetchResultEvent, CartMachineTypeState } from './cart-types.js';
+import { CountryCode, Cart as CartType } from './storefront-api-types.js';
+import type { PartialDeep } from 'type-fest';
+export declare function useCartAPIStateMachine({ numCartLines, onCartActionEntry, onCartActionOptimisticUI, onCartActionComplete, data: cart, cartFragment, countryCode, }: {
+    /**  Maximum number of cart lines to fetch. Defaults to 250 cart lines. */
+    numCartLines?: number;
+    /** A callback that is invoked just before a Cart API action executes. */
+    onCartActionEntry?: (context: CartMachineContext, event: CartMachineActionEvent) => void;
+    /** A callback that is invoked after executing the entry actions for optimistic UI changes.  */
+    onCartActionOptimisticUI?: (context: CartMachineContext, event: CartMachineEvent) => Partial<CartMachineContext>;
+    /** A callback that is invoked after a Cart API completes. */
+    onCartActionComplete?: (context: CartMachineContext, event: CartMachineFetchResultEvent) => void;
+    /** An object with fields that correspond to the Storefront API's [Cart object](https://shopify.dev/api/storefront/latest/objects/cart). */
+    data?: PartialDeep<CartType, {
+        recurseIntoArrays: true;
+    }>;
+    /** A fragment used to query the Storefront API's [Cart object](https://shopify.dev/api/storefront/latest/objects/cart) for all queries and mutations. A default value is used if no argument is provided. */
+    cartFragment: string;
+    /** The ISO country code for i18n. */
+    countryCode?: CountryCode;
+}): readonly [StateMachine.State<CartMachineContext, CartMachineEvent, CartMachineTypeState>, (event: "CART_FETCH" | "CART_CREATE" | "CART_SET" | "CARTLINE_ADD" | "CARTLINE_REMOVE" | "CARTLINE_UPDATE" | "NOTE_UPDATE" | "BUYER_IDENTITY_UPDATE" | "CART_ATTRIBUTES_UPDATE" | "DISCOUNT_CODES_UPDATE" | "CART_COMPLETED" | "RESOLVE" | "ERROR" | CartMachineEvent) => void, StateMachine.Service<CartMachineContext, CartMachineEvent, CartMachineTypeState>];
+export declare function cartFromGraphQL(cart: PartialDeep<CartType, {
+    recurseIntoArrays: true;
+}>): Cart;

package/dist/types/useCartActions.d.ts

@@ -0,0 +1,64 @@
+import { AttributeInput, CartBuyerIdentityInput, CartInput, CartLineInput, CartLineUpdateInput, CountryCode, Cart as CartType, MutationCartDiscountCodesUpdateArgs, MutationCartNoteUpdateArgs } from './storefront-api-types.js';
+import { PartialDeep } from 'type-fest';
+declare type CartResponse = PartialDeep<CartType, {
+    recurseIntoArrays: true;
+}>;
+/**
+ * The `useCartActions` hook returns helper graphql functions for Storefront Cart API
+ *
+ * See [cart API graphql mutations](https://shopify.dev/api/storefront/2022-07/objects/Cart)
+ */
+export declare function useCartActions({ numCartLines, cartFragment, countryCode, }: {
+    /**  Maximum number of cart lines to fetch. Defaults to 250 cart lines. */
+    numCartLines?: number;
+    /** A fragment used to query the Storefront API's [Cart object](https://shopify.dev/api/storefront/latest/objects/cart) for all queries and mutations. A default value is used if no argument is provided. */
+    cartFragment: string;
+    /** The ISO country code for i18n. */
+    countryCode?: CountryCode;
+}): {
+    cartFetch: (cartId: string) => Promise<import("./storefront-api-response.types.js").StorefrontApiResponseOkPartial<{
+        cart: CartResponse;
+    }>>;
+    cartCreate: (cart: CartInput) => Promise<import("./storefront-api-response.types.js").StorefrontApiResponseOkPartial<{
+        cartCreate: {
+            cart: CartResponse;
+        };
+    }>>;
+    cartLineAdd: (cartId: string, lines: CartLineInput[]) => Promise<import("./storefront-api-response.types.js").StorefrontApiResponseOkPartial<{
+        cartLinesAdd: {
+            cart: CartResponse;
+        };
+    }>>;
+    cartLineUpdate: (cartId: string, lines: CartLineUpdateInput[]) => Promise<import("./storefront-api-response.types.js").StorefrontApiResponseOkPartial<{
+        cartLinesUpdate: {
+            cart: CartResponse;
+        };
+    }>>;
+    cartLineRemove: (cartId: string, lines: string[]) => Promise<import("./storefront-api-response.types.js").StorefrontApiResponseOkPartial<{
+        cartLinesRemove: {
+            cart: CartResponse;
+        };
+    }>>;
+    noteUpdate: (cartId: string, note: MutationCartNoteUpdateArgs['note']) => Promise<import("./storefront-api-response.types.js").StorefrontApiResponseOkPartial<{
+        cartNoteUpdate: {
+            cart: CartResponse;
+        };
+    }>>;
+    buyerIdentityUpdate: (cartId: string, buyerIdentity: CartBuyerIdentityInput) => Promise<import("./storefront-api-response.types.js").StorefrontApiResponseOkPartial<{
+        cartBuyerIdentityUpdate: {
+            cart: CartResponse;
+        };
+    }>>;
+    cartAttributesUpdate: (cartId: string, attributes: AttributeInput[]) => Promise<import("./storefront-api-response.types.js").StorefrontApiResponseOkPartial<{
+        cartAttributesUpdate: {
+            cart: CartResponse;
+        };
+    }>>;
+    discountCodesUpdate: (cartId: string, discountCodes: MutationCartDiscountCodesUpdateArgs['discountCodes']) => Promise<import("./storefront-api-response.types.js").StorefrontApiResponseOkPartial<{
+        cartDiscountCodesUpdate: {
+            cart: CartResponse;
+        };
+    }>>;
+    cartFragment: string;
+};
+export {};