@anker-in/shopify-react 0.1.1-beta.3 → 0.1.1-beta.31

package/dist/index-aSsTcW2O.d.ts

@@ -1,1966 +0,0 @@
-import * as swr_mutation from 'swr/mutation';
-import { SWRMutationConfiguration } from 'swr/mutation';
-import * as _anker_in_shopify_sdk from '@anker-in/shopify-sdk';
-import { CartLineInput as CartLineInput$1, NormalizedCart, UpdateCartLinesOptions, HasMetafieldsIdentifier, NormalizedProduct, NormalizedProductVariant, NormalizedLineItem, Attribute as Attribute$1, Media, NormalizedCollection, CollectionsConnection, NormalizedBlog, NormalizedArticle } from '@anker-in/shopify-sdk';
-import { A as AddToCartLineItem, G as GtmParams, B as BuyNowTrackConfig, d as PlusMemberShippingMethodConfig, e as PlusMemberSettingsMetafields, D as DeliveryPlusType, f as SelectedPlusMemberProduct, i as DeliveryData } from './types-CICUnw0v.js';
-import Decimal from 'decimal.js';
-import * as swr from 'swr';
-import swr__default, { SWRConfiguration } from 'swr';
-import * as swr__internal from 'swr/_internal';
-import * as React$1 from 'react';
-import { PropsWithChildren, Dispatch, SetStateAction, RefObject } from 'react';
-import * as react_jsx_runtime from 'react/jsx-runtime';
-
-interface CreateCartInput {
-    /** Lines to add to the cart */
-    lines?: CartLineInput$1[];
-    /** Buyer identity for cart creation */
-    buyerIdentity?: {
-        email?: string;
-        countryCode?: string;
-    };
-    /** Discount codes */
-    discountCodes?: string[];
-    /** Custom attributes */
-    customAttributes?: Array<{
-        key: string;
-        value: string;
-    }>;
-}
-/**
- * Hook for creating a new cart
- *
- * Automatically removes invalid discount codes after creating cart
- *
- * @param options - SWR mutation configuration
- * @returns SWR mutation with trigger function
- *
- * @example
- * ```tsx
- * const { trigger, isMutating } = useCreateCart()
- *
- * // Create empty cart
- * await trigger({})
- *
- * // Create cart with items
- * await trigger({
- *   lines: [{
- *     merchandiseId: 'gid://shopify/ProductVariant/123',
- *     quantity: 1
- *   }],
- *   buyerIdentity: {
- *     email: 'customer@example.com',
- *     countryCode: 'US'
- *   },
- *   discountCodes: ['SUMMER2024']
- * })
- * ```
- */
-declare function useCreateCart(options?: SWRMutationConfiguration<NormalizedCart | undefined, Error, 'create-cart', CreateCartInput>): swr_mutation.SWRMutationResponse<NormalizedCart | undefined, Error, "create-cart", CreateCartInput>;
-
-interface AddCartLinesInput {
-    /** Cart ID (optional, will use cookie or create new cart) */
-    cartId?: string;
-    /** Lines to add */
-    lines: CartLineInput$1[];
-    /** Buyer identity for new cart */
-    buyerIdentity?: {
-        email?: string;
-        countryCode?: string;
-    };
-}
-/**
- * Hook for adding lines to cart
- *
- * Automatically removes invalid discount codes after adding items
- *
- * @param options - SWR mutation configuration
- * @returns SWR mutation with trigger function
- *
- * @example
- * ```tsx
- * const { trigger, isMutating } = useAddCartLines()
- *
- * await trigger({
- *   lines: [{
- *     merchandiseId: 'gid://shopify/ProductVariant/123',
- *     quantity: 1
- *   }]
- * })
- * ```
- */
-declare function useAddCartLines(options?: SWRMutationConfiguration<NormalizedCart | undefined, Error, 'add-cart-lines', AddCartLinesInput>): swr_mutation.SWRMutationResponse<NormalizedCart | undefined, Error, "add-cart-lines", AddCartLinesInput>;
-
-/**
- * Hook for updating cart line quantities
- *
- * @param options - SWR mutation configuration
- * @returns SWR mutation with trigger function
- *
- * @example
- * ```tsx
- * const { trigger, isMutating } = useUpdateCartLines()
- *
- * await trigger({
- *   lines: [{
- *     id: 'gid://shopify/CartLine/123',
- *     quantity: 2
- *   }]
- * })
- * ```
- */
-declare function useUpdateCartLines(options?: SWRMutationConfiguration<NormalizedCart | undefined, Error, 'update-cart-lines', UpdateCartLinesOptions>): swr_mutation.SWRMutationResponse<NormalizedCart | undefined, Error, "update-cart-lines", UpdateCartLinesOptions>;
-
-interface RemoveCartLinesInput {
-    /** Cart ID (optional, will use cookie) */
-    cartId?: string;
-    /** Line IDs to remove */
-    lineIds: string[];
-    /** Whether to automatically remove invalid discount codes (default: true) */
-    autoRemoveInvalidCodes?: boolean;
-    /** Callback when discount codes are removed */
-    onCodesRemoved?: (updatedCart: NormalizedCart, removedCodes: string[]) => Promise<NormalizedCart | undefined>;
-}
-/**
- * Hook for removing lines from cart
- *
- * Automatically removes invalid discount codes after removing items
- *
- * @param options - SWR mutation configuration
- * @returns SWR mutation with trigger function
- *
- * @example
- * ```tsx
- * const { trigger, isMutating } = useRemoveCartLines()
- *
- * await trigger({
- *   lineIds: ['gid://shopify/CartLine/123']
- * })
- * ```
- */
-declare function useRemoveCartLines(options?: SWRMutationConfiguration<NormalizedCart | undefined, Error, 'remove-cart-lines', RemoveCartLinesInput>): swr_mutation.SWRMutationResponse<NormalizedCart | undefined, Error, "remove-cart-lines", RemoveCartLinesInput>;
-
-interface ApplyCartCodesInput {
-    /** Cart ID (required) */
-    cartId?: string;
-    /** Discount codes to apply (added to existing applicable codes) */
-    discountCodes: string[];
-    /** Replace existing applicable codes */
-    replaceExistingCodes?: boolean;
-}
-/**
- * Hook for applying discount codes to cart
- *
- * Merges new codes with existing applicable codes and validates them
- *
- * @param options - SWR mutation configuration
- * @returns SWR mutation with trigger function
- *
- * @example
- * ```tsx
- * const { trigger, isMutating, error } = useApplyCartCodes()
- *
- * try {
- *   await trigger({
- *     cartId: 'gid://shopify/Cart/123',
- *     discountCodes: ['SUMMER2024']
- *   })
- * } catch (error) {
- *   // Handle unapplicable codes
- * }
- * ```
- */
-declare function useApplyCartCodes(options?: SWRMutationConfiguration<NormalizedCart | undefined, Error, 'apply-codes', ApplyCartCodesInput>): swr_mutation.SWRMutationResponse<NormalizedCart | undefined, Error, "apply-codes", ApplyCartCodesInput>;
-
-interface RemoveCartCodesInput {
-    /** Cart ID (required) */
-    cartId?: string;
-    /** Discount codes to remove */
-    discountCodes: string[];
-}
-/**
- * Hook for removing discount codes from cart
- *
- * @param options - SWR mutation configuration
- * @returns SWR mutation with trigger function
- *
- * @example
- * ```tsx
- * const { trigger, isMutating } = useRemoveCartCodes()
- *
- * await trigger({
- *   cartId: 'gid://shopify/Cart/123',
- *   discountCodes: ['EXPIRED_CODE']
- * })
- * ```
- */
-declare function useRemoveCartCodes(options?: SWRMutationConfiguration<NormalizedCart | undefined, Error, 'remove-codes', RemoveCartCodesInput>): swr_mutation.SWRMutationResponse<NormalizedCart | undefined, Error, "remove-codes", RemoveCartCodesInput>;
-
-interface UpdateCartAttributesInput {
-    /** Cart ID (optional, will use cookie) */
-    cartId?: string;
-    /** Custom attributes to set on cart */
-    attributes: Array<{
-        key: string;
-        value: string;
-    }>;
-}
-/**
- * Hook for updating cart attributes (custom key-value pairs)
- *
- * @param options - SWR mutation configuration
- * @returns SWR mutation with trigger function
- *
- * @example
- * ```tsx
- * const { trigger, isMutating } = useUpdateCartAttributes()
- *
- * await trigger({
- *   attributes: [
- *     { key: 'gift_message', value: 'Happy Birthday!' },
- *     { key: 'gift_wrap', value: 'true' }
- *   ]
- * })
- * ```
- */
-declare function useUpdateCartAttributes(mutate: (cart: NormalizedCart | undefined) => void, metafieldIdentifiers?: {
-    variant: HasMetafieldsIdentifier[];
-    product: HasMetafieldsIdentifier[];
-}, options?: SWRMutationConfiguration<NormalizedCart | undefined, Error, 'update-cart-attributes', UpdateCartAttributesInput>): swr_mutation.SWRMutationResponse<NormalizedCart | undefined, Error, "update-cart-attributes", UpdateCartAttributesInput>;
-
-interface BuyNowInput {
-    /** Metafield identifiers */
-    metafieldIdentifiers?: {
-        variant: HasMetafieldsIdentifier[];
-        product: HasMetafieldsIdentifier[];
-    };
-    /** Line items to add to the new cart */
-    lineItems: Array<AddToCartLineItem>;
-    /** Discount codes to apply */
-    discountCodes?: string[];
-    /** Custom attributes for the cart */
-    customAttributes?: Array<{
-        key: string;
-        value: string;
-    }>;
-    /** Buyer identity */
-    buyerIdentity?: {
-        email?: string;
-        countryCode?: string;
-    };
-    /** GTM tracking parameters */
-    gtmParams?: Omit<GtmParams, 'brand'>;
-    /** Facebook Pixel tracking configuration */
-    fbqTrackConfig?: BuyNowTrackConfig;
-    /** Whether to redirect to checkout page (default: true) */
-    redirectToCheckout?: boolean;
-}
-interface UseBuyNowOptions {
-    /** Enable tracking (GA and FBQ) */
-    withTrack?: boolean;
-}
-/**
- * Hook for buy now functionality
- *
- * Creates a new cart with the specified items and redirects to checkout.
- * Includes automatic tracking for GA4 and Facebook Pixel.
- *
- * @param options - Hook configuration
- * @param swrOptions - SWR mutation configuration
- * @returns SWR mutation with trigger function
- *
- * @example
- * ```tsx
- * const { trigger, isMutating } = useBuyNow({
- *   withTrack: true,
- *   redirectToCheckout: true,
- * })
- *
- * await trigger({
- *   lineItems: [{
- *     variantId: 'gid://shopify/ProductVariant/123',
- *     quantity: 1
- *   }],
- *   gtmParams: {
- *     pageGroup: 'PDP',
- *     position: 'Buy Now Button'
- *   }
- * })
- * ```
- */
-declare function useBuyNow({ withTrack }?: UseBuyNowOptions, swrOptions?: SWRMutationConfiguration<NormalizedCart | undefined, Error, string, BuyNowInput>): swr_mutation.SWRMutationResponse<NormalizedCart | undefined, Error, string, BuyNowInput>;
-
-type AutoFreeGift = {
-    currentTier: {
-        amount: number;
-        gift?: NormalizedProductVariant;
-    };
-    nextTierGoal: {
-        amount: number;
-        gift?: NormalizedProductVariant;
-    };
-};
-type DiscountLabel = {
-    cart_checkout_label: string;
-    product_label: string;
-    sold_out_label: string;
-};
-type AutoFreeGiftMainProduct = {
-    spend_money_type: number;
-    variant_id_list: string[];
-    all_store_variant: boolean;
-};
-type GiftProduct = {
-    spend_sum_money: number;
-    gift_type: number;
-    reward_list: {
-        get_unit: number;
-        variant_id: string;
-        bak_variant_id_list: null;
-    }[];
-};
-type AutoFreeGiftConfig = Config[];
-type RuleCondition = {
-    with_special_url_params: string[];
-    without_special_url_params: string[];
-    with_user_tags: string[];
-    without_user_tags: string[];
-};
-type MainProductInfo = {
-    spend_money_type: SpendMoneyType;
-    variant_list: VariantItem[];
-    all_store_variant: boolean;
-};
-type Config = {
-    rule_id: number;
-    rule_type: RuleType;
-    discount_label: {
-        cart_checkout_label: string;
-        product_label: string;
-        sold_out_label: string;
-    };
-    frontend_labels: {
-        key: string;
-        label: string;
-        desc: string;
-    }[];
-    apply_unit: number;
-    rule_result: {
-        buy_rule_type: BuyRuleType;
-        spend_get_reward: {
-            main_product: MainProductInfo;
-            gift_product: GiftProductItem[];
-        };
-        buy_get_reward: {
-            main_product: MainProductInfo;
-            gift_product: GiftProductItem[] | null;
-        };
-    };
-    rule_conditions?: RuleCondition[];
-};
-interface GiftTier {
-    spend_sum_money: number;
-    gift_type: number;
-    reward_list: RewardItem[];
-}
-interface RewardItem {
-    get_unit: number;
-    variant_list: VariantItem[];
-}
-interface VariantItem {
-    variant_id: string;
-    sku: string;
-    handle: string;
-    discount_value: number;
-}
-interface GiftProductItem {
-    spend_sum_money: number;
-    gift_type: number;
-    reward_list: RewardItem[];
-}
-declare enum RuleType {
-    AUTO_FREE_GIFT = 1,// 自动赠品
-    BUNDLE = 2,// 组合
-    VOLUME_DISCOUNT = 3,// 量价折扣
-    ORDER_DISCOUNT = 4,// 订单折扣
-    PRICE_DISCOUNT = 5
-}
-declare enum BuyRuleType {
-    BUY_GET_GIFT = 1,// 买赠
-    SPEND_GET_GIFT = 2
-}
-declare enum SpendMoneyType {
-    ORIGIN_PRICE = 1,// 原价
-    DISCOUNT_PRICE = 2
-}
-interface FunctionGiftResult {
-    qualifyingGift: FormattedGift | null;
-    nextTierGoal: GiftTier | null;
-    activeCampaign: Config | null;
-    isLoading: boolean;
-    giftProductsResult?: NormalizedProduct[] | [];
-}
-interface FormattedGift {
-    tier: GiftTier;
-    itemsToAdd: CartLineInput[];
-}
-interface CartLineInput {
-    variant: {
-        id: string;
-        handle: string;
-        sku: string;
-    };
-    quantity: number;
-    attributes: {
-        key: string;
-        value: string;
-    }[];
-}
-type AutoFreeGiftItem = {
-    line: NormalizedLineItem;
-    isSoldOut: boolean;
-};
-type AutoFreeGiftList = AutoFreeGiftItem[] | [];
-
-/**
- * [计算型 Hook]
- * 根据购物车、活动配置和用户信息，计算出应得的赠品和下一个目标。
- * 此 Hook 不产生任何副作用。
- * 使用示例：
- * const { qualifyingGift, nextTierGoal, activeCampaign, isLoading } = useCalcAutoFreeGift(cart, autoFreeGiftConfig);
- *
- * 也可以传入 lines 参数来计算加购前的赠品：
- * const { qualifyingGift, nextTierGoal, activeCampaign, isLoading } = useCalcAutoFreeGift(cart, autoFreeGiftConfig, customer, lines);
- */
-declare const useCalcAutoFreeGift: (cart: any, autoFreeGiftConfig: AutoFreeGiftConfig, customer: any, lines?: AddToCartLineItem[]) => FunctionGiftResult;
-
-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;
-}
-interface UseScriptAutoFreeGiftResult {
-    involvedLines: NormalizedLineItem[];
-    reorder: (a: NormalizedLineItem, b: NormalizedLineItem) => number;
-    disableCodeRemove: boolean;
-    nextFreeGiftLevel: Breakpoint | null;
-    freeGiftLevel: Breakpoint | null;
-    involvedSubTotal: Decimal;
-    giftProductsResult?: NormalizedProduct[];
-}
-declare const useScriptAutoFreeGift: ({ campaign, _giveaway, cart, locale: providedLocale, lines, }: {
-    campaign: Campaign | null;
-    _giveaway: string;
-    cart: NormalizedCart | undefined;
-    locale?: string;
-    lines?: AddToCartLineItem[];
-}) => UseScriptAutoFreeGiftResult;
-
-interface UseCalcGiftsFromLinesOptions {
-    /** Lines to calculate gifts from (AddToCartLineItem format) */
-    lines: AddToCartLineItem[];
-    /** Auto free gift configuration (Function gift) */
-    autoFreeGiftConfig?: AutoFreeGiftConfig;
-    /** Customer information (required for function gift) */
-    customer?: any;
-    /** Script gift campaign configuration */
-    scriptCampaign?: any;
-    /** Script giveaway attribute key */
-    scriptGiveawayKey?: string;
-    /** Locale for product fetching (optional, will use from ShopifyProvider if not provided) */
-    locale?: string;
-}
-interface UseCalcGiftsFromLinesResult {
-    /** Function gift calculation result */
-    functionGift: FunctionGiftResult;
-    /** Script gift calculation result */
-    scriptGift: UseScriptAutoFreeGiftResult;
-    /** All gift lines that need to be added to cart (combined from both) */
-    allGiftLines: CartLineInput[];
-    /** Whether any gifts are available */
-    hasGifts: boolean;
-}
-/**
- * Calculate gifts from AddToCartLineItem[] before adding to cart
- * Supports both function-based gifts (useCalcAutoFreeGift) and script-based gifts (useScriptAutoFreeGift)
- *
- * Automatically uses locale from ShopifyProvider and cart from CartContext if not provided.
- *
- * @example
- * ```tsx
- * // Basic usage (locale from context, customer required for function gift)
- * const { allGiftLines, hasGifts } = useCalcGiftsFromLines({
- *   lines: [{ variant: myVariant, quantity: 2 }],
- *   customer: currentCustomer,
- *   autoFreeGiftConfig: functionGiftConfig,
- *   scriptCampaign: scriptGiftConfig,
- * })
- *
- * // Script gift only (no customer needed)
- * const { allGiftLines, hasGifts } = useCalcGiftsFromLines({
- *   lines: [{ variant: myVariant, quantity: 2 }],
- *   scriptCampaign: scriptGiftConfig,
- * })
- *
- * // With custom locale
- * const { allGiftLines, hasGifts } = useCalcGiftsFromLines({
- *   lines: [{ variant: myVariant, quantity: 2 }],
- *   customer: currentCustomer,
- *   locale: 'fr',
- *   autoFreeGiftConfig: functionGiftConfig,
- * })
- *
- * // Then add both products and gifts to cart
- * await addToCart({
- *   lineItems: [...lines, ...allGiftLines]
- * })
- * ```
- */
-declare function useCalcGiftsFromLines({ lines, customer, scriptGiveawayKey, }: UseCalcGiftsFromLinesOptions): UseCalcGiftsFromLinesResult;
-
-declare enum OrderDiscountType {
-    PERCENTAGE = 1,// 百分比折扣
-    FIXED_AMOUNT = 2,// 固定金额折扣
-    REDUCE_PRICE = 3
-}
-declare enum OrderBasePriceType {
-    ORIGIN_PRICE = 1,// 原价
-    MIN_DISCOUNTED_PRICE = 2
-}
-type TieredDiscount = {
-    amount: number;
-    discount: number;
-    discount_type: OrderDiscountType;
-};
-type OrderDiscountConfig = {
-    rule_id: number;
-    rule_type: number;
-    rule_conditions?: RuleCondition[];
-    result_detail: {
-        main_product: {
-            variant_list: Array<{
-                variant_id: string;
-                sku: string;
-                handle: string;
-            }>;
-            all_store_variant: boolean;
-        };
-        order_discount_conf: {
-            base_price: OrderBasePriceType;
-            tiered_discounts: TieredDiscount[];
-        };
-    };
-};
-
-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 }
- */
-declare const useCalcOrderDiscount: (cart: any, orderDiscountConfig: OrderDiscountConfig[], customer: any) => OrderDiscountResult;
-
-interface ShippingMethodsContext {
-    freeShippingMethods: PlusMemberShippingMethodConfig[];
-    paymentShippingMethods: PlusMemberShippingMethodConfig[];
-    nddOverweight: boolean;
-    tddOverweight: boolean;
-}
-interface PlusMemberContextValue<TProduct = any, TVariant = any, TProfile = any> {
-    plusMemberMetafields: PlusMemberSettingsMetafields;
-    shopCommon?: Record<string, any>;
-    zipCode: string;
-    setZipCode: (value: string) => void;
-    allowNextDayDelivery: boolean;
-    setAllowNextDayDelivery: (value: boolean) => void;
-    allowThirdDayDelivery: boolean;
-    setAllowThirdDayDelivery: (value: boolean) => void;
-    selectedPlusMemberMode: DeliveryPlusType;
-    setSelectedPlusMemberMode: (value: DeliveryPlusType) => void;
-    showAreaCheckModal: boolean;
-    setShowAreaCheckModal: (value: boolean) => void;
-    selectedShippingMethod?: PlusMemberShippingMethodConfig;
-    setSelectedShippingMethod: (value: PlusMemberShippingMethodConfig) => void;
-    showTip: boolean;
-    setShowTip: (value: boolean) => void;
-    showMoreShippingMethod: boolean;
-    setShowMoreShippingMethod: (value: boolean) => void;
-    variant: TVariant;
-    product: TProduct;
-    shippingMethodsContext: ShippingMethodsContext;
-    selectedPlusMemberProduct: SelectedPlusMemberProduct;
-    plusMemberProducts: NormalizedProduct[];
-    showPlusMemberBenefit: boolean;
-    setShowPlusMemberBenefit: (value: boolean) => void;
-    deleteMarginBottom: boolean;
-    setDeleteMarginBottom: (value: boolean) => void;
-    profile?: TProfile;
-    locale?: string;
-}
-declare const PlusMemberContext: React$1.Context<PlusMemberContextValue<any, any, any>>;
-
-/**
- * Hook to access Plus Member Context
- */
-declare function usePlusMemberContext<TProduct = any, TVariant = any>(): PlusMemberContextValue<any, any, any>;
-
-/**
- * Hook to get Plus Monthly Product Variant
- */
-declare function usePlusMonthlyProductVariant<TVariant = any>(): TVariant | undefined;
-
-/**
- * Hook to get Plus Annual Product Variant
- */
-declare function usePlusAnnualProductVariant<TVariant = any>(): TVariant | undefined;
-
-/**
- * Hook to calculate available shipping methods based on product weight and member status
- */
-
-interface UseShippingMethodsOptions<TVariant = any> {
-    /** Product variant with weight information */
-    variant: TVariant;
-    /** Zip code for delivery */
-    zipCode: string;
-    /** Whether next day delivery is allowed */
-    allowNextDayDelivery: boolean;
-    /** Whether third day delivery is allowed */
-    allowThirdDayDelivery: boolean;
-    /** Plus member metafields configuration */
-    plusMemberMetafields: PlusMemberSettingsMetafields;
-    /** Selected plus member mode */
-    selectedPlusMemberMode: DeliveryPlusType;
-    /** Whether user is a plus member */
-    isPlus?: boolean;
-    /** Available NDD coupon code */
-    nddCoupon?: string;
-    /** Available TDD coupon code */
-    tddCoupon?: string;
-}
-interface UseShippingMethodsResult {
-    freeShippingMethods: PlusMemberShippingMethodConfig[];
-    paymentShippingMethods: PlusMemberShippingMethodConfig[];
-    nddOverweight: boolean;
-    tddOverweight: boolean;
-}
-/**
- * Calculate available shipping methods based on product weight, member status, and available coupons
- *
- * @param options - Configuration options
- * @returns Shipping methods categorized by free/payment and overweight status
- *
- * @example
- * ```tsx
- * const { freeShippingMethods, paymentShippingMethods, nddOverweight, tddOverweight } = useShippingMethods({
- *   variant,
- *   zipCode,
- *   allowNextDayDelivery,
- *   allowThirdDayDelivery,
- *   plusMemberMetafields,
- *   selectedPlusMemberMode,
- *   isPlus: profile?.isPlus,
- *   nddCoupon,
- *   tddCoupon,
- * })
- * ```
- */
-declare function useShippingMethods<TVariant extends {
-    weight?: number;
-} = any>(options: UseShippingMethodsOptions<TVariant>): UseShippingMethodsResult;
-
-/**
- * Hook to check shipping method availability and automatically adjust selection
- */
-declare function useShippingMethodAvailableCheck(): void;
-
-/**
- * Hook to replace cart plus member product
- *
- * When adding a monthly membership while an annual membership exists in cart,
- * the annual membership will be replaced and vice versa.
- *
- * @returns Handler function to replace conflicting membership products
- *
- * @example
- * ```tsx
- * const replaceCartPlusMember = useReplaceCartPlusMember()
- *
- * // Call before adding new membership product
- * await replaceCartPlusMember()
- * ```
- */
-declare const useReplaceCartPlusMember: () => () => Promise<void>;
-
-/**
- * Hook to get delivery discount codes from delivery data
- *
- * Extracts and returns the discount codes from the delivery custom data.
- *
- * @param deliveryData - Delivery data containing custom attributes
- * @returns Array of discount codes or undefined
- *
- * @example
- * ```tsx
- * const deliveryCodes = usePlusMemberDeliveryCodes({ deliveryData })
- * ```
- */
-declare const usePlusMemberDeliveryCodes: ({ deliveryData, }: {
-    deliveryData?: DeliveryData;
-}) => string[] | undefined;
-
-type Attribute = {
-    key: string;
-    value: string;
-};
-type Discount = {
-    amount: number;
-    code?: string;
-};
-type Image = {
-    url: string;
-    altText?: string;
-    width?: number;
-    height?: number;
-};
-type Measurement = {
-    value: number;
-    unit: string;
-};
-type ExportSelectedOption = {
-    id?: string;
-    name: string;
-    value: string;
-};
-type ExportProductVariant = {
-    id: string;
-    sku: string;
-    name: string;
-    requiresShipping: boolean;
-    price: number;
-    listPrice: number;
-    image?: Image;
-    isInStock?: boolean;
-    availableForSale?: boolean;
-    weight?: number;
-    height?: Measurement;
-    width?: Measurement;
-    depth?: Measurement;
-    metafields?: any;
-    quantityAvailable: number;
-    currentlyNotInStock: boolean;
-};
-type ExportDiscountAllocations = {
-    amount: number;
-    code: string;
-};
-type ExportLineItem = {
-    id: string;
-    variantId: string;
-    productId: string;
-    name: string;
-    quantity: number;
-    discounts: Discount[];
-    path: string;
-    variant: ExportProductVariant;
-    totalAmount: number;
-    subtotalAmount: number;
-    options?: ExportSelectedOption[];
-    discountAllocations?: ExportDiscountAllocations[];
-    product?: any;
-    weight?: number;
-    customAttributes?: Array<Omit<Attribute, '__typename'>>;
-    freeGiftVariant?: ExportLineItem;
-    relatedVariant?: ExportLineItem;
-};
-type ExportDiscounts = {
-    applicable: boolean;
-    code: string;
-};
-type ExportCart = {
-    id: string;
-    customerId?: string;
-    email?: string;
-    createdAt: string;
-    currency: {
-        code: string;
-    };
-    taxesIncluded?: boolean;
-    lineItems: ExportLineItem[];
-    totallineItemsDiscount?: number;
-    orderDiscounts?: number;
-    lineItemsSubtotalPrice: number;
-    subtotalPrice: number;
-    totalPrice: number;
-    totalTaxAmount: number;
-    discountCodes: ExportDiscounts[];
-    discountAllocations?: ExportDiscountAllocations[];
-    discounts?: Discount[];
-    url?: string;
-    ready: boolean;
-    orderStatusUrl?: any;
-    customAttributes?: any;
-    maxNum?: number;
-};
-
-/**
- * Hook to generate custom attributes for cart line items
- *
- * Creates custom attributes based on delivery data to be attached to line items.
- *
- * @param deliveryData - Delivery data containing custom attributes
- * @returns Array of custom attributes for line items
- *
- * @example
- * ```tsx
- * const itemAttributes = usePlusMemberItemCustomAttributes({ deliveryData })
- *
- * // Use in addToCart
- * await addToCart({
- *   lineItems: lineItems.map(item => ({
- *     ...item,
- *     customAttributes: [...(item.customAttributes || []), ...itemAttributes]
- *   }))
- * })
- * ```
- */
-declare const usePlusMemberItemCustomAttributes: ({ deliveryData, }: {
-    deliveryData?: DeliveryData;
-}) => Attribute[];
-
-interface CustomerOrder {
-    edges?: Array<any>;
-}
-interface Customer {
-    orders?: CustomerOrder;
-}
-/**
- * Hook to generate custom attributes for checkout
- *
- * Creates custom attributes based on delivery data, profile, and customer information
- * to be attached to the checkout.
- *
- * Requires profile to be provided via PlusMemberContext.
- *
- * @param deliveryData - Delivery data containing custom attributes
- * @param product - Product information (optional, for hiding shipping benefits check)
- * @param variant - Variant information (optional, for presale and hiding shipping benefits check)
- * @param customer - Customer information (optional, for user type determination)
- * @param isShowShippingBenefits - Function to check if shipping benefits should be shown (optional)
- * @returns Array of custom attributes for checkout
- *
- * @example
- * ```tsx
- * const checkoutAttributes = usePlusMemberCheckoutCustomAttributes({
- *   deliveryData,
- *   product,
- *   variant,
- *   customer,
- *   isShowShippingBenefits
- * })
- *
- * // Use in checkout
- * await createCheckout({
- *   lineItems,
- *   customAttributes: checkoutAttributes
- * })
- * ```
- */
-declare const usePlusMemberCheckoutCustomAttributes: <TProduct = any, TVariant = any>({ deliveryData, product, variant, customer, isShowShippingBenefits, }: {
-    deliveryData?: DeliveryData;
-    product?: TProduct;
-    variant?: TVariant;
-    customer?: Customer;
-    isShowShippingBenefits?: (args: {
-        variant?: TVariant;
-        product?: TProduct;
-        setting: any;
-    }) => boolean;
-}) => Attribute[];
-
-/**
- * useAutoRemovePlusMemberInCart Hook
- * 自动移除购物车中的会员产品
- * 年费会员删除月费会员产品，月费会员删除年费会员产品
- */
-
-interface UseAutoRemovePlusMemberInCartProps {
-    /** Plus Member 配置 */
-    metafields: PlusMemberSettingsMetafields;
-    /** 用户是否是月费会员 */
-    isMonthlyPlus?: boolean;
-    /** 用户是否是年费会员 */
-    isAnnualPlus?: boolean;
-}
-/**
- * 自动移除购物车中的会员产品
- *
- * @param props - Hook 参数
- * @param props.metafields - Plus Member 配置
- * @param props.isMonthlyPlus - 用户是否是月费会员
- * @param props.isAnnualPlus - 用户是否是年费会员
- *
- * @example
- * ```tsx
- * const { profile } = useProfile()
- *
- * useAutoRemovePlusMemberInCart({
- *   metafields: plusMemberSettings,
- *   isMonthlyPlus: profile?.isMonthlyPlus,
- *   isAnnualPlus: profile?.isAnnualPlus,
- * })
- * ```
- */
-declare function useAutoRemovePlusMemberInCart({ metafields, isMonthlyPlus, isAnnualPlus, }: UseAutoRemovePlusMemberInCartProps): void;
-
-/**
- * useHasPlusMemberInCart Hook
- * 判断购物车中是否包含年费会员或月费会员产品
- */
-
-interface UseHasPlusMemberInCartProps {
-    /** Plus Member 配置 */
-    memberSetting?: PlusMemberSettingsMetafields;
-    /** 购物车数据 */
-    cart?: NormalizedCart;
-}
-interface HasPlusMemberInCartResult {
-    /** 购物车中是否有任何会员产品 */
-    hasPlusMember: boolean;
-    /** 购物车中是否有月费会员产品 */
-    hasMonthlyPlus: boolean;
-    /** 购物车中是否有年费会员产品 */
-    hasAnnualPlus: boolean;
-    /** 月费会员产品的 line item */
-    monthlyPlusItem?: {
-        id: string;
-        quantity: number;
-        handle?: string;
-        sku?: string;
-    };
-    /** 年费会员产品的 line item */
-    annualPlusItem?: {
-        id: string;
-        quantity: number;
-        handle?: string;
-        sku?: string;
-    };
-}
-/**
- * 判断购物车中是否包含年费会员或月费会员产品
- *
- * @param props - Hook 参数
- * @param props.metafields - Plus Member 配置
- * @returns 会员产品信息
- *
- * @example
- * ```tsx
- * const {
- *   hasPlusMember,
- *   hasMonthlyPlus,
- *   hasAnnualPlus,
- *   monthlyPlusItem,
- *   annualPlusItem,
- * } = useHasPlusMemberInCart({
- *   memberSetting: plusMemberSettings,
- * })
- *
- * if (hasPlusMember) {
- *   console.log('购物车中有会员产品')
- * }
- * ```
- */
-declare function useHasPlusMemberInCart({ memberSetting, cart, }: UseHasPlusMemberInCartProps): HasPlusMemberInCartResult;
-
-interface UseAddPlusMemberProductsToCartProps {
-    /** 购物车数据 */
-    cart?: NormalizedCart;
-    /** Plus Member 配置 */
-    memberSetting?: PlusMemberSettingsMetafields;
-    /** 选中的会员模式 */
-    selectedPlusMemberMode: DeliveryPlusType;
-    /** 选中的会员产品 */
-    selectedPlusMemberProduct?: SelectedPlusMemberProduct;
-}
-/**
- * 返回需要添加到购物车的 Plus Member 产品
- *
- * 该 hook 会根据用户选择的会员模式和购物车现有状态，
- * 返回需要添加的会员产品。如果不需要添加会员产品，则返回 undefined。
- *
- * @param props - Hook 参数
- * @param props.cart - 购物车数据
- * @param props.memberSetting - Plus Member 配置
- * @param props.selectedPlusMemberMode - 选中的会员模式
- * @param props.selectedPlusMemberProduct - 选中的会员产品
- * @returns Plus Member 产品对象或 undefined
- *
- * @example
- * ```tsx
- * const plusMemberProduct = useAddPlusMemberProductsToCart({
- *   cart,
- *   memberSetting,
- *   selectedPlusMemberMode: DeliveryPlusType.MONTHLY,
- *   selectedPlusMemberProduct: { product, variant },
- * })
- *
- * // plusMemberProduct 格式:
- * // {
- * //   product: NormalizedProduct,
- * //   variant: NormalizedProductVariant
- * // }
- * // 或 undefined (当不需要添加会员产品时)
- * ```
- */
-declare function useAddPlusMemberProductsToCart({ cart, memberSetting, selectedPlusMemberMode, selectedPlusMemberProduct, }: UseAddPlusMemberProductsToCartProps): {
-    product: _anker_in_shopify_sdk.NormalizedProduct;
-    variant: _anker_in_shopify_sdk.NormalizedProductVariant;
-} | undefined;
-
-interface PlusMemberProviderProps<TProduct = any, TVariant = any, TProfile = any> {
-    variant: TVariant;
-    product: TProduct;
-    memberSetting: PlusMemberSettingsMetafields;
-    initialSelectedPlusMemberMode?: DeliveryPlusType;
-    profile?: TProfile;
-    locale?: string;
-}
-/**
- * Plus Member Provider Component
- *
- * Provides Plus Member context and state management to child components.
- *
- * @param variant - Product variant
- * @param product - Product
- * @param metafields - Plus member settings from metafields
- * @param initialSelectedPlusMemberMode - Initial selected mode (default: 'free')
- * @param profile - User profile
- * @param locale - Locale code
- * @param children - Child components
- *
- * @example
- * ```tsx
- * <PlusMemberProvider
- *   variant={variant}
- *   product={product}
- *   memberSetting={memberSetting}
- *   profile={profile}
- *   locale={locale}
- * >
- *   <YourComponent />
- * </PlusMemberProvider>
- * ```
- */
-declare const PlusMemberProvider: <TProduct = any, TVariant = any, TProfile = any>({ variant, product, memberSetting, initialSelectedPlusMemberMode, profile, locale, children, }: PropsWithChildren<PlusMemberProviderProps<TProduct, TVariant, TProfile>>) => react_jsx_runtime.JSX.Element;
-
-declare const getReferralAttributes: () => {
-    key: string;
-    value: string;
-}[];
-declare const useCartAttributes: ({ profile, customer, cart, memberSetting, }: {
-    profile: any;
-    customer: any;
-    cart?: NormalizedCart;
-    memberSetting?: PlusMemberSettingsMetafields;
-}) => {
-    attributes: Array<{
-        key: string;
-        value: any;
-    }>;
-};
-
-declare const useCartItemQuantityLimit: ({ cart, cartItem, config, }: {
-    cart?: NormalizedCart;
-    cartItem: NormalizedLineItem;
-    config: {
-        handle: Record<string, {
-            min: number;
-            max: number;
-        }>;
-        sku: Record<string, {
-            min: number;
-            max: number;
-        }>;
-    };
-}) => {
-    min: number;
-    max: number;
-};
-
-declare const useUpdateLineCodeAmountAttributes: ({ cart, mutateCart, isCartLoading, setLoadingState, metafieldIdentifiers, }: {
-    cart?: NormalizedCart;
-    mutateCart: (cart: NormalizedCart | undefined) => void;
-    isCartLoading: boolean;
-    setLoadingState: React.Dispatch<React.SetStateAction<any>>;
-    metafieldIdentifiers?: {
-        variant: HasMetafieldsIdentifier[];
-        product: HasMetafieldsIdentifier[];
-    };
-}) => void;
-
-declare enum PriceDiscountType {
-    PERCENTAGE = 1,// 百分比折扣
-    FIXED_AMOUNT = 2
-}
-declare enum PriceBasePriceType {
-    MIN_DISCOUNTED_PRICE = 1,// 最低折扣价
-    MIN_TOTAL_PRICE = 2
-}
-type PriceDiscountConfig = {
-    rule_id: number;
-    rule_type: number;
-    discount_type: PriceDiscountType;
-    discount_value: number;
-    base_price_type: PriceBasePriceType;
-    applicable_products: Array<{
-        product_id: string;
-        variant_id?: string;
-    }>;
-};
-
-declare const currencyCodeMapping: Record<string, string>;
-declare const defaultSWRMutationConfiguration: SWRMutationConfiguration<any, any, any, any, any> & {
-    throwOnError?: boolean;
-};
-declare const CUSTOMER_ATTRIBUTE_KEY = "_discounts_function_env";
-declare const CUSTOMER_SCRIPT_GIFT_KEY = "_giveaway_gradient_gifts";
-declare const CODE_AMOUNT_KEY = "_sku_code_money";
-declare const SCRIPT_CODE_AMOUNT_KEY = "_code_money";
-declare const MAIN_PRODUCT_CODE: string[];
-
-/**
- * Normalize AddToCartLineItem[] to NormalizedLineItem[] format
- * This is used to calculate gifts from lines before they are added to cart
- */
-declare function normalizeAddToCartLines(lines: AddToCartLineItem[]): NormalizedLineItem[];
-/**
- * Create a mock cart structure from AddToCartLineItem[]
- * This is useful for calculating gifts before actual cart operations
- */
-declare function createMockCartFromLines(lines: AddToCartLineItem[], existingCart?: any): any;
-
-declare const getQuery: () => Record<string, string>;
-declare function atobID(id: string): string | undefined;
-declare function btoaID(id: string, type?: 'ProductVariant' | 'Product'): string;
-
-declare const getMatchedMainProductSubTotal: (cartData: any, variant_list: AutoFreeGiftMainProduct["variant_id_list"], main_product: AutoFreeGiftMainProduct) => any;
-declare const safeParse: (str: string) => any;
-declare const getDiscountEnvAttributeValue: (attributes?: {
-    key: string;
-    value: string;
-}[]) => any;
-declare const checkAttributesUpdateNeeded: (oldAttributes: Attribute$1[], newAttributes: Attribute$1[], customAttributesNeedRemove: {
-    key: string;
-}[]) => boolean;
-declare function preCheck(rule_conditions: RuleCondition[], userTags: string[], currentDealsTypes: string[]): boolean;
-declare const formatScriptAutoFreeGift: ({ scriptAutoFreeGiftResult, gradient_gifts, locale, }: {
-    scriptAutoFreeGiftResult: UseScriptAutoFreeGiftResult;
-    gradient_gifts: any;
-    locale: string;
-}) => any[];
-declare const formatFunctionAutoFreeGift: ({ qualifyingGift, giftProductsResult, locale, }: {
-    locale: string;
-    qualifyingGift?: FormattedGift | null;
-    giftProductsResult?: NormalizedProduct[] | [];
-}) => any[];
-
-interface UseProductOptions extends SWRConfiguration<NormalizedProduct | undefined> {
-    handle?: string;
-    metafieldIdentifiers?: Array<{
-        namespace: string;
-        key: string;
-    }>;
-}
-/**
- * Hook to fetch a single product by handle
- *
- * @param options - Hook options including handle and SWR configuration
- * @returns SWR response with product data
- *
- * @example
- * ```typescript
- * function ProductPage() {
- *   const { data: product, error, isLoading } = useProduct({
- *     handle: 'my-product'
- *   })
- *
- *   if (isLoading) return <div>Loading...</div>
- *   if (error) return <div>Error loading product</div>
- *   if (!product) return <div>Product not found</div>
- *
- *   return (
- *     <div>
- *       <h1>{product.title}</h1>
- *       <p>{product.description}</p>
- *       <p>${product.price.amount}</p>
- *     </div>
- *   )
- * }
- * ```
- */
-declare function useProduct(options?: UseProductOptions): swr.SWRResponse<NormalizedProduct | undefined, any, SWRConfiguration<NormalizedProduct | undefined, any, ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedProduct | undefined>) | ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedProduct | undefined>)> | undefined>;
-
-interface UseAllProductsOptions extends SWRConfiguration<NormalizedProduct[]> {
-    first?: number;
-    query?: string;
-    sortKey?: 'TITLE' | 'PRODUCT_TYPE' | 'VENDOR' | 'UPDATED_AT' | 'CREATED_AT' | 'BEST_SELLING' | 'PRICE' | 'RELEVANCE';
-    reverse?: boolean;
-    metafieldIdentifiers?: Array<{
-        namespace: string;
-        key: string;
-    }>;
-}
-/**
- * Hook to fetch all products
- *
- * This hook automatically handles pagination and fetches all products.
- * Use with caution on stores with many products.
- *
- * @param options - Hook options including query parameters and SWR configuration
- * @returns SWR response with products array
- *
- * @example
- * ```typescript
- * function ProductList() {
- *   const { data: products, error, isLoading } = useAllProducts({
- *     sortKey: 'TITLE',
- *     reverse: false
- *   })
- *
- *   if (isLoading) return <div>Loading...</div>
- *   if (error) return <div>Error loading products</div>
- *
- *   return (
- *     <div>
- *       {products?.map(product => (
- *         <div key={product.id}>
- *           <h2>{product.title}</h2>
- *           <p>${product.price.amount}</p>
- *         </div>
- *       ))}
- *     </div>
- *   )
- * }
- * ```
- */
-declare function useAllProducts(options?: UseAllProductsOptions): swr.SWRResponse<NormalizedProduct[], any, SWRConfiguration<NormalizedProduct[], any, ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedProduct[]>) | ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedProduct[]>)> | undefined>;
-
-interface UseProductsByHandlesOptions extends SWRConfiguration<NormalizedProduct[]> {
-    handles?: string[];
-    metafieldIdentifiers?: {
-        product: HasMetafieldsIdentifier[];
-        variant: HasMetafieldsIdentifier[];
-    };
-}
-/**
- * Hook to fetch multiple products by their handles
- *
- * @param options - Hook options including handles array and SWR configuration
- * @returns SWR response with products array
- *
- * @example
- * ```typescript
- * function FeaturedProducts() {
- *   const { data: products, error, isLoading } = useProductsByHandles({
- *     handles: ['product-1', 'product-2', 'product-3']
- *   })
- *
- *   if (isLoading) return <div>Loading...</div>
- *   if (error) return <div>Error loading products</div>
- *
- *   return (
- *     <div>
- *       {products?.map(product => (
- *         <div key={product.id}>
- *           <h2>{product.title}</h2>
- *           <p>${product.price.amount}</p>
- *         </div>
- *       ))}
- *     </div>
- *   )
- * }
- * ```
- */
-declare function useProductsByHandles(options?: UseProductsByHandlesOptions): swr.SWRResponse<NormalizedProduct[], any, SWRConfiguration<NormalizedProduct[], any, ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedProduct[]>) | ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedProduct[]>)> | undefined>;
-
-/**
- * useVariant Hook
- *
- * Client-side hook to get the selected variant based on selected options
- */
-
-type Options = Record<string, string>;
-/**
- * Hook to manage variant selection based on selected options
- *
- * @param product - The product object
- * @param selectedOptions - Currently selected options { Color: 'Red', Size: 'M' }
- * @returns The matching variant
- *
- * @example
- * ```typescript
- * function ProductDetail() {
- *   const { data: product } = useProduct({ handle: 'my-product' })
- *   const [selectedOptions, setSelectedOptions] = useState({ Color: 'Red', Size: 'M' })
- *   const variant = useVariant({ product, selectedOptions })
- *
- *   return (
- *     <div>
- *       <h1>{product.title}</h1>
- *       <p>Selected: {variant.title}</p>
- *       <p>Price: ${variant.price.amount}</p>
- *       <p>Available: {variant.availableForSale ? 'Yes' : 'No'}</p>
- *     </div>
- *   )
- * }
- * ```
- */
-declare function useVariant({ product, selectedOptions, }: {
-    product?: NormalizedProduct;
-    selectedOptions: Options;
-}): NormalizedProductVariant | undefined;
-
-/**
- * usePrice Hook
- *
- * Client-side hook to format price for display
- */
-interface UsePriceOptions {
-    amount: number;
-    baseAmount?: number;
-    currencyCode: string;
-    soldOutDescription?: string;
-    maximumFractionDigits?: number;
-    minimumFractionDigits?: number;
-    removeTrailingZeros?: boolean;
-}
-interface UsePriceResult {
-    price: string;
-    basePrice?: string;
-    free: boolean;
-}
-/**
- * Hook to format price for display
- *
- * @param options - Price formatting options
- * @returns Formatted price object
- *
- * @example
- * ```typescript
- * function ProductPrice({ variant }) {
- *   const { price, basePrice, free } = usePrice({
- *     amount: variant.price.amount,
- *     baseAmount: variant.compareAtPrice?.amount,
- *     currencyCode: variant.price.currencyCode
- *   })
- *
- *   return (
- *     <div>
- *       {free ? (
- *         <span>Free</span>
- *       ) : (
- *         <>
- *           <span className="price">{price}</span>
- *           {basePrice && <span className="original">{basePrice}</span>}
- *         </>
- *       )}
- *     </div>
- *   )
- * }
- * ```
- */
-declare function usePrice({ amount, baseAmount, currencyCode, soldOutDescription, maximumFractionDigits, minimumFractionDigits, removeTrailingZeros, }: UsePriceOptions): UsePriceResult;
-
-/**
- * useSelectedOptions Hook
- *
- * Client-side hook to manage selected product options
- */
-
-type SelectedOptionsResult = [Options, Dispatch<SetStateAction<Options>>];
-/**
- * Hook to manage selected product options based on URL query or SKU
- *
- * @param product - The product object
- * @param sku - Optional SKU to match variant
- * @returns Tuple of [options, setOptions]
- *
- * @example
- * ```typescript
- * function ProductDetail() {
- *   const { data: product } = useProduct({ handle: 'my-product' })
- *   const [selectedOptions, setSelectedOptions] = useSelectedOptions(product)
- *   const variant = useVariant({ product, selectedOptions })
- *
- *   const handleOptionChange = (name: string, value: string) => {
- *     setSelectedOptions(prev => ({ ...prev, [name]: value }))
- *   }
- *
- *   return (
- *     <div>
- *       {product?.options.map(option => (
- *         <select
- *           key={option.id}
- *           value={selectedOptions[option.name] || ''}
- *           onChange={(e) => handleOptionChange(option.name, e.target.value)}
- *         >
- *           {option.values.map(value => (
- *             <option key={value.label} value={value.label}>
- *               {value.label}
- *             </option>
- *           ))}
- *         </select>
- *       ))}
- *       <p>Selected: {variant?.title}</p>
- *     </div>
- *   )
- * }
- * ```
- */
-declare function useSelectedOptions(product?: NormalizedProduct, sku?: string): SelectedOptionsResult;
-
-/**
- * useProductUrl Hook
- *
- * Hook to generate product URLs with variant query params
- * Requires routerAdapter to be configured in ShopifyProvider
- */
-
-/**
- * Hook to generate product URLs
- *
- * @param otherQuery - Additional query parameters to include
- * @returns Function to generate product URL
- *
- * @example
- * ```typescript
- * function ProductCard({ product, variant }) {
- *   const getProductUrl = useProductUrl()
- *
- *   const url = getProductUrl({ product, variant })
- *
- *   return (
- *     <a href={url}>
- *       <h2>{product.title}</h2>
- *       <p>{variant.title}</p>
- *     </a>
- *   )
- * }
- * ```
- *
- * @example With additional query params
- * ```typescript
- * function ProductCard({ product, variant }) {
- *   const getProductUrl = useProductUrl({ utm_source: 'email' })
- *
- *   const url = getProductUrl({ product, variant })
- *   // URL will include: ?variant=123&utm_source=email
- *
- *   return <a href={url}>{product.title}</a>
- * }
- * ```
- */
-declare function useProductUrl(otherQuery?: Record<string, string>): ({ product, variant }: {
-    product?: NormalizedProduct;
-    variant?: NormalizedProductVariant;
-}) => string;
-
-/**
- * useUpdateVariantQuery Hook
- *
- * Hook to automatically update URL query string when variant changes
- */
-
-/**
- * Hook to update URL query string when variant changes
- *
- * This hook automatically updates the browser URL with the selected variant ID
- * without causing a page reload. Useful for shareable URLs and browser history.
- *
- * @param variant - The selected variant
- *
- * @example
- * ```typescript
- * function ProductDetail() {
- *   const { data: product } = useProduct({ handle: 'my-product' })
- *   const [selectedOptions, setSelectedOptions] = useSelectedOptions(product)
- *   const variant = useVariant({ product, selectedOptions })
- *
- *   // Automatically updates URL when variant changes
- *   useUpdateVariantQuery(variant)
- *
- *   return (
- *     <div>
- *       <h1>{product?.title}</h1>
- *       <p>Current variant: {variant?.title}</p>
- *       {/* URL will be: /products/my-product?variant=123456 *\/}
- *     </div>
- *   )
- * }
- * ```
- */
-declare function useUpdateVariantQuery(variant?: NormalizedProductVariant): void;
-
-/**
- * useVariantMedia Hook
- *
- * Hook to get media (images and videos) for the selected variant
- */
-
-type ImageMedia = Media & {
-    mediaContentType: 'IMAGE';
-};
-type VideoMedia = Media & {
-    mediaContentType: 'VIDEO' | 'EXTERNAL_VIDEO';
-};
-interface VariantMedia {
-    productList: ImageMedia[];
-    sceneList: ImageMedia[];
-    videoList: VideoMedia[];
-}
-/**
- * Hook to get media for the selected variant
- *
- * @param product - The product object
- * @param variant - The selected variant
- * @returns Object with productList (first image), sceneList (other images), videoList
- *
- * @example
- * ```typescript
- * function ProductGallery() {
- *   const { data: product } = useProduct({ handle: 'my-product' })
- *   const [selectedOptions, setSelectedOptions] = useSelectedOptions(product)
- *   const variant = useVariant({ product, selectedOptions })
- *   const { productList, sceneList, videoList } = useVariantMedia({ product, variant })
- *
- *   return (
- *     <div>
- *       {/* Main product image *\/}
- *       {productList.map(media => (
- *         <img key={media.id} src={media.image?.url} alt={media.alt} />
- *       ))}
- *
- *       {/* Scene/detail images *\/}
- *       {sceneList.map(media => (
- *         <img key={media.id} src={media.image?.url} alt={media.alt} />
- *       ))}
- *
- *       {/* Videos *\/}
- *       {videoList.map(media => (
- *         <video key={media.id} src={media.sources?.[0]?.url} controls />
- *       ))}
- *     </div>
- *   )
- * }
- * ```
- */
-declare function useVariantMedia({ product, variant, }: {
-    product?: NormalizedProduct;
-    variant?: NormalizedProductVariant;
-}): VariantMedia;
-
-interface UseCollectionOptions extends SWRConfiguration<NormalizedCollection | undefined> {
-    handle?: string;
-    metafieldIdentifiers?: Array<{
-        namespace: string;
-        key: string;
-    }>;
-}
-declare function useCollection(options?: UseCollectionOptions): swr.SWRResponse<NormalizedCollection | undefined, any, SWRConfiguration<NormalizedCollection | undefined, any, ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedCollection | undefined>) | ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedCollection | undefined>)> | undefined>;
-
-interface UseAllCollectionsOptions extends SWRConfiguration<NormalizedCollection[]> {
-    first?: number;
-    query?: string;
-    sortKey?: 'TITLE' | 'UPDATED_AT' | 'ID' | 'RELEVANCE';
-    reverse?: boolean;
-    metafieldIdentifiers?: Array<{
-        namespace: string;
-        key: string;
-    }>;
-}
-declare function useAllCollections(options?: UseAllCollectionsOptions): swr.SWRResponse<NormalizedCollection[], any, SWRConfiguration<NormalizedCollection[], any, ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedCollection[]>) | ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedCollection[]>)> | undefined>;
-
-interface UseCollectionsOptions extends SWRConfiguration<CollectionsConnection> {
-    first?: number;
-    after?: string;
-    query?: string;
-    sortKey?: 'TITLE' | 'UPDATED_AT' | 'ID' | 'RELEVANCE';
-    reverse?: boolean;
-    metafieldIdentifiers?: Array<{
-        namespace: string;
-        key: string;
-    }>;
-}
-declare function useCollections(options?: UseCollectionsOptions): swr.SWRResponse<CollectionsConnection, any, SWRConfiguration<CollectionsConnection, any, ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<CollectionsConnection>) | ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<CollectionsConnection>)> | undefined>;
-
-interface UseBlogOptions extends SWRConfiguration<NormalizedBlog | undefined> {
-    handle?: string;
-    metafieldIdentifiers?: Array<{
-        namespace: string;
-        key: string;
-    }>;
-}
-declare function useBlog(options?: UseBlogOptions): swr.SWRResponse<NormalizedBlog | undefined, any, SWRConfiguration<NormalizedBlog | undefined, any, ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedBlog | undefined>) | ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedBlog | undefined>)> | undefined>;
-
-interface UseAllBlogsOptions extends SWRConfiguration<NormalizedBlog[]> {
-    first?: number;
-    query?: string;
-    metafieldIdentifiers?: Array<{
-        namespace: string;
-        key: string;
-    }>;
-}
-declare function useAllBlogs(options?: UseAllBlogsOptions): swr.SWRResponse<NormalizedBlog[], any, SWRConfiguration<NormalizedBlog[], any, ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedBlog[]>) | ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedBlog[]>)> | undefined>;
-
-interface UseArticleOptions extends SWRConfiguration<NormalizedArticle | undefined> {
-    blogHandle?: string;
-    articleHandle?: string;
-    metafieldIdentifiers?: Array<{
-        namespace: string;
-        key: string;
-    }>;
-}
-declare function useArticle(options?: UseArticleOptions): swr.SWRResponse<NormalizedArticle | undefined, any, SWRConfiguration<NormalizedArticle | undefined, any, ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedArticle | undefined>) | ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedArticle | undefined>)> | undefined>;
-
-interface UseArticlesOptions extends SWRConfiguration<NormalizedArticle[]> {
-    first?: number;
-    query?: string;
-    sortKey?: 'PUBLISHED_AT' | 'UPDATED_AT' | 'TITLE' | 'ID' | 'RELEVANCE';
-    reverse?: boolean;
-    metafieldIdentifiers?: Array<{
-        namespace: string;
-        key: string;
-    }>;
-}
-declare function useArticles(options?: UseArticlesOptions): swr.SWRResponse<NormalizedArticle[], any, SWRConfiguration<NormalizedArticle[], any, ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedArticle[]>) | ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedArticle[]>)> | undefined>;
-
-interface UseArticlesInBlogOptions extends SWRConfiguration<NormalizedArticle[]> {
-    blogHandle?: string;
-    first?: number;
-    sortKey?: 'PUBLISHED_AT' | 'UPDATED_AT' | 'TITLE' | 'ID' | 'RELEVANCE';
-    reverse?: boolean;
-    metafieldIdentifiers?: Array<{
-        namespace: string;
-        key: string;
-    }>;
-}
-declare function useArticlesInBlog(options?: UseArticlesInBlogOptions): swr.SWRResponse<NormalizedArticle[], any, SWRConfiguration<NormalizedArticle[], any, ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedArticle[]>) | ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<NormalizedArticle[]>)> | undefined>;
-
-type SearchResultType = 'ARTICLE' | 'PAGE' | 'PRODUCT';
-interface SearchResultItem {
-    type: SearchResultType;
-    id?: string;
-    handle?: string;
-    title?: string;
-    description?: string;
-    url?: string;
-    image?: {
-        url: string;
-        altText?: string;
-    };
-}
-interface SearchResult {
-    items: SearchResultItem[];
-    totalCount: number;
-    pageInfo?: {
-        hasNextPage: boolean;
-        endCursor?: string;
-    };
-}
-interface UseSearchOptions extends SWRConfiguration<SearchResult | undefined> {
-    query?: string;
-    first?: number;
-    types?: SearchResultType[];
-    productFilters?: any[];
-}
-declare function useSearch(options?: UseSearchOptions): swr.SWRResponse<SearchResult | undefined, any, SWRConfiguration<SearchResult | undefined, any, ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<SearchResult | undefined>) | ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<SearchResult | undefined>)> | undefined>;
-
-interface SiteInfo {
-    name: string;
-    description?: string;
-    primaryDomain: {
-        url: string;
-        host: string;
-    };
-    brand?: {
-        logo?: {
-            image?: {
-                url: string;
-            };
-        };
-        colors?: {
-            primary?: string;
-            secondary?: string;
-        };
-    };
-    metafields?: Record<string, any>;
-}
-interface UseSiteOptions extends SWRConfiguration<SiteInfo | undefined> {
-    metafieldIdentifiers?: Array<{
-        namespace: string;
-        key: string;
-    }>;
-}
-declare function useSite(options?: UseSiteOptions): swr.SWRResponse<SiteInfo | undefined, any, SWRConfiguration<SiteInfo | undefined, any, ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<SiteInfo | undefined>) | ((arg: readonly [any, ...unknown[]]) => swr__internal.FetcherResponse<SiteInfo | undefined>)> | undefined>;
-
-/**
- * useIntersection Hook
- *
- * Observes element visibility using IntersectionObserver API
- */
-
-interface UseIntersectionOptions {
-    /** Callback function when element becomes visible */
-    callback: () => void;
-    /** Only trigger callback once (default: false) */
-    once?: boolean;
-    /** Root element for intersection (default: viewport) */
-    root?: Element | null;
-    /** Margin around root (default: '0px') */
-    rootMargin?: string;
-    /** Visibility threshold 0-1 (default: 0.8) */
-    threshold?: number;
-}
-/**
- * Hook to observe element visibility with IntersectionObserver
- *
- * Triggers a callback when the target element becomes visible in the viewport
- *
- * @param targetRef - React ref to the target element
- * @param options - Intersection observer options
- *
- * @example
- * ```typescript
- * function LazyImage() {
- *   const imageRef = useRef<HTMLImageElement>(null)
- *   const [loaded, setLoaded] = useState(false)
- *
- *   useIntersection(imageRef, {
- *     callback: () => setLoaded(true),
- *     once: true,
- *     threshold: 0.5
- *   })
- *
- *   return (
- *     <img
- *       ref={imageRef}
- *       src={loaded ? actualSrc : placeholderSrc}
- *       alt="Lazy loaded"
- *     />
- *   )
- * }
- * ```
- */
-declare function useIntersection(targetRef: RefObject<Element> | undefined, options: UseIntersectionOptions): void;
-
-/**
- * useExposure Hook
- *
- * Tracks element exposure (visibility + duration) for analytics/tracking
- */
-
-interface UseExposureOptions {
-    /** Visibility threshold 0-1 (default: 0.5, meaning 50% visible) */
-    threshold?: number;
-    /** Duration in milliseconds element must be visible (default: 2000ms) */
-    duration?: number;
-    /** Only trigger callback once (default: true) */
-    once?: boolean;
-    /** Callback when element has been exposed for the required duration */
-    onExposure: () => void;
-}
-/**
- * Hook to track element exposure (visibility + duration threshold)
- *
- * Useful for tracking ad impressions, product views, or any analytics
- * that require an element to be visible for a certain duration
- *
- * @param targetRef - React ref to the target element
- * @param options - Exposure tracking options
- * @returns Current visibility state
- *
- * @example
- * ```typescript
- * function ProductCard({ product }) {
- *   const cardRef = useRef<HTMLDivElement>(null)
- *
- *   const isVisible = useExposure(cardRef, {
- *     threshold: 0.5,      // 50% visible
- *     duration: 2000,      // 2 seconds
- *     once: true,          // Only track once
- *     onExposure: () => {
- *       // Track product impression
- *       analytics.track('Product Viewed', {
- *         productId: product.id,
- *         productName: product.title
- *       })
- *     }
- *   })
- *
- *   return (
- *     <div ref={cardRef}>
- *       {product.title}
- *       {isVisible && <div className="viewing-indicator" />}
- *     </div>
- *   )
- * }
- * ```
- */
-declare function useExposure(targetRef: RefObject<Element>, options: UseExposureOptions): boolean;
-
-/**
- * useGeoLocation Hook
- *
- * Fetches and caches user's geographic location
- */
-
-interface GeoLocationData {
-    /** Geographic information */
-    geo: {
-        /** Country information */
-        country?: {
-            /** Country code (e.g., 'US', 'GB') */
-            code?: string;
-            /** Country name */
-            name?: string;
-        };
-        /** Region/state information */
-        region?: {
-            code?: string;
-            name?: string;
-        };
-        /** City name */
-        city?: string;
-        /** Coordinates */
-        latitude?: number;
-        longitude?: number;
-        /** Timezone */
-        timezone?: string;
-    };
-    /** Suggested locale based on location */
-    suggestLocale?: string;
-}
-interface LocaleMapping {
-    /** Countries that should map to EU locale */
-    euCountries?: string[];
-    /** Countries that should map to DE locale */
-    deCountries?: string[];
-    /** Countries that should map to AU locale */
-    auCountries?: string[];
-    /** Countries that should map to AE-EN locale */
-    aeEnCountries?: string[];
-    /** Custom country to locale mapping */
-    customMapping?: Record<string, string>;
-}
-interface UseGeoLocationOptions extends SWRConfiguration<GeoLocationData | undefined> {
-    /** API endpoint for fetching geo data (default: '/geolocation') */
-    endpoint?: string;
-    /** Cache key for localStorage (default: 'geoLocation') */
-    cacheKey?: string;
-    /** Cache duration in milliseconds (default: 24 hours) */
-    cacheDuration?: number;
-    /** Locale mapping configuration */
-    localeMapping?: LocaleMapping;
-    /** Enable automatic caching (default: true) */
-    enableCache?: boolean;
-}
-/**
- * Hook to fetch and cache user's geographic location
- *
- * Fetches geo data from an API endpoint and caches it in localStorage
- * Automatically determines suggested locale based on country
- *
- * @param options - Geo location options
- * @returns SWR response with geo location data
- *
- * @example
- * ```typescript
- * function LocaleSwitcher() {
- *   const { data: geoData, error, isLoading } = useGeoLocation({
- *     endpoint: '/api/geolocation',
- *     localeMapping: {
- *       euCountries: ['FR', 'DE', 'IT', 'ES'],
- *       auCountries: ['AU', 'NZ']
- *     }
- *   })
- *
- *   if (isLoading) return <div>Loading...</div>
- *   if (error) return <div>Error loading location</div>
- *
- *   return (
- *     <div>
- *       <p>Country: {geoData?.geo.country?.code}</p>
- *       <p>Suggested Locale: {geoData?.suggestLocale}</p>
- *     </div>
- *   )
- * }
- * ```
- *
- * @example
- * ```typescript
- * // With custom locale mapping
- * const { data } = useGeoLocation({
- *   localeMapping: {
- *     customMapping: {
- *       'JP': 'ja',
- *       'CN': 'zh-cn',
- *       'TW': 'zh-tw'
- *     }
- *   }
- * })
- * ```
- */
-declare function useGeoLocation(options?: UseGeoLocationOptions): ReturnType<typeof swr__default<GeoLocationData | undefined>>;
-/**
- * Get cached geo location data without fetching
- *
- * @param cacheKey - Cache key (default: 'geoLocation')
- * @returns Cached geo data or undefined
- *
- * @example
- * ```typescript
- * const cachedGeo = getCachedGeoLocation()
- * if (cachedGeo) {
- *   console.log('Country:', cachedGeo.geo.country?.code)
- * }
- * ```
- */
-declare function getCachedGeoLocation(cacheKey?: string): GeoLocationData | undefined;
-/**
- * Clear cached geo location data
- *
- * @param cacheKey - Cache key (default: 'geoLocation')
- *
- * @example
- * ```typescript
- * clearGeoLocationCache()
- * ```
- */
-declare function clearGeoLocationCache(cacheKey?: string): void;
-
-export { PriceBasePriceType as $, type AddCartLinesInput as A, type BuyNowInput as B, type CreateCartInput as C, type DiscountLabel as D, type Config as E, type GiftTier as F, type GiftProduct as G, type RewardItem as H, type GiftProductItem as I, RuleType as J, BuyRuleType as K, type FunctionGiftResult as L, type MainProductInfo as M, type FormattedGift as N, type OrderDiscountResult as O, type CartLineInput as P, type AutoFreeGiftItem as Q, type RemoveCartLinesInput as R, SpendMoneyType as S, type AutoFreeGiftList as T, type UpdateCartAttributesInput as U, type VariantItem as V, OrderDiscountType as W, OrderBasePriceType as X, type TieredDiscount as Y, type OrderDiscountConfig as Z, PriceDiscountType as _, useAddCartLines as a, type ShippingMethodsContext as a$, type PriceDiscountConfig as a0, currencyCodeMapping as a1, defaultSWRMutationConfiguration as a2, CUSTOMER_ATTRIBUTE_KEY as a3, CUSTOMER_SCRIPT_GIFT_KEY as a4, CODE_AMOUNT_KEY as a5, SCRIPT_CODE_AMOUNT_KEY as a6, MAIN_PRODUCT_CODE as a7, getQuery as a8, atobID as a9, type VideoMedia as aA, type VariantMedia as aB, useVariantMedia as aC, type UseCollectionOptions as aD, useCollection as aE, type UseAllCollectionsOptions as aF, useAllCollections as aG, type UseCollectionsOptions as aH, useCollections as aI, type UseBlogOptions as aJ, useBlog as aK, type UseAllBlogsOptions as aL, useAllBlogs as aM, type UseArticleOptions as aN, useArticle as aO, type UseArticlesOptions as aP, useArticles as aQ, type UseArticlesInBlogOptions as aR, useArticlesInBlog as aS, type SearchResultType as aT, type SearchResultItem as aU, type SearchResult as aV, type UseSearchOptions as aW, useSearch as aX, type SiteInfo as aY, type UseSiteOptions as aZ, useSite as a_, btoaID as aa, normalizeAddToCartLines as ab, createMockCartFromLines as ac, getMatchedMainProductSubTotal as ad, safeParse as ae, getDiscountEnvAttributeValue as af, checkAttributesUpdateNeeded as ag, preCheck as ah, formatScriptAutoFreeGift as ai, formatFunctionAutoFreeGift as aj, useSelectedOptions as ak, type SelectedOptionsResult as al, type UseProductOptions as am, useProduct as an, type UseAllProductsOptions as ao, useAllProducts as ap, type UseProductsByHandlesOptions as aq, useProductsByHandles as ar, type Options as as, useVariant as at, type UsePriceOptions as au, type UsePriceResult as av, usePrice as aw, useProductUrl as ax, useUpdateVariantQuery as ay, type ImageMedia as az, useUpdateCartLines as b, type PlusMemberContextValue as b0, PlusMemberContext as b1, usePlusMemberContext as b2, usePlusMonthlyProductVariant as b3, usePlusAnnualProductVariant as b4, type UseShippingMethodsOptions as b5, type UseShippingMethodsResult as b6, useShippingMethods as b7, useShippingMethodAvailableCheck as b8, useReplaceCartPlusMember as b9, type Image as bA, type Measurement as bB, type ExportSelectedOption as bC, type ExportProductVariant as bD, type ExportDiscountAllocations as bE, type ExportLineItem as bF, type ExportDiscounts as bG, type ExportCart as bH, usePlusMemberDeliveryCodes as ba, usePlusMemberItemCustomAttributes as bb, type CustomerOrder as bc, type Customer as bd, usePlusMemberCheckoutCustomAttributes as be, type UseAutoRemovePlusMemberInCartProps as bf, useAutoRemovePlusMemberInCart as bg, type UseHasPlusMemberInCartProps as bh, type HasPlusMemberInCartResult as bi, useHasPlusMemberInCart as bj, type UseAddPlusMemberProductsToCartProps as bk, useAddPlusMemberProductsToCart as bl, type PlusMemberProviderProps as bm, PlusMemberProvider as bn, type UseIntersectionOptions as bo, useIntersection as bp, type UseExposureOptions as bq, useExposure as br, type GeoLocationData as bs, type LocaleMapping as bt, type UseGeoLocationOptions as bu, useGeoLocation as bv, getCachedGeoLocation as bw, clearGeoLocationCache as bx, type Attribute as by, type Discount as bz, useRemoveCartLines as c, type ApplyCartCodesInput as d, useApplyCartCodes as e, type RemoveCartCodesInput as f, useRemoveCartCodes as g, useUpdateCartAttributes as h, type UseBuyNowOptions as i, useBuyNow as j, useCalcAutoFreeGift as k, type UseCalcGiftsFromLinesOptions as l, type UseCalcGiftsFromLinesResult as m, useCalcGiftsFromLines as n, useCalcOrderDiscount as o, getReferralAttributes as p, useCartAttributes as q, useCartItemQuantityLimit as r, type UseScriptAutoFreeGiftResult as s, useScriptAutoFreeGift as t, useCreateCart as u, useUpdateLineCodeAmountAttributes as v, type AutoFreeGift as w, type AutoFreeGiftMainProduct as x, type AutoFreeGiftConfig as y, type RuleCondition as z };