feat(module): API client exported as module

closes #23

BREAKING CHANGES:

  - renamed to APIClient
  - domain and configuration are now provided using `.forRoot` method
  ```
  APIClientModule.forRoot({
    domain: 'https://api.url',
  }),
  ```
  - cli command renamed to `api-client-generator`

Author: vmasek

README.md

@@ -62,8 +62,9 @@ output
  │   ├─ some.enum.ts
  │   ├─ some.model.ts
  │   │  ...
- │   └─ another.model.ts
- ├─ api-client-service.ts
+ │   ├─ another.model.ts
+ │   └─ index.ts
+ ├─ api-client.service.ts
  └─ index.ts
 ```
 

src/generator.ts

@@ -309,7 +309,7 @@ export class Generator {
     const clientTemplate = (await promisify(fs.readFile)(__dirname + '/../templates/ngx-service.mustache')).toString();
 
     const result = Mustache.render(clientTemplate, viewContext);
-    const outfile = join(this.outputPath, 'api-client-service.ts');
+    const outfile = join(this.outputPath, 'api-client.service.ts');
 
     await promisify(fs.writeFile)(outfile, result, 'utf-8');
   }

templates/ngx-module-export.mustache

@@ -1,4 +1,41 @@
 /* tslint:disable */
 
+import { NgModule, ModuleWithProviders } from '@angular/core';
+import { HttpHeaders, HttpParams } from '@angular/common/http';
+import { APIClient, USE_DOMAIN, USE_HTTP_OPTIONS } from './api-client.service';
+
 export * from './models';
-export { ApiClientService } from './api-client-service';
+export { APIClient } from './models';
+
+export interface HttpOptions {
+  headers?: HttpHeaders, // provided headers will be used as default for each request
+  params?: HttpParams,   // provided params will be used as default for each request
+  reportProgress?: boolean,
+  withCredentials?: boolean,
+}
+
+export interface APIClientModuleConfig {
+  domain?: string;
+  httpOptions?: HttpOptions;
+}
+
+@NgModule({})
+export class APIClientModule {
+  /**
+   * Use this method in your root module to provide the APIClientModule
+   *
+   * If you are not providing
+   * @param { APIClientModuleConfig } config
+   * @returns { ModuleWithProviders }
+   */
+  static forRoot(config: APIClientModuleConfig = {}): ModuleWithProviders {
+    return {
+      ngModule: APIClientModule,
+      providers: [
+        ...(config.domain ? [{provide: USE_DOMAIN, useValue: config.domain}] : []),
+        ...(config.httpOptions ? [{provide: USE_HTTP_OPTIONS, useValue: config.httpOptions}] : []),
+        APIClient
+      ]
+    };
+  }
+}

templates/ngx-service.mustache

@@ -1,30 +1,26 @@
 /* tslint:disable */
 
 import { HttpClient, HttpHeaders, HttpParams } from '@angular/common/http';
-import { Inject, Injectable, Optional } from '@angular/core';
+import { Inject, Injectable, InjectionToken, Optional } from '@angular/core';
 import { Observable } from 'rxjs/Observable';
-
+import { HttpOptions } from './';
 import * as models from './models';
 
-interface HttpOptions {
-  headers?: HttpHeaders,
-  params?: HttpParams,
-  reportProgress?: boolean,
-  withCredentials?: boolean,
-}
+export const USE_DOMAIN = new InjectionToken<string>('USE_DOMAIN');
+export const USE_HTTP_OPTIONS = new InjectionToken<HttpOptions>('USE_HTTP_OPTIONS');
 
 /**
  * Created with https://github.com/flowup/api-client-generator
  */
 @Injectable()
-export class ApiClientService {
+export class APIClient {
 
   readonly options: HttpOptions;
   private domain: string = `{{&domain}}`;
 
   constructor(private http: HttpClient,
-              @Optional() @Inject('domain') domain: string,
-              @Optional() @Inject('httpOptions') options: HttpOptions) {
+              @Optional() @Inject(USE_DOMAIN) domain: string,
+              @Optional() @Inject(USE_HTTP_OPTIONS) options: HttpOptions) {
 
     if (domain) {
       this.domain = domain;