@chriscdn/file-cache 0.0.12 → 0.0.14

package/lib/file-cache.cjs

@@ -0,0 +1,142 @@
+var path = require('path');
+var fs = require('fs');
+var pathExists = require('path-exists');
+var sha1 = require('sha1');
+var promiseSemaphore = require('@chriscdn/promise-semaphore');
+var touch = require('touch');
+var findNuke = require('@chriscdn/find-nuke');
+var duration = require('@chriscdn/duration');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var path__default = /*#__PURE__*/_interopDefaultLegacy(path);
+var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
+var sha1__default = /*#__PURE__*/_interopDefaultLegacy(sha1);
+var touch__default = /*#__PURE__*/_interopDefaultLegacy(touch);
+
+class FileCache {
+  constructor({
+    cachePath,
+    autoCreateCachePath,
+    cb,
+    ext,
+    ttl,
+    cleanupInterval,
+    resolveCacheKey
+  }) {
+    this._cachePath = void 0;
+    this._cb = void 0;
+    this._ttl = void 0;
+    this._cleanupInterval = void 0;
+    this._resolveCacheKey = void 0;
+    this._ext = void 0;
+    this._intervalId = null;
+    this._semaphore = new promiseSemaphore.Semaphore();
+    this._cleanupGroupSemaphore = new promiseSemaphore.GroupSemaphore();
+    this._cachePath = cachePath;
+    this._cb = cb;
+    this._ext = ext;
+    this._ttl = ttl;
+    this._cleanupInterval = cleanupInterval != null ? cleanupInterval : duration.Duration.toMilliseconds({
+      days: 1
+    });
+    this._resolveCacheKey = resolveCacheKey != null ? resolveCacheKey : args => JSON.stringify(args);
+    // Startup code
+    if (pathExists.pathExistsSync(cachePath)) ; else if (autoCreateCachePath) {
+      fs__default["default"].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.
+   */
+  async resolveFileName(args) {
+    const [name, ext] = await Promise.all([this._resolveCacheKey(args), this._ext(args)]);
+    const resolvedFileName = sha1__default["default"](JSON.stringify([name, ext]));
+    return path__default["default"].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.pathExists(filePath)) {
+        // fire and forget
+        touch__default["default"](filePath);
+      } else {
+        await fs__default["default"].promises.mkdir(path__default["default"].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) {
+    const fileName = await this.resolveFileName(args);
+    const filePath = path__default["default"].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) {
+    const filePath = await this.resolveFilePath(args);
+    return await pathExists.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.findNuke(this._cachePath, {
+        olderThan: this._ttl,
+        verbose: true,
+        deleteEmptyDirectories: true
+      });
+    } finally {
+      this._cleanupGroupSemaphore.release("cleanup");
+    }
+  }
+}
+
+exports.FileCache = FileCache;
+//# sourceMappingURL=file-cache.cjs.map

package/lib/file-cache.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-cache.cjs","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"],"names":["FileCache","constructor","cachePath","autoCreateCachePath","cb","ext","ttl","cleanupInterval","resolveCacheKey","_cachePath","_cb","_ttl","_cleanupInterval","_resolveCacheKey","_ext","_intervalId","_semaphore","Semaphore","_cleanupGroupSemaphore","GroupSemaphore","Duration","toMilliseconds","days","args","JSON","stringify","pathExistsSync","fs","mkdirSync","recursive","Error","cleanup","setInterval","bind","resolveFileName","name","Promise","all","resolvedFileName","sha1","path","format","getFile","filePath","resolveFilePath","acquire","pathExists","touch","promises","mkdir","dirname","release","fileName","resolve","destroy","clearInterval","has","findNuke","olderThan","verbose","deleteEmptyDirectories"],"mappings":";;;;;;;;;;;;;;;;AAwBA,MAAMA,SAAS,CAAA;AAabC,EAAAA,WAAAA,CACE;IACEC,SAAS;IACTC,mBAAmB;IACnBC,EAAE;IACFC,GAAG;IACHC,GAAG;IACHC,eAAe;AACfC,IAAAA,eAAAA;AACoB,GAAA,EAAA;AAAA,IAAA,IAAA,CArBhBC,UAAU,GAAA,KAAA,CAAA,CAAA;AAAA,IAAA,IAAA,CACVC,GAAG,GAAA,KAAA,CAAA,CAAA;AAAA,IAAA,IAAA,CACHC,IAAI,GAAA,KAAA,CAAA,CAAA;AAAA,IAAA,IAAA,CACJC,gBAAgB,GAAA,KAAA,CAAA,CAAA;AAAA,IAAA,IAAA,CAChBC,gBAAgB,GAAA,KAAA,CAAA,CAAA;AAAA,IAAA,IAAA,CAGhBC,IAAI,GAAA,KAAA,CAAA,CAAA;IAAA,IACJC,CAAAA,WAAW,GAA0C,IAAI,CAAA;AAAA,IAAA,IAAA,CACzDC,UAAU,GAAc,IAAIC,0BAAS,EAAE,CAAA;AAAA,IAAA,IAAA,CACvCC,sBAAsB,GAAmB,IAAIC,+BAAc,EAAE,CAAA;IAanE,IAAI,CAACV,UAAU,GAAGP,SAAS,CAAA;IAC3B,IAAI,CAACQ,GAAG,GAAGN,EAAE,CAAA;IACb,IAAI,CAACU,IAAI,GAAGT,GAAG,CAAA;IACf,IAAI,CAACM,IAAI,GAAGL,GAAG,CAAA;IACf,IAAI,CAACM,gBAAgB,GAAGL,eAAe,IAAA,IAAA,GAAfA,eAAe,GACrCa,iBAAQ,CAACC,cAAc,CAAC;AAAEC,MAAAA,IAAI,EAAE,CAAA;AAAG,KAAA,CAAC,CAAA;AAEtC,IAAA,IAAI,CAACT,gBAAgB,GAAGL,eAAe,WAAfA,eAAe,GACnCe,IAAO,IAAMC,IAAI,CAACC,SAAS,CAACF,IAAI,CAAG,CAAA;AAEvC;AACA,IAAA,IAAKG,yBAAc,CAACxB,SAAS,CAAC,EAAG,CAEhC,MAAM,IAAIC,mBAAmB,EAAE;AAC9BwB,MAAAA,sBAAE,CAACC,SAAS,CAAC1B,SAAS,EAAE;AAAE2B,QAAAA,SAAS,EAAE,IAAA;AAAM,OAAA,CAAC,CAAA;AAC9C,KAAC,MAAM;AACL,MAAA,MAAM,IAAIC,KAAK,CAAC,+CAA+C,CAAC,CAAA;AAClE,KAAA;AAEA;IACA,IAAI,CAACC,OAAO,EAAE,CAAA;AAEd,IAAA,IAAI,CAAChB,WAAW,GAAGiB,WAAW,CAC5B,IAAI,CAACD,OAAO,CAACE,IAAI,CAAC,IAAI,CAAC,EACvB,IAAI,CAACrB,gBAAgB,CACtB,CAAA;AACH,GAAA;AAEA;;;;;AAKG;EACK,MAAMsB,eAAeA,CAACX,IAAO,EAAA;IACnC,MAAM,CAACY,IAAI,EAAE9B,GAAG,CAAC,GAAG,MAAM+B,OAAO,CAACC,GAAG,CAAC,CACpC,IAAI,CAACxB,gBAAgB,CAACU,IAAI,CAAC,EAC3B,IAAI,CAACT,IAAI,CAACS,IAAI,CAAC,CAChB,CAAC,CAAA;AAEF,IAAA,MAAMe,gBAAgB,GAAGC,wBAAI,CAACf,IAAI,CAACC,SAAS,CAAC,CAACU,IAAI,EAAE9B,GAAG,CAAC,CAAC,CAAC,CAAA;IAE1D,OAAOmC,wBAAI,CAACC,MAAM,CAAC;AACjBN,MAAAA,IAAI,EAAEG,gBAAgB;AACtBjC,MAAAA,GAAAA;AACD,KAAA,CAAa,CAAA;AAChB,GAAA;AAEA;;;;;;;;;AASG;EACH,MAAMqC,OAAOA,CAACnB,IAAO,EAAA;IACnB,MAAMoB,QAAQ,GAAG,MAAM,IAAI,CAACC,eAAe,CAACrB,IAAI,CAAC,CAAA;IAEjD,IAAI;MACF,MAAMa,OAAO,CAACC,GAAG,CAAC,CAChB,IAAI,CAACnB,sBAAsB,CAAC2B,OAAO,CAAC,SAAS,CAAC,EAC9C,IAAI,CAAC7B,UAAU,CAAC6B,OAAO,CAACF,QAAQ,CAAC,CAClC,CAAC,CAAA;AAEF,MAAA,IAAI,MAAMG,qBAAU,CAACH,QAAQ,CAAC,EAAE;AAC9B;QACAI,yBAAK,CAACJ,QAAQ,CAAC,CAAA;AACjB,OAAC,MAAM;AACL,QAAA,MAAMhB,sBAAE,CAACqB,QAAQ,CAACC,KAAK,CAACT,wBAAI,CAACU,OAAO,CAACP,QAAQ,CAAC,EAAE;AAAEd,UAAAA,SAAS,EAAE,IAAA;AAAI,SAAE,CAAC,CAAA;QACpE,MAAM,IAAI,CAACnB,GAAG,CAACiC,QAAQ,EAAEpB,IAAI,EAAE,IAAI,CAAC,CAAA;AACtC,OAAA;AACF,KAAC,SAAS;AACR,MAAA,IAAI,CAACP,UAAU,CAACmC,OAAO,CAACR,QAAQ,CAAC,CAAA;AACjC,MAAA,IAAI,CAACzB,sBAAsB,CAACiC,OAAO,CAAC,SAAS,CAAC,CAAA;AAChD,KAAA;AAEA,IAAA,OAAOR,QAAQ,CAAA;AACjB,GAAA;AAEA;;;;;AAKG;EACH,MAAMC,eAAeA,CAACrB,IAAO,EAAA;IAC3B,MAAM6B,QAAQ,GAAG,MAAM,IAAI,CAAClB,eAAe,CAACX,IAAI,CAAC,CAAA;IAEjD,MAAMoB,QAAQ,GAAGH,wBAAI,CAACa,OAAO,CAC3B,IAAI,CAAC5C,UAAU,EACf2C,QAAQ,CAAC,CAAC,CAAC,EACXA,QAAQ,CAAC,CAAC,CAAC,EACXA,QAAQ,CAAC,CAAC,CAAC,EACXA,QAAQ,CACT,CAAA;AAED,IAAA,OAAOT,QAAQ,CAAA;AACjB,GAAA;AAEA;;AAEG;AACHW,EAAAA,OAAOA,GAAA;IACL,IAAI,IAAI,CAACvC,WAAW,EAAE;AACpBwC,MAAAA,aAAa,CAAC,IAAI,CAACxC,WAAW,CAAC,CAAA;MAC/B,IAAI,CAACA,WAAW,GAAG,IAAI,CAAA;AACzB,KAAA;AACF,GAAA;EAEA,MAAMyC,GAAGA,CAACjC,IAAO,EAAA;IACf,MAAMoB,QAAQ,GAAG,MAAM,IAAI,CAACC,eAAe,CAACrB,IAAI,CAAC,CAAA;AACjD,IAAA,OAAO,MAAMuB,qBAAU,CAACH,QAAQ,CAAC,CAAA;AACnC,GAAA;AAEA;;;AAGG;EACH,MAAMZ,OAAOA,GAAA;IACX,IAAI;AACF,MAAA,MAAM,IAAI,CAACb,sBAAsB,CAAC2B,OAAO,CAAC,SAAS,CAAC,CAAA;AACpD,MAAA,MAAMY,iBAAQ,CAAC,IAAI,CAAChD,UAAU,EAAE;QAC9BiD,SAAS,EAAE,IAAI,CAAC/C,IAAI;AACpBgD,QAAAA,OAAO,EAAE,IAAI;AACbC,QAAAA,sBAAsB,EAAE,IAAA;AACzB,OAAA,CAAC,CAAA;AACJ,KAAC,SAAS;AACR,MAAA,IAAI,CAAC1C,sBAAsB,CAACiC,OAAO,CAAC,SAAS,CAAC,CAAA;AAChD,KAAA;AACF,GAAA;AACD;;;;"}

package/lib/file-cache.modern.js

@@ -0,0 +1,135 @@
+import path from 'path';
+import fs from 'fs';
+import { pathExistsSync, pathExists } from 'path-exists';
+import sha1 from 'sha1';
+import { Semaphore, GroupSemaphore } from '@chriscdn/promise-semaphore';
+import touch from 'touch';
+import { findNuke } from '@chriscdn/find-nuke';
+import { Duration } from '@chriscdn/duration';
+
+class FileCache {
+  constructor({
+    cachePath,
+    autoCreateCachePath,
+    cb,
+    ext,
+    ttl,
+    cleanupInterval,
+    resolveCacheKey
+  }) {
+    this._cachePath = void 0;
+    this._cb = void 0;
+    this._ttl = void 0;
+    this._cleanupInterval = void 0;
+    this._resolveCacheKey = void 0;
+    this._ext = void 0;
+    this._intervalId = null;
+    this._semaphore = new Semaphore();
+    this._cleanupGroupSemaphore = new GroupSemaphore();
+    this._cachePath = cachePath;
+    this._cb = cb;
+    this._ext = ext;
+    this._ttl = ttl;
+    this._cleanupInterval = cleanupInterval != null ? cleanupInterval : Duration.toMilliseconds({
+      days: 1
+    });
+    this._resolveCacheKey = resolveCacheKey != null ? resolveCacheKey : args => JSON.stringify(args);
+    // Startup code
+    if (pathExistsSync(cachePath)) ; 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.
+   */
+  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)) {
+        // 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) {
+    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) {
+    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 };
+//# sourceMappingURL=file-cache.modern.js.map

package/lib/file-cache.modern.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-cache.modern.js","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"],"names":["FileCache","constructor","cachePath","autoCreateCachePath","cb","ext","ttl","cleanupInterval","resolveCacheKey","_cachePath","_cb","_ttl","_cleanupInterval","_resolveCacheKey","_ext","_intervalId","_semaphore","Semaphore","_cleanupGroupSemaphore","GroupSemaphore","Duration","toMilliseconds","days","args","JSON","stringify","pathExistsSync","fs","mkdirSync","recursive","Error","cleanup","setInterval","bind","resolveFileName","name","Promise","all","resolvedFileName","sha1","path","format","getFile","filePath","resolveFilePath","acquire","pathExists","touch","promises","mkdir","dirname","release","fileName","resolve","destroy","clearInterval","has","findNuke","olderThan","verbose","deleteEmptyDirectories"],"mappings":";;;;;;;;;AAwBA,MAAMA,SAAS,CAAA;AAabC,EAAAA,WAAAA,CACE;IACEC,SAAS;IACTC,mBAAmB;IACnBC,EAAE;IACFC,GAAG;IACHC,GAAG;IACHC,eAAe;AACfC,IAAAA,eAAAA;AACoB,GAAA,EAAA;AAAA,IAAA,IAAA,CArBhBC,UAAU,GAAA,KAAA,CAAA,CAAA;AAAA,IAAA,IAAA,CACVC,GAAG,GAAA,KAAA,CAAA,CAAA;AAAA,IAAA,IAAA,CACHC,IAAI,GAAA,KAAA,CAAA,CAAA;AAAA,IAAA,IAAA,CACJC,gBAAgB,GAAA,KAAA,CAAA,CAAA;AAAA,IAAA,IAAA,CAChBC,gBAAgB,GAAA,KAAA,CAAA,CAAA;AAAA,IAAA,IAAA,CAGhBC,IAAI,GAAA,KAAA,CAAA,CAAA;IAAA,IACJC,CAAAA,WAAW,GAA0C,IAAI,CAAA;AAAA,IAAA,IAAA,CACzDC,UAAU,GAAc,IAAIC,SAAS,EAAE,CAAA;AAAA,IAAA,IAAA,CACvCC,sBAAsB,GAAmB,IAAIC,cAAc,EAAE,CAAA;IAanE,IAAI,CAACV,UAAU,GAAGP,SAAS,CAAA;IAC3B,IAAI,CAACQ,GAAG,GAAGN,EAAE,CAAA;IACb,IAAI,CAACU,IAAI,GAAGT,GAAG,CAAA;IACf,IAAI,CAACM,IAAI,GAAGL,GAAG,CAAA;IACf,IAAI,CAACM,gBAAgB,GAAGL,eAAe,IAAA,IAAA,GAAfA,eAAe,GACrCa,QAAQ,CAACC,cAAc,CAAC;AAAEC,MAAAA,IAAI,EAAE,CAAA;AAAG,KAAA,CAAC,CAAA;AAEtC,IAAA,IAAI,CAACT,gBAAgB,GAAGL,eAAe,WAAfA,eAAe,GACnCe,IAAO,IAAMC,IAAI,CAACC,SAAS,CAACF,IAAI,CAAG,CAAA;AAEvC;AACA,IAAA,IAAKG,cAAc,CAACxB,SAAS,CAAC,EAAG,CAEhC,MAAM,IAAIC,mBAAmB,EAAE;AAC9BwB,MAAAA,EAAE,CAACC,SAAS,CAAC1B,SAAS,EAAE;AAAE2B,QAAAA,SAAS,EAAE,IAAA;AAAM,OAAA,CAAC,CAAA;AAC9C,KAAC,MAAM;AACL,MAAA,MAAM,IAAIC,KAAK,CAAC,+CAA+C,CAAC,CAAA;AAClE,KAAA;AAEA;IACA,IAAI,CAACC,OAAO,EAAE,CAAA;AAEd,IAAA,IAAI,CAAChB,WAAW,GAAGiB,WAAW,CAC5B,IAAI,CAACD,OAAO,CAACE,IAAI,CAAC,IAAI,CAAC,EACvB,IAAI,CAACrB,gBAAgB,CACtB,CAAA;AACH,GAAA;AAEA;;;;;AAKG;EACK,MAAMsB,eAAeA,CAACX,IAAO,EAAA;IACnC,MAAM,CAACY,IAAI,EAAE9B,GAAG,CAAC,GAAG,MAAM+B,OAAO,CAACC,GAAG,CAAC,CACpC,IAAI,CAACxB,gBAAgB,CAACU,IAAI,CAAC,EAC3B,IAAI,CAACT,IAAI,CAACS,IAAI,CAAC,CAChB,CAAC,CAAA;AAEF,IAAA,MAAMe,gBAAgB,GAAGC,IAAI,CAACf,IAAI,CAACC,SAAS,CAAC,CAACU,IAAI,EAAE9B,GAAG,CAAC,CAAC,CAAC,CAAA;IAE1D,OAAOmC,IAAI,CAACC,MAAM,CAAC;AACjBN,MAAAA,IAAI,EAAEG,gBAAgB;AACtBjC,MAAAA,GAAAA;AACD,KAAA,CAAa,CAAA;AAChB,GAAA;AAEA;;;;;;;;;AASG;EACH,MAAMqC,OAAOA,CAACnB,IAAO,EAAA;IACnB,MAAMoB,QAAQ,GAAG,MAAM,IAAI,CAACC,eAAe,CAACrB,IAAI,CAAC,CAAA;IAEjD,IAAI;MACF,MAAMa,OAAO,CAACC,GAAG,CAAC,CAChB,IAAI,CAACnB,sBAAsB,CAAC2B,OAAO,CAAC,SAAS,CAAC,EAC9C,IAAI,CAAC7B,UAAU,CAAC6B,OAAO,CAACF,QAAQ,CAAC,CAClC,CAAC,CAAA;AAEF,MAAA,IAAI,MAAMG,UAAU,CAACH,QAAQ,CAAC,EAAE;AAC9B;QACAI,KAAK,CAACJ,QAAQ,CAAC,CAAA;AACjB,OAAC,MAAM;AACL,QAAA,MAAMhB,EAAE,CAACqB,QAAQ,CAACC,KAAK,CAACT,IAAI,CAACU,OAAO,CAACP,QAAQ,CAAC,EAAE;AAAEd,UAAAA,SAAS,EAAE,IAAA;AAAI,SAAE,CAAC,CAAA;QACpE,MAAM,IAAI,CAACnB,GAAG,CAACiC,QAAQ,EAAEpB,IAAI,EAAE,IAAI,CAAC,CAAA;AACtC,OAAA;AACF,KAAC,SAAS;AACR,MAAA,IAAI,CAACP,UAAU,CAACmC,OAAO,CAACR,QAAQ,CAAC,CAAA;AACjC,MAAA,IAAI,CAACzB,sBAAsB,CAACiC,OAAO,CAAC,SAAS,CAAC,CAAA;AAChD,KAAA;AAEA,IAAA,OAAOR,QAAQ,CAAA;AACjB,GAAA;AAEA;;;;;AAKG;EACH,MAAMC,eAAeA,CAACrB,IAAO,EAAA;IAC3B,MAAM6B,QAAQ,GAAG,MAAM,IAAI,CAAClB,eAAe,CAACX,IAAI,CAAC,CAAA;IAEjD,MAAMoB,QAAQ,GAAGH,IAAI,CAACa,OAAO,CAC3B,IAAI,CAAC5C,UAAU,EACf2C,QAAQ,CAAC,CAAC,CAAC,EACXA,QAAQ,CAAC,CAAC,CAAC,EACXA,QAAQ,CAAC,CAAC,CAAC,EACXA,QAAQ,CACT,CAAA;AAED,IAAA,OAAOT,QAAQ,CAAA;AACjB,GAAA;AAEA;;AAEG;AACHW,EAAAA,OAAOA,GAAA;IACL,IAAI,IAAI,CAACvC,WAAW,EAAE;AACpBwC,MAAAA,aAAa,CAAC,IAAI,CAACxC,WAAW,CAAC,CAAA;MAC/B,IAAI,CAACA,WAAW,GAAG,IAAI,CAAA;AACzB,KAAA;AACF,GAAA;EAEA,MAAMyC,GAAGA,CAACjC,IAAO,EAAA;IACf,MAAMoB,QAAQ,GAAG,MAAM,IAAI,CAACC,eAAe,CAACrB,IAAI,CAAC,CAAA;AACjD,IAAA,OAAO,MAAMuB,UAAU,CAACH,QAAQ,CAAC,CAAA;AACnC,GAAA;AAEA;;;AAGG;EACH,MAAMZ,OAAOA,GAAA;IACX,IAAI;AACF,MAAA,MAAM,IAAI,CAACb,sBAAsB,CAAC2B,OAAO,CAAC,SAAS,CAAC,CAAA;AACpD,MAAA,MAAMY,QAAQ,CAAC,IAAI,CAAChD,UAAU,EAAE;QAC9BiD,SAAS,EAAE,IAAI,CAAC/C,IAAI;AACpBgD,QAAAA,OAAO,EAAE,IAAI;AACbC,QAAAA,sBAAsB,EAAE,IAAA;AACzB,OAAA,CAAC,CAAA;AACJ,KAAC,SAAS;AACR,MAAA,IAAI,CAAC1C,sBAAsB,CAACiC,OAAO,CAAC,SAAS,CAAC,CAAA;AAChD,KAAA;AACF,GAAA;AACD;;;;"}

package/lib/file-cache.module.js

@@ -0,0 +1,135 @@
+import path from 'path';
+import fs from 'fs';
+import { pathExistsSync, pathExists } from 'path-exists';
+import sha1 from 'sha1';
+import { Semaphore, GroupSemaphore } from '@chriscdn/promise-semaphore';
+import touch from 'touch';
+import { findNuke } from '@chriscdn/find-nuke';
+import { Duration } from '@chriscdn/duration';
+
+class FileCache {
+  constructor({
+    cachePath,
+    autoCreateCachePath,
+    cb,
+    ext,
+    ttl,
+    cleanupInterval,
+    resolveCacheKey
+  }) {
+    this._cachePath = void 0;
+    this._cb = void 0;
+    this._ttl = void 0;
+    this._cleanupInterval = void 0;
+    this._resolveCacheKey = void 0;
+    this._ext = void 0;
+    this._intervalId = null;
+    this._semaphore = new Semaphore();
+    this._cleanupGroupSemaphore = new GroupSemaphore();
+    this._cachePath = cachePath;
+    this._cb = cb;
+    this._ext = ext;
+    this._ttl = ttl;
+    this._cleanupInterval = cleanupInterval != null ? cleanupInterval : Duration.toMilliseconds({
+      days: 1
+    });
+    this._resolveCacheKey = resolveCacheKey != null ? resolveCacheKey : args => JSON.stringify(args);
+    // Startup code
+    if (pathExistsSync(cachePath)) ; 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.
+   */
+  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)) {
+        // 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) {
+    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) {
+    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 };
+//# sourceMappingURL=file-cache.module.js.map

package/lib/file-cache.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-cache.module.js","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"],"names":["FileCache","constructor","cachePath","autoCreateCachePath","cb","ext","ttl","cleanupInterval","resolveCacheKey","_cachePath","_cb","_ttl","_cleanupInterval","_resolveCacheKey","_ext","_intervalId","_semaphore","Semaphore","_cleanupGroupSemaphore","GroupSemaphore","Duration","toMilliseconds","days","args","JSON","stringify","pathExistsSync","fs","mkdirSync","recursive","Error","cleanup","setInterval","bind","resolveFileName","name","Promise","all","resolvedFileName","sha1","path","format","getFile","filePath","resolveFilePath","acquire","pathExists","touch","promises","mkdir","dirname","release","fileName","resolve","destroy","clearInterval","has","findNuke","olderThan","verbose","deleteEmptyDirectories"],"mappings":";;;;;;;;;AAwBA,MAAMA,SAAS,CAAA;AAabC,EAAAA,WAAAA,CACE;IACEC,SAAS;IACTC,mBAAmB;IACnBC,EAAE;IACFC,GAAG;IACHC,GAAG;IACHC,eAAe;AACfC,IAAAA,eAAAA;AACoB,GAAA,EAAA;AAAA,IAAA,IAAA,CArBhBC,UAAU,GAAA,KAAA,CAAA,CAAA;AAAA,IAAA,IAAA,CACVC,GAAG,GAAA,KAAA,CAAA,CAAA;AAAA,IAAA,IAAA,CACHC,IAAI,GAAA,KAAA,CAAA,CAAA;AAAA,IAAA,IAAA,CACJC,gBAAgB,GAAA,KAAA,CAAA,CAAA;AAAA,IAAA,IAAA,CAChBC,gBAAgB,GAAA,KAAA,CAAA,CAAA;AAAA,IAAA,IAAA,CAGhBC,IAAI,GAAA,KAAA,CAAA,CAAA;IAAA,IACJC,CAAAA,WAAW,GAA0C,IAAI,CAAA;AAAA,IAAA,IAAA,CACzDC,UAAU,GAAc,IAAIC,SAAS,EAAE,CAAA;AAAA,IAAA,IAAA,CACvCC,sBAAsB,GAAmB,IAAIC,cAAc,EAAE,CAAA;IAanE,IAAI,CAACV,UAAU,GAAGP,SAAS,CAAA;IAC3B,IAAI,CAACQ,GAAG,GAAGN,EAAE,CAAA;IACb,IAAI,CAACU,IAAI,GAAGT,GAAG,CAAA;IACf,IAAI,CAACM,IAAI,GAAGL,GAAG,CAAA;IACf,IAAI,CAACM,gBAAgB,GAAGL,eAAe,IAAA,IAAA,GAAfA,eAAe,GACrCa,QAAQ,CAACC,cAAc,CAAC;AAAEC,MAAAA,IAAI,EAAE,CAAA;AAAG,KAAA,CAAC,CAAA;AAEtC,IAAA,IAAI,CAACT,gBAAgB,GAAGL,eAAe,WAAfA,eAAe,GACnCe,IAAO,IAAMC,IAAI,CAACC,SAAS,CAACF,IAAI,CAAG,CAAA;AAEvC;AACA,IAAA,IAAKG,cAAc,CAACxB,SAAS,CAAC,EAAG,CAEhC,MAAM,IAAIC,mBAAmB,EAAE;AAC9BwB,MAAAA,EAAE,CAACC,SAAS,CAAC1B,SAAS,EAAE;AAAE2B,QAAAA,SAAS,EAAE,IAAA;AAAM,OAAA,CAAC,CAAA;AAC9C,KAAC,MAAM;AACL,MAAA,MAAM,IAAIC,KAAK,CAAC,+CAA+C,CAAC,CAAA;AAClE,KAAA;AAEA;IACA,IAAI,CAACC,OAAO,EAAE,CAAA;AAEd,IAAA,IAAI,CAAChB,WAAW,GAAGiB,WAAW,CAC5B,IAAI,CAACD,OAAO,CAACE,IAAI,CAAC,IAAI,CAAC,EACvB,IAAI,CAACrB,gBAAgB,CACtB,CAAA;AACH,GAAA;AAEA;;;;;AAKG;EACK,MAAMsB,eAAeA,CAACX,IAAO,EAAA;IACnC,MAAM,CAACY,IAAI,EAAE9B,GAAG,CAAC,GAAG,MAAM+B,OAAO,CAACC,GAAG,CAAC,CACpC,IAAI,CAACxB,gBAAgB,CAACU,IAAI,CAAC,EAC3B,IAAI,CAACT,IAAI,CAACS,IAAI,CAAC,CAChB,CAAC,CAAA;AAEF,IAAA,MAAMe,gBAAgB,GAAGC,IAAI,CAACf,IAAI,CAACC,SAAS,CAAC,CAACU,IAAI,EAAE9B,GAAG,CAAC,CAAC,CAAC,CAAA;IAE1D,OAAOmC,IAAI,CAACC,MAAM,CAAC;AACjBN,MAAAA,IAAI,EAAEG,gBAAgB;AACtBjC,MAAAA,GAAAA;AACD,KAAA,CAAa,CAAA;AAChB,GAAA;AAEA;;;;;;;;;AASG;EACH,MAAMqC,OAAOA,CAACnB,IAAO,EAAA;IACnB,MAAMoB,QAAQ,GAAG,MAAM,IAAI,CAACC,eAAe,CAACrB,IAAI,CAAC,CAAA;IAEjD,IAAI;MACF,MAAMa,OAAO,CAACC,GAAG,CAAC,CAChB,IAAI,CAACnB,sBAAsB,CAAC2B,OAAO,CAAC,SAAS,CAAC,EAC9C,IAAI,CAAC7B,UAAU,CAAC6B,OAAO,CAACF,QAAQ,CAAC,CAClC,CAAC,CAAA;AAEF,MAAA,IAAI,MAAMG,UAAU,CAACH,QAAQ,CAAC,EAAE;AAC9B;QACAI,KAAK,CAACJ,QAAQ,CAAC,CAAA;AACjB,OAAC,MAAM;AACL,QAAA,MAAMhB,EAAE,CAACqB,QAAQ,CAACC,KAAK,CAACT,IAAI,CAACU,OAAO,CAACP,QAAQ,CAAC,EAAE;AAAEd,UAAAA,SAAS,EAAE,IAAA;AAAI,SAAE,CAAC,CAAA;QACpE,MAAM,IAAI,CAACnB,GAAG,CAACiC,QAAQ,EAAEpB,IAAI,EAAE,IAAI,CAAC,CAAA;AACtC,OAAA;AACF,KAAC,SAAS;AACR,MAAA,IAAI,CAACP,UAAU,CAACmC,OAAO,CAACR,QAAQ,CAAC,CAAA;AACjC,MAAA,IAAI,CAACzB,sBAAsB,CAACiC,OAAO,CAAC,SAAS,CAAC,CAAA;AAChD,KAAA;AAEA,IAAA,OAAOR,QAAQ,CAAA;AACjB,GAAA;AAEA;;;;;AAKG;EACH,MAAMC,eAAeA,CAACrB,IAAO,EAAA;IAC3B,MAAM6B,QAAQ,GAAG,MAAM,IAAI,CAAClB,eAAe,CAACX,IAAI,CAAC,CAAA;IAEjD,MAAMoB,QAAQ,GAAGH,IAAI,CAACa,OAAO,CAC3B,IAAI,CAAC5C,UAAU,EACf2C,QAAQ,CAAC,CAAC,CAAC,EACXA,QAAQ,CAAC,CAAC,CAAC,EACXA,QAAQ,CAAC,CAAC,CAAC,EACXA,QAAQ,CACT,CAAA;AAED,IAAA,OAAOT,QAAQ,CAAA;AACjB,GAAA;AAEA;;AAEG;AACHW,EAAAA,OAAOA,GAAA;IACL,IAAI,IAAI,CAACvC,WAAW,EAAE;AACpBwC,MAAAA,aAAa,CAAC,IAAI,CAACxC,WAAW,CAAC,CAAA;MAC/B,IAAI,CAACA,WAAW,GAAG,IAAI,CAAA;AACzB,KAAA;AACF,GAAA;EAEA,MAAMyC,GAAGA,CAACjC,IAAO,EAAA;IACf,MAAMoB,QAAQ,GAAG,MAAM,IAAI,CAACC,eAAe,CAACrB,IAAI,CAAC,CAAA;AACjD,IAAA,OAAO,MAAMuB,UAAU,CAACH,QAAQ,CAAC,CAAA;AACnC,GAAA;AAEA;;;AAGG;EACH,MAAMZ,OAAOA,GAAA;IACX,IAAI;AACF,MAAA,MAAM,IAAI,CAACb,sBAAsB,CAAC2B,OAAO,CAAC,SAAS,CAAC,CAAA;AACpD,MAAA,MAAMY,QAAQ,CAAC,IAAI,CAAChD,UAAU,EAAE;QAC9BiD,SAAS,EAAE,IAAI,CAAC/C,IAAI;AACpBgD,QAAAA,OAAO,EAAE,IAAI;AACbC,QAAAA,sBAAsB,EAAE,IAAA;AACzB,OAAA,CAAC,CAAA;AACJ,KAAC,SAAS;AACR,MAAA,IAAI,CAAC1C,sBAAsB,CAACiC,OAAO,CAAC,SAAS,CAAC,CAAA;AAChD,KAAA;AACF,GAAA;AACD;;;;"}

package/lib/index.d.ts

@@ -7,7 +7,7 @@ export type FileCacheOptions<T extends Record<string, any>> = {
     autoCreateCachePath?: boolean;
     cb: (filePath: FilePath, args: T, cache: FileCache<T>) => Promise<void>;
     ext: (args: T) => string | Promise<string>;
-    resolveCacheFileKey?: (args: T) => string | Promise<string>;
+    resolveCacheKey?: (args: T) => string | Promise<string>;
     ttl: Milliseconds;
     cleanupInterval?: Milliseconds;
 };
@@ -16,17 +16,19 @@ declare class FileCache<T extends Record<string, any>> {
     private _cb;
     private _ttl;
     private _cleanupInterval;
-    private _resolveCacheFileKey;
+    private _resolveCacheKey;
     private _ext;
     private _intervalId;
     private _semaphore;
     private _cleanupGroupSemaphore;
-    constructor({ cachePath, autoCreateCachePath, cb, ext, ttl, cleanupInterval, resolveCacheFileKey, }: FileCacheOptions<T>);
+    constructor({ cachePath, autoCreateCachePath, cb, ext, ttl, cleanupInterval, resolveCacheKey, }: FileCacheOptions<T>);
     /**
-     * Runs a cleanup pass to remove files older than 1 day from the cache.
-     * This is called periodically, but can be triggered manually.
+     * 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.
      */
-    cleanup(): Promise<void>;
+    private resolveFileName;
     /**
      * Retrieves a cached file for the given arguments.
      * If the file doesn't exist, it is generated by the callback and stored.
@@ -38,31 +40,22 @@ declare class FileCache<T extends Record<string, any>> {
      * @returns The path to the cached or newly created file
      */
     getFile(args: T): Promise<FilePath>;
-    has(args: T): Promise<boolean>;
     /**
-     * Deletes a file from the cache if it exists.
+     * Resolves the full file path for the cached file based on the provided arguments.
      *
-     * @param args The arguments used to determine the file's identity
-     * @returns True if the file was deleted, false if it didn't exist
+     * @param args The arguments used to resolve the file path
+     * @returns The full path to the cached file
      */
-    expire(args: T): Promise<boolean>;
+    resolveFilePath(args: T): Promise<FilePath>;
     /**
      * Stops the background cleanup process, but does not delete any cached files.
      */
     destroy(): void;
+    has(args: T): Promise<boolean>;
     /**
-     * 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 resolveFileName;
-    /**
-     * 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
+     * Runs a cleanup pass to remove files older than 1 day from the cache.
+     * This is called periodically, but can be triggered manually.
      */
-    resolveFilePath(args: T): Promise<FilePath>;
+    cleanup(): Promise<void>;
 }
 export { type DirectoryPath, FileCache, type FileName, type FilePath };

package/package.json

@@ -1,25 +1,27 @@
 {
   "name": "@chriscdn/file-cache",
-  "version": "0.0.12",
-  "description": "File cache ",
+  "version": "0.0.14",
+  "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",
-  "types": "./lib/index.d.ts",
+  "main": "./lib/file-cache.cjs",
+  "module": "./lib/file-cache.module.js",
   "exports": {
-    "default": "./lib/index.js"
+    "types": "./lib/index.d.ts",
+    "require": "./lib/file-cache.cjs",
+    "default": "./lib/file-cache.modern.js"
   },
+  "types": "./lib/index.d.ts",
   "scripts": {
-    "build": "rimraf ./lib/ && tsc",
+    "build": "rm -rf ./lib/ && microbundle --target node --format modern,esm,cjs",
     "test": "vitest"
   },
   "dependencies": {
     "@chriscdn/duration": "^1.0.3",
     "@chriscdn/find-nuke": "^0.0.5",
-    "@chriscdn/memoize": "^1.0.10",
     "@chriscdn/promise-semaphore": "^3.1.1",
     "path-exists": "^5.0.0",
     "sha1": "^1.1.1",
@@ -27,10 +29,13 @@
     "touch": "^3.1.1"
   },
   "devDependencies": {
-    "@tsconfig/node22": "^22.0.2",
     "@types/sha1": "^1.1.5",
     "@types/touch": "^3.1.5",
-    "typescript": "^5.9.2",
-    "vitest": "^3.2.4"
-  }
+    "microbundle": "^0.15.1",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.5"
+  },
+  "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({
-    cachePath: await temp.mkdir("file-cache-test"),
-    cb: async (filePath, { a }: { a: number }) => {
-      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: 3 });
-
-    // 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/lib/index.js

@@ -1,164 +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";
-import { Memoize } from "@chriscdn/memoize";
-const fsp = fs.promises;
-const deleteFile = async (filepath) => await fs.promises.unlink(filepath);
-class FileCache {
-    _cachePath;
-    _cb;
-    _ttl;
-    _cleanupInterval;
-    _resolveCacheFileKey;
-    _ext;
-    _intervalId = null;
-    _semaphore = new Semaphore();
-    _cleanupGroupSemaphore = new GroupSemaphore();
-    // private _fileNameResover(args:T) =>
-    constructor({ cachePath, autoCreateCachePath, cb, ext, ttl, cleanupInterval, resolveCacheFileKey, }) {
-        this._cachePath = cachePath;
-        this._cb = cb;
-        this._ext = ext;
-        this._ttl = ttl;
-        this._cleanupInterval = cleanupInterval ??
-            Duration.toMilliseconds({ days: 1 });
-        this._resolveCacheFileKey = resolveCacheFileKey ??
-            ((args) => sha1(JSON.stringify(args)));
-        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);
-        this.resolveFileName = Memoize(this.resolveFileName.bind(this));
-        this.resolveFilePath = Memoize(this.resolveFilePath.bind(this));
-    }
-    /**
-     * 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");
-        }
-    }
-    /**
-     * 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 fsp.mkdir(path.dirname(filePath), { recursive: true });
-                await this._cb(filePath, args, this);
-            }
-        }
-        finally {
-            this._semaphore.release(filePath);
-            this._cleanupGroupSemaphore.release("getFile");
-        }
-        return filePath;
-    }
-    async has(args) {
-        const filePath = await this.resolveFilePath(args);
-        return await pathExists(filePath);
-    }
-    /**
-     * Deletes a file from the cache if it exists.
-     *
-     * @param args The arguments used to determine the file's identity
-     * @returns True if the file was deleted, false if it didn't exist
-     */
-    async expire(args) {
-        const filePath = await this.resolveFilePath(args);
-        try {
-            await Promise.all([
-                this._cleanupGroupSemaphore.acquire("expire"),
-                this._semaphore.acquire(filePath),
-            ]);
-            if (await pathExists(filePath)) {
-                await deleteFile(filePath);
-                return true;
-            }
-            else {
-                return false;
-            }
-        }
-        finally {
-            this._semaphore.release(filePath);
-            this._cleanupGroupSemaphore.release("expire");
-        }
-    }
-    /**
-     * Stops the background cleanup process, but does not delete any cached files.
-     */
-    destroy() {
-        if (this._intervalId) {
-            clearInterval(this._intervalId);
-            this._intervalId = null;
-        }
-    }
-    /**
-     * 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._resolveCacheFileKey(args),
-            this._ext(args),
-        ]);
-        return path.format({
-            name,
-            ext,
-        });
-    }
-    /**
-     * 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;
-    }
-}
-export { FileCache };
-//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +0,0 @@
-{"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;AAE9C,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAE5C,MAAM,GAAG,GAAG,EAAE,CAAC,QAAQ,CAAC;AAOxB,MAAM,UAAU,GAAG,KAAK,EAAE,QAAkB,EAAE,EAAE,CAC9C,MAAM,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;AAYrC,MAAM,SAAS;IACL,UAAU,CAAmC;IAE7C,GAAG,CAA4B;IAE/B,IAAI,CAA6B;IACjC,gBAAgB,CAAyC;IAEzD,oBAAoB,CAEH;IACjB,IAAI,CAA6B;IAEjC,WAAW,GAA0C,IAAI,CAAC;IAE1D,UAAU,GAAc,IAAI,SAAS,EAAE,CAAC;IACxC,sBAAsB,GAAmB,IAAI,cAAc,EAAE,CAAC;IAEtE,sCAAsC;IAEtC,YACE,EACE,SAAS,EACT,mBAAmB,EACnB,EAAE,EACF,GAAG,EACH,GAAG,EACH,eAAe,EACf,mBAAmB,GACC;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,oBAAoB,GAAG,mBAAmB;YAC7C,CAAC,CAAC,IAAO,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAE5C,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;QAEF,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAChE,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAClE,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;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,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;gBAC7D,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,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;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CAAC,IAAO;QAClB,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,QAAQ,CAAC;gBAC7C,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC;aAClC,CAAC,CAAC;YAEH,IAAI,MAAM,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC/B,MAAM,UAAU,CAAC,QAAQ,CAAC,CAAC;gBAC3B,OAAO,IAAI,CAAC;YACd,CAAC;iBAAM,CAAC;gBACN,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YAClC,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAChD,CAAC;IACH,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;;;;;OAKG;IACK,KAAK,CAAC,eAAe,CAAC,IAAO;QACnC,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACpC,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC;YAC/B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;SAChB,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC,MAAM,CAAC;YACjB,IAAI;YACJ,GAAG;SACJ,CAAa,CAAC;IACjB,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;CACF;AAED,OAAO,EAAsB,SAAS,EAAgC,CAAC"}

package/src/index.ts

@@ -1,225 +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";
-
-import { Memoize } from "@chriscdn/memoize";
-
-const fsp = fs.promises;
-
-type DirectoryPath = string;
-type FileName = string;
-type FilePath = string;
-type Milliseconds = number;
-
-const deleteFile = async (filepath: FilePath) =>
-  await fs.promises.unlink(filepath);
-
-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>;
-  resolveCacheFileKey?: (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 _resolveCacheFileKey: Required<
-    FileCacheOptions<T>
-  >["resolveCacheFileKey"];
-  private _ext: FileCacheOptions<T>["ext"];
-
-  private _intervalId: ReturnType<typeof setInterval> | null = null;
-
-  private _semaphore: Semaphore = new Semaphore();
-  private _cleanupGroupSemaphore: GroupSemaphore = new GroupSemaphore();
-
-  // private _fileNameResover(args:T) =>
-
-  constructor(
-    {
-      cachePath,
-      autoCreateCachePath,
-      cb,
-      ext,
-      ttl,
-      cleanupInterval,
-      resolveCacheFileKey,
-    }: FileCacheOptions<T>,
-  ) {
-    this._cachePath = cachePath;
-    this._cb = cb;
-    this._ext = ext;
-    this._ttl = ttl;
-    this._cleanupInterval = cleanupInterval ??
-      Duration.toMilliseconds({ days: 1 });
-
-    this._resolveCacheFileKey = resolveCacheFileKey ??
-      ((args: T) => sha1(JSON.stringify(args)));
-
-    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,
-    );
-
-    this.resolveFileName = Memoize(this.resolveFileName.bind(this));
-    this.resolveFilePath = Memoize(this.resolveFilePath.bind(this));
-  }
-
-  /**
-   * 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");
-    }
-  }
-
-  /**
-   * 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 fsp.mkdir(path.dirname(filePath), { recursive: true });
-        await this._cb(filePath, args, this);
-      }
-    } finally {
-      this._semaphore.release(filePath);
-      this._cleanupGroupSemaphore.release("getFile");
-    }
-
-    return filePath;
-  }
-
-  async has(args: T): Promise<boolean> {
-    const filePath = await this.resolveFilePath(args);
-    return await pathExists(filePath);
-  }
-
-  /**
-   * Deletes a file from the cache if it exists.
-   *
-   * @param args The arguments used to determine the file's identity
-   * @returns True if the file was deleted, false if it didn't exist
-   */
-  async expire(args: T): Promise<boolean> {
-    const filePath = await this.resolveFilePath(args);
-
-    try {
-      await Promise.all([
-        this._cleanupGroupSemaphore.acquire("expire"),
-        this._semaphore.acquire(filePath),
-      ]);
-
-      if (await pathExists(filePath)) {
-        await deleteFile(filePath);
-        return true;
-      } else {
-        return false;
-      }
-    } finally {
-      this._semaphore.release(filePath);
-      this._cleanupGroupSemaphore.release("expire");
-    }
-  }
-
-  /**
-   * Stops the background cleanup process, but does not delete any cached files.
-   */
-  destroy() {
-    if (this._intervalId) {
-      clearInterval(this._intervalId);
-      this._intervalId = null;
-    }
-  }
-
-  /**
-   * 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._resolveCacheFileKey(args),
-      this._ext(args),
-    ]);
-
-    return path.format({
-      name,
-      ext,
-    }) as FileName;
-  }
-
-  /**
-   * 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;
-  }
-}
-
-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/**/*"]
-}