@adyen/kyc-components 3.0.0-beta.9 → 3.0.1

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

@@ -1,25 +1,25 @@
-import { CountryCode } from '../country-code';
-import { Address } from './address';
-import { CompanyTypesValue } from './company-types-value';
-import { Phone } from './phone';
+import type { CountryCode } from '../country-code';
+import type { Address } from './address';
+import type { CompanyTypesValue } from './company-types-value';
+import type { Phone } from './phone';
 export interface Organization {
+    legalName: string;
+    registeredAddress: Address;
     description?: string;
     doingBusinessAs?: string;
     email?: string;
-    legalName: string;
     phone?: Phone;
     principalPlaceOfBusiness?: Address;
-    registeredAddress: Address;
     registrationNumber?: string;
     stockData?: {
         marketIdentifier: string;
         stockNumber: string;
-        tickerSymbol: string;
+        tickerSymbol?: string;
     };
     taxInformation?: TaxInformation[];
     vatNumber?: string;
     vatAbsenceReason?: VatAbsenceReason;
-    type?: CompanyTypesValue;
+    type?: CompanyTypesValue | '';
 }
 export declare const vatAbsenceReasons: readonly ["industryExemption", "belowTaxThreshold"];
 export type VatAbsenceReason = (typeof vatAbsenceReasons)[number];

package/dist/types/core/models/api/transfer-instrument-reference.d.ts

@@ -1,9 +1,9 @@
-import { VerificationStatus } from './verification-status';
+import { TaskStatus } from '../../../components/TaskList/types';
 export interface TransferInstrumentReference {
     transferInstrument: {
         accountIdentifier: string;
         id: string;
         trustedSource: boolean;
     };
-    verificationStatus: VerificationStatus;
+    status: keyof typeof TaskStatus;
 }

package/dist/types/core/models/api/transfer-instrument.d.ts

@@ -1,6 +1,8 @@
 import { CountryCode } from '../country-code';
 import { AccountIdentification } from './accountIdentification';
+import { Capability, CapabilityName } from './capability';
 import { DocumentDetail } from './documentDetail';
+import { Problem } from './problem';
 export interface BankAccount {
     accountIdentification: AccountIdentification;
     countryCode: CountryCode;
@@ -18,9 +20,12 @@ export interface TransferInstrument {
     bankAccount: BankAccount;
     type: TransferInstrumentType;
     documentDetails?: DocumentDetail[];
+    capabilities?: Partial<Record<CapabilityName, Capability>>;
+    problems?: Problem[];
 }
 export interface ExistingTransferInstrument extends TransferInstrument {
     id: string;
+    type: TransferInstrumentType;
 }
 export declare enum TransferInstrumentType {
     BANK_ACCOUNT = "bankAccount",

package/dist/types/core/models/api/trusted-transferInstrument.d.ts

@@ -1,5 +1,6 @@
 import { AccountVerificationResponse } from '../../../components/BankVerification/types';
 export type CreateTrustedTransferInstrumentResponse = {
+    verificationReference: string;
     accounts: AccountVerificationResponse[];
 };
 export type BankVerificationErrorResponse = {

package/dist/types/core/models/api/verification-error.d.ts

@@ -1,5 +1,5 @@
 import { ErrorCode } from '../errors/error-message';
-import { CapabilityNames } from './capability';
+import { CapabilityName } from './capability';
 import { RemediatingAction } from './remediating-action';
 export declare enum VerificationErrorType {
     DATA_MISSING = "dataMissing",
@@ -9,7 +9,7 @@ export declare enum VerificationErrorType {
     REJECTED = "rejected"
 }
 export interface VerificationError {
-    capabilities?: CapabilityNames[];
+    capabilities?: CapabilityName[];
     code: ErrorCode;
     message: string;
     type: VerificationErrorType;

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-code.d.ts

@@ -1,3 +1,4 @@
+export type CountryCode = `${CountryCodes}`;
 export declare const enum CountryCodes {
     Afghanistan = "AF",
     AlandIslands = "AX",
@@ -246,4 +247,3 @@ export declare const enum CountryCodes {
     Zambia = "ZM",
     Zimbabwe = "ZW"
 }
-export type CountryCode = `${CountryCodes}`;

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

@@ -1,10 +1,14 @@
-import { TranslationKey } from '../../language/types';
+import { Translatable, TranslationKey } from '../../language/types';
+import { ValidatorRule } from '../../utils/validation/types';
+import { MaskSettings } from '../hooks/useForm';
 import { CountryCode } from './country-code';
-export type CountryConfig = Partial<Record<CountryCode, {
-    [field: string]: CountryFieldConfig;
+export type CountryConfig<Options = unknown> = Partial<Record<CountryCode, {
+    [field: string]: FieldMetadata<Record<string, string>, string> | ((options: Options) => FieldMetadata<Record<string, string>, string>);
 }>>;
-export interface CountryFieldConfig {
+export interface FieldMetadata<FormSchema, FieldName extends keyof FormSchema> {
     label?: TranslationKey;
     placeholder?: TranslationKey;
-    helperText?: TranslationKey;
+    helperText?: Translatable;
+    mask?: MaskSettings;
+    validators?: ValidatorRule<FormSchema[FieldName], FormSchema> | ValidatorRule<FormSchema[FieldName], FormSchema>[];
 }

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

@@ -1,4 +1,5 @@
 export declare enum Currency {
+    AED = "AED",
     AUD = "AUD",
     BGN = "BGN",
     BRL = "BRL",
@@ -9,13 +10,15 @@ export declare enum Currency {
     EUR = "EUR",
     GBP = "GBP",
     HKD = "HKD",
-    HUF = "HUF",
     HRK = "HRK",
-    PLN = "PLN",
+    HUF = "HUF",
+    MXN = "MXN",
+    MYR = "MYR",
     NOK = "NOK",
     NZD = "NZD",
+    PLN = "PLN",
     RON = "RON",
-    SGD = "SGD",
     SEK = "SEK",
+    SGD = "SGD",
     USD = "USD"
 }

package/dist/types/core/models/decision-maker.d.ts

@@ -46,7 +46,7 @@ export interface DecisionMakerRequirement {
     min: number;
     max: number;
 }
-export declare const getDecisionMakerRequirements: (country: string) => readonly DecisionMakerRequirement[];
+export declare const getDecisionMakerRequirements: (country: string | undefined) => readonly DecisionMakerRequirement[];
 export declare function getAvailableDecisionMakerRoleTypes(country: string): {
     roleType: DecisionMakerType;
     min: number;

package/dist/types/core/models/errors/entity-problems.d.ts

@@ -5,12 +5,12 @@ import { VerificationError } from '../api/verification-error';
 import { FormVerificationErrors } from './form-verification-errors';
 import { Remediation, RemediationCode } from './remediation';
 export type EntityProblems = {
-    verificationErrors: {
+    verificationErrors?: {
         [formId: string]: FormVerificationErrors;
     };
-    remediationActions: Partial<Record<RemediationCode, Remediation>>;
-    status: TaskStatus;
-    missingData: VerificationError[];
+    remediationActions?: Partial<Record<RemediationCode, Remediation>>;
+    status?: TaskStatus;
+    missingData?: VerificationError[];
     validationErrors?: {
         [formId: string]: {
             [fieldName: string]: boolean;

package/dist/types/core/models/errors/validation-error.d.ts

@@ -18,3 +18,7 @@ export interface ValidationResponse {
     errorCode: string;
     valid: boolean;
 }
+export interface AccountValidationResponse {
+    invalidFields: InvalidField[];
+    valid: boolean;
+}

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

@@ -1,8 +1,10 @@
-import { CountryFieldConfig } from './country-config';
+import { PerCountry } from '../../utils/perCountry';
+import { FieldMetadata } from './country-config';
 import { ScenarioFieldSettings } from './scenario-fields';
-interface FieldConfiguration<FieldType> extends ScenarioFieldSettings<FieldType>, CountryFieldConfig {
-}
+type FieldConfiguration<FieldType> = ScenarioFieldSettings<FieldType>;
 export type FieldConfigurations<FormSchema> = {
     [key in keyof FormSchema]: FieldConfiguration<FormSchema[key]>;
 };
+export type PerCountryFieldConfig<FormSchema, FieldName extends keyof FormSchema, Params extends object> = PerCountry<FieldMetadata<FormSchema, FieldName> | ((params: Params) => FieldMetadata<FormSchema, FieldName>)>;
+export declare const resolveFieldMetadata: <FormSchema, FieldName extends keyof FormSchema, Params extends object>(countryEntry: FieldMetadata<FormSchema, FieldName> | ((params: Params) => FieldMetadata<FormSchema, FieldName>), params: Params, defaultMetadata: FieldMetadata<FormSchema, FieldName>) => FieldMetadata<FormSchema, FieldName>;
 export {};

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

@@ -0,0 +1,8 @@
+interface ExistingFile {
+    name: string;
+    existing: true;
+}
+export type FileSchema = ExistingFile | File;
+export declare const isExistingFile: (file: FileSchema) => file is ExistingFile;
+export declare const isNewlyUploadedFile: (file: FileSchema) => file is File;
+export {};

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

@@ -9,6 +9,7 @@ export interface FormRulesParams<TLDS extends TopLevelDataSchema> {
     taskType: TaskTypes;
     isSettingEnabled?: (setting: SettingName) => boolean;
     requiredFields?: Partial<PayoutRequiredFields>;
+    isEmbeddedDropin?: boolean;
 }
 export type FormRules<TLDS extends TopLevelDataSchema> = (params: FormRulesParams<TLDS>) => {
     [ruleName: string]: () => string | boolean | undefined;

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

@@ -15,7 +15,9 @@ export declare const nationality: {
     [key: string]: ScenarioFieldSettings;
 };
 export declare const fieldsPerScenario: {
-    L0: any;
+    L0: {
+        [key: string]: ScenarioFieldSettings<unknown>;
+    };
     L1: {
         [key: string]: ScenarioFieldSettings<unknown>;
     };

package/dist/types/core/models/payout-account.d.ts

@@ -7,5 +7,5 @@ import { CountryConfig } from './country-config';
 export declare const payoutFieldsMapping: Record<string, keyof PayoutAccountSchema>;
 export declare const maskedPayoutFields: Array<keyof PayoutAccountSchema>;
 export declare const countryConfig: CountryConfig;
-export declare const getValidatorRules: (validationRule: ValidationRule) => ValidatorRule<string, PayoutAccountSchema> | undefined;
+export declare const getValidatorRules: (validationRule: ValidationRule, country: CountryCode) => ValidatorRule<string, PayoutAccountSchema> | undefined;
 export declare const defaultPayoutAccountFormat: Partial<Record<CountryCode, BankAccountFormatType>>;

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/models/state-code.d.ts

@@ -1,3 +1,35 @@
+export type StateCode = StateCodeUS | StateCodeBR;
+export type StateCodeBR = `${StateCodesBR}`;
+export declare const enum StateCodesBR {
+    Acre = "AC",
+    Alagoas = "AL",
+    Amazonas = "AM",
+    Amapá = "AP",
+    Bahia = "BA",
+    Ceará = " CE",
+    DistritoFederal = "DF",
+    EspíritoSanto = "ES",
+    Goiás = "GO",
+    Maranhão = "MA",
+    MinasGerais = "MG",
+    MatoGrossodoSul = "MS",
+    MatoGrosso = "MT",
+    Pará = "PA",
+    Paraíba = "PB",
+    Pernambuco = "PE",
+    Piauí = "PI",
+    Paraná = "PR",
+    RiodeJaneiro = "RJ",
+    RioGrandedoNorte = "RN",
+    Rondônia = "RO",
+    Roraima = "RR",
+    RioGrandedoSul = "RS",
+    SantaCatarina = "SC",
+    Sergipe = "SE",
+    SãoPaulo = "SP",
+    Tocantins = "TO"
+}
+export type StateCodeUS = `${StateCodesUS}`;
 export declare const enum StateCodesUS {
     Alabama = "AL",
     Alaska = "AK",
@@ -51,4 +83,3 @@ export declare const enum StateCodesUS {
     Wisconsin = "WI",
     Wyoming = "WY"
 }
-export type StateCodeUS = `${StateCodesUS}`;

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

@@ -1,4 +1,5 @@
 import { CustomTranslations } from '../language/types';
+import { TokenResponse } from './Context/AuthContext/AuthProvider';
 import { CountryCode } from './models/country-code';
 export interface CoreOptions {
     /**
@@ -22,5 +23,5 @@ export interface CoreOptions {
      * JWT token used for embedded Dropin authentication
      */
     sdkToken?: string;
-    refreshToken?: string;
+    getSdkToken?(): Promise<TokenResponse>;
 }

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

@@ -10,15 +10,16 @@ export interface UserEvent {
         [key: string]: string | number | boolean | any[] | null;
     };
 }
-interface EventQueueItem {
-    eventName: string;
-    eventPayload?: UserEvent;
-}
-export type UserEventCallback = (eventQueueItems: EventQueueItem[]) => void;
+type UserEventWithKey = UserEvent & {
+    key: string;
+};
+type EventType = 'track_pageview' | 'add_event' | 'start_event' | 'end_event';
+type EventQueueItem = [EventType, string | UserEventWithKey];
+export type UserEventCallback = (eventQueueItem: EventQueueItem) => void;
 declare class UserEvents {
     private readonly queue;
     private readonly subscriptions;
-    protected add(...args: any[]): void;
+    protected add(...args: EventQueueItem[]): void;
     protected notifySubscribers(): void;
     /**
      * Adds an analytics event. Optionally can include a payload.

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