polystore 0.15.10 → 0.15.12

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "polystore",
-  "version": "0.15.10",
+  "version": "0.15.12",
   "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

@@ -36,8 +36,8 @@ Available clients for the KV store:
 - [**Cookies** `"cookie"`](#cookies) (fe): persist the data using cookies
 - [**LocalForage** `localForage`](#local-forage) (fe): persist the data on IndexedDB
 - [**Fetch API** `"https://..."`](#fetch-api) (fe+be): call an API to save/retrieve the data
-- [**File** `new URL('file:///...')`](#file) (be): store the data in a single JSON file in your FS
-- [**Folder** `new URL('file:///...')`](#folder) (be): store each key in a folder as json files
+- [**File** `"file:///[...].json"`](#file) (be): store the data in a single JSON file in your FS
+- [**Folder** `"file:///[...]/"`](#folder) (be): store each key in a folder as json files
 - [**Redis Client** `redisClient`](#redis-client) (be): use the Redis instance that you connect to
 - [**Cloudflare KV** `env.KV_NAMESPACE`](#cloudflare-kv) (be): use Cloudflare's KV store
 - [**Level** `new Level('example', { valueEncoding: 'json' })`](#level) (fe+be): support the whole Level ecosystem
@@ -646,7 +646,7 @@ console.log(await store.get("key1"));
 
 > Note: the API client expire resolution is in the seconds, so times shorter than 1 second like `expires: 0.02` (20 ms) don't make sense for this storage method and won't properly save them.
 
-> Note: see the reference implementation in src/server.js
+> Note: see the [reference implementation in src/server.js](https://github.com/franciscop/polystore/blob/master/src/server.js)
 
 
 ### File

package/src/index.d.ts

@@ -193,4 +193,17 @@ export interface Store {
   };
 }
 
-export default function (store?: any): Store;
+/**
+ * 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/server.js

@@ -2,6 +2,10 @@
 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());
@@ -51,6 +55,9 @@ async function fetch({ method, url, body }) {
 
 // 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 || {});