@anker-in/lib 1.0.0-beta.6 → 1.1.0-beta.1

package/src/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/cart/hooks/basic/useBuyNow.ts

@@ -0,0 +1,107 @@
+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 } = 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 = {
+          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/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/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/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/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/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/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)
+}

package/src/cart/hooks/feature/useCalcAutoFreeGift.tsx

@@ -0,0 +1,178 @@
+import { useMemo, useRef } from 'react'
+import { FunctionGiftResult, FormattedGift, CartLineInput, AutoFreeGiftConfig } from '../../types/autoFreeGift'
+import { preCheck } from '../../utils/autoFreeGift'
+import { getMatchedMainProductSubTotal } from '../../utils/autoFreeGift'
+import { CUSTOMER_ATTRIBUTE_KEY } from '../../../shopify/utils/const'
+import { btoaID } from '../../../shopify/utils/helper'
+import { getProductsByHandles } from '../../../shopify/fetchers'
+import useSWR from 'swr'
+import { useHeadlessContext } from '../../../context'
+
+/**
+ * [计算型 Hook]
+ * 根据购物车、活动配置和用户信息，计算出应得的赠品和下一个目标。
+ * 此 Hook 不产生任何副作用。
+ * 使用示例：
+ * const { qualifyingGift, nextTierGoal, activeCampaign, isLoading } = useCalcAutoFreeGift(cart, autoFreeGiftConfig);
+ */
+export const useCalcAutoFreeGift = (
+  cart: any,
+  autoFreeGiftConfig: AutoFreeGiftConfig,
+  customer: any
+): FunctionGiftResult => {
+  const tags = useMemo(() => customer?.tags || [], [customer?.tags])
+  const isCustomerLoading = useMemo(() => (!customer ? true : false), [customer])
+  const dealsType: string = '' // 可从URL或Context获取
+  const { storefrontToken, storeDomain } = useHeadlessContext()
+
+  // 使用 useRef 缓存 giftProductsResult，确保只执行一次
+  const giftProductsCache = useRef<{
+    data: any[] | null
+    giftHandles: string[]
+  } | null>(null)
+
+  // 1. 找到当前生效的活动和用于计算的子总价
+  const { activeCampaign, subtotal } = useMemo(() => {
+    // 遍历所有活动配置
+    for (const campaign of autoFreeGiftConfig) {
+      const { rule_conditions = [], rule_result } = campaign
+      const { spend_get_reward } = rule_result || {}
+
+      // 前置检查，判断用户和环境是否满足活动条件
+      const isPreCheckPassed = preCheck(rule_conditions, tags, dealsType ? [dealsType] : [])
+
+      if (isPreCheckPassed && spend_get_reward) {
+        // 计算参与活动的主商品的总价
+        const matchedSubtotal = getMatchedMainProductSubTotal(
+          cart,
+          spend_get_reward.main_product?.variant_list?.map((v: any) => v.variant_id) || [],
+          {
+            spend_money_type: spend_get_reward.main_product?.spend_money_type || 1,
+            variant_id_list: spend_get_reward.main_product?.variant_list?.map((v: any) => v.variant_id) || [],
+            all_store_variant: spend_get_reward.main_product?.all_store_variant || false,
+          }
+        )
+
+        // 如果有主商品在购物车中，则此活动为当前生效的活动
+        if (matchedSubtotal > 0) {
+          return { activeCampaign: campaign, subtotal: matchedSubtotal }
+        }
+      }
+    }
+    // 没有找到生效的活动
+    return { activeCampaign: null, subtotal: 0 }
+  }, [autoFreeGiftConfig, cart, tags, dealsType])
+
+  // 2. 根据子总价，计算应得赠品和下一个目标
+  const { qualifyingGift, nextTierGoal } = useMemo(() => {
+    if (!activeCampaign || !activeCampaign.rule_result?.spend_get_reward?.gift_product) {
+      return { qualifyingGift: null, nextTierGoal: null }
+    }
+
+    const giftTiers = activeCampaign.rule_result.spend_get_reward.gift_product
+
+    // a. 找到当前满足条件的最高阶梯 (findLast)
+    const qualifyingTier = giftTiers.findLast(tier => subtotal >= Number(tier.spend_sum_money))
+
+    // b. 找到下一个目标阶梯 (第一个门槛比当前subtotal高的)
+    const nextGoal = giftTiers.find(tier => subtotal < Number(tier.spend_sum_money))
+
+    if (!qualifyingTier) {
+      return { qualifyingGift: null, nextTierGoal: nextGoal || null }
+    }
+
+    // c. 将应得的赠品阶梯格式化为待添加购物车的结构
+    const formattedGift: FormattedGift = {
+      tier: qualifyingTier,
+      itemsToAdd: qualifyingTier.reward_list
+        ?.map(reward => {
+          const giftProduct = reward?.variant_list?.[0]
+          if (!giftProduct) return null
+          return {
+            variant: {
+              id: btoaID(giftProduct.variant_id),
+              handle: giftProduct.handle,
+              sku: giftProduct.sku,
+            },
+            quantity: reward?.get_unit || 1,
+            attributes: [
+              {
+                key: CUSTOMER_ATTRIBUTE_KEY,
+                value: JSON.stringify({
+                  is_gift: true,
+                  rule_id: activeCampaign.rule_id,
+                  spend_sum_money: qualifyingTier.spend_sum_money,
+                }),
+              },
+            ],
+          }
+        })
+        .filter((item): item is CartLineInput => item !== null),
+    }
+
+    return { qualifyingGift: formattedGift, nextTierGoal: nextGoal || null }
+  }, [activeCampaign, subtotal])
+
+  const giftHandles = useMemo(() => {
+    const giftVariant = autoFreeGiftConfig
+      .map(item =>
+        item.rule_result?.spend_get_reward?.gift_product
+          ?.map(v => v.reward_list.map(reward => reward.variant_list.map(variant => variant.handle)))
+          .flat()
+      )
+      .flat()
+    return giftVariant.flat(2)
+  }, [autoFreeGiftConfig])
+
+  // 检查是否需要重新获取数据
+  const shouldFetch = useMemo(() => {
+    if (!giftHandles.length) return false
+
+    // 如果缓存存在且 handles 相同，直接使用缓存
+    if (
+      giftProductsCache.current &&
+      JSON.stringify(giftProductsCache.current.giftHandles) === JSON.stringify(giftHandles)
+    ) {
+      return false
+    }
+
+    return true
+  }, [giftHandles])
+
+  const { data: giftProductsResult } = useSWR(shouldFetch ? giftHandles : null, async () => {
+    const res = await getProductsByHandles({
+      options: {
+        handles: giftHandles,
+      },
+      config: {
+        storefrontToken: storefrontToken,
+        storeDomain: storeDomain,
+      },
+    })
+    const result = Array.isArray(res) ? res : []
+
+    // 缓存结果
+    giftProductsCache.current = {
+      data: result,
+      giftHandles: [...giftHandles],
+    }
+
+    return result
+  })
+
+  // 使用缓存的数据或新获取的数据
+  const finalGiftProductsResult = useMemo(() => {
+    if (giftProductsCache.current && !shouldFetch) {
+      return giftProductsCache.current.data || undefined
+    }
+    return giftProductsResult
+  }, [giftProductsResult, shouldFetch])
+
+  return {
+    qualifyingGift,
+    nextTierGoal,
+    activeCampaign,
+    isLoading: isCustomerLoading,
+    giftProductsResult: finalGiftProductsResult,
+  }
+}