@zod-utils/react-hook-form 2.0.1 → 2.0.2

package/README.md

@@ -458,6 +458,7 @@ import {
   type DiscriminatorValue,
   type InferredFieldValues,
   type ValidFieldPaths,
+  type ValidFieldPathsOfType,
 } from "@zod-utils/react-hook-form";
 ```
 
@@ -525,6 +526,69 @@ Use this when all fields need to accept `null`, not just objects/arrays.
 
 ---
 
+#### `ValidFieldPathsOfType<TSchema, TValueConstraint, TDiscriminatorKey?, TDiscriminatorValue?, TFieldValues?>`
+
+Extracts field paths where the value type matches a constraint. Useful for building type-safe form components that only accept paths of specific types.
+
+```typescript
+import type { ValidFieldPathsOfType } from "@zod-utils/react-hook-form";
+import { z } from "zod";
+
+const schema = z.object({
+  name: z.string(),
+  age: z.number(),
+  score: z.number().optional(),
+  active: z.boolean(),
+});
+
+// Only accept number field paths
+type NumberPaths = ValidFieldPathsOfType<typeof schema, number>;
+// "age" | "score"
+
+// Only accept boolean field paths
+type BooleanPaths = ValidFieldPathsOfType<typeof schema, boolean>;
+// "active"
+```
+
+**Use case - Type-safe form field components:**
+
+```tsx
+// NumberFormField only accepts paths to number fields
+function NumberFormField<
+  TSchema extends z.ZodType,
+  TPath extends ValidFieldPathsOfType<TSchema, number>
+>({ schema, name }: { schema: TSchema; name: TPath }) {
+  // name is guaranteed to be a path to a number field
+  return <input type="number" name={name} />;
+}
+
+// ✅ Works - 'age' is a number field
+<NumberFormField schema={schema} name="age" />
+
+// ❌ TypeScript error - 'name' is a string field, not number
+<NumberFormField schema={schema} name="name" />
+```
+
+**With discriminated unions:**
+
+```typescript
+const formSchema = z.discriminatedUnion("mode", [
+  z.object({ mode: z.literal("create"), name: z.string(), priority: z.number() }),
+  z.object({ mode: z.literal("edit"), id: z.number(), rating: z.number() }),
+]);
+
+// Number paths for 'edit' variant
+type EditNumberPaths = ValidFieldPathsOfType<
+  typeof formSchema,
+  number,
+  "mode",
+  "edit"
+>;
+// "id" | "rating"
+```
+
+---
+
 ## Complete Example
 
 ```typescript

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { DiscriminatorKey, DiscriminatorValue, Discriminator, ValidPaths, ExtractZodByPath, ZodUnionCheck, Simplify } from '@zod-utils/core';
+import { DiscriminatorKey, DiscriminatorValue, Discriminator, ValidPaths, ExtractZodByPath, ZodUnionCheck, Simplify, ValidPathsOfType } from '@zod-utils/core';
 export * from '@zod-utils/core';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { Context, ReactNode } from 'react';
@@ -328,6 +328,61 @@ type InferredFieldValues<TSchema extends z.ZodType> = z.input<TSchema> & FieldVa
  * ```
  */
 type ValidFieldPaths<TSchema extends z.ZodType, TDiscriminatorKey extends DiscriminatorKey<TSchema>, TDiscriminatorValue extends DiscriminatorValue<TSchema, TDiscriminatorKey>, TFieldValues extends InferredFieldValues<TSchema> = InferredFieldValues<TSchema>> = ValidPaths<TSchema, TDiscriminatorKey, TDiscriminatorValue> & Path<TFieldValues>;
+/**
+ * Type-safe field paths filtered by value type for React Hook Form.
+ *
+ * Combines `ValidPathsOfType` (filters by value type) with React Hook Form's
+ * `Path` type for full compatibility with form field APIs.
+ *
+ * @template TSchema - The Zod schema type
+ * @template TValueConstraint - The value type to filter by
+ * @template TDiscriminatorKey - The discriminator key (for discriminated unions)
+ * @template TDiscriminatorValue - The discriminator value (for discriminated unions)
+ * @template TFieldValues - The form field values type (inferred from schema)
+ *
+ * @example
+ * Get all string field paths for form
+ * ```typescript
+ * const schema = z.object({
+ *   name: z.string(),
+ *   age: z.number(),
+ *   email: z.string().optional(),
+ * });
+ *
+ * type StringFields = ValidFieldPathsOfType<typeof schema, string>;
+ * // "name" | "email" - compatible with react-hook-form Path
+ * ```
+ *
+ * @example
+ * Get all number field paths for form
+ * ```typescript
+ * const schema = z.object({
+ *   id: z.number(),
+ *   name: z.string(),
+ *   count: z.number().optional(),
+ * });
+ *
+ * type NumberFields = ValidFieldPathsOfType<typeof schema, number>;
+ * // "id" | "count"
+ * ```
+ *
+ * @example
+ * With discriminated union
+ * ```typescript
+ * const schema = z.discriminatedUnion('mode', [
+ *   z.object({ mode: z.literal('create'), name: z.string() }),
+ *   z.object({ mode: z.literal('edit'), id: z.number() }),
+ * ]);
+ *
+ * type EditNumberFields = ValidFieldPathsOfType<typeof schema, number, 'mode', 'edit'>;
+ * // "id"
+ * ```
+ *
+ * @see {@link ValidPathsOfType} for the base type without react-hook-form Path intersection
+ * @see {@link ValidFieldPaths} for discriminated union field filtering
+ * @since 0.5.0
+ */
+type ValidFieldPathsOfType<TSchema extends z.ZodType, TValueConstraint, TDiscriminatorKey extends DiscriminatorKey<TSchema> = DiscriminatorKey<TSchema>, TDiscriminatorValue extends DiscriminatorValue<TSchema, TDiscriminatorKey> = DiscriminatorValue<TSchema, TDiscriminatorKey>, TFieldValues extends InferredFieldValues<TSchema> = InferredFieldValues<TSchema>> = ValidPathsOfType<TSchema, TValueConstraint, TDiscriminatorKey, TDiscriminatorValue> & Path<TFieldValues>;
 
 /**
  * Type-safe React Hook Form wrapper with automatic Zod v4 schema validation and type transformation.
@@ -501,4 +556,4 @@ declare const useZodForm: <TInput extends FieldValues, TOutput extends FieldValu
     zodResolverOptions?: Parameters<typeof zodResolver>[1];
 } & Omit<UseFormProps<TFormInput, unknown, TOutput>, "resolver" | "defaultValues">) => react_hook_form.UseFormReturn<TFormInput, unknown, TOutput>;
 
-export { FormSchemaContext, type FormSchemaContextType, type FormSchemaContextValue, FormSchemaProvider, type InferredFieldValues, type PartialWithAllNullables, type PartialWithNullableObjects, type ValidFieldPaths, isRequiredField, useExtractFieldFromSchema, useFieldChecks, useFormSchema, useIsRequiredField, useZodForm };
+export { FormSchemaContext, type FormSchemaContextType, type FormSchemaContextValue, FormSchemaProvider, type InferredFieldValues, type PartialWithAllNullables, type PartialWithNullableObjects, type ValidFieldPaths, type ValidFieldPathsOfType, isRequiredField, useExtractFieldFromSchema, useFieldChecks, useFormSchema, useIsRequiredField, useZodForm };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { DiscriminatorKey, DiscriminatorValue, Discriminator, ValidPaths, ExtractZodByPath, ZodUnionCheck, Simplify } from '@zod-utils/core';
+import { DiscriminatorKey, DiscriminatorValue, Discriminator, ValidPaths, ExtractZodByPath, ZodUnionCheck, Simplify, ValidPathsOfType } from '@zod-utils/core';
 export * from '@zod-utils/core';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { Context, ReactNode } from 'react';
@@ -328,6 +328,61 @@ type InferredFieldValues<TSchema extends z.ZodType> = z.input<TSchema> & FieldVa
  * ```
  */
 type ValidFieldPaths<TSchema extends z.ZodType, TDiscriminatorKey extends DiscriminatorKey<TSchema>, TDiscriminatorValue extends DiscriminatorValue<TSchema, TDiscriminatorKey>, TFieldValues extends InferredFieldValues<TSchema> = InferredFieldValues<TSchema>> = ValidPaths<TSchema, TDiscriminatorKey, TDiscriminatorValue> & Path<TFieldValues>;
+/**
+ * Type-safe field paths filtered by value type for React Hook Form.
+ *
+ * Combines `ValidPathsOfType` (filters by value type) with React Hook Form's
+ * `Path` type for full compatibility with form field APIs.
+ *
+ * @template TSchema - The Zod schema type
+ * @template TValueConstraint - The value type to filter by
+ * @template TDiscriminatorKey - The discriminator key (for discriminated unions)
+ * @template TDiscriminatorValue - The discriminator value (for discriminated unions)
+ * @template TFieldValues - The form field values type (inferred from schema)
+ *
+ * @example
+ * Get all string field paths for form
+ * ```typescript
+ * const schema = z.object({
+ *   name: z.string(),
+ *   age: z.number(),
+ *   email: z.string().optional(),
+ * });
+ *
+ * type StringFields = ValidFieldPathsOfType<typeof schema, string>;
+ * // "name" | "email" - compatible with react-hook-form Path
+ * ```
+ *
+ * @example
+ * Get all number field paths for form
+ * ```typescript
+ * const schema = z.object({
+ *   id: z.number(),
+ *   name: z.string(),
+ *   count: z.number().optional(),
+ * });
+ *
+ * type NumberFields = ValidFieldPathsOfType<typeof schema, number>;
+ * // "id" | "count"
+ * ```
+ *
+ * @example
+ * With discriminated union
+ * ```typescript
+ * const schema = z.discriminatedUnion('mode', [
+ *   z.object({ mode: z.literal('create'), name: z.string() }),
+ *   z.object({ mode: z.literal('edit'), id: z.number() }),
+ * ]);
+ *
+ * type EditNumberFields = ValidFieldPathsOfType<typeof schema, number, 'mode', 'edit'>;
+ * // "id"
+ * ```
+ *
+ * @see {@link ValidPathsOfType} for the base type without react-hook-form Path intersection
+ * @see {@link ValidFieldPaths} for discriminated union field filtering
+ * @since 0.5.0
+ */
+type ValidFieldPathsOfType<TSchema extends z.ZodType, TValueConstraint, TDiscriminatorKey extends DiscriminatorKey<TSchema> = DiscriminatorKey<TSchema>, TDiscriminatorValue extends DiscriminatorValue<TSchema, TDiscriminatorKey> = DiscriminatorValue<TSchema, TDiscriminatorKey>, TFieldValues extends InferredFieldValues<TSchema> = InferredFieldValues<TSchema>> = ValidPathsOfType<TSchema, TValueConstraint, TDiscriminatorKey, TDiscriminatorValue> & Path<TFieldValues>;
 
 /**
  * Type-safe React Hook Form wrapper with automatic Zod v4 schema validation and type transformation.
@@ -501,4 +556,4 @@ declare const useZodForm: <TInput extends FieldValues, TOutput extends FieldValu
     zodResolverOptions?: Parameters<typeof zodResolver>[1];
 } & Omit<UseFormProps<TFormInput, unknown, TOutput>, "resolver" | "defaultValues">) => react_hook_form.UseFormReturn<TFormInput, unknown, TOutput>;
 
-export { FormSchemaContext, type FormSchemaContextType, type FormSchemaContextValue, FormSchemaProvider, type InferredFieldValues, type PartialWithAllNullables, type PartialWithNullableObjects, type ValidFieldPaths, isRequiredField, useExtractFieldFromSchema, useFieldChecks, useFormSchema, useIsRequiredField, useZodForm };
+export { FormSchemaContext, type FormSchemaContextType, type FormSchemaContextValue, FormSchemaProvider, type InferredFieldValues, type PartialWithAllNullables, type PartialWithNullableObjects, type ValidFieldPaths, type ValidFieldPathsOfType, isRequiredField, useExtractFieldFromSchema, useFieldChecks, useFormSchema, useIsRequiredField, useZodForm };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zod-utils/react-hook-form",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "description": "React Hook Form integration and utilities for Zod schemas",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",