util.d.cts 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199
  1. import type * as checks from "./checks.cjs";
  2. import type { $ZodConfig } from "./core.cjs";
  3. import type * as errors from "./errors.cjs";
  4. import type * as schemas from "./schemas.cjs";
  5. export type JSONType = string | number | boolean | null | JSONType[] | {
  6. [key: string]: JSONType;
  7. };
  8. export type JWTAlgorithm = "HS256" | "HS384" | "HS512" | "RS256" | "RS384" | "RS512" | "ES256" | "ES384" | "ES512" | "PS256" | "PS384" | "PS512" | "EdDSA" | (string & {});
  9. export type HashAlgorithm = "md5" | "sha1" | "sha256" | "sha384" | "sha512";
  10. export type HashEncoding = "hex" | "base64" | "base64url";
  11. export type HashFormat = `${HashAlgorithm}_${HashEncoding}`;
  12. export type IPVersion = "v4" | "v6";
  13. export type MimeTypes = "application/json" | "application/xml" | "application/x-www-form-urlencoded" | "application/javascript" | "application/pdf" | "application/zip" | "application/vnd.ms-excel" | "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" | "application/msword" | "application/vnd.openxmlformats-officedocument.wordprocessingml.document" | "application/vnd.ms-powerpoint" | "application/vnd.openxmlformats-officedocument.presentationml.presentation" | "application/octet-stream" | "application/graphql" | "text/html" | "text/plain" | "text/css" | "text/javascript" | "text/csv" | "image/png" | "image/jpeg" | "image/gif" | "image/svg+xml" | "image/webp" | "audio/mpeg" | "audio/ogg" | "audio/wav" | "audio/webm" | "video/mp4" | "video/webm" | "video/ogg" | "font/woff" | "font/woff2" | "font/ttf" | "font/otf" | "multipart/form-data" | (string & {});
  14. export type ParsedTypes = "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function" | "file" | "date" | "array" | "map" | "set" | "nan" | "null" | "promise";
  15. export type AssertEqual<T, U> = (<V>() => V extends T ? 1 : 2) extends <V>() => V extends U ? 1 : 2 ? true : false;
  16. export type AssertNotEqual<T, U> = (<V>() => V extends T ? 1 : 2) extends <V>() => V extends U ? 1 : 2 ? false : true;
  17. export type AssertExtends<T, U> = T extends U ? T : never;
  18. export type IsAny<T> = 0 extends 1 & T ? true : false;
  19. export type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
  20. export type OmitKeys<T, K extends string> = Pick<T, Exclude<keyof T, K>>;
  21. export type MakePartial<T, K extends keyof T> = Omit<T, K> & InexactPartial<Pick<T, K>>;
  22. export type MakeRequired<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
  23. export type Exactly<T, X> = T & Record<Exclude<keyof X, keyof T>, never>;
  24. export type NoUndefined<T> = T extends undefined ? never : T;
  25. export type Whatever = {} | undefined | null;
  26. export type LoosePartial<T extends object> = InexactPartial<T> & {
  27. [k: string]: unknown;
  28. };
  29. export type Mask<Keys extends PropertyKey> = {
  30. [K in Keys]?: true;
  31. };
  32. export type Writeable<T> = {
  33. -readonly [P in keyof T]: T[P];
  34. } & {};
  35. export type InexactPartial<T> = {
  36. [P in keyof T]?: T[P] | undefined;
  37. };
  38. export type EmptyObject = Record<string, never>;
  39. export type BuiltIn = (((...args: any[]) => any) | (new (...args: any[]) => any)) | {
  40. readonly [Symbol.toStringTag]: string;
  41. } | Date | Error | Generator | Promise<unknown> | RegExp;
  42. export type MakeReadonly<T> = T extends Map<infer K, infer V> ? ReadonlyMap<K, V> : T extends Set<infer V> ? ReadonlySet<V> : T extends [infer Head, ...infer Tail] ? readonly [Head, ...Tail] : T extends Array<infer V> ? ReadonlyArray<V> : T extends BuiltIn ? T : Readonly<T>;
  43. export type SomeObject = Record<PropertyKey, any>;
  44. export type Identity<T> = T;
  45. export type Flatten<T> = Identity<{
  46. [k in keyof T]: T[k];
  47. }>;
  48. export type Mapped<T> = {
  49. [k in keyof T]: T[k];
  50. };
  51. export type Prettify<T> = {
  52. [K in keyof T]: T[K];
  53. } & {};
  54. export type NoNeverKeys<T> = {
  55. [k in keyof T]: [T[k]] extends [never] ? never : k;
  56. }[keyof T];
  57. export type NoNever<T> = Identity<{
  58. [k in NoNeverKeys<T>]: k extends keyof T ? T[k] : never;
  59. }>;
  60. export type Extend<A extends SomeObject, B extends SomeObject> = Flatten<keyof A & keyof B extends never ? A & B : {
  61. [K in keyof A as K extends keyof B ? never : K]: A[K];
  62. } & {
  63. [K in keyof B]: B[K];
  64. }>;
  65. export type TupleItems = ReadonlyArray<schemas.SomeType>;
  66. export type AnyFunc = (...args: any[]) => any;
  67. export type IsProp<T, K extends keyof T> = T[K] extends AnyFunc ? never : K;
  68. export type MaybeAsync<T> = T | Promise<T>;
  69. export type KeyOf<T> = keyof OmitIndexSignature<T>;
  70. export type OmitIndexSignature<T> = {
  71. [K in keyof T as string extends K ? never : K extends string ? K : never]: T[K];
  72. };
  73. export type ExtractIndexSignature<T> = {
  74. [K in keyof T as string extends K ? K : K extends string ? never : K]: T[K];
  75. };
  76. export type Keys<T extends object> = keyof OmitIndexSignature<T>;
  77. export type SchemaClass<T extends schemas.SomeType> = {
  78. new (def: T["_zod"]["def"]): T;
  79. };
  80. export type EnumValue = string | number;
  81. export type EnumLike = Readonly<Record<string, EnumValue>>;
  82. export type ToEnum<T extends EnumValue> = Flatten<{
  83. [k in T]: k;
  84. }>;
  85. export type KeysEnum<T extends object> = ToEnum<Exclude<keyof T, symbol>>;
  86. export type KeysArray<T extends object> = Flatten<(keyof T & string)[]>;
  87. export type Literal = string | number | bigint | boolean | null | undefined;
  88. export type LiteralArray = Array<Literal>;
  89. export type Primitive = string | number | symbol | bigint | boolean | null | undefined;
  90. export type PrimitiveArray = Array<Primitive>;
  91. export type HasSize = {
  92. size: number;
  93. };
  94. export type HasLength = {
  95. length: number;
  96. };
  97. export type Numeric = number | bigint | Date;
  98. export type SafeParseResult<T> = SafeParseSuccess<T> | SafeParseError<T>;
  99. export type SafeParseSuccess<T> = {
  100. success: true;
  101. data: T;
  102. error?: never;
  103. };
  104. export type SafeParseError<T> = {
  105. success: false;
  106. data?: never;
  107. error: errors.$ZodError<T>;
  108. };
  109. export type PropValues = Record<string, Set<Primitive>>;
  110. export type PrimitiveSet = Set<Primitive>;
  111. export declare function assertEqual<A, B>(val: AssertEqual<A, B>): AssertEqual<A, B>;
  112. export declare function assertNotEqual<A, B>(val: AssertNotEqual<A, B>): AssertNotEqual<A, B>;
  113. export declare function assertIs<T>(_arg: T): void;
  114. export declare function assertNever(_x: never): never;
  115. export declare function assert<T>(_: any): asserts _ is T;
  116. export declare function getEnumValues(entries: EnumLike): EnumValue[];
  117. export declare function joinValues<T extends Primitive[]>(array: T, separator?: string): string;
  118. export declare function jsonStringifyReplacer(_: string, value: any): any;
  119. export declare function cached<T>(getter: () => T): {
  120. value: T;
  121. };
  122. export declare function nullish(input: any): boolean;
  123. export declare function cleanRegex(source: string): string;
  124. export declare function floatSafeRemainder(val: number, step: number): number;
  125. export declare function defineLazy<T, K extends keyof T>(object: T, key: K, getter: () => T[K]): void;
  126. export declare function objectClone(obj: object): any;
  127. export declare function assignProp<T extends object, K extends PropertyKey>(target: T, prop: K, value: K extends keyof T ? T[K] : any): void;
  128. export declare function mergeDefs(...defs: Record<string, any>[]): any;
  129. export declare function cloneDef(schema: schemas.$ZodType): any;
  130. export declare function getElementAtPath(obj: any, path: (string | number)[] | null | undefined): any;
  131. export declare function promiseAllObject<T extends object>(promisesObj: T): Promise<{
  132. [k in keyof T]: Awaited<T[k]>;
  133. }>;
  134. export declare function randomString(length?: number): string;
  135. export declare function esc(str: string): string;
  136. export declare function slugify(input: string): string;
  137. export declare const captureStackTrace: (targetObject: object, constructorOpt?: Function) => void;
  138. export declare function isObject(data: any): data is Record<PropertyKey, unknown>;
  139. export declare const allowsEval: {
  140. value: boolean;
  141. };
  142. export declare function isPlainObject(o: any): o is Record<PropertyKey, unknown>;
  143. export declare function shallowClone(o: any): any;
  144. export declare function numKeys(data: any): number;
  145. export declare const getParsedType: (data: any) => ParsedTypes;
  146. export declare const propertyKeyTypes: Set<string>;
  147. export declare const primitiveTypes: Set<string>;
  148. export declare function escapeRegex(str: string): string;
  149. export declare function clone<T extends schemas.$ZodType>(inst: T, def?: T["_zod"]["def"], params?: {
  150. parent: boolean;
  151. }): T;
  152. export type EmptyToNever<T> = keyof T extends never ? never : T;
  153. export type Normalize<T> = T extends undefined ? never : T extends Record<any, any> ? Flatten<{
  154. [k in keyof Omit<T, "error" | "message">]: T[k];
  155. } & ("error" extends keyof T ? {
  156. error?: Exclude<T["error"], string>;
  157. } : unknown)> : never;
  158. export declare function normalizeParams<T>(_params: T): Normalize<T>;
  159. export declare function createTransparentProxy<T extends object>(getter: () => T): T;
  160. export declare function stringifyPrimitive(value: any): string;
  161. export declare function optionalKeys(shape: schemas.$ZodShape): string[];
  162. export type CleanKey<T extends PropertyKey> = T extends `?${infer K}` ? K : T extends `${infer K}?` ? K : T;
  163. export type ToCleanMap<T extends schemas.$ZodLooseShape> = {
  164. [k in keyof T]: k extends `?${infer K}` ? K : k extends `${infer K}?` ? K : k;
  165. };
  166. export type FromCleanMap<T extends schemas.$ZodLooseShape> = {
  167. [k in keyof T as k extends `?${infer K}` ? K : k extends `${infer K}?` ? K : k]: k;
  168. };
  169. export declare const NUMBER_FORMAT_RANGES: Record<checks.$ZodNumberFormats, [number, number]>;
  170. export declare const BIGINT_FORMAT_RANGES: Record<checks.$ZodBigIntFormats, [bigint, bigint]>;
  171. export declare function pick(schema: schemas.$ZodObject, mask: Record<string, unknown>): any;
  172. export declare function omit(schema: schemas.$ZodObject, mask: object): any;
  173. export declare function extend(schema: schemas.$ZodObject, shape: schemas.$ZodShape): any;
  174. export declare function safeExtend(schema: schemas.$ZodObject, shape: schemas.$ZodShape): any;
  175. export declare function merge(a: schemas.$ZodObject, b: schemas.$ZodObject): any;
  176. export declare function partial(Class: SchemaClass<schemas.$ZodOptional> | null, schema: schemas.$ZodObject, mask: object | undefined): any;
  177. export declare function required(Class: SchemaClass<schemas.$ZodNonOptional>, schema: schemas.$ZodObject, mask: object | undefined): any;
  178. export type Constructor<T, Def extends any[] = any[]> = new (...args: Def) => T;
  179. export declare function aborted(x: schemas.ParsePayload, startIndex?: number): boolean;
  180. export declare function prefixIssues(path: PropertyKey, issues: errors.$ZodRawIssue[]): errors.$ZodRawIssue[];
  181. export declare function unwrapMessage(message: string | {
  182. message: string;
  183. } | undefined | null): string | undefined;
  184. export declare function finalizeIssue(iss: errors.$ZodRawIssue, ctx: schemas.ParseContextInternal | undefined, config: $ZodConfig): errors.$ZodIssue;
  185. export declare function getSizableOrigin(input: any): "set" | "map" | "file" | "unknown";
  186. export declare function getLengthableOrigin(input: any): "array" | "string" | "unknown";
  187. export declare function parsedType(data: unknown): errors.$ZodInvalidTypeExpected;
  188. export declare function issue(_iss: string, input: any, inst: any): errors.$ZodRawIssue;
  189. export declare function issue(_iss: errors.$ZodRawIssue): errors.$ZodRawIssue;
  190. export declare function cleanEnum(obj: Record<string, EnumValue>): EnumValue[];
  191. export declare function base64ToUint8Array(base64: string): InstanceType<typeof Uint8Array>;
  192. export declare function uint8ArrayToBase64(bytes: Uint8Array): string;
  193. export declare function base64urlToUint8Array(base64url: string): InstanceType<typeof Uint8Array>;
  194. export declare function uint8ArrayToBase64url(bytes: Uint8Array): string;
  195. export declare function hexToUint8Array(hex: string): InstanceType<typeof Uint8Array>;
  196. export declare function uint8ArrayToHex(bytes: Uint8Array): string;
  197. export declare abstract class Class {
  198. constructor(..._args: any[]);
  199. }