@anker-in/shopify-react 0.1.1-beta.0

package/dist/types-CMA6_FML.d.mts

@@ -0,0 +1,550 @@
+import { NormalizedCart, NormalizedProduct, NormalizedProductVariant } from '@anker-in/shopify-sdk';
+
+/**
+ * Tracking Types
+ * Type definitions for analytics and tracking
+ */
+
+interface TrackingLineItem {
+    variant?: {
+        id: string;
+        sku?: string;
+        title?: string;
+        name?: string;
+        price?: {
+            amount: string;
+            currencyCode: string;
+        };
+        finalPrice?: {
+            amount: string;
+        };
+        product?: {
+            title?: string;
+            name?: string;
+            vendor?: string;
+            productType?: string;
+            metafields?: {
+                global?: {
+                    trafficType?: string;
+                };
+            };
+        };
+    };
+    quantity?: number;
+    finalPrice?: {
+        amount: string;
+    };
+}
+interface GtmParams {
+    pageGroup?: string;
+    position?: string;
+    brand?: string;
+    ga4Params?: Record<string, any>;
+}
+interface TrackingOptions {
+    /** Enable Google Analytics tracking */
+    enableGA?: boolean;
+    /** Enable Facebook Pixel tracking */
+    enableFBQ?: boolean;
+    /** GTM parameters */
+    gtmParams?: GtmParams;
+    /** Brand name for tracking */
+    brand?: string;
+}
+interface TrackingAdapter {
+    /** Track add to cart event */
+    trackAddToCart?: (params: {
+        cart: NormalizedCart;
+        lineItems: TrackingLineItem[];
+        gtmParams?: GtmParams;
+        brand?: string;
+    }) => void;
+    /** Track remove from cart event */
+    trackRemoveFromCart?: (params: {
+        cart: NormalizedCart;
+        lineItems: TrackingLineItem[];
+        gtmParams?: GtmParams;
+        brand?: string;
+    }) => void;
+    /** Track begin checkout event */
+    trackBeginCheckout?: (params: {
+        cart: NormalizedCart;
+        gtmParams?: GtmParams;
+        brand?: string;
+    }) => void;
+}
+
+/**
+ * Google Analytics Tracking
+ * GA4 event tracking utilities
+ */
+
+declare global {
+    interface Window {
+        dataLayer?: any[];
+        gtag?: (...args: any) => void;
+    }
+}
+/**
+ * Push event to GA4 dataLayer
+ */
+declare const gaTrack: (data: any) => void;
+/**
+ * Track add to cart event in GA4
+ */
+declare const trackAddToCartGA: ({ lineItems, gtmParams, brand, }: {
+    lineItems: TrackingLineItem[];
+    gtmParams?: GtmParams;
+    brand?: string;
+}) => void;
+/**
+ * Track begin checkout event in GA4
+ */
+declare const trackBeginCheckoutGA: ({ lineItems, currencyCode, totalPrice, gtmParams, brand, }: {
+    lineItems: TrackingLineItem[];
+    currencyCode?: string;
+    totalPrice?: number;
+    gtmParams?: GtmParams;
+    brand?: string;
+}) => void;
+/**
+ * Track buy now event in GA4
+ * This triggers begin_checkout event for buy now actions
+ */
+declare const trackBuyNowGA: ({ lineItems, gtmParams, brand, }: {
+    lineItems: TrackingLineItem[];
+    gtmParams?: GtmParams;
+    brand?: string;
+}) => void;
+
+/**
+ * Facebook Pixel Tracking
+ * FBQ event tracking utilities
+ */
+
+declare global {
+    interface Window {
+        fbq?: (...args: any[]) => void;
+        gtag?: (...args: any[]) => void;
+    }
+}
+/**
+ * Track add to cart event in Facebook Pixel
+ */
+declare const trackAddToCartFBQ: ({ lineItems }: {
+    lineItems: TrackingLineItem[];
+}) => void;
+/**
+ * Configuration for Buy Now tracking events
+ */
+interface BuyNowTrackConfig {
+    /** Google Tag ID */
+    gtagId?: string;
+    /** Facebook Pixel custom event name */
+    fbqBuyNowEvent?: string;
+    /** Google Tag conversion label */
+    gtagBuyNowLabel?: string;
+    /** Google Tag conversion action (default: 'conversion') */
+    gtagBuyNowConversion?: string;
+}
+/**
+ * Track buy now event in Facebook Pixel and Google Tag
+ */
+declare const trackBuyNowFBQ: ({ trackConfig }: {
+    trackConfig?: BuyNowTrackConfig;
+}) => void;
+
+/**
+ * Plus Member Types
+ * Type definitions for Plus Member functionality
+ */
+
+declare enum PLUS_MEMBER_TYPE {
+    FREE = 0,// 免费会员
+    MONTHLY = 1,// 月费会员
+    ANNUAL = 2
+}
+declare enum PlusMemberMode {
+    MONTHLY = "monthly",
+    ANNUAL = "annual"
+}
+declare enum DeliveryPlusType {
+    FREE = "free",
+    MONTHLY = "monthly",
+    ANNUAL = "annual"
+}
+declare enum ShippingMethodMode {
+    FREE = "free",
+    TDD = "tdd",
+    NDD = "ndd"
+}
+type PlusMemberShippingMethodMetafields = {
+    __mode: ShippingMethodMode;
+    __code: string;
+    title: string;
+    subtitle: string;
+    price: number;
+    weight_low?: number | null;
+    weight_high?: number | null;
+    __plus?: boolean;
+};
+type PlusMemberShippingMethodConfig = PlusMemberShippingMethodMetafields & {
+    id: string;
+    disabled?: boolean;
+    useCoupon?: boolean;
+    coupon?: string;
+};
+type PlusMemberSettingsMetafields = {
+    join_member: string;
+    join_plus_member: string;
+    member_extra: string;
+    member_price: string;
+    plus_member_price: string;
+    will_save: string;
+    total_save: string;
+    with_member: string;
+    with_plus_member: string;
+    save_with_plus: string;
+    discount_box: {
+        plus_member: string;
+        money: string;
+        month: string;
+        saving: string;
+        worth: string;
+        other: string;
+    };
+    plus_monthly_product: {
+        handle: string;
+        sku: string;
+    };
+    plus_annual_product: {
+        handle: string;
+        sku: string;
+    };
+    thank: {
+        success: {
+            title: string;
+            line1: string;
+            line2: string;
+            button: string;
+            link_text: string;
+            link: string;
+        };
+        warn: {
+            title: string;
+        };
+        error: {
+            title: string;
+            button: string;
+        };
+    };
+    agreeBox: {
+        text: string;
+        error_text: string;
+    };
+    shippingMethod: {
+        cancelCodeTip: string;
+        addCodeTip: string;
+        overWeight_ndd: number;
+        overWeight_tdd: number;
+        overWeight_ndd_tip: string;
+        specialTip: string;
+        learnMore: string;
+        specialModal: Array<{
+            title_del: string;
+            content: string;
+        }>;
+    };
+    cart: {
+        tip: string;
+        credits_times: number;
+        title: string;
+        subtitle: string;
+    };
+    plus_member: {
+        title: string;
+        box: {
+            title: string;
+            description: string;
+            learn_more: string;
+            trade_desc?: string;
+        };
+        type: Array<{
+            title: string;
+            subtitle: string;
+            __mode: DeliveryPlusType;
+            save?: string;
+            price?: string;
+            compare_price?: string;
+            tagImg?: string;
+        }>;
+    };
+    member_benefits: {
+        title: string;
+        subtitle: string;
+        list: Array<{
+            icon: string;
+            title: string;
+            subtitle: string;
+        }>;
+        annually: {
+            title: string;
+            list: Array<{
+                icon: string;
+                title: string;
+                subtitle: string;
+            }>;
+        };
+        ankerCredits: {
+            text: string;
+            url: string;
+        };
+    };
+    shipping_policy: {
+        title: string;
+        shipping_coupon: {
+            title: string;
+            list: string[];
+        };
+        shipping_service: {
+            title: string;
+            list: Array<{
+                title: string;
+                list: string[];
+            }>;
+        };
+        terms: {
+            text: string;
+            url: string;
+        };
+    };
+    shipping_check: {
+        title: string;
+        label: string;
+        placeholder: string;
+        cancel: string;
+        available: string;
+        here: {
+            text: string;
+            url: string;
+        };
+        save: string;
+        apply: string;
+    };
+    plus_shipping: {
+        title: string;
+        policy: string;
+        more_option: string;
+        view_less: string;
+        buy_directly: string;
+        used_up_all: string;
+        used_up_ndd: string;
+        delivers_to: string;
+        edit: string;
+        out_ndd_shipping: string;
+        out_tdd_shipping: string;
+        plus: string;
+        directly: string;
+        shipping_methods: PlusMemberShippingMethodMetafields[];
+    };
+    shipping: {
+        shipping_benefits: string;
+        shipping_address: string;
+        seeAvailableShippingAreas: string;
+        modify: string;
+        enter: string;
+        click: string;
+        fill: string;
+        plus: string;
+        use_coupon: string;
+        no_coupon: string;
+        get_address: string;
+        confirm: string;
+        shipping_not_support: string;
+        faq_link: string;
+        fields: Array<{
+            __key: string;
+            required: boolean;
+            title: string;
+            placeholder: string;
+        }>;
+        shipping_methods: Array<{
+            __mode: string;
+            __code: string;
+            title: string;
+            subtitle: string;
+            tip?: string;
+            outRange?: string;
+            rule?: {
+                '<22': number;
+                '>=22': number;
+            };
+            __weight?: string;
+        }>;
+        join_member: {
+            join: string;
+            text: string;
+            tip: string;
+        };
+        discount_not_support_address: string;
+    };
+    listingEntryCard: {
+        showEntry: boolean;
+        EntryCardBgi: string;
+        EntryCardMobBgi: string;
+        EntryCardPadBgi: string;
+        EntryCardSmBgi: string;
+        EntryCardicon: string;
+        EntryCardtitle: string;
+        EntryCardcontent: string;
+        EntryCardbuttonText: string;
+    };
+    noLogin: {
+        recommend: string;
+        content: Array<{
+            title: string;
+            list: Array<{
+                icon: string;
+                recommend: boolean;
+                title: string;
+                description: string;
+                subTitle?: string;
+            }>;
+            note?: string;
+        }>;
+        head: {
+            img: string;
+            padImg: string;
+            mobImg: string;
+            title: string;
+            mobTitle: string;
+            pay: string;
+            subTitle: string;
+            icon: string;
+        };
+        headAnnual: {
+            img: string;
+            padImg: string;
+            mobImg: string;
+            title: string;
+            pay: string;
+            subTitle: string;
+            icon: string;
+        };
+        main: {
+            title: string;
+        };
+    };
+    loginedExpiredMember: {
+        content: Array<{
+            img: string;
+            mobImg: string;
+            text: string;
+        }>;
+        head: {
+            img: string;
+            mobImg: string;
+            title: string;
+            subTitle: string;
+        };
+        main: {
+            text: string;
+            title: string;
+        };
+    };
+    loginedFreeMember: {
+        table: Array<{
+            plus: string;
+            normal: string;
+            plusColor: string;
+            normalColor: string;
+        }>;
+        tableTab: {
+            tab1: string;
+            tab2: string;
+            tab3: string;
+        };
+        head: {
+            img: string;
+            mobImg: string;
+            padImg: string;
+            icon: string;
+            title: string;
+            mobTitle: string;
+            pay: string;
+            subTitle: string;
+        };
+        headAnnual: {
+            img: string;
+            mobImg: string;
+            padImg: string;
+            icon: string;
+            title: string;
+            pay: string;
+            subTitle: string;
+        };
+        midTitle: string;
+    };
+    memberCard: {
+        header: {
+            text: string;
+        };
+        footer: {
+            buttonText: string[];
+            moreInformation: string;
+            moreInformationUrl: string;
+        };
+    };
+    memberRegisterCard: {
+        title: string;
+        bannerBgPc: string;
+        bannerBgMob: string;
+        backgroundColor: string;
+    };
+    memberSuperposed: {
+        title: string;
+        content: string;
+        cancelBtn: string;
+        confirmBtn: string;
+        monthly: string;
+        annual: string;
+    };
+    memberCannotSuperposed: {
+        title: string;
+        content: string;
+        confirmBtn: string;
+    };
+};
+type SelectedPlusMemberProduct = {
+    product: NormalizedProduct;
+    variant: NormalizedProductVariant;
+} | null;
+type DeliveryOption = string;
+type DeliveryCustomData = {
+    discount_code?: string[];
+    allow_nextday_delivery?: boolean;
+    allow_thirdday_delivery?: boolean;
+    selected_delivery_option?: DeliveryOption;
+    is_presale?: boolean;
+    plus_type?: DeliveryPlusType;
+};
+type MailingAddress = {
+    address1?: string | null;
+    address2?: string | null;
+    city?: string | null;
+    company?: string | null;
+    country?: string | null;
+    countryCode?: string | null;
+    firstName?: string | null;
+    lastName?: string | null;
+    phone?: string | null;
+    province?: string | null;
+    provinceCode?: string | null;
+    zip?: string | null;
+};
+type DeliveryData = {
+    deliveryAddress: MailingAddress;
+    deliveryCustomData: DeliveryCustomData;
+};
+
+export { type BuyNowTrackConfig as B, DeliveryPlusType as D, type GtmParams as G, type MailingAddress as M, PLUS_MEMBER_TYPE as P, ShippingMethodMode as S, type TrackingLineItem as T, PlusMemberMode as a, type PlusMemberShippingMethodMetafields as b, type PlusMemberShippingMethodConfig as c, type PlusMemberSettingsMetafields as d, type SelectedPlusMemberProduct as e, type DeliveryOption as f, type DeliveryCustomData as g, type DeliveryData as h, type TrackingOptions as i, type TrackingAdapter as j, gaTrack as k, trackBeginCheckoutGA as l, trackBuyNowGA as m, trackAddToCartFBQ as n, trackBuyNowFBQ as o, trackAddToCartGA as t };