@chriscdn/file-cache 0.0.13 → 2.0.0

package/lib/index.d.ts

@@ -2,7 +2,7 @@ type DirectoryPath = string;
 type FileName = string;
 type FilePath = string;
 type Milliseconds = number;
-export type FileCacheOptions<T extends Record<string, any>> = {
+type FileCacheOptions<T extends Record<string, any>> = {
     cachePath: DirectoryPath;
     autoCreateCachePath?: boolean;
     cb: (filePath: FilePath, args: T, cache: FileCache<T>) => Promise<void>;
@@ -58,4 +58,5 @@ declare class FileCache<T extends Record<string, any>> {
      */
     cleanup(): Promise<void>;
 }
-export { type DirectoryPath, FileCache, type FileName, type FilePath };
+
+export { type DirectoryPath, FileCache, type FileCacheOptions, type FileName, type FilePath };

package/lib/index.js

@@ -1,3 +1,4 @@
+// src/index.ts
 import path from "path";
 import fs from "fs";
 import { pathExists, pathExistsSync } from "path-exists";
@@ -6,129 +7,137 @@ import { GroupSemaphore, Semaphore } from "@chriscdn/promise-semaphore";
 import touch from "touch";
 import { findNuke } from "@chriscdn/find-nuke";
 import { Duration } from "@chriscdn/duration";
-class FileCache {
-    _cachePath;
-    _cb;
-    _ttl;
-    _cleanupInterval;
-    _resolveCacheKey;
-    _ext;
-    _intervalId = null;
-    _semaphore = new Semaphore();
-    _cleanupGroupSemaphore = new GroupSemaphore();
-    constructor({ cachePath, autoCreateCachePath, cb, ext, ttl, cleanupInterval, resolveCacheKey, }) {
-        this._cachePath = cachePath;
-        this._cb = cb;
-        this._ext = ext;
-        this._ttl = ttl;
-        this._cleanupInterval = cleanupInterval ??
-            Duration.toMilliseconds({ days: 1 });
-        this._resolveCacheKey = resolveCacheKey ??
-            ((args) => (JSON.stringify(args)));
-        // Startup code
-        if ((pathExistsSync(cachePath))) {
-            // we're good
-        }
-        else if (autoCreateCachePath) {
-            fs.mkdirSync(cachePath, { recursive: true });
-        }
-        else {
-            throw new Error("💥 FileCache error: cachePath does not exist.");
-        }
-        // fire and forget
-        this.cleanup();
-        this._intervalId = setInterval(this.cleanup.bind(this), this._cleanupInterval);
+var FileCache = class {
+  _cachePath;
+  _cb;
+  _ttl;
+  _cleanupInterval;
+  _resolveCacheKey;
+  _ext;
+  _intervalId = null;
+  _semaphore = new Semaphore();
+  _cleanupGroupSemaphore = new GroupSemaphore();
+  constructor({
+    cachePath,
+    autoCreateCachePath,
+    cb,
+    ext,
+    ttl,
+    cleanupInterval,
+    resolveCacheKey
+  }) {
+    this._cachePath = cachePath;
+    this._cb = cb;
+    this._ext = ext;
+    this._ttl = ttl;
+    this._cleanupInterval = cleanupInterval ?? Duration.toMilliseconds({ days: 1 });
+    this._resolveCacheKey = resolveCacheKey ?? ((args) => JSON.stringify(args));
+    if (pathExistsSync(cachePath)) {
+    } else if (autoCreateCachePath) {
+      fs.mkdirSync(cachePath, { recursive: true });
+    } else {
+      throw new Error("\u{1F4A5} FileCache error: cachePath does not exist.");
     }
-    /**
-     * Resolves the filename for the cache based on the provided arguments.
-     *
-     * Uses the provided `resolveFileName` function if available, or falls back to
-     * generating a hash from the arguments to create a unique file name.
-     */
-    async resolveFileName(args) {
-        const [name, ext] = await Promise.all([
-            this._resolveCacheKey(args),
-            this._ext(args),
-        ]);
-        const resolvedFileName = sha1(JSON.stringify([name, ext]));
-        return path.format({
-            name: resolvedFileName,
-            ext,
-        });
+    this.cleanup();
+    this._intervalId = setInterval(
+      this.cleanup.bind(this),
+      this._cleanupInterval
+    );
+  }
+  /**
+   * Resolves the filename for the cache based on the provided arguments.
+   *
+   * Uses the provided `resolveFileName` function if available, or falls back to
+   * generating a hash from the arguments to create a unique file name.
+   */
+  async resolveFileName(args) {
+    const [name, ext] = await Promise.all([
+      this._resolveCacheKey(args),
+      this._ext(args)
+    ]);
+    const resolvedFileName = sha1(JSON.stringify([name, ext]));
+    return path.format({
+      name: resolvedFileName,
+      ext
+    });
+  }
+  /**
+   * Retrieves a cached file for the given arguments.
+   * If the file doesn't exist, it is generated by the callback and stored.
+   *
+   * Concurrency-safe, ensuring no conflicts when multiple requests are made
+   * for the same file.
+   *
+   * @param args The arguments used to determine the file's identity and generation
+   * @returns The path to the cached or newly created file
+   */
+  async getFile(args) {
+    const filePath = await this.resolveFilePath(args);
+    try {
+      await Promise.all([
+        this._cleanupGroupSemaphore.acquire("getFile"),
+        this._semaphore.acquire(filePath)
+      ]);
+      if (await pathExists(filePath)) {
+        touch(filePath);
+      } else {
+        await fs.promises.mkdir(path.dirname(filePath), { recursive: true });
+        await this._cb(filePath, args, this);
+      }
+    } finally {
+      this._semaphore.release(filePath);
+      this._cleanupGroupSemaphore.release("getFile");
     }
-    /**
-     * Retrieves a cached file for the given arguments.
-     * If the file doesn't exist, it is generated by the callback and stored.
-     *
-     * Concurrency-safe, ensuring no conflicts when multiple requests are made
-     * for the same file.
-     *
-     * @param args The arguments used to determine the file's identity and generation
-     * @returns The path to the cached or newly created file
-     */
-    async getFile(args) {
-        const filePath = await this.resolveFilePath(args);
-        try {
-            await Promise.all([
-                this._cleanupGroupSemaphore.acquire("getFile"),
-                this._semaphore.acquire(filePath),
-            ]);
-            if (await pathExists(filePath)) {
-                // fire and forget
-                touch(filePath);
-            }
-            else {
-                await fs.promises.mkdir(path.dirname(filePath), { recursive: true });
-                await this._cb(filePath, args, this);
-            }
-        }
-        finally {
-            this._semaphore.release(filePath);
-            this._cleanupGroupSemaphore.release("getFile");
-        }
-        return filePath;
+    return filePath;
+  }
+  /**
+   * Resolves the full file path for the cached file based on the provided arguments.
+   *
+   * @param args The arguments used to resolve the file path
+   * @returns The full path to the cached file
+   */
+  async resolveFilePath(args) {
+    const fileName = await this.resolveFileName(args);
+    const filePath = path.resolve(
+      this._cachePath,
+      fileName[0],
+      fileName[1],
+      fileName[2],
+      fileName
+    );
+    return filePath;
+  }
+  /**
+   * Stops the background cleanup process, but does not delete any cached files.
+   */
+  destroy() {
+    if (this._intervalId) {
+      clearInterval(this._intervalId);
+      this._intervalId = null;
     }
-    /**
-     * Resolves the full file path for the cached file based on the provided arguments.
-     *
-     * @param args The arguments used to resolve the file path
-     * @returns The full path to the cached file
-     */
-    async resolveFilePath(args) {
-        const fileName = await this.resolveFileName(args);
-        const filePath = path.resolve(this._cachePath, fileName[0], fileName[1], fileName[2], fileName);
-        return filePath;
+  }
+  async has(args) {
+    const filePath = await this.resolveFilePath(args);
+    return await pathExists(filePath);
+  }
+  /**
+   * Runs a cleanup pass to remove files older than 1 day from the cache.
+   * This is called periodically, but can be triggered manually.
+   */
+  async cleanup() {
+    try {
+      await this._cleanupGroupSemaphore.acquire("cleanup");
+      await findNuke(this._cachePath, {
+        olderThan: this._ttl,
+        verbose: true,
+        deleteEmptyDirectories: true
+      });
+    } finally {
+      this._cleanupGroupSemaphore.release("cleanup");
     }
-    /**
-     * Stops the background cleanup process, but does not delete any cached files.
-     */
-    destroy() {
-        if (this._intervalId) {
-            clearInterval(this._intervalId);
-            this._intervalId = null;
-        }
-    }
-    async has(args) {
-        const filePath = await this.resolveFilePath(args);
-        return await pathExists(filePath);
-    }
-    /**
-     * Runs a cleanup pass to remove files older than 1 day from the cache.
-     * This is called periodically, but can be triggered manually.
-     */
-    async cleanup() {
-        try {
-            await this._cleanupGroupSemaphore.acquire("cleanup");
-            await findNuke(this._cachePath, {
-                olderThan: this._ttl,
-                verbose: true,
-                deleteEmptyDirectories: true,
-            });
-        }
-        finally {
-            this._cleanupGroupSemaphore.release("cleanup");
-        }
-    }
-}
-export { FileCache };
+  }
+};
+export {
+  FileCache
+};
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AACzD,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AACxE,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAiB9C,MAAM,SAAS;IACL,UAAU,CAAmC;IAC7C,GAAG,CAA4B;IAC/B,IAAI,CAA6B;IACjC,gBAAgB,CAAyC;IACzD,gBAAgB,CAEH;IACb,IAAI,CAA6B;IACjC,WAAW,GAA0C,IAAI,CAAC;IAC1D,UAAU,GAAc,IAAI,SAAS,EAAE,CAAC;IACxC,sBAAsB,GAAmB,IAAI,cAAc,EAAE,CAAC;IAEtE,YACE,EACE,SAAS,EACT,mBAAmB,EACnB,EAAE,EACF,GAAG,EACH,GAAG,EACH,eAAe,EACf,eAAe,GACK;QAEtB,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;QACd,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;QAChB,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;QAChB,IAAI,CAAC,gBAAgB,GAAG,eAAe;YACrC,QAAQ,CAAC,cAAc,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC;QAEvC,IAAI,CAAC,gBAAgB,GAAG,eAAe;YACrC,CAAC,CAAC,IAAO,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAExC,eAAe;QACf,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;YAChC,aAAa;QACf,CAAC;aAAM,IAAI,mBAAmB,EAAE,CAAC;YAC/B,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC/C,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;QACnE,CAAC;QAED,kBAAkB;QAClB,IAAI,CAAC,OAAO,EAAE,CAAC;QAEf,IAAI,CAAC,WAAW,GAAG,WAAW,CAC5B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EACvB,IAAI,CAAC,gBAAgB,CACtB,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,eAAe,CAAC,IAAO;QACnC,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACpC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC;YAC3B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;SAChB,CAAC,CAAC;QAEH,MAAM,gBAAgB,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;QAE3D,OAAO,IAAI,CAAC,MAAM,CAAC;YACjB,IAAI,EAAE,gBAAgB;YACtB,GAAG;SACJ,CAAa,CAAC;IACjB,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,OAAO,CAAC,IAAO;QACnB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAElD,IAAI,CAAC;YACH,MAAM,OAAO,CAAC,GAAG,CAAC;gBAChB,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,SAAS,CAAC;gBAC9C,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC;aAClC,CAAC,CAAC;YAEH,IAAI,MAAM,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC/B,kBAAkB;gBAClB,KAAK,CAAC,QAAQ,CAAC,CAAC;YAClB,CAAC;iBAAM,CAAC;gBACN,MAAM,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;gBACrE,MAAM,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;YACvC,CAAC;QACH,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YAClC,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACjD,CAAC;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,eAAe,CAAC,IAAO;QAC3B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAElD,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAC3B,IAAI,CAAC,UAAU,EACf,QAAQ,CAAC,CAAC,CAAC,EACX,QAAQ,CAAC,CAAC,CAAC,EACX,QAAQ,CAAC,CAAC,CAAC,EACX,QAAQ,CACT,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;OAEG;IACH,OAAO;QACL,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAChC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QAC1B,CAAC;IACH,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,IAAO;QACf,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAClD,OAAO,MAAM,UAAU,CAAC,QAAQ,CAAC,CAAC;IACpC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,OAAO;QACX,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YACrD,MAAM,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE;gBAC9B,SAAS,EAAE,IAAI,CAAC,IAAI;gBACpB,OAAO,EAAE,IAAI;gBACb,sBAAsB,EAAE,IAAI;aAC7B,CAAC,CAAC;QACL,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACjD,CAAC;IACH,CAAC;CACF;AAED,OAAO,EAAsB,SAAS,EAAgC,CAAC"}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import path from \"path\";\nimport fs from \"fs\";\nimport { pathExists, pathExistsSync } from \"path-exists\";\nimport sha1 from \"sha1\";\nimport { GroupSemaphore, Semaphore } from \"@chriscdn/promise-semaphore\";\nimport touch from \"touch\";\nimport { findNuke } from \"@chriscdn/find-nuke\";\nimport { Duration } from \"@chriscdn/duration\";\n\ntype DirectoryPath = string;\ntype FileName = string;\ntype FilePath = string;\ntype Milliseconds = number;\n\nexport type FileCacheOptions<T extends Record<string, any>> = {\n  cachePath: DirectoryPath;\n  autoCreateCachePath?: boolean;\n  cb: (filePath: FilePath, args: T, cache: FileCache<T>) => Promise<void>;\n  ext: (args: T) => string | Promise<string>;\n  resolveCacheKey?: (args: T) => string | Promise<string>;\n  ttl: Milliseconds;\n  cleanupInterval?: Milliseconds;\n};\n\nclass FileCache<T extends Record<string, any>> {\n  private _cachePath: FileCacheOptions<T>[\"cachePath\"];\n  private _cb: FileCacheOptions<T>[\"cb\"];\n  private _ttl: FileCacheOptions<T>[\"ttl\"];\n  private _cleanupInterval: FileCacheOptions<T>[\"cleanupInterval\"];\n  private _resolveCacheKey: Required<\n    FileCacheOptions<T>\n  >[\"resolveCacheKey\"];\n  private _ext: FileCacheOptions<T>[\"ext\"];\n  private _intervalId: ReturnType<typeof setInterval> | null = null;\n  private _semaphore: Semaphore = new Semaphore();\n  private _cleanupGroupSemaphore: GroupSemaphore = new GroupSemaphore();\n\n  constructor(\n    {\n      cachePath,\n      autoCreateCachePath,\n      cb,\n      ext,\n      ttl,\n      cleanupInterval,\n      resolveCacheKey,\n    }: FileCacheOptions<T>,\n  ) {\n    this._cachePath = cachePath;\n    this._cb = cb;\n    this._ext = ext;\n    this._ttl = ttl;\n    this._cleanupInterval = cleanupInterval ??\n      Duration.toMilliseconds({ days: 1 });\n\n    this._resolveCacheKey = resolveCacheKey ??\n      ((args: T) => (JSON.stringify(args)));\n\n    // Startup code\n    if ((pathExistsSync(cachePath))) {\n      // we're good\n    } else if (autoCreateCachePath) {\n      fs.mkdirSync(cachePath, { recursive: true });\n    } else {\n      throw new Error(\"💥 FileCache error: cachePath does not exist.\");\n    }\n\n    // fire and forget\n    this.cleanup();\n\n    this._intervalId = setInterval(\n      this.cleanup.bind(this),\n      this._cleanupInterval,\n    );\n  }\n\n  /**\n   * Resolves the filename for the cache based on the provided arguments.\n   *\n   * Uses the provided `resolveFileName` function if available, or falls back to\n   * generating a hash from the arguments to create a unique file name.\n   */\n  private async resolveFileName(args: T): Promise<FileName> {\n    const [name, ext] = await Promise.all([\n      this._resolveCacheKey(args),\n      this._ext(args),\n    ]);\n\n    const resolvedFileName = sha1(JSON.stringify([name, ext]));\n\n    return path.format({\n      name: resolvedFileName,\n      ext,\n    }) as FileName;\n  }\n\n  /**\n   * Retrieves a cached file for the given arguments.\n   * If the file doesn't exist, it is generated by the callback and stored.\n   *\n   * Concurrency-safe, ensuring no conflicts when multiple requests are made\n   * for the same file.\n   *\n   * @param args The arguments used to determine the file's identity and generation\n   * @returns The path to the cached or newly created file\n   */\n  async getFile(args: T): Promise<FilePath> {\n    const filePath = await this.resolveFilePath(args);\n\n    try {\n      await Promise.all([\n        this._cleanupGroupSemaphore.acquire(\"getFile\"),\n        this._semaphore.acquire(filePath),\n      ]);\n\n      if (await pathExists(filePath)) {\n        // fire and forget\n        touch(filePath);\n      } else {\n        await fs.promises.mkdir(path.dirname(filePath), { recursive: true });\n        await this._cb(filePath, args, this);\n      }\n    } finally {\n      this._semaphore.release(filePath);\n      this._cleanupGroupSemaphore.release(\"getFile\");\n    }\n\n    return filePath;\n  }\n\n  /**\n   * Resolves the full file path for the cached file based on the provided arguments.\n   *\n   * @param args The arguments used to resolve the file path\n   * @returns The full path to the cached file\n   */\n  async resolveFilePath(args: T): Promise<FilePath> {\n    const fileName = await this.resolveFileName(args);\n\n    const filePath = path.resolve(\n      this._cachePath,\n      fileName[0]!,\n      fileName[1]!,\n      fileName[2]!,\n      fileName,\n    );\n\n    return filePath;\n  }\n\n  /**\n   * Stops the background cleanup process, but does not delete any cached files.\n   */\n  destroy() {\n    if (this._intervalId) {\n      clearInterval(this._intervalId);\n      this._intervalId = null;\n    }\n  }\n\n  async has(args: T): Promise<boolean> {\n    const filePath = await this.resolveFilePath(args);\n    return await pathExists(filePath);\n  }\n\n  /**\n   * Runs a cleanup pass to remove files older than 1 day from the cache.\n   * This is called periodically, but can be triggered manually.\n   */\n  async cleanup() {\n    try {\n      await this._cleanupGroupSemaphore.acquire(\"cleanup\");\n      await findNuke(this._cachePath, {\n        olderThan: this._ttl,\n        verbose: true,\n        deleteEmptyDirectories: true,\n      });\n    } finally {\n      this._cleanupGroupSemaphore.release(\"cleanup\");\n    }\n  }\n}\n\nexport { type DirectoryPath, FileCache, type FileName, type FilePath };\n"],"mappings":";AAAA,OAAO,UAAU;AACjB,OAAO,QAAQ;AACf,SAAS,YAAY,sBAAsB;AAC3C,OAAO,UAAU;AACjB,SAAS,gBAAgB,iBAAiB;AAC1C,OAAO,WAAW;AAClB,SAAS,gBAAgB;AACzB,SAAS,gBAAgB;AAiBzB,IAAM,YAAN,MAA+C;AAAA,EACrC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EAGA;AAAA,EACA,cAAqD;AAAA,EACrD,aAAwB,IAAI,UAAU;AAAA,EACtC,yBAAyC,IAAI,eAAe;AAAA,EAEpE,YACE;AAAA,IACE;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,GACA;AACA,SAAK,aAAa;AAClB,SAAK,MAAM;AACX,SAAK,OAAO;AACZ,SAAK,OAAO;AACZ,SAAK,mBAAmB,mBACtB,SAAS,eAAe,EAAE,MAAM,EAAE,CAAC;AAErC,SAAK,mBAAmB,oBACrB,CAAC,SAAa,KAAK,UAAU,IAAI;AAGpC,QAAK,eAAe,SAAS,GAAI;AAAA,IAEjC,WAAW,qBAAqB;AAC9B,SAAG,UAAU,WAAW,EAAE,WAAW,KAAK,CAAC;AAAA,IAC7C,OAAO;AACL,YAAM,IAAI,MAAM,sDAA+C;AAAA,IACjE;AAGA,SAAK,QAAQ;AAEb,SAAK,cAAc;AAAA,MACjB,KAAK,QAAQ,KAAK,IAAI;AAAA,MACtB,KAAK;AAAA,IACP;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAc,gBAAgB,MAA4B;AACxD,UAAM,CAAC,MAAM,GAAG,IAAI,MAAM,QAAQ,IAAI;AAAA,MACpC,KAAK,iBAAiB,IAAI;AAAA,MAC1B,KAAK,KAAK,IAAI;AAAA,IAChB,CAAC;AAED,UAAM,mBAAmB,KAAK,KAAK,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC;AAEzD,WAAO,KAAK,OAAO;AAAA,MACjB,MAAM;AAAA,MACN;AAAA,IACF,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,MAAM,QAAQ,MAA4B;AACxC,UAAM,WAAW,MAAM,KAAK,gBAAgB,IAAI;AAEhD,QAAI;AACF,YAAM,QAAQ,IAAI;AAAA,QAChB,KAAK,uBAAuB,QAAQ,SAAS;AAAA,QAC7C,KAAK,WAAW,QAAQ,QAAQ;AAAA,MAClC,CAAC;AAED,UAAI,MAAM,WAAW,QAAQ,GAAG;AAE9B,cAAM,QAAQ;AAAA,MAChB,OAAO;AACL,cAAM,GAAG,SAAS,MAAM,KAAK,QAAQ,QAAQ,GAAG,EAAE,WAAW,KAAK,CAAC;AACnE,cAAM,KAAK,IAAI,UAAU,MAAM,IAAI;AAAA,MACrC;AAAA,IACF,UAAE;AACA,WAAK,WAAW,QAAQ,QAAQ;AAChC,WAAK,uBAAuB,QAAQ,SAAS;AAAA,IAC/C;AAEA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,gBAAgB,MAA4B;AAChD,UAAM,WAAW,MAAM,KAAK,gBAAgB,IAAI;AAEhD,UAAM,WAAW,KAAK;AAAA,MACpB,KAAK;AAAA,MACL,SAAS,CAAC;AAAA,MACV,SAAS,CAAC;AAAA,MACV,SAAS,CAAC;AAAA,MACV;AAAA,IACF;AAEA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA,EAKA,UAAU;AACR,QAAI,KAAK,aAAa;AACpB,oBAAc,KAAK,WAAW;AAC9B,WAAK,cAAc;AAAA,IACrB;AAAA,EACF;AAAA,EAEA,MAAM,IAAI,MAA2B;AACnC,UAAM,WAAW,MAAM,KAAK,gBAAgB,IAAI;AAChD,WAAO,MAAM,WAAW,QAAQ;AAAA,EAClC;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,UAAU;AACd,QAAI;AACF,YAAM,KAAK,uBAAuB,QAAQ,SAAS;AACnD,YAAM,SAAS,KAAK,YAAY;AAAA,QAC9B,WAAW,KAAK;AAAA,QAChB,SAAS;AAAA,QACT,wBAAwB;AAAA,MAC1B,CAAC;AAAA,IACH,UAAE;AACA,WAAK,uBAAuB,QAAQ,SAAS;AAAA,IAC/C;AAAA,EACF;AACF;","names":[]}

package/package.json

@@ -1,35 +1,37 @@
 {
   "name": "@chriscdn/file-cache",
-  "version": "0.0.13",
-  "description": "File cache ",
+  "version": "2.0.0",
+  "description": "File cache",
   "repository": "https://github.com/chriscdn/file-cache",
   "author": "Christopher Meyer <chris@schwiiz.org>",
   "license": "MIT",
   "type": "module",
-  "source": "./src/index.ts",
-  "module": "./lib/index.js",
+  "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
-  "exports": {
-    "default": "./lib/index.js"
-  },
+  "exports": "./lib/index.js",
   "scripts": {
-    "build": "rimraf ./lib/ && tsc",
+    "build": "tsup",
     "test": "vitest"
   },
   "dependencies": {
-    "@chriscdn/duration": "^1.0.3",
-    "@chriscdn/find-nuke": "^0.0.5",
-    "@chriscdn/promise-semaphore": "^3.1.1",
+    "@chriscdn/duration": "^2.0.0",
+    "@chriscdn/find-nuke": "^2.0.0",
+    "@chriscdn/promise-semaphore": "^4.0.0",
     "path-exists": "^5.0.0",
     "sha1": "^1.1.1",
-    "temp": "^0.9.4",
     "touch": "^3.1.1"
   },
   "devDependencies": {
-    "@tsconfig/node22": "^22.0.2",
+    "@tsconfig/strictest": "^2.0.7",
     "@types/sha1": "^1.1.5",
+    "@types/temp": "^0.9.4",
     "@types/touch": "^3.1.5",
-    "typescript": "^5.9.2",
-    "vitest": "^3.2.4"
-  }
+    "temp": "^0.9.4",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.6"
+  },
+  "files": [
+    "lib"
+  ]
 }

package/.gitattributes

@@ -1 +0,0 @@
-*.pdf filter=lfs diff=lfs merge=lfs -text

package/__tests__/file-cache.test.ts

@@ -1,45 +0,0 @@
-import { describe, expect, it } from "vitest";
-import { FileCache } from "../src";
-import { Duration } from "@chriscdn/duration";
-import { promises as fs } from "fs";
-import temp from "temp";
-import { pathExists } from "path-exists";
-
-const pause = async (ms) => new Promise((resolve) => setTimeout(resolve, ms));
-
-const testPDFFile = "./__tests__/pdfs/lorem.pdf";
-
-describe("Cache Expiration", async () => {
-  const cache = new FileCache<{ a: number }>({
-    cachePath: await temp.mkdir("file-cache-test"),
-    cb: async (filePath, { a }) => {
-      await fs.copyFile(
-        testPDFFile,
-        filePath,
-      );
-    },
-    ext: () => ".pdf",
-    ttl: Duration.toMilliseconds({ seconds: 1 }),
-    cleanupInterval: Duration.toMilliseconds({ seconds: 2 }),
-  });
-
-  it("sync", async () => {
-    //
-    const filePath3 = await cache.getFile({ a: 1 });
-
-    // test if filePath exists
-    expect(await pathExists(filePath3)).toBe(true);
-
-    // wait a second
-    await pause(Duration.toMilliseconds({ seconds: 1 }));
-
-    // should still exist
-    expect(await pathExists(filePath3)).toBe(true);
-
-    // wait 2 seconds
-    await pause(Duration.toMilliseconds({ seconds: 2 }));
-
-    // should not longer exist due to cleanup
-    expect(await pathExists(filePath3)).toBe(false);
-  });
-});

package/src/index.ts

@@ -1,184 +0,0 @@
-import path from "path";
-import fs from "fs";
-import { pathExists, pathExistsSync } from "path-exists";
-import sha1 from "sha1";
-import { GroupSemaphore, Semaphore } from "@chriscdn/promise-semaphore";
-import touch from "touch";
-import { findNuke } from "@chriscdn/find-nuke";
-import { Duration } from "@chriscdn/duration";
-
-type DirectoryPath = string;
-type FileName = string;
-type FilePath = string;
-type Milliseconds = number;
-
-export type FileCacheOptions<T extends Record<string, any>> = {
-  cachePath: DirectoryPath;
-  autoCreateCachePath?: boolean;
-  cb: (filePath: FilePath, args: T, cache: FileCache<T>) => Promise<void>;
-  ext: (args: T) => string | Promise<string>;
-  resolveCacheKey?: (args: T) => string | Promise<string>;
-  ttl: Milliseconds;
-  cleanupInterval?: Milliseconds;
-};
-
-class FileCache<T extends Record<string, any>> {
-  private _cachePath: FileCacheOptions<T>["cachePath"];
-  private _cb: FileCacheOptions<T>["cb"];
-  private _ttl: FileCacheOptions<T>["ttl"];
-  private _cleanupInterval: FileCacheOptions<T>["cleanupInterval"];
-  private _resolveCacheKey: Required<
-    FileCacheOptions<T>
-  >["resolveCacheKey"];
-  private _ext: FileCacheOptions<T>["ext"];
-  private _intervalId: ReturnType<typeof setInterval> | null = null;
-  private _semaphore: Semaphore = new Semaphore();
-  private _cleanupGroupSemaphore: GroupSemaphore = new GroupSemaphore();
-
-  constructor(
-    {
-      cachePath,
-      autoCreateCachePath,
-      cb,
-      ext,
-      ttl,
-      cleanupInterval,
-      resolveCacheKey,
-    }: FileCacheOptions<T>,
-  ) {
-    this._cachePath = cachePath;
-    this._cb = cb;
-    this._ext = ext;
-    this._ttl = ttl;
-    this._cleanupInterval = cleanupInterval ??
-      Duration.toMilliseconds({ days: 1 });
-
-    this._resolveCacheKey = resolveCacheKey ??
-      ((args: T) => (JSON.stringify(args)));
-
-    // Startup code
-    if ((pathExistsSync(cachePath))) {
-      // we're good
-    } else if (autoCreateCachePath) {
-      fs.mkdirSync(cachePath, { recursive: true });
-    } else {
-      throw new Error("💥 FileCache error: cachePath does not exist.");
-    }
-
-    // fire and forget
-    this.cleanup();
-
-    this._intervalId = setInterval(
-      this.cleanup.bind(this),
-      this._cleanupInterval,
-    );
-  }
-
-  /**
-   * Resolves the filename for the cache based on the provided arguments.
-   *
-   * Uses the provided `resolveFileName` function if available, or falls back to
-   * generating a hash from the arguments to create a unique file name.
-   */
-  private async resolveFileName(args: T): Promise<FileName> {
-    const [name, ext] = await Promise.all([
-      this._resolveCacheKey(args),
-      this._ext(args),
-    ]);
-
-    const resolvedFileName = sha1(JSON.stringify([name, ext]));
-
-    return path.format({
-      name: resolvedFileName,
-      ext,
-    }) as FileName;
-  }
-
-  /**
-   * Retrieves a cached file for the given arguments.
-   * If the file doesn't exist, it is generated by the callback and stored.
-   *
-   * Concurrency-safe, ensuring no conflicts when multiple requests are made
-   * for the same file.
-   *
-   * @param args The arguments used to determine the file's identity and generation
-   * @returns The path to the cached or newly created file
-   */
-  async getFile(args: T): Promise<FilePath> {
-    const filePath = await this.resolveFilePath(args);
-
-    try {
-      await Promise.all([
-        this._cleanupGroupSemaphore.acquire("getFile"),
-        this._semaphore.acquire(filePath),
-      ]);
-
-      if (await pathExists(filePath)) {
-        // fire and forget
-        touch(filePath);
-      } else {
-        await fs.promises.mkdir(path.dirname(filePath), { recursive: true });
-        await this._cb(filePath, args, this);
-      }
-    } finally {
-      this._semaphore.release(filePath);
-      this._cleanupGroupSemaphore.release("getFile");
-    }
-
-    return filePath;
-  }
-
-  /**
-   * Resolves the full file path for the cached file based on the provided arguments.
-   *
-   * @param args The arguments used to resolve the file path
-   * @returns The full path to the cached file
-   */
-  async resolveFilePath(args: T): Promise<FilePath> {
-    const fileName = await this.resolveFileName(args);
-
-    const filePath = path.resolve(
-      this._cachePath,
-      fileName[0],
-      fileName[1],
-      fileName[2],
-      fileName,
-    );
-
-    return filePath;
-  }
-
-  /**
-   * Stops the background cleanup process, but does not delete any cached files.
-   */
-  destroy() {
-    if (this._intervalId) {
-      clearInterval(this._intervalId);
-      this._intervalId = null;
-    }
-  }
-
-  async has(args: T): Promise<boolean> {
-    const filePath = await this.resolveFilePath(args);
-    return await pathExists(filePath);
-  }
-
-  /**
-   * Runs a cleanup pass to remove files older than 1 day from the cache.
-   * This is called periodically, but can be triggered manually.
-   */
-  async cleanup() {
-    try {
-      await this._cleanupGroupSemaphore.acquire("cleanup");
-      await findNuke(this._cachePath, {
-        olderThan: this._ttl,
-        verbose: true,
-        deleteEmptyDirectories: true,
-      });
-    } finally {
-      this._cleanupGroupSemaphore.release("cleanup");
-    }
-  }
-}
-
-export { type DirectoryPath, FileCache, type FileName, type FilePath };

package/tsconfig.json

@@ -1,11 +0,0 @@
-{
-  "extends": "@tsconfig/node22/tsconfig.json",
-  "compilerOptions": {
-    "allowSyntheticDefaultImports": true,
-    "outDir": "./lib",
-    "declaration": true,
-    "declarationDir": "./lib",
-    "sourceMap": true
-  },
-  "include": ["./src/**/*"]
-}