Add brand to ZodBranded def at runtime #2860
Closed
+87
−13
Conversation
This file contains 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
✅ Deploy Preview for guileless-rolypoly-866f8a ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
@colinhacks , please make branded types programmatically distinguishable. |
RobinTail
added a commit
to RobinTail/express-zod-api
that referenced
this pull request
Jan 10, 2024
I was dreaming about it. Unfortunately `zod` does not provide any way to make a custom or branded or third-party schema that can be identified as one programmatically. Developer of `zod` also does not want to make any method to store metadata in schemas, instead, recommends to wrap schemas in some other structures, which is not suitable for the purposes of `express-zod-api`. There are many small inconvenient things in making custom schema classes, that I'd like to replace into native methods, and use `withMeta` wrapper for storing proprietary identifier, so the generators and walkers could still handle it. Related issues: ``` colinhacks/zod#1718 colinhacks/zod#2413 colinhacks/zod#273 colinhacks/zod#71 colinhacks/zod#37 ``` PR I've been waiting for months to merged (programmatically distinguishable branding): ``` colinhacks/zod#2860 ```
|
The fact that the type-only If you need this for your own purposes, Zod 4's plugin system will let you hack this a bit by adding another overload to |
RobinTail
added a commit
to RobinTail/express-zod-api
that referenced
this pull request
May 3, 2024
RobinTail
added a commit
to RobinTail/express-zod-api
that referenced
this pull request
May 3, 2024
Can not express my disappointment in this regard. colinhacks/zod#2860 (comment)
|
@colinhacks What do you think about allowing to put "unique symbol" from a user space code? |
RobinTail
added a commit
to RobinTail/express-zod-api
that referenced
this pull request
May 9, 2024
Due to #1721, colinhacks/zod#2860 (comment), and #1719 I'm exploring the possibility to alter the behaviour of `.brand()` for storing the `brand` property as a way to distinguish the proprietary schemas in runtime. This can replace the `proprietary()` function with a call of `.brand()`. However, so far it turned out to be breaking because `ZodBranded` does not expose the methods of the wrapped schema, such as `.extend()`, which is used in `accept-raw.ts` endpoint for possible route params. —— After a series of serious considerations I realized that exposing brand to consumers of `express-zod-api` could be a beneficial feature. Runtime brand can be accessed via `._def[Symbol.for("express-zod-api")].brand`
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.
Make brand available at runtime when used as a parameter for .brand()
With this brand() can be used to enable external code to operate on types based on definition.
Typing is left as-is to be backwards-compatible so instead of overriding the BRAND symbol this just puts the brand parameter of the constructor in _def.
Let me know what you think! 🙂