@taxbit/react-sdk 0.0.14 → 0.0.16

package/dist/types/AccountType.d.ts

@@ -1,6 +1,6 @@
-import { usAccountHolderAccountTypeOptions, usLlcAccountTypeOptions, foreignAccountHolderAccountTypeOptions, foreignTrustAccountTypeOptions, foreignOtherAccountTypeOptions } from "lookups";
+import { usAccountHolderAccountTypeOptions, usLlcAccountTypeOptions, foreignAccountHolderAccountTypeOptions, foreignTrustClassificationOptions, foreignOtherClassificationOptions } from "lookups";
 export type UsAccountType = (typeof usAccountHolderAccountTypeOptions)[number]["value"];
 export type UsLlcAccountType = (typeof usLlcAccountTypeOptions)[number]["value"];
 export type ForeignAccountType = (typeof foreignAccountHolderAccountTypeOptions)[number]["value"];
-export type ForeignTrustAccountType = (typeof foreignTrustAccountTypeOptions)[number]["value"];
-export type ForeignOtherAccountType = (typeof foreignOtherAccountTypeOptions)[number]["value"];
+export type ForeignTrustAccountType = (typeof foreignTrustClassificationOptions)[number]["value"];
+export type ForeignOtherAccountType = (typeof foreignOtherClassificationOptions)[number]["value"];

package/dist/types/MonthCode.d.ts

@@ -0,0 +1 @@
+export type MonthCode = "01" | "02" | "03" | "04" | "05" | "06" | "07" | "08" | "09" | "10" | "11" | "12";

package/dist/types/TaxDocumentation.d.ts

@@ -38,6 +38,7 @@ export type AccountHolderContactData = {
 export type AccountHolderTaxData = {
     accountHolderFinancialAccountIdentifier?: string;
     accountHolderFinancialAccountName?: string;
+    accountHolderFinancialAccountNameSameAsAccountHolderName?: Yes;
     accountHolderForeignTin?: string;
     accountHolderForeignTinIsNotRequired?: Yes;
     accountHolderTaxResidenceCountry1?: string;
@@ -61,6 +62,7 @@ export type AccountHolderTaxData = {
     accountHolderShowTaxResidence5?: YesNo;
     accountHolderUsTin?: string;
     accountHolderVatIdentificationNumber?: string;
+    accountHolderVatIdentificationNumberIsNotRequired?: Yes;
     accountHolderVatCountry?: string;
 };
 export type RegardedOwnerClassificationData = {

package/dist/types/external/ComprehensiveTaxDocumentation.d.ts

@@ -1,3 +1,4 @@
+import type { CamelCasedPropertiesDeep } from "type-fest";
 type Address = {
     city?: string;
     country?: string;
@@ -6,71 +7,76 @@ type Address = {
     second_line?: string;
     postal_code?: string;
 };
-export type ComprehensiveTaxDocumentation = {
-    account_holder?: {
-        address?: Address;
-        country_of_citizenship?: string;
-        date_of_birth?: string;
-        dba_name?: string;
-        mailing_address?: Address;
-        mailing_address_is_different?: true;
-        name?: string;
-        city_of_birth?: string;
-        country_of_birth?: string;
-        business_registration_number?: string;
-        financial_account_identifier?: string;
-        financial_account_name?: string;
-        ftin?: string;
-        ftin_not_legally_required?: true;
-        tax_residences: {
-            country?: string;
-            tin?: string;
-            tin_not_required?: boolean;
-        }[];
-        show_tax_residence?: boolean[];
+type AccountHolderTaxDocumentation = {
+    address?: Address;
+    country_of_citizenship?: string;
+    date_of_birth?: string;
+    dba_name?: string;
+    mailing_address?: Address;
+    mailing_address_is_different?: boolean;
+    name?: string;
+    city_of_birth?: string;
+    country_of_birth?: string;
+    business_registration_number?: string;
+    financial_account_identifier?: string;
+    financial_account_name?: string;
+    ftin?: string;
+    ftin_not_legally_required?: boolean;
+    tax_residences?: {
+        country?: string;
         tin?: string;
-        vat_id?: string;
-        vat_country?: string;
-        exempt_fatca_code?: string;
-        exempt_payee_code?: string;
-        is_individual?: boolean;
-        is_eu_resident?: boolean;
-        is_us_person?: boolean;
-        us_account_type?: string;
-        us_smllc_election?: boolean;
-        us_llc_classification?: string;
-        other_classification?: string;
-        us_trust_estate_ein?: boolean;
-        foreign_account_type?: string;
-        foreign_trust_classification?: string;
-        foreign_other_classification?: string;
-    };
-    regarded_owner?: {
-        address?: Address;
-        country_of_citizenship?: string;
-        date_of_birth?: string;
-        dba_name?: string;
-        mailing_address?: Address;
-        mailing_address_is_different?: true;
-        name?: string;
-        ftin?: string;
-        ftin_not_legally_required?: true;
-        tin?: string;
-        exempt_fatca_code?: string;
-        exempt_payee_code?: string;
-        is_us_person?: boolean;
-        us_account_type?: string;
-        us_llc_classification?: string;
-        other_classification?: string;
-        us_trust_estate_ein?: boolean;
-        foreign_account_type?: string;
-        foreign_trust_classification?: string;
-        foreign_other_classification?: string;
-    };
-    document_type: "COMPREHENSIVE";
-    signature?: string;
-    signature_date?: string;
+        tin_not_required?: boolean;
+    }[];
+    show_tax_residence?: boolean[];
+    tin?: string;
+    vatin?: string;
+    vatin_country?: string;
+    vatin_not_required?: boolean;
+    exempt_fatca_code?: string;
+    exempt_payee_code?: string;
+    is_individual?: boolean;
+    is_eu_resident?: boolean;
+    is_us_person?: boolean;
+    us_account_type?: string;
+    us_smllc_election?: boolean;
+    us_llc_classification?: string;
+    us_other_classification?: string;
+    us_trust_estate_ein?: boolean;
+    foreign_account_type?: string;
+    foreign_trust_classification?: string;
+    foreign_other_classification?: string;
+};
+type RegardedOwnerTaxDocumentation = {
+    address?: Address;
+    country_of_citizenship?: string;
+    date_of_birth?: string;
+    dba_name?: string;
+    mailing_address?: Address;
+    mailing_address_is_different?: boolean;
+    name?: string;
+    ftin?: string;
+    ftin_not_legally_required?: boolean;
+    tin?: string;
+    exempt_fatca_code?: string;
+    exempt_payee_code?: string;
+    is_us_person?: boolean;
+    us_account_type?: string;
+    us_llc_classification?: string;
+    other_classification?: string;
+    us_trust_estate_ein?: boolean;
+    foreign_account_type?: string;
+    foreign_trust_classification?: string;
+    foreign_other_classification?: string;
+};
+export type SignedComprehensiveTaxDocumentation = {
+    account_holder?: AccountHolderTaxDocumentation;
+} & {
+    regarded_owner?: RegardedOwnerTaxDocumentation;
+} & {
     has_certified?: boolean;
     is_not_subject_backup_withholding?: boolean;
+    signature: string;
+    document_type: "COMPREHENSIVE";
 };
+export type ClientTaxDocumentation = CamelCasedPropertiesDeep<AccountHolderTaxDocumentation>;
 export {};

package/dist/types/index.d.ts

@@ -1,6 +1,7 @@
 export * from "./AccountType";
 export * from "./CaProvinceCode";
 export * from "./CountryCode";
+export * from "./MonthCode";
 export * from "./TaxForm";
 export * from "./TaxDocumentation";
 export * from "./UsStateCode";

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

@@ -0,0 +1,7 @@
+import React from "react";
+import { TaxDocumentationKey } from "types/TaxDocumentation";
+export type ActionButtonProps = {
+    name: TaxDocumentationKey;
+    onClick: () => void;
+};
+export declare const ActionButton: ({ name, onClick }: ActionButtonProps) => React.JSX.Element;

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

@@ -0,0 +1 @@
+export * from "./ActionButton.tsx";

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

@@ -4,5 +4,6 @@ export type CheckBoxProps = {
     label: boolean;
     subLabel?: boolean;
     name: TaxDocumentationKey;
+    onClick?: (val: string | undefined) => void;
 };
-export declare const CheckBox: ({ label, subLabel, name }: CheckBoxProps) => React.JSX.Element;
+export declare const CheckBox: ({ label, subLabel, name, onClick }: CheckBoxProps) => React.JSX.Element;

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

@@ -0,0 +1,9 @@
+import React from "react";
+import { TaxDocumentationKey } from "types/TaxDocumentation";
+export type DateOfBirthInputProps = {
+    name: TaxDocumentationKey;
+    className?: string;
+    hint?: true;
+    children?: React.ReactNode;
+};
+export declare const DateOfBirthInput: ({ name, className, hint, children, }: DateOfBirthInputProps) => React.JSX.Element;

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

@@ -0,0 +1 @@
+export * from "./DateOfBirthInput.tsx";

package/dist/ui/TextInput/TextInput.d.ts

@@ -5,5 +5,7 @@ export type TextInputProps = {
     className?: string;
     onChange?: (val: string) => string;
     hint?: true;
+    disabled?: boolean;
+    children?: React.ReactNode;
 };
-export declare const TextInput: ({ name, className, onChange, hint, }: TextInputProps) => React.JSX.Element;
+export declare const TextInput: ({ name, className, onChange, hint, children, disabled, }: TextInputProps) => React.JSX.Element;

package/dist/ui/index.d.ts

@@ -1,5 +1,7 @@
 export * from "./Actions";
+export * from "./ActionButton";
 export * from "./CheckBox";
+export * from "./DateOfBirthInput";
 export * from "./RadioButtons";
 export * from "./Select";
 export * from "./TextInput";

package/dist/utils/getForeignAccountType.d.ts

@@ -0,0 +1,2 @@
+import { type ForeignAccountHolderAccountType } from "lookups";
+export declare const getForeignAccountType: (accountType: string | undefined) => ForeignAccountHolderAccountType | undefined;

package/dist/utils/getForeignOtherClassification.d.ts

@@ -0,0 +1,2 @@
+import { type ForeignOtherClassification } from "lookups";
+export declare const getForeignOtherClassification: (classification: string | undefined) => ForeignOtherClassification | undefined;

package/dist/utils/getForeignTrustClassification.d.ts

@@ -0,0 +1,2 @@
+import { type ForeignTrustClassification } from "lookups";
+export declare const getForeignTrustClassification: (classification: string | undefined) => ForeignTrustClassification | undefined;

package/dist/utils/getHintKeyMap.d.ts

@@ -38,6 +38,7 @@ export declare const getHintKeyMap: () => {
     accountHolderName?: "dateOfBirth" | undefined;
     accountHolderFinancialAccountIdentifier?: "dateOfBirth" | undefined;
     accountHolderFinancialAccountName?: "dateOfBirth" | undefined;
+    accountHolderFinancialAccountNameSameAsAccountHolderName?: "dateOfBirth" | undefined;
     accountHolderForeignTin?: "dateOfBirth" | undefined;
     accountHolderForeignTinIsNotRequired?: "dateOfBirth" | undefined;
     accountHolderTaxResidenceCountry1?: "dateOfBirth" | undefined;
@@ -61,6 +62,7 @@ export declare const getHintKeyMap: () => {
     accountHolderShowTaxResidence5?: "dateOfBirth" | undefined;
     accountHolderUsTin?: "dateOfBirth" | undefined;
     accountHolderVatIdentificationNumber?: "dateOfBirth" | undefined;
+    accountHolderVatIdentificationNumberIsNotRequired?: "dateOfBirth" | undefined;
     accountHolderVatCountry?: "dateOfBirth" | undefined;
     accountHolderIsIndividual?: "dateOfBirth" | undefined;
     accountHolderIsEuResident?: "dateOfBirth" | undefined;

package/dist/utils/getLLCClassification.d.ts

@@ -0,0 +1,2 @@
+import { type UsLLCAccountType } from "lookups";
+export declare const getLLCClassification: (accountType: string | undefined) => UsLLCAccountType | undefined;

package/dist/utils/getNotifications.d.ts

@@ -0,0 +1,10 @@
+import { TaxDocumentation, TaxDocumentationKey } from "../types";
+import { NotificationKey } from "../i18n/types";
+export type NotificationRule = ((value: string | undefined, fields: TaxDocumentation) => NotificationKey | undefined) | ((value: string | undefined) => NotificationKey | undefined);
+export type Notifications = {
+    [key in TaxDocumentationKey]?: NotificationKey;
+};
+export type NotificationRules = {
+    [key in TaxDocumentationKey]?: NotificationRule;
+};
+export declare const getNotifications: (shownFields: Set<TaxDocumentationKey>, fields: TaxDocumentation) => Notifications;

package/dist/utils/getPromptKeyMap.d.ts

@@ -38,6 +38,7 @@ export declare const getPromptKeyMap: (data: TaxDocumentation) => {
     accountHolderName?: PromptKey | undefined;
     accountHolderFinancialAccountIdentifier?: PromptKey | undefined;
     accountHolderFinancialAccountName?: PromptKey | undefined;
+    accountHolderFinancialAccountNameSameAsAccountHolderName?: PromptKey | undefined;
     accountHolderForeignTin?: PromptKey | undefined;
     accountHolderForeignTinIsNotRequired?: PromptKey | undefined;
     accountHolderTaxResidenceCountry1?: PromptKey | undefined;
@@ -61,6 +62,7 @@ export declare const getPromptKeyMap: (data: TaxDocumentation) => {
     accountHolderShowTaxResidence5?: PromptKey | undefined;
     accountHolderUsTin?: PromptKey | undefined;
     accountHolderVatIdentificationNumber?: PromptKey | undefined;
+    accountHolderVatIdentificationNumberIsNotRequired?: PromptKey | undefined;
     accountHolderVatCountry?: PromptKey | undefined;
     accountHolderIsIndividual?: PromptKey | undefined;
     accountHolderIsEuResident?: PromptKey | undefined;

package/dist/utils/getUsAccountType.d.ts

@@ -0,0 +1,2 @@
+import { type UsAccountHolderAccountType } from "lookups";
+export declare const getUsAccountType: (accountType: string | undefined) => UsAccountHolderAccountType | undefined;

package/dist/utils/index.d.ts

@@ -1,9 +1,14 @@
 export * from "./cx";
 export * from "./date";
-export * from "./isBlank";
 export * from "./getFieldsState";
+export * from "./getForeignAccountType";
+export * from "./getForeignOtherClassification";
+export * from "./getForeignTrustClassification";
+export * from "./getLLCClassification.ts";
 export * from "./getPromptKeyMap";
 export * from "./getSupportedFields";
+export * from "./getUsAccountType";
 export * from "./getVisibleQuestions";
+export * from "./isBlank";
 export * from "./transformInbound";
 export * from "./transformOutbound";

package/dist/utils/isBlank.d.ts

@@ -1,2 +1,2 @@
-export declare const isBlank: (value: string | undefined) => boolean;
-export declare const isPresent: (value: string | undefined) => boolean;
+export declare const isBlank: (value: string | undefined) => value is undefined;
+export declare const isPresent: (value: string | undefined) => value is string;

package/dist/utils/transformInbound.d.ts

@@ -1,2 +1,3 @@
 import { TaxDocumentation } from "types";
-export declare const transformInbound: (data: TaxDocumentation) => TaxDocumentation;
+import { ClientTaxDocumentation } from "../types/external";
+export declare const transformInbound: (data: ClientTaxDocumentation) => TaxDocumentation;

package/dist/utils/transformOutbound.d.ts

@@ -1,3 +1,3 @@
-import { ComprehensiveTaxDocumentation } from "../types/external";
+import { SignedComprehensiveTaxDocumentation } from "../types/external";
 import { TaxDocumentation } from "../types";
-export declare const transformOutbound: (data: TaxDocumentation) => ComprehensiveTaxDocumentation;
+export declare const transformOutbound: (data: TaxDocumentation) => SignedComprehensiveTaxDocumentation;

package/dist/widgets/TaxBitForm/TaxBitDAC7Form.d.ts

@@ -1,8 +1,8 @@
 import React from "react";
 import type { Locale } from "../../i18n";
-import { TaxDocumentation } from "../../types";
+import { ClientTaxDocumentation } from "../../types/external";
 type TaxBitDAC7FormProps = {
-    data?: TaxDocumentation;
+    data?: ClientTaxDocumentation;
     bearerToken: string;
     language?: Locale;
     staging?: true;

package/dist/widgets/TaxBitForm/TaxBitForm.d.ts

@@ -1,8 +1,9 @@
 import React from "react";
 import type { Locale } from "../../i18n";
-import { TaxForm, TaxDocumentation } from "../../types";
+import { TaxForm } from "../../types";
+import { ClientTaxDocumentation } from "../../types/external";
 type TaxBitFormProps = {
-    data?: TaxDocumentation;
+    data?: ClientTaxDocumentation;
     staging?: true;
     bearerToken: string;
     language?: Locale;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@taxbit/react-sdk",
-  "version": "0.0.14",
+  "version": "0.0.16",
   "description": "TaxBit Tax Documentation",
   "author": "TaxBit",
   "type": "module",
@@ -33,7 +33,8 @@
   "dependencies": {
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "react-input-mask": "^2.0.4"
+    "react-input-mask": "^2.0.4",
+    "type-fest": "^4.3.2"
   },
   "devDependencies": {
     "@types/node": "^18.17.0",

package/dist/lookups/foreignOtherAccountTypeOptions.d.ts

@@ -1,15 +0,0 @@
-export declare const foreignOtherAccountTypeOptions: readonly [{
-    readonly value: "taxExemptOrganization";
-}, {
-    readonly value: "privateFoundation";
-}, {
-    readonly value: "internationalOrganization";
-}, {
-    readonly value: "centralBankOfIssue";
-}, {
-    readonly value: "foreignGovernmentControlledEntity";
-}, {
-    readonly value: "foreignGovernmentIntegralPart";
-}, {
-    readonly value: "estate";
-}];

package/dist/lookups/foreignTrustAccountTypeOptions.d.ts

@@ -1,7 +0,0 @@
-export declare const foreignTrustAccountTypeOptions: readonly [{
-    readonly value: "simpleTrust";
-}, {
-    readonly value: "complexTrust";
-}, {
-    readonly value: "grantorTrust";
-}];

package/dist/validations/__tests__/validations.test.d.ts

@@ -1 +0,0 @@
-export {};