feat: add reserved param names sample

Author: GregoryMerlet

bin/configs/typescript-nestjs-reserved-param-names.yaml

@@ -0,0 +1,6 @@
+generatorName: typescript-nestjs
+outputDir: samples/client/petstore/typescript-nestjs/builds/reservedParamNames
+inputSpec: modules/openapi-generator/src/test/resources/3_0/typescript-nestjs/reserved-param-names.yaml
+templateDir: modules/openapi-generator/src/main/resources/typescript-nestjs
+additionalProperties:
+  "useSingleRequestParameter" : true

modules/openapi-generator/src/test/resources/3_0/typescript-nestjs/reserved-param-names.yaml

@@ -0,0 +1,37 @@
+openapi: 3.0.0
+info:
+  description: Test reserved param names
+  version: 1.0.0
+  title: Reserved param names
+paths:
+  /test:
+    post:
+      security:
+        - bearerAuth: []
+      summary: Test reserved param names
+      description: ''
+      operationId: testReservedParamNames
+      parameters:
+        - name: from
+          in: query
+          description: Might conflict with rxjs import
+          required: true
+          schema:
+            type: string
+        - name: headers
+          in: header
+          description: Might conflict with headers const
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: successful operation
+        '405':
+          description: Invalid input
+components:
+  securitySchemes:
+    bearerAuth:
+      type: http
+      scheme: bearer
+      bearerFormat: JWT

samples/client/petstore/typescript-nestjs/builds/reservedParamNames/.gitignore

@@ -0,0 +1,4 @@
+wwwroot/*.js
+node_modules
+typings
+dist

samples/client/petstore/typescript-nestjs/builds/reservedParamNames/.openapi-generator-ignore

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

samples/client/petstore/typescript-nestjs/builds/reservedParamNames/.openapi-generator/FILES

@@ -0,0 +1,10 @@
+.gitignore
+README.md
+api.module.ts
+api/api.ts
+api/default.service.ts
+configuration.ts
+git_push.sh
+index.ts
+model/models.ts
+variables.ts

samples/client/petstore/typescript-nestjs/builds/reservedParamNames/.openapi-generator/VERSION

@@ -0,0 +1 @@
+7.11.0-SNAPSHOT

samples/client/petstore/typescript-nestjs/builds/reservedParamNames/README.md

@@ -0,0 +1,162 @@
+## @
+
+### Building
+
+To install the required dependencies and to build the typescript sources run:
+```
+npm install
+npm run build
+```
+
+#### General usage
+
+In your Nestjs project:
+
+
+```
+// without configuring providers
+import { ApiModule } from '';
+import { HttpModule } from '@nestjs/axios';
+
+@Module({
+    imports: [
+        ApiModule,
+        HttpModule
+    ],
+    providers: []
+})
+export class AppModule {}
+```
+
+```
+// configuring providers
+import { ApiModule, Configuration, ConfigurationParameters } from '';
+
+export function apiConfigFactory (): Configuration => {
+  const params: ConfigurationParameters = {
+    // set configuration parameters here.
+  }
+  return new Configuration(params);
+}
+
+@Module({
+    imports: [ ApiModule.forRoot(apiConfigFactory) ],
+    declarations: [ AppComponent ],
+    providers: [],
+    bootstrap: [ AppComponent ]
+})
+export class AppModule {}
+```
+
+```
+import { DefaultApi } from '';
+
+export class AppComponent {
+    constructor(private apiGateway: DefaultApi) { }
+}
+```
+
+Note: The ApiModule a dynamic module and instantiated once app wide.
+This is to ensure that all services are treated as singletons.
+
+#### Using multiple swagger files / APIs / ApiModules
+In order to use multiple `ApiModules` generated from different swagger files,
+you can create an alias name when importing the modules
+in order to avoid naming conflicts:
+```
+import { ApiModule } from 'my-api-path';
+import { ApiModule as OtherApiModule } from 'my-other-api-path';
+import { HttpModule } from '@nestjs/axios';
+
+@Module({
+  imports: [
+    ApiModule,
+    OtherApiModule,
+    HttpModule
+  ]
+})
+export class AppModule {
+
+}
+```
+
+
+### Set service base path
+If different than the generated base path, during app bootstrap, you can provide the base path to your service.
+
+```
+import { BASE_PATH } from '';
+
+bootstrap(AppComponent, [
+    { provide: BASE_PATH, useValue: 'https://your-web-service.com' },
+]);
+```
+or
+
+```
+import { BASE_PATH } from '';
+
+@Module({
+    imports: [],
+    declarations: [ AppComponent ],
+    providers: [ provide: BASE_PATH, useValue: 'https://your-web-service.com' ],
+    bootstrap: [ AppComponent ]
+})
+export class AppModule {}
+```
+
+### Configuring the module with `forRootAsync`
+
+You can also use the Nestjs Config Module/Service to configure your app with `forRootAsync`.
+
+```
+@Module({
+    imports: [
+      ApiModule.forRootAsync({
+        imports: [ConfigModule],
+        inject: [ConfigService],
+        useFactory: (config: ConfigService): Configuration => {
+          const params: ConfigurationParameters = {
+            // set configuration parameters here.
+            basePath: config.get('API_URL'),
+          };
+          return new Configuration(params);
+        },
+      })
+    ],
+    declarations: [ AppComponent ],
+    providers: [],
+    bootstrap: [ AppComponent ]
+})
+export class AppModule {}
+```
+
+#### Using @nestjs/cli
+First extend your `src/environments/*.ts` files by adding the corresponding base path:
+
+```
+export const environment = {
+  production: false,
+  API_BASE_PATH: 'http://127.0.0.1:8080'
+};
+```
+
+In the src/app/app.module.ts:
+```
+import { BASE_PATH } from '';
+import { environment } from '../environments/environment';
+
+@Module({
+  declarations: [
+    AppComponent
+  ],
+  imports: [ ],
+  providers: [
+    {
+      provide: 'BASE_PATH',
+      useValue: environment.API_BASE_PATH
+    }
+  ]
+})
+export class AppModule { }
+```

samples/client/petstore/typescript-nestjs/builds/reservedParamNames/api.module.ts

@@ -0,0 +1,70 @@
+import { DynamicModule, Module, Global, Provider } from '@nestjs/common';
+import { HttpModule, HttpService } from '@nestjs/axios';
+import { AsyncConfiguration, Configuration, ConfigurationFactory } from './configuration';
+
+import { DefaultService } from './api/default.service';
+
+@Global()
+@Module({
+  imports:      [ HttpModule ],
+  exports:      [
+    DefaultService
+  ],
+  providers: [
+    DefaultService
+  ]
+})
+export class ApiModule {
+    public static forRoot(configurationFactory: () => Configuration): DynamicModule {
+        return {
+            module: ApiModule,
+            providers: [ { provide: Configuration, useFactory: configurationFactory } ]
+        };
+    }
+
+    /**
+     * Register the module asynchronously.
+     */
+    static forRootAsync(options: AsyncConfiguration): DynamicModule {
+        const providers = [...this.createAsyncProviders(options)];
+        return {
+            module: ApiModule,
+            imports: options.imports || [],
+            providers,
+            exports: providers,
+        };
+    }
+
+    private static createAsyncProviders(options: AsyncConfiguration): Provider[] {
+        if (options.useClass) {
+            return [
+                this.createAsyncConfigurationProvider(options),
+                {
+                    provide: options.useClass,
+                    useClass: options.useClass,
+                },
+            ];
+        }
+        return [this.createAsyncConfigurationProvider(options)];
+    }
+
+    private static createAsyncConfigurationProvider(
+        options: AsyncConfiguration,
+    ): Provider {
+        if (options.useFactory) {
+            return {
+                provide: Configuration,
+                useFactory: options.useFactory,
+                inject: options.inject || [],
+            };
+        }
+        return {
+            provide: Configuration,
+            useFactory: async (optionsFactory: ConfigurationFactory) =>
+                await optionsFactory.createConfiguration(),
+            inject: (options.useExisting && [options.useExisting]) || (options.useClass && [options.useClass]) || [],
+        };
+    }
+
+    constructor( httpService: HttpService) { }
+}

samples/client/petstore/typescript-nestjs/builds/reservedParamNames/api/api.ts

@@ -0,0 +1,3 @@
+export * from './default.service';
+import { DefaultService } from './default.service';
+export const APIS = [DefaultService];