Comments (3)
pkuczynski
commented on July 20, 2024
As mentioned earlier, I tried with Type.Intersect instead of Type.Composite:
const query = Type.Intersect([
pagination,
Type.Union([
Type.Object({
categoryId: Type.Number()
}),
Type.Object({
name: Type.String()
})
])Which compiles well, TS works well, but then ajv fails validation:
query = { categoryId: 10 }
must have required property 'name'
must match a schema in anyOf
from typebox.
sinclairzx81
commented on July 20, 2024
@pkuczynski Hi,
This is a known limitation that should be resolved in future revisions. You can work around this limitation by authoring the types slightly differently. As follows.
import { Type, Static } from '@sinclair/typebox'
const Pagination = Type.Object({
page: Type.Optional(Type.Number({ minimum: 1, default: 1 })),
size: Type.Optional(Type.Number({ minimum: 1, default: 10 })),
})
const PaginationWithName = Type.Composite([Pagination, Type.Object({
name: Type.String()
})])
const PaginationWithCategoryId = Type.Composite([Pagination, Type.Object({
categoryId: Type.Number()
})])
type Query = Static<typeof Query>
const Query = Type.Union([
PaginationWithName,
PaginationWithCategoryId
])What I was expecting to get as a JSON schema is (as in this example):
Unfortunately, the combination of object and anyOf (mixed as a singular schema as per your code snippet) falls outside the documented schematics generated by TypeBox. The preferred solution would be to have TypeBox automatically transform the schematics into the Query structure shown above. This would be analogous to the following TypeScript example.
interface Pagination {
page?: number
size?: number
}
// this is the shape you're asking to create
type Query = Pagination & (
{ name: string } |
{ categoryId: number }
)
// this is the shape typebox evaluates with Composite
type NonDistributedQuery = { [K in keyof Query]: Query[K] } // hover
// this is what typebox needs to do
type Evaluate<T> = { [K in keyof T]: T[K] } & {}
type DistributedQuery = Evaluate<Query> // hoverAbove, the Evaluate<T> type will be added to TypeBox specifically for this case. The Evaluate function will take care of transforming the Intersect/Union into the flattened type DistributedUnion above. Unfortunately, this type isn't ready yet, so you will need to refactor the types shown in the previous example in the meantime.
Hope this helps
S
from typebox.
sinclairzx81
commented on July 20, 2024
@pkuczynski Hi,
Might close up this issue for now as this issue is non-actionable on the current revision. In the interim, would recommend refactoring the types as follows.
import { Type, Static } from '@sinclair/typebox'
const Pagination = Type.Object({
page: Type.Optional(Type.Number({ minimum: 1, default: 1 })),
size: Type.Optional(Type.Number({ minimum: 1, default: 10 })),
})
const PaginationWithName = Type.Composite([Pagination, Type.Object({
name: Type.String()
})])
const PaginationWithCategoryId = Type.Composite([Pagination, Type.Object({
categoryId: Type.Number()
})])
type Query = Static<typeof Query>
const Query = Type.Union([
PaginationWithName,
PaginationWithCategoryId
])If you have any follow up questions on the above, feel free to reply on this thread.
All the best!
S
from typebox.
Related Issues (20)
- Support for `definitions`? HOT 1
- Cannot reference a recursive type HOT 7
- Cannot use .map() inside Union with Literal HOT 2
- Nested `Type.Intersect` Errors HOT 1
- Incorrect inferred type for the empty object `Type.Object({})`. HOT 3
- `unevaluatedProperties` failed verification when combined with `Type.Intersect` and `Type.Union` HOT 2
- Types for both CJS and ESM cause ambiguity and prevent correct type resolution. HOT 8
- unique id for schemas generated with Type.Object() HOT 6
- Custom paths for custom validation errors HOT 2
- Type.Recursive does not work with Type.Transform for StaticDecode
- Issue regarding nested objects when using Value.Default HOT 5
- Enum type inferred as never when using Type.Mapped() HOT 2
- Should `IsValueType` guard consider `Date`? HOT 1
- ESNext target HOT 3
- Trying to do codegen from Drizzle schemas HOT 1
- Make `default` and `examples` schema options properties type-safe HOT 2
- Indicate which files don't have "sideEffects" in package.json for improved tree shaking HOT 3
- Type.String().Optional() is accepted on ts-hint / ts-lint, and even build successfully; but of course, "Optional()" does not exists HOT 2
- Dynamic Template Literals can't be Mapped 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 typebox.