@adyen/kyc-components 1.6.2 → 2.1.0

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

@@ -1,6 +1,6 @@
-import { ScenarioFieldSettings } from './scenario-fields';
-import { CountryConfig } from './country-config';
 import { AdditionalIdentityInfoSchema } from '../../components/IdentityAu/additionalIdentityInfoSchema';
+import { CountryConfig } from './country-config';
+import { ScenarioFieldSettings } from './scenario-fields';
 export declare const identityBase: {
     [key: string]: ScenarioFieldSettings;
 };

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

@@ -1,7 +1,11 @@
-import { CountryConfig } from './country-config';
-import { ValidatorRule } from '../../utils/Validator/types';
+import { BankAccountFormatType } from '../../components/internal/BankAccountFormat/types';
 import { PayoutAccountSchema } from '../../components/PayoutAccount/types';
+import { ValidatorRule } from '../../utils/validation/types';
+import { ValidationRule } from './api/get-configuration';
+import { CountryCode } from './country-code';
+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: (validationName: string) => ValidatorRule<string>;
+export declare const getValidatorRules: (validationRule: ValidationRule) => ValidatorRule<string, PayoutAccountSchema> | undefined;
+export declare const defaultPayoutAccountFormat: Partial<Record<CountryCode, BankAccountFormatType>>;

package/dist/types/core/models/scenario-fields.d.ts

@@ -1,10 +1,11 @@
-import { ValidatorRule } from '../../utils/Validator/types';
-export declare type ScenarioFields<Schema> = Record<string, {
+import { ValidatorRule } from '../../utils/validation/types';
+export type ScenarioFields<Schema> = Record<string, {
     [key in keyof Schema]: ScenarioFieldSettings<Schema[key]>;
 }>;
 export interface ScenarioFieldSettings<FieldType = unknown> {
+    masked?: boolean;
     rule?: string;
+    rules?: string[];
     verify?: string | boolean;
-    validators?: ValidatorRule<FieldType>[];
-    masked?: boolean;
+    validators?: Array<ValidatorRule<FieldType, any>>;
 }

package/dist/types/core/models/sole-prop.d.ts

@@ -1,5 +1,5 @@
-import { ScenarioFields, ScenarioFieldSettings } from './scenario-fields';
 import { CountryConfig } from './country-config';
+import { ScenarioFields, ScenarioFieldSettings } from './scenario-fields';
 export declare const solePropBase: {
     [key: string]: ScenarioFieldSettings;
 };

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

@@ -1,7 +1,25 @@
-import { ScenarioFields, ScenarioFieldSettings } from './scenario-fields';
+import { TranslationKey } from '../../language/types';
+import { TrustMemberType } from './api/trust-member-type';
+import { CountryCode } from './country-code';
 import { CountryConfig } from './country-config';
+import { ScenarioFields, ScenarioFieldSettings } from './scenario-fields';
+export declare enum TrustMemberGuidanceLabel {
+    BENEFICIARY = "beneficiary",
+    PROTECTOR = "protector",
+    TRUSTEE = "trustee",
+    SETTLOR = "settlor"
+}
+export interface TrustMemberRequirement {
+    roleTypes: readonly TrustMemberType[];
+    min: number;
+    max: number;
+    label: TrustMemberGuidanceLabel;
+}
+export declare const TRUST_COUNTRIES: CountryCode[];
 export declare const trustBase: {
     [key: string]: ScenarioFieldSettings;
 };
 export declare const fieldsPerScenario: ScenarioFields<typeof trustBase>;
 export declare const countryConfig: CountryConfig;
+export declare const DEFAULT_TRUST_MEMBER_REQUIREMENTS: readonly TrustMemberRequirement[];
+export declare const TRUST_DEFAULT_DESCRIPTIONS_MAP: Record<TrustMemberGuidanceLabel, TranslationKey>;

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

@@ -1,18 +1,27 @@
+import { PayoutAccountSchema } from '../components/PayoutAccount/types';
+import { SolePropSchema } from '../components/SoleProp/types';
+import { AnyTLDSFieldName } from '../utils/getFieldsWithExistingData';
+import { ValidatorRules } from '../utils/validation/types';
+import { BaseOuterFormProps } from './hooks/useForm';
+import { VerificationError } from './models/api/verification-error';
 import { Remediation } from './models/errors/remediation';
-import FieldConfigurations from './models/field-configurations';
+import { FieldConfigurations } from './models/field-configurations';
 import { FormList } from './models/form';
-import { SolePropSchema } from '../components/SoleProp/types';
-import { PayoutAccountSchema } from '../components/PayoutAccount/types';
 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 parseTrustScenarios<FormSchema>(scenario: any, country: any): FieldConfigurations<FormSchema>;
 export declare function parseSolePropScenarios(scenario: any, country: any): FieldConfigurations<SolePropSchema>;
-export declare function parsePayoutScenarios({ requiredFields, country, bankStatementRequirement, bankVerificationAvailable }: {
+export declare function parsePayoutScenarios({ requiredFields, country, bankVerificationAvailable, }: {
     requiredFields: any;
     country: any;
-    bankStatementRequirement: any;
     bankVerificationAvailable: any;
 }): Partial<FieldConfigurations<PayoutAccountSchema>>;
+type PropsFromConfiguration<FormSchema> = Required<Pick<BaseOuterFormProps<FormSchema>, 'verifyFields' | 'requiredFields' | 'placeholders' | 'optionalFields' | 'labels' | 'maskedFields'>> & {
+    validators: ValidatorRules<FormSchema>;
+    allFields: {
+        [Field in keyof FormSchema]: FormSchema[Field];
+    };
+};
 /**
  * function: getPropsFromScenarios
  *
@@ -53,29 +62,5 @@ export declare function parsePayoutScenarios({ requiredFields, country, bankStat
  * }
  * ```
  */
-export declare function getPropsFromConfigurations<FormSchema>(scenarioConfiguration: FieldConfigurations<FormSchema>, customRules: {}, customLabels: {}, forms: FormList, remediationActions?: Remediation[]): {
-    verifyFields: {
-        [field in keyof FormSchema]: FormSchema[field];
-    };
-    requiredFields: {
-        [field in keyof FormSchema]: FormSchema[field];
-    };
-    validators: {
-        [field in keyof FormSchema]: FormSchema[field];
-    };
-    placeholders: {
-        [field in keyof FormSchema]: FormSchema[field];
-    };
-    optionalFields: {
-        [field in keyof FormSchema]: FormSchema[field];
-    };
-    allFields: {
-        [field in keyof FormSchema]: FormSchema[field];
-    };
-    labels: {
-        [field in keyof FormSchema]: FormSchema[field];
-    };
-    maskedFields: {
-        [field in keyof FormSchema]: FormSchema[field];
-    };
-};
+export declare function getPropsFromConfigurations<FormSchema extends object>(scenarioConfiguration: FieldConfigurations<FormSchema>, 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, Locales } from '../language/types';
+import { CustomTranslations } from '../language/types';
+import { CountryCode } from './models/country-code';
 export interface CoreOptions {
     /**
      * The URL of the KYC external API. This will be used to fetch static resources and configurations.
@@ -11,10 +12,10 @@ export interface CoreOptions {
     /**
      * @defaultValue 'en-US'
      */
-    locale: Locales | string;
+    locale: string;
     /**
      * Custom translations and localizations
      */
     translations?: CustomTranslations;
-    country: string;
+    country: CountryCode;
 }

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

@@ -1,4 +1,4 @@
-interface UserEvent {
+export interface UserEvent {
     /** How many times has the event occurred */
     count?: number;
     /** Duration of the event */
@@ -7,20 +7,17 @@ interface UserEvent {
     sum?: number;
     /** Object with segments should be a flat object (arbitrary key/value pairs for event data) */
     segmentation?: {
-        [key: string]: string | number | boolean | Array<any> | null;
+        [key: string]: string | number | boolean | any[] | null;
     };
 }
 interface EventQueueItem {
     eventName: string;
     eventPayload?: UserEvent;
 }
-interface UserEventCallback {
-    (callbackFn: Array<EventQueueItem>): void;
-}
+export type UserEventCallback = (eventQueueItems: EventQueueItem[]) => void;
 declare class UserEvents {
     private readonly queue;
     private readonly subscriptions;
-    constructor();
     protected add(...args: any[]): void;
     protected notifySubscribers(): void;
     /**
@@ -61,5 +58,5 @@ declare class UserEvents {
      */
     unsubscribe(callback: UserEventCallback): void;
 }
-declare const _default: UserEvents;
-export default _default;
+export declare const userEvents: UserEvents;
+export {};

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

@@ -1,15 +1,15 @@
 import { TaskTypes } from '../components/TaskList/types';
-import LegalEntity from './models/api/legal-entity';
+import { LegalEntity } from './models/api/legal-entity';
 import { LegalEntityType } from './models/api/legal-entity-type';
-declare type BaseTrackingPayloadParams = {
-    trackingConig?: {
+type BaseTrackingPayloadParams = {
+    trackingConfig?: {
         topLevelLegalEntity: LegalEntity;
     };
     parentLegalEntity?: LegalEntity;
     legalEntity?: LegalEntity;
     task: TaskTypes;
 };
-export declare type BaseTrackingPayload = {
+export type BaseTrackingPayload = {
     task: TaskTypes;
     flow: LegalEntityType;
     topLevelLegalEntityId: string;
@@ -19,7 +19,7 @@ export declare type BaseTrackingPayload = {
     legalEntityId?: string;
     legalEntityType?: LegalEntityType;
 };
-export declare function getBaseTrackingPayload({ trackingConig, parentLegalEntity, legalEntity, task }: BaseTrackingPayloadParams): BaseTrackingPayload;
+export declare function getBaseTrackingPayload({ trackingConfig, parentLegalEntity, legalEntity, task, }: BaseTrackingPayloadParams): BaseTrackingPayload;
 /**
  * Filter data and remove unneeded fields
  * @param dataSubmitted - actual form data submitted from the frontend

package/dist/types/index.d.ts

@@ -1 +1,2 @@
-export { default } from './core/core';
+import { Core } from './core/core';
+export default Core;

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

@@ -1,11 +1,11 @@
+import { CustomTranslations, TranslationKey, Translations } from './types';
 import { GetTranslationOptions } from './utils';
-import { CustomTranslations, TranslationKey } from './types';
 declare class Language {
     private supportedLocales;
     customTranslations: CustomTranslations;
     languageCode: string;
     locale: string;
-    translations: Record<TranslationKey, string>;
+    translations: Translations;
     /**
      * Returns a translated string from a key in the current {@link Language.locale}
      * @param key - Translation key
@@ -26,10 +26,10 @@ declare class Language {
      * @param allowedLocales - allowed locales listed from the KYC external API that we can switch to
      *
      */
-    initialize({ customTranslations, locale, allowedLocales, loadingContext, clientKey }: {
+    initialize({ customTranslations, locale, allowedLocales, loadingContext, clientKey, }: {
         customTranslations?: {};
         locale?: string;
-        allowedLocales?: any[];
+        allowedLocales?: string[];
         loadingContext: any;
         clientKey: any;
     }): Promise<void>;