@blamejs/core 0.5.8 → 0.5.10

package/CHANGELOG.md

@@ -8,6 +8,8 @@ upgrading across more than a few patches at a time.
 
 ## v0.5.x
 
+- **0.5.9** (2026-04-30) — b.csv: RFC 4180 parser + serializer
+- **0.5.8** (2026-04-30) — b.uuid: RFC 4122 v4 + RFC 9562 v7
 - **0.5.7** (2026-04-30) — defensive validation + queue closure capture + audit context
 - **0.5.6** (2026-04-30) — break-glass: trustProxy honored, cache require hoisted
 - **0.5.5** (2026-04-30) — strict default CSP + IPv6 special-range expansion

package/index.js

@@ -106,6 +106,7 @@ var forms = require("./lib/forms");
 var app = require("./lib/app");
 var jobs = require("./lib/jobs");
 var breakGlass = require("./lib/break-glass");
+var csv = require("./lib/csv");
 var uuid = require("./lib/uuid");
 var mail = require("./lib/mail");
 var mailBounce = require("./lib/mail-bounce");
@@ -209,6 +210,7 @@ module.exports = {
   createApp:        app.createApp,
   jobs:             jobs,
   breakGlass:       breakGlass,
+  csv:              csv,
   uuid:             uuid,
   mail:             mail,
   mailBounce:       mailBounce,

package/lib/csv.js

@@ -0,0 +1,229 @@
+"use strict";
+/**
+ * csv — RFC 4180 parser + serializer.
+ *
+ * Public API:
+ *
+ *   b.csv.parse(text, opts?)        → { headers, rows }  (or { rows } if no header)
+ *   b.csv.stringify(rows, opts?)    → string
+ *
+ * Opts (parse):
+ *   delimiter:    ","   default
+ *   header:       true  default — first row becomes column names; rows
+ *                       are objects keyed by header
+ *   maxBytes:     8 MiB default — refuses parse-bombs the same way
+ *                       safeJson does
+ *   onBadRow:     "throw" default | "skip" — what to do when a row has
+ *                       a different column count than the header
+ *
+ * Opts (stringify):
+ *   delimiter:    ","   default
+ *   header:       true  default — emit a header row from object keys
+ *   columns:      array of explicit column order (default: first row's keys)
+ *   eol:          "\r\n" default — RFC 4180 mandates CRLF; some parsers
+ *                       want LF. Operators choose.
+ *
+ * Format support:
+ *   - Quoted fields with embedded commas, quotes ("" → "), newlines.
+ *   - Optional BOM at file start (consumed silently if present).
+ *   - Trailing newline tolerated (RFC 4180 says SHOULD; we tolerate).
+ *
+ * Throws CsvError (FrameworkError) on shape violations.
+ */
+var C = require("./constants");
+var { defineClass } = require("./framework-error");
+
+var CsvError = defineClass("CsvError", { alwaysPermanent: true });
+
+var DEFAULT_MAX_BYTES = C.BYTES.mib(8);
+var DEFAULT_DELIMITER = ",";
+var DEFAULT_EOL       = "\r\n";
+
+// ---- parse ----
+
+function parse(text, opts) {
+  opts = opts || {};
+  if (typeof text !== "string" && !Buffer.isBuffer(text)) {
+    throw new CsvError("csv/bad-input",
+      "parse: input must be a string or Buffer, got " + typeof text);
+  }
+  var s = Buffer.isBuffer(text) ? text.toString("utf8") : text;
+  var maxBytes = opts.maxBytes != null ? opts.maxBytes : DEFAULT_MAX_BYTES;
+  if (Buffer.byteLength(s, "utf8") > maxBytes) {
+    throw new CsvError("csv/too-large",
+      "parse: input exceeds maxBytes (" + maxBytes + ")");
+  }
+  var delimiter = opts.delimiter || DEFAULT_DELIMITER;
+  if (typeof delimiter !== "string" || delimiter.length !== 1) {
+    throw new CsvError("csv/bad-delimiter",
+      "parse: delimiter must be a single character, got " + JSON.stringify(delimiter));
+  }
+  if (delimiter === "\"" || delimiter === "\r" || delimiter === "\n") {
+    throw new CsvError("csv/bad-delimiter",
+      "parse: delimiter cannot be quote / CR / LF");
+  }
+  var hasHeader = opts.header !== false;
+  var onBadRow = opts.onBadRow || "throw";
+  if (onBadRow !== "throw" && onBadRow !== "skip") {
+    throw new CsvError("csv/bad-opt",
+      "parse: onBadRow must be 'throw' or 'skip'");
+  }
+
+  // Strip BOM if present.
+  if (s.charCodeAt(0) === 0xfeff) s = s.slice(1);
+
+  var rows = [];
+  var field = "";
+  var row = [];
+  var inQuotes = false;
+  var i = 0;
+  var len = s.length;
+  while (i < len) {
+    var c = s.charAt(i);
+    if (inQuotes) {
+      if (c === "\"") {
+        if (i + 1 < len && s.charAt(i + 1) === "\"") {
+          field += "\"";    // escaped quote
+          i += 2;
+          continue;
+        }
+        inQuotes = false;
+        i++;
+        continue;
+      }
+      field += c;
+      i++;
+      continue;
+    }
+    if (c === "\"") {
+      // Quote at the start of a field (or anywhere — treat as start of
+      // quoted run). RFC 4180 says quoted fields begin with a quote;
+      // fields that contain a quote not at the start are technically
+      // malformed but we tolerate by appending literally.
+      if (field.length === 0) {
+        inQuotes = true;
+        i++;
+        continue;
+      }
+      field += "\"";
+      i++;
+      continue;
+    }
+    if (c === delimiter) {
+      row.push(field);
+      field = "";
+      i++;
+      continue;
+    }
+    if (c === "\r") {
+      // CRLF or bare CR — treat both as row terminator.
+      row.push(field);
+      rows.push(row);
+      field = "";
+      row = [];
+      if (i + 1 < len && s.charAt(i + 1) === "\n") i += 2;
+      else i++;
+      continue;
+    }
+    if (c === "\n") {
+      row.push(field);
+      rows.push(row);
+      field = "";
+      row = [];
+      i++;
+      continue;
+    }
+    field += c;
+    i++;
+  }
+  // Flush any trailing field/row (no trailing newline case)
+  if (field.length > 0 || row.length > 0) {
+    row.push(field);
+    rows.push(row);
+  }
+
+  if (!hasHeader) {
+    return { rows: rows };
+  }
+  if (rows.length === 0) {
+    return { headers: [], rows: [] };
+  }
+  var headers = rows[0];
+  var out = [];
+  for (var r = 1; r < rows.length; r++) {
+    var current = rows[r];
+    if (current.length === 1 && current[0] === "") continue;   // skip blank lines
+    if (current.length !== headers.length) {
+      if (onBadRow === "skip") continue;
+      throw new CsvError("csv/row-length-mismatch",
+        "parse: row " + r + " has " + current.length + " columns, expected " + headers.length);
+    }
+    var obj = {};
+    for (var k = 0; k < headers.length; k++) obj[headers[k]] = current[k];
+    out.push(obj);
+  }
+  return { headers: headers, rows: out };
+}
+
+// ---- stringify ----
+
+function stringify(rows, opts) {
+  opts = opts || {};
+  if (!Array.isArray(rows)) {
+    throw new CsvError("csv/bad-input",
+      "stringify: rows must be an array");
+  }
+  var delimiter = opts.delimiter || DEFAULT_DELIMITER;
+  var eol       = opts.eol || DEFAULT_EOL;
+  var hasHeader = opts.header !== false;
+  if (rows.length === 0) return "";
+
+  var columns;
+  if (Array.isArray(opts.columns)) {
+    columns = opts.columns.slice();
+  } else if (Array.isArray(rows[0])) {
+    // Array-of-arrays input — no headers to derive; emit as-is.
+    columns = null;
+  } else if (rows[0] && typeof rows[0] === "object") {
+    columns = Object.keys(rows[0]);
+  } else {
+    throw new CsvError("csv/bad-input",
+      "stringify: rows[0] must be an object or array");
+  }
+
+  var lines = [];
+  if (hasHeader && columns) lines.push(columns.map(_quoteCell).join(delimiter));
+
+  for (var r = 0; r < rows.length; r++) {
+    var row = rows[r];
+    var cells;
+    if (Array.isArray(row)) {
+      cells = row.map(_quoteCell);
+    } else if (row && typeof row === "object") {
+      cells = (columns || Object.keys(row)).map(function (col) {
+        return _quoteCell(row[col]);
+      });
+    } else {
+      throw new CsvError("csv/bad-input",
+        "stringify: rows[" + r + "] must be an object or array");
+    }
+    lines.push(cells.join(delimiter));
+  }
+  return lines.join(eol) + eol;
+}
+
+function _quoteCell(value) {
+  if (value === null || value === undefined) return "";
+  var s = typeof value === "string" ? value : String(value);
+  if (s.indexOf("\"") !== -1 || s.indexOf(",") !== -1 ||
+      s.indexOf("\r") !== -1 || s.indexOf("\n") !== -1) {
+    return "\"" + s.replace(/"/g, "\"\"") + "\"";
+  }
+  return s;
+}
+
+module.exports = {
+  parse:     parse,
+  stringify: stringify,
+  CsvError:  CsvError,
+};

package/lib/middleware/index.js

@@ -30,6 +30,7 @@ module.exports = {
   health:          require("./health").create,
   compression:     require("./compression").create,
   cspNonce:        require("./csp-nonce").create,
+  sse:             require("./sse").create,
   apiEncrypt:      require("./api-encrypt"),
 
   // Module exports for advanced use (constants, raw factory access)
@@ -47,6 +48,7 @@ module.exports = {
     health:          require("./health"),
     compression:     require("./compression"),
     cspNonce:        require("./csp-nonce"),
+    sse:             require("./sse"),
     apiEncrypt:      require("./api-encrypt"),
   },
 };

package/lib/middleware/sse.js

@@ -0,0 +1,165 @@
+"use strict";
+/**
+ * sse — Server-Sent Events middleware. One-way streaming from server
+ * to browser over a single HTTP response with `Content-Type:
+ * text/event-stream`. Browsers reconnect automatically with the
+ * `Last-Event-ID` header so the operator's handler can resume from
+ * the last delivered event.
+ *
+ * Use case: live dashboards, log tailing, progress updates, real-time
+ * counters. SSE is the right tool when the server pushes and the
+ * client doesn't need to send anything back. For bidirectional, use
+ * `b.websocket`.
+ *
+ *   router.get("/events", b.middleware.sse(async function (channel, req) {
+ *     channel.send({ id: 1, event: "tick", data: { count: 1 } });
+ *     channel.send({ id: 2, event: "tick", data: { count: 2 } });
+ *     // resume support — read req.headers["last-event-id"] and
+ *     // resume from that point.
+ *   }));
+ *
+ * `channel`:
+ *   send({ id?, event?, data, retry? })  — emit one SSE message
+ *   ping(comment?)                       — emit a comment line (keeps
+ *                                          intermediate proxies happy)
+ *   close()                              — end the stream
+ *   onAbort(fn)                          — register cleanup when the
+ *                                          client disconnects (browser
+ *                                          tab close, network drop)
+ *
+ * Heartbeat: the middleware sends a comment line every `heartbeatMs`
+ * (default 15s) automatically so corporate proxies / Heroku-style
+ * idle-timeouts don't kill the stream. Operators with strict
+ * deployments override `heartbeatMs: false` to disable.
+ *
+ * Compression: SSE streams typically should NOT be compressed —
+ * `b.middleware.compression` skips `text/event-stream` by default.
+ */
+var C = require("../constants");
+var requestHelpers = require("../request-helpers");
+var validateOpts = require("../validate-opts");
+
+var DEFAULT_HEARTBEAT_MS = C.TIME.seconds(15);
+
+function _formatEvent(msg) {
+  // RFC 6455... wait, that's WebSocket. SSE: WHATWG HTML §9.2.5.
+  // Lines: "id: <n>\n", "event: <name>\n", "data: <line>\n" (multi-line
+  // data is multiple "data: " lines), "retry: <ms>\n", blank line ends.
+  var out = "";
+  if (msg.id !== undefined && msg.id !== null) out += "id: " + String(msg.id).replace(/[\r\n]/g, "") + "\n";
+  if (msg.event)                                out += "event: " + String(msg.event).replace(/[\r\n]/g, "") + "\n";
+  if (msg.retry !== undefined && msg.retry !== null) {
+    if (typeof msg.retry !== "number" || !isFinite(msg.retry) || msg.retry < 0) {
+      throw new Error("sse: retry must be a non-negative finite number of milliseconds");
+    }
+    out += "retry: " + Math.floor(msg.retry) + "\n";
+  }
+  var dataStr;
+  if (msg.data === undefined || msg.data === null) dataStr = "";
+  else if (typeof msg.data === "string")           dataStr = msg.data;
+  else                                              dataStr = JSON.stringify(msg.data);
+  // Multi-line data → one `data:` line per source line (per spec).
+  var lines = dataStr.split(/\r?\n/);
+  for (var i = 0; i < lines.length; i++) out += "data: " + lines[i] + "\n";
+  out += "\n";  // dispatch
+  return out;
+}
+
+function create(handler, opts) {
+  if (typeof handler !== "function") {
+    throw new Error("middleware.sse: handler must be a function (channel, req) => ...");
+  }
+  opts = opts || {};
+  validateOpts(opts, ["heartbeatMs", "headers"], "middleware.sse");
+  var heartbeatMs = opts.heartbeatMs === false ? 0
+    : (opts.heartbeatMs != null ? opts.heartbeatMs : DEFAULT_HEARTBEAT_MS);
+  if (heartbeatMs !== 0 && (typeof heartbeatMs !== "number" || !isFinite(heartbeatMs) || heartbeatMs <= 0)) {
+    throw new Error("middleware.sse: heartbeatMs must be a positive finite number or false");
+  }
+  var extraHeaders = opts.headers || {};
+
+  return async function sseMiddleware(req, res) {
+    if (typeof res.writeHead !== "function" || typeof res.write !== "function") {
+      // Not an http.ServerResponse — operator wired this onto something
+      // unusual. Fail closed rather than silently dropping the handler.
+      throw new Error("middleware.sse: res does not support writeHead/write — wire SSE only on HTTP routes");
+    }
+    var headers = Object.assign({
+      "Content-Type":     "text/event-stream; charset=utf-8",
+      "Cache-Control":    "no-cache, no-transform",
+      "Connection":       "keep-alive",
+      // Disable nginx response buffering when terminating behind it.
+      "X-Accel-Buffering": "no",
+    }, extraHeaders);
+    // Append Vary: Accept so a proxy doesn't serve a cached non-SSE
+    // response on the same URL to a future client.
+    res.writeHead(200, headers);
+    requestHelpers.appendVary(res, "Accept");
+    // Initial flush — some proxies hold the headers until first byte.
+    res.write(":\n\n");
+
+    var closed = false;
+    var heartbeatTimer = null;
+    var abortHandlers = [];
+
+    function _scheduleHeartbeat() {
+      if (heartbeatMs === 0) return;
+      heartbeatTimer = setTimeout(function () {
+        if (closed) return;
+        try { res.write(": heartbeat\n\n"); } catch (_e) { /* socket closed */ }
+        _scheduleHeartbeat();
+      }, heartbeatMs);
+      if (typeof heartbeatTimer.unref === "function") heartbeatTimer.unref();
+    }
+    _scheduleHeartbeat();
+
+    var channel = {
+      send: function (msg) {
+        if (closed) return false;
+        try { res.write(_formatEvent(msg || {})); return true; }
+        catch (_e) { return false; }
+      },
+      ping: function (comment) {
+        if (closed) return false;
+        var safe = comment ? String(comment).replace(/[\r\n]/g, " ") : "ping";
+        try { res.write(": " + safe + "\n\n"); return true; }
+        catch (_e) { return false; }
+      },
+      close: function () {
+        if (closed) return;
+        closed = true;
+        if (heartbeatTimer) { clearTimeout(heartbeatTimer); heartbeatTimer = null; }
+        try { res.end(); } catch (_e) { /* already ended */ }
+      },
+      onAbort: function (fn) {
+        if (typeof fn === "function") abortHandlers.push(fn);
+      },
+      get closed() { return closed; },
+    };
+
+    function _onClose() {
+      if (closed) return;
+      closed = true;
+      if (heartbeatTimer) { clearTimeout(heartbeatTimer); heartbeatTimer = null; }
+      for (var i = 0; i < abortHandlers.length; i++) {
+        try { abortHandlers[i](); } catch (_e) { /* operator handler error — drop */ }
+      }
+    }
+    res.once("close", _onClose);
+    res.once("error", _onClose);
+    if (req && typeof req.once === "function") req.once("aborted", _onClose);
+
+    try {
+      await handler(channel, req);
+    } catch (e) {
+      _onClose();
+      try { res.end(); } catch (_ignored) { /* */ }
+      throw e;
+    }
+  };
+}
+
+module.exports = {
+  create:        create,
+  _formatEvent:  _formatEvent,   // test-only export
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blamejs/core",
-  "version": "0.5.8",
+  "version": "0.5.10",
   "description": "The Node framework that owns its stack.",
   "license": "Apache-2.0",
   "author": "blamejs contributors",