@anker-in/lib 0.0.0-beta.1 → 0.0.0-beta.2

package/src/context/config.ts

@@ -0,0 +1,10 @@
+export type HeadlessConfig = {
+  storefrontToken: string
+  storeDomain: string
+  locale: string
+  comboMetafieldsNamespace: string
+  cartIdCookieName: string
+  brand: string
+  appName: string
+  passportUrl: string
+}

package/src/context/index.ts

@@ -0,0 +1,3 @@
+export * from './HeadlessProvider'
+export * from './config'
+

package/src/index.ts

@@ -0,0 +1,22 @@
+// ========================================
+// Context (from shared)
+// ========================================
+export * from './context'
+
+// ========================================
+// Shopify Integration
+// ========================================
+export * from './shopify/fetchers'
+export * from './shopify/hooks'
+export * from './shopify/queries'
+export * from './shopify/fragments'
+export * from './shopify/types'
+
+// ========================================
+// Cart Utilities
+// ========================================
+export * from './cart/hooks/basic/useBuyNow'
+export * from './cart/types'
+export * from './cart/utils'
+export * from './cart/const'
+export * from './cart/track/fbq'

package/src/shopify/fetchers/add-cart-lines.ts

@@ -0,0 +1,53 @@
+import { CartLinesAddPayload, MutationCartLinesAddArgs } from '../gql'
+import { addCartLinesMutation } from '../mutations/add-cart-lines'
+import type { Cart } from '../types/cart'
+import { ShopifyFetcher } from '../types/fetcher'
+import { fetchGraphqlApi } from '../utils/fetch-graphql-api'
+import { normalizeCart } from '../utils/normalize'
+import { ShopifyConfig } from '../types/config'
+import { Optional } from '../types/type-helper'
+/**
+ * Adds cart lines to the Shopify cart.
+ *
+ * @param options - The options for adding cart lines.
+ * @param config - The store configuration.
+ * @returns The updated cart or undefined if the cart could not be updated.
+ */
+export const addCartLines: ShopifyFetcher<Cart | undefined, MutationCartLinesAddArgs> = async function ({
+  options,
+  config,
+}: {
+  options: MutationCartLinesAddArgs
+  config: ShopifyConfig
+}) {
+  const { data } = await fetchGraphqlApi<
+    { cartLinesAdd: CartLinesAddPayload },
+    Optional<MutationCartLinesAddArgs, 'cartId'>
+  >({
+    query: addCartLinesMutation,
+    variables: {
+      cartId: options.cartId,
+      lines: options.lines,
+    },
+    config,
+  })
+
+  if (data?.cartLinesAdd?.userErrors?.length) {
+    const errors = data.cartLinesAdd.userErrors
+    const quantityError = errors.find(error => error.field?.includes('quantity'))
+    if (quantityError) {
+      // The quantity of the line item is invalid.
+      return Promise.reject(quantityError)
+    } else {
+      throw new Error(JSON.stringify(data?.cartLinesAdd?.userErrors))
+    }
+  }
+
+  const cart = data?.cartLinesAdd?.cart
+
+  if (cart) {
+    return normalizeCart(cart, '')
+  } else {
+    return undefined
+  }
+}

package/src/shopify/fetchers/create-cart.ts

@@ -0,0 +1,43 @@
+import { CartCreatePayload, CartInput } from '../gql'
+import { createCartMutation } from '../mutations/create-cart'
+import type { Cart } from '../types/cart'
+import { ShopifyFetcher } from '../types/fetcher'
+import { fetchGraphqlApi } from '../utils/fetch-graphql-api'
+import { normalizeCart } from '../utils/normalize'
+import { GetCartMetafieldQueryRoot } from './get-cart'
+import { constructMetafieldIdentifiersQueryParams } from '../utils/helper'
+
+/**
+ * Creates a cart using the Shopify API.
+ *
+ * @param options - The options for the cart.
+ * @param config - The store configuration.
+ * @returns The created cart or undefined if the cart creation fails.
+ */
+export const createCart: ShopifyFetcher<Cart | undefined, CartInput, GetCartMetafieldQueryRoot> = async function ({
+  options,
+  config,
+}) {
+  const { comboMetafieldsNamespace, metafieldIdentifiers, ...rest } = options
+  if (!rest.lines?.length) {
+    throw new Error('Invalid input used for this operation: Miss lines')
+  }
+  const { data } = await fetchGraphqlApi<{ cartCreate: CartCreatePayload }, CartInput>({
+    query: createCartMutation,
+    variables: {
+      ...rest,
+      ...(metafieldIdentifiers && {
+        ...constructMetafieldIdentifiersQueryParams(metafieldIdentifiers, comboMetafieldsNamespace),
+      }),
+    },
+    config,
+  })
+
+  const cart = data?.cartCreate?.cart
+
+  if (cart) {
+    return normalizeCart(cart, comboMetafieldsNamespace)
+  } else {
+    return undefined
+  }
+}

package/src/shopify/fetchers/get-cart.ts

@@ -0,0 +1,48 @@
+import { Cart, GetCartQueryVariables } from '../gql'
+import type { Cart as ExportCart } from '../types/cart'
+import {
+  HasMetafieldQueryRoot,
+  metafieldIdentifiersGroup,
+  ShopifyFetcher,
+  ShopifyFetcherVariables,
+} from '../types/fetcher'
+import { fetchGraphqlApi } from '../utils/fetch-graphql-api'
+import { normalizeCart } from '../utils/normalize'
+import { getCartQuery } from '../queries/get-cart'
+import { constructMetafieldIdentifiersQueryParams } from '../utils/helper'
+
+export type GetCartMetafieldQueryRoot = HasMetafieldQueryRoot.Product | HasMetafieldQueryRoot.Variant
+
+export type GetCartReq = {
+  cartId: string
+} & metafieldIdentifiersGroup<GetCartMetafieldQueryRoot>
+
+/**
+ * Fetches the cart from Shopify.
+ *
+ * @param options - The options for fetching the cart.
+ * @param config - The store configuration.
+ * @returns The fetched cart or undefined if not found.
+ */
+export const getCart: ShopifyFetcher<ExportCart | undefined, GetCartQueryVariables, GetCartMetafieldQueryRoot> =
+  async function ({ options, config }) {
+    const { comboMetafieldsNamespace: metafieldsNamespace, metafieldIdentifiers, cartId } = options
+
+    if (!cartId) {
+      throw new Error('Invalid input used for this operation: Miss cartId')
+    }
+
+    const { data } = await fetchGraphqlApi<
+      { cart: Cart },
+      ShopifyFetcherVariables<GetCartQueryVariables, GetCartMetafieldQueryRoot>
+    >({
+      query: getCartQuery,
+      variables: {
+        cartId,
+        ...constructMetafieldIdentifiersQueryParams(metafieldIdentifiers, metafieldsNamespace),
+      },
+      config,
+    })
+
+    return normalizeCart(data.cart, metafieldsNamespace)
+  }

package/src/shopify/fetchers/get-products-by-handles.ts

@@ -0,0 +1,48 @@
+import { getProductsByHandlesQuery } from '../queries/get-product-by-handles'
+import { fetchGraphqlApi } from '../utils/fetch-graphql-api'
+import { constructMetafieldIdentifiersQueryParams } from '../utils/helper'
+import { normalizeProduct } from '../utils/normalize/product'
+import { Product as ShopifyProduct } from '../gql'
+import { HasMetafieldQueryRoot, ShopifyFetcher, ShopifyFetcherVariables } from '../types/fetcher'
+import { Product } from '../types/product'
+
+export type GetProductsMetafieldQueryRoot = HasMetafieldQueryRoot.Product | HasMetafieldQueryRoot.Variant
+
+export type GetProductsByHandlesReq = {
+  handles: string[]
+}
+
+/**
+ * Gets products by their handles.
+ *
+ * @param options - The options for getting products.
+ * @param config - The store configuration.
+ * @returns An array of products.
+ */
+export const getProductsByHandles: ShopifyFetcher<
+  Product[],
+  GetProductsByHandlesReq,
+  GetProductsMetafieldQueryRoot
+> = async ({ options, config }) => {
+  const { handles, metafieldIdentifiers, comboMetafieldsNamespace } = options
+
+  if (!handles?.length) {
+    throw new Error('Handles are required')
+  }
+
+  const products = await fetchGraphqlApi<
+    Record<string, ShopifyProduct>,
+    ShopifyFetcherVariables<GetProductsByHandlesReq, GetProductsMetafieldQueryRoot>
+  >({
+    query: getProductsByHandlesQuery(handles),
+    variables: {
+      handles,
+      ...constructMetafieldIdentifiersQueryParams(metafieldIdentifiers, comboMetafieldsNamespace),
+    },
+    config,
+  })
+
+  return Object.values(products.data)
+    .filter(item => !!item)
+    .map(product => normalizeProduct(product, '')) as Product[]
+}

package/src/shopify/fetchers/index.ts

@@ -0,0 +1,10 @@
+export { getProductsByHandles } from './get-products-by-handles'
+export { addCartLines } from './add-cart-lines'
+export { createCart } from './create-cart'
+export { removeCartLines } from './remove-cart-lines'
+export { updateCartAttributes } from './update-cart-attributes'
+export { updateCartLines } from './update-cart-lines'
+export { getCart } from './get-cart'
+
+export type { GetProductsByHandlesReq, GetProductsMetafieldQueryRoot } from './get-products-by-handles'
+export type { GetCartReq, GetCartMetafieldQueryRoot } from './get-cart'

package/src/shopify/fetchers/remove-cart-lines.ts

@@ -0,0 +1,31 @@
+import { Cart, MutationCartLinesRemoveArgs } from '../gql'
+import { removeCartItemsMutation } from '../mutations/remove-cart-items'
+import type { Cart as ExportCart } from '../types/cart'
+import { ShopifyFetcher } from '../types/fetcher'
+import { fetchGraphqlApi } from '../utils/fetch-graphql-api'
+import { normalizeCart } from '../utils/normalize'
+
+/**
+ * Removes cart lines from the Shopify API.
+ *
+ * @param options - The options for removing cart lines.
+ * @param config - The store configuration.
+ * @returns The normalized cart after removing the cart lines, or undefined if the operation fails.
+ */
+export const removeCartLines: ShopifyFetcher<ExportCart | undefined, MutationCartLinesRemoveArgs> = async function ({
+  options,
+  config,
+}) {
+  const { data } = await fetchGraphqlApi<{ cartLinesRemove: { cart: Cart } }, MutationCartLinesRemoveArgs>({
+    query: removeCartItemsMutation,
+    variables: options,
+    config,
+  })
+
+  if (data?.cartLinesRemove?.cart) {
+    const normalizedCart = normalizeCart(data.cartLinesRemove.cart, '')
+    return normalizedCart
+  } else {
+    return undefined
+  }
+}

package/src/shopify/fetchers/update-cart-attributes.ts

@@ -0,0 +1,29 @@
+import { Cart, MutationCartAttributesUpdateArgs } from '../gql'
+import type { Cart as ExportCart } from '../types/cart'
+import { ShopifyFetcher } from '../types/fetcher'
+import { fetchGraphqlApi } from '../utils/fetch-graphql-api'
+import { normalizeCart } from '../utils/normalize'
+import { updateCartAttributesMutation } from '../mutations/update-cart-attributes'
+
+/**
+ * Updates the attributes of a cart.
+ *
+ * @param options - The options for updating the cart attributes.
+ * @param config - The store configuration.
+ * @returns The updated cart or undefined if the update was unsuccessful.
+ */
+export const updateCartAttributes: ShopifyFetcher<ExportCart | undefined, MutationCartAttributesUpdateArgs> =
+  async function ({ options, config }) {
+    const { data } = await fetchGraphqlApi<{ cartAttributesUpdate: { cart: Cart } }, MutationCartAttributesUpdateArgs>({
+      query: updateCartAttributesMutation,
+      variables: options,
+      config,
+    })
+
+    if (data?.cartAttributesUpdate?.cart) {
+      const normalizedCart = normalizeCart(data.cartAttributesUpdate.cart, '')
+      return normalizedCart
+    } else {
+      return undefined
+    }
+  }

package/src/shopify/fetchers/update-cart-buyer-identity.ts

@@ -0,0 +1,32 @@
+import { Cart, MutationCartBuyerIdentityUpdateArgs } from '../gql'
+import type { Cart as ExportCart } from '../types/cart'
+import { ShopifyFetcher } from '../types/fetcher'
+import { fetchGraphqlApi } from '../utils/fetch-graphql-api'
+import { normalizeCart } from '../utils/normalize'
+import { updateCartBuyerIdentityMutation } from '../mutations/update-cart-buyer-identity'
+
+/**
+ * Updates the buyer identity of a cart.
+ *
+ * @param options - The options for updating the cart buyer identity.
+ * @param config - The store configuration.
+ * @returns The updated cart or undefined if the update was unsuccessful.
+ */
+export const updateCartBuyerIdentity: ShopifyFetcher<ExportCart | undefined, MutationCartBuyerIdentityUpdateArgs> =
+  async function ({ options, config }) {
+    const { data } = await fetchGraphqlApi<
+      { cartBuyerIdentityUpdate: { cart: Cart } },
+      MutationCartBuyerIdentityUpdateArgs
+    >({
+      query: updateCartBuyerIdentityMutation,
+      variables: options,
+      config,
+    })
+
+    if (data?.cartBuyerIdentityUpdate?.cart) {
+      const normalizedCart = normalizeCart(data.cartBuyerIdentityUpdate.cart, '')
+      return normalizedCart
+    } else {
+      return undefined
+    }
+  }

package/src/shopify/fetchers/update-cart-codes.ts

@@ -0,0 +1,32 @@
+import { Cart, MutationCartDiscountCodesUpdateArgs } from '../gql'
+import type { Cart as ExportCart } from '../types/cart'
+import { ShopifyFetcher } from '../types/fetcher'
+import { fetchGraphqlApi } from '../utils/fetch-graphql-api'
+import { normalizeCart } from '../utils/normalize'
+import { updateCartDiscountCodeMutation } from '../mutations/update-cart-discount-code'
+
+/**
+ * Updates the discount codes for a cart in the Shopify API.
+ *
+ * @param options - The options for updating the cart discount codes.
+ * @param config - The store configuration.
+ * @returns The updated cart or undefined if the update was unsuccessful.
+ */
+export const updateCartCodes: ShopifyFetcher<ExportCart | undefined, MutationCartDiscountCodesUpdateArgs> =
+  async function ({ options, config }) {
+    const { data } = await fetchGraphqlApi<
+      {
+        cartDiscountCodesUpdate: { cart: Cart }
+      },
+      MutationCartDiscountCodesUpdateArgs
+    >({
+      query: updateCartDiscountCodeMutation,
+      variables: options,
+      config,
+    })
+    if (data.cartDiscountCodesUpdate.cart) {
+      return normalizeCart(data.cartDiscountCodesUpdate.cart, '')
+    } else {
+      return undefined
+    }
+  }

package/src/shopify/fetchers/update-cart-lines.ts

@@ -0,0 +1,42 @@
+import { Cart, MutationCartLinesUpdateArgs } from '../gql'
+import type { Cart as ExportCart } from '../types/cart'
+import { ShopifyFetcher } from '../types/fetcher'
+import { fetchGraphqlApi } from '../utils/fetch-graphql-api'
+import { normalizeCart } from '../utils/normalize'
+import { updateCartLinesMutation } from '../mutations/update-cart-items'
+
+/**
+ * Updates the cart lines in the Shopify API.
+ *
+ * @param options - The options for updating the cart lines.
+ * @param config - The store configuration.
+ * @returns The updated cart or undefined if the update was unsuccessful.
+ */
+export const updateCartLines: ShopifyFetcher<ExportCart | undefined, MutationCartLinesUpdateArgs> = async function ({
+  options,
+  config,
+}) {
+  const { data } = await fetchGraphqlApi<
+    { cartLinesUpdate: { cart: Cart; userErrors?: any } },
+    MutationCartLinesUpdateArgs
+  >({
+    query: updateCartLinesMutation,
+    variables: options,
+    config,
+  })
+
+  if (data?.cartLinesUpdate?.userErrors?.length) {
+    const errors = data.cartLinesUpdate?.userErrors
+    const quantityError = errors.find((error: any) => error.field?.includes('quantity'))
+    if (quantityError) {
+      return Promise.reject(quantityError)
+    }
+  }
+
+  if (data?.cartLinesUpdate?.cart) {
+    const normalizedCart = normalizeCart(data.cartLinesUpdate.cart, '')
+    return normalizedCart
+  } else {
+    return undefined
+  }
+}

package/src/shopify/fragments/article.ts

@@ -0,0 +1,51 @@
+export const articleFragment = /* GraphQL */ `
+  fragment article on Article {
+    id
+    handle
+    title
+    seo {
+      ...seo
+    }
+    image {
+      ...image
+    }
+    tags
+    publishedAt
+    content
+    contentHtml
+    excerpt
+    excerptHtml
+    authorV2 {
+      bio
+      email
+      firstName
+      lastName
+      name
+    }
+  }
+`
+
+export const articleWithoutContentFragment = /* GraphQL */ `
+  fragment article on Article {
+    id
+    handle
+    title
+    seo {
+      ...seo
+    }
+    image {
+      ...image
+    }
+    tags
+    publishedAt
+    excerpt
+    excerptHtml
+    authorV2 {
+      bio
+      email
+      firstName
+      lastName
+      name
+    }
+  }
+`

package/src/shopify/fragments/blog.ts

@@ -0,0 +1,10 @@
+export const blogFragment = /* GraphQL */ `
+  fragment blog on Blog {
+    id
+    handle
+    title
+    seo {
+      ...seo
+    }
+  }
+`

package/src/shopify/fragments/cart.ts

@@ -0,0 +1,193 @@
+import { imageFragment } from './image'
+import { metafieldFragment } from './metafields'
+import { productFragment } from './product'
+import { seoFragment } from './seo'
+
+export const cartFragment = /* GraphQL */ `
+  fragment cart on Cart {
+    id
+    totalQuantity
+    updatedAt
+    createdAt
+    checkoutUrl
+    note
+    attributes {
+      key
+      value
+    }
+    cost {
+      checkoutChargeAmount {
+        amount
+        currencyCode
+      }
+      subtotalAmount {
+        amount
+        currencyCode
+      }
+      totalAmount {
+        amount
+        currencyCode
+      }
+      totalTaxAmount {
+        amount
+        currencyCode
+      }
+      totalDutyAmount {
+        amount
+        currencyCode
+      }
+      totalAmountEstimated
+      totalTaxAmountEstimated
+      totalDutyAmountEstimated
+      subtotalAmountEstimated
+    }
+    buyerIdentity {
+      email
+      customer {
+        email
+        id
+      }
+      deliveryAddressPreferences {
+        ... on MailingAddress {
+          address1
+          address2
+          city
+          country
+          zip
+        }
+      }
+    }
+    discountCodes {
+      applicable
+      code
+    }
+    discountAllocations {
+      ... on CartCodeDiscountAllocation {
+        code
+        discountedAmount {
+          amount
+          currencyCode
+        }
+      }
+      ... on CartAutomaticDiscountAllocation {
+        title
+        discountedAmount {
+          amount
+          currencyCode
+        }
+      }
+      ... on CartCustomDiscountAllocation {
+        title
+        discountedAmount {
+          amount
+          currencyCode
+        }
+      }
+    }
+    deliveryGroups(first: 10) {
+      nodes {
+        deliveryAddress {
+          address1
+          address2
+          city
+          country
+          zip
+        }
+      }
+    }
+    lines(first: 100) {
+      edges {
+        node {
+          id
+          quantity
+          discountAllocations {
+            ... on CartCodeDiscountAllocation {
+              code
+              discountedAmount {
+                amount
+                currencyCode
+              }
+            }
+            ... on CartAutomaticDiscountAllocation {
+              title
+              discountedAmount {
+                amount
+                currencyCode
+              }
+            }
+            ... on CartCustomDiscountAllocation {
+              title
+              discountedAmount {
+                amount
+                currencyCode
+              }
+            }
+          }
+          attributes {
+            key
+            value
+          }
+          cost {
+            amountPerQuantity {
+              amount
+              currencyCode
+            }
+            compareAtAmountPerQuantity {
+              amount
+              currencyCode
+            }
+            subtotalAmount {
+              amount
+              currencyCode
+            }
+            totalAmount {
+              amount
+              currencyCode
+            }
+          }
+          merchandise {
+            ... on ProductVariant {
+              id
+              sku
+              title
+              quantityAvailable
+              currentlyNotInStock
+              availableForSale
+              barcode
+              weight
+              selectedOptions {
+                name
+                value
+              }
+              image {
+                ...image
+              }
+              price {
+                amount
+                currencyCode
+              }
+              compareAtPrice {
+                amount
+                currencyCode
+              }
+              metafields(identifiers: $variantMetafieldIdentifiers) {
+                ...metafield
+              }
+              product {
+                ...product
+                metafields(identifiers: $productMetafieldIdentifiers) {
+                  ...metafield
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+    totalQuantity
+  }
+  ${productFragment}
+  ${seoFragment}
+  ${imageFragment}
+  ${metafieldFragment}
+`

package/src/shopify/fragments/collection.ts

@@ -0,0 +1,15 @@
+export const collectionFragment = /* GraphQL */ `
+  fragment collection on Collection {
+    id
+    handle
+    title
+    description
+    descriptionHtml
+    seo {
+      ...seo
+    }
+    image {
+      ...image
+    }
+  }
+`