innovationhub-cli 1.1.0 → 2.0.1

package/templates/nest/README.md

@@ -0,0 +1,224 @@
+# Template NestJS — Innovation Hub
+
+Template base para inicialização de projetos backend com **NestJS**. Inclui autenticação completa, gerenciamento de usuários e uma estrutura modular pronta para expandir.
+
+## ✨ Funcionalidades Incluídas
+
+- **Autenticação e Autorização**: Sistema completo de login com JWT (JSON Web Tokens), refresh tokens rotativos e controle de acesso baseado em papéis (Roles).
+- **Gerenciamento de Usuários**: CRUD de usuários com criptografia de senhas (bcrypt), soft delete, paginação e reset de senha por admin.
+- **Base Genérica Reutilizável**: `BaseEntity`, `BaseRepository`, `BaseService` e `IRepository` para criar novos módulos rapidamente.
+- **Documentação de API**: Geração automática de documentação interativa com **Swagger (OpenAPI)**.
+- **Envio de E-mails**: Serviço de e-mail configurável com templates Handlebars.
+- **Utilitários**: Paginação, geração de slugs, parsing de duração, validadores customizados e constantes de erro centralizadas.
+
+## 🚀 Tecnologias Utilizadas
+
+- **Framework**: [NestJS](https://nestjs.com/)
+- **Linguagem**: [TypeScript](https://www.typescriptlang.org/)
+- **Banco de Dados**: [PostgreSQL](https://www.postgresql.org/)
+- **ORM**: [TypeORM](https://typeorm.io/)
+- **Containerização**: [Docker](https://www.docker.com/) e Docker Compose
+- **Autenticação**: [Passport.js](http://www.passportjs.org/) (Estratégias `local`, `jwt` e `jwt-refresh`)
+- **Validação de Dados**: `class-validator` e `class-transformer`
+- **Testes**: [Jest](https://jestjs.io/) para testes unitários e E2E.
+
+---
+
+## 🏁 Como Começar
+
+Siga os passos abaixo para configurar e executar o projeto em seu ambiente local.
+
+### Pré-requisitos
+
+- [Node.js](https://nodejs.org/en/) (v18 ou superior)
+- [Docker](https://www.docker.com/get-started) e Docker Compose
+- [NPM](https://www.npmjs.com/)
+
+### 1. Clone o Repositório
+
+```bash
+git clone <URL_DO_REPOSITORIO>
+cd <NOME_DO_PROJETO>
+```
+
+### 2. Configure as Variáveis de Ambiente
+
+Copie o arquivo de exemplo `.env.example` para um novo arquivo chamado `.env` e preencha as variáveis.
+
+```bash
+# No Windows (prompt de comando)
+copy .env.example .env
+
+# No Linux ou macOS
+cp .env.example .env
+```
+
+Abra o arquivo `.env` e preencha todas as variáveis necessárias, como as credenciais do banco de dados e segredos do JWT. Para o ambiente Docker padrão, as credenciais do Postgres já vêm configuradas no `docker-compose.yml`.
+
+### 3. Instale as Dependências
+
+```bash
+npm install
+```
+
+---
+
+## 🐳 Executando com Docker (Recomendado)
+
+O projeto está configurado para rodar facilmente com Docker, simplificando a configuração do banco de dados e da API.
+
+### Subir o Ambiente de Desenvolvimento
+
+```bash
+docker-compose --profile dev up -d --build
+```
+
+### Subir o Ambiente de Produção
+
+```bash
+docker-compose --profile prod up -d --build
+```
+
+- A API estará disponível em `http://localhost:3000`.
+- O banco de dados PostgreSQL estará acessível na porta `5432`.
+
+### Parar o Ambiente
+
+```bash
+docker-compose down
+```
+
+---
+
+## ⚙️ Executando Localmente (Sem Docker)
+
+### 1. Execute um Banco de Dados PostgreSQL
+
+Garanta que você tenha uma instância do PostgreSQL rodando e que as credenciais no seu arquivo `.env` apontem para ela.
+
+### 2. Execute as Migrations
+
+```bash
+npm run migration:run
+```
+
+### 3. Inicie a Aplicação
+
+```bash
+# Modo de desenvolvimento com hot-reload
+npm run start:dev
+```
+
+A aplicação estará disponível em `http://localhost:3000`.
+
+---
+
+## 📄 Documentação e Endpoints
+
+### Acessar a Documentação
+
+Com a aplicação em execução, acesse a documentação interativa da API gerada pelo Swagger em:
+**[http://localhost:3000/api/docs](http://localhost:3000/api/docs)**
+
+### Resumo dos Endpoints Principais
+
+- `POST /auth/login`: Autentica um usuário e retorna tokens JWT.
+- `POST /auth/logout`: Faz logout (revoga refresh token).
+- `POST /auth/refresh`: Atualiza os tokens de acesso usando um refresh token.
+- `PATCH /auth/change-password`: Altera a senha do usuário logado.
+- `GET /users/me`: Retorna o perfil do usuário autenticado.
+- `PATCH /users/me`: Atualiza o perfil do usuário autenticado.
+- `GET /users`: Lista todos os usuários (admin).
+- `GET /users/paginated`: Lista usuários com paginação e busca (admin).
+- `GET /users/:id`: Busca um usuário pelo ID (admin).
+- `POST /users`: Cria um novo usuário (admin).
+- `PATCH /users/:id`: Atualiza um usuário pelo ID (admin).
+- `PATCH /users/:id/reset-password`: Reseta a senha de um usuário (admin).
+- `DELETE /users/:id`: Deleta um usuário (admin).
+
+---
+
+## 📂 Estrutura do Projeto
+
+```
+src/
+├── auth/         # Autenticação: estratégias (JWT, local, refresh), guards, decorators, DTOs
+├── common/       # Base genérica (entity, repository, service), utilitários, validadores, DTOs
+├── user/         # Módulo de gerenciamento de usuários (CRUD completo)
+├── app.module.ts # Módulo raiz da aplicação
+├── main.ts       # Arquivo de entrada (bootstrap da aplicação)
+└── data-source.ts# Configuração da conexão com o banco de dados para o TypeORM
+```
+
+---
+
+## 🔌 Addons Disponíveis
+
+Na pasta `addons/` do repositório de templates, você encontra módulos opcionais que podem ser adicionados ao projeto:
+
+| Addon        | Descrição                                                            |
+| ------------ | -------------------------------------------------------------------- |
+| `.github`    | Workflows de CI/CD, Dependabot, labeler, semantic PR, stale issues   |
+| `.husky`     | Git hooks para Conventional Commits e lint pré-commit                |
+| `cloudinary` | Módulo NestJS para upload, delete e replace de imagens no Cloudinary |
+
+---
+
+## 🔧 Scripts Úteis
+
+### Migrations do TypeORM
+
+- **Gerar uma nova migration a partir das mudanças nas entidades:**
+
+  ```bash
+  npm run migration:generate -- -n NomeDaMigration
+  ```
+
+- **Executar migrations pendentes:**
+
+  ```bash
+  npm run migration:run
+  ```
+
+- **Reverter a última migration:**
+  ```bash
+  npm run migration:revert
+  ```
+
+### Testes
+
+- **Executar todos os testes unitários e de integração:**
+
+  ```bash
+  npm run test
+  ```
+
+- **Executar testes em modo de observação:**
+
+  ```bash
+  npm run test:watch
+  ```
+
+- **Verificar a cobertura de testes:**
+
+  ```bash
+  npm run test:cov
+  ```
+
+- **Executar testes end-to-end (E2E):**
+  ```bash
+  npm run test:e2e
+  ```
+
+### Lint e Formatação
+
+- **Verificar e corrigir erros de lint com ESLint:**
+
+  ```bash
+  npm run lint
+  ```
+
+- **Formatar o código com Prettier:**
+  ```bash
+  npm run format
+  ```

package/templates/nest/addons/.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    groups:
+      dependencies:
+        patterns:
+          - "*"
+    open-pull-requests-limit: 10

package/templates/nest/addons/.github/labeler.yml

@@ -0,0 +1,34 @@
+# Area Labels
+area/auth:
+  - src/auth/**/*
+  - src/common/guards/**/*
+  - src/common/decorators/**/*
+
+area/user:
+  - src/user/**/*
+
+area/project:
+  - src/project/**/*
+
+area/news:
+  - src/news/**/*
+
+area/event:
+  - src/event/**/*
+
+# Type Labels (Inferred from files)
+documentation:
+  - README.md
+  - LICENSE
+  - '**/*.md'
+
+ci:
+  - .github/**/*
+
+test:
+  - test/**/*
+  - '**/*.spec.ts'
+
+dependencies:
+  - package.json
+  - package-lock.json

package/templates/nest/addons/.github/workflows/check-branch.yml

@@ -0,0 +1,24 @@
+name: Check Branch Up-to-Date
+
+on:
+  pull_request:
+    branches: [ main, develop, master, dev ]
+
+jobs:
+  check-up-to-date:
+    name: Check if branch is up-to-date
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Check if branch is up-to-date
+        run: |
+          git fetch origin ${{ github.base_ref }}
+          git fetch origin ${{ github.head_ref }}
+          if ! git merge-base --is-ancestor origin/${{ github.base_ref }} origin/${{ github.head_ref }}; then
+            echo "::error::Branch is behind ${{ github.base_ref }}. Please merge/rebase before continuing."
+            exit 1
+          fi

package/templates/nest/addons/.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: CI
+on:
+  push:
+    branches: [ main, develop, master, dev ]
+  pull_request:
+    branches: [ main, develop, master, dev ]
+
+jobs:
+  build-and-test:
+    name: Build and Test
+    runs-on: ubuntu-latest
+    
+    strategy:
+      matrix:
+        node-version: [24.x]
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Setup Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Install dependencies
+        run: npm install
+      - name: Lint
+        run: npm run lint
+        
+      - name: Build
+        run: npm run build

package/templates/nest/addons/.github/workflows/draft-release.yml

@@ -0,0 +1,22 @@
+name: Release Drafter
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types: [opened, reopened, synchronize]
+
+permissions:
+  contents: read
+
+jobs:
+  update_release_draft:
+    permissions:
+      contents: write
+      pull-requests: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: release-drafter/release-drafter@v6
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/templates/nest/addons/.github/workflows/pr-labeler.yml

@@ -0,0 +1,16 @@
+name: "Pull Request Labeler"
+on:
+  pull_request_target:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  triage:
+    permissions:
+      contents: read
+      pull-requests: write
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/labeler@v5
+      with:
+        repo-token: "${{ secrets.GITHUB_TOKEN }}"
+        sync-labels: true

package/templates/nest/addons/.github/workflows/release.yml

@@ -0,0 +1,33 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  release:
+    name: Create Release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Build
+        run: npm run build
+
+      - name: Create Release
+        uses: softprops/action-gh-release@v1
+        if: startsWith(github.ref, 'refs/tags/')
+        with:
+          generate_release_notes: true

package/templates/nest/addons/.github/workflows/security-audit.yml

@@ -0,0 +1,17 @@
+name: Security Audit
+
+on:
+  push:
+    branches: [ main, develop, master, dev ]
+  pull_request:
+    branches: [ main, develop, master, dev ]
+
+jobs:
+  audit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install dependencies
+        run: npm install
+      - name: Audit components
+        run: npm audit --audit-level=critical

package/templates/nest/addons/.github/workflows/semantic-pr.yml

@@ -0,0 +1,31 @@
+name: Semantic PR
+
+on:
+  pull_request:
+    types:
+      - opened
+      - edited
+      - synchronize
+
+jobs:
+  main:
+    name: Validate PR title
+    runs-on: ubuntu-latest
+    steps:
+      - uses: amannn/action-semantic-pull-request@v5
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          types: |
+            feat
+            fix
+            docs
+            style
+            refactor
+            perf
+            test
+            build
+            ci
+            chore
+            revert
+          requireScope: false

package/templates/nest/addons/.github/workflows/stale.yml

@@ -0,0 +1,24 @@
+name: "Stale"
+on:
+  schedule:
+     - cron: "30 1 */4 * *" 
+
+jobs:
+  stale:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+    steps:
+      - uses: actions/stale@v9
+        with:
+          stale-issue-message: "Esta issue está inativa há 60 dias. Marque como 'fresco' ou comente para reativar."
+          stale-pr-message: "Este PR está inativo há 60 dias. Marque como 'fresco' ou comente para reativar."
+          close-issue-message: "Esta issue foi fechada por inatividade."
+          close-pr-message: "Este PR foi fechado por inatividade."
+          days-before-issue-stale: 60
+          days-before-pr-stale: 60
+          days-before-issue-close: 7
+          days-before-pr-close: 7
+          exempt-issue-labels: "security,bug,enhancement,pinned,long-term"
+          exempt-pr-labels: "security,bug,enhancement,pinned,long-term"

package/templates/nest/addons/.husky/commit-msg

@@ -0,0 +1,17 @@
+#!/bin/sh
+
+# Regex for Conventional Commits
+pattern="^(feat|fix|docs|style|refactor|perf|test|build|ci|chore|revert)(\(.+\))?: .+$"
+
+while read -r line; do
+  if ! echo "$line" | grep -qE "$pattern"; then
+    echo "❌ Invalid commit message format."
+    echo "Please use the Conventional Commits pattern:"
+    echo "  <type>(<scope>): <subject>"
+    echo "Valid types: feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert"
+    echo "Example: feat(auth): add google login"
+    exit 1
+  fi
+  # Only check the first line (subject)
+  break
+done < "$1"

package/templates/nest/addons/.husky/pre-commit

@@ -0,0 +1 @@
+npm run lint

package/templates/nest/addons/addons.json

@@ -0,0 +1,17 @@
+[
+  {
+    "name": "cloudinary",
+    "label": "Cloudinary (Upload de Imagens)",
+    "dest": "src/cloudinary"
+  },
+  {
+    "name": ".github",
+    "label": "GitHub Actions (CI/CD)",
+    "dest": ".github"
+  },
+  {
+    "name": ".husky",
+    "label": "Husky (Lint & Commits)",
+    "dest": ".husky"
+  }
+]

package/templates/nest/addons/cloudinary/cloudinary.module.ts

@@ -0,0 +1,11 @@
+import { Module } from '@nestjs/common';
+import { ConfigModule } from '@nestjs/config';
+import { CloudinaryProvider } from './cloudinary.provider';
+import { CloudinaryService } from './cloudinary.service';
+
+@Module({
+  imports: [ConfigModule],
+  providers: [CloudinaryProvider, CloudinaryService],
+  exports: [CloudinaryService],
+})
+export class CloudinaryModule {}

package/templates/nest/addons/cloudinary/cloudinary.provider.ts

@@ -0,0 +1,16 @@
+import { v2 as cloudinary } from 'cloudinary';
+import { ConfigService } from '@nestjs/config';
+
+export const CloudinaryProvider = {
+  provide: 'CLOUDINARY',
+  useFactory: (configService: ConfigService) => {
+    cloudinary.config({
+      cloud_name: configService.get<string>('CLOUDINARY_CLOUD_NAME'),
+      api_key: configService.get<string>('CLOUDINARY_API_KEY'),
+      api_secret: configService.get<string>('CLOUDINARY_API_SECRET'),
+      secure: true,
+    });
+    return cloudinary;
+  },
+  inject: [ConfigService],
+};

package/templates/nest/addons/cloudinary/cloudinary.service.ts

@@ -0,0 +1,54 @@
+import { Injectable, Inject, BadRequestException } from '@nestjs/common';
+import { UploadApiResponse, v2 as cloudinaryType } from 'cloudinary';
+import { ERRORS } from '../common/constants/errors.constants';
+
+@Injectable()
+export class CloudinaryService {
+  constructor(
+    @Inject('CLOUDINARY') private cloudinaryInstance: typeof cloudinaryType,
+  ) {}
+
+  async uploadImage(
+    file: Express.Multer.File,
+    folder: string,
+  ): Promise<UploadApiResponse> {
+    if (!file || !file.buffer) {
+      throw new BadRequestException(ERRORS.IMAGE.REQUIRED);
+    }
+
+    const fileBase64 = file.buffer.toString('base64');
+    const dataUri = `data:${file.mimetype};base64,${fileBase64}`;
+
+    return this.cloudinaryInstance.uploader.upload(dataUri, {
+      folder: folder,
+      resource_type: 'image',
+    });
+  }
+
+  async deleteImage(publicId: string): Promise<{ result: string }> {
+    return this.cloudinaryInstance.uploader.destroy(publicId) as Promise<{
+      result: string;
+    }>;
+  }
+
+  async replaceImage(
+    file: Express.Multer.File,
+    folder: string,
+    oldPublicId?: string,
+  ): Promise<UploadApiResponse> {
+    if (!file) {
+      throw new BadRequestException(ERRORS.IMAGE.REQUIRED);
+    }
+    if (oldPublicId) {
+      await this.deleteImage(oldPublicId);
+    }
+    return this.uploadImage(file, folder);
+  }
+
+  async deleteImages(publicIds: string[]): Promise<Record<string, unknown>> {
+    if (!publicIds.length) return {};
+    return this.cloudinaryInstance.api.delete_resources(publicIds) as Promise<
+      Record<string, unknown>
+    >;
+  }
+}

package/templates/nest/docker-compose.yml

@@ -0,0 +1,58 @@
+version: "3.9"
+
+services:
+  api-prod:
+    container_name: api_prod
+    build:
+      context: .
+      dockerfile: Dockerfile
+      target: production 
+    command: npm run start:prod
+    ports:
+      - "3000:3000"
+    env_file:
+      - .env 
+    depends_on:
+      postgres:
+        condition: service_healthy
+    restart: unless-stopped
+    profiles: ["prod"]
+
+  api-dev:
+    container_name: api_dev
+    build:
+      context: .
+      dockerfile: Dockerfile
+      target: development 
+    command: npm run start:dev 
+    ports:
+      - "3000:3000"
+    env_file:
+      - .env
+    depends_on:
+      postgres:
+        condition: service_healthy
+    volumes:
+      - .:/usr/src/app
+      - /usr/src/app/node_modules
+    restart: unless-stopped
+    profiles: ["dev"] 
+
+  postgres:
+    image: postgres:15
+    container_name: postgres
+    restart: unless-stopped
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U $${POSTGRES_USER} -d $${POSTGRES_DB}"]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+    env_file:
+      - .env
+    ports:
+      - "5432:5432"
+    volumes:
+      - db_data:/var/lib/postgresql/data
+
+volumes:
+  db_data:

package/templates/nest/eslint.config.mjs

@@ -0,0 +1,34 @@
+// @ts-check
+import eslint from '@eslint/js';
+import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended';
+import globals from 'globals';
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(
+  {
+    ignores: ['eslint.config.mjs'],
+  },
+  eslint.configs.recommended,
+  ...tseslint.configs.recommendedTypeChecked,
+  eslintPluginPrettierRecommended,
+  {
+    languageOptions: {
+      globals: {
+        ...globals.node,
+        ...globals.jest,
+      },
+      sourceType: 'commonjs',
+      parserOptions: {
+        projectService: true,
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+  },
+  {
+    rules: {
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/no-floating-promises': 'warn',
+      '@typescript-eslint/no-unsafe-argument': 'warn'
+    },
+  },
+);