feat: Add support for zod@4 schemas #1666
Conversation
karpetrosyan
force-pushed
the
support-zod-v4-schemas
branch
from
c482776 to
8f56474
Compare
tests/helpers/zod.test.ts
Outdated
| }); | ||
|
|
||
| it('throws error on optional fields', () => { | ||
| (version === 'v4' ? it.skip : it)('throws error on optional fields', () => { |
There was a problem hiding this comment.
as we transform the schema, we actually add missing fields in required property, as we do in python
There was a problem hiding this comment.
hmm I don't think this is quite right, in Python it's fine because the property being omitted or explicitly set to null results in the same type, None, but in TS it's different.
so if we add properties that are .optional() to the required array, then the API will send them back as null, which breaks the type promise because it'd be typed as property?: string instead of property?: string | null or property: string | null.
the equivalent behaviour here for python would be to only add properties to required when they're both .optional() and .nullable() which is why we throw the current error.
| describe.each([ | ||
| { version: 'v3', z: zv3 as any }, | ||
| { version: 'v4', z: zv4 as any }, | ||
| ])('zodResponseFormat (Zod $version)', ({ version, z }) => { |
There was a problem hiding this comment.
👌 this is a cool way to test things
tests/helpers/zod.test.ts
Outdated
| }); | ||
|
|
||
| it('throws error on optional fields', () => { | ||
| (version === 'v4' ? it.skip : it)('throws error on optional fields', () => { |
There was a problem hiding this comment.
hmm I don't think this is quite right, in Python it's fine because the property being omitted or explicitly set to null results in the same type, None, but in TS it's different.
so if we add properties that are .optional() to the required array, then the API will send them back as null, which breaks the type promise because it'd be typed as property?: string instead of property?: string | null or property: string | null.
the equivalent behaviour here for python would be to only add properties to required when they're both .optional() and .nullable() which is why we throw the current error.
Changes being requested
Additional context & links