@taxbit/react-sdk 0.3.0 → 0.3.1

package/README.md

@@ -10,13 +10,13 @@ npm install @taxbit/react-sdk
 
 ```typescript
 import '@taxbit/react-sdk/style/inline.css'; // other options include 'basic.css' and 'minimal.css'
-import { TaxBitDAC7Form } from '@taxbit/react-sdk';
+import { TaxBitDAC7Form, ClientTaxDocumentation } from '@taxbit/react-sdk';
 ```
 
 ### Data
 
 ```typescript
-exampleData = {
+exampleData: ClientTaxDocumentation = {
   accountHolder: {
     name: 'John Smith',
     tin: '456456456',
@@ -53,9 +53,10 @@ exampleData = {
     vatinNotRequired: true,
     financialAccountIdentifier: '123123123',
     financialAccountName: 'John Smith',
+    businessRegistrationNumber: '123123123',
+    businessRegistrationCountry: 'GR',
     isIndividual: true,
     isEuResident: true,
-    isUsPerson: false,
   },
 };
 ```
@@ -84,10 +85,12 @@ Which is just a shortcut for this component...
 There is a more basic component that simply shows the TaxBit UI and does not interact with the TaxBit server. It can be used like this...
 
 ```typescript jsx
+import { TaxBitDAC7FormUI, ClientTaxDocumentation } from '@taxbit/react-sdk';
+
 <TaxBitDAC7FormUI
   data={exampleData}
-  onSubmit={(data: unknown) => alert(JSON.stringify(data))}
-/>
+  onSubmit={(data: ClientTaxDocumentation) => alert(JSON.stringify(data))}
+/>;
 ```
 
 ### Bearer Token
@@ -130,6 +133,32 @@ This can also be initially set to any one of the following:
 - sl-si
 - sv-se
 
+### Status
+
+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
+{
+  submission_status: string;
+  DAC7_interview: {
+    data_collection_status: string;
+    expiration_date: string;
+  }
+}
+```
+
+an example is below.
+
+```json
+{
+  "submission_status": "SUBMITTED",
+  "DAC7_interview": {
+    "data_collection_status": "COMPLETE",
+    "expiration_date": "2026-11-20T00:00:00.000Z"
+  }
+}
+```
+
 ### Staging
 
 This can be set to `true` or `false`. Passing `staging` in the component is the same as passing `staging={true}`.
@@ -143,7 +172,7 @@ Classnames are namespaced with "taxbit-" to reduce the chance of conflict.
 
 ### Callbacks
 
-The TaxBit React SDK provides callbacks for the following events:
+The TaxBit React SDK provides callbacks for the following events on the `TaxBitDAC7Form` component:
 
 - `onSubmit` - called when the user clicks the submit button
 - `onSuccess` - called after the server responds with a successful submission
@@ -152,4 +181,4 @@ These callbacks can be passed in to the Component and used to trigger other acti
 
 ### Types
 
-The TaxBit React SDK provides a type for the status of the most resent tax documentation submitted by the user, referred to as `ClientTaxDocumentationStatus`. The data is typed as `ClientTaxDocumentation` and can be used to determine if the user has submitted tax documentation and if it has been approved.
+The TaxBit React SDK provides a type for the status of the most resent 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`.

package/dist/index.d.ts

@@ -1 +1 @@
-export * from './entry/index'
+export * from './src/entry/index'

package/dist/src/contexts/FormUI/shiftResidence.d.ts

@@ -0,0 +1,2 @@
+import { TaxDocumentation } from '../../types';
+export declare const shiftResidence: (fields: TaxDocumentation, index: 2 | 3 | 4) => TaxDocumentation;

package/dist/{contexts → src/contexts}/FormUI/useFormUI.d.ts

@@ -39,7 +39,6 @@ export declare const useFormUI: () => {
     notifiedFields: import("../../validations/getNotifiedFields.ts").Notifications;
     invalidFields: TaxDocumentationErrorFile;
     requiredFields: TaxDocumentationPropertyFile;
-    submittableFields: TaxDocumentation;
     visibleFields: TaxDocumentationPropertyFile;
     hideField: (key: TaxDocumentationKey) => void;
     showField: (key: TaxDocumentationKey) => void;

package/dist/{contexts → src/contexts}/FormUI/useFormUIContext.d.ts

@@ -30,7 +30,6 @@ export declare const useFormUIContext: () => {
     notifiedFields: import("../../validations/getNotifiedFields").Notifications;
     invalidFields: import("./useFormUI").TaxDocumentationErrorFile;
     requiredFields: import("./useFormUI").TaxDocumentationPropertyFile;
-    submittableFields: import("../../types").TaxDocumentation;
     visibleFields: import("./useFormUI").TaxDocumentationPropertyFile;
     hideField: (key: keyof import("../../types").AccountHolderContactData | keyof import("../../types").AccountHolderTaxData | keyof import("../../types").AccountHolderClassificationData | keyof import("../../types").RegardedOwnerContactData | keyof import("../../types").RegardedOwnerClassificationData | keyof import("../../types").RegardedOwnerTaxData | keyof import("../../types").SummaryData | "accountHolderTaxResidences") => void;
     showField: (key: keyof import("../../types").AccountHolderContactData | keyof import("../../types").AccountHolderTaxData | keyof import("../../types").AccountHolderClassificationData | keyof import("../../types").RegardedOwnerContactData | keyof import("../../types").RegardedOwnerClassificationData | keyof import("../../types").RegardedOwnerTaxData | keyof import("../../types").SummaryData | "accountHolderTaxResidences") => void;
@@ -65,7 +64,6 @@ export declare const useFormUIContext: () => {
     notifiedFields: import("../../validations/getNotifiedFields").Notifications;
     invalidFields: import("./useFormUI").TaxDocumentationErrorFile;
     requiredFields: import("./useFormUI").TaxDocumentationPropertyFile;
-    submittableFields: import("../../types").TaxDocumentation;
     visibleFields: import("./useFormUI").TaxDocumentationPropertyFile;
     hideField: (key: keyof import("../../types").AccountHolderContactData | keyof import("../../types").AccountHolderTaxData | keyof import("../../types").AccountHolderClassificationData | keyof import("../../types").RegardedOwnerContactData | keyof import("../../types").RegardedOwnerClassificationData | keyof import("../../types").RegardedOwnerTaxData | keyof import("../../types").SummaryData | "accountHolderTaxResidences") => void;
     showField: (key: keyof import("../../types").AccountHolderContactData | keyof import("../../types").AccountHolderTaxData | keyof import("../../types").AccountHolderClassificationData | keyof import("../../types").RegardedOwnerContactData | keyof import("../../types").RegardedOwnerClassificationData | keyof import("../../types").RegardedOwnerTaxData | keyof import("../../types").SummaryData | "accountHolderTaxResidences") => void;

package/dist/{utils → src/utils}/getFieldsState.d.ts

@@ -3,6 +3,7 @@ import { TaxForm } from '../types';
 export declare const getFieldsState: (fields: TaxDocumentation, supportedForms?: TaxForm[]) => {
     accountHolderIsDisregarded: boolean;
     hasNoEUTaxId: boolean;
+    hasTaxResidence: boolean;
     isDac7: boolean;
     isW9: boolean;
     isW8: boolean;

package/dist/{validations → src/validations}/index.d.ts

@@ -1,6 +1,5 @@
 export * from './getInvalidFields';
 export * from './getRequiredFields';
-export * from './getSubmittableFields';
 export * from './getSupportedFields';
 export * from './getVisibleFields';
 export * from './invalidFieldRules.ts';

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

@@ -0,0 +1,9 @@
+export * from './AccountHolderClassification';
+export * from './AccountHolderContact';
+export * from './AccountHolderTax';
+export * from './AccountHolderTaxClarification';
+export * from './Exemptions';
+export * from './RegardedOwnerClassification';
+export * from './RegardedOwnerContact';
+export * from './RegardedOwnerTax';
+export * from './Summary';