@storyshelf/db-sqlite 0.1.3 → 0.3.2

package/README.md

@@ -1,6 +1,6 @@
 # @storyshelf/db-sqlite
 
-The default database adapter for self-hosted StoryShelf: SQLite backed by better-sqlite3 and Drizzle ORM, in WAL mode. Zero configuration for a single-node deployment.
+The default database adapter for self-hosted StoryShelf: SQLite backed by node:sqlite (zero-dependency builtin) and Drizzle ORM, in WAL mode. Zero configuration for a single-node deployment.
 
 ## Install
 
@@ -22,19 +22,19 @@ import { createShelfRouter } from "@storyshelf/core";
 import { createLocalStorage } from "@storyshelf/storage-local";
 
 const database = createSqliteDatabase("./data/shelf.db");
-await database.migrate();
 
 const storage = createLocalStorage("./data");
 const app = createShelfRouter({ database, storage });
+await app.lifecycle.init();
 ```
 
 ## API
 
 ### `createSqliteDatabase(path: string): DatabaseAdapter`
 
-Opens (or creates) a SQLite database at `path` and returns a `DatabaseAdapter`. The connection enables WAL journal mode and a 5s busy timeout. Call `migrate()` before use to apply the schema (shared DDL from `@storyshelf/core`).
+Opens (or creates) a SQLite database at `path` and returns a `DatabaseAdapter`. The connection enables WAL journal mode and a 5s busy timeout. Schema migrations run inside the adapter's `lifecycle.init` (via `await app.lifecycle.init()`); teardown via `lifecycle.close` (idempotent).
 
-The returned adapter implements every method of the `DatabaseAdapter` interface (`insert`, `update`, `get`, `remove`, `list`, `count`, `all`, `migrate`, `close`).
+The returned adapter implements every method of the `DatabaseAdapter` interface (`insert`, `update`, `get`, `remove`, `list`, `count`, `all`) plus `metadata`/`lifecycle` from the shared `Adapter` base.
 
 ## How it fits in
 

package/dist/index.d.mts

@@ -3,7 +3,7 @@ import __tsdown_shims_url from 'node:url';
 import { DatabaseAdapter } from "@storyshelf/core/adapter/database";
 //#region src/index.d.ts
 /**
- * Create a SQLite-backed DatabaseAdapter using better-sqlite3 and Drizzle ORM.
+ * Create a SQLite-backed DatabaseAdapter using node:sqlite and Drizzle ORM.
  *
  * @param path - Filesystem path to the SQLite database file.
  * @returns A DatabaseAdapter backed by the given SQLite file (WAL mode).

package/dist/index.mjs

@@ -1,72 +1,69 @@
 import "node:path";
 import "node:url";
 import.meta.url;
-import { eq, getTableColumns } from "drizzle-orm";
-import { drizzle } from "drizzle-orm/better-sqlite3";
-import Database from "better-sqlite3";
-import { schema } from "@storyshelf/core/schema";
+import { DatabaseSync } from "node:sqlite";
+import { createDrizzleAdapter } from "@storyshelf/core/adapter/database";
 import { DDL } from "@storyshelf/core/ddl";
+import { schema } from "@storyshelf/core/schema";
+import { drizzle } from "drizzle-orm/sqlite-proxy";
 //#region src/index.ts
-function idOf(table) {
-	return getTableColumns(table)["id"];
-}
-function applyListOptions(query, opts) {
-	if (opts.where) query.where(opts.where);
-	if (opts.orderBy) query.orderBy(opts.orderBy);
-	if (opts.limit !== void 0) query.limit(opts.limit);
-	if (opts.offset !== void 0) query.offset(opts.offset);
+const STORYBOOK_META_ALTER = "ALTER TABLE projects ADD COLUMN storybook_meta TEXT";
+const WEBHOOK_SECRET_ALTER = "ALTER TABLE webhooks ADD COLUMN secret_encrypted TEXT NOT NULL DEFAULT ''";
+const WEBHOOK_SECRET_DROP = "ALTER TABLE webhooks DROP COLUMN secret";
+/**
+* Execute one Drizzle statement against DatabaseSync, returning proxy-shaped rows.
+* Drizzle builds the SQL and params; only the transport is hand-written.
+* `values` shares the `all` shape (array rows); the factory never emits it.
+* Note: for `get`, the proxy passes `result.rows` straight to the row mapper,
+* so `rows` is the single row (or undefined on a miss) — not a one-row array.
+*/
+function executeStatement(sqlite, sql, params, method) {
+	const stmt = sqlite.prepare(sql);
+	const args = params;
+	if (method === "run") {
+		stmt.run(...args);
+		return { rows: [] };
+	}
+	if (method === "get") return { rows: stmt.get(...args) };
+	return { rows: stmt.all(...args) };
 }
 /**
-* Create a SQLite-backed DatabaseAdapter using better-sqlite3 and Drizzle ORM.
+* Create a SQLite-backed DatabaseAdapter using node:sqlite and Drizzle ORM.
 *
 * @param path - Filesystem path to the SQLite database file.
 * @returns A DatabaseAdapter backed by the given SQLite file (WAL mode).
 */
 function createSqliteDatabase(path) {
-	const sqlite = new Database(path);
-	sqlite.pragma("journal_mode = WAL");
-	sqlite.pragma("busy_timeout = 5000");
-	const db = drizzle(sqlite, { schema });
-	return {
+	const sqlite = new DatabaseSync(path, { returnArrays: true });
+	sqlite.exec("PRAGMA journal_mode = WAL");
+	sqlite.exec("PRAGMA busy_timeout = 5000");
+	const callback = (async (sql, params, method) => {
+		await Promise.resolve();
+		return executeStatement(sqlite, sql, params, method);
+	});
+	const db = drizzle(callback, { schema });
+	return createDrizzleAdapter(db, {
 		metadata: {
 			name: "SQLite",
 			version: globalThis.__PKG_VERSION__ ?? "0.0.0",
-			description: "SQLite database adapter (better-sqlite3 + Drizzle)",
-			kind: "sqlite"
-		},
-		async insert(table, values) {
-			return db.insert(table).values(values).returning().get();
-		},
-		async update(table, id, values) {
-			return db.update(table).set(values).where(eq(idOf(table), id)).returning().get();
+			description: "SQLite database adapter (node:sqlite + Drizzle)",
+			kind: "sqlite",
+			category: "database"
 		},
-		async get(table, id) {
-			return db.select().from(table).where(eq(idOf(table), id)).limit(1).get() ?? null;
-		},
-		async remove(table, id) {
-			db.delete(table).where(eq(idOf(table), id)).run();
-		},
-		async list(table, opts = {}) {
-			const query = db.select().from(table);
-			applyListOptions(query, opts);
-			return query.all();
-		},
-		async count(table, where) {
-			return db.$count(table, where);
-		},
-		async all(query) {
-			return db.all(query);
-		},
-		async migrate() {
+		migrate: () => {
 			sqlite.exec(DDL);
 			try {
-				sqlite.exec("ALTER TABLE projects ADD COLUMN storybook_meta TEXT");
+				sqlite.exec(STORYBOOK_META_ALTER);
+			} catch {}
+			try {
+				sqlite.exec(WEBHOOK_SECRET_ALTER);
+				sqlite.exec(WEBHOOK_SECRET_DROP);
 			} catch {}
 		},
-		async close() {
+		close: () => {
 			sqlite.close();
 		}
-	};
+	});
 }
 //#endregion
 export { createSqliteDatabase };

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["import { eq, getTableColumns } from \"drizzle-orm\";\nimport { drizzle } from \"drizzle-orm/better-sqlite3\";\nimport type { AnySQLiteTable, SQLiteColumn } from \"drizzle-orm/sqlite-core\";\nimport Database from \"better-sqlite3\";\n\nimport type { DatabaseAdapter, ListOptions } from \"@storyshelf/core/adapter/database\";\nimport { schema } from \"@storyshelf/core/schema\";\nimport { DDL } from \"@storyshelf/core/ddl\";\n\ndeclare const __PKG_VERSION__: string | undefined;\n\nfunction idOf(table: AnySQLiteTable): SQLiteColumn {\n  // eslint-disable-next-line no-non-null-assertion -- every table has an `id` column\n  return getTableColumns(table)[\"id\"]!;\n}\n\n/* eslint-disable typescript/no-explicit-any, typescript/no-unsafe-call, typescript/no-unsafe-member-access -- drizzle query builder is intentionally loosely typed */\nfunction applyListOptions(\n  query: any,\n  opts: ListOptions,\n): void {\n  if (opts.where) {\n    query.where(opts.where);\n  }\n  if (opts.orderBy) {\n    query.orderBy(opts.orderBy);\n  }\n  if (opts.limit !== undefined) {\n    query.limit(opts.limit);\n  }\n  if (opts.offset !== undefined) {\n    query.offset(opts.offset);\n  }\n}\n/* eslint-enable typescript/no-explicit-any, typescript/no-unsafe-call, typescript/no-unsafe-member-access */\n\n/**\n * Create a SQLite-backed DatabaseAdapter using better-sqlite3 and Drizzle ORM.\n *\n * @param path - Filesystem path to the SQLite database file.\n * @returns A DatabaseAdapter backed by the given SQLite file (WAL mode).\n */\nexport function createSqliteDatabase(path: string): DatabaseAdapter {\n  const sqlite = new Database(path);\n  sqlite.pragma(\"journal_mode = WAL\");\n  sqlite.pragma(\"busy_timeout = 5000\");\n  const db = drizzle(sqlite, { schema });\n\n  // Better-sqlite3 is synchronous, so `async` is required only by the\n  // DatabaseAdapter interface (no `await`), and drizzle's `.get()`/`[\"id\"]`\n  // Are guaranteed present despite the undefined-able types. Both rules are\n  // False positives here.\n  /* eslint-disable require-await, no-non-null-assertion, no-unnecessary-type-assertion */\n  return {\n    metadata: {\n      name: \"SQLite\",\n      version: (globalThis as unknown as { __PKG_VERSION__?: string }).__PKG_VERSION__ ?? \"0.0.0\",\n      description: \"SQLite database adapter (better-sqlite3 + Drizzle)\",\n      kind: \"sqlite\",\n    },\n    async insert(table, values) {\n      return db.insert(table).values(values).returning().get()!;\n    },\n    async update(table, id, values) {\n      return db.update(table).set(values).where(eq(idOf(table), id)).returning().get()!;\n    },\n    async get(table, id) {\n      return db.select().from(table).where(eq(idOf(table), id)).limit(1).get() ?? null;\n    },\n    async remove(table, id) {\n      db.delete(table).where(eq(idOf(table), id)).run();\n    },\n    async list(table, opts: ListOptions = {}) {\n      const query = db.select().from(table);\n      applyListOptions(query, opts);\n      return query.all();\n    },\n    async count(table, where) {\n      return db.$count(table, where);\n    },\n    async all(query) {\n      return db.all(query);\n    },\n    async migrate() {\n      sqlite.exec(DDL);\n      try {\n        sqlite.exec(\"ALTER TABLE projects ADD COLUMN storybook_meta TEXT\");\n      } catch {\n        // Column already exists or other error — ignore for idempotency\n      }\n    },\n    async close() {\n      sqlite.close();\n    },\n  };\n  /* eslint-enable require-await, no-non-null-assertion, no-unnecessary-type-assertion */\n}\n"],"mappings":";;;;;;;;;AAWA,SAAS,KAAK,OAAqC;CAEjD,OAAO,gBAAgB,KAAK,CAAC,CAAC;AAChC;AAGA,SAAS,iBACP,OACA,MACM;CACN,IAAI,KAAK,OACP,MAAM,MAAM,KAAK,KAAK;CAExB,IAAI,KAAK,SACP,MAAM,QAAQ,KAAK,OAAO;CAE5B,IAAI,KAAK,UAAU,KAAA,GACjB,MAAM,MAAM,KAAK,KAAK;CAExB,IAAI,KAAK,WAAW,KAAA,GAClB,MAAM,OAAO,KAAK,MAAM;AAE5B;;;;;;;AASA,SAAgB,qBAAqB,MAA+B;CAClE,MAAM,SAAS,IAAI,SAAS,IAAI;CAChC,OAAO,OAAO,oBAAoB;CAClC,OAAO,OAAO,qBAAqB;CACnC,MAAM,KAAK,QAAQ,QAAQ,EAAE,OAAO,CAAC;CAOrC,OAAO;EACL,UAAU;GACR,MAAM;GACN,SAAU,WAAuD,mBAAmB;GACpF,aAAa;GACb,MAAM;EACR;EACA,MAAM,OAAO,OAAO,QAAQ;GAC1B,OAAO,GAAG,OAAO,KAAK,CAAC,CAAC,OAAO,MAAM,CAAC,CAAC,UAAU,CAAC,CAAC,IAAI;EACzD;EACA,MAAM,OAAO,OAAO,IAAI,QAAQ;GAC9B,OAAO,GAAG,OAAO,KAAK,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,MAAM,GAAG,KAAK,KAAK,GAAG,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,IAAI;EACjF;EACA,MAAM,IAAI,OAAO,IAAI;GACnB,OAAO,GAAG,OAAO,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,MAAM,GAAG,KAAK,KAAK,GAAG,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,KAAK;EAC9E;EACA,MAAM,OAAO,OAAO,IAAI;GACtB,GAAG,OAAO,KAAK,CAAC,CAAC,MAAM,GAAG,KAAK,KAAK,GAAG,EAAE,CAAC,CAAC,CAAC,IAAI;EAClD;EACA,MAAM,KAAK,OAAO,OAAoB,CAAC,GAAG;GACxC,MAAM,QAAQ,GAAG,OAAO,CAAC,CAAC,KAAK,KAAK;GACpC,iBAAiB,OAAO,IAAI;GAC5B,OAAO,MAAM,IAAI;EACnB;EACA,MAAM,MAAM,OAAO,OAAO;GACxB,OAAO,GAAG,OAAO,OAAO,KAAK;EAC/B;EACA,MAAM,IAAI,OAAO;GACf,OAAO,GAAG,IAAI,KAAK;EACrB;EACA,MAAM,UAAU;GACd,OAAO,KAAK,GAAG;GACf,IAAI;IACF,OAAO,KAAK,qDAAqD;GACnE,QAAQ,CAER;EACF;EACA,MAAM,QAAQ;GACZ,OAAO,MAAM;EACf;CACF;AAEF"}
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["import { DatabaseSync, type SQLInputValue } from \"node:sqlite\";\nimport type { DatabaseAdapter } from \"@storyshelf/core/adapter/database\";\nimport { createDrizzleAdapter } from \"@storyshelf/core/adapter/database\";\nimport { DDL } from \"@storyshelf/core/ddl\";\nimport { schema } from \"@storyshelf/core/schema\";\nimport { drizzle, type AsyncRemoteCallback } from \"drizzle-orm/sqlite-proxy\";\n\ndeclare const __PKG_VERSION__: string | undefined;\n\nconst STORYBOOK_META_ALTER = \"ALTER TABLE projects ADD COLUMN storybook_meta TEXT\";\nconst WEBHOOK_SECRET_ALTER = \"ALTER TABLE webhooks ADD COLUMN secret_encrypted TEXT NOT NULL DEFAULT ''\";\nconst WEBHOOK_SECRET_DROP = \"ALTER TABLE webhooks DROP COLUMN secret\";\n\ntype ProxyMethod = \"run\" | \"all\" | \"values\" | \"get\";\n\n/**\n * Execute one Drizzle statement against DatabaseSync, returning proxy-shaped rows.\n * Drizzle builds the SQL and params; only the transport is hand-written.\n * `values` shares the `all` shape (array rows); the factory never emits it.\n * Note: for `get`, the proxy passes `result.rows` straight to the row mapper,\n * so `rows` is the single row (or undefined on a miss) — not a one-row array.\n */\nfunction executeStatement(\n  sqlite: DatabaseSync,\n  sql: string,\n  params: unknown[],\n  method: ProxyMethod,\n): { rows: unknown } {\n  const stmt = sqlite.prepare(sql);\n  // Single contained cast: Drizzle's params are SQLite scalars by construction.\n  // oxlint-disable-next-line typescript/no-unnecessary-type-assertion -- tsc requires the narrowing; the rule misfires on the variadic overloads\n  const args = params as SQLInputValue[];\n  if (method === \"run\") {\n    stmt.run(...args);\n    return { rows: [] };\n  }\n  if (method === \"get\") {\n    return { rows: stmt.get(...args) };\n  }\n  return { rows: stmt.all(...args) };\n}\n\n/**\n * Create a SQLite-backed DatabaseAdapter using node:sqlite and Drizzle ORM.\n *\n * @param path - Filesystem path to the SQLite database file.\n * @returns A DatabaseAdapter backed by the given SQLite file (WAL mode).\n */\nexport function createSqliteDatabase(path: string): DatabaseAdapter {\n  const sqlite = new DatabaseSync(path, { returnArrays: true });\n  sqlite.exec(\"PRAGMA journal_mode = WAL\");\n  sqlite.exec(\"PRAGMA busy_timeout = 5000\");\n  // The declared callback type claims `{ rows: any[] }`, but the session\n  // passes `result.rows` straight to the row mapper for `get` — so `rows`\n  // must be the single row (or undefined), not a one-row array. The cast\n  // quarantines drizzle's inaccurate declaration at this boundary.\n  const callback = (async (sql: string, params: unknown[], method: ProxyMethod) => {\n    await Promise.resolve();\n    return executeStatement(sqlite, sql, params, method);\n  }) as AsyncRemoteCallback;\n  const db = drizzle(callback, { schema });\n\n  return createDrizzleAdapter(db, {\n    metadata: {\n      name: \"SQLite\",\n      version: (globalThis as unknown as { __PKG_VERSION__?: string }).__PKG_VERSION__ ?? \"0.0.0\",\n      description: \"SQLite database adapter (node:sqlite + Drizzle)\",\n      kind: \"sqlite\",\n      category: \"database\",\n    },\n    migrate: () => {\n      sqlite.exec(DDL);\n      try {\n        sqlite.exec(STORYBOOK_META_ALTER);\n      } catch {\n        // Column already exists or other error — ignore for idempotency\n      }\n      try {\n        sqlite.exec(WEBHOOK_SECRET_ALTER);\n        sqlite.exec(WEBHOOK_SECRET_DROP);\n      } catch {\n        // Already migrated (or fresh schema) — ignore for idempotency\n      }\n    },\n    close: () => {\n      sqlite.close();\n    },\n  });\n}\n"],"mappings":";;;;;;;;;AASA,MAAM,uBAAuB;AAC7B,MAAM,uBAAuB;AAC7B,MAAM,sBAAsB;;;;;;;;AAW5B,SAAS,iBACP,QACA,KACA,QACA,QACmB;CACnB,MAAM,OAAO,OAAO,QAAQ,GAAG;CAG/B,MAAM,OAAO;CACb,IAAI,WAAW,OAAO;EACpB,KAAK,IAAI,GAAG,IAAI;EAChB,OAAO,EAAE,MAAM,CAAC,EAAE;CACpB;CACA,IAAI,WAAW,OACb,OAAO,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI,EAAE;CAEnC,OAAO,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI,EAAE;AACnC;;;;;;;AAQA,SAAgB,qBAAqB,MAA+B;CAClE,MAAM,SAAS,IAAI,aAAa,MAAM,EAAE,cAAc,KAAK,CAAC;CAC5D,OAAO,KAAK,2BAA2B;CACvC,OAAO,KAAK,4BAA4B;CAKxC,MAAM,YAAY,OAAO,KAAa,QAAmB,WAAwB;EAC/E,MAAM,QAAQ,QAAQ;EACtB,OAAO,iBAAiB,QAAQ,KAAK,QAAQ,MAAM;CACrD;CACA,MAAM,KAAK,QAAQ,UAAU,EAAE,OAAO,CAAC;CAEvC,OAAO,qBAAqB,IAAI;EAC9B,UAAU;GACR,MAAM;GACN,SAAU,WAAuD,mBAAmB;GACpF,aAAa;GACb,MAAM;GACN,UAAU;EACZ;EACA,eAAe;GACb,OAAO,KAAK,GAAG;GACf,IAAI;IACF,OAAO,KAAK,oBAAoB;GAClC,QAAQ,CAER;GACA,IAAI;IACF,OAAO,KAAK,oBAAoB;IAChC,OAAO,KAAK,mBAAmB;GACjC,QAAQ,CAER;EACF;EACA,aAAa;GACX,OAAO,MAAM;EACf;CACF,CAAC;AACH"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@storyshelf/db-sqlite",
-  "version": "0.1.3",
-  "description": "SQLite database adapter for StoryShelf (better-sqlite3 + Drizzle).",
+  "version": "0.3.2",
+  "description": "SQLite database adapter for StoryShelf (node:sqlite + Drizzle).",
   "homepage": "https://github.com/GuptaSiddhant/StoryShelf#readme",
   "bugs": {
     "url": "https://github.com/GuptaSiddhant/StoryShelf/issues"
@@ -45,12 +45,10 @@
     "prepublishOnly": "nub run build"
   },
   "dependencies": {
-    "@storyshelf/core": "^0.1.3",
-    "better-sqlite3": "^12.4.1",
+    "@storyshelf/core": "^0.3.2",
     "drizzle-orm": "^0.44.0"
   },
   "devDependencies": {
-    "@types/better-sqlite3": "^7.6.13",
     "@types/node": "catalog:",
     "@vitest/coverage-v8": "catalog:",
     "oxfmt": "catalog:",