@taxbit/react-sdk 0.0.15 → 0.1.0

package/README.md

@@ -1,20 +1,319 @@
-# 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
+```
+
+```typescript
+import '@taxbit/react-sdk/style/inline.css'; // other options include 'basic.css' and 'minimal.css' 
+import { TaxBitDAC7Form } from '@taxbit/react-sdk';
+```
 
-`import { TaxDocumentation } from '@taxbit/taxbit-tax-documentation';`
+### 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
+<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
+/>
+```
 
+Which is just a shortcut for this component...
 ```jsx
-<TaxBitFormUI onSubmit={data => alert(JSON.stringify(data))} />
+<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
+/>
 ```
 
-## Todo
+There is a more basic component that simply shows the TaxBit UI and does not interact with the TaxBit server.  It can be used like this...
+```typescript jsx
+      <TaxBitDAC7FormUI
+        data={exampleData}
+        onSubmit={(data: unknown) => alert(JSON.stringify(data))}
+      />
+```
+
+### 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:
+- bg-bg
+- cs-cz
+- de-de
+- el-gr
+- en-gb
+- en-us
+- es-es
+- et-ee
+- fr-fr
+- hu-hu
+- it-it
+- mt-mt
+- nl-nl
+- no-no
+- pt-pt
+- ro-ro
+- sk-sk
+- sl-si
+- sv-se
+
+### Staging
+This can be set to `true` or `false`.  Passing `staging` in the component is the same as passing `staging={true}`.
+
+If `true`, the staging environment will be used. If `false`, the production environment will be used. The default is `false`.
+
+### CSS and Style Customization
+The TaxBit React SDK renders a form for collecting user data.  The form is structured with fairly semantic HTML and CSS classes and can be easily customized to closely match your website's style. 
+The structure below is an example of the HTML that that could be produced by a rendered React SDK Widget component.
+
+```html
+<form class="taxbit-page">
+    <header class="taxbit-page-header">
+        <h3 class="taxbit-page-title">Title</h3>
+    </header>
+    <main class="taxbit-page-main">
+        <div class="taxbit-row">
+            <div class="taxbit-label">Are you an individual?*</div>
+            <div class="taxbit-row-content">
+                <div class="taxbit-row-value">
+                    <div class="taxbit-input-status">
+                        <div class="taxbit-radio-buttons">
+                            <div class="taxbit-radio-button">
+                                <input type="radio" name="accountHolderIsIndividual" id="accountHolderIsIndividual-yes" value="yes" checked="">
+                                <label for="accountHolderIsIndividual-yes">Yes</label>
+                            </div>
+                            <div class="taxbit-radio-button">
+                                <input type="radio" name="accountHolderIsIndividual" id="accountHolderIsIndividual-no" value="no">
+                                <label for="accountHolderIsIndividual-no">No</label>
+                            </div>
+                        </div>
+                    </div>
+                </div>
+            </div>
+        </div>
+        <div class="taxbit-row">
+            <div class="taxbit-label">Name of Individual*</div>
+            <div class="taxbit-row-content">
+                <div class="taxbit-row-value">
+                    <div class="taxbit-input-status">
+                        <input type="text" name="accountHolderName" class="taxbit-input" value="Mark">
+                    </div>
+                </div>
+            </div>
+        </div>
+        <div class="taxbit-row">
+            <div class="taxbit-label">Date of Birth*</div>
+            <div class="taxbit-row-content">
+                <div class="taxbit-row-value">
+                    <div class="taxbit-input-status">
+                        <div class="taxbit-row-value">
+                            <select name="accountHolderDateOfBirth" class="taxbit-select taxbit-select-month">
+                                <option value="" disabled="" hidden="">Month</option>
+                                <option value="01">January</option>
+                                <option value="02">February</option>
+                                <option value="03">March</option>
+                                <option value="04">April</option>
+                                <option value="05">May</option>
+                                <option value="06">June</option>
+                                <option value="07">July</option>
+                                <option value="08">August</option>
+                                <option value="09">September</option>
+                                <option value="10">October</option>
+                                <option value="11">November</option>
+                                <option value="12">December</option>
+                            </select>
+                            <select name="accountHolderDateOfBirth" class="taxbit-select taxbit-select-day taxbit-placeholder">
+                                <option value="" disabled="" hidden="">Day</option>
+                                <option value="01">1</option>
+                                <option value="02">2</option>
+                                <option value="03">3</option>
+                                <option value="04">4</option>
+                                <option value="05">5</option>
+                                <option value="06">6</option>
+                                <option value="07">7</option>
+                                <option value="08">8</option>
+                                <option value="09">9</option>
+                                <option value="10">10</option>
+                                <option value="11">11</option>
+                                <option value="12">12</option>
+                                <option value="13">13</option>
+                                <option value="14">14</option>
+                                <option value="15">15</option>
+                                <option value="16">16</option>
+                                <option value="17">17</option>
+                                <option value="18">18</option>
+                                <option value="19">19</option>
+                                <option value="21">21</option>
+                                <option value="22">22</option>
+                                <option value="23">23</option>
+                                <option value="24">24</option>
+                                <option value="25">25</option>
+                                <option value="26">26</option>
+                                <option value="27">27</option>
+                                <option value="28">28</option>
+                                <option value="29">29</option>
+                                <option value="30">30</option>
+                                <option value="31">31</option>
+                            </select>
+                            <select name="accountHolderDateOfBirth" class="taxbit-select taxbit-select-year taxbit-placeholder">
+                                <option value="" disabled="" hidden="">Year</option>
+                                <option value="2023">2023</option>
+                                <option value="2022">2022</option>
+                                <option value="2021">2021</option>
+                                <option value="2020">2020</option>
+                                <option value="2019">2019</option>
+                                <option value="2018">2018</option>
+                                <option value="2017">2017</option>
+                                <option value="2016">2016</option>
+                                <option value="2015">2015</option>
+                                <option value="2014">2014</option>
+                                <option value="2013">2013</option>
+                                <option value="2012">2012</option>
+                                <option value="2011">2011</option>
+                                <option value="2010">2010</option>
+                                <option value="2009">2009</option>
+                                <option value="2008">2008</option>
+                                <option value="2007">2007</option>
+                                <option value="2006">2006</option>
+                                <option value="2005">2005</option>
+                                <option value="2004">2004</option>
+                                <option value="2003">2003</option>
+                                <option value="2002">2002</option>
+                                <option value="2001">2001</option>
+                                <option value="2000">2000</option>
+                            </select>
+                        </div>
+                    </div>
+                </div>
+            </div>
+        </div>
+        <div class="taxbit-section">
+            <div class="taxbit-row">
+                <div class="taxbit-label">VAT Member State*</div>
+                <div class="taxbit-row-content">
+                    <div class="taxbit-row-value">
+                        <div class="taxbit-input-status">
+                            <select name="accountHolderVatCountry" class="taxbit-select">
+                                <option value="">
 
- - I18n for another language
- - Config for self-cert and w forms
- - Style selection
- - 
+                                </option>
+                                <option value="AT">Austria</option>
+                                <option value="BE">Belgium</option>
+                                <option value="BG">Bulgaria</option>
+                                <option value="HR">Croatia</option>
+                                <option value="CY">Cyprus</option>
+                                <option value="CZ">Czechia</option>
+                                <option value="DK">Denmark</option>
+                                <option value="EE">Estonia</option>
+                                <option value="FI">Finland</option>
+                                <option value="FR">France</option>
+                                <option value="DE">Germany</option>
+                                <option value="GR">Greece</option>
+                                <option value="HU">Hungary</option>
+                                <option value="IE">Ireland</option>
+                                <option value="IT">Italy</option>
+                                <option value="LV">Latvia</option>
+                                <option value="LT">Lithuania</option>
+                                <option value="LU">Luxembourg</option>
+                                <option value="MT">Malta</option>
+                                <option value="NL">Netherlands</option>
+                                <option value="PL">Poland</option>
+                                <option value="PT">Portugal</option>
+                                <option value="RO">Romania</option>
+                                <option value="SK">Slovakia</option>
+                                <option value="SI">Slovenia</option>
+                                <option value="ES">Spain</option>
+                                <option value="SE">Sweden</option>
+                            </select>
+                        </div>
+                    </div>
+                </div>
+            </div>
+            <div class="taxbit-row">
+                <div class="taxbit-label">VAT Identification Number*<div class="taxbit-sub-label">Unique identifier for VAT-registered businesses or individuals.</div>
+                </div>
+                <div class="taxbit-row-content">
+                    <div class="taxbit-row-value">
+                        <div class="taxbit-input-status">
+                            <input type="text" name="accountHolderVatIdentificationNumber" class="taxbit-input" value="">
+                        </div>
+                    </div>
+                </div>
+            </div>
+            <div class="taxbit-row">
+                <div class="taxbit-label"></div>
+                <div class="taxbit-row-content">
+                    <div class="taxbit-row-value">
+                        <div class="taxbit-input-status">
+                            <div class="taxbit-checkBox-label">
+                                <input type="checkbox" id="accountHolderVatIdentificationNumberIsNotRequired" name="accountHolderVatIdentificationNumberIsNotRequired" class="taxbit-check-box">
+                                <label for="accountHolderVatIdentificationNumberIsNotRequired">VAT is not required or has not been issued</label>
+                            </div>
+                        </div>
+                    </div>
+                </div>
+            </div>
+        </div>
+    </main>
+    <footer class="taxbit-step-actions">
+        <div class="taxbit-secondary-actions">
+            <button tabindex="-1">Back</button>
+        </div>
+        <div class="taxbit-primary-actions">
+            <button>Next</button>
+        </div>
+    </footer>
+</form>
+```

package/dist/basic.css

@@ -29,17 +29,23 @@ button:focus-visible {
 .taxbit-page {
   max-width: 600px;
   padding: 12px;
-  margin-bottom: 100px;
 }
 
-.taxbit-title {
+.taxbit-page-header {
+  display: flex;
+  align-items: center;
+  padding-bottom: 8px;
+  border-bottom: solid 1px #E4EBF6;
+  margin-bottom: 20px;
+}
+
+.taxbit-page-title {
+  margin: 0;
   font-size: 1.2em;
   line-height: 1.1;
   font-weight: 600;
-  padding-bottom: 8px;
-  border-bottom: solid 1px #E4EBF6;
-  margin-bottom: 8px;
   color: #12263F;
+  flex: 1 1 auto;
 }
 
 .taxbit-section {
@@ -50,6 +56,23 @@ button:focus-visible {
     margin-bottom: 8px;
     opacity: .8;
   }
+  .taxbit-section-sub-title {
+    font-size: .8em;
+    opacity: .7;
+    font-weight: 400;
+  }
+}
+
+.taxbit-select-language {
+  border: 0;
+  outline: none;
+  opacity: 0.6;
+  width: 100px;
+}
+
+.taxbit-select-language:focus {
+  border-bottom: solid 1px #E4EBF6;
+  opacity: 1;
 }
 
 .taxbit-row {
@@ -66,6 +89,10 @@ button:focus-visible {
     color: red;
     font-size: .8em;
   }
+  .taxbit-notification {
+    color: blue;
+    font-size: .8em;
+  }
   .taxbit-hint {
     font-size: .8em;
     opacity: .7;
@@ -74,19 +101,23 @@ button:focus-visible {
 
 .taxbit-row-actions {
   flex: 0 0 10%;
+  display: flex;
+  align-items: center;
 }
-.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;
   .taxbit-sub-label {
-    font-size: 0.7em;
+    font-size: 0.8em;
     opacity: 0.7;
     font-weight: 400;
+    line-height: 1.25em;
   }
 }
 .taxbit-input, .taxbit-select {
@@ -99,6 +130,16 @@ button:focus-visible {
   color: rgb(18, 38, 63);
 }
 
+@media only screen and (max-width: 600px) {
+  .taxbit-input, .taxbit-select {
+    font-size: 100%;
+  }
+}
+
+.taxbit-placeholder {
+  color: #aaa;
+}
+
 .taxbit-check-box {
   margin: 5px;
 }
@@ -118,6 +159,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/Page/Page.d.ts

@@ -1,6 +1,8 @@
 import React from "react";
 type PageProps = {
+    title?: string;
     children: React.ReactNode;
+    actions?: React.ReactNode;
 };
-export declare const Page: ({ children }: PageProps) => React.JSX.Element;
+export declare const Page: ({ children, title, actions }: PageProps) => React.JSX.Element;
 export {};

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,7 +1,7 @@
 export * from "./Address";
 export * from "./ErrorMessage";
+export * from "./Notification";
 export * from "./InputStatus";
 export * from "./Page";
 export * from "./Row";
 export * from "./Section";
-export * from "./Title";

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

@@ -1,5 +1,7 @@
-import { ButtonKey, ErrorKey, TextKey, TitleKey } from "i18n/types";
+import { ButtonKey, ErrorKey, NotificationKey, TextKey, TitleKey } from "i18n/types";
 import { TaxDocumentation, TaxDocumentationKey } from "types/TaxDocumentation";
+import { Locale } from "types";
+import { Notifications } from "../../utils/getNotifications";
 export type FormUIFields = {
     [key in TaxDocumentationKey]?: string | undefined;
 };
@@ -13,22 +15,27 @@ export declare const useFormUI: () => {
     fields: TaxDocumentation;
     setValue: (key: TaxDocumentationKey, value: string | undefined) => void;
     errors: FormUIErrors;
+    notifications: Notifications;
     isErrorFree: boolean;
     showErrors: boolean;
     exposeErrors: () => void;
     hideErrors: () => void;
-    requiredFields: FormUIRequired;
+    required: FormUIRequired;
     getLocalButton: (key: ButtonKey) => string;
     getLocalCaProvince: (key: string | undefined) => string;
     getLocalCountry: (key: string | undefined) => string;
     getLocalError: (key: ErrorKey) => string;
     getLocalHint: (key: TaxDocumentationKey) => string | undefined;
+    getLocalLocale: (key: Locale) => string;
+    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;
@@ -91,6 +98,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

@@ -63,6 +63,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,11 +104,12 @@ 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;
     hideErrors: () => void;
-    requiredFields: {
+    required: {
         exemptPayeeCode?: boolean | undefined;
         exemptFatcaCode?: boolean | undefined;
         iAcknowlegeESignIsOk?: boolean | undefined;
@@ -168,6 +170,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 +216,16 @@ 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;
+    getLocalLocale: (key: import("../../types").Locale) => string;
+    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;
@@ -281,6 +288,7 @@ export declare const useFormUIContext: () => {
         accountHolderShowTaxResidence5: boolean;
         accountHolderUsTin: boolean;
         accountHolderVatIdentificationNumber: boolean;
+        accountHolderVatIdentificationNumberIsNotRequired: boolean;
         accountHolderVatCountry: boolean;
         accountHolderIsIndividual: boolean;
         accountHolderIsEuResident: boolean;
@@ -387,6 +395,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,11 +436,12 @@ 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;
     hideErrors: () => void;
-    requiredFields: {
+    required: {
         exemptPayeeCode?: boolean | undefined;
         exemptFatcaCode?: boolean | undefined;
         iAcknowlegeESignIsOk?: boolean | undefined;
@@ -492,6 +502,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 +548,16 @@ 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;
+    getLocalLocale: (key: import("../../types").Locale) => string;
+    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;
@@ -605,6 +620,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,8 @@
 import React from "react";
-import type { Locale } from "../../i18n";
-import type { TaxForm, TaxDocumentation } from "../../types";
+import type { Locale, TaxForm, TaxDocumentation } from "../../types";
+import { ClientTaxDocumentation } from "../../types/external";
 type TaxDocumentationProviderProps = {
-    data?: TaxDocumentation;
+    data?: ClientTaxDocumentation;
     onSubmit: (data: TaxDocumentation) => void;
     language?: Locale;
     children: React.ReactNode;