polystore 0.11.2 → 0.11.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "polystore",
-  "version": "0.11.2",
+  "version": "0.11.4",
   "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/src/clients/cloudflare.js

@@ -23,8 +23,7 @@ export default class Cloudflare {
 
   async set(key, value, { expires } = {}) {
     const expirationTtl = expires ? Math.round(expires) : undefined;
-    this.client.put(key, JSON.stringify(value), { expirationTtl });
-    return key;
+    return this.client.put(key, JSON.stringify(value), { expirationTtl });
   }
 
   async del(key) {
@@ -40,8 +39,7 @@ export default class Cloudflare {
       const keys = raw.keys.map((k) => k.name);
       for (let key of keys) {
         const value = await this.get(key);
-        // By the time this specific value is read, it could
-        // already be gone!
+        // By the time this specific value is read, it could be gone!
         if (!value) continue;
         yield [key, value];
       }
@@ -63,7 +61,7 @@ export default class Cloudflare {
   async entries(prefix = "") {
     const keys = await this.keys(prefix);
     const values = await Promise.all(keys.map((k) => this.get(k)));
-    return keys.map((key, i) => [key, values[i]]);
+    return keys.map((k, i) => [k, values[i]]);
   }
 
   async clear(prefix = "") {

package/src/clients/cookie.js

@@ -31,22 +31,19 @@ export default class Cookie {
 
   set(key, data = null, { expires } = {}) {
     // Setting it to null deletes it
-    if (data === null) {
-      data = "";
-      expires = -100;
-    }
-
     let expireStr = "";
     // NOTE: 0 is already considered here!
     if (expires !== null) {
-      const now = new Date().getTime();
-      const time = new Date(now + expires * 1000).toUTCString();
+      const time = new Date(Date.now() + expires * 1000).toUTCString();
       expireStr = `; expires=${time}`;
     }
 
-    const value = encodeURIComponent(JSON.stringify(data));
+    const value = encodeURIComponent(JSON.stringify(data || ""));
     document.cookie = encodeURIComponent(key) + "=" + value + expireStr;
-    return key;
+  }
+
+  del(key) {
+    this.set(key, "", { expires: -100 });
   }
 
   async *iterate(prefix = "") {

package/src/clients/etcd.js

@@ -14,11 +14,11 @@ export default class Etcd {
   }
 
   async set(key, value) {
-    if (value === null) {
-      return this.client.delete().key(key).exec();
-    }
+    return this.client.put(key).value(JSON.stringify(value));
+  }
 
-    await this.client.put(key).value(JSON.stringify(value));
+  async del(key) {
+    return this.client.delete().key(key).exec();
   }
 
   async *iterate(prefix = "") {
@@ -28,19 +28,18 @@ export default class Etcd {
     }
   }
 
+  async keys(prefix = "") {
+    return this.client.getAll().prefix(prefix).keys();
+  }
+
   async entries(prefix = "") {
-    const keys = await this.client.getAll().prefix(prefix).keys();
+    const keys = await this.keys(prefix);
     const values = await Promise.all(keys.map((k) => this.get(k)));
     return keys.map((k, i) => [k, values[i]]);
   }
 
   async clear(prefix = "") {
     if (!prefix) return this.client.delete().all();
-
     return this.client.delete().prefix(prefix);
   }
-
-  async close() {
-    // return this.client.close();
-  }
 }

package/src/clients/forage.js

@@ -14,12 +14,11 @@ export default class Forage {
   }
 
   async set(key, value) {
-    if (value === null) {
-      await this.client.removeItem(key);
-    } else {
-      await this.client.setItem(key, value);
-    }
-    return key;
+    return this.client.setItem(key, value);
+  }
+
+  async del(key) {
+    return this.client.removeItem(key);
   }
 
   async *iterate(prefix = "") {

package/src/clients/memory.js

@@ -14,33 +14,27 @@ export default class Memory {
   }
 
   set(key, data) {
-    this.client.set(key, data);
+    return this.client.set(key, data);
   }
 
   del(key) {
-    this.client.delete(key);
+    return this.client.delete(key);
   }
 
   *iterate(prefix = "") {
-    const entries = this.entries();
-    for (const entry of entries) {
+    for (const entry of this.client.entries()) {
       if (!entry[0].startsWith(prefix)) continue;
       yield entry;
     }
   }
 
-  // Group methods
-  entries(prefix = "") {
-    const entries = [...this.client.entries()];
-    return entries.filter((p) => p[0].startsWith(prefix));
-  }
-
   clear(prefix = "") {
     // Delete the whole dataset
     if (!prefix) return this.client.clear();
 
     // Delete them in a map
-    const list = this.entries(prefix);
-    return Promise.all(list.map((e) => e[0]).map((k) => this.del(k)));
+    return [...this.client.keys()]
+      .filter((k) => k.startsWith(prefix))
+      .map((k) => this.del(k));
   }
 }

package/src/clients/redis.js

@@ -19,13 +19,12 @@ export default class Redis {
   }
 
   async set(key, value, { expires } = {}) {
-    if (value === null || expires === 0) {
-      return this.client.del(key);
-    }
-
     const EX = expires ? Math.round(expires) : undefined;
-    await this.client.set(key, JSON.stringify(value), { EX });
-    return key;
+    return this.client.set(key, JSON.stringify(value), { EX });
+  }
+
+  async del(key) {
+    return this.client.del(key);
   }
 
   async has(key) {
@@ -42,6 +41,8 @@ export default class Redis {
     const MATCH = prefix + "*";
     for await (const key of this.client.scanIterator({ MATCH })) {
       const value = await this.get(key);
+      // By the time this specific value is read, it could be gone!
+      if (!value) continue;
       yield [key, value];
     }
   }
@@ -68,7 +69,7 @@ export default class Redis {
     if (!prefix) return this.client.flushAll();
 
     const list = await this.keys(prefix);
-    return Promise.all(list.map((k) => this.set(k, null)));
+    return Promise.all(list.map((k) => this.client.del(k)));
   }
 
   async close() {

package/src/clients/storage.js

@@ -17,27 +17,20 @@ export default class WebStorage {
   }
 
   set(key, data) {
-    if (data === null) {
-      this.client.removeItem(key);
-    } else {
-      this.client.setItem(key, JSON.stringify(data));
-    }
-    return key;
+    return this.client.setItem(key, JSON.stringify(data));
   }
 
-  *iterate(prefix = "") {
-    const entries = this.entries(prefix);
-    for (const entry of entries) {
-      yield entry;
-    }
+  del(key) {
+    return this.client.removeItem(key);
   }
 
-  // Group methods
-  entries(prefix = "") {
-    const entries = Object.entries(this.client);
-    return entries
-      .map((p) => [p[0], p[1] ? JSON.parse(p[1]) : null])
-      .filter((p) => p[0].startsWith(prefix));
+  *iterate(prefix = "") {
+    for (const key of Object.keys(this.client)) {
+      if (!key.startsWith(prefix)) continue;
+      const value = this.get(key);
+      if (!value) continue;
+      yield [key, value];
+    }
   }
 
   clear(prefix = "") {
@@ -45,6 +38,8 @@ export default class WebStorage {
     if (!prefix) return this.client.clear();
 
     // Delete them in a map
-    return this.entries(prefix).map((e) => this.set(e[0], null));
+    return Object.keys(this.client)
+      .filter((k) => k.startsWith(prefix))
+      .map((k) => this.del(k));
   }
 }

package/src/index.js

@@ -1,19 +1,11 @@
-/**
- * A number, or a string containing a number.
- * @typedef {(number|string|object|array)} Value
- */
-
 import clients from "./clients/index.js";
 import { createId, isClass, parse } from "./utils.js";
 
-// #region Store
 class Store {
   PREFIX = "";
 
   constructor(clientPromise = new Map()) {
     this.promise = Promise.resolve(clientPromise).then(async (client) => {
-      if (client?.open) await client.open();
-      if (client?.connect) await client.connect();
       this.client = this.#find(client);
       this.#validate(this.client);
       this.promise = null;
@@ -21,7 +13,6 @@ class Store {
     });
   }
 
-  // #region #client()
   #find(store) {
     // Already a fully compliant KV store
     if (store instanceof Store) return store.client;
@@ -41,7 +32,6 @@ class Store {
     return store;
   }
 
-  // #region #validate()
   #validate(client) {
     if (!client.set || !client.get || !client.iterate) {
       throw new Error(
@@ -50,20 +40,12 @@ class Store {
     }
 
     if (!client.EXPIRES) {
-      if (client.has) {
-        throw new Error(
-          `You can only define client.has() when the client manages the expiration; otherwise please do NOT define .has() and let us manage it`
-        );
-      }
-      if (client.keys) {
-        throw new Error(
-          `You can only define client.keys() when the client manages the expiration; otherwise please do NOT define .keys() and let us manage them`
-        );
-      }
-      if (client.values) {
-        console.warn(
-          `Since this KV client does not manage expiration, it's better not to define client.values() since it doesn't allow us to evict expired keys`
-        );
+      for (let method of ["has", "keys", "values"]) {
+        if (client[method]) {
+          throw new Error(
+            `You can only define client.${method}() when the client manages the expiration; otherwise please do NOT define .${method}() and let us manage it`
+          );
+        }
       }
     }
   }
@@ -93,21 +75,6 @@ class Store {
     return false;
   }
 
-  // #region .add()
-  /**
-   * Save the data on an autogenerated key, can add expiration as well:
-   *
-   * ```js
-   * const key1 = await store.add("value1");
-   * const key2 = await store.add({ hello: "world" });
-   * const key3 = await store.add("value3", { expires: "1h" });
-   * ```
-   *
-   * **[→ Full .add() Docs](https://polystore.dev/documentation#add)**
-   * @param {Value} value
-   * @param {{ expires: string }} options
-   * @returns {Promise<string>}
-   */
   async add(value, options = {}) {
     await this.promise;
     const expires = parse(options.expire ?? options.expires);
@@ -130,22 +97,6 @@ class Store {
     return id; // The plain one without the prefix
   }
 
-  // #region .set()
-  /**
-   * Save the data on the given key, can add expiration as well:
-   *
-   * ```js
-   * const key = await store.set("key1", "value1");
-   * await store.set("key2", { hello: "world" });
-   * await store.set("key3", "value3", { expires: "1h" });
-   * ```
-   *
-   * **[→ Full .set() Docs](https://polystore.dev/documentation#set)**
-   * @param {string} key
-   * @param {Value} value
-   * @param {{ expires: string }} options
-   * @returns {Promise<string>}
-   */
   async set(key, value, options = {}) {
     await this.promise;
     const id = this.PREFIX + key;
@@ -168,23 +119,6 @@ class Store {
     return key;
   }
 
-  // #region .get()
-  /**
-   * Read a single value from the KV store:
-   *
-   * ```js
-   * const value1 = await store.get("key1");
-   * // null (doesn't exist or has expired)
-   * const value2 = await store.get("key2");
-   * // "value2"
-   * const value3 = await store.get("key3");
-   * // { hello: "world" }
-   * ```
-   *
-   * **[→ Full .get() Docs](https://polystore.dev/documentation#get)**
-   * @param {string} key
-   * @returns {Promise<Value>}
-   */
   async get(key) {
     await this.promise;
     const id = this.PREFIX + key;
@@ -202,26 +136,6 @@ class Store {
     return data.value;
   }
 
-  // #region .has()
-  /**
-   * Check whether a key exists or not:
-   *
-   * ```js
-   * if (await store.has("key1")) { ... }
-   * ```
-   *
-   * If you are going to use the value, it's better to just read it:
-   *
-   * ```js
-   * const val = await store.get("key1");
-   * if (val) { ... }
-   * ```
-   *
-   *
-   * **[→ Full .has() Docs](https://polystore.dev/documentation#has)**
-   * @param {string} key
-   * @returns {Promise<boolean>}
-   */
   async has(key) {
     await this.promise;
     const id = this.PREFIX + key;
@@ -234,18 +148,6 @@ class Store {
     return value !== null;
   }
 
-  // #region .del()
-  /**
-   * Remove a single key and its value from the store:
-   *
-   * ```js
-   * const key = await store.del("key1");
-   * ```
-   *
-   * **[→ Full .del() Docs](https://polystore.dev/documentation#del)**
-   * @param {string} key
-   * @returns {Promise<string>}
-   */
   async del(key) {
     await this.promise;
     const id = this.PREFIX + key;
@@ -272,33 +174,19 @@ class Store {
     }
   }
 
-  // #region .entries()
-  /**
-   * Return an array of the entries, in the [key, value] format:
-   *
-   * ```js
-   * const entries = await store.entries();
-   * // [["key1", "value1"], ["key2", { hello: "world" }], ...]
-   *
-   * // To limit it to a given prefix, use `.prefix()`:
-   * const sessions = await store.prefix("session:").entries();
-   * ```
-   *
-   * **[→ Full .entries() Docs](https://polystore.dev/documentation#entries)**
-   * @returns {Promise<[string, Value][]>}
-   */
   async entries() {
     await this.promise;
 
+    // Cut the key to size
+    const trim = (key) => key.slice(this.PREFIX.length);
+
     let list = [];
     if (this.client.entries) {
-      list = (await this.client.entries(this.PREFIX)).map(([key, value]) => [
-        key.slice(this.PREFIX.length),
-        value,
-      ]);
+      const entries = await this.client.entries(this.PREFIX);
+      list = entries.map(([key, value]) => [trim(key), value]);
     } else {
       for await (const [key, value] of this.client.iterate(this.PREFIX)) {
-        list.push([key.slice(this.PREFIX.length), value]);
+        list.push([trim(key), value]);
       }
     }
 
@@ -312,21 +200,6 @@ class Store {
       .map(([key, data]) => [key, data.value]);
   }
 
-  // #region .keys()
-  /**
-   * Return an array of the keys in the store:
-   *
-   * ```js
-   * const keys = await store.keys();
-   * // ["key1", "key2", ...]
-   *
-   * // To limit it to a given prefix, use `.prefix()`:
-   * const sessions = await store.prefix("session:").keys();
-   * ```
-   *
-   * **[→ Full .keys() Docs](https://polystore.dev/documentation#keys)**
-   * @returns {Promise<string[]>}
-   */
   async keys() {
     await this.promise;
 
@@ -340,21 +213,6 @@ class Store {
     return entries.map((e) => e[0]);
   }
 
-  // #region .values()
-  /**
-   * Return an array of the values in the store:
-   *
-   * ```js
-   * const values = await store.values();
-   * // ["value1", { hello: "world" }, ...]
-   *
-   * // To limit it to a given prefix, use `.prefix()`:
-   * const sessions = await store.prefix("session:").values();
-   * ```
-   *
-   * **[→ Full .values() Docs](https://polystore.dev/documentation#values)**
-   * @returns {Promise<Value[]>}
-   */
   async values() {
     await this.promise;
 
@@ -370,21 +228,6 @@ class Store {
     return entries.map((e) => e[1]);
   }
 
-  // #region .all()
-  /**
-   * Return an object with the keys:values in the store:
-   *
-   * ```js
-   * const obj = await store.all();
-   * // { key1: "value1", key2: { hello: "world" }, ... }
-   *
-   * // To limit it to a given prefix, use `.prefix()`:
-   * const sessions = await store.prefix("session:").all();
-   * ```
-   *
-   * **[→ Full .all() Docs](https://polystore.dev/documentation#all)**
-   * @returns {Promise<{ [key:string]: Value }>}
-   */
   async all() {
     await this.promise;
 
@@ -402,19 +245,6 @@ class Store {
     return Object.fromEntries(entries);
   }
 
-  // #region .clear()
-  /**
-   * Delete all of the records of the store:
-   *
-   * ```js
-   * await store.clear();
-   * ```
-   *
-   * It's useful for cache invalidation, clearing the data, and testing.
-   *
-   * **[→ Full .clear() Docs](https://polystore.dev/documentation#clear)**
-   * @returns {Promise<null>}
-   */
   async clear() {
     await this.promise;
 
@@ -427,23 +257,6 @@ class Store {
     await Promise.all(keys.map((key) => this.del(key)));
   }
 
-  // #region .prefix()
-  /**
-   * Create a substore where all the keys are stored with
-   * the given prefix:
-   *
-   * ```js
-   * const session = store.prefix("session:");
-   * await session.set("key1", "value1");
-   * console.log(await session.entries());  // session.
-   * // [["key1", "value1"]]
-   * console.log(await store.entries());  // store.
-   * // [["session:key1", "value1"]]
-   * ```
-   *
-   * **[→ Full .prefix() Docs](https://polystore.dev/documentation#prefix)**
-   * @returns {Store}
-   */
   prefix(prefix = "") {
     const store = new Store(
       Promise.resolve(this.promise).then((client) => client || this.client)
@@ -452,19 +265,6 @@ class Store {
     return store;
   }
 
-  // #region .close()
-  /**
-   * Stop the connection to the store, if any:
-   *
-   * ```js
-   * await session.set("key1", "value1");
-   * await store.close();
-   * await session.set("key2", "value2");  // error
-   * ```
-   *
-   * **[→ Full .close() Docs](https://polystore.dev/documentation#close)**
-   * @returns {Store}
-   */
   async close() {
     await this.promise;