@gusto/embedded-react-sdk 0.47.1 → 0.48.1

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

@@ -1 +1 @@
-{"version":3,"file":"useChildSupportGarnishmentForm.js","sources":["../../../../../../src/components/Employee/Deductions/shared/useChildSupportGarnishmentForm/useChildSupportGarnishmentForm.tsx"],"sourcesContent":["import { useEffect, useMemo, useRef } 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 type { Agencies } from '@gusto/embedded-api-v-2025-11-15/models/components/childsupportdata'\nimport { PaymentPeriod } from '@gusto/embedded-api-v-2025-11-15/models/components/garnishmentchildsupport'\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 { useGarnishmentsGetChildSupportData } from '@gusto/embedded-api-v-2025-11-15/react-query/garnishmentsGetChildSupportData'\nimport {\n  createChildSupportGarnishmentFormSchema,\n  getRequiredAttrKeys,\n  type ChildSupportGarnishmentFormData,\n  type ChildSupportGarnishmentFormOutputs,\n  type SupportedRequiredAttrKey,\n} from './childSupportGarnishmentFormSchema'\nimport {\n  StateField,\n  FipsCodeField,\n  CaseNumberField,\n  OrderNumberField,\n  RemittanceNumberField,\n  PayPeriodMaximumField,\n  AmountField,\n  PaymentPeriodField,\n  type CountyEntry,\n  type StateFieldEntry,\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\nconst PAYMENT_PERIOD_OPTIONS = [\n  { value: PaymentPeriod.EveryWeek, label: PaymentPeriod.EveryWeek },\n  { value: PaymentPeriod.EveryOtherWeek, label: PaymentPeriod.EveryOtherWeek },\n  { value: PaymentPeriod.TwicePerMonth, label: PaymentPeriod.TwicePerMonth },\n  { value: PaymentPeriod.Monthly, label: PaymentPeriod.Monthly },\n] as const\n\nconst PAYMENT_PERIOD_ENTRIES = [\n  PaymentPeriod.EveryWeek,\n  PaymentPeriod.EveryOtherWeek,\n  PaymentPeriod.TwicePerMonth,\n  PaymentPeriod.Monthly,\n] as const\n\nexport interface UseChildSupportGarnishmentFormProps {\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  defaultValues?: Partial<ChildSupportGarnishmentFormData>\n  validationMode?: UseFormProps['mode']\n  shouldFocusError?: boolean\n}\n\nexport interface ChildSupportGarnishmentFormFields {\n  State: typeof StateField\n  /** Only available when the selected agency has more than one fips code, or the\n   *  sole code is county-scoped (not an \"all counties\" auto-pick). */\n  FipsCode: typeof FipsCodeField | undefined\n  /** Only available when the selected agency requires `case_number`. */\n  CaseNumber: typeof CaseNumberField | undefined\n  /** Only available when the selected agency requires `order_number`. */\n  OrderNumber: typeof OrderNumberField | undefined\n  /** Only available when the selected agency requires `remittance_number`. */\n  RemittanceNumber: typeof RemittanceNumberField | undefined\n  PayPeriodMaximum: typeof PayPeriodMaximumField\n  Amount: typeof AmountField\n  PaymentPeriod: typeof PaymentPeriodField\n}\n\nexport interface UseChildSupportGarnishmentFormReady extends BaseFormHookReady<\n  FieldsMetadata,\n  ChildSupportGarnishmentFormData,\n  ChildSupportGarnishmentFormFields\n> {\n  data: {\n    /** Agencies offered as `State` options; raw entries the consumer can use\n     *  with `getOptionLabel` for translated names. */\n    agencies: StateFieldEntry[]\n    /** Counties for the currently selected state. Empty array when no state\n     *  is selected. */\n    counties: CountyEntry[]\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    /** The agency record matching the currently selected `state`. */\n    selectedAgency: Agencies | null\n    /** Mirrors `selectedAgency.manualPaymentRequired`; convenient for showing\n     *  a warning alert. */\n    isManualPaymentRequired: boolean\n    /** Which `required_attributes` keys the selected agency declares. */\n    requiredAttrKeys: ReadonlySet<SupportedRequiredAttrKey>\n  }\n  actions: {\n    onSubmit: () => Promise<HookSubmitResult<Garnishment> | undefined>\n  }\n}\n\nexport type UseChildSupportGarnishmentFormResult =\n  | HookLoadingResult\n  | UseChildSupportGarnishmentFormReady\n\nexport function useChildSupportGarnishmentForm({\n  employeeId,\n  garnishmentId,\n  defaultValues: partnerDefaults,\n  validationMode = 'onSubmit',\n  shouldFocusError = true,\n}: UseChildSupportGarnishmentFormProps): UseChildSupportGarnishmentFormResult {\n  const isCreateMode = !garnishmentId\n  const schemaMode = isCreateMode ? 'create' : 'update'\n\n  // Agencies + their required-attributes / fips codes come from a single GET.\n  const agencyDataQuery = useGarnishmentsGetChildSupportData({})\n  const agencyList = useMemo(\n    () => agencyDataQuery.data?.childSupportData?.agencies ?? [],\n    [agencyDataQuery.data],\n  )\n\n  // Update mode reads the row from the list endpoint (the garnishments API\n  // has no single-row GET).\n  const garnishmentsListQuery = useGarnishmentsList({ employeeId }, { enabled: !isCreateMode })\n  const fetchedDeduction = useMemo(() => {\n    if (isCreateMode) return null\n    return garnishmentsListQuery.data?.garnishments?.find(g => g.uuid === garnishmentId) ?? null\n  }, [isCreateMode, garnishmentId, garnishmentsListQuery.data])\n\n  const resolvedDefaults: ChildSupportGarnishmentFormData = useMemo(\n    () => ({\n      state: fetchedDeduction?.childSupport?.state ?? partnerDefaults?.state ?? '',\n      fipsCode: fetchedDeduction?.childSupport?.fipsCode ?? partnerDefaults?.fipsCode ?? '',\n      caseNumber: fetchedDeduction?.childSupport?.caseNumber ?? partnerDefaults?.caseNumber ?? '',\n      orderNumber:\n        fetchedDeduction?.childSupport?.orderNumber ?? partnerDefaults?.orderNumber ?? '',\n      remittanceNumber:\n        fetchedDeduction?.childSupport?.remittanceNumber ?? partnerDefaults?.remittanceNumber ?? '',\n      amount: fetchedDeduction?.amount\n        ? Number(fetchedDeduction.amount)\n        : (partnerDefaults?.amount ?? 0),\n      payPeriodMaximum: fetchedDeduction?.payPeriodMaximum\n        ? Number(fetchedDeduction.payPeriodMaximum)\n        : (partnerDefaults?.payPeriodMaximum ?? 0),\n      paymentPeriod:\n        (fetchedDeduction?.childSupport?.paymentPeriod as PaymentPeriod | undefined) ??\n        partnerDefaults?.paymentPeriod ??\n        PaymentPeriod.Monthly,\n    }),\n    [fetchedDeduction, partnerDefaults],\n  )\n\n  // Pass the full agency list so requiredness for the agency-attribute fields\n  // (`caseNumber`, `orderNumber`, `remittanceNumber`) is derived dynamically\n  // from the form's `state` value. The schema doesn't need to rebuild when the\n  // user changes states — the predicate runs at validation time and via\n  // `useDeriveFieldsMetadata` for the (optional) label.\n  const [schema, metadataConfig] = useMemo(\n    () => createChildSupportGarnishmentFormSchema({ mode: schemaMode, agencyList }),\n    [schemaMode, agencyList],\n  )\n\n  const formMethods = useForm<\n    ChildSupportGarnishmentFormData,\n    unknown,\n    ChildSupportGarnishmentFormOutputs\n  >({\n    resolver: zodResolver(schema),\n    mode: validationMode,\n    shouldFocusError,\n    defaultValues: resolvedDefaults,\n    values: resolvedDefaults,\n    resetOptions: { keepDirtyValues: true },\n  })\n\n  const liveWatchedState = useWatch({ control: formMethods.control, name: 'state' })\n  const liveSelectedAgency = useMemo(\n    () => agencyList.find(a => a.state === liveWatchedState) ?? null,\n    [agencyList, liveWatchedState],\n  )\n\n  // The agency-attribute fields stay in sync with the chosen state: when the\n  // user switches states, the previous attribute values would otherwise carry\n  // over and potentially submit alongside the wrong agency. The ref tracks\n  // the previous value so the wipe only fires on user-driven transitions —\n  // NOT on the initial sync when an existing garnishment loads (state moves\n  // from '' to e.g. 'AK' as a side effect of `values` updating, which would\n  // otherwise clobber the loaded case/order/remittance values).\n  const previousWatchedStateRef = useRef<string | null>(null)\n  useEffect(() => {\n    const previous = previousWatchedStateRef.current\n    previousWatchedStateRef.current = liveWatchedState\n    // First render (no previous value) → skip the wipe.\n    if (previous === null) return\n    // Server-side load: previous was '' (initial defaults before the row\n    // arrived), now it's the loaded state. That's a sync, not a user toggle.\n    if (previous === '') return\n    if (previous === liveWatchedState) return\n    formMethods.setValue('caseNumber', '')\n    formMethods.setValue('orderNumber', '')\n    formMethods.setValue('remittanceNumber', '')\n    // eslint-disable-next-line react-hooks/exhaustive-deps\n  }, [liveWatchedState])\n\n  // When the selected agency has a single \"all counties\" fips code, auto-fill\n  // the field so the consumer doesn't have to render the county select.\n  const fipsCodes = liveSelectedAgency?.fipsCodes ?? []\n  const singleAllCountiesFipsCode =\n    fipsCodes.length === 1 && !fipsCodes[0]?.county?.length ? (fipsCodes[0]?.code ?? null) : null\n  useEffect(() => {\n    if (singleAllCountiesFipsCode) {\n      formMethods.setValue('fipsCode', singleAllCountiesFipsCode)\n    }\n    // eslint-disable-next-line react-hooks/exhaustive-deps\n  }, [singleAllCountiesFipsCode])\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('ChildSupportGarnishmentForm')\n\n  const errorHandling = composeErrorHandler(\n    isCreateMode ? [agencyDataQuery] : [agencyDataQuery, garnishmentsListQuery],\n    { submitError, setSubmitError },\n  )\n\n  // ── Derived data exposed on the ready branch ─────────────────────────\n\n  const agencies: StateFieldEntry[] = useMemo(\n    () =>\n      agencyList.map(a => ({\n        state: a.state ?? '',\n        name: a.name ?? a.state ?? '',\n        manualPaymentRequired: a.manualPaymentRequired ?? false,\n      })),\n    [agencyList],\n  )\n\n  const counties: CountyEntry[] = useMemo(\n    () =>\n      (liveSelectedAgency?.fipsCodes ?? [])\n        .filter(f => typeof f.code === 'string')\n        .map(f => ({ fipsCode: f.code as string, county: f.county ?? null })),\n    [liveSelectedAgency],\n  )\n\n  const requiredAttrKeys = useMemo(\n    () => getRequiredAttrKeys(liveSelectedAgency),\n    [liveSelectedAgency],\n  )\n\n  const hasSelectableCounties =\n    counties.length > 1 || (counties.length === 1 && singleAllCountiesFipsCode == null)\n\n  // ── Metadata + field-options wiring ─────────────────────────────────\n\n  const baseMetadata = useDeriveFieldsMetadata(metadataConfig, formMethods.control)\n  const stateOptions = agencies.map(a => ({ value: a.state, label: a.name }))\n  const countyOptions = counties.map(c => ({\n    value: c.fipsCode,\n    label: c.county ?? c.fipsCode,\n  }))\n\n  const fieldsMetadata = {\n    state: withOptions(baseMetadata.state, stateOptions, agencies),\n    fipsCode: withOptions(baseMetadata.fipsCode, countyOptions, counties),\n    caseNumber: baseMetadata.caseNumber,\n    orderNumber: baseMetadata.orderNumber,\n    remittanceNumber: baseMetadata.remittanceNumber,\n    payPeriodMaximum: baseMetadata.payPeriodMaximum,\n    amount: baseMetadata.amount,\n    paymentPeriod: withOptions(\n      baseMetadata.paymentPeriod,\n      [...PAYMENT_PERIOD_OPTIONS],\n      [...PAYMENT_PERIOD_ENTRIES],\n    ),\n  }\n\n  // ── Submit ───────────────────────────────────────────────────────────\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: ChildSupportGarnishmentFormOutputs) => {\n          await baseSubmitHandler(data, async payload => {\n            const childSupport = {\n              state: payload.state,\n              paymentPeriod: payload.paymentPeriod,\n              fipsCode: payload.fipsCode,\n              // Empty strings collapse to null so the API persists \"no value\n              // declared\" rather than an empty case number.\n              caseNumber: payload.caseNumber || null,\n              orderNumber: payload.orderNumber || null,\n              remittanceNumber: payload.remittanceNumber || null,\n            }\n\n            const description = `Child Support - ${childSupport.caseNumber ?? ''}`\n            const amountStr = String(payload.amount)\n            const payPeriodMaximumStr =\n              payload.payPeriodMaximum > 0 ? String(payload.payPeriodMaximum) : null\n\n            const requestBody = {\n              active: true,\n              amount: amountStr,\n              description,\n              courtOrdered: true,\n              garnishmentType: 'child_support' as GarnishmentType,\n              times: null,\n              deductAsPercentage: true,\n              payPeriodMaximum: payPeriodMaximumStr,\n              recurring: true,\n              childSupport,\n            }\n\n            let updated: Garnishment | undefined\n\n            if (isCreateMode) {\n              const result = await createGarnishmentMutation.mutateAsync({\n                request: { employeeId, garnishmentRequest: requestBody },\n              })\n              updated = result.garnishment\n            } else {\n              if (!fetchedDeduction) {\n                throw new SDKInternalError(\n                  'Cannot update child-support deduction: no matching garnishment on file',\n                )\n              }\n              const result = await updateGarnishmentMutation.mutateAsync({\n                request: {\n                  garnishmentId: fetchedDeduction.uuid,\n                  updateGarnishmentRequest: {\n                    ...requestBody,\n                    version: fetchedDeduction.version as string,\n                  },\n                },\n              })\n              updated = result.garnishment\n            }\n\n            if (!updated) {\n              throw new SDKInternalError(\n                isCreateMode\n                  ? 'Child-support deduction creation failed'\n                  : 'Child-support 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 (agencyDataQuery.isLoading) {\n    return { isLoading: true as const, errorHandling }\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      agencies,\n      counties,\n      deduction: fetchedDeduction,\n    },\n    status: {\n      isPending,\n      mode: isCreateMode ? 'create' : 'update',\n      selectedAgency: liveSelectedAgency,\n      isManualPaymentRequired: liveSelectedAgency?.manualPaymentRequired ?? false,\n      requiredAttrKeys,\n    },\n    actions: { onSubmit },\n    errorHandling,\n    form: {\n      Fields: {\n        State: StateField,\n        FipsCode: hasSelectableCounties ? FipsCodeField : undefined,\n        CaseNumber: requiredAttrKeys.has('case_number') ? CaseNumberField : undefined,\n        OrderNumber: requiredAttrKeys.has('order_number') ? OrderNumberField : undefined,\n        RemittanceNumber: requiredAttrKeys.has('remittance_number')\n          ? RemittanceNumberField\n          : undefined,\n        PayPeriodMaximum: PayPeriodMaximumField,\n        Amount: AmountField,\n        PaymentPeriod: PaymentPeriodField,\n      },\n      fieldsMetadata,\n      hookFormInternals,\n      getFormSubmissionValues: createGetFormSubmissionValues(formMethods, schema),\n    },\n  }\n}\n\nexport type ChildSupportGarnishmentFormFieldsMetadata =\n  UseChildSupportGarnishmentFormReady['form']['fieldsMetadata']\nexport type ChildSupportGarnishmentFormFieldsType =\n  UseChildSupportGarnishmentFormReady['form']['Fields']\n"],"names":["PAYMENT_PERIOD_OPTIONS","PaymentPeriod","PAYMENT_PERIOD_ENTRIES","useChildSupportGarnishmentForm","employeeId","garnishmentId","partnerDefaults","validationMode","shouldFocusError","isCreateMode","schemaMode","agencyDataQuery","useGarnishmentsGetChildSupportData","agencyList","useMemo","garnishmentsListQuery","useGarnishmentsList","fetchedDeduction","g","resolvedDefaults","schema","metadataConfig","createChildSupportGarnishmentFormSchema","formMethods","useForm","zodResolver","liveWatchedState","useWatch","liveSelectedAgency","a","previousWatchedStateRef","useRef","useEffect","previous","fipsCodes","singleAllCountiesFipsCode","createGarnishmentMutation","useGarnishmentsCreateMutation","updateGarnishmentMutation","useGarnishmentsUpdateMutation","isPending","baseSubmitHandler","submitError","setSubmitError","useBaseSubmit","errorHandling","composeErrorHandler","agencies","counties","f","requiredAttrKeys","getRequiredAttrKeys","hasSelectableCounties","baseMetadata","useDeriveFieldsMetadata","stateOptions","countyOptions","c","fieldsMetadata","withOptions","onSubmit","submitResult","resolve","data","payload","childSupport","description","amountStr","payPeriodMaximumStr","requestBody","updated","SDKInternalError","hookFormInternals","useHookFormInternals","StateField","FipsCodeField","CaseNumberField","OrderNumberField","RemittanceNumberField","PayPeriodMaximumField","AmountField","PaymentPeriodField","createGetFormSubmissionValues"],"mappings":";;;;;;;;;;;;;;;;;AA+CA,MAAMA,KAAyB;AAAA,EAC7B,EAAE,OAAOC,EAAc,WAAW,OAAOA,EAAc,UAAA;AAAA,EACvD,EAAE,OAAOA,EAAc,gBAAgB,OAAOA,EAAc,eAAA;AAAA,EAC5D,EAAE,OAAOA,EAAc,eAAe,OAAOA,EAAc,cAAA;AAAA,EAC3D,EAAE,OAAOA,EAAc,SAAS,OAAOA,EAAc,QAAA;AACvD,GAEMC,KAAyB;AAAA,EAC7BD,EAAc;AAAA,EACdA,EAAc;AAAA,EACdA,EAAc;AAAA,EACdA,EAAc;AAChB;AAiEO,SAASE,GAA+B;AAAA,EAC7C,YAAAC;AAAA,EACA,eAAAC;AAAA,EACA,eAAeC;AAAA,EACf,gBAAAC,IAAiB;AAAA,EACjB,kBAAAC,IAAmB;AACrB,GAA8E;AAC5E,QAAMC,IAAe,CAACJ,GAChBK,IAAaD,IAAe,WAAW,UAGvCE,IAAkBC,GAAmC,EAAE,GACvDC,IAAaC;AAAA,IACjB,MAAMH,EAAgB,MAAM,kBAAkB,YAAY,CAAA;AAAA,IAC1D,CAACA,EAAgB,IAAI;AAAA,EAAA,GAKjBI,IAAwBC,GAAoB,EAAE,YAAAZ,EAAA,GAAc,EAAE,SAAS,CAACK,GAAc,GACtFQ,IAAmBH,EAAQ,MAC3BL,IAAqB,OAClBM,EAAsB,MAAM,cAAc,KAAK,OAAKG,EAAE,SAASb,CAAa,KAAK,MACvF,CAACI,GAAcJ,GAAeU,EAAsB,IAAI,CAAC,GAEtDI,IAAoDL;AAAA,IACxD,OAAO;AAAA,MACL,OAAOG,GAAkB,cAAc,SAASX,GAAiB,SAAS;AAAA,MAC1E,UAAUW,GAAkB,cAAc,YAAYX,GAAiB,YAAY;AAAA,MACnF,YAAYW,GAAkB,cAAc,cAAcX,GAAiB,cAAc;AAAA,MACzF,aACEW,GAAkB,cAAc,eAAeX,GAAiB,eAAe;AAAA,MACjF,kBACEW,GAAkB,cAAc,oBAAoBX,GAAiB,oBAAoB;AAAA,MAC3F,QAAQW,GAAkB,SACtB,OAAOA,EAAiB,MAAM,IAC7BX,GAAiB,UAAU;AAAA,MAChC,kBAAkBW,GAAkB,mBAChC,OAAOA,EAAiB,gBAAgB,IACvCX,GAAiB,oBAAoB;AAAA,MAC1C,eACGW,GAAkB,cAAc,iBACjCX,GAAiB,iBACjBL,EAAc;AAAA,IAAA;AAAA,IAElB,CAACgB,GAAkBX,CAAe;AAAA,EAAA,GAQ9B,CAACc,GAAQC,CAAc,IAAIP;AAAA,IAC/B,MAAMQ,GAAwC,EAAE,MAAMZ,GAAY,YAAAG,GAAY;AAAA,IAC9E,CAACH,GAAYG,CAAU;AAAA,EAAA,GAGnBU,IAAcC,GAIlB;AAAA,IACA,UAAUC,GAAYL,CAAM;AAAA,IAC5B,MAAMb;AAAA,IACN,kBAAAC;AAAA,IACA,eAAeW;AAAA,IACf,QAAQA;AAAA,IACR,cAAc,EAAE,iBAAiB,GAAA;AAAA,EAAK,CACvC,GAEKO,IAAmBC,GAAS,EAAE,SAASJ,EAAY,SAAS,MAAM,SAAS,GAC3EK,IAAqBd;AAAA,IACzB,MAAMD,EAAW,KAAK,OAAKgB,EAAE,UAAUH,CAAgB,KAAK;AAAA,IAC5D,CAACb,GAAYa,CAAgB;AAAA,EAAA,GAUzBI,IAA0BC,EAAsB,IAAI;AAC1D,EAAAC,EAAU,MAAM;AACd,UAAMC,IAAWH,EAAwB;AAGzC,IAFAA,EAAwB,UAAUJ,GAE9BO,MAAa,QAGbA,MAAa,MACbA,MAAaP,MACjBH,EAAY,SAAS,cAAc,EAAE,GACrCA,EAAY,SAAS,eAAe,EAAE,GACtCA,EAAY,SAAS,oBAAoB,EAAE;AAAA,EAE7C,GAAG,CAACG,CAAgB,CAAC;AAIrB,QAAMQ,IAAYN,GAAoB,aAAa,CAAA,GAC7CO,IACJD,EAAU,WAAW,KAAK,CAACA,EAAU,CAAC,GAAG,QAAQ,SAAUA,EAAU,CAAC,GAAG,QAAQ,OAAQ;AAC3F,EAAAF,EAAU,MAAM;AACd,IAAIG,KACFZ,EAAY,SAAS,YAAYY,CAAyB;AAAA,EAG9D,GAAG,CAACA,CAAyB,CAAC;AAE9B,QAAMC,IAA4BC,GAAA,GAC5BC,IAA4BC,GAAA,GAC5BC,IAAYJ,EAA0B,aAAaE,EAA0B,WAE7E;AAAA,IACJ,mBAAAG;AAAA,IACA,OAAOC;AAAA,IACP,UAAUC;AAAA,EAAA,IACRC,GAAc,6BAA6B,GAEzCC,IAAgBC;AAAA,IACpBrC,IAAe,CAACE,CAAe,IAAI,CAACA,GAAiBI,CAAqB;AAAA,IAC1E,EAAE,aAAA2B,GAAa,gBAAAC,EAAA;AAAA,EAAe,GAK1BI,IAA8BjC;AAAA,IAClC,MACED,EAAW,IAAI,CAAAgB,OAAM;AAAA,MACnB,OAAOA,EAAE,SAAS;AAAA,MAClB,MAAMA,EAAE,QAAQA,EAAE,SAAS;AAAA,MAC3B,uBAAuBA,EAAE,yBAAyB;AAAA,IAAA,EAClD;AAAA,IACJ,CAAChB,CAAU;AAAA,EAAA,GAGPmC,IAA0BlC;AAAA,IAC9B,OACGc,GAAoB,aAAa,IAC/B,OAAO,CAAAqB,MAAK,OAAOA,EAAE,QAAS,QAAQ,EACtC,IAAI,CAAAA,OAAM,EAAE,UAAUA,EAAE,MAAgB,QAAQA,EAAE,UAAU,KAAA,EAAO;AAAA,IACxE,CAACrB,CAAkB;AAAA,EAAA,GAGfsB,IAAmBpC;AAAA,IACvB,MAAMqC,GAAoBvB,CAAkB;AAAA,IAC5C,CAACA,CAAkB;AAAA,EAAA,GAGfwB,IACJJ,EAAS,SAAS,KAAMA,EAAS,WAAW,KAAKb,KAA6B,MAI1EkB,IAAeC,GAAwBjC,GAAgBE,EAAY,OAAO,GAC1EgC,IAAeR,EAAS,IAAI,CAAAlB,OAAM,EAAE,OAAOA,EAAE,OAAO,OAAOA,EAAE,KAAA,EAAO,GACpE2B,IAAgBR,EAAS,IAAI,CAAAS,OAAM;AAAA,IACvC,OAAOA,EAAE;AAAA,IACT,OAAOA,EAAE,UAAUA,EAAE;AAAA,EAAA,EACrB,GAEIC,IAAiB;AAAA,IACrB,OAAOC,EAAYN,EAAa,OAAOE,GAAcR,CAAQ;AAAA,IAC7D,UAAUY,EAAYN,EAAa,UAAUG,GAAeR,CAAQ;AAAA,IACpE,YAAYK,EAAa;AAAA,IACzB,aAAaA,EAAa;AAAA,IAC1B,kBAAkBA,EAAa;AAAA,IAC/B,kBAAkBA,EAAa;AAAA,IAC/B,QAAQA,EAAa;AAAA,IACrB,eAAeM;AAAA,MACbN,EAAa;AAAA,MACb,CAAC,GAAGrD,EAAsB;AAAA,MAC1B,CAAC,GAAGE,EAAsB;AAAA,IAAA;AAAA,EAC5B,GAKI0D,IAAW,YAAgE;AAC/E,QAAIC;AAEJ,iBAAM,IAAI,QAAc,CAAAC,MAAW;AACjC,MAAKvC,EAAY;AAAA,QACf,OAAOwC,MAA6C;AAClD,gBAAMtB,EAAkBsB,GAAM,OAAMC,MAAW;AAC7C,kBAAMC,IAAe;AAAA,cACnB,OAAOD,EAAQ;AAAA,cACf,eAAeA,EAAQ;AAAA,cACvB,UAAUA,EAAQ;AAAA;AAAA;AAAA,cAGlB,YAAYA,EAAQ,cAAc;AAAA,cAClC,aAAaA,EAAQ,eAAe;AAAA,cACpC,kBAAkBA,EAAQ,oBAAoB;AAAA,YAAA,GAG1CE,IAAc,mBAAmBD,EAAa,cAAc,EAAE,IAC9DE,IAAY,OAAOH,EAAQ,MAAM,GACjCI,IACJJ,EAAQ,mBAAmB,IAAI,OAAOA,EAAQ,gBAAgB,IAAI,MAE9DK,IAAc;AAAA,cAClB,QAAQ;AAAA,cACR,QAAQF;AAAA,cACR,aAAAD;AAAA,cACA,cAAc;AAAA,cACd,iBAAiB;AAAA,cACjB,OAAO;AAAA,cACP,oBAAoB;AAAA,cACpB,kBAAkBE;AAAA,cAClB,WAAW;AAAA,cACX,cAAAH;AAAA,YAAA;AAGF,gBAAIK;AAEJ,gBAAI7D;AAIF,cAAA6D,KAHe,MAAMlC,EAA0B,YAAY;AAAA,gBACzD,SAAS,EAAE,YAAAhC,GAAY,oBAAoBiE,EAAA;AAAA,cAAY,CACxD,GACgB;AAAA,iBACZ;AACL,kBAAI,CAACpD;AACH,sBAAM,IAAIsD;AAAA,kBACR;AAAA,gBAAA;AAYJ,cAAAD,KATe,MAAMhC,EAA0B,YAAY;AAAA,gBACzD,SAAS;AAAA,kBACP,eAAerB,EAAiB;AAAA,kBAChC,0BAA0B;AAAA,oBACxB,GAAGoD;AAAA,oBACH,SAASpD,EAAiB;AAAA,kBAAA;AAAA,gBAC5B;AAAA,cACF,CACD,GACgB;AAAA,YACnB;AAEA,gBAAI,CAACqD;AACH,oBAAM,IAAIC;AAAA,gBACR9D,IACI,4CACA;AAAA,cAAA;AAIR,YAAAoD,IAAe;AAAA,cACb,MAAMpD,IAAe,WAAW;AAAA,cAChC,MAAM6D;AAAA,YAAA;AAAA,UAEV,CAAC,GACDR,EAAA;AAAA,QACF;AAAA,QACA,MAAM;AACJ,UAAAA,EAAA;AAAA,QACF;AAAA,MAAA,EACF;AAAA,IACF,CAAC,GAEMD;AAAA,EACT,GAEMW,IAAoBC,GAAqBlD,CAAW;AAE1D,SAAIZ,EAAgB,YACX,EAAE,WAAW,IAAe,eAAAkC,EAAA,IAEjC,CAACpC,KAAgBM,EAAsB,YAClC,EAAE,WAAW,IAAe,eAAA8B,EAAA,IAG9B;AAAA,IACL,WAAW;AAAA,IACX,MAAM;AAAA,MACJ,UAAAE;AAAA,MACA,UAAAC;AAAA,MACA,WAAW/B;AAAA,IAAA;AAAA,IAEb,QAAQ;AAAA,MACN,WAAAuB;AAAA,MACA,MAAM/B,IAAe,WAAW;AAAA,MAChC,gBAAgBmB;AAAA,MAChB,yBAAyBA,GAAoB,yBAAyB;AAAA,MACtE,kBAAAsB;AAAA,IAAA;AAAA,IAEF,SAAS,EAAE,UAAAU,EAAA;AAAA,IACX,eAAAf;AAAA,IACA,MAAM;AAAA,MACJ,QAAQ;AAAA,QACN,OAAO6B;AAAA,QACP,UAAUtB,IAAwBuB,KAAgB;AAAA,QAClD,YAAYzB,EAAiB,IAAI,aAAa,IAAI0B,KAAkB;AAAA,QACpE,aAAa1B,EAAiB,IAAI,cAAc,IAAI2B,KAAmB;AAAA,QACvE,kBAAkB3B,EAAiB,IAAI,mBAAmB,IACtD4B,KACA;AAAA,QACJ,kBAAkBC;AAAA,QAClB,QAAQC;AAAA,QACR,eAAeC;AAAA,MAAA;AAAA,MAEjB,gBAAAvB;AAAA,MACA,mBAAAc;AAAA,MACA,yBAAyBU,GAA8B3D,GAAaH,CAAM;AAAA,IAAA;AAAA,EAC5E;AAEJ;"}
+{"version":3,"file":"useChildSupportGarnishmentForm.js","sources":["../../../../../../src/components/Employee/Deductions/shared/useChildSupportGarnishmentForm/useChildSupportGarnishmentForm.tsx"],"sourcesContent":["import { useEffect, useMemo, useRef } 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 type { Agencies } from '@gusto/embedded-api-v-2025-11-15/models/components/childsupportdata'\nimport { PaymentPeriod } from '@gusto/embedded-api-v-2025-11-15/models/components/garnishmentchildsupport'\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 { useGarnishmentsGetChildSupportData } from '@gusto/embedded-api-v-2025-11-15/react-query/garnishmentsGetChildSupportData'\nimport {\n  createChildSupportGarnishmentFormSchema,\n  getRequiredAttrKeys,\n  type ChildSupportGarnishmentFormData,\n  type ChildSupportGarnishmentFormOutputs,\n  type SupportedRequiredAttrKey,\n} from './childSupportGarnishmentFormSchema'\nimport {\n  StateField,\n  FipsCodeField,\n  CaseNumberField,\n  OrderNumberField,\n  RemittanceNumberField,\n  PayPeriodMaximumField,\n  AmountField,\n  PaymentPeriodField,\n  type CountyEntry,\n  type StateFieldEntry,\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\nconst PAYMENT_PERIOD_OPTIONS = [\n  { value: PaymentPeriod.EveryWeek, label: PaymentPeriod.EveryWeek },\n  { value: PaymentPeriod.EveryOtherWeek, label: PaymentPeriod.EveryOtherWeek },\n  { value: PaymentPeriod.TwicePerMonth, label: PaymentPeriod.TwicePerMonth },\n  { value: PaymentPeriod.Monthly, label: PaymentPeriod.Monthly },\n] as const\n\nconst PAYMENT_PERIOD_ENTRIES = [\n  PaymentPeriod.EveryWeek,\n  PaymentPeriod.EveryOtherWeek,\n  PaymentPeriod.TwicePerMonth,\n  PaymentPeriod.Monthly,\n] as const\n\n/**\n * Configuration options for {@link useChildSupportGarnishmentForm}.\n *\n * @remarks\n * Presence or absence of `garnishmentId` selects the API verb — see the\n * `garnishmentId` field description.\n *\n * @public\n */\nexport interface UseChildSupportGarnishmentFormProps {\n  /** UUID of the employee whose child-support garnishment 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  /** Pre-fill form values. Server data takes precedence on update. */\n  defaultValues?: Partial<ChildSupportGarnishmentFormData>\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 `useChildSupportGarnishmentForm().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.FipsCode && <Fields.FipsCode ... />}`) before rendering.\n *\n * @public\n */\nexport interface ChildSupportGarnishmentFormFields {\n  /** Agency (state) select. Always available. */\n  State: typeof StateField\n  /** Only available when the selected agency has more than one fips code, or the\n   *  sole code is county-scoped (not an \"all counties\" auto-pick). */\n  FipsCode: typeof FipsCodeField | undefined\n  /** Only available when the selected agency requires `case_number`. */\n  CaseNumber: typeof CaseNumberField | undefined\n  /** Only available when the selected agency requires `order_number`. */\n  OrderNumber: typeof OrderNumberField | undefined\n  /** Only available when the selected agency requires `remittance_number`. */\n  RemittanceNumber: typeof RemittanceNumberField | undefined\n  /** Per-pay-period currency cap input. Always available. */\n  PayPeriodMaximum: typeof PayPeriodMaximumField\n  /** Percent-of-paycheck input (0–100). Always available. */\n  Amount: typeof AmountField\n  /** Payment period select. Always available. */\n  PaymentPeriod: typeof PaymentPeriodField\n}\n\n/**\n * Ready-state shape returned by {@link useChildSupportGarnishmentForm} once data has loaded.\n *\n * @remarks\n * Discriminated by `isLoading: false`. Extends {@link BaseFormHookReady} with\n * the child-support-specific `data`, `status`, `actions`, and `form.Fields`\n * shape. Static, entity-derived values live under `data.*`; reactive values\n * that flip with form input live under `status.*`.\n *\n * @public\n */\nexport interface UseChildSupportGarnishmentFormReady extends BaseFormHookReady<\n  FieldsMetadata,\n  ChildSupportGarnishmentFormData,\n  ChildSupportGarnishmentFormFields\n> {\n  /** Child-support-specific data payload: the available agencies, counties for the selected state, and the loaded garnishment for update mode. */\n  data: {\n    /** Agencies offered as `State` options; raw entries the consumer can use\n     *  with `getOptionLabel` for translated names. */\n    agencies: StateFieldEntry[]\n    /** Counties for the currently selected state. Empty array when no state\n     *  is selected. */\n    counties: CountyEntry[]\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 garnishment or PUT an existing one. */\n    mode: 'create' | 'update'\n    /** The agency record matching the currently selected `state`. */\n    selectedAgency: Agencies | null\n    /** Mirrors `selectedAgency.manualPaymentRequired`; convenient for showing\n     *  a warning alert. */\n    isManualPaymentRequired: boolean\n    /** Which `required_attributes` keys the selected agency declares. */\n    requiredAttrKeys: ReadonlySet<SupportedRequiredAttrKey>\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 useChildSupportGarnishmentForm}.\n *\n * @remarks\n * Discriminated union: {@link HookLoadingResult} while the agency catalog (and,\n * in update mode, the existing garnishment) is loading;\n * {@link UseChildSupportGarnishmentFormReady} once data is ready.\n *\n * @public\n */\nexport type UseChildSupportGarnishmentFormResult =\n  | HookLoadingResult\n  | UseChildSupportGarnishmentFormReady\n\n/**\n * Headless hook for creating or updating a child-support garnishment.\n *\n * @remarks\n * Unlike standard garnishments, child support requires agency-specific\n * attributes (case number, order number, remittance number) that vary by\n * state, plus an optional county selection when the state has multiple\n * counties. The hook loads the agency catalog from the Gusto API, derives\n * which attributes the selected state requires, and exposes the right Fields\n * conditionally.\n *\n * Presence or absence of `garnishmentId` selects the API verb: omit it to\n * POST a new garnishment, supply it to PUT updates against the existing row.\n * For non-child-support deductions (court-ordered garnishments and post-tax\n * custom), use {@link useDeductionForm} instead.\n *\n * @param input - See {@link UseChildSupportGarnishmentFormProps}.\n * @returns A {@link HookLoadingResult} while loading, or a {@link UseChildSupportGarnishmentFormReady} once ready.\n * @public\n *\n * @example\n * ```tsx\n * import { useChildSupportGarnishmentForm, SDKFormProvider } from '@gusto/embedded-react-sdk'\n *\n * function ChildSupportPage({ employeeId, garnishmentId }: { employeeId: string; garnishmentId?: string }) {\n *   const form = useChildSupportGarnishmentForm({ employeeId, garnishmentId })\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.State\n *           label=\"Agency\"\n *           getOptionLabel={entry => entry.name}\n *           validationMessages={{ REQUIRED: 'Required' }}\n *         />\n *         {Fields.CaseNumber && (\n *           <Fields.CaseNumber label=\"Case number\" validationMessages={{ REQUIRED: 'Required' }} />\n *         )}\n *         <Fields.Amount\n *           label=\"Percentage of paycheck\"\n *           validationMessages={{\n *             REQUIRED: 'Required',\n *             PERCENT_OUT_OF_RANGE: 'Must be between 0 and 100',\n *           }}\n *         />\n *         <button type=\"submit\">Save</button>\n *       </form>\n *     </SDKFormProvider>\n *   )\n * }\n * ```\n */\nexport function useChildSupportGarnishmentForm({\n  employeeId,\n  garnishmentId,\n  defaultValues: partnerDefaults,\n  validationMode = 'onSubmit',\n  shouldFocusError = true,\n}: UseChildSupportGarnishmentFormProps): UseChildSupportGarnishmentFormResult {\n  const isCreateMode = !garnishmentId\n  const schemaMode = isCreateMode ? 'create' : 'update'\n\n  // Agencies + their required-attributes / fips codes come from a single GET.\n  const agencyDataQuery = useGarnishmentsGetChildSupportData({})\n  const agencyList = useMemo(\n    () => agencyDataQuery.data?.childSupportData?.agencies ?? [],\n    [agencyDataQuery.data],\n  )\n\n  // Update mode reads the row from the list endpoint (the garnishments API\n  // has no single-row GET).\n  const garnishmentsListQuery = useGarnishmentsList({ employeeId }, { enabled: !isCreateMode })\n  const fetchedDeduction = useMemo(() => {\n    if (isCreateMode) return null\n    return garnishmentsListQuery.data?.garnishments?.find(g => g.uuid === garnishmentId) ?? null\n  }, [isCreateMode, garnishmentId, garnishmentsListQuery.data])\n\n  const resolvedDefaults: ChildSupportGarnishmentFormData = useMemo(\n    () => ({\n      state: fetchedDeduction?.childSupport?.state ?? partnerDefaults?.state ?? '',\n      fipsCode: fetchedDeduction?.childSupport?.fipsCode ?? partnerDefaults?.fipsCode ?? '',\n      caseNumber: fetchedDeduction?.childSupport?.caseNumber ?? partnerDefaults?.caseNumber ?? '',\n      orderNumber:\n        fetchedDeduction?.childSupport?.orderNumber ?? partnerDefaults?.orderNumber ?? '',\n      remittanceNumber:\n        fetchedDeduction?.childSupport?.remittanceNumber ?? partnerDefaults?.remittanceNumber ?? '',\n      amount: fetchedDeduction?.amount\n        ? Number(fetchedDeduction.amount)\n        : (partnerDefaults?.amount ?? 0),\n      payPeriodMaximum: fetchedDeduction?.payPeriodMaximum\n        ? Number(fetchedDeduction.payPeriodMaximum)\n        : (partnerDefaults?.payPeriodMaximum ?? 0),\n      paymentPeriod:\n        (fetchedDeduction?.childSupport?.paymentPeriod as PaymentPeriod | undefined) ??\n        partnerDefaults?.paymentPeriod ??\n        PaymentPeriod.Monthly,\n    }),\n    [fetchedDeduction, partnerDefaults],\n  )\n\n  // Pass the full agency list so requiredness for the agency-attribute fields\n  // (`caseNumber`, `orderNumber`, `remittanceNumber`) is derived dynamically\n  // from the form's `state` value. The schema doesn't need to rebuild when the\n  // user changes states — the predicate runs at validation time and via\n  // `useDeriveFieldsMetadata` for the (optional) label.\n  const [schema, metadataConfig] = useMemo(\n    () => createChildSupportGarnishmentFormSchema({ mode: schemaMode, agencyList }),\n    [schemaMode, agencyList],\n  )\n\n  const formMethods = useForm<\n    ChildSupportGarnishmentFormData,\n    unknown,\n    ChildSupportGarnishmentFormOutputs\n  >({\n    resolver: zodResolver(schema),\n    mode: validationMode,\n    shouldFocusError,\n    defaultValues: resolvedDefaults,\n    values: resolvedDefaults,\n    resetOptions: { keepDirtyValues: true },\n  })\n\n  const liveWatchedState = useWatch({ control: formMethods.control, name: 'state' })\n  const liveSelectedAgency = useMemo(\n    () => agencyList.find(a => a.state === liveWatchedState) ?? null,\n    [agencyList, liveWatchedState],\n  )\n\n  // The agency-attribute fields stay in sync with the chosen state: when the\n  // user switches states, the previous attribute values would otherwise carry\n  // over and potentially submit alongside the wrong agency. The ref tracks\n  // the previous value so the wipe only fires on user-driven transitions —\n  // NOT on the initial sync when an existing garnishment loads (state moves\n  // from '' to e.g. 'AK' as a side effect of `values` updating, which would\n  // otherwise clobber the loaded case/order/remittance values).\n  const previousWatchedStateRef = useRef<string | null>(null)\n  useEffect(() => {\n    const previous = previousWatchedStateRef.current\n    previousWatchedStateRef.current = liveWatchedState\n    // First render (no previous value) → skip the wipe.\n    if (previous === null) return\n    // Server-side load: previous was '' (initial defaults before the row\n    // arrived), now it's the loaded state. That's a sync, not a user toggle.\n    if (previous === '') return\n    if (previous === liveWatchedState) return\n    formMethods.setValue('caseNumber', '')\n    formMethods.setValue('orderNumber', '')\n    formMethods.setValue('remittanceNumber', '')\n    // eslint-disable-next-line react-hooks/exhaustive-deps\n  }, [liveWatchedState])\n\n  // When the selected agency has a single \"all counties\" fips code, auto-fill\n  // the field so the consumer doesn't have to render the county select.\n  const fipsCodes = liveSelectedAgency?.fipsCodes ?? []\n  const singleAllCountiesFipsCode =\n    fipsCodes.length === 1 && !fipsCodes[0]?.county?.length ? (fipsCodes[0]?.code ?? null) : null\n  useEffect(() => {\n    if (singleAllCountiesFipsCode) {\n      formMethods.setValue('fipsCode', singleAllCountiesFipsCode)\n    }\n    // eslint-disable-next-line react-hooks/exhaustive-deps\n  }, [singleAllCountiesFipsCode])\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('ChildSupportGarnishmentForm')\n\n  const errorHandling = composeErrorHandler(\n    isCreateMode ? [agencyDataQuery] : [agencyDataQuery, garnishmentsListQuery],\n    { submitError, setSubmitError },\n  )\n\n  // ── Derived data exposed on the ready branch ─────────────────────────\n\n  const agencies: StateFieldEntry[] = useMemo(\n    () =>\n      agencyList.map(a => ({\n        state: a.state ?? '',\n        name: a.name ?? a.state ?? '',\n        manualPaymentRequired: a.manualPaymentRequired ?? false,\n      })),\n    [agencyList],\n  )\n\n  const counties: CountyEntry[] = useMemo(\n    () =>\n      (liveSelectedAgency?.fipsCodes ?? [])\n        .filter(f => typeof f.code === 'string')\n        .map(f => ({ fipsCode: f.code as string, county: f.county ?? null })),\n    [liveSelectedAgency],\n  )\n\n  const requiredAttrKeys = useMemo(\n    () => getRequiredAttrKeys(liveSelectedAgency),\n    [liveSelectedAgency],\n  )\n\n  const hasSelectableCounties =\n    counties.length > 1 || (counties.length === 1 && singleAllCountiesFipsCode == null)\n\n  // ── Metadata + field-options wiring ─────────────────────────────────\n\n  const baseMetadata = useDeriveFieldsMetadata(metadataConfig, formMethods.control)\n  const stateOptions = agencies.map(a => ({ value: a.state, label: a.name }))\n  const countyOptions = counties.map(c => ({\n    value: c.fipsCode,\n    label: c.county ?? c.fipsCode,\n  }))\n\n  const fieldsMetadata = {\n    state: withOptions(baseMetadata.state, stateOptions, agencies),\n    fipsCode: withOptions(baseMetadata.fipsCode, countyOptions, counties),\n    caseNumber: baseMetadata.caseNumber,\n    orderNumber: baseMetadata.orderNumber,\n    remittanceNumber: baseMetadata.remittanceNumber,\n    payPeriodMaximum: baseMetadata.payPeriodMaximum,\n    amount: baseMetadata.amount,\n    paymentPeriod: withOptions(\n      baseMetadata.paymentPeriod,\n      [...PAYMENT_PERIOD_OPTIONS],\n      [...PAYMENT_PERIOD_ENTRIES],\n    ),\n  }\n\n  // ── Submit ───────────────────────────────────────────────────────────\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: ChildSupportGarnishmentFormOutputs) => {\n          await baseSubmitHandler(data, async payload => {\n            const childSupport = {\n              state: payload.state,\n              paymentPeriod: payload.paymentPeriod,\n              fipsCode: payload.fipsCode,\n              // Empty strings collapse to null so the API persists \"no value\n              // declared\" rather than an empty case number.\n              caseNumber: payload.caseNumber || null,\n              orderNumber: payload.orderNumber || null,\n              remittanceNumber: payload.remittanceNumber || null,\n            }\n\n            const description = `Child Support - ${childSupport.caseNumber ?? ''}`\n            const amountStr = String(payload.amount)\n            const payPeriodMaximumStr =\n              payload.payPeriodMaximum > 0 ? String(payload.payPeriodMaximum) : null\n\n            const requestBody = {\n              active: true,\n              amount: amountStr,\n              description,\n              courtOrdered: true,\n              garnishmentType: 'child_support' as GarnishmentType,\n              times: null,\n              deductAsPercentage: true,\n              payPeriodMaximum: payPeriodMaximumStr,\n              recurring: true,\n              childSupport,\n            }\n\n            let updated: Garnishment | undefined\n\n            if (isCreateMode) {\n              const result = await createGarnishmentMutation.mutateAsync({\n                request: { employeeId, garnishmentRequest: requestBody },\n              })\n              updated = result.garnishment\n            } else {\n              if (!fetchedDeduction) {\n                throw new SDKInternalError(\n                  'Cannot update child-support deduction: no matching garnishment on file',\n                )\n              }\n              const result = await updateGarnishmentMutation.mutateAsync({\n                request: {\n                  garnishmentId: fetchedDeduction.uuid,\n                  updateGarnishmentRequest: {\n                    ...requestBody,\n                    version: fetchedDeduction.version as string,\n                  },\n                },\n              })\n              updated = result.garnishment\n            }\n\n            if (!updated) {\n              throw new SDKInternalError(\n                isCreateMode\n                  ? 'Child-support deduction creation failed'\n                  : 'Child-support 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 (agencyDataQuery.isLoading) {\n    return { isLoading: true as const, errorHandling }\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      agencies,\n      counties,\n      deduction: fetchedDeduction,\n    },\n    status: {\n      isPending,\n      mode: isCreateMode ? 'create' : 'update',\n      selectedAgency: liveSelectedAgency,\n      isManualPaymentRequired: liveSelectedAgency?.manualPaymentRequired ?? false,\n      requiredAttrKeys,\n    },\n    actions: { onSubmit },\n    errorHandling,\n    form: {\n      Fields: {\n        State: StateField,\n        FipsCode: hasSelectableCounties ? FipsCodeField : undefined,\n        CaseNumber: requiredAttrKeys.has('case_number') ? CaseNumberField : undefined,\n        OrderNumber: requiredAttrKeys.has('order_number') ? OrderNumberField : undefined,\n        RemittanceNumber: requiredAttrKeys.has('remittance_number')\n          ? RemittanceNumberField\n          : undefined,\n        PayPeriodMaximum: PayPeriodMaximumField,\n        Amount: AmountField,\n        PaymentPeriod: PaymentPeriodField,\n      },\n      fieldsMetadata,\n      hookFormInternals,\n      getFormSubmissionValues: createGetFormSubmissionValues(formMethods, schema),\n    },\n  }\n}\n\n/**\n * Per-field metadata returned by {@link useChildSupportGarnishmentForm} 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 ChildSupportGarnishmentFormFields} components.\n *\n * @public\n */\nexport type ChildSupportGarnishmentFormFieldsMetadata =\n  UseChildSupportGarnishmentFormReady['form']['fieldsMetadata']\n"],"names":["PAYMENT_PERIOD_OPTIONS","PaymentPeriod","PAYMENT_PERIOD_ENTRIES","useChildSupportGarnishmentForm","employeeId","garnishmentId","partnerDefaults","validationMode","shouldFocusError","isCreateMode","schemaMode","agencyDataQuery","useGarnishmentsGetChildSupportData","agencyList","useMemo","garnishmentsListQuery","useGarnishmentsList","fetchedDeduction","g","resolvedDefaults","schema","metadataConfig","createChildSupportGarnishmentFormSchema","formMethods","useForm","zodResolver","liveWatchedState","useWatch","liveSelectedAgency","a","previousWatchedStateRef","useRef","useEffect","previous","fipsCodes","singleAllCountiesFipsCode","createGarnishmentMutation","useGarnishmentsCreateMutation","updateGarnishmentMutation","useGarnishmentsUpdateMutation","isPending","baseSubmitHandler","submitError","setSubmitError","useBaseSubmit","errorHandling","composeErrorHandler","agencies","counties","f","requiredAttrKeys","getRequiredAttrKeys","hasSelectableCounties","baseMetadata","useDeriveFieldsMetadata","stateOptions","countyOptions","c","fieldsMetadata","withOptions","onSubmit","submitResult","resolve","data","payload","childSupport","description","amountStr","payPeriodMaximumStr","requestBody","updated","SDKInternalError","hookFormInternals","useHookFormInternals","StateField","FipsCodeField","CaseNumberField","OrderNumberField","RemittanceNumberField","PayPeriodMaximumField","AmountField","PaymentPeriodField","createGetFormSubmissionValues"],"mappings":";;;;;;;;;;;;;;;;;AA+CA,MAAMA,KAAyB;AAAA,EAC7B,EAAE,OAAOC,EAAc,WAAW,OAAOA,EAAc,UAAA;AAAA,EACvD,EAAE,OAAOA,EAAc,gBAAgB,OAAOA,EAAc,eAAA;AAAA,EAC5D,EAAE,OAAOA,EAAc,eAAe,OAAOA,EAAc,cAAA;AAAA,EAC3D,EAAE,OAAOA,EAAc,SAAS,OAAOA,EAAc,QAAA;AACvD,GAEMC,KAAyB;AAAA,EAC7BD,EAAc;AAAA,EACdA,EAAc;AAAA,EACdA,EAAc;AAAA,EACdA,EAAc;AAChB;AAqLO,SAASE,GAA+B;AAAA,EAC7C,YAAAC;AAAA,EACA,eAAAC;AAAA,EACA,eAAeC;AAAA,EACf,gBAAAC,IAAiB;AAAA,EACjB,kBAAAC,IAAmB;AACrB,GAA8E;AAC5E,QAAMC,IAAe,CAACJ,GAChBK,IAAaD,IAAe,WAAW,UAGvCE,IAAkBC,GAAmC,EAAE,GACvDC,IAAaC;AAAA,IACjB,MAAMH,EAAgB,MAAM,kBAAkB,YAAY,CAAA;AAAA,IAC1D,CAACA,EAAgB,IAAI;AAAA,EAAA,GAKjBI,IAAwBC,GAAoB,EAAE,YAAAZ,EAAA,GAAc,EAAE,SAAS,CAACK,GAAc,GACtFQ,IAAmBH,EAAQ,MAC3BL,IAAqB,OAClBM,EAAsB,MAAM,cAAc,KAAK,OAAKG,EAAE,SAASb,CAAa,KAAK,MACvF,CAACI,GAAcJ,GAAeU,EAAsB,IAAI,CAAC,GAEtDI,IAAoDL;AAAA,IACxD,OAAO;AAAA,MACL,OAAOG,GAAkB,cAAc,SAASX,GAAiB,SAAS;AAAA,MAC1E,UAAUW,GAAkB,cAAc,YAAYX,GAAiB,YAAY;AAAA,MACnF,YAAYW,GAAkB,cAAc,cAAcX,GAAiB,cAAc;AAAA,MACzF,aACEW,GAAkB,cAAc,eAAeX,GAAiB,eAAe;AAAA,MACjF,kBACEW,GAAkB,cAAc,oBAAoBX,GAAiB,oBAAoB;AAAA,MAC3F,QAAQW,GAAkB,SACtB,OAAOA,EAAiB,MAAM,IAC7BX,GAAiB,UAAU;AAAA,MAChC,kBAAkBW,GAAkB,mBAChC,OAAOA,EAAiB,gBAAgB,IACvCX,GAAiB,oBAAoB;AAAA,MAC1C,eACGW,GAAkB,cAAc,iBACjCX,GAAiB,iBACjBL,EAAc;AAAA,IAAA;AAAA,IAElB,CAACgB,GAAkBX,CAAe;AAAA,EAAA,GAQ9B,CAACc,GAAQC,CAAc,IAAIP;AAAA,IAC/B,MAAMQ,GAAwC,EAAE,MAAMZ,GAAY,YAAAG,GAAY;AAAA,IAC9E,CAACH,GAAYG,CAAU;AAAA,EAAA,GAGnBU,IAAcC,GAIlB;AAAA,IACA,UAAUC,GAAYL,CAAM;AAAA,IAC5B,MAAMb;AAAA,IACN,kBAAAC;AAAA,IACA,eAAeW;AAAA,IACf,QAAQA;AAAA,IACR,cAAc,EAAE,iBAAiB,GAAA;AAAA,EAAK,CACvC,GAEKO,IAAmBC,GAAS,EAAE,SAASJ,EAAY,SAAS,MAAM,SAAS,GAC3EK,IAAqBd;AAAA,IACzB,MAAMD,EAAW,KAAK,OAAKgB,EAAE,UAAUH,CAAgB,KAAK;AAAA,IAC5D,CAACb,GAAYa,CAAgB;AAAA,EAAA,GAUzBI,IAA0BC,EAAsB,IAAI;AAC1D,EAAAC,EAAU,MAAM;AACd,UAAMC,IAAWH,EAAwB;AAGzC,IAFAA,EAAwB,UAAUJ,GAE9BO,MAAa,QAGbA,MAAa,MACbA,MAAaP,MACjBH,EAAY,SAAS,cAAc,EAAE,GACrCA,EAAY,SAAS,eAAe,EAAE,GACtCA,EAAY,SAAS,oBAAoB,EAAE;AAAA,EAE7C,GAAG,CAACG,CAAgB,CAAC;AAIrB,QAAMQ,IAAYN,GAAoB,aAAa,CAAA,GAC7CO,IACJD,EAAU,WAAW,KAAK,CAACA,EAAU,CAAC,GAAG,QAAQ,SAAUA,EAAU,CAAC,GAAG,QAAQ,OAAQ;AAC3F,EAAAF,EAAU,MAAM;AACd,IAAIG,KACFZ,EAAY,SAAS,YAAYY,CAAyB;AAAA,EAG9D,GAAG,CAACA,CAAyB,CAAC;AAE9B,QAAMC,IAA4BC,GAAA,GAC5BC,IAA4BC,GAAA,GAC5BC,IAAYJ,EAA0B,aAAaE,EAA0B,WAE7E;AAAA,IACJ,mBAAAG;AAAA,IACA,OAAOC;AAAA,IACP,UAAUC;AAAA,EAAA,IACRC,GAAc,6BAA6B,GAEzCC,IAAgBC;AAAA,IACpBrC,IAAe,CAACE,CAAe,IAAI,CAACA,GAAiBI,CAAqB;AAAA,IAC1E,EAAE,aAAA2B,GAAa,gBAAAC,EAAA;AAAA,EAAe,GAK1BI,IAA8BjC;AAAA,IAClC,MACED,EAAW,IAAI,CAAAgB,OAAM;AAAA,MACnB,OAAOA,EAAE,SAAS;AAAA,MAClB,MAAMA,EAAE,QAAQA,EAAE,SAAS;AAAA,MAC3B,uBAAuBA,EAAE,yBAAyB;AAAA,IAAA,EAClD;AAAA,IACJ,CAAChB,CAAU;AAAA,EAAA,GAGPmC,IAA0BlC;AAAA,IAC9B,OACGc,GAAoB,aAAa,IAC/B,OAAO,CAAAqB,MAAK,OAAOA,EAAE,QAAS,QAAQ,EACtC,IAAI,CAAAA,OAAM,EAAE,UAAUA,EAAE,MAAgB,QAAQA,EAAE,UAAU,KAAA,EAAO;AAAA,IACxE,CAACrB,CAAkB;AAAA,EAAA,GAGfsB,IAAmBpC;AAAA,IACvB,MAAMqC,GAAoBvB,CAAkB;AAAA,IAC5C,CAACA,CAAkB;AAAA,EAAA,GAGfwB,IACJJ,EAAS,SAAS,KAAMA,EAAS,WAAW,KAAKb,KAA6B,MAI1EkB,IAAeC,GAAwBjC,GAAgBE,EAAY,OAAO,GAC1EgC,IAAeR,EAAS,IAAI,CAAAlB,OAAM,EAAE,OAAOA,EAAE,OAAO,OAAOA,EAAE,KAAA,EAAO,GACpE2B,IAAgBR,EAAS,IAAI,CAAAS,OAAM;AAAA,IACvC,OAAOA,EAAE;AAAA,IACT,OAAOA,EAAE,UAAUA,EAAE;AAAA,EAAA,EACrB,GAEIC,IAAiB;AAAA,IACrB,OAAOC,EAAYN,EAAa,OAAOE,GAAcR,CAAQ;AAAA,IAC7D,UAAUY,EAAYN,EAAa,UAAUG,GAAeR,CAAQ;AAAA,IACpE,YAAYK,EAAa;AAAA,IACzB,aAAaA,EAAa;AAAA,IAC1B,kBAAkBA,EAAa;AAAA,IAC/B,kBAAkBA,EAAa;AAAA,IAC/B,QAAQA,EAAa;AAAA,IACrB,eAAeM;AAAA,MACbN,EAAa;AAAA,MACb,CAAC,GAAGrD,EAAsB;AAAA,MAC1B,CAAC,GAAGE,EAAsB;AAAA,IAAA;AAAA,EAC5B,GAKI0D,IAAW,YAAgE;AAC/E,QAAIC;AAEJ,iBAAM,IAAI,QAAc,CAAAC,MAAW;AACjC,MAAKvC,EAAY;AAAA,QACf,OAAOwC,MAA6C;AAClD,gBAAMtB,EAAkBsB,GAAM,OAAMC,MAAW;AAC7C,kBAAMC,IAAe;AAAA,cACnB,OAAOD,EAAQ;AAAA,cACf,eAAeA,EAAQ;AAAA,cACvB,UAAUA,EAAQ;AAAA;AAAA;AAAA,cAGlB,YAAYA,EAAQ,cAAc;AAAA,cAClC,aAAaA,EAAQ,eAAe;AAAA,cACpC,kBAAkBA,EAAQ,oBAAoB;AAAA,YAAA,GAG1CE,IAAc,mBAAmBD,EAAa,cAAc,EAAE,IAC9DE,IAAY,OAAOH,EAAQ,MAAM,GACjCI,IACJJ,EAAQ,mBAAmB,IAAI,OAAOA,EAAQ,gBAAgB,IAAI,MAE9DK,IAAc;AAAA,cAClB,QAAQ;AAAA,cACR,QAAQF;AAAA,cACR,aAAAD;AAAA,cACA,cAAc;AAAA,cACd,iBAAiB;AAAA,cACjB,OAAO;AAAA,cACP,oBAAoB;AAAA,cACpB,kBAAkBE;AAAA,cAClB,WAAW;AAAA,cACX,cAAAH;AAAA,YAAA;AAGF,gBAAIK;AAEJ,gBAAI7D;AAIF,cAAA6D,KAHe,MAAMlC,EAA0B,YAAY;AAAA,gBACzD,SAAS,EAAE,YAAAhC,GAAY,oBAAoBiE,EAAA;AAAA,cAAY,CACxD,GACgB;AAAA,iBACZ;AACL,kBAAI,CAACpD;AACH,sBAAM,IAAIsD;AAAA,kBACR;AAAA,gBAAA;AAYJ,cAAAD,KATe,MAAMhC,EAA0B,YAAY;AAAA,gBACzD,SAAS;AAAA,kBACP,eAAerB,EAAiB;AAAA,kBAChC,0BAA0B;AAAA,oBACxB,GAAGoD;AAAA,oBACH,SAASpD,EAAiB;AAAA,kBAAA;AAAA,gBAC5B;AAAA,cACF,CACD,GACgB;AAAA,YACnB;AAEA,gBAAI,CAACqD;AACH,oBAAM,IAAIC;AAAA,gBACR9D,IACI,4CACA;AAAA,cAAA;AAIR,YAAAoD,IAAe;AAAA,cACb,MAAMpD,IAAe,WAAW;AAAA,cAChC,MAAM6D;AAAA,YAAA;AAAA,UAEV,CAAC,GACDR,EAAA;AAAA,QACF;AAAA,QACA,MAAM;AACJ,UAAAA,EAAA;AAAA,QACF;AAAA,MAAA,EACF;AAAA,IACF,CAAC,GAEMD;AAAA,EACT,GAEMW,IAAoBC,GAAqBlD,CAAW;AAE1D,SAAIZ,EAAgB,YACX,EAAE,WAAW,IAAe,eAAAkC,EAAA,IAEjC,CAACpC,KAAgBM,EAAsB,YAClC,EAAE,WAAW,IAAe,eAAA8B,EAAA,IAG9B;AAAA,IACL,WAAW;AAAA,IACX,MAAM;AAAA,MACJ,UAAAE;AAAA,MACA,UAAAC;AAAA,MACA,WAAW/B;AAAA,IAAA;AAAA,IAEb,QAAQ;AAAA,MACN,WAAAuB;AAAA,MACA,MAAM/B,IAAe,WAAW;AAAA,MAChC,gBAAgBmB;AAAA,MAChB,yBAAyBA,GAAoB,yBAAyB;AAAA,MACtE,kBAAAsB;AAAA,IAAA;AAAA,IAEF,SAAS,EAAE,UAAAU,EAAA;AAAA,IACX,eAAAf;AAAA,IACA,MAAM;AAAA,MACJ,QAAQ;AAAA,QACN,OAAO6B;AAAA,QACP,UAAUtB,IAAwBuB,KAAgB;AAAA,QAClD,YAAYzB,EAAiB,IAAI,aAAa,IAAI0B,KAAkB;AAAA,QACpE,aAAa1B,EAAiB,IAAI,cAAc,IAAI2B,KAAmB;AAAA,QACvE,kBAAkB3B,EAAiB,IAAI,mBAAmB,IACtD4B,KACA;AAAA,QACJ,kBAAkBC;AAAA,QAClB,QAAQC;AAAA,QACR,eAAeC;AAAA,MAAA;AAAA,MAEjB,gBAAAvB;AAAA,MACA,mBAAAc;AAAA,MACA,yBAAyBU,GAA8B3D,GAAaH,CAAM;AAAA,IAAA;AAAA,EAC5E;AAEJ;"}

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

@@ -1,9 +1,20 @@
 import { z } from 'zod';
 import { OptionalFieldsToRequire } from '../../../../../partner-hook-utils/form/buildFormSchema';
+/**
+ * Validation error codes emitted by the deduction form schema. Map these
+ * codes to localized copy in `validationMessages` when composing the hook.
+ *
+ * @public
+ */
 export declare const DeductionFormErrorCodes: {
     readonly REQUIRED: "REQUIRED";
     readonly NEGATIVE_AMOUNT: "NEGATIVE_AMOUNT";
 };
+/**
+ * Union of validation error code strings emitted by the deduction form schema.
+ *
+ * @public
+ */
 export type DeductionFormErrorCode = (typeof DeductionFormErrorCodes)[keyof typeof DeductionFormErrorCodes];
 declare const fieldValidators: {
     description: z.ZodString;
@@ -22,16 +33,32 @@ declare const fieldValidators: {
         readonly OtherGarnishment: "other_garnishment";
     }>;
 };
-export type DeductionFormField = keyof typeof fieldValidators;
+/**
+ * Shape of the values managed by the deduction form.
+ *
+ * @public
+ */
 export type DeductionFormData = {
     [K in keyof typeof fieldValidators]: z.infer<(typeof fieldValidators)[K]>;
 };
+/**
+ * Shape of the validated values produced by the deduction form on submit.
+ *
+ * @public
+ */
 export type DeductionFormOutputs = DeductionFormData;
 declare const requiredFieldsConfig: {
     totalAmount: "never";
     annualMaximum: "never";
 };
+/**
+ * Keys of optional deduction fields that can be promoted to required via the
+ * hook's `optionalFieldsToRequire` option.
+ *
+ * @public
+ */
 export type DeductionFormOptionalFieldsToRequire = OptionalFieldsToRequire<typeof requiredFieldsConfig>;
+/** @internal */
 interface DeductionFormSchemaOptions {
     mode?: 'create' | 'update';
     /**
@@ -43,6 +70,7 @@ interface DeductionFormSchemaOptions {
     courtOrdered: boolean;
     optionalFieldsToRequire?: DeductionFormOptionalFieldsToRequire;
 }
+/** @internal */
 export declare function createDeductionFormSchema(options: DeductionFormSchemaOptions): import('../../../../../partner-hook-utils/form/buildFormSchema').BuildFormSchemaResult<{
     description: z.ZodString;
     recurring: z.ZodPipe<z.ZodTransform<boolean | undefined, unknown>, z.ZodBoolean>;

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

@@ -1 +1 @@
-{"version":3,"file":"deductionFormSchema.js","sources":["../../../../../../src/components/Employee/Deductions/shared/useDeductionForm/deductionFormSchema.ts"],"sourcesContent":["import { z } from 'zod'\nimport { GarnishmentType } from '@gusto/embedded-api-v-2025-11-15/models/components/garnishment'\nimport {\n  buildFormSchema,\n  type RequiredFieldConfig,\n  type OptionalFieldsToRequire,\n} from '@/partner-hook-utils/form/buildFormSchema'\nimport { coerceNaN, coerceStringBoolean } from '@/partner-hook-utils/form/preprocessors'\n\n// ── Error codes ────────────────────────────────────────────────────────\n\nexport const DeductionFormErrorCodes = {\n  REQUIRED: 'REQUIRED',\n  NEGATIVE_AMOUNT: 'NEGATIVE_AMOUNT',\n} as const\n\nexport type DeductionFormErrorCode =\n  (typeof DeductionFormErrorCodes)[keyof typeof DeductionFormErrorCodes]\n\n// ── Field validators ───────────────────────────────────────────────────\n\nconst fieldValidators = {\n  description: z.string(),\n  // Radio groups deliver `'true'`/`'false'` strings; coerce to boolean for the\n  // submit payload. Matches the useJobForm pattern.\n  recurring: z.preprocess(coerceStringBoolean, z.boolean()),\n  deductAsPercentage: z.preprocess(coerceStringBoolean, z.boolean()),\n  // Currency / percent input. NumberInputField writes `number | undefined`;\n  // coerce to a numeric so .min(0) runs reliably. The number-to-string\n  // conversion the garnishment API expects happens inside the hook's onSubmit,\n  // so the form value stays a number end-to-end (input === output).\n  amount: z.preprocess(\n    coerceNaN(0),\n    z.number().min(0, { message: DeductionFormErrorCodes.NEGATIVE_AMOUNT }),\n  ),\n  // Optional caps. The hook drops them to `null` on the wire when 0 — matches\n  // the legacy DeductionSchema's \"0 means no cap\" behavior.\n  totalAmount: z.preprocess(\n    coerceNaN(0),\n    z.number().min(0, { message: DeductionFormErrorCodes.NEGATIVE_AMOUNT }),\n  ),\n  annualMaximum: z.preprocess(\n    coerceNaN(0),\n    z.number().min(0, { message: DeductionFormErrorCodes.NEGATIVE_AMOUNT }),\n  ),\n  // Only used when `courtOrdered: true` — see `excludeFields` below.\n  garnishmentType: z.enum(GarnishmentType),\n}\n\nexport type DeductionFormField = keyof typeof fieldValidators\n\nexport type DeductionFormData = {\n  [K in keyof typeof fieldValidators]: z.infer<(typeof fieldValidators)[K]>\n}\n\nexport type DeductionFormOutputs = DeductionFormData\n\n// ── Required fields config ─────────────────────────────────────────────\n//\n// `description`, `recurring`, `deductAsPercentage`, `amount` are required by\n// default. `garnishmentType` is required only when present in the shape\n// (court-ordered branch). `totalAmount` and `annualMaximum` are caps the\n// partner can leave blank.\n\nconst requiredFieldsConfig = {\n  totalAmount: 'never',\n  annualMaximum: 'never',\n} satisfies RequiredFieldConfig<typeof fieldValidators>\n\nexport type DeductionFormOptionalFieldsToRequire = OptionalFieldsToRequire<\n  typeof requiredFieldsConfig\n>\n\ninterface DeductionFormSchemaOptions {\n  mode?: 'create' | 'update'\n  /**\n   * Court-ordered garnishments require `garnishmentType` (Federal Tax Lien,\n   * Student Loan, etc.). Non-court-ordered \"custom\" deductions don't carry a\n   * type — the field is excluded from the schema entirely, matching the legacy\n   * GarnishmentForm vs CustomDeductionForm split.\n   */\n  courtOrdered: boolean\n  optionalFieldsToRequire?: DeductionFormOptionalFieldsToRequire\n}\n\nexport function createDeductionFormSchema(options: DeductionFormSchemaOptions) {\n  const { mode = 'create', courtOrdered, optionalFieldsToRequire } = options\n\n  return buildFormSchema(fieldValidators, {\n    requiredFieldsConfig,\n    requiredErrorCode: DeductionFormErrorCodes.REQUIRED,\n    mode,\n    optionalFieldsToRequire,\n    excludeFields: courtOrdered ? [] : ['garnishmentType'],\n  })\n}\n"],"names":["DeductionFormErrorCodes","fieldValidators","z","coerceStringBoolean","coerceNaN","GarnishmentType","requiredFieldsConfig","createDeductionFormSchema","options","mode","courtOrdered","optionalFieldsToRequire","buildFormSchema"],"mappings":";;;;AAWO,MAAMA,IAA0B;AAAA,EACrC,UAAU;AAAA,EACV,iBAAiB;AACnB,GAOMC,IAAkB;AAAA,EACtB,aAAaC,EAAE,OAAA;AAAA;AAAA;AAAA,EAGf,WAAWA,EAAE,WAAWC,GAAqBD,EAAE,SAAS;AAAA,EACxD,oBAAoBA,EAAE,WAAWC,GAAqBD,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA,EAKjE,QAAQA,EAAE;AAAA,IACRE,EAAU,CAAC;AAAA,IACXF,EAAE,SAAS,IAAI,GAAG,EAAE,SAASF,EAAwB,gBAAA,CAAiB;AAAA,EAAA;AAAA;AAAA;AAAA,EAIxE,aAAaE,EAAE;AAAA,IACbE,EAAU,CAAC;AAAA,IACXF,EAAE,SAAS,IAAI,GAAG,EAAE,SAASF,EAAwB,gBAAA,CAAiB;AAAA,EAAA;AAAA,EAExE,eAAeE,EAAE;AAAA,IACfE,EAAU,CAAC;AAAA,IACXF,EAAE,SAAS,IAAI,GAAG,EAAE,SAASF,EAAwB,gBAAA,CAAiB;AAAA,EAAA;AAAA;AAAA,EAGxE,iBAAiBE,EAAE,KAAKG,CAAe;AACzC,GAiBMC,IAAuB;AAAA,EAC3B,aAAa;AAAA,EACb,eAAe;AACjB;AAkBO,SAASC,EAA0BC,GAAqC;AAC7E,QAAM,EAAE,MAAAC,IAAO,UAAU,cAAAC,GAAc,yBAAAC,MAA4BH;AAEnE,SAAOI,EAAgBX,GAAiB;AAAA,IACtC,sBAAAK;AAAA,IACA,mBAAmBN,EAAwB;AAAA,IAC3C,MAAAS;AAAA,IACA,yBAAAE;AAAA,IACA,eAAeD,IAAe,CAAA,IAAK,CAAC,iBAAiB;AAAA,EAAA,CACtD;AACH;"}
+{"version":3,"file":"deductionFormSchema.js","sources":["../../../../../../src/components/Employee/Deductions/shared/useDeductionForm/deductionFormSchema.ts"],"sourcesContent":["import { z } from 'zod'\nimport { GarnishmentType } from '@gusto/embedded-api-v-2025-11-15/models/components/garnishment'\nimport {\n  buildFormSchema,\n  type RequiredFieldConfig,\n  type OptionalFieldsToRequire,\n} from '@/partner-hook-utils/form/buildFormSchema'\nimport { coerceNaN, coerceStringBoolean } from '@/partner-hook-utils/form/preprocessors'\n\n// ── Error codes ────────────────────────────────────────────────────────\n\n/**\n * Validation error codes emitted by the deduction form schema. Map these\n * codes to localized copy in `validationMessages` when composing the hook.\n *\n * @public\n */\nexport const DeductionFormErrorCodes = {\n  REQUIRED: 'REQUIRED',\n  NEGATIVE_AMOUNT: 'NEGATIVE_AMOUNT',\n} as const\n\n/**\n * Union of validation error code strings emitted by the deduction form schema.\n *\n * @public\n */\nexport type DeductionFormErrorCode =\n  (typeof DeductionFormErrorCodes)[keyof typeof DeductionFormErrorCodes]\n\n// ── Field validators ───────────────────────────────────────────────────\n\nconst fieldValidators = {\n  description: z.string(),\n  // Radio groups deliver `'true'`/`'false'` strings; coerce to boolean for the\n  // submit payload. Matches the useJobForm pattern.\n  recurring: z.preprocess(coerceStringBoolean, z.boolean()),\n  deductAsPercentage: z.preprocess(coerceStringBoolean, z.boolean()),\n  // Currency / percent input. NumberInputField writes `number | undefined`;\n  // coerce to a numeric so .min(0) runs reliably. The number-to-string\n  // conversion the garnishment API expects happens inside the hook's onSubmit,\n  // so the form value stays a number end-to-end (input === output).\n  amount: z.preprocess(\n    coerceNaN(0),\n    z.number().min(0, { message: DeductionFormErrorCodes.NEGATIVE_AMOUNT }),\n  ),\n  // Optional caps. The hook drops them to `null` on the wire when 0 — matches\n  // the legacy DeductionSchema's \"0 means no cap\" behavior.\n  totalAmount: z.preprocess(\n    coerceNaN(0),\n    z.number().min(0, { message: DeductionFormErrorCodes.NEGATIVE_AMOUNT }),\n  ),\n  annualMaximum: z.preprocess(\n    coerceNaN(0),\n    z.number().min(0, { message: DeductionFormErrorCodes.NEGATIVE_AMOUNT }),\n  ),\n  // Only used when `courtOrdered: true` — see `excludeFields` below.\n  garnishmentType: z.enum(GarnishmentType),\n}\n\n/**\n * Shape of the values managed by the deduction form.\n *\n * @public\n */\nexport type DeductionFormData = {\n  [K in keyof typeof fieldValidators]: z.infer<(typeof fieldValidators)[K]>\n}\n\n/**\n * Shape of the validated values produced by the deduction form on submit.\n *\n * @public\n */\nexport type DeductionFormOutputs = DeductionFormData\n\n// ── Required fields config ─────────────────────────────────────────────\n//\n// `description`, `recurring`, `deductAsPercentage`, `amount` are required by\n// default. `garnishmentType` is required only when present in the shape\n// (court-ordered branch). `totalAmount` and `annualMaximum` are caps the\n// partner can leave blank.\n\nconst requiredFieldsConfig = {\n  totalAmount: 'never',\n  annualMaximum: 'never',\n} satisfies RequiredFieldConfig<typeof fieldValidators>\n\n/**\n * Keys of optional deduction fields that can be promoted to required via the\n * hook's `optionalFieldsToRequire` option.\n *\n * @public\n */\nexport type DeductionFormOptionalFieldsToRequire = OptionalFieldsToRequire<\n  typeof requiredFieldsConfig\n>\n\n/** @internal */\ninterface DeductionFormSchemaOptions {\n  mode?: 'create' | 'update'\n  /**\n   * Court-ordered garnishments require `garnishmentType` (Federal Tax Lien,\n   * Student Loan, etc.). Non-court-ordered \"custom\" deductions don't carry a\n   * type — the field is excluded from the schema entirely, matching the legacy\n   * GarnishmentForm vs CustomDeductionForm split.\n   */\n  courtOrdered: boolean\n  optionalFieldsToRequire?: DeductionFormOptionalFieldsToRequire\n}\n\n/** @internal */\nexport function createDeductionFormSchema(options: DeductionFormSchemaOptions) {\n  const { mode = 'create', courtOrdered, optionalFieldsToRequire } = options\n\n  return buildFormSchema(fieldValidators, {\n    requiredFieldsConfig,\n    requiredErrorCode: DeductionFormErrorCodes.REQUIRED,\n    mode,\n    optionalFieldsToRequire,\n    excludeFields: courtOrdered ? [] : ['garnishmentType'],\n  })\n}\n"],"names":["DeductionFormErrorCodes","fieldValidators","z","coerceStringBoolean","coerceNaN","GarnishmentType","requiredFieldsConfig","createDeductionFormSchema","options","mode","courtOrdered","optionalFieldsToRequire","buildFormSchema"],"mappings":";;;;AAiBO,MAAMA,IAA0B;AAAA,EACrC,UAAU;AAAA,EACV,iBAAiB;AACnB,GAYMC,IAAkB;AAAA,EACtB,aAAaC,EAAE,OAAA;AAAA;AAAA;AAAA,EAGf,WAAWA,EAAE,WAAWC,GAAqBD,EAAE,SAAS;AAAA,EACxD,oBAAoBA,EAAE,WAAWC,GAAqBD,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA,EAKjE,QAAQA,EAAE;AAAA,IACRE,EAAU,CAAC;AAAA,IACXF,EAAE,SAAS,IAAI,GAAG,EAAE,SAASF,EAAwB,gBAAA,CAAiB;AAAA,EAAA;AAAA;AAAA;AAAA,EAIxE,aAAaE,EAAE;AAAA,IACbE,EAAU,CAAC;AAAA,IACXF,EAAE,SAAS,IAAI,GAAG,EAAE,SAASF,EAAwB,gBAAA,CAAiB;AAAA,EAAA;AAAA,EAExE,eAAeE,EAAE;AAAA,IACfE,EAAU,CAAC;AAAA,IACXF,EAAE,SAAS,IAAI,GAAG,EAAE,SAASF,EAAwB,gBAAA,CAAiB;AAAA,EAAA;AAAA;AAAA,EAGxE,iBAAiBE,EAAE,KAAKG,CAAe;AACzC,GAyBMC,IAAuB;AAAA,EAC3B,aAAa;AAAA,EACb,eAAe;AACjB;AA0BO,SAASC,EAA0BC,GAAqC;AAC7E,QAAM,EAAE,MAAAC,IAAO,UAAU,cAAAC,GAAc,yBAAAC,MAA4BH;AAEnE,SAAOI,EAAgBX,GAAiB;AAAA,IACtC,sBAAAK;AAAA,IACA,mBAAmBN,EAAwB;AAAA,IAC3C,MAAAS;AAAA,IACA,yBAAAE;AAAA,IACA,eAAeD,IAAe,CAAA,IAAK,CAAC,iBAAiB;AAAA,EAAA,CACtD;AACH;"}

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 { TextInputHookField as o } from "../../../../../partner-hook-utils/form/fields/TextInputHookField.js";
+import { SelectHookField as i } 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(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';