@dismissible/nestjs-logger 0.0.1

package/README.md

@@ -0,0 +1,138 @@
+# @dismissible/nestjs-logger
+
+A flexible logging module for NestJS applications in the Dismissible ecosystem.
+
+> **Part of the Dismissible API** - This library is part of the [Dismissible API](https://dismissible.io) ecosystem. Visit [dismissible.io](https://dismissible.io) for more information and documentation.
+
+## Overview
+
+This library provides a standardized logging interface (`IDismissibleLogger`) and a default console logger implementation. It's designed to be easily replaceable with custom logging implementations (e.g., Winston, Pino, etc.) while maintaining a consistent API across the Dismissible ecosystem.
+
+## Installation
+
+```bash
+npm install @dismissible/nestjs-logger
+```
+
+## Getting Started
+
+### Basic Usage
+
+The simplest way to use the logger is with the default console logger:
+
+```typescript
+import { Module } from '@nestjs/common';
+import { LoggerModule } from '@dismissible/nestjs-logger';
+
+@Module({
+  imports: [
+    LoggerModule.forRoot({
+      // Uses default ConsoleLogger if not specified
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+### Using the Logger in Your Services
+
+```typescript
+import { Injectable, Inject } from '@nestjs/common';
+import { DISMISSIBLE_LOGGER, IDismissibleLogger } from '@dismissible/nestjs-logger';
+
+@Injectable()
+export class MyService {
+  constructor(@Inject(DISMISSIBLE_LOGGER) private readonly logger: IDismissibleLogger) {}
+
+  doSomething() {
+    this.logger.debug('Debug message', { context: 'MyService' });
+    this.logger.info('Info message', { userId: 'user-123' });
+    this.logger.warn('Warning message', { itemId: 'item-456' });
+    this.logger.error('Error message', new Error('Something went wrong'), {
+      additionalContext: 'value',
+    });
+  }
+}
+```
+
+### Custom Logger Implementation
+
+You can provide your own logger implementation:
+
+```typescript
+import { Module } from '@nestjs/common';
+import { LoggerModule, IDismissibleLogger } from '@dismissible/nestjs-logger';
+import * as winston from 'winston';
+
+class WinstonLogger implements IDismissibleLogger {
+  private logger = winston.createLogger({
+    // Your Winston configuration
+  });
+
+  debug(message: string, context?: object): void {
+    this.logger.debug(message, context);
+  }
+
+  info(message: string, context?: object): void {
+    this.logger.info(message, context);
+  }
+
+  warn(message: string, context?: object): void {
+    this.logger.warn(message, context);
+  }
+
+  error(message: string, error?: Error, context?: object): void {
+    this.logger.error(message, { error, ...context });
+  }
+}
+
+@Module({
+  imports: [
+    LoggerModule.forRoot({
+      logger: WinstonLogger,
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+## API Reference
+
+### IDismissibleLogger Interface
+
+```typescript
+interface IDismissibleLogger {
+  debug(message: string, context?: object): void;
+  info(message: string, context?: object): void;
+  warn(message: string, context?: object): void;
+  error(message: string, error?: Error, context?: object): void;
+}
+```
+
+### LoggerModule
+
+#### `LoggerModule.forRoot(options)`
+
+Configures the logger module with the provided options.
+
+**Options:**
+
+- `logger?: Type<IDismissibleLogger>` - Custom logger class (defaults to `Logger`)
+
+**Returns:** `DynamicModule`
+
+## Global Module
+
+The `LoggerModule` is registered as a global module, so you only need to import it once in your root module. The logger will be available throughout your application via dependency injection.
+
+## Related Packages
+
+This logger is used by other Dismissible packages:
+
+- `@dismissible/nestjs-dismissible` - Main dismissible service
+- `@dismissible/nestjs-storage` - Storage adapters
+- `@dismissible/nestjs-postgres-storage` - PostgreSQL storage adapter
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@dismissible/nestjs-logger",
+  "version": "0.0.1",
+  "description": "Console logger module for Dismissible applications",
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./src/index.mjs",
+      "require": "./src/index.js",
+      "types": "./src/index.d.ts"
+    }
+  },
+  "files": [
+    "src",
+    "README.md"
+  ],
+  "dependencies": {},
+  "peerDependencies": {
+    "@nestjs/common": "^11.0.0",
+    "@nestjs/core": "^11.0.0",
+    "class-validator": "^0.14.0",
+    "class-transformer": "^0.5.0"
+  },
+  "peerDependenciesMeta": {
+    "@nestjs/common": {
+      "optional": false
+    },
+    "@nestjs/core": {
+      "optional": false
+    },
+    "class-validator": {
+      "optional": false
+    },
+    "class-transformer": {
+      "optional": false
+    }
+  },
+  "keywords": [
+    "nestjs",
+    "logger",
+    "logging"
+  ],
+  "author": "",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/DismissibleIo/dismissible-api"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "commonjs"
+}

package/src/index.d.ts

@@ -0,0 +1,4 @@
+export * from './logger';
+export * from './logger.interface';
+export * from './logger.module';
+export * from './null-logger';

package/src/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./logger"), exports);
+tslib_1.__exportStar(require("./logger.interface"), exports);
+tslib_1.__exportStar(require("./logger.module"), exports);
+tslib_1.__exportStar(require("./null-logger"), exports);
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/logger/src/index.ts"],"names":[],"mappings":";;;AAAA,mDAAyB;AACzB,6DAAmC;AACnC,0DAAgC;AAChC,wDAA8B"}

package/src/logger.d.ts

@@ -0,0 +1,5 @@
+import { ConsoleLogger } from '@nestjs/common';
+import { IDismissibleLogger } from './logger.interface';
+export declare class Logger extends ConsoleLogger implements IDismissibleLogger {
+    info(message: string, context?: any[]): void;
+}

package/src/logger.interface.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Injection token for the logger provider.
+ */
+export declare const DISMISSIBLE_LOGGER: unique symbol;
+/**
+ * Interface for logger providers.
+ */
+export interface IDismissibleLogger {
+    /**
+     * Log a debug message.
+     */
+    debug(message: string, context?: object): void;
+    /**
+     * Log an info message.
+     */
+    info(message: string, context?: object): void;
+    /**
+     * Log a warning message.
+     */
+    warn(message: string, context?: object): void;
+    /**
+     * Log an error message.
+     */
+    error(message: string, error?: Error, context?: object): void;
+}

package/src/logger.interface.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DISMISSIBLE_LOGGER = void 0;
+/**
+ * Injection token for the logger provider.
+ */
+exports.DISMISSIBLE_LOGGER = Symbol('DISMISSIBLE_LOGGER');
+//# sourceMappingURL=logger.interface.js.map

package/src/logger.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.interface.js","sourceRoot":"","sources":["../../../../libs/logger/src/logger.interface.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACU,QAAA,kBAAkB,GAAG,MAAM,CAAC,oBAAoB,CAAC,CAAC"}

package/src/logger.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Logger = void 0;
+const common_1 = require("@nestjs/common");
+class Logger extends common_1.ConsoleLogger {
+    info(message, context) {
+        super.log(message, context);
+    }
+}
+exports.Logger = Logger;
+//# sourceMappingURL=logger.js.map

package/src/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../../../libs/logger/src/logger.ts"],"names":[],"mappings":";;;AAAA,2CAA+C;AAG/C,MAAa,MAAO,SAAQ,sBAAa;IACvC,IAAI,CAAC,OAAe,EAAE,OAAe;QACnC,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC9B,CAAC;CACF;AAJD,wBAIC"}

package/src/logger.module.d.ts

@@ -0,0 +1,9 @@
+import { DynamicModule, Type } from '@nestjs/common';
+import { IDismissibleLogger } from './logger.interface';
+export type IDismissibleLoggerModuleOptions = {
+    /** Custom logger provider implementation */
+    logger?: Type<IDismissibleLogger>;
+};
+export declare class LoggerModule {
+    static forRoot(options: IDismissibleLoggerModuleOptions): DynamicModule;
+}

package/src/logger.module.js

@@ -0,0 +1,28 @@
+"use strict";
+var LoggerModule_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LoggerModule = void 0;
+const tslib_1 = require("tslib");
+const common_1 = require("@nestjs/common");
+const logger_interface_1 = require("./logger.interface");
+const logger_1 = require("./logger");
+let LoggerModule = LoggerModule_1 = class LoggerModule {
+    static forRoot(options) {
+        return {
+            module: LoggerModule_1,
+            providers: [
+                {
+                    provide: logger_interface_1.DISMISSIBLE_LOGGER,
+                    useClass: options.logger ?? logger_1.Logger,
+                },
+            ],
+            exports: [logger_interface_1.DISMISSIBLE_LOGGER],
+            global: true,
+        };
+    }
+};
+exports.LoggerModule = LoggerModule;
+exports.LoggerModule = LoggerModule = LoggerModule_1 = tslib_1.__decorate([
+    (0, common_1.Module)({})
+], LoggerModule);
+//# sourceMappingURL=logger.module.js.map

package/src/logger.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.module.js","sourceRoot":"","sources":["../../../../libs/logger/src/logger.module.ts"],"names":[],"mappings":";;;;;AAAA,2CAA6D;AAC7D,yDAA4E;AAC5E,qCAAkC;AAQ3B,IAAM,YAAY,oBAAlB,MAAM,YAAY;IACvB,MAAM,CAAC,OAAO,CAAC,OAAwC;QACrD,OAAO;YACL,MAAM,EAAE,cAAY;YACpB,SAAS,EAAE;gBACT;oBACE,OAAO,EAAE,qCAAkB;oBAC3B,QAAQ,EAAE,OAAO,CAAC,MAAM,IAAI,eAAM;iBACnC;aACF;YACD,OAAO,EAAE,CAAC,qCAAkB,CAAC;YAC7B,MAAM,EAAE,IAAI;SACb,CAAC;IACJ,CAAC;CACF,CAAA;AAdY,oCAAY;uBAAZ,YAAY;IADxB,IAAA,eAAM,EAAC,EAAE,CAAC;GACE,YAAY,CAcxB"}

package/src/null-logger.d.ts

@@ -0,0 +1,7 @@
+import { IDismissibleLogger } from './logger.interface';
+export declare class NullLogger implements IDismissibleLogger {
+    info(_message: string, _context?: object): void;
+    error(_message: string, _context?: object): void;
+    warn(_message: string, _context?: object): void;
+    debug(_message: string, _context?: object): void;
+}

package/src/null-logger.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NullLogger = void 0;
+class NullLogger {
+    info(_message, _context) {
+        /* empty */
+    }
+    error(_message, _context) {
+        /* empty */
+    }
+    warn(_message, _context) {
+        /* empty */
+    }
+    debug(_message, _context) {
+        /* empty */
+    }
+}
+exports.NullLogger = NullLogger;
+//# sourceMappingURL=null-logger.js.map

package/src/null-logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"null-logger.js","sourceRoot":"","sources":["../../../../libs/logger/src/null-logger.ts"],"names":[],"mappings":";;;AAEA,MAAa,UAAU;IACrB,IAAI,CAAC,QAAgB,EAAE,QAAiB;QACtC,WAAW;IACb,CAAC;IACD,KAAK,CAAC,QAAgB,EAAE,QAAiB;QACvC,WAAW;IACb,CAAC;IACD,IAAI,CAAC,QAAgB,EAAE,QAAiB;QACtC,WAAW;IACb,CAAC;IACD,KAAK,CAAC,QAAgB,EAAE,QAAiB;QACvC,WAAW;IACb,CAAC;CACF;AAbD,gCAaC"}