@taxbit/react-sdk 1.1.0-beta.1 → 1.2.0-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (126) hide show
  1. package/README.md +13 -4
  2. package/dist/src/contexts/QuestionnaireStep/getLocal.d.ts +4 -3
  3. package/dist/src/contexts/QuestionnaireStep/shiftControllingPerson.d.ts +3 -0
  4. package/dist/src/contexts/QuestionnaireStep/shiftResidence.d.ts +1 -1
  5. package/dist/src/contexts/QuestionnaireStep/useQuestionnaireStep.d.ts +2 -1
  6. package/dist/src/contexts/QuestionnaireStep/useQuestionnaireStepContext.d.ts +4 -2
  7. package/dist/src/contexts/TaxDocumentation/useTaxDocumentation.d.ts +5 -5
  8. package/dist/src/contexts/TaxDocumentation/useTaxDocumentationContext.d.ts +6 -6
  9. package/dist/src/hooks/useTaxbit/useTaxbit.d.ts +2 -2
  10. package/dist/src/hooks/useTaxbit/useTaxbitStatus.d.ts +2 -2
  11. package/dist/src/i18n/locales/de.d.ts +2 -2
  12. package/dist/src/i18n/locales/el.d.ts +2 -2
  13. package/dist/src/i18n/locales/ga.d.ts +1 -3
  14. package/dist/src/i18n/locales/lt.d.ts +2 -2
  15. package/dist/src/i18n/locales/pl.d.ts +2 -2
  16. package/dist/src/i18n/types/LocalizationKey.d.ts +6 -6
  17. package/dist/src/i18n/types/PropertyFile.d.ts +15 -14
  18. package/dist/src/index.d.ts +2 -2
  19. package/dist/src/lookups/activeNonFinancialEntityTypeOptions.d.ts +3 -0
  20. package/dist/src/lookups/controllingPersonRoleOptions.d.ts +3 -0
  21. package/dist/src/lookups/entityTypeOptions.d.ts +3 -0
  22. package/dist/src/lookups/financialInstitutionTypeOptions.d.ts +3 -0
  23. package/dist/src/lookups/index.d.ts +7 -0
  24. package/dist/src/lookups/payeeCodeOptions.d.ts +1 -1
  25. package/dist/src/lookups/selfCertificationAccountTypeOptions.d.ts +3 -0
  26. package/dist/src/lookups/signatureCapacityOptions.d.ts +3 -0
  27. package/dist/src/lookups/tinNotRequiredReasonOptions.d.ts +3 -0
  28. package/dist/src/services/api.d.ts +5 -2
  29. package/dist/src/services/msw.d.ts +33 -0
  30. package/dist/src/test/Wrapper.d.ts +2 -2
  31. package/dist/src/test/getWrapper.d.ts +2 -2
  32. package/dist/src/test/utils/helpers.d.ts +10 -0
  33. package/dist/src/types/InputStep.d.ts +1 -1
  34. package/dist/src/types/QuestionnaireProp.d.ts +1 -0
  35. package/dist/src/types/StepId.d.ts +1 -1
  36. package/dist/src/types/TaxDocumentation.d.ts +87 -50
  37. package/dist/src/types/client/ClientTaxDocumentationStatus.d.ts +4 -0
  38. package/dist/src/types/index.d.ts +1 -1
  39. package/dist/src/types/server/TaxDocumentationStatus.d.ts +4 -0
  40. package/dist/src/ui/InputValue/InputValue.d.ts +2 -1
  41. package/dist/src/ui/Select/Select.d.ts +0 -1
  42. package/dist/src/utils/getFieldsState.d.ts +7 -2
  43. package/dist/src/utils/getFormStatus.d.ts +2 -1
  44. package/dist/src/utils/getLanguage.d.ts +2 -2
  45. package/dist/src/utils/index.d.ts +1 -1
  46. package/dist/src/utils/promptKeyMapping/getAddressPromptKeyMap.d.ts +6 -0
  47. package/dist/src/utils/promptKeyMapping/getControllingPersonPromptKeyMap.d.ts +4 -0
  48. package/dist/src/utils/promptKeyMapping/getTaxResidencesPromptKeyMap.d.ts +6 -0
  49. package/dist/src/utils/transformForClient/transformForClient.d.ts +2 -2
  50. package/dist/src/utils/transformForClient/transformForClientAddress.d.ts +4 -32
  51. package/dist/src/utils/transformForClient/transformForClientTaxResidences.d.ts +11 -0
  52. package/dist/src/utils/transformForClient/transformForControllingPersons.d.ts +4 -0
  53. package/dist/src/utils/transformInbound/getActiveNonFinancialEntityType.d.ts +3 -0
  54. package/dist/src/utils/transformInbound/getCountryCode.d.ts +1 -0
  55. package/dist/src/utils/transformInbound/getEntityType.d.ts +3 -0
  56. package/dist/src/utils/transformInbound/getFinancialInstitutionType.d.ts +3 -0
  57. package/dist/src/utils/transformInbound/getSelfCertificationAccountType.d.ts +3 -0
  58. package/dist/src/utils/transformInbound/transformInbound.d.ts +2 -2
  59. package/dist/src/utils/transformInbound/transformInboundAddress.d.ts +6 -0
  60. package/dist/src/utils/transformInbound/transformInboundControllingPersons.d.ts +440 -0
  61. package/dist/src/utils/transformInbound/transformInboundTaxResidencies.d.ts +7 -0
  62. package/dist/src/validations/getSteps.d.ts +2 -2
  63. package/dist/src/validations/index.d.ts +5 -5
  64. package/dist/src/validations/invalidFields/getInvalidAddressFields.d.ts +5 -0
  65. package/dist/src/validations/invalidFields/getInvalidControllingPersonsFields.d.ts +3 -0
  66. package/dist/src/validations/invalidFields/getInvalidFields.d.ts +5 -0
  67. package/dist/src/validations/invalidFields/getInvalidTaxResidencyFields.d.ts +5 -0
  68. package/dist/src/validations/{invalidFieldRules.d.ts → invalidFields/invalidFieldRules.d.ts} +1 -1
  69. package/dist/src/validations/requiredFields/getRequiredAddressFields.d.ts +7 -0
  70. package/dist/src/validations/requiredFields/getRequiredControllingPersonFields.d.ts +4 -0
  71. package/dist/src/validations/requiredFields/getRequiredFields.d.ts +4 -0
  72. package/dist/src/validations/requiredFields/getRequiredTaxResidenceFields.d.ts +7 -0
  73. package/dist/src/validations/supportedFields/__tests__/generateStrings.d.ts +5 -0
  74. package/dist/src/validations/supportedFields/getSupportedAddressFields.d.ts +8 -0
  75. package/dist/src/validations/supportedFields/getSupportedControllingPersonFields.d.ts +7 -0
  76. package/dist/src/validations/supportedFields/getSupportedFields.d.ts +4 -0
  77. package/dist/src/validations/supportedFields/getSupportedTaxResidenceFields.d.ts +8 -0
  78. package/dist/src/validations/supportedFields/getSupportedTreatyClaimFields.d.ts +3 -0
  79. package/dist/src/validations/visibleFields/getVisibleAddressFields.d.ts +5 -0
  80. package/dist/src/validations/visibleFields/getVisibleControllingPersonFields.d.ts +4 -0
  81. package/dist/src/validations/visibleFields/getVisibleFields.d.ts +4 -0
  82. package/dist/src/validations/visibleFields/getVisibleTaxResidenceFields.d.ts +9 -0
  83. package/dist/src/{entry → widgets}/TaxbitQuestionnaire/TaxbitQuestionnaire.d.ts +3 -3
  84. package/dist/src/widgets/TaxbitQuestionnairePersist/useTaxbitPersist.d.ts +2 -2
  85. package/dist/src/wizard/AddressInput/AddressInput.d.ts +1 -1
  86. package/dist/src/wizard/ControllingPersonInput/ControllingPersonInput.d.ts +11 -0
  87. package/dist/src/wizard/ControllingPersonInput/index.d.ts +1 -0
  88. package/dist/src/wizard/LanguageSelector/LanguageSelector.d.ts +2 -2
  89. package/dist/src/wizard/ResidenceInput/ResidenceInput.d.ts +2 -1
  90. package/dist/src/wizard/RowInput/AddressRow/AddressRow.d.ts +1 -1
  91. package/dist/src/wizard/RowInput/PercentInputRow/PercentInputRow.d.ts +9 -0
  92. package/dist/src/wizard/RowInput/PercentInputRow/index.d.ts +1 -0
  93. package/dist/src/wizard/RowInput/SelectRow/SelectRow.d.ts +2 -1
  94. package/dist/src/wizard/RowInput/index.d.ts +1 -0
  95. package/dist/src/wizard/TaxbitQuestionnaireUI/ControllingPersonDetails/ControllingPersonDetails.d.ts +7 -0
  96. package/dist/src/wizard/TaxbitQuestionnaireUI/ControllingPersonDetails/index.d.ts +1 -0
  97. package/dist/src/wizard/TaxbitQuestionnaireUI/Summary/AccountHolder/AccountHolderClassificationSummary.d.ts +3 -0
  98. package/dist/src/wizard/TaxbitQuestionnaireUI/Summary/AccountHolder/AccountHolderForeignClassificationSummary.d.ts +6 -0
  99. package/dist/src/wizard/TaxbitQuestionnaireUI/Summary/AccountHolder/AccountHolderSelfCertificationClassificationSummary.d.ts +6 -0
  100. package/dist/src/wizard/TaxbitQuestionnaireUI/Summary/AccountHolder/AccountHolderUsClassificationSummary.d.ts +6 -0
  101. package/dist/src/wizard/TaxbitQuestionnaireUI/Summary/ControllingPerson/ControllingPersonRoleInputValue.d.ts +7 -0
  102. package/dist/src/wizard/TaxbitQuestionnaireUI/Summary/ControllingPerson/ControllingPersonSummary.d.ts +7 -0
  103. package/dist/src/wizard/TaxbitQuestionnaireUI/Summary/ControllingPerson/ControllingPersonTypeSummary.d.ts +7 -0
  104. package/dist/src/wizard/TaxbitQuestionnaireUI/Summary/RegardedOwner/RegardedOwnerClassificationSummary.d.ts +3 -0
  105. package/dist/src/wizard/TaxbitQuestionnaireUI/Summary/RegardedOwner/RegardedOwnerForeignClassificationSummary.d.ts +6 -0
  106. package/dist/src/wizard/TaxbitQuestionnaireUI/Summary/RegardedOwner/RegardedOwnerUsClassificationSummary.d.ts +6 -0
  107. package/dist/src/wizard/TaxbitQuestionnaireUI/Summary/TaxResidency/TaxResidenciesSummary.d.ts +11 -0
  108. package/dist/src/wizard/TaxbitQuestionnaireUI/__tests__/TaxbitQuestionnaireUI.SelfCert.AccountClassification.test.d.ts +1 -0
  109. package/dist/src/wizard/TaxbitQuestionnaireUI/__tests__/TaxbitQuestionnaireUI.SelfCert.ControllingPerson.test.d.ts +1 -0
  110. package/dist/src/wizard/TaxbitQuestionnaireUI/__tests__/TaxbitQuestionnaireUI.SelfCert.NameAndAddress.test.d.ts +1 -0
  111. package/dist/src/wizard/TaxbitQuestionnaireUI/__tests__/TaxbitQuestionnaireUI.SelfCert.Summary.test.d.ts +1 -0
  112. package/dist/src/wizard/TaxbitQuestionnaireUI/__tests__/TaxbitQuestionnaireUI.SelfCert.TaxResidencies.test.d.ts +1 -0
  113. package/dist/src/wizard/TaxbitQuestionnaireUI/steps.d.ts +1 -0
  114. package/dist/taxbit-react-sdk.js +7466 -4608
  115. package/dist/taxbit-react-sdk.umd.cjs +1 -1
  116. package/package.json +7 -6
  117. package/style/basic.css +4 -0
  118. package/style/inline.css +1 -0
  119. package/dist/src/types/Questionnaire.d.ts +0 -1
  120. package/dist/src/utils/transformForClient/transformForClientTaxResidenceFields.d.ts +0 -7
  121. package/dist/src/validations/getInvalidFields.d.ts +0 -5
  122. package/dist/src/validations/getRequiredFields.d.ts +0 -4
  123. package/dist/src/validations/getSupportedFields.d.ts +0 -7
  124. package/dist/src/validations/getVisibleFields.d.ts +0 -4
  125. /package/dist/src/utils/{getPromptKeyMap.d.ts → promptKeyMapping/getPromptKeyMap.d.ts} +0 -0
  126. /package/dist/src/{entry → widgets}/TaxbitQuestionnaire/index.d.ts +0 -0
@@ -1,12 +1,12 @@
1
1
  import { ClientTaxDocumentation, SignedClientTaxDocumentation } from '@taxbit/utilities';
2
- import { Questionnaire } from 'types';
2
+ import { QuestionnaireProp } from 'types';
3
3
  import { ExternalValidations } from 'types/client';
4
4
 
5
5
  export type UseTaxbitPersistProps = {
6
6
  data?: ClientTaxDocumentation;
7
7
  staging?: boolean;
8
8
  bearerToken: string;
9
- questionnaire: Questionnaire;
9
+ questionnaire: QuestionnaireProp;
10
10
  onSuccess?: (data: ClientTaxDocumentation) => void | Promise<void>;
11
11
  onSettled?: (data: ClientTaxDocumentation) => void | Promise<void>;
12
12
  onError?: (error: Error) => void | Promise<void>;
@@ -4,7 +4,7 @@ type AddressProps = {
4
4
  prompt: string;
5
5
  subPrompt?: string;
6
6
  showIf?: boolean;
7
- prefix: 'accountHolderAddress' | 'accountHolderMailingAddress' | 'regardedOwnerAddress' | 'regardedOwnerMailingAddress';
7
+ prefix: 'accountHolderAddress' | 'accountHolderMailingAddress' | 'regardedOwnerAddress' | 'regardedOwnerMailingAddress' | 'controllingPerson1Address' | 'controllingPerson1MailingAddress' | 'controllingPerson2Address' | 'controllingPerson2MailingAddress' | 'controllingPerson3Address' | 'controllingPerson3MailingAddress' | 'controllingPerson4Address' | 'controllingPerson4MailingAddress' | 'controllingPerson5Address' | 'controllingPerson5MailingAddress';
8
8
  };
9
9
  export declare const AddressInput: ({ prompt, subPrompt, prefix, showIf, }: AddressProps) => React.JSX.Element;
10
10
  export {};
@@ -0,0 +1,11 @@
1
+ import { default as React } from 'react';
2
+
3
+ type ControllingPersonInputProps = {
4
+ index: 1 | 2 | 3 | 4 | 5;
5
+ showIf?: boolean;
6
+ more?: boolean;
7
+ remove?: boolean;
8
+ onShow?: () => void;
9
+ };
10
+ export declare const ControllingPersonInput: ({ index, showIf, onShow, more, remove, }: ControllingPersonInputProps) => React.JSX.Element;
11
+ export {};
@@ -0,0 +1 @@
1
+ export * from './ControllingPersonInput.tsx';
@@ -1,6 +1,6 @@
1
1
  import { default as React } from 'react';
2
- import { Questionnaire } from 'types';
2
+ import { QuestionnaireProp } from 'types';
3
3
 
4
4
  export declare const LanguageSelector: ({ questionnaire, }: {
5
- questionnaire: Questionnaire;
5
+ questionnaire: QuestionnaireProp;
6
6
  }) => React.JSX.Element | null;
@@ -2,6 +2,7 @@ import { default as React } from 'react';
2
2
 
3
3
  type ResidenceInputProps = {
4
4
  index: 1 | 2 | 3 | 4 | 5;
5
+ prefix: 'accountHolder' | 'controllingPerson1' | 'controllingPerson2' | 'controllingPerson3' | 'controllingPerson4' | 'controllingPerson5';
5
6
  showIf?: boolean;
6
7
  more?: boolean;
7
8
  remove?: boolean;
@@ -11,5 +12,5 @@ type ResidenceInputProps = {
11
12
  label: string;
12
13
  }>;
13
14
  };
14
- export declare const ResidenceInput: ({ index, showIf, onShow, more, remove, countryOptions, }: ResidenceInputProps) => React.JSX.Element;
15
+ export declare const ResidenceInput: ({ index, prefix, showIf, onShow, more, remove, countryOptions, }: ResidenceInputProps) => React.JSX.Element;
15
16
  export {};
@@ -3,7 +3,7 @@ import { default as React } from 'react';
3
3
  type AddressRowProps = {
4
4
  onEdit?: () => void;
5
5
  prompt?: string;
6
- name: 'accountHolderAddress' | 'accountHolderMailingAddress' | 'regardedOwnerAddress' | 'regardedOwnerMailingAddress';
6
+ name: 'accountHolderAddress' | 'accountHolderMailingAddress' | 'regardedOwnerAddress' | 'regardedOwnerMailingAddress' | 'controllingPerson1Address' | 'controllingPerson1MailingAddress' | 'controllingPerson2Address' | 'controllingPerson2MailingAddress' | 'controllingPerson3Address' | 'controllingPerson3MailingAddress' | 'controllingPerson4Address' | 'controllingPerson4MailingAddress' | 'controllingPerson5Address' | 'controllingPerson5MailingAddress';
7
7
  };
8
8
  export declare const AddressRow: ({ onEdit, name, prompt }: AddressRowProps) => React.JSX.Element | null;
9
9
  export {};
@@ -0,0 +1,9 @@
1
+ import { default as React } from 'react';
2
+ import { TextInputProps } from 'ui';
3
+
4
+ type PercentInputRowProps = {
5
+ label?: boolean;
6
+ subLabel?: boolean;
7
+ };
8
+ export declare const PercentInputRow: ({ name, label, subLabel, disabled, defaultValue, }: TextInputProps & PercentInputRowProps) => React.JSX.Element;
9
+ export {};
@@ -0,0 +1 @@
1
+ export * from './PercentInputRow.tsx';
@@ -6,6 +6,7 @@ type SelectRowProps = {
6
6
  subLabel?: true;
7
7
  onChange?: () => void;
8
8
  disabled?: boolean;
9
+ prompt?: string;
9
10
  };
10
- export declare const SelectRow: ({ name, label, options, subLabel, addBlank, onChange, disabled, }: SelectProps & SelectRowProps) => React.JSX.Element;
11
+ export declare const SelectRow: ({ name, label, options, subLabel, addBlank, onChange, disabled, prompt, }: SelectProps & SelectRowProps) => React.JSX.Element;
11
12
  export {};
@@ -1,6 +1,7 @@
1
1
  export * from './AddressRow';
2
2
  export * from './CheckBoxRow';
3
3
  export * from './ErrorRow';
4
+ export * from './PercentInputRow';
4
5
  export * from './RadioButtonRow';
5
6
  export * from './SelectRow';
6
7
  export * from './ShowHideInputRow';
@@ -0,0 +1,7 @@
1
+ import { default as React } from 'react';
2
+
3
+ export declare const ControllingPersonDetails1: () => React.JSX.Element;
4
+ export declare const ControllingPersonDetails2: () => React.JSX.Element;
5
+ export declare const ControllingPersonDetails3: () => React.JSX.Element;
6
+ export declare const ControllingPersonDetails4: () => React.JSX.Element;
7
+ export declare const ControllingPersonDetails5: () => React.JSX.Element;
@@ -0,0 +1 @@
1
+ export * from './ControllingPersonDetails';
@@ -0,0 +1,3 @@
1
+ import { default as React } from 'react';
2
+
3
+ export declare const AccountHolderClassificationSummary: () => React.JSX.Element;
@@ -0,0 +1,6 @@
1
+ import { ForeignAccountHolderAccountType } from '@taxbit/utilities';
2
+ import { default as React } from 'react';
3
+
4
+ export declare const AccountHolderForeignClassificationSummary: ({ classification, }: {
5
+ classification: ForeignAccountHolderAccountType;
6
+ }) => React.JSX.Element | undefined;
@@ -0,0 +1,6 @@
1
+ import { SelfCertificationAccountType } from '@taxbit/utilities';
2
+ import { default as React } from 'react';
3
+
4
+ export declare const AccountHolderSelfCertificationClassificationSummary: ({ classification, }: {
5
+ classification: SelfCertificationAccountType;
6
+ }) => React.JSX.Element | undefined;
@@ -0,0 +1,6 @@
1
+ import { UsAccountHolderAccountType } from '@taxbit/utilities';
2
+ import { default as React } from 'react';
3
+
4
+ export declare const AccountHolderUsClassificationSummary: ({ classification, }: {
5
+ classification: UsAccountHolderAccountType;
6
+ }) => React.JSX.Element | undefined;
@@ -0,0 +1,7 @@
1
+ import { default as React } from 'react';
2
+ import { TaxDocumentation } from '../../../../types';
3
+
4
+ export declare const ControllingPersonRoleInputValue: ({ fields, index, }: {
5
+ fields: TaxDocumentation;
6
+ index: "1" | "2" | "3" | "4" | "5";
7
+ }) => React.JSX.Element;
@@ -0,0 +1,7 @@
1
+ import { default as React } from 'react';
2
+
3
+ type ControllingPersonSummaryProps = {
4
+ index: '1' | '2' | '3' | '4' | '5';
5
+ };
6
+ export declare const ControllingPersonSummary: ({ index, }: ControllingPersonSummaryProps) => React.JSX.Element | null;
7
+ export {};
@@ -0,0 +1,7 @@
1
+ import { default as React } from 'react';
2
+
3
+ type ControllingPersonTypeSummaryProps = {
4
+ index: '1' | '2' | '3' | '4' | '5';
5
+ };
6
+ export declare const ControllingPersonTypeSummary: ({ index, }: ControllingPersonTypeSummaryProps) => React.JSX.Element;
7
+ export {};
@@ -0,0 +1,3 @@
1
+ import { default as React } from 'react';
2
+
3
+ export declare const RegardedOwnerClassificationSummary: () => React.JSX.Element | undefined;
@@ -0,0 +1,6 @@
1
+ import { ForeignRegardedOwnerAccountType } from '@taxbit/utilities';
2
+ import { default as React } from 'react';
3
+
4
+ export declare const RegardedOwnerForeignClassificationSummary: ({ classification, }: {
5
+ classification: ForeignRegardedOwnerAccountType;
6
+ }) => React.JSX.Element | undefined;
@@ -0,0 +1,6 @@
1
+ import { UsRegardedOwnerAccountType } from '@taxbit/utilities';
2
+ import { default as React } from 'react';
3
+
4
+ export declare const RegardedOwnerUsClassificationSummary: ({ classification, }: {
5
+ classification: UsRegardedOwnerAccountType;
6
+ }) => React.JSX.Element | undefined;
@@ -0,0 +1,11 @@
1
+ import { default as React } from 'react';
2
+ import { InputStep } from '../../../../types';
3
+
4
+ type Prefix = 'accountHolder' | 'controllingPerson1' | 'controllingPerson2' | 'controllingPerson3' | 'controllingPerson4' | 'controllingPerson5';
5
+ type TaxResidenciesSummaryProps = {
6
+ prefix: Prefix;
7
+ showIf?: boolean;
8
+ goToStep: InputStep;
9
+ };
10
+ export declare const TaxResidenciesSummary: ({ prefix, goToStep, }: TaxResidenciesSummaryProps) => React.JSX.Element;
11
+ export {};
@@ -3,6 +3,7 @@ export * from './AccountHolderContact';
3
3
  export * from './AccountHolderTax';
4
4
  export * from './AccountHolderTaxClarification';
5
5
  export * from './AccountHolderTreatyClaims';
6
+ export * from './ControllingPersonDetails';
6
7
  export * from './Exemptions';
7
8
  export * from './RegardedOwnerContact';
8
9
  export * from './RegardedOwnerTax';