sinclairzx81
commented
11 months ago @danecando Hi,
This is a somewhat known issue when composing Unsafe with some of TypeBox's more complex types (specifically Composite and Index). The problem relates to a need to check that the internal schematics being composited are valid, and Unsafe types are considered to be invalid unless they meet the following criteria.
- The Unsafe type has a unique
[Kind]symbol that is distinct from the built in types - The Unsafe type is registered with the TypeRegistry.
The following are 3 options you can try
Option 1: Rename Kind and Register on TypeRegistry
The following renames the Kind from Date to UnsafeDate to avoid conflicts with Type.Date(). This type is then registered on the TypeRegistry which allows the Unsafe type to pass Composite type validation checks. You can optionally implement the callback to also have TypeBox check values of UnsafeDate.
See here for documentation on the TypeRegistry.
import { Type, TypeRegistry } from '@sinclair/typebox'
TypeRegistry.Set('UnsafeDate', () => true) // required
export const userSchema = createSelectSchema(users, {
lastLoggedIn: Type.Unsafe<Date>({ [Kind]: "UnsafeDate" }),
createdAt: Type.Unsafe<Date>({ [Kind]: "UnsafeDate" }),
updatedAt: Type.Unsafe<Date>({ [Kind]: "UnsafeDate" }),
});
export const userRecordSchema = Type.Composite([userSchema, relationsSchema]); // should be okOption 2: Use Intersect instead of Composite
You can use Type.Intersect instead of Type.Composite as both return the same semantic type. Intersect is able to avoid the is-valid check as it does not need to evaluate interior types to produce a the singular object type. The downside however is that the schematics will be represented with the Json Schema allOf keyword.
import { Type } from '@sinclair/typebox'
export const userSchema = createSelectSchema(users, {
lastLoggedIn: Type.Unsafe<Date>({ [Kind]: "UnsafeDate" }),
createdAt: Type.Unsafe<Date>({ [Kind]: "UnsafeDate" }),
updatedAt: Type.Unsafe<Date>({ [Kind]: "UnsafeDate" }),
});
export const userRecordSchema = Type.Intersect([userSchema, relationsSchema]); // should be okOption 3: Cast Known Type in Unsafe
You can use Unsafe to cast a known type. This might be the most appropriate (and simplest) option if you're using Fastify. With this approach, you don't need to register the Unsafe type on the TypeRegistry as the interior type String is a known built in type.
import { Type } from '@sinclair/typebox'
export const userSchema = createSelectSchema(users, {
lastLoggedIn: Type.Unsafe<Date>(Type.String({ format: 'date-time' })),
createdAt: Type.Unsafe<Date>(Type.String({ format: 'date-time' })),
updatedAt: Type.Unsafe<Date>(Type.String({ format: 'date-time' })),
});
export const userRecordSchema = Type.Composite([userSchema, relationsSchema]); // should be okConsiderations
As per https://github.com/fastify/fastify/discussions/3357#discussioncomment-4241449, there is some complexity with handling string encoded dates and having them reflect back as actual JavaScript Date objects. I don't believe Fastify will automatically convert iso date strings into Date objects for you, so the value you will see in the route for the above types will be Date, but the actual value will be of type string. Just be a bit mindful of this aspect.
Hope this helps S
danecando
When using
Type.Unsafe<Date>({ [Kind]: "Date" })in an object to represent a datehttps://github.com/fastify/fastify/discussions/3357#discussioncomment-4241449
It works fine until I try to combine another object with
Type.CompositeFor context the createSchema functions is generating typebox schemas from a drizzle db schema, the object that is the second arg allows for overriding fields
Types
Logs
Types
Logs