@gusto/embedded-react-sdk 0.48.2 → 0.49.0

package/dist/components/Employee/Compensation/shared/useCompensationForm/compensationSchema.d.ts

@@ -50,48 +50,6 @@ export declare const CompensationErrorCodes: {
  * @public
  */
 export type CompensationErrorCode = (typeof CompensationErrorCodes)[keyof typeof CompensationErrorCodes];
-declare const fieldValidators: {
-    /**
-     * Optional in both modes. Setting title here scopes the change to this
-     * compensation's `effectiveDate` — pair it with a future-dated comp to
-     * schedule a promotion title alongside a rate change. Use
-     * `useJobForm.Fields.Title` instead when creating a job (title is required
-     * by the API on job creation) or when renaming the active role
-     * immediately, and avoid rendering both fields on the same screen.
-     */
-    title: z.ZodString;
-    flsaStatus: z.ZodOptional<z.ZodEnum<{
-        Exempt: "Exempt";
-        "Salaried Nonexempt": "Salaried Nonexempt";
-        Nonexempt: "Nonexempt";
-        Owner: "Owner";
-        "Commission Only Exempt": "Commission Only Exempt";
-        "Commission Only Nonexempt": "Commission Only Nonexempt";
-    }>>;
-    paymentUnit: z.ZodEnum<{
-        Hour: "Hour";
-        Week: "Week";
-        Month: "Month";
-        Year: "Year";
-        Paycheck: "Paycheck";
-    }>;
-    rate: z.ZodPipe<z.ZodTransform<number, unknown>, z.ZodNumber>;
-    /**
-     * The effective date a new compensation should take effect on.
-     *
-     * - **create mode (`compensationId` absent)**: required; partners typically default
-     *   to the parent job's `hireDate` (onboarding stub-fill) or a future date
-     *   (rate change). Must be on or after `hireDate`. Server-side this maps to
-     *   POST /v1/jobs/:jobId/compensations.
-     * - **update mode (`compensationId` present)**: optional; if omitted the API
-     *   keeps the existing effective date. The `hireDate` lower bound is **not**
-     *   enforced — loaded values may legitimately predate the hire date. Maps to
-     *   PUT /v1/compensations/:id.
-     */
-    effectiveDate: z.ZodPipe<z.ZodTransform<string | null, unknown>, z.ZodNullable<z.ZodISODate>>;
-    adjustForMinimumWage: z.ZodBoolean;
-    minimumWageId: z.ZodString;
-};
 /**
  * Shape of the form values managed by {@link useCompensationForm}.
  *
@@ -105,24 +63,34 @@ declare const fieldValidators: {
  * @public
  */
 export type CompensationFormData = {
-    [K in keyof typeof fieldValidators]: z.infer<(typeof fieldValidators)[K]>;
-};
-declare const requiredFieldsConfig: {
-    title: "never";
-    flsaStatus: "create";
-    paymentUnit: "create";
-    rate: "create";
-    effectiveDate: "create";
-    minimumWageId: (data: {
-        title: string;
-        flsaStatus: "Exempt" | "Salaried Nonexempt" | "Nonexempt" | "Owner" | "Commission Only Exempt" | "Commission Only Nonexempt" | undefined;
-        paymentUnit: "Hour" | "Week" | "Month" | "Year" | "Paycheck";
-        rate: number;
-        effectiveDate: string | null;
-        adjustForMinimumWage: boolean;
-        minimumWageId: string;
-    }) => boolean;
-};
+      /**
+         * Optional in both modes. Setting title here scopes the change to this
+         * compensation's `effectiveDate` — pair it with a future-dated comp to
+         * schedule a promotion title alongside a rate change. Use
+         * `useJobForm.Fields.Title` instead when creating a job (title is required
+         * by the API on job creation) or when renaming the active role
+         * immediately, and avoid rendering both fields on the same screen.
+         */
+      title: string
+      flsaStatus: "Exempt" | "Salaried Nonexempt" | "Nonexempt" | "Owner" | "Commission Only Exempt" | "Commission Only Nonexempt" | undefined
+      paymentUnit: "Hour" | "Week" | "Month" | "Year" | "Paycheck"
+      rate: number
+      /**
+         * The effective date a new compensation should take effect on.
+         *
+         * - **create mode (`compensationId` absent)**: required; partners typically default
+         *   to the parent job's `hireDate` (onboarding stub-fill) or a future date
+         *   (rate change). Must be on or after `hireDate`. Server-side this maps to
+         *   POST /v1/jobs/:jobId/compensations.
+         * - **update mode (`compensationId` present)**: optional; if omitted the API
+         *   keeps the existing effective date. The `hireDate` lower bound is **not**
+         *   enforced — loaded values may legitimately predate the hire date. Maps to
+         *   PUT /v1/compensations/:id.
+         */
+      effectiveDate: string | null
+      adjustForMinimumWage: boolean
+      minimumWageId: string
+    };
 /**
  * Override which fields are required on a given submission mode of {@link useCompensationForm}.
  *
@@ -156,7 +124,7 @@ declare const requiredFieldsConfig: {
  * })
  * ```
  */
-export type CompensationOptionalFieldsToRequire = OptionalFieldsToRequire<typeof requiredFieldsConfig>;
+export type CompensationOptionalFieldsToRequire = { create?: "title"[] | undefined; update?: ("title" | "flsaStatus" | "paymentUnit" | "rate" | "effectiveDate")[] | undefined; };
 /**
  * Validated submission shape produced by the {@link useCompensationForm} schema.
  *

package/dist/components/Employee/Compensation/shared/useCompensationForm/fields.js.map

@@ -1 +1 @@
-{"version":3,"file":"fields.js","sources":["../../../../../../src/components/Employee/Compensation/shared/useCompensationForm/fields.tsx"],"sourcesContent":["import type { MinimumWage } from '@gusto/embedded-api-v-2025-11-15/models/components/minimumwage'\nimport type { FlsaStatusType } from '@gusto/embedded-api-v-2025-11-15/models/components/flsastatustype'\nimport type { PaymentUnit } from '@gusto/embedded-api-v-2025-11-15/models/components/compensation'\nimport type { CompensationErrorCodes } from './compensationSchema'\nimport type { TextInputHookFieldProps } from '@/partner-hook-utils/form/fields/TextInputHookField'\nimport type { SelectHookFieldProps } from '@/partner-hook-utils/form/fields/SelectHookField'\nimport type { NumberInputHookFieldProps } from '@/partner-hook-utils/form/fields/NumberInputHookField'\nimport type { CheckboxHookFieldProps } from '@/partner-hook-utils/form/fields/CheckboxHookField'\nimport type { DatePickerHookFieldProps } from '@/partner-hook-utils/form/fields/DatePickerHookField'\nimport {\n  TextInputHookField,\n  SelectHookField,\n  NumberInputHookField,\n  CheckboxHookField,\n  DatePickerHookField,\n} from '@/partner-hook-utils/form/fields'\nimport type { HookFieldProps } from '@/partner-hook-utils/types'\n\n/**\n * The required-field error code produced by {@link useCompensationForm} fields that only emit `REQUIRED`.\n *\n * @remarks\n * Used as the `validationMessages` key for the title, FLSA status, payment\n * unit, and minimum-wage selection fields. See {@link CompensationErrorCodes}.\n *\n * @public\n */\nexport type RequiredValidation = typeof CompensationErrorCodes.REQUIRED\n\n/**\n * Validation error codes emitted by the `rate` field of {@link useCompensationForm}.\n *\n * @remarks\n * Use these as keys in `validationMessages` on `Fields.Rate`. See\n * {@link CompensationErrorCodes} for the full description of each code.\n *\n * @public\n */\nexport type RateValidation = (typeof CompensationErrorCodes)[\n  | 'REQUIRED'\n  | 'RATE_MINIMUM'\n  | 'RATE_EXEMPT_THRESHOLD']\n\n/**\n * Validation error codes emitted by the `effectiveDate` field of {@link useCompensationForm}.\n *\n * @remarks\n * Use these as keys in `validationMessages` on `Fields.EffectiveDate`. See\n * {@link CompensationErrorCodes} for the full description of each code.\n *\n * @public\n */\nexport type EffectiveDateValidation = (typeof CompensationErrorCodes)[\n  | 'REQUIRED'\n  | 'EFFECTIVE_DATE_BEFORE_HIRE'\n  | 'EFFECTIVE_DATE_BEFORE_MIN']\n\n/**\n * Props accepted by {@link useCompensationForm}'s `Fields.Title` component.\n *\n * @public\n */\nexport type TitleFieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>\n\n/**\n * Text input bound to the `title` field of {@link useCompensationForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.Title`. Optional in both\n * create and update modes — use this when a title change should take effect\n * on this compensation's `effectiveDate` (for example, a future-dated\n * promotion that bundles a new title with a raise). Otherwise bind the title\n * via `useJobForm.Fields.Title` instead and avoid rendering both on the same\n * screen.\n *\n * @param props - {@link TitleFieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).\n * @returns The rendered text input bound to `title`.\n * @public\n */\nexport function TitleField(props: TitleFieldProps) {\n  return <TextInputHookField {...props} name=\"title\" />\n}\n\n/**\n * Props accepted by {@link useCompensationForm}'s `Fields.FlsaStatus` component.\n *\n * @public\n */\nexport type FlsaStatusFieldProps = HookFieldProps<\n  SelectHookFieldProps<RequiredValidation, FlsaStatusType>\n>\n\n/**\n * Select bound to the `flsaStatus` field of {@link useCompensationForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.FlsaStatus` when the FLSA\n * status is editable. The field is `undefined` when the user has no\n * meaningful choice — for example, on a secondary job whose status must\n * match the primary's. Always null-check before rendering. Options:\n * `Exempt`, `Salaried Nonexempt`, `Nonexempt`, `Owner`,\n * `Commission Only Exempt`, `Commission Only Nonexempt`.\n *\n * @param props - {@link FlsaStatusFieldProps} — accepts the standard hook field props plus `getOptionLabel` for FLSA status display.\n * @returns The rendered select bound to `flsaStatus`.\n * @public\n */\nexport function FlsaStatusField(props: FlsaStatusFieldProps) {\n  return <SelectHookField {...props} name=\"flsaStatus\" />\n}\n\n/**\n * Props accepted by {@link useCompensationForm}'s `Fields.Rate` component.\n *\n * @public\n */\nexport type RateFieldProps = HookFieldProps<NumberInputHookFieldProps<RateValidation>>\n\n/**\n * Currency-formatted number input bound to the `rate` field of {@link useCompensationForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.Rate` when the rate is\n * partner-editable. The field is `undefined` for commission-only FLSA\n * statuses (`Commission Only Exempt`, `Commission Only Nonexempt`) — those\n * statuses don't accept a partner-supplied rate, so the hook removes the\n * field and forces `rate=0` on the form values. Always null-check before\n * rendering.\n *\n * @param props - {@link RateFieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).\n * @returns The rendered currency-formatted number input bound to `rate`.\n * @public\n */\nexport function RateField(props: RateFieldProps) {\n  return <NumberInputHookField {...props} name=\"rate\" format=\"currency\" min={0} />\n}\n\n/**\n * Props accepted by {@link useCompensationForm}'s `Fields.PaymentUnit` component.\n *\n * @public\n */\nexport type PaymentUnitFieldProps = HookFieldProps<\n  SelectHookFieldProps<RequiredValidation, PaymentUnit>\n>\n\n/**\n * Select bound to the `paymentUnit` field of {@link useCompensationForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.PaymentUnit` when the\n * payment unit is partner-editable. The field is `undefined` for\n * commission-only FLSA statuses (the hook forces `paymentUnit=Year`),\n * and automatically rendered disabled when `flsaStatus === Owner`\n * (locked to `Paycheck`). Options: `Hour`, `Week`, `Month`, `Year`,\n * `Paycheck`.\n *\n * @param props - {@link PaymentUnitFieldProps} — accepts the standard hook field props plus `getOptionLabel` for payment-unit display.\n * @returns The rendered select bound to `paymentUnit`.\n * @public\n */\nexport function PaymentUnitField(props: PaymentUnitFieldProps) {\n  return <SelectHookField {...props} name=\"paymentUnit\" />\n}\n\n/**\n * Props accepted by {@link useCompensationForm}'s `Fields.AdjustForMinimumWage` component.\n *\n * @public\n */\nexport type AdjustForMinimumWageFieldProps = HookFieldProps<CheckboxHookFieldProps>\n\n/**\n * Checkbox bound to the `adjustForMinimumWage` field of {@link useCompensationForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.AdjustForMinimumWage` when\n * minimum-wage adjustment applies — `Nonexempt` FLSA status, minimum wages\n * are available at the employee's work location, and the work state\n * supports tip credits. Always null-check before rendering.\n *\n * @param props - {@link AdjustForMinimumWageFieldProps} — accepts the standard hook field props (label, description, FieldComponent override).\n * @returns The rendered checkbox bound to `adjustForMinimumWage`.\n * @public\n */\nexport function AdjustForMinimumWageField(props: AdjustForMinimumWageFieldProps) {\n  return <CheckboxHookField {...props} name=\"adjustForMinimumWage\" />\n}\n\n/**\n * Props accepted by {@link useCompensationForm}'s `Fields.MinimumWageId` component.\n *\n * @public\n */\nexport type MinimumWageIdFieldProps = HookFieldProps<\n  SelectHookFieldProps<RequiredValidation, MinimumWage>\n>\n\n/**\n * Select bound to the `minimumWageId` field of {@link useCompensationForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.MinimumWageId` when\n * `Fields.AdjustForMinimumWage` is rendered and the user has checked it.\n * Options are dynamically populated from the minimum wages available at the\n * employee's work location.\n *\n * @param props - {@link MinimumWageIdFieldProps} — accepts the standard hook field props plus `getOptionLabel` for minimum-wage display.\n * @returns The rendered select bound to `minimumWageId`.\n * @public\n */\nexport function MinimumWageIdField(props: MinimumWageIdFieldProps) {\n  return <SelectHookField {...props} name=\"minimumWageId\" />\n}\n\n/**\n * Props accepted by {@link useCompensationForm}'s `Fields.EffectiveDate` component.\n *\n * @public\n */\nexport type EffectiveDateFieldProps = HookFieldProps<\n  DatePickerHookFieldProps<EffectiveDateValidation>\n>\n\n/**\n * Date picker bound to the `effectiveDate` field of {@link useCompensationForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.EffectiveDate` when\n * `withEffectiveDateField` is `true` (the default). Required on create;\n * optional on update unless `optionalFieldsToRequire.update` includes\n * `'effectiveDate'`. The picker's min/max bounds are exposed on\n * `data.minimumEffectiveDate` / `data.maximumEffectiveDate`. The field is\n * automatically disabled (and the form value forced to today) while\n * `status.willDeleteSecondaryJobs` is `true` in update mode.\n *\n * When `withEffectiveDateField: false`, the field is `undefined` — supply\n * the value at submit time via `CompensationSubmitOptions.effectiveDate`\n * instead.\n *\n * @param props - {@link EffectiveDateFieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).\n * @returns The rendered date picker bound to `effectiveDate`.\n * @public\n */\nexport function EffectiveDateField(props: EffectiveDateFieldProps) {\n  return <DatePickerHookField {...props} name=\"effectiveDate\" />\n}\n"],"names":["TitleField","props","jsx","TextInputHookField","FlsaStatusField","SelectHookField","RateField","NumberInputHookField","PaymentUnitField","AdjustForMinimumWageField","CheckboxHookField","MinimumWageIdField","EffectiveDateField","DatePickerHookField"],"mappings":";;;;;;AA+EO,SAASA,EAAWC,GAAwB;AACjD,SAAO,gBAAAC,EAACC,GAAA,EAAoB,GAAGF,GAAO,MAAK,SAAQ;AACrD;AA0BO,SAASG,EAAgBH,GAA6B;AAC3D,SAAO,gBAAAC,EAACG,GAAA,EAAiB,GAAGJ,GAAO,MAAK,cAAa;AACvD;AAwBO,SAASK,EAAUL,GAAuB;AAC/C,SAAO,gBAAAC,EAACK,KAAsB,GAAGN,GAAO,MAAK,QAAO,QAAO,YAAW,KAAK,EAAA,CAAG;AAChF;AA0BO,SAASO,EAAiBP,GAA8B;AAC7D,SAAO,gBAAAC,EAACG,GAAA,EAAiB,GAAGJ,GAAO,MAAK,eAAc;AACxD;AAsBO,SAASQ,EAA0BR,GAAuC;AAC/E,SAAO,gBAAAC,EAACQ,GAAA,EAAmB,GAAGT,GAAO,MAAK,wBAAuB;AACnE;AAwBO,SAASU,EAAmBV,GAAgC;AACjE,SAAO,gBAAAC,EAACG,GAAA,EAAiB,GAAGJ,GAAO,MAAK,iBAAgB;AAC1D;AA+BO,SAASW,EAAmBX,GAAgC;AACjE,SAAO,gBAAAC,EAACW,GAAA,EAAqB,GAAGZ,GAAO,MAAK,iBAAgB;AAC9D;"}
+{"version":3,"file":"fields.js","sources":["../../../../../../src/components/Employee/Compensation/shared/useCompensationForm/fields.tsx"],"sourcesContent":["import type { MinimumWage } from '@gusto/embedded-api-v-2025-11-15/models/components/minimumwage'\nimport type { FlsaStatusType } from '@gusto/embedded-api-v-2025-11-15/models/components/flsastatustype'\nimport type { PaymentUnit } from '@gusto/embedded-api-v-2025-11-15/models/components/compensation'\nimport type { CompensationErrorCodes } from './compensationSchema'\nimport type { TextInputHookFieldProps } from '@/partner-hook-utils/form/fields/TextInputHookField'\nimport type { SelectHookFieldProps } from '@/partner-hook-utils/form/fields/SelectHookField'\nimport type { NumberInputHookFieldProps } from '@/partner-hook-utils/form/fields/NumberInputHookField'\nimport type { CheckboxHookFieldProps } from '@/partner-hook-utils/form/fields/CheckboxHookField'\nimport type { DatePickerHookFieldProps } from '@/partner-hook-utils/form/fields/DatePickerHookField'\nimport {\n  TextInputHookField,\n  SelectHookField,\n  NumberInputHookField,\n  CheckboxHookField,\n  DatePickerHookField,\n} from '@/partner-hook-utils/form/fields'\nimport type { HookFieldProps } from '@/partner-hook-utils/types'\n\n/**\n * The required-field error code produced by {@link useCompensationForm} fields that only emit `REQUIRED`.\n *\n * @remarks\n * Used as the `validationMessages` key for the title, FLSA status, payment\n * unit, and minimum-wage selection fields. See {@link CompensationErrorCodes}.\n *\n * @public\n */\nexport type RequiredValidation = typeof CompensationErrorCodes.REQUIRED\n\n/**\n * Validation error codes emitted by the `rate` field of {@link useCompensationForm}.\n *\n * @remarks\n * Use these as keys in `validationMessages` on `Fields.Rate`. See\n * {@link CompensationErrorCodes} for the full description of each code.\n *\n * @public\n */\nexport type RateValidation = (typeof CompensationErrorCodes)[\n  'REQUIRED' | 'RATE_MINIMUM' | 'RATE_EXEMPT_THRESHOLD']\n\n/**\n * Validation error codes emitted by the `effectiveDate` field of {@link useCompensationForm}.\n *\n * @remarks\n * Use these as keys in `validationMessages` on `Fields.EffectiveDate`. See\n * {@link CompensationErrorCodes} for the full description of each code.\n *\n * @public\n */\nexport type EffectiveDateValidation = (typeof CompensationErrorCodes)[\n  'REQUIRED' | 'EFFECTIVE_DATE_BEFORE_HIRE' | 'EFFECTIVE_DATE_BEFORE_MIN']\n\n/**\n * Props accepted by {@link useCompensationForm}'s `Fields.Title` component.\n *\n * @public\n */\nexport type TitleFieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>\n\n/**\n * Text input bound to the `title` field of {@link useCompensationForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.Title`. Optional in both\n * create and update modes — use this when a title change should take effect\n * on this compensation's `effectiveDate` (for example, a future-dated\n * promotion that bundles a new title with a raise). Otherwise bind the title\n * via `useJobForm.Fields.Title` instead and avoid rendering both on the same\n * screen.\n *\n * @param props - {@link TitleFieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).\n * @returns The rendered text input bound to `title`.\n * @public\n */\nexport function TitleField(props: TitleFieldProps) {\n  return <TextInputHookField {...props} name=\"title\" />\n}\n\n/**\n * Props accepted by {@link useCompensationForm}'s `Fields.FlsaStatus` component.\n *\n * @public\n */\nexport type FlsaStatusFieldProps = HookFieldProps<\n  SelectHookFieldProps<RequiredValidation, FlsaStatusType>\n>\n\n/**\n * Select bound to the `flsaStatus` field of {@link useCompensationForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.FlsaStatus` when the FLSA\n * status is editable. The field is `undefined` when the user has no\n * meaningful choice — for example, on a secondary job whose status must\n * match the primary's. Always null-check before rendering. Options:\n * `Exempt`, `Salaried Nonexempt`, `Nonexempt`, `Owner`,\n * `Commission Only Exempt`, `Commission Only Nonexempt`.\n *\n * @param props - {@link FlsaStatusFieldProps} — accepts the standard hook field props plus `getOptionLabel` for FLSA status display.\n * @returns The rendered select bound to `flsaStatus`.\n * @public\n */\nexport function FlsaStatusField(props: FlsaStatusFieldProps) {\n  return <SelectHookField {...props} name=\"flsaStatus\" />\n}\n\n/**\n * Props accepted by {@link useCompensationForm}'s `Fields.Rate` component.\n *\n * @public\n */\nexport type RateFieldProps = HookFieldProps<NumberInputHookFieldProps<RateValidation>>\n\n/**\n * Currency-formatted number input bound to the `rate` field of {@link useCompensationForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.Rate` when the rate is\n * partner-editable. The field is `undefined` for commission-only FLSA\n * statuses (`Commission Only Exempt`, `Commission Only Nonexempt`) — those\n * statuses don't accept a partner-supplied rate, so the hook removes the\n * field and forces `rate=0` on the form values. Always null-check before\n * rendering.\n *\n * @param props - {@link RateFieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).\n * @returns The rendered currency-formatted number input bound to `rate`.\n * @public\n */\nexport function RateField(props: RateFieldProps) {\n  return <NumberInputHookField {...props} name=\"rate\" format=\"currency\" min={0} />\n}\n\n/**\n * Props accepted by {@link useCompensationForm}'s `Fields.PaymentUnit` component.\n *\n * @public\n */\nexport type PaymentUnitFieldProps = HookFieldProps<\n  SelectHookFieldProps<RequiredValidation, PaymentUnit>\n>\n\n/**\n * Select bound to the `paymentUnit` field of {@link useCompensationForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.PaymentUnit` when the\n * payment unit is partner-editable. The field is `undefined` for\n * commission-only FLSA statuses (the hook forces `paymentUnit=Year`),\n * and automatically rendered disabled when `flsaStatus === Owner`\n * (locked to `Paycheck`). Options: `Hour`, `Week`, `Month`, `Year`,\n * `Paycheck`.\n *\n * @param props - {@link PaymentUnitFieldProps} — accepts the standard hook field props plus `getOptionLabel` for payment-unit display.\n * @returns The rendered select bound to `paymentUnit`.\n * @public\n */\nexport function PaymentUnitField(props: PaymentUnitFieldProps) {\n  return <SelectHookField {...props} name=\"paymentUnit\" />\n}\n\n/**\n * Props accepted by {@link useCompensationForm}'s `Fields.AdjustForMinimumWage` component.\n *\n * @public\n */\nexport type AdjustForMinimumWageFieldProps = HookFieldProps<CheckboxHookFieldProps>\n\n/**\n * Checkbox bound to the `adjustForMinimumWage` field of {@link useCompensationForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.AdjustForMinimumWage` when\n * minimum-wage adjustment applies — `Nonexempt` FLSA status, minimum wages\n * are available at the employee's work location, and the work state\n * supports tip credits. Always null-check before rendering.\n *\n * @param props - {@link AdjustForMinimumWageFieldProps} — accepts the standard hook field props (label, description, FieldComponent override).\n * @returns The rendered checkbox bound to `adjustForMinimumWage`.\n * @public\n */\nexport function AdjustForMinimumWageField(props: AdjustForMinimumWageFieldProps) {\n  return <CheckboxHookField {...props} name=\"adjustForMinimumWage\" />\n}\n\n/**\n * Props accepted by {@link useCompensationForm}'s `Fields.MinimumWageId` component.\n *\n * @public\n */\nexport type MinimumWageIdFieldProps = HookFieldProps<\n  SelectHookFieldProps<RequiredValidation, MinimumWage>\n>\n\n/**\n * Select bound to the `minimumWageId` field of {@link useCompensationForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.MinimumWageId` when\n * `Fields.AdjustForMinimumWage` is rendered and the user has checked it.\n * Options are dynamically populated from the minimum wages available at the\n * employee's work location.\n *\n * @param props - {@link MinimumWageIdFieldProps} — accepts the standard hook field props plus `getOptionLabel` for minimum-wage display.\n * @returns The rendered select bound to `minimumWageId`.\n * @public\n */\nexport function MinimumWageIdField(props: MinimumWageIdFieldProps) {\n  return <SelectHookField {...props} name=\"minimumWageId\" />\n}\n\n/**\n * Props accepted by {@link useCompensationForm}'s `Fields.EffectiveDate` component.\n *\n * @public\n */\nexport type EffectiveDateFieldProps = HookFieldProps<\n  DatePickerHookFieldProps<EffectiveDateValidation>\n>\n\n/**\n * Date picker bound to the `effectiveDate` field of {@link useCompensationForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.EffectiveDate` when\n * `withEffectiveDateField` is `true` (the default). Required on create;\n * optional on update unless `optionalFieldsToRequire.update` includes\n * `'effectiveDate'`. The picker's min/max bounds are exposed on\n * `data.minimumEffectiveDate` / `data.maximumEffectiveDate`. The field is\n * automatically disabled (and the form value forced to today) while\n * `status.willDeleteSecondaryJobs` is `true` in update mode.\n *\n * When `withEffectiveDateField: false`, the field is `undefined` — supply\n * the value at submit time via `CompensationSubmitOptions.effectiveDate`\n * instead.\n *\n * @param props - {@link EffectiveDateFieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).\n * @returns The rendered date picker bound to `effectiveDate`.\n * @public\n */\nexport function EffectiveDateField(props: EffectiveDateFieldProps) {\n  return <DatePickerHookField {...props} name=\"effectiveDate\" />\n}\n"],"names":["TitleField","props","jsx","TextInputHookField","FlsaStatusField","SelectHookField","RateField","NumberInputHookField","PaymentUnitField","AdjustForMinimumWageField","CheckboxHookField","MinimumWageIdField","EffectiveDateField","DatePickerHookField"],"mappings":";;;;;;AA2EO,SAASA,EAAWC,GAAwB;AACjD,SAAO,gBAAAC,EAACC,GAAA,EAAoB,GAAGF,GAAO,MAAK,SAAQ;AACrD;AA0BO,SAASG,EAAgBH,GAA6B;AAC3D,SAAO,gBAAAC,EAACG,GAAA,EAAiB,GAAGJ,GAAO,MAAK,cAAa;AACvD;AAwBO,SAASK,EAAUL,GAAuB;AAC/C,SAAO,gBAAAC,EAACK,KAAsB,GAAGN,GAAO,MAAK,QAAO,QAAO,YAAW,KAAK,EAAA,CAAG;AAChF;AA0BO,SAASO,EAAiBP,GAA8B;AAC7D,SAAO,gBAAAC,EAACG,GAAA,EAAiB,GAAGJ,GAAO,MAAK,eAAc;AACxD;AAsBO,SAASQ,EAA0BR,GAAuC;AAC/E,SAAO,gBAAAC,EAACQ,GAAA,EAAmB,GAAGT,GAAO,MAAK,wBAAuB;AACnE;AAwBO,SAASU,EAAmBV,GAAgC;AACjE,SAAO,gBAAAC,EAACG,GAAA,EAAiB,GAAGJ,GAAO,MAAK,iBAAgB;AAC1D;AA+BO,SAASW,EAAmBX,GAAgC;AACjE,SAAO,gBAAAC,EAACW,GAAA,EAAqB,GAAGZ,GAAO,MAAK,iBAAgB;AAC9D;"}

package/dist/components/Employee/Compensation/shared/useJobForm/jobSchema.d.ts

@@ -28,13 +28,6 @@ export declare const JobErrorCodes: {
  * @public
  */
 export type JobErrorCode = (typeof JobErrorCodes)[keyof typeof JobErrorCodes];
-declare const fieldValidators: {
-    title: z.ZodString;
-    hireDate: z.ZodPipe<z.ZodTransform<string | null, unknown>, z.ZodNullable<z.ZodISODate>>;
-    twoPercentShareholder: z.ZodBoolean;
-    stateWcCovered: z.ZodPipe<z.ZodTransform<boolean | undefined, unknown>, z.ZodBoolean>;
-    stateWcClassCode: z.ZodString;
-};
 /**
  * Shape of the form values managed by {@link useJobForm}.
  *
@@ -46,10 +39,20 @@ declare const fieldValidators: {
  * input (the schema preprocessor coerces them).
  *
  * @public
+ * @interface
  */
 export type JobFormData = {
-    [K in keyof typeof fieldValidators]: z.infer<(typeof fieldValidators)[K]>;
-};
+      /** The employee's job title (e.g. `"Software Engineer"`). */
+      title: string
+      /** The employee's hire date as an ISO 8601 string (`YYYY-MM-DD`), or `null` if unknown. */
+      hireDate: string | null
+      /** Whether the employee owns 2 % or more of an S-corporation. Affects benefit-deduction tax treatment. */
+      twoPercentShareholder: boolean
+      /** Whether the employee is covered under Washington state workers' compensation insurance. */
+      stateWcCovered: boolean
+      /** Washington state workers' compensation risk-class code. Required when `stateWcCovered` is `true`. */
+      stateWcClassCode: string
+    };
 /**
  * Validated submission shape produced by the {@link useJobForm} schema.
  *
@@ -60,19 +63,6 @@ export type JobFormData = {
  * @public
  */
 export type JobFormOutputs = JobFormData;
-declare const requiredFieldsConfig: {
-    title: "create";
-    hireDate: "create";
-    twoPercentShareholder: "never";
-    stateWcCovered: "never";
-    stateWcClassCode: (data: {
-        title: string;
-        hireDate: string | null;
-        twoPercentShareholder: boolean;
-        stateWcCovered: boolean;
-        stateWcClassCode: string;
-    }) => boolean;
-};
 /**
  * Override which fields are required on a given submission mode of {@link useJobForm}.
  *
@@ -90,6 +80,7 @@ declare const requiredFieldsConfig: {
  * | `stateWcClassCode` | When WC is covered | When WC is covered | No (auto) |
  *
  * @public
+ * @interface
  *
  * @example
  * ```tsx
@@ -102,7 +93,7 @@ declare const requiredFieldsConfig: {
  * })
  * ```
  */
-export type JobOptionalFieldsToRequire = OptionalFieldsToRequire<typeof requiredFieldsConfig>;
+export type JobOptionalFieldsToRequire = { create?: ("twoPercentShareholder" | "stateWcCovered")[] | undefined; update?: ("title" | "hireDate" | "twoPercentShareholder" | "stateWcCovered")[] | undefined; };
 interface JobSchemaOptions {
     mode?: 'create' | 'update';
     optionalFieldsToRequire?: JobOptionalFieldsToRequire;
@@ -125,10 +116,15 @@ interface JobSchemaOptions {
 }
 /** @internal */
 export declare function createJobSchema(options?: JobSchemaOptions): import('../../../../../partner-hook-utils/form/buildFormSchema').BuildFormSchemaResult<{
+    /** The employee's job title (e.g. `"Software Engineer"`). */
     title: z.ZodString;
+    /** The employee's hire date as an ISO 8601 string (`YYYY-MM-DD`), or `null` if unknown. */
     hireDate: z.ZodPipe<z.ZodTransform<string | null, unknown>, z.ZodNullable<z.ZodISODate>>;
+    /** Whether the employee owns 2 % or more of an S-corporation. Affects benefit-deduction tax treatment. */
     twoPercentShareholder: z.ZodBoolean;
+    /** Whether the employee is covered under Washington state workers' compensation insurance. */
     stateWcCovered: z.ZodPipe<z.ZodTransform<boolean | undefined, unknown>, z.ZodBoolean>;
+    /** Washington state workers' compensation risk-class code. Required when `stateWcCovered` is `true`. */
     stateWcClassCode: z.ZodString;
 }>;
 export {};

package/dist/components/Employee/Compensation/shared/useJobForm/jobSchema.js

@@ -4,11 +4,16 @@ import { coerceStringBoolean as l, coerceToISODate as d } from "../../../../../p
 const n = {
   REQUIRED: "REQUIRED"
 }, h = {
+  /** The employee's job title (e.g. `"Software Engineer"`). */
   title: e.string(),
+  /** The employee's hire date as an ISO 8601 string (`YYYY-MM-DD`), or `null` if unknown. */
   hireDate: e.preprocess(d, e.iso.date().nullable()),
+  /** Whether the employee owns 2 % or more of an S-corporation. Affects benefit-deduction tax treatment. */
   twoPercentShareholder: e.boolean(),
   // Radio group delivers 'true'/'false' strings; coerceStringBoolean converts to boolean.
+  /** Whether the employee is covered under Washington state workers' compensation insurance. */
   stateWcCovered: e.preprocess(l, e.boolean()),
+  /** Washington state workers' compensation risk-class code. Required when `stateWcCovered` is `true`. */
   stateWcClassCode: e.string()
 }, u = {
   title: "create",

package/dist/components/Employee/Compensation/shared/useJobForm/jobSchema.js.map

@@ -1 +1 @@
-{"version":3,"file":"jobSchema.js","sources":["../../../../../../src/components/Employee/Compensation/shared/useJobForm/jobSchema.ts"],"sourcesContent":["import { z } from 'zod'\nimport {\n  buildFormSchema,\n  type RequiredFieldConfig,\n  type OptionalFieldsToRequire,\n} from '@/partner-hook-utils/form/buildFormSchema'\nimport { coerceToISODate, coerceStringBoolean } from '@/partner-hook-utils/form/preprocessors'\n\n/**\n * Validation error codes produced by the {@link useJobForm} schema.\n *\n * @remarks\n * Use these constants as the keys in a field's `validationMessages` prop to\n * map an error code to a user-facing message.\n *\n * @public\n *\n * @example\n * ```tsx\n * import { JobErrorCodes } from '@gusto/embedded-react-sdk'\n *\n * <Fields.Title\n *   label=\"Job title\"\n *   validationMessages={{ [JobErrorCodes.REQUIRED]: 'Job title is required' }}\n * />\n * ```\n */\nexport const JobErrorCodes = {\n  REQUIRED: 'REQUIRED',\n} as const\n\n/**\n * Union of every error code produced by the {@link useJobForm} schema.\n *\n * @public\n */\nexport type JobErrorCode = (typeof JobErrorCodes)[keyof typeof JobErrorCodes]\n\nconst fieldValidators = {\n  title: z.string(),\n  hireDate: z.preprocess(coerceToISODate, z.iso.date().nullable()),\n  twoPercentShareholder: z.boolean(),\n  // Radio group delivers 'true'/'false' strings; coerceStringBoolean converts to boolean.\n  stateWcCovered: z.preprocess(coerceStringBoolean, z.boolean()),\n  stateWcClassCode: z.string(),\n}\n\n/**\n * Shape of the form values managed by {@link useJobForm}.\n *\n * @remarks\n * Accepted as `defaultValues` on `useJobForm` and returned by\n * `form.getFormSubmissionValues()` once the form has validated. `hireDate` is\n * an ISO date string (`YYYY-MM-DD`) or `null`; `stateWcCovered` is a boolean\n * even though the radio group surfaces `'true'` / `'false'` strings during\n * input (the schema preprocessor coerces them).\n *\n * @public\n */\nexport type JobFormData = {\n  [K in keyof typeof fieldValidators]: z.infer<(typeof fieldValidators)[K]>\n}\n\n/**\n * Validated submission shape produced by the {@link useJobForm} schema.\n *\n * @remarks\n * Identical to {@link JobFormData} — exposed as a separate alias so the input\n * vs. output sides of the schema remain distinguishable in advanced usages.\n *\n * @public\n */\nexport type JobFormOutputs = JobFormData\n\nconst requiredFieldsConfig = {\n  title: 'create',\n  hireDate: 'create',\n  twoPercentShareholder: 'never',\n  stateWcCovered: 'never',\n  // stateWcClassCode is gated by stateWcCovered === true. The predicate also\n  // depends implicitly on the work-address state being WA — partners enforce\n  // that gate by passing `optionalFieldsToRequire` only for WA employees, or\n  // by simply never sending stateWcCovered=true outside WA.\n  stateWcClassCode: data => String(data.stateWcCovered) === 'true',\n} satisfies RequiredFieldConfig<typeof fieldValidators>\n\n/**\n * Override which fields are required on a given submission mode of {@link useJobForm}.\n *\n * @remarks\n * Each mode key lists the fields that are optional by default for that mode\n * but should be promoted to required. `stateWcClassCode` is automatically\n * required when `stateWcCovered` is `true` and is not configurable here.\n *\n * | Field | Required on create | Required on update | Configurable? |\n * | ----- | ------------------ | ------------------ | ------------- |\n * | `title` | Yes | No | Yes (on update) |\n * | `hireDate` | Yes | No | Yes (on update) |\n * | `twoPercentShareholder` | No | No | Yes (either mode) |\n * | `stateWcCovered` | No | No | Yes (either mode) |\n * | `stateWcClassCode` | When WC is covered | When WC is covered | No (auto) |\n *\n * @public\n *\n * @example\n * ```tsx\n * const job = useJobForm({\n *   employeeId,\n *   jobId,\n *   optionalFieldsToRequire: {\n *     update: ['title', 'hireDate'],\n *   },\n * })\n * ```\n */\nexport type JobOptionalFieldsToRequire = OptionalFieldsToRequire<typeof requiredFieldsConfig>\n\ninterface JobSchemaOptions {\n  mode?: 'create' | 'update'\n  optionalFieldsToRequire?: JobOptionalFieldsToRequire\n  /**\n   * When `false`, drops `hireDate` from the validated shape entirely — the\n   * field becomes hook-managed rather than user-facing (e.g. an onboarding\n   * screen that derives hireDate from the employee's `startDate`). Partners\n   * supply the value at submit time via `JobSubmitOptions.hireDate`.\n   * Defaults to `true`.\n   */\n  withHireDateField?: boolean\n  /**\n   * When `false`, drops `title` from the validated shape entirely and the\n   * hook stops sending it on PUT `/v1/jobs/:id`. Use this when title is\n   * being driven via the compensation form instead (steady-state edits,\n   * where title is effective-dated alongside rate/unit/FLSA on a future\n   * compensation row). Defaults to `true`.\n   */\n  withTitleField?: boolean\n}\n\n/** @internal */\nexport function createJobSchema(options: JobSchemaOptions = {}) {\n  const {\n    mode = 'create',\n    optionalFieldsToRequire,\n    withHireDateField = true,\n    withTitleField = true,\n  } = options\n\n  const excludeFields: Array<keyof typeof fieldValidators> = []\n  if (!withHireDateField) excludeFields.push('hireDate')\n  if (!withTitleField) excludeFields.push('title')\n\n  return buildFormSchema(fieldValidators, {\n    requiredFieldsConfig,\n    requiredErrorCode: JobErrorCodes.REQUIRED,\n    mode,\n    optionalFieldsToRequire,\n    excludeFields,\n  })\n}\n"],"names":["JobErrorCodes","fieldValidators","z","coerceToISODate","coerceStringBoolean","requiredFieldsConfig","data","createJobSchema","options","mode","optionalFieldsToRequire","withHireDateField","withTitleField","excludeFields","buildFormSchema"],"mappings":";;;AA2BO,MAAMA,IAAgB;AAAA,EAC3B,UAAU;AACZ,GASMC,IAAkB;AAAA,EACtB,OAAOC,EAAE,OAAA;AAAA,EACT,UAAUA,EAAE,WAAWC,GAAiBD,EAAE,IAAI,OAAO,UAAU;AAAA,EAC/D,uBAAuBA,EAAE,QAAA;AAAA;AAAA,EAEzB,gBAAgBA,EAAE,WAAWE,GAAqBF,EAAE,SAAS;AAAA,EAC7D,kBAAkBA,EAAE,OAAA;AACtB,GA6BMG,IAAuB;AAAA,EAC3B,OAAO;AAAA,EACP,UAAU;AAAA,EACV,uBAAuB;AAAA,EACvB,gBAAgB;AAAA;AAAA;AAAA;AAAA;AAAA,EAKhB,kBAAkB,CAAAC,MAAQ,OAAOA,EAAK,cAAc,MAAM;AAC5D;AAuDO,SAASC,EAAgBC,IAA4B,IAAI;AAC9D,QAAM;AAAA,IACJ,MAAAC,IAAO;AAAA,IACP,yBAAAC;AAAA,IACA,mBAAAC,IAAoB;AAAA,IACpB,gBAAAC,IAAiB;AAAA,EAAA,IACfJ,GAEEK,IAAqD,CAAA;AAC3D,SAAKF,KAAmBE,EAAc,KAAK,UAAU,GAChDD,KAAgBC,EAAc,KAAK,OAAO,GAExCC,EAAgBb,GAAiB;AAAA,IACtC,sBAAAI;AAAA,IACA,mBAAmBL,EAAc;AAAA,IACjC,MAAAS;AAAA,IACA,yBAAAC;AAAA,IACA,eAAAG;AAAA,EAAA,CACD;AACH;"}
+{"version":3,"file":"jobSchema.js","sources":["../../../../../../src/components/Employee/Compensation/shared/useJobForm/jobSchema.ts"],"sourcesContent":["import { z } from 'zod'\nimport {\n  buildFormSchema,\n  type RequiredFieldConfig,\n  type OptionalFieldsToRequire,\n} from '@/partner-hook-utils/form/buildFormSchema'\nimport { coerceToISODate, coerceStringBoolean } from '@/partner-hook-utils/form/preprocessors'\n\n/**\n * Validation error codes produced by the {@link useJobForm} schema.\n *\n * @remarks\n * Use these constants as the keys in a field's `validationMessages` prop to\n * map an error code to a user-facing message.\n *\n * @public\n *\n * @example\n * ```tsx\n * import { JobErrorCodes } from '@gusto/embedded-react-sdk'\n *\n * <Fields.Title\n *   label=\"Job title\"\n *   validationMessages={{ [JobErrorCodes.REQUIRED]: 'Job title is required' }}\n * />\n * ```\n */\nexport const JobErrorCodes = {\n  REQUIRED: 'REQUIRED',\n} as const\n\n/**\n * Union of every error code produced by the {@link useJobForm} schema.\n *\n * @public\n */\nexport type JobErrorCode = (typeof JobErrorCodes)[keyof typeof JobErrorCodes]\n\nconst fieldValidators = {\n  /** The employee's job title (e.g. `\"Software Engineer\"`). */\n  title: z.string(),\n  /** The employee's hire date as an ISO 8601 string (`YYYY-MM-DD`), or `null` if unknown. */\n  hireDate: z.preprocess(coerceToISODate, z.iso.date().nullable()),\n  /** Whether the employee owns 2 % or more of an S-corporation. Affects benefit-deduction tax treatment. */\n  twoPercentShareholder: z.boolean(),\n  // Radio group delivers 'true'/'false' strings; coerceStringBoolean converts to boolean.\n  /** Whether the employee is covered under Washington state workers' compensation insurance. */\n  stateWcCovered: z.preprocess(coerceStringBoolean, z.boolean()),\n  /** Washington state workers' compensation risk-class code. Required when `stateWcCovered` is `true`. */\n  stateWcClassCode: z.string(),\n}\n\n/**\n * Shape of the form values managed by {@link useJobForm}.\n *\n * @remarks\n * Accepted as `defaultValues` on `useJobForm` and returned by\n * `form.getFormSubmissionValues()` once the form has validated. `hireDate` is\n * an ISO date string (`YYYY-MM-DD`) or `null`; `stateWcCovered` is a boolean\n * even though the radio group surfaces `'true'` / `'false'` strings during\n * input (the schema preprocessor coerces them).\n *\n * @public\n * @interface\n */\nexport type JobFormData = {\n  [K in keyof typeof fieldValidators]: z.infer<(typeof fieldValidators)[K]>\n}\n\n/**\n * Validated submission shape produced by the {@link useJobForm} schema.\n *\n * @remarks\n * Identical to {@link JobFormData} — exposed as a separate alias so the input\n * vs. output sides of the schema remain distinguishable in advanced usages.\n *\n * @public\n */\nexport type JobFormOutputs = JobFormData\n\nconst requiredFieldsConfig = {\n  title: 'create',\n  hireDate: 'create',\n  twoPercentShareholder: 'never',\n  stateWcCovered: 'never',\n  // stateWcClassCode is gated by stateWcCovered === true. The predicate also\n  // depends implicitly on the work-address state being WA — partners enforce\n  // that gate by passing `optionalFieldsToRequire` only for WA employees, or\n  // by simply never sending stateWcCovered=true outside WA.\n  stateWcClassCode: data => String(data.stateWcCovered) === 'true',\n} satisfies RequiredFieldConfig<typeof fieldValidators>\n\n/**\n * Override which fields are required on a given submission mode of {@link useJobForm}.\n *\n * @remarks\n * Each mode key lists the fields that are optional by default for that mode\n * but should be promoted to required. `stateWcClassCode` is automatically\n * required when `stateWcCovered` is `true` and is not configurable here.\n *\n * | Field | Required on create | Required on update | Configurable? |\n * | ----- | ------------------ | ------------------ | ------------- |\n * | `title` | Yes | No | Yes (on update) |\n * | `hireDate` | Yes | No | Yes (on update) |\n * | `twoPercentShareholder` | No | No | Yes (either mode) |\n * | `stateWcCovered` | No | No | Yes (either mode) |\n * | `stateWcClassCode` | When WC is covered | When WC is covered | No (auto) |\n *\n * @public\n * @interface\n *\n * @example\n * ```tsx\n * const job = useJobForm({\n *   employeeId,\n *   jobId,\n *   optionalFieldsToRequire: {\n *     update: ['title', 'hireDate'],\n *   },\n * })\n * ```\n */\nexport type JobOptionalFieldsToRequire = OptionalFieldsToRequire<typeof requiredFieldsConfig>\n\ninterface JobSchemaOptions {\n  mode?: 'create' | 'update'\n  optionalFieldsToRequire?: JobOptionalFieldsToRequire\n  /**\n   * When `false`, drops `hireDate` from the validated shape entirely — the\n   * field becomes hook-managed rather than user-facing (e.g. an onboarding\n   * screen that derives hireDate from the employee's `startDate`). Partners\n   * supply the value at submit time via `JobSubmitOptions.hireDate`.\n   * Defaults to `true`.\n   */\n  withHireDateField?: boolean\n  /**\n   * When `false`, drops `title` from the validated shape entirely and the\n   * hook stops sending it on PUT `/v1/jobs/:id`. Use this when title is\n   * being driven via the compensation form instead (steady-state edits,\n   * where title is effective-dated alongside rate/unit/FLSA on a future\n   * compensation row). Defaults to `true`.\n   */\n  withTitleField?: boolean\n}\n\n/** @internal */\nexport function createJobSchema(options: JobSchemaOptions = {}) {\n  const {\n    mode = 'create',\n    optionalFieldsToRequire,\n    withHireDateField = true,\n    withTitleField = true,\n  } = options\n\n  const excludeFields: Array<keyof typeof fieldValidators> = []\n  if (!withHireDateField) excludeFields.push('hireDate')\n  if (!withTitleField) excludeFields.push('title')\n\n  return buildFormSchema(fieldValidators, {\n    requiredFieldsConfig,\n    requiredErrorCode: JobErrorCodes.REQUIRED,\n    mode,\n    optionalFieldsToRequire,\n    excludeFields,\n  })\n}\n"],"names":["JobErrorCodes","fieldValidators","z","coerceToISODate","coerceStringBoolean","requiredFieldsConfig","data","createJobSchema","options","mode","optionalFieldsToRequire","withHireDateField","withTitleField","excludeFields","buildFormSchema"],"mappings":";;;AA2BO,MAAMA,IAAgB;AAAA,EAC3B,UAAU;AACZ,GASMC,IAAkB;AAAA;AAAA,EAEtB,OAAOC,EAAE,OAAA;AAAA;AAAA,EAET,UAAUA,EAAE,WAAWC,GAAiBD,EAAE,IAAI,OAAO,UAAU;AAAA;AAAA,EAE/D,uBAAuBA,EAAE,QAAA;AAAA;AAAA;AAAA,EAGzB,gBAAgBA,EAAE,WAAWE,GAAqBF,EAAE,SAAS;AAAA;AAAA,EAE7D,kBAAkBA,EAAE,OAAA;AACtB,GA8BMG,IAAuB;AAAA,EAC3B,OAAO;AAAA,EACP,UAAU;AAAA,EACV,uBAAuB;AAAA,EACvB,gBAAgB;AAAA;AAAA;AAAA;AAAA;AAAA,EAKhB,kBAAkB,CAAAC,MAAQ,OAAOA,EAAK,cAAc,MAAM;AAC5D;AAwDO,SAASC,EAAgBC,IAA4B,IAAI;AAC9D,QAAM;AAAA,IACJ,MAAAC,IAAO;AAAA,IACP,yBAAAC;AAAA,IACA,mBAAAC,IAAoB;AAAA,IACpB,gBAAAC,IAAiB;AAAA,EAAA,IACfJ,GAEEK,IAAqD,CAAA;AAC3D,SAAKF,KAAmBE,EAAc,KAAK,UAAU,GAChDD,KAAgBC,EAAc,KAAK,OAAO,GAExCC,EAAgBb,GAAiB;AAAA,IACtC,sBAAAI;AAAA,IACA,mBAAmBL,EAAc;AAAA,IACjC,MAAAS;AAAA,IACA,yBAAAC;AAAA,IACA,eAAAG;AAAA,EAAA,CACD;AACH;"}

package/dist/components/Employee/Dashboard/Dashboard.d.ts

@@ -1,10 +1,35 @@
 import { BaseComponentInterface } from '../../Base/Base';
-/** @internal */
+/** @public */
 export type DashboardTab = 'basicDetails' | 'jobAndPay' | 'taxes' | 'documents';
-/** @internal */
+/** @public */
 export interface DashboardProps extends BaseComponentInterface<'Employee.Dashboard'> {
+    /** The associated employee identifier. */
     employeeId: string;
+    /** The currently active tab. Defaults to `'basicDetails'` when uncontrolled. */
     selectedTab?: DashboardTab;
 }
-/** @internal */
-export declare function Dashboard({ FallbackComponent, ...props }: DashboardProps & BaseComponentInterface): import("react").JSX.Element;
+/**
+ * Employee self-service dashboard summarizing a single employee's basic details, job and pay, taxes, and documents.
+ *
+ * @remarks
+ * Renders a tabbed overview of the employee, wrapped in the SDK's standard error and suspense
+ * boundaries. The active tab may be controlled via `selectedTab` or left uncontrolled, in which
+ * case it defaults to basic details. Each tab composes the read-only section cards listed below.
+ *
+ * @components
+ * - {@link ProfileCard}
+ * - {@link HomeAddressCard}
+ * - {@link WorkAddressCard}
+ * - {@link CompensationCard}
+ * - {@link PaymentMethodCard}
+ * - {@link DeductionsCard}
+ * - {@link PaystubsCard}
+ * - {@link FederalTaxesCard}
+ * - {@link StateTaxesCard}
+ * - {@link DocumentsCard}
+ *
+ * @param props - Component props. See {@link DashboardProps}.
+ * @returns A React element rendering the employee dashboard.
+ * @public
+ */
+export declare function Dashboard({ FallbackComponent, ...props }: DashboardProps): import("react").JSX.Element;

package/dist/components/Employee/Dashboard/Dashboard.js

@@ -74,10 +74,7 @@ function _({ employeeId: t }) {
     /* @__PURE__ */ e(o.Text, { variant: "supporting", children: a("employeeRoleLabel") })
   ] });
 }
-function z({
-  FallbackComponent: t,
-  ...a
-}) {
+function z({ FallbackComponent: t, ...a }) {
   return /* @__PURE__ */ e(g, { componentName: "Employee.Dashboard", FallbackComponent: t, children: /* @__PURE__ */ e(S, { ...a }) });
 }
 export {

package/dist/components/Employee/Dashboard/Dashboard.js.map

@@ -1 +1 @@
-{"version":3,"file":"Dashboard.js","sources":["../../../../src/components/Employee/Dashboard/Dashboard.tsx"],"sourcesContent":["import { Suspense, useState } from 'react'\nimport { useTranslation } from 'react-i18next'\nimport { useEmployeesGetSuspense } from '@gusto/embedded-api-v-2025-11-15/react-query/employeesGet'\nimport { BasicDetailsView } from './BasicDetailsView'\nimport { JobAndPayView } from './JobAndPayView'\nimport { TaxesViewWithData } from './TaxesView'\nimport { DocumentsCard } from '@/components/Employee/Documents/management/DocumentsCard'\nimport { Flex } from '@/components/Common/Flex/Flex'\nimport { useComponentContext } from '@/contexts/ComponentAdapter/useComponentContext'\nimport { BaseBoundaries, type BaseComponentInterface } from '@/components/Base/Base'\nimport { useComponentDictionary, useI18n } from '@/i18n'\nimport { componentEvents } from '@/shared/constants'\nimport { firstLastName } from '@/helpers/formattedStrings'\n\n/** @internal */\nexport type DashboardTab = 'basicDetails' | 'jobAndPay' | 'taxes' | 'documents'\n\n/** @internal */\nexport interface DashboardProps extends BaseComponentInterface<'Employee.Dashboard'> {\n  employeeId: string\n  selectedTab?: DashboardTab\n}\n\nfunction DashboardRoot({\n  employeeId,\n  dictionary,\n  onEvent,\n  selectedTab: controlledTab,\n}: DashboardProps) {\n  useI18n('Employee.Dashboard')\n  useComponentDictionary('Employee.Dashboard', dictionary)\n  const { t } = useTranslation('Employee.Dashboard')\n  const Components = useComponentContext()\n  const [internalTab, setInternalTab] = useState<DashboardTab>('basicDetails')\n  const selectedTab = controlledTab ?? internalTab\n\n  const tabs = [\n    {\n      id: 'basicDetails' as const,\n      label: t('tabs.basicDetails'),\n      content: null,\n    },\n    {\n      id: 'jobAndPay' as const,\n      label: t('tabs.jobAndPay'),\n      content: null,\n    },\n    {\n      id: 'taxes' as const,\n      label: t('tabs.taxes'),\n      content: null,\n    },\n    {\n      id: 'documents' as const,\n      label: t('tabs.documents'),\n      content: null,\n    },\n  ]\n\n  return (\n    <Flex flexDirection=\"column\" gap={32}>\n      <Suspense fallback={null}>\n        <DashboardHeader employeeId={employeeId} />\n      </Suspense>\n\n      <Flex flexDirection=\"column\" gap={8}>\n        <Components.Tabs\n          tabs={tabs}\n          selectedId={selectedTab}\n          onSelectionChange={id => {\n            const next = id as DashboardTab\n            setInternalTab(next)\n            onEvent(componentEvents.EMPLOYEE_DASHBOARD_TAB_CHANGE, { tab: next })\n          }}\n          aria-label={t('tabsLabel')}\n        />\n\n        <Flex flexDirection=\"column\" gap={24}>\n          {selectedTab === 'basicDetails' && (\n            <BasicDetailsView employeeId={employeeId} onEvent={onEvent} />\n          )}\n\n          {selectedTab === 'jobAndPay' && (\n            <JobAndPayView employeeId={employeeId} onEvent={onEvent} />\n          )}\n\n          {selectedTab === 'taxes' && (\n            <TaxesViewWithData employeeId={employeeId} onEvent={onEvent} />\n          )}\n\n          {selectedTab === 'documents' && (\n            <DocumentsCard employeeId={employeeId} onEvent={onEvent} />\n          )}\n        </Flex>\n      </Flex>\n    </Flex>\n  )\n}\n\nfunction DashboardHeader({ employeeId }: { employeeId: string }) {\n  const { t } = useTranslation('Employee.Dashboard')\n  const Components = useComponentContext()\n  const {\n    data: { employee },\n  } = useEmployeesGetSuspense({ employeeId })\n\n  return (\n    <Flex flexDirection=\"column\" gap={4}>\n      <Components.Heading as=\"h2\">\n        {firstLastName({ first_name: employee?.firstName, last_name: employee?.lastName })}\n      </Components.Heading>\n      <Components.Text variant=\"supporting\">{t('employeeRoleLabel')}</Components.Text>\n    </Flex>\n  )\n}\n\n/** @internal */\nexport function Dashboard({\n  FallbackComponent,\n  ...props\n}: DashboardProps & BaseComponentInterface) {\n  return (\n    <BaseBoundaries componentName=\"Employee.Dashboard\" FallbackComponent={FallbackComponent}>\n      <DashboardRoot {...props} />\n    </BaseBoundaries>\n  )\n}\n"],"names":["DashboardRoot","employeeId","dictionary","onEvent","controlledTab","useI18n","useComponentDictionary","t","useTranslation","Components","useComponentContext","internalTab","setInternalTab","useState","selectedTab","tabs","jsxs","Flex","jsx","Suspense","DashboardHeader","id","next","componentEvents","BasicDetailsView","JobAndPayView","TaxesViewWithData","DocumentsCard","employee","useEmployeesGetSuspense","firstLastName","Dashboard","FallbackComponent","props","BaseBoundaries"],"mappings":";;;;;;;;;;;;;;AAuBA,SAASA,EAAc;AAAA,EACrB,YAAAC;AAAA,EACA,YAAAC;AAAA,EACA,SAAAC;AAAA,EACA,aAAaC;AACf,GAAmB;AACjB,EAAAC,EAAQ,oBAAoB,GAC5BC,EAAuB,sBAAsBJ,CAAU;AACvD,QAAM,EAAE,GAAAK,EAAA,IAAMC,EAAe,oBAAoB,GAC3CC,IAAaC,EAAA,GACb,CAACC,GAAaC,CAAc,IAAIC,EAAuB,cAAc,GACrEC,IAAcV,KAAiBO,GAE/BI,IAAO;AAAA,IACX;AAAA,MACE,IAAI;AAAA,MACJ,OAAOR,EAAE,mBAAmB;AAAA,MAC5B,SAAS;AAAA,IAAA;AAAA,IAEX;AAAA,MACE,IAAI;AAAA,MACJ,OAAOA,EAAE,gBAAgB;AAAA,MACzB,SAAS;AAAA,IAAA;AAAA,IAEX;AAAA,MACE,IAAI;AAAA,MACJ,OAAOA,EAAE,YAAY;AAAA,MACrB,SAAS;AAAA,IAAA;AAAA,IAEX;AAAA,MACE,IAAI;AAAA,MACJ,OAAOA,EAAE,gBAAgB;AAAA,MACzB,SAAS;AAAA,IAAA;AAAA,EACX;AAGF,SACE,gBAAAS,EAACC,GAAA,EAAK,eAAc,UAAS,KAAK,IAChC,UAAA;AAAA,IAAA,gBAAAC,EAACC,KAAS,UAAU,MAClB,UAAA,gBAAAD,EAACE,GAAA,EAAgB,YAAAnB,GAAwB,GAC3C;AAAA,IAEA,gBAAAe,EAACC,GAAA,EAAK,eAAc,UAAS,KAAK,GAChC,UAAA;AAAA,MAAA,gBAAAC;AAAA,QAACT,EAAW;AAAA,QAAX;AAAA,UACC,MAAAM;AAAA,UACA,YAAYD;AAAA,UACZ,mBAAmB,CAAAO,MAAM;AACvB,kBAAMC,IAAOD;AACb,YAAAT,EAAeU,CAAI,GACnBnB,EAAQoB,EAAgB,+BAA+B,EAAE,KAAKD,GAAM;AAAA,UACtE;AAAA,UACA,cAAYf,EAAE,WAAW;AAAA,QAAA;AAAA,MAAA;AAAA,MAG3B,gBAAAS,EAACC,GAAA,EAAK,eAAc,UAAS,KAAK,IAC/B,UAAA;AAAA,QAAAH,MAAgB,kBACf,gBAAAI,EAACM,GAAA,EAAiB,YAAAvB,GAAwB,SAAAE,GAAkB;AAAA,QAG7DW,MAAgB,eACf,gBAAAI,EAACO,GAAA,EAAc,YAAAxB,GAAwB,SAAAE,GAAkB;AAAA,QAG1DW,MAAgB,WACf,gBAAAI,EAACQ,GAAA,EAAkB,YAAAzB,GAAwB,SAAAE,GAAkB;AAAA,QAG9DW,MAAgB,eACf,gBAAAI,EAACS,GAAA,EAAc,YAAA1B,GAAwB,SAAAE,EAAA,CAAkB;AAAA,MAAA,EAAA,CAE7D;AAAA,IAAA,EAAA,CACF;AAAA,EAAA,GACF;AAEJ;AAEA,SAASiB,EAAgB,EAAE,YAAAnB,KAAsC;AAC/D,QAAM,EAAE,GAAAM,EAAA,IAAMC,EAAe,oBAAoB,GAC3CC,IAAaC,EAAA,GACb;AAAA,IACJ,MAAM,EAAE,UAAAkB,EAAA;AAAA,EAAS,IACfC,EAAwB,EAAE,YAAA5B,GAAY;AAE1C,SACE,gBAAAe,EAACC,GAAA,EAAK,eAAc,UAAS,KAAK,GAChC,UAAA;AAAA,IAAA,gBAAAC,EAACT,EAAW,SAAX,EAAmB,IAAG,MACpB,UAAAqB,EAAc,EAAE,YAAYF,GAAU,WAAW,WAAWA,GAAU,SAAA,CAAU,GACnF;AAAA,IACA,gBAAAV,EAACT,EAAW,MAAX,EAAgB,SAAQ,cAAc,UAAAF,EAAE,mBAAmB,EAAA,CAAE;AAAA,EAAA,GAChE;AAEJ;AAGO,SAASwB,EAAU;AAAA,EACxB,mBAAAC;AAAA,EACA,GAAGC;AACL,GAA4C;AAC1C,SACE,gBAAAf,EAACgB,KAAe,eAAc,sBAAqB,mBAAAF,GACjD,UAAA,gBAAAd,EAAClB,GAAA,EAAe,GAAGiC,EAAA,CAAO,EAAA,CAC5B;AAEJ;"}
+{"version":3,"file":"Dashboard.js","sources":["../../../../src/components/Employee/Dashboard/Dashboard.tsx"],"sourcesContent":["import { Suspense, useState } from 'react'\nimport { useTranslation } from 'react-i18next'\nimport { useEmployeesGetSuspense } from '@gusto/embedded-api-v-2025-11-15/react-query/employeesGet'\nimport { BasicDetailsView } from './BasicDetailsView'\nimport { JobAndPayView } from './JobAndPayView'\nimport { TaxesViewWithData } from './TaxesView'\nimport { DocumentsCard } from '@/components/Employee/Documents/management/DocumentsCard'\nimport { Flex } from '@/components/Common/Flex/Flex'\nimport { useComponentContext } from '@/contexts/ComponentAdapter/useComponentContext'\nimport { BaseBoundaries, type BaseComponentInterface } from '@/components/Base/Base'\nimport { useComponentDictionary, useI18n } from '@/i18n'\nimport { componentEvents } from '@/shared/constants'\nimport { firstLastName } from '@/helpers/formattedStrings'\n\n/** @public */\nexport type DashboardTab = 'basicDetails' | 'jobAndPay' | 'taxes' | 'documents'\n\n/** @public */\nexport interface DashboardProps extends BaseComponentInterface<'Employee.Dashboard'> {\n  /** The associated employee identifier. */\n  employeeId: string\n  /** The currently active tab. Defaults to `'basicDetails'` when uncontrolled. */\n  selectedTab?: DashboardTab\n}\n\nfunction DashboardRoot({\n  employeeId,\n  dictionary,\n  onEvent,\n  selectedTab: controlledTab,\n}: DashboardProps) {\n  useI18n('Employee.Dashboard')\n  useComponentDictionary('Employee.Dashboard', dictionary)\n  const { t } = useTranslation('Employee.Dashboard')\n  const Components = useComponentContext()\n  const [internalTab, setInternalTab] = useState<DashboardTab>('basicDetails')\n  const selectedTab = controlledTab ?? internalTab\n\n  const tabs = [\n    {\n      id: 'basicDetails' as const,\n      label: t('tabs.basicDetails'),\n      content: null,\n    },\n    {\n      id: 'jobAndPay' as const,\n      label: t('tabs.jobAndPay'),\n      content: null,\n    },\n    {\n      id: 'taxes' as const,\n      label: t('tabs.taxes'),\n      content: null,\n    },\n    {\n      id: 'documents' as const,\n      label: t('tabs.documents'),\n      content: null,\n    },\n  ]\n\n  return (\n    <Flex flexDirection=\"column\" gap={32}>\n      <Suspense fallback={null}>\n        <DashboardHeader employeeId={employeeId} />\n      </Suspense>\n\n      <Flex flexDirection=\"column\" gap={8}>\n        <Components.Tabs\n          tabs={tabs}\n          selectedId={selectedTab}\n          onSelectionChange={id => {\n            const next = id as DashboardTab\n            setInternalTab(next)\n            onEvent(componentEvents.EMPLOYEE_DASHBOARD_TAB_CHANGE, { tab: next })\n          }}\n          aria-label={t('tabsLabel')}\n        />\n\n        <Flex flexDirection=\"column\" gap={24}>\n          {selectedTab === 'basicDetails' && (\n            <BasicDetailsView employeeId={employeeId} onEvent={onEvent} />\n          )}\n\n          {selectedTab === 'jobAndPay' && (\n            <JobAndPayView employeeId={employeeId} onEvent={onEvent} />\n          )}\n\n          {selectedTab === 'taxes' && (\n            <TaxesViewWithData employeeId={employeeId} onEvent={onEvent} />\n          )}\n\n          {selectedTab === 'documents' && (\n            <DocumentsCard employeeId={employeeId} onEvent={onEvent} />\n          )}\n        </Flex>\n      </Flex>\n    </Flex>\n  )\n}\n\nfunction DashboardHeader({ employeeId }: { employeeId: string }) {\n  const { t } = useTranslation('Employee.Dashboard')\n  const Components = useComponentContext()\n  const {\n    data: { employee },\n  } = useEmployeesGetSuspense({ employeeId })\n\n  return (\n    <Flex flexDirection=\"column\" gap={4}>\n      <Components.Heading as=\"h2\">\n        {firstLastName({ first_name: employee?.firstName, last_name: employee?.lastName })}\n      </Components.Heading>\n      <Components.Text variant=\"supporting\">{t('employeeRoleLabel')}</Components.Text>\n    </Flex>\n  )\n}\n\n/**\n * Employee self-service dashboard summarizing a single employee's basic details, job and pay, taxes, and documents.\n *\n * @remarks\n * Renders a tabbed overview of the employee, wrapped in the SDK's standard error and suspense\n * boundaries. The active tab may be controlled via `selectedTab` or left uncontrolled, in which\n * case it defaults to basic details. Each tab composes the read-only section cards listed below.\n *\n * @components\n * - {@link ProfileCard}\n * - {@link HomeAddressCard}\n * - {@link WorkAddressCard}\n * - {@link CompensationCard}\n * - {@link PaymentMethodCard}\n * - {@link DeductionsCard}\n * - {@link PaystubsCard}\n * - {@link FederalTaxesCard}\n * - {@link StateTaxesCard}\n * - {@link DocumentsCard}\n *\n * @param props - Component props. See {@link DashboardProps}.\n * @returns A React element rendering the employee dashboard.\n * @public\n */\nexport function Dashboard({ FallbackComponent, ...props }: DashboardProps) {\n  return (\n    <BaseBoundaries componentName=\"Employee.Dashboard\" FallbackComponent={FallbackComponent}>\n      <DashboardRoot {...props} />\n    </BaseBoundaries>\n  )\n}\n"],"names":["DashboardRoot","employeeId","dictionary","onEvent","controlledTab","useI18n","useComponentDictionary","t","useTranslation","Components","useComponentContext","internalTab","setInternalTab","useState","selectedTab","tabs","jsxs","Flex","jsx","Suspense","DashboardHeader","id","next","componentEvents","BasicDetailsView","JobAndPayView","TaxesViewWithData","DocumentsCard","employee","useEmployeesGetSuspense","firstLastName","Dashboard","FallbackComponent","props","BaseBoundaries"],"mappings":";;;;;;;;;;;;;;AAyBA,SAASA,EAAc;AAAA,EACrB,YAAAC;AAAA,EACA,YAAAC;AAAA,EACA,SAAAC;AAAA,EACA,aAAaC;AACf,GAAmB;AACjB,EAAAC,EAAQ,oBAAoB,GAC5BC,EAAuB,sBAAsBJ,CAAU;AACvD,QAAM,EAAE,GAAAK,EAAA,IAAMC,EAAe,oBAAoB,GAC3CC,IAAaC,EAAA,GACb,CAACC,GAAaC,CAAc,IAAIC,EAAuB,cAAc,GACrEC,IAAcV,KAAiBO,GAE/BI,IAAO;AAAA,IACX;AAAA,MACE,IAAI;AAAA,MACJ,OAAOR,EAAE,mBAAmB;AAAA,MAC5B,SAAS;AAAA,IAAA;AAAA,IAEX;AAAA,MACE,IAAI;AAAA,MACJ,OAAOA,EAAE,gBAAgB;AAAA,MACzB,SAAS;AAAA,IAAA;AAAA,IAEX;AAAA,MACE,IAAI;AAAA,MACJ,OAAOA,EAAE,YAAY;AAAA,MACrB,SAAS;AAAA,IAAA;AAAA,IAEX;AAAA,MACE,IAAI;AAAA,MACJ,OAAOA,EAAE,gBAAgB;AAAA,MACzB,SAAS;AAAA,IAAA;AAAA,EACX;AAGF,SACE,gBAAAS,EAACC,GAAA,EAAK,eAAc,UAAS,KAAK,IAChC,UAAA;AAAA,IAAA,gBAAAC,EAACC,KAAS,UAAU,MAClB,UAAA,gBAAAD,EAACE,GAAA,EAAgB,YAAAnB,GAAwB,GAC3C;AAAA,IAEA,gBAAAe,EAACC,GAAA,EAAK,eAAc,UAAS,KAAK,GAChC,UAAA;AAAA,MAAA,gBAAAC;AAAA,QAACT,EAAW;AAAA,QAAX;AAAA,UACC,MAAAM;AAAA,UACA,YAAYD;AAAA,UACZ,mBAAmB,CAAAO,MAAM;AACvB,kBAAMC,IAAOD;AACb,YAAAT,EAAeU,CAAI,GACnBnB,EAAQoB,EAAgB,+BAA+B,EAAE,KAAKD,GAAM;AAAA,UACtE;AAAA,UACA,cAAYf,EAAE,WAAW;AAAA,QAAA;AAAA,MAAA;AAAA,MAG3B,gBAAAS,EAACC,GAAA,EAAK,eAAc,UAAS,KAAK,IAC/B,UAAA;AAAA,QAAAH,MAAgB,kBACf,gBAAAI,EAACM,GAAA,EAAiB,YAAAvB,GAAwB,SAAAE,GAAkB;AAAA,QAG7DW,MAAgB,eACf,gBAAAI,EAACO,GAAA,EAAc,YAAAxB,GAAwB,SAAAE,GAAkB;AAAA,QAG1DW,MAAgB,WACf,gBAAAI,EAACQ,GAAA,EAAkB,YAAAzB,GAAwB,SAAAE,GAAkB;AAAA,QAG9DW,MAAgB,eACf,gBAAAI,EAACS,GAAA,EAAc,YAAA1B,GAAwB,SAAAE,EAAA,CAAkB;AAAA,MAAA,EAAA,CAE7D;AAAA,IAAA,EAAA,CACF;AAAA,EAAA,GACF;AAEJ;AAEA,SAASiB,EAAgB,EAAE,YAAAnB,KAAsC;AAC/D,QAAM,EAAE,GAAAM,EAAA,IAAMC,EAAe,oBAAoB,GAC3CC,IAAaC,EAAA,GACb;AAAA,IACJ,MAAM,EAAE,UAAAkB,EAAA;AAAA,EAAS,IACfC,EAAwB,EAAE,YAAA5B,GAAY;AAE1C,SACE,gBAAAe,EAACC,GAAA,EAAK,eAAc,UAAS,KAAK,GAChC,UAAA;AAAA,IAAA,gBAAAC,EAACT,EAAW,SAAX,EAAmB,IAAG,MACpB,UAAAqB,EAAc,EAAE,YAAYF,GAAU,WAAW,WAAWA,GAAU,SAAA,CAAU,GACnF;AAAA,IACA,gBAAAV,EAACT,EAAW,MAAX,EAAgB,SAAQ,cAAc,UAAAF,EAAE,mBAAmB,EAAA,CAAE;AAAA,EAAA,GAChE;AAEJ;AA0BO,SAASwB,EAAU,EAAE,mBAAAC,GAAmB,GAAGC,KAAyB;AACzE,SACE,gBAAAf,EAACgB,KAAe,eAAc,sBAAqB,mBAAAF,GACjD,UAAA,gBAAAd,EAAClB,GAAA,EAAe,GAAGiC,EAAA,CAAO,EAAA,CAC5B;AAEJ;"}

package/dist/components/Employee/Dashboard/DashboardFlow.d.ts

@@ -4,12 +4,12 @@ import { BaseComponentInterface } from '../../Base';
  *
  * @public
  */
-export interface DashboardFlowProps extends BaseComponentInterface {
+export interface DashboardFlowProps extends BaseComponentInterface<never> {
     /** The associated employee identifier. */
     employeeId: string;
 }
 /**
- * The main entry point for the employee dashboard.
+ * Hub for viewing and managing a single employee's profile, pay, and documents.
  *
  * @remarks
  * Renders a tabbed view of an employee's profile (Basic details, Job and pay,
@@ -20,17 +20,7 @@ export interface DashboardFlowProps extends BaseComponentInterface {
  *
  * Every tab section of the dashboard is also exported as a self-contained
  * block that can be dropped into a custom layout without the surrounding
- * dashboard chrome:
- *
- * - {@link Compensation} — Job &amp; Pay tab (jobs, pay type, wage, effective date)
- * - {@link Profile} — Basic details tab (name, start date, SSN, DOB, email)
- * - {@link FederalTaxes} — Taxes tab, federal withholding settings
- * - {@link StateTaxes} — Taxes tab, state withholding settings
- * - {@link PaymentMethod} — direct-deposit bank accounts and split-paycheck configuration
- * - {@link Deductions} — post-tax deductions (garnishments)
- * - {@link HomeAddress} — home address management
- * - {@link WorkAddress} — work address management
- * - {@link Documents} — documents and forms (read-only viewer)
+ * dashboard chrome (see the sub-components below).
  *
  * Each block wraps its read-only card, its edit form, and the card↔form
  * transitions as a single drop-in. For cases where that built-in orchestration
@@ -47,6 +37,7 @@ export interface DashboardFlowProps extends BaseComponentInterface {
  * complete, current set of events observable from `DashboardFlow`, grouped by
  * the tab that emits them.
  *
+ * @events
  * | Event | Description | Data |
  * | ----- | ----------- | ---- |
  * | `employee/management/profile/editRequested` | Fired when "Edit" is clicked on the Basic details (Profile) card | `{ employeeId: string }` |
@@ -99,13 +90,28 @@ export interface DashboardFlowProps extends BaseComponentInterface {
  * | `employee/dashboard/tabChange` | Fired when the user switches dashboard tabs | `{ tab: 'basicDetails' \| 'jobAndPay' \| 'taxes' \| 'documents' }` |
  * | `employee/dismiss` | Fired when the user dismisses a top-of-dashboard success alert | — |
  *
+ * @components
+ * - {@link Dashboard}
+ * - {@link ProfileEditForm}
+ * - {@link HomeAddressEditForm}
+ * - {@link WorkAddressEditForm}
+ * - {@link FederalTaxesEditForm}
+ * - {@link StateTaxesEditForm}
+ * - {@link PaymentMethodBankForm}
+ * - {@link PaymentMethodSplitForm}
+ * - {@link CompensationAddJobForm}
+ * - {@link CompensationEditForm}
+ * - {@link CompensationAddAnotherJobForm}
+ * - {@link DeductionsEditForm}
+ * - {@link DocumentManager}
+ *
  * @param props - See {@link DashboardFlowProps}.
  * @returns The tabbed dashboard with internal navigation between cards and edit screens.
  * @public
  * @group Flow Components
  *
  * @example
- * ```tsx
+ * ```tsx title="App.tsx"
  * import { EmployeeManagement } from '@gusto/embedded-react-sdk'
  *
  * function MyApp() {

package/dist/components/Employee/Dashboard/DashboardFlow.js.map

@@ -1 +1 @@
-{"version":3,"file":"DashboardFlow.js","sources":["../../../../src/components/Employee/Dashboard/DashboardFlow.tsx"],"sourcesContent":["import { createMachine } from 'robot3'\nimport { useMemo } from 'react'\nimport { dashboardStateMachine } from './dashboardStateMachine'\nimport { type DashboardContextInterface, DashboardViewContextual } from './DashboardComponents'\nimport { Flow } from '@/components/Flow/Flow'\nimport type { BaseComponentInterface } from '@/components/Base'\n\n/**\n * Props for {@link DashboardFlow}.\n *\n * @public\n */\nexport interface DashboardFlowProps extends BaseComponentInterface {\n  /** The associated employee identifier. */\n  employeeId: string\n}\n\n/**\n * The main entry point for the employee dashboard.\n *\n * @remarks\n * Renders a tabbed view of an employee's profile (Basic details, Job and pay,\n * Taxes, Documents), wires the card surfaces to their corresponding edit\n * screens via an internal state machine, and surfaces success alerts at the\n * top of the dashboard after each successful edit. Wraps the dashboard in\n * error and suspense boundaries.\n *\n * Every tab section of the dashboard is also exported as a self-contained\n * block that can be dropped into a custom layout without the surrounding\n * dashboard chrome:\n *\n * - {@link Compensation} — Job &amp; Pay tab (jobs, pay type, wage, effective date)\n * - {@link Profile} — Basic details tab (name, start date, SSN, DOB, email)\n * - {@link FederalTaxes} — Taxes tab, federal withholding settings\n * - {@link StateTaxes} — Taxes tab, state withholding settings\n * - {@link PaymentMethod} — direct-deposit bank accounts and split-paycheck configuration\n * - {@link Deductions} — post-tax deductions (garnishments)\n * - {@link HomeAddress} — home address management\n * - {@link WorkAddress} — work address management\n * - {@link Documents} — documents and forms (read-only viewer)\n *\n * Each block wraps its read-only card, its edit form, and the card↔form\n * transitions as a single drop-in. For cases where that built-in orchestration\n * doesn't fit — rendering a form in a modal, driving navigation via a router,\n * or showing a card read-only — each block's card and form are also exported\n * individually (e.g. {@link CompensationCard}, {@link CompensationEditForm}).\n * Using the individual pieces means owning the swap, any success alerts, and\n * cross-component state yourself.\n *\n * The dashboard composes self-fetching cards and their edit forms and forwards\n * every event they emit to the partner via `onEvent`; its internal state\n * machine also reacts to a subset of these events to swap between the cards\n * and edit screens and to surface success alerts. The table below is the\n * complete, current set of events observable from `DashboardFlow`, grouped by\n * the tab that emits them.\n *\n * | Event | Description | Data |\n * | ----- | ----------- | ---- |\n * | `employee/management/profile/editRequested` | Fired when \"Edit\" is clicked on the Basic details (Profile) card | `{ employeeId: string }` |\n * | `employee/management/profile/updated` | Fired after the basic-details edit form is saved; the dashboard returns to the cards and surfaces the \"Profile updated\" alert | Updated `Employee` entity |\n * | `employee/management/profile/editCancelled` | Fired when the user clicks Cancel on the basic-details edit form; the dashboard returns to the cards | — |\n * | `employee/management/homeAddress/editRequested` | Fired when \"Manage\" is clicked on the Home address card | `{ employeeId: string }` |\n * | `employee/management/homeAddress/created` | Fired after a new home address is created on the manage screen; the manage screen stays open | Created `EmployeeAddress` entity |\n * | `employee/management/homeAddress/updated` | Fired after a home address is updated on the manage screen; the manage screen stays open | Updated `EmployeeAddress` entity |\n * | `employee/management/homeAddress/deleted` | Fired after a non-active home address is deleted on the manage screen; the manage screen stays open | Deleted `EmployeeAddress` entity |\n * | `employee/management/homeAddress/editCancelled` | Fired when the user clicks Back on the manage screen; the dashboard returns to the cards | — |\n * | `employee/management/workAddress/editRequested` | Fired when \"Manage\" is clicked on the Work address card | `{ employeeId: string }` |\n * | `employee/management/workAddress/created` | Fired after a new work address is created on the manage screen; the manage screen stays open | Created `EmployeeWorkAddress` entity |\n * | `employee/management/workAddress/updated` | Fired after a work address is updated on the manage screen; the manage screen stays open | Updated `EmployeeWorkAddress` entity |\n * | `employee/management/workAddress/deleted` | Fired after a work address is deleted on the manage screen; the manage screen stays open | Deleted `EmployeeWorkAddress` entity |\n * | `employee/management/workAddress/editCancelled` | Fired when the user clicks Back on the manage screen; the dashboard returns to the cards | — |\n * | `employee/management/compensation/card/editRequested` | Fired when an \"Edit\" CTA is clicked for a job on the Compensation card | `{ employeeId: string, jobId: string }` |\n * | `employee/management/compensation/card/addRequested` | Fired when \"Add job\" is clicked from the Compensation card's empty state | `{ employeeId: string }` |\n * | `employee/management/compensation/card/addAnotherRequested` | Fired when \"Add another job\" is clicked on the Compensation card | `{ employeeId: string }` |\n * | `employee/management/compensation/card/jobDeleted` | Fired after a non-primary job is deleted via the card's confirm dialog | `{ employeeId: string, jobId: string }` |\n * | `employee/management/compensation/card/changeCancelled` | Fired after a scheduled future-dated change is cancelled from the card | `{ employeeId: string, compensationId: string }` |\n * | `employee/management/compensation/editForm/submitted` | Fired after an edit-compensation save completes; the dashboard returns to the cards | Updated `Compensation` entity |\n * | `employee/management/compensation/editForm/cancelled` | Fired when the user cancels the edit-compensation form; the dashboard returns to the cards | — |\n * | `employee/management/compensation/addJobForm/submitted` | Fired after the first job and compensation are saved; the dashboard returns to the cards and surfaces the \"Job added\" alert | Updated `Compensation` entity |\n * | `employee/management/compensation/addJobForm/cancelled` | Fired when the user cancels the add-job form; the dashboard returns to the cards | — |\n * | `employee/management/compensation/addAnotherJobForm/submitted` | Fired after a secondary job and compensation are saved; the dashboard returns to the cards and surfaces the \"Job added\" alert | Updated `Compensation` entity |\n * | `employee/management/compensation/addAnotherJobForm/cancelled` | Fired when the user cancels the add-another-job form; the dashboard returns to the cards | — |\n * | `employee/management/paymentMethod/card/addRequested` | Fired when \"Add bank account\" / \"Add another bank account\" is clicked on the Payment card | — |\n * | `employee/management/paymentMethod/card/splitRequested` | Fired when \"Split paycheck\" is clicked on the Payment card | — |\n * | `employee/management/paymentMethod/card/bankAccountDeleted` | Fired after a bank account is deleted from the card; the dashboard surfaces the \"Bank account deleted\" alert | Response from the Delete a bank account endpoint |\n * | `employee/management/paymentMethod/bankForm/submitted` | Fired after a new bank account is saved; the dashboard returns to the cards and surfaces the \"Bank account added\" alert | Created `EmployeeBankAccount` entity |\n * | `employee/management/paymentMethod/bankForm/cancelled` | Fired when the user cancels the add-bank-account screen; the dashboard returns to the cards | — |\n * | `employee/management/paymentMethod/splitForm/submitted` | Fired after the split configuration is saved; the dashboard returns to the cards and surfaces the \"Split updated\" alert | Updated `EmployeePaymentMethod` entity |\n * | `employee/management/paymentMethod/splitForm/cancelled` | Fired when the user cancels the split-paycheck screen; the dashboard returns to the cards | — |\n * | `employee/management/deductions/card/addRequested` | Fired when \"Add deduction\" is clicked on the Deductions card | `{ employeeId: string }` |\n * | `employee/management/deductions/card/editRequested` | Fired when a row's \"Edit\" menu item is chosen on the Deductions card | The `Garnishment` row being edited |\n * | `employee/management/deductions/card/deleted` | Fired after the soft-delete dialog is confirmed; the dashboard surfaces the \"Deduction deleted\" alert | The now-inactive `Garnishment` |\n * | `employee/management/deductions/editForm/created` | Fired after a new deduction is created; the dashboard returns to the cards and surfaces the \"Deduction added\" alert | The created `Garnishment` |\n * | `employee/management/deductions/editForm/updated` | Fired after a deduction is updated; the dashboard returns to the cards and surfaces the \"Deduction updated\" alert | The updated `Garnishment` |\n * | `employee/management/deductions/editForm/cancelled` | Fired when the user cancels the add/edit deduction form; the dashboard returns to the cards | — |\n * | `employee/management/paystubs/card/downloadRequested` | Fired when a paystub row's download button is clicked, before the PDF is fetched | `{ employeeId: string, payrollUuid: string }` |\n * | `employee/management/paystubs/card/downloaded` | Fired after the paystub PDF is fetched and opened in a new tab | `{ employeeId: string, payrollUuid: string }` |\n * | `employee/management/federalTaxes/card/editRequested` | Fired when \"Edit\" is clicked on the Federal taxes card | `{ employeeId: string }` |\n * | `employee/management/federalTaxes/editForm/submitted` | Fired after a federal-taxes save succeeds; the dashboard returns to the cards and surfaces the \"Federal taxes updated\" alert | Updated `EmployeeFederalTax` entity |\n * | `employee/management/federalTaxes/editForm/cancelled` | Fired when the user cancels the federal-taxes edit form; the dashboard returns to the cards | — |\n * | `employee/management/stateTaxes/editRequested` | Fired when \"Edit\" is clicked on the State taxes card | `{ employeeId: string }` |\n * | `employee/management/stateTaxes/updated` | Fired after a state-taxes save succeeds; the dashboard returns to the cards and surfaces the \"State taxes updated\" alert | `{ employeeStateTaxesList: EmployeeStateTaxesList[] }` |\n * | `employee/management/stateTaxes/editCancelled` | Fired when the user cancels the state-taxes edit form; the dashboard returns to the cards | — |\n * | `employee/management/documents/card/viewRequested` | Fired when a document row's \"View\" CTA is clicked; the dashboard swaps to the read-only document viewer | `{ employeeId: string, formId: string }` |\n * | `CANCEL` | Fired when the user clicks Back in the document viewer; the dashboard returns to the cards | — |\n * | `employee/dashboard/tabChange` | Fired when the user switches dashboard tabs | `{ tab: 'basicDetails' \\| 'jobAndPay' \\| 'taxes' \\| 'documents' }` |\n * | `employee/dismiss` | Fired when the user dismisses a top-of-dashboard success alert | — |\n *\n * @param props - See {@link DashboardFlowProps}.\n * @returns The tabbed dashboard with internal navigation between cards and edit screens.\n * @public\n * @group Flow Components\n *\n * @example\n * ```tsx\n * import { EmployeeManagement } from '@gusto/embedded-react-sdk'\n *\n * function MyApp() {\n *   return (\n *     <EmployeeManagement.DashboardFlow\n *       employeeId=\"4b3f930f-82cd-48a8-b797-798686e12e5e\"\n *       onEvent={() => {}}\n *     />\n *   )\n * }\n * ```\n */\nexport const DashboardFlow = ({ employeeId, onEvent }: DashboardFlowProps) => {\n  const dashboardMachine = useMemo(\n    () =>\n      createMachine(\n        'index',\n        dashboardStateMachine,\n        (initialContext: DashboardContextInterface) => ({\n          ...initialContext,\n          component: DashboardViewContextual,\n          employeeId,\n        }),\n      ),\n    [employeeId],\n  )\n\n  return <Flow machine={dashboardMachine} onEvent={onEvent} />\n}\n"],"names":["DashboardFlow","employeeId","onEvent","dashboardMachine","useMemo","createMachine","dashboardStateMachine","initialContext","DashboardViewContextual","jsx","Flow"],"mappings":";;;;;;AA+HO,MAAMA,IAAgB,CAAC,EAAE,YAAAC,GAAY,SAAAC,QAAkC;AAC5E,QAAMC,IAAmBC;AAAA,IACvB,MACEC;AAAA,MACE;AAAA,MACAC;AAAA,MACA,CAACC,OAA+C;AAAA,QAC9C,GAAGA;AAAA,QACH,WAAWC;AAAA,QACX,YAAAP;AAAA,MAAA;AAAA,IACF;AAAA,IAEJ,CAACA,CAAU;AAAA,EAAA;AAGb,SAAO,gBAAAQ,EAACC,GAAA,EAAK,SAASP,GAAkB,SAAAD,EAAA,CAAkB;AAC5D;"}
+{"version":3,"file":"DashboardFlow.js","sources":["../../../../src/components/Employee/Dashboard/DashboardFlow.tsx"],"sourcesContent":["import { createMachine } from 'robot3'\nimport { useMemo } from 'react'\nimport { dashboardStateMachine } from './dashboardStateMachine'\nimport { type DashboardContextInterface, DashboardViewContextual } from './DashboardComponents'\nimport { Flow } from '@/components/Flow/Flow'\nimport type { BaseComponentInterface } from '@/components/Base'\n\n/**\n * Props for {@link DashboardFlow}.\n *\n * @public\n */\nexport interface DashboardFlowProps extends BaseComponentInterface<never> {\n  /** The associated employee identifier. */\n  employeeId: string\n}\n\n/**\n * Hub for viewing and managing a single employee's profile, pay, and documents.\n *\n * @remarks\n * Renders a tabbed view of an employee's profile (Basic details, Job and pay,\n * Taxes, Documents), wires the card surfaces to their corresponding edit\n * screens via an internal state machine, and surfaces success alerts at the\n * top of the dashboard after each successful edit. Wraps the dashboard in\n * error and suspense boundaries.\n *\n * Every tab section of the dashboard is also exported as a self-contained\n * block that can be dropped into a custom layout without the surrounding\n * dashboard chrome (see the sub-components below).\n *\n * Each block wraps its read-only card, its edit form, and the card↔form\n * transitions as a single drop-in. For cases where that built-in orchestration\n * doesn't fit — rendering a form in a modal, driving navigation via a router,\n * or showing a card read-only — each block's card and form are also exported\n * individually (e.g. {@link CompensationCard}, {@link CompensationEditForm}).\n * Using the individual pieces means owning the swap, any success alerts, and\n * cross-component state yourself.\n *\n * The dashboard composes self-fetching cards and their edit forms and forwards\n * every event they emit to the partner via `onEvent`; its internal state\n * machine also reacts to a subset of these events to swap between the cards\n * and edit screens and to surface success alerts. The table below is the\n * complete, current set of events observable from `DashboardFlow`, grouped by\n * the tab that emits them.\n *\n * @events\n * | Event | Description | Data |\n * | ----- | ----------- | ---- |\n * | `employee/management/profile/editRequested` | Fired when \"Edit\" is clicked on the Basic details (Profile) card | `{ employeeId: string }` |\n * | `employee/management/profile/updated` | Fired after the basic-details edit form is saved; the dashboard returns to the cards and surfaces the \"Profile updated\" alert | Updated `Employee` entity |\n * | `employee/management/profile/editCancelled` | Fired when the user clicks Cancel on the basic-details edit form; the dashboard returns to the cards | — |\n * | `employee/management/homeAddress/editRequested` | Fired when \"Manage\" is clicked on the Home address card | `{ employeeId: string }` |\n * | `employee/management/homeAddress/created` | Fired after a new home address is created on the manage screen; the manage screen stays open | Created `EmployeeAddress` entity |\n * | `employee/management/homeAddress/updated` | Fired after a home address is updated on the manage screen; the manage screen stays open | Updated `EmployeeAddress` entity |\n * | `employee/management/homeAddress/deleted` | Fired after a non-active home address is deleted on the manage screen; the manage screen stays open | Deleted `EmployeeAddress` entity |\n * | `employee/management/homeAddress/editCancelled` | Fired when the user clicks Back on the manage screen; the dashboard returns to the cards | — |\n * | `employee/management/workAddress/editRequested` | Fired when \"Manage\" is clicked on the Work address card | `{ employeeId: string }` |\n * | `employee/management/workAddress/created` | Fired after a new work address is created on the manage screen; the manage screen stays open | Created `EmployeeWorkAddress` entity |\n * | `employee/management/workAddress/updated` | Fired after a work address is updated on the manage screen; the manage screen stays open | Updated `EmployeeWorkAddress` entity |\n * | `employee/management/workAddress/deleted` | Fired after a work address is deleted on the manage screen; the manage screen stays open | Deleted `EmployeeWorkAddress` entity |\n * | `employee/management/workAddress/editCancelled` | Fired when the user clicks Back on the manage screen; the dashboard returns to the cards | — |\n * | `employee/management/compensation/card/editRequested` | Fired when an \"Edit\" CTA is clicked for a job on the Compensation card | `{ employeeId: string, jobId: string }` |\n * | `employee/management/compensation/card/addRequested` | Fired when \"Add job\" is clicked from the Compensation card's empty state | `{ employeeId: string }` |\n * | `employee/management/compensation/card/addAnotherRequested` | Fired when \"Add another job\" is clicked on the Compensation card | `{ employeeId: string }` |\n * | `employee/management/compensation/card/jobDeleted` | Fired after a non-primary job is deleted via the card's confirm dialog | `{ employeeId: string, jobId: string }` |\n * | `employee/management/compensation/card/changeCancelled` | Fired after a scheduled future-dated change is cancelled from the card | `{ employeeId: string, compensationId: string }` |\n * | `employee/management/compensation/editForm/submitted` | Fired after an edit-compensation save completes; the dashboard returns to the cards | Updated `Compensation` entity |\n * | `employee/management/compensation/editForm/cancelled` | Fired when the user cancels the edit-compensation form; the dashboard returns to the cards | — |\n * | `employee/management/compensation/addJobForm/submitted` | Fired after the first job and compensation are saved; the dashboard returns to the cards and surfaces the \"Job added\" alert | Updated `Compensation` entity |\n * | `employee/management/compensation/addJobForm/cancelled` | Fired when the user cancels the add-job form; the dashboard returns to the cards | — |\n * | `employee/management/compensation/addAnotherJobForm/submitted` | Fired after a secondary job and compensation are saved; the dashboard returns to the cards and surfaces the \"Job added\" alert | Updated `Compensation` entity |\n * | `employee/management/compensation/addAnotherJobForm/cancelled` | Fired when the user cancels the add-another-job form; the dashboard returns to the cards | — |\n * | `employee/management/paymentMethod/card/addRequested` | Fired when \"Add bank account\" / \"Add another bank account\" is clicked on the Payment card | — |\n * | `employee/management/paymentMethod/card/splitRequested` | Fired when \"Split paycheck\" is clicked on the Payment card | — |\n * | `employee/management/paymentMethod/card/bankAccountDeleted` | Fired after a bank account is deleted from the card; the dashboard surfaces the \"Bank account deleted\" alert | Response from the Delete a bank account endpoint |\n * | `employee/management/paymentMethod/bankForm/submitted` | Fired after a new bank account is saved; the dashboard returns to the cards and surfaces the \"Bank account added\" alert | Created `EmployeeBankAccount` entity |\n * | `employee/management/paymentMethod/bankForm/cancelled` | Fired when the user cancels the add-bank-account screen; the dashboard returns to the cards | — |\n * | `employee/management/paymentMethod/splitForm/submitted` | Fired after the split configuration is saved; the dashboard returns to the cards and surfaces the \"Split updated\" alert | Updated `EmployeePaymentMethod` entity |\n * | `employee/management/paymentMethod/splitForm/cancelled` | Fired when the user cancels the split-paycheck screen; the dashboard returns to the cards | — |\n * | `employee/management/deductions/card/addRequested` | Fired when \"Add deduction\" is clicked on the Deductions card | `{ employeeId: string }` |\n * | `employee/management/deductions/card/editRequested` | Fired when a row's \"Edit\" menu item is chosen on the Deductions card | The `Garnishment` row being edited |\n * | `employee/management/deductions/card/deleted` | Fired after the soft-delete dialog is confirmed; the dashboard surfaces the \"Deduction deleted\" alert | The now-inactive `Garnishment` |\n * | `employee/management/deductions/editForm/created` | Fired after a new deduction is created; the dashboard returns to the cards and surfaces the \"Deduction added\" alert | The created `Garnishment` |\n * | `employee/management/deductions/editForm/updated` | Fired after a deduction is updated; the dashboard returns to the cards and surfaces the \"Deduction updated\" alert | The updated `Garnishment` |\n * | `employee/management/deductions/editForm/cancelled` | Fired when the user cancels the add/edit deduction form; the dashboard returns to the cards | — |\n * | `employee/management/paystubs/card/downloadRequested` | Fired when a paystub row's download button is clicked, before the PDF is fetched | `{ employeeId: string, payrollUuid: string }` |\n * | `employee/management/paystubs/card/downloaded` | Fired after the paystub PDF is fetched and opened in a new tab | `{ employeeId: string, payrollUuid: string }` |\n * | `employee/management/federalTaxes/card/editRequested` | Fired when \"Edit\" is clicked on the Federal taxes card | `{ employeeId: string }` |\n * | `employee/management/federalTaxes/editForm/submitted` | Fired after a federal-taxes save succeeds; the dashboard returns to the cards and surfaces the \"Federal taxes updated\" alert | Updated `EmployeeFederalTax` entity |\n * | `employee/management/federalTaxes/editForm/cancelled` | Fired when the user cancels the federal-taxes edit form; the dashboard returns to the cards | — |\n * | `employee/management/stateTaxes/editRequested` | Fired when \"Edit\" is clicked on the State taxes card | `{ employeeId: string }` |\n * | `employee/management/stateTaxes/updated` | Fired after a state-taxes save succeeds; the dashboard returns to the cards and surfaces the \"State taxes updated\" alert | `{ employeeStateTaxesList: EmployeeStateTaxesList[] }` |\n * | `employee/management/stateTaxes/editCancelled` | Fired when the user cancels the state-taxes edit form; the dashboard returns to the cards | — |\n * | `employee/management/documents/card/viewRequested` | Fired when a document row's \"View\" CTA is clicked; the dashboard swaps to the read-only document viewer | `{ employeeId: string, formId: string }` |\n * | `CANCEL` | Fired when the user clicks Back in the document viewer; the dashboard returns to the cards | — |\n * | `employee/dashboard/tabChange` | Fired when the user switches dashboard tabs | `{ tab: 'basicDetails' \\| 'jobAndPay' \\| 'taxes' \\| 'documents' }` |\n * | `employee/dismiss` | Fired when the user dismisses a top-of-dashboard success alert | — |\n *\n * @components\n * - {@link Dashboard}\n * - {@link ProfileEditForm}\n * - {@link HomeAddressEditForm}\n * - {@link WorkAddressEditForm}\n * - {@link FederalTaxesEditForm}\n * - {@link StateTaxesEditForm}\n * - {@link PaymentMethodBankForm}\n * - {@link PaymentMethodSplitForm}\n * - {@link CompensationAddJobForm}\n * - {@link CompensationEditForm}\n * - {@link CompensationAddAnotherJobForm}\n * - {@link DeductionsEditForm}\n * - {@link DocumentManager}\n *\n * @param props - See {@link DashboardFlowProps}.\n * @returns The tabbed dashboard with internal navigation between cards and edit screens.\n * @public\n * @group Flow Components\n *\n * @example\n * ```tsx title=\"App.tsx\"\n * import { EmployeeManagement } from '@gusto/embedded-react-sdk'\n *\n * function MyApp() {\n *   return (\n *     <EmployeeManagement.DashboardFlow\n *       employeeId=\"4b3f930f-82cd-48a8-b797-798686e12e5e\"\n *       onEvent={() => {}}\n *     />\n *   )\n * }\n * ```\n */\nexport const DashboardFlow = ({ employeeId, onEvent }: DashboardFlowProps) => {\n  const dashboardMachine = useMemo(\n    () =>\n      createMachine(\n        'index',\n        dashboardStateMachine,\n        (initialContext: DashboardContextInterface) => ({\n          ...initialContext,\n          component: DashboardViewContextual,\n          employeeId,\n        }),\n      ),\n    [employeeId],\n  )\n\n  return <Flow machine={dashboardMachine} onEvent={onEvent} />\n}\n"],"names":["DashboardFlow","employeeId","onEvent","dashboardMachine","useMemo","createMachine","dashboardStateMachine","initialContext","DashboardViewContextual","jsx","Flow"],"mappings":";;;;;;AAqIO,MAAMA,IAAgB,CAAC,EAAE,YAAAC,GAAY,SAAAC,QAAkC;AAC5E,QAAMC,IAAmBC;AAAA,IACvB,MACEC;AAAA,MACE;AAAA,MACAC;AAAA,MACA,CAACC,OAA+C;AAAA,QAC9C,GAAGA;AAAA,QACH,WAAWC;AAAA,QACX,YAAAP;AAAA,MAAA;AAAA,IACF;AAAA,IAEJ,CAACA,CAAU;AAAA,EAAA;AAGb,SAAO,gBAAAQ,EAACC,GAAA,EAAK,SAASP,GAAkB,SAAAD,EAAA,CAAkB;AAC5D;"}