@gusto/embedded-react-sdk 0.55.7 → 0.56.0

package/dist/src/components/Contractor/Payments/CreatePayment/CreatePaymentPresentation.d.ts

@@ -5,6 +5,8 @@ import { SetPaymentAmountsDictionary } from '../shared/SetPaymentAmounts';
 import { UsePaymentAmountsEditorReturn } from '../shared/usePaymentAmountsEditor';
 import { ApiPayrollBlocker } from '../../../Payroll/PayrollBlocker/payrollHelpers';
 interface ContractorPaymentCreatePaymentPresentationProps {
+    /** CSS class name applied to the root element. */
+    className?: string;
     contractors: Contractor[];
     contractorPayments: (ContractorPayments & {
         isTouched?: boolean;
@@ -28,5 +30,5 @@ interface ContractorPaymentCreatePaymentPresentationProps {
     paymentSpeedDays: number;
 }
 /** @internal */
-export declare const CreatePaymentPresentation: ({ contractors, paymentDate, contractorPayments, onPaymentDateChange, onSaveAndContinue, editModal, allowedPaymentMethods, paymentAmountsDictionary, totals, alerts, payrollBlockers, onViewBlockers, isLoading, paymentSpeedDays, }: ContractorPaymentCreatePaymentPresentationProps) => import("react").JSX.Element;
+export declare const CreatePaymentPresentation: ({ className, contractors, paymentDate, contractorPayments, onPaymentDateChange, onSaveAndContinue, editModal, allowedPaymentMethods, paymentAmountsDictionary, totals, alerts, payrollBlockers, onViewBlockers, isLoading, paymentSpeedDays, }: ContractorPaymentCreatePaymentPresentationProps) => import("react").JSX.Element;
 export {};

package/dist/src/components/Contractor/Payments/CreatePayment/PreviewPresentation.d.ts

@@ -3,6 +3,8 @@ import { Contractor } from '@gusto/embedded-api/models/components/contractor';
 import { CompanyBankAccount } from '@gusto/embedded-api/models/components/companybankaccount';
 import { PaymentSpeed } from '@gusto/embedded-api/models/components/paymentconfigs';
 interface PreviewPresentationProps {
+    /** CSS class name applied to the root element. */
+    className?: string;
     contractorPaymentGroup: ContractorPaymentGroupPreview;
     contractors: Contractor[];
     onBackToEdit: () => void;
@@ -14,5 +16,5 @@ interface PreviewPresentationProps {
     paymentSpeed?: PaymentSpeed;
 }
 /** @internal */
-export declare const PreviewPresentation: ({ contractorPaymentGroup, contractors, onBackToEdit, onSubmit, isLoading, bankAccount, selectedUnblockOptions, onUnblockOptionChange, paymentSpeed, }: PreviewPresentationProps) => import("react").JSX.Element;
+export declare const PreviewPresentation: ({ className, contractorPaymentGroup, contractors, onBackToEdit, onSubmit, isLoading, bankAccount, selectedUnblockOptions, onUnblockOptionChange, paymentSpeed, }: PreviewPresentationProps) => import("react").JSX.Element;
 export {};

package/dist/src/components/Contractor/Payments/PaymentHistory/PaymentHistoryPresentation.d.ts

@@ -1,6 +1,8 @@
 import { ContractorPaymentGroup } from '@gusto/embedded-api/models/components/contractorpaymentgroup';
 import { Contractor } from '@gusto/embedded-api/models/components/contractor';
 interface PaymentHistoryPresentationProps {
+    /** CSS class name applied to the root element. */
+    className?: string;
     paymentGroup: ContractorPaymentGroup;
     contractors: Contractor[];
     onViewPayment: (paymentId: string) => void;
@@ -8,5 +10,5 @@ interface PaymentHistoryPresentationProps {
     isCancelling: boolean;
 }
 /** @internal */
-export declare const PaymentHistoryPresentation: ({ paymentGroup, contractors, onViewPayment, onCancelPayment, isCancelling, }: PaymentHistoryPresentationProps) => import("react").JSX.Element;
+export declare const PaymentHistoryPresentation: ({ className, paymentGroup, contractors, onViewPayment, onCancelPayment, isCancelling, }: PaymentHistoryPresentationProps) => import("react").JSX.Element;
 export {};

package/dist/src/components/Contractor/Payments/PaymentStatement/PaymentStatementPresentation.d.ts

@@ -2,11 +2,13 @@ import { ContractorPaymentForGroup } from '@gusto/embedded-api/models/components
 import { Contractor } from '@gusto/embedded-api/models/components/contractor';
 import { ContractorPaymentReceipt } from '@gusto/embedded-api/models/components/contractorpaymentreceipt';
 interface PaymentStatementPresentationProps {
+    /** CSS class name applied to the root element. */
+    className?: string;
     payment: ContractorPaymentForGroup;
     contractor: Contractor;
     paymentReceipt?: ContractorPaymentReceipt;
     checkDate: string;
 }
 /** @internal */
-export declare const PaymentStatementPresentation: ({ payment, contractor, checkDate, paymentReceipt, }: PaymentStatementPresentationProps) => import("react").JSX.Element;
+export declare const PaymentStatementPresentation: ({ className, payment, contractor, checkDate, paymentReceipt, }: PaymentStatementPresentationProps) => import("react").JSX.Element;
 export {};

package/dist/src/components/Contractor/Payments/PaymentsList/PaymentsListPresentation.d.ts

@@ -3,6 +3,8 @@ import { InternalAlert } from '../types';
 import { EventType } from '../../../../shared/constants';
 import { PaginationControlProps } from '../../../Common/PaginationControl/PaginationControlTypes';
 interface ContractorPaymentPaymentsListPresentationProps {
+    /** CSS class name applied to the root element. */
+    className?: string;
     numberOfMonths: number;
     contractorPayments: ContractorPaymentGroupWithBlockers[];
     onCreatePayment: () => void;
@@ -16,5 +18,5 @@ interface ContractorPaymentPaymentsListPresentationProps {
     paginationProps?: PaginationControlProps;
 }
 /** @internal */
-export declare const PaymentsListPresentation: ({ contractorPayments, numberOfMonths, onCreatePayment, onCreateHistoricalPayment, onDateRangeChange, onViewPayment, alerts, companyId, hasUnresolvedWireInRequests, onEvent, paginationProps, }: ContractorPaymentPaymentsListPresentationProps) => import("react").JSX.Element;
+export declare const PaymentsListPresentation: ({ className, contractorPayments, numberOfMonths, onCreatePayment, onCreateHistoricalPayment, onDateRangeChange, onViewPayment, alerts, companyId, hasUnresolvedWireInRequests, onEvent, paginationProps, }: ContractorPaymentPaymentsListPresentationProps) => import("react").JSX.Element;
 export {};

package/dist/src/components/Contractor/Submit/SubmitDone.d.ts

@@ -1,6 +1,8 @@
 interface SubmitDoneProps {
     onDone: () => void;
+    /** CSS class name applied to the root element. */
+    className?: string;
 }
 /** @internal */
-export declare const SubmitDone: ({ onDone }: SubmitDoneProps) => import("react").JSX.Element;
+export declare const SubmitDone: ({ onDone, className }: SubmitDoneProps) => import("react").JSX.Element;
 export {};

package/dist/src/components/Employee/Compensation/management/CompensationEditForm/CompensationEditForm.d.ts

@@ -38,4 +38,4 @@ export interface CompensationEditFormProps extends CommonComponentInterface<'Emp
  * @public
  * @group Block components
  */
-export declare function CompensationEditForm({ employeeId, jobId, onEvent, dictionary, LoaderComponent, }: CompensationEditFormProps): import("react").JSX.Element;
+export declare function CompensationEditForm({ employeeId, jobId, onEvent, dictionary, LoaderComponent, className, }: CompensationEditFormProps): import("react").JSX.Element;

package/dist/src/components/Employee/Documents/onboarding/DocumentSigner/EmploymentEligibility/EmploymentEligibilityPresentation.d.ts

@@ -1,11 +1,13 @@
 import { SubmitHandler } from 'react-hook-form';
 import { EmploymentEligibilityInputs, EmploymentEligibilityPayload } from './EmploymentEligibilitySchema';
 interface EmploymentEligibilityPresentationProps {
+    /** CSS class name applied to the root element. */
+    className?: string;
     onSubmit: SubmitHandler<EmploymentEligibilityPayload>;
     defaultValues?: Partial<EmploymentEligibilityInputs>;
     hasDocumentNumber?: boolean | null;
     isPending?: boolean;
 }
 /** @internal */
-export declare const EmploymentEligibilityPresentation: ({ onSubmit, defaultValues, hasDocumentNumber, isPending, }: EmploymentEligibilityPresentationProps) => import("react").JSX.Element;
+export declare const EmploymentEligibilityPresentation: ({ className, onSubmit, defaultValues, hasDocumentNumber, isPending, }: EmploymentEligibilityPresentationProps) => import("react").JSX.Element;
 export {};

package/dist/src/components/Employee/Documents/onboarding/EmployeeDocuments/EmployeeDocumentsPresentation.d.ts

@@ -3,6 +3,8 @@ import { z } from 'zod';
 export type EmployeeDocumentsFormValues = { includeI9: boolean; };
 /** @internal */
 export interface EmployeeDocumentsPresentationProps {
+    /** CSS class name applied to the root element. */
+    className?: string;
     isEmployeeSelfOnboarding: boolean;
     currentI9Status: boolean;
     onSubmit: (formData: EmployeeDocumentsFormValues) => Promise<void>;
@@ -10,5 +12,5 @@ export interface EmployeeDocumentsPresentationProps {
     isPending: boolean;
 }
 /** @internal */
-export declare const EmployeeDocumentsPresentation: ({ isEmployeeSelfOnboarding, currentI9Status, onSubmit, onDone, isPending, }: EmployeeDocumentsPresentationProps) => import("react").JSX.Element;
+export declare const EmployeeDocumentsPresentation: ({ className, isEmployeeSelfOnboarding, currentI9Status, onSubmit, onDone, isPending, }: EmployeeDocumentsPresentationProps) => import("react").JSX.Element;
 export {};

package/dist/src/components/Employee/EmployeeList/management/ManagementEmployeeListView.d.ts

@@ -12,7 +12,9 @@ export interface ManagementEmployeeListViewProps extends Pick<Extract<UseEmploye
     onDismiss: (employeeId: string) => void;
     onDelete: (employeeId: string) => Promise<void>;
     onAddEmployee: () => void;
+    /** CSS class name applied to the root element. */
+    className?: string;
 }
 /** @internal */
-export declare function ManagementEmployeeListView({ selectedTab, onTabChange, employees, isFetching, status, onEdit, onDismiss, onDelete, onAddEmployee, pagination, }: ManagementEmployeeListViewProps): import("react").JSX.Element;
+export declare function ManagementEmployeeListView({ selectedTab, onTabChange, employees, isFetching, status, onEdit, onDismiss, onDelete, onAddEmployee, pagination, className, }: ManagementEmployeeListViewProps): import("react").JSX.Element;
 export {};

package/dist/src/components/Employee/EmployeeList/onboarding/EmployeeListView.d.ts

@@ -13,6 +13,8 @@ export interface EmployeeListViewProps extends Pick<Extract<UseEmployeeListResul
     onAddEmployee: () => void;
     onSkip: () => void;
     showContinueButton: boolean;
+    /** CSS class name applied to the root element. */
+    className?: string;
 }
 /** @internal */
-export declare function EmployeeListView({ employees, isFetching, pagination, status, onEdit, onDelete, onCancelSelfOnboarding, onReview, onAddEmployee, onSkip, showContinueButton, }: EmployeeListViewProps): import("react").JSX.Element;
+export declare function EmployeeListView({ employees, isFetching, pagination, status, onEdit, onDelete, onCancelSelfOnboarding, onReview, onAddEmployee, onSkip, showContinueButton, className, }: EmployeeListViewProps): import("react").JSX.Element;

package/dist/src/components/Employee/EmployeeList/shared/useEmployeeList.d.ts

@@ -20,6 +20,8 @@ export interface EmployeeWithActions extends Employee {
     allowedActions: EmployeeAction[];
     /** The employee's primary job, if one is marked primary. */
     primaryJob?: Job;
+    /** Effective date of a termination that hasn't gone into effect yet, if one is scheduled. */
+    pendingDismissalDate?: string;
 }
 /**
  * Filter applied to {@link useEmployeeList} that scopes the result set and tailors the per-row action list.
@@ -73,8 +75,15 @@ export type UseEmployeeListResult = HookLoadingResult | UseEmployeeListReady;
  *
  * @remarks
  * `employeeType` maps to a server-side filter and changes which actions appear on each row:
- * `'active'` adds `dismiss`, `'terminated'` adds `rehire`, `'onboarding'` adds none. Omit it
- * to list every employee.
+ * `'active'` adds `dismiss` unless the employee already has a termination scheduled for a future
+ * date, `'terminated'` adds `rehire`, `'onboarding'` adds none. Omit it to list every employee.
+ *
+ * An `'active'` row with a pending termination carries its effective date on
+ * `pendingDismissalDate` instead of the `dismiss` action.
+ *
+ * `'onboarding'` includes employees who haven't completed onboarding as well as employees who
+ * have completed onboarding but whose primary job's hire date hasn't arrived yet, so `onboarded`
+ * may be `true` for rows in this filter.
  *
  * Page changes use placeholder data: the previous page stays rendered while the next one loads,
  * and `status.isFetching` flips to `true` during the request.

package/dist/src/components/Employee/EmployeeListFlow/employeeListStateMachine.test.d.ts

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

package/dist/src/components/Employee/HomeAddress/management/HomeAddressView.d.ts

@@ -16,6 +16,8 @@ export interface HomeAddressViewProps {
     onConfirmDelete: (homeAddressUuid: string) => Promise<boolean>;
     onBack: () => void;
     isDeletePending?: boolean;
+    /** CSS class name applied to the root element. */
+    className?: string;
 }
 /** @internal */
-export declare function HomeAddressView({ editHomeAddressForm, createHomeAddressForm, employeeHomeAddresses, employeeDisplayName, editingHomeAddressUuid, onEditAddressTargetChange, onSaved, onConfirmDelete, onBack, isDeletePending, }: HomeAddressViewProps): import("react").JSX.Element;
+export declare function HomeAddressView({ editHomeAddressForm, createHomeAddressForm, employeeHomeAddresses, employeeDisplayName, editingHomeAddressUuid, onEditAddressTargetChange, onSaved, onConfirmDelete, onBack, isDeletePending, className, }: HomeAddressViewProps): import("react").JSX.Element;

package/dist/src/components/Employee/Terminations/TerminateEmployee/TerminateEmployeePresentation.d.ts

@@ -6,7 +6,9 @@ interface TerminateEmployeePresentationProps {
     onSubmit: (data: TerminateEmployeeFormData) => void;
     onCancel: () => void;
     isLoading: boolean;
+    /** CSS class name applied to the root element. */
+    className?: string;
 }
 /** @internal */
-export declare function TerminateEmployeePresentation({ employeeName, existingTermination, onSubmit, onCancel, isLoading, }: TerminateEmployeePresentationProps): import("react").JSX.Element;
+export declare function TerminateEmployeePresentation({ employeeName, existingTermination, onSubmit, onCancel, isLoading, className, }: TerminateEmployeePresentationProps): import("react").JSX.Element;
 export {};

package/dist/src/components/Employee/Terminations/TerminationSummary/TerminationSummaryPresentation.d.ts

@@ -15,7 +15,9 @@ interface TerminationSummaryPresentationProps {
     onDialogClose: () => void;
     onDialogConfirm: () => void;
     isCancelling: boolean;
+    /** CSS class name applied to the root element. */
+    className?: string;
 }
 /** @internal */
-export declare function TerminationSummaryPresentation({ employeeName, effectiveDate, canCancel, canEdit, showRunPayroll, showRunOffCyclePayroll, showSuccessAlert, onCancelClick, onEditDismissal, onRunDismissalPayroll, onRunOffCyclePayroll, isLoading, isCancelDialogOpen, onDialogClose, onDialogConfirm, isCancelling, }: TerminationSummaryPresentationProps): import("react").JSX.Element;
+export declare function TerminationSummaryPresentation({ employeeName, effectiveDate, canCancel, canEdit, showRunPayroll, showRunOffCyclePayroll, showSuccessAlert, onCancelClick, onEditDismissal, onRunDismissalPayroll, onRunOffCyclePayroll, isLoading, isCancelDialogOpen, onDialogClose, onDialogConfirm, isCancelling, className, }: TerminationSummaryPresentationProps): import("react").JSX.Element;
 export {};

package/dist/src/components/Employee/WorkAddress/management/WorkAddressView.d.ts

@@ -14,6 +14,8 @@ export interface WorkAddressViewProps {
     onWorkAddressSaved: (result: HookSubmitResult<EmployeeWorkAddress>) => void;
     onBack: () => void;
     isDeletePending?: boolean;
+    /** CSS class name applied to the root element. */
+    className?: string;
 }
 /** @internal */
-export declare function WorkAddressView({ editWorkAddressForm, changeWorkAddressForm, workAddresses, editTargetUuid, onEditTargetUuidChange, employeeDisplayName, onConfirmDelete, onWorkAddressSaved, onBack, isDeletePending, }: WorkAddressViewProps): import("react").JSX.Element;
+export declare function WorkAddressView({ editWorkAddressForm, changeWorkAddressForm, workAddresses, editTargetUuid, onEditTargetUuidChange, employeeDisplayName, onConfirmDelete, onWorkAddressSaved, onBack, isDeletePending, className, }: WorkAddressViewProps): import("react").JSX.Element;

package/dist/src/components/Payroll/Dismissal/DismissalPayPeriodSelection/DismissalPayPeriodSelectionPresentation.d.ts

@@ -11,6 +11,8 @@ export interface DismissalPayPeriodSelectionPresentationProps {
     onSubmit: () => void;
     /** Whether the submit action is in flight. */
     isPending: boolean;
+    /** CSS class name applied to the root element. */
+    className?: string;
 }
 /** @internal */
-export declare function DismissalPayPeriodSelectionPresentation({ payPeriodOptions, selectedPeriodKey, onSelectPeriod, onSubmit, isPending, }: DismissalPayPeriodSelectionPresentationProps): import("react").JSX.Element;
+export declare function DismissalPayPeriodSelectionPresentation({ payPeriodOptions, selectedPeriodKey, onSelectPeriod, onSubmit, isPending, className, }: DismissalPayPeriodSelectionPresentationProps): import("react").JSX.Element;

package/dist/src/components/Payroll/OffCycleCreation/OffCycleCreationPresentation.d.ts

@@ -1,3 +1,3 @@
 import { OffCycleCreationPresentationProps } from './OffCycleCreationTypes';
 /** @internal */
-export declare function OffCycleCreationPresentation({ employees, isPending, minCheckDate, minCheckOnlyDate, maxDate, minPayPeriodDate, taxWithholdingConfig, isTaxWithholdingModalOpen, onTaxWithholdingEditClick, onTaxWithholdingModalDone, onTaxWithholdingModalCancel, }: OffCycleCreationPresentationProps): import("react").JSX.Element;
+export declare function OffCycleCreationPresentation({ employees, blockers, isPending, minCheckDate, minCheckOnlyDate, maxDate, minPayPeriodDate, taxWithholdingConfig, isTaxWithholdingModalOpen, onTaxWithholdingEditClick, onTaxWithholdingModalDone, onTaxWithholdingModalCancel, className, }: OffCycleCreationPresentationProps): import("react").JSX.Element;

package/dist/src/components/Payroll/OffCycleCreation/OffCycleCreationTypes.d.ts

@@ -1,6 +1,7 @@
 import { OffCycleReason } from '../OffCycleReasonSelection';
 import { OffCyclePayPeriodDateFormData, OffCyclePayrollDateType } from '../OffCyclePayPeriodDateForm';
 import { OffCycleTaxWithholdingConfig } from '../OffCycleTaxWithholdingTable/OffCycleTaxWithholdingTableTypes';
+import { ApiPayrollBlocker } from '../PayrollBlocker/payrollHelpers';
 import { MultiSelectComboBoxOption } from '../../Common/UI/MultiSelectComboBox/MultiSelectComboBoxTypes';
 import { BaseComponentInterface } from '../../Base/Base';
 /**
@@ -33,6 +34,11 @@ export interface OffCycleCreationFormData extends OffCyclePayPeriodDateFormData
 export interface OffCycleCreationPresentationProps {
     /** Selectable employees rendered in the multi-select. */
     employees: MultiSelectComboBoxOption[];
+    /**
+     * Run-payroll blockers for the company. When non-empty, a blocker alert is shown and the
+     * submit action is disabled so the off-cycle payroll cannot be created while a blocker is active.
+     */
+    blockers: ApiPayrollBlocker[];
     /** Whether the off-cycle create mutation is in flight. */
     isPending?: boolean;
     /** Earliest selectable payment date for direct deposit (today plus the ACH lead time). */
@@ -53,4 +59,6 @@ export interface OffCycleCreationPresentationProps {
     onTaxWithholdingModalDone: (config: OffCycleTaxWithholdingConfig) => void;
     /** Fires when the user dismisses the tax withholding modal without saving. */
     onTaxWithholdingModalCancel: () => void;
+    /** CSS class name applied to the root element. */
+    className?: string;
 }

package/dist/src/components/Payroll/OffCycleReasonSelection/OffCycleReasonSelectionPresentation.d.ts

@@ -2,7 +2,9 @@ import { OffCycleReason } from './types';
 interface OffCycleReasonSelectionPresentationProps {
     name: string;
     onChange?: (value: OffCycleReason) => void;
+    /** CSS class name applied to the root element. */
+    className?: string;
 }
 /** @internal */
-export declare function OffCycleReasonSelectionPresentation({ name, onChange, }: OffCycleReasonSelectionPresentationProps): import("react").JSX.Element;
+export declare function OffCycleReasonSelectionPresentation({ name, onChange, className, }: OffCycleReasonSelectionPresentationProps): import("react").JSX.Element;
 export {};

package/dist/src/components/Payroll/PayrollConfiguration/PayrollConfigurationPresentation.d.ts

@@ -7,6 +7,8 @@ import { PayrollCategory } from '../payrollTypes';
 import { ApiPayrollBlocker } from '../PayrollBlocker/payrollHelpers';
 import { PaginationControlProps } from '../../Common/PaginationControl/PaginationControlTypes';
 interface PayrollConfigurationPresentationProps {
+    /** CSS class name applied to the root element. */
+    className?: string;
     employeeCompensations: PayrollEmployeeCompensationsType[];
     employeeDetails: Employee[];
     payPeriod?: PayrollPayPeriodType;
@@ -32,5 +34,5 @@ interface PayrollConfigurationPresentationProps {
     onGrossUpSelect?: (employeeUuid: string) => void;
 }
 /** @internal */
-export declare const PayrollConfigurationPresentation: ({ employeeCompensations, employeeDetails, payPeriod, paySchedule, onEdit, onToggleExclude, onCalculatePayroll, onViewBlockers, payrollCategory, alerts, payrollAlert, isPending, isCalculating, payrollBlockers, pagination, withReimbursements, isCalculateDisabled, grossUpEnabled, onGrossUpSelect, }: PayrollConfigurationPresentationProps) => import("react").JSX.Element;
+export declare const PayrollConfigurationPresentation: ({ className, employeeCompensations, employeeDetails, payPeriod, paySchedule, onEdit, onToggleExclude, onCalculatePayroll, onViewBlockers, payrollCategory, alerts, payrollAlert, isPending, isCalculating, payrollBlockers, pagination, withReimbursements, isCalculateDisabled, grossUpEnabled, onGrossUpSelect, }: PayrollConfigurationPresentationProps) => import("react").JSX.Element;
 export {};

package/dist/src/components/Payroll/PayrollConfiguration/useCalculationPoll.d.ts

@@ -35,6 +35,11 @@ export interface UseCalculationPollOptions {
     refetch: () => Promise<QueryObserverResult<PayrollsGetQueryData, PayrollsGetQueryError>>;
     onCalculated: (payroll: PayrollShow | undefined) => void;
     onProcessingFailed: (payroll: PayrollShow | undefined) => void;
+    /**
+     * Called when the poll gives up on a non-retryable read error, without ever confirming a
+     * calculated/failed outcome. The raw error is reported to observability by this hook already.
+     */
+    onError: () => void;
 }
 /** @internal */
 export interface CalculationPoll {
@@ -46,5 +51,5 @@ export interface CalculationPoll {
  *
  * @internal
  */
-export declare function useCalculationPoll({ refetch, onCalculated, onProcessingFailed, }: UseCalculationPollOptions): CalculationPoll;
+export declare function useCalculationPoll({ refetch, onCalculated, onProcessingFailed, onError, }: UseCalculationPollOptions): CalculationPoll;
 export {};

package/dist/src/components/Payroll/PayrollEditEmployee/PayrollEditEmployeePresentation.d.ts

@@ -5,6 +5,8 @@ import { PayScheduleShow as PayScheduleObject } from '@gusto/embedded-api/models
 import { z } from 'zod';
 import { PayrollCategory } from '../payrollTypes';
 interface PayrollEditEmployeeProps {
+    /** CSS class name applied to the root element. */
+    className?: string;
     onSave: (updatedCompensation: PayrollEmployeeCompensationsType) => void;
     onCancel: () => void;
     employee: Employee;
@@ -21,5 +23,5 @@ interface PayrollEditEmployeeProps {
 /** @internal */
 export type PayrollEditEmployeeFormValues = { hourlyCompensations: Record<string, Record<string, string | undefined>>; timeOffCompensations: Record<string, string | undefined>; finalPayoutCompensations: Record<string, string | undefined>; fixedCompensations: Record<string, string | undefined>; reimbursements: { description: string; amount: string; uuid?: string | null | undefined; recurring?: boolean | undefined; }[]; paymentMethod?: "Check" | "Historical" | "Direct Deposit" | undefined; };
 /** @internal */
-export declare const PayrollEditEmployeePresentation: ({ onSave, onCancel, employee, employeeCompensation, isPending, fixedCompensationTypes, payPeriodStartDate, paySchedule, payrollCategory, withReimbursements, hasDirectDepositSetup, }: PayrollEditEmployeeProps) => import("react").JSX.Element;
+export declare const PayrollEditEmployeePresentation: ({ className, onSave, onCancel, employee, employeeCompensation, isPending, fixedCompensationTypes, payPeriodStartDate, paySchedule, payrollCategory, withReimbursements, hasDirectDepositSetup, }: PayrollEditEmployeeProps) => import("react").JSX.Element;
 export {};

package/dist/src/components/Payroll/PayrollEditEmployee/shared/usePayrollEditEmployeeForm/fields.d.ts

@@ -111,10 +111,10 @@ export interface TimeOffEntry {
     remaining: number | null;
 }
 /**
- * One entry in the flat `other` section.
+ * One entry in the flat `overtimeExcludedEarnings` section.
  *
  * @remarks
- * Intentionally opaque: `other` collects earnings that are not overtime-affecting
+ * Intentionally opaque: `overtimeExcludedEarnings` collects earnings that are not overtime-affecting
  * and whose input type the partner does not need to reason about. Render each
  * entry's `Field` keyed by `key`; use `id` as a reach-in handle for labeling.
  *
@@ -138,8 +138,8 @@ export interface OtherEntry {
  * The value type is the signal — array is flat, object is split by workweek; use
  * {@link isSplitByWorkweek} to discriminate. `title` is the job's display title
  * (entity data, not copy) for rendering a per-job heading. Earnings are not
- * job-scoped: they live in the employee-level `additionalEarnings` and
- * `otherEarnings` sections on {@link PayrollEditEmployeeFields}.
+ * job-scoped: they live in the employee-level `overtimeIncludedEarnings` and
+ * `overtimeExcludedEarnings` sections on {@link PayrollEditEmployeeFields}.
  *
  * @public
  */
@@ -217,8 +217,8 @@ export interface ReimbursementRow {
  * @remarks
  * Hours are grouped under `jobs`, one entry per job, so multi-job employees
  * render correctly. All earnings and the remaining sections are employee-scoped
- * and stay top-level: `additionalEarnings` (overtime-affecting) and
- * `otherEarnings` (non-overtime) each render as a single section spanning every
+ * and stay top-level: `overtimeIncludedEarnings` (overtime-affecting) and
+ * `overtimeExcludedEarnings` (non-overtime) each render as a single section spanning every
  * job, alongside time off, final payout, payment method, and reimbursements.
  *
  * @public
@@ -231,9 +231,9 @@ export interface PayrollEditEmployeeFields {
      * section. Flat `Entry[]` when unsplit, or `Record<workweekStart, Entry[]>`
      * when split by workweek; use {@link isSplitByWorkweek} to discriminate.
      */
-    additionalEarnings: EarningEntry[] | Record<string, EarningEntry[]>;
+    overtimeIncludedEarnings: EarningEntry[] | Record<string, EarningEntry[]>;
     /** Non-overtime earnings (e.g. tips), always flat; opaque render entries. */
-    otherEarnings: OtherEntry[];
+    overtimeExcludedEarnings: OtherEntry[];
     /** Time-off inputs (never workweek-breakdown). */
     timeOff: TimeOffEntry[];
     /** Final-payout inputs, present only for dismissal payrolls. */
@@ -317,7 +317,7 @@ export declare function computeTimeOffRemaining(accrualBalance: string | undefin
  * compensations are split by whether their earning type is included in the
  * regular-rate-of-pay overtime calculation (`overtimeEarningNames`): included
  * earnings become each job's additional earnings, the rest become the flat,
- * employee-level `other` section. Time off comes from the paid-time-off list,
+ * employee-level `overtimeExcludedEarnings` section. Time off comes from the paid-time-off list,
  * final payout is added only for dismissal payrolls, and the payment-method
  * selector appears only when direct deposit is set up.
  *

package/dist/src/components/Payroll/PayrollEditEmployee/shared/usePayrollEditEmployeeForm/payrollEditEmployeeHelpers.d.ts

@@ -40,7 +40,7 @@ export declare function normalizeWorkweeks(workweeks: Array<{
 /**
  * Collects the names of earning types included in the regular-rate-of-pay
  * overtime calculation. These earnings render in the workweek-breakdown
- * additional-earnings section; all others fall into the flat `other` section.
+ * additional-earnings section; all others fall into the flat `overtimeExcludedEarnings` section.
  *
  * @param earningTypeList - The company's default and custom earning types.
  * @returns A set of earning-type names with `includedInOvertimePay` set.
@@ -60,7 +60,7 @@ export declare function collectOvertimeEarningNames(earningTypeList: EarningType
  * handled elsewhere or never shown as additional earnings
  * ({@link EXCLUDED_ADDITIONAL_EARNINGS}) and inactive types are skipped. The
  * result is sorted alphabetically by name. The regular-rate-of-pay split between
- * additional earnings and `other` happens downstream via `overtimeEarningNames`;
+ * additional earnings and `overtimeExcludedEarnings` happens downstream via `overtimeEarningNames`;
  * this helper only decides which earning lines exist.
  *
  * @param existingFixedCompensations - The prepared compensation's fixed compensations.

package/dist/src/components/Payroll/PayrollEditEmployee/shared/usePayrollEditEmployeeForm/payrollEditEmployeeSchema.d.ts

@@ -47,13 +47,13 @@ export declare const reimbursementDraftSchema: z.ZodObject<{
  * Overtime-affecting values are keyed by workweek internally: hours and
  * additional earnings are job-then-name-then-workweekStart records, so the
  * single-workweek (or not-yet-split) case is just the degenerate one-key form
- * of the multi-workweek shape. Non-overtime earnings (other) are flat
+ * of the multi-workweek shape. Non-overtime earnings (`overtimeExcludedEarnings`) are flat
  * job-then-name-to-amount records with no per-workweek breakdown, since they do
  * not feed the blended rate. Time off and final payout are keyed by
  * compensation name. This keeps one schema and one submit path.
  *
  * A `superRefine` enforces per-row completeness on `hours` and
- * `additionalEarnings`: once any workweek cell in a job+name row is filled, every
+ * `overtimeIncludedEarnings`: once any workweek cell in a job+name row is filled, every
  * other cell in that row must be filled too, surfaced per empty cell as
  * {@link PayrollEditEmployeeErrorCodes.REQUIRED_WORKWEEK}. A row with nothing
  * filled is left alone (still submittable as untouched). This needs no
@@ -66,8 +66,8 @@ export declare const reimbursementDraftSchema: z.ZodObject<{
  */
 export declare function createPayrollEditEmployeeSchema(): z.ZodObject<{
     hours: z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>>>;
-    additionalEarnings: z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>>>;
-    other: z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>>;
+    overtimeIncludedEarnings: z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>>>;
+    overtimeExcludedEarnings: z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>>;
     timeOff: z.ZodRecord<z.ZodString, z.ZodString>;
     finalPayout: z.ZodRecord<z.ZodString, z.ZodString>;
     reimbursements: z.ZodArray<z.ZodObject<{

package/dist/src/components/Payroll/PayrollHistory/PayrollHistoryPresentation.d.ts

@@ -3,6 +3,8 @@ import { WireInRequest } from '@gusto/embedded-api/models/components/wireinreque
 import { PaginationControlProps } from '../../Common/PaginationControl/PaginationControlTypes';
 import { UseDateRangeFilterResult } from '../../../hooks/useDateRangeFilter/useDateRangeFilter';
 interface PayrollHistoryPresentationProps {
+    /** CSS class name applied to the root element. */
+    className?: string;
     payrollHistory: Payroll[];
     wireInRequests: WireInRequest[];
     pagination: PaginationControlProps;
@@ -16,5 +18,5 @@ interface PayrollHistoryPresentationProps {
     dateRangeFilter: UseDateRangeFilterResult;
 }
 /** @internal */
-export declare const PayrollHistoryPresentation: ({ payrollHistory, wireInRequests, pagination, onViewSummary, onViewReceipt, onCancelPayroll, cancelDialogItem, onCancelDialogOpen, onCancelDialogClose, isLoading, dateRangeFilter, }: PayrollHistoryPresentationProps) => import("react").JSX.Element;
+export declare const PayrollHistoryPresentation: ({ className, payrollHistory, wireInRequests, pagination, onViewSummary, onViewReceipt, onCancelPayroll, cancelDialogItem, onCancelDialogOpen, onCancelDialogClose, isLoading, dateRangeFilter, }: PayrollHistoryPresentationProps) => import("react").JSX.Element;
 export {};

package/dist/src/components/Payroll/PayrollList/PayrollListPresentation.d.ts

@@ -5,6 +5,8 @@ import { ApiPayrollBlocker } from '../PayrollBlocker/payrollHelpers';
 import { PaginationControlProps } from '../../Common/PaginationControl/PaginationControlTypes';
 import { UseDateRangeFilterResult } from '../../../hooks/useDateRangeFilter/useDateRangeFilter';
 interface PayrollListPresentationProps {
+    /** CSS class name applied to the root element. */
+    className?: string;
     onRunPayroll: ({ payrollUuid, payPeriod }: Pick<Payroll, 'payrollUuid' | 'payPeriod'>) => void;
     onSubmitPayroll: ({ payrollUuid, payPeriod }: Pick<Payroll, 'payrollUuid' | 'payPeriod'>) => void;
     onSkipPayroll: ({ payrollUuid }: Pick<Payroll, 'payrollUuid'>) => void;
@@ -26,5 +28,5 @@ interface PayrollListPresentationProps {
     withOffcyclePayroll?: boolean;
 }
 /** @internal */
-export declare const PayrollListPresentation: ({ onRunPayroll, onSubmitPayroll, onSkipPayroll, onDeletePayroll, onRunOffCyclePayroll, payrolls, pagination, paySchedules, showSkipSuccessAlert, onDismissSkipSuccessAlert, showDeleteSuccessAlert, onDismissDeleteSuccessAlert, skippingPayrollId, deletingPayrollId, blockers, wireInRequests, dateRangeFilter, hasUnprocessedTransitions, withOffcyclePayroll, }: PayrollListPresentationProps) => import("react").JSX.Element;
+export declare const PayrollListPresentation: ({ className, onRunPayroll, onSubmitPayroll, onSkipPayroll, onDeletePayroll, onRunOffCyclePayroll, payrolls, pagination, paySchedules, showSkipSuccessAlert, onDismissSkipSuccessAlert, showDeleteSuccessAlert, onDismissDeleteSuccessAlert, skippingPayrollId, deletingPayrollId, blockers, wireInRequests, dateRangeFilter, hasUnprocessedTransitions, withOffcyclePayroll, }: PayrollListPresentationProps) => import("react").JSX.Element;
 export {};

package/dist/src/components/Payroll/PayrollOverview/PayrollOverviewPresentation.d.ts

@@ -6,6 +6,7 @@ import { PayrollFlowAlert } from '../PayrollFlow/PayrollFlowComponents';
 import { PayrollOverviewStatus } from './PayrollOverviewTypes';
 import { PaginationControlProps } from '../../Common/PaginationControl/PaginationControlTypes';
 interface PayrollOverviewProps {
+    className?: string;
     payrollData: PayrollShow;
     employeeFlsaStatusByUuid?: Record<string, string | undefined>;
     bankAccount?: CompanyBankAccount;
@@ -34,5 +35,5 @@ interface PayrollOverviewProps {
     downloadingEmployeeIds?: ReadonlySet<string>;
 }
 /** @internal */
-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 declare const PayrollOverviewPresentation: ({ className, 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/PayrollOverview/useSubmissionPoll.d.ts

@@ -25,6 +25,15 @@ export interface UseSubmissionPollOptions {
     refetch: () => Promise<QueryObserverResult<PayrollsGetQueryData, PayrollsGetQueryError>>;
     onProcessed: (payroll: PayrollShow | undefined) => void;
     onProcessingFailed: (payroll: PayrollShow | undefined) => void;
+    /**
+     * Called when the poll gives up on a non-retryable read error, but only for a run that was
+     * actually tracking a submission (`baseline` set, or a `submitting` status observed mid-run).
+     * A baseline-less mount poll that never saw `submitting` swallows the error here -- it was only
+     * guarding the initial render, not watching a real submission, so surfacing it as a processing
+     * failure would be a false failure. The raw error is reported to observability by this hook
+     * either way.
+     */
+    onError: () => void;
 }
 /** @internal */
 export interface SubmissionPoll {
@@ -36,4 +45,4 @@ export interface SubmissionPoll {
  *
  * @internal
  */
-export declare function useSubmissionPoll({ refetch, onProcessed, onProcessingFailed, }: UseSubmissionPollOptions): SubmissionPoll;
+export declare function useSubmissionPoll({ refetch, onProcessed, onProcessingFailed, onError, }: UseSubmissionPollOptions): SubmissionPoll;

package/dist/src/components/Payroll/PayrollReceipts/PayrollReceiptsPresentation.d.ts

@@ -1,8 +1,9 @@
 import { PayrollReceipt } from '@gusto/embedded-api/models/components/payrollreceipt';
 interface PayrollReceiptsPresentationProps {
+    className?: string;
     receiptData: PayrollReceipt;
     withReimbursements?: boolean;
 }
 /** @internal */
-export declare const PayrollReceiptsPresentation: ({ receiptData, withReimbursements, }: PayrollReceiptsPresentationProps) => import("react").JSX.Element;
+export declare const PayrollReceiptsPresentation: ({ className, receiptData, withReimbursements, }: PayrollReceiptsPresentationProps) => import("react").JSX.Element;
 export {};

package/dist/src/components/Payroll/TransitionCreation/TransitionCreationPresentation.d.ts

@@ -6,4 +6,4 @@ import { TransitionCreationPresentationProps } from './TransitionCreationTypes';
  * @returns The transition payroll creation form layout.
  * @internal
  */
-export declare function TransitionCreationPresentation({ startDate, endDate, payScheduleName, isPending, taxWithholdingConfig, isTaxWithholdingModalOpen, onTaxWithholdingEditClick, onTaxWithholdingModalDone, onTaxWithholdingModalCancel, }: TransitionCreationPresentationProps): import("react").JSX.Element;
+export declare function TransitionCreationPresentation({ className, startDate, endDate, payScheduleName, isPending, taxWithholdingConfig, isTaxWithholdingModalOpen, onTaxWithholdingEditClick, onTaxWithholdingModalDone, onTaxWithholdingModalCancel, }: TransitionCreationPresentationProps): import("react").JSX.Element;

package/dist/src/components/Payroll/TransitionCreation/TransitionCreationTypes.d.ts

@@ -34,6 +34,8 @@ export declare function createTransitionCreationSchema(t: (key: string, options?
 }, z.core.$strip>;
 /** @internal */
 export interface TransitionCreationPresentationProps {
+    /** CSS class name applied to the component's root element. */
+    className?: string;
     /** The start date of the transition pay period (YYYY-MM-DD). */
     startDate: string;
     /** The end date of the transition pay period (YYYY-MM-DD). */

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

@@ -1,9 +1,11 @@
+import { LoaderComponentType } from '../../Base/Base';
 import { OnEventType } from '../../Base/useBase';
 import { EventType } from '../../../shared/constants';
 interface TransitionPayrollAlertProps {
     companyId: string;
     onEvent: OnEventType<EventType, unknown>;
+    LoaderComponent?: LoaderComponentType;
 }
 /** @internal */
-export declare function TransitionPayrollAlert({ companyId, onEvent }: TransitionPayrollAlertProps): import("react").JSX.Element;
+export declare function TransitionPayrollAlert({ companyId, onEvent, LoaderComponent, }: TransitionPayrollAlertProps): import("react").JSX.Element;
 export {};

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

@@ -6,7 +6,7 @@ import { PayrollEditEmployeeProps } from '../PayrollEditEmployee/PayrollEditEmpl
  * 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
+ * additional-earnings / time-off / 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`)

package/dist/src/components/TimeOff/AddEmployeesHoliday/AddEmployeesHoliday.d.ts

@@ -21,4 +21,4 @@ export interface AddEmployeesHolidayProps extends BaseComponentInterface<never>
  * @returns The rendered holiday employee selection screen.
  * @public
  */
-export declare function AddEmployeesHoliday(props: AddEmployeesHolidayProps): import("react").JSX.Element;
+export declare function AddEmployeesHoliday({ className, ...props }: AddEmployeesHolidayProps): import("react").JSX.Element;

package/dist/src/components/TimeOff/AddEmployeesToPolicy/AddEmployeesToPolicy.d.ts

@@ -50,4 +50,4 @@ export interface AddEmployeesToPolicyProps extends BaseComponentInterface<never>
  * }
  * ```
  */
-export declare function AddEmployeesToPolicy(props: AddEmployeesToPolicyProps): import("react").JSX.Element;
+export declare function AddEmployeesToPolicy({ className, ...props }: AddEmployeesToPolicyProps): import("react").JSX.Element;

package/dist/src/components/TimeOff/HolidayPolicyDetail/HolidayPolicyDetailPresentation.d.ts

@@ -1,3 +1,3 @@
 import { HolidayPolicyDetailPresentationProps } from './HolidayPolicyDetailTypes';
 /** @internal */
-export declare function HolidayPolicyDetailPresentation({ title, subtitle, onBack, backLabel, actions, holidays, selectedTabId, onTabChange, employees, onAddEmployee, removeDialog, successAlert, onDismissAlert, }: HolidayPolicyDetailPresentationProps): import("react").JSX.Element;
+export declare function HolidayPolicyDetailPresentation({ title, subtitle, onBack, backLabel, actions, holidays, selectedTabId, onTabChange, employees, onAddEmployee, removeDialog, successAlert, onDismissAlert, className, }: HolidayPolicyDetailPresentationProps): import("react").JSX.Element;