Add v3 docs

packages/docs-v3/.editorconfig

@@ -0,0 +1,12 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+charset = utf-8

packages/docs-v3/CHANGELOG.md

@@ -0,0 +1,255 @@
+# Changelog
+
+## Release notes are now stored in Github Releases: https://github.com/colinhacks/zod/releases
+
+## Previous Releases
+
+### 3.10
+
+- New parser that allows parsing to continue after non-fatal errors have occurred. This allows Zod to surface more errors to the user at once.
+
+### 3.9
+
+- Custom error messages in schemas
+
+```ts
+const name = z.string({
+  invalid_type_error: "Name must be string",
+  required_error: "Name is required",
+});
+```
+
+Under the hood, this creates a custom error map that's bound to the schema. You can also pass a custom error map explicitly.
+
+```ts
+const name = z.string({ errorMap: myErrorMap });
+```
+
+- Rest parameters for tuples
+
+```ts
+const myTuple = z.tuple([z.string(), z.number()]).rest(z.boolean());
+type t1 = z.output<typeof myTuple>; // [string, number, ...boolean[]]
+```
+
+- Selective `.partial`
+
+You can specify certain fields to make optional with the `ZodObject.partial` method.
+
+```ts
+const user = z.object({
+  name: z.string(),
+  age: z.number(),
+});
+
+const optionalNameUser = user.partial({ name: true });
+// { name?: string; age: number; }
+```
+
+- Specify key schema in ZodRecord
+
+Previously, `z.record` only accepted a single schema:
+
+```ts
+z.record(z.boolean()); // Record<string, boolean>;
+```
+
+Now `z.record` has been overloaded to support two schemas. The first validates the _keys_ of the record, and the second validates the _values_.
+
+```ts
+const schema = z.record(z.number(), z.boolean());
+type schema = z.infer<typeof schema>; // Record<number, boolean>
+
+const schema = z.record(z.enum(["Tuna", "Trout"]), z.boolean());
+type schema = z.infer<typeof schema>; // Record<"Tuna" | "Trout", boolean>
+```
+
+### 3.8
+
+- Add `z.preprocess`
+- Implement CUID validation on ZodString (`z.string().cuid()`)
+- Improved `.deepPartial()`: now recursively operates on arrays, tuples, optionals, and nullables (in addition to objects)
+
+### 3.7
+
+- Eliminate `ZodNonEmptyArray`, add `Cardinality` to `ZodArray`
+- Add optional error message to `ZodArray.nonempty`
+- Add `.gt/.gte/.lt/.lte` to `ZodNumber`
+
+### 3.6
+
+- Add IE11 support
+- `ZodError.flatten` now optionally accepts a map function for customizing the output
+- `.void()` now only accepts undefined, not null.
+- `z.enum` now supports `Readonly` string tuples
+
+### 3.5
+
+- Add discriminator to all first-party schema defs
+
+### 3.4
+
+- `unknown` and `any` schemas are always interpreted as optional. Reverts change from 3.3.
+
+### 3.3
+
+- HUGE speed improvements
+- Added benchmarking: `yarn benchmark`
+- Type signature of `ZodType#_parse` has changed. This will affects users who have implemented custom subclasses of `ZodType`.
+- [reverted] Object fields of type `unknown` are no longer inferred as optional.
+
+### 3.2
+
+- Certain methods (`.or`, `.transform`) now return a new instance that wrap the current instance, instead of trying to avoid additional nesting. For example:
+
+```ts
+z.union([z.string(), z.number()]).or(z.boolean());
+// previously
+// => ZodUnion<[ZodString, ZodNumber, ZodBoolean]>
+
+// now
+// => ZodUnion<[ZodUnion<[ZodString, ZodNumber]>, ZodBoolean]>
+```
+
+This change was made due to recursion limitations in TypeScript 4.3 that made it impossible to properly type these methods.
+
+### 3.0.0-beta.1
+
+- Moved default value logic into ZodDefault. Implemented `.nullish()` method.
+
+### 3.0.0-alpha.33
+
+- Added `.returnType` and `.parameters` methods to ZodFunction
+
+### 3.0.0-alpha.32
+
+- Added `.required()` method to ZodObject
+
+### 3.0.0-alpha.30
+
+- Added Rollup for bundling ESM module
+
+### zod@3.0.0-alpha.24
+
+- Added back ZodIntersection
+- Added .and() method to base class
+
+### zod@3.0.0-alpha.9
+
+- Added `z.strictCreate`
+
+### zod@3.0.0-alpha.8
+
+- Allowing optional default values on ZodOptional
+
+### zod@3.0.0-alpha.5
+
+March 17, 2021
+
+- Refactored parsing logic into individual subclass methods
+- Eliminated ZodTypes to enable custom ZodType subclasses
+- Removed ZodIntersection
+- Added ZodEffects as a container for refinement and transform logic
+- Added `or` method to `ZodType`
+- Added `format` method to `ZodError`
+- Added `unwrap` method to `ZodOptional` and `ZodNullable`
+- Added new `default` method and moved default functionality into ZodOptional
+- Implemented `z.setErrorMap`
+- Exporting `z` variable from `index.ts` to enable `import { z } from 'zod';`
+
+### zod@3.0.0-alpha.4
+
+Jan 25, 2021
+
+- New implementation of transformers
+- Removed type guards
+
+### zod@2
+
+- Added ZodTransformer
+- Async refinements
+
+### zod@1.11
+
+- Introduced `.safeParse` option
+- Introduced .regex method on string schemas
+- Implemented `.primitives()` and `.nonprimitives()` on object schemas
+- Implemented `z.nativeEnum()` for creating schemas from TypeScript `enum`s
+- Switched to `new URL()` constructor to check valid URLs
+
+### zod@1.10
+
+- Dropping support for TypeScript 3.2
+
+### zod@1.9
+
+- Added z.instanceof() and z.custom()
+- Implemented ZodSchema.array() method
+
+### zod@1.8
+
+- Introduced z.void()
+- Major overhaul to error handling system, including the introduction of custom error maps
+- Wrote new [error handling guide](./ERROR_HANDLING.md)
+
+### zod@1.7
+
+- Added several built-in validators to string, number, and array schemas
+- Calls to `.refine` now return new instance
+
+### zod@1.5
+
+- Introduces ZodAny and ZodUnknown
+
+### zod@1.4
+
+- Refinement types (`.refine`)
+- Parsing no longer returns deep clone
+
+### zod@1.3
+
+- Promise schemas
+
+### zod@1.2.6
+
+- `.parse` accepts `unknown`
+- `bigint` schemas
+
+### zod@1.2.5
+
+- `.partial` and `.deepPartial` on object schemas
+
+### zod@1.2.3
+
+- Added ZodDate
+
+### zod@1.2.0
+
+- Added `.pick`, `.omit`, and `.extend` on object schemas
+
+### zod@1.1.0
+
+- Added ZodRecord
+
+### zod@1.0.11
+
+- Added `.nonstrict`
+
+### zod@1.0.10
+
+- Added type assertions with `.check`
+
+### zod@1.0.4
+
+- Support for empty tuples
+
+### zod@1.0.2
+
+- Added type assertions
+- Added ZodLiteral
+- Added ZodEnum
+- Improved error reporting
+
+### zod@1.0.0
+
+- Initial release