@storyshelf/db-sqlite 0.1.0

package/README.md

@@ -0,0 +1,43 @@
+# @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.
+
+## Install
+
+```sh
+nub add @storyshelf/db-sqlite
+```
+
+or
+
+```sh
+npm install @storyshelf/db-sqlite
+```
+
+## Quick start
+
+```ts
+import { createSqliteDatabase } from "@storyshelf/db-sqlite";
+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 });
+```
+
+## 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`).
+
+The returned adapter implements every method of the `DatabaseAdapter` interface (`insert`, `update`, `get`, `remove`, `list`, `count`, `all`, `migrate`, `close`).
+
+## How it fits in
+
+`db-sqlite` is the default `database` option for `createShelfRouter` in single-node self-hosted deployments. It implements the same `DatabaseAdapter` interface and shares the same Drizzle schema as `@storyshelf/db-turso`, so switching to a serverless database only means swapping this adapter.
+
+See `docs/architecture.md` and ADR 0002.

package/dist/index.d.mts

@@ -0,0 +1,14 @@
+import __tsdown_shims_path from 'node:path';
+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.
+ *
+ * @param path - Filesystem path to the SQLite database file.
+ * @returns A DatabaseAdapter backed by the given SQLite file (WAL mode).
+ */
+declare function createSqliteDatabase(path: string): DatabaseAdapter;
+//#endregion
+export { createSqliteDatabase };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.mjs

@@ -0,0 +1,71 @@
+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 { DDL } from "@storyshelf/core/ddl";
+//#region src/index.ts
+function idOf(table) {
+	return getTableColumns(table)["id"];
+}
+/**
+* Create a SQLite-backed DatabaseAdapter using better-sqlite3 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 {
+		metadata: {
+			name: "SQLite",
+			version: "0.1.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();
+		},
+		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);
+			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);
+			return query.all();
+		},
+		async count(table, where) {
+			return db.$count(table, where);
+		},
+		async all(query) {
+			return db.all(query);
+		},
+		async migrate() {
+			sqlite.exec(DDL);
+			try {
+				sqlite.exec("ALTER TABLE projects ADD COLUMN storybook_meta TEXT");
+			} catch {}
+		},
+		async close() {
+			sqlite.close();
+		}
+	};
+}
+//#endregion
+export { createSqliteDatabase };
+
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +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;\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/**\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: typeof __PKG_VERSION__ === \"undefined\" ? \"0.0.0\" : __PKG_VERSION__, // oxlint-disable-line unicorn/no-typeof-undefined\n      description: \"SQLite database adapter (better-sqlite3 + Drizzle)\",\n      kind: \"sqlite\",\n    },\n    async insert(table, values) {\n      const row = db.insert(table).values(values).returning().get();\n      return row!;\n    },\n    async update(table, id, values) {\n      const row = db.update(table).set(values).where(eq(idOf(table), id)).returning().get();\n      return row!;\n    },\n    async get(table, id) {\n      const row = db.select().from(table).where(eq(idOf(table), id)).limit(1).get();\n      return row ?? 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      if (opts.where) query.where(opts.where);\n      if (opts.orderBy) query.orderBy(opts.orderBy);\n      if (opts.limit !== undefined) query.limit(opts.limit);\n      if (opts.offset !== undefined) query.offset(opts.offset);\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;;;;;;;AAQA,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,SAAA;GACA,aAAa;GACb,MAAM;EACR;EACA,MAAM,OAAO,OAAO,QAAQ;GAE1B,OADY,GAAG,OAAO,KAAK,CAAC,CAAC,OAAO,MAAM,CAAC,CAAC,UAAU,CAAC,CAAC,IAC/C;EACX;EACA,MAAM,OAAO,OAAO,IAAI,QAAQ;GAE9B,OADY,GAAG,OAAO,KAAK,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,MAAM,GAAG,KAAK,KAAK,GAAG,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,IACvE;EACX;EACA,MAAM,IAAI,OAAO,IAAI;GAEnB,OADY,GAAG,OAAO,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,MAAM,GAAG,KAAK,KAAK,GAAG,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAC/D,KAAK;EAChB;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,IAAI,KAAK,OAAO,MAAM,MAAM,KAAK,KAAK;GACtC,IAAI,KAAK,SAAS,MAAM,QAAQ,KAAK,OAAO;GAC5C,IAAI,KAAK,UAAU,KAAA,GAAW,MAAM,MAAM,KAAK,KAAK;GACpD,IAAI,KAAK,WAAW,KAAA,GAAW,MAAM,OAAO,KAAK,MAAM;GACvD,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"}

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@storyshelf/db-sqlite",
+  "version": "0.1.0",
+  "type": "module",
+  "description": "SQLite database adapter for StoryShelf (better-sqlite3 + Drizzle).",
+  "author": {
+    "name": "Siddhant Gupta",
+    "url": "https://guptasiddhant.com"
+  },
+  "license": "MIT",
+  "sideEffects": false,
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/GuptaSiddhant/storyshelf.git",
+    "directory": "packages/db-sqlite"
+  },
+  "homepage": "https://github.com/GuptaSiddhant/storyshelf#readme",
+  "bugs": {
+    "url": "https://github.com/GuptaSiddhant/storyshelf/issues"
+  },
+  "publishConfig": {
+    "access": "public",
+    "exports": {
+      ".": "./dist/index.mjs",
+      "./package.json": "./package.json"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown -w",
+    "fmt": "oxfmt -c ../../.oxfmtrc.json ./src",
+    "lint": "oxlint --type-aware --type-check ./src",
+    "test": "vitest run",
+    "prepublishOnly": "nub run build"
+  },
+  "dependencies": {
+    "@storyshelf/core": "workspace:*",
+    "better-sqlite3": "^12.4.1",
+    "drizzle-orm": "^0.44.0"
+  },
+  "devDependencies": {
+    "@types/better-sqlite3": "^7.6.13",
+    "@types/node": "catalog:",
+    "@vitest/coverage-v8": "catalog:",
+    "oxfmt": "catalog:",
+    "oxlint": "catalog:",
+    "oxlint-tsgolint": "catalog:",
+    "tsdown": "catalog:",
+    "typescript": "catalog:",
+    "vitest": "catalog:"
+  },
+  "types": "./dist/index.d.mts",
+  "exports": {
+    ".": {
+      "source": "./src/index.ts",
+      "default": "./dist/index.mjs"
+    },
+    "./package.json": "./package.json"
+  }
+}