@synstack/fs-cache 1.0.1-alpha.0

package/README.md

@@ -0,0 +1 @@
+# @synstack/fs-cache

package/dist/fs-cache.index.cjs

@@ -0,0 +1,116 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/fs-cache.index.ts
+var fs_cache_index_exports = {};
+__export(fs_cache_index_exports, {
+  FsCache: () => FsCache,
+  fsCache: () => fsCache
+});
+module.exports = __toCommonJS(fs_cache_index_exports);
+
+// src/fs-cache.lib.ts
+var import_fs = require("@synstack/fs");
+
+// src/deepEqual.lib.ts
+function deepEqual(obj1, obj2) {
+  if (obj1 === obj2) {
+    return true;
+  }
+  if (isPrimitive(obj1) && isPrimitive(obj2)) {
+    return obj1 === obj2;
+  }
+  if (obj1 == null || obj2 == null) {
+    return false;
+  }
+  const keys1 = Object.keys(obj1).filter((k) => obj1[k] !== void 0);
+  const keys2 = Object.keys(obj2).filter((k) => obj2[k] !== void 0);
+  if (keys1.length !== keys2.length) return false;
+  for (const key of keys1) {
+    if (!keys2.includes(key)) return false;
+    if (!deepEqual(obj1[key], obj2[key])) {
+      return false;
+    }
+  }
+  return true;
+}
+function isPrimitive(obj) {
+  return obj !== Object(obj);
+}
+
+// src/fs-cache.lib.ts
+var FsCache = class _FsCache {
+  _config;
+  constructor(config) {
+    this._config = config;
+  }
+  static cwd(cwd) {
+    return new _FsCache({ cwd });
+  }
+  key(key) {
+    return new _FsCache({ ...this._config, key });
+  }
+  pretty(pretty) {
+    return new _FsCache({ ...this._config, pretty });
+  }
+  static keyToRelativePath(key, args) {
+    return `./${key.map((k) => k instanceof Function ? k(...args) : k).join("/")}.json`;
+  }
+  async get(args) {
+    const relativePath = _FsCache.keyToRelativePath(this._config.key, args);
+    const cacheDir = (0, import_fs.dir)(this._config.cwd);
+    if (!await cacheDir.file(relativePath).exists()) return ["miss", null];
+    const value = await cacheDir.file(relativePath).read.json();
+    if (value === null) return ["miss", null];
+    if (!deepEqual(value.input, args)) return ["miss", null];
+    return ["hit", value.output];
+  }
+  async setDefault(args, defaultValue) {
+    const [status] = await this.get(args);
+    if (status === "hit") return false;
+    return this.set(args, defaultValue);
+  }
+  async set(args, value) {
+    const relativePath = _FsCache.keyToRelativePath(this._config.key, args);
+    const file = (0, import_fs.dir)(this._config.cwd).file(relativePath);
+    return file.write.text(
+      JSON.stringify(
+        { input: args, output: value },
+        null,
+        this._config.pretty ? 2 : void 0
+      )
+    );
+  }
+  fn(fn) {
+    return async (...args) => {
+      const [status, value] = await this.get(args);
+      if (status === "hit") return value;
+      const output = await Promise.resolve(fn(...args));
+      await this.set(args, output);
+      return output;
+    };
+  }
+};
+var fsCache = FsCache.cwd;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  FsCache,
+  fsCache
+});
+//# sourceMappingURL=fs-cache.index.cjs.map

package/dist/fs-cache.index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/fs-cache.index.ts","../src/fs-cache.lib.ts","../src/deepEqual.lib.ts"],"sourcesContent":["export * from \"./fs-cache.lib\";\n","import { OneToN } from \"@shared/src/ts.utils\";\nimport { dir } from \"@synstack/fs\";\nimport { deepEqual } from \"./deepEqual.lib\";\n\ntype $Partial<T> = Partial<T>;\n\ninterface CacheValue<TValue = any> {\n  input: any;\n  output: TValue;\n}\n\ndeclare namespace FsCache {\n  export type KeyFn<TFnArgs extends any[] = any[]> =\n    | string\n    | ((...args: TFnArgs) => string);\n  export type Key<TFnArgs extends any[] = any[]> = OneToN<KeyFn<TFnArgs>>;\n\n  interface Options<TFnArgs extends any[] = any[]> {\n    cwd: string;\n    key: Key<TFnArgs>;\n    pretty?: boolean;\n  }\n\n  namespace Options {\n    export type Partial = $Partial<Options>;\n  }\n}\n\nexport class FsCache<TConfig extends FsCache.Options.Partial> {\n  private readonly _config: TConfig;\n\n  private constructor(config: TConfig) {\n    this._config = config;\n  }\n\n  public static cwd(this: void, cwd: string) {\n    return new FsCache({ cwd });\n  }\n\n  public key<TFnArgs extends any[], TKey extends FsCache.Key<TFnArgs>>(\n    key: TKey,\n  ) {\n    return new FsCache({ ...this._config, key });\n  }\n\n  public pretty(pretty: boolean) {\n    return new FsCache({ ...this._config, pretty });\n  }\n\n  private static keyToRelativePath(key: FsCache.Key, args: any[]) {\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-argument\n    return `./${key.map((k) => (k instanceof Function ? k(...args) : k)).join(\"/\")}.json`;\n  }\n\n  public async get<TFnArgs extends any[], TValue = any>(\n    this: FsCache<FsCache.Options<TFnArgs>>,\n    args: TFnArgs,\n  ): Promise<[\"miss\", null] | [\"hit\", TValue]> {\n    const relativePath = FsCache.keyToRelativePath(this._config.key, args);\n    const cacheDir = dir(this._config.cwd);\n\n    if (!(await cacheDir.file(relativePath).exists())) return [\"miss\", null];\n\n    const value = await cacheDir\n      .file(relativePath)\n      .read.json<CacheValue<TValue>>();\n\n    if (value === null) return [\"miss\", null];\n\n    // Todo: FIX CACHE HIT\n    if (!deepEqual(value.input, args)) return [\"miss\", null];\n\n    return [\"hit\", value.output];\n  }\n\n  public async setDefault<TFnArgs extends any[], TValue = any>(\n    this: FsCache<FsCache.Options<TFnArgs>>,\n    args: TFnArgs,\n    defaultValue: TValue,\n  ) {\n    const [status] = await this.get<TFnArgs, TValue>(args);\n    if (status === \"hit\") return false;\n    return this.set(args, defaultValue);\n  }\n\n  public async set<TFnArgs extends any[]>(\n    this: FsCache<FsCache.Options<TFnArgs>>,\n    args: TFnArgs,\n    value: any,\n  ) {\n    const relativePath = FsCache.keyToRelativePath(this._config.key, args);\n    const file = dir(this._config.cwd).file(relativePath);\n    return file.write.text(\n      JSON.stringify(\n        { input: args, output: value } satisfies CacheValue,\n        null,\n        this._config.pretty ? 2 : undefined,\n      ),\n    );\n  }\n\n  public fn<TFnArgs extends any[], TFnOutput>(\n    this: FsCache<FsCache.Options<TFnArgs>>,\n    fn: (...args: TFnArgs) => Promise<TFnOutput> | TFnOutput,\n  ): (...args: TFnArgs) => Promise<TFnOutput> {\n    return async (...args: TFnArgs): Promise<TFnOutput> => {\n      const [status, value] = await this.get<TFnArgs, TFnOutput>(args);\n      if (status === \"hit\") return value;\n\n      const output = await Promise.resolve(fn(...args));\n      await this.set(args, output);\n      return output;\n    };\n  }\n}\n\nexport const fsCache = FsCache.cwd;\n","export function deepEqual(obj1: any, obj2: any) {\n  if (obj1 === obj2) {\n    return true;\n  }\n\n  if (isPrimitive(obj1) && isPrimitive(obj2)) {\n    return obj1 === obj2;\n  }\n\n  if (obj1 == null || obj2 == null) {\n    return false;\n  }\n\n  const keys1 = Object.keys(obj1 as {}).filter((k) => obj1[k] !== undefined);\n  const keys2 = Object.keys(obj2 as {}).filter((k) => obj2[k] !== undefined);\n\n  if (keys1.length !== keys2.length) return false;\n\n  for (const key of keys1) {\n    if (!keys2.includes(key)) return false;\n    if (!deepEqual(obj1[key], obj2[key])) {\n      return false;\n    }\n  }\n\n  return true;\n}\n\n//check if value is primitive\nfunction isPrimitive(obj: any) {\n  return obj !== Object(obj);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACCA,gBAAoB;;;ACDb,SAAS,UAAU,MAAW,MAAW;AAC9C,MAAI,SAAS,MAAM;AACjB,WAAO;AAAA,EACT;AAEA,MAAI,YAAY,IAAI,KAAK,YAAY,IAAI,GAAG;AAC1C,WAAO,SAAS;AAAA,EAClB;AAEA,MAAI,QAAQ,QAAQ,QAAQ,MAAM;AAChC,WAAO;AAAA,EACT;AAEA,QAAM,QAAQ,OAAO,KAAK,IAAU,EAAE,OAAO,CAAC,MAAM,KAAK,CAAC,MAAM,MAAS;AACzE,QAAM,QAAQ,OAAO,KAAK,IAAU,EAAE,OAAO,CAAC,MAAM,KAAK,CAAC,MAAM,MAAS;AAEzE,MAAI,MAAM,WAAW,MAAM,OAAQ,QAAO;AAE1C,aAAW,OAAO,OAAO;AACvB,QAAI,CAAC,MAAM,SAAS,GAAG,EAAG,QAAO;AACjC,QAAI,CAAC,UAAU,KAAK,GAAG,GAAG,KAAK,GAAG,CAAC,GAAG;AACpC,aAAO;AAAA,IACT;AAAA,EACF;AAEA,SAAO;AACT;AAGA,SAAS,YAAY,KAAU;AAC7B,SAAO,QAAQ,OAAO,GAAG;AAC3B;;;ADHO,IAAM,UAAN,MAAM,SAAiD;AAAA,EAC3C;AAAA,EAET,YAAY,QAAiB;AACnC,SAAK,UAAU;AAAA,EACjB;AAAA,EAEA,OAAc,IAAgB,KAAa;AACzC,WAAO,IAAI,SAAQ,EAAE,IAAI,CAAC;AAAA,EAC5B;AAAA,EAEO,IACL,KACA;AACA,WAAO,IAAI,SAAQ,EAAE,GAAG,KAAK,SAAS,IAAI,CAAC;AAAA,EAC7C;AAAA,EAEO,OAAO,QAAiB;AAC7B,WAAO,IAAI,SAAQ,EAAE,GAAG,KAAK,SAAS,OAAO,CAAC;AAAA,EAChD;AAAA,EAEA,OAAe,kBAAkB,KAAkB,MAAa;AAE9D,WAAO,KAAK,IAAI,IAAI,CAAC,MAAO,aAAa,WAAW,EAAE,GAAG,IAAI,IAAI,CAAE,EAAE,KAAK,GAAG,CAAC;AAAA,EAChF;AAAA,EAEA,MAAa,IAEX,MAC2C;AAC3C,UAAM,eAAe,SAAQ,kBAAkB,KAAK,QAAQ,KAAK,IAAI;AACrE,UAAM,eAAW,eAAI,KAAK,QAAQ,GAAG;AAErC,QAAI,CAAE,MAAM,SAAS,KAAK,YAAY,EAAE,OAAO,EAAI,QAAO,CAAC,QAAQ,IAAI;AAEvE,UAAM,QAAQ,MAAM,SACjB,KAAK,YAAY,EACjB,KAAK,KAAyB;AAEjC,QAAI,UAAU,KAAM,QAAO,CAAC,QAAQ,IAAI;AAGxC,QAAI,CAAC,UAAU,MAAM,OAAO,IAAI,EAAG,QAAO,CAAC,QAAQ,IAAI;AAEvD,WAAO,CAAC,OAAO,MAAM,MAAM;AAAA,EAC7B;AAAA,EAEA,MAAa,WAEX,MACA,cACA;AACA,UAAM,CAAC,MAAM,IAAI,MAAM,KAAK,IAAqB,IAAI;AACrD,QAAI,WAAW,MAAO,QAAO;AAC7B,WAAO,KAAK,IAAI,MAAM,YAAY;AAAA,EACpC;AAAA,EAEA,MAAa,IAEX,MACA,OACA;AACA,UAAM,eAAe,SAAQ,kBAAkB,KAAK,QAAQ,KAAK,IAAI;AACrE,UAAM,WAAO,eAAI,KAAK,QAAQ,GAAG,EAAE,KAAK,YAAY;AACpD,WAAO,KAAK,MAAM;AAAA,MAChB,KAAK;AAAA,QACH,EAAE,OAAO,MAAM,QAAQ,MAAM;AAAA,QAC7B;AAAA,QACA,KAAK,QAAQ,SAAS,IAAI;AAAA,MAC5B;AAAA,IACF;AAAA,EACF;AAAA,EAEO,GAEL,IAC0C;AAC1C,WAAO,UAAU,SAAsC;AACrD,YAAM,CAAC,QAAQ,KAAK,IAAI,MAAM,KAAK,IAAwB,IAAI;AAC/D,UAAI,WAAW,MAAO,QAAO;AAE7B,YAAM,SAAS,MAAM,QAAQ,QAAQ,GAAG,GAAG,IAAI,CAAC;AAChD,YAAM,KAAK,IAAI,MAAM,MAAM;AAC3B,aAAO;AAAA,IACT;AAAA,EACF;AACF;AAEO,IAAM,UAAU,QAAQ;","names":[]}

package/dist/fs-cache.index.d.cts

@@ -0,0 +1,39 @@
+/**
+ * One or more values
+ */
+type OneToN<T> = [...T[], T];
+
+type $Partial<T> = Partial<T>;
+declare namespace FsCache {
+    type KeyFn<TFnArgs extends any[] = any[]> = string | ((...args: TFnArgs) => string);
+    type Key<TFnArgs extends any[] = any[]> = OneToN<KeyFn<TFnArgs>>;
+    interface Options<TFnArgs extends any[] = any[]> {
+        cwd: string;
+        key: Key<TFnArgs>;
+        pretty?: boolean;
+    }
+    namespace Options {
+        type Partial = $Partial<Options>;
+    }
+}
+declare class FsCache<TConfig extends FsCache.Options.Partial> {
+    private readonly _config;
+    private constructor();
+    static cwd(this: void, cwd: string): FsCache<{
+        cwd: string;
+    }>;
+    key<TFnArgs extends any[], TKey extends FsCache.Key<TFnArgs>>(key: TKey): FsCache<TConfig & {
+        key: TKey;
+    }>;
+    pretty(pretty: boolean): FsCache<TConfig & {
+        pretty: boolean;
+    }>;
+    private static keyToRelativePath;
+    get<TFnArgs extends any[], TValue = any>(this: FsCache<FsCache.Options<TFnArgs>>, args: TFnArgs): Promise<["miss", null] | ["hit", TValue]>;
+    setDefault<TFnArgs extends any[], TValue = any>(this: FsCache<FsCache.Options<TFnArgs>>, args: TFnArgs, defaultValue: TValue): Promise<false | void>;
+    set<TFnArgs extends any[]>(this: FsCache<FsCache.Options<TFnArgs>>, args: TFnArgs, value: any): Promise<void>;
+    fn<TFnArgs extends any[], TFnOutput>(this: FsCache<FsCache.Options<TFnArgs>>, fn: (...args: TFnArgs) => Promise<TFnOutput> | TFnOutput): (...args: TFnArgs) => Promise<TFnOutput>;
+}
+declare const fsCache: typeof FsCache.cwd;
+
+export { FsCache, fsCache };

package/dist/fs-cache.index.d.ts

@@ -0,0 +1,39 @@
+/**
+ * One or more values
+ */
+type OneToN<T> = [...T[], T];
+
+type $Partial<T> = Partial<T>;
+declare namespace FsCache {
+    type KeyFn<TFnArgs extends any[] = any[]> = string | ((...args: TFnArgs) => string);
+    type Key<TFnArgs extends any[] = any[]> = OneToN<KeyFn<TFnArgs>>;
+    interface Options<TFnArgs extends any[] = any[]> {
+        cwd: string;
+        key: Key<TFnArgs>;
+        pretty?: boolean;
+    }
+    namespace Options {
+        type Partial = $Partial<Options>;
+    }
+}
+declare class FsCache<TConfig extends FsCache.Options.Partial> {
+    private readonly _config;
+    private constructor();
+    static cwd(this: void, cwd: string): FsCache<{
+        cwd: string;
+    }>;
+    key<TFnArgs extends any[], TKey extends FsCache.Key<TFnArgs>>(key: TKey): FsCache<TConfig & {
+        key: TKey;
+    }>;
+    pretty(pretty: boolean): FsCache<TConfig & {
+        pretty: boolean;
+    }>;
+    private static keyToRelativePath;
+    get<TFnArgs extends any[], TValue = any>(this: FsCache<FsCache.Options<TFnArgs>>, args: TFnArgs): Promise<["miss", null] | ["hit", TValue]>;
+    setDefault<TFnArgs extends any[], TValue = any>(this: FsCache<FsCache.Options<TFnArgs>>, args: TFnArgs, defaultValue: TValue): Promise<false | void>;
+    set<TFnArgs extends any[]>(this: FsCache<FsCache.Options<TFnArgs>>, args: TFnArgs, value: any): Promise<void>;
+    fn<TFnArgs extends any[], TFnOutput>(this: FsCache<FsCache.Options<TFnArgs>>, fn: (...args: TFnArgs) => Promise<TFnOutput> | TFnOutput): (...args: TFnArgs) => Promise<TFnOutput>;
+}
+declare const fsCache: typeof FsCache.cwd;
+
+export { FsCache, fsCache };

package/dist/fs-cache.index.js

@@ -0,0 +1,88 @@
+// src/fs-cache.lib.ts
+import { dir } from "@synstack/fs";
+
+// src/deepEqual.lib.ts
+function deepEqual(obj1, obj2) {
+  if (obj1 === obj2) {
+    return true;
+  }
+  if (isPrimitive(obj1) && isPrimitive(obj2)) {
+    return obj1 === obj2;
+  }
+  if (obj1 == null || obj2 == null) {
+    return false;
+  }
+  const keys1 = Object.keys(obj1).filter((k) => obj1[k] !== void 0);
+  const keys2 = Object.keys(obj2).filter((k) => obj2[k] !== void 0);
+  if (keys1.length !== keys2.length) return false;
+  for (const key of keys1) {
+    if (!keys2.includes(key)) return false;
+    if (!deepEqual(obj1[key], obj2[key])) {
+      return false;
+    }
+  }
+  return true;
+}
+function isPrimitive(obj) {
+  return obj !== Object(obj);
+}
+
+// src/fs-cache.lib.ts
+var FsCache = class _FsCache {
+  _config;
+  constructor(config) {
+    this._config = config;
+  }
+  static cwd(cwd) {
+    return new _FsCache({ cwd });
+  }
+  key(key) {
+    return new _FsCache({ ...this._config, key });
+  }
+  pretty(pretty) {
+    return new _FsCache({ ...this._config, pretty });
+  }
+  static keyToRelativePath(key, args) {
+    return `./${key.map((k) => k instanceof Function ? k(...args) : k).join("/")}.json`;
+  }
+  async get(args) {
+    const relativePath = _FsCache.keyToRelativePath(this._config.key, args);
+    const cacheDir = dir(this._config.cwd);
+    if (!await cacheDir.file(relativePath).exists()) return ["miss", null];
+    const value = await cacheDir.file(relativePath).read.json();
+    if (value === null) return ["miss", null];
+    if (!deepEqual(value.input, args)) return ["miss", null];
+    return ["hit", value.output];
+  }
+  async setDefault(args, defaultValue) {
+    const [status] = await this.get(args);
+    if (status === "hit") return false;
+    return this.set(args, defaultValue);
+  }
+  async set(args, value) {
+    const relativePath = _FsCache.keyToRelativePath(this._config.key, args);
+    const file = dir(this._config.cwd).file(relativePath);
+    return file.write.text(
+      JSON.stringify(
+        { input: args, output: value },
+        null,
+        this._config.pretty ? 2 : void 0
+      )
+    );
+  }
+  fn(fn) {
+    return async (...args) => {
+      const [status, value] = await this.get(args);
+      if (status === "hit") return value;
+      const output = await Promise.resolve(fn(...args));
+      await this.set(args, output);
+      return output;
+    };
+  }
+};
+var fsCache = FsCache.cwd;
+export {
+  FsCache,
+  fsCache
+};
+//# sourceMappingURL=fs-cache.index.js.map

package/dist/fs-cache.index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/fs-cache.lib.ts","../src/deepEqual.lib.ts"],"sourcesContent":["import { OneToN } from \"@shared/src/ts.utils\";\nimport { dir } from \"@synstack/fs\";\nimport { deepEqual } from \"./deepEqual.lib\";\n\ntype $Partial<T> = Partial<T>;\n\ninterface CacheValue<TValue = any> {\n  input: any;\n  output: TValue;\n}\n\ndeclare namespace FsCache {\n  export type KeyFn<TFnArgs extends any[] = any[]> =\n    | string\n    | ((...args: TFnArgs) => string);\n  export type Key<TFnArgs extends any[] = any[]> = OneToN<KeyFn<TFnArgs>>;\n\n  interface Options<TFnArgs extends any[] = any[]> {\n    cwd: string;\n    key: Key<TFnArgs>;\n    pretty?: boolean;\n  }\n\n  namespace Options {\n    export type Partial = $Partial<Options>;\n  }\n}\n\nexport class FsCache<TConfig extends FsCache.Options.Partial> {\n  private readonly _config: TConfig;\n\n  private constructor(config: TConfig) {\n    this._config = config;\n  }\n\n  public static cwd(this: void, cwd: string) {\n    return new FsCache({ cwd });\n  }\n\n  public key<TFnArgs extends any[], TKey extends FsCache.Key<TFnArgs>>(\n    key: TKey,\n  ) {\n    return new FsCache({ ...this._config, key });\n  }\n\n  public pretty(pretty: boolean) {\n    return new FsCache({ ...this._config, pretty });\n  }\n\n  private static keyToRelativePath(key: FsCache.Key, args: any[]) {\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-argument\n    return `./${key.map((k) => (k instanceof Function ? k(...args) : k)).join(\"/\")}.json`;\n  }\n\n  public async get<TFnArgs extends any[], TValue = any>(\n    this: FsCache<FsCache.Options<TFnArgs>>,\n    args: TFnArgs,\n  ): Promise<[\"miss\", null] | [\"hit\", TValue]> {\n    const relativePath = FsCache.keyToRelativePath(this._config.key, args);\n    const cacheDir = dir(this._config.cwd);\n\n    if (!(await cacheDir.file(relativePath).exists())) return [\"miss\", null];\n\n    const value = await cacheDir\n      .file(relativePath)\n      .read.json<CacheValue<TValue>>();\n\n    if (value === null) return [\"miss\", null];\n\n    // Todo: FIX CACHE HIT\n    if (!deepEqual(value.input, args)) return [\"miss\", null];\n\n    return [\"hit\", value.output];\n  }\n\n  public async setDefault<TFnArgs extends any[], TValue = any>(\n    this: FsCache<FsCache.Options<TFnArgs>>,\n    args: TFnArgs,\n    defaultValue: TValue,\n  ) {\n    const [status] = await this.get<TFnArgs, TValue>(args);\n    if (status === \"hit\") return false;\n    return this.set(args, defaultValue);\n  }\n\n  public async set<TFnArgs extends any[]>(\n    this: FsCache<FsCache.Options<TFnArgs>>,\n    args: TFnArgs,\n    value: any,\n  ) {\n    const relativePath = FsCache.keyToRelativePath(this._config.key, args);\n    const file = dir(this._config.cwd).file(relativePath);\n    return file.write.text(\n      JSON.stringify(\n        { input: args, output: value } satisfies CacheValue,\n        null,\n        this._config.pretty ? 2 : undefined,\n      ),\n    );\n  }\n\n  public fn<TFnArgs extends any[], TFnOutput>(\n    this: FsCache<FsCache.Options<TFnArgs>>,\n    fn: (...args: TFnArgs) => Promise<TFnOutput> | TFnOutput,\n  ): (...args: TFnArgs) => Promise<TFnOutput> {\n    return async (...args: TFnArgs): Promise<TFnOutput> => {\n      const [status, value] = await this.get<TFnArgs, TFnOutput>(args);\n      if (status === \"hit\") return value;\n\n      const output = await Promise.resolve(fn(...args));\n      await this.set(args, output);\n      return output;\n    };\n  }\n}\n\nexport const fsCache = FsCache.cwd;\n","export function deepEqual(obj1: any, obj2: any) {\n  if (obj1 === obj2) {\n    return true;\n  }\n\n  if (isPrimitive(obj1) && isPrimitive(obj2)) {\n    return obj1 === obj2;\n  }\n\n  if (obj1 == null || obj2 == null) {\n    return false;\n  }\n\n  const keys1 = Object.keys(obj1 as {}).filter((k) => obj1[k] !== undefined);\n  const keys2 = Object.keys(obj2 as {}).filter((k) => obj2[k] !== undefined);\n\n  if (keys1.length !== keys2.length) return false;\n\n  for (const key of keys1) {\n    if (!keys2.includes(key)) return false;\n    if (!deepEqual(obj1[key], obj2[key])) {\n      return false;\n    }\n  }\n\n  return true;\n}\n\n//check if value is primitive\nfunction isPrimitive(obj: any) {\n  return obj !== Object(obj);\n}\n"],"mappings":";AACA,SAAS,WAAW;;;ACDb,SAAS,UAAU,MAAW,MAAW;AAC9C,MAAI,SAAS,MAAM;AACjB,WAAO;AAAA,EACT;AAEA,MAAI,YAAY,IAAI,KAAK,YAAY,IAAI,GAAG;AAC1C,WAAO,SAAS;AAAA,EAClB;AAEA,MAAI,QAAQ,QAAQ,QAAQ,MAAM;AAChC,WAAO;AAAA,EACT;AAEA,QAAM,QAAQ,OAAO,KAAK,IAAU,EAAE,OAAO,CAAC,MAAM,KAAK,CAAC,MAAM,MAAS;AACzE,QAAM,QAAQ,OAAO,KAAK,IAAU,EAAE,OAAO,CAAC,MAAM,KAAK,CAAC,MAAM,MAAS;AAEzE,MAAI,MAAM,WAAW,MAAM,OAAQ,QAAO;AAE1C,aAAW,OAAO,OAAO;AACvB,QAAI,CAAC,MAAM,SAAS,GAAG,EAAG,QAAO;AACjC,QAAI,CAAC,UAAU,KAAK,GAAG,GAAG,KAAK,GAAG,CAAC,GAAG;AACpC,aAAO;AAAA,IACT;AAAA,EACF;AAEA,SAAO;AACT;AAGA,SAAS,YAAY,KAAU;AAC7B,SAAO,QAAQ,OAAO,GAAG;AAC3B;;;ADHO,IAAM,UAAN,MAAM,SAAiD;AAAA,EAC3C;AAAA,EAET,YAAY,QAAiB;AACnC,SAAK,UAAU;AAAA,EACjB;AAAA,EAEA,OAAc,IAAgB,KAAa;AACzC,WAAO,IAAI,SAAQ,EAAE,IAAI,CAAC;AAAA,EAC5B;AAAA,EAEO,IACL,KACA;AACA,WAAO,IAAI,SAAQ,EAAE,GAAG,KAAK,SAAS,IAAI,CAAC;AAAA,EAC7C;AAAA,EAEO,OAAO,QAAiB;AAC7B,WAAO,IAAI,SAAQ,EAAE,GAAG,KAAK,SAAS,OAAO,CAAC;AAAA,EAChD;AAAA,EAEA,OAAe,kBAAkB,KAAkB,MAAa;AAE9D,WAAO,KAAK,IAAI,IAAI,CAAC,MAAO,aAAa,WAAW,EAAE,GAAG,IAAI,IAAI,CAAE,EAAE,KAAK,GAAG,CAAC;AAAA,EAChF;AAAA,EAEA,MAAa,IAEX,MAC2C;AAC3C,UAAM,eAAe,SAAQ,kBAAkB,KAAK,QAAQ,KAAK,IAAI;AACrE,UAAM,WAAW,IAAI,KAAK,QAAQ,GAAG;AAErC,QAAI,CAAE,MAAM,SAAS,KAAK,YAAY,EAAE,OAAO,EAAI,QAAO,CAAC,QAAQ,IAAI;AAEvE,UAAM,QAAQ,MAAM,SACjB,KAAK,YAAY,EACjB,KAAK,KAAyB;AAEjC,QAAI,UAAU,KAAM,QAAO,CAAC,QAAQ,IAAI;AAGxC,QAAI,CAAC,UAAU,MAAM,OAAO,IAAI,EAAG,QAAO,CAAC,QAAQ,IAAI;AAEvD,WAAO,CAAC,OAAO,MAAM,MAAM;AAAA,EAC7B;AAAA,EAEA,MAAa,WAEX,MACA,cACA;AACA,UAAM,CAAC,MAAM,IAAI,MAAM,KAAK,IAAqB,IAAI;AACrD,QAAI,WAAW,MAAO,QAAO;AAC7B,WAAO,KAAK,IAAI,MAAM,YAAY;AAAA,EACpC;AAAA,EAEA,MAAa,IAEX,MACA,OACA;AACA,UAAM,eAAe,SAAQ,kBAAkB,KAAK,QAAQ,KAAK,IAAI;AACrE,UAAM,OAAO,IAAI,KAAK,QAAQ,GAAG,EAAE,KAAK,YAAY;AACpD,WAAO,KAAK,MAAM;AAAA,MAChB,KAAK;AAAA,QACH,EAAE,OAAO,MAAM,QAAQ,MAAM;AAAA,QAC7B;AAAA,QACA,KAAK,QAAQ,SAAS,IAAI;AAAA,MAC5B;AAAA,IACF;AAAA,EACF;AAAA,EAEO,GAEL,IAC0C;AAC1C,WAAO,UAAU,SAAsC;AACrD,YAAM,CAAC,QAAQ,KAAK,IAAI,MAAM,KAAK,IAAwB,IAAI;AAC/D,UAAI,WAAW,MAAO,QAAO;AAE7B,YAAM,SAAS,MAAM,QAAQ,QAAQ,GAAG,GAAG,IAAI,CAAC;AAChD,YAAM,KAAK,IAAI,MAAM,MAAM;AAC3B,aAAO;AAAA,IACT;AAAA,EACF;AACF;AAEO,IAAM,UAAU,QAAQ;","names":[]}

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@synstack/fs-cache",
+  "type": "module",
+  "publishConfig": {
+    "access": "public"
+  },
+  "packageManager": "yarn@4.4.0",
+  "version": "1.0.1-alpha.0",
+  "description": "Human-friendly file system caching",
+  "keywords": [
+    "cache",
+    "memoize"
+  ],
+  "author": {
+    "name": "pAIrprog",
+    "url": "https://pairprog.io"
+  },
+  "homepage": "https://github.com/pAIrprogio/synscript/tree/main/packages/fs-cache",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pAIrprogio/syn-stack.git",
+    "directory": "packages/fs-cache"
+  },
+  "license": "Apache-2.0",
+  "scripts": {
+    "publish": "yarn npm publish --access public",
+    "prepublish": "yarn test && yarn build",
+    "build": "tsup",
+    "build:watch": "tsup --watch",
+    "test:types": "tsc --noEmit",
+    "test:unit": "node --import tsx --test src/**/*.test.ts",
+    "test:unit:watch": "node --import tsx --watch --test src/**/*.test.ts",
+    "test": "yarn test:types && yarn test:unit"
+  },
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/fs-cache.index.d.ts",
+        "default": "./dist/fs-cache.index.js"
+      },
+      "require": {
+        "types": "./dist/fs-cache.index.d.cts",
+        "default": "./dist/fs-cache.index.cjs"
+      }
+    }
+  },
+  "dependencies": {
+    "@synstack/fs": "1.0.1-alpha.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.7.0",
+    "tsup": "^8.3.0",
+    "tsx": "^4.19.1",
+    "typescript": "^5.6.2"
+  },
+  "files": [
+    "src/**/*.ts",
+    "!src/**/*.test.ts",
+    "dist/**/*"
+  ],
+  "gitHead": "85f9945f77a0427bc4cfc1f7046aba430c8a8b9f"
+}

package/src/deepEqual.lib.ts

@@ -0,0 +1,32 @@
+export function deepEqual(obj1: any, obj2: any) {
+  if (obj1 === obj2) {
+    return true;
+  }
+
+  if (isPrimitive(obj1) && isPrimitive(obj2)) {
+    return obj1 === obj2;
+  }
+
+  if (obj1 == null || obj2 == null) {
+    return false;
+  }
+
+  const keys1 = Object.keys(obj1 as {}).filter((k) => obj1[k] !== undefined);
+  const keys2 = Object.keys(obj2 as {}).filter((k) => obj2[k] !== undefined);
+
+  if (keys1.length !== keys2.length) return false;
+
+  for (const key of keys1) {
+    if (!keys2.includes(key)) return false;
+    if (!deepEqual(obj1[key], obj2[key])) {
+      return false;
+    }
+  }
+
+  return true;
+}
+
+//check if value is primitive
+function isPrimitive(obj: any) {
+  return obj !== Object(obj);
+}

package/src/fs-cache.index.ts

@@ -0,0 +1 @@
+export * from "./fs-cache.lib";

package/src/fs-cache.lib.ts

@@ -0,0 +1,117 @@
+import { OneToN } from "@shared/src/ts.utils";
+import { dir } from "@synstack/fs";
+import { deepEqual } from "./deepEqual.lib";
+
+type $Partial<T> = Partial<T>;
+
+interface CacheValue<TValue = any> {
+  input: any;
+  output: TValue;
+}
+
+declare namespace FsCache {
+  export type KeyFn<TFnArgs extends any[] = any[]> =
+    | string
+    | ((...args: TFnArgs) => string);
+  export type Key<TFnArgs extends any[] = any[]> = OneToN<KeyFn<TFnArgs>>;
+
+  interface Options<TFnArgs extends any[] = any[]> {
+    cwd: string;
+    key: Key<TFnArgs>;
+    pretty?: boolean;
+  }
+
+  namespace Options {
+    export type Partial = $Partial<Options>;
+  }
+}
+
+export class FsCache<TConfig extends FsCache.Options.Partial> {
+  private readonly _config: TConfig;
+
+  private constructor(config: TConfig) {
+    this._config = config;
+  }
+
+  public static cwd(this: void, cwd: string) {
+    return new FsCache({ cwd });
+  }
+
+  public key<TFnArgs extends any[], TKey extends FsCache.Key<TFnArgs>>(
+    key: TKey,
+  ) {
+    return new FsCache({ ...this._config, key });
+  }
+
+  public pretty(pretty: boolean) {
+    return new FsCache({ ...this._config, pretty });
+  }
+
+  private static keyToRelativePath(key: FsCache.Key, args: any[]) {
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+    return `./${key.map((k) => (k instanceof Function ? k(...args) : k)).join("/")}.json`;
+  }
+
+  public async get<TFnArgs extends any[], TValue = any>(
+    this: FsCache<FsCache.Options<TFnArgs>>,
+    args: TFnArgs,
+  ): Promise<["miss", null] | ["hit", TValue]> {
+    const relativePath = FsCache.keyToRelativePath(this._config.key, args);
+    const cacheDir = dir(this._config.cwd);
+
+    if (!(await cacheDir.file(relativePath).exists())) return ["miss", null];
+
+    const value = await cacheDir
+      .file(relativePath)
+      .read.json<CacheValue<TValue>>();
+
+    if (value === null) return ["miss", null];
+
+    // Todo: FIX CACHE HIT
+    if (!deepEqual(value.input, args)) return ["miss", null];
+
+    return ["hit", value.output];
+  }
+
+  public async setDefault<TFnArgs extends any[], TValue = any>(
+    this: FsCache<FsCache.Options<TFnArgs>>,
+    args: TFnArgs,
+    defaultValue: TValue,
+  ) {
+    const [status] = await this.get<TFnArgs, TValue>(args);
+    if (status === "hit") return false;
+    return this.set(args, defaultValue);
+  }
+
+  public async set<TFnArgs extends any[]>(
+    this: FsCache<FsCache.Options<TFnArgs>>,
+    args: TFnArgs,
+    value: any,
+  ) {
+    const relativePath = FsCache.keyToRelativePath(this._config.key, args);
+    const file = dir(this._config.cwd).file(relativePath);
+    return file.write.text(
+      JSON.stringify(
+        { input: args, output: value } satisfies CacheValue,
+        null,
+        this._config.pretty ? 2 : undefined,
+      ),
+    );
+  }
+
+  public fn<TFnArgs extends any[], TFnOutput>(
+    this: FsCache<FsCache.Options<TFnArgs>>,
+    fn: (...args: TFnArgs) => Promise<TFnOutput> | TFnOutput,
+  ): (...args: TFnArgs) => Promise<TFnOutput> {
+    return async (...args: TFnArgs): Promise<TFnOutput> => {
+      const [status, value] = await this.get<TFnArgs, TFnOutput>(args);
+      if (status === "hit") return value;
+
+      const output = await Promise.resolve(fn(...args));
+      await this.set(args, output);
+      return output;
+    };
+  }
+}
+
+export const fsCache = FsCache.cwd;