@taxbit/react-sdk 2.2.0-beta.0 → 2.2.0-beta.2

package/README.md

@@ -157,9 +157,22 @@ The serverData object contains the currently saved tax documentation data for th
 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
+type QuestionnaireIssue = {
+  issueType:
+    | 'CARE_OF_PERMANENT_ADDRESS'
+    | 'PO_BOX_PERMANENT_ADDRESS'
+    | 'US_PERMANENT_ADDRESS'
+    | 'TREATY_COUNTRY_MISMATCH'
+    | 'US_INDICIA'
+    | 'WITHHOLDING_DOCUMENTATION'
+    | 'CHANGE_IN_CIRCUMSTANCES';
+  createdAt: string;
+};
+
 type ClientTaxDocumentationStatus = {
   dpsQuestionnaire?: {
     dataCollectionStatus: 'COMPLETE' | 'INCOMPLETE';
+    expirationDate?: string;
     vatStatus?:
       | 'PENDING'
       | 'VALID'
@@ -168,12 +181,13 @@ type ClientTaxDocumentationStatus = {
       | 'NOT_REQUIRED'
       | 'NON_EU';
     vatValidationDate?: string;
-    expirationDate?: string;
   };
   wFormQuestionnaire?: {
     dataCollectionStatus: 'COMPLETE' | 'INCOMPLETE';
     type: 'W-9' | 'W-8BEN' | 'W-8BEN-E' | 'W-8IMY';
     expirationDate?: string;
+    issues?: QuestionnaireIssue[];
+    needsResubmission?: boolean;
     tinStatus?:
       | 'PENDING'
       | 'FOREIGN'
@@ -185,11 +199,12 @@ type ClientTaxDocumentationStatus = {
       | 'TIN_NOT_ISSUED'
       | 'ERROR';
     tinValidationDate?: string;
-    needsResubmission: boolean;
+    treatyClaimStatus?: 'VALID' | 'INVALID';
   };
   selfCertification?: {
     dataCollectionStatus: 'COMPLETE' | 'INCOMPLETE';
-    needsResubmission: boolean;
+    issues?: QuestionnaireIssue[];
+    needsResubmission?: boolean;
   };
 };
 ```
@@ -331,6 +346,14 @@ type QuestionnaireType = 'DPS' | 'W-FORM' | 'SELF-CERT';
 
 ## Changelog
 
+### Version 2.2.0-beta.2
+
+1. Bug fix, hiding email field for non-AU residents.
+
+### Version 2.2.0-beta.1
+
+1. Updating TaxDocumentationStatus type to include issues and treatyClaimStatus.
+
 ### Version 2.2.0-beta.0
 
 1. Adding SERR support for Australian residents.

package/dist/src/contexts/QuestionnaireStep/useQuestionnaireStepContext.d.ts

@@ -1,3 +1,6 @@
+import { useQuestionnaireStep } from './useQuestionnaireStep.ts';
+
+export type QuestionnaireStepContextValue = ReturnType<typeof useQuestionnaireStep>;
 export declare const useQuestionnaireStepContext: () => {
     getBadgeKey: (key: import('../../types/TaxDocumentation.ts').TaxDocumentationKey) => import('../../hooks/index.ts').UsTinValidationStatus | undefined;
     getLocalAddressTitle: (data: import('../../types/TaxDocumentation.ts').TaxDocumentation) => string;

package/dist/src/test/StepWrapper.d.ts

@@ -0,0 +1,11 @@
+import { QuestionnaireStepContextValue } from 'contexts/QuestionnaireStep/useQuestionnaireStepContext';
+import { default as React } from 'react';
+
+/**
+ * A wrapper for unit testing questionnaire components that combines a real value from the
+ * `useQuestionnaireStep` hook with the provided context value overrides.
+ */
+export declare const StepWrapper: ({ contextValue, children, }: {
+    contextValue: Partial<QuestionnaireStepContextValue>;
+    children: React.ReactNode;
+}) => React.JSX.Element;

package/dist/src/test/Wrapper.d.ts

@@ -1,8 +1,26 @@
 import { ClientTaxDocumentation } from '@taxbit/utilities';
+import { QuestionnaireStepContextValue } from 'contexts';
 import { default as React } from 'react';
 import { QuestionnaireProp } from '../types';
 
-export declare const Wrapper: React.FC<React.PropsWithChildren & {
+export type WrapperProps = React.PropsWithChildren<{
+    /**
+     * Initial data for the questionnaire.
+     */
     initialData?: ClientTaxDocumentation;
+    /**
+     * The type of questionnaire to render. Defaults to 'W-FORM'.
+     */
     questionnaire?: QuestionnaireProp;
+    /**
+     * Overrides for the context value of the `QuestionnaireStepProvider`. When provided, these
+     * overrides will be combined with the real output of a `useQuestionnaireStep` hook to produce
+     * a complete context value. When not provided, an actual provider with complete stateful data
+     * will be rendered.
+     */
+    contextValue?: Partial<QuestionnaireStepContextValue>;
 }>;
+/**
+ * A test wrapper for unit testing questionnaire components.
+ */
+export declare const Wrapper: React.FC<WrapperProps>;

package/dist/src/test/getWrapper.d.ts

@@ -1,5 +1,7 @@
-import { ClientTaxDocumentation } from '@taxbit/utilities';
 import { default as React } from 'react';
-import { QuestionnaireProp } from '../types';
+import { WrapperProps } from './Wrapper';
 
-export declare const getWrapper: (initialData?: ClientTaxDocumentation, questionnaire?: QuestionnaireProp) => ({ children }: React.PropsWithChildren) => React.ReactNode | Promise<React.ReactNode>;
+/**
+ * A helper function to create a test wrapper for unit testing questionnaire components.
+ */
+export declare const getWrapper: (initialData?: WrapperProps["initialData"], questionnaire?: WrapperProps["questionnaire"], contextValue?: WrapperProps["contextValue"]) => ({ children }: React.PropsWithChildren) => React.ReactNode | Promise<React.ReactNode>;

package/dist/src/test/renderWithWrapper.d.ts

@@ -0,0 +1,3 @@
+import { WrapperProps } from './Wrapper';
+
+export declare const renderWithWrapper: ({ contextValue, children, initialData, questionnaire, }: WrapperProps) => import('@testing-library/react').RenderResult<typeof import("@testing-library/dom/types/queries"), HTMLElement, HTMLElement>;

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

@@ -1,20 +1,28 @@
+type QuestionnaireIssue = {
+    issueType: 'CARE_OF_PERMANENT_ADDRESS' | 'PO_BOX_PERMANENT_ADDRESS' | 'US_PERMANENT_ADDRESS' | 'TREATY_COUNTRY_MISMATCH' | 'US_INDICIA' | 'WITHHOLDING_DOCUMENTATION' | 'CHANGE_IN_CIRCUMSTANCES';
+    createdAt: string;
+};
 export type ClientTaxDocumentationStatus = {
     dpsQuestionnaire?: {
         dataCollectionStatus: 'COMPLETE' | 'INCOMPLETE';
+        expirationDate?: string;
         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';
+        type: 'W-9' | 'W-8BEN' | 'W-8BEN-E' | 'W-8IMY';
         expirationDate?: string;
+        issues?: QuestionnaireIssue[];
+        needsResubmission?: boolean;
         tinStatus?: 'PENDING' | 'FOREIGN' | 'INVALID_DATA' | 'VALID_SSN_MATCH' | 'VALID_EIN_MATCH' | 'VALID_SSN_EIN_MATCH' | 'MISMATCH' | 'TIN_NOT_ISSUED' | 'ERROR';
         tinValidationDate?: string;
-        needsResubmission: boolean;
+        treatyClaimStatus?: 'VALID' | 'INVALID';
     };
     selfCertification?: {
         dataCollectionStatus: 'COMPLETE' | 'INCOMPLETE';
-        needsResubmission: boolean;
+        issues?: QuestionnaireIssue[];
+        needsResubmission?: boolean;
     };
 };
+export {};

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

@@ -1,20 +1,28 @@
+type Issue = {
+    issue_type: 'CARE_OF_PERMANENT_ADDRESS' | 'PO_BOX_PERMANENT_ADDRESS' | 'US_PERMANENT_ADDRESS' | 'TREATY_COUNTRY_MISMATCH' | 'US_INDICIA' | 'WITHHOLDING_DOCUMENTATION' | 'CHANGE_IN_CIRCUMSTANCES';
+    created_at: string;
+};
 export type TaxDocumentationStatus = {
     dps_questionnaire?: {
         data_collection_status: 'COMPLETE' | 'INCOMPLETE';
+        expiration_date?: string;
         vat_status?: 'PENDING' | 'VALID' | 'INVALID' | 'INSUFFICIENT_DATA' | 'NOT_REQUIRED' | 'NON_EU';
         vat_validation_date?: string;
-        expiration_date?: string;
     };
     w_form_questionnaire?: {
         data_collection_status: 'COMPLETE' | 'INCOMPLETE';
-        type: 'W-9' | 'W-8BEN' | 'W-8BEN-E';
+        type: 'W-9' | 'W-8BEN' | 'W-8BEN-E' | 'W-8IMY';
         expiration_date?: string;
+        issues?: Issue[];
+        needs_resubmission?: boolean;
         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;
+        treaty_claim_status?: 'VALID' | 'INVALID';
     };
     self_certification: {
         data_collection_status: 'COMPLETE' | 'INCOMPLETE';
-        needs_resubmission: boolean;
+        issues?: Issue[];
+        needs_resubmission?: boolean;
     };
 };
+export {};

package/dist/src/ui/CheckBox/__tests__/CheckBox.test.d.ts

@@ -0,0 +1 @@
+

package/dist/src/ui/DateOfBirthInput/__tests__/DateOfBirthInput.test.d.ts

@@ -1 +1 @@
-export {};
+

package/dist/src/ui/FormattedInput/__tests__/FormattedInput.test.d.ts

@@ -0,0 +1 @@
+

package/dist/src/ui/PasswordInput/__tests__/PasswordInput.test.d.ts

@@ -0,0 +1 @@
+

package/dist/src/ui/PhoneNumberInput/__tests__/PhoneNumberInput.test.d.ts

@@ -0,0 +1 @@
+

package/dist/src/ui/Select/__tests__/Select.test.d.ts

@@ -0,0 +1 @@
+

package/dist/src/ui/TextArea/__tests__/TextArea.test.d.ts

@@ -0,0 +1 @@
+

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

@@ -13,4 +13,5 @@ export * from './ShowHideInput';
 export * from './TextArea';
 export * from './TextInput';
 export * from './ToggleButton';
+export * from './useAriaAttributes';
 export * from './WithholdingInput';

package/dist/src/ui/useAriaAttributes.d.ts

@@ -0,0 +1,10 @@
+import { TaxDocumentationKey } from '../types/TaxDocumentation';
+
+/**
+ * Hook that returns any aria attributes needed to properly set up the given
+ * field for assistive technologies.
+ */
+export declare const useAriaAttributes: (fieldName: TaxDocumentationKey) => {
+    'aria-invalid': boolean;
+    'aria-describedby': string | undefined;
+};

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

@@ -0,0 +1,3 @@
+import { TaxDocumentationKey } from 'types';
+
+export declare const getErrorMessageId: (name: TaxDocumentationKey) => string;

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

@@ -1,6 +1,7 @@
 export * from './bearerTokenIsRequiredError';
 export * from './cx';
 export * from './formatTin';
+export * from './getErrorMessageId';
 export * from './getFieldsState';
 export * from './getFormStatus';
 export * from './getHeaders';

package/dist/src/wizard/RowInput/ErrorRow/__tests__/ErrorRow.test.d.ts

@@ -0,0 +1 @@
+