@adatechnology/logger 0.0.6 → 0.0.7

package/README.md

@@ -16,17 +16,17 @@ import { LoggerModule } from "@adatechnology/logger";
   imports: [
     // Opção 1: Configuração estática (forRoot)
     LoggerModule.forRoot({
-      level: 'debug',
-      context: 'MyService',
-      isProduction: process.env.NODE_ENV === 'production',
+      level: "debug",
+      context: "MyService",
+      isProduction: process.env.NODE_ENV === "production",
       colorize: true,
     }),
 
     // Opção 2: Configuração dinâmica (forRootAsync)
     LoggerModule.forRootAsync({
       useFactory: (configService: ConfigService) => ({
-        level: configService.get('LOG_LEVEL'),
-        isProduction: configService.get('NODE_ENV') === 'production',
+        level: configService.get("LOG_LEVEL"),
+        isProduction: configService.get("NODE_ENV") === "production",
       }),
       inject: [ConfigService],
     }),
@@ -92,9 +92,11 @@ Se quiser, eu adiciono um exemplo de teste unitário para validar o comportament
 Este pacote implementa um formato de log padronizado para todo o monorepo, facilitando o rastreamento de chamadas entre múltiplas bibliotecas e serviços.
 
 ### Formato Final
+
 `[App-name@version][lib-name:version][requestId][timestamp][source][libMethod][LEVEL] - message - {payload}`
 
 ### Propriedades do Payload
+
 Ao realizar um log, você pode passar as seguintes propriedades para enriquecer o contexto:
 
 - `message`: A mensagem principal do log.
@@ -105,7 +107,46 @@ Ao realizar um log, você pode passar as seguintes propriedades para enriquecer
 - `libMethod`: O método interno da biblioteca sendo executado. Ex: `get`.
 - `meta`: Objeto com metadados adicionais (será exibido em uma única linha compacta).
 
+> ✅ **Padrão recomendado:** enviar payload estruturado em `meta`.
+>
+> ⚠️ **Compatibilidade legada:** payload em `params` ainda é aceito e promovido para `meta` internamente para não quebrar serviços antigos.
+
+### `meta` vs `params` (recomendação)
+
+Use `meta` para todo conteúdo estruturado de log (request/response/error/details).
+
+Exemplo recomendado:
+
+```ts
+this.logger.error({
+  message: "Exception caught in filter",
+  context: "HttpExceptionFilter.logResponse",
+  requestId,
+  meta: {
+    request: { path, method, headers, params, query, body },
+    response: { status, headers, messages },
+    error: { type, message, status, body, details },
+  },
+});
+```
+
+Exemplo legado (ainda funciona, mas evite em código novo):
+
+```ts
+this.logger.error({
+  message: "Exception caught in filter",
+  context: "HttpExceptionFilter.logResponse",
+  requestId,
+  params: {
+    request: { path, method, headers, params, query, body },
+    response: { status, headers, messages },
+    error: { type, message, status, body, details },
+  },
+});
+```
+
 ### Exemplo de Log de Biblioteca
+
 Para uma biblioteca que segue o padrão:
 
 ```ts
@@ -128,13 +169,13 @@ Resultado visual:
 O pacote oferece um middleware `RequestContextMiddleware` que injeta um `requestId` (a partir do header `x-request-id` ou gerando um UUID) e executa a request dentro de um contexto assíncrono (AsyncLocalStorage). Para usá-lo no NestJS:
 
 ```ts
-import { MiddlewareConsumer, Module, NestModule } from '@nestjs/common';
-import { RequestContextMiddleware, LoggerModule } from '@adatechnology/logger';
+import { MiddlewareConsumer, Module, NestModule } from "@nestjs/common";
+import { RequestContextMiddleware, LoggerModule } from "@adatechnology/logger";
 
 @Module({ imports: [LoggerModule.forRoot()] })
 export class AppModule implements NestModule {
   configure(consumer: MiddlewareConsumer) {
-    consumer.apply(RequestContextMiddleware).forRoutes('*');
+    consumer.apply(RequestContextMiddleware).forRoutes("*");
   }
 }
 ```
@@ -146,6 +187,5 @@ Com o middleware ativo, o logger automaticamente incluirá `requestId` nos metad
 Se desejar um provider por request (cada request recebe uma instância com `setContext` isolado), passe `requestScoped: true` ao `forRoot`:
 
 ```ts
-LoggerModule.forRoot({ requestScoped: true })
+LoggerModule.forRoot({ requestScoped: true });
 ```
-

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adatechnology/logger",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "publishConfig": {
     "access": "public"
   },