nestforge-generator 0.2.0 → 0.3.0

package/templates/prisma/docs/features-markers.md

@@ -21,6 +21,16 @@ export class UsersController {
 
 O nome depois de `nestforge:feature:` tem que ser exatamente o mesmo nas duas linhas (abertura e `:end`), e bater com o nome usado no array `features` da CLI (`docker`, `swagger`, `validation`, `redis`, `rbac`).
 
+Marcadores de banco são adicionados automaticamente pelo gerador:
+
+* `database:postgres`;
+* `database:mysql`;
+* `database:sqlite`;
+* `database:mongodb`;
+* `database:relational`, habilitado em PostgreSQL, MySQL e SQLite.
+
+Use `database:relational` quando o mesmo trecho SQL serve para todos os bancos relacionais, como a etapa `prisma migrate deploy`. Use o marcador específico quando provider, URL, health check ou infraestrutura dependem do banco selecionado.
+
 Funciona em qualquer arquivo cuja linguagem use `//` para comentário (`.ts`, `.js`). **Não funciona em JSON** (`package.json`) — pra dependências, ver a seção final deste documento.
 
 ## Marcador de arquivo inteiro
@@ -47,4 +57,4 @@ JSON não aceita comentário, então marcador não funciona ali. Em vez disso, o
 - [ ] Todo trecho de código exclusivo do recurso está marcado (bloco ou arquivo inteiro)
 - [ ] O nome do marcador bate com o valor usado em `features` na CLI (`packages/cli/src/prompts.ts`)
 - [ ] Dependências novas do `package.json` estão em `FEATURE_DEPENDENCIES` (`packages/cli/src/features/dependencies.ts`)
-- [ ] Testado gerando o projeto com o recurso ligado **e** desligado — o projeto tem que compilar/rodar dos dois jeitos
+- [ ] Testado gerando o projeto com o recurso ligado **e** desligado — o projeto tem que compilar/rodar dos dois jeitos

package/templates/prisma/prisma/schema.prisma

@@ -97,6 +97,10 @@ model Session {
   data String
   // nestforge:feature:database:sqlite:end
 
+  // nestforge:feature:database:mongodb
+  data String
+  // nestforge:feature:database:mongodb:end
+
   expiresAt DateTime
 
   @@map("sessions")

package/templates/prisma/src/auth/token.service.ts

@@ -1,6 +1,7 @@
 // nestforge:feature-file:auth:token
 import { Injectable, UnauthorizedException } from '@nestjs/common';
 import { JwtService } from '@nestjs/jwt';
+import type { JwtSignOptions } from '@nestjs/jwt';
 import { createHash } from 'crypto';
 import { PrismaService } from '../database/prisma.service';
 
@@ -14,14 +15,22 @@ export class TokenService {
     async issueTokens(userId: string, email: string, role: string) {
         const payload = { sub: userId, email, role };
 
+        const accessTokenExpiresIn = (
+            process.env.JWT_ACCESS_EXPIRES_IN ?? '15m'
+        ) as JwtSignOptions['expiresIn'];
+
+        const refreshTokenExpiresIn = (
+            process.env.JWT_REFRESH_EXPIRES_IN ?? '7d'
+        ) as JwtSignOptions['expiresIn'];
+
         const accessToken = this.jwtService.sign(payload, {
             secret: process.env.JWT_ACCESS_SECRET,
-            expiresIn: process.env.JWT_ACCESS_EXPIRES_IN ?? '15m',
+            expiresIn: accessTokenExpiresIn,
         });
 
         const refreshToken = this.jwtService.sign(payload, {
             secret: process.env.JWT_REFRESH_SECRET,
-            expiresIn: process.env.JWT_REFRESH_EXPIRES_IN ?? '7d',
+            expiresIn: refreshTokenExpiresIn,
         });
 
         const expiresAt = new Date();
@@ -81,4 +90,4 @@ export class TokenService {
     private hashToken(token: string): string {
         return createHash('sha256').update(token).digest('hex');
     }
-}
+}

package/templates/prisma/src/health/indicators/prisma-health.indicator.spec.ts

@@ -1,22 +1,39 @@
-import { describe, expect, it, vi } from 'vitest';
-import { HealthCheckError } from '@nestjs/terminus';
-import { PrismaHealthIndicator } from './prisma-health.indicator';
-import { PrismaService } from '../../database/prisma.service';
-
-describe('PrismaHealthIndicator', () => {
-    it('retorna status up quando a query executa com sucesso', async () => {
-        const prisma = { $queryRaw: vi.fn().mockResolvedValue([{ '?column?': 1 }]) };
-        const indicator = new PrismaHealthIndicator(prisma as unknown as PrismaService);
-
-        const result = await indicator.isHealthy('database');
-
-        expect(result).toEqual({ database: { status: 'up' } });
-    });
-
-    it('lança HealthCheckError quando a query falha', async () => {
-        const prisma = { $queryRaw: vi.fn().mockRejectedValue(new Error('conexão recusada')) };
-        const indicator = new PrismaHealthIndicator(prisma as unknown as PrismaService);
-
-        await expect(indicator.isHealthy('database')).rejects.toBeInstanceOf(HealthCheckError);
-    });
-});
+import { describe, expect, it, vi } from 'vitest';
+import { HealthCheckError } from '@nestjs/terminus';
+import { PrismaHealthIndicator } from './prisma-health.indicator';
+import { PrismaService } from '../../database/prisma.service';
+
+describe('PrismaHealthIndicator', () => {
+    it('retorna status up quando a query executa com sucesso', async () => {
+        const prisma = {
+            // nestforge:feature:database:relational
+            $queryRaw: vi.fn().mockResolvedValue([{ '?column?': 1 }]),
+            // nestforge:feature:database:relational:end
+            // nestforge:feature:database:mongodb
+            $runCommandRaw: vi.fn().mockResolvedValue({ ok: 1 }),
+            // nestforge:feature:database:mongodb:end
+        };
+        const indicator = new PrismaHealthIndicator(prisma as unknown as PrismaService);
+
+        const result = await indicator.isHealthy('database');
+
+        expect(result).toEqual({ database: { status: 'up' } });
+        // nestforge:feature:database:mongodb
+        expect(prisma.$runCommandRaw).toHaveBeenCalledWith({ ping: 1 });
+        // nestforge:feature:database:mongodb:end
+    });
+
+    it('lança HealthCheckError quando a query falha', async () => {
+        const prisma = {
+            // nestforge:feature:database:relational
+            $queryRaw: vi.fn().mockRejectedValue(new Error('conexão recusada')),
+            // nestforge:feature:database:relational:end
+            // nestforge:feature:database:mongodb
+            $runCommandRaw: vi.fn().mockRejectedValue(new Error('conexão recusada')),
+            // nestforge:feature:database:mongodb:end
+        };
+        const indicator = new PrismaHealthIndicator(prisma as unknown as PrismaService);
+
+        await expect(indicator.isHealthy('database')).rejects.toBeInstanceOf(HealthCheckError);
+    });
+});

package/templates/prisma/src/health/indicators/prisma-health.indicator.ts

@@ -1,19 +1,24 @@
-import { Injectable } from '@nestjs/common';
-import { HealthIndicatorResult, HealthCheckError } from '@nestjs/terminus';
-import { PrismaService } from '../../database/prisma.service';
-
-@Injectable()
-export class PrismaHealthIndicator {
-    constructor(private readonly prisma: PrismaService) { }
-
-    async isHealthy(key: string): Promise<HealthIndicatorResult> {
-        try {
-            await this.prisma.$queryRaw`SELECT 1`;
-            return { [key]: { status: 'up' } };
-        } catch (error) {
-            throw new HealthCheckError('Banco de dados indisponível', {
-                [key]: { status: 'down', message: (error as Error).message },
-            });
-        }
-    }
-}
+import { Injectable } from '@nestjs/common';
+import { HealthIndicatorResult, HealthCheckError } from '@nestjs/terminus';
+import { PrismaService } from '../../database/prisma.service';
+
+@Injectable()
+export class PrismaHealthIndicator {
+    constructor(private readonly prisma: PrismaService) { }
+
+    async isHealthy(key: string): Promise<HealthIndicatorResult> {
+        try {
+            // nestforge:feature:database:relational
+            await this.prisma.$queryRaw`SELECT 1`;
+            // nestforge:feature:database:relational:end
+            // nestforge:feature:database:mongodb
+            await this.prisma.$runCommandRaw({ ping: 1 });
+            // nestforge:feature:database:mongodb:end
+            return { [key]: { status: 'up' } };
+        } catch (error) {
+            throw new HealthCheckError('Banco de dados indisponível', {
+                [key]: { status: 'down', message: (error as Error).message },
+            });
+        }
+    }
+}

package/templates/typeorm/README.md

@@ -25,6 +25,8 @@ NestForge is a NestJS starter designed to accelerate the beginning of serious ba
 - 🐳 **Docker** — complete environment with a single command
 - ⚙️ **CI/CD** — GitHub Actions (build, lint, test)
 
+> **MongoDB compatibility:** MongoDB is not available in this NestForge template. Although TypeORM provides basic MongoDB support, adopting it would require a separate document-oriented architecture for entities, repositories, relations, migrations, session persistence, and tests; it is not a direct database-driver substitution. MongoDB generation is currently available through the Prisma template.
+
 ## 🧱 Stack
 
 | Layer | Technology |

package/templates/typeorm/README.pt-BR.md

@@ -25,6 +25,8 @@ NestForge é um boilerplate de NestJS pensado para acelerar o início de projeto
 - 🐳 **Docker** — ambiente completo com um comando
 - ⚙️ **CI/CD** — GitHub Actions (build, lint, test)
 
+> **Compatibilidade com MongoDB:** o MongoDB não está disponível neste template do NestForge. Embora o TypeORM ofereça suporte básico a MongoDB, adotá-lo exigiria uma arquitetura separada e orientada a documentos para entidades, repositories, relações, migrations, persistência de sessões e testes; não se trata de uma troca direta do driver de banco. Atualmente, a geração com MongoDB está disponível por meio do template Prisma.
+
 ## 🧱 Stack
 
 | Camada | Tecnologia |