@fedify/sqlite 2.0.0-dev.1908 → 2.0.0-dev.206

package/LICENSE

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

package/README.md

@@ -6,12 +6,12 @@
 
 This package provides a SQLite-based [`KvStore`] implementation for [Fedify].
 
-[JSR]: https://jsr.io/@fedify/sqlite
 [JSR badge]: https://jsr.io/badges/@fedify/sqlite
-[npm]: https://www.npmjs.com/package/@fedify/sqlite
+[JSR]: https://jsr.io/@fedify/sqlite
 [npm badge]: https://img.shields.io/npm/v/@fedify/sqlite?logo=npm
-[Fedify]: https://fedify.dev/
+[npm]: https://www.npmjs.com/package/@fedify/sqlite
 [`KvStore`]: https://jsr.io/@fedify/fedify/doc/federation/~/KvStore
+[Fedify]: https://fedify.dev/
 
 
 Usage

package/deno.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/sqlite",
-  "version": "2.0.0-dev.1908+c31cc639",
+  "version": "2.0.0-dev.206+fa815928",
   "license": "MIT",
   "exports": {
     ".": "./src/mod.ts",
@@ -16,6 +16,7 @@
   ],
   "publish": {
     "exclude": [
+      "**/*.test.ts",
       "!dist/"
     ]
   },

package/dist/kv.cjs

@@ -134,6 +134,36 @@ var SqliteKvStore = class SqliteKvStore {
 		}
 	}
 	/**
+	* {@inheritDoc KvStore.list}
+	* @since 1.10.0
+	*/
+	async *list(prefix) {
+		this.initialize();
+		const now = Temporal.Now.instant().epochMilliseconds;
+		let results;
+		if (prefix == null || prefix.length === 0) results = this.#db.prepare(`
+          SELECT key, value
+          FROM "${this.#tableName}"
+          WHERE expires IS NULL OR expires > ?
+          ORDER BY key
+        `).all(now);
+		else {
+			const pattern = JSON.stringify(prefix).slice(0, -1) + ",%";
+			const exactKey = JSON.stringify(prefix);
+			results = this.#db.prepare(`
+          SELECT key, value
+          FROM "${this.#tableName}"
+          WHERE (key LIKE ? ESCAPE '\\' OR key = ?)
+            AND (expires IS NULL OR expires > ?)
+          ORDER BY key
+        `).all(pattern, exactKey, now);
+		}
+		for (const row of results) yield {
+			key: this.#decodeKey(row.key),
+			value: this.#decodeValue(row.value)
+		};
+	}
+	/**
 	* Creates the table used by the key–value store if it does not already exist.
 	* Does nothing if the table already exists.
 	*/

package/dist/kv.d.cts

@@ -1,5 +1,5 @@
 import { DatabaseSync } from "./dist/sqlite.node.cjs";
-import { KvKey, KvStore, KvStoreSetOptions } from "@fedify/fedify";
+import { KvKey, KvStore, KvStoreListEntry, KvStoreSetOptions } from "@fedify/fedify";
 
 //#region src/kv.d.ts
 /**
@@ -12,12 +12,12 @@ interface SqliteKvStoreOptions {
    * `"fedify_kv"` by default.
    * @default `"fedify_kv"`
    */
-  tableName?: string;
+  readonly tableName?: string;
   /**
    * Whether the table has been initialized.  `false` by default.
    * @default `false`
    */
-  initialized?: boolean;
+  readonly initialized?: boolean;
 }
 /**
  * A key–value store that uses SQLite as the underlying storage.
@@ -61,6 +61,11 @@ declare class SqliteKvStore implements KvStore {
    * {@inheritDoc KvStore.cas}
    */
   cas(key: KvKey, expectedValue: unknown, newValue: unknown, options?: KvStoreSetOptions): Promise<boolean>;
+  /**
+   * {@inheritDoc KvStore.list}
+   * @since 1.10.0
+   */
+  list(prefix?: KvKey): AsyncIterable<KvStoreListEntry>;
   /**
    * Creates the table used by the key–value store if it does not already exist.
    * Does nothing if the table already exists.

package/dist/kv.d.ts

@@ -1,6 +1,6 @@
 import { Temporal } from "@js-temporal/polyfill";
 import { PlatformDatabase } from "#sqlite";
-import { KvKey, KvStore, KvStoreSetOptions } from "@fedify/fedify";
+import { KvKey, KvStore, KvStoreListEntry, KvStoreSetOptions } from "@fedify/fedify";
 
 //#region src/kv.d.ts
 /**
@@ -13,12 +13,12 @@ interface SqliteKvStoreOptions {
    * `"fedify_kv"` by default.
    * @default `"fedify_kv"`
    */
-  tableName?: string;
+  readonly tableName?: string;
   /**
    * Whether the table has been initialized.  `false` by default.
    * @default `false`
    */
-  initialized?: boolean;
+  readonly initialized?: boolean;
 }
 /**
  * A key–value store that uses SQLite as the underlying storage.
@@ -62,6 +62,11 @@ declare class SqliteKvStore implements KvStore {
    * {@inheritDoc KvStore.cas}
    */
   cas(key: KvKey, expectedValue: unknown, newValue: unknown, options?: KvStoreSetOptions): Promise<boolean>;
+  /**
+   * {@inheritDoc KvStore.list}
+   * @since 1.10.0
+   */
+  list(prefix?: KvKey): AsyncIterable<KvStoreListEntry>;
   /**
    * Creates the table used by the key–value store if it does not already exist.
    * Does nothing if the table already exists.

package/dist/kv.js

@@ -133,6 +133,36 @@ var SqliteKvStore = class SqliteKvStore {
 		}
 	}
 	/**
+	* {@inheritDoc KvStore.list}
+	* @since 1.10.0
+	*/
+	async *list(prefix) {
+		this.initialize();
+		const now = Temporal.Now.instant().epochMilliseconds;
+		let results;
+		if (prefix == null || prefix.length === 0) results = this.#db.prepare(`
+          SELECT key, value
+          FROM "${this.#tableName}"
+          WHERE expires IS NULL OR expires > ?
+          ORDER BY key
+        `).all(now);
+		else {
+			const pattern = JSON.stringify(prefix).slice(0, -1) + ",%";
+			const exactKey = JSON.stringify(prefix);
+			results = this.#db.prepare(`
+          SELECT key, value
+          FROM "${this.#tableName}"
+          WHERE (key LIKE ? ESCAPE '\\' OR key = ?)
+            AND (expires IS NULL OR expires > ?)
+          ORDER BY key
+        `).all(pattern, exactKey, now);
+		}
+		for (const row of results) yield {
+			key: this.#decodeKey(row.key),
+			value: this.#decodeValue(row.value)
+		};
+	}
+	/**
 	* Creates the table used by the key–value store if it does not already exist.
 	* Does nothing if the table already exists.
 	*/

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/sqlite",
-  "version": "2.0.0-dev.1908+c31cc639",
+  "version": "2.0.0-dev.206+fa815928",
   "description": "SQLite drivers for Fedify",
   "keywords": [
     "fedify",
@@ -58,11 +58,11 @@
   },
   "dependencies": {
     "@js-temporal/polyfill": "^0.5.1",
-    "@logtape/logtape": "^1.1.1",
+    "@logtape/logtape": "^2.0.0",
     "es-toolkit": "^1.31.0"
   },
   "peerDependencies": {
-    "@fedify/fedify": "^2.0.0-dev.1908+c31cc639"
+    "@fedify/fedify": "^2.0.0-dev.206+fa815928"
   },
   "devDependencies": {
     "@std/async": "npm:@jsr/std__async@^1.0.13",

package/src/kv.test.ts

@@ -1,9 +1,9 @@
 import { PlatformDatabase } from "#sqlite";
+import { SqliteKvStore } from "@fedify/sqlite/kv";
 import * as temporal from "@js-temporal/polyfill";
 import { delay } from "@std/async/delay";
 import assert from "node:assert/strict";
 import { test } from "node:test";
-import { SqliteKvStore } from "@fedify/sqlite/kv";
 
 let Temporal: typeof temporal.Temporal;
 if ("Temporal" in globalThis) {
@@ -310,3 +310,96 @@ test("SqliteKvStore.set() - preserves created timestamp on update", async () =>
     await db.close();
   }
 });
+
+test("SqliteKvStore.list()", async () => {
+  const { db, store } = getStore();
+  try {
+    await store.set(["prefix", "a"], "value-a");
+    await store.set(["prefix", "b"], "value-b");
+    await store.set(["prefix", "nested", "c"], "value-c");
+    await store.set(["other", "x"], "value-x");
+
+    const entries: { key: readonly string[]; value: unknown }[] = [];
+    for await (const entry of store.list(["prefix"])) {
+      entries.push({ key: entry.key, value: entry.value });
+    }
+
+    assert.strictEqual(entries.length, 3);
+    assert(
+      entries.some((e) => e.key[1] === "a" && e.value === "value-a"),
+    );
+    assert(entries.some((e) => e.key[1] === "b"));
+    assert(entries.some((e) => e.key[1] === "nested"));
+  } finally {
+    await store.drop();
+    await db.close();
+  }
+});
+
+test("SqliteKvStore.list() - excludes expired", async () => {
+  const { db, tableName, store } = getStore();
+  try {
+    await store.initialize();
+    const now = Temporal.Now.instant().epochMilliseconds;
+
+    // Insert expired entry directly
+    db.prepare(`
+      INSERT INTO "${tableName}" (key, value, created, expires)
+      VALUES (?, ?, ?, ?)
+    `).run(
+      JSON.stringify(["list-test", "expired"]),
+      JSON.stringify("expired-value"),
+      now - 1000,
+      now - 500,
+    );
+    await store.set(["list-test", "valid"], "valid-value");
+
+    const entries: { key: readonly string[]; value: unknown }[] = [];
+    for await (const entry of store.list(["list-test"])) {
+      entries.push({ key: entry.key, value: entry.value });
+    }
+
+    assert.strictEqual(entries.length, 1);
+    assert.deepStrictEqual(entries[0].key, ["list-test", "valid"]);
+  } finally {
+    await store.drop();
+    await db.close();
+  }
+});
+
+test("SqliteKvStore.list() - single element key", async () => {
+  const { db, store } = getStore();
+  try {
+    await store.set(["a"], "value-a");
+    await store.set(["b"], "value-b");
+
+    const entries: { key: readonly string[]; value: unknown }[] = [];
+    for await (const entry of store.list(["a"])) {
+      entries.push({ key: entry.key, value: entry.value });
+    }
+
+    assert.strictEqual(entries.length, 1);
+  } finally {
+    await store.drop();
+    await db.close();
+  }
+});
+
+test("SqliteKvStore.list() - empty prefix", async () => {
+  const { db, store } = getStore();
+  try {
+    await store.set(["a"], "value-a");
+    await store.set(["b", "c"], "value-bc");
+    await store.set(["d", "e", "f"], "value-def");
+
+    const entries: { key: readonly string[]; value: unknown }[] = [];
+    for await (const entry of store.list()) {
+      entries.push({ key: entry.key, value: entry.value });
+    }
+
+    assert.strictEqual(entries.length, 3);
+  } finally {
+    await store.drop();
+    await db.close();
+  }
+});

package/src/kv.ts

@@ -1,5 +1,10 @@
 import { type PlatformDatabase, SqliteDatabase } from "#sqlite";
-import type { KvKey, KvStore, KvStoreSetOptions } from "@fedify/fedify";
+import type {
+  KvKey,
+  KvStore,
+  KvStoreListEntry,
+  KvStoreSetOptions,
+} from "@fedify/fedify";
 import { getLogger } from "@logtape/logtape";
 import { isEqual } from "es-toolkit";
 import type { SqliteDatabaseAdapter } from "./adapter.ts";
@@ -16,13 +21,13 @@ export interface SqliteKvStoreOptions {
    * `"fedify_kv"` by default.
    * @default `"fedify_kv"`
    */
-  tableName?: string;
+  readonly tableName?: string;
 
   /**
    * Whether the table has been initialized.  `false` by default.
    * @default `false`
    */
-  initialized?: boolean;
+  readonly initialized?: boolean;
 }
 
 /**
@@ -212,6 +217,51 @@ export class SqliteKvStore implements KvStore {
     }
   }
 
+  /**
+   * {@inheritDoc KvStore.list}
+   * @since 1.10.0
+   */
+  async *list(prefix?: KvKey): AsyncIterable<KvStoreListEntry> {
+    this.initialize();
+
+    const now = Temporal.Now.instant().epochMilliseconds;
+
+    let results: { key: string; value: string }[];
+
+    if (prefix == null || prefix.length === 0) {
+      // Empty prefix: return all entries
+      results = this.#db
+        .prepare(`
+          SELECT key, value
+          FROM "${this.#tableName}"
+          WHERE expires IS NULL OR expires > ?
+          ORDER BY key
+        `)
+        .all(now) as { key: string; value: string }[];
+    } else {
+      // JSON pattern: '["prefix","' matches keys starting with prefix
+      const pattern = JSON.stringify(prefix).slice(0, -1) + ",%";
+      const exactKey = JSON.stringify(prefix);
+
+      results = this.#db
+        .prepare(`
+          SELECT key, value
+          FROM "${this.#tableName}"
+          WHERE (key LIKE ? ESCAPE '\\' OR key = ?)
+            AND (expires IS NULL OR expires > ?)
+          ORDER BY key
+        `)
+        .all(pattern, exactKey, now) as { key: string; value: string }[];
+    }
+
+    for (const row of results) {
+      yield {
+        key: this.#decodeKey(row.key),
+        value: this.#decodeValue(row.value),
+      };
+    }
+  }
+
   /**
    * Creates the table used by the key–value store if it does not already exist.
    * Does nothing if the table already exists.