@alipay/ams-checkout 0.0.1788166152-dev.7 → 0.0.1788166152-dev.8

package/esm/modern/core/component/element/type.d.ts

@@ -0,0 +1,586 @@
+import type { ShippingInfo } from "../../../modern/index";
+import { ActionForm, ConnectErrorCode, IAmount, IAmountView, IMerchantAppointParam, IPaymentMethod } from '../../../types';
+import AddressProcessor from './elementProcessor/addressProcessor';
+import AuthProcessor from './elementProcessor/authProcessor';
+import PaymentProcessor from './elementProcessor/paymentProcessor';
+/**
+ * element 消息事件名
+ */
+export declare enum ElementPaymentEvent {
+    RENDER_COMPONENT = "renderComponent",
+    CAPTURE_ASSET = "onCaptureAsset",
+    SIGN_OUT = "onSignout",
+    BLUR = "onBlur",
+    SUBMIT_PAY = "submitPay",
+    VALIDATE = "onValidate",
+    SUBMIT_RISK = "onSubmitRisk",
+    AFTER_SUBMIT = "onAfterSubmit",
+    SIZE_CHANGE = "onSizeChange",
+    LAUNCH = "onLaunch",
+    CALLBACK = "callback",
+    /**
+     * @deprecated 已废弃 请使用eventCallback
+     */
+    SEND_MUITI_APP_EVENT_TO_SDK = "sendMuitiAppEventToSdk",
+    LOG = "log",
+    HANDLE_PAYMENT = "handlePayment",
+    ON_EVENT_CALLBACK = "onEventCallback"
+}
+export declare enum ElementPaymentMethod {
+    CONTAINER_ELEMENT = "CONTAINER_ELEMENT",
+    AUTH_ELEMENT = "AUTH_ELEMENT",
+    ADDRESS_ELEMENT = "ADDRESS_ELEMENT",
+    PAYMENT_ELEMENT = "PAYMENT_ELEMENT"
+}
+export declare enum ElementType {
+    auth = "auth",
+    address = "address",
+    payment = "payment"
+}
+/**
+ * TODO 替换外外网链接
+ * 支付状态参考: https://yuque.antfin.com/antom_ka_team/yg9y7x/fe8xxqgbivnx5fd2#rGgE
+ */
+export declare enum PaymentStatus {
+    SUCCESS = "SUCCESS",
+    PROCESSING = "PROCESSING",
+    CANCELLED = "CANCELLED",
+    PENDING = "PENDING",
+    S = "SUCCESS",
+    F = "FAIL",
+    U = "PROCESSING",
+    FAIL = "FAIL"
+}
+export declare const MountElementType: {
+    auth: ElementPaymentMethod;
+    address: ElementPaymentMethod;
+    payment: ElementPaymentMethod;
+    AUTH_ELEMENT: ElementType;
+    ADDRESS_ELEMENT: ElementType;
+    PAYMENT_ELEMENT: ElementType;
+};
+export declare enum ThemeType {
+    NostalgicGray = "nostalgicGray",
+    Default = "default",
+    Night = "night",
+    CherryBlossomPink = "cherryBlossomPink",
+    GamingPurple = "gamingPurple",
+    AgateGreen = "agateGreen"
+}
+export declare enum PaymentElementLayout {
+    Tabs = "tabs",
+    Accordion = "Accordion"
+}
+export declare const addressTheme: {
+    default: string;
+    night: string;
+};
+export declare enum EventCallbackCode {
+    SDK_CREATE_COMPONENT_ERROR = "SDK_CREATE_COMPONENT_ERROR",
+    SDK_CREATEPAYMENT_PARAMETER_ERROR = "SDK_CREATEPAYMENT_PARAMETER_ERROR",
+    SDK_PAYMENT_ERROR = "SDK_PAYMENT_ERROR",
+    SDK_PAYMENT_FAIL = "SDK_PAYMENT_FAIL",
+    SDK_PAYMENT_CANCEL = "SDK_PAYMENT_CANCEL",
+    SDK_PAYMENT_SUCCESSFUL = "SDK_PAYMENT_SUCCESSFUL",
+    SDK_PAYMENT_PROCESSING = "SDK_PAYMENT_PROCESSING"
+}
+export declare enum ELEMENT_ENVIRONMENT {
+    DEV = "DEV",
+    TEST = "TEST",
+    SIT = "SIT",
+    PRE = "PRE",
+    PROD = "PROD",
+    SANDBOX = "SANDBOX"
+}
+type ELEMENT_ENVIRONMENT_VALUE = 'dev' | 'test' | 'sit' | 'pre' | 'prod' | 'sandbox';
+export type ELEMENT_ENVIRONMENT_TYPE = keyof typeof ELEMENT_ENVIRONMENT | (typeof ELEMENT_ENVIRONMENT)[keyof typeof ELEMENT_ENVIRONMENT] | ELEMENT_ENVIRONMENT_VALUE;
+export interface AddressMountComponentsParams {
+    configParams?: AddressMountConfig;
+    prefillValue: Array<AddressSubmitData>;
+    sessionData: string;
+    appearance: {
+        themeType: string;
+    };
+    debugProps?: {
+        localLink: string;
+    };
+    elementProps?: {
+        elementLink: string;
+    };
+}
+interface BaseMountOptions<T = void> {
+    configParams?: T;
+    debugProps?: {
+        localLink: string;
+    };
+    elementProps?: {
+        elementLink: string;
+    };
+}
+type HideField = 'shippingCountry' | 'shippingName' | 'shippingPhoneNo' | 'shippingRegion' | 'shippingAddress1' | 'shippingZipCode' | 'shippingAddress2';
+interface AddressMountConfig {
+    /**
+     * 是否开启地址联想功能
+     * 0 开启
+     * 1 关闭
+     */
+    autoSaveAsDefaultAddress?: boolean;
+    /**
+     * 隐藏部分地址要素
+     */
+    hideFields?: Array<HideField>;
+}
+export interface AddressMountOptions extends BaseMountOptions<AddressMountConfig> {
+    type: ElementType.address;
+    prefillValue: Array<AddressSubmitData>;
+    appearance?: {
+        theme?: ThemeType.Default | ThemeType.Night;
+    };
+}
+export interface LinkAuthMountOptions extends BaseMountOptions {
+    type: ElementType.auth;
+    appearance?: {
+        theme?: ThemeType;
+    };
+}
+type ToCamelCase<S extends string> = S extends `${infer First}-${infer Rest}` ? `${First}${Capitalize<ToCamelCase<Rest>>}` : S;
+type CompatibleVariables<T extends Record<string, string>> = {
+    [K in keyof T as K | ToCamelCase<K & string>]: string;
+};
+export interface PaymentMountOptions extends BaseMountOptions {
+    type: ElementType.payment;
+    appearance?: {
+        theme?: ThemeType | `APR_${string}`;
+        layout?: {
+            type: PaymentElementLayout;
+        };
+        variables?: Partial<CompatibleVariables<{
+            'content-primary': string;
+            'content-secondary': string;
+            'content-tertiary': string;
+            'content-quaternary': string;
+            'background-primary': string;
+            'background-secondary': string;
+            'background-disable': string;
+            'background-transparency': string;
+            'border-primary': string;
+            'border-secondary': string;
+            'border-disable': string;
+            'action-normal': string;
+            'action-hover': string;
+            'action-disable': string;
+            'action-secondary': string;
+            'state-failure': string;
+            'state-warning': string;
+            'state-success': string;
+            'state-info': string;
+            'state-marketing': string;
+            'state-conventional': string;
+            'radius-backup': string;
+            'radius-module': string;
+            'radius-component': string;
+            'radius-button': string;
+            'wrapper-padding': string;
+            'stroke-default': string;
+            'stroke-active': string;
+        }>>;
+        card?: {
+            showBrandIcon?: boolean;
+        };
+        accordion?: {
+            showRadio?: boolean;
+        };
+    };
+    notRedirectAfterComplete?: boolean;
+    merchantAppointParam?: IMerchantAppointParam;
+    /**
+     * 支付方式配置
+     *
+     * 使用说明：
+     * - preview: true 时生效，用于配置预览展示的支付方式和外观
+     * - preview: false/undefined 时，此配置被忽略，支付方式来自后端 sdkAction.query 接口
+     */
+    previewPaymentMethods?: {
+        /**
+         * 极速支付配置
+         */
+        expressCheckout?: {
+            enabled: boolean;
+            methods?: {
+                /**
+                 * 支付方式显示名称，如 "Apple Pay"
+                 */
+                paymentMethodName: string;
+                /**
+                 * 支付方式类型，如 "APPLEPAY"
+                 */
+                paymentMethodType: string;
+            }[];
+        };
+        /**
+         * 支持的支付方式列表
+         * 数组顺序即为前端展示顺序
+         */
+        supportedMethods?: {
+            /**
+             * 支付方式显示名称，如 "CARD", "AlipayHK"
+             */
+            paymentMethodName: string;
+            /**
+             * 支付方式类型，如 "VISA", "ALIPAY_HK"
+             */
+            paymentMethodType: string;
+            /**
+             * 支付方式图标 URL
+             */
+            logoUrl?: string;
+        }[];
+        /**
+         * 推荐支付方式
+         * 值为 paymentMethodType，匹配的支付方式会被标记为 recommend
+         */
+        topping?: string;
+    };
+}
+export declare enum AddressEventCallbackName {
+    SHIPPING_CHANGE = "SHIPPING_CHANGE"
+}
+interface BaseMountResult {
+}
+export interface AddressMountResult extends BaseMountResult {
+    on: (event: AddressEventCallbackName, callback: (data: any) => void) => void;
+}
+export interface LinkAuthMountResult extends BaseMountResult {
+}
+export interface PaymentMountResult extends BaseMountResult {
+}
+/**
+ * connect element之间通信的类型格式
+ */
+export interface ConnectElementMessageDataType<T = {}> {
+    source?: ElementPaymentMethod;
+    target?: ElementPaymentMethod;
+    data?: T;
+    event?: ElementPaymentEvent;
+}
+export interface ValidateResult<T = {}> {
+    success: boolean;
+    data: {
+        success: boolean;
+        status: PaymentStatus;
+        message?: string;
+        data: T;
+    };
+}
+export interface AuthSubmitData {
+    accountInfo: {
+        email: string;
+    };
+}
+export interface PaymentSubmitData {
+    paymentMethod: {
+        paymentMethodType: string;
+        paymentMethodDetail?: {
+            cardNo?: string;
+        };
+        cardHolderName?: {
+            firstName: string;
+        };
+        lastName: string;
+    };
+    paymentFactors: {
+        paymentRedirectUrl: string;
+        paymentMethodId?: string;
+    };
+}
+export interface AddressSubmitData {
+    shippingName: {
+        firstName: string;
+        lastName: string;
+    };
+    shippingPhoneNo: string;
+    shippingAddress: {
+        region: string;
+        address1: string;
+        address2: string;
+        city?: string;
+        province?: string;
+        zipCode: string;
+        districts?: string[];
+        districtValues?: {
+            [key: string]: string;
+        };
+    };
+    notes: string;
+    prefer: '1' | '0';
+    shippingId: string;
+    actionFlag?: 'I' | 'U' | 'D';
+}
+export interface SubmitFuncParams {
+    handleActions?: boolean;
+    shippingInfo?: ShippingInfo;
+    /**
+     * Amount displayed on the Apple Pay payment sheet, e.g. '10.99'.
+     * Display only; actual charge amount is controlled by server.
+     * Must be provided together with `currency`. Only effective for Apple Pay.
+     */
+    amount?: string;
+    /**
+     * Currency code displayed on the Apple Pay payment sheet, e.g. 'USD'.
+     * Follows ISO 4217 standard. Must be provided together with `amount`. Only effective for Apple Pay.
+     */
+    currency?: string;
+    /**
+     * Pre-confirmation callback. Executed after user authorization but before actual charge,
+     * allowing merchant to create order at this point.
+     * - Apple Pay: invoked via event bridge after user FaceID/TouchID authorization
+     * - Other payment methods: invoked before the submit message is sent
+     * - Return true: proceed with charge
+     * - Return false / throw error: abort payment, returns MERCHANT_CONFIRM_ABORT error code
+     * - Timeout: abort payment, returns MERCHANT_CONFIRM_TIMEOUT error code
+     */
+    onBeforeConfirm?: () => Promise<boolean>;
+}
+export interface SubmitServiceParams extends PaymentSubmitData {
+    accountInfo: AuthSubmitData['accountInfo'];
+    shipping?: AddressSubmitData;
+}
+interface SubmitResultActionForm extends ActionForm {
+    paymentCodeExpireTime: string;
+}
+export interface SubmitServiceResult {
+    success: boolean;
+    errorCode: ConnectErrorCode;
+    errorMessage: string;
+    errorStatus: string;
+    traceId: string;
+    actionForm?: SubmitResultActionForm;
+    codeFormViews?: Array<{
+        codeExpireTime?: string;
+    }>;
+}
+export interface SubmitFuncResult {
+    success: boolean;
+    msg: string;
+}
+declare enum AccountStatusEnum {
+    EFFECTIVE = "EFFECTIVE",
+    UNREGISTERED = "UNREGISTERED"
+}
+type IAccountInfo = {
+    email?: string;
+    verifyId?: string;
+    accountStatus?: AccountStatusEnum;
+    oneAccountId?: string;
+    needOtp?: boolean;
+    errorMsg?: string;
+    inputStatus?: 'success' | 'loading' | 'error' | 'focused' | '';
+    resendLeftTimes?: number;
+};
+interface ShippingsItem {
+    shippingName: {
+        firstName: string;
+        lastName: string;
+    };
+    prefer: '1' | '0';
+    shippingId: string;
+    shippingPhoneNo: string;
+    shippingAddress: {
+        region: string;
+        state: string;
+        city: string;
+        address1: string;
+        address2: string;
+        zipCode: string;
+    };
+}
+interface Estimate {
+    unit: string;
+    value: number;
+}
+interface DeliveryEstimate {
+    maximum: Estimate;
+    minimum: Estimate;
+}
+interface FixedAmount {
+    amount: number;
+    currency: string;
+}
+interface ShippingRateData {
+    displayName: string;
+    deliveryEstimate: DeliveryEstimate;
+    fixedAmount: FixedAmount;
+}
+interface ShippingAddress {
+    address1: string;
+    address2: string;
+    city: string;
+    region: string;
+    state: string;
+    zipCode: string;
+}
+interface IUserName {
+    firstName: string;
+    middleName?: string;
+    lastName: string;
+    fullName?: string;
+}
+type Shippings = ShippingsItem[];
+type IPaymentMethods = IPaymentMethod[];
+export interface CKPShipping {
+    shippingRateId?: string;
+    shippingRateData?: ShippingRateData;
+    shippingAddress: ShippingAddress;
+    shippingFee?: IAmount;
+    shippingFeeView?: IAmountView;
+    shippingDescription?: string;
+    deliveryEstimate?: DeliveryEstimate;
+    shippingFeeId?: string;
+    shippingName?: IUserName;
+    shippingPhoneNo?: string;
+    shipToEmail?: string;
+    notes?: string;
+}
+export interface AccountQueryRequest {
+    paymentSessionData: string;
+    paymentSessionConfig: any;
+    accountInfo: IAccountInfo;
+}
+export interface AccountQueryResult {
+    accountInfo: IAccountInfo;
+    actionForm?: ActionForm;
+    paymentMethods: IPaymentMethods;
+    shippings: Shippings;
+    success: boolean;
+    errorCode?: string;
+    errorMessage?: string;
+    errorStatus?: string;
+    shippingInfo?: CKPShipping;
+}
+export interface IElementOptions {
+    sessionData: string;
+    environment?: ELEMENT_ENVIRONMENT_TYPE;
+    locale?: string;
+    version?: string;
+    appearance?: {
+        theme: ThemeType.Default | ThemeType.Night;
+    };
+    onEventCallback?: ({ code, message, result }: {
+        code: EventCallbackCode;
+        message: string;
+        result?: any;
+    }) => void;
+    loading?: {
+        onStartLoading: () => void;
+        onEndLoading: () => void;
+    };
+    /**
+     * 预览模式开关
+     * - true / 'web': 跳过真实 API 请求，使用 mock 数据，按 WebElement（inline）方式渲染（向后兼容，等同于 'web'）
+     * - 'mobile': 跳过真实 API 请求，使用 mock 数据，按 MobileElement（popup）方式渲染，用于 mobileElement 降级预览
+     * - false / undefined: 发起真实请求（默认行为）
+     *
+     * 使用场景：B 端配置后台预览，C 端生产环境不应使用
+     */
+    preview?: boolean | 'web' | 'mobile';
+}
+export interface IElementProcessors {
+    [ElementType.auth]: AuthProcessor;
+    [ElementType.address]: AddressProcessor;
+    [ElementType.payment]: PaymentProcessor;
+}
+export interface IToastOptions {
+    position?: 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' | 'center';
+    backgroundColor?: string;
+    color?: string;
+    padding?: string;
+    borderRadius?: string;
+    fontSize?: string;
+    zIndex?: number;
+    width?: string;
+    duration?: number;
+    icon?: 'SUCCESS' | 'FAIL';
+    spin?: boolean;
+}
+interface IPaymentSession {
+    nextAction: INextAction;
+}
+interface INextAction {
+    normalUrl: string;
+    applinkUrl?: string;
+    schemeUrl?: string;
+}
+export interface ICommonApiResponse {
+    error?: {
+        code: string;
+        message: string;
+        traceId?: string;
+        context?: any;
+        needChangeSessionForRetry?: boolean;
+    };
+}
+export interface IPaymentApiResponse extends ICommonApiResponse {
+    status: keyof typeof PaymentStatus | '';
+    userCanceled3D?: boolean;
+    session?: IPaymentSession;
+}
+export declare class InvalidElementConfigError extends Error {
+    errors: Array<{
+        field: keyof IElementOptions;
+        message: string;
+    }>;
+    constructor(errors: Array<{
+        field: keyof IElementOptions;
+        message: string;
+    }>);
+}
+export declare enum EXPOSURE_API_EVENT {
+    DESTORY = "destroy",
+    MOUNT = "mount",
+    SUBMITPAYMENT = "submitPayment",
+    VALIDATAFIELDS = "validateFields",
+    UPDATEPAYMENT = "updatePayment"
+}
+export declare enum EVENTNAME {
+    PAYMENTMETHODCHANGED = "paymentMethodChanged",
+    BILLINGADDRESSCHANGED = "billingAddressChanged"
+}
+interface PaymentMethodChangedData {
+    type: string;
+    name: string;
+}
+interface BillingAddressChangedData {
+    sameAsShipping: boolean;
+    billingAddress: {
+        region: string;
+        state: string;
+        city: string;
+        address1: string;
+        address2: string;
+        zipCode: string;
+        phoneNo: string;
+        name: {
+            firstName: string;
+            lastName: string;
+            middleName: string;
+        };
+    };
+}
+export interface EventDataMap {
+    [EVENTNAME.PAYMENTMETHODCHANGED]: PaymentMethodChangedData;
+    [EVENTNAME.BILLINGADDRESSCHANGED]: BillingAddressChangedData;
+}
+export interface IElementController {
+    mount(renderOptions: PaymentMountOptions, sdkSelector: string): Promise<ICommonApiResponse>;
+    submitPayment(params: SubmitFuncParams): Promise<IPaymentApiResponse>;
+    validateFields(): Promise<{
+        isValid: boolean;
+    }>;
+    /**
+     * @deprecated 不要使用，internal experiment方法
+     */
+    updatePayment(paymentSessionData: string): Promise<boolean>;
+    destroy(): void;
+    on<T extends EVENTNAME>(event: T, callback: (data: EventDataMap[T]) => void): void;
+}
+export {};

package/esm/modern/core/component/element/util.d.ts

@@ -0,0 +1,93 @@
+import { IElementStatus } from '../../../foundation';
+import { CashierSdkActionQueryResult, DisplayTypeEnum, Ianalytics, IPaymentSessionMetaData } from '../../../types';
+import { ContainerController } from './elementContainerService/containerService';
+import { ELEMENT_ENVIRONMENT_TYPE, EventCallbackCode, IElementOptions, IToastOptions } from './type';
+export declare const formatElementOption: (options: IElementOptions) => {
+    environment: ELEMENT_ENVIRONMENT_TYPE;
+    sessionData: string;
+    locale?: string;
+    version?: string;
+    appearance?: {
+        theme: import("./type").ThemeType.Default | import("./type").ThemeType.Night;
+    };
+    onEventCallback?: ({ code, message, result }: {
+        code: EventCallbackCode;
+        message: string;
+        result?: any;
+    }) => void;
+    loading?: {
+        onStartLoading: () => void;
+        onEndLoading: () => void;
+    };
+    preview?: boolean | "web" | "mobile";
+};
+export declare const validateElementOption: (options: IElementOptions) => {
+    isValid: boolean;
+    errors: any[];
+};
+/**
+ * 校验渲染条件
+ * 1.校验当前 sdkSelector 结点是否存在
+ * 2.校验当前 Element 的状态是否能够渲染
+ * 3.校验当前 type 类型 Elment 是否已经执行过 mount
+ */
+export declare function checkCanMount({ sdkSelector, containerService, status, }: {
+    sdkSelector: string;
+    containerService: ContainerController;
+    status: IElementStatus;
+}): {
+    success: boolean;
+    errorMsg?: string;
+    error?: {
+        code: string;
+        message: string;
+    };
+};
+export declare function checkCanUpdate({ status, paymentContainerService, newPaymentSessionData, oldPaymentSessionData, }: {
+    status: IElementStatus;
+    paymentContainerService: ContainerController;
+    newPaymentSessionData: string;
+    oldPaymentSessionData: string;
+}): boolean;
+export declare function generateIframeSrc({ paymentSessionObj, paymentSession, instanceId, environment, appVersion, analytics, locale, pageUrl, link, renderDisplayType, }: {
+    paymentSessionObj: IPaymentSessionMetaData;
+    paymentSession: string;
+    environment: string;
+    analytics: Ianalytics;
+    locale: string;
+    instanceId: string;
+    pageUrl: string;
+    appVersion: string;
+    link?: string;
+    /**
+     * iframe 中 checkout-v2 的渲染形态。
+     * - inline（默认）: WebElement 渲染
+     * - popup: MobileElement 渲染（用于 mobileElement 降级预览）
+     */
+    renderDisplayType?: DisplayTypeEnum;
+}): string;
+export declare function handleRedirect(data: any, fromFastSdk: boolean, eventCallback: ({ code, message }: {
+    code: any;
+    message: any;
+}) => void): void;
+export declare function redirect(data: {
+    normalUrl?: string;
+    schemeUrl?: string;
+    applinkUrl?: string;
+    callAppJudgeTime?: number;
+}): Promise<void>;
+export declare function showToast(options?: IToastOptions, callback?: Function): void;
+export declare const isElementMobile: () => boolean;
+/**
+ * @description judge whether the device is a pad, by userAgent and screen aspect ratio, but not accurate
+ */
+export declare const isElementPad: () => boolean;
+export declare const isElementPC: () => boolean;
+/**
+ * 判断是否需要加载错误页
+ * @param {CashierSdkActionQueryResult} params
+ * @returns {boolean} - 是否需要加载错误页
+ */
+export declare const isLoadErrorPage: (params: CashierSdkActionQueryResult) => boolean;
+export declare const safeStringify: (payload: any, defaultValue?: string) => string;
+export declare const safeParse: (payload: any, defaultValue?: Record<string, any>) => Record<string, any>;