@unikvs/indexeddb 0.0.13 → 0.0.14

package/dist/index.d.ts

@@ -9,20 +9,92 @@ type IndexeddbOptions = {};
  */
 declare class Indexeddb implements IStorage {
   #private;
+  /**
+   * ストレージ名です。常に `Indexeddb` を返します。
+   */
   readonly name: string;
   /**
    * [API Reference](https://tai-kun.github.io/unikvs/packages/indexeddb#usage)
    */
   constructor(dbName?: string, storeName?: string, _options?: IndexeddbOptions);
+  /**
+   * ストレージが開いているかどうかを返します。
+   *
+   * @returns データベース接続があれば true を返します。
+   */
   get isOpen(): boolean;
+  /**
+   * データベースを開きます。並行した呼び出しは一つの接続処理に束ねます。
+   *
+   * @param c 中断を知らせるシグナルを持つコンテキストです。
+   *
+   * @returns 完了を知らせるプロミスです。
+   */
   open(c: IStorage.OpenContext): Promise<void>;
+  /**
+   * データベース接続を閉じます。
+   *
+   * @param c 中断を知らせるシグナルを持つコンテキストです。
+   *
+   * @returns 完了を知らせるプロミスです。
+   */
   close(c: IStorage.CloseContext): Promise<void>;
+  /**
+   * 指定したキーに値を保存します。Blob は中間形式に変換して保存します。
+   *
+   * @param c 書き込み対象のキーを持つコンテキストです。
+   * @param data 保存する値です。
+   *
+   * @returns 完了を知らせるプロミスです。
+   */
   write(c: IStorage.WriteContext, data: any): Promise<void>;
+  /**
+   * 指定したキーの値を読み出します。中間形式は Blob または File に戻します。
+   *
+   * @param c 読み出すキーを持つコンテキストです。
+   *
+   * @returns 保存されている値です。
+   */
   read(c: IStorage.ReadContext): Promise<any>;
+  /**
+   * 指定したキーが存在するかどうかを返します。
+   *
+   * @param c 確認するキーを持つコンテキストです。
+   *
+   * @returns キーが存在すれば true を返します。
+   */
   exists(c: IStorage.ExistsContext): Promise<boolean>;
+  /**
+   * 指定したキーを削除します。
+   *
+   * @param c 削除するキーを持つコンテキストです。
+   *
+   * @returns 完了を知らせるプロミスです。
+   */
   delete(c: IStorage.DeleteContext): Promise<void>;
+  /**
+   * オブジェクトストアのすべての値を削除します。
+   *
+   * @param c 中断を知らせるシグナルを持つコンテキストです。
+   *
+   * @returns 完了を知らせるプロミスです。
+   */
   clear(c: IStorage.ClearContext): Promise<void>;
+  /**
+   * Uint8Array を書き込むためのストリームを作成します。close 時にまとめて保存します。
+   *
+   * @param c 書き込み対象のキーを持つコンテキストです。
+   *
+   * @returns Uint8Array を受け付ける書き込みストリームです。
+   */
   getWritable(c: IStorage.GetWritableContext): WritableStream<Uint8Array>;
+  /**
+   * 保存済みの値を読み出すストリームを作成します。
+   *
+   * @param c 読み出すキーを持つコンテキストです。
+   *
+   * @returns Uint8Array を送出する読み取りストリームです。
+   */
   getReadable(c: IStorage.GetReadableContext): ReadableStream<Uint8Array>;
 }
 //#endregion

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":[],"sources":["../src/indexeddb.ts"],"mappings":";;;;;KAMY;;;;cAuDS,qBAAqB;;WAuBxB;;;;EAKhB,YACE,iBACA,oBACA,WAAU;MASD;EAgBX,KAAkB,GAAG,SAAS,cAAc;EA8C5C,MAAmB,GAAG,SAAS,eAAe;EAc9C,MAAmB,GAAG,SAAS,cAAc,YAAY;EAmBzD,KAAkB,GAAG,SAAS,cAAc;EA6B5C,OAAoB,GAAG,SAAS,gBAAgB;EAahD,OAAoB,GAAG,SAAS,gBAAgB;EAShD,MAAmB,GAAG,SAAS,eAAe;EAS9C,YAAmB,GAAG,SAAS,qBAAqB,eAAe;EAkCnE,YAAmB,GAAG,SAAS,qBAAqB,eAAe"}
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/indexeddb.ts"],"mappings":";;;;;KAMY;;;;cAkGS,qBAAqB;;;;;WAIxB;;;;EA2BhB,YACE,iBACA,oBACA,WAAU;;;;;;MAcD;;;;;;;;EAWX,KAAkB,GAAG,SAAS,cAAc;;;;;;;;EAqD5C,MAAmB,GAAG,SAAS,eAAe;;;;;;;;;EAsB9C,MAAmB,GAAG,SAAS,cAAc,YAAY;;;;;;;;EA0BzD,KAAkB,GAAG,SAAS,cAAc;;;;;;;;EAoC5C,OAAoB,GAAG,SAAS,gBAAgB;;;;;;;;EAoBhD,OAAoB,GAAG,SAAS,gBAAgB;;;;;;;;EAgBhD,MAAmB,GAAG,SAAS,eAAe;;;;;;;;EAgB9C,YAAmB,GAAG,SAAS,qBAAqB,eAAe;;;;;;;;EAyCnE,YAAmB,GAAG,SAAS,qBAAqB,eAAe"}

package/dist/index.js

@@ -31,10 +31,25 @@ function _classPrivateFieldGet2(s, a) {
 }
 //#endregion
 //#region ../src/indexeddb.ts
+/**
+* 保存した中間形式かどうかを判定します。
+*
+* @param value 判定する値です。
+*
+* @returns 中間形式であれば true を返します。
+*/
 function isStoredBlob(value) {
 	if (typeof value !== "object" || value === null) return false;
 	return value["unikvsBlob"] === true;
 }
+/**
+* Blob を IndexedDB に保存できる中間形式に変換します。File の名前と更新時刻も保持します。
+*
+* @param signal 中断を知らせるシグナルです。
+* @param data 変換する Blob です。
+*
+* @returns 中間形式に変換した値です。
+*/
 async function toStoredBlob(signal, data) {
 	const buffer = await data.arrayBuffer();
 	signal.throwIfAborted();
@@ -48,6 +63,13 @@ async function toStoredBlob(signal, data) {
 		lastModified: isFile ? data.lastModified : 0
 	};
 }
+/**
+* 中間形式を Blob または File に戻します。
+*
+* @param stored 中間形式の値です。
+*
+* @returns 復元した Blob または File です。
+*/
 function fromStoredBlob(stored) {
 	if (stored.unikvsFile) return new File([stored.buffer], stored.name, {
 		type: stored.type,
@@ -79,9 +101,21 @@ var Indexeddb = class {
 		_classPrivateFieldSet2(_dbName, this, dbName);
 		_classPrivateFieldSet2(_storeName, this, storeName);
 	}
+	/**
+	* ストレージが開いているかどうかを返します。
+	*
+	* @returns データベース接続があれば true を返します。
+	*/
 	get isOpen() {
 		return _classPrivateFieldGet2(_db, this) !== null;
 	}
+	/**
+	* データベースを開きます。並行した呼び出しは一つの接続処理に束ねます。
+	*
+	* @param c 中断を知らせるシグナルを持つコンテキストです。
+	*
+	* @returns 完了を知らせるプロミスです。
+	*/
 	async open(c) {
 		c.signal.throwIfAborted();
 		if (_classPrivateFieldGet2(_db, this) !== null) return;
@@ -109,6 +143,13 @@ var Indexeddb = class {
 			_classPrivateFieldSet2(_opening, this, null);
 		}
 	}
+	/**
+	* データベース接続を閉じます。
+	*
+	* @param c 中断を知らせるシグナルを持つコンテキストです。
+	*
+	* @returns 完了を知らせるプロミスです。
+	*/
 	async close(c) {
 		c.signal.throwIfAborted();
 		const db = _classPrivateFieldGet2(_db, this);
@@ -117,6 +158,14 @@ var Indexeddb = class {
 		db.close();
 		_classPrivateFieldSet2(_db, this, null);
 	}
+	/**
+	* 指定したキーに値を保存します。Blob は中間形式に変換して保存します。
+	*
+	* @param c 書き込み対象のキーを持つコンテキストです。
+	* @param data 保存する値です。
+	*
+	* @returns 完了を知らせるプロミスです。
+	*/
 	async write(c, data) {
 		c.signal.throwIfAborted();
 		const db = _assertClassBrand(_Indexeddb_brand, this, _getDb).call(this);
@@ -129,6 +178,13 @@ var Indexeddb = class {
 		await db.put(_classPrivateFieldGet2(_storeName, this), data, c.key);
 		c.signal.throwIfAborted();
 	}
+	/**
+	* 指定したキーの値を読み出します。中間形式は Blob または File に戻します。
+	*
+	* @param c 読み出すキーを持つコンテキストです。
+	*
+	* @returns 保存されている値です。
+	*/
 	async read(c) {
 		c.signal.throwIfAborted();
 		const db = _assertClassBrand(_Indexeddb_brand, this, _getDb).call(this);
@@ -142,22 +198,50 @@ var Indexeddb = class {
 		}
 		return value;
 	}
+	/**
+	* 指定したキーが存在するかどうかを返します。
+	*
+	* @param c 確認するキーを持つコンテキストです。
+	*
+	* @returns キーが存在すれば true を返します。
+	*/
 	async exists(c) {
 		c.signal.throwIfAborted();
 		const count = await _assertClassBrand(_Indexeddb_brand, this, _getDb).call(this).count(_classPrivateFieldGet2(_storeName, this), c.key);
 		c.signal.throwIfAborted();
 		return count > 0;
 	}
+	/**
+	* 指定したキーを削除します。
+	*
+	* @param c 削除するキーを持つコンテキストです。
+	*
+	* @returns 完了を知らせるプロミスです。
+	*/
 	async delete(c) {
 		c.signal.throwIfAborted();
 		await _assertClassBrand(_Indexeddb_brand, this, _getDb).call(this).delete(_classPrivateFieldGet2(_storeName, this), c.key);
 		c.signal.throwIfAborted();
 	}
+	/**
+	* オブジェクトストアのすべての値を削除します。
+	*
+	* @param c 中断を知らせるシグナルを持つコンテキストです。
+	*
+	* @returns 完了を知らせるプロミスです。
+	*/
 	async clear(c) {
 		c.signal.throwIfAborted();
 		await _assertClassBrand(_Indexeddb_brand, this, _getDb).call(this).clear(_classPrivateFieldGet2(_storeName, this));
 		c.signal.throwIfAborted();
 	}
+	/**
+	* Uint8Array を書き込むためのストリームを作成します。close 時にまとめて保存します。
+	*
+	* @param c 書き込み対象のキーを持つコンテキストです。
+	*
+	* @returns Uint8Array を受け付ける書き込みストリームです。
+	*/
 	getWritable(c) {
 		c.signal.throwIfAborted();
 		const chunks = [];
@@ -183,6 +267,13 @@ var Indexeddb = class {
 			}
 		});
 	}
+	/**
+	* 保存済みの値を読み出すストリームを作成します。
+	*
+	* @param c 読み出すキーを持つコンテキストです。
+	*
+	* @returns Uint8Array を送出する読み取りストリームです。
+	*/
 	getReadable(c) {
 		c.signal.throwIfAborted();
 		return new ReadableStream({ pull: async (controller) => {
@@ -197,6 +288,11 @@ var Indexeddb = class {
 		} });
 	}
 };
+/**
+* 開いているデータベースを返します。未オープン時はエラーを投げます。
+*
+* @returns 開いているデータベースです。
+*/
 function _getDb() {
 	const db = _classPrivateFieldGet2(_db, this);
 	if (db === null) throw new TypeError("Indexeddb is not open. Call open() first.");

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../src/indexeddb.ts"],"sourcesContent":["import type { IStorage } from \"@unikvs/core\";\nimport { type IDBPDatabase, openDB } from \"idb\";\n\n/**\n * [API Reference](https://tai-kun.github.io/unikvs/packages/indexeddb#usage)\n */\nexport type IndexeddbOptions = {};\n\n// WebKit で `Blob` を直接保存できない場合があるため、中間形式で保持します。\ntype StoredBlob = {\n  readonly name: string;\n  readonly type: string;\n  readonly buffer: ArrayBuffer;\n  readonly unikvsBlob: true;\n  readonly unikvsFile: boolean;\n  readonly lastModified: number;\n};\n\n// 保存した中間形式かどうかを判定します。\nfunction isStoredBlob(value: unknown): value is StoredBlob {\n  if (typeof value !== \"object\" || value === null) {\n    return false;\n  }\n\n  return (value as Record<string, unknown>)[\"unikvsBlob\"] === true;\n}\n\n// `Blob` を IndexedDB に保存できる中間形式に変換します。\n// `File` の名前と更新時刻も保持します。\nasync function toStoredBlob(signal: AbortSignal, data: Blob): Promise<StoredBlob> {\n  const buffer = await data.arrayBuffer();\n\n  signal.throwIfAborted();\n\n  const isFile = typeof File !== \"undefined\" && data instanceof File;\n\n  return {\n    name: isFile ? data.name : \"\",\n    type: data.type,\n    buffer,\n    unikvsBlob: true,\n    unikvsFile: isFile,\n    lastModified: isFile ? data.lastModified : 0,\n  };\n}\n\n// 中間形式を `Blob` または `File` に戻します。\nfunction fromStoredBlob(stored: StoredBlob): Blob {\n  if (stored.unikvsFile) {\n    return new File([stored.buffer], stored.name, {\n      type: stored.type,\n      lastModified: stored.lastModified,\n    });\n  }\n\n  return new Blob([stored.buffer], { type: stored.type });\n}\n\n/**\n * [API Reference](https://tai-kun.github.io/unikvs/packages/indexeddb#usage)\n */\nexport default class Indexeddb implements IStorage {\n  /**\n   * IndexedDB のデータベースインスタンスを保持します。\n   *\n   * ストレージがオープンされるまで null です。\n   */\n  #db: IDBPDatabase | null;\n\n  /**\n   * 並行 open を束ねるための進行中 Promise です。\n   */\n  #opening: Promise<IDBPDatabase> | null;\n\n  /**\n   * 使用するデータベース名です。\n   */\n  readonly #dbName: string;\n\n  /**\n   * 使用するオブジェクトストア名です。\n   */\n  readonly #storeName: string;\n\n  public readonly name: string;\n\n  /**\n   * [API Reference](https://tai-kun.github.io/unikvs/packages/indexeddb#usage)\n   */\n  public constructor(\n    dbName = \"unikvs_db\",\n    storeName = \"kvs_store\",\n    _options: IndexeddbOptions = {},\n  ) {\n    this.name = \"Indexeddb\";\n    this.#db = null;\n    this.#opening = null;\n    this.#dbName = dbName;\n    this.#storeName = storeName;\n  }\n\n  public get isOpen(): boolean {\n    return this.#db !== null;\n  }\n\n  // 開いているデータベースを返します。\n  // 未オープン時は `TypeError` を投げます。\n  #getDb(): IDBPDatabase {\n    const db = this.#db;\n\n    if (db === null) {\n      throw new TypeError(\"Indexeddb is not open. Call open() first.\");\n    }\n\n    return db;\n  }\n\n  public async open(c: IStorage.OpenContext): Promise<void> {\n    c.signal.throwIfAborted();\n\n    if (this.#db !== null) {\n      return;\n    }\n\n    if (this.#opening !== null) {\n      await this.#opening;\n      c.signal.throwIfAborted();\n\n      return;\n    }\n\n    const opening = openDB(this.#dbName, 1, {\n      upgrade: (upgraded) => {\n        // オブジェクトストアが存在しない場合は作成します。\n        if (!upgraded.objectStoreNames.contains(this.#storeName)) {\n          upgraded.createObjectStore(this.#storeName);\n        }\n      },\n    });\n    this.#opening = opening;\n\n    let opened: IDBPDatabase | null = null;\n\n    try {\n      opened = await opening;\n      c.signal.throwIfAborted();\n      this.#db = opened;\n      opened = null;\n    } catch (ex) {\n      if (opened !== null) {\n        try {\n          opened.close();\n        } catch {\n          // 閉鎖時の失敗は無視します。\n        }\n      }\n\n      throw ex;\n    } finally {\n      this.#opening = null;\n    }\n  }\n\n  public async close(c: IStorage.CloseContext): Promise<void> {\n    c.signal.throwIfAborted();\n\n    const db = this.#db;\n\n    if (db === null) {\n      throw new TypeError(\"Indexeddb is not open. Call open() first.\");\n    }\n\n    await Promise.resolve();\n    db.close();\n    this.#db = null;\n  }\n\n  public async write(c: IStorage.WriteContext, data: any): Promise<void> {\n    c.signal.throwIfAborted();\n\n    const db = this.#getDb();\n\n    if (typeof Blob !== \"undefined\" && data instanceof Blob) {\n      const stored = await toStoredBlob(c.signal, data);\n      await db.put(this.#storeName, stored, c.key);\n\n      c.signal.throwIfAborted();\n\n      return;\n    }\n\n    await db.put(this.#storeName, data, c.key);\n\n    c.signal.throwIfAborted();\n  }\n\n  public async read(c: IStorage.ReadContext): Promise<any> {\n    c.signal.throwIfAborted();\n\n    const db = this.#getDb();\n    const value = await db.get(this.#storeName, c.key);\n\n    c.signal.throwIfAborted();\n\n    if (isStoredBlob(value)) {\n      return fromStoredBlob(value);\n    }\n\n    if (value === undefined) {\n      const count = await db.count(this.#storeName, c.key);\n\n      c.signal.throwIfAborted();\n\n      // 存在しない場合は DOMException (NotFoundError) を投げます。\n      if (count === 0) {\n        throw new DOMException(\n          \"A requested file or directory could not be found at the time an operation was processed.\",\n          \"NotFoundError\",\n        );\n      }\n    }\n\n    return value;\n  }\n\n  public async exists(c: IStorage.ExistsContext): Promise<boolean> {\n    c.signal.throwIfAborted();\n\n    const db = this.#getDb();\n\n    // 件数が 1 であれば存在し、0 であれば存在しません。\n    const count = await db.count(this.#storeName, c.key);\n\n    c.signal.throwIfAborted();\n\n    return count > 0;\n  }\n\n  public async delete(c: IStorage.DeleteContext): Promise<void> {\n    c.signal.throwIfAborted();\n\n    const db = this.#getDb();\n    await db.delete(this.#storeName, c.key);\n\n    c.signal.throwIfAborted();\n  }\n\n  public async clear(c: IStorage.ClearContext): Promise<void> {\n    c.signal.throwIfAborted();\n\n    const db = this.#getDb();\n    await db.clear(this.#storeName);\n\n    c.signal.throwIfAborted();\n  }\n\n  public getWritable(c: IStorage.GetWritableContext): WritableStream<Uint8Array> {\n    c.signal.throwIfAborted();\n\n    const chunks: Uint8Array[] = [];\n\n    return new WritableStream<Uint8Array>({\n      abort: (): void => {\n        chunks.length = 0;\n      },\n      close: async (): Promise<void> => {\n        // 保存は close のときだけ行うため、中断時はここまでのチャンクを破棄できます。\n        c.signal.throwIfAborted();\n\n        const totalLength = chunks.reduce((sum, chunk) => sum + chunk.length, 0);\n        const merged = new Uint8Array(totalLength);\n        let offset = 0;\n\n        for (const chunk of chunks) {\n          merged.set(chunk, offset);\n          offset += chunk.length;\n        }\n\n        const db = this.#getDb();\n        await db.put(this.#storeName, merged, c.key);\n\n        c.signal.throwIfAborted();\n      },\n      write: (chunk): void => {\n        c.signal.throwIfAborted();\n        chunks.push(chunk);\n      },\n    });\n  }\n\n  public getReadable(c: IStorage.GetReadableContext): ReadableStream<Uint8Array> {\n    c.signal.throwIfAborted();\n\n    return new ReadableStream<Uint8Array>({\n      pull: async (controller: ReadableStreamDefaultController<Uint8Array>): Promise<void> => {\n        try {\n          const data = await this.read(c as unknown as IStorage.ReadContext);\n\n          c.signal.throwIfAborted();\n          controller.enqueue(data as Uint8Array);\n          controller.close();\n        } catch (ex) {\n          controller.error(ex);\n        }\n      },\n    });\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmBA,SAAS,aAAa,OAAqC;CACzD,IAAI,OAAO,UAAU,YAAY,UAAU,MACzC,OAAO;CAGT,OAAQ,MAAkC,kBAAkB;AAC9D;AAIA,eAAe,aAAa,QAAqB,MAAiC;CAChF,MAAM,SAAS,MAAM,KAAK,YAAY;CAEtC,OAAO,eAAe;CAEtB,MAAM,SAAS,OAAO,SAAS,eAAe,gBAAgB;CAE9D,OAAO;EACL,MAAM,SAAS,KAAK,OAAO;EAC3B,MAAM,KAAK;EACX;EACA,YAAY;EACZ,YAAY;EACZ,cAAc,SAAS,KAAK,eAAe;CAC7C;AACF;AAGA,SAAS,eAAe,QAA0B;CAChD,IAAI,OAAO,YACT,OAAO,IAAI,KAAK,CAAC,OAAO,MAAM,GAAG,OAAO,MAAM;EAC5C,MAAM,OAAO;EACb,cAAc,OAAO;CACvB,CAAC;CAGH,OAAO,IAAI,KAAK,CAAC,OAAO,MAAM,GAAG,EAAE,MAAM,OAAO,KAAK,CAAC;AACxD;;;;;;;;;AAKA,IAAqB,YAArB,MAAmD;;;;CA4BjD,YACE,SAAS,aACT,YAAY,aACZ,WAA6B,CAAC,GAC9B;;;;;;EACA,KAAK,OAAO;EACZ,uBAAA,KAAA,MAAW,IAAA;EACX,uBAAA,UAAA,MAAgB,IAAA;EAChB,uBAAA,SAAA,MAAe,MAAA;EACf,uBAAA,YAAA,MAAkB,SAAA;CACpB;CAEA,IAAW,SAAkB;EAC3B,OAAA,uBAAA,KAAO,IAAA,MAAa;CACtB;CAcA,MAAa,KAAK,GAAwC;EACxD,EAAE,OAAO,eAAe;EAExB,IAAA,uBAAA,KAAI,IAAA,MAAa,MACf;EAGF,IAAA,uBAAA,UAAI,IAAA,MAAkB,MAAM;GAC1B,MAAA,uBAAA,UAAM,IAAA;GACN,EAAE,OAAO,eAAe;GAExB;EACF;EAEA,MAAM,UAAU,OAAA,uBAAA,SAAO,IAAA,GAAc,GAAG,EACtC,UAAU,aAAa;GAErB,IAAI,CAAC,SAAS,iBAAiB,SAAA,uBAAA,YAAS,IAAA,CAAe,GACrD,SAAS,kBAAA,uBAAA,YAAkB,IAAA,CAAe;EAE9C,EACF,CAAC;EACD,uBAAA,UAAA,MAAgB,OAAA;EAEhB,IAAI,SAA8B;EAElC,IAAI;GACF,SAAS,MAAM;GACf,EAAE,OAAO,eAAe;GACxB,uBAAA,KAAA,MAAW,MAAA;GACX,SAAS;EACX,SAAS,IAAI;GACX,IAAI,WAAW,MACb,IAAI;IACF,OAAO,MAAM;GACf,QAAQ,CAER;GAGF,MAAM;EACR,UAAU;GACR,uBAAA,UAAA,MAAgB,IAAA;EAClB;CACF;CAEA,MAAa,MAAM,GAAyC;EAC1D,EAAE,OAAO,eAAe;EAExB,MAAM,KAAA,uBAAA,KAAK,IAAA;EAEX,IAAI,OAAO,MACT,MAAM,IAAI,UAAU,2CAA2C;EAGjE,MAAM,QAAQ,QAAQ;EACtB,GAAG,MAAM;EACT,uBAAA,KAAA,MAAW,IAAA;CACb;CAEA,MAAa,MAAM,GAA0B,MAA0B;EACrE,EAAE,OAAO,eAAe;EAExB,MAAM,KAAA,kBAAA,kBAAK,MAAA,MAAA,CAAA,CAAA,KAAA,IAAY;EAEvB,IAAI,OAAO,SAAS,eAAe,gBAAgB,MAAM;GACvD,MAAM,SAAS,MAAM,aAAa,EAAE,QAAQ,IAAI;GAChD,MAAM,GAAG,IAAA,uBAAA,YAAI,IAAA,GAAiB,QAAQ,EAAE,GAAG;GAE3C,EAAE,OAAO,eAAe;GAExB;EACF;EAEA,MAAM,GAAG,IAAA,uBAAA,YAAI,IAAA,GAAiB,MAAM,EAAE,GAAG;EAEzC,EAAE,OAAO,eAAe;CAC1B;CAEA,MAAa,KAAK,GAAuC;EACvD,EAAE,OAAO,eAAe;EAExB,MAAM,KAAA,kBAAA,kBAAK,MAAA,MAAA,CAAA,CAAA,KAAA,IAAY;EACvB,MAAM,QAAQ,MAAM,GAAG,IAAA,uBAAA,YAAI,IAAA,GAAiB,EAAE,GAAG;EAEjD,EAAE,OAAO,eAAe;EAExB,IAAI,aAAa,KAAK,GACpB,OAAO,eAAe,KAAK;EAG7B,IAAI,UAAU,KAAA,GAAW;GACvB,MAAM,QAAQ,MAAM,GAAG,MAAA,uBAAA,YAAM,IAAA,GAAiB,EAAE,GAAG;GAEnD,EAAE,OAAO,eAAe;GAGxB,IAAI,UAAU,GACZ,MAAM,IAAI,aACR,4FACA,eACF;EAEJ;EAEA,OAAO;CACT;CAEA,MAAa,OAAO,GAA6C;EAC/D,EAAE,OAAO,eAAe;EAKxB,MAAM,QAAQ,MAAA,kBAAA,kBAHH,MAAA,MAAA,CAAA,CAAA,KAAA,IAGU,CAAC,CAAC,MAAA,uBAAA,YAAM,IAAA,GAAiB,EAAE,GAAG;EAEnD,EAAE,OAAO,eAAe;EAExB,OAAO,QAAQ;CACjB;CAEA,MAAa,OAAO,GAA0C;EAC5D,EAAE,OAAO,eAAe;EAGxB,MAAA,kBAAA,kBADW,MAAA,MAAA,CAAA,CAAA,KAAA,IACJ,CAAC,CAAC,OAAA,uBAAA,YAAO,IAAA,GAAiB,EAAE,GAAG;EAEtC,EAAE,OAAO,eAAe;CAC1B;CAEA,MAAa,MAAM,GAAyC;EAC1D,EAAE,OAAO,eAAe;EAGxB,MAAA,kBAAA,kBADW,MAAA,MAAA,CAAA,CAAA,KAAA,IACJ,CAAC,CAAC,MAAA,uBAAA,YAAM,IAAA,CAAe;EAE9B,EAAE,OAAO,eAAe;CAC1B;CAEA,YAAmB,GAA4D;EAC7E,EAAE,OAAO,eAAe;EAExB,MAAM,SAAuB,CAAC;EAE9B,OAAO,IAAI,eAA2B;GACpC,aAAmB;IACjB,OAAO,SAAS;GAClB;GACA,OAAO,YAA2B;IAEhC,EAAE,OAAO,eAAe;IAExB,MAAM,cAAc,OAAO,QAAQ,KAAK,UAAU,MAAM,MAAM,QAAQ,CAAC;IACvE,MAAM,SAAS,IAAI,WAAW,WAAW;IACzC,IAAI,SAAS;IAEb,KAAK,MAAM,SAAS,QAAQ;KAC1B,OAAO,IAAI,OAAO,MAAM;KACxB,UAAU,MAAM;IAClB;IAGA,MAAA,kBAAA,kBADW,MAAA,MAAA,CAAA,CAAA,KAAA,IACJ,CAAC,CAAC,IAAA,uBAAA,YAAI,IAAA,GAAiB,QAAQ,EAAE,GAAG;IAE3C,EAAE,OAAO,eAAe;GAC1B;GACA,QAAQ,UAAgB;IACtB,EAAE,OAAO,eAAe;IACxB,OAAO,KAAK,KAAK;GACnB;EACF,CAAC;CACH;CAEA,YAAmB,GAA4D;EAC7E,EAAE,OAAO,eAAe;EAExB,OAAO,IAAI,eAA2B,EACpC,MAAM,OAAO,eAA2E;GACtF,IAAI;IACF,MAAM,OAAO,MAAM,KAAK,KAAK,CAAoC;IAEjE,EAAE,OAAO,eAAe;IACxB,WAAW,QAAQ,IAAkB;IACrC,WAAW,MAAM;GACnB,SAAS,IAAI;IACX,WAAW,MAAM,EAAE;GACrB;EACF,EACF,CAAC;CACH;AACF;AAxME,SAAA,SAAuB;CACrB,MAAM,KAAA,uBAAA,KAAK,IAAA;CAEX,IAAI,OAAO,MACT,MAAM,IAAI,UAAU,2CAA2C;CAGjE,OAAO;AACT"}
+{"version":3,"file":"index.js","names":[],"sources":["../src/indexeddb.ts"],"sourcesContent":["import type { IStorage } from \"@unikvs/core\";\nimport { type IDBPDatabase, openDB } from \"idb\";\n\n/**\n * [API Reference](https://tai-kun.github.io/unikvs/packages/indexeddb#usage)\n */\nexport type IndexeddbOptions = {};\n\n/**\n * WebKit で Blob を直接保存できない場合があるため、中間形式で保持します。\n */\ntype StoredBlob = {\n  /**\n   * File のときに保持するファイル名です。\n   */\n  readonly name: string;\n\n  /**\n   * 元の Blob の MIME 種別です。\n   */\n  readonly type: string;\n\n  /**\n   * Blob のバイト列です。\n   */\n  readonly buffer: ArrayBuffer;\n\n  /**\n   * 中間形式であることを示す目印です。\n   */\n  readonly unikvsBlob: true;\n\n  /**\n   * File 由来かどうかを示す目印です。\n   */\n  readonly unikvsFile: boolean;\n\n  /**\n   * File のときに保持する更新時刻です。\n   */\n  readonly lastModified: number;\n};\n\n/**\n * 保存した中間形式かどうかを判定します。\n *\n * @param value 判定する値です。\n *\n * @returns 中間形式であれば true を返します。\n */\nfunction isStoredBlob(value: unknown): value is StoredBlob {\n  if (typeof value !== \"object\" || value === null) {\n    return false;\n  }\n\n  return (value as Record<string, unknown>)[\"unikvsBlob\"] === true;\n}\n\n/**\n * Blob を IndexedDB に保存できる中間形式に変換します。File の名前と更新時刻も保持します。\n *\n * @param signal 中断を知らせるシグナルです。\n * @param data 変換する Blob です。\n *\n * @returns 中間形式に変換した値です。\n */\nasync function toStoredBlob(signal: AbortSignal, data: Blob): Promise<StoredBlob> {\n  const buffer = await data.arrayBuffer();\n\n  signal.throwIfAborted();\n\n  const isFile = typeof File !== \"undefined\" && data instanceof File;\n\n  return {\n    name: isFile ? data.name : \"\",\n    type: data.type,\n    buffer,\n    unikvsBlob: true,\n    unikvsFile: isFile,\n    lastModified: isFile ? data.lastModified : 0,\n  };\n}\n\n/**\n * 中間形式を Blob または File に戻します。\n *\n * @param stored 中間形式の値です。\n *\n * @returns 復元した Blob または File です。\n */\nfunction fromStoredBlob(stored: StoredBlob): Blob {\n  if (stored.unikvsFile) {\n    return new File([stored.buffer], stored.name, {\n      type: stored.type,\n      lastModified: stored.lastModified,\n    });\n  }\n\n  return new Blob([stored.buffer], { type: stored.type });\n}\n\n/**\n * [API Reference](https://tai-kun.github.io/unikvs/packages/indexeddb#usage)\n */\nexport default class Indexeddb implements IStorage {\n  /**\n   * ストレージ名です。常に `Indexeddb` を返します。\n   */\n  public readonly name: string;\n\n  /**\n   * IndexedDB のデータベースインスタンスを保持します。\n   *\n   * ストレージがオープンされるまで null です。\n   */\n  #db: IDBPDatabase | null;\n\n  /**\n   * 並行 open を束ねるための進行中 Promise です。\n   */\n  #opening: Promise<IDBPDatabase> | null;\n\n  /**\n   * 使用するデータベース名です。\n   */\n  readonly #dbName: string;\n\n  /**\n   * 使用するオブジェクトストア名です。\n   */\n  readonly #storeName: string;\n\n  /**\n   * [API Reference](https://tai-kun.github.io/unikvs/packages/indexeddb#usage)\n   */\n  public constructor(\n    dbName = \"unikvs_db\",\n    storeName = \"kvs_store\",\n    _options: IndexeddbOptions = {},\n  ) {\n    this.name = \"Indexeddb\";\n    this.#db = null;\n    this.#opening = null;\n    this.#dbName = dbName;\n    this.#storeName = storeName;\n  }\n\n  /**\n   * ストレージが開いているかどうかを返します。\n   *\n   * @returns データベース接続があれば true を返します。\n   */\n  public get isOpen(): boolean {\n    return this.#db !== null;\n  }\n\n  /**\n   * データベースを開きます。並行した呼び出しは一つの接続処理に束ねます。\n   *\n   * @param c 中断を知らせるシグナルを持つコンテキストです。\n   *\n   * @returns 完了を知らせるプロミスです。\n   */\n  public async open(c: IStorage.OpenContext): Promise<void> {\n    c.signal.throwIfAborted();\n\n    if (this.#db !== null) {\n      return;\n    }\n\n    if (this.#opening !== null) {\n      await this.#opening;\n      c.signal.throwIfAborted();\n\n      return;\n    }\n\n    const opening = openDB(this.#dbName, 1, {\n      upgrade: (upgraded) => {\n        // オブジェクトストアが存在しない場合は作成します。\n        if (!upgraded.objectStoreNames.contains(this.#storeName)) {\n          upgraded.createObjectStore(this.#storeName);\n        }\n      },\n    });\n    this.#opening = opening;\n\n    let opened: IDBPDatabase | null = null;\n\n    try {\n      opened = await opening;\n      c.signal.throwIfAborted();\n      this.#db = opened;\n      opened = null;\n    } catch (ex) {\n      if (opened !== null) {\n        try {\n          opened.close();\n        } catch {\n          // 閉鎖時の失敗は無視します。\n        }\n      }\n\n      throw ex;\n    } finally {\n      this.#opening = null;\n    }\n  }\n\n  /**\n   * データベース接続を閉じます。\n   *\n   * @param c 中断を知らせるシグナルを持つコンテキストです。\n   *\n   * @returns 完了を知らせるプロミスです。\n   */\n  public async close(c: IStorage.CloseContext): Promise<void> {\n    c.signal.throwIfAborted();\n\n    const db = this.#db;\n\n    if (db === null) {\n      throw new TypeError(\"Indexeddb is not open. Call open() first.\");\n    }\n\n    await Promise.resolve();\n    db.close();\n    this.#db = null;\n  }\n\n  /**\n   * 指定したキーに値を保存します。Blob は中間形式に変換して保存します。\n   *\n   * @param c 書き込み対象のキーを持つコンテキストです。\n   * @param data 保存する値です。\n   *\n   * @returns 完了を知らせるプロミスです。\n   */\n  public async write(c: IStorage.WriteContext, data: any): Promise<void> {\n    c.signal.throwIfAborted();\n\n    const db = this.#getDb();\n\n    if (typeof Blob !== \"undefined\" && data instanceof Blob) {\n      const stored = await toStoredBlob(c.signal, data);\n      await db.put(this.#storeName, stored, c.key);\n\n      c.signal.throwIfAborted();\n\n      return;\n    }\n\n    await db.put(this.#storeName, data, c.key);\n\n    c.signal.throwIfAborted();\n  }\n\n  /**\n   * 指定したキーの値を読み出します。中間形式は Blob または File に戻します。\n   *\n   * @param c 読み出すキーを持つコンテキストです。\n   *\n   * @returns 保存されている値です。\n   */\n  public async read(c: IStorage.ReadContext): Promise<any> {\n    c.signal.throwIfAborted();\n\n    const db = this.#getDb();\n    const value = await db.get(this.#storeName, c.key);\n\n    c.signal.throwIfAborted();\n\n    if (isStoredBlob(value)) {\n      return fromStoredBlob(value);\n    }\n\n    if (value === undefined) {\n      const count = await db.count(this.#storeName, c.key);\n\n      c.signal.throwIfAborted();\n\n      // 存在しない場合は DOMException (NotFoundError) を投げます。\n      if (count === 0) {\n        throw new DOMException(\n          \"A requested file or directory could not be found at the time an operation was processed.\",\n          \"NotFoundError\",\n        );\n      }\n    }\n\n    return value;\n  }\n\n  /**\n   * 指定したキーが存在するかどうかを返します。\n   *\n   * @param c 確認するキーを持つコンテキストです。\n   *\n   * @returns キーが存在すれば true を返します。\n   */\n  public async exists(c: IStorage.ExistsContext): Promise<boolean> {\n    c.signal.throwIfAborted();\n\n    const db = this.#getDb();\n\n    // 件数が 1 であれば存在し、0 であれば存在しません。\n    const count = await db.count(this.#storeName, c.key);\n\n    c.signal.throwIfAborted();\n\n    return count > 0;\n  }\n\n  /**\n   * 指定したキーを削除します。\n   *\n   * @param c 削除するキーを持つコンテキストです。\n   *\n   * @returns 完了を知らせるプロミスです。\n   */\n  public async delete(c: IStorage.DeleteContext): Promise<void> {\n    c.signal.throwIfAborted();\n\n    const db = this.#getDb();\n    await db.delete(this.#storeName, c.key);\n\n    c.signal.throwIfAborted();\n  }\n\n  /**\n   * オブジェクトストアのすべての値を削除します。\n   *\n   * @param c 中断を知らせるシグナルを持つコンテキストです。\n   *\n   * @returns 完了を知らせるプロミスです。\n   */\n  public async clear(c: IStorage.ClearContext): Promise<void> {\n    c.signal.throwIfAborted();\n\n    const db = this.#getDb();\n    await db.clear(this.#storeName);\n\n    c.signal.throwIfAborted();\n  }\n\n  /**\n   * Uint8Array を書き込むためのストリームを作成します。close 時にまとめて保存します。\n   *\n   * @param c 書き込み対象のキーを持つコンテキストです。\n   *\n   * @returns Uint8Array を受け付ける書き込みストリームです。\n   */\n  public getWritable(c: IStorage.GetWritableContext): WritableStream<Uint8Array> {\n    c.signal.throwIfAborted();\n\n    const chunks: Uint8Array[] = [];\n\n    return new WritableStream<Uint8Array>({\n      abort: (): void => {\n        chunks.length = 0;\n      },\n      close: async (): Promise<void> => {\n        // 保存は close のときだけ行うため、中断時はここまでのチャンクを破棄できます。\n        c.signal.throwIfAborted();\n\n        const totalLength = chunks.reduce((sum, chunk) => sum + chunk.length, 0);\n        const merged = new Uint8Array(totalLength);\n        let offset = 0;\n\n        for (const chunk of chunks) {\n          merged.set(chunk, offset);\n          offset += chunk.length;\n        }\n\n        const db = this.#getDb();\n        await db.put(this.#storeName, merged, c.key);\n\n        c.signal.throwIfAborted();\n      },\n      write: (chunk): void => {\n        c.signal.throwIfAborted();\n        chunks.push(chunk);\n      },\n    });\n  }\n\n  /**\n   * 保存済みの値を読み出すストリームを作成します。\n   *\n   * @param c 読み出すキーを持つコンテキストです。\n   *\n   * @returns Uint8Array を送出する読み取りストリームです。\n   */\n  public getReadable(c: IStorage.GetReadableContext): ReadableStream<Uint8Array> {\n    c.signal.throwIfAborted();\n\n    return new ReadableStream<Uint8Array>({\n      pull: async (controller: ReadableStreamDefaultController<Uint8Array>): Promise<void> => {\n        try {\n          const data = await this.read(c as unknown as IStorage.ReadContext);\n\n          c.signal.throwIfAborted();\n          controller.enqueue(data as Uint8Array);\n          controller.close();\n        } catch (ex) {\n          controller.error(ex);\n        }\n      },\n    });\n  }\n\n  /**\n   * 開いているデータベースを返します。未オープン時はエラーを投げます。\n   *\n   * @returns 開いているデータベースです。\n   */\n  #getDb(): IDBPDatabase {\n    const db = this.#db;\n\n    if (db === null) {\n      throw new TypeError(\"Indexeddb is not open. Call open() first.\");\n    }\n\n    return db;\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkDA,SAAS,aAAa,OAAqC;CACzD,IAAI,OAAO,UAAU,YAAY,UAAU,MACzC,OAAO;CAGT,OAAQ,MAAkC,kBAAkB;AAC9D;;;;;;;;;AAUA,eAAe,aAAa,QAAqB,MAAiC;CAChF,MAAM,SAAS,MAAM,KAAK,YAAY;CAEtC,OAAO,eAAe;CAEtB,MAAM,SAAS,OAAO,SAAS,eAAe,gBAAgB;CAE9D,OAAO;EACL,MAAM,SAAS,KAAK,OAAO;EAC3B,MAAM,KAAK;EACX;EACA,YAAY;EACZ,YAAY;EACZ,cAAc,SAAS,KAAK,eAAe;CAC7C;AACF;;;;;;;;AASA,SAAS,eAAe,QAA0B;CAChD,IAAI,OAAO,YACT,OAAO,IAAI,KAAK,CAAC,OAAO,MAAM,GAAG,OAAO,MAAM;EAC5C,MAAM,OAAO;EACb,cAAc,OAAO;CACvB,CAAC;CAGH,OAAO,IAAI,KAAK,CAAC,OAAO,MAAM,GAAG,EAAE,MAAM,OAAO,KAAK,CAAC;AACxD;;;;;;;;;AAKA,IAAqB,YAArB,MAAmD;;;;CA+BjD,YACE,SAAS,aACT,YAAY,aACZ,WAA6B,CAAC,GAC9B;;;;;;EACA,KAAK,OAAO;EACZ,uBAAA,KAAA,MAAW,IAAA;EACX,uBAAA,UAAA,MAAgB,IAAA;EAChB,uBAAA,SAAA,MAAe,MAAA;EACf,uBAAA,YAAA,MAAkB,SAAA;CACpB;;;;;;CAOA,IAAW,SAAkB;EAC3B,OAAA,uBAAA,KAAO,IAAA,MAAa;CACtB;;;;;;;;CASA,MAAa,KAAK,GAAwC;EACxD,EAAE,OAAO,eAAe;EAExB,IAAA,uBAAA,KAAI,IAAA,MAAa,MACf;EAGF,IAAA,uBAAA,UAAI,IAAA,MAAkB,MAAM;GAC1B,MAAA,uBAAA,UAAM,IAAA;GACN,EAAE,OAAO,eAAe;GAExB;EACF;EAEA,MAAM,UAAU,OAAA,uBAAA,SAAO,IAAA,GAAc,GAAG,EACtC,UAAU,aAAa;GAErB,IAAI,CAAC,SAAS,iBAAiB,SAAA,uBAAA,YAAS,IAAA,CAAe,GACrD,SAAS,kBAAA,uBAAA,YAAkB,IAAA,CAAe;EAE9C,EACF,CAAC;EACD,uBAAA,UAAA,MAAgB,OAAA;EAEhB,IAAI,SAA8B;EAElC,IAAI;GACF,SAAS,MAAM;GACf,EAAE,OAAO,eAAe;GACxB,uBAAA,KAAA,MAAW,MAAA;GACX,SAAS;EACX,SAAS,IAAI;GACX,IAAI,WAAW,MACb,IAAI;IACF,OAAO,MAAM;GACf,QAAQ,CAER;GAGF,MAAM;EACR,UAAU;GACR,uBAAA,UAAA,MAAgB,IAAA;EAClB;CACF;;;;;;;;CASA,MAAa,MAAM,GAAyC;EAC1D,EAAE,OAAO,eAAe;EAExB,MAAM,KAAA,uBAAA,KAAK,IAAA;EAEX,IAAI,OAAO,MACT,MAAM,IAAI,UAAU,2CAA2C;EAGjE,MAAM,QAAQ,QAAQ;EACtB,GAAG,MAAM;EACT,uBAAA,KAAA,MAAW,IAAA;CACb;;;;;;;;;CAUA,MAAa,MAAM,GAA0B,MAA0B;EACrE,EAAE,OAAO,eAAe;EAExB,MAAM,KAAA,kBAAA,kBAAK,MAAA,MAAA,CAAA,CAAA,KAAA,IAAY;EAEvB,IAAI,OAAO,SAAS,eAAe,gBAAgB,MAAM;GACvD,MAAM,SAAS,MAAM,aAAa,EAAE,QAAQ,IAAI;GAChD,MAAM,GAAG,IAAA,uBAAA,YAAI,IAAA,GAAiB,QAAQ,EAAE,GAAG;GAE3C,EAAE,OAAO,eAAe;GAExB;EACF;EAEA,MAAM,GAAG,IAAA,uBAAA,YAAI,IAAA,GAAiB,MAAM,EAAE,GAAG;EAEzC,EAAE,OAAO,eAAe;CAC1B;;;;;;;;CASA,MAAa,KAAK,GAAuC;EACvD,EAAE,OAAO,eAAe;EAExB,MAAM,KAAA,kBAAA,kBAAK,MAAA,MAAA,CAAA,CAAA,KAAA,IAAY;EACvB,MAAM,QAAQ,MAAM,GAAG,IAAA,uBAAA,YAAI,IAAA,GAAiB,EAAE,GAAG;EAEjD,EAAE,OAAO,eAAe;EAExB,IAAI,aAAa,KAAK,GACpB,OAAO,eAAe,KAAK;EAG7B,IAAI,UAAU,KAAA,GAAW;GACvB,MAAM,QAAQ,MAAM,GAAG,MAAA,uBAAA,YAAM,IAAA,GAAiB,EAAE,GAAG;GAEnD,EAAE,OAAO,eAAe;GAGxB,IAAI,UAAU,GACZ,MAAM,IAAI,aACR,4FACA,eACF;EAEJ;EAEA,OAAO;CACT;;;;;;;;CASA,MAAa,OAAO,GAA6C;EAC/D,EAAE,OAAO,eAAe;EAKxB,MAAM,QAAQ,MAAA,kBAAA,kBAHH,MAAA,MAAA,CAAA,CAAA,KAAA,IAGU,CAAC,CAAC,MAAA,uBAAA,YAAM,IAAA,GAAiB,EAAE,GAAG;EAEnD,EAAE,OAAO,eAAe;EAExB,OAAO,QAAQ;CACjB;;;;;;;;CASA,MAAa,OAAO,GAA0C;EAC5D,EAAE,OAAO,eAAe;EAGxB,MAAA,kBAAA,kBADW,MAAA,MAAA,CAAA,CAAA,KAAA,IACJ,CAAC,CAAC,OAAA,uBAAA,YAAO,IAAA,GAAiB,EAAE,GAAG;EAEtC,EAAE,OAAO,eAAe;CAC1B;;;;;;;;CASA,MAAa,MAAM,GAAyC;EAC1D,EAAE,OAAO,eAAe;EAGxB,MAAA,kBAAA,kBADW,MAAA,MAAA,CAAA,CAAA,KAAA,IACJ,CAAC,CAAC,MAAA,uBAAA,YAAM,IAAA,CAAe;EAE9B,EAAE,OAAO,eAAe;CAC1B;;;;;;;;CASA,YAAmB,GAA4D;EAC7E,EAAE,OAAO,eAAe;EAExB,MAAM,SAAuB,CAAC;EAE9B,OAAO,IAAI,eAA2B;GACpC,aAAmB;IACjB,OAAO,SAAS;GAClB;GACA,OAAO,YAA2B;IAEhC,EAAE,OAAO,eAAe;IAExB,MAAM,cAAc,OAAO,QAAQ,KAAK,UAAU,MAAM,MAAM,QAAQ,CAAC;IACvE,MAAM,SAAS,IAAI,WAAW,WAAW;IACzC,IAAI,SAAS;IAEb,KAAK,MAAM,SAAS,QAAQ;KAC1B,OAAO,IAAI,OAAO,MAAM;KACxB,UAAU,MAAM;IAClB;IAGA,MAAA,kBAAA,kBADW,MAAA,MAAA,CAAA,CAAA,KAAA,IACJ,CAAC,CAAC,IAAA,uBAAA,YAAI,IAAA,GAAiB,QAAQ,EAAE,GAAG;IAE3C,EAAE,OAAO,eAAe;GAC1B;GACA,QAAQ,UAAgB;IACtB,EAAE,OAAO,eAAe;IACxB,OAAO,KAAK,KAAK;GACnB;EACF,CAAC;CACH;;;;;;;;CASA,YAAmB,GAA4D;EAC7E,EAAE,OAAO,eAAe;EAExB,OAAO,IAAI,eAA2B,EACpC,MAAM,OAAO,eAA2E;GACtF,IAAI;IACF,MAAM,OAAO,MAAM,KAAK,KAAK,CAAoC;IAEjE,EAAE,OAAO,eAAe;IACxB,WAAW,QAAQ,IAAkB;IACrC,WAAW,MAAM;GACnB,SAAS,IAAI;IACX,WAAW,MAAM,EAAE;GACrB;EACF,EACF,CAAC;CACH;AAgBF;;;;;;AATE,SAAA,SAAuB;CACrB,MAAM,KAAA,uBAAA,KAAK,IAAA;CAEX,IAAI,OAAO,MACT,MAAM,IAAI,UAAU,2CAA2C;CAGjE,OAAO;AACT"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unikvs/indexeddb",
-  "version": "0.0.13",
+  "version": "0.0.14",
   "description": "Storage plugin that stores arbitrary data in the browser IndexedDB.",
   "homepage": "https://tai-kun.github.io/unikvs/",
   "license": "MIT",
@@ -24,7 +24,7 @@
     }
   },
   "dependencies": {
-    "@unikvs/core": "0.0.13",
+    "@unikvs/core": "0.0.14",
     "idb": "^8.0.4"
   },
   "devDependencies": {

package/src/indexeddb.ts

@@ -6,17 +6,48 @@ import { type IDBPDatabase, openDB } from "idb";
  */
 export type IndexeddbOptions = {};
 
-// WebKit で `Blob` を直接保存できない場合があるため、中間形式で保持します。
+/**
+ * WebKit で Blob を直接保存できない場合があるため、中間形式で保持します。
+ */
 type StoredBlob = {
+  /**
+   * File のときに保持するファイル名です。
+   */
   readonly name: string;
+
+  /**
+   * 元の Blob の MIME 種別です。
+   */
   readonly type: string;
+
+  /**
+   * Blob のバイト列です。
+   */
   readonly buffer: ArrayBuffer;
+
+  /**
+   * 中間形式であることを示す目印です。
+   */
   readonly unikvsBlob: true;
+
+  /**
+   * File 由来かどうかを示す目印です。
+   */
   readonly unikvsFile: boolean;
+
+  /**
+   * File のときに保持する更新時刻です。
+   */
   readonly lastModified: number;
 };
 
-// 保存した中間形式かどうかを判定します。
+/**
+ * 保存した中間形式かどうかを判定します。
+ *
+ * @param value 判定する値です。
+ *
+ * @returns 中間形式であれば true を返します。
+ */
 function isStoredBlob(value: unknown): value is StoredBlob {
   if (typeof value !== "object" || value === null) {
     return false;
@@ -25,8 +56,14 @@ function isStoredBlob(value: unknown): value is StoredBlob {
   return (value as Record<string, unknown>)["unikvsBlob"] === true;
 }
 
-// `Blob` を IndexedDB に保存できる中間形式に変換します。
-// `File` の名前と更新時刻も保持します。
+/**
+ * Blob を IndexedDB に保存できる中間形式に変換します。File の名前と更新時刻も保持します。
+ *
+ * @param signal 中断を知らせるシグナルです。
+ * @param data 変換する Blob です。
+ *
+ * @returns 中間形式に変換した値です。
+ */
 async function toStoredBlob(signal: AbortSignal, data: Blob): Promise<StoredBlob> {
   const buffer = await data.arrayBuffer();
 
@@ -44,7 +81,13 @@ async function toStoredBlob(signal: AbortSignal, data: Blob): Promise<StoredBlob
   };
 }
 
-// 中間形式を `Blob` または `File` に戻します。
+/**
+ * 中間形式を Blob または File に戻します。
+ *
+ * @param stored 中間形式の値です。
+ *
+ * @returns 復元した Blob または File です。
+ */
 function fromStoredBlob(stored: StoredBlob): Blob {
   if (stored.unikvsFile) {
     return new File([stored.buffer], stored.name, {
@@ -60,6 +103,11 @@ function fromStoredBlob(stored: StoredBlob): Blob {
  * [API Reference](https://tai-kun.github.io/unikvs/packages/indexeddb#usage)
  */
 export default class Indexeddb implements IStorage {
+  /**
+   * ストレージ名です。常に `Indexeddb` を返します。
+   */
+  public readonly name: string;
+
   /**
    * IndexedDB のデータベースインスタンスを保持します。
    *
@@ -82,8 +130,6 @@ export default class Indexeddb implements IStorage {
    */
   readonly #storeName: string;
 
-  public readonly name: string;
-
   /**
    * [API Reference](https://tai-kun.github.io/unikvs/packages/indexeddb#usage)
    */
@@ -99,22 +145,22 @@ export default class Indexeddb implements IStorage {
     this.#storeName = storeName;
   }
 
+  /**
+   * ストレージが開いているかどうかを返します。
+   *
+   * @returns データベース接続があれば true を返します。
+   */
   public get isOpen(): boolean {
     return this.#db !== null;
   }
 
-  // 開いているデータベースを返します。
-  // 未オープン時は `TypeError` を投げます。
-  #getDb(): IDBPDatabase {
-    const db = this.#db;
-
-    if (db === null) {
-      throw new TypeError("Indexeddb is not open. Call open() first.");
-    }
-
-    return db;
-  }
-
+  /**
+   * データベースを開きます。並行した呼び出しは一つの接続処理に束ねます。
+   *
+   * @param c 中断を知らせるシグナルを持つコンテキストです。
+   *
+   * @returns 完了を知らせるプロミスです。
+   */
   public async open(c: IStorage.OpenContext): Promise<void> {
     c.signal.throwIfAborted();
 
@@ -161,6 +207,13 @@ export default class Indexeddb implements IStorage {
     }
   }
 
+  /**
+   * データベース接続を閉じます。
+   *
+   * @param c 中断を知らせるシグナルを持つコンテキストです。
+   *
+   * @returns 完了を知らせるプロミスです。
+   */
   public async close(c: IStorage.CloseContext): Promise<void> {
     c.signal.throwIfAborted();
 
@@ -175,6 +228,14 @@ export default class Indexeddb implements IStorage {
     this.#db = null;
   }
 
+  /**
+   * 指定したキーに値を保存します。Blob は中間形式に変換して保存します。
+   *
+   * @param c 書き込み対象のキーを持つコンテキストです。
+   * @param data 保存する値です。
+   *
+   * @returns 完了を知らせるプロミスです。
+   */
   public async write(c: IStorage.WriteContext, data: any): Promise<void> {
     c.signal.throwIfAborted();
 
@@ -194,6 +255,13 @@ export default class Indexeddb implements IStorage {
     c.signal.throwIfAborted();
   }
 
+  /**
+   * 指定したキーの値を読み出します。中間形式は Blob または File に戻します。
+   *
+   * @param c 読み出すキーを持つコンテキストです。
+   *
+   * @returns 保存されている値です。
+   */
   public async read(c: IStorage.ReadContext): Promise<any> {
     c.signal.throwIfAborted();
 
@@ -223,6 +291,13 @@ export default class Indexeddb implements IStorage {
     return value;
   }
 
+  /**
+   * 指定したキーが存在するかどうかを返します。
+   *
+   * @param c 確認するキーを持つコンテキストです。
+   *
+   * @returns キーが存在すれば true を返します。
+   */
   public async exists(c: IStorage.ExistsContext): Promise<boolean> {
     c.signal.throwIfAborted();
 
@@ -236,6 +311,13 @@ export default class Indexeddb implements IStorage {
     return count > 0;
   }
 
+  /**
+   * 指定したキーを削除します。
+   *
+   * @param c 削除するキーを持つコンテキストです。
+   *
+   * @returns 完了を知らせるプロミスです。
+   */
   public async delete(c: IStorage.DeleteContext): Promise<void> {
     c.signal.throwIfAborted();
 
@@ -245,6 +327,13 @@ export default class Indexeddb implements IStorage {
     c.signal.throwIfAborted();
   }
 
+  /**
+   * オブジェクトストアのすべての値を削除します。
+   *
+   * @param c 中断を知らせるシグナルを持つコンテキストです。
+   *
+   * @returns 完了を知らせるプロミスです。
+   */
   public async clear(c: IStorage.ClearContext): Promise<void> {
     c.signal.throwIfAborted();
 
@@ -254,6 +343,13 @@ export default class Indexeddb implements IStorage {
     c.signal.throwIfAborted();
   }
 
+  /**
+   * Uint8Array を書き込むためのストリームを作成します。close 時にまとめて保存します。
+   *
+   * @param c 書き込み対象のキーを持つコンテキストです。
+   *
+   * @returns Uint8Array を受け付ける書き込みストリームです。
+   */
   public getWritable(c: IStorage.GetWritableContext): WritableStream<Uint8Array> {
     c.signal.throwIfAborted();
 
@@ -288,6 +384,13 @@ export default class Indexeddb implements IStorage {
     });
   }
 
+  /**
+   * 保存済みの値を読み出すストリームを作成します。
+   *
+   * @param c 読み出すキーを持つコンテキストです。
+   *
+   * @returns Uint8Array を送出する読み取りストリームです。
+   */
   public getReadable(c: IStorage.GetReadableContext): ReadableStream<Uint8Array> {
     c.signal.throwIfAborted();
 
@@ -305,4 +408,19 @@ export default class Indexeddb implements IStorage {
       },
     });
   }
+
+  /**
+   * 開いているデータベースを返します。未オープン時はエラーを投げます。
+   *
+   * @returns 開いているデータベースです。
+   */
+  #getDb(): IDBPDatabase {
+    const db = this.#db;
+
+    if (db === null) {
+      throw new TypeError("Indexeddb is not open. Call open() first.");
+    }
+
+    return db;
+  }
 }