@adyen/kyc-components 2.2.3 → 2.2.5

package/dist/types/utils/trust-util.d.ts

@@ -0,0 +1,44 @@
+import { SelectItem } from '../components/internal/FormFields/Select/types';
+import { ExistingLegalEntity, LegalEntity } from '../core/models/api/legal-entity';
+import { LegalEntityAssociation } from '../core/models/api/legal-entity-association';
+import { UndefinedBeneficiaryInfo } from '../core/models/api/trust';
+import { TrustMemberType } from '../core/models/api/trust-member-type';
+import { CapabilityProblems } from '../core/models/errors/capability-problems';
+import { EntityProblems } from '../core/models/errors/entity-problems';
+import { TrustMemberGuidanceLabel } from '../core/models/trust';
+import Language from '../language';
+import { TranslationKey } from '../language/types';
+export declare const isPartOfTrustFromLegalEntity: (legalEntity: LegalEntity) => boolean;
+type TrustMemberAssociation = {
+    id: string;
+    type: TrustMemberType;
+};
+export interface TrustMemberWithAllTypes {
+    id: string;
+    types: TrustMemberType[];
+}
+export declare const getOwnTrustMembers: (trustEntity: LegalEntity) => LegalEntityAssociation[];
+export declare const getRootTrusteeInfo: (rootLegalEntity: ExistingLegalEntity) => TrustMemberAssociation;
+export declare const getUndefinedBeneficiaries: (legalEntity: LegalEntity) => UndefinedBeneficiaryInfo[];
+export declare const getAllTrustMembers: (rootLegalEntity: ExistingLegalEntity, trustEntity: LegalEntity) => TrustMemberAssociation[];
+export declare const getOwnTrustMembersLegalEntityIds: (legalEntity: LegalEntity) => string[];
+export declare const getOwnTrustLegalEntityIdAsArray: (legalEntity: LegalEntity) => string[];
+export declare const getOwnTrustProblems: (legalEntity: LegalEntity, capabilityProblems: CapabilityProblems) => EntityProblems | undefined;
+export declare const hasMinRequiredTrustMemberCount: (legalEntity: LegalEntity) => boolean;
+export declare const makeSelectItemForTrustRole: (role: TrustMemberType, i18n: Language) => SelectItem;
+export declare const getTrustMemberTagColor: (trustMemberType: TrustMemberType) => string;
+export declare const getTrustMemberName: (trustMemberType: TrustMemberType) => "SST" | "RFC" | "CNPJ" | "CVR-nummer" | "close" | "individual" | "payoutAccount" | "payinAccount" | "firstName" | "lastName" | "country" | "street" | "houseNumber" | "houseNumberOptional" | "houseNumberOrName" | "postalCode" | "city" | "cityTown" | "state" | "provinceOrTerritory" | "selectProvinceOrTerritory" | "zipCode" | "apartmentSuite" | "apartmentSuiteOptional" | "phoneNumber" | "email" | "birthdate" | "code" | "invalidEmail" | "pleaseEnterAPhoneNumberPrefixedWithCountryCode" | "invalidPhoneNumber" | "birthDate" | "idNumber" | "selectState" | "selectCountry" | "search" | "noOptionsFound" | "SSNFormatUS" | "SSNFormatUS9Digits" | "SINFormatCA" | "invalidFormat" | "fieldIsRequired" | "tooManyFiles" | "duplicatedFiles" | "unsupportedFiletype" | "maximumFileSizeExceeded" | "personalDetails" | "invalidBirthDate" | "address" | "contactDetails" | "uploadDocument" | "individualDetails" | "socialSecurityNumber" | "socialSecurityNumber9Digits" | "codiceFiscale" | "personnummer" | "dni" | "peselNumber" | "detCentralePersonregister" | "codNumericPersonal" | "cadastroDePessoasFisicas" | "invalidFormatExpects" | "invalidFormatForAuPassportNumber" | "invalidFormatForAuDriversLicenseNumber" | "invalidFormatForAuDriversLicenseCardNumber" | "invalidFormatForAuProofOfIdentityCardNumber" | "invalidFormatIdentityNumberBR" | "invalidFormatIdentityNumberDK" | "invalidFormatIdentityNumberCA" | "invalidFormatIdentityNumberIT" | "invalidFormatIdentityNumberPL" | "invalidFormatIdentityNumberRO" | "invalidFormatIdentityNumberES" | "invalidFormatIdentityNumberSE" | "invalidFormatIdentityNumberUS" | "invalidFormatIdentityNumberUS9" | "invalidFormatIdentityNumberSG" | "residencyCountry" | "stateOrProvince" | "selectStateOrProvince" | "dragYourFilesHereOr" | "browse" | "supports" | "complete" | "summary" | "selectDocument" | "passport" | "passportNumber" | "id" | "driversLicense" | "issuerState" | "licenseNumber" | "licenseCardNumber" | "documents" | "idDocument" | "documentType" | "frontPage" | "backPage" | "fileName" | "nationality" | "dateOfIncorporation" | "proofOfNationality" | "uploadDocumentForSsn" | "uploadDocumentForNric" | "operationalAddressHeader" | "operationalAddressHeaderDescription" | "operationalAddressIsSame" | "operationalAddressIsSameItemName" | "operationalAddressIsNotSameItemName" | "verifyPrefilledInfoIsCorrect" | "legalStructureHeader" | "whatTypeOfCompanyDoYouHave" | "privateCompanyTitle" | "privateCompanyDescription" | "publicCompanyTitle" | "publicCompanyDescription" | "incorporatedPartnershipTitle" | "incorporatedPartnershipDescription" | "nonProfitOrCharitableOrgTitle" | "nonProfitOrCharitableOrgDescription" | "governmentalOrganizationTitle" | "governmentalOrganizationDescription" | "associationIncorporatedTitle" | "associationIncorporatedDescription" | "jobTitle" | "legalStructure" | "entityType" | "registrationDetails" | "registeredAddress" | "registrationAddress" | "registeredAddressHeaderDescription" | "registeredAddressHeaderDescription__US" | "registeredAddressTrustHeaderDescription" | "operationalAddress" | "provideRegistrationDetails" | "companyStructure" | "providePersonalAddress" | "provideContactDetails" | "correctErrorsResubmit" | "registrationDocument" | "taxDocument" | "companyDetails" | "invalidRegistrationNumber" | "tradingName" | "chamberOfCommerceRegistrationNumber" | "taxId" | "exemptedFromTax" | "doNotHaveTaxIdNumber" | "doNotHaveFirmenbuchnummer" | "doNotHaveOrganisationsnummer" | "doNotHaveYTunnus" | "doNotHaveLtRegistrationNumber" | "doNotHaveLuRegistrationNumber" | "doNotHaveChRegistrationNumber" | "doNotHaveHandelsregisternummer" | "doNotHaveRegonKrsNumber" | "taxIdAbsenceReason" | "vatNumberExempted" | "vatNumberAbsenceReason" | "belowTaxThreshold" | "industryExemption" | "validationPleaseEnterAValidRegistrationNumber" | "validationPleaseEnterAValidRegistrationNumberWithFormat" | "validationPleaseEnterAValidVatNumber" | "validationPleaseEnterAValidVatNumberWithFormat" | "validationPleaseEnterAValidTaxIdNumberWithFormat" | "aValidAbnShouldBe11Digits" | "aValidUenOrGstShouldBe9To10Characters" | "validationPleaseEnterAValidUen" | "validationPleaseEnterAValidIban" | "yourIbanShouldBeginWith_" | "validation8Or11Characters" | "validationCharacters" | "validationDigitsBetween" | "validationDigits" | "enterValidRegistrationNumber" | "stockExchangeMIC" | "stockExchangeMICHelper" | "stockISINHelper" | "stockISIN" | "validationPleaseEnterAValidMarketIdentifier" | "validationPleaseEnterAValidStockISIN" | "shareholderDocument" | "role" | "selectAllTheRolesThatThisDecisionMakerHolds" | "selectTheApplicableRoles" | "back" | "next" | "submit" | "submitSuccessful" | "submitFailed" | "submitReviewOfYourData" | "completeReview" | "submitReview" | "pleaseNote" | "byClickingSubmitReview" | "nameAndCountry" | "companyCountry" | "legalCompanyName" | "legalCompanyNameHelper" | "legalCompanyNameHelper__AU" | "legalCompanyNameHelper__US" | "legalCompanyNameHelper__SG" | "accountDetailsDescription" | "provideDetails" | "payoutAccountsDescription" | "payoutAccountsDescriptionReview" | "payinAccountsDescription" | "addExtraPayoutAccount" | "addExtraPayinAccount" | "payoutDetails" | "payinDetails" | "addPayoutAccount" | "addPayinAccount" | "failedToFetchPayoutAccount" | "failedToDeletePayoutAccount" | "transferInstrumentDeleted" | "toCompleteProcessReviewAndSignOfficialDocumentation" | "sign" | "signer" | "selectSigner" | "pciSignedSuccessfully" | "pciSignFailed" | "byClickingSignIAcknowledgeAndAgree" | "acknowledgePciRequirements" | "basedOnTheAboveSignatory" | "failedToGetPciStatus" | "failedToGetPciTemplate" | "failedToGetPciTemplateInSelectedLanguageFallbackToEn" | "failedToDownloadPci" | "signServiceAgreement" | "signedDocuments" | "paymentProcessingTerms" | "accountHolderTerms" | "capitalUserTerms" | "businessAccountTerms" | "cardUserTerms" | "franchiseesTAndCs" | "pciDssQuestionnaire" | "serviceAgreementSignedSuccessfully" | "serviceAgreementSignFailed" | "failedToGetServiceAgreementStatus" | "failedToGetServiceAgreement" | "failedToGetServiceAgreementInSelectedLanguageFallbackToEn" | "iHaveReadAndIAcceptTheseTerms" | "verified" | "signed" | "invalidRole" | "unableToVerifyTheIdNumber" | "download" | "accountHolder" | "accountHolderDescriptionCompany" | "accountHolderDescriptionIndividual" | "accountHolderDescriptionSoleProp" | "bankAccountToHaveSameNameAsTrust" | "bankCountry" | "bankAccountCountry" | "currency" | "currencyCode" | "currencyPlaceholder" | "bankAccountNumber" | "iban" | "swiftCode" | "bic" | "bsbNumber" | "branchCode" | "transitNumber" | "listitemVoidedChequeBankLetterBankStatementOnline" | "instructionNumber" | "institutionNumber" | "sortCode" | "bankCityTown" | "clearingCode" | "bankCode" | "bankName" | "achRoutingNumber" | "decisionMaker" | "decisionMakerDescription" | "owner" | "ownerDescription" | "controllingPerson" | "controllingPersonDescription" | "signatory" | "signatoryDescription" | "director" | "directorDescription" | "provideAllDirectors" | "addDecisionMaker" | "decisionMakers" | "goToOverview" | "saveAndGoToOverview" | "pleaseEnsureTheFollowing" | "edit" | "remove" | "toggleAssociationMenu" | "editDecisionMakerDetails" | "removeDecisionMaker" | "verifyDecisionMakerDetails" | "goToMenu" | "confirm" | "goToDecisionMakers" | "theSubmitWasSuccessful" | "thereWasAnErrorTryAgain" | "proofOfIdentityCard" | "proofOfIdentityCardNumber" | "proofOfResidence" | "proofOfNationalId" | "backToTaskList" | "proofOfResidenceDocumentTypeLabel" | "utilityBill" | "governmentIssuedCorrespondence" | "taxationDocument" | "extractFromMunicipalPersonalRecordsDatabase" | "salarySlip" | "mortgageStatement" | "certificateOfVoterRegistration" | "businessAccountDetailsDescription" | "businessAccountDetailsDescriptionReview" | "documentAddressedToName" | "showAddressStateCountry" | "dateOnDocumentNoOlderThanXMonths" | "fullDocumentVisibleWithReadableText" | "documentCannotBeDamaged" | "verify" | "add" | "idUploadDocumentSubtitle" | "documentNotExpiredOrDamaged" | "weAccept" | "includeFrontAndBack" | "fullDocumentVisible" | "imagesInColor" | "datePlaceholder" | "onlyEnterNormalCharacters" | "verifyCompanyInfoIsUpToDate" | "failedToFetchRelevantDocuments" | "failedToFetchRelevantAccounts" | "processing" | "inReview" | "unsuccessful" | "invalidDateOfBirth" | "invalidDateOfIncorporation" | "successfullyUpdatedDetails" | "failedToUpdateDetails" | "successfullyVerifiedIdNumber" | "failedFetchingDecisionMaker" | "fileUpload" | "bankStatement" | "bankStatementOptional" | "bankAccountVerification" | "bankStatementDocument" | "bankStatementDocumentTypeLabel" | "requirements" | "accountHolderNameMatchesWithBusinessOrTradingName" | "accountNumberOrIbanVisible" | "accountNumberVisible" | "routingNumberVisible" | "showsCountryOfBankAccount" | "hasToBeOfficialDocumentFromBank" | "ifDocumentMoreThan12months" | "whyDoINeedToFillInThisInformation" | "reasonForFillingCompanyRegistrationDetails" | "reasonForFillingCompanyAddressDetails" | "reasonForFillingIndividualPersonalDetails" | "reasonForFillingIndividualAddressDetails" | "reasonForFillingPayoutAccountDetails" | "reasonForFillingPayoutDetails" | "whatIsTheDifferenceBetweenTheseRoles" | "ownerGuideDescription" | "controllingPersonGuideDescription" | "signatoryGuideDescription" | "directorGuideDescription" | "someoneAppointedToManageACompanysBusinessAndAffairs" | "whatIfDocumentIsMoreThan12MonthsOld" | "descriptionHelper" | "depositTicket" | "screenshotOfOnlineBankingEnviroment" | "officialEmailOrALetterFromYourBank" | "cheques" | "releveDidentiteBancaire" | "successFullyRemovedDecisionMaker" | "failedToRemoveDecisionMaker" | "chamberOfCommerceExtract" | "taxNumberCorporateNumber" | "companyLegalName" | "companyName" | "companyType" | "taxReferenceNumber" | "companyProfile" | "companyNumber" | "RfcDocument" | "companyRegistrationDocument" | "businessName" | "typeOfCompany" | "typeOfIdentity" | "typeOfIdentitySubtitle" | "businessNumber" | "doingBusinessAs" | "taxIdentificationNumber" | "irdDocument" | "irdNumber" | "australianBusinessNumberAbn" | "australianBusinessNumberAcn" | "enterpriseNumber" | "NIP" | "NIPC" | "numerodeIVA" | "NIF" | "uen" | "nric" | "NIFdeIVA" | "partitaIVA" | "organisationsnummer" | "momsregistreringsnummer" | "codiceFiscaleOrCCIAA" | "UST-ID" | "DIC" | "ICO" | "USt-IdNr" | "handelsregisternummer" | "NumeroDeTVA" | "organisasjonsnummer" | "skattenummer" | "verificationErrorMessage" | "remediationFormErrorMessage" | "youHaveUnsavedChanges" | "areYouSureToLeave" | "cancel" | "save&Leave" | "leave" | "taxIdNumber" | "companyRegistrationNumber" | "euVatNumber" | "vatNumber" | "regonKrsNumber" | "registrationNumber" | "registrationNumber__nonProfit__FR" | "registrationNumber__FR" | "registrationNumber__PR" | "charityNumber" | "firmenbuchnummer" | "firmenbuchnummerOrZVR" | "stepsX/YofForm" | "no" | "yes" | "informationCouldNotBeSubmitted" | "fieldHasUnsupportedFormats" | "updateTheInformation" | "andResubmit" | "someFieldsHaveUnsupportedFormatedUpdateInfoAndResubmit" | "trustType" | "cashManagementTrust" | "corporateUnitTrust" | "deceasedEstate" | "discretionaryInvestmentTrust" | "discretionaryServicesManagementTrust" | "discretionaryTradingTrust" | "firstHomeSaverAccountsTrust" | "fixedTrust" | "fixedUnitTrust" | "hybridTrust" | "listedPublicUnitTrust" | "otherTrust" | "pooledSuperannuationTrust" | "publicTradingTrust" | "unlistedPublicUnitTrust" | "countryOfEstablishment" | "nameOfTrustAgreement" | "typeOfTrustAgreement" | "weFoundTheFollowingIssues" | "reviewTheInformationBelowAndCorrectMistakesOr" | "uploadTheRequestedDocuments" | "uploadTheFollowingDocuments" | "uploadDocumentAndDocument" | "thenResubmit" | "isTrustOperationAddressSame" | "trustDetails" | "trustDetailsDescription" | "trustDocumentDescription" | "nameOfTrust" | "fullLegalNamesOfAnyAppointers" | "dateDeedWasSigned" | "settlerDetailsIncl" | "trusteeDetailsIncl" | "beneficiariesDetailsIncl" | "trustMembers" | "trustMembersDescription" | "trustee" | "obligatory" | "requiredIfApplicable" | "provideAtLeastOneSettlor" | "provideAtLeastOneProtector" | "provideAllBeneficiaries" | "provideAllTrustees" | "provideAllControllingPersons" | "settlorGuideDescription" | "trusteeGuideDescription" | "protectorGuideDescription" | "beneficiaryGuideDescription" | "uboThroughControlGuideDescription" | "uboThroughOwnershipGuideDescription" | "beneficiary" | "protector" | "settlor" | "ultimateBeneficialOwner" | "addTrustMember" | "personAppointmentUnderTrustInstrument" | "legalOwnerOfProperty" | "entityEstablishingTrust" | "entityOwning25OrMoreOfTrust" | "controllingPersonOfTrust" | "failedToFetchTrustDetails" | "failedToFetchTrustMemberDetails" | "failedToFetchLegalEntityDetails" | "editTrustMember" | "removeTrustMember" | "successFullyRemovedTrustMember" | "failedToRemoveTrustMember" | "editEntityDetails" | "editOwnerOfTrustMember" | "editEntityOwner" | "addEntityOwner" | "addOwnerToTrustMember" | "whatTypeOfYourMembersEntity" | "naturalPersonTitle" | "naturalPersonDescription" | "businessEntityTitle" | "businessEntityDescription" | "roleAndEntityType" | "helpUsVerifyCompany" | "providePersonalDetailsOfOwner" | "memberDetails" | "good" | "notCutOff" | "notBlurry" | "notExpired" | "noGlare" | "selectDocumentType" | "registrationDocumentSubTitle" | "documentIssuedByGovernmentAuthority" | "uploadTaxationDocument" | "containsNameOfCompany" | "documentShowsTaxIdOfCompany" | "issuedByTheTaxAuthority" | "providePageWithPhotoAndCode" | "constitutionalDocument" | "solePropDetails" | "soleProprietorDetails" | "selectAccountHolder" | "nameOfBankAccountHolder" | "myName" | "myNameDescription" | "mySoleTraderName" | "mySoleTraderNameDescription" | "theCompanyIWorkFor" | "theCompanyIWorkForDescription" | "aTrust" | "aTrustDescription" | "aPartnership" | "aPartnershipDescription" | "anAssociation" | "anAssociationDescription" | "legalNameOfSoleProprietor" | "failedToFetchSoleProp" | "uniqueIdentificationCode" | "identifikacionenNomerDDS" | "MBS" | "PDVIdBrojOIB" | "cyRegistrationNumber" | "arithmosEngraphes" | "momsregistreringsnummerOrStamregister" | "registrikood" | "kaibemaksukohustuslaseNumber" | "YTunnus" | "arvonlisaveronumeroMervardesskattenummer" | "GEMI-number" | "grTaxId" | "huRegistrationNumber" | "huTaxId" | "valueAddedTaxIdentificationNumber" | "lvRegistrationNumber" | "lvTaxId" | "ltRegistrationNumber" | "mcRegistrationNumberSoleProp" | "PVMmoketojoKodas" | "luRegistrationNumber" | "numeroDIdentificationALATaxe" | "numarOrdineRegistrulComertului" | "codulDeIdentificareFiscala" | "skRegistrationNumber" | "skTaxId" | "siRegistrationNumber" | "siTaxId" | "chRegistrationNumber" | "mcRegistrationNumber" | "liRegistrationNumber" | "Mehrwertsteuernummer" | "Xdigits" | "upToXdigits" | "XtoYdigits" | "XorYdigits" | "Xcharacters" | "XtoYcharacters" | "XdigitsAndYcharacters" | "1character5to7digits" | "1char8digits" | "1charXalphanumeric" | "2characters6or7digits" | "7or8or12characters" | "2digits1to3letters5digits" | "Cchar5digits" | "characterPlusXToYDigitsWithOptionalSpace" | "cop1to8digits" | "8digitsOptional-" | "provideAllOwners" | "ifNoOwnersSpecifyControllingPersons" | "provideAtLeastOneSignatory" | "provideOneControllingPerson" | "textToVerifyAccount" | "theBankAccountHolderMustHaveTheSameNameAsYourCompany_" | "theBankAccountHolderMustBeInYourName_" | "weDoNotYetSupportInstantVerificationForBankAccountsIn_" | "youCanOnlyUseABankAccountInTheCountryWhereYourCompanyIsRegistered" | "youCanOnlyUseABankAccountInTheCountryWhereYouLive" | "mobileApplication" | "onOnlineBankingEnvironment" | "dontHaveAccessOnlineBanking" | "confirmPayoutManually" | "noteManualTakesLonger" | "accountVerification" | "verifyWith" | "documentVerification" | "youHaveSuccessfullyProvidedTheIdDocument" | "submitIdDocumentsAgain" | "madeAMistake" | "canNotCompleteInstantVerification" | "goBackAndProvideDocumentScans" | "identityCard" | "uploadOneOfTheFollowing" | "documentIssuedWithinLastYear" | "learnMore" | "doingBusinessAsNameFiling" | "taxFiling" | "continueAsCompany" | "continueAsIndividual" | "indicatedPayoutToCompany" | "continueSigningUpAsCompany" | "indicatedPayoutToPersonalAccount" | "continueSigningUpAsIndividual" | "continue" | "noGoBack" | "continueCompany" | "continueIndividual" | "addManually" | "searchAddress" | "startTypingTheAddress" | "addresses" | "loading" | "businessIncorporationNumber" | "doNotHaveBusinessIncorporationNumber" | "socialInsuranceNumber" | "verificationMethod" | "verifyViaMobileBankAppOrBankWebsite" | "provideAccountDetailsAndUploadBankStatement" | "instantVerificationDescription" | "couldNotEstablishBankConnection" | "sorryAnErrorOccurred" | "ranIntoTechnicalError" | "failedInitializeInstantVerification" | "couldNotCompleteAccountCheck" | "tryAgainOrManualAccountDetails" | "manualVerificationDescription" | "poweredBy" | "youSuccessfullyVerifiedAccount" | "verifyBankAccountAgain" | "accountName" | "mayTakeAFewHoursOrDays" | "instant" | "isOurTrustedPartnerHelpingSpeedUpSetup" | "howDoesVerificationWithOurPartnerWorks" | "selectTheBankToReceivePayouts" | "bankAccountFormat" | "ibanFormat" | "localFormat" | "payoutInOnly_" | "payoutIn_Or_" | "loginIntoYourBankingEnvironment" | "yourBankWillConfirmYourAccountDetails" | "adyenWillOnlyGetTemporaryAccess" | "instantVerification" | "xCharactersLeft" | "goBack" | "businessRegistrationNumber" | "doNotHaveBusinessNumber" | "UEN/GST" | "IRD/GST" | "enterNameExactlyAsAppearInID" | "enterLastNameExactlyAsAppearInID" | "takePhotoOriginalDocumentWithPhone" | "instantIDVerificationDescription" | "manualIDVerificationDescription" | "uploadScanOriginalIDDocument" | "takesLonger" | "howVerificationWithOnfidoWork" | "onfidoIsOurTrustedPartner" | "usePhoneToScanId" | "onfidoWillGiveFeedbackInRealTime" | "theIdCheckWillBeAutomaticallyValidated" | "adyenKeepsDataAsLongAsLegallyRequired" | "requiresSignatory" | "requiresDecisionMakers" | "definedBeneficiary" | "definedBeneficiaryDescription" | "undefinedBeneficiary" | "undefinedBeneficiaryDescription" | "description" | "descriptionOptional" | "describeWhoIsABeneficiaryInYourTrust" | "descriptionUndefinedBeneficiary" | "undefinedBeneficiaryGuideDescription" | "identityCardBack" | "identityCardFront" | "drivinglicenseBack" | "drivinglicenseFront" | "passportPhotoPage" | "residencePermitBack" | "residencePermitFront" | "manualUpload" | "errorMessage_1_10" | "errorMessage_1_11" | "errorMessage_1_12" | "errorMessage_1_30" | "errorMessage_1_31" | "errorMessage_1_32" | "errorMessage_1_33" | "errorMessage_1_34" | "errorMessage_1_35" | "errorMessage_1_36" | "errorMessage_1_37" | "errorMessage_1_38" | "errorMessage_1_39" | "errorMessage_1_40" | "errorMessage_1_41" | "errorMessage_1_50" | "errorMessage_1_51" | "errorMessage_1_52" | "errorMessage_1_53" | "errorMessage_1_54" | "errorMessage_1_55" | "errorMessage_1_56" | "errorMessage_1_57" | "errorMessage_1_60" | "errorMessage_1_61" | "errorMessage_1_62" | "errorMessage_1_70" | "errorMessage_1_71" | "errorMessage_1_72" | "errorMessage_1_73" | "errorMessage_1_74" | "errorMessage_1_75" | "errorMessage_1_76" | "errorMessage_1_1000" | "errorMessage_1_1001" | "errorMessage_1_1002" | "errorMessage_1_1003" | "errorMessage_1_3000" | "errorMessage_1_3001" | "errorMessage_1_3002" | "errorMessage_1_3003" | "errorMessage_1_3004" | "errorMessage_1_3005" | "errorMessage_1_3006" | "errorMessage_1_3007" | "errorMessage_1_3008" | "errorMessage_1_3009" | "errorMessage_1_3010" | "errorMessage_1_3011" | "errorMessage_1_3012" | "errorMessage_1_3013" | "errorMessage_1_3014" | "errorMessage_1_3015" | "errorMessage_1_3016" | "errorMessage_1_3017" | "errorMessage_1_3018" | "errorMessage_1_3019" | "errorMessage_1_3020" | "errorMessage_1_3021" | "errorMessage_1_3022" | "errorMessage_1_3023" | "errorMessage_1_3024" | "errorMessage_1_3025" | "errorMessage_1_3026" | "errorMessage_1_3027" | "errorMessage_1_3028" | "errorMessage_1_3029" | "errorMessage_1_3030" | "errorMessage_1_3031" | "errorMessage_1_3032" | "errorMessage_1_3033" | "errorMessage_1_3034" | "errorMessage_1_3035" | "errorMessage_1_3036" | "errorMessage_1_3037" | "errorMessage_1_3038" | "errorMessage_1_3039" | "errorMessage_1_3040" | "errorMessage_1_3041" | "errorMessage_1_3042" | "errorMessage_1_3043" | "errorMessage_1_3044" | "errorMessage_1_3045" | "errorMessage_1_3046" | "errorMessage_1_3047" | "errorMessage_1_3048" | "errorMessage_1_3049" | "errorMessage_1_3050" | "errorMessage_1_3051" | "errorMessage_1_3062" | "errorMessage_1_5000" | "errorMessage_1_5001" | "errorMessage_1_5002" | "errorMessage_1_5003" | "errorMessage_1_5004" | "errorMessage_1_5005" | "errorMessage_1_5006" | "errorMessage_1_5007" | "errorMessage_1_5008" | "errorMessage_1_5009" | "errorMessage_1_5010" | "errorMessage_1_5011" | "errorMessage_1_5012" | "errorMessage_1_5013" | "errorMessage_1_5014" | "errorMessage_1_5015" | "errorMessage_1_5016" | "errorMessage_1_5017" | "errorMessage_1_5018" | "errorMessage_1_5019" | "errorMessage_1_5020" | "errorMessage_1_5021" | "errorMessage_1_5022" | "errorMessage_1_5023" | "errorMessage_1_5024" | "errorMessage_1_5025" | "errorMessage_1_5026" | "errorMessage_1_5027" | "errorMessage_1_5028" | "errorMessage_1_5029" | "errorMessage_1_5030" | "errorMessage_1_5031" | "errorMessage_1_5032" | "errorMessage_1_5033" | "errorMessage_1_5034" | "errorMessage_1_5035" | "errorMessage_1_5036" | "errorMessage_1_5037" | "errorMessage_1_5038" | "errorMessage_1_5039" | "errorMessage_1_5040" | "errorMessage_1_5041" | "errorMessage_1_5042" | "errorMessage_1_5043" | "errorMessage_1_5044" | "errorMessage_1_5045" | "errorMessage_1_5046" | "errorMessage_1_5047" | "errorMessage_1_5048" | "errorMessage_1_5049" | "errorMessage_1_5050" | "errorMessage_1_5051" | "errorMessage_1_5052" | "errorMessage_1_5053" | "errorMessage_1_6000" | "errorMessage_1_6001" | "errorMessage_1_6002" | "errorMessage_1_6003" | "errorMessage_1_6004" | "errorMessage_1_6005" | "errorMessage_1_6006" | "errorMessage_1_6007" | "errorMessage_1_6008" | "errorMessage_1_6009" | "errorMessage_1_6010" | "errorMessage_1_6011" | "errorMessage_1_6022" | "errorMessage_1_6027" | "errorMessage_1_7000" | "errorMessage_1_7001" | "errorMessage_1_7002" | "errorMessage_1_7003" | "errorMessage_1_7004" | "errorMessage_1_7005" | "errorMessage_1_7006" | "errorMessage_1_7007" | "errorMessage_1_7008" | "errorMessage_1_7009" | "errorMessage_1_7010" | "errorMessage_1_7011" | "errorMessage_1_7012" | "errorMessage_1_7013" | "errorMessage_1_7014" | "errorMessage_1_7015" | "errorMessage_1_7016" | "errorMessage_1_7017" | "errorMessage_1_7018" | "errorMessage_1_7019" | "errorMessage_1_7020" | "errorMessage_1_7021" | "errorMessage_1_7022" | "errorMessage_3_10" | "remediationMessage_1_100" | "remediationMessage_1_101" | "remediationMessage_1_102" | "remediationMessage_1_300" | "remediationMessage_1_301" | "remediationMessage_1_302" | "remediationMessage_1_303" | "remediationMessage_1_304" | "remediationMessage_1_305" | "remediationMessage_1_306" | "remediationMessage_1_307" | "remediationMessage_1_308" | "remediationMessage_1_309" | "remediationMessage_1_316" | "remediationMessage_1_500" | "remediationMessage_1_501" | "remediationMessage_1_502" | "remediationMessage_1_503" | "remediationMessage_1_504" | "remediationMessage_1_505" | "remediationMessage_1_506" | "remediationMessage_1_507" | "remediationMessage_1_508" | "remediationMessage_1_509" | "remediationMessage_1_510" | "remediationMessage_1_511" | "remediationMessage_1_600" | "remediationMessage_1_601" | "remediationMessage_1_602" | "remediationMessage_1_700" | "remediationMessage_1_701" | "remediationMessage_1_702" | "remediationMessage_1_703" | "remediationMessage_1_704" | "remediationMessage_1_705" | "remediationMessage_2_106" | "remediationMessage_2_107" | "remediationMessage_2_108" | "remediationMessage_2_117" | "remediationMessage_2_118" | "remediationMessage_2_158" | "remediationMessage_3_100" | "sameNameAsLegalName" | "whereCanIFindTheseNumbersOnMyDriversLicense" | "whereToFindNumbersOnDriversLicense" | "iStillCantFindIt" | "patriotActDisclosureTitle" | "patriotActDisclosureTextParagraph1" | "patriotActDisclosureTextParagraph2" | "trusteeAsTrusteeForTrust" | "trustDeed" | "trustInstrument" | "makeSureToHaveYourTrustDeed" | "maintenanceModeMessage" | "individualTrusteeDetails" | "companyTrusteeDetails" | "trusteePersonalDetails" | "byProceedingToTheNextStepYouConfirmThatYouHaveReadUnderstandAndAcceptTheTerms" | "whichOfTheseApplyToTheSettlor" | "contributionBelowThreshold" | "professionalServiceProvider" | "deceased" | "noneOfTheAbove" | "settlorExemptionReason" | "otherInformation";
+export interface TrustMemberRole {
+    id: TrustMemberType;
+    name: TranslationKey;
+    description: TranslationKey;
+    className: string;
+}
+export interface TrustMemberRoleGuidance {
+    id: TrustMemberGuidanceLabel;
+    name: TranslationKey;
+    className: string;
+}
+export declare const trustMemberRoles: Record<TrustMemberType, TrustMemberRole>;
+export declare const trustMemberGuidanceRoles: Record<TrustMemberGuidanceLabel, TrustMemberRoleGuidance>;
+export {};

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

@@ -0,0 +1,2 @@
+import { ForwardedRef } from 'preact/compat';
+export declare const useForwardedRef: <T>(forwardedRef: ForwardedRef<T>) => import("preact/compat").MutableRefObject<T>;

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

@@ -0,0 +1,9 @@
+import { StateUpdater } from 'preact/hooks';
+type UseStateFromPropParams<T> = {
+    initialValue?: T;
+    passedValue: T;
+    skipUpdate?: boolean;
+};
+type UseStateFromPropReturn<T> = [T | undefined, StateUpdater<T | undefined>];
+declare const useStateFromProp: <T>({ initialValue, passedValue, skipUpdate, }: UseStateFromPropParams<T>) => UseStateFromPropReturn<T>;
+export default useStateFromProp;

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

@@ -0,0 +1 @@
+export default function uuidv4(): string;

package/dist/types/utils/validation/ValidationResult.d.ts

@@ -0,0 +1,13 @@
+import type { ValidationRuleResult } from './types';
+export declare class ValidationResult {
+    private validationResults;
+    constructor(results: ValidationRuleResult[]);
+    /** Checks if all validation rules have passed */
+    get isValid(): boolean;
+    /** Checks if any validation rule returned an error */
+    hasError(): boolean;
+    /** Returns the first validation result that returned an error */
+    getError(): ValidationRuleResult;
+    /** Returns all validation results that returned an error */
+    getAllErrors(): ValidationRuleResult[];
+}

package/dist/types/utils/validation/commonValidators.d.ts

@@ -0,0 +1,3 @@
+import { ValidatorRule } from './types';
+export declare const isTruthyValidator: ValidatorRule<unknown, unknown>;
+export declare const isNotEmptyValidator: ValidatorRule<unknown, unknown>;

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

@@ -0,0 +1,61 @@
+import { FormState } from '../../core/hooks/useForm/types';
+import { CountryCode } from '../../core/models/country-code';
+import { TranslationKey } from '../../language/types';
+export type Ruleset = {
+    [key: string]: any;
+};
+export type CountryRuleset = {
+    [country: string]: Ruleset;
+};
+export type ErrorMessageObject = {
+    translationKey: TranslationKey;
+    translationObject: {
+        values: Record<string, string>;
+    };
+};
+export type ErrorMessage = TranslationKey | ErrorMessageObject;
+export type ValidatorMode = 'blur' | 'input';
+export interface FieldData<FormSchema> {
+    key: keyof FormSchema;
+    value: FormSchema[keyof FormSchema] | null;
+    mode?: ValidatorMode;
+}
+export interface FieldContext<FormSchema> {
+    state: FormState<FormSchema>;
+}
+export interface Format<ValueType> {
+    formatter?: (value: ValueType | null, context?: FieldContext<any>) => ValueType | null;
+    format?: string;
+    maxlength?: number;
+}
+export type FormatRules<FormSchema> = Partial<{
+    [field in keyof FormSchema]: Format<FormSchema[field]>;
+}>;
+export type CountryFormatRules<FormSchema> = Partial<Record<CountryCode, FormatRules<FormSchema>>>;
+export interface ValidationRuleResult {
+    isValid: boolean;
+    errorMessage?: TranslationKey | ErrorMessageObject;
+    hasError: boolean;
+}
+export type ValidationRuleResults<Schema> = Partial<Record<keyof Schema, ValidationRuleResult | null>>;
+export interface ValidatorRule<ValueType, FormSchema> {
+    validate: (value: ValueType | null, context?: FieldContext<FormSchema>) => boolean;
+    errorMessage?: ErrorMessage | ((value: ValueType | null, context?: FieldContext<FormSchema>) => ErrorMessage | undefined);
+    modes: readonly ValidatorMode[];
+}
+export interface AsyncValidatorRule<ValueType, FormSchema> {
+    asyncValidate: (value: ValueType | null, context?: FieldContext<FormSchema>) => Promise<boolean>;
+    errorMessage?: ErrorMessage | ((value: ValueType | null, context: FieldContext<FormSchema>) => ErrorMessage);
+    modes: readonly ValidatorMode[];
+}
+export type FieldValidatorRule<ValueType, FormSchema> = ValidatorRule<ValueType, FormSchema> | AsyncValidatorRule<ValueType, FormSchema>;
+export type ValidatorRules<FormSchema> = Partial<{
+    [field in keyof FormSchema]: ValidatorRule<FormSchema[field], FormSchema> | ValidatorRule<FormSchema[field], FormSchema>[];
+}>;
+export type AsyncValidatorRules<FormSchema> = Partial<{
+    [field in keyof FormSchema]: AsyncValidatorRule<FormSchema[field], FormSchema>;
+}>;
+export type FieldValidatorRules<FormSchema> = ValidatorRules<FormSchema> | AsyncValidatorRules<FormSchema>;
+export type CountryBasedValidatorRules<FormSchema> = {
+    [country: string]: ValidatorRules<FormSchema>;
+};

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

@@ -0,0 +1,27 @@
+import { CountryBasedValidatorRules, CountryRuleset, Ruleset, ValidatorRules } from './validation/types';
+export declare const getMaxLengthByFormatRuleset: (formattingRules: any, field: any) => any;
+export declare const getMaxLengthByFieldAndCountry: (formattingRules: any, field: any, country: any, ignoreIfFormatterExists: any) => any;
+/**
+ * Merges country based and default validation rule sets.
+ * Only merges rule-sets for a field if the "modes" for the validation rule are different.
+ * Avoids having duplicate rules for the same fields (both of which would still be run)
+ */
+export declare function mergeCountryBasedValidators<FormSchema>(defaultValidatorsObj: ValidatorRules<FormSchema>, countryBasedValidators: CountryBasedValidatorRules<FormSchema>, country: string): ValidatorRules<FormSchema>;
+/**
+ * Merges any 2 set of objects where we have a base set of rules and then a country based set with values for particular fields
+ * Example - formatting rules e.g. for SSN in IdentityNumberComponent
+ */
+export declare function mergeCountryBasedRulesets(defaultRuleset: Ruleset, countryBasedRuleset: CountryRuleset, country: string): Ruleset;
+export declare const isUndefinedOrNull: (input: any) => boolean;
+export declare const isEmpty: <T>(input: T) => input is null;
+export declare const isString: (input: any) => input is string;
+export declare const hasText: (input: any) => boolean;
+export declare const SPECIAL_CHARS = "?\\-\\+_=!@#$%^&*(){}~<>\\[\\]\\/\\\\";
+export declare const getFormattingRegEx: (specChars: string, flags?: string) => RegExp;
+export declare const getValidatingRegEx: (specChars: string, exclude: boolean) => RegExp;
+export declare const CHARACTER_PATTERNS: {
+    [key: string]: RegExp;
+};
+export declare const exactLength: (input: string | undefined | null, length: number) => boolean;
+export declare const lengthIsBetween: (input: string | undefined | null, minLength: number, maxLength: number) => boolean;
+export declare const trimValWithOneSpace: (val: string) => string;

package/dist/types/utils/verification/helpers/verify-id-number-helper.d.ts

@@ -0,0 +1,3 @@
+import { VerifyIdNumberResponse } from '../../../core/models/api/verify-id-number';
+import { IdVerificationStatus } from '../../../core/models/id-verification-status';
+export declare const verifyIdNumberHelper: (idRtnData: VerifyIdNumberResponse) => IdVerificationStatus | undefined;

package/dist/types/utils/verification/verificationUtils.d.ts

@@ -0,0 +1,7 @@
+import { IdFormState, PersonalDetailsSchema } from '../../components/PersonalDetails/types';
+import { CountryCode } from '../../core/models/country-code';
+import { IdVerificationStatus } from '../../core/models/id-verification-status';
+export declare function useVerification(fieldsToVerify: any[], country: CountryCode): {
+    hasFieldsToVerify: boolean;
+    verifyFields: (formState: Pick<IdFormState, 'data'>, savedData: PersonalDetailsSchema) => Promise<IdVerificationStatus[]>;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adyen/kyc-components",
-  "version": "2.2.3",
+  "version": "2.2.5",
   "description": "",
   "license": "MIT",
   "files": [