drizzle-typebox is a plugin for Drizzle ORM that allows you to generate @sinclair/typebox schemas from Drizzle ORM schemas.

Features

• Create a select schema for tables, views and enums.
• Create insert and update schemas for tables.
• Supports all dialects: PostgreSQL, MySQL and SQLite.

Usage

1import { pgEnum, pgTable, serial, text, timestamp } from 'drizzle-orm/pg-core';
2import { createInsertSchema, createSelectSchema } from 'drizzle-typebox';
3import { Type } from '@sinclair/typebox';
4import { Value } from '@sinclair/typebox/value';
5
6const users = pgTable('users', {
7	id: serial('id').primaryKey(),
8	name: text('name').notNull(),
9	email: text('email').notNull(),
10	role: text('role', { enum: ['admin', 'user'] }).notNull(),
11	createdAt: timestamp('created_at').notNull().defaultNow(),
12});
13
14// Schema for inserting a user - can be used to validate API requests
15const insertUserSchema = createInsertSchema(users);
16
17// Schema for updating a user - can be used to validate API requests
18const updateUserSchema = createUpdateSchema(users);
19
20// Schema for selecting a user - can be used to validate API responses
21const selectUserSchema = createSelectSchema(users);
22
23// Overriding the fields
24const insertUserSchema = createInsertSchema(users, {
25	role: Type.String(),
26});
27
28// Refining the fields - useful if you want to change the fields before they become nullable/optional in the final schema
29const insertUserSchema = createInsertSchema(users, {
30	id: (schema) => Type.Number({ ...schema, minimum: 0 }),
31	role: Type.String(),
32});
33
34// Usage
35
36const isUserValid: boolean = Value.Check(insertUserSchema, {
37	name: 'John Doe',
38	email: 'johndoe@test.com',
39	role: 'admin',
40});