| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220 |
- import type { $ZodCheck, $ZodStringFormats } from "./checks.js";
- import { $constructor } from "./core.js";
- import type { $ZodType } from "./schemas.js";
- import type { StandardSchemaV1 } from "./standard-schema.js";
- import * as util from "./util.js";
- export interface $ZodIssueBase {
- readonly code?: string;
- readonly input?: unknown;
- readonly path: PropertyKey[];
- readonly message: string;
- }
- export type $ZodInvalidTypeExpected = "string" | "number" | "int" | "boolean" | "bigint" | "symbol" | "undefined" | "null" | "never" | "void" | "date" | "array" | "object" | "tuple" | "record" | "map" | "set" | "file" | "nonoptional" | "nan" | "function" | (string & {});
- export interface $ZodIssueInvalidType<Input = unknown> extends $ZodIssueBase {
- readonly code: "invalid_type";
- readonly expected: $ZodInvalidTypeExpected;
- 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>;
- }
- interface $ZodIssueInvalidUnionNoMatch extends $ZodIssueBase {
- readonly code: "invalid_union";
- readonly errors: $ZodIssue[][];
- readonly input?: unknown;
- readonly discriminator?: string | undefined;
- readonly inclusive?: true;
- }
- interface $ZodIssueInvalidUnionMultipleMatch extends $ZodIssueBase {
- readonly code: "invalid_union";
- readonly errors: [];
- readonly input?: unknown;
- readonly discriminator?: string | undefined;
- readonly inclusive: false;
- }
- export type $ZodIssueInvalidUnion = $ZodIssueInvalidUnionNoMatch | $ZodIssueInvalidUnionMultipleMatch;
- 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;
- }
- 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;
- export type $ZodIssue = $ZodIssueInvalidType | $ZodIssueTooBig | $ZodIssueTooSmall | $ZodIssueInvalidStringFormat | $ZodIssueNotMultipleOf | $ZodIssueUnrecognizedKeys | $ZodIssueInvalidUnion | $ZodIssueInvalidKey | $ZodIssueInvalidElement | $ZodIssueInvalidValue | $ZodIssueCustom;
- export type $ZodIssueCode = $ZodIssue["code"];
- export type $ZodInternalIssue<T extends $ZodIssueBase = $ZodIssue> = T extends any ? RawIssue<T> : never;
- type RawIssue<T extends $ZodIssueBase> = T extends any ? 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;
- /** If `true`, Zod will continue executing checks/refinements after this issue. */
- readonly continue?: boolean | undefined;
- } & Record<string, unknown>> : never;
- export type $ZodRawIssue<T extends $ZodIssueBase = $ZodIssue> = $ZodInternalIssue<T>;
- export interface $ZodErrorMap<T extends $ZodIssueBase = $ZodIssue> {
- (issue: $ZodRawIssue<T>): {
- message: string;
- } | string | undefined | null;
- }
- export interface $ZodError<T = unknown> extends Error {
- type: T;
- issues: $ZodIssue[];
- _zod: {
- output: T;
- def: $ZodIssue[];
- };
- stack?: string;
- name: string;
- }
- export declare const $ZodError: $constructor<$ZodError>;
- interface $ZodRealError<T = any> extends $ZodError<T> {
- }
- export declare const $ZodRealError: $constructor<$ZodRealError>;
- export type $ZodFlattenedError<T, U = string> = _FlattenedError<T, U>;
- type _FlattenedError<T, U = string> = {
- formErrors: U[];
- fieldErrors: {
- [P in keyof T]?: U[];
- };
- };
- export declare function flattenError<T>(error: $ZodError<T>): _FlattenedError<T>;
- export declare function flattenError<T, U>(error: $ZodError<T>, mapper?: (issue: $ZodIssue) => U): _FlattenedError<T, U>;
- 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 declare function formatError<T>(error: $ZodError<T>): $ZodFormattedError<T>;
- export declare function formatError<T, U>(error: $ZodError<T>, mapper?: (issue: $ZodIssue) => U): $ZodFormattedError<T, U>;
- 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 declare function treeifyError<T>(error: $ZodError<T>): $ZodErrorTree<T>;
- export declare function treeifyError<T, U>(error: $ZodError<T>, mapper?: (issue: $ZodIssue) => U): $ZodErrorTree<T, U>;
- /** 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 declare function toDotPath(_path: readonly (string | number | symbol | StandardSchemaV1.PathSegment)[]): string;
- export declare function prettifyError(error: StandardSchemaV1.FailureResult): string;
- export {};
|