@unikvs/redis.node 0.0.0 → 0.0.14

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,45 +1,3 @@
 # @unikvs/redis.node
 
-## ⚠️ IMPORTANT NOTICE ⚠️
-
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
-
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
-
-## Purpose
-
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `@unikvs/redis.node`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
-
-## What is OIDC Trusted Publishing?
-
-OIDC trusted publishing allows package maintainers to publish packages directly from their CI/CD workflows without needing to manage npm access tokens. Instead, it uses OpenID Connect to establish trust between the CI/CD provider (like GitHub Actions) and npm.
-
-## Setup Instructions
-
-To properly configure OIDC trusted publishing for this package:
-
-1. Go to [npmjs.com](https://www.npmjs.com/) and navigate to your package settings
-2. Configure the trusted publisher (e.g., GitHub Actions)
-3. Specify the repository and workflow that should be allowed to publish
-4. Use the configured workflow to publish your actual package
-
-## DO NOT USE THIS PACKAGE
-
-This package is a placeholder for OIDC configuration only. It:
-- Contains no executable code
-- Provides no functionality
-- Should not be installed as a dependency
-- Exists only for administrative purposes
-
-## More Information
-
-For more details about npm's trusted publishing feature, see:
-- [npm Trusted Publishing Documentation](https://docs.npmjs.com/generating-provenance-statements)
-- [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
-
----
-
-**Maintained for OIDC setup purposes only**
+[Document](https://tai-kun.github.io/unikvs/)

package/dist/index.d.ts

@@ -0,0 +1,222 @@
+import { ErrorBase, ErrorOptions, IStorage, InvalidUsageErrorBase, KeyNotFoundError, KeyNotFoundErrorArgs, KeyNotFoundErrorMeta } from "@unikvs/core";
+import { ClusterNode, ClusterOptions, RedisOptions } from "ioredis";
+//#region ../src/errors.d.ts
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-cluster-not-supported)
+ */
+export declare class ClusterNotSupportedError extends InvalidUsageErrorBase<undefined> {
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-cluster-not-supported)
+   */
+  constructor(options?: ErrorOptions);
+}
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-invalid-close-timeout)
+ */
+type InvalidCloseTimeoutErrorMeta = {
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#invalid-close-timeout-actual)
+   */
+  readonly actual: unknown;
+};
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-invalid-close-timeout)
+ */
+type InvalidCloseTimeoutErrorArgs = ErrorOptions & InvalidCloseTimeoutErrorMeta;
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-invalid-close-timeout)
+ */
+export declare class InvalidCloseTimeoutError extends ErrorBase<InvalidCloseTimeoutErrorMeta> {
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-invalid-close-timeout)
+   */
+  constructor(args: InvalidCloseTimeoutErrorArgs);
+}
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-connect-timeout)
+ */
+type ConnectTimeoutErrorMeta = {
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#connect-timeout-timeoutms)
+   */
+  readonly timeoutMs: number;
+};
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-connect-timeout)
+ */
+type ConnectTimeoutErrorArgs = ErrorOptions & ConnectTimeoutErrorMeta;
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-connect-timeout)
+ */
+export declare class ConnectTimeoutError extends ErrorBase<ConnectTimeoutErrorMeta> {
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-connect-timeout)
+   */
+  constructor(args: ConnectTimeoutErrorArgs);
+}
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-close-timeout)
+ */
+type CloseTimeoutErrorMeta = {
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#close-timeout-timeoutms)
+   */
+  readonly timeoutMs: number;
+};
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-close-timeout)
+ */
+type CloseTimeoutErrorArgs = ErrorOptions & CloseTimeoutErrorMeta;
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-close-timeout)
+ */
+export declare class CloseTimeoutError extends ErrorBase<CloseTimeoutErrorMeta> {
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-close-timeout)
+   */
+  constructor(args: CloseTimeoutErrorArgs);
+}
+//#endregion
+//#region ../src/redis.d.ts
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#redisclusterspec)
+ */
+type RedisClusterSpec = {
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#redisclusterspec-nodes)
+   */
+  readonly nodes: readonly ClusterNode[];
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#redisclusterspec-options)
+   */
+  readonly options?: ClusterOptions | undefined;
+};
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#redisstorageoptions)
+ */
+type RedisStorageOptions = Omit<RedisOptions, "keyPrefix" | "lazyConnect"> & {
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#redisstorageoptions-keyprefix)
+   */
+  readonly keyPrefix?: string | undefined;
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#redisstorageoptions-cluster)
+   */
+  readonly cluster?: RedisClusterSpec | undefined;
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#redisstorageoptions-closetimeout)
+   */
+  readonly closeTimeout?: number | undefined;
+};
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#redis)
+ */
+declare class Redis implements IStorage {
+  #private;
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#redis)
+   */
+  readonly name: string;
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#redis)
+   */
+  constructor(url?: string, options?: RedisStorageOptions);
+  /**
+   * ストレージがオープン済みかどうかです。
+   *
+   * @returns オープン済みなら真です。
+   */
+  get isOpen(): boolean;
+  /**
+   * ストレージをオープンします。
+   *
+   * `ioredis` クライアントを作成して接続します。
+   *
+   * @param _c オープンコンテキストです。
+   *
+   * @returns オープンが完了したら解決します。
+   */
+  open(_c: IStorage.OpenContext): Promise<void>;
+  /**
+   * ストレージをクローズします。
+   *
+   * `quit` で丁寧に閉じ、失敗時は `disconnect` で掃除します。
+   *
+   * @param _c クローズコンテキストです。
+   *
+   * @returns クローズが完了したら解決します。
+   */
+  close(_c: IStorage.CloseContext): Promise<void>;
+  /**
+   * バイト列を書き込みます。
+   *
+   * 指定したキーで値を上書きします。
+   *
+   * @param c 書き込みコンテキストです。
+   * @param data 保存するバイト列です。
+   *
+   * @returns 書き込みが完了したら解決します。
+   */
+  write(c: IStorage.WriteContext, data: Uint8Array<ArrayBuffer>): Promise<void>;
+  /**
+   * バイト列を読み取ります。
+   *
+   * 指定したキーの値を取得します。
+   *
+   * @param c 読み取りコンテキストです。
+   *
+   * @returns 読み取ったバイト列です。
+   */
+  read(c: IStorage.ReadContext): Promise<Uint8Array<ArrayBuffer>>;
+  /**
+   * キーの存在を確認します。
+   *
+   * @param c 存在確認コンテキストです。
+   *
+   * @returns 存在すれば真です。
+   */
+  exists(c: IStorage.ExistsContext): Promise<boolean>;
+  /**
+   * キーを削除します。
+   *
+   * 存在しないキーも成功扱いにします。
+   *
+   * @param c 削除コンテキストです。
+   *
+   * @returns 削除が完了したら解決します。
+   */
+  delete(c: IStorage.DeleteContext): Promise<void>;
+  /**
+   * 接頭辞に一致するキーをすべて削除します。
+   *
+   * `SCAN` で列挙しながら削除します。
+   *
+   * @param c クリアコンテキストです。
+   *
+   * @returns 削除が完了したら解決します。
+   */
+  clear(c: IStorage.ClearContext): Promise<void>;
+  /**
+   * 書き込み用ストリームを取得します。
+   *
+   * 一時キーに追記し、`close` 時に最終キーへ置き換えます。
+   *
+   * @param c 書き込みストリーム取得コンテキストです。
+   *
+   * @returns 書き込み用ストリームです。
+   */
+  getWritable(c: IStorage.GetWritableContext): WritableStream<Uint8Array<ArrayBuffer>>;
+  /**
+   * 読み取り用ストリームを取得します。
+   *
+   * 取得した値を単一チャンクとして送出します。
+   *
+   * @param c 読み取りストリーム取得コンテキストです。
+   *
+   * @returns 読み取り用ストリームです。
+   */
+  getReadable(c: IStorage.GetReadableContext): ReadableStream<Uint8Array<ArrayBuffer>>;
+}
+//#endregion
+export { type CloseTimeoutErrorArgs, type CloseTimeoutErrorMeta, type ConnectTimeoutErrorArgs, type ConnectTimeoutErrorMeta, type InvalidCloseTimeoutErrorArgs, type InvalidCloseTimeoutErrorMeta, KeyNotFoundError, type KeyNotFoundErrorArgs, type KeyNotFoundErrorMeta, Redis, type RedisClusterSpec, type RedisStorageOptions };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/errors.ts","../src/redis.ts"],"mappings":";;;;;;qBAQa,iCAAiC;;;;EAQ5C,YAAmB,UAAU;;;;;KAiBnB;;;;WAID;;;;;KAMC,+BAA+B,eAAe;;;;qBAK7C,iCAAiC,UAAU;;;;EAQtD,YAAmB,MAAM;;;;;KAsBf;;;;WAID;;;;;KAMC,0BAA0B,eAAe;;;;qBAKxC,4BAA4B,UAAU;;;;EAQjD,YAAmB,MAAM;;;;;KAqBf;;;;WAID;;;;;KAMC,wBAAwB,eAAe;;;;qBAKtC,0BAA0B,UAAU;;;;EAQ/C,YAAmB,MAAM;;;;;;;KC7Hf;;;;WAID,gBAAgB;;;;WAKhB,UAAU;;;;;KAMT,sBAAsB,KAAK;;;;WAI5B;;;;WAKA,UAAU;;;;WAKV;;;;;cAiCU,iBAAiB;;;;;WAIpB;;;;EAuChB,YAAmB,cAAc,UAAS;;;;;;MAiC/B;;;;;;;;;;EAaX,KAAkB,IAAI,SAAS,cAAc;;;;;;;;;;EAwE7C,MAAmB,IAAI,SAAS,eAAe;;;;;;;;;;;EAwC/C,MAAmB,GAAG,SAAS,cAAc,MAAM,WAAW,eAAe;;;;;;;;;;EAiB7E,KAAkB,GAAG,SAAS,cAAc,QAAQ,WAAW;;;;;;;;EAqB/D,OAAoB,GAAG,SAAS,gBAAgB;;;;;;;;;;EAiBhD,OAAoB,GAAG,SAAS,gBAAgB;;;;;;;;;;EAiBhD,MAAmB,GAAG,SAAS,eAAe;;;;;;;;;;EAmB9C,YAAmB,GAAG,SAAS,qBAAqB,eAAe,WAAW;;;;;;;;;;EAmF9E,YAAmB,GAAG,SAAS,qBAAqB,eAAe,WAAW"}