@anker-in/campaign-ui 0.5.16 → 0.5.19

package/src/lib/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,
+  }
+}

package/src/lib/cart/hooks/feature/useCalcOrderDiscount.tsx

@@ -0,0 +1,127 @@
+import { useMemo } from 'react'
+import { preCheck } from '../../utils/autoFreeGift'
+import { getMatchedMainProductSubTotal } from '../../utils/autoFreeGift'
+import { OrderDiscountConfig, DiscountType, BasePriceType, TieredDiscount } from '../../types/orderDiscount'
+
+// 返回结果类型
+export interface OrderDiscountResult {
+  qualifyingDiscount: TieredDiscount | null // 当前应得的折扣
+  nextTierGoal: TieredDiscount | null // 下一个目标阶梯
+  activeCampaign: OrderDiscountConfig | null // 当前生效的活动配置
+  discountAmount: number // 折扣金额
+  cartTotalForDiscount: number // 用于计算折扣的购物车总额
+  isLoading: boolean // 依赖数据是否加载中
+}
+
+/**
+ * [计算型 Hook]
+ * 根据购物车、活动配置和用户信息，计算出应得的订单折扣和下一个目标。
+ * 此 Hook 不产生任何副作用。
+ * 使用示例：
+ * const { qualifyingDiscount, nextTierGoal, activeCampaign, discountAmount, isLoading } = useCalcOrderDiscount(cart, orderDiscountConfig);
+ * @param cart - 购物车
+ * @param orderDiscountConfig - 订单折扣配置
+ * @returns { OrderDiscountResult }
+ */
+export const useCalcOrderDiscount = (
+  cart: any,
+  orderDiscountConfig: OrderDiscountConfig[],
+  customer: any
+): OrderDiscountResult => {
+  const tags = useMemo(() => customer?.tags || [], [customer?.tags])
+  const isCustomerLoading = useMemo(() => (!customer ? true : false), [customer])
+  const dealsType: string = '' // 可从URL或Context获取
+
+  // 1. 找到当前生效的活动和用于计算的子总价
+  const { activeCampaign, subtotal } = useMemo(() => {
+    // 遍历所有活动配置
+    for (const campaign of orderDiscountConfig) {
+      const { rule_conditions = [], result_detail } = campaign
+      const { main_product, order_discount_conf } = result_detail || {}
+
+      // 前置检查，判断用户和环境是否满足活动条件
+      const isPreCheckPassed = preCheck(rule_conditions, tags, dealsType ? [dealsType] : [])
+
+      if (isPreCheckPassed && main_product && order_discount_conf) {
+        // 计算参与活动的主商品的总价
+        const matchedSubtotal = getMatchedMainProductSubTotal(
+          cart,
+          main_product?.variant_list?.map(v => v.variant_id) || [],
+          {
+            spend_money_type: order_discount_conf.base_price === BasePriceType.MIN_DISCOUNTED_PRICE ? 2 : 1, // 根据基础价格类型设置
+            variant_id_list: main_product?.variant_list?.map(v => v.variant_id) || [],
+            all_store_variant: main_product?.all_store_variant || false,
+          }
+        )
+
+        // 如果有主商品在购物车中，则此活动为当前生效的活动
+        if (matchedSubtotal > 0) {
+          return { activeCampaign: campaign, subtotal: matchedSubtotal }
+        }
+      }
+    }
+    // 没有找到生效的活动
+    return { activeCampaign: null, subtotal: 0 }
+  }, [orderDiscountConfig, cart, tags, dealsType])
+
+  // 2. 根据子总价，计算应得折扣和下一个目标
+  const { qualifyingDiscount, nextTierGoal, discountAmount } = useMemo(() => {
+    if (!activeCampaign || !activeCampaign.result_detail?.order_discount_conf?.tiered_discounts) {
+      return {
+        qualifyingDiscount: null,
+        nextTierGoal: null,
+        discountAmount: 0,
+      }
+    }
+
+    const tieredDiscounts = activeCampaign.result_detail.order_discount_conf.tiered_discounts
+
+    // a. 找到当前满足条件的最高阶梯 (findLast)
+    const qualifyingTier = tieredDiscounts.findLast(tier => subtotal >= Number(tier.amount))
+
+    // b. 找到下一个目标阶梯 (第一个门槛比当前subtotal高的)
+    const nextGoal = tieredDiscounts.find(tier => subtotal < Number(tier.amount))
+
+    if (!qualifyingTier) {
+      return {
+        qualifyingDiscount: null,
+        nextTierGoal: nextGoal || null,
+        discountAmount: 0,
+      }
+    }
+
+    // c. 计算折扣金额
+    let calculatedDiscount = 0
+    switch (qualifyingTier.discount_type) {
+      case DiscountType.PERCENTAGE:
+        // 百分比折扣
+        calculatedDiscount = (subtotal * qualifyingTier.discount) / 100
+        break
+      case DiscountType.FIXED_AMOUNT:
+        // 固定金额折扣
+        calculatedDiscount = qualifyingTier.discount
+        break
+      case DiscountType.REDUCE_PRICE:
+        // 降低指定价格
+        calculatedDiscount = Math.min(subtotal, qualifyingTier.discount)
+        break
+      default:
+        calculatedDiscount = 0
+    }
+
+    return {
+      qualifyingDiscount: qualifyingTier,
+      nextTierGoal: nextGoal || null,
+      discountAmount: calculatedDiscount,
+    }
+  }, [activeCampaign, subtotal])
+
+  return {
+    qualifyingDiscount,
+    nextTierGoal,
+    activeCampaign,
+    discountAmount,
+    cartTotalForDiscount: subtotal,
+    isLoading: isCustomerLoading,
+  }
+}

package/src/lib/cart/hooks/feature/useCartAttributes.tsx

@@ -0,0 +1,133 @@
+import Cookies from 'js-cookie'
+import { AttributeInput } from '../../../shopify/gql'
+import { useEffect, useMemo, useState } from 'react'
+import { Cart } from '../../../shopify/types/cart'
+import Decimal from 'decimal.js'
+
+export const useCartAttributes = ({
+  profile,
+  customer,
+  cart,
+}: {
+  profile: any
+  customer: any
+  cart?: Cart
+}): { attributes: AttributeInput[] } => {
+  const [currentUrl, setCurrentUrl] = useState('')
+
+  useEffect(() => {
+    setCurrentUrl(window.location.href)
+  }, [])
+
+  const userType = useMemo(() => {
+    let userInfo: any = Cookies.get('userInfo')
+    if (userInfo) {
+      userInfo = JSON.parse(userInfo)
+      let arr = typeof userInfo?.id == 'string' && userInfo?.id.split('/')
+      userInfo.setId = arr[arr.length - 1]
+    }
+    const customerInfo = userInfo || customer
+    if (!customerInfo) {
+      return 'new_user_unlogin'
+    }
+    if (customer) {
+      const { orders = {} } = customer
+      if (orders?.edges?.length === 1) {
+        return 'old_user_orders_once'
+      } else if (orders?.edges?.length > 1) {
+        return 'old_user_orders_twice'
+      }
+    }
+    return 'new_user_login'
+  }, [customer])
+
+  // 用户相关
+  const memberAttributes = useMemo(() => {
+    return [
+      {
+        key: '_token',
+        value: profile?.token, //是否登录
+      },
+      {
+        key: '_member_type',
+        value: profile?.memberType, //：0(游客)，1(普通会员)，2(付费会员)
+      },
+      {
+        key: '_user_type',
+        value: userType, // n
+      },
+      {
+        key: '_is_login',
+        value: profile?.token ? 'true' : 'false',
+      },
+    ]
+  }, [profile?.memberType, profile?.token, userType])
+
+  const functionAttributes = useMemo(() => {
+    return [
+      cart?.discountCodes && {
+        key: '_discounts_function_env',
+        value: JSON.stringify({
+          discount_code: cart?.discountCodes.map((item) => item.code),
+          user_tags: customer?.tags || [],
+        }),
+      },
+    ]
+  }, [cart])
+
+  const presellAttributes = useMemo(() => {
+    return [
+      {
+        key: '_presale',
+        value: cart?.lineItems.some(
+          (item) => item?.variant?.metafields?.presell === 'presell'
+        ),
+      },
+    ]
+  }, [cart])
+
+  const weightAttributes = useMemo(() => {
+    return [
+      {
+        key: '_weight',
+        value: cart?.lineItems.reduce<number>((acc, item) => {
+          return new Decimal(acc)
+            .plus(item.variant.weight?.value ?? 0)
+            .toNumber()
+        }, 0),
+      },
+      {
+        key: '_app_source_name',
+        value: 'dtc',
+      },
+    ]
+  }, [cart])
+
+  const trackingAttributes = useMemo(() => {
+    return [
+      {
+        key: 'utm_params',
+        value: currentUrl,
+      },
+    ]
+  }, [currentUrl])
+
+  return useMemo(
+    () => ({
+      attributes: [
+        ...memberAttributes,
+        ...functionAttributes,
+        ...presellAttributes,
+        ...weightAttributes,
+        ...trackingAttributes,
+      ].filter((item) => item?.value) as AttributeInput[],
+    }),
+    [
+      memberAttributes,
+      functionAttributes,
+      presellAttributes,
+      weightAttributes,
+      trackingAttributes,
+    ]
+  )
+}

package/src/lib/cart/hooks/feature/useCartItemQuantityLimit.tsx

@@ -0,0 +1,59 @@
+import { useMemo } from 'react'
+
+import { LineItem, Cart } from '../../../shopify/types/cart'
+
+const DEFAULT_MIN = 1
+const DEFAULT_MAX = 999
+
+export const useCartItemQuantityLimit = ({
+  cart,
+  cartItem,
+  config,
+}: {
+  cart?: Cart
+  cartItem: LineItem
+  config: {
+    handle: Record<string, { min: number; max: number }>
+    sku: Record<string, { min: number; max: number }>
+  }
+}) => {
+  const quantityLimit = useMemo(() => {
+    if (config?.handle) {
+      // 按handle维度限制
+      const cartItemQuantityLimit =
+        config?.handle?.[cartItem?.product?.handle || '']
+
+      const sameHandleTotalQuantity =
+        cart?.lineItems.reduce((acc, item) => {
+          if (
+            item.product?.handle === cartItem?.product?.handle &&
+            item.variant.sku !== cartItem.variant.sku
+          ) {
+            acc += item.quantity
+          }
+          return acc
+        }, 0) || 0
+
+      return {
+        min: cartItemQuantityLimit?.min || DEFAULT_MIN,
+        max: cartItemQuantityLimit?.max
+          ? cartItemQuantityLimit?.max - sameHandleTotalQuantity
+          : DEFAULT_MAX,
+      }
+    } else if (config?.sku) {
+      const cartItemQuantityLimit = config?.sku?.[cartItem?.variant?.sku]
+
+      return {
+        min: cartItemQuantityLimit?.min || DEFAULT_MIN,
+        max: cartItemQuantityLimit?.max || DEFAULT_MAX,
+      }
+    }
+
+    return {
+      min: DEFAULT_MIN,
+      max: DEFAULT_MAX,
+    }
+  }, [cartItem, cart])
+
+  return quantityLimit
+}