@fedify/postgres 2.0.0-dev.1875 → 2.0.0-dev.196

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

@@ -25,10 +25,10 @@ const federation = createFederation({
 });
 ~~~~
 
-[JSR]: https://jsr.io/@fedify/postgres
 [JSR badge]: https://jsr.io/badges/@fedify/postgres
-[npm]: https://www.npmjs.com/package/@fedify/postgres
+[JSR]: https://jsr.io/@fedify/postgres
 [npm badge]: https://img.shields.io/npm/v/@fedify/postgres?logo=npm
+[npm]: https://www.npmjs.com/package/@fedify/postgres
 [Fedify]: https://fedify.dev/
 [`KvStore`]: https://jsr.io/@fedify/fedify/doc/federation/~/KvStore
 [`MessageQueue`]: https://jsr.io/@fedify/fedify/doc/federation/~/MessageQueue

package/dist/kv.cjs

@@ -81,6 +81,35 @@ var PostgresKvStore = class {
 		await this.#expire();
 	}
 	/**
+	* {@inheritDoc KvStore.list}
+	* @since 1.10.0
+	*/
+	async *list(prefix) {
+		await this.initialize();
+		let results;
+		if (prefix == null || prefix.length === 0) results = await this.#sql`
+        SELECT key, value
+        FROM ${this.#sql(this.#tableName)}
+        WHERE ttl IS NULL OR created + ttl > CURRENT_TIMESTAMP
+        ORDER BY key
+      `;
+		else {
+			const prefixLength = prefix.length;
+			results = await this.#sql`
+        SELECT key, value
+        FROM ${this.#sql(this.#tableName)}
+        WHERE array_length(key, 1) >= ${prefixLength}
+          AND key[1:${prefixLength}] = ${prefix}::text[]
+          AND (ttl IS NULL OR created + ttl > CURRENT_TIMESTAMP)
+        ORDER BY key
+      `;
+		}
+		for (const row of results) yield {
+			key: row.key,
+			value: 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,4 +1,4 @@
-import { KvKey, KvStore, KvStoreSetOptions } from "@fedify/fedify";
+import { KvKey, KvStore, KvStoreListEntry, KvStoreSetOptions } from "@fedify/fedify";
 import { Sql } from "postgres";
 
 //#region src/kv.d.ts
@@ -11,12 +11,12 @@ interface PostgresKvStoreOptions {
    * `"fedify_kv_v2"` by default.
    * @default `"fedify_kv_v2"`
    */
-  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 PostgreSQL as the underlying storage.
@@ -44,6 +44,11 @@ declare class PostgresKvStore implements KvStore {
   get<T = unknown>(key: KvKey): Promise<T | undefined>;
   set(key: KvKey, value: unknown, options?: KvStoreSetOptions | undefined): Promise<void>;
   delete(key: KvKey): Promise<void>;
+  /**
+   * {@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 { Sql } from "postgres";
-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 PostgresKvStoreOptions {
    * `"fedify_kv_v2"` by default.
    * @default `"fedify_kv_v2"`
    */
-  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 PostgreSQL as the underlying storage.
@@ -45,6 +45,11 @@ declare class PostgresKvStore implements KvStore {
   get<T = unknown>(key: KvKey): Promise<T | undefined>;
   set(key: KvKey, value: unknown, options?: KvStoreSetOptions | undefined): Promise<void>;
   delete(key: KvKey): Promise<void>;
+  /**
+   * {@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

@@ -80,6 +80,35 @@ var PostgresKvStore = class {
 		await this.#expire();
 	}
 	/**
+	* {@inheritDoc KvStore.list}
+	* @since 1.10.0
+	*/
+	async *list(prefix) {
+		await this.initialize();
+		let results;
+		if (prefix == null || prefix.length === 0) results = await this.#sql`
+        SELECT key, value
+        FROM ${this.#sql(this.#tableName)}
+        WHERE ttl IS NULL OR created + ttl > CURRENT_TIMESTAMP
+        ORDER BY key
+      `;
+		else {
+			const prefixLength = prefix.length;
+			results = await this.#sql`
+        SELECT key, value
+        FROM ${this.#sql(this.#tableName)}
+        WHERE array_length(key, 1) >= ${prefixLength}
+          AND key[1:${prefixLength}] = ${prefix}::text[]
+          AND (ttl IS NULL OR created + ttl > CURRENT_TIMESTAMP)
+        ORDER BY key
+      `;
+		}
+		for (const row of results) yield {
+			key: row.key,
+			value: 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/mq.d.cts

@@ -11,23 +11,23 @@ interface PostgresMessageQueueOptions {
    * `"fedify_message_v2"` by default.
    * @default `"fedify_message_v2"`
    */
-  tableName?: string;
+  readonly tableName?: string;
   /**
    * The channel name to use for the message queue.
    * `"fedify_channel"` by default.
    * @default `"fedify_channel"`
    */
-  channelName?: string;
+  readonly channelName?: string;
   /**
    * Whether the table has been initialized.  `false` by default.
    * @default `false`
    */
-  initialized?: boolean;
+  readonly initialized?: boolean;
   /**
    * The poll interval for the message queue.  5 seconds by default.
    * @default `{ seconds: 5 }`
    */
-  pollInterval?: Temporal.Duration | Temporal.DurationLike;
+  readonly pollInterval?: Temporal.Duration | Temporal.DurationLike;
 }
 /**
  * A message queue that uses PostgreSQL as the underlying storage.
@@ -50,7 +50,7 @@ declare class PostgresMessageQueue implements MessageQueue {
   #private;
   constructor(sql: Sql<{}>, options?: PostgresMessageQueueOptions);
   enqueue(message: any, options?: MessageQueueEnqueueOptions): Promise<void>;
-  enqueueMany(messages: any[], options?: MessageQueueEnqueueOptions): Promise<void>;
+  enqueueMany(messages: readonly any[], options?: MessageQueueEnqueueOptions): Promise<void>;
   listen(handler: (message: any) => void | Promise<void>, options?: MessageQueueListenOptions): Promise<void>;
   /**
    * Initializes the message queue table if it does not already exist.

package/dist/mq.d.ts

@@ -12,23 +12,23 @@ interface PostgresMessageQueueOptions {
    * `"fedify_message_v2"` by default.
    * @default `"fedify_message_v2"`
    */
-  tableName?: string;
+  readonly tableName?: string;
   /**
    * The channel name to use for the message queue.
    * `"fedify_channel"` by default.
    * @default `"fedify_channel"`
    */
-  channelName?: string;
+  readonly channelName?: string;
   /**
    * Whether the table has been initialized.  `false` by default.
    * @default `false`
    */
-  initialized?: boolean;
+  readonly initialized?: boolean;
   /**
    * The poll interval for the message queue.  5 seconds by default.
    * @default `{ seconds: 5 }`
    */
-  pollInterval?: Temporal.Duration | Temporal.DurationLike;
+  readonly pollInterval?: Temporal.Duration | Temporal.DurationLike;
 }
 /**
  * A message queue that uses PostgreSQL as the underlying storage.
@@ -51,7 +51,7 @@ declare class PostgresMessageQueue implements MessageQueue {
   #private;
   constructor(sql: Sql<{}>, options?: PostgresMessageQueueOptions);
   enqueue(message: any, options?: MessageQueueEnqueueOptions): Promise<void>;
-  enqueueMany(messages: any[], options?: MessageQueueEnqueueOptions): Promise<void>;
+  enqueueMany(messages: readonly any[], options?: MessageQueueEnqueueOptions): Promise<void>;
   listen(handler: (message: any) => void | Promise<void>, options?: MessageQueueListenOptions): Promise<void>;
   /**
    * Initializes the message queue table if it does not already exist.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/postgres",
-  "version": "2.0.0-dev.1875+d712d60c",
+  "version": "2.0.0-dev.196+c3cfc0a9",
   "description": "PostgreSQL drivers for Fedify",
   "keywords": [
     "fedify",
@@ -70,11 +70,11 @@
   ],
   "dependencies": {
     "@js-temporal/polyfill": "^0.5.1",
-    "@logtape/logtape": "^1.1.1"
+    "@logtape/logtape": "^2.0.0"
   },
   "peerDependencies": {
     "postgres": "^3.4.7",
-    "@fedify/fedify": "^2.0.0-dev.1875+d712d60c"
+    "@fedify/fedify": "^2.0.0-dev.196+c3cfc0a9"
   },
   "devDependencies": {
     "@std/async": "npm:@jsr/std__async@^1.0.13",