@classytic/formkit 1.3.0 → 1.4.0

package/dist/server.d.mts

@@ -31,7 +31,7 @@ declare function cn(...inputs: ClassValue[]): string;
  * Field type identifier.
  * Can be built-in types or custom string identifiers.
  */
-type FieldType = "text" | "email" | "password" | "number" | "tel" | "url" | "textarea" | "select" | "checkbox" | "radio" | "switch" | "date" | "time" | "datetime" | "file" | "hidden" | "group" | "array" | "custom" | (string & {});
+type FieldType = "text" | "email" | "password" | "number" | "tel" | "phone" | "url" | "textarea" | "slug" | "select" | "combobox" | "multiselect" | "dependentSelect" | "checkbox" | "radio" | "switch" | "date" | "time" | "datetime" | "rich-text" | "color" | "rating" | "tags" | "json" | "file" | "hidden" | "group" | "array" | "custom" | (string & {});
 /**
  * Layout type identifier.
  */
@@ -93,12 +93,55 @@ interface FieldOptionGroup<TValue = string> {
   /** Whether group is disabled */
   disabled?: boolean;
 }
+/**
+ * Object form for length/range validation rules with a custom message.
+ */
+interface ValidationRuleObject<TValue = number> {
+  value: TValue;
+  message: string;
+}
+/**
+ * Object form for pattern validation with a custom message.
+ */
+interface PatternRuleObject {
+  /** Regex string (will be compiled with `new RegExp(regex)`) */
+  regex: string;
+  /** Custom error message */
+  message: string;
+}
+/**
+ * AI-friendly metadata attached to any field.
+ * Consumed by LLM coding assistants, documentation generators, and
+ * schema-introspection tools — never by the form renderer itself.
+ */
+interface FieldMeta {
+  /** Human-readable description of what this field collects */
+  description?: string;
+  /** Representative example value (for documentation / AI context) */
+  example?: unknown;
+  /** Logical category for grouping fields in documentation or tooling */
+  category?: string;
+  /** Arbitrary tags for filtering, search, or feature-flagging */
+  tags?: string[];
+  /** Whether this field is considered PII */
+  pii?: boolean;
+  /** Arbitrary extension point — anything extra you want to carry */
+  [key: string]: unknown;
+}
 /**
  * Base field configuration shared by all field types.
  * @template TFieldValues - Form field values type for type-safe field names
  */
 interface BaseField<TFieldValues extends FieldValues = FieldValues> {
-  /** Field name (must be a valid path in form values) */
+  /**
+   * Field name — a path into TFieldValues (e.g. `"email"`, `"address.street"`).
+   *
+   * Accepts any string so that:
+   * - Namespaced sections can use relative names (`"street"` → prefixed to `"address.street"`)
+   * - Group/array `itemFields` can use relative names (`"email"` → prefixed at render time)
+   *
+   * Use `field.for<T>()` builder for call-site enforcement that names are valid paths.
+   */
   name: Path<TFieldValues> | (string & {});
   /** Field type identifier */
   type: FieldType;
@@ -129,18 +172,41 @@ interface BaseField<TFieldValues extends FieldValues = FieldValues> {
   defaultValue?: unknown;
   /** Options for select/radio/checkbox fields */
   options?: (FieldOption | FieldOptionGroup)[];
-  /** Minimum value (for number/date fields) */
-  min?: number | string;
-  /** Maximum value (for number/date fields) */
-  max?: number | string;
+  /**
+   * Minimum value (for number/date fields).
+   * Pass an object `{ value, message }` to provide a custom error message.
+   */
+  min?: number | string | ValidationRuleObject<number | string>;
+  /**
+   * Maximum value (for number/date fields).
+   * Pass an object `{ value, message }` to provide a custom error message.
+   */
+  max?: number | string | ValidationRuleObject<number | string>;
   /** Step value (for number fields) */
   step?: number;
-  /** Pattern for validation (regex string) */
-  pattern?: string;
-  /** Minimum length */
-  minLength?: number;
-  /** Maximum length */
-  maxLength?: number;
+  /**
+   * Pattern for validation.
+   * Pass a regex string or `{ regex, message }` for a custom error message.
+   *
+   * @example
+   * ```ts
+   * // simple
+   * pattern: "^[a-z]+$"
+   * // with custom message
+   * pattern: { regex: "^[a-z]+$", message: "Only lowercase letters allowed" }
+   * ```
+   */
+  pattern?: string | PatternRuleObject;
+  /**
+   * Minimum length.
+   * Pass an object `{ value, message }` to provide a custom error message.
+   */
+  minLength?: number | ValidationRuleObject<number>;
+  /**
+   * Maximum length.
+   * Pass an object `{ value, message }` to provide a custom error message.
+   */
+  maxLength?: number | ValidationRuleObject<number>;
   /** Number of rows (for textarea) */
   rows?: number;
   /** Multiple selection (for select/file) */
@@ -164,10 +230,13 @@ interface BaseField<TFieldValues extends FieldValues = FieldValues> {
    */
   onLoadError?: (error: unknown) => void;
   /**
-   * Fields for array or object types.
-   * Useful for 'array' or 'group' field types that need a sub-schema.
+   * Sub-fields for `group` and `array` field types.
+   *
+   * These fields use **relative** names (`"street"`, `"email"`) — FormGenerator
+   * prefixes them with the parent field name at render time (`"address.street"`).
+   * They are intentionally untyped to TFieldValues for this reason.
    */
-  itemFields?: BaseField<TFieldValues>[];
+  itemFields?: BaseField[];
   /**
    * Custom render function to override the component registry for this specific field.
    * Completely bypasses the globally registered FieldComponent for this type.
@@ -176,15 +245,22 @@ interface BaseField<TFieldValues extends FieldValues = FieldValues> {
   /**
    * Cross-field validation function.
    * Receives the field value and all form values for cross-field checks.
-   * Return `true` for valid, or a string error message for invalid.
+   * Return `true` for valid, a string error message for invalid, or a Promise of either
+   * for async validation (e.g., checking server-side uniqueness).
    *
    * @example
    * ```ts
    * validate: (value, formValues) =>
    *   value > formValues.minPrice || "Must be greater than min price"
+   *
+   * // Async example
+   * validate: async (value) => {
+   *   const taken = await checkUsernameAvailability(value as string);
+   *   return taken ? "Username already taken" : true;
+   * }
    * ```
    */
-  validate?: (value: unknown, formValues: Partial<TFieldValues>) => string | true;
+  validate?: (value: unknown, formValues: Partial<TFieldValues>) => string | true | Promise<string | true>;
   /**
    * Dependencies for optimizing conditionally rendered fields.
    * Allows specifying specific field names to watch, preventing full form re-renders.
@@ -192,6 +268,32 @@ interface BaseField<TFieldValues extends FieldValues = FieldValues> {
   watchNames?: Path<TFieldValues> | Path<TFieldValues>[];
   /** Additional field-specific props for custom components */
   customProps?: Record<string, unknown>;
+  /**
+   * AI / agent-friendly metadata for this field.
+   *
+   * Provides hints that help LLM coding assistants generate correct field
+   * configs without needing to inspect the schema at runtime.
+   *
+   * @example
+   * ```ts
+   * field.text("companyName", "Company", {
+   *   meta: {
+   *     description: "Legal entity name of the organization",
+   *     example: "Acme Corp",
+   *     category: "identity",
+   *     tags: ["crm", "required-for-billing"],
+   *   }
+   * })
+   * ```
+   */
+  meta?: FieldMeta;
+  /**
+   * Escape hatch for adapter-specific or custom props.
+   * Allows passing arbitrary props directly on the field object so they
+   * flow through the adapter spread (`{...field}`) without needing `customProps`.
+   * Intentionally broad to support diverse UI component libraries.
+   */
+  [key: string]: unknown;
 }
 /**
  * Props passed to field components.
@@ -237,13 +339,68 @@ interface FieldComponentProps<TFieldValues extends FieldValues = FieldValues> ex
     invalid: boolean;
     isDirty: boolean;
     isTouched: boolean;
-    isValidating: boolean;
+    isValidating: boolean; /** True after the enclosing form's submit handler has been called at least once. */
+    isSubmitted: boolean;
     error?: FieldError;
   };
-  /** Generated field ID for label-input association (e.g. `formkit-field-email`) */
+  /**
+   * Generated field ID for label-input association (e.g. `formkit-field-email`).
+   * Use as `id` on the input element and `htmlFor` on the `<label>`.
+   */
   fieldId: string;
+  /**
+   * Generated error container ID for ARIA association (e.g. `formkit-field-email-error`).
+   * Use as `id` on the error message element and as the value for `aria-errormessage`
+   * (preferred) or `aria-describedby` (broader support) on the input.
+   *
+   * @example
+   * ```tsx
+   * <input
+   *   id={fieldId}
+   *   aria-invalid={shouldShowError || undefined}
+   *   aria-errormessage={shouldShowError ? errorId : undefined}
+   * />
+   * <p id={errorId} role="alert" aria-live="polite">
+   *   {shouldShowError ? error?.message : null}
+   * </p>
+   * ```
+   */
+  errorId: string;
+  /**
+   * Whether to display the field error right now.
+   *
+   * Aligns with the CSS `:user-invalid` timing model: `true` only after the
+   * user has interacted with the field (blur) **or** the form has been
+   * submitted. This prevents premature "required" errors on untouched fields.
+   *
+   * Use this — not `!!error` — to drive `aria-invalid`, error message
+   * visibility, and destructive ring/border styles.
+   *
+   * @example
+   * ```tsx
+   * <input aria-invalid={shouldShowError || undefined} />
+   * {shouldShowError && <p id={errorId} role="alert">{error?.message}</p>}
+   * ```
+   */
+  shouldShowError: boolean;
   /** Whether dynamic options are currently loading */
   isLoading?: boolean;
+  /**
+   * Pre-computed react-hook-form validation rules for this field.
+   * Equivalent to calling `buildValidationRules(field)` — provided here so
+   * adapter components can pass `rules={rules}` directly to `<Controller>`
+   * without importing or calling `buildValidationRules` themselves.
+   *
+   * @example
+   * ```tsx
+   * function TextInput({ field, control, rules }: FieldComponentProps) {
+   *   return (
+   *     <Controller name={field.name} control={control} rules={rules} render={...} />
+   *   );
+   * }
+   * ```
+   */
+  rules: ValidationRules;
 }
 /**
  * Validation rules compatible with react-hook-form's RegisterOptions.
@@ -289,6 +446,17 @@ interface Section<TFieldValues extends FieldValues = FieldValues> {
   collapsible?: boolean;
   /** Default collapsed state */
   defaultCollapsed?: boolean;
+  /**
+   * Defer rendering of this section until it scrolls near the viewport.
+   * Applies `content-visibility: auto` + `contain-intrinsic-size` to the
+   * section container, skipping layout/paint work while off-screen.
+   *
+   * **Only use for sections that are below the initial fold.** Applying this
+   * to above-fold sections has no benefit and slightly increases overhead.
+   *
+   * @see https://developer.mozilla.org/en-US/docs/Web/CSS/content-visibility
+   */
+  deferRender?: boolean;
 }
 /**
  * Props passed to section render function.
@@ -316,6 +484,12 @@ interface SectionLayoutProps {
   collapsible?: boolean;
   /** Default collapsed state */
   defaultCollapsed?: boolean;
+  /**
+   * When true the section is below the initial fold and should defer
+   * browser layout/paint work until it nears the viewport.
+   * Layout components may apply `content-visibility: auto` here.
+   */
+  deferRender?: boolean;
   /** Children content */
   children: ReactNode;
 }
@@ -350,6 +524,12 @@ type LayoutComponentProps = SectionLayoutProps | GridLayoutProps | DefaultLayout
  * @template TFieldValues - Form field values type for type-safe schemas
  */
 interface FormSchema<TFieldValues extends FieldValues = FieldValues> {
+  /** Optional schema identifier — useful for serialization, analytics, and AI context */
+  id?: string;
+  /** Human-readable form title (AI / documentation use) */
+  title?: string;
+  /** Human-readable description of the form's purpose */
+  description?: string;
   /** Form sections */
   sections: Section<TFieldValues>[];
 }
@@ -402,6 +582,7 @@ declare function defineSection<TFieldValues extends FieldValues = FieldValues>(s
 /**
  * Extracts default values from a form schema.
  * Walks all sections and fields, respecting nameSpace prefixes and group nesting.
+ * Array fields default to `[]` when no explicit `defaultValue` is provided.
  *
  * @example
  * ```ts
@@ -415,6 +596,9 @@ declare function extractDefaultValues<TFieldValues extends FieldValues = FieldVa
  * from a field's schema props. Maps `required`, `min`, `max`, `minLength`,
  * `maxLength`, `pattern`, and `validate` to RHF rules.
  *
+ * Supports both shorthand scalars and `{ value, message }` objects for all
+ * numeric/length rules, and `{ regex, message }` for pattern.
+ *
  * @example
  * ```tsx
  * import { buildValidationRules } from '@classytic/formkit';
@@ -426,175 +610,147 @@ declare function extractDefaultValues<TFieldValues extends FieldValues = FieldVa
  * ```
  */
 declare function buildValidationRules<TFieldValues extends FieldValues = FieldValues>(field: BaseField<TFieldValues>): ValidationRules;
+/** Returns true for fields that carry an `options` array (select, radio, etc.) */
+declare function isChoiceField(field: BaseField): boolean;
+/** Returns true for free-text input fields */
+declare function isTextField(field: BaseField): boolean;
+/** Returns true for numeric input fields */
+declare function isNumericField(field: BaseField): boolean;
+/** Returns true for date / time fields */
+declare function isDateField(field: BaseField): boolean;
+/** Returns true for structural fields that contain sub-fields (`itemFields`) */
+declare function isContainerField(field: BaseField): boolean;
+/** Returns true for array fields that render a repeatable list */
+declare function isArrayField(field: BaseField): boolean;
+/** Returns true for fields that load options asynchronously */
+declare function isDynamicField(field: BaseField): boolean;
+/** Returns true for fields with conditional rendering */
+declare function isConditionalField(field: BaseField): boolean;
+/**
+ * Merge two or more schemas into one, concatenating their sections.
+ *
+ * @example
+ * ```ts
+ * const full = mergeSchemas(personalSchema, addressSchema, billingSchema);
+ * ```
+ */
+declare function mergeSchemas<TFieldValues extends FieldValues = FieldValues>(...schemas: FormSchema<TFieldValues>[]): FormSchema<TFieldValues>;
+/**
+ * Add fields to a section identified by `sectionId`.
+ * Returns a new schema — the original is not mutated.
+ *
+ * @example
+ * ```ts
+ * const extended = extendSection(schema, "personal", [
+ *   field.text("middleName", "Middle Name"),
+ * ]);
+ * ```
+ */
+declare function extendSection<TFieldValues extends FieldValues = FieldValues>(schema: FormSchema<TFieldValues>, sectionId: string, fields: BaseField<TFieldValues>[], position?: "start" | "end"): FormSchema<TFieldValues>;
+/**
+ * Create a new schema that includes only the named fields.
+ *
+ * @example
+ * ```ts
+ * const slim = pickFields(schema, ["email", "password"]);
+ * ```
+ */
+declare function pickFields<TFieldValues extends FieldValues = FieldValues>(schema: FormSchema<TFieldValues>, names: string[]): FormSchema<TFieldValues>;
+/**
+ * Create a new schema that excludes the named fields.
+ *
+ * @example
+ * ```ts
+ * const withoutInternal = omitFields(schema, ["__id", "__createdAt"]);
+ * ```
+ */
+declare function omitFields<TFieldValues extends FieldValues = FieldValues>(schema: FormSchema<TFieldValues>, names: string[]): FormSchema<TFieldValues>;
+/**
+ * Collect every field from every section into a flat array.
+ * Useful for validation, documentation, and AI schema introspection.
+ *
+ * @example
+ * ```ts
+ * const allFields = flattenSchema(schema);
+ * const required = allFields.filter(f => f.required);
+ * ```
+ */
+declare function flattenSchema<TFieldValues extends FieldValues = FieldValues>(schema: FormSchema<TFieldValues>): BaseField<TFieldValues>[];
 //#endregion
 //#region src/builders.d.ts
 /**
- * Additional field props for builder helpers.
+ * Additional field props accepted by builder helpers.
  * Accepts all BaseField properties except `name`, `type`, and `label`
- * which are set by the builder method.
+ * which are provided by the builder method directly.
  */
-type FieldProps<TFieldValues extends FieldValues = FieldValues> = Omit<BaseField<TFieldValues>, "name" | "type" | "label"> & {
-  /** Grid column class (e.g., "col-span-2") */gridColumn?: string; /** Icon for the left side of input */
-  iconLeft?: ReactNode; /** Icon for the right side of input */
-  iconRight?: ReactNode; /** Additional custom props */
-  [key: string]: unknown;
-};
+type FieldProps<TFieldValues extends FieldValues = FieldValues> = Omit<BaseField<TFieldValues>, "name" | "type" | "label">;
 /**
  * Section configuration props.
  */
 interface SectionProps<TFieldValues extends FieldValues = FieldValues> extends Omit<Section<TFieldValues>, "id" | "title" | "fields" | "cols"> {
   cols?: number;
 }
-/**
- * Render function for custom field types.
- */
-type CustomRenderFn = (props: {
-  control: Control<FieldValues>;
-  disabled?: boolean;
-  error?: FieldError;
-}) => ReactNode;
 /**
  * Type-safe field builder helpers for schema-driven forms.
  *
- * Provides shorthand methods for common field types with sensible defaults,
- * reducing boilerplate while maintaining full type safety.
+ * All methods are generic over TFieldValues, defaulting to FieldValues (any string)
+ * when no type argument is provided. Specify the generic to enforce that field
+ * names are valid paths in your form values type.
+ *
+ * For fully-typed schemas where every field name is checked, prefer
+ * `field.for<MyForm>()` which fixes the generic once for the whole schema:
  *
  * @example
  * ```ts
- * import { field, section } from '@classytic/formkit';
+ * // Untyped — any string accepted (backwards compatible)
+ * field.text("email", "Email")
  *
- * const schema = {
- *   sections: [
- *     section("personal", "Personal Info", [
- *       field.text("firstName", "First Name", { required: true }),
- *       field.email("email", "Email"),
- *       field.select("role", "Role", [
- *         { label: "Admin", value: "admin" },
- *         { label: "User", value: "user" },
- *       ]),
- *     ], { cols: 2 }),
- *   ],
- * };
+ * // Per-call generic — name is checked against MyForm
+ * field.text<MyForm>("email", "Email")
+ *
+ * // Typed factory — name checked on every call without repeating the generic
+ * const f = field.for<MyForm>()
+ * f.text("email", "Email")        // ✓
+ * f.text("typo", "Email")         // ✗ TypeScript error
  * ```
  */
 declare const field: {
-  /**
-   * Text input field.
-   */
-  text: (name: string, label: string, props?: FieldProps) => BaseField;
-  /**
-   * Email input field with default placeholder.
-   */
-  email: (name: string, label: string, props?: FieldProps) => BaseField;
-  /**
-   * URL input field with default placeholder.
-   */
-  url: (name: string, label: string, props?: FieldProps) => BaseField;
-  /**
-   * Phone/tel input field with default placeholder.
-   */
-  tel: (name: string, label: string, props?: FieldProps) => BaseField;
-  /**
-   * Password input field.
-   */
-  password: (name: string, label: string, props?: FieldProps) => BaseField;
-  /**
-   * Number input field with min: 0 default.
-   */
-  number: (name: string, label: string, props?: FieldProps) => BaseField;
-  /**
-   * Textarea field with default 3 rows.
-   */
-  textarea: (name: string, label: string, props?: FieldProps) => BaseField;
-  /**
-   * Select dropdown field.
-   */
-  select: (name: string, label: string, options: (FieldOption | FieldOptionGroup)[], props?: FieldProps) => BaseField;
-  /**
-   * Searchable combobox field.
-   */
-  combobox: (name: string, label: string, options: (FieldOption | FieldOptionGroup)[], props?: FieldProps) => BaseField;
-  /**
-   * Multi-select field (tag choice).
-   */
-  multiselect: (name: string, label: string, options: (FieldOption | FieldOptionGroup)[], props?: FieldProps) => BaseField;
-  /**
-   * Tag choice field for selecting options as tags/chips.
-   */
-  tagChoice: (name: string, label: string, options: (FieldOption | FieldOptionGroup)[], props?: FieldProps) => BaseField;
-  /**
-   * Dependent select field that reacts to parent field changes.
-   */
-  dependentSelect: (name: string, label: string, props?: FieldProps) => BaseField;
-  /**
-   * Switch/toggle field.
-   */
-  switch: (name: string, label: string, props?: FieldProps) => BaseField;
-  /**
-   * Boolean field (alias for switch).
-   */
-  boolean: (name: string, label: string, props?: FieldProps) => BaseField;
-  /**
-   * Checkbox field.
-   */
-  checkbox: (name: string, label: string, props?: FieldProps) => BaseField;
-  /**
-   * Radio button group field.
-   */
-  radio: (name: string, label: string, options: FieldOption[], props?: FieldProps) => BaseField;
-  /**
-   * Date picker field.
-   */
-  date: (name: string, label: string, props?: FieldProps) => BaseField;
-  /**
-   * Tag input field with default placeholder.
-   */
-  tags: (name: string, label: string, props?: FieldProps) => BaseField;
-  /**
-   * Slug field with auto-generation from source value.
-   */
-  slug: (name: string, label: string, props?: FieldProps) => BaseField;
-  /**
-   * File upload field.
-   */
-  file: (name: string, label: string, props?: FieldProps) => BaseField;
-  /**
-   * OTP/PIN input field.
-   */
-  otp: (name: string, label: string, props?: FieldProps) => BaseField;
-  /**
-   * Async searchable combobox with server-side search.
-   */
-  asyncCombobox: (name: string, label: string, props?: FieldProps) => BaseField;
-  /**
-   * Async searchable multi-select with server-side search.
-   */
-  asyncMultiselect: (name: string, label: string, props?: FieldProps) => BaseField;
-  /**
-   * Date and optional time picker field.
-   */
-  dateTime: (name: string, label: string, props?: FieldProps) => BaseField;
-  /**
-   * Hidden field (no UI).
-   */
-  hidden: (name: string, props?: FieldProps) => BaseField;
+  /** Text input field. */text: <T extends FieldValues = FieldValues>(name: Path<T>, label: string, props?: FieldProps<T>) => BaseField<T>; /** Email input field with default placeholder. */
+  email: <T extends FieldValues = FieldValues>(name: Path<T>, label: string, props?: FieldProps<T>) => BaseField<T>; /** URL input field with default placeholder. */
+  url: <T extends FieldValues = FieldValues>(name: Path<T>, label: string, props?: FieldProps<T>) => BaseField<T>; /** Phone/tel input field with default placeholder. */
+  tel: <T extends FieldValues = FieldValues>(name: Path<T>, label: string, props?: FieldProps<T>) => BaseField<T>; /** Password input field. */
+  password: <T extends FieldValues = FieldValues>(name: Path<T>, label: string, props?: FieldProps<T>) => BaseField<T>; /** Number input field with min: 0 default (overrideable via props). */
+  number: <T extends FieldValues = FieldValues>(name: Path<T>, label: string, props?: FieldProps<T>) => BaseField<T>; /** Textarea field with default 3 rows. */
+  textarea: <T extends FieldValues = FieldValues>(name: Path<T>, label: string, props?: FieldProps<T>) => BaseField<T>; /** Select dropdown field. */
+  select: <T extends FieldValues = FieldValues>(name: Path<T>, label: string, options: (FieldOption | FieldOptionGroup)[], props?: FieldProps<T>) => BaseField<T>; /** Searchable combobox field. */
+  combobox: <T extends FieldValues = FieldValues>(name: Path<T>, label: string, options: (FieldOption | FieldOptionGroup)[], props?: FieldProps<T>) => BaseField<T>; /** Multi-select field. */
+  multiselect: <T extends FieldValues = FieldValues>(name: Path<T>, label: string, options: (FieldOption | FieldOptionGroup)[], props?: FieldProps<T>) => BaseField<T>; /** Dependent select field that reacts to parent field changes. */
+  dependentSelect: <T extends FieldValues = FieldValues>(name: Path<T>, label: string, props?: FieldProps<T>) => BaseField<T>; /** Switch/toggle field. */
+  switch: <T extends FieldValues = FieldValues>(name: Path<T>, label: string, props?: FieldProps<T>) => BaseField<T>; /** Boolean field (alias for switch). */
+  boolean: <T extends FieldValues = FieldValues>(name: Path<T>, label: string, props?: FieldProps<T>) => BaseField<T>; /** Checkbox field. */
+  checkbox: <T extends FieldValues = FieldValues>(name: Path<T>, label: string, props?: FieldProps<T>) => BaseField<T>; /** Radio button group field. */
+  radio: <T extends FieldValues = FieldValues>(name: Path<T>, label: string, options: FieldOption[], props?: FieldProps<T>) => BaseField<T>; /** Date picker field. */
+  date: <T extends FieldValues = FieldValues>(name: Path<T>, label: string, props?: FieldProps<T>) => BaseField<T>; /** Tag input field. */
+  tags: <T extends FieldValues = FieldValues>(name: Path<T>, label: string, props?: FieldProps<T>) => BaseField<T>; /** Slug field. */
+  slug: <T extends FieldValues = FieldValues>(name: Path<T>, label: string, props?: FieldProps<T>) => BaseField<T>; /** File upload field. */
+  file: <T extends FieldValues = FieldValues>(name: Path<T>, label: string, props?: FieldProps<T>) => BaseField<T>; /** Hidden field (no UI). */
+  hidden: <T extends FieldValues = FieldValues>(name: Path<T>, props?: FieldProps<T>) => BaseField<T>;
   /**
    * Group field for nested objects.
-   * Renders itemFields as a sub-grid within the form.
+   * Renders itemFields as a sub-grid. Child names are relative (e.g. "street"),
+   * FormGenerator prefixes them with the group name at render time.
    *
    * @example
    * ```ts
    * field.group("address", "Address", [
    *   field.text("street", "Street"),
    *   field.text("city", "City"),
-   *   field.text("zip", "ZIP Code"),
-   * ], { cols: 3 })
+   * ], { cols: 2 })
    * ```
    */
-  group: (name: string, label: string, itemFields: BaseField[], props?: FieldProps) => BaseField;
+  group: <T extends FieldValues = FieldValues>(name: Path<T>, label: string, itemFields: BaseField[], props?: FieldProps<T>) => BaseField<T>;
   /**
-   * Array/repeatable field.
-   * Renders a dynamic list of sub-forms using react-hook-form's useFieldArray.
+   * Array/repeatable field backed by react-hook-form's useFieldArray.
    *
    * @example
    * ```ts
@@ -604,41 +760,108 @@ declare const field: {
    * ])
    * ```
    */
-  array: (name: string, label: string, itemFields: BaseField[], props?: FieldProps) => BaseField;
+  array: <T extends FieldValues = FieldValues>(name: Path<T>, label: string, itemFields: BaseField[], props?: FieldProps<T>) => BaseField<T>;
   /**
    * Custom field with a render function.
-   * Bypasses the component registry entirely.
+   * Bypasses the component registry — full control over rendering.
+   *
+   * The render callback receives the complete `FieldComponentProps` including
+   * `fieldId`, `errorId`, `shouldShowError`, `error`, `rules`, and `control`.
+   *
+   * Use `shouldShowError` (not `!!error`) to drive `aria-invalid` and error
+   * visibility so timing mirrors the CSS `:user-invalid` pseudo-class.
    *
    * @example
-   * ```ts
-   * field.custom("skills", "Skills", ({ control, disabled }) => (
-   *   <SkillSelector control={control} disabled={disabled} />
+   * ```tsx
+   * field.custom("skills", "Skills", ({ control, shouldShowError, errorId, error, fieldId }) => (
+   *   <div>
+   *     <SkillSelector
+   *       id={fieldId}
+   *       control={control}
+   *       aria-invalid={shouldShowError || undefined}
+   *       aria-errormessage={shouldShowError ? errorId : undefined}
+   *     />
+   *     {shouldShowError && (
+   *       <p id={errorId} role="alert" className="text-sm text-destructive">
+   *         {error?.message}
+   *       </p>
+   *     )}
+   *   </div>
    * ))
    * ```
    */
-  custom: (name: string, label: string, render: CustomRenderFn, props?: FieldProps) => BaseField;
+  custom: <T extends FieldValues = FieldValues>(name: Path<T>, label: string, render: (props: FieldComponentProps<T>) => ReactNode, props?: FieldProps<T>) => BaseField<T>;
+  /**
+   * Returns a typed field builder with `TFieldValues` fixed.
+   * Every field name is validated against `Path<TFieldValues>` at the call site —
+   * no need to repeat the generic on each individual builder call.
+   *
+   * @example
+   * ```ts
+   * interface ContactForm {
+   *   firstName: string;
+   *   email: string;
+   *   address: { street: string; city: string };
+   * }
+   *
+   * const f = field.for<ContactForm>()
+   *
+   * const schema = defineSchema<ContactForm>({
+   *   sections: [{
+   *     fields: [
+   *       f.text("firstName", "First Name"),     // ✓
+   *       f.email("email", "Email"),              // ✓
+   *       f.text("typo", "Label"),                // ✗ TypeScript error
+   *     ],
+   *   }],
+   * })
+   * ```
+   */
+  for: <T extends FieldValues>() => {
+    text: (name: Path<T>, label: string, props?: FieldProps<T>) => BaseField<T>;
+    email: (name: Path<T>, label: string, props?: FieldProps<T>) => BaseField<T>;
+    url: (name: Path<T>, label: string, props?: FieldProps<T>) => BaseField<T>;
+    tel: (name: Path<T>, label: string, props?: FieldProps<T>) => BaseField<T>;
+    password: (name: Path<T>, label: string, props?: FieldProps<T>) => BaseField<T>;
+    number: (name: Path<T>, label: string, props?: FieldProps<T>) => BaseField<T>;
+    textarea: (name: Path<T>, label: string, props?: FieldProps<T>) => BaseField<T>;
+    select: (name: Path<T>, label: string, options: (FieldOption | FieldOptionGroup)[], props?: FieldProps<T>) => BaseField<T>;
+    combobox: (name: Path<T>, label: string, options: (FieldOption | FieldOptionGroup)[], props?: FieldProps<T>) => BaseField<T>;
+    multiselect: (name: Path<T>, label: string, options: (FieldOption | FieldOptionGroup)[], props?: FieldProps<T>) => BaseField<T>;
+    dependentSelect: (name: Path<T>, label: string, props?: FieldProps<T>) => BaseField<T>;
+    switch: (name: Path<T>, label: string, props?: FieldProps<T>) => BaseField<T>;
+    boolean: (name: Path<T>, label: string, props?: FieldProps<T>) => BaseField<T>;
+    checkbox: (name: Path<T>, label: string, props?: FieldProps<T>) => BaseField<T>;
+    radio: (name: Path<T>, label: string, options: FieldOption[], props?: FieldProps<T>) => BaseField<T>;
+    date: (name: Path<T>, label: string, props?: FieldProps<T>) => BaseField<T>;
+    tags: (name: Path<T>, label: string, props?: FieldProps<T>) => BaseField<T>;
+    slug: (name: Path<T>, label: string, props?: FieldProps<T>) => BaseField<T>;
+    file: (name: Path<T>, label: string, props?: FieldProps<T>) => BaseField<T>;
+    hidden: (name: Path<T>, props?: FieldProps<T>) => BaseField<T>;
+    group: (name: Path<T>, label: string, itemFields: BaseField[], props?: FieldProps<T>) => BaseField<T>;
+    array: (name: Path<T>, label: string, itemFields: BaseField[], props?: FieldProps<T>) => BaseField<T>;
+    custom: (name: Path<T>, label: string, render: (props: FieldComponentProps<T>) => ReactNode, builderProps?: FieldProps<T>) => BaseField<T>;
+  };
 };
 /**
  * Create a section definition with sensible defaults.
  *
- * @param id - Unique section identifier
- * @param title - Section title
- * @param fields - Array of field definitions
- * @param props - Additional section configuration
- *
  * @example
  * ```ts
  * section("personal", "Personal Info", [
  *   field.text("name", "Name", { required: true }),
  *   field.email("email", "Email"),
- * ], { cols: 2, variant: "card" })
+ * ], { cols: 2 })
  * ```
  */
 declare function section<TFieldValues extends FieldValues = FieldValues>(id: string, title: string, fields: BaseField<TFieldValues>[], props?: SectionProps<TFieldValues>): Section<TFieldValues>;
 /**
  * Create a section without a title (transparent section).
  * Useful for grouping fields without visual separation.
+ *
+ * Accepts `BaseField[]` (no generic) so mixed-type field arrays don't trigger
+ * conflicting type inference across different field name generics.
  */
-declare function sectionUntitled<TFieldValues extends FieldValues = FieldValues>(fields: BaseField<TFieldValues>[], props?: Omit<SectionProps<TFieldValues>, "variant">): Section<TFieldValues>;
+declare function sectionUntitled(fields: BaseField[], props?: Omit<SectionProps, "variant">): Section;
 //#endregion
-export { type BaseField, type ClassValue, type Condition, type ConditionConfig, type ConditionRule, type DefaultLayoutProps, type DefineField, type FieldOption, type FieldOptionGroup, type FieldType, type FormSchema, type GridLayoutProps, type InferSchemaValues, type LayoutComponentProps, type LayoutType, type SchemaFieldNames, type Section, type SectionLayoutProps, type SectionRenderProps, type Variant, buildValidationRules, cn, defineField, defineSchema, defineSection, evaluateCondition, extractDefaultValues, extractWatchNames, field, section, sectionUntitled };
+export { type BaseField, type ClassValue, type Condition, type ConditionConfig, type ConditionRule, type DefaultLayoutProps, type DefineField, type FieldMeta, type FieldOption, type FieldOptionGroup, type FieldType, type FormSchema, type GridLayoutProps, type InferSchemaValues, type LayoutComponentProps, type LayoutType, type PatternRuleObject, type SchemaFieldNames, type Section, type SectionLayoutProps, type SectionRenderProps, type ValidationRuleObject, type Variant, buildValidationRules, cn, defineField, defineSchema, defineSection, evaluateCondition, extendSection, extractDefaultValues, extractWatchNames, field, flattenSchema, isArrayField, isChoiceField, isConditionalField, isContainerField, isDateField, isDynamicField, isNumericField, isTextField, mergeSchemas, omitFields, pickFields, section, sectionUntitled };