@taxbit/react-sdk 0.4.0 → 0.4.2

package/README.md

@@ -176,18 +176,7 @@ The TaxBit React SDK provides callbacks for the following events on the `TaxBitD
 
 - `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:
-
-```typescript
-type Progress = {
-  stepNumber: number;
-  totalSteps: number;
-  percentComplete: number;
-  stepTitle: string;
-  stepId: string;
-  language: Locale;
-};
-```
+- `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):
 
 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.
 
@@ -231,13 +220,29 @@ type Locale =
   | 'sv-se';
 ```
 
+```typescript
+type StepId =
+  | 'accountHolderContactInformation'
+  | 'accountHolderTaxInformation'
+  | 'accountHolderTaxClarification'
+  | 'accountHolderClassification'
+  | 'confirmation'
+  | 'exemptions'
+  | 'regardedOwnerClassification'
+  | 'regardedOwnerContactInformation'
+  | 'regardedOwnerTaxInformation'
+  | 'summary';
+```
+
 ```typescript
 type Progress = {
-  stepNumber: number;
-  totalSteps: number;
+  language: Locale;
   percentComplete: number;
+  stepId: StepId;
+  stepIndex: number;
+  stepNumber: number;
   stepTitle: string;
-  stepId: string;
-  language: Locale;
+  steps: StepId[];
+  totalSteps: number;
 };
 ```

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

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 import type { InputStep, Locale, Progress, TaxDocumentation, TaxForm } from 'types';
+import type { StepId } from 'types/StepId';
 import { ClientTaxDocumentation } from 'types/client';
-import { TitleKey } from '../../i18n/types';
 type UseTaxDocumentationProps = {
     data: ClientTaxDocumentation;
     language?: Locale;
@@ -22,7 +22,7 @@ export declare const useTaxDocumentation: ({ data: initialData, language: initia
     onResetTaxDocumentation: (data: ClientTaxDocumentation) => void;
     editTo: (form: InputStep) => void;
     onCancel: (() => void) | undefined;
-    getTitleKey: (key: InputStep) => TitleKey;
+    getStepId: (key: InputStep) => StepId;
     goTo: (form: InputStep) => void;
     goBack: (() => void) | undefined;
     goToNext: (data: TaxDocumentation) => void;

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

@@ -11,7 +11,7 @@ export declare const useTaxDocumentationContext: () => {
     onResetTaxDocumentation: (data: import("../../entry").ClientTaxDocumentation) => void;
     editTo: (form: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Confirmation" | "Exemptions" | "RegardedOwnerClassification" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary") => void;
     onCancel: (() => void) | undefined;
-    getTitleKey: (key: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Confirmation" | "Exemptions" | "RegardedOwnerClassification" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary") => import("../../i18n/types").TitleKey;
+    getStepId: (key: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Confirmation" | "Exemptions" | "RegardedOwnerClassification" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary") => import("../../entry").StepId;
     goTo: (form: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Confirmation" | "Exemptions" | "RegardedOwnerClassification" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary") => void;
     goBack: (() => void) | undefined;
     goToNext: (data: import("../../types").TaxDocumentation) => void;
@@ -34,7 +34,7 @@ export declare const useTaxDocumentationContext: () => {
     onResetTaxDocumentation: (data: import("../../entry").ClientTaxDocumentation) => void;
     editTo: (form: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Confirmation" | "Exemptions" | "RegardedOwnerClassification" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary") => void;
     onCancel: (() => void) | undefined;
-    getTitleKey: (key: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Confirmation" | "Exemptions" | "RegardedOwnerClassification" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary") => import("../../i18n/types").TitleKey;
+    getStepId: (key: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Confirmation" | "Exemptions" | "RegardedOwnerClassification" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary") => import("../../entry").StepId;
     goTo: (form: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Confirmation" | "Exemptions" | "RegardedOwnerClassification" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary") => void;
     goBack: (() => void) | undefined;
     goToNext: (data: import("../../types").TaxDocumentation) => void;

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

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

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

@@ -0,0 +1,13 @@
+export declare const expectRowError: (prompt: 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;
+export declare const expectInputValue: (ariaLabel: string, value: string) => void;
+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 clickBack: () => void;
+export declare const clickNext: () => void;
+export declare const clickAddAdditionalResidence: () => void;
+export declare const setBusinessNameAndAddress: () => void;
+export declare const setIndividualNameAndAddress: () => void;

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

@@ -1,9 +1,12 @@
 import { Locale } from './Locale.ts';
+import type { StepId } from './StepId.ts';
 export type Progress = {
-    stepNumber: number;
-    totalSteps: number;
+    language: Locale;
     percentComplete: number;
+    stepId: StepId;
+    stepIndex: number;
+    stepNumber: number;
     stepTitle: string;
-    stepId: string;
-    language: Locale;
+    steps: StepId[];
+    totalSteps: number;
 };

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

@@ -0,0 +1 @@
+export type StepId = 'accountHolderContactInformation' | 'accountHolderTaxInformation' | 'accountHolderTaxClarification' | 'accountHolderClassification' | 'confirmation' | 'exemptions' | 'regardedOwnerClassification' | 'regardedOwnerContactInformation' | 'regardedOwnerTaxInformation' | 'summary';

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

@@ -7,7 +7,7 @@ export * from './getMonthlyDayCount';
 export * from './getPromptKeyMap';
 export * from './isBlank';
 export * from './kebabCase';
-export * from './mergeDeep';
+export * from './mergeClientTaxDocumentationData';
 export * from './snakeCaseKeys';
 export * from './transformForClient';
 export * from './transformInbound';

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

@@ -0,0 +1,2 @@
+import { ClientTaxDocumentation } from '../types/client';
+export declare const mergeClientTaxDocumentationData: (serverData: ClientTaxDocumentation | undefined, clientData: ClientTaxDocumentation | undefined) => ClientTaxDocumentation;

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, onSuccess, }: TaxBitDAC7FormProps) => React.JSX.Element;
+export declare const TaxBitDAC7Form: ({ data, staging, bearerToken, language, onSubmit, onProgress, onSuccess, }: TaxBitDAC7FormProps) => React.JSX.Element;

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

@@ -0,0 +1,10 @@
+import { ClientTaxDocumentation } from '../../types/client';
+import { TaxBitFormProps } from './TaxBitForm.tsx';
+type UseTaxBitFormProps = Exclude<TaxBitFormProps, 'language'>;
+export declare const useTaxBitForm: ({ bearerToken, data, onSubmit, onSuccess, staging, }: UseTaxBitFormProps) => {
+    handleOnSubmit: (data: ClientTaxDocumentation) => Promise<void>;
+    formData: ClientTaxDocumentation | undefined;
+    isComplete: boolean;
+    isLoading: boolean;
+};
+export {};