@gusto/embedded-react-sdk 0.47.0 → 0.48.0

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

@@ -5,21 +5,179 @@ import { NumberInputHookFieldProps } from '../../../../../partner-hook-utils/for
 import { RadioGroupHookFieldProps } from '../../../../../partner-hook-utils/form/fields/RadioGroupHookField';
 import { SelectHookFieldProps } from '../../../../../partner-hook-utils/form/fields/SelectHookField';
 import { HookFieldProps } from '../../../../../partner-hook-utils/types';
+/**
+ * The required-field error code produced by {@link useDeductionForm} fields that only emit `REQUIRED`.
+ *
+ * @remarks
+ * Used as the `validationMessages` key for the description, recurring,
+ * deduct-as-percentage, and garnishment-type fields. See
+ * {@link DeductionFormErrorCodes}.
+ *
+ * @public
+ */
 export type RequiredValidation = typeof DeductionFormErrorCodes.REQUIRED;
+/**
+ * The negative-amount error code produced by {@link useDeductionForm}'s currency fields.
+ *
+ * @remarks
+ * Used as a `validationMessages` key on `Fields.Amount`, `Fields.TotalAmount`,
+ * and `Fields.AnnualMaximum`. See {@link DeductionFormErrorCodes}.
+ *
+ * @public
+ */
 export type NegativeAmountValidation = typeof DeductionFormErrorCodes.NEGATIVE_AMOUNT;
+/**
+ * Validation error codes emitted by the `amount` field of {@link useDeductionForm}.
+ *
+ * @remarks
+ * Use these as keys in `validationMessages` on `Fields.Amount`. See
+ * {@link DeductionFormErrorCodes} for the full description of each code.
+ *
+ * @public
+ */
 export type AmountValidation = RequiredValidation | NegativeAmountValidation;
+/**
+ * Validation error codes emitted by the cap fields of {@link useDeductionForm} (`totalAmount`, `annualMaximum`).
+ *
+ * @remarks
+ * Use these as keys in `validationMessages` on `Fields.TotalAmount` and
+ * `Fields.AnnualMaximum`. See {@link DeductionFormErrorCodes} for the full
+ * description of each code.
+ *
+ * @public
+ */
 export type CapValidation = NegativeAmountValidation;
+/**
+ * Props accepted by {@link useDeductionForm}'s `Fields.Description` component.
+ *
+ * @public
+ */
 export type DescriptionFieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>;
+/**
+ * Text input bound to the `description` field of {@link useDeductionForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.Description`. Always rendered.
+ *
+ * @param props - {@link DescriptionFieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).
+ * @returns The rendered text input bound to `description`.
+ * @public
+ */
 export declare function DescriptionField(props: DescriptionFieldProps): import("react").JSX.Element;
+/**
+ * Props accepted by {@link useDeductionForm}'s `Fields.Recurring` component.
+ *
+ * @public
+ */
 export type RecurringFieldProps = HookFieldProps<RadioGroupHookFieldProps<RequiredValidation, boolean>>;
+/**
+ * Radio group bound to the `recurring` field of {@link useDeductionForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.Recurring`. Always rendered.
+ * Picks between a recurring deduction (taken every paycheck) and a one-time
+ * deduction. The cap fields (`Fields.TotalAmount` and `Fields.AnnualMaximum`)
+ * are exposed only when this is set to recurring.
+ *
+ * @param props - {@link RecurringFieldProps} — accepts the standard hook field props plus `getOptionLabel` for boolean display.
+ * @returns The rendered radio group bound to `recurring`.
+ * @public
+ */
 export declare function RecurringField(props: RecurringFieldProps): import("react").JSX.Element;
+/**
+ * Props accepted by {@link useDeductionForm}'s `Fields.DeductAsPercentage` component.
+ *
+ * @public
+ */
 export type DeductAsPercentageFieldProps = HookFieldProps<RadioGroupHookFieldProps<RequiredValidation, boolean>>;
+/**
+ * Radio group bound to the `deductAsPercentage` field of {@link useDeductionForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.DeductAsPercentage`. Always
+ * rendered. Toggles how `Fields.Amount` is interpreted — as a fixed currency
+ * amount when `false`, or as a percentage of paycheck when `true`.
+ *
+ * @param props - {@link DeductAsPercentageFieldProps} — accepts the standard hook field props plus `getOptionLabel` for boolean display.
+ * @returns The rendered radio group bound to `deductAsPercentage`.
+ * @public
+ */
 export declare function DeductAsPercentageField(props: DeductAsPercentageFieldProps): import("react").JSX.Element;
+/**
+ * Props accepted by {@link useDeductionForm}'s `Fields.Amount` component.
+ *
+ * @public
+ */
 export type AmountFieldProps = HookFieldProps<NumberInputHookFieldProps<AmountValidation>>;
+/**
+ * Number input bound to the `amount` field of {@link useDeductionForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.Amount`. Always rendered.
+ * Interpreted as a currency amount when `Fields.DeductAsPercentage` is set to
+ * a fixed amount, or as a percentage of paycheck when it's set to percentage.
+ *
+ * @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 useDeductionForm}'s `Fields.TotalAmount` component.
+ *
+ * @public
+ */
 export type TotalAmountFieldProps = HookFieldProps<NumberInputHookFieldProps<CapValidation>>;
+/**
+ * Number input bound to the `totalAmount` field of {@link useDeductionForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.TotalAmount` only when
+ * `status.isRecurring` is `true`. A zero value means "no cap" — the hook
+ * drops it on the wire. Always null-check before rendering.
+ *
+ * @param props - {@link TotalAmountFieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).
+ * @returns The rendered number input bound to `totalAmount`.
+ * @public
+ */
 export declare function TotalAmountField(props: TotalAmountFieldProps): import("react").JSX.Element;
+/**
+ * Props accepted by {@link useDeductionForm}'s `Fields.AnnualMaximum` component.
+ *
+ * @public
+ */
 export type AnnualMaximumFieldProps = HookFieldProps<NumberInputHookFieldProps<CapValidation>>;
+/**
+ * Number input bound to the `annualMaximum` field of {@link useDeductionForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.AnnualMaximum` only when
+ * `status.isRecurring` is `true`. A zero value means "no cap" — the hook
+ * drops it on the wire. Always null-check before rendering.
+ *
+ * @param props - {@link AnnualMaximumFieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).
+ * @returns The rendered number input bound to `annualMaximum`.
+ * @public
+ */
 export declare function AnnualMaximumField(props: AnnualMaximumFieldProps): import("react").JSX.Element;
+/**
+ * Props accepted by {@link useDeductionForm}'s `Fields.GarnishmentType` component.
+ *
+ * @public
+ */
 export type GarnishmentTypeFieldProps = HookFieldProps<SelectHookFieldProps<RequiredValidation, GarnishmentType>>;
+/**
+ * Select bound to the `garnishmentType` field of {@link useDeductionForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.GarnishmentType` only when the
+ * hook is constructed with `courtOrdered: true`. Always null-check before
+ * rendering. Options: `Federal Tax Lien`, `State Tax Lien`, `Student Loan`,
+ * `Creditor Garnishment`, `Federal Loan`, `Other Garnishment`. For
+ * child-support garnishments, use {@link useChildSupportGarnishmentForm}.
+ *
+ * @param props - {@link GarnishmentTypeFieldProps} — accepts the standard hook field props plus `getOptionLabel` for garnishment-type display.
+ * @returns The rendered select bound to `garnishmentType`.
+ * @public
+ */
 export declare function GarnishmentTypeField(props: GarnishmentTypeFieldProps): import("react").JSX.Element;

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

@@ -1,10 +1,10 @@
 import { jsx as e } from "react/jsx-runtime";
-import { SelectHookField as o } from "../../../../../partner-hook-utils/form/fields/SelectHookField.js";
 import { NumberInputHookField as t } from "../../../../../partner-hook-utils/form/fields/NumberInputHookField.js";
 import { RadioGroupHookField as r } from "../../../../../partner-hook-utils/form/fields/RadioGroupHookField.js";
-import { TextInputHookField as i } from "../../../../../partner-hook-utils/form/fields/TextInputHookField.js";
+import { TextInputHookField as o } from "../../../../../partner-hook-utils/form/fields/TextInputHookField.js";
+import { SelectHookField as i } from "../../../../../partner-hook-utils/form/fields/SelectHookField.js";
 function l(n) {
-  return /* @__PURE__ */ e(i, { ...n, name: "description" });
+  return /* @__PURE__ */ e(o, { ...n, name: "description" });
 }
 function p(n) {
   return /* @__PURE__ */ e(r, { ...n, name: "recurring" });
@@ -22,7 +22,7 @@ function A(n) {
   return /* @__PURE__ */ e(t, { ...n, name: "annualMaximum" });
 }
 function g(n) {
-  return /* @__PURE__ */ e(o, { ...n, name: "garnishmentType" });
+  return /* @__PURE__ */ e(i, { ...n, name: "garnishmentType" });
 }
 export {
   F as AmountField,

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

@@ -1 +1 @@
-{"version":3,"file":"fields.js","sources":["../../../../../../src/components/Employee/Deductions/shared/useDeductionForm/fields.tsx"],"sourcesContent":["import type { GarnishmentType } from '@gusto/embedded-api-v-2025-11-15/models/components/garnishment'\nimport type { DeductionFormErrorCodes } from './deductionFormSchema'\nimport type { TextInputHookFieldProps } from '@/partner-hook-utils/form/fields/TextInputHookField'\nimport type { NumberInputHookFieldProps } from '@/partner-hook-utils/form/fields/NumberInputHookField'\nimport type { RadioGroupHookFieldProps } from '@/partner-hook-utils/form/fields/RadioGroupHookField'\nimport type { SelectHookFieldProps } from '@/partner-hook-utils/form/fields/SelectHookField'\nimport {\n  TextInputHookField,\n  NumberInputHookField,\n  RadioGroupHookField,\n  SelectHookField,\n} from '@/partner-hook-utils/form/fields'\nimport type { HookFieldProps } from '@/partner-hook-utils/types'\n\nexport type RequiredValidation = typeof DeductionFormErrorCodes.REQUIRED\nexport type NegativeAmountValidation = typeof DeductionFormErrorCodes.NEGATIVE_AMOUNT\n\nexport type AmountValidation = RequiredValidation | NegativeAmountValidation\nexport type CapValidation = NegativeAmountValidation\n\n// ── Description ────────────────────────────────────────────────────────\n\nexport type DescriptionFieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>\n\nexport function DescriptionField(props: DescriptionFieldProps) {\n  return <TextInputHookField {...props} name=\"description\" />\n}\n\n// ── Recurring (radio: boolean) ─────────────────────────────────────────\n\nexport type RecurringFieldProps = HookFieldProps<\n  RadioGroupHookFieldProps<RequiredValidation, boolean>\n>\n\nexport function RecurringField(props: RecurringFieldProps) {\n  return <RadioGroupHookField {...props} name=\"recurring\" />\n}\n\n// ── DeductAsPercentage (radio: boolean) ────────────────────────────────\n\nexport type DeductAsPercentageFieldProps = HookFieldProps<\n  RadioGroupHookFieldProps<RequiredValidation, boolean>\n>\n\nexport function DeductAsPercentageField(props: DeductAsPercentageFieldProps) {\n  return <RadioGroupHookField {...props} name=\"deductAsPercentage\" />\n}\n\n// ── Amount (currency or percent depending on deductAsPercentage) ───────\n\nexport type AmountFieldProps = HookFieldProps<NumberInputHookFieldProps<AmountValidation>>\n\nexport function AmountField(props: AmountFieldProps) {\n  return <NumberInputHookField {...props} name=\"amount\" />\n}\n\n// ── TotalAmount (optional cap — only meaningful when recurring) ────────\n\nexport type TotalAmountFieldProps = HookFieldProps<NumberInputHookFieldProps<CapValidation>>\n\nexport function TotalAmountField(props: TotalAmountFieldProps) {\n  return <NumberInputHookField {...props} name=\"totalAmount\" />\n}\n\n// ── AnnualMaximum (optional annual cap — only meaningful when recurring) ─\n\nexport type AnnualMaximumFieldProps = HookFieldProps<NumberInputHookFieldProps<CapValidation>>\n\nexport function AnnualMaximumField(props: AnnualMaximumFieldProps) {\n  return <NumberInputHookField {...props} name=\"annualMaximum\" />\n}\n\n// ── GarnishmentType (court-ordered only) ───────────────────────────────\n\nexport type GarnishmentTypeFieldProps = HookFieldProps<\n  SelectHookFieldProps<RequiredValidation, GarnishmentType>\n>\n\nexport function GarnishmentTypeField(props: GarnishmentTypeFieldProps) {\n  return <SelectHookField {...props} name=\"garnishmentType\" />\n}\n"],"names":["DescriptionField","props","jsx","TextInputHookField","RecurringField","RadioGroupHookField","DeductAsPercentageField","AmountField","NumberInputHookField","TotalAmountField","AnnualMaximumField","GarnishmentTypeField","SelectHookField"],"mappings":";;;;;AAwBO,SAASA,EAAiBC,GAA8B;AAC7D,SAAO,gBAAAC,EAACC,GAAA,EAAoB,GAAGF,GAAO,MAAK,eAAc;AAC3D;AAQO,SAASG,EAAeH,GAA4B;AACzD,SAAO,gBAAAC,EAACG,GAAA,EAAqB,GAAGJ,GAAO,MAAK,aAAY;AAC1D;AAQO,SAASK,EAAwBL,GAAqC;AAC3E,SAAO,gBAAAC,EAACG,GAAA,EAAqB,GAAGJ,GAAO,MAAK,sBAAqB;AACnE;AAMO,SAASM,EAAYN,GAAyB;AACnD,SAAO,gBAAAC,EAACM,GAAA,EAAsB,GAAGP,GAAO,MAAK,UAAS;AACxD;AAMO,SAASQ,EAAiBR,GAA8B;AAC7D,SAAO,gBAAAC,EAACM,GAAA,EAAsB,GAAGP,GAAO,MAAK,eAAc;AAC7D;AAMO,SAASS,EAAmBT,GAAgC;AACjE,SAAO,gBAAAC,EAACM,GAAA,EAAsB,GAAGP,GAAO,MAAK,iBAAgB;AAC/D;AAQO,SAASU,EAAqBV,GAAkC;AACrE,SAAO,gBAAAC,EAACU,GAAA,EAAiB,GAAGX,GAAO,MAAK,mBAAkB;AAC5D;"}
+{"version":3,"file":"fields.js","sources":["../../../../../../src/components/Employee/Deductions/shared/useDeductionForm/fields.tsx"],"sourcesContent":["import type { GarnishmentType } from '@gusto/embedded-api-v-2025-11-15/models/components/garnishment'\nimport type { DeductionFormErrorCodes } from './deductionFormSchema'\nimport type { TextInputHookFieldProps } from '@/partner-hook-utils/form/fields/TextInputHookField'\nimport type { NumberInputHookFieldProps } from '@/partner-hook-utils/form/fields/NumberInputHookField'\nimport type { RadioGroupHookFieldProps } from '@/partner-hook-utils/form/fields/RadioGroupHookField'\nimport type { SelectHookFieldProps } from '@/partner-hook-utils/form/fields/SelectHookField'\nimport {\n  TextInputHookField,\n  NumberInputHookField,\n  RadioGroupHookField,\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 useDeductionForm} fields that only emit `REQUIRED`.\n *\n * @remarks\n * Used as the `validationMessages` key for the description, recurring,\n * deduct-as-percentage, and garnishment-type fields. See\n * {@link DeductionFormErrorCodes}.\n *\n * @public\n */\nexport type RequiredValidation = typeof DeductionFormErrorCodes.REQUIRED\n\n/**\n * The negative-amount error code produced by {@link useDeductionForm}'s currency fields.\n *\n * @remarks\n * Used as a `validationMessages` key on `Fields.Amount`, `Fields.TotalAmount`,\n * and `Fields.AnnualMaximum`. See {@link DeductionFormErrorCodes}.\n *\n * @public\n */\nexport type NegativeAmountValidation = typeof DeductionFormErrorCodes.NEGATIVE_AMOUNT\n\n/**\n * Validation error codes emitted by the `amount` field of {@link useDeductionForm}.\n *\n * @remarks\n * Use these as keys in `validationMessages` on `Fields.Amount`. See\n * {@link DeductionFormErrorCodes} for the full description of each code.\n *\n * @public\n */\nexport type AmountValidation = RequiredValidation | NegativeAmountValidation\n\n/**\n * Validation error codes emitted by the cap fields of {@link useDeductionForm} (`totalAmount`, `annualMaximum`).\n *\n * @remarks\n * Use these as keys in `validationMessages` on `Fields.TotalAmount` and\n * `Fields.AnnualMaximum`. See {@link DeductionFormErrorCodes} for the full\n * description of each code.\n *\n * @public\n */\nexport type CapValidation = NegativeAmountValidation\n\n// ── Description ────────────────────────────────────────────────────────\n\n/**\n * Props accepted by {@link useDeductionForm}'s `Fields.Description` component.\n *\n * @public\n */\nexport type DescriptionFieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>\n\n/**\n * Text input bound to the `description` field of {@link useDeductionForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.Description`. Always rendered.\n *\n * @param props - {@link DescriptionFieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).\n * @returns The rendered text input bound to `description`.\n * @public\n */\nexport function DescriptionField(props: DescriptionFieldProps) {\n  return <TextInputHookField {...props} name=\"description\" />\n}\n\n// ── Recurring (radio: boolean) ─────────────────────────────────────────\n\n/**\n * Props accepted by {@link useDeductionForm}'s `Fields.Recurring` component.\n *\n * @public\n */\nexport type RecurringFieldProps = HookFieldProps<\n  RadioGroupHookFieldProps<RequiredValidation, boolean>\n>\n\n/**\n * Radio group bound to the `recurring` field of {@link useDeductionForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.Recurring`. Always rendered.\n * Picks between a recurring deduction (taken every paycheck) and a one-time\n * deduction. The cap fields (`Fields.TotalAmount` and `Fields.AnnualMaximum`)\n * are exposed only when this is set to recurring.\n *\n * @param props - {@link RecurringFieldProps} — accepts the standard hook field props plus `getOptionLabel` for boolean display.\n * @returns The rendered radio group bound to `recurring`.\n * @public\n */\nexport function RecurringField(props: RecurringFieldProps) {\n  return <RadioGroupHookField {...props} name=\"recurring\" />\n}\n\n// ── DeductAsPercentage (radio: boolean) ────────────────────────────────\n\n/**\n * Props accepted by {@link useDeductionForm}'s `Fields.DeductAsPercentage` component.\n *\n * @public\n */\nexport type DeductAsPercentageFieldProps = HookFieldProps<\n  RadioGroupHookFieldProps<RequiredValidation, boolean>\n>\n\n/**\n * Radio group bound to the `deductAsPercentage` field of {@link useDeductionForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.DeductAsPercentage`. Always\n * rendered. Toggles how `Fields.Amount` is interpreted — as a fixed currency\n * amount when `false`, or as a percentage of paycheck when `true`.\n *\n * @param props - {@link DeductAsPercentageFieldProps} — accepts the standard hook field props plus `getOptionLabel` for boolean display.\n * @returns The rendered radio group bound to `deductAsPercentage`.\n * @public\n */\nexport function DeductAsPercentageField(props: DeductAsPercentageFieldProps) {\n  return <RadioGroupHookField {...props} name=\"deductAsPercentage\" />\n}\n\n// ── Amount (currency or percent depending on deductAsPercentage) ───────\n\n/**\n * Props accepted by {@link useDeductionForm}'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 useDeductionForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.Amount`. Always rendered.\n * Interpreted as a currency amount when `Fields.DeductAsPercentage` is set to\n * a fixed amount, or as a percentage of paycheck when it's set to percentage.\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// ── TotalAmount (optional cap — only meaningful when recurring) ────────\n\n/**\n * Props accepted by {@link useDeductionForm}'s `Fields.TotalAmount` component.\n *\n * @public\n */\nexport type TotalAmountFieldProps = HookFieldProps<NumberInputHookFieldProps<CapValidation>>\n\n/**\n * Number input bound to the `totalAmount` field of {@link useDeductionForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.TotalAmount` only when\n * `status.isRecurring` is `true`. A zero value means \"no cap\" — the hook\n * drops it on the wire. Always null-check before rendering.\n *\n * @param props - {@link TotalAmountFieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).\n * @returns The rendered number input bound to `totalAmount`.\n * @public\n */\nexport function TotalAmountField(props: TotalAmountFieldProps) {\n  return <NumberInputHookField {...props} name=\"totalAmount\" />\n}\n\n// ── AnnualMaximum (optional annual cap — only meaningful when recurring) ─\n\n/**\n * Props accepted by {@link useDeductionForm}'s `Fields.AnnualMaximum` component.\n *\n * @public\n */\nexport type AnnualMaximumFieldProps = HookFieldProps<NumberInputHookFieldProps<CapValidation>>\n\n/**\n * Number input bound to the `annualMaximum` field of {@link useDeductionForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.AnnualMaximum` only when\n * `status.isRecurring` is `true`. A zero value means \"no cap\" — the hook\n * drops it on the wire. Always null-check before rendering.\n *\n * @param props - {@link AnnualMaximumFieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).\n * @returns The rendered number input bound to `annualMaximum`.\n * @public\n */\nexport function AnnualMaximumField(props: AnnualMaximumFieldProps) {\n  return <NumberInputHookField {...props} name=\"annualMaximum\" />\n}\n\n// ── GarnishmentType (court-ordered only) ───────────────────────────────\n\n/**\n * Props accepted by {@link useDeductionForm}'s `Fields.GarnishmentType` component.\n *\n * @public\n */\nexport type GarnishmentTypeFieldProps = HookFieldProps<\n  SelectHookFieldProps<RequiredValidation, GarnishmentType>\n>\n\n/**\n * Select bound to the `garnishmentType` field of {@link useDeductionForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.GarnishmentType` only when the\n * hook is constructed with `courtOrdered: true`. Always null-check before\n * rendering. Options: `Federal Tax Lien`, `State Tax Lien`, `Student Loan`,\n * `Creditor Garnishment`, `Federal Loan`, `Other Garnishment`. For\n * child-support garnishments, use {@link useChildSupportGarnishmentForm}.\n *\n * @param props - {@link GarnishmentTypeFieldProps} — accepts the standard hook field props plus `getOptionLabel` for garnishment-type display.\n * @returns The rendered select bound to `garnishmentType`.\n * @public\n */\nexport function GarnishmentTypeField(props: GarnishmentTypeFieldProps) {\n  return <SelectHookField {...props} name=\"garnishmentType\" />\n}\n"],"names":["DescriptionField","props","jsx","TextInputHookField","RecurringField","RadioGroupHookField","DeductAsPercentageField","AmountField","NumberInputHookField","TotalAmountField","AnnualMaximumField","GarnishmentTypeField","SelectHookField"],"mappings":";;;;;AA+EO,SAASA,EAAiBC,GAA8B;AAC7D,SAAO,gBAAAC,EAACC,GAAA,EAAoB,GAAGF,GAAO,MAAK,eAAc;AAC3D;AA0BO,SAASG,EAAeH,GAA4B;AACzD,SAAO,gBAAAC,EAACG,GAAA,EAAqB,GAAGJ,GAAO,MAAK,aAAY;AAC1D;AAyBO,SAASK,EAAwBL,GAAqC;AAC3E,SAAO,gBAAAC,EAACG,GAAA,EAAqB,GAAGJ,GAAO,MAAK,sBAAqB;AACnE;AAuBO,SAASM,EAAYN,GAAyB;AACnD,SAAO,gBAAAC,EAACM,GAAA,EAAsB,GAAGP,GAAO,MAAK,UAAS;AACxD;AAuBO,SAASQ,EAAiBR,GAA8B;AAC7D,SAAO,gBAAAC,EAACM,GAAA,EAAsB,GAAGP,GAAO,MAAK,eAAc;AAC7D;AAuBO,SAASS,EAAmBT,GAAgC;AACjE,SAAO,gBAAAC,EAACM,GAAA,EAAsB,GAAGP,GAAO,MAAK,iBAAgB;AAC/D;AA2BO,SAASU,EAAqBV,GAAkC;AACrE,SAAO,gBAAAC,EAACU,GAAA,EAAiB,GAAGX,GAAO,MAAK,mBAAkB;AAC5D;"}

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

@@ -1,4 +1,5 @@
 import "./types/i18next.d.ts"
-export { useDeductionForm, type UseDeductionFormProps, type UseDeductionFormResult, type UseDeductionFormReady, type DeductionFormFields, type DeductionFormFieldsMetadata, type DeductionFormFieldsType, type DeductionFormOptionalFieldsToRequire, } from './useDeductionForm';
-export { createDeductionFormSchema, DeductionFormErrorCodes, type DeductionFormErrorCode, type DeductionFormData, type DeductionFormOutputs, type DeductionFormField, } from './deductionFormSchema';
+export { useDeductionForm, type UseDeductionFormProps, type UseDeductionFormResult, type UseDeductionFormReady, type DeductionFormFields, type DeductionFormFieldsMetadata, type DeductionFormOptionalFieldsToRequire, } from './useDeductionForm';
+export { createDeductionFormSchema, DeductionFormErrorCodes, type DeductionFormErrorCode, type DeductionFormData, type DeductionFormOutputs, } from './deductionFormSchema';
+export { DescriptionField, RecurringField, DeductAsPercentageField, AmountField, TotalAmountField, AnnualMaximumField, GarnishmentTypeField, } from './fields';
 export type { RequiredValidation as DeductionFormRequiredValidation, NegativeAmountValidation as DeductionFormNegativeAmountValidation, AmountValidation as DeductionFormAmountValidation, CapValidation as DeductionFormCapValidation, DescriptionFieldProps, RecurringFieldProps, DeductAsPercentageFieldProps, AmountFieldProps, TotalAmountFieldProps, AnnualMaximumFieldProps, GarnishmentTypeFieldProps, } from './fields';

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

@@ -4,11 +4,22 @@ import { DeductionFormData, DeductionFormOptionalFieldsToRequire } from './deduc
 import { DescriptionField, RecurringField, DeductAsPercentageField, AmountField, TotalAmountField, AnnualMaximumField, GarnishmentTypeField } from './fields';
 import { BaseFormHookReady, FieldsMetadata, HookLoadingResult, HookSubmitResult } from '../../../../../partner-hook-utils/types';
 export type { DeductionFormOptionalFieldsToRequire } from './deductionFormSchema';
+/**
+ * Configuration options for {@link useDeductionForm}.
+ *
+ * @remarks
+ * Presence or absence of `garnishmentId` selects the API verb — see the
+ * `garnishmentId` field description. `courtOrdered` selects between the
+ * post-tax custom variant and the court-ordered garnishment variant.
+ *
+ * @public
+ */
 export interface UseDeductionFormProps {
+    /** UUID of the employee whose deduction 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;
     /**
@@ -18,18 +29,37 @@ export interface UseDeductionFormProps {
      * `garnishmentType` is excluded from the schema and submit payload.
      *
      * Note: this hook does NOT handle `garnishmentType: 'child_support'`. Use
-     * `useChildSupportGarnishmentForm` for child-support agency-keyed payloads.
+     * {@link useChildSupportGarnishmentForm} for child-support agency-keyed payloads.
      */
     courtOrdered: boolean;
+    /** Override fields that are optional on a given mode to be required. See {@link DeductionFormOptionalFieldsToRequire}. */
     optionalFieldsToRequire?: DeductionFormOptionalFieldsToRequire;
+    /** Pre-fill form values. Server data takes precedence on update. */
     defaultValues?: Partial<DeductionFormData>;
+    /** 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 `useDeductionForm().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.TotalAmount && <Fields.TotalAmount ... />}`) before rendering.
+ *
+ * @public
+ */
 export interface DeductionFormFields {
+    /** Description text input. Always available. */
     Description: typeof DescriptionField;
+    /** Recurring vs one-time radio group. Always available. */
     Recurring: typeof RecurringField;
+    /** Fixed-amount vs percentage radio group. Always available. */
     DeductAsPercentage: typeof DeductAsPercentageField;
+    /** Deduction amount input. Always available. */
     Amount: typeof AmountField;
     /** Only available when `status.isRecurring` is true. */
     TotalAmount: typeof TotalAmountField | undefined;
@@ -38,13 +68,28 @@ export interface DeductionFormFields {
     /** Only available when `courtOrdered: true`. */
     GarnishmentType: typeof GarnishmentTypeField | undefined;
 }
+/**
+ * Ready-state shape returned by {@link useDeductionForm} once data has loaded.
+ *
+ * @remarks
+ * Discriminated by `isLoading: false`. Extends {@link BaseFormHookReady} with
+ * the deduction-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 UseDeductionFormReady extends BaseFormHookReady<FieldsMetadata, DeductionFormData, DeductionFormFields> {
+    /** Deduction-specific data payload: the loaded garnishment for update mode, or `null` in create mode. */
     data: {
         /** 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 deduction or PUT an existing one. */
         mode: 'create' | 'update';
         /**
          * Mirrors the watched `recurring` value. Cap fields (`TotalAmount`,
@@ -54,11 +99,93 @@ export interface UseDeductionFormReady extends BaseFormHookReady<FieldsMetadata,
          */
         isRecurring: boolean;
     };
+    /** 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 useDeductionForm}.
+ *
+ * @remarks
+ * Discriminated union: {@link HookLoadingResult} while the existing garnishment
+ * is loading (update mode only); {@link UseDeductionFormReady} once data is
+ * ready. In create mode the hook returns the ready branch immediately.
+ *
+ * @public
+ */
 export type UseDeductionFormResult = HookLoadingResult | UseDeductionFormReady;
+/**
+ * Headless hook for creating or updating a non-child-support deduction.
+ *
+ * @remarks
+ * Both variants — post-tax custom deductions and court-ordered garnishments —
+ * share the same field set (description, frequency, deduct-as-percentage,
+ * amount, optional caps) and differ only in whether the deduction is
+ * court-ordered and carries a `garnishmentType`. Set `courtOrdered: true` to
+ * surface the garnishment-type select; set it to `false` for a custom post-tax
+ * deduction.
+ *
+ * Presence or absence of `garnishmentId` selects the API verb: omit it to POST
+ * a new deduction, supply it to PUT updates against the existing row. For
+ * child-support garnishments, use {@link useChildSupportGarnishmentForm}
+ * instead — those require agency-keyed required attributes (case number,
+ * order number, remittance number, county) that this hook doesn't model.
+ *
+ * @param input - See {@link UseDeductionFormProps}.
+ * @returns A {@link HookLoadingResult} while loading, or a {@link UseDeductionFormReady} once ready.
+ * @public
+ *
+ * @example
+ * ```tsx
+ * import { useDeductionForm, SDKFormProvider } from '@gusto/embedded-react-sdk'
+ *
+ * function CustomDeductionPage({ employeeId, garnishmentId }: { employeeId: string; garnishmentId?: string }) {
+ *   const form = useDeductionForm({ employeeId, garnishmentId, courtOrdered: false })
+ *
+ *   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.Description label="Description" validationMessages={{ REQUIRED: 'Required' }} />
+ *         <Fields.Recurring
+ *           label="Frequency"
+ *           getOptionLabel={v => (v ? 'Recurring' : 'One-time')}
+ *           validationMessages={{ REQUIRED: 'Required' }}
+ *         />
+ *         <Fields.Amount
+ *           label="Amount"
+ *           validationMessages={{ REQUIRED: 'Required', NEGATIVE_AMOUNT: 'Must be ≥ 0' }}
+ *         />
+ *         {Fields.TotalAmount && (
+ *           <Fields.TotalAmount label="Total cap" validationMessages={{ NEGATIVE_AMOUNT: 'Must be ≥ 0' }} />
+ *         )}
+ *         <button type="submit">Save</button>
+ *       </form>
+ *     </SDKFormProvider>
+ *   )
+ * }
+ * ```
+ */
 export declare function useDeductionForm({ employeeId, garnishmentId, courtOrdered, optionalFieldsToRequire, defaultValues: partnerDefaults, validationMode, shouldFocusError, }: UseDeductionFormProps): UseDeductionFormResult;
+/**
+ * Per-field metadata returned by {@link useDeductionForm} 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 DeductionFormFields} components.
+ *
+ * @public
+ */
 export type DeductionFormFieldsMetadata = UseDeductionFormReady['form']['fieldsMetadata'];
-export type DeductionFormFieldsType = UseDeductionFormReady['form']['Fields'];

package/dist/components/Employee/Deductions/shared/useDeductionForm/useDeductionForm.js.map

@@ -1 +1 @@
-{"version":3,"file":"useDeductionForm.js","sources":["../../../../../../src/components/Employee/Deductions/shared/useDeductionForm/useDeductionForm.tsx"],"sourcesContent":["import { useMemo } from 'react'\nimport { useForm, useWatch } from 'react-hook-form'\nimport type { UseFormProps } from 'react-hook-form'\nimport { zodResolver } from '@hookform/resolvers/zod'\nimport {\n  type Garnishment,\n  type GarnishmentType,\n} from '@gusto/embedded-api-v-2025-11-15/models/components/garnishment'\nimport { useGarnishmentsCreateMutation } from '@gusto/embedded-api-v-2025-11-15/react-query/garnishmentsCreate'\nimport { useGarnishmentsUpdateMutation } from '@gusto/embedded-api-v-2025-11-15/react-query/garnishmentsUpdate'\nimport { useGarnishmentsList } from '@gusto/embedded-api-v-2025-11-15/react-query/garnishmentsList'\nimport {\n  createDeductionFormSchema,\n  type DeductionFormData,\n  type DeductionFormOutputs,\n  type DeductionFormOptionalFieldsToRequire,\n} from './deductionFormSchema'\nimport {\n  DescriptionField,\n  RecurringField,\n  DeductAsPercentageField,\n  AmountField,\n  TotalAmountField,\n  AnnualMaximumField,\n  GarnishmentTypeField,\n} from './fields'\nimport { useDeriveFieldsMetadata } from '@/partner-hook-utils/form/useDeriveFieldsMetadata'\nimport { useHookFormInternals } from '@/partner-hook-utils/form/useHookFormInternals'\nimport { createGetFormSubmissionValues } from '@/partner-hook-utils/form/getFormSubmissionValues'\nimport { withOptions } from '@/partner-hook-utils/form/withOptions'\nimport { composeErrorHandler } from '@/partner-hook-utils/composeErrorHandler'\nimport type {\n  BaseFormHookReady,\n  FieldsMetadata,\n  HookLoadingResult,\n  HookSubmitResult,\n} from '@/partner-hook-utils/types'\nimport { useBaseSubmit } from '@/components/Base/useBaseSubmit'\nimport { SDKInternalError } from '@/types/sdkError'\n\nexport type { DeductionFormOptionalFieldsToRequire } from './deductionFormSchema'\n\n// GarnishmentType is a runtime enum; the schema gates which values are valid.\n// The hook's `withOptions` entries below carry the raw enum values so the\n// consumer can supply translated labels via `getOptionLabel` on the field.\n//\n// `'child_support'` is intentionally omitted — child-support garnishments\n// require agency-keyed required attributes (case number, order number,\n// remittance number, county) that this hook doesn't model. Use\n// `useChildSupportGarnishmentForm` for those.\nconst GARNISHMENT_TYPES: readonly GarnishmentType[] = [\n  'federal_tax_lien',\n  'state_tax_lien',\n  'student_loan',\n  'creditor_garnishment',\n  'federal_loan',\n  'other_garnishment',\n] as const\n\nexport interface UseDeductionFormProps {\n  employeeId: string\n  /**\n   * When set, loads that garnishment via the list query and updates it (PUT).\n   * When omitted, the form is in create mode (POST).\n   */\n  garnishmentId?: string\n  /**\n   * Court-ordered deductions are stored as garnishments with `courtOrdered: true`\n   * and require a `garnishmentType` (Federal Tax Lien, Student Loan, etc.).\n   * When `false`, the form is for a \"custom\" post-tax deduction —\n   * `garnishmentType` is excluded from the schema and submit payload.\n   *\n   * Note: this hook does NOT handle `garnishmentType: 'child_support'`. Use\n   * `useChildSupportGarnishmentForm` for child-support agency-keyed payloads.\n   */\n  courtOrdered: boolean\n  optionalFieldsToRequire?: DeductionFormOptionalFieldsToRequire\n  defaultValues?: Partial<DeductionFormData>\n  validationMode?: UseFormProps['mode']\n  shouldFocusError?: boolean\n}\n\nexport interface DeductionFormFields {\n  Description: typeof DescriptionField\n  Recurring: typeof RecurringField\n  DeductAsPercentage: typeof DeductAsPercentageField\n  Amount: typeof AmountField\n  /** Only available when `status.isRecurring` is true. */\n  TotalAmount: typeof TotalAmountField | undefined\n  /** Only available when `status.isRecurring` is true. */\n  AnnualMaximum: typeof AnnualMaximumField | undefined\n  /** Only available when `courtOrdered: true`. */\n  GarnishmentType: typeof GarnishmentTypeField | undefined\n}\n\nexport interface UseDeductionFormReady extends BaseFormHookReady<\n  FieldsMetadata,\n  DeductionFormData,\n  DeductionFormFields\n> {\n  data: {\n    /** The garnishment loaded for update; `null` in create mode. */\n    deduction: Garnishment | null\n  }\n  status: {\n    isPending: boolean\n    mode: 'create' | 'update'\n    /**\n     * Mirrors the watched `recurring` value. Cap fields (`TotalAmount`,\n     * `AnnualMaximum`) are only included on `Fields` when this is true — the\n     * consumer can render them unconditionally and the gating happens in the\n     * hook.\n     */\n    isRecurring: boolean\n  }\n  actions: {\n    onSubmit: () => Promise<HookSubmitResult<Garnishment> | undefined>\n  }\n}\n\nexport type UseDeductionFormResult = HookLoadingResult | UseDeductionFormReady\n\nexport function useDeductionForm({\n  employeeId,\n  garnishmentId,\n  courtOrdered,\n  optionalFieldsToRequire,\n  defaultValues: partnerDefaults,\n  validationMode = 'onSubmit',\n  shouldFocusError = true,\n}: UseDeductionFormProps): UseDeductionFormResult {\n  const isCreateMode = !garnishmentId\n  const schemaMode = isCreateMode ? 'create' : 'update'\n\n  // The garnishments API has no single-row GET — the list endpoint is the only\n  // way to retrieve an existing garnishment. We use the (non-suspense) list\n  // query and pick the matching row by uuid.\n  const garnishmentsListQuery = useGarnishmentsListMutationLikeLoader({\n    employeeId,\n    enabled: !isCreateMode,\n  })\n\n  const fetchedDeduction = useMemo(() => {\n    if (isCreateMode) return null\n    return garnishmentsListQuery.data?.find(g => g.uuid === garnishmentId) ?? null\n  }, [isCreateMode, garnishmentId, garnishmentsListQuery.data])\n\n  const [schema, metadataConfig] = useMemo(\n    () =>\n      createDeductionFormSchema({\n        mode: schemaMode,\n        courtOrdered,\n        optionalFieldsToRequire,\n      }),\n    [schemaMode, courtOrdered, optionalFieldsToRequire],\n  )\n\n  const resolvedDefaults: DeductionFormData = useMemo(\n    () => ({\n      description: fetchedDeduction?.description ?? partnerDefaults?.description ?? '',\n      recurring: fetchedDeduction?.recurring ?? partnerDefaults?.recurring ?? true,\n      deductAsPercentage:\n        fetchedDeduction?.deductAsPercentage ?? partnerDefaults?.deductAsPercentage ?? true,\n      amount: fetchedDeduction?.amount\n        ? Number(fetchedDeduction.amount)\n        : (partnerDefaults?.amount ?? 0),\n      // Caps stay as numbers in the form (0 means \"no cap\"); the hook drops\n      // them to null on the wire in onSubmit.\n      totalAmount: fetchedDeduction?.totalAmount\n        ? Number(fetchedDeduction.totalAmount)\n        : (partnerDefaults?.totalAmount ?? 0),\n      annualMaximum: fetchedDeduction?.annualMaximum\n        ? Number(fetchedDeduction.annualMaximum)\n        : (partnerDefaults?.annualMaximum ?? 0),\n      garnishmentType:\n        fetchedDeduction?.garnishmentType ??\n        partnerDefaults?.garnishmentType ??\n        // First non-child-support type — partners typically pick via the\n        // GarnishmentType select before saving.\n        'federal_tax_lien',\n    }),\n    [fetchedDeduction, partnerDefaults],\n  )\n\n  const formMethods = useForm<DeductionFormData, unknown, DeductionFormOutputs>({\n    resolver: zodResolver(schema),\n    mode: validationMode,\n    shouldFocusError,\n    defaultValues: resolvedDefaults,\n    values: resolvedDefaults,\n    resetOptions: { keepDirtyValues: true },\n  })\n\n  // The cap fields only appear when the deduction is recurring. Watching here\n  // (inside the hook) keeps the consumer from having to reach into\n  // hookFormInternals — the conditional Fields below flip to `undefined`.\n  // The `recurring` RadioGroup round-trips its value as the strings `'true'`/\n  // `'false'` (only the zod preprocessor coerces to a real boolean at\n  // validation time). The string `'false'` is truthy, so reading the raw\n  // watched value here would leave the cap fields visible for one-time\n  // deductions after a frequency toggle. Compare against both shapes — mirrors\n  // the `deductAsPercentage` handling in StandardDeductionForm.\n  const watchedRecurring = useWatch({ control: formMethods.control, name: 'recurring' }) as\n    | boolean\n    | 'true'\n    | 'false'\n    | undefined\n  const isRecurring = watchedRecurring === true || watchedRecurring === 'true'\n\n  const createGarnishmentMutation = useGarnishmentsCreateMutation()\n  const updateGarnishmentMutation = useGarnishmentsUpdateMutation()\n  const isPending = createGarnishmentMutation.isPending || updateGarnishmentMutation.isPending\n\n  const {\n    baseSubmitHandler,\n    error: submitError,\n    setError: setSubmitError,\n  } = useBaseSubmit('DeductionForm')\n\n  const queriesForErrors = !isCreateMode ? [garnishmentsListQuery] : []\n  const errorHandling = composeErrorHandler(queriesForErrors, { submitError, setSubmitError })\n\n  const garnishmentTypeOptions = GARNISHMENT_TYPES.map(value => ({ value, label: value }))\n\n  const baseMetadata = useDeriveFieldsMetadata(metadataConfig, formMethods.control)\n  const fieldsMetadata = {\n    description: baseMetadata.description,\n    recurring: withOptions<boolean>(\n      baseMetadata.recurring,\n      [\n        { value: 'true', label: 'true' },\n        { value: 'false', label: 'false' },\n      ],\n      [true, false],\n    ),\n    deductAsPercentage: withOptions<boolean>(\n      baseMetadata.deductAsPercentage,\n      [\n        { value: 'true', label: 'true' },\n        { value: 'false', label: 'false' },\n      ],\n      [true, false],\n    ),\n    amount: baseMetadata.amount,\n    totalAmount: baseMetadata.totalAmount,\n    annualMaximum: baseMetadata.annualMaximum,\n    garnishmentType: courtOrdered\n      ? withOptions(baseMetadata.garnishmentType, garnishmentTypeOptions, GARNISHMENT_TYPES)\n      : baseMetadata.garnishmentType,\n  }\n\n  const onSubmit = async (): Promise<HookSubmitResult<Garnishment> | undefined> => {\n    let submitResult: HookSubmitResult<Garnishment> | undefined\n\n    await new Promise<void>(resolve => {\n      void formMethods.handleSubmit(\n        async (data: DeductionFormOutputs) => {\n          await baseSubmitHandler(data, async payload => {\n            // The API's `times` column is \"number of remaining occurrences\" —\n            // for one-time deductions we set it to 1, for recurring we null it\n            // out. Matches the legacy GarnishmentForm/CustomDeductionForm.\n            const times = payload.recurring ? null : 1\n            // Wire conversions: amount is always a string; the optional caps\n            // collapse to undefined when the partner left them at zero.\n            const amountStr = String(payload.amount)\n            const totalAmountStr = payload.totalAmount > 0 ? String(payload.totalAmount) : undefined\n            const annualMaximumStr =\n              payload.annualMaximum > 0 ? String(payload.annualMaximum) : undefined\n\n            let updated: Garnishment | undefined\n\n            if (isCreateMode) {\n              const result = await createGarnishmentMutation.mutateAsync({\n                request: {\n                  employeeId,\n                  garnishmentRequest: {\n                    active: true,\n                    description: payload.description,\n                    recurring: payload.recurring,\n                    deductAsPercentage: payload.deductAsPercentage,\n                    amount: amountStr,\n                    totalAmount: totalAmountStr,\n                    annualMaximum: annualMaximumStr,\n                    courtOrdered,\n                    garnishmentType: courtOrdered ? payload.garnishmentType : undefined,\n                    times,\n                  },\n                },\n              })\n              updated = result.garnishment\n            } else {\n              if (!fetchedDeduction) {\n                throw new SDKInternalError(\n                  'Cannot update deduction: no matching garnishment on file',\n                )\n              }\n              const result = await updateGarnishmentMutation.mutateAsync({\n                request: {\n                  garnishmentId: fetchedDeduction.uuid,\n                  updateGarnishmentRequest: {\n                    version: fetchedDeduction.version as string,\n                    active: true,\n                    description: payload.description,\n                    recurring: payload.recurring,\n                    deductAsPercentage: payload.deductAsPercentage,\n                    amount: amountStr,\n                    totalAmount: totalAmountStr,\n                    annualMaximum: annualMaximumStr,\n                    courtOrdered,\n                    // The API rejects garnishment_type changes on update — only\n                    // include when court-ordered AND when matching the loaded\n                    // row's type (no-op pass-through).\n                    garnishmentType: courtOrdered ? payload.garnishmentType : undefined,\n                    times,\n                  },\n                },\n              })\n              updated = result.garnishment\n            }\n\n            if (!updated) {\n              throw new SDKInternalError(\n                isCreateMode ? 'Deduction creation failed' : 'Deduction update failed',\n              )\n            }\n\n            submitResult = {\n              mode: isCreateMode ? 'create' : 'update',\n              data: updated,\n            }\n          })\n          resolve()\n        },\n        () => {\n          resolve()\n        },\n      )()\n    })\n\n    return submitResult\n  }\n\n  const hookFormInternals = useHookFormInternals(formMethods)\n\n  if (!isCreateMode && garnishmentsListQuery.isLoading) {\n    return { isLoading: true as const, errorHandling }\n  }\n\n  return {\n    isLoading: false as const,\n    data: {\n      deduction: fetchedDeduction,\n    },\n    status: {\n      isPending,\n      mode: isCreateMode ? 'create' : 'update',\n      isRecurring,\n    },\n    actions: { onSubmit },\n    errorHandling,\n    form: {\n      Fields: {\n        Description: DescriptionField,\n        Recurring: RecurringField,\n        DeductAsPercentage: DeductAsPercentageField,\n        Amount: AmountField,\n        TotalAmount: isRecurring ? TotalAmountField : undefined,\n        AnnualMaximum: isRecurring ? AnnualMaximumField : undefined,\n        GarnishmentType: courtOrdered ? GarnishmentTypeField : undefined,\n      },\n      fieldsMetadata,\n      hookFormInternals,\n      getFormSubmissionValues: createGetFormSubmissionValues(formMethods, schema),\n    },\n  }\n}\n\nexport type DeductionFormFieldsMetadata = UseDeductionFormReady['form']['fieldsMetadata']\nexport type DeductionFormFieldsType = UseDeductionFormReady['form']['Fields']\n\n// ── Internal loader ─────────────────────────────────────────────────────\n//\n// `useGarnishmentsList` is the only way to retrieve an existing garnishment\n// row — the API has no single-row GET. We expose a tiny wrapper that returns\n// the array directly so the hook above can `.find()` by uuid. Skips the fetch\n// entirely in create mode via `enabled: false`.\n\nfunction useGarnishmentsListMutationLikeLoader({\n  employeeId,\n  enabled,\n}: {\n  employeeId: string\n  enabled: boolean\n}) {\n  const query = useGarnishmentsList({ employeeId }, { enabled })\n  return {\n    data: query.data?.garnishments,\n    isLoading: query.isLoading,\n    error: query.error,\n    refetch: query.refetch,\n  }\n}\n"],"names":["GARNISHMENT_TYPES","useDeductionForm","employeeId","garnishmentId","courtOrdered","optionalFieldsToRequire","partnerDefaults","validationMode","shouldFocusError","isCreateMode","schemaMode","garnishmentsListQuery","useGarnishmentsListMutationLikeLoader","fetchedDeduction","useMemo","g","schema","metadataConfig","createDeductionFormSchema","resolvedDefaults","formMethods","useForm","zodResolver","watchedRecurring","useWatch","isRecurring","createGarnishmentMutation","useGarnishmentsCreateMutation","updateGarnishmentMutation","useGarnishmentsUpdateMutation","isPending","baseSubmitHandler","submitError","setSubmitError","useBaseSubmit","errorHandling","composeErrorHandler","garnishmentTypeOptions","value","baseMetadata","useDeriveFieldsMetadata","fieldsMetadata","withOptions","onSubmit","submitResult","resolve","data","payload","times","amountStr","totalAmountStr","annualMaximumStr","updated","SDKInternalError","hookFormInternals","useHookFormInternals","DescriptionField","RecurringField","DeductAsPercentageField","AmountField","TotalAmountField","AnnualMaximumField","GarnishmentTypeField","createGetFormSubmissionValues","enabled","query","useGarnishmentsList"],"mappings":";;;;;;;;;;;;;;;AAkDA,MAAMA,IAAgD;AAAA,EACpD;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAiEO,SAASC,GAAiB;AAAA,EAC/B,YAAAC;AAAA,EACA,eAAAC;AAAA,EACA,cAAAC;AAAA,EACA,yBAAAC;AAAA,EACA,eAAeC;AAAA,EACf,gBAAAC,IAAiB;AAAA,EACjB,kBAAAC,IAAmB;AACrB,GAAkD;AAChD,QAAMC,IAAe,CAACN,GAChBO,IAAaD,IAAe,WAAW,UAKvCE,IAAwBC,GAAsC;AAAA,IAClE,YAAAV;AAAA,IACA,SAAS,CAACO;AAAA,EAAA,CACX,GAEKI,IAAmBC,EAAQ,MAC3BL,IAAqB,OAClBE,EAAsB,MAAM,KAAK,OAAKI,EAAE,SAASZ,CAAa,KAAK,MACzE,CAACM,GAAcN,GAAeQ,EAAsB,IAAI,CAAC,GAEtD,CAACK,GAAQC,CAAc,IAAIH;AAAA,IAC/B,MACEI,EAA0B;AAAA,MACxB,MAAMR;AAAA,MACN,cAAAN;AAAA,MACA,yBAAAC;AAAA,IAAA,CACD;AAAA,IACH,CAACK,GAAYN,GAAcC,CAAuB;AAAA,EAAA,GAG9Cc,IAAsCL;AAAA,IAC1C,OAAO;AAAA,MACL,aAAaD,GAAkB,eAAeP,GAAiB,eAAe;AAAA,MAC9E,WAAWO,GAAkB,aAAaP,GAAiB,aAAa;AAAA,MACxE,oBACEO,GAAkB,sBAAsBP,GAAiB,sBAAsB;AAAA,MACjF,QAAQO,GAAkB,SACtB,OAAOA,EAAiB,MAAM,IAC7BP,GAAiB,UAAU;AAAA;AAAA;AAAA,MAGhC,aAAaO,GAAkB,cAC3B,OAAOA,EAAiB,WAAW,IAClCP,GAAiB,eAAe;AAAA,MACrC,eAAeO,GAAkB,gBAC7B,OAAOA,EAAiB,aAAa,IACpCP,GAAiB,iBAAiB;AAAA,MACvC,iBACEO,GAAkB,mBAClBP,GAAiB;AAAA;AAAA,MAGjB;AAAA,IAAA;AAAA,IAEJ,CAACO,GAAkBP,CAAe;AAAA,EAAA,GAG9Bc,IAAcC,EAA0D;AAAA,IAC5E,UAAUC,EAAYN,CAAM;AAAA,IAC5B,MAAMT;AAAA,IACN,kBAAAC;AAAA,IACA,eAAeW;AAAA,IACf,QAAQA;AAAA,IACR,cAAc,EAAE,iBAAiB,GAAA;AAAA,EAAK,CACvC,GAWKI,IAAmBC,EAAS,EAAE,SAASJ,EAAY,SAAS,MAAM,aAAa,GAK/EK,IAAcF,MAAqB,MAAQA,MAAqB,QAEhEG,IAA4BC,EAAA,GAC5BC,IAA4BC,EAAA,GAC5BC,IAAYJ,EAA0B,aAAaE,EAA0B,WAE7E;AAAA,IACJ,mBAAAG;AAAA,IACA,OAAOC;AAAA,IACP,UAAUC;AAAA,EAAA,IACRC,GAAc,eAAe,GAG3BC,IAAgBC,GADI3B,IAAyC,CAAA,IAA1B,CAACE,CAAqB,GACH,EAAE,aAAAqB,GAAa,gBAAAC,GAAgB,GAErFI,IAAyBrC,EAAkB,IAAI,CAAAsC,OAAU,EAAE,OAAAA,GAAO,OAAOA,IAAQ,GAEjFC,IAAeC,GAAwBvB,GAAgBG,EAAY,OAAO,GAC1EqB,IAAiB;AAAA,IACrB,aAAaF,EAAa;AAAA,IAC1B,WAAWG;AAAA,MACTH,EAAa;AAAA,MACb;AAAA,QACE,EAAE,OAAO,QAAQ,OAAO,OAAA;AAAA,QACxB,EAAE,OAAO,SAAS,OAAO,QAAA;AAAA,MAAQ;AAAA,MAEnC,CAAC,IAAM,EAAK;AAAA,IAAA;AAAA,IAEd,oBAAoBG;AAAA,MAClBH,EAAa;AAAA,MACb;AAAA,QACE,EAAE,OAAO,QAAQ,OAAO,OAAA;AAAA,QACxB,EAAE,OAAO,SAAS,OAAO,QAAA;AAAA,MAAQ;AAAA,MAEnC,CAAC,IAAM,EAAK;AAAA,IAAA;AAAA,IAEd,QAAQA,EAAa;AAAA,IACrB,aAAaA,EAAa;AAAA,IAC1B,eAAeA,EAAa;AAAA,IAC5B,iBAAiBnC,IACbsC,EAAYH,EAAa,iBAAiBF,GAAwBrC,CAAiB,IACnFuC,EAAa;AAAA,EAAA,GAGbI,IAAW,YAAgE;AAC/E,QAAIC;AAEJ,iBAAM,IAAI,QAAc,CAAAC,MAAW;AACjC,MAAKzB,EAAY;AAAA,QACf,OAAO0B,MAA+B;AACpC,gBAAMf,EAAkBe,GAAM,OAAMC,MAAW;AAI7C,kBAAMC,IAAQD,EAAQ,YAAY,OAAO,GAGnCE,IAAY,OAAOF,EAAQ,MAAM,GACjCG,IAAiBH,EAAQ,cAAc,IAAI,OAAOA,EAAQ,WAAW,IAAI,QACzEI,IACJJ,EAAQ,gBAAgB,IAAI,OAAOA,EAAQ,aAAa,IAAI;AAE9D,gBAAIK;AAEJ,gBAAI3C;AAkBF,cAAA2C,KAjBe,MAAM1B,EAA0B,YAAY;AAAA,gBACzD,SAAS;AAAA,kBACP,YAAAxB;AAAA,kBACA,oBAAoB;AAAA,oBAClB,QAAQ;AAAA,oBACR,aAAa6C,EAAQ;AAAA,oBACrB,WAAWA,EAAQ;AAAA,oBACnB,oBAAoBA,EAAQ;AAAA,oBAC5B,QAAQE;AAAA,oBACR,aAAaC;AAAA,oBACb,eAAeC;AAAA,oBACf,cAAA/C;AAAA,oBACA,iBAAiBA,IAAe2C,EAAQ,kBAAkB;AAAA,oBAC1D,OAAAC;AAAA,kBAAA;AAAA,gBACF;AAAA,cACF,CACD,GACgB;AAAA,iBACZ;AACL,kBAAI,CAACnC;AACH,sBAAM,IAAIwC;AAAA,kBACR;AAAA,gBAAA;AAwBJ,cAAAD,KArBe,MAAMxB,EAA0B,YAAY;AAAA,gBACzD,SAAS;AAAA,kBACP,eAAef,EAAiB;AAAA,kBAChC,0BAA0B;AAAA,oBACxB,SAASA,EAAiB;AAAA,oBAC1B,QAAQ;AAAA,oBACR,aAAakC,EAAQ;AAAA,oBACrB,WAAWA,EAAQ;AAAA,oBACnB,oBAAoBA,EAAQ;AAAA,oBAC5B,QAAQE;AAAA,oBACR,aAAaC;AAAA,oBACb,eAAeC;AAAA,oBACf,cAAA/C;AAAA;AAAA;AAAA;AAAA,oBAIA,iBAAiBA,IAAe2C,EAAQ,kBAAkB;AAAA,oBAC1D,OAAAC;AAAA,kBAAA;AAAA,gBACF;AAAA,cACF,CACD,GACgB;AAAA,YACnB;AAEA,gBAAI,CAACI;AACH,oBAAM,IAAIC;AAAA,gBACR5C,IAAe,8BAA8B;AAAA,cAAA;AAIjD,YAAAmC,IAAe;AAAA,cACb,MAAMnC,IAAe,WAAW;AAAA,cAChC,MAAM2C;AAAA,YAAA;AAAA,UAEV,CAAC,GACDP,EAAA;AAAA,QACF;AAAA,QACA,MAAM;AACJ,UAAAA,EAAA;AAAA,QACF;AAAA,MAAA,EACF;AAAA,IACF,CAAC,GAEMD;AAAA,EACT,GAEMU,IAAoBC,GAAqBnC,CAAW;AAE1D,SAAI,CAACX,KAAgBE,EAAsB,YAClC,EAAE,WAAW,IAAe,eAAAwB,EAAA,IAG9B;AAAA,IACL,WAAW;AAAA,IACX,MAAM;AAAA,MACJ,WAAWtB;AAAA,IAAA;AAAA,IAEb,QAAQ;AAAA,MACN,WAAAiB;AAAA,MACA,MAAMrB,IAAe,WAAW;AAAA,MAChC,aAAAgB;AAAA,IAAA;AAAA,IAEF,SAAS,EAAE,UAAAkB,EAAA;AAAA,IACX,eAAAR;AAAA,IACA,MAAM;AAAA,MACJ,QAAQ;AAAA,QACN,aAAaqB;AAAA,QACb,WAAWC;AAAA,QACX,oBAAoBC;AAAA,QACpB,QAAQC;AAAA,QACR,aAAalC,IAAcmC,IAAmB;AAAA,QAC9C,eAAenC,IAAcoC,IAAqB;AAAA,QAClD,iBAAiBzD,IAAe0D,IAAuB;AAAA,MAAA;AAAA,MAEzD,gBAAArB;AAAA,MACA,mBAAAa;AAAA,MACA,yBAAyBS,GAA8B3C,GAAaJ,CAAM;AAAA,IAAA;AAAA,EAC5E;AAEJ;AAYA,SAASJ,GAAsC;AAAA,EAC7C,YAAAV;AAAA,EACA,SAAA8D;AACF,GAGG;AACD,QAAMC,IAAQC,EAAoB,EAAE,YAAAhE,KAAc,EAAE,SAAA8D,GAAS;AAC7D,SAAO;AAAA,IACL,MAAMC,EAAM,MAAM;AAAA,IAClB,WAAWA,EAAM;AAAA,IACjB,OAAOA,EAAM;AAAA,IACb,SAASA,EAAM;AAAA,EAAA;AAEnB;"}
+{"version":3,"file":"useDeductionForm.js","sources":["../../../../../../src/components/Employee/Deductions/shared/useDeductionForm/useDeductionForm.tsx"],"sourcesContent":["import { useMemo } from 'react'\nimport { useForm, useWatch } from 'react-hook-form'\nimport type { UseFormProps } from 'react-hook-form'\nimport { zodResolver } from '@hookform/resolvers/zod'\nimport {\n  type Garnishment,\n  type GarnishmentType,\n} from '@gusto/embedded-api-v-2025-11-15/models/components/garnishment'\nimport { useGarnishmentsCreateMutation } from '@gusto/embedded-api-v-2025-11-15/react-query/garnishmentsCreate'\nimport { useGarnishmentsUpdateMutation } from '@gusto/embedded-api-v-2025-11-15/react-query/garnishmentsUpdate'\nimport { useGarnishmentsList } from '@gusto/embedded-api-v-2025-11-15/react-query/garnishmentsList'\nimport {\n  createDeductionFormSchema,\n  type DeductionFormData,\n  type DeductionFormOutputs,\n  type DeductionFormOptionalFieldsToRequire,\n} from './deductionFormSchema'\nimport {\n  DescriptionField,\n  RecurringField,\n  DeductAsPercentageField,\n  AmountField,\n  TotalAmountField,\n  AnnualMaximumField,\n  GarnishmentTypeField,\n} from './fields'\nimport { useDeriveFieldsMetadata } from '@/partner-hook-utils/form/useDeriveFieldsMetadata'\nimport { useHookFormInternals } from '@/partner-hook-utils/form/useHookFormInternals'\nimport { createGetFormSubmissionValues } from '@/partner-hook-utils/form/getFormSubmissionValues'\nimport { withOptions } from '@/partner-hook-utils/form/withOptions'\nimport { composeErrorHandler } from '@/partner-hook-utils/composeErrorHandler'\nimport type {\n  BaseFormHookReady,\n  FieldsMetadata,\n  HookLoadingResult,\n  HookSubmitResult,\n} from '@/partner-hook-utils/types'\nimport { useBaseSubmit } from '@/components/Base/useBaseSubmit'\nimport { SDKInternalError } from '@/types/sdkError'\n\nexport type { DeductionFormOptionalFieldsToRequire } from './deductionFormSchema'\n\n// GarnishmentType is a runtime enum; the schema gates which values are valid.\n// The hook's `withOptions` entries below carry the raw enum values so the\n// consumer can supply translated labels via `getOptionLabel` on the field.\n//\n// `'child_support'` is intentionally omitted — child-support garnishments\n// require agency-keyed required attributes (case number, order number,\n// remittance number, county) that this hook doesn't model. Use\n// `useChildSupportGarnishmentForm` for those.\nconst GARNISHMENT_TYPES: readonly GarnishmentType[] = [\n  'federal_tax_lien',\n  'state_tax_lien',\n  'student_loan',\n  'creditor_garnishment',\n  'federal_loan',\n  'other_garnishment',\n] as const\n\n/**\n * Configuration options for {@link useDeductionForm}.\n *\n * @remarks\n * Presence or absence of `garnishmentId` selects the API verb — see the\n * `garnishmentId` field description. `courtOrdered` selects between the\n * post-tax custom variant and the court-ordered garnishment variant.\n *\n * @public\n */\nexport interface UseDeductionFormProps {\n  /** UUID of the employee whose deduction is being created or edited. */\n  employeeId: string\n  /**\n   * When set, loads that garnishment and updates it (PUT). When omitted, the\n   * form is in create mode (POST).\n   */\n  garnishmentId?: string\n  /**\n   * Court-ordered deductions are stored as garnishments with `courtOrdered: true`\n   * and require a `garnishmentType` (Federal Tax Lien, Student Loan, etc.).\n   * When `false`, the form is for a \"custom\" post-tax deduction —\n   * `garnishmentType` is excluded from the schema and submit payload.\n   *\n   * Note: this hook does NOT handle `garnishmentType: 'child_support'`. Use\n   * {@link useChildSupportGarnishmentForm} for child-support agency-keyed payloads.\n   */\n  courtOrdered: boolean\n  /** Override fields that are optional on a given mode to be required. See {@link DeductionFormOptionalFieldsToRequire}. */\n  optionalFieldsToRequire?: DeductionFormOptionalFieldsToRequire\n  /** Pre-fill form values. Server data takes precedence on update. */\n  defaultValues?: Partial<DeductionFormData>\n  /** Passed through to react-hook-form. Defaults to `'onSubmit'`. */\n  validationMode?: UseFormProps['mode']\n  /** 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`. */\n  shouldFocusError?: boolean\n}\n\n/**\n * Pre-bound field components exposed on `useDeductionForm().form.Fields`.\n *\n * @remarks\n * Each property is either the field component or `undefined`. A field is\n * `undefined` when conditions for rendering it aren't met — see each member\n * for its visibility rule. Always null-check conditional fields (e.g.\n * `{Fields.TotalAmount && <Fields.TotalAmount ... />}`) before rendering.\n *\n * @public\n */\nexport interface DeductionFormFields {\n  /** Description text input. Always available. */\n  Description: typeof DescriptionField\n  /** Recurring vs one-time radio group. Always available. */\n  Recurring: typeof RecurringField\n  /** Fixed-amount vs percentage radio group. Always available. */\n  DeductAsPercentage: typeof DeductAsPercentageField\n  /** Deduction amount input. Always available. */\n  Amount: typeof AmountField\n  /** Only available when `status.isRecurring` is true. */\n  TotalAmount: typeof TotalAmountField | undefined\n  /** Only available when `status.isRecurring` is true. */\n  AnnualMaximum: typeof AnnualMaximumField | undefined\n  /** Only available when `courtOrdered: true`. */\n  GarnishmentType: typeof GarnishmentTypeField | undefined\n}\n\n/**\n * Ready-state shape returned by {@link useDeductionForm} once data has loaded.\n *\n * @remarks\n * Discriminated by `isLoading: false`. Extends {@link BaseFormHookReady} with\n * the deduction-specific `data`, `status`, `actions`, and `form.Fields` shape.\n * Static, entity-derived values live under `data.*`; reactive values that\n * flip with form input live under `status.*`.\n *\n * @public\n */\nexport interface UseDeductionFormReady extends BaseFormHookReady<\n  FieldsMetadata,\n  DeductionFormData,\n  DeductionFormFields\n> {\n  /** Deduction-specific data payload: the loaded garnishment for update mode, or `null` in create mode. */\n  data: {\n    /** The garnishment loaded for update; `null` in create mode. */\n    deduction: Garnishment | null\n  }\n  /** Submission state and reactive flags derived from current form input. */\n  status: {\n    /** `true` while a create or update mutation is in flight. */\n    isPending: boolean\n    /** Reflects whether the next submit will POST a new deduction or PUT an existing one. */\n    mode: 'create' | 'update'\n    /**\n     * Mirrors the watched `recurring` value. Cap fields (`TotalAmount`,\n     * `AnnualMaximum`) are only included on `Fields` when this is true — the\n     * consumer can render them unconditionally and the gating happens in the\n     * hook.\n     */\n    isRecurring: boolean\n  }\n  /** Submission action. */\n  actions: {\n    /** Submits the form. Returns the saved garnishment + mode on success, or `undefined` when validation fails or the request errored. */\n    onSubmit: () => Promise<HookSubmitResult<Garnishment> | undefined>\n  }\n}\n\n/**\n * Return value of {@link useDeductionForm}.\n *\n * @remarks\n * Discriminated union: {@link HookLoadingResult} while the existing garnishment\n * is loading (update mode only); {@link UseDeductionFormReady} once data is\n * ready. In create mode the hook returns the ready branch immediately.\n *\n * @public\n */\nexport type UseDeductionFormResult = HookLoadingResult | UseDeductionFormReady\n\n/**\n * Headless hook for creating or updating a non-child-support deduction.\n *\n * @remarks\n * Both variants — post-tax custom deductions and court-ordered garnishments —\n * share the same field set (description, frequency, deduct-as-percentage,\n * amount, optional caps) and differ only in whether the deduction is\n * court-ordered and carries a `garnishmentType`. Set `courtOrdered: true` to\n * surface the garnishment-type select; set it to `false` for a custom post-tax\n * deduction.\n *\n * Presence or absence of `garnishmentId` selects the API verb: omit it to POST\n * a new deduction, supply it to PUT updates against the existing row. For\n * child-support garnishments, use {@link useChildSupportGarnishmentForm}\n * instead — those require agency-keyed required attributes (case number,\n * order number, remittance number, county) that this hook doesn't model.\n *\n * @param input - See {@link UseDeductionFormProps}.\n * @returns A {@link HookLoadingResult} while loading, or a {@link UseDeductionFormReady} once ready.\n * @public\n *\n * @example\n * ```tsx\n * import { useDeductionForm, SDKFormProvider } from '@gusto/embedded-react-sdk'\n *\n * function CustomDeductionPage({ employeeId, garnishmentId }: { employeeId: string; garnishmentId?: string }) {\n *   const form = useDeductionForm({ employeeId, garnishmentId, courtOrdered: false })\n *\n *   if (form.isLoading) return <p>Loading…</p>\n *\n *   const { Fields } = form.form\n *\n *   return (\n *     <SDKFormProvider formHookResult={form}>\n *       <form\n *         onSubmit={e => {\n *           e.preventDefault()\n *           void form.actions.onSubmit()\n *         }}\n *       >\n *         <Fields.Description label=\"Description\" validationMessages={{ REQUIRED: 'Required' }} />\n *         <Fields.Recurring\n *           label=\"Frequency\"\n *           getOptionLabel={v => (v ? 'Recurring' : 'One-time')}\n *           validationMessages={{ REQUIRED: 'Required' }}\n *         />\n *         <Fields.Amount\n *           label=\"Amount\"\n *           validationMessages={{ REQUIRED: 'Required', NEGATIVE_AMOUNT: 'Must be ≥ 0' }}\n *         />\n *         {Fields.TotalAmount && (\n *           <Fields.TotalAmount label=\"Total cap\" validationMessages={{ NEGATIVE_AMOUNT: 'Must be ≥ 0' }} />\n *         )}\n *         <button type=\"submit\">Save</button>\n *       </form>\n *     </SDKFormProvider>\n *   )\n * }\n * ```\n */\nexport function useDeductionForm({\n  employeeId,\n  garnishmentId,\n  courtOrdered,\n  optionalFieldsToRequire,\n  defaultValues: partnerDefaults,\n  validationMode = 'onSubmit',\n  shouldFocusError = true,\n}: UseDeductionFormProps): UseDeductionFormResult {\n  const isCreateMode = !garnishmentId\n  const schemaMode = isCreateMode ? 'create' : 'update'\n\n  // The garnishments API has no single-row GET — the list endpoint is the only\n  // way to retrieve an existing garnishment. We use the (non-suspense) list\n  // query and pick the matching row by uuid.\n  const garnishmentsListQuery = useGarnishmentsListMutationLikeLoader({\n    employeeId,\n    enabled: !isCreateMode,\n  })\n\n  const fetchedDeduction = useMemo(() => {\n    if (isCreateMode) return null\n    return garnishmentsListQuery.data?.find(g => g.uuid === garnishmentId) ?? null\n  }, [isCreateMode, garnishmentId, garnishmentsListQuery.data])\n\n  const [schema, metadataConfig] = useMemo(\n    () =>\n      createDeductionFormSchema({\n        mode: schemaMode,\n        courtOrdered,\n        optionalFieldsToRequire,\n      }),\n    [schemaMode, courtOrdered, optionalFieldsToRequire],\n  )\n\n  const resolvedDefaults: DeductionFormData = useMemo(\n    () => ({\n      description: fetchedDeduction?.description ?? partnerDefaults?.description ?? '',\n      recurring: fetchedDeduction?.recurring ?? partnerDefaults?.recurring ?? true,\n      deductAsPercentage:\n        fetchedDeduction?.deductAsPercentage ?? partnerDefaults?.deductAsPercentage ?? true,\n      amount: fetchedDeduction?.amount\n        ? Number(fetchedDeduction.amount)\n        : (partnerDefaults?.amount ?? 0),\n      // Caps stay as numbers in the form (0 means \"no cap\"); the hook drops\n      // them to null on the wire in onSubmit.\n      totalAmount: fetchedDeduction?.totalAmount\n        ? Number(fetchedDeduction.totalAmount)\n        : (partnerDefaults?.totalAmount ?? 0),\n      annualMaximum: fetchedDeduction?.annualMaximum\n        ? Number(fetchedDeduction.annualMaximum)\n        : (partnerDefaults?.annualMaximum ?? 0),\n      garnishmentType:\n        fetchedDeduction?.garnishmentType ??\n        partnerDefaults?.garnishmentType ??\n        // First non-child-support type — partners typically pick via the\n        // GarnishmentType select before saving.\n        'federal_tax_lien',\n    }),\n    [fetchedDeduction, partnerDefaults],\n  )\n\n  const formMethods = useForm<DeductionFormData, unknown, DeductionFormOutputs>({\n    resolver: zodResolver(schema),\n    mode: validationMode,\n    shouldFocusError,\n    defaultValues: resolvedDefaults,\n    values: resolvedDefaults,\n    resetOptions: { keepDirtyValues: true },\n  })\n\n  // The cap fields only appear when the deduction is recurring. Watching here\n  // (inside the hook) keeps the consumer from having to reach into\n  // hookFormInternals — the conditional Fields below flip to `undefined`.\n  // The `recurring` RadioGroup round-trips its value as the strings `'true'`/\n  // `'false'` (only the zod preprocessor coerces to a real boolean at\n  // validation time). The string `'false'` is truthy, so reading the raw\n  // watched value here would leave the cap fields visible for one-time\n  // deductions after a frequency toggle. Compare against both shapes — mirrors\n  // the `deductAsPercentage` handling in StandardDeductionForm.\n  const watchedRecurring = useWatch({ control: formMethods.control, name: 'recurring' }) as\n    | boolean\n    | 'true'\n    | 'false'\n    | undefined\n  const isRecurring = watchedRecurring === true || watchedRecurring === 'true'\n\n  const createGarnishmentMutation = useGarnishmentsCreateMutation()\n  const updateGarnishmentMutation = useGarnishmentsUpdateMutation()\n  const isPending = createGarnishmentMutation.isPending || updateGarnishmentMutation.isPending\n\n  const {\n    baseSubmitHandler,\n    error: submitError,\n    setError: setSubmitError,\n  } = useBaseSubmit('DeductionForm')\n\n  const queriesForErrors = !isCreateMode ? [garnishmentsListQuery] : []\n  const errorHandling = composeErrorHandler(queriesForErrors, { submitError, setSubmitError })\n\n  const garnishmentTypeOptions = GARNISHMENT_TYPES.map(value => ({ value, label: value }))\n\n  const baseMetadata = useDeriveFieldsMetadata(metadataConfig, formMethods.control)\n  const fieldsMetadata = {\n    description: baseMetadata.description,\n    recurring: withOptions<boolean>(\n      baseMetadata.recurring,\n      [\n        { value: 'true', label: 'true' },\n        { value: 'false', label: 'false' },\n      ],\n      [true, false],\n    ),\n    deductAsPercentage: withOptions<boolean>(\n      baseMetadata.deductAsPercentage,\n      [\n        { value: 'true', label: 'true' },\n        { value: 'false', label: 'false' },\n      ],\n      [true, false],\n    ),\n    amount: baseMetadata.amount,\n    totalAmount: baseMetadata.totalAmount,\n    annualMaximum: baseMetadata.annualMaximum,\n    garnishmentType: courtOrdered\n      ? withOptions(baseMetadata.garnishmentType, garnishmentTypeOptions, GARNISHMENT_TYPES)\n      : baseMetadata.garnishmentType,\n  }\n\n  const onSubmit = async (): Promise<HookSubmitResult<Garnishment> | undefined> => {\n    let submitResult: HookSubmitResult<Garnishment> | undefined\n\n    await new Promise<void>(resolve => {\n      void formMethods.handleSubmit(\n        async (data: DeductionFormOutputs) => {\n          await baseSubmitHandler(data, async payload => {\n            // The API's `times` column is \"number of remaining occurrences\" —\n            // for one-time deductions we set it to 1, for recurring we null it\n            // out. Matches the legacy GarnishmentForm/CustomDeductionForm.\n            const times = payload.recurring ? null : 1\n            // Wire conversions: amount is always a string; the optional caps\n            // collapse to undefined when the partner left them at zero.\n            const amountStr = String(payload.amount)\n            const totalAmountStr = payload.totalAmount > 0 ? String(payload.totalAmount) : undefined\n            const annualMaximumStr =\n              payload.annualMaximum > 0 ? String(payload.annualMaximum) : undefined\n\n            let updated: Garnishment | undefined\n\n            if (isCreateMode) {\n              const result = await createGarnishmentMutation.mutateAsync({\n                request: {\n                  employeeId,\n                  garnishmentRequest: {\n                    active: true,\n                    description: payload.description,\n                    recurring: payload.recurring,\n                    deductAsPercentage: payload.deductAsPercentage,\n                    amount: amountStr,\n                    totalAmount: totalAmountStr,\n                    annualMaximum: annualMaximumStr,\n                    courtOrdered,\n                    garnishmentType: courtOrdered ? payload.garnishmentType : undefined,\n                    times,\n                  },\n                },\n              })\n              updated = result.garnishment\n            } else {\n              if (!fetchedDeduction) {\n                throw new SDKInternalError(\n                  'Cannot update deduction: no matching garnishment on file',\n                )\n              }\n              const result = await updateGarnishmentMutation.mutateAsync({\n                request: {\n                  garnishmentId: fetchedDeduction.uuid,\n                  updateGarnishmentRequest: {\n                    version: fetchedDeduction.version as string,\n                    active: true,\n                    description: payload.description,\n                    recurring: payload.recurring,\n                    deductAsPercentage: payload.deductAsPercentage,\n                    amount: amountStr,\n                    totalAmount: totalAmountStr,\n                    annualMaximum: annualMaximumStr,\n                    courtOrdered,\n                    // The API rejects garnishment_type changes on update — only\n                    // include when court-ordered AND when matching the loaded\n                    // row's type (no-op pass-through).\n                    garnishmentType: courtOrdered ? payload.garnishmentType : undefined,\n                    times,\n                  },\n                },\n              })\n              updated = result.garnishment\n            }\n\n            if (!updated) {\n              throw new SDKInternalError(\n                isCreateMode ? 'Deduction creation failed' : 'Deduction update failed',\n              )\n            }\n\n            submitResult = {\n              mode: isCreateMode ? 'create' : 'update',\n              data: updated,\n            }\n          })\n          resolve()\n        },\n        () => {\n          resolve()\n        },\n      )()\n    })\n\n    return submitResult\n  }\n\n  const hookFormInternals = useHookFormInternals(formMethods)\n\n  if (!isCreateMode && garnishmentsListQuery.isLoading) {\n    return { isLoading: true as const, errorHandling }\n  }\n\n  return {\n    isLoading: false as const,\n    data: {\n      deduction: fetchedDeduction,\n    },\n    status: {\n      isPending,\n      mode: isCreateMode ? 'create' : 'update',\n      isRecurring,\n    },\n    actions: { onSubmit },\n    errorHandling,\n    form: {\n      Fields: {\n        Description: DescriptionField,\n        Recurring: RecurringField,\n        DeductAsPercentage: DeductAsPercentageField,\n        Amount: AmountField,\n        TotalAmount: isRecurring ? TotalAmountField : undefined,\n        AnnualMaximum: isRecurring ? AnnualMaximumField : undefined,\n        GarnishmentType: courtOrdered ? GarnishmentTypeField : undefined,\n      },\n      fieldsMetadata,\n      hookFormInternals,\n      getFormSubmissionValues: createGetFormSubmissionValues(formMethods, schema),\n    },\n  }\n}\n\n/**\n * Per-field metadata returned by {@link useDeductionForm} as `form.fieldsMetadata`.\n *\n * @remarks\n * Carries per-field `isRequired`, `isDisabled`, label, description, and option\n * entries derived from the schema and form state. Use these to drive UI such\n * as disabled state or option lists when not relying on the pre-bound\n * {@link DeductionFormFields} components.\n *\n * @public\n */\nexport type DeductionFormFieldsMetadata = UseDeductionFormReady['form']['fieldsMetadata']\n\n// ── Internal loader ─────────────────────────────────────────────────────\n//\n// `useGarnishmentsList` is the only way to retrieve an existing garnishment\n// row — the API has no single-row GET. We expose a tiny wrapper that returns\n// the array directly so the hook above can `.find()` by uuid. Skips the fetch\n// entirely in create mode via `enabled: false`.\n\nfunction useGarnishmentsListMutationLikeLoader({\n  employeeId,\n  enabled,\n}: {\n  employeeId: string\n  enabled: boolean\n}) {\n  const query = useGarnishmentsList({ employeeId }, { enabled })\n  return {\n    data: query.data?.garnishments,\n    isLoading: query.isLoading,\n    error: query.error,\n    refetch: query.refetch,\n  }\n}\n"],"names":["GARNISHMENT_TYPES","useDeductionForm","employeeId","garnishmentId","courtOrdered","optionalFieldsToRequire","partnerDefaults","validationMode","shouldFocusError","isCreateMode","schemaMode","garnishmentsListQuery","useGarnishmentsListMutationLikeLoader","fetchedDeduction","useMemo","g","schema","metadataConfig","createDeductionFormSchema","resolvedDefaults","formMethods","useForm","zodResolver","watchedRecurring","useWatch","isRecurring","createGarnishmentMutation","useGarnishmentsCreateMutation","updateGarnishmentMutation","useGarnishmentsUpdateMutation","isPending","baseSubmitHandler","submitError","setSubmitError","useBaseSubmit","errorHandling","composeErrorHandler","garnishmentTypeOptions","value","baseMetadata","useDeriveFieldsMetadata","fieldsMetadata","withOptions","onSubmit","submitResult","resolve","data","payload","times","amountStr","totalAmountStr","annualMaximumStr","updated","SDKInternalError","hookFormInternals","useHookFormInternals","DescriptionField","RecurringField","DeductAsPercentageField","AmountField","TotalAmountField","AnnualMaximumField","GarnishmentTypeField","createGetFormSubmissionValues","enabled","query","useGarnishmentsList"],"mappings":";;;;;;;;;;;;;;;AAkDA,MAAMA,IAAgD;AAAA,EACpD;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAsLO,SAASC,GAAiB;AAAA,EAC/B,YAAAC;AAAA,EACA,eAAAC;AAAA,EACA,cAAAC;AAAA,EACA,yBAAAC;AAAA,EACA,eAAeC;AAAA,EACf,gBAAAC,IAAiB;AAAA,EACjB,kBAAAC,IAAmB;AACrB,GAAkD;AAChD,QAAMC,IAAe,CAACN,GAChBO,IAAaD,IAAe,WAAW,UAKvCE,IAAwBC,GAAsC;AAAA,IAClE,YAAAV;AAAA,IACA,SAAS,CAACO;AAAA,EAAA,CACX,GAEKI,IAAmBC,EAAQ,MAC3BL,IAAqB,OAClBE,EAAsB,MAAM,KAAK,OAAKI,EAAE,SAASZ,CAAa,KAAK,MACzE,CAACM,GAAcN,GAAeQ,EAAsB,IAAI,CAAC,GAEtD,CAACK,GAAQC,CAAc,IAAIH;AAAA,IAC/B,MACEI,EAA0B;AAAA,MACxB,MAAMR;AAAA,MACN,cAAAN;AAAA,MACA,yBAAAC;AAAA,IAAA,CACD;AAAA,IACH,CAACK,GAAYN,GAAcC,CAAuB;AAAA,EAAA,GAG9Cc,IAAsCL;AAAA,IAC1C,OAAO;AAAA,MACL,aAAaD,GAAkB,eAAeP,GAAiB,eAAe;AAAA,MAC9E,WAAWO,GAAkB,aAAaP,GAAiB,aAAa;AAAA,MACxE,oBACEO,GAAkB,sBAAsBP,GAAiB,sBAAsB;AAAA,MACjF,QAAQO,GAAkB,SACtB,OAAOA,EAAiB,MAAM,IAC7BP,GAAiB,UAAU;AAAA;AAAA;AAAA,MAGhC,aAAaO,GAAkB,cAC3B,OAAOA,EAAiB,WAAW,IAClCP,GAAiB,eAAe;AAAA,MACrC,eAAeO,GAAkB,gBAC7B,OAAOA,EAAiB,aAAa,IACpCP,GAAiB,iBAAiB;AAAA,MACvC,iBACEO,GAAkB,mBAClBP,GAAiB;AAAA;AAAA,MAGjB;AAAA,IAAA;AAAA,IAEJ,CAACO,GAAkBP,CAAe;AAAA,EAAA,GAG9Bc,IAAcC,EAA0D;AAAA,IAC5E,UAAUC,EAAYN,CAAM;AAAA,IAC5B,MAAMT;AAAA,IACN,kBAAAC;AAAA,IACA,eAAeW;AAAA,IACf,QAAQA;AAAA,IACR,cAAc,EAAE,iBAAiB,GAAA;AAAA,EAAK,CACvC,GAWKI,IAAmBC,EAAS,EAAE,SAASJ,EAAY,SAAS,MAAM,aAAa,GAK/EK,IAAcF,MAAqB,MAAQA,MAAqB,QAEhEG,IAA4BC,EAAA,GAC5BC,IAA4BC,EAAA,GAC5BC,IAAYJ,EAA0B,aAAaE,EAA0B,WAE7E;AAAA,IACJ,mBAAAG;AAAA,IACA,OAAOC;AAAA,IACP,UAAUC;AAAA,EAAA,IACRC,GAAc,eAAe,GAG3BC,IAAgBC,GADI3B,IAAyC,CAAA,IAA1B,CAACE,CAAqB,GACH,EAAE,aAAAqB,GAAa,gBAAAC,GAAgB,GAErFI,IAAyBrC,EAAkB,IAAI,CAAAsC,OAAU,EAAE,OAAAA,GAAO,OAAOA,IAAQ,GAEjFC,IAAeC,GAAwBvB,GAAgBG,EAAY,OAAO,GAC1EqB,IAAiB;AAAA,IACrB,aAAaF,EAAa;AAAA,IAC1B,WAAWG;AAAA,MACTH,EAAa;AAAA,MACb;AAAA,QACE,EAAE,OAAO,QAAQ,OAAO,OAAA;AAAA,QACxB,EAAE,OAAO,SAAS,OAAO,QAAA;AAAA,MAAQ;AAAA,MAEnC,CAAC,IAAM,EAAK;AAAA,IAAA;AAAA,IAEd,oBAAoBG;AAAA,MAClBH,EAAa;AAAA,MACb;AAAA,QACE,EAAE,OAAO,QAAQ,OAAO,OAAA;AAAA,QACxB,EAAE,OAAO,SAAS,OAAO,QAAA;AAAA,MAAQ;AAAA,MAEnC,CAAC,IAAM,EAAK;AAAA,IAAA;AAAA,IAEd,QAAQA,EAAa;AAAA,IACrB,aAAaA,EAAa;AAAA,IAC1B,eAAeA,EAAa;AAAA,IAC5B,iBAAiBnC,IACbsC,EAAYH,EAAa,iBAAiBF,GAAwBrC,CAAiB,IACnFuC,EAAa;AAAA,EAAA,GAGbI,IAAW,YAAgE;AAC/E,QAAIC;AAEJ,iBAAM,IAAI,QAAc,CAAAC,MAAW;AACjC,MAAKzB,EAAY;AAAA,QACf,OAAO0B,MAA+B;AACpC,gBAAMf,EAAkBe,GAAM,OAAMC,MAAW;AAI7C,kBAAMC,IAAQD,EAAQ,YAAY,OAAO,GAGnCE,IAAY,OAAOF,EAAQ,MAAM,GACjCG,IAAiBH,EAAQ,cAAc,IAAI,OAAOA,EAAQ,WAAW,IAAI,QACzEI,IACJJ,EAAQ,gBAAgB,IAAI,OAAOA,EAAQ,aAAa,IAAI;AAE9D,gBAAIK;AAEJ,gBAAI3C;AAkBF,cAAA2C,KAjBe,MAAM1B,EAA0B,YAAY;AAAA,gBACzD,SAAS;AAAA,kBACP,YAAAxB;AAAA,kBACA,oBAAoB;AAAA,oBAClB,QAAQ;AAAA,oBACR,aAAa6C,EAAQ;AAAA,oBACrB,WAAWA,EAAQ;AAAA,oBACnB,oBAAoBA,EAAQ;AAAA,oBAC5B,QAAQE;AAAA,oBACR,aAAaC;AAAA,oBACb,eAAeC;AAAA,oBACf,cAAA/C;AAAA,oBACA,iBAAiBA,IAAe2C,EAAQ,kBAAkB;AAAA,oBAC1D,OAAAC;AAAA,kBAAA;AAAA,gBACF;AAAA,cACF,CACD,GACgB;AAAA,iBACZ;AACL,kBAAI,CAACnC;AACH,sBAAM,IAAIwC;AAAA,kBACR;AAAA,gBAAA;AAwBJ,cAAAD,KArBe,MAAMxB,EAA0B,YAAY;AAAA,gBACzD,SAAS;AAAA,kBACP,eAAef,EAAiB;AAAA,kBAChC,0BAA0B;AAAA,oBACxB,SAASA,EAAiB;AAAA,oBAC1B,QAAQ;AAAA,oBACR,aAAakC,EAAQ;AAAA,oBACrB,WAAWA,EAAQ;AAAA,oBACnB,oBAAoBA,EAAQ;AAAA,oBAC5B,QAAQE;AAAA,oBACR,aAAaC;AAAA,oBACb,eAAeC;AAAA,oBACf,cAAA/C;AAAA;AAAA;AAAA;AAAA,oBAIA,iBAAiBA,IAAe2C,EAAQ,kBAAkB;AAAA,oBAC1D,OAAAC;AAAA,kBAAA;AAAA,gBACF;AAAA,cACF,CACD,GACgB;AAAA,YACnB;AAEA,gBAAI,CAACI;AACH,oBAAM,IAAIC;AAAA,gBACR5C,IAAe,8BAA8B;AAAA,cAAA;AAIjD,YAAAmC,IAAe;AAAA,cACb,MAAMnC,IAAe,WAAW;AAAA,cAChC,MAAM2C;AAAA,YAAA;AAAA,UAEV,CAAC,GACDP,EAAA;AAAA,QACF;AAAA,QACA,MAAM;AACJ,UAAAA,EAAA;AAAA,QACF;AAAA,MAAA,EACF;AAAA,IACF,CAAC,GAEMD;AAAA,EACT,GAEMU,IAAoBC,GAAqBnC,CAAW;AAE1D,SAAI,CAACX,KAAgBE,EAAsB,YAClC,EAAE,WAAW,IAAe,eAAAwB,EAAA,IAG9B;AAAA,IACL,WAAW;AAAA,IACX,MAAM;AAAA,MACJ,WAAWtB;AAAA,IAAA;AAAA,IAEb,QAAQ;AAAA,MACN,WAAAiB;AAAA,MACA,MAAMrB,IAAe,WAAW;AAAA,MAChC,aAAAgB;AAAA,IAAA;AAAA,IAEF,SAAS,EAAE,UAAAkB,EAAA;AAAA,IACX,eAAAR;AAAA,IACA,MAAM;AAAA,MACJ,QAAQ;AAAA,QACN,aAAaqB;AAAA,QACb,WAAWC;AAAA,QACX,oBAAoBC;AAAA,QACpB,QAAQC;AAAA,QACR,aAAalC,IAAcmC,IAAmB;AAAA,QAC9C,eAAenC,IAAcoC,IAAqB;AAAA,QAClD,iBAAiBzD,IAAe0D,IAAuB;AAAA,MAAA;AAAA,MAEzD,gBAAArB;AAAA,MACA,mBAAAa;AAAA,MACA,yBAAyBS,GAA8B3C,GAAaJ,CAAM;AAAA,IAAA;AAAA,EAC5E;AAEJ;AAsBA,SAASJ,GAAsC;AAAA,EAC7C,YAAAV;AAAA,EACA,SAAA8D;AACF,GAGG;AACD,QAAMC,IAAQC,EAAoB,EAAE,YAAAhE,KAAc,EAAE,SAAA8D,GAAS;AAC7D,SAAO;AAAA,IACL,MAAMC,EAAM,MAAM;AAAA,IAClB,WAAWA,EAAM;AAAA,IACjB,OAAOA,EAAM;AAAA,IACb,SAASA,EAAM;AAAA,EAAA;AAEnB;"}

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

@@ -1,12 +1,14 @@
 import { Garnishment } from '@gusto/embedded-api-v-2025-11-15/models/components/garnishment';
 import { BaseHookReady, HookLoadingResult, HookSubmitResult } from '../../../../partner-hook-utils/types';
+/** @internal */
 export interface UseDeductionsListProps {
     employeeId: string;
 }
-export interface DeductionsListDeleteResult {
+interface DeductionsListDeleteResult {
     garnishment: Garnishment;
     remainingActiveCount: number;
 }
+/** @internal */
 export interface UseDeductionsListReady extends BaseHookReady<{
     deductions: Garnishment[];
 }, {
@@ -18,5 +20,8 @@ export interface UseDeductionsListReady extends BaseHookReady<{
         onDelete: (garnishment: Garnishment) => Promise<HookSubmitResult<DeductionsListDeleteResult> | undefined>;
     };
 }
+/** @internal */
 export type UseDeductionsListResult = HookLoadingResult | UseDeductionsListReady;
+/** @internal */
 export declare function useDeductionsList({ employeeId }: UseDeductionsListProps): UseDeductionsListResult;
+export {};

package/dist/components/Employee/Deductions/shared/useDeductionsList.js.map

@@ -1 +1 @@
-{"version":3,"file":"useDeductionsList.js","sources":["../../../../../src/components/Employee/Deductions/shared/useDeductionsList.tsx"],"sourcesContent":["import { useGarnishmentsList } from '@gusto/embedded-api-v-2025-11-15/react-query/garnishmentsList'\nimport { useGarnishmentsUpdateMutation } from '@gusto/embedded-api-v-2025-11-15/react-query/garnishmentsUpdate'\nimport type { Garnishment } from '@gusto/embedded-api-v-2025-11-15/models/components/garnishment'\nimport { useBaseSubmit } from '@/components/Base/useBaseSubmit'\nimport { composeErrorHandler } from '@/partner-hook-utils/composeErrorHandler'\nimport type { BaseHookReady, HookLoadingResult, HookSubmitResult } from '@/partner-hook-utils/types'\n\nexport interface UseDeductionsListProps {\n  employeeId: string\n}\n\nexport interface DeductionsListDeleteResult {\n  garnishment: Garnishment\n  remainingActiveCount: number\n}\n\nexport interface UseDeductionsListReady extends BaseHookReady<\n  { deductions: Garnishment[] },\n  { isFetching: boolean; isPending: boolean; deletingGarnishmentUuid?: string }\n> {\n  actions: {\n    onDelete: (\n      garnishment: Garnishment,\n    ) => Promise<HookSubmitResult<DeductionsListDeleteResult> | undefined>\n  }\n}\n\nexport type UseDeductionsListResult = HookLoadingResult | UseDeductionsListReady\n\nexport function useDeductionsList({ employeeId }: UseDeductionsListProps): UseDeductionsListResult {\n  const garnishmentsQuery = useGarnishmentsList({ employeeId })\n  const updateMutation = useGarnishmentsUpdateMutation()\n\n  const {\n    baseSubmitHandler,\n    error: submitError,\n    setError: setSubmitError,\n  } = useBaseSubmit('DeductionsList')\n\n  const errorHandling = composeErrorHandler([garnishmentsQuery], {\n    submitError,\n    setSubmitError,\n  })\n\n  const onDelete = async (\n    garnishment: Garnishment,\n  ): Promise<HookSubmitResult<DeductionsListDeleteResult> | undefined> => {\n    let result: HookSubmitResult<DeductionsListDeleteResult> | undefined\n    await baseSubmitHandler(garnishment, async payload => {\n      const response = await updateMutation.mutateAsync({\n        request: {\n          garnishmentId: payload.uuid as string,\n          updateGarnishmentRequest: {\n            ...payload,\n            totalAmount: payload.totalAmount ?? undefined,\n            active: false,\n            version: payload.version as string,\n          },\n        },\n      })\n      const updated = (response.garnishment ?? payload) as Garnishment\n      const currentDeductions = garnishmentsQuery.data?.garnishments ?? []\n      const remainingActiveCount = currentDeductions.filter(\n        g => g.active && g.uuid !== updated.uuid,\n      ).length\n      result = {\n        mode: 'update',\n        data: { garnishment: updated, remainingActiveCount },\n      }\n    })\n    return result\n  }\n\n  const deletingGarnishmentUuid = updateMutation.isPending\n    ? updateMutation.variables.request.garnishmentId\n    : undefined\n\n  const allDeductions = garnishmentsQuery.data?.garnishments\n\n  if (garnishmentsQuery.isLoading || !allDeductions) {\n    return { isLoading: true, errorHandling }\n  }\n\n  const deductions = allDeductions.filter(g => g.active)\n\n  return {\n    isLoading: false,\n    data: { deductions },\n    status: {\n      isFetching: garnishmentsQuery.isFetching,\n      isPending: updateMutation.isPending,\n      deletingGarnishmentUuid,\n    },\n    actions: { onDelete },\n    errorHandling,\n  }\n}\n"],"names":["useDeductionsList","employeeId","garnishmentsQuery","useGarnishmentsList","updateMutation","useGarnishmentsUpdateMutation","baseSubmitHandler","submitError","setSubmitError","useBaseSubmit","errorHandling","composeErrorHandler","onDelete","garnishment","result","payload","updated","remainingActiveCount","g","deletingGarnishmentUuid","allDeductions"],"mappings":";;;;AA6BO,SAASA,EAAkB,EAAE,YAAAC,KAA+D;AACjG,QAAMC,IAAoBC,EAAoB,EAAE,YAAAF,GAAY,GACtDG,IAAiBC,EAAA,GAEjB;AAAA,IACJ,mBAAAC;AAAA,IACA,OAAOC;AAAA,IACP,UAAUC;AAAA,EAAA,IACRC,EAAc,gBAAgB,GAE5BC,IAAgBC,EAAoB,CAACT,CAAiB,GAAG;AAAA,IAC7D,aAAAK;AAAA,IACA,gBAAAC;AAAA,EAAA,CACD,GAEKI,IAAW,OACfC,MACsE;AACtE,QAAIC;AACJ,iBAAMR,EAAkBO,GAAa,OAAME,MAAW;AAYpD,YAAMC,KAXW,MAAMZ,EAAe,YAAY;AAAA,QAChD,SAAS;AAAA,UACP,eAAeW,EAAQ;AAAA,UACvB,0BAA0B;AAAA,YACxB,GAAGA;AAAA,YACH,aAAaA,EAAQ,eAAe;AAAA,YACpC,QAAQ;AAAA,YACR,SAASA,EAAQ;AAAA,UAAA;AAAA,QACnB;AAAA,MACF,CACD,GACyB,eAAeA,GAEnCE,KADoBf,EAAkB,MAAM,gBAAgB,CAAA,GACnB;AAAA,QAC7C,CAAAgB,MAAKA,EAAE,UAAUA,EAAE,SAASF,EAAQ;AAAA,MAAA,EACpC;AACF,MAAAF,IAAS;AAAA,QACP,MAAM;AAAA,QACN,MAAM,EAAE,aAAaE,GAAS,sBAAAC,EAAA;AAAA,MAAqB;AAAA,IAEvD,CAAC,GACMH;AAAA,EACT,GAEMK,IAA0Bf,EAAe,YAC3CA,EAAe,UAAU,QAAQ,gBACjC,QAEEgB,IAAgBlB,EAAkB,MAAM;AAE9C,SAAIA,EAAkB,aAAa,CAACkB,IAC3B,EAAE,WAAW,IAAM,eAAAV,EAAA,IAKrB;AAAA,IACL,WAAW;AAAA,IACX,MAAM,EAAE,YAJSU,EAAc,OAAO,CAAAF,MAAKA,EAAE,MAAM,EAI3C;AAAA,IACR,QAAQ;AAAA,MACN,YAAYhB,EAAkB;AAAA,MAC9B,WAAWE,EAAe;AAAA,MAC1B,yBAAAe;AAAA,IAAA;AAAA,IAEF,SAAS,EAAE,UAAAP,EAAA;AAAA,IACX,eAAAF;AAAA,EAAA;AAEJ;"}
+{"version":3,"file":"useDeductionsList.js","sources":["../../../../../src/components/Employee/Deductions/shared/useDeductionsList.tsx"],"sourcesContent":["import { useGarnishmentsList } from '@gusto/embedded-api-v-2025-11-15/react-query/garnishmentsList'\nimport { useGarnishmentsUpdateMutation } from '@gusto/embedded-api-v-2025-11-15/react-query/garnishmentsUpdate'\nimport type { Garnishment } from '@gusto/embedded-api-v-2025-11-15/models/components/garnishment'\nimport { useBaseSubmit } from '@/components/Base/useBaseSubmit'\nimport { composeErrorHandler } from '@/partner-hook-utils/composeErrorHandler'\nimport type { BaseHookReady, HookLoadingResult, HookSubmitResult } from '@/partner-hook-utils/types'\n\n/** @internal */\nexport interface UseDeductionsListProps {\n  employeeId: string\n}\n\ninterface DeductionsListDeleteResult {\n  garnishment: Garnishment\n  remainingActiveCount: number\n}\n\n/** @internal */\nexport interface UseDeductionsListReady extends BaseHookReady<\n  { deductions: Garnishment[] },\n  { isFetching: boolean; isPending: boolean; deletingGarnishmentUuid?: string }\n> {\n  actions: {\n    onDelete: (\n      garnishment: Garnishment,\n    ) => Promise<HookSubmitResult<DeductionsListDeleteResult> | undefined>\n  }\n}\n\n/** @internal */\nexport type UseDeductionsListResult = HookLoadingResult | UseDeductionsListReady\n\n/** @internal */\nexport function useDeductionsList({ employeeId }: UseDeductionsListProps): UseDeductionsListResult {\n  const garnishmentsQuery = useGarnishmentsList({ employeeId })\n  const updateMutation = useGarnishmentsUpdateMutation()\n\n  const {\n    baseSubmitHandler,\n    error: submitError,\n    setError: setSubmitError,\n  } = useBaseSubmit('DeductionsList')\n\n  const errorHandling = composeErrorHandler([garnishmentsQuery], {\n    submitError,\n    setSubmitError,\n  })\n\n  const onDelete = async (\n    garnishment: Garnishment,\n  ): Promise<HookSubmitResult<DeductionsListDeleteResult> | undefined> => {\n    let result: HookSubmitResult<DeductionsListDeleteResult> | undefined\n    await baseSubmitHandler(garnishment, async payload => {\n      const response = await updateMutation.mutateAsync({\n        request: {\n          garnishmentId: payload.uuid as string,\n          updateGarnishmentRequest: {\n            ...payload,\n            totalAmount: payload.totalAmount ?? undefined,\n            active: false,\n            version: payload.version as string,\n          },\n        },\n      })\n      const updated = (response.garnishment ?? payload) as Garnishment\n      const currentDeductions = garnishmentsQuery.data?.garnishments ?? []\n      const remainingActiveCount = currentDeductions.filter(\n        g => g.active && g.uuid !== updated.uuid,\n      ).length\n      result = {\n        mode: 'update',\n        data: { garnishment: updated, remainingActiveCount },\n      }\n    })\n    return result\n  }\n\n  const deletingGarnishmentUuid = updateMutation.isPending\n    ? updateMutation.variables.request.garnishmentId\n    : undefined\n\n  const allDeductions = garnishmentsQuery.data?.garnishments\n\n  if (garnishmentsQuery.isLoading || !allDeductions) {\n    return { isLoading: true, errorHandling }\n  }\n\n  const deductions = allDeductions.filter(g => g.active)\n\n  return {\n    isLoading: false,\n    data: { deductions },\n    status: {\n      isFetching: garnishmentsQuery.isFetching,\n      isPending: updateMutation.isPending,\n      deletingGarnishmentUuid,\n    },\n    actions: { onDelete },\n    errorHandling,\n  }\n}\n"],"names":["useDeductionsList","employeeId","garnishmentsQuery","useGarnishmentsList","updateMutation","useGarnishmentsUpdateMutation","baseSubmitHandler","submitError","setSubmitError","useBaseSubmit","errorHandling","composeErrorHandler","onDelete","garnishment","result","payload","updated","remainingActiveCount","g","deletingGarnishmentUuid","allDeductions"],"mappings":";;;;AAiCO,SAASA,EAAkB,EAAE,YAAAC,KAA+D;AACjG,QAAMC,IAAoBC,EAAoB,EAAE,YAAAF,GAAY,GACtDG,IAAiBC,EAAA,GAEjB;AAAA,IACJ,mBAAAC;AAAA,IACA,OAAOC;AAAA,IACP,UAAUC;AAAA,EAAA,IACRC,EAAc,gBAAgB,GAE5BC,IAAgBC,EAAoB,CAACT,CAAiB,GAAG;AAAA,IAC7D,aAAAK;AAAA,IACA,gBAAAC;AAAA,EAAA,CACD,GAEKI,IAAW,OACfC,MACsE;AACtE,QAAIC;AACJ,iBAAMR,EAAkBO,GAAa,OAAME,MAAW;AAYpD,YAAMC,KAXW,MAAMZ,EAAe,YAAY;AAAA,QAChD,SAAS;AAAA,UACP,eAAeW,EAAQ;AAAA,UACvB,0BAA0B;AAAA,YACxB,GAAGA;AAAA,YACH,aAAaA,EAAQ,eAAe;AAAA,YACpC,QAAQ;AAAA,YACR,SAASA,EAAQ;AAAA,UAAA;AAAA,QACnB;AAAA,MACF,CACD,GACyB,eAAeA,GAEnCE,KADoBf,EAAkB,MAAM,gBAAgB,CAAA,GACnB;AAAA,QAC7C,CAAAgB,MAAKA,EAAE,UAAUA,EAAE,SAASF,EAAQ;AAAA,MAAA,EACpC;AACF,MAAAF,IAAS;AAAA,QACP,MAAM;AAAA,QACN,MAAM,EAAE,aAAaE,GAAS,sBAAAC,EAAA;AAAA,MAAqB;AAAA,IAEvD,CAAC,GACMH;AAAA,EACT,GAEMK,IAA0Bf,EAAe,YAC3CA,EAAe,UAAU,QAAQ,gBACjC,QAEEgB,IAAgBlB,EAAkB,MAAM;AAE9C,SAAIA,EAAkB,aAAa,CAACkB,IAC3B,EAAE,WAAW,IAAM,eAAAV,EAAA,IAKrB;AAAA,IACL,WAAW;AAAA,IACX,MAAM,EAAE,YAJSU,EAAc,OAAO,CAAAF,MAAKA,EAAE,MAAM,EAI3C;AAAA,IACR,QAAQ;AAAA,MACN,YAAYhB,EAAkB;AAAA,MAC9B,WAAWE,EAAe;AAAA,MAC1B,yBAAAe;AAAA,IAAA;AAAA,IAEF,SAAS,EAAE,UAAAP,EAAA;AAAA,IACX,eAAAF;AAAA,EAAA;AAEJ;"}

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

@@ -5,6 +5,8 @@ import { Garnishment } from '@gusto/embedded-api-v-2025-11-15/models/components/
  * `setPendingDeleteDeduction(...)` to open the dialog, and the dialog's
  * confirm calls `handleConfirmDelete`, which in turn invokes the
  * caller-supplied `handleDelete(garnishment)`.
+ *
+ * @internal
  */
 export declare function useDeleteDeduction(handleDelete: (garnishment: Garnishment) => Promise<void>): {
     pendingDeleteDeduction: Garnishment | null;