polystore 0.15.12 → 0.16.0

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;

package/src/index.js

@@ -1,278 +0,0 @@
-import clients from "./clients/index.js";
-import { createId, parse, unix } from "./utils.js";
-
-class Store {
-  PREFIX = "";
-
-  constructor(clientPromise) {
-    this.promise = Promise.resolve(clientPromise).then(async (client) => {
-      this.client = this.#find(client);
-      this.#validate(this.client);
-      this.promise = null;
-      await this.client.promise;
-      return client;
-    });
-  }
-
-  #find(store) {
-    // Already a fully compliant KV store
-    if (store instanceof Store) return store.client;
-
-    // One of the supported ones, so we receive an instance and
-    // wrap it with the client wrapper
-    for (let client of Object.values(clients)) {
-      if (client.test && client.test(store)) {
-        return new client(store);
-      }
-    }
-
-    // We get passed a class
-    if (
-      typeof store === "function" &&
-      /^class\s/.test(Function.prototype.toString.call(store))
-    ) {
-      return new store();
-    }
-
-    // A raw one, we just receive the single instance to use directly
-    return store;
-  }
-
-  #validate(client) {
-    if (!client) throw new Error("No client received");
-    if (!client.set || !client.get || !client.iterate) {
-      throw new Error("Client should have .get(), .set() and .iterate()");
-    }
-
-    if (!client.EXPIRES) {
-      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.`,
-          );
-        }
-      }
-    }
-  }
-
-  // Check if the given data is fresh or not; if
-  #isFresh(data, key) {
-    // Should never happen, but COULD happen; schedule it for
-    // removal and mark it as stale
-    if (!data || !data.value || typeof data !== "object") {
-      if (key) this.del(key);
-      return false;
-    }
-
-    // It never expires, so keep it
-    if (data.expires === null) return true;
-
-    // It's fresh, keep it
-    if (data.expires > Date.now()) return true;
-
-    // It's expired, remove it
-    if (key) this.del(key);
-    return false;
-  }
-
-  async add(value, options = {}) {
-    await this.promise;
-    let expires = parse(options.expire ?? options.expires);
-
-    // Use the underlying one from the client if found
-    if (this.client.add) {
-      if (this.client.EXPIRES) {
-        return await this.client.add(this.PREFIX, value, { expires });
-      }
-
-      // In the data we need the timestamp since we need it "absolute":
-      expires = unix(expires);
-      const key = await this.client.add(this.PREFIX, { expires, value });
-      return key;
-    }
-
-    const key = createId();
-    return this.set(key, value, { expires });
-  }
-
-  async set(key, value, options = {}) {
-    await this.promise;
-    const id = this.PREFIX + key;
-    let expires = parse(options.expire ?? options.expires);
-
-    // Quick delete
-    if (value === null || (typeof expires === "number" && expires <= 0)) {
-      return this.del(id);
-    }
-
-    // The client manages the expiration, so let it manage it
-    if (this.client.EXPIRES) {
-      await this.client.set(id, value, { expires });
-      return key;
-    }
-
-    // In the data we need the timestamp since we need it "absolute":
-    expires = unix(expires);
-    await this.client.set(id, { expires, value });
-    return key;
-  }
-
-  async get(key) {
-    await this.promise;
-    const id = this.PREFIX + key;
-
-    const data = (await this.client.get(id)) ?? null;
-
-    // No value; nothing to do/check
-    if (data === null) return null;
-
-    // The client already managed expiration and there's STILL some data,
-    // so we can assume it's the raw user data
-    if (this.client.EXPIRES) return data;
-
-    if (!this.#isFresh(data, key)) return null;
-    return data.value;
-  }
-
-  async has(key) {
-    await this.promise;
-    const id = this.PREFIX + key;
-
-    if (this.client.has) {
-      return this.client.has(id);
-    }
-
-    return (await this.get(key)) !== null;
-  }
-
-  async del(key) {
-    await this.promise;
-    const id = this.PREFIX + key;
-
-    if (this.client.del) {
-      await this.client.del(id);
-      return key;
-    }
-
-    await this.client.set(id, null, { expires: 0 });
-    return key;
-  }
-
-  async *[Symbol.asyncIterator]() {
-    await this.promise;
-
-    for await (const [name, data] of this.client.iterate(this.PREFIX)) {
-      const key = name.slice(this.PREFIX.length);
-      if (this.client.EXPIRES) {
-        yield [key, data];
-      } else if (this.#isFresh(data, key)) {
-        yield [key, data.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) {
-      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([trim(key), value]);
-      }
-    }
-
-    // The client already manages the expiration, so we can assume
-    // that at this point, all entries are not-expired
-    if (this.client.EXPIRES) return list;
-
-    // We need to do manual expiration checking
-    return list
-      .filter(([key, data]) => this.#isFresh(data, key))
-      .map(([key, data]) => [key, data.value]);
-  }
-
-  async keys() {
-    await this.promise;
-
-    if (this.client.keys) {
-      const list = await this.client.keys(this.PREFIX);
-      if (!this.PREFIX) return list;
-      return list.map((k) => k.slice(this.PREFIX.length));
-    }
-
-    const entries = await this.entries();
-    return entries.map((e) => e[0]);
-  }
-
-  async values() {
-    await this.promise;
-
-    if (this.client.values) {
-      const list = this.client.values(this.PREFIX);
-      if (this.client.EXPIRES) return list;
-      return list
-        .filter((data) => this.#isFresh(data))
-        .map((data) => data.value);
-    }
-
-    const entries = await this.entries();
-    return entries.map((e) => e[1]);
-  }
-
-  async all() {
-    await this.promise;
-
-    if (this.client.all) {
-      const obj = await this.client.all(this.PREFIX);
-      if (!this.PREFIX) return obj;
-      const all = {};
-      for (let key in obj) {
-        all[key.slice(this.PREFIX.length)] = obj[key];
-      }
-      return all;
-    }
-
-    const entries = await this.entries();
-    return Object.fromEntries(entries);
-  }
-
-  async clear() {
-    await this.promise;
-
-    if (!this.PREFIX && this.client.clearAll) {
-      return this.client.clearAll();
-    }
-
-    if (this.client.clear) {
-      return this.client.clear(this.PREFIX);
-    }
-
-    const keys = await this.keys();
-    // Note: this gives trouble of concurrent deletes in the FS
-    await Promise.all(keys.map((key) => this.del(key)));
-  }
-
-  prefix(prefix = "") {
-    const store = new Store(
-      Promise.resolve(this.promise).then(() => this.client),
-    );
-    store.PREFIX = this.PREFIX + prefix;
-    return store;
-  }
-
-  async close() {
-    await this.promise;
-
-    if (this.client.close) {
-      return this.client.close();
-    }
-  }
-}
-
-export default (client) => new Store(client);

package/src/server.js

@@ -1,81 +0,0 @@
-// This is an example server implementation of the HTTP library!
-import http from "node:http";
-import kv from "./index.js";
-
-// Add/remove the key whether you want the API to be behind a key
-const key = null;
-// const key = 'MY-SECRET-KEY';
-
-// Modify this to use any sub-store as desired. It's nice
-// to use polystore itself for the polystore server library!'
-const store = kv(new Map());
-
-// Some reply helpers
-const notFound = () => new Response(null, { status: 404 });
-const sendJson = (data, status = 200) => {
-  const body = JSON.stringify(data);
-  const headers = { "content-type": "application/json" };
-  return new Response(body, { status, headers });
-};
-
-async function fetch({ method, url, body }) {
-  method = method.toLowerCase();
-  url = new URL(url);
-  let [, id] = url.pathname.split("/");
-  id = decodeURIComponent(id);
-  const expires = Number(url.searchParams.get("expires")) || null;
-  const prefix = url.searchParams.get("prefix") || null;
-
-  let local = store;
-  if (prefix) local = store.prefix(prefix);
-
-  if (method === "get") {
-    if (id === "ping") return new Response(null, { status: 200 });
-    if (!id) return sendJson(await local.all());
-    const data = await local.get(id);
-    if (data === null) return notFound();
-    return sendJson(data);
-  }
-
-  if (method === "put") {
-    if (!id) return notFound();
-    const data = await new Response(body).json();
-    if (!data) return notFound();
-    await local.set(id, data, { expires });
-    return sendJson(id);
-  }
-
-  if (method === "delete" && id) {
-    await local.del(id);
-    return sendJson(id);
-  }
-
-  return notFound();
-}
-
-// http or express server-like handler:
-async function server(req, res) {
-  // Secure it behind a key (optional)
-  if (key && req.headers.get("x-api-key") !== key) return res.send(401);
-
-  const url = new URL(req.url, "http://localhost:3000/").href;
-  const reply = await fetch({ ...req, url });
-  res.writeHead(reply.status, null, reply.headers || {});
-  if (reply.body) res.write(reply.body);
-  res.end();
-}
-
-function start(port = 3000) {
-  return new Promise((resolve, reject) => {
-    const server = http.createServer(server);
-    server.on("clientError", (error, socket) => {
-      reject(error);
-      socket.end("HTTP/1.1 400 Bad Request\r\n\r\n");
-    });
-    server.listen(port, resolve);
-    return () => server.close();
-  });
-}
-
-export { fetch, server, start };
-export default { fetch, server, start };

package/src/utils.js

@@ -1,47 +0,0 @@
-const times = /(-?(?:\d+\.?\d*|\d*\.?\d+)(?:e[-+]?\d+)?)\s*([\p{L}]*)/iu;
-
-parse.millisecond = parse.ms = 0.001;
-parse.second = parse.sec = parse.s = parse[""] = 1;
-parse.minute = parse.min = parse.m = parse.s * 60;
-parse.hour = parse.hr = parse.h = parse.m * 60;
-parse.day = parse.d = parse.h * 24;
-parse.week = parse.wk = parse.w = parse.d * 7;
-parse.year = parse.yr = parse.y = parse.d * 365.25;
-parse.month = parse.b = parse.y / 12;
-
-// Returns the time in seconds
-export function parse(str) {
-  if (str === null || str === undefined) return null;
-  if (typeof str === "number") return str;
-  // ignore commas/placeholders
-  str = str.toLowerCase().replace(/[,_]/g, "");
-  let [_, value, units] = times.exec(str) || [];
-  if (!units) return null;
-  const unitValue = parse[units] || parse[units.replace(/s$/, "")];
-  if (!unitValue) return null;
-  const result = unitValue * parseFloat(value, 10);
-  return Math.abs(Math.round(result * 1000) / 1000);
-}
-
-// "nanoid" imported manually
-// Something about improved GZIP performance with this string
-const urlAlphabet =
-  "useandom26T198340PX75pxJACKVERYMINDBUSHWOLFGQZbfghjklqvwyzrict";
-
-export function createId() {
-  let size = 24;
-  let id = "";
-  let bytes = crypto.getRandomValues(new Uint8Array(size));
-  while (size--) {
-    // Using the bitwise AND operator to "cap" the value of
-    // the random byte from 255 to 63, in that way we can make sure
-    // that the value will be a valid index for the "chars" string.
-    id += urlAlphabet[bytes[size] & 61];
-  }
-  return id;
-}
-
-export function unix(expires) {
-  const now = new Date().getTime();
-  return expires === null ? null : now + expires * 1000;
-}