@adyen/kyc-components 3.0.0-beta.8 → 3.0.0

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

@@ -5,8 +5,11 @@ export declare const getRequestUrl: (loadingContext: string, path: string, clien
 export declare const logFetchError: (message: string, level: FetchErrorLevel) => void;
 export declare const handleFetchResponse: (response: Response, responseType: XMLHttpRequestResponseType) => Promise<any>;
 export declare const isValidationErrorResponse: (response: any) => boolean;
+export declare const isSessionExpiredResponse: (response: any) => boolean;
+export declare const processValidationErrors: (response: Response) => Promise<never>;
 export declare class ValidationError extends Error {
     invalidFields: InvalidField[];
     errorCode: string;
+    sourceError: unknown;
     constructor(message: string, validationDetails: ValidationResponse);
 }

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" | "transferInstrumentComponent" | "manageTransferInstrumentComponent">(componentName: Name, componentOptions: ComponentOptions<Name>) => UIElement;
+    create: <Name extends "payoutAccount" | "taskList" | "pci" | "individualDropin" | "companyDropin" | "companySearchDropin" | "trustDropin" | "soleProprietorDropin" | "createTransferInstrumentComponent" | "createIndividualComponent" | "manageTransferInstrumentComponent">(componentName: Name, componentOptions: ComponentOptions<Name>) => UIElement;
     /**
      * Updates global configurations, resets the internal state and remounts each element.
      * @param options - props to update
@@ -23,4 +23,5 @@ export declare class Core {
      */
     remove: (component: BaseElement<object>) => this;
     private getUpdatedOptions;
+    private initializeSession;
 }

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

@@ -1,7 +1,9 @@
+import { ErrorCode } from './models/errors/error-message';
 import { RemediationCode } from './models/errors/remediation';
 import { RemediationActionContext } from './models/errors/remediation-action-context';
 /**
  * Mapping of remediation code to impacted api field path
  */
-export declare const remediationActionMappings: Partial<Record<RemediationCode, RemediationActionContext[]>>;
+export declare const invalidInputRemediationActionMappings: Partial<Record<RemediationCode, RemediationActionContext[]>>;
 export declare const dataMissingRemediationsToFieldsMap: Partial<Record<RemediationCode, string[]>>;
+export declare const DATA_MISSING_DECISION_MAKER_ERROR_CODE_MAPPING: Partial<Record<ErrorCode, RemediationCode>>;

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

@@ -0,0 +1,5 @@
+import { ExistingLegalEntity } from '../../models/api/legal-entity';
+export interface UseCanSeeIntroductionProps {
+    legalEntity: ExistingLegalEntity;
+}
+export declare const useCanSeeIntroduction: ({ legalEntity }: UseCanSeeIntroductionProps) => boolean;

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

@@ -0,0 +1,7 @@
+export interface UseHasSeenIntroductionProps {
+    legalEntityId: string;
+}
+export declare const useHasSeenIntroduction: ({ legalEntityId }: UseHasSeenIntroductionProps) => {
+    hasSeenIntroduction: boolean;
+    setHasSeenIntroduction: import("preact/hooks").StateUpdater<boolean>;
+};

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

@@ -0,0 +1,8 @@
+import { IntroductionScreens } from '../../../components/Introduction/types';
+import { TaskTypes } from '../../../components/TaskList/types';
+import { ExistingLegalEntity } from '../../models/api/legal-entity';
+export interface UseIntroductionScreensProps {
+    legalEntity: ExistingLegalEntity;
+    tasks: TaskTypes[];
+}
+export declare const useIntroductionScreens: ({ legalEntity, tasks }: UseIntroductionScreensProps) => IntroductionScreens[];

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

@@ -0,0 +1,5 @@
+import { ExistingLegalEntity } from '../../models/api/legal-entity';
+export interface UseShouldShowIntroductionProps {
+    legalEntity: ExistingLegalEntity;
+}
+export declare const useShouldShowIntroduction: ({ legalEntity, }: UseShouldShowIntroductionProps) => boolean;

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

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

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

@@ -0,0 +1,2 @@
+import { AccountHolderOption } from '../../components/internal/AccountHolder/types';
+export declare const useAccountHolder: (enableNewEntryFlow: boolean) => [accountHolder: AccountHolderOption, setAccountHolder: (accountHolder: AccountHolderOption | null) => void];

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

@@ -0,0 +1,2 @@
+import { CountryCode } from '../models/country-code';
+export declare const useAllowedCountries: () => CountryCode[] | undefined;

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

@@ -0,0 +1,3 @@
+import { AccountIdentification } from '../models/api/accountIdentification';
+import { AccountValidationResponse } from '../models/errors/validation-error';
+export declare const useAsyncAccountDetailsValidationRules: (payload: AccountIdentification, hasEmptyFields: boolean, isAccountNumberMasked: boolean) => AccountValidationResponse;

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/useBusinessSetup.d.ts

@@ -0,0 +1,22 @@
+import { AccountHolderOption } from '../../components/internal/AccountHolder/types';
+import { CompanyTypesValue } from '../models/api/company-types-value';
+import { ExistingLegalEntity } from '../models/api/legal-entity';
+import { LegalEntityType } from '../models/api/legal-entity-type';
+export declare enum BusinessType {
+    INDIVIDUAL = "individual",
+    COMPANY = "company",
+    INCORPORATED_PARTNERSHIP = "incorporatedPartnership",
+    UNINCORPORATED_PARTNERSHIP = "unincorporatedPartnership",
+    INDIVIDUAL_TRUSTEE = "individualTrustee",
+    COMPANY_TRUSTEE = "companyTrustee",
+    SOLE_PROPRIETORSHIP = "soleProprietorship"
+}
+export declare const businessTypeMapping: {
+    [key in AccountHolderOption]?: Partial<Record<LegalEntityType, BusinessType>>;
+};
+export declare const companyTypesMapping: {
+    [key in CompanyTypesValue]?: BusinessType;
+};
+export declare const useBusinessSetup: (legalEntityResponse: ExistingLegalEntity) => {
+    businessSetup: BusinessType | AccountHolderOption | null | undefined;
+};

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

@@ -0,0 +1,2 @@
+import { AccountHolderOption } from '../../components/internal/AccountHolder/types';
+export declare const useShouldShowBusinessTypeSelection: (accountHolder: AccountHolderOption) => boolean;

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,42 @@
+import type { AxiosError } from 'axios';
+import { CompanyBasicsSchema } from '../../../components/CompanyBasics/types';
+import { DropinAPIHandlers } from '../../../components/Dropins/types';
+import { ValidatorMode } from '../../../utils/validation/types';
+import { CompanyDatasetResponse, 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 SearchCompaniesOptions {
+    companyName: string;
+    companyCountry: CountryCode;
+    companyState: StateCodeUS;
+    resultsLimit?: number;
+    indexSearch: DropinAPIHandlers['handleCompanyIndexSearch'];
+    deepSearch: DropinAPIHandlers['handleCompanyDeepSearch'];
+}
+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;
+    handleCompanyIndexSearch: DropinAPIHandlers['handleCompanyIndexSearch'];
+    handleCompanyDeepSearch: DropinAPIHandlers['handleCompanyDeepSearch'];
+    handleGetCompanyDataset: DropinAPIHandlers['handleGetCompanyDataset'];
+    handleRefreshCompanyDataset: DropinAPIHandlers['handleRefreshCompanyDataset'];
+    handleVerifyTin: DropinAPIHandlers['handleVerifyTin'];
+}
+export type UseCompanySearch = {
+    results: readonly CompanySearchResult[];
+    selectedCompanyId: string | undefined;
+    status: HookStatus;
+    error: AxiosError | undefined;
+    verifiedCompany: CompanyDatasetResponse | 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 type { 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, handleCompanyIndexSearch, handleCompanyDeepSearch, handleGetCompanyDataset, handleRefreshCompanyDataset, handleVerifyTin, }: UseCompanySearchOptions): UseCompanySearch;

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

@@ -0,0 +1,33 @@
+import { StateUpdater } from 'preact/hooks';
+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: StateUpdater<EntityProblems | undefined>;
+    setLoadingStatus: StateUpdater<LoadingStatus>;
+    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/useComponentApi.d.ts

@@ -3,6 +3,8 @@ import { TransferInstrumentReference } from '../models/api/transfer-instrument-r
 import { BankVerificationErrorResponse, CreateTrustedTransferInstrumentResponse } from '../models/api/trusted-transferInstrument';
 export type ComponentApi = {
     getLegalEntity: Required<DropinAPIHandlers>['handleGetLegalEntity'];
+    updateLegalEntity: Required<DropinAPIHandlers>['handleUpdateLegalEntity'];
+    createLegalEntity: Required<DropinAPIHandlers>['handleCreateLegalEntity'];
     getTransferInstrument: Required<DropinAPIHandlers>['handleGetTransferInstrument'];
     getBankVerificationVendor: Required<DropinAPIHandlers>['handleGetBankVerificationVendors'];
     getDocument: Required<DropinAPIHandlers>['handleGetDocument'];
@@ -10,6 +12,11 @@ export type ComponentApi = {
     updateDocument: Required<DropinAPIHandlers>['handleUpdateDocument'];
     createTransferInstrument: Required<DropinAPIHandlers>['handleCreateTransferInstrument'];
     updateTransferInstrument: Required<DropinAPIHandlers>['handleUpdateTransferInstrument'];
+    deleteTransferInstrument: Required<DropinAPIHandlers>['handleDeleteTransferInstrument'];
+    getIdVerificationToken: Required<DropinAPIHandlers>['handleGetIdVerificationToken'];
+    idVerificationStartCheck: Required<DropinAPIHandlers>['handleGetIdVerificationStartCheck'];
+    getAddress: Required<DropinAPIHandlers>['handleFindAddress'];
+    searchAddress: Required<DropinAPIHandlers>['handleAddressSearch'];
     createTrustedTransferInstrument(code: string, state: string): Promise<CreateTrustedTransferInstrumentResponse>;
     handleBankVerificationError(errorCode: string, errorMessage: string, state: string, metadata?: Map<string, string>): Promise<BankVerificationErrorResponse>;
     getTransferInstruments(): Promise<TransferInstrumentReference[]>;

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

@@ -0,0 +1,18 @@
+import { TaskTypes } from '../../components/TaskList/types';
+import type { CapabilityProblems } from '../models/errors/capability-problems';
+interface UseDataMissingRemediationsProps {
+    legalEntityId: string;
+    problems: CapabilityProblems;
+}
+interface DataMissingRemediations {
+    remediationMessages: Partial<Record<TaskTypes, string | undefined>>;
+}
+/**
+ * @description A hook that parses a legal entities capability problems and maps its verification error codes to task specific remediation messages
+ *
+ * @param legalEntityId - ID of an exisiting LegalEntity
+ * @param problems - Capability problems on exisiting LegalEntity
+ * @returns A record of TaskTypes to a remediation message
+ */
+export declare function useDataMissingRemediations({ legalEntityId, problems, }: UseDataMissingRemediationsProps): DataMissingRemediations;
+export {};

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

@@ -0,0 +1 @@
+export declare const useEnableNewEntryFlow: () => boolean;

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

@@ -1,7 +1,7 @@
 import { DropinAPIHandlers } from '../../components/Dropins/types';
 import { ExistingLegalEntity } from '../models/api/legal-entity';
 interface UseExemptSettlorArgs {
-    trust: ExistingLegalEntity;
+    trust: ExistingLegalEntity | null;
     handleGetLegalEntity: NonNullable<DropinAPIHandlers['handleGetLegalEntity']>;
 }
 export declare const useExemptSettlor: ({ trust, handleGetLegalEntity, }: UseExemptSettlorArgs) => ExistingLegalEntity | undefined;

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

@@ -1,22 +1,43 @@
 import { StateUpdater } from 'preact/hooks';
-import type { TranslationKey } from '../../../language/types';
+import type { Translatable, TranslationKey } 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';
 import type { EntityProblems } from '../../models/errors/entity-problems';
 import type { FormVerificationErrors } from '../../models/errors/form-verification-errors';
 import type { FormModel } from '../../models/form';
-export type FieldValue<FormSchema> = FormSchema[keyof FormSchema];
-export interface BaseFormFieldProps<FormSchema> {
-    data: FieldValue<FormSchema>;
-    valid: boolean;
-    error: string | boolean;
-    label: string;
+export type FieldData<FieldSchema> = {
+    [fieldData in keyof FieldSchema]: FieldSchema[fieldData];
+};
+export type FieldValid<FieldSchema> = {
+    [fieldValid in keyof FieldSchema]: boolean;
+};
+export type FieldErrors<FieldSchema> = {
+    [fieldError in keyof FieldSchema]: string | boolean;
+};
+export type FieldLabels<FieldSchema> = {
+    [fieldLabel in keyof FieldSchema]?: string;
+};
+export interface MaskSettings {
+    mask?: Mask;
+    transformOnType?: (val: string) => string;
+    guidanceText?: Translatable;
+}
+export interface BaseFormFieldProps<FieldSchema> {
+    data: FieldData<FieldSchema>;
+    valid: FieldValid<FieldSchema>;
+    errors: FieldErrors<FieldSchema>;
+    labels: FieldLabels<FieldSchema>;
     readonly: boolean;
+    helperText?: Partial<Record<keyof FieldSchema, string>>;
+    placeholders?: Partial<Record<keyof FieldSchema, string>>;
     className?: string;
     classNameModifiers?: string[];
-    helperText?: string;
-    handleChangeFor: (key: keyof FormSchema, mode?: ValidatorMode) => (e: any) => void;
+    stateSliceId?: AnyFormIdOfTLDS;
+    handleChangeFor: (key: keyof FieldSchema, mode?: ValidatorMode) => (e: any) => void;
 }
+export type FieldValue<FormSchema> = FormSchema[keyof FormSchema];
 export interface FormState<FormSchema> {
     schema: Array<keyof FormSchema>;
     data: FormSchema;
@@ -45,7 +66,10 @@ export interface BaseFormProps<FormSchema> {
         [Field in keyof FormSchema]: TranslationKey;
     };
     helperText?: {
-        [Field in keyof FormSchema]: TranslationKey;
+        [Field in keyof FormSchema]: Translatable;
+    };
+    masks?: {
+        [Field in keyof FormSchema]: MaskSettings;
     };
     data?: FormSchema;
     validators?: ValidatorRules<FormSchema>;

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

@@ -9,5 +9,6 @@ export interface UseFormOptions<FormSchema> {
     shouldValidate?: boolean;
     fieldProblems?: Record<keyof FormSchema, boolean>;
     maskedFields?: (keyof FormSchema)[];
+    optionalFields?: (keyof FormSchema)[];
 }
-export declare function useForm<FormSchema>({ schema, defaultData, rules, asyncRules, fieldProblems, maskedFields, formatters, shouldValidate, }: UseFormOptions<FormSchema>): Form<FormSchema>;
+export declare function useForm<FormSchema>({ schema, defaultData, rules, asyncRules, fieldProblems, maskedFields, optionalFields, formatters, shouldValidate, }: UseFormOptions<FormSchema>): Form<FormSchema>;

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

@@ -1,2 +1,13 @@
-export declare const omitKeys: (obj: any, omit: any) => {};
+import { FieldData } from './types';
+export declare const omitKeys: (obj: any, omit: any) => any;
 export declare const addKeys: (obj: any, add: any, initialValue: any, defaultData: any, pendingData: any) => any;
+/**
+ * @description Extracts the field schema data from the form schema using the field component
+ *
+ * @param formData The data of the form using the field component
+ * @param fieldKeys The keys in the field schema
+ * @returns An object containing only the field schemas form data
+ */
+export declare function getDataByFields<FormSchema, Fields extends Array<keyof FormSchema>, FieldSchema extends {
+    [field in keyof FormSchema]: FormSchema[field];
+}>(formData: FormSchema, fieldKeys: Fields): FieldData<FieldSchema>;

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

@@ -5,20 +5,19 @@ import { FormModelWithValidity } from '../models/form';
 import { BaseTrackingPayload } from '../utils';
 export interface FormComposer {
     handleNextClick(): void;
-    handleBackClick(): void;
+    handleBackClick?(): void;
     nextButtonLabel: string;
     gotoFormByFormIndex(index: number): void;
     activeForm: FormModelWithValidity;
     shouldValidate: boolean;
     setShouldValidate: StateUpdater<boolean>;
 }
-export declare const useFormComposer: ({ problems, baseTrackingPayload, forms, formRef, submitButtonLabel, onSubmit, skipSubmit, onSkipSubmit, }: {
-    problems: EntityProblems;
+export declare const useFormComposer: ({ problems, baseTrackingPayload, forms, formRef, submitButtonLabel, externalBackClick, onSubmit, }: {
+    problems?: EntityProblems;
     baseTrackingPayload: BaseTrackingPayload;
     forms: FormModelWithValidity[];
     formRef?: any;
     submitButtonLabel?: TranslationKey;
+    externalBackClick?(): void;
     onSubmit(): void;
-    skipSubmit?: boolean;
-    onSkipSubmit?(): void;
 }) => FormComposer;

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

@@ -0,0 +1,4 @@
+/// <reference types="node" />
+type IntervalFunction = () => unknown | void;
+export declare function useInterval(callback: IntervalFunction, initialDelay?: number): NodeJS.Timeout;
+export {};

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

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

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

@@ -0,0 +1,6 @@
+import { ExistingLegalEntity } from '../models/api/legal-entity';
+import { LegalEntityType } from '../models/api/legal-entity-type';
+export interface UseLegalEntityTypeProps {
+    legalEntity: ExistingLegalEntity;
+}
+export declare const useLegalEntityType: ({ legalEntity, }: UseLegalEntityTypeProps) => LegalEntityType | undefined;

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

@@ -1,11 +1,14 @@
 import { StateUpdater } from 'preact/hooks';
 type Serializer<T> = (object: T | undefined) => string;
 type Parser<T> = (val: string) => T | undefined;
-type Setter<T> = StateUpdater<T | undefined>;
 type Options<T> = Partial<{
     serializer: Serializer<T>;
     parser: Parser<T>;
     syncData: boolean;
 }>;
-export declare function useLocalStorage<T>(key: string, defaultValue: T, options?: Options<T>): [T, Setter<T>];
+export declare const useLocalStorage: <T>(key: string, defaultValue: T, options?: Partial<{
+    serializer: Serializer<T>;
+    parser: Parser<T>;
+    syncData: boolean;
+}>) => [T, StateUpdater<T>];
 export {};

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/accountIdentification.d.ts

@@ -46,7 +46,7 @@ interface NOLocalAccountIdentification {
     type: 'noLocal';
     accountNumber: string;
 }
-interface NZLocalAccountIdentification {
+export interface NZLocalAccountIdentification {
     type: 'nzLocal';
     accountNumber: string;
 }

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

@@ -1,5 +1,6 @@
+export type PageType = 'front' | 'back';
 export interface Attachment {
     content: string;
-    pageType?: string;
-    pageName?: string;
+    pageName: string;
+    pageType?: PageType;
 }

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

@@ -1,6 +1,6 @@
 import { SupportingEntityCapability } from './supporting-entity-capability';
 import { VerificationStatus } from './verification-status';
-export type CapabilityNames = 'acceptExternalFunding' | 'acceptPspFunding' | 'acceptTransactionInRestrictedCountries' | 'acceptTransactionInRestrictedCountriesCommercial' | 'acceptTransactionInRestrictedCountriesConsumer' | 'acceptTransactionInRestrictedIndustries' | 'acceptTransactionInRestrictedIndustriesCommercial' | 'acceptTransactionInRestrictedIndustriesConsumer' | 'acquiring' | 'atmWithdrawal' | 'atmWithdrawalCommercial' | 'atmWithdrawalConsumer' | 'atmWithdrawalInRestrictedCountries' | 'atmWithdrawalInRestrictedCountriesCommercial' | 'atmWithdrawalInRestrictedCountriesConsumer' | 'authorisedPaymentInstrumentUser' | 'getGrantOffers' | 'issueBankAccount' | 'issueCard' | 'issueCardCommercial' | 'issueCardConsumer' | 'localAcceptance' | 'payout' | 'payoutToTransferInstrument' | 'processing' | 'receiveFromBalanceAccount' | 'receiveFromPlatformPayments' | 'receiveFromThirdParty' | 'receiveFromTransferInstrument' | 'receiveGrants' | 'receivePayments' | 'sendToBalanceAccount' | 'sendToThirdParty' | 'sendToTransferInstrument' | 'thirdPartyFunding' | 'useCard' | 'useCardCommercial' | 'useCardConsumer' | 'useCardInRestrictedCountries' | 'useCardInRestrictedCountriesCommercial' | 'useCardInRestrictedCountriesConsumer' | 'useCardInRestrictedIndustries' | 'useCardInRestrictedIndustriesCommercial' | 'useCardInRestrictedIndustriesConsumer' | 'withdrawFromAtm' | 'withdrawFromAtmCommercial' | 'withdrawFromAtmConsumer' | 'withdrawFromAtmInRestrictedCountries' | 'withdrawFromAtmInRestrictedCountriesCommercial' | 'withdrawFromAtmInRestrictedCountriesConsumer';
+export type CapabilityName = 'acceptExternalFunding' | 'acceptPspFunding' | 'acceptTransactionInRestrictedCountries' | 'acceptTransactionInRestrictedCountriesCommercial' | 'acceptTransactionInRestrictedCountriesConsumer' | 'acceptTransactionInRestrictedIndustries' | 'acceptTransactionInRestrictedIndustriesCommercial' | 'acceptTransactionInRestrictedIndustriesConsumer' | 'acquiring' | 'atmWithdrawal' | 'atmWithdrawalCommercial' | 'atmWithdrawalConsumer' | 'atmWithdrawalInRestrictedCountries' | 'atmWithdrawalInRestrictedCountriesCommercial' | 'atmWithdrawalInRestrictedCountriesConsumer' | 'authorisedPaymentInstrumentUser' | 'getGrantOffers' | 'issueBankAccount' | 'issueCard' | 'issueCardCommercial' | 'issueCardConsumer' | 'localAcceptance' | 'payout' | 'payoutToTransferInstrument' | 'processing' | 'receiveFromBalanceAccount' | 'receiveFromPlatformPayments' | 'receiveFromThirdParty' | 'receiveFromTransferInstrument' | 'receiveGrants' | 'receivePayments' | 'sendToBalanceAccount' | 'sendToThirdParty' | 'sendToTransferInstrument' | 'thirdPartyFunding' | 'useCard' | 'useCardCommercial' | 'useCardConsumer' | 'useCardInRestrictedCountries' | 'useCardInRestrictedCountriesCommercial' | 'useCardInRestrictedCountriesConsumer' | 'useCardInRestrictedIndustries' | 'useCardInRestrictedIndustriesCommercial' | 'useCardInRestrictedIndustriesConsumer' | 'withdrawFromAtm' | 'withdrawFromAtmCommercial' | 'withdrawFromAtmConsumer' | 'withdrawFromAtmInRestrictedCountries' | 'withdrawFromAtmInRestrictedCountriesCommercial' | 'withdrawFromAtmInRestrictedCountriesConsumer';
 export interface Capability {
     /** @description Indicates whether the capability is allowed. Adyen sets this to **true** if the verification is successful */
     allowed?: boolean;

package/dist/types/core/models/api/company-search.d.ts

@@ -18,41 +18,17 @@ export interface CompanySearchRequest {
      */
     limit?: number;
 }
-/**
- * @description Index search for company ID within kompany datastore using their current company data cache
- */
-export type CompanyIndexSearchRequest = CompanySearchRequest;
-/**
- * @description Deep search for company ID requesting new data from the external datastore (e.g. Secretary of State) that kompany uses to fetch results
- */
-export type CompanyDeepSearchRequest = CompanySearchRequest;
 export interface CompanySearchResult {
     id: string;
     name: string;
     registrationNumber: string;
     requestTime: string;
-    lastUpdate: string;
+    lastUpdate?: string;
 }
-export type CompanyIndexSearchResponse = {
+export type CompanySearchResponse = {
     results: Array<CompanySearchResult>;
 };
-export type CompanyDeepSearchResponse = {
-    results: Array<CompanySearchResult>;
-};
-export interface TinVerificationRequest {
-    /**
-     * @description Nine letter Tax Identification Number with or without hyphens
-     */
-    tin: string;
-    /**
-     * @description Company name
-     */
-    name: string;
-}
-export interface TinVerificationResponse {
-    matched: boolean;
-}
-export interface CompanyDataRequest {
+export interface CompanyDatasetRequest {
     /**
      * @description Company Id returned from index search
      */
@@ -62,19 +38,25 @@ export interface CompanyDataRequest {
      */
     country?: CountryCode;
 }
-export type GetCompanyDataRequest = CompanyDataRequest;
-export type RefreshCompanyDataRequest = CompanyDataRequest;
-export interface CompanyDataResponse {
-    id: string;
-    name: string;
+export interface CompanyDatasetResponse extends CompanySearchResult {
     country: CountryCode;
-    registrationNumber: string;
     organizationType: string;
     address: string;
-    requestTime: string;
-    lastUpdate: string;
     street?: string;
     city?: string;
     state?: StateCodeUS;
     zipcode?: string;
 }
+export interface TinVerificationRequest {
+    /**
+     * @description Nine letter Tax Identification Number with or without hyphens
+     */
+    tin: string;
+    /**
+     * @description Company name from index/deep search response
+     */
+    name: string;
+}
+export interface TinVerificationResponse {
+    matched: boolean;
+}

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

@@ -11,6 +11,7 @@ export interface Individual {
         number?: string;
         type?: string;
         cardNumber?: string;
+        expiryDate?: string;
     };
     name: {
         firstName: string;

package/dist/types/core/models/api/legal-entity.d.ts

@@ -1,5 +1,5 @@
 import type { PartialDeep } from 'type-fest';
-import { Capability, CapabilityNames } from './capability';
+import { Capability, CapabilityName } from './capability';
 import { DocumentDetail } from './documentDetail';
 import { Individual } from './individual';
 import { LegalEntityAssociation } from './legal-entity-association';
@@ -18,7 +18,7 @@ export interface LegalEntity {
     soleProprietorship?: SoleProprietor;
     trust?: Trust;
     type?: LegalEntityType;
-    capabilities?: Partial<Record<CapabilityNames, Capability>>;
+    capabilities?: Partial<Record<CapabilityName, Capability>>;
     problems?: Problem[];
     transferInstruments?: TransferInstrumentOverview[];
 }
@@ -27,4 +27,5 @@ export type PatchLegalEntity = Omit<PartialDeep<LegalEntity, {
 }>, 'id'>;
 export interface ExistingLegalEntity extends LegalEntity {
     id: string;
+    type: LegalEntityType;
 }