bun-query-builder 0.1.7 → 0.1.9

package/dist/actions/benchmark.d.ts

@@ -1,12 +1,8 @@
+/**
+ * Run performance benchmarks
+ */
+export declare function runBenchmark(options?: BenchmarkOptions): Promise<void>;
 export declare interface BenchmarkOptions {
   operations?: string
   iterations?: number
-}
-declare interface BenchmarkResult {
-  operation: string
-  avgTime: number
-  minTime: number
-  maxTime: number
-  iterations: number
-}
-export declare function runBenchmark(options: BenchmarkOptions = {}): Promise<void>;
+}

package/dist/actions/cache.d.ts

@@ -1,6 +1,18 @@
+/**
+ * Clear the query cache
+ */
 export declare function cacheClear(): Promise<void>;
+/**
+ * Show cache statistics and configuration
+ *
+ * Note: The current cache implementation doesn't track detailed statistics.
+ * This command shows the current configuration.
+ */
 export declare function cacheStats(): Promise<void>;
+/**
+ * Configure query cache settings
+ */
+export declare function cacheConfig(options?: CacheConfigOptions): Promise<void>;
 export declare interface CacheConfigOptions {
   size?: number
-}
-export declare function cacheConfig(options: CacheConfigOptions = {}): Promise<void>;
+}

package/dist/actions/console.d.ts

@@ -1,2 +1,8 @@
+/**
+ * Start an interactive REPL for running queries
+ */
 export declare function startConsole(): Promise<void>;
+/**
+ * Tinker - alias for startConsole
+ */
 export declare function tinker(): Promise<void>;

package/dist/actions/data.d.ts

@@ -1,3 +1,15 @@
+/**
+ * Export data from a table
+ */
+export declare function exportData(tableName: string, options?: ExportOptions): Promise<void>;
+/**
+ * Import data into a table
+ */
+export declare function importData(tableName: string, filePath: string, options?: ImportOptions): Promise<void>;
+/**
+ * Dump database or specific tables to SQL
+ */
+export declare function dumpDatabase(options?: DumpOptions): Promise<void>;
 export declare interface ExportOptions {
   format?: 'json' | 'csv' | 'sql'
   output?: string
@@ -10,6 +22,4 @@ export declare interface ImportOptions {
 export declare interface DumpOptions {
   tables?: string
   output?: string
-}
-export declare function exportData(tableName: string, options: ExportOptions = {}): Promise<void>;
-export declare function importData(tableName: string, filePath: string, options: ImportOptions = {}): Promise<void>;
+}

package/dist/actions/db-info.d.ts

@@ -1,5 +1,12 @@
 import type { SupportedDialect } from '@/types';
-
+/**
+ * Get database information and statistics
+ */
+export declare function dbInfo(): Promise<DatabaseInfo>;
+/**
+ * Get database statistics (alias for dbInfo)
+ */
+export declare function dbStats(): Promise<DatabaseInfo>;
 export declare interface TableInfo {
   name: string
   rowCount: number
@@ -12,6 +19,4 @@ export declare interface DatabaseInfo {
   tables: TableInfo[]
   totalTables: number
   totalRows: number
-}
-export declare function dbInfo(): Promise<DatabaseInfo>;
-export declare function dbStats(): Promise<DatabaseInfo>;
+}

package/dist/actions/db-optimize.d.ts

@@ -1,11 +1,12 @@
 import type { SupportedDialect } from '@/types';
-
+/**
+ * Optimize database tables (VACUUM, ANALYZE, OPTIMIZE)
+ */
+export declare function dbOptimize(options?: OptimizeOptions): Promise<void>;
 export declare interface OptimizeOptions {
   dialect?: SupportedDialect
   aggressive?: boolean
   tables?: string[]
   verbose?: boolean
 }
-export declare function dbOptimize(options: OptimizeOptions = {}): Promise<void>;
-
-export { dbOptimize as optimizeDatabase }
+export { dbOptimize as optimizeDatabase };

package/dist/actions/db-wipe.d.ts

@@ -1,10 +1,11 @@
 import type { SupportedDialect } from '@/types';
-
+/**
+ * Drop all tables in the database
+ */
+export declare function dbWipe(options?: WipeOptions): Promise<void>;
 export declare interface WipeOptions {
   dialect?: SupportedDialect
   force?: boolean
   verbose?: boolean
 }
-export declare function dbWipe(options: WipeOptions = {}): Promise<void>;
-
-export { dbWipe as wipeDatabase }
+export { dbWipe as wipeDatabase };

package/dist/actions/file.d.ts

@@ -1,3 +1,2 @@
 import type { FileOptions } from '../types';
-
-export declare function file(path: string, opts: FileOptions = {}): void;
+export declare function file(path: string, opts?: FileOptions): void;

package/dist/actions/index.d.ts

@@ -1,25 +1,25 @@
-export { runBenchmark } from './benchmark'
-export { cacheClear, cacheConfig, cacheStats } from './cache'
-export { startConsole, tinker } from './console'
-export { dumpDatabase, exportData, importData } from './data'
-export { dbInfo, dbStats } from './db-info'
-export { dbOptimize, optimizeDatabase } from './db-optimize'
-export { dbWipe, wipeDatabase } from './db-wipe'
-export { explain } from './explain'
-export { file } from './file'
-export { inspectTable, tableInfo } from './inspect'
-export { introspect } from './introspect'
-export { makeModel } from './make-model'
-export { executeMigration, generateMigration, resetDatabase } from './migrate'
-export { migrateGenerate } from './migrate-generate'
-export { migrateRollback } from './migrate-rollback'
-export { migrateList, migrateStatus } from './migrate-status'
-export { modelShow, showModel } from './model-show'
-export { ping } from './ping'
-export { explainAllQueries, queryExplainAll } from './query-explain-all'
-export { generateDiagram, relationDiagram } from './relation-diagram'
-export { freshDatabase, makeSeeder, runSeeder, runSeeders } from './seed'
-export { sql } from './sql'
-export { unsafe } from './unsafe'
-export { checkSchema, validateSchema } from './validate'
-export { waitReady } from './wait-ready'
+export { runBenchmark } from './benchmark';
+export { cacheClear, cacheConfig, cacheStats } from './cache';
+export { startConsole, tinker } from './console';
+export { dumpDatabase, exportData, importData } from './data';
+export { dbInfo, dbStats } from './db-info';
+export { dbOptimize, optimizeDatabase } from './db-optimize';
+export { dbWipe, wipeDatabase } from './db-wipe';
+export { explain } from './explain';
+export { file } from './file';
+export { inspectTable, tableInfo } from './inspect';
+export { introspect } from './introspect';
+export { makeModel } from './make-model';
+export { executeMigration, generateMigration, resetDatabase } from './migrate';
+export { migrateGenerate } from './migrate-generate';
+export { migrateRollback } from './migrate-rollback';
+export { migrateList, migrateStatus } from './migrate-status';
+export { modelShow, showModel } from './model-show';
+export { ping } from './ping';
+export { explainAllQueries, queryExplainAll } from './query-explain-all';
+export { generateDiagram, relationDiagram } from './relation-diagram';
+export { freshDatabase, makeSeeder, runSeeder, runSeeders } from './seed';
+export { sql } from './sql';
+export { unsafe } from './unsafe';
+export { checkSchema, validateSchema } from './validate';
+export { waitReady } from './wait-ready';

package/dist/actions/inspect.d.ts

@@ -1,3 +1,11 @@
+/**
+ * Inspect a table's structure, indexes, and statistics
+ */
+export declare function inspectTable(tableName: string, options?: InspectOptions): Promise<TableInspection>;
+/**
+ * Alias for inspectTable
+ */
+export declare function tableInfo(tableName: string, options?: InspectOptions): Promise<TableInspection>;
 export declare interface ColumnInfo {
   name: string
   type: string
@@ -19,6 +27,4 @@ export declare interface TableInspection {
 }
 export declare interface InspectOptions {
   verbose?: boolean
-}
-export declare function inspectTable(tableName: string, options: InspectOptions = {}): Promise<TableInspection>;
-export declare function tableInfo(tableName: string, options: InspectOptions = {}): Promise<TableInspection>;
+}

package/dist/actions/introspect.d.ts

@@ -1,3 +1,2 @@
 import type { IntrospectOptions } from '../types';
-
-export declare function introspect(dir: string, _opts: IntrospectOptions = {}): void;
+export declare function introspect(dir: string, _opts?: IntrospectOptions): void;

package/dist/actions/make-model.d.ts

@@ -1,7 +1,9 @@
-declare function findWorkspaceRoot(startPath: string): string;
+/**
+ * Generate a new model file
+ */
+export declare function makeModel(name: string, options?: MakeModelOptions): Promise<void>;
 export declare interface MakeModelOptions {
   table?: string
   dir?: string
   timestamps?: boolean
-}
-export declare function makeModel(name: string, options: MakeModelOptions = {}): Promise<void>;
+}

package/dist/actions/migrate-generate.d.ts

@@ -1,5 +1,6 @@
 import type { GenerateMigrationResult, MigrateOptions } from '@/types';
-
-export declare function migrateGenerate(dir?: string, opts: MigrateOptions = {}): Promise<GenerateMigrationResult>;
-
-export { migrateGenerate as generateMigration }
+/**
+ * Generate migration files from model changes (alias for generateMigration)
+ */
+export declare function migrateGenerate(dir?: string, opts?: MigrateOptions): Promise<GenerateMigrationResult>;
+export { migrateGenerate as generateMigration };

package/dist/actions/migrate-rollback.d.ts

@@ -1,6 +1,13 @@
-declare function findWorkspaceRoot(startPath: string): string;
-declare function getSqlDirectory(workspaceRoot?: string): string;
+/**
+ * Rollback migrations
+ *
+ * Note: This removes migration entries from the migrations table.
+ * Since migrations are auto-generated from models, you should:
+ * 1. Revert your model changes
+ * 2. Run rollback to remove migration records
+ * 3. Generate fresh migrations
+ */
+export declare function migrateRollback(options?: RollbackOptions): Promise<void>;
 export declare interface RollbackOptions {
   steps?: number
-}
-export declare function migrateRollback(options: RollbackOptions = {}): Promise<void>;
+}

package/dist/actions/migrate-status.d.ts

@@ -1,9 +1,13 @@
-declare function findWorkspaceRoot(startPath: string): string;
-declare function getSqlDirectory(workspaceRoot?: string): string;
+/**
+ * Get migration status - shows which migrations have been executed and which are pending
+ */
+export declare function migrateStatus(): Promise<MigrationStatus[]>;
+/**
+ * List all migrations (alias for status)
+ */
+export declare function migrateList(): Promise<MigrationStatus[]>;
 export declare interface MigrationStatus {
   file: string
   status: 'executed' | 'pending' | 'transient'
   executedAt?: string
-}
-export declare function migrateStatus(): Promise<MigrationStatus[]>;
-export declare function migrateList(): Promise<MigrationStatus[]>;
+}

package/dist/actions/migrate.d.ts

@@ -1,13 +1,21 @@
-import type { GenerateMigrationResult, MigrateOptions, SupportedDialect } from '@/types';
-
-declare function getWorkspaceRoot(): string;
-declare function ensureSqlDirectory(workspaceRoot?: string): string;
-export declare function generateMigration(dir?: string, opts: MigrateOptions = {}): Promise<GenerateMigrationResult>;
+import type { GenerateMigrationResult, MigrateOptions } from '@/types';
+/**
+ * Generate migration files by comparing old models (from generated/) with new models (from source).
+ *
+ * Workflow:
+ * 1. Loads previous model state from the 'generated/' directory (old model copies)
+ * 2. Loads current models from the source directory
+ * 3. Compares both to detect all changes:
+ *    - Dropped tables, columns, indexes
+ *    - New tables, columns, indexes
+ *    - Modified columns (type changes, etc.)
+ * 4. Generates SQL migration files for all detected changes
+ * 5. Copies current models to 'generated/' for next comparison
+ *
+ * This follows Laravel's migration philosophy where model changes drive schema changes.
+ */
+export declare function generateMigration(dir?: string, opts?: MigrateOptions): Promise<GenerateMigrationResult>;
 export declare function executeMigration(dir?: string): Promise<boolean>;
-export declare function resetDatabase(dir?: string, opts: MigrateOptions = {}): Promise<boolean>;
-export declare function deleteMigrationFiles(dir?: string, workspaceRoot?: string, opts: MigrateOptions = {}): Promise<void>;
-export declare function copyModelsToGenerated(dir?: string, workspaceRoot?: string): Promise<void>;
-declare function getSqlDirectory(workspaceRoot?: string): string;
-declare function createMigrationsTable(qb: any, dialect: SupportedDialect): Promise<void>;
-declare function getExecutedMigrations(qb: any, dialect: SupportedDialect): Promise<string[]>;
-declare function recordMigration(qb: any, migrationFile: string, dialect: SupportedDialect): Promise<void>;
+export declare function resetDatabase(dir?: string, opts?: MigrateOptions): Promise<boolean>;
+export declare function deleteMigrationFiles(dir?: string, workspaceRoot?: string, opts?: MigrateOptions): Promise<void>;
+export declare function copyModelsToGenerated(dir?: string, workspaceRoot?: string): Promise<void>;

package/dist/actions/model-show.d.ts

@@ -1,3 +1,7 @@
+/**
+ * Show detailed information about a specific model
+ */
+export declare function modelShow(modelName: string, options?: ModelShowOptions): Promise<ModelDetails | void>;
 export declare interface ModelShowOptions {
   dir?: string
   verbose?: boolean
@@ -15,6 +19,4 @@ export declare interface ModelDetails {
   timestamps?: boolean
   softDeletes?: boolean
 }
-export declare function modelShow(modelName: string, options: ModelShowOptions = {}): Promise<ModelDetails | void>;
-
-export { modelShow as showModel }
+export { modelShow as showModel };

package/dist/actions/query-explain-all.d.ts

@@ -1,3 +1,7 @@
+/**
+ * Run EXPLAIN on all SQL files in a directory
+ */
+export declare function queryExplainAll(path: string, options?: ExplainAllOptions): Promise<ExplainResult[]>;
 export declare interface ExplainAllOptions {
   verbose?: boolean
   json?: boolean
@@ -9,6 +13,4 @@ export declare interface ExplainResult {
   plan: any[]
   error?: string
 }
-export declare function queryExplainAll(path: string, options: ExplainAllOptions = {}): Promise<ExplainResult[]>;
-
-export { queryExplainAll as explainAllQueries }
+export { queryExplainAll as explainAllQueries };

package/dist/actions/relation-diagram.d.ts

@@ -1,11 +1,11 @@
+/**
+ * Generate relationship diagram from models
+ */
+export declare function relationDiagram(options?: DiagramOptions): Promise<string>;
 export declare interface DiagramOptions {
   dir?: string
   format?: 'mermaid' | 'dot'
   output?: string
   verbose?: boolean
 }
-export declare function relationDiagram(options: DiagramOptions = {}): Promise<string>;
-declare function generateMermaidDiagram(models: Record<string, any>): string;
-declare function generateDotDiagram(models: Record<string, any>): string;
-
-export { relationDiagram as generateDiagram }
+export { relationDiagram as generateDiagram };

package/dist/actions/seed.d.ts

@@ -1,8 +1,18 @@
-import type { RunSeederOptions, Seeder, SeederConfig } from '@/seeder';
-
-declare function findWorkspaceRoot(startPath: string): string;
-declare function loadSeeders(seedersDir: string): Promise<Array<{ name: string, instance: Seeder }>>;
-export declare function runSeeders(config: SeederConfig = {}): Promise<void>;
-export declare function runSeeder(className: string, options: RunSeederOptions = {}): Promise<void>;
+import type { RunSeederOptions, SeederConfig } from '@/seeder';
+/**
+ * Run all seeders from a directory
+ */
+export declare function runSeeders(config?: SeederConfig): Promise<void>;
+/**
+ * Run a specific seeder by class name
+ */
+export declare function runSeeder(className: string, options?: RunSeederOptions): Promise<void>;
+/**
+ * Generate a new seeder file
+ */
 export declare function makeSeeder(name: string): Promise<void>;
-export declare function freshDatabase(options: { seedersDir?: string, modelsDir?: string, verbose?: boolean } = {}): Promise<void>;
+/**
+ * Refresh database and run all seeders
+ * This will drop all tables and re-run migrations and seeders
+ */
+export declare function freshDatabase(options?: { seedersDir?: string, modelsDir?: string, verbose?: boolean }): Promise<void>;

package/dist/actions/sql.d.ts

@@ -1,3 +1,2 @@
 import type { SqlOptions } from '../types';
-
-export declare function sql(dir: string, table: string, opts: SqlOptions = {}): void;
+export declare function sql(dir: string, table: string, opts?: SqlOptions): void;

package/dist/actions/unsafe.d.ts

@@ -1,3 +1,2 @@
 import type { UnsafeOptions } from '../types';
-
-export declare function unsafe(sql: string, opts: UnsafeOptions = {}): void;
+export declare function unsafe(sql: string, opts?: UnsafeOptions): void;

package/dist/actions/validate.d.ts

@@ -1,4 +1,11 @@
-declare function findWorkspaceRoot(startPath: string): string;
+/**
+ * Validate that models match the database schema
+ */
+export declare function validateSchema(dir?: string): Promise<ValidationResult>;
+/**
+ * Check schema (alias for validateSchema)
+ */
+export declare function checkSchema(dir?: string): Promise<ValidationResult>;
 export declare interface ValidationIssue {
   type: 'missing_table' | 'extra_table' | 'missing_column' | 'extra_column' | 'type_mismatch'
   severity: 'error' | 'warning'
@@ -11,6 +18,4 @@ export declare interface ValidationIssue {
 export declare interface ValidationResult {
   valid: boolean
   issues: ValidationIssue[]
-}
-export declare function validateSchema(dir?: string): Promise<ValidationResult>;
-export declare function checkSchema(dir?: string): Promise<ValidationResult>;
+}

package/dist/actions/wait-ready.d.ts

@@ -1,3 +1,2 @@
 import type { WaitReadyOptions } from '../types';
-
-export declare function waitReady(opts: WaitReadyOptions = {}): void;
+export declare function waitReady(opts?: WaitReadyOptions): void;