@anker-in/campaign-ui 0.2.10-beta.2 → 0.2.10-beta.20

package/dist/index.d.ts

@@ -0,0 +1,494 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import React from 'react';
+export { useCopilotAction, useCopilotChat, useCopilotReadable } from '@copilotkit/react-core';
+export { ActionExecutionMessage, Role, TextMessage } from '@copilotkit/runtime-client-gql';
+import * as swr_mutation from 'swr/mutation';
+export * from '@anker-in/shopify';
+
+interface ChatProps {
+    title: string;
+    runtimeUrl: string;
+    shopifyDomain: string;
+    /** GA 的 client id
+     */
+    userId: string;
+    /** 是否登陆用户 0 or 1
+     */
+    account?: string;
+    /** 用户浏览器语言
+     */
+    locale?: string;
+    /** 开场白
+     */
+    prologue?: string;
+    /** ?a=1&b=2
+     */
+    query?: string;
+    /** 'follow' or 'unfollow' | true or false
+     * follow: ResponseButton 会跟随在 messages 的后边
+     * unfollow: ResponseButton 在聊天框底部
+     */
+    showResponseButton?: string | boolean;
+    /** messages 的回调事件
+     * 每次生成/接受新的messages，会将 整个 messages list 传递给外部
+     */
+    messagesCallback?: (_messages: any) => void;
+    /** 通用 action 的触发事件
+     */
+    commonRender?: string | ((_props: any) => React.ReactElement);
+    /** shulex的 action 的触发事件
+     */
+    shulexRender?: string | ((_props: any) => React.ReactElement);
+    /** 通用 积分 换 Coupon 的触发事件
+     */
+    pointsExchangeCouponRender?: string | ((_props: any) => React.ReactElement);
+    /** 跳转 checkout action 卡片，接受参数： {"status":"complete","args":[{"sku":["A3936031"],"handle":"space-a40-a3936031"}],"result":""}
+     * 后端接口文档：https://anker-in.feishu.cn/wiki/DOYJwE9oxipWmYk072ncnJNznBb
+     */
+    gotocheckoutRender?: string | ((_props: any) => React.ReactElement);
+    /** 打开购物车 action 卡片，接受参数： {"status":"complete","args":[{"sku":["A3936031"],"handle":"space-a40-a3936031"}],"result":""}
+     * 后端接口文档：https://anker-in.feishu.cn/wiki/DOYJwE9oxipWmYk072ncnJNznBb
+     */
+    gotocartRender?: string | ((_props: any) => React.ReactElement);
+    /** 打开购物车 action 的触发事件
+     */
+    addtocartHandler?: (_args: any) => Promise<any>;
+    /** 加购卡片，接受参数： {"status":"complete","args":[{"sku":["A3936031"],"handle":"space-a40-a3936031"}],"result":""}
+     * 后端接口文档：https://anker-in.feishu.cn/wiki/DOYJwE9oxipWmYk072ncnJNznBb
+     */
+    addtocartRender?: string | ((_props: any) => React.ReactElement);
+    /** 订阅卡片，接受参数： {"status":"complete","args":[{"sku":["A3936031"],"handle":"space-a40-a3936031"}],"result":""}
+     * 后端接口文档：https://anker-in.feishu.cn/wiki/DOYJwE9oxipWmYk072ncnJNznBb
+     */
+    signupRender?: string | ((_props: any) => React.ReactElement);
+    /** 产品卡片，接受参数： {"status":"complete","args":[{"sku":["A3936031"],"handle":"space-a40-a3936031"}],"result":""}
+     * 后端接口文档：https://anker-in.feishu.cn/wiki/DOYJwE9oxipWmYk072ncnJNznBb
+     */
+    productRender?: string | ((_props: any) => React.ReactElement);
+    /** CopilotPopup 自定义参数，参考：https://docs.copilotkit.ai/reference/components/CopilotPopup */
+    popup?: any;
+    /** 文案，{"productRenderTipMessage": "","popupTip": "Hi ! Welcome to soundcore Innovations live chat！", "popupTipTimeout": [3000, 6000]} */
+    lang?: any;
+    /** 参考此文档：https://docs.copilotkit.ai/concepts/customize-look-and-feel */
+    style?: any;
+    className?: string;
+}
+declare const Chat: (props: ChatProps) => react_jsx_runtime.JSX.Element;
+
+declare enum ConsumeType {
+    Coupon = "coupon",
+    GiftCard = "giftCard",
+    GoGift = "goGift",
+    Product = "product"
+}
+declare enum DTC_TASK_TYPE {
+    FirstPurchase = "firstPurchase",
+    UploadReceipt = "uploadReceipt",
+    Shopping = "shopping"
+}
+
+interface BaseResponse {
+    brand: string;
+}
+interface CreditInfoResponse extends BaseResponse {
+    total_credit: number;
+    available_credit: number;
+    pending_credit: number;
+    expired_credit: number;
+    cancel_credit: number;
+    consumed_credit: number;
+}
+
+declare function CreditsProvider({ children, profile, removeProfile, isLoadingProfile, openSignInPopup, openSignUpPopup, taskIdToTypeMapping, creditInfo, customer, customerLoading, fetchCreditInfo, gtm, }: {
+    children: React.ReactNode;
+    profile: any;
+    removeProfile: () => void;
+    isLoadingProfile: boolean;
+    openSignInPopup: () => void;
+    openSignUpPopup: () => void;
+    taskIdToTypeMapping: Record<string, DTC_TASK_TYPE>;
+    creditInfo?: CreditInfoResponse;
+    customer: any;
+    fetchCreditInfo: (user_id: string) => void;
+    customerLoading: boolean;
+    gtm: {
+        pageGroup: string;
+    };
+}): react_jsx_runtime.JSX.Element;
+declare function useCreditsContext(): {
+    profile: any;
+    isLoadingProfile: boolean;
+    removeProfile: () => void;
+    taskIdToTypeMapping: Record<string, DTC_TASK_TYPE>;
+    openSignInPopup: () => void;
+    openSignUpPopup: () => void;
+    creditInfo?: CreditInfoResponse;
+    customer?: any;
+    customerLoading: boolean;
+    fetchCreditInfo: (user_id: string) => void;
+    gtm: {
+        pageGroup: string;
+    };
+};
+
+declare const useUploadReceipt: () => swr_mutation.SWRMutationResponse<{
+    ok: boolean;
+    code: number;
+}, any, "/api/multipass/mktsrv/v1/credit/upload_third_party_order", {
+    orderName: string;
+}>;
+
+type ReceiptCopy = {
+    title: string;
+    description: string;
+    placeholder: string;
+    note: string;
+    submit: string;
+    successTitle: string;
+    successDescription: string;
+    gotIt: string;
+    failedTitle: string;
+    successIcon: string;
+    failedIcon: string;
+    failedReasons: {
+        code: string;
+        id: string;
+        description: string;
+    }[];
+};
+declare function CreditsUploadReceiptModal({ isOpen, onClose, copy, onSuccess, }: {
+    isOpen: boolean;
+    onClose: () => void;
+    copy: ReceiptCopy;
+    onSuccess: () => void;
+}): react_jsx_runtime.JSX.Element;
+
+type Img = {
+    url: string;
+    alt: string;
+};
+type BannerProps = {
+    copy: {
+        pcImg: Img;
+        laptopImg: Img;
+        mobileImg: Img;
+        joinNow: string;
+        loginIn: string;
+        login: {
+            title: string;
+            description: string;
+        };
+        unLogin: {
+            title: string;
+            description: string;
+        };
+    };
+};
+declare function CreditsBanner({ copy }: BannerProps): react_jsx_runtime.JSX.Element;
+
+interface BenefitItemCopy {
+    icon: {
+        alt: string;
+        url: string;
+    };
+    text: string;
+    note?: string;
+    tag?: string;
+}
+
+interface CreditsBenefitsProps {
+    copy: {
+        title: string;
+        benefits: BenefitItemCopy[];
+    };
+}
+declare const CreditsBenefits: ({ copy }: CreditsBenefitsProps) => react_jsx_runtime.JSX.Element;
+
+interface MyRewardsMetafields {
+    title: string;
+    orderNumberLabel: string;
+    valueLabel: string;
+    receivedLabel: string;
+    failedLabel: string;
+    approveSuccessLabel: string;
+    couponTab: string;
+    productTab: string;
+    pendingLabel: string;
+    unfulfilledLabel: string;
+    fulfilledLabel: string;
+    confirmedTip: string;
+    pendingTip: string;
+    processingTip: string;
+    ShippedTip: string;
+    emptyListLabel: string;
+    pointUnit: string;
+    code: string;
+    copied: string;
+    copy: string;
+    emptyListImage: {
+        url: string;
+        alt?: string;
+    };
+}
+
+interface MyActivitiesMetafields {
+    title: string;
+    tips: string;
+    allTab: string;
+    earnedTab: string;
+    deductedTab: string;
+    expiredTab: string;
+    activationTask: string;
+    updateNameTask: string;
+    updatePhoneTask: string;
+    updateBirthdayTask: string;
+    updateAppNameTask: string;
+    subscriptionTask: string;
+    refundTask: string;
+    productUnApprovedTask: string;
+    pendingTips?: string;
+    pendingTips2?: string;
+    firstPurchaseTask: string;
+    uploadReceiptTask: string;
+    shoppingTask: string;
+    emptyListImage: {
+        url: string;
+        alt?: string;
+    };
+    emptyListLabel: string;
+}
+
+type ButtonConfig = {
+    text: string;
+    type: 'activities' | 'rewards';
+};
+interface InfoCardProps {
+    data: {
+        balanceLabel: string;
+        comingSoonLabel: string;
+        comingSoonTips: string;
+        buttons: ButtonConfig[];
+        pointUnit: string;
+        infoIcon: string;
+        myActivities: MyActivitiesMetafields;
+        myRewards: MyRewardsMetafields;
+    };
+}
+declare function CreditsInfoCard({ data }: InfoCardProps): react_jsx_runtime.JSX.Element;
+
+type BenefitItem = {
+    title: string;
+    credits: string;
+    id: string;
+};
+type WaysToGetCreditsCopy = {
+    title: string;
+    subtitle: string;
+    equalCredits: string;
+    musicIcon: string;
+    list: BenefitItem[];
+    mainImage: {
+        url: string;
+        alt: string;
+    };
+    joinNow: string;
+    activate: string;
+    completed: string;
+    completeProfile: string;
+    makeFirstPurchase: string;
+    goShopLink: string;
+    uploadReceipt: string;
+    shopNow: string;
+    subscribe: string;
+    sendEmailSuccess: string;
+    creditsIcon: {
+        url: string;
+        alt: string;
+    };
+    receipt: ReceiptCopy;
+};
+type CreditsWaysToGetCreditsProps = {
+    copy: WaysToGetCreditsCopy;
+    classNames?: {
+        equalCreditsText?: string;
+        subtitle?: string;
+    };
+    activate: {
+        openAuthCodePopup: () => void;
+        isSuccess: boolean;
+        isSendingActivateEmail: boolean;
+    };
+    subscribe: {
+        openSubscribePopup: () => void;
+        isSuccess: boolean;
+    };
+    uploadReceipt: {
+        openUploadReceiptPopup: () => void;
+        isSuccess: boolean;
+    };
+};
+
+declare const CreditsWaysToGetCredits: ({ copy, activate, subscribe, uploadReceipt, classNames, }: CreditsWaysToGetCreditsProps) => react_jsx_runtime.JSX.Element;
+
+type FaqCopy = {
+    title: string;
+    subTitle: string;
+    learnMore: {
+        link: string;
+        label: string;
+    };
+    items: {
+        category_name: string;
+        question: string;
+        answer: string;
+    }[];
+};
+declare const CreditsFaq: ({ copy }: {
+    copy: FaqCopy;
+}) => react_jsx_runtime.JSX.Element;
+
+type RedeemableItemConfig = {
+    title: string;
+    desc: string;
+    price: string;
+    credit: string;
+    rules: string;
+    image: {
+        url: string;
+    };
+    mobileImage: {
+        url: string;
+    };
+    redeemId: number;
+};
+type CreditsCashCopy = {
+    title: string;
+    list: (RedeemableItemConfig & {
+        products: {
+            handle: string;
+            sku: string;
+        }[];
+    })[];
+    soldOut: string;
+    ruleLabel: string;
+    unlockRewards: string;
+    btnRedeem: string;
+    off: string;
+    insufficientCredits: string;
+};
+
+declare const CreditsCash: ({ copy, className, hideTitle, cardClassName, authCodeActivate, }: {
+    copy: CreditsCashCopy;
+    className?: string;
+    hideTitle?: boolean;
+    cardClassName?: string;
+    authCodeActivate: {
+        openAuthCodePopup: Function;
+        isSuccess: boolean;
+        setOnSuccess: (arg: Function) => void;
+        isSendingActivateEmail: boolean;
+    };
+}) => react_jsx_runtime.JSX.Element;
+
+type CreditsPageCommon = {
+    pointUnit: string;
+    ruleLabel: string;
+    soldOut: string;
+    imageMapping: {
+        [key in ConsumeType]: {
+            url: string;
+        };
+    };
+};
+
+type CreditsRedeemListCopy = {
+    title: string;
+    giftCardLabel: string;
+    unlockRewards: string;
+    btnRedeem: string;
+    list: {
+        label: string;
+        list: {
+            id: string;
+            type: string;
+            value: string;
+            rules: string[];
+        }[];
+    }[];
+    validatorInfo: {
+        addressInfo: {
+            name: string;
+            country: string;
+            province: string;
+            city: string;
+            address: string;
+        };
+    };
+    redeemModal: {
+        confirmTitle: string;
+        confirmButton: string;
+        commonError: string;
+        redeemLimitError: string;
+        inventoryNotEnough: string;
+        creditsNotEnough: string;
+        crossSiteError: string;
+        errorImageUrl: string;
+        coupon: {
+            successDesc: string;
+            successTitle: string;
+            successButton: string;
+            successButtonUrl: string;
+        };
+        product: {
+            required: string;
+            invalidEmail: string;
+            shippingAddress: string;
+            shippingProduct: string;
+            addressForm: {
+                key: string;
+                type: string;
+                label: string;
+                isSelect: boolean;
+                required: boolean;
+                placeholder: string;
+            }[][];
+            form: {
+                key: string;
+                type: string;
+                isSelect: boolean;
+                required: boolean;
+                placeholder: string;
+            }[][];
+            successDesc: string[];
+            rules: string[];
+            steps: {
+                imageUrl: string;
+                title: string;
+            }[];
+            quantityLabel: string;
+            totalPriceLabel: string;
+            variantLabel: string;
+            shippingFeeLabel: string;
+            paymentButton: string;
+            stepTitle: string;
+        };
+    };
+    copied: string;
+    off: string;
+    copy: string;
+} & CreditsPageCommon;
+
+declare function CreditsRedeemList({ copy, className, tabClassName, hideTitle, cardClassName, activate, }: {
+    copy: CreditsRedeemListCopy;
+    className?: string;
+    tabClassName?: string;
+    hideTitle?: boolean;
+    cardClassName?: string;
+    activate: {
+        openAuthCodePopup: () => void;
+        isSuccess: boolean;
+        setOnSuccess: (callback: Function) => void;
+    };
+}): react_jsx_runtime.JSX.Element;
+
+export { Chat, CreditsBanner, CreditsBenefits, CreditsCash, CreditsFaq, CreditsInfoCard, CreditsProvider, CreditsRedeemList, CreditsUploadReceiptModal, CreditsWaysToGetCredits, useCreditsContext, useUploadReceipt as useCreditsUploadReceipt };