Changelog

Notas de versión. Para el historial completo, consulta los GitHub Releases en MarvinRF/nest-docfy.

Consulta GitHub Releases y CHANGELOG.md en el repositorio para el historial canónico, a nivel de commit.

v0.9.0 (versión actual)

  • Documenta specs, openApiDocument y additionalProxyOrigins en DocfyUiModule.setup(). specs ya existía sin documentar desde la v0.6.0; las otras dos son el catch-up de docs de esta versión para el proxy introducido en la v0.8.0. Fija la dependencia de docfy-ui en ^0.5.0.

v0.8.0

  • Proxy same-origin para el "Try it out" de docfy-ui, habilitado vía las nuevas opciones de DocfyUiModule.setup() openApiDocument/additionalProxyOrigins. Evita CORS por completo; los fallos a nivel de proxy son distinguibles de respuestas reales de la API vía un header de respuesta X-Docfy-Proxy-Error.

v0.7.0

  • Nuevo comando de CLI export: genera el documento OpenAPI a partir de tu propio bootstrap sin necesitar .listen() ni infraestructura viva.

v0.6.1 – v0.6.3

  • Infiere el schema completo para entidades de respuesta sin decorators de class-validator.
  • Actualiza la dependencia fijada de docfy-ui a ^0.3.0.
  • Colapsa uniones de literales boolean en un schema boolean simple.

v0.6.0

  • Bot de PR-check: hace dogfooding de check/coverage contra la app de ejemplo en CI.
  • Flag --json para check y coverage, para salida legible por máquina.
  • Opción specs para el selector multi-spec de docfy-ui.
  • --register-plugin arregla automáticamente webpack: true sin necesitar configurar el plugin de CLI a mano.
  • Nuevo comando generate-client: un cliente TypeScript tipado generado a partir de una spec OpenAPI.

v0.5.0

  • Primera versión versionada vía semantic-release/conventional commits. Consolida el tooling anterior bajo semver real de aquí en adelante. Ninguna función nueva de cara al usuario más allá de lo ya descrito arriba.

v0.4.0

  • DocfyUiModule ahora funciona en apps Fastify (@nestjs/platform-fastify), no solo Express. Necesita la peer dependency opcional @fastify/static.
  • /api-json (staticSpecPath) y el handler de fallback ahora usan res.type()/res.send(), agnósticos de adapter, en vez de APIs exclusivas de Express.

v0.3.6

  • Corrige una condición de export por defecto faltante en el exports map del paquete.

v0.3.5

  • Soporte de routing mejorado en DocfyUiModule; actualiza la dependencia companion docfy-ui a 0.0.5.

v0.3.3 – v0.3.4

  • Versiones de mantenimiento: actualiza la dependencia companion docfy-ui (a 0.0.3 y luego 0.0.4). Sin cambios funcionales en nestjs-docfy en sí.

v0.3.1 – v0.3.2

  • Versiones de mantenimiento (solo metadatos de lockfile/versión), sin cambios funcionales.

v0.3.0

  • Se introduce DocfyUiModule: sirve docfy-ui por defecto, con un modo static-spec seguro para webpack.
  • Comando de CLI patch-spec: parcheo de OpenAPI solo con análisis estático.
  • Comando coverage para métricas de documentación, y comando lint para checks de calidad de la documentación.
  • Tag groups (x-tagGroups) para ReDoc.
  • Fixes: fusión de tags sensible a mayúsculas que dividía el grupo del sidebar, patch-spec perdiendo campos cuando dos controllers parcheaban la misma ruta, resolución del source del controller vía stack+source-map, falsos positivos de avisos de docs-file faltante, y un crash en entradas de require.cache con getters que lanzan errores.
  • Docs: webpack: true documentado como no soportado fundamentalmente, explicando por qué.

v0.2.8

  • Comando check, reconocimiento de @HttpCode(), e inferencia de schema desde class-validator.

v0.2.7

  • Elimina la telemetría de @scarf/scarf vía un override de swagger-ui-dist; mejoras de estructura y claridad en el README.

v0.2.5 – v0.2.6

  • Salida de ApiResponse más rica, con descripciones y respuestas de error (la v0.2.6 fue una versión de mantenimiento sin más cambios funcionales).

v0.2.4

  • Generación de schema inline para DTOs tipados como interface.

v0.2.3

  • Salida de CLI completa: ApiParam/ApiBody/ApiQuery, summaries inferidos, ApiBearerAuth, y modo watch.

v0.2.2

  • Se añade inferencia del tipo de DTO de respuesta a la salida de ApiResponse.

v0.2.1

  • generate ahora produce decorators listos para usar en vez de placeholders comentados.

v0.2.0

  • El comando de CLI nestjs-docfy generate, la primera función de CLI.

v0.1.1 – v0.1.4

  • Versión inicial: la convención de archivo companion @WithDocs()/docs() y DocfyModule.forRoot().
  • Claves de método type-safe en docs() vía generics (v0.1.4).