@taxbit/react-sdk 0.0.14 → 0.0.16

package/README.md

@@ -1,20 +1,98 @@
-# TaxBit Tax Documentation
+# TaxBit React SDK
 
-A React app, widget, and component for gathering Tax Documentation data.
+A React app, widget, and component for gathering Tax Documentation data for US and EU Tax forms.
 
 ## Installation
 
-`npm install @taxbit/taxbit-tax-documentation`.
+```bash
+npm install @taxbit/react-sdk
+```
 
-`import { TaxDocumentation } from '@taxbit/taxbit-tax-documentation';`
+```typescript
+import '@taxbit/react-sdk/style/inline.css'; // other options include 'basic.css' and 'minimal.css' 
+import { TaxBitDAC7Form } from '@taxbit/react-sdk';
+```
+
+### Data
+```typescript
+exampleData = {
+    name: "John Smith",
+    tin: "456456456",
+    ftin: "667788991",
+    usAccountType: "individual",
+    foreignAccountType: "individual",
+    address: {
+    firstLine: "123 Main St",
+        city: "Seattle",
+        stateOrProvince: "WA",
+        postalCode: "98000",
+        country: "GR",
+    },
+    mailingAddress: {
+        firstLine: "123 Main St",
+        city: "Seattle",
+        stateOrProvince: "WA",
+        postalCode: "98000",
+        country: "GR",
+    },
+    mailingAddressIsDifferent: true,
+    countryOfCitizenship: "GR",
+    ftinNotLegallyRequired: true,
+    taxResidences: [
+        {
+            country: "GR",
+            tin: "456456456",
+            tinNotRequired: false,
+        },
+    ],
+    vatin: "123123123",
+    vatinCountry: "GR",
+    vatinNotRequired: true,
+    financialAccountIdentifier: "123123123",
+    financialAccountName: "John Smith",
+    isIndividual: true,
+    isEuResident: true,
+    isUsPerson: false,
+};
+```
 
 ```jsx
-<TaxBitFormUI onSubmit={data => alert(JSON.stringify(data))} />
+<TaxBitDAC7Form
+    data={exampleData}  // `data` is an optional prop
+    bearerToken='bearer token goes here'
+    language='en-us'  // 'en-us' is the default
+    staging // if not production
+/>
 ```
 
-## Todo
+Which is just a shortcut for this component...
+```jsx
+<TaxBitForm 
+    data={exampleData}  // `data` is an optional prop
+    bearerToken='bearer token goes here' 
+    language='en-us'  // 'en-us' is the default
+    forms={['DAC7']}
+    staging // if not production
+/>
+```
+
+### Bearer Token
+This will be generated from the TaxBit API and passed in as a prop to the component.
+
+### Language
+This can be set to any of the following:
+- en-us
+- es-es
+- fr-fr
+- de-de
+- it-it
+- nl-nl
+- no-no
+- sv-se
+- en-gb
+- pt-pt
+
+### Staging
+This can be set to `true` or `false`.  Passing `staging` in the component is the same as passing `staging={true}`.
 
- - I18n for another language
- - Config for self-cert and w forms
- - Style selection
- - 
+If `true`, the staging environment will be used. If `false`, the production environment will be used. The default is `false`.

package/dist/basic.css

@@ -50,6 +50,11 @@ button:focus-visible {
     margin-bottom: 8px;
     opacity: .8;
   }
+  .taxbit-section-sub-title {
+    font-size: .8em;
+    opacity: .7;
+    font-weight: 400;
+  }
 }
 
 .taxbit-row {
@@ -66,6 +71,10 @@ button:focus-visible {
     color: red;
     font-size: .8em;
   }
+  .taxbit-notification {
+    color: blue;
+    font-size: .8em;
+  }
   .taxbit-hint {
     font-size: .8em;
     opacity: .7;
@@ -75,16 +84,18 @@ button:focus-visible {
 .taxbit-row-actions {
   flex: 0 0 10%;
 }
-.taxbit-row-action-button, .taxbit-toggle-button {
+.taxbit-row-action-button {
   font-size: .8em;
   padding: 0.2em 1em;
+  flex: 0 0 auto;
 }
 
 .taxbit-label {
   flex: 0 0 40%;
   font-weight: 500;
+  line-height: 1.25em;
   .taxbit-sub-label {
-    font-size: 0.7em;
+    font-size: 0.8em;
     opacity: 0.7;
     font-weight: 400;
   }
@@ -99,6 +110,10 @@ button:focus-visible {
   color: rgb(18, 38, 63);
 }
 
+.taxbit-placeholder {
+  color: #aaa;
+}
+
 .taxbit-check-box {
   margin: 5px;
 }
@@ -118,6 +133,10 @@ button:focus-visible {
   width: 100%;
 }
 
+.taxbit-input-status-footer {
+  margin-top: 5px
+}
+
 .taxbit-row-value {
   display: flex;
   flex: 1;

package/dist/components/Notification/Notification.d.ts

@@ -0,0 +1,5 @@
+import React from "react";
+import { TaxDocumentationKey } from "types";
+export declare const Notification: ({ name }: {
+    name: TaxDocumentationKey;
+}) => React.JSX.Element | null;

package/dist/components/Notification/index.d.ts

@@ -0,0 +1 @@
+export * from "./Notification";

package/dist/components/Section/Section.d.ts

@@ -1,8 +1,9 @@
 import React from "react";
 type SectionProps = {
     title?: string;
+    subTitle?: string;
     showIf?: boolean;
     children: React.ReactNode;
 };
-export declare const Section: ({ title, showIf, children }: SectionProps) => string | number | boolean | Iterable<React.ReactNode> | React.JSX.Element | null | undefined;
+export declare const Section: ({ title, subTitle, showIf, children, }: SectionProps) => string | number | boolean | Iterable<React.ReactNode> | React.JSX.Element | null | undefined;
 export {};

package/dist/components/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./Address";
 export * from "./ErrorMessage";
+export * from "./Notification";
 export * from "./InputStatus";
 export * from "./Page";
 export * from "./Row";

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

@@ -1,5 +1,6 @@
-import { ButtonKey, ErrorKey, TextKey, TitleKey } from "i18n/types";
+import { ButtonKey, ErrorKey, NotificationKey, TextKey, TitleKey } from "i18n/types";
 import { TaxDocumentation, TaxDocumentationKey } from "types/TaxDocumentation";
+import { Notifications } from "../../utils/getNotifications";
 export type FormUIFields = {
     [key in TaxDocumentationKey]?: string | undefined;
 };
@@ -13,6 +14,7 @@ export declare const useFormUI: () => {
     fields: TaxDocumentation;
     setValue: (key: TaxDocumentationKey, value: string | undefined) => void;
     errors: FormUIErrors;
+    notifications: Notifications;
     isErrorFree: boolean;
     showErrors: boolean;
     exposeErrors: () => void;
@@ -23,12 +25,15 @@ export declare const useFormUI: () => {
     getLocalCountry: (key: string | undefined) => string;
     getLocalError: (key: ErrorKey) => string;
     getLocalHint: (key: TaxDocumentationKey) => string | undefined;
+    getLocalNotification: (key: NotificationKey) => string;
     getLocalOption: (key: string | undefined) => string | undefined;
-    getLocalPrompt: (key: TaxDocumentationKey) => string;
+    getLocalPrompt: (key: string) => string;
     getLocalSubPrompt: (key: TaxDocumentationKey) => string;
     getLocalText: (key: TextKey) => string;
     getLocalTitle: (key: TitleKey) => string;
+    getLocalSubTitle: (key: string) => string;
     getLocalUsState: (key: string | undefined) => string;
+    getLocalMonth: (key: string | undefined) => string;
     getRequiredLocalPrompt: (key: TaxDocumentationKey) => string;
     visibleQuestions: {
         exemptPayeeCode: boolean;
@@ -68,6 +73,7 @@ export declare const useFormUI: () => {
         accountHolderName: boolean;
         accountHolderFinancialAccountIdentifier: boolean;
         accountHolderFinancialAccountName: boolean;
+        accountHolderFinancialAccountNameSameAsAccountHolderName: boolean;
         accountHolderForeignTin: boolean;
         accountHolderForeignTinIsNotRequired: boolean;
         accountHolderTaxResidenceCountry1: boolean;
@@ -91,6 +97,7 @@ export declare const useFormUI: () => {
         accountHolderShowTaxResidence5: boolean;
         accountHolderUsTin: boolean;
         accountHolderVatIdentificationNumber: boolean;
+        accountHolderVatIdentificationNumberIsNotRequired: boolean;
         accountHolderVatCountry: boolean;
         accountHolderIsIndividual: boolean;
         accountHolderIsEuResident: boolean;

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

@@ -40,6 +40,7 @@ export declare const useFormUIContext: () => {
         accountHolderName: import("../../i18n/types").ErrorKey;
         accountHolderFinancialAccountIdentifier: import("../../i18n/types").ErrorKey;
         accountHolderFinancialAccountName: import("../../i18n/types").ErrorKey;
+        accountHolderFinancialAccountNameSameAsAccountHolderName: import("../../i18n/types").ErrorKey;
         accountHolderForeignTin: import("../../i18n/types").ErrorKey;
         accountHolderForeignTinIsNotRequired: import("../../i18n/types").ErrorKey;
         accountHolderTaxResidenceCountry1: import("../../i18n/types").ErrorKey;
@@ -63,6 +64,7 @@ export declare const useFormUIContext: () => {
         accountHolderShowTaxResidence5: import("../../i18n/types").ErrorKey;
         accountHolderUsTin: import("../../i18n/types").ErrorKey;
         accountHolderVatIdentificationNumber: import("../../i18n/types").ErrorKey;
+        accountHolderVatIdentificationNumberIsNotRequired: import("../../i18n/types").ErrorKey;
         accountHolderVatCountry: import("../../i18n/types").ErrorKey;
         accountHolderIsIndividual: import("../../i18n/types").ErrorKey;
         accountHolderIsEuResident: import("../../i18n/types").ErrorKey;
@@ -103,6 +105,7 @@ export declare const useFormUIContext: () => {
         regardedOwnerForeignTinIsNotRequired: import("../../i18n/types").ErrorKey;
         regardedOwnerUsTin: import("../../i18n/types").ErrorKey;
     };
+    notifications: import("../../utils/getNotifications").Notifications;
     isErrorFree: boolean;
     showErrors: boolean;
     exposeErrors: () => void;
@@ -145,6 +148,7 @@ export declare const useFormUIContext: () => {
         accountHolderName?: boolean | undefined;
         accountHolderFinancialAccountIdentifier?: boolean | undefined;
         accountHolderFinancialAccountName?: boolean | undefined;
+        accountHolderFinancialAccountNameSameAsAccountHolderName?: boolean | undefined;
         accountHolderForeignTin?: boolean | undefined;
         accountHolderForeignTinIsNotRequired?: boolean | undefined;
         accountHolderTaxResidenceCountry1?: boolean | undefined;
@@ -168,6 +172,7 @@ export declare const useFormUIContext: () => {
         accountHolderShowTaxResidence5?: boolean | undefined;
         accountHolderUsTin?: boolean | undefined;
         accountHolderVatIdentificationNumber?: boolean | undefined;
+        accountHolderVatIdentificationNumberIsNotRequired?: boolean | undefined;
         accountHolderVatCountry?: boolean | undefined;
         accountHolderIsIndividual?: boolean | undefined;
         accountHolderIsEuResident?: boolean | undefined;
@@ -213,12 +218,15 @@ export declare const useFormUIContext: () => {
     getLocalCountry: (key: string | undefined) => string;
     getLocalError: (key: import("../../i18n/types").ErrorKey) => string;
     getLocalHint: (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) => string | undefined;
+    getLocalNotification: (key: "vatUnexpectedFormat") => string;
     getLocalOption: (key: string | undefined) => string | undefined;
-    getLocalPrompt: (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) => string;
+    getLocalPrompt: (key: string) => string;
     getLocalSubPrompt: (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) => string;
     getLocalText: (key: import("../../i18n/types").TextKey) => string;
     getLocalTitle: (key: import("../../i18n/types").TitleKey) => string;
+    getLocalSubTitle: (key: string) => string;
     getLocalUsState: (key: string | undefined) => string;
+    getLocalMonth: (key: string | undefined) => string;
     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) => string;
     visibleQuestions: {
         exemptPayeeCode: boolean;
@@ -258,6 +266,7 @@ export declare const useFormUIContext: () => {
         accountHolderName: boolean;
         accountHolderFinancialAccountIdentifier: boolean;
         accountHolderFinancialAccountName: boolean;
+        accountHolderFinancialAccountNameSameAsAccountHolderName: boolean;
         accountHolderForeignTin: boolean;
         accountHolderForeignTinIsNotRequired: boolean;
         accountHolderTaxResidenceCountry1: boolean;
@@ -281,6 +290,7 @@ export declare const useFormUIContext: () => {
         accountHolderShowTaxResidence5: boolean;
         accountHolderUsTin: boolean;
         accountHolderVatIdentificationNumber: boolean;
+        accountHolderVatIdentificationNumberIsNotRequired: boolean;
         accountHolderVatCountry: boolean;
         accountHolderIsIndividual: boolean;
         accountHolderIsEuResident: boolean;
@@ -364,6 +374,7 @@ export declare const useFormUIContext: () => {
         accountHolderName: import("../../i18n/types").ErrorKey;
         accountHolderFinancialAccountIdentifier: import("../../i18n/types").ErrorKey;
         accountHolderFinancialAccountName: import("../../i18n/types").ErrorKey;
+        accountHolderFinancialAccountNameSameAsAccountHolderName: import("../../i18n/types").ErrorKey;
         accountHolderForeignTin: import("../../i18n/types").ErrorKey;
         accountHolderForeignTinIsNotRequired: import("../../i18n/types").ErrorKey;
         accountHolderTaxResidenceCountry1: import("../../i18n/types").ErrorKey;
@@ -387,6 +398,7 @@ export declare const useFormUIContext: () => {
         accountHolderShowTaxResidence5: import("../../i18n/types").ErrorKey;
         accountHolderUsTin: import("../../i18n/types").ErrorKey;
         accountHolderVatIdentificationNumber: import("../../i18n/types").ErrorKey;
+        accountHolderVatIdentificationNumberIsNotRequired: import("../../i18n/types").ErrorKey;
         accountHolderVatCountry: import("../../i18n/types").ErrorKey;
         accountHolderIsIndividual: import("../../i18n/types").ErrorKey;
         accountHolderIsEuResident: import("../../i18n/types").ErrorKey;
@@ -427,6 +439,7 @@ export declare const useFormUIContext: () => {
         regardedOwnerForeignTinIsNotRequired: import("../../i18n/types").ErrorKey;
         regardedOwnerUsTin: import("../../i18n/types").ErrorKey;
     };
+    notifications: import("../../utils/getNotifications").Notifications;
     isErrorFree: boolean;
     showErrors: boolean;
     exposeErrors: () => void;
@@ -469,6 +482,7 @@ export declare const useFormUIContext: () => {
         accountHolderName?: boolean | undefined;
         accountHolderFinancialAccountIdentifier?: boolean | undefined;
         accountHolderFinancialAccountName?: boolean | undefined;
+        accountHolderFinancialAccountNameSameAsAccountHolderName?: boolean | undefined;
         accountHolderForeignTin?: boolean | undefined;
         accountHolderForeignTinIsNotRequired?: boolean | undefined;
         accountHolderTaxResidenceCountry1?: boolean | undefined;
@@ -492,6 +506,7 @@ export declare const useFormUIContext: () => {
         accountHolderShowTaxResidence5?: boolean | undefined;
         accountHolderUsTin?: boolean | undefined;
         accountHolderVatIdentificationNumber?: boolean | undefined;
+        accountHolderVatIdentificationNumberIsNotRequired?: boolean | undefined;
         accountHolderVatCountry?: boolean | undefined;
         accountHolderIsIndividual?: boolean | undefined;
         accountHolderIsEuResident?: boolean | undefined;
@@ -537,12 +552,15 @@ export declare const useFormUIContext: () => {
     getLocalCountry: (key: string | undefined) => string;
     getLocalError: (key: import("../../i18n/types").ErrorKey) => string;
     getLocalHint: (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) => string | undefined;
+    getLocalNotification: (key: "vatUnexpectedFormat") => string;
     getLocalOption: (key: string | undefined) => string | undefined;
-    getLocalPrompt: (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) => string;
+    getLocalPrompt: (key: string) => string;
     getLocalSubPrompt: (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) => string;
     getLocalText: (key: import("../../i18n/types").TextKey) => string;
     getLocalTitle: (key: import("../../i18n/types").TitleKey) => string;
+    getLocalSubTitle: (key: string) => string;
     getLocalUsState: (key: string | undefined) => string;
+    getLocalMonth: (key: string | undefined) => string;
     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) => string;
     visibleQuestions: {
         exemptPayeeCode: boolean;
@@ -582,6 +600,7 @@ export declare const useFormUIContext: () => {
         accountHolderName: boolean;
         accountHolderFinancialAccountIdentifier: boolean;
         accountHolderFinancialAccountName: boolean;
+        accountHolderFinancialAccountNameSameAsAccountHolderName: boolean;
         accountHolderForeignTin: boolean;
         accountHolderForeignTinIsNotRequired: boolean;
         accountHolderTaxResidenceCountry1: boolean;
@@ -605,6 +624,7 @@ export declare const useFormUIContext: () => {
         accountHolderShowTaxResidence5: boolean;
         accountHolderUsTin: boolean;
         accountHolderVatIdentificationNumber: boolean;
+        accountHolderVatIdentificationNumberIsNotRequired: boolean;
         accountHolderVatCountry: boolean;
         accountHolderIsIndividual: boolean;
         accountHolderIsEuResident: boolean;

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

@@ -1,8 +1,9 @@
 import React from "react";
 import type { Locale } from "../../i18n";
 import type { TaxForm, TaxDocumentation } from "../../types";
+import { ClientTaxDocumentation } from "../../types/external";
 type TaxDocumentationProviderProps = {
-    data?: TaxDocumentation;
+    data?: ClientTaxDocumentation;
     onSubmit: (data: TaxDocumentation) => void;
     language?: Locale;
     children: React.ReactNode;

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

@@ -1,9 +1,10 @@
 /// <reference types="react" />
 import type { TaxForm, TaxDocumentation } from "types";
 import { Locale } from "i18n";
+import { ClientTaxDocumentation } from "../../types/external";
 type InputStep = "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Exemptions" | "RegardedOwnerClassification" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary";
 type UseTaxDocumentationProps = {
-    data: TaxDocumentation;
+    data: ClientTaxDocumentation;
     onSubmit: (transformedData: TaxDocumentation) => void;
     language?: Locale;
     taxForms?: TaxForm[];
@@ -17,7 +18,7 @@ export declare const useTaxDocumentation: ({ data: initialData, onSubmit, langua
     onPersistAccountHolderData: (newData: TaxDocumentation) => void;
     onPersistCollectedData: (newData: TaxDocumentation) => void;
     onSubmitTaxDocumentation: (newData: TaxDocumentation) => void;
-    onResetTaxDocumentation: () => void;
+    onResetTaxDocumentation: (data: ClientTaxDocumentation) => void;
     editTo: (form: InputStep) => void;
     onCancel: (() => void) | undefined;
     goTo: (form: InputStep) => void;
@@ -25,8 +26,8 @@ export declare const useTaxDocumentation: ({ data: initialData, onSubmit, langua
     goToNext: (data: TaxDocumentation) => void;
     stepName: InputStep;
     data: TaxDocumentation;
-    setLanguage: import("react").Dispatch<import("react").SetStateAction<"en-us" | "de-de" | "en-gb" | "it-it" | "nl-nl" | "no-no" | "sv-se" | "fr-fr" | "es-es">>;
-    language: "en-us" | "de-de" | "en-gb" | "it-it" | "nl-nl" | "no-no" | "sv-se" | "fr-fr" | "es-es";
+    setLanguage: import("react").Dispatch<import("react").SetStateAction<"en-us" | "de-de" | "en-gb" | "it-it" | "nl-nl" | "no-no" | "sv-se" | "fr-fr" | "es-es" | "pt-pt">>;
+    language: "en-us" | "de-de" | "en-gb" | "it-it" | "nl-nl" | "no-no" | "sv-se" | "fr-fr" | "es-es" | "pt-pt";
     supportedForms: TaxForm[];
     setSupportedForms: import("react").Dispatch<import("react").SetStateAction<TaxForm[]>>;
 };

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

@@ -8,7 +8,59 @@ export declare const useTaxDocumentationContext: () => {
     onPersistAccountHolderData: (newData: import("../../types").TaxDocumentation) => void;
     onPersistCollectedData: (newData: import("../../types").TaxDocumentation) => void;
     onSubmitTaxDocumentation: (newData: import("../../types").TaxDocumentation) => void;
-    onResetTaxDocumentation: () => void;
+    onResetTaxDocumentation: (data: {
+        address?: {
+            city?: string | undefined;
+            country?: string | undefined;
+            stateOrProvince?: string | undefined;
+            firstLine?: string | undefined;
+            secondLine?: string | undefined;
+            postalCode?: string | undefined;
+        } | undefined;
+        countryOfCitizenship?: string | undefined;
+        dateOfBirth?: string | undefined;
+        dbaName?: string | undefined;
+        mailingAddress?: {
+            city?: string | undefined;
+            country?: string | undefined;
+            stateOrProvince?: string | undefined;
+            firstLine?: string | undefined;
+            secondLine?: string | undefined;
+            postalCode?: string | undefined;
+        } | undefined;
+        mailingAddressIsDifferent?: boolean | undefined;
+        name?: string | undefined;
+        cityOfBirth?: string | undefined;
+        countryOfBirth?: string | undefined;
+        businessRegistrationNumber?: string | undefined;
+        financialAccountIdentifier?: string | undefined;
+        financialAccountName?: string | undefined;
+        ftin?: string | undefined;
+        ftinNotLegallyRequired?: boolean | undefined;
+        taxResidences?: {
+            country?: string | undefined;
+            tin?: string | undefined;
+            tinNotRequired?: boolean | undefined;
+        }[] | undefined;
+        showTaxResidence?: boolean[] | undefined;
+        tin?: string | undefined;
+        vatin?: string | undefined;
+        vatinCountry?: string | undefined;
+        vatinNotRequired?: boolean | undefined;
+        exemptFatcaCode?: string | undefined;
+        exemptPayeeCode?: string | undefined;
+        isIndividual?: boolean | undefined;
+        isEuResident?: boolean | undefined;
+        isUsPerson?: boolean | undefined;
+        usAccountType?: string | undefined;
+        usSmllcElection?: boolean | undefined;
+        usLlcClassification?: string | undefined;
+        usOtherClassification?: string | undefined;
+        usTrustEstateEin?: boolean | undefined;
+        foreignAccountType?: string | undefined;
+        foreignTrustClassification?: string | undefined;
+        foreignOtherClassification?: string | undefined;
+    }) => void;
     editTo: (form: "Summary" | "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Exemptions" | "RegardedOwnerClassification" | "RegardedOwnerContact" | "RegardedOwnerTax") => void;
     onCancel: (() => void) | undefined;
     goTo: (form: "Summary" | "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Exemptions" | "RegardedOwnerClassification" | "RegardedOwnerContact" | "RegardedOwnerTax") => void;
@@ -16,8 +68,8 @@ export declare const useTaxDocumentationContext: () => {
     goToNext: (data: import("../../types").TaxDocumentation) => void;
     stepName: "Summary" | "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Exemptions" | "RegardedOwnerClassification" | "RegardedOwnerContact" | "RegardedOwnerTax";
     data: import("../../types").TaxDocumentation;
-    setLanguage: import("react").Dispatch<import("react").SetStateAction<"en-us" | "de-de" | "en-gb" | "it-it" | "nl-nl" | "no-no" | "sv-se" | "fr-fr" | "es-es">>;
-    language: "en-us" | "de-de" | "en-gb" | "it-it" | "nl-nl" | "no-no" | "sv-se" | "fr-fr" | "es-es";
+    setLanguage: import("react").Dispatch<import("react").SetStateAction<"en-us" | "de-de" | "en-gb" | "it-it" | "nl-nl" | "no-no" | "sv-se" | "fr-fr" | "es-es" | "pt-pt">>;
+    language: "en-us" | "de-de" | "en-gb" | "it-it" | "nl-nl" | "no-no" | "sv-se" | "fr-fr" | "es-es" | "pt-pt";
     supportedForms: import("../../types").TaxForm[];
     setSupportedForms: import("react").Dispatch<import("react").SetStateAction<import("../../types").TaxForm[]>>;
 }, TaxDocumentationContextProvider: import("react").Provider<{
@@ -29,7 +81,59 @@ export declare const useTaxDocumentationContext: () => {
     onPersistAccountHolderData: (newData: import("../../types").TaxDocumentation) => void;
     onPersistCollectedData: (newData: import("../../types").TaxDocumentation) => void;
     onSubmitTaxDocumentation: (newData: import("../../types").TaxDocumentation) => void;
-    onResetTaxDocumentation: () => void;
+    onResetTaxDocumentation: (data: {
+        address?: {
+            city?: string | undefined;
+            country?: string | undefined;
+            stateOrProvince?: string | undefined;
+            firstLine?: string | undefined;
+            secondLine?: string | undefined;
+            postalCode?: string | undefined;
+        } | undefined;
+        countryOfCitizenship?: string | undefined;
+        dateOfBirth?: string | undefined;
+        dbaName?: string | undefined;
+        mailingAddress?: {
+            city?: string | undefined;
+            country?: string | undefined;
+            stateOrProvince?: string | undefined;
+            firstLine?: string | undefined;
+            secondLine?: string | undefined;
+            postalCode?: string | undefined;
+        } | undefined;
+        mailingAddressIsDifferent?: boolean | undefined;
+        name?: string | undefined;
+        cityOfBirth?: string | undefined;
+        countryOfBirth?: string | undefined;
+        businessRegistrationNumber?: string | undefined;
+        financialAccountIdentifier?: string | undefined;
+        financialAccountName?: string | undefined;
+        ftin?: string | undefined;
+        ftinNotLegallyRequired?: boolean | undefined;
+        taxResidences?: {
+            country?: string | undefined;
+            tin?: string | undefined;
+            tinNotRequired?: boolean | undefined;
+        }[] | undefined;
+        showTaxResidence?: boolean[] | undefined;
+        tin?: string | undefined;
+        vatin?: string | undefined;
+        vatinCountry?: string | undefined;
+        vatinNotRequired?: boolean | undefined;
+        exemptFatcaCode?: string | undefined;
+        exemptPayeeCode?: string | undefined;
+        isIndividual?: boolean | undefined;
+        isEuResident?: boolean | undefined;
+        isUsPerson?: boolean | undefined;
+        usAccountType?: string | undefined;
+        usSmllcElection?: boolean | undefined;
+        usLlcClassification?: string | undefined;
+        usOtherClassification?: string | undefined;
+        usTrustEstateEin?: boolean | undefined;
+        foreignAccountType?: string | undefined;
+        foreignTrustClassification?: string | undefined;
+        foreignOtherClassification?: string | undefined;
+    }) => void;
     editTo: (form: "Summary" | "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Exemptions" | "RegardedOwnerClassification" | "RegardedOwnerContact" | "RegardedOwnerTax") => void;
     onCancel: (() => void) | undefined;
     goTo: (form: "Summary" | "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Exemptions" | "RegardedOwnerClassification" | "RegardedOwnerContact" | "RegardedOwnerTax") => void;
@@ -37,8 +141,8 @@ export declare const useTaxDocumentationContext: () => {
     goToNext: (data: import("../../types").TaxDocumentation) => void;
     stepName: "Summary" | "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Exemptions" | "RegardedOwnerClassification" | "RegardedOwnerContact" | "RegardedOwnerTax";
     data: import("../../types").TaxDocumentation;
-    setLanguage: import("react").Dispatch<import("react").SetStateAction<"en-us" | "de-de" | "en-gb" | "it-it" | "nl-nl" | "no-no" | "sv-se" | "fr-fr" | "es-es">>;
-    language: "en-us" | "de-de" | "en-gb" | "it-it" | "nl-nl" | "no-no" | "sv-se" | "fr-fr" | "es-es";
+    setLanguage: import("react").Dispatch<import("react").SetStateAction<"en-us" | "de-de" | "en-gb" | "it-it" | "nl-nl" | "no-no" | "sv-se" | "fr-fr" | "es-es" | "pt-pt">>;
+    language: "en-us" | "de-de" | "en-gb" | "it-it" | "nl-nl" | "no-no" | "sv-se" | "fr-fr" | "es-es" | "pt-pt";
     supportedForms: import("../../types").TaxForm[];
     setSupportedForms: import("react").Dispatch<import("react").SetStateAction<import("../../types").TaxForm[]>>;
 } | undefined>;

package/dist/entry/index.d.ts

@@ -3,3 +3,4 @@ export * from "../widgets/TaxBitForm";
 export * from "../hooks/useTaxBit";
 export { type TaxForm } from "../types";
 export { type Locale } from "../i18n/types";
+export { type ClientTaxDocumentation } from "../types/external";

package/dist/i18n/i18n.d.ts

@@ -1,4 +1,4 @@
-import type { Locale } from "./types/Locale";
+import type { Locale } from "./types";
 import type { PropertyFile } from "./types/PropertyFile";
 type LocalizationFile = {
     [locale in Locale]: PropertyFile;

package/dist/i18n/index.d.ts

@@ -1,2 +1,2 @@
-export { getButtonText, getCaProvinceText, getCountryText, getErrorText, getHintText, getOptionText, getPromptText, getSubPromptText, getTitleText, getUsStateText, } from "./utils";
+export { getButtonText, getCaProvinceText, getCountryText, getErrorText, getHintText, getMonthText, getNotificationText, getOptionText, getPromptText, getSubPromptText, getTitleText, getUsStateText, } from "./utils";
 export type { Locale } from "./types/Locale";

package/dist/i18n/locales/index.d.ts

@@ -7,3 +7,4 @@ export * from "./it-it";
 export * from "./nl-nl";
 export * from "./no-no";
 export * from "./sv-se";
+export * from "./pt-pt";

package/dist/i18n/locales/pt-pt.d.ts

@@ -0,0 +1,2 @@
+import { PropertyFile } from "../types/PropertyFile";
+export declare const ptPt: PropertyFile;

package/dist/i18n/types/Locale.d.ts

@@ -1 +1 @@
-export type Locale = "en-us" | "de-de" | "en-gb" | "it-it" | "nl-nl" | "no-no" | "sv-se" | "fr-fr" | "es-es";
+export type Locale = "en-us" | "de-de" | "en-gb" | "it-it" | "nl-nl" | "no-no" | "sv-se" | "fr-fr" | "es-es" | "pt-pt";