@adyen/adyen-web 5.58.0 → 5.60.0

package/dist/types/components/types.d.ts

@@ -3,12 +3,14 @@ import { Order, PaymentAction, PaymentAmount, PaymentAmountExtended } from '../t
 import Language from '../language/Language';
 import UIElement from './UIElement';
 import Core from '../core';
-import Analytics from '../core/Analytics';
 import RiskElement from '../core/RiskModule';
 import { PayButtonProps } from './internal/PayButton/PayButton';
 import Session from '../core/CheckoutSession';
 import { SRPanel } from '../core/Errors/SRPanel';
 import { Resources } from '../core/Context/Resources';
+import { AnalyticsInitialEvent, AnalyticsObject, CreateAnalyticsEventObject, SendAnalyticsObject } from '../core/Analytics/types';
+import { EventsQueueModule } from '../core/Analytics/EventsQueue';
+import { CbObjOnFocus } from './internal/SecuredFields/lib/types';
 export interface PaymentMethodData {
     paymentMethod: {
         [key: string]: any;
@@ -56,12 +58,20 @@ export interface PaymentResponse {
 export interface RawPaymentResponse extends PaymentResponse {
     [key: string]: any;
 }
+export interface AnalyticsModule {
+    setUp: (a: AnalyticsInitialEvent) => Promise<any>;
+    getCheckoutAttemptId: () => string;
+    getEventsQueue: () => EventsQueueModule;
+    createAnalyticsEvent: (a: CreateAnalyticsEventObject) => AnalyticsObject;
+    getEnabled: () => boolean;
+    sendAnalytics: (component: string, analyticsObj: SendAnalyticsObject) => void;
+}
 export interface BaseElementProps {
     _parentInstance?: Core;
     order?: Order;
     modules?: {
         srPanel?: SRPanel;
-        analytics?: Analytics;
+        analytics?: AnalyticsModule;
         resources?: Resources;
         risk?: RiskElement;
     };
@@ -84,7 +94,7 @@ export interface IUIElement {
     setState(newState: object): void;
 }
 export type UIElementStatus = 'ready' | 'loading' | 'error' | 'success';
-export type ActionDescriptionType = 'qr-code-loaded' | 'polling-started' | 'fingerprint-iframe-loaded' | 'challenge-iframe-loaded';
+export type ActionDescriptionType = 'qr-code-loaded' | 'polling-started' | string;
 export type PayButtonFunctionProps = Omit<PayButtonProps, 'amount'>;
 export interface ActionHandledReturnObject {
     componentType: string;
@@ -109,6 +119,7 @@ export interface UIElementProps extends BaseElementProps {
     icon?: string;
     amount?: PaymentAmount;
     secondaryAmount?: PaymentAmountExtended;
+    brand?: string;
     /**
      * Show/Hide pay button
      * @defaultValue true
@@ -142,3 +153,12 @@ export interface ComponentMethodsRef {
     showValidation?: () => void;
     setStatus?(status: UIElementStatus): void;
 }
+export type DecodeObject = {
+    success: boolean;
+    error?: string;
+    data?: string;
+};
+export type ComponentFocusObject = {
+    fieldType: string;
+    event: Event | CbObjOnFocus;
+};

package/dist/types/core/Analytics/Analytics.d.ts

@@ -1,14 +1,4 @@
-import { CoreOptions } from '../types';
-export type AnalyticsProps = Pick<CoreOptions, 'loadingContext' | 'locale' | 'clientKey' | 'analytics' | 'amount'>;
-declare class Analytics {
-    private static defaultProps;
-    checkoutAttemptId: string;
-    props: any;
-    private readonly logEvent;
-    private readonly logTelemetry;
-    private readonly queue;
-    readonly collectId: any;
-    constructor({ loadingContext, locale, clientKey, analytics, amount }: AnalyticsProps);
-    send(event: any): void;
-}
+import { AnalyticsProps } from './types';
+import { AnalyticsModule } from '../../components/types';
+declare const Analytics: ({ loadingContext, locale, clientKey, analytics, amount, analyticsContext }: AnalyticsProps) => AnalyticsModule;
 export default Analytics;

package/dist/types/core/Analytics/EventsQueue.d.ts

@@ -1,7 +1,15 @@
-type EventItem = (checkoutAttemptId: string) => Promise<any>;
-declare class EventsQueue {
-    events: EventItem[];
-    add(event: any): void;
-    run(checkoutAttemptId?: string): Promise<any[]>;
+import { AnalyticsObject, EventQueueProps } from './types';
+interface CAActions {
+    channel: 'Web';
+    platform: 'Web';
+    info: AnalyticsObject[];
+    errors: AnalyticsObject[];
+    logs: AnalyticsObject[];
 }
+export interface EventsQueueModule {
+    add: (t: string, o: AnalyticsObject) => void;
+    run: (id: string) => Promise<any>;
+    getQueue: () => CAActions;
+}
+declare const EventsQueue: ({ analyticsContext, clientKey, analyticsPath }: EventQueueProps) => EventsQueueModule;
 export default EventsQueue;

package/dist/types/core/Analytics/analyticsPreProcessor.d.ts

@@ -0,0 +1,3 @@
+import { AnalyticsModule } from '../../components/types';
+import { SendAnalyticsObject } from './types';
+export declare const analyticsPreProcessor: (analyticsModule: AnalyticsModule) => (component: string, analyticsObj: SendAnalyticsObject) => void;

package/dist/types/core/Analytics/constants.d.ts

@@ -0,0 +1,72 @@
+export declare const ANALYTICS_PATH = "v3/analytics";
+export declare const ANALYTICS_INFO_TIMER_INTERVAL: number;
+export declare const ANALYTICS_SEARCH_DEBOUNCE_TIME = 3000;
+export declare const ANALYTICS_EVENT_LOG = "log";
+export declare const ANALYTICS_EVENT_ERROR = "error";
+export declare const ANALYTICS_EVENT_INFO = "info";
+export declare const ANALYTICS_ACTION_STR = "action";
+export declare const ANALYTICS_SUBMIT_STR = "submit";
+export declare const ANALYTICS_SELECTED_STR = "selected";
+export declare const ANALYTICS_RENDERED_STR = "rendered";
+export declare const ANALYTICS_DISPLAYED_STR = "displayed";
+export declare const ANALYTICS_INPUT_STR = "input";
+export declare const ANALYTICS_DOWNLOAD_STR = "download";
+export declare const ANALYTICS_VALIDATION_ERROR_STR = "validationError";
+export declare const ANALYTICS_FOCUS_STR = "focus";
+export declare const ANALYTICS_UNFOCUS_STR = "unfocus";
+export declare const ANALYTICS_CONFIGURED_STR = "configured";
+export declare const ANALYTICS_QR_CODE_DOWNLOAD = "qr_download_button";
+export declare const ANALYTICS_INSTANT_PAYMENT_BUTTON = "instant_payment_button";
+export declare const ANALYTICS_FEATURED_ISSUER = "featured_issuer";
+export declare const ANALYTICS_LIST = "list";
+export declare const ANALYTICS_LIST_SEARCH = "list_search";
+export declare const ANALYTICS_IMPLEMENTATION_ERROR = "ImplementationError";
+export declare const ANALYTICS_API_ERROR = "ApiError";
+export declare const ANALYTICS_SDK_ERROR = "SdkError";
+export declare const ANALYTICS_NETWORK_ERROR = "Network";
+export declare const ANALYTICS_INTERNAL_ERROR = "Internal";
+export declare const ANALYTICS_ERROR_CODE_ACTION_IS_MISSING_PAYMENT_DATA = "web_700";
+export declare const ANALYTICS_ERROR_CODE_ACTION_IS_MISSING_TOKEN = "web_701";
+export declare const ANALYTICS_ERROR_CODE_TOKEN_IS_MISSING_THREEDSMETHODURL = "web_702";
+/**
+ * Decoded token is missing one or more of the following properties:
+ *  fingerprint: (threeDSMethodNotificationURL | postMessageDomain | threeDSServerTransID)
+ *  challenge: (acsTransID | messageVersion | threeDSServerTransID)
+ */
+export declare const ANALYTICS_ERROR_CODE_TOKEN_IS_MISSING_OTHER_PROPS = "web_703";
+export declare const ANALYTICS_ERROR_CODE_TOKEN_DECODE_OR_PARSING_FAILED = "web_704";
+export declare const ANALYTICS_ERROR_CODE_3DS2_TIMEOUT = "web_705";
+export declare const ANALYTICS_ERROR_CODE_TOKEN_IS_MISSING_ACSURL = "web_800";
+export declare const ANALYTICS_ERROR_CODE_NO_TRANSSTATUS = "web_801";
+export declare const errorCodeMapping: {
+    "error.va.sf-cc-num.02": string;
+    "error.va.sf-cc-num.04": string;
+    "error.va.sf-cc-num.01": string;
+    "error.va.sf-cc-num.03": string;
+    "error.va.sf-cc-dat.04": string;
+    "error.va.sf-cc-dat.05": string;
+    "error.va.sf-cc-dat.01": string;
+    "error.va.sf-cc-dat.02": string;
+    "error.va.sf-cc-dat.03": string;
+    "error.va.sf-cc-mth.01": string;
+    "error.va.sf-cc-yr.01": string;
+    "error.va.sf-cc-yr.02": string;
+    "error.va.sf-cc-cvc.01": string;
+    "error.va.sf-cc-cvc.02": string;
+    "creditCard.holderName.invalid": string;
+    "boleto.socialSecurityNumber.invalid": string;
+    "error.va.gen.01.country": string;
+    "error.va.gen.01.street": string;
+    "error.va.gen.01.house_number_or_name": string;
+    "error.va.gen.01.postal_code": string;
+    "invalidFormatExpects.postal_code": string;
+    "error.va.gen.01.city": string;
+    "error.va.gen.01.state_or_province": string;
+    "error.va.sf-kcp-pwd.01": string;
+    "error.va.sf-kcp-pwd.02": string;
+    "creditCard.taxNumber.invalid": string;
+    "error.va.sf-ach-num.01": string;
+    "error.va.sf-ach-num.02": string;
+    "error.va.sf-ach-loc.01": string;
+    "error.va.sf-ach-loc.02": string;
+};

package/dist/types/core/Analytics/types.d.ts

@@ -1,3 +1,5 @@
+import { PaymentAmount } from '../../types';
+import { CoreOptions } from '../types';
 export interface Experiment {
     controlGroup: boolean;
     experimentId: string;
@@ -21,7 +23,58 @@ export interface AnalyticsOptions {
      */
     payload?: any;
     /**
-     * List of experiments to be sent in the collectId call
+     * List of experiments to be sent in the collectId call // TODO - still used?
      */
     experiments?: Experiment[];
 }
+export type AnalyticsProps = Pick<CoreOptions, 'loadingContext' | 'locale' | 'clientKey' | 'analytics' | 'amount'> & {
+    analyticsContext?: string;
+};
+export interface AnalyticsObject {
+    timestamp: string;
+    component: string;
+    id: string;
+    code?: string;
+    errorType?: string;
+    message?: string;
+    type?: string;
+    subtype?: string;
+    target?: string;
+    metadata?: Record<string, any>;
+    isStoredPaymentMethod?: boolean;
+    brand?: string;
+    validationErrorCode?: string;
+    validationErrorMessage?: string;
+    issuer?: string;
+}
+export type ANALYTICS_EVENT = 'log' | 'error' | 'info';
+export type CreateAnalyticsObject = Omit<AnalyticsObject, 'timestamp' | 'id'> & {
+    event: ANALYTICS_EVENT;
+};
+export type AnalyticsInitialEvent = {
+    containerWidth: number;
+    component: string;
+    flavor: string;
+    paymentMethods?: any[];
+    sessionId?: string;
+};
+export type AnalyticsConfig = {
+    analyticsContext?: string;
+    clientKey?: string;
+    locale?: string;
+    amount?: PaymentAmount;
+    loadingContext?: string;
+};
+export type CreateAnalyticsEventData = Omit<AnalyticsObject, 'timestamp' | 'id'>;
+export type CreateAnalyticsEventObject = {
+    event: ANALYTICS_EVENT;
+    data: CreateAnalyticsEventData;
+};
+export type EventQueueProps = Pick<AnalyticsConfig, 'analyticsContext' | 'clientKey'> & {
+    analyticsPath: string;
+};
+export type SendAnalyticsObject = Omit<AnalyticsObject, 'timestamp' | 'component' | 'id'>;
+export type FieldErrorAnalyticsObject = {
+    fieldType: string;
+    errorCode: string;
+};

package/dist/types/core/Analytics/utils.d.ts

@@ -0,0 +1,21 @@
+import { AnalyticsObject, CreateAnalyticsObject } from './types';
+export declare const getUTCTimestamp: () => number;
+/**
+ * All objects for the /checkoutanalytics endpoint have base props:
+ *  "timestamp" & "component"
+ *
+ * Error objects have, in addition to the base props:
+ *  "code", "errorType" & "message"
+ *
+ * Log objects have, in addition to the base props:
+ *  "message" & "type" &
+ *    "subtype" (e.g. when an action is handled)
+ *
+ * Info objects have, in addition to the base props:
+ *   "type" & "target" &
+ *     "isStoredPaymentMethod" & "brand" (when a storedCard is "selected"), or,
+ *     "validationErrorCode" & "validationErrorMessage" (when the event is describing a validation error)
+ *
+ *  All objects can also have a "metadata" object of key-value pairs
+ */
+export declare const createAnalyticsObject: (aObj: CreateAnalyticsObject) => AnalyticsObject;

package/dist/types/core/Environment/Environment.d.ts

@@ -2,3 +2,5 @@ export declare const FALLBACK_CONTEXT = "https://checkoutshopper-live.adyen.com/
 export declare const resolveEnvironment: (env?: string, environmentUrl?: string) => string;
 export declare const FALLBACK_CDN_CONTEXT = "https://checkoutshopper-live.adyen.com/checkoutshopper/";
 export declare const resolveCDNEnvironment: (env?: string, environmentUrl?: string) => any;
+export declare const FALLBACK_ANALYTICS_CONTEXT = "https://checkoutanalytics-live.adyen.com/checkoutanalytics/";
+export declare const resolveAnalyticsEnvironment: (env?: string) => any;

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

@@ -1 +1 @@
-export { resolveCDNEnvironment, resolveEnvironment } from './Environment';
+export { resolveCDNEnvironment, resolveEnvironment, resolveAnalyticsEnvironment } from './Environment';

package/dist/types/core/Errors/types.d.ts

@@ -48,3 +48,7 @@ export interface SetSRMessagesReturnObject {
     action: string;
     fieldToFocus?: string;
 }
+export type ErrorObject = {
+    success: false;
+    error: string;
+};

package/dist/types/core/Errors/utils.d.ts

@@ -14,6 +14,7 @@ export declare const addAriaErrorTranslationsObject: (i18n: any) => {};
  * @returns a duplicate of the original object with a new property: "error" whose value is a object containing the translated errors
  */
 export declare const addErrorTranslationsToObject: (originalObj: any, i18n: any) => any;
+export declare const getErrorMessageFromCode: (errorCode: string, codeMap: Record<string, string>) => string;
 /**
  * sortErrorsByLayout - takes a list of errors and a layout, and returns a sorted array of error objects with translated error messages
  *

package/dist/types/core/Services/analytics/collect-id.d.ts

@@ -1,8 +1,9 @@
 import { CollectIdProps } from './types';
+export declare const FAILURE_MSG = "WARNING: Failed to retrieve \"checkoutAttemptId\". Consequently, analytics will not be available for this payment. The payment process, however, will not be affected.";
 /**
- * Log event to Adyen
- * @param config - ready to be serialized and included in the body of request
- * @returns a function returning a promise containing the response of the call
+ * Send an event to Adyen with some basic telemetry info and receive a checkoutAttemptId in response
+ * @param config - object containing values needed to calculate the url for the request; and also some that need to be serialized and included in the body of request
+ * @returns a function returning a promise containing the response of the call (an object containing a checkoutAttemptId property)
  */
-declare const collectId: ({ loadingContext, clientKey, experiments }: CollectIdProps) => () => Promise<string>;
+declare const collectId: ({ analyticsContext, clientKey, locale, analyticsPath }: CollectIdProps) => (event: any) => Promise<string>;
 export default collectId;

package/dist/types/core/Services/analytics/log-event.d.ts

@@ -1,7 +1,8 @@
+import { LogEventProps } from './types';
 /**
  * Log event to Adyen
  * @param config - ready to be serialized and included in the request
  * @returns A log event function
  */
-declare const logEvent: (config: any) => (event: any) => void;
+declare const logEvent: (config: LogEventProps) => (initialEvent: any) => void;
 export default logEvent;

package/dist/types/core/Services/analytics/types.d.ts

@@ -1,11 +1,21 @@
-import { Experiment } from '../../Analytics/types';
-type CheckoutAttemptIdSession = {
+import { AnalyticsConfig } from '../../Analytics/types';
+import { PaymentAmount } from '../../../types';
+export type CheckoutAttemptIdSession = {
     id: string;
     timestamp: number;
 };
-type CollectIdProps = {
-    clientKey: string;
-    loadingContext: string;
-    experiments: Experiment[];
+export type CollectIdProps = Pick<AnalyticsConfig, 'clientKey' | 'analyticsContext' | 'locale' | 'amount'> & {
+    analyticsPath: string;
+};
+export type LogEventProps = Pick<AnalyticsConfig, 'loadingContext' | 'locale'>;
+export type TelemetryEvent = {
+    version: string;
+    channel: 'Web';
+    locale: string;
+    referrer: string;
+    screenWidth: number;
+    containerWidth: number;
+    component: string;
+    flavor: string;
+    amount?: PaymentAmount;
 };
-export { CheckoutAttemptIdSession, CollectIdProps };

package/dist/types/core/Services/http.d.ts

@@ -1,4 +1,4 @@
-interface HttpOptions {
+export interface HttpOptions {
     accept?: string;
     contentType?: string;
     errorMessage?: string;

package/dist/types/core/core.d.ts

@@ -12,6 +12,7 @@ declare class Core {
     components: any[];
     loadingContext?: string;
     cdnContext?: string;
+    analyticsContext?: string;
     static readonly version: {
         version: string;
         revision: string;

package/dist/types/core/types.d.ts

@@ -126,7 +126,9 @@ type PaymentMethodsConfigurationMap = {
     [key in keyof PaymentMethods]?: Partial<PaymentMethodOptions<key>>;
 };
 type PaymentActionTypesMap = {
-    [key in PaymentActionsType]?: Partial<UIElementProps>;
+    [key in PaymentActionsType]?: Partial<UIElementProps> & {
+        challengeWindowSize?: string;
+    };
 };
 /**
  * Type must be loose, otherwise it will take priority over the rest

package/dist/types/utils/Formatters/formatters.d.ts

@@ -1,2 +1,3 @@
 import { FormatterFn } from './types';
 export declare const digitsOnlyFormatter: FormatterFn;
+export declare const capitalizeFirstLetter: (str: string) => string;

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

@@ -6,5 +6,8 @@ declare class Storage<T> {
     get(): T;
     set(value: T): void;
     remove(): void;
+    clear(): void;
+    keyByIndex(index: any): string;
+    get length(): number;
 }
 export default Storage;

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

@@ -1,8 +1,11 @@
+import { DecodeObject } from '../components/types';
+export declare const NOT_BASE64_ERROR = "not base64";
+export declare const BASE64_MALFORMED_URI_ERROR = "malformed URI sequence";
 /**
  * @internal
  */
 declare const base64: {
-    decode: (pData: any) => string | false;
+    decode: (pData: string) => DecodeObject;
     encode: (pData: any) => string;
     isBase64: (pDataStr: any) => boolean;
 };

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

@@ -0,0 +1,2 @@
+export declare const DEFAULT_DEBOUNCE_TIME_MS = 300;
+export declare const debounce: (fn: Function, ms?: number) => (this: any, ...args: any[]) => void;

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

@@ -0,0 +1 @@
+export declare const camelCaseToSnakeCase: (camelCaseString: any) => any;

package/package.json

@@ -25,7 +25,7 @@
         "./dist/es/adyen.css": "./dist/es/adyen.css",
         "./package.json": "./package.json"
     },
-    "version": "5.58.0",
+    "version": "5.60.0",
     "license": "MIT",
     "homepage": "https://docs.adyen.com/checkout",
     "repository": "github:Adyen/adyen-web",
@@ -124,7 +124,7 @@
     "dependencies": {
         "@babel/runtime": "^7.15.4",
         "@babel/runtime-corejs3": "^7.20.1",
-        "@types/applepayjs": "^3.0.4",
+        "@types/applepayjs": "14.0.6",
         "@types/googlepay": "^0.7.0",
         "classnames": "^2.3.1",
         "core-js-pure": "^3.25.3",

package/dist/types/core/Services/analytics/post-telemetry.d.ts

@@ -1,13 +0,0 @@
-import { PaymentAmount } from '../../../types';
-type LogTelemetryConfig = {
-    loadingContext: string;
-    locale: string;
-    clientKey: string;
-    amount: PaymentAmount;
-};
-/**
- * Log event to Adyen
- * @param config -
- */
-declare const logTelemetry: (config: LogTelemetryConfig) => (event: any) => Promise<any>;
-export default logTelemetry;