@gusto/embedded-react-sdk 0.47.1 → 0.48.1

package/dist/components/Employee/Deductions/shared/useChildSupportGarnishmentForm/fields.d.ts

@@ -4,33 +4,240 @@ import { TextInputHookFieldProps } from '../../../../../partner-hook-utils/form/
 import { NumberInputHookFieldProps } from '../../../../../partner-hook-utils/form/fields/NumberInputHookField';
 import { SelectHookFieldProps } from '../../../../../partner-hook-utils/form/fields/SelectHookField';
 import { HookFieldProps } from '../../../../../partner-hook-utils/types';
+/**
+ * The required-field error code produced by {@link useChildSupportGarnishmentForm} fields that only emit `REQUIRED`.
+ *
+ * @remarks
+ * Used as the `validationMessages` key for the state, county (fips code), case
+ * number, order number, remittance number, and payment-period fields. See
+ * {@link ChildSupportGarnishmentFormErrorCodes}.
+ *
+ * @public
+ */
 export type RequiredValidation = typeof ChildSupportGarnishmentFormErrorCodes.REQUIRED;
+/**
+ * The negative-amount error code produced by {@link useChildSupportGarnishmentForm}'s currency fields.
+ *
+ * @remarks
+ * Used as a `validationMessages` key on `Fields.PayPeriodMaximum`. See
+ * {@link ChildSupportGarnishmentFormErrorCodes}.
+ *
+ * @public
+ */
 export type NegativeAmountValidation = typeof ChildSupportGarnishmentFormErrorCodes.NEGATIVE_AMOUNT;
+/**
+ * The percent-out-of-range error code produced by {@link useChildSupportGarnishmentForm}'s percentage field.
+ *
+ * @remarks
+ * Used as a `validationMessages` key on `Fields.Amount` (the percent-of-paycheck input).
+ * See {@link ChildSupportGarnishmentFormErrorCodes}.
+ *
+ * @public
+ */
 export type PercentValidation = typeof ChildSupportGarnishmentFormErrorCodes.PERCENT_OUT_OF_RANGE;
+/**
+ * Validation error codes emitted by the `payPeriodMaximum` field of {@link useChildSupportGarnishmentForm}.
+ *
+ * @remarks
+ * Use these as keys in `validationMessages` on `Fields.PayPeriodMaximum`. See
+ * {@link ChildSupportGarnishmentFormErrorCodes} for the full description of each code.
+ *
+ * @public
+ */
 export type PayPeriodMaximumValidation = RequiredValidation | NegativeAmountValidation;
+/**
+ * Validation error codes emitted by the `amount` field of {@link useChildSupportGarnishmentForm}.
+ *
+ * @remarks
+ * Use these as keys in `validationMessages` on `Fields.Amount`. The field
+ * accepts a percentage of paycheck (0–100). See
+ * {@link ChildSupportGarnishmentFormErrorCodes} for the full description of each code.
+ *
+ * @public
+ */
 export type AmountValidation = RequiredValidation | PercentValidation;
+/**
+ * Raw agency entry exposed on {@link useChildSupportGarnishmentForm}'s `data.agencies` and as the `entries` shape for the `State` select.
+ *
+ * @remarks
+ * Supply `getOptionLabel` on `Fields.State` to translate the agency name into a
+ * localized label — the SDK's option-label fallback is the agency state code.
+ *
+ * @public
+ */
 export type StateFieldEntry = {
+    /** The agency's state code (e.g. `AK`). */
     state: string;
+    /** The agency name as returned by the Gusto API. */
     name: string;
+    /** True when the agency requires payments to be remitted manually rather than through Gusto. */
     manualPaymentRequired?: boolean;
 };
+/**
+ * Props accepted by {@link useChildSupportGarnishmentForm}'s `Fields.State` component.
+ *
+ * @public
+ */
 export type StateFieldProps = HookFieldProps<SelectHookFieldProps<RequiredValidation, StateFieldEntry>>;
+/**
+ * Select bound to the `state` field of {@link useChildSupportGarnishmentForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.State`. Always rendered. The
+ * selected agency drives which subsequent fields are required and visible
+ * (`FipsCode`, `CaseNumber`, `OrderNumber`, `RemittanceNumber`).
+ *
+ * @param props - {@link StateFieldProps} — accepts the standard hook field props plus `getOptionLabel` for agency display.
+ * @returns The rendered select bound to `state`.
+ * @public
+ */
 export declare function StateField(props: StateFieldProps): import("react").JSX.Element;
+/**
+ * Raw county entry exposed on {@link useChildSupportGarnishmentForm}'s `data.counties` and as the `entries` shape for the `FipsCode` select.
+ *
+ * @remarks
+ * `county` is `null` for "all counties" entries — the agency's single county
+ * record represents the whole state. Supply `getOptionLabel` on
+ * `Fields.FipsCode` to translate the county name into a localized label.
+ *
+ * @public
+ */
 export type CountyEntry = {
+    /** The FIPS code for the county. */
     fipsCode: string;
+    /** The county name, or `null` for an "all counties" entry covering the whole state. */
     county: string | null;
 };
+/**
+ * Props accepted by {@link useChildSupportGarnishmentForm}'s `Fields.FipsCode` component.
+ *
+ * @public
+ */
 export type FipsCodeFieldProps = HookFieldProps<SelectHookFieldProps<RequiredValidation, CountyEntry>>;
+/**
+ * Select bound to the `fipsCode` field of {@link useChildSupportGarnishmentForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.FipsCode` only when the selected
+ * agency offers multiple counties. When the agency has a single "all counties"
+ * code, the hook auto-fills the value and exposes the field as `undefined` —
+ * always null-check before rendering. Options are dynamically populated from
+ * the FIPS codes the selected agency declares.
+ *
+ * @param props - {@link FipsCodeFieldProps} — accepts the standard hook field props plus `getOptionLabel` for county display.
+ * @returns The rendered select bound to `fipsCode`.
+ * @public
+ */
 export declare function FipsCodeField(props: FipsCodeFieldProps): import("react").JSX.Element;
+/**
+ * Props accepted by {@link useChildSupportGarnishmentForm}'s `Fields.CaseNumber` component.
+ *
+ * @public
+ */
 export type CaseNumberFieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>;
+/**
+ * Text input bound to the `caseNumber` field of {@link useChildSupportGarnishmentForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.CaseNumber` only when the
+ * selected agency requires a case number (`status.requiredAttrKeys.has('case_number')`).
+ * Always null-check before rendering.
+ *
+ * @param props - {@link CaseNumberFieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).
+ * @returns The rendered text input bound to `caseNumber`.
+ * @public
+ */
 export declare function CaseNumberField(props: CaseNumberFieldProps): import("react").JSX.Element;
+/**
+ * Props accepted by {@link useChildSupportGarnishmentForm}'s `Fields.OrderNumber` component.
+ *
+ * @public
+ */
 export type OrderNumberFieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>;
+/**
+ * Text input bound to the `orderNumber` field of {@link useChildSupportGarnishmentForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.OrderNumber` only when the
+ * selected agency requires an order number (`status.requiredAttrKeys.has('order_number')`).
+ * Always null-check before rendering.
+ *
+ * @param props - {@link OrderNumberFieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).
+ * @returns The rendered text input bound to `orderNumber`.
+ * @public
+ */
 export declare function OrderNumberField(props: OrderNumberFieldProps): import("react").JSX.Element;
+/**
+ * Props accepted by {@link useChildSupportGarnishmentForm}'s `Fields.RemittanceNumber` component.
+ *
+ * @public
+ */
 export type RemittanceNumberFieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>;
+/**
+ * Text input bound to the `remittanceNumber` field of {@link useChildSupportGarnishmentForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.RemittanceNumber` only when the
+ * selected agency requires a remittance number (`status.requiredAttrKeys.has('remittance_number')`).
+ * Always null-check before rendering.
+ *
+ * @param props - {@link RemittanceNumberFieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).
+ * @returns The rendered text input bound to `remittanceNumber`.
+ * @public
+ */
 export declare function RemittanceNumberField(props: RemittanceNumberFieldProps): import("react").JSX.Element;
+/**
+ * Props accepted by {@link useChildSupportGarnishmentForm}'s `Fields.PayPeriodMaximum` component.
+ *
+ * @public
+ */
 export type PayPeriodMaximumFieldProps = HookFieldProps<NumberInputHookFieldProps<PayPeriodMaximumValidation>>;
+/**
+ * Number input bound to the `payPeriodMaximum` field of {@link useChildSupportGarnishmentForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.PayPeriodMaximum`. Always
+ * rendered. Carries the per-pay-period currency cap for the garnishment.
+ *
+ * @param props - {@link PayPeriodMaximumFieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).
+ * @returns The rendered number input bound to `payPeriodMaximum`.
+ * @public
+ */
 export declare function PayPeriodMaximumField(props: PayPeriodMaximumFieldProps): import("react").JSX.Element;
+/**
+ * Props accepted by {@link useChildSupportGarnishmentForm}'s `Fields.Amount` component.
+ *
+ * @public
+ */
 export type AmountFieldProps = HookFieldProps<NumberInputHookFieldProps<AmountValidation>>;
+/**
+ * Number input bound to the `amount` field of {@link useChildSupportGarnishmentForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.Amount`. Always rendered.
+ * Accepts a percentage of paycheck in the range 0–100 — the API stores
+ * child-support amounts as percentages rather than fixed currency values.
+ *
+ * @param props - {@link AmountFieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).
+ * @returns The rendered number input bound to `amount`.
+ * @public
+ */
 export declare function AmountField(props: AmountFieldProps): import("react").JSX.Element;
+/**
+ * Props accepted by {@link useChildSupportGarnishmentForm}'s `Fields.PaymentPeriod` component.
+ *
+ * @public
+ */
 export type PaymentPeriodFieldProps = HookFieldProps<SelectHookFieldProps<RequiredValidation, PaymentPeriod>>;
+/**
+ * Select bound to the `paymentPeriod` field of {@link useChildSupportGarnishmentForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.PaymentPeriod`. Always rendered.
+ * Options: `Every week`, `Every other week`, `Twice per month`, `Monthly`.
+ *
+ * @param props - {@link PaymentPeriodFieldProps} — accepts the standard hook field props plus `getOptionLabel` for payment-period display.
+ * @returns The rendered select bound to `paymentPeriod`.
+ * @public
+ */
 export declare function PaymentPeriodField(props: PaymentPeriodFieldProps): import("react").JSX.Element;

package/dist/components/Employee/Deductions/shared/useChildSupportGarnishmentForm/fields.js

@@ -1,21 +1,21 @@
 import { jsx as r } from "react/jsx-runtime";
-import { SelectHookField as n } from "../../../../../partner-hook-utils/form/fields/SelectHookField.js";
+import { TextInputHookField as n } from "../../../../../partner-hook-utils/form/fields/TextInputHookField.js";
+import { SelectHookField as t } from "../../../../../partner-hook-utils/form/fields/SelectHookField.js";
 import { NumberInputHookField as i } from "../../../../../partner-hook-utils/form/fields/NumberInputHookField.js";
-import { TextInputHookField as t } from "../../../../../partner-hook-utils/form/fields/TextInputHookField.js";
 function d(e) {
-  return /* @__PURE__ */ r(n, { ...e, name: "state" });
+  return /* @__PURE__ */ r(t, { ...e, name: "state" });
 }
 function f(e) {
-  return /* @__PURE__ */ r(n, { ...e, name: "fipsCode" });
+  return /* @__PURE__ */ r(t, { ...e, name: "fipsCode" });
 }
 function c(e) {
-  return /* @__PURE__ */ r(t, { ...e, name: "caseNumber" });
+  return /* @__PURE__ */ r(n, { ...e, name: "caseNumber" });
 }
 function l(e) {
-  return /* @__PURE__ */ r(t, { ...e, name: "orderNumber" });
+  return /* @__PURE__ */ r(n, { ...e, name: "orderNumber" });
 }
 function F(e) {
-  return /* @__PURE__ */ r(t, { ...e, name: "remittanceNumber" });
+  return /* @__PURE__ */ r(n, { ...e, name: "remittanceNumber" });
 }
 function p(e) {
   return /* @__PURE__ */ r(i, { ...e, name: "payPeriodMaximum" });
@@ -24,7 +24,7 @@ function b(e) {
   return /* @__PURE__ */ r(i, { ...e, name: "amount" });
 }
 function N(e) {
-  return /* @__PURE__ */ r(n, { ...e, name: "paymentPeriod" });
+  return /* @__PURE__ */ r(t, { ...e, name: "paymentPeriod" });
 }
 export {
   b as AmountField,

package/dist/components/Employee/Deductions/shared/useChildSupportGarnishmentForm/fields.js.map

@@ -1 +1 @@
-{"version":3,"file":"fields.js","sources":["../../../../../../src/components/Employee/Deductions/shared/useChildSupportGarnishmentForm/fields.tsx"],"sourcesContent":["import type { PaymentPeriod } from '@gusto/embedded-api-v-2025-11-15/models/components/garnishmentchildsupport'\nimport type { ChildSupportGarnishmentFormErrorCodes } from './childSupportGarnishmentFormSchema'\nimport type { TextInputHookFieldProps } from '@/partner-hook-utils/form/fields/TextInputHookField'\nimport type { NumberInputHookFieldProps } from '@/partner-hook-utils/form/fields/NumberInputHookField'\nimport type { SelectHookFieldProps } from '@/partner-hook-utils/form/fields/SelectHookField'\nimport {\n  TextInputHookField,\n  NumberInputHookField,\n  SelectHookField,\n} from '@/partner-hook-utils/form/fields'\nimport type { HookFieldProps } from '@/partner-hook-utils/types'\n\nexport type RequiredValidation = typeof ChildSupportGarnishmentFormErrorCodes.REQUIRED\nexport type NegativeAmountValidation = typeof ChildSupportGarnishmentFormErrorCodes.NEGATIVE_AMOUNT\nexport type PercentValidation = typeof ChildSupportGarnishmentFormErrorCodes.PERCENT_OUT_OF_RANGE\n\nexport type PayPeriodMaximumValidation = RequiredValidation | NegativeAmountValidation\nexport type AmountValidation = RequiredValidation | PercentValidation\n\n// ── State (agency) ─────────────────────────────────────────────────────\n//\n// The select carries the raw agency record as `entries`; the consumer can\n// supply `getOptionLabel` to translate the agency name into a localized\n// label (the SDK's option-label fallback is the agency state code).\n\nexport type StateFieldEntry = {\n  state: string\n  name: string\n  manualPaymentRequired?: boolean\n}\n\nexport type StateFieldProps = HookFieldProps<\n  SelectHookFieldProps<RequiredValidation, StateFieldEntry>\n>\n\nexport function StateField(props: StateFieldProps) {\n  return <SelectHookField {...props} name=\"state\" />\n}\n\n// ── FipsCode (county) ──────────────────────────────────────────────────\n\nexport type CountyEntry = {\n  fipsCode: string\n  county: string | null\n}\n\nexport type FipsCodeFieldProps = HookFieldProps<\n  SelectHookFieldProps<RequiredValidation, CountyEntry>\n>\n\nexport function FipsCodeField(props: FipsCodeFieldProps) {\n  return <SelectHookField {...props} name=\"fipsCode\" />\n}\n\n// ── Required agency-attribute text inputs ──────────────────────────────\n\nexport type CaseNumberFieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>\n\nexport function CaseNumberField(props: CaseNumberFieldProps) {\n  return <TextInputHookField {...props} name=\"caseNumber\" />\n}\n\nexport type OrderNumberFieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>\n\nexport function OrderNumberField(props: OrderNumberFieldProps) {\n  return <TextInputHookField {...props} name=\"orderNumber\" />\n}\n\nexport type RemittanceNumberFieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>\n\nexport function RemittanceNumberField(props: RemittanceNumberFieldProps) {\n  return <TextInputHookField {...props} name=\"remittanceNumber\" />\n}\n\n// ── Pay-period maximum (currency) ──────────────────────────────────────\n\nexport type PayPeriodMaximumFieldProps = HookFieldProps<\n  NumberInputHookFieldProps<PayPeriodMaximumValidation>\n>\n\nexport function PayPeriodMaximumField(props: PayPeriodMaximumFieldProps) {\n  return <NumberInputHookField {...props} name=\"payPeriodMaximum\" />\n}\n\n// ── Amount (percent of paycheck, 0-100) ────────────────────────────────\n\nexport type AmountFieldProps = HookFieldProps<NumberInputHookFieldProps<AmountValidation>>\n\nexport function AmountField(props: AmountFieldProps) {\n  return <NumberInputHookField {...props} name=\"amount\" />\n}\n\n// ── Payment period (select) ────────────────────────────────────────────\n\nexport type PaymentPeriodFieldProps = HookFieldProps<\n  SelectHookFieldProps<RequiredValidation, PaymentPeriod>\n>\n\nexport function PaymentPeriodField(props: PaymentPeriodFieldProps) {\n  return <SelectHookField {...props} name=\"paymentPeriod\" />\n}\n"],"names":["StateField","props","jsx","SelectHookField","FipsCodeField","CaseNumberField","TextInputHookField","OrderNumberField","RemittanceNumberField","PayPeriodMaximumField","NumberInputHookField","AmountField","PaymentPeriodField"],"mappings":";;;;AAmCO,SAASA,EAAWC,GAAwB;AACjD,SAAO,gBAAAC,EAACC,GAAA,EAAiB,GAAGF,GAAO,MAAK,SAAQ;AAClD;AAaO,SAASG,EAAcH,GAA2B;AACvD,SAAO,gBAAAC,EAACC,GAAA,EAAiB,GAAGF,GAAO,MAAK,YAAW;AACrD;AAMO,SAASI,EAAgBJ,GAA6B;AAC3D,SAAO,gBAAAC,EAACI,GAAA,EAAoB,GAAGL,GAAO,MAAK,cAAa;AAC1D;AAIO,SAASM,EAAiBN,GAA8B;AAC7D,SAAO,gBAAAC,EAACI,GAAA,EAAoB,GAAGL,GAAO,MAAK,eAAc;AAC3D;AAIO,SAASO,EAAsBP,GAAmC;AACvE,SAAO,gBAAAC,EAACI,GAAA,EAAoB,GAAGL,GAAO,MAAK,oBAAmB;AAChE;AAQO,SAASQ,EAAsBR,GAAmC;AACvE,SAAO,gBAAAC,EAACQ,GAAA,EAAsB,GAAGT,GAAO,MAAK,oBAAmB;AAClE;AAMO,SAASU,EAAYV,GAAyB;AACnD,SAAO,gBAAAC,EAACQ,GAAA,EAAsB,GAAGT,GAAO,MAAK,UAAS;AACxD;AAQO,SAASW,EAAmBX,GAAgC;AACjE,SAAO,gBAAAC,EAACC,GAAA,EAAiB,GAAGF,GAAO,MAAK,iBAAgB;AAC1D;"}
+{"version":3,"file":"fields.js","sources":["../../../../../../src/components/Employee/Deductions/shared/useChildSupportGarnishmentForm/fields.tsx"],"sourcesContent":["import type { PaymentPeriod } from '@gusto/embedded-api-v-2025-11-15/models/components/garnishmentchildsupport'\nimport type { ChildSupportGarnishmentFormErrorCodes } from './childSupportGarnishmentFormSchema'\nimport type { TextInputHookFieldProps } from '@/partner-hook-utils/form/fields/TextInputHookField'\nimport type { NumberInputHookFieldProps } from '@/partner-hook-utils/form/fields/NumberInputHookField'\nimport type { SelectHookFieldProps } from '@/partner-hook-utils/form/fields/SelectHookField'\nimport {\n  TextInputHookField,\n  NumberInputHookField,\n  SelectHookField,\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 useChildSupportGarnishmentForm} fields that only emit `REQUIRED`.\n *\n * @remarks\n * Used as the `validationMessages` key for the state, county (fips code), case\n * number, order number, remittance number, and payment-period fields. See\n * {@link ChildSupportGarnishmentFormErrorCodes}.\n *\n * @public\n */\nexport type RequiredValidation = typeof ChildSupportGarnishmentFormErrorCodes.REQUIRED\n\n/**\n * The negative-amount error code produced by {@link useChildSupportGarnishmentForm}'s currency fields.\n *\n * @remarks\n * Used as a `validationMessages` key on `Fields.PayPeriodMaximum`. See\n * {@link ChildSupportGarnishmentFormErrorCodes}.\n *\n * @public\n */\nexport type NegativeAmountValidation = typeof ChildSupportGarnishmentFormErrorCodes.NEGATIVE_AMOUNT\n\n/**\n * The percent-out-of-range error code produced by {@link useChildSupportGarnishmentForm}'s percentage field.\n *\n * @remarks\n * Used as a `validationMessages` key on `Fields.Amount` (the percent-of-paycheck input).\n * See {@link ChildSupportGarnishmentFormErrorCodes}.\n *\n * @public\n */\nexport type PercentValidation = typeof ChildSupportGarnishmentFormErrorCodes.PERCENT_OUT_OF_RANGE\n\n/**\n * Validation error codes emitted by the `payPeriodMaximum` field of {@link useChildSupportGarnishmentForm}.\n *\n * @remarks\n * Use these as keys in `validationMessages` on `Fields.PayPeriodMaximum`. See\n * {@link ChildSupportGarnishmentFormErrorCodes} for the full description of each code.\n *\n * @public\n */\nexport type PayPeriodMaximumValidation = RequiredValidation | NegativeAmountValidation\n\n/**\n * Validation error codes emitted by the `amount` field of {@link useChildSupportGarnishmentForm}.\n *\n * @remarks\n * Use these as keys in `validationMessages` on `Fields.Amount`. The field\n * accepts a percentage of paycheck (0–100). See\n * {@link ChildSupportGarnishmentFormErrorCodes} for the full description of each code.\n *\n * @public\n */\nexport type AmountValidation = RequiredValidation | PercentValidation\n\n// ── State (agency) ─────────────────────────────────────────────────────\n//\n// The select carries the raw agency record as `entries`; the consumer can\n// supply `getOptionLabel` to translate the agency name into a localized\n// label (the SDK's option-label fallback is the agency state code).\n\n/**\n * Raw agency entry exposed on {@link useChildSupportGarnishmentForm}'s `data.agencies` and as the `entries` shape for the `State` select.\n *\n * @remarks\n * Supply `getOptionLabel` on `Fields.State` to translate the agency name into a\n * localized label — the SDK's option-label fallback is the agency state code.\n *\n * @public\n */\nexport type StateFieldEntry = {\n  /** The agency's state code (e.g. `AK`). */\n  state: string\n  /** The agency name as returned by the Gusto API. */\n  name: string\n  /** True when the agency requires payments to be remitted manually rather than through Gusto. */\n  manualPaymentRequired?: boolean\n}\n\n/**\n * Props accepted by {@link useChildSupportGarnishmentForm}'s `Fields.State` component.\n *\n * @public\n */\nexport type StateFieldProps = HookFieldProps<\n  SelectHookFieldProps<RequiredValidation, StateFieldEntry>\n>\n\n/**\n * Select bound to the `state` field of {@link useChildSupportGarnishmentForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.State`. Always rendered. The\n * selected agency drives which subsequent fields are required and visible\n * (`FipsCode`, `CaseNumber`, `OrderNumber`, `RemittanceNumber`).\n *\n * @param props - {@link StateFieldProps} — accepts the standard hook field props plus `getOptionLabel` for agency display.\n * @returns The rendered select bound to `state`.\n * @public\n */\nexport function StateField(props: StateFieldProps) {\n  return <SelectHookField {...props} name=\"state\" />\n}\n\n// ── FipsCode (county) ──────────────────────────────────────────────────\n\n/**\n * Raw county entry exposed on {@link useChildSupportGarnishmentForm}'s `data.counties` and as the `entries` shape for the `FipsCode` select.\n *\n * @remarks\n * `county` is `null` for \"all counties\" entries — the agency's single county\n * record represents the whole state. Supply `getOptionLabel` on\n * `Fields.FipsCode` to translate the county name into a localized label.\n *\n * @public\n */\nexport type CountyEntry = {\n  /** The FIPS code for the county. */\n  fipsCode: string\n  /** The county name, or `null` for an \"all counties\" entry covering the whole state. */\n  county: string | null\n}\n\n/**\n * Props accepted by {@link useChildSupportGarnishmentForm}'s `Fields.FipsCode` component.\n *\n * @public\n */\nexport type FipsCodeFieldProps = HookFieldProps<\n  SelectHookFieldProps<RequiredValidation, CountyEntry>\n>\n\n/**\n * Select bound to the `fipsCode` field of {@link useChildSupportGarnishmentForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.FipsCode` only when the selected\n * agency offers multiple counties. When the agency has a single \"all counties\"\n * code, the hook auto-fills the value and exposes the field as `undefined` —\n * always null-check before rendering. Options are dynamically populated from\n * the FIPS codes the selected agency declares.\n *\n * @param props - {@link FipsCodeFieldProps} — accepts the standard hook field props plus `getOptionLabel` for county display.\n * @returns The rendered select bound to `fipsCode`.\n * @public\n */\nexport function FipsCodeField(props: FipsCodeFieldProps) {\n  return <SelectHookField {...props} name=\"fipsCode\" />\n}\n\n// ── Required agency-attribute text inputs ──────────────────────────────\n\n/**\n * Props accepted by {@link useChildSupportGarnishmentForm}'s `Fields.CaseNumber` component.\n *\n * @public\n */\nexport type CaseNumberFieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>\n\n/**\n * Text input bound to the `caseNumber` field of {@link useChildSupportGarnishmentForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.CaseNumber` only when the\n * selected agency requires a case number (`status.requiredAttrKeys.has('case_number')`).\n * Always null-check before rendering.\n *\n * @param props - {@link CaseNumberFieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).\n * @returns The rendered text input bound to `caseNumber`.\n * @public\n */\nexport function CaseNumberField(props: CaseNumberFieldProps) {\n  return <TextInputHookField {...props} name=\"caseNumber\" />\n}\n\n/**\n * Props accepted by {@link useChildSupportGarnishmentForm}'s `Fields.OrderNumber` component.\n *\n * @public\n */\nexport type OrderNumberFieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>\n\n/**\n * Text input bound to the `orderNumber` field of {@link useChildSupportGarnishmentForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.OrderNumber` only when the\n * selected agency requires an order number (`status.requiredAttrKeys.has('order_number')`).\n * Always null-check before rendering.\n *\n * @param props - {@link OrderNumberFieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).\n * @returns The rendered text input bound to `orderNumber`.\n * @public\n */\nexport function OrderNumberField(props: OrderNumberFieldProps) {\n  return <TextInputHookField {...props} name=\"orderNumber\" />\n}\n\n/**\n * Props accepted by {@link useChildSupportGarnishmentForm}'s `Fields.RemittanceNumber` component.\n *\n * @public\n */\nexport type RemittanceNumberFieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>\n\n/**\n * Text input bound to the `remittanceNumber` field of {@link useChildSupportGarnishmentForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.RemittanceNumber` only when the\n * selected agency requires a remittance number (`status.requiredAttrKeys.has('remittance_number')`).\n * Always null-check before rendering.\n *\n * @param props - {@link RemittanceNumberFieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).\n * @returns The rendered text input bound to `remittanceNumber`.\n * @public\n */\nexport function RemittanceNumberField(props: RemittanceNumberFieldProps) {\n  return <TextInputHookField {...props} name=\"remittanceNumber\" />\n}\n\n// ── Pay-period maximum (currency) ──────────────────────────────────────\n\n/**\n * Props accepted by {@link useChildSupportGarnishmentForm}'s `Fields.PayPeriodMaximum` component.\n *\n * @public\n */\nexport type PayPeriodMaximumFieldProps = HookFieldProps<\n  NumberInputHookFieldProps<PayPeriodMaximumValidation>\n>\n\n/**\n * Number input bound to the `payPeriodMaximum` field of {@link useChildSupportGarnishmentForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.PayPeriodMaximum`. Always\n * rendered. Carries the per-pay-period currency cap for the garnishment.\n *\n * @param props - {@link PayPeriodMaximumFieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).\n * @returns The rendered number input bound to `payPeriodMaximum`.\n * @public\n */\nexport function PayPeriodMaximumField(props: PayPeriodMaximumFieldProps) {\n  return <NumberInputHookField {...props} name=\"payPeriodMaximum\" />\n}\n\n// ── Amount (percent of paycheck, 0-100) ────────────────────────────────\n\n/**\n * Props accepted by {@link useChildSupportGarnishmentForm}'s `Fields.Amount` component.\n *\n * @public\n */\nexport type AmountFieldProps = HookFieldProps<NumberInputHookFieldProps<AmountValidation>>\n\n/**\n * Number input bound to the `amount` field of {@link useChildSupportGarnishmentForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.Amount`. Always rendered.\n * Accepts a percentage of paycheck in the range 0–100 — the API stores\n * child-support amounts as percentages rather than fixed currency values.\n *\n * @param props - {@link AmountFieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).\n * @returns The rendered number input bound to `amount`.\n * @public\n */\nexport function AmountField(props: AmountFieldProps) {\n  return <NumberInputHookField {...props} name=\"amount\" />\n}\n\n// ── Payment period (select) ────────────────────────────────────────────\n\n/**\n * Props accepted by {@link useChildSupportGarnishmentForm}'s `Fields.PaymentPeriod` component.\n *\n * @public\n */\nexport type PaymentPeriodFieldProps = HookFieldProps<\n  SelectHookFieldProps<RequiredValidation, PaymentPeriod>\n>\n\n/**\n * Select bound to the `paymentPeriod` field of {@link useChildSupportGarnishmentForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.PaymentPeriod`. Always rendered.\n * Options: `Every week`, `Every other week`, `Twice per month`, `Monthly`.\n *\n * @param props - {@link PaymentPeriodFieldProps} — accepts the standard hook field props plus `getOptionLabel` for payment-period display.\n * @returns The rendered select bound to `paymentPeriod`.\n * @public\n */\nexport function PaymentPeriodField(props: PaymentPeriodFieldProps) {\n  return <SelectHookField {...props} name=\"paymentPeriod\" />\n}\n"],"names":["StateField","props","jsx","SelectHookField","FipsCodeField","CaseNumberField","TextInputHookField","OrderNumberField","RemittanceNumberField","PayPeriodMaximumField","NumberInputHookField","AmountField","PaymentPeriodField"],"mappings":";;;;AAkHO,SAASA,EAAWC,GAAwB;AACjD,SAAO,gBAAAC,EAACC,GAAA,EAAiB,GAAGF,GAAO,MAAK,SAAQ;AAClD;AA4CO,SAASG,EAAcH,GAA2B;AACvD,SAAO,gBAAAC,EAACC,GAAA,EAAiB,GAAGF,GAAO,MAAK,YAAW;AACrD;AAuBO,SAASI,EAAgBJ,GAA6B;AAC3D,SAAO,gBAAAC,EAACI,GAAA,EAAoB,GAAGL,GAAO,MAAK,cAAa;AAC1D;AAqBO,SAASM,EAAiBN,GAA8B;AAC7D,SAAO,gBAAAC,EAACI,GAAA,EAAoB,GAAGL,GAAO,MAAK,eAAc;AAC3D;AAqBO,SAASO,EAAsBP,GAAmC;AACvE,SAAO,gBAAAC,EAACI,GAAA,EAAoB,GAAGL,GAAO,MAAK,oBAAmB;AAChE;AAwBO,SAASQ,EAAsBR,GAAmC;AACvE,SAAO,gBAAAC,EAACQ,GAAA,EAAsB,GAAGT,GAAO,MAAK,oBAAmB;AAClE;AAuBO,SAASU,EAAYV,GAAyB;AACnD,SAAO,gBAAAC,EAACQ,GAAA,EAAsB,GAAGT,GAAO,MAAK,UAAS;AACxD;AAwBO,SAASW,EAAmBX,GAAgC;AACjE,SAAO,gBAAAC,EAACC,GAAA,EAAiB,GAAGF,GAAO,MAAK,iBAAgB;AAC1D;"}

package/dist/components/Employee/Deductions/shared/useChildSupportGarnishmentForm/index.d.ts

@@ -1,4 +1,5 @@
 import "./types/i18next.d.ts"
-export { useChildSupportGarnishmentForm, type UseChildSupportGarnishmentFormProps, type UseChildSupportGarnishmentFormResult, type UseChildSupportGarnishmentFormReady, type ChildSupportGarnishmentFormFields, type ChildSupportGarnishmentFormFieldsMetadata, type ChildSupportGarnishmentFormFieldsType, } from './useChildSupportGarnishmentForm';
-export { createChildSupportGarnishmentFormSchema, ChildSupportGarnishmentFormErrorCodes, type ChildSupportGarnishmentFormErrorCode, type ChildSupportGarnishmentFormData, type ChildSupportGarnishmentFormOutputs, type ChildSupportGarnishmentFormField, type SupportedRequiredAttrKey, getRequiredAttrKeys, REQUIRED_ATTR_FIELD_NAME, SUPPORTED_REQUIRED_ATTR_KEYS, } from './childSupportGarnishmentFormSchema';
+export { useChildSupportGarnishmentForm, type UseChildSupportGarnishmentFormProps, type UseChildSupportGarnishmentFormResult, type UseChildSupportGarnishmentFormReady, type ChildSupportGarnishmentFormFields, type ChildSupportGarnishmentFormFieldsMetadata, } from './useChildSupportGarnishmentForm';
+export { createChildSupportGarnishmentFormSchema, ChildSupportGarnishmentFormErrorCodes, type ChildSupportGarnishmentFormErrorCode, type ChildSupportGarnishmentFormData, type ChildSupportGarnishmentFormOutputs, type SupportedRequiredAttrKey, getRequiredAttrKeys, SUPPORTED_REQUIRED_ATTR_KEYS, } from './childSupportGarnishmentFormSchema';
+export { StateField, FipsCodeField, CaseNumberField, OrderNumberField, RemittanceNumberField, PayPeriodMaximumField, AmountField, PaymentPeriodField, } from './fields';
 export type { RequiredValidation as ChildSupportGarnishmentRequiredValidation, NegativeAmountValidation as ChildSupportGarnishmentNegativeAmountValidation, PercentValidation as ChildSupportGarnishmentPercentValidation, PayPeriodMaximumValidation, AmountValidation as ChildSupportGarnishmentAmountValidation, StateFieldEntry, CountyEntry, StateFieldProps as ChildSupportGarnishmentStateFieldProps, FipsCodeFieldProps, CaseNumberFieldProps, OrderNumberFieldProps, RemittanceNumberFieldProps, PayPeriodMaximumFieldProps, AmountFieldProps as ChildSupportGarnishmentAmountFieldProps, PaymentPeriodFieldProps, } from './fields';

package/dist/components/Employee/Deductions/shared/useChildSupportGarnishmentForm/useChildSupportGarnishmentForm.d.ts

@@ -4,18 +4,43 @@ import { Agencies } from '@gusto/embedded-api-v-2025-11-15/models/components/chi
 import { ChildSupportGarnishmentFormData, SupportedRequiredAttrKey } from './childSupportGarnishmentFormSchema';
 import { StateField, FipsCodeField, CaseNumberField, OrderNumberField, RemittanceNumberField, PayPeriodMaximumField, AmountField, PaymentPeriodField, CountyEntry, StateFieldEntry } from './fields';
 import { BaseFormHookReady, FieldsMetadata, HookLoadingResult, HookSubmitResult } from '../../../../../partner-hook-utils/types';
+/**
+ * Configuration options for {@link useChildSupportGarnishmentForm}.
+ *
+ * @remarks
+ * Presence or absence of `garnishmentId` selects the API verb — see the
+ * `garnishmentId` field description.
+ *
+ * @public
+ */
 export interface UseChildSupportGarnishmentFormProps {
+    /** UUID of the employee whose child-support garnishment is being created or edited. */
     employeeId: string;
     /**
-     * When set, loads that garnishment via the list query and updates it (PUT).
-     * When omitted, the form is in create mode (POST).
+     * When set, loads that garnishment and updates it (PUT). When omitted, the
+     * form is in create mode (POST).
      */
     garnishmentId?: string;
+    /** Pre-fill form values. Server data takes precedence on update. */
     defaultValues?: Partial<ChildSupportGarnishmentFormData>;
+    /** Passed through to react-hook-form. Defaults to `'onSubmit'`. */
     validationMode?: UseFormProps['mode'];
+    /** Auto-focus the first invalid field on submit. Set to `false` when using `composeSubmitHandler` so submit-time focus is coordinated across multiple forms. Defaults to `true`. */
     shouldFocusError?: boolean;
 }
+/**
+ * Pre-bound field components exposed on `useChildSupportGarnishmentForm().form.Fields`.
+ *
+ * @remarks
+ * Each property is either the field component or `undefined`. A field is
+ * `undefined` when conditions for rendering it aren't met — see each member
+ * for its visibility rule. Always null-check conditional fields (e.g.
+ * `{Fields.FipsCode && <Fields.FipsCode ... />}`) before rendering.
+ *
+ * @public
+ */
 export interface ChildSupportGarnishmentFormFields {
+    /** Agency (state) select. Always available. */
     State: typeof StateField;
     /** Only available when the selected agency has more than one fips code, or the
      *  sole code is county-scoped (not an "all counties" auto-pick). */
@@ -26,11 +51,26 @@ export interface ChildSupportGarnishmentFormFields {
     OrderNumber: typeof OrderNumberField | undefined;
     /** Only available when the selected agency requires `remittance_number`. */
     RemittanceNumber: typeof RemittanceNumberField | undefined;
+    /** Per-pay-period currency cap input. Always available. */
     PayPeriodMaximum: typeof PayPeriodMaximumField;
+    /** Percent-of-paycheck input (0–100). Always available. */
     Amount: typeof AmountField;
+    /** Payment period select. Always available. */
     PaymentPeriod: typeof PaymentPeriodField;
 }
+/**
+ * Ready-state shape returned by {@link useChildSupportGarnishmentForm} once data has loaded.
+ *
+ * @remarks
+ * Discriminated by `isLoading: false`. Extends {@link BaseFormHookReady} with
+ * the child-support-specific `data`, `status`, `actions`, and `form.Fields`
+ * shape. Static, entity-derived values live under `data.*`; reactive values
+ * that flip with form input live under `status.*`.
+ *
+ * @public
+ */
 export interface UseChildSupportGarnishmentFormReady extends BaseFormHookReady<FieldsMetadata, ChildSupportGarnishmentFormData, ChildSupportGarnishmentFormFields> {
+    /** Child-support-specific data payload: the available agencies, counties for the selected state, and the loaded garnishment for update mode. */
     data: {
         /** Agencies offered as `State` options; raw entries the consumer can use
          *  with `getOptionLabel` for translated names. */
@@ -41,8 +81,11 @@ export interface UseChildSupportGarnishmentFormReady extends BaseFormHookReady<F
         /** The garnishment loaded for update; `null` in create mode. */
         deduction: Garnishment | null;
     };
+    /** Submission state and reactive flags derived from current form input. */
     status: {
+        /** `true` while a create or update mutation is in flight. */
         isPending: boolean;
+        /** Reflects whether the next submit will POST a new garnishment or PUT an existing one. */
         mode: 'create' | 'update';
         /** The agency record matching the currently selected `state`. */
         selectedAgency: Agencies | null;
@@ -52,11 +95,94 @@ export interface UseChildSupportGarnishmentFormReady extends BaseFormHookReady<F
         /** Which `required_attributes` keys the selected agency declares. */
         requiredAttrKeys: ReadonlySet<SupportedRequiredAttrKey>;
     };
+    /** Submission action. */
     actions: {
+        /** Submits the form. Returns the saved garnishment + mode on success, or `undefined` when validation fails or the request errored. */
         onSubmit: () => Promise<HookSubmitResult<Garnishment> | undefined>;
     };
 }
+/**
+ * Return value of {@link useChildSupportGarnishmentForm}.
+ *
+ * @remarks
+ * Discriminated union: {@link HookLoadingResult} while the agency catalog (and,
+ * in update mode, the existing garnishment) is loading;
+ * {@link UseChildSupportGarnishmentFormReady} once data is ready.
+ *
+ * @public
+ */
 export type UseChildSupportGarnishmentFormResult = HookLoadingResult | UseChildSupportGarnishmentFormReady;
+/**
+ * Headless hook for creating or updating a child-support garnishment.
+ *
+ * @remarks
+ * Unlike standard garnishments, child support requires agency-specific
+ * attributes (case number, order number, remittance number) that vary by
+ * state, plus an optional county selection when the state has multiple
+ * counties. The hook loads the agency catalog from the Gusto API, derives
+ * which attributes the selected state requires, and exposes the right Fields
+ * conditionally.
+ *
+ * Presence or absence of `garnishmentId` selects the API verb: omit it to
+ * POST a new garnishment, supply it to PUT updates against the existing row.
+ * For non-child-support deductions (court-ordered garnishments and post-tax
+ * custom), use {@link useDeductionForm} instead.
+ *
+ * @param input - See {@link UseChildSupportGarnishmentFormProps}.
+ * @returns A {@link HookLoadingResult} while loading, or a {@link UseChildSupportGarnishmentFormReady} once ready.
+ * @public
+ *
+ * @example
+ * ```tsx
+ * import { useChildSupportGarnishmentForm, SDKFormProvider } from '@gusto/embedded-react-sdk'
+ *
+ * function ChildSupportPage({ employeeId, garnishmentId }: { employeeId: string; garnishmentId?: string }) {
+ *   const form = useChildSupportGarnishmentForm({ employeeId, garnishmentId })
+ *
+ *   if (form.isLoading) return <p>Loading…</p>
+ *
+ *   const { Fields } = form.form
+ *
+ *   return (
+ *     <SDKFormProvider formHookResult={form}>
+ *       <form
+ *         onSubmit={e => {
+ *           e.preventDefault()
+ *           void form.actions.onSubmit()
+ *         }}
+ *       >
+ *         <Fields.State
+ *           label="Agency"
+ *           getOptionLabel={entry => entry.name}
+ *           validationMessages={{ REQUIRED: 'Required' }}
+ *         />
+ *         {Fields.CaseNumber && (
+ *           <Fields.CaseNumber label="Case number" validationMessages={{ REQUIRED: 'Required' }} />
+ *         )}
+ *         <Fields.Amount
+ *           label="Percentage of paycheck"
+ *           validationMessages={{
+ *             REQUIRED: 'Required',
+ *             PERCENT_OUT_OF_RANGE: 'Must be between 0 and 100',
+ *           }}
+ *         />
+ *         <button type="submit">Save</button>
+ *       </form>
+ *     </SDKFormProvider>
+ *   )
+ * }
+ * ```
+ */
 export declare function useChildSupportGarnishmentForm({ employeeId, garnishmentId, defaultValues: partnerDefaults, validationMode, shouldFocusError, }: UseChildSupportGarnishmentFormProps): UseChildSupportGarnishmentFormResult;
+/**
+ * Per-field metadata returned by {@link useChildSupportGarnishmentForm} as `form.fieldsMetadata`.
+ *
+ * @remarks
+ * Carries per-field `isRequired`, `isDisabled`, label, description, and option
+ * entries derived from the schema and form state. Use these to drive UI such
+ * as disabled state or option lists when not relying on the pre-bound
+ * {@link ChildSupportGarnishmentFormFields} components.
+ *
+ * @public
+ */
 export type ChildSupportGarnishmentFormFieldsMetadata = UseChildSupportGarnishmentFormReady['form']['fieldsMetadata'];
-export type ChildSupportGarnishmentFormFieldsType = UseChildSupportGarnishmentFormReady['form']['Fields'];