Skip to content

Releases: colinhacks/zod

v3.23.0

21 Apr 22:44
@github-actions github-actions
v3.23.0
39a588a
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.
Compare
Choose a tag to compare
v3.23.0

Zod 3.23 is now available. This is the final 3.x release before Zod 4.0. To try it out:

npm install zod

Features

z.string().date()

Zod can now validate ISO 8601 date strings. Thanks @igalklebanov! #1766

const schema = z.string().date();
schema.parse("2022-01-01"); // OK

z.string().time()

Zod can now validate ISO 8601 time strings. Thanks @igalklebanov! #1766

const schema = z.string().time();
schema.parse("12:00:00"); // OK

You can specify sub-second precision using the precision option:

const schema = z.string().time({ precision: 3 });
schema.parse("12:00:00.123"); // OK
schema.parse("12:00:00.123456"); // Error
schema.parse("12:00:00"); // Error

z.string().duration()

Zod can now validate ISO 8601 duration strings. Thanks @mastermatt! #3265

const schema = z.string().duration();
schema.parse("P3Y6M4DT12H30M5S"); // OK

Improvements to z.string().datetime()

Thanks @bchrobot #2522

You can now allow unqualified (timezone-less) datetimes using the local: true flag.

const schema = z.string().datetime({ local: true });
schema.parse("2022-01-01T12:00:00"); // OK

Plus, Zod now validates the day-of-month correctly to ensure no invalid dates (e.g. February 30th) pass validation. Thanks @szamanr! #3391

z.string().base64()

Zod can now validate base64 strings. Thanks @StefanTerdell! #3047

const schema = z.string().base64();
schema.parse("SGVsbG8gV29ybGQ="); // OK

Improved discriminated unions

The following can now be used as discriminator keys in z.discriminatedUnion():

  • ZodOptional
  • ZodNullable
  • ZodReadonly
  • ZodBranded
  • ZodCatch
const schema = z.discriminatedUnion("type", [
  z.object({ type: z.literal("A").optional(), value: z.number() }),
  z.object({ type: z.literal("B").nullable(), value: z.string() }),
  z.object({ type: z.literal("C").readonly(), value: z.boolean() }),
  z.object({ type: z.literal("D").brand<"D">(), value: z.boolean() }),
  z.object({ type: z.literal("E").catch("E"), value: z.unknown() }),
]);

Misc

Breaking changes

There are no breaking changes to the public API of Zod. However some changes can impact ecosystem tools that rely on Zod internals.

ZodFirstPartySchemaTypes

Three new types have been added to the ZodFirstPartySchemaTypes union. This may impact some codegen libraries. #3247

+  | ZodPipeline<any, any>
+  | ZodReadonly<any>
+  | ZodSymbol;

Unrecognized keys in .pick() and .omit()

This version fixes a bug where unknown keys were accidentally accepted in .pick() and omit(). This has been fixed, which could cause compiler errors in some user code. #3255

z.object({ 
  name: z.string() 
}).pick({
  notAKey: true // no longer allowed
})

Bugfixes and performance

Docs and ecosystem

New Contributors

Read more

Contributors

rotu, IlyaSemenov, and 40 other contributors
Assets 2
Loading

v3.23.0-beta.0

18 Apr 01:55
@colinhacks colinhacks
v3.23.0-beta.0
579ecb2
Compare
Choose a tag to compare
v3.23.0-beta.0 Pre-release
Pre-release

Zod 3.23 is now in beta! This is the final 3.x release before Zod 4.0. To try it out:

npm install zod@beta

Features

z.string().date()

Zod can now validate ISO 8601 date strings. Thanks @igalklebanov! #1766

const schema = z.string().date();
schema.parse("2022-01-01"); // OK

z.string().time()

Zod can now validate ISO 8601 time strings. Thanks @igalklebanov! #1766

const schema = z.string().time();
schema.parse("12:00:00"); // OK

You can specify sub-second precision using the precision option:

const schema = z.string().time({ precision: 3 });
schema.parse("12:00:00.123"); // OK
schema.parse("12:00:00.123456"); // Error
schema.parse("12:00:00"); // Error

z.string().duration()

Zod can now validate ISO 8601 duration strings. Thanks @mastermatt! #3265

const schema = z.string().duration();
schema.parse("P3Y6M4DT12H30M5S"); // OK

Improvements to z.string().datetime()

Thanks @bchrobot #2522

You can now allow unqualified (timezone-less) datetimes using the local: true flag.

const schema = z.string().datetime({ local: true });
schema.parse("2022-01-01T12:00:00"); // OK

Plus, Zod now validates the day-of-month correctly to ensure no invalid dates (e.g. February 30th) pass validation. Thanks @szamanr! #3391

z.string().base64()

Zod can now validate base64 strings. Thanks @StefanTerdell! #3047

const schema = z.string().base64();
schema.parse("SGVsbG8gV29ybGQ="); // OK

Improved discriminated unions

The following can now be used as discriminator keys in z.discriminatedUnion():

  • ZodOptional
  • ZodNullable
  • ZodReadonly
  • ZodBranded
  • ZodCatch
const schema = z.discriminatedUnion("type", [
  z.object({ type: z.literal("A").optional(), value: z.number() }),
  z.object({ type: z.literal("B").nullable(), value: z.string() }),
  z.object({ type: z.literal("C").readonly(), value: z.boolean() }),
  z.object({ type: z.literal("D").readonly(), value: z.boolean() }),
  z.object({ type: z.literal("E").catch("E"), value: z.unknown() }),
]);

Misc

Breaking changes

There are no breaking changes to the public API of Zod. However some changes can impact ecosystem tools that rely on Zod internals.

ZodFirstPartySchemaTypes

Three new types have been added to the ZodFirstPartySchemaTypes union. This may impact some codegen libraries. #3247

+  | ZodPipeline<any, any>
+  | ZodReadonly<any>
+  | ZodSymbol;

Default generics in ZodType

The third argument of the ZodType base class now defaults to unknown. This makes it easier to define recursive schemas and write generic functions that accept Zod schemas.

- class ZodType<Output = any, Def extends ZodTypeDef = ZodTypeDef, Input = Output> {}
+ class ZodType<Output = unknown, Def extends ZodTypeDef = ZodTypeDef, Input = unknown> {}

Unrecognized keys in .pick() and .omit()

This version fixes a bug where unknown keys were accidentally accepted in .pick() and omit(). This has been fixed, which could cause compiler errors in some user code. #3255

z.object({ 
  name: z.string() 
}).pick({
  notAKey: true // no longer allowed
})

Bugfixes and performance

Docs and ecosystem

New Contributors

Read more

Contributors

rotu, IlyaSemenov, and 40 other contributors
Assets 2
Loading

v3.22.4

04 Oct 21:53
@github-actions github-actions
v3.22.4
e7a9b9b
Compare
Choose a tag to compare
v3.22.4

Commits:

Assets 2
Loading

v3.22.3

03 Oct 18:34
@github-actions github-actions
v3.22.3
1e61d76
Compare
Choose a tag to compare
v3.22.3

Commits:

Assets 2
Loading

v3.22.2

19 Aug 00:15
@github-actions github-actions
v3.22.2
792b3ef
Compare
Choose a tag to compare
v3.22.2

Commits:

Assets 2
Loading

v3.22.1

15 Aug 19:43
@github-actions github-actions
v3.22.1
0a055e7
Compare
Choose a tag to compare
v3.22.1

Commits:

Fix handing of this in ZodFunction schemas. The parse logic for function schemas now requires the Reflect API.

const methodObject = z.object({
  property: z.number(),
  method: z.function().args(z.string()).returns(z.number()),
});
const methodInstance = {
  property: 3,
  method: function (s: string) {
    return s.length + this.property;
  },
};
const parsed = methodObject.parse(methodInstance);
parsed.method("length=8"); // => 11 (8 length + 3 property)
Assets 2
Loading

v3.22.0

14 Aug 19:24
@github-actions github-actions
v3.22.0
fba438c
Compare
Choose a tag to compare
v3.22.0

ZodReadonly

This release introduces ZodReadonly and the .readonly() method on ZodType.

Calling .readonly() on any schema returns a ZodReadonly instance that wraps the original schema. The new schema parses all inputs using the original schema, then calls Object.freeze() on the result. The inferred type is also marked as readonly.

const schema = z.object({ name: string }).readonly();
type schema = z.infer<typeof schema>;
// Readonly<{name: string}>

const result = schema.parse({ name: "fido" });
result.name = "simba"; // error

The inferred type uses TypeScript's built-in readonly types when relevant.

z.array(z.string()).readonly();
// readonly string[]

z.tuple([z.string(), z.number()]).readonly();
// readonly [string, number]

z.map(z.string(), z.date()).readonly();
// ReadonlyMap<string, Date>

z.set(z.string()).readonly();
// ReadonlySet<Promise<string>>

Commits:

Assets 2
Loading

v3.21.4

07 Mar 04:39
@github-actions github-actions
v3.21.4
22f3cc6
Compare
Choose a tag to compare
v3.21.4

Commits:

Assets 2
Loading

v3.21.3

06 Mar 21:48
@github-actions github-actions
v3.21.3
2db0dca
Compare
Choose a tag to compare
v3.21.3

Commits:

Assets 2
Loading

v3.21.2

06 Mar 07:20
@github-actions github-actions
v3.21.2
ac0135e
Compare
Choose a tag to compare
v3.21.2

Commits:

  • b276d71 Improve typings in generics
  • 4d016b7 Improve type inference in generics
  • f9895ab Improve types inside generic functions
  • ac0135e Pass input into catchValue
Assets 2
Loading