@gusto/embedded-react-sdk 0.57.2 → 0.58.0

package/dist/src/components/Company/PaySchedule/management/PayScheduleAssignment/AssignmentEmployeeStepPresentation.d.ts

@@ -0,0 +1,34 @@
+import { ShowEmployees } from '@gusto/embedded-api/models/components/showemployees';
+import { PayScheduleShow } from '@gusto/embedded-api/models/components/payschedulelistitem';
+/**
+ * Employee UUIDs and their selected schedules.
+ *
+ * @internal
+ */
+export type EmployeeSelection = {
+    employees: {
+        employeeUuid: string;
+        payScheduleUuid: string;
+    }[];
+};
+/**
+ * Props for the paginated employee assignment picker.
+ *
+ * @internal
+ */
+export interface AssignmentEmployeeStepPresentationProps {
+    employees: ShowEmployees[];
+    schedules: PayScheduleShow[];
+    selection: EmployeeSelection;
+    onBack: (selection: EmployeeSelection) => void;
+    onAddPaySchedule: (selection: EmployeeSelection) => void;
+    onContinue: (selection: EmployeeSelection) => void;
+}
+/**
+ * Renders a schedule picker for every employee, retaining choices across pages.
+ *
+ * @param props - Employee roster, schedule choices, draft, and navigation callbacks.
+ * @returns The paginated employee assignment step.
+ * @internal
+ */
+export declare function AssignmentEmployeeStepPresentation({ employees, schedules, selection, onBack, onAddPaySchedule, onContinue, }: AssignmentEmployeeStepPresentationProps): import('react').JSX.Element;

package/dist/src/components/Company/PaySchedule/management/PayScheduleAssignment/AssignmentScheduleStepPresentation.d.ts

@@ -1,11 +1,17 @@
-import { PayScheduleShow } from '@gusto/embedded-api/models/components/payscheduleshow';
+import { z } from 'zod';
+import { PayScheduleShow } from '@gusto/embedded-api/models/components/payschedulelistitem';
 /** @internal */
 export interface AssignmentScheduleStepPresentationProps {
     schedules: PayScheduleShow[];
     defaultPayScheduleUuid?: string;
-    onBack: () => void;
-    onAddPaySchedule: () => void;
+    onBack: (selection: ScheduleStepInputs) => void;
+    onAddPaySchedule: (selection: ScheduleStepInputs) => void;
     onContinue: (defaultPayScheduleUuid: string) => void;
 }
+declare const ScheduleStepSchema: z.ZodObject<{
+    defaultPayScheduleUuid: z.ZodString;
+}, z.core.$strip>;
+type ScheduleStepInputs = z.infer<typeof ScheduleStepSchema>;
 /** @internal */
 export declare function AssignmentScheduleStepPresentation({ schedules, defaultPayScheduleUuid, onBack, onAddPaySchedule, onContinue, }: AssignmentScheduleStepPresentationProps): import('react').JSX.Element;
+export {};

package/dist/src/components/Company/PaySchedule/management/PayScheduleAssignment/AssignmentTypeStepPresentation.d.ts

@@ -2,8 +2,12 @@ import { SupportedAssignmentType } from './usePayScheduleAssignment';
 /** @internal */
 export interface AssignmentTypeStepPresentationProps {
     defaultType?: SupportedAssignmentType;
+    hasEmployees?: boolean;
+    employeeAccessDenied?: boolean;
+    hasDepartments?: boolean;
+    departmentAccessDenied?: boolean;
     onBack: () => void;
     onContinue: (type: SupportedAssignmentType) => void;
 }
 /** @internal */
-export declare function AssignmentTypeStepPresentation({ defaultType, onBack, onContinue, }: AssignmentTypeStepPresentationProps): import('react').JSX.Element;
+export declare function AssignmentTypeStepPresentation({ defaultType, hasDepartments, hasEmployees, employeeAccessDenied, departmentAccessDenied, onBack, onContinue, }: AssignmentTypeStepPresentationProps): import('react').JSX.Element;

package/dist/src/components/Company/PaySchedule/management/PayScheduleAssignment/PayScheduleAssignment.d.ts

@@ -15,24 +15,24 @@ export interface PayScheduleAssignmentProps extends BaseComponentInterface<'Comp
  * Walks through choosing an assignment type, picking (or creating) a pay schedule, and reviewing
  * the employees and transition payrolls affected before submitting. Opens on the company's
  * current assignment, so submitting without changing anything is a no-op rather than a
- * reassignment. Two assignment types are
- * supported: one schedule for everyone (`single`), or separate schedules for hourly and salaried
- * employees (`hourly_salaried`). Picking the same schedule for both compensation types is
- * submitted as `single`. Can be mounted directly or launched from
+ * reassignment. Supports one schedule for everyone (`single`), separate schedules for hourly
+ * and salaried employees (`hourly_salaried`), or schedules by department (`by_department`),
+ * including a default for employees without a department, or individually (`by_employee`).
+ * Employee assignment requires employee and compensation read access and excludes terminated,
+ * historical, incomplete-onboarding, and missing-compensation employees. Selecting one schedule for every
+ * group is submitted as `single`. Can be mounted directly or launched from
  * `CompanyManagement.PaySchedule`'s Manage action.
  *
- * The internal step-to-step selection events (assignment type chosen, schedule picked) also
- * bubble through `onEvent` as a side effect of how the underlying `Flow` re-emits every event —
- * they carry no information a host needs mid-flow, since `assigned` reports the final outcome,
- * so they're intentionally left out of the table below.
+ * Step selection events also bubble through `onEvent`; the `assigned` event reports the
+ * final outcome. Adding a pay schedule can include the current selections in its event payload.
  *
  * @events
  * | Event | Description | Data |
  * | ----- | ----------- | ---- |
- * | `paySchedule/create` | The user chose to add a new pay schedule from the picker step | — |
+ * | `paySchedule/create` | The user chose to add a new pay schedule from the picker step | Optional current selections: `{ defaultPayScheduleUuid?: string; hourlyPayScheduleUuid?: string; salariedPayScheduleUuid?: string; departments?: { departmentUuid: string; payScheduleUuid: string }[]; employees?: { employeeUuid: string; payScheduleUuid: string }[] }` |
  * | `paySchedule/created` | A new pay schedule was created from the picker step | `{ paySchedule: PayScheduleShow }` |
  * | `paySchedule/management/assignment/cancel` | The user backed out of the flow entirely, from the first step | — |
- * | `paySchedule/management/assignment/assigned` | The assignment was submitted successfully | `{ employeeChanges: PayScheduleAssignmentEmployeeChange[] }` plus either `{ type: 'single'; defaultPayScheduleUuid: string }` or `{ type: 'hourly_salaried'; hourlyPayScheduleUuid: string; salariedPayScheduleUuid: string }` |
+ * | `paySchedule/management/assignment/assigned` | The assignment was submitted successfully | `{ employeeChanges: PayScheduleAssignmentEmployeeChange[] }` plus either `{ type: 'single'; defaultPayScheduleUuid: string }` or `{ type: 'hourly_salaried'; hourlyPayScheduleUuid: string; salariedPayScheduleUuid: string }` or `{ type: 'by_department'; defaultPayScheduleUuid: string; departments: { departmentUuid: string; payScheduleUuid: string }[] }` or `{ type: 'by_employee'; employees: { employeeUuid: string; payScheduleUuid: string }[] }` |
  *
  * @alpha
  */

package/dist/src/components/Company/PaySchedule/management/PayScheduleAssignment/PayScheduleAssignmentComponents.d.ts

@@ -1,7 +1,9 @@
 import { PayScheduleAssignmentBodyType } from '@gusto/embedded-api/models/components/payscheduleassignmentbody';
 import { PayScheduleAssignmentEmployeeChange } from '@gusto/embedded-api/models/components/payscheduleassignmentemployeechange';
-import { PayScheduleShow } from '@gusto/embedded-api/models/components/payscheduleshow';
-import { SupportedAssignmentType } from './usePayScheduleAssignment';
+import { PayScheduleShow } from '@gusto/embedded-api/models/components/payschedulelistitem';
+import { EmployeeSelection } from './AssignmentEmployeeStepPresentation';
+import { DepartmentSelection } from './AssignmentDepartmentStepPresentation';
+import { AssignmentDraft, SupportedAssignmentType } from './usePayScheduleAssignment';
 import { componentEvents } from '../../../../../shared/constants';
 /**
  * The assignment the user built, already collapsed to the type that actually gets submitted.
@@ -16,7 +18,11 @@ export type AssignmentSelection = {
     type: typeof PayScheduleAssignmentBodyType.HourlySalaried;
     hourlyPayScheduleUuid: string;
     salariedPayScheduleUuid: string;
-};
+} | ({
+    type: typeof PayScheduleAssignmentBodyType.ByDepartment;
+} & DepartmentSelection) | ({
+    type: typeof PayScheduleAssignmentBodyType.ByEmployee;
+} & EmployeeSelection);
 /** @internal */
 export type EventPayloads = {
     [componentEvents.PAY_SCHEDULE_ASSIGNMENT_TYPE_SELECTED]: {
@@ -27,7 +33,9 @@ export type EventPayloads = {
     } | {
         hourlyPayScheduleUuid: string;
         salariedPayScheduleUuid: string;
-    };
+    } | DepartmentSelection | EmployeeSelection;
+    [componentEvents.PAY_SCHEDULE_CREATE]: AssignmentDraft | undefined;
+    [componentEvents.PAY_SCHEDULE_ASSIGNMENT_BACK]: AssignmentDraft | undefined;
     [componentEvents.PAY_SCHEDULE_CREATED]: {
         paySchedule: PayScheduleShow;
     };

package/dist/src/components/Company/PaySchedule/management/PayScheduleAssignment/departmentAccess.d.ts

@@ -0,0 +1,19 @@
+import { Department } from '@gusto/embedded-api/models/components/department';
+/**
+ * Narrows department responses to entries that can be assigned a schedule.
+ *
+ * @param departments - Departments returned by the API.
+ * @returns Departments with a usable UUID.
+ * @internal
+ */
+export declare function getCompanyDepartments(departments: Department[] | undefined): (Department & {
+    uuid: string;
+})[];
+/**
+ * Identifies an assignment data request rejected for missing OAuth scopes.
+ *
+ * @param error - Assignment query error.
+ * @returns Whether access is unavailable because a required scope is missing.
+ * @internal
+ */
+export declare function isAssignmentAccessDenied(error: unknown): boolean;

package/dist/src/components/Company/PaySchedule/management/PayScheduleAssignment/employeeJob.d.ts

@@ -0,0 +1,17 @@
+import { ShowEmployees } from '@gusto/embedded-api/models/components/showemployees';
+/**
+ * Finds the primary job, falling back to the first job for older responses.
+ *
+ * @param employee - Employee whose job is needed.
+ * @returns The primary job, or undefined when no jobs exist.
+ * @internal
+ */
+export declare function getPrimaryJob(employee: Pick<ShowEmployees, 'jobs'>): import('@gusto/embedded-api/models/components/job.js').Job | undefined;
+/**
+ * Finds the primary job's current compensation without depending on array order.
+ *
+ * @param employee - Employee whose compensation is needed.
+ * @returns The named current compensation, or the first record when no pointer is supplied.
+ * @internal
+ */
+export declare function getPrimaryCompensation(employee: Pick<ShowEmployees, 'jobs'>): import('@gusto/embedded-api/models/components/compensation.js').Compensation | undefined;

package/dist/src/components/Company/PaySchedule/management/PayScheduleAssignment/scheduleLabel.d.ts

@@ -1,3 +1,3 @@
-import { PayScheduleShow } from '@gusto/embedded-api/models/components/payscheduleshow';
+import { PayScheduleShow } from '@gusto/embedded-api/models/components/payschedulelistitem';
 /** @internal */
 export declare function scheduleLabel(schedule: PayScheduleShow): string;

package/dist/src/components/Company/PaySchedule/management/PayScheduleAssignment/useAssignableEmployees.d.ts

@@ -0,0 +1,34 @@
+import { ShowEmployees } from '@gusto/embedded-api/models/components/showemployees';
+/**
+ * Checks the employee eligibility rules used by pay schedule assignment.
+ *
+ * @param employee - Employee returned by the list endpoint.
+ * @returns Whether the employee is onboarded, current, and has compensation data.
+ * @internal
+ */
+export declare function isAssignableEmployee(employee: ShowEmployees): boolean;
+/**
+ * Loads every employee page before exposing the assignable roster.
+ *
+ * @param companyId - Company whose employees are being assigned.
+ * @returns Loading state or the complete roster and any missing access or compensation data.
+ * @internal
+ */
+export declare function useAssignableEmployees(companyId: string): {
+    status: "loading";
+} | {
+    employees: ShowEmployees[];
+    accessDenied: boolean;
+    status: "ready";
+};
+/**
+ * Loads the complete assignable roster, suspending until every employee page is ready.
+ *
+ * @param companyId - Company whose employees are being assigned.
+ * @returns The complete roster and any missing compensation data.
+ * @internal
+ */
+export declare function useAssignableEmployeesSuspense(companyId: string): {
+    employees: ShowEmployees[];
+    accessDenied: boolean;
+};

package/dist/src/components/Company/PaySchedule/management/PayScheduleAssignment/usePayScheduleAssignment.d.ts

@@ -1,12 +1,23 @@
 import { PayScheduleAssignmentBodyType } from '@gusto/embedded-api/models/components/payscheduleassignmentbody';
+import { EmployeeSelection } from './AssignmentEmployeeStepPresentation';
+import { DepartmentSelection } from './AssignmentDepartmentStepPresentation';
 import { FlowContextInterface } from '../../../../Flow/useFlow';
 /**
- * The assignment types this flow supports. `by_employee` and `by_department` exist in the API
- * but have no step implementations, so they're unrepresentable here.
+ * The assignment types supported by the management flow.
  *
  * @internal
  */
-export type SupportedAssignmentType = Extract<PayScheduleAssignmentBodyType, 'single' | 'hourly_salaried'>;
+export type SupportedAssignmentType = Extract<PayScheduleAssignmentBodyType, 'single' | 'hourly_salaried' | 'by_department' | 'by_employee'>;
+/**
+ * Draft selections retained when moving between assignment steps.
+ *
+ * @internal
+ */
+export type AssignmentDraft = Partial<DepartmentSelection & EmployeeSelection> & {
+    assignmentType?: SupportedAssignmentType;
+    hourlyPayScheduleUuid?: string;
+    salariedPayScheduleUuid?: string;
+};
 /** @internal */
 export interface PayScheduleAssignmentContextInterface extends FlowContextInterface {
     companyId: string;
@@ -14,5 +25,7 @@ export interface PayScheduleAssignmentContextInterface extends FlowContextInterf
     defaultPayScheduleUuid?: string;
     hourlyPayScheduleUuid?: string;
     salariedPayScheduleUuid?: string;
+    departments?: DepartmentSelection['departments'];
+    employees?: EmployeeSelection['employees'];
     component: React.ComponentType | null;
 }

package/dist/src/components/Company/PaySchedule/management/PayScheduleCompensationOverviewPresentation.d.ts

@@ -1,4 +1,4 @@
-import { PayScheduleShow } from '@gusto/embedded-api/models/components/payscheduleshow';
+import { PayScheduleShow } from '@gusto/embedded-api/models/components/payschedulelistitem';
 /** @internal */
 export type CompensationType = 'hourly' | 'salaried';
 /** @internal */

package/dist/src/components/Company/PaySchedule/management/PayScheduleDepartmentOverviewPresentation.d.ts

@@ -0,0 +1,23 @@
+import { PayScheduleShow } from '@gusto/embedded-api/models/components/payschedulelistitem';
+/** @internal */
+export interface PayScheduleDepartmentRow {
+    departmentName: string;
+    schedule: PayScheduleShow;
+}
+/** @internal */
+export interface PayScheduleDepartmentOverviewPresentationProps {
+    /** One row per department, including employees without a department. */
+    rows: PayScheduleDepartmentRow[];
+    /** Shows the AutoPilot column and its row action when `true`. */
+    enableAutoPilot?: boolean;
+    /** Shows the Manage action when `true`. */
+    enableMultipleSchedules?: boolean;
+    /** Fired when the user chooses Edit schedule from a row menu. */
+    onEditSchedule: (schedule: PayScheduleShow) => void;
+    /** Fired when the user clicks Manage. */
+    onManageAssignment: () => void;
+    /** Fired when the user chooses AutoPilot from a row menu. */
+    onEditAutoPilot: (schedule: PayScheduleShow) => void;
+}
+/** @internal */
+export declare function PayScheduleDepartmentOverviewPresentation({ rows, enableAutoPilot, enableMultipleSchedules, onEditSchedule, onManageAssignment, onEditAutoPilot, }: PayScheduleDepartmentOverviewPresentationProps): import('react').JSX.Element;

package/dist/src/components/Company/PaySchedule/management/PayScheduleEmployeeOverviewPresentation.d.ts

@@ -0,0 +1,25 @@
+import { PayScheduleShow } from '@gusto/embedded-api/models/components/payschedulelistitem';
+/** @internal */
+export interface PayScheduleEmployeeRow {
+    employeeCount: number;
+    schedule: PayScheduleShow;
+}
+/** @internal */
+export interface PayScheduleEmployeeOverviewPresentationProps {
+    /** One row per assigned pay schedule. */
+    rows: PayScheduleEmployeeRow[];
+    /** Replaces the table with a warning while preserving management actions. */
+    accessDenied?: boolean;
+    /** Shows the AutoPilot column and its row action when `true`. */
+    enableAutoPilot?: boolean;
+    /** Shows the Manage action when `true`. */
+    enableMultipleSchedules?: boolean;
+    /** Fired when the user chooses Edit schedule from a row menu. */
+    onEditSchedule: (schedule: PayScheduleShow) => void;
+    /** Fired when the user clicks Manage. */
+    onManageAssignment: () => void;
+    /** Fired when the user chooses AutoPilot from a row menu. */
+    onEditAutoPilot: (schedule: PayScheduleShow) => void;
+}
+/** @internal */
+export declare function PayScheduleEmployeeOverviewPresentation({ rows, accessDenied, enableAutoPilot, enableMultipleSchedules, onEditSchedule, onManageAssignment, onEditAutoPilot, }: PayScheduleEmployeeOverviewPresentationProps): import('react').JSX.Element;

package/dist/src/components/Company/PaySchedule/management/PayScheduleManagementComponents.d.ts

@@ -1,4 +1,4 @@
-import { PayScheduleShow } from '@gusto/embedded-api/models/components/payscheduleshow';
+import { PayScheduleShow } from '@gusto/embedded-api/models/components/payschedulelistitem';
 import { PayScheduleDefaultValues } from '../PaySchedule';
 import { FlowContextInterface } from '../../../Flow/useFlow';
 /** @internal */

package/dist/src/components/Company/PaySchedule/management/PayScheduleOverviewPresentation.d.ts

@@ -1,4 +1,4 @@
-import { PayScheduleShow } from '@gusto/embedded-api/models/components/payscheduleshow';
+import { PayScheduleShow } from '@gusto/embedded-api/models/components/payschedulelistitem';
 /** @internal */
 export interface PayScheduleOverviewPresentationProps {
     /** The company's single pay schedule. */

package/dist/src/components/Company/PaySchedule/shared/usePayScheduleForm/fields.d.ts

@@ -84,7 +84,7 @@ export declare function Day2Field(props: Day2FieldProps): import('react').JSX.El
 /**
  * Props accepted by {@link usePayScheduleForm}'s `Fields.WorkweekStartDay` component.
  *
- * @alpha
+ * @public
  */
 export type WorkweekStartDayFieldProps = HookFieldProps<SelectHookFieldProps<never, PayScheduleWorkweekStartDay>>;
 /** @internal */

package/dist/src/components/Company/PaySchedule/shared/usePayScheduleForm/payScheduleSchema.d.ts

@@ -28,7 +28,7 @@ export type PayScheduleFrequency = "Every other week" | "Every week" | "Monthly"
 /**
  * Pay schedule workweek start day values accepted by {@link usePayScheduleForm}.
  *
- * @alpha
+ * @public
  */
 export type PayScheduleWorkweekStartDay = WorkweekStartDay;
 /**

package/dist/src/components/Company/PaySchedule/shared/usePayScheduleForm/usePayScheduleForm.d.ts

@@ -1,6 +1,6 @@
 import { ComponentType } from 'react';
 import { UseFormProps } from 'react-hook-form';
-import { PayScheduleShow } from '@gusto/embedded-api/models/components/payscheduleshow';
+import { PayScheduleShow } from '@gusto/embedded-api/models/components/payschedulelistitem';
 import { PaySchedulePreviewPayPeriod } from '@gusto/embedded-api/models/components/payschedulepreviewpayperiod';
 import { WorkweekStartDay } from '@gusto/embedded-api/models/components/payschedulecreaterequest';
 import { PayScheduleOptionalFieldsToRequire, PayScheduleFormData } from './payScheduleSchema';
@@ -31,15 +31,6 @@ export interface UsePayScheduleFormProps {
     validationMode?: UseFormProps['mode'];
     /** Auto-focus the first invalid field on submit. Set to `false` when using `composeSubmitHandler` so submit-time focus is coordinated across multiple forms. Defaults to `true`. */
     shouldFocusError?: boolean;
-    /**
-     * Renders `Fields.WorkweekStartDay` disabled while still submitting its current value,
-     * for partners that compute the workweek start day themselves and don't want end users
-     * editing it directly. Defaults to `false`. Has no effect unless the `payrollRegularRateOfPay`
-     * unstable feature is enabled.
-     *
-     * @alpha
-     */
-    disableWorkweekStartDayEditing?: boolean;
 }
 /**
  * Pre-bound field components exposed on `usePayScheduleForm().form.Fields`.
@@ -68,10 +59,8 @@ export interface PayScheduleFormFields {
     Day2: ComponentType<Day2FieldProps> | undefined;
     /**
      * Bound to `workweekStartDay`. Workweek start day selector, used for regular rate of pay
-     * overtime calculations. `undefined` unless the `payrollRegularRateOfPay` unstable feature
-     * is enabled.
-     *
-     * @alpha
+     * overtime calculations. `undefined` when the `regularRateOfPay` flag in {@link Features} is
+     * set to `false`.
      */
     WorkweekStartDay: ComponentType<WorkweekStartDayFieldProps> | undefined;
 }
@@ -175,7 +164,7 @@ export interface UsePayScheduleFormReady extends BaseFormHookReady<PayScheduleFi
  * }
  * ```
  */
-export declare function usePayScheduleForm({ companyId, payScheduleId, optionalFieldsToRequire, defaultValues: partnerDefaults, validationMode, shouldFocusError, disableWorkweekStartDayEditing, }: UsePayScheduleFormProps): HookLoadingResult | UsePayScheduleFormReady;
+export declare function usePayScheduleForm({ companyId, payScheduleId, optionalFieldsToRequire, defaultValues: partnerDefaults, validationMode, shouldFocusError, }: UsePayScheduleFormProps): HookLoadingResult | UsePayScheduleFormReady;
 /**
  * Discriminated union returned by {@link usePayScheduleForm}.
  *

package/dist/src/components/Contractor/ContractorList/management/ManagementContractorListView.d.ts

@@ -3,7 +3,7 @@ import { ContractorTab } from './ManagementContractorList';
 /** @internal */
 export interface ManagementContractorListViewProps extends Pick<Extract<UseContractorListResult, {
     isLoading: false;
-}>, 'pagination' | 'status'> {
+}>, 'pagination' | 'status' | 'sort'> {
     /** CSS class name applied to the root element. */
     className?: string;
     contractors: ContractorWithActions[];
@@ -23,4 +23,4 @@ export interface ManagementContractorListViewProps extends Pick<Extract<UseContr
     onAddContractor: () => void;
 }
 /** @internal */
-export declare function ManagementContractorListView({ className, contractors, isFetching, selectedTab, onTabChange, successMessage, status, pagination, onEdit, onView, onDismiss, onRehire, onDelete, onCancelSelfOnboarding, onCancelDismissal, onCancelRehire, onAddContractor, }: ManagementContractorListViewProps): import('react').JSX.Element;
+export declare function ManagementContractorListView({ className, contractors, isFetching, selectedTab, onTabChange, successMessage, status, pagination, sort, onEdit, onView, onDismiss, onRehire, onDelete, onCancelSelfOnboarding, onCancelDismissal, onCancelRehire, onAddContractor, }: ManagementContractorListViewProps): import('react').JSX.Element;

package/dist/src/components/Contractor/ContractorList/shared/index.d.ts

@@ -1 +1 @@
-export { useContractorList, type ContractorAction, type ContractorWithActions, type ContractorType, type UseContractorListProps, type UseContractorListResult, type UseContractorListReady, } from './useContractorList';
+export { useContractorList, type ContractorAction, type ContractorWithActions, type ContractorType, type ContractorSortField, type ContractorListSort, type UseContractorListProps, type UseContractorListResult, type UseContractorListReady, } from './useContractorList';

package/dist/src/components/Contractor/ContractorList/shared/useContractorList.d.ts

@@ -1,6 +1,7 @@
 import { Contractor } from '@gusto/embedded-api/models/components/contractor';
 import { ContractorOnboardingStatus as ContractorOnboardingStatusEntity } from '@gusto/embedded-api/models/components/contractoronboardingstatus';
 import { PaginationControlProps } from '../../../Common/PaginationControl/PaginationControlTypes';
+import { TableSortDirection } from '../../../Common/UI/Table/TableTypes';
 import { HookLoadingResult, BaseHookReady } from '../../../../partner-hook-utils/types';
 /**
  * Action that may be performed on a contractor row, determined by the contractor's onboarding
@@ -24,6 +25,27 @@ export interface ContractorWithActions extends Contractor {
  * @public
  */
 export type ContractorType = 'active' | 'onboarding' | 'terminated';
+/**
+ * Field the contractor list can be sorted by.
+ *
+ * @remarks
+ * `'name'` sorts by last name for individual contractors and by business name for business
+ * contractors, matching how each row is labelled.
+ *
+ * @public
+ */
+export type ContractorSortField = 'name';
+/**
+ * Sort applied to {@link useContractorList}.
+ *
+ * @public
+ */
+export interface ContractorListSort {
+    /** Field the list is ordered by. */
+    field: ContractorSortField;
+    /** Direction the field is ordered in. */
+    direction: TableSortDirection;
+}
 /**
  * Props for {@link useContractorList}.
  *
@@ -48,6 +70,13 @@ export interface UseContractorListReady extends BaseHookReady<{
 }> {
     /** Pagination controls for the current contractor list page. */
     pagination: PaginationControlProps;
+    /** Server-side sort state for the list, and the setter that re-queries with a new sort. */
+    sort: {
+        /** The active sort, or `undefined` while the list is in the API's default order. */
+        current?: ContractorListSort;
+        /** Applies a new sort, or clears it with `undefined`, and returns to page 1. */
+        onSortChange: (sort: ContractorListSort | undefined) => void;
+    };
     /** Actions that mutate a contractor's state, gated by the entry's `allowedActions`. */
     actions: {
         /** Deletes the contractor. */
@@ -80,6 +109,15 @@ export type UseContractorListResult = HookLoadingResult | UseContractorListReady
  * Page changes use placeholder data: the previous page stays rendered while the next one loads,
  * and `status.isFetching` flips to `true` during the request.
  *
+ * Sorting is applied by the API, so the order holds across pages. No sort is requested until
+ * `sort.onSortChange` is called, leaving the list in the API's default order until then, and
+ * calling it with `undefined` returns the list to that default order. Applying or clearing a sort
+ * returns to page 1 because the API sorts before it paginates. The sort persists across
+ * `contractorType` changes, since every filter sorts by the same field.
+ *
+ * The endpoint rejects a sort combined with a search term (HTTP 422), so a search filter added
+ * here would have to clear the sort.
+ *
  * @param input - Company and optional filter for the list.
  * @returns A {@link HookLoadingResult} while the first page is in flight, or a {@link UseContractorListReady} once data has arrived.
  * @public

package/dist/src/components/Contractor/Landing/Landing.d.ts

@@ -7,8 +7,11 @@ import { BaseComponentInterface } from '../../Base';
 export interface LandingProps extends BaseComponentInterface<'Contractor.Landing'> {
     /** UUID of the contractor entering the self-onboarding flow. */
     contractorId: string;
-    /** UUID of the company the contractor belongs to. */
-    companyId: string;
+    /**
+     * @deprecated
+     * UUID of the company the contractor belongs to.
+     */
+    companyId?: string;
 }
 /**
  * Landing page for the contractor self-onboarding flow. Displays a welcome

package/dist/src/components/Contractor/shared/hourlyRate.d.ts

@@ -0,0 +1,23 @@
+import { z } from 'zod';
+/**
+ * Largest hourly rate the contractor create/update API accepts. Mirrored client-side so an
+ * over-limit value is caught inline instead of round-tripping to an API error.
+ *
+ * @internal
+ */
+export declare const HOURLY_RATE_CAP = 1000000000000;
+/**
+ * Builds the `hourlyRate` validator shared by the contractor pay and contractor details forms.
+ *
+ * @remarks
+ * Only bounded to non-negative, so a Fixed contractor's default of 0 stays valid while the field
+ * doesn't apply to them. Each schema decides separately when an Hourly contractor must supply a
+ * rate — `superRefine` in `contractorPaySchema`, `requiredFieldsConfig` + `excludeFields` in
+ * `contractorDetailsSchema`.
+ *
+ * @param maxErrorCode - The calling schema's own "rate too large" error code, so validation types
+ *   stay derived from that schema's error-codes constant.
+ * @returns A `z.preprocess` validator producing a number between 0 and {@link HOURLY_RATE_CAP}.
+ * @internal
+ */
+export declare function createHourlyRateValidator(maxErrorCode: string): z.ZodPipe<z.ZodTransform<number, unknown>, z.ZodNumber>;

package/dist/src/components/Employee/Landing/Landing.d.ts

@@ -7,8 +7,11 @@ import { BaseComponentInterface } from '../../Base';
 export interface LandingProps extends BaseComponentInterface<'Employee.Landing'> {
     /** UUID of the employee entering the self-onboarding flow. */
     employeeId: string;
-    /** UUID of the company the employee belongs to. */
-    companyId: string;
+    /**
+     * @deprecated
+     * UUID of the company the employee belongs to.
+     */
+    companyId?: string;
 }
 /**
  * Landing page for the employee self-onboarding flow. Displays a welcome

package/dist/src/components/Payroll/OffCycleTaxWithholdingTable/getDefaultWithholdingPayPeriod.d.ts

@@ -0,0 +1,9 @@
+import { WithholdingPayPeriod } from '@gusto/embedded-api/models/operations/postv1companiescompanyidpayrolls';
+/**
+ * Resolves a withholding frequency, defaulting to every other week when it is absent.
+ *
+ * @param frequency - The saved payroll frequency or selected pay schedule frequency.
+ * @returns The frequency to use when initializing withholding settings.
+ * @internal
+ */
+export declare function getDefaultWithholdingPayPeriod(frequency: WithholdingPayPeriod | null | undefined): WithholdingPayPeriod;

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

@@ -2,7 +2,7 @@ import { ReactNode } from 'react';
 import { PayrollEmployeeCompensationsType } from '@gusto/embedded-api/models/components/payrollemployeecompensationstype';
 import { Employee } from '@gusto/embedded-api/models/components/employee';
 import { PayrollPayPeriodType } from '@gusto/embedded-api/models/components/payrollpayperiodtype';
-import { PayScheduleShow as PayScheduleObject } from '@gusto/embedded-api/models/components/payscheduleshow';
+import { PayScheduleShow as PayScheduleObject } from '@gusto/embedded-api/models/components/payschedulelistitem';
 import { PayrollCategory } from '../payrollTypes';
 import { ApiPayrollBlocker } from '../PayrollBlocker/payrollHelpers';
 import { PaginationControlProps } from '../../Common/PaginationControl/PaginationControlTypes';

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

@@ -1,7 +1,7 @@
 import { PayrollEmployeeCompensationsType } from '@gusto/embedded-api/models/components/payrollemployeecompensationstype';
 import { Employee } from '@gusto/embedded-api/models/components/employee';
 import { PayrollPayPeriodType } from '@gusto/embedded-api/models/components/payrollpayperiodtype';
-import { PayScheduleShow } from '@gusto/embedded-api/models/components/payscheduleshow';
+import { PayScheduleShow } from '@gusto/embedded-api/models/components/payschedulelistitem';
 import { PayrollCategory } from '../payrollTypes';
 import { PaginationControlProps } from '../../Common/PaginationControl/PaginationControlTypes';
 interface UsePayrollConfigurationDataParams {

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

@@ -1,7 +1,7 @@
 import { Employee } from '@gusto/embedded-api/models/components/employee';
 import { PayrollEmployeeCompensationsType } from '@gusto/embedded-api/models/components/payrollemployeecompensationstype';
 import { PayrollFixedCompensationTypesType } from '@gusto/embedded-api/models/components/payrollfixedcompensationtypestype';
-import { PayScheduleShow as PayScheduleObject } from '@gusto/embedded-api/models/components/payscheduleshow';
+import { PayScheduleShow as PayScheduleObject } from '@gusto/embedded-api/models/components/payschedulelistitem';
 import { z } from 'zod';
 import { PayrollCategory } from '../payrollTypes';
 interface PayrollEditEmployeeProps {

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

@@ -6,6 +6,8 @@ export interface TimeOffFieldProps {
     timeOff: PayrollEmployeeCompensationsTypePaidTimeOff;
     /** The employee whose accrual balance is displayed alongside the field. */
     employee: Employee;
+    /** Whether to visually hide the input label in a table row. */
+    shouldVisuallyHideLabel?: boolean;
 }
 /** @internal */
 export interface PayoutTimeOffFieldProps {
@@ -17,4 +19,4 @@ export interface PayoutTimeOffFieldProps {
 /** @internal */
 export declare const PayoutTimeOffField: ({ timeOff, employee }: PayoutTimeOffFieldProps) => import('react').JSX.Element | null;
 /** @internal */
-export declare const TimeOffField: ({ timeOff, employee }: TimeOffFieldProps) => import('react').JSX.Element | null;
+export declare const TimeOffField: ({ timeOff, employee, shouldVisuallyHideLabel }: TimeOffFieldProps) => import('react').JSX.Element | null;

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

@@ -109,6 +109,8 @@ export interface TimeOffEntry {
      * `description` to render it as the input's help text.
      */
     remaining: number | null;
+    /** Read-only approved request hours for this pay period; absent on final-payout rows. */
+    approvedRequestHours?: number;
 }
 /**
  * One entry in the flat `overtimeExcludedEarnings` section.

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

@@ -1,8 +1,8 @@
 import { UseFormProps } from 'react-hook-form';
 import { Employee } from '@gusto/embedded-api/models/components/employee';
 import { PayrollEmployeeCompensationsType } from '@gusto/embedded-api/models/components/payrollemployeecompensationstype';
-import { PayrollPrepared } from '@gusto/embedded-api/models/components/payrollshow';
-import { PayScheduleShow } from '@gusto/embedded-api/models/components/payscheduleshow';
+import { PayrollPrepared } from '@gusto/embedded-api/models/components/unprocessedpayroll';
+import { PayScheduleShow } from '@gusto/embedded-api/models/components/payschedulelistitem';
 import { PayrollEditEmployeeFormData } from './payrollEditEmployeeSchema';
 import { NormalizedWorkweek } from './payrollEditEmployeeHelpers';
 import { PayrollEditEmployeeErrorMessages, PayrollEditEmployeeFields, ReimbursementRow } from './fields';