@anker-in/campaign-ui 0.5.16 → 0.5.19

package/src/lib/cart/hooks/basic/useAddToCart.ts

@@ -0,0 +1,161 @@
+import { Cart, Attributes } from '../../../shopify'
+import { CartBuyerIdentityInput } from '../../../shopify/gql'
+import { useCallback } from 'react'
+import useSWRMutation, { SWRMutationConfiguration } from 'swr/mutation'
+import { GtmParams } from '../../types'
+// import { startInactiveSpan } from '@sentry/nextjs'
+import { addCartLines as addCartLinesFetcher, createCart as createCartFetcher } from '../../../shopify'
+import { useHeadlessContext } from '../../../context'
+import { defaultSWRMutationConfiguration } from '../../const'
+import { addToCartFbq } from '../../track/fbq'
+import { addToCartGa } from '../../track/gtm'
+
+type AddToCartLineItem = {
+  variant?: { id: string }
+  variantId?: string
+  quantity?: number
+  attributes?: Attributes
+}
+
+export type AddToCartArgs = {
+  lineItems: AddToCartLineItem[]
+  cartId?: string
+  discountCodes?: string[]
+  customAttributes?: Attributes
+  buyerIdentity?: CartBuyerIdentityInput
+  gtmParams?: Exclude<GtmParams, 'brand'>
+  needCreateCart?: boolean // 是否强制创建新购物车
+  onCodesInvalid?: (updatedCart: Cart, invalidCodes: string[]) => Promise<Cart | undefined> // 折扣码不可用时的回调
+}
+
+type UseAddToCartProps = {
+  withTrack?: boolean // 是否需要默认埋点（暂时注释，需要时可以启用）
+}
+
+export const useAddToCart = (
+  { withTrack = true }: UseAddToCartProps = {},
+  swrOptions: SWRMutationConfiguration<Cart | undefined, Error, string, AddToCartArgs> & {
+    throwOnError?: boolean
+  } = defaultSWRMutationConfiguration
+) => {
+  const { storefrontToken, storeDomain, brand } = useHeadlessContext()
+
+  const trigger = useCallback(
+    async (_: any, { arg }: { arg: AddToCartArgs }) => {
+      const {
+        lineItems,
+        cartId,
+        discountCodes,
+        gtmParams = {},
+        buyerIdentity,
+        needCreateCart = false,
+        onCodesInvalid,
+      } = arg
+
+      if (!lineItems || lineItems.length === 0) {
+        return
+      }
+
+      // const addToCartSpan = startInactiveSpan({
+      //   name: 'addToCart',
+      //   op: 'business',
+      // })
+
+      // 准备要添加的商品数据
+      const linesToAdd = lineItems
+        .map(item => ({
+          merchandiseId: item.variant?.id || item.variantId || '',
+          quantity: item.quantity || 1,
+          attributes: item.attributes,
+        }))
+        .filter(item => item.merchandiseId && item.quantity)
+
+      let resultCart: Cart | undefined
+
+      if (linesToAdd.length > 0) {
+        // const addToCartAPISpan = startInactiveSpan({
+        //   name: 'addToCartAPI',
+        //   op: 'business',
+        //   parentSpan: addToCartSpan,
+        // })
+
+        if (!cartId || needCreateCart) {
+          // 创建新购物车
+          // const createCartApiSpan = startInactiveSpan({
+          //   name: 'createCartAPI',
+          //   op: 'business',
+          //   parentSpan: addToCartAPISpan,
+          // })
+
+          resultCart = await createCartFetcher({
+            options: {
+              lines: linesToAdd,
+              buyerIdentity,
+              discountCodes,
+            },
+            config: {
+              storefrontToken,
+              storeDomain,
+            },
+          })
+
+          // createCartApiSpan.end()
+        } else {
+          // 添加到现有购物车
+          // const addCartLinesApiSpan = startInactiveSpan({
+          //   name: 'addCartLinesAPI',
+          //   op: 'business',
+          //   parentSpan: addToCartAPISpan,
+          // })
+
+          resultCart = await addCartLinesFetcher({
+            options: {
+              lines: linesToAdd,
+              cartId,
+            },
+            config: {
+              storefrontToken,
+              storeDomain,
+            },
+          })
+
+          // addCartLinesApiSpan.end()
+        }
+
+        // addToCartAPISpan.end()
+      }
+
+      // 检查是否有不可用的折扣码
+      if (resultCart && onCodesInvalid) {
+        const unApplicableCodes = resultCart.discountCodes
+          ?.filter((item) => !item.applicable)
+          .map((item) => item.code)
+
+        if (unApplicableCodes?.length) {
+          // const removeCartCodesApiSpan = startInactiveSpan({
+          //   name: 'removeCartCodesAPI',
+          //   op: 'business',
+          //   parentSpan: addToCartSpan,
+          // })
+
+          resultCart = (await onCodesInvalid(resultCart, unApplicableCodes)) || resultCart
+
+          // removeCartCodesApiSpan.end()
+        }
+      }
+
+      // 埋点（需要时可以启用）
+      if (withTrack) {
+        addToCartFbq({ lineItems: resultCart?.lineItems || [] })
+        addToCartGa({ lineItems: resultCart?.lineItems || [], gtmParams: { ...gtmParams, brand } })
+      }
+
+      // addToCartSpan.end()
+
+      return resultCart
+    },
+    [storefrontToken, storeDomain]
+  )
+
+  return useSWRMutation('add-to-cart', trigger, swrOptions)
+}

package/src/lib/cart/hooks/basic/useApplyCartCodes.ts

@@ -0,0 +1,72 @@
+import { Cart } from '../../../shopify'
+import { useCallback } from 'react'
+import useSWRMutation, { SWRMutationConfiguration } from 'swr/mutation'
+import { MutationCartDiscountCodesUpdateArgs } from '../../../shopify/gql'
+// import { startInactiveSpan } from '@sentry/nextjs'
+import { updateCartCodes as updateCartCodesFetcher } from '../../../shopify'
+import { useHeadlessContext } from '../../../context'
+import { defaultSWRMutationConfiguration } from '../../const'
+
+export type ApplyCartCodesArgs = {
+  cartId: string
+  discountCodes: string[]
+  currentCart?: Cart // 当前购物车状态，用于合并已有的折扣码
+}
+
+export const useApplyCartCodes = (
+  swrOptions: SWRMutationConfiguration<Cart | undefined, Error, string, ApplyCartCodesArgs> & {
+    throwOnError?: boolean
+  } = defaultSWRMutationConfiguration
+) => {
+  const { storefrontToken, storeDomain } = useHeadlessContext()
+
+  const trigger = useCallback(
+    async (_: any, { arg }: { arg: ApplyCartCodesArgs }) => {
+      const { cartId, discountCodes, currentCart } = arg
+
+      if (!discountCodes?.length) {
+        throw new Error('Invalid input used for this operation: Miss discountCode')
+      }
+
+      if (!cartId) {
+        throw new Error('cartId is required')
+      }
+
+      // 合并当前已有的可用折扣码
+      let existingCodes = currentCart?.discountCodes?.filter(code => code.applicable) || []
+      const uniqueCodes = [...new Set([...existingCodes.map(code => code.code), ...discountCodes])]
+
+      // const applyCartCodesApiSpan = startInactiveSpan({
+      //   name: 'applyCartCodesAPI',
+      //   op: 'business',
+      // })
+
+      const updatedCart = await updateCartCodesFetcher({
+        options: {
+          cartId,
+          discountCodes: uniqueCodes,
+        },
+        config: {
+          storefrontToken,
+          storeDomain,
+        },
+      })
+
+      // applyCartCodesApiSpan.end()
+
+      // 检查新添加的折扣码是否有不可用的
+      const unApplicableCodes = discountCodes.filter((code) =>
+        updatedCart?.discountCodes?.find((item) => item.code === code && !item.applicable)
+      )
+
+      if (unApplicableCodes.length) {
+        throw new Error(`${unApplicableCodes.join(', ')} is not applicable to the cart`)
+      }
+
+      return updatedCart
+    },
+    [storefrontToken, storeDomain]
+  )
+
+  return useSWRMutation('apply-cart-codes', trigger, swrOptions)
+}

package/src/lib/cart/hooks/basic/useBuyNow.ts

@@ -0,0 +1,108 @@
+import { Attributes, Cart, CartBuyerIdentity, CartInput } from '../../../shopify'
+import { useCallback } from 'react'
+import useSWRMutation, { SWRMutationConfiguration } from 'swr/mutation'
+import { FbqBuyNowTrackConfig } from '../../track/fbq'
+import { GtmParams, BuyNowLineItems } from '../../types'
+// import { startInactiveSpan } from '@sentry/nextjs'
+import { createCart as createCartFetcher } from '../../../shopify'
+import { useHeadlessContext } from '../../../context'
+import { defaultSWRMutationConfiguration } from '../../const'
+import { buyNowGa } from '../../track/gtm'
+import { buyNowFbq } from '../../track/fbq'
+
+type UseBuyNowProps = {
+  withTrack?: boolean // 是否需要默认埋点
+  redirectToCheckout?: boolean // 是否重定向到结账页
+}
+
+export type BuyNowArgs = {
+  lineItems: BuyNowLineItems
+  discountCodes?: string[]
+  customAttributes?: Attributes
+  buyerIdentity?: CartBuyerIdentity
+  gtmParams?: GtmParams
+  fbqTrackConfig?: FbqBuyNowTrackConfig
+}
+
+export const useBuyNow = (
+  { withTrack = true, redirectToCheckout = true }: UseBuyNowProps = {},
+  swrOptions: SWRMutationConfiguration<Cart | undefined, Error, string, BuyNowArgs> & {
+    throwOnError?: boolean
+  } = defaultSWRMutationConfiguration
+) => {
+  const { storefrontToken, storeDomain, brand } = useHeadlessContext()
+
+  const trigger = useCallback(
+    async (_: any, { arg }: { arg: BuyNowArgs }) => {
+      const { lineItems, discountCodes, gtmParams = {}, buyerIdentity, fbqTrackConfig,customAttributes } = arg
+
+      if (!lineItems) {
+        return
+      }
+
+      // const buyNowSpan = startInactiveSpan({
+      //   name: 'buyNow',
+      //   op: 'business',
+      // })
+
+      const linesToBuyNow = lineItems
+        .map(item => ({
+          merchandiseId: item.variant.id,
+          quantity: item.quantity || 1,
+          attributes: item.attributes,
+        }))
+        .filter(item => item.merchandiseId && item.quantity)
+
+      let resultCart: Cart | undefined
+      if (linesToBuyNow.length > 0) {
+        // const buyNowAPISpan = startInactiveSpan({
+        //   name: 'buyNowAPI',
+        //   op: 'business',
+        //   parentSpan: buyNowSpan,
+        // })
+
+        // const createCartApiSpan = startInactiveSpan({
+        //   name: 'createCartAPI',
+        //   op: 'business',
+        //   parentSpan: buyNowAPISpan,
+        // })
+        // 创建购物车
+        const createCartOptions = {
+          attributes: customAttributes,
+          lines: linesToBuyNow,
+          buyerIdentity,
+          discountCodes,
+        } as CartInput
+        resultCart = await createCartFetcher({
+          options: createCartOptions,
+          config: {
+            storefrontToken,
+            storeDomain,
+          },
+        })
+        // createCartApiSpan.end()
+
+        // buyNowAPISpan.end()
+      }
+
+      // 埋点
+      if (withTrack) {
+        buyNowGa({ lineItems, gtmParams: { ...gtmParams, brand } })
+        if (fbqTrackConfig) {
+          buyNowFbq({ trackConfig: fbqTrackConfig })
+        }
+      }
+
+      // buyNowSpan.end()
+      if (redirectToCheckout && resultCart?.url) {
+        window.location.href = resultCart.url
+      } else {
+        throw new Error('Failed to buy now')
+      }
+      return resultCart
+    },
+    [withTrack, redirectToCheckout, createCartFetcher]
+  )
+
+  return useSWRMutation('buyNow', trigger, swrOptions)
+}

package/src/lib/cart/hooks/basic/useCreateCart.ts

@@ -0,0 +1,32 @@
+import { Cart, CartInput } from '../../../shopify'
+import { useCallback } from 'react'
+import useSWRMutation, { SWRMutationConfiguration } from 'swr/mutation'
+import { createCart as createCartFetcher } from '../../../shopify'
+import { useHeadlessContext } from '../../../context'
+import { defaultSWRMutationConfiguration } from '../../const'
+
+export type CreateCartArgs = CartInput
+
+export const useCreateCart = (
+  swrOptions: SWRMutationConfiguration<Cart | undefined, Error, string, CreateCartArgs> & {
+    throwOnError?: boolean
+  } = defaultSWRMutationConfiguration
+) => {
+  const { storefrontToken, storeDomain } = useHeadlessContext()
+
+  const trigger = useCallback(
+    async (_: any, { arg }: { arg: CreateCartArgs }) => {
+      const updatedCart = await createCartFetcher({
+        options: arg,
+        config: {
+          storefrontToken,
+          storeDomain,
+        },
+      })
+      return updatedCart
+    },
+    [storefrontToken, storeDomain]
+  )
+
+  return useSWRMutation('create-cart', trigger, swrOptions)
+}

package/src/lib/cart/hooks/basic/useRemoveCartCodes.ts

@@ -0,0 +1,55 @@
+import { Cart } from '../../../shopify'
+import { MutationCartDiscountCodesUpdateArgs } from '../../../shopify/gql'
+import { useCallback } from 'react'
+import useSWRMutation, { SWRMutationConfiguration } from 'swr/mutation'
+import { updateCartCodes as updateCartCodesFetcher } from '../../../shopify'
+import { useHeadlessContext } from '../../../context'
+import { defaultSWRMutationConfiguration } from '../../const'
+
+export type RemoveCartCodesArgs = {
+  cartId: string
+  discountCodes: string[]
+  currentCart?: Cart // 当前购物车状态，用于过滤已有的折扣码
+}
+
+export const useRemoveCartCodes = (
+  swrOptions: SWRMutationConfiguration<Cart | undefined, Error, string, RemoveCartCodesArgs> & {
+    throwOnError?: boolean
+  } = defaultSWRMutationConfiguration
+) => {
+  const { storefrontToken, storeDomain } = useHeadlessContext()
+
+  const trigger = useCallback(
+    async (_: any, { arg }: { arg: RemoveCartCodesArgs }) => {
+      const { cartId, discountCodes, currentCart } = arg
+
+      if (!cartId) {
+        throw new Error('cartId is required')
+      }
+
+      // 获取当前可用的折扣码
+      let codes = currentCart?.discountCodes?.filter((code) => !!code.applicable) || []
+
+      // 过滤掉要删除的折扣码
+      const leftCodes = codes
+        .filter((code) => (discountCodes?.length ? !discountCodes.includes(code.code) : code.code))
+        .map((code) => code.code)
+
+      const updatedCart = await updateCartCodesFetcher({
+        options: {
+          cartId,
+          discountCodes: leftCodes,
+        },
+        config: {
+          storefrontToken,
+          storeDomain,
+        },
+      })
+
+      return updatedCart
+    },
+    [storefrontToken, storeDomain]
+  )
+
+  return useSWRMutation('remove-cart-codes', trigger, swrOptions)
+}

package/src/lib/cart/hooks/basic/useRemoveCartLines.ts

@@ -0,0 +1,51 @@
+import { Cart } from '../../../shopify'
+import { MutationCartLinesRemoveArgs } from '../../../shopify/gql'
+import { useCallback } from 'react'
+import useSWRMutation, { SWRMutationConfiguration } from 'swr/mutation'
+import { removeCartLines as removeCartLinesFetcher } from '../../../shopify'
+import { useHeadlessContext } from '../../../context'
+import { defaultSWRMutationConfiguration } from '../../const'
+
+export type RemoveCartLinesArgs = MutationCartLinesRemoveArgs & {
+  autoRemoveInvalidCodes?: boolean // 是否自动移除不可用的折扣码
+  onCodesRemoved?: (updatedCart: Cart, removedCodes: string[]) => Promise<Cart | undefined> // 移除折扣码的回调
+}
+
+export const useRemoveCartLines = (
+  swrOptions: SWRMutationConfiguration<Cart | undefined, Error, string, RemoveCartLinesArgs> & {
+    throwOnError?: boolean
+  } = defaultSWRMutationConfiguration
+) => {
+  const { storefrontToken, storeDomain } = useHeadlessContext()
+
+  const trigger = useCallback(
+    async (_: any, { arg }: { arg: RemoveCartLinesArgs }) => {
+      const { autoRemoveInvalidCodes = true, onCodesRemoved, ...removeArgs } = arg
+
+      let updatedCart = await removeCartLinesFetcher({
+        options: removeArgs,
+        config: {
+          storefrontToken,
+          storeDomain,
+        },
+      })
+
+      // 自动移除不可用的折扣码
+      if (updatedCart && autoRemoveInvalidCodes) {
+        const unApplicableCodes = updatedCart.discountCodes
+          ?.filter((item) => !item.applicable)
+          .map((item) => item.code)
+
+        if (unApplicableCodes?.length && onCodesRemoved) {
+          // 如果提供了回调函数，使用回调处理
+          updatedCart = (await onCodesRemoved(updatedCart, unApplicableCodes)) || updatedCart
+        }
+      }
+
+      return updatedCart
+    },
+    [storefrontToken, storeDomain]
+  )
+
+  return useSWRMutation('remove-cart-lines', trigger, swrOptions)
+}

package/src/lib/cart/hooks/basic/useUpdateCartAttributes.ts

@@ -0,0 +1,42 @@
+import { Cart } from '../../../shopify'
+import { MutationCartAttributesUpdateArgs } from '../../../shopify/gql'
+import { useCallback } from 'react'
+import useSWRMutation, { SWRMutationConfiguration } from 'swr/mutation'
+import { updateCartAttributes as updateCartAttributesFetcher } from '../../../shopify'
+import { useHeadlessContext } from '../../../context'
+// import { startInactiveSpan } from '@sentry/nextjs'
+import { defaultSWRMutationConfiguration } from '../../const'
+
+export type UpdateCartAttributesArgs = MutationCartAttributesUpdateArgs
+
+export const useUpdateCartAttributes = (
+  swrOptions: SWRMutationConfiguration<Cart | undefined, Error, string, UpdateCartAttributesArgs> & {
+    throwOnError?: boolean
+  } = defaultSWRMutationConfiguration
+) => {
+  const { storefrontToken, storeDomain } = useHeadlessContext()
+
+  const trigger = useCallback(
+    async (_: any, { arg }: { arg: UpdateCartAttributesArgs }) => {
+      // const updateCartAttributesApiSpan = startInactiveSpan({
+      //   name: 'updateCartAttributesAPI',
+      //   op: 'business',
+      // })
+
+      const updatedCart = await updateCartAttributesFetcher({
+        options: arg,
+        config: {
+          storefrontToken,
+          storeDomain,
+        },
+      })
+
+      // updateCartAttributesApiSpan.end()
+
+      return updatedCart
+    },
+    [storefrontToken, storeDomain]
+  )
+
+  return useSWRMutation('update-cart-attributes', trigger, swrOptions)
+}

package/src/lib/cart/hooks/basic/useUpdateCartBuyerIdentity.ts

@@ -0,0 +1,34 @@
+import { Cart } from '../../../shopify'
+import { MutationCartBuyerIdentityUpdateArgs } from '../../../shopify/gql'
+import { useCallback } from 'react'
+import useSWRMutation, { SWRMutationConfiguration } from 'swr/mutation'
+import { updateCartBuyerIdentity as updateCartBuyerIdentityFetcher } from '../../../shopify'
+import { useHeadlessContext } from '../../../context'
+import { defaultSWRMutationConfiguration } from '../../const'
+
+export type UpdateCartBuyerIdentityArgs = MutationCartBuyerIdentityUpdateArgs
+
+export const useUpdateCartBuyerIdentity = (
+  swrOptions: SWRMutationConfiguration<Cart | undefined, Error, string, UpdateCartBuyerIdentityArgs> & {
+    throwOnError?: boolean
+  } = defaultSWRMutationConfiguration
+) => {
+  const { storefrontToken, storeDomain } = useHeadlessContext()
+
+  const trigger = useCallback(
+    async (_: any, { arg }: { arg: UpdateCartBuyerIdentityArgs }) => {
+      const updatedCart = await updateCartBuyerIdentityFetcher({
+        options: arg,
+        config: {
+          storefrontToken,
+          storeDomain,
+        },
+      })
+
+      return updatedCart
+    },
+    [storefrontToken, storeDomain]
+  )
+
+  return useSWRMutation('update-cart-buyer-identity', trigger, swrOptions)
+}

package/src/lib/cart/hooks/basic/useUpdateCartLines.ts

@@ -0,0 +1,34 @@
+import { Cart } from '../../../shopify'
+import { MutationCartLinesUpdateArgs } from '../../../shopify/gql'
+import { useCallback } from 'react'
+import useSWRMutation, { SWRMutationConfiguration } from 'swr/mutation'
+import { updateCartLines as updateCartLinesFetcher } from '../../../shopify'
+import { useHeadlessContext } from '../../../context'
+import { defaultSWRMutationConfiguration } from '../../const'
+
+export type UpdateCartLinesArgs = MutationCartLinesUpdateArgs
+
+export const useUpdateCartLines = (
+  swrOptions: SWRMutationConfiguration<Cart | undefined, Error, string, UpdateCartLinesArgs> & {
+    throwOnError?: boolean
+  } = defaultSWRMutationConfiguration
+) => {
+  const { storefrontToken, storeDomain } = useHeadlessContext()
+
+  const trigger = useCallback(
+    async (_: any, { arg }: { arg: UpdateCartLinesArgs }) => {
+      const updatedCart = await updateCartLinesFetcher({
+        options: arg,
+        config: {
+          storefrontToken,
+          storeDomain,
+        },
+      })
+
+      return updatedCart
+    },
+    [storefrontToken, storeDomain]
+  )
+
+  return useSWRMutation('update-cart-lines', trigger, swrOptions)
+}