[typescript-nestjs-server] #22928 updated README, additional PR feedback

Author: aryobenholzner

modules/openapi-generator/src/main/resources/typescript-nestjs-server/README.md

@@ -2,6 +2,8 @@
 
 Usage: The generated output is intended to be its own module, that can be imported into your NestJS App Module. You do not need to change generated files, just import the module and implement the API
 
+Currently, only Express is supported.
+
 Example usage (with the openapi sample `petstore.yaml`):
 
 1. Invoke openapi-generator
@@ -28,7 +30,7 @@ Example usage (with the openapi sample `petstore.yaml`):
 
    ...
    ```
-3. Import the generated `ApiModule` with `ApiModule.forRoot` and provide a instance of `ApiImplementations` with a reference to your implementation  
+3. Import the generated `ApiModule` with `ApiModule.forRoot` and provide an instance of `ApiImplementations` with a reference to your implementation  
    `app.module.ts`
    ```typescript
    import { Module } from "@nestjs/common";
@@ -45,12 +47,35 @@ Example usage (with the openapi sample `petstore.yaml`):
 
    @Module({
      imports: [
-       ApiModule.forRoot(apiImplementations),
+       ApiModule.forRoot({
+         apiImplementations: apiImplementations,
+         providers: [
+           // additional providers for services injected into apiImplementations
+         ]
+   }),
      ],
      controllers: [],
      providers: [],
    })
    export class AppModule {}
    ```
 
-You now can regenerate the API module as often as you want without overriding your implementation.
+You now can regenerate the API module as often as you want without overriding your implementation.
+
+## Using Cookie parameters
+
+In order for cookie parameters to work, the the framework specific cookie middleware must be enabled.
+
+For Express, the `cookie-parser` middleware must be installed and enabled.
+
+```
+npm install cookie-parser
+```
+
+in  `main.ts`
+
+```
+import * as cookieParser from 'cookie-parser';
+
+app.use(cookieParser());
+```

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

@@ -15,10 +15,10 @@ import { createParamDecorator, ExecutionContext } from '@nestjs/common';
 * findAll(@Cookies('name') name: string) {}
 * ```
 */
-export const Cookies = createParamDecorator((data: string, ctx: ExecutionContext) => {
+export const Cookies = createParamDecorator((cookieName: string, ctx: ExecutionContext) => {
   const request = ctx.switchToHttp().getRequest();
-  if (!data) {
+  if (!cookieName) {
     return { ...request.cookies, ...request.signedCookies };
   }
-  return request.cookies?.[data] ?? request.signedCookies?.[data];
+  return request.cookies?.[cookieName] ?? request.signedCookies?.[cookieName];
 });

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

@@ -10,7 +10,7 @@ import { createParamDecorator, ExecutionContext } from '@nestjs/common';
 * findAll(@Headers('name') name: string) {}
 * ```
 */
-export const Headers = createParamDecorator((data: string, ctx: ExecutionContext) => {
-const request = ctx.switchToHttp().getRequest();
-return data ? request.headers?.[data.toLowerCase()] : request.headers;
+export const Headers = createParamDecorator((headerName: string, ctx: ExecutionContext) => {
+  const request = ctx.switchToHttp().getRequest();
+  return headerName ? request.headers?.[headerName.toLowerCase()] : request.headers;
 });

samples/server/petstore/typescript-nestjs-server/builds/default/README.md

@@ -2,6 +2,8 @@
 
 Usage: The generated output is intended to be its own module, that can be imported into your NestJS App Module. You do not need to change generated files, just import the module and implement the API
 
+Currently, only Express is supported.
+
 Example usage (with the openapi sample `petstore.yaml`):
 
 1. Invoke openapi-generator
@@ -28,7 +30,7 @@ Example usage (with the openapi sample `petstore.yaml`):
 
    ...
    ```
-3. Import the generated `ApiModule` with `ApiModule.forRoot` and provide a instance of `ApiImplementations` with a reference to your implementation  
+3. Import the generated `ApiModule` with `ApiModule.forRoot` and provide an instance of `ApiImplementations` with a reference to your implementation  
    `app.module.ts`
    ```typescript
    import { Module } from "@nestjs/common";
@@ -45,12 +47,35 @@ Example usage (with the openapi sample `petstore.yaml`):
 
    @Module({
      imports: [
-       ApiModule.forRoot(apiImplementations),
+       ApiModule.forRoot({
+         apiImplementations: apiImplementations,
+         providers: [
+           // additional providers for services injected into apiImplementations
+         ]
+   }),
      ],
      controllers: [],
      providers: [],
    })
    export class AppModule {}
    ```
 
-You now can regenerate the API module as often as you want without overriding your implementation.
+You now can regenerate the API module as often as you want without overriding your implementation.
+
+## Using Cookie parameters
+
+In order for cookie parameters to work, the the framework specific cookie middleware must be enabled.
+
+For Express, the `cookie-parser` middleware must be installed and enabled.
+
+```
+npm install cookie-parser
+```
+
+in  `main.ts`
+
+```
+import * as cookieParser from 'cookie-parser';
+
+app.use(cookieParser());
+```

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

@@ -15,10 +15,10 @@ import { createParamDecorator, ExecutionContext } from '@nestjs/common';
 * findAll(@Cookies('name') name: string) {}
 * ```
 */
-export const Cookies = createParamDecorator((data: string, ctx: ExecutionContext) => {
+export const Cookies = createParamDecorator((cookieName: string, ctx: ExecutionContext) => {
   const request = ctx.switchToHttp().getRequest();
-  if (!data) {
+  if (!cookieName) {
     return { ...request.cookies, ...request.signedCookies };
   }
-  return request.cookies?.[data] ?? request.signedCookies?.[data];
+  return request.cookies?.[cookieName] ?? request.signedCookies?.[cookieName];
 });

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

@@ -10,7 +10,7 @@ import { createParamDecorator, ExecutionContext } from '@nestjs/common';
 * findAll(@Headers('name') name: string) {}
 * ```
 */
-export const Headers = createParamDecorator((data: string, ctx: ExecutionContext) => {
-const request = ctx.switchToHttp().getRequest();
-return data ? request.headers?.[data.toLowerCase()] : request.headers;
+export const Headers = createParamDecorator((headerName: string, ctx: ExecutionContext) => {
+  const request = ctx.switchToHttp().getRequest();
+  return headerName ? request.headers?.[headerName.toLowerCase()] : request.headers;
 });

samples/server/petstore/typescript-nestjs-server/builds/parameters/.openapi-generator/VERSION

@@ -1 +1 @@
-7.20.0-SNAPSHOT
+7.21.0-SNAPSHOT

samples/server/petstore/typescript-nestjs-server/builds/parameters/README.md

@@ -2,6 +2,8 @@
 
 Usage: The generated output is intended to be its own module, that can be imported into your NestJS App Module. You do not need to change generated files, just import the module and implement the API
 
+Currently, only Express is supported.
+
 Example usage (with the openapi sample `petstore.yaml`):
 
 1. Invoke openapi-generator
@@ -28,7 +30,7 @@ Example usage (with the openapi sample `petstore.yaml`):
 
    ...
    ```
-3. Import the generated `ApiModule` with `ApiModule.forRoot` and provide a instance of `ApiImplementations` with a reference to your implementation  
+3. Import the generated `ApiModule` with `ApiModule.forRoot` and provide an instance of `ApiImplementations` with a reference to your implementation  
    `app.module.ts`
    ```typescript
    import { Module } from "@nestjs/common";
@@ -45,12 +47,35 @@ Example usage (with the openapi sample `petstore.yaml`):
 
    @Module({
      imports: [
-       ApiModule.forRoot(apiImplementations),
+       ApiModule.forRoot({
+         apiImplementations: apiImplementations,
+         providers: [
+           // additional providers for services injected into apiImplementations
+         ]
+   }),
      ],
      controllers: [],
      providers: [],
    })
    export class AppModule {}
    ```
 
-You now can regenerate the API module as often as you want without overriding your implementation.
+You now can regenerate the API module as often as you want without overriding your implementation.
+
+## Using Cookie parameters
+
+In order for cookie parameters to work, the the framework specific cookie middleware must be enabled.
+
+For Express, the `cookie-parser` middleware must be installed and enabled.
+
+```
+npm install cookie-parser
+```
+
+in  `main.ts`
+
+```
+import * as cookieParser from 'cookie-parser';
+
+app.use(cookieParser());
+```

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

@@ -15,10 +15,10 @@ import { createParamDecorator, ExecutionContext } from '@nestjs/common';
 * findAll(@Cookies('name') name: string) {}
 * ```
 */
-export const Cookies = createParamDecorator((data: string, ctx: ExecutionContext) => {
+export const Cookies = createParamDecorator((cookieName: string, ctx: ExecutionContext) => {
   const request = ctx.switchToHttp().getRequest();
-  if (!data) {
+  if (!cookieName) {
     return { ...request.cookies, ...request.signedCookies };
   }
-  return request.cookies?.[data] ?? request.signedCookies?.[data];
+  return request.cookies?.[cookieName] ?? request.signedCookies?.[cookieName];
 });

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

@@ -10,7 +10,7 @@ import { createParamDecorator, ExecutionContext } from '@nestjs/common';
 * findAll(@Headers('name') name: string) {}
 * ```
 */
-export const Headers = createParamDecorator((data: string, ctx: ExecutionContext) => {
-const request = ctx.switchToHttp().getRequest();
-return data ? request.headers?.[data.toLowerCase()] : request.headers;
+export const Headers = createParamDecorator((headerName: string, ctx: ExecutionContext) => {
+  const request = ctx.switchToHttp().getRequest();
+  return headerName ? request.headers?.[headerName.toLowerCase()] : request.headers;
 });