@taxbit/react-sdk 1.0.0-beta.7 → 1.1.0-beta.0

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

@@ -0,0 +1,8 @@
+type TypeOfIncome = 'ROYALTIES_OTHER' | 'BUSINESS_PROFITS' | 'SERVICES';
+export declare const typeOfIncomeIndividualOptions: {
+    value: TypeOfIncome;
+}[];
+export declare const typeOfIncomeEntityOptions: {
+    value: TypeOfIncome;
+}[];
+export {};

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

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

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

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

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

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

package/dist/src/services/api.d.ts

@@ -1,14 +1,15 @@
 import { Questionnaire } from 'types';
+
 export declare const api: {
     taxDocumentationSubmissions: {
-        post: (environment: 'PRODUCTION' | 'STAGING') => string;
-        get: (environment: 'PRODUCTION' | 'STAGING', questionnaire: Questionnaire) => string;
+        post: (environment: "PRODUCTION" | "STAGING") => string;
+        get: (environment: "PRODUCTION" | "STAGING", questionnaire: Questionnaire) => string;
     };
     taxDocumentationStatus: {
-        get: (environment: 'PRODUCTION' | 'STAGING') => string;
+        get: (environment: "PRODUCTION" | "STAGING") => string;
     };
     taxDocument: {
-        post: (environment: 'PRODUCTION' | 'STAGING') => string;
-        get: (documentId: string, environment: 'PRODUCTION' | 'STAGING') => string;
+        post: (environment: "PRODUCTION" | "STAGING") => string;
+        get: (documentId: string, environment: "PRODUCTION" | "STAGING") => string;
     };
 };

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

@@ -1,6 +1,7 @@
 import { ClientTaxDocumentation } from '@taxbit/utilities';
-import React from 'react';
+import { default as React } from 'react';
 import { Questionnaire } from '../types';
+
 export declare const Wrapper: React.FC<React.PropsWithChildren & {
     initialData?: ClientTaxDocumentation;
     questionnaire?: Questionnaire;

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

@@ -1,4 +1,5 @@
 import { ClientTaxDocumentation } from '@taxbit/utilities';
-import React from 'react';
+import { default as React } from 'react';
 import { Questionnaire } from '../types';
+
 export declare const getWrapper: (initialData?: ClientTaxDocumentation, questionnaire?: Questionnaire) => ({ children }: React.PropsWithChildren) => React.ReactNode;

package/dist/src/test/utils/helpers.d.ts

@@ -2,6 +2,7 @@ export declare const expectRowError: (prompt: string) => void;
 export declare const expectRowErrorText: (prompt: string, text: string) => void;
 export declare const expectNoRowError: (prompt: string) => void;
 export declare const expectText: (text: string, length?: number) => void;
+export declare const expectSummaryFieldText: (field: string, text: string) => void;
 export declare const expectNullInput: (ariaLabel: string) => void;
 export declare const expectDisabledInput: (ariaLabel: string) => void;
 export declare const expectInputValue: (ariaLabel: string, value: string) => void;
@@ -14,6 +15,7 @@ export declare const clickBack: () => void;
 export declare const clickNext: () => void;
 export declare const clickSubmit: () => void;
 export declare const clickAddAdditionalResidence: () => void;
+export declare const clickRemoveResidence: (index: 1 | 2 | 3 | 4 | 5) => void;
 export declare const setBusinessNameAndAddress: (prefix?: string) => void;
 export declare const setIndividualNameAndAddress: (prefix?: string) => void;
 export declare const setUSIndividualNameAndAddress: (prefix?: string) => void;

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

@@ -1,5 +1,5 @@
-declare const inputSteps: readonly ["AccountHolderClassification", "AccountHolderContact", "AccountHolderTax", "AccountHolderTaxClarification", "Exemptions", "RegardedOwnerContact", "RegardedOwnerTax", "Summary"];
+declare const inputSteps: readonly ["AccountHolderClassification", "AccountHolderContact", "AccountHolderTax", "AccountHolderTaxClarification", "AccountHolderTreatyClaims", "Exemptions", "RegardedOwnerContact", "RegardedOwnerTax", "RegardedOwnerTreatyClaims", "Summary", "W8imyInstructions"];
 export type InputStep = (typeof inputSteps)[number];
-export declare const isInputStep: (step: string) => step is "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "Summary";
+export declare const isInputStep: (step: string) => step is InputStep;
 export declare const confirmInputStep: (step: string) => InputStep;
 export {};

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

@@ -1,5 +1,6 @@
 import { Locale } from './Locale';
 import { StepId } from './StepId';
+
 export type Progress = {
     language: Locale;
     percentComplete: number;

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

@@ -1 +1 @@
-export type StepId = 'accountHolderContactInformation' | 'accountHolderTaxInformation' | 'accountHolderClassification' | 'accountHolderTaxClarification' | 'confirmation' | 'exemptions' | 'regardedOwnerContactInformation' | 'regardedOwnerTaxInformation' | 'summary';
+export type StepId = 'accountHolderContactInformation' | 'accountHolderTaxInformation' | 'accountHolderClassification' | 'accountHolderTaxClarification' | 'accountHolderTreatyClaims' | 'confirmation' | 'exemptions' | 'regardedOwnerContactInformation' | 'regardedOwnerTaxInformation' | 'regardedOwnerTreatyClaims' | 'summary' | 'w8imyInstructions';

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

@@ -1,6 +1,7 @@
-import type { ForeignAccountHolderAccountType, ForeignOtherClassification, ForeignRegardedOwnerAccountType, ForeignTrustClassification, UsAccountHolderAccountType, UsLLCAccountType, UsRegardedOwnerAccountType } from '@taxbit/utilities';
-import type { Yes } from './Yes';
-import type { YesNo } from './YesNo';
+import { ForeignAccountHolderAccountType, ForeignOtherClassification, ForeignRegardedOwnerAccountType, ForeignTrustClassification, UsAccountHolderAccountType, UsLLCAccountType, UsRegardedOwnerAccountType } from '@taxbit/utilities';
+import { Yes } from './Yes';
+import { YesNo } from './YesNo';
+
 export type AccountHolderClassificationData = {
     accountHolderIsIndividual?: YesNo;
     accountHolderUsPerson?: YesNo;
@@ -35,6 +36,28 @@ export type AccountHolderContactData = {
     accountHolderMailingAddressZip?: string;
     accountHolderName?: string;
 };
+export type AccountHolderTreatyClaimData = {
+    accountHolderTreatyClaimIsEligible?: YesNo;
+    accountHolderTreatyClaimCountry?: string;
+    accountHolderTreatyClaimICertifyResident?: Yes;
+    accountHolderTreatyClaimICertifyRequirements?: Yes;
+    accountHolderTreatyClaimLimitationOnBenefits?: string;
+    accountHolderTreatyClaimLimitationOnBenefitsOtherArticleParagraph?: string;
+    accountHolderTreatyClaimTypeOfIncome?: string;
+    accountHolderTreatyClaimWithholding?: string;
+    accountHolderTreatyClaimHasAdditionalConditions?: Yes;
+};
+export type RegardedOwnerTreatyClaimData = {
+    regardedOwnerTreatyClaimIsEligible?: YesNo;
+    regardedOwnerTreatyClaimCountry?: string;
+    regardedOwnerTreatyClaimICertifyResident?: Yes;
+    regardedOwnerTreatyClaimICertifyRequirements?: Yes;
+    regardedOwnerTreatyClaimLimitationOnBenefits?: string;
+    regardedOwnerTreatyClaimLimitationOnBenefitsOtherArticleParagraph?: string;
+    regardedOwnerTreatyClaimTypeOfIncome?: string;
+    regardedOwnerTreatyClaimWithholding?: string;
+    regardedOwnerTreatyClaimHasAdditionalConditions?: Yes;
+};
 export type AccountHolderTaxData = {
     accountHolderForeignTin?: string;
     accountHolderForeignTinIsNotRequired?: Yes;
@@ -56,6 +79,7 @@ export type AccountHolderTaxData = {
     accountHolderTaxResidenceCountry5?: string;
     accountHolderTaxResidenceTin5?: string;
     accountHolderTaxResidenceTin5IsNotRequired?: Yes;
+    accountHolderShowTaxResidence1?: YesNo;
     accountHolderShowTaxResidence2?: YesNo;
     accountHolderShowTaxResidence3?: YesNo;
     accountHolderShowTaxResidence4?: YesNo;
@@ -103,6 +127,7 @@ export type SummaryData = {
     exemptFatcaCode?: string;
     exemptPayeeCode?: string;
     iAcknowledgeESignIsOk?: Yes;
+    iAgreeWillResubmitIfIncorrect?: Yes;
     iAmACitizenOfTheUs?: Yes;
     iAmExemptFromFatcaReporting?: Yes;
     iAmNotSubjectToBackupWithholding?: Yes;
@@ -126,5 +151,5 @@ export type CalculatedData = {
     regardedOwnerAddress?: string;
     regardedOwnerMailingAddress?: string;
 };
-export type TaxDocumentation = AccountHolderContactData & AccountHolderTaxData & AccountHolderClassificationData & RegardedOwnerContactData & RegardedOwnerClassificationData & RegardedOwnerTaxData & SummaryData & CalculatedData;
+export type TaxDocumentation = AccountHolderContactData & AccountHolderTaxData & AccountHolderClassificationData & RegardedOwnerContactData & RegardedOwnerClassificationData & RegardedOwnerTaxData & SummaryData & CalculatedData & AccountHolderTreatyClaimData & RegardedOwnerTreatyClaimData;
 export type TaxDocumentationKey = keyof TaxDocumentation;

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

@@ -1,5 +1,6 @@
-import React from 'react';
+import { default as React } from 'react';
 import { TaxDocumentationKey } from 'types/TaxDocumentation';
+
 export type ActionButtonProps = {
     name: TaxDocumentationKey;
     onClick: () => void;

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

@@ -1,12 +1,12 @@
-import React from 'react';
+import { default as React } from 'react';
+
 type ActionsProps = {
     onBack?: (data: unknown) => void;
-    onCancel?: (data: unknown) => void;
     onNext?: (data: unknown) => void;
     onReset?: (data: unknown) => void;
     onSubmit?: (data: unknown) => void;
     disabled?: boolean;
     info?: string;
 };
-export declare const Actions: ({ onBack, onCancel, onNext, onSubmit, onReset, disabled, info, }: ActionsProps) => React.JSX.Element;
+export declare const Actions: ({ onBack, onNext, onSubmit, onReset, disabled, info, }: ActionsProps) => React.JSX.Element;
 export {};

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

@@ -1 +1 @@
-export * from "./Actions";
+export * from './Actions';

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

@@ -1,11 +1,13 @@
-import React from 'react';
+import { default as React } from 'react';
 import { TaxDocumentationKey } from 'types/TaxDocumentation';
 import { Yes } from 'types/Yes';
+
 export type CheckBoxProps = {
     label: boolean;
     subLabel?: boolean;
     name: TaxDocumentationKey;
     onClick?: (val: Yes | undefined) => void;
     disabled?: boolean;
+    indicateRequired?: boolean;
 };
-export declare const CheckBox: ({ label, subLabel, name, onClick, disabled, }: CheckBoxProps) => React.JSX.Element;
+export declare const CheckBox: ({ label, subLabel, name, onClick, disabled, indicateRequired, }: CheckBoxProps) => React.JSX.Element;

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

@@ -1 +1 @@
-export * from "./CheckBox";
+export * from './CheckBox';

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

@@ -1,5 +1,6 @@
-import React from 'react';
+import { default as React } from 'react';
 import { TaxDocumentationKey } from 'types/TaxDocumentation';
+
 export type DateOfBirthInputProps = {
     name: TaxDocumentationKey;
     className?: string;

package/dist/src/ui/DateOfBirthInput/useDateOfBirthInput.d.ts

@@ -1,5 +1,6 @@
-import React from 'react';
+import { default as React } from 'react';
 import { TaxDocumentationKey } from 'types';
+
 export declare const useDateOfBirthInput: (name: TaxDocumentationKey) => {
     mm: string;
     dd: string;
@@ -8,7 +9,7 @@ export declare const useDateOfBirthInput: (name: TaxDocumentationKey) => {
     handleMonthChange: (e: React.ChangeEvent<HTMLSelectElement>) => void;
     handleYearChange: (e: React.ChangeEvent<HTMLSelectElement>) => void;
     dayOptions: {
-        value: "01" | "02" | "03" | "04" | "05" | "06" | "07" | "08" | "09" | "10" | "11" | "12" | "13" | "14" | "15" | "16" | "17" | "18" | "19" | "20" | "21" | "22" | "23" | "24" | "25" | "26" | "27" | "28" | "29" | "30" | "31";
+        value: T;
     }[];
     birthYearOptions: {
         value: number;

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

@@ -1,5 +1,6 @@
-import React from 'react';
+import { default as React } from 'react';
 import { TaxDocumentationKey } from '../../types';
+
 type FormattedInputProps = {
     name: TaxDocumentationKey;
     format: (s: string) => string;

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

@@ -1,4 +1,5 @@
-import React from 'react';
+import { default as React } from 'react';
+
 export type HideShowButtonProps = {
     onClick: () => void;
 };

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

@@ -1 +1 @@
-export * from "./HideShowButton";
+export * from './HideShowButton';

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

@@ -1,5 +1,6 @@
-import React from 'react';
+import { default as React } from 'react';
 import { TaxDocumentationKey } from 'types/TaxDocumentation';
+
 export type InputValueProps = {
     name: TaxDocumentationKey;
     value?: string;

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

@@ -1,5 +1,6 @@
-import React from 'react';
+import { default as React } from 'react';
 import { TaxDocumentationKey } from '../../types';
+
 export declare const MaskedContent: ({ name }: {
     name: TaxDocumentationKey;
 }) => React.JSX.Element;

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

@@ -1 +1 @@
-export * from "./MaskedContent";
+export * from './MaskedContent';

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

@@ -1,5 +1,6 @@
-import React from 'react';
+import { default as React } from 'react';
 import { TaxDocumentationKey } from 'types';
+
 export type PasswordInputProps = {
     name: TaxDocumentationKey;
     className?: string;

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

@@ -1,13 +1,16 @@
 import { OptionKey } from 'i18n/types';
-import React from 'react';
+import { default as React } from 'react';
 import { TaxDocumentationKey } from 'types/TaxDocumentation';
-type SelectOption = {
-    value: OptionKey;
+
+type RadioOption = {
+    value: string;
     label?: string;
+    disabled?: boolean;
 };
 export type RadioButtonsProps = {
     name: TaxDocumentationKey;
-    options: ReadonlyArray<SelectOption>;
+    options: ReadonlyArray<RadioOption>;
+    retainErrors?: boolean;
 };
-export declare const RadioButtons: <T extends OptionKey>({ name, options, }: RadioButtonsProps) => React.JSX.Element;
+export declare const RadioButtons: <T extends OptionKey>({ name, options, retainErrors, }: RadioButtonsProps) => React.JSX.Element;
 export {};

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

@@ -0,0 +1 @@
+

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

@@ -1,6 +1,7 @@
 import { OptionKey } from 'i18n/types';
-import React from 'react';
+import { default as React } from 'react';
 import { TaxDocumentationKey } from 'types/TaxDocumentation';
+
 type ValueOption = {
     value: string;
     label?: string;

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

@@ -1,5 +1,6 @@
-import React from 'react';
+import { default as React } from 'react';
 import { TaxDocumentationKey } from 'types/TaxDocumentation';
+
 export type ShowHideInputProps = {
     name: TaxDocumentationKey;
     className?: string;

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

@@ -0,0 +1,12 @@
+import { default as React } from 'react';
+import { TaxDocumentationKey } from 'types/TaxDocumentation';
+
+export type TextAreaProps = {
+    name: TaxDocumentationKey;
+    className?: string;
+    onChange?: (val: string) => string;
+    disabled?: boolean;
+    children?: React.ReactNode;
+    defaultValue?: string;
+};
+export declare const TextArea: ({ name, className, onChange, children, disabled, defaultValue, }: TextAreaProps) => React.JSX.Element;

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

@@ -0,0 +1 @@
+

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

@@ -0,0 +1 @@
+export * from './TextArea.tsx';

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

@@ -1,5 +1,6 @@
-import React from 'react';
+import { default as React } from 'react';
 import { TaxDocumentationKey } from 'types/TaxDocumentation';
+
 export type TextInputProps = {
     name: TaxDocumentationKey;
     className?: string;

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

@@ -0,0 +1 @@
+

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

@@ -1,5 +1,6 @@
-import React from 'react';
+import { default as React } from 'react';
 import { TaxDocumentationKey } from 'types/TaxDocumentation';
+
 export type ToggleButtonProps = {
     name: TaxDocumentationKey;
 };

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

@@ -1 +1 @@
-export * from "./ToggleButton";
+export * from './ToggleButton';

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

@@ -0,0 +1,9 @@
+import { default as React } from 'react';
+
+export type WithholdingInputProps = {
+    prefix: 'accountHolder' | 'regardedOwner';
+    country?: string;
+    typeOfIncome?: string;
+    className?: string;
+};
+export declare const WithholdingInput: ({ prefix, country, typeOfIncome, }: WithholdingInputProps) => React.JSX.Element;

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

@@ -0,0 +1 @@
+export * from './WithholdingInput.tsx';

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

@@ -10,5 +10,7 @@ export * from './PasswordInput';
 export * from './RadioButtons';
 export * from './Select';
 export * from './ShowHideInput';
+export * from './TextArea';
 export * from './TextInput';
 export * from './ToggleButton';
+export * from './WithholdingInput';

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

@@ -1,2 +1,4 @@
-import { CamelCaseKeys } from '../types';
+import { CamelCase, CamelCaseKeys } from '../types';
+
+export declare const camelCase: (str: string) => CamelCase<string>;
 export declare const camelCaseKeys: <T, U>(item: T) => CamelCaseKeys<T>;

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

@@ -1,4 +1,5 @@
 import { TaxDocumentation } from 'types/TaxDocumentation';
+
 export declare const getFieldsState: (fields: TaxDocumentation) => {
     hasNoEuTaxId: boolean;
     hasEuResidence: boolean;
@@ -10,6 +11,8 @@ export declare const getFieldsState: (fields: TaxDocumentation) => {
     isBuildingWForm: boolean;
     isDre: boolean;
     isIndividual: boolean;
+    isMakingTreatyClaim: boolean;
+    isPartnership: boolean;
     residenceCountryCodes: string[];
     residences: {
         country: string | undefined;

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

@@ -1,2 +1,3 @@
 import { ClientTaxDocumentationStatus } from '../types/client';
+
 export declare const getFormStatus: (statusData: ClientTaxDocumentationStatus | undefined, questionnaire: string) => "COMPLETE" | "INCOMPLETE" | undefined;

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

@@ -1,2 +1,3 @@
 import { Locale, Questionnaire } from '../types';
+
 export declare const getLanguage: (language: string | undefined, questionnaire: Questionnaire) => Locale;

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

@@ -1,113 +1,4 @@
 import { PromptKey } from 'i18n/types';
 import { TaxDocumentation, TaxDocumentationKey } from 'types/TaxDocumentation';
-export declare const getPromptKeyMap: (data: TaxDocumentation) => {
-    exemptPayeeCode?: PromptKey | undefined;
-    exemptFatcaCode?: PromptKey | undefined;
-    iAcknowledgeESignIsOk?: PromptKey | undefined;
-    iAmACitizenOfTheUs?: PromptKey | undefined;
-    iAmExemptFromFatcaReporting?: PromptKey | undefined;
-    iAmNotSubjectToBackupWithholding?: PromptKey | undefined;
-    iAuthorizeWithholdingAgent?: PromptKey | undefined;
-    iCertifyToAll?: PromptKey | undefined;
-    iConfirmIncomeIsNonUs?: PromptKey | undefined;
-    iConfirmTheBeneficialOwnerIsExempt?: PromptKey | undefined;
-    iConfirmTheInformationIsCorrectComplete?: PromptKey | undefined;
-    iConfirmTheIndividualIsResidentOfTreatyCountry?: PromptKey | undefined;
-    iConfirmTheTaxIdIsCorrect?: PromptKey | undefined;
-    regardedOwnerUsPerson?: PromptKey | undefined;
-    signature?: PromptKey | undefined;
-    accountHolderAddressCity?: PromptKey | undefined;
-    accountHolderAddressCountry?: PromptKey | undefined;
-    accountHolderAddressState?: PromptKey | undefined;
-    accountHolderAddressStreet2?: PromptKey | undefined;
-    accountHolderAddressStreet?: PromptKey | undefined;
-    accountHolderAddressZip?: PromptKey | undefined;
-    accountHolderCityOfBirth?: PromptKey | undefined;
-    accountHolderCountryOfBirth?: PromptKey | undefined;
-    accountHolderCountryOfCitizenship?: PromptKey | undefined;
-    accountHolderDateOfBirth?: PromptKey | undefined;
-    accountHolderDbaName?: PromptKey | undefined;
-    accountHolderMailingAddressCity?: PromptKey | undefined;
-    accountHolderMailingAddressCountry?: PromptKey | undefined;
-    accountHolderMailingAddressIsDifferent?: PromptKey | undefined;
-    accountHolderMailingAddressState?: PromptKey | undefined;
-    accountHolderMailingAddressStreet2?: PromptKey | undefined;
-    accountHolderMailingAddressStreet?: PromptKey | undefined;
-    accountHolderMailingAddressZip?: PromptKey | undefined;
-    accountHolderName?: PromptKey | undefined;
-    accountHolderForeignTin?: PromptKey | undefined;
-    accountHolderForeignTinIsNotRequired?: PromptKey | undefined;
-    accountHolderUsTin?: PromptKey | undefined;
-    accountHolderFinancialAccountIdentifier?: PromptKey | undefined;
-    accountHolderFinancialAccountName?: PromptKey | undefined;
-    accountHolderTaxResidenceCountry1?: PromptKey | undefined;
-    accountHolderTaxResidenceTin1?: PromptKey | undefined;
-    accountHolderTaxResidenceTin1IsNotRequired?: PromptKey | undefined;
-    accountHolderTaxResidenceCountry2?: PromptKey | undefined;
-    accountHolderTaxResidenceTin2?: PromptKey | undefined;
-    accountHolderTaxResidenceTin2IsNotRequired?: PromptKey | undefined;
-    accountHolderTaxResidenceCountry3?: PromptKey | undefined;
-    accountHolderTaxResidenceTin3?: PromptKey | undefined;
-    accountHolderTaxResidenceTin3IsNotRequired?: PromptKey | undefined;
-    accountHolderTaxResidenceCountry4?: PromptKey | undefined;
-    accountHolderTaxResidenceTin4?: PromptKey | undefined;
-    accountHolderTaxResidenceTin4IsNotRequired?: PromptKey | undefined;
-    accountHolderTaxResidenceCountry5?: PromptKey | undefined;
-    accountHolderTaxResidenceTin5?: PromptKey | undefined;
-    accountHolderTaxResidenceTin5IsNotRequired?: PromptKey | undefined;
-    accountHolderShowTaxResidence2?: PromptKey | undefined;
-    accountHolderShowTaxResidence3?: PromptKey | undefined;
-    accountHolderShowTaxResidence4?: PromptKey | undefined;
-    accountHolderShowTaxResidence5?: PromptKey | undefined;
-    accountHolderVatIdentificationNumber?: PromptKey | undefined;
-    accountHolderVatIsNotRequired?: PromptKey | undefined;
-    accountHolderVatCountry?: PromptKey | undefined;
-    accountHolderBusinessRegistrationNumber?: PromptKey | undefined;
-    accountHolderBusinessRegistrationCountry?: PromptKey | undefined;
-    accountHolderIsIndividual?: PromptKey | undefined;
-    accountHolderUsPerson?: PromptKey | undefined;
-    accountHolderUsAccountType?: PromptKey | undefined;
-    accountHolderUsSmllcElection?: PromptKey | undefined;
-    accountHolderUsLlcClassification?: PromptKey | undefined;
-    accountHolderUsOtherClassification?: PromptKey | undefined;
-    accountHolderUsTrustEstateEin?: PromptKey | undefined;
-    accountHolderUsSoleProprietorEin?: PromptKey | undefined;
-    accountHolderForeignAccountType?: PromptKey | undefined;
-    accountHolderForeignTrustClassification?: PromptKey | undefined;
-    accountHolderForeignOtherClassification?: PromptKey | undefined;
-    regardedOwnerAddressCity?: PromptKey | undefined;
-    regardedOwnerAddressCountry?: PromptKey | undefined;
-    regardedOwnerAddressState?: PromptKey | undefined;
-    regardedOwnerAddressStreet2?: PromptKey | undefined;
-    regardedOwnerAddressStreet?: PromptKey | undefined;
-    regardedOwnerAddressZip?: PromptKey | undefined;
-    regardedOwnerCountryOfCitizenship?: PromptKey | undefined;
-    regardedOwnerDateOfBirth?: PromptKey | undefined;
-    regardedOwnerDbaName?: PromptKey | undefined;
-    regardedOwnerMailingAddressCity?: PromptKey | undefined;
-    regardedOwnerMailingAddressCountry?: PromptKey | undefined;
-    regardedOwnerMailingAddressIsDifferent?: PromptKey | undefined;
-    regardedOwnerMailingAddressState?: PromptKey | undefined;
-    regardedOwnerMailingAddressStreet2?: PromptKey | undefined;
-    regardedOwnerMailingAddressStreet?: PromptKey | undefined;
-    regardedOwnerMailingAddressZip?: PromptKey | undefined;
-    regardedOwnerName?: PromptKey | undefined;
-    regardedOwnerUsAccountType?: PromptKey | undefined;
-    regardedOwnerUsLlcClassification?: PromptKey | undefined;
-    regardedOwnerUsOtherClassification?: PromptKey | undefined;
-    regardedOwnerForeignAccountType?: PromptKey | undefined;
-    regardedOwnerForeignTrustClassification?: PromptKey | undefined;
-    regardedOwnerForeignOtherClassification?: PromptKey | undefined;
-    regardedOwnerForeignTin?: PromptKey | undefined;
-    regardedOwnerForeignTinIsNotRequired?: PromptKey | undefined;
-    regardedOwnerUsTin?: PromptKey | undefined;
-    iConfirmNotAUsPerson?: PromptKey | undefined;
-    iConfirmTheBeneficialOwner?: PromptKey | undefined;
-    iHaveCapacityToSign?: PromptKey | undefined;
-    source?: PromptKey | undefined;
-    accountHolderTaxResidences?: PromptKey | undefined;
-    accountHolderAddress?: PromptKey | undefined;
-    accountHolderMailingAddress?: PromptKey | undefined;
-    regardedOwnerAddress?: PromptKey | undefined;
-    regardedOwnerMailingAddress?: PromptKey | undefined;
-};
+
+export declare const getPromptKeyMap: (data: TaxDocumentation) => { [key in TaxDocumentationKey]?: PromptKey; };

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

@@ -0,0 +1,2 @@
+export declare const getRateOfWithholding: (val: string | undefined) => string | undefined;
+export declare const getArticleParagraph: (val: string | undefined) => string | undefined;

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

@@ -0,0 +1,38 @@
+import { LimitationOnBenefit } from '@taxbit/utilities';
+
+type TreatyWithholding = {
+    rate: string;
+    articleParagraph: string;
+    additionalConditionsRequired: boolean;
+};
+type TreatyCountry = {
+    businessProfits?: TreatyWithholding;
+    royaltiesOther?: TreatyWithholding;
+    services?: TreatyWithholding;
+    additionalConditionsRequired?: boolean;
+    limitationOnBenefits: {
+        government: boolean;
+        taxExemptPension: boolean;
+        otherTaxExemptOrganization: boolean;
+        publiclyTradedCorporation: boolean;
+        subsidiary: boolean;
+        companyMeetsErosionTest: boolean;
+        companyMeetsDerivativeTest: boolean;
+        companyMeetsBusinessTest: boolean;
+        favorableDetermination: boolean;
+        noLobArticle: boolean;
+        otherArticleParagraphs: Array<string>;
+    };
+};
+export declare const getTreatyCountry: (country?: string) => TreatyCountry;
+export declare const getTreatyCountryWithholding: (countryCode?: string, typeOfIncome?: string) => TreatyWithholding | undefined;
+export declare const getTreatyCountryWithholdingLabel: (countryCode?: string, typeOfIncome?: string) => string;
+export declare const getTreatyCountryLimitationOnBenefitsOptions: (country?: string) => Array<{
+    value: LimitationOnBenefit;
+}>;
+export declare const getTreatyCountryLimitationOnBenefitsOtherArticleParagraphOptions: (country?: string) => {
+    value: string;
+    label: string;
+}[];
+export declare const isAdditionalConditionsRequired: (country?: string, typeOfIncome?: string) => boolean;
+export {};

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

@@ -9,6 +9,8 @@ export * from './getLanguage';
 export * from './getMaskedContent';
 export * from './getMonthlyDayCount';
 export * from './getPromptKeyMap';
+export * from './getTreatyClaimDetails';
+export * from './getTreatyCountry';
 export * from './handleFetch';
 export * from './isBlank';
 export * from './kebabCase';

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

@@ -1,2 +1,3 @@
-export declare const isBlank: (val: unknown) => boolean;
+export declare const isBlank: (val: unknown) => val is "" | null | undefined;
 export declare const isPresent: (value: string | undefined) => value is string;
+export declare const presence: (val: string | undefined) => string | undefined;