@dockstat/sqlite-wrapper 1.2.5 → 1.2.7

package/README.md

@@ -16,19 +16,32 @@ bun add @dockstat/sqlite-wrapper
 
 ## 10-second quickstart
 
-```ts
+```typescript
 import { DB, column } from "@dockstat/sqlite-wrapper";
 
-const db = new DB("app.db", { pragmas: [["journal_mode","WAL"], ["foreign_keys","ON"]] });
+type User = {
+  id?: number,
+  name: string,
+  active: boolean,
+  email: string,
+}
 
-db.createTable("users", {
+const db = new DB("app.db", {
+  pragmas: [
+    ["journal_mode","WAL"],
+    ["foreign_keys","ON"]
+  ]
+});
+
+const userTable = db.createTable<User>("users", {
   id: column.id(),
   name: column.text({ notNull: true }),
+  active: column.boolean(),
   email: column.text({ unique: true, notNull: true }),
   created_at: column.createdAt()
 });
 
-const users = db.table("users")
+const users = userTable
   .select(["id","name","email"])
   .where({ active: true })
   .orderBy("created_at").desc()
@@ -44,10 +57,43 @@ const users = db.table("users")
 * 🛡️ Safety-first defaults — prevents accidental full-table updates/deletes
 * 🚀 Designed for production workflows: WAL, pragmatic PRAGMAs, bulk ops, transactions
 
+## Core Features
+
+### Type Safety
+
+* **Compile-time validation** of column names and data shapes
+* **IntelliSense support** for all operations
+* **Generic interfaces** that adapt to your data models
+* **Type-safe column definitions** with comprehensive constraint support
+
+### Safety-First Design
+
+* **Mandatory WHERE conditions** for UPDATE and DELETE operations to prevent accidental data loss
+* **Parameter binding** for all queries to prevent SQL injection
+* **Prepared statements** used internally for optimal performance
+* **Transaction support** with automatic rollback on errors
+
+### Production Ready
+
+* **WAL mode** support for concurrent read/write operations
+* **Comprehensive PRAGMA management** for performance tuning
+* **Connection pooling** considerations built-in
+* **Bulk operation** support with transaction batching
+* **Schema introspection** tools for migrations and debugging
+
+### Complete SQLite Support
+
+* **All SQLite data types** with proper TypeScript mappings
+* **Generated columns** (both VIRTUAL and STORED)
+* **Foreign key constraints** with cascade options
+* **JSON columns** with validation and transformation
+* **Full-text search** preparation
+* **Custom functions** and extensions support
+
 ## Docs & examples
 
 See full technical docs [here](https://outline.itsnik.de/s/9d88c471-373e-4ef2-a955-b1058eb7dc99/doc/dockstatsqlite-wrapper-Lxt4IphXI5).
 
 ## License
 
-MIT — maintained by Dockstat. Contributions welcome.
+MPL-2.0 — maintained by Dockstat. Contributions welcome.

package/index.ts

@@ -102,7 +102,7 @@ class DB {
     tableName: string,
     jsonConfig?: JsonColumnConfig<T>
   ): QueryBuilder<T> {
-    logger.debug(`Creating QueryBuilder for table: ${tableName}`)
+    logger.debug(`Creating QueryBuilder for table: ${tableName} - JSONConfig: ${JSON.stringify(jsonConfig)}`)
     return new QueryBuilder<T>(this.db, tableName, jsonConfig)
   }
 
@@ -209,7 +209,8 @@ class DB {
    */
   createTable<_T extends Record<string, unknown>>(
     tableName: string,
-    columns: string | Record<string, string> | Partial<Record<Extract<keyof _T, string>, ColumnDefinition>> | TableSchema, options?: TableOptions<_T>,
+    columns: string | Record<string, string> | Partial<Record<Extract<keyof _T, string>, ColumnDefinition>> | TableSchema,
+    options?: TableOptions<_T>,
   ): QueryBuilder<_T> {
     const temp = options?.temporary ? 'TEMPORARY ' : ''
     const ifNot = options?.ifNotExists ? 'IF NOT EXISTS ' : ''
@@ -276,7 +277,7 @@ class DB {
       this.setTableComment(tableName, options.comment)
     }
 
-    return this.table<_T>(tableName)
+    return this.table<_T>(tableName, options?.jsonConfig)
   }
 
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dockstat/sqlite-wrapper",
-  "version": "1.2.5",
+  "version": "1.2.7",
   "description": "A TypeScript wrapper around bun:sqlite with type-safe query building",
   "type": "module",
   "main": "./index.ts",

package/query-builder/base.ts

@@ -34,24 +34,24 @@ export abstract class BaseQueryBuilder<T extends Record<string, unknown>> {
       whereConditions: [],
       whereParams: [],
       regexConditions: [],
-      jsonColumns: jsonConfig?.jsonColumns,
+      jsonColumns: jsonConfig,
     }
   }
 
   /**
     * Reset query builder state
     */
-    protected reset(): void {
-      this.state.whereConditions = []
-      this.state.whereParams = []
-      this.state.regexConditions = []
-      // Reset any ordering, limit, offset, selected columns if present
-      if ('orderColumn' in this) (this as any).orderColumn = undefined
-      if ('orderDirection' in this) (this as any).orderDirection = 'ASC'
-      if ('limitValue' in this) (this as any).limitValue = undefined
-      if ('offsetValue' in this) (this as any).offsetValue = undefined
-      if ('selectedColumns' in this) (this as any).selectedColumns = ['*']
-    }
+  protected reset(): void {
+    this.state.whereConditions = []
+    this.state.whereParams = []
+    this.state.regexConditions = []
+    // Reset any ordering, limit, offset, selected columns if present
+    if ('orderColumn' in this) (this as any).orderColumn = undefined
+    if ('orderDirection' in this) (this as any).orderDirection = 'ASC'
+    if ('limitValue' in this) (this as any).limitValue = undefined
+    if ('offsetValue' in this) (this as any).offsetValue = undefined
+    if ('selectedColumns' in this) (this as any).selectedColumns = ['*']
+  }
 
   /**
    * Get the database instance
@@ -197,11 +197,16 @@ export abstract class BaseQueryBuilder<T extends Record<string, unknown>> {
    * Transform row data before inserting/updating to database (serialize JSON columns).
    */
   protected transformRowToDb(row: Partial<T>): DatabaseRowData {
-    if (!this.state.jsonColumns || !row) return row as DatabaseRowData
+    this.logger.debug(`Transforming row (${JSON.stringify(row)}) to row Data`)
+    if (!this.state.jsonColumns || !row) {
+      return row as DatabaseRowData
+    }
 
     const transformed: DatabaseRowData = { ...row } as DatabaseRowData
+
     for (const column of this.state.jsonColumns) {
       const columnKey = String(column)
+      this.logger.debug(`Checking: ${columnKey}`)
       if (
         transformed[columnKey] !== undefined &&
         transformed[columnKey] !== null

package/query-builder/insert.ts

@@ -9,6 +9,7 @@ import { WhereQueryBuilder } from "./where";
 export class InsertQueryBuilder<
   T extends Record<string, unknown>,
 > extends WhereQueryBuilder<T> {
+
   /**
    * Insert a single row or multiple rows into the table.
    *
@@ -20,11 +21,16 @@ export class InsertQueryBuilder<
     data: Partial<T> | Partial<T>[],
     options?: InsertOptions,
   ): InsertResult {
+    this.getLogger().debug(`Building Data Array: ${data}`)
     const rows = Array.isArray(data) ? data : [data];
 
+
+
     // Transform rows to handle JSON serialization
     const transformedRows = rows.map((row) => this.transformRowToDb(row));
 
+    this.getLogger().debug(`Transformed row: ${JSON.stringify(transformedRows)}`)
+
     if (transformedRows.length === 0) {
       throw new Error("insert: data cannot be empty");
     }

package/types.ts

@@ -1,4 +1,3 @@
-// Enhanced types.ts with comprehensive SQLite support
 import type { Database, SQLQueryBindings } from "bun:sqlite";
 
 /**
@@ -262,8 +261,8 @@ export interface TableOptions<T> {
   temporary?: boolean;
   /** Table comment */
   comment?: string;
-  /** JSON config for table creation and returned query builder */
-  jsonConfig?: Array<keyof T>;
+
+  jsonConfig?: JsonColumnConfig<T>
 }
 
 /**
@@ -380,7 +379,7 @@ export const column = {
     constraints: ColumnConstraints & { validateJson?: boolean },
   ): ColumnDefinition => ({
     type: SQLiteTypes.JSON,
-    check: constraints?.validateJson ?? true
+    check: constraints?.validateJson
       ? "JSON_VALID({{COLUMN}})"
       : constraints?.check,
     ...constraints,
@@ -606,9 +605,7 @@ export interface InsertOptions {
 /**
  * JSON column configuration
  */
-export interface JsonColumnConfig<T> {
-  jsonColumns?: Array<keyof T>;
-}
+export type JsonColumnConfig<T> = Array<keyof T>
 
 /**
  * Generic database row type