@taxbit/react-sdk 2.4.0-beta.0 → 2.5.1-beta.0

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

@@ -1,13 +1,13 @@
 import { Locale, TaxDocumentation } from '../../types';
-import { ButtonKey, ErrorKey, OptionKey, PromptKey, SubOptionKey, SubPromptKey } from '../types';
+import { ButtonKey, OptionKey, PromptKey, StatusKey, 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: string, data: TaxDocumentation, locale: Locale | undefined) => string;
-export declare const getTitleText: (key: string, 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;
+export declare const getPromptText: (key: PromptKey, locale: Locale | undefined, fields?: TaxDocumentation) => string;
+export declare const getSubPromptText: (key: SubPromptKey, locale: Locale | undefined) => string;
+export declare const getStatusText: (key: StatusKey, locale: Locale | undefined) => string;
+export declare const getBadgeText: (key: string, locale: Locale | undefined) => string;
+export declare const getTextText: (key: string, locale: Locale | undefined) => string;
+export declare const getTitleText: (key: string, locale: Locale | undefined) => string;
+export declare const getSubTitleText: (key: string, locale: Locale | undefined) => string;
+export declare const getButtonText: (key: ButtonKey, locale: Locale | undefined) => string;
+export declare const getOptionText: (key: OptionKey | undefined, locale: Locale | undefined) => string;
+export declare const getSubOptionText: (key: SubOptionKey | undefined, locale: Locale | undefined) => string | undefined;

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

@@ -1,6 +1,11 @@
+type IssueDetail = {
+    field: string;
+    description: string;
+};
 type QuestionnaireIssue = {
-    issueType: 'CARE_OF_PERMANENT_ADDRESS' | 'PO_BOX_PERMANENT_ADDRESS' | 'US_PERMANENT_ADDRESS' | 'TREATY_COUNTRY_MISMATCH' | 'US_INDICIA' | 'WITHHOLDING_DOCUMENTATION' | 'CHANGE_IN_CIRCUMSTANCES';
+    issueType: 'CARE_OF_PERMANENT_ADDRESS' | 'CHANGE_IN_CIRCUMSTANCES' | 'INCOMPLETE_DATA' | 'INCONSISTENT_DATA' | 'INCOMPLETE_ADDRESS' | 'INCOMPLETE_CLASSIFICATION' | 'INCOMPLETE_US_TIN' | 'INCOMPLETE_TREATY_CLAIM' | 'PO_BOX_PERMANENT_ADDRESS' | 'TREATY_COUNTRY_MISMATCH' | 'US_INDICIA' | 'US_PERMANENT_ADDRESS' | 'WITHHOLDING_DOCUMENTATION';
     createdAt: string;
+    details: IssueDetail[];
 };
 export type ClientTaxDocumentationStatus = {
     dpsQuestionnaire?: {

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

@@ -1,6 +1,11 @@
+type IssueDetail = {
+    field: string;
+    description: string;
+};
 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';
+    issue_type: 'CARE_OF_PERMANENT_ADDRESS' | 'CHANGE_IN_CIRCUMSTANCES' | 'INCOMPLETE_DATA' | 'INCONSISTENT_DATA' | 'INCOMPLETE_ADDRESS' | 'INCOMPLETE_CLASSIFICATION' | 'INCOMPLETE_US_TIN' | 'INCOMPLETE_TREATY_CLAIM' | 'PO_BOX_PERMANENT_ADDRESS' | 'TREATY_COUNTRY_MISMATCH' | 'US_INDICIA' | 'US_PERMANENT_ADDRESS' | 'WITHHOLDING_DOCUMENTATION';
     created_at: string;
+    details: IssueDetail[];
 };
 export type TaxDocumentationStatus = {
     dps_questionnaire?: {

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

@@ -6,7 +6,6 @@ export type TextInputProps = {
     className?: string;
     onChange?: (val: string) => string;
     disabled?: boolean;
-    children?: React.ReactNode;
     defaultValue?: string;
 };
-export declare const TextInput: ({ name, className, onChange, children, disabled, defaultValue, }: TextInputProps) => React.JSX.Element;
+export declare const TextInput: ({ name, className, onChange, disabled, defaultValue, }: TextInputProps) => React.JSX.Element;

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

@@ -7,7 +7,7 @@ type Options = {
     treatyClaims?: boolean;
     externalValidations?: ExternalValidations;
 };
-export declare const getFieldsState: (fields: TaxDocumentation, questionnaire?: QuestionnaireProp, options?: Options) => {
+export declare const getFieldsState: (fields?: TaxDocumentation, questionnaire?: QuestionnaireProp, options?: Options) => {
     hasNoEuTaxId: boolean;
     hasEuResidence: boolean;
     hasAuResidence: boolean;
@@ -46,6 +46,6 @@ export declare const getFieldsState: (fields: TaxDocumentation, questionnaire?:
         tin: string | undefined;
         tinNotRequired: "yes" | undefined;
     }[];
-    hasUsTinValidationError: import('../i18n/types').ErrorKey[] | undefined;
+    hasUsTinValidationError: import('../i18n/types').StatusKey[] | undefined;
 };
 export {};

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

@@ -1,6 +1,7 @@
 export * from './getSteps';
-export * from './invalidFields/getInvalidFields.ts';
-export * from './invalidFields/invalidFieldRules.ts';
-export * from './requiredFields/getRequiredFields.ts';
-export * from './supportedFields/getSupportedFields.ts';
-export * from './visibleFields/getVisibleFields.ts';
+export * from './invalidFields/getInvalidFields';
+export * from './invalidFields/invalidFieldRules';
+export * from './requiredFields/getRequiredFields';
+export * from './statusFields/getStatusFields.ts';
+export * from './supportedFields/getSupportedFields';
+export * from './visibleFields/getVisibleFields';

package/dist/src/validations/invalidFields/getInvalidAddressFields.d.ts

@@ -1,5 +1,5 @@
-import { FormUIValidations } from './invalidFieldRules.ts';
+import { QuestionnaireValidations } from './invalidFieldRules.ts';
 
 type Prefix = 'accountHolder' | 'accountHolderMailing' | 'regardedOwner' | 'regardedOwnerMailing' | 'controllingPerson1' | 'controllingPerson1Mailing' | 'controllingPerson2' | 'controllingPerson2Mailing' | 'controllingPerson3' | 'controllingPerson3Mailing' | 'controllingPerson4' | 'controllingPerson4Mailing' | 'controllingPerson5' | 'controllingPerson5Mailing';
-export declare const getInvalidAddressRules: (prefix: Prefix) => FormUIValidations;
+export declare const getInvalidAddressRules: (prefix: Prefix) => QuestionnaireValidations;
 export {};

package/dist/src/validations/invalidFields/getInvalidControllingPersonsFields.d.ts

@@ -1,3 +1,3 @@
-import { FormUIValidations } from './invalidFieldRules';
+import { QuestionnaireValidations } from './invalidFieldRules';
 
-export declare const getInvalidControllingPersonsFields: () => FormUIValidations;
+export declare const getInvalidControllingPersonsFields: () => QuestionnaireValidations;

package/dist/src/validations/invalidFields/getInvalidFields.d.ts

@@ -1,4 +1,4 @@
-import { TaxDocumentationErrorFile } from '../../contexts';
+import { TaxDocumentationErrorMessagesMap } from '../../contexts';
 import { QuestionnaireProp, TaxDocumentation } from '../../types';
 import { ExternalValidations } from '../../types/client';
 
@@ -7,5 +7,5 @@ type Options = {
     treatyClaims?: boolean;
     externalValidations?: ExternalValidations;
 };
-export declare const getInvalidFields: (fields: TaxDocumentation, questionnaire: QuestionnaireProp, options?: Options) => TaxDocumentationErrorFile;
+export declare const getInvalidFields: (fields: TaxDocumentation, questionnaire: QuestionnaireProp, options?: Options) => TaxDocumentationErrorMessagesMap;
 export {};

package/dist/src/validations/invalidFields/getInvalidTaxResidencyFields.d.ts

@@ -1,5 +1,5 @@
-import { FormUIValidations } from './invalidFieldRules.ts';
+import { QuestionnaireValidations } from './invalidFieldRules.ts';
 
 type Prefix = 'accountHolder' | 'controllingPerson1' | 'controllingPerson2' | 'controllingPerson3' | 'controllingPerson4' | 'controllingPerson5';
-export declare const getInvalidTaxResidencyFields: (prefix: Prefix) => FormUIValidations;
+export declare const getInvalidTaxResidencyFields: (prefix: Prefix) => QuestionnaireValidations;
 export {};

package/dist/src/validations/invalidFields/invalidFieldRules.d.ts

@@ -1,15 +1,17 @@
-import { ErrorKey } from 'i18n/types';
+import { StatusKey } from 'i18n/types';
 import { TaxDocumentation, TaxDocumentationKey } from 'types/TaxDocumentation';
+import { QuestionnaireProp } from '../../types';
 import { ExternalValidations } from '../../types/client';
 
 type Options = {
     treatyClaims?: boolean;
     realTimeTinValidation?: boolean;
     externalValidations?: ExternalValidations;
+    questionnaire?: QuestionnaireProp;
 };
-export type FormUIValidation = (fields: TaxDocumentation, options?: Options) => ErrorKey[] | undefined;
-export type FormUIValidations = {
+export type FormUIValidation = (fields: TaxDocumentation, options?: Options) => StatusKey[] | undefined;
+export type QuestionnaireValidations = {
     [key in TaxDocumentationKey]?: FormUIValidation;
 };
-export declare const invalidFieldRules: FormUIValidations;
+export declare const invalidFieldRules: QuestionnaireValidations;
 export {};

package/dist/src/validations/requiredFields/getRequiredControllingPersonFields.d.ts

@@ -1,4 +1,4 @@
-import { TaxDocumentationPropertyFile } from '../../contexts';
+import { TaxDocumentationBooleanMap } from '../../contexts';
 import { TaxDocumentation } from '../../types';
 
-export declare const getRequiredControllingPersonFields: (fields: TaxDocumentation, isSelfCertification: boolean) => Partial<TaxDocumentationPropertyFile>;
+export declare const getRequiredControllingPersonFields: (fields: TaxDocumentation, isSelfCertification: boolean) => Partial<TaxDocumentationBooleanMap>;

package/dist/src/validations/requiredFields/getRequiredFields.d.ts

@@ -1,9 +1,9 @@
-import { TaxDocumentationPropertyFile } from '../../contexts';
+import { TaxDocumentationBooleanMap } from '../../contexts';
 import { QuestionnaireProp, TaxDocumentation } from '../../types';
 
 type Options = {
     treatyClaims?: boolean;
     realTimeTinValidation?: boolean;
 };
-export declare const getRequiredFields: (fields: TaxDocumentation, questionnaire: QuestionnaireProp, options?: Options) => TaxDocumentationPropertyFile;
+export declare const getRequiredFields: (fields: TaxDocumentation, questionnaire: QuestionnaireProp, options?: Options) => TaxDocumentationBooleanMap;
 export {};

package/dist/src/validations/statusFields/getStatusFields.d.ts

@@ -0,0 +1,4 @@
+import { TaxDocumentationErrorMessagesMap } from '../../contexts';
+import { TaxDocumentation } from '../../types';
+
+export declare const getStatusFields: (fields: TaxDocumentation) => TaxDocumentationErrorMessagesMap;

package/dist/src/validations/statusFields/statusFieldRules.d.ts

@@ -0,0 +1,8 @@
+import { StatusKey } from '../../i18n/types';
+import { TaxDocumentation, TaxDocumentationKey } from '../../types';
+
+export type GetMessageFunction = (fields: TaxDocumentation) => StatusKey[] | undefined;
+export type GetMessageFunctions = {
+    [key in TaxDocumentationKey]?: GetMessageFunction;
+};
+export declare const statusFieldRules: GetMessageFunctions;

package/dist/src/validations/supportedFields/getSupportedAddressFields.d.ts

@@ -1,8 +1,8 @@
-import { TaxDocumentationPropertyFile } from '../../contexts';
+import { TaxDocumentationBooleanMap } from '../../contexts';
 
 declare const iterate5: readonly ["1", "2", "3", "4", "5"];
 type Iterate5 = (typeof iterate5)[number];
 type ControllingPersonPrefix = `controllingPerson${Iterate5}`;
 type AddressPrefix = 'accountHolder' | 'accountHolderMailing' | 'regardedOwner' | 'regardedOwnerMailing' | ControllingPersonPrefix | `${ControllingPersonPrefix}Mailing`;
-export declare const getSupportedAddressFields: (prefix: AddressPrefix, isSupported: boolean) => Partial<TaxDocumentationPropertyFile>;
+export declare const getSupportedAddressFields: (prefix: AddressPrefix, isSupported: boolean) => Partial<TaxDocumentationBooleanMap>;
 export {};

package/dist/src/validations/supportedFields/getSupportedControllingPersonFields.d.ts

@@ -1,7 +1,7 @@
-import { TaxDocumentationPropertyFile } from '../../contexts';
+import { TaxDocumentationBooleanMap } from '../../contexts';
 
 declare const iterate5: readonly ["1", "2", "3", "4", "5"];
 type Iterate5 = (typeof iterate5)[number];
 type ControllingPersonPrefix = `controllingPerson${Iterate5}`;
-export declare const getSupportedControllingPersonFields: (prefix: ControllingPersonPrefix, isSupported: boolean) => Partial<TaxDocumentationPropertyFile>;
+export declare const getSupportedControllingPersonFields: (prefix: ControllingPersonPrefix, isSupported: boolean) => Partial<TaxDocumentationBooleanMap>;
 export {};

package/dist/src/validations/supportedFields/getSupportedFields.d.ts

@@ -1,9 +1,9 @@
 import { QuestionnaireProp } from 'types';
-import { TaxDocumentationPropertyFile } from '../../contexts';
+import { TaxDocumentationBooleanMap } from '../../contexts';
 
 type Options = {
     treatyClaims?: boolean;
     realTimeTinValidation?: boolean;
 };
-export declare const getSupportedFields: (questionnaire: QuestionnaireProp, options?: Options) => Partial<TaxDocumentationPropertyFile>;
+export declare const getSupportedFields: (questionnaire: QuestionnaireProp, options?: Options) => Partial<TaxDocumentationBooleanMap>;
 export {};

package/dist/src/validations/supportedFields/getSupportedTaxResidenceFields.d.ts

@@ -1,8 +1,8 @@
-import { TaxDocumentationPropertyFile } from '../../contexts';
+import { TaxDocumentationBooleanMap } from '../../contexts';
 
 declare const iterate5: readonly ["1", "2", "3", "4", "5"];
 type Iterate5 = (typeof iterate5)[number];
 type ControllingPersonPrefix = `controllingPerson${Iterate5}`;
 type ResidencePrefix = 'accountHolder' | ControllingPersonPrefix;
-export declare const getSupportedTaxResidenceFields: (prefix: ResidencePrefix, isSupported: boolean, hasReason?: boolean) => Partial<TaxDocumentationPropertyFile>;
+export declare const getSupportedTaxResidenceFields: (prefix: ResidencePrefix, isSupported: boolean, hasReason?: boolean) => Partial<TaxDocumentationBooleanMap>;
 export {};

package/dist/src/validations/visibleFields/__tests__/utils.d.ts

@@ -1,3 +1,3 @@
-import { TaxDocumentationPropertyFile } from '../../../contexts';
+import { TaxDocumentationBooleanMap } from '../../../contexts';
 
-export declare const getVisibleFieldsArray: (visibleFields: TaxDocumentationPropertyFile) => string[];
+export declare const getVisibleFieldsArray: (visibleFields: TaxDocumentationBooleanMap) => string[];

package/dist/src/validations/visibleFields/getVisibleAddressFields.d.ts

@@ -1,5 +1,5 @@
-import { TaxDocumentationPropertyFile } from '../../contexts';
+import { TaxDocumentationBooleanMap } from '../../contexts';
 
 type Prefix = 'accountHolderAddress' | 'accountHolderMailingAddress' | 'regardedOwnerAddress' | 'regardedOwnerMailingAddress' | 'controllingPerson1Address' | 'controllingPerson2Address' | 'controllingPerson3Address' | 'controllingPerson4Address' | 'controllingPerson5Address' | 'controllingPerson1MailingAddress' | 'controllingPerson2MailingAddress' | 'controllingPerson3MailingAddress' | 'controllingPerson4MailingAddress' | 'controllingPerson5MailingAddress';
-export declare const getVisibleAddressFields: (prefix: Prefix, showFields: boolean) => Partial<TaxDocumentationPropertyFile>;
+export declare const getVisibleAddressFields: (prefix: Prefix, showFields: boolean) => Partial<TaxDocumentationBooleanMap>;
 export {};

package/dist/src/validations/visibleFields/getVisibleControllingPersonFields.d.ts

@@ -1,4 +1,4 @@
-import { TaxDocumentationPropertyFile } from '../../contexts';
+import { TaxDocumentationBooleanMap } from '../../contexts';
 import { TaxDocumentation } from '../../types';
 
-export declare const getVisibleControllingPersonFields: (fields: TaxDocumentation, isSupported: boolean) => Partial<TaxDocumentationPropertyFile>;
+export declare const getVisibleControllingPersonFields: (fields: TaxDocumentation, isSupported: boolean) => Partial<TaxDocumentationBooleanMap>;

package/dist/src/validations/visibleFields/getVisibleFields.d.ts

@@ -1,5 +1,5 @@
 import { QuestionnaireProp, TaxDocumentation } from 'types';
-import { TaxDocumentationPropertyFile } from '../../contexts';
+import { TaxDocumentationBooleanMap } from '../../contexts';
 import { UsTinValidationAttempt } from '../../hooks';
 
 type Options = {
@@ -7,5 +7,5 @@ type Options = {
     usTinValidations?: UsTinValidationAttempt[];
     realTimeTinValidation?: boolean;
 };
-export declare const getVisibleFields: (fields: TaxDocumentation | undefined, questionnaire: QuestionnaireProp, options?: Options) => TaxDocumentationPropertyFile;
+export declare const getVisibleFields: (fields: TaxDocumentation | undefined, questionnaire: QuestionnaireProp, options?: Options) => TaxDocumentationBooleanMap;
 export {};

package/dist/src/wizard/RowInput/ShowHideInputRow/ShowHideInputRow.d.ts

@@ -3,10 +3,11 @@ import { ShowHideInputProps } from 'ui';
 
 type ShowHideInputRowProps = {
     label?: boolean;
+    aka?: string;
     subLabel?: boolean;
     onChange?: (val: string) => string;
     disabled?: boolean;
     children?: React.ReactNode;
 };
-export declare const ShowHideInputRow: ({ name, label, subLabel, onChange, disabled, children, }: ShowHideInputProps & ShowHideInputRowProps) => React.JSX.Element;
+export declare const ShowHideInputRow: ({ name, label, aka, subLabel, onChange, disabled, children, }: ShowHideInputProps & ShowHideInputRowProps) => React.JSX.Element;
 export {};

package/dist/src/wizard/RowInput/TinInputRow/TinInputRow.d.ts

@@ -0,0 +1,22 @@
+import { default as React } from 'react';
+import { TaxDocumentationKey } from 'types';
+
+export type TinInputProps = {
+    countryFieldKey: TaxDocumentationKey;
+    tinFieldKey: TaxDocumentationKey;
+    notRequiredFieldKey?: TaxDocumentationKey;
+    isIndividual: boolean;
+};
+export declare const AuTinInputRow: ({ name, disabled, aka, }: {
+    name: TaxDocumentationKey;
+    disabled?: boolean;
+    isIndividual?: boolean;
+    aka?: string;
+}) => React.JSX.Element;
+export declare const UsTinInputRow: ({ name, disabled, isIndividual, aka, }: {
+    name: TaxDocumentationKey;
+    disabled?: boolean;
+    isIndividual?: boolean;
+    aka?: string;
+}) => React.JSX.Element;
+export declare const TinInputRow: ({ countryFieldKey, tinFieldKey, notRequiredFieldKey, isIndividual, }: TinInputProps) => React.JSX.Element;

package/dist/src/wizard/RowInput/TinInputRow/index.d.ts

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

package/dist/src/wizard/RowInput/VisibleRow/VisibleRow.d.ts

@@ -1,9 +1,10 @@
 import { default as React } from 'react';
 import { TaxDocumentationKey } from 'types';
 
-export declare const VisibleRow: ({ label, subLabel, badge, name, header, children, onEdit, }: {
+export declare const VisibleRow: ({ label, subLabel, badge, name, header, children, onEdit, aka, }: {
     badge?: boolean;
     label?: boolean;
+    aka?: string;
     subLabel?: boolean;
     header?: string;
     name: TaxDocumentationKey;

package/dist/src/wizard/RowInput/index.d.ts

@@ -8,4 +8,5 @@ export * from './SelectRow';
 export * from './ShowHideInputRow';
 export * from './TextAreaRow';
 export * from './TextInputRow';
+export * from './TinInputRow';
 export * from './ToggleButtonRow';