polystore 0.15.13 → 0.16.0

package/src/clients/cookie.js

@@ -1,51 +0,0 @@
-import Client from "./Client.js";
-
-// A client that uses a single file (JSON) as a store
-export default class Cookie extends Client {
-  // Indicate if this client handles expirations (true = it does)
-  EXPIRES = true;
-
-  // Check if this is the right class for the given client
-  static test = (client) => client === "cookie" || client === "cookies";
-
-  // Group methods
-  #read = () => {
-    const all = {};
-    for (let entry of document.cookie.split(";")) {
-      try {
-        const [rawKey, rawValue] = entry.split("=");
-        const key = decodeURIComponent(rawKey.trim());
-        const value = JSON.parse(decodeURIComponent(rawValue.trim()));
-        all[key] = value;
-      } catch (error) {
-        // no-op (some 3rd party can set cookies independently)
-      }
-    }
-    return all;
-  };
-
-  // For cookies, an empty value is the same as null, even `""`
-  get = (key) => this.#read()[key] || null;
-
-  set = (key, data = null, { expires } = {}) => {
-    // Setting it to null deletes it
-    let expireStr = "";
-    // NOTE: 0 is already considered here!
-    if (expires !== null) {
-      const time = new Date(Date.now() + expires * 1000).toUTCString();
-      expireStr = `; expires=${time}`;
-    }
-
-    const value = encodeURIComponent(this.encode(data || ""));
-    document.cookie = encodeURIComponent(key) + "=" + value + expireStr;
-  };
-
-  del = (key) => this.set(key, "", { expires: -100 });
-
-  async *iterate(prefix = "") {
-    for (let [key, value] of Object.entries(this.#read())) {
-      if (!key.startsWith(prefix)) continue;
-      yield [key, value];
-    }
-  }
-}

package/src/clients/etcd.js

@@ -1,29 +0,0 @@
-import Client from "./Client.js";
-
-// Use a redis client to back up the store
-export default class Etcd extends Client {
-  // Check if this is the right class for the given client
-  static test = (client) => client?.constructor?.name === "Etcd3";
-
-  get = (key) => this.client.get(key).json();
-  set = (key, value) => this.client.put(key).value(this.encode(value));
-  del = (key) => this.client.delete().key(key).exec();
-
-  async *iterate(prefix = "") {
-    const keys = await this.client.getAll().prefix(prefix).keys();
-    for (const key of keys) {
-      yield [key, await this.get(key)];
-    }
-  }
-
-  keys = (prefix = "") => this.client.getAll().prefix(prefix).keys();
-  entries = async (prefix = "") => {
-    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]]);
-  };
-  clear = async (prefix = "") => {
-    if (!prefix) return this.client.delete().all();
-    return this.client.delete().prefix(prefix);
-  };
-}

package/src/clients/file.js

@@ -1,70 +0,0 @@
-import Client from "./Client.js";
-
-// A client that uses a single file (JSON) as a store
-export default class File extends Client {
-  // Check if this is the right class for the given client
-  static test = (client) => {
-    if (client instanceof URL) client = client.href;
-    return (
-      typeof client === "string" &&
-      client.startsWith("file://") &&
-      client.includes(".")
-    );
-  };
-
-  // 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
-  #promise = (async () => {
-    this.fsp = await import("node:fs/promises");
-    this.file = (this.client?.href || this.client).replace(/^file:\/\//, "");
-    const folder = this.file.split("/").slice(0, -1).join("/");
-    await this.fsp.mkdir(folder, { recursive: true }).catch(() => {});
-    await this.fsp.writeFile(this.file, "{}", { flag: "wx" }).catch(() => {});
-  })();
-
-  // Internal
-  #read = async () => {
-    const text = await this.fsp.readFile(this.file, "utf8");
-    return text ? JSON.parse(text) : {};
-  };
-
-  #write = async (data) => {
-    return this.fsp.writeFile(this.file, this.encode(data));
-  };
-
-  get = async (key) => {
-    const data = await this.#read();
-    return data[key] ?? null;
-  };
-
-  set = async (key, value) => {
-    const data = await this.#read();
-    if (value === null) {
-      delete data[key];
-    } else {
-      data[key] = value;
-    }
-    await this.#write(data);
-  };
-
-  async *iterate(prefix = "") {
-    const data = await this.#read();
-    const entries = Object.entries(data).filter((p) => p[0].startsWith(prefix));
-    for (const entry of entries) {
-      yield entry;
-    }
-  }
-
-  // Bulk updates are worth creating a custom method here
-  clearAll = () => this.#write({});
-  clear = async (prefix = "") => {
-    const data = await this.#read();
-    for (let key in data) {
-      if (key.startsWith(prefix)) {
-        delete data[key];
-      }
-    }
-    await this.#write(data);
-  };
-}

package/src/clients/folder.js

@@ -1,49 +0,0 @@
-import Client from "./Client.js";
-
-const noFileOk = (error) => {
-  if (error.code === "ENOENT") return null;
-  throw error;
-};
-
-// A client that uses a single file (JSON) as a store
-export default class Folder extends Client {
-  // Check if this is the right class for the given client
-  static test = (client) => {
-    if (client instanceof URL) client = client.href;
-    return (
-      typeof client === "string" &&
-      client.startsWith("file://") &&
-      client.endsWith("/")
-    );
-  };
-
-  // Make sure the folder already exists, so attempt to create it
-  // It fails if it already exists, hence the catch case
-  #promise = (async () => {
-    this.fsp = await import("node:fs/promises");
-    this.folder = (this.client?.href || this.client).replace(/^file:\/\//, "");
-    await this.fsp.mkdir(this.folder, { recursive: true }).catch(() => {});
-  })();
-
-  file = (key) => this.folder + key + ".json";
-
-  get = (key) => {
-    return this.fsp
-      .readFile(this.file(key), "utf8")
-      .then(this.decode, noFileOk);
-  };
-  set = (key, value) => {
-    return this.fsp.writeFile(this.file(key), this.encode(value), "utf8");
-  };
-  del = (key) => this.fsp.unlink(this.file(key)).catch(noFileOk);
-
-  async *iterate(prefix = "") {
-    const all = await this.fsp.readdir(this.folder);
-    const keys = all.filter((f) => f.startsWith(prefix) && f.endsWith(".json"));
-    for (const name of keys) {
-      const key = name.slice(0, -".json".length);
-      const data = await this.get(key);
-      yield [key, data];
-    }
-  }
-}

package/src/clients/forage.js

@@ -1,29 +0,0 @@
-import Client from "./Client.js";
-
-// Use localForage for managing the KV
-export default class Forage extends Client {
-  // Check if this is the right class for the given client
-  static test = (client) =>
-    client?.defineDriver && client?.dropInstance && client?.INDEXEDDB;
-
-  get = (key) => this.client.getItem(key);
-  set = (key, value) => this.client.setItem(key, value);
-  del = (key) => this.client.removeItem(key);
-
-  async *iterate(prefix = "") {
-    const keys = await this.client.keys();
-    const list = keys.filter((k) => k.startsWith(prefix));
-    for (const key of list) {
-      yield [key, await this.get(key)];
-    }
-  }
-
-  entries = async (prefix = "") => {
-    const all = await this.client.keys();
-    const keys = all.filter((k) => k.startsWith(prefix));
-    const values = await Promise.all(keys.map((key) => this.get(key)));
-    return keys.map((key, i) => [key, values[i]]);
-  };
-
-  clearAll = () => this.client.clear();
-}

package/src/clients/index.js

@@ -1,25 +0,0 @@
-import api from "./api.js";
-import cloudflare from "./cloudflare.js";
-import cookie from "./cookie.js";
-import etcd from "./etcd.js";
-import file from "./file.js";
-import folder from "./folder.js";
-import forage from "./forage.js";
-import level from "./level.js";
-import memory from "./memory.js";
-import redis from "./redis.js";
-import storage from "./storage.js";
-
-export default {
-  api,
-  cloudflare,
-  cookie,
-  etcd,
-  file,
-  folder,
-  forage,
-  level,
-  memory,
-  redis,
-  storage,
-};

package/src/clients/level.js

@@ -1,40 +0,0 @@
-import Client from "./Client.js";
-
-const valueEncoding = "json";
-const notFound = (error) => {
-  if (error?.code === "LEVEL_NOT_FOUND") return null;
-  throw error;
-};
-
-// Level KV DB - https://github.com/Level/level
-export default class Level extends Client {
-  // Check if this is the right class for the given client
-  static test = (client) => client?.constructor?.name === "ClassicLevel";
-
-  get = (key) => this.client.get(key, { valueEncoding }).catch(notFound);
-  set = (key, value) => this.client.put(key, value, { valueEncoding });
-  del = (key) => this.client.del(key);
-
-  async *iterate(prefix = "") {
-    const keys = await this.client.keys().all();
-    const list = keys.filter((k) => k.startsWith(prefix));
-    for (const key of list) {
-      yield [key, await this.get(key)];
-    }
-  }
-
-  entries = async (prefix = "") => {
-    const keys = await this.client.keys().all();
-    const list = keys.filter((k) => k.startsWith(prefix));
-    return Promise.all(list.map(async (k) => [k, await this.get(k)]));
-  };
-
-  clearAll = () => this.client.clear();
-  clear = async (prefix = "") => {
-    const keys = await this.client.keys().all();
-    const list = keys.filter((k) => k.startsWith(prefix));
-    return this.client.batch(list.map((key) => ({ type: "del", key })));
-  };
-
-  close = () => this.client.close();
-}

package/src/clients/memory.js

@@ -1,19 +0,0 @@
-import Client from "./Client.js";
-
-// Use a Map() as an in-memory client
-export default class Memory extends Client {
-  // Check if this is the right class for the given client
-  static test = (client) => client instanceof Map;
-
-  get = (key) => this.client.get(key) ?? null;
-  set = (key, data) => this.client.set(key, data);
-  del = (key) => this.client.delete(key);
-
-  *iterate(prefix = "") {
-    for (const entry of this.client.entries()) {
-      if (entry[0].startsWith(prefix)) yield entry;
-    }
-  }
-
-  clearAll = () => this.client.clear();
-}

package/src/clients/redis.js

@@ -1,51 +0,0 @@
-import Client from "./Client.js";
-
-// Use a redis client to back up the store
-export default class Redis extends Client {
-  // Indicate if this client handles expirations (true = it does)
-  EXPIRES = true;
-
-  // Check if this is the right class for the given client
-  static test = (client) => client && client.pSubscribe && client.sSubscribe;
-
-  get = async (key) => this.decode(await this.client.get(key));
-  set = async (key, value, { expires } = {}) => {
-    const EX = expires ? Math.round(expires) : undefined;
-    return this.client.set(key, this.encode(value), { EX });
-  };
-  del = (key) => this.client.del(key);
-
-  has = async (key) => Boolean(await this.client.exists(key));
-
-  // Go through each of the [key, value] in the set
-  async *iterate(prefix = "") {
-    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];
-    }
-  }
-
-  // Optimizing the retrieval of them by not getting their values
-  keys = async (prefix = "") => {
-    const MATCH = prefix + "*";
-    const keys = [];
-    for await (const key of this.client.scanIterator({ MATCH })) {
-      keys.push(key);
-    }
-    return keys;
-  };
-
-  // Optimizing the retrieval of them all in bulk by loading the values
-  // in parallel
-  entries = async (prefix = "") => {
-    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]]);
-  };
-
-  clearAll = () => this.client.flushAll();
-  close = () => this.client.quit();
-}

package/src/clients/storage.js

@@ -1,25 +0,0 @@
-import Client from "./Client.js";
-
-// A client that uses a single file (JSON) as a store
-export default class WebStorage extends Client {
-  // Check if this is the right class for the given client
-  static test(client) {
-    if (typeof Storage === "undefined") return false;
-    return client instanceof Storage;
-  }
-
-  // Item methods
-  get = (key) => this.decode(this.client[key]);
-  set = (key, data) => this.client.setItem(key, this.encode(data));
-  del = (key) => this.client.removeItem(key);
-
-  *iterate(prefix = "") {
-    for (const key of Object.keys(this.client)) {
-      if (!key.startsWith(prefix)) continue;
-      const value = this.get(key);
-      if (value) yield [key, value];
-    }
-  }
-
-  clearAll = () => this.client.clear();
-}

package/src/index.d.ts

@@ -1,209 +0,0 @@
-export type Options = { expires?: number | string | null };
-export type Value = string | { [key: string]: Value } | Value[];
-
-export interface Store {
-  /**
-   * 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)**
-   */
-  add: <T = Value>(value: T, options?: Options) => Promise<string>;
-
-  /**
-   * 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)**
-   */
-  set: <T = Value>(key: string, value: T, options?: Options) => Promise<string>;
-
-  /**
-   * 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)**
-   */
-  get: <T = Value>(key: string) => Promise<T | null>;
-
-  /**
-   * 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)**
-   */
-  has: (key: string) => Promise<boolean>;
-
-  /**
-   * 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)**
-   */
-  del: (key: string) => Promise<string>;
-
-  /**
-   * 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)**
-   */
-  entries: <T = Value>() => Promise<[key: string, value: T][]>;
-
-  /**
-   * 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)**
-   */
-  keys: () => Promise<string[]>;
-
-  /**
-   * 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)**
-   */
-  values: <T = Value>() => Promise<T[]>;
-
-  /**
-   * 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)**
-   */
-  all: <T = Value>() => Promise<{ [key: string]: T }>;
-
-  /**
-   * 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)**
-   */
-  clear: () => Promise<null>;
-
-  /**
-   * 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)**
-   */
-  prefix: (prefix: string) => Store;
-
-  /**
-   * 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)**
-   */
-  close?: () => Promise<null>;
-
-  /**
-   * An iterator that goes through all of the key:value pairs in the client
-   *
-   * ```js
-   * for await (const [key, value] of store) {
-   *   console.log(key, value);
-   * }
-   * ```
-   *
-   * **[→ Full Iterator Docs](https://polystore.dev/documentation#iterator)**
-   */
-  [Symbol.asyncIterator]: () => {
-    next: () => Promise<{ value: [string, Value] }>;
-  };
-}
-
-/**
- * Create a Store instance with the given client:
- *
- * ```js
- * import kv from "polystore";
- * const store1 = kv(new Map());
- * const store2 = kv(localStorage);
- * const store3 = kv(redisClient);
- * const store4 = kv(yourOwnStore);
- * ```
- *
- * **[→ Full kv() Docs](https://polystore.dev/documentation)**
- */
-export default function (client?: any): Store;