@triproject/nestjs-core 1.0.5 → 1.0.6

package/README.md

@@ -1,11 +1,27 @@
-# @triproject/nestjs
+# @triproject/nestjs-core
 
-Opinionated NestJS building blocks for caching, configuration, queues, logging, mail, notifications, encryption, and database access.
+A collection of NestJS modules and utilities to speed up development with built-in support for caching, database access, encryption, logging, mail, notifications, queues, and more.
+
+[![npm version](https://badge.fury.io/js/@triproject%2Fnestjs-core.svg)](https://www.npmjs.com/package/@triproject/nestjs-core)
+[![License: ISC](https://img.shields.io/badge/License-ISC-blue.svg)](https://opensource.org/licenses/ISC)
+
+## Features
+
+- 🚀 **Quick Bootstrap** - Preconfigured NestJS application setup
+- 🔐 **Encryption & Authentication** - JWT, password hashing (PBKDF2), AES-256-GCM encryption, TOTP/2FA
+- 💾 **Database** - Sequelize ORM with TypeScript support
+- 🗄️ **Caching** - Redis integration with helpers
+- 📧 **Email** - Nodemailer with queue support
+- 🔔 **Notifications** - Push notifications and Slack integration
+- ⚡ **Queue Management** - Bull and BullMQ support
+- 📝 **Logging** - Structured logging with Slack alerts
+- 🎨 **Swagger** - API documentation helpers
+- 🔌 **Modular** - Import only what you need
 
 ## Installation
 
 ```bash
-npm install @triproject/nestjs
+npm install @triproject/nestjs-core
 ```
 
 ## Modular Imports
@@ -15,36 +31,82 @@ This package uses subpath exports to avoid loading unnecessary dependencies. Imp
 ### Bootstrap (Core)
 
 ```typescript
-import { bootstrap } from '@triproject/nestjs/bootstrap';
-import { APP_PORT, APP_KEY } from '@triproject/nestjs/config';
+import { bootstrap } from '@triproject/nestjs-core/bootstrap';
+import { APP_PORT, APP_KEY } from '@triproject/nestjs-core/config';
 ```
 
-Required peer dependencies:
+**Required peer dependencies:**
+
+- `@nestjs/common` (^11.0.0)
+- `@nestjs/core` (^11.0.0)
+- `express` (^4.0.0 || ^5.0.0)
+- `helmet` (^7.0.0 || ^8.0.0)
+- `cookie-parser` (^1.4.0)
+- `class-validator` (^0.14.0)
+- `dotenv` (^16.0.0 || ^17.0.0)
+
+### Configuration
 
-- `@nestjs/common`
-- `@nestjs/core`
-- `express`
-- `helmet`
-- `cookie-parser`
-- `class-validator`
+```typescript
+import {
+  APP_NAME,
+  APP_PORT,
+  APP_KEY,
+  DB_HOST,
+  DB_PORT,
+  REDIS_HOST,
+  REDIS_PORT,
+  // ... and more
+} from '@triproject/nestjs-core/config';
+```
+
+All environment variables are pre-configured with sensible defaults.
 
 ### Cache (Redis)
 
 ```typescript
-import { AppCache, Redis, CacheModule } from '@triproject/nestjs/cache';
+import { AppCache, Redis, CacheModule } from '@triproject/nestjs-core/cache';
+
+// In your module
+@Module({
+  imports: [CacheModule],
+})
+export class AppModule {}
+
+// In your service
+constructor(private cache: AppCache) {}
+
+async cacheData() {
+  await this.cache.set('key', { data: 'value' }, 3600);
+  const data = await this.cache.get<{ data: string }>('key');
+  await this.cache.delete('key');
+}
 ```
 
-Required peer dependencies:
+**Required peer dependencies:**
 
 - `redis` (^4.0.0 || ^5.0.0)
 
 ### Database (Sequelize)
 
 ```typescript
-import { DatabaseModule, Repository } from '@triproject/nestjs/db';
+import { DatabaseModule, Repository } from '@triproject/nestjs-core/db';
+
+// In your module
+@Module({
+  imports: [DatabaseModule],
+})
+export class AppModule {}
+
+// Base repository with pagination and common queries
+export class UserRepository extends Repository<UserModel> {
+  constructor() {
+    super(UserModel);
+  }
+}
 ```
 
-Required peer dependencies:
+**Required peer dependencies:**
 
 - `sequelize` (^6.0.0)
 - `sequelize-typescript` (^2.0.0)
@@ -53,28 +115,73 @@ Required peer dependencies:
 ### Encryption & JWT
 
 ```typescript
-import { PasswordHash, Jwt, EncryptionModule } from '@triproject/nestjs/encryption';
+import { PasswordHash, Jwt, Encryption, EncryptionModule } from '@triproject/nestjs-core/encryption';
+
+// Password hashing
+const hash = passwordHash.sign('myPassword');
+const isValid = passwordHash.verify('myPassword', hash);
+
+// JWT tokens
+const token = jwt.sign({ userId: 123 }, 3600);
+const decoded = jwt.verify<{ userId: number }>(token);
+
+// AES-256-GCM encryption
+const encrypted = encryption.encrypt('sensitive data');
+const decrypted = encryption.decrypt(encrypted);
 ```
 
-Required peer dependencies:
+**Required peer dependencies:**
 
 - `jsonwebtoken` (^9.0.0)
 
+**Features:**
+
+- PBKDF2 password hashing with SHA-512
+- RS512 JWT tokens
+- AES-256-GCM encryption
+- Native Node.js crypto (no external dependencies)
+
 ### Logger
 
 ```typescript
-import { AppLogger, SlackLogger } from '@triproject/nestjs/logger';
+import { AppLogger, SlackLogger } from '@triproject/nestjs-core/logger';
+
+const logger = new AppLogger('MyService');
+logger.log('Info message');
+logger.error('Error message', error);
+logger.warn('Warning message');
+logger.debug('Debug message');
+
+// Slack integration
+const slackLogger = new SlackLogger();
+await slackLogger.error('Critical error', error);
 ```
 
-No additional dependencies required (uses `axios` from core).
+**Required peer dependencies:**
+
+- `axios` (^1.0.0)
+- `lodash` (^4.17.0)
+- `moment` (^2.30.0)
 
 ### Mail
 
 ```typescript
-import { MailModule, Mailer } from '@triproject/nestjs/mail';
+import { MailModule, Mailer } from '@triproject/nestjs-core/mail';
+
+@Module({
+  imports: [MailModule],
+})
+export class AppModule {}
+
+// Send email
+await mailer.send({
+  to: 'user@example.com',
+  subject: 'Welcome',
+  html: '<p>Welcome to our app!</p>',
+});
 ```
 
-Required peer dependencies:
+**Required peer dependencies:**
 
 - `nodemailer` (^6.0.0 || ^7.0.0)
 - `@nestjs/bull` (^11.0.0)
@@ -83,10 +190,22 @@ Required peer dependencies:
 ### Notifications
 
 ```typescript
-import { NotificationModule, PushNotification } from '@triproject/nestjs/notifications';
+import { NotificationModule, PushNotification } from '@triproject/nestjs-core/notifications';
+
+@Module({
+  imports: [NotificationModule],
+})
+export class AppModule {}
+
+// Send push notification
+await pushNotification.send({
+  playerIds: ['user-id'],
+  title: 'New Message',
+  message: 'You have a new message',
+});
 ```
 
-Required peer dependencies:
+**Required peer dependencies:**
 
 - `@nestjs/bull` (^11.0.0)
 - `bull` (^4.0.0)
@@ -94,10 +213,24 @@ Required peer dependencies:
 ### Queues (BullMQ)
 
 ```typescript
-import { QueueModule, AppQueue } from '@triproject/nestjs/queues';
+import { QueueModule, AppQueue } from '@triproject/nestjs-core/queues';
+
+@Module({
+  imports: [QueueModule],
+})
+export class AppModule {}
+
+// Create queue processor
+@Processor('myQueue')
+export class MyQueue extends AppQueue {
+  @Process('job-name')
+  async processJob(job: Job) {
+    // Process job
+  }
+}
 ```
 
-Required peer dependencies:
+**Required peer dependencies:**
 
 - `@nestjs/bullmq` (^11.0.0)
 - `bullmq` (^5.0.0)
@@ -105,36 +238,162 @@ Required peer dependencies:
 ### Helpers
 
 ```typescript
-import { HttpExceptionFilter, SwaggerHelper, Totp } from '@triproject/nestjs/helpers';
+import {
+  CatchError,
+  TransformResponseInterceptor,
+  totp,
+  SwaggerApiPaginateResponse,
+} from '@triproject/nestjs-core/helpers';
+
+// Error handling decorator
+class MyService {
+  @CatchError('Operation failed')
+  async myMethod() {
+    // Automatically catches and transforms errors
+  }
+}
+
+// TOTP/2FA
+const { secret, qrCodeBase64 } = await totp.generateSecret({
+  email: 'user@example.com',
+  issuer: 'MyApp',
+});
+const isValid = totp.verify(secret, '123456');
+
+// Swagger decorators
+@SwaggerApiPaginateResponse(UserDto)
+async getUsers() {
+  // Returns paginated response with Swagger docs
+}
 ```
 
-Required peer dependencies for TOTP:
+**Required peer dependencies (for TOTP):**
 
 - `speakeasy` (^2.0.0)
 - `qrcode` (^1.5.0)
 
-## Usage Example
+## Complete Usage Example
 
 ```typescript
+// main.ts
+import { bootstrap } from '@triproject/nestjs-core/bootstrap';
+import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
+import { AppModule } from './app.module';
+
+const setupSwagger = (app) => {
+  const config = new DocumentBuilder().setTitle('My API').setVersion('1.0').build();
+  const document = SwaggerModule.createDocument(app, config);
+  SwaggerModule.setup('docs', app, document);
+};
+
+bootstrap(AppModule, setupSwagger);
+
 // app.module.ts
 import { Module } from '@nestjs/common';
-import { CacheModule } from '@triproject/nestjs/cache';
-import { DatabaseModule } from '@triproject/nestjs/db';
-import { EncryptionModule } from '@triproject/nestjs/encryption';
+import { CacheModule } from '@triproject/nestjs-core/cache';
+import { DatabaseModule } from '@triproject/nestjs-core/db';
+import { EncryptionModule } from '@triproject/nestjs-core/encryption';
+import { MailModule } from '@triproject/nestjs-core/mail';
 
 @Module({
-  imports: [CacheModule, DatabaseModule, EncryptionModule],
+  imports: [DatabaseModule, CacheModule, EncryptionModule, MailModule],
 })
 export class AppModule {}
 
-// main.ts
-import { bootstrap } from '@triproject/nestjs/bootstrap';
-import { setupSwagger } from './swagger';
-import { AppModule } from './app.module';
+// user.service.ts
+import { Injectable } from '@nestjs/common';
+import { AppCache } from '@triproject/nestjs-core/cache';
+import { PasswordHash, Jwt } from '@triproject/nestjs-core/encryption';
 
-bootstrap(AppModule, setupSwagger);
+@Injectable()
+export class UserService {
+  constructor(private cache: AppCache, private passwordHash: PasswordHash, private jwt: Jwt) {}
+
+  async login(email: string, password: string) {
+    // Get user from cache or database
+    const user = await this.cache.get(`user:${email}`);
+
+    // Verify password
+    const isValid = this.passwordHash.verify(password, user.password);
+    if (!isValid) throw new Error('Invalid credentials');
+
+    // Generate JWT token
+    const token = this.jwt.sign({ userId: user.id }, 86400);
+
+    return { token };
+  }
+}
+```
+
+## Environment Variables
+
+All configuration is done through environment variables. Create a `.env` file:
+
+```env
+# App
+APP_NAME=MyApp
+APP_PORT=3000
+APP_KEY=your-app-secret-key
+
+# Database
+DB_HOST=localhost
+DB_PORT=5432
+DB_USER=postgres
+DB_PASSWORD=password
+DB_NAME=mydb
+
+# Redis
+REDIS_HOST=localhost
+REDIS_PORT=6379
+REDIS_PASSWORD=
+
+# JWT
+JWT_PUBLIC_KEY=your-rsa-public-key
+JWT_PRIVATE_KEY=your-rsa-private-key
+
+# Encryption
+PASSWORD_HASH_SECRET=your-hash-secret
+ENCRYPTION_KEY=your-aes-256-key
+
+# Mail
+MAIL_HOST=smtp.gmail.com
+MAIL_PORT=587
+MAIL_USERNAME=your-email
+MAIL_PASSWORD=your-password
+
+# Slack
+SLACK_ERROR_WEBHOOK_URL=your-slack-webhook
+
+# OneSignal
+ONESIGNAL_APP_ID=your-app-id
+ONESIGNAL_REST_API_KEY=your-api-key
+```
+
+## Testing
+
+This package includes comprehensive test coverage:
+
+```bash
+npm test
+```
+
+## Development
+
+```bash
+# Install dependencies
+npm install
+
+# Build
+npm run build
+
+# Run tests
+npm test
 ```
 
 ## License
 
 ISC
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@triproject/nestjs-core",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "author": "",
   "license": "ISC",
   "description": "A collection of NestJS modules and utilities to speed up development.",