nestjs-log-decorator 0.1.0 → 0.2.0

package/README.md

@@ -25,7 +25,7 @@ TypeScript decorators that eliminate logging boilerplate from NestJS application
 
 ## Description
 
-`@Log()` decorator replaces try-catch logging pattern from NestJS service methods, by automatically logging methods invocation, on return or error.
+`@Log()` decorator replaces the try-catch logging pattern in NestJS service methods by automatically logging method invocation on return or error.
 
 **Key Features**
 
@@ -47,7 +47,7 @@ import { Logger } from '@nestjs/common';
 import { Log } from 'nestjs-log-decorator';
 
 class UserService {
-  private readonly logger = new Logger(UserService.name);
+  readonly logger = new Logger(UserService.name);
 
   @Log()
   createUser(name: string, email: string) {
@@ -57,7 +57,7 @@ class UserService {
 
 ```
 
-Once a service method is called, it will log the method call invocation with all arguments.
+Once a service method is called, it will log the method invocation with all arguments.
 
 ```typescript
 const result = service.createUser('John', 'john@example.com');
@@ -106,7 +106,7 @@ const result = await resultPromise;
 
 ### Complete Example
 
-After installation, no additional configuration is needed, just make sure that your class has a `logger` property, which implements default NestJS Logger interface.
+After installation, no additional configuration is needed, just make sure that your class has a public `logger` property that implements the default NestJS Logger interface.
 
 ```typescript
 import { Logger } from '@nestjs/common';
@@ -115,7 +115,7 @@ import { Log } from 'nestjs-log-decorator';
 
 class PaymentService {
   // `logger` property will be used by decorator
-  private readonly logger = new Logger(PaymentService.name);
+  readonly logger = new Logger(PaymentService.name);
 
   @Log()
   async processPayment(amount: number, currency: string) {
@@ -130,6 +130,8 @@ class PaymentService {
 }
 ```
 
+The `logger` property is public due to TypeScript validation limitations. TS cannot check if a private property is valid, but it should still work even if the property is private.
+
 ## How It Works
 
 The `@Log()` decorator wraps your methods with automatic try-catch logging. It extracts parameter names, captures arguments, and logs structured output on success or error.
@@ -181,7 +183,7 @@ Apply `@Log()` to specific methods for granular control:
 
 ```typescript
 class DataService {
-  private readonly logger = new Logger(DataService.name);
+  readonly logger = new Logger(DataService.name);
 
   @Log()
   async fetchData(id: number) {
@@ -207,7 +209,7 @@ import { Log } from 'nestjs-log-decorator';
 @Log()
 @Injectable()
 class PaymentService {
-  private readonly logger = new Logger(PaymentService.name);
+  readonly logger = new Logger(PaymentService.name);
 
   processPayment(amount: number, currency: string) {
     // Automatically logged on success or error
@@ -230,7 +232,7 @@ import { Log, NoLog } from 'nestjs-log-decorator';
 
 @Log()
 class UserService {
-  private readonly logger = new Logger(UserService.name);
+  readonly logger = new Logger(UserService.name);
 
   createUser(name: string) {
     // Logged
@@ -266,7 +268,7 @@ Class-level with `onInvoke`:
 ```typescript
 @Log({ onInvoke: true })
 class ApiService {
-  private readonly logger = new Logger(ApiService.name);
+  readonly logger = new Logger(ApiService.name);
   
   // All methods will log invocation + completion
 }
@@ -287,7 +289,7 @@ interface LargePayload {
 }
 
 class SyncService {
-  private readonly logger = new Logger(SyncService.name);
+  readonly logger = new Logger(SyncService.name);
 
   // Only log the ID, exclude the large payload
   @Log({ args: (id: number, _payload: LargePayload) => ({ id }) })
@@ -469,11 +471,11 @@ import { Log, NoLog } from 'nestjs-log-decorator';
 @Log()
 @Injectable()
 export class OrderService {
-  private readonly logger = new Logger(OrderService.name);
+  readonly logger = new Logger(OrderService.name);
 
   constructor(
-    private readonly orderRepo: OrderRepository,
-    private readonly paymentGateway: PaymentGateway,
+    readonly orderRepo: OrderRepository,
+    readonly paymentGateway: PaymentGateway,
   ) {}
 
   // Logged with all args

package/dist/{index.mjs → index.cjs}

@@ -1,4 +1,4 @@
-import { Logger } from "@nestjs/common";
+require("@nestjs/common");
 
 //#region src/axios/axios.stub.ts
 /**
@@ -427,4 +427,6 @@ const NoLog = () => {
 };
 
 //#endregion
-export { Log, NoLog, isLoggable };
+exports.Log = Log;
+exports.NoLog = NoLog;
+exports.isLoggable = isLoggable;

package/package.json

@@ -1,7 +1,6 @@
 {
   "name": "nestjs-log-decorator",
-  "type": "module",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Decorator that removes try catch boilerplate logging from NestJS service methods",
   "author": "Vlad Goncharov <leovs010@gmail.com>",
   "license": "AGPL-3.0",
@@ -14,12 +13,11 @@
     "url": "https://github.com/neolabhq/nestjs-log-decorator/issues"
   },
   "exports": {
-    ".": "./dist/index.mjs",
+    ".": "./dist/index.cjs",
     "./package.json": "./package.json"
   },
-  "main": "./dist/index.mjs",
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.mts",
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.cts",
   "files": [
     "dist"
   ],