@taxbit/react-sdk 2.2.0-beta.1 → 2.3.0-beta.0

package/dist/src/i18n/types/PropertyFile.d.ts

@@ -34,11 +34,11 @@ export type PropertyFile = {
 };
 export type ForeignPropertyFile = {
     button: PropertyFile['button'];
-    prompt: Pick<PropertyFile['prompt'], 'addAdditionalResidence' | 'addControllingPerson' | 'foreignAccountType' | 'financialInstitutionType' | 'activeNonFinancialEntityType' | 'passiveEntityType' | 'managedEntityType' | 'investmentEntityManaged' | 'iUnderstandTheInformationIsCovered' | 'iAcknowledgeTheInformationMayBeProvided' | 'iAcknowledgeESignIsOKForeign' | 'iCertifyIAmAccountHolder' | 'iCertifyIAmAuthorizedToSignForAccountHolder' | 'iCertifyIWillNotifyPersons' | 'iDeclareStatementsAreCorrect' | 'iWillNotifyChangeInCircumstanceForIndividual' | 'iWillNotifyChangeInCircumstanceForAccountHolder' | 'otherRole' | 'otherEquivalentRole' | 'ownershipPercentage' | 'relatedCorporation' | 'removeControllingPerson' | 'role' | 'securitiesMarket' | 'taxIdNumberIsNotRequiredReason' | 'taxIdNumberIsNotRequiredReasonOther' | 'address' | 'mailingAddressIsDifferent' | 'businessRegistrationCountry' | 'businessRegistrationNumber' | 'city' | 'cityOfBirth' | 'country' | 'countryOfBirth' | 'dateOfBirth' | 'day' | 'emailAddress' | 'iCertifyToAll' | 'iConfirmTheInformationIsCorrectComplete' | 'iHaveCapacityToSignForEntity' | 'iHaveCapacityToSignForIndividual' | 'isIndividual' | 'month' | 'name' | 'nameOfEntity' | 'nameOfIndividual' | 'phoneNumber' | 'phoneNumberCode' | 'phoneNumberNumber' | 'province' | 'removeResidence' | 'countyRegion' | 'stateProvince' | 'street' | 'street2' | 'signature' | 'signatureCapacity' | 'signatureCapacityOther' | 'taxIdNumber' | 'taxIdNumberIsNotRequired' | 'tin' | 'tinUkCrn' | 'tinUkNino' | 'type' | 'usTin' | 'vatCountry' | 'vatIdentificationNumber' | 'vatIsNotRequired' | 'year' | 'zip'>;
+    prompt: Pick<PropertyFile['prompt'], 'addAdditionalResidence' | 'addControllingPerson' | 'foreignAccountType' | 'financialInstitutionType' | 'activeNonFinancialEntityType' | 'passiveEntityType' | 'managedEntityType' | 'investmentEntityManaged' | 'iUnderstandTheInformationIsCovered' | 'iAcknowledgeTheInformationMayBeProvided' | 'iCertifyIAmAccountHolder' | 'iCertifyIAmAuthorizedToSignForAccountHolder' | 'iDeclareStatementsAreCorrect' | 'iWillNotifyChangeInCircumstance' | 'otherRole' | 'otherEquivalentRole' | 'ownershipPercentage' | 'relatedCorporation' | 'removeControllingPerson' | 'role' | 'securitiesMarket' | 'taxIdNumberIsNotRequiredReason' | 'taxIdNumberIsNotRequiredReasonOther' | 'address' | 'mailingAddressIsDifferent' | 'businessRegistrationCountry' | 'businessRegistrationNumber' | 'city' | 'cityOfBirth' | 'country' | 'countryOfBirth' | 'dateOfBirth' | 'day' | 'emailAddress' | 'isIndividual' | 'month' | 'name' | 'nameOfEntity' | 'nameOfIndividual' | 'phoneNumber' | 'phoneNumberCode' | 'phoneNumberNumber' | 'province' | 'removeResidence' | 'countyRegion' | 'stateProvince' | 'street' | 'street2' | 'signature' | 'signatureCapacity' | 'signatureCapacityOther' | 'taxIdNumber' | 'taxIdNumberIsNotRequired' | 'tin' | 'tinUkCrn' | 'tinUkNino' | 'type' | 'usTin' | 'vatCountry' | 'vatIdentificationNumber' | 'vatIsNotRequired' | 'year' | 'zip'>;
     subPrompt: Pick<PropertyFile['subPrompt'], 'financialInstitutionType' | 'isIndividual' | 'placeOfBirth' | 'relatedCorporation' | 'role' | 'securitiesMarket' | 'signatureCapacityOther' | 'streetIsPermanent' | 'vatIdentificationNumber'>;
     subTitle: Pick<PropertyFile['subTitle'], 'taxResidences' | 'controllingPersonDetails' | 'permanentAddress'>;
-    title: Pick<PropertyFile['title'], 'acknowledge' | 'certify' | 'carfClassificationDetails' | 'controllingPersonDetails' | 'controllingPersons' | 'controllingPerson1' | 'controllingPerson2' | 'controllingPerson3' | 'controllingPerson4' | 'controllingPerson5' | 'accountHolder' | 'accountHolderClassification' | 'accountHolderContactInformation' | 'accountHolderTaxInformation' | 'accountHolderAdditionalInfo' | 'address' | 'confirmation' | 'countryOfCitizenship' | 'countryOfIncorporation' | 'placeOfBirth' | 'mailingAddress' | 'permanentAddress' | 'primaryAddress' | 'summary' | 'taxResidences' | 'taxResidence1' | 'taxResidence2' | 'taxResidence3' | 'taxResidence4' | 'taxResidence5'>;
-    text: Pick<PropertyFile['text'], 'eSignActReference' | 'interviewIsComplete' | 'notRequired' | 'notRequiredOrNotIssued' | 'retrievingInterviewStatus' | 'taxDocumentationSaved'>;
+    title: Pick<PropertyFile['title'], 'certify' | 'carfClassificationDetails' | 'controllingPersonDetails' | 'controllingPersons' | 'controllingPerson1' | 'controllingPerson2' | 'controllingPerson3' | 'controllingPerson4' | 'controllingPerson5' | 'accountHolder' | 'accountHolderClassification' | 'accountHolderContactInformation' | 'accountHolderTaxInformation' | 'accountHolderAdditionalInfo' | 'address' | 'confirmation' | 'countryOfCitizenship' | 'countryOfIncorporation' | 'placeOfBirth' | 'mailingAddress' | 'permanentAddress' | 'primaryAddress' | 'summary' | 'taxResidences' | 'taxResidence1' | 'taxResidence2' | 'taxResidence3' | 'taxResidence4' | 'taxResidence5'>;
+    text: Pick<PropertyFile['text'], 'interviewIsComplete' | 'notRequired' | 'notRequiredOrNotIssued' | 'retrievingInterviewStatus' | 'taxDocumentationSaved' | 'iCertifyIsCorrect' | 'iCertifyHaveCapacity'>;
     error: Pick<PropertyFile['error'], 'countryMustBeAResidenceCountry' | 'formHasErrors' | 'invalid' | 'invalidDate' | 'invalidVat' | 'mustBeABNFormat' | 'mustBeAtLeast18' | 'mustBeFiveOrNineDigits' | 'mustBeInDateFormat' | 'mustBeInVatinFormat' | 'mustBeNineDigits' | 'mustBeNinoFormat' | 'mustBeCaPostalCodeFormat' | 'mustBeValidBirthDate' | 'mustNotMatchVatin' | 'required' | 'residencesMustIncludeAddressCountry' | 'residencesMustIncludeAnEUCountry' | 'residencesMustIncludeVatCountry' | 'residencesMustIncludeBusinessRegistrationCountry' | 'tooLong' | 'tooShort' | 'vatinMustNotMatchResidencyTin'>;
     option: Pick<PropertyFile['option'], 'no' | 'yes' | 'isIndividual_yes' | 'isIndividual_no' | 'investmentEntityManaged_yes' | 'investmentEntityManaged_no' | 'ACTIVE_NON_FINANCIAL_ENTITY' | 'PASSIVE_NON_FINANCIAL_ENTITY' | 'CUSTODIAL_INSTITUTION' | 'accountHolderActiveNonFinancialEntityType_GOVERNMENT_ENTITY' | 'INSURANCE_COMPANY' | 'INVESTMENT_ENTITY' | 'entityType_TRUST' | 'entityType_SIMILAR_TO_TRUST' | 'entityType_OTHER' | 'accountHolderActiveNonFinancialEntityType_PUBLIC_CORPORATION' | 'accountHolderActiveNonFinancialEntityType_OTHER' | 'accountHolderActiveNonFinancialEntityType_INTERNATIONAL_ORGANIZATION' | 'signatureCapacity_EXECUTOR' | 'signatureCapacity_OFFICER' | 'signatureCapacity_OTHER_CAPACITY' | 'DEPOSITORY_INSTITUTION' | 'FINANCIAL_INSTITUTION' | 'controllingPersonRole_SETTLOR' | 'controllingPersonRole_TRUSTEE' | 'controllingPersonRole_PROTECTOR' | 'controllingPersonRole_BENEFICIARY' | 'controllingPersonRole_OTHER' | 'controllingPersonRole_SETTLOR_EQUIVALENT' | 'controllingPersonRole_TRUSTEE_EQUIVALENT' | 'controllingPersonRole_PROTECTOR_EQUIVALENT' | 'controllingPersonRole_BENEFICIARY_EQUIVALENT' | 'controllingPersonRole_OTHER_EQUIVALENT' | 'controllingPersonRole_OWNER' | 'controllingPersonRole_OTHER_MEANS' | 'controllingPersonRole_SENIOR_MANAGING_OFFICIAL' | 'missingTinNotRequiredReason_NOT_ISSUED' | 'missingTinNotRequiredReason_NOT_REQUIRED' | 'missingTinNotRequiredReason_OTHER'>;
     subOption: Pick<PropertyFile['subOption'], 'accountHolderActiveNonFinancialEntityType_PUBLIC_CORPORATION' | 'accountHolderActiveNonFinancialEntityType_OTHER' | 'accountHolderSelfCertificationAccountType_FINANCIAL_INSTITUTION' | 'accountHolderSelfCertificationAccountType_ACTIVE_NON_FINANCIAL_ENTITY' | 'accountHolderSelfCertificationAccountType_PASSIVE_NON_FINANCIAL_ENTITY'>;

package/dist/src/i18n/utils/getText.d.ts

@@ -1,13 +1,13 @@
 import { Locale, TaxDocumentation } from '../../types';
-import { ButtonKey, ErrorKey, OptionKey, PromptKey, SubOptionKey, SubPromptKey, SubTitleKey, TextKey } from '../types';
+import { ButtonKey, ErrorKey, OptionKey, PromptKey, SubOptionKey, SubPromptKey } from '../types';
 
 export declare const getPromptText: (key: PromptKey, data: TaxDocumentation, locale: Locale | undefined) => string;
 export declare const getSubPromptText: (key: SubPromptKey, data: TaxDocumentation, locale: Locale | undefined) => string;
 export declare const getErrorText: (key: ErrorKey, data: TaxDocumentation, locale: Locale | undefined) => string;
 export declare const getBadgeText: (key: string, data: TaxDocumentation, locale: Locale | undefined) => string;
-export declare const getTextText: (key: TextKey, data: TaxDocumentation, locale: Locale | undefined) => string;
+export declare const getTextText: (key: string, data: TaxDocumentation, locale: Locale | undefined) => string;
 export declare const getTitleText: (key: string, data: TaxDocumentation, locale: Locale | undefined) => string;
-export declare const getSubTitleText: (key: SubTitleKey, data: TaxDocumentation, locale: Locale | undefined) => string;
+export declare const getSubTitleText: (key: string, data: TaxDocumentation, locale: Locale | undefined) => string;
 export declare const getButtonText: (key: ButtonKey, data: TaxDocumentation, locale: Locale | undefined) => string;
 export declare const getOptionText: (key: OptionKey | undefined, data: TaxDocumentation, locale: Locale | undefined) => string;
 export declare const getSubOptionText: (key: SubOptionKey | undefined, data: TaxDocumentation, locale: Locale | undefined) => string | undefined;

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/test/utils/helpers.d.ts

@@ -13,6 +13,8 @@ export declare const expectSection: (title: string) => void;
 export declare const expectNoSection: (title: string) => void;
 export declare const expectDisabledInput: (ariaLabel: string) => void;
 export declare const expectInputValue: (ariaLabel: string, value: string) => void;
+export declare const expectChecked: (label: string) => void;
+export declare const expectUnchecked: (ariaLabel: string) => void;
 export declare const clickLabel: (ariaLabel: string) => void;
 export declare const clickShow: (text: string) => void;
 export declare const changeInput: (ariaLabel: string, value: string) => void;

package/dist/src/types/TaxDocumentation.d.ts

@@ -208,12 +208,10 @@ export type RegardedOwnerTaxData = {
 export type SummaryData = {
     exemptFatcaCode?: string;
     exemptPayeeCode?: string;
-    iAcknowledgeESignIsOk?: Yes;
     iAmACitizenOfTheUs?: Yes;
     iAmExemptFromFatcaReporting?: Yes;
     iAmNotSubjectToBackupWithholding?: Yes;
     iAuthorizeWithholdingAgent?: Yes;
-    iCertifyToAll?: Yes;
     iConfirmIncomeIsNonUs?: Yes;
     iConfirmTheBeneficialOwnerIsExempt?: Yes;
     iConfirmNotAUsPerson?: Yes;
@@ -226,7 +224,6 @@ export type SummaryData = {
     iUnderstandTheInformationIsCovered?: Yes;
     iAcknowledgeTheInformationMayBeProvided?: Yes;
     iCertifyIAmAccountHolder?: Yes;
-    iCertifyIWillNotifyPersons?: Yes;
     iDeclareStatementsAreCorrect?: Yes;
     iWillNotifyChangeInCircumstance?: Yes;
     signature?: string;
@@ -241,6 +238,10 @@ export type CalculatedData = {
     regardedOwnerAddress?: string;
     regardedOwnerMailingAddress?: string;
 };
-export type TaxDocumentation = AccountHolderContactData & AccountHolderCertifications & AccountHolderTaxData & AccountHolderClassificationData & RegardedOwnerCertifications & RegardedOwnerContactData & RegardedOwnerClassificationData & RegardedOwnerTaxData & SummaryData & CalculatedData & AccountHolderTreatyClaimData & RegardedOwnerTreatyClaimData & ControllingPersonClassificationData;
+export type InformationalText = {
+    subjectToBackupWithholding?: undefined;
+    irsRequiresBackupWithholdingConsent?: undefined;
+};
+export type TaxDocumentation = AccountHolderContactData & AccountHolderCertifications & AccountHolderTaxData & AccountHolderClassificationData & RegardedOwnerCertifications & RegardedOwnerContactData & RegardedOwnerClassificationData & RegardedOwnerTaxData & SummaryData & CalculatedData & AccountHolderTreatyClaimData & RegardedOwnerTreatyClaimData & ControllingPersonClassificationData & InformationalText;
 export type TaxDocumentationKey = keyof TaxDocumentation;
 export {};

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

@@ -9,5 +9,6 @@ export type CheckBoxProps = {
     onClick?: (val: Yes | undefined) => void;
     disabled?: boolean;
     indicateRequired?: boolean;
+    defaultChecked?: boolean;
 };
-export declare const CheckBox: ({ label, subLabel, name, onClick, disabled, indicateRequired, }: CheckBoxProps) => React.JSX.Element;
+export declare const CheckBox: ({ label, subLabel, name, onClick, disabled, indicateRequired, defaultChecked, }: CheckBoxProps) => React.JSX.Element;

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

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

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,11 @@
+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;
+    'aria-required': boolean;
+};