zod doesn't work with typescript 4.3.2

[KATT]

see #472

[prueker]

Ran into the same issue today when updating packages.

Keeping typescript at 4.2.4 works for now as a workaround.

[toresbe]

Thank you for filing this issue and giving a workaround which saved us some tzores.

Can confirm that pinning TS to 4.2.3 solved our problem.

For anyone Googling, this is the error we got:

Excessive stack depth comparing types 'ZodError<?>' and 'ZodError<?>

[KATT]

workaround in my monorepo: trpc/trpc@ff184a9

[glitch452]

I also experienced the same issue. Reverting to TS v4.2.4 solved it for now.
Here are the errors I see. Hope it helps!

error TS2321: Excessive stack depth comparing types 'ZodOptional<?>' and 'ZodOptional<?>'.
error TS2321: Excessive stack depth comparing types 'ZodError<?>' and 'ZodError<?>'.

z.union([z.string(), z.number(), z.boolean(), z.null()]);
error TS2321: Excessive stack depth comparing types 'ZodFormattedError<?>' and 'ZodFormattedError<?>'.

z.union([z.string(), z.number(), z.boolean(), z.null()]);
error TS2321: Excessive stack depth comparing types 'ZodIntersection<?, U>' and 'ZodIntersection<?, U>'.

z.union([z.string(), z.number(), z.boolean(), z.null()]);

error TS2321: Excessive stack depth comparing types 'ZodIntersection<T, ?>' and 'ZodIntersection<T, ?>'.
z.union([z.string(), z.number(), z.boolean(), z.null()]);

src/services/schemas.ts:10:30 - error TS2321: Excessive stack depth comparing types 'ZodNonEmptyArray<?>' and 'ZodNonEmptyArray<?>'.
z.union([z.string(), z.number(), z.boolean(), z.null()]);

error TS2321: Excessive stack depth comparing types 'ZodRecord<?>' and 'ZodRecord<?>'.
z.record(z.string().or(z.number())).optional(),

Ps. Love the library, keep up the awesome work!

[adam-thomas-privitar]

Hi guys. This has been raised on microsoft/TypeScript#44299. There seems to be a more severe variation of this where node runs out of memory during type checking when zod is in use.

[colinhacks]

Fixed in zod@3.2 - upgrade and it will work with TypeScript 4.3.2.

This was a doozy. TS 4.3 added limitations on the self-referential recursive conditional types inside class methods, something that Zod relies on heavily.

I managed to get everything working again with minimal disruption to the Zod's internals, but there's one minor change that was unavoidable. Certain methods (.or and .transform) now return a new instance that wrap the current instance. Previously Zod would try to avoid additional/unnecessary nesting. For example:

z.union([z.string(), z.number()]).or(z.boolean());
// previously
// => ZodUnion<[ZodString, ZodNumber, ZodBoolean]>

// now
// => ZodUnion<[ZodUnion<[ZodString, ZodNumber]>, ZodBoolean]>

With TypeScript 4.3.2 it was no longer possible to reflect the old type signature. In practice I think this change is minor and could almost be considered an internal change so I'm not bumping the major version. This behavior is actually more consistent and avoids certain pitfalls when implementing generic functions that operate on ZodSchemas, so it's not all bad.