@gusto/embedded-react-sdk 0.55.6 → 0.55.7

package/dist/{components → src/components}/Payroll/PayrollEditEmployee/shared/usePayrollEditEmployeeForm/usePayrollEditEmployeeForm.d.ts

@@ -4,7 +4,8 @@ import { PayrollEmployeeCompensationsType } from '@gusto/embedded-api/models/com
 import { PayrollPrepared } from '@gusto/embedded-api/models/components/payrollshow';
 import { PayScheduleShow } from '@gusto/embedded-api/models/components/payscheduleshow';
 import { PayrollEditEmployeeFormData } from './payrollEditEmployeeSchema';
-import { PayrollEditEmployeeFields, ReimbursementRow } from './fields';
+import { NormalizedWorkweek } from './payrollEditEmployeeHelpers';
+import { PayrollEditEmployeeErrorMessages, PayrollEditEmployeeFields, ReimbursementRow } from './fields';
 import { BaseFormHookReady, FieldMetadata, FieldMetadataWithOptions, HookLoadingResult, HookSubmitResult } from '../../../../../partner-hook-utils/types';
 /**
  * Options accepted by {@link usePayrollEditEmployeeForm}.
@@ -29,6 +30,13 @@ export interface UsePayrollEditEmployeeFormProps {
     validationMode?: UseFormProps['mode'];
     /** Auto-focus the first invalid field on submit. Defaults to `true`. Set to `false` when composing with other forms. */
     shouldFocusError?: boolean;
+    /**
+     * Display copy for each validation error code, baked into every bound field so
+     * it resolves and renders its own message. Supply it once, keyed by
+     * {@link PayrollEditEmployeeErrorCodes}; a missing code falls back to the raw
+     * code. Omit it to render raw codes.
+     */
+    errorMessages?: PayrollEditEmployeeErrorMessages;
 }
 /**
  * Field metadata for {@link usePayrollEditEmployeeForm}, keyed by full form path.
@@ -60,8 +68,26 @@ export interface UsePayrollEditEmployeeFormReady extends BaseFormHookReady<Payro
         paySchedule?: PayScheduleShow;
         /** Whether the pay period spans more than one workweek. Raw workweeks are on `preparedPayroll.workweeks`. */
         isMultipleWorkweeks: boolean;
+        /**
+         * The pay period's normalized workweeks (`{ startDate, endDate }` strings),
+         * in order — one entry, spanning the pay period, when it's a single
+         * workweek. The per-workweek split fields are keyed by start date only, so
+         * this is the source for each column's date range.
+         */
+        workweeks: NormalizedWorkweek[];
         /** Whether the employee is overtime-eligible (nonexempt family). Drives whether hours split by workweek. */
         isOvertimeEligible: boolean;
+        /**
+         * The single, form-wide overtime-mode flag. `false` renders one flat
+         * column per line with Overtime/Double-overtime rows hidden; `true`
+         * splits hours and overtime-affecting earnings into per-workweek columns
+         * (for overtime-eligible employees on a multi-workweek payroll) and
+         * un-hides those rows. Starts `true` when the employee already has real
+         * overtime hours or matching per-workweek breakdowns (see
+         * `hasExistingOvertimeHours`, `hasBreakdownsMatchingWorkweeks`), or after
+         * `actions.addOvertime` is called; otherwise starts `false`.
+         */
+        withOvertime: boolean;
         /** Whether the employee has a direct-deposit bank account set up. */
         hasDirectDepositSetup: boolean;
         /**
@@ -81,6 +107,17 @@ export interface UsePayrollEditEmployeeFormReady extends BaseFormHookReady<Payro
     actions: {
         /** Validates and submits the form, resolving to the updated prepared payroll on success or `undefined` when validation blocked the submit. */
         onSubmit: () => Promise<HookSubmitResult<PayrollPrepared> | undefined>;
+        /**
+         * Sets `data.withOvertime` to `true`, switching the whole form to the
+         * workweek split: un-hides Overtime/Double-overtime rows and splits hours
+         * and overtime-affecting earnings into per-workweek columns. Populates
+         * only the first workweek cell of each line with that line's current
+         * total, leaving every other cell blank — no auto distribution — so the
+         * per-row validation then requires the user to fill in the rest. One
+         * affordance for the whole employee, not one per job. One-directional —
+         * there's no corresponding "remove overtime" action.
+         */
+        addOvertime: () => void;
         /** Reveals the draft reimbursement row. Present only when reimbursement controls are exposed. */
         beginAddReimbursement?: () => void;
         /** Validates the draft and commits it to the reimbursement list, or flags the draft amount if invalid. Present only when reimbursement controls are exposed. */
@@ -113,14 +150,16 @@ export type UsePayrollEditEmployeeFormResult = HookLoadingResult | UsePayrollEdi
  * @remarks
  * Prepares the payroll for the target employee, then exposes a workweek-keyed
  * form whose submit builds a `PayrollUpdate`. Single-workweek pay periods send
- * totals without `breakdowns`; multi-workweek pay periods send `breakdowns`
- * tiling every workweek exactly. Overtime-eligible (nonexempt) employees split
- * hours and overtime-affecting earnings per workweek; everyone else edits flat
- * totals.
+ * totals without `breakdowns`; multi-workweek pay periods send `breakdowns` per
+ * line once that line's every workweek cell is filled. Overtime-eligible
+ * (nonexempt) employees split hours and overtime-affecting earnings per
+ * workweek while the single `data.withOvertime` flag is on (see
+ * `actions.addOvertime`); everyone else, and every line while `withOvertime` is
+ * off, edits flat totals.
  *
  * @param props - Hook options.
  * @returns A loading result while data is fetching, or a ready result with data,
  * fields, status, actions, and error handling.
  * @public
  */
-export declare function usePayrollEditEmployeeForm({ employeeId, companyId, payrollId, withReimbursements, validationMode, shouldFocusError, }: UsePayrollEditEmployeeFormProps): UsePayrollEditEmployeeFormResult;
+export declare function usePayrollEditEmployeeForm({ employeeId, companyId, payrollId, withReimbursements, validationMode, shouldFocusError, errorMessages, }: UsePayrollEditEmployeeFormProps): UsePayrollEditEmployeeFormResult;

package/dist/{components → src/components}/Payroll/PayrollOverview/PayrollOverviewPresentation.d.ts

@@ -7,6 +7,7 @@ import { PayrollOverviewStatus } from './PayrollOverviewTypes';
 import { PaginationControlProps } from '../../Common/PaginationControl/PaginationControlTypes';
 interface PayrollOverviewProps {
     payrollData: PayrollShow;
+    employeeFlsaStatusByUuid?: Record<string, string | undefined>;
     bankAccount?: CompanyBankAccount;
     taxes: Record<string, {
         employee: number;
@@ -33,5 +34,5 @@ interface PayrollOverviewProps {
     downloadingEmployeeIds?: ReadonlySet<string>;
 }
 /** @internal */
-export declare const PayrollOverviewPresentation: ({ onEdit, onSubmit, onCancel, onPayrollReceipt, onPaystubDownload, payrollData, bankAccount, taxes, status, isProcessed, canCancel, canEdit, alerts, submissionBlockers, selectedUnblockOptions, onUnblockOptionChange, wireInConfirmationRequest, printChecksBanner, withReimbursements, paymentSpeed, pagination, downloadingEmployeeIds, }: PayrollOverviewProps) => import("react").JSX.Element;
+export declare const PayrollOverviewPresentation: ({ onEdit, onSubmit, onCancel, onPayrollReceipt, onPaystubDownload, payrollData, employeeFlsaStatusByUuid, bankAccount, taxes, status, isProcessed, canCancel, canEdit, alerts, submissionBlockers, selectedUnblockOptions, onUnblockOptionChange, wireInConfirmationRequest, printChecksBanner, withReimbursements, paymentSpeed, pagination, downloadingEmployeeIds, }: PayrollOverviewProps) => import("react").JSX.Element;
 export {};

package/dist/src/components/Payroll/UNSTABLE_PayrollEditEmployee/UNSTABLE_PayrollEditEmployee.d.ts

@@ -0,0 +1,20 @@
+import { PayrollEditEmployeeProps } from '../PayrollEditEmployee/PayrollEditEmployee';
+/**
+ * In-development regular-rate-of-pay rebuild of {@link PayrollEditEmployee}.
+ *
+ * @remarks
+ * Gated behind the `payrollRegularRateOfPay` unstable feature flag and not part of the public
+ * SDK surface. `PayrollEditEmployee` renders this in place of the stable editor when the flag is
+ * enabled. Consumes {@link usePayrollEditEmployeeForm} and renders the header, the hours /
+ * additional-earnings / time-off / other / payment-method sections, and the
+ * `Cancel`/`Save` controls, performing a real payroll update on save. For an overtime-eligible
+ * employee on a multi-workweek payroll, Overtime/Double-overtime rows start hidden behind a single,
+ * employee-level "Add overtime" control (`form.data.withOvertime` / `form.actions.addOvertime`)
+ * unless the employee already has real overtime hours or matching per-workweek breakdowns; adding
+ * overtime also switches hours and overtime-affecting earnings to per-workweek columns and surfaces
+ * the per-row "fill in every workweek" validation. `Cancel` and `Save` emit the same events as the
+ * stable component so the surrounding flow behaves identically.
+ *
+ * @internal
+ */
+export declare function UNSTABLE_PayrollEditEmployee({ FallbackComponent, LoaderComponent, ...props }: PayrollEditEmployeeProps): import("react").JSX.Element;

package/dist/{contexts → src/contexts}/ApiProvider/apiVersion.d.ts

@@ -10,6 +10,17 @@
  * @internal
  */
 export declare const API_VERSION = "2026-06-15";
+/**
+ * SDK package name and version, sent on every request via the `X-Gusto-SDK-Version`
+ * header so backend traffic can be attributed to a specific SDK release.
+ *
+ * @remarks
+ * Read directly from `package.json` so it always matches the published package —
+ * no manual bump required.
+ *
+ * @internal
+ */
+export declare const SDK_VERSION: string;
 /**
  * TanStack Query namespace the embedded-api client prefixes onto every generated
  * query and mutation key (segment 1 of every key it emits).

package/dist/{helpers → src/helpers}/dateFormatting.d.ts

@@ -153,6 +153,15 @@ export declare const getDaysUntil: (deadline?: Date | string | null) => number |
  * @internal
  */
 export declare const addDays: (date: Date, days: number) => Date;
+/**
+ * Returns a new `Date` offset by a given number of years.
+ *
+ * @param date - The base date. Not mutated.
+ * @param years - Number of years to add (negative values subtract).
+ * @returns A new `Date` shifted by `years`.
+ * @internal
+ */
+export declare const addYears: (date: Date, years: number) => Date;
 /**
  * Returns a new `Date` offset by a given number of business days (Monday–Friday).
  *

package/dist/{helpers → src/helpers}/formattedStrings.d.ts

@@ -2,18 +2,19 @@ import { Location } from '@gusto/embedded-api/models/components/location';
 import { EmployeeAddress } from '@gusto/embedded-api/models/components/employeeaddress';
 import { TFunction } from 'i18next';
 /**
- * Joins a first and last name into a single capitalized display string.
+ * Joins a first, middle initial, and last name into a single capitalized display string.
  *
  * @remarks Each name part is capitalized at its first character. A space is
- * inserted between the parts only when the last name is present. Missing
- * parts are treated as empty.
+ * inserted before the middle initial and last name only when that part is
+ * present. Missing parts are treated as empty.
  *
- * @param name - Object with optional `first_name` and `last_name` fields.
- * @returns The combined name, e.g. `Jane Doe`, `Jane`, or `''`.
+ * @param name - Object with optional `first_name`, `middle_initial`, and `last_name` fields.
+ * @returns The combined name, e.g. `Jane M Doe`, `Jane Doe`, `Jane`, or `''`.
  * @internal
  */
-export declare const firstLastName: ({ first_name, last_name, }: {
+export declare const firstLastName: ({ first_name, middle_initial, last_name, }: {
     first_name?: string | null;
+    middle_initial?: string | null;
     last_name?: string | null;
 }) => string;
 /**

package/dist/{i18n → src/i18n}/types.d.ts

@@ -2631,9 +2631,9 @@ export namespace Translations {
       /** @defaultValue `"Profile updated"` */
       successAlert: string
       validations: {
-        /** @defaultValue `"First name is required"` */
+        /** @defaultValue `"Enter a valid first name"` */
         firstName: string
-        /** @defaultValue `"Last name is required"` */
+        /** @defaultValue `"Enter a valid last name"` */
         lastName: string
         /** @defaultValue `"Business name is required"` */
         businessName: string
@@ -2654,6 +2654,8 @@ export namespace Translations {
     title: string
     /** @defaultValue `"Add contractor"` */
     addContractorCta: string
+    /** @defaultValue `"Back to contractors"` */
+    backToListCta: string
     /** @defaultValue `"Contractor status tabs"` */
     tabsLabel: string
     tabs: {
@@ -7034,8 +7036,6 @@ export namespace Translations {
       checkDateRequired: string
       /** @defaultValue `"End date must be on or after start date"` */
       endDateAfterStart: string
-      /** @defaultValue `"Start date cannot be in the future for correction payrolls"` */
-      startDateNotFuture: string
       /** @defaultValue `"Payment date must be at least {{count}} business day from today for direct deposit"` */
       checkDateAchLeadTime_one: string
       /** @defaultValue `"Payment date must be at least {{count}} business days from today for direct deposit"` */
@@ -8382,14 +8382,14 @@ export namespace Translations {
     pageTitle: string
     /** @defaultValue `"{{firstName}} {{lastName}}"` */
     breadcrumbLabel: string
-    /** @defaultValue `"Gross pay (excluding reimbursements)"` */
-    grossPayLabel: string
-    /** @defaultValue `"Gross pay: {{grossPay}} (excluding reimbursements)"` */
-    grossPayLabelMobile: string
     /** @defaultValue `"Regular and overtime hours"` */
     regularHoursTitle: string
     /** @defaultValue `"Regular hours"` */
     regularHoursTitleWithoutOvertime: string
+    /** @defaultValue `"Add overtime"` */
+    addOvertimeCta: string
+    /** @defaultValue `"When adding overtime hours, you must record hours and earnings by work week so {{employeeName}}'s pay is calculated correctly."` */
+    overtimeWorkweekAlert: string
     /** @defaultValue `"Hours"` */
     hoursUnit: string
     /** @defaultValue `"Save"` */
@@ -8497,6 +8497,8 @@ export namespace Translations {
       reimbursementAmount: string
       /** @defaultValue `"Amount cannot be negative"` */
       negativeAmount: string
+      /** @defaultValue `"Enter an amount for every workweek"` */
+      requiredWorkweek: string
     }
   }
   /** Translation keys for the `Payroll.WireInstructions` i18n namespace. */

package/dist/src/index.d.ts

@@ -0,0 +1,70 @@
+export * from './components';
+export * from './contexts';
+/**
+ * Entity types returned by the Gusto Embedded Payroll API.
+ *
+ * @remarks
+ * Re-exported from `@gusto/embedded-api` for use in SDK hook results and component props.
+ * Properties are camelCase — the underlying API returns snake_case JSON, but the Typescript
+ * client normalizes them.
+ *
+ * @public
+ */
+export type * as APIModels from './models/external';
+export type { WARiskClassCode } from './models/WA_RISK_CODES';
+export { componentEvents, EmployeeOnboardingStatus, EmployeeSelfOnboardingStatuses, ContractorOnboardingStatus, ContractorSelfOnboardingStatuses, PAY_PERIODS, I9_FORM_NAME, STATES_ABBR, } from './shared/constants';
+export type { EventType, StateAbbreviation } from './shared/constants';
+export type { BeforeCreateRequestHook, BeforeRequestHook, AfterSuccessHook, AfterErrorHook, BeforeCreateRequestContext, BeforeRequestContext, AfterSuccessContext, AfterErrorContext, SDKHooks, } from './types/hooks';
+export type { SDKError, SDKErrorCategory, SDKFieldError } from './types/sdkError';
+export { SDKErrorCategories } from './types/sdkError';
+export type { ObservabilityHook, ObservabilityError, ObservabilityMetric, ObservabilityMetricUnit, SanitizationConfig, } from './types/observability';
+export type { BaseComponentInterface, CommonComponentInterface, LoaderComponentType, OnEventType, } from './components/Base';
+export type { ResourceDictionary, GlobalResourceDictionary, Resources, Translations, DeepPartial, SupportedLanguages, DataAttributes, RequireAtLeastOne, } from './types/Helpers';
+export { composeErrorHandler, SDKFormProvider, composeSubmitHandler } from './partner-hook-utils';
+export type { MixedErrorSource, QueryWithRefetch, SubmitStateForErrorHandling, SDKFormProviderProps, ComposeSubmitInput, ComposeSubmitHandlerResult, ComposableFormHookResult, HookFormInternals, HookLoadingResult, HookSubmitResult, HookErrorHandling, BaseHookReady, BaseFormHookReady, FormHookResult, FieldMetadata, FieldMetadataWithOptions, FieldsMetadata, ValidationMessages, BaseFieldProps, HookFieldProps, InputProps, TextInputHookFieldProps, SelectHookFieldProps, CheckboxHookFieldProps, NumberInputHookFieldProps, DatePickerHookFieldProps, RadioGroupHookFieldProps, SwitchHookFieldProps, SharedFieldLayoutProps, SharedHorizontalFieldLayoutProps, TextInputProps, SelectProps, SelectOption, CheckboxProps, NumberInputProps, DatePickerProps, RadioGroupProps, RadioGroupOption, SwitchProps, } from './partner-hook-utils';
+export { useDeductionForm, DeductionFormErrorCodes, } from './components/Employee/Deductions/shared/useDeductionForm';
+export type { UseDeductionFormProps, UseDeductionFormResult, UseDeductionFormReady, DeductionFormFields, DeductionFormFieldsMetadata, DeductionFormErrorCode, DeductionFormOptionalFieldsToRequire, DeductionFormData, DeductionFormRequiredValidation, DeductionFormNegativeAmountValidation, DeductionFormAmountValidation, DeductionFormCapValidation, DescriptionFieldProps, RecurringFieldProps, DeductAsPercentageFieldProps, AmountFieldProps as DeductionAmountFieldProps, TotalAmountFieldProps, AnnualMaximumFieldProps, GarnishmentTypeFieldProps, } from './components/Employee/Deductions/shared/useDeductionForm';
+export { useChildSupportGarnishmentForm, ChildSupportGarnishmentFormErrorCodes, SUPPORTED_REQUIRED_ATTR_KEYS, } from './components/Employee/Deductions/shared/useChildSupportGarnishmentForm';
+export type { UseChildSupportGarnishmentFormProps, UseChildSupportGarnishmentFormResult, UseChildSupportGarnishmentFormReady, ChildSupportGarnishmentFormFields, ChildSupportGarnishmentFormFieldsMetadata, ChildSupportGarnishmentFormErrorCode, ChildSupportGarnishmentFormData, SupportedRequiredAttrKey, ChildSupportGarnishmentRequiredValidation, ChildSupportGarnishmentNegativeAmountValidation, ChildSupportGarnishmentPercentValidation, PayPeriodMaximumValidation, ChildSupportGarnishmentAmountValidation, StateFieldEntry, CountyEntry, ChildSupportGarnishmentStateFieldProps, FipsCodeFieldProps, CaseNumberFieldProps, OrderNumberFieldProps, RemittanceNumberFieldProps, PayPeriodMaximumFieldProps, ChildSupportGarnishmentAmountFieldProps, PaymentPeriodFieldProps, } from './components/Employee/Deductions/shared/useChildSupportGarnishmentForm';
+export { useCompensationForm, CompensationErrorCodes, } from './components/Employee/Compensation/shared/useCompensationForm';
+export type { CompensationSubmitOptions, UseCompensationFormProps, UseCompensationFormResult, UseCompensationFormReady, CompensationFieldsMetadata, CompensationFormFields, CompensationErrorCode, CompensationOptionalFieldsToRequire, CompensationFormData, RequiredValidation as CompensationRequiredValidation, RateValidation, EffectiveDateValidation as CompensationEffectiveDateValidation, TitleFieldProps as CompensationTitleFieldProps, EffectiveDateFieldProps as CompensationEffectiveDateFieldProps, FlsaStatusFieldProps, RateFieldProps, PaymentUnitFieldProps, AdjustForMinimumWageFieldProps, MinimumWageIdFieldProps, } from './components/Employee/Compensation/shared/useCompensationForm';
+export { useJobForm, JobErrorCodes } from './components/Employee/Compensation/shared/useJobForm';
+export type { JobSubmitOptions, UseJobFormProps, UseJobFormResult, UseJobFormReady, JobFieldsMetadata, JobFormFields, JobErrorCode, JobOptionalFieldsToRequire, JobFormData, JobRequiredValidation, JobTitleFieldProps, HireDateFieldProps, TwoPercentShareholderFieldProps, StateWcCoveredFieldProps, StateWcClassCodeFieldProps, } from './components/Employee/Compensation/shared/useJobForm';
+export { useEmployeeDetailsForm, EmployeeDetailsErrorCodes, } from './components/Employee/Profile/shared/useEmployeeDetailsForm';
+export type { EmployeeDetailsSubmitCallbacks, EmployeeDetailsOptionalFieldsToRequire, UseEmployeeDetailsFormSharedProps, UseEmployeeDetailsFormProps, UseEmployeeDetailsFormResult, UseEmployeeDetailsFormReady, EmployeeDetailsFieldsMetadata, EmployeeDetailsFormFields, EmployeeDetailsErrorCode, EmployeeDetailsFormData, EmployeeDetailsField, EmployeeDetailsRequiredValidation, NameValidation, EmailValidation, SsnValidation, FirstNameFieldProps, MiddleInitialFieldProps, LastNameFieldProps, EmailFieldProps, DateOfBirthFieldProps, SsnFieldProps, SelfOnboardingFieldProps, SsnRequiredValidation, } from './components/Employee/Profile/shared/useEmployeeDetailsForm';
+export { useContractorDetailsForm, ContractorType, WageType, ContractorDetailsErrorCodes, } from './components/Contractor/Profile/shared/useContractorDetailsForm';
+export type { ContractorDetailsSubmitOptions, ContractorDetailsOptionalFieldsToRequire, UseContractorDetailsFormSharedProps, UseContractorDetailsFormProps, UseContractorDetailsFormResult, UseContractorDetailsFormReady, ContractorDetailsFieldsMetadata, ContractorDetailsFormFields, ContractorDetailsErrorCode, ContractorDetailsFormData, ContractorDetailsRequiredValidation, ContractorDetailsMaxHourlyRateValidation, ContractorDetailsNameValidation, ContractorDetailsEmailValidation, ContractorDetailsSsnValidation, ContractorDetailsSsnRequiredValidation, ContractorDetailsEinValidation, ContractorDetailsEinRequiredValidation, TypeFieldProps as ContractorTypeFieldProps, WageTypeFieldProps as ContractorWageTypeFieldProps, StartDateFieldProps as ContractorStartDateFieldProps, HourlyRateFieldProps as ContractorHourlyRateFieldProps, SelfOnboardingFieldProps as ContractorSelfOnboardingFieldProps, FileNewHireReportFieldProps as ContractorFileNewHireReportFieldProps, EmailFieldProps as ContractorEmailFieldProps, FirstNameFieldProps as ContractorFirstNameFieldProps, LastNameFieldProps as ContractorLastNameFieldProps, MiddleInitialFieldProps as ContractorMiddleInitialFieldProps, BusinessNameFieldProps as ContractorBusinessNameFieldProps, SsnFieldProps as ContractorSsnFieldProps, EinFieldProps as ContractorEinFieldProps, WorkStateFieldProps as ContractorWorkStateFieldProps, } from './components/Contractor/Profile/shared/useContractorDetailsForm';
+export { useContractorBankAccountForm, ContractorBankAccountErrorCodes, ACCOUNT_TYPES as ContractorBankAccountTypes, } from './components/Contractor/PaymentMethod/shared/useContractorBankAccountForm';
+export type { UseContractorBankAccountFormProps, UseContractorBankAccountFormResult, UseContractorBankAccountFormReady, ContractorBankAccountFormFields, ContractorBankAccountFieldsMetadata, ContractorBankAccountErrorCode, ContractorAccountType, ContractorBankAccountFormData, ContractorBankAccountFormField, ContractorBankAccountOptionalFieldsToRequire, ContractorBankAccountRequiredValidation, ContractorBankAccountRoutingNumberValidation, ContractorBankAccountAccountNumberValidation, NameFieldProps as ContractorBankAccountNameFieldProps, RoutingNumberFieldProps as ContractorBankAccountRoutingNumberFieldProps, AccountNumberFieldProps as ContractorBankAccountAccountNumberFieldProps, AccountTypeFieldProps as ContractorBankAccountAccountTypeFieldProps, } from './components/Contractor/PaymentMethod/shared/useContractorBankAccountForm';
+export { useContractorPaymentMethodForm, ContractorPaymentMethodErrorCodes, } from './components/Contractor/PaymentMethod/shared/useContractorPaymentMethodForm';
+export type { UseContractorPaymentMethodFormProps, UseContractorPaymentMethodFormResult, UseContractorPaymentMethodFormReady, ContractorPaymentMethodFormFields, ContractorPaymentMethodFieldsMetadata, ContractorPaymentMethodErrorCode, ContractorPaymentMethodFormType, ContractorPaymentMethodFormData, ContractorPaymentMethodFormField, TypeFieldProps as ContractorPaymentMethodTypeFieldProps, } from './components/Contractor/PaymentMethod/shared/useContractorPaymentMethodForm';
+export { useContractorPayForm, ContractorPayErrorCodes, WageType as ContractorPayWageType, } from './components/Contractor/Compensation/shared/useContractorPayForm';
+export type { UseContractorPayFormProps, UseContractorPayFormResult, UseContractorPayFormReady, ContractorPayFormFields, ContractorPayFieldsMetadata, ContractorPayErrorCode, ContractorPayFormData, ContractorPayFormField, RequiredValidation as ContractorPayRequiredValidation, MaxHourlyRateValidation as ContractorPayMaxHourlyRateValidation, WageTypeFieldProps as ContractorPayWageTypeFieldProps, HourlyRateFieldProps as ContractorPayHourlyRateFieldProps, } from './components/Contractor/Compensation/shared/useContractorPayForm';
+export { useWorkAddressForm, useCurrentWorkAddressForm, WorkAddressErrorCodes, } from './components/Employee/Profile/shared/useWorkAddressForm';
+export type { WorkAddressSubmitCallbacks, WorkAddressSubmitOptions, WorkAddressOptionalFieldsToRequire, UseCurrentWorkAddressFormProps, UseWorkAddressFormProps, UseWorkAddressFormResult, UseWorkAddressFormReady, WorkAddressFieldsMetadata, WorkAddressFormFields, WorkAddressErrorCode, WorkAddressFormData, WorkAddressField, WorkAddressRequiredValidation, LocationFieldProps, EffectiveDateFieldProps, } from './components/Employee/Profile/shared/useWorkAddressForm';
+export { useHomeAddressForm, useCurrentHomeAddressForm, HomeAddressErrorCodes, } from './components/Employee/Profile/shared/useHomeAddressForm';
+export type { HomeAddressSubmitOptions, HomeAddressOptionalFieldsToRequire, UseHomeAddressFormProps, UseCurrentHomeAddressFormProps, UseHomeAddressFormResult, UseHomeAddressFormReady, HomeAddressFieldsMetadata, HomeAddressFormFields, HomeAddressErrorCode, HomeAddressFormData, HomeAddressField, HomeAddressRequiredValidation, ZipValidation, Street1FieldProps, Street2FieldProps, CityFieldProps, StateFieldProps, ZipFieldProps, CourtesyWithholdingFieldProps, HomeAddressEffectiveDateFieldProps, } from './components/Employee/Profile/shared/useHomeAddressForm';
+export { useContractorAddressForm, ContractorAddressErrorCodes, } from './components/Contractor/Address/shared/useContractorAddressForm';
+export type { ContractorAddressSubmitOptions, ContractorAddressOptionalFieldsToRequire, UseContractorAddressFormProps, UseContractorAddressFormResult, UseContractorAddressFormReady, ContractorAddressFieldsMetadata, ContractorAddressFormFields, ContractorAddressErrorCode, ContractorAddressFormData, ContractorAddressField, ContractorAddressRequiredValidation, ContractorAddressZipValidation, ContractorAddressStreet1FieldProps, ContractorAddressStreet2FieldProps, ContractorAddressCityFieldProps, ContractorAddressStateFieldProps, ContractorAddressZipFieldProps, } from './components/Contractor/Address/shared/useContractorAddressForm';
+export { useBankForm, BankFormErrorCodes, ACCOUNT_TYPES, } from './components/Employee/PaymentMethod/shared/useBankForm';
+export type { BankFormSubmitOptions, UseBankFormProps, UseBankFormResult, UseBankFormReady, BankFormFields, BankFormFieldsMetadata, BankFormErrorCode, BankFormData, BankFormField, BankFormOptionalFieldsToRequire, AccountType, BankFormRequiredValidation, RoutingNumberValidation, AccountNumberValidation, NameFieldProps, RoutingNumberFieldProps, AccountNumberFieldProps, AccountTypeFieldProps, } from './components/Employee/PaymentMethod/shared/useBankForm';
+export { usePaymentMethodForm, PaymentMethodFormErrorCodes, PAYMENT_METHOD_TYPES, } from './components/Employee/PaymentMethod/shared/usePaymentMethodForm';
+export type { UsePaymentMethodFormProps, UsePaymentMethodFormResult, UsePaymentMethodFormReady, PaymentMethodFormFields, PaymentMethodFormFieldsMetadata, PaymentMethodFormErrorCode, PaymentMethodFormData, PaymentMethodFormField, PaymentMethodFormOptionalFieldsToRequire, PaymentMethodType, PaymentMethodFormRequiredValidation, TypeFieldProps, } from './components/Employee/PaymentMethod/shared/usePaymentMethodForm';
+export { useSplitPaymentsForm, SplitPaymentsFormErrorCodes, SPLIT_BY_VALUES, } from './components/Employee/PaymentMethod/shared/useSplitPaymentsForm';
+export type { UseSplitPaymentsFormProps, UseSplitPaymentsFormResult, UseSplitPaymentsFormReady, SplitPaymentsFormFields, SplitPaymentsFormFieldsMetadata, SplitPaymentsFormErrorCode, SplitPaymentsFormData, SplitPaymentsFormField, SplitPaymentsFormOptionalFieldsToRequire, SplitByValue, SplitPaymentsFormRequiredValidation, SplitByFieldProps, SplitFieldEntry, SplitFieldProps, SplitFieldValidation, WorkingSplit, } from './components/Employee/PaymentMethod/shared/useSplitPaymentsForm';
+export { useFederalTaxesForm, FederalTaxesErrorCodes, FILING_STATUS_VALUES, } from './components/Employee/FederalTaxes/shared/useFederalTaxesForm';
+export { useEmployeeStateTaxesForm, EmployeeStateTaxesErrorCodes, useStateFields, } from './components/Employee/StateTaxes/shared';
+export type { UseEmployeeStateTaxesFormProps, UseEmployeeStateTaxesFormResult, UseEmployeeStateTaxesFormReady, EmployeeStateTaxesFieldsMetadata, EmployeeStateTaxesFormFields, EmployeeStateTaxesErrorCode, EmployeeStateTaxesFormData, StateTaxValue, StateTaxQuestionVariant, StateTaxFieldsGroup, StateTaxFields, StateTaxQuestionFieldEntry, SharedQuestionMetadata, SelectStateTaxQuestion, RadioStateTaxQuestion, TextStateTaxQuestion, NumberStateTaxQuestion, CurrencyStateTaxQuestion, DateStateTaxQuestion, BaseStateTaxFieldProps, StateTaxValidationMessages, SelectStateTaxFieldProps, RadioStateTaxFieldProps, TextStateTaxFieldProps, NumberStateTaxFieldProps, CurrencyStateTaxFieldProps, DateStateTaxFieldProps, } from './components/Employee/StateTaxes/shared';
+export type { FederalTaxesOptionalFieldsToRequire, UseFederalTaxesFormProps, UseFederalTaxesFormResult, UseFederalTaxesFormReady, FederalTaxesFieldsMetadata, FederalTaxesFormFields, FederalTaxesErrorCode, FederalTaxesFormData, FederalTaxesField, FilingStatusValue, FederalTaxesRequiredValidation, FilingStatusFieldProps, TwoJobsFieldProps, DependentsAmountFieldProps, OtherIncomeFieldProps, DeductionsFieldProps, ExtraWithholdingFieldProps, } from './components/Employee/FederalTaxes/shared/useFederalTaxesForm';
+export { useSignEmployeeForm, SignEmployeeFormErrorCodes, MAX_PREPARERS, PREPARER_FIELDS_BY_INDEX, } from './components/Employee/Documents/shared/useSignEmployeeForm';
+export type { UseSignEmployeeFormProps, UseSignEmployeeFormResult, UseSignEmployeeFormReady, SignEmployeeFormFieldsMetadata, SignEmployeeBaseFieldsMetadata, SignEmployeeI9FieldsMetadata, SignEmployeeFormFields, PreparerFieldGroup, SignEmployeeFormErrorCode, SignEmployeeFormData, SignEmployeeFormField, PreparerIndex, PreparerFieldSuffix, SignEmployeeFormRequiredValidation, SignatureFieldProps as SignEmployeeFormSignatureFieldProps, ConfirmSignatureFieldProps as SignEmployeeFormConfirmSignatureFieldProps, UsedPreparerFieldProps, PreparerTextFieldProps, PreparerSelectFieldProps, PreparerCheckboxFieldProps, } from './components/Employee/Documents/shared/useSignEmployeeForm';
+export { useEmployeeList } from './components/Employee/EmployeeList/shared';
+export type { UseEmployeeListProps, UseEmployeeListResult, UseEmployeeListReady, EmployeeType, EmployeeAction, EmployeeWithActions, } from './components/Employee/EmployeeList/shared';
+export { usePayScheduleForm, PayScheduleErrorCodes, } from './components/Company/PaySchedule/shared/usePayScheduleForm';
+export type { PayScheduleOptionalFieldsToRequire, UsePayScheduleFormProps, UsePayScheduleFormResult, UsePayScheduleFormReady, PayScheduleFieldsMetadata, PayScheduleFormFields, PayScheduleErrorCode, PayScheduleFormData, PayScheduleField, PayScheduleFrequency, PayScheduleRequiredValidation, DayValidation, CustomNameFieldProps, FrequencyFieldProps, CustomTwicePerMonthFieldProps, AnchorPayDateFieldProps, AnchorEndOfPayPeriodFieldProps, Day1FieldProps, Day2FieldProps, } from './components/Company/PaySchedule/shared/usePayScheduleForm';
+export { useSignCompanyForm, SignCompanyFormErrorCodes, } from './components/Company/DocumentSigner/shared/useSignCompanyForm';
+export type { SignCompanyFormOptionalFieldsToRequire, UseSignCompanyFormProps, UseSignCompanyFormResult, UseSignCompanyFormReady, SignCompanyFormFieldsMetadata, SignCompanyFormFields, SignCompanyFormErrorCode, SignCompanyFormData, SignCompanyFormField, SignCompanyFormRequiredValidation, SignatureFieldProps, ConfirmSignatureFieldProps, } from './components/Company/DocumentSigner/shared/useSignCompanyForm';
+export { useContractorDocumentsList } from './components/Contractor/Documents/shared/useContractorDocumentsList';
+export type { UseContractorDocumentsListParams, UseContractorDocumentsListResult, UseContractorDocumentsListReady, } from './components/Contractor/Documents/shared/useContractorDocumentsList';
+export { useContractorSignatureForm, ContractorSignatureFormErrorCodes, } from './components/Contractor/Documents/shared/SignatureForm/useContractorSignatureForm';
+export type { UseContractorSignatureFormProps, UseContractorSignatureFormResult, UseContractorSignatureFormReady, ContractorSignatureFormErrorCode, ContractorSignatureFormData, ContractorSignatureOptionalFieldsToRequire, ContractorSignatureFormFieldComponents, ContractorSignatureAgreeFieldProps, ContractorSignatureSsnFieldProps, ContractorSignatureEinFieldProps, NameFieldProps as ContractorSignatureNameFieldProps, TaxClassificationFieldProps as ContractorSignatureTaxClassificationFieldProps, HomeAddressStreet1FieldProps as ContractorSignatureHomeAddressStreet1FieldProps, HomeAddressCityFieldProps as ContractorSignatureHomeAddressCityFieldProps, HomeAddressStateFieldProps as ContractorSignatureHomeAddressStateFieldProps, HomeAddressZipFieldProps as ContractorSignatureHomeAddressZipFieldProps, SignatureTextFieldProps as ContractorSignatureSignatureTextFieldProps, BusinessNameFieldProps as ContractorSignatureBusinessNameFieldProps, LlcClassificationCodeFieldProps as ContractorSignatureLlcClassificationCodeFieldProps, OtherTextFieldProps as ContractorSignatureOtherTextFieldProps, ForeignPartnersFieldProps as ContractorSignatureForeignPartnersFieldProps, ExemptPayeeCodeFieldProps as ContractorSignatureExemptPayeeCodeFieldProps, ExemptionFromFatcaFieldProps as ContractorSignatureExemptionFromFatcaFieldProps, HomeAddressStreet2FieldProps as ContractorSignatureHomeAddressStreet2FieldProps, AccountNumberFieldProps as ContractorSignatureAccountNumberFieldProps, CompanyNameFieldProps as ContractorSignatureCompanyNameFieldProps, ContractorSignatureFieldsMetadata, ContractorSignatureRequiredValidation, ContractorSignatureAgreeValidation, ContractorSignatureSsnValidation, ContractorSignatureEinValidation, } from './components/Contractor/Documents/shared/SignatureForm/useContractorSignatureForm';

package/dist/{shared → src/shared}/constants.d.ts

@@ -208,6 +208,7 @@ export declare const contractorEvents: {
     readonly CONTRACTOR_SIGN_DOCUMENT: "contractor/documents/sign";
     readonly CONTRACTOR_DOCUMENTS_DONE: "contractor/documents/done";
     readonly CONTRACTOR_VIEW: "contractor/view";
+    readonly CONTRACTOR_RETURN_TO_LIST: "contractor/returnToList";
     readonly CONTRACTOR_DISMISS: "contractor/dismiss";
     readonly CONTRACTOR_REHIRE: "contractor/rehire";
     readonly CONTRACTOR_DISMISSAL_CANCELLED: "contractor/dismissal/cancelled";
@@ -658,6 +659,7 @@ export declare const componentEvents: {
     readonly CONTRACTOR_SIGN_DOCUMENT: "contractor/documents/sign";
     readonly CONTRACTOR_DOCUMENTS_DONE: "contractor/documents/done";
     readonly CONTRACTOR_VIEW: "contractor/view";
+    readonly CONTRACTOR_RETURN_TO_LIST: "contractor/returnToList";
     readonly CONTRACTOR_DISMISS: "contractor/dismiss";
     readonly CONTRACTOR_REHIRE: "contractor/rehire";
     readonly CONTRACTOR_DISMISSAL_CANCELLED: "contractor/dismissal/cancelled";

package/dist/{types → src/types}/sdkError.d.ts

@@ -26,6 +26,13 @@ export declare const SDKErrorCategories: {
  * @public
  */
 export type SDKErrorCategory = (typeof SDKErrorCategories)[keyof typeof SDKErrorCategories];
+/**
+ * Fallback message used when an API error response carries no extractable field errors
+ * (e.g. a non-JSON or unrecognized 5xx body) — never surfaces the raw response body.
+ *
+ * @internal
+ */
+export declare const GENERIC_API_ERROR_MESSAGE = "Something went wrong. Please try again.";
 /**
  * An error thrown by internal SDK logic that should be caught and normalized
  * by `baseSubmitHandler` rather than propagating to the ErrorBoundary.

package/dist/src/types/sdkError.test.d.ts

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