docs: update copy for NestJS

Author: mrlubos

.changeset/bright-wasps-invite.md

@@ -0,0 +1,5 @@
+---
+"@hey-api/openapi-ts": patch
+---
+
+**plugin(nestjs)**: initial release

docs/.vitepress/config/en.ts

@@ -227,6 +227,10 @@ export default defineConfig({
                 link: '/openapi-ts/plugins/fastify',
                 text: 'Fastify',
               },
+              {
+                link: '/openapi-ts/plugins/nest',
+                text: 'Nest',
+              },
               {
                 link: '/openapi-ts/plugins/adonis',
                 text: 'Adonis <span data-soon>soon</span>',
@@ -247,10 +251,6 @@ export default defineConfig({
                 link: '/openapi-ts/plugins/koa',
                 text: 'Koa <span data-soon>soon</span>',
               },
-              {
-                link: '/openapi-ts/plugins/nest',
-                text: 'Nest',
-              },
             ],
             link: '/openapi-ts/web-frameworks',
             text: 'Web Frameworks',

docs/.vitepress/theme/components/Examples.vue

@@ -0,0 +1,28 @@
+<script setup lang="ts">
+const props = defineProps<{
+  githubExamplePath?: string;
+}>();
+</script>
+
+<template>
+  <h2 id="examples" tabindex="-1">
+    Examples
+    <a class="header-anchor" href="#examples" aria-label="Permalink to “Examples”">​</a>
+  </h2>
+  <p>
+    You can view live examples on
+    <a
+      href="https://stackblitz.com/orgs/github/hey-api/collections/openapi-ts-examples"
+      target="_blank"
+      rel="noreferrer"
+      >StackBlitz</a
+    >
+    or on
+    <a
+      :href="`https://github.com/hey-api/openapi-ts/tree/main/examples${props.githubExamplePath ? props.githubExamplePath : ''}`"
+      target="_blank"
+      rel="noreferrer"
+      >GitHub</a
+    >.
+  </p>
+</template>

docs/data/people.ts

@@ -27,3 +27,8 @@ export const sebastiaanWouters: Person = {
   github: 'https://github.com/SebastiaanWouters',
   name: 'Sebastiaan Wouters',
 };
+
+export const yuriMikhin: Person = {
+  github: 'https://github.com/mikhin',
+  name: 'Yuri Mikhin',
+};

docs/openapi-ts/plugins/fastify.md

@@ -5,6 +5,7 @@ description: Generate Fastify v5 route handlers from OpenAPI with the Fastify pl
 
 <script setup lang="ts">
 import AuthorsList from '@components/AuthorsList.vue';
+import Examples from '@components/Examples.vue';
 import Heading from '@components/Heading.vue';
 import { jacobCohen } from '@data/people.js';
 import VersionLabel from '@components/VersionLabel.vue';
@@ -99,5 +100,6 @@ export default {
 
 You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/fastify/types.ts) interface.
 
-<!--@include: ../../partials/examples.md-->
+<Examples githubExamplePath="/openapi-ts-fastify" />
+
 <!--@include: ../../partials/sponsors.md-->

docs/openapi-ts/plugins/nest.md

@@ -1,15 +1,18 @@
 ---
-title: NestJS Plugin
-description: Generate NestJS controller method types from OpenAPI specs. Type-safe controllers via implements.
+title: NestJS v11 Plugin
+description: Generate NestJS v11 controller methods from OpenAPI with the NestJS plugin for openapi-ts. Fully compatible with validators, transformers, and all core features.
 ---
 
 <script setup lang="ts">
+import AuthorsList from '@components/AuthorsList.vue';
+import Examples from '@components/Examples.vue';
 import Heading from '@components/Heading.vue';
+import { yuriMikhin } from '@data/people.js';
 import VersionLabel from '@components/VersionLabel.vue';
 </script>
 
 <Heading>
-  <h1>NestJS</h1>
+  <h1>NestJS<span class="sr-only"> v11</span></h1>
   <VersionLabel value="v11" />
 </Heading>
 
@@ -19,18 +22,24 @@ NestJS plugin is currently in beta. The interface might change before it becomes
 
 ### About
 
-The NestJS plugin generates type-safe controller method signatures from your OpenAPI spec.
+[Nest](https://nestjs.com) is a progressive Node.js framework for building efficient, reliable and scalable server-side applications.
+
+The NestJS plugin for Hey API generates type-safe controller method signatures from your OpenAPI spec, fully compatible with all core features.
+
+### Collaborators
+
+<AuthorsList :people="[yuriMikhin]" />
 
 ## Features
 
-- type-safe controller methods via `implements`
-- tag-based grouping for per-controller types
-- incremental adoption with `Pick<ControllerMethods, ...>`
-- zero runtime coupling — pure TypeScript types
+- NestJS v11 support
+- seamless integration with `@hey-api/openapi-ts` ecosystem
+- type-safe controller methods
+- minimal learning curve thanks to extending the underlying technology
 
 ## Installation
 
-In your [configuration](/openapi-ts/get-started), add `nestjs` to your plugins.
+In your [configuration](/openapi-ts/get-started), add `nestjs` to your plugins and you'll be ready to generate NestJS artifacts. :tada:
 
 ```js
 export default {
@@ -45,12 +54,18 @@ export default {
 
 ## Output
 
-Operations are grouped by their first OpenAPI tag into separate types like `PetsControllerMethods`, `StoreControllerMethods`, etc.
+The NestJS plugin will generate the following artifacts, depending on the input specification.
+
+## Controller Methods
+
+Operations are grouped by their first tag into separate types.
 
-```ts
+::: code-group
+
+```ts [example]
 export type PetsControllerMethods = {
-  listPets: (query?: ListPetsData['query']) => Promise<ListPetsResponse>;
   createPet: (body: CreatePetData['body']) => Promise<CreatePetResponse>;
+  listPets: (query?: ListPetsData['query']) => Promise<ListPetsResponse>;
   showPetById: (path: ShowPetByIdData['path']) => Promise<ShowPetByIdResponse>;
 };
 
@@ -59,10 +74,9 @@ export type StoreControllerMethods = {
 };
 ```
 
-## Usage
-
-```ts
+```ts [usage]
 import { Body, Controller, Get, Param, Post, Query } from '@nestjs/common';
+
 import type { PetsControllerMethods } from '../client/nestjs.gen';
 import type { CreatePetData, ListPetsData, ShowPetByIdData } from '../client/types.gen';
 
@@ -71,44 +85,23 @@ export class PetsController implements Pick<
   PetsControllerMethods,
   'createPet' | 'listPets' | 'showPetById'
 > {
-  @Get()
-  async listPets(@Query() query?: ListPetsData['query']) {
-    // ...
-  }
-
   @Post()
-  async createPet(@Body() body: CreatePetData['body']) {
-    // ...
-  }
+  async createPet(@Body() body: CreatePetData['body']) {}
+
+  @Get()
+  async listPets(@Query() query?: ListPetsData['query']) {}
 
   @Get(':petId')
-  async showPetById(@Param() path: ShowPetByIdData['path']) {
-    // ...
-  }
+  async showPetById(@Param() path: ShowPetByIdData['path']) {}
 }
 ```
 
-## Example
-
-The [openapi-ts-nestjs example](https://github.com/hey-api/openapi-ts/tree/main/examples/openapi-ts-nestjs) demonstrates the plugin with a minimal NestJS v11 app featuring two controllers and integration tests.
-
-## Constraints
-
-The `implements` pattern requires **whole-object parameter style** with NestJS decorators:
+:::
 
-```ts
-// WORKS with implements - whole-object style (recommended)
-@Get(':petId')
-async showPetById(@Param() path: ShowPetByIdData['path']) { ... }
+## API
 
-// DOES NOT WORK with implements - decomposed style
-@Get(':petId')
-async showPetById(@Param('petId') petId: string) { ... }
-```
+You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/nestjs/types.ts) interface.
 
-- Methods using `@Res()` for raw response access are incompatible — the extra parameter breaks assignability
-- Operations without tags are grouped under `DefaultControllerMethods`
-- Cookie parameters are not included in generated signatures — NestJS handles cookies via `@Req()` or dedicated middleware
+<Examples githubExamplePath="/openapi-ts-nestjs" />
 
-<!--@include: ../../partials/examples.md-->
 <!--@include: ../../partials/sponsors.md-->

docs/openapi-ts/web-frameworks.md

@@ -13,12 +13,12 @@ Hey API natively supports the following frameworks.
 
 - [Angular](/openapi-ts/plugins/angular)
 - [Fastify](/openapi-ts/plugins/fastify)
+- [Nest](/openapi-ts/plugins/nest)
 - [Adonis](/openapi-ts/plugins/adonis) <span data-soon>Soon</span>
 - [Elysia](/openapi-ts/plugins/elysia) <span data-soon>Soon</span>
 - [Express](/openapi-ts/plugins/express) <span data-soon>Soon</span>
 - [Hono](/openapi-ts/plugins/hono) <span data-soon>Soon</span>
 - [Koa](/openapi-ts/plugins/koa) <span data-soon>Soon</span>
-- [Nest](/openapi-ts/plugins/nest) <span data-soon>Soon</span>
 
 Don't see your framework? Let us know your interest by [opening an issue](https://github.com/hey-api/openapi-ts/issues).
 

packages/openapi-ts/README.md

@@ -343,6 +343,7 @@ These plugins help reduce boilerplate associated with third-party dependencies.
 - [`@tanstack/svelte-query`](https://heyapi.dev/openapi-ts/plugins/tanstack-query)
 - [`@tanstack/vue-query`](https://heyapi.dev/openapi-ts/plugins/tanstack-query)
 - [`fastify`](https://heyapi.dev/openapi-ts/plugins/fastify)
+- [`nestjs`](https://heyapi.dev/openapi-ts/plugins/nest)
 - [`valibot`](https://heyapi.dev/openapi-ts/plugins/valibot)
 - [`zod`](https://heyapi.dev/openapi-ts/plugins/zod)
 
@@ -362,7 +363,6 @@ The following plugins are planned but not in development yet. You can help us pr
 - [Joi](https://heyapi.dev/openapi-ts/plugins/joi)
 - [Koa](https://heyapi.dev/openapi-ts/plugins/koa)
 - [MSW](https://heyapi.dev/openapi-ts/plugins/msw)
-- [Nest](https://heyapi.dev/openapi-ts/plugins/nest)
 - [Nock](https://heyapi.dev/openapi-ts/plugins/nock)
 - [Superstruct](https://heyapi.dev/openapi-ts/plugins/superstruct)
 - [Supertest](https://heyapi.dev/openapi-ts/plugins/supertest)

packages/openapi-ts/src/index.ts

@@ -211,10 +211,6 @@ export namespace Plugins {
     export type Types = FastifyPlugin;
   }
 
-  export namespace NestJs {
-    export type Types = NestJsPlugin;
-  }
-
   export namespace HeyApiClientAngular {
     export type Client = AngularClientImp;
     export type Types = HeyApiClientAngularPlugin;
@@ -267,6 +263,10 @@ export namespace Plugins {
     export type Types = HeyApiTypeScriptPlugin;
   }
 
+  export namespace NestJs {
+    export type Types = NestJsPlugin;
+  }
+
   export namespace PiniaColada {
     export type Types = PiniaColadaPlugin;
   }