nest-devtools 0.1.2 → 0.1.3

package/README.md

@@ -0,0 +1,212 @@
+# nest-devtools
+
+A zero-config developer dashboard for NestJS applications.
+
+`nest-devtools` mounts a browser UI inside your Nest app so you can watch logs and HTTP requests in real time while developing.
+
+## Features
+
+- Zero-config module setup with `DevtoolsModule.forRoot()`
+- Live logs captured from Nest `Logger` and `ConsoleLogger`
+- Live HTTP request tracing with method, path, status, duration, and redacted headers
+- In-memory circular-style buffers for logs and requests
+- Embedded dashboard UI served by your Nest app
+- Raw WebSocket live updates, no frontend framework required
+- Auto-disabled when `NODE_ENV === 'production'`
+
+## Compatibility
+
+- NestJS `^10.0.0 || ^11.0.0`
+- `reflect-metadata` `^0.1.12 || ^0.2.0`
+- `rxjs` `^7.8.0`
+
+## Install
+
+```bash
+npm i nest-devtools
+```
+
+If you are testing the package locally before publishing a new version, install it from the repo instead of npm:
+
+```bash
+npm i /absolute/path/to/nest-devtool
+```
+
+Or pack it first and install the generated tarball:
+
+```bash
+npm pack
+npm i ./nest-devtools-0.1.2.tgz
+```
+
+## Quick Start
+
+Import the module in your app module:
+
+```ts
+import { Module } from '@nestjs/common';
+import { DevtoolsModule } from 'nest-devtools';
+
+@Module({
+  imports: [DevtoolsModule.forRoot()],
+})
+export class AppModule {}
+```
+
+Start your app and open:
+
+```txt
+http://localhost:3000/__devtools__
+```
+
+That is enough for the dashboard to start collecting:
+
+- Nest logs
+- request traces
+- live updates through the built-in WebSocket endpoint
+
+## Configuration
+
+```ts
+import { Module } from '@nestjs/common';
+import { DevtoolsModule } from 'nest-devtools';
+
+@Module({
+  imports: [
+    DevtoolsModule.forRoot({
+      maxLogs: 500,
+      maxRequests: 500,
+      path: '__devtools__',
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+### Options
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `maxLogs` | `number` | `500` | Maximum number of log entries kept in memory |
+| `maxRequests` | `number` | `500` | Maximum number of request entries kept in memory |
+| `path` | `string` | `__devtools__` | Base path used for the dashboard and API routes |
+
+Examples:
+
+- `path: '__devtools__'` -> `/__devtools__`
+- `path: '/inspect/'` -> `/inspect`
+- `path: 'internal/devtools'` -> `/internal/devtools`
+
+## How To Use It
+
+Once your Nest app is running:
+
+1. Open the dashboard URL in your browser.
+2. Hit your normal API routes from Postman, your frontend, curl, or the browser.
+3. Watch logs and requests appear live in the dashboard.
+
+### Logs Tab
+
+- Shows `log`, `warn`, `error`, `debug`, and `verbose`
+- Includes timestamp, level, context, and message
+- Supports client-side search and level filters
+- Can be cleared from the UI
+
+### Requests Tab
+
+- Shows timestamp, method, path, status, and duration
+- Streams requests live as they finish
+- Lets you filter by HTTP method and status range
+- Expands each row to show the full path and captured headers
+
+## What Gets Captured
+
+### Logs
+
+The package captures logs that go through Nest's built-in logging path:
+
+- `Logger.log()`
+- `Logger.warn()`
+- `Logger.error()`
+- `Logger.debug()`
+- `Logger.verbose()`
+- direct `ConsoleLogger` usage
+
+### Requests
+
+The package captures HTTP requests handled by Nest and stores:
+
+- method
+- path
+- status code
+- duration in milliseconds
+- timestamp
+- optional request headers
+
+Sensitive headers are redacted:
+
+- `authorization`
+- `cookie`
+- `set-cookie`
+- `proxy-authorization`
+- `x-api-key`
+
+## Routes
+
+With the default path, the module exposes:
+
+| Method | Path | Description |
+| --- | --- | --- |
+| `GET` | `/__devtools__` | Dashboard UI |
+| `GET` | `/__devtools__/api/logs` | Current log buffer |
+| `GET` | `/__devtools__/api/requests` | Current request buffer |
+| `DELETE` | `/__devtools__/api/logs` | Clear logs |
+| `DELETE` | `/__devtools__/api/requests` | Clear requests |
+| `WS` | `/__devtools__/ws` | Live realtime stream |
+
+## Production Behavior
+
+If `NODE_ENV === 'production'`, `DevtoolsModule.forRoot()` becomes a no-op:
+
+- no dashboard route
+- no API endpoints
+- no request interceptor
+- no logger patching
+- no WebSocket listener
+
+## Notes
+
+- Everything is in memory only.
+- The dashboard does not persist data across restarts.
+- The dashboard skips recording its own requests to avoid self-noise.
+- This package is intended for development, not production monitoring.
+
+## Example App In This Repo
+
+Run the included example app:
+
+```bash
+npm install
+npm run example:start
+```
+
+Then open:
+
+```txt
+http://localhost:3000/__devtools__
+```
+
+Useful example routes:
+
+- `GET /`
+- `GET /users/123`
+- `GET /warn`
+- `GET /fail`
+
+## Development
+
+```bash
+npm install
+npm run build
+npm test
+```

package/dist/dashboard/index.html.js

@@ -635,7 +635,7 @@ const DASHBOARD_TEMPLATE = `<!DOCTYPE html>
     </div>
 
     <script>
-      window.__NEST_DEVTOOLS_CONFIG__ = __NEST_DEVTOOLS_CONFIG__;
+      window.__NEST_DEVTOOLS_CONFIG__ = __NEST_DEVTOOLS_JSON__;
 
       (function () {
         var config = window.__NEST_DEVTOOLS_CONFIG__;
@@ -1045,7 +1045,7 @@ const DASHBOARD_TEMPLATE = `<!DOCTYPE html>
   </body>
 </html>`;
 function renderDashboardHtml(basePath) {
-    return DASHBOARD_TEMPLATE.replace('__NEST_DEVTOOLS_CONFIG__', JSON.stringify({
+    return DASHBOARD_TEMPLATE.replace('__NEST_DEVTOOLS_JSON__', JSON.stringify({
         basePath,
     }));
 }

package/dist/dashboard/index.html.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.html.js","sourceRoot":"","sources":["../../src/dashboard/index.html.ts"],"names":[],"mappings":";;AAohCA,kDAOC;AA3hCD,MAAM,kBAAkB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAkhCnB,CAAC;AAET,SAAgB,mBAAmB,CAAC,QAAgB;IAClD,OAAO,kBAAkB,CAAC,OAAO,CAC/B,0BAA0B,EAC1B,IAAI,CAAC,SAAS,CAAC;QACb,QAAQ;KACT,CAAC,CACH,CAAC;AACJ,CAAC"}
+{"version":3,"file":"index.html.js","sourceRoot":"","sources":["../../src/dashboard/index.html.ts"],"names":[],"mappings":";;AAohCA,kDAOC;AA3hCD,MAAM,kBAAkB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAkhCnB,CAAC;AAET,SAAgB,mBAAmB,CAAC,QAAgB;IAClD,OAAO,kBAAkB,CAAC,OAAO,CAC/B,wBAAwB,EACxB,IAAI,CAAC,SAAS,CAAC;QACb,QAAQ;KACT,CAAC,CACH,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nest-devtools",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "A zero-config developer dashboard for NestJS applications.",
   "license": "MIT",
   "main": "dist/index.js",