@chriscdn/file-cache 0.0.4 → 0.0.6

package/README.md

@@ -53,6 +53,9 @@ const options: FileCacheOptions<MyCallbackArgs> = {
   // anything else in this directory.
   cachePath: "/some/path/on/your/filesystem/",
 
+  // optional, automatically create cachePath if it doesn't exist
+  autoCreateCachePath: false,
+
   // An asynchronous callback function, which is executed if no matching cached
   // file is found. It is the responsibility of this function to use `context`
   // to write a file to `filePath`.
@@ -61,9 +64,8 @@ const options: FileCacheOptions<MyCallbackArgs> = {
     await downloadAndConvertToJPG(url, filePath);
   },
 
-  // Specifies the file extension for each cached file.
-  // Currently, all files share the same extension (this may change in the future).
-  ext: ".jpg",
+  // Specifies the file extension for the cached file. Can be synchronous or asynchronous.
+  ext: (context: MyCallbackArgs) => ".jpg",
 
   // Determines the time-to-live (TTL) of a cached file, in milliseconds,
   // based on when it was last accessed.
@@ -84,6 +86,7 @@ const imageFilePath = await imageCache({
 ## Cleanup
 
 `FileCache` instances are intended to be instantiated as singletons, persisting throughout the lifecycle of your app. If you need to deallocate an instance, be sure to call the `destroy()` method to prevent a memory leak.
+This does not cleanup the cache directory.
 
 ## Tests
 

package/__tests__/file-cache.test.ts

@@ -18,7 +18,7 @@ describe("Cache Expiration", async () => {
         filePath,
       );
     },
-    ext: "pdf",
+    ext: () => ".pdf",
     ttl: Duration.toMilliseconds({ seconds: 1 }),
     cleanupInterval: Duration.toMilliseconds({ seconds: 2 }),
   });

package/lib/index.d.ts

@@ -4,21 +4,23 @@ type Milliseconds = number;
 export type FileCacheOptions<T extends Record<string, any>> = {
     cachePath: DirectoryPath;
     autoCreateCachePath?: boolean;
-    cb: (filePath: FilePath, context: T, cache: FileCache<T>) => Promise<void>;
-    ext: string;
+    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;
 };
 declare class FileCache<T extends Record<string, any>> {
     private _cachePath;
     private _cb;
-    private _ext;
     private _ttl;
     private _cleanupInterval;
+    private _resolveCacheFileKey;
+    private _ext;
     private _intervalId;
     private _semaphore;
     private _cleanupSemaphore;
-    constructor({ cachePath, autoCreateCachePath, cb, ext, ttl, cleanupInterval }: FileCacheOptions<T>);
+    constructor({ cachePath, autoCreateCachePath, cb, ext, ttl, cleanupInterval, resolveCacheFileKey, }: 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.
@@ -60,6 +62,6 @@ declare class FileCache<T extends Record<string, any>> {
      * @param args The arguments used to resolve the file path
      * @returns The full path to the cached file
      */
-    resolveFilePath(args: T): FilePath;
+    resolveFilePath(args: T): Promise<FilePath>;
 }
 export { type DirectoryPath, FileCache, type FilePath };

package/lib/index.js

@@ -7,23 +7,28 @@ import touch from "touch";
 import { findNuke } from "@chriscdn/find-nuke";
 import { Duration } from "@chriscdn/duration";
 import { rimraf } from "rimraf";
+import { Memoize } from "@chriscdn/memoize";
 const fsp = fs.promises;
 class FileCache {
     _cachePath;
     _cb;
-    _ext;
     _ttl;
     _cleanupInterval;
+    _resolveCacheFileKey;
+    _ext;
     _intervalId = null;
     _semaphore = new Semaphore();
     _cleanupSemaphore = new Semaphore();
-    constructor({ cachePath, autoCreateCachePath, cb, ext, ttl, cleanupInterval }) {
+    // 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
         }
@@ -36,6 +41,8 @@ class FileCache {
         // 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.
@@ -65,7 +72,7 @@ class FileCache {
      * @returns The path to the cached or newly created file
      */
     async getFile(args) {
-        const filePath = this.resolveFilePath(args);
+        const filePath = await this.resolveFilePath(args);
         try {
             await Promise.all([
                 this._semaphore.acquire(filePath),
@@ -86,7 +93,7 @@ class FileCache {
         return filePath;
     }
     async has(args) {
-        const filePath = this.resolveFilePath(args);
+        const filePath = await this.resolveFilePath(args);
         return await pathExists(filePath);
     }
     /**
@@ -96,7 +103,7 @@ class FileCache {
      * @returns True if the file was deleted, false if it didn't exist
      */
     async expire(args) {
-        const filePath = this.resolveFilePath(args);
+        const filePath = await this.resolveFilePath(args);
         try {
             await this._semaphore.acquire(filePath);
             if (await pathExists(filePath)) {
@@ -126,11 +133,14 @@ class FileCache {
      * Uses the provided `resolveFileName` function if available, or falls back to
      * generating a hash from the arguments to create a unique file name.
      */
-    resolveFileName(args) {
-        const baseName = sha1(JSON.stringify(args));
+    async resolveFileName(args) {
+        const [name, ext] = await Promise.all([
+            this._resolveCacheFileKey(args),
+            this._ext(args),
+        ]);
         return path.format({
-            name: baseName,
-            ext: this._ext,
+            name,
+            ext,
         });
     }
     /**
@@ -139,8 +149,8 @@ class FileCache {
      * @param args The arguments used to resolve the file path
      * @returns The full path to the cached file
      */
-    resolveFilePath(args) {
-        const fileName = this.resolveFileName(args);
+    async resolveFilePath(args) {
+        const fileName = await this.resolveFileName(args);
         const filePath = path.resolve(this._cachePath, fileName[0], fileName[1], fileName[2], 
         // fileName[3],
         fileName);

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,SAAS,MAAM,6BAA6B,CAAC;AACpD,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,MAAM,GAAG,GAAG,EAAE,CAAC,QAAQ,CAAC;AAexB,MAAM,SAAS;IACL,UAAU,CAAmC;IAE7C,GAAG,CAA4B;IAC/B,IAAI,CAA6B;IACjC,IAAI,CAA6B;IACjC,gBAAgB,CAAyC;IAEzD,WAAW,GAA0C,IAAI,CAAC;IAE1D,UAAU,GAAc,IAAI,SAAS,EAAE,CAAC;IACxC,iBAAiB,GAAc,IAAI,SAAS,EAAE,CAAC;IAEvD,YACE,EAAE,SAAS,EAAE,mBAAmB,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,eAAe,EAC1C;QAErB,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,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;;;OAGG;IACH,KAAK,CAAC,OAAO;QACX,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,CAAC;YACvC,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,iBAAiB,CAAC,OAAO,EAAE,CAAC;QACnC,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,OAAO,CAAC,IAAO;QACnB,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAE5C,IAAI,CAAC;YACH,MAAM,OAAO,CAAC,GAAG,CAAC;gBAChB,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC;gBACjC,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,EAAE,mCAAmC;aACnE,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;QACpC,CAAC;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,IAAO;QACf,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAC5C,OAAO,MAAM,UAAU,CAAC,QAAQ,CAAC,CAAC;IACpC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CAAC,IAAO;QAClB,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAE5C,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YAExC,IAAI,MAAM,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC/B,MAAM,MAAM,CAAC,QAAQ,CAAC,CAAC;gBACvB,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;QACpC,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,eAAe,CAAC,IAAO;QAC7B,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC,MAAM,CAAC;YACjB,IAAI,EAAE,QAAQ;YACd,GAAG,EAAE,IAAI,CAAC,IAAI;SACf,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,eAAe,CAAC,IAAO;QACrB,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAE5C,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;QACX,eAAe;QACf,QAAQ,CACT,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;CASF;AAED,OAAO,EAAsB,SAAS,EAAiB,CAAC"}
+{"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,SAAS,MAAM,6BAA6B,CAAC;AACpD,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,MAAM,GAAG,GAAG,EAAE,CAAC,QAAQ,CAAC;AAgBxB,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,iBAAiB,GAAc,IAAI,SAAS,EAAE,CAAC;IAEvD,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,iBAAiB,CAAC,OAAO,EAAE,CAAC;YACvC,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,iBAAiB,CAAC,OAAO,EAAE,CAAC;QACnC,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,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC;gBACjC,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,EAAE,mCAAmC;aACnE,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;QACpC,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,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YAExC,IAAI,MAAM,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC/B,MAAM,MAAM,CAAC,QAAQ,CAAC,CAAC;gBACvB,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;QACpC,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,CAAC,CAAC;IACL,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;QACX,eAAe;QACf,QAAQ,CACT,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;CASF;AAED,OAAO,EAAsB,SAAS,EAAiB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chriscdn/file-cache",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "description": "File cache ",
   "repository": "https://github.com/chriscdn/file-cache",
   "author": "Christopher Meyer <chris@schwiiz.org>",
@@ -10,7 +10,6 @@
   "module": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "exports": {
-    "types": "./lib/index.d.ts",
     "default": "./lib/index.js"
   },
   "scripts": {
@@ -20,7 +19,8 @@
   "dependencies": {
     "@chriscdn/duration": "^1.0.3",
     "@chriscdn/find-nuke": "^0.0.4",
-    "@chriscdn/promise-semaphore": "^2.0.11",
+    "@chriscdn/memoize": "^1.0.9",
+    "@chriscdn/promise-semaphore": "^2.0.12",
     "path-exists": "^5.0.0",
     "rimraf": "^6.0.1",
     "sha1": "^1.1.1",

package/src/index.ts

@@ -7,7 +7,7 @@ import touch from "touch";
 import { findNuke } from "@chriscdn/find-nuke";
 import { Duration } from "@chriscdn/duration";
 import { rimraf } from "rimraf";
-
+import { Memoize } from "@chriscdn/memoize";
 const fsp = fs.promises;
 
 type DirectoryPath = string;
@@ -17,8 +17,9 @@ type Milliseconds = number;
 export type FileCacheOptions<T extends Record<string, any>> = {
   cachePath: DirectoryPath;
   autoCreateCachePath?: boolean;
-  cb: (filePath: FilePath, context: T, cache: FileCache<T>) => Promise<void>;
-  ext: string;
+  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;
 };
@@ -27,18 +28,32 @@ class FileCache<T extends Record<string, any>> {
   private _cachePath: FileCacheOptions<T>["cachePath"];
 
   private _cb: FileCacheOptions<T>["cb"];
-  private _ext: FileCacheOptions<T>["ext"];
+
   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 _cleanupSemaphore: Semaphore = new Semaphore();
 
+  // private _fileNameResover(args:T) =>
+
   constructor(
-    { cachePath, autoCreateCachePath, cb, ext, ttl, cleanupInterval }:
-      FileCacheOptions<T>,
+    {
+      cachePath,
+      autoCreateCachePath,
+      cb,
+      ext,
+      ttl,
+      cleanupInterval,
+      resolveCacheFileKey,
+    }: FileCacheOptions<T>,
   ) {
     this._cachePath = cachePath;
     this._cb = cb;
@@ -47,6 +62,9 @@ class FileCache<T extends Record<string, any>> {
     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) {
@@ -62,6 +80,9 @@ class FileCache<T extends Record<string, any>> {
       this.cleanup.bind(this),
       this._cleanupInterval,
     );
+
+    this.resolveFileName = Memoize(this.resolveFileName.bind(this));
+    this.resolveFilePath = Memoize(this.resolveFilePath.bind(this));
   }
 
   /**
@@ -92,7 +113,7 @@ class FileCache<T extends Record<string, any>> {
    * @returns The path to the cached or newly created file
    */
   async getFile(args: T): Promise<FilePath> {
-    const filePath = this.resolveFilePath(args);
+    const filePath = await this.resolveFilePath(args);
 
     try {
       await Promise.all([
@@ -115,7 +136,7 @@ class FileCache<T extends Record<string, any>> {
   }
 
   async has(args: T): Promise<boolean> {
-    const filePath = this.resolveFilePath(args);
+    const filePath = await this.resolveFilePath(args);
     return await pathExists(filePath);
   }
 
@@ -126,7 +147,7 @@ class FileCache<T extends Record<string, any>> {
    * @returns True if the file was deleted, false if it didn't exist
    */
   async expire(args: T): Promise<boolean> {
-    const filePath = this.resolveFilePath(args);
+    const filePath = await this.resolveFilePath(args);
 
     try {
       await this._semaphore.acquire(filePath);
@@ -158,12 +179,15 @@ class FileCache<T extends Record<string, any>> {
    * 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(args: T): string {
-    const baseName = sha1(JSON.stringify(args));
+  private async resolveFileName(args: T): Promise<string> {
+    const [name, ext] = await Promise.all([
+      this._resolveCacheFileKey(args),
+      this._ext(args),
+    ]);
 
     return path.format({
-      name: baseName,
-      ext: this._ext,
+      name,
+      ext,
     });
   }
 
@@ -173,8 +197,8 @@ class FileCache<T extends Record<string, any>> {
    * @param args The arguments used to resolve the file path
    * @returns The full path to the cached file
    */
-  resolveFilePath(args: T): FilePath {
-    const fileName = this.resolveFileName(args);
+  async resolveFilePath(args: T): Promise<FilePath> {
+    const fileName = await this.resolveFileName(args);
 
     const filePath = path.resolve(
       this._cachePath,