Changelog

Notas de versão. Para o histórico completo, consulte GitHub Releases em MarvinRF/nest-docfy.

Consulte GitHub Releases e o CHANGELOG.md no repositório para o histórico canônico, por commit.

v0.9.0 (versão atual)

  • Documenta specs, openApiDocument e additionalProxyOrigins no DocfyUiModule.setup(). specs existia sem documentação desde a v0.6.0; as outras duas são o catch-up de docs pro proxy introduzido na v0.8.0. Fixa a dependência docfy-ui em ^0.5.0.

v0.8.0

  • Proxy same-origin pro "Try it out" do docfy-ui, habilitado via novas opções do DocfyUiModule.setup(): openApiDocument/additionalProxyOrigins. Evita CORS por completo; falhas no nível do proxy são distinguíveis de respostas reais da API via um header de resposta X-Docfy-Proxy-Error.

v0.7.0

  • Novo comando CLI export: gera o documento OpenAPI a partir do seu próprio bootstrap, sem precisar de .listen() nem infra viva.

v0.6.1 – v0.6.3

  • Inferir o schema completo pra response entities sem decorators do class-validator.
  • Bump da dependência fixada de docfy-ui pra ^0.3.0.
  • Colapsar union de literais booleanos num schema boolean simples.

v0.6.0

  • Bot de PR-check: faz dogfood de check/coverage contra o app de exemplo no CI.
  • Flag --json pra check e coverage, pra saída legível por máquina.
  • Opção specs pro multi-spec switcher do docfy-ui.
  • --register-plugin corrige automaticamente webpack: true sem precisar configurar o plugin do CLI na mão.
  • Novo comando generate-client: um client TypeScript tipado gerado a partir de um spec OpenAPI.

v0.5.0

  • Primeira versão versionada via semantic-release/conventional commits. Consolida o tooling anterior sob semver de verdade daqui pra frente. Nenhuma feature nova pro usuário além do que já foi descrito acima.

v0.4.0

  • DocfyUiModule agora funciona em apps Fastify (@nestjs/platform-fastify), não só Express. Precisa da dependência peer opcional @fastify/static.
  • /api-json (staticSpecPath) e o handler de fallback agora usam res.type()/res.send() (agnóstico de adapter) em vez de APIs específicas do Express.

v0.3.6

  • Corrigido export map do pacote, que faltava a condição de default export.

v0.3.5

  • Suporte de roteamento aprimorado no DocfyUiModule; dependência docfy-ui atualizada para 0.0.5.

v0.3.3 – v0.3.4

  • Releases de manutenção: dependência docfy-ui atualizada (para 0.0.3, depois 0.0.4). Sem mudanças funcionais no nestjs-docfy em si.

v0.3.1 – v0.3.2

  • Releases de manutenção (só lockfile/metadados de versão), sem mudanças funcionais.

v0.3.0

  • DocfyUiModule introduzido: serve o docfy-ui por padrão, com um modo static-spec seguro para webpack.
  • Comando CLI patch-spec: patch de OpenAPI só por análise estática.
  • Comando coverage para métricas de documentação, e lint para checar qualidade da documentação.
  • Tag groups (x-tagGroups) para ReDoc.
  • Correções: merge de tags case-sensitive que quebrava o grupo na sidebar, patch-spec perdendo campos quando dois controllers faziam patch na mesma rota, resolução do arquivo fonte do controller via stack+source-map, avisos de docs file ausente com falso-positivo, e um crash em entradas de require.cache com getters que lançam exceção.
  • Docs: webpack: true documentado como fundamentalmente não suportado, com a justificativa.

v0.2.8

  • Comando check, reconhecimento de @HttpCode(), e inferência de schema via class-validator.

v0.2.7

  • Telemetria do @scarf/scarf removida via override de swagger-ui-dist; melhorias de estrutura e clareza no README.

v0.2.5 – v0.2.6

  • Output de ApiResponse mais rico, com descrições e respostas de erro (v0.2.6 foi um release de manutenção, sem mudança funcional adicional).

v0.2.4

  • Geração de schema inline para DTOs tipados como interface.

v0.2.3

  • Output completo do CLI: ApiParam/ApiBody/ApiQuery, resumos inferidos, ApiBearerAuth, e modo watch.

v0.2.2

  • Inferência do tipo de resposta do DTO adicionada ao output de ApiResponse.

v0.2.1

  • generate agora produz decorators prontos para uso, em vez de placeholders comentados.

v0.2.0

  • Comando CLI nestjs-docfy generate, o primeiro recurso de CLI.

v0.1.1 – v0.1.4

  • Release inicial: a convenção de companion file @WithDocs()/docs() e DocfyModule.forRoot().
  • Chaves de método type-safe em docs() via generics (v0.1.4).