keyv-dir-store 0.0.7 → 0.0.9

package/KeyvDirStoreAsJSON.ts

@@ -1,10 +1,10 @@
-import type { DeserializedData } from "keyv";
-
-export const KeyvDirStoreAsJSON = {
-  serialize({ value }: DeserializedData<any>): string {
-    return JSON.stringify(value, null, 2);
-  },
-  deserialize(str: string): DeserializedData<any> {
-    return { value: JSON.parse(str), expires: undefined };
-  },
-};
+import type { DeserializedData } from "keyv";
+
+export const KeyvDirStoreAsJSON = {
+  serialize({ value }: DeserializedData<any>): string {
+    return JSON.stringify(value, null, 2);
+  },
+  deserialize(str: string): DeserializedData<any> {
+    return { value: JSON.parse(str), expires: undefined };
+  },
+};

package/KeyvDirStoreAsYaml.ts

@@ -1,11 +1,11 @@
-import type { DeserializedData } from "keyv";
-import yaml from "yaml";
-
-export const KeyvDirStoreAsYaml = {
-  serialize({ value }: DeserializedData<any>): string {
-    return yaml.stringify(value);
-  },
-  deserialize(str: string): DeserializedData<any> {
-    return { value: yaml.parse(str), expires: undefined };
-  },
-};
+import type { DeserializedData } from "keyv";
+import yaml from "yaml";
+
+export const KeyvDirStoreAsYaml = {
+  serialize({ value }: DeserializedData<any>): string {
+    return yaml.stringify(value);
+  },
+  deserialize(str: string): DeserializedData<any> {
+    return { value: yaml.parse(str), expires: undefined };
+  },
+};

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 snomiao
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2024 snomiao
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,34 +1,41 @@
-# Keyv Directory Store
-
-Store key into a file per value
-
-## Usages
-
-```ts
-// Default: Store each value with JSON in format "{value: ..., expires: ...}"
-new Keyv({
-  store: new KeyvDirStore(".cache/kv")
-});
-
-// Store each value with CSV
-new Keyv({
-  store: new KeyvDirStore(".cache/kv", { ext: ".csv" }),
-  serialize: ({ value }) => d3.csvFormat(value),
-  deserialize: (str) => ({ value: d3.csvParse(str), expires: undefined }),
-});
-
-// Store each value with YAML
-new Keyv({
-  store: new KeyvDirStore(".cache/kv", { ext: ".json" }),
-  serialize: ({ value }) => yaml.stringify(value),
-  deserialize: (str) => ({ value: yaml.parse(str), expires: undefined }),
-});
-
-// Store each value with JSON
-new Keyv({
-  store: new KeyvDirStore(".cache/kv", { ext: ".json" }),
-  serialize: ({ value }) => JSON.stringify(value, null, 2),
-  deserialize: (str) => ({ value: JSON.parse(str), expires: undefined }),
-});
-
+# Keyv Directory Store
+
+High performance Filesystem Keyv Store, caches each key-value pair into a $key.json. and more! *.JSON, *.YAML, *.CSV is also avaliable.
+
+## Usages
+
+```ts
+// Default: Store each value with JSON in format "{value: ..., expires: ...}"
+new Keyv({
+  store: new KeyvDirStore(".cache/kv")
+});
+
+// Store each object list with CSV
+new Keyv({
+  store: new KeyvDirStore(".cache/kv", { ext: ".csv" }),
+  serialize: ({ value }) => d3.csvFormat(value),
+  deserialize: (str) => ({ value: d3.csvParse(str), expires: undefined }),
+});
+
+// Store each object list with TSV
+new Keyv({
+  store: new KeyvDirStore(".cache/kv", { ext: ".tsv" }),
+  serialize: ({ value }) => d3.tsvFormat(value),
+  deserialize: (str) => ({ value: d3.tsvParse(str), expires: undefined }),
+});
+
+// Store each value with YAML
+new Keyv({
+  store: new KeyvDirStore(".cache/kv", { ext: ".json" }),
+  serialize: ({ value }) => yaml.stringify(value),
+  deserialize: (str) => ({ value: yaml.parse(str), expires: undefined }),
+});
+
+// Store each value with JSON
+new Keyv({
+  store: new KeyvDirStore(".cache/kv", { ext: ".json" }),
+  serialize: ({ value }) => JSON.stringify(value, null, 2),
+  deserialize: (str) => ({ value: JSON.parse(str), expires: undefined }),
+});
+
 ```

package/dist/index.js

@@ -1,7 +1,7 @@
 // @bun
 var __create = Object.create;
-var __defProp = Object.defineProperty;
 var __getProtoOf = Object.getPrototypeOf;
+var __defProp = Object.defineProperty;
 var __getOwnPropNames = Object.getOwnPropertyNames;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __toESM = (mod, isNodeMode, target) => {
@@ -116,12 +116,6 @@ var require_charenc = __commonJS((exports, module) => {
 
 // node_modules/is-buffer/index.js
 var require_is_buffer = __commonJS((exports, module) => {
-  var isBuffer = function(obj) {
-    return !!obj.constructor && typeof obj.constructor.isBuffer === "function" && obj.constructor.isBuffer(obj);
-  };
-  var isSlowBuffer = function(obj) {
-    return typeof obj.readFloatLE === "function" && typeof obj.slice === "function" && isBuffer(obj.slice(0, 0));
-  };
   /*!
    * Determine if an object is a Buffer
    *
@@ -131,6 +125,12 @@ var require_is_buffer = __commonJS((exports, module) => {
   module.exports = function(obj) {
     return obj != null && (isBuffer(obj) || isSlowBuffer(obj) || !!obj._isBuffer);
   };
+  function isBuffer(obj) {
+    return !!obj.constructor && typeof obj.constructor.isBuffer === "function" && obj.constructor.isBuffer(obj);
+  }
+  function isSlowBuffer(obj) {
+    return typeof obj.readFloatLE === "function" && typeof obj.slice === "function" && isBuffer(obj.slice(0, 0));
+  }
 });
 
 // node_modules/md5/md5.js
@@ -255,12 +255,12 @@ var require_md5 = __commonJS((exports, module) => {
 
 // node_modules/truncate-utf8-bytes/lib/truncate.js
 var require_truncate = __commonJS((exports, module) => {
-  var isHighSurrogate = function(codePoint) {
+  function isHighSurrogate(codePoint) {
     return codePoint >= 55296 && codePoint <= 56319;
-  };
-  var isLowSurrogate = function(codePoint) {
+  }
+  function isLowSurrogate(codePoint) {
     return codePoint >= 56320 && codePoint <= 57343;
-  };
+  }
   module.exports = function truncate(getLength, string, byteLength) {
     if (typeof string !== "string") {
       throw new Error("Input must be string");
@@ -296,19 +296,19 @@ var require_truncate_utf8_bytes = __commonJS((exports, module) => {
 
 // node_modules/sanitize-filename/index.js
 var require_sanitize_filename = __commonJS((exports, module) => {
-  var sanitize = function(input, replacement) {
-    if (typeof input !== "string") {
-      throw new Error("Input must be string");
-    }
-    var sanitized = input.replace(illegalRe, replacement).replace(controlRe, replacement).replace(reservedRe, replacement).replace(windowsReservedRe, replacement).replace(windowsTrailingRe, replacement);
-    return truncate(sanitized, 255);
-  };
   var truncate = require_truncate_utf8_bytes();
   var illegalRe = /[\/\?<>\\:\*\|"]/g;
   var controlRe = /[\x00-\x1f\x80-\x9f]/g;
   var reservedRe = /^\.+$/;
   var windowsReservedRe = /^(con|prn|aux|nul|com[0-9]|lpt[0-9])(\..*)?$/i;
   var windowsTrailingRe = /[\. ]+$/;
+  function sanitize(input, replacement) {
+    if (typeof input !== "string") {
+      throw new Error("Input must be string");
+    }
+    var sanitized = input.replace(illegalRe, replacement).replace(controlRe, replacement).replace(reservedRe, replacement).replace(windowsReservedRe, replacement).replace(windowsTrailingRe, replacement);
+    return truncate(sanitized, 255);
+  }
   module.exports = function(input, options) {
     var replacement = options && options.replacement || "";
     var output = sanitize(input, replacement);
@@ -322,7 +322,7 @@ var require_sanitize_filename = __commonJS((exports, module) => {
 // index.ts
 var import_md5 = __toESM(require_md5(), 1);
 var import_sanitize_filename = __toESM(require_sanitize_filename(), 1);
-import {mkdir, readFile, rm, stat, utimes, writeFile} from "fs/promises";
+import { mkdir, readFile, rm, stat, utimes, writeFile } from "fs/promises";
 import path from "path";
 
 class KeyvDirStore {
@@ -336,7 +336,8 @@ class KeyvDirStore {
     filename,
     ext
   } = {}) {
-    this.#ready = mkdir(dir, { recursive: true });
+    this.#ready = mkdir(dir, { recursive: true }).catch(() => {
+    });
     this.#cache = cache;
     this.#dir = dir;
     this.#filename = filename ?? this.#defaultFilename;
@@ -382,7 +383,8 @@ class KeyvDirStore {
     const expires = ttl ? Date.now() + ttl : 0;
     this.#cache.set(key, { value, expires });
     await this.#ready;
-    await mkdir(this.#dir, { recursive: true });
+    await mkdir(this.#dir, { recursive: true }).catch(() => {
+    });
     await writeFile(this.#path(key), value);
     await utimes(this.#path(key), new Date, new Date(expires ?? 0));
     return true;

package/index.spec.ts

@@ -1,67 +1,67 @@
-import { existsSync } from "fs";
-import Keyv from "keyv";
-import { KeyvDirStore } from ".";
-import { KeyvDirStoreAsJSON } from "./KeyvDirStoreAsJSON";
-
-it("KeyvDirStore works", async () => {
-  // store test
-  const kv = new Keyv<number | string | { obj: boolean }>({
-    store: new KeyvDirStore(".cache/test1", { filename: (x) => x }),
-    namespace: "",
-    deserialize: KeyvDirStore.deserialize,
-    serialize: KeyvDirStore.serialize,
-  });
-  await kv.clear();
-  await kv.set("a", 1234, -86400e3); // already expired
-
-  expect(existsSync(".cache/test1/a.json")).toEqual(true);
-  expect(await kv.get("a")).toEqual(undefined); // will delete file before get
-  expect(existsSync(".cache/test1/a.json")).toEqual(false);
-
-  expect(existsSync(".cache/test1/b.json")).toEqual(false);
-  await kv.set("b", 1234); // never expired
-  expect(existsSync(".cache/test1/b.json")).toEqual(true);
-  expect(await kv.get("b")).toEqual(1234);
-
-  await kv.set("c", "b", 86400e3); // 1 day
-  expect(await kv.get("c")).toEqual("b");
-  await kv.set("d", { obj: false }, 86400e3); // obj store
-  expect(await kv.get("d")).toEqual({ obj: false });
-
-  // new instance with no cache Obj, to test file cache
-  const kv2 = new Keyv<number | string | { obj: boolean }>({
-    store: new KeyvDirStore(".cache/test1", { filename: (x) => x }),
-    namespace: "",
-    ...KeyvDirStoreAsJSON,
-  });
-  expect(await kv2.get("a")).toEqual(undefined); // will delete file before get
-  expect(await kv2.get("b")).toEqual(1234);
-  expect(await kv2.get("c")).toEqual("b");
-  expect(await kv2.get("d")).toEqual({ obj: false });
-});
-it("KeyvDirStore works without deserialize", async () => {
-  // store test
-  const kv = new Keyv<number | string | { obj: boolean }>({
-    store: new KeyvDirStore(".cache/test2", { filename: (x) => x }),
-    namespace: "",
-  });
-  await kv.clear();
-  await kv.set("a", 1234, -86400e3); // already expired
-  expect(await kv.get("a")).toEqual(undefined); // will delete file before get
-  await kv.set("b", 1234); // never expired
-  expect(await kv.get("b")).toEqual(1234);
-  await kv.set("c", "b", 86400e3); // 1 day
-  expect(await kv.get("c")).toEqual("b");
-  await kv.set("d", { obj: false }, 86400e3); // obj store
-  expect(await kv.get("d")).toEqual({ obj: false });
-
-  // new instance with no cache Obj, to test file cache
-  const kv2 = new Keyv<number | string | { obj: boolean }>({
-    store: new KeyvDirStore(".cache/test2", { filename: (x) => x }),
-    namespace: "",
-  });
-  expect(await kv2.get("a")).toEqual(undefined); // will delete file before get
-  expect(await kv2.get("b")).toEqual(1234);
-  expect(await kv2.get("c")).toEqual("b");
-  expect(await kv2.get("d")).toEqual({ obj: false });
-});
+import { existsSync } from "fs";
+import Keyv from "keyv";
+import { KeyvDirStore } from ".";
+import { KeyvDirStoreAsJSON } from "./KeyvDirStoreAsJSON";
+
+it("KeyvDirStore works", async () => {
+  // store test
+  const kv = new Keyv<number | string | { obj: boolean }>({
+    store: new KeyvDirStore(".cache/test1", { filename: (x) => x }),
+    namespace: "",
+    deserialize: KeyvDirStore.deserialize,
+    serialize: KeyvDirStore.serialize,
+  });
+  await kv.clear();
+  await kv.set("a", 1234, -86400e3); // already expired
+
+  expect(existsSync(".cache/test1/a.json")).toEqual(true);
+  expect(await kv.get("a")).toEqual(undefined); // will delete file before get
+  expect(existsSync(".cache/test1/a.json")).toEqual(false);
+
+  expect(existsSync(".cache/test1/b.json")).toEqual(false);
+  await kv.set("b", 1234); // never expired
+  expect(existsSync(".cache/test1/b.json")).toEqual(true);
+  expect(await kv.get("b")).toEqual(1234);
+
+  await kv.set("c", "b", 86400e3); // 1 day
+  expect(await kv.get("c")).toEqual("b");
+  await kv.set("d", { obj: false }, 86400e3); // obj store
+  expect(await kv.get("d")).toEqual({ obj: false });
+
+  // new instance with no cache Obj, to test file cache
+  const kv2 = new Keyv<number | string | { obj: boolean }>({
+    store: new KeyvDirStore(".cache/test1", { filename: (x) => x }),
+    namespace: "",
+    ...KeyvDirStoreAsJSON,
+  });
+  expect(await kv2.get("a")).toEqual(undefined); // will delete file before get
+  expect(await kv2.get("b")).toEqual(1234);
+  expect(await kv2.get("c")).toEqual("b");
+  expect(await kv2.get("d")).toEqual({ obj: false });
+});
+it("KeyvDirStore works without deserialize", async () => {
+  // store test
+  const kv = new Keyv<number | string | { obj: boolean }>({
+    store: new KeyvDirStore(".cache/test2", { filename: (x) => x }),
+    namespace: "",
+  });
+  await kv.clear();
+  await kv.set("a", 1234, -86400e3); // already expired
+  expect(await kv.get("a")).toEqual(undefined); // will delete file before get
+  await kv.set("b", 1234); // never expired
+  expect(await kv.get("b")).toEqual(1234);
+  await kv.set("c", "b", 86400e3); // 1 day
+  expect(await kv.get("c")).toEqual("b");
+  await kv.set("d", { obj: false }, 86400e3); // obj store
+  expect(await kv.get("d")).toEqual({ obj: false });
+
+  // new instance with no cache Obj, to test file cache
+  const kv2 = new Keyv<number | string | { obj: boolean }>({
+    store: new KeyvDirStore(".cache/test2", { filename: (x) => x }),
+    namespace: "",
+  });
+  expect(await kv2.get("a")).toEqual(undefined); // will delete file before get
+  expect(await kv2.get("b")).toEqual(1234);
+  expect(await kv2.get("c")).toEqual("b");
+  expect(await kv2.get("d")).toEqual({ obj: false });
+});

package/index.ts

@@ -1,120 +1,127 @@
-import type { DeserializedData, default as Keyv } from "keyv";
-import md5 from "md5";
-import { mkdir, readFile, rm, stat, utimes, writeFile } from "node:fs/promises";
-import path from "path";
-import sanitizeFilename from "sanitize-filename";
-
-type CacheMap<Value> = Map<string, DeserializedData<Value>>;
-/**
- * KeyvDirStore is a Keyv.Store<string> implementation that stores data in files.
- * @example
- * const kv = new Keyv<number | string | { obj: boolean }>({
- *   store: new KeyvDirStore("cache/test"),
- *   deserialize: KeyvDirStore.deserialize,
- *   serialize: KeyvDirStore.serialize,
- * });
- * await kv.set("a", 1234, -86400e3); // already expired
- * expect(await kv.get("a")).toEqual(undefined); // will delete file before get
- * await kv.set("b", 1234); // never expired
- * expect(await kv.get("b")).toEqual(1234);
- */
-export class KeyvDirStore<Value extends string> implements Keyv.Store<string> {
-  #dir: string;
-  #cache: CacheMap<Value>;
-  #ready: Promise<unknown>;
-  #filename: (key: string) => string;
-  ext = ".json";
-  constructor(
-    dir: string,
-    {
-      cache = new Map(),
-      filename,
-      ext,
-    }: {
-      cache?: CacheMap<Value>;
-      filename?: (key: string) => string;
-      ext?: string;
-    } = {}
-  ) {
-    this.#ready = mkdir(dir, { recursive: true });
-    this.#cache = cache;
-    this.#dir = dir;
-    this.#filename = filename ?? this.#defaultFilename;
-    this.ext = ext ?? this.ext;
-  }
-  #defaultFilename(key: string) {
-    // use dir as hash salt to avoid collisions
-    const readableName = sanitizeFilename(key).slice(0, 16);
-    const hashName = md5(key + "+SALT-poS1djRa4M2jXsWi").slice(0, 16);
-    const name = `${readableName}-${hashName}`;
-    return name;
-  }
-  #path(key: string) {
-    return path.join(
-      this.#dir,
-      sanitizeFilename(this.#filename(key) + this.ext)
-    );
-  }
-  async get(key: string) {
-    // read memory
-    const memCached = this.#cache.get(key);
-    if (memCached) {
-      // console.log("memory cache hit but expired", key, cached.expires, Date.now());
-      if (memCached.expires && memCached.expires < Date.now()) {
-        await this.delete(key);
-      } else {
-        return memCached.value;
-      }
-    }
-    // read file cache
-    const path = this.#path(key);
-    const stats = await stat(path).catch(() => null);
-    if (!stats) return undefined; // stat not found
-    const expires = +stats.mtime;
-    if (expires !== 0) {
-      const expired = +stats.mtime < +Date.now();
-      if (expired) {
-        //   console.log("file cache hit expired", key, expires, Date.now(), expired);
-        await this.delete(key);
-        return undefined;
-      }
-    }
-    return await readFile(path, "utf8").catch(() => undefined);
-  }
-  async set(key: string, value: Value, ttl?: number) {
-    if (!value) return await this.delete(key);
-    // const { value, expires } = JSON.parse(stored) as DeserializedData<Value>;
-    const expires = ttl ? Date.now() + ttl : 0;
-    // save to memory
-    this.#cache.set(key, { value, expires });
-    // save to file
-    await this.#ready;
-    // console.log({ key, value, expires });
-    await mkdir(this.#dir, { recursive: true });
-    await writeFile(this.#path(key), value); // create a expired file
-    await utimes(this.#path(key), new Date(), new Date(expires ?? 0)); // set expires time as mtime (0 as never expired)
-    return true;
-  }
-  async delete(key: string) {
-    // delete memory
-    this.#cache.delete(key);
-    await rm(this.#path(key), { force: true });
-    return true;
-  }
-  async clear() {
-    await rm(this.#dir, { recursive: true }).catch(() => void 0);
-  }
-  async has(key: string) {
-    return undefined !== (await this.get(key));
-  }
-
-  // Save expires into mtime, and value into file
-  /** @deprecated use KeyvDirStoreJSON */
-  static serialize({ value }: DeserializedData<any>): string {
-    return JSON.stringify(value, null, 2);
-  }
-  /** @deprecated use KeyvDirStoreJSON */
-  static deserialize(str: string): DeserializedData<any> {
-    return { value: JSON.parse(str), expires: undefined };
-  }
-}
+import type { DeserializedData, default as Keyv } from "keyv";
+import md5 from "md5";
+import { mkdir, readFile, rm, stat, utimes, writeFile } from "node:fs/promises";
+import path from "path";
+import sanitizeFilename from "sanitize-filename";
+
+type CacheMap<Value> = Map<string, DeserializedData<Value>>;
+/**
+ * KeyvDirStore is a Keyv.Store<string> implementation that stores data in files.
+ *
+ * learn more [README](./README.md)
+ *
+ * @example
+ * const kv = new Keyv<number | string | { obj: boolean }>({
+ *   store: new KeyvDirStore("cache/test"),
+ *   deserialize: KeyvDirStore.deserialize,
+ *   serialize: KeyvDirStore.serialize,
+ * });
+ * await kv.set("a", 1234, -86400e3); // already expired
+ * expect(await kv.get("a")).toEqual(undefined); // will delete file before get
+ * await kv.set("b", 1234); // never expired
+ * expect(await kv.get("b")).toEqual(1234);
+ *
+ */
+export class KeyvDirStore<Value extends string> implements Keyv.Store<string> {
+  #dir: string;
+  #cache: CacheMap<Value>;
+  #ready: Promise<unknown>;
+  #filename: (key: string) => string;
+  ext = ".json";
+  constructor(
+    /** dir to cache store
+     * WARN: dont share this dir with other purpose
+     *       it will be rm -f when keyv.clear() is called
+     */
+    dir: string,
+    {
+      cache = new Map(),
+      filename,
+      ext,
+    }: {
+      cache?: CacheMap<Value>;
+      filename?: (key: string) => string;
+      ext?: string;
+    } = {}
+  ) {
+    this.#ready = mkdir(dir, { recursive: true }).catch(() => {});
+    this.#cache = cache;
+    this.#dir = dir;
+    this.#filename = filename ?? this.#defaultFilename;
+    this.ext = ext ?? this.ext;
+  }
+  #defaultFilename(key: string) {
+    // use dir as hash salt to avoid collisions
+    const readableName = sanitizeFilename(key).slice(0, 16);
+    const hashName = md5(key + "+SALT-poS1djRa4M2jXsWi").slice(0, 16);
+    const name = `${readableName}-${hashName}`;
+    return name;
+  }
+  #path(key: string) {
+    return path.join(
+      this.#dir,
+      sanitizeFilename(this.#filename(key) + this.ext)
+    );
+  }
+  async get(key: string) {
+    // read memory
+    const memCached = this.#cache.get(key);
+    if (memCached) {
+      // console.log("memory cache hit but expired", key, cached.expires, Date.now());
+      if (memCached.expires && memCached.expires < Date.now()) {
+        await this.delete(key);
+      } else {
+        return memCached.value;
+      }
+    }
+    // read file cache
+    const path = this.#path(key);
+    const stats = await stat(path).catch(() => null);
+    if (!stats) return undefined; // stat not found
+    const expires = +stats.mtime;
+    if (expires !== 0) {
+      const expired = +stats.mtime < +Date.now();
+      if (expired) {
+        //   console.log("file cache hit expired", key, expires, Date.now(), expired);
+        await this.delete(key);
+        return undefined;
+      }
+    }
+    return await readFile(path, "utf8").catch(() => undefined);
+  }
+  async set(key: string, value: Value, ttl?: number) {
+    if (!value) return await this.delete(key);
+    // const { value, expires } = JSON.parse(stored) as DeserializedData<Value>;
+    const expires = ttl ? Date.now() + ttl : 0;
+    // save to memory
+    this.#cache.set(key, { value, expires });
+    // save to file
+    await this.#ready;
+    // console.log({ key, value, expires });
+    await mkdir(this.#dir, { recursive: true }).catch(() => {});
+    await writeFile(this.#path(key), value); // create a expired file
+    await utimes(this.#path(key), new Date(), new Date(expires ?? 0)); // set expires time as mtime (0 as never expired)
+    return true;
+  }
+  async delete(key: string) {
+    // delete memory
+    this.#cache.delete(key);
+    await rm(this.#path(key), { force: true });
+    return true;
+  }
+  async clear() {
+    await rm(this.#dir, { recursive: true }).catch(() => void 0);
+  }
+  async has(key: string) {
+    return undefined !== (await this.get(key));
+  }
+  // Save expires into mtime, and value into file
+  /** @deprecated use KeyvDirStoreJSON */
+  static serialize({ value }: DeserializedData<any>): string {
+    return JSON.stringify(value, null, 2);
+  }
+  /** @deprecated use KeyvDirStoreJSON */
+  static deserialize(str: string): DeserializedData<any> {
+    return { value: JSON.parse(str), expires: undefined };
+  }
+}

package/package.json

@@ -1,12 +1,28 @@
 {
   "name": "keyv-dir-store",
-  "version": "0.0.7",
+  "version": "0.0.9",
+  "description": "High performance Filesystem Keyv Store, caches each key-value pair into a $key.json. and more! *.JSON, *.YAML, *.CSV is also avaliable.",
+  "keywords": [
+    "keyv",
+    "keyv-store",
+    "dir"
+  ],
+  "homepage": "https://github.com/snomiao/keyv-dir-store#readme",
+  "bugs": {
+    "url": "https://github.com/snomiao/keyv-dir-store/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/snomiao/keyv-dir-store.git"
+  },
+  "license": "MIT",
   "author": "snomiao <snomiao@gmail.com>",
   "type": "module",
   "exports": {
     "import": "./dist/index.js",
     "types": "./index.ts"
   },
+  "main": "index.js",
   "module": "index.ts",
   "types": "./index.ts",
   "files": [
@@ -15,6 +31,7 @@
   ],
   "scripts": {
     "build": "bun build index.ts --outdir=dist --target=bun",
+    "prepare": "husky",
     "prerelease": "bun run build && bun run test",
     "release": "bunx standard-version && git push --follow-tags && npm publish",
     "test": "bun test"
@@ -26,10 +43,12 @@
     "yaml": "^2.4.5"
   },
   "devDependencies": {
-    "@types/bun": "^1.1.3",
-    "@types/jest": "^29.5.12",
+    "@types/bun": "^1.1.17",
+    "@types/jest": "^29.5.14",
     "@types/md5": "^2.3.5",
-    "typescript": "^5.4.5"
+    "husky": "^9.1.7",
+    "semantic-release": "^24.2.1",
+    "typescript": "^5.7.3"
   },
   "peerDependencies": {
     "keyv": "^4.5.4"