@singhak/nodeui-express 0.1.0

package/README.md

@@ -0,0 +1,47 @@
+# @singhak/nodeui-express
+
+Express middleware adapter for the NodeUI developer console. Mounts the core
+middleware, serving the bundled React console and its API under `{path}`
+(default `/nodeui`) and recording app requests in the request-log panel.
+
+## Install
+
+```bash
+npm install @singhak/nodeui-express
+```
+
+## Usage
+
+```ts
+import express from 'express';
+import { nodeui } from '@singhak/nodeui-express';
+
+const app = express();
+const { middleware, server } = nodeui();
+
+app.use(express.json());
+app.use(middleware);
+
+app.get('/hello', (_req, res) => res.json({ hello: 'world' }));
+
+app.listen(3000, '127.0.0.1', () => {
+  server.mark('listening');
+});
+```
+
+Open `http://127.0.0.1:3000/nodeui` for the console and
+`http://127.0.0.1:3000/nodeui/api/config` for the API.
+
+## Options
+
+`nodeui(options?)` accepts any `@singhak/nodeui-core` `NodeUIOptions` (env overrides,
+path, request-log size, poll interval, etc.). See the `@singhak/nodeui-core` README for
+the full configuration table and safety model.
+
+## Development
+
+```bash
+npm run typecheck
+npm test
+npm run build
+```

package/dist/index.cjs

@@ -0,0 +1,38 @@
+"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 __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  nodeui: () => nodeui
+});
+module.exports = __toCommonJS(index_exports);
+var import_nodeui_core = require("@singhak/nodeui-core");
+__reExport(index_exports, require("@singhak/nodeui-core"), module.exports);
+function nodeui(options) {
+  const server = (0, import_nodeui_core.createNodeUI)(options);
+  return { middleware: server.middleware(), server, addLogSource: server.addLogSource };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  nodeui,
+  ...require("@singhak/nodeui-core")
+});
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import {\n  createNodeUI,\n  type NodeUIMiddleware,\n  type NodeUIOptions,\n  type NodeUIServer,\n} from '@singhak/nodeui-core';\n\nexport interface NodeUIExpress {\n  /** Express middleware that mounts the console; call `app.use(middleware)`. */\n  middleware: NodeUIMiddleware;\n  /** Handle to the underlying server (mark, shutdown, config). */\n  server: NodeUIServer;\n  /** Pushes an external log entry into the log viewer (logger adapter). */\n  addLogSource: NodeUIServer['addLogSource'];\n}\n\n/**\n * Creates the NodeUI Express middleware plus its server handle.\n *\n * @example\n * const { middleware, server } = nodeui();\n * app.use(middleware);\n * app.listen(3000, \"127.0.0.1\", () => server.mark(\"listening\"));\n */\nexport function nodeui(options?: NodeUIOptions): NodeUIExpress {\n  const server = createNodeUI(options);\n  return { middleware: server.middleware(), server, addLogSource: server.addLogSource };\n}\n\nexport * from '@singhak/nodeui-core';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,yBAKO;AAwBP,0BAAc,iCA7Bd;AAwBO,SAAS,OAAO,SAAwC;AAC7D,QAAM,aAAS,iCAAa,OAAO;AACnC,SAAO,EAAE,YAAY,OAAO,WAAW,GAAG,QAAQ,cAAc,OAAO,aAAa;AACtF;","names":[]}

package/dist/index.d.mts

@@ -0,0 +1,22 @@
+import { NodeUIMiddleware, NodeUIServer, NodeUIOptions } from '@singhak/nodeui-core';
+export * from '@singhak/nodeui-core';
+
+interface NodeUIExpress {
+    /** Express middleware that mounts the console; call `app.use(middleware)`. */
+    middleware: NodeUIMiddleware;
+    /** Handle to the underlying server (mark, shutdown, config). */
+    server: NodeUIServer;
+    /** Pushes an external log entry into the log viewer (logger adapter). */
+    addLogSource: NodeUIServer['addLogSource'];
+}
+/**
+ * Creates the NodeUI Express middleware plus its server handle.
+ *
+ * @example
+ * const { middleware, server } = nodeui();
+ * app.use(middleware);
+ * app.listen(3000, "127.0.0.1", () => server.mark("listening"));
+ */
+declare function nodeui(options?: NodeUIOptions): NodeUIExpress;
+
+export { type NodeUIExpress, nodeui };

package/dist/index.d.ts

@@ -0,0 +1,22 @@
+import { NodeUIMiddleware, NodeUIServer, NodeUIOptions } from '@singhak/nodeui-core';
+export * from '@singhak/nodeui-core';
+
+interface NodeUIExpress {
+    /** Express middleware that mounts the console; call `app.use(middleware)`. */
+    middleware: NodeUIMiddleware;
+    /** Handle to the underlying server (mark, shutdown, config). */
+    server: NodeUIServer;
+    /** Pushes an external log entry into the log viewer (logger adapter). */
+    addLogSource: NodeUIServer['addLogSource'];
+}
+/**
+ * Creates the NodeUI Express middleware plus its server handle.
+ *
+ * @example
+ * const { middleware, server } = nodeui();
+ * app.use(middleware);
+ * app.listen(3000, "127.0.0.1", () => server.mark("listening"));
+ */
+declare function nodeui(options?: NodeUIOptions): NodeUIExpress;
+
+export { type NodeUIExpress, nodeui };

package/dist/index.mjs

@@ -0,0 +1,13 @@
+// src/index.ts
+import {
+  createNodeUI
+} from "@singhak/nodeui-core";
+export * from "@singhak/nodeui-core";
+function nodeui(options) {
+  const server = createNodeUI(options);
+  return { middleware: server.middleware(), server, addLogSource: server.addLogSource };
+}
+export {
+  nodeui
+};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import {\n  createNodeUI,\n  type NodeUIMiddleware,\n  type NodeUIOptions,\n  type NodeUIServer,\n} from '@singhak/nodeui-core';\n\nexport interface NodeUIExpress {\n  /** Express middleware that mounts the console; call `app.use(middleware)`. */\n  middleware: NodeUIMiddleware;\n  /** Handle to the underlying server (mark, shutdown, config). */\n  server: NodeUIServer;\n  /** Pushes an external log entry into the log viewer (logger adapter). */\n  addLogSource: NodeUIServer['addLogSource'];\n}\n\n/**\n * Creates the NodeUI Express middleware plus its server handle.\n *\n * @example\n * const { middleware, server } = nodeui();\n * app.use(middleware);\n * app.listen(3000, \"127.0.0.1\", () => server.mark(\"listening\"));\n */\nexport function nodeui(options?: NodeUIOptions): NodeUIExpress {\n  const server = createNodeUI(options);\n  return { middleware: server.middleware(), server, addLogSource: server.addLogSource };\n}\n\nexport * from '@singhak/nodeui-core';\n"],"mappings":";AAAA;AAAA,EACE;AAAA,OAIK;AAwBP,cAAc;AALP,SAAS,OAAO,SAAwC;AAC7D,QAAM,SAAS,aAAa,OAAO;AACnC,SAAO,EAAE,YAAY,OAAO,WAAW,GAAG,QAAQ,cAAc,OAAO,aAAa;AACtF;","names":[]}

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@singhak/nodeui-express",
+  "version": "0.1.0",
+  "description": "Express middleware adapter for the NodeUI developer console.",
+  "license": "Apache-2.0",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false,
+  "keywords": [
+    "express",
+    "middleware",
+    "console",
+    "developer-tools",
+    "observability",
+    "debugging"
+  ],
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Singhak/nodeui.git"
+  },
+  "homepage": "https://github.com/Singhak/nodeui#readme",
+  "bugs": {
+    "url": "https://github.com/Singhak/nodeui/issues"
+  },
+  "scripts": {
+    "prepublishOnly": "npm run build",
+    "build": "tsup",
+    "typecheck": "tsc -p tsconfig.typecheck.json",
+    "test": "vitest run"
+  },
+  "dependencies": {
+    "@singhak/nodeui-core": "^0.1.0"
+  },
+  "peerDependencies": {
+    "express": "^4.0.0 || ^5.0.0"
+  },
+  "devDependencies": {
+    "@types/express": "^5.0.0",
+    "@types/node": "^22.19.0",
+    "@types/supertest": "^6.0.2",
+    "express": "^5.2.1",
+    "supertest": "^7.1.0",
+    "tsup": "^8.5.0",
+    "typescript": "^5.9.3",
+    "vitest": "^3.2.4"
+  },
+  "author": "Anil Kumar",
+  "type": "commonjs"
+}