keyv-dir-store 0.0.6 → 0.0.8

package/KeyvDirStoreAsJSON.ts

@@ -0,0 +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 };
+  },
+};

package/KeyvDirStoreAsYaml.ts

@@ -0,0 +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 };
+  },
+};

package/README.md

@@ -1,6 +1,6 @@
 # Keyv Directory Store
 
-Store key into a file per value
+High performance Filesystem Keyv Store, caches each key-value pair into a $key.json. and more! *.JSON, *.YAML, *.CSV is also avaliable.
 
 ## Usages
 
@@ -10,13 +10,20 @@ new Keyv({
   store: new KeyvDirStore(".cache/kv")
 });
 
-// Store each value with CSV
+// 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" }),

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,14 +336,15 @@ 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;
     this.ext = ext ?? this.ext;
   }
   #defaultFilename(key) {
-    const readableName = import_sanitize_filename.default(key).slice(4, 16);
+    const readableName = import_sanitize_filename.default(key).slice(0, 16);
     const hashName = import_md5.default(key + "+SALT-poS1djRa4M2jXsWi").slice(0, 16);
     const name = `${readableName}-${hashName}`;
     return name;
@@ -352,15 +353,16 @@ class KeyvDirStore {
     return path.join(this.#dir, import_sanitize_filename.default(this.#filename(key) + this.ext));
   }
   async get(key) {
-    const cached = this.#cache.get(key);
-    if (cached) {
-      if (cached.expires && cached.expires < Date.now()) {
+    const memCached = this.#cache.get(key);
+    if (memCached) {
+      if (memCached.expires && memCached.expires < Date.now()) {
         await this.delete(key);
       } else {
-        return cached.value;
+        return memCached.value;
       }
     }
-    const stats = await stat(this.#path(key)).catch(() => null);
+    const path2 = this.#path(key);
+    const stats = await stat(path2).catch(() => null);
     if (!stats)
       return;
     const expires = +stats.mtime;
@@ -371,7 +373,7 @@ class KeyvDirStore {
         return;
       }
     }
-    return await readFile(this.#path(key), "utf8").catch(() => {
+    return await readFile(path2, "utf8").catch(() => {
       return;
     });
   }
@@ -381,6 +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 }).catch(() => {
+    });
     await writeFile(this.#path(key), value);
     await utimes(this.#path(key), new Date, new Date(expires ?? 0));
     return true;
@@ -394,7 +398,6 @@ class KeyvDirStore {
     await rm(this.#dir, { recursive: true }).catch(() => {
       return;
     });
-    await mkdir(this.#dir, { recursive: true });
   }
   async has(key) {
     return await this.get(key) !== undefined;

package/{index.test.ts → index.spec.ts}

@@ -1,18 +1,28 @@
+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"),
+    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
@@ -20,19 +30,20 @@ it("KeyvDirStore works", async () => {
 
   // new instance with no cache Obj, to test file cache
   const kv2 = new Keyv<number | string | { obj: boolean }>({
-    store: new KeyvDirStore(".cache/test1"),
-    deserialize: KeyvDirStore.deserialize,
-    serialize: KeyvDirStore.serialize,
+    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 with only store", async () => {
+it("KeyvDirStore works without deserialize", async () => {
   // store test
   const kv = new Keyv<number | string | { obj: boolean }>({
-    store: new KeyvDirStore(".cache/test2"),
+    store: new KeyvDirStore(".cache/test2", { filename: (x) => x }),
+    namespace: "",
   });
   await kv.clear();
   await kv.set("a", 1234, -86400e3); // already expired
@@ -46,7 +57,8 @@ it("KeyvDirStore works with only store", async () => {
 
   // new instance with no cache Obj, to test file cache
   const kv2 = new Keyv<number | string | { obj: boolean }>({
-    store: new KeyvDirStore(".cache/test2"),
+    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);

package/index.ts

@@ -3,10 +3,13 @@ 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 Value = any;
+
 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"),
@@ -17,14 +20,19 @@ type CacheMap<Value> = Map<string, DeserializedData<Value>>;
  * 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 implements Keyv.Store<string> {
+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(),
@@ -36,15 +44,16 @@ export class KeyvDirStore implements Keyv.Store<string> {
       ext?: string;
     } = {}
   ) {
-    this.#ready = mkdir(dir, { recursive: true });
+    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(4, 16);
+    const readableName = sanitizeFilename(key).slice(0, 16);
     const hashName = md5(key + "+SALT-poS1djRa4M2jXsWi").slice(0, 16);
     const name = `${readableName}-${hashName}`;
     return name;
@@ -57,17 +66,18 @@ export class KeyvDirStore implements Keyv.Store<string> {
   }
   async get(key: string) {
     // read memory
-    const cached = this.#cache.get(key);
-    if (cached) {
+    const memCached = this.#cache.get(key);
+    if (memCached) {
       // console.log("memory cache hit but expired", key, cached.expires, Date.now());
-      if (cached.expires && cached.expires < Date.now()) {
+      if (memCached.expires && memCached.expires < Date.now()) {
         await this.delete(key);
       } else {
-        return cached.value;
+        return memCached.value;
       }
     }
     // read file cache
-    const stats = await stat(this.#path(key)).catch(() => null);
+    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) {
@@ -78,8 +88,7 @@ export class KeyvDirStore implements Keyv.Store<string> {
         return undefined;
       }
     }
-    // return this.#parse(await readFile(this.#path(key), "utf8"));
-    return await readFile(this.#path(key), "utf8").catch(() => undefined);
+    return await readFile(path, "utf8").catch(() => undefined);
   }
   async set(key: string, value: Value, ttl?: number) {
     if (!value) return await this.delete(key);
@@ -90,8 +99,9 @@ export class KeyvDirStore implements Keyv.Store<string> {
     // 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 a future expires time (0 as never expired)
+    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) {
@@ -102,17 +112,18 @@ export class KeyvDirStore implements Keyv.Store<string> {
   }
   async clear() {
     await rm(this.#dir, { recursive: true }).catch(() => void 0);
-    await mkdir(this.#dir, { recursive: true });
   }
   async has(key: string) {
     return undefined !== (await this.get(key));
   }
 
   // Save expires into mtime, and value into file
-  static serialize({ value }: DeserializedData<Value>): string {
+  /** @deprecated use KeyvDirStoreJSON */
+  static serialize({ value }: DeserializedData<any>): string {
     return JSON.stringify(value, null, 2);
   }
-  static deserialize(str: string): DeserializedData<Value> {
+  /** @deprecated use KeyvDirStoreJSON */
+  static deserialize(str: string): DeserializedData<any> {
     return { value: JSON.parse(str), expires: undefined };
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "keyv-dir-store",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "author": "snomiao <snomiao@gmail.com>",
   "type": "module",
   "exports": {
@@ -17,17 +17,21 @@
     "build": "bun build index.ts --outdir=dist --target=bun",
     "prerelease": "bun run build && bun run test",
     "release": "bunx standard-version && git push --follow-tags && npm publish",
-    "test": "bun test"
+    "test": "bun test",
+    "prepare": "husky"
   },
   "dependencies": {
     "@types/node": "^20.14.2",
     "md5": "^2.3.0",
-    "sanitize-filename": "^1.6.3"
+    "sanitize-filename": "^1.6.3",
+    "yaml": "^2.4.5"
   },
   "devDependencies": {
     "@types/bun": "^1.1.3",
     "@types/jest": "^29.5.12",
     "@types/md5": "^2.3.5",
+    "husky": "^9.1.7",
+    "semantic-release": "^24.2.1",
     "typescript": "^5.4.5"
   },
   "peerDependencies": {

package/CHANGELOG.md

@@ -1,31 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
-
-### [0.0.6](https://github.com/snomiao/keyv-dir-store/compare/v0.0.5...v0.0.6) (2024-06-27)
-
-
-### Bug Fixes
-
-* - [`fs.utimes` doesn't support `number` or `string` on Windows · Issue [#33227](https://github.com/snomiao/keyv-dir-store/issues/33227) · nodejs/node]( https://github.com/nodejs/node/issues/33227 ) ([ff4981c](https://github.com/snomiao/keyv-dir-store/commit/ff4981cde2564eb9e49350d97149653d0066f850))
-
-### [0.0.5](https://github.com/snomiao/keyv-dir-store/compare/v0.0.4...v0.0.5) (2024-06-26)
-
-
-### Bug Fixes
-
-* **main:** sanitize ([ae7b162](https://github.com/snomiao/keyv-dir-store/commit/ae7b162cb8835bccda3c81769009ac0a78c7fac0))
-* **main:** stage ([86d9193](https://github.com/snomiao/keyv-dir-store/commit/86d9193f5aa095ac77d006f081a3b0e801c1327e))
-
-### [0.0.4](https://github.com/snomiao/keyv-dir-store/compare/v0.0.3...v0.0.4) (2024-06-26)
-
-### [0.0.3](https://github.com/snomiao/keyv-dir-store/compare/v0.0.2...v0.0.3) (2024-06-12)
-
-
-### Features
-
-* **kds:** init ([7ef5f68](https://github.com/snomiao/keyv-dir-store/commit/7ef5f68430657a81dcace597148c7641032ed6ab))
-
-### [0.0.2](https://github.com/snomiao/keyv-dir-store/compare/v0.0.1...v0.0.2) (2024-06-12)
-
-### 0.0.1 (2024-06-12)