@adyen/kyc-components 2.62.0 → 2.63.0

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

@@ -17,7 +17,7 @@ export declare enum BankDocumentTypes {
     BANK_STATEMENT = "bankStatement",
     DEPOSIT_SLIP = "depositSlip",
     SCREENSHOT_OF_BANK = "screenshotOfOnlineBankingEnviroment",
-    OFFICIAL_EMAIL = "officialEmailOrALetterFromYourBank",
+    A_LETTER_FROM_YOUR_BANK = "aLetterFromYourBank",
     CHECK = "check"
 }
 export interface DocumentsModifiers {

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

@@ -1,5 +1,4 @@
 import type { Dispatch, StateUpdater } from 'preact/hooks';
-import type { BaseTrackingPayload } from '../../core/analytics';
 import type { HookStatus } from '../../core/hooks/types';
 import type { BaseInnerFormProps } from '../../core/hooks/useForm/types';
 import type { CompanyDatasetResponse, CompanySearchResult } from '../../core/models/api/company-search';
@@ -15,7 +14,6 @@ export interface BasicInformationProps extends BaseInnerFormProps<BasicInformati
     country: CountryCode;
     companyType: CompanyTypesValue | undefined;
     isTopLevelEntity: boolean;
-    baseTrackingPayload: BaseTrackingPayload;
     showBusinessSelection: boolean;
     showCompanyStructure: boolean;
     isActiveForm: boolean;

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

@@ -1,5 +1,4 @@
 import type { Dispatch, StateUpdater } from 'preact/hooks';
-import type { BaseTrackingPayload } from '../../core/analytics';
 import type { HookStatus } from '../../core/hooks/types';
 import type { BaseOuterFormProps } from '../../core/hooks/useForm/types';
 import type { CompanyDatasetResponse, CompanySearchResult } from '../../core/models/api/company-search';
@@ -20,7 +19,6 @@ export interface BusinessDetailsSchema {
 export interface BusinessDetailsProps extends BaseOuterFormProps<BusinessDetailsSchema> {
     country: CountryCode;
     isTopLevelEntity: boolean;
-    baseTrackingPayload: BaseTrackingPayload;
     showCompanyStructure: boolean;
     showBusinessSelection: boolean;
     searching: HookStatus;

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

@@ -1,8 +1,8 @@
 import type { Dispatch, StateUpdater } from 'preact/hooks';
-import type { BaseTrackingPayload } from '../../../core/analytics';
 import type { ExistingLegalEntity, LegalEntity } from '../../../core/models/api/legal-entity';
 import type { EntityProblems } from '../../../core/models/errors/entity-problems';
 import type { FormModelWithValidity } from '../../../core/models/form';
+import type { AdditionalEventProperties } from '../../../core/user-events';
 import type Language from '../../../language/Language';
 import type { DocumentApiUtils } from '../../../utils/api/documentUtils';
 import type { BusinessDetailsProps, BusinessDetailsSchema } from '../../BusinessDetails/types';
@@ -19,7 +19,7 @@ export type BusinessDetailsDropinApihandler = Required<Pick<DropinAPIHandlers, '
     handleVerifyTin?: DropinAPIHandlers['handleVerifyTin'];
     handleClearCompanyData?: DropinAPIHandlers['handleClearCompanyData'];
 };
-export type BusinessDetailsDropin = Omit<BusinessDetailsProps, 'isTopLevelEntity' | 'baseTrackingPayload' | 'handleNextClick' | 'showCompanyStructure' | 'showBusinessSelection' | 'searching' | 'fetching' | 'verifying' | 'resettingTrustedData' | 'searchResults' | 'invalidTin' | 'resetTinVerification' | 'verifiedBusiness' | 'fetchBusinessData' | 'verifyBusinessData' | 'proceedToManualDataEntry' | 'setShowBusinessSelection' | 'setShowCompanyStructure'>;
+export type BusinessDetailsDropin = Omit<BusinessDetailsProps, 'isTopLevelEntity' | 'handleNextClick' | 'showCompanyStructure' | 'showBusinessSelection' | 'searching' | 'fetching' | 'verifying' | 'resettingTrustedData' | 'searchResults' | 'invalidTin' | 'resetTinVerification' | 'verifiedBusiness' | 'fetchBusinessData' | 'verifyBusinessData' | 'proceedToManualDataEntry' | 'setShowBusinessSelection' | 'setShowCompanyStructure'>;
 export interface BusinessDetailsDropinProps extends BusinessDetailsDropin, BusinessDetailsDropinApihandler, DropinProps {
     legalEntityResponse: ExistingLegalEntity;
     isTargetLegalEntityType?: boolean;
@@ -31,13 +31,13 @@ export interface SubmitDocumentsProps {
     legalEntity: ExistingLegalEntity;
     forms: FormModelWithValidity[];
     documentUtils: DocumentApiUtils;
-    baseTrackingPayload: BaseTrackingPayload;
+    additionalTrackingParams: Partial<AdditionalEventProperties>;
 }
 export interface SubmitProps {
     data: BusinessDetailsSchema;
     legalEntityResponse: ExistingLegalEntity;
     isTargetLegalEntityType: boolean;
-    baseTrackingPayload: BaseTrackingPayload;
+    additionalTrackingParams: Partial<AdditionalEventProperties>;
     forms: FormModelWithValidity[];
     documentUtils: DocumentApiUtils;
     i18n: Language;

package/dist/types/components/Dropins/BusinessDetailsDropin/utils.d.ts

@@ -9,4 +9,4 @@ export declare const canSubmit: (data: BusinessDetailsSchema) => boolean;
 export declare const isDocumentsRequired: (forms: FormModelWithValidity[]) => boolean;
 export declare const removeConditionalForms: (forms: FormModelWithValidity[], isSkippingCompanyStructure: boolean) => FormModelWithValidity[];
 export declare const formatDataForSummary: (data: BusinessDetailsSchema, forms: FormModelWithValidity[], labels: OuterFormLabels<BusinessDetailsSchema>, i18n: Language) => {};
-export declare function submit({ data, legalEntityResponse, baseTrackingPayload, forms, problems, documentUtils, i18n, setLoadingStatus, setProblems, showToast, clearToasts, handleUpdateLegalEntity, onExternalSubmit, accountHolder, }: SubmitProps): Promise<void>;
+export declare function submit({ data, legalEntityResponse, additionalTrackingParams, forms, problems, documentUtils, i18n, setLoadingStatus, setProblems, showToast, clearToasts, handleUpdateLegalEntity, onExternalSubmit, accountHolder, }: SubmitProps): Promise<void>;

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

@@ -1,8 +1,8 @@
 import './FormWrapper.scss';
 import type { ComponentChildren } from 'preact';
-import type { BaseTrackingPayload } from '../../../core/analytics';
 import type { EntityProblems } from '../../../core/models/errors/entity-problems';
 import type { FormModelWithValidity } from '../../../core/models/form';
+import { type AdditionalEventProperties } from '../../../core/user-events';
 import type { TranslationKey } from '../../../language/types';
 import type { LoadingStatus } from '../../internal/LoaderWrapper/constants';
 import type { DropinAPIHandlers } from '../types';
@@ -28,7 +28,7 @@ export interface FormWrapperProps {
     forms: FormModelWithValidity[];
     activeForm: FormModelWithValidity;
     validateForm(): void;
-    baseTrackingPayload: BaseTrackingPayload;
+    navigationTrackingParams?: Partial<AdditionalEventProperties>;
     hideDropinLayout?: boolean;
     hideFooter?: boolean;
     hideHomeButton?: boolean;
@@ -42,4 +42,4 @@ export interface FormWrapperProps {
     currentStep?: number;
     totalSteps?: number;
 }
-export declare const FormWrapper: ({ summary, taskName, children, handleNextClick, handleBackClick, handleHomeClick, handleCloseClick, nextButtonLabel, backButtonLabel, homeButtonLabel, loadingStatus, gotoFormByFormIndex, forms, activeForm, handleGetIdVerificationToken, validateForm, baseTrackingPayload, hideDropinLayout, hideFooter, hideHomeButton, hideBackButton, hideNextButton, hideNavigation, asModal, canSubmit, onSubmit, problems, currentStep, totalSteps, }: FormWrapperProps) => import("preact").JSX.Element;
+export declare const FormWrapper: ({ summary, taskName, children, handleNextClick, handleBackClick, handleHomeClick, handleCloseClick, nextButtonLabel, backButtonLabel, homeButtonLabel, loadingStatus, gotoFormByFormIndex, forms, activeForm, handleGetIdVerificationToken, validateForm, navigationTrackingParams, hideDropinLayout, hideFooter, hideHomeButton, hideBackButton, hideNextButton, hideNavigation, asModal, canSubmit, onSubmit, problems, currentStep, totalSteps, }: FormWrapperProps) => import("preact").JSX.Element;

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

@@ -1,4 +1,3 @@
-import type { BaseTrackingPayload } from '../../core/analytics';
 import type { State, TopLevelDataSchema } from '../../core/Context/StateContext/types';
 import type { AddressSearchRequest, AddressSearchResponse, LoqateAddress } from '../../core/models/api/address-search';
 import type { CapabilityName } from '../../core/models/api/capability';
@@ -71,7 +70,6 @@ export interface DropinAPIHandlers {
 }
 export interface DropinProps {
     legalEntityResponse?: ExistingLegalEntity;
-    baseTrackingPayload?: BaseTrackingPayload;
     homeButtonLabel?: string;
     handleHomeClick?(): void;
     handleBackClick?(): void;

package/dist/types/components/PersonalDetails/component/IdentityComponent/IdentityAu/component/DriversLicense.d.ts

@@ -1,4 +1,3 @@
-import type { BaseTrackingPayload } from '../../../../../../core/analytics';
 import type { FormUtils } from '../../../../../../utils/formUtils';
 import type { IdentityNumberSchema } from '../../../../../IdentityNumber/type';
 import type { MultiSelectOnChangeProps, SingleSelectOnChangeProps } from '../../../../../internal/FormFields/Select/types';
@@ -19,7 +18,6 @@ interface DriversLicenseProps {
     isValid: Record<keyof AuDriversLicenseSchema, boolean>;
     errorMessages: Record<keyof AuDriversLicenseSchema, string | boolean>;
     shouldValidate?: boolean;
-    baseTrackingPayload: BaseTrackingPayload;
 }
-export declare const DriversLicense: ({ driversLicense, onIssuerStateChange, onLicenseNumberInput, onLicenseNumberBlur, onCardNumberInput, onCardNumberBlur, formUtils, isValid, errorMessages, shouldValidate, baseTrackingPayload, }: DriversLicenseProps) => import("preact").JSX.Element;
+export declare const DriversLicense: ({ driversLicense, onIssuerStateChange, onLicenseNumberInput, onLicenseNumberBlur, onCardNumberInput, onCardNumberBlur, formUtils, isValid, errorMessages, shouldValidate, }: DriversLicenseProps) => import("preact").JSX.Element;
 export {};

package/dist/types/components/PersonalDetails/component/IdentityComponent/IdentityNZ/component/DriversLicense.d.ts

@@ -1,4 +1,3 @@
-import type { BaseTrackingPayload } from '../../../../../../core/analytics';
 import type { FormUtils } from '../../../../../../utils/formUtils';
 import type { IdentityNumberSchema } from '../../../../../IdentityNumber/type';
 import type { AdditionalIdentityInfoSchema } from '../../types';
@@ -16,7 +15,6 @@ interface DriversLicenseProps {
     isValid: Record<keyof NZDriversLicenseSchema, boolean>;
     errorMessages: Record<keyof NZDriversLicenseSchema, string | boolean>;
     shouldValidate?: boolean;
-    baseTrackingPayload: BaseTrackingPayload;
 }
-export declare const DriversLicense: ({ driversLicense, onLicenseNumberInput, onLicenseNumberBlur, onCardNumberInput, onCardNumberBlur, formUtils, isValid, errorMessages, shouldValidate, baseTrackingPayload, }: DriversLicenseProps) => import("preact").JSX.Element;
+export declare const DriversLicense: ({ driversLicense, onLicenseNumberInput, onLicenseNumberBlur, onCardNumberInput, onCardNumberBlur, formUtils, isValid, errorMessages, shouldValidate, }: DriversLicenseProps) => import("preact").JSX.Element;
 export {};

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

@@ -1,4 +1,3 @@
-import type { BaseTrackingPayload } from '../../core/analytics';
 import type { BaseOuterFormProps } from '../../core/hooks/useForm/types';
 import type { CountryCode } from '../../core/models/country-code';
 import type { FormModel } from '../../core/models/form';
@@ -16,7 +15,6 @@ export interface RegistrationAddressProps extends BaseOuterFormProps<Registratio
     country?: CountryCode;
     handleAddressSearch?: DropinAPIHandlers['handleAddressSearch'];
     handleFindAddress?: DropinAPIHandlers['handleFindAddress'];
-    baseTrackingPayload: BaseTrackingPayload;
 }
 export declare enum operationalAddressIsSameIds {
     OPERATIONAL_ADDRESS_IS_SAME = "OperationAddressAnswerYes",

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

@@ -1,2 +1,2 @@
-import type { GuidanceProps } from './types';
-export declare function ContextGuidance({ page, title, content, titleId, contentId, baseTrackingPayload, }: GuidanceProps): import("preact").JSX.Element;
+import type { ContextGuidanceProps } from './types';
+export declare function ContextGuidance({ title, content, titleId, contentId, trackingParams, }: ContextGuidanceProps): import("preact").JSX.Element;

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

@@ -1,12 +1,11 @@
 import type { ComponentChildren } from 'preact';
-import type { BaseTrackingPayload } from '../../../core/analytics';
-export interface GuidanceProps {
-    baseTrackingPayload: BaseTrackingPayload;
-    page: string;
+import type { AdditionalEventProperties } from '../../../core/user-events';
+export interface ContextGuidanceProps {
     title: string;
     content: ComponentChildren;
     titleId: string;
     contentId: string;
+    trackingParams?: Partial<AdditionalEventProperties>;
     onOpen?: () => void;
     onClose?: () => void;
 }

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

@@ -1,19 +1,16 @@
 import type { SetOptional } from 'type-fest';
-import type { TaskTypes } from '../components/TaskList/types';
 import type { LegalEntity } from './models/api/legal-entity';
 import type { AdditionalEventProperties } from './user-events';
-type BaseTrackingPayloadParams = {
-    task?: TaskTypes;
+type GetAssociatedLeAnalyticsParams = {
     associatedLegalEntity?: LegalEntity;
     associatedLegalEntityOrg?: LegalEntity;
 };
-export type BaseTrackingPayload = {
-    task?: TaskTypes;
+export type AssociatedLeAnalyticsParams = {
     associatedLegalEntityId?: string;
     associatedLegalEntityType?: string;
     associatedLegalEntityOrgId?: string;
     associatedLegalEntityOrgType?: string;
 };
-export declare const getAssociatedLeAnalyticsPayload: ({ task, associatedLegalEntity, associatedLegalEntityOrg, }: BaseTrackingPayloadParams) => BaseTrackingPayload;
+export declare const getAssociatedLeAnalyticsPayload: ({ associatedLegalEntity, associatedLegalEntityOrg, }: GetAssociatedLeAnalyticsParams) => AssociatedLeAnalyticsParams;
 export declare const debouncedInputEvent: import("lodash").DebouncedFunc<(properties: SetOptional<AdditionalEventProperties, "actionLevel">) => void>;
 export {};

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

@@ -1,8 +1,8 @@
 import type { Dispatch, StateUpdater } from 'preact/hooks';
 import type { TranslationKey } from '../../language/types';
-import type { BaseTrackingPayload } from '../analytics';
 import type { EntityProblems } from '../models/errors/entity-problems';
 import type { FormModelWithValidity } from '../models/form';
+import type { AdditionalEventProperties } from '../user-events';
 export interface FormComposer {
     handleNextClick(): void;
     handleBackClick?(): void;
@@ -16,9 +16,9 @@ export interface FormComposer {
     currentStep?: number;
     totalSteps: number;
 }
-export declare const useFormComposer: ({ problems, baseTrackingPayload, forms, formRef, submitButtonLabel, externalBackClick, onSubmit, skipSubmit, onSkipSubmit, }: {
+export declare const useFormComposer: ({ problems, navigationTrackingParams, forms, formRef, submitButtonLabel, externalBackClick, onSubmit, skipSubmit, onSkipSubmit, }: {
     problems?: EntityProblems;
-    baseTrackingPayload: BaseTrackingPayload;
+    navigationTrackingParams?: Partial<AdditionalEventProperties>;
     forms: FormModelWithValidity[];
     formRef?: any;
     submitButtonLabel?: TranslationKey;

package/dist/types/core/user-events.d.ts

@@ -20,6 +20,7 @@ type BaseEventProperties = {
     capabilities?: string[];
     entityType?: LegalEntityType;
     task?: TaskTypes;
+    locale?: string;
 };
 /**
  * Additional event properties
@@ -64,6 +65,10 @@ declare class UserEvents {
      * Adds an analytics event.
      */
     addEvent(eventName: EventName, properties: AdditionalEventProperties): void;
+    /**
+     * Adds an event with context specific to task-related events
+     */
+    addTaskEvent(eventName: EventName, properties: SetOptional<AdditionalEventProperties, 'actionLevel'>): void;
     /**
      * Adds an event with context specific to page-related events
      */

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

@@ -5,6 +5,6 @@ export interface TrackNavigationProps {
     toForm?: TranslationKey;
     label: string;
     returnValue?: 'success' | 'validation error';
-    baseTrackingPayload?: Partial<AdditionalEventProperties>;
+    additionalTrackingParams?: Partial<AdditionalEventProperties>;
 }
-export declare const trackNavigation: ({ actionType, toForm, label, returnValue, baseTrackingPayload, }: TrackNavigationProps) => void;
+export declare const trackNavigation: ({ actionType, toForm, label, returnValue, additionalTrackingParams, }: TrackNavigationProps) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adyen/kyc-components",
-  "version": "2.62.0",
+  "version": "2.63.0",
   "keywords": [
     "adyen",
     "adyen-kyc",