@anker-in/campaign-ui 0.5.16 → 0.5.18

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

@@ -0,0 +1,256 @@
+
+import { useRouter } from 'next/router'
+import { useEffect, useMemo, useCallback, useState, useRef } from 'react'
+import Decimal from 'decimal.js'
+import Cookies from 'js-cookie'
+import { Cart, LineItem } from '../../../shopify/types/cart'
+import useSWR from 'swr'
+import { getProductsByHandles } from '../../../shopify/fetchers'
+import { Product } from '../../../shopify/types'
+import { useHeadlessContext } from '../../../context'
+
+// 兼容老script满赠  ----- 待拆解优化
+interface GiveawayProduct {
+  handle: string
+  sku: string
+}
+
+interface Breakpoint {
+  breakpoint: string
+  giveawayProducts: GiveawayProduct[]
+}
+
+interface Campaign {
+  activityAvailableQuery?: string
+  activityQroperty?: string
+  breakpoints?: Array<{
+    breakpoint: string
+    giveawayProducts: GiveawayProduct[]
+  }>
+  includeTags?: string[]
+  useTotalAmount?: boolean
+}
+export interface UseScriptAutoFreeGiftResult {
+  involvedLines: LineItem[]
+  reorder: (a: LineItem, b: LineItem) => number
+  disableCodeRemove: boolean
+  nextFreeGiftLevel: Breakpoint | null
+  freeGiftLevel: Breakpoint | null
+  involvedSubTotal: Decimal
+  giftProductsResult?: Product[]
+}
+
+// --- 3. 优化后的 Hook 主体 ---
+const useScriptAutoFreeGift = ({
+  campaign,
+  _giveaway,
+  cart,
+}: {
+  campaign: Campaign | null
+  _giveaway: string
+  cart: Cart | undefined
+}): UseScriptAutoFreeGiftResult => {
+  // const { cart } = useCartContext()
+  const { locale } = useRouter()
+
+  // --- 状态管理 ---
+  const [points_subscribe, set_points_subscribe] = useState<boolean>(false)
+  const { storefrontToken, storeDomain } = useHeadlessContext()
+
+  // 使用 useRef 缓存 giftProductsResult，确保只执行一次
+  const giftProductsCache = useRef<{
+    data: any[] | null
+    giftHandles: string[]
+  } | null>(null)
+
+  useEffect(() => {
+    if (locale === 'au') {
+      const isPointsSubscribe = Cookies.get('points_subscribe')
+      set_points_subscribe(!!isPointsSubscribe)
+    }
+  }, [locale])
+
+  // --- 计算层 ---
+  // 使用 useMemo 进行性能优化，处理所有纯计算逻辑。
+
+  const [upgrade_multiple, upgrade_value] = useMemo((): [number, number] => {
+    let upgrade_multiple = 1
+    let upgrade_value = 0
+    if (points_subscribe) {
+      upgrade_multiple = 1.2
+      upgrade_value = 40
+    }
+    cart?.lineItems?.forEach(({ customAttributes }) => {
+      customAttributes?.forEach(({ key, value }: { key: string; value: string }) => {
+        if (key === '_amount_upgrade_multiple')
+          upgrade_multiple = Number(value) || 1
+        if (key === '_amount_upgrade_value') upgrade_value = Number(value) || 0
+      })
+    })
+    return [upgrade_multiple, upgrade_value]
+  }, [cart?.lineItems, points_subscribe])
+
+  const breakpoints = useMemo((): Breakpoint[] => {
+    if (!campaign) return []
+    return (campaign.breakpoints || []).map((item) => ({
+      breakpoint: new Decimal(item.breakpoint)
+        .minus(new Decimal(upgrade_value))
+        .dividedBy(new Decimal(upgrade_multiple))
+        .toFixed(2, Decimal.ROUND_DOWN),
+      giveawayProducts: item.giveawayProducts || [],
+    }))
+  }, [campaign, upgrade_multiple, upgrade_value])
+
+  const giftHandles = useMemo(
+    (): string[] =>
+      // 使用 Set 去重，然后拼接字符串
+      [
+        ...new Set(
+          breakpoints
+            .flatMap((b) => b.giveawayProducts.map((p) => p.handle))
+            .filter(Boolean)
+        ),
+      ],
+    [breakpoints]
+  )
+
+  // 检查是否需要重新获取数据
+  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 involvedLines = useMemo((): LineItem[] => {
+    if (!campaign) return []
+    return (cart?.lineItems || []).filter((line) => {
+      const isNotGift =
+        line?.totalAmount &&
+        Number(line.totalAmount) > 0 &&
+        line.customAttributes?.every((item: { key: string; value: string }) => item.key !== _giveaway)
+      const hasCampaignTag = line.product?.tags?.some(
+        (tag) =>
+          campaign.includeTags?.includes(tag.trim()) &&
+          line.variant?.availableForSale
+      )
+      return isNotGift && hasCampaignTag
+    })
+  }, [cart?.lineItems, campaign, _giveaway])
+
+  const involvedSubTotal = useMemo((): Decimal => {
+    if (!campaign) return new Decimal(0)
+    return involvedLines.reduce((prev, item) => {
+      const amount = campaign.useTotalAmount
+        ? item.totalAmount
+        : item.subtotalAmount
+      return new Decimal(prev).plus(new Decimal(amount || 0))
+    }, new Decimal(0))
+  }, [involvedLines, campaign])
+
+  const [freeGiftLevel, nextFreeGiftLevel] = useMemo((): [
+    Breakpoint | null,
+    Breakpoint | null
+  ] => {
+    const sortedLevels = [...breakpoints].sort(
+      (a, b) => Number(b.breakpoint) - Number(a.breakpoint)
+    )
+    const levelIndex = sortedLevels.findIndex(
+      (level) =>
+        involvedSubTotal.gte(new Decimal(level.breakpoint)) &&
+        involvedLines.length > 0
+    )
+
+    if (levelIndex === -1) {
+      return [
+        null,
+        sortedLevels.length > 0 ? sortedLevels[sortedLevels.length - 1] : null,
+      ]
+    }
+
+    const currentLevel = sortedLevels[levelIndex]
+    const nextLevel = levelIndex > 0 ? sortedLevels[levelIndex - 1] : null
+    return [currentLevel, nextLevel]
+  }, [breakpoints, involvedSubTotal, involvedLines.length])
+
+  // --- 数据获取层 ---
+  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])
+
+  // 使用 useCallback 创建一个稳定的排序函数，用于优化渲染。
+  // 它会根据商品类型（赠品、活动商品、普通商品）进行排序。
+  const reorder = useCallback(
+    (a: LineItem, b: LineItem): number => {
+      const getPriority = (item: LineItem): number => {
+        // 优先级 0: 赠品 (排在最后)
+        if (
+          item.customAttributes?.some(
+            (attribute: { key: string; value: string }) => attribute.key === _giveaway
+          )
+        )
+          return 0
+        // 优先级 1: 参与活动的商品 (BUG修复：应检查 product.tags)
+        if (
+          item.product?.tags?.some((tag) =>
+            campaign?.includeTags?.includes(tag)
+          )
+        )
+          return 1
+        // 优先级 2: 其他普通商品 (排在最前)
+        return 2
+      }
+      // b 的优先级减 a 的优先级，实现降序排列
+      return getPriority(b) - getPriority(a)
+    },
+    [campaign?.includeTags, _giveaway]
+  )
+
+  return {
+    involvedLines,
+    reorder,
+    disableCodeRemove: involvedLines.length > 0,
+    nextFreeGiftLevel,
+    freeGiftLevel,
+    involvedSubTotal,
+    giftProductsResult: finalGiftProductsResult,
+  }
+}
+
+export default useScriptAutoFreeGift

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

@@ -0,0 +1,184 @@
+import { useEffect, useMemo } from 'react'
+import {
+  CODE_AMOUNT_KEY,
+  CUSTOMER_ATTRIBUTE_KEY,
+  MAIN_PRODUCT_CODE,
+  SCRIPT_CODE_AMOUNT_KEY,
+} from '../../../shopify/utils/const'
+import { updateCartLines as updateCartLinesFetcher } from '../../../shopify/fetchers/update-cart-lines'
+import { Cart } from '../../../shopify/types/cart'
+import { useRequest } from 'ahooks'
+import { LoadingState } from '../../context'
+import { getDiscountEnvAttributeValue } from '../../utils/autoFreeGift'
+import { AttributeInput } from '../../../shopify/gql'
+import { useHeadlessContext } from '../../../context'
+
+export const useUpdateLineCodeAmountAttributes = ({
+  cart,
+  mutateCart,
+  isCartLoading,
+  setLoadingState,
+}: {
+  cart?: Cart
+  mutateCart: (cart: Cart) => void
+  isCartLoading: boolean
+  setLoadingState: React.Dispatch<React.SetStateAction<LoadingState>>
+}) => {
+  const { storefrontToken, storeDomain } = useHeadlessContext()
+  
+  const mainProductDiscountCodes = useMemo(
+    () =>
+      cart?.discountCodes
+        .filter(
+          ({ code, applicable }) =>
+            applicable &&
+            MAIN_PRODUCT_CODE.some((codePrefix) => code.startsWith(codePrefix))
+        )
+        .map(({ code }) => code),
+    [cart]
+  )
+
+  const linesNeedUpdate = useMemo(
+    () =>
+      cart?.lineItems
+        .map((line) => {
+          const attrNeedUpdate: AttributeInput[] = []
+          const attrNeedDelete = []
+
+          const codeDiscount = line.discountAllocations?.find((allocation) =>
+            mainProductDiscountCodes?.includes(allocation.code)
+          )
+
+          // 是否有 _discounts_function_env 属性
+          const hasFunctionEnvAttribute = line.customAttributes?.find(
+            (attr: { key: string; value: string }) => attr.key === CUSTOMER_ATTRIBUTE_KEY
+          )
+          const functionEnvValue = getDiscountEnvAttributeValue(
+            line.customAttributes
+          )
+          // lineItem 折后总价与attr中的不一致的情况
+          const hasSameFunctionEnvAttribute =
+            Number(functionEnvValue.discounted_amount) ===
+            Number(line.totalAmount)
+
+          if (!hasSameFunctionEnvAttribute && hasFunctionEnvAttribute) {
+            attrNeedUpdate.push({
+              key: CUSTOMER_ATTRIBUTE_KEY,
+              value: JSON.stringify({
+                ...functionEnvValue,
+                discounted_amount: Number(line.totalAmount),
+              }),
+            })
+          }
+
+          const codeDiscountAmount = codeDiscount?.amount || 0
+          // 是否有 code_money 属性
+          const hasCodeAmountAttribute = line.customAttributes?.find(
+            (attr: { key: string; value: string }) =>
+              attr.key === CODE_AMOUNT_KEY ||
+              attr.key === SCRIPT_CODE_AMOUNT_KEY
+          )
+          // 两个属性都存在且值相同，则不更新
+          const hasSameCodeAmountAttribute =
+            line.customAttributes?.find(
+              (attr: { key: string; value: string }) =>
+                attr.key === CODE_AMOUNT_KEY &&
+                attr.value === String(codeDiscountAmount)
+            ) &&
+            line.customAttributes?.find(
+              (attr: { key: string; value: string }) =>
+                attr.key === SCRIPT_CODE_AMOUNT_KEY &&
+                attr.value === String(codeDiscountAmount)
+            )
+
+          if (codeDiscount && !hasSameCodeAmountAttribute) {
+            attrNeedUpdate.push({
+              key: CODE_AMOUNT_KEY,
+              value: String(codeDiscountAmount),
+            })
+            attrNeedUpdate.push({
+              key: SCRIPT_CODE_AMOUNT_KEY,
+              value: String(codeDiscountAmount),
+            })
+          } else if (!codeDiscount && hasCodeAmountAttribute) {
+            // 没有 code 需要删除的情况
+            attrNeedDelete.push(CODE_AMOUNT_KEY)
+            attrNeedDelete.push(SCRIPT_CODE_AMOUNT_KEY)
+          }
+
+          return {
+            line,
+            attrNeedUpdate,
+            attrNeedDelete,
+          }
+        })
+        .filter(
+          ({ attrNeedUpdate, attrNeedDelete }) =>
+            attrNeedUpdate.length || attrNeedDelete.length
+        )
+        .map(({ line, attrNeedUpdate, attrNeedDelete }) => {
+          if (attrNeedUpdate.length) {
+            return {
+              id: line.id,
+              attributes: [
+                ...(line.customAttributes?.filter(
+                  (attr: { key: string; value: string }) =>
+                    !attrNeedUpdate.some(
+                      (updateAttr) => updateAttr.key === attr.key
+                    )
+                ) || []),
+                ...attrNeedUpdate,
+              ],
+            }
+          } else if (attrNeedDelete.length) {
+            return {
+              id: line.id,
+              attributes:
+                line.customAttributes?.filter(
+                  (attr: { key: string; value: string }) => !attrNeedDelete.includes(attr.key)
+                ) || [],
+            }
+          } else {
+            return {
+              id: line.id,
+              attributes: line.customAttributes || [],
+            }
+          }
+        }),
+    [cart?.lineItems, mainProductDiscountCodes]
+  )
+
+  const { loading } = useRequest(
+    async () => {
+      if (linesNeedUpdate?.length && !isCartLoading) {
+        const result = await updateCartLinesFetcher({
+          options: {
+            cartId: cart?.id || '',
+            lines: linesNeedUpdate,
+          },
+          config: {
+            storefrontToken,
+            storeDomain,
+          },
+        })
+        if (result) {
+          mutateCart(result)
+        }
+      }
+    },
+    {
+      throttleWait: 3000, // 3 秒内只触发最后一次更新
+      throttleTrailing: true,
+      refreshDeps: [linesNeedUpdate, isCartLoading],
+    }
+  )
+
+  useEffect(() => {
+    setLoadingState((prev) => {
+      return {
+        ...prev,
+        editLineCodeAmountLoading: loading,
+      }
+    })
+  }, [loading, setLoadingState])
+}

package/src/lib/cart/index.ts

@@ -0,0 +1,19 @@
+// Context
+
+// Basic Hooks
+
+export * from './hooks/basic/useBuyNow'
+
+// Feature Hooks
+
+// Types
+export * from './types'
+
+// Utils
+export * from './utils'
+
+// Constants
+export * from './const'
+
+// Tracking
+export * from './track/fbq'

package/src/lib/cart/track/fbq.ts

@@ -0,0 +1,38 @@
+import { fbq, gtag } from '../../utils/track'
+import { AddToCartLineItems } from '../types'
+
+export const addToCartFbq = ({ lineItems = [] }: { lineItems: AddToCartLineItems }) => {
+  if (lineItems.length && lineItems[0].variant) {
+    const { variant, quantity, finalPrice } = lineItems[0]
+    fbq('track', 'AddToCart', {
+      value: finalPrice?.amount || variant?.price?.amount,
+      num_items: quantity,
+      currency: variant?.price?.currencyCode,
+      content_name: variant?.product?.title, // 产品内容的名字
+      content_type: 'product_group',
+      content_ids: String(variant?.id), // 产品的varaint id
+      content_category: variant?.product?.metafields?.global?.trafficType || 'public', // 产品分类
+    })
+  }
+}
+
+export type FbqBuyNowTrackConfig = {
+  gtagId: string
+  fbqBuyNowEvent: string
+  gtagBuyNowLabel: string
+  gtagBuyNowConversion: string
+}
+
+export const buyNowFbq = ({ trackConfig }: { trackConfig: FbqBuyNowTrackConfig }) => {
+  try {
+    if (trackConfig?.fbqBuyNowEvent) {
+      fbq('trackCustom', trackConfig?.fbqBuyNowEvent)
+    }
+
+    if (trackConfig?.gtagBuyNowLabel) {
+      gtag('event', trackConfig?.gtagBuyNowConversion || 'conversion', {
+        send_to: `${trackConfig?.gtagId}/${trackConfig?.gtagBuyNowLabel}`,
+      })
+    }
+  } catch (error) {}
+}

package/src/lib/cart/track/gtm.ts

@@ -0,0 +1,159 @@
+// GA 埋点
+import { Decimal } from 'decimal.js'
+
+import { AddToCartLineItems, BuyNowLineItems, GtmParams } from '../types'
+import { Cart } from '../../shopify/types/cart'
+import { getQuery } from '../utils'
+
+declare global {
+  interface Window {
+    dataLayer?: any[]
+    gtag?: (...args: any) => void
+  }
+}
+
+export const gaTrack = (data: any) => {
+  if (typeof window === 'undefined') {
+    return ''
+  }
+  window.dataLayer = window?.dataLayer || []
+  if (!Array.isArray(window.dataLayer)) {
+    return ''
+  }
+
+  try {
+    window?.dataLayer?.push({ event_parameters: null })
+    window?.dataLayer?.push(data || {})
+  } catch (error) {
+    console.log('pageGTMEvent error', error)
+  }
+}
+
+export const addToCartGa = ({
+  lineItems = [],
+  gtmParams = {},
+}: {
+  lineItems: AddToCartLineItems
+  gtmParams?: GtmParams
+}) => {
+  if (!lineItems.length) {
+    return
+  }
+
+  const { variant } = lineItems[0]
+
+  const currencyCode = variant?.price?.currencyCode
+  const totalPrice = lineItems?.reduce(
+    (prev, { variant }) => new Decimal(prev || 0).plus(variant?.price?.amount || 0).toNumber(),
+    0
+  )
+
+  const searchTerm = getQuery().searchTerm
+
+  gaTrack({
+    event: 'ga4Event',
+    event_name: 'add_to_cart',
+    event_parameters: {
+      page_group: gtmParams?.pageGroup,
+      currency: currencyCode,
+      value: totalPrice, // Total price after discount
+      position: gtmParams?.position || '', // Module name
+      ...(searchTerm && {
+        // 站内搜索参数
+        search_term: searchTerm,
+        item_list_name: 'innersite_search',
+      }),
+      items: lineItems?.map(({ variant, quantity }) => ({
+        item_id: variant?.sku,
+        item_name: variant?.product?.title || variant?.product?.name,
+        item_brand: gtmParams?.brand || '',
+        item_category: variant?.product?.productType || '',
+        item_variant: variant?.title || variant?.name,
+        price: variant?.finalPrice?.amount ?? variant?.price?.amount, // Product unit price
+        quantity: quantity || 1,
+      })),
+      ...gtmParams?.ga4Params,
+    },
+  })
+}
+
+export const buyNowGa = ({ lineItems = [], gtmParams = {} }: { lineItems: BuyNowLineItems; gtmParams?: GtmParams }) => {
+  if (!lineItems.length) {
+    return
+  } else {
+    const currencyCode = lineItems[0].variant.price.currencyCode
+    const totalPrice = lineItems?.reduce(
+      (prev, lineItem) =>
+        new Decimal(prev || 0)
+          .plus(lineItem?.finalPrice?.amount ?? (lineItem?.variant.price.amount || 0))
+          .mul(lineItem.quantity || 1)
+          .toNumber(),
+      0
+    )
+    const searchTerm = getQuery().searchTerm
+    gaTrack({
+      event: 'ga4Event',
+      event_name: 'begin_checkout',
+      value: totalPrice, // Total price after discount
+      event_parameters: {
+        ...(searchTerm && {
+          search_term: searchTerm, // Use query directly
+          item_list_name: 'innersite_search',
+        }),
+        position: gtmParams?.position,
+        page_group: gtmParams.pageGroup,
+        currency: currencyCode,
+        value: totalPrice, // Total price after discount
+        items: lineItems?.map(lineItem => ({
+          item_id: lineItem.variant.sku,
+          item_name: lineItem.variant.product.title,
+          item_brand: lineItem.variant.product.vendor || gtmParams?.brand || '',
+          item_category: lineItem.variant.product.productType,
+          item_variant: lineItem.variant.title,
+          price: lineItem.finalPrice?.amount || lineItem.variant.price.amount, //产品单价
+          quantity: lineItem.quantity || 1,
+        })),
+        ...gtmParams.ga4Params,
+      },
+    })
+  }
+}
+
+export const cartCheckoutGa = ({ cart, gtmParams = {} }: { cart: Cart; gtmParams?: GtmParams }) => {
+  if (!cart?.lineItems.length) {
+    return
+  }
+
+  gaTrack({
+    event: 'ga4Event',
+    event_name: 'begin_checkout',
+    event_parameters: {
+      page_group: gtmParams?.pageGroup,
+      position: 'Cart Pop Up_Checkout',
+      currency: cart?.currency?.code,
+      value: cart?.totalPrice,
+      items: cart?.lineItems.map(product => {
+        const variant = product?.variant
+        return {
+          item_id: variant?.sku,
+          item_name: product?.name,
+          item_variant: variant?.title,
+          price: variant?.price,
+          quantity: product?.quantity || 1,
+        }
+      }),
+    },
+  })
+}
+
+export function gaNormalClick({ position, label }: { position: string; label: string }) {
+  gaTrack({
+    event: 'ga4Event',
+    event_name: 'lp_button',
+    event_parameters: {
+      page_group: 'soundcoreCredits Rewards Program',
+      position: position,
+      button_name: label,
+    },
+  })
+}