@forinda/kickjs-db

KickJS-native ORM — code-first schema, reversible migrations, multi-dialect SQL.

Phantom-typed column builders, SchemaToKysely<S> for end-to-end row inference, KickDbRegister module augmentation, runtime lifecycle hooks (query / queryError / slowQuery), customType mapper, pgEnum with full migration pipeline, and db.$extends({ model }) per-table methods.

Install

pnpm add @forinda/kickjs-db
pnpm add @forinda/kickjs-db-pg pg          # PostgreSQL adapter

Quick start

import { table, uuid, varchar, timestamp, createDbClient } from '@forinda/kickjs-db'
import { pgAdapter, pgDialect } from '@forinda/kickjs-db-pg'
import { Pool } from 'pg'

// 1. Schema — phantom T flows through every column automatically.
const users = table('users', {
  id: uuid().primaryKey().defaultRandom(),
  email: varchar(255).notNull().unique(),
  createdAt: timestamp().notNull().defaultNow(),
})

const schema = { users }
const pool = new Pool({ connectionString: process.env.DATABASE_URL })

// 2. Client — DB shape inferred from schema, no manual generic.
const db = createDbClient({
  schema,
  dialect: pgDialect({ pool }),
  events: true,
  slowQueryThresholdMs: 100,
})

db.on('slowQuery', ({ sql, durationMs }) => {
  console.warn({ sql, durationMs }, 'slow query')
})

// 3. Query — fully typed against the schema.
const row = await db
  .selectFrom('users')
  .selectAll()
  .where('email', '=', '[email protected]')
  .executeTakeFirst()
//  row?.email is string; row?.createdAt is Date

Docs

• Schema Types — phantom inference, KickDbRegister, self-references, pgEnum
• DB Extensions — customType<T>(), $extends({ model })
• Type Generation — kick typegen plugin contract + kick/db auto-emit

Companion packages

• @forinda/kickjs-db-pg — node-postgres adapter
• @forinda/kickjs — framework runtime + DI container
• @forinda/kickjs-cli — kick db generate, kick db migrate, kick typegen

License

MIT © Felix Orinda