@gusto/embedded-react-sdk 0.47.0 → 0.48.0

package/dist/components/Employee/StateTaxes/shared/useEmployeeStateTaxesForm/employeeStateTaxesSchema.d.ts

@@ -1,26 +1,57 @@
 import { z } from 'zod';
 import { EmployeeStateTaxesList } from '@gusto/embedded-api-v-2025-11-15/models/components/employeestatetaxeslist';
-import { EmployeeStateTaxQuestion } from '@gusto/embedded-api-v-2025-11-15/models/components/employeestatetaxquestion';
 import { StateTaxQuestionVariant } from './fieldMapping';
 import { FieldsMetadataConfig } from '../../../../../partner-hook-utils/form/buildFormSchema';
 /**
- * The state-taxes form only surfaces a single error code: `REQUIRED`. Field
- * values are stored as `z.unknown()` in the schema; the bundled UI components
- * emit type-correct values and the submit serializer handles edge cases, so
- * any "invalid" input is treated as empty and lands on `REQUIRED`.
+ * Validation error codes produced by the {@link useEmployeeStateTaxesForm} schema.
+ *
+ * @remarks
+ * Use these constants as the keys in a field's `validationMessages` prop to
+ * map an error code to a user-facing message. The state-taxes form surfaces
+ * only a single error code: every required field that is empty emits
+ * `REQUIRED`.
+ *
+ * @public
  */
 export declare const EmployeeStateTaxesErrorCodes: {
     readonly REQUIRED: "REQUIRED";
 };
+/**
+ * Union of validation error code strings emitted by the employee state taxes
+ * form schema.
+ *
+ * @public
+ */
 export type EmployeeStateTaxesErrorCode = (typeof EmployeeStateTaxesErrorCodes)[keyof typeof EmployeeStateTaxesErrorCodes];
+/**
+ * Union of value types a single state-tax answer may hold in the form. The
+ * shape depends on the API-provided question variant.
+ *
+ * @public
+ */
 export type StateTaxValue = string | number | boolean | Date | null | undefined;
+/**
+ * Shape of the values managed by the employee state taxes form. Keyed by
+ * two-letter state code, then by question key (camelCased from the API key).
+ *
+ * @public
+ */
 export interface EmployeeStateTaxesFormData {
+    /** Per-state answer map: state code → (camelCased question key → value). */
     states: Record<string, Record<string, StateTaxValue>>;
 }
+/**
+ * Shape of the validated values produced by the employee state taxes form on
+ * submit.
+ *
+ * @public
+ */
 export type EmployeeStateTaxesFormOutputs = EmployeeStateTaxesFormData;
+/** @internal */
 export interface EmployeeStateTaxesSchemaOptions {
     isAdmin?: boolean;
 }
+/** @internal */
 export interface EmployeeStateTaxesQuestionMeta {
     state: string;
     isWorkState: boolean;
@@ -30,6 +61,7 @@ export interface EmployeeStateTaxesQuestionMeta {
     isAdminOnly: boolean;
     isWireSelectWithBooleanOptions: boolean;
 }
+/** @internal */
 export interface EmployeeStateTaxesMetadataConfig extends FieldsMetadataConfig<Record<string, z.ZodType>> {
     /** Group → questions, in API response order, post admin-filtering. */
     groups: Array<{
@@ -38,19 +70,10 @@ export interface EmployeeStateTaxesMetadataConfig extends FieldsMetadataConfig<R
         questions: EmployeeStateTaxesQuestionMeta[];
     }>;
 }
+/** @internal */
 export type EmployeeStateTaxesSchemaResult = [
     schema: z.ZodType<EmployeeStateTaxesFormData, EmployeeStateTaxesFormData>,
     metadataConfig: EmployeeStateTaxesMetadataConfig
 ];
-/**
- * Builds a Zod schema and metadata config for a dynamic state-taxes form.
- *
- * Schema shape: `{ states: { [state]: { [camelKey]: value } } }` where the
- * inner record's keys mirror each API question's `key` after camelCasing.
- *
- * Required fields are tracked via `superRefine` (mirrors `buildFormSchema`'s
- * approach for static-shape forms). Admin-only questions are excluded from
- * both schema and metadata when `isAdmin=false`.
- */
+/** @internal */
 export declare function createEmployeeStateTaxesSchema(employeeStateTaxes: EmployeeStateTaxesList[], options?: EmployeeStateTaxesSchemaOptions): EmployeeStateTaxesSchemaResult;
-export type EmployeeStateTaxesQuestion = EmployeeStateTaxQuestion;

package/dist/components/Employee/StateTaxes/shared/useEmployeeStateTaxesForm/employeeStateTaxesSchema.js.map

@@ -1 +1 @@
-{"version":3,"file":"employeeStateTaxesSchema.js","sources":["../../../../../../src/components/Employee/StateTaxes/shared/useEmployeeStateTaxesForm/employeeStateTaxesSchema.ts"],"sourcesContent":["import { z } from 'zod'\nimport type { EmployeeStateTaxesList } from '@gusto/embedded-api-v-2025-11-15/models/components/employeestatetaxeslist'\nimport type { EmployeeStateTaxQuestion } from '@gusto/embedded-api-v-2025-11-15/models/components/employeestatetaxquestion'\nimport { getQuestionVariant, type StateTaxQuestionVariant } from './fieldMapping'\nimport { snakeCaseToCamelCase } from '@/helpers/formattedStrings'\nimport type {\n  FieldMetadata,\n  FieldMetadataWithOptions,\n  FieldsMetadata,\n} from '@/partner-hook-utils/types'\nimport type { FieldsMetadataConfig } from '@/partner-hook-utils/form/buildFormSchema'\n\n// ── Error codes ────────────────────────────────────────────────────────\n\n/**\n * The state-taxes form only surfaces a single error code: `REQUIRED`. Field\n * values are stored as `z.unknown()` in the schema; the bundled UI components\n * emit type-correct values and the submit serializer handles edge cases, so\n * any \"invalid\" input is treated as empty and lands on `REQUIRED`.\n */\nexport const EmployeeStateTaxesErrorCodes = {\n  REQUIRED: 'REQUIRED',\n} as const\n\nexport type EmployeeStateTaxesErrorCode =\n  (typeof EmployeeStateTaxesErrorCodes)[keyof typeof EmployeeStateTaxesErrorCodes]\n\n// ── Form data shape ────────────────────────────────────────────────────\n\nexport type StateTaxValue = string | number | boolean | Date | null | undefined\n\nexport interface EmployeeStateTaxesFormData {\n  states: Record<string, Record<string, StateTaxValue>>\n}\n\nexport type EmployeeStateTaxesFormOutputs = EmployeeStateTaxesFormData\n\n// ── Empty-value detection ──────────────────────────────────────────────\n\n/**\n * State-taxes fields are typed as `z.unknown()` in the schema and validated\n * for emptiness in `superRefine`. The bundled UI components only emit\n * type-correct values (NumberInput → number | undefined, DatePicker → Date |\n * undefined, etc.) and the submit serializer normalizes NaN / invalid Dates\n * to empty strings before hitting the API, so a per-variant Zod validator\n * would only fire for adversarial inputs that aren't reachable through the UI.\n */\nfunction isEmpty(value: unknown): boolean {\n  if (value === undefined || value === null) return true\n  if (typeof value === 'string' && value.trim() === '') return true\n  if (typeof value === 'number' && Number.isNaN(value)) return true\n  if (value instanceof Date && Number.isNaN(value.getTime())) return true\n  return false\n}\n\n// ── Schema factory ─────────────────────────────────────────────────────\n\nexport interface EmployeeStateTaxesSchemaOptions {\n  isAdmin?: boolean\n}\n\ninterface QuestionOption {\n  value: string | number | boolean\n  label: string\n}\n\ninterface QuestionEntry {\n  apiKey: string\n  formKey: string\n  fullPath: string\n  variant: StateTaxQuestionVariant\n  options?: QuestionOption[]\n  isAdminOnly: boolean\n  /** Server-provided answer at hook initialization. Used to compute the\n   *  `file_new_hire_report` lock-once-set rule. */\n  initialValue: unknown\n}\n\nexport interface EmployeeStateTaxesQuestionMeta {\n  state: string\n  isWorkState: boolean\n  apiKey: string\n  formKey: string\n  variant: StateTaxQuestionVariant\n  isAdminOnly: boolean\n  isWireSelectWithBooleanOptions: boolean\n}\n\nexport interface EmployeeStateTaxesMetadataConfig extends FieldsMetadataConfig<\n  Record<string, z.ZodType>\n> {\n  /** Group → questions, in API response order, post admin-filtering. */\n  groups: Array<{\n    state: string\n    isWorkState: boolean\n    questions: EmployeeStateTaxesQuestionMeta[]\n  }>\n}\n\nexport type EmployeeStateTaxesSchemaResult = [\n  schema: z.ZodType<EmployeeStateTaxesFormData, EmployeeStateTaxesFormData>,\n  metadataConfig: EmployeeStateTaxesMetadataConfig,\n]\n\n/**\n * Builds a Zod schema and metadata config for a dynamic state-taxes form.\n *\n * Schema shape: `{ states: { [state]: { [camelKey]: value } } }` where the\n * inner record's keys mirror each API question's `key` after camelCasing.\n *\n * Required fields are tracked via `superRefine` (mirrors `buildFormSchema`'s\n * approach for static-shape forms). Admin-only questions are excluded from\n * both schema and metadata when `isAdmin=false`.\n */\nexport function createEmployeeStateTaxesSchema(\n  employeeStateTaxes: EmployeeStateTaxesList[],\n  options: EmployeeStateTaxesSchemaOptions = {},\n): EmployeeStateTaxesSchemaResult {\n  const { isAdmin = false } = options\n\n  const groupEntries: Array<{\n    state: string\n    isWorkState: boolean\n    questions: QuestionEntry[]\n  }> = []\n\n  for (const stateGroup of employeeStateTaxes) {\n    if (!stateGroup.state || !stateGroup.questions) continue\n\n    const visibleQuestions: QuestionEntry[] = []\n    for (const question of stateGroup.questions) {\n      if (question.isQuestionForAdminOnly && !isAdmin) continue\n      const formKey = snakeCaseToCamelCase(question.key)\n      const fullPath = `states.${stateGroup.state}.${formKey}`\n      visibleQuestions.push({\n        apiKey: question.key,\n        formKey,\n        fullPath,\n        variant: getQuestionVariant(question),\n        options: normalizeOptions(question.inputQuestionFormat.options),\n        isAdminOnly: question.isQuestionForAdminOnly,\n        initialValue: question.answers[0]?.value,\n      })\n    }\n\n    groupEntries.push({\n      state: stateGroup.state,\n      isWorkState: Boolean(stateGroup.isWorkState),\n      questions: visibleQuestions,\n    })\n  }\n\n  const statesShape: Record<string, z.ZodType> = {}\n  for (const group of groupEntries) {\n    const innerShape: Record<string, z.ZodType> = {}\n    for (const entry of group.questions) {\n      innerShape[entry.formKey] = z.unknown()\n    }\n    statesShape[group.state] = z.object(innerShape).optional()\n  }\n\n  const baseSchema = z.object({\n    states: z.object(statesShape),\n  })\n\n  const refined = baseSchema.superRefine((data, ctx) => {\n    for (const group of groupEntries) {\n      const stateValues = data.states[group.state] ?? {}\n      for (const entry of group.questions) {\n        const value = (stateValues as Record<string, unknown>)[entry.formKey]\n        if (isEmpty(value)) {\n          ctx.addIssue({\n            code: z.ZodIssueCode.custom,\n            path: ['states', group.state, entry.formKey],\n            message: EmployeeStateTaxesErrorCodes.REQUIRED,\n          })\n        }\n      }\n    }\n  })\n\n  const schema = refined as unknown as z.ZodType<\n    EmployeeStateTaxesFormData,\n    EmployeeStateTaxesFormData\n  >\n\n  const groupsForMetadata = groupEntries.map(g => ({\n    state: g.state,\n    isWorkState: g.isWorkState,\n    questions: g.questions.map(q => ({\n      state: g.state,\n      isWorkState: g.isWorkState,\n      apiKey: q.apiKey,\n      formKey: q.formKey,\n      variant: q.variant,\n      isAdminOnly: q.isAdminOnly,\n      isWireSelectWithBooleanOptions: isWireSelectWithBooleanOptions(q.options),\n    })),\n  }))\n\n  function getFieldsMetadata(): FieldsMetadata {\n    const metadata: FieldsMetadata = {}\n    for (const group of groupEntries) {\n      for (const entry of group.questions) {\n        const base: FieldMetadata = {\n          name: entry.fullPath,\n          isRequired: true,\n        }\n\n        if (isLockedOnceSet(entry.apiKey, entry.initialValue)) {\n          base.isDisabled = true\n        }\n\n        if (entry.options && entry.options.length > 0) {\n          const withOptions: FieldMetadataWithOptions = {\n            ...base,\n            options: entry.options.map(opt => ({\n              value: String(opt.value),\n              label: opt.label,\n            })),\n          }\n          metadata[entry.fullPath] = withOptions\n        } else {\n          metadata[entry.fullPath] = base\n        }\n      }\n    }\n    return metadata\n  }\n\n  /**\n   * Mirrors the existing `TaxInputs.tsx` rule for `file_new_hire_report`:\n   * once a value has been recorded server-side, the question is locked.\n   */\n  function isLockedOnceSet(apiKey: string, initialValue: unknown): boolean {\n    if (apiKey !== 'file_new_hire_report') return false\n    return initialValue !== undefined && initialValue !== null\n  }\n\n  return [\n    schema,\n    {\n      getFieldsMetadata,\n      predicateDeps: [],\n      groups: groupsForMetadata,\n    } as EmployeeStateTaxesMetadataConfig,\n  ]\n}\n\nfunction isWireSelectWithBooleanOptions(options: QuestionOption[] | undefined): boolean {\n  if (!options || options.length === 0) return false\n  return options.every(opt => typeof opt.value === 'boolean')\n}\n\nfunction normalizeOptions(\n  options:\n    | Array<{ value?: string | number | boolean | undefined; label?: string | undefined }>\n    | undefined,\n): QuestionOption[] | undefined {\n  if (!options) return undefined\n  const result: QuestionOption[] = []\n  for (const opt of options) {\n    if (opt.value === undefined || opt.label === undefined) continue\n    result.push({ value: opt.value, label: opt.label })\n  }\n  return result.length > 0 ? result : undefined\n}\n\nexport type EmployeeStateTaxesQuestion = EmployeeStateTaxQuestion\n"],"names":["EmployeeStateTaxesErrorCodes","isEmpty","value","createEmployeeStateTaxesSchema","employeeStateTaxes","options","isAdmin","groupEntries","stateGroup","visibleQuestions","question","formKey","snakeCaseToCamelCase","fullPath","getQuestionVariant","normalizeOptions","statesShape","group","innerShape","entry","z","schema","data","ctx","stateValues","groupsForMetadata","g","q","isWireSelectWithBooleanOptions","getFieldsMetadata","metadata","base","isLockedOnceSet","withOptions","opt","apiKey","initialValue","result"],"mappings":";;;AAoBO,MAAMA,IAA+B;AAAA,EAC1C,UAAU;AACZ;AAyBA,SAASC,EAAQC,GAAyB;AAIxC,SAHI,GAAuBA,KAAU,QACjC,OAAOA,KAAU,YAAYA,EAAM,KAAA,MAAW,MAC9C,OAAOA,KAAU,YAAY,OAAO,MAAMA,CAAK,KAC/CA,aAAiB,QAAQ,OAAO,MAAMA,EAAM,QAAA,CAAS;AAE3D;AA6DO,SAASC,EACdC,GACAC,IAA2C,IACX;AAChC,QAAM,EAAE,SAAAC,IAAU,GAAA,IAAUD,GAEtBE,IAID,CAAA;AAEL,aAAWC,KAAcJ,GAAoB;AAC3C,QAAI,CAACI,EAAW,SAAS,CAACA,EAAW,UAAW;AAEhD,UAAMC,IAAoC,CAAA;AAC1C,eAAWC,KAAYF,EAAW,WAAW;AAC3C,UAAIE,EAAS,0BAA0B,CAACJ,EAAS;AACjD,YAAMK,IAAUC,EAAqBF,EAAS,GAAG,GAC3CG,IAAW,UAAUL,EAAW,KAAK,IAAIG,CAAO;AACtD,MAAAF,EAAiB,KAAK;AAAA,QACpB,QAAQC,EAAS;AAAA,QACjB,SAAAC;AAAA,QACA,UAAAE;AAAA,QACA,SAASC,EAAmBJ,CAAQ;AAAA,QACpC,SAASK,EAAiBL,EAAS,oBAAoB,OAAO;AAAA,QAC9D,aAAaA,EAAS;AAAA,QACtB,cAAcA,EAAS,QAAQ,CAAC,GAAG;AAAA,MAAA,CACpC;AAAA,IACH;AAEA,IAAAH,EAAa,KAAK;AAAA,MAChB,OAAOC,EAAW;AAAA,MAClB,aAAa,EAAQA,EAAW;AAAA,MAChC,WAAWC;AAAA,IAAA,CACZ;AAAA,EACH;AAEA,QAAMO,IAAyC,CAAA;AAC/C,aAAWC,KAASV,GAAc;AAChC,UAAMW,IAAwC,CAAA;AAC9C,eAAWC,KAASF,EAAM;AACxB,MAAAC,EAAWC,EAAM,OAAO,IAAIC,EAAE,QAAA;AAEhC,IAAAJ,EAAYC,EAAM,KAAK,IAAIG,EAAE,OAAOF,CAAU,EAAE,SAAA;AAAA,EAClD;AAsBA,QAAMG,IApBaD,EAAE,OAAO;AAAA,IAC1B,QAAQA,EAAE,OAAOJ,CAAW;AAAA,EAAA,CAC7B,EAE0B,YAAY,CAACM,GAAMC,MAAQ;AACpD,eAAWN,KAASV,GAAc;AAChC,YAAMiB,IAAcF,EAAK,OAAOL,EAAM,KAAK,KAAK,CAAA;AAChD,iBAAWE,KAASF,EAAM,WAAW;AACnC,cAAMf,IAASsB,EAAwCL,EAAM,OAAO;AACpE,QAAIlB,EAAQC,CAAK,KACfqB,EAAI,SAAS;AAAA,UACX,MAAMH,EAAE,aAAa;AAAA,UACrB,MAAM,CAAC,UAAUH,EAAM,OAAOE,EAAM,OAAO;AAAA,UAC3C,SAASnB,EAA6B;AAAA,QAAA,CACvC;AAAA,MAEL;AAAA,IACF;AAAA,EACF,CAAC,GAOKyB,IAAoBlB,EAAa,IAAI,CAAAmB,OAAM;AAAA,IAC/C,OAAOA,EAAE;AAAA,IACT,aAAaA,EAAE;AAAA,IACf,WAAWA,EAAE,UAAU,IAAI,CAAAC,OAAM;AAAA,MAC/B,OAAOD,EAAE;AAAA,MACT,aAAaA,EAAE;AAAA,MACf,QAAQC,EAAE;AAAA,MACV,SAASA,EAAE;AAAA,MACX,SAASA,EAAE;AAAA,MACX,aAAaA,EAAE;AAAA,MACf,gCAAgCC,EAA+BD,EAAE,OAAO;AAAA,IAAA,EACxE;AAAA,EAAA,EACF;AAEF,WAASE,IAAoC;AAC3C,UAAMC,IAA2B,CAAA;AACjC,eAAWb,KAASV;AAClB,iBAAWY,KAASF,EAAM,WAAW;AACnC,cAAMc,IAAsB;AAAA,UAC1B,MAAMZ,EAAM;AAAA,UACZ,YAAY;AAAA,QAAA;AAOd,YAJIa,EAAgBb,EAAM,QAAQA,EAAM,YAAY,MAClDY,EAAK,aAAa,KAGhBZ,EAAM,WAAWA,EAAM,QAAQ,SAAS,GAAG;AAC7C,gBAAMc,IAAwC;AAAA,YAC5C,GAAGF;AAAA,YACH,SAASZ,EAAM,QAAQ,IAAI,CAAAe,OAAQ;AAAA,cACjC,OAAO,OAAOA,EAAI,KAAK;AAAA,cACvB,OAAOA,EAAI;AAAA,YAAA,EACX;AAAA,UAAA;AAEJ,UAAAJ,EAASX,EAAM,QAAQ,IAAIc;AAAA,QAC7B;AACE,UAAAH,EAASX,EAAM,QAAQ,IAAIY;AAAA,MAE/B;AAEF,WAAOD;AAAA,EACT;AAMA,WAASE,EAAgBG,GAAgBC,GAAgC;AACvE,WAAID,MAAW,yBAA+B,KACTC,KAAiB;AAAA,EACxD;AAEA,SAAO;AAAA,IACLf;AAAA,IACA;AAAA,MACE,mBAAAQ;AAAA,MACA,eAAe,CAAA;AAAA,MACf,QAAQJ;AAAA,IAAA;AAAA,EACV;AAEJ;AAEA,SAASG,EAA+BvB,GAAgD;AACtF,SAAI,CAACA,KAAWA,EAAQ,WAAW,IAAU,KACtCA,EAAQ,MAAM,CAAA6B,MAAO,OAAOA,EAAI,SAAU,SAAS;AAC5D;AAEA,SAASnB,EACPV,GAG8B;AAC9B,MAAI,CAACA,EAAS;AACd,QAAMgC,IAA2B,CAAA;AACjC,aAAWH,KAAO7B;AAChB,IAAI6B,EAAI,UAAU,UAAaA,EAAI,UAAU,UAC7CG,EAAO,KAAK,EAAE,OAAOH,EAAI,OAAO,OAAOA,EAAI,OAAO;AAEpD,SAAOG,EAAO,SAAS,IAAIA,IAAS;AACtC;"}
+{"version":3,"file":"employeeStateTaxesSchema.js","sources":["../../../../../../src/components/Employee/StateTaxes/shared/useEmployeeStateTaxesForm/employeeStateTaxesSchema.ts"],"sourcesContent":["import { z } from 'zod'\nimport type { EmployeeStateTaxesList } from '@gusto/embedded-api-v-2025-11-15/models/components/employeestatetaxeslist'\nimport { getQuestionVariant, type StateTaxQuestionVariant } from './fieldMapping'\nimport { snakeCaseToCamelCase } from '@/helpers/formattedStrings'\nimport type {\n  FieldMetadata,\n  FieldMetadataWithOptions,\n  FieldsMetadata,\n} from '@/partner-hook-utils/types'\nimport type { FieldsMetadataConfig } from '@/partner-hook-utils/form/buildFormSchema'\n\n// ── Error codes ────────────────────────────────────────────────────────\n\n/**\n * Validation error codes produced by the {@link useEmployeeStateTaxesForm} schema.\n *\n * @remarks\n * Use these constants as the keys in a field's `validationMessages` prop to\n * map an error code to a user-facing message. The state-taxes form surfaces\n * only a single error code: every required field that is empty emits\n * `REQUIRED`.\n *\n * @public\n */\nexport const EmployeeStateTaxesErrorCodes = {\n  REQUIRED: 'REQUIRED',\n} as const\n\n/**\n * Union of validation error code strings emitted by the employee state taxes\n * form schema.\n *\n * @public\n */\nexport type EmployeeStateTaxesErrorCode =\n  (typeof EmployeeStateTaxesErrorCodes)[keyof typeof EmployeeStateTaxesErrorCodes]\n\n// ── Form data shape ────────────────────────────────────────────────────\n\n/**\n * Union of value types a single state-tax answer may hold in the form. The\n * shape depends on the API-provided question variant.\n *\n * @public\n */\nexport type StateTaxValue = string | number | boolean | Date | null | undefined\n\n/**\n * Shape of the values managed by the employee state taxes form. Keyed by\n * two-letter state code, then by question key (camelCased from the API key).\n *\n * @public\n */\nexport interface EmployeeStateTaxesFormData {\n  /** Per-state answer map: state code → (camelCased question key → value). */\n  states: Record<string, Record<string, StateTaxValue>>\n}\n\n/**\n * Shape of the validated values produced by the employee state taxes form on\n * submit.\n *\n * @public\n */\nexport type EmployeeStateTaxesFormOutputs = EmployeeStateTaxesFormData\n\n// ── Empty-value detection ──────────────────────────────────────────────\n\n/**\n * State-taxes fields are typed as `z.unknown()` in the schema and validated\n * for emptiness in `superRefine`. The bundled UI components only emit\n * type-correct values (NumberInput → number | undefined, DatePicker → Date |\n * undefined, etc.) and the submit serializer normalizes NaN / invalid Dates\n * to empty strings before hitting the API, so a per-variant Zod validator\n * would only fire for adversarial inputs that aren't reachable through the UI.\n */\nfunction isEmpty(value: unknown): boolean {\n  if (value === undefined || value === null) return true\n  if (typeof value === 'string' && value.trim() === '') return true\n  if (typeof value === 'number' && Number.isNaN(value)) return true\n  if (value instanceof Date && Number.isNaN(value.getTime())) return true\n  return false\n}\n\n// ── Schema factory ─────────────────────────────────────────────────────\n\n/** @internal */\nexport interface EmployeeStateTaxesSchemaOptions {\n  isAdmin?: boolean\n}\n\ninterface QuestionOption {\n  value: string | number | boolean\n  label: string\n}\n\ninterface QuestionEntry {\n  apiKey: string\n  formKey: string\n  fullPath: string\n  variant: StateTaxQuestionVariant\n  options?: QuestionOption[]\n  isAdminOnly: boolean\n  /** Server-provided answer at hook initialization. Used to compute the\n   *  `file_new_hire_report` lock-once-set rule. */\n  initialValue: unknown\n}\n\n/** @internal */\nexport interface EmployeeStateTaxesQuestionMeta {\n  state: string\n  isWorkState: boolean\n  apiKey: string\n  formKey: string\n  variant: StateTaxQuestionVariant\n  isAdminOnly: boolean\n  isWireSelectWithBooleanOptions: boolean\n}\n\n/** @internal */\nexport interface EmployeeStateTaxesMetadataConfig extends FieldsMetadataConfig<\n  Record<string, z.ZodType>\n> {\n  /** Group → questions, in API response order, post admin-filtering. */\n  groups: Array<{\n    state: string\n    isWorkState: boolean\n    questions: EmployeeStateTaxesQuestionMeta[]\n  }>\n}\n\n/** @internal */\nexport type EmployeeStateTaxesSchemaResult = [\n  schema: z.ZodType<EmployeeStateTaxesFormData, EmployeeStateTaxesFormData>,\n  metadataConfig: EmployeeStateTaxesMetadataConfig,\n]\n\n/** @internal */\nexport function createEmployeeStateTaxesSchema(\n  employeeStateTaxes: EmployeeStateTaxesList[],\n  options: EmployeeStateTaxesSchemaOptions = {},\n): EmployeeStateTaxesSchemaResult {\n  const { isAdmin = false } = options\n\n  const groupEntries: Array<{\n    state: string\n    isWorkState: boolean\n    questions: QuestionEntry[]\n  }> = []\n\n  for (const stateGroup of employeeStateTaxes) {\n    if (!stateGroup.state || !stateGroup.questions) continue\n\n    const visibleQuestions: QuestionEntry[] = []\n    for (const question of stateGroup.questions) {\n      if (question.isQuestionForAdminOnly && !isAdmin) continue\n      const formKey = snakeCaseToCamelCase(question.key)\n      const fullPath = `states.${stateGroup.state}.${formKey}`\n      visibleQuestions.push({\n        apiKey: question.key,\n        formKey,\n        fullPath,\n        variant: getQuestionVariant(question),\n        options: normalizeOptions(question.inputQuestionFormat.options),\n        isAdminOnly: question.isQuestionForAdminOnly,\n        initialValue: question.answers[0]?.value,\n      })\n    }\n\n    groupEntries.push({\n      state: stateGroup.state,\n      isWorkState: Boolean(stateGroup.isWorkState),\n      questions: visibleQuestions,\n    })\n  }\n\n  const statesShape: Record<string, z.ZodType> = {}\n  for (const group of groupEntries) {\n    const innerShape: Record<string, z.ZodType> = {}\n    for (const entry of group.questions) {\n      innerShape[entry.formKey] = z.unknown()\n    }\n    statesShape[group.state] = z.object(innerShape).optional()\n  }\n\n  const baseSchema = z.object({\n    states: z.object(statesShape),\n  })\n\n  const refined = baseSchema.superRefine((data, ctx) => {\n    for (const group of groupEntries) {\n      const stateValues = data.states[group.state] ?? {}\n      for (const entry of group.questions) {\n        const value = (stateValues as Record<string, unknown>)[entry.formKey]\n        if (isEmpty(value)) {\n          ctx.addIssue({\n            code: z.ZodIssueCode.custom,\n            path: ['states', group.state, entry.formKey],\n            message: EmployeeStateTaxesErrorCodes.REQUIRED,\n          })\n        }\n      }\n    }\n  })\n\n  const schema = refined as unknown as z.ZodType<\n    EmployeeStateTaxesFormData,\n    EmployeeStateTaxesFormData\n  >\n\n  const groupsForMetadata = groupEntries.map(g => ({\n    state: g.state,\n    isWorkState: g.isWorkState,\n    questions: g.questions.map(q => ({\n      state: g.state,\n      isWorkState: g.isWorkState,\n      apiKey: q.apiKey,\n      formKey: q.formKey,\n      variant: q.variant,\n      isAdminOnly: q.isAdminOnly,\n      isWireSelectWithBooleanOptions: isWireSelectWithBooleanOptions(q.options),\n    })),\n  }))\n\n  function getFieldsMetadata(): FieldsMetadata {\n    const metadata: FieldsMetadata = {}\n    for (const group of groupEntries) {\n      for (const entry of group.questions) {\n        const base: FieldMetadata = {\n          name: entry.fullPath,\n          isRequired: true,\n        }\n\n        if (isLockedOnceSet(entry.apiKey, entry.initialValue)) {\n          base.isDisabled = true\n        }\n\n        if (entry.options && entry.options.length > 0) {\n          const withOptions: FieldMetadataWithOptions = {\n            ...base,\n            options: entry.options.map(opt => ({\n              value: String(opt.value),\n              label: opt.label,\n            })),\n          }\n          metadata[entry.fullPath] = withOptions\n        } else {\n          metadata[entry.fullPath] = base\n        }\n      }\n    }\n    return metadata\n  }\n\n  /**\n   * Mirrors the existing `TaxInputs.tsx` rule for `file_new_hire_report`:\n   * once a value has been recorded server-side, the question is locked.\n   */\n  function isLockedOnceSet(apiKey: string, initialValue: unknown): boolean {\n    if (apiKey !== 'file_new_hire_report') return false\n    return initialValue !== undefined && initialValue !== null\n  }\n\n  return [\n    schema,\n    {\n      getFieldsMetadata,\n      predicateDeps: [],\n      groups: groupsForMetadata,\n    } as EmployeeStateTaxesMetadataConfig,\n  ]\n}\n\nfunction isWireSelectWithBooleanOptions(options: QuestionOption[] | undefined): boolean {\n  if (!options || options.length === 0) return false\n  return options.every(opt => typeof opt.value === 'boolean')\n}\n\nfunction normalizeOptions(\n  options:\n    | Array<{ value?: string | number | boolean | undefined; label?: string | undefined }>\n    | undefined,\n): QuestionOption[] | undefined {\n  if (!options) return undefined\n  const result: QuestionOption[] = []\n  for (const opt of options) {\n    if (opt.value === undefined || opt.label === undefined) continue\n    result.push({ value: opt.value, label: opt.label })\n  }\n  return result.length > 0 ? result : undefined\n}\n"],"names":["EmployeeStateTaxesErrorCodes","isEmpty","value","createEmployeeStateTaxesSchema","employeeStateTaxes","options","isAdmin","groupEntries","stateGroup","visibleQuestions","question","formKey","snakeCaseToCamelCase","fullPath","getQuestionVariant","normalizeOptions","statesShape","group","innerShape","entry","z","schema","data","ctx","stateValues","groupsForMetadata","g","q","isWireSelectWithBooleanOptions","getFieldsMetadata","metadata","base","isLockedOnceSet","withOptions","opt","apiKey","initialValue","result"],"mappings":";;;AAwBO,MAAMA,IAA+B;AAAA,EAC1C,UAAU;AACZ;AAkDA,SAASC,EAAQC,GAAyB;AAIxC,SAHI,GAAuBA,KAAU,QACjC,OAAOA,KAAU,YAAYA,EAAM,KAAA,MAAW,MAC9C,OAAOA,KAAU,YAAY,OAAO,MAAMA,CAAK,KAC/CA,aAAiB,QAAQ,OAAO,MAAMA,EAAM,QAAA,CAAS;AAE3D;AAwDO,SAASC,EACdC,GACAC,IAA2C,IACX;AAChC,QAAM,EAAE,SAAAC,IAAU,GAAA,IAAUD,GAEtBE,IAID,CAAA;AAEL,aAAWC,KAAcJ,GAAoB;AAC3C,QAAI,CAACI,EAAW,SAAS,CAACA,EAAW,UAAW;AAEhD,UAAMC,IAAoC,CAAA;AAC1C,eAAWC,KAAYF,EAAW,WAAW;AAC3C,UAAIE,EAAS,0BAA0B,CAACJ,EAAS;AACjD,YAAMK,IAAUC,EAAqBF,EAAS,GAAG,GAC3CG,IAAW,UAAUL,EAAW,KAAK,IAAIG,CAAO;AACtD,MAAAF,EAAiB,KAAK;AAAA,QACpB,QAAQC,EAAS;AAAA,QACjB,SAAAC;AAAA,QACA,UAAAE;AAAA,QACA,SAASC,EAAmBJ,CAAQ;AAAA,QACpC,SAASK,EAAiBL,EAAS,oBAAoB,OAAO;AAAA,QAC9D,aAAaA,EAAS;AAAA,QACtB,cAAcA,EAAS,QAAQ,CAAC,GAAG;AAAA,MAAA,CACpC;AAAA,IACH;AAEA,IAAAH,EAAa,KAAK;AAAA,MAChB,OAAOC,EAAW;AAAA,MAClB,aAAa,EAAQA,EAAW;AAAA,MAChC,WAAWC;AAAA,IAAA,CACZ;AAAA,EACH;AAEA,QAAMO,IAAyC,CAAA;AAC/C,aAAWC,KAASV,GAAc;AAChC,UAAMW,IAAwC,CAAA;AAC9C,eAAWC,KAASF,EAAM;AACxB,MAAAC,EAAWC,EAAM,OAAO,IAAIC,EAAE,QAAA;AAEhC,IAAAJ,EAAYC,EAAM,KAAK,IAAIG,EAAE,OAAOF,CAAU,EAAE,SAAA;AAAA,EAClD;AAsBA,QAAMG,IApBaD,EAAE,OAAO;AAAA,IAC1B,QAAQA,EAAE,OAAOJ,CAAW;AAAA,EAAA,CAC7B,EAE0B,YAAY,CAACM,GAAMC,MAAQ;AACpD,eAAWN,KAASV,GAAc;AAChC,YAAMiB,IAAcF,EAAK,OAAOL,EAAM,KAAK,KAAK,CAAA;AAChD,iBAAWE,KAASF,EAAM,WAAW;AACnC,cAAMf,IAASsB,EAAwCL,EAAM,OAAO;AACpE,QAAIlB,EAAQC,CAAK,KACfqB,EAAI,SAAS;AAAA,UACX,MAAMH,EAAE,aAAa;AAAA,UACrB,MAAM,CAAC,UAAUH,EAAM,OAAOE,EAAM,OAAO;AAAA,UAC3C,SAASnB,EAA6B;AAAA,QAAA,CACvC;AAAA,MAEL;AAAA,IACF;AAAA,EACF,CAAC,GAOKyB,IAAoBlB,EAAa,IAAI,CAAAmB,OAAM;AAAA,IAC/C,OAAOA,EAAE;AAAA,IACT,aAAaA,EAAE;AAAA,IACf,WAAWA,EAAE,UAAU,IAAI,CAAAC,OAAM;AAAA,MAC/B,OAAOD,EAAE;AAAA,MACT,aAAaA,EAAE;AAAA,MACf,QAAQC,EAAE;AAAA,MACV,SAASA,EAAE;AAAA,MACX,SAASA,EAAE;AAAA,MACX,aAAaA,EAAE;AAAA,MACf,gCAAgCC,EAA+BD,EAAE,OAAO;AAAA,IAAA,EACxE;AAAA,EAAA,EACF;AAEF,WAASE,IAAoC;AAC3C,UAAMC,IAA2B,CAAA;AACjC,eAAWb,KAASV;AAClB,iBAAWY,KAASF,EAAM,WAAW;AACnC,cAAMc,IAAsB;AAAA,UAC1B,MAAMZ,EAAM;AAAA,UACZ,YAAY;AAAA,QAAA;AAOd,YAJIa,EAAgBb,EAAM,QAAQA,EAAM,YAAY,MAClDY,EAAK,aAAa,KAGhBZ,EAAM,WAAWA,EAAM,QAAQ,SAAS,GAAG;AAC7C,gBAAMc,IAAwC;AAAA,YAC5C,GAAGF;AAAA,YACH,SAASZ,EAAM,QAAQ,IAAI,CAAAe,OAAQ;AAAA,cACjC,OAAO,OAAOA,EAAI,KAAK;AAAA,cACvB,OAAOA,EAAI;AAAA,YAAA,EACX;AAAA,UAAA;AAEJ,UAAAJ,EAASX,EAAM,QAAQ,IAAIc;AAAA,QAC7B;AACE,UAAAH,EAASX,EAAM,QAAQ,IAAIY;AAAA,MAE/B;AAEF,WAAOD;AAAA,EACT;AAMA,WAASE,EAAgBG,GAAgBC,GAAgC;AACvE,WAAID,MAAW,yBAA+B,KACTC,KAAiB;AAAA,EACxD;AAEA,SAAO;AAAA,IACLf;AAAA,IACA;AAAA,MACE,mBAAAQ;AAAA,MACA,eAAe,CAAA;AAAA,MACf,QAAQJ;AAAA,IAAA;AAAA,EACV;AAEJ;AAEA,SAASG,EAA+BvB,GAAgD;AACtF,SAAI,CAACA,KAAWA,EAAQ,WAAW,IAAU,KACtCA,EAAQ,MAAM,CAAA6B,MAAO,OAAOA,EAAI,SAAU,SAAS;AAC5D;AAEA,SAASnB,EACPV,GAG8B;AAC9B,MAAI,CAACA,EAAS;AACd,QAAMgC,IAA2B,CAAA;AACjC,aAAWH,KAAO7B;AAChB,IAAI6B,EAAI,UAAU,UAAaA,EAAI,UAAU,UAC7CG,EAAO,KAAK,EAAE,OAAOH,EAAI,OAAO,OAAOA,EAAI,OAAO;AAEpD,SAAOG,EAAO,SAAS,IAAIA,IAAS;AACtC;"}

package/dist/components/Employee/StateTaxes/shared/useEmployeeStateTaxesForm/fieldComponents.d.ts

@@ -3,10 +3,16 @@ import { CurrencyStateTaxFieldProps, DateStateTaxFieldProps, NumberStateTaxField
 interface MetaProps {
     meta: BoundFieldMeta;
 }
+/** @internal */
 export declare function SelectStateTaxField({ meta, ...props }: MetaProps & SelectStateTaxFieldProps): import("react").JSX.Element;
+/** @internal */
 export declare function RadioStateTaxField({ meta, ...props }: MetaProps & RadioStateTaxFieldProps): import("react").JSX.Element;
+/** @internal */
 export declare function TextStateTaxField({ meta, ...props }: MetaProps & TextStateTaxFieldProps): import("react").JSX.Element;
+/** @internal */
 export declare function NumberStateTaxField({ meta, ...props }: MetaProps & NumberStateTaxFieldProps): import("react").JSX.Element;
+/** @internal */
 export declare function CurrencyStateTaxField({ meta, ...props }: MetaProps & CurrencyStateTaxFieldProps): import("react").JSX.Element;
+/** @internal */
 export declare function DateStateTaxField({ meta, ...props }: MetaProps & DateStateTaxFieldProps): import("react").JSX.Element;
 export {};

package/dist/components/Employee/StateTaxes/shared/useEmployeeStateTaxesForm/fieldComponents.js.map

@@ -1 +1 @@
-{"version":3,"file":"fieldComponents.js","sources":["../../../../../../src/components/Employee/StateTaxes/shared/useEmployeeStateTaxesForm/fieldComponents.tsx"],"sourcesContent":["import type { ReactNode } from 'react'\nimport { useTranslation } from 'react-i18next'\nimport { EmployeeStateTaxesErrorCodes } from './employeeStateTaxesSchema'\nimport type { BoundFieldMeta } from './fieldMeta'\nimport type {\n  BaseStateTaxFieldProps,\n  CurrencyStateTaxFieldProps,\n  DateStateTaxFieldProps,\n  NumberStateTaxFieldProps,\n  RadioStateTaxFieldProps,\n  SelectStateTaxFieldProps,\n  StateTaxValidationMessages,\n  TextStateTaxFieldProps,\n} from './fieldProps'\nimport {\n  SelectHookField,\n  RadioGroupHookField,\n  TextInputHookField,\n  NumberInputHookField,\n  DatePickerHookField,\n} from '@/partner-hook-utils/form/fields'\nimport type { SelectHookFieldProps } from '@/partner-hook-utils/form/fields/SelectHookField'\nimport type { RadioGroupHookFieldProps } from '@/partner-hook-utils/form/fields/RadioGroupHookField'\nimport type { TextInputHookFieldProps } from '@/partner-hook-utils/form/fields/TextInputHookField'\nimport type { NumberInputHookFieldProps } from '@/partner-hook-utils/form/fields/NumberInputHookField'\nimport type { DatePickerHookFieldProps } from '@/partner-hook-utils/form/fields/DatePickerHookField'\nimport type { FormHookResult } from '@/partner-hook-utils/types'\n\ninterface MetaProps {\n  meta: BoundFieldMeta\n}\n\nfunction useStateTaxValidationDefaults(): StateTaxValidationMessages {\n  const { t } = useTranslation('Employee.StateTaxesView')\n  return { [EmployeeStateTaxesErrorCodes.REQUIRED]: t('validations.required') }\n}\n\nfunction useResolvedBaseProps(\n  meta: BoundFieldMeta,\n  props: BaseStateTaxFieldProps,\n): {\n  name: string\n  label: string\n  description: ReactNode\n  formHookResult: FormHookResult | undefined\n  validationMessages: StateTaxValidationMessages\n} {\n  const defaults = useStateTaxValidationDefaults()\n  return {\n    name: meta.name,\n    label: props.label ?? meta.apiLabel,\n    description: props.description !== undefined ? props.description : meta.apiDescription,\n    formHookResult: props.formHookResult,\n    validationMessages: { ...defaults, ...props.validationMessages },\n  }\n}\n\nexport function SelectStateTaxField({ meta, ...props }: MetaProps & SelectStateTaxFieldProps) {\n  const base = useResolvedBaseProps(meta, props)\n  const hookProps: SelectHookFieldProps<typeof EmployeeStateTaxesErrorCodes.REQUIRED> = {\n    ...base,\n    placeholder: props.placeholder,\n    FieldComponent: props.FieldComponent,\n  }\n  return <SelectHookField {...hookProps} />\n}\n\nexport function RadioStateTaxField({ meta, ...props }: MetaProps & RadioStateTaxFieldProps) {\n  const base = useResolvedBaseProps(meta, props)\n  const hookProps: RadioGroupHookFieldProps<typeof EmployeeStateTaxesErrorCodes.REQUIRED> = {\n    ...base,\n    FieldComponent: props.FieldComponent,\n  }\n  return <RadioGroupHookField {...hookProps} />\n}\n\nexport function TextStateTaxField({ meta, ...props }: MetaProps & TextStateTaxFieldProps) {\n  const base = useResolvedBaseProps(meta, props)\n  const hookProps: TextInputHookFieldProps<typeof EmployeeStateTaxesErrorCodes.REQUIRED> = {\n    ...base,\n    placeholder: props.placeholder,\n  }\n  return <TextInputHookField {...hookProps} />\n}\n\nexport function NumberStateTaxField({ meta, ...props }: MetaProps & NumberStateTaxFieldProps) {\n  const base = useResolvedBaseProps(meta, props)\n  const hookProps: NumberInputHookFieldProps<typeof EmployeeStateTaxesErrorCodes.REQUIRED> = {\n    ...base,\n    format: 'decimal',\n    FieldComponent: props.FieldComponent,\n  }\n  return <NumberInputHookField {...hookProps} />\n}\n\nexport function CurrencyStateTaxField({ meta, ...props }: MetaProps & CurrencyStateTaxFieldProps) {\n  const base = useResolvedBaseProps(meta, props)\n  const hookProps: NumberInputHookFieldProps<typeof EmployeeStateTaxesErrorCodes.REQUIRED> = {\n    ...base,\n    format: 'currency',\n    FieldComponent: props.FieldComponent,\n  }\n  return <NumberInputHookField {...hookProps} />\n}\n\nexport function DateStateTaxField({ meta, ...props }: MetaProps & DateStateTaxFieldProps) {\n  const base = useResolvedBaseProps(meta, props)\n  const hookProps: DatePickerHookFieldProps<typeof EmployeeStateTaxesErrorCodes.REQUIRED> = {\n    ...base,\n    FieldComponent: props.FieldComponent,\n  }\n  return <DatePickerHookField {...hookProps} />\n}\n"],"names":["useStateTaxValidationDefaults","t","useTranslation","EmployeeStateTaxesErrorCodes","useResolvedBaseProps","meta","props","defaults","SelectStateTaxField","hookProps","jsx","SelectHookField","RadioStateTaxField","RadioGroupHookField","TextStateTaxField","TextInputHookField","NumberStateTaxField","NumberInputHookField","CurrencyStateTaxField","DateStateTaxField","DatePickerHookField"],"mappings":";;;;;;;;AAgCA,SAASA,IAA4D;AACnE,QAAM,EAAE,GAAAC,EAAA,IAAMC,EAAe,yBAAyB;AACtD,SAAO,EAAE,CAACC,EAA6B,QAAQ,GAAGF,EAAE,sBAAsB,EAAA;AAC5E;AAEA,SAASG,EACPC,GACAC,GAOA;AACA,QAAMC,IAAWP,EAAA;AACjB,SAAO;AAAA,IACL,MAAMK,EAAK;AAAA,IACX,OAAOC,EAAM,SAASD,EAAK;AAAA,IAC3B,aAAaC,EAAM,gBAAgB,SAAYA,EAAM,cAAcD,EAAK;AAAA,IACxE,gBAAgBC,EAAM;AAAA,IACtB,oBAAoB,EAAE,GAAGC,GAAU,GAAGD,EAAM,mBAAA;AAAA,EAAmB;AAEnE;AAEO,SAASE,EAAoB,EAAE,MAAAH,GAAM,GAAGC,KAA+C;AAE5F,QAAMG,IAAgF;AAAA,IACpF,GAFWL,EAAqBC,GAAMC,CAAK;AAAA,IAG3C,aAAaA,EAAM;AAAA,IACnB,gBAAgBA,EAAM;AAAA,EAAA;AAExB,SAAO,gBAAAI,EAACC,GAAA,EAAiB,GAAGF,EAAA,CAAW;AACzC;AAEO,SAASG,EAAmB,EAAE,MAAAP,GAAM,GAAGC,KAA8C;AAE1F,QAAMG,IAAoF;AAAA,IACxF,GAFWL,EAAqBC,GAAMC,CAAK;AAAA,IAG3C,gBAAgBA,EAAM;AAAA,EAAA;AAExB,SAAO,gBAAAI,EAACG,GAAA,EAAqB,GAAGJ,EAAA,CAAW;AAC7C;AAEO,SAASK,EAAkB,EAAE,MAAAT,GAAM,GAAGC,KAA6C;AAExF,QAAMG,IAAmF;AAAA,IACvF,GAFWL,EAAqBC,GAAMC,CAAK;AAAA,IAG3C,aAAaA,EAAM;AAAA,EAAA;AAErB,SAAO,gBAAAI,EAACK,GAAA,EAAoB,GAAGN,EAAA,CAAW;AAC5C;AAEO,SAASO,EAAoB,EAAE,MAAAX,GAAM,GAAGC,KAA+C;AAE5F,QAAMG,IAAqF;AAAA,IACzF,GAFWL,EAAqBC,GAAMC,CAAK;AAAA,IAG3C,QAAQ;AAAA,IACR,gBAAgBA,EAAM;AAAA,EAAA;AAExB,SAAO,gBAAAI,EAACO,GAAA,EAAsB,GAAGR,EAAA,CAAW;AAC9C;AAEO,SAASS,EAAsB,EAAE,MAAAb,GAAM,GAAGC,KAAiD;AAEhG,QAAMG,IAAqF;AAAA,IACzF,GAFWL,EAAqBC,GAAMC,CAAK;AAAA,IAG3C,QAAQ;AAAA,IACR,gBAAgBA,EAAM;AAAA,EAAA;AAExB,SAAO,gBAAAI,EAACO,GAAA,EAAsB,GAAGR,EAAA,CAAW;AAC9C;AAEO,SAASU,EAAkB,EAAE,MAAAd,GAAM,GAAGC,KAA6C;AAExF,QAAMG,IAAoF;AAAA,IACxF,GAFWL,EAAqBC,GAAMC,CAAK;AAAA,IAG3C,gBAAgBA,EAAM;AAAA,EAAA;AAExB,SAAO,gBAAAI,EAACU,GAAA,EAAqB,GAAGX,EAAA,CAAW;AAC7C;"}
+{"version":3,"file":"fieldComponents.js","sources":["../../../../../../src/components/Employee/StateTaxes/shared/useEmployeeStateTaxesForm/fieldComponents.tsx"],"sourcesContent":["import type { ReactNode } from 'react'\nimport { useTranslation } from 'react-i18next'\nimport { EmployeeStateTaxesErrorCodes } from './employeeStateTaxesSchema'\nimport type { BoundFieldMeta } from './fieldMeta'\nimport type {\n  BaseStateTaxFieldProps,\n  CurrencyStateTaxFieldProps,\n  DateStateTaxFieldProps,\n  NumberStateTaxFieldProps,\n  RadioStateTaxFieldProps,\n  SelectStateTaxFieldProps,\n  StateTaxValidationMessages,\n  TextStateTaxFieldProps,\n} from './fieldProps'\nimport {\n  SelectHookField,\n  RadioGroupHookField,\n  TextInputHookField,\n  NumberInputHookField,\n  DatePickerHookField,\n} from '@/partner-hook-utils/form/fields'\nimport type { SelectHookFieldProps } from '@/partner-hook-utils/form/fields/SelectHookField'\nimport type { RadioGroupHookFieldProps } from '@/partner-hook-utils/form/fields/RadioGroupHookField'\nimport type { TextInputHookFieldProps } from '@/partner-hook-utils/form/fields/TextInputHookField'\nimport type { NumberInputHookFieldProps } from '@/partner-hook-utils/form/fields/NumberInputHookField'\nimport type { DatePickerHookFieldProps } from '@/partner-hook-utils/form/fields/DatePickerHookField'\nimport type { FormHookResult } from '@/partner-hook-utils/types'\n\ninterface MetaProps {\n  meta: BoundFieldMeta\n}\n\nfunction useStateTaxValidationDefaults(): StateTaxValidationMessages {\n  const { t } = useTranslation('Employee.StateTaxesView')\n  return { [EmployeeStateTaxesErrorCodes.REQUIRED]: t('validations.required') }\n}\n\nfunction useResolvedBaseProps(\n  meta: BoundFieldMeta,\n  props: BaseStateTaxFieldProps,\n): {\n  name: string\n  label: string\n  description: ReactNode\n  formHookResult: FormHookResult | undefined\n  validationMessages: StateTaxValidationMessages\n} {\n  const defaults = useStateTaxValidationDefaults()\n  return {\n    name: meta.name,\n    label: props.label ?? meta.apiLabel,\n    description: props.description !== undefined ? props.description : meta.apiDescription,\n    formHookResult: props.formHookResult,\n    validationMessages: { ...defaults, ...props.validationMessages },\n  }\n}\n\n/** @internal */\nexport function SelectStateTaxField({ meta, ...props }: MetaProps & SelectStateTaxFieldProps) {\n  const base = useResolvedBaseProps(meta, props)\n  const hookProps: SelectHookFieldProps<typeof EmployeeStateTaxesErrorCodes.REQUIRED> = {\n    ...base,\n    placeholder: props.placeholder,\n    FieldComponent: props.FieldComponent,\n  }\n  return <SelectHookField {...hookProps} />\n}\n\n/** @internal */\nexport function RadioStateTaxField({ meta, ...props }: MetaProps & RadioStateTaxFieldProps) {\n  const base = useResolvedBaseProps(meta, props)\n  const hookProps: RadioGroupHookFieldProps<typeof EmployeeStateTaxesErrorCodes.REQUIRED> = {\n    ...base,\n    FieldComponent: props.FieldComponent,\n  }\n  return <RadioGroupHookField {...hookProps} />\n}\n\n/** @internal */\nexport function TextStateTaxField({ meta, ...props }: MetaProps & TextStateTaxFieldProps) {\n  const base = useResolvedBaseProps(meta, props)\n  const hookProps: TextInputHookFieldProps<typeof EmployeeStateTaxesErrorCodes.REQUIRED> = {\n    ...base,\n    placeholder: props.placeholder,\n  }\n  return <TextInputHookField {...hookProps} />\n}\n\n/** @internal */\nexport function NumberStateTaxField({ meta, ...props }: MetaProps & NumberStateTaxFieldProps) {\n  const base = useResolvedBaseProps(meta, props)\n  const hookProps: NumberInputHookFieldProps<typeof EmployeeStateTaxesErrorCodes.REQUIRED> = {\n    ...base,\n    format: 'decimal',\n    FieldComponent: props.FieldComponent,\n  }\n  return <NumberInputHookField {...hookProps} />\n}\n\n/** @internal */\nexport function CurrencyStateTaxField({ meta, ...props }: MetaProps & CurrencyStateTaxFieldProps) {\n  const base = useResolvedBaseProps(meta, props)\n  const hookProps: NumberInputHookFieldProps<typeof EmployeeStateTaxesErrorCodes.REQUIRED> = {\n    ...base,\n    format: 'currency',\n    FieldComponent: props.FieldComponent,\n  }\n  return <NumberInputHookField {...hookProps} />\n}\n\n/** @internal */\nexport function DateStateTaxField({ meta, ...props }: MetaProps & DateStateTaxFieldProps) {\n  const base = useResolvedBaseProps(meta, props)\n  const hookProps: DatePickerHookFieldProps<typeof EmployeeStateTaxesErrorCodes.REQUIRED> = {\n    ...base,\n    FieldComponent: props.FieldComponent,\n  }\n  return <DatePickerHookField {...hookProps} />\n}\n"],"names":["useStateTaxValidationDefaults","t","useTranslation","EmployeeStateTaxesErrorCodes","useResolvedBaseProps","meta","props","defaults","SelectStateTaxField","hookProps","jsx","SelectHookField","RadioStateTaxField","RadioGroupHookField","TextStateTaxField","TextInputHookField","NumberStateTaxField","NumberInputHookField","CurrencyStateTaxField","DateStateTaxField","DatePickerHookField"],"mappings":";;;;;;;;AAgCA,SAASA,IAA4D;AACnE,QAAM,EAAE,GAAAC,EAAA,IAAMC,EAAe,yBAAyB;AACtD,SAAO,EAAE,CAACC,EAA6B,QAAQ,GAAGF,EAAE,sBAAsB,EAAA;AAC5E;AAEA,SAASG,EACPC,GACAC,GAOA;AACA,QAAMC,IAAWP,EAAA;AACjB,SAAO;AAAA,IACL,MAAMK,EAAK;AAAA,IACX,OAAOC,EAAM,SAASD,EAAK;AAAA,IAC3B,aAAaC,EAAM,gBAAgB,SAAYA,EAAM,cAAcD,EAAK;AAAA,IACxE,gBAAgBC,EAAM;AAAA,IACtB,oBAAoB,EAAE,GAAGC,GAAU,GAAGD,EAAM,mBAAA;AAAA,EAAmB;AAEnE;AAGO,SAASE,EAAoB,EAAE,MAAAH,GAAM,GAAGC,KAA+C;AAE5F,QAAMG,IAAgF;AAAA,IACpF,GAFWL,EAAqBC,GAAMC,CAAK;AAAA,IAG3C,aAAaA,EAAM;AAAA,IACnB,gBAAgBA,EAAM;AAAA,EAAA;AAExB,SAAO,gBAAAI,EAACC,GAAA,EAAiB,GAAGF,EAAA,CAAW;AACzC;AAGO,SAASG,EAAmB,EAAE,MAAAP,GAAM,GAAGC,KAA8C;AAE1F,QAAMG,IAAoF;AAAA,IACxF,GAFWL,EAAqBC,GAAMC,CAAK;AAAA,IAG3C,gBAAgBA,EAAM;AAAA,EAAA;AAExB,SAAO,gBAAAI,EAACG,GAAA,EAAqB,GAAGJ,EAAA,CAAW;AAC7C;AAGO,SAASK,EAAkB,EAAE,MAAAT,GAAM,GAAGC,KAA6C;AAExF,QAAMG,IAAmF;AAAA,IACvF,GAFWL,EAAqBC,GAAMC,CAAK;AAAA,IAG3C,aAAaA,EAAM;AAAA,EAAA;AAErB,SAAO,gBAAAI,EAACK,GAAA,EAAoB,GAAGN,EAAA,CAAW;AAC5C;AAGO,SAASO,EAAoB,EAAE,MAAAX,GAAM,GAAGC,KAA+C;AAE5F,QAAMG,IAAqF;AAAA,IACzF,GAFWL,EAAqBC,GAAMC,CAAK;AAAA,IAG3C,QAAQ;AAAA,IACR,gBAAgBA,EAAM;AAAA,EAAA;AAExB,SAAO,gBAAAI,EAACO,GAAA,EAAsB,GAAGR,EAAA,CAAW;AAC9C;AAGO,SAASS,EAAsB,EAAE,MAAAb,GAAM,GAAGC,KAAiD;AAEhG,QAAMG,IAAqF;AAAA,IACzF,GAFWL,EAAqBC,GAAMC,CAAK;AAAA,IAG3C,QAAQ;AAAA,IACR,gBAAgBA,EAAM;AAAA,EAAA;AAExB,SAAO,gBAAAI,EAACO,GAAA,EAAsB,GAAGR,EAAA,CAAW;AAC9C;AAGO,SAASU,EAAkB,EAAE,MAAAd,GAAM,GAAGC,KAA6C;AAExF,QAAMG,IAAoF;AAAA,IACxF,GAFWL,EAAqBC,GAAMC,CAAK;AAAA,IAG3C,gBAAgBA,EAAM;AAAA,EAAA;AAExB,SAAO,gBAAAI,EAACU,GAAA,EAAqB,GAAGX,EAAA,CAAW;AAC7C;"}

package/dist/components/Employee/StateTaxes/shared/useEmployeeStateTaxesForm/fieldMapping.d.ts

@@ -1,14 +1,9 @@
 import { EmployeeStateTaxQuestion } from '@gusto/embedded-api-v-2025-11-15/models/components/employeestatetaxquestion';
 /**
- * Lowercase post-mapping variant that decides which UI primitive renders
- * a given state-tax question. Mirrors the existing `QuestionInput` switch
- * in `src/components/Common/TaxInputs/TaxInputs.tsx`, narrowed to the
- * cases that apply to the employee state-tax endpoint.
+ * UI input variant for a state-tax question — determines which field type renders for a given question from the employee state-taxes API.
+ *
+ * @public
  */
 export type StateTaxQuestionVariant = 'select' | 'radio' | 'text' | 'number' | 'currency' | 'date';
-/**
- * Resolves a question's UI variant from its API shape and per-key promotion
- * rules. Unknown wire types fall through to `text` to mirror the existing
- * `QuestionInput` default branch.
- */
+/** @internal */
 export declare function getQuestionVariant(question: EmployeeStateTaxQuestion): StateTaxQuestionVariant;

package/dist/components/Employee/StateTaxes/shared/useEmployeeStateTaxesForm/fieldMapping.js.map

@@ -1 +1 @@
-{"version":3,"file":"fieldMapping.js","sources":["../../../../../../src/components/Employee/StateTaxes/shared/useEmployeeStateTaxesForm/fieldMapping.ts"],"sourcesContent":["import type { EmployeeStateTaxQuestion } from '@gusto/embedded-api-v-2025-11-15/models/components/employeestatetaxquestion'\n\n/**\n * Lowercase post-mapping variant that decides which UI primitive renders\n * a given state-tax question. Mirrors the existing `QuestionInput` switch\n * in `src/components/Common/TaxInputs/TaxInputs.tsx`, narrowed to the\n * cases that apply to the employee state-tax endpoint.\n */\nexport type StateTaxQuestionVariant = 'select' | 'radio' | 'text' | 'number' | 'currency' | 'date'\n\n/**\n * Per-key mapping rules that promote API `Select`s to other variants for\n * UX reasons.\n *\n * `file_new_hire_report` is internally a Radio per the canonical Ruby\n * helper (`FileNewHireReportHelper.display_field_for_file_new_hire_report`),\n * but the converter at\n * `convert_employee_state_field_to_gws_flow_questions.rb` emits it as\n * `Select` because there's no Radio output type. The existing component at\n * `src/components/Employee/StateTaxes/StateForm.tsx` intends to override\n * `questionType` to `'Radio'` for this question but the comparison checks\n * `'fileNewHireReport'` (camelCase) against an API `key` of\n * `'file_new_hire_report'` (snake_case), so the override never fires today.\n *\n * This map fixes that bug and surfaces it as a Radio in the new hook.\n */\nconst SELECT_TO_RADIO_PROMOTION_KEYS = new Set<string>(['file_new_hire_report'])\n\n/**\n * Resolves a question's UI variant from its API shape and per-key promotion\n * rules. Unknown wire types fall through to `text` to mirror the existing\n * `QuestionInput` default branch.\n */\nexport function getQuestionVariant(question: EmployeeStateTaxQuestion): StateTaxQuestionVariant {\n  if (SELECT_TO_RADIO_PROMOTION_KEYS.has(question.key)) {\n    return 'radio'\n  }\n\n  switch (question.inputQuestionFormat.type.toLowerCase()) {\n    case 'select':\n      return 'select'\n    case 'number':\n      return 'number'\n    case 'currency':\n      return 'currency'\n    case 'date':\n      return 'date'\n    case 'text':\n      return 'text'\n    default:\n      return 'text'\n  }\n}\n"],"names":["SELECT_TO_RADIO_PROMOTION_KEYS","getQuestionVariant","question"],"mappings":"AA0BA,MAAMA,IAAiC,oBAAI,IAAY,CAAC,sBAAsB,CAAC;AAOxE,SAASC,EAAmBC,GAA6D;AAC9F,MAAIF,EAA+B,IAAIE,EAAS,GAAG;AACjD,WAAO;AAGT,UAAQA,EAAS,oBAAoB,KAAK,YAAA,GAAY;AAAA,IACpD,KAAK;AACH,aAAO;AAAA,IACT,KAAK;AACH,aAAO;AAAA,IACT,KAAK;AACH,aAAO;AAAA,IACT,KAAK;AACH,aAAO;AAAA,IACT,KAAK;AACH,aAAO;AAAA,IACT;AACE,aAAO;AAAA,EAAA;AAEb;"}
+{"version":3,"file":"fieldMapping.js","sources":["../../../../../../src/components/Employee/StateTaxes/shared/useEmployeeStateTaxesForm/fieldMapping.ts"],"sourcesContent":["import type { EmployeeStateTaxQuestion } from '@gusto/embedded-api-v-2025-11-15/models/components/employeestatetaxquestion'\n\n/**\n * UI input variant for a state-tax question — determines which field type renders for a given question from the employee state-taxes API.\n *\n * @public\n */\nexport type StateTaxQuestionVariant = 'select' | 'radio' | 'text' | 'number' | 'currency' | 'date'\n\n/**\n * Per-key mapping rules that promote API `Select`s to other variants for\n * UX reasons.\n *\n * `file_new_hire_report` is internally a Radio per the canonical Ruby\n * helper (`FileNewHireReportHelper.display_field_for_file_new_hire_report`),\n * but the converter at\n * `convert_employee_state_field_to_gws_flow_questions.rb` emits it as\n * `Select` because there's no Radio output type. The existing component at\n * `src/components/Employee/StateTaxes/StateForm.tsx` intends to override\n * `questionType` to `'Radio'` for this question but the comparison checks\n * `'fileNewHireReport'` (camelCase) against an API `key` of\n * `'file_new_hire_report'` (snake_case), so the override never fires today.\n *\n * This map fixes that bug and surfaces it as a Radio in the new hook.\n */\nconst SELECT_TO_RADIO_PROMOTION_KEYS = new Set<string>(['file_new_hire_report'])\n\n/** @internal */\nexport function getQuestionVariant(question: EmployeeStateTaxQuestion): StateTaxQuestionVariant {\n  if (SELECT_TO_RADIO_PROMOTION_KEYS.has(question.key)) {\n    return 'radio'\n  }\n\n  switch (question.inputQuestionFormat.type.toLowerCase()) {\n    case 'select':\n      return 'select'\n    case 'number':\n      return 'number'\n    case 'currency':\n      return 'currency'\n    case 'date':\n      return 'date'\n    case 'text':\n      return 'text'\n    default:\n      return 'text'\n  }\n}\n"],"names":["SELECT_TO_RADIO_PROMOTION_KEYS","getQuestionVariant","question"],"mappings":"AAyBA,MAAMA,IAAiC,oBAAI,IAAY,CAAC,sBAAsB,CAAC;AAGxE,SAASC,EAAmBC,GAA6D;AAC9F,MAAIF,EAA+B,IAAIE,EAAS,GAAG;AACjD,WAAO;AAGT,UAAQA,EAAS,oBAAoB,KAAK,YAAA,GAAY;AAAA,IACpD,KAAK;AACH,aAAO;AAAA,IACT,KAAK;AACH,aAAO;AAAA,IACT,KAAK;AACH,aAAO;AAAA,IACT,KAAK;AACH,aAAO;AAAA,IACT,KAAK;AACH,aAAO;AAAA,IACT;AACE,aAAO;AAAA,EAAA;AAEb;"}

package/dist/components/Employee/StateTaxes/shared/useEmployeeStateTaxesForm/fieldMeta.d.ts

@@ -1,4 +1,8 @@
-/** Per-question metadata baked into each bound Field component. */
+/**
+ * Per-question metadata baked into each bound Field component.
+ *
+ * @internal
+ */
 export interface BoundFieldMeta {
     name: string;
     apiLabel: string;

package/dist/components/Employee/StateTaxes/shared/useEmployeeStateTaxesForm/fieldProps.d.ts

@@ -6,34 +6,86 @@ import { RadioGroupProps } from '../../../../Common/UI/RadioGroup/RadioGroupType
 import { TextInputProps } from '../../../../Common/UI/TextInput/TextInputTypes';
 import { NumberInputProps } from '../../../../Common/UI/NumberInput/NumberInputTypes';
 import { DatePickerProps } from '../../../../Common/UI/DatePicker/DatePickerTypes';
+/**
+ * Localized validation messages supported by the state-tax field components.
+ * Every variant surfaces a single error code, `REQUIRED`.
+ *
+ * @public
+ */
 export type StateTaxValidationMessages = ValidationMessages<typeof EmployeeStateTaxesErrorCodes.REQUIRED>;
+/**
+ * Props shared by every state-tax `Field` variant. Each variant extends this
+ * with a variant-specific `FieldComponent` shape; `select` and `text` also add
+ * a `placeholder`.
+ *
+ * @public
+ */
 export interface BaseStateTaxFieldProps {
     /** Overrides the API-supplied label. When omitted, falls back to `question.label`. */
     label?: string;
     /** Overrides the API-supplied description. When omitted, falls back to `question.description`
      *  (sanitized internally by the underlying field via DOMPurify). */
     description?: ReactNode;
+    /** When using the hook outside an `SDKFormProvider`, pass the form-hook result here so the field can connect to it. */
     formHookResult?: FormHookResult;
     /** Override the default localized validation message(s). */
     validationMessages?: StateTaxValidationMessages;
 }
+/**
+ * Props for a `Field` rendered as a select (dropdown).
+ *
+ * @public
+ */
 export type SelectStateTaxFieldProps = BaseStateTaxFieldProps & {
+    /** Placeholder shown when no option is selected. */
     placeholder?: string;
+    /** Replace the underlying SDK Select primitive with a component of your own. */
     FieldComponent?: ComponentType<SelectProps>;
 };
+/**
+ * Props for a `Field` rendered as a radio group.
+ *
+ * @public
+ */
 export type RadioStateTaxFieldProps = BaseStateTaxFieldProps & {
+    /** Replace the underlying SDK RadioGroup primitive with a component of your own. */
     FieldComponent?: ComponentType<RadioGroupProps>;
 };
+/**
+ * Props for a `Field` rendered as a single-line text input.
+ *
+ * @public
+ */
 export type TextStateTaxFieldProps = BaseStateTaxFieldProps & {
+    /** Placeholder shown when the field is empty. */
     placeholder?: string;
+    /** Replace the underlying SDK TextInput primitive with a component of your own. */
     FieldComponent?: ComponentType<TextInputProps>;
 };
+/**
+ * Props for a `Field` rendered as a decimal number input.
+ *
+ * @public
+ */
 export type NumberStateTaxFieldProps = BaseStateTaxFieldProps & {
+    /** Replace the underlying SDK NumberInput primitive with a component of your own. */
     FieldComponent?: ComponentType<NumberInputProps>;
 };
+/**
+ * Props for a `Field` rendered as a currency-formatted number input.
+ *
+ * @public
+ */
 export type CurrencyStateTaxFieldProps = BaseStateTaxFieldProps & {
+    /** Replace the underlying SDK NumberInput primitive with a component of your own. */
     FieldComponent?: ComponentType<NumberInputProps>;
 };
+/**
+ * Props for a `Field` rendered as a date picker.
+ *
+ * @public
+ */
 export type DateStateTaxFieldProps = BaseStateTaxFieldProps & {
+    /** Replace the underlying SDK DatePicker primitive with a component of your own. */
     FieldComponent?: ComponentType<DatePickerProps>;
 };

package/dist/components/Employee/StateTaxes/shared/useEmployeeStateTaxesForm/fields.d.ts

@@ -1,7 +1,7 @@
 import { ComponentType } from 'react';
 import { EmployeeStateTaxesList } from '@gusto/embedded-api-v-2025-11-15/models/components/employeestatetaxeslist';
 import { CurrencyStateTaxFieldProps, DateStateTaxFieldProps, NumberStateTaxFieldProps, RadioStateTaxFieldProps, SelectStateTaxFieldProps, TextStateTaxFieldProps } from './fieldProps';
-export type { BaseStateTaxFieldProps, CurrencyStateTaxFieldProps, DateStateTaxFieldProps, NumberStateTaxFieldProps, RadioStateTaxFieldProps, SelectStateTaxFieldProps, StateTaxValidationMessages, TextStateTaxFieldProps, } from './fieldProps';
+export type { CurrencyStateTaxFieldProps, DateStateTaxFieldProps, NumberStateTaxFieldProps, RadioStateTaxFieldProps, SelectStateTaxFieldProps, TextStateTaxFieldProps, } from './fieldProps';
 interface SharedQuestionMetadata {
     /** Stable identifier for this question (camelCase form of the API key). */
     questionId: string;
@@ -10,6 +10,14 @@ interface SharedQuestionMetadata {
     /** API-supplied description (raw HTML, sanitized internally before render). */
     description: string | null;
 }
+/**
+ * One question entry within a {@link StateTaxFieldsGroup}, discriminated by
+ * `type` to identify which input variant the question uses. Each entry carries
+ * a `Field` component pre-bound to its API-supplied metadata so callers can
+ * render the input directly.
+ *
+ * @public
+ */
 export type StateTaxQuestionFieldEntry = ({
     type: 'select';
     Field: ComponentType<SelectStateTaxFieldProps>;
@@ -29,18 +37,31 @@ export type StateTaxQuestionFieldEntry = ({
     type: 'date';
     Field: ComponentType<DateStateTaxFieldProps>;
 } & SharedQuestionMetadata);
+/**
+ * Group of state-tax questions for a single jurisdiction returned by
+ * {@link useStateFields}.
+ *
+ * @public
+ */
 export interface StateTaxFieldsGroup {
+    /** Two-letter state code. */
     state: string;
+    /** Ordered list of question entries for this state, post admin-only filtering. */
     questions: StateTaxQuestionFieldEntry[];
 }
+/** @internal */
 export interface CreateStateFieldsOptions {
     isAdmin: boolean;
 }
+/** @internal */
 export declare function createStateFields(employeeStateTaxes: EmployeeStateTaxesList[], options: CreateStateFieldsOptions): StateTaxFieldsGroup[];
 /**
- * Memoization helper: state-tax data refetches will return new array
- * references even when the underlying questions are unchanged. Use this
- * inside a `useMemo` whose dependency is the raw `employeeStateTaxes` to
- * avoid rebuilding bound Field components on every render.
+ * Memoizes the bound field components for a state-taxes form, avoiding unnecessary rebuilds when the data refetches but the underlying questions haven't changed.
+ *
+ * @param employeeStateTaxes - Array of state-tax groups returned by the employee state-taxes API.
+ * @param isAdmin - When `true`, admin-only questions are included; when `false`, they are filtered out.
+ * @returns An array of {@link StateTaxFieldsGroup} — one entry per state, each with a `questions` array of bound field components.
+ * @public
+ * @group Utility Hooks
  */
 export declare function useStateFields(employeeStateTaxes: EmployeeStateTaxesList[], isAdmin: boolean): StateTaxFieldsGroup[];

package/dist/components/Employee/StateTaxes/shared/useEmployeeStateTaxesForm/fields.js.map

@@ -1 +1 @@
-{"version":3,"file":"fields.js","sources":["../../../../../../src/components/Employee/StateTaxes/shared/useEmployeeStateTaxesForm/fields.tsx"],"sourcesContent":["import type { ComponentType } from 'react'\nimport { useMemo } from 'react'\nimport type { EmployeeStateTaxesList } from '@gusto/embedded-api-v-2025-11-15/models/components/employeestatetaxeslist'\nimport { getQuestionVariant, type StateTaxQuestionVariant } from './fieldMapping'\nimport {\n  CurrencyStateTaxField,\n  DateStateTaxField,\n  NumberStateTaxField,\n  RadioStateTaxField,\n  SelectStateTaxField,\n  TextStateTaxField,\n} from './fieldComponents'\nimport type { BoundFieldMeta } from './fieldMeta'\nimport type {\n  CurrencyStateTaxFieldProps,\n  DateStateTaxFieldProps,\n  NumberStateTaxFieldProps,\n  RadioStateTaxFieldProps,\n  SelectStateTaxFieldProps,\n  TextStateTaxFieldProps,\n} from './fieldProps'\nimport { snakeCaseToCamelCase } from '@/helpers/formattedStrings'\n\nexport type {\n  BaseStateTaxFieldProps,\n  CurrencyStateTaxFieldProps,\n  DateStateTaxFieldProps,\n  NumberStateTaxFieldProps,\n  RadioStateTaxFieldProps,\n  SelectStateTaxFieldProps,\n  StateTaxValidationMessages,\n  TextStateTaxFieldProps,\n} from './fieldProps'\n\n// ── Discriminated union surfaced to partners ───────────────────────────\n\ninterface SharedQuestionMetadata {\n  /** Stable identifier for this question (camelCase form of the API key). */\n  questionId: string\n  /** API-supplied label; default text for the rendered Field. */\n  label: string\n  /** API-supplied description (raw HTML, sanitized internally before render). */\n  description: string | null\n}\n\nexport type StateTaxQuestionFieldEntry =\n  | ({ type: 'select'; Field: ComponentType<SelectStateTaxFieldProps> } & SharedQuestionMetadata)\n  | ({ type: 'radio'; Field: ComponentType<RadioStateTaxFieldProps> } & SharedQuestionMetadata)\n  | ({ type: 'text'; Field: ComponentType<TextStateTaxFieldProps> } & SharedQuestionMetadata)\n  | ({ type: 'number'; Field: ComponentType<NumberStateTaxFieldProps> } & SharedQuestionMetadata)\n  | ({\n      type: 'currency'\n      Field: ComponentType<CurrencyStateTaxFieldProps>\n    } & SharedQuestionMetadata)\n  | ({ type: 'date'; Field: ComponentType<DateStateTaxFieldProps> } & SharedQuestionMetadata)\n\nexport interface StateTaxFieldsGroup {\n  state: string\n  questions: StateTaxQuestionFieldEntry[]\n}\n\n// ── Factory ────────────────────────────────────────────────────────────\n\nexport interface CreateStateFieldsOptions {\n  isAdmin: boolean\n}\n\nexport function createStateFields(\n  employeeStateTaxes: EmployeeStateTaxesList[],\n  options: CreateStateFieldsOptions,\n): StateTaxFieldsGroup[] {\n  const { isAdmin } = options\n  const groups: StateTaxFieldsGroup[] = []\n\n  for (const stateGroup of employeeStateTaxes) {\n    if (!stateGroup.state || !stateGroup.questions) continue\n\n    const questions: StateTaxQuestionFieldEntry[] = []\n    for (const question of stateGroup.questions) {\n      if (question.isQuestionForAdminOnly && !isAdmin) continue\n\n      const formKey = snakeCaseToCamelCase(question.key)\n      const meta: BoundFieldMeta = {\n        name: `states.${stateGroup.state}.${formKey}`,\n        apiLabel: question.label,\n        apiDescription: question.description,\n      }\n      const variant = getQuestionVariant(question)\n      const shared: SharedQuestionMetadata = {\n        questionId: formKey,\n        label: question.label,\n        description: question.description,\n      }\n\n      questions.push(buildEntry(variant, meta, shared))\n    }\n\n    if (questions.length === 0) continue\n\n    groups.push({\n      state: stateGroup.state,\n      questions,\n    })\n  }\n\n  return groups\n}\n\nfunction buildEntry(\n  variant: StateTaxQuestionVariant,\n  meta: BoundFieldMeta,\n  shared: SharedQuestionMetadata,\n): StateTaxQuestionFieldEntry {\n  switch (variant) {\n    case 'select':\n      return {\n        type: 'select',\n        Field: function BoundSelectStateTaxField(props: SelectStateTaxFieldProps) {\n          return <SelectStateTaxField meta={meta} {...props} />\n        },\n        ...shared,\n      }\n    case 'radio':\n      return {\n        type: 'radio',\n        Field: function BoundRadioStateTaxField(props: RadioStateTaxFieldProps) {\n          return <RadioStateTaxField meta={meta} {...props} />\n        },\n        ...shared,\n      }\n    case 'text':\n      return {\n        type: 'text',\n        Field: function BoundTextStateTaxField(props: TextStateTaxFieldProps) {\n          return <TextStateTaxField meta={meta} {...props} />\n        },\n        ...shared,\n      }\n    case 'number':\n      return {\n        type: 'number',\n        Field: function BoundNumberStateTaxField(props: NumberStateTaxFieldProps) {\n          return <NumberStateTaxField meta={meta} {...props} />\n        },\n        ...shared,\n      }\n    case 'currency':\n      return {\n        type: 'currency',\n        Field: function BoundCurrencyStateTaxField(props: CurrencyStateTaxFieldProps) {\n          return <CurrencyStateTaxField meta={meta} {...props} />\n        },\n        ...shared,\n      }\n    case 'date':\n      return {\n        type: 'date',\n        Field: function BoundDateStateTaxField(props: DateStateTaxFieldProps) {\n          return <DateStateTaxField meta={meta} {...props} />\n        },\n        ...shared,\n      }\n  }\n}\n\n/**\n * Memoization helper: state-tax data refetches will return new array\n * references even when the underlying questions are unchanged. Use this\n * inside a `useMemo` whose dependency is the raw `employeeStateTaxes` to\n * avoid rebuilding bound Field components on every render.\n */\nexport function useStateFields(\n  employeeStateTaxes: EmployeeStateTaxesList[],\n  isAdmin: boolean,\n): StateTaxFieldsGroup[] {\n  return useMemo(\n    () => createStateFields(employeeStateTaxes, { isAdmin }),\n    [employeeStateTaxes, isAdmin],\n  )\n}\n"],"names":["createStateFields","employeeStateTaxes","options","isAdmin","groups","stateGroup","questions","question","formKey","snakeCaseToCamelCase","meta","variant","getQuestionVariant","shared","buildEntry","props","jsx","SelectStateTaxField","RadioStateTaxField","TextStateTaxField","NumberStateTaxField","CurrencyStateTaxField","DateStateTaxField","useStateFields","useMemo"],"mappings":";;;;;AAmEO,SAASA,EACdC,GACAC,GACuB;AACvB,QAAM,EAAE,SAAAC,MAAYD,GACdE,IAAgC,CAAA;AAEtC,aAAWC,KAAcJ,GAAoB;AAC3C,QAAI,CAACI,EAAW,SAAS,CAACA,EAAW,UAAW;AAEhD,UAAMC,IAA0C,CAAA;AAChD,eAAWC,KAAYF,EAAW,WAAW;AAC3C,UAAIE,EAAS,0BAA0B,CAACJ,EAAS;AAEjD,YAAMK,IAAUC,EAAqBF,EAAS,GAAG,GAC3CG,IAAuB;AAAA,QAC3B,MAAM,UAAUL,EAAW,KAAK,IAAIG,CAAO;AAAA,QAC3C,UAAUD,EAAS;AAAA,QACnB,gBAAgBA,EAAS;AAAA,MAAA,GAErBI,IAAUC,EAAmBL,CAAQ,GACrCM,IAAiC;AAAA,QACrC,YAAYL;AAAA,QACZ,OAAOD,EAAS;AAAA,QAChB,aAAaA,EAAS;AAAA,MAAA;AAGxB,MAAAD,EAAU,KAAKQ,EAAWH,GAASD,GAAMG,CAAM,CAAC;AAAA,IAClD;AAEA,IAAIP,EAAU,WAAW,KAEzBF,EAAO,KAAK;AAAA,MACV,OAAOC,EAAW;AAAA,MAClB,WAAAC;AAAA,IAAA,CACD;AAAA,EACH;AAEA,SAAOF;AACT;AAEA,SAASU,EACPH,GACAD,GACAG,GAC4B;AAC5B,UAAQF,GAAA;AAAA,IACN,KAAK;AACH,aAAO;AAAA,QACL,MAAM;AAAA,QACN,OAAO,SAAkCI,GAAiC;AACxE,iBAAO,gBAAAC,EAACC,GAAA,EAAoB,MAAAP,GAAa,GAAGK,EAAA,CAAO;AAAA,QACrD;AAAA,QACA,GAAGF;AAAA,MAAA;AAAA,IAEP,KAAK;AACH,aAAO;AAAA,QACL,MAAM;AAAA,QACN,OAAO,SAAiCE,GAAgC;AACtE,iBAAO,gBAAAC,EAACE,GAAA,EAAmB,MAAAR,GAAa,GAAGK,EAAA,CAAO;AAAA,QACpD;AAAA,QACA,GAAGF;AAAA,MAAA;AAAA,IAEP,KAAK;AACH,aAAO;AAAA,QACL,MAAM;AAAA,QACN,OAAO,SAAgCE,GAA+B;AACpE,iBAAO,gBAAAC,EAACG,GAAA,EAAkB,MAAAT,GAAa,GAAGK,EAAA,CAAO;AAAA,QACnD;AAAA,QACA,GAAGF;AAAA,MAAA;AAAA,IAEP,KAAK;AACH,aAAO;AAAA,QACL,MAAM;AAAA,QACN,OAAO,SAAkCE,GAAiC;AACxE,iBAAO,gBAAAC,EAACI,GAAA,EAAoB,MAAAV,GAAa,GAAGK,EAAA,CAAO;AAAA,QACrD;AAAA,QACA,GAAGF;AAAA,MAAA;AAAA,IAEP,KAAK;AACH,aAAO;AAAA,QACL,MAAM;AAAA,QACN,OAAO,SAAoCE,GAAmC;AAC5E,iBAAO,gBAAAC,EAACK,GAAA,EAAsB,MAAAX,GAAa,GAAGK,EAAA,CAAO;AAAA,QACvD;AAAA,QACA,GAAGF;AAAA,MAAA;AAAA,IAEP,KAAK;AACH,aAAO;AAAA,QACL,MAAM;AAAA,QACN,OAAO,SAAgCE,GAA+B;AACpE,iBAAO,gBAAAC,EAACM,GAAA,EAAkB,MAAAZ,GAAa,GAAGK,EAAA,CAAO;AAAA,QACnD;AAAA,QACA,GAAGF;AAAA,MAAA;AAAA,EACL;AAEN;AAQO,SAASU,EACdtB,GACAE,GACuB;AACvB,SAAOqB;AAAA,IACL,MAAMxB,EAAkBC,GAAoB,EAAE,SAAAE,GAAS;AAAA,IACvD,CAACF,GAAoBE,CAAO;AAAA,EAAA;AAEhC;"}
+{"version":3,"file":"fields.js","sources":["../../../../../../src/components/Employee/StateTaxes/shared/useEmployeeStateTaxesForm/fields.tsx"],"sourcesContent":["import type { ComponentType } from 'react'\nimport { useMemo } from 'react'\nimport type { EmployeeStateTaxesList } from '@gusto/embedded-api-v-2025-11-15/models/components/employeestatetaxeslist'\nimport { getQuestionVariant, type StateTaxQuestionVariant } from './fieldMapping'\nimport {\n  CurrencyStateTaxField,\n  DateStateTaxField,\n  NumberStateTaxField,\n  RadioStateTaxField,\n  SelectStateTaxField,\n  TextStateTaxField,\n} from './fieldComponents'\nimport type { BoundFieldMeta } from './fieldMeta'\nimport type {\n  CurrencyStateTaxFieldProps,\n  DateStateTaxFieldProps,\n  NumberStateTaxFieldProps,\n  RadioStateTaxFieldProps,\n  SelectStateTaxFieldProps,\n  TextStateTaxFieldProps,\n} from './fieldProps'\nimport { snakeCaseToCamelCase } from '@/helpers/formattedStrings'\n\nexport type {\n  CurrencyStateTaxFieldProps,\n  DateStateTaxFieldProps,\n  NumberStateTaxFieldProps,\n  RadioStateTaxFieldProps,\n  SelectStateTaxFieldProps,\n  TextStateTaxFieldProps,\n} from './fieldProps'\n\n// ── Discriminated union surfaced to partners ───────────────────────────\n\ninterface SharedQuestionMetadata {\n  /** Stable identifier for this question (camelCase form of the API key). */\n  questionId: string\n  /** API-supplied label; default text for the rendered Field. */\n  label: string\n  /** API-supplied description (raw HTML, sanitized internally before render). */\n  description: string | null\n}\n\n/**\n * One question entry within a {@link StateTaxFieldsGroup}, discriminated by\n * `type` to identify which input variant the question uses. Each entry carries\n * a `Field` component pre-bound to its API-supplied metadata so callers can\n * render the input directly.\n *\n * @public\n */\nexport type StateTaxQuestionFieldEntry =\n  | ({ type: 'select'; Field: ComponentType<SelectStateTaxFieldProps> } & SharedQuestionMetadata)\n  | ({ type: 'radio'; Field: ComponentType<RadioStateTaxFieldProps> } & SharedQuestionMetadata)\n  | ({ type: 'text'; Field: ComponentType<TextStateTaxFieldProps> } & SharedQuestionMetadata)\n  | ({ type: 'number'; Field: ComponentType<NumberStateTaxFieldProps> } & SharedQuestionMetadata)\n  | ({\n      type: 'currency'\n      Field: ComponentType<CurrencyStateTaxFieldProps>\n    } & SharedQuestionMetadata)\n  | ({ type: 'date'; Field: ComponentType<DateStateTaxFieldProps> } & SharedQuestionMetadata)\n\n/**\n * Group of state-tax questions for a single jurisdiction returned by\n * {@link useStateFields}.\n *\n * @public\n */\nexport interface StateTaxFieldsGroup {\n  /** Two-letter state code. */\n  state: string\n  /** Ordered list of question entries for this state, post admin-only filtering. */\n  questions: StateTaxQuestionFieldEntry[]\n}\n\n// ── Factory ────────────────────────────────────────────────────────────\n\n/** @internal */\nexport interface CreateStateFieldsOptions {\n  isAdmin: boolean\n}\n\n/** @internal */\nexport function createStateFields(\n  employeeStateTaxes: EmployeeStateTaxesList[],\n  options: CreateStateFieldsOptions,\n): StateTaxFieldsGroup[] {\n  const { isAdmin } = options\n  const groups: StateTaxFieldsGroup[] = []\n\n  for (const stateGroup of employeeStateTaxes) {\n    if (!stateGroup.state || !stateGroup.questions) continue\n\n    const questions: StateTaxQuestionFieldEntry[] = []\n    for (const question of stateGroup.questions) {\n      if (question.isQuestionForAdminOnly && !isAdmin) continue\n\n      const formKey = snakeCaseToCamelCase(question.key)\n      const meta: BoundFieldMeta = {\n        name: `states.${stateGroup.state}.${formKey}`,\n        apiLabel: question.label,\n        apiDescription: question.description,\n      }\n      const variant = getQuestionVariant(question)\n      const shared: SharedQuestionMetadata = {\n        questionId: formKey,\n        label: question.label,\n        description: question.description,\n      }\n\n      questions.push(buildEntry(variant, meta, shared))\n    }\n\n    if (questions.length === 0) continue\n\n    groups.push({\n      state: stateGroup.state,\n      questions,\n    })\n  }\n\n  return groups\n}\n\nfunction buildEntry(\n  variant: StateTaxQuestionVariant,\n  meta: BoundFieldMeta,\n  shared: SharedQuestionMetadata,\n): StateTaxQuestionFieldEntry {\n  switch (variant) {\n    case 'select':\n      return {\n        type: 'select',\n        Field: function BoundSelectStateTaxField(props: SelectStateTaxFieldProps) {\n          return <SelectStateTaxField meta={meta} {...props} />\n        },\n        ...shared,\n      }\n    case 'radio':\n      return {\n        type: 'radio',\n        Field: function BoundRadioStateTaxField(props: RadioStateTaxFieldProps) {\n          return <RadioStateTaxField meta={meta} {...props} />\n        },\n        ...shared,\n      }\n    case 'text':\n      return {\n        type: 'text',\n        Field: function BoundTextStateTaxField(props: TextStateTaxFieldProps) {\n          return <TextStateTaxField meta={meta} {...props} />\n        },\n        ...shared,\n      }\n    case 'number':\n      return {\n        type: 'number',\n        Field: function BoundNumberStateTaxField(props: NumberStateTaxFieldProps) {\n          return <NumberStateTaxField meta={meta} {...props} />\n        },\n        ...shared,\n      }\n    case 'currency':\n      return {\n        type: 'currency',\n        Field: function BoundCurrencyStateTaxField(props: CurrencyStateTaxFieldProps) {\n          return <CurrencyStateTaxField meta={meta} {...props} />\n        },\n        ...shared,\n      }\n    case 'date':\n      return {\n        type: 'date',\n        Field: function BoundDateStateTaxField(props: DateStateTaxFieldProps) {\n          return <DateStateTaxField meta={meta} {...props} />\n        },\n        ...shared,\n      }\n  }\n}\n\n/**\n * Memoizes the bound field components for a state-taxes form, avoiding unnecessary rebuilds when the data refetches but the underlying questions haven't changed.\n *\n * @param employeeStateTaxes - Array of state-tax groups returned by the employee state-taxes API.\n * @param isAdmin - When `true`, admin-only questions are included; when `false`, they are filtered out.\n * @returns An array of {@link StateTaxFieldsGroup} — one entry per state, each with a `questions` array of bound field components.\n * @public\n * @group Utility Hooks\n */\nexport function useStateFields(\n  employeeStateTaxes: EmployeeStateTaxesList[],\n  isAdmin: boolean,\n): StateTaxFieldsGroup[] {\n  return useMemo(\n    () => createStateFields(employeeStateTaxes, { isAdmin }),\n    [employeeStateTaxes, isAdmin],\n  )\n}\n"],"names":["createStateFields","employeeStateTaxes","options","isAdmin","groups","stateGroup","questions","question","formKey","snakeCaseToCamelCase","meta","variant","getQuestionVariant","shared","buildEntry","props","jsx","SelectStateTaxField","RadioStateTaxField","TextStateTaxField","NumberStateTaxField","CurrencyStateTaxField","DateStateTaxField","useStateFields","useMemo"],"mappings":";;;;;AAmFO,SAASA,EACdC,GACAC,GACuB;AACvB,QAAM,EAAE,SAAAC,MAAYD,GACdE,IAAgC,CAAA;AAEtC,aAAWC,KAAcJ,GAAoB;AAC3C,QAAI,CAACI,EAAW,SAAS,CAACA,EAAW,UAAW;AAEhD,UAAMC,IAA0C,CAAA;AAChD,eAAWC,KAAYF,EAAW,WAAW;AAC3C,UAAIE,EAAS,0BAA0B,CAACJ,EAAS;AAEjD,YAAMK,IAAUC,EAAqBF,EAAS,GAAG,GAC3CG,IAAuB;AAAA,QAC3B,MAAM,UAAUL,EAAW,KAAK,IAAIG,CAAO;AAAA,QAC3C,UAAUD,EAAS;AAAA,QACnB,gBAAgBA,EAAS;AAAA,MAAA,GAErBI,IAAUC,EAAmBL,CAAQ,GACrCM,IAAiC;AAAA,QACrC,YAAYL;AAAA,QACZ,OAAOD,EAAS;AAAA,QAChB,aAAaA,EAAS;AAAA,MAAA;AAGxB,MAAAD,EAAU,KAAKQ,EAAWH,GAASD,GAAMG,CAAM,CAAC;AAAA,IAClD;AAEA,IAAIP,EAAU,WAAW,KAEzBF,EAAO,KAAK;AAAA,MACV,OAAOC,EAAW;AAAA,MAClB,WAAAC;AAAA,IAAA,CACD;AAAA,EACH;AAEA,SAAOF;AACT;AAEA,SAASU,EACPH,GACAD,GACAG,GAC4B;AAC5B,UAAQF,GAAA;AAAA,IACN,KAAK;AACH,aAAO;AAAA,QACL,MAAM;AAAA,QACN,OAAO,SAAkCI,GAAiC;AACxE,iBAAO,gBAAAC,EAACC,GAAA,EAAoB,MAAAP,GAAa,GAAGK,EAAA,CAAO;AAAA,QACrD;AAAA,QACA,GAAGF;AAAA,MAAA;AAAA,IAEP,KAAK;AACH,aAAO;AAAA,QACL,MAAM;AAAA,QACN,OAAO,SAAiCE,GAAgC;AACtE,iBAAO,gBAAAC,EAACE,GAAA,EAAmB,MAAAR,GAAa,GAAGK,EAAA,CAAO;AAAA,QACpD;AAAA,QACA,GAAGF;AAAA,MAAA;AAAA,IAEP,KAAK;AACH,aAAO;AAAA,QACL,MAAM;AAAA,QACN,OAAO,SAAgCE,GAA+B;AACpE,iBAAO,gBAAAC,EAACG,GAAA,EAAkB,MAAAT,GAAa,GAAGK,EAAA,CAAO;AAAA,QACnD;AAAA,QACA,GAAGF;AAAA,MAAA;AAAA,IAEP,KAAK;AACH,aAAO;AAAA,QACL,MAAM;AAAA,QACN,OAAO,SAAkCE,GAAiC;AACxE,iBAAO,gBAAAC,EAACI,GAAA,EAAoB,MAAAV,GAAa,GAAGK,EAAA,CAAO;AAAA,QACrD;AAAA,QACA,GAAGF;AAAA,MAAA;AAAA,IAEP,KAAK;AACH,aAAO;AAAA,QACL,MAAM;AAAA,QACN,OAAO,SAAoCE,GAAmC;AAC5E,iBAAO,gBAAAC,EAACK,GAAA,EAAsB,MAAAX,GAAa,GAAGK,EAAA,CAAO;AAAA,QACvD;AAAA,QACA,GAAGF;AAAA,MAAA;AAAA,IAEP,KAAK;AACH,aAAO;AAAA,QACL,MAAM;AAAA,QACN,OAAO,SAAgCE,GAA+B;AACpE,iBAAO,gBAAAC,EAACM,GAAA,EAAkB,MAAAZ,GAAa,GAAGK,EAAA,CAAO;AAAA,QACnD;AAAA,QACA,GAAGF;AAAA,MAAA;AAAA,EACL;AAEN;AAWO,SAASU,EACdtB,GACAE,GACuB;AACvB,SAAOqB;AAAA,IACL,MAAMxB,EAAkBC,GAAoB,EAAE,SAAAE,GAAS;AAAA,IACvD,CAACF,GAAoBE,CAAO;AAAA,EAAA;AAEhC;"}

package/dist/components/Employee/StateTaxes/shared/useEmployeeStateTaxesForm/useEmployeeStateTaxesForm.d.ts

@@ -3,7 +3,13 @@ import { EmployeeStateTaxesList } from '@gusto/embedded-api-v-2025-11-15/models/
 import { EmployeeStateTaxesFormData } from './employeeStateTaxesSchema';
 import { StateTaxFieldsGroup } from './fields';
 import { BaseFormHookReady, FieldsMetadata, HookLoadingResult, HookSubmitResult } from '../../../../../partner-hook-utils/types';
+/**
+ * Options accepted by {@link useEmployeeStateTaxesForm}.
+ *
+ * @public
+ */
 export interface UseEmployeeStateTaxesFormProps {
+    /** The UUID of the employee whose state taxes are being updated. */
     employeeId: string;
     /**
      * When `true`, admin-only questions are visible and submitted. When
@@ -11,26 +17,126 @@ export interface UseEmployeeStateTaxesFormProps {
      * questions is preserved unchanged on submit.
      */
     isAdmin?: boolean;
+    /** When validation runs. Passed through to react-hook-form. Defaults to `'onSubmit'`. */
     validationMode?: UseFormProps['mode'];
+    /** Auto-focus the first invalid field on submit. Defaults to `true`. Set to `false` when composing with other forms. */
     shouldFocusError?: boolean;
 }
+/**
+ * Ready-state return value of {@link useEmployeeStateTaxesForm} — the
+ * `isLoading: false` branch of {@link UseEmployeeStateTaxesFormResult}.
+ *
+ * @public
+ */
 export interface UseEmployeeStateTaxesFormReady extends BaseFormHookReady<FieldsMetadata, EmployeeStateTaxesFormData, StateTaxFieldsGroup[]> {
+    /** Current per-state tax records returned by the server. */
     data: {
         employeeStateTaxes: EmployeeStateTaxesList[];
     };
+    /** Submission status. `mode` is always `'update'` since state-tax records are created with the employee. */
     status: {
         isPending: boolean;
         mode: 'update';
     };
+    /** Form actions. */
     actions: {
+        /** Validates and submits the form, resolving to the updated records on success or `undefined` when validation blocked the submit. */
         onSubmit: () => Promise<HookSubmitResult<EmployeeStateTaxesList[]> | undefined>;
     };
+    /** Form internals plus the iterable per-state `Fields` array. */
     form: BaseFormHookReady<FieldsMetadata, EmployeeStateTaxesFormData, StateTaxFieldsGroup[]>['form'] & {
         /** Iterable, render-ready group + question entries with bound Field components. */
         Fields: StateTaxFieldsGroup[];
     };
 }
+/**
+ * Discriminated union returned by {@link useEmployeeStateTaxesForm}. Loading
+ * branch carries only `errorHandling`; ready branch carries form data,
+ * fields, status, and actions.
+ *
+ * @public
+ */
 export type UseEmployeeStateTaxesFormResult = HookLoadingResult | UseEmployeeStateTaxesFormReady;
+/**
+ * Headless form hook for updating an employee's state tax withholding answers.
+ * The set of questions is driven by the API response per state, so
+ * `form.Fields` is an array of state groups with discriminated, render-ready
+ * `Field` components rather than a fixed named object.
+ *
+ * @remarks
+ * The state-tax record(s) are created automatically with the employee, so this
+ * hook is always in update mode. When the form has no states with submittable
+ * answers (e.g. an employee in a no-income-tax state), submit resolves with
+ * the existing record list without making a network request.
+ *
+ * @param props - Hook options.
+ * @returns A loading result while data is fetching, or a ready result with
+ * form data, fields, status, actions, and error handling.
+ * @public
+ *
+ * @example
+ * ```tsx
+ * import {
+ *   useEmployeeStateTaxesForm,
+ *   SDKFormProvider,
+ *   type UseEmployeeStateTaxesFormReady,
+ * } from '@gusto/embedded-react-sdk'
+ *
+ * function StateTaxesPage({ employeeId }: { employeeId: string }) {
+ *   const stateTaxes = useEmployeeStateTaxesForm({ employeeId })
+ *
+ *   if (stateTaxes.isLoading) return <div>Loading...</div>
+ *
+ *   return <StateTaxesFormReady stateTaxes={stateTaxes} />
+ * }
+ *
+ * function StateTaxesFormReady({
+ *   stateTaxes,
+ * }: {
+ *   stateTaxes: UseEmployeeStateTaxesFormReady
+ * }) {
+ *   const handleSubmit = async () => {
+ *     const result = await stateTaxes.actions.onSubmit()
+ *     if (result) console.log('Updated state tax records:', result.data)
+ *   }
+ *
+ *   return (
+ *     <SDKFormProvider formHookResult={stateTaxes}>
+ *       <form
+ *         onSubmit={e => {
+ *           e.preventDefault()
+ *           void handleSubmit()
+ *         }}
+ *       >
+ *         {stateTaxes.form.Fields.map(group => (
+ *           <section key={group.state}>
+ *             <h2>{group.state}</h2>
+ *             {group.questions.map(question => (
+ *               <question.Field key={question.questionId} />
+ *             ))}
+ *           </section>
+ *         ))}
+ *         <button type="submit" disabled={stateTaxes.status.isPending}>
+ *           Save
+ *         </button>
+ *       </form>
+ *     </SDKFormProvider>
+ *   )
+ * }
+ * ```
+ */
 export declare function useEmployeeStateTaxesForm({ employeeId, isAdmin, validationMode, shouldFocusError, }: UseEmployeeStateTaxesFormProps): UseEmployeeStateTaxesFormResult;
+/**
+ * Static field metadata keyed by full form path (`states.<STATE>.<camelKey>`),
+ * with `isRequired` / `isDisabled` and option lists.
+ *
+ * @public
+ */
 export type EmployeeStateTaxesFieldsMetadata = UseEmployeeStateTaxesFormReady['form']['fieldsMetadata'];
+/**
+ * The array of per-state field groups exposed by
+ * {@link useEmployeeStateTaxesForm} on `form.Fields`.
+ *
+ * @public
+ */
 export type EmployeeStateTaxesFormFields = UseEmployeeStateTaxesFormReady['form']['Fields'];