iobroker.time-tracker 0.2.0

package/build/lib/web/static.js

@@ -0,0 +1,151 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var static_exports = {};
+__export(static_exports, {
+  createStaticHandler: () => createStaticHandler
+});
+module.exports = __toCommonJS(static_exports);
+var import_node_crypto = require("node:crypto");
+var fs = __toESM(require("node:fs"));
+var path = __toESM(require("node:path"));
+const CONTENT_TYPES = {
+  ".html": "text/html; charset=utf-8",
+  ".js": "text/javascript; charset=utf-8",
+  ".mjs": "text/javascript; charset=utf-8",
+  ".css": "text/css; charset=utf-8",
+  ".json": "application/json; charset=utf-8",
+  ".webmanifest": "application/manifest+json; charset=utf-8",
+  ".svg": "image/svg+xml",
+  ".png": "image/png",
+  ".jpg": "image/jpeg",
+  ".jpeg": "image/jpeg",
+  ".gif": "image/gif",
+  ".ico": "image/x-icon",
+  ".woff": "font/woff",
+  ".woff2": "font/woff2",
+  ".txt": "text/plain; charset=utf-8",
+  ".map": "application/json; charset=utf-8"
+};
+function createStaticHandler(options) {
+  var _a;
+  const root = path.resolve(options.root);
+  const indexFile = (_a = options.indexFile) != null ? _a : "index.html";
+  return (request) => {
+    var _a2, _b, _c;
+    const method = ((_a2 = request.method) != null ? _a2 : "GET").toUpperCase();
+    if (method !== "GET" && method !== "HEAD") {
+      return null;
+    }
+    let target;
+    try {
+      target = resolveTarget(root, (_b = request.path) != null ? _b : "/");
+    } catch {
+      return {
+        status: 404,
+        headers: { "content-type": "text/plain; charset=utf-8" },
+        body: "Not Found"
+      };
+    }
+    let file = target;
+    if (!isFile(file)) {
+      if (!requestsHtml(request)) {
+        return null;
+      }
+      file = path.join(root, indexFile);
+      if (!isFile(file)) {
+        return null;
+      }
+    }
+    const stats = fs.statSync(file);
+    const etag = `"${(0, import_node_crypto.createHash)("sha1").update(`${stats.size}:${stats.mtimeMs}`).digest("hex")}"`;
+    const headers = {
+      "content-type": (_c = CONTENT_TYPES[path.extname(file).toLowerCase()]) != null ? _c : "application/octet-stream",
+      etag,
+      "last-modified": stats.mtime.toUTCString(),
+      "cache-control": file.endsWith(indexFile) ? "no-cache" : "public, max-age=3600",
+      "x-content-type-options": "nosniff"
+    };
+    if (isFresh(request, etag, stats.mtime)) {
+      return { status: 304, headers, body: "" };
+    }
+    return {
+      status: 200,
+      headers: { ...headers, "content-length": String(stats.size) },
+      // binary assets must keep their bytes, so the file is read as Buffer
+      body: method === "HEAD" ? "" : fs.readFileSync(file)
+    };
+  };
+}
+function resolveTarget(root, requestPath) {
+  const decoded = decodeURIComponent(requestPath.split("?")[0]);
+  const relative = decoded.replace(/^\/+/, "");
+  const resolved = path.resolve(root, relative);
+  if (resolved !== root && !resolved.startsWith(`${root}${path.sep}`)) {
+    throw new Error("path leaves the root directory");
+  }
+  return resolved;
+}
+function isFile(file) {
+  try {
+    return fs.statSync(file).isFile();
+  } catch {
+    return false;
+  }
+}
+function requestsHtml(request) {
+  var _a;
+  const accept = (_a = headerOf(request, "accept")) != null ? _a : "";
+  if (!accept) {
+    return true;
+  }
+  return accept.includes("text/html") || accept.includes("*/*");
+}
+function headerOf(request, name) {
+  var _a, _b;
+  const value = (_a = request.headers) == null ? void 0 : _a[name];
+  return Array.isArray(value) ? (_b = value[0]) != null ? _b : null : value != null ? value : null;
+}
+function isFresh(request, etag, modified) {
+  const ifNoneMatch = headerOf(request, "if-none-match");
+  if (ifNoneMatch) {
+    return ifNoneMatch.split(",").some((value) => value.trim() === etag);
+  }
+  const ifModifiedSince = headerOf(request, "if-modified-since");
+  if (ifModifiedSince) {
+    const since = Date.parse(ifModifiedSince);
+    const modifiedSeconds = Math.floor(modified.getTime() / 1e3) * 1e3;
+    return Number.isFinite(since) && modifiedSeconds <= since;
+  }
+  return false;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createStaticHandler
+});
+//# sourceMappingURL=static.js.map

package/build/lib/web/static.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/lib/web/static.ts"],
+  "sourcesContent": ["/**\n * Static file delivery for the PWA (`www/`).\n *\n * The handler answers `GET`/`HEAD` for files below a root directory. It never leaves that directory: the path\n * is resolved and checked against the root, so `../` or encoded traversal cannot read other files. Single page\n * applications get an `index.html` fallback for unknown paths, but only for HTML requests \u2014 an API call must\n * never receive the HTML page.\n *\n * Caching uses `ETag` and `Last-Modified`, so a reload only transfers changed files; `If-None-Match` and\n * `If-Modified-Since` answer with `304`.\n */\n\nimport { createHash } from \"node:crypto\";\nimport * as fs from \"node:fs\";\nimport * as path from \"node:path\";\nimport type { HttpRequest, HttpResponse } from \"./router\";\n\n/** Options of the static handler. */\nexport interface StaticFilesOptions {\n\t/** Directory that is served (absolute path) */\n\troot: string;\n\t/** File served for unknown paths of a single page application (default `index.html`) */\n\tindexFile?: string;\n}\n\n/** A static handler: returns a response or `null` when it does not handle the request. */\nexport type StaticHandler = (request: HttpRequest) => HttpResponse | null;\n\nconst CONTENT_TYPES: Record<string, string> = {\n\t\".html\": \"text/html; charset=utf-8\",\n\t\".js\": \"text/javascript; charset=utf-8\",\n\t\".mjs\": \"text/javascript; charset=utf-8\",\n\t\".css\": \"text/css; charset=utf-8\",\n\t\".json\": \"application/json; charset=utf-8\",\n\t\".webmanifest\": \"application/manifest+json; charset=utf-8\",\n\t\".svg\": \"image/svg+xml\",\n\t\".png\": \"image/png\",\n\t\".jpg\": \"image/jpeg\",\n\t\".jpeg\": \"image/jpeg\",\n\t\".gif\": \"image/gif\",\n\t\".ico\": \"image/x-icon\",\n\t\".woff\": \"font/woff\",\n\t\".woff2\": \"font/woff2\",\n\t\".txt\": \"text/plain; charset=utf-8\",\n\t\".map\": \"application/json; charset=utf-8\",\n};\n\n/**\n * Creates a static file handler.\n *\n * @param options - root directory and index file\n * @returns the handler\n */\nexport function createStaticHandler(options: StaticFilesOptions): StaticHandler {\n\tconst root = path.resolve(options.root);\n\tconst indexFile = options.indexFile ?? \"index.html\";\n\n\treturn (request: HttpRequest): HttpResponse | null => {\n\t\tconst method = (request.method ?? \"GET\").toUpperCase();\n\t\tif (method !== \"GET\" && method !== \"HEAD\") {\n\t\t\treturn null;\n\t\t}\n\n\t\tlet target: string;\n\t\ttry {\n\t\t\ttarget = resolveTarget(root, request.path ?? \"/\");\n\t\t} catch {\n\t\t\t// traversal attempt: the caller must not learn anything about the file system\n\t\t\treturn {\n\t\t\t\tstatus: 404,\n\t\t\t\theaders: { \"content-type\": \"text/plain; charset=utf-8\" },\n\t\t\t\tbody: \"Not Found\",\n\t\t\t};\n\t\t}\n\n\t\tlet file = target;\n\t\tif (!isFile(file)) {\n\t\t\t// single page application: unknown paths are routed on the client\n\t\t\tif (!requestsHtml(request)) {\n\t\t\t\treturn null;\n\t\t\t}\n\t\t\tfile = path.join(root, indexFile);\n\t\t\tif (!isFile(file)) {\n\t\t\t\treturn null;\n\t\t\t}\n\t\t}\n\n\t\tconst stats = fs.statSync(file);\n\t\tconst etag = `\"${createHash(\"sha1\").update(`${stats.size}:${stats.mtimeMs}`).digest(\"hex\")}\"`;\n\t\tconst headers: Record<string, string> = {\n\t\t\t\"content-type\": CONTENT_TYPES[path.extname(file).toLowerCase()] ?? \"application/octet-stream\",\n\t\t\tetag,\n\t\t\t\"last-modified\": stats.mtime.toUTCString(),\n\t\t\t\"cache-control\": file.endsWith(indexFile) ? \"no-cache\" : \"public, max-age=3600\",\n\t\t\t\"x-content-type-options\": \"nosniff\",\n\t\t};\n\n\t\tif (isFresh(request, etag, stats.mtime)) {\n\t\t\treturn { status: 304, headers, body: \"\" };\n\t\t}\n\n\t\treturn {\n\t\t\tstatus: 200,\n\t\t\theaders: { ...headers, \"content-length\": String(stats.size) },\n\t\t\t// binary assets must keep their bytes, so the file is read as Buffer\n\t\t\tbody: method === \"HEAD\" ? \"\" : fs.readFileSync(file),\n\t\t};\n\t};\n}\n\n/**\n * Resolves a request path to a file inside the root directory.\n *\n * @param root - root directory (absolute)\n * @param requestPath - path of the request\n * @returns absolute file path\n */\nfunction resolveTarget(root: string, requestPath: string): string {\n\tconst decoded = decodeURIComponent(requestPath.split(\"?\")[0]);\n\tconst relative = decoded.replace(/^\\/+/, \"\");\n\tconst resolved = path.resolve(root, relative);\n\n\tif (resolved !== root && !resolved.startsWith(`${root}${path.sep}`)) {\n\t\tthrow new Error(\"path leaves the root directory\");\n\t}\n\t// a directory is mapped to its index file\n\treturn resolved;\n}\n\n/**\n * Checks whether a path is an existing file.\n *\n * @param file - absolute path\n * @returns true when it is a file\n */\nfunction isFile(file: string): boolean {\n\ttry {\n\t\treturn fs.statSync(file).isFile();\n\t} catch {\n\t\treturn false;\n\t}\n}\n\n/**\n * Checks whether the client expects HTML (a browser navigating, not an API client).\n *\n * @param request - incoming request\n * @returns true when HTML may be delivered\n */\nfunction requestsHtml(request: HttpRequest): boolean {\n\tconst accept = headerOf(request, \"accept\") ?? \"\";\n\tif (!accept) {\n\t\t// no `Accept` header: behave like a browser and deliver the page\n\t\treturn true;\n\t}\n\treturn accept.includes(\"text/html\") || accept.includes(\"*/*\");\n}\n\n/**\n * Reads a header value as string.\n *\n * @param request - incoming request\n * @param name - header name (lower case)\n * @returns the value or `null`\n */\nfunction headerOf(request: HttpRequest, name: string): string | null {\n\tconst value = request.headers?.[name];\n\treturn Array.isArray(value) ? (value[0] ?? null) : (value ?? null);\n}\n\n/**\n * Checks whether the client already has the current version.\n *\n * @param request - incoming request\n * @param etag - current entity tag\n * @param modified - last modification time\n * @returns true when a `304` may be answered\n */\nfunction isFresh(request: HttpRequest, etag: string, modified: Date): boolean {\n\tconst ifNoneMatch = headerOf(request, \"if-none-match\");\n\tif (ifNoneMatch) {\n\t\treturn ifNoneMatch.split(\",\").some(value => value.trim() === etag);\n\t}\n\n\tconst ifModifiedSince = headerOf(request, \"if-modified-since\");\n\tif (ifModifiedSince) {\n\t\tconst since = Date.parse(ifModifiedSince);\n\t\t// `Last-Modified` only carries seconds, so the comparison has to as well\n\t\tconst modifiedSeconds = Math.floor(modified.getTime() / 1000) * 1000;\n\t\treturn Number.isFinite(since) && modifiedSeconds <= since;\n\t}\n\treturn false;\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAYA,yBAA2B;AAC3B,SAAoB;AACpB,WAAsB;AActB,MAAM,gBAAwC;AAAA,EAC7C,SAAS;AAAA,EACT,OAAO;AAAA,EACP,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,SAAS;AAAA,EACT,gBAAgB;AAAA,EAChB,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,SAAS;AAAA,EACT,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,SAAS;AAAA,EACT,UAAU;AAAA,EACV,QAAQ;AAAA,EACR,QAAQ;AACT;AAQO,SAAS,oBAAoB,SAA4C;AArDhF;AAsDC,QAAM,OAAO,KAAK,QAAQ,QAAQ,IAAI;AACtC,QAAM,aAAY,aAAQ,cAAR,YAAqB;AAEvC,SAAO,CAAC,YAA8C;AAzDvD,QAAAA,KAAA;AA0DE,UAAM,WAAUA,MAAA,QAAQ,WAAR,OAAAA,MAAkB,OAAO,YAAY;AACrD,QAAI,WAAW,SAAS,WAAW,QAAQ;AAC1C,aAAO;AAAA,IACR;AAEA,QAAI;AACJ,QAAI;AACH,eAAS,cAAc,OAAM,aAAQ,SAAR,YAAgB,GAAG;AAAA,IACjD,QAAQ;AAEP,aAAO;AAAA,QACN,QAAQ;AAAA,QACR,SAAS,EAAE,gBAAgB,4BAA4B;AAAA,QACvD,MAAM;AAAA,MACP;AAAA,IACD;AAEA,QAAI,OAAO;AACX,QAAI,CAAC,OAAO,IAAI,GAAG;AAElB,UAAI,CAAC,aAAa,OAAO,GAAG;AAC3B,eAAO;AAAA,MACR;AACA,aAAO,KAAK,KAAK,MAAM,SAAS;AAChC,UAAI,CAAC,OAAO,IAAI,GAAG;AAClB,eAAO;AAAA,MACR;AAAA,IACD;AAEA,UAAM,QAAQ,GAAG,SAAS,IAAI;AAC9B,UAAM,OAAO,QAAI,+BAAW,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,IAAI,MAAM,OAAO,EAAE,EAAE,OAAO,KAAK,CAAC;AAC1F,UAAM,UAAkC;AAAA,MACvC,iBAAgB,mBAAc,KAAK,QAAQ,IAAI,EAAE,YAAY,CAAC,MAA9C,YAAmD;AAAA,MACnE;AAAA,MACA,iBAAiB,MAAM,MAAM,YAAY;AAAA,MACzC,iBAAiB,KAAK,SAAS,SAAS,IAAI,aAAa;AAAA,MACzD,0BAA0B;AAAA,IAC3B;AAEA,QAAI,QAAQ,SAAS,MAAM,MAAM,KAAK,GAAG;AACxC,aAAO,EAAE,QAAQ,KAAK,SAAS,MAAM,GAAG;AAAA,IACzC;AAEA,WAAO;AAAA,MACN,QAAQ;AAAA,MACR,SAAS,EAAE,GAAG,SAAS,kBAAkB,OAAO,MAAM,IAAI,EAAE;AAAA;AAAA,MAE5D,MAAM,WAAW,SAAS,KAAK,GAAG,aAAa,IAAI;AAAA,IACpD;AAAA,EACD;AACD;AASA,SAAS,cAAc,MAAc,aAA6B;AACjE,QAAM,UAAU,mBAAmB,YAAY,MAAM,GAAG,EAAE,CAAC,CAAC;AAC5D,QAAM,WAAW,QAAQ,QAAQ,QAAQ,EAAE;AAC3C,QAAM,WAAW,KAAK,QAAQ,MAAM,QAAQ;AAE5C,MAAI,aAAa,QAAQ,CAAC,SAAS,WAAW,GAAG,IAAI,GAAG,KAAK,GAAG,EAAE,GAAG;AACpE,UAAM,IAAI,MAAM,gCAAgC;AAAA,EACjD;AAEA,SAAO;AACR;AAQA,SAAS,OAAO,MAAuB;AACtC,MAAI;AACH,WAAO,GAAG,SAAS,IAAI,EAAE,OAAO;AAAA,EACjC,QAAQ;AACP,WAAO;AAAA,EACR;AACD;AAQA,SAAS,aAAa,SAA+B;AArJrD;AAsJC,QAAM,UAAS,cAAS,SAAS,QAAQ,MAA1B,YAA+B;AAC9C,MAAI,CAAC,QAAQ;AAEZ,WAAO;AAAA,EACR;AACA,SAAO,OAAO,SAAS,WAAW,KAAK,OAAO,SAAS,KAAK;AAC7D;AASA,SAAS,SAAS,SAAsB,MAA6B;AArKrE;AAsKC,QAAM,SAAQ,aAAQ,YAAR,mBAAkB;AAChC,SAAO,MAAM,QAAQ,KAAK,KAAK,WAAM,CAAC,MAAP,YAAY,OAAS,wBAAS;AAC9D;AAUA,SAAS,QAAQ,SAAsB,MAAc,UAAyB;AAC7E,QAAM,cAAc,SAAS,SAAS,eAAe;AACrD,MAAI,aAAa;AAChB,WAAO,YAAY,MAAM,GAAG,EAAE,KAAK,WAAS,MAAM,KAAK,MAAM,IAAI;AAAA,EAClE;AAEA,QAAM,kBAAkB,SAAS,SAAS,mBAAmB;AAC7D,MAAI,iBAAiB;AACpB,UAAM,QAAQ,KAAK,MAAM,eAAe;AAExC,UAAM,kBAAkB,KAAK,MAAM,SAAS,QAAQ,IAAI,GAAI,IAAI;AAChE,WAAO,OAAO,SAAS,KAAK,KAAK,mBAAmB;AAAA,EACrD;AACA,SAAO;AACR;",
+  "names": ["_a"]
+}

package/build/lib/web/stream.js

@@ -0,0 +1,135 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var stream_exports = {};
+__export(stream_exports, {
+  attachEventStream: () => attachEventStream
+});
+module.exports = __toCommonJS(stream_exports);
+var import_ws = require("ws");
+var import_cookies = require("./cookies");
+function attachEventStream(options) {
+  var _a, _b, _c;
+  const path = (_a = options.path) != null ? _a : "/api/stream";
+  const now = (_b = options.now) != null ? _b : (() => Math.floor(Date.now() / 1e3));
+  const pingIntervalMs = (_c = options.pingIntervalMs) != null ? _c : 3e4;
+  const wss = new import_ws.WebSocketServer({ noServer: true });
+  const clients = /* @__PURE__ */ new Map();
+  function send(socket, payload) {
+    if (socket.readyState === socket.OPEN) {
+      socket.send(JSON.stringify(payload));
+    }
+  }
+  function reject(socket, status, code) {
+    const reason = status === 401 ? "Unauthorized" : "Forbidden";
+    const body = JSON.stringify({
+      type: "about:blank",
+      title: reason,
+      status,
+      code
+    });
+    socket.write(
+      `HTTP/1.1 ${status} ${reason}\r
+content-type: application/problem+json; charset=utf-8\r
+content-length: ${Buffer.byteLength(body)}\r
+connection: close\r
+\r
+${body}`
+    );
+    socket.destroy();
+  }
+  function textOf(raw) {
+    const buffer = Array.isArray(raw) ? Buffer.concat(raw) : Buffer.isBuffer(raw) ? raw : Buffer.from(raw);
+    return buffer.toString("utf8");
+  }
+  function onUpgrade(request, socket, head) {
+    var _a2, _b2;
+    const url = new URL((_a2 = request.url) != null ? _a2 : "/", "http://localhost");
+    if (url.pathname !== path) {
+      reject(socket, 404, "not_found");
+      return;
+    }
+    const cookieToken = (_b2 = (0, import_cookies.parseCookies)(request.headers.cookie)[import_cookies.SESSION_COOKIE]) != null ? _b2 : "";
+    const token = url.searchParams.get("token") || cookieToken;
+    const result = options.auth.authenticate({ token, now: now() });
+    if (!result.ok) {
+      reject(socket, result.error === "permission_denied" ? 403 : 401, result.error);
+      return;
+    }
+    const context = result.context;
+    wss.handleUpgrade(request, socket, head, (websocket) => {
+      var _a3;
+      clients.set(websocket, {
+        userId: context.user.id,
+        // a manager or administrator sees the whole house, everybody else only themselves
+        seesAll: context.permissions.includes("report.view_other")
+      });
+      send(websocket, {
+        type: "hello",
+        atUtc: now(),
+        userId: context.user.id,
+        version: (_a3 = options.version) != null ? _a3 : "0.0.0",
+        subscribe: context.permissions.includes("report.view_other") ? "all" : "own"
+      });
+      websocket.on("close", () => clients.delete(websocket));
+      websocket.on("error", () => clients.delete(websocket));
+      websocket.on("message", (raw) => {
+        if (textOf(raw) === "ping") {
+          send(websocket, { type: "pong", atUtc: now() });
+        }
+      });
+    });
+  }
+  options.server.on("upgrade", onUpgrade);
+  const unsubscribe = options.events.subscribe((event) => {
+    for (const [socket, client] of clients) {
+      if (client.seesAll || event.userId === null || event.userId === client.userId) {
+        send(socket, event);
+      }
+    }
+  });
+  const pingTimer = options.timers === void 0 ? null : options.timers.setInterval(() => {
+    for (const socket of clients.keys()) {
+      if (socket.readyState === socket.OPEN) {
+        socket.ping();
+      }
+    }
+  }, pingIntervalMs);
+  return {
+    async close() {
+      if (pingTimer !== null && options.timers !== void 0) {
+        options.timers.clearInterval(pingTimer);
+      }
+      unsubscribe();
+      options.server.off("upgrade", onUpgrade);
+      for (const socket of [...clients.keys()]) {
+        socket.close(1001, "server shutting down");
+      }
+      clients.clear();
+      await new Promise((resolve) => wss.close(() => resolve()));
+    },
+    clientCount() {
+      return clients.size;
+    }
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  attachEventStream
+});
+//# sourceMappingURL=stream.js.map

package/build/lib/web/stream.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/lib/web/stream.ts"],
+  "sourcesContent": ["/**\n * WebSocket endpoint `/api/stream`.\n *\n * Clients connect with their session token as a query parameter (a browser cannot set headers on a WebSocket),\n * the token is checked with the same `AuthService` as the REST API. Each client only receives the events it is\n * allowed to see: its own ones, plus everything when it holds `report.view_other` (a manager or administrator).\n *\n * The connection is kept alive with protocol pings; a client that does not answer them is dropped. There is no\n * history: a client that reconnects reloads the data it needs over REST.\n */\n\nimport type { IncomingMessage, Server } from \"node:http\";\nimport type { Duplex } from \"node:stream\";\nimport { WebSocketServer, type RawData, type WebSocket } from \"ws\";\nimport type { AuthService } from \"../services/auth\";\nimport { parseCookies, SESSION_COOKIE } from \"./cookies\";\nimport type { ApiEvent, EventBus } from \"./events\";\n\n/** Options of the stream endpoint. */\nexport interface EventStreamOptions {\n\t/** HTTP server the upgrade requests arrive on */\n\tserver: Server;\n\t/** Path of the endpoint (default `/api/stream`) */\n\tpath?: string;\n\t/** Authentication service used to check the token */\n\tauth: AuthService;\n\t/** Event bus that is forwarded */\n\tevents: EventBus;\n\t/** Reported version in the greeting frame */\n\tversion?: string;\n\t/** Instant source, defaults to the system clock */\n\tnow?: () => number;\n\t/** Interval of the protocol pings in milliseconds (default 30 s) */\n\tpingIntervalMs?: number;\n\t/**\n\t * Timer functions of the caller. The adapter passes its own (`this.setInterval`/`this.clearInterval`), so\n\t * the ping timer belongs to the adapter and cannot outlive it; without them no ping is sent (tests do not\n\t * need one).\n\t */\n\ttimers?: {\n\t\tsetInterval: (handler: () => void, milliseconds: number) => TimerHandle;\n\t\tclearInterval: (handle: TimerHandle) => void;\n\t};\n}\n\n/**\n * Handle of a repeating timer: the adapter marks its own handles with a brand type, Node returns `Timeout`\n * objects. `null`/`undefined` are allowed because the adapter's own type declaration permits them.\n */\ntype TimerHandle = number | null | undefined | ReturnType<typeof setInterval>;\n\n/** The running stream endpoint. */\nexport interface EventStream {\n\t/** Closes every connection and stops the endpoint */\n\tclose(): Promise<void>;\n\t/** Number of connected clients */\n\tclientCount(): number;\n}\n\n/**\n * Attaches the event stream to an HTTP server.\n *\n * @param options - server, path, authentication and bus\n * @returns the running endpoint\n */\nexport function attachEventStream(options: EventStreamOptions): EventStream {\n\tconst path = options.path ?? \"/api/stream\";\n\tconst now = options.now ?? (() => Math.floor(Date.now() / 1000));\n\tconst pingIntervalMs = options.pingIntervalMs ?? 30_000;\n\tconst wss = new WebSocketServer({ noServer: true });\n\t/** Connected clients with the user they belong to. */\n\tconst clients = new Map<WebSocket, { userId: number; seesAll: boolean }>();\n\n\t/**\n\t * Sends a frame to one client.\n\t *\n\t * @param socket - connection\n\t * @param payload - object to serialise\n\t */\n\tfunction send(socket: WebSocket, payload: unknown): void {\n\t\tif (socket.readyState === socket.OPEN) {\n\t\t\tsocket.send(JSON.stringify(payload));\n\t\t}\n\t}\n\n\t/**\n\t * Rejects an upgrade with a problem document.\n\t *\n\t * @param socket - raw socket of the request\n\t * @param status - HTTP status code\n\t * @param code - stable error code\n\t */\n\tfunction reject(socket: Duplex, status: number, code: string): void {\n\t\tconst reason = status === 401 ? \"Unauthorized\" : \"Forbidden\";\n\t\tconst body = JSON.stringify({\n\t\t\ttype: \"about:blank\",\n\t\t\ttitle: reason,\n\t\t\tstatus,\n\t\t\tcode,\n\t\t});\n\t\tsocket.write(\n\t\t\t`HTTP/1.1 ${status} ${reason}\\r\\n` +\n\t\t\t\t`content-type: application/problem+json; charset=utf-8\\r\\n` +\n\t\t\t\t`content-length: ${Buffer.byteLength(body)}\\r\\n` +\n\t\t\t\t`connection: close\\r\\n\\r\\n${body}`,\n\t\t);\n\t\tsocket.destroy();\n\t}\n\n\t/**\n\t * Reads the text of a received frame.\n\t *\n\t * The library hands the frame over as a `Buffer`, an `ArrayBuffer` or a list of buffers; only the text\n\t * matters here, and a client only ever sends its own ping.\n\t *\n\t * @param raw - received frame\n\t * @returns the frame as UTF-8 text\n\t */\n\tfunction textOf(raw: RawData): string {\n\t\tconst buffer = Array.isArray(raw) ? Buffer.concat(raw) : Buffer.isBuffer(raw) ? raw : Buffer.from(raw);\n\t\treturn buffer.toString(\"utf8\");\n\t}\n\n\t/**\n\t * Handles an upgrade request of the HTTP server.\n\t *\n\t * @param request - upgrade request\n\t * @param socket - raw socket\n\t * @param head - already read bytes\n\t */\n\tfunction onUpgrade(request: IncomingMessage, socket: Duplex, head: Buffer): void {\n\t\tconst url = new URL(request.url ?? \"/\", \"http://localhost\");\n\t\tif (url.pathname !== path) {\n\t\t\t// the API owns this path; anything else is not a websocket\n\t\t\treject(socket, 404, \"not_found\");\n\t\t\treturn;\n\t\t}\n\n\t\t// A browser cannot set headers on a handshake, but it does send cookies \u2014 so the session cookie counts as\n\t\t// well and the live stream works without a token in the URL (specification 4.10). The query parameter stays\n\t\t// for terminals and integration clients.\n\t\tconst cookieToken = parseCookies(request.headers.cookie)[SESSION_COOKIE] ?? \"\";\n\t\tconst token = url.searchParams.get(\"token\") || cookieToken;\n\t\tconst result = options.auth.authenticate({ token, now: now() });\n\t\tif (!result.ok) {\n\t\t\treject(socket, result.error === \"permission_denied\" ? 403 : 401, result.error);\n\t\t\treturn;\n\t\t}\n\n\t\tconst context = result.context;\n\t\twss.handleUpgrade(request, socket, head, (websocket: WebSocket) => {\n\t\t\tclients.set(websocket, {\n\t\t\t\tuserId: context.user.id,\n\t\t\t\t// a manager or administrator sees the whole house, everybody else only themselves\n\t\t\t\tseesAll: context.permissions.includes(\"report.view_other\"),\n\t\t\t});\n\n\t\t\tsend(websocket, {\n\t\t\t\ttype: \"hello\",\n\t\t\t\tatUtc: now(),\n\t\t\t\tuserId: context.user.id,\n\t\t\t\tversion: options.version ?? \"0.0.0\",\n\t\t\t\tsubscribe: context.permissions.includes(\"report.view_other\") ? \"all\" : \"own\",\n\t\t\t});\n\n\t\t\twebsocket.on(\"close\", () => clients.delete(websocket));\n\t\t\twebsocket.on(\"error\", () => clients.delete(websocket));\n\t\t\twebsocket.on(\"message\", raw => {\n\t\t\t\t// the only client message that is understood is a ping, everything else is ignored\n\t\t\t\tif (textOf(raw) === \"ping\") {\n\t\t\t\t\tsend(websocket, { type: \"pong\", atUtc: now() });\n\t\t\t\t}\n\t\t\t});\n\t\t});\n\t}\n\n\toptions.server.on(\"upgrade\", onUpgrade);\n\n\tconst unsubscribe = options.events.subscribe((event: ApiEvent) => {\n\t\tfor (const [socket, client] of clients) {\n\t\t\tif (client.seesAll || event.userId === null || event.userId === client.userId) {\n\t\t\t\tsend(socket, event);\n\t\t\t}\n\t\t}\n\t});\n\n\t// The adapter hands in its own timers, so the keep-alive ping is cleared with the adapter even when the\n\t// stream is never closed explicitly.\n\tconst pingTimer =\n\t\toptions.timers === undefined\n\t\t\t? null\n\t\t\t: options.timers.setInterval(() => {\n\t\t\t\t\tfor (const socket of clients.keys()) {\n\t\t\t\t\t\tif (socket.readyState === socket.OPEN) {\n\t\t\t\t\t\t\tsocket.ping();\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}, pingIntervalMs);\n\n\treturn {\n\t\tasync close(): Promise<void> {\n\t\t\tif (pingTimer !== null && options.timers !== undefined) {\n\t\t\t\toptions.timers.clearInterval(pingTimer);\n\t\t\t}\n\t\t\tunsubscribe();\n\t\t\toptions.server.off(\"upgrade\", onUpgrade);\n\t\t\tfor (const socket of [...clients.keys()]) {\n\t\t\t\tsocket.close(1001, \"server shutting down\");\n\t\t\t}\n\t\t\tclients.clear();\n\t\t\tawait new Promise<void>(resolve => wss.close(() => resolve()));\n\t\t},\n\n\t\tclientCount(): number {\n\t\t\treturn clients.size;\n\t\t},\n\t};\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAaA,gBAA8D;AAE9D,qBAA6C;AAkDtC,SAAS,kBAAkB,SAA0C;AAjE5E;AAkEC,QAAM,QAAO,aAAQ,SAAR,YAAgB;AAC7B,QAAM,OAAM,aAAQ,QAAR,aAAgB,MAAM,KAAK,MAAM,KAAK,IAAI,IAAI,GAAI;AAC9D,QAAM,kBAAiB,aAAQ,mBAAR,YAA0B;AACjD,QAAM,MAAM,IAAI,0BAAgB,EAAE,UAAU,KAAK,CAAC;AAElD,QAAM,UAAU,oBAAI,IAAqD;AAQzE,WAAS,KAAK,QAAmB,SAAwB;AACxD,QAAI,OAAO,eAAe,OAAO,MAAM;AACtC,aAAO,KAAK,KAAK,UAAU,OAAO,CAAC;AAAA,IACpC;AAAA,EACD;AASA,WAAS,OAAO,QAAgB,QAAgB,MAAoB;AACnE,UAAM,SAAS,WAAW,MAAM,iBAAiB;AACjD,UAAM,OAAO,KAAK,UAAU;AAAA,MAC3B,MAAM;AAAA,MACN,OAAO;AAAA,MACP;AAAA,MACA;AAAA,IACD,CAAC;AACD,WAAO;AAAA,MACN,YAAY,MAAM,IAAI,MAAM;AAAA;AAAA,kBAER,OAAO,WAAW,IAAI,CAAC;AAAA;AAAA;AAAA,EACd,IAAI;AAAA,IAClC;AACA,WAAO,QAAQ;AAAA,EAChB;AAWA,WAAS,OAAO,KAAsB;AACrC,UAAM,SAAS,MAAM,QAAQ,GAAG,IAAI,OAAO,OAAO,GAAG,IAAI,OAAO,SAAS,GAAG,IAAI,MAAM,OAAO,KAAK,GAAG;AACrG,WAAO,OAAO,SAAS,MAAM;AAAA,EAC9B;AASA,WAAS,UAAU,SAA0B,QAAgB,MAAoB;AAlIlF,QAAAA,KAAAC;AAmIE,UAAM,MAAM,IAAI,KAAID,MAAA,QAAQ,QAAR,OAAAA,MAAe,KAAK,kBAAkB;AAC1D,QAAI,IAAI,aAAa,MAAM;AAE1B,aAAO,QAAQ,KAAK,WAAW;AAC/B;AAAA,IACD;AAKA,UAAM,eAAcC,UAAA,6BAAa,QAAQ,QAAQ,MAAM,EAAE,6BAAc,MAAnD,OAAAA,MAAwD;AAC5E,UAAM,QAAQ,IAAI,aAAa,IAAI,OAAO,KAAK;AAC/C,UAAM,SAAS,QAAQ,KAAK,aAAa,EAAE,OAAO,KAAK,IAAI,EAAE,CAAC;AAC9D,QAAI,CAAC,OAAO,IAAI;AACf,aAAO,QAAQ,OAAO,UAAU,sBAAsB,MAAM,KAAK,OAAO,KAAK;AAC7E;AAAA,IACD;AAEA,UAAM,UAAU,OAAO;AACvB,QAAI,cAAc,SAAS,QAAQ,MAAM,CAAC,cAAyB;AAtJrE,UAAAD;AAuJG,cAAQ,IAAI,WAAW;AAAA,QACtB,QAAQ,QAAQ,KAAK;AAAA;AAAA,QAErB,SAAS,QAAQ,YAAY,SAAS,mBAAmB;AAAA,MAC1D,CAAC;AAED,WAAK,WAAW;AAAA,QACf,MAAM;AAAA,QACN,OAAO,IAAI;AAAA,QACX,QAAQ,QAAQ,KAAK;AAAA,QACrB,UAASA,MAAA,QAAQ,YAAR,OAAAA,MAAmB;AAAA,QAC5B,WAAW,QAAQ,YAAY,SAAS,mBAAmB,IAAI,QAAQ;AAAA,MACxE,CAAC;AAED,gBAAU,GAAG,SAAS,MAAM,QAAQ,OAAO,SAAS,CAAC;AACrD,gBAAU,GAAG,SAAS,MAAM,QAAQ,OAAO,SAAS,CAAC;AACrD,gBAAU,GAAG,WAAW,SAAO;AAE9B,YAAI,OAAO,GAAG,MAAM,QAAQ;AAC3B,eAAK,WAAW,EAAE,MAAM,QAAQ,OAAO,IAAI,EAAE,CAAC;AAAA,QAC/C;AAAA,MACD,CAAC;AAAA,IACF,CAAC;AAAA,EACF;AAEA,UAAQ,OAAO,GAAG,WAAW,SAAS;AAEtC,QAAM,cAAc,QAAQ,OAAO,UAAU,CAAC,UAAoB;AACjE,eAAW,CAAC,QAAQ,MAAM,KAAK,SAAS;AACvC,UAAI,OAAO,WAAW,MAAM,WAAW,QAAQ,MAAM,WAAW,OAAO,QAAQ;AAC9E,aAAK,QAAQ,KAAK;AAAA,MACnB;AAAA,IACD;AAAA,EACD,CAAC;AAID,QAAM,YACL,QAAQ,WAAW,SAChB,OACA,QAAQ,OAAO,YAAY,MAAM;AACjC,eAAW,UAAU,QAAQ,KAAK,GAAG;AACpC,UAAI,OAAO,eAAe,OAAO,MAAM;AACtC,eAAO,KAAK;AAAA,MACb;AAAA,IACD;AAAA,EACD,GAAG,cAAc;AAEpB,SAAO;AAAA,IACN,MAAM,QAAuB;AAC5B,UAAI,cAAc,QAAQ,QAAQ,WAAW,QAAW;AACvD,gBAAQ,OAAO,cAAc,SAAS;AAAA,MACvC;AACA,kBAAY;AACZ,cAAQ,OAAO,IAAI,WAAW,SAAS;AACvC,iBAAW,UAAU,CAAC,GAAG,QAAQ,KAAK,CAAC,GAAG;AACzC,eAAO,MAAM,MAAM,sBAAsB;AAAA,MAC1C;AACA,cAAQ,MAAM;AACd,YAAM,IAAI,QAAc,aAAW,IAAI,MAAM,MAAM,QAAQ,CAAC,CAAC;AAAA,IAC9D;AAAA,IAEA,cAAsB;AACrB,aAAO,QAAQ;AAAA,IAChB;AAAA,EACD;AACD;",
+  "names": ["_a", "_b"]
+}