@alipay/ams-checkout 0.0.1745390310-dev.6 → 0.0.1746673215-dev.0

package/esm/core/component/ckp/interface.d.ts

@@ -1,540 +0,0 @@
-/**
- * Copyright (c) 2022 International Business Group, Ant Group. All rights reserved.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), the rights to use, copy, modify, merge, and/or distribute the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
- * 1. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE; and
- * 2. If applicable, the use of the Software is also subject to the terms and conditions of any non-disclosure agreement signed by you and the relevant Ant Group entity.
- */
-export type Version = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
-export declare const APPLE_PAY_VERSION = 2;
-export declare const APPLE_PAY_RECURRING_VERSION = 14;
-export interface IApplePayValidateMerchantEvent {
-    validationURL: string;
-}
-export type ApplePayMerchantCapability = 'supports3DS' | 'supportsEMV' | 'supportsCredit' | 'supportsDebit';
-export type PaymentNetwork = 'amex' | 'cartesBancaires' | 'chinaUnionPay' | 'discover' | 'eftpos' | 'electron' | 'elo' | 'interac' | 'jcb' | 'mada' | 'maestro' | 'masterCard' | 'privateLabel' | 'visa' | 'vPay';
-export interface IApplePayContactField {
-    email: string;
-    name: string;
-    phone: string;
-    postalAddress: string;
-    phoneticName: string;
-}
-export declare enum RedirectTypeEnum {
-    TWO_D = "TWO_D",
-    THREE_D_IDENTIFICATION = "THREE_D_IDENTIFICATION",
-    THREE_D_ENROLLED = "THREE_D_ENROLLED"
-}
-export declare enum PaymentStatusType {
-    SUCCESS = "SUCCESS",
-    PROCESSING = "PROCESSING",
-    FAIL = "FAIL",
-    CANCELLED = "CANCELLED",
-    EXPIRED = "EXPIRED"
-}
-export type DisplayType = 'TEXT_BUTTON' | 'TEXT_ICON' | 'QRCODE' | 'QRCODE_IMAGE' | 'TEXT_REMINDER';
-export interface Instructions {
-    /**
-     * @description title
-     */
-    title: string;
-    /**
-     * @description steps
-     */
-    steps: string;
-    /**
-     * @description unfold
-     */
-    unfolded?: boolean;
-}
-export interface ApplePayPaymentSessionRequest {
-    validateUrl: string;
-    paymentSessionData: string;
-}
-export interface ActionForm {
-    redirectUrl?: string;
-    method?: 'POST' | 'GET';
-    actionFormType?: any;
-    parameters?: string;
-    redirectType: RedirectTypeEnum;
-    challengeType?: 'EMAIL_OTP' | string;
-    paymentCodeExpireTime?: string;
-    verifyId?: string;
-}
-export interface RateInfo {
-    rateId: string;
-    effectiveTime: string;
-    expireTime: string;
-    rate: {
-        rate: string;
-        rateValue: number;
-        exchangeCurrency: string;
-        baseCurrency: string;
-        exchangeRelation: string;
-    };
-}
-export interface CodeFormViews {
-    /**
-     * @description title
-     */
-    title: string;
-    /**
-     * @description code
-     */
-    code: string;
-    /**
-     * @description priority
-     */
-    priority: string;
-    /**
-     * @description displayType
-     */
-    displayType: DisplayType;
-    /**
-     * @description catogory
-     */
-    catogory?: string;
-    /**
-     * @description instructions
-     */
-    instructions?: Instructions[];
-    label: string;
-    /**
-     * A+ 钱包展码过期时间
-     */
-    codeExpireTime?: string;
-}
-export interface IPaymentFeeChargeInfo {
-    preChargeNo: string;
-    chargeAmount: IAmount;
-    chargeAmountView: IAmountView;
-}
-export interface InstructionGuideView {
-    expireCountDown?: string;
-    instructionGuideContent?: string;
-    instructionGuideUrl?: string;
-    logoUrl?: string;
-    paymentMethodType?: string;
-}
-export interface CashierSubmitPayResult {
-    actionForm?: ActionForm;
-    applinkUrl?: string;
-    normalUrl?: string;
-    schemeUrl?: string;
-    authUrl?: string;
-    appIdentifier?: string;
-    success: boolean;
-    errorCode?: string;
-    errorMessage?: string;
-    errorStatus?: string;
-    extendInfo?: any;
-    rateInfo?: RateInfo;
-    codeFormViews?: CodeFormViews[];
-    paymentFeeChargeInfo?: IPaymentFeeChargeInfo;
-    orderAmount: IAmount;
-    orderAmountView: IAmountView;
-    paymentAmount: IAmount;
-    paymentAmountView: IAmountView;
-    paymentExchangeAmount: IAmount;
-    paymentExchangeAmountView?: IAmountView;
-    instructionGuideView?: InstructionGuideView;
-    paymentStatus?: PaymentStatusType;
-    paymentResultCode?: string;
-    paymentResultMessage?: string;
-}
-export interface IApplePayPaymentContact {
-    phoneNumber: string;
-    emailAddress: string;
-    givenName: string;
-    familyName: string;
-    phoneticGivenName: string;
-    phoneticFamilyName: string;
-    addressLines: string;
-    subLocality: string;
-    locality: string;
-    postalCode: string;
-    subAdministrativeArea: string;
-    administrativeArea: string;
-    country: string;
-    countryCode: string;
-}
-export type IApplePayLineItemType = 'final' | 'pending';
-export type ApplePayPaymentTiming = 'immediate' | 'recurring' | 'deferred' | 'automaticReload';
-export type ApplePayRecurringPaymentDateUnit = 'year' | 'month' | 'day' | 'hour' | 'minute';
-/**
- *
-{
-    "label": "Subscription",
-    "amount": "20.00",
-    "type": "final",
-    "paymentTiming": "recurring",
-    "recurringPaymentStartDate": new Date("2022-01-01T00:00:00"),
-    "recurringPaymentIntervalUnit": "month",
-    "recurringPaymentIntervalCount": 6,
-    "recurringPaymentEndDate": new Date("2024-01-01T00:00:00"),
-}
- */
-export interface IApplePayLineItem {
-    /**
-     * A value that indicates whether the line item is final or pending.
-     */
-    type: IApplePayLineItemType;
-    /**
-     * A required value that’s a short, localized description of the line item.
-     */
-    label: string;
-    /**
-     * A required value that’s the monetary amount of the line item.
-     */
-    amount: string;
-    paymentTiming?: ApplePayPaymentTiming;
-    recurringPaymentStartDate?: Date;
-    recurringPaymentEndDate?: Date;
-    recurringPaymentIntervalUnit?: ApplePayRecurringPaymentDateUnit;
-    recurringPaymentIntervalCount?: number;
-    deferredPaymentDate?: Date;
-    automaticReloadPaymentThresholdAmount?: string;
-}
-export type applePayShippingType = 'shipping' | 'delivery' | 'storePickup' | 'servicePickup';
-export interface IApplePayShippingMethod {
-    label: string;
-    detail: string;
-    amount: string;
-    identifier: string;
-}
-export interface IApplePayPayment {
-    token: any;
-    billingContact?: IApplePayPaymentContact;
-    shippingContact?: IApplePayPaymentContact;
-}
-export interface IApplePayPaymentAuthorizedEvent {
-    payment: IApplePayPayment;
-}
-export type status = 'STATUS_SUCCESS' | 'STATUS_FAILURE' | 'STATUS_INVALID_BILLING_POSTAL_ADDRESS' | 'STATUS_INVALID_SHIPPING_POSTAL_ADDRESS' | 'STATUS_INVALID_SHIPPING_CONTACT' | 'STATUS_PIN_INCORRECT' | 'STATUS_PIN_LOCKOUT' | 'STATUS_PIN_REQUIRED';
-export interface IApplePayPaymentAuthorizationResult {
-    status: any;
-    errors?: string[];
-}
-export interface IApplePayPaymentRequest {
-    merchantCapabilities?: string[];
-    supportedNetworks?: string[];
-    countryCode: string;
-    requiredBillingContactFields?: IApplePayContactField[];
-    billingContact?: IApplePayPaymentContact;
-    requiredShippingContactFields?: IApplePayContactField[];
-    shippingContact?: IApplePayPaymentContact;
-    applicationData?: string;
-    supportedCountries?: string[];
-    total: IApplePayLineItem;
-    lineItems?: IApplePayLineItem[];
-    currencyCode: string;
-    shippingType?: applePayShippingType;
-    shippingMethods?: IApplePayShippingMethod[];
-    recurringPaymentRequest?: IApplePayRecurringPaymentRequest;
-}
-export interface IApplePayRecurringPaymentRequest {
-    /**
-     * A description of the recurring payment that Apple Pay displays to the user in the payment sheet.
-     */
-    paymentDescription: string;
-    /**
-     * A localized billing agreement that the payment sheet displays to the user before the user authorizes the payment.
-     */
-    billingAgreement?: string;
-    /**
-     * The regular billing cycle for the recurring payment, including start and end dates, an interval, and an interval count.
-     */
-    regularBilling: IApplePayLineItem;
-    /**
-     * 订阅试用的周期控制，暂时不需要
-     * The trial billing cycle for the recurring payment.
-     */
-    trialBilling?: IApplePayLineItem;
-    /**
-     * A URL to a web page where the user can update or delete the payment method for the recurring payment.
-     */
-    managementURL: string;
-    /**
-     * A URL you provide for receiving life-cycle notifications from the Apple Pay servers about the Apple Pay merchant token for the recurring payment.
-     */
-    tokenNotificationURL?: string;
-}
-export interface IApplePaySession {
-    supportsVersion?: (version: Version) => boolean;
-    canMakePayments?: () => boolean;
-    canMakePaymentsWithActiveCard?: (merchantIdentifier: string) => Promise<boolean>;
-    begin: () => void;
-    onvalidatemerchant: (event: IApplePayValidateMerchantEvent) => void;
-    completeMerchantValidation: (merchantSession: any) => void;
-    onpaymentauthorized: (event: IApplePayPaymentAuthorizedEvent) => void;
-    completePayment: (result: IApplePayPaymentAuthorizationResult) => void;
-    oncancel?: () => void;
-    abort?: () => void;
-}
-export type IGetMerchantSession = (params: {
-    displayName?: string;
-    merchantIdentifier?: string;
-    validationUrl: string;
-}) => Promise<any>;
-export type ICompletePaymentAuthorized = (params: {
-    paymentToken?: string;
-    billingContact?: any;
-    shippingContact?: any;
-}) => Promise<any>;
-export type ICompleteApplePay = (data: any) => void;
-export type ILogError = (code: string, msg: string, error?: any) => void;
-export declare enum ProductSceneEnum {
-    'EASY_PAY' = "EASY_PAY",
-    'CASHIER_PAYMENT' = "CASHIER_PAYMENT",
-    'AUTO_DEBIT' = "AUTO_DEBIT",
-    'AUTO_DEBIT_PAY' = "AUTO_DEBIT_PAY",
-    'VAULTING' = "VAULTING",
-    'FLASH_BUY' = "FLASH_BUY",
-    'CARD_APPLE_PAY' = "CARD_APPLE_PAY",
-    'CHECKOUT_PAYMENT' = "CHECKOUT_PAYMENT"
-}
-export type ApplePaySubTypeEnum = 'ApplePayRecurringPayment';
-export interface frontModulesToBeLoadedInterface {
-    acquirerName: string;
-    scriptUrl: string;
-}
-export declare enum PaymentMethodCategoryTypeEnum {
-    'CARD' = "CARD",
-    'WALLET' = "WALLET",
-    'BANK' = "BANK",
-    'APM' = "APM"
-}
-export interface IpaymentSessionConfig {
-    productScene: ProductSceneEnum;
-    paymentMethodCategoryType: PaymentMethodCategoryTypeEnum;
-    productSceneVersion: string;
-}
-export interface IpaymentSecurityConfig {
-    appId: string;
-    appName: string;
-    bizToken: string;
-    gateway: string;
-    h5gateway: string;
-    tokenCollectTime?: string;
-    dataPollingInterval?: string;
-    workSpaceId: string;
-}
-export declare enum eventCodeEnum {
-    SDK_START_OF_LOADING = "SDK_START_OF_LOADING",
-    SDK_END_OF_LOADING = "SDK_END_OF_LOADING",
-    SDK_INTERNAL_ERROR = "SDK_INTERNAL_ERROR",
-    SDK_CREATEPAYMENT_PARAMETER_ERROR = "SDK_CREATEPAYMENT_PARAMETER_ERROR",
-    SDK_INIT_PARAMETER_ERROR = "SDK_INIT_PARAMETER_ERROR",
-    SDK_CREATECOMPONENT_ERROR = "SDK_CREATECOMPONENT_ERROR",
-    SDK_CALL_URL_ERROR = "SDK_CALL_URL_ERROR",
-    SDK_CALL_URL_SUCCESS = "SDK_CALL_URL_SUCCESS",
-    SDK_PAYMENT_SUCCESSFUL = "SDK_PAYMENT_SUCCESSFUL",
-    SDK_PAYMENT_FAIL = "SDK_PAYMENT_FAIL",
-    SDK_PAYMENT_ERROR = "SDK_PAYMENT_ERROR",
-    SDK_PAYMENT_CANCEL = "SDK_PAYMENT_CANCEL",
-    /**
-     * 当前为Apple Pay发起了Pay请求，但是用户关闭了页面
-     */
-    SDK_PAYMENT_PROCESSING = "SDK_PAYMENT_PROCESSING",
-    SDK_PAYMENT_WARN = "SDK_PAYMENT_WARN",
-    SDK_PAYMENT_SHIPPINGCHANGE = "SDK_PAYMENT_SHIPPINGCHANGE",
-    SDK_PAYMENT_APPROVE = "SDK_PAYMENT_APPROVE"
-}
-export declare enum environmentEnum {
-    sandbox = "sandbox",
-    prod = "prod",
-    light_sandbox = "light_sandbox"
-}
-export declare enum redirectTypeEnum {
-    UNSAFE_BROWSER = "UNSAFE_BROWSER",// 非安全浏览器
-    SAFETY_BROWSER = "SAFETY_BROWSER",// 安全浏览器
-    INVOKE_SDK = "INVOKE_SDK"
-}
-export interface RequestInterface {
-    countryCode: string;
-    currencyCode: string;
-    merchantCapabilities: string[];
-    supportedNetworks: string[];
-    total: {
-        label: string;
-        type: string;
-        amount: string;
-    };
-}
-export interface ApplePayPaymentRequest {
-    version?: number;
-    supportedNetworks: string[];
-    requiredBillingContactFields?: string[];
-    requiredShippingContactFields?: string[];
-    merchantInfo: {
-        instMid: string;
-        merchantName: string;
-        countryCode: string;
-    };
-    paymentAmount: {
-        value: string;
-        currency: string;
-    };
-    order?: {
-        orderDescription: string;
-    };
-    merchantCapabilities: string[];
-}
-export interface ApplyPayParams {
-    isScriptLoaded: boolean;
-    isScriptLoadSucceed: boolean;
-    paymentRequest: ApplePayPaymentRequest;
-    paymentSessionData: string;
-    isDarkTheme?: boolean;
-    isAbbreviation?: boolean;
-    device?: string;
-    loading?: boolean;
-    disabled?: boolean;
-    className?: string;
-    paymentStartFn: () => void;
-    paymentEndFn: (result: any) => void;
-    doSubmit: (paymentMethod: IPaymentMethod) => any;
-    paymentMethod: IPaymentMethod;
-    checkDisabledBeforeSubmit?: (paymentMethod: IPaymentMethod) => Promise<boolean>;
-    isExpressBtn?: boolean;
-    productScene?: 'ELEMENT';
-}
-export interface AppleResultData {
-    status: boolean;
-    result?: any;
-    error?: {
-        errorCode: string;
-    };
-}
-export interface ISubPaymentElementView {
-    defaultText: string;
-    defaultValue: string;
-    elementMandatory: boolean;
-    elementRegx?: string;
-    elementType: string;
-    extendInfo: string;
-    paramIllegalText: string;
-    paymentElementKey: string;
-    title: string;
-    validateFunction?: string;
-    isPart?: boolean;
-    isPartEnd?: boolean;
-}
-interface CurrencyConfiguration {
-    supportedMerchantRegion: string[];
-}
-export interface CurrencySupportConfiguration {
-    [currencyCode: string]: CurrencyConfiguration;
-}
-export interface IAmount {
-    amount?: string;
-    currency: string;
-    currencyLabel: string;
-    formattedAmount?: string;
-    formattedAmountWithCurrency?: string;
-    value: string;
-    __extendInfo__?: {
-        traceId?: string;
-        rpc?: string;
-        amountKey?: string;
-    };
-}
-export interface IAmountView {
-    currency: string;
-    currencyDivider: string;
-    currencyLabel: string;
-    currencySymbolPosition: 'L' | 'R';
-    formattedValue: string;
-    value: string;
-    __extendInfo__?: {
-        traceId?: string;
-        rpc?: string;
-        amountKey?: string;
-    };
-}
-export declare enum InterActionTypeEnum {
-    COLLECT_REDIRECT = "COLLECT_REDIRECT",
-    SHOW_CODE = "SHOW_CODE",
-    COLLECT_SHOW_CODE = "COLLECT_SHOW_CODE",
-    REDIRECT = "REDIRECT"
-}
-export interface IPaymentElement {
-    defaultText?: string;
-    defaultValue: string;
-    elementMandatory: boolean;
-    elementType: string;
-    extendInfo: string;
-    paymentElementKey: string;
-    subPaymentElementView?: ISubPaymentElementView[];
-    title: string;
-    paymentMethodType?: string;
-    linkPaymentElementKey?: string;
-    bankDataNeedPageRequest?: boolean;
-    topHasOtherElement?: boolean;
-}
-export interface IPaymentMethod {
-    paymentMethodKey?: string;
-    antomPage?: string;
-    redirectUrl?: string;
-    icon?: string;
-    iconName?: string;
-    logoList?: Array<{
-        cardBrand: string;
-        logoUrl: string;
-    }>;
-    bankInfoList?: {
-        bankIdentifierCode?: string;
-        bankShortName?: string;
-        logoUrl?: string;
-        logo?: {
-            logoUrl?: string;
-        };
-    }[];
-    paymentMethod?: string;
-    paymentMethodName: string;
-    paymentMethodType: string;
-    category?: string;
-    paymentElements?: IPaymentElement[];
-    paymentMethodId?: string;
-    paymentMethodDetail?: {
-        last4?: string;
-        requireIssuerAuthentication?: string;
-        applePayProps?: {
-            environment?: string;
-            paymentRequest?: ApplePayPaymentRequest;
-        };
-        googlePayProps?: any;
-    };
-    interActionType?: InterActionTypeEnum;
-    recommend?: boolean;
-    expressCheckout?: boolean;
-    webRedirectType?: string;
-    paymentCurrencyList?: string[];
-    paymentAmount?: IAmount;
-    paymentAmountView?: IAmountView;
-    paymentQuoteId?: string;
-    paymentFactors?: {
-        [key: string]: any;
-    };
-    subPaymentMethodView?: IPaymentMethod[];
-    currencySupportConfiguration?: CurrencySupportConfiguration;
-    refundNonInsured?: boolean;
-}
-export interface RequestData {
-    merchantCapabilities?: string[];
-    supportedNetworks?: string[];
-    countryCode: string;
-    requiredBillingContactFields?: IApplePayContactField[];
-    billingContact?: IApplePayPaymentContact;
-    requiredShippingContactFields?: IApplePayContactField[];
-    shippingContact?: IApplePayPaymentContact;
-    applicationData?: string;
-    supportedCountries?: string[];
-    total: IApplePayLineItem;
-    lineItems?: IApplePayLineItem[];
-    currencyCode: string;
-    shippingType?: applePayShippingType;
-    shippingMethods?: IApplePayShippingMethod[];
-    recurringPaymentRequest?: IApplePayRecurringPaymentRequest;
-}
-export {};