@taxbit/react-sdk 2.3.0-beta.0 → 2.4.0-beta.0

package/README.md

@@ -130,6 +130,10 @@ If the `realTimeTinValidation` prop is set to `true`, the W-9 form will perform
 
 The date format can be set to `mdy` (month-day-year), `dmy` (day-month-year), or `ymd` (year-month-day). The default is `mdy`.
 
+### Region and Proxy Domain
+
+The `region` prop can be set to either `US` or `EU` to determine which regional server the component will connect to. The default is `US`. The `proxyDomain` prop can be set to a custom domain to route requests through a proxy server. This is useful in environments where direct access to the Taxbit servers is restricted. If not provided, the component will connect directly to the Taxbit servers based on the selected region.
+
 ## useTaxbit Hook
 
 The `useTaxbit` hook can be used to get the data from the server or the account status.
@@ -143,7 +147,14 @@ const {
   generateDocumentUrl,
   isGeneratingDocumentUrl,
   documentUrl,
-} = useTaxbit({ bearerToken, questionnaire, onError });
+} = useTaxbit({
+  bearerToken,
+  questionnaire,
+  staging,
+  region,
+  proxyDomain,
+  onError,
+});
 ```
 
 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.
@@ -346,37 +357,41 @@ type QuestionnaireType = 'DPS' | 'W-FORM' | 'SELF-CERT';
 
 ## Changelog
 
+### Version 2.4.0-beta.0
+
+- Adding `region` and `proxyDomain` props to the TaxbitQuestionnaire component for US, EU regional support and proxy domain support.
+
 ### Version 2.3.0-beta.0
 
-1. Simplifying checkbox options on the Certification screen.
+- Simplifying checkbox options on the Certification screen.
 
 ### Version 2.2.0-beta.2
 
-1. Bug fix, hiding email field for non-AU residents.
+- Bug fix, hiding email field for non-AU residents.
 
 ### Version 2.2.0-beta.1
 
-1. Updating TaxDocumentationStatus type to include issues and treatyClaimStatus.
+- Updating TaxDocumentationStatus type to include issues and treatyClaimStatus.
 
 ### Version 2.2.0-beta.0
 
-1. Adding SERR support for Australian residents.
+- Adding SERR support for Australian residents.
 
 ### Version 2.1.0-beta.0
 
-1. Adding Real-Time Tin Validation for W-9
+- Adding Real-Time Tin Validation for W-9
 
 ### Version 2.0.0-beta.2
 
-1. Adding es-MX ISO option.
+- Adding es-MX ISO option.
 
 ### Version 2.0.0-beta.1
 
-1. Fixed required fields for non-us Regarded Owner.
+- Fixed required fields for non-us Regarded Owner.
 
 ### Version 2.0.0-beta.0
 
-1. W-8IMY support added.
+- W-8IMY support added.
 
 ### Version 1.2.0-beta.8
 
@@ -385,23 +400,23 @@ type QuestionnaireType = 'DPS' | 'W-FORM' | 'SELF-CERT';
 
 ### Version 1.2.0-beta.7
 
-1. Verifying Mailing Address for W8-BEN-E, showing UsPerson selection on Summary screen.
+- Verifying Mailing Address for W8-BEN-E, showing UsPerson selection on Summary screen.
 
 ### Version 1.2.0-beta.6
 
-1. Fixing Treaty Claim header showing erroneously on the Summary screen.
+- Fixing Treaty Claim header showing erroneously on the Summary screen.
 
 ### Version 1.2.0-beta.4
 
-1. Passing investmentEntityManaged boolean to the server.
+- Passing investmentEntityManaged boolean to the server.
 
 ### Version 1.2.0-beta.2
 
-1. React 17 issue fixed with void return types in components.
+- React 17 issue fixed with void return types in components.
 
 ### Version 1.2.0-beta.0
 
-1. Self-Certification support
+- Self-Certification support
 
 ### Version 1.1.0-beta.1
 
@@ -410,7 +425,7 @@ type QuestionnaireType = 'DPS' | 'W-FORM' | 'SELF-CERT';
 
 ### Version 1.1.0-beta.0
 
-1. Treaty Claims Support on W-Forms.
+- Treaty Claims Support on W-Forms.
 
 ### Version 1.0.0-beta.8
 
@@ -434,7 +449,7 @@ type QuestionnaireType = 'DPS' | 'W-FORM' | 'SELF-CERT';
 
 ### Version 1.0.0-beta.4
 
-1. More explicit typing for TaxbitQuestionnaire component props
+- More explicit typing for TaxbitQuestionnaire component props
 
 ### Version 1.0.0-beta.3
 
@@ -443,11 +458,11 @@ type QuestionnaireType = 'DPS' | 'W-FORM' | 'SELF-CERT';
 
 ### Version 1.0.0-beta.2
 
-1. The ClientTaxDocumentation type is exposed in the `useTaxbit` hook.
+- The ClientTaxDocumentation type is exposed in the `useTaxbit` hook.
 
 ### Version 1.0.0-beta.1
 
-1. Showing "\*" when required for Addresses on Summary
+- Showing "\*" when required for Addresses on Summary
 
 ### Version 1.0.0-beta.0
 
@@ -457,7 +472,7 @@ type QuestionnaireType = 'DPS' | 'W-FORM' | 'SELF-CERT';
 
 ### Version 0.6.2
 
-1. Added this Changelog file
+- Added this Changelog file
 
 ### Version 0.6.1
 
@@ -479,7 +494,7 @@ type QuestionnaireType = 'DPS' | 'W-FORM' | 'SELF-CERT';
 
 ### Version 0.4.4
 
-1. Handle blank bearer token. No error, but a warning is logged.
+- Handle blank bearer token. No error, but a warning is logged.
 
 ### Version 0.4.3
 
@@ -489,11 +504,11 @@ type QuestionnaireType = 'DPS' | 'W-FORM' | 'SELF-CERT';
 
 ### Version 0.4.2
 
-1. Added stepIndex and steps fields to the Progress object. stepId is now typed to potential enum values.
+- Added stepIndex and steps fields to the Progress object. stepId is now typed to potential enum values.
 
 ### Version 0.4.1
 
-1. Bug fix for onProgress callback not being triggered from the TaxBitDAC7Form component.
+- Bug fix for onProgress callback not being triggered from the TaxBitDAC7Form component.
 
 ### Version 0.4.0
 
@@ -507,19 +522,19 @@ type QuestionnaireType = 'DPS' | 'W-FORM' | 'SELF-CERT';
 
 ### Version 0.2.4
 
-1. Bug fix for naming of CommonJS module exports.
+- Bug fix for naming of CommonJS module exports.
 
 ### Version 0.2.3
 
-1. Bug fix for the ClientTaxDocumentationStatus type not being accessible externally.
+- Bug fix for the ClientTaxDocumentationStatus type not being accessible externally.
 
 ### Version 0.2.2
 
-1. onSubmit and onSuccess callbacks are invoked with a parameter of type ClientTaxDocumentation which is now exposed.
+- onSubmit and onSuccess callbacks are invoked with a parameter of type ClientTaxDocumentation which is now exposed.
 
 ### Version 0.2.1
 
-1. The SDK now supports React versions 16, 17, 18 and TypeScript versions 4 and 5.
+- The SDK now supports React versions 16, 17, 18 and TypeScript versions 4 and 5.
 
 ### Version 0.2.0
 

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

@@ -20,8 +20,10 @@ export type UseTaxDocumentationProps = {
     realTimeTinValidation?: boolean;
     staging?: boolean;
     bearerToken?: string;
+    region?: 'US' | 'EU' | string;
+    proxyDomain?: string;
 };
-export declare const useTaxDocumentation: ({ data: startingData, language: initialLanguage, externalValidations, onSubmit, onProgress, step: initialStep, questionnaire, config, treatyClaims, dateFormat, realTimeTinValidation, staging, bearerToken, }: UseTaxDocumentationProps) => {
+export declare const useTaxDocumentation: ({ data: startingData, language: initialLanguage, externalValidations, onSubmit, onProgress, step: initialStep, questionnaire, config, treatyClaims, dateFormat, realTimeTinValidation, staging, bearerToken, region, proxyDomain, }: UseTaxDocumentationProps) => {
     config: InterviewConfig | undefined;
     data: TaxDocumentation;
     dateFormat: DateFormatConfig;

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

@@ -5,8 +5,17 @@ type UseTaxbitProps = {
     questionnaire: QuestionnaireProp;
     staging?: boolean;
     onError?: (error: Error) => void | Promise<void>;
+    region?: 'US' | 'EU' | string;
+    proxyDomain?: never;
+} | {
+    bearerToken: string;
+    questionnaire: QuestionnaireProp;
+    staging?: never;
+    region?: never;
+    proxyDomain?: string;
+    onError?: (error: Error) => void | Promise<void>;
 };
-export declare const useTaxbit: ({ bearerToken, questionnaire, staging, onError, }: UseTaxbitProps) => {
+export declare const useTaxbit: ({ bearerToken, questionnaire, staging, onError, region, proxyDomain, }: UseTaxbitProps) => {
     serverData: import('@taxbit/utilities').SignedClientTaxDocumentation | undefined;
     statusData: import('../..').ClientTaxDocumentationStatus | undefined;
     canGetDocumentUrl: boolean;

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

@@ -7,8 +7,10 @@ type UseTaxbitStatusProps = {
     onError?: (error: Error) => void | Promise<void>;
     questionnaire: QuestionnaireProp;
     staging?: boolean;
+    region?: 'US' | 'EU' | string;
+    proxyDomain?: string;
 };
-export declare const useTaxbitStatus: ({ bearerToken, questionnaire, staging, onError, }: UseTaxbitStatusProps) => {
+export declare const useTaxbitStatus: ({ bearerToken, questionnaire, staging, onError, region, proxyDomain, }: UseTaxbitStatusProps) => {
     serverData: SignedClientTaxDocumentation | undefined;
     statusData: ClientTaxDocumentationStatus | undefined;
     isLoading: boolean;

package/dist/src/hooks/useUsTinVerification/useUsTinValidation.d.ts

@@ -11,8 +11,10 @@ type UseUsTinValidationProps = {
     bearerToken?: string;
     isEnabled?: boolean;
     staging?: boolean;
+    region?: 'US' | 'EU' | string;
+    proxyDomain?: string;
 };
-export declare const useUsTinValidation: ({ bearerToken, isEnabled, staging, }: UseUsTinValidationProps) => {
+export declare const useUsTinValidation: ({ bearerToken, isEnabled, staging, region, proxyDomain, }: UseUsTinValidationProps) => {
     doValidateUsTin: (name: string, usTin: string) => Promise<void>;
     isValidatingUsTin: boolean;
     usTinValidations: UsTinValidationAttempt[];

package/dist/src/services/api.d.ts

@@ -1,22 +1,25 @@
 import { QuestionnaireProp } from 'types';
 
+type Environment = 'PRODUCTION' | 'STAGING';
+type Region = 'US' | 'EU' | string;
 export declare const TAX_DOCUMENTATION_SUBMISSIONS_PATH = "tax-documentation/submissions";
 export declare const TAX_DOCUMENTATION_STATUS_PATH = "tax-documentation-status";
 export declare const TAX_DOCUMENT_PATH = "tax-documentation/document";
 export declare const US_TIN_VALIDATION_PATH = "embedded-validations/us-tin";
 export declare const api: {
     taxDocumentationSubmissions: {
-        post: (environment: "PRODUCTION" | "STAGING") => string;
-        get: (environment: "PRODUCTION" | "STAGING", questionnaire: QuestionnaireProp) => string;
+        post: (environment: Environment, region: Region | undefined, proxyDomain: string | undefined) => string;
+        get: (environment: Environment, questionnaire: QuestionnaireProp, region: Region | undefined, proxyDomain: string | undefined) => string;
     };
     taxDocumentationStatus: {
-        get: (environment: "PRODUCTION" | "STAGING") => string;
+        get: (environment: Environment, region: Region | undefined, proxyDomain: string | undefined) => string;
     };
     taxDocument: {
-        post: (environment: "PRODUCTION" | "STAGING") => string;
-        get: (documentId: string, environment: "PRODUCTION" | "STAGING") => string;
+        post: (environment: Environment, region: Region | undefined, proxyDomain: string | undefined) => string;
+        get: (documentId: string, environment: Environment, region?: Region, proxyDomain?: string) => string;
     };
     usTinValidation: {
-        post: (environment: "PRODUCTION" | "STAGING") => string;
+        post: (environment: Environment, region: Region | undefined, proxyDomain: string | undefined) => string;
     };
 };
+export {};

package/dist/src/services/msw.d.ts

@@ -17,6 +17,7 @@ export declare const mockApi: {
         get: {
             success: (options?: ResponseOptions) => import('msw').HttpHandler;
             unauthorized: (options?: ResponseOptions) => import('msw').HttpHandler;
+            forbidden: (options?: ResponseOptions) => import('msw').HttpHandler;
         };
     };
     taxDocument: {

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

@@ -3,7 +3,7 @@ import { default as React } from 'react';
 import { Locale, QuestionnaireProp } from '../../types';
 import { TaxbitQuestionnairePersistProps } from '../TaxbitQuestionnairePersist';
 
-export type TaxbitQuestionnaireProps = {
+type BaseProps = {
     data?: ClientTaxDocumentation;
     language?: Locale;
     questionnaire: QuestionnaireProp;
@@ -12,7 +12,8 @@ export type TaxbitQuestionnaireProps = {
     onSubmit?: TaxbitQuestionnairePersistProps['onSubmit'];
     dateFormat?: TaxbitQuestionnairePersistProps['dateFormat'];
     realTimeTinValidation?: TaxbitQuestionnairePersistProps['realTimeTinValidation'];
-} & ({
+};
+type DemoProps = {
     demoMode: true;
     bearerToken?: never;
     onError?: never;
@@ -20,13 +21,27 @@ export type TaxbitQuestionnaireProps = {
     onSettled?: never;
     onSuccess?: never;
     staging?: never;
-} | {
-    demoMode?: false | undefined;
+    region?: never;
+    proxyDomain?: never;
+};
+type AuthenticatedBase = {
+    demoMode?: false;
     bearerToken: TaxbitQuestionnairePersistProps['bearerToken'];
     onError?: TaxbitQuestionnairePersistProps['onError'];
     loadingComponent?: TaxbitQuestionnairePersistProps['loadingComponent'];
     onSettled?: TaxbitQuestionnairePersistProps['onSettled'];
     onSuccess?: TaxbitQuestionnairePersistProps['onSuccess'];
+};
+type RegionMode = {
+    region?: TaxbitQuestionnairePersistProps['region'];
+    proxyDomain?: never;
     staging?: TaxbitQuestionnairePersistProps['staging'];
-});
-export declare const TaxbitQuestionnaire: ({ bearerToken, data, demoMode, language, onError, loadingComponent, onProgress, onSettled, onSubmit, onSuccess, questionnaire, staging, treatyClaims, dateFormat, realTimeTinValidation, }: TaxbitQuestionnaireProps) => React.JSX.Element;
+};
+type ProxyMode = {
+    proxyDomain: TaxbitQuestionnairePersistProps['proxyDomain'];
+    region?: never;
+    staging?: never;
+};
+export type TaxbitQuestionnaireProps = (BaseProps & DemoProps) | (BaseProps & AuthenticatedBase & RegionMode) | (BaseProps & AuthenticatedBase & ProxyMode);
+export declare const TaxbitQuestionnaire: ({ bearerToken, data, demoMode, language, onError, loadingComponent, onProgress, onSettled, onSubmit, onSuccess, questionnaire, staging, treatyClaims, dateFormat, realTimeTinValidation, region, proxyDomain, }: TaxbitQuestionnaireProps) => React.JSX.Element;
+export {};

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

@@ -6,4 +6,4 @@ export type TaxbitQuestionnairePersistProps = UseTaxDocumentationProps & UseTaxb
     loadingComponent?: React.ReactNode;
     treatyClaims?: boolean;
 };
-export declare const TaxbitQuestionnairePersist: ({ staging, data, bearerToken, language, questionnaire, loadingComponent, onProgress, onSubmit, onSettled, onSuccess, onError, treatyClaims, dateFormat, realTimeTinValidation, }: TaxbitQuestionnairePersistProps) => string | number | bigint | true | Iterable<React.ReactNode> | Promise<string | number | bigint | boolean | React.ReactPortal | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | null | undefined> | React.JSX.Element;
+export declare const TaxbitQuestionnairePersist: ({ staging, data, bearerToken, language, questionnaire, loadingComponent, onProgress, onSubmit, onSettled, onSuccess, onError, treatyClaims, dateFormat, realTimeTinValidation, region, proxyDomain, }: TaxbitQuestionnairePersistProps) => string | number | bigint | true | Iterable<React.ReactNode> | Promise<string | number | bigint | boolean | React.ReactPortal | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | null | undefined> | React.JSX.Element;

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

@@ -11,8 +11,10 @@ export type UseTaxbitPersistProps = {
     onSettled?: (data: ClientTaxDocumentation) => void | Promise<void>;
     onError?: (error: Error) => void | Promise<void>;
     onSubmit?: (data: ClientTaxDocumentation) => void | Promise<void>;
+    region?: 'US' | 'EU' | string;
+    proxyDomain?: string;
 };
-export declare const useTaxbitPersist: ({ bearerToken, data, onError, onSettled, onSubmit, onSuccess, questionnaire, staging, }: UseTaxbitPersistProps) => {
+export declare const useTaxbitPersist: ({ bearerToken, data, onError, onSettled, onSubmit, onSuccess, questionnaire, staging, region, proxyDomain, }: UseTaxbitPersistProps) => {
     handleOnSubmit: (data: SignedClientTaxDocumentation) => Promise<void>;
     externalValidations: ExternalValidations;
     formData: ClientTaxDocumentation;