@taxbit/react-sdk 1.0.0-beta.7 → 1.1.0-beta.0

package/README.md

@@ -81,7 +81,7 @@ The `questionnaire` prop determines the UI of the component. The `questionnaire`
 />
 ```
 
-For W-9 W-8BEN and W-8BEN-E forms, the `questionnaire` prop is set like this...
+For W-9, W-8BEN, and W-8BEN-E forms, the `questionnaire` prop is set like this...
 
 ```jsx
 <TaxbitQuestionnaire
@@ -89,6 +89,7 @@ For W-9 W-8BEN and W-8BEN-E forms, the `questionnaire` prop is set like this...
   bearerToken="bearer token goes here"
   questionnaire="W-FORM"
   language="en" // 'en' is the default
+  treatyClaims={true} // 'treatyClaims' is an optional path for the W-8BEN and W-8BEN-E forms
 />
 ```
 
@@ -117,6 +118,10 @@ The WForm component language can be set to 'en', 'fr', or 'es'.
 
 See the `Locale` type below.
 
+### Treaty Claims
+
+To collect treaty claims for the W-8BEN and W-8BEN-E forms, the `treatyClaims` prop can be set to `true`. This will add a screen to the W-8 flow where an eligible user can enter treaty claim specifics including the treaty country and rate of withholding.
+
 ## useTaxbit Hook
 
 The `useTaxbit` hook can be used to get the data from the server or the account status.
@@ -234,7 +239,7 @@ The Taxbit React SDK provides callbacks for the following events on the `TaxbitQ
 
 #### Error Boundary
 
-A basic React Error Boundary is in place and when an error is thrown, the TaxbitQuestionnaire component will display errors on screen and throw an error in console. The exceptions that are possible are related to fetching data from the server, such as authentication (401 Unauthorized) or network problems (Failed to fetch). An error is also thrown if the bearer token is missing (Bearer Token is required). If the `onError` callback is provided to the component or the hook, these errors will be caught not and the error boundary will not be displayed.
+A basic React Error Boundary is in place and when an error is thrown, the TaxbitQuestionnaire component will display errors on screen and throw an error in console. The exceptions that are possible are related to fetching data from the server, such as authentication (401 Unauthorized) or network problems (Failed to fetch). An error is also thrown if the bearer token is missing (Bearer Token is required). If the `onError` callback is provided to the component or the hook, these errors will be caught and passed to the callback. The error boundary will not be displayed.
 
 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.
 
@@ -255,11 +260,13 @@ type Locale =
   | 'el-cy'
   | 'en'
   | 'en-gb'
+  | 'en-nz'
   | 'en-us'
   | 'es'
   | 'et'
   | 'fi'
   | 'fr'
+  | 'fr-ca'
   | 'fr-lu'
   | 'ga'
   | 'hr'
@@ -311,10 +318,19 @@ type QuestionnaireType = 'DPS' | 'W-FORM';
 
 ## Changelog
 
+### Version 1.1.0-beta.0
+
+1. Treaty Claims can now be collected for the W-8BEN and W-8BEN-E forms.
+
+### Version 1.0.0-beta.8
+
+1. Signature confirmation is more flexible with spaces.
+2. Fixed checkbox issue with certification upon submission.
+
 ### Version 1.0.0-beta.7
 
 1. BearerToken and Fetch errors are now sent only to the console, no longer thrown and bubbled up.
-2. 2Added an `error` object to the 'useTaxbit' hook.
+2. Added an `error` object to the 'useTaxbit' hook.
 
 ### Version 1.0.0-beta.6
 

package/dist/index.d.ts

@@ -1 +1 @@
-export * from './src/entry/index'
+export * from './src'

package/dist/src/App.d.ts

@@ -1,2 +1,3 @@
-import React from 'react';
+import { default as React } from 'react';
+
 export declare const App: () => React.JSX.Element;

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

@@ -1,4 +1,5 @@
-import React from 'react';
+import { default as React } from 'react';
+
 type AddressParts = {
     street?: string;
     street2?: string;

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

@@ -1 +1 @@
-export * from "./Address";
+export * from './Address';

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

@@ -1,4 +1,5 @@
-import React from 'react';
+import { default as React } from 'react';
+
 export declare const ErrorAlert: ({ message }: {
-    message?: string | undefined;
+    message?: string;
 }) => React.JSX.Element;

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

@@ -1,4 +1,5 @@
-import React, { Component, ReactNode } from 'react';
+import { default as React, Component, ReactNode } from 'react';
+
 interface Props {
     children?: ReactNode;
 }

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

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

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

@@ -1 +1 @@
-export * from "./ErrorMessage";
+export * from './ErrorMessage';

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

@@ -1,4 +1,5 @@
-import React from 'react';
+import { default as React } from 'react';
+
 type FormProps = {
     title: string;
     subTitle?: string;

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

@@ -1,5 +1,6 @@
-import React from "react";
+import { default as React } from 'react';
+
 export declare const InputStatus: ({ children, className, }: {
-    className?: string | undefined;
+    className?: string;
     children: React.ReactNode;
 }) => React.JSX.Element;

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

@@ -1 +1 @@
-export * from "./InputStatus";
+export * from './InputStatus';

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

@@ -0,0 +1,5 @@
+import { default as React } from 'react';
+
+export declare const JsxFromString: ({ val }: {
+    val?: string;
+}) => React.ReactNode[] | null;

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

@@ -0,0 +1 @@
+export * from './JsxFromString.tsx';

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

@@ -1,5 +1,6 @@
-import React from 'react';
+import { default as React } from 'react';
 import { Progress } from '../../types';
+
 export declare const ProgressStatus: ({ progress }: {
-    progress?: Progress | undefined;
+    progress?: Progress;
 }) => React.JSX.Element | null;

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

@@ -1,5 +1,6 @@
-import React from 'react';
+import { default as React } from 'react';
 import { TaxDocumentationKey } from 'types/TaxDocumentation';
+
 export type RowProps = {
     label?: string;
     subLabel?: string;

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

@@ -1 +1 @@
-export * from "./Row";
+export * from './Row';

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

@@ -1,4 +1,5 @@
-import React from 'react';
+import { default as React } from 'react';
+
 type SectionProps = {
     title?: string;
     subTitle?: string;

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

@@ -1 +1 @@
-export * from "./Section";
+export * from './Section';

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

@@ -4,6 +4,7 @@ export * from './ErrorBoundary';
 export * from './ErrorMessage';
 export * from './Form';
 export * from './InputStatus';
+export * from './JsxFromString';
 export * from './ProgressStatus';
 export * from './Row';
 export * from './Section';

package/dist/src/contexts/QuestionnaireStep/QuestionnaireStepProvider.d.ts

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

package/dist/src/contexts/{QuestionnaireUI → QuestionnaireStep}/getLocal.d.ts

@@ -1,5 +1,6 @@
 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;

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

@@ -0,0 +1,5 @@
+import { TaxDocumentationErrorFile, TaxDocumentationPropertyFile } from './useQuestionnaireStep';
+
+export * from './QuestionnaireStepProvider';
+export * from './useQuestionnaireStepContext';
+export { TaxDocumentationErrorFile, TaxDocumentationPropertyFile };

package/dist/src/contexts/{QuestionnaireUI → QuestionnaireStep}/shiftResidence.d.ts

@@ -1,2 +1,3 @@
 import { TaxDocumentation } from '../../types';
-export declare const shiftResidence: (fields: TaxDocumentation, index: 2 | 3 | 4) => TaxDocumentation;
+
+export declare const shiftResidence: (fields: TaxDocumentation, index: 1 | 2 | 3 | 4) => TaxDocumentation;

package/dist/src/contexts/{QuestionnaireUI/useQuestionnaireUI.d.ts → QuestionnaireStep/useQuestionnaireStep.d.ts}

@@ -1,42 +1,37 @@
-/// <reference types="react" />
 import { ErrorKey } from 'i18n/types';
 import { Yes } from 'types';
 import { TaxDocumentation, TaxDocumentationKey } from 'types/TaxDocumentation';
+
 export type TaxDocumentationPropertyFile = {
     [key in TaxDocumentationKey]: boolean;
 };
 export type TaxDocumentationErrorFile = {
     [key in TaxDocumentationKey]?: ErrorKey[];
 };
-export declare const useQuestionnaireUI: () => {
-    config: {
-        minimumAge: number;
-    } | undefined;
-    language: import("types").Locale;
-    getLocalText: (key: import("i18n/types").TextKey) => string;
+export declare const useQuestionnaireStep: () => {
+    getLocalText: (key: import('i18n/types').TextKey) => string;
     getLocalTitle: (key: string) => string;
-    getLocalSubTitle: (key: import("i18n/types").SubTitleKey) => string;
+    getLocalSubTitle: (key: import('i18n/types').SubTitleKey) => string;
     getLocalError: (key: ErrorKey) => string;
-    getLocalButton: (key: import("i18n/types").ButtonKey) => 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;
+    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) => import("i18n/types").PromptKey;
-    getSubPromptKey: (key: string) => import("i18n/types").SubPromptKey;
+    getPromptKey: (key: string) => import('i18n/types').PromptKey;
+    getSubPromptKey: (key: string) => import('i18n/types').SubPromptKey;
     clearIfNotRequired: (...arg: TaxDocumentationKey[]) => (value: Yes | undefined) => void;
     fields: TaxDocumentation;
-    setFields: import("react").Dispatch<import("react").SetStateAction<TaxDocumentation>>;
     setValue: (key: TaxDocumentationKey, value: string | undefined) => void;
     isErrorFree: boolean;
-    showErrors: boolean;
-    showErrorsForField: (key: TaxDocumentationKey) => boolean | undefined;
-    exposeErrors: () => void;
+    isShowingErrors: boolean;
+    isShowingErrorsForField: (key: TaxDocumentationKey) => boolean | undefined;
     hideErrors: () => void;
+    showErrors: () => void;
     hasChangedData: boolean;
     getRequiredLocalPrompt: (key: TaxDocumentationKey) => string;
     visibleFields: TaxDocumentationPropertyFile;

package/dist/src/contexts/QuestionnaireStep/useQuestionnaireStepContext.d.ts

@@ -0,0 +1,63 @@
+export declare const useQuestionnaireStepContext: () => {
+    getLocalText: (key: import('../../i18n/types/LocalizationKey.ts').TextKey) => string;
+    getLocalTitle: (key: string) => string;
+    getLocalSubTitle: (key: import('../../i18n/types/LocalizationKey.ts').SubTitleKey) => string;
+    getLocalError: (key: import('../../i18n/types/LocalizationKey.ts').ErrorKey) => string;
+    getLocalButton: (key: import('../../i18n/types/LocalizationKey.ts').ButtonKey) => string;
+    getLocalPrompt: (key: string) => string;
+    getLocalSubPrompt: (key: import('../../types/TaxDocumentation.ts').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) => import('../../i18n/types/LocalizationKey.ts').PromptKey;
+    getSubPromptKey: (key: string) => import('../../i18n/types/LocalizationKey.ts').SubPromptKey;
+    clearIfNotRequired: (...arg: import('../../types/TaxDocumentation.ts').TaxDocumentationKey[]) => (value: import('../../types/Yes.ts').Yes | undefined) => void;
+    fields: import('../../types/TaxDocumentation.ts').TaxDocumentation;
+    setValue: (key: import('../../types/TaxDocumentation.ts').TaxDocumentationKey, value: string | undefined) => void;
+    isErrorFree: boolean;
+    isShowingErrors: boolean;
+    isShowingErrorsForField: (key: import('../../types/TaxDocumentation.ts').TaxDocumentationKey) => boolean | undefined;
+    hideErrors: () => void;
+    showErrors: () => void;
+    hasChangedData: boolean;
+    getRequiredLocalPrompt: (key: import('../../types/TaxDocumentation.ts').TaxDocumentationKey) => string;
+    visibleFields: import('./useQuestionnaireStep.ts').TaxDocumentationPropertyFile;
+    invalidFields: import('./useQuestionnaireStep.ts').TaxDocumentationErrorFile;
+    requiredFields: import('./useQuestionnaireStep.ts').TaxDocumentationPropertyFile;
+    hideField: (key: import('../../types/TaxDocumentation.ts').TaxDocumentationKey) => void;
+    showField: (key: import('../../types/TaxDocumentation.ts').TaxDocumentationKey) => void;
+}, QuestionnaireStepContextProvider: import('react').Provider<{
+    getLocalText: (key: import('../../i18n/types/LocalizationKey.ts').TextKey) => string;
+    getLocalTitle: (key: string) => string;
+    getLocalSubTitle: (key: import('../../i18n/types/LocalizationKey.ts').SubTitleKey) => string;
+    getLocalError: (key: import('../../i18n/types/LocalizationKey.ts').ErrorKey) => string;
+    getLocalButton: (key: import('../../i18n/types/LocalizationKey.ts').ButtonKey) => string;
+    getLocalPrompt: (key: string) => string;
+    getLocalSubPrompt: (key: import('../../types/TaxDocumentation.ts').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) => import('../../i18n/types/LocalizationKey.ts').PromptKey;
+    getSubPromptKey: (key: string) => import('../../i18n/types/LocalizationKey.ts').SubPromptKey;
+    clearIfNotRequired: (...arg: import('../../types/TaxDocumentation.ts').TaxDocumentationKey[]) => (value: import('../../types/Yes.ts').Yes | undefined) => void;
+    fields: import('../../types/TaxDocumentation.ts').TaxDocumentation;
+    setValue: (key: import('../../types/TaxDocumentation.ts').TaxDocumentationKey, value: string | undefined) => void;
+    isErrorFree: boolean;
+    isShowingErrors: boolean;
+    isShowingErrorsForField: (key: import('../../types/TaxDocumentation.ts').TaxDocumentationKey) => boolean | undefined;
+    hideErrors: () => void;
+    showErrors: () => void;
+    hasChangedData: boolean;
+    getRequiredLocalPrompt: (key: import('../../types/TaxDocumentation.ts').TaxDocumentationKey) => string;
+    visibleFields: import('./useQuestionnaireStep.ts').TaxDocumentationPropertyFile;
+    invalidFields: import('./useQuestionnaireStep.ts').TaxDocumentationErrorFile;
+    requiredFields: import('./useQuestionnaireStep.ts').TaxDocumentationPropertyFile;
+    hideField: (key: import('../../types/TaxDocumentation.ts').TaxDocumentationKey) => void;
+    showField: (key: import('../../types/TaxDocumentation.ts').TaxDocumentationKey) => void;
+} | undefined>;

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

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

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

@@ -1,7 +1,7 @@
 import { ClientTaxDocumentation } from '@taxbit/utilities';
-import type { InputStep, Locale, Progress, Questionnaire, TaxDocumentation } from 'types';
-import type { StepId } from 'types/StepId';
+import { InputStep, Locale, Progress, Questionnaire, TaxDocumentation } from 'types';
 import { ExternalValidations } from 'types/client';
+
 type InterviewConfig = {
     minimumAge: number;
 };
@@ -14,28 +14,27 @@ export type UseTaxDocumentationProps = {
     step?: InputStep;
     questionnaire: Questionnaire;
     config?: InterviewConfig;
+    treatyClaims?: boolean;
 };
-export declare const useTaxDocumentation: ({ data: startingData, language: initialLanguage, externalValidations, onSubmit, onProgress, step: initialStep, questionnaire, config, }: UseTaxDocumentationProps) => {
+export declare const useTaxDocumentation: ({ data: startingData, language: initialLanguage, externalValidations, onSubmit, onProgress, step: initialStep, questionnaire, config, treatyClaims, }: UseTaxDocumentationProps) => {
     isBuildingW9: boolean;
     isBuildingW8: boolean;
     onPersistCollectedData: (newData: TaxDocumentation) => void;
     onSubmitTaxDocumentation: (data: TaxDocumentation) => Promise<void>;
-    editTo: (form: InputStep) => void;
-    onCancel: (() => void) | undefined;
-    getStepId: (key: InputStep) => StepId;
-    goTo: (form: InputStep) => void;
+    goTo: (inputStep: InputStep) => void;
     goBack: (() => void) | undefined;
     goToNext: (data: TaxDocumentation) => void;
     progress: Progress | undefined;
-    stepName: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary";
+    stepName: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "AccountHolderTreatyClaims" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary" | "W8imyInstructions";
     data: TaxDocumentation;
     originalClientData: TaxDocumentation;
-    initialStep: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary";
+    initialStep: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "AccountHolderTreatyClaims" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary" | "W8imyInstructions";
     setLanguage: (lang: Locale) => void;
     language: Locale;
     questionnaire: Questionnaire;
     externalValidations: ExternalValidations | undefined;
     config: InterviewConfig | undefined;
     isSubmitting: boolean;
+    treatyClaims: boolean | undefined;
 };
 export {};

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

@@ -1,50 +1,45 @@
-/// <reference types="react" />
 export declare const useTaxDocumentationContext: () => {
     isBuildingW9: boolean;
     isBuildingW8: boolean;
-    onPersistCollectedData: (newData: import("../../types").TaxDocumentation) => void;
-    onSubmitTaxDocumentation: (data: import("../../types").TaxDocumentation) => Promise<void>;
-    editTo: (form: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary") => void;
-    onCancel: (() => void) | undefined;
-    getStepId: (key: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary") => import("../../types/StepId").StepId;
-    goTo: (form: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary") => void;
+    onPersistCollectedData: (newData: import('../../types').TaxDocumentation) => void;
+    onSubmitTaxDocumentation: (data: import('../../types').TaxDocumentation) => Promise<void>;
+    goTo: (inputStep: import('../../types').InputStep) => void;
     goBack: (() => void) | undefined;
-    goToNext: (data: import("../../types").TaxDocumentation) => void;
-    progress: import("../../types").Progress | undefined;
-    stepName: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary";
-    data: import("../../types").TaxDocumentation;
-    originalClientData: import("../../types").TaxDocumentation;
-    initialStep: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary";
-    setLanguage: (lang: import("../../types").Locale) => void;
-    language: import("../../types").Locale;
-    questionnaire: import("../../types").Questionnaire;
-    externalValidations: import("../../types/client").ExternalValidations | undefined;
+    goToNext: (data: import('../../types').TaxDocumentation) => void;
+    progress: import('../..').Progress | undefined;
+    stepName: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "AccountHolderTreatyClaims" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary" | "W8imyInstructions";
+    data: import('../../types').TaxDocumentation;
+    originalClientData: import('../../types').TaxDocumentation;
+    initialStep: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "AccountHolderTreatyClaims" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary" | "W8imyInstructions";
+    setLanguage: (lang: import('../..').Locale) => void;
+    language: import('../..').Locale;
+    questionnaire: import('../..').Questionnaire;
+    externalValidations: import('../../types/client').ExternalValidations | undefined;
     config: {
         minimumAge: number;
     } | undefined;
     isSubmitting: boolean;
-}, TaxDocumentationContextProvider: import("react").Provider<{
+    treatyClaims: boolean | undefined;
+}, TaxDocumentationContextProvider: import('react').Provider<{
     isBuildingW9: boolean;
     isBuildingW8: boolean;
-    onPersistCollectedData: (newData: import("../../types").TaxDocumentation) => void;
-    onSubmitTaxDocumentation: (data: import("../../types").TaxDocumentation) => Promise<void>;
-    editTo: (form: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary") => void;
-    onCancel: (() => void) | undefined;
-    getStepId: (key: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary") => import("../../types/StepId").StepId;
-    goTo: (form: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary") => void;
+    onPersistCollectedData: (newData: import('../../types').TaxDocumentation) => void;
+    onSubmitTaxDocumentation: (data: import('../../types').TaxDocumentation) => Promise<void>;
+    goTo: (inputStep: import('../../types').InputStep) => void;
     goBack: (() => void) | undefined;
-    goToNext: (data: import("../../types").TaxDocumentation) => void;
-    progress: import("../../types").Progress | undefined;
-    stepName: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary";
-    data: import("../../types").TaxDocumentation;
-    originalClientData: import("../../types").TaxDocumentation;
-    initialStep: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary";
-    setLanguage: (lang: import("../../types").Locale) => void;
-    language: import("../../types").Locale;
-    questionnaire: import("../../types").Questionnaire;
-    externalValidations: import("../../types/client").ExternalValidations | undefined;
+    goToNext: (data: import('../../types').TaxDocumentation) => void;
+    progress: import('../..').Progress | undefined;
+    stepName: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "AccountHolderTreatyClaims" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary" | "W8imyInstructions";
+    data: import('../../types').TaxDocumentation;
+    originalClientData: import('../../types').TaxDocumentation;
+    initialStep: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "AccountHolderTreatyClaims" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary" | "W8imyInstructions";
+    setLanguage: (lang: import('../..').Locale) => void;
+    language: import('../..').Locale;
+    questionnaire: import('../..').Questionnaire;
+    externalValidations: import('../../types/client').ExternalValidations | undefined;
     config: {
         minimumAge: number;
     } | undefined;
     isSubmitting: boolean;
+    treatyClaims: boolean | undefined;
 } | undefined>;

package/dist/src/contexts/createCtx.d.ts

@@ -1,2 +1 @@
-/// <reference types="react" />
-export declare const createCtx: <A extends Record<string, unknown> | null>() => readonly [() => A, import("react").Provider<A | undefined>];
+export declare const createCtx: <A extends Record<string, unknown> | null>() => readonly [() => A, import('react').Provider<A | undefined>];

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

@@ -1,2 +1,2 @@
-export * from './QuestionnaireUI';
+export * from './QuestionnaireStep';
 export * from './TaxDocumentation';

package/dist/src/entry/TaxbitQuestionnaire/TaxbitQuestionnaire.d.ts

@@ -1,11 +1,13 @@
 import { ClientTaxDocumentation } from '@taxbit/utilities';
-import React from 'react';
-import type { Locale, Questionnaire } from '../../types';
+import { default as React } from 'react';
+import { Locale, Questionnaire } from '../../types';
 import { TaxbitQuestionnairePersistProps } from '../../widgets';
+
 export type TaxbitQuestionnaireProps = {
     data?: ClientTaxDocumentation;
     language?: Locale;
     questionnaire: Questionnaire;
+    treatyClaims?: TaxbitQuestionnairePersistProps['treatyClaims'];
     onProgress?: TaxbitQuestionnairePersistProps['onProgress'];
     onSubmit?: TaxbitQuestionnairePersistProps['onSubmit'];
 } & ({
@@ -25,4 +27,4 @@ export type TaxbitQuestionnaireProps = {
     onSuccess?: TaxbitQuestionnairePersistProps['onSuccess'];
     staging?: TaxbitQuestionnairePersistProps['staging'];
 });
-export declare const TaxbitQuestionnaire: ({ bearerToken, data, demoMode, language, onError, loadingComponent, onProgress, onSettled, onSubmit, onSuccess, questionnaire, staging, }: TaxbitQuestionnaireProps) => React.JSX.Element;
+export declare const TaxbitQuestionnaire: ({ bearerToken, data, demoMode, language, onError, loadingComponent, onProgress, onSettled, onSubmit, onSuccess, questionnaire, staging, treatyClaims, }: TaxbitQuestionnaireProps) => React.JSX.Element;

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

@@ -1,4 +1,5 @@
 import { Dispatch, SetStateAction } from 'react';
+
 export declare const useHandleError: (onError: ((error: Error) => void | Promise<void>) | undefined, setError?: Dispatch<SetStateAction<Error | undefined>>) => {
     handleError: (error: Error) => void;
 };

package/dist/src/hooks/useTaxbit/__tests__/clientTaxDocumentation.d.ts

@@ -1,2 +1,3 @@
 import { SignedClientTaxDocumentation } from '@taxbit/utilities';
+
 export declare const clientTaxDocumentation: SignedClientTaxDocumentation;

package/dist/src/hooks/useTaxbit/__tests__/serverTaxDocumentation.d.ts

@@ -1,2 +1,3 @@
 import { SignedDatedComprehensiveTaxDocumentation } from '@taxbit/utilities';
+
 export declare const serverTaxDocumentation: SignedDatedComprehensiveTaxDocumentation;

package/dist/src/hooks/useTaxbit/types/comprehensive.d.ts

@@ -1,4 +1,5 @@
 import { SignedDatedComprehensiveTaxDocumentation } from '@taxbit/utilities';
+
 export type Comprehensive = {
     account_holder: SignedDatedComprehensiveTaxDocumentation['account_holder'];
     regarded_owner?: SignedDatedComprehensiveTaxDocumentation['regarded_owner'];

package/dist/src/hooks/useTaxbit/types/w8.d.ts

@@ -1,5 +1,6 @@
 import { Comprehensive } from './comprehensive';
 import { W9 } from './w9';
+
 export type W8 = {
     name?: string;
     country?: string;

package/dist/src/hooks/useTaxbit/types/w9.d.ts

@@ -1,5 +1,6 @@
 import { Comprehensive } from './comprehensive';
 import { W8 } from './w8';
+
 export type W9 = {
     name?: string;
     tin?: string;

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

@@ -1,4 +1,5 @@
 import { Questionnaire } from 'types';
+
 type UseTaxbitProps = {
     bearerToken: string;
     questionnaire: Questionnaire;
@@ -6,8 +7,8 @@ type UseTaxbitProps = {
     onError?: (error: Error) => void | Promise<void>;
 };
 export declare const useTaxbit: ({ bearerToken, questionnaire, staging, onError, }: UseTaxbitProps) => {
-    serverData: import("@taxbit/utilities").SignedClientTaxDocumentation | undefined;
-    statusData: import("../../entry").ClientTaxDocumentationStatus | undefined;
+    serverData: import('@taxbit/utilities').SignedClientTaxDocumentation | undefined;
+    statusData: import('../..').ClientTaxDocumentationStatus | undefined;
     canGetDocumentUrl: boolean;
     generateDocumentUrl: () => void;
     isGeneratingDocumentUrl: boolean;

package/dist/src/hooks/useTaxbit/useTaxbitStatus.d.ts

@@ -1,6 +1,7 @@
-import type { SignedClientTaxDocumentation } from '@taxbit/utilities';
+import { SignedClientTaxDocumentation } from '@taxbit/utilities';
 import { Questionnaire } from '../../types';
-import type { ClientTaxDocumentationStatus } from '../../types/client';
+import { ClientTaxDocumentationStatus } from '../../types/client';
+
 type UseTaxbitStatusProps = {
     bearerToken?: string;
     onError?: (error: Error) => void | Promise<void>;

package/dist/src/i18n/__tests__/JsxFromString.test.d.ts

@@ -0,0 +1 @@
+export {};