keyv-dir-store 0.0.2 → 0.0.4

package/CHANGELOG.md

@@ -0,0 +1,16 @@
+# 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.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)

package/README.md

@@ -1,24 +1,34 @@
-
-# KeyvDIR
+# Keyv Directory Store
 
 Store key into a file per value
 
-## Store each value with CSV
+## Usages
 
 ```ts
+// Default: Store each value with JSON in format "{value: ..., expires: ...}"
 new Keyv({
-  store: new KeyvDirStore("cache/kv", { ext: "csv" }),
-  serialize: ({ value }) => csvFormat(value),
-  deserialize: (str) => ({ value: csvParse(str), expires: undefined }),
+  store: new KeyvDirStore(".cache/kv")
 });
-```
 
-## Store each value with YAML
+// 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 }),
+});
 
-```ts
+// Store each value with YAML
 new Keyv({
-  store: new KeyvDirStore("cache/kv", { ext: "yaml" }),
+  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,3 +1,4 @@
+// @bun
 var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getProtoOf = Object.getPrototypeOf;
@@ -286,47 +287,10 @@ var require_truncate = __commonJS((exports, module) => {
   };
 });
 
-// node_modules/utf8-byte-length/browser.js
-var require_browser = __commonJS((exports, module) => {
-  var isHighSurrogate = function(codePoint) {
-    return codePoint >= 55296 && codePoint <= 56319;
-  };
-  var isLowSurrogate = function(codePoint) {
-    return codePoint >= 56320 && codePoint <= 57343;
-  };
-  module.exports = function getByteLength(string) {
-    if (typeof string !== "string") {
-      throw new Error("Input must be string");
-    }
-    var charLength = string.length;
-    var byteLength = 0;
-    var codePoint = null;
-    var prevCodePoint = null;
-    for (var i = 0;i < charLength; i++) {
-      codePoint = string.charCodeAt(i);
-      if (isLowSurrogate(codePoint)) {
-        if (prevCodePoint != null && isHighSurrogate(prevCodePoint)) {
-          byteLength += 1;
-        } else {
-          byteLength += 3;
-        }
-      } else if (codePoint <= 127) {
-        byteLength += 1;
-      } else if (codePoint >= 128 && codePoint <= 2047) {
-        byteLength += 2;
-      } else if (codePoint >= 2048 && codePoint <= 65535) {
-        byteLength += 3;
-      }
-      prevCodePoint = codePoint;
-    }
-    return byteLength;
-  };
-});
-
-// node_modules/truncate-utf8-bytes/browser.js
-var require_browser2 = __commonJS((exports, module) => {
+// node_modules/truncate-utf8-bytes/index.js
+var require_truncate_utf8_bytes = __commonJS((exports, module) => {
   var truncate = require_truncate();
-  var getLength = require_browser();
+  var getLength = Buffer.byteLength.bind(Buffer);
   module.exports = truncate.bind(null, getLength);
 });
 
@@ -339,7 +303,7 @@ var require_sanitize_filename = __commonJS((exports, module) => {
     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_browser2();
+  var truncate = require_truncate_utf8_bytes();
   var illegalRe = /[\/\?<>\\:\*\|"]/g;
   var controlRe = /[\x00-\x1f\x80-\x9f]/g;
   var reservedRe = /^\.+$/;
@@ -358,236 +322,34 @@ 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);
-var {stat} = (()=>({}));
-var {writeFile} = (()=>({}));
-var {rm} = (()=>({}));
-var {readFile, mkdir} = (()=>({}));
-
-// node:path
-var L = Object.create;
-var b = Object.defineProperty;
-var z = Object.getOwnPropertyDescriptor;
-var D = Object.getOwnPropertyNames;
-var T = Object.getPrototypeOf;
-var R = Object.prototype.hasOwnProperty;
-var _ = (f, e) => () => (e || f((e = { exports: {} }).exports, e), e.exports);
-var E = (f, e) => {
-  for (var r in e)
-    b(f, r, { get: e[r], enumerable: true });
-};
-var C = (f, e, r, l) => {
-  if (e && typeof e == "object" || typeof e == "function")
-    for (let i of D(e))
-      !R.call(f, i) && i !== r && b(f, i, { get: () => e[i], enumerable: !(l = z(e, i)) || l.enumerable });
-  return f;
-};
-var A = (f, e, r) => (C(f, e, "default"), r && C(r, e, "default"));
-var y = (f, e, r) => (r = f != null ? L(T(f)) : {}, C(e || !f || !f.__esModule ? b(r, "default", { value: f, enumerable: true }) : r, f));
-var h = _((F, S) => {
-  function c(f) {
-    if (typeof f != "string")
-      throw new TypeError("Path must be a string. Received " + JSON.stringify(f));
-  }
-  function w(f, e) {
-    for (var r = "", l = 0, i = -1, s = 0, n, t = 0;t <= f.length; ++t) {
-      if (t < f.length)
-        n = f.charCodeAt(t);
-      else {
-        if (n === 47)
-          break;
-        n = 47;
-      }
-      if (n === 47) {
-        if (!(i === t - 1 || s === 1))
-          if (i !== t - 1 && s === 2) {
-            if (r.length < 2 || l !== 2 || r.charCodeAt(r.length - 1) !== 46 || r.charCodeAt(r.length - 2) !== 46) {
-              if (r.length > 2) {
-                var a = r.lastIndexOf("/");
-                if (a !== r.length - 1) {
-                  a === -1 ? (r = "", l = 0) : (r = r.slice(0, a), l = r.length - 1 - r.lastIndexOf("/")), i = t, s = 0;
-                  continue;
-                }
-              } else if (r.length === 2 || r.length === 1) {
-                r = "", l = 0, i = t, s = 0;
-                continue;
-              }
-            }
-            e && (r.length > 0 ? r += "/.." : r = "..", l = 2);
-          } else
-            r.length > 0 ? r += "/" + f.slice(i + 1, t) : r = f.slice(i + 1, t), l = t - i - 1;
-        i = t, s = 0;
-      } else
-        n === 46 && s !== -1 ? ++s : s = -1;
-    }
-    return r;
-  }
-  function J(f, e) {
-    var r = e.dir || e.root, l = e.base || (e.name || "") + (e.ext || "");
-    return r ? r === e.root ? r + l : r + f + l : l;
-  }
-  var g = { resolve: function() {
-    for (var e = "", r = false, l, i = arguments.length - 1;i >= -1 && !r; i--) {
-      var s;
-      i >= 0 ? s = arguments[i] : (l === undefined && (l = process.cwd()), s = l), c(s), s.length !== 0 && (e = s + "/" + e, r = s.charCodeAt(0) === 47);
-    }
-    return e = w(e, !r), r ? e.length > 0 ? "/" + e : "/" : e.length > 0 ? e : ".";
-  }, normalize: function(e) {
-    if (c(e), e.length === 0)
-      return ".";
-    var r = e.charCodeAt(0) === 47, l = e.charCodeAt(e.length - 1) === 47;
-    return e = w(e, !r), e.length === 0 && !r && (e = "."), e.length > 0 && l && (e += "/"), r ? "/" + e : e;
-  }, isAbsolute: function(e) {
-    return c(e), e.length > 0 && e.charCodeAt(0) === 47;
-  }, join: function() {
-    if (arguments.length === 0)
-      return ".";
-    for (var e, r = 0;r < arguments.length; ++r) {
-      var l = arguments[r];
-      c(l), l.length > 0 && (e === undefined ? e = l : e += "/" + l);
-    }
-    return e === undefined ? "." : g.normalize(e);
-  }, relative: function(e, r) {
-    if (c(e), c(r), e === r || (e = g.resolve(e), r = g.resolve(r), e === r))
-      return "";
-    for (var l = 1;l < e.length && e.charCodeAt(l) === 47; ++l)
-      ;
-    for (var i = e.length, s = i - l, n = 1;n < r.length && r.charCodeAt(n) === 47; ++n)
-      ;
-    for (var t = r.length, a = t - n, v = s < a ? s : a, u = -1, o = 0;o <= v; ++o) {
-      if (o === v) {
-        if (a > v) {
-          if (r.charCodeAt(n + o) === 47)
-            return r.slice(n + o + 1);
-          if (o === 0)
-            return r.slice(n + o);
-        } else
-          s > v && (e.charCodeAt(l + o) === 47 ? u = o : o === 0 && (u = 0));
-        break;
-      }
-      var k = e.charCodeAt(l + o), P = r.charCodeAt(n + o);
-      if (k !== P)
-        break;
-      k === 47 && (u = o);
-    }
-    var d = "";
-    for (o = l + u + 1;o <= i; ++o)
-      (o === i || e.charCodeAt(o) === 47) && (d.length === 0 ? d += ".." : d += "/..");
-    return d.length > 0 ? d + r.slice(n + u) : (n += u, r.charCodeAt(n) === 47 && ++n, r.slice(n));
-  }, _makeLong: function(e) {
-    return e;
-  }, dirname: function(e) {
-    if (c(e), e.length === 0)
-      return ".";
-    for (var r = e.charCodeAt(0), l = r === 47, i = -1, s = true, n = e.length - 1;n >= 1; --n)
-      if (r = e.charCodeAt(n), r === 47) {
-        if (!s) {
-          i = n;
-          break;
-        }
-      } else
-        s = false;
-    return i === -1 ? l ? "/" : "." : l && i === 1 ? "//" : e.slice(0, i);
-  }, basename: function(e, r) {
-    if (r !== undefined && typeof r != "string")
-      throw new TypeError('"ext" argument must be a string');
-    c(e);
-    var l = 0, i = -1, s = true, n;
-    if (r !== undefined && r.length > 0 && r.length <= e.length) {
-      if (r.length === e.length && r === e)
-        return "";
-      var t = r.length - 1, a = -1;
-      for (n = e.length - 1;n >= 0; --n) {
-        var v = e.charCodeAt(n);
-        if (v === 47) {
-          if (!s) {
-            l = n + 1;
-            break;
-          }
-        } else
-          a === -1 && (s = false, a = n + 1), t >= 0 && (v === r.charCodeAt(t) ? --t === -1 && (i = n) : (t = -1, i = a));
-      }
-      return l === i ? i = a : i === -1 && (i = e.length), e.slice(l, i);
-    } else {
-      for (n = e.length - 1;n >= 0; --n)
-        if (e.charCodeAt(n) === 47) {
-          if (!s) {
-            l = n + 1;
-            break;
-          }
-        } else
-          i === -1 && (s = false, i = n + 1);
-      return i === -1 ? "" : e.slice(l, i);
-    }
-  }, extname: function(e) {
-    c(e);
-    for (var r = -1, l = 0, i = -1, s = true, n = 0, t = e.length - 1;t >= 0; --t) {
-      var a = e.charCodeAt(t);
-      if (a === 47) {
-        if (!s) {
-          l = t + 1;
-          break;
-        }
-        continue;
-      }
-      i === -1 && (s = false, i = t + 1), a === 46 ? r === -1 ? r = t : n !== 1 && (n = 1) : r !== -1 && (n = -1);
-    }
-    return r === -1 || i === -1 || n === 0 || n === 1 && r === i - 1 && r === l + 1 ? "" : e.slice(r, i);
-  }, format: function(e) {
-    if (e === null || typeof e != "object")
-      throw new TypeError('The "pathObject" argument must be of type Object. Received type ' + typeof e);
-    return J("/", e);
-  }, parse: function(e) {
-    c(e);
-    var r = { root: "", dir: "", base: "", ext: "", name: "" };
-    if (e.length === 0)
-      return r;
-    var l = e.charCodeAt(0), i = l === 47, s;
-    i ? (r.root = "/", s = 1) : s = 0;
-    for (var n = -1, t = 0, a = -1, v = true, u = e.length - 1, o = 0;u >= s; --u) {
-      if (l = e.charCodeAt(u), l === 47) {
-        if (!v) {
-          t = u + 1;
-          break;
-        }
-        continue;
-      }
-      a === -1 && (v = false, a = u + 1), l === 46 ? n === -1 ? n = u : o !== 1 && (o = 1) : n !== -1 && (o = -1);
-    }
-    return n === -1 || a === -1 || o === 0 || o === 1 && n === a - 1 && n === t + 1 ? a !== -1 && (t === 0 && i ? r.base = r.name = e.slice(1, a) : r.base = r.name = e.slice(t, a)) : (t === 0 && i ? (r.name = e.slice(1, n), r.base = e.slice(1, a)) : (r.name = e.slice(t, n), r.base = e.slice(t, a)), r.ext = e.slice(n, a)), t > 0 ? r.dir = e.slice(0, t - 1) : i && (r.dir = "/"), r;
-  }, sep: "/", delimiter: ":", win32: null, posix: null };
-  g.posix = g;
-  S.exports = g;
-});
-var m = {};
-E(m, { default: () => q });
-A(m, y(h()));
-var q = y(h());
-
-// index.ts
-var {utimes} = (()=>({}));
+import {mkdir, readFile, rm, stat, utimes, writeFile} from "fs/promises";
+import path from "path";
 
 class KeyvDirStore {
   #dir;
   #cache;
   #ready;
-  #path;
+  #filename;
   ext = ".json";
   constructor(dir, {
     cache = new Map,
-    path,
+    filename,
     ext
   } = {}) {
     this.#ready = mkdir(dir, { recursive: true });
     this.#cache = cache;
     this.#dir = dir;
-    this.#path = path ?? this.#defaultPath;
+    this.#filename = filename ?? this.#defaultFilename;
     this.ext = ext ?? this.ext;
   }
-  #defaultPath(key) {
+  #defaultFilename(key) {
     const readableName = import_sanitize_filename.default(key).slice(4, 16);
-    const hashName = import_md5.default(this.#dir + key).slice(0, 16);
-    const name = readableName + "-" + hashName + this.ext;
-    return q.join(this.#dir, name);
+    const hashName = import_md5.default(key + "+SALT-poS1djRa4M2jXsWi").slice(0, 16);
+    const name = `${readableName}-${hashName}`;
+    return name;
+  }
+  #path(key) {
+    return path.join(this.#dir, this.#filename(key) + this.ext);
   }
   async get(key) {
     const cached = this.#cache.get(key);

package/index.test.ts

@@ -4,7 +4,7 @@ import { KeyvDirStore } from ".";
 it("KeyvDirStore works", async () => {
   // store test
   const kv = new Keyv<number | string | { obj: boolean }>({
-    store: new KeyvDirStore("cache/test1"),
+    store: new KeyvDirStore(".cache/test1"),
     deserialize: KeyvDirStore.deserialize,
     serialize: KeyvDirStore.serialize,
   });
@@ -20,7 +20,7 @@ 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"),
+    store: new KeyvDirStore(".cache/test1"),
     deserialize: KeyvDirStore.deserialize,
     serialize: KeyvDirStore.serialize,
   });
@@ -32,7 +32,7 @@ it("KeyvDirStore works", async () => {
 it("KeyvDirStore works with only store", async () => {
   // store test
   const kv = new Keyv<number | string | { obj: boolean }>({
-    store: new KeyvDirStore("cache/test2"),
+    store: new KeyvDirStore(".cache/test2"),
   });
   await kv.clear();
   await kv.set("a", 1234, -86400e3); // already expired
@@ -46,7 +46,7 @@ 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"),
   });
   expect(await kv2.get("a")).toEqual(undefined); // will delete file before get
   expect(await kv2.get("b")).toEqual(1234);

package/index.ts

@@ -1,12 +1,8 @@
-import { stat } from "fs/promises";
-import { writeFile } from "fs/promises";
-import { rm } from "fs/promises";
-import { readFile, mkdir } from "fs/promises";
-import { type default as Keyv, type DeserializedData } from "keyv";
+import type { DeserializedData, default as Keyv } from "keyv";
 import md5 from "md5";
-import sanitizeFilename from "sanitize-filename";
+import { mkdir, readFile, rm, stat, utimes, writeFile } from "node:fs/promises";
 import path from "path";
-import { utimes } from "fs/promises";
+import sanitizeFilename from "sanitize-filename";
 type Value = any;
 type CacheMap<Value> = Map<string, DeserializedData<Value>>;
 /**
@@ -26,32 +22,35 @@ export class KeyvDirStore implements Keyv.Store<string> {
   #dir: string;
   #cache: CacheMap<Value>;
   #ready: Promise<unknown>;
-  #path: (key: string) => string;
+  #filename: (key: string) => string;
   ext = ".json";
   constructor(
     dir: string,
     {
       cache = new Map(),
-      path,
+      filename,
       ext,
     }: {
       cache?: CacheMap<Value>;
-      path?: (key: string) => string;
+      filename?: (key: string) => string;
       ext?: string;
     } = {}
   ) {
     this.#ready = mkdir(dir, { recursive: true });
     this.#cache = cache;
     this.#dir = dir;
-    this.#path = path ?? this.#defaultPath;
+    this.#filename = filename ?? this.#defaultFilename;
     this.ext = ext ?? this.ext;
   }
-  #defaultPath(key: string) {
+  #defaultFilename(key: string) {
     // use dir as hash salt to avoid collisions
     const readableName = sanitizeFilename(key).slice(4, 16);
-    const hashName = md5(this.#dir + key).slice(0, 16);
-    const name = readableName + "-" + hashName + this.ext;
-    return path.join(this.#dir, name);
+    const hashName = md5(key + "+SALT-poS1djRa4M2jXsWi").slice(0, 16);
+    const name = `${readableName}-${hashName}`;
+    return name;
+  }
+  #path(key: string) {
+    return path.join(this.#dir, this.#filename(key) + this.ext);
   }
   async get(key: string) {
     // read memory

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "keyv-dir-store",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "author": "snomiao <snomiao@gmail.com>",
   "type": "module",
   "exports": {
@@ -13,11 +13,16 @@
     "dist"
   ],
   "scripts": {
-    "build": "bun build index.ts --outdir=dist",
+    "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"
   },
+  "dependencies": {
+    "@types/node": "^20.14.2",
+    "md5": "^2.3.0",
+    "sanitize-filename": "^1.6.3"
+  },
   "devDependencies": {
     "@types/bun": "^1.1.3",
     "@types/jest": "^29.5.12",
@@ -26,9 +31,5 @@
   },
   "peerDependencies": {
     "keyv": "^4.5.4"
-  },
-  "dependencies": {
-    "md5": "^2.3.0",
-    "sanitize-filename": "^1.6.3"
   }
 }