generate
migrate
push
pull
check
up
studio
drizzle-typebox is a plugin for Drizzle ORM that allows you to generate Typebox schemas from Drizzle ORM schemas.
drizzle-typebox
npm i drizzle-typebox
yarn add drizzle-typebox
pnpm add drizzle-typebox
bun add drizzle-typebox
import { pgEnum, pgTable, serial, text, timestamp } from 'drizzle-orm/pg-core'; import { createInsertSchema, createSelectSchema } from 'drizzle-typebox'; import { Type } from '@sinclair/typebox'; import { Value } from '@sinclair/typebox/value'; const users = pgTable('users', { id: serial('id').primaryKey(), name: text('name').notNull(), email: text('email').notNull(), role: text('role', { enum: ['admin', 'user'] }).notNull(), createdAt: timestamp('created_at').notNull().defaultNow(), }); // Schema for inserting a user - can be used to validate API requests const insertUserSchema = createInsertSchema(users); // Schema for selecting a user - can be used to validate API responses const selectUserSchema = createSelectSchema(users); // Overriding the fields const insertUserSchema = createInsertSchema(users, { role: Type.String(), }); // Refining the fields - useful if you want to change the fields before they become nullable/optional in the final schema const insertUserSchema = createInsertSchema(users, { id: (schema) => Type.Number({ minimum: 0 }), role: Type.String(), }); // Usage const isUserValid: boolean = Value.Check(insertUserSchema, { name: 'John Doe', email: '[email protected]', role: 'admin', });