@nest-omni/core 4.1.3-13 → 4.1.3-14

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nest-omni/core",
-  "version": "4.1.3-13",
+  "version": "4.1.3-14",
   "description": "A comprehensive NestJS framework for building enterprise-grade applications with best practices",
   "main": "index.js",
   "types": "index.d.ts",

package/LICENSE

@@ -1,17 +0,0 @@
-Apache License
-Version 2.0, January 2004
-http://www.apache.org/licenses/
-
-Copyright 2024 Jinpy
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.

package/README.md

@@ -1,444 +0,0 @@
-# @nest-omni/core
-
-A comprehensive NestJS framework for building enterprise-grade applications with best practices, decorators, validators, filters, interceptors, and utilities.
-
-## Features
-
-- 🎯 **Rich Decorators**: Custom decorators for controllers, routes, validation, and more
-- 🛡️ **Advanced Filters**: Global exception handling with customizable error responses
-- 🔄 **Interceptors**: Request/response transformation, logging, and translation
-- ✅ **Validators**: Custom validators for common use cases (phone numbers, emails, etc.)
-- 🏥 **Health Checks**: Built-in health checker module with configurable endpoints
-- 🔧 **Middleware**: Compression, logging, and session management
-- 📦 **Bootstrap Utilities**: Easy application setup with PM2 support and different modes
-- 🌍 **i18n Support**: Internationalization with nestjs-i18n integration
-- 🔒 **Redis Lock**: Distributed locking mechanism with decorators
-- 📊 **Audit**: Request auditing and logging capabilities
-- 🔐 **Sentry Integration**: Built-in error tracking and performance monitoring
-- 🚀 **TypeScript 5.9+**: Full support for latest TypeScript features
-- 📦 **Zero Config**: Most dependencies bundled - minimal setup required
-
-## Installation
-
-```bash
-npm install @nest-omni/core
-
-# Essential peer dependencies (required)
-npm install @nestjs/common@^11.0.0 @nestjs/core@^11.0.0 @nestjs/platform-express@^11.0.0
-
-# Optional peer dependencies (install as needed)
-npm install typeorm@^0.3.20 @nestjs/typeorm@^11.0.0  # For database
-npm install @nestjs/swagger@^11.0.0  # For API documentation
-npm install @nestjs/schedule@^6.0.0  # For scheduled tasks
-npm install nestjs-i18n@^10.5.0  # For internationalization
-```
-
-## Requirements
-
-- Node.js >= 18.0.0
-- NestJS >= 11.0.0
-- TypeScript >= 5.9.0
-
-## What's New in v3.1.0
-
-- ✨ **Updated Dependencies**: All dependencies upgraded to latest stable versions
-- 📦 **Better Bundling**: Core runtime dependencies now bundled (axios, lodash, moment, etc.)
-- 🎯 **Enhanced Exports**: Sub-path exports for better tree-shaking
-- 🔧 **Improved Types**: Better TypeScript support with updated type definitions
-- 🚀 **NestJS 11**: Full support for NestJS 11.x
-- 📊 **Sentry 10**: Upgraded to latest Sentry SDK with improved performance monitoring
-
-## Quick Start
-
-### 1. Basic Setup
-
-```typescript
-import { Module } from '@nestjs/common';
-import { HealthCheckerModule } from '@nest-omni/core';
-
-@Module({
-  imports: [HealthCheckerModule],
-})
-export class AppModule {}
-```
-
-### 2. Using Bootstrap
-
-```typescript
-import { bootstrap } from '@nest-omni/core';
-import { AppModule } from './app.module';
-
-bootstrap(AppModule, {
-  port: 3000,
-  globalPrefix: 'api',
-  enableCors: true,
-  enableSwagger: true,
-});
-```
-
-### 3. Using Decorators
-
-```typescript
-import { Controller, Get } from '@nestjs/common';
-import { ApiController, ApiOperation, PublicRoute } from '@nest-omni/core';
-
-@ApiController('users', 'User Management')
-@Controller('users')
-export class UsersController {
-  @Get()
-  @PublicRoute()
-  @ApiOperation({ summary: 'Get all users' })
-  findAll() {
-    return [];
-  }
-}
-```
-
-## Sub-path Exports
-
-The package now supports sub-path exports for better tree-shaking and smaller bundle sizes:
-
-```typescript
-// Import from main entry (includes everything)
-import { ApiController, QueryFailedFilter } from '@nest-omni/core';
-
-// Import from specific sub-paths (better tree-shaking)
-import { ApiController } from '@nest-omni/core/decorators';
-import { QueryFailedFilter } from '@nest-omni/core/filters';
-import { TranslationInterceptor } from '@nest-omni/core/interceptors';
-import { IsPhoneNumber } from '@nest-omni/core/validators';
-import { bootstrap } from '@nest-omni/core/setup';
-import { HealthCheckerModule } from '@nest-omni/core/health-checker';
-```
-
-Available sub-paths:
-- `@nest-omni/core` - Main entry point (all exports)
-- `@nest-omni/core/decorators` - Decorators only
-- `@nest-omni/core/filters` - Exception filters only
-- `@nest-omni/core/interceptors` - Interceptors only
-- `@nest-omni/core/validators` - Custom validators only
-- `@nest-omni/core/setup` - Bootstrap and setup utilities
-- `@nest-omni/core/health-checker` - Health check module
-
-## Core Modules
-
-### Decorators
-
-#### Controller Decorators
-- `@ApiController(path, tag)` - Enhanced API controller with Swagger tags
-- `@PublicRoute()` - Mark route as public (skip authentication)
-
-#### Property Decorators
-- `@NumberField(options)` - Number field with validation
-- `@StringField(options)` - String field with validation
-- `@BooleanField(options)` - Boolean field with validation
-- `@DateField(options)` - Date field with validation
-- `@EmailField(options)` - Email field with validation
-- `@PhoneField(options)` - Phone number field with validation
-- `@UrlField(options)` - URL field with validation
-
-#### User Decorator
-- `@User()` - Extract user from request
-
-#### Transform Decorators
-- `@Trim()` - Trim string values
-- `@ToLowerCase()` - Convert to lowercase
-- `@ToUpperCase()` - Convert to uppercase
-
-### Filters
-
-Global exception filters for handling common errors:
-
-```typescript
-import { BadRequestExceptionFilter, QueryFailedFilter } from '@nest-omni/core';
-
-app.useGlobalFilters(
-  new BadRequestExceptionFilter(),
-  new QueryFailedFilter(),
-);
-```
-
-### Interceptors
-
-#### LanguageInterceptor
-Handles language detection and setting:
-
-```typescript
-import { LanguageInterceptor } from '@nest-omni/core';
-
-app.useGlobalInterceptors(new LanguageInterceptor());
-```
-
-#### TranslationInterceptor
-Handles response translation:
-
-```typescript
-import { TranslationInterceptor } from '@nest-omni/core';
-
-app.useGlobalInterceptors(new TranslationInterceptor());
-```
-
-### Validators
-
-Custom validators for common use cases:
-
-```typescript
-import { IsPhoneNumber, IsEmail, IsUrl } from '@nest-omni/core';
-
-export class CreateUserDto {
-  @IsEmail()
-  email: string;
-
-  @IsPhoneNumber()
-  phone: string;
-
-  @IsUrl()
-  website: string;
-}
-```
-
-### Health Checker
-
-Built-in health check endpoint:
-
-```typescript
-import { HealthCheckerModule } from '@nest-omni/core';
-
-@Module({
-  imports: [
-    HealthCheckerModule, // Adds /health endpoint
-  ],
-})
-export class AppModule {}
-```
-
-### Setup & Bootstrap
-
-#### Mode-based Setup
-
-Support for different execution modes (web, worker, scheduler):
-
-```typescript
-import { ModeSetup } from '@nest-omni/core';
-
-const mode = ModeSetup.getMode(); // 'web' | 'worker' | 'scheduler'
-```
-
-#### Worker Decorator
-
-```typescript
-import { Worker } from '@nest-omni/core';
-
-export class TaskService {
-  @Worker()
-  async processTask() {
-    // This will only run in worker mode
-  }
-}
-```
-
-#### Schedule Decorator
-
-```typescript
-import { Schedule } from '@nest-omni/core';
-
-export class SchedulerService {
-  @Schedule()
-  @Cron('0 0 * * *')
-  async dailyTask() {
-    // This will only run in scheduler mode
-  }
-}
-```
-
-#### Redis Lock
-
-分布式锁服务，支持装饰器和服务注入两种使用方式：
-
-```typescript
-import { RedisLockModule, UseRedisLock, RedisLockService } from '@nest-omni/core';
-
-// 模块配置
-@Module({
-  imports: [
-    RedisLockModule.forRootAsync({
-      imports: [RedisModule],
-      inject: [RedisService],
-      useFactory: (redisService: RedisService) => ({
-        redisClient: redisService.getClient(),
-      }),
-    }),
-  ],
-})
-
-// 使用装饰器（推荐）
-@Cron('0 * * * *')
-@UseRedisLock('hourly-task', { ttl: 3600000 })
-async hourlyTask() {
-  // 在分布式环境下，同一时间只有一个实例会执行
-}
-
-// 使用服务注入
-async processOrder(orderId: string) {
-  const lockResult = await this.lockService.acquireLock(
-    `order:${orderId}`,
-    { ttl: 60000 }
-  );
-
-  if (!lockResult.acquired) return;
-
-  try {
-    await this.doProcess(orderId);
-  } finally {
-    await this.lockService.releaseLock(
-      `order:${orderId}`,
-      lockResult.lockValue
-    );
-  }
-}
-```
-
-**[📖 查看完整文档](./src/redis-lock/README.md)**
-
-### Cache System
-
-企业级三层缓存架构，支持智能依赖管理：
-
-```typescript
-import { CacheModule, Cacheable, TagDependency } from '@nest-omni/core';
-
-// 模块配置
-@Module({
-  imports: [
-    CacheModule.forRoot({
-      redis: { host: 'localhost', port: 6379 },
-      defaultTtl: 300000, // 5分钟
-    }),
-  ],
-})
-
-// 使用装饰器（推荐）
-@Cacheable({
-  key: (id: string) => `user:${id}`,
-  ttl: 300000,
-  dependencies: [new TagDependency(['user-data'])],
-})
-async getUser(id: string): Promise<User> {
-  return await this.userRepository.findOne(id);
-}
-
-// 使用服务
-async getProduct(id: string): Promise<Product> {
-  return await this.cacheService.getOrSet(
-    `product:${id}`,
-    () => this.productRepository.findOne(id),
-    { ttl: 600000 }
-  );
-}
-```
-
-**核心特性：**
-- 🏗️ 三层缓存架构（CLS + Memory + Redis）
-- 🔗 6种智能依赖类型（Tag, DB, Callback, Chain, File, Time）
-- 🎯 装饰器支持（@Cacheable, @CacheEvict, @CachePut）
-- 📊 性能监控和统计
-- 🛡️ 自动回填机制
-
-**[📖 查看完整文档](./src/cache/README.md)**
-
-
-
-## Middleware
-
-### Compression Middleware
-
-Automatically enabled in production:
-
-```typescript
-import { setupCompression } from '@nest-omni/core';
-
-const app = await NestFactory.create(AppModule);
-setupCompression(app);
-```
-
-## Configuration
-
-### TypeScript Configuration
-
-Your `tsconfig.json`:
-
-```json
-{
-  "compilerOptions": {
-    "experimentalDecorators": true,
-    "emitDecoratorMetadata": true,
-    "target": "ES2022",
-    "module": "commonjs"
-  }
-}
-```
-
-## Advanced Usage
-
-### Custom Exception Handling
-
-```typescript
-import { HttpException, HttpStatus } from '@nestjs/common';
-import { BaseExceptionFilter } from '@nest-omni/core';
-
-@Catch()
-export class CustomExceptionFilter extends BaseExceptionFilter {
-  catch(exception: unknown, host: ArgumentsHost) {
-    // Your custom logic
-    super.catch(exception, host);
-  }
-}
-```
-
-### Integration with i18n
-
-```typescript
-import { I18nModule } from 'nestjs-i18n';
-
-@Module({
-  imports: [
-    I18nModule.forRoot({
-      fallbackLanguage: 'en',
-      loaderOptions: {
-        path: path.join(__dirname, '/i18n/'),
-        watch: true,
-      },
-    }),
-  ],
-})
-export class AppModule {}
-```
-
-## PM2 Deployment
-
-The framework includes PM2 support for production deployments:
-
-```typescript
-import { bootstrap } from '@nest-omni/core';
-
-bootstrap(AppModule, {
-  pm2: true,
-  instances: 4, // or 'max'
-});
-```
-
-## License
-
-Apache-2.0 © Jinpy
-
-## Support
-
-- Email: jinpy.he@kuehne-nagel.com
-
-## Credits
-
-Built with ❤️ using:
-- [NestJS](https://nestjs.com/)
-- [TypeORM](https://typeorm.io/)
-- [class-validator](https://github.com/typestack/class-validator)
-- [class-transformer](https://github.com/typestack/class-transformer)

package/build.sh

@@ -1,45 +0,0 @@
-#!/bin/bash
-
-files_to_copy=("package.json" ".npmignore" "yarn.lock" "../../.hygen" "../../.hygen.js")
-
-if [ -d "dist" ]; then
-    rm -rf dist
-fi
-
-yarn run build
-
-if [ ! -d "dist" ]; then
-    echo "dist directory was not created by the build command."
-    exit 1
-fi
-
-# 新增测试版发布询问
-read -p "是否发布测试版？(yes/no) " is_beta
-
-# 版本号递增逻辑
-if [[ "$is_beta" =~ ^[Yy](es)?$ ]]; then
-    npm version prerelease -m "Bump version for beta release"
-else
-    npm version patch -m "Bump version for release"
-fi
-
-# 文件复制（注意调整到版本号递增之后）
-for file in "${files_to_copy[@]}"; do
-  if [ -f "$file" ]; then
-    cp "$file" dist/
-  elif [ -d "$file" ]; then
-    cp -rf "$file" dist/
-  else
-    echo "Warning: $file does not exist and cannot be copied to dist."
-  fi
-done
-
-# 发布逻辑
-cd dist || exit
-if [[ "$is_beta" =~ ^[Yy](es)?$ ]]; then
-    npm publish --tag beta --access public
-else
-    npm publish --access public
-fi
-
-echo "Build completed, files copied to dist, and package published to npm."

package/dist/package.json

@@ -1,105 +0,0 @@
-{
-  "name": "@nest-omni/core",
-  "version": "4.1.3-13",
-  "description": "A comprehensive NestJS framework for building enterprise-grade applications with best practices",
-  "main": "index.js",
-  "types": "index.d.ts",
-  "scripts": {
-    "build": "tsc -p tsconfig.json",
-    "test": "jest --passWithNoTests",
-    "test:cache": "jest src/cache --verbose",
-    "test:cache:watch": "jest src/cache --watch",
-    "test:cache:coverage": "jest src/cache --coverage",
-    "lint": "eslint 'src/**/*.ts' --fix"
-  },
-  "bin": {
-    "nest-omni": "nest start",
-    "i18n": "i18n",
-    "gen": "gen"
-  },
-  "keywords": [
-    "nestjs",
-    "framework",
-    "typescript",
-    "decorators",
-    "validation",
-    "interceptors",
-    "filters",
-    "middleware",
-    "enterprise",
-    "omni",
-    "sentry",
-    "health-check",
-    "redis-lock",
-    "pm2"
-  ],
-  "author": "Jinpy",
-  "license": "Apache-2.0",
-  "engines": {
-    "node": ">=22.0.0",
-    "npm": ">=9.0.0"
-  },
-  "devDependencies": {
-    "@types/compression": "^1.8.1",
-    "@types/express": "^5.0.4",
-    "@types/express-session": "^1.18.2",
-    "@types/lodash": "^4.17.20",
-    "@types/node": "^24.9.1",
-    "@types/sharp": "^0.31.1",
-    "@types/sprintf-js": "^1.1.4",
-    "@types/uuid": "^11.0.0",
-    "sqlite3": "^5.1.7",
-    "typescript": "^5.9.3"
-  },
-  "dependencies": {
-    "@dataui/crud": "^5.3.4",
-    "@dataui/crud-typeorm": "^5.3.4",
-    "@nestjs/bull": "^11.0.4",
-    "@nestjs/common": "^11.1.7",
-    "@nestjs/config": "^4.0.2",
-    "@nestjs/core": "^11.1.7",
-    "@nestjs/platform-express": "^11.1.7",
-    "@nestjs/schedule": "^6.0.1",
-    "@nestjs/swagger": "^11.2.1",
-    "@nestjs/terminus": "^11.0.0",
-    "@nestjs/typeorm": "^11.0.0",
-    "@sentry/nestjs": "^10.22.0",
-    "@sentry/profiling-node": "^10.22.0",
-    "@songkeys/nestjs-redis": "^11.0.0",
-    "@songkeys/nestjs-redis-health": "^11.0.0",
-    "axios": "^1.13.2",
-    "axios-retry": "^4.5.0",
-    "bcrypt": "^6.0.0",
-    "body-parser": "^2.2.0",
-    "bull": "^4.16.5",
-    "class-transformer": "^0.5.1",
-    "class-validator": "^0.14.2",
-    "compression": "^1.8.1",
-    "connect-redis": "^9.0.0",
-    "dotenv": "^17.2.3",
-    "express": "^5.1.0",
-    "express-session": "^1.18.2",
-    "hygen": "^6.2.11",
-    "ioredis": "^5.8.2",
-    "libphonenumber-js": "^1.12.25",
-    "lodash": "^4.17.21",
-    "mime-types": "^3.0.1",
-    "moment": "^2.30.1",
-    "mysql2": "^3.15.3",
-    "nestjs-cls": "^6.0.1",
-    "nestjs-i18n": "^10.5.1",
-    "nestjs-pino": "^4.4.1",
-    "node-vault": "^0.10.9",
-    "pino-http": "^11.0.0",
-    "pino-pretty": "^13.1.2",
-    "reflect-metadata": "^0.2.2",
-    "rxjs": "^7.8.2",
-    "source-map-support": "^0.5.21",
-    "sprintf-js": "^1.1.3",
-    "typeorm": "^0.3.27",
-    "uuid": "^13.0.0",
-    "fast-csv": "^5.0.5",
-    "xlsx": "git+https://git.sheetjs.com/sheetjs/sheetjs.git#v0.20.3"
-  },
-  "peerDependencies": {}
-}

package/tsconfig.build.json

@@ -1,16 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "removeComments": false,
-    "declaration": true,
-    "declarationMap": true
-  },
-  "exclude": [
-    "node_modules",
-    "dist",
-    "test",
-    "tests",
-    "**/*.spec.ts",
-    "**/*.test.ts"
-  ]
-}