@alipay/ams-checkout 2.0.28 → 2.0.29

package/types.untrimmed.d.ts

@@ -290,8 +290,10 @@ export declare interface AntomOpenModalConfig extends OpenModalParams {
 export declare class AntomSDK extends BaseElementsFactory {
     static version: string;
     private stopModalMessageMonitor;
+    private readonly apiTracker;
     constructor(config?: AntomSDKConfig);
     protected canUseElements(): Array<ElementListItemType>;
+    init(): Promise<this>;
     /**
      * @description 更新配置
      */
@@ -315,17 +317,34 @@ export declare class AntomSDK extends BaseElementsFactory {
     createElement(elementType: 'vaulting', options?: VaultingAppConfig): VaultingElement;
     createElement(elementType: 'CVV', options: CVVAppConfig): CVVElement;
     createElement(elementType: 'express', options?: ExpressAppConfig): ExpressElement;
+    createElement(elementType: 'expressVaulting', options?: ExpressVaultingAppConfig): ExpressVaultingElement;
     getElement(elementType: 'payment', options?: PaymentAppConfig): PaymentElement;
     getElement(elementType: 'vaulting', options?: VaultingAppConfig): VaultingElement;
     getElement(elementType: 'CVV', options?: CVVAppConfig): CVVElement;
     getElement(elementType: 'express', options?: ExpressAppConfig): ExpressElement;
+    getElement(elementType: 'expressVaulting', options?: ExpressVaultingAppConfig): ExpressVaultingElement;
     /**
      * 从 elements 容器或直接传入的 MainElement 中提取指定类型的主元素
      * @throws {AntomSDKError} 当无法找到有效的主元素时抛出错误
      */
     private extractMainElement;
     confirmCardSetup(options: ConfirmCardSetupOptions): Promise<SubmitResult>;
+    private runConfirmCardSetup;
     confirmPayment(options: ConfirmPaymentOptions): Promise<SubmitResult>;
+    private runConfirmPayment;
+    /**
+     * 触发 Express Vaulting element 的 PayPal 绑卡提交流程。
+     *
+     * iframe 收到 OPENSDK@CONFIRM_VAULTING 后执行 submitPay + 单次 inquiry 兜底，
+     * 完成后通过 OPENSDK@CONFIRM_VAULTING_RESULT 回包，Promise resolve。
+     *
+     * @param options.elements 已挂载的 ExpressVaultingElement 或包含它的 Elements 实例
+     * @param options.redirect 跳转策略，默认 'always'，透传给 iframe
+     */
+    confirmVaulting(options: {
+        elements: BaseMainElement | BaseElements;
+        redirect?: 'always' | 'if_required';
+    }): Promise<ExpressVaultingResult>;
 }
 
 /**
@@ -2747,6 +2766,9 @@ export declare type CVVAppearanceProps = {
 export declare class CVVElement extends BaseMainElement<CVVElementConfig, CVVElementEvents> {
     static elementType: string;
     private readonly sessionData;
+    private readonly elementTracker;
+    private _mountInProgress;
+    private _destroyInProgress;
     constructor(name: string, config: CVVElementConfig);
     /**
      * @internal
@@ -2763,6 +2785,10 @@ export declare class CVVElement extends BaseMainElement<CVVElementConfig, CVVEle
      * @internal
      */
     submit(data?: CVVSubmitParams): Promise<SubmitResult>;
+    mount(container: HTMLElement): Promise<void>;
+    on<T extends keyof CVVElementEvents>(event: T, handler: (payload: CVVElementEvents[T]) => void): void;
+    unmount(): void;
+    destroy(): void;
     protected focus(): void;
     protected blur(): void;
     protected clear(): void;
@@ -3503,8 +3529,12 @@ declare interface ElementPluginChangeStates {
 declare type ElementPluginNameEnum = 'SET_STATE' | 'PASSIVE_SET_STATE';
 
 declare class Elements extends BaseElements {
+    private readonly apiTracker;
     protected canUseElements(): Array<ElementListItemType>;
     constructor(config: BaseElementsConfig);
+    init(): Promise<this>;
+    updateConfig(config: Partial<BaseElementsConfig>): void;
+    destroy(): void;
     createElement(elementType: 'vaulting', options?: VaultingAppConfig): VaultingElement;
     createElement(elementType: 'express', options?: ExpressAppConfig): ExpressElement;
     getElement(elementType: 'vaulting', options?: VaultingAppConfig): VaultingElement;
@@ -3722,6 +3752,17 @@ export declare interface ExpressClickEvent {
     expressPaymentType: string;
 }
 
+declare type ExpressCompletePaymentResult = {
+    success: boolean;
+    result?: any;
+    error?: {
+        code: string;
+        message: string;
+    };
+    userCanceled3D?: boolean;
+    status?: 'SUCCESS' | 'CANCELLED' | 'FAIL' | 'PROCESSING';
+};
+
 /** confirm 事件负载（统一终态，替代 approve） */
 export declare interface ExpressConfirmData {
     expressPaymentType: string;
@@ -3768,6 +3809,10 @@ export declare interface ExpressConfirmData {
  */
 export declare class ExpressElement extends BaseMainElement<ExpressElementConfig, ExpressElementEvents> {
     static elementType: string;
+    private readonly elementTracker;
+    private _mountInProgress;
+    private _destroyInProgress;
+    private _registeringInternalListeners;
     /**
      * Store all function-type callbacks locally, not involved in postMessage serialization
      */
@@ -3786,6 +3831,12 @@ export declare class ExpressElement extends BaseMainElement<ExpressElementConfig
     private _localHandlers;
     /** 支付流程进行中标志（click → confirm/error/cancel 之间） */
     private _paymentInProgress;
+    /**
+     * confirm 窗口超时标志：iframe 在 20s onTimeout 发 error(MERCHANT_CONFIRM_TIMEOUT) 时置位，
+     * completePayment 入口据此立即返失败（不发 COMPLETE_PAYMENT，不进 5min 兜底）。
+     * 每新一轮 confirm 事件到达时复位（见 on() 重写）。
+     */
+    private _confirmWindowTimedOut;
     /**
      * 是否已收到 iframe 业务层 ready 事件（app.tsx sendReady）。
      * 注意：与 host `status='ready'`（由 HANDSHAKE_ACK 触发，bridge.js:450 同步回发，与 amount 解析无关）不同。
@@ -3808,6 +3859,7 @@ export declare class ExpressElement extends BaseMainElement<ExpressElementConfig
      */
     private _emit;
     updateConfig(newConfig: ExpressAppConfig): Promise<ExpressElementEvents['OPENSDK@UPDATE_CONFIG_REPLY']>;
+    private runUpdateConfig;
     private updateConfigTransaction;
     private updateAmountConfigWithSanitizedDebug;
     private getAmountValidationReason;
@@ -3823,19 +3875,13 @@ export declare class ExpressElement extends BaseMainElement<ExpressElementConfig
      * iframe 收到 OPENSDK@COMPLETE_PAYMENT 后执行 submitPay / polling 等，
      * 完成后通过 OPENSDK@COMPLETE_PAYMENT_RESULT 回包，Promise resolve。
      */
-    completePayment(redirect?: 'always' | 'if_required'): Promise<{
-        success: boolean;
-        result?: any;
-        error?: {
-            code: string;
-            message: string;
-        };
-        /** 用户是否手动关闭 3D 弹窗（透传 webapp COMPLETE_PAYMENT_RESULT.userCanceled3D） */
-        userCanceled3D?: boolean;
-        status?: 'SUCCESS' | 'CANCELLED' | 'FAIL' | 'PROCESSING';
-    }>;
+    completePayment(redirect?: 'always' | 'if_required'): Promise<ExpressCompletePaymentResult>;
+    private runCompletePayment;
     setup(): Promise<Partial<ExpressAppConfig> | undefined>;
     private registerInternalListeners;
+    mount(container: HTMLElement): Promise<void>;
+    unmount(): void;
+    destroy(): void;
     protected focus(): void;
     protected blur(): void;
     protected clear(): void;
@@ -3944,6 +3990,201 @@ declare type ExpressSetupError = ErrorPayload & {
     mulityLanguageMapping?: boolean;
 };
 
+/**
+ * @public
+ * @description Express Vaulting element app config type
+ */
+export declare interface ExpressVaultingAppConfig extends BaseElementAppConfig {
+    /**
+     * @description payment sessionData，无法通过 updateConfig 更新
+     */
+    sessionData?: string;
+    /**
+     * @description 开通的支付方式列表，本期固定为 ['PAYPAL_DIRECTDEBIT']
+     */
+    paymentMethods?: string[];
+    /** PayPal 按钮配置 */
+    paypal?: ExpressVaultingPayPalConfig;
+    /** PayPal 按钮文案类型 */
+    buttonType?: {
+        paypal?: 'paypal' | 'checkout' | 'buynow' | 'pay';
+    };
+    /** 按钮统一高度（px） */
+    buttonHeight?: number;
+    /** PayPal 按钮主题色 */
+    buttonTheme?: {
+        paypal?: 'gold' | 'blue' | 'silver' | 'white' | 'black';
+    };
+}
+
+/**
+ * @public
+ * @description cancel 事件负载
+ */
+export declare interface ExpressVaultingCancelEvent {
+    paymentMethodType: ExpressVaultingMethod;
+    data?: unknown;
+}
+
+/**
+ * @public
+ * @description click 事件负载
+ */
+export declare interface ExpressVaultingClickEvent {
+    paymentMethodType: ExpressVaultingMethod;
+}
+
+/**
+ * @public
+ * @description confirm 事件负载（PayPal onApprove 成功后触发，商户可在回调中调 confirmVaulting）
+ */
+export declare interface ExpressVaultingConfirmEvent {
+    paymentMethodType: ExpressVaultingMethod;
+    payerInfo?: ExpressVaultingPayerInfo;
+}
+
+/**
+ * @public
+ * @description Express Vaulting element - PayPal 绑卡 Element
+ *
+ * Host 侧只保留 Element 生命周期与 bridge 连接；PayPal 按钮渲染、Braintree SDK
+ * 加载、submit/inquiry 都由 express_vaulting webapp 承接。
+ *
+ * setup 阶段调 sdkActionQuery 拿 paypalClientToken，握手时下发给 iframe（系分
+ * 4.1 节 BR-007：client token 必须来自握手，iframe 不自调 sdkActionQuery）。
+ */
+export declare class ExpressVaultingElement extends BaseMainElement<ExpressVaultingElementConfig, ExpressVaultingElementEvents> {
+    static elementType: string;
+    /**
+     * Host-side fullscreen overlay shown while the PayPal popup is open.
+     *
+     * PayPal Braintree vault flow renders its own popup + backdrop inside the
+     * iframe body, so without a host overlay the backdrop only masks the tiny
+     * button area. Mirrors ExpressElement: show on `click`, hide on
+     * `confirm` / `cancel` / `error`.
+     */
+    private _paypalOverlay;
+    constructor(name: string, config: ExpressVaultingElementConfig);
+    /**
+     * @internal
+     * 握手前调 sdkActionQuery 拿 paypalClientToken，连同按钮样式一起打包下发给 iframe。
+     * 失败时以 setupError 形式返回，iframe 侧读取后透传 error 事件。
+     */
+    setup(): Promise<Partial<ExpressVaultingAppConfig> | undefined>;
+    /**
+     * @internal
+     * Host-side bridge listeners. Only the PayPal overlay lifecycle here —
+     * show when the PayPal popup opens (click), hide when it closes
+     * (confirm / cancel / error). Mirrors ExpressElement's overlay handling.
+     */
+    private registerInternalListeners;
+    protected focus(): void;
+    protected blur(): void;
+    protected clear(): void;
+    /**
+     * @internal
+     * 由 SDK 容器（antom.ts.confirmVaulting）调用，向 iframe 发送 CONFIRM_VAULTING
+     * 指令并等待 CONFIRM_VAULTING_RESULT 回包。iframe 侧执行 submitPay + 单次 inquiry
+     * 兜底后回包终态结果。
+     */
+    _confirmVaulting(redirect?: 'always' | 'if_required'): Promise<ExpressVaultingResult>;
+}
+
+/**
+ * @public
+ * @description Express Vaulting element config type
+ */
+export declare interface ExpressVaultingElementConfig extends BaseElementConfig<ExpressVaultingAppConfig> {
+}
+
+/**
+ * @public
+ * @description Express Vaulting element 事件类型
+ */
+export declare interface ExpressVaultingElementEvents extends AntomBridgeWithNativeEventMap<ExpressVaultingAppConfig> {
+    ready: ExpressVaultingReadyEvent;
+    click: ExpressVaultingClickEvent;
+    confirm: ExpressVaultingConfirmEvent;
+    cancel: ExpressVaultingCancelEvent;
+    error: ExpressVaultingErrorEvent;
+    'OPENSDK@CONFIRM_VAULTING': {
+        requestId: string;
+        redirect?: 'always' | 'if_required';
+    };
+    'OPENSDK@CONFIRM_VAULTING_RESULT': {
+        requestId: string;
+        result: ExpressVaultingResult;
+    };
+}
+
+/**
+ * @public
+ * @description error 事件负载
+ */
+export declare interface ExpressVaultingErrorEvent extends ErrorPayload<string> {
+    paymentMethodType: ExpressVaultingMethod;
+}
+
+/**
+ * Supported express vaulting payment methods. All bridge event payloads carry
+ * `paymentMethodType` — use this enum instead of硬编码 strings so adding a
+ * new wallet only needs one entry here. Must match the iframe-side enum in
+ * elements2/express_vaulting/interface.ts.
+ */
+declare enum ExpressVaultingMethod {
+    PAYPAL_DIRECTDEBIT = "PAYPAL_DIRECTDEBIT"
+}
+
+/**
+ * @public
+ * @description Braintree tokenizePayment 返回的 payer 信息，随 confirm 事件透传给商户
+ */
+export declare interface ExpressVaultingPayerInfo {
+    payerId?: string;
+    email?: string;
+    firstName?: string;
+    lastName?: string;
+    countryCode?: string;
+    phone?: string;
+}
+
+/**
+ * MERCHANT_CONFIRM_TIMEOUT is owned by the iframe side (mirrors express_element:
+ * iframe starts a 20s timer on the `confirm` event and sends
+ * `error(MERCHANT_CONFIRM_TIMEOUT)` if the merchant never calls confirmVaulting).
+ * See elements2/express_vaulting/app.tsx + tools/error.ts.
+ */
+/**
+ * @public
+ * @description PayPal 按钮配置
+ */
+export declare interface ExpressVaultingPayPalConfig {
+    /** 按钮形状 */
+    buttonShape?: 'pill' | 'rect' | 'sharp';
+}
+
+/**
+ * @public
+ * @description ready 事件负载
+ */
+export declare interface ExpressVaultingReadyEvent {
+    availablePaymentMethods: Partial<Record<ExpressVaultingMethod, boolean>>;
+}
+
+/**
+ * @public
+ * @description confirmVaulting 返回结果
+ */
+export declare interface ExpressVaultingResult {
+    status: 'SUCCESS' | 'PROCESSING' | 'FAIL' | 'CANCELLED';
+    paymentMethodId?: string;
+    payerId?: string;
+    error?: {
+        code: string;
+        message: string;
+    };
+}
+
 declare interface ExpSupportBank {
     /**
      * @description 银行名称
@@ -7648,12 +7889,18 @@ export declare type PaymentAppearanceProps = {
 export declare class PaymentElement extends BaseMainElement<PaymentElementConfig, PaymentElementEvents> {
     static elementType: string;
     private _paymentInProgress;
+    private readonly paymentTracker;
+    private _mountStartedAt;
+    private _mountInProgress;
+    private _mountPhase;
+    private _destroyInProgress;
     private readonly walletLogger;
     constructor(name: string, config: PaymentElementConfig);
     /**
      * @internal
      */
     setup(): Promise<Partial<PaymentAppConfig> | undefined>;
+    mount(container: HTMLElement): Promise<void>;
     /**
      * @description Update payment element configuration with amount validation and appearance Rules support
      */
@@ -7662,6 +7909,9 @@ export declare class PaymentElement extends BaseMainElement<PaymentElementConfig
      * @internal
      */
     submit(data?: PaymentSubmitParams): Promise<PaymentSubmitResult>;
+    on<T extends keyof PaymentElementEvents>(event: T, handler: (payload: PaymentElementEvents[T]) => void): void;
+    unmount(): void;
+    destroy(): void;
     protected focus(): void;
     protected blur(): void;
     protected clear(): void;
@@ -7691,6 +7941,11 @@ export declare interface PaymentElementEvents extends AntomBridgeWithNativeEvent
     'OPENSDK@GET_GOOGLE_PAY_TOKEN': GetGooglePayTokenRequest;
     /** host 完成 Google Pay token 获取后回包给 webapp */
     'OPENSDK@GET_GOOGLE_PAY_TOKEN_REPLY': GetGooglePayTokenReply;
+    /** WebApp notifies the host when the selected payment method changes. */
+    paymentMethodChanged: {
+        type: string;
+        name?: string;
+    };
 }
 
 declare interface PaymentElementView {
@@ -25162,6 +25417,9 @@ export declare type VaultingAppearanceProps = {
  */
 export declare class VaultingElement extends BaseMainElement<VaultingElementConfig, VaultingElementEvents> {
     static elementType: string;
+    private readonly elementTracker;
+    private _mountInProgress;
+    private _destroyInProgress;
     constructor(name: string, config: VaultingElementConfig);
     /**
      * @internal
@@ -25177,6 +25435,10 @@ export declare class VaultingElement extends BaseMainElement<VaultingElementConf
      * @internal
      */
     submit(data?: VaultingSubmitParams): Promise<SubmitResult>;
+    mount(container: HTMLElement): Promise<void>;
+    on<T extends keyof VaultingElementEvents>(event: T, handler: (payload: VaultingElementEvents[T]) => void): void;
+    unmount(): void;
+    destroy(): void;
     protected focus(): void;
     protected blur(): void;
     protected clear(): void;