@unikvs/redis.bun 0.0.0-stage → 0.0.13

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026-present, tai-kun
+
+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

@@ -1,3 +1,3 @@
-# Temporary Holding Version
+# @unikvs/redis.bun
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[Document](https://tai-kun.github.io/unikvs/)

package/dist/index.d.ts

@@ -0,0 +1,40 @@
+import { IStorage, KeyNotFoundError, KeyNotFoundErrorArgs, KeyNotFoundErrorMeta, UnsupportedRuntimeError } from "@unikvs/core";
+import { RedisOptions } from "bun";
+//#region ../src/redis.d.ts
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-bun#redisstorageoptions)
+ */
+type RedisStorageOptions = RedisOptions & {
+  /**
+   * すべてのキーの先頭に付与するプレフィックスです。
+   *
+   * キーを名前空間で分離し、`clear()` が削除する範囲を限定します。空文字を指定するとキーをそのまま使います。
+   *
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-bun#redisstorageoptions-keyprefix)
+   */
+  readonly keyPrefix?: string;
+};
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-bun#redis)
+ */
+declare class Redis implements IStorage {
+  #private;
+  readonly name: string;
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-bun#redis)
+   */
+  constructor(url?: string, options?: RedisStorageOptions);
+  get isOpen(): boolean;
+  open(_c: IStorage.OpenContext): Promise<void>;
+  close(_c: IStorage.CloseContext): void;
+  write(c: IStorage.WriteContext, data: Uint8Array<ArrayBuffer>): Promise<void>;
+  read(c: IStorage.ReadContext): Promise<Uint8Array<ArrayBuffer>>;
+  exists(c: IStorage.ExistsContext): Promise<boolean>;
+  delete(c: IStorage.DeleteContext): Promise<void>;
+  clear(c: IStorage.ClearContext): Promise<void>;
+  getWritable(c: IStorage.GetWritableContext): WritableStream<Uint8Array<ArrayBuffer>>;
+  getReadable(c: IStorage.GetReadableContext): ReadableStream<Uint8Array<ArrayBuffer>>;
+}
+//#endregion
+export { KeyNotFoundError, type KeyNotFoundErrorArgs, type KeyNotFoundErrorMeta, Redis, type RedisStorageOptions, UnsupportedRuntimeError };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/redis.ts"],"mappings":";;;;;;KAMY,sBAAsB;;;;;;;;WAQvB;;;;;cAsBU,iBAAiB;;WAyBpB;;;;EAKhB,YAAmB,cAAc,UAAS;MAU/B;EAcX,KAAkB,IAAI,SAAS,cAAc;EA4B7C,MAAa,IAAI,SAAS;EAY1B,MAAmB,GAAG,SAAS,cAAc,MAAM,WAAW,eAAe;EAS7E,KAAkB,GAAG,SAAS,cAAc,QAAQ,WAAW;EAe/D,OAAoB,GAAG,SAAS,gBAAgB;EAShD,OAAoB,GAAG,SAAS,gBAAgB;EAShD,MAAmB,GAAG,SAAS,eAAe;EAuB9C,YAAmB,GAAG,SAAS,qBAAqB,eAAe,WAAW;EA0E9E,YAAmB,GAAG,SAAS,qBAAqB,eAAe,WAAW"}

package/dist/index.js

@@ -0,0 +1,212 @@
+import { KeyNotFoundError, KeyNotFoundError as KeyNotFoundError$1, UnsupportedRuntimeError, UnsupportedRuntimeError as UnsupportedRuntimeError$1 } from "@unikvs/core";
+//#region \0@oxc-project+runtime@0.154.0/helpers/esm/checkPrivateRedeclaration.js
+function _checkPrivateRedeclaration(e, t) {
+	if (t.has(e)) throw new TypeError("Cannot initialize the same private elements twice on an object");
+}
+//#endregion
+//#region \0@oxc-project+runtime@0.154.0/helpers/esm/classPrivateMethodInitSpec.js
+function _classPrivateMethodInitSpec(e, a) {
+	_checkPrivateRedeclaration(e, a), a.add(e);
+}
+//#endregion
+//#region \0@oxc-project+runtime@0.154.0/helpers/esm/classPrivateFieldInitSpec.js
+function _classPrivateFieldInitSpec(e, t, a) {
+	_checkPrivateRedeclaration(e, t), t.set(e, a);
+}
+//#endregion
+//#region \0@oxc-project+runtime@0.154.0/helpers/esm/assertClassBrand.js
+function _assertClassBrand(e, t, n) {
+	if ("function" == typeof e ? e === t : e.has(t)) return arguments.length < 3 ? t : n;
+	throw new TypeError("Private element is not present on this object");
+}
+//#endregion
+//#region \0@oxc-project+runtime@0.154.0/helpers/esm/classPrivateFieldSet2.js
+function _classPrivateFieldSet2(s, a, r) {
+	return s.set(_assertClassBrand(s, a), r), r;
+}
+//#endregion
+//#region \0@oxc-project+runtime@0.154.0/helpers/esm/classPrivateFieldGet2.js
+function _classPrivateFieldGet2(s, a) {
+	return s.get(_assertClassBrand(s, a));
+}
+//#endregion
+//#region ../src/redis.ts
+/**
+* Redis の `SCAN` 1 回あたりにヒントとして渡すキー数です。
+* 削除の往復回数と 1 回の `DEL` に渡す引数数を抑えるために使用します。
+*/
+const SCAN_COUNT = 1e3;
+var _con = /* @__PURE__ */ new WeakMap();
+var _url = /* @__PURE__ */ new WeakMap();
+var _options = /* @__PURE__ */ new WeakMap();
+var _keyPrefix = /* @__PURE__ */ new WeakMap();
+var _Redis_brand = /* @__PURE__ */ new WeakSet();
+/**
+* [API Reference](https://tai-kun.github.io/unikvs/packages/redis-bun#redis)
+*/
+var Redis = class {
+	/**
+	* [API Reference](https://tai-kun.github.io/unikvs/packages/redis-bun#redis)
+	*/
+	constructor(url, options = {}) {
+		_classPrivateMethodInitSpec(this, _Redis_brand);
+		_classPrivateFieldInitSpec(this, _con, void 0);
+		_classPrivateFieldInitSpec(this, _url, void 0);
+		_classPrivateFieldInitSpec(this, _options, void 0);
+		_classPrivateFieldInitSpec(this, _keyPrefix, void 0);
+		const { keyPrefix = "unikvs:", ...redisOptions } = options;
+		this.name = "Redis";
+		_classPrivateFieldSet2(_con, this, null);
+		_classPrivateFieldSet2(_url, this, url);
+		_classPrivateFieldSet2(_options, this, redisOptions);
+		_classPrivateFieldSet2(_keyPrefix, this, keyPrefix);
+	}
+	get isOpen() {
+		return _classPrivateFieldGet2(_con, this) !== null;
+	}
+	async open(_c) {
+		if (typeof Bun === "undefined") throw new UnsupportedRuntimeError$1({
+			name: this.name,
+			runtime: "Bun"
+		});
+		if (_classPrivateFieldGet2(_con, this)) this.close(_c);
+		const { RedisClient: RedisClientImpl } = await import("bun");
+		const client = new RedisClientImpl(_classPrivateFieldGet2(_url, this), _classPrivateFieldGet2(_options, this));
+		try {
+			await client.connect();
+		} catch (ex) {
+			client.close();
+			throw ex;
+		}
+		_classPrivateFieldSet2(_con, this, { client });
+	}
+	close(_c) {
+		_assertClassBrand(_Redis_brand, this, _getConnection).call(this).client.close();
+		_classPrivateFieldSet2(_con, this, null);
+	}
+	async write(c, data) {
+		const { client } = _assertClassBrand(_Redis_brand, this, _getConnection).call(this);
+		c.signal.throwIfAborted();
+		await client.set(_assertClassBrand(_Redis_brand, this, _toKey).call(this, c.key), data);
+	}
+	async read(c) {
+		const { client } = _assertClassBrand(_Redis_brand, this, _getConnection).call(this);
+		c.signal.throwIfAborted();
+		const data = await client.getBuffer(_assertClassBrand(_Redis_brand, this, _toKey).call(this, c.key));
+		if (data === null) throw new KeyNotFoundError$1({ key: c.key });
+		return new Uint8Array(data);
+	}
+	async exists(c) {
+		const { client } = _assertClassBrand(_Redis_brand, this, _getConnection).call(this);
+		c.signal.throwIfAborted();
+		return client.exists(_assertClassBrand(_Redis_brand, this, _toKey).call(this, c.key));
+	}
+	async delete(c) {
+		const { client } = _assertClassBrand(_Redis_brand, this, _getConnection).call(this);
+		c.signal.throwIfAborted();
+		await client.del(_assertClassBrand(_Redis_brand, this, _toKey).call(this, c.key));
+	}
+	async clear(c) {
+		const { client } = _assertClassBrand(_Redis_brand, this, _getConnection).call(this);
+		c.signal.throwIfAborted();
+		const pattern = `${_classPrivateFieldGet2(_keyPrefix, this)}*`;
+		let cursor = "0";
+		do {
+			c.signal.throwIfAborted();
+			const [nextCursor, keys] = await client.scan(cursor, "MATCH", pattern, "COUNT", SCAN_COUNT);
+			if (keys.length > 0) await client.del(...keys);
+			cursor = nextCursor;
+		} while (cursor !== "0");
+	}
+	getWritable(c) {
+		const { client } = _assertClassBrand(_Redis_brand, this, _getConnection).call(this);
+		c.signal.throwIfAborted();
+		const dest = _assertClassBrand(_Redis_brand, this, _toKey).call(this, c.key);
+		const tmp = `${dest}.${Bun.randomUUIDv7()}.tmp`;
+		let finished = false;
+		const removeAbortListener = () => {
+			c.signal.removeEventListener("abort", onAbort);
+		};
+		const discardTemporary = async () => {
+			try {
+				await client.del(tmp);
+			} catch {}
+		};
+		const finish = async () => {
+			if (finished) return;
+			finished = true;
+			removeAbortListener();
+			await discardTemporary();
+		};
+		const onAbort = () => {
+			finish();
+		};
+		c.signal.addEventListener("abort", onAbort, { once: true });
+		return new WritableStream({
+			async abort() {
+				await finish();
+			},
+			async close() {
+				c.signal.throwIfAborted();
+				try {
+					await client.rename(tmp, dest);
+				} catch (ex) {
+					await finish();
+					throw ex;
+				}
+				finished = true;
+				removeAbortListener();
+			},
+			async start() {
+				try {
+					c.signal.throwIfAborted();
+					await client.set(tmp, "");
+				} catch (ex) {
+					await finish();
+					throw ex;
+				}
+			},
+			async write(chunk) {
+				c.signal.throwIfAborted();
+				try {
+					await client.append(tmp, chunk);
+				} catch (ex) {
+					await finish();
+					throw ex;
+				}
+			}
+		});
+	}
+	getReadable(c) {
+		const { client } = _assertClassBrand(_Redis_brand, this, _getConnection).call(this);
+		c.signal.throwIfAborted();
+		const dest = _assertClassBrand(_Redis_brand, this, _toKey).call(this, c.key);
+		let sent = false;
+		return new ReadableStream({ async pull(controller) {
+			if (sent) {
+				controller.close();
+				return;
+			}
+			sent = true;
+			c.signal.throwIfAborted();
+			const data = await client.getBuffer(dest);
+			if (data === null) throw new KeyNotFoundError$1({ key: c.key });
+			controller.enqueue(new Uint8Array(data));
+			controller.close();
+		} });
+	}
+};
+function _getConnection() {
+	if (_classPrivateFieldGet2(_con, this) === null) throw new TypeError("Redis is not open. Call open() first.");
+	return _classPrivateFieldGet2(_con, this);
+}
+/**
+* unikvs のキーにプレフィックスを付与し、Redis のキーへ変換します。
+*/
+function _toKey(key) {
+	return `${_classPrivateFieldGet2(_keyPrefix, this)}${key}`;
+}
+//#endregion
+export { KeyNotFoundError, Redis, UnsupportedRuntimeError };
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["UnsupportedRuntimeError","KeyNotFoundError"],"sources":["../src/redis.ts"],"sourcesContent":["import { type IStorage, KeyNotFoundError, UnsupportedRuntimeError } from \"@unikvs/core\";\nimport type { RedisClient, RedisOptions } from \"bun\";\n\n/**\n * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-bun#redisstorageoptions)\n */\nexport type RedisStorageOptions = RedisOptions & {\n  /**\n   * すべてのキーの先頭に付与するプレフィックスです。\n   *\n   * キーを名前空間で分離し、`clear()` が削除する範囲を限定します。空文字を指定するとキーをそのまま使います。\n   *\n   * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-bun#redisstorageoptions-keyprefix)\n   */\n  readonly keyPrefix?: string;\n};\n\n/**\n * ストレージの動作に必要な接続を保持する型定義です。\n */\ntype Connection = {\n  /**\n   * Bun の Redis クライアントです。\n   */\n  readonly client: RedisClient;\n};\n\n/**\n * Redis の `SCAN` 1 回あたりにヒントとして渡すキー数です。\n * 削除の往復回数と 1 回の `DEL` に渡す引数数を抑えるために使用します。\n */\nconst SCAN_COUNT = 1000;\n\n/**\n * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-bun#redis)\n */\nexport default class Redis implements IStorage {\n  /**\n   * Redis クライアントのインスタンスを保持します。\n   *\n   * ストレージがオープンされるまで null です。\n   */\n  #con: Connection | null;\n\n  /**\n   * 接続先の URL です。\n   *\n   * 未指定の場合はクライアントが環境変数 (`REDIS_URL`、`VALKEY_URL`) から解決します。\n   */\n  readonly #url: string | undefined;\n\n  /**\n   * `RedisClient` の初期化に使用する設定オブジェクトです。\n   */\n  readonly #options: RedisOptions;\n\n  /**\n   * すべてのキーの先頭に付与するプレフィックスです。\n   */\n  readonly #keyPrefix: string;\n\n  public readonly name: string;\n\n  /**\n   * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-bun#redis)\n   */\n  public constructor(url?: string, options: RedisStorageOptions = {}) {\n    const { keyPrefix = \"unikvs:\", ...redisOptions } = options;\n\n    this.name = \"Redis\";\n    this.#con = null;\n    this.#url = url;\n    this.#options = redisOptions;\n    this.#keyPrefix = keyPrefix;\n  }\n\n  public get isOpen(): boolean {\n    return this.#con !== null;\n  }\n\n  // オープン済みかを確認します。\n  // 未オープン時は `TypeError` を投げます。\n  #getConnection(): Connection {\n    if (this.#con === null) {\n      throw new TypeError(\"Redis is not open. Call open() first.\");\n    }\n\n    return this.#con;\n  }\n\n  public async open(_c: IStorage.OpenContext): Promise<void> {\n    // Bun 以外のランタイムで誤って使われた場合に、原因の分かるエラーを返します。\n    if (typeof Bun === \"undefined\") {\n      throw new UnsupportedRuntimeError({\n        name: this.name,\n        runtime: \"Bun\",\n      });\n    }\n\n    // オープン済みの場合は古い接続を閉じ、開き直しでリークしないようにします。\n    if (this.#con) {\n      this.close(_c as unknown as IStorage.CloseContext);\n    }\n\n    const { RedisClient: RedisClientImpl } = await import(\"bun\");\n    const client = new RedisClientImpl(this.#url, this.#options);\n\n    try {\n      // 最初のコマンドまで接続しないクライアントのため、open の時点で接続を確立します。\n      await client.connect();\n    } catch (ex) {\n      client.close();\n      throw ex;\n    }\n\n    this.#con = { client };\n  }\n\n  public close(_c: IStorage.CloseContext): void {\n    this.#getConnection().client.close();\n    this.#con = null;\n  }\n\n  /**\n   * unikvs のキーにプレフィックスを付与し、Redis のキーへ変換します。\n   */\n  #toKey(key: string): string {\n    return `${this.#keyPrefix}${key}`;\n  }\n\n  public async write(c: IStorage.WriteContext, data: Uint8Array<ArrayBuffer>): Promise<void> {\n    const { client } = this.#getConnection();\n\n    c.signal.throwIfAborted();\n\n    // Bun のクライアントは ArrayBufferView をそのままバイナリーとして送信します。\n    await client.set(this.#toKey(c.key), data);\n  }\n\n  public async read(c: IStorage.ReadContext): Promise<Uint8Array<ArrayBuffer>> {\n    const { client } = this.#getConnection();\n\n    c.signal.throwIfAborted();\n\n    const data = await client.getBuffer(this.#toKey(c.key));\n\n    if (data === null) {\n      throw new KeyNotFoundError({ key: c.key });\n    }\n\n    // Bun は Buffer を返すため、契約どおりの Uint8Array へ正規化します。\n    return new Uint8Array(data);\n  }\n\n  public async exists(c: IStorage.ExistsContext): Promise<boolean> {\n    const { client } = this.#getConnection();\n\n    c.signal.throwIfAborted();\n\n    // Bun のクライアントは EXISTS の整数を真偽値に変換して返します。\n    return client.exists(this.#toKey(c.key));\n  }\n\n  public async delete(c: IStorage.DeleteContext): Promise<void> {\n    const { client } = this.#getConnection();\n\n    c.signal.throwIfAborted();\n\n    // 存在しないキーの削除は 0 を返すだけでエラーになりません。\n    await client.del(this.#toKey(c.key));\n  }\n\n  public async clear(c: IStorage.ClearContext): Promise<void> {\n    const { client } = this.#getConnection();\n\n    c.signal.throwIfAborted();\n\n    // prefix が空文字の場合は MATCH \"*\" となり、選択中のデータベースの全キーが対象になります。\n    const pattern = `${this.#keyPrefix}*`;\n\n    let cursor = \"0\";\n\n    do {\n      c.signal.throwIfAborted();\n\n      const [nextCursor, keys] = await client.scan(cursor, \"MATCH\", pattern, \"COUNT\", SCAN_COUNT);\n\n      if (keys.length > 0) {\n        await client.del(...keys);\n      }\n\n      cursor = nextCursor;\n    } while (cursor !== \"0\");\n  }\n\n  public getWritable(c: IStorage.GetWritableContext): WritableStream<Uint8Array<ArrayBuffer>> {\n    const { client } = this.#getConnection();\n\n    c.signal.throwIfAborted();\n\n    const dest = this.#toKey(c.key);\n    // 一意なサフィックスにより、同一キーへの並行書き込みでも一時キーが衝突しないようにします。\n    const tmp = `${dest}.${Bun.randomUUIDv7()}.tmp`;\n\n    // 中断と失敗のどちらからでも後始末が走るため、完了処理は一度だけ行います。\n    let finished = false;\n    const removeAbortListener = (): void => {\n      c.signal.removeEventListener(\"abort\", onAbort);\n    };\n    const discardTemporary = async (): Promise<void> => {\n      try {\n        await client.del(tmp);\n      } catch {\n        // 後始末としての削除なので、失敗しても無視します。\n      }\n    };\n    const finish = async (): Promise<void> => {\n      if (finished) {\n        return;\n      }\n\n      finished = true;\n      removeAbortListener();\n      await discardTemporary();\n    };\n    const onAbort = (): void => {\n      void finish();\n    };\n    c.signal.addEventListener(\"abort\", onAbort, { once: true });\n\n    return new WritableStream<Uint8Array<ArrayBuffer>>({\n      async abort() {\n        await finish();\n      },\n      async close() {\n        c.signal.throwIfAborted();\n        try {\n          // 全チャンクの追記が完了した時点で初めて最終キーへ置き換えます (swap-on-close)。\n          await client.rename(tmp, dest);\n        } catch (ex) {\n          await finish();\n          throw ex;\n        }\n        // rename 後は一時キーが存在しないため、完了済みとして中断時の削除を行いません。\n        finished = true;\n        removeAbortListener();\n      },\n      async start() {\n        try {\n          c.signal.throwIfAborted();\n          // 0 バイトの書き込みでも close 時の RENAME が成功するよう、空の文字列で一時キーを作ります。\n          await client.set(tmp, \"\");\n        } catch (ex) {\n          await finish();\n          throw ex;\n        }\n      },\n      async write(chunk) {\n        c.signal.throwIfAborted();\n        try {\n          await client.append(tmp, chunk);\n        } catch (ex) {\n          await finish();\n          throw ex;\n        }\n      },\n    });\n  }\n\n  public getReadable(c: IStorage.GetReadableContext): ReadableStream<Uint8Array<ArrayBuffer>> {\n    const { client } = this.#getConnection();\n\n    c.signal.throwIfAborted();\n\n    const dest = this.#toKey(c.key);\n    let sent = false;\n\n    // Redis の GET は値を一括で返すため、取得したバイト列を単一のチャンクとして送出します。\n    return new ReadableStream<Uint8Array<ArrayBuffer>>({\n      async pull(controller) {\n        if (sent) {\n          controller.close();\n\n          return;\n        }\n\n        sent = true;\n        c.signal.throwIfAborted();\n\n        const data = await client.getBuffer(dest);\n\n        if (data === null) {\n          throw new KeyNotFoundError({ key: c.key });\n        }\n\n        // Bun は Buffer を返すため、契約どおりの Uint8Array へ正規化します。\n        controller.enqueue(new Uint8Array(data));\n        controller.close();\n      },\n    });\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BA,MAAM,aAAa;;;;;;;;;AAKnB,IAAqB,QAArB,MAA+C;;;;CA8B7C,YAAmB,KAAc,UAA+B,CAAC,GAAG;;;;;;EAClE,MAAM,EAAE,YAAY,WAAW,GAAG,iBAAiB;EAEnD,KAAK,OAAO;EACZ,uBAAA,MAAA,MAAY,IAAA;EACZ,uBAAA,MAAA,MAAY,GAAA;EACZ,uBAAA,UAAA,MAAgB,YAAA;EAChB,uBAAA,YAAA,MAAkB,SAAA;CACpB;CAEA,IAAW,SAAkB;EAC3B,OAAA,uBAAA,MAAO,IAAA,MAAc;CACvB;CAYA,MAAa,KAAK,IAAyC;EAEzD,IAAI,OAAO,QAAQ,aACjB,MAAM,IAAIA,0BAAwB;GAChC,MAAM,KAAK;GACX,SAAS;EACX,CAAC;EAIH,IAAA,uBAAA,MAAI,IAAA,GACF,KAAK,MAAM,EAAsC;EAGnD,MAAM,EAAE,aAAa,oBAAoB,MAAM,OAAO;EACtD,MAAM,SAAS,IAAI,gBAAA,uBAAA,MAAgB,IAAA,GAAA,uBAAA,UAAW,IAAA,CAAa;EAE3D,IAAI;GAEF,MAAM,OAAO,QAAQ;EACvB,SAAS,IAAI;GACX,OAAO,MAAM;GACb,MAAM;EACR;EAEA,uBAAA,MAAA,MAAY,EAAE,OAAO,CAAA;CACvB;CAEA,MAAa,IAAiC;EAC5C,kBAAA,cAAA,MAAA,cAAA,CAAA,CAAA,KAAA,IAAoB,CAAC,CAAC,OAAO,MAAM;EACnC,uBAAA,MAAA,MAAY,IAAA;CACd;CASA,MAAa,MAAM,GAA0B,MAA8C;EACzF,MAAM,EAAE,WAAA,kBAAA,cAAW,MAAA,cAAA,CAAA,CAAA,KAAA,IAAoB;EAEvC,EAAE,OAAO,eAAe;EAGxB,MAAM,OAAO,IAAA,kBAAA,cAAI,MAAA,MAAA,CAAA,CAAA,KAAA,MAAY,EAAE,GAAG,GAAG,IAAI;CAC3C;CAEA,MAAa,KAAK,GAA2D;EAC3E,MAAM,EAAE,WAAA,kBAAA,cAAW,MAAA,cAAA,CAAA,CAAA,KAAA,IAAoB;EAEvC,EAAE,OAAO,eAAe;EAExB,MAAM,OAAO,MAAM,OAAO,UAAA,kBAAA,cAAU,MAAA,MAAA,CAAA,CAAA,KAAA,MAAY,EAAE,GAAG,CAAC;EAEtD,IAAI,SAAS,MACX,MAAM,IAAIC,mBAAiB,EAAE,KAAK,EAAE,IAAI,CAAC;EAI3C,OAAO,IAAI,WAAW,IAAI;CAC5B;CAEA,MAAa,OAAO,GAA6C;EAC/D,MAAM,EAAE,WAAA,kBAAA,cAAW,MAAA,cAAA,CAAA,CAAA,KAAA,IAAoB;EAEvC,EAAE,OAAO,eAAe;EAGxB,OAAO,OAAO,OAAA,kBAAA,cAAO,MAAA,MAAA,CAAA,CAAA,KAAA,MAAY,EAAE,GAAG,CAAC;CACzC;CAEA,MAAa,OAAO,GAA0C;EAC5D,MAAM,EAAE,WAAA,kBAAA,cAAW,MAAA,cAAA,CAAA,CAAA,KAAA,IAAoB;EAEvC,EAAE,OAAO,eAAe;EAGxB,MAAM,OAAO,IAAA,kBAAA,cAAI,MAAA,MAAA,CAAA,CAAA,KAAA,MAAY,EAAE,GAAG,CAAC;CACrC;CAEA,MAAa,MAAM,GAAyC;EAC1D,MAAM,EAAE,WAAA,kBAAA,cAAW,MAAA,cAAA,CAAA,CAAA,KAAA,IAAoB;EAEvC,EAAE,OAAO,eAAe;EAGxB,MAAM,UAAU,GAAA,uBAAA,YAAG,IAAA,EAAgB;EAEnC,IAAI,SAAS;EAEb,GAAG;GACD,EAAE,OAAO,eAAe;GAExB,MAAM,CAAC,YAAY,QAAQ,MAAM,OAAO,KAAK,QAAQ,SAAS,SAAS,SAAS,UAAU;GAE1F,IAAI,KAAK,SAAS,GAChB,MAAM,OAAO,IAAI,GAAG,IAAI;GAG1B,SAAS;EACX,SAAS,WAAW;CACtB;CAEA,YAAmB,GAAyE;EAC1F,MAAM,EAAE,WAAA,kBAAA,cAAW,MAAA,cAAA,CAAA,CAAA,KAAA,IAAoB;EAEvC,EAAE,OAAO,eAAe;EAExB,MAAM,OAAA,kBAAA,cAAO,MAAA,MAAA,CAAA,CAAA,KAAA,MAAY,EAAE,GAAG;EAE9B,MAAM,MAAM,GAAG,KAAK,GAAG,IAAI,aAAa,EAAE;EAG1C,IAAI,WAAW;EACf,MAAM,4BAAkC;GACtC,EAAE,OAAO,oBAAoB,SAAS,OAAO;EAC/C;EACA,MAAM,mBAAmB,YAA2B;GAClD,IAAI;IACF,MAAM,OAAO,IAAI,GAAG;GACtB,QAAQ,CAER;EACF;EACA,MAAM,SAAS,YAA2B;GACxC,IAAI,UACF;GAGF,WAAW;GACX,oBAAoB;GACpB,MAAM,iBAAiB;EACzB;EACA,MAAM,gBAAsB;GAC1B,OAAY;EACd;EACA,EAAE,OAAO,iBAAiB,SAAS,SAAS,EAAE,MAAM,KAAK,CAAC;EAE1D,OAAO,IAAI,eAAwC;GACjD,MAAM,QAAQ;IACZ,MAAM,OAAO;GACf;GACA,MAAM,QAAQ;IACZ,EAAE,OAAO,eAAe;IACxB,IAAI;KAEF,MAAM,OAAO,OAAO,KAAK,IAAI;IAC/B,SAAS,IAAI;KACX,MAAM,OAAO;KACb,MAAM;IACR;IAEA,WAAW;IACX,oBAAoB;GACtB;GACA,MAAM,QAAQ;IACZ,IAAI;KACF,EAAE,OAAO,eAAe;KAExB,MAAM,OAAO,IAAI,KAAK,EAAE;IAC1B,SAAS,IAAI;KACX,MAAM,OAAO;KACb,MAAM;IACR;GACF;GACA,MAAM,MAAM,OAAO;IACjB,EAAE,OAAO,eAAe;IACxB,IAAI;KACF,MAAM,OAAO,OAAO,KAAK,KAAK;IAChC,SAAS,IAAI;KACX,MAAM,OAAO;KACb,MAAM;IACR;GACF;EACF,CAAC;CACH;CAEA,YAAmB,GAAyE;EAC1F,MAAM,EAAE,WAAA,kBAAA,cAAW,MAAA,cAAA,CAAA,CAAA,KAAA,IAAoB;EAEvC,EAAE,OAAO,eAAe;EAExB,MAAM,OAAA,kBAAA,cAAO,MAAA,MAAA,CAAA,CAAA,KAAA,MAAY,EAAE,GAAG;EAC9B,IAAI,OAAO;EAGX,OAAO,IAAI,eAAwC,EACjD,MAAM,KAAK,YAAY;GACrB,IAAI,MAAM;IACR,WAAW,MAAM;IAEjB;GACF;GAEA,OAAO;GACP,EAAE,OAAO,eAAe;GAExB,MAAM,OAAO,MAAM,OAAO,UAAU,IAAI;GAExC,IAAI,SAAS,MACX,MAAM,IAAIA,mBAAiB,EAAE,KAAK,EAAE,IAAI,CAAC;GAI3C,WAAW,QAAQ,IAAI,WAAW,IAAI,CAAC;GACvC,WAAW,MAAM;EACnB,EACF,CAAC;CACH;AACF;AA3NE,SAAA,iBAA6B;CAC3B,IAAA,uBAAA,MAAI,IAAA,MAAc,MAChB,MAAM,IAAI,UAAU,uCAAuC;CAG7D,OAAA,uBAAA,MAAO,IAAA;AACT;;;;AAsCA,SAAA,OAAO,KAAqB;CAC1B,OAAO,GAAA,uBAAA,YAAG,IAAA,IAAkB;AAC9B"}

package/package.json

@@ -1,6 +1,44 @@
 {
   "name": "@unikvs/redis.bun",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.0.13",
+  "description": "Storage plugin that stores byte arrays in Redis on Bun.",
+  "homepage": "https://tai-kun.github.io/unikvs/",
+  "license": "MIT",
+  "repository": {
+    "url": "https://github.com/tai-kun/unikvs",
+    "directory": "packages/redis.bun"
+  },
+  "files": [
+    "dist",
+    "src",
+    "package.json",
+    "LICENSE",
+    "README.md"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "dependencies": {
+    "@unikvs/core": "0.0.13"
+  },
+  "devDependencies": {
+    "@types/bun": "1.4.3",
+    "@unikvs/testing": "0.0.0",
+    "@vitest/coverage-istanbul": "5.0.5",
+    "@vitest/coverage-v8": "5.0.5",
+    "valibot": "1.5.0",
+    "vite-plus": "1.3.0"
+  },
+  "peerDependencies": {
+    "@logtape/logtape": "^2.0.0"
+  },
+  "readme": "README.md",
+  "scripts": {
+    "build": "vp -C .config pack"
+  }
 }

package/src/errors.ts

@@ -0,0 +1,4 @@
+export type { KeyNotFoundErrorArgs, KeyNotFoundErrorMeta } from "@unikvs/core";
+export { KeyNotFoundError } from "@unikvs/core";
+export type { UnsupportedRuntimeErrorArgs, UnsupportedRuntimeErrorMeta } from "@unikvs/core";
+export { UnsupportedRuntimeError } from "@unikvs/core";

package/src/index.ts

@@ -0,0 +1,5 @@
+export type { KeyNotFoundErrorArgs, KeyNotFoundErrorMeta } from "./errors.js";
+export { KeyNotFoundError, UnsupportedRuntimeError } from "./errors.js";
+
+export type * from "./redis.js";
+export { default as Redis } from "./redis.js";

package/src/redis.ts

@@ -0,0 +1,302 @@
+import { type IStorage, KeyNotFoundError, UnsupportedRuntimeError } from "@unikvs/core";
+import type { RedisClient, RedisOptions } from "bun";
+
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-bun#redisstorageoptions)
+ */
+export type RedisStorageOptions = RedisOptions & {
+  /**
+   * すべてのキーの先頭に付与するプレフィックスです。
+   *
+   * キーを名前空間で分離し、`clear()` が削除する範囲を限定します。空文字を指定するとキーをそのまま使います。
+   *
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-bun#redisstorageoptions-keyprefix)
+   */
+  readonly keyPrefix?: string;
+};
+
+/**
+ * ストレージの動作に必要な接続を保持する型定義です。
+ */
+type Connection = {
+  /**
+   * Bun の Redis クライアントです。
+   */
+  readonly client: RedisClient;
+};
+
+/**
+ * Redis の `SCAN` 1 回あたりにヒントとして渡すキー数です。
+ * 削除の往復回数と 1 回の `DEL` に渡す引数数を抑えるために使用します。
+ */
+const SCAN_COUNT = 1000;
+
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-bun#redis)
+ */
+export default class Redis implements IStorage {
+  /**
+   * Redis クライアントのインスタンスを保持します。
+   *
+   * ストレージがオープンされるまで null です。
+   */
+  #con: Connection | null;
+
+  /**
+   * 接続先の URL です。
+   *
+   * 未指定の場合はクライアントが環境変数 (`REDIS_URL`、`VALKEY_URL`) から解決します。
+   */
+  readonly #url: string | undefined;
+
+  /**
+   * `RedisClient` の初期化に使用する設定オブジェクトです。
+   */
+  readonly #options: RedisOptions;
+
+  /**
+   * すべてのキーの先頭に付与するプレフィックスです。
+   */
+  readonly #keyPrefix: string;
+
+  public readonly name: string;
+
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-bun#redis)
+   */
+  public constructor(url?: string, options: RedisStorageOptions = {}) {
+    const { keyPrefix = "unikvs:", ...redisOptions } = options;
+
+    this.name = "Redis";
+    this.#con = null;
+    this.#url = url;
+    this.#options = redisOptions;
+    this.#keyPrefix = keyPrefix;
+  }
+
+  public get isOpen(): boolean {
+    return this.#con !== null;
+  }
+
+  // オープン済みかを確認します。
+  // 未オープン時は `TypeError` を投げます。
+  #getConnection(): Connection {
+    if (this.#con === null) {
+      throw new TypeError("Redis is not open. Call open() first.");
+    }
+
+    return this.#con;
+  }
+
+  public async open(_c: IStorage.OpenContext): Promise<void> {
+    // Bun 以外のランタイムで誤って使われた場合に、原因の分かるエラーを返します。
+    if (typeof Bun === "undefined") {
+      throw new UnsupportedRuntimeError({
+        name: this.name,
+        runtime: "Bun",
+      });
+    }
+
+    // オープン済みの場合は古い接続を閉じ、開き直しでリークしないようにします。
+    if (this.#con) {
+      this.close(_c as unknown as IStorage.CloseContext);
+    }
+
+    const { RedisClient: RedisClientImpl } = await import("bun");
+    const client = new RedisClientImpl(this.#url, this.#options);
+
+    try {
+      // 最初のコマンドまで接続しないクライアントのため、open の時点で接続を確立します。
+      await client.connect();
+    } catch (ex) {
+      client.close();
+      throw ex;
+    }
+
+    this.#con = { client };
+  }
+
+  public close(_c: IStorage.CloseContext): void {
+    this.#getConnection().client.close();
+    this.#con = null;
+  }
+
+  /**
+   * unikvs のキーにプレフィックスを付与し、Redis のキーへ変換します。
+   */
+  #toKey(key: string): string {
+    return `${this.#keyPrefix}${key}`;
+  }
+
+  public async write(c: IStorage.WriteContext, data: Uint8Array<ArrayBuffer>): Promise<void> {
+    const { client } = this.#getConnection();
+
+    c.signal.throwIfAborted();
+
+    // Bun のクライアントは ArrayBufferView をそのままバイナリーとして送信します。
+    await client.set(this.#toKey(c.key), data);
+  }
+
+  public async read(c: IStorage.ReadContext): Promise<Uint8Array<ArrayBuffer>> {
+    const { client } = this.#getConnection();
+
+    c.signal.throwIfAborted();
+
+    const data = await client.getBuffer(this.#toKey(c.key));
+
+    if (data === null) {
+      throw new KeyNotFoundError({ key: c.key });
+    }
+
+    // Bun は Buffer を返すため、契約どおりの Uint8Array へ正規化します。
+    return new Uint8Array(data);
+  }
+
+  public async exists(c: IStorage.ExistsContext): Promise<boolean> {
+    const { client } = this.#getConnection();
+
+    c.signal.throwIfAborted();
+
+    // Bun のクライアントは EXISTS の整数を真偽値に変換して返します。
+    return client.exists(this.#toKey(c.key));
+  }
+
+  public async delete(c: IStorage.DeleteContext): Promise<void> {
+    const { client } = this.#getConnection();
+
+    c.signal.throwIfAborted();
+
+    // 存在しないキーの削除は 0 を返すだけでエラーになりません。
+    await client.del(this.#toKey(c.key));
+  }
+
+  public async clear(c: IStorage.ClearContext): Promise<void> {
+    const { client } = this.#getConnection();
+
+    c.signal.throwIfAborted();
+
+    // prefix が空文字の場合は MATCH "*" となり、選択中のデータベースの全キーが対象になります。
+    const pattern = `${this.#keyPrefix}*`;
+
+    let cursor = "0";
+
+    do {
+      c.signal.throwIfAborted();
+
+      const [nextCursor, keys] = await client.scan(cursor, "MATCH", pattern, "COUNT", SCAN_COUNT);
+
+      if (keys.length > 0) {
+        await client.del(...keys);
+      }
+
+      cursor = nextCursor;
+    } while (cursor !== "0");
+  }
+
+  public getWritable(c: IStorage.GetWritableContext): WritableStream<Uint8Array<ArrayBuffer>> {
+    const { client } = this.#getConnection();
+
+    c.signal.throwIfAborted();
+
+    const dest = this.#toKey(c.key);
+    // 一意なサフィックスにより、同一キーへの並行書き込みでも一時キーが衝突しないようにします。
+    const tmp = `${dest}.${Bun.randomUUIDv7()}.tmp`;
+
+    // 中断と失敗のどちらからでも後始末が走るため、完了処理は一度だけ行います。
+    let finished = false;
+    const removeAbortListener = (): void => {
+      c.signal.removeEventListener("abort", onAbort);
+    };
+    const discardTemporary = async (): Promise<void> => {
+      try {
+        await client.del(tmp);
+      } catch {
+        // 後始末としての削除なので、失敗しても無視します。
+      }
+    };
+    const finish = async (): Promise<void> => {
+      if (finished) {
+        return;
+      }
+
+      finished = true;
+      removeAbortListener();
+      await discardTemporary();
+    };
+    const onAbort = (): void => {
+      void finish();
+    };
+    c.signal.addEventListener("abort", onAbort, { once: true });
+
+    return new WritableStream<Uint8Array<ArrayBuffer>>({
+      async abort() {
+        await finish();
+      },
+      async close() {
+        c.signal.throwIfAborted();
+        try {
+          // 全チャンクの追記が完了した時点で初めて最終キーへ置き換えます (swap-on-close)。
+          await client.rename(tmp, dest);
+        } catch (ex) {
+          await finish();
+          throw ex;
+        }
+        // rename 後は一時キーが存在しないため、完了済みとして中断時の削除を行いません。
+        finished = true;
+        removeAbortListener();
+      },
+      async start() {
+        try {
+          c.signal.throwIfAborted();
+          // 0 バイトの書き込みでも close 時の RENAME が成功するよう、空の文字列で一時キーを作ります。
+          await client.set(tmp, "");
+        } catch (ex) {
+          await finish();
+          throw ex;
+        }
+      },
+      async write(chunk) {
+        c.signal.throwIfAborted();
+        try {
+          await client.append(tmp, chunk);
+        } catch (ex) {
+          await finish();
+          throw ex;
+        }
+      },
+    });
+  }
+
+  public getReadable(c: IStorage.GetReadableContext): ReadableStream<Uint8Array<ArrayBuffer>> {
+    const { client } = this.#getConnection();
+
+    c.signal.throwIfAborted();
+
+    const dest = this.#toKey(c.key);
+    let sent = false;
+
+    // Redis の GET は値を一括で返すため、取得したバイト列を単一のチャンクとして送出します。
+    return new ReadableStream<Uint8Array<ArrayBuffer>>({
+      async pull(controller) {
+        if (sent) {
+          controller.close();
+
+          return;
+        }
+
+        sent = true;
+        c.signal.throwIfAborted();
+
+        const data = await client.getBuffer(dest);
+
+        if (data === null) {
+          throw new KeyNotFoundError({ key: c.key });
+        }
+
+        // Bun は Buffer を返すため、契約どおりの Uint8Array へ正規化します。
+        controller.enqueue(new Uint8Array(data));
+        controller.close();
+      },
+    });
+  }
+}