@taxbit/react-sdk 3.2.1-beta.0 → 3.3.0-beta.0

package/README.md

@@ -376,6 +376,10 @@ type QuestionnaireType = 'DPS' | 'W-FORM' | 'SELF-CERT';
 
 ## Changelog
 
+### Version 3.3.0-beta.0
+
+- **Proxy Headers**: New `proxyHeaders` prop allows passing custom HTTP headers through to all API requests, enabling support for proxy configurations and custom authentication schemes
+
 ### Version 3.2.1-beta.0
 
 - Bug fix, Fatca and Payee option text updated.

package/dist/src/contexts/TaxDocumentation/TaxbitQuestionnaireProvider.d.ts

@@ -4,5 +4,5 @@ type TaxDocumentationProviderProps = UseTaxDocumentationProps & {
     children: React.ReactNode;
     treatyClaims?: boolean;
 };
-export declare const TaxbitQuestionnaireProvider: ({ data, externalValidations, onSubmit, onProgress, language, questionnaire, step, children, config, treatyClaims, dateFormat, realTimeTinValidation, staging, bearerToken, adaptiveMode, }: TaxDocumentationProviderProps) => React.JSX.Element;
+export declare const TaxbitQuestionnaireProvider: ({ data, externalValidations, onSubmit, onProgress, language, questionnaire, step, children, config, treatyClaims, dateFormat, realTimeTinValidation, staging, bearerToken, adaptiveMode, proxyHeaders, proxyDomain, }: TaxDocumentationProviderProps) => React.JSX.Element;
 export {};

package/dist/src/contexts/TaxDocumentation/useTaxDocumentation.d.ts

@@ -1,11 +1,11 @@
 import { ClientTaxDocumentation } from '@taxbit/utilities';
 import { InputStep, Locale, Progress, QuestionnaireProp, TaxDocumentation, TaxDocumentationKey } from 'types';
 import { ExternalValidations } from 'types/client';
+import { AdaptiveMode } from '../../types/props';
 type InterviewConfig = {
     minimumAge: number;
 };
 export type DateFormatConfig = 'dmy' | 'mdy' | 'ymd';
-type AdaptiveMode = 'full' | 'skipEdit' | 'skipLock';
 export type UseTaxDocumentationProps = {
     data?: ClientTaxDocumentation;
     language?: Locale;
@@ -22,9 +22,10 @@ export type UseTaxDocumentationProps = {
     bearerToken?: string;
     region?: 'US' | 'EU' | string;
     proxyDomain?: string;
+    proxyHeaders?: Record<string, string>;
     adaptiveMode?: AdaptiveMode;
 };
-export declare const useTaxDocumentation: ({ data: startingData, language: initialLanguage, externalValidations, onSubmit, onProgress, step: initialStep, questionnaire, config, treatyClaims, dateFormat, realTimeTinValidation, staging, bearerToken, region, proxyDomain, adaptiveMode, }: UseTaxDocumentationProps) => {
+export declare const useTaxDocumentation: ({ data: startingData, language: initialLanguage, externalValidations, onSubmit, onProgress, step: initialStep, questionnaire, config, treatyClaims, dateFormat, realTimeTinValidation, staging, bearerToken, region, proxyDomain, proxyHeaders, adaptiveMode, }: UseTaxDocumentationProps) => {
     adaptiveMode: AdaptiveMode | undefined;
     config: InterviewConfig | undefined;
     data: TaxDocumentation;

package/dist/src/contexts/TaxDocumentation/useTaxDocumentationContext.d.ts

@@ -1,5 +1,5 @@
 export declare const useTaxDocumentationContext: () => {
-    adaptiveMode: ("full" | "skipEdit" | "skipLock") | undefined;
+    adaptiveMode: import('../../types/props').AdaptiveMode | undefined;
     config: {
         minimumAge: number;
     } | undefined;
@@ -34,7 +34,7 @@ export declare const useTaxDocumentationContext: () => {
     setIsEditing: import('react').Dispatch<import('react').SetStateAction<boolean>>;
     canShowField: (fieldName: import('../../types').TaxDocumentationKey) => boolean;
 }, TaxDocumentationContextProvider: import('react').Provider<{
-    adaptiveMode: ("full" | "skipEdit" | "skipLock") | undefined;
+    adaptiveMode: import('../../types/props').AdaptiveMode | undefined;
     config: {
         minimumAge: number;
     } | undefined;

package/dist/src/hooks/useTaxbit/useTaxbit.d.ts

@@ -1,20 +1,23 @@
 import { QuestionnaireProp } from 'types';
-type UseTaxbitProps = {
+import { SafeProxyHeaders } from '../../types/props';
+type UseTaxbitProps<TProxyHeaders extends Record<string, string>> = {
     bearerToken: string;
     questionnaire: QuestionnaireProp;
     staging?: boolean;
     onError?: (error: Error) => void | Promise<void>;
     region?: 'US' | 'EU' | string;
     proxyDomain?: never;
+    proxyHeaders?: never;
 } | {
     bearerToken: string;
     questionnaire: QuestionnaireProp;
     staging?: never;
     region?: never;
     proxyDomain?: string;
+    proxyHeaders?: SafeProxyHeaders<TProxyHeaders>;
     onError?: (error: Error) => void | Promise<void>;
 };
-export declare const useTaxbit: ({ bearerToken, questionnaire, staging, onError, region, proxyDomain, }: UseTaxbitProps) => {
+export declare const useTaxbit: <TProxyHeaders extends Record<string, string>>({ bearerToken, questionnaire, staging, onError, region, proxyDomain, proxyHeaders, }: UseTaxbitProps<TProxyHeaders>) => {
     serverData: import('@taxbit/utilities').SignedClientTaxDocumentation | undefined;
     statusData: import('../..').ClientTaxDocumentationStatus | undefined;
     canGetDocumentUrl: boolean;

package/dist/src/hooks/useTaxbit/useTaxbitStatus.d.ts

@@ -8,8 +8,9 @@ type UseTaxbitStatusProps = {
     staging?: boolean;
     region?: 'US' | 'EU' | string;
     proxyDomain?: string;
+    proxyHeaders?: Record<string, string>;
 };
-export declare const useTaxbitStatus: ({ bearerToken, questionnaire, staging, onError, region, proxyDomain, }: UseTaxbitStatusProps) => {
+export declare const useTaxbitStatus: ({ bearerToken, questionnaire, staging, onError, region, proxyDomain, proxyHeaders, }: UseTaxbitStatusProps) => {
     serverData: SignedClientTaxDocumentation | undefined;
     statusData: ClientTaxDocumentationStatus | undefined;
     isLoading: boolean;

package/dist/src/hooks/useUsTinVerification/useUsTinValidation.d.ts

@@ -13,8 +13,9 @@ type UseUsTinValidationProps = {
     staging?: boolean;
     region?: 'US' | 'EU' | string;
     proxyDomain?: string;
+    proxyHeaders?: Record<string, string>;
 };
-export declare const useUsTinValidation: ({ bearerToken, isEnabled, staging, region, proxyDomain, }: UseUsTinValidationProps) => {
+export declare const useUsTinValidation: ({ bearerToken, isEnabled, staging, region, proxyDomain, proxyHeaders, }: UseUsTinValidationProps) => {
     doValidateUsTin: (name: string, usTin: string) => Promise<void>;
     isValidatingUsTin: boolean;
     usTinValidations: UsTinValidationAttempt[];

package/dist/src/i18n/json/enDPS.d.ts

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

package/dist/src/i18n/locales/bg.d.ts

@@ -1 +1,2 @@
-export declare const bg: import('../types/PropertyFile').PropertyFile;
+import { LanguageWithProperties } from '../types/Language';
+export declare const bg: LanguageWithProperties;

package/dist/src/i18n/locales/cs.d.ts

@@ -1 +1,2 @@
-export declare const cs: import('../types/PropertyFile').PropertyFile;
+import { LanguageWithProperties } from '../types/Language';
+export declare const cs: LanguageWithProperties;

package/dist/src/i18n/locales/da.d.ts

@@ -1 +1,2 @@
-export declare const da: import('../types/PropertyFile').PropertyFile;
+import { LanguageWithProperties } from '../types/Language';
+export declare const da: LanguageWithProperties;

package/dist/src/i18n/locales/de-at.d.ts

@@ -1 +1,2 @@
-export declare const deAt: import('../types/PropertyFile').PropertyFile;
+import { LanguageWithProperties } from '../types/Language';
+export declare const deAt: LanguageWithProperties;

package/dist/src/i18n/locales/de-de.d.ts

@@ -1,2 +1,2 @@
-import { PropertyFile } from '../types/PropertyFile';
-export declare const deDe: PropertyFile;
+import { LanguageWithProperties } from '../types/Language';
+export declare const deDe: LanguageWithProperties;

package/dist/src/i18n/locales/de.d.ts

@@ -1,2 +1,2 @@
-import { PropertyFile } from '../types/PropertyFile';
-export declare const de: PropertyFile;
+import { LanguageWithProperties } from '../types/Language';
+export declare const de: LanguageWithProperties;

package/dist/src/i18n/locales/el-cy.d.ts

@@ -1 +1,2 @@
-export declare const elCy: import('../types/PropertyFile').PropertyFile;
+import { LanguageWithProperties } from '../types/Language';
+export declare const elCy: LanguageWithProperties;

package/dist/src/i18n/locales/el-el.d.ts

@@ -1 +1,2 @@
-export declare const elEl: import('../types/PropertyFile').PropertyFile;
+import { LanguageWithProperties } from '../types/Language';
+export declare const elEl: LanguageWithProperties;

package/dist/src/i18n/locales/el.d.ts

@@ -1 +1,2 @@
-export declare const el: import('../types/PropertyFile').PropertyFile;
+import { LanguageWithProperties } from '../types/Language';
+export declare const el: LanguageWithProperties;

package/dist/src/i18n/locales/en-dps.d.ts

@@ -1,2 +1,2 @@
-import { ForeignPropertyFile } from '../types/PropertyFile';
-export declare const enDPS: ForeignPropertyFile;
+import { ForeignLanguage } from '../types/Language';
+export declare const enDPS: ForeignLanguage;

package/dist/src/i18n/locales/en-gb.d.ts

@@ -1 +1,2 @@
-export declare const enGb: import('../types/PropertyFile').PropertyFile;
+import { LanguageWithProperties } from '../types/Language';
+export declare const enGb: LanguageWithProperties;

package/dist/src/i18n/locales/en-nz.d.ts

@@ -1 +1,2 @@
-export declare const enNz: import('../types/PropertyFile.ts').PropertyFile;
+import { LanguageWithProperties } from '../types/Language';
+export declare const enNz: LanguageWithProperties;

package/dist/src/i18n/locales/en-us.d.ts

@@ -1 +1,2 @@
-export declare const enUs: import('../types/PropertyFile').PropertyFile;
+import { LanguageWithProperties } from '../types/Language';
+export declare const enUs: LanguageWithProperties;

package/dist/src/i18n/locales/en.d.ts

@@ -1,2 +1,2 @@
-import { PropertyFile } from '../types/PropertyFile';
-export declare const en: PropertyFile;
+import { LanguageWithProperties } from '../types/Language';
+export declare const en: LanguageWithProperties;