@taxbit/react-sdk 1.0.0-beta.1 → 1.0.0-beta.3

package/README.md

@@ -1,6 +1,12 @@
 # Taxbit React SDK
 
-A React app, widget, and component for gathering Tax Documentation data for US and EU Tax forms.
+A React component and hook for gathering Tax Documentation data for US and EU Tax forms.
+
+## Usage
+
+The Taxbit React SDK provides a React component and hook for gathering tax documentation data from users. The component can be used to collect data for the Taxbit DPS (Digital Platform Sales) or W-Form (W-9, W-8BEN, W-8BEN-E) tax documentation forms. A hook provides more tools to understand the user's tax documentation status and download any pdf versions of the files that are created if eligible.
+
+DPS (Digital Platform Sales) is a data standard and UI flow used by Taxbit to gather the information needed to report income as directed by the DAC7 for the European Union, and equivalent reporting requirements in Canada, New Zealand, and the United Kingdom.
 
 ## Installation
 
@@ -60,6 +66,8 @@ exampleData: ClientTaxDocumentation = {
 };
 ```
 
+The `questionnaire` prop determines the UI of the component. The `questionnaire` prop can be set to 'DPS' or 'W-FORM'.
+
 ```jsx
 <TaxbitQuestionnaire
   data={exampleData} // `data` is an optional prop
@@ -69,7 +77,7 @@ exampleData: ClientTaxDocumentation = {
 />
 ```
 
-For W-9 W-8BEN and W-8BEN-E forms, this component can be used...
+For W-9 W-8BEN and W-8BEN-E forms, the `questionnaire` prop is set like this...
 
 ```jsx
 <TaxbitQuestionnaire
@@ -87,6 +95,7 @@ import { TaxbitQuestionnaire, ClientTaxDocumentation } from '@taxbit/react-sdk';
 
 <TaxbitQuestionnaire
   data={exampleData}
+  questionnaire="DPS"
   onSubmit={(data: ClientTaxDocumentation) => alert(JSON.stringify(data))}
   demoMode={true}
 />;
@@ -109,24 +118,43 @@ See the `Locale` type below.
 The `useTaxbit` hook will return a `status` object that can be used to determine the status of the user's tax documentation. The `status` object will have the following shape:
 
 ```typescript
-{
-  submissionStatus: 'SUBMITTED' | 'NOT_SUBMITTED';
-  dpsQuestionnaire: {
+type ClientTaxDocumentationStatus = {
+  dpsQuestionnaire?: {
     dataCollectionStatus: 'COMPLETE' | 'INCOMPLETE';
-    expirationDate: 'PENDING' |
-      'VALID' |
-      'INVALID' |
-      'INSUFFICIENT_DATA' |
-      'NOT_REQUIRED';
-  }
-}
+    vatStatus?:
+      | 'PENDING'
+      | 'VALID'
+      | 'INVALID'
+      | 'INSUFFICIENT_DATA'
+      | 'NOT_REQUIRED'
+      | 'NON_EU';
+    vatValidationDate?: string;
+    expirationDate?: string;
+  };
+  wFormQuestionnaire?: {
+    dataCollectionStatus: 'COMPLETE' | 'INCOMPLETE';
+    type: 'W-9' | 'W-8BEN' | 'W-8BEN-E';
+    expirationDate?: string;
+    tinStatus?:
+      | 'PENDING'
+      | 'FOREIGN'
+      | 'INVALID_DATA'
+      | 'VALID_SSN_MATCH'
+      | 'VALID_EIN_MATCH'
+      | 'VALID_SSN_EIN_MATCH'
+      | 'MISMATCH'
+      | 'TIN_NOT_ISSUED'
+      | 'ERROR';
+    tinValidationDate?: string;
+    needsResubmission: boolean;
+  };
+};
 ```
 
 an example is below.
 
 ```json
 {
-  "submissionStatus": "SUBMITTED",
   "dpsQuestionnaire": {
     "dataCollectionStatus": "COMPLETE",
     "expirationDate": "2026-11-20T00:00:00.000Z"
@@ -134,6 +162,19 @@ an example is below.
 }
 ```
 
+or for W-Form status
+
+```json
+{
+  "wFormQuestionnaire": {
+    "dataCollectionStatus": "COMPLETE",
+    "type": "W-9",
+    "tinValidationDate": "2027-11-01T17:09:05.962Z",
+    "needsResubmission": false
+  }
+}
+```
+
 ### 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.
@@ -218,8 +259,21 @@ type Progress = {
 };
 ```
 
+```typescript
+type QuestionnaireType = 'DPS' | 'W-FORM';
+```
+
 ## Changelog
 
+### Version 1.0.0-beta.3
+
+1. Transforming deprecated tax documentation data types for import to SDK
+2. More Readme documentation around Status and Questionnaire types
+
+### Version 1.0.0-beta.2
+
+1. The ClientTaxDocumentation type is exposed in the `useTaxbit` hook.
+
 ### Version 1.0.0-beta.1
 
 1. Showing "\*" when required for Addresses on Summary
@@ -268,7 +322,7 @@ type Progress = {
 
 ### Version 0.4.1
 
-1. Bug fix for onProgress callback not being triggered from the TaxbitDPSQuestionnaire component.
+1. Bug fix for onProgress callback not being triggered from the TaxBitDAC7Form component.
 
 ### Version 0.4.0
 
@@ -301,5 +355,5 @@ type Progress = {
 1. Fix in package.json to expose UMD module as main.
 2. Added specific CSS class names for each question and each screen of the form.
 3. Added the new status structure into the useTaxbit hook.
-4. TaxbitDPSQuestionnaire component will now preload the form with previously submitted data.
+4. TaxBitDAC7Form component will now preload the form with previously submitted data.
 5. Validation update to enforce that primary address country and tax residence country are the same.

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

@@ -13,7 +13,7 @@ export type UseTaxDocumentationProps = {
     onSubmit: (data: ClientTaxDocumentation) => void | Promise<void>;
     onProgress?: (progress: Progress) => void | Promise<void>;
     step?: InputStep;
-    questionnaire?: Questionnaire;
+    questionnaire: Questionnaire;
     config?: InterviewConfig;
 };
 export declare const useTaxDocumentation: ({ data: startingData, language: initialLanguage, externalValidations, onSubmit, onProgress, step: initialStep, questionnaire, config, }: UseTaxDocumentationProps) => {

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

@@ -1,9 +1,12 @@
 import React from 'react';
 import { TaxbitQuestionnairePersistProps } from 'widgets';
 import { TaxbitQuestionnaireUIProps } from 'wizard';
-export type TaxbitQuestionnaireProps = (TaxbitQuestionnaireUIProps & {
+import { Questionnaire } from '../../types';
+export type TaxbitQuestionnaireProps = {
+    questionnaire: Questionnaire;
+} & ((TaxbitQuestionnaireUIProps & {
     demoMode: true;
 }) | (TaxbitQuestionnairePersistProps & {
     demoMode?: false | undefined;
-});
+}));
 export declare const TaxbitQuestionnaire: ({ ...props }: TaxbitQuestionnaireProps) => React.JSX.Element;

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

@@ -1,6 +1,8 @@
+import { ClientTaxDocumentation } from '@taxbit/utilities';
 export * from '../hooks/useTaxbit';
 export * from '../types/Locale';
 export * from '../types/Progress';
 export * from '../types/Questionnaire';
 export * from '../types/client/ClientTaxDocumentationStatus';
 export * from './TaxbitQuestionnaire';
+export type { ClientTaxDocumentation };

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

@@ -0,0 +1,6 @@
+import { SignedDatedComprehensiveTaxDocumentation } from '@taxbit/utilities';
+export type Comprehensive = {
+    account_holder: SignedDatedComprehensiveTaxDocumentation['account_holder'];
+    regarded_owner?: SignedDatedComprehensiveTaxDocumentation['regarded_owner'];
+    document_type: 'COMPREHENSIVE';
+};

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

@@ -0,0 +1,29 @@
+import { Comprehensive } from './comprehensive';
+import { W9 } from './w9';
+export type W8 = {
+    name?: string;
+    country?: string;
+    tax_classification?: 'INDIVIDUAL' | 'CORPORATION' | 'PARTNERSHIP' | 'SIMPLE_TRUST' | 'COMPLEX_TRUST' | 'GRANTOR_TRUST' | 'ESTATE' | 'CENTRAL_BANK_OF_ISSUE' | 'FOREIGN_GOVERNMENT_CONTROLLED_ENTITY' | 'FOREIGN_GOVERNMENT_INTEGRAL_PART' | 'TAX_EXEMPT_ORGANIZATION' | 'PRIVATE_FOUNDATION' | 'INTERNATIONAL_ORGANIZATION';
+    permanent_address: {
+        first_line?: string;
+        city?: string;
+        state_or_province?: string;
+        postal_code?: string;
+        country?: string;
+    };
+    mailing_address?: {
+        first_line?: string;
+        city?: string;
+        state_or_province?: string;
+        postal_code?: string;
+        country?: string;
+    };
+    reference_numbers?: string;
+    tin?: string;
+    ftin?: string;
+    date_of_birth?: string;
+    ftin_not_legally_required?: true;
+    document_type: 'W-8BEN' | 'W-8BEN-E';
+};
+export declare const isW8TaxDocument: (taxDocument: Comprehensive | W9 | W8) => taxDocument is W8;
+export declare const transformW8ToComprehensive: (taxDocument: W8) => Comprehensive;

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

@@ -0,0 +1,22 @@
+import { Comprehensive } from './comprehensive';
+import { W8 } from './w8';
+export type W9 = {
+    name?: string;
+    tin?: string;
+    dba_name?: string;
+    tax_classification?: 'INDIVIDUAL' | 'LLC_S' | 'LLC_C' | 'LLC_P' | 'S_CORPORATION' | 'C_CORPORATION' | 'PARTNERSHIP' | 'TRUST_ESTATE' | 'OTHER';
+    address: {
+        first_line?: string;
+        second_line?: string;
+        city?: string;
+        state_or_province?: string;
+        postal_code?: string;
+        country?: string;
+    };
+    document_type: 'W-9';
+    other_tax_classification?: string;
+    exempt_payee_code?: string;
+    exempt_fatca_code?: string;
+};
+export declare const isW9TaxDocument: (taxDocument: Comprehensive | W9 | W8) => taxDocument is W9;
+export declare const transformW9ToComprehensive: (taxDocument: W9) => Comprehensive;

package/dist/src/lookups/foreignAccountHolderAccountTypeOptions.d.ts

@@ -1,3 +1,3 @@
 export declare const foreignAccountHolderAccountTypeOptions: {
-    value: "INDIVIDUAL" | "CORPORATION" | "PARTNERSHIP" | "TRUST" | "OTHER" | "DISREGARDED_ENTITY";
+    value: "INDIVIDUAL" | "PARTNERSHIP" | "OTHER" | "DISREGARDED_ENTITY" | "CORPORATION" | "TRUST";
 }[];

package/dist/src/lookups/foreignRegardedOwnerAccountTypeOptions.d.ts

@@ -1,3 +1,3 @@
 export declare const foreignRegardedOwnerAccountTypeOptions: {
-    value: "INDIVIDUAL" | "CORPORATION" | "PARTNERSHIP" | "TRUST" | "OTHER";
+    value: "INDIVIDUAL" | "PARTNERSHIP" | "OTHER" | "CORPORATION" | "TRUST";
 }[];

package/dist/src/lookups/usAccountHolderAccountTypeOptions.d.ts

@@ -1,3 +1,3 @@
 export declare const usAccountHolderAccountTypeOptions: {
-    value: "INDIVIDUAL" | "PARTNERSHIP" | "OTHER" | "DISREGARDED_ENTITY" | "SOLE_PROPRIETOR" | "LLC" | "SM_LLC" | "C_CORPORATION" | "S_CORPORATION" | "TRUST_ESTATE";
+    value: "INDIVIDUAL" | "SOLE_PROPRIETOR" | "LLC" | "SM_LLC" | "C_CORPORATION" | "S_CORPORATION" | "PARTNERSHIP" | "TRUST_ESTATE" | "OTHER" | "DISREGARDED_ENTITY";
 }[];

package/dist/src/lookups/usLlcAccountTypeOptions.d.ts

@@ -1,3 +1,3 @@
 export declare const usLlcAccountTypeOptions: {
-    value: "PARTNERSHIP" | "C_CORPORATION" | "S_CORPORATION";
+    value: "C_CORPORATION" | "S_CORPORATION" | "PARTNERSHIP";
 }[];

package/dist/src/lookups/usRegardedOwnerAccountTypeOptions.d.ts

@@ -1,3 +1,3 @@
 export declare const usRegardedOwnerAccountTypeOptions: {
-    value: "INDIVIDUAL" | "PARTNERSHIP" | "OTHER" | "LLC" | "C_CORPORATION" | "S_CORPORATION" | "TRUST_ESTATE";
+    value: "INDIVIDUAL" | "LLC" | "C_CORPORATION" | "S_CORPORATION" | "PARTNERSHIP" | "TRUST_ESTATE" | "OTHER";
 }[];

package/dist/src/types/client/ClientTaxDocumentationStatus.d.ts

@@ -1,9 +1,7 @@
 export type ClientTaxDocumentationStatus = {
-    status: 'UNDOCUMENTED' | 'UNDETERMINED';
-    submissionStatus: 'SUBMITTED' | 'NOT_SUBMITTED';
     dpsQuestionnaire?: {
         dataCollectionStatus: 'COMPLETE' | 'INCOMPLETE';
-        vatStatus?: 'PENDING' | 'VALID' | 'INVALID' | 'INSUFFICIENT_DATA' | 'NOT_REQUIRED';
+        vatStatus?: 'PENDING' | 'VALID' | 'INVALID' | 'INSUFFICIENT_DATA' | 'NOT_REQUIRED' | 'NON_EU';
         vatValidationDate?: string;
         expirationDate?: string;
     };
@@ -11,7 +9,7 @@ export type ClientTaxDocumentationStatus = {
         dataCollectionStatus: 'COMPLETE' | 'INCOMPLETE';
         type: 'W-9' | 'W-8BEN' | 'W-8BEN-E';
         expirationDate?: string;
-        tinStatus?: string;
+        tinStatus?: 'PENDING' | 'FOREIGN' | 'INVALID_DATA' | 'VALID_SSN_MATCH' | 'VALID_EIN_MATCH' | 'VALID_SSN_EIN_MATCH' | 'MISMATCH' | 'TIN_NOT_ISSUED' | 'ERROR';
         tinValidationDate?: string;
         needsResubmission: boolean;
     };

package/dist/src/types/server/TaxDocumentationStatus.d.ts

@@ -1,9 +1,7 @@
 export type TaxDocumentationStatus = {
-    status: 'UNDOCUMENTED' | 'UNDETERMINED';
-    submission_status: 'SUBMITTED' | 'NOT_SUBMITTED';
     dps_questionnaire?: {
         data_collection_status: 'COMPLETE' | 'INCOMPLETE';
-        vat_status?: 'PENDING' | 'VALID' | 'INVALID' | 'INSUFFICIENT_DATA' | 'NOT_REQUIRED';
+        vat_status?: 'PENDING' | 'VALID' | 'INVALID' | 'INSUFFICIENT_DATA' | 'NOT_REQUIRED' | 'NON_EU';
         vat_validation_date?: string;
         expiration_date?: string;
     };
@@ -11,7 +9,7 @@ export type TaxDocumentationStatus = {
         data_collection_status: 'COMPLETE' | 'INCOMPLETE';
         type: 'W-9' | 'W-8BEN' | 'W-8BEN-E';
         expiration_date?: string;
-        tin_status?: string;
+        tin_status?: 'PENDING' | 'FOREIGN' | 'INVALID_DATA' | 'VALID_SSN_MATCH' | 'VALID_EIN_MATCH' | 'VALID_SSN_EIN_MATCH' | 'MISMATCH' | 'TIN_NOT_ISSUED' | 'ERROR';
         tin_validation_date?: string;
         needs_resubmission: boolean;
     };