Comments (3)
@MatanYadaev Hi,
Is there a way to make a schema of JSON schema with TypeBox?
Yes, partially. However you may run into some challenges adequately expressing both the Json Schema specification while retaining type inference (as schematics can get recursive). This said, The following sets up a few Json Schema types and shows the Recursive / Generic pattern self referential schematics.
import { Type, TSchema, Static } from '@sinclair/typebox'
import { Value } from '@sinclair/typebox/value'
export const AnyOf = <T extends TSchema>(This: T) => Type.Object({
anyOf: Type.Array(This)
})
export const AllOf = <T extends TSchema>(This: T) => Type.Object({
allOf: Type.Array(This)
})
export const Object = <T extends TSchema>(This: T) => Type.Object({
type: Type.Literal('object'),
properties: Type.Record(Type.String(), This),
required: Type.Array(Type.String())
})
export const Array = <T extends TSchema>(This: T) => Type.Object({
type: Type.Literal('array'),
items: This
})
export const String = Type.Object({ type: Type.Literal('string') })
export const Number = Type.Object({ type: Type.Literal('number') })
export const Boolean = Type.Object({ type: Type.Literal('boolean') })
export const Null = Type.Object({ type: Type.Literal('null') })
export type Schema = Static<typeof Schema>
export const Schema = Type.Recursive(This => Type.Union([
AllOf(This),
AnyOf(This),
Object(This),
Array(This),
String,
Number,
Boolean,
Null
]), { $id: 'Schema' })
// some tests
console.log(Schema)
console.log(Value.Check(Schema, { type: 'null' }))
console.log(Value.Check(Schema, { type: 'string' }))
console.log(Value.Check(Schema, { type: 'object', properties: {
x: { type: 'number' }
}, required: ['x'] }))
Hope this helps
S
from typebox.
Thanks @sinclairzx81 for the quick reply.
from typebox.
Thank you @sinclairzx81
Creating JSON Schema of JSON Schema in TypeBox feels quite meta and powerful :)
from typebox.
Related Issues (20)
- Regression bug 0.32.19 HOT 2
- TypeGuard.IsEnum HOT 2
- Better pre-validation errors for invalid TypeBox schema HOT 2
- Static resolution is not working as expected when using a generic function to generate a schema HOT 3
- tsconfig "strict": true - ignore modifiers HOT 2
- `Static` types cannot be used to enforce types from a generic parameter HOT 3
- Applying refinements + general advice on my implementation HOT 11
- Unable to create value of custom class type HOT 2
- Migrate to regexp vs string type in pattern HOT 4
- feedback on Refinement API HOT 2
- Type.Date() cause errors with fastify and querybuilder returning type Date HOT 2
- Should coerce type to array HOT 2
- Interconnected interfaces, missing type annotations and maximum length exceeded. HOT 2
- Optimisations to inference in 0.32 seems to cause `ts(2589)` with composite types. HOT 16
- Add trim option to Type.String() HOT 1
- Should add option to remove redundant prop in Convert() HOT 1
- Metadata missing in custom types HOT 2
- Utility type inference appears missing or broken HOT 2
- How to express function optional parameter? HOT 5
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 typebox.