chore: wip

Author: glennmichael123

README.md

@@ -28,7 +28,13 @@ Define your data model once and get a type-safe query experience _(a la Kysely/L
 
 ## Get Started
 
-Install and use in code:
+### Installation
+
+```bash
+bun add bun-query-builder
+```
+
+### Usage
 
 ```ts
 import { buildDatabaseSchema, buildSchemaMeta, createQueryBuilder } from 'bun-query-builder'
@@ -52,6 +58,24 @@ const q = db
 const rows = await q.execute()
 ```
 
+## Migrations
+
+Generate and execute migrations from your models:
+
+```ts
+import { generateMigration, executeMigration } from 'bun-query-builder'
+
+// Generate migration from models directory
+const migration = await generateMigration('./models', { 
+  dialect: 'postgres', 
+  apply: true, 
+  full: true 
+})
+
+// Execute the migration
+await executeMigration(migration)
+```
+
 ### CLI
 
 ```bash

bin/cli.ts

@@ -1,14 +1,11 @@
+import type { CliOption, FileOptions, MigrateOptions, SqlOptions, UnsafeOptions } from '../src/types'
 import { CAC } from 'cac'
 import { version } from '../package.json'
 import { explain, file, introspect, ping, sql, unsafe, waitReady } from '../src/actions'
 import { generateMigration } from '../src/actions/migrate'
 
 const cli = new CAC('query-builder')
 
-interface CliOption {
-  verbose: boolean
-}
-
 cli
   .command('introspect <dir>', 'Load models and print inferred schema')
   .option('--verbose', 'Enable verbose logging')
@@ -21,7 +18,7 @@ cli
   .command('sql <dir> <table>', 'Build a sample query for a table')
   .option('--limit <n>', 'Limit rows', { default: 10 })
   .example('query-builder sql ./app/Models users --limit 5')
-  .action(async (dir: string, table: string, opts: any) => {
+  .action(async (dir: string, table: string, opts: SqlOptions) => {
     await sql(dir, table, opts)
   })
 
@@ -51,7 +48,7 @@ cli
   .command('unsafe <sql>', 'Execute an unsafe SQL string (one statement with params)')
   .option('--params <json>', 'JSON array of parameters')
   .example('query-builder unsafe "SELECT * FROM users WHERE id = $1" --params "[1]"')
-  .action(async (sql: string, opts: any) => {
+  .action(async (sql: string, opts: UnsafeOptions) => {
     await unsafe(sql, opts)
   })
 
@@ -60,7 +57,7 @@ cli
   .option('--params <json>', 'JSON array of parameters')
   .example('query-builder file ./migrations/seed.sql')
   .example('query-builder file ./reports/top.sql --params "[30]"')
-  .action(async (path: string, opts: any) => {
+  .action(async (path: string, opts: FileOptions) => {
     await file(path, opts)
   })
 
@@ -71,7 +68,7 @@ cli
   .option('--apply', 'Execute the generated SQL against the database')
   .option('--full', 'Force full migration SQL instead of incremental diff')
   .example('query-builder migrate ./app/Models --dialect postgres')
-  .action(async (dir: string, opts: any) => {
+  .action(async (dir: string, opts: MigrateOptions) => {
     try {
       await generateMigration(dir, {
         dialect: opts.dialect,

examples/test-queries.ts

@@ -30,11 +30,7 @@ async function basicSelectQuery() {
 async function simpleMigration() {
   const migration = await generateMigration('./models', { dialect: 'postgres', apply: true, full: true })
 
-  const sqlScript = migration.sqlStatements
-
-  console.log(sqlScript)
-
-  await executeMigration(sqlScript)
+  await executeMigration(migration)
 }
 
 // Export for use in other files

src/actions/file.ts

@@ -1,9 +1,6 @@
+import type { FileOptions } from '../types'
 import { createQueryBuilder } from '../index'
 
-export interface FileOptions {
-  params?: string
-}
-
 export async function file(path: string, opts: FileOptions = {}) {
   const qb = createQueryBuilder()
   const params = opts.params ? JSON.parse(opts.params) : undefined

src/actions/introspect.ts

@@ -1,8 +1,6 @@
-import { buildDatabaseSchema, loadModels } from '../index'
+import type { IntrospectOptions } from '../types'
 
-export interface IntrospectOptions {
-  verbose?: boolean
-}
+import { buildDatabaseSchema, loadModels } from '../index'
 
 export async function introspect(dir: string, _opts: IntrospectOptions = {}) {
   const models = await loadModels({ modelsDir: dir })

src/actions/migrate.ts

@@ -1,24 +1,10 @@
-import type { SupportedDialect } from '../types'
+import type { GenerateMigrationResult, MigrateOptions, SupportedDialect } from '../types'
 import { sql as bunSql } from 'bun'
 import { existsSync, mkdtempSync, readFileSync, writeFileSync } from 'node:fs'
 import { tmpdir } from 'node:os'
 import { join } from 'node:path'
 import { buildMigrationPlan, createQueryBuilder, generateDiffSql, generateSql, hashMigrationPlan, loadModels } from '../'
 
-export interface MigrateOptions {
-  dialect?: SupportedDialect
-  state?: string
-  apply?: boolean
-  full?: boolean
-}
-
-export interface GenerateMigrationResult {
-  sql: string
-  sqlStatements: string[]
-  hasChanges: boolean
-  plan: any
-}
-
 export async function generateMigration(dir: string, opts: MigrateOptions = {}): Promise<GenerateMigrationResult> {
   const dialect = String(opts.dialect || 'postgres') as SupportedDialect
   const models = await loadModels({ modelsDir: dir })
@@ -69,7 +55,9 @@ export async function generateMigration(dir: string, opts: MigrateOptions = {}):
   return { sql, sqlStatements, hasChanges, plan }
 }
 
-export async function executeMigration(sqlStatements: string[]): Promise<boolean> {
+export async function executeMigration(migration: GenerateMigrationResult): Promise<boolean> {
+  const { sqlStatements } = migration
+
   try {
     for (const sql of sqlStatements) {
       // Use raw SQL execution instead of template literal to avoid parameter binding issues

src/actions/sql.ts

@@ -1,10 +1,7 @@
+import type { SqlOptions } from '../types'
 import { config } from '../config'
 import { buildDatabaseSchema, createQueryBuilder, loadModels } from '../index'
 
-export interface SqlOptions {
-  limit?: number
-}
-
 export function sql(dir: string, table: string, opts: SqlOptions = {}) {
   const models = loadModels({ modelsDir: dir })
   const dbSchema = buildDatabaseSchema(models)

src/actions/unsafe.ts

@@ -1,9 +1,6 @@
+import type { UnsafeOptions } from '../types'
 import { createQueryBuilder } from '../index'
 
-export interface UnsafeOptions {
-  params?: string
-}
-
 export async function unsafe(sql: string, opts: UnsafeOptions = {}) {
   const qb = createQueryBuilder()
   const params = opts.params ? JSON.parse(opts.params) : undefined

src/actions/wait-ready.ts

@@ -1,10 +1,6 @@
+import type { WaitReadyOptions } from '../types'
 import { createQueryBuilder } from '../index'
 
-export interface WaitReadyOptions {
-  attempts?: number
-  delay?: number
-}
-
 export async function waitReady(opts: WaitReadyOptions = {}) {
   const attempts = Number(opts.attempts || 10)
   const delayMs = Number(opts.delay || 100)

src/index.ts

@@ -1,3 +1,4 @@
+export * from './actions'
 export * from './client'
 export * from './config'
 export * from './factory'