chore: [JS] Add instructions to always use zod@v4 #299
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1 task
|
|
||
| ```ts | ||
| import * as z from 'zod'; | ||
| import * as z from 'zod/v4'; |
Contributor
There was a problem hiding this comment.
Instead of importing zod/v4, I would suggest we import zod and put a sentence here recommending people to use zod@v4 package. Also add a note here and link the zod migration guide to tell people, if anything wrong, update their zod to v4 package and also use meta instead of describe. I find it otherwise pretty complex to document all combinations and support old zod versions.
davidkna-sap
force-pushed
the
davidkna-sap_version-zod
branch
from
3956fdf to
1d38484
Compare
davidkna-sap
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What Has Changed?
This ensures that the examples work as expected, always using a fixed zod version (
zod/v4) to ensure broader compatibility of the sample code.This PR also handles the following deprecations:
describe->.meta({ description })object({}).strict()->strictObject({})Draft because this depends on SAP/ai-sdk-js#1187