@gusto/embedded-react-sdk 0.50.0 → 0.51.0

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

@@ -1,4 +1,4 @@
-import { GarnishmentType } from '@gusto/embedded-api-v-2025-11-15/models/components/garnishment';
+import { GarnishmentType } from '@gusto/embedded-api-v-2026-02-01/models/components/garnishment';
 import { DeductionFormErrorCodes } from './deductionFormSchema';
 import { TextInputHookFieldProps } from '../../../../../partner-hook-utils/form/fields/TextInputHookField';
 import { NumberInputHookFieldProps } from '../../../../../partner-hook-utils/form/fields/NumberInputHookField';
@@ -53,16 +53,7 @@ export type CapValidation = NegativeAmountValidation;
  * @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
- */
+/** @internal */
 export declare function DescriptionField(props: DescriptionFieldProps): import("react").JSX.Element;
 /**
  * Props accepted by {@link useDeductionForm}'s `Fields.Recurring` component.
@@ -70,19 +61,7 @@ export declare function DescriptionField(props: DescriptionFieldProps): import("
  * @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
- */
+/** @internal */
 export declare function RecurringField(props: RecurringFieldProps): import("react").JSX.Element;
 /**
  * Props accepted by {@link useDeductionForm}'s `Fields.DeductAsPercentage` component.
@@ -90,18 +69,7 @@ export declare function RecurringField(props: RecurringFieldProps): import("reac
  * @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
- */
+/** @internal */
 export declare function DeductAsPercentageField(props: DeductAsPercentageFieldProps): import("react").JSX.Element;
 /**
  * Props accepted by {@link useDeductionForm}'s `Fields.Amount` component.
@@ -109,18 +77,7 @@ export declare function DeductAsPercentageField(props: DeductAsPercentageFieldPr
  * @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
- */
+/** @internal */
 export declare function AmountField(props: AmountFieldProps): import("react").JSX.Element;
 /**
  * Props accepted by {@link useDeductionForm}'s `Fields.TotalAmount` component.
@@ -128,18 +85,7 @@ export declare function AmountField(props: AmountFieldProps): import("react").JS
  * @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
- */
+/** @internal */
 export declare function TotalAmountField(props: TotalAmountFieldProps): import("react").JSX.Element;
 /**
  * Props accepted by {@link useDeductionForm}'s `Fields.AnnualMaximum` component.
@@ -147,18 +93,7 @@ export declare function TotalAmountField(props: TotalAmountFieldProps): import("
  * @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
- */
+/** @internal */
 export declare function AnnualMaximumField(props: AnnualMaximumFieldProps): import("react").JSX.Element;
 /**
  * Props accepted by {@link useDeductionForm}'s `Fields.GarnishmentType` component.
@@ -166,18 +101,5 @@ export declare function AnnualMaximumField(props: AnnualMaximumFieldProps): impo
  * @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
- */
+/** @internal */
 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 { TextInputHookField as o } from "../../../../../partner-hook-utils/form/fields/TextInputHookField.js";
-import { SelectHookField as i } from "../../../../../partner-hook-utils/form/fields/SelectHookField.js";
+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";
 function l(n) {
-  return /* @__PURE__ */ e(o, { ...n, name: "description" });
+  return /* @__PURE__ */ e(i, { ...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(i, { ...n, name: "garnishmentType" });
+  return /* @__PURE__ */ e(o, { ...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\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;"}
+{"version":3,"file":"fields.js","sources":["../../../../../../src/components/Employee/Deductions/shared/useDeductionForm/fields.tsx"],"sourcesContent":["import type { GarnishmentType } from '@gusto/embedded-api-v-2026-02-01/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/** @internal */\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/** @internal */\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/** @internal */\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/** @internal */\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/** @internal */\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/** @internal */\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/** @internal */\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":";;;;;AAsEO,SAASA,EAAiBC,GAA8B;AAC7D,SAAO,gBAAAC,EAACC,GAAA,EAAoB,GAAGF,GAAO,MAAK,eAAc;AAC3D;AAcO,SAASG,EAAeH,GAA4B;AACzD,SAAO,gBAAAC,EAACG,GAAA,EAAqB,GAAGJ,GAAO,MAAK,aAAY;AAC1D;AAcO,SAASK,EAAwBL,GAAqC;AAC3E,SAAO,gBAAAC,EAACG,GAAA,EAAqB,GAAGJ,GAAO,MAAK,sBAAqB;AACnE;AAYO,SAASM,EAAYN,GAAyB;AACnD,SAAO,gBAAAC,EAACM,GAAA,EAAsB,GAAGP,GAAO,MAAK,UAAS;AACxD;AAYO,SAASQ,EAAiBR,GAA8B;AAC7D,SAAO,gBAAAC,EAACM,GAAA,EAAsB,GAAGP,GAAO,MAAK,eAAc;AAC7D;AAYO,SAASS,EAAmBT,GAAgC;AACjE,SAAO,gBAAAC,EAACM,GAAA,EAAsB,GAAGP,GAAO,MAAK,iBAAgB;AAC/D;AAcO,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,5 +1,3 @@
-import "./types/i18next.d.ts"
 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 { DeductionFormErrorCodes, type DeductionFormErrorCode, type DeductionFormData, } from './deductionFormSchema';
 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

@@ -1,8 +1,9 @@
+import { ComponentType } from 'react';
 import { UseFormProps } from 'react-hook-form';
-import { Garnishment } from '@gusto/embedded-api-v-2025-11-15/models/components/garnishment';
+import { Garnishment, GarnishmentType } from '@gusto/embedded-api-v-2026-02-01/models/components/garnishment';
 import { DeductionFormData, DeductionFormOptionalFieldsToRequire } from './deductionFormSchema';
-import { DescriptionField, RecurringField, DeductAsPercentageField, AmountField, TotalAmountField, AnnualMaximumField, GarnishmentTypeField } from './fields';
-import { BaseFormHookReady, FieldsMetadata, HookLoadingResult, HookSubmitResult } from '../../../../../partner-hook-utils/types';
+import { DescriptionFieldProps, RecurringFieldProps, DeductAsPercentageFieldProps, AmountFieldProps, TotalAmountFieldProps, AnnualMaximumFieldProps, GarnishmentTypeFieldProps } from './fields';
+import { BaseFormHookReady, FieldMetadata, HookLoadingResult, HookSubmitResult } from '../../../../../partner-hook-utils/types';
 export type { DeductionFormOptionalFieldsToRequire } from './deductionFormSchema';
 /**
  * Configuration options for {@link useDeductionForm}.
@@ -53,20 +54,20 @@ export interface UseDeductionFormProps {
  * @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;
-    /** Only available when `status.isRecurring` is true. */
-    AnnualMaximum: typeof AnnualMaximumField | undefined;
-    /** Only available when `courtOrdered: true`. */
-    GarnishmentType: typeof GarnishmentTypeField | undefined;
+    /** Bound to `description`. Description text input. Always available. */
+    Description: ComponentType<DescriptionFieldProps>;
+    /** Bound to `recurring`. Recurring vs one-time radio group. Always available. */
+    Recurring: ComponentType<RecurringFieldProps>;
+    /** Bound to `deductAsPercentage`. Fixed-amount vs percentage radio group. Always available. */
+    DeductAsPercentage: ComponentType<DeductAsPercentageFieldProps>;
+    /** Bound to `amount`. Deduction amount input. Always available. */
+    Amount: ComponentType<AmountFieldProps>;
+    /** Bound to `totalAmount`. Only available when `status.isRecurring` is true. */
+    TotalAmount: ComponentType<TotalAmountFieldProps> | undefined;
+    /** Bound to `annualMaximum`. Only available when `status.isRecurring` is true. */
+    AnnualMaximum: ComponentType<AnnualMaximumFieldProps> | undefined;
+    /** Bound to `garnishmentType`. Only available when `courtOrdered: true`. */
+    GarnishmentType: ComponentType<GarnishmentTypeFieldProps> | undefined;
 }
 /**
  * Ready-state shape returned by {@link useDeductionForm} once data has loaded.
@@ -79,7 +80,7 @@ export interface DeductionFormFields {
  *
  * @public
  */
-export interface UseDeductionFormReady extends BaseFormHookReady<FieldsMetadata, DeductionFormData, DeductionFormFields> {
+export interface UseDeductionFormReady extends BaseFormHookReady<DeductionFormFieldsMetadata, 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. */
@@ -188,4 +189,4 @@ export declare function useDeductionForm({ employeeId, garnishmentId, courtOrder
  *
  * @public
  */
-export type DeductionFormFieldsMetadata = UseDeductionFormReady['form']['fieldsMetadata'];
+export type DeductionFormFieldsMetadata = { description: FieldMetadata; recurring: import("../../../../../partner-hook-utils/types").FieldMetadataWithOptions<boolean>; deductAsPercentage: import("../../../../../partner-hook-utils/types").FieldMetadataWithOptions<boolean>; amount: FieldMetadata; totalAmount: FieldMetadata; annualMaximum: FieldMetadata; garnishmentType: FieldMetadata; };

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

@@ -1,19 +1,19 @@
-import { useMemo as g } from "react";
+import { useMemo as l } from "react";
 import { useForm as K, useWatch as Q } from "react-hook-form";
 import { zodResolver as U } from "@hookform/resolvers/zod";
-import { useGarnishmentsCreateMutation as W } from "@gusto/embedded-api-v-2025-11-15/react-query/garnishmentsCreate";
-import { useGarnishmentsUpdateMutation as Y } from "@gusto/embedded-api-v-2025-11-15/react-query/garnishmentsUpdate";
-import { useGarnishmentsList as j } from "@gusto/embedded-api-v-2025-11-15/react-query/garnishmentsList";
+import { useGarnishmentsCreateMutation as W } from "@gusto/embedded-api-v-2026-02-01/react-query/garnishmentsCreate";
+import { useGarnishmentsUpdateMutation as Y } from "@gusto/embedded-api-v-2026-02-01/react-query/garnishmentsUpdate";
+import { useGarnishmentsList as j } from "@gusto/embedded-api-v-2026-02-01/react-query/garnishmentsList";
 import { createDeductionFormSchema as J } from "./deductionFormSchema.js";
-import { GarnishmentTypeField as X, AnnualMaximumField as Z, TotalAmountField as $, AmountField as O, DeductAsPercentageField as ee, RecurringField as te, DescriptionField as ne } from "./fields.js";
-import { useDeriveFieldsMetadata as re } from "../../../../../partner-hook-utils/form/useDeriveFieldsMetadata.js";
-import { useHookFormInternals as ie } from "../../../../../partner-hook-utils/form/useHookFormInternals.js";
-import { createGetFormSubmissionValues as ae } from "../../../../../partner-hook-utils/form/getFormSubmissionValues.js";
-import { withOptions as h } from "../../../../../partner-hook-utils/form/withOptions.js";
-import { composeErrorHandler as oe } from "../../../../../partner-hook-utils/composeErrorHandler.js";
-import { useBaseSubmit as se } from "../../../../Base/useBaseSubmit.js";
-import { SDKInternalError as _ } from "../../../../../types/sdkError.js";
-const L = [
+import { GarnishmentTypeField as X, AnnualMaximumField as Z, TotalAmountField as $, AmountField as O, DeductAsPercentageField as tt, RecurringField as et, DescriptionField as nt } from "./fields.js";
+import { useDeriveFieldsMetadata as rt } from "../../../../../partner-hook-utils/form/useDeriveFieldsMetadata.js";
+import { useHookFormInternals as it } from "../../../../../partner-hook-utils/form/useHookFormInternals.js";
+import { createGetFormSubmissionValues as ot } from "../../../../../partner-hook-utils/form/getFormSubmissionValues.js";
+import { withOptions as g } from "../../../../../partner-hook-utils/form/withOptions.js";
+import { composeErrorHandler as at } from "../../../../../partner-hook-utils/composeErrorHandler.js";
+import { useBaseSubmit as ut } from "../../../../Base/useBaseSubmit.js";
+import { SDKInternalError as G } from "../../../../../types/sdkError.js";
+const _ = [
   "federal_tax_lien",
   "state_tax_lien",
   "student_loan",
@@ -21,133 +21,142 @@ const L = [
   "federal_loan",
   "other_garnishment"
 ];
-function Te({
-  employeeId: m,
-  garnishmentId: s,
-  courtOrdered: n,
-  optionalFieldsToRequire: f,
-  defaultValues: i,
-  validationMode: E = "onSubmit",
-  shouldFocusError: R = !0
+function st(r, {
+  courtOrdered: a,
+  garnishmentTypeOptions: t
 }) {
-  const r = !s, p = r ? "create" : "update", c = ue({
-    employeeId: m,
-    enabled: !r
-  }), e = g(() => r ? null : c.data?.find((o) => o.uuid === s) ?? null, [r, s, c.data]), [A, y] = g(
-    () => J({
-      mode: p,
-      courtOrdered: n,
-      optionalFieldsToRequire: f
-    }),
-    [p, n, f]
-  ), M = g(
-    () => ({
-      description: e?.description ?? i?.description ?? "",
-      recurring: e?.recurring ?? i?.recurring ?? !0,
-      deductAsPercentage: e?.deductAsPercentage ?? i?.deductAsPercentage ?? !0,
-      amount: e?.amount ? Number(e.amount) : i?.amount ?? 0,
-      // Caps stay as numbers in the form (0 means "no cap"); the hook drops
-      // them to null on the wire in onSubmit.
-      totalAmount: e?.totalAmount ? Number(e.totalAmount) : i?.totalAmount ?? 0,
-      annualMaximum: e?.annualMaximum ? Number(e.annualMaximum) : i?.annualMaximum ?? 0,
-      garnishmentType: e?.garnishmentType ?? i?.garnishmentType ?? // First non-child-support type — partners typically pick via the
-      // GarnishmentType select before saving.
-      "federal_tax_lien"
-    }),
-    [e, i]
-  ), u = K({
-    resolver: U(A),
-    mode: E,
-    shouldFocusError: R,
-    defaultValues: M,
-    values: M,
-    resetOptions: { keepDirtyValues: !0 }
-  }), b = Q({ control: u.control, name: "recurring" }), l = b === !0 || b === "true", v = W(), F = Y(), D = v.isPending || F.isPending, {
-    baseSubmitHandler: q,
-    error: H,
-    setError: N
-  } = se("DeductionForm"), S = oe(r ? [] : [c], { submitError: H, setSubmitError: N }), V = L.map((o) => ({ value: o, label: o })), a = re(y, u.control), k = {
-    description: a.description,
-    recurring: h(
-      a.recurring,
+  return {
+    description: r.description,
+    recurring: g(
+      r.recurring,
       [
         { value: "true", label: "true" },
         { value: "false", label: "false" }
       ],
       [!0, !1]
     ),
-    deductAsPercentage: h(
-      a.deductAsPercentage,
+    deductAsPercentage: g(
+      r.deductAsPercentage,
       [
         { value: "true", label: "true" },
         { value: "false", label: "false" }
       ],
       [!0, !1]
     ),
-    amount: a.amount,
-    totalAmount: a.totalAmount,
-    annualMaximum: a.annualMaximum,
-    garnishmentType: n ? h(a.garnishmentType, V, L) : a.garnishmentType
-  }, C = async () => {
-    let o;
+    amount: r.amount,
+    totalAmount: r.totalAmount,
+    annualMaximum: r.annualMaximum,
+    garnishmentType: a ? g(r.garnishmentType, t, _) : r.garnishmentType
+  };
+}
+function wt({
+  employeeId: r,
+  garnishmentId: a,
+  courtOrdered: t,
+  optionalFieldsToRequire: h,
+  defaultValues: o,
+  validationMode: L = "onSubmit",
+  shouldFocusError: E = !0
+}) {
+  const i = !a, f = i ? "create" : "update", m = mt({
+    employeeId: r,
+    enabled: !i
+  }), e = l(() => i ? null : m.data?.find((u) => u.uuid === a) ?? null, [i, a, m.data]), [p, D] = l(
+    () => J({
+      mode: f,
+      courtOrdered: t,
+      optionalFieldsToRequire: h
+    }),
+    [f, t, h]
+  ), A = l(
+    () => ({
+      description: e?.description ?? o?.description ?? "",
+      recurring: e?.recurring ?? o?.recurring ?? !0,
+      deductAsPercentage: e?.deductAsPercentage ?? o?.deductAsPercentage ?? !0,
+      amount: e?.amount ? Number(e.amount) : o?.amount ?? 0,
+      // Caps stay as numbers in the form (0 means "no cap"); the hook drops
+      // them to null on the wire in onSubmit.
+      totalAmount: e?.totalAmount ? Number(e.totalAmount) : o?.totalAmount ?? 0,
+      annualMaximum: e?.annualMaximum ? Number(e.annualMaximum) : o?.annualMaximum ?? 0,
+      garnishmentType: e?.garnishmentType ?? o?.garnishmentType ?? // First non-child-support type — partners typically pick via the
+      // GarnishmentType select before saving.
+      "federal_tax_lien"
+    }),
+    [e, o]
+  ), s = K({
+    resolver: U(p),
+    mode: L,
+    shouldFocusError: E,
+    defaultValues: A,
+    values: A,
+    resetOptions: { keepDirtyValues: !0 }
+  }), M = Q({ control: s.control, name: "recurring" }), d = M === !0 || M === "true", v = W(), F = Y(), R = v.isPending || F.isPending, {
+    baseSubmitHandler: y,
+    error: q,
+    setError: H
+  } = ut("DeductionForm"), S = at(i ? [] : [m], { submitError: q, setSubmitError: H }), N = _.map((u) => ({ value: u, label: u })), V = rt(D, s.control), k = st(V, {
+    courtOrdered: t,
+    garnishmentTypeOptions: N
+  }), C = async () => {
+    let u;
     return await new Promise((x) => {
-      u.handleSubmit(
+      s.handleSubmit(
         async (z) => {
-          await q(z, async (t) => {
-            const P = t.recurring ? null : 1, T = String(t.amount), w = t.totalAmount > 0 ? String(t.totalAmount) : void 0, G = t.annualMaximum > 0 ? String(t.annualMaximum) : void 0;
-            let d;
-            if (r)
-              d = (await v.mutateAsync({
+          await y(z, async (n) => {
+            const P = n.recurring ? null : 1, T = String(n.amount), b = n.totalAmount > 0 ? String(n.totalAmount) : void 0, w = n.annualMaximum > 0 ? String(n.annualMaximum) : void 0;
+            let c;
+            if (i)
+              c = (await v.mutateAsync({
                 request: {
-                  employeeId: m,
+                  employeeId: r,
                   garnishmentRequest: {
                     active: !0,
-                    description: t.description,
-                    recurring: t.recurring,
-                    deductAsPercentage: t.deductAsPercentage,
+                    description: n.description,
+                    recurring: n.recurring,
+                    deductAsPercentage: n.deductAsPercentage,
                     amount: T,
-                    totalAmount: w,
-                    annualMaximum: G,
-                    courtOrdered: n,
-                    garnishmentType: n ? t.garnishmentType : void 0,
+                    totalAmount: b,
+                    annualMaximum: w,
+                    courtOrdered: t,
+                    garnishmentType: t ? n.garnishmentType : void 0,
                     times: P
                   }
                 }
               })).garnishment;
             else {
               if (!e)
-                throw new _(
+                throw new G(
                   "Cannot update deduction: no matching garnishment on file"
                 );
-              d = (await F.mutateAsync({
+              c = (await F.mutateAsync({
                 request: {
                   garnishmentId: e.uuid,
                   updateGarnishmentRequest: {
                     version: e.version,
                     active: !0,
-                    description: t.description,
-                    recurring: t.recurring,
-                    deductAsPercentage: t.deductAsPercentage,
+                    description: n.description,
+                    recurring: n.recurring,
+                    deductAsPercentage: n.deductAsPercentage,
                     amount: T,
-                    totalAmount: w,
-                    annualMaximum: G,
-                    courtOrdered: n,
+                    totalAmount: b,
+                    annualMaximum: w,
+                    courtOrdered: t,
                     // The API rejects garnishment_type changes on update — only
                     // include when court-ordered AND when matching the loaded
                     // row's type (no-op pass-through).
-                    garnishmentType: n ? t.garnishmentType : void 0,
+                    garnishmentType: t ? n.garnishmentType : void 0,
                     times: P
                   }
                 }
               })).garnishment;
             }
-            if (!d)
-              throw new _(
-                r ? "Deduction creation failed" : "Deduction update failed"
+            if (!c)
+              throw new G(
+                i ? "Deduction creation failed" : "Deduction update failed"
               );
-            o = {
-              mode: r ? "create" : "update",
-              data: d
+            u = {
+              mode: i ? "create" : "update",
+              data: c
             };
           }), x();
         },
@@ -155,49 +164,49 @@ function Te({
           x();
         }
       )();
-    }), o;
-  }, I = ie(u);
-  return !r && c.isLoading ? { isLoading: !0, errorHandling: S } : {
+    }), u;
+  }, I = it(s);
+  return !i && m.isLoading ? { isLoading: !0, errorHandling: S } : {
     isLoading: !1,
     data: {
       deduction: e
     },
     status: {
-      isPending: D,
-      mode: r ? "create" : "update",
-      isRecurring: l
+      isPending: R,
+      mode: i ? "create" : "update",
+      isRecurring: d
     },
     actions: { onSubmit: C },
     errorHandling: S,
     form: {
       Fields: {
-        Description: ne,
-        Recurring: te,
-        DeductAsPercentage: ee,
+        Description: nt,
+        Recurring: et,
+        DeductAsPercentage: tt,
         Amount: O,
-        TotalAmount: l ? $ : void 0,
-        AnnualMaximum: l ? Z : void 0,
-        GarnishmentType: n ? X : void 0
+        TotalAmount: d ? $ : void 0,
+        AnnualMaximum: d ? Z : void 0,
+        GarnishmentType: t ? X : void 0
       },
       fieldsMetadata: k,
       hookFormInternals: I,
-      getFormSubmissionValues: ae(u, A)
+      getFormSubmissionValues: ot(s, p)
     }
   };
 }
-function ue({
-  employeeId: m,
-  enabled: s
+function mt({
+  employeeId: r,
+  enabled: a
 }) {
-  const n = j({ employeeId: m }, { enabled: s });
+  const t = j({ employeeId: r }, { enabled: a });
   return {
-    data: n.data?.garnishments,
-    isLoading: n.isLoading,
-    error: n.error,
-    refetch: n.refetch
+    data: t.data?.garnishments,
+    isLoading: t.isLoading,
+    error: t.error,
+    refetch: t.refetch
   };
 }
 export {
-  Te as useDeductionForm
+  wt as useDeductionForm
 };
 //# sourceMappingURL=useDeductionForm.js.map