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

package/README.md

@@ -346,6 +346,10 @@ 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.

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/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 @@
+