@adyen/kyc-components 2.23.0 → 2.24.0

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

@@ -0,0 +1,4 @@
+import { JSX } from 'preact';
+import { TaxInformationFieldProps, TaxInformationFieldSchema } from './types';
+export declare const TAX_INFORMATION_FIELD: Array<keyof TaxInformationFieldSchema>;
+export declare function TaxInformationField({ data, valid, errors, labels, helperText, readonly, handleChangeFor, country, canExempt, }: TaxInformationFieldProps): JSX.Element;

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

@@ -0,0 +1 @@
+export * from './TaxInformationField';

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

@@ -0,0 +1,13 @@
+import type { BaseFormFieldProps } from '../../../core/hooks/useForm/types';
+import type { TaxInformation } from '../../../core/models/api/organization';
+import type { CountryCode } from '../../../core/models/country-code';
+export interface TaxInformationFieldSchema {
+    taxInformation?: TaxInformation[];
+    exemptedFromTax?: boolean;
+    isUen?: boolean;
+}
+export interface TaxInformationFieldProps extends BaseFormFieldProps<TaxInformationFieldSchema> {
+    country: CountryCode;
+    canExempt: boolean;
+    isUen?: boolean;
+}

package/dist/types/components/internal/TaxInformationField/validate.d.ts

@@ -0,0 +1,4 @@
+import { CountryCode } from '../../../core/models/country-code';
+import { ValidatorRules } from '../../../utils/validation/types';
+import { TaxInformationFieldSchema } from './types';
+export declare const TaxInformationFieldValidation: (country: CountryCode) => ValidatorRules<TaxInformationFieldSchema>;

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

@@ -0,0 +1,3 @@
+import { TradingNameFieldProps, TradingNameFieldSchema } from './types';
+export declare const TRADING_NAME_FIELD: Array<keyof TradingNameFieldSchema>;
+export declare function TradingNameField({ data, valid, errors, labels, readonly, handleChangeFor, legalCompanyName, }: TradingNameFieldProps): import("preact").JSX.Element;

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

@@ -0,0 +1 @@
+export * from './TradingNameField';

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

@@ -0,0 +1,8 @@
+import type { BaseFormFieldProps } from '../../../core/hooks/useForm/types';
+export interface TradingNameFieldSchema {
+    tradingName?: string | undefined;
+    sameNameAsLegalName?: boolean;
+}
+export interface TradingNameFieldProps extends BaseFormFieldProps<TradingNameFieldSchema> {
+    legalCompanyName?: string;
+}

package/dist/types/components/internal/TradingNameField/validate.d.ts

@@ -0,0 +1,3 @@
+import { ValidatorRules } from '../../../utils/validation/types';
+import { TradingNameFieldSchema } from './types';
+export declare const TradingNameFieldValidation: () => ValidatorRules<TradingNameFieldSchema>;

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

@@ -1,5 +1,6 @@
 import type { BaseInnerFormProps } from '../../../core/hooks/useForm';
 import type { CountryCode } from '../../../core/models/country-code';
+import { TranslationKey } from '../../../language/types';
 import type { RegexValidationOptions } from '../../../utils/regex';
 export interface VatNumberSchema {
     vatNumber?: string;
@@ -8,6 +9,7 @@ export interface VatNumberSchema {
 }
 export interface VatNumberProps extends BaseInnerFormProps<VatNumberSchema> {
     country: CountryCode;
+    vatNumberType?: TranslationKey;
 }
 export interface RegexPatterns {
     [key: string]: RegExp[];

package/dist/types/components/internal/VatNumber/validate.d.ts

@@ -1,4 +1,5 @@
-import { CountryBasedValidatorRules, ValidatorRules } from '../../../utils/validation/types';
+import { CountryBasedCustomValidatorRules, CountryBasedValidatorRules, ValidatorRules } from '../../../utils/validation/types';
 import { VatNumberSchema } from './types';
 export declare const vatNumberValidationRules: ValidatorRules<VatNumberSchema>;
 export declare const countryBasedValidatorRules: CountryBasedValidatorRules<VatNumberSchema>;
+export declare const countryBasedCustomValidatorRules: CountryBasedCustomValidatorRules<VatNumberSchema>;

package/dist/types/components/internal/VatNumber/vatNumberValidation.d.ts

@@ -1,5 +1,10 @@
 import type { CountryCode } from '../../../core/models/country-code';
+import { TranslationKey } from '../../../language/types';
 export declare const validateVatNumber: (input: string | undefined | null, fallbackCountryCode?: CountryCode | null) => {
     isValid: boolean;
     message?: string;
 };
+export declare const validatePerVatNumberType: (input: string | undefined | null, vatNumberType: TranslationKey, fallbackCountryCode?: CountryCode | null) => {
+    isValid: boolean;
+    message?: string;
+};

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

@@ -0,0 +1,3 @@
+import { VatNumberFieldProps, VatNumberFieldSchema } from './types';
+export declare const VAT_NUMBER_FIELD: Array<keyof VatNumberFieldSchema>;
+export declare function VatNumberField({ data, valid, errors, labels, placeholders, readonly, handleChangeFor, canExempt, }: VatNumberFieldProps): import("preact").JSX.Element;

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

@@ -0,0 +1 @@
+export * from './VatNumberField';

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

@@ -0,0 +1,11 @@
+import type { BaseFormFieldProps } from '../../../core/hooks/useForm/types';
+import type { CountryCode } from '../../../core/models/country-code';
+export interface VatNumberFieldSchema {
+    vatNumber?: string | undefined;
+    exemptedFromVat?: boolean;
+    vatAbsenceReason?: string;
+}
+export interface VatNumberFieldProps extends BaseFormFieldProps<VatNumberFieldSchema> {
+    country: CountryCode;
+    canExempt: boolean;
+}

package/dist/types/components/internal/VatNumberField/validate.d.ts

@@ -0,0 +1,4 @@
+import { CountryCode } from '../../../core/models/country-code';
+import { ValidatorRules } from '../../../utils/validation/types';
+import { VatNumberFieldSchema } from './types';
+export declare const VatNumberFieldValidation: (country: CountryCode) => ValidatorRules<VatNumberFieldSchema>;

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

@@ -4,10 +4,12 @@ import { ComponentChildren } from 'preact';
  * This list is defined in the BE.
  */
 export declare enum ExperimentNames {
+    EnableCompanySearchFlow = "EnableCompanySearchFlow",
     OnlyAllowAlphanumericBankAccountNumbers = "OnlyAllowAlphanumericBankAccountNumbers",
     EnableNewEntryFlow = "EnableNewEntryFlow",
     AllowOrganizationSettlorWithExemptionReason = "AllowOrganizationSettlorWithExemptionReason",
-    AllowMoreRolesForMainRootTrustee = "AllowMoreRolesForMainRootTrustee"
+    AllowMoreRolesForMainRootTrustee = "AllowMoreRolesForMainRootTrustee",
+    EnableIdentityFieldTypeSelector = "EnableIdentityFieldTypeSelector"
 }
 export type ExperimentName = `${ExperimentNames}`;
 export type Experiments = {

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

@@ -1,4 +1,5 @@
 import type { CompanySchema } from '../../../components/Company/types';
+import type { CompanySearchSchema } from '../../../components/CompanySearch/types';
 import type { TrustMemberSchema } from '../../../components/Dropins/RoleAndTypeDropin/types';
 import type { IndividualSchema } from '../../../components/Individual/types';
 import type { PayoutDetailsSchema } from '../../../components/PayoutDetails/types';
@@ -46,8 +47,8 @@ export type StateModel<TLDS extends TopLevelDataSchema = TopLevelDataSchema> = {
         prevState?: State<TLDS>;
     };
 };
-export type TopLevelDataSchema = IndividualSchema | CompanySchema | PayoutDetailsSchema | TrustSchema | TrustMemberSchema | SolePropSchema;
-export type AnyFormIdOfTLDS = keyof IndividualSchema | keyof CompanySchema | keyof PayoutDetailsSchema | keyof TrustSchema | keyof TrustMemberSchema | keyof SolePropSchema;
+export type TopLevelDataSchema = IndividualSchema | CompanySchema | CompanySearchSchema | PayoutDetailsSchema | TrustSchema | TrustMemberSchema | SolePropSchema;
+export type AnyFormIdOfTLDS = keyof IndividualSchema | keyof CompanySchema | keyof CompanySearchSchema | keyof PayoutDetailsSchema | keyof TrustSchema | keyof TrustMemberSchema | keyof SolePropSchema;
 export interface State<TLDS extends TopLevelDataSchema> {
     data: TLDS;
     allData: TLDS;

package/dist/types/core/Context/StateContext/useGlobalData.d.ts

@@ -1,8 +1,10 @@
-/// <reference types="lodash" />
+import { DebouncedFunc } from 'lodash';
 import { StateSlice, TopLevelDataSchema } from './types';
 export declare function useGlobalData<TLDS extends TopLevelDataSchema>(): TLDS;
-export declare function useGlobalDataSlice<TLDS extends TopLevelDataSchema, SliceName extends keyof TLDS>(sliceId: SliceName, caller?: string): {
-    sliceData: TLDS[SliceName];
-    updateStateSlice: import("lodash").DebouncedFunc<(updatedSlice: StateSlice<TLDS, SliceName>) => void>;
-};
+interface UseGlobalDataSlice<TLDS extends TopLevelDataSchema, SliceName extends keyof TLDS, SliceSchema extends TLDS[SliceName]> {
+    sliceData: SliceSchema | undefined;
+    updateStateSlice: DebouncedFunc<(updatedSlice: StateSlice<TLDS, SliceName>) => void>;
+}
+export declare function useGlobalDataSlice<TLDS extends TopLevelDataSchema, SliceName extends keyof TLDS, SliceSchema extends TLDS[SliceName] = TLDS[SliceName]>(sliceId: SliceName, caller?: string): UseGlobalDataSlice<TLDS, SliceName, SliceSchema>;
 export declare function useResetGlobalData<TLDS extends TopLevelDataSchema>(caller?: string): () => void;
+export {};

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

@@ -1,4 +1,4 @@
 import { ComponentOptions } from '../../components';
 import { CoreOptions } from '../types';
 export declare const validateCoreOptions: (coreOptions: CoreOptions) => void;
-export declare const validateForComponent: <Name extends "payoutAccount" | "taskList" | "pci" | "individualDropin" | "companyDropin" | "trustDropin" | "soleProprietorDropin" | "createTransferInstrumentComponent" | "createIndividualComponent">(componentName: Name, options: ComponentOptions<Name>) => void;
+export declare const validateForComponent: <Name extends "payoutAccount" | "taskList" | "pci" | "individualDropin" | "companyDropin" | "companySearchDropin" | "trustDropin" | "soleProprietorDropin" | "createTransferInstrumentComponent" | "createIndividualComponent">(componentName: Name, options: ComponentOptions<Name>) => void;

package/dist/types/core/Services/componentApi/get-bankVerification-vendor.d.ts

@@ -1,4 +1,4 @@
 import { BankVerificationVendorsResponse } from '../../models/api/get-bankVerification-providers';
 import { CountryCode } from '../../models/country-code';
 import { ComponentApiRequestContext } from '../types';
-export declare const getBankVerificationVendor: (context: ComponentApiRequestContext, country: CountryCode) => Promise<BankVerificationVendorsResponse>;
+export declare const getBankVerificationVendor: (context: ComponentApiRequestContext, country: CountryCode, openBankingPartnerConfigId?: string) => Promise<BankVerificationVendorsResponse>;

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

@@ -6,6 +6,7 @@ export declare const KEYBOARD_KEYS: {
     readonly escape: "Escape";
     readonly space: " ";
     readonly tab: "Tab";
+    readonly backspace: "Backspace";
 };
 export type KeyboardKeyLabel = keyof typeof KEYBOARD_KEYS;
 export type KeyboardKey = (typeof KEYBOARD_KEYS)[KeyboardKeyLabel];

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

@@ -8,7 +8,7 @@ export declare class Core {
     };
     components: UIElement[];
     constructor(coreOptions: CoreOptions);
-    create: <Name extends "payoutAccount" | "taskList" | "pci" | "individualDropin" | "companyDropin" | "trustDropin" | "soleProprietorDropin" | "createTransferInstrumentComponent" | "createIndividualComponent">(componentName: Name, componentOptions: ComponentOptions<Name>) => UIElement;
+    create: <Name extends "payoutAccount" | "taskList" | "pci" | "individualDropin" | "companyDropin" | "companySearchDropin" | "trustDropin" | "soleProprietorDropin" | "createTransferInstrumentComponent" | "createIndividualComponent">(componentName: Name, componentOptions: ComponentOptions<Name>) => UIElement;
     /**
      * Updates global configurations, resets the internal state and remounts each element.
      * @param options - props to update

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

@@ -0,0 +1 @@
+export type HookStatus = 'loading' | 'loaded' | 'error' | 'success' | 'idle';

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

@@ -19,6 +19,6 @@ interface UseBankConfigurationHandlersProps {
  */
 export declare const useBankConfigurationHandlers: ({ isEmbeddedDropin, handleGetBankVerificationVendors, bankAccountCountry, getConfiguration, legalEntityType, capabilities, }: UseBankConfigurationHandlersProps) => {
     getConfigurationData: () => Promise<GetConfigurationResponse>;
-    getBankVerificationVendorsHandler: (data: string) => Promise<BankVerificationVendorsResponse>;
+    getBankVerificationVendorsHandler: (country: "AF" | "AX" | "AL" | "DZ" | "AS" | "AD" | "AO" | "AI" | "AQ" | "AG" | "AR" | "AM" | "AW" | "AU" | "AT" | "AZ" | "BS" | "BH" | "BD" | "BB" | "BY" | "BE" | "BZ" | "BJ" | "BM" | "BT" | "BO" | "BQ" | "BA" | "BW" | "BV" | "BR" | "IO" | "BN" | "BG" | "BF" | "BI" | "KH" | "CM" | "CA" | "CV" | "KY" | "CF" | "TD" | "CL" | "CN" | "CX" | "CC" | "CO" | "KM" | "CG" | "CD" | "CK" | "CR" | "CI" | "HR" | "CU" | "CW" | "CY" | "CZ" | "DK" | "DJ" | "DM" | "DO" | "EC" | "EG" | "SV" | "GQ" | "ER" | "EE" | "ET" | "FK" | "FO" | "FJ" | "FI" | "FR" | "GF" | "PF" | "TF" | "GA" | "GM" | "GE" | "DE" | "GH" | "GI" | "GR" | "EL" | "GL" | "GD" | "GP" | "GU" | "GT" | "GG" | "GN" | "GW" | "GY" | "HT" | "HM" | "VA" | "HN" | "HK" | "HU" | "IS" | "IN" | "ID" | "IR" | "IQ" | "IE" | "IM" | "IL" | "IT" | "JM" | "JP" | "JE" | "JO" | "KZ" | "KE" | "KI" | "KR" | "KP" | "KW" | "KG" | "LA" | "LV" | "LB" | "LS" | "LR" | "LY" | "LI" | "LT" | "LU" | "MO" | "MK" | "MG" | "MW" | "MY" | "MV" | "ML" | "MT" | "MH" | "MQ" | "MR" | "MU" | "YT" | "MX" | "FM" | "MD" | "MC" | "MN" | "ME" | "MS" | "MA" | "MZ" | "MM" | "NA" | "NR" | "NP" | "NL" | "NC" | "NZ" | "NI" | "NE" | "NG" | "NU" | "NF" | "MP" | "NO" | "OM" | "PK" | "PW" | "PS" | "PA" | "PG" | "PY" | "PE" | "PH" | "PN" | "PL" | "PT" | "PR" | "QA" | "RE" | "RO" | "RU" | "RW" | "SH" | "KN" | "LC" | "PM" | "VC" | "WS" | "SM" | "ST" | "SA" | "SN" | "RS" | "SC" | "SL" | "SG" | "SK" | "SI" | "SB" | "SO" | "ZA" | "GS" | "ES" | "LK" | "SD" | "SR" | "SJ" | "SZ" | "SE" | "CH" | "SY" | "TW" | "TJ" | "TZ" | "TH" | "TL" | "TG" | "TK" | "TO" | "TT" | "TN" | "TR" | "TM" | "TC" | "TV" | "UG" | "UA" | "AE" | "GB" | "US" | "UM" | "UY" | "UZ" | "VU" | "VE" | "VN" | "VG" | "VI" | "WF" | "EH" | "YE" | "ZM" | "ZW", openBankingPartnerConfigId?: string) => Promise<BankVerificationVendorsResponse>;
 };
 export {};

package/dist/types/core/hooks/useCompanySearch/index.d.ts

@@ -0,0 +1 @@
+export * from './useCompanySearch';

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

@@ -0,0 +1,41 @@
+import { CompanyBasicsSchema } from '../../../components/CompanyBasics/types';
+import { ValidatorMode } from '../../../utils/validation/types';
+import { AdyenKycSdkError } from '../../error';
+import { CompanyDataResponse, CompanyDeepSearchRequest, CompanyDeepSearchResponse, CompanyIndexSearchRequest, CompanyIndexSearchResponse, CompanySearchResult } from '../../models/api/company-search';
+import { CountryCode } from '../../models/country-code';
+import { ProvinceCode } from '../../models/province-code';
+import { StateCode, StateCodeUS } from '../../models/state-code';
+import { HookStatus } from '../types';
+export interface CompanySearchError extends Error {
+    status: number;
+    errorCode: string;
+    errorType: string;
+}
+export interface SearchOptions {
+    companyName: string;
+    companyCountry: CountryCode;
+    companyState: StateCodeUS;
+    resultsLimit?: number;
+    indexSearch: (request: CompanyIndexSearchRequest) => Promise<CompanyIndexSearchResponse>;
+    deepSearch: (request: CompanyDeepSearchRequest) => Promise<CompanyDeepSearchResponse>;
+}
+export interface UseCompanySearchOptions {
+    defaultData: CompanyBasicsSchema | undefined;
+    legalCompanyName: string | undefined;
+    country: CountryCode | undefined;
+    stateOrProvince: StateCode | ProvinceCode | undefined;
+    taxIdentificationNumber: string | undefined;
+    canVerify: boolean;
+    limit?: number;
+    handleChangeFor: (key: keyof CompanyBasicsSchema, mode?: ValidatorMode) => (e: any) => void;
+}
+export type UseCompanySearch = {
+    results: readonly CompanySearchResult[];
+    selectedCompanyId: string | undefined;
+    status: HookStatus;
+    error: AdyenKycSdkError | undefined;
+    verifiedCompany: CompanyDataResponse | undefined;
+    retrySearch: () => Promise<void>;
+    verify: (tin: string, company: CompanySearchResult) => Promise<void>;
+    reset: () => void;
+};

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

@@ -0,0 +1,5 @@
+import { UseCompanySearch, UseCompanySearchOptions } from './types';
+export declare const LOW_RISK_COMPANY_DATA_COMPLIANCE_WINDOW = 157766400000;
+export declare const MED_RISK_COMPANY_DATA_COMPLIANCE_WINDOW = 94694400000;
+export declare const HIGH_RISK_COMPANY_DATA_COMPLIANCE_WINDOW = 31536000000;
+export declare function useCompanySearch({ defaultData, legalCompanyName, country, stateOrProvince, taxIdentificationNumber, canVerify, limit, handleChangeFor, }: UseCompanySearchOptions): UseCompanySearch;

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

@@ -0,0 +1,32 @@
+import { CompanySearchSchema } from '../../components/CompanySearch/types';
+import { DropinAPIHandlers } from '../../components/Dropins/types';
+import { LoadingStatus } from '../../components/internal/LoaderWrapper/constants';
+import { TaskTypes } from '../../components/TaskList/types';
+import { DocumentApiUtils } from '../../utils/api/documentUtils';
+import { ExistingLegalEntity } from '../models/api/legal-entity';
+import { EntityProblems } from '../models/errors/entity-problems';
+import { FormModelWithValidity } from '../models/form';
+import { BaseTrackingPayload } from '../utils';
+export interface SubmitOptions<FormTaskSchema> {
+    data: FormTaskSchema;
+}
+export interface SubmitDocumentsOptions<FormTaskSchema> extends SubmitOptions<FormTaskSchema> {
+    legalEntity: ExistingLegalEntity;
+    currentForms: FormModelWithValidity[];
+}
+export interface FormTaskSubmitOptions {
+    task: TaskTypes;
+    forms: FormModelWithValidity[];
+    legalEntityResponse: ExistingLegalEntity;
+    problems: EntityProblems;
+    baseTrackingPayload: BaseTrackingPayload;
+    documentUtils: DocumentApiUtils;
+    setProblems: (value: EntityProblems | ((prevState: EntityProblems) => EntityProblems)) => void;
+    setLoadingStatus: (value: LoadingStatus | ((prevState: LoadingStatus) => LoadingStatus)) => void;
+    onExternalSubmit?: (company: CompanySearchSchema) => void;
+    handleUpdateLegalEntity: Required<DropinAPIHandlers>['handleUpdateLegalEntity'];
+}
+export type FormTaskSubmit<FormTaskSchema> = {
+    submit: (options: SubmitOptions<FormTaskSchema>) => Promise<void>;
+};
+export declare function useCompanySearchTaskSubmit<FormTaskSchema extends CompanySearchSchema>({ task, forms, legalEntityResponse, problems, baseTrackingPayload, documentUtils, setProblems, setLoadingStatus, onExternalSubmit, handleUpdateLegalEntity, }: FormTaskSubmitOptions): FormTaskSubmit<FormTaskSchema>;

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

@@ -1,5 +1,6 @@
 import { StateUpdater } from 'preact/hooks';
-import type { TranslationKey } from '../../../language/types';
+import type { TranslationKey, TranslationObject } from '../../../language/types';
+import { Mask } from '../../../utils/masking/maskTypes';
 import type { ValidationRuleResult, ValidatorMode, ValidatorRules } from '../../../utils/validation/types';
 import type { AnyFormIdOfTLDS } from '../../Context/StateContext/types';
 import type { CountryCode } from '../../models/country-code';
@@ -18,6 +19,10 @@ export type FieldErrors<FieldSchema> = {
 export type FieldLabels<FieldSchema> = {
     [fieldLabel in keyof FieldSchema]?: string;
 };
+export interface MaskOptions {
+    mask?: Mask;
+    transformOnType?: (val: string) => string;
+}
 export interface BaseFormFieldProps<FieldSchema> {
     data: FieldData<FieldSchema>;
     valid: FieldValid<FieldSchema>;
@@ -60,7 +65,10 @@ export interface BaseFormProps<FormSchema> {
         [Field in keyof FormSchema]: TranslationKey;
     };
     helperText?: {
-        [Field in keyof FormSchema]: TranslationKey;
+        [Field in keyof FormSchema]: TranslationKey | TranslationObject;
+    };
+    masks?: {
+        [Field in keyof FormSchema]: MaskOptions;
     };
     data?: FormSchema;
     validators?: ValidatorRules<FormSchema>;

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

@@ -0,0 +1 @@
+export declare function useIsElementVisible(element: Element | undefined): boolean;

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

@@ -1,4 +1,5 @@
 import { CountryBankVerificationVendors } from '../../components/BankVerification/types';
+import { BankAccountFormatType } from '../../components/internal/BankAccountFormat/types';
 import { LoadingStatus } from '../../components/internal/LoaderWrapper/constants';
 import { GetPayoutAccountFormatResponse } from '../models/api/get-account-format';
 import { GetConfigurationResponse, PayoutRequiredFields } from '../models/api/get-configuration';
@@ -16,10 +17,11 @@ export interface UseScenarioConfigurationOptions {
     setLoadingStatus: (loadingStatus: LoadingStatus) => void;
     getPayoutAccountFormatData?: () => Promise<GetPayoutAccountFormatResponse>;
     instantVerificationEnabled?: boolean;
+    existingBankAccountFormat?: BankAccountFormatType;
 }
 export interface ScenarioConfiguration {
     fieldConfigurations: FieldConfigurations<any> | undefined;
     requiredFields: PayoutRequiredFields | undefined;
     bankVerificationVendors: CountryBankVerificationVendors | undefined;
 }
-export declare const useScenarioConfiguration: ({ getConfigurationData, getPayoutAccountFormatData, parseConfiguration, country, instantVerificationEnabled, setLoadingStatus, }: UseScenarioConfigurationOptions) => ScenarioConfiguration;
+export declare const useScenarioConfiguration: ({ getConfigurationData, getPayoutAccountFormatData, parseConfiguration, country, instantVerificationEnabled, setLoadingStatus, existingBankAccountFormat, }: UseScenarioConfigurationOptions) => ScenarioConfiguration;

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

@@ -14,7 +14,7 @@ export interface Organization {
     stockData?: {
         marketIdentifier: string;
         stockNumber: string;
-        tickerSymbol: string;
+        tickerSymbol?: string;
     };
     taxInformation?: TaxInformation[];
     vatNumber?: string;

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

@@ -10,10 +10,17 @@ interface CompanyTypeModel {
 export declare const companyBase: {
     [key: string]: ScenarioFieldSettings;
 };
+export declare const companySearchBase: {
+    [key: string]: ScenarioFieldSettings;
+};
 export declare const taxIdBase: {
     [key: string]: ScenarioFieldSettings;
 };
+export declare const taxInformationBase: {
+    [key: string]: ScenarioFieldSettings;
+};
 export declare const companyTypes: readonly CompanyTypeModel[];
 export declare const fieldsPerScenario: ScenarioFields<typeof companyBase>;
+export declare const companySearchFieldsPerScenario: ScenarioFields<typeof companySearchBase>;
 export declare const countryConfig: CountryConfig;
 export {};

package/dist/types/core/models/country-config.d.ts

@@ -1,4 +1,5 @@
-import { TranslationKey } from '../../language/types';
+import { Translatable, TranslationKey } from '../../language/types';
+import { MaskOptions } from '../hooks/useForm';
 import { CountryCode } from './country-code';
 export type CountryConfig = Partial<Record<CountryCode, {
     [field: string]: CountryFieldConfig;
@@ -6,5 +7,6 @@ export type CountryConfig = Partial<Record<CountryCode, {
 export interface CountryFieldConfig {
     label?: TranslationKey;
     placeholder?: TranslationKey;
-    helperText?: TranslationKey;
+    helperText?: Translatable;
+    mask?: MaskOptions;
 }

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

@@ -2,6 +2,7 @@ import { TranslationKey } from '../../language/types';
 export interface FormModel {
     formId: string;
     formName: TranslationKey;
+    formDescription?: TranslationKey;
     fields?: readonly string[];
     hideNavigation?: boolean;
     hideActionBar?: boolean;

package/dist/types/core/models/province-code.d.ts

@@ -0,0 +1,47 @@
+export type ProvinceCode = ProvinceCodeAU | ProvinceCodeCA | ProvinceCodeNZ;
+export type ProvinceCodeAU = `${ProvinceCodesAU}`;
+export declare const enum ProvinceCodesAU {
+    AustralianCapitalTerritory = "ACT",
+    NewSouthWales = "NSW",
+    NorthernTerritory = "NT",
+    Queensland = "QLD",
+    SouthAustralia = "SA",
+    Tasmania = "TAS",
+    Victoria = "VIC",
+    WesternAustralia = "WA"
+}
+export type ProvinceCodeCA = `${ProvinceCodesCA}`;
+export declare const enum ProvinceCodesCA {
+    Alberta = "AB",
+    BritishColumbia = "BC",
+    Manitoba = "MB",
+    NewBrunswick = "NB",
+    NewfoundlandAndLabrador = "NL",
+    NorthwestTerritories = "NT",
+    NovaScotia = "NS",
+    Nunavut = "NU",
+    Ontario = "ON",
+    PrinceEdwardIsland = "PE",
+    Quebec = "QC",
+    Saskatchewan = "SK",
+    Yukon = "YT"
+}
+export type ProvinceCodeNZ = `${ProvinceCodesNZ}`;
+export declare const enum ProvinceCodesNZ {
+    Auckland = "AUK",
+    BayOfPlenty = "BOP",
+    Canterbury = "CAN",
+    Gisborne = "GIS",
+    HawkesBay = "HKB",
+    Marlborough = "MBH",
+    ManawatuWanganui = "MWT",
+    Nelson = "NSN",
+    Otago = "OTA",
+    SouthLand = "STL",
+    Tasman = "TAS",
+    Taranaki = "TKI",
+    Waikato = "WKO",
+    Wellington = "WGN",
+    WestCoast = "WTC",
+    ChathamIslandsTerritory = "CIT"
+}

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

@@ -4,11 +4,13 @@ import { AnyTLDSFieldName } from '../utils/getFieldsWithExistingData';
 import { ValidatorRules } from '../utils/validation/types';
 import { BaseOuterFormProps } from './hooks/useForm';
 import { VerificationError } from './models/api/verification-error';
+import { CountryCode } from './models/country-code';
 import { Remediation } from './models/errors/remediation';
 import { FieldConfigurations } from './models/field-configurations';
 import { FormList } from './models/form';
 export declare function parseIndividualScenarios<FormSchema>(scenario: any, country: any): FieldConfigurations<FormSchema>;
 export declare function parseCompanyScenarios<FormSchema>(scenario: any, country: any): FieldConfigurations<FormSchema>;
+export declare function parseCompanySearchScenarios<FormSchema>(scenario: any, country: CountryCode): FieldConfigurations<FormSchema>;
 export declare function parseTrustScenarios<FormSchema>(scenario: any, country: any): FieldConfigurations<FormSchema>;
 export declare function parseSolePropScenarios(scenario: any, country: any): FieldConfigurations<SolePropSchema>;
 export declare function parsePayoutScenarios({ requiredFields, country, bankVerificationAvailable, }: {
@@ -16,7 +18,7 @@ export declare function parsePayoutScenarios({ requiredFields, country, bankVeri
     country: any;
     bankVerificationAvailable: any;
 }): Partial<FieldConfigurations<PayoutAccountSchema>>;
-type PropsFromConfiguration<FormSchema> = Required<Pick<BaseOuterFormProps<FormSchema>, 'verifyFields' | 'requiredFields' | 'placeholders' | 'helperText' | 'optionalFields' | 'labels' | 'maskedFields'>> & {
+type PropsFromConfiguration<FormSchema> = Required<Pick<BaseOuterFormProps<FormSchema>, 'verifyFields' | 'requiredFields' | 'placeholders' | 'helperText' | 'masks' | 'optionalFields' | 'labels' | 'maskedFields'>> & {
     validators: ValidatorRules<FormSchema>;
     allFields: {
         [Field in keyof FormSchema]: FormSchema[Field];
@@ -62,5 +64,5 @@ type PropsFromConfiguration<FormSchema> = Required<Pick<BaseOuterFormProps<FormS
  * }
  * ```
  */
-export declare function getPropsFromConfigurations<FormSchema extends object>(scenarioConfiguration: FieldConfigurations<FormSchema>, forms: FormList, remediationActions: Remediation[], dataMissingErrors: VerificationError[], fieldsWithExistingData: AnyTLDSFieldName[], customRules?: {}, customLabels?: {}): PropsFromConfiguration<FormSchema>;
+export declare function getPropsFromConfigurations<FormSchema extends object>(scenarioConfiguration: FieldConfigurations<FormSchema> | undefined, forms: FormList, remediationActions: Remediation[], dataMissingErrors: VerificationError[], fieldsWithExistingData: AnyTLDSFieldName[], customRules?: {}, customLabels?: {}): PropsFromConfiguration<FormSchema>;
 export {};

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

@@ -1,4 +1,4 @@
-import { CustomTranslations, TranslationKey, Translations } from './types';
+import { CustomTranslations, Translatable, Translations } from './types';
 import { GetTranslationOptions } from './utils';
 declare class Language {
     private readonly supportedLocales;
@@ -14,11 +14,9 @@ declare class Language {
     });
     /**
      * Returns a translated string from a key in the current {@link Language.locale}
-     * @param key - Translation key
-     * @param options - Translation options
-     * @returns Translated string
+     * @returns Translated string in the user's locale
      */
-    get(key: TranslationKey, options?: GetTranslationOptions): string;
+    get(translatable: Translatable, translationOptions?: GetTranslationOptions): string;
     /**
      * Returns a localized string for a date
      * @param date - Date to be localized