@alipay/ams-checkout 2.0.12 → 2.0.13

package/types.untrimmed.d.ts

@@ -395,19 +395,6 @@ declare interface ApplePayProps {
     paymentRequest?: ApplePaymentModel;
 }
 
-/**
- * @public
- * @description onApprove callback parameter
- */
-export declare interface ApproveData {
-    /** Payment method identifier */
-    paymentMethod: string;
-    /** Raw data returned by payment method */
-    data?: Record<string, any>;
-    /** Shipping address (if collectShippingAddress is true) */
-    shippingAddress?: Record<string, any>;
-}
-
 /**
  * @description googlePay risk check
  */
@@ -622,11 +609,7 @@ declare type AxiosHeaderMatcher =
 | RegExp
 | ((this: AxiosHeaders, value: string, name: string) => boolean);
 
-declare type AxiosHeaderParser = (
-this: AxiosHeaders,
-value: AxiosHeaderValue,
-header: string,
-) => any;
+declare type AxiosHeaderParser = (this: AxiosHeaders, value: AxiosHeaderValue, header: string) => any;
 
 declare class AxiosHeaders {
     constructor(headers?: RawAxiosHeaders | AxiosHeaders | string);
@@ -636,12 +619,9 @@ declare class AxiosHeaders {
     set(
     headerName?: string,
     value?: AxiosHeaderValue,
-    rewrite?: boolean | AxiosHeaderMatcher,
-    ): AxiosHeaders;
-    set(
-    headers?: RawAxiosHeaders | AxiosHeaders | string,
-    rewrite?: boolean,
+    rewrite?: boolean | AxiosHeaderMatcher
     ): AxiosHeaders;
+    set(headers?: RawAxiosHeaders | AxiosHeaders | string, rewrite?: boolean): AxiosHeaders;
 
     get(headerName: string, parser: RegExp): RegExpExecArray | null;
     get(headerName: string, matcher?: true | AxiosHeaderParser): AxiosHeaderValue;
@@ -655,9 +635,7 @@ declare class AxiosHeaders {
     normalize(format: boolean): AxiosHeaders;
 
     concat(
-    ...targets: Array<
-    AxiosHeaders | RawAxiosHeaders | string | undefined | null
-    >
+    ...targets: Array<AxiosHeaders | RawAxiosHeaders | string | undefined | null>
     ): AxiosHeaders;
 
     toJSON(asStrings?: boolean): RawAxiosHeaders;
@@ -667,55 +645,35 @@ declare class AxiosHeaders {
     static accessor(header: string | string[]): AxiosHeaders;
 
     static concat(
-    ...targets: Array<
-    AxiosHeaders | RawAxiosHeaders | string | undefined | null
-    >
+    ...targets: Array<AxiosHeaders | RawAxiosHeaders | string | undefined | null>
     ): AxiosHeaders;
 
-    setContentType(
-    value: ContentType,
-    rewrite?: boolean | AxiosHeaderMatcher,
-    ): AxiosHeaders;
+    setContentType(value: ContentType, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders;
     getContentType(parser?: RegExp): RegExpExecArray | null;
     getContentType(matcher?: AxiosHeaderMatcher): AxiosHeaderValue;
     hasContentType(matcher?: AxiosHeaderMatcher): boolean;
 
-    setContentLength(
-    value: AxiosHeaderValue,
-    rewrite?: boolean | AxiosHeaderMatcher,
-    ): AxiosHeaders;
+    setContentLength(value: AxiosHeaderValue, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders;
     getContentLength(parser?: RegExp): RegExpExecArray | null;
     getContentLength(matcher?: AxiosHeaderMatcher): AxiosHeaderValue;
     hasContentLength(matcher?: AxiosHeaderMatcher): boolean;
 
-    setAccept(
-    value: AxiosHeaderValue,
-    rewrite?: boolean | AxiosHeaderMatcher,
-    ): AxiosHeaders;
+    setAccept(value: AxiosHeaderValue, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders;
     getAccept(parser?: RegExp): RegExpExecArray | null;
     getAccept(matcher?: AxiosHeaderMatcher): AxiosHeaderValue;
     hasAccept(matcher?: AxiosHeaderMatcher): boolean;
 
-    setUserAgent(
-    value: AxiosHeaderValue,
-    rewrite?: boolean | AxiosHeaderMatcher,
-    ): AxiosHeaders;
+    setUserAgent(value: AxiosHeaderValue, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders;
     getUserAgent(parser?: RegExp): RegExpExecArray | null;
     getUserAgent(matcher?: AxiosHeaderMatcher): AxiosHeaderValue;
     hasUserAgent(matcher?: AxiosHeaderMatcher): boolean;
 
-    setContentEncoding(
-    value: AxiosHeaderValue,
-    rewrite?: boolean | AxiosHeaderMatcher,
-    ): AxiosHeaders;
+    setContentEncoding(value: AxiosHeaderValue, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders;
     getContentEncoding(parser?: RegExp): RegExpExecArray | null;
     getContentEncoding(matcher?: AxiosHeaderMatcher): AxiosHeaderValue;
     hasContentEncoding(matcher?: AxiosHeaderMatcher): boolean;
 
-    setAuthorization(
-    value: AxiosHeaderValue,
-    rewrite?: boolean | AxiosHeaderMatcher,
-    ): AxiosHeaders;
+    setAuthorization(value: AxiosHeaderValue, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders;
     getAuthorization(parser?: RegExp): RegExpExecArray | null;
     getAuthorization(matcher?: AxiosHeaderMatcher): AxiosHeaderValue;
     hasAuthorization(matcher?: AxiosHeaderMatcher): boolean;
@@ -725,13 +683,7 @@ declare class AxiosHeaders {
     [Symbol.iterator](): IterableIterator<[string, AxiosHeaderValue]>;
 }
 
-declare type AxiosHeaderValue =
-| AxiosHeaders
-| string
-| string[]
-| number
-| boolean
-| null;
+declare type AxiosHeaderValue = AxiosHeaders | string | string[] | number | boolean | null;
 
 declare interface BankInfo {
     /**
@@ -1812,6 +1764,28 @@ declare interface ChargeInfo {
     chargeActualAmountView?: PaymentView;
 }
 
+/** click 事件 resolve 参数 */
+export declare interface ClickResolveOptions {
+    amount?: {
+        currency: string;
+        value: string;
+    };
+    shippingAddressRequired?: boolean;
+    allowedShippingCountries?: string[];
+    shippingRates?: Array<{
+        id: string;
+        displayName: string;
+        amount: string;
+    }>;
+    lineItems?: Array<{
+        name: string;
+        amount: string;
+    }>;
+    business?: {
+        name: string;
+    };
+}
+
 declare interface CodeFormView {
     /**
      * @description title
@@ -2424,12 +2398,12 @@ declare interface ConnectFactor {
 
 declare type ContentType =
 | AxiosHeaderValue
-| "text/html"
-| "text/plain"
-| "multipart/form-data"
-| "application/json"
-| "application/x-www-form-urlencoded"
-| "application/octet-stream";
+| 'text/html'
+| 'text/plain'
+| 'multipart/form-data'
+| 'application/json'
+| 'application/x-www-form-urlencoded'
+| 'application/octet-stream';
 
 declare namespace CSS_2 {
     export {
@@ -3510,8 +3484,8 @@ export declare interface ExpressAppConfig extends BaseAppearance<AppearanceSetti
         currency: string;
         value: string;
     };
-    /** PayPal payment configuration */
-    paypalConfig?: PayPalConfig;
+    /** PayPal 配置 */
+    paypal?: PayPalConfig;
     /**
      * Button text type (following Stripe Express Checkout Element design)
      * Each payment method can independently set the button display text
@@ -3540,21 +3514,37 @@ export declare interface ExpressAppConfig extends BaseAppearance<AppearanceSetti
      * @example ['paypal']
      */
     paymentMethods?: string[];
-    /** Lifecycle callbacks */
-    hooks?: ExpressHooks;
+    /**
+     * @internal setup 阶段的错误信息，传给 iframe 侧处理
+     */
+    setupError?: ErrorPayload;
+    /**
+     * Locale for internationalization, passed from entry params (loadAntom), default to en_US
+     */
+    locale?: string;
 }
 
-/**
- * @public
- * @description onCancel callback parameter
- */
-export declare interface ExpressCancelInfo {
-    /** Payment method identifier */
-    paymentMethod: string;
-    /** Raw data returned by payment method (PayPal SDK return content, fully passed through) */
+/** cancel 事件负载 */
+export declare interface ExpressCancelEvent {
+    expressPaymentType: string;
     data?: any;
 }
 
+/** click 事件负载 */
+export declare interface ExpressClickEvent {
+    expressPaymentType: string;
+    resolve: (options: ClickResolveOptions) => void;
+}
+
+/** confirm 事件负载（统一终态，替代 approve） */
+export declare interface ExpressConfirmData {
+    expressPaymentType: string;
+    paymentData: any;
+    billingDetails?: any;
+    shippingAddress?: any;
+    sessionData?: string;
+}
+
 /**
  * @public
  * @description Express element - express checkout element, supports PayPal / Apple Pay / Google Pay
@@ -3593,62 +3583,82 @@ export declare interface ExpressElementConfig extends BaseElementConfig<ExpressA
  */
 export declare interface ExpressElementEvents extends AntomBridgeEventMap<ExpressAppConfig> {
     /**
-     * @description Element ready event
+     * @description Element ready event — 上报可用支付方式
+     */
+    ready: {
+        availablePaymentMethods: Record<string, boolean>;
+    };
+    /**
+     * @description 用户点击按钮 — 商户必须调用 event.resolve() 后 sheet 才弹出
+     * 对 PayPal: resolve 为 no-op（PayPal 自行弹出 popup）
      */
-    ready: ExpressReadyInfo;
+    click: ExpressClickEvent;
     /**
-     * @description Payment authorization success event
+     * @description 统一支付完成事件（替代 approve）
+     * 用户授权完成后触发，通过 expressPaymentType 区分钱包类型
      */
-    approve: ApproveData;
+    confirm: ExpressConfirmData;
     /**
-     * @description Payment error event
+     * @description 支付错误事件（扩展基类 ErrorPayload，新增 expressPaymentType）
      */
-    paymentError: ExpressErrorData;
+    error: ErrorPayload & {
+        expressPaymentType: string;
+    };
     /**
-     * @description User cancelled payment event
+     * @description 用户取消支付
      */
-    cancel: ExpressCancelInfo;
+    cancel: ExpressCancelEvent;
     /**
-     * @description Payment button click event
+     * @description 用户在 sheet 内变更收货地址（AP/GP only，PayPal 不触发）
      */
-    click: void;
-}
-
-/**
- * @public
- * @description onError callback parameter
- */
-export declare interface ExpressErrorData {
-    /** Payment method identifier */
-    paymentMethod: string;
-    /** Error code */
-    code: string;
-    /** Error message */
-    message: string;
-}
-
-/**
- * @public
- * @description Express Element lifecycle hooks
- */
-export declare interface ExpressHooks {
-    /** Element initialization ready callback */
-    onReady?: (info: ExpressReadyInfo) => void;
-    /** Payment authorization success callback */
-    onApprove?: (data: ApproveData) => void;
-    /** Payment error callback */
-    onError?: (error: ExpressErrorData) => void;
-    /** User cancelled payment callback */
-    onCancel?: (info: ExpressCancelInfo) => void;
-}
-
-/**
- * @public
- * @description onReady callback parameter
- */
-export declare interface ExpressReadyInfo {
-    /** List of currently available payment methods */
-    availablePaymentMethods: string[];
+    shippingaddresschange: {
+        expressPaymentType: string;
+        address: any;
+        resolve: (options: ShippingResolveOptions) => void;
+        reject: (reason: string) => void;
+    };
+    /**
+     * @description 用户在 sheet 内变更配送方式（AP/GP only，PayPal 不触发）
+     */
+    shippingratechange: {
+        expressPaymentType: string;
+        shippingRate: any;
+        resolve: (options: RateResolveOptions) => void;
+    };
+    /** @internal iframe 内容高度变化 */
+    contentHeightChanged: {
+        height: number;
+    };
+    /** @internal PayPal 请求商户创建订单 */
+    'paypal:createOrder': {
+        requestId: string;
+    };
+    /** @internal PayPal createOrder 响应 */
+    'paypal:createOrder:reply': {
+        requestId: string;
+        sessionData?: string;
+        error?: string;
+    };
+    /** @internal PayPal 用户变更收货地址 */
+    'paypal:onShippingAddressChange': {
+        requestId: string;
+        shippingData: any;
+    };
+    /** @internal PayPal 收货地址变更响应 */
+    'paypal:onShippingAddressChange:reply': {
+        requestId: string;
+        error?: string;
+    };
+    /** @internal PayPal 用户变更配送方式 */
+    'paypal:onShippingOptionsChange': {
+        requestId: string;
+        shippingData: any;
+    };
+    /** @internal PayPal 配送方式变更响应 */
+    'paypal:onShippingOptionsChange:reply': {
+        requestId: string;
+        error?: string;
+    };
 }
 
 declare interface ExpSupportBank {
@@ -9895,6 +9905,14 @@ declare interface RateInfo {
     rate?: Rate;
 }
 
+/** shippingratechange 事件 resolve 参数 */
+export declare interface RateResolveOptions {
+    lineItems?: Array<{
+        name: string;
+        amount: string;
+    }>;
+}
+
 declare interface RawAxiosHeaders {
     [key: string]: AxiosHeaderValue;
 }
@@ -10213,6 +10231,19 @@ declare interface ShippingInfo {
     deliveryEstimate?: DeliveryEstimate;
 }
 
+/** shippingaddresschange 事件 resolve 参数 */
+export declare interface ShippingResolveOptions {
+    shippingRates?: Array<{
+        id: string;
+        displayName: string;
+        amount: string;
+    }>;
+    lineItems?: Array<{
+        name: string;
+        amount: string;
+    }>;
+}
+
 declare type SimpleI18n = {
     get(id: GetI18nQueryParam, variable?: Record<string, any>, localeCode?: string): string;
 };