@taxbit/react-sdk 1.2.0-beta.8 → 2.0.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 (96) hide show
  1. package/README.md +1 -1
  2. package/dist/src/contexts/QuestionnaireStep/useQuestionnaireStep.d.ts +1 -0
  3. package/dist/src/contexts/QuestionnaireStep/useQuestionnaireStepContext.d.ts +2 -0
  4. package/dist/src/contexts/TaxDocumentation/TaxbitQuestionnaireProvider.d.ts +1 -1
  5. package/dist/src/contexts/TaxDocumentation/useTaxDocumentation.d.ts +6 -3
  6. package/dist/src/contexts/TaxDocumentation/useTaxDocumentationContext.d.ts +6 -4
  7. package/dist/src/hooks/useTaxbit/types/w8.d.ts +0 -1
  8. package/dist/src/i18n/locales/bg.d.ts +4 -1
  9. package/dist/src/i18n/locales/cs.d.ts +3 -1
  10. package/dist/src/i18n/locales/da.d.ts +3 -1
  11. package/dist/src/i18n/locales/de-at.d.ts +3 -1
  12. package/dist/src/i18n/locales/de.d.ts +2 -3
  13. package/dist/src/i18n/locales/el-cy.d.ts +4 -3
  14. package/dist/src/i18n/locales/el.d.ts +2 -3
  15. package/dist/src/i18n/locales/en-gb.d.ts +2 -1
  16. package/dist/src/i18n/locales/en-nz.d.ts +2 -1
  17. package/dist/src/i18n/locales/en-us.d.ts +2 -1
  18. package/dist/src/i18n/locales/en.d.ts +2 -1
  19. package/dist/src/i18n/locales/es.d.ts +2 -1
  20. package/dist/src/i18n/locales/et.d.ts +3 -1
  21. package/dist/src/i18n/locales/fi.d.ts +3 -1
  22. package/dist/src/i18n/locales/fr-ca.d.ts +2 -1
  23. package/dist/src/i18n/locales/fr-lu.d.ts +3 -1
  24. package/dist/src/i18n/locales/fr.d.ts +2 -1
  25. package/dist/src/i18n/locales/ga.d.ts +3 -1
  26. package/dist/src/i18n/locales/hr.d.ts +3 -1
  27. package/dist/src/i18n/locales/hu.d.ts +3 -1
  28. package/dist/src/i18n/locales/it.d.ts +3 -1
  29. package/dist/src/i18n/locales/lt.d.ts +3 -2
  30. package/dist/src/i18n/locales/lv.d.ts +3 -1
  31. package/dist/src/i18n/locales/mt.d.ts +3 -1
  32. package/dist/src/i18n/locales/nl-be.d.ts +4 -3
  33. package/dist/src/i18n/locales/nl.d.ts +4 -1
  34. package/dist/src/i18n/locales/no.d.ts +3 -1
  35. package/dist/src/i18n/locales/pl.d.ts +2 -3
  36. package/dist/src/i18n/locales/pt.d.ts +3 -1
  37. package/dist/src/i18n/locales/ro.d.ts +3 -1
  38. package/dist/src/i18n/locales/sk.d.ts +3 -1
  39. package/dist/src/i18n/locales/sl.d.ts +3 -1
  40. package/dist/src/i18n/locales/sv.d.ts +3 -1
  41. package/dist/src/i18n/localizationFileMap.d.ts +2 -2
  42. package/dist/src/i18n/types/LocalizationKey.d.ts +5 -5
  43. package/dist/src/i18n/types/PropertyFile.d.ts +1 -1
  44. package/dist/src/i18n/utils/getText.d.ts +10 -10
  45. package/dist/src/lookups/accountHolderEntityAccountTypeOptions.d.ts +3 -0
  46. package/dist/src/lookups/accountOwnerTypeOptions.d.ts +3 -0
  47. package/dist/src/lookups/index.d.ts +4 -3
  48. package/dist/src/lookups/intermediaryAccountTypeOptions.d.ts +3 -0
  49. package/dist/src/lookups/regardedOwnerEntityAccountTypeOptions.d.ts +3 -0
  50. package/dist/src/test/utils/helpers.d.ts +5 -0
  51. package/dist/src/types/InputStep.d.ts +1 -1
  52. package/dist/src/types/StepId.d.ts +1 -1
  53. package/dist/src/types/TaxDocumentation.d.ts +56 -8
  54. package/dist/src/ui/DateOfBirthInput/__tests__/DateOfBirthInput.test.d.ts +1 -0
  55. package/dist/src/utils/getFieldsState.d.ts +13 -1
  56. package/dist/src/utils/getKeysByValue.d.ts +1 -0
  57. package/dist/src/utils/index.d.ts +0 -2
  58. package/dist/src/utils/transformForClient/transformCertifications.d.ts +22 -0
  59. package/dist/src/utils/transformInbound/getAccountOwnerType.d.ts +3 -0
  60. package/dist/src/utils/transformInbound/getEntityAccountType.d.ts +4 -0
  61. package/dist/src/utils/transformInbound/getIntermediaryAccountType.d.ts +3 -0
  62. package/dist/src/utils/transformInbound/index.d.ts +3 -3
  63. package/dist/src/utils/transformInbound/transformInboundControllingPersons.d.ts +50 -6
  64. package/dist/src/validations/getSteps.d.ts +1 -1
  65. package/dist/src/validations/supportedFields/__tests__/generateStrings.d.ts +3 -6
  66. package/dist/src/validations/utils.d.ts +3 -0
  67. package/dist/src/validations/visibleFields/__tests__/utils.d.ts +3 -0
  68. package/dist/src/widgets/TaxbitQuestionnaire/TaxbitQuestionnaire.d.ts +2 -1
  69. package/dist/src/widgets/TaxbitQuestionnairePersist/TaxbitQuestionnairePersist.d.ts +1 -1
  70. package/dist/src/wizard/TaxbitQuestionnaireUI/AccountHolderCertifications/AccountHolderCertifications.d.ts +3 -0
  71. package/dist/src/wizard/TaxbitQuestionnaireUI/AccountHolderCertifications/index.d.ts +1 -0
  72. package/dist/src/wizard/TaxbitQuestionnaireUI/RegardedOwnerCertifications/RegardedOwnerCertifications.d.ts +3 -0
  73. package/dist/src/wizard/TaxbitQuestionnaireUI/RegardedOwnerCertifications/index.d.ts +1 -0
  74. package/dist/src/wizard/TaxbitQuestionnaireUI/Summary/AccountHolder/AccountHolderForeignClassificationSummary.d.ts +3 -3
  75. package/dist/src/wizard/TaxbitQuestionnaireUI/Summary/RegardedOwner/RegardedOwnerForeignClassificationSummary.d.ts +3 -3
  76. package/dist/src/wizard/TaxbitQuestionnaireUI/TaxbitQuestionnaireUI.d.ts +1 -1
  77. package/dist/src/wizard/TaxbitQuestionnaireUI/__tests__/TaxbitQuestionnaireUI.DepthFirst.DPS.test.d.ts +1 -0
  78. package/dist/src/wizard/TaxbitQuestionnaireUI/__tests__/TaxbitQuestionnaireUI.DepthFirst.SelfCert.test.d.ts +1 -0
  79. package/dist/src/wizard/TaxbitQuestionnaireUI/__tests__/TaxbitQuestionnaireUI.DepthFirst.W8.test.d.ts +1 -0
  80. package/dist/src/wizard/TaxbitQuestionnaireUI/__tests__/TaxbitQuestionnaireUI.DepthFirst.W9.test.d.ts +1 -0
  81. package/dist/src/wizard/TaxbitQuestionnaireUI/steps.d.ts +2 -1
  82. package/dist/taxbit-react-sdk.js +5096 -3186
  83. package/dist/taxbit-react-sdk.umd.cjs +1 -1
  84. package/package.json +2 -2
  85. package/style/basic.css +2 -1
  86. package/style/inline.css +2 -1
  87. package/dist/src/lookups/foreignAccountHolderAccountTypeOptions.d.ts +0 -3
  88. package/dist/src/lookups/foreignOtherClassificationOptions.d.ts +0 -3
  89. package/dist/src/lookups/foreignTrustClassificationOptions.d.ts +0 -3
  90. package/dist/src/utils/camelCaseKeys.d.ts +0 -4
  91. package/dist/src/utils/snakeCaseKeys.d.ts +0 -1
  92. package/dist/src/utils/transformInbound/getForeignAccountType.d.ts +0 -4
  93. package/dist/src/utils/transformInbound/getForeignOtherClassification.d.ts +0 -3
  94. package/dist/src/utils/transformInbound/getForeignTrustClassification.d.ts +0 -3
  95. package/dist/src/wizard/TaxbitQuestionnaireUI/W8imyInstructions/W8imyInstructions.d.ts +0 -3
  96. package/dist/src/wizard/TaxbitQuestionnaireUI/W8imyInstructions/index.d.ts +0 -1
package/README.md CHANGED
@@ -32,7 +32,7 @@ const exampleData: ClientTaxDocumentation = {
32
32
  tin: '456456456',
33
33
  ftin: '667788991',
34
34
  usAccountType: 'INDIVIDUAL',
35
- foreignAccountType: 'INDIVIDUAL',
35
+ accountOwnerType: 'INDIVIDUAL',
36
36
  address: {
37
37
  firstLine: '123 Main St',
38
38
  secondLine: 'Unit #2',
@@ -40,4 +40,5 @@ export declare const useQuestionnaireStep: () => {
40
40
  requiredFields: TaxDocumentationPropertyFile;
41
41
  hideField: (key: TaxDocumentationKey) => void;
42
42
  showField: (key: TaxDocumentationKey) => void;
43
+ dateFormat: import('../TaxDocumentation/useTaxDocumentation').DateFormatConfig;
43
44
  };
@@ -30,6 +30,7 @@ export declare const useQuestionnaireStepContext: () => {
30
30
  requiredFields: import('./useQuestionnaireStep.ts').TaxDocumentationPropertyFile;
31
31
  hideField: (key: import('../../types/TaxDocumentation.ts').TaxDocumentationKey) => void;
32
32
  showField: (key: import('../../types/TaxDocumentation.ts').TaxDocumentationKey) => void;
33
+ dateFormat: import('../TaxDocumentation/useTaxDocumentation.ts').DateFormatConfig;
33
34
  }, QuestionnaireStepContextProvider: import('react').Provider<{
34
35
  getLocalText: (key: import('../../i18n/types/LocalizationKey.ts').TextKey) => string;
35
36
  getLocalTitle: (key: string) => string;
@@ -62,4 +63,5 @@ export declare const useQuestionnaireStepContext: () => {
62
63
  requiredFields: import('./useQuestionnaireStep.ts').TaxDocumentationPropertyFile;
63
64
  hideField: (key: import('../../types/TaxDocumentation.ts').TaxDocumentationKey) => void;
64
65
  showField: (key: import('../../types/TaxDocumentation.ts').TaxDocumentationKey) => void;
66
+ dateFormat: import('../TaxDocumentation/useTaxDocumentation.ts').DateFormatConfig;
65
67
  } | undefined>;
@@ -5,5 +5,5 @@ type TaxDocumentationProviderProps = UseTaxDocumentationProps & {
5
5
  children: React.ReactNode;
6
6
  treatyClaims?: boolean;
7
7
  };
8
- export declare const TaxbitQuestionnaireProvider: ({ data, externalValidations, onSubmit, onProgress, language, questionnaire, step, children, config, treatyClaims, }: TaxDocumentationProviderProps) => React.JSX.Element;
8
+ export declare const TaxbitQuestionnaireProvider: ({ data, externalValidations, onSubmit, onProgress, language, questionnaire, step, children, config, treatyClaims, dateFormat, }: TaxDocumentationProviderProps) => React.JSX.Element;
9
9
  export {};
@@ -5,6 +5,7 @@ import { ExternalValidations } from 'types/client';
5
5
  type InterviewConfig = {
6
6
  minimumAge: number;
7
7
  };
8
+ export type DateFormatConfig = 'dmy' | 'mdy' | 'ymd';
8
9
  export type UseTaxDocumentationProps = {
9
10
  data?: ClientTaxDocumentation;
10
11
  language?: Locale;
@@ -15,8 +16,9 @@ export type UseTaxDocumentationProps = {
15
16
  questionnaire: QuestionnaireProp;
16
17
  config?: InterviewConfig;
17
18
  treatyClaims?: boolean;
19
+ dateFormat?: DateFormatConfig;
18
20
  };
19
- export declare const useTaxDocumentation: ({ data: startingData, language: initialLanguage, externalValidations, onSubmit, onProgress, step: initialStep, questionnaire, config, treatyClaims, }: UseTaxDocumentationProps) => {
21
+ export declare const useTaxDocumentation: ({ data: startingData, language: initialLanguage, externalValidations, onSubmit, onProgress, step: initialStep, questionnaire, config, treatyClaims, dateFormat, }: UseTaxDocumentationProps) => {
20
22
  isBuildingW9: boolean;
21
23
  isBuildingW8: boolean;
22
24
  onPersistCollectedData: (newData: TaxDocumentation) => void;
@@ -25,10 +27,10 @@ export declare const useTaxDocumentation: ({ data: startingData, language: initi
25
27
  goBack: (() => void) | undefined;
26
28
  goToNext: (data: TaxDocumentation) => void;
27
29
  progress: Progress | undefined;
28
- stepName: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "AccountHolderTreatyClaims" | "ControllingPersonDetails1" | "ControllingPersonDetails2" | "ControllingPersonDetails3" | "ControllingPersonDetails4" | "ControllingPersonDetails5" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary" | "W8imyInstructions";
30
+ stepName: "AccountHolderCertifications" | "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "AccountHolderTreatyClaims" | "ControllingPersonDetails1" | "ControllingPersonDetails2" | "ControllingPersonDetails3" | "ControllingPersonDetails4" | "ControllingPersonDetails5" | "Exemptions" | "RegardedOwnerCertifications" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary";
29
31
  data: TaxDocumentation;
30
32
  originalClientData: TaxDocumentation;
31
- initialStep: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "AccountHolderTreatyClaims" | "ControllingPersonDetails1" | "ControllingPersonDetails2" | "ControllingPersonDetails3" | "ControllingPersonDetails4" | "ControllingPersonDetails5" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary" | "W8imyInstructions";
33
+ initialStep: "AccountHolderCertifications" | "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "AccountHolderTreatyClaims" | "ControllingPersonDetails1" | "ControllingPersonDetails2" | "ControllingPersonDetails3" | "ControllingPersonDetails4" | "ControllingPersonDetails5" | "Exemptions" | "RegardedOwnerCertifications" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary";
32
34
  setLanguage: (lang: Locale) => void;
33
35
  language: Locale;
34
36
  questionnaire: QuestionnaireProp;
@@ -36,5 +38,6 @@ export declare const useTaxDocumentation: ({ data: startingData, language: initi
36
38
  config: InterviewConfig | undefined;
37
39
  isSubmitting: boolean;
38
40
  treatyClaims: boolean | undefined;
41
+ dateFormat: DateFormatConfig;
39
42
  };
40
43
  export {};
@@ -7,10 +7,10 @@ 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" | "ControllingPersonDetails1" | "ControllingPersonDetails2" | "ControllingPersonDetails3" | "ControllingPersonDetails4" | "ControllingPersonDetails5" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary" | "W8imyInstructions";
10
+ stepName: "AccountHolderCertifications" | "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "AccountHolderTreatyClaims" | "ControllingPersonDetails1" | "ControllingPersonDetails2" | "ControllingPersonDetails3" | "ControllingPersonDetails4" | "ControllingPersonDetails5" | "Exemptions" | "RegardedOwnerCertifications" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary";
11
11
  data: import('../../types').TaxDocumentation;
12
12
  originalClientData: import('../../types').TaxDocumentation;
13
- initialStep: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "AccountHolderTreatyClaims" | "ControllingPersonDetails1" | "ControllingPersonDetails2" | "ControllingPersonDetails3" | "ControllingPersonDetails4" | "ControllingPersonDetails5" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary" | "W8imyInstructions";
13
+ initialStep: "AccountHolderCertifications" | "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "AccountHolderTreatyClaims" | "ControllingPersonDetails1" | "ControllingPersonDetails2" | "ControllingPersonDetails3" | "ControllingPersonDetails4" | "ControllingPersonDetails5" | "Exemptions" | "RegardedOwnerCertifications" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary";
14
14
  setLanguage: (lang: import('../..').Locale) => void;
15
15
  language: import('../..').Locale;
16
16
  questionnaire: import('../..').QuestionnaireProp;
@@ -20,6 +20,7 @@ export declare const useTaxDocumentationContext: () => {
20
20
  } | undefined;
21
21
  isSubmitting: boolean;
22
22
  treatyClaims: boolean | undefined;
23
+ dateFormat: import('./useTaxDocumentation').DateFormatConfig;
23
24
  }, TaxDocumentationContextProvider: import('react').Provider<{
24
25
  isBuildingW9: boolean;
25
26
  isBuildingW8: boolean;
@@ -29,10 +30,10 @@ export declare const useTaxDocumentationContext: () => {
29
30
  goBack: (() => void) | undefined;
30
31
  goToNext: (data: import('../../types').TaxDocumentation) => void;
31
32
  progress: import('../..').Progress | undefined;
32
- stepName: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "AccountHolderTreatyClaims" | "ControllingPersonDetails1" | "ControllingPersonDetails2" | "ControllingPersonDetails3" | "ControllingPersonDetails4" | "ControllingPersonDetails5" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary" | "W8imyInstructions";
33
+ stepName: "AccountHolderCertifications" | "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "AccountHolderTreatyClaims" | "ControllingPersonDetails1" | "ControllingPersonDetails2" | "ControllingPersonDetails3" | "ControllingPersonDetails4" | "ControllingPersonDetails5" | "Exemptions" | "RegardedOwnerCertifications" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary";
33
34
  data: import('../../types').TaxDocumentation;
34
35
  originalClientData: import('../../types').TaxDocumentation;
35
- initialStep: "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "AccountHolderTreatyClaims" | "ControllingPersonDetails1" | "ControllingPersonDetails2" | "ControllingPersonDetails3" | "ControllingPersonDetails4" | "ControllingPersonDetails5" | "Exemptions" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary" | "W8imyInstructions";
36
+ initialStep: "AccountHolderCertifications" | "AccountHolderClassification" | "AccountHolderContact" | "AccountHolderTax" | "AccountHolderTaxClarification" | "AccountHolderTreatyClaims" | "ControllingPersonDetails1" | "ControllingPersonDetails2" | "ControllingPersonDetails3" | "ControllingPersonDetails4" | "ControllingPersonDetails5" | "Exemptions" | "RegardedOwnerCertifications" | "RegardedOwnerContact" | "RegardedOwnerTax" | "RegardedOwnerTreatyClaims" | "Summary";
36
37
  setLanguage: (lang: import('../..').Locale) => void;
37
38
  language: import('../..').Locale;
38
39
  questionnaire: import('../..').QuestionnaireProp;
@@ -42,4 +43,5 @@ export declare const useTaxDocumentationContext: () => {
42
43
  } | undefined;
43
44
  isSubmitting: boolean;
44
45
  treatyClaims: boolean | undefined;
46
+ dateFormat: import('./useTaxDocumentation').DateFormatConfig;
45
47
  } | undefined>;
@@ -4,7 +4,6 @@ import { W9 } from './w9';
4
4
  export type W8 = {
5
5
  name?: string;
6
6
  country?: string;
7
- tax_classification?: 'INDIVIDUAL' | 'CORPORATION' | 'PARTNERSHIP' | 'SIMPLE_TRUST' | 'COMPLEX_TRUST' | 'GRANTOR_TRUST' | 'ESTATE' | 'CENTRAL_BANK_OF_ISSUE' | 'FOREIGN_GOVERNMENT_CONTROLLED_ENTITY' | 'FOREIGN_GOVERNMENT_INTEGRAL_PART' | 'TAX_EXEMPT_ORGANIZATION' | 'PRIVATE_FOUNDATION' | 'INTERNATIONAL_ORGANIZATION';
8
7
  permanent_address: {
9
8
  first_line?: string;
10
9
  city?: string;
@@ -1 +1,4 @@
1
- export declare const bg: import('../types/PropertyFile').PropertyFile;
1
+ import { TaxDocumentation } from '../../types';
2
+ import { PropertyFile } from '../types/PropertyFile';
3
+
4
+ export declare const bg: (data?: TaxDocumentation) => PropertyFile;
@@ -1 +1,3 @@
1
- export declare const cs: import('../types/PropertyFile').PropertyFile;
1
+ import { TaxDocumentation } from '../../types';
2
+
3
+ export declare const cs: (data?: TaxDocumentation) => import('../types/PropertyFile').PropertyFile;
@@ -1 +1,3 @@
1
- export declare const da: import('../types/PropertyFile').PropertyFile;
1
+ import { TaxDocumentation } from '../../types';
2
+
3
+ export declare const da: (data?: TaxDocumentation) => import('../types/PropertyFile').PropertyFile;
@@ -1 +1,3 @@
1
- export declare const deAt: import('../types/PropertyFile').PropertyFile;
1
+ import { TaxDocumentation } from '../../types';
2
+
3
+ export declare const deAt: (data?: TaxDocumentation) => import('../types/PropertyFile').PropertyFile;
@@ -1,4 +1,3 @@
1
- import { ForeignPropertyFile } from '../types/PropertyFile';
1
+ import { TaxDocumentation } from '../../types';
2
2
 
3
- export declare const deTranslations: ForeignPropertyFile;
4
- export declare const de: import('../types/PropertyFile').PropertyFile;
3
+ export declare const de: (data?: TaxDocumentation) => import('../types/PropertyFile').PropertyFile;
@@ -1,4 +1,5 @@
1
- import { PartialDPSPropertyFile } from '../types/PropertyFile';
1
+ import { TaxDocumentation } from '../../types';
2
+ import { PartialForeignPropertyFile } from '../types/PropertyFile';
2
3
 
3
- export declare const elCyTranslations: PartialDPSPropertyFile;
4
- export declare const elCy: import('../types/PropertyFile').PropertyFile;
4
+ export declare const elCyTranslations: (_data?: TaxDocumentation) => PartialForeignPropertyFile;
5
+ export declare const elCy: (data?: TaxDocumentation) => import('../types/PropertyFile').PropertyFile;
@@ -1,4 +1,3 @@
1
- import { ForeignPropertyFile } from '../types/PropertyFile';
1
+ import { TaxDocumentation } from '../../types';
2
2
 
3
- export declare const elTranslations: ForeignPropertyFile;
4
- export declare const el: import('../types/PropertyFile').PropertyFile;
3
+ export declare const el: (data?: TaxDocumentation) => import('../types/PropertyFile').PropertyFile;
@@ -1,3 +1,4 @@
1
+ import { TaxDocumentation } from '../../types';
1
2
  import { PropertyFile } from '../types/PropertyFile';
2
3
 
3
- export declare const enGb: PropertyFile;
4
+ export declare const enGb: (data?: TaxDocumentation) => PropertyFile;
@@ -1,3 +1,4 @@
1
+ import { TaxDocumentation } from '../../types';
1
2
  import { PropertyFile } from '../types/PropertyFile';
2
3
 
3
- export declare const enNz: PropertyFile;
4
+ export declare const enNz: (data?: TaxDocumentation) => PropertyFile;
@@ -1,3 +1,4 @@
1
+ import { TaxDocumentation } from '../../types';
1
2
  import { PropertyFile } from '../types/PropertyFile';
2
3
 
3
- export declare const enUs: PropertyFile;
4
+ export declare const enUs: (data?: TaxDocumentation) => PropertyFile;
@@ -1,3 +1,4 @@
1
+ import { TaxDocumentation } from '../../types';
1
2
  import { PropertyFile } from '../types/PropertyFile';
2
3
 
3
- export declare const en: PropertyFile;
4
+ export declare const en: (_data?: TaxDocumentation) => PropertyFile;
@@ -1,3 +1,4 @@
1
+ import { TaxDocumentation } from '../../types';
1
2
  import { PropertyFile } from '../types/PropertyFile';
2
3
 
3
- export declare const es: PropertyFile;
4
+ export declare const es: (_data?: TaxDocumentation) => PropertyFile;
@@ -1 +1,3 @@
1
- export declare const et: import('../types/PropertyFile').PropertyFile;
1
+ import { TaxDocumentation } from '../../types';
2
+
3
+ export declare const et: (data?: TaxDocumentation) => import('../types/PropertyFile').PropertyFile;
@@ -1 +1,3 @@
1
- export declare const fi: import('../types/PropertyFile').PropertyFile;
1
+ import { TaxDocumentation } from '../../types';
2
+
3
+ export declare const fi: (data?: TaxDocumentation) => import('../types/PropertyFile').PropertyFile;
@@ -1,3 +1,4 @@
1
+ import { TaxDocumentation } from '../../types';
1
2
  import { PropertyFile } from '../types/PropertyFile';
2
3
 
3
- export declare const frCa: PropertyFile;
4
+ export declare const frCa: (data?: TaxDocumentation) => PropertyFile;
@@ -1 +1,3 @@
1
- export declare const frLu: import('../types/PropertyFile').PropertyFile;
1
+ import { TaxDocumentation } from '../../types';
2
+
3
+ export declare const frLu: (data?: TaxDocumentation) => import('../types/PropertyFile').PropertyFile;
@@ -1,3 +1,4 @@
1
+ import { TaxDocumentation } from '../../types';
1
2
  import { PropertyFile } from '../types/PropertyFile';
2
3
 
3
- export declare const fr: PropertyFile;
4
+ export declare const fr: (_data?: TaxDocumentation) => PropertyFile;
@@ -1 +1,3 @@
1
- export declare const ga: import('../types/PropertyFile').PropertyFile;
1
+ import { TaxDocumentation } from '../../types';
2
+
3
+ export declare const ga: (data?: TaxDocumentation) => import('../types/PropertyFile').PropertyFile;
@@ -1 +1,3 @@
1
- export declare const hr: import('../types/PropertyFile').PropertyFile;
1
+ import { TaxDocumentation } from '../../types';
2
+
3
+ export declare const hr: (data?: TaxDocumentation) => import('../types/PropertyFile').PropertyFile;
@@ -1 +1,3 @@
1
- export declare const hu: import('../types/PropertyFile').PropertyFile;
1
+ import { TaxDocumentation } from '../../types';
2
+
3
+ export declare const hu: (data?: TaxDocumentation) => import('../types/PropertyFile').PropertyFile;
@@ -1 +1,3 @@
1
- export declare const it: import('../types/PropertyFile').PropertyFile;
1
+ import { TaxDocumentation } from '../../types';
2
+
3
+ export declare const it: (data?: TaxDocumentation) => import('../types/PropertyFile').PropertyFile;
@@ -1,4 +1,5 @@
1
+ import { TaxDocumentation } from '../../types';
1
2
  import { ForeignPropertyFile } from '../types/PropertyFile';
2
3
 
3
- export declare const ltTranslations: ForeignPropertyFile;
4
- export declare const lt: import('../types/PropertyFile').PropertyFile;
4
+ export declare const ltTranslations: (_data?: TaxDocumentation) => ForeignPropertyFile;
5
+ export declare const lt: (data?: TaxDocumentation) => import('../types/PropertyFile').PropertyFile;
@@ -1 +1,3 @@
1
- export declare const lv: import('../types/PropertyFile').PropertyFile;
1
+ import { TaxDocumentation } from '../../types';
2
+
3
+ export declare const lv: (data?: TaxDocumentation) => import('../types/PropertyFile').PropertyFile;
@@ -1 +1,3 @@
1
- export declare const mt: import('../types/PropertyFile').PropertyFile;
1
+ import { TaxDocumentation } from '../../types';
2
+
3
+ export declare const mt: (data?: TaxDocumentation) => import('../types/PropertyFile').PropertyFile;
@@ -1,4 +1,5 @@
1
- import { PartialDPSPropertyFile } from '../types/PropertyFile';
1
+ import { TaxDocumentation } from '../../types';
2
+ import { PartialForeignPropertyFile } from '../types/PropertyFile';
2
3
 
3
- export declare const nlBeTranslations: PartialDPSPropertyFile;
4
- export declare const nlBe: import('../types/PropertyFile').PropertyFile;
4
+ export declare const nlBeTranslations: (_data?: TaxDocumentation) => PartialForeignPropertyFile;
5
+ export declare const nlBe: (data?: TaxDocumentation) => import('../types/PropertyFile').PropertyFile;
@@ -1 +1,4 @@
1
- export declare const nl: import('../types/PropertyFile').PropertyFile;
1
+ import { TaxDocumentation } from '../../types';
2
+ import { PropertyFile } from '../types/PropertyFile';
3
+
4
+ export declare const nl: (data?: TaxDocumentation) => PropertyFile;
@@ -1 +1,3 @@
1
- export declare const no: import('../types/PropertyFile').PropertyFile;
1
+ import { TaxDocumentation } from '../../types';
2
+
3
+ export declare const no: (data?: TaxDocumentation) => import('../types/PropertyFile').PropertyFile;
@@ -1,4 +1,3 @@
1
- import { ForeignPropertyFile } from '../types/PropertyFile';
1
+ import { TaxDocumentation } from '../../types';
2
2
 
3
- export declare const plTranslations: ForeignPropertyFile;
4
- export declare const pl: import('../types/PropertyFile').PropertyFile;
3
+ export declare const pl: (data?: TaxDocumentation) => import('../types/PropertyFile').PropertyFile;
@@ -1 +1,3 @@
1
- export declare const pt: import('../types/PropertyFile').PropertyFile;
1
+ import { TaxDocumentation } from '../../types';
2
+
3
+ export declare const pt: (data?: TaxDocumentation) => import('../types/PropertyFile').PropertyFile;
@@ -1 +1,3 @@
1
- export declare const ro: import('../types/PropertyFile').PropertyFile;
1
+ import { TaxDocumentation } from '../../types';
2
+
3
+ export declare const ro: (data?: TaxDocumentation) => import('../types/PropertyFile').PropertyFile;
@@ -1 +1,3 @@
1
- export declare const sk: import('../types/PropertyFile').PropertyFile;
1
+ import { TaxDocumentation } from '../../types';
2
+
3
+ export declare const sk: (data?: TaxDocumentation) => import('../types/PropertyFile').PropertyFile;
@@ -1 +1,3 @@
1
- export declare const sl: import('../types/PropertyFile').PropertyFile;
1
+ import { TaxDocumentation } from '../../types';
2
+
3
+ export declare const sl: (data?: TaxDocumentation) => import('../types/PropertyFile').PropertyFile;
@@ -1 +1,3 @@
1
- export declare const sv: import('../types/PropertyFile').PropertyFile;
1
+ import { TaxDocumentation } from '../../types';
2
+
3
+ export declare const sv: (data?: TaxDocumentation) => import('../types/PropertyFile').PropertyFile;
@@ -1,8 +1,8 @@
1
- import { Locale } from 'types';
1
+ import { Locale, TaxDocumentation } from 'types';
2
2
  import { PropertyFile } from './types/PropertyFile';
3
3
 
4
4
  type LocalizationFile = {
5
- [locale in Locale]: PropertyFile;
5
+ [locale in Locale]: (data?: TaxDocumentation) => PropertyFile;
6
6
  };
7
7
  export declare const localizationFileMap: LocalizationFile;
8
8
  export {};
@@ -1,10 +1,10 @@
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' | 'accountHolderActiveNonFinancialEntityType_OTHER' | 'accountHolderActiveNonFinancialEntityType_PUBLIC_CORPORATION' | 'accountHolderSelfCertificationAccountType_FINANCIAL_INSTITUTION' | 'accountHolderSelfCertificationAccountType_ACTIVE_NON_FINANCIAL_ENTITY' | 'accountHolderSelfCertificationAccountType_PASSIVE_NON_FINANCIAL_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' | 'investmentEntityManaged_yes' | 'investmentEntityManaged_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';
3
+ export type SubOptionKey = 'accountHolderUsAccountType_SOLE_PROPRIETOR' | 'accountHolderUsAccountType_SM_LLC' | 'accountHolderUsAccountType_DISREGARDED_ENTITY' | 'accountHolderActiveNonFinancialEntityType_OTHER' | 'accountHolderActiveNonFinancialEntityType_PUBLIC_CORPORATION' | 'accountHolderSelfCertificationAccountType_FINANCIAL_INSTITUTION' | 'accountHolderSelfCertificationAccountType_ACTIVE_NON_FINANCIAL_ENTITY' | 'accountHolderSelfCertificationAccountType_PASSIVE_NON_FINANCIAL_ENTITY' | 'accountHolderAccountOwnerType_ENTITY' | 'accountHolderAccountOwnerType_INTERMEDIARY' | 'regardedOwnerAccountOwnerType_ENTITY' | 'regardedOwnerAccountOwnerType_INTERMEDIARY';
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' | 'investmentEntityManaged_yes' | 'investmentEntityManaged_no' | 'assumesChapters3And4Responsibility_yes' | 'assumesChapters3And4Responsibility_no' | 'assumes1099Responsibility_yes' | 'assumes1099Responsibility_no' | 'usPersonElection_yes' | 'usPersonElection_no' | 'providesAdditionalDocumentation_yes' | 'providesAdditionalDocumentation_no' | 'no' | 'yes' | 'no_not_applicable' | 'ACTIVE_NON_FINANCIAL_ENTITY' | 'CENTRAL_BANK_OF_ISSUE' | 'COMPLEX_TRUST' | 'CORPORATION' | 'CUSTODIAL_INSTITUTION' | 'C_CORPORATION' | 'DEPOSITORY_INSTITUTION' | 'DISREGARDED_ENTITY' | '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' | 'INTERMEDIARY' | 'QUALIFIED_INTERMEDIARY' | 'NONQUALIFIED_INTERMEDIARY' | 'TERRITORY_FINANCIAL_INSTITUTION' | 'US_BRANCH' | 'WITHHOLDING_FOREIGN_PARTNERSHIP' | 'WITHHOLDING_FOREIGN_TRUST' | 'NONWITHHOLDING_FOREIGN_PARTNERSHIP' | 'NONWITHHOLDING_FOREIGN_SIMPLE_TRUST' | 'NONWITHHOLDING_FOREIGN_GRANTOR_TRUST' | '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 | 'accountHolderAccountOwnerType' | 'accountHolderIntermediaryAccountType' | 'accountHolderEntityAccountType' | 'activeNonFinancialEntityType' | 'addAdditionalResidence' | 'addControllingPerson' | 'address' | 'businessRegistrationNumber' | 'businessRegistrationCountry' | 'city' | 'cityOfBirth' | 'country' | 'countryOfBirth' | 'dateOfBirth' | 'day' | 'dbaName' | 'exemptPayeeCode' | 'exemptFatcaCode' | 'financialAccountIdentifier' | 'financialAccountName' | 'foreignAccountType' | 'financialInstitutionType' | 'foreignTin' | 'foreignTinIsNotRequired' | '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' | 'nameOfComplexTrust' | 'nameOfTaxExemptOrganization' | 'nameOfPrivateFoundation' | 'nameOfInternationalOrganization' | 'nameOfCentralBankOfIssue' | 'nameOfForeignGovernmentControlledEntity' | 'nameOfForeignGovernmentIntegralPart' | 'nameOfEstate' | 'nameOfQualifiedIntermediary' | 'nameOfNonqualifiedIntermediary' | 'nameOfTerritoryFinancialInstitution' | 'nameOfUsBranch' | 'nameOfWithholdingForeignPartnership' | 'nameOfWithholdingForeignTrust' | 'nameOfNonwithholdingForeignPartnership' | 'nameOfNonwithholdingForeignSimpleTrust' | 'nameOfNonwithholdingForeignGrantorTrust' | 'otherRole' | 'otherEquivalentRole' | 'ownershipPercentage' | 'managedEntityType' | 'passiveEntityType' | 'province' | 'referenceNumbers' | 'regardedOwnerUsPerson' | 'regardedOwnerAccountType' | 'regardedOwnerEntityAccountType' | 'regardedOwnerIntermediaryAccountType' | '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' | 'isQiCertified' | 'assumesChapters3And4Responsibility' | 'assumes1099Responsibility' | 'usPersonElection' | 'providesAdditionalDocumentation' | 'assumesChapters3And4ResponsibilityCertified' | 'assumes1099ResponsibilityCertified' | 'notAssume1099ResponsibilityCertified' | 'meetsQiRegulationsRequirementsCertified' | 'obtainsDocumentationCertified' | 'notActingAsQiCertified' | 'transmitsNqiDocumentationCertified' | 'representsWithholdingStatementsCertified' | 'isFinancialInstitutionCertified' | 'tfiUsPersonElectionCertified' | 'transmitsTfiDocumentationCertified' | 'usbPaymentsCertified' | 'usbUsPersonElectionCertified' | 'transmitsUsbDocumentationCertified' | 'isCompliantCertified' | 'entityPaymentsCertified' | 'providesWithholdingStatementCertified';
6
+ export type SubPromptKey = TreatyClaimSubPrompt | 'isQiCertified' | 'smllcElection' | 'iAmNotSubjectToBackupWithholding' | 'iConfirmIncomeIsNonUs' | 'isIndividual' | 'transmitsTfiDocumentationCertified' | 'transmitsUsbDocumentationCertified' | 'entityPaymentsCertified' | 'financialAccountIdentifier' | 'financialAccountName' | 'financialInstitutionType' | 'vatIdentificationNumber' | 'placeOfBirth' | 'referenceNumbers' | 'relatedCorporation' | 'role' | 'securitiesMarket' | 'signature' | 'signatureCapacityOther' | 'streetIsPermanent' | 'usPerson';
7
+ export type TitleKey = 'accountHolder' | 'accountHolderCertifications' | 'accountHolderClassification' | 'accountHolderContactInformation' | 'accountHolderTaxInformation' | 'accountHolderTaxClarification' | 'accountHolderTreatyClaims' | 'accountTypeCertifications' | 'address' | 'additionalConditions' | 'acknowledge' | 'carfClassificationDetails' | 'certificationStatements' | 'certify' | 'confirmation' | 'controllingPersonDetails' | 'controllingPersons' | 'controllingPerson1' | 'controllingPerson2' | 'controllingPerson3' | 'controllingPerson4' | 'controllingPerson5' | 'countryOfCitizenship' | 'countryOfIncorporation' | 'exemptions' | 'mailingAddress' | 'primaryAddress' | 'permanentAddress' | 'placeOfBirth' | 'regardedOwner' | 'regardedOwnerCertifications' | 'regardedOwnerClassification' | 'regardedOwnerContactInformation' | 'regardedOwnerTaxInformation' | 'regardedOwnerTreatyClaims' | 'signature' | 'summary' | 'taxResidences' | 'taxResidence1' | 'taxResidence2' | 'taxResidence3' | 'taxResidence4' | 'taxResidence5' | 'w8imyInstructions';
8
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';
@@ -40,7 +40,7 @@ export type ForeignPropertyFile = {
40
40
  option: Pick<PropertyFile['option'], 'no' | 'yes' | 'isIndividual_yes' | 'isIndividual_no' | 'investmentEntityManaged_yes' | 'investmentEntityManaged_no' | 'ACTIVE_NON_FINANCIAL_ENTITY' | 'PASSIVE_NON_FINANCIAL_ENTITY' | 'CUSTODIAL_INSTITUTION' | 'accountHolderActiveNonFinancialEntityType_GOVERNMENT_ENTITY' | 'INSURANCE_COMPANY' | 'INVESTMENT_ENTITY' | 'ENTITY_TYPE_TRUST' | 'ENTITY_TYPE_SIMILAR_TO_TRUST' | 'ENTITY_TYPE_OTHER' | 'accountHolderActiveNonFinancialEntityType_PUBLIC_CORPORATION' | 'accountHolderActiveNonFinancialEntityType_OTHER' | 'accountHolderActiveNonFinancialEntityType_INTERNATIONAL_ORGANIZATION' | 'SIGNATURE_CAPACITY_EXECUTOR' | 'SIGNATURE_CAPACITY_OFFICER' | 'SIGNATURE_CAPACITY_OTHER_CAPACITY' | 'DEPOSITORY_INSTITUTION' | 'FINANCIAL_INSTITUTION' | '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'>;
41
41
  subOption: Pick<PropertyFile['subOption'], 'accountHolderActiveNonFinancialEntityType_PUBLIC_CORPORATION' | 'accountHolderActiveNonFinancialEntityType_OTHER' | 'accountHolderSelfCertificationAccountType_FINANCIAL_INSTITUTION' | 'accountHolderSelfCertificationAccountType_ACTIVE_NON_FINANCIAL_ENTITY' | 'accountHolderSelfCertificationAccountType_PASSIVE_NON_FINANCIAL_ENTITY'>;
42
42
  };
43
- export type PartialDPSPropertyFile = {
43
+ export type PartialForeignPropertyFile = {
44
44
  button?: Partial<ForeignPropertyFile['button']>;
45
45
  prompt?: Partial<ForeignPropertyFile['prompt']>;
46
46
  subPrompt?: Partial<ForeignPropertyFile['subPrompt']>;
@@ -1,12 +1,12 @@
1
- import { Locale } from '../../types';
1
+ import { Locale, TaxDocumentation } from '../../types';
2
2
  import { ButtonKey, ErrorKey, OptionKey, PromptKey, SubOptionKey, SubPromptKey, SubTitleKey, TextKey } from '../types';
3
3
 
4
- export declare const getPromptText: (key: PromptKey, locale: Locale | undefined) => string;
5
- export declare const getSubPromptText: (key: SubPromptKey, locale: Locale | undefined) => string;
6
- export declare const getErrorText: (key: ErrorKey, locale: Locale | undefined) => string;
7
- export declare const getTextText: (key: TextKey, locale: Locale | undefined) => string;
8
- export declare const getTitleText: (key: string, locale: Locale | undefined) => string;
9
- export declare const getSubTitleText: (key: SubTitleKey, locale: Locale | undefined) => string;
10
- export declare const getButtonText: (key: ButtonKey, locale: Locale | undefined) => string;
11
- export declare const getOptionText: (key: OptionKey | undefined, locale: Locale | undefined) => string;
12
- export declare const getSubOptionText: (key: SubOptionKey | undefined, locale: Locale | undefined) => string | undefined;
4
+ export declare const getPromptText: (key: PromptKey, data: TaxDocumentation, locale: Locale | undefined) => string;
5
+ export declare const getSubPromptText: (key: SubPromptKey, data: TaxDocumentation, locale: Locale | undefined) => string;
6
+ export declare const getErrorText: (key: ErrorKey, data: TaxDocumentation, locale: Locale | undefined) => string;
7
+ export declare const getTextText: (key: TextKey, data: TaxDocumentation, locale: Locale | undefined) => string;
8
+ export declare const getTitleText: (key: string, data: TaxDocumentation, locale: Locale | undefined) => string;
9
+ export declare const getSubTitleText: (key: SubTitleKey, data: TaxDocumentation, locale: Locale | undefined) => string;
10
+ export declare const getButtonText: (key: ButtonKey, data: TaxDocumentation, locale: Locale | undefined) => string;
11
+ export declare const getOptionText: (key: OptionKey | undefined, data: TaxDocumentation, locale: Locale | undefined) => string;
12
+ export declare const getSubOptionText: (key: SubOptionKey | undefined, data: TaxDocumentation, locale: Locale | undefined) => string | undefined;
@@ -0,0 +1,3 @@
1
+ export declare const accountHolderEntityAccountTypeOptions: {
2
+ value: T;
3
+ }[];
@@ -0,0 +1,3 @@
1
+ export declare const accountOwnerTypeOptions: {
2
+ value: T;
3
+ }[];
@@ -1,3 +1,5 @@
1
+ export * from './accountHolderEntityAccountTypeOptions';
2
+ export * from './accountOwnerTypeOptions';
1
3
  export * from './activeNonFinancialEntityTypeOptions';
2
4
  export * from './controllingPersonRoleOptions';
3
5
  export * from './countryOptions';
@@ -5,13 +7,12 @@ export * from './dayOptions';
5
7
  export * from './entityTypeOptions.ts';
6
8
  export * from './fatcaCodeOptions';
7
9
  export * from './financialInstitutionTypeOptions';
8
- export * from './foreignAccountHolderAccountTypeOptions';
9
- export * from './foreignOtherClassificationOptions';
10
10
  export * from './foreignRegardedOwnerAccountTypeOptions';
11
- export * from './foreignTrustClassificationOptions';
12
11
  export * from './getTreatyCountryLimitationOnBenefitOptions';
12
+ export * from './intermediaryAccountTypeOptions';
13
13
  export * from './localeOptions';
14
14
  export * from './payeeCodeOptions';
15
+ export * from './regardedOwnerEntityAccountTypeOptions';
15
16
  export * from './selfCertificationAccountTypeOptions';
16
17
  export * from './signatureCapacityOptions';
17
18
  export * from './tinNotRequiredReasonOptions';
@@ -0,0 +1,3 @@
1
+ export declare const intermediaryAccountTypeOptions: {
2
+ value: T;
3
+ }[];
@@ -0,0 +1,3 @@
1
+ export declare const regardedOwnerEntityAccountTypeOptions: {
2
+ value: T;
3
+ }[];
@@ -26,8 +26,13 @@ export declare const clickRemoveResidence: (index: 1 | 2 | 3 | 4 | 5) => void;
26
26
  export declare const clickAddControllingPerson: () => void;
27
27
  export declare const clickRemoveControllingPerson: (index: 1 | 2 | 3 | 4 | 5) => void;
28
28
  export declare const setBusinessNameAndAddress: (prefix?: string) => void;
29
+ export declare const setAddress: (prefix: string, location: "US" | "AT") => void;
29
30
  export declare const setIndividualNameAndAddress: (prefix?: string) => void;
30
31
  export declare const setUSIndividualNameAndAddress: (prefix?: string) => void;
31
32
  export declare const setIndividualNameAndAddressAndBirthDate: (prefix?: string) => void;
32
33
  export declare const setUSIndividualNameAndAddressAndBirthDate: (prefix?: string) => void;
33
34
  export declare const setIndividualCountryNameAndAddressAndBirthDate: (prefix?: string) => void;
35
+ export declare const setBirthDateAndCitizenship: (prefix?: string) => void;
36
+ export declare const setBirthDate: (prefix?: string) => void;
37
+ export declare const setControllingPersonDetails: (prefix: string) => void;
38
+ export declare const expectNoErrors: () => void;
@@ -1,4 +1,4 @@
1
- declare const inputSteps: readonly ["AccountHolderClassification", "AccountHolderContact", "AccountHolderTax", "AccountHolderTaxClarification", "AccountHolderTreatyClaims", "ControllingPersonDetails1", "ControllingPersonDetails2", "ControllingPersonDetails3", "ControllingPersonDetails4", "ControllingPersonDetails5", "Exemptions", "RegardedOwnerContact", "RegardedOwnerTax", "RegardedOwnerTreatyClaims", "Summary", "W8imyInstructions"];
1
+ declare const inputSteps: readonly ["AccountHolderCertifications", "AccountHolderClassification", "AccountHolderContact", "AccountHolderTax", "AccountHolderTaxClarification", "AccountHolderTreatyClaims", "ControllingPersonDetails1", "ControllingPersonDetails2", "ControllingPersonDetails3", "ControllingPersonDetails4", "ControllingPersonDetails5", "Exemptions", "RegardedOwnerCertifications", "RegardedOwnerContact", "RegardedOwnerTax", "RegardedOwnerTreatyClaims", "Summary"];
2
2
  export type InputStep = (typeof inputSteps)[number];
3
3
  export declare const isInputStep: (step: string) => step is InputStep;
4
4
  export declare const confirmInputStep: (step: string) => InputStep;
@@ -1 +1 @@
1
- export type StepId = 'accountHolderContactInformation' | 'accountHolderTaxInformation' | 'accountHolderClassification' | 'accountHolderTaxClarification' | 'accountHolderTreatyClaims' | 'confirmation' | 'controllingPersonDetails1' | 'controllingPersonDetails2' | 'controllingPersonDetails3' | 'controllingPersonDetails4' | 'controllingPersonDetails5' | 'exemptions' | 'regardedOwnerContactInformation' | 'regardedOwnerTaxInformation' | 'regardedOwnerTreatyClaims' | 'summary' | 'w8imyInstructions';
1
+ export type StepId = 'accountHolderCertifications' | 'accountHolderContactInformation' | 'accountHolderTaxInformation' | 'accountHolderClassification' | 'accountHolderTaxClarification' | 'accountHolderTreatyClaims' | 'confirmation' | 'controllingPersonDetails1' | 'controllingPersonDetails2' | 'controllingPersonDetails3' | 'controllingPersonDetails4' | 'controllingPersonDetails5' | 'exemptions' | 'regardedOwnerCertifications' | 'regardedOwnerContactInformation' | 'regardedOwnerTaxInformation' | 'regardedOwnerTreatyClaims' | 'summary' | 'w8imyInstructions';