@alipay/ams-checkout 0.0.1779094014-dev.11 → 0.0.1779094014-dev.13

package/types.untrimmed.d.ts

@@ -143,7 +143,88 @@ declare interface AmountLimitInfo {
 /**
  * AntomBridge事件类型，包含了SDK与webapp通信的所有事件类型
  */
-export declare interface AntomBridgeEventMap<AppConfig extends Record<string, any> = Record<string, any>, SubmitParams extends Record<string, any> = Record<string, any>> extends BaseBridgeEventMap<AppConfig, SubmitResult, SubmitParams, string, OpenModalParams> {
+export declare interface AntomBridgeEventMap<AppConfig extends Record<string, any> = Record<string, any>, SubmitParams extends Record<string, any> = Record<string, any>, SR extends SubmitResult = SubmitResult> extends BaseBridgeEventMap<AppConfig, SR, SubmitParams, string, AntomOpenModalConfig> {
+}
+
+/**
+ * @description 整合了native事件的eventMap，如果你的业务element需要支持native，事件请继承这个类型
+ */
+export declare interface AntomBridgeWithNativeEventMap<AppConfig extends Record<string, any> = Record<string, any>, SubmitParams extends Record<string, any> = Record<string, any>, SR extends SubmitResult = SubmitResult> extends AntomBridgeEventMap<AppConfig, SubmitParams, SR> {
+    /**
+     * @internal 展示半浮层
+     */
+    showPopup: {
+        mode: string;
+        showAnimation: string;
+    };
+    /**
+     * @internal 隐藏loading
+     */
+    dismissLoading: Record<string, never>;
+    /**
+     * @internal 通知APP 收银台已经ready
+     */
+    webAppReady: {
+        source: string;
+    };
+    /**
+     * @internal 通知app 应用已启动
+     */
+    onLaunch: {
+        success: boolean;
+        source: string;
+        target: string;
+    };
+    /**
+     * @internal 收到客户端返回action query的数据和商户的配置
+     */
+    renderComponent: {
+        sessionResult?: Record<string, unknown>;
+    };
+    /**
+     * @internal 心跳事件
+     */
+    appHeartBeat: {
+        success: boolean;
+    };
+    /**
+     * @internal 客户端 展示toast弹窗
+     */
+    showToast: {
+        icon: string;
+        message: string;
+        source: string;
+    };
+    /**
+     * @internal 客户端eventCallback 事件
+     */
+    onEventCallback: {
+        code: string;
+    };
+    /**
+     * @internal 发送回调码事件
+     */
+    onSubmitPayCallback: CallbackReturnData;
+    /**
+     * @internal 重置收银台
+     */
+    reset: Record<string, never>;
+    /**
+     * @internal 销毁收银台
+     */
+    destroy: Record<string, never>;
+    /**
+     * @internal 关闭收银台
+     */
+    onClose: Record<string, never>;
+    /**
+     * @internal 重定向
+     */
+    onRedirect: {
+        normalUrl: string;
+        isDestroy: boolean;
+        needReset: boolean;
+    };
 }
 
 /**
@@ -178,6 +259,8 @@ declare interface AntomErrorResponse {
     extendInfo?: Record<string, any>;
 }
 
+export declare type AntomLayouts = 'tabs' | 'accordion';
+
 /**
  * 给中间页使用的桥接事件类型
  * @internal 内部使用，不暴露到外部
@@ -194,13 +277,6 @@ export declare interface AntomMiddlePageEventMap extends AntomBridgeEventMap {
     auto_close_modal: void;
 }
 
-/**
- * 给modal和webapp页面messagePort使用的桥接事件类型
- * @internal 内部使用，不暴露到外部
- */
-export declare interface AntomModalEventMap extends AntomBridgeEventMap {
-}
-
 /**
  * modal打开参数类型
  * @internal 内部使用，不暴露到外部
@@ -229,9 +305,11 @@ export declare class AntomSDK extends BaseElementsFactory {
         getContentWindow: () => Window;
     }>;
     elements(): Elements;
+    createElement(elementType: 'payment', options?: PaymentAppConfig): PaymentElement;
     createElement(elementType: 'vaulting', options?: VaultingAppConfig): VaultingElement;
     createElement(elementType: 'CVV', options?: CVVAppConfig): CVVElement;
     createElement(elementType: 'express', options?: ExpressAppConfig): ExpressElement;
+    getElement(elementType: 'payment', options?: PaymentAppConfig): PaymentElement;
     getElement(elementType: 'vaulting', options?: VaultingAppConfig): VaultingElement;
     getElement(elementType: 'CVV', options?: CVVAppConfig): CVVElement;
     getElement(elementType: 'express', options?: ExpressAppConfig): ExpressElement;
@@ -240,18 +318,8 @@ export declare class AntomSDK extends BaseElementsFactory {
      * @throws {AntomSDKError} 当无法找到有效的主元素时抛出错误
      */
     private extractMainElement;
-    confirmCardSetup(options: ConfirmCardSetupOptions): Promise<SubmitResult | {
-        code: string;
-        message: string;
-        status: string;
-        userCancel3D: boolean;
-    }>;
-    confirmPayment(options: ConfirmPaymentOptions): Promise<SubmitResult | {
-        code: string;
-        message: string;
-        userCancel3D: boolean;
-        status: string;
-    }>;
+    confirmCardSetup(options: ConfirmCardSetupOptions): Promise<SubmitResult>;
+    confirmPayment(options: ConfirmPaymentOptions): Promise<SubmitResult>;
 }
 
 /**
@@ -331,6 +399,8 @@ export declare type AntomSDKErrorCodes = (typeof AntomSDKErrorCodes)[keyof typeo
 
 export declare type AntomTheme = 'default' | 'agateGreen' | 'night' | 'nostalgicGray' | 'gamingPurple' | 'cherryBlossomPink' | 'light';
 
+export declare type AntomVariables = 'content-primary' | 'content-secondary' | 'content-tertiary' | 'content-quaternary' | 'background-primary' | 'background-secondary' | 'background-disable' | 'background-transparency' | 'border-primary' | 'border-secondary' | 'border-disable' | 'action-normal' | 'action-hover' | 'action-disable' | 'action-secondary' | 'state-failure' | 'state-warning' | 'state-success' | 'state-info' | 'state-marketing' | 'state-conventional' | 'radius-backup' | 'radius-module' | 'radius-component' | 'radius-button' | 'wrapper-padding' | 'stroke-default' | 'stroke-active';
+
 declare interface APICallbackOptions {
     requestType: 'fetch' | 'xhr';
     time: number;
@@ -1355,6 +1425,42 @@ declare interface C2PProps {
     merchantTransactionId?: string;
 }
 
+/**
+ * @description native回调错误信息格式
+ * @internal
+ */
+export declare interface CallbackErrorInfo {
+    code: string;
+    message?: string;
+    needChangeSessionForRetry?: boolean;
+    traceId?: string;
+    context?: string;
+}
+
+/**
+ * @description native回调返回数据
+ * @internal
+ */
+export declare interface CallbackReturnData {
+    status?: string;
+    userCanceled3D?: boolean;
+    isExposed?: boolean;
+    error?: CallbackErrorInfo;
+    session?: {
+        nextAction?: CallbackSessionNextAction;
+    };
+}
+
+/**
+ * @description native回调会话下一步操作，包含了回调的url
+ * @internal
+ */
+export declare interface CallbackSessionNextAction {
+    normalUrl?: string;
+    schemeUrl?: string;
+    applinkUrl?: string;
+}
+
 declare interface CardIssuerAuthentication {
     /**
      * @description 卡售卖单元
@@ -2599,7 +2705,7 @@ export declare type CVVAppearance = PickAppearance<CVVAppearanceProps>;
 
 export declare type CVVAppearanceProps = {
     theme: AntomTheme;
-    variables: 'content-primary' | 'content-tertiary' | 'background-primary' | 'background-disable' | 'background-transparency' | 'border-primary' | 'border-disable' | 'action-normal' | 'action-hover' | 'radius-component' | 'content-secondary' | 'background-secondary';
+    variables: AntomVariables;
 };
 
 /**
@@ -3784,6 +3890,11 @@ declare interface FirstPhaseSubscriptionDetail {
     promotionDetails?: PromotionDetail[];
 }
 
+declare interface FrontModulesToBeLoadedInterface {
+    acquirerName: string;
+    scriptUrl: string;
+}
+
 /**
  * @description 分期银行展示模型
  */
@@ -4429,6 +4540,14 @@ declare interface HTTPErrorCallbackOptions {
     aborted?: 0 | 1;
 }
 
+declare interface IApplePayContactField {
+    email: string;
+    name: string;
+    phone: string;
+    postalAddress: string;
+    phoneticName: string;
+}
+
 declare interface iBaseElementClass {
     new (name: string, config: BaseElementConfig): BaseElement;
     elementType: string;
@@ -4596,6 +4715,96 @@ declare interface IOptions {
     stayTime?: number;
 }
 
+declare interface IPaymentSessionMetaData {
+    clientId?: string;
+    renderDisplayType?: string;
+    paymentSessionConfig?: PaymentSessionConfig;
+    securityConfig?: SessionSecurityConfig;
+    moneyView?: any;
+    extendInfo?: string;
+    paymentMethodInfoView?: any;
+    paymentView?: any;
+    modernWeb?: boolean;
+    action?: PaymentSessionAction;
+    authUrlInfo?: {
+        appIdentifier?: string;
+        applinkUrl?: string;
+        normalUrl?: string;
+        schemeUrl?: string;
+        authUrl?: string;
+    };
+    paymentSessionFactor?: {
+        externalRiskTimeout?: number;
+        extendInfo?: {
+            merchantCapabilities?: string[];
+            supportedNetworks?: string[];
+            requiredBillingContactFields: IApplePayContactField[];
+            requiredShippingContactFields: IApplePayContactField[];
+        };
+        merchantInfo?: {
+            registeredCountry?: string;
+            partnerId?: string;
+            merchantName?: string;
+        };
+        order?: {
+            orderDescription: string;
+        };
+        paymentAmount?: {
+            value?: string;
+            currency?: string;
+        };
+        paymentMethodInfo?: {
+            paymentMethodType?: string;
+        };
+        paymentMethodViewMetaData?: any;
+        paymentRequestId?: string;
+        supportedLanguages?: any;
+        /**
+         * 当前为苹果分期场景的信息
+         */
+        recurringInfo?: {
+            /**
+             * 代扣协议开始日期 不传为当前系统时间
+             */
+            startDate?: number;
+            /**
+             * 代扣协议结束日期 不传不限制结束时间
+             */
+            endDate?: number;
+            /**
+             * 付款时间间隔单位，支持："year" "month" "day" "hour" "minute" 不传默认month
+             */
+            intervalUnit?: string;
+            /**
+             * 付款时间间隔。比如每过6个月付款一次，intervalCount就是6, 不传默认为1
+             */
+            intervalCount?: number;
+            /**
+             * 分期标题信息
+             */
+            title?: string;
+            /**
+             * 分期管理页面
+             */
+            managementURL?: string;
+            /**
+             * 苹果通知ipay MAPN信息变更的地址
+             */
+            tokenNotificationURL?: string;
+            /**
+             * 分期协议描述
+             */
+            agreementDescription?: string;
+        };
+        frontModulesToBeLoaded?: FrontModulesToBeLoadedInterface[];
+    };
+    connectFactor?: {
+        enableConnect?: boolean;
+    };
+    skipRenderPaymentMethod?: boolean;
+    needAccountConfirmPage?: boolean;
+}
+
 declare interface ISystemInfo {
     readonly pixelRatio: number;
     readonly windowWidth: number;
@@ -7095,6 +7304,68 @@ declare interface OneAccountInfo {
     accountStatus?: string;
 }
 
+/**
+ * @description one account 账户信息查询结果
+ */
+declare interface OneAccountQueryResult {
+    /**
+     * @description 是否业务处理成功
+     */
+    success?: boolean;
+    /**
+     * @description 错误上下文
+     */
+    errorContext?: ErrorContext;
+    /**
+     * @description 返回结果码
+     */
+    resultCode?: string;
+    /**
+     * @description 返回结果信息
+     */
+    resultMessage?: string;
+    /**
+     * @description error actions
+     */
+    errorActions?: Record<string, string>;
+    /**
+     * @description error code
+     */
+    errorCode?: string;
+    /**
+     * @description error status
+     */
+    errorStatus?: string;
+    /**
+     * @description error message
+     */
+    errorMessage?: string;
+    /**
+     * @description extend info
+     */
+    extendInfo?: Record<string, string>;
+    /**
+     * @description one account 账户信息
+     */
+    accountInfo?: OneAccountInfo;
+    /**
+     * @description action form 下一步动作
+     */
+    actionForm?: OtpChallengeActionForm;
+    /**
+     * @description 支付方式列表
+     */
+    paymentMethods?: PaymentMethodView[];
+    /**
+     * @description 物流信息
+     */
+    shippings?: ShippingInfo[];
+    /**
+     * @description 支付金额 （订单金额 + 物流费）
+     */
+    paymentAmount?: MobileMoneyView;
+}
+
 /**
  * @description OpenModal的返回值类型
  */
@@ -7301,6 +7572,56 @@ declare interface OSInfo {
     osVer?: string;
 }
 
+declare interface OtpChallengeActionForm {
+    /**
+     * @description action form type
+     */
+    actionFormType?: string;
+    /**
+     * @description type of challenge
+     */
+    challengeType?: string;
+    /**
+     * @description The actual render value
+     */
+    challengeRenderValue?: string;
+    /**
+     * @description Describe the challenge is required by AAC or external party
+     */
+    triggerSource?: string;
+    /**
+     * @description is support retry challenge
+     * @default true
+     */
+    isChallengeRetrySupported?: boolean;
+    /**
+     * @description is fist otp auto triggered
+     * @default false
+     */
+    isChallengeAutoTriggered?: boolean;
+    /**
+     * @description estimated challenge response duration
+     * @default 0
+     */
+    estimatedDuration?: number;
+    /**
+     * @description url - like h5 sdk challenge need to call back url
+     */
+    challengeUrl?: string;
+    /**
+     * @description extend information
+     */
+    extendInfo?: string;
+    /**
+     * @description verify Id
+     */
+    verifyId?: string;
+    /**
+     * @description 重发次数
+     */
+    resendLeftTimes?: number;
+}
+
 declare type PartialSpeKey<T, V> = Partial<T extends infer K extends string ? Record<K, V> : Record<string, V>>;
 
 declare interface PayByLinkInfo {
@@ -7322,6 +7643,99 @@ declare interface PayByLinkInfo {
     linkVersion?: number;
 }
 
+/**
+ * @description Payment element app config type
+ */
+export declare interface PaymentAppConfig extends BaseAppearance<PaymentAppearance>, BaseElementAppConfig {
+    /**
+     * @description sessionData，无法通过updateConfig更新
+     */
+    sessionData?: string;
+    /**
+     * @internal sdk所在hostname
+     */
+    merchantDomain: string;
+    /**
+     * @internal 渲染数据
+     */
+    renderData?: CashierSdkActionQueryResult;
+    /**
+     * @internal connect时有这个数据
+     */
+    connectAccount?: OneAccountQueryResult;
+    /**
+     * @internal sessionData解析后的数据
+     */
+    sessionMetaData?: IPaymentSessionMetaData;
+    /**
+     * @internal 渲染数据错误信息
+     */
+    renderDataError?: ErrorPayload;
+    /**
+     * @internal sdk 版本号
+     */
+    sdkVersion?: string;
+    /**
+     * @internal 内部联调使用，生产环境传递无效
+     */
+    _requestConfig?: Partial<Omit<RequestOptions, 'scope' | 'tracker'>>;
+    /**
+     * @internal 内部使用，无需用户传递，用于log日志原数据
+     */
+    logMetaData?: {
+        paymentMethodCategoryType?: PaymentSessionConfig['paymentMethodCategoryType'];
+        productSceneVersion?: PaymentSessionConfig['productSceneVersion'];
+        trackId: string;
+        merchantId?: string;
+        paymentMethodType?: string;
+    };
+    /**
+     * @internal 内部使用，无需用户传递，高度信息
+     */
+    heightOfVisible?: number;
+}
+
+/**
+ * @description Payment element appearance type
+ */
+export declare type PaymentAppearance = PickAppearance<{
+    displaySetting: 'showPaymentMethodListWhenSingleOption' | 'showCardBrandIcon' | 'showRadioWhenAccordionLayout' | 'showCardCVV';
+    theme: AntomTheme;
+    variables: AntomVariables;
+    layout: AntomLayouts;
+}>;
+
+/**
+ * @description Payment element
+ */
+export declare class PaymentElement extends BaseMainElement<PaymentElementConfig, PaymentElementEvents> {
+    static elementType: string;
+    constructor(name: string, config: PaymentElementConfig);
+    /**
+     * @internal
+     */
+    setup(): Promise<Partial<PaymentAppConfig> | undefined>;
+    /**
+     * @internal
+     */
+    submit(data?: PaymentSubmitParams): Promise<PaymentSubmitResult>;
+    protected focus(): void;
+    protected blur(): void;
+    protected clear(): void;
+}
+
+/**
+ * @description Payment element config type
+ */
+declare interface PaymentElementConfig extends BaseElementConfig<PaymentAppConfig> {
+}
+
+/**
+ * @description Payment element events
+ */
+export declare interface PaymentElementEvents extends AntomBridgeWithNativeEventMap<PaymentAppConfig, PaymentSubmitParams, PaymentSubmitResult> {
+}
+
 declare interface PaymentElementView {
     /**
      * @description payment element key
@@ -7923,6 +8337,32 @@ declare interface PaymentSessionConfig {
     productSceneVersion?: string;
 }
 
+/**
+ * @description The submit params
+ */
+export declare interface PaymentSubmitParams extends SubmitParams {
+}
+
+/**
+ * @description Payment element submit result
+ */
+export declare interface PaymentSubmitResult extends SubmitResult {
+    paymentSession?: {
+        /**
+         * @description 回调页面的url链接，使用浏览器可直接打开，比如 http://xxx.app.com/xxx
+         */
+        returnUrl: string;
+        /**
+         * @description 回调页面唤起app的url链接，使用浏览器可直接打开，比如 http://xxx.app.com/xxx
+         */
+        returnAppUrl?: string;
+        /**
+         * @description 回调页面唤起app的scheme链接，比如 alipay://xxx
+         */
+        returnAppScheme?: string;
+    };
+}
+
 declare interface PaymentView {
     /**
      * @description 金额,以元为单位的金额
@@ -24269,22 +24709,43 @@ declare interface StandardShorthandPropertiesHyphen<TLength = (string & {}) | 0,
 
 declare type StandardShorthandPropertiesHyphenFallback<TLength = (string & {}) | 0, TTime = string & {}> = Fallback<StandardShorthandPropertiesHyphen<TLength, TTime>>;
 
+export declare type SubmitParams = {
+    redirect?: 'always' | 'if_required';
+};
+
 /**
- * @description 成功时的data数据类型
+ * @description 成功时的数据类型
  */
 export declare type SubmitResult = {
     /**
-     * 查询到的状态
-     */
-    status: 'SUCCESS' | 'CANCELLED' | 'FAIL' | 'PROCESSING';
-    /**
-     * 查询到的结果码或者错误码, 在SUCCESS和CANCELLED无该字段
+     * 查询到的结果码或者错误码, 在SUCCESS无该字段
+     * @deprecated 已废弃请读取error中的code
+     * @internal
      */
     code?: string;
     /**
-     * 查询到的结果消息, 在SUCCESS和CANCELLED无该字段
+     * 查询到的结果消息, 在SUCCESS无该字段
+     * @deprecated 已废弃请读取error中的message
+     * @internal
      */
     message?: string;
+    /**
+     * 查询到的状态
+     */
+    status: 'SUCCESS' | 'CANCELLED' | 'FAIL' | 'PROCESSING';
+    /**
+     * @description 对结果的详细结果码和结果信息，在status为SUCCESS时无该字段
+     */
+    error?: {
+        /**
+         * 查询到的结果码或者错误码
+         */
+        code?: string;
+        /**
+         * 查询到的结果消息
+         */
+        message?: string;
+    };
     /**
      * 是否是用户手动取消3D
      */
@@ -25086,7 +25547,7 @@ export declare type VaultingAppearance = PickAppearance<VaultingAppearanceProps>
 export declare type VaultingAppearanceProps = {
     displaySetting: 'showCardBrandIcon';
     theme: AntomTheme;
-    variables: 'background-secondary' | 'radius-module' | 'wrapper-padding' | 'content-primary' | 'border-primary' | 'action-hover' | 'border-disable' | 'content-tertiary' | 'background-primary' | 'background-disable' | 'radius-component' | 'state-failure' | 'action-normal' | 'content-secondary';
+    variables: AntomVariables;
 };
 
 /**
@@ -25115,7 +25576,7 @@ export declare class VaultingElement extends BaseMainElement<VaultingElementConf
 declare interface VaultingElementConfig extends BaseElementConfig<VaultingAppConfig> {
 }
 
-export declare interface VaultingElementEvents extends AntomBridgeEventMap<VaultingAppConfig, VaultingSubmitParams> {
+export declare interface VaultingElementEvents extends AntomBridgeWithNativeEventMap<VaultingAppConfig, VaultingSubmitParams> {
 }
 
 /**