@shopify/hydrogen 1.3.2 → 1.4.1

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

@@ -0,0 +1,62 @@
+import { AttributeInput, CartBuyerIdentityInput, CartInput, CartLineInput, CartLineUpdateInput, CountryCode } from '../../storefront-api-types.js';
+import { CartAttributesUpdateMutation } from './graphql/CartAttributesUpdateMutation.js';
+import { CartBuyerIdentityUpdateMutation } from './graphql/CartBuyerIdentityUpdateMutation.js';
+import { CartCreateMutation } from './graphql/CartCreateMutation.js';
+import { CartDiscountCodesUpdateMutation, CartDiscountCodesUpdateMutationVariables } from './graphql/CartDiscountCodesUpdateMutation.js';
+import { CartLineAddMutation } from './graphql/CartLineAddMutation.js';
+import { CartLineRemoveMutation } from './graphql/CartLineRemoveMutation.js';
+import { CartLineUpdateMutation } from './graphql/CartLineUpdateMutation.js';
+import { CartNoteUpdateMutation, CartNoteUpdateMutationVariables } from './graphql/CartNoteUpdateMutation.js';
+import { CartQueryQuery } from './graphql/CartQuery.js';
+/**
+ * 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<{
+        data: CartQueryQuery | undefined;
+        errors: any;
+    }>;
+    cartCreate: (cart: CartInput) => Promise<{
+        data: CartCreateMutation | undefined;
+        errors: any;
+    }>;
+    cartLineAdd: (cartId: string, lines: CartLineInput[]) => Promise<{
+        data: CartLineAddMutation | undefined;
+        errors: any;
+    }>;
+    cartLineUpdate: (cartId: string, lines: CartLineUpdateInput[]) => Promise<{
+        data: CartLineUpdateMutation | undefined;
+        errors: any;
+    }>;
+    cartLineRemove: (cartId: string, lines: string[]) => Promise<{
+        data: CartLineRemoveMutation | undefined;
+        errors: any;
+    }>;
+    noteUpdate: (cartId: string, note: CartNoteUpdateMutationVariables['note']) => Promise<{
+        data: CartNoteUpdateMutation | undefined;
+        errors: any;
+    }>;
+    buyerIdentityUpdate: (cartId: string, buyerIdentity: CartBuyerIdentityInput) => Promise<{
+        data: CartBuyerIdentityUpdateMutation | undefined;
+        errors: any;
+    }>;
+    cartAttributesUpdate: (cartId: string, attributes: AttributeInput[]) => Promise<{
+        data: CartAttributesUpdateMutation | undefined;
+        errors: any;
+    }>;
+    discountCodesUpdate: (cartId: string, discountCodes: CartDiscountCodesUpdateMutationVariables['discountCodes']) => Promise<{
+        data: CartDiscountCodesUpdateMutation | undefined;
+        errors: any;
+    }>;
+    cartFragment: string;
+};
+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";

package/dist/esnext/components/CartProvider/CartActions.client.js

@@ -0,0 +1,232 @@
+import { useCallback, useMemo } from 'react';
+import { CountryCode, } from '../../storefront-api-types.js';
+import { CartAttributesUpdate, CartBuyerIdentityUpdate, CartCreate, CartDiscountCodesUpdate, CartLineAdd, CartLineRemove, CartLineUpdate, CartNoteUpdate, CartQuery, } from './cart-queries.js';
+import { useCartFetch } from './hooks.client.js';
+/**
+ * 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 function useCartActions({ numCartLines, cartFragment = defaultCartFragment, countryCode = CountryCode.Us, }) {
+    const fetchCart = useCartFetch();
+    const cartFetch = useCallback((cartId) => {
+        return fetchCart({
+            query: CartQuery(cartFragment),
+            variables: {
+                id: cartId,
+                numCartLines,
+                country: countryCode,
+            },
+        });
+    }, [fetchCart, cartFragment, numCartLines, countryCode]);
+    const cartCreate = useCallback((cart) => {
+        return fetchCart({
+            query: CartCreate(cartFragment),
+            variables: {
+                input: cart,
+                numCartLines,
+                country: countryCode,
+            },
+        });
+    }, [cartFragment, countryCode, fetchCart, numCartLines]);
+    const cartLineAdd = useCallback((cartId, lines) => {
+        return fetchCart({
+            query: CartLineAdd(cartFragment),
+            variables: {
+                cartId,
+                lines,
+                numCartLines,
+                country: countryCode,
+            },
+        });
+    }, [cartFragment, countryCode, fetchCart, numCartLines]);
+    const cartLineUpdate = useCallback((cartId, lines) => {
+        return fetchCart({
+            query: CartLineUpdate(cartFragment),
+            variables: {
+                cartId,
+                lines,
+                numCartLines,
+                country: countryCode,
+            },
+        });
+    }, [cartFragment, countryCode, fetchCart, numCartLines]);
+    const cartLineRemove = useCallback((cartId, lines) => {
+        return fetchCart({
+            query: CartLineRemove(cartFragment),
+            variables: {
+                cartId,
+                lines,
+                numCartLines,
+                country: countryCode,
+            },
+        });
+    }, [cartFragment, countryCode, fetchCart, numCartLines]);
+    const noteUpdate = useCallback((cartId, note) => {
+        return fetchCart({
+            query: CartNoteUpdate(cartFragment),
+            variables: {
+                cartId,
+                note,
+                numCartLines,
+                country: countryCode,
+            },
+        });
+    }, [fetchCart, cartFragment, numCartLines, countryCode]);
+    const buyerIdentityUpdate = useCallback((cartId, buyerIdentity) => {
+        return fetchCart({
+            query: CartBuyerIdentityUpdate(cartFragment),
+            variables: {
+                cartId,
+                buyerIdentity,
+                numCartLines,
+                country: countryCode,
+            },
+        });
+    }, [cartFragment, countryCode, fetchCart, numCartLines]);
+    const cartAttributesUpdate = useCallback((cartId, attributes) => {
+        return fetchCart({
+            query: CartAttributesUpdate(cartFragment),
+            variables: {
+                cartId,
+                attributes,
+                numCartLines,
+                country: countryCode,
+            },
+        });
+    }, [cartFragment, countryCode, fetchCart, numCartLines]);
+    const discountCodesUpdate = useCallback((cartId, discountCodes) => {
+        return fetchCart({
+            query: CartDiscountCodesUpdate(cartFragment),
+            variables: {
+                cartId,
+                discountCodes,
+                numCartLines,
+                country: countryCode,
+            },
+        });
+    }, [cartFragment, countryCode, fetchCart, numCartLines]);
+    return useMemo(() => ({
+        cartFetch,
+        cartCreate,
+        cartLineAdd,
+        cartLineUpdate,
+        cartLineRemove,
+        noteUpdate,
+        buyerIdentityUpdate,
+        cartAttributesUpdate,
+        discountCodesUpdate,
+        cartFragment,
+    }), [
+        cartFetch,
+        cartCreate,
+        cartLineAdd,
+        cartLineUpdate,
+        cartLineRemove,
+        noteUpdate,
+        buyerIdentityUpdate,
+        cartAttributesUpdate,
+        discountCodesUpdate,
+        cartFragment,
+    ]);
+}
+export const defaultCartFragment = `
+fragment CartFragment on Cart {
+  id
+  checkoutUrl
+  totalQuantity
+  buyerIdentity {
+    countryCode
+    customer {
+      id
+      email
+      firstName
+      lastName
+      displayName
+    }
+    email
+    phone
+  }
+  lines(first: $numCartLines) {
+    edges {
+      node {
+        id
+        quantity
+        attributes {
+          key
+          value
+        }
+        cost {
+          totalAmount {
+            amount
+            currencyCode
+          }
+          compareAtAmountPerQuantity {
+            amount
+            currencyCode
+          }
+        }
+        merchandise {
+          ... on ProductVariant {
+            id
+            availableForSale
+            compareAtPriceV2 {
+              ...MoneyFragment
+            }
+            priceV2 {
+              ...MoneyFragment
+            }
+            requiresShipping
+            title
+            image {
+              ...ImageFragment
+            }
+            product {
+              handle
+              title
+            }
+            selectedOptions {
+              name
+              value
+            }
+          }
+        }
+      }
+    }
+  }
+  cost {
+    subtotalAmount {
+      ...MoneyFragment
+    }
+    totalAmount {
+      ...MoneyFragment
+    }
+    totalDutyAmount {
+      ...MoneyFragment
+    }
+    totalTaxAmount {
+      ...MoneyFragment
+    }
+  }
+  note
+  attributes {
+    key
+    value
+  }
+  discountCodes {
+    code
+  }
+}
+
+fragment MoneyFragment on MoneyV2 {
+  currencyCode
+  amount
+}
+fragment ImageFragment on Image {
+  id
+  url
+  altText
+  width
+  height
+}
+`;

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

@@ -0,0 +1,49 @@
+import React from 'react';
+import { CartFragmentFragment } from './graphql/CartFragment.js';
+import { CartBuyerIdentityInput, CountryCode } from '../../storefront-api-types.js';
+export declare function CartProviderV2({ children, numCartLines, onCreate, onLineAdd, onLineRemove, onLineUpdate, onNoteUpdate, onBuyerIdentityUpdate, onAttributesUpdate, onDiscountCodesUpdate, onCreateComplete, onLineAddComplete, onLineRemoveComplete, onLineUpdateComplete, onNoteUpdateComplete, onBuyerIdentityUpdateComplete, onAttributesUpdateComplete, onDiscountCodesUpdateComplete, data, 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;
+    /** A callback that is invoked when the process to add a line item to the cart begins, but before the line item is added to the Storefront API. */
+    onLineAdd?: () => void;
+    /** A callback that is invoked when the process to remove a line item to the cart begins, but before the line item is removed from the Storefront API. */
+    onLineRemove?: () => void;
+    /** A callback that is invoked when the process to update a line item in the cart begins, but before the line item is updated in the Storefront API. */
+    onLineUpdate?: () => void;
+    /** A callback that is invoked when the process to add or update a note in the cart begins, but before the note is added or updated in the Storefront API. */
+    onNoteUpdate?: () => void;
+    /** A callback that is invoked when the process to update the buyer identity begins, but before the buyer identity is updated in the Storefront API. */
+    onBuyerIdentityUpdate?: () => void;
+    /** A callback that is invoked when the process to update the cart attributes begins, but before the attributes are updated in the Storefront API. */
+    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 */
+    onCreateComplete?: () => void;
+    /** A callback that is invoked when the process to add a line item to the cart completes */
+    onLineAddComplete?: () => void;
+    /** A callback that is invoked when the process to remove a line item to the cart completes */
+    onLineRemoveComplete?: () => void;
+    /** A callback that is invoked when the process to update a line item in the cart completes */
+    onLineUpdateComplete?: () => void;
+    /** A callback that is invoked when the process to add or update a note in the cart completes */
+    onNoteUpdateComplete?: () => void;
+    /** A callback that is invoked when the process to update the buyer identity completes */
+    onBuyerIdentityUpdateComplete?: () => void;
+    /** A callback that is invoked when the process to update the cart attributes completes */
+    onAttributesUpdateComplete?: () => void;
+    /** A callback that is invoked when the process to update the cart discount codes completes */
+    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. */
+    cartFragment?: string;
+    /** A customer access token that's accessible on the server if there's a customer login. */
+    customerAccessToken?: CartBuyerIdentityInput['customerAccessToken'];
+    /** The ISO country code for i18n. */
+    countryCode?: CountryCode;
+}): JSX.Element;