@adyen/adyen-web 6.24.0 → 6.25.0

package/dist/es/index.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="applepayjs" />
 /// <reference types="googlepay" />
 import * as preact from 'preact';
-import { h, ComponentChild, Ref, FunctionComponent } from 'preact';
+import { h, ComponentChild, Ref, FunctionComponent, Component } from 'preact';
 
 /**
  * Holds the result of a validation
@@ -130,6 +130,8 @@ declare class Resources {
     getImage(props?: ImageOptions): GetImageFnType;
 }
 
+type PlaceholderKeys$1 = 'cardNumber' | 'securityCode' | 'expiryDate';
+type Placeholders$1 = Partial<Record<PlaceholderKeys$1, string>>;
 type GiftcardFieldsProps = {
     setRootNode: (input: HTMLElement) => void;
     i18n: Language;
@@ -141,6 +143,52 @@ type GiftcardFieldsProps = {
     label?: string;
 };
 
+type Placeholders = CardPlaceholders | Placeholders$1;
+/**
+ * Should be the only props that can be sent to SFP (from CardInput, SecuredFieldsInput, AchInput, GiftcardComponent)
+ */
+interface SFPProps {
+    autoFocus?: boolean;
+    brands?: string[];
+    brandsConfiguration?: CardBrandsConfiguration;
+    clientKey: string;
+    countryCode?: string;
+    forceCompat?: boolean;
+    hasKoreanFields?: boolean;
+    i18n: Language;
+    implementationType?: string;
+    keypadFix?: boolean;
+    koreanAuthenticationRequired?: boolean;
+    legacyInputMode?: boolean;
+    loadingContext: string;
+    minimumExpiryDate?: string;
+    onAdditionalSFConfig?: () => {};
+    onAdditionalSFRemoved?: () => {};
+    onAllValid?: () => {};
+    onAutoComplete?: () => {};
+    onBinValue?: () => {};
+    onBrand?: () => {};
+    onChange: () => {};
+    onConfigSuccess?: () => {};
+    onError?: () => {};
+    onFieldValid?: () => {};
+    onFocus?: () => {};
+    onLoad?: () => {};
+    onStateUpdate: (obj: SFPState) => void;
+    handleKeyPress?: (obj: KeyboardEvent) => void;
+    rootNode: HTMLElement;
+    showWarnings?: boolean;
+    styles?: StylesObject;
+    trimTrailingSeparator?: boolean;
+    type: string;
+    render: () => {};
+    resources: Resources;
+    maskSecurityCode: boolean;
+    exposeExpiryDate: boolean;
+    disableIOSArrowKeys: (obj: TouchStartEventObj) => void | null;
+    placeholders?: Placeholders;
+    showContextualElement?: boolean;
+}
 interface SFPState {
     status?: string;
     brand?: string;
@@ -157,6 +205,10 @@ interface SFPState {
     expiryDatePolicy?: DatePolicyType;
     socialSecurityNumber?: string;
 }
+interface SingleBrandResetObject {
+    brand: string;
+    cvcPolicy: CVCPolicyType;
+}
 interface SFPValid {
     encryptedCardNumber?: boolean;
     encryptedExpiryMonth?: boolean;
@@ -676,6 +728,9 @@ interface SFError {
     rootNode: HTMLElement;
     detectedBrands?: string[];
 }
+interface SFStateErrorObj {
+    [key: string]: SFError;
+}
 
 interface ValidationRuleErrorObj {
     [key: string]: ValidationRuleResult;
@@ -1301,6 +1356,10 @@ interface InstallmentOptions {
         preselectedValue?: number;
     };
 }
+interface TouchStartEventObj {
+    fieldType: string;
+    name?: string;
+}
 
 type CheckoutSession = {
     id: string;
@@ -2882,6 +2941,16 @@ interface GiftCardConfiguration extends UIElementProps {
      */
     fieldsLayoutComponent?: FunctionComponent<GiftcardFieldsProps>;
 }
+/**
+ * Unified error interface that matches useForm error structure for gift cards
+ */
+interface GiftCardValidationError {
+    isValid: boolean;
+    errorMessage: string;
+    errorI18n?: string;
+    error?: string;
+}
+type GiftCardBalanceCheckErrorType = 'no-balance' | 'card-error' | 'currency-error';
 
 interface GooglePayConfiguration extends UIElementProps {
     type?: 'googlepay' | 'paywithgoogle';
@@ -3764,11 +3833,10 @@ interface AwaitComponentProps {
     classNameModifiers?: string[];
     clientKey: string;
     onError: (error: any) => void;
-    onComplete: (status: any, component: any) => void;
+    onComplete: (status: any) => void;
     brandLogo?: string;
     messageText?: string;
     awaitText: string;
-    ref?: any;
     onActionHandled?: (rtnObj: ActionHandledReturnObject) => void;
     pollStatus?: () => Promise<RawPaymentResponse>;
     instructions?: string | (() => h.JSX.Element);
@@ -4708,8 +4776,150 @@ declare class EPSElement extends IssuerListContainer {
     formatProps(props: any): any;
 }
 
+/**
+ * SecuredFieldsProvider:
+ * Initialises & handles the client-side part of SecuredFields
+ */
+declare class SecuredFieldsProvider extends Component<SFPProps, SFPState> {
+    private csfLoadFailTimeout;
+    private csfLoadFailTimeoutMS;
+    private csfConfigFailTimeout;
+    private csfConfigFailTimeoutMS;
+    private numCharsInField;
+    private rootNode;
+    private numDateFields;
+    private csf;
+    private handleOnLoad;
+    private handleOnConfigSuccess;
+    private handleOnFieldValid;
+    private handleOnAllValid;
+    private handleOnBrand;
+    private handleFocus;
+    private handleOnError;
+    private handleOnAutoComplete;
+    private handleOnNoDataRequired;
+    private handleOnTouchstartIOS;
+    private handleKeyPressed;
+    state: SFPState;
+    props: any;
+    private issuingCountryCode;
+    constructor(props: SFPProps);
+    static defaultProps: {
+        type: string;
+        keypadFix: boolean;
+        rootNode: any;
+        loadingContext: any;
+        brands: any[];
+        showWarnings: boolean;
+        autoFocus: boolean;
+        trimTrailingSeparator: boolean;
+        onChange: () => void;
+        onLoad: () => void;
+        onConfigSuccess: () => void;
+        onAllValid: () => void;
+        onFieldValid: () => void;
+        onBrand: () => void;
+        onError: () => void;
+        onBinValue: () => void;
+        onFocus: () => void;
+        onAutoComplete: () => void;
+        handleKeyPress: () => void;
+        styles: {};
+    };
+    componentDidMount(): void;
+    componentDidUpdate(): void;
+    componentWillUnmount(): void;
+    private initializeCSF;
+    private checkForKCPFields;
+    getChildContext(): object;
+    handleUnsupportedCard(errObj: CardErrorData): boolean;
+    setFocusOn(frame: string): void;
+    updateStyles(stylesObj: StylesObject): void;
+    sfIsOptionalOrHidden(fieldType: string): boolean;
+    destroy(): void;
+    showValidation(): void;
+    /**
+     * Map SF errors to ValidationRuleResult-like objects, for CardInput component
+     */
+    mapErrorsToValidationRuleResult(): SFStateErrorObj;
+    processBinLookupResponse(binLookupResponse: BinLookupResponse, resetObject: SingleBrandResetObject): void;
+    private setRootNode;
+    render(props: any, state: any): any;
+}
+
+interface GiftcardComponentProps {
+    onChange: (state: any) => void;
+    onFocus: (event: any) => void;
+    onBlur: (event: any) => void;
+    makeBalanceCheck: (event: any) => void;
+    makePayment: (event: any) => void;
+    amount?: PaymentAmount;
+    showPayButton: boolean;
+    payButton: (config: any) => any;
+    pinRequired: boolean;
+    expiryDateRequired?: boolean;
+    fieldsLayoutComponent: FunctionComponent<GiftcardFieldsProps>;
+    placeholders?: Placeholders$1;
+    handleKeyPress?: (o: KeyboardEvent) => void;
+}
+declare class Giftcard extends Component<GiftcardComponentProps> {
+    state: {
+        status: string;
+        data: {};
+        balance: any;
+        transactionLimit: any;
+        focusedElement: boolean;
+        isValid: boolean;
+        sfpState: {};
+        isValidating: boolean;
+        transformedErrors: {};
+    };
+    static defaultProps: {
+        pinRequired: boolean;
+        expiryDateRequired: boolean;
+        onChange: () => void;
+        onFocus: () => void;
+        onBlur: () => void;
+        fieldsLayoutComponent: (props: GiftcardFieldsProps) => h.JSX.Element;
+    };
+    sfp: SecuredFieldsProvider;
+    /**
+     * Maps string error codes from SecuredFields to validation rule objects
+     */
+    mapErrorsToValidationObjects: () => SFStateErrorObj;
+    private updateTransformedErrors;
+    onChange: (sfpState: any) => void;
+    handleFocus: (e: any) => void;
+    setBalance: ({ balance, transactionLimit }: {
+        balance: any;
+        transactionLimit: any;
+    }) => void;
+    /**
+     * Generates balance check errors in the same format as SFP errors
+     * Compatible with the transformedErrors structure
+     */
+    private generateBalanceCheckErrors;
+    /**
+     * Checks if a status represents a balance check error
+     */
+    private isBalanceCheckError;
+    /**
+     * Method called by GiftcardElement to set balance check errors only
+     */
+    setBalanceCheckErrors: (errorType: GiftCardBalanceCheckErrorType | null) => void;
+    showValidation: () => void;
+    render(props: any, { focusedElement, balance, transactionLimit, isValidating, transformedErrors }: {
+        focusedElement: any;
+        balance: any;
+        transactionLimit: any;
+        isValidating: any;
+        transformedErrors: any;
+    }): h.JSX.Element;
+}
+
 declare class GiftcardElement extends UIElement<GiftCardConfiguration> {
     static type: TxVariants;
+    protected componentRef: Giftcard | undefined;
     protected static defaultProps: {
         brandsConfiguration: {};
     };
@@ -4718,6 +4928,7 @@ declare class GiftcardElement extends UIElement<GiftCardConfiguration> {
     get isValid(): boolean;
     get icon(): any;
     get displayName(): any;
+    private setBalanceCheckError;
     private handleBalanceCheck;
     private onOrderRequest;
     balanceCheck(): void;
@@ -7366,4 +7577,4 @@ declare namespace AdyenCheckout {
 }
 
 export { ANCVElement as ANCV, AchElement as Ach, AddressElement as Address, AdyenCheckout, AdyenCheckoutError, Affirm, AfterPay, AfterPayB2B, AmazonPayElement as AmazonPay, ApplePayElement as ApplePay, Atome, BacsElement as BacsDirectDebit, BancontactElement as Bancontact, BankTransferElement as BankTransfer, BCMCMobileElement as BcmcMobile, BillDeskOnlineElement as BillDeskOnline, BillDeskWalletElement as BillDeskWallet, BlikElement as Blik, BoletoElement as Boleto, CardElement as Card, CashAppPay, ClickToPayElement as ClickToPay, Core, CustomCard, DokuElement as Doku, DonationElement as Donation, DotpayElement as Dotpay, DragonpayElement as Dragonpay, DropinElement as Dropin, DuitNowElement as DuitNow, EPSElement as EPS, EcontextElement as Econtext, FacilyPay10x as FacilPay10x, FacilyPay12x as FacilPay12x, FacilyPay3x as FacilPay3x, FacilyPay4x as FacilPay4x, FacilyPay6x as FacilPay6x, Fastlane, FastlaneSDK, GiftcardElement as Giftcard, GiropayElement as Giropay, GooglePay, KlarnaPayments as Klarna, MBWayElement as MBWay, MealVoucherFRElement as MealVoucherFR, MolPayEBankingMYElement as MolPayEBankingMY, MolPayEBankingTHElement as MolPayEBankingTH, MolPayEbankingVNElement as MolPayEBankingVN, MultibancoElement as Multibanco, OnlineBankingCZElement as OnlineBankingCZ, OnlineBankingFI, OnlineBankingINElement as OnlineBankingIN, OnlineBankingPL, OnlineBankingSKElement as OnlineBankingSK, OxxoElement as Oxxo, PayByBank, PayByBankPixElement as PayByBankPix, PayByBankUS, PayMeElement as PayMe, PayNowElement as PayNow, PaypalElement as PayPal, PayToElement as PayTo, PayuNetCashcardElement as PayuCashcard, PayuNetBankingElement as PayuNetBanking, PersonalDetailsElement as PersonalDetails, PixElement as Pix, PreAuthorizedDebitCanada, PromptPayElement as PromptPay, RatePay, RatePayDirectDebit, RedirectElement as Redirect, Riverty, SepaElement as SepaDirectDebit, SwishElement as Swish, ThreeDS2Challenge, ThreeDS2DeviceFingerprint, TrustlyElement as Trustly, TwintElement as Twint, UIElement, UPI, VippsElement as Vipps, WalletINElement as WalletIN, WeChatPayElement as WeChat, index_d as components, initializeFastlane };
-export type { ANCVConfiguration, ANCVDataState, AchConfiguration, AchPlaceholders, ActionDescriptionType, ActionHandledReturnObject, AdditionalDetailsActions, AdditionalDetailsData, AddressData, AddressField, AmazonPayBackendConfiguration, AmazonPayButtonProps, AmazonPayButtonSettings, AmazonPayComponentProps, AmazonPayConfiguration, AmazonPayElementData, AnalyticsModule, App, ApplePayButtonStyle, ApplePayButtonType, ApplePayConfiguration, ApplePayElementData, ApplePayPaymentAuthorizationResult, ApplePayPaymentOrderDetails, ApplePaySessionRequest, ApplePayWebConfiguration, AwaitComponentProps, AwaitConfiguration, BankDetailsSchema, BankTransferConfiguration, BankTransferSchema, BankTransferState, BeforeSubmitActions, BinLookupResponse, BinLookupResponseRaw, BoletoConfiguration, BoletoElementProps, BoletoInputDataState, BoletoInputErrorState, BoletoInputValidState, BrandConfiguration, BrandObject, BrowserInfo, CReqData, CardAllValidData, CardAutoCompleteData, CardBackendConfiguration, CardBinLookupData, CardBinValueData, CardBrandData, CardBrandsConfiguration, CardConfigSuccessData, CardConfiguration, CardElementData, CardErrorData, CardFieldValidData, CardFocusData, CardLoadData, CardPlaceholders, CashAppPayConfiguration, CashAppPayElementData, CashAppPayEventData, ChallengeData, ChallengeResolveData, ChangeActionOptions, ChangePaymentDetailsButtonProps, ChargeAmount, CheckoutAdvancedFlowResponse, CheckoutDetailsRequest, CheckoutSessionConfig, ClickToPayConfiguration, ClickToPayPaymentData, ClickToPayProps, ClickToPayScheme, CommonVoucherProps, ComponentFocusObject, ComponentMethodsRef, CoreConfiguration, CoreModules, Currency, CustomCardConfiguration, CustomTranslations, DecodeObject, DeliverySpecifications, DokuVoucherResultProps, DonationConfiguration, DragonpayConfiguraton, DragonpayInputData, DragonpayInputIssuerItem, DragonpayInputProps, DragonpayVoucherResultProps, DropinComponentProps, DropinComponentState, DropinConfiguration, DropinStatus, DropinStatusProps, DualBrandSelectElement, EcontextConfiguration, EcontextInputSchema, EcontextVoucherResultProps, ErrorCodeObject, ExtendedMerchantInfo, FastlaneAddress, FastlaneAuthenticatedCustomerResult, FastlaneConfiguration, FastlaneConsentRenderState, FastlaneOptions, FastlanePaymentMethodConfiguration, FastlaneProfile, FastlaneSDKConfiguration, FastlaneShipping, FastlaneShippingAddressSelectorResult, FastlaneSignupConfiguration, FastlaneWindowInstance, FieldsetVisibility, FingerPrintData, FingerprintResolveData, FundingSource, GiftCardConfiguration, GiftCardElementData, GooglePayConfiguration, GooglePaymentDataRequest, ICore, IDropin, InstantPaymentTypes, Intent, IssuerListConfiguration, IssuerListData, KlarnaAction, KlarnaAdditionalDetailsData, KlarnaComponentRef, KlarnaConfiguration, KlarnaSdkData, KlarnaWidgetAuthorizeResponse, KlarnaWidgetProps, LedgerCurrencies, LegacyChallengeResolveData, LegacyFingerprintResolveData, MandateFrequencyType, MandateType, MultibancoVoucherResultProps, OnChangeData, OpenInvoiceActiveFieldsets, OpenInvoiceConfiguration, OpenInvoiceFieldsetsRefs, OpenInvoiceProps, OpenInvoiceStateData, OpenInvoiceStateError, OpenInvoiceStateValid, OpenInvoiceVisibility, Order, OrderButtonProps, OrderStatus, OxxoVoucherResultProps, PayButtonFunctionProps, PayPalConfiguration, PayToConfiguration, PayToData, PayToPlaceholdersType, PayloadJSON, PaymentAction, PaymentActionsType, PaymentAmount, PaymentAmountExtended, PaymentCompletedData, PaymentData, PaymentFailedData, PaymentMethod, PaymentMethodData, PaymentMethodGroup, PaymentMethodOptions, PaymentMethods$1 as PaymentMethods, PaymentMethodsConfiguration, PaymentMethodsRequestData, PaymentMethodsResponse, PaymentResponseData, PersonalDetailsSchema, PixConfiguration, PixElementData, PostMsgParseErrorObject, PreAuthorizedDebitCanadaConfiguration, PreAuthorizedDebitCanadaPlaceholders, ProcessedResponse, QRLoaderConfiguration, RawPaymentResponse, RecurringMetadata, RedirectConfiguration, Region, ResultCode, ResultObject, ResultValue, SepaConfiguration, SepaElementData, SessionsResponse, SignOutButtonProps, SocialSecurityMode, StatusFromAction, StatusObject, StoredPaymentMethod, SubmitActions, SubmitData, SupportedLocale, ThreeDS2ChallengeConfiguration, ThreeDS2DeviceFingerprintConfiguration, ThreeDS2FingerprintResponse, ThreeDS2FlowObject, ThreeDS2Token, UIElementProps, UIElementStatus, UPIConfiguration, UpdateAmazonCheckoutSessionRequest, UpiMode, UpiPaymentData, UpiType, ValidationError, VoucherConfiguration, VoucherDetail, VoucherProps, balanceCheckResponseType, onBalanceCheckCallbackType, onOrderCancelData, onOrderCancelType, onOrderRequestCallbackType, onRequiringConfirmationCallbackType };
+export type { ANCVConfiguration, ANCVDataState, AchConfiguration, AchPlaceholders, ActionDescriptionType, ActionHandledReturnObject, AdditionalDetailsActions, AdditionalDetailsData, AddressData, AddressField, AmazonPayBackendConfiguration, AmazonPayButtonProps, AmazonPayButtonSettings, AmazonPayComponentProps, AmazonPayConfiguration, AmazonPayElementData, AnalyticsModule, App, ApplePayButtonStyle, ApplePayButtonType, ApplePayConfiguration, ApplePayElementData, ApplePayPaymentAuthorizationResult, ApplePayPaymentOrderDetails, ApplePaySessionRequest, ApplePayWebConfiguration, AwaitComponentProps, AwaitConfiguration, BankDetailsSchema, BankTransferConfiguration, BankTransferSchema, BankTransferState, BeforeSubmitActions, BinLookupResponse, BinLookupResponseRaw, BoletoConfiguration, BoletoElementProps, BoletoInputDataState, BoletoInputErrorState, BoletoInputValidState, BrandConfiguration, BrandObject, BrowserInfo, CReqData, CardAllValidData, CardAutoCompleteData, CardBackendConfiguration, CardBinLookupData, CardBinValueData, CardBrandData, CardBrandsConfiguration, CardConfigSuccessData, CardConfiguration, CardElementData, CardErrorData, CardFieldValidData, CardFocusData, CardLoadData, CardPlaceholders, CashAppPayConfiguration, CashAppPayElementData, CashAppPayEventData, ChallengeData, ChallengeResolveData, ChangeActionOptions, ChangePaymentDetailsButtonProps, ChargeAmount, CheckoutAdvancedFlowResponse, CheckoutDetailsRequest, CheckoutSessionConfig, ClickToPayConfiguration, ClickToPayPaymentData, ClickToPayProps, ClickToPayScheme, CommonVoucherProps, ComponentFocusObject, ComponentMethodsRef, CoreConfiguration, CoreModules, Currency, CustomCardConfiguration, CustomTranslations, DecodeObject, DeliverySpecifications, DokuVoucherResultProps, DonationConfiguration, DragonpayConfiguraton, DragonpayInputData, DragonpayInputIssuerItem, DragonpayInputProps, DragonpayVoucherResultProps, DropinComponentProps, DropinComponentState, DropinConfiguration, DropinStatus, DropinStatusProps, DualBrandSelectElement, EcontextConfiguration, EcontextInputSchema, EcontextVoucherResultProps, ErrorCodeObject, ExtendedMerchantInfo, FastlaneAddress, FastlaneAuthenticatedCustomerResult, FastlaneConfiguration, FastlaneConsentRenderState, FastlaneOptions, FastlanePaymentMethodConfiguration, FastlaneProfile, FastlaneSDKConfiguration, FastlaneShipping, FastlaneShippingAddressSelectorResult, FastlaneSignupConfiguration, FastlaneWindowInstance, FieldsetVisibility, FingerPrintData, FingerprintResolveData, FundingSource, GiftCardBalanceCheckErrorType, GiftCardConfiguration, GiftCardElementData, GiftCardValidationError, GooglePayConfiguration, GooglePaymentDataRequest, ICore, IDropin, InstantPaymentTypes, Intent, IssuerListConfiguration, IssuerListData, KlarnaAction, KlarnaAdditionalDetailsData, KlarnaComponentRef, KlarnaConfiguration, KlarnaSdkData, KlarnaWidgetAuthorizeResponse, KlarnaWidgetProps, LedgerCurrencies, LegacyChallengeResolveData, LegacyFingerprintResolveData, MandateFrequencyType, MandateType, MultibancoVoucherResultProps, OnChangeData, OpenInvoiceActiveFieldsets, OpenInvoiceConfiguration, OpenInvoiceFieldsetsRefs, OpenInvoiceProps, OpenInvoiceStateData, OpenInvoiceStateError, OpenInvoiceStateValid, OpenInvoiceVisibility, Order, OrderButtonProps, OrderStatus, OxxoVoucherResultProps, PayButtonFunctionProps, PayPalConfiguration, PayToConfiguration, PayToData, PayToPlaceholdersType, PayloadJSON, PaymentAction, PaymentActionsType, PaymentAmount, PaymentAmountExtended, PaymentCompletedData, PaymentData, PaymentFailedData, PaymentMethod, PaymentMethodData, PaymentMethodGroup, PaymentMethodOptions, PaymentMethods$1 as PaymentMethods, PaymentMethodsConfiguration, PaymentMethodsRequestData, PaymentMethodsResponse, PaymentResponseData, PersonalDetailsSchema, PixConfiguration, PixElementData, PostMsgParseErrorObject, PreAuthorizedDebitCanadaConfiguration, PreAuthorizedDebitCanadaPlaceholders, ProcessedResponse, QRLoaderConfiguration, RawPaymentResponse, RecurringMetadata, RedirectConfiguration, Region, ResultCode, ResultObject, ResultValue, SepaConfiguration, SepaElementData, SessionsResponse, SignOutButtonProps, SocialSecurityMode, StatusFromAction, StatusObject, StoredPaymentMethod, SubmitActions, SubmitData, SupportedLocale, ThreeDS2ChallengeConfiguration, ThreeDS2DeviceFingerprintConfiguration, ThreeDS2FingerprintResponse, ThreeDS2FlowObject, ThreeDS2Token, UIElementProps, UIElementStatus, UPIConfiguration, UpdateAmazonCheckoutSessionRequest, UpiMode, UpiPaymentData, UpiType, ValidationError, VoucherConfiguration, VoucherDetail, VoucherProps, balanceCheckResponseType, onBalanceCheckCallbackType, onOrderCancelData, onOrderCancelType, onOrderRequestCallbackType, onRequiringConfirmationCallbackType };