@taxbit/react-sdk 0.0.0

package/README.md

@@ -0,0 +1,20 @@
+# TaxBit Tax Documentation
+
+A React app, widget, and component for gathering Tax Documentation data.
+
+## Installation
+
+`npm install @taxbit/taxbit-tax-documentation`.
+
+`import { TaxDocumentation } from '@taxbit/taxbit-tax-documentation';`
+
+```jsx
+<TaxDocumentationPath onSubmit={data => alert(JSON.stringify(data))} />
+```
+
+## Todo
+
+ - I18n for another language
+ - Config for self-cert and w forms
+ - Style selection
+ - 

package/dist/App.d.ts

@@ -0,0 +1,5 @@
+import React from "react";
+export declare const DataContext: React.Context<{
+    hey: number;
+}>;
+export declare const App: () => React.JSX.Element;

package/dist/Component.d.ts

@@ -0,0 +1,2 @@
+import React from "react";
+export declare const Component: () => React.JSX.Element;

package/dist/components/Address/Address.d.ts

@@ -0,0 +1,17 @@
+import React from "react";
+import { UsStateCode } from "types/UsStateCode";
+import { CaProvinceCode } from "types/CaProvinceCode";
+type AddressParts = {
+    street?: string;
+    street2?: string;
+    city?: string;
+    state?: string | UsStateCode | CaProvinceCode;
+    zip?: string;
+    country?: string;
+};
+type AddressProps = {
+    address: AddressParts;
+    className?: string;
+};
+export declare const Address: ({ address, className }: AddressProps) => React.JSX.Element;
+export {};

package/dist/components/Address/index.d.ts

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

package/dist/components/ErrorMessage/ErrorMessage.d.ts

@@ -0,0 +1,6 @@
+import React from "react";
+import { TaxDocumentationKey } from "types";
+export declare const ErrorMessage: ({ name, hint, }: {
+    name: TaxDocumentationKey;
+    hint?: true | undefined;
+}) => React.JSX.Element | null;

package/dist/components/ErrorMessage/index.d.ts

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

package/dist/components/InputStatus/InputStatus.d.ts

@@ -0,0 +1,5 @@
+import React from "react";
+export declare const InputStatus: ({ children, className, }: {
+    className?: string | undefined;
+    children: React.ReactNode;
+}) => React.JSX.Element;

package/dist/components/InputStatus/index.d.ts

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

package/dist/components/Page/Page.d.ts

@@ -0,0 +1,6 @@
+import React from "react";
+type PageProps = {
+    children: React.ReactNode;
+};
+export declare const Page: ({ children }: PageProps) => React.JSX.Element;
+export {};

package/dist/components/Page/index.d.ts

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

package/dist/components/Row/Row.d.ts

@@ -0,0 +1,12 @@
+import React from "react";
+import { TaxDocumentationKey } from "types/TaxDocumentation";
+export type RowProps = {
+    label?: string;
+    subLabel?: string;
+    value?: string;
+    onEdit?: () => void;
+    children?: React.ReactNode;
+    className?: string;
+    name?: TaxDocumentationKey;
+};
+export declare const Row: ({ label, subLabel, value, children, onEdit, name, className, }: RowProps) => React.JSX.Element;

package/dist/components/Row/index.d.ts

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

package/dist/components/Section/Section.d.ts

@@ -0,0 +1,8 @@
+import React from "react";
+type SectionProps = {
+    title?: string;
+    showIf?: boolean;
+    children: React.ReactNode;
+};
+export declare const Section: ({ title, showIf, children }: SectionProps) => string | number | boolean | Iterable<React.ReactNode> | React.JSX.Element | null | undefined;
+export {};

package/dist/components/Section/index.d.ts

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

package/dist/components/Title/Title.d.ts

@@ -0,0 +1,5 @@
+import React from "react";
+export declare const Title: ({ title, subtitle, }: {
+    title: string;
+    subtitle?: string | undefined;
+}) => React.JSX.Element;

package/dist/components/Title/index.d.ts

@@ -0,0 +1 @@
+export * from './Title.tsx';

package/dist/components/index.d.ts

@@ -0,0 +1,7 @@
+export * from "./Address";
+export * from "./ErrorMessage";
+export * from "./InputStatus";
+export * from "./Page";
+export * from "./Row";
+export * from "./Section";
+export * from "./Title";

package/dist/contexts/FormUI/FormUIProvider.d.ts

@@ -0,0 +1,6 @@
+import React from "react";
+type FormUIProviderProps = {
+    children: React.ReactNode;
+};
+export declare const FormUIProvider: ({ children }: FormUIProviderProps) => React.JSX.Element;
+export {};

package/dist/contexts/FormUI/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./useFormUIContext.ts";
+export * from "./FormUIProvider.tsx";
+export { type FormUIFields } from "./useFormUI.ts";

package/dist/contexts/FormUI/useFormUI.d.ts

@@ -0,0 +1,137 @@
+import { ButtonKey, ErrorKey, TextKey, TitleKey } from "i18n/types";
+import { TaxDocumentation, TaxDocumentationKey } from "types/TaxDocumentation";
+export type FormUIFields = {
+    [key in TaxDocumentationKey]?: string | undefined;
+};
+type FormUIErrors = {
+    [key in TaxDocumentationKey]: ErrorKey;
+};
+type FormUIRequired = {
+    [key in TaxDocumentationKey]?: boolean;
+};
+export declare const useFormUI: () => {
+    fields: TaxDocumentation;
+    setValue: (key: TaxDocumentationKey, value: string | undefined) => void;
+    errors: FormUIErrors;
+    isErrorFree: boolean;
+    showErrors: boolean;
+    exposeErrors: () => void;
+    hideErrors: () => void;
+    requiredFields: FormUIRequired;
+    getLocalButton: (key: ButtonKey) => string;
+    getLocalCaProvince: (key: string | undefined) => string;
+    getLocalCountry: (key: string | undefined) => string;
+    getLocalError: (key: ErrorKey) => string;
+    getLocalHint: (key: TaxDocumentationKey) => string | undefined;
+    getLocalOption: (key: string | undefined) => string | undefined;
+    getLocalPrompt: (key: TaxDocumentationKey) => string;
+    getLocalSubPrompt: (key: TaxDocumentationKey) => string;
+    getLocalText: (key: TextKey) => string;
+    getLocalTitle: (key: TitleKey) => string;
+    getLocalUsState: (key: string | undefined) => string;
+    getRequiredLocalPrompt: (key: TaxDocumentationKey) => string;
+    visibleQuestions: {
+        exemptPayeeCode: boolean;
+        exemptFatcaCode: boolean;
+        iAcknowlegeESignIsOk: boolean;
+        iAmACitizenOfTheUs: boolean;
+        iAmExemptFromFatcaReporting: boolean;
+        iAmNotSubjectToBackupWithholding: boolean;
+        iAuthorizeWithholdingAgent: boolean;
+        iCertifyToAll: boolean;
+        iConfirmIncomeIsNonUs: boolean;
+        iConfirmTheBeneficialOwnerIsExempt: boolean;
+        iConfirmTheEntityIsNotAUsPerson: boolean;
+        iConfirmTheEntityIsTheBeneficialOwner: boolean;
+        iConfirmTheTaxIdIsCorrect: boolean;
+        iHaveLegalCapacityToSign: boolean;
+        regardedOwnerUsPerson: boolean;
+        signature: boolean;
+        accountHolderAddressCity: boolean;
+        accountHolderAddressCountry: boolean;
+        accountHolderAddressState: boolean;
+        accountHolderAddressStreet2: boolean;
+        accountHolderAddressStreet: boolean;
+        accountHolderAddressZip: boolean;
+        accountHolderCityOfBirth: boolean;
+        accountHolderCountryOfBirth: boolean;
+        accountHolderCountryOfCitizenship: boolean;
+        accountHolderDateOfBirth: boolean;
+        accountHolderDbaName: boolean;
+        accountHolderMailingAddressCity: boolean;
+        accountHolderMailingAddressCountry: boolean;
+        accountHolderMailingAddressIsDifferent: boolean;
+        accountHolderMailingAddressState: boolean;
+        accountHolderMailingAddressStreet2: boolean;
+        accountHolderMailingAddressStreet: boolean;
+        accountHolderMailingAddressZip: boolean;
+        accountHolderName: boolean;
+        accountHolderFinancialAccountIdentifier: boolean;
+        accountHolderFinancialAccountName: boolean;
+        accountHolderForeignTin: boolean;
+        accountHolderForeignTinIsNotRequired: boolean;
+        accountHolderTaxResidenceCountry1: boolean;
+        accountHolderTaxResidenceForeignTin1: boolean;
+        accountHolderTaxResidenceForeignTin1IsNotRequired: boolean;
+        accountHolderTaxResidenceCountry2: boolean;
+        accountHolderTaxResidenceForeignTin2: boolean;
+        accountHolderTaxResidenceForeignTin2IsNotRequired: boolean;
+        accountHolderTaxResidenceCountry3: boolean;
+        accountHolderTaxResidenceForeignTin3: boolean;
+        accountHolderTaxResidenceForeignTin3IsNotRequired: boolean;
+        accountHolderTaxResidenceCountry4: boolean;
+        accountHolderTaxResidenceForeignTin4: boolean;
+        accountHolderTaxResidenceForeignTin4IsNotRequired: boolean;
+        accountHolderTaxResidenceCountry5: boolean;
+        accountHolderTaxResidenceForeignTin5: boolean;
+        accountHolderTaxResidenceForeignTin5IsNotRequired: boolean;
+        accountHolderShowTaxResidence2: boolean;
+        accountHolderShowTaxResidence3: boolean;
+        accountHolderShowTaxResidence4: boolean;
+        accountHolderShowTaxResidence5: boolean;
+        accountHolderUsTin: boolean;
+        accountHolderVatIdentificationNumber: boolean;
+        accountHolderVatCountry: boolean;
+        accountHolderIsIndividual: boolean;
+        accountHolderIsEuResident: boolean;
+        accountHolderUsPerson: boolean;
+        accountHolderUsAccountType: boolean;
+        accountHolderUsSmllcElection: boolean;
+        accountHolderUsLlcClassification: boolean;
+        accountHolderUsOtherClassification: boolean;
+        accountHolderUsTrustEstateEin: boolean;
+        accountHolderForeignAccountType: boolean;
+        accountHolderForeignTrustClassification: boolean;
+        accountHolderForeignOtherClassification: boolean;
+        regardedOwnerAddressCity: boolean;
+        regardedOwnerAddressCountry: boolean;
+        regardedOwnerAddressState: boolean;
+        regardedOwnerAddressStreet2: boolean;
+        regardedOwnerAddressStreet: boolean;
+        regardedOwnerAddressZip: boolean;
+        regardedOwnerCountryOfCitizenship: boolean;
+        regardedOwnerDateOfBirth: boolean;
+        regardedOwnerDbaName: boolean;
+        regardedOwnerMailingAddressCity: boolean;
+        regardedOwnerMailingAddressCountry: boolean;
+        regardedOwnerMailingAddressIsDifferent: boolean;
+        regardedOwnerMailingAddressState: boolean;
+        regardedOwnerMailingAddressStreet2: boolean;
+        regardedOwnerMailingAddressStreet: boolean;
+        regardedOwnerMailingAddressZip: boolean;
+        regardedOwnerName: boolean;
+        regardedOwnerUsAccountType: boolean;
+        regardedOwnerUsLlcClassification: boolean;
+        regardedOwnerUsOtherClassification: boolean;
+        regardedOwnerUsTrustEstateEin: boolean;
+        regardedOwnerForeignAccountType: boolean;
+        regardedOwnerForeignTrustClassification: boolean;
+        regardedOwnerForeignOtherClassification: boolean;
+        regardedOwnerForeignTin: boolean;
+        regardedOwnerForeignTinIsNotRequired: boolean;
+        regardedOwnerUsTin: boolean;
+    };
+    hideField: (key: TaxDocumentationKey) => void;
+    showField: (key: TaxDocumentationKey) => void;
+};
+export {};