@taxbit/react-sdk 1.0.0-beta.4 → 1.0.0-beta.5

package/README.md

@@ -126,13 +126,13 @@ const {
   statusData,
   serverData,
   canGetDocumentUrl,
-  getNewDocumentUrl,
-  isGettingDocumentUrl,
+  generateDocumentUrl,
+  isGeneratingDocumentUrl,
   documentUrl,
-} = useTaxbit(bearerToken, questionnaire);
+} = useTaxbit({ bearerToken, questionnaire, onError });
 ```
 
-It can also be used to get the document URL for the user's tax documentation. The `getNewDocumentUrl` function will trigger a temporary URL generation. The `documentUrl` will be the URL of the document if it is available. `isGettingDocumentUrl` will be true while the URL is being generated. `canGetDocumentUrl` will be true if the user has submitted the questionnaire and a PDF tax document is available to this user. Note, `DPS` data does not generate a PDF document.
+It can also be used to get the document URL for the user's tax documentation. The `generateDocumentUrl` function will trigger a temporary URL generation. The `documentUrl` will be the URL of the document if it is available. `isGeneratingDocumentUrl` will be true while the URL is being generated. `canGetDocumentUrl` will be true if the user has submitted the questionnaire and a PDF tax document is available to this user. Note, `DPS` data does not generate a PDF document.
 
 ### Server Data
 
@@ -215,9 +215,13 @@ The Taxbit React SDK provides callbacks for the following events on the `TaxbitQ
 - `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):
 
+#### Error Boundary
+
+A basic React Error Boundary is in place and when an error is thrown, the TaxbitQuestionnaire component will display errors on screen and throw an error in console. The exceptions that are possible are related to fetching data from the server, such as authentication (401 Unauthorized) or network problems (Failed to fetch). An error is also thrown if the bearer token is missing (Bearer Token is required). If the `onError` callback is provided to the component or the hook, these errors will be caught not and the error boundary will not be displayed.
+
 The DPS sequence, for example, can have a total of 3, 4, or 5 steps, each with a localized `stepTitle` and `stepId`. The `stepNumber` is the current step (1 based), and `percentComplete` is the percentage of the steps that have been completed.
 
-### Types
+## Types
 
 The Taxbit React SDK provides a type for the status of the most recent tax documentation submitted by the user, referred to as `ClientTaxDocumentationStatus`. The data passed to the component and returned to the callback is typed as `ClientTaxDocumentation`.
 
@@ -290,6 +294,11 @@ type QuestionnaireType = 'DPS' | 'W-FORM';
 
 ## Changelog
 
+### Version 1.0.0-beta.5
+
+1. Document Generation modifications. Renamed from "getDocumentUrl" to "generateDocumentUrl".
+2. `onError` callback is now exposed in both the TaxbitQuestionnaire component and the useTaxbit hook.
+
 ### Version 1.0.0-beta.4
 
 1. More explicit typing for TaxbitQuestionnaire component props

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

@@ -0,0 +1,16 @@
+import React, { Component, ReactNode } from 'react';
+interface Props {
+    children?: ReactNode;
+}
+interface State {
+    hasError: boolean;
+    errorMessage?: string;
+}
+export declare class ErrorBoundary extends Component<Props, State> {
+    state: State;
+    static getDerivedStateFromError(error: Error): State;
+    componentDidCatch(error: Error): void;
+    componentDidUpdate(): void;
+    render(): string | number | boolean | Iterable<React.ReactNode> | React.JSX.Element | null | undefined;
+}
+export {};

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

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

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

@@ -1,4 +1,5 @@
 export * from './Address';
+export * from './ErrorBoundary';
 export * from './ErrorMessage';
 export * from './Form';
 export * from './InputStatus';

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

@@ -1,8 +1,8 @@
 /// <reference types="react" />
 import { ClientTaxDocumentation } from '@taxbit/utilities';
 import type { InputStep, Locale, Progress, Questionnaire, TaxDocumentation } from 'types';
-import { ExternalValidations } from 'types/client';
 import type { StepId } from 'types/StepId';
+import { ExternalValidations } from 'types/client';
 type InterviewConfig = {
     minimumAge: number;
 };
@@ -10,7 +10,7 @@ export type UseTaxDocumentationProps = {
     data?: ClientTaxDocumentation;
     language?: Locale;
     externalValidations?: ExternalValidations;
-    onSubmit?: (data?: ClientTaxDocumentation) => void | Promise<void>;
+    onSubmit?: (data: ClientTaxDocumentation) => void | Promise<void>;
     onProgress?: (progress: Progress) => void | Promise<void>;
     step?: InputStep;
     questionnaire: Questionnaire;
@@ -20,8 +20,7 @@ export declare const useTaxDocumentation: ({ data: startingData, language: initi
     isBuildingW9: boolean;
     isBuildingW8: boolean;
     onPersistCollectedData: (newData: TaxDocumentation) => void;
-    onSubmitTaxDocumentation: (data: TaxDocumentation) => void;
-    error: string | undefined;
+    onSubmitTaxDocumentation: (data: TaxDocumentation) => Promise<void>;
     editTo: (form: InputStep) => void;
     onCancel: (() => void) | undefined;
     getStepId: (key: InputStep) => StepId;
@@ -29,10 +28,10 @@ export declare const useTaxDocumentation: ({ data: startingData, language: initi
     goBack: (() => void) | undefined;
     goToNext: (data: TaxDocumentation) => void;
     progress: Progress | undefined;
-    stepName: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Confirmation" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary";
+    stepName: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary";
     data: TaxDocumentation;
     originalClientData: TaxDocumentation;
-    initialStep: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Confirmation" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary";
+    initialStep: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary";
     setLanguage: import("react").Dispatch<import("react").SetStateAction<"bg" | "cs" | "da" | "de" | "de-at" | "el" | "el-cy" | "en" | "en-gb" | "en-nz" | "en-us" | "es" | "et" | "fi" | "fr" | "fr-ca" | "fr-lu" | "ga" | "hr" | "hu" | "it" | "lt" | "lv" | "mt" | "nl" | "nl-be" | "no" | "pl" | "pt" | "ro" | "sk" | "sl" | "sv">>;
     language: "bg" | "cs" | "da" | "de" | "de-at" | "el" | "el-cy" | "en" | "en-gb" | "en-nz" | "en-us" | "es" | "et" | "fi" | "fr" | "fr-ca" | "fr-lu" | "ga" | "hr" | "hu" | "it" | "lt" | "lv" | "mt" | "nl" | "nl-be" | "no" | "pl" | "pt" | "ro" | "sk" | "sl" | "sv";
     questionnaire: Questionnaire;

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

@@ -3,19 +3,18 @@ export declare const useTaxDocumentationContext: () => {
     isBuildingW9: boolean;
     isBuildingW8: boolean;
     onPersistCollectedData: (newData: import("../../types").TaxDocumentation) => void;
-    onSubmitTaxDocumentation: (data: import("../../types").TaxDocumentation) => void;
-    error: string | undefined;
-    editTo: (form: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Confirmation" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary") => void;
+    onSubmitTaxDocumentation: (data: import("../../types").TaxDocumentation) => Promise<void>;
+    editTo: (form: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary") => void;
     onCancel: (() => void) | undefined;
-    getStepId: (key: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Confirmation" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary") => import("../../types/StepId").StepId;
-    goTo: (form: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Confirmation" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary") => void;
+    getStepId: (key: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary") => import("../../types/StepId").StepId;
+    goTo: (form: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary") => void;
     goBack: (() => void) | undefined;
     goToNext: (data: import("../../types").TaxDocumentation) => void;
     progress: import("../../types").Progress | undefined;
-    stepName: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Confirmation" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary";
+    stepName: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary";
     data: import("../../types").TaxDocumentation;
     originalClientData: import("../../types").TaxDocumentation;
-    initialStep: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Confirmation" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary";
+    initialStep: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary";
     setLanguage: import("react").Dispatch<import("react").SetStateAction<"bg" | "cs" | "da" | "de" | "de-at" | "el" | "el-cy" | "en" | "en-gb" | "en-nz" | "en-us" | "es" | "et" | "fi" | "fr" | "fr-ca" | "fr-lu" | "ga" | "hr" | "hu" | "it" | "lt" | "lv" | "mt" | "nl" | "nl-be" | "no" | "pl" | "pt" | "ro" | "sk" | "sl" | "sv">>;
     language: "bg" | "cs" | "da" | "de" | "de-at" | "el" | "el-cy" | "en" | "en-gb" | "en-nz" | "en-us" | "es" | "et" | "fi" | "fr" | "fr-ca" | "fr-lu" | "ga" | "hr" | "hu" | "it" | "lt" | "lv" | "mt" | "nl" | "nl-be" | "no" | "pl" | "pt" | "ro" | "sk" | "sl" | "sv";
     questionnaire: import("../../types").Questionnaire;
@@ -28,19 +27,18 @@ export declare const useTaxDocumentationContext: () => {
     isBuildingW9: boolean;
     isBuildingW8: boolean;
     onPersistCollectedData: (newData: import("../../types").TaxDocumentation) => void;
-    onSubmitTaxDocumentation: (data: import("../../types").TaxDocumentation) => void;
-    error: string | undefined;
-    editTo: (form: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Confirmation" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary") => void;
+    onSubmitTaxDocumentation: (data: import("../../types").TaxDocumentation) => Promise<void>;
+    editTo: (form: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary") => void;
     onCancel: (() => void) | undefined;
-    getStepId: (key: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Confirmation" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary") => import("../../types/StepId").StepId;
-    goTo: (form: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Confirmation" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary") => void;
+    getStepId: (key: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary") => import("../../types/StepId").StepId;
+    goTo: (form: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary") => void;
     goBack: (() => void) | undefined;
     goToNext: (data: import("../../types").TaxDocumentation) => void;
     progress: import("../../types").Progress | undefined;
-    stepName: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Confirmation" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary";
+    stepName: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary";
     data: import("../../types").TaxDocumentation;
     originalClientData: import("../../types").TaxDocumentation;
-    initialStep: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Confirmation" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary";
+    initialStep: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary";
     setLanguage: import("react").Dispatch<import("react").SetStateAction<"bg" | "cs" | "da" | "de" | "de-at" | "el" | "el-cy" | "en" | "en-gb" | "en-nz" | "en-us" | "es" | "et" | "fi" | "fr" | "fr-ca" | "fr-lu" | "ga" | "hr" | "hu" | "it" | "lt" | "lv" | "mt" | "nl" | "nl-be" | "no" | "pl" | "pt" | "ro" | "sk" | "sl" | "sv">>;
     language: "bg" | "cs" | "da" | "de" | "de-at" | "el" | "el-cy" | "en" | "en-gb" | "en-nz" | "en-us" | "es" | "et" | "fi" | "fr" | "fr-ca" | "fr-lu" | "ga" | "hr" | "hu" | "it" | "lt" | "lv" | "mt" | "nl" | "nl-be" | "no" | "pl" | "pt" | "ro" | "sk" | "sl" | "sv";
     questionnaire: import("../../types").Questionnaire;

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

@@ -1,5 +1,5 @@
 import { ClientTaxDocumentation } from '@taxbit/utilities';
-export * from '../hooks/useTaxbit';
+export * from '../hooks/useTaxbit/useTaxbit';
 export * from '../types/Locale';
 export * from '../types/Progress';
 export * from '../types/Questionnaire';

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

@@ -1 +1,2 @@
+export * from './useHandleError';
 export * from './useTaxbit';

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

@@ -0,0 +1,3 @@
+export declare const useHandleError: (onError?: ((error: Error) => void | Promise<void>) | undefined) => {
+    handleError: (error: Error) => void;
+};

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

@@ -1 +1,2 @@
 export * from './useTaxbit';
+export * from './useTaxbitStatus';

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

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

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

@@ -1,8 +1,15 @@
 import type { SignedClientTaxDocumentation } from '@taxbit/utilities';
 import { Questionnaire } from '../../types';
 import type { ClientTaxDocumentationStatus } from '../../types/client';
-export declare const useTaxbitStatus: (bearerToken: string, questionnaire: Questionnaire, staging?: boolean) => {
-    formStatus: "COMPLETE" | "INCOMPLETE" | undefined;
+type UseTaxbitStatusProps = {
+    bearerToken?: string;
+    onError?: (error: Error) => void | Promise<void>;
+    questionnaire: Questionnaire;
+    staging?: boolean;
+};
+export declare const useTaxbitStatus: ({ bearerToken, questionnaire, staging, onError, }: UseTaxbitStatusProps) => {
     serverData: SignedClientTaxDocumentation | undefined;
     statusData: ClientTaxDocumentationStatus | undefined;
+    isLoading: boolean;
 };
+export {};

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

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

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

@@ -0,0 +1 @@
+export declare const bearerTokenIsRequiredError: Error;

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

@@ -0,0 +1,2 @@
+import { ClientTaxDocumentationStatus } from '../types/client';
+export declare const getFormStatus: (statusData: ClientTaxDocumentationStatus | undefined, questionnaire: string) => "COMPLETE" | "INCOMPLETE" | undefined;

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

@@ -0,0 +1,3 @@
+export declare const getHeaders: ({ bearerToken }: {
+    bearerToken: string;
+}) => Headers;

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

@@ -0,0 +1,7 @@
+type HandleFetchProps<T> = {
+    fetcher: Promise<Response>;
+    onSuccess?: (data: T) => void;
+    onError: (error: Error) => void;
+};
+export declare const handleFetch: <T>({ fetcher, onSuccess, onError, }: HandleFetchProps<T>) => Promise<void>;
+export {};

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

@@ -1,10 +1,14 @@
+export * from './bearerTokenIsRequiredError';
 export * from './camelCaseKeys';
 export * from './cx';
 export * from './formatUsTin';
 export * from './getFieldsState';
+export * from './getFormStatus';
+export * from './getHeaders';
 export * from './getMaskedContent';
 export * from './getMonthlyDayCount';
 export * from './getPromptKeyMap';
+export * from './handleFetch';
 export * from './isBlank';
 export * from './kebabCase';
 export * from './mergeClientTaxDocumentationData';

package/dist/src/widgets/TaxbitQuestionnairePersist/useTaxbitPersist.d.ts

@@ -1,22 +1,18 @@
-import { ClientTaxDocumentation } from '@taxbit/utilities';
+import { ClientTaxDocumentation, SignedClientTaxDocumentation } from '@taxbit/utilities';
 import { Questionnaire } from 'types';
 import { ExternalValidations } from 'types/client';
-export type TaxbitResponseError = {
-    message: string;
-    response: Response;
-};
 export type UseTaxbitPersistProps = {
     data?: ClientTaxDocumentation;
     staging?: boolean;
     bearerToken: string;
-    questionnaire?: Questionnaire;
-    onSuccess?: (data?: ClientTaxDocumentation) => void | Promise<void>;
-    onSettled?: (data?: ClientTaxDocumentation) => void | Promise<void>;
-    onError?: (error?: TaxbitResponseError) => void | Promise<void>;
-    onSubmit?: (data?: ClientTaxDocumentation) => void | Promise<void>;
+    questionnaire: Questionnaire;
+    onSuccess?: (data: ClientTaxDocumentation) => void | Promise<void>;
+    onSettled?: (data: ClientTaxDocumentation) => void | Promise<void>;
+    onError?: (error: Error) => void | Promise<void>;
+    onSubmit?: (data: ClientTaxDocumentation) => void | Promise<void>;
 };
 export declare const useTaxbitPersist: ({ bearerToken, data, onSubmit, onSuccess, onSettled, onError, staging, questionnaire, }: UseTaxbitPersistProps) => {
-    handleOnSubmit: (data?: ClientTaxDocumentation) => Promise<void>;
+    handleOnSubmit: (data: SignedClientTaxDocumentation) => Promise<void>;
     externalValidations: ExternalValidations;
     formData: ClientTaxDocumentation;
     isComplete: boolean;

package/dist/src/wizard/TaxbitQuestionnaireUI/steps.d.ts

@@ -2,7 +2,6 @@ export * from './AccountHolderClassification';
 export * from './AccountHolderContact';
 export * from './AccountHolderTax';
 export * from './AccountHolderTaxClarification';
-export * from './Confirmation';
 export * from './Exemptions';
 export * from './RegardedOwnerContact';
 export * from './RegardedOwnerTax';