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

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 (235) hide show
  1. package/README.md +13 -4
  2. package/dist/index.d.ts +1 -1
  3. package/dist/src/App.d.ts +0 -1
  4. package/dist/src/components/Address/Address.d.ts +0 -1
  5. package/dist/src/components/ErrorAlert/ErrorAlert.d.ts +0 -1
  6. package/dist/src/components/ErrorBoundary/ErrorBoundary.d.ts +0 -1
  7. package/dist/src/components/ErrorMessage/ErrorMessage.d.ts +0 -1
  8. package/dist/src/components/Form/Form.d.ts +0 -1
  9. package/dist/src/components/InputStatus/InputStatus.d.ts +0 -1
  10. package/dist/src/components/JsxFromString/JsxFromString.d.ts +0 -1
  11. package/dist/src/components/ProgressStatus/ProgressStatus.d.ts +0 -1
  12. package/dist/src/components/Row/Row.d.ts +0 -1
  13. package/dist/src/components/Section/Section.d.ts +0 -1
  14. package/dist/src/contexts/QuestionnaireStep/QuestionnaireStepProvider.d.ts +0 -1
  15. package/dist/src/contexts/QuestionnaireStep/getLocal.d.ts +4 -4
  16. package/dist/src/contexts/QuestionnaireStep/index.d.ts +0 -1
  17. package/dist/src/contexts/QuestionnaireStep/shiftControllingPerson.d.ts +2 -0
  18. package/dist/src/contexts/QuestionnaireStep/shiftResidence.d.ts +1 -2
  19. package/dist/src/contexts/QuestionnaireStep/useQuestionnaireStep.d.ts +2 -2
  20. package/dist/src/contexts/QuestionnaireStep/useQuestionnaireStepContext.d.ts +4 -2
  21. package/dist/src/contexts/TaxDocumentation/TaxbitQuestionnaireProvider.d.ts +0 -1
  22. package/dist/src/contexts/TaxDocumentation/useTaxDocumentation.d.ts +5 -6
  23. package/dist/src/contexts/TaxDocumentation/useTaxDocumentationContext.d.ts +6 -6
  24. package/dist/src/hooks/useHandleError.d.ts +0 -1
  25. package/dist/src/hooks/useTaxbit/__tests__/clientTaxDocumentation.d.ts +0 -1
  26. package/dist/src/hooks/useTaxbit/__tests__/serverTaxDocumentation.d.ts +0 -1
  27. package/dist/src/hooks/useTaxbit/types/comprehensive.d.ts +0 -1
  28. package/dist/src/hooks/useTaxbit/types/w8.d.ts +0 -1
  29. package/dist/src/hooks/useTaxbit/types/w9.d.ts +0 -1
  30. package/dist/src/hooks/useTaxbit/useTaxbit.d.ts +2 -3
  31. package/dist/src/hooks/useTaxbit/useTaxbitStatus.d.ts +2 -3
  32. package/dist/src/i18n/locales/de.d.ts +2 -3
  33. package/dist/src/i18n/locales/el-cy.d.ts +0 -1
  34. package/dist/src/i18n/locales/el.d.ts +2 -3
  35. package/dist/src/i18n/locales/en-gb.d.ts +0 -1
  36. package/dist/src/i18n/locales/en-nz.d.ts +0 -1
  37. package/dist/src/i18n/locales/en-us.d.ts +0 -1
  38. package/dist/src/i18n/locales/en.d.ts +0 -1
  39. package/dist/src/i18n/locales/es.d.ts +0 -1
  40. package/dist/src/i18n/locales/fr-ca.d.ts +0 -1
  41. package/dist/src/i18n/locales/fr.d.ts +0 -1
  42. package/dist/src/i18n/locales/ga.d.ts +1 -3
  43. package/dist/src/i18n/locales/lt.d.ts +2 -3
  44. package/dist/src/i18n/locales/mergePropertyFiles.d.ts +0 -1
  45. package/dist/src/i18n/locales/nl-be.d.ts +0 -1
  46. package/dist/src/i18n/locales/pl.d.ts +2 -3
  47. package/dist/src/i18n/locales/translation-missing.d.ts +0 -1
  48. package/dist/src/i18n/localizationFileMap.d.ts +0 -1
  49. package/dist/src/i18n/types/LocalizationKey.d.ts +6 -6
  50. package/dist/src/i18n/types/PropertyFile.d.ts +15 -15
  51. package/dist/src/i18n/utils/getText.d.ts +0 -1
  52. package/dist/src/index.d.ts +2 -3
  53. package/dist/src/lookups/activeNonFinancialEntityTypeOptions.d.ts +3 -0
  54. package/dist/src/lookups/controllingPersonRoleOptions.d.ts +3 -0
  55. package/dist/src/lookups/dayOptions.d.ts +1 -1
  56. package/dist/src/lookups/entityTypeOptions.d.ts +3 -0
  57. package/dist/src/lookups/fatcaCodeOptions.d.ts +1 -1
  58. package/dist/src/lookups/financialInstitutionTypeOptions.d.ts +3 -0
  59. package/dist/src/lookups/foreignAccountHolderAccountTypeOptions.d.ts +1 -1
  60. package/dist/src/lookups/foreignOtherClassificationOptions.d.ts +1 -1
  61. package/dist/src/lookups/foreignRegardedOwnerAccountTypeOptions.d.ts +1 -1
  62. package/dist/src/lookups/foreignTrustClassificationOptions.d.ts +1 -1
  63. package/dist/src/lookups/getTreatyCountryLimitationOnBenefitOptions.d.ts +0 -1
  64. package/dist/src/lookups/index.d.ts +7 -0
  65. package/dist/src/lookups/localeOptions.d.ts +0 -1
  66. package/dist/src/lookups/payeeCodeOptions.d.ts +2 -2
  67. package/dist/src/lookups/selfCertificationAccountTypeOptions.d.ts +3 -0
  68. package/dist/src/lookups/signatureCapacityOptions.d.ts +3 -0
  69. package/dist/src/lookups/tinNotRequiredReasonOptions.d.ts +3 -0
  70. package/dist/src/lookups/usAccountHolderAccountTypeOptions.d.ts +1 -1
  71. package/dist/src/lookups/usLlcAccountTypeOptions.d.ts +1 -1
  72. package/dist/src/lookups/usRegardedOwnerAccountTypeOptions.d.ts +1 -1
  73. package/dist/src/services/api.d.ts +5 -3
  74. package/dist/src/services/msw.d.ts +33 -0
  75. package/dist/src/test/Wrapper.d.ts +2 -3
  76. package/dist/src/test/getWrapper.d.ts +2 -3
  77. package/dist/src/test/utils/helpers.d.ts +10 -0
  78. package/dist/src/types/InputStep.d.ts +1 -1
  79. package/dist/src/types/Progress.d.ts +0 -1
  80. package/dist/src/types/QuestionnaireProp.d.ts +1 -0
  81. package/dist/src/types/StepId.d.ts +1 -1
  82. package/dist/src/types/TaxDocumentation.d.ts +87 -51
  83. package/dist/src/types/client/ClientTaxDocumentationStatus.d.ts +4 -0
  84. package/dist/src/types/index.d.ts +1 -1
  85. package/dist/src/types/server/TaxDocumentationStatus.d.ts +4 -0
  86. package/dist/src/ui/ActionButton/ActionButton.d.ts +0 -1
  87. package/dist/src/ui/Actions/Actions.d.ts +0 -1
  88. package/dist/src/ui/CheckBox/CheckBox.d.ts +0 -1
  89. package/dist/src/ui/DateOfBirthInput/DateOfBirthInput.d.ts +0 -1
  90. package/dist/src/ui/DateOfBirthInput/useDateOfBirthInput.d.ts +1 -2
  91. package/dist/src/ui/FormattedInput/FormattedInput.d.ts +0 -1
  92. package/dist/src/ui/HideShowButton/HideShowButton.d.ts +0 -1
  93. package/dist/src/ui/InputValue/InputValue.d.ts +2 -2
  94. package/dist/src/ui/MaskedContent/MaskedContent.d.ts +0 -1
  95. package/dist/src/ui/PasswordInput/PasswordInput.d.ts +0 -1
  96. package/dist/src/ui/RadioButtons/RadioButtons.d.ts +0 -1
  97. package/dist/src/ui/RadioButtons/__tests__/RadioButtons.test.d.ts +0 -1
  98. package/dist/src/ui/Select/Select.d.ts +0 -2
  99. package/dist/src/ui/ShowHideInput/ShowHideInput.d.ts +0 -1
  100. package/dist/src/ui/TextArea/TextArea.d.ts +0 -1
  101. package/dist/src/ui/TextArea/__tests__/TextInput.test.d.ts +0 -1
  102. package/dist/src/ui/TextInput/TextInput.d.ts +0 -1
  103. package/dist/src/ui/TextInput/__tests__/TextInput.test.d.ts +0 -1
  104. package/dist/src/ui/ToggleButton/ToggleButton.d.ts +0 -1
  105. package/dist/src/ui/WithholdingInput/WithholdingInput.d.ts +0 -1
  106. package/dist/src/utils/camelCaseKeys.d.ts +0 -1
  107. package/dist/src/utils/getFieldsState.d.ts +7 -3
  108. package/dist/src/utils/getFormStatus.d.ts +2 -2
  109. package/dist/src/utils/getLanguage.d.ts +2 -3
  110. package/dist/src/utils/index.d.ts +1 -1
  111. package/dist/src/utils/mergeClientTaxDocumentationData.d.ts +0 -1
  112. package/dist/src/utils/promptKeyMapping/getAddressPromptKeyMap.d.ts +5 -0
  113. package/dist/src/utils/promptKeyMapping/getControllingPersonPromptKeyMap.d.ts +3 -0
  114. package/dist/src/utils/{getPromptKeyMap.d.ts → promptKeyMapping/getPromptKeyMap.d.ts} +0 -1
  115. package/dist/src/utils/promptKeyMapping/getTaxResidencesPromptKeyMap.d.ts +5 -0
  116. package/dist/src/utils/transformForClient/convertYesNoToBoolean.d.ts +0 -1
  117. package/dist/src/utils/transformForClient/convertYesNoToBooleanOrUndefined.d.ts +0 -1
  118. package/dist/src/utils/transformForClient/transformForClient.d.ts +2 -3
  119. package/dist/src/utils/transformForClient/transformForClientAccountHolder.d.ts +0 -1
  120. package/dist/src/utils/transformForClient/transformForClientAddress.d.ts +4 -33
  121. package/dist/src/utils/transformForClient/transformForClientRegardedOwner.d.ts +0 -1
  122. package/dist/src/utils/transformForClient/transformForClientTaxResidences.d.ts +10 -0
  123. package/dist/src/utils/transformForClient/transformForControllingPersons.d.ts +3 -0
  124. package/dist/src/utils/transformInbound/getActiveNonFinancialEntityType.d.ts +2 -0
  125. package/dist/src/utils/transformInbound/getCountryCode.d.ts +1 -0
  126. package/dist/src/utils/transformInbound/getEntityType.d.ts +2 -0
  127. package/dist/src/utils/transformInbound/getFinancialInstitutionType.d.ts +2 -0
  128. package/dist/src/utils/transformInbound/getForeignAccountType.d.ts +0 -1
  129. package/dist/src/utils/transformInbound/getForeignOtherClassification.d.ts +0 -1
  130. package/dist/src/utils/transformInbound/getForeignTrustClassification.d.ts +0 -1
  131. package/dist/src/utils/transformInbound/getLLCClassification.d.ts +0 -1
  132. package/dist/src/utils/transformInbound/getSelfCertificationAccountType.d.ts +2 -0
  133. package/dist/src/utils/transformInbound/getUsAccountType.d.ts +0 -1
  134. package/dist/src/utils/transformInbound/transformInbound.d.ts +2 -3
  135. package/dist/src/utils/transformInbound/transformInboundAddress.d.ts +5 -0
  136. package/dist/src/utils/transformInbound/transformInboundControllingPersons.d.ts +439 -0
  137. package/dist/src/utils/transformInbound/transformInboundTaxResidencies.d.ts +6 -0
  138. package/dist/src/validations/getSteps.d.ts +2 -3
  139. package/dist/src/validations/index.d.ts +5 -5
  140. package/dist/src/validations/invalidFields/getInvalidAddressFields.d.ts +4 -0
  141. package/dist/src/validations/invalidFields/getInvalidControllingPersonsFields.d.ts +2 -0
  142. package/dist/src/validations/invalidFields/getInvalidFields.d.ts +4 -0
  143. package/dist/src/validations/invalidFields/getInvalidTaxResidencyFields.d.ts +4 -0
  144. package/dist/src/validations/{invalidFieldRules.d.ts → invalidFields/invalidFieldRules.d.ts} +1 -2
  145. package/dist/src/validations/requiredFields/getRequiredAddressFields.d.ts +6 -0
  146. package/dist/src/validations/requiredFields/getRequiredControllingPersonFields.d.ts +3 -0
  147. package/dist/src/validations/requiredFields/getRequiredFields.d.ts +3 -0
  148. package/dist/src/validations/requiredFields/getRequiredTaxResidenceFields.d.ts +6 -0
  149. package/dist/src/validations/supportedFields/__tests__/generateStrings.d.ts +5 -0
  150. package/dist/src/validations/supportedFields/getSupportedAddressFields.d.ts +7 -0
  151. package/dist/src/validations/supportedFields/getSupportedControllingPersonFields.d.ts +6 -0
  152. package/dist/src/validations/supportedFields/getSupportedFields.d.ts +3 -0
  153. package/dist/src/validations/supportedFields/getSupportedTaxResidenceFields.d.ts +7 -0
  154. package/dist/src/validations/supportedFields/getSupportedTreatyClaimFields.d.ts +3 -0
  155. package/dist/src/validations/visibleFields/getVisibleAddressFields.d.ts +4 -0
  156. package/dist/src/validations/visibleFields/getVisibleControllingPersonFields.d.ts +3 -0
  157. package/dist/src/validations/visibleFields/getVisibleFields.d.ts +3 -0
  158. package/dist/src/validations/visibleFields/getVisibleTaxResidenceFields.d.ts +8 -0
  159. package/dist/src/{entry → widgets}/TaxbitQuestionnaire/TaxbitQuestionnaire.d.ts +3 -4
  160. package/dist/src/widgets/TaxbitQuestionnairePersist/TaxbitQuestionnairePersist.d.ts +0 -1
  161. package/dist/src/widgets/TaxbitQuestionnairePersist/__tests__/TaxbitQuestionnairePersist.complete.test.d.ts +0 -1
  162. package/dist/src/widgets/TaxbitQuestionnairePersist/__tests__/TaxbitQuestionnairePersist.error.test.d.ts +0 -1
  163. package/dist/src/widgets/TaxbitQuestionnairePersist/__tests__/TaxbitQuestionnairePersist.loaded.test.d.ts +0 -1
  164. package/dist/src/widgets/TaxbitQuestionnairePersist/__tests__/TaxbitQuestionnairePersist.loading.test.d.ts +0 -1
  165. package/dist/src/widgets/TaxbitQuestionnairePersist/__tests__/TaxbitQuestionnairePersist.missingBearerToken.test.d.ts +0 -1
  166. package/dist/src/widgets/TaxbitQuestionnairePersist/useTaxbitPersist.d.ts +2 -3
  167. package/dist/src/wizard/AddressInput/AddressInput.d.ts +1 -2
  168. package/dist/src/wizard/ControllingPersonInput/ControllingPersonInput.d.ts +10 -0
  169. package/dist/src/wizard/ControllingPersonInput/index.d.ts +1 -0
  170. package/dist/src/wizard/LanguageSelector/LanguageSelector.d.ts +2 -3
  171. package/dist/src/wizard/ResidenceInput/ResidenceInput.d.ts +2 -2
  172. package/dist/src/wizard/RowInput/AddressRow/AddressRow.d.ts +1 -2
  173. package/dist/src/wizard/RowInput/CheckBoxRow/CheckBoxRow.d.ts +0 -1
  174. package/dist/src/wizard/RowInput/DateOfBirthRow/DateOfBirthRow.d.ts +0 -1
  175. package/dist/src/wizard/RowInput/ErrorRow/ErrorRow.d.ts +0 -1
  176. package/dist/src/wizard/RowInput/HiddenInputRow/HiddenInputRow.d.ts +0 -1
  177. package/dist/src/wizard/RowInput/PercentInputRow/PercentInputRow.d.ts +8 -0
  178. package/dist/src/wizard/RowInput/PercentInputRow/index.d.ts +1 -0
  179. package/dist/src/wizard/RowInput/RadioButtonRow/RadioButtonRow.d.ts +0 -1
  180. package/dist/src/wizard/RowInput/SelectRow/SelectRow.d.ts +2 -2
  181. package/dist/src/wizard/RowInput/ShowHideInputRow/ShowHideInputRow.d.ts +0 -1
  182. package/dist/src/wizard/RowInput/TextAreaRow/TextAreaRow.d.ts +0 -1
  183. package/dist/src/wizard/RowInput/TextInputRow/TextInputRow.d.ts +0 -1
  184. package/dist/src/wizard/RowInput/ToggleButtonRow/ToggleButtonRow.d.ts +0 -1
  185. package/dist/src/wizard/RowInput/VisibleRow/VisibleRow.d.ts +0 -1
  186. package/dist/src/wizard/RowInput/index.d.ts +1 -0
  187. package/dist/src/wizard/TaxbitQuestionnaireUI/AccountHolderClassification/AccountHolderClassification.d.ts +0 -1
  188. package/dist/src/wizard/TaxbitQuestionnaireUI/AccountHolderContact/AccountHolderContact.d.ts +0 -1
  189. package/dist/src/wizard/TaxbitQuestionnaireUI/AccountHolderTax/AccountHolderTax.d.ts +0 -1
  190. package/dist/src/wizard/TaxbitQuestionnaireUI/AccountHolderTaxClarification/AccountHolderTaxClarification.d.ts +0 -1
  191. package/dist/src/wizard/TaxbitQuestionnaireUI/AccountHolderTreatyClaims/AccountHolderTreatyClaims.d.ts +0 -1
  192. package/dist/src/wizard/TaxbitQuestionnaireUI/AppError/AppError.d.ts +0 -1
  193. package/dist/src/wizard/TaxbitQuestionnaireUI/ControllingPersonDetails/ControllingPersonDetails.d.ts +6 -0
  194. package/dist/src/wizard/TaxbitQuestionnaireUI/ControllingPersonDetails/index.d.ts +1 -0
  195. package/dist/src/wizard/TaxbitQuestionnaireUI/Exemptions/Exemptions.d.ts +0 -1
  196. package/dist/src/wizard/TaxbitQuestionnaireUI/RegardedOwnerContact/RegardedOwnerContact.d.ts +0 -1
  197. package/dist/src/wizard/TaxbitQuestionnaireUI/RegardedOwnerTax/RegardedOwnerTax.d.ts +0 -1
  198. package/dist/src/wizard/TaxbitQuestionnaireUI/RegardedOwnerTreatyClaims/RegardedOwnerTreatyClaims.d.ts +0 -1
  199. package/dist/src/wizard/TaxbitQuestionnaireUI/Summary/AccountHolder/AccountHolderClassificationSummary.d.ts +2 -0
  200. package/dist/src/wizard/TaxbitQuestionnaireUI/Summary/AccountHolder/AccountHolderForeignClassificationSummary.d.ts +5 -0
  201. package/dist/src/wizard/TaxbitQuestionnaireUI/Summary/AccountHolder/AccountHolderSelfCertificationClassificationSummary.d.ts +5 -0
  202. package/dist/src/wizard/TaxbitQuestionnaireUI/Summary/AccountHolder/AccountHolderUsClassificationSummary.d.ts +5 -0
  203. package/dist/src/wizard/TaxbitQuestionnaireUI/Summary/ControllingPerson/ControllingPersonRoleInputValue.d.ts +6 -0
  204. package/dist/src/wizard/TaxbitQuestionnaireUI/Summary/ControllingPerson/ControllingPersonSummary.d.ts +6 -0
  205. package/dist/src/wizard/TaxbitQuestionnaireUI/Summary/ControllingPerson/ControllingPersonTypeSummary.d.ts +6 -0
  206. package/dist/src/wizard/TaxbitQuestionnaireUI/Summary/Recap.d.ts +0 -1
  207. package/dist/src/wizard/TaxbitQuestionnaireUI/Summary/RegardedOwner/RegardedOwnerClassificationSummary.d.ts +2 -0
  208. package/dist/src/wizard/TaxbitQuestionnaireUI/Summary/RegardedOwner/RegardedOwnerForeignClassificationSummary.d.ts +5 -0
  209. package/dist/src/wizard/TaxbitQuestionnaireUI/Summary/RegardedOwner/RegardedOwnerUsClassificationSummary.d.ts +5 -0
  210. package/dist/src/wizard/TaxbitQuestionnaireUI/Summary/Summary.d.ts +0 -1
  211. package/dist/src/wizard/TaxbitQuestionnaireUI/Summary/TaxResidency/TaxResidenciesSummary.d.ts +10 -0
  212. package/dist/src/wizard/TaxbitQuestionnaireUI/TaxbitQuestionnaireUI.d.ts +0 -1
  213. package/dist/src/wizard/TaxbitQuestionnaireUI/W8imyInstructions/W8imyInstructions.d.ts +0 -1
  214. package/dist/src/wizard/TaxbitQuestionnaireUI/__tests__/TaxbitDPSQuestionnaireUI.test.d.ts +0 -1
  215. package/dist/src/wizard/TaxbitQuestionnaireUI/__tests__/TaxbitQuestionnaireUI.SelfCert.AccountClassification.test.d.ts +0 -0
  216. package/dist/src/wizard/TaxbitQuestionnaireUI/__tests__/TaxbitQuestionnaireUI.SelfCert.ControllingPerson.test.d.ts +0 -0
  217. package/dist/src/wizard/TaxbitQuestionnaireUI/__tests__/TaxbitQuestionnaireUI.SelfCert.NameAndAddress.test.d.ts +0 -0
  218. package/dist/src/wizard/TaxbitQuestionnaireUI/__tests__/TaxbitQuestionnaireUI.SelfCert.Summary.test.d.ts +0 -0
  219. package/dist/src/wizard/TaxbitQuestionnaireUI/__tests__/TaxbitQuestionnaireUI.SelfCert.TaxResidencies.test.d.ts +0 -0
  220. package/dist/src/wizard/TaxbitQuestionnaireUI/__tests__/TaxbitQuestionnaireUI.test.d.ts +0 -1
  221. package/dist/src/wizard/TaxbitQuestionnaireUI/__tests__/TaxbitWFormQuestionnaireUI.test.d.ts +0 -1
  222. package/dist/src/wizard/TaxbitQuestionnaireUI/__tests__/TaxbitWFormQuestionnaireUI.treatyClaims.test.d.ts +0 -1
  223. package/dist/src/wizard/TaxbitQuestionnaireUI/steps.d.ts +1 -0
  224. package/dist/taxbit-react-sdk.js +7290 -6619
  225. package/dist/taxbit-react-sdk.umd.cjs +1 -1
  226. package/package.json +7 -6
  227. package/style/basic.css +4 -0
  228. package/style/inline.css +1 -0
  229. package/dist/src/types/Questionnaire.d.ts +0 -1
  230. package/dist/src/utils/transformForClient/transformForClientTaxResidenceFields.d.ts +0 -7
  231. package/dist/src/validations/getInvalidFields.d.ts +0 -5
  232. package/dist/src/validations/getRequiredFields.d.ts +0 -4
  233. package/dist/src/validations/getSupportedFields.d.ts +0 -7
  234. package/dist/src/validations/getVisibleFields.d.ts +0 -4
  235. /package/dist/src/{entry → widgets}/TaxbitQuestionnaire/index.d.ts +0 -0
package/README.md CHANGED
@@ -4,7 +4,7 @@ A React component and hook for gathering Tax Documentation data for US and EU Ta
4
4
 
5
5
  ## Usage
6
6
 
7
- The Taxbit React SDK provides a React component, hook, and Typescript types for gathering tax documentation data from users. The component can be used to collect data for the Taxbit DPS (Digital Platform Sales) or W-Form (W-9, W-8BEN, W-8BEN-E) tax documentation forms. A hook provides more tools to understand the user's tax documentation status and download any pdf versions of the files that are created if eligible.
7
+ The Taxbit React SDK provides a React component, hook, and Typescript types for gathering tax documentation data from users. The component can be used to collect data for the Taxbit DPS (Digital Platform Sales), W-Form (W-9, W-8BEN, W-8BEN-E), or Self-certification (DAC8, CARF) tax documentation forms. A hook provides additional tools to understand the user's tax documentation status and download any digital versions of the tax form files that are created if that are available.
8
8
 
9
9
  DPS (Digital Platform Sales) is a data standard and UI flow used by Taxbit to gather the information needed to report income as directed by the DAC7 for the European Union, and equivalent reporting requirements in Canada, New Zealand, and the United Kingdom.
10
10
 
@@ -179,6 +179,10 @@ type ClientTaxDocumentationStatus = {
179
179
  tinValidationDate?: string;
180
180
  needsResubmission: boolean;
181
181
  };
182
+ selfCertification?: {
183
+ dataCollectionStatus: 'COMPLETE' | 'INCOMPLETE';
184
+ needsResubmission: boolean;
185
+ };
182
186
  };
183
187
  ```
184
188
 
@@ -313,18 +317,23 @@ type Progress = {
313
317
  ```
314
318
 
315
319
  ```typescript
316
- type QuestionnaireType = 'DPS' | 'W-FORM';
320
+ type QuestionnaireType = 'DPS' | 'W-FORM' | 'SELF-CERT';
317
321
  ```
318
322
 
319
323
  ## Changelog
320
324
 
325
+ ### Version 1.2.0-beta.0
326
+
327
+ 1. Self-Certification support
328
+
321
329
  ### Version 1.1.0-beta.1
322
330
 
323
331
  1. Small bug fixes related to mailing address and using enter key to submit.
332
+ 2. React 19 Support.
324
333
 
325
334
  ### Version 1.1.0-beta.0
326
335
 
327
- 1. Treaty Claims can now be collected for the W-8BEN and W-8BEN-E forms.
336
+ 1. Treaty Claims Support on W-Forms.
328
337
 
329
338
  ### Version 1.0.0-beta.8
330
339
 
@@ -433,7 +442,7 @@ type QuestionnaireType = 'DPS' | 'W-FORM';
433
442
 
434
443
  ### Version 0.2.1
435
444
 
436
- 1. The SDK now supports React versions 16, 17, and 18 and TypeScript versions 4 and 5.
445
+ 1. The SDK now supports React versions 16, 17, 18 and TypeScript versions 4 and 5.
437
446
 
438
447
  ### Version 0.2.0
439
448
 
package/dist/index.d.ts CHANGED
@@ -1 +1 @@
1
- export * from './src'
1
+ export {}
package/dist/src/App.d.ts CHANGED
@@ -1,3 +1,2 @@
1
1
  import { default as React } from 'react';
2
-
3
2
  export declare const App: () => React.JSX.Element;
@@ -1,5 +1,4 @@
1
1
  import { default as React } from 'react';
2
-
3
2
  type AddressParts = {
4
3
  street?: string;
5
4
  street2?: string;
@@ -1,5 +1,4 @@
1
1
  import { default as React } from 'react';
2
-
3
2
  export declare const ErrorAlert: ({ message }: {
4
3
  message?: string;
5
4
  }) => React.JSX.Element;
@@ -1,5 +1,4 @@
1
1
  import { default as React, Component, ReactNode } from 'react';
2
-
3
2
  interface Props {
4
3
  children?: ReactNode;
5
4
  }
@@ -1,6 +1,5 @@
1
1
  import { default as React } from 'react';
2
2
  import { TaxDocumentationKey } from 'types';
3
-
4
3
  export declare const ErrorMessage: ({ name }: {
5
4
  name: TaxDocumentationKey;
6
5
  }) => React.JSX.Element | null;
@@ -1,5 +1,4 @@
1
1
  import { default as React } from 'react';
2
-
3
2
  type FormProps = {
4
3
  title: string;
5
4
  subTitle?: string;
@@ -1,5 +1,4 @@
1
1
  import { default as React } from 'react';
2
-
3
2
  export declare const InputStatus: ({ children, className, }: {
4
3
  className?: string;
5
4
  children: React.ReactNode;
@@ -1,5 +1,4 @@
1
1
  import { default as React } from 'react';
2
-
3
2
  export declare const JsxFromString: ({ val }: {
4
3
  val?: string;
5
4
  }) => React.ReactNode[] | null;
@@ -1,6 +1,5 @@
1
1
  import { default as React } from 'react';
2
2
  import { Progress } from '../../types';
3
-
4
3
  export declare const ProgressStatus: ({ progress }: {
5
4
  progress?: Progress;
6
5
  }) => React.JSX.Element | null;
@@ -1,6 +1,5 @@
1
1
  import { default as React } from 'react';
2
2
  import { TaxDocumentationKey } from 'types/TaxDocumentation';
3
-
4
3
  export type RowProps = {
5
4
  label?: string;
6
5
  subLabel?: string;
@@ -1,5 +1,4 @@
1
1
  import { default as React } from 'react';
2
-
3
2
  type SectionProps = {
4
3
  title?: string;
5
4
  subTitle?: string;
@@ -1,5 +1,4 @@
1
1
  import { default as React } from 'react';
2
-
3
2
  type FormUIProviderProps = {
4
3
  children: React.ReactNode;
5
4
  };
@@ -1,7 +1,6 @@
1
1
  import { ButtonKey, ErrorKey, PromptKey, SubPromptKey, SubTitleKey, TextKey } from '../../i18n/types';
2
- import { Locale, TaxDocumentation, TaxDocumentationKey } from '../../types';
3
-
4
- export declare const getLocal: (fields: TaxDocumentation, language: Locale) => {
2
+ import { Locale, QuestionnaireProp, TaxDocumentation, TaxDocumentationKey } from '../../types';
3
+ export declare const getLocal: (fields: TaxDocumentation, language: Locale, questionnaire: QuestionnaireProp) => {
5
4
  getLocalText: (key: TextKey) => string;
6
5
  getLocalTitle: (key: string) => string;
7
6
  getLocalSubTitle: (key: SubTitleKey) => string;
@@ -9,12 +8,13 @@ export declare const getLocal: (fields: TaxDocumentation, language: Locale) => {
9
8
  getLocalButton: (key: ButtonKey) => string;
10
9
  getLocalPrompt: (key: string) => string;
11
10
  getLocalSubPrompt: (key: TaxDocumentationKey) => string;
12
- getLocalOption: (key: string | undefined) => string | undefined;
11
+ getLocalOption: (key: string | undefined, prefix?: string) => string | undefined;
13
12
  getLocalSubOption: (key: string | undefined) => string | undefined;
14
13
  getLocalCountry: (key: string | undefined) => string;
15
14
  getLocalUsState: (key: string | undefined) => "" | "Alabama" | "Alaska" | "Arizona" | "Arkansas" | "California" | "Colorado" | "Connecticut" | "Delaware" | "District Of Columbia" | "Florida" | "Georgia" | "Hawaii" | "Idaho" | "Illinois" | "Indiana" | "Iowa" | "Kansas" | "Kentucky" | "Louisiana" | "Maine" | "Maryland" | "Massachusetts" | "Michigan" | "Minnesota" | "Mississippi" | "Missouri" | "Montana" | "Nebraska" | "Nevada" | "New Hampshire" | "New Jersey" | "New Mexico" | "New York" | "North Carolina" | "North Dakota" | "Ohio" | "Oklahoma" | "Oregon" | "Pennsylvania" | "Rhode Island" | "South Carolina" | "South Dakota" | "Tennessee" | "Texas" | "Utah" | "Vermont" | "Virginia" | "Washington" | "West Virginia" | "Wisconsin" | "Wyoming";
16
15
  getLocalCaProvince: (key: string | undefined) => string;
17
16
  getLocalMonth: (key: string | undefined) => string;
17
+ getLocalAddressTitle: (data: TaxDocumentation) => string;
18
18
  getPromptKey: (key: string) => PromptKey;
19
19
  getSubPromptKey: (key: string) => SubPromptKey;
20
20
  };
@@ -1,5 +1,4 @@
1
1
  import { TaxDocumentationErrorFile, TaxDocumentationPropertyFile } from './useQuestionnaireStep';
2
-
3
2
  export * from './QuestionnaireStepProvider';
4
3
  export * from './useQuestionnaireStepContext';
5
4
  export { TaxDocumentationErrorFile, TaxDocumentationPropertyFile };
@@ -0,0 +1,2 @@
1
+ import { TaxDocumentation } from '../../types';
2
+ export declare const shiftControllingPerson: (fields: TaxDocumentation, index: 1 | 2 | 3 | 4) => TaxDocumentation;
@@ -1,3 +1,2 @@
1
1
  import { TaxDocumentation } from '../../types';
2
-
3
- export declare const shiftResidence: (fields: TaxDocumentation, index: 1 | 2 | 3 | 4) => TaxDocumentation;
2
+ export declare const shiftResidence: (fields: TaxDocumentation, prefix: string, index: string) => TaxDocumentation;
@@ -1,7 +1,6 @@
1
1
  import { ErrorKey } from 'i18n/types';
2
2
  import { Yes } from 'types';
3
3
  import { TaxDocumentation, TaxDocumentationKey } from 'types/TaxDocumentation';
4
-
5
4
  export type TaxDocumentationPropertyFile = {
6
5
  [key in TaxDocumentationKey]: boolean;
7
6
  };
@@ -16,12 +15,13 @@ export declare const useQuestionnaireStep: () => {
16
15
  getLocalButton: (key: import('i18n/types').ButtonKey) => string;
17
16
  getLocalPrompt: (key: string) => string;
18
17
  getLocalSubPrompt: (key: TaxDocumentationKey) => string;
19
- getLocalOption: (key: string | undefined) => string | undefined;
18
+ getLocalOption: (key: string | undefined, prefix?: string) => string | undefined;
20
19
  getLocalSubOption: (key: string | undefined) => string | undefined;
21
20
  getLocalCountry: (key: string | undefined) => string;
22
21
  getLocalUsState: (key: string | undefined) => "" | "Alabama" | "Alaska" | "Arizona" | "Arkansas" | "California" | "Colorado" | "Connecticut" | "Delaware" | "District Of Columbia" | "Florida" | "Georgia" | "Hawaii" | "Idaho" | "Illinois" | "Indiana" | "Iowa" | "Kansas" | "Kentucky" | "Louisiana" | "Maine" | "Maryland" | "Massachusetts" | "Michigan" | "Minnesota" | "Mississippi" | "Missouri" | "Montana" | "Nebraska" | "Nevada" | "New Hampshire" | "New Jersey" | "New Mexico" | "New York" | "North Carolina" | "North Dakota" | "Ohio" | "Oklahoma" | "Oregon" | "Pennsylvania" | "Rhode Island" | "South Carolina" | "South Dakota" | "Tennessee" | "Texas" | "Utah" | "Vermont" | "Virginia" | "Washington" | "West Virginia" | "Wisconsin" | "Wyoming";
23
22
  getLocalCaProvince: (key: string | undefined) => string;
24
23
  getLocalMonth: (key: string | undefined) => string;
24
+ getLocalAddressTitle: (data: TaxDocumentation) => string;
25
25
  getPromptKey: (key: string) => import('i18n/types').PromptKey;
26
26
  getSubPromptKey: (key: string) => import('i18n/types').SubPromptKey;
27
27
  clearIfNotRequired: (...arg: TaxDocumentationKey[]) => (value: Yes | undefined) => void;
@@ -6,12 +6,13 @@ export declare const useQuestionnaireStepContext: () => {
6
6
  getLocalButton: (key: import('../../i18n/types/LocalizationKey.ts').ButtonKey) => string;
7
7
  getLocalPrompt: (key: string) => string;
8
8
  getLocalSubPrompt: (key: import('../../types/TaxDocumentation.ts').TaxDocumentationKey) => string;
9
- getLocalOption: (key: string | undefined) => string | undefined;
9
+ getLocalOption: (key: string | undefined, prefix?: string) => string | undefined;
10
10
  getLocalSubOption: (key: string | undefined) => string | undefined;
11
11
  getLocalCountry: (key: string | undefined) => string;
12
12
  getLocalUsState: (key: string | undefined) => "" | "Alabama" | "Alaska" | "Arizona" | "Arkansas" | "California" | "Colorado" | "Connecticut" | "Delaware" | "District Of Columbia" | "Florida" | "Georgia" | "Hawaii" | "Idaho" | "Illinois" | "Indiana" | "Iowa" | "Kansas" | "Kentucky" | "Louisiana" | "Maine" | "Maryland" | "Massachusetts" | "Michigan" | "Minnesota" | "Mississippi" | "Missouri" | "Montana" | "Nebraska" | "Nevada" | "New Hampshire" | "New Jersey" | "New Mexico" | "New York" | "North Carolina" | "North Dakota" | "Ohio" | "Oklahoma" | "Oregon" | "Pennsylvania" | "Rhode Island" | "South Carolina" | "South Dakota" | "Tennessee" | "Texas" | "Utah" | "Vermont" | "Virginia" | "Washington" | "West Virginia" | "Wisconsin" | "Wyoming";
13
13
  getLocalCaProvince: (key: string | undefined) => string;
14
14
  getLocalMonth: (key: string | undefined) => string;
15
+ getLocalAddressTitle: (data: import('../../types/TaxDocumentation.ts').TaxDocumentation) => string;
15
16
  getPromptKey: (key: string) => import('../../i18n/types/LocalizationKey.ts').PromptKey;
16
17
  getSubPromptKey: (key: string) => import('../../i18n/types/LocalizationKey.ts').SubPromptKey;
17
18
  clearIfNotRequired: (...arg: import('../../types/TaxDocumentation.ts').TaxDocumentationKey[]) => (value: import('../../types/Yes.ts').Yes | undefined) => void;
@@ -37,12 +38,13 @@ export declare const useQuestionnaireStepContext: () => {
37
38
  getLocalButton: (key: import('../../i18n/types/LocalizationKey.ts').ButtonKey) => string;
38
39
  getLocalPrompt: (key: string) => string;
39
40
  getLocalSubPrompt: (key: import('../../types/TaxDocumentation.ts').TaxDocumentationKey) => string;
40
- getLocalOption: (key: string | undefined) => string | undefined;
41
+ getLocalOption: (key: string | undefined, prefix?: string) => string | undefined;
41
42
  getLocalSubOption: (key: string | undefined) => string | undefined;
42
43
  getLocalCountry: (key: string | undefined) => string;
43
44
  getLocalUsState: (key: string | undefined) => "" | "Alabama" | "Alaska" | "Arizona" | "Arkansas" | "California" | "Colorado" | "Connecticut" | "Delaware" | "District Of Columbia" | "Florida" | "Georgia" | "Hawaii" | "Idaho" | "Illinois" | "Indiana" | "Iowa" | "Kansas" | "Kentucky" | "Louisiana" | "Maine" | "Maryland" | "Massachusetts" | "Michigan" | "Minnesota" | "Mississippi" | "Missouri" | "Montana" | "Nebraska" | "Nevada" | "New Hampshire" | "New Jersey" | "New Mexico" | "New York" | "North Carolina" | "North Dakota" | "Ohio" | "Oklahoma" | "Oregon" | "Pennsylvania" | "Rhode Island" | "South Carolina" | "South Dakota" | "Tennessee" | "Texas" | "Utah" | "Vermont" | "Virginia" | "Washington" | "West Virginia" | "Wisconsin" | "Wyoming";
44
45
  getLocalCaProvince: (key: string | undefined) => string;
45
46
  getLocalMonth: (key: string | undefined) => string;
47
+ getLocalAddressTitle: (data: import('../../types/TaxDocumentation.ts').TaxDocumentation) => string;
46
48
  getPromptKey: (key: string) => import('../../i18n/types/LocalizationKey.ts').PromptKey;
47
49
  getSubPromptKey: (key: string) => import('../../i18n/types/LocalizationKey.ts').SubPromptKey;
48
50
  clearIfNotRequired: (...arg: import('../../types/TaxDocumentation.ts').TaxDocumentationKey[]) => (value: import('../../types/Yes.ts').Yes | undefined) => void;
@@ -1,6 +1,5 @@
1
1
  import { default as React } from 'react';
2
2
  import { UseTaxDocumentationProps } from './useTaxDocumentation';
3
-
4
3
  type TaxDocumentationProviderProps = UseTaxDocumentationProps & {
5
4
  children: React.ReactNode;
6
5
  treatyClaims?: boolean;
@@ -1,7 +1,6 @@
1
1
  import { ClientTaxDocumentation } from '@taxbit/utilities';
2
- import { InputStep, Locale, Progress, Questionnaire, TaxDocumentation } from 'types';
2
+ import { InputStep, Locale, Progress, QuestionnaireProp, TaxDocumentation } from 'types';
3
3
  import { ExternalValidations } from 'types/client';
4
-
5
4
  type InterviewConfig = {
6
5
  minimumAge: number;
7
6
  };
@@ -12,7 +11,7 @@ export type UseTaxDocumentationProps = {
12
11
  onSubmit?: (data: ClientTaxDocumentation) => void | Promise<void>;
13
12
  onProgress?: (progress: Progress) => void | Promise<void>;
14
13
  step?: InputStep;
15
- questionnaire: Questionnaire;
14
+ questionnaire: QuestionnaireProp;
16
15
  config?: InterviewConfig;
17
16
  treatyClaims?: boolean;
18
17
  };
@@ -25,13 +24,13 @@ export declare const useTaxDocumentation: ({ data: startingData, language: initi
25
24
  goBack: (() => void) | undefined;
26
25
  goToNext: (data: TaxDocumentation) => void;
27
26
  progress: Progress | undefined;
28
- stepName: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "AccountHolderTreatyClaims" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary" | "W8imyInstructions";
27
+ stepName: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "AccountHolderTreatyClaims" | "ControllingPersonDetails1" | "ControllingPersonDetails2" | "ControllingPersonDetails3" | "ControllingPersonDetails4" | "ControllingPersonDetails5" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary" | "W8imyInstructions";
29
28
  data: TaxDocumentation;
30
29
  originalClientData: TaxDocumentation;
31
- initialStep: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "AccountHolderTreatyClaims" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary" | "W8imyInstructions";
30
+ initialStep: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "AccountHolderTreatyClaims" | "ControllingPersonDetails1" | "ControllingPersonDetails2" | "ControllingPersonDetails3" | "ControllingPersonDetails4" | "ControllingPersonDetails5" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary" | "W8imyInstructions";
32
31
  setLanguage: (lang: Locale) => void;
33
32
  language: Locale;
34
- questionnaire: Questionnaire;
33
+ questionnaire: QuestionnaireProp;
35
34
  externalValidations: ExternalValidations | undefined;
36
35
  config: InterviewConfig | undefined;
37
36
  isSubmitting: boolean;
@@ -7,13 +7,13 @@ export declare const useTaxDocumentationContext: () => {
7
7
  goBack: (() => void) | undefined;
8
8
  goToNext: (data: import('../../types').TaxDocumentation) => void;
9
9
  progress: import('../..').Progress | undefined;
10
- stepName: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "AccountHolderTreatyClaims" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary" | "W8imyInstructions";
10
+ stepName: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "AccountHolderTreatyClaims" | "ControllingPersonDetails1" | "ControllingPersonDetails2" | "ControllingPersonDetails3" | "ControllingPersonDetails4" | "ControllingPersonDetails5" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary" | "W8imyInstructions";
11
11
  data: import('../../types').TaxDocumentation;
12
12
  originalClientData: import('../../types').TaxDocumentation;
13
- initialStep: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "AccountHolderTreatyClaims" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary" | "W8imyInstructions";
13
+ initialStep: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "AccountHolderTreatyClaims" | "ControllingPersonDetails1" | "ControllingPersonDetails2" | "ControllingPersonDetails3" | "ControllingPersonDetails4" | "ControllingPersonDetails5" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary" | "W8imyInstructions";
14
14
  setLanguage: (lang: import('../..').Locale) => void;
15
15
  language: import('../..').Locale;
16
- questionnaire: import('../..').Questionnaire;
16
+ questionnaire: import('../..').QuestionnaireProp;
17
17
  externalValidations: import('../../types/client').ExternalValidations | undefined;
18
18
  config: {
19
19
  minimumAge: number;
@@ -29,13 +29,13 @@ export declare const useTaxDocumentationContext: () => {
29
29
  goBack: (() => void) | undefined;
30
30
  goToNext: (data: import('../../types').TaxDocumentation) => void;
31
31
  progress: import('../..').Progress | undefined;
32
- stepName: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "AccountHolderTreatyClaims" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary" | "W8imyInstructions";
32
+ stepName: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "AccountHolderTreatyClaims" | "ControllingPersonDetails1" | "ControllingPersonDetails2" | "ControllingPersonDetails3" | "ControllingPersonDetails4" | "ControllingPersonDetails5" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary" | "W8imyInstructions";
33
33
  data: import('../../types').TaxDocumentation;
34
34
  originalClientData: import('../../types').TaxDocumentation;
35
- initialStep: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "AccountHolderTreatyClaims" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary" | "W8imyInstructions";
35
+ initialStep: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "AccountHolderTreatyClaims" | "ControllingPersonDetails1" | "ControllingPersonDetails2" | "ControllingPersonDetails3" | "ControllingPersonDetails4" | "ControllingPersonDetails5" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary" | "W8imyInstructions";
36
36
  setLanguage: (lang: import('../..').Locale) => void;
37
37
  language: import('../..').Locale;
38
- questionnaire: import('../..').Questionnaire;
38
+ questionnaire: import('../..').QuestionnaireProp;
39
39
  externalValidations: import('../../types/client').ExternalValidations | undefined;
40
40
  config: {
41
41
  minimumAge: number;
@@ -1,5 +1,4 @@
1
1
  import { Dispatch, SetStateAction } from 'react';
2
-
3
2
  export declare const useHandleError: (onError: ((error: Error) => void | Promise<void>) | undefined, setError?: Dispatch<SetStateAction<Error | undefined>>) => {
4
3
  handleError: (error: Error) => void;
5
4
  };
@@ -1,3 +1,2 @@
1
1
  import { SignedClientTaxDocumentation } from '@taxbit/utilities';
2
-
3
2
  export declare const clientTaxDocumentation: SignedClientTaxDocumentation;
@@ -1,3 +1,2 @@
1
1
  import { SignedDatedComprehensiveTaxDocumentation } from '@taxbit/utilities';
2
-
3
2
  export declare const serverTaxDocumentation: SignedDatedComprehensiveTaxDocumentation;
@@ -1,5 +1,4 @@
1
1
  import { SignedDatedComprehensiveTaxDocumentation } from '@taxbit/utilities';
2
-
3
2
  export type Comprehensive = {
4
3
  account_holder: SignedDatedComprehensiveTaxDocumentation['account_holder'];
5
4
  regarded_owner?: SignedDatedComprehensiveTaxDocumentation['regarded_owner'];
@@ -1,6 +1,5 @@
1
1
  import { Comprehensive } from './comprehensive';
2
2
  import { W9 } from './w9';
3
-
4
3
  export type W8 = {
5
4
  name?: string;
6
5
  country?: string;
@@ -1,6 +1,5 @@
1
1
  import { Comprehensive } from './comprehensive';
2
2
  import { W8 } from './w8';
3
-
4
3
  export type W9 = {
5
4
  name?: string;
6
5
  tin?: string;
@@ -1,8 +1,7 @@
1
- import { Questionnaire } from 'types';
2
-
1
+ import { QuestionnaireProp } from 'types';
3
2
  type UseTaxbitProps = {
4
3
  bearerToken: string;
5
- questionnaire: Questionnaire;
4
+ questionnaire: QuestionnaireProp;
6
5
  staging?: boolean;
7
6
  onError?: (error: Error) => void | Promise<void>;
8
7
  };
@@ -1,11 +1,10 @@
1
1
  import { SignedClientTaxDocumentation } from '@taxbit/utilities';
2
- import { Questionnaire } from '../../types';
2
+ import { QuestionnaireProp } from '../../types';
3
3
  import { ClientTaxDocumentationStatus } from '../../types/client';
4
-
5
4
  type UseTaxbitStatusProps = {
6
5
  bearerToken?: string;
7
6
  onError?: (error: Error) => void | Promise<void>;
8
- questionnaire: Questionnaire;
7
+ questionnaire: QuestionnaireProp;
9
8
  staging?: boolean;
10
9
  };
11
10
  export declare const useTaxbitStatus: ({ bearerToken, questionnaire, staging, onError, }: UseTaxbitStatusProps) => {
@@ -1,4 +1,3 @@
1
- import { DPSPropertyFile } from '../types/PropertyFile';
2
-
3
- export declare const deTranslations: DPSPropertyFile;
1
+ import { ForeignPropertyFile } from '../types/PropertyFile';
2
+ export declare const deTranslations: ForeignPropertyFile;
4
3
  export declare const de: import('../types/PropertyFile').PropertyFile;
@@ -1,4 +1,3 @@
1
1
  import { PartialDPSPropertyFile } from '../types/PropertyFile';
2
-
3
2
  export declare const elCyTranslations: PartialDPSPropertyFile;
4
3
  export declare const elCy: import('../types/PropertyFile').PropertyFile;
@@ -1,4 +1,3 @@
1
- import { DPSPropertyFile } from '../types/PropertyFile';
2
-
3
- export declare const elTranslations: DPSPropertyFile;
1
+ import { ForeignPropertyFile } from '../types/PropertyFile';
2
+ export declare const elTranslations: ForeignPropertyFile;
4
3
  export declare const el: import('../types/PropertyFile').PropertyFile;
@@ -1,3 +1,2 @@
1
1
  import { PropertyFile } from '../types/PropertyFile';
2
-
3
2
  export declare const enGb: PropertyFile;
@@ -1,3 +1,2 @@
1
1
  import { PropertyFile } from '../types/PropertyFile';
2
-
3
2
  export declare const enNz: PropertyFile;
@@ -1,3 +1,2 @@
1
1
  import { PropertyFile } from '../types/PropertyFile';
2
-
3
2
  export declare const enUs: PropertyFile;
@@ -1,3 +1,2 @@
1
1
  import { PropertyFile } from '../types/PropertyFile';
2
-
3
2
  export declare const en: PropertyFile;
@@ -1,3 +1,2 @@
1
1
  import { PropertyFile } from '../types/PropertyFile';
2
-
3
2
  export declare const es: PropertyFile;
@@ -1,3 +1,2 @@
1
1
  import { PropertyFile } from '../types/PropertyFile';
2
-
3
2
  export declare const frCa: PropertyFile;
@@ -1,3 +1,2 @@
1
1
  import { PropertyFile } from '../types/PropertyFile';
2
-
3
2
  export declare const fr: PropertyFile;
@@ -1,3 +1 @@
1
- import { PropertyFile } from '../types/PropertyFile';
2
-
3
- export declare const ga: PropertyFile;
1
+ export declare const ga: import('../types/PropertyFile').PropertyFile;
@@ -1,4 +1,3 @@
1
- import { DPSPropertyFile } from '../types/PropertyFile';
2
-
3
- export declare const ltTranslations: DPSPropertyFile;
1
+ import { ForeignPropertyFile } from '../types/PropertyFile';
2
+ export declare const ltTranslations: ForeignPropertyFile;
4
3
  export declare const lt: import('../types/PropertyFile').PropertyFile;
@@ -1,5 +1,4 @@
1
1
  import { PropertyFile } from '../types/PropertyFile';
2
-
3
2
  type DeepPartial<T> = T extends object ? {
4
3
  [P in keyof T]?: DeepPartial<T[P]>;
5
4
  } : T;
@@ -1,4 +1,3 @@
1
1
  import { PartialDPSPropertyFile } from '../types/PropertyFile';
2
-
3
2
  export declare const nlBeTranslations: PartialDPSPropertyFile;
4
3
  export declare const nlBe: import('../types/PropertyFile').PropertyFile;
@@ -1,4 +1,3 @@
1
- import { DPSPropertyFile } from '../types/PropertyFile';
2
-
3
- export declare const plTranslations: DPSPropertyFile;
1
+ import { ForeignPropertyFile } from '../types/PropertyFile';
2
+ export declare const plTranslations: ForeignPropertyFile;
4
3
  export declare const pl: import('../types/PropertyFile').PropertyFile;
@@ -1,5 +1,4 @@
1
1
  import { PropertyFile } from '../types/PropertyFile';
2
-
3
2
  export declare const translationRequired = "translation required";
4
3
  export declare const translationRequiredForDPS = "translation required for DPS";
5
4
  export declare const translationRequiredForWForm = "translation required for W-Form";
@@ -1,6 +1,5 @@
1
1
  import { Locale } from 'types';
2
2
  import { PropertyFile } from './types/PropertyFile';
3
-
4
3
  type LocalizationFile = {
5
4
  [locale in Locale]: PropertyFile;
6
5
  };
@@ -1,11 +1,11 @@
1
1
  export type ButtonKey = 'edit' | 'back' | 'next' | 'reset' | 'submit' | 'cancel' | 'hide' | 'show';
2
2
  export type ErrorKey = 'countryMustBeAResidenceCountry' | 'formHasErrors' | 'invalid' | 'invalidDate' | 'invalidVat' | 'mustBeFiveOrNineDigits' | 'mustBeInDateFormat' | 'mustBeNineDigits' | 'mustBeNinoFormat' | 'mustBeCaPostalCodeFormat' | 'mustBeInVatinFormat' | 'mustBeValidBirthDate' | 'mustBeAtLeast18' | 'mustMatchName' | 'mustNotMatchVatin' | 'required' | 'residencesMustIncludeAddressCountry' | 'residencesMustIncludeAnEUCountry' | 'residencesMustIncludeVatCountry' | 'tooLong' | 'tooShort' | 'vatinMustNotMatchResidencyTin';
3
- export type SubOptionKey = 'accountHolderUsAccountType_SOLE_PROPRIETOR' | 'accountHolderUsAccountType_SM_LLC' | 'accountHolderUsAccountType_DISREGARDED_ENTITY';
4
- export type OptionKey = TreatyClaimOption | 'accountHolderUsPerson_yes' | 'accountHolderUsPerson_no' | 'usTrustEstateEin_yes' | 'usTrustEstateEin_no' | 'usSoleProprietorEin_yes' | 'usSoleProprietorEin_no' | 'regardedOwnerUsPerson_yes' | 'regardedOwnerUsPerson_no' | 'smllcOwnerUsPerson_yes' | 'smllcOwnerUsPerson_no' | 'smllcElection_yes' | 'smllcElection_no' | 'isIndividual_yes' | 'isIndividual_no' | 'no' | 'yes' | 'CENTRAL_BANK_OF_ISSUE' | 'COMPLEX_TRUST' | 'CORPORATION' | 'C_CORPORATION' | 'DISREGARDED_ENTITY' | 'ESTATE' | 'FOREIGN_GOVERNMENT_CONTROLLED_ENTITY' | 'FOREIGN_GOVERNMENT_INTEGRAL_PART' | 'GRANTOR_TRUST' | 'INDIVIDUAL' | 'INTERNATIONAL_ORGANIZATION' | 'LLC' | 'OTHER' | 'PARTNERSHIP' | 'PRIVATE_FOUNDATION' | 'SIMPLE_TRUST' | 'SM_LLC' | 'SOLE_PROPRIETOR' | 'S_CORPORATION' | 'TAX_EXEMPT_ORGANIZATION' | 'TRUST' | 'TRUST_ESTATE';
5
- export type PromptKey = TreatyClaimPrompt | 'addAdditional' | 'address' | 'businessRegistrationNumber' | 'businessRegistrationCountry' | 'city' | 'cityOfBirth' | 'country' | 'countryOfBirth' | 'dateOfBirth' | 'day' | 'dbaName' | 'exemptPayeeCode' | 'exemptFatcaCode' | 'financialAccountIdentifier' | 'financialAccountName' | 'foreignAccountType' | 'foreignOtherClassification' | 'foreignTin' | 'foreignTinIsNotRequired' | 'foreignTrustClassification' | 'isIndividual' | 'iAcknowledgeESignIsOk' | 'iAgreeWillResubmitIfIncorrect' | 'iAmACitizenOfTheUs' | 'iAmExemptFromFatcaReporting' | 'iAmNotSubjectToBackupWithholding' | 'iAuthorizeWithholdingAgent' | 'iCertifyToAll' | 'iConfirmIncomeIsNonUs' | 'iConfirmTheBeneficialOwnerIsExempt' | 'iConfirmTheInformationIsCorrectComplete' | 'iConfirmTheEntityIsNotAUsPerson' | 'iConfirmTheEntityIsTheBeneficialOwner' | 'iConfirmTheIndividualIsNotAUsPerson' | 'iConfirmTheIndividualIsTheBeneficialOwner' | 'iConfirmTheIndividualIsResidentOfTreatyCountry' | 'iConfirmTheTaxIdIsCorrect' | 'iHaveCapacityToSignForEntity' | 'iHaveCapacityToSignForIndividual' | 'mailingAddress' | 'mailingAddressIsDifferent' | 'month' | 'name' | 'nameOfDisregardedEntity' | 'nameOfEntity' | 'nameOfCCorporation' | 'nameOfCorporation' | 'nameOfIndividual' | 'nameOfIndividualSoleProprietor' | 'nameOfLlc' | 'nameOfOrganization' | 'nameOfPartnership' | 'nameOfSCorporation' | 'nameOfSmllc' | 'nameOfSmllcOwner' | 'nameOfSoleProprietor' | 'nameOfTrustEstate' | 'nameOfTrust' | 'province' | 'referenceNumbers' | 'regardedOwnerUsPerson' | 'regardedOwnerAccountType' | 'removeResidence' | 'signature' | 'smllcElection' | 'smllcOwnerAccountType' | 'smllcOwnerUsPerson' | 'state' | 'stateProvince' | 'street' | 'street2' | 'taxIdNumber' | 'taxIdNumberIsNotRequired' | 'tin' | 'tinUkCrn' | 'tinUkNino' | 'usAccountType' | 'usLlcClassification' | 'usOtherClassification' | 'usPerson' | 'usEin' | 'usSoleProprietorEin' | 'usSsn' | 'usTin' | 'usTrustEstateEin' | 'vatIdentificationNumber' | 'vatIsNotRequired' | 'vatCountry' | 'year' | 'zip';
6
- export type SubPromptKey = TreatyClaimSubPrompt | 'smllcElection' | 'iAmNotSubjectToBackupWithholding' | 'iConfirmIncomeIsNonUs' | 'isIndividual' | 'financialAccountIdentifier' | 'financialAccountName' | 'vatIdentificationNumber' | 'placeOfBirth' | 'referenceNumbers' | 'signature' | 'streetIsPermanent' | 'usPerson';
7
- export type TitleKey = 'accountHolder' | 'accountHolderClassification' | 'accountHolderContactInformation' | 'accountHolderTaxInformation' | 'accountHolderTaxClarification' | 'accountHolderTreatyClaims' | 'address' | 'additionalConditions' | 'acknowledge' | 'certify' | 'confirmation' | 'countryOfCitizenship' | 'countryOfIncorporation' | 'exemptions' | 'mailingAddress' | 'primaryAddress' | 'permanentAddress' | 'placeOfBirth' | 'regardedOwner' | 'regardedOwnerClassification' | 'regardedOwnerContactInformation' | 'regardedOwnerTaxInformation' | 'regardedOwnerTreatyClaims' | 'signature' | 'summary' | 'taxResidences' | 'taxResidence1' | 'taxResidence2' | 'taxResidence3' | 'taxResidence4' | 'taxResidence5' | 'w8imyInstructions';
8
- export type SubTitleKey = 'taxResidences' | 'permanentAddress' | 'taxInformationTreatyClaims';
3
+ export type SubOptionKey = 'accountHolderUsAccountType_SOLE_PROPRIETOR' | 'accountHolderUsAccountType_SM_LLC' | 'accountHolderUsAccountType_DISREGARDED_ENTITY' | 'accountHolderActiveNonFinancialEntityType_OTHER' | 'accountHolderActiveNonFinancialEntityType_PUBLIC_CORPORATION';
4
+ export type OptionKey = TreatyClaimOption | 'accountHolderUsPerson_yes' | 'accountHolderUsPerson_no' | 'usTrustEstateEin_yes' | 'usTrustEstateEin_no' | 'usSoleProprietorEin_yes' | 'usSoleProprietorEin_no' | 'regardedOwnerUsPerson_yes' | 'regardedOwnerUsPerson_no' | 'smllcOwnerUsPerson_yes' | 'smllcOwnerUsPerson_no' | 'smllcElection_yes' | 'smllcElection_no' | 'isIndividual_yes' | 'isIndividual_no' | 'isInvestmentEntityManaged_yes' | 'isInvestmentEntityManaged_no' | 'no' | 'yes' | 'ACTIVE_NON_FINANCIAL_ENTITY' | 'CENTRAL_BANK_OF_ISSUE' | 'COMPLEX_TRUST' | 'CORPORATION' | 'CUSTODIAL_INSTITUTION' | 'C_CORPORATION' | 'DEPOSITORY_INSTITUTION' | 'DISREGARDED_ENTITY' | 'ENTITY_TYPE_TRUST' | 'ENTITY_TYPE_SIMILAR_TO_TRUST' | 'ENTITY_TYPE_OTHER' | 'ESTATE' | 'FINANCIAL_INSTITUTION' | 'FOREIGN_GOVERNMENT_CONTROLLED_ENTITY' | 'FOREIGN_GOVERNMENT_INTEGRAL_PART' | 'accountHolderActiveNonFinancialEntityType_GOVERNMENT_ENTITY' | 'GRANTOR_TRUST' | 'INDIVIDUAL' | 'accountHolderActiveNonFinancialEntityType_INTERNATIONAL_ORGANIZATION' | 'INTERNATIONAL_ORGANIZATION' | 'INVESTMENT_ENTITY' | 'INSURANCE_COMPANY' | 'LLC' | 'OTHER' | 'accountHolderActiveNonFinancialEntityType_OTHER' | 'PARTNERSHIP' | 'PASSIVE_NON_FINANCIAL_ENTITY' | 'PRIVATE_FOUNDATION' | 'accountHolderActiveNonFinancialEntityType_PUBLIC_CORPORATION' | 'SIGNATURE_CAPACITY_EXECUTOR' | 'SIGNATURE_CAPACITY_OFFICER' | 'SIGNATURE_CAPACITY_OTHER_CAPACITY' | 'SIMPLE_TRUST' | 'SM_LLC' | 'SOLE_PROPRIETOR' | 'S_CORPORATION' | 'TAX_EXEMPT_ORGANIZATION' | 'TRUST' | 'TRUST_ESTATE' | 'CONTROLLING_PERSON_ROLE_SETTLOR' | 'CONTROLLING_PERSON_ROLE_TRUSTEE' | 'CONTROLLING_PERSON_ROLE_PROTECTOR' | 'CONTROLLING_PERSON_ROLE_BENEFICIARY' | 'CONTROLLING_PERSON_ROLE_OTHER' | 'CONTROLLING_PERSON_ROLE_SETTLOR_EQUIVALENT' | 'CONTROLLING_PERSON_ROLE_TRUSTEE_EQUIVALENT' | 'CONTROLLING_PERSON_ROLE_PROTECTOR_EQUIVALENT' | 'CONTROLLING_PERSON_ROLE_BENEFICIARY_EQUIVALENT' | 'CONTROLLING_PERSON_ROLE_OTHER_EQUIVALENT' | 'CONTROLLING_PERSON_ROLE_OWNER' | 'CONTROLLING_PERSON_ROLE_OTHER_MEANS' | 'CONTROLLING_PERSON_ROLE_SENIOR_MANAGING_OFFICIAL' | 'MISSING_TIN_NOT_REQUIRED_REASON_NOT_ISSUED' | 'MISSING_TIN_NOT_REQUIRED_REASON_NOT_REQUIRED' | 'MISSING_TIN_NOT_REQUIRED_REASON_OTHER';
5
+ export type PromptKey = TreatyClaimPrompt | 'activeNonFinancialEntityType' | 'addAdditionalResidence' | 'addControllingPerson' | 'address' | 'businessRegistrationNumber' | 'businessRegistrationCountry' | 'city' | 'cityOfBirth' | 'country' | 'countryOfBirth' | 'dateOfBirth' | 'day' | 'dbaName' | 'exemptPayeeCode' | 'exemptFatcaCode' | 'financialAccountIdentifier' | 'financialAccountName' | 'foreignAccountType' | 'financialInstitutionType' | 'foreignOtherClassification' | 'foreignTin' | 'foreignTinIsNotRequired' | 'foreignTrustClassification' | 'investmentEntityManaged' | 'isIndividual' | 'iAcknowledgeESignIsOk' | 'iWillResubmitIfIncorrect' | 'iAmACitizenOfTheUs' | 'iAmExemptFromFatcaReporting' | 'iAmNotSubjectToBackupWithholding' | 'iAuthorizeWithholdingAgent' | 'iCertifyToAll' | 'iConfirmIncomeIsNonUs' | 'iConfirmTheBeneficialOwnerIsExempt' | 'iConfirmTheInformationIsCorrectComplete' | 'iConfirmTheEntityIsNotAUsPerson' | 'iConfirmTheEntityIsTheBeneficialOwner' | 'iConfirmTheIndividualIsNotAUsPerson' | 'iConfirmTheIndividualIsTheBeneficialOwner' | 'iConfirmTheIndividualIsResidentOfTreatyCountry' | 'iConfirmTheTaxIdIsCorrect' | 'iHaveCapacityToSignForEntity' | 'iHaveCapacityToSignForIndividual' | 'iDeclareStatementsAreCorrect' | 'iUnderstandTheInformationIsCovered' | 'iAcknowledgeTheInformationMayBeProvided' | 'iCertifyIAmAccountHolder' | 'iCertifyIAmAuthorizedToSignForAccountHolder' | 'iCertifyIWillNotifyPersons' | 'iWillNotifyChangeInCircumstanceForIndividual' | 'iWillNotifyChangeInCircumstanceForAccountHolder' | 'mailingAddress' | 'mailingAddressIsDifferent' | 'month' | 'name' | 'nameOfDisregardedEntity' | 'nameOfEntity' | 'nameOfCCorporation' | 'nameOfCorporation' | 'nameOfIndividual' | 'nameOfIndividualSoleProprietor' | 'nameOfLlc' | 'nameOfOrganization' | 'nameOfPartnership' | 'nameOfSCorporation' | 'nameOfSmllc' | 'nameOfSmllcOwner' | 'nameOfSoleProprietor' | 'nameOfTrustEstate' | 'nameOfTrust' | 'otherRole' | 'otherEquivalentRole' | 'ownershipPercentage' | 'managedEntityType' | 'passiveEntityType' | 'province' | 'referenceNumbers' | 'regardedOwnerUsPerson' | 'regardedOwnerAccountType' | 'relatedCorporation' | 'removeResidence' | 'removeControllingPerson' | 'role' | 'securitiesMarket' | 'signature' | 'signatureCapacity' | 'signatureCapacityOther' | 'smllcElection' | 'smllcOwnerAccountType' | 'smllcOwnerUsPerson' | 'countyRegion' | 'stateProvince' | 'street' | 'street2' | 'taxIdNumber' | 'taxIdNumberIsNotRequired' | 'taxIdNumberIsNotRequiredReason' | 'taxIdNumberIsNotRequiredReasonOther' | 'tin' | 'tinUkCrn' | 'tinUkNino' | 'type' | 'usAccountType' | 'usLlcClassification' | 'usOtherClassification' | 'usPerson' | 'usEin' | 'usSoleProprietorEin' | 'usSsn' | 'usTin' | 'usTrustEstateEin' | 'vatIdentificationNumber' | 'vatIsNotRequired' | 'vatCountry' | 'year' | 'zip';
6
+ export type SubPromptKey = TreatyClaimSubPrompt | 'smllcElection' | 'iAmNotSubjectToBackupWithholding' | 'iConfirmIncomeIsNonUs' | 'isIndividual' | 'financialAccountIdentifier' | 'financialAccountName' | 'financialInstitutionType' | 'vatIdentificationNumber' | 'placeOfBirth' | 'referenceNumbers' | 'relatedCorporation' | 'role' | 'securitiesMarket' | 'signature' | 'signatureCapacityOther' | 'streetIsPermanent' | 'usPerson';
7
+ export type TitleKey = 'accountHolder' | 'accountHolderClassification' | 'accountHolderContactInformation' | 'accountHolderTaxInformation' | 'accountHolderTaxClarification' | 'accountHolderTreatyClaims' | 'address' | 'additionalConditions' | 'acknowledge' | 'carfClassificationDetails' | 'certify' | 'confirmation' | 'controllingPersonDetails' | 'controllingPersons' | 'controllingPerson1' | 'controllingPerson2' | 'controllingPerson3' | 'controllingPerson4' | 'controllingPerson5' | 'countryOfCitizenship' | 'countryOfIncorporation' | 'exemptions' | 'mailingAddress' | 'primaryAddress' | 'permanentAddress' | 'placeOfBirth' | 'regardedOwner' | 'regardedOwnerClassification' | 'regardedOwnerContactInformation' | 'regardedOwnerTaxInformation' | 'regardedOwnerTreatyClaims' | 'signature' | 'summary' | 'taxResidences' | 'taxResidence1' | 'taxResidence2' | 'taxResidence3' | 'taxResidence4' | 'taxResidence5' | 'w8imyInstructions';
8
+ export type SubTitleKey = 'controllingPersonDetails' | 'taxResidences' | 'permanentAddress' | 'taxInformationTreatyClaims';
9
9
  export type TextKey = 'eSignActReference' | 'notRequired' | 'notRequiredOrNotIssued' | 'interviewIsComplete' | 'penaltyOfPerjury' | 'penaltiesOfPerjury' | 'retrievingInterviewStatus' | 'taxDocumentationSaved' | 'w8imyInstructions';
10
10
  type TreatyClaimPrompt = 'treatyClaimIsEligible' | 'treatyClaimICertifyResident' | 'treatyClaimICertifyRequirements' | 'treatyClaimCountry' | 'treatyClaimTypeOfIncome' | 'treatyClaimWithholding' | 'treatyClaimAdditionalConditions' | 'treatyClaimLimitationOnBenefits' | 'treatyClaimLimitationOnBenefitsOtherArticleParagraph';
11
11
  type TreatyClaimSubPrompt = 'treatyClaimIsEligible' | 'treatyClaimWithholding' | 'treatyClaimAdditionalConditions' | 'treatyClaimLimitationOnBenefits';