@taxbit/react-sdk 0.6.1 → 1.0.0-beta.0

package/README.md

@@ -1,4 +1,4 @@
-# TaxBit React SDK
+# Taxbit React SDK
 
 A React app, widget, and component for gathering Tax Documentation data for US and EU Tax forms.
 
@@ -10,7 +10,7 @@ npm install @taxbit/react-sdk
 
 ```typescript
 import '@taxbit/react-sdk/style/inline.css'; // other options include 'basic.css' and 'minimal.css'
-import { TaxBitDAC7Form, ClientTaxDocumentation } from '@taxbit/react-sdk';
+import { TaxbitQuestionnaire, ClientTaxDocumentation } from '@taxbit/react-sdk';
 ```
 
 ### Data
@@ -56,62 +56,64 @@ exampleData: ClientTaxDocumentation = {
     businessRegistrationNumber: '123123123',
     businessRegistrationCountry: 'GR',
     isIndividual: true,
-    isEuResident: true,
   },
 };
 ```
 
 ```jsx
-<TaxBitDAC7Form
+<TaxbitQuestionnaire
   data={exampleData} // `data` is an optional prop
   bearerToken="bearer token goes here"
+  questionnaire="DPS"
   language="en-us" // 'en-us' is the default
   staging // if not production
 />
 ```
 
-Which is just a shortcut for this component...
+For W-9 W-8BEN and W-8BEN-E forms, this component can be used...
 
 ```jsx
-<TaxBitForm
+<TaxbitQuestionnaire
   data={exampleData} // `data` is an optional prop
   bearerToken="bearer token goes here"
-  language="en-us" // 'en-us' is the default
-  forms={['DAC7']}
+  questionnaire="W-FORM"
+  language="en" // 'en' is the default
   staging // if not production
 />
 ```
 
-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...
+To view the Taxbit Questionnaire component without connecting to the server, you can put it in "demoMode". It can be used like this...
 
 ```typescript jsx
-import { TaxBitDAC7FormUI, ClientTaxDocumentation } from '@taxbit/react-sdk';
+import { TaxbitQuestionnaire, ClientTaxDocumentation } from '@taxbit/react-sdk';
 
-<TaxBitDAC7FormUI
+<TaxbitQuestionnaire
   data={exampleData}
   onSubmit={(data: ClientTaxDocumentation) => alert(JSON.stringify(data))}
+  demoMode={true}
 />;
 ```
 
 ### Bearer Token
 
-This will be generated from the TaxBit API and passed in as a prop to the component.
+This will be generated from the Taxbit API and passed in as a prop to the component.
 
 ### Language
 
 The first screen of the tax documentation interview gives the user the opportunity to select a language.  
-This can also be initially set to any of that languages that are supported by the TaxBit API.
+The language in the DPS component can be initially set to any of that languages that are supported by the Taxbit API.  
+The WForm component language can be set to 'en', 'fr', or 'es'.
 
 See the `Locale` type below.
 
 ### Status
 
-The `useTaxBit` hook will return a `status` object that can be used to determine the status of the user's tax documentation. The `status` object will have the following shape:
+The `useTaxbit` hook will return a `status` object that can be used to determine the status of the user's tax documentation. The `status` object will have the following shape:
 
 ```typescript
 {
   submissionStatus: 'SUBMITTED' | 'NOT_SUBMITTED';
-  DAC7Interview: {
+  dpsQuestionnaire: {
     dataCollectionStatus: 'COMPLETE' | 'INCOMPLETE';
     expirationDate: 'PENDING' |
       'VALID' |
@@ -127,7 +129,7 @@ an example is below.
 ```json
 {
   "submissionStatus": "SUBMITTED",
-  "DAC7Interview": {
+  "dpsQuestionnaire": {
     "dataCollectionStatus": "COMPLETE",
     "expirationDate": "2026-11-20T00:00:00.000Z"
   }
@@ -142,67 +144,67 @@ If `true`, the staging environment will be used. If `false`, the production envi
 
 ### 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 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.
 Classnames are namespaced with "taxbit-" to reduce the chance of conflict.
 
 ### Callbacks
 
-The TaxBit React SDK provides callbacks for the following events on the `TaxBitDAC7Form` component. These callbacks can be passed in to the Component and used to trigger other actions in your application.
+The Taxbit React SDK provides callbacks for the following events on the `TaxbitQuestionnaire` component. These callbacks can be passed in to the Component and used to trigger other actions in your application.
 
 - `onSubmit` - called when the user clicks the submit button. This can be an `async` function.
 - `onSuccess` - called after the server responds with a successful submission.
 - `onError` - called when the server responds with an error during data submission.
 - `onSettled` - called after `onError` or `onSuccess` is called.
-- `onProgress` - called when the user loads and navigates within the TaxBit UI. The function passed here will be passed a Progress object (see below for the type definition):
+- `onProgress` - called when the user loads and navigates within the Taxbit UI. The function passed here will be passed a Progress object (see below for the type definition):
 
-The DAC7 sequence, for example, can have a total of 3, 4, or 5 steps, each with a localized `stepTitle` and `stepId`. The `stepNumber` is the current step (1 based), and `percentComplete` is the percentage of the steps that have been completed.
+The DPS sequence, for example, can have a total of 3, 4, or 5 steps, each with a localized `stepTitle` and `stepId`. The `stepNumber` is the current step (1 based), and `percentComplete` is the percentage of the steps that have been completed.
 
 ### Types
 
-The TaxBit React SDK provides a type for the status of the most recent tax documentation submitted by the user, referred to as `ClientTaxDocumentationStatus`. The data passed to the component and returned to the callback is typed as `ClientTaxDocumentation`.
+The Taxbit React SDK provides a type for the status of the most recent tax documentation submitted by the user, referred to as `ClientTaxDocumentationStatus`. The data passed to the component and returned to the callback is typed as `ClientTaxDocumentation`.
 
 Also included are some utility types:
 
 ```typescript
 type Locale =
-  | 'bg-bg'
-  | 'cs-cz'
-  | 'da-dk'
+  | 'bg'
+  | 'cs'
+  | 'da'
+  | 'de'
   | 'de-at'
-  | 'de-de'
+  | 'el'
   | 'el-cy'
-  | 'el-gr'
+  | 'en'
   | 'en-gb'
   | 'en-us'
-  | 'es-es'
-  | 'et-ee'
-  | 'fi-fi'
-  | 'fr-fr'
+  | 'es'
+  | 'et'
+  | 'fi'
+  | 'fr'
   | 'fr-lu'
-  | 'ga-ie'
-  | 'hr-hr'
-  | 'hu-hu'
-  | 'it-it'
-  | 'lt-lt'
-  | 'lv-lv'
-  | 'mt-mt'
+  | 'ga'
+  | 'hr'
+  | 'hu'
+  | 'it'
+  | 'lt'
+  | 'lv'
+  | 'mt'
+  | 'nl'
   | 'nl-be'
-  | 'nl-nl'
-  | 'no-no'
-  | 'pl-pl'
-  | 'pt-pt'
-  | 'ro-ro'
-  | 'sk-sk'
-  | 'sl-si'
-  | 'sv-se';
+  | 'no'
+  | 'pl'
+  | 'pt'
+  | 'ro'
+  | 'sk'
+  | 'sl'
+  | 'sv';
 ```
 
 ```typescript
 type StepId =
+  | 'accountHolderClassification'
   | 'accountHolderContactInformation'
   | 'accountHolderTaxInformation'
-  | 'accountHolderTaxClarification'
-  | 'accountHolderClassification'
   | 'confirmation'
   | 'exemptions'
   | 'regardedOwnerClassification'
@@ -226,72 +228,82 @@ type Progress = {
 
 ## Changelog
 
-### Version 0.6.0
+### Version 1.0.0-beta
+
+1. W-9, W-8BEN, and W-8BEN-E forms are now supported in the UI. The `TaxbitQuestionnaire` component can be used to collect data for these forms.
+2. Translations for country names are now coming from the Intl API.
+3. Download URL available in the `useTaxbit` hook.
+
+### Version 0.6.2
+
+1. Added this Changelog file
+
+### Version 0.6.1
 
-- Native local terms for languages
-- Moved "Remove Residence" button, added section action button
-- Fixed Type for onSubmit callback. Callback can be async or not async.
+1. Native local terms for languages
+2. Moved "Remove Residence" button, added section action button
+3. Fixed Type for onSubmit callback. Callback can be async or not async.
 
 ### Version 0.5.1
 
-- Place of Birth: Localized text update
-- Confirming valid ISO country code in data
-- Setting account holder name as the default value on Financial Account Identifier
+1. Place of Birth: Localized text update
+2. Confirming valid ISO country code in data
+3. Setting account holder name as the default value on Financial Account Identifier
 
 ### Version 0.5.0
 
-- Adding all error messages to Summary Screen
-- Submit button is disabled when saved data matches local data
-- Indicate in form footer when errors are in the form above
+1. Adding all error messages to Summary Screen
+2. Submit button is disabled when saved data matches local data
+3. Indicate in form footer when errors are in the form above
 
 ### Version 0.4.4
 
-- Handle blank bearer token. No error, but a warning is logged.
+1. Handle blank bearer token. No error, but a warning is logged.
 
 ### Version 0.4.3
 
-- Show error on VAT Identifier field when the Identifier is determined to be invalid
-- Fix: data should not reset on react render
-- Fix: changing data prop will reset form
+1. Show error on VAT Identifier field when the Identifier is determined to be invalid
+2. Fix: data should not reset on react render
+3. Fix: changing data prop will reset form
 
 ### Version 0.4.2
 
-- Added stepIndex and steps fields to the Progress object. stepId is now typed to potential enum values.
+1. Added stepIndex and steps fields to the Progress object. stepId is now typed to potential enum values.
 
 ### Version 0.4.1
 
-- Bug fix for onProgress callback not being triggered from the TaxBitDAC7Form component.
+1. Bug fix for onProgress callback not being triggered from the TaxbitDPSQuestionnaire component.
 
 ### Version 0.4.0
 
-- Added onProgress callback.
-- Showing multiple errors for DAC7 Tax residency when the case arises.
+1. Added onProgress callback.
+2. Showing multiple errors for DAC7 Tax residency when the case arises.
 
 ### Version 0.3.0
 
-- Added business registration questions to the form.
-- Added confirmation checkbox to the summary screen before submission.
+1. Added business registration questions to the form.
+2. Added confirmation checkbox to the summary screen before submission.
 
 ### Version 0.2.4
 
-- Bug fix for naming of CommonJS module exports.
+1. Bug fix for naming of CommonJS module exports.
 
 ### Version 0.2.3
 
-- Bug fix for the ClientTaxDocumentationStatus type not being accessible externally.
+1. Bug fix for the ClientTaxDocumentationStatus type not being accessible externally.
 
 ### Version 0.2.2
 
-- onSubmit and onSuccess callbacks are invoked with a parameter of type ClientTaxDocumentation which is now exposed.
+1. onSubmit and onSuccess callbacks are invoked with a parameter of type ClientTaxDocumentation which is now exposed.
 
 ### Version 0.2.1
 
-- The SDK now supports React versions 16, 17, and 18 and TypeScript versions 4 and 5.
+1. The SDK now supports React versions 16, 17, and 18 and TypeScript versions 4 and 5.
 
 ### Version 0.2.0
 
-- Fix in package.json to expose UMD module as main.
-- Added specific CSS class names for each question and each screen of the form.
-- Added the new status structure into the useTaxBit hook.
-- TaxBitDAC7Form component will now preload the form with previously submitted data.
-- Validation update to enforce that primary address country and tax residence country are the same.
+1. Fix in package.json to expose UMD module as main.
+2. Added specific CSS class names for each question and each screen of the form.
+3. Added the new status structure into the useTaxbit hook.
+4. TaxbitDPSQuestionnaire component will now preload the form with previously submitted data.
+5. Validation update to enforce that primary address country and tax residence country are the same.

package/dist/src/components/Address/Address.d.ts

@@ -1,10 +1,9 @@
 import React from 'react';
-import type { CaProvinceCode, UsStateCode } from 'types';
 type AddressParts = {
     street?: string;
     street2?: string;
     city?: string;
-    state?: string | UsStateCode | CaProvinceCode;
+    state?: string;
     zip?: string;
     country?: string;
 };

package/dist/src/components/ErrorMessage/ErrorMessage.d.ts

@@ -1,6 +1,5 @@
 import React from 'react';
 import { TaxDocumentationKey } from 'types';
-export declare const ErrorMessage: ({ name, hint, }: {
+export declare const ErrorMessage: ({ name }: {
     name: TaxDocumentationKey;
-    hint?: true | undefined;
 }) => React.JSX.Element | null;

package/dist/src/components/Form/Form.d.ts

@@ -1,9 +1,10 @@
 import React from 'react';
 type FormProps = {
     title: string;
+    subTitle?: string;
     className?: string;
     children: React.ReactNode;
     actions?: React.ReactNode;
 };
-export declare const Form: ({ children, title, actions, className }: FormProps) => React.JSX.Element;
+export declare const Form: ({ children, title, subTitle, actions, className, }: FormProps) => React.JSX.Element;
 export {};

package/dist/src/components/Form/index.d.ts

@@ -1 +1 @@
-export * from './Form.tsx';
+export * from './Form';

package/dist/src/contexts/QuestionnaireUI/QuestionnaireUIProvider.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+type FormUIProviderProps = {
+    children: React.ReactNode;
+};
+export declare const QuestionnaireUIProvider: ({ children }: FormUIProviderProps) => React.JSX.Element;
+export {};

package/dist/src/contexts/QuestionnaireUI/getLocal.d.ts

@@ -0,0 +1,19 @@
+import { ButtonKey, ErrorKey, PromptKey, SubPromptKey, SubTitleKey, TextKey } from '../../i18n/types';
+import { Locale, TaxDocumentation, TaxDocumentationKey } from '../../types';
+export declare const getLocal: (fields: TaxDocumentation, language: Locale) => {
+    getLocalText: (key: TextKey) => string;
+    getLocalTitle: (key: string) => string;
+    getLocalSubTitle: (key: SubTitleKey) => string;
+    getLocalError: (key: ErrorKey) => string;
+    getLocalButton: (key: ButtonKey) => string;
+    getLocalPrompt: (key: string) => string;
+    getLocalSubPrompt: (key: TaxDocumentationKey) => string;
+    getLocalOption: (key: string | undefined) => string | undefined;
+    getLocalSubOption: (key: string | undefined) => string | undefined;
+    getLocalCountry: (key: string | undefined) => string;
+    getLocalUsState: (key: string | undefined) => "" | "Guam" | "Puerto Rico" | "Alabama" | "Alaska" | "American Samoa" | "Arizona" | "Arkansas" | "California" | "Colorado" | "Connecticut" | "Delaware" | "District Of Columbia" | "Federated States Of Micronesia" | "Florida" | "Georgia" | "Hawaii" | "Idaho" | "Illinois" | "Indiana" | "Iowa" | "Kansas" | "Kentucky" | "Louisiana" | "Maine" | "Marshall Islands" | "Maryland" | "Massachusetts" | "Michigan" | "Minnesota" | "Mississippi" | "Missouri" | "Montana" | "Nebraska" | "Nevada" | "New Hampshire" | "New Jersey" | "New Mexico" | "New York" | "North Carolina" | "North Dakota" | "Northern Mariana Islands" | "Ohio" | "Oklahoma" | "Oregon" | "Outlying Islands" | "Palau" | "Pennsylvania" | "Rhode Island" | "South Carolina" | "South Dakota" | "Tennessee" | "Texas" | "Utah" | "Vermont" | "Virgin Islands" | "Virginia" | "Washington" | "West Virginia" | "Wisconsin" | "Wyoming";
+    getLocalCaProvince: (key: string | undefined) => string;
+    getLocalMonth: (key: string | undefined) => string;
+    getPromptKey: (key: string) => PromptKey;
+    getSubPromptKey: (key: string) => SubPromptKey;
+};

package/dist/src/contexts/{FormUI → QuestionnaireUI}/index.d.ts

@@ -1,4 +1,4 @@
-import type { TaxDocumentationErrorFile, TaxDocumentationPropertyFile } from './useFormUI';
-export * from './FormUIProvider';
-export * from './useFormUIContext';
+import type { TaxDocumentationErrorFile, TaxDocumentationPropertyFile } from './useQuestionnaireUI';
+export * from './QuestionnaireUIProvider';
+export * from './useQuestionnaireUIContext';
 export { TaxDocumentationErrorFile, TaxDocumentationPropertyFile };

package/dist/src/contexts/{FormUI/useFormUI.d.ts → QuestionnaireUI/useQuestionnaireUI.d.ts}

@@ -8,26 +8,26 @@ export type TaxDocumentationPropertyFile = {
 export type TaxDocumentationErrorFile = {
     [key in TaxDocumentationKey]?: ErrorKey[];
 };
-export declare const useFormUI: () => {
+export declare const useQuestionnaireUI: () => {
     config: {
         minimumAge: number;
     } | undefined;
-    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 | keyof import("types").CalculatedData) => string | undefined;
+    language: "bg" | "cs" | "da" | "de" | "de-at" | "el" | "el-cy" | "en" | "en-gb" | "en-nz" | "en-us" | "es" | "et" | "fi" | "fr" | "fr-ca" | "fr-lu" | "ga" | "hr" | "hu" | "it" | "lt" | "lv" | "mt" | "nl" | "nl-be" | "no" | "pl" | "pt" | "ro" | "sk" | "sl" | "sv";
     getLocalText: (key: import("i18n/types").TextKey) => string;
     getLocalTitle: (key: string) => string;
-    getLocalSubTitle: (key: "taxResidences") => string;
+    getLocalSubTitle: (key: import("i18n/types").SubTitleKey) => string;
     getLocalError: (key: ErrorKey) => string;
     getLocalButton: (key: import("i18n/types").ButtonKey) => 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 | keyof import("types").CalculatedData) => string;
     getLocalOption: (key: string | undefined) => string | undefined;
+    getLocalSubOption: (key: string | undefined) => string | undefined;
     getLocalCountry: (key: string | undefined) => string;
-    getLocalUsState: (key: string | undefined) => string;
+    getLocalUsState: (key: string | undefined) => "" | "Guam" | "Puerto Rico" | "Alabama" | "Alaska" | "American Samoa" | "Arizona" | "Arkansas" | "California" | "Colorado" | "Connecticut" | "Delaware" | "District Of Columbia" | "Federated States Of Micronesia" | "Florida" | "Georgia" | "Hawaii" | "Idaho" | "Illinois" | "Indiana" | "Iowa" | "Kansas" | "Kentucky" | "Louisiana" | "Maine" | "Marshall Islands" | "Maryland" | "Massachusetts" | "Michigan" | "Minnesota" | "Mississippi" | "Missouri" | "Montana" | "Nebraska" | "Nevada" | "New Hampshire" | "New Jersey" | "New Mexico" | "New York" | "North Carolina" | "North Dakota" | "Northern Mariana Islands" | "Ohio" | "Oklahoma" | "Oregon" | "Outlying Islands" | "Palau" | "Pennsylvania" | "Rhode Island" | "South Carolina" | "South Dakota" | "Tennessee" | "Texas" | "Utah" | "Vermont" | "Virgin Islands" | "Virginia" | "Washington" | "West Virginia" | "Wisconsin" | "Wyoming";
     getLocalCaProvince: (key: string | undefined) => string;
     getLocalMonth: (key: string | undefined) => string;
-    getHintKey: (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) => "dateOfBirth";
     getPromptKey: (key: string) => import("i18n/types").PromptKey;
-    getSubPromptKey: (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) => import("i18n/types").SubPromptKey;
+    getSubPromptKey: (key: string) => import("i18n/types").SubPromptKey;
     clearIfNotRequired: (...arg: TaxDocumentationKey[]) => (value: Yes | undefined) => void;
     fields: TaxDocumentation;
     setFields: import("react").Dispatch<import("react").SetStateAction<TaxDocumentation>>;

package/dist/src/contexts/{FormUI/useFormUIContext.d.ts → QuestionnaireUI/useQuestionnaireUIContext.d.ts}

@@ -1,24 +1,24 @@
 /// <reference types="react" />
-export declare const useFormUIContext: () => {
+export declare const useQuestionnaireUIContext: () => {
     config: {
         minimumAge: number;
     } | undefined;
-    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 | keyof import("../../types").CalculatedData) => string | undefined;
+    language: "bg" | "cs" | "da" | "de" | "de-at" | "el" | "el-cy" | "en" | "en-gb" | "en-nz" | "en-us" | "es" | "et" | "fi" | "fr" | "fr-ca" | "fr-lu" | "ga" | "hr" | "hu" | "it" | "lt" | "lv" | "mt" | "nl" | "nl-be" | "no" | "pl" | "pt" | "ro" | "sk" | "sl" | "sv";
     getLocalText: (key: import("../../i18n/types").TextKey) => string;
     getLocalTitle: (key: string) => string;
-    getLocalSubTitle: (key: "taxResidences") => string;
+    getLocalSubTitle: (key: import("../../i18n/types").SubTitleKey) => string;
     getLocalError: (key: import("../../i18n/types").ErrorKey) => string;
     getLocalButton: (key: import("../../i18n/types").ButtonKey) => 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 | keyof import("../../types").CalculatedData) => string;
     getLocalOption: (key: string | undefined) => string | undefined;
+    getLocalSubOption: (key: string | undefined) => string | undefined;
     getLocalCountry: (key: string | undefined) => string;
-    getLocalUsState: (key: string | undefined) => string;
+    getLocalUsState: (key: string | undefined) => "" | "Guam" | "Puerto Rico" | "Alabama" | "Alaska" | "American Samoa" | "Arizona" | "Arkansas" | "California" | "Colorado" | "Connecticut" | "Delaware" | "District Of Columbia" | "Federated States Of Micronesia" | "Florida" | "Georgia" | "Hawaii" | "Idaho" | "Illinois" | "Indiana" | "Iowa" | "Kansas" | "Kentucky" | "Louisiana" | "Maine" | "Marshall Islands" | "Maryland" | "Massachusetts" | "Michigan" | "Minnesota" | "Mississippi" | "Missouri" | "Montana" | "Nebraska" | "Nevada" | "New Hampshire" | "New Jersey" | "New Mexico" | "New York" | "North Carolina" | "North Dakota" | "Northern Mariana Islands" | "Ohio" | "Oklahoma" | "Oregon" | "Outlying Islands" | "Palau" | "Pennsylvania" | "Rhode Island" | "South Carolina" | "South Dakota" | "Tennessee" | "Texas" | "Utah" | "Vermont" | "Virgin Islands" | "Virginia" | "Washington" | "West Virginia" | "Wisconsin" | "Wyoming";
     getLocalCaProvince: (key: string | undefined) => string;
     getLocalMonth: (key: string | undefined) => string;
-    getHintKey: (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) => "dateOfBirth";
     getPromptKey: (key: string) => import("../../i18n/types").PromptKey;
-    getSubPromptKey: (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) => import("../../i18n/types").SubPromptKey;
+    getSubPromptKey: (key: string) => import("../../i18n/types").SubPromptKey;
     clearIfNotRequired: (...arg: (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: "yes" | undefined) => void;
     fields: import("../../types").TaxDocumentation;
     setFields: import("react").Dispatch<import("react").SetStateAction<import("../../types").TaxDocumentation>>;
@@ -30,31 +30,31 @@ export declare const useFormUIContext: () => {
     hideErrors: () => void;
     hasChangedData: boolean;
     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;
-    visibleFields: import("./useFormUI").TaxDocumentationPropertyFile;
-    invalidFields: import("./useFormUI").TaxDocumentationErrorFile;
-    requiredFields: import("./useFormUI").TaxDocumentationPropertyFile;
+    visibleFields: import("./useQuestionnaireUI").TaxDocumentationPropertyFile;
+    invalidFields: import("./useQuestionnaireUI").TaxDocumentationErrorFile;
+    requiredFields: import("./useQuestionnaireUI").TaxDocumentationPropertyFile;
     hideField: (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) => void;
     showField: (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) => void;
-}, FormUIContextProvider: import("react").Provider<{
+}, QuestionnaireUIContextProvider: import("react").Provider<{
     config: {
         minimumAge: number;
     } | undefined;
-    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 | keyof import("../../types").CalculatedData) => string | undefined;
+    language: "bg" | "cs" | "da" | "de" | "de-at" | "el" | "el-cy" | "en" | "en-gb" | "en-nz" | "en-us" | "es" | "et" | "fi" | "fr" | "fr-ca" | "fr-lu" | "ga" | "hr" | "hu" | "it" | "lt" | "lv" | "mt" | "nl" | "nl-be" | "no" | "pl" | "pt" | "ro" | "sk" | "sl" | "sv";
     getLocalText: (key: import("../../i18n/types").TextKey) => string;
     getLocalTitle: (key: string) => string;
-    getLocalSubTitle: (key: "taxResidences") => string;
+    getLocalSubTitle: (key: import("../../i18n/types").SubTitleKey) => string;
     getLocalError: (key: import("../../i18n/types").ErrorKey) => string;
     getLocalButton: (key: import("../../i18n/types").ButtonKey) => 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 | keyof import("../../types").CalculatedData) => string;
     getLocalOption: (key: string | undefined) => string | undefined;
+    getLocalSubOption: (key: string | undefined) => string | undefined;
     getLocalCountry: (key: string | undefined) => string;
-    getLocalUsState: (key: string | undefined) => string;
+    getLocalUsState: (key: string | undefined) => "" | "Guam" | "Puerto Rico" | "Alabama" | "Alaska" | "American Samoa" | "Arizona" | "Arkansas" | "California" | "Colorado" | "Connecticut" | "Delaware" | "District Of Columbia" | "Federated States Of Micronesia" | "Florida" | "Georgia" | "Hawaii" | "Idaho" | "Illinois" | "Indiana" | "Iowa" | "Kansas" | "Kentucky" | "Louisiana" | "Maine" | "Marshall Islands" | "Maryland" | "Massachusetts" | "Michigan" | "Minnesota" | "Mississippi" | "Missouri" | "Montana" | "Nebraska" | "Nevada" | "New Hampshire" | "New Jersey" | "New Mexico" | "New York" | "North Carolina" | "North Dakota" | "Northern Mariana Islands" | "Ohio" | "Oklahoma" | "Oregon" | "Outlying Islands" | "Palau" | "Pennsylvania" | "Rhode Island" | "South Carolina" | "South Dakota" | "Tennessee" | "Texas" | "Utah" | "Vermont" | "Virgin Islands" | "Virginia" | "Washington" | "West Virginia" | "Wisconsin" | "Wyoming";
     getLocalCaProvince: (key: string | undefined) => string;
     getLocalMonth: (key: string | undefined) => string;
-    getHintKey: (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) => "dateOfBirth";
     getPromptKey: (key: string) => import("../../i18n/types").PromptKey;
-    getSubPromptKey: (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) => import("../../i18n/types").SubPromptKey;
+    getSubPromptKey: (key: string) => import("../../i18n/types").SubPromptKey;
     clearIfNotRequired: (...arg: (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: "yes" | undefined) => void;
     fields: import("../../types").TaxDocumentation;
     setFields: import("react").Dispatch<import("react").SetStateAction<import("../../types").TaxDocumentation>>;
@@ -66,9 +66,9 @@ export declare const useFormUIContext: () => {
     hideErrors: () => void;
     hasChangedData: boolean;
     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;
-    visibleFields: import("./useFormUI").TaxDocumentationPropertyFile;
-    invalidFields: import("./useFormUI").TaxDocumentationErrorFile;
-    requiredFields: import("./useFormUI").TaxDocumentationPropertyFile;
+    visibleFields: import("./useQuestionnaireUI").TaxDocumentationPropertyFile;
+    invalidFields: import("./useQuestionnaireUI").TaxDocumentationErrorFile;
+    requiredFields: import("./useQuestionnaireUI").TaxDocumentationPropertyFile;
     hideField: (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) => void;
     showField: (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) => void;
 } | undefined>;

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

@@ -0,0 +1,7 @@
+import React from 'react';
+import { UseTaxDocumentationProps } from './useTaxDocumentation';
+type TaxDocumentationProviderProps = UseTaxDocumentationProps & {
+    children: React.ReactNode;
+};
+export declare const TaxbitQuestionnaireProvider: ({ data, externalValidations, onSubmit, onProgress, language, questionnaire, step, children, config, }: TaxDocumentationProviderProps) => React.JSX.Element;
+export {};

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

@@ -1,3 +1,3 @@
-export * from './TaxBitFormProvider';
+export * from './TaxbitQuestionnaireProvider';
 export type { UseTaxDocumentationProps } from './useTaxDocumentation';
 export * from './useTaxDocumentationContext';

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

@@ -1,7 +1,8 @@
 /// <reference types="react" />
-import type { InputStep, Locale, Progress, TaxDocumentation, TaxForm } from 'types';
+import { ClientTaxDocumentation } from '@taxbit/utilities';
+import type { InputStep, Locale, Progress, Questionnaire, TaxDocumentation } from 'types';
 import type { StepId } from 'types/StepId';
-import { ClientTaxDocumentation, ExternalValidations } from 'types/client';
+import { ExternalValidations } from 'types/client';
 type InterviewConfig = {
     minimumAge: number;
 };
@@ -12,16 +13,12 @@ export type UseTaxDocumentationProps = {
     onSubmit: (data: ClientTaxDocumentation) => void | Promise<void>;
     onProgress?: (progress: Progress) => void | Promise<void>;
     step?: InputStep;
-    taxForms?: TaxForm[];
+    questionnaire?: Questionnaire;
     config?: InterviewConfig;
 };
-export declare const useTaxDocumentation: ({ data: startingData, language: initialLanguage, externalValidations, onSubmit, onProgress, step: initialStep, taxForms: supportedForms, config, }: UseTaxDocumentationProps) => {
-    isW9: boolean;
-    isW8: boolean;
-    isW8Ben: boolean;
-    isW8BenE: boolean;
-    isDac7: boolean;
-    onPersistAccountHolderData: (newData: TaxDocumentation) => void;
+export declare const useTaxDocumentation: ({ data: startingData, language: initialLanguage, externalValidations, onSubmit, onProgress, step: initialStep, questionnaire, config, }: UseTaxDocumentationProps) => {
+    isBuildingW9: boolean;
+    isBuildingW8: boolean;
     onPersistCollectedData: (newData: TaxDocumentation) => void;
     onSubmitTaxDocumentation: (data: TaxDocumentation) => void;
     error: string | undefined;
@@ -32,14 +29,15 @@ export declare const useTaxDocumentation: ({ data: startingData, language: initi
     goBack: (() => void) | undefined;
     goToNext: (data: TaxDocumentation) => void;
     progress: Progress | undefined;
-    stepName: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Confirmation" | "Exemptions" | "RegardedOwnerClassification" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary";
+    stepName: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Confirmation" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary";
     data: TaxDocumentation;
     originalClientData: TaxDocumentation;
-    initialStep: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Confirmation" | "Exemptions" | "RegardedOwnerClassification" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary";
-    setLanguage: import("react").Dispatch<import("react").SetStateAction<"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">>;
-    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[];
+    initialStep: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Confirmation" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary";
+    setLanguage: import("react").Dispatch<import("react").SetStateAction<"bg" | "cs" | "da" | "de" | "de-at" | "el" | "el-cy" | "en" | "en-gb" | "en-nz" | "en-us" | "es" | "et" | "fi" | "fr" | "fr-ca" | "fr-lu" | "ga" | "hr" | "hu" | "it" | "lt" | "lv" | "mt" | "nl" | "nl-be" | "no" | "pl" | "pt" | "ro" | "sk" | "sl" | "sv">>;
+    language: "bg" | "cs" | "da" | "de" | "de-at" | "el" | "el-cy" | "en" | "en-gb" | "en-nz" | "en-us" | "es" | "et" | "fi" | "fr" | "fr-ca" | "fr-lu" | "ga" | "hr" | "hu" | "it" | "lt" | "lv" | "mt" | "nl" | "nl-be" | "no" | "pl" | "pt" | "ro" | "sk" | "sl" | "sv";
+    questionnaire: Questionnaire;
     externalValidations: ExternalValidations | undefined;
     config: InterviewConfig | undefined;
+    isSubmitting: boolean;
 };
 export {};