@adyen/adyen-web 5.2.2 → 5.5.0

package/dist/types/language/types.d.ts

@@ -1,7 +1,7 @@
-import locales from './locales';
-export declare type Locales = keyof typeof locales;
-export declare type CustomTranslations = {
-    [key: string]: {
-        [message: string]: string;
-    };
-};
+import locales from './locales';
+export declare type Locales = keyof typeof locales;
+export declare type CustomTranslations = {
+    [key: string]: {
+        [message: string]: string;
+    };
+};

package/dist/types/language/utils.d.ts

@@ -1,39 +1,39 @@
-/**
- * Matches a string with one of the locales
- * @param locale -
- * @param supportedLocales -
+/**
+ * Matches a string with one of the locales
+ * @param locale -
+ * @param supportedLocales -
 
- * @example
- * matchLocale('en-GB');
- * // 'en-US'
- */
-export declare function matchLocale(locale: string, supportedLocales: any): string;
-/**
- * Returns a locale with the proper format
- * @param localeParam -
- *
- * @example
- * formatLocale('En_us');
- * // 'en-US'
- */
-export declare function formatLocale(localeParam: string): string;
-/**
- * Checks the locale format.
- * Also checks if it's on the locales array.
- * If it is not, tries to match it with one.
- * @param locale -
- * @param supportedLocales -
- */
-export declare function parseLocale(locale: string, supportedLocales?: string[]): string;
-/**
- * Formats the locales inside the customTranslations object against the supportedLocales
- * @param customTranslations -
- * @param supportedLocales -
- */
-export declare function formatCustomTranslations(customTranslations: object, supportedLocales: string[]): object;
-/**
- * Returns an array with all the locales
- * @param locale - The locale the user wants to use
- * @param customTranslations -
- */
-export declare const loadTranslations: (locale: string, customTranslations?: object) => Promise<any>;
+ * @example
+ * matchLocale('en-GB');
+ * // 'en-US'
+ */
+export declare function matchLocale(locale: string, supportedLocales: any): string;
+/**
+ * Returns a locale with the proper format
+ * @param localeParam -
+ *
+ * @example
+ * formatLocale('En_us');
+ * // 'en-US'
+ */
+export declare function formatLocale(localeParam: string): string;
+/**
+ * Checks the locale format.
+ * Also checks if it's on the locales array.
+ * If it is not, tries to match it with one.
+ * @param locale -
+ * @param supportedLocales -
+ */
+export declare function parseLocale(locale: string, supportedLocales?: string[]): string;
+/**
+ * Formats the locales inside the customTranslations object against the supportedLocales
+ * @param customTranslations -
+ * @param supportedLocales -
+ */
+export declare function formatCustomTranslations(customTranslations: object, supportedLocales: string[]): object;
+/**
+ * Returns an array with all the locales
+ * @param locale - The locale the user wants to use
+ * @param customTranslations -
+ */
+export declare const loadTranslations: (locale: string, customTranslations?: object) => Promise<any>;

package/dist/types/types/index.d.ts

@@ -1,210 +1,214 @@
-import paymentMethods from '../components';
-import { ADDRESS_SCHEMA } from '../components/internal/Address/constants';
-import actionTypes from '../core/ProcessResponse/PaymentAction/actionTypes';
-export declare type PaymentActionsType = keyof typeof actionTypes;
-/**
- * {@link https://docs.adyen.com/api-explorer/#/PaymentSetupAndVerificationService/v51/payments__resParam_action API Explorer /payments action}
- */
-export interface PaymentAction {
-    /**
-     * General type of action that needs to be taken by the client
-     */
-    type: PaymentActionsType | string;
-    /**
-     * Refinement of type of action that needs to be taken by the client (currently only applies to the new 'threeDS2' type)
-     */
-    subtype?: string;
-    /**
-     * Specifies the payment method.
-     */
-    paymentMethodType: string;
-    /**
-     * When non-empty, contains a value that you must submit to the /payments/details endpoint. In some cases, required for polling.
-     */
-    paymentData?: string;
-    authorisationToken?: string;
-    /**
-     * Specifies the HTTP method, for example GET or POST.
-     */
-    method?: string;
-    /**
-     * Specifies the URL to redirect to.
-     */
-    url?: string;
-    alternativeReference?: string;
-    downloadUrl?: string;
-    entity?: string;
-    expiresAt?: string;
-    instructionsUrl?: string;
-    issuer?: string;
-    maskedTelephoneNumber?: string;
-    merchantName?: string;
-    merchantReference?: string;
-    reference?: string;
-    shopperEmail?: string;
-    shopperName?: string;
-    qrCodeData?: string;
-    /**
-     * A token to pass to the 3DS2 Component to get the fingerprint/challenge.
-     */
-    token?: string;
-    /**
-     * An object containing data to be used in external SDKs like PayPal Buttons SDK.
-     */
-    sdkData?: {
-        [key: string]: any;
-    };
-}
-export interface PaymentMethod {
-    /**
-     * The unique payment method code.
-     */
-    type: string;
-    /**
-     * The displayable name of this payment method.
-     */
-    name: string;
-    /**
-     * All input details to be provided to complete the payment with this payment method.
-     */
-    details?: object;
-    /**
-     * Configuration props as set by the merchant in the CA and received in the PM object in the /paymentMethods response
-     */
-    configuration?: object;
-}
-export interface StoredPaymentMethod extends PaymentMethod {
-    /**
-     * The supported shopper interactions for this stored payment method.
-     */
-    supportedShopperInteractions: string[];
-    /**
-     * A unique identifier of this stored payment method.
-     */
-    storedPaymentMethodId?: string;
-}
-/**
- * List of the available payment methods
- * {@link https://docs.adyen.com/api-explorer/#/PaymentSetupAndVerificationService/v51/paymentMethods API Explorer /paymentMethods}.
- */
-export interface PaymentMethodsResponseInterface {
-    /**
-     * Detailed list of payment methods required to generate payment forms.
-     */
-    paymentMethods: PaymentMethod[];
-    /**
-     * List of all stored payment methods.
-     */
-    storedPaymentMethods: StoredPaymentMethod[];
-}
-export interface PaymentResponse {
-    type: string;
-    resultCode: string;
-    url?: string;
-}
-export interface ProcessedResponse {
-    type: string;
-    props?: object;
-}
-/**
- * {@link https://docs.adyen.com/api-explorer/#/PaymentSetupAndVerificationService/v52/payments__reqParam_amount API Explorer /payments amount}
- */
-export interface PaymentAmount {
-    value: number;
-    currency: string;
-}
-export declare type AddressField = typeof ADDRESS_SCHEMA[number];
-export declare type AddressData = {
-    [key in AddressField]?: string;
-};
-export interface PersonalDetailsSchema {
-    firstName?: string;
-    lastName?: string;
-    gender?: string;
-    dateOfBirth?: string;
-    shopperEmail?: string;
-    telephoneNumber?: string;
-}
-export interface Order {
-    /**
-     * The encrypted order data.
-     */
-    orderData: string;
-    /**
-     * The pspReference that belongs to the order.
-     */
-    pspReference: string;
-    /**
-     * The remaining amount to complete the order.
-     */
-    remainingAmount?: PaymentAmount;
-}
-export interface OrderStatus {
-    expiresAt: string;
-    paymentMethods: {
-        lastFour: string;
-        type: string;
-    }[];
-    pspReference: string;
-    reference: string;
-    remainingAmount: PaymentAmount;
-}
-/**
- * {@link https://docs.adyen.com/api-explorer/#/PaymentSetupAndVerificationService/v52/post/payments__reqParam_browserInfo API Explorer /payments browserInfo}
- */
-export interface BrowserInfo {
-    acceptHeader: string;
-    colorDepth: string;
-    language: string;
-    javaEnabled: boolean;
-    screenHeight: string;
-    screenWidth: string;
-    userAgent: string;
-    timeZoneOffset: number;
-}
-/**
- * Available components
- */
-export declare type PaymentMethods = typeof paymentMethods;
-/**
- * Options for a component
- */
-export declare type PaymentMethodOptions<P extends keyof PaymentMethods> = InstanceType<PaymentMethods[P]>['props'];
-/**
- * Visibility options for a fieldset
- */
-export declare type FieldsetVisibility = 'editable' | 'hidden' | 'readOnly';
-export declare type CheckoutSession = {
-    id: string;
-    sessionData: string;
-};
-export declare type CheckoutSessionSetupResponse = {
-    id: string;
-    sessionData: string;
-    amount: PaymentAmount;
-    expiresAt: string;
-    paymentMethods: any;
-    returnUrl: string;
-};
-export declare type CheckoutSessionPaymentResponse = {
-    sessionData: string;
-    status?: string;
-    resultCode?: string;
-    action?: PaymentAction;
-};
-export declare type CheckoutSessionDetailsResponse = {
-    sessionData: string;
-    status?: string;
-    resultCode?: string;
-    action?: PaymentAction;
-};
-export declare type CheckoutSessionBalanceResponse = {
-    sessionData: string;
-    balance?: PaymentAmount;
-    transactionLimit?: PaymentAmount;
-};
-export declare type CheckoutSessionOrdersResponse = {
-    sessionData: string;
-    orderData: string;
-    pspReference: string;
-};
+import paymentMethods from '../components';
+import { ADDRESS_SCHEMA } from '../components/internal/Address/constants';
+import actionTypes from '../core/ProcessResponse/PaymentAction/actionTypes';
+export declare type PaymentActionsType = keyof typeof actionTypes;
+/**
+ * {@link https://docs.adyen.com/api-explorer/#/PaymentSetupAndVerificationService/v51/payments__resParam_action API Explorer /payments action}
+ */
+export interface PaymentAction {
+    /**
+     * General type of action that needs to be taken by the client
+     */
+    type: PaymentActionsType | string;
+    /**
+     * Refinement of type of action that needs to be taken by the client (currently only applies to the new 'threeDS2' type)
+     */
+    subtype?: string;
+    /**
+     * Specifies the payment method.
+     */
+    paymentMethodType: string;
+    /**
+     * When non-empty, contains a value that you must submit to the /payments/details endpoint. In some cases, required for polling.
+     */
+    paymentData?: string;
+    authorisationToken?: string;
+    /**
+     * Specifies the HTTP method, for example GET or POST.
+     */
+    method?: string;
+    /**
+     * Specifies the URL to redirect to.
+     */
+    url?: string;
+    alternativeReference?: string;
+    downloadUrl?: string;
+    entity?: string;
+    expiresAt?: string;
+    instructionsUrl?: string;
+    issuer?: string;
+    maskedTelephoneNumber?: string;
+    merchantName?: string;
+    merchantReference?: string;
+    reference?: string;
+    shopperEmail?: string;
+    shopperName?: string;
+    qrCodeData?: string;
+    /**
+     * A token to pass to the 3DS2 Component to get the fingerprint/challenge.
+     */
+    token?: string;
+    /**
+     * An object containing data to be used in external SDKs like PayPal Buttons SDK.
+     */
+    sdkData?: {
+        [key: string]: any;
+    };
+}
+export interface PaymentMethod {
+    /**
+     * The unique payment method code.
+     */
+    type: string;
+    /**
+     * The displayable name of this payment method.
+     */
+    name: string;
+    /**
+     * All input details to be provided to complete the payment with this payment method.
+     */
+    details?: object;
+    /**
+     * Configuration props as set by the merchant in the CA and received in the PM object in the /paymentMethods response
+     */
+    configuration?: object;
+    /**
+     * Brands available for this payment method
+     */
+    brands?: string[];
+}
+export interface StoredPaymentMethod extends PaymentMethod {
+    /**
+     * The supported shopper interactions for this stored payment method.
+     */
+    supportedShopperInteractions: string[];
+    /**
+     * A unique identifier of this stored payment method.
+     */
+    storedPaymentMethodId?: string;
+}
+/**
+ * List of the available payment methods
+ * {@link https://docs.adyen.com/api-explorer/#/PaymentSetupAndVerificationService/v51/paymentMethods API Explorer /paymentMethods}.
+ */
+export interface PaymentMethodsResponseInterface {
+    /**
+     * Detailed list of payment methods required to generate payment forms.
+     */
+    paymentMethods: PaymentMethod[];
+    /**
+     * List of all stored payment methods.
+     */
+    storedPaymentMethods: StoredPaymentMethod[];
+}
+export interface PaymentResponse {
+    type: string;
+    resultCode: string;
+    url?: string;
+}
+export interface ProcessedResponse {
+    type: string;
+    props?: object;
+}
+/**
+ * {@link https://docs.adyen.com/api-explorer/#/PaymentSetupAndVerificationService/v52/payments__reqParam_amount API Explorer /payments amount}
+ */
+export interface PaymentAmount {
+    value: number;
+    currency: string;
+}
+export declare type AddressField = typeof ADDRESS_SCHEMA[number];
+export declare type AddressData = {
+    [key in AddressField]?: string;
+};
+export interface PersonalDetailsSchema {
+    firstName?: string;
+    lastName?: string;
+    gender?: string;
+    dateOfBirth?: string;
+    shopperEmail?: string;
+    telephoneNumber?: string;
+}
+export interface Order {
+    /**
+     * The encrypted order data.
+     */
+    orderData: string;
+    /**
+     * The pspReference that belongs to the order.
+     */
+    pspReference: string;
+    /**
+     * The remaining amount to complete the order.
+     */
+    remainingAmount?: PaymentAmount;
+}
+export interface OrderStatus {
+    expiresAt: string;
+    paymentMethods: {
+        lastFour: string;
+        type: string;
+    }[];
+    pspReference: string;
+    reference: string;
+    remainingAmount: PaymentAmount;
+}
+/**
+ * {@link https://docs.adyen.com/api-explorer/#/PaymentSetupAndVerificationService/v52/post/payments__reqParam_browserInfo API Explorer /payments browserInfo}
+ */
+export interface BrowserInfo {
+    acceptHeader: string;
+    colorDepth: string;
+    language: string;
+    javaEnabled: boolean;
+    screenHeight: string;
+    screenWidth: string;
+    userAgent: string;
+    timeZoneOffset: number;
+}
+/**
+ * Available components
+ */
+export declare type PaymentMethods = typeof paymentMethods;
+/**
+ * Options for a component
+ */
+export declare type PaymentMethodOptions<P extends keyof PaymentMethods> = InstanceType<PaymentMethods[P]>['props'];
+/**
+ * Visibility options for a fieldset
+ */
+export declare type FieldsetVisibility = 'editable' | 'hidden' | 'readOnly';
+export declare type CheckoutSession = {
+    id: string;
+    sessionData: string;
+};
+export declare type CheckoutSessionSetupResponse = {
+    id: string;
+    sessionData: string;
+    amount: PaymentAmount;
+    expiresAt: string;
+    paymentMethods: any;
+    returnUrl: string;
+};
+export declare type CheckoutSessionPaymentResponse = {
+    sessionData: string;
+    status?: string;
+    resultCode?: string;
+    action?: PaymentAction;
+};
+export declare type CheckoutSessionDetailsResponse = {
+    sessionData: string;
+    status?: string;
+    resultCode?: string;
+    action?: PaymentAction;
+};
+export declare type CheckoutSessionBalanceResponse = {
+    sessionData: string;
+    balance?: PaymentAmount;
+    transactionLimit?: PaymentAmount;
+};
+export declare type CheckoutSessionOrdersResponse = {
+    sessionData: string;
+    orderData: string;
+    pspReference: string;
+};

package/dist/types/utils/Script.d.ts

@@ -1,24 +1,24 @@
-/**
- * Creates a script element from a certain source in the passed node selector.
- * If no selector is passed it will add the script element in the body.
- *
- * @example
- * ```
- * const script = new Script('https://example.com/script.js', '.container');
- * script.load().then(doSomething);
- *
- * // To clean up just call the remove method
- * script.remove();
- * ```
- */
-declare class Script {
-    private readonly script;
-    private readonly src;
-    private readonly node;
-    private readonly attributes;
-    private readonly dataAttributes;
-    constructor(src: any, node?: string, attributes?: Partial<HTMLScriptElement>, dataAttributes?: Record<string, string | undefined>);
-    load: () => Promise<any>;
-    remove: () => void;
-}
-export default Script;
+/**
+ * Creates a script element from a certain source in the passed node selector.
+ * If no selector is passed it will add the script element in the body.
+ *
+ * @example
+ * ```
+ * const script = new Script('https://example.com/script.js', '.container');
+ * script.load().then(doSomething);
+ *
+ * // To clean up just call the remove method
+ * script.remove();
+ * ```
+ */
+declare class Script {
+    private readonly script;
+    private readonly src;
+    private readonly node;
+    private readonly attributes;
+    private readonly dataAttributes;
+    constructor(src: any, node?: string, attributes?: Partial<HTMLScriptElement>, dataAttributes?: Record<string, string | undefined>);
+    load: () => Promise<any>;
+    remove: () => HTMLScriptElement;
+}
+export default Script;

package/dist/types/utils/Storage.d.ts

@@ -1,10 +1,10 @@
-declare class Storage {
-    private readonly prefix;
-    private readonly key;
-    private storage;
-    constructor(key: string, storage?: globalThis.Storage);
-    get(): any;
-    set(value: any): void;
-    remove(): void;
-}
-export default Storage;
+declare class Storage {
+    private readonly prefix;
+    private readonly key;
+    private storage;
+    constructor(key: string, storage?: globalThis.Storage);
+    get(): any;
+    set(value: any): void;
+    remove(): void;
+}
+export default Storage;