@adyen/kyc-components
Version:
This guide assumes that you have already an account with Adyen. A legalEntity needs to be created, and you need to have a `legalEntityId` to instatiate a Component.
54 lines (53 loc) • 5.77 kB
TypeScript
import { IdentityScreeningWorkflow } from './components/Fields/IdentityScreening/IdentityScreeningWorkflow';
import { LegalName } from './components/Fields/LegalName';
import { UboTaskItem } from './components/TaskItems/UboTaskItem/UboTaskItem';
/**
* Registry for simple (single form.Field) components
*/
export declare const simpleComponentMap: {
LegalNameField: typeof LegalName;
};
/**
* Registry for compound components
* Compound components receive form + basePath + dynamic server-driven props.
* The map value must be ComponentType<any> because each compound component has its own unique
* props interface — there's no single type that covers all of them in a dynamic registry.
*/
export declare const compoundComponentMap: {
TaxInformationFieldGroup: import("react").FunctionComponent<import("react").PropsWithChildren<NoInfer<import("./components/Fields/TaxInformation/TaxInformationFieldGroup").TaxInformationFieldGroupProps> & {
form: import("@tanstack/react-form").AppFieldExtendedReactFormApi<Record<string, unknown>, any, any, import("@tanstack/react-form").FormAsyncValidateOrFn<Record<string, unknown>> | undefined, any, import("@tanstack/react-form").FormAsyncValidateOrFn<Record<string, unknown>> | undefined, any, import("@tanstack/react-form").FormAsyncValidateOrFn<Record<string, unknown>> | undefined, any, import("@tanstack/react-form").FormAsyncValidateOrFn<Record<string, unknown>> | undefined, import("@tanstack/react-form").FormAsyncValidateOrFn<Record<string, unknown>> | undefined, any, {}, {}>;
}>>;
BusinessRegistrationNumberFieldGroup: import("react").FunctionComponent<import("react").PropsWithChildren<NoInfer<import("./components/Fields/BusinessRegistrationNumber/BusinessRegistrationNumberFieldGroup").BusinessRegistrationNumberFieldGroupProps> & {
form: import("@tanstack/react-form").AppFieldExtendedReactFormApi<Record<string, unknown>, any, any, import("@tanstack/react-form").FormAsyncValidateOrFn<Record<string, unknown>> | undefined, any, import("@tanstack/react-form").FormAsyncValidateOrFn<Record<string, unknown>> | undefined, any, import("@tanstack/react-form").FormAsyncValidateOrFn<Record<string, unknown>> | undefined, any, import("@tanstack/react-form").FormAsyncValidateOrFn<Record<string, unknown>> | undefined, import("@tanstack/react-form").FormAsyncValidateOrFn<Record<string, unknown>> | undefined, any, {}, {}>;
}>>;
IndustryCodeFieldGroup: import("react").FunctionComponent<import("react").PropsWithChildren<NoInfer<import("./components/Fields/IndustryCode/IndustryCodeFieldGroup").IndustryCodeFieldGroupProps> & {
form: import("@tanstack/react-form").AppFieldExtendedReactFormApi<Record<string, unknown>, any, any, import("@tanstack/react-form").FormAsyncValidateOrFn<Record<string, unknown>> | undefined, any, import("@tanstack/react-form").FormAsyncValidateOrFn<Record<string, unknown>> | undefined, any, import("@tanstack/react-form").FormAsyncValidateOrFn<Record<string, unknown>> | undefined, any, import("@tanstack/react-form").FormAsyncValidateOrFn<Record<string, unknown>> | undefined, import("@tanstack/react-form").FormAsyncValidateOrFn<Record<string, unknown>> | undefined, any, {}, {}>;
}>>;
IdentityNumberFieldGroup: import("react").FunctionComponent<import("react").PropsWithChildren<NoInfer<import("./components/Fields/IdentityNumber/IdentityNumberFieldGroup").IdentityNumberFieldGroupProps> & {
form: import("@tanstack/react-form").AppFieldExtendedReactFormApi<Record<string, unknown>, any, any, import("@tanstack/react-form").FormAsyncValidateOrFn<Record<string, unknown>> | undefined, any, import("@tanstack/react-form").FormAsyncValidateOrFn<Record<string, unknown>> | undefined, any, import("@tanstack/react-form").FormAsyncValidateOrFn<Record<string, unknown>> | undefined, any, import("@tanstack/react-form").FormAsyncValidateOrFn<Record<string, unknown>> | undefined, import("@tanstack/react-form").FormAsyncValidateOrFn<Record<string, unknown>> | undefined, any, {}, {}>;
}>>;
};
/**
* Registry for specialized components
* Specialized components are intended to be all encompassing, handling their own
* field rendering, form steps (if applicable), data submission, etc.
*
* Naming convention: `${componentName}Workflow`
*/
export declare const specializedComponentMap: {
SourceOfFunds: ({ onComplete, onClose, resourceId, }: import("./components/Fields/SourceOfFundsWorkflow/SourceOfFundsWorkflow").SourceOfFundsWorkflowProps) => import("preact/jsx-runtime").JSX.Element;
TaxReporting: ({ onComplete, onClose, resourceId, }: import("./components/Fields/TaxReportingWorkflow/TaxReportingWorkflow").TaxReportingWorkflowProps) => import("preact/jsx-runtime").JSX.Element;
IdentityScreening: typeof IdentityScreeningWorkflow;
AcceptTermsOfService: ({ onComplete, onClose, }: import("./components/Fields/AcceptTermsOfServiceWorkflow/AcceptTermsOfServiceWorkflow").AcceptTermsOfServiceWorkflowProps) => import("preact/jsx-runtime").JSX.Element;
};
/**
* Registry for specialized components used for rendering tasks in the UI which replace the default component used to represent tasks.
*/
export declare const specializedTaskComponentMap: {
UboTaskItem: ({ status, onClick, props: { name } }: UboTaskItem) => import("preact/jsx-runtime").JSX.Element;
};
export type SimpleComponentName = keyof typeof simpleComponentMap;
export type CompoundComponentName = keyof typeof compoundComponentMap;
export type SpecializedComponentName = keyof typeof specializedComponentMap;
export type SpecializedTaskComponentName = keyof typeof specializedTaskComponentMap;
export type ComponentName = SimpleComponentName | CompoundComponentName | SpecializedComponentName | SpecializedTaskComponentName;