Comments (3)
This one's a little trickier than you'd initially expect. Whether or not a property with a default value should be required or not basically comes down to which JSON Schema validator you use. The only single source of truth that I know of comes from the other side of the equation - Zod itself.
import { z } from "zod";
const schema = z.object({ requiredProperty: z.string().default("some value") });
type Input = z.input<typeof schema> // { requiredProperty?: string | undefined }
type Output = z.output<typeof schema> // { requiredProperty: string }
const data = schema.parse({}) // This is fine
console.log(data); // { requiredProperty: "some value" }
Due to design decisions made for the Zod API we can't target the output type (aka infer), only the input type.
Unless there is a part of the JSON Schema specification (which I may well have missed) that defines this behavior conclusively I'm leaning towards keeping it as is.
from zod-to-json-schema.
Ok, and with Superforms targeting the output type is the primary thing, or at least has been for version 1. But I'll take this into consideration for sure, thank you. Would it still be possible to add it as an option, even though you're focusing on the input type? If it's too much work or goes against your design, no problem.
from zod-to-json-schema.
Well, Zod allows chaining transformational functions into the schemas that affect the output type, and those obviously can't be serialized. So it's not really up to me unfortunately :/
However, if you wanted to really target this specific use-case, you could rebuild the way optionality is checked in the object parser and add an option to ignore default values there. I'd be open to a PR for it. I might even take a stab at it myself at some point but I'm not making any promises.
from zod-to-json-schema.
Related Issues (20)
- OpenAPI fix for a nullable ref using allOf HOT 2
- Type definition misconfigured HOT 1
- All fields are getting added to required HOT 1
- When zod specifies z.date(), type is converted to date-time rather than date HOT 2
- Date fields accepted by zod schema are not accepted by JSON schema generated from it HOT 4
- Circular Dependency HOT 3
- Would it be possible to retain branded types? HOT 3
- String regex-pattern flags are discarded during conversion HOT 3
- 3.23.0 is missing a changelog entry HOT 1
- Circular dependencies? HOT 7
- How to validate a ReadableStream response? HOT 3
- Add title property of JSON Schema from zod definitions HOT 3
- Schema refs are assigned regardless of `.describe()` calls HOT 3
- Certain schemas to define a record's keys are discarded HOT 1
- Is it possible to force a normalized output ? HOT 5
- SyntaxError: Invalid RegExp: Invalid escape, js engine: hermes HOT 3
- `z.Date()` resolves to a `string` type with a `date-time` check HOT 2
- The `coerce` config is lost during conversion HOT 2
- Emoji regex is not supported in some environments HOT 2
- Cleaner way of turning zod objects to json schema with Typescript support HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from zod-to-json-schema.