@unikvs/indexeddb 0.0.1 → 0.0.5

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/dist/src/indexeddb.d.ts

@@ -0,0 +1,39 @@
+import type { IStorage } from "@unikvs/core";
+/**
+ * ブラウザーの IndexedDB を永続化先として使用するストレージクラスです。
+ */
+export default class Indexeddb implements IStorage {
+    /**
+     * IndexedDB のデータベースインスタンスを保持します。
+     *
+     * ストレージがオープンされるまで null です。
+     */
+    private db;
+    /**
+     * 使用するデータベース名です。
+     */
+    private readonly dbName;
+    /**
+     * 使用するオブジェクトストア名です。
+     */
+    private readonly storeName;
+    readonly name: string;
+    /**
+     * Indexeddb インスタンスを初期化します。
+     *
+     * @param dbName データベース名です。
+     * @param storeName データを保存するオブジェクトストア名です。
+     */
+    constructor(dbName?: string, storeName?: string);
+    get isOpen(): boolean;
+    open(): Promise<void>;
+    close(): Promise<void>;
+    write(args: Pick<IStorage.WriteArgs<any>, "key" | "data">): Promise<void>;
+    read(args: Pick<IStorage.ReadArgs, "key">): Promise<any>;
+    exists(args: Pick<IStorage.ExistsArgs, "key">): Promise<boolean>;
+    delete(args: Pick<IStorage.DeleteArgs, "key">): Promise<void>;
+    clear(): Promise<void>;
+    getWritable(args: Pick<IStorage.GetWritableArgs, "key">): WritableStream<Uint8Array>;
+    getReadable(args: Pick<IStorage.GetReadableArgs, "key">): ReadableStream<Uint8Array>;
+}
+//# sourceMappingURL=indexeddb.d.ts.map

package/dist/src/indexeddb.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexeddb.d.ts","sourceRoot":"","sources":["../../src/indexeddb.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAG7C;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,SAAU,YAAW,QAAQ;IAChD;;;;OAIG;IACH,OAAO,CAAC,EAAE,CAAsB;IAEhC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAEhC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IAEnC,SAAgB,IAAI,EAAE,MAAM,CAAC;IAE7B;;;;;OAKG;gBACgB,MAAM,GAAE,MAAoB,EAAE,SAAS,GAAE,MAAoB;IAOhF,IAAW,MAAM,IAAI,OAAO,CAE3B;IAEY,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAerB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAKtB,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAKzE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC;IAaxD,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,KAAK,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAQhE,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,KAAK,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAK7D,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAI5B,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,KAAK,CAAC,GAAG,cAAc,CAAC,UAAU,CAAC;IAwBpF,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,KAAK,CAAC,GAAG,cAAc,CAAC,UAAU,CAAC;CAY5F"}

package/dist/src/indexeddb.js

@@ -0,0 +1,94 @@
+import { openDB } from "idb";
+/**
+ * ブラウザーの IndexedDB を永続化先として使用するストレージクラスです。
+ */
+export default class Indexeddb {
+    /**
+     * Indexeddb インスタンスを初期化します。
+     *
+     * @param dbName データベース名です。
+     * @param storeName データを保存するオブジェクトストア名です。
+     */
+    constructor(dbName = "unikvs_db", storeName = "kvs_store") {
+        this.name = "Indexeddb";
+        this.db = null;
+        this.dbName = dbName;
+        this.storeName = storeName;
+    }
+    get isOpen() {
+        return this.db !== null;
+    }
+    async open() {
+        if (this.db) {
+            return;
+        }
+        this.db = await openDB(this.dbName, 1, {
+            upgrade: (db) => {
+                // オブジェクトストアが存在しない場合は作成します
+                if (!db.objectStoreNames.contains(this.storeName)) {
+                    db.createObjectStore(this.storeName);
+                }
+            },
+        });
+    }
+    async close() {
+        this.db.close();
+        this.db = null;
+    }
+    async write(args) {
+        const { key, data } = args;
+        await this.db.put(this.storeName, data, key);
+    }
+    async read(args) {
+        const { key } = args;
+        // Opfs の挙動に合わせて、存在しない場合は DOMException (NotFoundError) を投げます
+        if (!(await this.exists({ key }))) {
+            throw new DOMException(`A requested file or directory could not be found at the time an operation was processed.`, "NotFoundError");
+        }
+        return await this.db.get(this.storeName, key);
+    }
+    async exists(args) {
+        const { key } = args;
+        // count() はキーが存在すれば 1 を、存在しなければ 0 を返します
+        const count = await this.db.count(this.storeName, key);
+        return count > 0;
+    }
+    async delete(args) {
+        const { key } = args;
+        await this.db.delete(this.storeName, key);
+    }
+    async clear() {
+        await this.db.clear(this.storeName);
+    }
+    getWritable(args) {
+        const { key } = args;
+        const chunks = [];
+        // IndexedDB にはネイティブなファイルストリームがないため、書き込まれたチャンクをメモリに保持し、クローズ時にまとめて put します。
+        return new WritableStream({
+            write: (chunk) => {
+                chunks.push(chunk);
+            },
+            close: async () => {
+                const totalLength = chunks.reduce((acc, chunk) => acc + chunk.length, 0);
+                const result = new Uint8Array(totalLength);
+                let offset = 0;
+                for (const chunk of chunks) {
+                    result.set(chunk, offset);
+                    offset += chunk.length;
+                }
+                await this.db.put(this.storeName, result, key);
+            },
+        });
+    }
+    getReadable(args) {
+        const { key } = args;
+        return new ReadableStream({
+            pull: async (controller) => {
+                // データ全体をメモリにロードしてから ReadableStream に流し込みます。
+                const data = await this.read({ key });
+                controller.enqueue(data);
+                controller.close();
+            },
+        });
+    }
+}

package/package.json

@@ -1,10 +1,48 @@
 {
   "name": "@unikvs/indexeddb",
-  "version": "0.0.1",
-  "description": "OIDC trusted publishing setup package for @unikvs/indexeddb",
-  "keywords": [
-    "oidc",
-    "trusted-publishing",
-    "setup"
-  ]
-}
+  "version": "0.0.5",
+  "description": "",
+  "homepage": "https://github.com/tai-kun/unikvs",
+  "license": "MIT",
+  "author": "tai-kun",
+  "repository": {
+    "url": "https://github.com/tai-kun/unikvs"
+  },
+  "files": [
+    "dist",
+    "src",
+    "package.json",
+    "LICENSE"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/src/index.js",
+  "types": "./dist/src/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "default": "./dist/src/index.js"
+    }
+  },
+  "dependencies": {
+    "@unikvs/core": "0.0.5",
+    "idb": "^8.0.3"
+  },
+  "devDependencies": {
+    "@tsconfig/node24": "^24.0.4",
+    "@tsconfig/strictest": "^2.0.8",
+    "@types/node": "^24.12.2",
+    "@vitest/browser": "^4.1.5",
+    "@vitest/browser-playwright": "^4.1.5",
+    "npm-check-updates": "^20.0.2",
+    "playwright": "^1.59.1",
+    "vite": "^8.0.10",
+    "vitest": "^4.1.5"
+  },
+  "peerDependencies": {
+    "@logtape/logtape": "^2.0.0"
+  },
+  "scripts": {
+    "build": "tsc --project ./.config/tsconfig.build.json"
+  }
+}

package/src/indexeddb.ts

@@ -0,0 +1,135 @@
+import type { IStorage } from "@unikvs/core";
+import { openDB, type IDBPDatabase } from "idb";
+
+/**
+ * ブラウザーの IndexedDB を永続化先として使用するストレージクラスです。
+ */
+export default class Indexeddb implements IStorage {
+  /**
+   * IndexedDB のデータベースインスタンスを保持します。
+   *
+   * ストレージがオープンされるまで null です。
+   */
+  private db: IDBPDatabase | null;
+
+  /**
+   * 使用するデータベース名です。
+   */
+  private readonly dbName: string;
+
+  /**
+   * 使用するオブジェクトストア名です。
+   */
+  private readonly storeName: string;
+
+  public readonly name: string;
+
+  /**
+   * Indexeddb インスタンスを初期化します。
+   *
+   * @param dbName データベース名です。
+   * @param storeName データを保存するオブジェクトストア名です。
+   */
+  public constructor(dbName: string = "unikvs_db", storeName: string = "kvs_store") {
+    this.name = "Indexeddb";
+    this.db = null;
+    this.dbName = dbName;
+    this.storeName = storeName;
+  }
+
+  public get isOpen(): boolean {
+    return this.db !== null;
+  }
+
+  public async open(): Promise<void> {
+    if (this.db) {
+      return;
+    }
+
+    this.db = await openDB(this.dbName, 1, {
+      upgrade: (db) => {
+        // オブジェクトストアが存在しない場合は作成します
+        if (!db.objectStoreNames.contains(this.storeName)) {
+          db.createObjectStore(this.storeName);
+        }
+      },
+    });
+  }
+
+  public async close(): Promise<void> {
+    this.db!.close();
+    this.db = null;
+  }
+
+  public async write(args: Pick<IStorage.WriteArgs<any>, "key" | "data">): Promise<void> {
+    const { key, data } = args;
+    await this.db!.put(this.storeName, data, key);
+  }
+
+  public async read(args: Pick<IStorage.ReadArgs, "key">): Promise<any> {
+    const { key } = args;
+    // Opfs の挙動に合わせて、存在しない場合は DOMException (NotFoundError) を投げます
+    if (!(await this.exists({ key }))) {
+      throw new DOMException(
+        `A requested file or directory could not be found at the time an operation was processed.`,
+        "NotFoundError",
+      );
+    }
+
+    return await this.db!.get(this.storeName, key);
+  }
+
+  public async exists(args: Pick<IStorage.ExistsArgs, "key">): Promise<boolean> {
+    const { key } = args;
+
+    // count() はキーが存在すれば 1 を、存在しなければ 0 を返します
+    const count = await this.db!.count(this.storeName, key);
+    return count > 0;
+  }
+
+  public async delete(args: Pick<IStorage.DeleteArgs, "key">): Promise<void> {
+    const { key } = args;
+    await this.db!.delete(this.storeName, key);
+  }
+
+  public async clear(): Promise<void> {
+    await this.db!.clear(this.storeName);
+  }
+
+  public getWritable(args: Pick<IStorage.GetWritableArgs, "key">): WritableStream<Uint8Array> {
+    const { key } = args;
+    const chunks: Uint8Array[] = [];
+
+    // IndexedDB にはネイティブなファイルストリームがないため、書き込まれたチャンクをメモリに保持し、クローズ時にまとめて put します。
+    return new WritableStream({
+      write: (chunk) => {
+        chunks.push(chunk);
+      },
+      close: async () => {
+        const totalLength = chunks.reduce((acc, chunk) => acc + chunk.length, 0);
+        const result = new Uint8Array(totalLength);
+        let offset = 0;
+
+        for (const chunk of chunks) {
+          result.set(chunk, offset);
+          offset += chunk.length;
+        }
+
+        await this.db!.put(this.storeName, result, key);
+      },
+    });
+  }
+
+  public getReadable(args: Pick<IStorage.GetReadableArgs, "key">): ReadableStream<Uint8Array> {
+    const { key } = args;
+
+    return new ReadableStream({
+      pull: async (controller) => {
+        // データ全体をメモリにロードしてから ReadableStream に流し込みます。
+        const data = await this.read({ key });
+        controller.enqueue(data);
+        controller.close();
+      },
+    });
+  }
+}

package/README.md

@@ -1,45 +0,0 @@
-# @unikvs/indexeddb
-
-## ⚠️ 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/indexeddb`
-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**