@fedify/sqlite 1.8.1-pr.318.1225

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright 2024–2025 Hong Minhee
+
+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

@@ -0,0 +1,38 @@
+@fedify/sqlite: SQLite drivers for Fedify
+==============
+
+This package provides a SQLite-based key–value store implementation.
+
+## Usage
+
+### Node.js
+
+```typescript
+import { DatabaseSync } from 'node:sqlite';
+import { SqliteKvStore } from '@fedify/sqlite';
+
+const db = new DatabaseSync('./data.db');
+const store = new SqliteKvStore(db);
+```
+
+### Bun
+
+```typescript
+import { Database } from 'bun:sqlite';
+import { SqliteKvStore } from '@fedify/sqlite';
+
+const db = new Database('./data.db');
+const store = new SqliteKvStore(db);
+```
+
+### Deno
+
+For Deno, you can directly import from `@fedify/sqlite` when using the import map in `deno.json`:
+
+```typescript
+import { DB } from 'https://deno.land/x/sqlite@v3.7.0/mod.ts';
+import { SqliteKvStore } from '@fedify/sqlite';
+
+const db = new DB('./data.db');
+const store = new SqliteKvStore(db);
+```

package/adapter.ts

@@ -0,0 +1,44 @@
+/**
+ * SQLite database adapter.
+ *
+ * An abstract interface for SQLite database for different runtime environments.
+ */
+export interface SqliteDatabaseAdapter {
+  /**
+   * Prepares a SQL statement.
+   * @param sql - The SQL statement to prepare.
+   */
+  prepare(sql: string): SqliteStatementAdapter;
+
+  /**
+   * Executes a SQL statement.
+   * @param sql - The SQL statement to execute.
+   */
+  exec(sql: string): void;
+
+  /**
+   * Closes the database connection.
+   */
+  close(): void;
+}
+
+export interface SqliteStatementAdapter {
+  /**
+   * Executes a SQL statement and returns the number of changes made to the database.
+   * @param params - The parameters to bind to the SQL statement.
+   */
+  run(...params: unknown[]): { changes: number; lastInsertRowid: number };
+
+  /**
+   * Executes a SQL statement and returns the first row of the result set.
+   * @param params - The parameters to bind to the SQL statement.
+   * @returns The first row of the result set, or `undefined` if the result set is empty.
+   */
+  get(...params: unknown[]): unknown | undefined;
+
+  /**
+   * Executes a SQL statement and returns all rows of the result set.
+   * @param params - The parameters to bind to the SQL statement.
+   */
+  all(...params: unknown[]): unknown[];
+}

package/deno.json

@@ -0,0 +1,27 @@
+{
+  "name": "@fedify/sqlite",
+  "version": "1.8.1-pr.318.1225+27a86736",
+  "license": "MIT",
+  "exports": {
+    ".": "./mod.ts",
+    "./kv": "./kv.ts"
+  },
+  "imports": {
+    "@fedify/sqlite": "./mod.ts",
+    "@fedify/sqlite/": "./",
+    "#sqlite": "./sqlite.node.ts"
+  },
+  "exclude": [
+    "node_modules",
+    "sqlite.bun.ts"
+  ],
+  "publish": {
+    "exclude": [
+      "!dist/"
+    ]
+  },
+  "tasks": {
+    "check": "deno fmt --check && deno lint && deno check *.ts",
+    "test": "deno test --allow-net --allow-env --doc --no-check=leaks"
+  }
+}

package/dist/_virtual/rolldown_runtime.js

@@ -0,0 +1,30 @@
+
+import { Temporal } from "@js-temporal/polyfill";
+    
+//#region rolldown:runtime
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __commonJS = (cb, mod) => function() {
+	return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
+};
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+		key = keys[i];
+		if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
+			get: ((k) => from[k]).bind(null, key),
+			enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+		});
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
+
+//#endregion
+export { __commonJS, __toESM };

package/dist/adapter.d.ts

@@ -0,0 +1,48 @@
+import { Temporal } from "@js-temporal/polyfill";
+
+//#region adapter.d.ts
+
+/**
+ * SQLite database adapter.
+ *
+ * An abstract interface for SQLite database for different runtime environments.
+ */
+interface SqliteDatabaseAdapter {
+  /**
+   * Prepares a SQL statement.
+   * @param sql - The SQL statement to prepare.
+   */
+  prepare(sql: string): SqliteStatementAdapter;
+  /**
+   * Executes a SQL statement.
+   * @param sql - The SQL statement to execute.
+   */
+  exec(sql: string): void;
+  /**
+   * Closes the database connection.
+   */
+  close(): void;
+}
+interface SqliteStatementAdapter {
+  /**
+   * Executes a SQL statement and returns the number of changes made to the database.
+   * @param params - The parameters to bind to the SQL statement.
+   */
+  run(...params: unknown[]): {
+    changes: number;
+    lastInsertRowid: number;
+  };
+  /**
+   * Executes a SQL statement and returns the first row of the result set.
+   * @param params - The parameters to bind to the SQL statement.
+   * @returns The first row of the result set, or `undefined` if the result set is empty.
+   */
+  get(...params: unknown[]): unknown | undefined;
+  /**
+   * Executes a SQL statement and returns all rows of the result set.
+   * @param params - The parameters to bind to the SQL statement.
+   */
+  all(...params: unknown[]): unknown[];
+}
+//#endregion
+export { SqliteDatabaseAdapter, SqliteStatementAdapter };

package/dist/kv.d.ts

@@ -0,0 +1,72 @@
+import { Temporal } from "@js-temporal/polyfill";
+import { PlatformDatabase } from "#sqlite";
+import { KvKey, KvStore, KvStoreSetOptions } from "@fedify/fedify";
+
+//#region kv.d.ts
+/**
+ * Options for the SQLite key–value store.
+ */
+interface SqliteKvStoreOptions {
+  /**
+   * The table name to use for the key–value store.
+   * Only letters, digits, and underscores are allowed.
+   * `"fedify_kv"` by default.
+   * @default `"fedify_kv"`
+   */
+  tableName?: string;
+  /**
+   * Whether the table has been initialized.  `false` by default.
+   * @default `false`
+   */
+  initialized?: boolean;
+}
+/**
+ * A key–value store that uses SQLite as the underlying storage.
+ *
+ * @example
+ * ```ts
+ * import { createFederation } from "@fedify/fedify";
+ * import { SqliteKvStore } from "@fedify/sqlite";
+ * import { DatabaseSync } from "node:sqlite";
+ *
+ * const db = new DatabaseSync(":memory:");
+ * const federation = createFederation({
+ *   // ...
+ *   kv: new SqliteKvStore(db),
+ * });
+ * ```
+ */
+declare class SqliteKvStore implements KvStore {
+  #private;
+  readonly db: PlatformDatabase;
+  readonly options: SqliteKvStoreOptions;
+  constructor(db: PlatformDatabase, options?: SqliteKvStoreOptions);
+  /**
+   * {@inheritDoc KvStore.get}
+   */
+  get<T = unknown>(key: KvKey): Promise<T | undefined>;
+  /**
+   * {@inheritDoc KvStore.set}
+   */
+  set(key: KvKey, value: unknown, options?: KvStoreSetOptions): Promise<void>;
+  /**
+   * {@inheritDoc KvStore.delete}
+   */
+  delete(key: KvKey): Promise<void>;
+  /**
+   * {@inheritDoc KvStore.cas}
+   */
+  cas(key: KvKey, expectedValue: unknown, newValue: unknown, options?: KvStoreSetOptions): Promise<boolean>;
+  /**
+   * Creates the table used by the key–value store if it does not already exist.
+   * Does nothing if the table already exists.
+   */
+  initialize(): void;
+  /**
+   * Drops the table used by the key–value store.  Does nothing if the table
+   * does not exist.
+   */
+  drop(): void;
+}
+//#endregion
+export { SqliteKvStore, SqliteKvStoreOptions };

package/dist/kv.js

@@ -0,0 +1,183 @@
+
+import { Temporal } from "@js-temporal/polyfill";
+    
+import { qi } from "./node_modules/.pnpm/@js-temporal_polyfill@0.5.1/node_modules/@js-temporal/polyfill/dist/index.esm.js";
+import { SqliteDatabase } from "#sqlite";
+import { getLogger } from "@logtape/logtape";
+import { isEqual } from "es-toolkit";
+
+//#region kv.ts
+const logger = getLogger([
+	"fedify",
+	"sqlite",
+	"kv"
+]);
+/**
+* A key–value store that uses SQLite as the underlying storage.
+*
+* @example
+* ```ts
+* import { createFederation } from "@fedify/fedify";
+* import { SqliteKvStore } from "@fedify/sqlite";
+* import { DatabaseSync } from "node:sqlite";
+*
+* const db = new DatabaseSync(":memory:");
+* const federation = createFederation({
+*   // ...
+*   kv: new SqliteKvStore(db),
+* });
+* ```
+*/
+var SqliteKvStore = class SqliteKvStore {
+	static #defaultTableName = "fedify_kv";
+	static #tableNameRegex = /^[A-Za-z_][A-Za-z0-9_]{0,63}$/;
+	#db;
+	#tableName;
+	#initialized;
+	constructor(db, options = {}) {
+		this.db = db;
+		this.options = options;
+		this.#db = new SqliteDatabase(db);
+		this.#initialized = options.initialized ?? false;
+		this.#tableName = options.tableName ?? SqliteKvStore.#defaultTableName;
+		if (!SqliteKvStore.#tableNameRegex.test(this.#tableName)) throw new Error(`Invalid table name for the key–value store: ${this.#tableName}`);
+	}
+	/**
+	* {@inheritDoc KvStore.get}
+	*/
+	async get(key) {
+		this.initialize();
+		const encodedKey = this.#encodeKey(key);
+		const now = qi.Now.instant().epochMilliseconds;
+		const result = this.#db.prepare(`
+      SELECT value 
+      FROM "${this.#tableName}" 
+      WHERE key = ? AND (expires IS NULL OR expires > ?)
+    `).get(encodedKey, now);
+		if (!result) return void 0;
+		return this.#decodeValue(result.value);
+	}
+	/**
+	* {@inheritDoc KvStore.set}
+	*/
+	async set(key, value, options) {
+		this.initialize();
+		if (value === void 0) return;
+		const encodedKey = this.#encodeKey(key);
+		const encodedValue = this.#encodeValue(value);
+		const now = qi.Now.instant().epochMilliseconds;
+		const expiresAt = options?.ttl !== void 0 ? now + options.ttl.total({ unit: "milliseconds" }) : null;
+		this.#db.prepare(`INSERT INTO "${this.#tableName}" (key, value, created, expires)
+        VALUES (?, ?, ?, ?)
+        ON CONFLICT(key) DO UPDATE SET
+          value = excluded.value,
+          expires = excluded.expires`).run(encodedKey, encodedValue, now, expiresAt);
+		this.#expire();
+		return;
+	}
+	/**
+	* {@inheritDoc KvStore.delete}
+	*/
+	async delete(key) {
+		this.initialize();
+		const encodedKey = this.#encodeKey(key);
+		this.#db.prepare(`
+      DELETE FROM "${this.#tableName}" WHERE key = ?
+    `).run(encodedKey);
+		this.#expire();
+		return Promise.resolve();
+	}
+	/**
+	* {@inheritDoc KvStore.cas}
+	*/
+	async cas(key, expectedValue, newValue, options) {
+		this.initialize();
+		const encodedKey = this.#encodeKey(key);
+		const now = qi.Now.instant().epochMilliseconds;
+		const expiresAt = options?.ttl !== void 0 ? now + options.ttl.total({ unit: "milliseconds" }) : null;
+		try {
+			this.#db.exec("BEGIN IMMEDIATE");
+			const currentResult = this.#db.prepare(`
+          SELECT value 
+          FROM "${this.#tableName}" 
+          WHERE key = ? AND (expires IS NULL OR expires > ?)
+        `).get(encodedKey, now);
+			const currentValue = currentResult === void 0 ? void 0 : this.#decodeValue(currentResult.value);
+			if (!isEqual(currentValue, expectedValue)) {
+				this.#db.exec("ROLLBACK");
+				return false;
+			}
+			if (newValue === void 0) this.#db.prepare(`
+            DELETE FROM "${this.#tableName}" WHERE key = ?
+          `).run(encodedKey);
+			else {
+				const newValueJson = this.#encodeValue(newValue);
+				this.#db.prepare(`
+          INSERT INTO "${this.#tableName}" (key, value, created, expires)
+          VALUES (?, ?, ?, ?)
+          ON CONFLICT(key) DO UPDATE SET
+            value = excluded.value,
+            expires = excluded.expires
+          `).run(encodedKey, newValueJson, now, expiresAt);
+			}
+			this.#db.exec("COMMIT");
+			this.#expire();
+			return true;
+		} catch (error) {
+			this.#db.exec("ROLLBACK");
+			throw error;
+		}
+	}
+	/**
+	* Creates the table used by the key–value store if it does not already exist.
+	* Does nothing if the table already exists.
+	*/
+	initialize() {
+		if (this.#initialized) return;
+		logger.debug("Initializing the key–value store table {tableName}...", { tableName: this.#tableName });
+		this.#db.exec(`
+      CREATE TABLE IF NOT EXISTS "${this.#tableName}" (
+        key TEXT PRIMARY KEY,
+        value TEXT NOT NULL,
+        created INTEGER NOT NULL,
+        expires INTEGER
+      )
+    `);
+		this.#db.exec(`
+      CREATE INDEX IF NOT EXISTS "idx_${this.#tableName}_expires" 
+      ON "${this.#tableName}" (expires)
+    `);
+		this.#initialized = true;
+		logger.debug("Initialized the key–value store table {tableName}.", { tableName: this.#tableName });
+	}
+	#expire() {
+		const now = qi.Now.instant().epochMilliseconds;
+		this.#db.prepare(`
+      DELETE FROM "${this.#tableName}"
+      WHERE expires IS NOT NULL AND expires <= ?
+    `).run(now);
+	}
+	/**
+	* Drops the table used by the key–value store.  Does nothing if the table
+	* does not exist.
+	*/
+	drop() {
+		this.#db.exec(`DROP TABLE IF EXISTS "${this.#tableName}"`);
+		this.#initialized = false;
+	}
+	#encodeKey(key) {
+		return JSON.stringify(key);
+	}
+	#decodeKey(key) {
+		return JSON.parse(key);
+	}
+	#encodeValue(value) {
+		return JSON.stringify(value);
+	}
+	#decodeValue(value) {
+		return JSON.parse(value);
+	}
+};
+
+//#endregion
+export { SqliteKvStore };

package/dist/mod.d.ts

@@ -0,0 +1,3 @@
+import { Temporal } from "@js-temporal/polyfill";
+import { SqliteKvStore } from "./kv.js";
+export { SqliteKvStore };

package/dist/mod.js

@@ -0,0 +1,6 @@
+
+import { Temporal } from "@js-temporal/polyfill";
+    
+import { SqliteKvStore } from "./kv.js";
+
+export { SqliteKvStore };