@taxbit/react-sdk 0.4.2 → 0.4.3

package/dist/src/contexts/FormUI/useFormUI.d.ts

@@ -32,6 +32,7 @@ export declare const useFormUI: () => {
     setValue: (key: TaxDocumentationKey, value: string | undefined) => void;
     isErrorFree: boolean;
     showErrors: boolean;
+    showErrorsForField: (key: TaxDocumentationKey) => boolean | undefined;
     exposeErrors: () => void;
     hideErrors: () => void;
     getRequiredLocalPrompt: (key: TaxDocumentationKey) => string;

package/dist/src/contexts/FormUI/useFormUIContext.d.ts

@@ -23,6 +23,7 @@ export declare const useFormUIContext: () => {
     setValue: (key: keyof import("../../types").AccountHolderContactData | keyof import("../../types").AccountHolderTaxData | keyof import("../../types").AccountHolderClassificationData | keyof import("../../types").RegardedOwnerContactData | keyof import("../../types").RegardedOwnerClassificationData | keyof import("../../types").RegardedOwnerTaxData | keyof import("../../types").SummaryData | keyof import("../../types").CalculatedData, value: string | undefined) => void;
     isErrorFree: boolean;
     showErrors: boolean;
+    showErrorsForField: (key: keyof import("../../types").AccountHolderContactData | keyof import("../../types").AccountHolderTaxData | keyof import("../../types").AccountHolderClassificationData | keyof import("../../types").RegardedOwnerContactData | keyof import("../../types").RegardedOwnerClassificationData | keyof import("../../types").RegardedOwnerTaxData | keyof import("../../types").SummaryData | keyof import("../../types").CalculatedData) => boolean | undefined;
     exposeErrors: () => void;
     hideErrors: () => void;
     getRequiredLocalPrompt: (key: keyof import("../../types").AccountHolderContactData | keyof import("../../types").AccountHolderTaxData | keyof import("../../types").AccountHolderClassificationData | keyof import("../../types").RegardedOwnerContactData | keyof import("../../types").RegardedOwnerClassificationData | keyof import("../../types").RegardedOwnerTaxData | keyof import("../../types").SummaryData | keyof import("../../types").CalculatedData) => string;
@@ -55,6 +56,7 @@ export declare const useFormUIContext: () => {
     setValue: (key: keyof import("../../types").AccountHolderContactData | keyof import("../../types").AccountHolderTaxData | keyof import("../../types").AccountHolderClassificationData | keyof import("../../types").RegardedOwnerContactData | keyof import("../../types").RegardedOwnerClassificationData | keyof import("../../types").RegardedOwnerTaxData | keyof import("../../types").SummaryData | keyof import("../../types").CalculatedData, value: string | undefined) => void;
     isErrorFree: boolean;
     showErrors: boolean;
+    showErrorsForField: (key: keyof import("../../types").AccountHolderContactData | keyof import("../../types").AccountHolderTaxData | keyof import("../../types").AccountHolderClassificationData | keyof import("../../types").RegardedOwnerContactData | keyof import("../../types").RegardedOwnerClassificationData | keyof import("../../types").RegardedOwnerTaxData | keyof import("../../types").SummaryData | keyof import("../../types").CalculatedData) => boolean | undefined;
     exposeErrors: () => void;
     hideErrors: () => void;
     getRequiredLocalPrompt: (key: keyof import("../../types").AccountHolderContactData | keyof import("../../types").AccountHolderTaxData | keyof import("../../types").AccountHolderClassificationData | keyof import("../../types").RegardedOwnerContactData | keyof import("../../types").RegardedOwnerClassificationData | keyof import("../../types").RegardedOwnerTaxData | keyof import("../../types").SummaryData | keyof import("../../types").CalculatedData) => string;

package/dist/src/contexts/TaxDocumentation/TaxBitFormProvider.d.ts

@@ -1,6 +1,6 @@
 import React from 'react';
 import type { InputStep, Locale, Progress, TaxForm } from '../../types';
-import { ClientTaxDocumentation } from '../../types/client';
+import { ClientTaxDocumentation, ExternalValidations } from '../../types/client';
 type TaxDocumentationProviderProps = {
     data?: ClientTaxDocumentation;
     onSubmit: (data: ClientTaxDocumentation) => void;
@@ -9,6 +9,7 @@ type TaxDocumentationProviderProps = {
     taxForms?: TaxForm[];
     step?: InputStep;
     onProgress?: (progress: Progress) => void;
+    externalValidations?: ExternalValidations;
 };
-export declare const TaxBitFormProvider: ({ data, onSubmit, onProgress, language, taxForms, step, children, }: TaxDocumentationProviderProps) => React.JSX.Element;
+export declare const TaxBitFormProvider: ({ data, externalValidations, onSubmit, onProgress, language, taxForms, step, children, }: TaxDocumentationProviderProps) => React.JSX.Element;
 export {};

package/dist/src/contexts/TaxDocumentation/useTaxDocumentation.d.ts

@@ -1,16 +1,17 @@
 /// <reference types="react" />
 import type { InputStep, Locale, Progress, TaxDocumentation, TaxForm } from 'types';
 import type { StepId } from 'types/StepId';
-import { ClientTaxDocumentation } from 'types/client';
+import { ClientTaxDocumentation, ExternalValidations } from 'types/client';
 type UseTaxDocumentationProps = {
     data: ClientTaxDocumentation;
     language?: Locale;
+    externalValidations?: ExternalValidations;
     onSubmit: (data: ClientTaxDocumentation) => void;
     onProgress?: (progress: Progress) => void;
     step?: InputStep;
     taxForms?: TaxForm[];
 };
-export declare const useTaxDocumentation: ({ data: initialData, language: initialLanguage, onSubmit, onProgress, step: initialStep, taxForms: supportedForms, }: UseTaxDocumentationProps) => {
+export declare const useTaxDocumentation: ({ data: startingData, language: initialLanguage, externalValidations, onSubmit, onProgress, step: initialStep, taxForms: supportedForms, }: UseTaxDocumentationProps) => {
     isW9: boolean;
     isW8: boolean;
     isW8Ben: boolean;
@@ -33,5 +34,6 @@ export declare const useTaxDocumentation: ({ data: initialData, language: initia
     language: "bg-bg" | "cs-cz" | "da-dk" | "de-at" | "de-de" | "el-cy" | "el-gr" | "en-gb" | "en-us" | "es-es" | "et-ee" | "fi-fi" | "fr-fr" | "fr-lu" | "ga-ie" | "hr-hr" | "hu-hu" | "it-it" | "lt-lt" | "lv-lv" | "mt-mt" | "nl-be" | "nl-nl" | "no-no" | "pl-pl" | "pt-pt" | "ro-ro" | "sk-sk" | "sl-si" | "sv-se";
     supportedForms: TaxForm[];
     setSupportedForms: import("react").Dispatch<import("react").SetStateAction<TaxForm[]>>;
+    externalValidations: ExternalValidations | undefined;
 };
 export {};

package/dist/src/contexts/TaxDocumentation/useTaxDocumentationContext.d.ts

@@ -22,6 +22,7 @@ export declare const useTaxDocumentationContext: () => {
     language: "bg-bg" | "cs-cz" | "da-dk" | "de-at" | "de-de" | "el-cy" | "el-gr" | "en-gb" | "en-us" | "es-es" | "et-ee" | "fi-fi" | "fr-fr" | "fr-lu" | "ga-ie" | "hr-hr" | "hu-hu" | "it-it" | "lt-lt" | "lv-lv" | "mt-mt" | "nl-be" | "nl-nl" | "no-no" | "pl-pl" | "pt-pt" | "ro-ro" | "sk-sk" | "sl-si" | "sv-se";
     supportedForms: import("../../types").TaxForm[];
     setSupportedForms: import("react").Dispatch<import("react").SetStateAction<import("../../types").TaxForm[]>>;
+    externalValidations: import("../../entry").ExternalValidations | undefined;
 }, TaxDocumentationContextProvider: import("react").Provider<{
     isW9: boolean;
     isW8: boolean;
@@ -45,4 +46,5 @@ export declare const useTaxDocumentationContext: () => {
     language: "bg-bg" | "cs-cz" | "da-dk" | "de-at" | "de-de" | "el-cy" | "el-gr" | "en-gb" | "en-us" | "es-es" | "et-ee" | "fi-fi" | "fr-fr" | "fr-lu" | "ga-ie" | "hr-hr" | "hu-hu" | "it-it" | "lt-lt" | "lv-lv" | "mt-mt" | "nl-be" | "nl-nl" | "no-no" | "pl-pl" | "pt-pt" | "ro-ro" | "sk-sk" | "sl-si" | "sv-se";
     supportedForms: import("../../types").TaxForm[];
     setSupportedForms: import("react").Dispatch<import("react").SetStateAction<import("../../types").TaxForm[]>>;
+    externalValidations: import("../../entry").ExternalValidations | undefined;
 } | undefined>;

package/dist/src/hooks/useTaxBit/useTaxBit.d.ts

@@ -1,7 +1,6 @@
 import type { ClientTaxDocumentation, ClientTaxDocumentationStatus } from '../../types/client';
 export declare const useTaxBit: (bearerToken: string, staging?: true) => {
     postData: (data: ClientTaxDocumentation) => Promise<void>;
-    formStatus: "NOT_SUBMITTED" | "COMPLETE" | "INCOMPLETE" | undefined;
     status: ClientTaxDocumentationStatus | undefined;
     formSubmitted: boolean;
     serverData: ClientTaxDocumentation | undefined;

package/dist/src/i18n/types/LocalizationKey.d.ts

@@ -1,5 +1,5 @@
 export type ButtonKey = 'edit' | 'back' | 'next' | 'reset' | 'submit' | 'cancel' | 'hide' | 'show';
-export type ErrorKey = 'required' | 'invalid' | 'invalidDate' | 'mustBeSixCharacters' | 'mustBeNineDigits' | 'mustBeFiveOrNineDigits' | 'mustMatchName' | 'mustBeInDateFormat' | 'mustBeValidBirthDate' | 'mustNotMatchVatin' | 'residencesMustIncludeVatCountry' | 'residencesMustIncludeAddressCountry' | 'residencesMustIncludeAnEUCountry';
+export type ErrorKey = 'required' | 'invalid' | 'invalidDate' | 'invalidVat' | 'mustBeSixCharacters' | 'mustBeNineDigits' | 'mustBeFiveOrNineDigits' | 'mustMatchName' | 'mustBeInDateFormat' | 'mustBeValidBirthDate' | 'mustNotMatchVatin' | 'residencesMustIncludeVatCountry' | 'residencesMustIncludeAddressCountry' | 'residencesMustIncludeAnEUCountry';
 export type OptionKey = 'usPerson_yes' | 'usPerson_no' | 'regardedOwnerUsPerson_yes' | 'regardedOwnerUsPerson_no' | 'isIndividual_yes' | 'isIndividual_no' | 'cCorporation' | 'centralBankOfIssue' | 'complexTrust' | 'corporation' | 'disregardedEntity' | 'estate' | 'foreignGovernmentControlledEntity' | 'foreignGovernmentIntegralPart' | 'grantorTrust' | 'individual' | 'internationalOrganization' | 'llc' | 'no' | 'other' | 'partnership' | 'privateFoundation' | 'sCorporation' | 'simpleTrust' | 'smllc' | 'soleProprietor' | 'taxExemptOrganization' | 'trust' | 'trustEstate' | 'yes';
 export type PromptKey = 'addAdditional' | 'address' | 'businessRegistrationNumber' | 'businessRegistrationCountry' | 'city' | 'cityOfBirth' | 'country' | 'countryOfBirth' | 'countryOfCitizenship' | 'dateOfBirth' | 'day' | 'dbaName' | 'exemptPayeeCode' | 'exemptFatcaCode' | 'financialAccountIdentifier' | 'financialAccountName' | 'foreignAccountType' | 'foreignOtherClassification' | 'foreignTin' | 'foreignTinIsNotRequired' | 'foreignTrustClassification' | 'isEuResident' | 'isIndividual' | 'iAcknowlegeESignIsOk' | 'iAmACitizenOfTheUs' | 'iAmExemptFromFatcaReporting' | 'iAmNotSubjectToBackupWithholding' | 'iAuthorizeWithholdingAgent' | 'iCertifyToAll' | 'iConfirmIncomeIsNonUs' | 'iConfirmTheBeneficialOwnerIsExempt' | 'iConfirmTheInformationIsCorrectComplete' | 'iConfirmTheEntityIsNotAUsPerson' | 'iConfirmTheEntityIsTheBeneficialOwner' | 'iConfirmTheTaxIdIsCorrect' | 'iHaveLegalCapacityToSign' | 'mailingAddress' | 'mailingAddressIsDifferent' | 'month' | 'name' | 'nameOfEntity' | 'nameOfCCorporation' | 'nameOfCorporation' | 'nameOfIndividual' | 'nameOfLlc' | 'nameOfOrganization' | 'nameOfPartnership' | 'nameOfSCorporation' | 'nameOfSoleProprietor' | 'nameOfTrustEstate' | 'nameOfTrust' | 'province' | 'regardedOwnerUsPerson' | 'removeAdditional' | 'signature' | 'smllcElection' | 'state' | 'stateProvince' | 'street' | 'street2' | 'taxIdNumber' | 'taxIdNumberIsNotRequired' | 'tin' | 'usAccountType' | 'usLlcClassification' | 'usOtherClassification' | 'usPerson' | 'usEin' | 'usSsn' | 'usTin' | 'usTrustEstateEin' | 'vatIdentificationNumber' | 'vatIsNotRequired' | 'vatCountry' | 'year' | 'zip';
 export type SubPromptKey = 'smllcElection' | 'iConfirmIncomeIsNonUs' | 'isEuResident' | 'isIndividual' | 'financialAccountIdentifier' | 'financialAccountName' | 'vatIdentificationNumber' | 'placeOfBirth';

package/dist/src/types/Progress.d.ts

@@ -1,5 +1,5 @@
-import { Locale } from './Locale.ts';
-import type { StepId } from './StepId.ts';
+import { Locale } from './Locale';
+import { StepId } from './StepId';
 export type Progress = {
     language: Locale;
     percentComplete: number;

package/dist/src/types/client/ClientTaxDocumentationStatus.d.ts

@@ -3,6 +3,7 @@ export type ClientTaxDocumentationStatus = {
     submissionStatus: 'SUBMITTED' | 'NOT_SUBMITTED';
     DAC7Interview?: {
         dataCollectionStatus: 'COMPLETE' | 'INCOMPLETE';
+        vatStatus: 'PENDING' | 'VALID' | 'INVALID' | 'INSUFFICIENT_DATA' | 'NOT_REQUIRED';
         expirationDate: string;
     };
 };

package/dist/src/types/client/ExternalValidations.d.ts

@@ -0,0 +1,7 @@
+type ExternalValidation = {
+    type: 'vat' | 'ustin';
+    identifier: string;
+    status: string;
+};
+export type ExternalValidations = Array<ExternalValidation>;
+export {};

package/dist/src/types/client/index.d.ts

@@ -1,2 +1,3 @@
 export type * from './ClientTaxDocumentation';
 export type * from './ClientTaxDocumentationStatus';
+export type * from './ExternalValidations';

package/dist/src/types/server/TaxDocumentationStatus.d.ts

@@ -2,7 +2,8 @@ export type TaxDocumentationStatus = {
     status: 'UNDOCUMENTED' | 'UNDETERMINED';
     submission_status: 'SUBMITTED' | 'NOT_SUBMITTED';
     DAC7_interview?: {
-        dataCollection_status: 'COMPLETE' | 'INCOMPLETE';
+        data_collection_status: 'COMPLETE' | 'INCOMPLETE';
+        vat_status: 'PENDING' | 'VALID' | 'INVALID' | 'INSUFFICIENT_DATA' | 'NOT_REQUIRED';
         expiration_date: string;
     };
 };

package/dist/src/validations/getInvalidFields.d.ts

@@ -1,3 +1,4 @@
 import { TaxDocumentationErrorFile } from '../contexts';
 import { TaxDocumentation } from '../types';
-export declare const getInvalidFields: (fields: TaxDocumentation) => TaxDocumentationErrorFile;
+import { ExternalValidations } from '../types/client';
+export declare const getInvalidFields: (fields: TaxDocumentation, externalValidations?: ExternalValidations) => TaxDocumentationErrorFile;

package/dist/src/validations/invalidFieldRules.d.ts

@@ -1,6 +1,7 @@
 import { ErrorKey } from 'i18n/types';
 import { TaxDocumentation, TaxDocumentationKey } from 'types/TaxDocumentation';
-export type FormUIValidation = (fields: TaxDocumentation) => ErrorKey[] | undefined;
+import { ExternalValidations } from '../types/client';
+export type FormUIValidation = (fields: TaxDocumentation, externalValidations?: ExternalValidations) => ErrorKey[] | undefined;
 export type FormUIValidations = {
     [key in TaxDocumentationKey]?: FormUIValidation;
 };

package/dist/src/widgets/TaxBitForm/useTaxBitForm.d.ts

@@ -1,9 +1,10 @@
-import { ClientTaxDocumentation } from '../../types/client';
-import { TaxBitFormProps } from './TaxBitForm.tsx';
+import { ClientTaxDocumentation, ExternalValidations } from 'types/client';
+import { TaxBitFormProps } from './TaxBitForm';
 type UseTaxBitFormProps = Exclude<TaxBitFormProps, 'language'>;
 export declare const useTaxBitForm: ({ bearerToken, data, onSubmit, onSuccess, staging, }: UseTaxBitFormProps) => {
     handleOnSubmit: (data: ClientTaxDocumentation) => Promise<void>;
-    formData: ClientTaxDocumentation | undefined;
+    externalValidations: ExternalValidations;
+    formData: ClientTaxDocumentation;
     isComplete: boolean;
     isLoading: boolean;
 };

package/dist/src/wizard/TaxBitFormUI/TaxBitFormUI.d.ts

@@ -1,12 +1,13 @@
 import React from 'react';
 import type { Locale, Progress, TaxForm } from '../../types';
-import { ClientTaxDocumentation } from '../../types/client';
+import { ClientTaxDocumentation, ExternalValidations } from '../../types/client';
 export type TaxBitFormUIProps = {
     data?: ClientTaxDocumentation;
     onSubmit: (data: ClientTaxDocumentation) => void;
+    externalValidations?: ExternalValidations;
     language?: Locale;
     taxForms?: TaxForm[];
     complete?: boolean;
     onProgress?: (progress: Progress) => void;
 };
-export declare const TaxBitFormUI: ({ data, onSubmit, language, taxForms, complete, onProgress, }: TaxBitFormUIProps) => React.JSX.Element;
+export declare const TaxBitFormUI: ({ data, onSubmit, language, taxForms, complete, onProgress, externalValidations, }: TaxBitFormUIProps) => React.JSX.Element;