[typescript-nestjs-server] #22928 add docs, fix indentations and test execution

Author: aryobenholzner

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/TypeScriptNestjsServerCodegen.java

@@ -278,6 +278,14 @@ private boolean isLanguagePrimitive(String type) {
         return languageSpecificPrimitives.contains(type) || isInlineUnion(type);
     }
 
+    /**
+     * <p>
+     * Determines if the given type is an inline union of strings, described as an enum without being an explicit component in OpenAPI spec.
+     * </p>
+     * Example input that matches: {@code "'A' | 'B'" }
+     *
+     * @param type The Typescript type to evaluate.
+     */
     private boolean isInlineUnion(String type) {
         return Arrays.stream(type.split("\\|"))
                 .map(String::trim)
@@ -301,7 +309,7 @@ private boolean isRecordType(String type) {
     public void postProcessParameter(CodegenParameter parameter) {
         super.postProcessParameter(parameter);
         parameter.dataType = applyLocalTypeMapping(parameter.dataType);
-        if("undefined".equals(parameter.defaultValue)) {
+        if ("undefined".equals(parameter.defaultValue)) {
             parameter.defaultValue = null;
         }
     }

modules/openapi-generator/src/main/resources/typescript-nestjs-server/cookies-decorator.mustache

@@ -1,6 +1,21 @@
 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();
-return data ? request.cookies?.[data] : request.cookies;
+  const request = ctx.switchToHttp().getRequest();
+  return data ? request.cookies?.[data] : request.cookies;
 });

samples/server/petstore/typescript-nestjs-server/builds/default/cookies-decorator.ts

@@ -1,6 +1,21 @@
 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();
-return data ? request.cookies?.[data] : request.cookies;
+  const request = ctx.switchToHttp().getRequest();
+  return data ? request.cookies?.[data] : request.cookies;
 });

samples/server/petstore/typescript-nestjs-server/builds/parameters/cookies-decorator.ts

@@ -1,6 +1,21 @@
 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();
-return data ? request.cookies?.[data] : request.cookies;
+  const request = ctx.switchToHttp().getRequest();
+  return data ? request.cookies?.[data] : request.cookies;
 });

samples/server/petstore/typescript-nestjs-server/test/app.e2e-spec.ts

@@ -58,9 +58,10 @@ describe('AppModule (e2e)', () => {
     it('should set default parameters', () => {
       let defaultService: DefaultService = app.get(DefaultApi);
 
-      request(app.getHttpServer())
+      return request(app.getHttpServer())
         .get('/test/parameters/path_a/path_b')
-        .expect(200, () => {
+        .expect(200)
+        .then(() => {
           expect(defaultService.lastRequestParams).toEqual({
             pathDefault: 'path_a',
             pathNullable: 'path_b',
@@ -84,7 +85,7 @@ describe('AppModule (e2e)', () => {
     it('should receive request parameters', () => {
       let defaultService: DefaultService = app.get(DefaultApi);
 
-      request(app.getHttpServer())
+      return request(app.getHttpServer())
         .get('/test/parameters/path_a/path_b')
         .query({
           query_default: 'custom_query',
@@ -101,7 +102,8 @@ describe('AppModule (e2e)', () => {
           'Cookie',
           'cookie_default=custom_cookie; cookie_default_enum=C; cookie_default_int=7; cookie_nullable=a_cookie',
         )
-        .expect(200, () => {
+        .expect(200)
+        .then(() => {
           expect(defaultService.lastRequestParams).toEqual({
             pathDefault: 'path_a',
             pathNullable: 'path_b',