@graffy/server 0.15.16 → 0.15.19-alpha.1

package/Readme.md

@@ -4,4 +4,4 @@ Node.js library for building an API for a Graffy store.
 
 This creates an HTTP request handler for serving an API that is compatible with Graffy Client. The request handler can be used with the Node.js built-in http, https and http2 `createServer()` and with Express.js.
 
-See [Graffy documentation](https://aravindet.github.io/graffy/#/GraffyServer) for more.
+See [Graffy documentation](https://graffy.org#/GraffyServer) for more.

package/index.cjs

@@ -23,22 +23,21 @@ exports[Symbol.toStringTag] = "Module";
 var url = require("url");
 var common = require("@graffy/common");
 var debug = require("debug");
-var WebSocket = require("ws");
+var ws = require("ws");
 function _interopDefaultLegacy(e) {
   return e && typeof e === "object" && "default" in e ? e : { "default": e };
 }
 var url__default = /* @__PURE__ */ _interopDefaultLegacy(url);
 var debug__default = /* @__PURE__ */ _interopDefaultLegacy(debug);
-var WebSocket__default = /* @__PURE__ */ _interopDefaultLegacy(WebSocket);
 const log$1 = debug__default["default"]("graffy:server:http");
-function server$1(store) {
+function server$1(store, { auth } = {}) {
   if (!store)
     throw new Error("server.store_undef");
   return async (req, res) => {
     const parsed = url__default["default"].parse(req.url, true);
-    const query = parsed.query.q && common.decodeUrl(parsed.query.q);
     const options = parsed.query.opts && !Array.isArray(parsed.query.opts) && common.deserialize(decodeURIComponent(parsed.query.opts));
     if (req.method === "GET") {
+      const query = parsed.query.q && common.decodeUrl(parsed.query.q);
       try {
         if (req.headers["accept"] === "text/event-stream") {
           res.setHeader("content-type", "text/event-stream");
@@ -79,7 +78,7 @@ data: ${e.message}
       }
     } else if (req.method === "POST") {
       try {
-        const op = req.query.op;
+        const op = parsed.query.op;
         if (op !== "write" && op !== "read") {
           throw Error("httpServer.unsupported_op: " + op);
         }
@@ -87,6 +86,11 @@ data: ${e.message}
         for await (const chunk of req)
           chunks.push(chunk);
         const payload = common.deserialize(Buffer.concat(chunks).toString());
+        if (auth && !await auth(op, payload, options)) {
+          res.writeHead(401);
+          res.end("unauthorized");
+          return;
+        }
         const value = await store.call(op, payload, options);
         res.writeHead(200);
         res.end(common.serialize(value));
@@ -107,14 +111,14 @@ const PING_INTERVAL = 3e4;
 function server(store) {
   if (!store)
     throw new Error("server.store_undef");
-  const wss = new WebSocket__default["default"].Server({ noServer: true });
-  wss.on("connection", function connection(ws) {
-    ws.graffyStreams = {};
-    ws.on("message", async function message(msg) {
+  const wss = new ws.WebSocketServer({ noServer: true });
+  wss.on("connection", function connection(ws2) {
+    ws2.graffyStreams = {};
+    ws2.on("message", async function message(msg) {
       try {
         const [id, op, payload, options] = common.deserialize(msg);
         if (id === ":pong") {
-          ws.pingPending = false;
+          ws2.pingPending = false;
           return;
         }
         switch (op) {
@@ -122,10 +126,10 @@ function server(store) {
           case "write":
             try {
               const result = await store.call(op, payload, options);
-              ws.send(common.serialize([id, null, result]));
+              ws2.send(common.serialize([id, null, result]));
             } catch (e) {
               log(op + "error:" + e.message + " " + payload);
-              ws.send(common.serialize([id, e.message]));
+              ws2.send(common.serialize([id, e.message]));
             }
             break;
           case "watch":
@@ -133,44 +137,44 @@ function server(store) {
               const stream = store.call("watch", payload, __spreadProps(__spreadValues({}, options), {
                 raw: true
               }));
-              ws.graffyStreams[id] = stream;
+              ws2.graffyStreams[id] = stream;
               for await (const value of stream) {
-                ws.send(common.serialize([id, null, value]));
+                ws2.send(common.serialize([id, null, value]));
               }
             } catch (e) {
               log(op + "error:" + e.message + " " + payload);
-              ws.send(common.serialize([id, e.message]));
+              ws2.send(common.serialize([id, e.message]));
             }
             break;
           case "unwatch":
-            if (!ws.graffyStreams[id])
+            if (!ws2.graffyStreams[id])
               break;
-            ws.graffyStreams[id].return();
-            delete ws.graffyStreams[id];
+            ws2.graffyStreams[id].return();
+            delete ws2.graffyStreams[id];
             break;
         }
       } catch (_) {
-        ws.close();
+        ws2.close();
       }
     });
-    ws.on("close", () => {
-      for (const id in ws.graffyStreams) {
-        ws.graffyStreams[id].return();
-        delete ws.graffyStreams[id];
+    ws2.on("close", () => {
+      for (const id in ws2.graffyStreams) {
+        ws2.graffyStreams[id].return();
+        delete ws2.graffyStreams[id];
       }
     });
   });
   setInterval(function ping() {
-    wss.clients.forEach(function each(ws) {
-      if (ws.pingPending)
-        return ws.terminate();
-      ws.pingPending = true;
-      ws.send(common.serialize([":ping", Date.now()]));
+    wss.clients.forEach(function each(ws2) {
+      if (ws2.pingPending)
+        return ws2.terminate();
+      ws2.pingPending = true;
+      ws2.send(common.serialize([":ping", Date.now()]));
     });
   }, PING_INTERVAL);
   return async (request, socket, head) => {
-    wss.handleUpgrade(request, socket, head, function done(ws) {
-      wss.emit("connection", ws, request);
+    wss.handleUpgrade(request, socket, head, function done(ws2) {
+      wss.emit("connection", ws2, request);
     });
   };
 }

package/index.mjs

@@ -18,18 +18,18 @@ var __spreadValues = (a, b) => {
 };
 var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
 import url from "url";
-import { decodeUrl, deserialize, serialize } from "@graffy/common";
+import { deserialize, decodeUrl, serialize } from "@graffy/common";
 import debug from "debug";
-import WebSocket from "ws";
+import { WebSocketServer } from "ws";
 const log$1 = debug("graffy:server:http");
-function server$1(store) {
+function server$1(store, { auth } = {}) {
   if (!store)
     throw new Error("server.store_undef");
   return async (req, res) => {
     const parsed = url.parse(req.url, true);
-    const query = parsed.query.q && decodeUrl(parsed.query.q);
     const options = parsed.query.opts && !Array.isArray(parsed.query.opts) && deserialize(decodeURIComponent(parsed.query.opts));
     if (req.method === "GET") {
+      const query = parsed.query.q && decodeUrl(parsed.query.q);
       try {
         if (req.headers["accept"] === "text/event-stream") {
           res.setHeader("content-type", "text/event-stream");
@@ -70,7 +70,7 @@ data: ${e.message}
       }
     } else if (req.method === "POST") {
       try {
-        const op = req.query.op;
+        const op = parsed.query.op;
         if (op !== "write" && op !== "read") {
           throw Error("httpServer.unsupported_op: " + op);
         }
@@ -78,6 +78,11 @@ data: ${e.message}
         for await (const chunk of req)
           chunks.push(chunk);
         const payload = deserialize(Buffer.concat(chunks).toString());
+        if (auth && !await auth(op, payload, options)) {
+          res.writeHead(401);
+          res.end("unauthorized");
+          return;
+        }
         const value = await store.call(op, payload, options);
         res.writeHead(200);
         res.end(serialize(value));
@@ -98,7 +103,7 @@ const PING_INTERVAL = 3e4;
 function server(store) {
   if (!store)
     throw new Error("server.store_undef");
-  const wss = new WebSocket.Server({ noServer: true });
+  const wss = new WebSocketServer({ noServer: true });
   wss.on("connection", function connection(ws) {
     ws.graffyStreams = {};
     ws.on("message", async function message(msg) {

package/package.json

@@ -2,7 +2,7 @@
   "name": "@graffy/server",
   "description": "Node.js library for building an API for a Graffy store.",
   "author": "aravind (https://github.com/aravindet)",
-  "version": "0.15.16",
+  "version": "0.15.19-alpha.1",
   "main": "./index.cjs",
   "exports": {
     "import": "./index.mjs",
@@ -16,8 +16,8 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@graffy/common": "0.15.16",
-    "debug": "^4.3.2",
-    "ws": "^7.0.0"
+    "@graffy/common": "0.15.19-alpha.1",
+    "debug": "^4.3.3",
+    "ws": "^8.4.2"
   }
 }

package/types/httpServer.d.ts

@@ -1 +1,12 @@
-export default function server(store: any): (req: any, res: any) => Promise<void>;
+/**
+ * @typedef {import('@graffy/core').default} GraffyStore
+ * @param {GraffyStore} store
+ * @param {{
+ *   auth?: (operation: string, payload: any, options: any) => Promise<boolean>
+ * } | undefined} options
+ * @returns
+ */
+export default function server(store: any, { auth }?: {
+    auth?: (operation: string, payload: any, options: any) => Promise<boolean>;
+}): (req: any, res: any) => Promise<void>;
+export type GraffyStore = any;