presidium-db-client-server 0.0.0-stage → 0.1.0

package/TextStream.js

@@ -0,0 +1,55 @@
+/**
+ * Presidium DB Client and Server may be freely distributed under the CFOSS license.
+ */
+
+const EventEmitter = require("events")
+
+/**
+ * @name TextStream
+ *
+ * @docs
+ * ```coffeescript [specscript]
+ * module stream 'https://nodejs.org/docs/latest-v26.x/api/stream.html'
+ * module events 'https://nodejs.org/docs/latest-v26.x/api/events.html'
+ *
+ * TextStream(readable stream.Readable, delimiter string) -> textStream events.EventEmitter
+ *
+ * textStream.on("data", (text string, encoding string) -> ())
+ *
+ * textStream.on("end", () -> ())
+ * ```
+ */
+class TextStream extends EventEmitter {
+  constructor(readable, delimiter, encoding) {
+    super()
+
+    delimiter ??= ""
+    encoding ??= "utf8"
+
+    let s = ""
+    readable.on('data', (chunk, encoding) => {
+      if (typeof chunk == 'string') {
+        s += Buffer.from(chunk, encoding).toString(encoding)
+      } else {
+        s += chunk.toString(encoding)
+      }
+
+      let delimiterIndex = s.indexOf(delimiter)
+      while (delimiterIndex > -1) {
+        const text = s.slice(0, delimiterIndex)
+        this.emit("data", text, encoding)
+        s = s.slice(delimiterIndex + 1)
+        delimiterIndex = s.indexOf(delimiter)
+      }
+    })
+
+    readable.on('end', () => {
+      if (s.length > 0) {
+        this.emit("data", s, encoding)
+      }
+      this.emit("end")
+    })
+  }
+}
+
+module.exports = TextStream

package/buffersToEntry.js

@@ -0,0 +1,44 @@
+/**
+ * Presidium DB Client and Server may be freely distributed under the CFOSS license.
+ */
+
+/**
+ * @name buffersToEntry
+ *
+ * @docs
+ * ```specscript
+ * buffersToEntry(
+ *   buffers Array<Buffer>,
+ *   entryLength number,
+ *   encoding string,
+ *   valueType string,
+ * ) -> Array<string, Buffer>
+ *
+ * buffersToEntry(
+ *   buffers Array<Buffer>,
+ *   entryLength number,
+ *   encoding string,
+ *   valueType string,
+ *   sortValueType string
+ * ) -> Array<string, Buffer>
+ * ```
+ */
+function buffersToEntry(buffers, entryLength, encoding, valueType, sortValueType) {
+  if (entryLength == 3) {
+    const key = buffers[0].toString(encoding)
+    const value = valueType == "string"
+      ? buffers[1].toString(encoding)
+      : buffers[1]
+    const sortValue = sortValueType == "number"
+      ? Number(buffers[2].toString(encoding))
+      : buffers[2].toString(encoding)
+    return [key, value, sortValue]
+  }
+  const key = buffers[0].toString(encoding)
+  const value = valueType == "string"
+    ? buffers[1].toString(encoding)
+    : buffers[1]
+  return [key, value]
+}
+
+module.exports = buffersToEntry

package/handleServerResponse.js

@@ -0,0 +1,72 @@
+/**
+ * Presidium DB Client and Server may be freely distributed under the CFOSS license.
+ */
+
+const Readable = require("presidium/Readable")
+const TextStream = require("./TextStream")
+const BinaryStream = require("./BinaryStream")
+const TextEntriesStream = require("./TextEntriesStream")
+const BinaryEntriesStream = require("./BinaryEntriesStream")
+const AsyncIterator = require("./AsyncIterator")
+
+/**
+ * @name handleServerResponse
+ *
+ * @docs
+ * ```specscript
+ * module http 'https://nodejs.org/docs/latest-v26.x/api/http.html'
+ * module events 'https://nodejs.org/docs/latest-v26.x/api/events.html'
+ *
+ * handleServerResponse(response http.ServerResponse, options {
+ *   textStream: boolean,
+ *   binaryStream: boolean,
+ *   textEntriesStream: boolean,
+ *   binaryEntriesStream: boolean,
+ *   delimiter: string,
+ *   entryLength: number,
+ * }) -> data object|events.EventEmitter
+ * ```
+ */
+async function handleServerResponse(response, options = {}) {
+  const {
+    textStream,
+    binaryStream,
+    textEntriesStream,
+    binaryEntriesStream,
+    delimiter = "",
+    entryLength,
+  } = options
+
+  const encoding = response.headers["content-encoding"] ?? "utf8"
+
+  if (response.ok) {
+    if (textStream) {
+      const stream = new TextStream(response, delimiter, encoding)
+      return AsyncIterator.fromEvents(stream)
+    }
+    if (binaryStream) {
+      const stream = new BinaryStream(response, delimiter)
+      return AsyncIterator.fromEvents(stream)
+    }
+    if (textEntriesStream) {
+      const stream = new TextEntriesStream(response, entryLength, delimiter, encoding)
+      return AsyncIterator.fromEvents(stream, "entry")
+    }
+    if (binaryEntriesStream) {
+      const stream = new BinaryEntriesStream(response, entryLength, delimiter, encoding)
+      return AsyncIterator.fromEvents(stream, "entry")
+    }
+    if (response.headers["content-type"] == "application/json") {
+      return Readable.JSON(response)
+    }
+    if (response.headers["content-type"] == "application/octet-stream") {
+      return Readable.Buffer(response)
+    }
+    return Readable.Text(response)
+  }
+  const message = await Readable.Text(response)
+  const error = new Error(message)
+  throw error
+}
+
+module.exports = handleServerResponse

package/package.json

@@ -1,6 +1,47 @@
 {
   "name": "presidium-db-client-server",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Presidium DB client and server library",
+  "author": "Richard Tong",
+  "license": "CFOSS",
+  "repository": {
+    "type": "git",
+    "url": "github:richytong/presidium-db-client-server"
+  },
+  "homepage": "https://github.com/richytong/presidium-db-client-server",
+  "files": [
+    "ArrayEventEmitter.js",
+    "AsyncIterator.js",
+    "BinaryEntriesStream.js",
+    "BinaryStream.js",
+    "DatabaseHandler.js",
+    "DatabaseServer.js",
+    "DiskHashTableClient.js",
+    "DiskSortedHashTableClient.js",
+    "TextEntriesStream.js",
+    "TextStream.js",
+    "buffersToEntry.js",
+    "handleServerResponse.js"
+  ],
+  "keywords": [
+    "presidium",
+    "db",
+    "database",
+    "client",
+    "server",
+    "key-value",
+    "node",
+    "nodejs",
+    "javascript"
+  ],
+  "scripts": {
+    "test": "node test.js"
+  },
+  "dependencies": {
+    "presidium": "^4.5.0",
+    "rubico": "^2.20.0"
+  },
+  "devDependencies": {
+    "codecov": "^3.8.2"
+  }
+}