@zgeoff/kysely-bun-sqlite 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 zgeoff
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,42 @@
-# Temporary Holding Version
+# @zgeoff/kysely-bun-sqlite
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A Kysely driver and dialect over one `bun:sqlite` database handle. Kysely ships no `bun:sqlite`
+dialect, so a repo that pairs the two builds its dialect from this package.
+
+## Install
+
+```sh
+bun add @zgeoff/kysely-bun-sqlite kysely
+```
+
+Kysely is a peer dependency, so the repo picks its own Kysely version within the peer range.
+
+## Usage
+
+The repo opens the handle and sets its pragmas, then passes the handle to `buildSQLiteDialect`.
+
+```ts
+import { Database } from 'bun:sqlite';
+import { buildSQLiteDialect } from '@zgeoff/kysely-bun-sqlite';
+import { Kysely } from 'kysely';
+
+interface LibrarySchema {
+  books: { title: string };
+}
+
+const sqlite = new Database('library.db', { create: true });
+
+sqlite.run('CREATE TABLE IF NOT EXISTS books (title TEXT NOT NULL)');
+
+const db = new Kysely<LibrarySchema>({ dialect: buildSQLiteDialect(sqlite) });
+
+const titles = await db.selectFrom('books').select('title').execute();
+
+await db.destroy();
+sqlite.close();
+```
+
+The opener owns the handle. `db.destroy()` waits for the caller that holds the connection and leaves
+the handle open, so the opener closes the handle after `db.destroy()` resolves.
+
+The driver refuses a streaming query, so `stream()` on a Kysely query throws.

package/dist/build-sqlite-dialect.d.ts

@@ -0,0 +1,3 @@
+import type { Database } from 'bun:sqlite';
+import type { Dialect } from 'kysely';
+export declare function buildSQLiteDialect(sqlite: Database): Dialect;

package/dist/bun-sqlite-driver.d.ts

@@ -0,0 +1,15 @@
+import type { Database } from 'bun:sqlite';
+import type { DatabaseConnection, Driver } from 'kysely';
+export declare class BunSQLiteDriver implements Driver {
+    private readonly connection;
+    private turn;
+    private releaseTurn;
+    constructor(sqlite: Database);
+    init(): Promise<void>;
+    acquireConnection(): Promise<DatabaseConnection>;
+    beginTransaction(connection: DatabaseConnection): Promise<void>;
+    commitTransaction(connection: DatabaseConnection): Promise<void>;
+    rollbackTransaction(connection: DatabaseConnection): Promise<void>;
+    releaseConnection(): Promise<void>;
+    destroy(): Promise<void>;
+}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { buildSQLiteDialect } from './build-sqlite-dialect.ts';
+export { BunSQLiteDriver } from './bun-sqlite-driver.ts';

package/package.json

@@ -1,6 +1,42 @@
 {
   "name": "@zgeoff/kysely-bun-sqlite",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "A Kysely driver and dialect for a bun:sqlite database handle",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/zgeoff/tools.git",
+    "directory": "packages/kysely-bun-sqlite"
+  },
+  "files": [
+    "src",
+    "!src/*.test.ts",
+    "dist"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./src/index.ts"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "rm -rf dist && tsc -p tsconfig.build.json",
+    "prepare": "bun run build",
+    "typecheck": "tsc"
+  },
+  "devDependencies": {
+    "@types/bun": "1.3.14",
+    "kysely": "0.29.6",
+    "typescript": "7.0.1-rc"
+  },
+  "peerDependencies": {
+    "kysely": ">=0.29.5 <0.30.0"
+  },
+  "engines": {
+    "bun": ">=1.3"
+  }
+}

package/src/build-sqlite-dialect.ts

@@ -0,0 +1,13 @@
+import type { Database } from 'bun:sqlite';
+import { SqliteAdapter, SqliteIntrospector, SqliteQueryCompiler } from 'kysely';
+import type { Dialect } from 'kysely';
+import { BunSQLiteDriver } from './bun-sqlite-driver.ts';
+
+export function buildSQLiteDialect(sqlite: Database): Dialect {
+  return {
+    createAdapter: () => new SqliteAdapter(),
+    createDriver: () => new BunSQLiteDriver(sqlite),
+    createIntrospector: (kysely) => new SqliteIntrospector(kysely),
+    createQueryCompiler: () => new SqliteQueryCompiler(),
+  };
+}

package/src/bun-sqlite-driver.ts

@@ -0,0 +1,91 @@
+import type { Database, SQLQueryBindings } from 'bun:sqlite';
+import { CompiledQuery } from 'kysely';
+import type { DatabaseConnection, Driver, QueryResult } from 'kysely';
+
+// oxlint-disable zgeoff/function-verb -- Kysely's Driver interface fixes the method names
+
+// Kysely's RuntimeDriver serializes the connection: SqliteAdapter reports no
+// support for multiple connections, so RuntimeDriver holds a mutex from each
+// acquire to its release.
+export class BunSQLiteDriver implements Driver {
+  private readonly connection: DatabaseConnection;
+
+  // The driver's own turn chain exists only for the destroy() wait, because
+  // Kysely calls destroy() outside RuntimeDriver's mutex.
+  private turn: Promise<void> = Promise.resolve();
+
+  private releaseTurn: () => void = () => {};
+
+  constructor(sqlite: Database) {
+    this.connection = buildConnection(sqlite);
+  }
+
+  init(): Promise<void> {
+    return Promise.resolve();
+  }
+
+  async acquireConnection(): Promise<DatabaseConnection> {
+    const previous = this.turn;
+    const next = Promise.withResolvers<void>();
+
+    this.turn = next.promise;
+
+    await previous;
+
+    this.releaseTurn = next.resolve;
+
+    return this.connection;
+  }
+
+  async beginTransaction(connection: DatabaseConnection): Promise<void> {
+    await connection.executeQuery(CompiledQuery.raw('begin'));
+  }
+
+  async commitTransaction(connection: DatabaseConnection): Promise<void> {
+    await connection.executeQuery(CompiledQuery.raw('commit'));
+  }
+
+  async rollbackTransaction(connection: DatabaseConnection): Promise<void> {
+    await connection.executeQuery(CompiledQuery.raw('rollback'));
+  }
+
+  releaseConnection(): Promise<void> {
+    this.releaseTurn();
+
+    return Promise.resolve();
+  }
+
+  // The opener owns the handle and closes it, so destroy() leaves the handle
+  // open and only waits for the caller that holds the connection.
+  async destroy(): Promise<void> {
+    await this.acquireConnection();
+    await this.releaseConnection();
+  }
+}
+
+function buildConnection(sqlite: Database): DatabaseConnection {
+  return {
+    executeQuery<R>(compiledQuery: CompiledQuery): Promise<QueryResult<R>> {
+      const stmt = sqlite.query<R, SQLQueryBindings[]>(compiledQuery.sql);
+
+      // oxlint-disable-next-line typescript/no-unsafe-type-assertion -- Kysely's SQLite compiler binds only values that bun:sqlite accepts
+      const bindings = compiledQuery.parameters as SQLQueryBindings[];
+
+      if (stmt.columnNames.length > 0) {
+        return Promise.resolve({ rows: stmt.all(...bindings) });
+      }
+
+      const result = stmt.run(...bindings);
+
+      return Promise.resolve({
+        rows: [],
+        numAffectedRows: BigInt(result.changes),
+        insertId: BigInt(result.lastInsertRowid),
+      });
+    },
+
+    streamQuery<R>(): AsyncIterableIterator<QueryResult<R>> {
+      throw new Error('BunSQLiteDriver does not support streaming queries');
+    },
+  };
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export { buildSQLiteDialect } from './build-sqlite-dialect.ts';
+export { BunSQLiteDriver } from './bun-sqlite-driver.ts';