@alipay/ams-checkout 0.0.1726734012-dev.1 → 0.0.1726734012-dev.10

package/esm/types/index.d.ts

@@ -5,6 +5,18 @@
  * 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 * from '../core/component/element/type';
+export type onChange = () => onCnageResult;
+interface onCnageResult {
+    complete: boolean;
+    addressValue: AddressItem[];
+    selectIndex: number | string;
+}
+export type getValue = (hasValidate: boolean) => Promise<AddressValueResult>;
+interface AddressValueResult {
+    complete: boolean;
+    value: AddressItem;
+}
 /**
  * SDK options
  */
@@ -17,18 +29,20 @@ export interface IoptionsParams {
     onLog?: callOnLog;
     onEventCallback?: callOnEventCallback;
     onClose?: callOnClose;
-    networkMode?: string;
-    mode?: string;
+    onChange?: onChange;
     analytics?: {
         enabled: boolean;
     };
-    product?: string;
     onBeforeSubmit?: callOnBeforeSubmit;
+    product?: string;
+    networkMode?: string;
+    mode?: string;
+    securityRegion?: 'US' | 'SG' | 'DE';
 }
 export interface IApplePayOptionsParams extends Pick<IoptionsParams, 'locale' | 'environment' | 'onEventCallback' | 'analytics'> {
 }
 export type Iselector = string;
-export declare enum renderDisplayTypeEnum {
+export declare enum DisplayTypeEnum {
     'popup' = "popup",
     'inline' = "inline"
 }
@@ -41,7 +55,11 @@ export interface IcreatePaymentParams {
         backgroundColor?: string;
     };
 }
-export declare enum componentSignEnum {
+export declare enum ComponentSignEnumV2 {
+    'ELEMENT_PAYMENT' = "ELEMENT_PAYMENT_ALL",
+    'ELEMENT_ADDRESS' = "ELEMENT_ADDRESS_ALL"
+}
+export declare enum ComponentSignEnum {
     'EASY_PAY_WALLET' = "EASY_PAY_WALLET",
     'EASY_PAY_APM' = "EASY_PAY_APM",
     'CASHIER_PAYMENT_CARD' = "CASHIER_PAYMENT_CARD",
@@ -51,9 +69,11 @@ export declare enum componentSignEnum {
     'AUTO_DEBIT_PAY_WALLET' = "AUTO_DEBIT_PAY_WALLET",
     'NONE' = "NONE",
     'VAULTING_CARD' = "VAULTING_CARD",
-    'CHECKOUT_PAYMENT' = "CHECKOUT_PAYMENT"
+    'CHECKOUT_PAYMENT' = "CHECKOUT_PAYMENT",
+    'ELEMENT_PAYMENT' = "ELEMENT_PAYMENT_ALL",
+    'ELEMENT_ADDRESS' = "ELEMENT_ADDRESS_ALL"
 }
-export declare enum productSceneEnum {
+export declare enum ProductSceneEnum {
     'EASY_PAY' = "EASY_PAY",
     'CASHIER_PAYMENT' = "CASHIER_PAYMENT",
     'AUTO_DEBIT' = "AUTO_DEBIT",
@@ -61,34 +81,98 @@ export declare enum productSceneEnum {
     'VAULTING' = "VAULTING",
     'FLASH_BUY' = "FLASH_BUY",
     'CARD_APPLE_PAY' = "CARD_APPLE_PAY",
+    'ELEMENT_PAYMENT' = "ELEMENT_PAYMENT",
+    'ELEMENT_ADDRESS' = "ELEMENT_ADDRESS",
     'CHECKOUT_PAYMENT' = "CHECKOUT_PAYMENT"
 }
-export declare enum paymentMethodCategoryTypeEnum {
+export declare enum PaymentMethodCategoryTypeEnum {
     'CARD' = "CARD",
     'WALLET' = "WALLET",
     'BANK' = "BANK",
-    'APM' = "APM"
+    'APM' = "APM",
+    'ALL' = "ALL"
 }
 export interface DeviceIdParameter {
     scene?: string;
-    productScene?: productSceneEnum;
-    paymentMethodCategoryType?: paymentMethodCategoryTypeEnum;
+    productScene?: ProductSceneEnum;
+    paymentMethodCategoryType?: PaymentMethodCategoryTypeEnum;
     tokenCollectTime?: string;
     dataPollingInterval?: string;
 }
 export interface IcreateComponent {
     sessionData: string;
     paymentSessionData?: string;
+    elementProps?: {
+        elementLink: string;
+    };
+    appendAliasContainerId?: boolean;
     notRedirectAfterComplete?: boolean;
-    appearance?: Record<string, any>;
+    appearance?: {
+        [x: string]: any;
+        themeType?: string;
+        accentColor?: string;
+    };
+    isAppWebview?: boolean;
     merchantAppointParam?: IMerchantAppointParam;
 }
 export interface IappendIframeNodesParams extends IcreateComponent {
-    paymentSessionMetaData: IpaymentSessionMetaData;
-    renderDisplayType: renderDisplayTypeEnum;
+    paymentSessionMetaData: IPaymentSessionMetaData;
+    renderDisplayType: DisplayTypeEnum;
     selector?: Iselector;
     paypalConfiguration?: IPaypalConfiguration;
-}
+    /** 将address-element参数定义合入原参数定义 */
+    configParams?: {
+        hideFields?: string[];
+        addressAutoSuggestDisabled?: addressAutoSuggestDisabledType;
+    };
+    prefillValue?: AddressItem[];
+    componentSession?: string;
+    loca?: string;
+}
+/** 表单地址数据 */
+export interface AddressItem {
+    shippingName: {
+        firstName: string;
+        lastName: string;
+    };
+    /** 手机号 */
+    shippingPhoneNo: string;
+    /** 地址 */
+    shippingAddress: {
+        /** 国家 */
+        region: string;
+        /** 地址1 */
+        address1: string;
+        /** 地址2 */
+        address2: string;
+        /** 省份 */
+        province?: string;
+        /** 城市 */
+        city?: string;
+        /** 地址级联 四层 【province,city,district,subDistrict】 */
+        district?: string[];
+        /** 邮政编码 */
+        zipCode: string;
+        /** 对应地址级联数据对象 */
+        districtValues?: {
+            /** 城市 */
+            city?: string;
+            /** 区/县 */
+            district?: string;
+            /** 省份 */
+            province?: string;
+            /** 子区域 */
+            subDistrict?: string;
+        };
+    };
+    /** 备注 */
+    notes?: string;
+    open?: boolean;
+    /** 是否默认地址 */
+    prefer?: '1' | '0';
+    shippingId?: string;
+}
+type addressAutoSuggestDisabledType = 0 | 1;
 export interface IPaypalConfiguration {
     style?: object;
     blockPayPalCreditButton?: boolean;
@@ -119,8 +203,8 @@ export interface Isubmit {
     billingAddress?: IbillingAddress;
 }
 export interface IpaymentSessionConfig {
-    productScene: productSceneEnum;
-    paymentMethodCategoryType: paymentMethodCategoryTypeEnum;
+    productScene: ProductSceneEnum;
+    paymentMethodCategoryType?: PaymentMethodCategoryTypeEnum;
     productSceneVersion: string;
 }
 export interface IpaymentSecurityConfig {
@@ -138,14 +222,29 @@ export interface IsecurityConfig {
     h5gateway: string;
 }
 export interface InitSecurityConfig {
-    product: productSceneEnum;
+    product: ProductSceneEnum;
     region?: string;
+    securityRegion?: 'US' | 'SG' | 'DE';
 }
 export interface frontModulesToBeLoadedInterface {
     acquirerName: string;
     scriptUrl: string;
 }
-export interface IpaymentSessionMetaData {
+export interface PaymentSessionActionData {
+    amountConfirmRequired?: boolean;
+    autoDebitWithToken: boolean;
+    enableSignAgreement?: boolean;
+    skipSdkQuery: boolean;
+    requireFastSdk: boolean;
+    nonCompliant?: boolean;
+    nonInitSecuritySDK?: boolean;
+    skipSdkQueryForm?: {
+        value: boolean;
+        version: string;
+        platform: string;
+    };
+}
+export interface IPaymentSessionMetaData {
     clientId?: string;
     renderDisplayType?: string;
     paymentSessionConfig?: IpaymentSessionConfig;
@@ -153,18 +252,8 @@ export interface IpaymentSessionMetaData {
     moneyView?: any;
     extendInfo?: string;
     paymentMethodInfoView?: any;
-    action?: {
-        amountConfirmRequired?: boolean;
-        autoDebitWithToken: boolean;
-        enableSignAgreement?: boolean;
-        skipSdkQuery: boolean;
-        requireFastSdk: boolean;
-        skipSdkQueryForm?: {
-            value: boolean;
-            version: string;
-            platform: string;
-        };
-    };
+    paymentView?: any;
+    action?: PaymentSessionActionData;
     authUrlInfo?: {
         appIdentifier?: string;
         applinkUrl?: string;
@@ -235,6 +324,9 @@ export interface IpaymentSessionMetaData {
         };
         frontModulesToBeLoaded?: frontModulesToBeLoadedInterface[];
     };
+    connectFactor?: {
+        enableConnect?: boolean;
+    };
 }
 export interface IPaymentSessionFactor {
     merchantInfo?: IMerchantInfo;
@@ -281,7 +373,7 @@ export declare enum networkModeEnum {
 export interface IcheckoutState {
     paymentMethodType?: string;
 }
-export declare enum environmentEnum {
+export declare enum EnvironmentEnum {
     sandbox = "sandbox",
     prod = "prod",
     light_sandbox = "light_sandbox"
@@ -302,7 +394,7 @@ export interface Ienv {
     terminalType: terminalTypeEnum;
     environment: string;
 }
-export declare enum platformEnum {
+export declare enum PlatformEnum {
     desktop = "desktop",
     mobile = "mobile"
 }
@@ -356,19 +448,19 @@ export type callOnBeforeSubmit = (state?: Record<string, any>) => Promise<onBefo
  * @description Create an event handler, In pop-up layer mode, the user clicks the semi floating layer close button and is called.
  */
 export type callOnClose = () => void;
-export declare enum messageName {
+export declare enum MessageName {
     SDK_TO_APP = "SDK_TO_APP",
     APP_TO_SDK = "APP_TO_SDK",
     APP_TO_APP = "APP_TO_APP"
 }
-export interface eventPayload {
-    name: messageName;
+export interface EventPayload {
+    name: MessageName;
     mode?: string;
     appId?: string;
     instanceId: string;
-    context: eventPayloadContext;
+    context: EventPayloadContext;
 }
-export interface eventPayloadContext {
+export interface EventPayloadContext {
     event: string;
     data: any;
     eventCallbackId?: string;
@@ -384,7 +476,7 @@ export interface AMSCheckoutOptions {
 export interface Ianalytics {
     enabled: boolean;
 }
-export declare enum targetEnum {
+export declare enum TargetEnum {
     BLANK = "_blank",
     SELF = "_self",
     REPLACE = "_replace"
@@ -515,6 +607,7 @@ export interface CashierSubmitPayResult {
     normalUrl?: string;
     errorStatus?: string;
     message?: string;
+    traceId?: string;
 }
 export declare enum eventCodeEnum {
     SDK_START_OF_LOADING = "SDK_START_OF_LOADING",
@@ -569,6 +662,212 @@ export declare enum ProductSceneVersion {
     V2 = "2.0"
 }
 export type IAppendParams = {
-    componentSign: componentSignEnum;
+    componentSign: ComponentSignEnum;
     iframeNodesParams: IappendIframeNodesParams;
 };
+export declare enum AccountStatusEnum {
+    EFFECTIVE = "EFFECTIVE",
+    UNREGISTERED = "UNREGISTERED"
+}
+export type IAccountInfo = {
+    email?: string;
+    verifyId?: string;
+    accountStatus?: AccountStatusEnum;
+    oneAccountId?: string;
+    needOtp?: boolean;
+    errorMsg?: string;
+    inputStatus?: 'success' | 'loading' | 'error' | 'focused' | '';
+    resendLeftTimes?: number;
+};
+export interface AccountQueryRequest {
+    paymentSessionData: string;
+    paymentSessionConfig: any;
+    accountInfo: IAccountInfo;
+}
+export interface ShippingsItem {
+    shippingName: {
+        firstName: string;
+        lastName: string;
+    };
+    prefer: '1' | '0';
+    shippingId: string;
+    shippingPhoneNo: string;
+    shippingAddress: {
+        region: string;
+        state: string;
+        city: string;
+        address1: string;
+        address2: string;
+        zipCode: 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;
+}
+export interface IPaymentElement {
+    defaultValue: string;
+    elementMandatory: boolean;
+    elementType: string;
+    extendInfo: string;
+    paymentElementKey: string;
+    subPaymentElementView: ISubPaymentElementView[];
+    title: string;
+}
+export declare enum InterActionTypeEnum {
+    COLLECT_REDIRECT = "COLLECT_REDIRECT",
+    SHOW_CODE = "SHOW_CODE",
+    COLLECT_SHOW_CODE = "COLLECT_SHOW_CODE",
+    REDIRECT = "REDIRECT"
+}
+export interface IAmount {
+    amount?: string;
+    currency: string;
+    currencyLabel: string;
+    formattedAmount?: string;
+    formattedAmountWithCurrency?: string;
+    value: string;
+}
+export interface IAmountView {
+    currency: string;
+    currencyDivider: string;
+    currencyLabel: string;
+    currencySymbolPosition: 'L' | 'R';
+    formattedValue: string;
+    value: string;
+}
+export interface IPaymentMethod {
+    paymentMethodKey?: string;
+    antomPage?: string;
+    redirectUrl?: string;
+    icon?: string;
+    iconName?: string;
+    logoList?: Array<{
+        cardBrand: string;
+        logoUrl: string;
+    }>;
+    paymentMethod?: string;
+    paymentMethodName: string;
+    paymentMethodType: string;
+    category?: string;
+    paymentElements?: IPaymentElement[];
+    paymentMethodId?: string;
+    paymentMethodDetail?: {
+        last4?: string;
+        requireIssuerAuthentication?: string;
+    };
+    interActionType?: InterActionTypeEnum;
+    recommend?: boolean;
+    expressCheckout?: boolean;
+    webRedirectType?: string;
+    paymentCurrencyList?: string[];
+    paymentAmount?: IAmount;
+    paymentAmountView?: IAmountView;
+    paymentQuoteId?: string;
+}
+interface Estimate {
+    unit: string;
+    value: number;
+}
+interface DeliveryEstimate {
+    maximum: Estimate;
+    minimum: Estimate;
+}
+interface FixedAmount {
+    amount: number;
+    currency: string;
+}
+interface ShippingRateData {
+    displayName: string;
+    deliveryEstimate: DeliveryEstimate;
+    fixedAmount: FixedAmount;
+}
+export interface ShippingAddress {
+    address1: string;
+    address2: string;
+    city: string;
+    region: string;
+    state: string;
+    zipCode: string;
+}
+export interface IUserName {
+    firstName: string;
+    middleName?: string;
+    lastName: string;
+    fullName?: string;
+}
+export type Shippings = ShippingsItem[];
+export type IPaymentMethods = IPaymentMethod[];
+export interface CKPShipping {
+    shippingRateId?: string;
+    shippingRateData?: ShippingRateData;
+    shippingAddress: ShippingAddress;
+    shippingFee?: IAmount;
+    shippingFeeView?: IAmountView;
+    shippingDescription?: string;
+    deliveryEstimate?: DeliveryEstimate;
+    shippingFeeId?: string;
+    shippingName?: IUserName;
+    shippingPhoneNo?: string;
+    shipToEmail?: string;
+    notes?: string;
+}
+export interface AccountQueryResult {
+    accountInfo: IAccountInfo;
+    actionForm?: ActionForm;
+    paymentMethods: IPaymentMethods;
+    shippings: Shippings;
+    success: boolean;
+    errorCode?: string;
+    errorMessage?: string;
+    errorStatus?: string;
+    shippingInfo?: CKPShipping;
+}
+export declare enum ElementPaymentMethod {
+    CONTAINER_ELEMENT = "CONTAINER_ELEMENT",
+    AUTH_ELEMENT = "AUTH_ELEMENT",
+    ADDRESS_ELEMENT = "ADDRESS_ELEMENT",
+    PAYMENT_ELEMENT = "PAYMENT_ELEMENT"
+}
+export declare enum ElementPaymentEvent {
+    INITIAL_DATA_READY = "initialDataReady",
+    CAPTURE_ASSET = "onCaptureAsset",
+    SIGN_OUT = "onSignout",
+    BLUR = "onBlur",
+    VALIDATE = "validate",
+    SUBMIT_RISK = "onSubmitRisk",
+    AFTER_SUBMIT = "onAfterSubmit",
+    SIZE_CHANGE = "onSizeChange",
+    LAUNCH = "onLaunch",
+    CALLBACK = "callback",
+    LOG = "log"
+}
+export declare enum ConnectErrorCode {
+    RISK_REJECT = "RISK_REJECT",
+    USER_AUTH_VERIFICATION_FAILED = "USER_AUTH_VERIFICATION_FAILED",
+    USER_NOT_EXISTS = "USER_NOT_EXISTS"
+}
+export interface IoptionsAddressParams {
+    environment?: string;
+    locale?: string;
+    onSizeChanged?: callOnSizeChanged;
+    onChange?: onChange;
+    analytics?: {
+        enabled: boolean;
+    };
+    product?: string;
+}
+export declare enum RiskSdkInfoEnum {
+    NEED = "need",
+    NO_NEED = "noneed"
+}