@adyen/kyc-components 2.59.10 → 2.60.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/es/adyen-kyc-components.es.js +774 -589
- package/dist/style.css +2 -2
- package/dist/types/components/BusinessTypeSelection/component/BusinessTypeSelection.d.ts +1 -1
- package/dist/types/components/Company/component/CompanyComponent.d.ts +1 -1
- package/dist/types/components/CompanyRegistrationDetails/types.d.ts +2 -1
- package/dist/types/components/Dropins/BusinessDetailsDropin/types.d.ts +0 -13
- package/dist/types/components/Dropins/BusinessDetailsDropin/utils.d.ts +1 -2
- package/dist/types/components/Dropins/FormNavigation/types.d.ts +3 -3
- package/dist/types/components/Introduction/constants.d.ts +0 -14
- package/dist/types/components/PersonalDetails/component/IdentityComponent/IdentityAu/component/DriversLicense.d.ts +3 -1
- package/dist/types/components/PersonalDetails/component/IdentityComponent/IdentityNZ/component/DriversLicense.d.ts +3 -1
- package/dist/types/components/RegistrationAddress/types.d.ts +2 -0
- package/dist/types/components/SoleProp/component/SolePropComponent.d.ts +1 -1
- package/dist/types/components/TrustRegistrationDetails/types.d.ts +2 -1
- package/dist/types/components/UIElement/UIElement.d.ts +1 -1
- package/dist/types/components/internal/ContextGuidance/ContextGuidance.d.ts +1 -1
- package/dist/types/components/internal/ContextGuidance/types.d.ts +2 -0
- package/dist/types/components/internal/DBANameField/DBANameField.d.ts +1 -1
- package/dist/types/components/internal/DBANameField/types.d.ts +4 -1
- package/dist/types/components/internal/Summary/types.d.ts +3 -2
- package/dist/types/core/Context/ExperimentContext/types.d.ts +3 -2
- package/dist/types/core/hooks/useAnalytics.d.ts +4 -3
- package/dist/types/core/user-events.d.ts +38 -22
- package/dist/types/core/utils.d.ts +4 -5
- package/dist/types/utils/mapping/componentApiMapping.d.ts +11 -4
- package/dist/types/utils/trackNavigation.d.ts +3 -3
- package/package.json +1 -1
package/dist/style.css
CHANGED
|
@@ -1492,6 +1492,8 @@ button[disabled]:hover {
|
|
|
1492
1492
|
font-weight: var(--adyen-sdk-text-body-font-weight, 400);
|
|
1493
1493
|
margin-right: var(--adyen-sdk-spacer-070, 16px);
|
|
1494
1494
|
vertical-align: baseline;
|
|
1495
|
+
}.adyen-kyc-field--dbaName {
|
|
1496
|
+
margin-left: 0 !important;
|
|
1495
1497
|
}.adyen-kyc-field--entityType {
|
|
1496
1498
|
margin-bottom: var(--adyen-sdk-spacer-090, 24px);
|
|
1497
1499
|
}
|
|
@@ -2388,8 +2390,6 @@ fieldset {
|
|
|
2388
2390
|
}
|
|
2389
2391
|
.adyen-kyc-additional-information .adyen-kyc__address {
|
|
2390
2392
|
margin-bottom: 0 !important;
|
|
2391
|
-
}.adyen-kyc-field--dbaName {
|
|
2392
|
-
margin-left: 0 !important;
|
|
2393
2393
|
}.adyen-kyc-verified-business-card {
|
|
2394
2394
|
display: flex;
|
|
2395
2395
|
flex-direction: column;
|
|
@@ -11,4 +11,4 @@ export declare enum BusinessTypeSelectionStep {
|
|
|
11
11
|
CONFIRM_BUSINESS_SETUP_CHANGE = 3
|
|
12
12
|
}
|
|
13
13
|
export declare const businessTypeSelectionStepTitles: Record<BusinessTypeSelectionStep, TranslationKey>;
|
|
14
|
-
export declare const BusinessTypeSelection: ({ legalEntityResponse, accountHolder, onComplete, onBack, handleUpdateLegalEntity,
|
|
14
|
+
export declare const BusinessTypeSelection: ({ legalEntityResponse, accountHolder, onComplete, onBack, handleUpdateLegalEntity, }: BusinessTypeSelectionProps) => JSX.Element | null;
|
|
@@ -15,7 +15,7 @@ export declare const companyForms: {
|
|
|
15
15
|
readonly companyRegistrationDetails: {
|
|
16
16
|
readonly formId: "companyRegistrationDetails";
|
|
17
17
|
readonly formName: "registrationDetails";
|
|
18
|
-
readonly fields: ("dateOfIncorporation" | "stockExchangeMIC" | "stockISIN" | "stockTickerSymbol" | keyof import("../../internal/BusinessRegistrationNumberField/types").BusinessRegistrationNumberFieldSchema | keyof import("../../internal/VatNumberField/types").VatNumberFieldSchema | keyof import("../../internal/TaxInformationField/types").TaxInformationFieldSchema | keyof import("../../internal/TradingNameField/types").TradingNameFieldSchema)[];
|
|
18
|
+
readonly fields: ("dateOfIncorporation" | "stockExchangeMIC" | "stockISIN" | "stockTickerSymbol" | keyof import("../../internal/BusinessRegistrationNumberField/types").BusinessRegistrationNumberFieldSchema | keyof import("../../internal/DBANameField/types").DBANameFieldSchema | keyof import("../../internal/VatNumberField/types").VatNumberFieldSchema | keyof import("../../internal/TaxInformationField/types").TaxInformationFieldSchema | keyof import("../../internal/TradingNameField/types").TradingNameFieldSchema)[];
|
|
19
19
|
};
|
|
20
20
|
readonly companyRegistrationAddress: {
|
|
21
21
|
readonly formId: "companyRegistrationAddress";
|
|
@@ -3,13 +3,14 @@ import type { CompanyTypesValue } from '../../core/models/api/company-types-valu
|
|
|
3
3
|
import type { CountryCode } from '../../core/models/country-code';
|
|
4
4
|
import type { BusinessRegistrationNumberFieldSchema } from '../internal/BusinessRegistrationNumberField/types';
|
|
5
5
|
import type { DateOfIncorporationFieldSchema } from '../internal/DateOfIncorporationField/types';
|
|
6
|
+
import type { DBANameFieldSchema } from '../internal/DBANameField/types';
|
|
6
7
|
import type { StockExchangeMICFieldSchema } from '../internal/StockExchangeMICField/types';
|
|
7
8
|
import type { StockISINFieldSchema } from '../internal/StockISINField/types';
|
|
8
9
|
import type { StockTickerSymbolFieldSchema } from '../internal/StockTickerSymbol/types';
|
|
9
10
|
import type { TaxInformationFieldSchema } from '../internal/TaxInformationField/types';
|
|
10
11
|
import type { TradingNameFieldSchema } from '../internal/TradingNameField/types';
|
|
11
12
|
import type { VatNumberFieldSchema } from '../internal/VatNumberField/types';
|
|
12
|
-
export type CompanyRegistrationDetailsSchema = TradingNameFieldSchema & BusinessRegistrationNumberFieldSchema & TaxInformationFieldSchema & VatNumberFieldSchema & StockExchangeMICFieldSchema & StockISINFieldSchema & StockTickerSymbolFieldSchema & DateOfIncorporationFieldSchema;
|
|
13
|
+
export type CompanyRegistrationDetailsSchema = TradingNameFieldSchema & DBANameFieldSchema & BusinessRegistrationNumberFieldSchema & TaxInformationFieldSchema & VatNumberFieldSchema & StockExchangeMICFieldSchema & StockISINFieldSchema & StockTickerSymbolFieldSchema & DateOfIncorporationFieldSchema;
|
|
13
14
|
export interface CompanyRegistrationDetailsProps extends BaseInnerFormProps<CompanyRegistrationDetailsSchema> {
|
|
14
15
|
companyType?: CompanyTypesValue;
|
|
15
16
|
country?: CountryCode;
|
|
@@ -11,19 +11,6 @@ import type { LoadingStatus } from '../../internal/LoaderWrapper/constants';
|
|
|
11
11
|
import type { ToastOptions } from '../../internal/Toast/types';
|
|
12
12
|
import type { TrustMember } from '../../TrustMembers/types';
|
|
13
13
|
import type { DropinAPIHandlers, DropinProps } from '../types';
|
|
14
|
-
export declare enum BusinessDetailsEvents {
|
|
15
|
-
TASK_START = "BusinessDetails_TaskStarted",
|
|
16
|
-
TASK_SUBMIT = "BusinessDetails_TaskSubmitted",
|
|
17
|
-
TASK_SAVED = "BusinessDetails_TaskSaved",
|
|
18
|
-
TASK_ERROR = "BusinessDetails_TaskError",
|
|
19
|
-
DOCUMENTS_SAVED = "BusinessDetails_DocumentsSaved",
|
|
20
|
-
DOCUMENTS_ERROR = "BusinessDetails_DocumentsError",
|
|
21
|
-
NO_SEARCH_RESULTS = "BusinessDetails_NoSearchResults",
|
|
22
|
-
TIN_MATCH = "BusinessDetails_TinMatch",
|
|
23
|
-
TIN_NO_MATCH = "BusinessDetails_TinNoMatch",
|
|
24
|
-
SELECTION_RESET = "BusinessDetails_CompanySelectionReset",
|
|
25
|
-
SELECTION_ERROR = "BusinessDetails_CompanySelectionError"
|
|
26
|
-
}
|
|
27
14
|
export type BusinessDetailsDropinApihandler = Required<Pick<DropinAPIHandlers, 'handleCreateDocument' | 'handleGetDocument' | 'handleUpdateDocument' | 'handleUpdateLegalEntity'>> & {
|
|
28
15
|
handleCompanyIndexSearch?: DropinAPIHandlers['handleCompanyIndexSearch'];
|
|
29
16
|
handleCompanyDeepSearch?: DropinAPIHandlers['handleCompanyDeepSearch'];
|
|
@@ -3,11 +3,10 @@ import type { ParseConfiguration } from '../../../core/hooks/useScenarioConfigur
|
|
|
3
3
|
import type { FormModelWithValidity } from '../../../core/models/form';
|
|
4
4
|
import type Language from '../../../language/Language';
|
|
5
5
|
import type { BusinessDetailsSchema } from '../../BusinessDetails/types';
|
|
6
|
-
import type {
|
|
6
|
+
import type { SubmitProps } from './types';
|
|
7
7
|
export declare const parseConfiguration: ParseConfiguration;
|
|
8
8
|
export declare const canSubmit: (data: BusinessDetailsSchema) => boolean;
|
|
9
9
|
export declare const isDocumentsRequired: (forms: FormModelWithValidity[]) => boolean;
|
|
10
10
|
export declare const removeConditionalForms: (forms: FormModelWithValidity[], isSkippingCompanyStructure: boolean) => FormModelWithValidity[];
|
|
11
11
|
export declare const formatDataForSummary: (data: BusinessDetailsSchema, forms: FormModelWithValidity[], labels: OuterFormLabels<BusinessDetailsSchema>, i18n: Language) => {};
|
|
12
|
-
export declare function submitDocuments({ data, legalEntity, forms, documentUtils, baseTrackingPayload, }: SubmitDocumentsProps): Promise<void>;
|
|
13
12
|
export declare function submit({ data, legalEntityResponse, baseTrackingPayload, forms, problems, documentUtils, i18n, setLoadingStatus, setProblems, showToast, clearToasts, handleUpdateLegalEntity, onExternalSubmit, accountHolder, }: SubmitProps): Promise<void>;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { EntityProblems } from '../../../core/models/errors/entity-problems';
|
|
2
2
|
import type { FormVerificationErrors } from '../../../core/models/errors/form-verification-errors';
|
|
3
|
-
import type {
|
|
3
|
+
import type { FormModelWithValidity } from '../../../core/models/form';
|
|
4
4
|
import type { TranslationKey } from '../../../language/types';
|
|
5
5
|
export interface FormNavigationProps {
|
|
6
6
|
forms: FormModelWithValidity[];
|
|
@@ -14,8 +14,8 @@ export interface FormNavigationProps {
|
|
|
14
14
|
[formId: string]: FormVerificationErrors;
|
|
15
15
|
};
|
|
16
16
|
trackNavigation?: (props: {
|
|
17
|
-
fromForm:
|
|
18
|
-
toForm:
|
|
17
|
+
fromForm: TranslationKey;
|
|
18
|
+
toForm: TranslationKey;
|
|
19
19
|
component: string;
|
|
20
20
|
}) => void;
|
|
21
21
|
}
|
|
@@ -1,17 +1,3 @@
|
|
|
1
1
|
import { LegalEntityType } from '../../core/models/api/legal-entity-type';
|
|
2
2
|
import { IntroductionScreens } from './types';
|
|
3
3
|
export declare const introductionScreensByLegalEntityType: Record<LegalEntityType, IntroductionScreens[]>;
|
|
4
|
-
export declare enum IntroductionScreenEvent {
|
|
5
|
-
EMPTY = "Introduction_Empty",
|
|
6
|
-
START_FLOW = "Introduction_StartFlow",
|
|
7
|
-
START_SCREEN = "Introduction_StartScreen",
|
|
8
|
-
STOP_SCREEN = "Introduction_StopScreen",
|
|
9
|
-
STOP_FLOW = "Introduction_StopFlow",
|
|
10
|
-
NEXT = "Introduction_Next",
|
|
11
|
-
BACK = "Introduction_Back",
|
|
12
|
-
SKIP = "Introduction_Skip"
|
|
13
|
-
}
|
|
14
|
-
export declare enum IntroductionScreenTiming {
|
|
15
|
-
VIEW_FLOW = "Introduction_ViewFlow",
|
|
16
|
-
VIEW_SCREEN = "Introduction_ViewScreen"
|
|
17
|
-
}
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { BaseTrackingPayload } from '../../../../../../core/utils';
|
|
1
2
|
import type { FormUtils } from '../../../../../../utils/formUtils';
|
|
2
3
|
import type { IdentityNumberSchema } from '../../../../../IdentityNumber/type';
|
|
3
4
|
import type { MultiSelectOnChangeProps, SingleSelectOnChangeProps } from '../../../../../internal/FormFields/Select/types';
|
|
@@ -18,6 +19,7 @@ interface DriversLicenseProps {
|
|
|
18
19
|
isValid: Record<keyof AuDriversLicenseSchema, boolean>;
|
|
19
20
|
errorMessages: Record<keyof AuDriversLicenseSchema, string | boolean>;
|
|
20
21
|
shouldValidate?: boolean;
|
|
22
|
+
baseTrackingPayload: BaseTrackingPayload;
|
|
21
23
|
}
|
|
22
|
-
export declare const DriversLicense: ({ driversLicense, onIssuerStateChange, onLicenseNumberInput, onLicenseNumberBlur, onCardNumberInput, onCardNumberBlur, formUtils, isValid, errorMessages, shouldValidate, }: DriversLicenseProps) => import("preact").JSX.Element;
|
|
24
|
+
export declare const DriversLicense: ({ driversLicense, onIssuerStateChange, onLicenseNumberInput, onLicenseNumberBlur, onCardNumberInput, onCardNumberBlur, formUtils, isValid, errorMessages, shouldValidate, baseTrackingPayload, }: DriversLicenseProps) => import("preact").JSX.Element;
|
|
23
25
|
export {};
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { BaseTrackingPayload } from '../../../../../../core/utils';
|
|
1
2
|
import type { FormUtils } from '../../../../../../utils/formUtils';
|
|
2
3
|
import type { IdentityNumberSchema } from '../../../../../IdentityNumber/type';
|
|
3
4
|
import type { AdditionalIdentityInfoSchema } from '../../types';
|
|
@@ -15,6 +16,7 @@ interface DriversLicenseProps {
|
|
|
15
16
|
isValid: Record<keyof NZDriversLicenseSchema, boolean>;
|
|
16
17
|
errorMessages: Record<keyof NZDriversLicenseSchema, string | boolean>;
|
|
17
18
|
shouldValidate?: boolean;
|
|
19
|
+
baseTrackingPayload: BaseTrackingPayload;
|
|
18
20
|
}
|
|
19
|
-
export declare const DriversLicense: ({ driversLicense, onLicenseNumberInput, onLicenseNumberBlur, onCardNumberInput, onCardNumberBlur, formUtils, isValid, errorMessages, shouldValidate, }: DriversLicenseProps) => import("preact").JSX.Element;
|
|
21
|
+
export declare const DriversLicense: ({ driversLicense, onLicenseNumberInput, onLicenseNumberBlur, onCardNumberInput, onCardNumberBlur, formUtils, isValid, errorMessages, shouldValidate, baseTrackingPayload, }: DriversLicenseProps) => import("preact").JSX.Element;
|
|
20
22
|
export {};
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import type { BaseOuterFormProps } from '../../core/hooks/useForm/types';
|
|
2
2
|
import type { CountryCode } from '../../core/models/country-code';
|
|
3
3
|
import type { FormModel } from '../../core/models/form';
|
|
4
|
+
import type { BaseTrackingPayload } from '../../core/utils';
|
|
4
5
|
import type { TranslationKey } from '../../language/types';
|
|
5
6
|
import type { DropinAPIHandlers } from '../Dropins/types';
|
|
6
7
|
import type { AddressSchema } from '../internal/Address/types';
|
|
@@ -15,6 +16,7 @@ export interface RegistrationAddressProps extends BaseOuterFormProps<Registratio
|
|
|
15
16
|
country?: CountryCode;
|
|
16
17
|
handleAddressSearch?: DropinAPIHandlers['handleAddressSearch'];
|
|
17
18
|
handleFindAddress?: DropinAPIHandlers['handleFindAddress'];
|
|
19
|
+
baseTrackingPayload: BaseTrackingPayload;
|
|
18
20
|
}
|
|
19
21
|
export declare enum operationalAddressIsSameIds {
|
|
20
22
|
OPERATIONAL_ADDRESS_IS_SAME = "OperationAddressAnswerYes",
|
|
@@ -8,7 +8,7 @@ export declare const solePropForms: {
|
|
|
8
8
|
readonly solePropRegistrationDetails: {
|
|
9
9
|
readonly formId: "solePropRegistrationDetails";
|
|
10
10
|
readonly formName: "registrationDetails";
|
|
11
|
-
readonly fields: ("dateOfIncorporation" | "stockExchangeMIC" | "stockISIN" | "stockTickerSymbol" | keyof import("../../internal/BusinessRegistrationNumberField/types").BusinessRegistrationNumberFieldSchema | keyof import("../../internal/VatNumberField/types").VatNumberFieldSchema | keyof import("../../internal/TaxInformationField/types").TaxInformationFieldSchema | keyof import("../../internal/TradingNameField/types").TradingNameFieldSchema)[];
|
|
11
|
+
readonly fields: ("dateOfIncorporation" | "stockExchangeMIC" | "stockISIN" | "stockTickerSymbol" | keyof import("../../internal/BusinessRegistrationNumberField/types").BusinessRegistrationNumberFieldSchema | keyof import("../../internal/DBANameField/types").DBANameFieldSchema | keyof import("../../internal/VatNumberField/types").VatNumberFieldSchema | keyof import("../../internal/TaxInformationField/types").TaxInformationFieldSchema | keyof import("../../internal/TradingNameField/types").TradingNameFieldSchema)[];
|
|
12
12
|
};
|
|
13
13
|
readonly solePropRegistrationAddress: {
|
|
14
14
|
readonly formId: "solePropRegistrationAddress";
|
|
@@ -3,8 +3,9 @@ import { TrustTypes } from '../../core/models/api/trust-types-value';
|
|
|
3
3
|
import type { CountryCode } from '../../core/models/country-code';
|
|
4
4
|
import type { TranslationKey } from '../../language/types';
|
|
5
5
|
import type { BusinessRegistrationNumberSchema } from '../internal/BusinessRegistrationNumber/types';
|
|
6
|
+
import type { DBANameFieldSchema } from '../internal/DBANameField/types';
|
|
6
7
|
import type { TaxIdSchema } from '../internal/TaxId/types';
|
|
7
|
-
export interface TrustRegistrationDetailsSchema extends BusinessRegistrationNumberSchema, TaxIdSchema {
|
|
8
|
+
export interface TrustRegistrationDetailsSchema extends BusinessRegistrationNumberSchema, TaxIdSchema, DBANameFieldSchema {
|
|
8
9
|
legalName?: string;
|
|
9
10
|
country?: CountryCode;
|
|
10
11
|
trustType?: TrustTypes;
|
|
@@ -7,7 +7,7 @@ import type { ExperimentsProps } from '../../core/Context/ExperimentContext/type
|
|
|
7
7
|
import type { ExpiryProviderProps } from '../../core/Context/ExpiryContext/ExpiryContext';
|
|
8
8
|
import type { I18nProviderProps } from '../../core/Context/I18nProvider/I18nProvider';
|
|
9
9
|
import type { SettingsProps } from '../../core/Context/SettingsContext/types';
|
|
10
|
-
import type
|
|
10
|
+
import { type UserEventCallback } from '../../core/user-events';
|
|
11
11
|
import type { BaseElementProps } from '../BaseElement';
|
|
12
12
|
import { BaseElement } from '../BaseElement';
|
|
13
13
|
import type { ComponentMap } from '../index';
|
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
import type { GuidanceProps } from './types';
|
|
2
|
-
export
|
|
2
|
+
export declare function ContextGuidance({ page, title, content, titleId, contentId, baseTrackingPayload, }: GuidanceProps): import("preact").JSX.Element;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
import './DBANameField.scss';
|
|
2
2
|
import type { DBANameFieldProps, DBANameFieldSchema } from './types';
|
|
3
3
|
export declare const DBA_NAME_FIELD: Array<keyof DBANameFieldSchema>;
|
|
4
|
-
export declare function DBANameField({ data, valid, errors, labels, helperText, readonly, handleChangeFor, setErrors, }: DBANameFieldProps): import("preact").JSX.Element;
|
|
4
|
+
export declare function DBANameField({ data, valid, errors, labels, legalCompanyName, helperText, readonly, handleChangeFor, setErrors, }: DBANameFieldProps): import("preact").JSX.Element;
|
|
@@ -2,5 +2,8 @@ import type { BaseFormFieldProps } from '../../../core/hooks/useForm/types';
|
|
|
2
2
|
export interface DBANameFieldSchema {
|
|
3
3
|
hasDba?: boolean;
|
|
4
4
|
dbaName?: string;
|
|
5
|
+
doingBusinessAbsent?: boolean;
|
|
6
|
+
}
|
|
7
|
+
export interface DBANameFieldProps extends BaseFormFieldProps<DBANameFieldSchema> {
|
|
8
|
+
legalCompanyName?: string;
|
|
5
9
|
}
|
|
6
|
-
export type DBANameFieldProps = BaseFormFieldProps<DBANameFieldSchema>;
|
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
import type { EntityProblems } from '../../../core/models/errors/entity-problems';
|
|
2
2
|
import type { FormModel } from '../../../core/models/form';
|
|
3
|
+
import type { TranslationKey } from '../../../language/types';
|
|
3
4
|
export interface SummaryProps<Schema> {
|
|
4
5
|
trackNavigation?: (props: {
|
|
5
|
-
fromForm:
|
|
6
|
-
toForm:
|
|
6
|
+
fromForm: TranslationKey;
|
|
7
|
+
toForm: TranslationKey;
|
|
7
8
|
component: string;
|
|
8
9
|
}) => void;
|
|
9
10
|
data: Schema;
|
|
@@ -18,12 +18,13 @@ export declare enum ExperimentNames {
|
|
|
18
18
|
HidePciTask = "HidePciTask",
|
|
19
19
|
EnableAgeVerification = "EnableAgeVerification",
|
|
20
20
|
PreserveMismatchedInitialValues = "PreserveMismatchedInitialValues",
|
|
21
|
-
StrictNameAndAddressValidationV4 = "StrictNameAndAddressValidationV4",
|
|
22
21
|
EnableNationalitySGHK = "EnableNationalitySGHK",
|
|
23
22
|
EnableAUGovernmentalOrganizationSkipRegistrationNumber = "EnableAUGovernmentalOrganizationSkipRegistrationNumber",
|
|
24
23
|
EnableMinimalRegistrationNumberValidationForAuIncorporatedAssociation = "EnableMinimalRegistrationNumberValidationForAuIncorporatedAssociation",
|
|
25
|
-
EnableFinancialInformationComponentV4 = "EnableFinancialInformationComponentV4",
|
|
26
24
|
EnablePreferInstantVerificationFlow = "EnablePreferInstantVerificationFlow",
|
|
25
|
+
EnableFinancialInformationComponentV4 = "EnableFinancialInformationComponentV4",
|
|
26
|
+
StrictNameAndAddressValidationV4 = "StrictNameAndAddressValidationV4",
|
|
27
|
+
EnableLemApiVersionV4 = "EnableLemApiVersionV4",
|
|
27
28
|
EnablePhoneFieldScenario = "EnablePhoneFieldScenario"
|
|
28
29
|
}
|
|
29
30
|
export type ExperimentName = `${ExperimentNames}`;
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import type { ComponentMap } from '../../components';
|
|
2
|
-
import type {
|
|
2
|
+
import type { EmbeddedAnalyticsSessionRequest } from '../models/api/analytics';
|
|
3
|
+
import type { AnalyticsEventPayload, EventProperty, EventQueueItem, EventType, UserEventCallback } from '../user-events';
|
|
3
4
|
export type UseAnalyticsProps = {
|
|
4
5
|
legalEntityId: string;
|
|
5
6
|
onUserEvent?: UserEventCallback;
|
|
@@ -9,8 +10,8 @@ export type UseAnalyticsProps = {
|
|
|
9
10
|
type EmbeddedEventItem = {
|
|
10
11
|
eventType: EventType;
|
|
11
12
|
eventName: string;
|
|
12
|
-
eventData:
|
|
13
|
+
eventData: AnalyticsEventPayload | Record<string, EventProperty>;
|
|
13
14
|
};
|
|
14
|
-
export declare const convertToEmbeddedEvent: (eventQueueItem: EventQueueItem) => EmbeddedEventItem;
|
|
15
|
+
export declare const convertToEmbeddedEvent: (eventQueueItem: EventQueueItem, sessionData: EmbeddedAnalyticsSessionRequest) => EmbeddedEventItem & EmbeddedAnalyticsSessionRequest;
|
|
15
16
|
export declare const useAnalytics: ({ onUserEvent, legalEntityId, sdkVersion, componentName, }: UseAnalyticsProps) => Promise<void>;
|
|
16
17
|
export {};
|
|
@@ -1,38 +1,52 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
1
|
+
import type { TaskTypes } from '../components/TaskList/types';
|
|
2
|
+
import type { LegalEntityType } from './models/api/legal-entity-type';
|
|
3
|
+
export type EventProperty = string | number | boolean | any[] | null | undefined;
|
|
4
|
+
type ActionLevel = 'journey' | 'task' | 'page' | 'field';
|
|
5
|
+
type ActionType = 'start' | 'submit' | 'save' | 'add' | 'edit' | 'remove' | 'open' | 'close' | 'next' | 'back' | 'skip' | 'download' | 'upload' | 'sign' | 'navigate';
|
|
6
|
+
type BaseEventProperties = {
|
|
7
|
+
category: 'onboarding';
|
|
8
|
+
subCategory: 'hosted onboarding';
|
|
9
|
+
countryCode?: string;
|
|
10
|
+
capabilities?: string[];
|
|
11
|
+
legalEntityId?: string;
|
|
12
|
+
};
|
|
13
|
+
export interface EventProperties {
|
|
14
|
+
actionType: ActionType;
|
|
15
|
+
actionLevel: ActionLevel;
|
|
16
|
+
entityType?: LegalEntityType;
|
|
17
|
+
task: TaskTypes;
|
|
18
|
+
page?: string;
|
|
19
|
+
field?: string;
|
|
20
|
+
returnType?: 'backend' | (string & {});
|
|
21
|
+
returnValue?: string | string[];
|
|
22
|
+
label?: string;
|
|
23
|
+
[key: string]: EventProperty;
|
|
7
24
|
}
|
|
8
|
-
type
|
|
9
|
-
|
|
25
|
+
export type AnalyticsEventPayload = BaseEventProperties & EventProperties;
|
|
26
|
+
export type EventName = 'Clicked button' | 'Clicked accordion' | 'Success' | 'Encountered error' | 'Landed on page' | (string & {});
|
|
27
|
+
export type EventType = 'add_event' | 'start_event';
|
|
28
|
+
export type EventQueueItem = {
|
|
29
|
+
type: EventType;
|
|
30
|
+
name: EventName;
|
|
31
|
+
properties?: AnalyticsEventPayload;
|
|
10
32
|
};
|
|
11
|
-
export type EventType = 'track_pageview' | 'add_event' | 'start_event' | 'end_event';
|
|
12
|
-
export type EventQueueItem = [EventType, string | UserEventWithKey];
|
|
13
33
|
export type UserEventCallback = (eventQueueItem: EventQueueItem) => void;
|
|
14
34
|
declare class UserEvents {
|
|
15
35
|
private readonly queue;
|
|
16
36
|
private readonly subscriptions;
|
|
37
|
+
/** payload of commmon props sent in every event */
|
|
38
|
+
private baseTrackingPayload;
|
|
39
|
+
constructor();
|
|
17
40
|
protected add(...args: EventQueueItem[]): void;
|
|
18
41
|
protected notifySubscribers(): void;
|
|
19
42
|
/**
|
|
20
43
|
* Adds an analytics event. Optionally can include a payload.
|
|
21
44
|
*/
|
|
22
|
-
addEvent(
|
|
23
|
-
/**
|
|
24
|
-
* Logs a page view event
|
|
25
|
-
* @param pageName - The name of the page/screen to log as viewed
|
|
26
|
-
*/
|
|
27
|
-
addPageView(pageName: string): void;
|
|
28
|
-
/**
|
|
29
|
-
* Starts a new event which is expected to be ended with `endEvent` eventually
|
|
30
|
-
*/
|
|
31
|
-
startEvent(key: string): void;
|
|
45
|
+
addEvent(eventName: EventName, properties: EventProperties): void;
|
|
32
46
|
/**
|
|
33
|
-
*
|
|
47
|
+
* Starts a timer for an event to measure the time it takes for an event to occur. Time is ended when `addEvent` is executed with the same key
|
|
34
48
|
*/
|
|
35
|
-
|
|
49
|
+
startEvent(eventName: EventName): void;
|
|
36
50
|
/**
|
|
37
51
|
* Subscribes a callback to analytics events. It gets called every time
|
|
38
52
|
* one of the above public methods get called, and the event data is passed back as an array.
|
|
@@ -49,6 +63,8 @@ declare class UserEvents {
|
|
|
49
63
|
* ```
|
|
50
64
|
*/
|
|
51
65
|
subscribe(callback: UserEventCallback): void;
|
|
66
|
+
/** Sets params that are sent on every event */
|
|
67
|
+
updateBaseTrackingPayload(baseTrackingPayload: Partial<BaseEventProperties>): void;
|
|
52
68
|
/**
|
|
53
69
|
* Removes a subscribed callback
|
|
54
70
|
*/
|
|
@@ -11,13 +11,12 @@ type BaseTrackingPayloadParams = {
|
|
|
11
11
|
};
|
|
12
12
|
export type BaseTrackingPayload = {
|
|
13
13
|
task: TaskTypes;
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
14
|
+
entityType?: LegalEntityType;
|
|
15
|
+
legalEntityId?: string;
|
|
16
|
+
topLevelLegalEntityId?: string;
|
|
17
|
+
topLevelLegalEntityType?: LegalEntityType;
|
|
17
18
|
parentLegalEntityId?: string;
|
|
18
19
|
parentLegalEntityType?: LegalEntityType;
|
|
19
|
-
legalEntityId?: string;
|
|
20
|
-
legalEntityType?: LegalEntityType;
|
|
21
20
|
};
|
|
22
21
|
export declare function getBaseTrackingPayload({ trackingConfig, parentLegalEntity, legalEntity, task, }: BaseTrackingPayloadParams): BaseTrackingPayload;
|
|
23
22
|
/**
|
|
@@ -58,6 +58,7 @@ export declare const businessDetailsComponentsKeyMapping: {
|
|
|
58
58
|
'additionalInformation.legalCompanyName': string;
|
|
59
59
|
'additionalInformation.legalFormDescription': string;
|
|
60
60
|
'additionalInformation.dbaName': string;
|
|
61
|
+
'additionalInformation.doingBusinessAbsent': string;
|
|
61
62
|
'additionalInformation.registrationNumber': string;
|
|
62
63
|
'additionalInformation.taxInformation': string;
|
|
63
64
|
'additionalInformation.vatNumber': string;
|
|
@@ -81,7 +82,7 @@ export declare const businessDetailsComponentsKeyMapping: {
|
|
|
81
82
|
'additionalInformation.exemptedFromVat': string;
|
|
82
83
|
};
|
|
83
84
|
export declare const businessDetailsApiKeyMapping: {
|
|
84
|
-
[x: string]: "additionalInformation.legalCompanyName" | "additionalInformation.dateOfIncorporation" | "additionalInformation.registrationNumber" | "additionalInformation.stockExchangeMIC" | "additionalInformation.stockISIN" | "additionalInformation.stockTickerSymbol" | "additionalInformation.vatAbsenceReason" | "additionalInformation.vatNumber" | "additionalInformation.taxInformation" | "additionalInformation.operationalAddress.address" | "additionalInformation.operationalAddress.city" | "additionalInformation.operationalAddress.country" | "additionalInformation.operationalAddress.otherAddressInformation" | "additionalInformation.operationalAddress.postalCode" | "additionalInformation.operationalAddress.stateOrProvince" | "additionalInformation.registrationAddress.address" | "additionalInformation.registrationAddress.city" | "additionalInformation.registrationAddress.country" | "additionalInformation.registrationAddress.otherAddressInformation" | "additionalInformation.registrationAddress.postalCode" | "additionalInformation.registrationAddress.stateOrProvince" | "additionalInformation.
|
|
85
|
+
[x: string]: "additionalInformation.legalCompanyName" | "additionalInformation.dateOfIncorporation" | "additionalInformation.dbaName" | "additionalInformation.registrationNumber" | "additionalInformation.stockExchangeMIC" | "additionalInformation.stockISIN" | "additionalInformation.stockTickerSymbol" | "additionalInformation.vatAbsenceReason" | "additionalInformation.vatNumber" | "additionalInformation.doingBusinessAbsent" | "additionalInformation.taxInformation" | "additionalInformation.operationalAddress.address" | "additionalInformation.operationalAddress.city" | "additionalInformation.operationalAddress.country" | "additionalInformation.operationalAddress.otherAddressInformation" | "additionalInformation.operationalAddress.postalCode" | "additionalInformation.operationalAddress.stateOrProvince" | "additionalInformation.registrationAddress.address" | "additionalInformation.registrationAddress.city" | "additionalInformation.registrationAddress.country" | "additionalInformation.registrationAddress.otherAddressInformation" | "additionalInformation.registrationAddress.postalCode" | "additionalInformation.registrationAddress.stateOrProvince" | "additionalInformation.legalFormDescription" | "basicInformation.country" | "basicInformation.stateOrProvince" | "basicInformation.registrationNumber" | "basicInformation.taxInformation" | "basicInformation.businessName" | "companyStructure.entityType";
|
|
85
86
|
};
|
|
86
87
|
export declare const companyComponentsKeyMapping: {
|
|
87
88
|
'companyNameAndCountry.country': string;
|
|
@@ -89,6 +90,8 @@ export declare const companyComponentsKeyMapping: {
|
|
|
89
90
|
'companyNameAndCountry.countryOfGoverningLaw': string;
|
|
90
91
|
'companyType.entityType': string;
|
|
91
92
|
'companyRegistrationDetails.tradingName': string;
|
|
93
|
+
'companyRegistrationDetails.dbaName': string;
|
|
94
|
+
'companyRegistrationDetails.doingBusinessAbsent': string;
|
|
92
95
|
'companyRegistrationDetails.registrationNumber': string;
|
|
93
96
|
'companyRegistrationDetails.taxInformation': string;
|
|
94
97
|
'companyRegistrationDetails.vatNumber': string;
|
|
@@ -112,7 +115,7 @@ export declare const companyComponentsKeyMapping: {
|
|
|
112
115
|
'companyRegistrationDetails.exemptedFromVat': string;
|
|
113
116
|
};
|
|
114
117
|
export declare const companyApiKeyMapping: {
|
|
115
|
-
[x: string]: "companyType.entityType" | "companyNameAndCountry.country" | "companyNameAndCountry.countryOfGoverningLaw" | "companyNameAndCountry.legalCompanyName" | "companyRegistrationDetails.dateOfIncorporation" | "companyRegistrationDetails.registrationNumber" | "companyRegistrationDetails.stockExchangeMIC" | "companyRegistrationDetails.stockISIN" | "companyRegistrationDetails.stockTickerSymbol" | "companyRegistrationDetails.tradingName" | "companyRegistrationDetails.vatAbsenceReason" | "companyRegistrationDetails.vatNumber" | "companyRegistrationDetails.taxInformation" | "companyRegistrationAddress.operationalAddress.address" | "companyRegistrationAddress.operationalAddress.city" | "companyRegistrationAddress.operationalAddress.country" | "companyRegistrationAddress.operationalAddress.otherAddressInformation" | "companyRegistrationAddress.operationalAddress.postalCode" | "companyRegistrationAddress.operationalAddress.stateOrProvince" | "companyRegistrationAddress.registrationAddress.address" | "companyRegistrationAddress.registrationAddress.city" | "companyRegistrationAddress.registrationAddress.country" | "companyRegistrationAddress.registrationAddress.otherAddressInformation" | "companyRegistrationAddress.registrationAddress.postalCode" | "companyRegistrationAddress.registrationAddress.stateOrProvince";
|
|
118
|
+
[x: string]: "companyType.entityType" | "companyNameAndCountry.country" | "companyNameAndCountry.countryOfGoverningLaw" | "companyNameAndCountry.legalCompanyName" | "companyRegistrationDetails.dateOfIncorporation" | "companyRegistrationDetails.dbaName" | "companyRegistrationDetails.registrationNumber" | "companyRegistrationDetails.stockExchangeMIC" | "companyRegistrationDetails.stockISIN" | "companyRegistrationDetails.stockTickerSymbol" | "companyRegistrationDetails.tradingName" | "companyRegistrationDetails.vatAbsenceReason" | "companyRegistrationDetails.vatNumber" | "companyRegistrationDetails.doingBusinessAbsent" | "companyRegistrationDetails.taxInformation" | "companyRegistrationAddress.operationalAddress.address" | "companyRegistrationAddress.operationalAddress.city" | "companyRegistrationAddress.operationalAddress.country" | "companyRegistrationAddress.operationalAddress.otherAddressInformation" | "companyRegistrationAddress.operationalAddress.postalCode" | "companyRegistrationAddress.operationalAddress.stateOrProvince" | "companyRegistrationAddress.registrationAddress.address" | "companyRegistrationAddress.registrationAddress.city" | "companyRegistrationAddress.registrationAddress.country" | "companyRegistrationAddress.registrationAddress.otherAddressInformation" | "companyRegistrationAddress.registrationAddress.postalCode" | "companyRegistrationAddress.registrationAddress.stateOrProvince";
|
|
116
119
|
};
|
|
117
120
|
export declare const payoutComponentKeyMapping: {
|
|
118
121
|
'payoutAccountDetails.transferInstrumentId': string;
|
|
@@ -134,6 +137,8 @@ export declare const payoutApiKeyMapping: {
|
|
|
134
137
|
export declare const trustComponentsKeyMapping: {
|
|
135
138
|
'trustRegistrationDetails.trustType': string;
|
|
136
139
|
'trustRegistrationDetails.legalName': string;
|
|
140
|
+
'trustRegistrationDetails.dbaName': string;
|
|
141
|
+
'trustRegistrationDetails.doingBusinessAbsent': string;
|
|
137
142
|
'trustRegistrationDetails.country': string;
|
|
138
143
|
'trustRegistrationDetails.registrationNumber': string;
|
|
139
144
|
'trustRegistrationAddress.registrationAddress.city': string;
|
|
@@ -150,7 +155,7 @@ export declare const trustComponentsKeyMapping: {
|
|
|
150
155
|
'trustRegistrationAddress.operationalAddress.otherAddressInformation': string;
|
|
151
156
|
};
|
|
152
157
|
export declare const trustApiKeyMapping: {
|
|
153
|
-
[x: string]: "trustRegistrationDetails.country" | "trustRegistrationDetails.registrationNumber" | "trustRegistrationDetails.legalName" | "trustRegistrationDetails.trustType" | "trustRegistrationAddress.operationalAddress.address" | "trustRegistrationAddress.operationalAddress.city" | "trustRegistrationAddress.operationalAddress.country" | "trustRegistrationAddress.operationalAddress.otherAddressInformation" | "trustRegistrationAddress.operationalAddress.postalCode" | "trustRegistrationAddress.operationalAddress.stateOrProvince" | "trustRegistrationAddress.registrationAddress.address" | "trustRegistrationAddress.registrationAddress.city" | "trustRegistrationAddress.registrationAddress.country" | "trustRegistrationAddress.registrationAddress.otherAddressInformation" | "trustRegistrationAddress.registrationAddress.postalCode" | "trustRegistrationAddress.registrationAddress.stateOrProvince";
|
|
158
|
+
[x: string]: "trustRegistrationDetails.country" | "trustRegistrationDetails.dbaName" | "trustRegistrationDetails.registrationNumber" | "trustRegistrationDetails.doingBusinessAbsent" | "trustRegistrationDetails.legalName" | "trustRegistrationDetails.trustType" | "trustRegistrationAddress.operationalAddress.address" | "trustRegistrationAddress.operationalAddress.city" | "trustRegistrationAddress.operationalAddress.country" | "trustRegistrationAddress.operationalAddress.otherAddressInformation" | "trustRegistrationAddress.operationalAddress.postalCode" | "trustRegistrationAddress.operationalAddress.stateOrProvince" | "trustRegistrationAddress.registrationAddress.address" | "trustRegistrationAddress.registrationAddress.city" | "trustRegistrationAddress.registrationAddress.country" | "trustRegistrationAddress.registrationAddress.otherAddressInformation" | "trustRegistrationAddress.registrationAddress.postalCode" | "trustRegistrationAddress.registrationAddress.stateOrProvince";
|
|
154
159
|
};
|
|
155
160
|
export declare const highExposureComponentsKeyMapping: {
|
|
156
161
|
'company.numberOfEmployees': string;
|
|
@@ -164,6 +169,8 @@ export declare const solePropComponentsKeyMapping: {
|
|
|
164
169
|
'solePropNameAndCountry.country': string;
|
|
165
170
|
'solePropNameAndCountry.legalCompanyName': string;
|
|
166
171
|
'solePropRegistrationDetails.tradingName': string;
|
|
172
|
+
'solePropRegistrationDetails.dbaName': string;
|
|
173
|
+
'solePropRegistrationDetails.doingBusinessAbsent': string;
|
|
167
174
|
'solePropRegistrationDetails.vatNumber': string;
|
|
168
175
|
'solePropRegistrationDetails.vatAbsenceReason': string;
|
|
169
176
|
'solePropRegistrationDetails.exemptedFromTax': string;
|
|
@@ -185,7 +192,7 @@ export declare const solePropComponentsKeyMapping: {
|
|
|
185
192
|
'solePropRegistrationDetails.exemptedFromVat': string;
|
|
186
193
|
};
|
|
187
194
|
export declare const solePropApiKeyMapping: {
|
|
188
|
-
[x: string]: "solePropNameAndCountry.country" | "solePropNameAndCountry.legalCompanyName" | "solePropRegistrationDetails.dateOfIncorporation" | "solePropRegistrationDetails.exemptedFromTax" | "solePropRegistrationDetails.registrationNumber" | "solePropRegistrationDetails.tradingName" | "solePropRegistrationDetails.vatAbsenceReason" | "solePropRegistrationDetails.vatNumber" | "solePropRegistrationDetails.taxInformation" | "solePropRegistrationAddress.operationalAddress.address" | "solePropRegistrationAddress.operationalAddress.city" | "solePropRegistrationAddress.operationalAddress.country" | "solePropRegistrationAddress.operationalAddress.otherAddressInformation" | "solePropRegistrationAddress.operationalAddress.postalCode" | "solePropRegistrationAddress.operationalAddress.stateOrProvince" | "solePropRegistrationAddress.registrationAddress.address" | "solePropRegistrationAddress.registrationAddress.city" | "solePropRegistrationAddress.registrationAddress.country" | "solePropRegistrationAddress.registrationAddress.otherAddressInformation" | "solePropRegistrationAddress.registrationAddress.postalCode" | "solePropRegistrationAddress.registrationAddress.stateOrProvince";
|
|
195
|
+
[x: string]: "solePropNameAndCountry.country" | "solePropNameAndCountry.legalCompanyName" | "solePropRegistrationDetails.dateOfIncorporation" | "solePropRegistrationDetails.dbaName" | "solePropRegistrationDetails.exemptedFromTax" | "solePropRegistrationDetails.registrationNumber" | "solePropRegistrationDetails.tradingName" | "solePropRegistrationDetails.vatAbsenceReason" | "solePropRegistrationDetails.vatNumber" | "solePropRegistrationDetails.doingBusinessAbsent" | "solePropRegistrationDetails.taxInformation" | "solePropRegistrationAddress.operationalAddress.address" | "solePropRegistrationAddress.operationalAddress.city" | "solePropRegistrationAddress.operationalAddress.country" | "solePropRegistrationAddress.operationalAddress.otherAddressInformation" | "solePropRegistrationAddress.operationalAddress.postalCode" | "solePropRegistrationAddress.operationalAddress.stateOrProvince" | "solePropRegistrationAddress.registrationAddress.address" | "solePropRegistrationAddress.registrationAddress.city" | "solePropRegistrationAddress.registrationAddress.country" | "solePropRegistrationAddress.registrationAddress.otherAddressInformation" | "solePropRegistrationAddress.registrationAddress.postalCode" | "solePropRegistrationAddress.registrationAddress.stateOrProvince";
|
|
189
196
|
};
|
|
190
197
|
export declare const financialInformationApiKeyMapping: {
|
|
191
198
|
[x: string]: "annualTurnover" | "currency" | "financialReportingDate" | "numberOfEmployees" | "netAssets";
|
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
import type { FormModel } from '../core/models/form';
|
|
2
1
|
import type { BaseTrackingPayload } from '../core/utils';
|
|
3
2
|
import type Language from '../language/Language';
|
|
3
|
+
import type { TranslationKey } from '../language/types';
|
|
4
4
|
export declare const trackNavigation: ({ fromForm, toForm, component, baseTrackingPayload, i18n, }: {
|
|
5
|
-
fromForm:
|
|
6
|
-
toForm:
|
|
5
|
+
fromForm: TranslationKey;
|
|
6
|
+
toForm: TranslationKey;
|
|
7
7
|
component: string;
|
|
8
8
|
baseTrackingPayload: BaseTrackingPayload;
|
|
9
9
|
i18n: Language;
|