@singhak/nodeui-nestjs 0.1.0

package/README.md

@@ -0,0 +1,65 @@
+# @singhak/nodeui-nestjs
+
+NestJS module adapter for the NodeUI developer console. Registers the core
+middleware for every route, 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-nestjs
+```
+
+Peer dependencies: `@nestjs/common`, `@nestjs/core`, `reflect-metadata`,
+`rxjs`.
+
+## Usage
+
+```ts
+import { Module } from '@nestjs/common';
+import { NodeUIModule } from '@singhak/nodeui-nestjs';
+
+@Module({ imports: [NodeUIModule.register()] })
+export class AppModule {}
+```
+
+```ts
+// main.ts
+import 'reflect-metadata';
+import { NestFactory } from '@nestjs/core';
+import { NodeUIService } from '@singhak/nodeui-nestjs';
+import { AppModule } from './app.module';
+
+async function bootstrap(): Promise<void> {
+  const app = await NestFactory.create(AppModule);
+  await app.listen(3000, '127.0.0.1');
+  app.get(NodeUIService).mark('listening');
+}
+
+void bootstrap();
+```
+
+Open `http://127.0.0.1:3000/nodeui` for the console and
+`http://127.0.0.1:3000/nodeui/api/config` for the API.
+
+## NodeUIService
+
+Injectable handle to the underlying server:
+
+- `mark(name)` — record a startup timing mark.
+- `config` — the effective configuration.
+- `shutdown()` — stop all sampling and timers.
+
+## Options
+
+`NodeUIModule.register(options?)` accepts any `@singhak/nodeui-core` `NodeUIOptions`.
+See the `@singhak/nodeui-core` README for the configuration table and safety model.
+
+## Development
+
+```bash
+npm run typecheck
+npm test
+npm run build
+```

package/dist/index.cjs

@@ -0,0 +1,105 @@
+"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);
+var __decorateClass = (decorators, target, key, kind) => {
+  var result = kind > 1 ? void 0 : kind ? __getOwnPropDesc(target, key) : target;
+  for (var i = decorators.length - 1, decorator; i >= 0; i--)
+    if (decorator = decorators[i])
+      result = (kind ? decorator(target, key, result) : decorator(result)) || result;
+  if (kind && result) __defProp(target, key, result);
+  return result;
+};
+var __decorateParam = (index, decorator) => (target, key) => decorator(target, key, index);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  NODEUI_SERVER: () => NODEUI_SERVER,
+  NodeUIModule: () => NodeUIModule,
+  NodeUIService: () => NodeUIService
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/nodeui.module.ts
+var import_common2 = require("@nestjs/common");
+var import_nodeui_core = require("@singhak/nodeui-core");
+
+// src/nodeui.service.ts
+var import_common = require("@nestjs/common");
+
+// src/tokens.ts
+var NODEUI_SERVER = /* @__PURE__ */ Symbol("NODEUI_SERVER");
+
+// src/nodeui.service.ts
+var NodeUIService = class {
+  constructor(server) {
+    this.server = server;
+  }
+  server;
+  mark(name) {
+    this.server.mark(name);
+  }
+  get config() {
+    return this.server.config;
+  }
+  shutdown() {
+    this.server.shutdown();
+  }
+  addLogSource(entry) {
+    this.server.addLogSource(entry);
+  }
+};
+NodeUIService = __decorateClass([
+  (0, import_common.Injectable)(),
+  __decorateParam(0, (0, import_common.Inject)(NODEUI_SERVER))
+], NodeUIService);
+
+// src/nodeui.module.ts
+var NodeUIModule = class {
+  constructor(server) {
+    this.server = server;
+  }
+  server;
+  static register(options) {
+    const server = (0, import_nodeui_core.createNodeUI)(options);
+    return {
+      module: NodeUIModule,
+      providers: [{ provide: NODEUI_SERVER, useValue: server }, NodeUIService],
+      exports: [NodeUIService, NODEUI_SERVER]
+    };
+  }
+  configure(consumer) {
+    consumer.apply(this.server.middleware()).forRoutes("*");
+  }
+};
+NodeUIModule = __decorateClass([
+  (0, import_common2.Module)({}),
+  __decorateParam(0, (0, import_common2.Inject)(NODEUI_SERVER))
+], NodeUIModule);
+
+// src/index.ts
+__reExport(index_exports, require("@singhak/nodeui-core"), module.exports);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  NODEUI_SERVER,
+  NodeUIModule,
+  NodeUIService,
+  ...require("@singhak/nodeui-core")
+});
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/nodeui.module.ts","../src/nodeui.service.ts","../src/tokens.ts"],"sourcesContent":["/**\n * @nodeui/nestjs — NestJS adapter for the NodeUI developer console.\n */\n\nexport { NodeUIModule } from './nodeui.module';\nexport { NodeUIService } from './nodeui.service';\nexport { NODEUI_SERVER } from './tokens';\nexport * from '@singhak/nodeui-core';\n","import { DynamicModule, Inject, MiddlewareConsumer, Module, NestModule } from '@nestjs/common';\nimport { createNodeUI, type NodeUIOptions, type NodeUIServer } from '@singhak/nodeui-core';\nimport { NodeUIService } from './nodeui.service';\nimport { NODEUI_SERVER } from './tokens';\n\n/**\n * NestJS adapter for the NodeUI developer console. Mounts the core middleware\n * for every route; the console and its API live under `NODEUI_PATH` (default\n * `/nodeui`) and app requests are recorded in the request log.\n *\n * @example\n * @Module({ imports: [NodeUIModule.register()] })\n * export class AppModule {}\n */\n@Module({})\nexport class NodeUIModule implements NestModule {\n  static register(options?: NodeUIOptions): DynamicModule {\n    const server = createNodeUI(options);\n    return {\n      module: NodeUIModule,\n      providers: [{ provide: NODEUI_SERVER, useValue: server }, NodeUIService],\n      exports: [NodeUIService, NODEUI_SERVER],\n    };\n  }\n\n  constructor(@Inject(NODEUI_SERVER) private readonly server: NodeUIServer) {}\n\n  configure(consumer: MiddlewareConsumer): void {\n    consumer.apply(this.server.middleware()).forRoutes('*');\n  }\n}\n","import { Inject, Injectable } from '@nestjs/common';\nimport type { NodeUIServer } from '@singhak/nodeui-core';\nimport { NODEUI_SERVER } from './tokens';\n\n/** Injectable handle to the NodeUI server: record startup marks, read config. */\n@Injectable()\nexport class NodeUIService {\n  constructor(@Inject(NODEUI_SERVER) private readonly server: NodeUIServer) {}\n\n  mark(name: string): void {\n    this.server.mark(name);\n  }\n\n  get config() {\n    return this.server.config;\n  }\n\n  shutdown(): void {\n    this.server.shutdown();\n  }\n\n  addLogSource(entry: { level: 'debug' | 'info' | 'warn' | 'error'; message: string }): void {\n    this.server.addLogSource(entry);\n  }\n}\n","/** Injection token for the underlying NodeUIServer instance. */\nexport const NODEUI_SERVER = Symbol('NODEUI_SERVER');\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,IAAAA,iBAA8E;AAC9E,yBAAoE;;;ACDpE,oBAAmC;;;ACC5B,IAAM,gBAAgB,uBAAO,eAAe;;;ADK5C,IAAM,gBAAN,MAAoB;AAAA,EACzB,YAAoD,QAAsB;AAAtB;AAAA,EAAuB;AAAA,EAAvB;AAAA,EAEpD,KAAK,MAAoB;AACvB,SAAK,OAAO,KAAK,IAAI;AAAA,EACvB;AAAA,EAEA,IAAI,SAAS;AACX,WAAO,KAAK,OAAO;AAAA,EACrB;AAAA,EAEA,WAAiB;AACf,SAAK,OAAO,SAAS;AAAA,EACvB;AAAA,EAEA,aAAa,OAA8E;AACzF,SAAK,OAAO,aAAa,KAAK;AAAA,EAChC;AACF;AAlBa,gBAAN;AAAA,MADN,0BAAW;AAAA,EAEG,6CAAO,aAAa;AAAA,GADtB;;;ADSN,IAAM,eAAN,MAAyC;AAAA,EAU9C,YAAoD,QAAsB;AAAtB;AAAA,EAAuB;AAAA,EAAvB;AAAA,EATpD,OAAO,SAAS,SAAwC;AACtD,UAAM,aAAS,iCAAa,OAAO;AACnC,WAAO;AAAA,MACL,QAAQ;AAAA,MACR,WAAW,CAAC,EAAE,SAAS,eAAe,UAAU,OAAO,GAAG,aAAa;AAAA,MACvE,SAAS,CAAC,eAAe,aAAa;AAAA,IACxC;AAAA,EACF;AAAA,EAIA,UAAU,UAAoC;AAC5C,aAAS,MAAM,KAAK,OAAO,WAAW,CAAC,EAAE,UAAU,GAAG;AAAA,EACxD;AACF;AAfa,eAAN;AAAA,MADN,uBAAO,CAAC,CAAC;AAAA,EAWK,8CAAO,aAAa;AAAA,GAVtB;;;ADRb,0BAAc,iCAPd;","names":["import_common"]}

package/dist/index.d.mts

@@ -0,0 +1,38 @@
+import { NestModule, DynamicModule, MiddlewareConsumer } from '@nestjs/common';
+import * as _singhak_nodeui_core from '@singhak/nodeui-core';
+import { NodeUIOptions, NodeUIServer } from '@singhak/nodeui-core';
+export * from '@singhak/nodeui-core';
+
+/**
+ * NestJS adapter for the NodeUI developer console. Mounts the core middleware
+ * for every route; the console and its API live under `NODEUI_PATH` (default
+ * `/nodeui`) and app requests are recorded in the request log.
+ *
+ * @example
+ * @Module({ imports: [NodeUIModule.register()] })
+ * export class AppModule {}
+ */
+declare class NodeUIModule implements NestModule {
+    private readonly server;
+    static register(options?: NodeUIOptions): DynamicModule;
+    constructor(server: NodeUIServer);
+    configure(consumer: MiddlewareConsumer): void;
+}
+
+/** Injectable handle to the NodeUI server: record startup marks, read config. */
+declare class NodeUIService {
+    private readonly server;
+    constructor(server: NodeUIServer);
+    mark(name: string): void;
+    get config(): _singhak_nodeui_core.NodeUIConfig;
+    shutdown(): void;
+    addLogSource(entry: {
+        level: 'debug' | 'info' | 'warn' | 'error';
+        message: string;
+    }): void;
+}
+
+/** Injection token for the underlying NodeUIServer instance. */
+declare const NODEUI_SERVER: unique symbol;
+
+export { NODEUI_SERVER, NodeUIModule, NodeUIService };

package/dist/index.d.ts

@@ -0,0 +1,38 @@
+import { NestModule, DynamicModule, MiddlewareConsumer } from '@nestjs/common';
+import * as _singhak_nodeui_core from '@singhak/nodeui-core';
+import { NodeUIOptions, NodeUIServer } from '@singhak/nodeui-core';
+export * from '@singhak/nodeui-core';
+
+/**
+ * NestJS adapter for the NodeUI developer console. Mounts the core middleware
+ * for every route; the console and its API live under `NODEUI_PATH` (default
+ * `/nodeui`) and app requests are recorded in the request log.
+ *
+ * @example
+ * @Module({ imports: [NodeUIModule.register()] })
+ * export class AppModule {}
+ */
+declare class NodeUIModule implements NestModule {
+    private readonly server;
+    static register(options?: NodeUIOptions): DynamicModule;
+    constructor(server: NodeUIServer);
+    configure(consumer: MiddlewareConsumer): void;
+}
+
+/** Injectable handle to the NodeUI server: record startup marks, read config. */
+declare class NodeUIService {
+    private readonly server;
+    constructor(server: NodeUIServer);
+    mark(name: string): void;
+    get config(): _singhak_nodeui_core.NodeUIConfig;
+    shutdown(): void;
+    addLogSource(entry: {
+        level: 'debug' | 'info' | 'warn' | 'error';
+        message: string;
+    }): void;
+}
+
+/** Injection token for the underlying NodeUIServer instance. */
+declare const NODEUI_SERVER: unique symbol;
+
+export { NODEUI_SERVER, NodeUIModule, NodeUIService };

package/dist/index.mjs

@@ -0,0 +1,77 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __decorateClass = (decorators, target, key, kind) => {
+  var result = kind > 1 ? void 0 : kind ? __getOwnPropDesc(target, key) : target;
+  for (var i = decorators.length - 1, decorator; i >= 0; i--)
+    if (decorator = decorators[i])
+      result = (kind ? decorator(target, key, result) : decorator(result)) || result;
+  if (kind && result) __defProp(target, key, result);
+  return result;
+};
+var __decorateParam = (index, decorator) => (target, key) => decorator(target, key, index);
+
+// src/nodeui.module.ts
+import { Inject as Inject2, Module } from "@nestjs/common";
+import { createNodeUI } from "@singhak/nodeui-core";
+
+// src/nodeui.service.ts
+import { Inject, Injectable } from "@nestjs/common";
+
+// src/tokens.ts
+var NODEUI_SERVER = /* @__PURE__ */ Symbol("NODEUI_SERVER");
+
+// src/nodeui.service.ts
+var NodeUIService = class {
+  constructor(server) {
+    this.server = server;
+  }
+  server;
+  mark(name) {
+    this.server.mark(name);
+  }
+  get config() {
+    return this.server.config;
+  }
+  shutdown() {
+    this.server.shutdown();
+  }
+  addLogSource(entry) {
+    this.server.addLogSource(entry);
+  }
+};
+NodeUIService = __decorateClass([
+  Injectable(),
+  __decorateParam(0, Inject(NODEUI_SERVER))
+], NodeUIService);
+
+// src/nodeui.module.ts
+var NodeUIModule = class {
+  constructor(server) {
+    this.server = server;
+  }
+  server;
+  static register(options) {
+    const server = createNodeUI(options);
+    return {
+      module: NodeUIModule,
+      providers: [{ provide: NODEUI_SERVER, useValue: server }, NodeUIService],
+      exports: [NodeUIService, NODEUI_SERVER]
+    };
+  }
+  configure(consumer) {
+    consumer.apply(this.server.middleware()).forRoutes("*");
+  }
+};
+NodeUIModule = __decorateClass([
+  Module({}),
+  __decorateParam(0, Inject2(NODEUI_SERVER))
+], NodeUIModule);
+
+// src/index.ts
+export * from "@singhak/nodeui-core";
+export {
+  NODEUI_SERVER,
+  NodeUIModule,
+  NodeUIService
+};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/nodeui.module.ts","../src/nodeui.service.ts","../src/tokens.ts","../src/index.ts"],"sourcesContent":["import { DynamicModule, Inject, MiddlewareConsumer, Module, NestModule } from '@nestjs/common';\nimport { createNodeUI, type NodeUIOptions, type NodeUIServer } from '@singhak/nodeui-core';\nimport { NodeUIService } from './nodeui.service';\nimport { NODEUI_SERVER } from './tokens';\n\n/**\n * NestJS adapter for the NodeUI developer console. Mounts the core middleware\n * for every route; the console and its API live under `NODEUI_PATH` (default\n * `/nodeui`) and app requests are recorded in the request log.\n *\n * @example\n * @Module({ imports: [NodeUIModule.register()] })\n * export class AppModule {}\n */\n@Module({})\nexport class NodeUIModule implements NestModule {\n  static register(options?: NodeUIOptions): DynamicModule {\n    const server = createNodeUI(options);\n    return {\n      module: NodeUIModule,\n      providers: [{ provide: NODEUI_SERVER, useValue: server }, NodeUIService],\n      exports: [NodeUIService, NODEUI_SERVER],\n    };\n  }\n\n  constructor(@Inject(NODEUI_SERVER) private readonly server: NodeUIServer) {}\n\n  configure(consumer: MiddlewareConsumer): void {\n    consumer.apply(this.server.middleware()).forRoutes('*');\n  }\n}\n","import { Inject, Injectable } from '@nestjs/common';\nimport type { NodeUIServer } from '@singhak/nodeui-core';\nimport { NODEUI_SERVER } from './tokens';\n\n/** Injectable handle to the NodeUI server: record startup marks, read config. */\n@Injectable()\nexport class NodeUIService {\n  constructor(@Inject(NODEUI_SERVER) private readonly server: NodeUIServer) {}\n\n  mark(name: string): void {\n    this.server.mark(name);\n  }\n\n  get config() {\n    return this.server.config;\n  }\n\n  shutdown(): void {\n    this.server.shutdown();\n  }\n\n  addLogSource(entry: { level: 'debug' | 'info' | 'warn' | 'error'; message: string }): void {\n    this.server.addLogSource(entry);\n  }\n}\n","/** Injection token for the underlying NodeUIServer instance. */\nexport const NODEUI_SERVER = Symbol('NODEUI_SERVER');\n","/**\n * @nodeui/nestjs — NestJS adapter for the NodeUI developer console.\n */\n\nexport { NodeUIModule } from './nodeui.module';\nexport { NodeUIService } from './nodeui.service';\nexport { NODEUI_SERVER } from './tokens';\nexport * from '@singhak/nodeui-core';\n"],"mappings":";;;;;;;;;;;;;AAAA,SAAwB,UAAAA,SAA4B,cAA0B;AAC9E,SAAS,oBAA2D;;;ACDpE,SAAS,QAAQ,kBAAkB;;;ACC5B,IAAM,gBAAgB,uBAAO,eAAe;;;ADK5C,IAAM,gBAAN,MAAoB;AAAA,EACzB,YAAoD,QAAsB;AAAtB;AAAA,EAAuB;AAAA,EAAvB;AAAA,EAEpD,KAAK,MAAoB;AACvB,SAAK,OAAO,KAAK,IAAI;AAAA,EACvB;AAAA,EAEA,IAAI,SAAS;AACX,WAAO,KAAK,OAAO;AAAA,EACrB;AAAA,EAEA,WAAiB;AACf,SAAK,OAAO,SAAS;AAAA,EACvB;AAAA,EAEA,aAAa,OAA8E;AACzF,SAAK,OAAO,aAAa,KAAK;AAAA,EAChC;AACF;AAlBa,gBAAN;AAAA,EADN,WAAW;AAAA,EAEG,0BAAO,aAAa;AAAA,GADtB;;;ADSN,IAAM,eAAN,MAAyC;AAAA,EAU9C,YAAoD,QAAsB;AAAtB;AAAA,EAAuB;AAAA,EAAvB;AAAA,EATpD,OAAO,SAAS,SAAwC;AACtD,UAAM,SAAS,aAAa,OAAO;AACnC,WAAO;AAAA,MACL,QAAQ;AAAA,MACR,WAAW,CAAC,EAAE,SAAS,eAAe,UAAU,OAAO,GAAG,aAAa;AAAA,MACvE,SAAS,CAAC,eAAe,aAAa;AAAA,IACxC;AAAA,EACF;AAAA,EAIA,UAAU,UAAoC;AAC5C,aAAS,MAAM,KAAK,OAAO,WAAW,CAAC,EAAE,UAAU,GAAG;AAAA,EACxD;AACF;AAfa,eAAN;AAAA,EADN,OAAO,CAAC,CAAC;AAAA,EAWK,mBAAAC,QAAO,aAAa;AAAA,GAVtB;;;AGRb,cAAc;","names":["Inject","Inject"]}

package/package.json

@@ -0,0 +1,76 @@
+{
+  "name": "@singhak/nodeui-nestjs",
+  "version": "0.1.0",
+  "description": "NestJS module 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": [
+    "nestjs",
+    "module",
+    "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": {
+    "@nestjs/common": "^11.0.0",
+    "@nestjs/core": "^11.0.0",
+    "reflect-metadata": "^0.2.0",
+    "rxjs": "^7.8.0"
+  },
+  "devDependencies": {
+    "@nestjs/common": "^11.2.1",
+    "@nestjs/core": "^11.2.1",
+    "@nestjs/platform-express": "^11.2.1",
+    "@nestjs/testing": "^11.2.1",
+    "@types/express": "^5.0.0",
+    "@types/node": "^22.19.0",
+    "@types/supertest": "^6.0.2",
+    "express": "^5.2.1",
+    "reflect-metadata": "^0.2.2",
+    "rxjs": "^7.8.2",
+    "supertest": "^7.1.0",
+    "tsup": "^8.5.0",
+    "typescript": "^5.9.3",
+    "vitest": "^3.2.4"
+  },
+  "author": "Anil Kumar",
+  "type": "commonjs"
+}