Journal des modifications

Notes de version. Pour l'historique complet, voir les Releases GitHub sur MarvinRF/nest-docfy.

Voir les Releases GitHub et le CHANGELOG.md du dépôt pour l'historique canonique, commit par commit.

v0.9.0 (version actuelle)

  • Documente specs, openApiDocument et additionalProxyOrigins dans DocfyUiModule.setup(). specs existait sans être documenté depuis la v0.6.0 ; les deux autres comblent le retard de doc pour le proxy introduit en v0.8.0. Épingle la dépendance docfy-ui à ^0.5.0.

v0.8.0

  • Proxy same-origin pour le « Try it out » de docfy-ui, activé via les nouvelles options openApiDocument/additionalProxyOrigins de DocfyUiModule.setup(). Évite CORS entièrement ; les échecs côté proxy se distinguent des vraies réponses de l'API via un en-tête de réponse X-Docfy-Proxy-Error.

v0.7.0

  • Nouvelle commande CLI export : génère le document OpenAPI à partir de ton propre bootstrap sans exiger .listen() ni d'infrastructure en direct.

v0.6.1 – v0.6.3

  • Infère le schéma complet pour les entités de réponse sans décorateurs class-validator.
  • Dépendance docfy-ui épinglée relevée à ^0.3.0.
  • Réduit les unions de littéraux booléens à un simple schéma booléen.

v0.6.0

  • Bot de vérification de PR : utilise check/coverage en interne, contre l'app d'exemple, en CI.
  • Option --json pour check et coverage, pour une sortie exploitable par une machine.
  • Option specs pour le sélecteur multi-spec de docfy-ui.
  • --register-plugin corrige automatiquement webpack: true sans devoir configurer le plugin CLI à la main.
  • Nouvelle commande generate-client : un client TypeScript typé généré à partir d'une spec OpenAPI.

v0.5.0

  • Première release versionnée via semantic-release et les conventional commits. Consolide l'outillage précédent sous un vrai semver. Aucune nouvelle fonctionnalité visible au-delà de ce qui est déjà décrit ci-dessus.

v0.4.0

  • DocfyUiModule fonctionne désormais sur les apps Fastify (@nestjs/platform-fastify), pas seulement Express. Nécessite la dépendance peer optionnelle @fastify/static.
  • /api-json (staticSpecPath) et le handler de repli utilisent maintenant res.type()/res.send(), agnostiques de l'adaptateur, plutôt que des API réservées à Express.

v0.3.6

  • Correction d'une condition d'export par défaut manquante dans le exports map du package.

v0.3.5

  • Meilleur support du routage dans DocfyUiModule ; dépendance compagnon docfy-ui relevée à 0.0.5.

v0.3.3 – v0.3.4

  • Releases de maintenance : dépendance compagnon docfy-ui relevée (à 0.0.3, puis 0.0.4). Aucun changement fonctionnel dans nestjs-docfy lui-même.

v0.3.1 – v0.3.2

  • Releases de maintenance (lockfile et métadonnées de version uniquement), aucun changement fonctionnel.

v0.3.0

  • Introduction de DocfyUiModule : sert docfy-ui par défaut, avec un mode spec statique compatible webpack.
  • Commande CLI patch-spec : patch OpenAPI par analyse statique uniquement.
  • Commande coverage pour les métriques de documentation, et commande lint pour vérifier la qualité de la documentation.
  • Groupes de tags (x-tagGroups) pour ReDoc.
  • Corrections : fusion de tags sensible à la casse qui divisait le groupe dans la sidebar, patch-spec qui perdait des champs quand deux contrôleurs patchaient la même route, résolution de la source du contrôleur via stack et source map, faux positifs d'avertissement de fichier docs manquant, et un crash sur des entrées de require.cache avec des getters qui lèvent une exception.
  • Docs : webpack: true documenté comme fondamentalement non supporté, avec les raisons.

v0.2.8

  • Commande check, prise en compte de @HttpCode(), et inférence de schéma class-validator.

v0.2.7

  • Télémétrie @scarf/scarf supprimée via un override de swagger-ui-dist ; structure et clarté du README améliorées.

v0.2.5 – v0.2.6

  • Sortie ApiResponse enrichie, avec descriptions et réponses d'erreur (la v0.2.6 était une release de maintenance sans autre changement fonctionnel).

v0.2.4

  • Génération de schéma en ligne pour les DTO typés en interface.

v0.2.3

  • Sortie CLI complète : ApiParam/ApiBody/ApiQuery, résumés inférés, ApiBearerAuth, et mode watch.

v0.2.2

  • Inférence du type de réponse du DTO ajoutée à la sortie ApiResponse.

v0.2.1

  • generate produit désormais des décorateurs prêts à l'emploi au lieu de placeholders commentés.

v0.2.0

  • La commande CLI nestjs-docfy generate, la toute première fonctionnalité CLI.

v0.1.1 – v0.1.4

  • Première release : la convention de fichier compagnon @WithDocs()/docs() et DocfyModule.forRoot().
  • Clés de méthode type-safe dans docs() via les génériques (v0.1.4).