@gusto/embedded-react-sdk 0.44.2 → 0.46.0

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

@@ -0,0 +1,208 @@
+import { useMemo as u, useRef as Z, useEffect as q } from "react";
+import { useForm as ee, useWatch as te } from "react-hook-form";
+import { zodResolver as re } from "@hookform/resolvers/zod";
+import { PaymentPeriod as r } from "@gusto/embedded-api/models/components/garnishmentchildsupport";
+import { useGarnishmentsCreateMutation as oe } from "@gusto/embedded-api/react-query/garnishmentsCreate";
+import { useGarnishmentsUpdateMutation as ie } from "@gusto/embedded-api/react-query/garnishmentsUpdate";
+import { useGarnishmentsList as ne } from "@gusto/embedded-api/react-query/garnishmentsList";
+import { useGarnishmentsGetChildSupportData as ae } from "@gusto/embedded-api/react-query/garnishmentsGetChildSupportData";
+import { createChildSupportGarnishmentFormSchema as se, getRequiredAttrKeys as ue } from "./childSupportGarnishmentFormSchema.js";
+import { PaymentPeriodField as me, AmountField as de, PayPeriodMaximumField as ce, RemittanceNumberField as le, OrderNumberField as pe, CaseNumberField as he, FipsCodeField as be, StateField as fe } from "./fields.js";
+import { useDeriveFieldsMetadata as ye } from "../../../../../partner-hook-utils/form/useDeriveFieldsMetadata.js";
+import { useHookFormInternals as Pe } from "../../../../../partner-hook-utils/form/useHookFormInternals.js";
+import { createGetFormSubmissionValues as Ne } from "../../../../../partner-hook-utils/form/getFormSubmissionValues.js";
+import { withOptions as M } from "../../../../../partner-hook-utils/form/withOptions.js";
+import { composeErrorHandler as ge } from "../../../../../partner-hook-utils/composeErrorHandler.js";
+import { useBaseSubmit as Se } from "../../../../Base/useBaseSubmit.js";
+import { SDKInternalError as k } from "../../../../../types/sdkError.js";
+const Me = [
+  { value: r.EveryWeek, label: r.EveryWeek },
+  { value: r.EveryOtherWeek, label: r.EveryOtherWeek },
+  { value: r.TwicePerMonth, label: r.TwicePerMonth },
+  { value: r.Monthly, label: r.Monthly }
+], Ce = [
+  r.EveryWeek,
+  r.EveryOtherWeek,
+  r.TwicePerMonth,
+  r.Monthly
+];
+function He({
+  employeeId: C,
+  garnishmentId: P,
+  defaultValues: i,
+  validationMode: V = "onSubmit",
+  shouldFocusError: W = !0
+}) {
+  const o = !P, v = o ? "create" : "update", d = ae({}), p = u(
+    () => d.data?.childSupportData?.agencies ?? [],
+    [d.data]
+  ), h = ne({ employeeId: C }, { enabled: !o }), t = u(() => o ? null : h.data?.garnishments?.find((e) => e.uuid === P) ?? null, [o, P, h.data]), F = u(
+    () => ({
+      state: t?.childSupport?.state ?? i?.state ?? "",
+      fipsCode: t?.childSupport?.fipsCode ?? i?.fipsCode ?? "",
+      caseNumber: t?.childSupport?.caseNumber ?? i?.caseNumber ?? "",
+      orderNumber: t?.childSupport?.orderNumber ?? i?.orderNumber ?? "",
+      remittanceNumber: t?.childSupport?.remittanceNumber ?? i?.remittanceNumber ?? "",
+      amount: t?.amount ? Number(t.amount) : i?.amount ?? 0,
+      payPeriodMaximum: t?.payPeriodMaximum ? Number(t.payPeriodMaximum) : i?.payPeriodMaximum ?? 0,
+      paymentPeriod: t?.childSupport?.paymentPeriod ?? i?.paymentPeriod ?? r.Monthly
+    }),
+    [t, i]
+  ), [E, L] = u(
+    () => se({ mode: v }),
+    [v]
+  ), n = ee({
+    resolver: re(E),
+    mode: V,
+    shouldFocusError: W,
+    defaultValues: F,
+    values: F,
+    resetOptions: { keepDirtyValues: !0 }
+  }), c = te({ control: n.control, name: "state" }), m = u(
+    () => p.find((e) => e.state === c) ?? null,
+    [p, c]
+  ), R = Z(null);
+  q(() => {
+    const e = R.current;
+    R.current = c, e !== null && e !== "" && e !== c && (n.setValue("caseNumber", ""), n.setValue("orderNumber", ""), n.setValue("remittanceNumber", ""));
+  }, [c]);
+  const N = m?.fipsCodes ?? [], b = N.length === 1 && !N[0]?.county?.length ? N[0]?.code ?? null : null;
+  q(() => {
+    b && n.setValue("fipsCode", b);
+  }, [b]);
+  const O = oe(), w = ie(), T = O.isPending || w.isPending, {
+    baseSubmitHandler: _,
+    error: I,
+    setError: H
+  } = Se("ChildSupportGarnishmentForm"), g = ge(
+    o ? [d] : [d, h],
+    { submitError: I, setSubmitError: H }
+  ), S = u(
+    () => p.map((e) => ({
+      state: e.state ?? "",
+      name: e.name ?? e.state ?? "",
+      manualPaymentRequired: e.manualPaymentRequired ?? !1
+    })),
+    [p]
+  ), l = u(
+    () => (m?.fipsCodes ?? []).filter((e) => typeof e.code == "string").map((e) => ({ fipsCode: e.code, county: e.county ?? null })),
+    [m]
+  ), f = u(
+    () => ue(m),
+    [m]
+  ), K = l.length > 1 || l.length === 1 && b == null, s = ye(L, n.control), B = S.map((e) => ({ value: e.state, label: e.name })), D = l.map((e) => ({
+    value: e.fipsCode,
+    label: e.county ?? e.fipsCode
+  })), Q = {
+    state: M(s.state, B, S),
+    fipsCode: M(s.fipsCode, D, l),
+    caseNumber: s.caseNumber,
+    orderNumber: s.orderNumber,
+    remittanceNumber: s.remittanceNumber,
+    payPeriodMaximum: s.payPeriodMaximum,
+    amount: s.amount,
+    paymentPeriod: M(
+      s.paymentPeriod,
+      [...Me],
+      [...Ce]
+    )
+  }, Y = async () => {
+    let e;
+    return await new Promise((x) => {
+      n.handleSubmit(
+        async (U) => {
+          await _(U, async (a) => {
+            const A = {
+              state: a.state,
+              paymentPeriod: a.paymentPeriod,
+              fipsCode: a.fipsCode,
+              // Empty strings collapse to null so the API persists "no value
+              // declared" rather than an empty case number.
+              caseNumber: a.caseNumber || null,
+              orderNumber: a.orderNumber || null,
+              remittanceNumber: a.remittanceNumber || null
+            }, $ = `Child Support - ${A.caseNumber ?? ""}`, j = String(a.amount), J = a.payPeriodMaximum > 0 ? String(a.payPeriodMaximum) : null, G = {
+              active: !0,
+              amount: j,
+              description: $,
+              courtOrdered: !0,
+              garnishmentType: "child_support",
+              times: null,
+              deductAsPercentage: !0,
+              payPeriodMaximum: J,
+              recurring: !0,
+              childSupport: A
+            };
+            let y;
+            if (o)
+              y = (await O.mutateAsync({
+                request: { employeeId: C, garnishmentRequest: G }
+              })).garnishment;
+            else {
+              if (!t)
+                throw new k(
+                  "Cannot update child-support deduction: no matching garnishment on file"
+                );
+              y = (await w.mutateAsync({
+                request: {
+                  garnishmentId: t.uuid,
+                  updateGarnishmentRequest: {
+                    ...G,
+                    version: t.version
+                  }
+                }
+              })).garnishment;
+            }
+            if (!y)
+              throw new k(
+                o ? "Child-support deduction creation failed" : "Child-support deduction update failed"
+              );
+            e = {
+              mode: o ? "create" : "update",
+              data: y
+            };
+          }), x();
+        },
+        () => {
+          x();
+        }
+      )();
+    }), e;
+  }, z = Pe(n);
+  return d.isLoading ? { isLoading: !0, errorHandling: g } : !o && h.isLoading ? { isLoading: !0, errorHandling: g } : {
+    isLoading: !1,
+    data: {
+      agencies: S,
+      counties: l,
+      deduction: t
+    },
+    status: {
+      isPending: T,
+      mode: o ? "create" : "update",
+      selectedAgency: m,
+      isManualPaymentRequired: m?.manualPaymentRequired ?? !1,
+      requiredAttrKeys: f
+    },
+    actions: { onSubmit: Y },
+    errorHandling: g,
+    form: {
+      Fields: {
+        State: fe,
+        FipsCode: K ? be : void 0,
+        CaseNumber: f.has("case_number") ? he : void 0,
+        OrderNumber: f.has("order_number") ? pe : void 0,
+        RemittanceNumber: f.has("remittance_number") ? le : void 0,
+        PayPeriodMaximum: ce,
+        Amount: de,
+        PaymentPeriod: me
+      },
+      fieldsMetadata: Q,
+      hookFormInternals: z,
+      getFormSubmissionValues: Ne(n, E)
+    }
+  };
+}
+export {
+  He as useChildSupportGarnishmentForm
+};
+//# sourceMappingURL=useChildSupportGarnishmentForm.js.map

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

@@ -0,0 +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/models/components/garnishment'\nimport type { Agencies } from '@gusto/embedded-api/models/components/childsupportdata'\nimport { PaymentPeriod } from '@gusto/embedded-api/models/components/garnishmentchildsupport'\nimport { useGarnishmentsCreateMutation } from '@gusto/embedded-api/react-query/garnishmentsCreate'\nimport { useGarnishmentsUpdateMutation } from '@gusto/embedded-api/react-query/garnishmentsUpdate'\nimport { useGarnishmentsList } from '@gusto/embedded-api/react-query/garnishmentsList'\nimport { useGarnishmentsGetChildSupportData } from '@gusto/embedded-api/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  // The schema is built statically here. The agency-attribute fields\n  // (`caseNumber`, `orderNumber`, `remittanceNumber`) are kept optional in the\n  // schema and surfaced as `isRequired` at the metadata level when the\n  // selected agency declares them in `required_attributes`. This matches the\n  // legacy ChildSupportForm, which also used a static schema and relied on the\n  // API to enforce missing-attribute validation. The hook's `requiredAttrKeys`\n  // status flag tells consumers which UI fields to mark required.\n  const [schema, metadataConfig] = useMemo(\n    () => createChildSupportGarnishmentFormSchema({ mode: schemaMode }),\n    [schemaMode],\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,GAU9B,CAACc,GAAQC,CAAc,IAAIP;AAAA,IAC/B,MAAMQ,GAAwC,EAAE,MAAMZ,GAAY;AAAA,IAClE,CAACA,CAAU;AAAA,EAAA,GAGPa,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

@@ -0,0 +1,63 @@
+import { z } from 'zod';
+import { OptionalFieldsToRequire } from '../../../../../partner-hook-utils/form/buildFormSchema';
+export declare const DeductionFormErrorCodes: {
+    readonly REQUIRED: "REQUIRED";
+    readonly NEGATIVE_AMOUNT: "NEGATIVE_AMOUNT";
+};
+export type DeductionFormErrorCode = (typeof DeductionFormErrorCodes)[keyof typeof DeductionFormErrorCodes];
+declare const fieldValidators: {
+    description: z.ZodString;
+    recurring: z.ZodPipe<z.ZodTransform<boolean | undefined, unknown>, z.ZodBoolean>;
+    deductAsPercentage: z.ZodPipe<z.ZodTransform<boolean | undefined, unknown>, z.ZodBoolean>;
+    amount: z.ZodPipe<z.ZodTransform<number, unknown>, z.ZodNumber>;
+    totalAmount: z.ZodPipe<z.ZodTransform<number, unknown>, z.ZodNumber>;
+    annualMaximum: z.ZodPipe<z.ZodTransform<number, unknown>, z.ZodNumber>;
+    garnishmentType: z.ZodEnum<{
+        readonly ChildSupport: "child_support";
+        readonly FederalTaxLien: "federal_tax_lien";
+        readonly StateTaxLien: "state_tax_lien";
+        readonly StudentLoan: "student_loan";
+        readonly CreditorGarnishment: "creditor_garnishment";
+        readonly FederalLoan: "federal_loan";
+        readonly OtherGarnishment: "other_garnishment";
+    }>;
+};
+export type DeductionFormField = keyof typeof fieldValidators;
+export type DeductionFormData = {
+    [K in keyof typeof fieldValidators]: z.infer<(typeof fieldValidators)[K]>;
+};
+export type DeductionFormOutputs = DeductionFormData;
+declare const requiredFieldsConfig: {
+    totalAmount: "never";
+    annualMaximum: "never";
+};
+export type DeductionFormOptionalFieldsToRequire = OptionalFieldsToRequire<typeof requiredFieldsConfig>;
+interface DeductionFormSchemaOptions {
+    mode?: 'create' | 'update';
+    /**
+     * Court-ordered garnishments require `garnishmentType` (Federal Tax Lien,
+     * Student Loan, etc.). Non-court-ordered "custom" deductions don't carry a
+     * type — the field is excluded from the schema entirely, matching the legacy
+     * GarnishmentForm vs CustomDeductionForm split.
+     */
+    courtOrdered: boolean;
+    optionalFieldsToRequire?: DeductionFormOptionalFieldsToRequire;
+}
+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>;
+    deductAsPercentage: z.ZodPipe<z.ZodTransform<boolean | undefined, unknown>, z.ZodBoolean>;
+    amount: z.ZodPipe<z.ZodTransform<number, unknown>, z.ZodNumber>;
+    totalAmount: z.ZodPipe<z.ZodTransform<number, unknown>, z.ZodNumber>;
+    annualMaximum: z.ZodPipe<z.ZodTransform<number, unknown>, z.ZodNumber>;
+    garnishmentType: z.ZodEnum<{
+        readonly ChildSupport: "child_support";
+        readonly FederalTaxLien: "federal_tax_lien";
+        readonly StateTaxLien: "state_tax_lien";
+        readonly StudentLoan: "student_loan";
+        readonly CreditorGarnishment: "creditor_garnishment";
+        readonly FederalLoan: "federal_loan";
+        readonly OtherGarnishment: "other_garnishment";
+    }>;
+}>;
+export {};

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

@@ -0,0 +1,52 @@
+import { z as e } from "zod";
+import { GarnishmentType as a } from "@gusto/embedded-api/models/components/garnishment";
+import { buildFormSchema as c } from "../../../../../partner-hook-utils/form/buildFormSchema.js";
+import { coerceNaN as o, coerceStringBoolean as n } from "../../../../../partner-hook-utils/form/preprocessors.js";
+const r = {
+  REQUIRED: "REQUIRED",
+  NEGATIVE_AMOUNT: "NEGATIVE_AMOUNT"
+}, u = {
+  description: e.string(),
+  // Radio groups deliver `'true'`/`'false'` strings; coerce to boolean for the
+  // submit payload. Matches the useJobForm pattern.
+  recurring: e.preprocess(n, e.boolean()),
+  deductAsPercentage: e.preprocess(n, e.boolean()),
+  // Currency / percent input. NumberInputField writes `number | undefined`;
+  // coerce to a numeric so .min(0) runs reliably. The number-to-string
+  // conversion the garnishment API expects happens inside the hook's onSubmit,
+  // so the form value stays a number end-to-end (input === output).
+  amount: e.preprocess(
+    o(0),
+    e.number().min(0, { message: r.NEGATIVE_AMOUNT })
+  ),
+  // Optional caps. The hook drops them to `null` on the wire when 0 — matches
+  // the legacy DeductionSchema's "0 means no cap" behavior.
+  totalAmount: e.preprocess(
+    o(0),
+    e.number().min(0, { message: r.NEGATIVE_AMOUNT })
+  ),
+  annualMaximum: e.preprocess(
+    o(0),
+    e.number().min(0, { message: r.NEGATIVE_AMOUNT })
+  ),
+  // Only used when `courtOrdered: true` — see `excludeFields` below.
+  garnishmentType: e.enum(a)
+}, p = {
+  totalAmount: "never",
+  annualMaximum: "never"
+};
+function A(m) {
+  const { mode: t = "create", courtOrdered: i, optionalFieldsToRequire: s } = m;
+  return c(u, {
+    requiredFieldsConfig: p,
+    requiredErrorCode: r.REQUIRED,
+    mode: t,
+    optionalFieldsToRequire: s,
+    excludeFields: i ? [] : ["garnishmentType"]
+  });
+}
+export {
+  r as DeductionFormErrorCodes,
+  A as createDeductionFormSchema
+};
+//# sourceMappingURL=deductionFormSchema.js.map

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

@@ -0,0 +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/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;"}

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

@@ -0,0 +1,25 @@
+import { GarnishmentType } from '@gusto/embedded-api/models/components/garnishment';
+import { DeductionFormErrorCodes } from './deductionFormSchema';
+import { TextInputHookFieldProps } from '../../../../../partner-hook-utils/form/fields/TextInputHookField';
+import { NumberInputHookFieldProps } from '../../../../../partner-hook-utils/form/fields/NumberInputHookField';
+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';
+export type RequiredValidation = typeof DeductionFormErrorCodes.REQUIRED;
+export type NegativeAmountValidation = typeof DeductionFormErrorCodes.NEGATIVE_AMOUNT;
+export type AmountValidation = RequiredValidation | NegativeAmountValidation;
+export type CapValidation = NegativeAmountValidation;
+export type DescriptionFieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>;
+export declare function DescriptionField(props: DescriptionFieldProps): import("react/jsx-runtime").JSX.Element;
+export type RecurringFieldProps = HookFieldProps<RadioGroupHookFieldProps<RequiredValidation, boolean>>;
+export declare function RecurringField(props: RecurringFieldProps): import("react/jsx-runtime").JSX.Element;
+export type DeductAsPercentageFieldProps = HookFieldProps<RadioGroupHookFieldProps<RequiredValidation, boolean>>;
+export declare function DeductAsPercentageField(props: DeductAsPercentageFieldProps): import("react/jsx-runtime").JSX.Element;
+export type AmountFieldProps = HookFieldProps<NumberInputHookFieldProps<AmountValidation>>;
+export declare function AmountField(props: AmountFieldProps): import("react/jsx-runtime").JSX.Element;
+export type TotalAmountFieldProps = HookFieldProps<NumberInputHookFieldProps<CapValidation>>;
+export declare function TotalAmountField(props: TotalAmountFieldProps): import("react/jsx-runtime").JSX.Element;
+export type AnnualMaximumFieldProps = HookFieldProps<NumberInputHookFieldProps<CapValidation>>;
+export declare function AnnualMaximumField(props: AnnualMaximumFieldProps): import("react/jsx-runtime").JSX.Element;
+export type GarnishmentTypeFieldProps = HookFieldProps<SelectHookFieldProps<RequiredValidation, GarnishmentType>>;
+export declare function GarnishmentTypeField(props: GarnishmentTypeFieldProps): import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,36 @@
+import { jsx as e } from "react/jsx-runtime";
+import { TextInputHookField as o } from "../../../../../partner-hook-utils/form/fields/TextInputHookField.js";
+import { SelectHookField as i } from "../../../../../partner-hook-utils/form/fields/SelectHookField.js";
+import { NumberInputHookField as t } from "../../../../../partner-hook-utils/form/fields/NumberInputHookField.js";
+import { RadioGroupHookField as r } from "../../../../../partner-hook-utils/form/fields/RadioGroupHookField.js";
+function l(n) {
+  return /* @__PURE__ */ e(o, { ...n, name: "description" });
+}
+function p(n) {
+  return /* @__PURE__ */ e(r, { ...n, name: "recurring" });
+}
+function f(n) {
+  return /* @__PURE__ */ e(r, { ...n, name: "deductAsPercentage" });
+}
+function F(n) {
+  return /* @__PURE__ */ e(t, { ...n, name: "amount" });
+}
+function s(n) {
+  return /* @__PURE__ */ e(t, { ...n, name: "totalAmount" });
+}
+function A(n) {
+  return /* @__PURE__ */ e(t, { ...n, name: "annualMaximum" });
+}
+function g(n) {
+  return /* @__PURE__ */ e(i, { ...n, name: "garnishmentType" });
+}
+export {
+  F as AmountField,
+  A as AnnualMaximumField,
+  f as DeductAsPercentageField,
+  l as DescriptionField,
+  g as GarnishmentTypeField,
+  p as RecurringField,
+  s as TotalAmountField
+};
+//# sourceMappingURL=fields.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"fields.js","sources":["../../../../../../src/components/Employee/Deductions/shared/useDeductionForm/fields.tsx"],"sourcesContent":["import type { GarnishmentType } from '@gusto/embedded-api/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;"}

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

@@ -0,0 +1,4 @@
+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 type { RequiredValidation as DeductionFormRequiredValidation, NegativeAmountValidation as DeductionFormNegativeAmountValidation, AmountValidation as DeductionFormAmountValidation, CapValidation as DeductionFormCapValidation, DescriptionFieldProps, RecurringFieldProps, DeductAsPercentageFieldProps, AmountFieldProps, TotalAmountFieldProps, AnnualMaximumFieldProps, GarnishmentTypeFieldProps, } from './fields';

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

@@ -0,0 +1,64 @@
+import { UseFormProps } from 'react-hook-form';
+import { Garnishment } from '@gusto/embedded-api/models/components/garnishment';
+import { DeductionFormData, DeductionFormOptionalFieldsToRequire } from './deductionFormSchema';
+import { DescriptionField, RecurringField, DeductAsPercentageField, AmountField, TotalAmountField, AnnualMaximumField, GarnishmentTypeField } from './fields';
+import { BaseFormHookReady, FieldsMetadata, HookLoadingResult, HookSubmitResult } from '../../../../../partner-hook-utils/types';
+export type { DeductionFormOptionalFieldsToRequire } from './deductionFormSchema';
+export interface UseDeductionFormProps {
+    employeeId: string;
+    /**
+     * When set, loads that garnishment via the list query and updates it (PUT).
+     * When omitted, the form is in create mode (POST).
+     */
+    garnishmentId?: string;
+    /**
+     * Court-ordered deductions are stored as garnishments with `courtOrdered:
+     * true` and require a `garnishmentType` (Federal Tax Lien, Student Loan,
+     * etc.). When `false`, the form is for a "custom" post-tax deduction —
+     * `garnishmentType` is excluded from the schema and submit payload.
+     *
+     * Note: this hook does NOT handle `garnishmentType: 'child_support'`. Use
+     * `useChildSupportGarnishmentForm` for child-support agency-keyed payloads.
+     */
+    courtOrdered: boolean;
+    optionalFieldsToRequire?: DeductionFormOptionalFieldsToRequire;
+    defaultValues?: Partial<DeductionFormData>;
+    validationMode?: UseFormProps['mode'];
+    shouldFocusError?: boolean;
+}
+export interface DeductionFormFields {
+    Description: typeof DescriptionField;
+    Recurring: typeof RecurringField;
+    DeductAsPercentage: typeof DeductAsPercentageField;
+    Amount: typeof AmountField;
+    /** Only available when `status.isRecurring` is true. */
+    TotalAmount: typeof TotalAmountField | undefined;
+    /** Only available when `status.isRecurring` is true. */
+    AnnualMaximum: typeof AnnualMaximumField | undefined;
+    /** Only available when `courtOrdered: true`. */
+    GarnishmentType: typeof GarnishmentTypeField | undefined;
+}
+export interface UseDeductionFormReady extends BaseFormHookReady<FieldsMetadata, DeductionFormData, DeductionFormFields> {
+    data: {
+        /** The garnishment loaded for update; `null` in create mode. */
+        deduction: Garnishment | null;
+    };
+    status: {
+        isPending: boolean;
+        mode: 'create' | 'update';
+        /**
+         * Mirrors the watched `recurring` value. Cap fields (`TotalAmount`,
+         * `AnnualMaximum`) are only included on `Fields` when this is true — the
+         * consumer can render them unconditionally and the gating happens in the
+         * hook.
+         */
+        isRecurring: boolean;
+    };
+    actions: {
+        onSubmit: () => Promise<HookSubmitResult<Garnishment> | undefined>;
+    };
+}
+export type UseDeductionFormResult = HookLoadingResult | UseDeductionFormReady;
+export declare function useDeductionForm({ employeeId, garnishmentId, courtOrdered, optionalFieldsToRequire, defaultValues: partnerDefaults, validationMode, shouldFocusError, }: UseDeductionFormProps): UseDeductionFormResult;
+export type DeductionFormFieldsMetadata = UseDeductionFormReady['form']['fieldsMetadata'];
+export type DeductionFormFieldsType = UseDeductionFormReady['form']['Fields'];