@gusto/embedded-react-sdk 0.56.2 → 0.56.3

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

@@ -15,7 +15,13 @@ interface TransitionPayrollAlertPresentationProps {
     showSkipSuccessAlert: boolean;
     onDismissSkipSuccessAlert: () => void;
     skippingPayPeriod: PayPeriod | null;
+    /**
+     * When true, a payroll blocker is present. Running or skipping the
+     * transition payroll would dead-end, so both actions are disabled. The
+     * blocker itself is surfaced separately by `PayrollBlockerAlerts`.
+     */
+    hasBlockers?: boolean;
 }
 /** @internal */
-export declare function TransitionPayrollAlertPresentation({ groupedPayPeriods, onRunPayroll, onSkipPayroll, showSkipSuccessAlert, onDismissSkipSuccessAlert, skippingPayPeriod, }: TransitionPayrollAlertPresentationProps): import('react').JSX.Element | null;
+export declare function TransitionPayrollAlertPresentation({ groupedPayPeriods, onRunPayroll, onSkipPayroll, showSkipSuccessAlert, onDismissSkipSuccessAlert, skippingPayPeriod, hasBlockers, }: TransitionPayrollAlertPresentationProps): import('react').JSX.Element | null;
 export {};

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

@@ -7,6 +7,7 @@ import { PayScheduleShow as PayScheduleObject } from '@gusto/embedded-api/models
 import { Payroll } from '@gusto/embedded-api/models/components/payrollshow';
 import { PayrollType } from './PayrollList/types';
 import { PayrollCategory } from './payrollTypes';
+import { useDateFormatter } from '../../hooks/useDateFormatter';
 /**
  * The compensation fields the payroll math helpers operate on.
  *
@@ -168,6 +169,39 @@ export declare const getPayrollType: (payroll: {
  * @internal
  */
 export declare const isDismissalPayroll: (offCycleReason?: string | null) => boolean;
+/**
+ * Returns whether an off-cycle reason indicates a tax reconciliation payroll.
+ *
+ * @remarks
+ * Tax reconciliation payrolls are created by Gusto rather than run by the partner. They come
+ * back processed with no pay period and no `calculatedAt`, so callers use this to grant them a
+ * targeted exception from checks that otherwise assume every payroll has both.
+ *
+ * @param offCycleReason - The payroll's off-cycle reason string.
+ * @returns `true` when the reason matches the tax reconciliation reason.
+ * @internal
+ */
+export declare const isTaxReconciliationPayroll: (offCycleReason?: string | null) => boolean;
+/**
+ * Returns a formatted pay-period range, falling back to the formatted check date when the
+ * payroll has no pay period.
+ *
+ * @remarks
+ * Tax reconciliation payrolls always have a null `pay_period`, so anywhere a pay-period date
+ * is used to identify a payroll on screen needs this fallback to avoid rendering blank space.
+ *
+ * @param payroll - The payroll to derive a date label for.
+ * @param dateFormatter - The date formatter returned by {@link useDateFormatter}.
+ * @returns The formatted pay-period range, or the formatted check date when no pay period exists.
+ * @internal
+ */
+export declare const getPayPeriodOrCheckDateLabel: (payroll: {
+    payPeriod?: {
+        startDate?: string | null;
+        endDate?: string | null;
+    } | null;
+    checkDate?: string | Date | null;
+}, dateFormatter: ReturnType<typeof useDateFormatter>) => string;
 /**
  * Returns a human-readable label describing the payroll type, mapping off-cycle reasons to display strings.
  *

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

@@ -6,6 +6,11 @@ interface UsePreparedPayrollDataParams {
     employeeUuids?: string[];
     sortBy?: string;
     onDataReady?: (preparedPayroll: PayrollPrepared) => void;
+    /**
+     * When true, prepare is called without a roster. A transition payroll's roster is fixed by the
+     * pay-schedule transition, so the API rejects any `employeeUuids` sent to prepare.
+     */
+    isTransitionPayroll?: boolean;
 }
 interface UsePreparedPayrollDataReturn {
     handlePreparePayroll: () => Promise<void>;
@@ -27,5 +32,5 @@ interface UsePreparedPayrollDataReturn {
  * @returns The prepared payroll, its pay schedule, loading flags, and a `handlePreparePayroll` callback to re-run.
  * @internal
  */
-export declare const usePreparedPayrollData: ({ companyId, payrollId, employeeUuids, sortBy, onDataReady, }: UsePreparedPayrollDataParams) => UsePreparedPayrollDataReturn;
+export declare const usePreparedPayrollData: ({ companyId, payrollId, employeeUuids, sortBy, onDataReady, isTransitionPayroll, }: UsePreparedPayrollDataParams) => UsePreparedPayrollDataReturn;
 export {};

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

@@ -64,6 +64,18 @@ export * as EmployeeManagement from './Employee/exports/employeeManagement';
  * @group Component namespaces
  */
 export * as CompanyOnboarding from './Company/exports/companyOnboarding';
+/**
+ * Flows and blocks for managing a company's pay schedule after onboarding.
+ *
+ * @remarks
+ * ```ts
+ * import { CompanyManagement } from '@gusto/embedded-react-sdk'
+ * ```
+ *
+ * @group Component namespaces
+ * @alpha
+ */
+export * as CompanyManagement from './Company/exports/companyManagement';
 /**
  * Flows and blocks for onboarding contractors.
  *

package/dist/src/contexts/ApiProvider/informationRequestEnumHook.d.ts

@@ -0,0 +1,14 @@
+import { AfterSuccessHook } from '../../types/hooks';
+/**
+ * Temporary workaround for a Gusto-Partner-API spec gap: `InformationRequest.type`, `.status`, and
+ * `requiredQuestions[].responseType` are generated as closed enums (`z.nativeEnum`) in
+ * `@gusto/embedded-api`, so a value the published OAS doesn't list makes the whole
+ * `GetInformationRequests` response throw an `SDKValidationError` -- taking down every
+ * `useInformationRequestsGetInformationRequestsSuspense` call site (including the payroll blocker
+ * RFI surface, SDK-1347). This afterSuccess hook remaps any value outside those closed enums to a
+ * safe known member before the SDK's zod parse, so the response still validates and the request
+ * stays viewable. Remove once the client supports lax/open enum parsing for these fields.
+ *
+ * @internal
+ */
+export declare const informationRequestEnumHook: AfterSuccessHook;

package/dist/src/contexts/ApiProvider/informationRequestEnumHook.test.d.ts

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

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

@@ -19,6 +19,8 @@ export interface UnstableFeatures {
      * workweek start day field on `PaySchedule` that RRoP's overtime calculations depend on.
      */
     payrollRegularRateOfPay?: boolean;
+    /** Enables the in-development `CompanyManagement.PaySchedule` flow for managing pay schedules and their assignments after onboarding. */
+    managePaySchedules?: boolean;
 }
 /**
  * React context backing {@link useUnstableFeature}.

package/dist/src/helpers/dateFormatting.d.ts

@@ -83,8 +83,8 @@ export declare const formatPayPeriod: (startDateInput?: string | Date | null, en
  * @param endDateInput - Pay period end date.
  * @param locale - Optional BCP 47 locale tag passed to `toLocaleDateString`.
  * @param options - When `useShortMonth` is true, both ends use short month names.
- * Otherwise the start uses the long month name and the end uses short.
- * @returns The formatted range (e.g. `January 1–Jan 15, 2025`), or an empty
+ * Otherwise both use the long month name.
+ * @returns The formatted range (e.g. `January 1–January 15, 2025`), or an empty
  * string when either input cannot be parsed.
  * @internal
  */

package/dist/src/helpers/formattedStrings.d.ts

@@ -135,6 +135,21 @@ export declare function createMarkup(dirty: string): {
  * @internal
  */
 export declare const removeNonDigits: (value: string) => string;
+/**
+ * Removes redundant leading zeros from a numeric input string.
+ *
+ * @remarks Intended as a `transform` for controlled `type="number"` text
+ * fields, which store their value verbatim. Several payroll inputs are
+ * seeded with `"0"`, so typing into one without clearing it would otherwise
+ * leave a value like `"05"`. Only zeros immediately followed by another
+ * digit are stripped, so `"0"`, `"0.5"`, and an empty string are preserved,
+ * and any leading sign is retained (`"-05"` becomes `"-5"`).
+ *
+ * @param value - The raw input string.
+ * @returns The input with redundant leading zeros removed.
+ * @internal
+ */
+export declare const stripLeadingZeros: (value: string) => string;
 /**
  * Strips the trailing `.value` segment from an API error path.
  *

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

@@ -6,7 +6,6 @@ declare const _default: {
     "errorEncountered": "There was a problem with your submission",
     "multipleErrorsEncountered": "There were multiple problems with your submission"
   },
-  "optionalLabel": "(optional)",
   "selectPlaceholder": "Select an option...",
   "progressBarLabel": "You are on step {{currentStep}} of {{totalSteps}}",
   "back": "Back",

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

@@ -29,6 +29,10 @@ export interface Resources {
   /** */
   'Company.Locations': Translations.CompanyLocations
   /** */
+  'Company.Management.PaySchedule': Translations.CompanyManagementPaySchedule
+  /** */
+  'Company.Management.PayScheduleAssignment': Translations.CompanyManagementPayScheduleAssignment
+  /** */
   'Company.OnboardingOverview': Translations.CompanyOnboardingOverview
   /** */
   'Company.PaySchedule': Translations.CompanyPaySchedule
@@ -936,6 +940,92 @@ export namespace Translations {
       phone: string
     }
   }
+  /** Translation keys for the `Company.Management.PaySchedule` i18n namespace. */
+  export interface CompanyManagementPaySchedule {
+    /** @defaultValue `"Pay schedule"` */
+    title: string
+    /** @defaultValue `"You have assigned everyone to be on one pay schedule."` */
+    description: string
+    /** @defaultValue `"Manage"` */
+    manageCta: string
+    /** @defaultValue `"Edit"` */
+    editCta: string
+    /** @defaultValue `"Edit pay schedule"` */
+    editScheduleAriaLabel: string
+    /** @defaultValue `"Edit AutoPilot"` */
+    editAutoPilotAriaLabel: string
+    labels: {
+      /** @defaultValue `"Name"` */
+      name: string
+      /** @defaultValue `"Frequency"` */
+      frequency: string
+    }
+    autoPilot: {
+      /** @defaultValue `"AutoPilot"` */
+      label: string
+      /** @defaultValue `"Enabled"` */
+      enabled: string
+      /** @defaultValue `"Disabled"` */
+      disabled: string
+    }
+    alerts: {
+      /** @defaultValue `"Pay schedule assignment updated."` */
+      assignmentUpdated: string
+    }
+  }
+  /** Translation keys for the `Company.Management.PayScheduleAssignment` i18n namespace. */
+  export interface CompanyManagementPayScheduleAssignment {
+    typeStep: {
+      /** @defaultValue `"Choose schedule type"` */
+      heading: string
+      /** @defaultValue `"After you choose, you can create a pay schedule for each group."` */
+      description: string
+      options: {
+        single: {
+          /** @defaultValue `"Everyone on one schedule"` */
+          label: string
+          /** @defaultValue `"Choose one pay schedule for all your employees"` */
+          description: string
+        }
+      }
+    }
+    scheduleStep: {
+      /** @defaultValue `"Assign employees"` */
+      heading: string
+      /** @defaultValue `"Pay schedule"` */
+      payScheduleLabel: string
+      /** @defaultValue `"The pay schedule to use for all employees."` */
+      payScheduleDescription: string
+      /** @defaultValue `"Add pay schedule"` */
+      addPayScheduleCta: string
+    }
+    reviewStep: {
+      /** @defaultValue `"Review changes"` */
+      heading: string
+      /** @defaultValue `"There are no changes to review."` */
+      noChangesHeading: string
+      /** @defaultValue `"If you intended to make changes, please go back and make them."` */
+      noChangesDescription: string
+      /** @defaultValue `"Employees affected"` */
+      employeeChangesHeading: string
+      /** @defaultValue `"Name"` */
+      nameLabel: string
+      /** @defaultValue `"Transition pay period"` */
+      transitionPayPeriodLabel: string
+      /** @defaultValue `"New pay frequency"` */
+      payFrequencyLabel: string
+      /** @defaultValue `"First pay period"` */
+      firstPayPeriodLabel: string
+      /** @defaultValue `"No transition needed"` */
+      noTransitionNeeded: string
+    }
+    /** @defaultValue `"Back"` */
+    backCta: string
+    /** @defaultValue `"Continue"` */
+    continueCta: string
+    /** @defaultValue `"Submit"` */
+    submitCta: string
+  }
   /** Translation keys for the `Company.OnboardingOverview` i18n namespace. */
   export interface CompanyOnboardingOverview {
     /** @defaultValue `"Nice! We’ll take it from here."` */
@@ -1232,6 +1322,10 @@ export namespace Translations {
       noEditableRequirementsTitle: string
       /** @defaultValue `"This state does not have any editable tax requirements."` */
       noEditableRequirementsDescription: string
+      errors: {
+        /** @defaultValue `"{{section}} for {{state}} is incomplete. Complete all required fields and try again."` */
+        incompleteRequirementSet: string
+      }
       validations: {
         /** @defaultValue `"Minimum value is {{min}}%"` */
         minValue: string
@@ -6977,8 +7071,6 @@ export namespace Translations {
     netPayLabel: string
     /** @defaultValue `"Calculate"` */
     calculateCta: string
-    /** @defaultValue `"Calculating..."` */
-    calculatingCta: string
     /** @defaultValue `"Apply"` */
     applyCta: string
     /** @defaultValue `"Calculate a gross amount first to apply it."` */
@@ -7879,7 +7971,7 @@ export namespace Translations {
     overviewTitle: string
     /** @defaultValue `"Payroll summary"` */
     summaryTitle: string
-    /** @defaultValue `"{{payrollType}} payroll for <dateWrapper>{{startDate}} - {{endDate}}</dateWrapper>"` */
+    /** @defaultValue `"{{payrollType}} payroll for <dateWrapper>{{payPeriod}}</dateWrapper>"` */
     pageSubtitle: string
     /** @defaultValue `"{{payrollType}} payroll"` */
     pageSubtitleDismissal: string
@@ -7889,7 +7981,7 @@ export namespace Translations {
     editCta: string
     /** @defaultValue `"Cancel payroll"` */
     cancelCta: string
-    /** @defaultValue `"Cancel {{startDate}} - {{endDate}} payroll?"` */
+    /** @defaultValue `"Cancel {{payPeriod}} payroll?"` */
     cancelDialogTitle: string
     /** @defaultValue `"Cancel payroll?"` */
     cancelDialogTitleDismissal: string
@@ -8626,8 +8718,6 @@ export namespace Translations {
       /** @defaultValue `"There were multiple problems with your submission"` */
       multipleErrorsEncountered: string
     }
-    /** @defaultValue `"(optional)"` */
-    optionalLabel: string
     /** @defaultValue `"Select an option..."` */
     selectPlaceholder: string
     /** @defaultValue `"You are on step {{currentStep}} of {{totalSteps}}"` */

package/dist/src/models/external.d.ts

@@ -306,6 +306,18 @@ export type { PayrollUpdateReimbursements } from '@gusto/embedded-api/models/com
 export type { PayrollUpdateState } from '@gusto/embedded-api/models/components/payrollupdate';
 export type { PayrollUpdateCustomWithholdings, PayrollUpdateDeductions, PayrollUpdateFederal, PayrollUpdateFixedCompensations, PayrollUpdateHourlyCompensations, } from '@gusto/embedded-api/models/components/payrollupdate';
 export { PayrollUpdateAmountType, PayrollUpdateEmployeeCompensationsAmountType, PayrollUpdateEmployeeCompensationsCustomWithholdingsAmountType, PayrollUpdateEmployeeCompensationsOverrideType, PayrollUpdateOverrideType, PayrollUpdatePaymentMethod, } from '@gusto/embedded-api/models/components/payrollupdate';
+/** `Departments` entity from the Gusto Embedded API. */
+export type { Departments } from '@gusto/embedded-api/models/components/payscheduleassignmentbody';
+/** `PayScheduleAssignmentBody` entity from the Gusto Embedded API. */
+export type { PayScheduleAssignmentBody } from '@gusto/embedded-api/models/components/payscheduleassignmentbody';
+/** `PayScheduleAssignmentBodyEmployees` entity from the Gusto Embedded API. */
+export type { PayScheduleAssignmentBodyEmployees } from '@gusto/embedded-api/models/components/payscheduleassignmentbody';
+/** `PayScheduleAssignmentBodyType` entity from the Gusto Embedded API. */
+export { PayScheduleAssignmentBodyType } from '@gusto/embedded-api/models/components/payscheduleassignmentbody';
+/** `PayScheduleAssignmentEmployeeChange` entity from the Gusto Embedded API. */
+export type { PayScheduleAssignmentEmployeeChange } from '@gusto/embedded-api/models/components/payscheduleassignmentemployeechange';
+export type { PayScheduleAssignmentPayPeriod } from '@gusto/embedded-api/models/components/payscheduleassignmentpayperiod';
+export type { PayScheduleAssignmentTransitionPayPeriod } from '@gusto/embedded-api/models/components/payscheduleassignmenttransitionpayperiod';
 export type { PayScheduleAutoPayrollEnablementBlocker, PayScheduleAutoPayrollEnablementBlockerMetadata, } from '@gusto/embedded-api/models/components/payscheduleautopayrollenablementblocker';
 export { WorkweekStartDay } from '@gusto/embedded-api/models/components/payschedulecreaterequest';
 export { PayScheduleFrequency } from '@gusto/embedded-api/models/components/payschedulefrequency';

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

@@ -319,6 +319,14 @@ export declare const payScheduleEvents: {
     readonly PAY_SCHEDULE_DELETE: "paySchedule/delete";
     readonly PAY_SCHEDULE_DELETED: "paySchedule/deleted";
     readonly PAY_SCHEDULE_DONE: "paySchedule/done";
+    readonly PAY_SCHEDULE_MANAGE_ASSIGNMENT: "paySchedule/management/manageAssignment";
+    readonly PAY_SCHEDULE_AUTO_PILOT_EDIT: "paySchedule/management/autoPilotEdit";
+    readonly PAY_SCHEDULE_ASSIGNMENT_TYPE_SELECTED: "paySchedule/management/assignment/typeSelected";
+    readonly PAY_SCHEDULE_ASSIGNMENT_SCHEDULE_SELECTED: "paySchedule/management/assignment/scheduleSelected";
+    readonly PAY_SCHEDULE_ASSIGNMENT_BACK: "paySchedule/management/assignment/back";
+    readonly PAY_SCHEDULE_ASSIGNMENT_CANCEL: "paySchedule/management/assignment/cancel";
+    readonly PAY_SCHEDULE_ASSIGNED: "paySchedule/management/assignment/assigned";
+    readonly PAY_SCHEDULE_MANAGEMENT_ALERT_DISMISSED: "paySchedule/management/alertDismissed";
 };
 /**
  * Event keys emitted by run-payroll components.
@@ -695,6 +703,14 @@ export declare const componentEvents: {
     readonly PAY_SCHEDULE_DELETE: "paySchedule/delete";
     readonly PAY_SCHEDULE_DELETED: "paySchedule/deleted";
     readonly PAY_SCHEDULE_DONE: "paySchedule/done";
+    readonly PAY_SCHEDULE_MANAGE_ASSIGNMENT: "paySchedule/management/manageAssignment";
+    readonly PAY_SCHEDULE_AUTO_PILOT_EDIT: "paySchedule/management/autoPilotEdit";
+    readonly PAY_SCHEDULE_ASSIGNMENT_TYPE_SELECTED: "paySchedule/management/assignment/typeSelected";
+    readonly PAY_SCHEDULE_ASSIGNMENT_SCHEDULE_SELECTED: "paySchedule/management/assignment/scheduleSelected";
+    readonly PAY_SCHEDULE_ASSIGNMENT_BACK: "paySchedule/management/assignment/back";
+    readonly PAY_SCHEDULE_ASSIGNMENT_CANCEL: "paySchedule/management/assignment/cancel";
+    readonly PAY_SCHEDULE_ASSIGNED: "paySchedule/management/assignment/assigned";
+    readonly PAY_SCHEDULE_MANAGEMENT_ALERT_DISMISSED: "paySchedule/management/alertDismissed";
     readonly COMPANY_INDUSTRY: "company/industry";
     readonly COMPANY_INDUSTRY_SELECTED: "company/industry/selected";
     readonly COMPANY_FEDERAL_TAXES_UPDATED: "company/federalTaxes/updated";