@alipay/ams-checkout 2.0.28 → 2.0.30

package/esm/modern/modern/sdk/elements/PaymentElement.d.ts

@@ -0,0 +1,204 @@
+import { type RequestOptions } from '@antintl/antom-toolset';
+import { type BaseElementAppConfig, type BaseElementConfig, BaseMainElement, type ErrorPayload } from '@antintl/opensdk-core';
+import type { CashierSdkActionQueryResult, OneAccountQueryResult, PaymentSessionConfig } from '../oneapi/iexpfront/definitions';
+import { type IPaymentSessionMetaData } from '../tools/getMetaData';
+import { type GetApplePayTokenReply, type GetApplePayTokenRequest } from '../tools/paymentElement/applePayHostToken';
+import { type GetGooglePayTokenReply, type GetGooglePayTokenRequest } from '../tools/paymentElement/googlePayHostToken';
+import { type AntomBridgeWithNativeEventMap, type AntomLayouts, type AntomTheme, type AntomVariables, type AppearanceVariables, type SubmitParams, type SubmitResult } from '../types';
+import { type AppearanceRuleSelector, type PickAntomAppearance } from './appearanceRules';
+/**
+ * @description Payment element appearance properties
+ */
+export type PaymentAppearanceProps = {
+    displaySetting: 'showPaymentMethodListWhenSingleOption' | 'showCardBrandIcon' | 'showRadioWhenAccordionLayout' | 'showCardCVV';
+    theme: AntomTheme;
+    variables: AppearanceVariables | AntomVariables;
+    layout: AntomLayouts;
+    rules: AppearanceRuleSelector<string>;
+};
+/**
+ * @description Payment element appearance type
+ */
+export type PaymentAppearance = PickAntomAppearance<PaymentAppearanceProps>;
+/**
+ * @description Payment element app config type
+ */
+export interface PaymentAppConfig extends BaseElementAppConfig {
+    /** Payment appearance configuration including optional alias-only Rules. */
+    appearance?: PaymentAppearance;
+    /**
+     * @description sessionData，无法通过updateConfig更新
+     */
+    sessionData?: string;
+    /**
+     * @internal sdk所在hostname
+     */
+    merchantDomain?: string;
+    doMain?: 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 Elements2 preload grouping data. */
+    preloadTelemetryContext?: import('../types').PreloadTelemetryContext;
+    /**
+     * @internal 内部使用，无需用户传递，高度信息
+     */
+    heightOfVisible?: number;
+    /**
+     * Amount & Currency
+     *
+     * Only effective via `updateConfig({ amount })` at runtime.
+     */
+    amount?: {
+        currency: string;
+        value: string;
+    };
+}
+export interface ShippingInfo {
+    shippingName: {
+        firstName: string;
+        lastName: string;
+        middleName?: string;
+        fullName?: string;
+    };
+    shippingPhoneNo: string;
+    shippingAddress: {
+        region: string;
+        address1: string;
+        address2: string;
+        city?: string;
+        state?: string;
+        zipCode: string;
+    };
+}
+/**
+ * @description The submit params
+ */
+export interface PaymentSubmitParams extends SubmitParams {
+    /**
+     * @description 是否由antom sdk自动处理唤端逻辑，默认为true，由sdk自动处理。
+     * 如果antom sdk唤起客户端失败，建议设置为false，商家自行唤端
+     */
+    handleActions?: boolean;
+    /**
+     * @description 收件地址信息
+     */
+    shippingInfo?: ShippingInfo;
+    /**
+     * @description 集成用户自定义信息（如 cardHolderName）
+     */
+    params?: Record<string, unknown>;
+}
+/**
+ * @description Payment element submit result
+ */
+export 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;
+    };
+}
+/**
+ * @description Payment element events
+ */
+export interface PaymentElementEvents extends AntomBridgeWithNativeEventMap<PaymentAppConfig, PaymentSubmitParams, PaymentSubmitResult> {
+    /**
+     * webapp 委托 host(父 frame)拉起 Apple Pay 拿 token。
+     * payload 结构对齐 ModernElementController.GetApplePayTokenRequest(放 paymentMethod/shipping)。
+     */
+    'OPENSDK@GET_APPLE_PAY_TOKEN': GetApplePayTokenRequest;
+    /** host 完成 Apple Pay token 获取后回包给 webapp */
+    'OPENSDK@GET_APPLE_PAY_TOKEN_REPLY': GetApplePayTokenReply;
+    /**
+     * webapp 委托 host(父 frame)拉起 Google Pay 拿 token。
+     * payload 结构对齐 ModernElementController.GetGooglePayTokenRequest(放 data.environment/paymentRequest)。
+     */
+    '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;
+    };
+}
+/**
+ * @description Payment element config type
+ */
+interface PaymentElementConfig extends BaseElementConfig<PaymentAppConfig> {
+}
+/**
+ * @description Payment element
+ */
+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
+     */
+    updateConfig(newConfig: Partial<PaymentAppConfig>): Promise<PaymentElementEvents['OPENSDK@UPDATE_CONFIG_REPLY']>;
+    /**
+     * @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;
+}
+export {};

package/esm/modern/modern/sdk/elements/appearanceRules.d.ts

@@ -0,0 +1,59 @@
+import type { PickAppearance } from '@antintl/opensdk-core';
+/** Semantic states accepted by the merchant selector grammar. */
+type AppearanceRuleState = 'hover' | 'focus' | 'focus-visible' | 'active' | 'disabled' | 'loading' | 'selected' | 'checked' | 'expanded' | 'invalid' | 'success' | 'error';
+/** Controlled pseudo-class accepted by the merchant selector grammar. */
+type AppearanceRulePseudoClass = 'autofill';
+/** Controlled pseudo-element accepted by the merchant selector grammar. */
+type AppearanceRulePseudoElement = 'placeholder' | 'selection';
+/**
+ * Optional state or controlled pseudo suffix on one alias.
+ */
+export type AppearanceRuleScopeSuffix = '' | `:${AppearanceRuleState | AppearanceRulePseudoClass}` | `::${AppearanceRulePseudoElement}`;
+/** One merchant alias with an optional semantic suffix. */
+export type AppearanceRuleSelector<RuleAlias extends string> = `${RuleAlias}${AppearanceRuleScopeSuffix}`;
+/** Paint-only property names exposed by the SDK contract. */
+export type AppearancePaintProperty = 'color' | 'WebkitTextFillColor' | 'textDecorationColor' | 'textDecorationLine' | 'textDecorationStyle' | 'textShadow' | 'backgroundColor' | 'borderColor' | 'borderTopColor' | 'borderRightColor' | 'borderBottomColor' | 'borderLeftColor' | 'borderRadius' | 'borderTopLeftRadius' | 'borderTopRightRadius' | 'borderBottomRightRadius' | 'borderBottomLeftRadius' | 'borderStyle' | 'boxShadow' | 'fill' | 'stroke' | 'fillOpacity' | 'strokeOpacity' | 'strokeWidth' | 'outlineColor' | 'outlineStyle' | 'outlineWidth' | 'outlineOffset' | 'caretColor' | 'accentColor';
+/** Controlled layout longhands intersected with the concrete Part at runtime. */
+export type AppearanceLayoutProperty = 'marginTop' | 'marginRight' | 'marginBottom' | 'marginLeft' | 'paddingTop' | 'paddingRight' | 'paddingBottom' | 'paddingLeft' | 'height';
+/** Exact official spacing Token accepted by controlled margin and padding. */
+export type AppearanceSpacingToken = `var(--spacing-${'base' | 'none' | '2xs' | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | '2xl' | '3xl'})`;
+/** Runtime-constrained non-negative integer pixel value for spacing longhands. */
+export type AppearanceSpacingValue = '0' | `${number}px` | AppearanceSpacingToken;
+/** Paint declarations accepted before WebApp and Components runtime validation. */
+type AppearancePaintDeclarations = Partial<Record<Exclude<AppearancePaintProperty, 'fillOpacity' | 'strokeOpacity' | 'strokeWidth' | 'textDecorationStyle' | 'outlineStyle'>, string> & Record<'fillOpacity' | 'strokeOpacity' | 'strokeWidth', string | number> & {
+    textDecorationStyle: '-moz-initial' | 'inherit' | 'initial' | 'revert' | 'revert-layer' | 'unset' | 'dashed' | 'dotted' | 'double' | 'solid' | 'wavy';
+    outlineStyle: '-moz-initial' | 'inherit' | 'initial' | 'revert' | 'revert-layer' | 'unset' | 'auto' | 'dashed' | 'dotted' | 'double' | 'groove' | 'inset' | 'none' | 'outset' | 'ridge' | 'solid';
+}>;
+/** Target-level layout declarations admitted before runtime capability intersection. */
+export type AppearanceLayoutDeclarations = {
+    [Property in Exclude<AppearanceLayoutProperty, 'height'>]?: AppearanceSpacingValue;
+} & {
+    /** Exact integer-pixel enum allocated by the target contract. */
+    readonly height?: `${number}px`;
+};
+/** Paint declarations plus controlled typography and target-level layout fields. */
+type AppearanceRuleDeclarations = AppearancePaintDeclarations & AppearanceLayoutDeclarations & {
+    /** Single font family identifier admitted only for authorized targets at runtime. */
+    readonly fontFamily?: string;
+    /** Integer pixel size admitted only for authorized text targets at runtime. */
+    readonly fontSize?: `${number}px`;
+    /** Controlled font weight admitted only for authorized text targets at runtime. */
+    readonly fontWeight?: 400 | 500 | 600 | 700;
+    /** Controlled font style admitted only for authorized text targets at runtime. */
+    readonly fontStyle?: 'normal' | 'italic';
+};
+/** Builds an Antom appearance type with the restricted Rules declaration contract. */
+export type PickAntomAppearance<T extends Record<string, any>> = PickAppearance<T, AppearanceRuleDeclarations>;
+type AppearanceRulesAppConfig = {
+    appearance?: {
+        rules?: unknown;
+    };
+};
+/**
+ * Resets stored Rules before the core deep merge handles an explicit empty patch.
+ *
+ * @param currentConfig - Current complete SDK configuration.
+ * @param update - Merchant configuration patch being merged.
+ */
+export declare function prepareAppearanceRulesUpdate(currentConfig: AppearanceRulesAppConfig, update: AppearanceRulesAppConfig): void;
+export {};

package/esm/modern/modern/sdk/elements/appearanceRulesDefaults.d.ts

@@ -0,0 +1,2 @@
+/** Shared immutable snapshot used when an Element must send an explicit Rules clear. */
+export declare const EMPTY_APPEARANCE_RULES: Readonly<{}>;

package/esm/modern/modern/sdk/eventsMap.d.ts

@@ -0,0 +1,135 @@
+import type { BaseBridgeEventMap } from "@antintl/opensdk-core";
+import type { AntomOpenModalConfig, SubmitResult } from "./types";
+/**
+ * @description native回调错误信息格式
+ * @internal
+ */
+export interface CallbackErrorInfo {
+    code: string;
+    message?: string;
+    needChangeSessionForRetry?: boolean;
+    traceId?: string;
+    context?: string;
+}
+/**
+ * @description native回调会话下一步操作，包含了回调的url
+ * @internal
+ */
+export interface CallbackSessionNextAction {
+    normalUrl?: string;
+    schemeUrl?: string;
+    applinkUrl?: string;
+}
+/**
+ * @description native回调返回数据
+ * @internal
+ */
+export interface CallbackReturnData {
+    status?: string;
+    userCanceled3D?: boolean;
+    isExposed?: boolean;
+    error?: CallbackErrorInfo;
+    session?: {
+        nextAction?: CallbackSessionNextAction;
+    };
+}
+/**
+ * 给中间页使用的桥接事件类型
+ * @internal 内部使用，不暴露到外部
+ */
+export interface AntomMiddlePageEventMap extends AntomBridgeEventMap {
+    /**
+     * @description 3DS流程完成
+     * @deprecated 使用auto_close_modal
+     */
+    three_ds_end: void;
+    /**
+     * @description 正常结束自动关闭事件
+     */
+    auto_close_modal: void;
+}
+/**
+ * AntomBridge事件类型，包含了SDK与webapp通信的所有事件类型
+ */
+export 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 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;
+    };
+}

package/esm/modern/modern/sdk/oneapi/iexpfront/PaymentSessionService.d.ts

@@ -0,0 +1,69 @@
+import type { RequestOptions } from '@antintl/antom-toolset';
+import { ApplePayPaymentSessionRequest, ApplePayPaymentSessionResponse, CashierSdkActionQueryRequest, CashierSdkActionQueryResult, ChannelClientIdQueryRequest, ChannelClientIdQueryResult, InquiryPaymentBySessionResult, MobileSessionRequest, OneAccountQueryRequest, OneAccountQueryResult, SubmitPayByPaymentSessionRequest, SubmitPayByPaymentSessionResult } from './definitions';
+export { preConnection } from './preConnection';
+/**
+ * @description 查询渠道clientId
+ * @param channelClientIdQueryRequest
+ * @return
+ * @method com.ipay.iexpfront.channelClientId.query
+ *
+ */
+export declare function channelClientIdQuery(payload: ChannelClientIdQueryRequest, extraParams?: RequestOptions): Promise<ChannelClientIdQueryResult & {
+    traceId?: string;
+    errorMessage?: string;
+}>;
+/**
+ * @description 创建ApplePay支付会话，用于Apple Pay Web
+ * @param request 会话请求
+ * @return 会话对象
+ * @method com.ipay.iexpcashier.cashier.createApplePayPaymentSession
+ *
+ */
+export declare function createApplePayPaymentSession(payload: ApplePayPaymentSessionRequest, extraParams?: RequestOptions): Promise<ApplePayPaymentSessionResponse & {
+    traceId?: string;
+    errorMessage?: string;
+}>;
+/**
+ * @description 根据session查询支付结果
+ * @param mobileSessionRequest session
+ * @return
+ * @method com.ipay.iexpfront.sdk.inquiryPaymentBySession
+ *
+ */
+export declare function inquiryPaymentBySession(payload: MobileSessionRequest, extraParams?: RequestOptions): Promise<InquiryPaymentBySessionResult & {
+    traceId?: string;
+    errorMessage?: string;
+}>;
+/**
+ * @description one account 账户信息查询
+ * @param accountQueryRequest
+ * @return
+ * @method com.ipay.iexpfront.one.account.query
+ *
+ */
+export declare function oneAccountQuery(payload: OneAccountQueryRequest, extraParams?: RequestOptions): Promise<OneAccountQueryResult & {
+    traceId?: string;
+    errorMessage?: string;
+}>;
+/**
+ * @description sdk action 编排接口，要素二次收集和确认等
+ * @param cashierSdkActionQueryRequest sessionData等
+ * @return 端交互信息
+ * @method com.ipay.iexpcashier.sdkAction.query
+ *
+ */
+export declare function sdkQuery(payload: CashierSdkActionQueryRequest, extraParams?: RequestOptions): Promise<CashierSdkActionQueryResult & {
+    traceId?: string;
+    errorMessage?: string;
+}>;
+/**
+ * @description 支付要素提交，完成支付
+ * @param submitPayByPaymentSessionRequest 提交支付session
+ * @return 提交支付结果
+ * @method com.ipay.iexpcashier.cashier.submitPayByPaymentSession
+ *
+ */
+export declare function submitPayByPaymentSession(payload: SubmitPayByPaymentSessionRequest, extraParams?: RequestOptions): Promise<SubmitPayByPaymentSessionResult & {
+    traceId?: string;
+    errorMessage?: string;
+}>;