@gusto/embedded-react-sdk 0.57.2 → 0.58.0

package/dist/src/components/Payroll/Transition/TransitionFlowComponents.d.ts

@@ -1,52 +0,0 @@
-import { PayrollFlowContextInterface } from '../PayrollFlow/PayrollFlowComponents';
-import { OnEventType } from '../../Base/useBase';
-import { EventType } from '../../../shared/constants';
-/**
- * Flow context shape carried through the transition payroll macro state machine.
- *
- * @remarks
- * Extends {@link PayrollFlowContextInterface} so the payroll-execution reducers reused by the
- * transition machine (overview, edit-employee, receipts, blockers) typecheck against a single
- * shared context shape.
- *
- * @internal
- */
-export interface TransitionFlowContextInterface extends PayrollFlowContextInterface {
-    /** Start date of the transition pay period (YYYY-MM-DD). */
-    startDate: string;
-    /** End date of the transition pay period (YYYY-MM-DD). */
-    endDate: string;
-    /** UUID of the pay schedule the transition is associated with. */
-    payScheduleUuid: string;
-}
-/**
- * Props for {@link TransitionFlow}.
- *
- * @public
- */
-export interface TransitionFlowProps {
-    /** Company running the transition payroll. */
-    companyId: string;
-    /** Start date of the transition pay period (YYYY-MM-DD). */
-    startDate: string;
-    /** End date of the transition pay period (YYYY-MM-DD). */
-    endDate: string;
-    /** UUID of the pay schedule the transition is associated with. */
-    payScheduleUuid: string;
-    /**
-     * UUID of an existing transition payroll. When provided, the flow skips the lookup and starts on
-     * configuration for this payroll. When omitted, it resolves the payroll for the pay period.
-     */
-    payrollUuid?: string;
-    /** Whether reimbursement fields are shown throughout the flow. Defaults to `true`. */
-    withReimbursements?: boolean;
-    /** Callback invoked for each event emitted by the flow and its child steps. */
-    onEvent: OnEventType<EventType, unknown>;
-}
-/**
- * Renders {@link TransitionPayroll} as the entry step of {@link TransitionFlow}, wiring its events
- * up to the flow's state machine.
- *
- * @internal
- */
-export declare function TransitionPayrollContextual(): import('react').JSX.Element;

package/dist/src/components/Payroll/Transition/index.d.ts

@@ -1,2 +0,0 @@
-export { TransitionFlow } from './TransitionFlow';
-export type { TransitionFlowProps } from './TransitionFlowComponents';

package/dist/src/components/Payroll/Transition/transitionStateMachine.d.ts

@@ -1,29 +0,0 @@
-import { BreadcrumbNodes } from '../../Common/FlowBreadcrumbs/FlowBreadcrumbsTypes';
-/**
- * Breadcrumb nodes for the transition payroll macro flow: the creation crumb merged with the
- * shared payroll-execution crumbs. `configuration` is nested under the creation crumb so the
- * "Transition Payroll" crumb persists in the trail once the flow advances past creation, matching
- * the display-only prefix the flow rendered before this refactor.
- *
- * @internal
- */
-export declare const transitionBreadcrumbsNodes: BreadcrumbNodes;
-/**
- * Macro state machine for {@link TransitionFlow}.
- *
- * @remarks
- * The entry state renders {@link TransitionPayroll}; the rest of the states are the shared
- * {@link payrollExecutionMachine} states, reused via object spread. The entry state reuses that
- * machine's onward transitions so configuration events route into overview / edit-employee /
- * blockers.
- *
- * @internal
- */
-export declare const transitionMachine: {
-    configuration: import('robot3').MachineState<any>;
-    overview: import('robot3').MachineState<any>;
-    editEmployee: import('robot3').MachineState<any>;
-    receipts: import('robot3').MachineState<any>;
-    blockers: import('robot3').MachineState<any>;
-    transitionPayroll: import('robot3').MachineState<any>;
-};

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

@@ -1,22 +0,0 @@
-import { TransitionCreationProps } from './TransitionCreationTypes';
-/**
- * Creation form for transition payrolls covering the gap between an old and new pay schedule.
- *
- * Displays the transition pay period and pay schedule information, and collects a check
- * date, deduction preference, and tax withholding configuration before submitting the
- * resulting off-cycle payroll for execution.
- *
- * @events
- * | Event | Description | Data |
- * | ----- | ----------- | ---- |
- * | `transition/created` | The transition payroll has been created | `{ payrollUuid: string }` |
- *
- * The check date must be at least the company's ACH lead time (typically two business
- * days) from today. Deductions default to included and tax withholding defaults to the
- * regular rate with an every-other-week pay period.
- *
- * @param props - {@link TransitionCreationProps} plus base component props.
- * @returns The transition payroll creation form.
- * @public
- */
-export declare function TransitionCreation(props: TransitionCreationProps): import('react').JSX.Element;

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

@@ -1,9 +0,0 @@
-import { TransitionCreationPresentationProps } from './TransitionCreationTypes';
-/**
- * Presentational layout for the transition payroll creation form.
- *
- * @param props - {@link TransitionCreationPresentationProps}.
- * @returns The transition payroll creation form layout.
- * @internal
- */
-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

@@ -1,57 +0,0 @@
-import { z } from 'zod';
-import { OffCycleTaxWithholdingConfig } from '../OffCycleTaxWithholdingTable/OffCycleTaxWithholdingTableTypes';
-import { BaseComponentInterface } from '../../Base/Base';
-/**
- * Props for the {@link TransitionCreation} component.
- *
- * @public
- */
-export interface TransitionCreationProps extends BaseComponentInterface<'Payroll.TransitionCreation'> {
-    /** The associated company identifier. */
-    companyId: 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). */
-    endDate: string;
-    /** The UUID of the pay schedule this transition is associated with. */
-    payScheduleUuid: string;
-}
-/**
- * Form values collected by the {@link TransitionCreation} component.
- *
- * @public
- */
-export interface TransitionCreationFormData {
-    /** The date employees will be paid. Must be at least the company's ACH lead time from today. */
-    checkDate: Date | null;
-    /** When `true`, regular deductions are skipped for this payroll. */
-    skipRegularDeductions: boolean;
-}
-/** @internal */
-export declare function createTransitionCreationSchema(t: (key: string, options?: Record<string, unknown>) => string, minCheckDate: Date, paymentSpeedDays?: number): z.ZodObject<{
-    checkDate: z.ZodNullable<z.ZodDate> & z.ZodType<Date, Date | null, z.core.$ZodTypeInternals<Date, Date | null>>;
-    skipRegularDeductions: z.ZodBoolean;
-}, 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). */
-    endDate: string;
-    /** Display name of the associated pay schedule, or `null` when none is available. */
-    payScheduleName: string | null;
-    /** Whether the create off-cycle mutation is in flight. */
-    isPending?: boolean;
-    /** Current tax withholding configuration shown in the table. */
-    taxWithholdingConfig: OffCycleTaxWithholdingConfig;
-    /** Whether the tax withholding edit modal is open. */
-    isTaxWithholdingModalOpen: boolean;
-    /** Fires when the user clicks the edit affordance on the tax withholding table. */
-    onTaxWithholdingEditClick: () => void;
-    /** Fires when the user confirms a new tax withholding configuration in the modal. */
-    onTaxWithholdingModalDone: (config: OffCycleTaxWithholdingConfig) => void;
-    /** Fires when the user dismisses the tax withholding modal without saving. */
-    onTaxWithholdingModalCancel: () => void;
-}

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

@@ -1,2 +0,0 @@
-export { TransitionCreation } from './TransitionCreation';
-export type { TransitionCreationProps, TransitionCreationFormData } from './TransitionCreationTypes';

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

@@ -1,55 +0,0 @@
-import { TransitionPayrollProps } from './TransitionPayrollTypes';
-/**
- * Resolves and runs a transition payroll for a pay-schedule change, picking up an existing
- * unprocessed transition payroll when one exists and creating one otherwise.
- *
- * @remarks
- * A transition payroll covers the gap that opens when a company changes its pay schedule. This
- * component looks up whether one already exists for the pay period and picks the starting screen:
- *
- * - If it exists, it starts on {@link PayrollConfiguration} for that payroll.
- * - Otherwise it starts on {@link TransitionCreation}, then advances to {@link PayrollConfiguration}
- *   once the payroll is created.
- *
- * Configuration events (calculate, employee edit, blockers, etc.) are emitted through `onEvent` for
- * the host to route. Compose it inside {@link TransitionFlow} for the full run-payroll experience,
- * or handle the events yourself.
- *
- * @events
- * | Event | Description | Data |
- * | ----- | ----------- | ---- |
- * | `transition/created` | The transition payroll has been created and the flow advances to configuration | `{ payrollUuid: string }` |
- *
- * Once configuration begins, all standard run-payroll events are emitted as well (e.g.
- * `runPayroll/calculated`, `runPayroll/employee/edit`, `runPayroll/blockers/viewAll`).
- *
- * @components
- * - {@link TransitionCreation}
- * - {@link PayrollConfiguration}
- *
- * @param props - See {@link TransitionPayrollProps}.
- * @returns The transition payroll component.
- * @public
- *
- * @example
- * ```tsx title="App.tsx"
- * import { Payroll, type EventType } from '@gusto/embedded-react-sdk'
- *
- * function MyApp() {
- *   return (
- *     <Payroll.TransitionPayroll
- *       companyId="a007e1ab-3595-43c2-ab4b-af7a5af2e365"
- *       startDate="2025-01-16"
- *       endDate="2025-01-31"
- *       payScheduleUuid="c75c1ef6-2ec0-4cca-94a5-8b4cf7e5ea21"
- *       onEvent={(eventType: EventType) => {
- *         if (eventType === 'runPayroll/calculated') {
- *           // Payroll calculated — navigate to your review screen
- *         }
- *       }}
- *     />
- *   )
- * }
- * ```
- */
-export declare function TransitionPayroll(props: TransitionPayrollProps): import('react').JSX.Element;

package/dist/src/components/Payroll/TransitionPayroll/TransitionPayrollComponents.d.ts

@@ -1,24 +0,0 @@
-import { FlowContextInterface } from '../../Flow/useFlow';
-/**
- * Flow context shape carried through the {@link TransitionPayroll} state machine.
- *
- * @internal
- */
-export interface TransitionPayrollContextInterface extends FlowContextInterface {
-    /** Company the transition payroll belongs to. */
-    companyId: string;
-    /** Start date of the transition pay period (YYYY-MM-DD). */
-    startDate: string;
-    /** End date of the transition pay period (YYYY-MM-DD). */
-    endDate: string;
-    /** UUID of the pay schedule the transition is associated with. */
-    payScheduleUuid: string;
-    /** UUID of the transition payroll once it has been resolved or created. */
-    payrollUuid?: string;
-    /** Whether reimbursement fields are shown on the configuration screen. Defaults to `true`. */
-    withReimbursements?: boolean;
-}
-/** @internal */
-export declare function TransitionCreationContextual(): import('react').JSX.Element;
-/** @internal */
-export declare function PayrollConfigurationContextual(): import('react').JSX.Element;

package/dist/src/components/Payroll/TransitionPayroll/TransitionPayrollTypes.d.ts

@@ -1,23 +0,0 @@
-import { BaseComponentInterface } from '../../Base/Base';
-/**
- * Props for {@link TransitionPayroll}.
- *
- * @public
- */
-export interface TransitionPayrollProps extends BaseComponentInterface {
-    /** The company running the transition payroll. */
-    companyId: 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). */
-    endDate: string;
-    /** The UUID of the pay schedule the transition is associated with. */
-    payScheduleUuid: string;
-    /**
-     * UUID of an existing transition payroll. When provided, the component skips the lookup and starts
-     * on configuration for this payroll. When omitted, it resolves the payroll for the pay period.
-     */
-    payrollUuid?: string;
-    /** Whether reimbursement fields are shown on the configuration screen. Defaults to `true`. */
-    withReimbursements?: boolean;
-}

package/dist/src/components/Payroll/TransitionPayroll/index.d.ts

@@ -1,2 +0,0 @@
-export { TransitionPayroll } from './TransitionPayroll';
-export type { TransitionPayrollProps } from './TransitionPayrollTypes';

package/dist/src/components/Payroll/TransitionPayroll/transitionPayrollStateMachine.d.ts

@@ -1,15 +0,0 @@
-/**
- * State machine for {@link TransitionPayroll}.
- *
- * @remarks
- * `creation` shows {@link TransitionCreation}; `configuration` shows {@link PayrollConfiguration}.
- * The component freezes the initial state from the resolve lookup. `configuration` has no outgoing
- * transitions (a plain zero-transition state, not a robot3 final state per SDK-1169) so its events
- * bubble via `onEvent` and the screen keeps working if the host stays mounted past completion.
- *
- * @internal
- */
-export declare const transitionPayrollMachine: {
-    creation: import('robot3').MachineState<any>;
-    configuration: import('robot3').MachineState<any>;
-};

package/dist/src/components/Payroll/TransitionPayroll/useResolveTransitionPayroll.d.ts

@@ -1,28 +0,0 @@
-/**
- * Arguments describing the transition pay period to resolve.
- *
- * @internal
- */
-export interface ResolveTransitionPayrollArgs {
-    companyId: string;
-    startDate: string;
-    endDate: string;
-    payScheduleUuid: string;
-}
-/**
- * Looks up an existing unprocessed transition payroll for the given pay period.
- *
- * @remarks
- * A transition payroll is an unprocessed off-cycle payroll whose `offCycleReason` is
- * `"Transition from old pay schedule"` and whose pay period matches the supplied
- * `startDate`, `endDate`, and `payScheduleUuid`. When the company changed its pay schedule
- * the platform creates exactly one such payroll for the coverage gap; this hook finds it so
- * the caller can resume it instead of creating a duplicate.
- *
- * Backed by a suspense query, so callers must render it under a suspense boundary.
- *
- * @param args - The pay period to match. See {@link ResolveTransitionPayrollArgs}.
- * @returns The matching payroll's UUID, or `undefined` when none exists yet.
- * @internal
- */
-export declare function useResolveTransitionPayroll({ companyId, startDate, endDate, payScheduleUuid, }: ResolveTransitionPayrollArgs): string | undefined;