Complete zod plugin with proprietary brands
#1730
Merged
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
RobinTail
added
enhancement
RobinTail
commented
May 5, 2024
RobinTail
commented
May 5, 2024
|
At the moment, despite the beauty of it, I'm thinking that it's not needed to be a part of consumer's API, so it can be kept as an internal method for a while. At least until I come up with something better for |
|
UPDATE on raw / extending shape issue: |
RobinTail
force-pushed
the
exp-proprietary-brands
branch
from
037147d
to
5453ff9
Compare
Merged
|
I realized that this can actually be a feature for those who may need it as much as I am. |
RobinTail
commented
May 9, 2024
RobinTail
changed the title
RobinTail
force-pushed
the
exp-proprietary-brands
branch
from
78a517b
to
4730811
Compare
RobinTail
changed the title
zod plugin with proprietary brands
…or('express-zod-api')] - if needed (compromise for keeping it simpler).
RobinTail
added a commit
that referenced
this pull request
May 13, 2024
 Pebbles LaDime (Dime) Doe was a black transgender woman. https://edition.cnn.com/2024/02/25/us/dime-doe-trial-south-carolina-federal-hate-crime/index.html https://www.nbcnews.com/feature/nbc-out/south-carolina-death-marks-14th-black-transgender-woman-killed-u-n1040971 https://www.justice.gov/opa/pr/south-carolina-man-found-guilty-hate-crime-killing-transgender-woman-because-her-gender Transgender women suffer too frequently from transphobic violence and cruelty, being the less protected social group. I'd like to raise an awareness of this problem. Humans should be creators — not killers. But most importantly, I want every transgender girl to have an opportunity to create applications quickly and, in general, learn to write code easily in order to receive job offers and leave dangerously transphobic territories for more favorable and civilized ones, and live happily there. Protect transgender women. ------------------------------ This version is focused on making `express-zod-api` a complete `zod` plugin. In this regard `withMeta` is removed in favor of the recommended approach on extending `zod` functionality, which opens up opportunities for new features and simplifies the consumer experience. Another improvement has been made for parsers: they are now applied selectively depending on the type of expected request. - #1693 - #1705 - #1707 - Theoretically #1631 - In advance #1708 - #1726 - #1736 - #1741 - #1745 - #1762 - #1756 - #1766 - #1730 - #1747 - #1748 - #1755 - #1760 - Not included, but comes later: #1750⚠️ don't squash it, to avoid conflicts with #1750
RobinTail
added a commit
that referenced
this pull request
May 14, 2024
…#1750) Based on #1470 and thanks to #1730 This will be a feature in v19. I'd like to keep changes of 19.0.0 smaller, making it easier to migrate. Thus, I'm going to separate breaking changes from features and release this as 19.1.0. This will be the interface: ```ts import { z } from "zod"; import { Documentation, Integration } from "express-zod-api"; const myBrand = Symbol("MamaToldMeImSpecial"); // I highly recommend using symbols for this purpose const myBrandedSchema = z.string().brand(myBrand); new Documentation({ /* config, routing, title, version */ brandHandling: { [myBrand]: ( schema: typeof myBrandedSchema, // you should assign type yourself { next, path, method, isResponse }, // handle a nested schema using next() ) => { const defaultResult = next(schema.unwrap()); // { type: string } return { summary: "Special type of data" }; }, }, }); import ts from "typescript"; const { factory: f } = ts; new Integration({ /* routing */ brandHandling: { [myBrand]: ( schema: typeof myBrandedSchema, // you should assign type yourself { next, isResponse, serializer }, // handle a nested schema using next() ) => f.createKeywordTypeNode(ts.SyntaxKind.BooleanKeyword), }, }); ```
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.
Due to #1721, colinhacks/zod#2860 (comment), and #1719 I'm exploring the possibility to alter the behaviour of
.brand()for storing thebrandproperty 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
ZodBrandeddoes not expose the methods of the wrapped schema, such as.extend(), which is used inaccept-raw.tsendpoint for possible route params.——
After a series of serious considerations I realized that exposing brand to consumers of
express-zod-apicould be a beneficial feature.Runtime brand can be accessed via
._def[Symbol.for("express-zod-api")].brand