@easydocs/nestjs 0.5.0 → 0.5.4

package/{LICENSE.md → LICENSE}

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 EasyDocs
+Copyright (c) 2025 Ruben González Alonso
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -9,13 +9,13 @@ 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 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.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -28,11 +28,26 @@ That's it. A global interceptor is automatically registered. Every controller re
 
 ## Per-controller or per-route
 
+`EasyDocsInterceptor` requires the `EASYDOCS_CAPTURER` DI token to be provided. The easiest way is to still import `EasyDocsModule.forRoot()` globally (which registers the token), then apply the interceptor manually on specific controllers instead of relying on the global one.
+
+If you want full control without `forRoot()`, provide the token yourself:
+
 ```ts
-import { UseInterceptors } from '@nestjs/common'
-import { EasyDocsInterceptor } from '@easydocs/nestjs'
+import { Module } from '@nestjs/common'
+import { UseInterceptors, Controller } from '@nestjs/common'
+import { EasyDocsInterceptor, EASYDOCS_CAPTURER } from '@easydocs/nestjs'
+import { createCapturer, parseConfig } from '@easydocs/core'
+
+@Module({
+  providers: [
+    {
+      provide: EASYDOCS_CAPTURER,
+      useValue: createCapturer(parseConfig({ project: 'my-api' })),
+    },
+  ],
+})
+export class UsersModule {}
 
-// Skip the forRoot() import and use selectively:
 @UseInterceptors(EasyDocsInterceptor)
 @Controller('users')
 export class UsersController {}

package/dist/index.d.ts

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

package/dist/index.js

@@ -23,7 +23,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
-  EASYDOCS_CONFIG: () => EASYDOCS_CONFIG,
+  EASYDOCS_CAPTURER: () => EASYDOCS_CAPTURER,
   EasyDocsInterceptor: () => EasyDocsInterceptor,
   EasyDocsModule: () => EasyDocsModule
 });
@@ -54,11 +54,11 @@ function _ts_param(paramIndex, decorator) {
   };
 }
 __name(_ts_param, "_ts_param");
-var EASYDOCS_CONFIG = /* @__PURE__ */ Symbol("EASYDOCS_CONFIG");
+var EASYDOCS_CAPTURER = /* @__PURE__ */ Symbol("EASYDOCS_CAPTURER");
 var _EasyDocsInterceptor = class _EasyDocsInterceptor {
-  constructor(config) {
-    __publicField(this, "config");
-    this.config = config;
+  constructor(capturer) {
+    __publicField(this, "capturer");
+    this.capturer = capturer;
   }
   intercept(context, next) {
     const startedAt = Date.now();
@@ -66,7 +66,7 @@ var _EasyDocsInterceptor = class _EasyDocsInterceptor {
     const req = http.getRequest();
     const res = http.getResponse();
     return next.handle().pipe((0, import_rxjs.tap)((responseBody) => {
-      (0, import_core.capture)((0, import_core.buildCaptureEvent)({
+      this.capturer.capture((0, import_core.buildCaptureEvent)({
         method: req.method,
         path: req.route?.path ?? req.path,
         query: req.query,
@@ -77,7 +77,7 @@ var _EasyDocsInterceptor = class _EasyDocsInterceptor {
         requestHeaders: req.headers,
         responseHeaders: res.getHeaders(),
         durationMs: Date.now() - startedAt
-      }), this.config);
+      }));
     }));
   }
 };
@@ -85,10 +85,10 @@ __name(_EasyDocsInterceptor, "EasyDocsInterceptor");
 var EasyDocsInterceptor = _EasyDocsInterceptor;
 EasyDocsInterceptor = _ts_decorate([
   (0, import_common.Injectable)(),
-  _ts_param(0, (0, import_common.Inject)(EASYDOCS_CONFIG)),
+  _ts_param(0, (0, import_common.Inject)(EASYDOCS_CAPTURER)),
   _ts_metadata("design:type", Function),
   _ts_metadata("design:paramtypes", [
-    typeof EasyDocsConfig === "undefined" ? Object : EasyDocsConfig
+    typeof Capturer === "undefined" ? Object : Capturer
   ])
 ], EasyDocsInterceptor);
 
@@ -103,14 +103,14 @@ function _ts_decorate2(decorators, target, key, desc) {
 __name(_ts_decorate2, "_ts_decorate");
 var _EasyDocsModule = class _EasyDocsModule {
   static forRoot(config = {}) {
-    const parsedConfig = (0, import_core3.parseConfig)(config);
+    const capturer = (0, import_core3.createCapturer)((0, import_core3.parseConfig)(config));
     return {
       module: _EasyDocsModule,
       global: true,
       providers: [
         {
-          provide: EASYDOCS_CONFIG,
-          useValue: parsedConfig
+          provide: EASYDOCS_CAPTURER,
+          useValue: capturer
         },
         {
           provide: import_core2.APP_INTERCEPTOR,
@@ -127,7 +127,7 @@ EasyDocsModule = _ts_decorate2([
 ], EasyDocsModule);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  EASYDOCS_CONFIG,
+  EASYDOCS_CAPTURER,
   EasyDocsInterceptor,
   EasyDocsModule
 });

package/dist/index.js.map

@@ -1 +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 { parseConfig } from '@easydocs/core'\nimport type { EasyDocsConfig } from '@easydocs/core'\n\n@Module({})\nexport class EasyDocsModule {\n  static forRoot(config: EasyDocsConfig = {}): DynamicModule {\n    const parsedConfig = parseConfig(config)\n    return {\n      module: EasyDocsModule,\n      global: true,\n      providers: [\n        {\n          provide: EASYDOCS_CONFIG,\n          useValue: parsedConfig,\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, buildCaptureEvent } from '@easydocs/core'\nimport type { EasyDocsConfig } 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        capture(\n          buildCaptureEvent({\n            method: req.method,\n            path: req.route?.path ?? req.path,\n            query: req.query as Record<string, unknown>,\n            params: req.params as Record<string, unknown>,\n            requestBody: req.body,\n            responseBody,\n            status: res.statusCode,\n            requestHeaders: req.headers as Record<string, unknown>,\n            responseHeaders: res.getHeaders() as Record<string, unknown>,\n            durationMs: Date.now() - startedAt,\n          }),\n          this.config\n        )\n      })\n    )\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAAA;;;;;;;;;ACAA,IAAAA,iBAAsC;AACtC,IAAAC,eAAgC;;;ACDhC,oBAMO;AACP,kBAAgC;AAChC,kBAA2C;;;;;;;;;;;;;;;;;;AAkBpC,IAAMC,kBAAkBC,uBAAO,iBAAA;AAG/B,IAAMC,uBAAN,MAAMA,qBAAAA;EACX,YAAsDC,QAAwB;;SAAxBA,SAAAA;EAAyB;EAE/EC,UAAUC,SAA2BC,MAAwC;AAC3E,UAAMC,YAAYC,KAAKC,IAAG;AAC1B,UAAMC,OAAOL,QAAQM,aAAY;AACjC,UAAMC,MAAMF,KAAKG,WAAU;AAC3B,UAAMC,MAAMJ,KAAKK,YAAW;AAE5B,WAAOT,KAAKU,OAAM,EAAGC,SACnBC,iBAAI,CAACC,iBAAAA;AACHC,mCACEC,+BAAkB;QAChBC,QAAQV,IAAIU;QACZC,MAAMX,IAAIY,OAAOD,QAAQX,IAAIW;QAC7BE,OAAOb,IAAIa;QACXC,QAAQd,IAAIc;QACZC,aAAaf,IAAIgB;QACjBT;QACAU,QAAQf,IAAIgB;QACZC,gBAAgBnB,IAAIoB;QACpBC,iBAAiBnB,IAAIoB,WAAU;QAC/BC,YAAY3B,KAAKC,IAAG,IAAKF;MAC3B,CAAA,GACA,KAAKJ,MAAM;IAEf,CAAA,CAAA;EAEJ;AACF;AA7BaD;AAAN,IAAMA,sBAAN;;;;;;;;;;;AD1BP,IAAAkC,eAA4B;;;;;;;;AAIrB,IAAMC,kBAAN,MAAMA,gBAAAA;EACX,OAAOC,QAAQC,SAAyB,CAAC,GAAkB;AACzD,UAAMC,mBAAeC,0BAAYF,MAAAA;AACjC,WAAO;MACLG,QAAQL;MACRM,QAAQ;MACRC,WAAW;QACT;UACEC,SAASC;UACTC,UAAUP;QACZ;QACA;UACEK,SAASG;UACTC,UAAUC;QACZ;;IAEJ;EACF;AACF;AAlBab;AAAN,IAAMA,iBAAN;;;;","names":["import_common","import_core","EASYDOCS_CONFIG","Symbol","EasyDocsInterceptor","config","intercept","context","next","startedAt","Date","now","http","switchToHttp","req","getRequest","res","getResponse","handle","pipe","tap","responseBody","capture","buildCaptureEvent","method","path","route","query","params","requestBody","body","status","statusCode","requestHeaders","headers","responseHeaders","getHeaders","durationMs","import_core","EasyDocsModule","forRoot","config","parsedConfig","parseConfig","module","global","providers","provide","EASYDOCS_CONFIG","useValue","APP_INTERCEPTOR","useClass","EasyDocsInterceptor"]}
+{"version":3,"sources":["../src/index.ts","../src/module.ts","../src/interceptor.ts"],"sourcesContent":["export { EasyDocsModule } from './module'\nexport { EasyDocsInterceptor, EASYDOCS_CAPTURER } from './interceptor'\n","import { Module, DynamicModule } from '@nestjs/common'\nimport { APP_INTERCEPTOR } from '@nestjs/core'\nimport { EasyDocsInterceptor, EASYDOCS_CAPTURER } from './interceptor'\nimport { parseConfig, createCapturer } from '@easydocs/core'\nimport type { EasyDocsConfig } from '@easydocs/core'\n\n@Module({})\nexport class EasyDocsModule {\n  static forRoot(config: EasyDocsConfig = {}): DynamicModule {\n    const capturer = createCapturer(parseConfig(config))\n    return {\n      module: EasyDocsModule,\n      global: true,\n      providers: [\n        {\n          provide: EASYDOCS_CAPTURER,\n          useValue: capturer,\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 { buildCaptureEvent } from '@easydocs/core'\nimport type { Capturer } 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_CAPTURER = Symbol('EASYDOCS_CAPTURER')\n\n@Injectable()\nexport class EasyDocsInterceptor implements NestInterceptor {\n  constructor(@Inject(EASYDOCS_CAPTURER) private readonly capturer: Capturer) {}\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        this.capturer.capture(\n          buildCaptureEvent({\n            method: req.method,\n            path: req.route?.path ?? req.path,\n            query: req.query as Record<string, unknown>,\n            params: req.params as Record<string, unknown>,\n            requestBody: req.body,\n            responseBody,\n            status: res.statusCode,\n            requestHeaders: req.headers as Record<string, unknown>,\n            responseHeaders: res.getHeaders() as Record<string, unknown>,\n            durationMs: Date.now() - startedAt,\n          })\n        )\n      })\n    )\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAAA;;;;;;;;;ACAA,IAAAA,iBAAsC;AACtC,IAAAC,eAAgC;;;ACDhC,oBAMO;AACP,kBAAgC;AAChC,kBAAkC;;;;;;;;;;;;;;;;;;AAkB3B,IAAMC,oBAAoBC,uBAAO,mBAAA;AAGjC,IAAMC,uBAAN,MAAMA,qBAAAA;EACX,YAAwDC,UAAoB;;SAApBA,WAAAA;EAAqB;EAE7EC,UAAUC,SAA2BC,MAAwC;AAC3E,UAAMC,YAAYC,KAAKC,IAAG;AAC1B,UAAMC,OAAOL,QAAQM,aAAY;AACjC,UAAMC,MAAMF,KAAKG,WAAU;AAC3B,UAAMC,MAAMJ,KAAKK,YAAW;AAE5B,WAAOT,KAAKU,OAAM,EAAGC,SACnBC,iBAAI,CAACC,iBAAAA;AACH,WAAKhB,SAASiB,YACZC,+BAAkB;QAChBC,QAAQV,IAAIU;QACZC,MAAMX,IAAIY,OAAOD,QAAQX,IAAIW;QAC7BE,OAAOb,IAAIa;QACXC,QAAQd,IAAIc;QACZC,aAAaf,IAAIgB;QACjBT;QACAU,QAAQf,IAAIgB;QACZC,gBAAgBnB,IAAIoB;QACpBC,iBAAiBnB,IAAIoB,WAAU;QAC/BC,YAAY3B,KAAKC,IAAG,IAAKF;MAC3B,CAAA,CAAA;IAEJ,CAAA,CAAA;EAEJ;AACF;AA5BaL;AAAN,IAAMA,sBAAN;;;;;;;;;;;AD1BP,IAAAkC,eAA4C;;;;;;;;AAIrC,IAAMC,kBAAN,MAAMA,gBAAAA;EACX,OAAOC,QAAQC,SAAyB,CAAC,GAAkB;AACzD,UAAMC,eAAWC,iCAAeC,0BAAYH,MAAAA,CAAAA;AAC5C,WAAO;MACLI,QAAQN;MACRO,QAAQ;MACRC,WAAW;QACT;UACEC,SAASC;UACTC,UAAUR;QACZ;QACA;UACEM,SAASG;UACTC,UAAUC;QACZ;;IAEJ;EACF;AACF;AAlBad;AAAN,IAAMA,iBAAN;;;;","names":["import_common","import_core","EASYDOCS_CAPTURER","Symbol","EasyDocsInterceptor","capturer","intercept","context","next","startedAt","Date","now","http","switchToHttp","req","getRequest","res","getResponse","handle","pipe","tap","responseBody","capture","buildCaptureEvent","method","path","route","query","params","requestBody","body","status","statusCode","requestHeaders","headers","responseHeaders","getHeaders","durationMs","import_core","EasyDocsModule","forRoot","config","capturer","createCapturer","parseConfig","module","global","providers","provide","EASYDOCS_CAPTURER","useValue","APP_INTERCEPTOR","useClass","EasyDocsInterceptor"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easydocs/nestjs",
-  "version": "0.5.0",
+  "version": "0.5.4",
   "files": [
     "dist",
     "README.md"
@@ -16,7 +16,7 @@
     }
   },
   "dependencies": {
-    "@easydocs/core": "0.5.0"
+    "@easydocs/core": "0.5.4"
   },
   "peerDependencies": {
     "@nestjs/common": ">=10.0.0",
@@ -29,7 +29,13 @@
     "rxjs": "^7.8.0",
     "tsup": "^8.3.0",
     "typescript": "^5",
-    "vitest": "^2.1.9"
+    "vite": "8.0.13",
+    "vitest": "^4.1.6"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/RubenGlez/easydocs",
+    "directory": ""
   },
   "scripts": {
     "build": "tsup",