@taxbit/react-sdk 1.1.0-beta.0 → 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 (136) hide show
  1. package/README.md +17 -4
  2. package/dist/src/components/ErrorBoundary/ErrorBoundary.d.ts +1 -1
  3. package/dist/src/components/Section/Section.d.ts +1 -1
  4. package/dist/src/contexts/QuestionnaireStep/getLocal.d.ts +5 -4
  5. package/dist/src/contexts/QuestionnaireStep/shiftControllingPerson.d.ts +3 -0
  6. package/dist/src/contexts/QuestionnaireStep/shiftResidence.d.ts +1 -1
  7. package/dist/src/contexts/QuestionnaireStep/useQuestionnaireStep.d.ts +3 -2
  8. package/dist/src/contexts/QuestionnaireStep/useQuestionnaireStepContext.d.ts +6 -4
  9. package/dist/src/contexts/TaxDocumentation/useTaxDocumentation.d.ts +5 -5
  10. package/dist/src/contexts/TaxDocumentation/useTaxDocumentationContext.d.ts +6 -6
  11. package/dist/src/hooks/useTaxbit/useTaxbit.d.ts +2 -2
  12. package/dist/src/hooks/useTaxbit/useTaxbitStatus.d.ts +2 -2
  13. package/dist/src/i18n/locales/de.d.ts +2 -2
  14. package/dist/src/i18n/locales/el.d.ts +2 -2
  15. package/dist/src/i18n/locales/ga.d.ts +1 -3
  16. package/dist/src/i18n/locales/lt.d.ts +2 -2
  17. package/dist/src/i18n/locales/pl.d.ts +2 -2
  18. package/dist/src/i18n/types/LocalizationKey.d.ts +6 -6
  19. package/dist/src/i18n/types/PropertyFile.d.ts +15 -14
  20. package/dist/src/index.d.ts +2 -2
  21. package/dist/src/lookups/activeNonFinancialEntityTypeOptions.d.ts +3 -0
  22. package/dist/src/lookups/controllingPersonRoleOptions.d.ts +3 -0
  23. package/dist/src/lookups/countryOptions.d.ts +0 -4
  24. package/dist/src/lookups/entityTypeOptions.d.ts +3 -0
  25. package/dist/src/lookups/financialInstitutionTypeOptions.d.ts +3 -0
  26. package/dist/src/lookups/getTreatyCountryLimitationOnBenefitOptions.d.ts +9 -0
  27. package/dist/src/lookups/index.d.ts +8 -0
  28. package/dist/src/lookups/payeeCodeOptions.d.ts +1 -1
  29. package/dist/src/lookups/selfCertificationAccountTypeOptions.d.ts +3 -0
  30. package/dist/src/lookups/signatureCapacityOptions.d.ts +3 -0
  31. package/dist/src/lookups/tinNotRequiredReasonOptions.d.ts +3 -0
  32. package/dist/src/lookups/typeOfIncomeOptions.d.ts +0 -2
  33. package/dist/src/services/api.d.ts +5 -2
  34. package/dist/src/services/msw.d.ts +33 -0
  35. package/dist/src/test/Wrapper.d.ts +2 -2
  36. package/dist/src/test/getWrapper.d.ts +2 -2
  37. package/dist/src/test/utils/helpers.d.ts +10 -0
  38. package/dist/src/types/InputStep.d.ts +1 -1
  39. package/dist/src/types/QuestionnaireProp.d.ts +1 -0
  40. package/dist/src/types/StepId.d.ts +1 -1
  41. package/dist/src/types/TaxDocumentation.d.ts +87 -50
  42. package/dist/src/types/client/ClientTaxDocumentationStatus.d.ts +4 -0
  43. package/dist/src/types/index.d.ts +1 -1
  44. package/dist/src/types/server/TaxDocumentationStatus.d.ts +4 -0
  45. package/dist/src/ui/InputValue/InputValue.d.ts +2 -1
  46. package/dist/src/ui/Select/Select.d.ts +0 -1
  47. package/dist/src/utils/getFieldsState.d.ts +7 -2
  48. package/dist/src/utils/getFormStatus.d.ts +2 -1
  49. package/dist/src/utils/getLanguage.d.ts +2 -2
  50. package/dist/src/utils/index.d.ts +1 -2
  51. package/dist/src/utils/promptKeyMapping/getAddressPromptKeyMap.d.ts +6 -0
  52. package/dist/src/utils/promptKeyMapping/getControllingPersonPromptKeyMap.d.ts +4 -0
  53. package/dist/src/utils/promptKeyMapping/getTaxResidencesPromptKeyMap.d.ts +6 -0
  54. package/dist/src/utils/transformForClient/transformForClient.d.ts +2 -2
  55. package/dist/src/utils/transformForClient/transformForClientAddress.d.ts +4 -32
  56. package/dist/src/utils/transformForClient/transformForClientTaxResidences.d.ts +11 -0
  57. package/dist/src/utils/transformForClient/transformForControllingPersons.d.ts +4 -0
  58. package/dist/src/utils/transformInbound/getActiveNonFinancialEntityType.d.ts +3 -0
  59. package/dist/src/utils/transformInbound/getCountryCode.d.ts +1 -0
  60. package/dist/src/utils/transformInbound/getEntityType.d.ts +3 -0
  61. package/dist/src/utils/transformInbound/getFinancialInstitutionType.d.ts +3 -0
  62. package/dist/src/utils/transformInbound/getForeignAccountType.d.ts +3 -2
  63. package/dist/src/utils/transformInbound/getSelfCertificationAccountType.d.ts +3 -0
  64. package/dist/src/utils/transformInbound/getUsAccountType.d.ts +3 -2
  65. package/dist/src/utils/transformInbound/transformInbound.d.ts +2 -2
  66. package/dist/src/utils/transformInbound/transformInboundAddress.d.ts +6 -0
  67. package/dist/src/utils/transformInbound/transformInboundControllingPersons.d.ts +440 -0
  68. package/dist/src/utils/transformInbound/transformInboundTaxResidencies.d.ts +7 -0
  69. package/dist/src/validations/getSteps.d.ts +2 -2
  70. package/dist/src/validations/index.d.ts +5 -5
  71. package/dist/src/validations/invalidFields/getInvalidAddressFields.d.ts +5 -0
  72. package/dist/src/validations/invalidFields/getInvalidControllingPersonsFields.d.ts +3 -0
  73. package/dist/src/validations/invalidFields/getInvalidFields.d.ts +5 -0
  74. package/dist/src/validations/invalidFields/getInvalidTaxResidencyFields.d.ts +5 -0
  75. package/dist/src/validations/{invalidFieldRules.d.ts → invalidFields/invalidFieldRules.d.ts} +1 -1
  76. package/dist/src/validations/requiredFields/getRequiredAddressFields.d.ts +7 -0
  77. package/dist/src/validations/requiredFields/getRequiredControllingPersonFields.d.ts +4 -0
  78. package/dist/src/validations/requiredFields/getRequiredFields.d.ts +4 -0
  79. package/dist/src/validations/requiredFields/getRequiredTaxResidenceFields.d.ts +7 -0
  80. package/dist/src/validations/supportedFields/__tests__/generateStrings.d.ts +5 -0
  81. package/dist/src/validations/supportedFields/getSupportedAddressFields.d.ts +8 -0
  82. package/dist/src/validations/supportedFields/getSupportedControllingPersonFields.d.ts +7 -0
  83. package/dist/src/validations/supportedFields/getSupportedFields.d.ts +4 -0
  84. package/dist/src/validations/supportedFields/getSupportedTaxResidenceFields.d.ts +8 -0
  85. package/dist/src/validations/supportedFields/getSupportedTreatyClaimFields.d.ts +3 -0
  86. package/dist/src/validations/visibleFields/getVisibleAddressFields.d.ts +5 -0
  87. package/dist/src/validations/visibleFields/getVisibleControllingPersonFields.d.ts +4 -0
  88. package/dist/src/validations/visibleFields/getVisibleFields.d.ts +4 -0
  89. package/dist/src/validations/visibleFields/getVisibleTaxResidenceFields.d.ts +9 -0
  90. package/dist/src/{entry → widgets}/TaxbitQuestionnaire/TaxbitQuestionnaire.d.ts +3 -3
  91. package/dist/src/widgets/TaxbitQuestionnairePersist/TaxbitQuestionnairePersist.d.ts +1 -1
  92. package/dist/src/widgets/TaxbitQuestionnairePersist/useTaxbitPersist.d.ts +2 -2
  93. package/dist/src/wizard/AddressInput/AddressInput.d.ts +1 -1
  94. package/dist/src/wizard/ControllingPersonInput/ControllingPersonInput.d.ts +11 -0
  95. package/dist/src/wizard/ControllingPersonInput/index.d.ts +1 -0
  96. package/dist/src/wizard/LanguageSelector/LanguageSelector.d.ts +2 -2
  97. package/dist/src/wizard/ResidenceInput/ResidenceInput.d.ts +2 -1
  98. package/dist/src/wizard/RowInput/AddressRow/AddressRow.d.ts +1 -1
  99. package/dist/src/wizard/RowInput/PercentInputRow/PercentInputRow.d.ts +9 -0
  100. package/dist/src/wizard/RowInput/PercentInputRow/index.d.ts +1 -0
  101. package/dist/src/wizard/RowInput/SelectRow/SelectRow.d.ts +2 -1
  102. package/dist/src/wizard/RowInput/index.d.ts +1 -0
  103. package/dist/src/wizard/TaxbitQuestionnaireUI/ControllingPersonDetails/ControllingPersonDetails.d.ts +7 -0
  104. package/dist/src/wizard/TaxbitQuestionnaireUI/ControllingPersonDetails/index.d.ts +1 -0
  105. package/dist/src/wizard/TaxbitQuestionnaireUI/Summary/AccountHolder/AccountHolderClassificationSummary.d.ts +3 -0
  106. package/dist/src/wizard/TaxbitQuestionnaireUI/Summary/AccountHolder/AccountHolderForeignClassificationSummary.d.ts +6 -0
  107. package/dist/src/wizard/TaxbitQuestionnaireUI/Summary/AccountHolder/AccountHolderSelfCertificationClassificationSummary.d.ts +6 -0
  108. package/dist/src/wizard/TaxbitQuestionnaireUI/Summary/AccountHolder/AccountHolderUsClassificationSummary.d.ts +6 -0
  109. package/dist/src/wizard/TaxbitQuestionnaireUI/Summary/ControllingPerson/ControllingPersonRoleInputValue.d.ts +7 -0
  110. package/dist/src/wizard/TaxbitQuestionnaireUI/Summary/ControllingPerson/ControllingPersonSummary.d.ts +7 -0
  111. package/dist/src/wizard/TaxbitQuestionnaireUI/Summary/ControllingPerson/ControllingPersonTypeSummary.d.ts +7 -0
  112. package/dist/src/wizard/TaxbitQuestionnaireUI/Summary/RegardedOwner/RegardedOwnerClassificationSummary.d.ts +3 -0
  113. package/dist/src/wizard/TaxbitQuestionnaireUI/Summary/RegardedOwner/RegardedOwnerForeignClassificationSummary.d.ts +6 -0
  114. package/dist/src/wizard/TaxbitQuestionnaireUI/Summary/RegardedOwner/RegardedOwnerUsClassificationSummary.d.ts +6 -0
  115. package/dist/src/wizard/TaxbitQuestionnaireUI/Summary/TaxResidency/TaxResidenciesSummary.d.ts +11 -0
  116. package/dist/src/wizard/TaxbitQuestionnaireUI/__tests__/TaxbitQuestionnaireUI.SelfCert.AccountClassification.test.d.ts +1 -0
  117. package/dist/src/wizard/TaxbitQuestionnaireUI/__tests__/TaxbitQuestionnaireUI.SelfCert.ControllingPerson.test.d.ts +1 -0
  118. package/dist/src/wizard/TaxbitQuestionnaireUI/__tests__/TaxbitQuestionnaireUI.SelfCert.NameAndAddress.test.d.ts +1 -0
  119. package/dist/src/wizard/TaxbitQuestionnaireUI/__tests__/TaxbitQuestionnaireUI.SelfCert.Summary.test.d.ts +1 -0
  120. package/dist/src/wizard/TaxbitQuestionnaireUI/__tests__/TaxbitQuestionnaireUI.SelfCert.TaxResidencies.test.d.ts +1 -0
  121. package/dist/src/wizard/TaxbitQuestionnaireUI/steps.d.ts +1 -0
  122. package/dist/taxbit-react-sdk.js +9568 -7323
  123. package/dist/taxbit-react-sdk.umd.cjs +1 -30
  124. package/package.json +12 -11
  125. package/style/basic.css +4 -0
  126. package/style/inline.css +1 -0
  127. package/dist/src/lookups/treatyCountries.json.d.ts +0 -2195
  128. package/dist/src/types/Questionnaire.d.ts +0 -1
  129. package/dist/src/utils/getTreatyCountry.d.ts +0 -38
  130. package/dist/src/utils/transformForClient/transformForClientTaxResidenceFields.d.ts +0 -7
  131. package/dist/src/validations/getInvalidFields.d.ts +0 -5
  132. package/dist/src/validations/getRequiredFields.d.ts +0 -4
  133. package/dist/src/validations/getSupportedFields.d.ts +0 -7
  134. package/dist/src/validations/getVisibleFields.d.ts +0 -4
  135. /package/dist/src/utils/{getPromptKeyMap.d.ts → promptKeyMapping/getPromptKeyMap.d.ts} +0 -0
  136. /package/dist/src/{entry → widgets}/TaxbitQuestionnaire/index.d.ts +0 -0
@@ -1 +0,0 @@
1
- export type Questionnaire = 'W-FORM' | 'DPS';
@@ -1,38 +0,0 @@
1
- import { LimitationOnBenefit } from '@taxbit/utilities';
2
-
3
- type TreatyWithholding = {
4
- rate: string;
5
- articleParagraph: string;
6
- additionalConditionsRequired: boolean;
7
- };
8
- type TreatyCountry = {
9
- businessProfits?: TreatyWithholding;
10
- royaltiesOther?: TreatyWithholding;
11
- services?: TreatyWithholding;
12
- additionalConditionsRequired?: boolean;
13
- limitationOnBenefits: {
14
- government: boolean;
15
- taxExemptPension: boolean;
16
- otherTaxExemptOrganization: boolean;
17
- publiclyTradedCorporation: boolean;
18
- subsidiary: boolean;
19
- companyMeetsErosionTest: boolean;
20
- companyMeetsDerivativeTest: boolean;
21
- companyMeetsBusinessTest: boolean;
22
- favorableDetermination: boolean;
23
- noLobArticle: boolean;
24
- otherArticleParagraphs: Array<string>;
25
- };
26
- };
27
- export declare const getTreatyCountry: (country?: string) => TreatyCountry;
28
- export declare const getTreatyCountryWithholding: (countryCode?: string, typeOfIncome?: string) => TreatyWithholding | undefined;
29
- export declare const getTreatyCountryWithholdingLabel: (countryCode?: string, typeOfIncome?: string) => string;
30
- export declare const getTreatyCountryLimitationOnBenefitsOptions: (country?: string) => Array<{
31
- value: LimitationOnBenefit;
32
- }>;
33
- export declare const getTreatyCountryLimitationOnBenefitsOtherArticleParagraphOptions: (country?: string) => {
34
- value: string;
35
- label: string;
36
- }[];
37
- export declare const isAdditionalConditionsRequired: (country?: string, typeOfIncome?: string) => boolean;
38
- export {};
@@ -1,7 +0,0 @@
1
- import { TaxDocumentation } from 'types';
2
-
3
- export declare const transformForClientAccountHolderTaxResidences: (data: TaxDocumentation) => {
4
- country?: string;
5
- tin?: string;
6
- tinNotRequired?: boolean;
7
- }[] | undefined;
@@ -1,5 +0,0 @@
1
- import { TaxDocumentationErrorFile } from '../contexts';
2
- import { Questionnaire, TaxDocumentation } from '../types';
3
- import { ExternalValidations } from '../types/client';
4
-
5
- export declare const getInvalidFields: (fields: TaxDocumentation, questionnaire: Questionnaire, externalValidations?: ExternalValidations) => TaxDocumentationErrorFile;
@@ -1,4 +0,0 @@
1
- import { TaxDocumentationPropertyFile } from '../contexts';
2
- import { Questionnaire, TaxDocumentation } from '../types';
3
-
4
- export declare const getRequiredFields: (fields: TaxDocumentation, questionnaire: Questionnaire) => TaxDocumentationPropertyFile;
@@ -1,7 +0,0 @@
1
- import { Questionnaire, TaxDocumentationKey } from 'types';
2
-
3
- type TaxDocumentationPropertyFile = {
4
- [key in TaxDocumentationKey]: boolean;
5
- };
6
- export declare const getSupportedFields: (questionnaire: Questionnaire, treatyClaims?: boolean) => TaxDocumentationPropertyFile;
7
- export {};
@@ -1,4 +0,0 @@
1
- import { Questionnaire, TaxDocumentation } from 'types';
2
- import { TaxDocumentationPropertyFile } from '../contexts';
3
-
4
- export declare const getVisibleFields: (fields: TaxDocumentation | undefined, questionnaire: Questionnaire, treatyClaims?: boolean) => TaxDocumentationPropertyFile;