@koalarx/nest 1.17.0 → 1.18.0

package/README.md

@@ -9,7 +9,7 @@
 <div align="center">
 
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![Node.js](https://img.shields.io/badge/Node.js-20%2B-green)](https://nodejs.org/)
+[![Bun](https://img.shields.io/badge/Bun-1.3%2B-black)](https://bun.sh)
 [![TypeScript](https://img.shields.io/badge/TypeScript-5.1%2B-blue)](https://www.typescriptlang.org/)
 [![CLI](https://img.shields.io/badge/CLI-@koalarx/nest--cli-brightgreen)](https://www.npmjs.com/package/@koalarx/nest-cli)
 
@@ -31,6 +31,37 @@ Toda a documentação está organizada em arquivos separados para facilitar a na
 
 ## Quick Start
 
+### Usando Bun (Recomendado - Mais Rápido)
+
+O projeto agora usa **Bun** como runtime JavaScript. Para instalar o Bun:
+
+```bash
+# Instalar Bun (Windows, macOS, Linux)
+curl -fsSL https://bun.sh/install | bash
+
+# Ou em Windows com PowerShell:
+powershell -Command "irm https://bun.sh/install.ps1 | iex"
+
+# Instalar dependências
+bun install
+
+# Iniciar em modo desenvolvimento
+bun run start:dev
+
+# Executar testes
+bun run test
+
+# Fazer build
+bun run build
+```
+
+**Vantagens do Bun:**
+- ⚡ Runtime ~3x mais rápido que Node.js
+- 📦 Package manager integrado (mais rápido que npm)
+- 🧪 Test runner nativo (compatível com Vitest)
+- 🔄 Hot reload automático
+- 💾 Menor consumo de memória
+
 ### Forma Rápida com CLI (Recomendado)
 
 ```bash
@@ -43,21 +74,27 @@ koala-nest new meu-projeto
 # Entrar na pasta
 cd meu-projeto
 
-# Iniciar em modo desenvolvimento
-npm run start:dev
+# Iniciar em modo desenvolvimento (com Bun)
+bun run start:dev
 ```
 
 **Pronto!** Seu projeto está estruturado com:
 - [x] Módulo DDD configurado
 - [x] Documentação da API (Scalar UI)
 - [x] Tratamento de erros robusto
-- [x] Autenticação JWT
+- [x] Guards de autenticação (JWT + API Key)
 - [x] Banco de dados Prisma
 - [x] Redis para background services
 
 ### Forma Manual
 
+> ⚠️ **Requisito Obrigatório**: A abstração de banco de dados da biblioteca requer **Prisma como ORM**. 
+
 ```bash
+# Com Bun (Recomendado - Mais rápido)
+bun install @koalarx/nest
+
+# Ou com npm (Alternativa)
 npm install @koalarx/nest
 ```
 
@@ -119,9 +156,10 @@ Acesse `http://localhost:3000/doc` para a documentação interativa!
 
 ### Segurança
 
-- **Guards Globais**: Proteja endpoints com autenticação
-- **API Key Strategy**: Autenticação via chave de API integrada
+- **Guards**: Autenticação e autorização (JWT + API Key)
+- **Estratégias Customizadas**: JwtStrategy e ApiKeyStrategy
 - **@IsPublic()**: Marca endpoints como públicos
+- **@RestrictByProfile()**: Restringe acesso por perfil de usuário
 
 ### Tratamento de Erros
 
@@ -155,15 +193,24 @@ export class SendReportJob extends CronJobHandlerBase {
 .addCronJob(SendReportJob)
 ```
 
-**Event Handlers** - Processe eventos assincronamente:
+**Event Jobs** - Processe eventos assincronamente:
 ```typescript
 @Injectable()
 export class UserCreatedHandler extends EventHandlerBase {
-  get eventName(): string { return 'user:created' }
-  async handle(data: any): Promise<void> { /* sua lógica */ }
+  async handleEvent(): Promise<void> {
+    // Processar evento de criação de usuário
+    console.log('Usuário criado!')
+  }
+}
+
+// Registrar em EventJob
+export class UserEventJob extends EventJob<User> {
+  defineHandlers(): Type<EventHandlerBase>[] {
+    return [UserCreatedHandler]
+  }
 }
 
-.addEventJob(UserCreatedHandler)
+.addEventJob(UserEventJob)
 ```
 
 ### Banco de Dados
@@ -310,14 +357,25 @@ src/
 
 ## Configuração de Ambiente
 
+A lib já valida automaticamente as variáveis padrão. Crie seu `.env` com:
+
 ```env
+# Variáveis obrigatórias
 NODE_ENV=develop
 DATABASE_URL=postgresql://user:password@localhost:5432/db
-REDIS_URL=redis://localhost:6379
+
+# Variáveis opcionais (padrão da lib)
+REDIS_CONNECTION_STRING=redis://localhost:6379
 SWAGGER_USERNAME=admin
 SWAGGER_PASSWORD=password123
+PRISMA_QUERY_LOG=false
+
+# Suas variáveis customizadas
+# CUSTOM_VAR=value
 ```
 
+Ver [Configuração Inicial - Variáveis de Ambiente](./docs/02-configuracao-inicial.md#2-configurar-variáveis-de-ambiente) para detalhes.
+
 ## Índice da Documentação Original
 
 A documentação abaixo foi mantida para referência de recursos específicos:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@koalarx/nest",
-  "version": "1.17.0",
+  "version": "1.18.0",
   "description": "",
   "repository": {
     "type": "git",