[typescript-nestjs-server] #22928 correctly parse numeric parameters, use DefaultValuePipe for default values

aryobenholzner · aryobenholzner · commit f3b4491c80ea · 2026-02-13T23:59:00.000+01:00
diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/TypeScriptNestjsServerCodegen.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/TypeScriptNestjsServerCodegen.java
@@ -156,7 +156,9 @@ public void processOpts() {
         supportingFiles.add(new SupportingFile("api-implementations.mustache", "", "api-implementations.ts"));
         supportingFiles.add(new SupportingFile("api.module.mustache", "", "api.module.ts"));
         supportingFiles.add(new SupportingFile("controllers.mustache", "controllers", "index.ts"));
-        supportingFiles.add(new SupportingFile("cookies-decorator.mustache", "cookies-decorator.ts"));
+        supportingFiles.add(new SupportingFile("cookies-decorator.mustache", "decorators", "cookies-decorator.ts"));
+        supportingFiles.add(new SupportingFile("headers-decorator.mustache", "decorators", "headers-decorator.ts"));
+        supportingFiles.add(new SupportingFile("decorators.mustache", "decorators", "index.ts"));
         supportingFiles.add(new SupportingFile("gitignore", "", ".gitignore"));
         supportingFiles.add(new SupportingFile("README.md", "", "README.md"));
         supportingFiles.add(new SupportingFile("tsconfig.mustache", "", "tsconfig.json"));
diff --git a/modules/openapi-generator/src/main/resources/typescript-nestjs-server/controller.mustache b/modules/openapi-generator/src/main/resources/typescript-nestjs-server/controller.mustache
@@ -1,6 +1,6 @@
-import { Body, Controller{{#httpMethods}}, {{.}}{{/httpMethods}}, Param, Query, Headers, Req } from '@nestjs/common';
+import { Body, Controller, DefaultValuePipe{{#httpMethods}}, {{.}}{{/httpMethods}}, Param, ParseIntPipe, ParseFloatPipe, Query, Req } from '@nestjs/common';
 import { Observable } from 'rxjs';
-import { Cookies } from '../cookies-decorator';
+import { Cookies, Headers } from '../decorators';
 import { {{classname}} } from '../{{apiPackage}}';
 {{#tsImports.0}}
 import { {{#tsImports}}{{classname}}, {{/tsImports}} } from '../{{modelPackage}}';
@@ -13,7 +13,7 @@ export class {{classname}}Controller {
 {{#operations}}
 {{#operation}}
   @{{#vendorExtensions.x-http-method}}{{.}}{{/vendorExtensions.x-http-method}}{{^vendorExtensions.x-http-method}}{{httpMethod}}{{/vendorExtensions.x-http-method}}('{{path}}')
-  {{operationId}}({{#allParams}}{{#isPathParam}}@Param('{{baseName}}') {{/isPathParam}}{{#isQueryParam}}@Query('{{baseName}}') {{/isQueryParam}}{{#isHeaderParam}}@Headers('{{baseName}}') {{/isHeaderParam}}{{#isCookieParam}}@Cookies('{{baseName}}') {{/isCookieParam}}{{#isBodyParam}}@Body() {{/isBodyParam}}{{paramName}}: {{{dataType}}}{{#isNullable}} | null{{/isNullable}}{{^required}} | undefined{{/required}}{{#defaultValue}} = {{{defaultValue}}}{{/defaultValue}}, {{/allParams}}@Req() request: Request): {{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}void{{/returnType}} | Promise<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}void{{/returnType}}> | Observable<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}void{{/returnType}}> {
+  {{operationId}}({{#allParams}}{{#isPathParam}}@Param('{{baseName}}'{{>paramPipe}}) {{/isPathParam}}{{#isQueryParam}}@Query('{{baseName}}'{{>paramPipe}}) {{/isQueryParam}}{{#isHeaderParam}}@Headers('{{baseName}}'{{>paramPipe}}) {{/isHeaderParam}}{{#isCookieParam}}@Cookies('{{baseName}}'{{>paramPipe}}) {{/isCookieParam}}{{#isBodyParam}}@Body() {{/isBodyParam}}{{paramName}}: {{{dataType}}}{{#isNullable}} | null{{/isNullable}}{{^required}} | undefined{{/required}}, {{/allParams}}@Req() request: Request): {{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}void{{/returnType}} | Promise<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}void{{/returnType}}> | Observable<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}void{{/returnType}}> {
     return this.{{classVarName}}.{{operationId}}({{#useSingleRequestParameter}}{ {{/useSingleRequestParameter}}{{#allParams}}{{paramName}}, {{/allParams}}{{#useSingleRequestParameter}}}, {{/useSingleRequestParameter}}request);
   }
 
diff --git a/modules/openapi-generator/src/main/resources/typescript-nestjs-server/cookies-decorator.mustache b/modules/openapi-generator/src/main/resources/typescript-nestjs-server/cookies-decorator.mustache
@@ -17,5 +17,8 @@ import { createParamDecorator, ExecutionContext } from '@nestjs/common';
 */
 export const Cookies = createParamDecorator((data: string, ctx: ExecutionContext) => {
   const request = ctx.switchToHttp().getRequest();
-  return data ? request.cookies?.[data] : request.cookies;
+  if (!data) {
+    return { ...request.cookies, ...request.signedCookies };
+  }
+  return request.cookies?.[data] ?? request.signedCookies?.[data];
 });
diff --git a/modules/openapi-generator/src/main/resources/typescript-nestjs-server/decorators.mustache b/modules/openapi-generator/src/main/resources/typescript-nestjs-server/decorators.mustache
@@ -0,0 +1,2 @@
+export * from './cookies-decorator';
+export * from './headers-decorator';
diff --git a/modules/openapi-generator/src/main/resources/typescript-nestjs-server/headers-decorator.mustache b/modules/openapi-generator/src/main/resources/typescript-nestjs-server/headers-decorator.mustache
@@ -0,0 +1,16 @@
+import { createParamDecorator, ExecutionContext } from '@nestjs/common';
+
+/**
+* A decorator function for retrieving headers from the request object in an HTTP context.
+* Workaround for enabling PipeTransformers on Headers (see https://github.com/nestjs/nest/issues/356)
+*
+* Usage:
+* ```
+* @Get()
+* findAll(@Headers('name') name: string) {}
+* ```
+*/
+export const Headers = createParamDecorator((data: string, ctx: ExecutionContext) => {
+const request = ctx.switchToHttp().getRequest();
+return data ? request.headers?.[data] : request.headers;
+});
diff --git a/modules/openapi-generator/src/main/resources/typescript-nestjs-server/paramPipe.mustache b/modules/openapi-generator/src/main/resources/typescript-nestjs-server/paramPipe.mustache
@@ -0,0 +1 @@
+{{#defaultValue}}, new DefaultValuePipe({{{defaultValue}}}){{/defaultValue}}{{#isNumber}}, {{#isFloat}}ParseFloatPipe{{/isFloat}}{{^isFloat}}ParseIntPipe{{/isFloat}}{{/isNumber}}
diff --git a/samples/server/petstore/typescript-nestjs-server/builds/default/.openapi-generator/FILES b/samples/server/petstore/typescript-nestjs-server/builds/default/.openapi-generator/FILES
@@ -10,7 +10,9 @@ controllers/PetApi.controller.ts
 controllers/StoreApi.controller.ts
 controllers/UserApi.controller.ts
 controllers/index.ts
-cookies-decorator.ts
+decorators/cookies-decorator.ts
+decorators/headers-decorator.ts
+decorators/index.ts
 index.ts
 models/api-response.ts
 models/category.ts
diff --git a/samples/server/petstore/typescript-nestjs-server/builds/default/controllers/PetApi.controller.ts b/samples/server/petstore/typescript-nestjs-server/builds/default/controllers/PetApi.controller.ts
@@ -1,6 +1,6 @@
-import { Body, Controller, Delete, Get, Post, Put, Param, Query, Headers, Req } from '@nestjs/common';
+import { Body, Controller, DefaultValuePipe, Delete, Get, Post, Put, Param, ParseIntPipe, ParseFloatPipe, Query, Req } from '@nestjs/common';
 import { Observable } from 'rxjs';
-import { Cookies } from '../cookies-decorator';
+import { Cookies, Headers } from '../decorators';
 import { PetApi } from '../api';
 import { ApiResponse, Pet,  } from '../models';
 
diff --git a/samples/server/petstore/typescript-nestjs-server/builds/default/controllers/StoreApi.controller.ts b/samples/server/petstore/typescript-nestjs-server/builds/default/controllers/StoreApi.controller.ts
@@ -1,6 +1,6 @@
-import { Body, Controller, Delete, Get, Post, Param, Query, Headers, Req } from '@nestjs/common';
+import { Body, Controller, DefaultValuePipe, Delete, Get, Post, Param, ParseIntPipe, ParseFloatPipe, Query, Req } from '@nestjs/common';
 import { Observable } from 'rxjs';
-import { Cookies } from '../cookies-decorator';
+import { Cookies, Headers } from '../decorators';
 import { StoreApi } from '../api';
 import { Order,  } from '../models';
 
diff --git a/samples/server/petstore/typescript-nestjs-server/builds/default/controllers/UserApi.controller.ts b/samples/server/petstore/typescript-nestjs-server/builds/default/controllers/UserApi.controller.ts
@@ -1,6 +1,6 @@
-import { Body, Controller, Delete, Get, Post, Put, Param, Query, Headers, Req } from '@nestjs/common';
+import { Body, Controller, DefaultValuePipe, Delete, Get, Post, Put, Param, ParseIntPipe, ParseFloatPipe, Query, Req } from '@nestjs/common';
 import { Observable } from 'rxjs';
-import { Cookies } from '../cookies-decorator';
+import { Cookies, Headers } from '../decorators';
 import { UserApi } from '../api';
 import { User,  } from '../models';
 
diff --git a/samples/server/petstore/typescript-nestjs-server/builds/default/decorators/cookies-decorator.ts b/samples/server/petstore/typescript-nestjs-server/builds/default/decorators/cookies-decorator.ts
@@ -17,5 +17,8 @@ import { createParamDecorator, ExecutionContext } from '@nestjs/common';
 */
 export const Cookies = createParamDecorator((data: string, ctx: ExecutionContext) => {
   const request = ctx.switchToHttp().getRequest();
-  return data ? request.cookies?.[data] : request.cookies;
+  if (!data) {
+    return { ...request.cookies, ...request.signedCookies };
+  }
+  return request.cookies?.[data] ?? request.signedCookies?.[data];
 });
diff --git a/samples/server/petstore/typescript-nestjs-server/builds/default/decorators/headers-decorator.ts b/samples/server/petstore/typescript-nestjs-server/builds/default/decorators/headers-decorator.ts
@@ -0,0 +1,16 @@
+import { createParamDecorator, ExecutionContext } from '@nestjs/common';
+
+/**
+* A decorator function for retrieving headers from the request object in an HTTP context.
+* Workaround for enabling PipeTransformers on Headers (see https://github.com/nestjs/nest/issues/356)
+*
+* Usage:
+* ```
+* @Get()
+* findAll(@Headers('name') name: string) {}
+* ```
+*/
+export const Headers = createParamDecorator((data: string, ctx: ExecutionContext) => {
+const request = ctx.switchToHttp().getRequest();
+return data ? request.headers?.[data] : request.headers;
+});
diff --git a/samples/server/petstore/typescript-nestjs-server/builds/default/decorators/index.ts b/samples/server/petstore/typescript-nestjs-server/builds/default/decorators/index.ts
@@ -0,0 +1,2 @@
+export * from './cookies-decorator';
+export * from './headers-decorator';
diff --git a/samples/server/petstore/typescript-nestjs-server/builds/parameters/.openapi-generator/FILES b/samples/server/petstore/typescript-nestjs-server/builds/parameters/.openapi-generator/FILES
@@ -6,7 +6,9 @@ api/DefaultApi.ts
 api/index.ts
 controllers/DefaultApi.controller.ts
 controllers/index.ts
-cookies-decorator.ts
+decorators/cookies-decorator.ts
+decorators/headers-decorator.ts
+decorators/index.ts
 index.ts
 models/index.ts
 tsconfig.json
diff --git a/samples/server/petstore/typescript-nestjs-server/builds/parameters/controllers/DefaultApi.controller.ts b/samples/server/petstore/typescript-nestjs-server/builds/parameters/controllers/DefaultApi.controller.ts
@@ -1,14 +1,14 @@
-import { Body, Controller, Get, Param, Query, Headers, Req } from '@nestjs/common';
+import { Body, Controller, DefaultValuePipe, Get, Param, ParseIntPipe, ParseFloatPipe, Query, Req } from '@nestjs/common';
 import { Observable } from 'rxjs';
-import { Cookies } from '../cookies-decorator';
+import { Cookies, Headers } from '../decorators';
 import { DefaultApi } from '../api';
 
 @Controller()
 export class DefaultApiController {
   constructor(private readonly defaultApi: DefaultApi) {}
 
   @Get('/test/parameters/:path_default/:path_nullable')
-  findPetsByStatus(@Param('path_default') pathDefault: string, @Param('path_nullable') pathNullable: string, @Query('query_default') queryDefault: string | undefined = 'available', @Query('query_default_enum') queryDefaultEnum: 'A' | 'B' | 'C' | undefined = 'B', @Query('query_default_int') queryDefaultInt: number | undefined = 3, @Headers('header_default') headerDefault: string | undefined = 'available', @Headers('header_default_enum') headerDefaultEnum: 'A' | 'B' | 'C' | undefined = 'B', @Headers('header_default_int') headerDefaultInt: number | undefined = 3, @Cookies('cookie_default') cookieDefault: string | undefined = 'available', @Cookies('cookie_default_enum') cookieDefaultEnum: 'A' | 'B' | 'C' | undefined = 'B', @Cookies('cookie_default_int') cookieDefaultInt: number | undefined = 3, @Query('query_nullable') queryNullable: string | null | undefined, @Headers('header_nullable') headerNullable: string | null | undefined, @Cookies('cookie_nullable') cookieNullable: string | null | undefined, @Query('$query-$dollar-sign') $query$dollarSign: string | undefined, @Req() request: Request): void | Promise<void> | Observable<void> {
+  findPetsByStatus(@Param('path_default') pathDefault: string, @Param('path_nullable') pathNullable: string, @Query('query_default', new DefaultValuePipe('available')) queryDefault: string | undefined, @Query('query_default_enum', new DefaultValuePipe('B')) queryDefaultEnum: 'A' | 'B' | 'C' | undefined, @Query('query_default_int', new DefaultValuePipe(3), ParseIntPipe) queryDefaultInt: number | undefined, @Headers('header_default', new DefaultValuePipe('available')) headerDefault: string | undefined, @Headers('header_default_enum', new DefaultValuePipe('B')) headerDefaultEnum: 'A' | 'B' | 'C' | undefined, @Headers('header_default_int', new DefaultValuePipe(3), ParseIntPipe) headerDefaultInt: number | undefined, @Cookies('cookie_default', new DefaultValuePipe('available')) cookieDefault: string | undefined, @Cookies('cookie_default_enum', new DefaultValuePipe('B')) cookieDefaultEnum: 'A' | 'B' | 'C' | undefined, @Cookies('cookie_default_int', new DefaultValuePipe(3), ParseIntPipe) cookieDefaultInt: number | undefined, @Query('query_nullable') queryNullable: string | null | undefined, @Headers('header_nullable') headerNullable: string | null | undefined, @Cookies('cookie_nullable') cookieNullable: string | null | undefined, @Query('$query-$dollar-sign') $query$dollarSign: string | undefined, @Req() request: Request): void | Promise<void> | Observable<void> {
     return this.defaultApi.findPetsByStatus({ pathDefault, pathNullable, queryDefault, queryDefaultEnum, queryDefaultInt, headerDefault, headerDefaultEnum, headerDefaultInt, cookieDefault, cookieDefaultEnum, cookieDefaultInt, queryNullable, headerNullable, cookieNullable, $query$dollarSign, }, request);
   }
 
diff --git a/samples/server/petstore/typescript-nestjs-server/builds/parameters/decorators/cookies-decorator.ts b/samples/server/petstore/typescript-nestjs-server/builds/parameters/decorators/cookies-decorator.ts
@@ -0,0 +1,24 @@
+import { createParamDecorator, ExecutionContext } from '@nestjs/common';
+
+/**
+* A decorator function for retrieving cookies from the request object in an HTTP context.
+*
+* This decorator only works, if the framework specific cookie middleware is installed and enabled.
+* - For Express, you need to use the `cookie-parser` middleware.
+* - For Fastify, you need to use the `@fastify/cookie` plugin.
+*
+* Consult https://docs.nestjs.com/techniques/cookies for further information
+*
+* Usage:
+* ```
+* @Get()
+* findAll(@Cookies('name') name: string) {}
+* ```
+*/
+export const Cookies = createParamDecorator((data: string, ctx: ExecutionContext) => {
+  const request = ctx.switchToHttp().getRequest();
+  if (!data) {
+    return { ...request.cookies, ...request.signedCookies };
+  }
+  return request.cookies?.[data] ?? request.signedCookies?.[data];
+});
diff --git a/samples/server/petstore/typescript-nestjs-server/builds/parameters/decorators/headers-decorator.ts b/samples/server/petstore/typescript-nestjs-server/builds/parameters/decorators/headers-decorator.ts
@@ -0,0 +1,16 @@
+import { createParamDecorator, ExecutionContext } from '@nestjs/common';
+
+/**
+* A decorator function for retrieving headers from the request object in an HTTP context.
+* Workaround for enabling PipeTransformers on Headers (see https://github.com/nestjs/nest/issues/356)
+*
+* Usage:
+* ```
+* @Get()
+* findAll(@Headers('name') name: string) {}
+* ```
+*/
+export const Headers = createParamDecorator((data: string, ctx: ExecutionContext) => {
+const request = ctx.switchToHttp().getRequest();
+return data ? request.headers?.[data] : request.headers;
+});
diff --git a/samples/server/petstore/typescript-nestjs-server/builds/parameters/decorators/index.ts b/samples/server/petstore/typescript-nestjs-server/builds/parameters/decorators/index.ts
@@ -0,0 +1,2 @@
+export * from './cookies-decorator';
+export * from './headers-decorator';
diff --git a/samples/server/petstore/typescript-nestjs-server/test/app.e2e-spec.ts b/samples/server/petstore/typescript-nestjs-server/test/app.e2e-spec.ts
@@ -60,6 +60,9 @@ describe('AppModule (e2e)', () => {
 
       return request(app.getHttpServer())
         .get('/test/parameters/path_a/path_b')
+        .expect((res)=> {
+          console.log('Body:', JSON.stringify(res.body, null, 2));
+        })
         .expect(200)
         .then(() => {
           expect(defaultService.lastRequestParams).toEqual({
@@ -82,6 +85,7 @@ describe('AppModule (e2e)', () => {
         });
     });
 
+
     it('should receive request parameters', () => {
       let defaultService: DefaultService = app.get(DefaultApi);
 
@@ -109,13 +113,13 @@ describe('AppModule (e2e)', () => {
             pathNullable: 'path_b',
             queryDefault: 'custom_query',
             queryDefaultEnum: 'C',
-            queryDefaultInt: '5',
+            queryDefaultInt: 5,
             headerDefault: 'custom_header',
             headerDefaultEnum: 'C',
-            headerDefaultInt: '6',
+            headerDefaultInt: 6,
             cookieDefault: 'custom_cookie',
             cookieDefaultEnum: 'C',
-            cookieDefaultInt: '7',
+            cookieDefaultInt: 7,
             queryNullable: 'not_null_query',
             headerNullable: 'null',
             cookieNullable: 'a_cookie',

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+export * from './cookies-decorator';`
	`2`	`+export * from './headers-decorator';`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+{{#defaultValue}}, new DefaultValuePipe({{{defaultValue}}}){{/defaultValue}}{{#isNumber}}, {{#isFloat}}ParseFloatPipe{{/isFloat}}{{^isFloat}}ParseIntPipe{{/isFloat}}{{/isNumber}}`