dl-once 0.0.1 → 0.0.2

package/dist/memory-cache-storage.js

@@ -0,0 +1,290 @@
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _MemoryCacheWriter_instances, _MemoryCacheWriter_storage, _MemoryCacheWriter_onComplete, _MemoryCacheWriter_buffer, _MemoryCacheWriter_reason, _MemoryCacheWriter_isClosed, _MemoryCacheWriter_assertOk, _MemoryCacheHandle_instances, _MemoryCacheHandle_storage, _MemoryCacheHandle_buffer, _MemoryCacheHandle_assertOk, _MemoryCacheStorage_instances, _MemoryCacheStorage_store, _MemoryCacheStorage_assertOk;
+import { tryCaptureStackTrace } from "try-capture-stack-trace";
+/**
+ * 中断理由が設定されていないことを示すための初期値シンボルです。
+ */
+const NONE = Symbol();
+/**
+ * メモリーキャッシュへの書き込みを担当するクラスです。
+ *
+ * データのチャンクを一時的に蓄積し、完了時にストレージへ保存します。
+ */
+class MemoryCacheWriter {
+    /**
+     * MemoryCacheWriter の新しいインスタンスを生成します。
+     *
+     * @param storage 関連付けられたメモリーキャッシュストレージです。
+     * @param onComplete 書き込み成功時にチャンク配列を受け取るコールバックです。
+     */
+    constructor(storage, onComplete) {
+        _MemoryCacheWriter_instances.add(this);
+        /**
+         * 参照先のメモリーキャッシュストレージです。
+         */
+        _MemoryCacheWriter_storage.set(this, void 0);
+        /**
+         * 書き込み完了時に実行されるコールバック関数です。
+         */
+        _MemoryCacheWriter_onComplete.set(this, void 0);
+        /**
+         * 書き込まれたバイナリーデータのチャンクを保持する配列です。
+         */
+        _MemoryCacheWriter_buffer.set(this, void 0);
+        /**
+         * 書き込みが中断（abort）された際の理由を保持します。
+         */
+        _MemoryCacheWriter_reason.set(this, void 0);
+        /**
+         * ライターが閉じられたかどうかを管理するフラグです。
+         */
+        _MemoryCacheWriter_isClosed.set(this, void 0);
+        __classPrivateFieldSet(this, _MemoryCacheWriter_storage, storage, "f");
+        __classPrivateFieldSet(this, _MemoryCacheWriter_onComplete, onComplete, "f");
+        __classPrivateFieldSet(this, _MemoryCacheWriter_buffer, [], "f");
+        __classPrivateFieldSet(this, _MemoryCacheWriter_reason, NONE, "f");
+        __classPrivateFieldSet(this, _MemoryCacheWriter_isClosed, false, "f");
+    }
+    /**
+     * データのチャンクを内部バッファーに書き込みます。
+     *
+     * @param chunkData 書き込むバイナリーデータです。
+     */
+    write(chunkData) {
+        __classPrivateFieldGet(this, _MemoryCacheWriter_instances, "m", _MemoryCacheWriter_assertOk).call(this);
+        // メモリー上の配列にチャンクを追加します。
+        __classPrivateFieldGet(this, _MemoryCacheWriter_buffer, "f").push(chunkData);
+    }
+    /**
+     * 書き込みを正常に終了し、蓄積されたデータを確定させます。
+     */
+    close() {
+        __classPrivateFieldGet(this, _MemoryCacheWriter_instances, "m", _MemoryCacheWriter_assertOk).call(this);
+        // 蓄積した全チャンクをコールバックに渡し、キャッシュとして確定させます。
+        __classPrivateFieldGet(this, _MemoryCacheWriter_onComplete, "f").call(this, __classPrivateFieldGet(this, _MemoryCacheWriter_buffer, "f"));
+        __classPrivateFieldSet(this, _MemoryCacheWriter_onComplete, () => { }, "f");
+        __classPrivateFieldSet(this, _MemoryCacheWriter_buffer, [], "f");
+        __classPrivateFieldSet(this, _MemoryCacheWriter_isClosed, true, "f");
+    }
+    /**
+     * 書き込みを中断し、蓄積されたデータを破棄します。
+     *
+     * @param reason 中断した理由（エラーオブジェクトなど）です。
+     */
+    abort(reason) {
+        __classPrivateFieldGet(this, _MemoryCacheWriter_instances, "m", _MemoryCacheWriter_assertOk).call(this);
+        // 蓄積していたバッファーを直ちに解放します。
+        __classPrivateFieldSet(this, _MemoryCacheWriter_buffer, [], "f");
+        __classPrivateFieldSet(this, _MemoryCacheWriter_reason, reason, "f");
+        __classPrivateFieldSet(this, _MemoryCacheWriter_isClosed, true, "f");
+    }
+}
+_MemoryCacheWriter_storage = new WeakMap(), _MemoryCacheWriter_onComplete = new WeakMap(), _MemoryCacheWriter_buffer = new WeakMap(), _MemoryCacheWriter_reason = new WeakMap(), _MemoryCacheWriter_isClosed = new WeakMap(), _MemoryCacheWriter_instances = new WeakSet(), _MemoryCacheWriter_assertOk = function _MemoryCacheWriter_assertOk() {
+    // ストレージ本体が有効であることを確認します。
+    if (!__classPrivateFieldGet(this, _MemoryCacheWriter_storage, "f").isOpen) {
+        const error = new Error("MemoryCacheStorage is closed");
+        tryCaptureStackTrace(error, __classPrivateFieldGet(this, _MemoryCacheWriter_instances, "m", _MemoryCacheWriter_assertOk));
+        throw error;
+    }
+    // ライターがクローズまたはアボート済みでないか確認します。
+    if (__classPrivateFieldGet(this, _MemoryCacheWriter_isClosed, "f")) {
+        // 異常終了（abort）している場合はその理由を、正常終了している場合は標準エラーを投げます。
+        if (__classPrivateFieldGet(this, _MemoryCacheWriter_reason, "f") === NONE) {
+            const error = new Error("MemoryCacheWriter is closed");
+            tryCaptureStackTrace(error, __classPrivateFieldGet(this, _MemoryCacheWriter_instances, "m", _MemoryCacheWriter_assertOk));
+            throw error;
+        }
+        throw __classPrivateFieldGet(this, _MemoryCacheWriter_reason, "f");
+    }
+};
+/**
+ * 特定のキーに対応するキャッシュデータを操作するためのハンドルです。
+ */
+class MemoryCacheHandle {
+    /**
+     * MemoryCacheHandle の新しいインスタンスを生成します。
+     *
+     * @param storage 関連付けられたメモリーキャッシュストレージです。
+     */
+    constructor(storage) {
+        _MemoryCacheHandle_instances.add(this);
+        /**
+         * 親となるストレージインスタンスです。
+         */
+        _MemoryCacheHandle_storage.set(this, void 0);
+        /**
+         * キャッシュされたバイナリーデータのリストです。まだデータがない場合は null です。
+         */
+        _MemoryCacheHandle_buffer.set(this, void 0);
+        __classPrivateFieldSet(this, _MemoryCacheHandle_storage, storage, "f");
+        __classPrivateFieldSet(this, _MemoryCacheHandle_buffer, null, "f");
+    }
+    /**
+     * キャッシュされたデータをクリアします。
+     */
+    clear() {
+        __classPrivateFieldGet(this, _MemoryCacheHandle_instances, "m", _MemoryCacheHandle_assertOk).call(this);
+        __classPrivateFieldSet(this, _MemoryCacheHandle_buffer, null, "f");
+    }
+    /**
+     * キャッシュされたデータを読み取るためのイテレーターを取得します。
+     *
+     * @returns データのチャンクを順次返すイテレーターを返します。キャッシュがない場合は null を返します。
+     */
+    getReader(args) {
+        const { signal } = args;
+        signal?.throwIfAborted();
+        __classPrivateFieldGet(this, _MemoryCacheHandle_instances, "m", _MemoryCacheHandle_assertOk).call(this);
+        // まだ書き込みが完了していない（キャッシュデータがない）場合は null を返して終了します。
+        if (!__classPrivateFieldGet(this, _MemoryCacheHandle_buffer, "f")) {
+            return null;
+        }
+        const buffer = __classPrivateFieldGet(this, _MemoryCacheHandle_buffer, "f");
+        const storage = __classPrivateFieldGet(this, _MemoryCacheHandle_storage, "f");
+        function* createReader() {
+            // 保存されているチャンクを順番に yield します。
+            for (const chunk of buffer) {
+                // 読み取り中にストレージが破棄されていないか確認します。
+                if (!storage.isOpen) {
+                    throw new Error("MemoryCacheStorage is closed");
+                }
+                yield chunk;
+            }
+        }
+        return createReader();
+    }
+    /**
+     * キャッシュにデータを書き込むためのライターを生成します。
+     *
+     * @returns IWriter インターフェースを実装したライターオブジェクトを返します。
+     */
+    getWriter(args) {
+        const { signal } = args;
+        signal?.throwIfAborted();
+        __classPrivateFieldGet(this, _MemoryCacheHandle_instances, "m", _MemoryCacheHandle_assertOk).call(this);
+        // ライターが close されたときに、このハンドル内の #buffer にデータがセットされるようにします。
+        return new MemoryCacheWriter(__classPrivateFieldGet(this, _MemoryCacheHandle_storage, "f"), buffer => {
+            __classPrivateFieldSet(this, _MemoryCacheHandle_buffer, buffer, "f");
+        });
+    }
+}
+_MemoryCacheHandle_storage = new WeakMap(), _MemoryCacheHandle_buffer = new WeakMap(), _MemoryCacheHandle_instances = new WeakSet(), _MemoryCacheHandle_assertOk = function _MemoryCacheHandle_assertOk() {
+    // ストレージ本体が有効であることを確認します。
+    if (!__classPrivateFieldGet(this, _MemoryCacheHandle_storage, "f").isOpen) {
+        const error = new Error("MemoryCacheStorage is closed");
+        tryCaptureStackTrace(error, __classPrivateFieldGet(this, _MemoryCacheHandle_instances, "m", _MemoryCacheHandle_assertOk));
+        throw error;
+    }
+};
+/**
+ * メモリー上でのデータキャッシュを管理するストレージクラスです。
+ *
+ * Map を使用してキーごとにキャッシュハンドルを保持します。
+ */
+export default class MemoryCacheStorage {
+    constructor() {
+        _MemoryCacheStorage_instances.add(this);
+        /**
+         * キャッシュキーとハンドルの対応を保持する内部マップです。
+         *
+         * ストレージが閉じているときは null になります。
+         */
+        _MemoryCacheStorage_store.set(this, null);
+    }
+    /**
+     * ストレージが現在開いているかどうかを返します。
+     */
+    get isOpen() {
+        return !!__classPrivateFieldGet(this, _MemoryCacheStorage_store, "f");
+    }
+    /**
+     * ストレージを開き、利用可能な状態にします。
+     */
+    open(options = {}) {
+        const { signal } = options;
+        signal?.throwIfAborted();
+        if (__classPrivateFieldGet(this, _MemoryCacheStorage_store, "f")) {
+            throw new Error("Storage is already open");
+        }
+        __classPrivateFieldSet(this, _MemoryCacheStorage_store, new Map(), "f");
+    }
+    /**
+     * ストレージを閉じ、すべてのキャッシュデータを破棄します。
+     */
+    close(options = {}) {
+        const { signal } = options;
+        signal?.throwIfAborted();
+        __classPrivateFieldGet(this, _MemoryCacheStorage_instances, "m", _MemoryCacheStorage_assertOk).call(this);
+        // メモリ解放のためマップをクリアし、null を代入します。
+        __classPrivateFieldGet(this, _MemoryCacheStorage_store, "f").clear();
+        __classPrivateFieldSet(this, _MemoryCacheStorage_store, null, "f");
+    }
+    /**
+     * Explicit Resource Management (Using 構文) をサポートするための破棄メソッドです。
+     */
+    [(_MemoryCacheStorage_store = new WeakMap(), _MemoryCacheStorage_instances = new WeakSet(), _MemoryCacheStorage_assertOk = function _MemoryCacheStorage_assertOk() {
+        // ストレージ本体が有効であることを確認します。
+        if (!this.isOpen) {
+            const error = new Error("MemoryCacheStorage is closed");
+            tryCaptureStackTrace(error, __classPrivateFieldGet(this, _MemoryCacheStorage_instances, "m", _MemoryCacheStorage_assertOk));
+            throw error;
+        }
+    }, Symbol.dispose)]() {
+        // 既に閉じられている可能性を考慮し、オプショナルチェイニングを使用してクリアします。
+        __classPrivateFieldGet(this, _MemoryCacheStorage_store, "f")?.clear();
+        __classPrivateFieldSet(this, _MemoryCacheStorage_store, null, "f");
+    }
+    clear(cacheKeyOrOptions, options = {}) {
+        // 引数の型に応じてオプションを正規化します。
+        const { signal, cacheKey, } = typeof cacheKeyOrOptions === "object"
+            ? cacheKeyOrOptions
+            : {
+                ...options,
+                cacheKey: cacheKeyOrOptions,
+            };
+        signal?.throwIfAborted();
+        __classPrivateFieldGet(this, _MemoryCacheStorage_instances, "m", _MemoryCacheStorage_assertOk).call(this);
+        const store = __classPrivateFieldGet(this, _MemoryCacheStorage_store, "f");
+        if (cacheKey !== undefined) {
+            const handle = store.get(cacheKey);
+            if (handle) {
+                handle.clear();
+                store.delete(cacheKey);
+            }
+        }
+        else {
+            // 全てのハンドルのデータをクリアしてから Map を空にする
+            for (const handle of store.values()) {
+                handle.clear();
+            }
+            store.clear();
+        }
+    }
+    /**
+     * 指定したキーに対応するキャッシュハンドルを取得、または新規作成します。
+     *
+     * @param key キャッシュを一意に識別する文字列です。
+     * @returns ICacheHandle を実装したオブジェクトを返します。
+     */
+    createCacheHandle(key) {
+        __classPrivateFieldGet(this, _MemoryCacheStorage_instances, "m", _MemoryCacheStorage_assertOk).call(this);
+        const store = __classPrivateFieldGet(this, _MemoryCacheStorage_store, "f");
+        // 既にハンドルが存在すればそれを返し、なければ新規作成してストアに登録します。
+        let handle = store.get(key);
+        if (!handle) {
+            handle = new MemoryCacheHandle(this);
+            store.set(key, handle);
+        }
+        return handle;
+    }
+}

package/dist/node-fs-cache-storage.d.ts

@@ -0,0 +1,63 @@
+import type { ClearOptions, CloseOptions, ICacheStorage, OpenOptions } from "./cache-storage.js";
+import type { ICacheHandle } from "./dl-once.js";
+/**
+ * Node.js のファイルシステムを基盤としたキャッシュストレージの実装です。
+ */
+export default class NodeFsCacheStorage implements ICacheStorage, AsyncDisposable {
+    #private;
+    /**
+     * インスタンスを生成します。
+     *
+     * @param baseDir キャッシュを保存するベースディレクトリーです。デフォルトは ".dl-once" です。
+     */
+    constructor(baseDir?: string | undefined);
+    /**
+     * ストレージが現在利用可能（オープン状態）かどうかを取得します。
+     */
+    get isOpen(): boolean;
+    /**
+     * ストレージを初期化し、利用可能な状態にします。
+     *
+     * 必要な Node.js モジュールのインポートとベースディレクトリーの作成を行います。
+     *
+     * @param options オープン時のオプション（タイムアウト用シグナルなど）です。
+     * @returns 完了を示すプロミスです。
+     */
+    open(options?: OpenOptions | undefined): Promise<void>;
+    /**
+     * ストレージを閉じ、以降の操作を無効化します。
+     *
+     * @param options クローズ時のオプションです。
+     * @returns 完了を示すプロミスです。
+     */
+    close(options?: CloseOptions | undefined): Promise<void>;
+    /**
+     * `using` 構文などで自動的にリソースを解放するためのメソッドです。
+     *
+     * @returns 完了を示すプロミスです。
+     */
+    [Symbol.asyncDispose](): Promise<void>;
+    /**
+     * 特定のキャッシュ、またはストレージ全体を削除します。
+     *
+     * @param cacheKey 削除対象の特定のキャッシュキーです。
+     * @param options 削除オプションです。
+     * @returns 完了を示すプロミスです。
+     */
+    clear(cacheKey?: string | undefined, options?: Omit<ClearOptions, "cacheKey"> | undefined): Promise<void>;
+    /**
+     * オプション指定による削除を行います。
+     *
+     * @param options 削除オプションです。
+     * @returns 完了を示すプロミスです。
+     */
+    clear(options?: ClearOptions | undefined): Promise<void>;
+    /**
+     * 指定されたキーに対応するキャッシュ操作ハンドルを作成します。
+     *
+     * @param key キャッシュを一意に識別するキーです。
+     * @returns キャッシュハンドルインスタンスです。
+     */
+    createCacheHandle(key: string): ICacheHandle;
+}
+//# sourceMappingURL=node-fs-cache-storage.d.ts.map

package/dist/node-fs-cache-storage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"node-fs-cache-storage.d.ts","sourceRoot":"","sources":["../src/node-fs-cache-storage.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjG,OAAO,KAAK,EAAgC,YAAY,EAAW,MAAM,cAAc,CAAC;AAmUxF;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,kBAAmB,YAAW,aAAa,EAAE,eAAe;;IAqB/E;;;;OAIG;gBACgB,OAAO,GAAE,MAAM,GAAG,SAAsB;IAkB3D;;OAEG;IACH,IAAW,MAAM,IAAI,OAAO,CAE3B;IAED;;;;;;;OAOG;IACU,IAAI,CAAC,OAAO,GAAE,WAAW,GAAG,SAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAwBvE;;;;;OAKG;IACU,KAAK,CAAC,OAAO,GAAE,YAAY,GAAG,SAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAUzE;;;;OAIG;IACU,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC;IAMnD;;;;;;OAMG;IACI,KAAK,CACV,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,EAC7B,OAAO,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,UAAU,CAAC,GAAG,SAAS,GACnD,OAAO,CAAC,IAAI,CAAC;IAEhB;;;;;OAKG;IACI,KAAK,CAAC,OAAO,CAAC,EAAE,YAAY,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAwC/D;;;;;OAKG;IACI,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY;CAOpD"}