@adyen/kyc-components 3.61.3 → 3.62.0

package/dist/types/api/configurations/useSupportedCountries.d.ts

@@ -0,0 +1,9 @@
+import type { CountryCode } from '#core/models/country-code';
+import type { QueryOptions } from '../types';
+import type { components } from './configurations.contract';
+type SuccessResponse = components['schemas']['CountriesResponse'];
+interface CorrectSuccessReponse extends SuccessResponse {
+    countries: CountryCode[];
+}
+export declare const useSupportedCountries: (options?: QueryOptions<CorrectSuccessReponse>) => import("@tanstack/react-query").UseQueryResult<CorrectSuccessReponse, Error>;
+export {};

package/dist/types/api/configurations/useVersionConfiguration.d.ts

@@ -0,0 +1,16 @@
+import type { QueryOptions } from '../types';
+import type { components } from './configurations.contract';
+type SuccessResponse = components['schemas']['VersionResponse'];
+/**
+ * Retrieves from the backend information about the version and features/experiments
+ * linked to the legalEntityId
+ *
+ * @param id legalEntityId
+ * @param options additional options passed to Tanstack Query, eg; refetchInterval for polling
+ */
+export declare const getVersionConfiguration: (legalEntityId: string, url: string) => Promise<SuccessResponse>;
+export declare const useVersionConfiguration: (options?: QueryOptions<SuccessResponse>) => import("@tanstack/react-query").UseQueryResult<{
+    features?: string[];
+    version?: number;
+}, Error>;
+export {};

package/dist/types/api/datasets/useLegalForms.d.ts

@@ -0,0 +1,9 @@
+import type { CountryCode } from '#models/country-code';
+import type { QueryOptions } from '../types';
+import type { components } from './datasets.contract';
+export type DataSetSuccessResponse = components['schemas']['LocalizedDataSet'];
+export type DataSetsWithId = Omit<DataSetSuccessResponse, 'id' | 'name'> & {
+    id: NonNullable<components['schemas']['LocalizedDataSet']['id']>;
+    name: NonNullable<components['schemas']['LocalizedDataSet']['name']>;
+};
+export declare const useLegalForms: (countryCode: CountryCode, options?: QueryOptions<DataSetsWithId[]>) => import("@tanstack/react-query").UseQueryResult<DataSetsWithId[], Error>;

package/dist/types/api/datasets/useNaceCodes.d.ts

@@ -0,0 +1,3 @@
+import type { DataSetsWithId } from '#api/datasets/useLegalForms';
+import type { QueryOptions } from '../types';
+export declare const useNaceCodes: (options?: QueryOptions<DataSetsWithId[]>) => import("@tanstack/react-query").UseQueryResult<DataSetsWithId[], Error>;

package/dist/types/api/datasets/useSourceOfFundsTypes.d.ts

@@ -0,0 +1,3 @@
+import type { DataSetsWithId } from '#api/datasets/useLegalForms';
+import type { QueryOptions } from '../types';
+export declare const useSourceOfFundsTypes: (options?: QueryOptions<DataSetsWithId[]>) => import("@tanstack/react-query").UseQueryResult<DataSetsWithId[], Error>;

package/dist/types/api/transferInstruments/useTransferInstruments.d.ts

@@ -0,0 +1,11 @@
+import type { QueryOptions } from '../types';
+import type { components } from './transferInstruments.contract';
+export type GetTransferInstrumentResponse = components['schemas']['TransferInstrumentOverview'][];
+export type TransferInstrumentReference = components['schemas']['TransferInstrumentOverview'];
+export type TransferInstrumentReferenceWithStatusId = Omit<TransferInstrumentReference, 'transferInstrument' | 'status'> & {
+    status: NonNullable<components['schemas']['TransferInstrumentOverview']['status']>;
+    transferInstrument: Omit<components['schemas']['TransferInstrumentReferenceDto'], 'id'> & {
+        id: string;
+    };
+};
+export declare const useTransferInstruments: (options?: QueryOptions<GetTransferInstrumentResponse>) => import("@tanstack/react-query").UseQueryResult<GetTransferInstrumentResponse, Error>;

package/dist/types/api/uiAnalytics/useAnalyticsSession.d.ts

@@ -0,0 +1,16 @@
+import { type QueryOptions } from '@tanstack/react-query';
+import type { MixpanelProperty } from '#core/user-events';
+import type { components } from './analytics.contract';
+type SuccessResponse = components['schemas']['InitSessionResponse'];
+interface CorrectSuccessReponse extends SuccessResponse {
+    id: string;
+}
+export interface SessionData {
+    sdkVersion: string;
+    componentName: string;
+    userAgent: string;
+    legalEntityId: string;
+    userData?: Record<string, MixpanelProperty>;
+}
+export declare const useAnalyticsSession: (sessionData: SessionData, onboardingVersion: number | undefined, options?: QueryOptions<CorrectSuccessReponse>) => import("@tanstack/react-query").UseQueryResult<CorrectSuccessReponse, Error>;
+export {};

package/dist/types/api/uiAnalytics/usePushAnalyticEvent.d.ts

@@ -0,0 +1,17 @@
+import { type MutationOptions } from '@tanstack/react-query';
+import type { components } from './analytics.contract';
+type SuccessResponse = components['schemas']['JsonNode'];
+type Request = components['schemas']['LogAnalyticRequest'];
+export declare const usePushAnalyticEvent: (sessionId: string, options?: Omit<MutationOptions<SuccessResponse, unknown, Request>, "mutationFn">) => import("@tanstack/react-query").UseMutationResult<Record<string, never>, unknown, {
+    componentName: string;
+    eventData?: {
+        [key: string]: components["schemas"]["JsonNode"];
+    };
+    eventName: string;
+    eventType: string;
+    legalEntityId: string;
+    locale?: string;
+    sdkVersion: string;
+    userAgent: string;
+}, unknown>;
+export {};

package/dist/types/components/BankAccount/fields/BankAccountNumber/fieldConfig.d.ts

@@ -1,5 +1,4 @@
-import type { FieldMetadata } from '#core/models/country-config';
-import type { NoParams, PerCountryFieldConfig } from '#core/models/field-configurations';
+import type { FieldMetadata, NoParams, PerCountryFieldConfig } from '#core/models/field-configurations';
 import type { BankAccountNumberSchema } from './types';
 export declare const defaultFieldMetadata: FieldMetadata<BankAccountNumberSchema, 'bankAccountNumber'>;
 export declare const defaultFieldConfig: PerCountryFieldConfig<BankAccountNumberSchema, 'bankAccountNumber', NoParams>;

package/dist/types/components/BankAccount/fields/BankCode/fieldConfig.d.ts

@@ -1,5 +1,4 @@
-import type { FieldMetadata } from '#core/models/country-config';
-import type { NoParams, PerCountryFieldConfig } from '#core/models/field-configurations';
+import type { FieldMetadata, NoParams, PerCountryFieldConfig } from '#core/models/field-configurations';
 import type { BankCodeSchema } from './types';
 export declare const defaultFieldMetadata: FieldMetadata<BankCodeSchema, 'bankCode'>;
 export declare const defaultFieldConfig: PerCountryFieldConfig<BankCodeSchema, 'bankCode', NoParams>;

package/dist/types/components/BankAccount/fields/BranchCode/fieldConfig.d.ts

@@ -1,5 +1,4 @@
-import type { FieldMetadata } from '#core/models/country-config';
-import type { NoParams, PerCountryFieldConfig } from '#core/models/field-configurations';
+import type { FieldMetadata, NoParams, PerCountryFieldConfig } from '#core/models/field-configurations';
 import type { BranchCodeSchema } from './types';
 export declare const defaultFieldMetadata: FieldMetadata<BranchCodeSchema, 'branchCode'>;
 export declare const defaultFieldConfig: PerCountryFieldConfig<BranchCodeSchema, 'branchCode', NoParams>;

package/dist/types/components/BankAccount/fields/Iban/fieldConfig.d.ts

@@ -1,5 +1,4 @@
-import type { FieldMetadata } from '#core/models/country-config';
-import type { NoParams, PerCountryFieldConfig } from '#core/models/field-configurations';
+import type { FieldMetadata, NoParams, PerCountryFieldConfig } from '#core/models/field-configurations';
 import type { IbanSchema } from './types';
 export declare const defaultFieldMetadata: FieldMetadata<IbanSchema, 'iban'>;
 export declare const defaultFieldConfig: PerCountryFieldConfig<IbanSchema, 'iban', NoParams>;

package/dist/types/components/BankAccount/fields/SwiftCode/fieldConfig.d.ts

@@ -1,3 +1,3 @@
-import type { FieldMetadata } from '#core/models/country-config';
+import type { FieldMetadata } from '#models/field-configurations';
 import type { SwiftCodeSchema } from './types';
 export declare const swiftCodeFieldMetadata: FieldMetadata<SwiftCodeSchema, 'swiftCode'>;

package/dist/types/components/BankAccount/forms/BankDocument/BankDocumentRequirements.d.ts

@@ -1,10 +1,10 @@
 import './BankDocumentRequirements.scss';
+import { DocumentType } from '#core/models/api/document';
 import type { CountryCode } from '#core/models/country-code';
 import type { DocumentsModifiers } from './types';
-import { BankDocumentTypes } from './types';
 interface BankDocumentRequirementsProps {
     country: CountryCode;
-    documentType: BankDocumentTypes;
+    documentType: DocumentType;
     documentModifiers: DocumentsModifiers;
 }
 export declare const BankDocumentRequirements: ({ country, documentType, documentModifiers, }: BankDocumentRequirementsProps) => import("preact/jsx-runtime").JSX.Element;

package/dist/types/components/BankAccount/forms/BankDocument/types.d.ts

@@ -1,3 +1,4 @@
+import { DocumentType } from '#core/models/api/document';
 import type { ExistingLegalEntity } from '#core/models/api/legal-entity';
 import type { LegalEntityType } from '#core/models/api/legal-entity-type';
 import type { CountryCode } from '#core/models/country-code';
@@ -5,6 +6,7 @@ import type { FileSchema } from '#core/models/file';
 import type { BaseInnerFormProps } from '#hooks/useForm/types';
 import type { TranslationKey } from '#language/types';
 export interface BankDocumentSchema {
+    documentType?: DocumentType;
     bankStatementDocument?: FileSchema[];
     description?: string;
 }
@@ -13,13 +15,6 @@ export interface BankDocumentProps extends BaseInnerFormProps<BankDocumentSchema
     associatedLegalArrangement?: ExistingLegalEntity;
     country?: CountryCode;
 }
-export declare enum BankDocumentTypes {
-    BANK_STATEMENT = "bankStatement",
-    DEPOSIT_SLIP = "depositSlip",
-    SCREENSHOT_OF_BANK = "screenshotOfOnlineBankingEnviroment",
-    A_LETTER_FROM_YOUR_BANK = "aLetterFromYourBank",
-    CHECK = "check"
-}
 export interface DocumentsModifiers {
     rootEntityType: LegalEntityType;
     rootEntityLegalName: string;
@@ -28,7 +23,7 @@ export interface DocumentsModifiers {
     associatedEntityTradingName?: string | undefined;
 }
 export declare const bankDocumentOptions: Array<{
-    id: BankDocumentTypes;
+    id: DocumentType;
     name: TranslationKey;
 }>;
 export declare enum BankDocumentRequirement {

package/dist/types/components/BankAccount/forms/PayoutDetails/rules.d.ts

@@ -1,3 +1,10 @@
-import type { FormRules } from '#core/models/form-rules';
+import type { FormRulesParams } from '#core/models/form-rules';
 import type { PayoutDetailsSchema } from './types';
-export declare const rules: FormRules<PayoutDetailsSchema>;
+export declare const rules: ({ data, requiredFields, isExperimentEnabled, }: FormRulesParams<PayoutDetailsSchema>) => {
+    whenUsingManualVerification: () => "REQUIRED";
+    whenUsingInstantVerification: () => "REQUIRED";
+    verifiedBankAccountNumber: () => "REQUIRED";
+    bankStatementRequirement: () => "OPTIONAL" | "REQUIRED";
+    bankStatementDescription: () => "OPTIONAL";
+};
+export type PayoutRules = ReturnType<typeof rules>;

package/dist/types/components/BankAccount/mapping/mapApiDocumentToPayoutDocuments.d.ts

@@ -0,0 +1,2 @@
+import type { BankDocumentSchema } from '../forms/BankDocument/types';
+export declare const mapApiDocumentToPayoutDocuments: (entityId: string) => BankDocumentSchema;

package/dist/types/components/BankAccount/{forms/PayoutAccount/helpers → mapping}/mapPayoutAccountSchemaToApiBankAccount.d.ts

@@ -1,6 +1,6 @@
-import type { AccountIdentification } from '#core/models/api/accountIdentification';
-import type { BankAccount } from '#core/models/api/transfer-instrument';
-import type { CountryCode } from '#core/models/country-code';
-import type { PayoutAccountSchema } from '../types';
+import type { AccountIdentification } from '#models/api/accountIdentification';
+import type { BankAccount } from '#models/api/transfer-instrument';
+import type { CountryCode } from '#models/country-code';
+import type { PayoutAccountSchema } from '../forms/PayoutAccount/types';
 export declare const getAccountIdentificationFromPayoutAccountSchema: (payoutAccount: PayoutAccountSchema, bankCountry: CountryCode) => AccountIdentification;
 export declare const mapPayoutAccountSchemaToApiBankAccount: (payoutAccount: PayoutAccountSchema, bankCountry: CountryCode) => BankAccount;

package/dist/types/components/BankAccount/mapping/mapPayoutDetailsToTransferInstrument.d.ts

@@ -0,0 +1,12 @@
+import type { ExistingLegalEntity } from '#models/api/legal-entity';
+import type { TransferInstrument } from '#models/api/transfer-instrument';
+import type { PayoutDetailsSchema } from '../forms/PayoutDetails/types';
+/**
+ * Easy to use function for mapping payout account details component data to transferInstrument
+ * @param payoutDetails - Details person data
+ * @returns transferInstrument - a transferInstrument the same as found in API response
+ */
+export declare const mapPayoutDetailsToTransferInstrument: ({ data, legalEntity, }: {
+    data: PayoutDetailsSchema;
+    legalEntity: ExistingLegalEntity;
+}) => TransferInstrument;

package/dist/types/components/BankAccount/mapping/mapPayoutDocumentsToApiDocuments.d.ts

@@ -0,0 +1,3 @@
+import type { Document } from '#models/api/document';
+import type { PayoutDetailsSchema } from '../forms/PayoutDetails/types';
+export declare const mapPayoutDocumentsToApiDocuments: (data: PayoutDetailsSchema, entityId: string) => Promise<Document>;

package/dist/types/components/BankAccount/mapping/mapTransferInstrumentToPayoutAccount.d.ts

@@ -0,0 +1,8 @@
+import type { ExistingTransferInstrument } from '#models/api/transfer-instrument';
+import type { PayoutDetailsSchema } from '../forms/PayoutDetails/types';
+/**
+ * Easy to use function for mapping transferInstrument response to payout account details component data
+ * @param transferInstrument - a transferInstrument the same as found in API response
+ * @returns a Payout Details person data
+ */
+export declare const mapTransferInstrumentToPayoutAccount: (transferInstrument: ExistingTransferInstrument) => PayoutDetailsSchema;