@taxbit/react-sdk 0.4.4 → 0.5.1

package/README.md

@@ -100,38 +100,9 @@ This will be generated from the TaxBit API and passed in as a prop to the compon
 ### 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 one of the following:
-
-- 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
+This can also be initially set to any of that languages that are supported by the TaxBit API.
+
+See the `Locale` type below.
 
 ### Status
 
@@ -139,10 +110,14 @@ The `useTaxBit` hook will return a `status` object that can be used to determine
 
 ```typescript
 {
-  submission_status: string;
-  DAC7_interview: {
-    data_collection_status: string;
-    expiration_date: string;
+  submissionStatus: 'SUBMITTED' | 'NOT_SUBMITTED';
+  DAC7Interview: {
+    dataCollectionStatus: 'COMPLETE' | 'INCOMPLETE';
+    expirationDate: 'PENDING' |
+      'VALID' |
+      'INVALID' |
+      'INSUFFICIENT_DATA' |
+      'NOT_REQUIRED';
   }
 }
 ```
@@ -151,10 +126,10 @@ an example is below.
 
 ```json
 {
-  "submission_status": "SUBMITTED",
-  "DAC7_interview": {
-    "data_collection_status": "COMPLETE",
-    "expiration_date": "2026-11-20T00:00:00.000Z"
+  "submissionStatus": "SUBMITTED",
+  "DAC7Interview": {
+    "dataCollectionStatus": "COMPLETE",
+    "expirationDate": "2026-11-20T00:00:00.000Z"
   }
 }
 ```
@@ -174,15 +149,17 @@ Classnames are namespaced with "taxbit-" to reduce the chance of conflict.
 
 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.
 
-- `onSubmit` - called when the user clicks the submit button
-- `onSuccess` - called after the server responds with a successful submission
-- `onProgress` - called when the user navigates within the TaxBit UI. The function passed here will be passed a Progress object (see below for the type definition):
+- `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):
 
 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.
 
 ### Types
 
-The TaxBit React SDK provides a type for the status of the most resent 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:
 

package/dist/basic.css

@@ -78,14 +78,19 @@ button.taxbit-button:focus-visible {
       color: red;
     }
   }
-  .taxbit-error-message {
-    color: red;
-    font-size: 0.8em;
-  }
-  .taxbit-hint {
-    font-size: 0.8em;
-    opacity: 0.7;
-  }
+}
+
+.taxbit-info-message {
+  color: blue;
+  font-size: 0.8em;
+}
+.taxbit-error-message {
+  color: red;
+  font-size: 0.8em;
+}
+.taxbit-hint {
+  font-size: 0.8em;
+  opacity: 0.7;
 }
 
 .taxbit-row-actions {
@@ -181,12 +186,15 @@ button.taxbit-button:focus-visible {
   flex: 0 0 40%;
 }
 
-.taxbit-step-actions {
-  display: flex;
-
-  padding-top: 8px;
+.taxbit-footer {
+  padding-top: 5px;
   border-top: solid 1px #e4ebf6;
   margin-top: 12px;
+}
+
+.taxbit-step-actions {
+  display: flex;
+  margin-top: 5px;
 
   .taxbit-primary-actions {
     > button {
@@ -197,6 +205,13 @@ button.taxbit-button:focus-visible {
       border-color: rgb(2, 80, 187);
       background-color: rgb(2, 80, 187);
     }
+    > button.taxbit-button-disabled {
+      cursor: default;
+      background-color: rgb(170, 179, 187);
+    }
+    > button.taxbit-button-disabled:hover {
+      border-color: rgb(170, 179, 187);
+    }
   }
 
   .taxbit-secondary-actions {

package/dist/inline.css

@@ -66,14 +66,19 @@ button.taxbit-button:focus-visible {
       color: red;
     }
   }
-  .taxbit-error-message {
-    color: red;
-    font-size: 0.8em;
-  }
-  .taxbit-hint {
-    font-size: 0.8em;
-    opacity: 0.7;
-  }
+}
+
+.taxbit-info-message {
+  color: blue;
+  font-size: 0.8em;
+}
+.taxbit-error-message {
+  color: red;
+  font-size: 0.8em;
+}
+.taxbit-hint {
+  font-size: 0.8em;
+  opacity: 0.7;
 }
 
 .taxbit-row-actions {
@@ -181,12 +186,15 @@ button.taxbit-button:focus-visible {
   margin-right: 50%;
 }
 
-.taxbit-step-actions {
-  display: flex;
-
-  padding-top: 8px;
+.taxbit-footer {
+  padding-top: 5px;
   border-top: solid 1px #e4ebf6;
   margin-top: 12px;
+}
+
+.taxbit-step-actions {
+  display: flex;
+  margin-top: 5px;
 
   .taxbit-primary-actions {
     > button {
@@ -197,6 +205,13 @@ button.taxbit-button:focus-visible {
       border-color: rgb(2, 80, 187);
       background-color: rgb(2, 80, 187);
     }
+    > button.taxbit-button-disabled {
+      cursor: default;
+      background-color: rgb(170, 179, 187);
+    }
+    > button.taxbit-button-disabled:hover {
+      border-color: rgb(170, 179, 187);
+    }
   }
 
   .taxbit-secondary-actions {

package/dist/minimal.css

@@ -11,8 +11,15 @@
   color: red;
 }
 
+.taxbit-info-message {
+  color: blue;
+}
+
+.taxbit-footer {
+  margin-top: 20px;
+}
+
 .taxbit-step-actions {
   display: flex;
   justify-content: space-between;
-  margin-top: 20px;
 }

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

@@ -35,10 +35,11 @@ export declare const useFormUI: () => {
     showErrorsForField: (key: TaxDocumentationKey) => boolean | undefined;
     exposeErrors: () => void;
     hideErrors: () => void;
+    hasChangedData: boolean;
     getRequiredLocalPrompt: (key: TaxDocumentationKey) => string;
+    visibleFields: TaxDocumentationPropertyFile;
     invalidFields: TaxDocumentationErrorFile;
     requiredFields: TaxDocumentationPropertyFile;
-    visibleFields: TaxDocumentationPropertyFile;
     hideField: (key: TaxDocumentationKey) => void;
     showField: (key: TaxDocumentationKey) => void;
 };

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

@@ -26,10 +26,11 @@ export declare const useFormUIContext: () => {
     showErrorsForField: (key: keyof import("../../types").AccountHolderContactData | keyof import("../../types").AccountHolderTaxData | keyof import("../../types").AccountHolderClassificationData | keyof import("../../types").RegardedOwnerContactData | keyof import("../../types").RegardedOwnerClassificationData | keyof import("../../types").RegardedOwnerTaxData | keyof import("../../types").SummaryData | keyof import("../../types").CalculatedData) => boolean | undefined;
     exposeErrors: () => void;
     hideErrors: () => void;
+    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("./useFormUI").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<{
@@ -59,10 +60,11 @@ export declare const useFormUIContext: () => {
     showErrorsForField: (key: keyof import("../../types").AccountHolderContactData | keyof import("../../types").AccountHolderTaxData | keyof import("../../types").AccountHolderClassificationData | keyof import("../../types").RegardedOwnerContactData | keyof import("../../types").RegardedOwnerClassificationData | keyof import("../../types").RegardedOwnerTaxData | keyof import("../../types").SummaryData | keyof import("../../types").CalculatedData) => boolean | undefined;
     exposeErrors: () => void;
     hideErrors: () => void;
+    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("./useFormUI").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/TaxBitFormProvider.d.ts

@@ -3,7 +3,7 @@ import type { InputStep, Locale, Progress, TaxForm } from '../../types';
 import { ClientTaxDocumentation, ExternalValidations } from '../../types/client';
 type TaxDocumentationProviderProps = {
     data?: ClientTaxDocumentation;
-    onSubmit: (data: ClientTaxDocumentation) => void;
+    onSubmit: (data: ClientTaxDocumentation) => Promise<void>;
     language?: Locale;
     children: React.ReactNode;
     taxForms?: TaxForm[];

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

@@ -2,12 +2,13 @@
 import type { InputStep, Locale, Progress, TaxDocumentation, TaxForm } from 'types';
 import type { StepId } from 'types/StepId';
 import { ClientTaxDocumentation, ExternalValidations } from 'types/client';
+import { TaxBitFormProps } from '../../widgets';
 type UseTaxDocumentationProps = {
     data: ClientTaxDocumentation;
     language?: Locale;
     externalValidations?: ExternalValidations;
-    onSubmit: (data: ClientTaxDocumentation) => void;
-    onProgress?: (progress: Progress) => void;
+    onSubmit: (data: ClientTaxDocumentation) => Promise<void>;
+    onProgress?: TaxBitFormProps['onProgress'];
     step?: InputStep;
     taxForms?: TaxForm[];
 };
@@ -20,7 +21,7 @@ export declare const useTaxDocumentation: ({ data: startingData, language: initi
     onPersistAccountHolderData: (newData: TaxDocumentation) => void;
     onPersistCollectedData: (newData: TaxDocumentation) => void;
     onSubmitTaxDocumentation: (data: TaxDocumentation) => void;
-    onResetTaxDocumentation: (data: ClientTaxDocumentation) => void;
+    error: string | undefined;
     editTo: (form: InputStep) => void;
     onCancel: (() => void) | undefined;
     getStepId: (key: InputStep) => StepId;
@@ -30,10 +31,11 @@ export declare const useTaxDocumentation: ({ data: startingData, language: initi
     progress: Progress | undefined;
     stepName: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Confirmation" | "Exemptions" | "RegardedOwnerClassification" | "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[];
-    setSupportedForms: import("react").Dispatch<import("react").SetStateAction<TaxForm[]>>;
     externalValidations: ExternalValidations | undefined;
 };
 export {};

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

@@ -8,7 +8,7 @@ export declare const useTaxDocumentationContext: () => {
     onPersistAccountHolderData: (newData: import("../../types").TaxDocumentation) => void;
     onPersistCollectedData: (newData: import("../../types").TaxDocumentation) => void;
     onSubmitTaxDocumentation: (data: import("../../types").TaxDocumentation) => void;
-    onResetTaxDocumentation: (data: import("../../entry").ClientTaxDocumentation) => void;
+    error: string | undefined;
     editTo: (form: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Confirmation" | "Exemptions" | "RegardedOwnerClassification" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary") => void;
     onCancel: (() => void) | undefined;
     getStepId: (key: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Confirmation" | "Exemptions" | "RegardedOwnerClassification" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary") => import("../../entry").StepId;
@@ -18,10 +18,11 @@ export declare const useTaxDocumentationContext: () => {
     progress: import("../../types").Progress | undefined;
     stepName: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Confirmation" | "Exemptions" | "RegardedOwnerClassification" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary";
     data: import("../../types").TaxDocumentation;
+    originalClientData: import("../../types").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: import("../../types").TaxForm[];
-    setSupportedForms: import("react").Dispatch<import("react").SetStateAction<import("../../types").TaxForm[]>>;
     externalValidations: import("../../entry").ExternalValidations | undefined;
 }, TaxDocumentationContextProvider: import("react").Provider<{
     isW9: boolean;
@@ -32,7 +33,7 @@ export declare const useTaxDocumentationContext: () => {
     onPersistAccountHolderData: (newData: import("../../types").TaxDocumentation) => void;
     onPersistCollectedData: (newData: import("../../types").TaxDocumentation) => void;
     onSubmitTaxDocumentation: (data: import("../../types").TaxDocumentation) => void;
-    onResetTaxDocumentation: (data: import("../../entry").ClientTaxDocumentation) => void;
+    error: string | undefined;
     editTo: (form: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Confirmation" | "Exemptions" | "RegardedOwnerClassification" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary") => void;
     onCancel: (() => void) | undefined;
     getStepId: (key: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Confirmation" | "Exemptions" | "RegardedOwnerClassification" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary") => import("../../entry").StepId;
@@ -42,9 +43,10 @@ export declare const useTaxDocumentationContext: () => {
     progress: import("../../types").Progress | undefined;
     stepName: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Confirmation" | "Exemptions" | "RegardedOwnerClassification" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary";
     data: import("../../types").TaxDocumentation;
+    originalClientData: import("../../types").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: import("../../types").TaxForm[];
-    setSupportedForms: import("react").Dispatch<import("react").SetStateAction<import("../../types").TaxForm[]>>;
     externalValidations: import("../../entry").ExternalValidations | undefined;
 } | undefined>;

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

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

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

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

package/dist/src/test/utils/helpers.d.ts

@@ -1,4 +1,5 @@
 export declare const expectRowError: (prompt: string) => void;
+export declare const expectRowErrorText: (prompt: string, text: string) => void;
 export declare const expectNoRowError: (prompt: string) => void;
 export declare const expectText: (text: string, length?: number) => void;
 export declare const expectNullInput: (ariaLabel: string) => void;
@@ -6,8 +7,10 @@ export declare const expectInputValue: (ariaLabel: string, value: string) => voi
 export declare const clickLabel: (ariaLabel: string) => void;
 export declare const changeInput: (ariaLabel: string, value: string) => void;
 export declare const clickInput: (ariaLabel: string) => void;
+export declare const clickEdit: (ariaLabel: string) => void;
 export declare const clickBack: () => void;
 export declare const clickNext: () => void;
+export declare const clickSubmit: () => void;
 export declare const clickAddAdditionalResidence: () => void;
 export declare const setBusinessNameAndAddress: () => void;
 export declare const setIndividualNameAndAddress: () => void;

package/dist/src/ui/Actions/Actions.d.ts

@@ -5,6 +5,8 @@ type ActionsProps = {
     onNext?: (data: unknown) => void;
     onReset?: (data: unknown) => void;
     onSubmit?: (data: unknown) => void;
+    disabled?: boolean;
+    info?: string;
 };
-export declare const Actions: ({ onBack, onCancel, onNext, onSubmit, onReset, }: ActionsProps) => React.JSX.Element;
+export declare const Actions: ({ onBack, onCancel, onNext, onSubmit, onReset, disabled, info, }: ActionsProps) => React.JSX.Element;
 export {};

package/dist/src/ui/InputValue/InputValue.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { TaxDocumentationKey } from 'types/TaxDocumentation';
+export type InputValueProps = {
+    name: TaxDocumentationKey;
+    value?: string;
+};
+export declare const InputValue: ({ name, value }: InputValueProps) => React.JSX.Element;

package/dist/src/ui/InputValue/index.d.ts

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

package/dist/src/ui/MaskedContent/MaskedContent.d.ts

@@ -1,4 +1,5 @@
 import React from 'react';
-export declare const MaskedContent: ({ text }: {
-    text: string | undefined;
+import { TaxDocumentationKey } from '../../types';
+export declare const MaskedContent: ({ name }: {
+    name: TaxDocumentationKey;
 }) => React.JSX.Element;

package/dist/src/ui/RadioButtons/RadioButtons.d.ts

@@ -9,5 +9,5 @@ export type RadioButtonsProps = {
     name: TaxDocumentationKey;
     options: ReadonlyArray<SelectOption>;
 };
-export declare const RadioButtons: ({ name, options }: RadioButtonsProps) => React.JSX.Element;
+export declare const RadioButtons: <T extends OptionKey>({ name, options, }: RadioButtonsProps) => React.JSX.Element;
 export {};

package/dist/src/ui/Select/Select.d.ts

@@ -1,24 +1,14 @@
 import { OptionKey } from 'i18n/types';
-import { FatcaCode, PayeeCode } from 'lookups';
 import React from 'react';
-import type { CaProvinceCode } from 'types/CaProvinceCode';
-import type { CountryCode } from 'types/CountryCode';
 import { TaxDocumentationKey } from 'types/TaxDocumentation';
-import type { UsStateCode } from 'types/UsStateCode';
-type FatcaSelectOption = {
-    value: FatcaCode;
-};
-type PayeeSelectOption = {
-    value: PayeeCode;
-};
-type SpecialSelectOption = {
-    value: CountryCode | UsStateCode | CaProvinceCode;
-    label: string;
+type ValueOption = {
+    value: string;
+    label?: string;
 };
 export type SelectProps = {
     prompt?: string;
     name: TaxDocumentationKey;
-    options: ReadonlyArray<FatcaSelectOption> | ReadonlyArray<PayeeSelectOption> | ReadonlyArray<SpecialSelectOption>;
+    options: ReadonlyArray<ValueOption>;
     addBlank?: boolean;
     className?: string;
     onChange?: () => void;

package/dist/src/ui/TextInput/TextInput.d.ts

@@ -7,6 +7,6 @@ export type TextInputProps = {
     hint?: true;
     disabled?: boolean;
     children?: React.ReactNode;
-    syncName?: TaxDocumentationKey;
+    defaultValue?: string;
 };
-export declare const TextInput: ({ name, className, onChange, hint, children, disabled, syncName, }: TextInputProps) => React.JSX.Element;
+export declare const TextInput: ({ name, className, onChange, hint, children, disabled, defaultValue, }: TextInputProps) => React.JSX.Element;

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

@@ -1,10 +1,12 @@
-export * from "./Actions";
-export * from "./ActionButton";
-export * from "./CheckBox";
-export * from "./DateOfBirthInput";
-export * from "./RadioButtons";
-export * from "./Select";
-export * from "./TextInput";
-export * from "./ToggleButton";
-export * from "./HideShowButton";
-export * from "./MaskedInput";
+export * from './ActionButton';
+export * from './Actions';
+export * from './CheckBox';
+export * from './DateOfBirthInput';
+export * from './HideShowButton';
+export * from './InputValue';
+export * from './MaskedContent';
+export * from './MaskedInput';
+export * from './RadioButtons';
+export * from './Select';
+export * from './TextInput';
+export * from './ToggleButton';

package/dist/src/utils/isBlank.d.ts

@@ -1,2 +1,2 @@
-export declare const isBlank: (value: string | undefined) => value is undefined;
+export declare const isBlank: (val: unknown) => boolean;
 export declare const isPresent: (value: string | undefined) => value is string;

package/dist/src/utils/sort/byOptionalLabel.d.ts

@@ -0,0 +1,5 @@
+export declare const byOptionalLabel: (a: {
+    label?: string;
+}, b: {
+    label?: string;
+}) => number;

package/dist/src/utils/sort/index.d.ts

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

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

@@ -1,4 +1,4 @@
 import React from 'react';
 import { TaxBitFormProps } from './TaxBitForm';
 export type TaxBitDAC7FormProps = Omit<TaxBitFormProps, 'taxForms'>;
-export declare const TaxBitDAC7Form: ({ data, staging, bearerToken, language, onSubmit, onProgress, onSuccess, }: TaxBitDAC7FormProps) => React.JSX.Element;
+export declare const TaxBitDAC7Form: ({ data, staging, bearerToken, language, onSubmit, onProgress, onSuccess, onError, onSettled, }: TaxBitDAC7FormProps) => React.JSX.Element;

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

@@ -1,14 +1,21 @@
 import React from 'react';
 import { Locale, Progress, TaxForm } from 'types';
 import { ClientTaxDocumentation } from 'types/client';
+type TaxBitResponseError = {
+    message: string;
+    response: Response;
+};
 export type TaxBitFormProps = {
     data?: ClientTaxDocumentation;
     staging?: true;
     bearerToken: string;
     language?: Locale;
     taxForms?: TaxForm[];
-    onProgress?: (progress: Progress) => void;
-    onSubmit?: (data?: ClientTaxDocumentation) => void;
-    onSuccess?: (data?: ClientTaxDocumentation) => void;
+    onProgress?: (progress: Progress) => void | Promise<void>;
+    onSubmit?: (data?: ClientTaxDocumentation) => void | Promise<void>;
+    onSuccess?: (data?: ClientTaxDocumentation) => void | Promise<void>;
+    onSettled?: (data?: ClientTaxDocumentation) => void | Promise<void>;
+    onError?: (error?: TaxBitResponseError) => void | Promise<void>;
 };
-export declare const TaxBitForm: ({ staging, data, bearerToken, language, taxForms, onProgress, onSubmit, onSuccess, }: TaxBitFormProps) => React.JSX.Element;
+export declare const TaxBitForm: ({ staging, data, bearerToken, language, taxForms, onProgress, onSubmit, onSettled, onSuccess, onError, }: TaxBitFormProps) => React.JSX.Element;
+export {};

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

@@ -1,7 +1,7 @@
 import { ClientTaxDocumentation, ExternalValidations } from 'types/client';
 import { TaxBitFormProps } from './TaxBitForm';
-type UseTaxBitFormProps = Exclude<TaxBitFormProps, 'language'>;
-export declare const useTaxBitForm: ({ bearerToken, data, onSubmit, onSuccess, staging, }: UseTaxBitFormProps) => {
+type UseTaxBitFormProps = Omit<TaxBitFormProps, 'language'>;
+export declare const useTaxBitForm: ({ bearerToken, data, onSubmit, onSuccess, onSettled, onError, staging, }: UseTaxBitFormProps) => {
     handleOnSubmit: (data: ClientTaxDocumentation) => Promise<void>;
     externalValidations: ExternalValidations;
     formData: ClientTaxDocumentation;

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

@@ -1,2 +1,2 @@
-import React from "react";
+import React from 'react';
 export declare const LanguageSelector: () => React.JSX.Element;

package/dist/src/wizard/RowInput/TextInputRow/TextInputRow.d.ts

@@ -1,12 +1,10 @@
-import React from "react";
-import { TextInputProps } from "ui";
-import { TaxDocumentationKey } from "types";
+import React from 'react';
+import { TextInputProps } from 'ui';
 type TextInputRowProps = {
     label?: true;
     subLabel?: true;
     hint?: true;
     onChange?: (val: string) => string;
-    syncName?: TaxDocumentationKey;
 };
-export declare const TextInputRow: ({ name, label, hint, subLabel, onChange, disabled, syncName, }: TextInputProps & TextInputRowProps) => React.JSX.Element;
+export declare const TextInputRow: ({ name, label, hint, subLabel, onChange, disabled, defaultValue, }: TextInputProps & TextInputRowProps) => React.JSX.Element;
 export {};

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

@@ -0,0 +1,4 @@
+import React from 'react';
+export declare const AppError: ({ message }: {
+    message: string;
+}) => React.JSX.Element;