Skip to content

v3.23.0
Compare
Choose a tag to compare
@github-actions github-actions released this 21 Apr 22:44
· 22 commits to refs/heads/master since this release
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.

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

Full Changelog: v3.22.4...v3.23.0

Contributors

rotu, IlyaSemenov, and 41 other contributors
Assets 2