@taxbit/react-sdk 0.3.2 → 0.4.0

package/README.md

@@ -172,13 +172,72 @@ 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:
+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 with the following shape:
 
-These callbacks can be passed in to the Component and used to trigger other actions in your application.
+```typescript
+type Progress = {
+  stepNumber: number;
+  totalSteps: number;
+  percentComplete: number;
+  stepTitle: string;
+  stepId: string;
+  language: Locale;
+};
+```
+
+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`.
+
+Also included are some utility types:
+
+```typescript
+type Locale =
+  | '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';
+```
+
+```typescript
+type Progress = {
+  stepNumber: number;
+  totalSteps: number;
+  percentComplete: number;
+  stepTitle: string;
+  stepId: string;
+  language: Locale;
+};
+```

package/dist/basic.css

@@ -18,6 +18,12 @@ button.taxbit-button:focus-visible {
   padding: 12px;
 }
 
+.taxbit-progress-status {
+  font-size: 0.8em;
+  font-weight: normal;
+  opacity: 0.7;
+}
+
 .taxbit-page-header {
   display: flex;
   align-items: center;
@@ -76,10 +82,6 @@ button.taxbit-button:focus-visible {
     color: red;
     font-size: 0.8em;
   }
-  .taxbit-notification {
-    color: blue;
-    font-size: 0.8em;
-  }
   .taxbit-hint {
     font-size: 0.8em;
     opacity: 0.7;

package/dist/inline.css

@@ -18,6 +18,12 @@ button.taxbit-button:focus-visible {
   padding: 12px;
 }
 
+.taxbit-progress-status {
+  font-size: 0.8em;
+  font-weight: normal;
+  opacity: 0.7;
+}
+
 .taxbit-page-header {
   display: flex;
   align-items: center;
@@ -64,10 +70,6 @@ button.taxbit-button:focus-visible {
     color: red;
     font-size: 0.8em;
   }
-  .taxbit-notification {
-    color: blue;
-    font-size: 0.8em;
-  }
   .taxbit-hint {
     font-size: 0.8em;
     opacity: 0.7;

package/dist/minimal.css

@@ -11,10 +11,6 @@
   color: red;
 }
 
-.taxbit-notification {
-  color: blue;
-}
-
 .taxbit-step-actions {
   display: flex;
   justify-content: space-between;

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

@@ -1,6 +1,5 @@
-import React from "react";
-import { UsStateCode } from "types/UsStateCode";
-import { CaProvinceCode } from "types/CaProvinceCode";
+import React from 'react';
+import type { CaProvinceCode, UsStateCode } from 'types';
 type AddressParts = {
     street?: string;
     street2?: string;

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

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

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

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

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

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

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

@@ -2,6 +2,6 @@ export * from './Address';
 export * from './ErrorMessage';
 export * from './Form';
 export * from './InputStatus';
-export * from './Notification';
+export * from './ProgressStatus';
 export * from './Row';
 export * from './Section';

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

@@ -0,0 +1,21 @@
+import { ButtonKey, ErrorKey, HintKey, PromptKey, SubPromptKey, SubTitleKey, TextKey } from '../../i18n/types';
+import { Locale, TaxDocumentation, TaxDocumentationKey } from '../../types';
+export declare const getLocal: (fields: TaxDocumentation, language: Locale) => {
+    getLocalHint: (key: TaxDocumentationKey) => string | undefined;
+    getLocalText: (key: TextKey) => string;
+    getLocalTitle: (key: string) => string;
+    getLocalSubTitle: (key: SubTitleKey) => string;
+    getLocalError: (key: ErrorKey) => string;
+    getLocalLocale: (key: Locale) => string;
+    getLocalButton: (key: ButtonKey) => string;
+    getLocalPrompt: (key: string) => string;
+    getLocalSubPrompt: (key: TaxDocumentationKey) => string;
+    getLocalOption: (key: string | undefined) => string | undefined;
+    getLocalCountry: (key: string | undefined) => string;
+    getLocalUsState: (key: string | undefined) => string;
+    getLocalCaProvince: (key: string | undefined) => string;
+    getLocalMonth: (key: string | undefined) => string;
+    getHintKey: (key: TaxDocumentationKey) => HintKey;
+    getPromptKey: (key: string) => PromptKey;
+    getSubPromptKey: (key: TaxDocumentationKey) => SubPromptKey;
+};

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

@@ -1,14 +1,31 @@
 /// <reference types="react" />
-import { ButtonKey, ErrorKey, HintKey, NotificationKey, PromptKey, SubPromptKey, SubTitleKey, TextKey, TitleKey } from 'i18n/types';
-import { Locale, Yes } from 'types';
+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;
+    [key in TaxDocumentationKey]?: ErrorKey[];
 };
 export declare const useFormUI: () => {
+    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;
+    getLocalText: (key: import("i18n/types").TextKey) => string;
+    getLocalTitle: (key: string) => string;
+    getLocalSubTitle: (key: "taxResidences") => string;
+    getLocalError: (key: ErrorKey) => string;
+    getLocalLocale: (key: import("types").Locale) => 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;
+    getLocalCountry: (key: string | undefined) => string;
+    getLocalUsState: (key: string | undefined) => string;
+    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;
     clearIfNotRequired: (...arg: TaxDocumentationKey[]) => (value: Yes | undefined) => void;
     fields: TaxDocumentation;
     setFields: import("react").Dispatch<import("react").SetStateAction<TaxDocumentation>>;
@@ -17,26 +34,7 @@ export declare const useFormUI: () => {
     showErrors: boolean;
     exposeErrors: () => void;
     hideErrors: () => void;
-    getLocalButton: (key: ButtonKey) => string;
-    getLocalCaProvince: (key: string | undefined) => string;
-    getLocalCountry: (key: string | undefined) => string;
-    getLocalError: (key: ErrorKey) => string;
-    getLocalHint: (key: TaxDocumentationKey) => string | undefined;
-    getHintKey: (key: TaxDocumentationKey) => HintKey;
-    getLocalLocale: (key: Locale) => string;
-    getLocalNotification: (key: NotificationKey) => string;
-    getLocalOption: (key: string | undefined) => string | undefined;
-    getLocalPrompt: (key: string) => string;
-    getPromptKey: (key: string) => PromptKey;
-    getLocalSubPrompt: (key: TaxDocumentationKey) => string;
-    getSubPromptKey: (key: TaxDocumentationKey) => SubPromptKey;
-    getLocalText: (key: TextKey) => string;
-    getLocalTitle: (key: TitleKey) => string;
-    getLocalSubTitle: (key: SubTitleKey) => string;
-    getLocalUsState: (key: string | undefined) => string;
-    getLocalMonth: (key: string | undefined) => string;
     getRequiredLocalPrompt: (key: TaxDocumentationKey) => string;
-    notifiedFields: import("../../validations/getNotifiedFields.ts").Notifications;
     invalidFields: TaxDocumentationErrorFile;
     requiredFields: TaxDocumentationPropertyFile;
     visibleFields: TaxDocumentationPropertyFile;

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

@@ -1,70 +1,66 @@
 /// <reference types="react" />
 export declare const useFormUIContext: () => {
-    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 | "accountHolderTaxResidences")[]) => (value: "yes" | undefined) => void;
+    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;
+    getLocalText: (key: import("../../i18n/types").TextKey) => string;
+    getLocalTitle: (key: string) => string;
+    getLocalSubTitle: (key: "taxResidences") => string;
+    getLocalError: (key: import("../../i18n/types").ErrorKey) => string;
+    getLocalLocale: (key: import("../../types").Locale) => 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;
+    getLocalCountry: (key: string | undefined) => string;
+    getLocalUsState: (key: string | undefined) => string;
+    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;
+    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>>;
-    setValue: (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 | "accountHolderTaxResidences", value: string | undefined) => void;
+    setValue: (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, value: string | undefined) => void;
     isErrorFree: boolean;
     showErrors: boolean;
     exposeErrors: () => void;
     hideErrors: () => void;
-    getLocalButton: (key: import("../../i18n/types").ButtonKey) => string;
-    getLocalCaProvince: (key: string | undefined) => string;
-    getLocalCountry: (key: string | undefined) => string;
+    getRequiredLocalPrompt: (key: keyof import("../../types").AccountHolderContactData | keyof import("../../types").AccountHolderTaxData | keyof import("../../types").AccountHolderClassificationData | keyof import("../../types").RegardedOwnerContactData | keyof import("../../types").RegardedOwnerClassificationData | keyof import("../../types").RegardedOwnerTaxData | keyof import("../../types").SummaryData | keyof import("../../types").CalculatedData) => string;
+    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<{
+    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;
+    getLocalText: (key: import("../../i18n/types").TextKey) => string;
+    getLocalTitle: (key: string) => string;
+    getLocalSubTitle: (key: "taxResidences") => string;
     getLocalError: (key: import("../../i18n/types").ErrorKey) => string;
-    getLocalHint: (key: keyof import("../../types").AccountHolderContactData | keyof import("../../types").AccountHolderTaxData | keyof import("../../types").AccountHolderClassificationData | keyof import("../../types").RegardedOwnerContactData | keyof import("../../types").RegardedOwnerClassificationData | keyof import("../../types").RegardedOwnerTaxData | keyof import("../../types").SummaryData | "accountHolderTaxResidences") => string | undefined;
-    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 | "accountHolderTaxResidences") => "dateOfBirth";
     getLocalLocale: (key: import("../../types").Locale) => string;
-    getLocalNotification: (key: "vatUnexpectedFormat") => string;
-    getLocalOption: (key: string | undefined) => string | undefined;
+    getLocalButton: (key: import("../../i18n/types").ButtonKey) => string;
     getLocalPrompt: (key: string) => string;
-    getPromptKey: (key: string) => import("../../i18n/types").PromptKey;
-    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 | "accountHolderTaxResidences") => string;
-    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 | "accountHolderTaxResidences") => import("../../i18n/types").SubPromptKey;
-    getLocalText: (key: import("../../i18n/types").TextKey) => string;
-    getLocalTitle: (key: import("../../i18n/types").TitleKey) => string;
-    getLocalSubTitle: (key: "taxResidences") => 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;
+    getLocalCountry: (key: string | undefined) => string;
     getLocalUsState: (key: string | undefined) => string;
+    getLocalCaProvince: (key: string | undefined) => string;
     getLocalMonth: (key: string | undefined) => string;
-    getRequiredLocalPrompt: (key: keyof import("../../types").AccountHolderContactData | keyof import("../../types").AccountHolderTaxData | keyof import("../../types").AccountHolderClassificationData | keyof import("../../types").RegardedOwnerContactData | keyof import("../../types").RegardedOwnerClassificationData | keyof import("../../types").RegardedOwnerTaxData | keyof import("../../types").SummaryData | "accountHolderTaxResidences") => string;
-    notifiedFields: import("../../validations/getNotifiedFields").Notifications;
-    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 | "accountHolderTaxResidences") => 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 | "accountHolderTaxResidences") => void;
-}, FormUIContextProvider: import("react").Provider<{
-    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 | "accountHolderTaxResidences")[]) => (value: "yes" | undefined) => void;
+    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;
+    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>>;
-    setValue: (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 | "accountHolderTaxResidences", value: string | undefined) => void;
+    setValue: (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, value: string | undefined) => void;
     isErrorFree: boolean;
     showErrors: boolean;
     exposeErrors: () => void;
     hideErrors: () => void;
-    getLocalButton: (key: import("../../i18n/types").ButtonKey) => string;
-    getLocalCaProvince: (key: string | undefined) => string;
-    getLocalCountry: (key: string | undefined) => string;
-    getLocalError: (key: import("../../i18n/types").ErrorKey) => string;
-    getLocalHint: (key: keyof import("../../types").AccountHolderContactData | keyof import("../../types").AccountHolderTaxData | keyof import("../../types").AccountHolderClassificationData | keyof import("../../types").RegardedOwnerContactData | keyof import("../../types").RegardedOwnerClassificationData | keyof import("../../types").RegardedOwnerTaxData | keyof import("../../types").SummaryData | "accountHolderTaxResidences") => string | undefined;
-    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 | "accountHolderTaxResidences") => "dateOfBirth";
-    getLocalLocale: (key: import("../../types").Locale) => string;
-    getLocalNotification: (key: "vatUnexpectedFormat") => string;
-    getLocalOption: (key: string | undefined) => string | undefined;
-    getLocalPrompt: (key: string) => string;
-    getPromptKey: (key: string) => import("../../i18n/types").PromptKey;
-    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 | "accountHolderTaxResidences") => string;
-    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 | "accountHolderTaxResidences") => import("../../i18n/types").SubPromptKey;
-    getLocalText: (key: import("../../i18n/types").TextKey) => string;
-    getLocalTitle: (key: import("../../i18n/types").TitleKey) => string;
-    getLocalSubTitle: (key: "taxResidences") => string;
-    getLocalUsState: (key: string | undefined) => string;
-    getLocalMonth: (key: string | undefined) => string;
-    getRequiredLocalPrompt: (key: keyof import("../../types").AccountHolderContactData | keyof import("../../types").AccountHolderTaxData | keyof import("../../types").AccountHolderClassificationData | keyof import("../../types").RegardedOwnerContactData | keyof import("../../types").RegardedOwnerClassificationData | keyof import("../../types").RegardedOwnerTaxData | keyof import("../../types").SummaryData | "accountHolderTaxResidences") => string;
-    notifiedFields: import("../../validations/getNotifiedFields").Notifications;
+    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;
     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 | "accountHolderTaxResidences") => 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 | "accountHolderTaxResidences") => void;
+    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

@@ -1,7 +1,6 @@
 import React from 'react';
-import type { Locale, TaxForm } from '../../types';
+import type { InputStep, Locale, Progress, TaxForm } from '../../types';
 import { ClientTaxDocumentation } from '../../types/client';
-import { InputStep } from './useTaxDocumentation';
 type TaxDocumentationProviderProps = {
     data?: ClientTaxDocumentation;
     onSubmit: (data: ClientTaxDocumentation) => void;
@@ -9,6 +8,7 @@ type TaxDocumentationProviderProps = {
     children: React.ReactNode;
     taxForms?: TaxForm[];
     step?: InputStep;
+    onProgress?: (progress: Progress) => void;
 };
-export declare const TaxBitFormProvider: ({ data, onSubmit, language, taxForms, step, children, }: TaxDocumentationProviderProps) => React.JSX.Element;
+export declare const TaxBitFormProvider: ({ data, onSubmit, onProgress, language, taxForms, step, children, }: TaxDocumentationProviderProps) => React.JSX.Element;
 export {};

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

@@ -1,15 +1,16 @@
 /// <reference types="react" />
-import type { Locale, TaxDocumentation, TaxForm } from 'types';
+import type { InputStep, Locale, Progress, TaxDocumentation, TaxForm } from 'types';
 import { ClientTaxDocumentation } from 'types/client';
-export type InputStep = 'AccountHolderClassification' | 'AccountHolderContact' | 'AccountHolderTax' | 'AccountHolderTaxClarification' | 'Exemptions' | 'RegardedOwnerClassification' | 'RegardedOwnerContact' | 'RegardedOwnerTax' | 'Summary';
+import { TitleKey } from '../../i18n/types';
 type UseTaxDocumentationProps = {
     data: ClientTaxDocumentation;
     language?: Locale;
     onSubmit: (data: ClientTaxDocumentation) => void;
+    onProgress?: (progress: Progress) => void;
     step?: InputStep;
     taxForms?: TaxForm[];
 };
-export declare const useTaxDocumentation: ({ data: initialData, language: initialLanguage, onSubmit, step: initialStep, taxForms: supportedForms, }: UseTaxDocumentationProps) => {
+export declare const useTaxDocumentation: ({ data: initialData, language: initialLanguage, onSubmit, onProgress, step: initialStep, taxForms: supportedForms, }: UseTaxDocumentationProps) => {
     isW9: boolean;
     isW8: boolean;
     isW8Ben: boolean;
@@ -17,14 +18,16 @@ export declare const useTaxDocumentation: ({ data: initialData, language: initia
     isDac7: boolean;
     onPersistAccountHolderData: (newData: TaxDocumentation) => void;
     onPersistCollectedData: (newData: TaxDocumentation) => void;
-    onSubmitTaxDocumentation: (submitFields: TaxDocumentation) => void;
+    onSubmitTaxDocumentation: (data: TaxDocumentation) => void;
     onResetTaxDocumentation: (data: ClientTaxDocumentation) => void;
     editTo: (form: InputStep) => void;
     onCancel: (() => void) | undefined;
+    getTitleKey: (key: InputStep) => TitleKey;
     goTo: (form: InputStep) => void;
     goBack: (() => void) | undefined;
     goToNext: (data: TaxDocumentation) => void;
-    stepName: InputStep;
+    progress: Progress | undefined;
+    stepName: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Confirmation" | "Exemptions" | "RegardedOwnerClassification" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary";
     data: TaxDocumentation;
     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";

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

@@ -7,14 +7,16 @@ export declare const useTaxDocumentationContext: () => {
     isDac7: boolean;
     onPersistAccountHolderData: (newData: import("../../types").TaxDocumentation) => void;
     onPersistCollectedData: (newData: import("../../types").TaxDocumentation) => void;
-    onSubmitTaxDocumentation: (submitFields: import("../../types").TaxDocumentation) => void;
+    onSubmitTaxDocumentation: (data: import("../../types").TaxDocumentation) => void;
     onResetTaxDocumentation: (data: import("../../entry").ClientTaxDocumentation) => void;
-    editTo: (form: import("./useTaxDocumentation").InputStep) => void;
+    editTo: (form: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Confirmation" | "Exemptions" | "RegardedOwnerClassification" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary") => void;
     onCancel: (() => void) | undefined;
-    goTo: (form: import("./useTaxDocumentation").InputStep) => void;
+    getTitleKey: (key: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Confirmation" | "Exemptions" | "RegardedOwnerClassification" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary") => import("../../i18n/types").TitleKey;
+    goTo: (form: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Confirmation" | "Exemptions" | "RegardedOwnerClassification" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary") => void;
     goBack: (() => void) | undefined;
     goToNext: (data: import("../../types").TaxDocumentation) => void;
-    stepName: import("./useTaxDocumentation").InputStep;
+    progress: import("../../types").Progress | undefined;
+    stepName: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Confirmation" | "Exemptions" | "RegardedOwnerClassification" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary";
     data: import("../../types").TaxDocumentation;
     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";
@@ -28,14 +30,16 @@ export declare const useTaxDocumentationContext: () => {
     isDac7: boolean;
     onPersistAccountHolderData: (newData: import("../../types").TaxDocumentation) => void;
     onPersistCollectedData: (newData: import("../../types").TaxDocumentation) => void;
-    onSubmitTaxDocumentation: (submitFields: import("../../types").TaxDocumentation) => void;
+    onSubmitTaxDocumentation: (data: import("../../types").TaxDocumentation) => void;
     onResetTaxDocumentation: (data: import("../../entry").ClientTaxDocumentation) => void;
-    editTo: (form: import("./useTaxDocumentation").InputStep) => void;
+    editTo: (form: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Confirmation" | "Exemptions" | "RegardedOwnerClassification" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary") => void;
     onCancel: (() => void) | undefined;
-    goTo: (form: import("./useTaxDocumentation").InputStep) => void;
+    getTitleKey: (key: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Confirmation" | "Exemptions" | "RegardedOwnerClassification" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary") => import("../../i18n/types").TitleKey;
+    goTo: (form: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Confirmation" | "Exemptions" | "RegardedOwnerClassification" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary") => void;
     goBack: (() => void) | undefined;
     goToNext: (data: import("../../types").TaxDocumentation) => void;
-    stepName: import("./useTaxDocumentation").InputStep;
+    progress: import("../../types").Progress | undefined;
+    stepName: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Confirmation" | "Exemptions" | "RegardedOwnerClassification" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary";
     data: import("../../types").TaxDocumentation;
     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";

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

@@ -1,5 +1,6 @@
 export * from '../hooks/useTaxBit';
 export * from '../types/Locale';
+export * from '../types/Progress';
 export * from '../types/TaxForm';
 export * from '../types/client';
 export * from '../widgets/TaxBitForm';

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

@@ -1 +1 @@
-export { getButtonText, getCaProvinceText, getCountryText, getErrorText, getHintText, getLocaleText, getMonthText, getNotificationText, getOptionText, getPromptText, getSubPromptText, getSubTitleText, getTitleText, getUsStateText, } from './utils';
+export { getButtonText, getCaProvinceText, getCountryText, getErrorText, getHintText, getLocaleText, getMonthText, getOptionText, getPromptText, getSubPromptText, getSubTitleText, getTitleText, getUsStateText, } from './utils';

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

@@ -1,10 +1,9 @@
 export type ButtonKey = 'edit' | 'back' | 'next' | 'reset' | 'submit' | 'cancel' | 'hide' | 'show';
 export type ErrorKey = 'required' | 'invalid' | 'invalidDate' | 'mustBeSixCharacters' | 'mustBeNineDigits' | 'mustBeFiveOrNineDigits' | 'mustMatchName' | 'mustBeInDateFormat' | 'mustBeValidBirthDate' | 'mustNotMatchVatin' | 'residencesMustIncludeVatCountry' | 'residencesMustIncludeAddressCountry' | 'residencesMustIncludeAnEUCountry';
-export type NotificationKey = 'vatUnexpectedFormat';
 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' | 'address' | 'mailingAddress' | 'primaryAddress' | 'placeOfBirth' | 'regardedOwner' | 'regardedOwnerClassification' | 'regardedOwnerContactInformation' | 'regardedOwnerTaxInformation' | 'signature' | 'summary' | 'taxResidences' | 'taxResidence1' | 'taxResidence2' | 'taxResidence3' | 'taxResidence4' | 'taxResidence5';
+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 HintKey = 'dateOfBirth';

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

@@ -3,7 +3,7 @@ import { CountryCode } from 'types/CountryCode';
 import { Locale } from 'types/Locale';
 import { MonthCode } from 'types/MonthCode';
 import { UsStateCode } from 'types/UsStateCode';
-import { ButtonKey, ErrorKey, HintKey, NotificationKey, OptionKey, PromptKey, SubPromptKey, SubTitleKey, TextKey, TitleKey } from './LocalizationKey';
+import { ButtonKey, ErrorKey, HintKey, OptionKey, PromptKey, SubPromptKey, SubTitleKey, TextKey, TitleKey } from './LocalizationKey';
 export type PropertyFile = {
     button: {
         [key in ButtonKey]: string;
@@ -26,9 +26,6 @@ export type PropertyFile = {
     option: {
         [key in OptionKey]: string;
     };
-    notification: {
-        [key in NotificationKey]: string;
-    };
     country: {
         [key in CountryCode]: string;
     };

package/dist/src/i18n/utils/getText.d.ts

@@ -2,17 +2,16 @@ import { CaProvinceCode } from 'types/CaProvinceCode';
 import { CountryCode } from 'types/CountryCode';
 import { UsStateCode } from 'types/UsStateCode';
 import { Locale } from '../../types';
-import { ButtonKey, ErrorKey, NotificationKey, OptionKey, PromptKey, SubPromptKey, SubTitleKey, TextKey, TitleKey } from '../types';
+import { ButtonKey, ErrorKey, OptionKey, PromptKey, SubPromptKey, SubTitleKey, TextKey } from '../types';
 export declare const getPromptText: (key: PromptKey, locale: Locale | undefined) => string;
 export declare const getSubPromptText: (key: SubPromptKey, locale: Locale | undefined) => string;
 export declare const getErrorText: (key: ErrorKey, locale: Locale | undefined) => string;
 export declare const getHintText: (key: string | undefined, locale: Locale | undefined) => string | undefined;
 export declare const getTextText: (key: TextKey, locale: Locale | undefined) => string;
-export declare const getTitleText: (key: TitleKey, locale: Locale | undefined) => string;
+export declare const getTitleText: (key: string, locale: Locale | undefined) => string;
 export declare const getSubTitleText: (key: SubTitleKey, locale: Locale | undefined) => string;
 export declare const getButtonText: (key: ButtonKey, locale: Locale | undefined) => string;
 export declare const getOptionText: (key: OptionKey | undefined, locale: Locale | undefined) => string;
-export declare const getNotificationText: (key: NotificationKey | undefined, locale: Locale | undefined) => string;
 export declare const getCountryText: (key: CountryCode, locale: Locale | undefined) => string;
 export declare const getUsStateText: (key: UsStateCode, locale: Locale | undefined) => string;
 export declare const getCaProvinceText: (key: CaProvinceCode, locale: Locale | undefined) => string;

package/dist/src/types/InputStep.d.ts

@@ -0,0 +1,5 @@
+declare const inputSteps: readonly ["AccountHolderClassification", "AccountHolderContact", "AccountHolderTax", "AccountHolderTaxClarification", "Confirmation", "Exemptions", "RegardedOwnerClassification", "RegardedOwnerContact", "RegardedOwnerTax", "Summary"];
+export type InputStep = (typeof inputSteps)[number];
+export declare const isInputStep: (step: string) => step is "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Confirmation" | "Exemptions" | "RegardedOwnerClassification" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary";
+export declare const confirmInputStep: (step: string) => InputStep;
+export {};