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

package/dist/src/i18n/types/PropertyFile.d.ts

@@ -1,5 +1,4 @@
 import { ButtonKey, ErrorKey, OptionKey, PromptKey, SubOptionKey, SubPromptKey, SubTitleKey, TextKey, TitleKey } from './LocalizationKey';
-
 export type PropertyFile = {
     button: {
         [key in ButtonKey]: string;
@@ -29,23 +28,24 @@ export type PropertyFile = {
         [key in TextKey]: string;
     };
 };
-export type DPSPropertyFile = {
+export type ForeignPropertyFile = {
     button: PropertyFile['button'];
-    prompt: Pick<PropertyFile['prompt'], 'addAdditional' | 'address' | 'businessRegistrationCountry' | 'businessRegistrationNumber' | 'city' | 'cityOfBirth' | 'country' | 'countryOfBirth' | 'dateOfBirth' | 'day' | 'financialAccountIdentifier' | 'financialAccountName' | 'iConfirmTheInformationIsCorrectComplete' | 'isIndividual' | 'month' | 'name' | 'nameOfEntity' | 'nameOfIndividual' | 'province' | 'removeResidence' | 'state' | 'stateProvince' | 'street' | 'street2' | 'taxIdNumber' | 'taxIdNumberIsNotRequired' | 'tin' | 'tinUkCrn' | 'tinUkNino' | 'usTin' | 'vatCountry' | 'vatIdentificationNumber' | 'vatIsNotRequired' | 'year' | 'zip'>;
-    subPrompt: Pick<PropertyFile['subPrompt'], 'financialAccountIdentifier' | 'financialAccountName' | 'isIndividual' | 'placeOfBirth' | 'streetIsPermanent' | 'vatIdentificationNumber'>;
-    subTitle: Pick<PropertyFile['subTitle'], 'taxResidences'>;
-    title: Pick<PropertyFile['title'], 'accountHolder' | 'accountHolderClassification' | 'accountHolderContactInformation' | 'accountHolderTaxInformation' | 'accountHolderTaxClarification' | 'address' | 'confirmation' | 'countryOfCitizenship' | 'countryOfIncorporation' | 'permanentAddress' | 'placeOfBirth' | 'summary' | 'taxResidences' | 'taxResidence1' | 'taxResidence2' | 'taxResidence3' | 'taxResidence4' | 'taxResidence5'>;
+    prompt: Pick<PropertyFile['prompt'], 'addAdditionalResidence' | 'addControllingPerson' | 'financialInstitutionType' | 'activeNonFinancialEntityType' | 'passiveEntityType' | 'managedEntityType' | 'investmentEntityManaged' | 'iUnderstandTheInformationIsCovered' | 'iAcknowledgeTheInformationMayBeProvided' | 'iCertifyIAmAccountHolder' | 'iCertifyIAmAuthorizedToSignForAccountHolder' | 'iCertifyIWillNotifyPersons' | 'iDeclareStatementsAreCorrect' | 'iWillNotifyChangeInCircumstanceForIndividual' | 'iWillNotifyChangeInCircumstanceForAccountHolder' | 'otherRole' | 'otherEquivalentRole' | 'ownershipPercentage' | 'relatedCorporation' | 'removeControllingPerson' | 'role' | 'securitiesMarket' | 'taxIdNumberIsNotRequiredReason' | 'taxIdNumberIsNotRequiredReasonOther' | 'address' | 'businessRegistrationCountry' | 'businessRegistrationNumber' | 'city' | 'cityOfBirth' | 'country' | 'countryOfBirth' | 'dateOfBirth' | 'day' | 'financialAccountIdentifier' | 'financialAccountName' | 'iConfirmTheInformationIsCorrectComplete' | 'isIndividual' | 'month' | 'name' | 'nameOfEntity' | 'nameOfIndividual' | 'province' | 'removeResidence' | 'countyRegion' | 'stateProvince' | 'street' | 'street2' | 'signatureCapacity' | 'signatureCapacityOther' | 'taxIdNumber' | 'taxIdNumberIsNotRequired' | 'tin' | 'tinUkCrn' | 'tinUkNino' | 'type' | 'usTin' | 'vatCountry' | 'vatIdentificationNumber' | 'vatIsNotRequired' | 'year' | 'zip'>;
+    subPrompt: Pick<PropertyFile['subPrompt'], 'financialAccountIdentifier' | 'financialAccountName' | 'financialInstitutionType' | 'isIndividual' | 'placeOfBirth' | 'relatedCorporation' | 'role' | 'securitiesMarket' | 'signatureCapacityOther' | 'streetIsPermanent' | 'vatIdentificationNumber'>;
+    subTitle: Pick<PropertyFile['subTitle'], 'taxResidences' | 'controllingPersonDetails'>;
+    title: Pick<PropertyFile['title'], 'carfClassificationDetails' | 'controllingPersonDetails' | 'controllingPersons' | 'controllingPerson1' | 'controllingPerson2' | 'controllingPerson3' | 'controllingPerson4' | 'controllingPerson5' | 'accountHolder' | 'accountHolderClassification' | 'accountHolderContactInformation' | 'accountHolderTaxInformation' | 'accountHolderTaxClarification' | 'address' | 'confirmation' | 'countryOfCitizenship' | 'countryOfIncorporation' | 'permanentAddress' | 'placeOfBirth' | 'summary' | 'taxResidences' | 'taxResidence1' | 'taxResidence2' | 'taxResidence3' | 'taxResidence4' | 'taxResidence5'>;
     text: Pick<PropertyFile['text'], 'interviewIsComplete' | 'notRequired' | 'notRequiredOrNotIssued' | 'retrievingInterviewStatus' | 'taxDocumentationSaved'>;
     error: Pick<PropertyFile['error'], 'countryMustBeAResidenceCountry' | 'formHasErrors' | 'invalid' | 'invalidDate' | 'invalidVat' | 'mustBeAtLeast18' | 'mustBeFiveOrNineDigits' | 'mustBeInDateFormat' | 'mustBeInVatinFormat' | 'mustBeNineDigits' | 'mustBeNinoFormat' | 'mustBeCaPostalCodeFormat' | 'mustBeValidBirthDate' | 'mustNotMatchVatin' | 'required' | 'residencesMustIncludeAddressCountry' | 'residencesMustIncludeAnEUCountry' | 'residencesMustIncludeVatCountry' | 'tooLong' | 'tooShort' | 'vatinMustNotMatchResidencyTin'>;
-    option: Pick<PropertyFile['option'], 'no' | 'yes' | 'isIndividual_yes' | 'isIndividual_no'>;
+    option: Pick<PropertyFile['option'], 'no' | 'yes' | 'isIndividual_yes' | 'isIndividual_no' | 'isInvestmentEntityManaged_yes' | 'isInvestmentEntityManaged_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'>;
+    subOption: Pick<PropertyFile['subOption'], 'accountHolderActiveNonFinancialEntityType_PUBLIC_CORPORATION' | 'accountHolderActiveNonFinancialEntityType_OTHER'>;
 };
 export type PartialDPSPropertyFile = {
-    button?: Partial<DPSPropertyFile['button']>;
-    prompt?: Partial<DPSPropertyFile['prompt']>;
-    subPrompt?: Partial<DPSPropertyFile['subPrompt']>;
-    subTitle?: Partial<DPSPropertyFile['subTitle']>;
-    title?: Partial<DPSPropertyFile['title']>;
-    text?: Partial<DPSPropertyFile['text']>;
-    error?: Partial<DPSPropertyFile['error']>;
-    option?: Partial<DPSPropertyFile['option']>;
+    button?: Partial<ForeignPropertyFile['button']>;
+    prompt?: Partial<ForeignPropertyFile['prompt']>;
+    subPrompt?: Partial<ForeignPropertyFile['subPrompt']>;
+    subTitle?: Partial<ForeignPropertyFile['subTitle']>;
+    title?: Partial<ForeignPropertyFile['title']>;
+    text?: Partial<ForeignPropertyFile['text']>;
+    error?: Partial<ForeignPropertyFile['error']>;
+    option?: Partial<ForeignPropertyFile['option']>;
 };

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

@@ -1,6 +1,5 @@
 import { Locale } from '../../types';
 import { ButtonKey, ErrorKey, OptionKey, PromptKey, SubOptionKey, SubPromptKey, SubTitleKey, TextKey } from '../types';
-
 export declare const getPromptText: (key: PromptKey, locale: Locale | undefined) => string;
 export declare const getSubPromptText: (key: SubPromptKey, locale: Locale | undefined) => string;
 export declare const getErrorText: (key: ErrorKey, locale: Locale | undefined) => string;

package/dist/src/index.d.ts

@@ -1,9 +1,8 @@
 import { ClientTaxDocumentation } from '@taxbit/utilities';
-
-export * from './entry/TaxbitQuestionnaire';
 export * from './hooks/useTaxbit/useTaxbit';
 export * from './types/client/ClientTaxDocumentationStatus';
 export * from './types/Locale';
 export * from './types/Progress';
-export * from './types/Questionnaire';
+export * from './types/QuestionnaireProp.ts';
+export * from './widgets/TaxbitQuestionnaire';
 export type { ClientTaxDocumentation };

package/dist/src/lookups/activeNonFinancialEntityTypeOptions.d.ts

@@ -0,0 +1,3 @@
+export declare const activeNonFinancialEntityTypeOptions: {
+    value: "OTHER" | "INTERNATIONAL_ORGANIZATION" | "GOVERNMENT_ENTITY" | "PUBLIC_CORPORATION";
+}[];

package/dist/src/lookups/controllingPersonRoleOptions.d.ts

@@ -0,0 +1,3 @@
+export declare const getControllingPersonRoleOptions: (entityType: string | undefined) => {
+    value: "OTHER" | "SETTLOR" | "TRUSTEE" | "PROTECTOR" | "BENEFICIARY" | "SETTLOR_EQUIVALENT" | "TRUSTEE_EQUIVALENT" | "PROTECTOR_EQUIVALENT" | "BENEFICIARY_EQUIVALENT" | "OTHER_EQUIVALENT" | "OWNER" | "OTHER_MEANS" | "SENIOR_MANAGING_OFFICIAL";
+}[];

package/dist/src/lookups/dayOptions.d.ts

@@ -1,3 +1,3 @@
 export declare const dayOptions: {
-    value: T;
+    value: "01" | "02" | "03" | "04" | "05" | "06" | "07" | "08" | "09" | "10" | "11" | "12" | "13" | "14" | "15" | "16" | "17" | "18" | "19" | "20" | "21" | "22" | "23" | "24" | "25" | "26" | "27" | "28" | "29" | "30" | "31";
 }[];

package/dist/src/lookups/entityTypeOptions.d.ts

@@ -0,0 +1,3 @@
+export declare const entityTypeOptions: {
+    value: "OTHER" | "TRUST" | "SIMILAR_TO_TRUST";
+}[];

package/dist/src/lookups/fatcaCodeOptions.d.ts

@@ -1,4 +1,4 @@
 export declare const fatcaCodeOptions: {
     label: "A" | "B" | "C" | "D" | "E" | "F" | "G" | "H" | "I" | "J" | "K" | "L" | "M";
-    value: T;
+    value: "A" | "B" | "C" | "D" | "E" | "F" | "G" | "H" | "I" | "J" | "K" | "L" | "M";
 }[];

package/dist/src/lookups/financialInstitutionTypeOptions.d.ts

@@ -0,0 +1,3 @@
+export declare const financialInstitutionTypeOptions: {
+    value: "DEPOSITORY_INSTITUTION" | "CUSTODIAL_INSTITUTION" | "INSURANCE_COMPANY" | "INVESTMENT_ENTITY";
+}[];

package/dist/src/lookups/foreignAccountHolderAccountTypeOptions.d.ts

@@ -1,3 +1,3 @@
 export declare const foreignAccountHolderAccountTypeOptions: {
-    value: T;
+    value: "INDIVIDUAL" | "PARTNERSHIP" | "OTHER" | "DISREGARDED_ENTITY" | "CORPORATION" | "TRUST";
 }[];

package/dist/src/lookups/foreignOtherClassificationOptions.d.ts

@@ -1,3 +1,3 @@
 export declare const foreignOtherClassificationOptions: {
-    value: T;
+    value: "TAX_EXEMPT_ORGANIZATION" | "PRIVATE_FOUNDATION" | "INTERNATIONAL_ORGANIZATION" | "CENTRAL_BANK_OF_ISSUE" | "FOREIGN_GOVERNMENT_CONTROLLED_ENTITY" | "FOREIGN_GOVERNMENT_INTEGRAL_PART" | "ESTATE";
 }[];

package/dist/src/lookups/foreignRegardedOwnerAccountTypeOptions.d.ts

@@ -1,3 +1,3 @@
 export declare const foreignRegardedOwnerAccountTypeOptions: {
-    value: T;
+    value: "INDIVIDUAL" | "PARTNERSHIP" | "OTHER" | "CORPORATION" | "TRUST";
 }[];

package/dist/src/lookups/foreignTrustClassificationOptions.d.ts

@@ -1,3 +1,3 @@
 export declare const foreignTrustClassificationOptions: {
-    value: T;
+    value: "SIMPLE_TRUST" | "COMPLEX_TRUST" | "GRANTOR_TRUST";
 }[];

package/dist/src/lookups/getTreatyCountryLimitationOnBenefitOptions.d.ts

@@ -1,5 +1,4 @@
 import { LimitationOnBenefit } from '@taxbit/utilities';
-
 export declare const getTreatyCountryLimitationOnBenefitOptions: (country?: string) => Array<{
     value: LimitationOnBenefit;
 }>;

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

@@ -1,6 +1,10 @@
+export * from './activeNonFinancialEntityTypeOptions';
+export * from './controllingPersonRoleOptions';
 export * from './countryOptions';
 export * from './dayOptions';
+export * from './entityTypeOptions.ts';
 export * from './fatcaCodeOptions';
+export * from './financialInstitutionTypeOptions';
 export * from './foreignAccountHolderAccountTypeOptions';
 export * from './foreignOtherClassificationOptions';
 export * from './foreignRegardedOwnerAccountTypeOptions';
@@ -8,6 +12,9 @@ export * from './foreignTrustClassificationOptions';
 export * from './getTreatyCountryLimitationOnBenefitOptions';
 export * from './localeOptions';
 export * from './payeeCodeOptions';
+export * from './selfCertificationAccountTypeOptions';
+export * from './signatureCapacityOptions';
+export * from './tinNotRequiredReasonOptions';
 export * from './typeOfIncomeOptions';
 export * from './usAccountHolderAccountTypeOptions';
 export * from './usLlcAccountTypeOptions';

package/dist/src/lookups/localeOptions.d.ts

@@ -1,5 +1,4 @@
 import { Locale } from 'types';
-
 export declare const localeDPSOptions: {
     value: Locale;
     label: string;

package/dist/src/lookups/payeeCodeOptions.d.ts

@@ -1,4 +1,4 @@
 export declare const payeeCodeOptions: {
-    label: "10" | "11" | "12" | "13" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9";
-    value: T;
+    label: "1" | "2" | "3" | "4" | "5" | "10" | "11" | "12" | "13" | "6" | "7" | "8" | "9";
+    value: "1" | "2" | "3" | "4" | "5" | "10" | "11" | "12" | "13" | "6" | "7" | "8" | "9";
 }[];

package/dist/src/lookups/selfCertificationAccountTypeOptions.d.ts

@@ -0,0 +1,3 @@
+export declare const selfCertificationAccountTypeOptions: {
+    value: "FINANCIAL_INSTITUTION" | "ACTIVE_NON_FINANCIAL_ENTITY" | "PASSIVE_NON_FINANCIAL_ENTITY";
+}[];

package/dist/src/lookups/signatureCapacityOptions.d.ts

@@ -0,0 +1,3 @@
+export declare const signatureCapacityOptions: {
+    value: "OFFICER" | "EXECUTOR" | "OTHER_CAPACITY";
+}[];

package/dist/src/lookups/tinNotRequiredReasonOptions.d.ts

@@ -0,0 +1,3 @@
+export declare const tinNotRequiredReasonOptions: {
+    value: "OTHER" | "NOT_ISSUED" | "NOT_REQUIRED";
+}[];

package/dist/src/lookups/usAccountHolderAccountTypeOptions.d.ts

@@ -1,3 +1,3 @@
 export declare const usAccountHolderAccountTypeOptions: {
-    value: T;
+    value: "INDIVIDUAL" | "SOLE_PROPRIETOR" | "LLC" | "SM_LLC" | "C_CORPORATION" | "S_CORPORATION" | "PARTNERSHIP" | "TRUST_ESTATE" | "OTHER" | "DISREGARDED_ENTITY";
 }[];

package/dist/src/lookups/usLlcAccountTypeOptions.d.ts

@@ -1,3 +1,3 @@
 export declare const usLlcAccountTypeOptions: {
-    value: T;
+    value: "C_CORPORATION" | "S_CORPORATION" | "PARTNERSHIP";
 }[];

package/dist/src/lookups/usRegardedOwnerAccountTypeOptions.d.ts

@@ -1,3 +1,3 @@
 export declare const usRegardedOwnerAccountTypeOptions: {
-    value: T;
+    value: "INDIVIDUAL" | "LLC" | "C_CORPORATION" | "S_CORPORATION" | "PARTNERSHIP" | "TRUST_ESTATE" | "OTHER";
 }[];

package/dist/src/services/api.d.ts

@@ -1,9 +1,11 @@
-import { Questionnaire } from 'types';
-
+import { QuestionnaireProp } from 'types';
+export declare const TAX_DOCUMENTATION_SUBMISSIONS_PATH = "tax-documentation/submissions";
+export declare const TAX_DOCUMENTATION_STATUS_PATH = "tax-documentation-status";
+export declare const TAX_DOCUMENT_PATH = "tax-documentation/document";
 export declare const api: {
     taxDocumentationSubmissions: {
         post: (environment: "PRODUCTION" | "STAGING") => string;
-        get: (environment: "PRODUCTION" | "STAGING", questionnaire: Questionnaire) => string;
+        get: (environment: "PRODUCTION" | "STAGING", questionnaire: QuestionnaireProp) => string;
     };
     taxDocumentationStatus: {
         get: (environment: "PRODUCTION" | "STAGING") => string;

package/dist/src/services/msw.d.ts

@@ -0,0 +1,33 @@
+type ResponseOptions = {
+    once?: boolean;
+    body?: unknown;
+    status?: number;
+};
+export declare const mockApi: {
+    taxDocumentationSubmissions: {
+        get: {
+            success: (options?: ResponseOptions) => import('msw').HttpHandler;
+        };
+        post: {
+            success: (options?: ResponseOptions) => import('msw').HttpHandler;
+            unauthorized: (options?: ResponseOptions) => import('msw').HttpHandler;
+        };
+    };
+    taxDocumentationStatus: {
+        get: {
+            success: (options?: ResponseOptions) => import('msw').HttpHandler;
+            unauthorized: (options?: ResponseOptions) => import('msw').HttpHandler;
+        };
+    };
+    taxDocument: {
+        post: {
+            success: (options?: ResponseOptions) => import('msw').HttpHandler;
+        };
+        get: {
+            success: (options?: ResponseOptions) => import('msw').HttpHandler;
+            pending: (options?: ResponseOptions) => import('msw').HttpHandler;
+        };
+    };
+};
+export declare const successHandlers: import('msw').HttpHandler[];
+export {};

package/dist/src/test/Wrapper.d.ts

@@ -1,8 +1,7 @@
 import { ClientTaxDocumentation } from '@taxbit/utilities';
 import { default as React } from 'react';
-import { Questionnaire } from '../types';
-
+import { QuestionnaireProp } from '../types';
 export declare const Wrapper: React.FC<React.PropsWithChildren & {
     initialData?: ClientTaxDocumentation;
-    questionnaire?: Questionnaire;
+    questionnaire?: QuestionnaireProp;
 }>;

package/dist/src/test/getWrapper.d.ts

@@ -1,5 +1,4 @@
 import { ClientTaxDocumentation } from '@taxbit/utilities';
 import { default as React } from 'react';
-import { Questionnaire } from '../types';
-
-export declare const getWrapper: (initialData?: ClientTaxDocumentation, questionnaire?: Questionnaire) => ({ children }: React.PropsWithChildren) => React.ReactNode | Promise<React.ReactNode>;
+import { QuestionnaireProp } from '../types';
+export declare const getWrapper: (initialData?: ClientTaxDocumentation, questionnaire?: QuestionnaireProp) => ({ children }: React.PropsWithChildren) => React.ReactNode | Promise<React.ReactNode>;

package/dist/src/test/utils/helpers.d.ts

@@ -1,9 +1,16 @@
 export declare const expectRowError: (prompt: string) => void;
 export declare const expectRowErrorText: (prompt: string, text: string) => void;
 export declare const expectNoRowError: (prompt: string) => void;
+export declare const expectQuestionCount: (count: number) => void;
 export declare const expectText: (text: string, length?: number) => void;
 export declare const expectSummaryFieldText: (field: string, text: string) => void;
 export declare const expectNullInput: (ariaLabel: string) => void;
+export declare const expectVisibleQuestion: (prompt: string) => void;
+export declare const expectNoQuestion: (prompt: string) => void;
+export declare const expectCheckbox: (prompt: string) => void;
+export declare const expectNoCheckbox: (prompt: string) => void;
+export declare const expectSection: (title: string) => void;
+export declare const expectNoSection: (title: string) => void;
 export declare const expectDisabledInput: (ariaLabel: string) => void;
 export declare const expectInputValue: (ariaLabel: string, value: string) => void;
 export declare const clickLabel: (ariaLabel: string) => void;
@@ -16,8 +23,11 @@ export declare const clickNext: () => void;
 export declare const clickSubmit: () => void;
 export declare const clickAddAdditionalResidence: () => void;
 export declare const clickRemoveResidence: (index: 1 | 2 | 3 | 4 | 5) => void;
+export declare const clickAddControllingPerson: () => void;
+export declare const clickRemoveControllingPerson: (index: 1 | 2 | 3 | 4 | 5) => void;
 export declare const setBusinessNameAndAddress: (prefix?: string) => void;
 export declare const setIndividualNameAndAddress: (prefix?: string) => void;
 export declare const setUSIndividualNameAndAddress: (prefix?: string) => void;
 export declare const setIndividualNameAndAddressAndBirthDate: (prefix?: string) => void;
 export declare const setUSIndividualNameAndAddressAndBirthDate: (prefix?: string) => void;
+export declare const setIndividualCountryNameAndAddressAndBirthDate: (prefix?: string) => void;

package/dist/src/types/InputStep.d.ts

@@ -1,4 +1,4 @@
-declare const inputSteps: readonly ["AccountHolderClassification", "AccountHolderContact", "AccountHolderTax", "AccountHolderTaxClarification", "AccountHolderTreatyClaims", "Exemptions", "RegardedOwnerContact", "RegardedOwnerTax", "RegardedOwnerTreatyClaims", "Summary", "W8imyInstructions"];
+declare const inputSteps: readonly ["AccountHolderClassification", "AccountHolderContact", "AccountHolderTax", "AccountHolderTaxClarification", "AccountHolderTreatyClaims", "ControllingPersonDetails1", "ControllingPersonDetails2", "ControllingPersonDetails3", "ControllingPersonDetails4", "ControllingPersonDetails5", "Exemptions", "RegardedOwnerContact", "RegardedOwnerTax", "RegardedOwnerTreatyClaims", "Summary", "W8imyInstructions"];
 export type InputStep = (typeof inputSteps)[number];
 export declare const isInputStep: (step: string) => step is InputStep;
 export declare const confirmInputStep: (step: string) => InputStep;

package/dist/src/types/Progress.d.ts

@@ -1,6 +1,5 @@
 import { Locale } from './Locale';
 import { StepId } from './StepId';
-
 export type Progress = {
     language: Locale;
     percentComplete: number;

package/dist/src/types/QuestionnaireProp.d.ts

@@ -0,0 +1 @@
+export type QuestionnaireProp = 'W-FORM' | 'DPS' | 'SELF-CERT';

package/dist/src/types/StepId.d.ts

@@ -1 +1 @@
-export type StepId = 'accountHolderContactInformation' | 'accountHolderTaxInformation' | 'accountHolderClassification' | 'accountHolderTaxClarification' | 'accountHolderTreatyClaims' | 'confirmation' | 'exemptions' | 'regardedOwnerContactInformation' | 'regardedOwnerTaxInformation' | 'regardedOwnerTreatyClaims' | 'summary' | 'w8imyInstructions';
+export type StepId = 'accountHolderContactInformation' | 'accountHolderTaxInformation' | 'accountHolderClassification' | 'accountHolderTaxClarification' | 'accountHolderTreatyClaims' | 'confirmation' | 'controllingPersonDetails1' | 'controllingPersonDetails2' | 'controllingPersonDetails3' | 'controllingPersonDetails4' | 'controllingPersonDetails5' | 'exemptions' | 'regardedOwnerContactInformation' | 'regardedOwnerTaxInformation' | 'regardedOwnerTreatyClaims' | 'summary' | 'w8imyInstructions';

package/dist/src/types/TaxDocumentation.d.ts

@@ -1,7 +1,6 @@
-import { ForeignAccountHolderAccountType, ForeignOtherClassification, ForeignRegardedOwnerAccountType, ForeignTrustClassification, UsAccountHolderAccountType, UsLLCAccountType, UsRegardedOwnerAccountType } from '@taxbit/utilities';
+import { ActiveNonFinancialEntityType, EntityType, FinancialInstitutionType, ForeignAccountHolderAccountType, ForeignOtherClassification, ForeignRegardedOwnerAccountType, ForeignTrustClassification, SelfCertificationAccountType, UsAccountHolderAccountType, UsLLCAccountType, UsRegardedOwnerAccountType } from '@taxbit/utilities';
 import { Yes } from './Yes';
 import { YesNo } from './YesNo';
-
 export type AccountHolderClassificationData = {
     accountHolderIsIndividual?: YesNo;
     accountHolderUsPerson?: YesNo;
@@ -15,25 +14,30 @@ export type AccountHolderClassificationData = {
     accountHolderForeignTrustClassification?: ForeignTrustClassification;
     accountHolderForeignOtherClassification?: ForeignOtherClassification;
 };
-export type AccountHolderContactData = {
-    accountHolderAddressCity?: string;
-    accountHolderAddressCountry?: string;
-    accountHolderAddressState?: string;
-    accountHolderAddressStreet2?: string;
-    accountHolderAddressStreet?: string;
-    accountHolderAddressZip?: string;
+type Address<Prefix extends string> = {
+    [key in `${Prefix}Address`]?: string;
+} & {
+    [key in `${Prefix}AddressCity`]?: string;
+} & {
+    [key in `${Prefix}AddressCountry`]?: string;
+} & {
+    [key in `${Prefix}AddressState`]?: string;
+} & {
+    [key in `${Prefix}AddressStreet2`]?: string;
+} & {
+    [key in `${Prefix}AddressStreet`]?: string;
+} & {
+    [key in `${Prefix}AddressZip`]?: string;
+};
+export type AccountHolderContactData = Address<'accountHolder'> & Address<'accountHolderMailing'> & {
     accountHolderCityOfBirth?: string;
     accountHolderCountryOfBirth?: string;
+    accountHolderOptionalCityOfBirth?: string;
+    accountHolderOptionalCountryOfBirth?: string;
     accountHolderCountryOfCitizenship?: string;
     accountHolderDateOfBirth?: string;
     accountHolderDbaName?: string;
-    accountHolderMailingAddressCity?: string;
-    accountHolderMailingAddressCountry?: string;
     accountHolderMailingAddressIsDifferent?: Yes;
-    accountHolderMailingAddressState?: string;
-    accountHolderMailingAddressStreet2?: string;
-    accountHolderMailingAddressStreet?: string;
-    accountHolderMailingAddressZip?: string;
     accountHolderName?: string;
 };
 export type AccountHolderTreatyClaimData = {
@@ -58,38 +62,73 @@ export type RegardedOwnerTreatyClaimData = {
     regardedOwnerTreatyClaimWithholding?: string;
     regardedOwnerTreatyClaimHasAdditionalConditions?: Yes;
 };
-export type AccountHolderTaxData = {
+type Iterate1_5 = '1' | '2' | '3' | '4' | '5';
+type ResidencesKey<Prefix extends string> = `${Prefix}TaxResidences`;
+type ResidenceCountryKey<Prefix extends string> = `${Prefix}TaxResidenceCountry${Iterate1_5}`;
+type ResidenceTinKey<Prefix extends string> = `${Prefix}TaxResidenceTin${Iterate1_5}`;
+type ResidenceTinNotRequiredKey<Prefix extends string> = `${Prefix}TaxResidenceTinIsNotRequired${Iterate1_5}`;
+type ResidenceTinNotRequiredReasonKey<Prefix extends string> = `${Prefix}TaxResidenceTinIsNotRequiredReason${Iterate1_5}`;
+type ResidenceTinNotRequiredReasonOtherKey<Prefix extends string> = `${Prefix}TaxResidenceTinIsNotRequiredReasonOther${Iterate1_5}`;
+type ResidenceShowKey<Prefix extends string> = `${Prefix}ShowTaxResidence${Iterate1_5}`;
+type Residences<Prefix extends string> = {
+    [key in ResidencesKey<Prefix>]?: YesNo;
+} & {
+    [key in ResidenceCountryKey<Prefix>]?: string;
+} & {
+    [key in ResidenceTinKey<Prefix>]?: string;
+} & {
+    [key in ResidenceTinNotRequiredKey<Prefix>]?: Yes;
+} & {
+    [key in ResidenceTinNotRequiredReasonKey<Prefix>]?: string;
+} & {
+    [key in ResidenceTinNotRequiredReasonOtherKey<Prefix>]?: string;
+} & {
+    [key in ResidenceShowKey<Prefix>]?: YesNo;
+};
+export type AccountHolderTaxData = Residences<'accountHolder'> & {
     accountHolderForeignTin?: string;
     accountHolderForeignTinIsNotRequired?: Yes;
     accountHolderUsTin?: string;
     accountHolderFinancialAccountIdentifier?: string;
     accountHolderFinancialAccountName?: string;
-    accountHolderTaxResidenceCountry1?: string;
-    accountHolderTaxResidenceTin1?: string;
-    accountHolderTaxResidenceTin1IsNotRequired?: Yes;
-    accountHolderTaxResidenceCountry2?: string;
-    accountHolderTaxResidenceTin2?: string;
-    accountHolderTaxResidenceTin2IsNotRequired?: Yes;
-    accountHolderTaxResidenceCountry3?: string;
-    accountHolderTaxResidenceTin3?: string;
-    accountHolderTaxResidenceTin3IsNotRequired?: Yes;
-    accountHolderTaxResidenceCountry4?: string;
-    accountHolderTaxResidenceTin4?: string;
-    accountHolderTaxResidenceTin4IsNotRequired?: Yes;
-    accountHolderTaxResidenceCountry5?: string;
-    accountHolderTaxResidenceTin5?: string;
-    accountHolderTaxResidenceTin5IsNotRequired?: Yes;
-    accountHolderShowTaxResidence1?: YesNo;
-    accountHolderShowTaxResidence2?: YesNo;
-    accountHolderShowTaxResidence3?: YesNo;
-    accountHolderShowTaxResidence4?: YesNo;
-    accountHolderShowTaxResidence5?: YesNo;
     accountHolderVatIdentificationNumber?: string;
     accountHolderVatIsNotRequired?: Yes;
     accountHolderVatCountry?: string;
     accountHolderBusinessRegistrationNumber?: string;
     accountHolderBusinessRegistrationCountry?: string;
+    accountHolderSelfCertificationAccountType?: SelfCertificationAccountType;
+    accountHolderActiveNonFinancialEntityType?: ActiveNonFinancialEntityType;
+    accountHolderFinancialInstitutionType?: FinancialInstitutionType;
+    accountHolderInvestmentEntityManaged?: YesNo;
+    accountHolderEntityType?: EntityType;
+    accountHolderSecuritiesMarket?: string;
+    accountHolderRelatedCorporation?: string;
 };
+type ControllingPersonPrefix = `controllingPerson${Iterate1_5}`;
+type ControllingPerson = {
+    [key in `${ControllingPersonPrefix}ShowFields`]?: Yes;
+} & {
+    [key in `${ControllingPersonPrefix}Name`]?: string;
+} & {
+    [key in `${ControllingPersonPrefix}Role`]?: string;
+} & {
+    [key in `${ControllingPersonPrefix}RoleOther`]?: string;
+} & {
+    [key in `${ControllingPersonPrefix}RoleOtherEquivalent`]?: string;
+} & {
+    [key in `${ControllingPersonPrefix}OwnershipPercentage`]?: string;
+} & {
+    [key in `${ControllingPersonPrefix}DateOfBirth`]?: string;
+} & {
+    [key in `${ControllingPersonPrefix}CityOfBirth`]?: string;
+} & {
+    [key in `${ControllingPersonPrefix}CountryOfBirth`]?: string;
+} & {
+    [key in `${ControllingPersonPrefix}CountryOfCitizenship`]?: string;
+} & {
+    [key in `${ControllingPersonPrefix}MailingAddressIsDifferent`]?: Yes;
+} & Address<ControllingPersonPrefix> & Address<`${ControllingPersonPrefix}Mailing`>;
+export type ControllingPersonClassificationData = Residences<ControllingPersonPrefix> & ControllingPerson;
 export type RegardedOwnerClassificationData = {
     regardedOwnerUsPerson?: YesNo;
     regardedOwnerUsAccountType?: UsRegardedOwnerAccountType;
@@ -100,24 +139,12 @@ export type RegardedOwnerClassificationData = {
     regardedOwnerForeignOtherClassification?: ForeignOtherClassification;
 };
 export type RegardedOwnerContactData = {
-    regardedOwnerAddressCity?: string;
-    regardedOwnerAddressCountry?: string;
-    regardedOwnerAddressState?: string;
-    regardedOwnerAddressStreet2?: string;
-    regardedOwnerAddressStreet?: string;
-    regardedOwnerAddressZip?: string;
     regardedOwnerCountryOfCitizenship?: string;
     regardedOwnerDateOfBirth?: string;
     regardedOwnerDbaName?: string;
-    regardedOwnerMailingAddressCity?: string;
-    regardedOwnerMailingAddressCountry?: string;
     regardedOwnerMailingAddressIsDifferent?: Yes;
-    regardedOwnerMailingAddressState?: string;
-    regardedOwnerMailingAddressStreet2?: string;
-    regardedOwnerMailingAddressStreet?: string;
-    regardedOwnerMailingAddressZip?: string;
     regardedOwnerName?: string;
-};
+} & Address<'regardedOwner'> & Address<'regardedOwnerMailing'>;
 export type RegardedOwnerTaxData = {
     regardedOwnerForeignTin?: string;
     regardedOwnerForeignTinIsNotRequired?: Yes;
@@ -127,7 +154,6 @@ export type SummaryData = {
     exemptFatcaCode?: string;
     exemptPayeeCode?: string;
     iAcknowledgeESignIsOk?: Yes;
-    iAgreeWillResubmitIfIncorrect?: Yes;
     iAmACitizenOfTheUs?: Yes;
     iAmExemptFromFatcaReporting?: Yes;
     iAmNotSubjectToBackupWithholding?: Yes;
@@ -141,7 +167,16 @@ export type SummaryData = {
     iConfirmTheInformationIsCorrectComplete?: Yes;
     iConfirmTheTaxIdIsCorrect?: Yes;
     iHaveCapacityToSign?: Yes;
+    iWillResubmitIfIncorrect?: Yes;
+    iUnderstandTheInformationIsCovered?: Yes;
+    iAcknowledgeTheInformationMayBeProvided?: Yes;
+    iCertifyIAmAccountHolder?: Yes;
+    iCertifyIWillNotifyPersons?: Yes;
+    iDeclareStatementsAreCorrect?: Yes;
+    iWillNotifyChangeInCircumstance?: Yes;
     signature?: string;
+    signatureCapacity?: string;
+    signatureCapacityOther?: string;
     source?: string;
 };
 export type CalculatedData = {
@@ -151,5 +186,6 @@ export type CalculatedData = {
     regardedOwnerAddress?: string;
     regardedOwnerMailingAddress?: string;
 };
-export type TaxDocumentation = AccountHolderContactData & AccountHolderTaxData & AccountHolderClassificationData & RegardedOwnerContactData & RegardedOwnerClassificationData & RegardedOwnerTaxData & SummaryData & CalculatedData & AccountHolderTreatyClaimData & RegardedOwnerTreatyClaimData;
+export type TaxDocumentation = AccountHolderContactData & AccountHolderTaxData & AccountHolderClassificationData & RegardedOwnerContactData & RegardedOwnerClassificationData & RegardedOwnerTaxData & SummaryData & CalculatedData & AccountHolderTreatyClaimData & RegardedOwnerTreatyClaimData & ControllingPersonClassificationData;
 export type TaxDocumentationKey = keyof TaxDocumentation;
+export {};

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

@@ -13,4 +13,8 @@ export type ClientTaxDocumentationStatus = {
         tinValidationDate?: string;
         needsResubmission: boolean;
     };
+    selfCertification?: {
+        dataCollectionStatus: 'COMPLETE' | 'INCOMPLETE';
+        needsResubmission: boolean;
+    };
 };

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

@@ -2,7 +2,7 @@ export * from './CamelCaseKeys';
 export * from './InputStep';
 export * from './Locale';
 export * from './Progress';
-export * from './Questionnaire';
+export * from './QuestionnaireProp.ts';
 export * from './TaxDocumentation';
 export * from './Utilities';
 export * from './Yes';

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

@@ -13,4 +13,8 @@ export type TaxDocumentationStatus = {
         tin_validation_date?: string;
         needs_resubmission: boolean;
     };
+    self_certification: {
+        data_collection_status: 'COMPLETE' | 'INCOMPLETE';
+        needs_resubmission: boolean;
+    };
 };

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

@@ -1,6 +1,5 @@
 import { default as React } from 'react';
 import { TaxDocumentationKey } from 'types/TaxDocumentation';
-
 export type ActionButtonProps = {
     name: TaxDocumentationKey;
     onClick: () => void;

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

@@ -1,5 +1,4 @@
 import { default as React } from 'react';
-
 type ActionsProps = {
     onBack?: (data: unknown) => void;
     onNext?: (data: unknown) => void;

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

@@ -1,7 +1,6 @@
 import { default as React } from 'react';
 import { TaxDocumentationKey } from 'types/TaxDocumentation';
 import { Yes } from 'types/Yes';
-
 export type CheckBoxProps = {
     label: boolean;
     subLabel?: boolean;

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

@@ -1,6 +1,5 @@
 import { default as React } from 'react';
 import { TaxDocumentationKey } from 'types/TaxDocumentation';
-
 export type DateOfBirthInputProps = {
     name: TaxDocumentationKey;
     className?: string;