zod 4.0.0-beta.20250505T195954 → 4.0.0

package/src/v4/core/config.ts

@@ -0,0 +1,15 @@
+import type * as errors from "./errors.js";
+
+export interface $ZodConfig {
+  /** Custom error map. Overrides `config().localeError`. */
+  customError?: errors.$ZodErrorMap | undefined;
+  /** Localized error map. Lowest priority. */
+  localeError?: errors.$ZodErrorMap | undefined;
+}
+
+export const globalConfig: $ZodConfig = {};
+
+export function config(config?: Partial<$ZodConfig>): $ZodConfig {
+  if (config) Object.assign(globalConfig, config);
+  return globalConfig;
+}

package/src/v4/core/core.ts

@@ -0,0 +1,134 @@
+import type * as errors from "./errors.js";
+import type * as schemas from "./schemas.js";
+import type { Class } from "./util.js";
+//////////////////////////////   CONSTRUCTORS   ///////////////////////////////////////
+
+type ZodTrait = { _zod: { def: any; [k: string]: any } };
+export interface $constructor<T extends ZodTrait, D = T["_zod"]["def"]> {
+  new (def: D): T;
+  init(inst: T, def: D): asserts inst is T;
+}
+
+/** A special constant with type `never` */
+export const NEVER: never = Object.freeze({
+  status: "aborted",
+}) as never;
+
+export /*@__NO_SIDE_EFFECTS__*/ function $constructor<T extends ZodTrait, D = T["_zod"]["def"]>(
+  name: string,
+  initializer: (inst: T, def: D) => void,
+  params?: { Parent?: typeof Class }
+): $constructor<T, D> {
+  function init(inst: T, def: D) {
+    Object.defineProperty(inst, "_zod", {
+      value: inst._zod ?? {},
+      enumerable: false,
+    });
+
+    inst._zod.traits ??= new Set();
+
+    inst._zod.traits.add(name);
+    initializer(inst, def);
+    // support prototype modifications
+    for (const k in _.prototype) {
+      if (!(k in inst)) Object.defineProperty(inst, k, { value: _.prototype[k].bind(inst) });
+    }
+    inst._zod.constr = _;
+    inst._zod.def = def;
+  }
+
+  // doesn't work if Parent has a constructor with arguments
+  const Parent = params?.Parent ?? Object;
+  class Definition extends Parent {}
+  Object.defineProperty(Definition, "name", { value: name });
+
+  function _(this: any, def: D) {
+    const inst = params?.Parent ? new Definition() : this;
+    init(inst, def);
+    inst._zod.deferred ??= [];
+    for (const fn of inst._zod.deferred) {
+      fn();
+    }
+    return inst;
+  }
+
+  Object.defineProperty(_, "init", { value: init });
+  Object.defineProperty(_, Symbol.hasInstance, {
+    value: (inst: any) => {
+      if (params?.Parent && inst instanceof params.Parent) return true;
+      return inst?._zod?.traits?.has(name);
+    },
+  });
+  Object.defineProperty(_, "name", { value: name });
+  return _ as any;
+}
+
+//////////////////////////////   UTILITIES   ///////////////////////////////////////
+export const $brand: unique symbol = Symbol("zod_brand");
+export type $brand<T extends string | number | symbol = string | number | symbol> = {
+  [$brand]: { [k in T]: true };
+};
+
+export type $ZodBranded<T extends schemas.SomeType, Brand extends string | number | symbol> = T &
+  Record<"_zod", Record<"output", output<T> & $brand<Brand>>>;
+
+export class $ZodAsyncError extends Error {
+  constructor() {
+    super(`Encountered Promise during synchronous parse. Use .parseAsync() instead.`);
+  }
+}
+
+////////////////////////////  TYPE HELPERS  ///////////////////////////////////
+
+// export type input<T extends schemas.$ZodType> = T["_zod"]["input"];
+// export type output<T extends schemas.$ZodType> = T["_zod"]["output"];
+// export type input<T extends schemas.$ZodType> = T["_zod"]["input"];
+// export type output<T extends schemas.$ZodType> = T["_zod"]["output"];
+export type input<T> = T extends { _zod: { input: any } } ? Required<T["_zod"]>["input"] : unknown;
+export type output<T> = T extends { _zod: { output: any } } ? Required<T["_zod"]>["output"] : unknown;
+
+// Mk2
+// export type input<T> = T extends { _zod: { "~input": any } }
+//   ? T["_zod"]["~input"]
+//   : T extends { _zod: { input: any } }
+//     ? T["_zod"]["input"]
+//     : never;
+// export type output<T> = T extends { _zod: { "~output": any } }
+//   ? T["_zod"]["~output"]
+//   : T extends { _zod: { output: any } }
+//     ? T["_zod"]["output"]
+//     : never;
+// Mk 3
+// export type input<T extends schemas.$ZodType> = T["_zod"]["input"];
+// export type output<T extends schemas.$ZodType> = T["_zod"]["output"];
+// Mk 4
+// export type input<T extends schemas.$ZodType> = T[] extends { _zod: { "~input": any } }
+//   ? T["_zod"]["~input"]
+//   : T extends { _zod: { input: any } }
+//     ? T["_zod"]["input"]
+//     : never;
+// export type output<T extends schemas.$ZodType> = T extends { _zod: { "~output": any } }
+//   ? T["_zod"]["~output"]
+//   : T extends { _zod: { output: any } }
+//     ? T["_zod"]["output"]
+//     : never;
+
+export type { output as infer };
+
+//////////////////////////////   CONFIG   ///////////////////////////////////////
+
+export interface $ZodConfig {
+  /** Custom error map. Overrides `config().localeError`. */
+  customError?: errors.$ZodErrorMap | undefined;
+  /** Localized error map. Lowest priority. */
+  localeError?: errors.$ZodErrorMap | undefined;
+  /** Disable JIT schema compilation. Useful in environments that disallow `eval`. */
+  jitless?: boolean | undefined;
+}
+
+export const globalConfig: $ZodConfig = {};
+
+export function config(newConfig?: Partial<$ZodConfig>): $ZodConfig {
+  if (newConfig) Object.assign(globalConfig, newConfig);
+  return globalConfig;
+}

package/src/v4/core/doc.ts

@@ -0,0 +1,44 @@
+type ModeWriter = (doc: Doc, modes: { execution: "sync" | "async" }) => void;
+
+export class Doc {
+  args!: string[];
+  content: string[] = [];
+  indent = 0;
+
+  constructor(args: string[] = []) {
+    if (this) this.args = args;
+  }
+
+  indented(fn: (doc: Doc) => void) {
+    this.indent += 1;
+    fn(this);
+    this.indent -= 1;
+  }
+
+  write(fn: ModeWriter): void;
+  write(line: string): void;
+  write(arg: any) {
+    if (typeof arg === "function") {
+      (arg as ModeWriter)(this, { execution: "sync" });
+      (arg as ModeWriter)(this, { execution: "async" });
+      return;
+    }
+
+    const content = arg as string;
+    const lines = content.split("\n").filter((x) => x);
+    const minIndent = Math.min(...lines.map((x) => x.length - x.trimStart().length));
+    const dedented = lines.map((x) => x.slice(minIndent)).map((x) => " ".repeat(this.indent * 2) + x);
+    for (const line of dedented) {
+      this.content.push(line);
+    }
+  }
+
+  compile(): any {
+    const F = Function;
+    const args = this?.args;
+    const content = this?.content ?? [``];
+    const lines = [...content.map((x) => `  ${x}`)];
+    // console.log(lines.join("\n"));
+    return new F(...args, lines.join("\n")) as any;
+  }
+}

package/src/v4/core/errors.ts

@@ -0,0 +1,426 @@
+import type { $ZodCheck, $ZodStringFormats } from "./checks.js";
+import { $constructor } from "./core.js";
+import type { $ZodType } from "./schemas.js";
+import * as util from "./util.js";
+
+///////////////////////////
+////     base type     ////
+///////////////////////////
+export interface $ZodIssueBase {
+  readonly code?: string;
+  readonly input?: unknown;
+  readonly path: PropertyKey[];
+  readonly message: string;
+  // [k: string]: unknown;
+}
+
+////////////////////////////////
+////     issue subtypes     ////
+////////////////////////////////
+export interface $ZodIssueInvalidType<Input = unknown> extends $ZodIssueBase {
+  readonly code: "invalid_type";
+  readonly expected: $ZodType["_zod"]["def"]["type"];
+  readonly input: Input;
+}
+
+export interface $ZodIssueTooBig<Input = unknown> extends $ZodIssueBase {
+  readonly code: "too_big";
+  readonly origin: "number" | "int" | "bigint" | "date" | "string" | "array" | "set" | "file" | (string & {});
+  readonly maximum: number | bigint;
+  readonly inclusive?: boolean;
+  readonly exact?: boolean;
+  readonly input: Input;
+}
+
+export interface $ZodIssueTooSmall<Input = unknown> extends $ZodIssueBase {
+  readonly code: "too_small";
+  readonly origin: "number" | "int" | "bigint" | "date" | "string" | "array" | "set" | "file" | (string & {});
+  readonly minimum: number | bigint;
+  /** True if the allowable range includes the minimum */
+  readonly inclusive?: boolean;
+  /** True if the allowed value is fixed (e.g.` z.length(5)`), not a range (`z.minLength(5)`) */
+  readonly exact?: boolean;
+  readonly input: Input;
+}
+
+export interface $ZodIssueInvalidStringFormat extends $ZodIssueBase {
+  readonly code: "invalid_format";
+  readonly format: $ZodStringFormats | (string & {});
+  readonly pattern?: string;
+  readonly input: string;
+}
+
+export interface $ZodIssueNotMultipleOf<Input extends number | bigint = number | bigint> extends $ZodIssueBase {
+  readonly code: "not_multiple_of";
+  readonly divisor: number;
+  readonly input: Input;
+}
+
+export interface $ZodIssueUnrecognizedKeys extends $ZodIssueBase {
+  readonly code: "unrecognized_keys";
+  readonly keys: string[];
+  readonly input: Record<string, unknown>;
+}
+
+export interface $ZodIssueInvalidUnion extends $ZodIssueBase {
+  readonly code: "invalid_union";
+  readonly errors: $ZodIssue[][];
+  readonly input: unknown;
+}
+
+export interface $ZodIssueInvalidKey<Input = unknown> extends $ZodIssueBase {
+  readonly code: "invalid_key";
+  readonly origin: "map" | "record";
+  readonly issues: $ZodIssue[];
+  readonly input: Input;
+}
+
+export interface $ZodIssueInvalidElement<Input = unknown> extends $ZodIssueBase {
+  readonly code: "invalid_element";
+  readonly origin: "map" | "set";
+  readonly key: unknown;
+  readonly issues: $ZodIssue[];
+  readonly input: Input;
+}
+
+export interface $ZodIssueInvalidValue<Input = unknown> extends $ZodIssueBase {
+  readonly code: "invalid_value";
+  readonly values: util.Primitive[];
+  readonly input: Input;
+}
+
+export interface $ZodIssueCustom extends $ZodIssueBase {
+  readonly code: "custom";
+  readonly params?: Record<string, any> | undefined;
+  readonly input: unknown;
+}
+
+////////////////////////////////////////////
+////     first-party string formats     ////
+////////////////////////////////////////////
+
+export interface $ZodIssueStringCommonFormats extends $ZodIssueInvalidStringFormat {
+  format: Exclude<$ZodStringFormats, "regex" | "jwt" | "starts_with" | "ends_with" | "includes">;
+}
+
+export interface $ZodIssueStringInvalidRegex extends $ZodIssueInvalidStringFormat {
+  format: "regex";
+  pattern: string;
+}
+
+export interface $ZodIssueStringInvalidJWT extends $ZodIssueInvalidStringFormat {
+  format: "jwt";
+  algorithm?: string;
+}
+
+export interface $ZodIssueStringStartsWith extends $ZodIssueInvalidStringFormat {
+  format: "starts_with";
+  prefix: string;
+}
+
+export interface $ZodIssueStringEndsWith extends $ZodIssueInvalidStringFormat {
+  format: "ends_with";
+  suffix: string;
+}
+
+export interface $ZodIssueStringIncludes extends $ZodIssueInvalidStringFormat {
+  format: "includes";
+  includes: string;
+}
+
+export type $ZodStringFormatIssues =
+  | $ZodIssueStringCommonFormats
+  | $ZodIssueStringInvalidRegex
+  | $ZodIssueStringInvalidJWT
+  | $ZodIssueStringStartsWith
+  | $ZodIssueStringEndsWith
+  | $ZodIssueStringIncludes;
+
+////////////////////////
+////     utils     /////
+////////////////////////
+
+export type $ZodIssue =
+  | $ZodIssueInvalidType
+  | $ZodIssueTooBig
+  | $ZodIssueTooSmall
+  | $ZodIssueInvalidStringFormat
+  | $ZodIssueNotMultipleOf
+  | $ZodIssueUnrecognizedKeys
+  | $ZodIssueInvalidUnion
+  | $ZodIssueInvalidKey
+  | $ZodIssueInvalidElement
+  | $ZodIssueInvalidValue
+  | $ZodIssueCustom;
+
+export type $ZodIssueCode = $ZodIssue["code"];
+
+export type $ZodRawIssue<T extends $ZodIssueBase = $ZodIssue> = T extends any ? RawIssue<T> : never;
+type RawIssue<T extends $ZodIssueBase> = util.Flatten<
+  util.MakePartial<T, "message" | "path"> & {
+    /** The input data */
+    readonly input?: unknown;
+    /** The schema or check that originated this issue. */
+    readonly inst?: $ZodType | $ZodCheck;
+    /** @deprecated Internal use only. If `true`, Zod will continue executing validation despite this issue. */
+    readonly continue?: boolean | undefined;
+  } & Record<string, any>
+>;
+
+export interface $ZodErrorMap<T extends $ZodIssueBase = $ZodIssue> {
+  // biome-ignore lint:
+  (issue: $ZodRawIssue<T>): { message: string } | string | undefined | null;
+}
+
+////////////////////////    ERROR CLASS   ////////////////////////
+
+// const ZOD_ERROR: symbol = Symbol.for("{{zod.error}}");
+export interface $ZodError<T = unknown> extends Error {
+  type: T;
+  issues: $ZodIssue[];
+  _zod: {
+    output: T;
+    def: $ZodIssue[];
+  };
+  stack?: string;
+  name: string;
+}
+
+const initializer = (inst: $ZodError, def: $ZodIssue[]): void => {
+  inst.name = "$ZodError";
+  Object.defineProperty(inst, "_zod", {
+    value: inst._zod,
+    enumerable: false,
+  });
+  Object.defineProperty(inst, "issues", {
+    value: def,
+    enumerable: false,
+  });
+  Object.defineProperty(inst, "message", {
+    get() {
+      return JSON.stringify(def, util.jsonStringifyReplacer, 2);
+    },
+    enumerable: true,
+    // configurable: false,
+  });
+  Object.defineProperty(inst, "toString", {
+    value: () => inst.message,
+    enumerable: false,
+  });
+};
+
+export const $ZodError: $constructor<$ZodError> = $constructor("$ZodError", initializer);
+interface $ZodRealError<T = any> extends $ZodError<T> {}
+export const $ZodRealError: $constructor<$ZodRealError> = $constructor("$ZodError", initializer, { Parent: Error });
+
+///////////////////    ERROR UTILITIES   ////////////////////////
+
+// flatten
+export type $ZodFlattenedError<T, U = string> = _FlattenedError<T, U>;
+type _FlattenedError<T, U = string> = {
+  formErrors: U[];
+  fieldErrors: {
+    [P in keyof T]?: U[];
+  };
+};
+
+export function flattenError<T>(error: $ZodError<T>): _FlattenedError<T>;
+export function flattenError<T, U>(error: $ZodError<T>, mapper?: (issue: $ZodIssue) => U): _FlattenedError<T, U>;
+export function flattenError(error: $ZodError, mapper = (issue: $ZodIssue) => issue.message): any {
+  const fieldErrors: any = {};
+  const formErrors: any[] = [];
+  for (const sub of error.issues) {
+    if (sub.path.length > 0) {
+      fieldErrors[sub.path[0]!] = fieldErrors[sub.path[0]!] || [];
+      fieldErrors[sub.path[0]!].push(mapper(sub));
+    } else {
+      formErrors.push(mapper(sub));
+    }
+  }
+  return { formErrors, fieldErrors };
+}
+
+type _ZodFormattedError<T, U = string> = T extends [any, ...any[]]
+  ? { [K in keyof T]?: $ZodFormattedError<T[K], U> }
+  : T extends any[]
+    ? { [k: number]: $ZodFormattedError<T[number], U> }
+    : T extends object
+      ? util.Flatten<{ [K in keyof T]?: $ZodFormattedError<T[K], U> }>
+      : any;
+
+export type $ZodFormattedError<T, U = string> = {
+  _errors: U[];
+} & util.Flatten<_ZodFormattedError<T, U>>;
+
+export function formatError<T>(error: $ZodError<T>): $ZodFormattedError<T>;
+export function formatError<T, U>(error: $ZodError<T>, mapper?: (issue: $ZodIssue) => U): $ZodFormattedError<T, U>;
+export function formatError<T>(error: $ZodError, _mapper?: any) {
+  const mapper: (issue: $ZodIssue) => any =
+    _mapper ||
+    function (issue: $ZodIssue) {
+      return issue.message;
+    };
+  const fieldErrors: $ZodFormattedError<T> = { _errors: [] } as any;
+  const processError = (error: { issues: $ZodIssue[] }) => {
+    for (const issue of error.issues) {
+      if (issue.code === "invalid_union" && issue.errors.length) {
+        issue.errors.map((issues) => processError({ issues }));
+      } else if (issue.code === "invalid_key") {
+        processError({ issues: issue.issues });
+      } else if (issue.code === "invalid_element") {
+        processError({ issues: issue.issues });
+      } else if (issue.path.length === 0) {
+        (fieldErrors as any)._errors.push(mapper(issue));
+      } else {
+        let curr: any = fieldErrors;
+        let i = 0;
+        while (i < issue.path.length) {
+          const el = issue.path[i]!;
+          const terminal = i === issue.path.length - 1;
+
+          if (!terminal) {
+            curr[el] = curr[el] || { _errors: [] };
+          } else {
+            curr[el] = curr[el] || { _errors: [] };
+            curr[el]._errors.push(mapper(issue));
+          }
+
+          curr = curr[el];
+          i++;
+        }
+      }
+    }
+  };
+  processError(error);
+  return fieldErrors;
+}
+
+export type $ZodErrorTree<T, U = string> = T extends util.Primitive
+  ? { errors: U[] }
+  : T extends [any, ...any[]]
+    ? { errors: U[]; items?: { [K in keyof T]?: $ZodErrorTree<T[K], U> } }
+    : T extends any[]
+      ? { errors: U[]; items?: Array<$ZodErrorTree<T[number], U>> }
+      : T extends object
+        ? { errors: U[]; properties?: { [K in keyof T]?: $ZodErrorTree<T[K], U> } }
+        : { errors: U[] };
+
+export function treeifyError<T>(error: $ZodError<T>): $ZodErrorTree<T>;
+export function treeifyError<T, U>(error: $ZodError<T>, mapper?: (issue: $ZodIssue) => U): $ZodErrorTree<T, U>;
+export function treeifyError<T>(error: $ZodError, _mapper?: any) {
+  const mapper: (issue: $ZodIssue) => any =
+    _mapper ||
+    function (issue: $ZodIssue) {
+      return issue.message;
+    };
+  const result: $ZodErrorTree<T> = { errors: [] } as any;
+  const processError = (error: { issues: $ZodIssue[] }, path: PropertyKey[] = []) => {
+    for (const issue of error.issues) {
+      if (issue.code === "invalid_union" && issue.errors.length) {
+        // regular union error
+        issue.errors.map((issues) => processError({ issues }, issue.path));
+      } else if (issue.code === "invalid_key") {
+        processError({ issues: issue.issues }, issue.path);
+      } else if (issue.code === "invalid_element") {
+        processError({ issues: issue.issues }, issue.path);
+      } else {
+        const fullpath = [...path, ...issue.path];
+        if (fullpath.length === 0) {
+          result.errors.push(mapper(issue));
+          continue;
+        }
+
+        let curr: any = result;
+        let i = 0;
+        while (i < fullpath.length) {
+          const el = fullpath[i]!;
+
+          const terminal = i === fullpath.length - 1;
+          if (typeof el === "string") {
+            curr.properties ??= {};
+            curr.properties[el] ??= { errors: [] };
+            curr = curr.properties[el];
+          } else {
+            curr.items ??= [];
+            curr.items[el] ??= { errors: [] };
+            curr = curr.items[el];
+          }
+
+          if (terminal) {
+            curr.errors.push(mapper(issue));
+          }
+
+          i++;
+        }
+      }
+    }
+  };
+  processError(error);
+  return result;
+}
+
+/** Format a ZodError as a human-readable string in the following form.
+ *
+ * From
+ *
+ * ```ts
+ * ZodError {
+ *   issues: [
+ *     {
+ *       expected: 'string',
+ *       code: 'invalid_type',
+ *       path: [ 'username' ],
+ *       message: 'Invalid input: expected string'
+ *     },
+ *     {
+ *       expected: 'number',
+ *       code: 'invalid_type',
+ *       path: [ 'favoriteNumbers', 1 ],
+ *       message: 'Invalid input: expected number'
+ *     }
+ *   ];
+ * }
+ * ```
+ *
+ * to
+ *
+ * ```
+ * username
+ *   ✖ Expected number, received string at "username
+ * favoriteNumbers[0]
+ *   ✖ Invalid input: expected number
+ * ```
+ */
+export function toDotPath(path: (string | number | symbol)[]): string {
+  const segs: string[] = [];
+  for (const seg of path) {
+    if (typeof seg === "number") segs.push(`[${seg}]`);
+    else if (typeof seg === "symbol") segs.push(`[${JSON.stringify(String(seg))}]`);
+    else if (/[^\w$]/.test(seg)) segs.push(`[${JSON.stringify(seg)}]`);
+    else {
+      if (segs.length) segs.push(".");
+      segs.push(seg);
+    }
+  }
+
+  return segs.join("");
+}
+
+interface BaseError {
+  issues: $ZodIssueBase[];
+}
+
+export function prettifyError(error: BaseError): string {
+  const lines: string[] = [];
+  // sort by path length
+  const issues = [...error.issues].sort((a, b) => a.path.length - b.path.length);
+
+  // Process each issue
+  for (const issue of issues) {
+    lines.push(`✖ ${issue.message}`);
+    if (issue.path?.length) lines.push(`  → at ${toDotPath(issue.path)}`);
+  }
+
+  // Convert Map to formatted string
+  return lines.join("\n");
+}