@shopify/hydrogen 1.5.0 → 1.6.1

package/dist/esnext/components/CartProvider/CartProvider.client.d.ts

@@ -1,18 +1,10 @@
 import React from 'react';
-import { CartBuyerIdentityInput, CountryCode } from '../../storefront-api-types.js';
 import { CartFragmentFragment } from './graphql/CartFragment.js';
-/**
- * The `CartProvider` component creates a context for using a cart. It creates a cart object and callbacks
- * that can be accessed by any descendent component using the `useCart` hook and related hooks. It also carries out
- * any callback props when a relevant action is performed. For example, if a `onLineAdd` callback is provided,
- * then the callback will be called when a new line item is successfully added to the cart.
- *
- * The `CartProvider` component must be a descendent of the `ShopifyProvider` component.
- * You must use this component if you want to use the `useCart` hook or related hooks, or if you would like to use the `AddToCartButton` component.
- */
-export declare function CartProvider({ children, numCartLines, onCreate, onLineAdd, onLineRemove, onLineUpdate, onNoteUpdate, onBuyerIdentityUpdate, onAttributesUpdate, onDiscountCodesUpdate, data: cart, cartFragment, customerAccessToken, countryCode, }: {
+import { CartBuyerIdentityInput, CountryCode } from '../../storefront-api-types.js';
+export declare function CartProvider({ children, numCartLines, onCreate, onLineAdd, onLineRemove, onLineUpdate, onNoteUpdate, onBuyerIdentityUpdate, onAttributesUpdate, onDiscountCodesUpdate, onCreateComplete, onLineAddComplete, onLineRemoveComplete, onLineUpdateComplete, onNoteUpdateComplete, onBuyerIdentityUpdateComplete, onAttributesUpdateComplete, onDiscountCodesUpdateComplete, data: cart, cartFragment, customerAccessToken, countryCode, }: {
     /** Any `ReactNode` elements. */
     children: React.ReactNode;
+    /**  Maximum number of cart lines to fetch. Defaults to 250 cart lines. */
     numCartLines?: number;
     /** A callback that is invoked when the process to create a cart begins, but before the cart is created in the Storefront API. */
     onCreate?: () => void;
@@ -30,6 +22,22 @@ export declare function CartProvider({ children, numCartLines, onCreate, onLineA
     onAttributesUpdate?: () => void;
     /** A callback that is invoked when the process to update the cart discount codes begins, but before the discount codes are updated in the Storefront API. */
     onDiscountCodesUpdate?: () => void;
+    /** A callback that is invoked when the process to create a cart completes successfully */
+    onCreateComplete?: () => void;
+    /** A callback that is invoked when the process to add a line item to the cart completes successfully */
+    onLineAddComplete?: () => void;
+    /** A callback that is invoked when the process to remove a line item to the cart completes successfully */
+    onLineRemoveComplete?: () => void;
+    /** A callback that is invoked when the process to update a line item in the cart completes successfully */
+    onLineUpdateComplete?: () => void;
+    /** A callback that is invoked when the process to add or update a note in the cart completes successfully */
+    onNoteUpdateComplete?: () => void;
+    /** A callback that is invoked when the process to update the buyer identity completes successfully */
+    onBuyerIdentityUpdateComplete?: () => void;
+    /** A callback that is invoked when the process to update the cart attributes completes successfully */
+    onAttributesUpdateComplete?: () => void;
+    /** A callback that is invoked when the process to update the cart discount codes completes successfully */
+    onDiscountCodesUpdateComplete?: () => void;
     /** An object with fields that correspond to the Storefront API's [Cart object](https://shopify.dev/api/storefront/latest/objects/cart). */
     data?: CartFragmentFragment;
     /** 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. */
@@ -39,3 +47,4 @@ export declare function CartProvider({ children, numCartLines, onCreate, onLineA
     /** The ISO country code for i18n. */
     countryCode?: CountryCode;
 }): JSX.Element;
+export declare const defaultCartFragment = "\nfragment CartFragment on Cart {\n  id\n  checkoutUrl\n  totalQuantity\n  buyerIdentity {\n    countryCode\n    customer {\n      id\n      email\n      firstName\n      lastName\n      displayName\n    }\n    email\n    phone\n  }\n  lines(first: $numCartLines) {\n    edges {\n      node {\n        id\n        quantity\n        attributes {\n          key\n          value\n        }\n        cost {\n          totalAmount {\n            amount\n            currencyCode\n          }\n          compareAtAmountPerQuantity {\n            amount\n            currencyCode\n          }\n        }\n        merchandise {\n          ... on ProductVariant {\n            id\n            availableForSale\n            compareAtPriceV2 {\n              ...MoneyFragment\n            }\n            priceV2 {\n              ...MoneyFragment\n            }\n            requiresShipping\n            title\n            image {\n              ...ImageFragment\n            }\n            product {\n              handle\n              title\n            }\n            selectedOptions {\n              name\n              value\n            }\n          }\n        }\n      }\n    }\n  }\n  cost {\n    subtotalAmount {\n      ...MoneyFragment\n    }\n    totalAmount {\n      ...MoneyFragment\n    }\n    totalDutyAmount {\n      ...MoneyFragment\n    }\n    totalTaxAmount {\n      ...MoneyFragment\n    }\n  }\n  note\n  attributes {\n    key\n    value\n  }\n  discountCodes {\n    code\n  }\n}\n\nfragment MoneyFragment on MoneyV2 {\n  currencyCode\n  amount\n}\nfragment ImageFragment on Image {\n  id\n  url\n  altText\n  width\n  height\n}\n";