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

package/README.md

@@ -125,6 +125,7 @@ The `useTaxbit` hook can be used to get the data from the server or the account
 const {
   statusData,
   serverData,
+  error,
   canGetDocumentUrl,
   generateDocumentUrl,
   isGeneratingDocumentUrl,
@@ -200,11 +201,27 @@ or for W-Form status
 }
 ```
 
+#### useTaxbit hook `error` object
+
+The useTaxbit hook also contains an `error` object which can be `undefined`, or an `Error`. If there is an error fetching or with the bearer token, the error property will be populated, and also logged to the console. If an `onError` callback is provided to the hook, the error will _not_ be logged to the console.
+
 ### CSS and Style Customization
 
 The Taxbit React SDK renders a form for collecting user data. The form is structured with fairly semantic HTML and CSS classes and can be easily customized to closely match your client's style.
 Classnames are namespaced with "taxbit-" to reduce the chance of conflict.
 
+#### Loading Component
+
+When the TaxbitQuestionnaire component is fetching the status and tax documentation from the server, the TaxbitQuestionnaire component will display a text message my default "Retrieving interview status...". This can be customized by supplying a `loadingComponent` as a prop.
+
+```jsx
+<TaxbitQuestionnaire
+  bearerToken="bearer token goes here"
+  questionnaire="W-FORM"
+  loadingComponent={<div>Loading...</div>}
+/>
+```
+
 ### Callbacks
 
 The Taxbit React SDK provides callbacks for the following events on the `TaxbitQuestionnaire` component. These callbacks can be passed in to the Component and used to trigger other actions in your application.
@@ -294,6 +311,16 @@ type QuestionnaireType = 'DPS' | 'W-FORM';
 
 ## Changelog
 
+### Version 1.0.0-beta.7
+
+1. BearerToken and Fetch errors are now sent only to the console, no longer thrown and bubbled up.
+2. 2Added an `error` object to the 'useTaxbit' hook.
+
+### Version 1.0.0-beta.6
+
+1. Bugs fixed related to the country drop-downs.
+2. Added a `loadingComponent` prop to the TaxbitQuestionnaire component.
+
 ### Version 1.0.0-beta.5
 
 1. Document Generation modifications. Renamed from "getDocumentUrl" to "generateDocumentUrl".

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

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

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

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

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

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

package/dist/src/contexts/QuestionnaireUI/useQuestionnaireUI.d.ts

@@ -12,7 +12,7 @@ export declare const useQuestionnaireUI: () => {
     config: {
         minimumAge: number;
     } | undefined;
-    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";
+    language: import("types").Locale;
     getLocalText: (key: import("i18n/types").TextKey) => string;
     getLocalTitle: (key: string) => string;
     getLocalSubTitle: (key: import("i18n/types").SubTitleKey) => string;

package/dist/src/contexts/QuestionnaireUI/useQuestionnaireUIContext.d.ts

@@ -3,7 +3,7 @@ export declare const useQuestionnaireUIContext: () => {
     config: {
         minimumAge: number;
     } | undefined;
-    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";
+    language: import("../../types").Locale;
     getLocalText: (key: import("../../i18n/types").TextKey) => string;
     getLocalTitle: (key: string) => string;
     getLocalSubTitle: (key: import("../../i18n/types").SubTitleKey) => string;
@@ -39,7 +39,7 @@ export declare const useQuestionnaireUIContext: () => {
     config: {
         minimumAge: number;
     } | undefined;
-    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";
+    language: import("../../types").Locale;
     getLocalText: (key: import("../../i18n/types").TextKey) => string;
     getLocalTitle: (key: string) => string;
     getLocalSubTitle: (key: import("../../i18n/types").SubTitleKey) => string;

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

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 import { ClientTaxDocumentation } from '@taxbit/utilities';
 import type { InputStep, Locale, Progress, Questionnaire, TaxDocumentation } from 'types';
 import type { StepId } from 'types/StepId';
@@ -32,8 +31,8 @@ export declare const useTaxDocumentation: ({ data: startingData, language: initi
     data: TaxDocumentation;
     originalClientData: TaxDocumentation;
     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";
+    setLanguage: (lang: Locale) => void;
+    language: Locale;
     questionnaire: Questionnaire;
     externalValidations: ExternalValidations | undefined;
     config: InterviewConfig | undefined;

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

@@ -15,8 +15,8 @@ export declare const useTaxDocumentationContext: () => {
     data: import("../../types").TaxDocumentation;
     originalClientData: import("../../types").TaxDocumentation;
     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";
+    setLanguage: (lang: import("../../types").Locale) => void;
+    language: import("../../types").Locale;
     questionnaire: import("../../types").Questionnaire;
     externalValidations: import("../../types/client").ExternalValidations | undefined;
     config: {
@@ -39,8 +39,8 @@ export declare const useTaxDocumentationContext: () => {
     data: import("../../types").TaxDocumentation;
     originalClientData: import("../../types").TaxDocumentation;
     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";
+    setLanguage: (lang: import("../../types").Locale) => void;
+    language: import("../../types").Locale;
     questionnaire: import("../../types").Questionnaire;
     externalValidations: import("../../types/client").ExternalValidations | undefined;
     config: {

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

@@ -11,16 +11,18 @@ export type TaxbitQuestionnaireProps = {
 } & ({
     demoMode: true;
     bearerToken?: never;
-    onSuccess?: never;
-    onSettled?: never;
     onError?: never;
+    loadingComponent?: never;
+    onSettled?: never;
+    onSuccess?: never;
     staging?: never;
 } | {
     demoMode?: false | undefined;
     bearerToken: TaxbitQuestionnairePersistProps['bearerToken'];
-    onSuccess?: TaxbitQuestionnairePersistProps['onSuccess'];
-    onSettled?: TaxbitQuestionnairePersistProps['onSettled'];
     onError?: TaxbitQuestionnairePersistProps['onError'];
+    loadingComponent?: TaxbitQuestionnairePersistProps['loadingComponent'];
+    onSettled?: TaxbitQuestionnairePersistProps['onSettled'];
+    onSuccess?: TaxbitQuestionnairePersistProps['onSuccess'];
     staging?: TaxbitQuestionnairePersistProps['staging'];
 });
-export declare const TaxbitQuestionnaire: ({ questionnaire, data, onSubmit, onSuccess, onSettled, onError, language, onProgress, bearerToken, demoMode, staging, }: TaxbitQuestionnaireProps) => React.JSX.Element;
+export declare const TaxbitQuestionnaire: ({ bearerToken, data, demoMode, language, onError, loadingComponent, onProgress, onSettled, onSubmit, onSuccess, questionnaire, staging, }: TaxbitQuestionnaireProps) => React.JSX.Element;

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

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

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

@@ -12,5 +12,6 @@ export declare const useTaxbit: ({ bearerToken, questionnaire, staging, onError,
     generateDocumentUrl: () => void;
     isGeneratingDocumentUrl: boolean;
     documentUrl: string | undefined;
+    error: Error | undefined;
 };
 export {};

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

@@ -11,5 +11,6 @@ export declare const useTaxbitStatus: ({ bearerToken, questionnaire, staging, on
     serverData: SignedClientTaxDocumentation | undefined;
     statusData: ClientTaxDocumentationStatus | undefined;
     isLoading: boolean;
+    error: Error | undefined;
 };
 export {};

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

@@ -0,0 +1,2 @@
+import { Locale, Questionnaire } from '../types';
+export declare const getLanguage: (language: string | undefined, questionnaire: Questionnaire) => Locale;

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

@@ -5,6 +5,7 @@ export * from './formatUsTin';
 export * from './getFieldsState';
 export * from './getFormStatus';
 export * from './getHeaders';
+export * from './getLanguage';
 export * from './getMaskedContent';
 export * from './getMonthlyDayCount';
 export * from './getPromptKeyMap';

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

@@ -1,5 +1,7 @@
 import React from 'react';
 import type { UseTaxDocumentationProps } from '../../contexts';
 import { UseTaxbitPersistProps } from './useTaxbitPersist';
-export type TaxbitQuestionnairePersistProps = UseTaxDocumentationProps & UseTaxbitPersistProps;
-export declare const TaxbitQuestionnairePersist: ({ staging, data, bearerToken, language, questionnaire, onProgress, onSubmit, onSettled, onSuccess, onError, }: TaxbitQuestionnairePersistProps) => React.JSX.Element;
+export type TaxbitQuestionnairePersistProps = UseTaxDocumentationProps & UseTaxbitPersistProps & {
+    loadingComponent?: React.ReactNode;
+};
+export declare const TaxbitQuestionnairePersist: ({ staging, data, bearerToken, language, questionnaire, loadingComponent, onProgress, onSubmit, onSettled, onSuccess, onError, }: TaxbitQuestionnairePersistProps) => string | number | true | Iterable<React.ReactNode> | React.JSX.Element;

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

@@ -11,10 +11,11 @@ export type UseTaxbitPersistProps = {
     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) => {
+export declare const useTaxbitPersist: ({ bearerToken, data, onError, onSettled, onSubmit, onSuccess, questionnaire, staging, }: UseTaxbitPersistProps) => {
     handleOnSubmit: (data: SignedClientTaxDocumentation) => Promise<void>;
     externalValidations: ExternalValidations;
     formData: ClientTaxDocumentation;
     isComplete: boolean;
     isLoading: boolean;
+    error: Error | undefined;
 };