@zod-utils/core 2.0.0 → 2.0.2

package/README.md

@@ -519,6 +519,124 @@ type Simple = Simplify<Complex>;
 
 ---
 
+### `DiscriminatedInput<TSchema, TDiscriminatorKey, TDiscriminatorValue>`
+
+Extracts the input type from a discriminated union variant. For discriminated unions, narrows to the variant matching the discriminator value and returns its input type. For regular schemas, returns the full input type.
+
+```typescript
+import type { DiscriminatedInput } from "@zod-utils/core";
+import { z } from "zod";
+
+const schema = z.discriminatedUnion("mode", [
+  z.object({ mode: z.literal("create"), name: z.string() }),
+  z.object({ mode: z.literal("edit"), id: z.number() }),
+]);
+
+type CreateInput = DiscriminatedInput<typeof schema, "mode", "create">;
+// { mode: 'create'; name: string }
+
+type EditInput = DiscriminatedInput<typeof schema, "mode", "edit">;
+// { mode: 'edit'; id: number }
+```
+
+---
+
+### `ValidPaths<TSchema, TDiscriminatorKey, TDiscriminatorValue>`
+
+Generates all valid dot-notation paths for a schema. For discriminated unions, narrows to the specific variant first.
+
+```typescript
+import type { ValidPaths } from "@zod-utils/core";
+import { z } from "zod";
+
+const schema = z.discriminatedUnion("mode", [
+  z.object({ mode: z.literal("create"), name: z.string() }),
+  z.object({ mode: z.literal("edit"), id: z.number() }),
+]);
+
+type CreatePaths = ValidPaths<typeof schema, "mode", "create">;
+// "mode" | "name"
+
+type EditPaths = ValidPaths<typeof schema, "mode", "edit">;
+// "mode" | "id"
+```
+
+---
+
+### `ValidPathsOfType<TSchema, TValueConstraint, TDiscriminatorKey?, TDiscriminatorValue?>`
+
+Extracts field paths from a schema where the field value type matches a constraint. Filters schema keys to only those whose input type (with nullish stripped) extends the given `TValueConstraint`.
+
+```typescript
+import type { ValidPathsOfType } from "@zod-utils/core";
+import { z } from "zod";
+
+const schema = z.object({
+  name: z.string(),
+  age: z.number(),
+  email: z.string().optional(),
+  count: z.number().nullable(),
+  active: z.boolean(),
+});
+
+// Get all string field paths
+type StringPaths = ValidPathsOfType<typeof schema, string>;
+// "name" | "email"
+
+// Get all number field paths
+type NumberPaths = ValidPathsOfType<typeof schema, number>;
+// "age" | "count"
+
+// Get all boolean field paths
+type BooleanPaths = ValidPathsOfType<typeof schema, boolean>;
+// "active"
+```
+
+**With discriminated unions:**
+
+```typescript
+const formSchema = z.discriminatedUnion("mode", [
+  z.object({ mode: z.literal("create"), name: z.string(), age: z.number() }),
+  z.object({ mode: z.literal("edit"), id: z.number(), title: z.string() }),
+]);
+
+// Get number paths for 'edit' variant only
+type EditNumberPaths = ValidPathsOfType<
+  typeof formSchema,
+  number,
+  "mode",
+  "edit"
+>;
+// "id"
+
+// Get string paths for 'create' variant
+type CreateStringPaths = ValidPathsOfType<
+  typeof formSchema,
+  string,
+  "mode",
+  "create"
+>;
+// "name"
+```
+
+**Array and object filtering:**
+
+```typescript
+const schema = z.object({
+  tags: z.array(z.string()),
+  scores: z.array(z.number()),
+  profile: z.object({ bio: z.string() }),
+});
+
+type StringArrayPaths = ValidPathsOfType<typeof schema, string[]>;
+// "tags"
+
+type ProfilePaths = ValidPathsOfType<typeof schema, { bio: string }>;
+// "profile"
+```
+
+---
+
 ## License
 
 MIT

package/dist/index.d.mts

@@ -113,6 +113,33 @@ type Paths<T> = PathsHint<T> | PathsLoose<T>;
  * ```
  */
 type CommonFields<T> = Pick<T, keyof T>;
+/**
+ * Extracts the input type from a discriminated union variant.
+ *
+ * For discriminated unions, narrows to the variant matching the discriminator value
+ * and returns its input type. For regular schemas, returns the full input type.
+ *
+ * @template TSchema - The Zod schema type
+ * @template TDiscriminatorKey - The discriminator key
+ * @template TDiscriminatorValue - The discriminator value to match
+ *
+ * @example
+ * ```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 CreateInput = DiscriminatedInput<typeof schema, 'mode', 'create'>;
+ * // { mode: 'create'; name: string }
+ *
+ * type EditInput = DiscriminatedInput<typeof schema, 'mode', 'edit'>;
+ * // { mode: 'edit'; id: number }
+ * ```
+ *
+ * @since 0.5.0
+ */
+type DiscriminatedInput<TSchema extends z$1.ZodType, TDiscriminatorKey extends DiscriminatorKey<TSchema>, TDiscriminatorValue extends DiscriminatorValue<TSchema, TDiscriminatorKey>> = CommonFields<Extract<Required<z$1.input<TSchema>>, TDiscriminatorKey extends never ? z$1.input<TSchema> : TDiscriminatorValue extends never ? z$1.input<TSchema> : Simplify<Record<TDiscriminatorKey, TDiscriminatorValue>>>>;
 /**
  * Generates valid dot-notation paths for fields in a discriminated union variant.
  *
@@ -133,7 +160,50 @@ type CommonFields<T> = Pick<T, keyof T>;
  * // "mode" | "id"
  * ```
  */
-type ValidPaths<TSchema extends z$1.ZodType, TDiscriminatorKey extends DiscriminatorKey<TSchema>, TDiscriminatorValue extends DiscriminatorValue<TSchema, TDiscriminatorKey>> = Paths<CommonFields<Extract<Required<z$1.input<TSchema>>, TDiscriminatorKey extends never ? z$1.input<TSchema> : TDiscriminatorValue extends never ? z$1.input<TSchema> : Simplify<Record<TDiscriminatorKey, TDiscriminatorValue>>>>>;
+type ValidPaths<TSchema extends z$1.ZodType, TDiscriminatorKey extends DiscriminatorKey<TSchema>, TDiscriminatorValue extends DiscriminatorValue<TSchema, TDiscriminatorKey>> = Paths<DiscriminatedInput<TSchema, TDiscriminatorKey, TDiscriminatorValue>>;
+/**
+ * Extracts field paths from a schema where the field value type matches a constraint.
+ *
+ * Filters schema keys to only those whose input type (with nullish stripped via `NonNullable`)
+ * extends the given `TValueConstraint`. For discriminated unions, first narrows to the
+ * specific variant before filtering.
+ *
+ * @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)
+ *
+ * @example
+ * Get all string field paths
+ * ```typescript
+ * const schema = z.object({
+ *   name: z.string(),
+ *   age: z.number(),
+ *   email: z.string().optional(),
+ * });
+ *
+ * type StringPaths = ValidPathsOfType<typeof schema, string>;
+ * // "name" | "email"
+ * ```
+ *
+ * @example
+ * With discriminated union - filter by type within a variant
+ * ```typescript
+ * const schema = z.discriminatedUnion('mode', [
+ *   z.object({ mode: z.literal('create'), name: z.string(), age: z.number() }),
+ *   z.object({ mode: z.literal('edit'), id: z.number(), name: z.string() }),
+ * ]);
+ *
+ * type EditNumberPaths = ValidPathsOfType<typeof schema, number, 'mode', 'edit'>;
+ * // "id" - only number fields in 'edit' variant
+ * ```
+ *
+ * @see {@link ValidPaths} for discriminated union path filtering
+ * @since 0.5.0
+ */
+type ValidPathsOfType<TSchema extends z$1.ZodType, TValueConstraint, TDiscriminatorKey extends DiscriminatorKey<TSchema> = DiscriminatorKey<TSchema>, TDiscriminatorValue extends DiscriminatorValue<TSchema, TDiscriminatorKey> = DiscriminatorValue<TSchema, TDiscriminatorKey>, TVariant = DiscriminatedInput<TSchema, TDiscriminatorKey, TDiscriminatorValue>> = NonNullable<Extract<{
+    [K in keyof TVariant]: NonNullable<TVariant[K]> extends TValueConstraint ? K : never;
+}[keyof TVariant], string> & ValidPaths<TSchema, TDiscriminatorKey, TDiscriminatorValue>>;
 
 /**
  * Extracts the default value from a Zod field, recursively unwrapping optional, nullable, and union layers.
@@ -798,4 +868,4 @@ type ZodUnionCheck = $ZodCheckLessThanDef | $ZodCheckGreaterThanDef | $ZodCheckM
  */
 declare function getFieldChecks<T extends z$1.ZodTypeAny>(field: T): Array<ZodUnionCheck>;
 
-export { type CommonFields, type Discriminator, type DiscriminatorKey, type DiscriminatorValue, type ExtractZodByPath, type Paths, type Simplify, type ValidPaths, type ZodUnionCheck, canUnwrap, extendWithMeta, extractDefaultValue, extractDiscriminatedSchema, extractFieldFromSchema, getFieldChecks, getPrimitiveType, getSchemaDefaults, removeDefault, requiresValidInput, tryStripNullishOnly };
+export { type CommonFields, type DiscriminatedInput, type Discriminator, type DiscriminatorKey, type DiscriminatorValue, type ExtractZodByPath, type Paths, type Simplify, type ValidPaths, type ValidPathsOfType, type ZodUnionCheck, canUnwrap, extendWithMeta, extractDefaultValue, extractDiscriminatedSchema, extractFieldFromSchema, getFieldChecks, getPrimitiveType, getSchemaDefaults, removeDefault, requiresValidInput, tryStripNullishOnly };

package/dist/index.d.ts

@@ -113,6 +113,33 @@ type Paths<T> = PathsHint<T> | PathsLoose<T>;
  * ```
  */
 type CommonFields<T> = Pick<T, keyof T>;
+/**
+ * Extracts the input type from a discriminated union variant.
+ *
+ * For discriminated unions, narrows to the variant matching the discriminator value
+ * and returns its input type. For regular schemas, returns the full input type.
+ *
+ * @template TSchema - The Zod schema type
+ * @template TDiscriminatorKey - The discriminator key
+ * @template TDiscriminatorValue - The discriminator value to match
+ *
+ * @example
+ * ```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 CreateInput = DiscriminatedInput<typeof schema, 'mode', 'create'>;
+ * // { mode: 'create'; name: string }
+ *
+ * type EditInput = DiscriminatedInput<typeof schema, 'mode', 'edit'>;
+ * // { mode: 'edit'; id: number }
+ * ```
+ *
+ * @since 0.5.0
+ */
+type DiscriminatedInput<TSchema extends z$1.ZodType, TDiscriminatorKey extends DiscriminatorKey<TSchema>, TDiscriminatorValue extends DiscriminatorValue<TSchema, TDiscriminatorKey>> = CommonFields<Extract<Required<z$1.input<TSchema>>, TDiscriminatorKey extends never ? z$1.input<TSchema> : TDiscriminatorValue extends never ? z$1.input<TSchema> : Simplify<Record<TDiscriminatorKey, TDiscriminatorValue>>>>;
 /**
  * Generates valid dot-notation paths for fields in a discriminated union variant.
  *
@@ -133,7 +160,50 @@ type CommonFields<T> = Pick<T, keyof T>;
  * // "mode" | "id"
  * ```
  */
-type ValidPaths<TSchema extends z$1.ZodType, TDiscriminatorKey extends DiscriminatorKey<TSchema>, TDiscriminatorValue extends DiscriminatorValue<TSchema, TDiscriminatorKey>> = Paths<CommonFields<Extract<Required<z$1.input<TSchema>>, TDiscriminatorKey extends never ? z$1.input<TSchema> : TDiscriminatorValue extends never ? z$1.input<TSchema> : Simplify<Record<TDiscriminatorKey, TDiscriminatorValue>>>>>;
+type ValidPaths<TSchema extends z$1.ZodType, TDiscriminatorKey extends DiscriminatorKey<TSchema>, TDiscriminatorValue extends DiscriminatorValue<TSchema, TDiscriminatorKey>> = Paths<DiscriminatedInput<TSchema, TDiscriminatorKey, TDiscriminatorValue>>;
+/**
+ * Extracts field paths from a schema where the field value type matches a constraint.
+ *
+ * Filters schema keys to only those whose input type (with nullish stripped via `NonNullable`)
+ * extends the given `TValueConstraint`. For discriminated unions, first narrows to the
+ * specific variant before filtering.
+ *
+ * @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)
+ *
+ * @example
+ * Get all string field paths
+ * ```typescript
+ * const schema = z.object({
+ *   name: z.string(),
+ *   age: z.number(),
+ *   email: z.string().optional(),
+ * });
+ *
+ * type StringPaths = ValidPathsOfType<typeof schema, string>;
+ * // "name" | "email"
+ * ```
+ *
+ * @example
+ * With discriminated union - filter by type within a variant
+ * ```typescript
+ * const schema = z.discriminatedUnion('mode', [
+ *   z.object({ mode: z.literal('create'), name: z.string(), age: z.number() }),
+ *   z.object({ mode: z.literal('edit'), id: z.number(), name: z.string() }),
+ * ]);
+ *
+ * type EditNumberPaths = ValidPathsOfType<typeof schema, number, 'mode', 'edit'>;
+ * // "id" - only number fields in 'edit' variant
+ * ```
+ *
+ * @see {@link ValidPaths} for discriminated union path filtering
+ * @since 0.5.0
+ */
+type ValidPathsOfType<TSchema extends z$1.ZodType, TValueConstraint, TDiscriminatorKey extends DiscriminatorKey<TSchema> = DiscriminatorKey<TSchema>, TDiscriminatorValue extends DiscriminatorValue<TSchema, TDiscriminatorKey> = DiscriminatorValue<TSchema, TDiscriminatorKey>, TVariant = DiscriminatedInput<TSchema, TDiscriminatorKey, TDiscriminatorValue>> = NonNullable<Extract<{
+    [K in keyof TVariant]: NonNullable<TVariant[K]> extends TValueConstraint ? K : never;
+}[keyof TVariant], string> & ValidPaths<TSchema, TDiscriminatorKey, TDiscriminatorValue>>;
 
 /**
  * Extracts the default value from a Zod field, recursively unwrapping optional, nullable, and union layers.
@@ -798,4 +868,4 @@ type ZodUnionCheck = $ZodCheckLessThanDef | $ZodCheckGreaterThanDef | $ZodCheckM
  */
 declare function getFieldChecks<T extends z$1.ZodTypeAny>(field: T): Array<ZodUnionCheck>;
 
-export { type CommonFields, type Discriminator, type DiscriminatorKey, type DiscriminatorValue, type ExtractZodByPath, type Paths, type Simplify, type ValidPaths, type ZodUnionCheck, canUnwrap, extendWithMeta, extractDefaultValue, extractDiscriminatedSchema, extractFieldFromSchema, getFieldChecks, getPrimitiveType, getSchemaDefaults, removeDefault, requiresValidInput, tryStripNullishOnly };
+export { type CommonFields, type DiscriminatedInput, type Discriminator, type DiscriminatorKey, type DiscriminatorValue, type ExtractZodByPath, type Paths, type Simplify, type ValidPaths, type ValidPathsOfType, type ZodUnionCheck, canUnwrap, extendWithMeta, extractDefaultValue, extractDiscriminatedSchema, extractFieldFromSchema, getFieldChecks, getPrimitiveType, getSchemaDefaults, removeDefault, requiresValidInput, tryStripNullishOnly };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zod-utils/core",
-  "version": "2.0.0",
+  "version": "2.0.2",
   "description": "Pure TypeScript utilities for Zod schema manipulation and default extraction",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",