Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SFAPI 2024-10 cart update #2572

Merged
merged 9 commits into from
Oct 21, 2024
Merged

SFAPI 2024-10 cart update #2572

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
887452b
SFAPI 2024-10 update
wizardlyhel Sep 27, 2024
e230e99
fix test
wizardlyhel Sep 27, 2024
3adbc76
add changeset
wizardlyhel Sep 27, 2024
93a4849
Update cart mutation to query for cart warnings
wizardlyhel Sep 27, 2024
df20d6d
remove accidental changes
wizardlyhel Sep 27, 2024
2efbaac
lint
wizardlyhel Sep 27, 2024
2f8830c
Update changeset
wizardlyhel Oct 10, 2024
537b108
Return warnings in the cart handler route
juanpprieto Oct 18, 2024
50c1758
Merge branch 'main' into hl-2024-10-cart-update
wizardlyhel Oct 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/wicked-schools-reflect.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
'@shopify/hydrogen': patch
---

Update all cart mutation methods from `createCartHandler` to return cart warnings.

As of API version 2024-10, inventory errors about stock levels will no longer be included in the `userErrors` of cart mutations. Inventory errors will now be available in a new return field `warnings` and will contain explicit code values of `MERCHANDISE_NOT_ENOUGH_STOCK`` or MERCHANDISE_OUT_OF_STOCK`. Reference: https://shopify.dev/changelog/cart-warnings-in-storefront-api-cart
8 changes: 8 additions & 0 deletions packages/hydrogen/src/cart/queries/cart-fragments.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,11 @@ export const MINIMAL_CART_FRAGMENT = `#graphql
checkoutUrl
}
`;

export const CART_WARNING_FRAGMENT = `#graphql
fragment CartApiWarning on CartWarning {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TIL

code
message
target
}
`;
2 changes: 2 additions & 0 deletions packages/hydrogen/src/cart/queries/cart-types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import type {
CartUserError,
MetafieldsSetUserError,
MetafieldDeleteUserError,
CartWarning,
} from '@shopify/hydrogen-react/storefront-api-types';
import type {StorefrontApiErrors, Storefront} from '../../storefront';
import {CustomerAccount} from '../../customer/types';
Expand Down Expand Up @@ -60,6 +61,7 @@ export type CartQueryData = {
| CartUserError[]
| MetafieldsSetUserError[]
| MetafieldDeleteUserError[];
warnings?: CartWarning[];
};

export type CartQueryDataReturn = CartQueryData & {
Expand Down
10 changes: 9 additions & 1 deletion packages/hydrogen/src/cart/queries/cartAttributesUpdateDefault.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import {StorefrontApiErrors, formatAPIResult} from '../../storefront';
import {MINIMAL_CART_FRAGMENT, USER_ERROR_FRAGMENT} from './cart-fragments';
import {
CART_WARNING_FRAGMENT,
MINIMAL_CART_FRAGMENT,
USER_ERROR_FRAGMENT,
} from './cart-fragments';
import type {
CartOptionalInput,
CartQueryData,
Expand Down Expand Up @@ -44,8 +48,12 @@ export const CART_ATTRIBUTES_UPDATE_MUTATION = (
userErrors {
...CartApiError
}
warnings {
...CartApiWarning
}
}
}
${cartFragment}
${USER_ERROR_FRAGMENT}
${CART_WARNING_FRAGMENT}
`;
10 changes: 9 additions & 1 deletion packages/hydrogen/src/cart/queries/cartBuyerIdentityUpdateDefault.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import {StorefrontApiErrors, formatAPIResult} from '../../storefront';
import {MINIMAL_CART_FRAGMENT, USER_ERROR_FRAGMENT} from './cart-fragments';
import {
CART_WARNING_FRAGMENT,
MINIMAL_CART_FRAGMENT,
USER_ERROR_FRAGMENT,
} from './cart-fragments';
import type {
CartOptionalInput,
CartQueryData,
Expand Down Expand Up @@ -61,8 +65,12 @@ export const CART_BUYER_IDENTITY_UPDATE_MUTATION = (
userErrors {
...CartApiError
}
warnings {
...CartApiWarning
}
}
}
${cartFragment}
${USER_ERROR_FRAGMENT}
${CART_WARNING_FRAGMENT}
`;
10 changes: 9 additions & 1 deletion packages/hydrogen/src/cart/queries/cartCreateDefault.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import {StorefrontApiErrors, formatAPIResult} from '../../storefront';
import {MINIMAL_CART_FRAGMENT, USER_ERROR_FRAGMENT} from './cart-fragments';
import {
CART_WARNING_FRAGMENT,
MINIMAL_CART_FRAGMENT,
USER_ERROR_FRAGMENT,
} from './cart-fragments';
import type {
CartQueryData,
CartQueryOptions,
Expand Down Expand Up @@ -58,8 +62,12 @@ export const CART_CREATE_MUTATION = (
userErrors {
...CartApiError
}
warnings {
...CartApiWarning
}
}
}
${cartFragment}
${USER_ERROR_FRAGMENT}
${CART_WARNING_FRAGMENT}
`;
10 changes: 9 additions & 1 deletion packages/hydrogen/src/cart/queries/cartDiscountCodesUpdateDefault.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import {StorefrontApiErrors, formatAPIResult} from '../../storefront';
import {MINIMAL_CART_FRAGMENT, USER_ERROR_FRAGMENT} from './cart-fragments';
import {
CART_WARNING_FRAGMENT,
MINIMAL_CART_FRAGMENT,
USER_ERROR_FRAGMENT,
} from './cart-fragments';
import type {
CartOptionalInput,
CartQueryData,
Expand Down Expand Up @@ -52,8 +56,12 @@ export const CART_DISCOUNT_CODE_UPDATE_MUTATION = (
userErrors {
...CartApiError
}
warnings {
...CartApiWarning
}
}
}
${cartFragment}
${USER_ERROR_FRAGMENT}
${CART_WARNING_FRAGMENT}
`;
10 changes: 9 additions & 1 deletion packages/hydrogen/src/cart/queries/cartGiftCardCodeUpdateDefault.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import {StorefrontApiErrors, formatAPIResult} from '../../storefront';
import {MINIMAL_CART_FRAGMENT, USER_ERROR_FRAGMENT} from './cart-fragments';
import {
CART_WARNING_FRAGMENT,
MINIMAL_CART_FRAGMENT,
USER_ERROR_FRAGMENT,
} from './cart-fragments';
import type {
CartOptionalInput,
CartQueryData,
Expand Down Expand Up @@ -52,8 +56,12 @@ export const CART_GIFT_CARD_CODE_UPDATE_MUTATION = (
userErrors {
...CartApiError
}
warnings {
...CartApiWarning
}
}
}
${cartFragment}
${USER_ERROR_FRAGMENT}
${CART_WARNING_FRAGMENT}
`;
11 changes: 9 additions & 2 deletions packages/hydrogen/src/cart/queries/cartLinesAddDefault.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
import type {CartLineInput} from '@shopify/hydrogen-react/storefront-api-types';
import {StorefrontApiErrors, formatAPIResult} from '../../storefront';
import {MINIMAL_CART_FRAGMENT, USER_ERROR_FRAGMENT} from './cart-fragments';
import {
CART_WARNING_FRAGMENT,
MINIMAL_CART_FRAGMENT,
USER_ERROR_FRAGMENT,
} from './cart-fragments';
import type {
CartOptionalInput,
CartQueryData,
Expand Down Expand Up @@ -49,9 +53,12 @@ export const CART_LINES_ADD_MUTATION = (
userErrors {
...CartApiError
}
warnings {
...CartApiWarning
}
}
}

${cartFragment}
${USER_ERROR_FRAGMENT}
${CART_WARNING_FRAGMENT}
`;
11 changes: 9 additions & 2 deletions packages/hydrogen/src/cart/queries/cartLinesRemoveDefault.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
import {StorefrontApiErrors, formatAPIResult} from '../../storefront';
import {throwIfLinesAreOptimistic} from '../optimistic/optimistic-cart.helper';
import {MINIMAL_CART_FRAGMENT, USER_ERROR_FRAGMENT} from './cart-fragments';
import {
CART_WARNING_FRAGMENT,
MINIMAL_CART_FRAGMENT,
USER_ERROR_FRAGMENT,
} from './cart-fragments';
import type {
CartOptionalInput,
CartQueryData,
Expand Down Expand Up @@ -50,9 +54,12 @@ export const CART_LINES_REMOVE_MUTATION = (
userErrors {
...CartApiError
}
warnings {
...CartApiWarning
}
}
}

${cartFragment}
${USER_ERROR_FRAGMENT}
${CART_WARNING_FRAGMENT}
`;
11 changes: 9 additions & 2 deletions packages/hydrogen/src/cart/queries/cartLinesUpdateDefault.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
import {StorefrontApiErrors, formatAPIResult} from '../../storefront';
import {throwIfLinesAreOptimistic} from '../optimistic/optimistic-cart.helper';
import {MINIMAL_CART_FRAGMENT, USER_ERROR_FRAGMENT} from './cart-fragments';
import {
CART_WARNING_FRAGMENT,
MINIMAL_CART_FRAGMENT,
USER_ERROR_FRAGMENT,
} from './cart-fragments';
import type {
CartOptionalInput,
CartQueryData,
Expand Down Expand Up @@ -51,9 +55,12 @@ export const CART_LINES_UPDATE_MUTATION = (
userErrors {
...CartApiError
}
warnings {
...CartApiWarning
}
}
}

${cartFragment}
${USER_ERROR_FRAGMENT}
${CART_WARNING_FRAGMENT}
`;
10 changes: 9 additions & 1 deletion packages/hydrogen/src/cart/queries/cartNoteUpdateDefault.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import {StorefrontApiErrors, formatAPIResult} from '../../storefront';
import {MINIMAL_CART_FRAGMENT, USER_ERROR_FRAGMENT} from './cart-fragments';
import {
CART_WARNING_FRAGMENT,
MINIMAL_CART_FRAGMENT,
USER_ERROR_FRAGMENT,
} from './cart-fragments';
import type {
CartOptionalInput,
CartQueryData,
Expand Down Expand Up @@ -47,8 +51,12 @@ export const CART_NOTE_UPDATE_MUTATION = (
userErrors {
...CartApiError
}
warnings {
...CartApiWarning
}
}
}
${cartFragment}
${USER_ERROR_FRAGMENT}
${CART_WARNING_FRAGMENT}
`;
10 changes: 9 additions & 1 deletion packages/hydrogen/src/cart/queries/cartSelectedDeliveryOptionsUpdateDefault.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import {StorefrontApiErrors, formatAPIResult} from '../../storefront';
import {MINIMAL_CART_FRAGMENT, USER_ERROR_FRAGMENT} from './cart-fragments';
import {
CART_WARNING_FRAGMENT,
MINIMAL_CART_FRAGMENT,
USER_ERROR_FRAGMENT,
} from './cart-fragments';
import type {
CartOptionalInput,
CartQueryData,
Expand Down Expand Up @@ -49,8 +53,12 @@ export const CART_SELECTED_DELIVERY_OPTIONS_UPDATE_MUTATION = (
userErrors {
...CartApiError
}
warnings {
...CartApiWarning
}
}
}
${cartFragment}
${USER_ERROR_FRAGMENT}
${CART_WARNING_FRAGMENT}
`;
3 changes: 2 additions & 1 deletion templates/skeleton/app/routes/cart.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ export async function action({request, context}: ActionFunctionArgs) {

const cartId = result?.cart?.id;
const headers = cartId ? cart.setCartId(result.cart.id) : new Headers();
const {cart: cartResult, errors} = result;
const {cart: cartResult, errors, warnings} = result;

const redirectTo = formData.get('redirectTo') ?? null;
if (typeof redirectTo === 'string') {
Expand All @@ -86,6 +86,7 @@ export async function action({request, context}: ActionFunctionArgs) {
{
cart: cartResult,
errors,
warnings,
analytics: {
cartId,
},
Expand Down
Loading