@adyen/kyc-components 3.61.2 → 3.62.0

package/dist/types/components/UnincorporatedPartnership/hooks/useUnincorporatedPartnershipNavigation.d.ts

@@ -1,17 +1,22 @@
-import type { ExistingLegalEntity } from '#core/models/api/legal-entity';
+import type { ExistingLegalEntity, PatchLegalEntity } from '#core/models/api/legal-entity';
+import { LegalEntityType } from '#core/models/api/legal-entity-type';
 import type { UnincorporatedPartnershipMemberTypes } from '#core/models/api/unincorporated-partnership';
 import { TaskTypes } from '#shared/tasks/TaskList/types';
 import type { UnincorporatedPartnershipMember } from '../UnincorporatedPartnershipMembers/types';
 export interface NavigateToMemberProps {
     selectedMember: UnincorporatedPartnershipMember | undefined | 'new';
     selectedRoles?: UnincorporatedPartnershipMemberTypes[];
+    selectedEntityType?: LegalEntityType.ORGANIZATION | LegalEntityType.INDIVIDUAL;
     roleAndType?: boolean;
 }
-export declare const useUnincorporatedPartnershipNavigation: ({ setAssociatedLegalEntity, navigateTo, handleGetLegalEntity, }: {
+export interface NavigationProps {
     setAssociatedLegalEntity: (legalEntity?: ExistingLegalEntity) => void;
     navigateTo: (taskType: TaskTypes) => void;
     handleGetLegalEntity: (legalEntityId: string) => Promise<ExistingLegalEntity>;
-}) => {
-    onNavigateToMember: ({ selectedMember, selectedRoles, roleAndType, }: NavigateToMemberProps) => Promise<void>;
+    handleUpdateLegalEntity: (data: PatchLegalEntity, legalEntityId: string) => Promise<ExistingLegalEntity>;
+}
+export declare const useUnincorporatedPartnershipNavigation: ({ setAssociatedLegalEntity, navigateTo, handleGetLegalEntity, handleUpdateLegalEntity, }: NavigationProps) => {
+    onNavigateToMember: ({ selectedMember, selectedRoles, selectedEntityType, roleAndType, }: NavigateToMemberProps) => Promise<void>;
+    onDeleteMember: (member: UnincorporatedPartnershipMember, associatedLegalArrangement?: ExistingLegalEntity) => Promise<void>;
     activeMember: UnincorporatedPartnershipMember;
 };

package/dist/types/components/UnincorporatedPartnership/mapping/mapLegalEntityToUnincorporatedPartnership.d.ts

@@ -0,0 +1,4 @@
+import type { ExperimentName } from '#context/ExperimentContext/types';
+import type { LegalEntity } from '#models/api/legal-entity';
+import type { TrustSchema } from '../../Trust/forms/Trust/types';
+export declare const mapLegalEntityToUnincorporatedPartnership: (legalEntity: LegalEntity, isExperimentEnabled: (key: ExperimentName) => boolean) => TrustSchema;

package/dist/types/components/UnincorporatedPartnership/mapping/mapUnincorporatedPartnershipToLegalEntity.d.ts

@@ -0,0 +1,4 @@
+import type { ExperimentName } from '#context/ExperimentContext/types';
+import type { LegalEntity } from '#models/api/legal-entity';
+import type { TrustSchema } from '../../Trust/forms/Trust/types';
+export declare const mapUnincorporatedPartnershipToLegalEntity: (data: TrustSchema, isExperimentEnabled: (key: ExperimentName) => boolean) => LegalEntity;

package/dist/types/components/UnincorporatedPartnership/mapping/unincorporatedPartnershipKeyMappings.d.ts

@@ -0,0 +1,6 @@
+import type { LegalEntity } from '#models/api/legal-entity';
+import type { DocumentMappingRecord, MappingRecord } from '#utils/mapping/mappingRecord';
+import type { TrustSchema } from '../../Trust/forms/Trust/types';
+export declare const unincorporatedPartnershipComponentsKeyMapping: MappingRecord<TrustSchema, Pick<LegalEntity, 'unincorporatedPartnership'>>;
+export declare const unincorporatedPartnershipApiKeyMapping: MappingRecord<Pick<LegalEntity, 'unincorporatedPartnership'>, TrustSchema>;
+export declare const unincorporatedPartnershipDocumentMapping: DocumentMappingRecord<TrustSchema>;

package/dist/types/components/UnincorporatedPartnership/utils/unincorporatedPartnershipMembers.d.ts

@@ -1,4 +1,6 @@
+import type { ExistingLegalEntity } from '#core/models/api/legal-entity';
 import type { LegalEntityAssociation } from '#core/models/api/legal-entity-association';
+import type { DropinAPIHandlers } from '../../EmbeddedDropins/OnboardingDropinComponent/DropinComposer/types';
 import type { UnincorporatedPartnershipMember } from '../UnincorporatedPartnershipMembers/types';
 /**
  * In the API response, there are multiple {@link LegalEntityAssociation}s for the same associated entity;
@@ -7,3 +9,8 @@ import type { UnincorporatedPartnershipMember } from '../UnincorporatedPartnersh
  * Therefore we need to combine these into one {@link UnincorporatedPartnershipMember} with multiple roles.
  */
 export declare const mapEntityAssociationsToUnincorporatedPartnershipMembers: (entityId: string, entityAssociations: LegalEntityAssociation[]) => UnincorporatedPartnershipMember[];
+export declare const deleteUnincorporatedPartnershipMember: ({ associatedTrustMember, unincorporatedPartnership, handleUpdateLegalEntity, }: {
+    associatedTrustMember: UnincorporatedPartnershipMember;
+    unincorporatedPartnership: ExistingLegalEntity;
+    handleUpdateLegalEntity: NonNullable<DropinAPIHandlers["handleUpdateLegalEntity"]>;
+}) => Promise<void>;

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

@@ -2,12 +2,12 @@ import type { CoreProviderProps } from '#context/CoreContext/CoreProvider';
 import type { ExperimentsProps } from '#context/ExperimentContext/types';
 import type { SettingsProps } from '#context/SettingsContext/types';
 import type { EventEmitter } from '#core/EventEmitter';
-import type { UserEventCallback } from '#core/user-events';
 import { PayoutDetailsDropin } from './BankAccount/tasks/PayoutDetailsDropin/PayoutDetailsDropin';
 import { BusinessDetailsDropin } from './Business/tasks/BusinessDetailsDropin/BusinessDetailsDropin';
 import { CompanyDropin } from './Business/tasks/CompanyDropin/CompanyDropin';
 import { PciDropin } from './Contract/tasks/PciDropin/PciDropin';
 import { SourceOfFundsDropin } from './EFP/tasks/SourceOfFundsDropin/SourceOfFundsDropin';
+import { TaxReportingDropin } from './EFP/tasks/TaxReportingDropin/TaxReportingDropin';
 import { AcceptTermsOfServiceComponent } from './EmbeddedDropins/AcceptTermsOfServiceComponent/AcceptTermsOfServiceComponent';
 import { CreateIndividualComponent } from './EmbeddedDropins/CreateIndividualComponent/CreateIndividualComponent';
 import { CreateTransferInstrumentComponent } from './EmbeddedDropins/CreateTransferInstrumentComponent/CreateTransferInstrumentComponent';
@@ -47,6 +47,7 @@ export declare const componentsMap: {
     readonly viewVerificationStatusComponent: typeof ViewVerificationStatusComponent;
     readonly updateLegalEntityForHighExposureComponent: typeof UpdateLegalEntityForHighExposure;
     readonly sourceOfFundsDropin: typeof SourceOfFundsDropin;
+    readonly taxReportingDropin: typeof TaxReportingDropin;
 };
 export type ComponentMap = typeof componentsMap;
 export type ComponentProps<Name extends keyof ComponentMap> = Parameters<ComponentMap[Name]>[0];
@@ -62,7 +63,5 @@ interface CommonInternalProps {
     /** Used to update locale in components */
     eventEmitter: EventEmitter;
 }
-export type ComponentOptions<Name extends keyof ComponentMap> = ComponentPropsWithoutInternalProps<Name> & Partial<CoreProviderProps> & Partial<SettingsProps> & Partial<ExperimentsProps> & {
-    onUserEvent?: UserEventCallback;
-};
+export type ComponentOptions<Name extends keyof ComponentMap> = ComponentPropsWithoutInternalProps<Name> & Partial<CoreProviderProps> & Partial<SettingsProps> & Partial<ExperimentsProps>;
 export {};

package/dist/types/components/ui/atoms/Svg/svgs.d.ts

@@ -73,6 +73,7 @@ export declare const customIcons: {
     review: import("preact").FunctionComponent<import("preact/jsx-runtime").JSX.SVGAttributes<SVGSVGElement>>;
     'funds-in': import("preact").FunctionComponent<import("preact/jsx-runtime").JSX.SVGAttributes<SVGSVGElement>>;
     house: import("preact").FunctionComponent<import("preact/jsx-runtime").JSX.SVGAttributes<SVGSVGElement>>;
+    reporting: import("preact").FunctionComponent<import("preact/jsx-runtime").JSX.SVGAttributes<SVGSVGElement>>;
 };
 export declare const images: {
     'document-blurred': import("preact").FunctionComponent<import("preact/jsx-runtime").JSX.SVGAttributes<SVGSVGElement>>;
@@ -104,6 +105,7 @@ export declare const images: {
     'plaid-logo': import("preact").FunctionComponent<import("preact/jsx-runtime").JSX.SVGAttributes<SVGSVGElement>>;
     'trustly-logo': import("preact").FunctionComponent<import("preact/jsx-runtime").JSX.SVGAttributes<SVGSVGElement>>;
     'source-of-funds': import("preact").FunctionComponent<import("preact/jsx-runtime").JSX.SVGAttributes<SVGSVGElement>>;
+    'tax-reporting-graph': import("preact").FunctionComponent<import("preact/jsx-runtime").JSX.SVGAttributes<SVGSVGElement>>;
 };
 export declare const svgs: {
     readonly 'document-blurred': import("preact").FunctionComponent<import("preact/jsx-runtime").JSX.SVGAttributes<SVGSVGElement>>;
@@ -135,9 +137,11 @@ export declare const svgs: {
     readonly 'plaid-logo': import("preact").FunctionComponent<import("preact/jsx-runtime").JSX.SVGAttributes<SVGSVGElement>>;
     readonly 'trustly-logo': import("preact").FunctionComponent<import("preact/jsx-runtime").JSX.SVGAttributes<SVGSVGElement>>;
     readonly 'source-of-funds': import("preact").FunctionComponent<import("preact/jsx-runtime").JSX.SVGAttributes<SVGSVGElement>>;
+    readonly 'tax-reporting-graph': import("preact").FunctionComponent<import("preact/jsx-runtime").JSX.SVGAttributes<SVGSVGElement>>;
     readonly review: import("preact").FunctionComponent<import("preact/jsx-runtime").JSX.SVGAttributes<SVGSVGElement>>;
     readonly 'funds-in': import("preact").FunctionComponent<import("preact/jsx-runtime").JSX.SVGAttributes<SVGSVGElement>>;
     readonly house: import("preact").FunctionComponent<import("preact/jsx-runtime").JSX.SVGAttributes<SVGSVGElement>>;
+    readonly reporting: import("preact").FunctionComponent<import("preact/jsx-runtime").JSX.SVGAttributes<SVGSVGElement>>;
     readonly 'adyen-a-filled': import("preact").FunctionComponent<import("preact/jsx-runtime").JSX.SVGAttributes<SVGSVGElement>>;
     readonly 'arrow-left': import("preact").FunctionComponent<import("preact/jsx-runtime").JSX.SVGAttributes<SVGSVGElement>>;
     readonly 'arrow-right': import("preact").FunctionComponent<import("preact/jsx-runtime").JSX.SVGAttributes<SVGSVGElement>>;

package/dist/types/context/AnalyticsContext/AnalyticsProvider.d.ts

@@ -1,10 +1,13 @@
 import type { ComponentChildren } from 'preact';
-import type { UserEventCallback } from '#core/user-events';
 import type { ComponentMap } from '../../components';
 export interface AnalyticsProviderProps {
-    onUserEvent?: UserEventCallback;
     componentName: keyof ComponentMap;
     children?: ComponentChildren;
     legalEntityId: string;
 }
-export declare const AnalyticsProvider: ({ onUserEvent, componentName, children, legalEntityId, }: AnalyticsProviderProps) => import("preact/jsx-runtime").JSX.Element;
+/**
+ * The provider exists to scope analytics to one application instance.
+ * This would otherwise be problematic when a consumer might have several
+ * instantiations of a embedded Component for instance on the same page
+ */
+export declare const AnalyticsProvider: ({ componentName, children, legalEntityId, }: AnalyticsProviderProps) => import("preact/jsx-runtime").JSX.Element;

package/dist/types/context/ApiContext/ApiProvider.d.ts

@@ -2,7 +2,6 @@ import type { Signal } from '@preact/signals';
 import { type ComponentChildren } from 'preact';
 interface ApiStateProps {
     legalEntityId: string;
-    isComponent: boolean;
     baseUrl: string;
     children?: ComponentChildren;
 }
@@ -18,5 +17,5 @@ export declare const useApiContext: () => ApiState;
  * @param {string} legalEntityId - legalEntityId
  * @param {string} baseUrl - base url
  */
-export declare const ApiProvider: ({ legalEntityId, baseUrl, isComponent, children }: ApiStateProps) => import("preact/jsx-runtime").JSX.Element;
+export declare const ApiProvider: ({ legalEntityId, baseUrl, children }: ApiStateProps) => import("preact/jsx-runtime").JSX.Element;
 export {};

package/dist/types/context/ConfigurationApiContext/ConfigurationApiContext.d.ts

@@ -1,23 +1,14 @@
 import type { AccountIdentification } from '#models/api/accountIdentification';
 import type { DataSet } from '#models/api/data-set';
-import type { GetAllowedCountriesResponse } from '#models/api/get-allowed-countries';
 import type { GetConfigurationRequest, GetConfigurationResponse } from '#models/api/get-configuration';
-import type { BusinessLinesType, SourceOfFundsPayloadType } from '#models/api/source-of-funds';
 import type { VerifyIdNumberRequest, VerifyIdNumberResponse } from '#models/api/verify-id-number';
-import type { CountryCode } from '#models/country-code';
 import type { AccountValidationResponse, ValidationResponse } from '#models/errors/validation-error';
 import type { DatasetIdentifier } from '#utils/datasetUtil';
 export type ConfigurationApi = {
     getConfiguration: (request: GetConfigurationRequest) => Promise<GetConfigurationResponse>;
-    getAllowedCountries: () => Promise<GetAllowedCountriesResponse>;
     getDataset: (identifier: DatasetIdentifier, locale: string) => Promise<DataSet>;
     validateAccountIdentification: (accountIdentificationDetails: AccountIdentification) => Promise<AccountValidationResponse>;
     verifyIdNumber: (request: VerifyIdNumberRequest) => Promise<VerifyIdNumberResponse | undefined>;
     validatePhoneNumber: (phoneNumber: string) => Promise<ValidationResponse>;
-    getLegalForms: (countryCode?: CountryCode) => Promise<DataSet>;
-    getNaceCodes: () => Promise<DataSet>;
-    getBusinessLines: (legalEntityId: string) => Promise<BusinessLinesType[]>;
-    getSourceOfFundsTypes: () => Promise<DataSet>;
-    updateSourceOfFunds: (legalEntityId: string, businessLineId: string, sourceOfFundData: SourceOfFundsPayloadType) => Promise<BusinessLinesType | undefined>;
 };
 export declare const ConfigurationApiContext: import("preact").Context<ConfigurationApi>;

package/dist/types/context/ExperimentContext/types.d.ts

@@ -8,8 +8,6 @@ export declare enum ExperimentNames {
     EnableKompanySearchByRegistrationNumber = "EnableKompanySearchByRegistrationNumber",
     AllowMoreRolesForMainRootTrustee = "AllowMoreRolesForMainRootTrustee",
     ShowUnsupportedEntityType = "ShowUnsupportedEntityType",
-    ShowSingPassButtonForCompanies = "ShowSingPassButtonForCompanies",
-    ShowSingPassButtonForIndividuals = "ShowSingPassButtonForIndividuals",
     ShowExtraTaxExemptionReasons = "ShowExtraTaxExemptionReasons",
     EnableEInvoicingCodeField = "EnableEInvoicingCodeField",
     EnableCountryOfGoverningLawForUKCompanies = "EnableCountryOfGoverningLawForUKCompanies",
@@ -17,13 +15,11 @@ export declare enum ExperimentNames {
     HidePciTask = "HidePciTask",
     EnableAgeVerification = "EnableAgeVerification",
     EnableNationalitySGHK = "EnableNationalitySGHK",
-    EnableMinimalRegistrationNumberValidationForAuIncorporatedAssociation = "EnableMinimalRegistrationNumberValidationForAuIncorporatedAssociation",
     EnablePreferInstantVerificationFlow = "EnablePreferInstantVerificationFlow",
     EnableFinancialInformationComponentV4 = "EnableFinancialInformationComponentV4",
     StrictNameAndAddressValidationV4 = "StrictNameAndAddressValidationV4",
     EnableDoingBusinessAsNameV4 = "EnableDoingBusinessAsNameV4",
     EnablePhoneFieldScenario = "EnablePhoneFieldScenario",
-    EnableAUIncorporatedPartnershipSkipRegistrationNumber = "EnableAUIncorporatedPartnershipSkipRegistrationNumber",
     ShowCustomerSupportV4 = "ShowCustomerSupportV4",
     EnableRegistrationAndTaxAbsentStatesV4 = "EnableRegistrationAndTaxAbsentStatesV4",
     EnableManualCompanyTinVerification = "EnableManualCompanyTinVerification",

package/dist/types/context/StateContext/types.d.ts

@@ -1,3 +1,4 @@
+import type { TaxReportingClassification } from '#models/api/tax-reporting-classification';
 import type { CustomerSupportSchema } from '#shared/tasks/CustomerSupport/types';
 import type { ValidationRuleResult } from '#utils/validation/types';
 import type { PayoutDetailsSchema } from '../../components/BankAccount/forms/PayoutDetails/types';
@@ -51,7 +52,7 @@ export type StateModel<TLDS extends TopLevelDataSchema = TopLevelDataSchema> = {
         prevState?: State<TLDS>;
     };
 };
-export type TopLevelDataSchema = IndividualSchema | IndividualOnfidoSchema | BusinessDetailsSchema | CompanySchema | CustomerSupportSchema | PayoutDetailsSchema | TrustSchema | TrustMemberSchema | SolePropSchema | HighExposureSchema | SourceOfFundsSchema;
+export type TopLevelDataSchema = IndividualSchema | IndividualOnfidoSchema | BusinessDetailsSchema | CompanySchema | CustomerSupportSchema | PayoutDetailsSchema | TrustSchema | TrustMemberSchema | SolePropSchema | HighExposureSchema | SourceOfFundsSchema | TaxReportingClassification;
 export type AnyFormIdOfTLDS = keyof IndividualSchema | keyof BusinessDetailsSchema | keyof CompanySchema | keyof PayoutDetailsSchema | keyof TrustSchema | keyof TrustMemberSchema | keyof SolePropSchema;
 export interface State<TLDS extends TopLevelDataSchema> {
     data: TLDS;

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

@@ -1,7 +1,6 @@
 import './UIElement.scss';
 import type { JSX } from 'preact';
 import type { EmptyObject } from 'type-fest';
-import type { AuthProviderProps } from '#context/AuthContext/AuthProvider';
 import type { CoreProviderProps } from '#context/CoreContext/CoreProvider';
 import type { ExperimentsProps } from '#context/ExperimentContext/types';
 import type { ExpiryProviderProps } from '#context/ExpiryContext/ExpiryContext';
@@ -10,9 +9,10 @@ import type { SettingsProps } from '#context/SettingsContext/types';
 import type { ComponentMap } from '../../components';
 import type { BaseElementProps } from '../BaseElement';
 import { BaseElement } from '../BaseElement';
-import type { UserEventCallback } from '../user-events';
-export interface UIElementProps<Props extends object> extends BaseElementProps, CoreProviderProps, AuthProviderProps, I18nProviderProps, ExpiryProviderProps, SettingsProps, ExperimentsProps {
-    onUserEvent?: UserEventCallback;
+interface EmbedProps {
+    loadingContext: string;
+}
+export interface UIElementProps<Props extends object> extends BaseElementProps, CoreProviderProps, I18nProviderProps, ExpiryProviderProps, SettingsProps, EmbedProps, ExperimentsProps {
     component: (props: Props) => JSX.Element;
     componentName: keyof ComponentMap;
     componentProps: Props;
@@ -20,3 +20,4 @@ export interface UIElementProps<Props extends object> extends BaseElementProps,
 export declare class UIElement<Props extends object = EmptyObject> extends BaseElement<UIElementProps<Props>> {
     render: () => JSX.Element;
 }
+export {};

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

@@ -1,4 +1,5 @@
 import type { MixpanelProperty } from '../../user-events';
+/** @deprecated */
 export interface EmbeddedAnalyticsSessionRequest {
     sdkVersion: string;
     componentName: string;
@@ -6,6 +7,7 @@ export interface EmbeddedAnalyticsSessionRequest {
     legalEntityId: string;
     userData?: Record<string, MixpanelProperty>;
 }
+/** @deprecated */
 export interface EmbeddedAnalyticsSessionResponse {
     id: string;
 }

package/dist/types/core/models/api/check.d.ts

@@ -0,0 +1,4 @@
+import type { components } from '#api/check/check.contract';
+import type { AccountIdentification } from './accountIdentification';
+export type CAASResponseError = components['schemas']['CheckResponseDto']['errors'];
+export type CAASRequest = AccountIdentification;

package/dist/types/core/models/api/document.d.ts

@@ -37,5 +37,9 @@ export declare enum DocumentType {
     PROOF_OF_RESIDENCY = "proofOfResidency",
     REGISTRATION_DOCUMENT = "registrationDocument",
     RESIDENCE_PERMIT = "residence_permit",
-    VAT_DOCUMENT = "vatDocument"
+    VAT_DOCUMENT = "vatDocument",
+    DEPOSIT_SLIP = "depositSlip",
+    SCREENSHOT_OF_BANK = "screenshotOfOnlineBankingEnviroment",
+    A_LETTER_FROM_YOUR_BANK = "aLetterFromYourBank",
+    CHECK = "check"
 }

package/dist/types/core/models/api/get-scenarios.d.ts

@@ -10,9 +10,11 @@ export declare const enum Scenarios {
     L1_IDO = "L1_IDO",
     L1_NAT = "L1_NAT",
     L1_IDDOC = "L1_IDDOC",
+    L2 = "L2",
     L_REGDOC = "L_REGDOC",
     L_TAXDOC = "L_TAXDOC",
-    L_PROOFOFADDRESS = "L_PROOFOFADDRESS"
+    L_PROOFOFADDRESS = "L_PROOFOFADDRESS",
+    L_PH = "L_PH"
 }
 export type Scenario = `${Scenarios}`;
 export interface GetScenariosResponse {

package/dist/types/core/models/api/individual.d.ts

@@ -8,7 +8,7 @@ export interface Individual {
     email?: string;
     identificationData?: {
         issuerState?: string;
-        nationalIdExempt: boolean;
+        nationalIdExempt?: boolean;
         number?: string;
         type?: string;
         cardNumber?: string;

package/dist/types/core/models/api/organization.d.ts

@@ -1,3 +1,4 @@
+import type { TaxReportingClassification } from '#models/api/tax-reporting-classification';
 import type { TaxIdNumberType } from '#shared/fields/IdFieldTypeSelector/countryIdNumberTypes';
 import type { CountryCode } from '../country-code';
 import type { Address } from './address';
@@ -40,6 +41,7 @@ export interface Organization {
     globalLegalEntityIdentifier?: string;
     eInvoicingCode?: string;
     support?: CustomerSupport;
+    taxReportingClassification?: TaxReportingClassification;
 }
 export declare const vatAbsenceReasons: readonly ["industryExemption", "belowTaxThreshold", "countryWithoutVatOrGstSystem"];
 export type VatAbsenceReason = (typeof vatAbsenceReasons)[number];

package/dist/types/core/models/api/tax-reporting-classification.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Tax reporting classification.
+ *
+ * The tax reporting classification (FATCA/CRS self-certification) of the organization..
+ *
+ */
+export interface TaxReportingClassification {
+    businessType?: TaxReportingBusinessType;
+    financialInstitutionNumber?: string;
+    mainSourceOfIncome?: TaxReportingMainSourceOfIncomeType;
+    type?: TaxReportingClassificationType;
+}
+export type TaxReportingBusinessType = 'listedPublicCompany' | 'subsidiaryOfListedPublicCompany' | 'governmentalOrganization' | 'internationalOrganization' | 'financialInstitution' | 'other';
+export type TaxReportingMainSourceOfIncomeType = 'businessOperation' | 'realEstateSales' | 'investmentInterestOrRoyalty' | 'propertyRental' | 'other';
+export type TaxReportingClassificationType = 'nonFinancialNonReportable' | 'financialNonReportable' | 'nonFinancialActive' | 'nonFinancialPassive';

package/dist/types/core/models/field-configurations.d.ts

@@ -1,11 +1,15 @@
+import type { MaskSettings } from '#hooks/useForm/types';
+import type { Translatable, TranslationKey } from '#language/types';
 import type { PerCountry } from '#utils/perCountry';
-import type { FieldMetadata } from './country-config';
-import type { ScenarioFieldSettings } from './scenario-fields';
-type FieldConfiguration<FieldType> = ScenarioFieldSettings<FieldType>;
-export type FieldConfigurations<FormSchema> = {
-    [key in keyof FormSchema]: FieldConfiguration<FormSchema[key]>;
-};
+import type { ValidatorRule } from '#utils/validation/types';
+export interface FieldMetadata<FormSchema, FieldName extends keyof FormSchema> {
+    label?: TranslationKey;
+    placeholder?: TranslationKey;
+    helperText?: Translatable;
+    guidanceText?: Translatable;
+    mask?: MaskSettings;
+    validators?: ValidatorRule<FormSchema[FieldName], FormSchema> | ValidatorRule<FormSchema[FieldName], FormSchema>[];
+}
 export type PerCountryFieldConfig<FormSchema, FieldName extends keyof FormSchema, Params extends object> = PerCountry<FieldMetadata<FormSchema, FieldName> | ((params: Params) => FieldMetadata<FormSchema, FieldName>)>;
 export type NoParams = Record<string, never>;
 export declare const resolveFieldMetadata: <FormSchema, FieldName extends keyof FormSchema, Params extends object>(countryEntry: FieldMetadata<FormSchema, FieldName> | ((params: Params) => FieldMetadata<FormSchema, FieldName>) | undefined, params: Params, defaultMetadata: FieldMetadata<FormSchema, FieldName>) => FieldMetadata<FormSchema, FieldName>;
-export {};

package/dist/types/core/models/form-configuration.d.ts

@@ -0,0 +1,36 @@
+import type { AllUnionFields, ValueOf } from 'type-fest';
+import type { TopLevelDataSchema } from '#context/StateContext/types';
+import type { TranslationKey } from '#language/types';
+import type { Scenario } from '#models/api/get-scenarios';
+import type { PerCountry } from '#utils/perCountry';
+export interface FieldSettings<RuleName extends string> {
+    obscured?: boolean;
+    rule?: RuleName | 'REQUIRED' | 'OPTIONAL';
+    rules?: Array<RuleName>;
+    /**
+     * The default label is a translation of the field name.
+     * Usually overridden by an {@link PerCountryFormConfiguration}.
+     */
+    label?: TranslationKey;
+}
+/**
+ * We're only interested in the keys of the inner schemas
+ */
+type GrandchildKeyOf<T> = keyof AllUnionFields<ValueOf<Required<T>>>;
+/**
+ * A {@link FormConfiguration} tells us for each field within a form, which rule(s) will decide if that
+ * field is `REQUIRED` or `OPTIONAL`.
+ *
+ * Optionally they can mark a field as {@link FieldSettings.obscured},
+ * which indicates that the API may give us a (partially) obscured value.
+ */
+export type FormConfiguration<TLDS extends TopLevelDataSchema, RuleName extends string> = Partial<Record<GrandchildKeyOf<TLDS>, // TODO replace this with `MappingKey<TLDS>` at some point
+FieldSettings<RuleName>>>;
+export type FormConfigurationWithoutRules<TLDS extends TopLevelDataSchema> = Partial<Record<GrandchildKeyOf<TLDS>, Pick<FieldSettings<string>, 'label'>>>;
+/**
+ * A form configuration is defined for each {@link Scenario}. Normally this means higher scenarios
+ * (e.g. `L1_ID` or `L`) override rules for relevant fields, making more fields `REQUIRED`.
+ */
+export type PerScenarioFormConfiguration<TLDS extends TopLevelDataSchema, RuleName extends string> = Partial<Record<Scenario, FormConfiguration<TLDS, RuleName>>>;
+export type PerCountryFormConfiguration<TLDS extends TopLevelDataSchema> = PerCountry<FormConfigurationWithoutRules<TLDS>>;
+export {};

package/dist/types/core/models/form-rules.d.ts

@@ -13,11 +13,14 @@ export interface FormRulesParams<TLDS extends TopLevelDataSchema> {
     isSettingEnabled?: (setting: SettingName) => boolean;
     isExperimentEnabled?: (experiment: ExperimentName) => boolean;
     requiredFields?: Partial<AccountFormatRequirements>;
-    isEmbeddedDropin?: boolean;
     rootLegalEntity?: ExistingLegalEntity;
     accountHolder?: AccountHolderOption;
     tinMatched?: boolean;
 }
-export type FormRules<TLDS extends TopLevelDataSchema> = (params: FormRulesParams<TLDS>) => {
-    [ruleName: string]: () => string | boolean | undefined;
-};
+type FieldRule = () => 'REQUIRED' | 'OPTIONAL' | undefined;
+export type FormRules<RuleName extends string> = Record<RuleName, FieldRule>;
+/**
+ * Identity function that guarantees strictly typed rules with the provided rule names
+ */
+export declare const createFormRules: <SpecificRules extends FormRules<string>>(rules: SpecificRules) => SpecificRules;
+export {};

package/dist/types/core/process-field-configurations.d.ts

@@ -1,36 +1,17 @@
+import type { TopLevelDataSchema } from '#context/StateContext/types';
 import type { BaseOuterFormProps } from '#hooks/useForm/types';
 import type { Scenario } from '#models/api/get-scenarios';
 import type { LegalEntityTrustedFields } from '#models/api/legal-entity';
 import type { LegalEntityType } from '#models/api/legal-entity-type';
 import type { VerificationError } from '#models/api/verification-error';
-import type { CountryCode } from '#models/country-code';
 import type { Remediation } from '#models/errors/remediation';
-import type { FieldConfigurations } from '#models/field-configurations';
 import type { FormList } from '#models/form';
+import type { FormConfiguration, FormConfigurationWithoutRules, PerScenarioFormConfiguration } from '#models/form-configuration';
+import type { FormRules } from '#models/form-rules';
 import type { AnyTLDSFieldName } from '#utils/getFieldsWithExistingData';
-import type { ValidatorRules } from '#utils/validation/types';
-import type { PayoutAccountSchema } from '../components/BankAccount/forms/PayoutAccount/types';
-import type { BusinessDetailsSchema } from '../components/Business/forms/BusinessDetails/types';
-import type { CompanySchema } from '../components/Business/forms/Company/types';
-import type { HighExposureSchema } from '../components/EFP/tasks/HighExposureDropin/types';
-import type { IndividualSchema } from '../components/Individual/forms/Individual/types';
-import type { SolePropSchema } from '../components/SoleProprietorship/forms/SoleProp/types';
-import type { TrustSchema } from '../components/Trust/forms/Trust/types';
-export declare const parseIndividualScenarios: (scenario: Scenario[] | undefined) => FieldConfigurations<IndividualSchema>;
-export declare const parseIndividualOnfidoScenarios: (scenario: Scenario[] | undefined) => FieldConfigurations<IndividualSchema>;
-export declare function parseBusinessDetailsScenarios(scenario: Scenario[] | undefined, country: CountryCode): FieldConfigurations<BusinessDetailsSchema>;
-export declare function parseCompanyScenarios(scenario: Scenario[], country: CountryCode): FieldConfigurations<CompanySchema>;
-export declare function parseTrustScenarios(scenario: Scenario[], country: CountryCode): FieldConfigurations<TrustSchema>;
-export declare const parseHighExposureScenarios: (scenario: Scenario[] | undefined) => FieldConfigurations<HighExposureSchema>;
-export declare function parseSolePropScenarios(scenario: Scenario[], country: CountryCode): FieldConfigurations<SolePropSchema>;
-export declare function parsePayoutScenarios({ requiredFields, country, bankVerificationAvailable, }: {
-    requiredFields: (keyof PayoutAccountSchema)[] | undefined;
-    country: CountryCode;
-    bankVerificationAvailable: boolean | undefined;
-}): Partial<FieldConfigurations<PayoutAccountSchema>>;
-export type PropsFromConfiguration<FormSchema> = Required<Pick<BaseOuterFormProps<FormSchema>, 'allFields' | 'verifyFields' | 'requiredFields' | 'placeholders' | 'helperText' | 'masks' | 'optionalFields' | 'labels' | 'obscuredFields' | 'trustedFields'>> & {
-    validators: ValidatorRules<FormSchema>;
-};
+export declare const composePerScenarioFormConfigurations: <TLDS extends TopLevelDataSchema>(scenarios: Scenario[], configurations: PerScenarioFormConfiguration<TLDS, string>) => FormConfiguration<TLDS, string>;
+export declare const augmentWithCountryConfigs: <FormSchema>(countrySpecificConfig: FormConfigurationWithoutRules<FormSchema> | undefined, baseFormConfig: FormConfiguration<FormSchema, string>) => FormConfiguration<FormSchema, string>;
+export type PropsFromConfiguration<FormSchema> = Required<Pick<BaseOuterFormProps<FormSchema>, 'allFields' | 'requiredFields' | 'optionalFields' | 'labels' | 'obscuredFields' | 'trustedFields'>>;
 /**
  * function: getPropsFromScenarios
  *
@@ -71,4 +52,5 @@ export type PropsFromConfiguration<FormSchema> = Required<Pick<BaseOuterFormProp
  * }
  * ```
  */
-export declare function getPropsFromConfigurations<FormSchema extends object>(scenarioConfiguration: FieldConfigurations<FormSchema> | undefined, forms: FormList, remediationActions: Remediation[], dataMissingErrors: VerificationError[], fieldsWithExistingData: AnyTLDSFieldName[], customRules: {}, customLabels: {}, customValidators: {}, legalEntityType: LegalEntityType | undefined, legalEntityTrustedFields?: LegalEntityTrustedFields[], remediationFieldAsOptional?: boolean): PropsFromConfiguration<FormSchema> | undefined;
+export declare function getPropsFromConfigurations<FormSchema extends object>(scenarioConfiguration: FormConfiguration<FormSchema, string> | undefined, forms: FormList, remediationActions: Remediation[], dataMissingErrors: VerificationError[], fieldsWithExistingData: AnyTLDSFieldName[], // TODO can type more strictly as `MappingKey<FormSchema>`
+customRules: FormRules<string>, _customLabels: {}, _customValidators: {}, legalEntityType: LegalEntityType | undefined, legalEntityTrustedFields?: LegalEntityTrustedFields[], remediationFieldAsOptional?: boolean): PropsFromConfiguration<FormSchema> | undefined;

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

@@ -1,7 +1,7 @@
-import type { NonEmbeddedAuthContextType } from '#context/AuthContext/AuthContext';
 export type FetchErrorLevel = 'silent' | 'info' | 'warn' | 'error' | 'fatal';
 export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'OPTIONS' | 'PATCH';
-export type RequestContext = Partial<NonEmbeddedAuthContextType> & Required<Pick<NonEmbeddedAuthContextType, 'clientKey'>> & {
+export type RequestContext = {
+    clientKey: string;
     loadingContext: string;
 };
 export interface HttpOptions {

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

@@ -1,4 +1,3 @@
-import type { TokenResponse } from '#context/AuthContext/AuthProvider';
 import type { CountryCode } from '#models/country-code';
 export interface CoreOptions {
     /**
@@ -18,7 +17,9 @@ export interface CoreOptions {
      * JWT token used for embedded Dropin authentication
      */
     sdkToken?: string;
-    getSdkToken?(): Promise<TokenResponse>;
+    getSdkToken?(): Promise<{
+        token: string;
+    }>;
     /**
      * When the user's session is set to expire.
      * Should be provided as a Unix timestamp, i.e. milliseconds since epoch (e.g. 1721054807209).

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

@@ -36,6 +36,7 @@ export interface AdditionalEventProperties {
     field?: string;
     returnType?: 'backend' | 'validation' | (string & {});
     returnValue?: string | string[];
+    additionalData?: string | string[];
     label?: string;
     [key: string]: MixpanelProperty;
     'Experiment name'?: string;
@@ -53,7 +54,7 @@ export type EventQueueItem = {
     name: EventName;
     properties?: AnalyticsEventPayload;
 };
-export type UserEventCallback = (eventQueueItem: EventQueueItem) => void;
+type UserEventCallback = (eventQueueItem: EventQueueItem) => void;
 export declare class UserEvents {
     private readonly queue;
     private readonly subscriptions;

package/dist/types/hooks/useAnalytics.d.ts

@@ -1,12 +1,9 @@
-import type { AnalyticsEventPayload, EventQueueItem, EventType, MixpanelProperty, UserEventCallback, UserEvents } from '#core/user-events';
+import type { AnalyticsEventPayload, EventQueueItem, EventType, MixpanelProperty, UserEvents } from '#core/user-events';
 import type { EmbeddedAnalyticsSessionRequest } from '#models/api/analytics';
-import type { ComponentMap } from '../components';
-import type { OnboardingVersion } from './useVersionConfiguration';
 export type UseAnalyticsProps = {
-    onUserEvent?: UserEventCallback;
     userEvents: UserEvents;
-    componentName: keyof ComponentMap;
-    onboardingVersion: OnboardingVersion;
+    sessionId: string | undefined;
+    sessionData: EmbeddedAnalyticsSessionRequest;
 };
 type EmbeddedEventItem = {
     eventType: EventType;
@@ -14,5 +11,5 @@ type EmbeddedEventItem = {
     eventData: AnalyticsEventPayload | Record<string, MixpanelProperty>;
 };
 export declare const convertToEmbeddedEvent: (eventQueueItem: EventQueueItem, sessionData: EmbeddedAnalyticsSessionRequest) => EmbeddedEventItem & EmbeddedAnalyticsSessionRequest;
-export declare const useAnalytics: ({ onUserEvent, userEvents, componentName, onboardingVersion, }: UseAnalyticsProps) => void;
+export declare const useAnalytics: ({ userEvents, sessionId, sessionData }: UseAnalyticsProps) => void;
 export {};

package/dist/types/hooks/useBankConfigurationHandlers.d.ts

@@ -7,7 +7,6 @@ import type { CountryCode } from '#models/country-code';
 import type { BankVerificationVendor } from '../components/BankAccount/forms/BankVerification/types';
 import type { DropinAPIHandlers } from '../components/EmbeddedDropins/OnboardingDropinComponent/DropinComposer/types';
 interface UseBankConfigurationHandlersProps {
-    isEmbeddedDropin: boolean;
     handleGetBankVerificationVendors: DropinAPIHandlers['handleGetBankVerificationVendors'];
     bankAccountCountry: CountryCode;
     getConfiguration: ConfigurationApi['getConfiguration'];

package/dist/types/hooks/useComponentApi.d.ts

@@ -1,5 +1,4 @@
 import type { ProviderStatusRequest, ProviderStatusResponse } from '#models/api/provider-status';
-import type { TransferInstrumentReference } from '#models/api/transfer-instrument-reference';
 import type { BankVerificationErrorResponse } from '#models/api/trusted-transferInstrument';
 import type { DropinAPIHandlers } from '../components/EmbeddedDropins/OnboardingDropinComponent/DropinComposer/types';
 export type ComponentApi = {
@@ -21,11 +20,7 @@ export type ComponentApi = {
     searchAddress: Required<DropinAPIHandlers>['handleAddressSearch'];
     createTrustedTransferInstrument: Required<DropinAPIHandlers>['handleCreateTrustedTransferInstrument'];
     handleBankVerificationError(errorCode: string, errorMessage: string, state: string, metadata?: Map<string, string>): Promise<BankVerificationErrorResponse>;
-    getTransferInstruments(): Promise<TransferInstrumentReference[]>;
-    getPciStatus: Required<DropinAPIHandlers>['handleGetPciStatus'];
-    getPciTemplate: Required<DropinAPIHandlers>['handleGetPciTemplate'];
     getPciQuestionnaires: Required<DropinAPIHandlers>['handleGetPciQuestionnaires'];
-    signPci: Required<DropinAPIHandlers>['handleSignPci'];
     downloadPci: Required<DropinAPIHandlers>['handleDownloadPci'];
     getServiceAgreementStatus: Required<DropinAPIHandlers>['handleGetServiceAgreementStatus'];
     getServiceAgreementAcceptanceInfos: Required<DropinAPIHandlers>['handleGetServiceAgreementAcceptanceInfos'];

package/dist/types/hooks/useForm/types.d.ts

@@ -71,7 +71,7 @@ export type OuterFormLabels<OuterFormSchema> = {
     [Form in keyof OuterFormSchema]: InnerFormLabels<OuterFormSchema[Form]>;
 };
 export interface Form<FormSchema> extends FormState<FormSchema> {
-    setData: (key: keyof FormSchema, value: FieldValue<FormSchema>) => void;
+    setData: <Key extends keyof FormSchema>(key: Key, value: FormSchema[Key]) => void;
     setValid: (key: keyof FormSchema, value: boolean) => void;
     setErrors: (key: keyof FormSchema, value: ValidationRuleResult | null) => void;
     setFieldProblems: (fieldProblems: Record<keyof FormSchema, boolean>) => void;