- Added support for the Angular client with --name parameter

Author: ferdikoomen

CHANGELOG.md

@@ -1,6 +1,11 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.19.0] - 2022-02-02
+### Added
+- Support for Angular client with `--name` option
+- Added test cases for Angular client
+
 ## [0.18.2] - 2022-02-02
 ### Fixed
 - Updated dependencies

jest.config.ts

@@ -32,6 +32,7 @@ const config: Config.InitialOptions = {
                 '<rootDir>/test/e2e/client.node.spec.ts',
                 '<rootDir>/test/e2e/client.axios.spec.ts',
                 '<rootDir>/test/e2e/client.babel.spec.ts',
+                '<rootDir>/test/e2e/client.angular.spec.ts',
             ],
             modulePathIgnorePatterns: ['<rootDir>/test/e2e/generated'],
         },

src/index.ts

@@ -4,7 +4,6 @@ import { parse as parseV2 } from './openApi/v2';
 import { parse as parseV3 } from './openApi/v3';
 import { getOpenApiSpec } from './utils/getOpenApiSpec';
 import { getOpenApiVersion, OpenApiVersion } from './utils/getOpenApiVersion';
-import { isDefined } from './utils/isDefined';
 import { isString } from './utils/isString';
 import { postProcessClient } from './utils/postProcessClient';
 import { registerHandlebarTemplates } from './utils/registerHandlebarTemplates';
@@ -65,10 +64,6 @@ export const generate = async ({
     request,
     write = true,
 }: Options): Promise<void> => {
-    if (httpClient === HttpClient.ANGULAR && isDefined(clientName)) {
-        throw new Error('Angular client does not support --name property');
-    }
-
     const openApi = isString(input) ? await getOpenApiSpec(input) : input;
     const openApiVersion = getOpenApiVersion(openApi);
     const templates = registerHandlebarTemplates({

src/templates/client.hbs

@@ -1,15 +1,54 @@
 {{>header}}
 
+{{#equals @root.httpClient 'angular'}}
+import { NgModule} from '@angular/core';
+import { HttpClientModule } from '@angular/common/http';
+
+import { AngularHttpRequest } from './core/AngularHttpRequest';
+import { BaseHttpRequest } from './core/BaseHttpRequest';
+import type { OpenAPIConfig } from './core/OpenAPI';
+import { OpenAPI } from './core/OpenAPI';
+{{else}}
 import type { BaseHttpRequest } from './core/BaseHttpRequest';
 import type { OpenAPIConfig } from './core/OpenAPI';
 import { {{{httpRequest}}} } from './core/{{{httpRequest}}}';
+{{/equals}}
 
 {{#if services}}
 {{#each services}}
 import { {{{name}}}{{{@root.postfix}}} } from './services/{{{name}}}{{{@root.postfix}}}';
 {{/each}}
 {{/if}}
 
+{{#equals @root.httpClient 'angular'}}
+@NgModule({
+	imports: [HttpClientModule],
+	providers: [
+		{
+			provide: OpenAPI,
+			useValue: {
+				BASE: OpenAPI?.BASE ?? '{{{server}}}',
+				VERSION: OpenAPI?.VERSION ?? '{{{version}}}',
+				WITH_CREDENTIALS: OpenAPI?.WITH_CREDENTIALS ?? false,
+				CREDENTIALS: OpenAPI?.CREDENTIALS ?? 'include',
+				TOKEN: OpenAPI?.TOKEN,
+				USERNAME: OpenAPI?.USERNAME,
+				PASSWORD: OpenAPI?.PASSWORD,
+				HEADERS: OpenAPI?.HEADERS,
+				ENCODE_PATH: OpenAPI?.ENCODE_PATH,
+			} as OpenAPIConfig,
+		},
+		{
+			provide: BaseHttpRequest,
+			useClass: AngularHttpRequest,
+		},
+		{{#each services}}
+		{{{name}}}{{{@root.postfix}}},
+		{{/each}}
+	]
+})
+export class {{{clientName}}} {}
+{{else}}
 type HttpRequestConstructor = new (config: OpenAPIConfig) => BaseHttpRequest;
 
 export class {{{clientName}}} {
@@ -38,3 +77,4 @@ export class {{{clientName}}} {
 		{{/each}}
 	}
 }
+{{/equals}}

src/templates/core/BaseHttpRequest.hbs

@@ -1,14 +1,35 @@
 {{>header}}
 
+{{#equals @root.httpClient 'angular'}}
+import type { HttpClient } from '@angular/common/http';
+import type { Observable } from 'rxjs';
+
+import type { ApiRequestOptions } from './ApiRequestOptions';
+import type { OpenAPIConfig } from './OpenAPI';
+{{else}}
 import type { ApiRequestOptions } from './ApiRequestOptions';
 import type { CancelablePromise } from './CancelablePromise';
 import type { OpenAPIConfig } from './OpenAPI';
+{{/equals}}
 
 export class BaseHttpRequest {
 
+	{{#equals @root.httpClient 'angular'}}
+	constructor(
+		public readonly config: OpenAPIConfig,
+		public readonly http: HttpClient,
+	) {}
+	{{else}}
 	constructor(public readonly config: OpenAPIConfig) {}
+	{{/equals}}
 
+	{{#equals @root.httpClient 'angular'}}
+	public request<T>(options: ApiRequestOptions): Observable<T> {
+		throw new Error('Not Implemented');
+	}
+	{{else}}
 	public request<T>(options: ApiRequestOptions): CancelablePromise<T> {
 		throw new Error('Not Implemented');
 	}
+	{{/equals}}
 }

src/templates/core/HttpRequest.hbs

@@ -1,24 +1,61 @@
 {{>header}}
 
+{{#equals @root.httpClient 'angular'}}
+import { HttpClient } from '@angular/common/http';
+import { Inject, Injectable } from '@angular/core';
+import type { Observable } from 'rxjs';
+
+import type { ApiRequestOptions } from './ApiRequestOptions';
+import { BaseHttpRequest } from './BaseHttpRequest';
+import type { OpenAPIConfig } from './OpenAPI';
+import { OpenAPI } from './OpenAPI';
+import { request as __request } from './request';
+{{else}}
 import type { ApiRequestOptions } from './ApiRequestOptions';
 import { BaseHttpRequest } from './BaseHttpRequest';
 import type { CancelablePromise } from './CancelablePromise';
 import type { OpenAPIConfig } from './OpenAPI';
 import { request as __request } from './request';
+{{/equals}}
 
+{{#equals @root.httpClient 'angular'}}
+@Injectable()
+{{/equals}}
 export class {{httpRequest}} extends BaseHttpRequest {
 
+	{{#equals @root.httpClient 'angular'}}
+	constructor(
+		@Inject(OpenAPI)
+		config: OpenAPIConfig,
+		http: HttpClient,
+	) {
+		super(config, http);
+	}
+	{{else}}
 	constructor(config: OpenAPIConfig) {
 		super(config);
 	}
+	{{/equals}}
 
+	{{#equals @root.httpClient 'angular'}}
+	/**
+	 * Request method
+	 * @param options The request options from the service
+	 * @returns Observable<T>
+	 * @throws ApiError
+	 */
+	public override request<T>(options: ApiRequestOptions): Observable<T> {
+		return __request(this.config, this.http, options);
+	}
+	{{else}}
 	/**
 	 * Request method
 	 * @param options The request options from the service
 	 * @returns CancelablePromise<T>
 	 * @throws ApiError
 	 */
-	public request<T>(options: ApiRequestOptions): CancelablePromise<T> {
+	public override request<T>(options: ApiRequestOptions): CancelablePromise<T> {
 		return __request(this.config, options);
 	}
+	{{/equals}}
 }

src/templates/exportService.hbs

@@ -1,9 +1,14 @@
 {{>header}}
 
 {{#equals @root.httpClient 'angular'}}
+{{#if @root.exportClient}}
+import { Injectable } from '@angular/core';
+import type { Observable } from 'rxjs';
+{{else}}
 import { Injectable } from '@angular/core';
 import { HttpClient } from '@angular/common/http';
 import type { Observable } from 'rxjs';
+{{/if}}
 
 {{/equals}}
 {{#if imports}}
@@ -16,7 +21,11 @@ import type { {{{this}}} } from '../models/{{{this}}}';
 import type { CancelablePromise } from '../core/CancelablePromise';
 {{/notEquals}}
 {{#if @root.exportClient}}
+{{#equals @root.httpClient 'angular'}}
+import { BaseHttpRequest } from '../core/BaseHttpRequest';
+{{else}}
 import type { BaseHttpRequest } from '../core/BaseHttpRequest';
+{{/equals}}
 {{else}}
 import { OpenAPI } from '../core/OpenAPI';
 import { request as __request } from '../core/request';
@@ -28,12 +37,13 @@ import { request as __request } from '../core/request';
 export class {{{name}}}{{{@root.postfix}}} {
 	{{#if @root.exportClient}}
 
-	constructor(private readonly httpRequest: BaseHttpRequest) {}
-	{{/if}}
+	constructor(public readonly httpRequest: BaseHttpRequest) {}
+	{{else}}
 	{{#equals @root.httpClient 'angular'}}
 
-	constructor(private readonly http: HttpClient) {}
+	constructor(public readonly http: HttpClient) {}
 	{{/equals}}
+	{{/if}}
 
 	{{#each operations}}
 	/**
@@ -59,8 +69,13 @@ export class {{{name}}}{{{@root.postfix}}} {
 	 * @throws ApiError
 	 */
 	{{#if @root.exportClient}}
+	{{#equals @root.httpClient 'angular'}}
+	public {{{name}}}({{>parameters}}): Observable<{{>result}}> {
+		return this.httpRequest.request({
+	{{else}}
 	public {{{name}}}({{>parameters}}): CancelablePromise<{{>result}}> {
 		return this.httpRequest.request({
+	{{/equals}}
 	{{else}}
 	{{#equals @root.httpClient 'angular'}}
 	public {{{name}}}({{>parameters}}): Observable<{{>result}}> {

src/templates/index.hbs

@@ -1,7 +1,8 @@
 {{>header}}
 
 {{#if @root.exportClient}}
-export { {{{clientName}}} } from './client';
+export { {{{clientName}}} } from './{{{clientName}}}';
+
 {{/if}}
 {{#if @root.exportCore}}
 export { ApiError } from './core/ApiError';

src/utils/writeClientClass.ts

@@ -34,6 +34,7 @@ export const writeClientClass = async (
 ): Promise<void> => {
     const templateResult = templates.client({
         clientName,
+        httpClient,
         postfix,
         server: client.server,
         version: client.version,
@@ -42,5 +43,5 @@ export const writeClientClass = async (
         httpRequest: getHttpRequestName(httpClient),
     });
 
-    await writeFile(resolve(outputPath, 'client.ts'), i(f(templateResult), indent));
+    await writeFile(resolve(outputPath, `${clientName}.ts`), i(f(templateResult), indent));
 };

test/e2e/assets/main-angular-module.ts

@@ -0,0 +1,76 @@
+import { HttpClientModule } from '@angular/common/http';
+import { Component, NgModule } from '@angular/core';
+import { BrowserModule } from '@angular/platform-browser';
+import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
+
+import { ApiModule } from './ApiModule';
+import { OpenAPI } from './core/OpenAPI';
+import { CollectionFormatService } from './services/CollectionFormatService';
+import { ComplexService } from './services/ComplexService';
+import { DefaultService } from './services/DefaultService';
+import { DefaultsService } from './services/DefaultsService';
+import { DuplicateService } from './services/DuplicateService';
+import { ErrorService } from './services/ErrorService';
+import { HeaderService } from './services/HeaderService';
+import { MultipleTags1Service } from './services/MultipleTags1Service';
+import { MultipleTags2Service } from './services/MultipleTags2Service';
+import { MultipleTags3Service } from './services/MultipleTags3Service';
+import { NoContentService } from './services/NoContentService';
+import { ParametersService } from './services/ParametersService';
+import { ResponseService } from './services/ResponseService';
+import { SimpleService } from './services/SimpleService';
+import { TypesService } from './services/TypesService';
+
+@Component({
+    selector: 'app-root',
+    template: `<div>Angular is ready</div>`,
+})
+export class AppComponent {
+    constructor(
+        private readonly collectionFormatService: CollectionFormatService,
+        private readonly complexService: ComplexService,
+        private readonly defaultService: DefaultService,
+        private readonly defaultsService: DefaultsService,
+        private readonly duplicateService: DuplicateService,
+        private readonly errorService: ErrorService,
+        private readonly headerService: HeaderService,
+        private readonly multipleTags1Service: MultipleTags1Service,
+        private readonly multipleTags2Service: MultipleTags2Service,
+        private readonly multipleTags3Service: MultipleTags3Service,
+        private readonly noContentService: NoContentService,
+        private readonly parametersService: ParametersService,
+        private readonly responseService: ResponseService,
+        private readonly simpleService: SimpleService,
+        private readonly typesService: TypesService
+    ) {
+        (window as any).api = {
+            OpenAPI,
+            ApiModule,
+            CollectionFormatService: this.collectionFormatService,
+            ComplexService: this.complexService,
+            DefaultService: this.defaultService,
+            DefaultsService: this.defaultsService,
+            DuplicateService: this.duplicateService,
+            ErrorService: this.errorService,
+            HeaderService: this.headerService,
+            MultipleTags1Service: this.multipleTags1Service,
+            MultipleTags2Service: this.multipleTags2Service,
+            MultipleTags3Service: this.multipleTags3Service,
+            NoContentService: this.noContentService,
+            ParametersService: this.parametersService,
+            ResponseService: this.responseService,
+            SimpleService: this.simpleService,
+            TypesService: this.typesService,
+        };
+    }
+}
+
+@NgModule({
+    imports: [BrowserModule, HttpClientModule, ApiModule],
+    bootstrap: [AppComponent],
+})
+export class AppModule {}
+
+platformBrowserDynamic()
+    .bootstrapModule(AppModule)
+    .catch(err => console.error(err));