@gusto/embedded-react-sdk 0.57.3 → 0.58.0

package/dist/src/contexts/UnstableFeaturesProvider/useUnstableFeature.d.ts

@@ -4,24 +4,52 @@
  * @remarks
  * Pass to {@link GustoProvider} via the `unstableFeatures` prop to enable a feature ahead of its
  * public release. Every flag defaults to disabled when omitted. When a feature graduates to
- * public release, its flag is deleted from this interface along with the conditional checks that
- * read it — there is no deprecation step. This interface may have no flags at all at any given
- * time — e.g. immediately after the last active flag graduates and before the next one is added —
- * the opt-in mechanism itself is permanent even when nothing is currently gated behind it.
+ * public release, its flag is deleted from this interface — there is no deprecation step. The
+ * conditional checks that read it are deleted too, or moved to a {@link Features} flag when the
+ * released feature still needs a way to turn it off. This interface may have no flags at all
+ * at any given time — e.g. immediately after the last active flag graduates and before the next
+ * one is added — the opt-in mechanism itself is permanent even when nothing is currently gated
+ * behind it.
  *
  * @alpha
  */
 export interface UnstableFeatures {
-    /** Enables recording past payments to contractors within the `ContractorManagement` flows. */
+    /**
+     * Recording contractor payments that were made outside of Gusto.
+     *
+     * When `true`, `ContractorManagement.PaymentsList` (and `ContractorManagement.PaymentFlow`, which
+     * renders it) shows a "Record a historical payment" call to action that opens the historical
+     * payment flow. `ContractorManagement.HistoricalPaymentFlow`,
+     * `ContractorManagement.CreateHistoricalPayment`, and
+     * `ContractorManagement.HistoricalPaymentSummary` can be mounted.
+     *
+     * When `false`, the call to action is hidden and those three components throw when mounted.
+     *
+     * @defaultValue `false`
+     */
     historicalPayments?: boolean;
     /**
-     * Enables the in-development regular-rate-of-pay experience: the payroll editing flow, and the
-     * workweek start day field on `PaySchedule` that RRoP's overtime calculations depend on.
+     * Managing pay schedules and their employee assignments after onboarding.
+     *
+     * When `true`, `CompanyManagement.PaySchedule` and `CompanyManagement.PayScheduleAssignment` can
+     * be mounted.
+     *
+     * When `false`, both components throw when mounted. `CompanyOnboarding.PaySchedule` is not
+     * affected.
+     *
+     * @defaultValue `false`
      */
-    payrollRegularRateOfPay?: boolean;
-    /** Enables the in-development `CompanyManagement.PaySchedule` flow for managing pay schedules and their assignments after onboarding. */
     managePaySchedules?: boolean;
-    /** Enables the in-development `CompanyManagement.TaxPaymentsFlow` for reviewing a company's tax payments and their liabilities. */
+    /**
+     * Reviewing a company's tax payments and their liabilities.
+     *
+     * When `true`, `CompanyManagement.TaxPaymentsFlow`, `CompanyManagement.TaxPaymentsList`, and
+     * `CompanyManagement.TaxPaymentDetail` can be mounted.
+     *
+     * When `false`, all three components throw when mounted.
+     *
+     * @defaultValue `false`
+     */
     taxPayments?: boolean;
 }
 /**

package/dist/src/contexts/index.d.ts

@@ -6,3 +6,4 @@ export * from './ComponentAdapter/componentAdapterTypes';
 export type { GustoSDKTheme, GustoSDKThemeColors } from './ThemeProvider/theme';
 export { useNonce } from './NonceProvider';
 export type { UnstableFeatures } from './UnstableFeaturesProvider/useUnstableFeature';
+export type { Features } from './FeaturesProvider/useFeature';

package/dist/src/i18n/en/common.json.d.ts

@@ -160,7 +160,11 @@ declare const _default: {
   },
   "card": {
     "selectRowLabel": "Select row",
-    "selectAllRowsLabel": "Select all rows"
+    "selectAllRowsLabel": "Select all rows",
+    "sortByLabel": "Sort by",
+    "sortDefaultOption": "Default order",
+    "sortAscendingOption": "{{column}} (A\u2013Z)",
+    "sortDescendingOption": "{{column}} (Z\u2013A)"
   },
   "signatoryTitles": {
     "owner": "Owner",

package/dist/src/i18n/types.d.ts

@@ -258,14 +258,12 @@ export interface Resources {
   'Payroll.RecoveryCasesList': Translations.PayrollRecoveryCasesList
   /** */
   'Payroll.RecoveryCasesResubmit': Translations.PayrollRecoveryCasesResubmit
+  /** @internal */
+  'Payroll.RropPayrollEditEmployee': Translations.PayrollRropPayrollEditEmployee
   /** */
-  'Payroll.Transition': Translations.PayrollTransition
-  /** */
-  'Payroll.TransitionCreation': Translations.PayrollTransitionCreation
+  'Payroll.TransitionConfiguration': Translations.PayrollTransitionConfiguration
   /** */
   'Payroll.TransitionPayrollAlert': Translations.PayrollTransitionPayrollAlert
-  /** @internal */
-  'Payroll.UNSTABLE_PayrollEditEmployee': Translations.PayrollUNSTABLE_PayrollEditEmployee
   /** */
   'Payroll.WireInstructions': Translations.PayrollWireInstructions
   /** */
@@ -4077,6 +4075,14 @@ export namespace Translations {
       wageType: {
         /** @defaultValue `"Wage Type"` */
         label: string
+        /** @defaultValue `"Fixed"` */
+        fixedLabel: string
+        /** @defaultValue `"Hourly"` */
+        hourlyLabel: string
+        /** @defaultValue `"Pay a fixed amount each pay period."` */
+        fixedDescription: string
+        /** @defaultValue `"Pay based on hours worked."` */
+        hourlyDescription: string
       }
       hourlyRate: {
         /** @defaultValue `"Hourly Rate"` */
@@ -8146,6 +8152,12 @@ export namespace Translations {
       /** @defaultValue `"Hours must be less than or equal to 99,999"` */
       maxHours: string
     }
+    /** @defaultValue `"Preapproved hours"` */
+    preapprovedHoursColumn: string
+    /** @defaultValue `"Additional hours"` */
+    additionalHoursColumn: string
+    /** @defaultValue `"Type"` */
+    timeOffTypeColumn: string
   }
   /** Translation keys for the `Payroll.PayrollFlow` i18n namespace. */
   export interface PayrollPayrollFlow {
@@ -8246,6 +8258,8 @@ export namespace Translations {
     breadcrumbs: {
       /** @defaultValue `"Run payroll"` */
       landing: string
+      /** @defaultValue `"Transition payroll"` */
+      transitionConfiguration: string
       /** @defaultValue `"Summary for {{startDate}}-{{endDate}}"` */
       overview: string
       /** @defaultValue `"Payroll receipt for {{startDate}}-{{endDate}}"` */
@@ -8849,67 +8863,8 @@ export namespace Translations {
       }
     }
   }
-  /** Translation keys for the `Payroll.Transition` i18n namespace. */
-  export interface PayrollTransition {
-    /** @defaultValue `"Transition Payroll"` */
-    breadcrumbLabel: string
-  }
-  /** Translation keys for the `Payroll.TransitionCreation` i18n namespace. */
-  export interface PayrollTransitionCreation {
-    /** @defaultValue `"Transition Payroll"` */
-    breadcrumbLabel: string
-    /** @defaultValue `"Transition Payroll"` */
-    pageTitle: string
-    /** @defaultValue `"A transition payroll covers the gap between your old and new pay schedules."` */
-    pageDescription: string
-    /** @defaultValue `"When a pay schedule changes, there may be workdays that fall between the end of the old schedule and the start of the new one. This transition payroll ensures employees are paid for those days."` */
-    transitionExplanation: string
-    /** @defaultValue `"Transition Details"` */
-    detailsHeading: string
-    /** @defaultValue `"Pay period"` */
-    payPeriodLabel: string
-    /** @defaultValue `"Pay schedule"` */
-    payScheduleLabel: string
-    /** @defaultValue `"Check date"` */
-    checkDateLabel: string
-    /** @defaultValue `"Continue"` */
-    continueCta: string
-    errors: {
-      /** @defaultValue `"Transition payroll was created but no payroll ID was returned"` */
-      missingPayrollId: string
-      /** @defaultValue `"Check date is required"` */
-      checkDateRequired: string
-      /** @defaultValue `"Check date must be at least {{count}} business day from today"` */
-      checkDateAchLeadTime_one: string
-      /** @defaultValue `"Check date must be at least {{count}} business days from today"` */
-      checkDateAchLeadTime_other: string
-    }
-  }
-  /** Translation keys for the `Payroll.TransitionPayrollAlert` i18n namespace. */
-  export interface PayrollTransitionPayrollAlert {
-    /** @defaultValue `"Transition payroll - {{dateRange}}"` */
-    alertTitle: string
-    /** @defaultValue `"Because you changed your pay schedule, you'll need to run some transition payrolls. Transition payrolls let you pay employees for any workdays during gaps between pay schedules. You may choose to skip them, but it is your responsibility to ensure employees are paid properly. Regular payroll functionality is blocked until you either run or skip transition payrolls."` */
-    alertDescription: string
-    /** @defaultValue `"Run Transition Payroll"` */
-    runPayroll: string
-    /** @defaultValue `"Skip this payroll"` */
-    skipPayroll: string
-    /** @defaultValue `"Transition payroll skipped"` */
-    skipSuccessAlert: string
-    skipDialog: {
-      /** @defaultValue `"Skip {{dateRange}} transition payroll?"` */
-      title: string
-      /** @defaultValue `"Skipping this payroll means employees will not be paid for the transition period. It is your responsibility to ensure employees are paid properly."` */
-      body: string
-      /** @defaultValue `"Skip payroll"` */
-      confirmCta: string
-      /** @defaultValue `"Cancel"` */
-      cancelCta: string
-    }
-  }
-  /** Translation keys for the `Payroll.UNSTABLE_PayrollEditEmployee` i18n namespace. @internal */
-  export interface PayrollUNSTABLE_PayrollEditEmployee {
+  /** Translation keys for the `Payroll.RropPayrollEditEmployee` i18n namespace. @internal */
+  export interface PayrollRropPayrollEditEmployee {
     /** @defaultValue `"Edit payroll for {{employeeName}}"` */
     pageTitle: string
     /** @defaultValue `"{{firstName}} {{lastName}}"` */
@@ -9042,6 +8997,90 @@ export namespace Translations {
       /** @defaultValue `"Hours must be less than or equal to 99,999"` */
       maxHours: string
     }
+    /** @defaultValue `"Preapproved hours"` */
+    preapprovedHoursColumn: string
+    /** @defaultValue `"Additional hours"` */
+    additionalHoursColumn: string
+  }
+  /** Translation keys for the `Payroll.TransitionConfiguration` i18n namespace. */
+  export interface PayrollTransitionConfiguration {
+    /** @defaultValue `"Edit transition payroll"` */
+    pageTitle: string
+    /** @defaultValue `"A transition payroll covers the gap between your old and new pay schedules."` */
+    pageDescription: string
+    /** @defaultValue `"When a pay schedule changes, there may be workdays that fall between the end of the old schedule and the start of the new one. This transition payroll ensures employees are paid for those days."` */
+    transitionExplanation: string
+    /** @defaultValue `"Transition Details"` */
+    detailsHeading: string
+    /** @defaultValue `"Pay period"` */
+    payPeriodLabel: string
+    /** @defaultValue `"Pay schedule"` */
+    payScheduleLabel: string
+    /** @defaultValue `"Payment date"` */
+    checkDateLabel: string
+    /** @defaultValue `"Continue"` */
+    continueCta: string
+    errors: {
+      /** @defaultValue `"This transition payroll has no employees to update, so its settings could not be saved."` */
+      noEmployeeCompensations: string
+    }
+    deductions: {
+      /** @defaultValue `"Deductions and contributions"` */
+      title: string
+      /** @defaultValue `"Employers often block deductions and contributions from certain checks (i.e. bonus checks), since they are calculated on a per-pay-period basis. Deductions and contributions include loan repayments, garnishments, benefits, etc. Taxes will be included regardless of what is chosen."` */
+      description: string
+      options: {
+        /** @defaultValue `"Make all the regular deductions and contributions."` */
+        include: string
+        /** @defaultValue `"Block all deductions and contributions, except 401(k). Taxes will be included."` */
+        skip: string
+      }
+    }
+    wageTypeGroups: {
+      regular: {
+        /** @defaultValue `"Regular hours, regular wages, and tips"` */
+        label: string
+        /** @defaultValue `"These earnings should be taxed at a rate that matches your employees' regular pay schedule."` */
+        description: string
+      }
+      supplemental: {
+        /** @defaultValue `"Supplemental wages, bonus wages, commission"` */
+        label: string
+        /** @defaultValue `"These are typically taxed at the rate required by the IRS for federal income taxes and by the state for state income taxes."` */
+        description: string
+      }
+      reimbursement: {
+        /** @defaultValue `"Reimbursements"` */
+        label: string
+      }
+    }
+  }
+  /** Translation keys for the `Payroll.TransitionPayrollAlert` i18n namespace. */
+  export interface PayrollTransitionPayrollAlert {
+    /** @defaultValue `"Transition payroll - {{dateRange}}"` */
+    alertTitle: string
+    /** @defaultValue `"You have {{count}} transition payrolls to run or skip"` */
+    multipleAlertTitle: string
+    /** @defaultValue `"Because you changed your pay schedule, you'll need to run some transition payrolls. Transition payrolls let you pay employees for any workdays during gaps between pay schedules. You may choose to skip them, but it is your responsibility to ensure employees are paid properly. Regular payroll functionality is blocked until you either run or skip transition payrolls."` */
+    alertDescription: string
+    /** @defaultValue `"Run Transition Payroll"` */
+    runPayroll: string
+    /** @defaultValue `"Review and submit"` */
+    reviewPayroll: string
+    /** @defaultValue `"Skip this payroll"` */
+    skipPayroll: string
+    /** @defaultValue `"Transition payroll skipped"` */
+    skipSuccessAlert: string
+    skipDialog: {
+      /** @defaultValue `"Skip {{dateRange}} transition payroll?"` */
+      title: string
+      /** @defaultValue `"Skipping this payroll means employees will not be paid for the transition period. It is your responsibility to ensure employees are paid properly."` */
+      body: string
+      /** @defaultValue `"Skip payroll"` */
+      confirmCta: string
+      /** @defaultValue `"Cancel"` */
+      cancelCta: string
+    }
   }
   /** Translation keys for the `Payroll.WireInstructions` i18n namespace. */
   export interface PayrollWireInstructions {
@@ -9399,6 +9438,14 @@ export namespace Translations {
       selectRowLabel: string
       /** @defaultValue `"Select all rows"` */
       selectAllRowsLabel: string
+      /** @defaultValue `"Sort by"` */
+      sortByLabel: string
+      /** @defaultValue `"Default order"` */
+      sortDefaultOption: string
+      /** @defaultValue `"{{column}} (A–Z)"` */
+      sortAscendingOption: string
+      /** @defaultValue `"{{column}} (Z–A)"` */
+      sortDescendingOption: string
     }
     signatoryTitles: {
       /** @defaultValue `"Owner"` */

package/dist/src/partner-hook-utils/form/fields/RadioGroupHookField.d.ts

@@ -1,14 +1,14 @@
-import { ComponentType } from 'react';
+import { ComponentType, ReactNode } from 'react';
 import { BaseFieldProps, ValidationMessages, FormHookResult } from '../../types';
 import { RadioGroupProps } from '../../../components/Common/UI/RadioGroup/RadioGroupTypes';
 /**
  * Props accepted by a radio group field surfaced through a form hook.
- * Exposes `getOptionLabel` to customize how option entries are rendered as labels,
- * and `validationMessages` for custom error text alongside the shared base field
+ * Exposes `getOptionLabel` and `getOptionDescription` to customize how option entries are
+ * rendered, and `validationMessages` for custom error text alongside the shared base field
  * attributes (`label`, `description`).
  *
  * @typeParam TErrorCode - Validation error code keys mapped via `validationMessages`.
- * @typeParam TEntry - Shape of each option entry consumed by `getOptionLabel`.
+ * @typeParam TEntry - Shape of each option entry consumed by `getOptionLabel` and `getOptionDescription`.
  * @public
  * @group Hook field props
  */
@@ -21,6 +21,8 @@ export interface RadioGroupHookFieldProps<TErrorCode extends string = never, TEn
     validationMessages?: ValidationMessages<TErrorCode>;
     /** Maps a raw option entry to its display label; when omitted, options use the labels provided by the hook. */
     getOptionLabel?: (entry: TEntry) => string;
+    /** Maps a raw option entry to supporting text rendered beneath that radio option; when omitted, no per-option description is rendered. */
+    getOptionDescription?: (entry: TEntry) => ReactNode;
     /** Replaces the default radio group UI component; must accept the same props as `RadioGroupProps`. */
     FieldComponent?: ComponentType<RadioGroupProps>;
 }
@@ -28,9 +30,9 @@ export interface RadioGroupHookFieldProps<TErrorCode extends string = never, TEn
  * Radio group field connected to a partner form hook result via `useHookFieldResolution`.
  *
  * @typeParam TErrorCode - Validation error code keys mapped via `validationMessages`.
- * @typeParam TEntry - Shape of each option entry consumed by `getOptionLabel`.
- * @param props - Field configuration including `name`, `formHookResult`, and an optional `getOptionLabel`.
+ * @typeParam TEntry - Shape of each option entry consumed by `getOptionLabel` and `getOptionDescription`.
+ * @param props - Field configuration including `name`, `formHookResult`, and optional `getOptionLabel` / `getOptionDescription`.
  * @returns The rendered radio group field wrapped in the field element registry.
  * @internal
  */
-export declare function RadioGroupHookField<TErrorCode extends string, TEntry = unknown>({ name, formHookResult, label, description, validationMessages, getOptionLabel, FieldComponent, }: RadioGroupHookFieldProps<TErrorCode, TEntry>): import('react').ReactElement<unknown, string | import('react').JSXElementConstructor<any>>;
+export declare function RadioGroupHookField<TErrorCode extends string, TEntry = unknown>({ name, formHookResult, label, description, validationMessages, getOptionLabel, getOptionDescription, FieldComponent, }: RadioGroupHookFieldProps<TErrorCode, TEntry>): import('react').ReactElement<unknown, string | import('react').JSXElementConstructor<any>>;

package/dist/src/shared/constants.d.ts

@@ -475,8 +475,9 @@ export declare const offCycleEvents: {
     readonly OFF_CYCLE_CREATED: "offCycle/created";
     readonly OFF_CYCLE_BLOCKERS_VIEW_ALL: "offCycle/blockers/viewAll";
     readonly DISMISSAL_PAY_PERIOD_SELECTED: "dismissal/payPeriod/selected";
-    readonly TRANSITION_CREATED: "transition/created";
+    readonly TRANSITION_CONFIGURED: "transition/configured";
     readonly RUN_TRANSITION_PAYROLL: "transition/runPayroll";
+    readonly TRANSITION_PAYROLL_SELECTED: "transition/payrollSelected";
     readonly TRANSITION_PAYROLL_SKIPPED: "transition/payrollSkipped";
 };
 /**
@@ -589,8 +590,9 @@ export declare const componentEvents: {
     readonly OFF_CYCLE_CREATED: "offCycle/created";
     readonly OFF_CYCLE_BLOCKERS_VIEW_ALL: "offCycle/blockers/viewAll";
     readonly DISMISSAL_PAY_PERIOD_SELECTED: "dismissal/payPeriod/selected";
-    readonly TRANSITION_CREATED: "transition/created";
+    readonly TRANSITION_CONFIGURED: "transition/configured";
     readonly RUN_TRANSITION_PAYROLL: "transition/runPayroll";
+    readonly TRANSITION_PAYROLL_SELECTED: "transition/payrollSelected";
     readonly TRANSITION_PAYROLL_SKIPPED: "transition/payrollSkipped";
     readonly CONTRACTOR_HISTORICAL_PAYMENT_CREATE: "contractor/historicalPayments/create";
     readonly CONTRACTOR_HISTORICAL_PAYMENT_EDIT: "contractor/historicalPayments/edit";

package/dist/src/test-utils/renderWithProviders.d.ts

@@ -1,6 +1,7 @@
 import { ReactElement } from 'react';
 import { RenderOptions } from '@testing-library/react';
 import { UnstableFeatures } from '../contexts/UnstableFeaturesProvider/useUnstableFeature';
+import { Features } from '../contexts/FeaturesProvider/useFeature';
 /**
  * Custom render function that wraps the component with necessary providers
  * - ComponentsProvider: Provides UI components
@@ -8,5 +9,6 @@ import { UnstableFeatures } from '../contexts/UnstableFeaturesProvider/useUnstab
  * - I18nextProvider: Provides translation functions
  */
 export declare const renderWithProviders: (ui: ReactElement, options?: Omit<RenderOptions, "wrapper"> & {
+    features?: Features;
     unstableFeatures?: UnstableFeatures;
 }) => import('@testing-library/react').RenderResult<typeof import('@testing-library/dom/types/queries'), HTMLElement, HTMLElement>;