polystore 0.15.0 → 0.15.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "polystore",
-  "version": "0.15.0",
+  "version": "0.15.2",
   "description": "A small compatibility layer for many popular KV stores like localStorage, Redis, FileSystem, etc.",
   "homepage": "https://polystore.dev/",
   "repository": "https://github.com/franciscop/polystore.git",

package/readme.md

@@ -700,7 +700,7 @@ await fsp.writeFile(file, serialValue);
 
 ### Folder
 
-Treat a single folder in your filesystem as the source for the KV store, with each key being within a file:
+Treat a single folder in your filesystem as the store, where each key is a file:
 
 ```js
 import kv from "polystore";
@@ -708,6 +708,7 @@ import kv from "polystore";
 const store = kv(new URL("file:///Users/me/project/data/"));
 
 await store.set("key1", "Hello world", { expires: "1h" });
+// Writes "./data/key1.json"
 console.log(await store.get("key1"));
 // "Hello world"
 ```
@@ -717,12 +718,14 @@ console.log(await store.get("key1"));
 You can also create multiple stores:
 
 ```js
-// Paths need to be absolute, but you can use process.cwd() to make
-// it relative to the current process:
+// Paths need to be absolute, but you can use `process.cwd()` to make
+// it relative to the current process, or `import.meta.dirname`:
 const store1 = kv(new URL(`file://${process.cwd()}/cache/`));
 const store2 = kv(new URL(`file://${import.meta.dirname}/data/`));
 ```
 
+The folder is created if it doesn't exist. When a key is deleted, the corresponding file is also deleted. The data is serialized as JSON, with a meta wrapper to store the expiration date.
+
 <details>
   <summary>Why use polystore with a folder?</summary>
   <p>These benefits are for wrapping a folder with polystore:</p>

package/src/clients/api.js

@@ -1,71 +1,39 @@
-// Use fetch()
+const enc = encodeURIComponent; // Optimization of size
+
+// Handle an API endpoint with fetch()
 export default class Api {
-  // Indicate that the file handler does NOT handle expirations
+  // Indicate that the file handler DOES handle expirations
   EXPIRES = true;
 
-  // Check whether the given store is a FILE-type
-  static test(client) {
-    return (
-      typeof client === "string" &&
-      (client.startsWith("https://") || client.startsWith("http://"))
-    );
-  }
+  static test = (client) =>
+    typeof client === "string" && /^https?:\/\//.test(client);
 
   constructor(client) {
-    client = client.replace(/\/$/, "") + "/";
-    this.client = async (path, opts = {}) => {
-      const query = Object.entries(opts.query || {})
-        .map(([k, v]) => `${k}=${encodeURIComponent(v)}`)
-        .join("&");
-      let url = client + path.replace(/^\//, "") + "?" + query;
-      opts.headers = opts.headers || {};
-      opts.headers.accept = "application/json";
-      if (opts.body) opts.headers["content-type"] = "application/json";
-      const res = await fetch(url, opts);
-      if (!res.ok) return null;
-      if (!res.headers["content-type"] !== "application/json") {
-        console.warn("Not a JSON API");
-      }
-      return res.json();
+    client = client.replace(/\/$/, "");
+    this.client = async (path, method = "GET", body) => {
+      const url = `${client}/${path.replace(/^\//, "")}`;
+      const headers = { accept: "application/json" };
+      if (body) headers["content-type"] = "application/json";
+      const res = await fetch(url, { method, headers, body });
+      return res.ok ? res.json() : null;
     };
   }
 
-  async get(key) {
-    return await this.client(`/${key}`);
-  }
+  get = (key) => this.client(`/${enc(key)}`);
 
-  async set(key, value, { expires } = {}) {
-    return await this.client(`/${encodeURIComponent(key)}`, {
-      query: { expires },
-      method: "put",
-      body: JSON.stringify(value),
-    });
-  }
+  set = (key, value, { expires } = {}) =>
+    this.client(
+      `/${enc(key)}?expires=${enc(expires || "")}`,
+      "PUT",
+      JSON.stringify(value),
+    );
 
-  async del(key) {
-    return await this.client(`/${encodeURIComponent(key)}`, {
-      method: "delete",
-    });
-  }
+  del = (key) => this.client(`/${enc(key)}`, "DELETE");
 
-  // Since we have pagination, we don't want to get all of the
-  // keys at once if we can avoid it
   async *iterate(prefix = "") {
-    const data = await this.client("/", { query: { prefix } });
-    if (!data) return [];
-    for (let [key, value] of Object.entries(data)) {
+    const data = await this.client(`/?prefix=${enc(prefix)}`);
+    for (let [key, value] of Object.entries(data || {})) {
       yield [prefix + key, value];
     }
   }
-
-  async keys(prefix = "") {
-    const data = await this.client(`/`, { query: { prefix } });
-    if (!data) return [];
-    return Object.keys(data).map((k) => prefix + k);
-  }
-
-  async clear(prefix = "") {
-    const list = await this.keys(prefix);
-    return Promise.all(list.map((k) => this.del(k)));
-  }
 }

package/src/clients/file.js

@@ -29,7 +29,8 @@ export default class File {
       // We want to make sure the file already exists, so attempt to
       // create the folders and the file (but not OVERWRITE it, that's why the x flag)
       // It fails if it already exists, hence the catch case
-      await fsp.mkdir(path.dirname(this.file), { recursive: true });
+      const folder = path.dirname(this.file);
+      await fsp.mkdir(folder, { recursive: true }).catch(() => {});
       await fsp.writeFile(this.file, "{}", { flag: "wx" }).catch((err) => {
         if (err.code !== "EEXIST") throw err;
       });

package/src/clients/folder.js

@@ -32,7 +32,7 @@ export default class Folder {
 
       // Make sure the folder already exists, so attempt to create it
       // It fails if it already exists, hence the catch case
-      await fsp.mkdir(this.folder, { recursive: true }).catch((err) => {});
+      await fsp.mkdir(this.folder, { recursive: true }).catch(() => {});
       return fsp;
     })();
   }

package/src/server.js

@@ -1,7 +1,6 @@
 // This is an example server implementation of the HTTP library!
 import http from "node:http";
 import kv from "./index.js";
-import { parse } from "./utils.js";
 
 // Modify this to use any sub-store as desired. It's nice
 // to use polystore itself for the polystore server library!'