@easydocs/nestjs 0.1.4

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 EasyDocs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,66 @@
+# @easydocs/nestjs
+
+EasyDocs module for [NestJS](https://nestjs.com/).
+
+## Install
+
+```bash
+npm install @easydocs/nestjs
+```
+
+## Usage
+
+```ts
+import { Module } from '@nestjs/common'
+import { EasyDocsModule } from '@easydocs/nestjs'
+
+@Module({
+  imports: [
+    EasyDocsModule.forRoot({
+      ai: { provider: 'anthropic' },
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+That's it. A global interceptor is automatically registered. Every controller response is captured in the background.
+
+## Per-controller or per-route
+
+```ts
+import { UseInterceptors } from '@nestjs/common'
+import { EasyDocsInterceptor } from '@easydocs/nestjs'
+
+// Skip the forRoot() import and use selectively:
+@UseInterceptors(EasyDocsInterceptor)
+@Controller('users')
+export class UsersController {}
+```
+
+## Configuration
+
+```ts
+EasyDocsModule.forRoot({
+  ai: {
+    provider: 'openai', // 'openai' | 'anthropic' | 'ollama'
+    model: 'gpt-4o',
+    apiKey: process.env.OPENAI_API_KEY,
+  },
+  capture: {
+    ignoreRoutes: ['/health', '/api/metrics'],
+  },
+})
+```
+
+## View your docs
+
+```bash
+npm install -D @easydocs/dashboard
+npx easydocs dashboard
+
+# Or export to a file
+npx easydocs export > openapi.json
+```
+
+See [@easydocs/core](../core) for the full configuration reference.

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+import { DynamicModule, NestInterceptor, ExecutionContext, CallHandler } from '@nestjs/common';
+import { EasyDocsConfig } from '@easydocs/core';
+import { Observable } from 'rxjs';
+
+declare class EasyDocsModule {
+    static forRoot(config?: EasyDocsConfig): DynamicModule;
+}
+
+declare const EASYDOCS_CONFIG: unique symbol;
+declare class EasyDocsInterceptor implements NestInterceptor {
+    private readonly config;
+    constructor(config: EasyDocsConfig);
+    intercept(context: ExecutionContext, next: CallHandler): Observable<unknown>;
+}
+
+export { EASYDOCS_CONFIG, EasyDocsInterceptor, EasyDocsModule };

package/dist/index.js

@@ -0,0 +1,111 @@
+"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 __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, {
+  EASYDOCS_CONFIG: () => EASYDOCS_CONFIG,
+  EasyDocsInterceptor: () => EasyDocsInterceptor,
+  EasyDocsModule: () => EasyDocsModule
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/module.ts
+var import_common2 = require("@nestjs/common");
+var import_core2 = require("@nestjs/core");
+
+// src/interceptor.ts
+var import_common = require("@nestjs/common");
+var import_rxjs = require("rxjs");
+var import_core = require("@easydocs/core");
+var EASYDOCS_CONFIG = /* @__PURE__ */ Symbol("EASYDOCS_CONFIG");
+var EasyDocsInterceptor = class {
+  constructor(config) {
+    this.config = config;
+  }
+  intercept(context, next) {
+    const startedAt = Date.now();
+    const http = context.switchToHttp();
+    const req = http.getRequest();
+    const res = http.getResponse();
+    return next.handle().pipe(
+      (0, import_rxjs.tap)((responseBody) => {
+        const routePath = req.route?.path ?? req.path;
+        (0, import_core.capture)(
+          {
+            method: req.method,
+            path: routePath,
+            query: req.query,
+            params: req.params,
+            body: req.body,
+            response: responseBody,
+            status: res.statusCode,
+            requestHeaders: req.headers,
+            responseHeaders: res.getHeaders(),
+            durationMs: Date.now() - startedAt
+          },
+          this.config
+        );
+      })
+    );
+  }
+};
+EasyDocsInterceptor = __decorateClass([
+  (0, import_common.Injectable)(),
+  __decorateParam(0, (0, import_common.Inject)(EASYDOCS_CONFIG))
+], EasyDocsInterceptor);
+
+// src/module.ts
+var EasyDocsModule = class {
+  static forRoot(config = {}) {
+    return {
+      module: EasyDocsModule,
+      global: true,
+      providers: [
+        {
+          provide: EASYDOCS_CONFIG,
+          useValue: config
+        },
+        {
+          provide: import_core2.APP_INTERCEPTOR,
+          useClass: EasyDocsInterceptor
+        }
+      ]
+    };
+  }
+};
+EasyDocsModule = __decorateClass([
+  (0, import_common2.Module)({})
+], EasyDocsModule);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  EASYDOCS_CONFIG,
+  EasyDocsInterceptor,
+  EasyDocsModule
+});
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/module.ts","../src/interceptor.ts"],"sourcesContent":["export { EasyDocsModule } from './module'\nexport { EasyDocsInterceptor, EASYDOCS_CONFIG } from './interceptor'\n","import { Module, DynamicModule } from '@nestjs/common'\nimport { APP_INTERCEPTOR } from '@nestjs/core'\nimport { EasyDocsInterceptor, EASYDOCS_CONFIG } from './interceptor'\nimport type { EasyDocsConfig } from '@easydocs/core'\n\n@Module({})\nexport class EasyDocsModule {\n  static forRoot(config: EasyDocsConfig = {}): DynamicModule {\n    return {\n      module: EasyDocsModule,\n      global: true,\n      providers: [\n        {\n          provide: EASYDOCS_CONFIG,\n          useValue: config,\n        },\n        {\n          provide: APP_INTERCEPTOR,\n          useClass: EasyDocsInterceptor,\n        },\n      ],\n    }\n  }\n}\n","import {\n  Injectable,\n  NestInterceptor,\n  ExecutionContext,\n  CallHandler,\n  Inject,\n} from '@nestjs/common'\nimport { Observable, tap } from 'rxjs'\nimport { capture } from '@easydocs/core'\nimport type { EasyDocsConfig, HttpMethod } from '@easydocs/core'\n\ninterface HttpRequest {\n  method: string\n  path: string\n  route?: { path?: string }\n  query: Record<string, string>\n  params: Record<string, string>\n  body: unknown\n  headers: Record<string, string>\n}\n\ninterface HttpResponse {\n  statusCode: number\n  getHeaders(): Record<string, unknown>\n}\n\nexport const EASYDOCS_CONFIG = Symbol('EASYDOCS_CONFIG')\n\n@Injectable()\nexport class EasyDocsInterceptor implements NestInterceptor {\n  constructor(@Inject(EASYDOCS_CONFIG) private readonly config: EasyDocsConfig) {}\n\n  intercept(context: ExecutionContext, next: CallHandler): Observable<unknown> {\n    const startedAt = Date.now()\n    const http = context.switchToHttp()\n    const req = http.getRequest<HttpRequest>()\n    const res = http.getResponse<HttpResponse>()\n\n    return next.handle().pipe(\n      tap((responseBody: unknown) => {\n        const routePath = req.route?.path ?? req.path\n\n        capture(\n          {\n            method: req.method as HttpMethod,\n            path: routePath,\n            query: req.query as Record<string, string>,\n            params: req.params as Record<string, string>,\n            body: req.body,\n            response: responseBody,\n            status: res.statusCode,\n            requestHeaders: req.headers as Record<string, string>,\n            responseHeaders: res.getHeaders() as Record<string, string>,\n            durationMs: Date.now() - startedAt,\n          },\n          this.config\n        )\n      })\n    )\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,IAAAA,iBAAsC;AACtC,IAAAC,eAAgC;;;ACDhC,oBAMO;AACP,kBAAgC;AAChC,kBAAwB;AAkBjB,IAAM,kBAAkB,uBAAO,iBAAiB;AAGhD,IAAM,sBAAN,MAAqD;AAAA,EAC1D,YAAsD,QAAwB;AAAxB;AAAA,EAAyB;AAAA,EAE/E,UAAU,SAA2B,MAAwC;AAC3E,UAAM,YAAY,KAAK,IAAI;AAC3B,UAAM,OAAO,QAAQ,aAAa;AAClC,UAAM,MAAM,KAAK,WAAwB;AACzC,UAAM,MAAM,KAAK,YAA0B;AAE3C,WAAO,KAAK,OAAO,EAAE;AAAA,UACnB,iBAAI,CAAC,iBAA0B;AAC7B,cAAM,YAAY,IAAI,OAAO,QAAQ,IAAI;AAEzC;AAAA,UACE;AAAA,YACE,QAAQ,IAAI;AAAA,YACZ,MAAM;AAAA,YACN,OAAO,IAAI;AAAA,YACX,QAAQ,IAAI;AAAA,YACZ,MAAM,IAAI;AAAA,YACV,UAAU;AAAA,YACV,QAAQ,IAAI;AAAA,YACZ,gBAAgB,IAAI;AAAA,YACpB,iBAAiB,IAAI,WAAW;AAAA,YAChC,YAAY,KAAK,IAAI,IAAI;AAAA,UAC3B;AAAA,UACA,KAAK;AAAA,QACP;AAAA,MACF,CAAC;AAAA,IACH;AAAA,EACF;AACF;AA/Ba,sBAAN;AAAA,MADN,0BAAW;AAAA,EAEG,6CAAO,eAAe;AAAA,GADxB;;;ADvBN,IAAM,iBAAN,MAAqB;AAAA,EAC1B,OAAO,QAAQ,SAAyB,CAAC,GAAkB;AACzD,WAAO;AAAA,MACL,QAAQ;AAAA,MACR,QAAQ;AAAA,MACR,WAAW;AAAA,QACT;AAAA,UACE,SAAS;AAAA,UACT,UAAU;AAAA,QACZ;AAAA,QACA;AAAA,UACE,SAAS;AAAA,UACT,UAAU;AAAA,QACZ;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;AAjBa,iBAAN;AAAA,MADN,uBAAO,CAAC,CAAC;AAAA,GACG;","names":["import_common","import_core"]}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@easydocs/nestjs",
+  "version": "0.1.4",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "description": "EasyDocs module for NestJS",
+  "type": "commonjs",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "dependencies": {
+    "@easydocs/core": "0.1.4"
+  },
+  "peerDependencies": {
+    "@nestjs/common": ">=10.0.0",
+    "@nestjs/core": ">=10.0.0",
+    "rxjs": ">=7.0.0"
+  },
+  "devDependencies": {
+    "@nestjs/common": "^11.0.0",
+    "@nestjs/core": "^11.0.0",
+    "rxjs": "^7.8.0",
+    "tsup": "^8.3.0",
+    "typescript": "^5"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit"
+  }
+}