forked from crowetic/commerce
We're making some updates to Next.js Commerce. Everything prior to this commit marks what we're calling [`v1`](https://github.com/vercel/commerce/releases/tag/v1) as a point in time to be able to reference and still use going into the future. The current architecture of Commerce is a multi-vendor, interoperable solution, including:
- [Shopify](https://shopify.vercel.store/)
- [Swell](https://swell.vercel.store/)
- [BigCommerce](https://bigcommerce.vercel.store/)
- [Vendure](https://vendure.vercel.store/)
- [Saleor](https://saleor.vercel.store/)
- [Ordercloud](https://ordercloud.vercel.store/)
- [Spree](https://spree.vercel.store/)
- [Kibo Commerce](https://kibocommerce.vercel.store/)
- [Commerce.js](https://commercejs.vercel.store/)
- [SalesForce Cloud Commerce](https://salesforce-cloud-commerce.vercel.store/)
All features can be toggled on or off, and it's easy to change between commerce providers. To support this, we needed to create a ["commerce metaframework"](d1d9e8c434/packages/commerce/new-provider.md
) where providers could confirm to an API spec to add support for Next.js Commerce. While this worked and was successful for `v1`, we have different design goals and ambitions for `v2`.
**What You Need To Know**
- `v1` will not be updated moving forward. If you need to reference `v1`, you will still be able to clone and deploy the version tagged at this release.
- `v2` will be shifting to be a single provider vs. provider agnostic. Other providers are welcome to fork this repository and swap out the underlying `lib/` implementation that connects to the selected commerce provider (Shopify). This architecture was chosen to reduce the surface area of the codebase, remove the intermediate metaframework layer for provider-interoperability, and enable usage with the latest Next.js and React features.
- We will be sharing more about `v2` in the future as we continue to iterate before the marked release.
362 lines
8.5 KiB
TypeScript
362 lines
8.5 KiB
TypeScript
import { HIDDEN_PRODUCT_TAG, SHOPIFY_GRAPHQL_API_ENDPOINT } from 'lib/constants';
|
|
import { isShopifyError } from 'lib/type-guards';
|
|
import {
|
|
addToCartMutation,
|
|
createCartMutation,
|
|
editCartItemsMutation,
|
|
removeFromCartMutation
|
|
} from './mutations/cart';
|
|
import { getCartQuery } from './queries/cart';
|
|
import {
|
|
getCollectionProductsQuery,
|
|
getCollectionQuery,
|
|
getCollectionsQuery
|
|
} from './queries/collection';
|
|
import { getMenuQuery } from './queries/menu';
|
|
import { getPageQuery } from './queries/page';
|
|
import {
|
|
getProductQuery,
|
|
getProductRecommendationsQuery,
|
|
getProductsQuery
|
|
} from './queries/product';
|
|
import {
|
|
Cart,
|
|
Collection,
|
|
Connection,
|
|
Menu,
|
|
Page,
|
|
Product,
|
|
ShopifyAddToCartOperation,
|
|
ShopifyCart,
|
|
ShopifyCartOperation,
|
|
ShopifyCollection,
|
|
ShopifyCollectionOperation,
|
|
ShopifyCollectionProductsOperation,
|
|
ShopifyCollectionsOperation,
|
|
ShopifyCreateCartOperation,
|
|
ShopifyMenuOperation,
|
|
ShopifyPageOperation,
|
|
ShopifyProduct,
|
|
ShopifyProductOperation,
|
|
ShopifyProductRecommendationsOperation,
|
|
ShopifyProductsOperation,
|
|
ShopifyRemoveFromCartOperation,
|
|
ShopifyUpdateCartOperation
|
|
} from './types';
|
|
|
|
const domain = process.env.SHOPIFY_STORE_DOMAIN!;
|
|
const endpoint = process.env.SHOPIFY_STORE_DOMAIN! + SHOPIFY_GRAPHQL_API_ENDPOINT;
|
|
const key = process.env.SHOPIFY_STOREFRONT_ACCESS_TOKEN!;
|
|
|
|
type ExtractVariables<T> = T extends { variables: object } ? T['variables'] : never;
|
|
|
|
export async function shopifyFetch<T>({
|
|
query,
|
|
variables,
|
|
headers,
|
|
cache = 'force-cache'
|
|
}: {
|
|
query: string;
|
|
variables?: ExtractVariables<T>;
|
|
headers?: HeadersInit;
|
|
cache?: RequestCache;
|
|
}): Promise<{ status: number; body: T } | never> {
|
|
try {
|
|
const result = await fetch(endpoint, {
|
|
method: 'POST',
|
|
headers: {
|
|
'Content-Type': 'application/json',
|
|
'X-Shopify-Storefront-Access-Token': key,
|
|
...headers
|
|
},
|
|
body: JSON.stringify({
|
|
...(query && { query }),
|
|
...(variables && { variables })
|
|
}),
|
|
cache,
|
|
next: { revalidate: 900 } // 15 minutes
|
|
});
|
|
|
|
const body = await result.json();
|
|
|
|
if (body.errors) {
|
|
throw body.errors[0];
|
|
}
|
|
|
|
return {
|
|
status: result.status,
|
|
body
|
|
};
|
|
} catch (e) {
|
|
if (isShopifyError(e)) {
|
|
throw {
|
|
status: e.status || 500,
|
|
message: e.message,
|
|
query
|
|
};
|
|
}
|
|
|
|
throw {
|
|
error: e,
|
|
query
|
|
};
|
|
}
|
|
}
|
|
|
|
const removeEdgesAndNodes = (array: Connection<any>) => {
|
|
return array.edges.map((edge) => edge?.node);
|
|
};
|
|
|
|
const reshapeCart = (cart: ShopifyCart): Cart => {
|
|
if (!cart.cost?.totalTaxAmount) {
|
|
cart.cost.totalTaxAmount = {
|
|
amount: '0.0',
|
|
currencyCode: 'USD'
|
|
};
|
|
}
|
|
|
|
return {
|
|
...cart,
|
|
lines: removeEdgesAndNodes(cart.lines)
|
|
};
|
|
};
|
|
|
|
const reshapeCollection = (collection: ShopifyCollection): Collection | undefined => {
|
|
if (!collection) {
|
|
return undefined;
|
|
}
|
|
|
|
return {
|
|
...collection,
|
|
path: `/search/${collection.handle}`
|
|
};
|
|
};
|
|
|
|
const reshapeCollections = (collections: ShopifyCollection[]) => {
|
|
const reshapedCollections = [];
|
|
|
|
for (const collection of collections) {
|
|
if (collection) {
|
|
const reshapedCollection = reshapeCollection(collection);
|
|
|
|
if (reshapedCollection) {
|
|
reshapedCollections.push(reshapedCollection);
|
|
}
|
|
}
|
|
}
|
|
|
|
return reshapedCollections;
|
|
};
|
|
|
|
const reshapeProduct = (product: ShopifyProduct, filterHiddenProducts: boolean = true) => {
|
|
if (!product || (filterHiddenProducts && product.tags.includes(HIDDEN_PRODUCT_TAG))) {
|
|
return undefined;
|
|
}
|
|
|
|
const { images, variants, ...rest } = product;
|
|
|
|
return {
|
|
...rest,
|
|
images: removeEdgesAndNodes(images),
|
|
variants: removeEdgesAndNodes(variants)
|
|
};
|
|
};
|
|
|
|
const reshapeProducts = (products: ShopifyProduct[]) => {
|
|
const reshapedProducts = [];
|
|
|
|
for (const product of products) {
|
|
if (product) {
|
|
const reshapedProduct = reshapeProduct(product);
|
|
|
|
if (reshapedProduct) {
|
|
reshapedProducts.push(reshapedProduct);
|
|
}
|
|
}
|
|
}
|
|
|
|
return reshapedProducts;
|
|
};
|
|
|
|
export async function createCart(): Promise<Cart> {
|
|
const res = await shopifyFetch<ShopifyCreateCartOperation>({
|
|
query: createCartMutation,
|
|
cache: 'no-store'
|
|
});
|
|
|
|
return reshapeCart(res.body.data.cartCreate.cart);
|
|
}
|
|
|
|
export async function addToCart(
|
|
cartId: string,
|
|
lines: { merchandiseId: string; quantity: number }[]
|
|
): Promise<Cart> {
|
|
const res = await shopifyFetch<ShopifyAddToCartOperation>({
|
|
query: addToCartMutation,
|
|
variables: {
|
|
cartId,
|
|
lines
|
|
},
|
|
cache: 'no-store'
|
|
});
|
|
return reshapeCart(res.body.data.cartLinesAdd.cart);
|
|
}
|
|
|
|
export async function removeFromCart(cartId: string, lineIds: string[]): Promise<Cart> {
|
|
const res = await shopifyFetch<ShopifyRemoveFromCartOperation>({
|
|
query: removeFromCartMutation,
|
|
variables: {
|
|
cartId,
|
|
lineIds
|
|
},
|
|
cache: 'no-store'
|
|
});
|
|
|
|
return reshapeCart(res.body.data.cartLinesRemove.cart);
|
|
}
|
|
|
|
export async function updateCart(
|
|
cartId: string,
|
|
lines: { id: string; merchandiseId: string; quantity: number }[]
|
|
): Promise<Cart> {
|
|
const res = await shopifyFetch<ShopifyUpdateCartOperation>({
|
|
query: editCartItemsMutation,
|
|
variables: {
|
|
cartId,
|
|
lines
|
|
},
|
|
cache: 'no-store'
|
|
});
|
|
|
|
return reshapeCart(res.body.data.cartLinesUpdate.cart);
|
|
}
|
|
|
|
export async function getCart(cartId: string): Promise<Cart | null> {
|
|
const res = await shopifyFetch<ShopifyCartOperation>({
|
|
query: getCartQuery,
|
|
variables: { cartId },
|
|
cache: 'no-store'
|
|
});
|
|
|
|
if (!res.body.data.cart) {
|
|
return null;
|
|
}
|
|
|
|
return reshapeCart(res.body.data.cart);
|
|
}
|
|
|
|
export async function getCollection(handle: string): Promise<Collection | undefined> {
|
|
const res = await shopifyFetch<ShopifyCollectionOperation>({
|
|
query: getCollectionQuery,
|
|
variables: {
|
|
handle
|
|
}
|
|
});
|
|
|
|
return reshapeCollection(res.body.data.collection);
|
|
}
|
|
|
|
export async function getCollectionProducts(handle: string, limit?: number): Promise<Product[]> {
|
|
const res = await shopifyFetch<ShopifyCollectionProductsOperation>({
|
|
query: getCollectionProductsQuery,
|
|
variables: {
|
|
handle,
|
|
first: limit
|
|
}
|
|
});
|
|
|
|
return reshapeProducts(removeEdgesAndNodes(res.body.data.collection.products));
|
|
}
|
|
|
|
export async function getCollections(): Promise<Collection[]> {
|
|
const res = await shopifyFetch<ShopifyCollectionsOperation>({ query: getCollectionsQuery });
|
|
const shopifyCollections = removeEdgesAndNodes(res.body?.data?.collections);
|
|
const collections = [
|
|
{
|
|
handle: '',
|
|
title: 'All',
|
|
description: 'All products',
|
|
seo: {
|
|
title: 'All',
|
|
description: 'All products'
|
|
},
|
|
path: '/search'
|
|
},
|
|
// Filter out the `hidden` collections.
|
|
// Collections that start with `hidden-*` need to be hidden on the search page.
|
|
...reshapeCollections(shopifyCollections).filter(
|
|
(collection) => !collection.handle.startsWith('hidden')
|
|
)
|
|
];
|
|
|
|
return collections;
|
|
}
|
|
|
|
export async function getMenu(handle: string): Promise<Menu[]> {
|
|
const res = await shopifyFetch<ShopifyMenuOperation>({
|
|
query: getMenuQuery,
|
|
variables: {
|
|
handle
|
|
}
|
|
});
|
|
|
|
return (
|
|
res.body?.data?.menu?.items.map((item: { title: string; url: string }) => ({
|
|
title: item.title,
|
|
path: item.url.replace(domain, '').replace('/collections', '/search').replace('/pages', '')
|
|
})) || []
|
|
);
|
|
}
|
|
|
|
export async function getPage(handle: string): Promise<Page> {
|
|
const res = await shopifyFetch<ShopifyPageOperation>({
|
|
query: getPageQuery,
|
|
variables: { handle }
|
|
});
|
|
|
|
return res.body.data.pageByHandle;
|
|
}
|
|
|
|
export async function getProduct(handle: string): Promise<Product | undefined> {
|
|
const res = await shopifyFetch<ShopifyProductOperation>({
|
|
query: getProductQuery,
|
|
variables: {
|
|
handle
|
|
}
|
|
});
|
|
|
|
return reshapeProduct(res.body.data.product, false);
|
|
}
|
|
|
|
export async function getProductRecommendations(productId: string): Promise<Product[]> {
|
|
const res = await shopifyFetch<ShopifyProductRecommendationsOperation>({
|
|
query: getProductRecommendationsQuery,
|
|
variables: {
|
|
productId
|
|
}
|
|
});
|
|
|
|
return reshapeProducts(res.body.data.productRecommendations);
|
|
}
|
|
|
|
export async function getProducts({
|
|
query,
|
|
reverse,
|
|
sortKey
|
|
}: {
|
|
query?: string;
|
|
reverse?: boolean;
|
|
sortKey?: string;
|
|
}): Promise<Product[]> {
|
|
const res = await shopifyFetch<ShopifyProductsOperation>({
|
|
query: getProductsQuery,
|
|
variables: {
|
|
query,
|
|
reverse,
|
|
sortKey
|
|
}
|
|
});
|
|
|
|
return reshapeProducts(removeEdgesAndNodes(res.body.data.products));
|
|
}
|