feat(exportService): introduce serviceOptions to enhance generated service class

Author: A.K Sahin

bin/index.js

@@ -21,25 +21,32 @@ const params = program
     .option('--exportSchemas <value>', 'Write schemas to disk', false)
     .option('--postfix <value>', 'Service name postfix', 'Service')
     .option('--request <value>', 'Path to custom request file')
+    .option('-so, --serviceOptions <value>, Service options path')
     .parse(process.argv)
     .opts();
 
 const OpenAPI = require(path.resolve(__dirname, '../dist/index.js'));
 
+const genereteParams = {
+    input: program.input,
+    output: program.output,
+    httpClient: program.client,
+    useOptions: program.useOptions,
+    useUnionTypes: program.useUnionTypes,
+    exportCore: JSON.parse(program.exportCore) === true,
+    exportServices: JSON.parse(program.exportServices) === true,
+    exportModels: JSON.parse(program.exportModels) === true,
+    exportSchemas: JSON.parse(program.exportSchemas) === true,
+    postfix: params.postfix,
+    request: params.request,
+};
+
+if (program.serviceOptions) {
+    genereteParams.serviceOptions = require(path.resolve(__dirname, '../../', program.serviceOptions));
+}
+
 if (OpenAPI) {
-    OpenAPI.generate({
-        input: params.input,
-        output: params.output,
-        httpClient: params.client,
-        useOptions: params.useOptions,
-        useUnionTypes: params.useUnionTypes,
-        exportCore: JSON.parse(params.exportCore) === true,
-        exportServices: JSON.parse(params.exportServices) === true,
-        exportModels: JSON.parse(params.exportModels) === true,
-        exportSchemas: JSON.parse(params.exportSchemas) === true,
-        postfix: params.postfix,
-        request: params.request,
-    })
+    OpenAPI.generate(genereteParams)
         .then(() => {
             process.exit(0);
         })

src/index.ts

@@ -10,9 +10,17 @@ import { writeClient } from './utils/writeClient';
 
 export { HttpClient } from './HttpClient';
 
-export type Options = {
+export interface ServiceOptions {
+    serviceImports?: string;
+    serviceConstructor?: string;
+    serviceDecorator?: string;
+    staticMethods?: boolean;
+}
+
+export interface Options {
     input: string | Record<string, any>;
     output: string;
+    serviceOptions?: ServiceOptions;
     httpClient?: HttpClient;
     useOptions?: boolean;
     useUnionTypes?: boolean;
@@ -23,7 +31,7 @@ export type Options = {
     postfix?: string;
     request?: string;
     write?: boolean;
-};
+}
 
 /**
  * Generate the OpenAPI client. This method will read the OpenAPI specification and based on the
@@ -55,6 +63,9 @@ export async function generate({
     postfix = 'Service',
     request,
     write = true,
+    serviceOptions = {
+        staticMethods: true,
+    },
 }: Options): Promise<void> {
     const openApi = isString(input) ? await getOpenApiSpec(input) : input;
     const openApiVersion = getOpenApiVersion(openApi);
@@ -81,6 +92,7 @@ export async function generate({
                 exportModels,
                 exportSchemas,
                 postfix,
+                serviceOptions,
                 request
             );
             break;
@@ -102,6 +114,7 @@ export async function generate({
                 exportModels,
                 exportSchemas,
                 postfix,
+                serviceOptions,
                 request
             );
             break;

src/templates/core/ApiRequestOptions.hbs

@@ -11,4 +11,5 @@ export type ApiRequestOptions = {
     readonly mediaType?: string;
     readonly responseHeader?: string;
     readonly errors?: Record<number, string>;
+    readonly context?: any;
 }

src/templates/exportService.hbs

@@ -10,8 +10,17 @@ import { request as __request } from '../core/request';
 {{#if @root.useVersion}}
 import { OpenAPI } from '../core/OpenAPI';
 {{/if}}
+{{#if @root.serviceImports}}
+{{@root.serviceImports}}
+{{/if}}
 
+{{#if @root.serviceDecorator}}
+{{@root.serviceDecorator}}
+{{/if}}
 export class {{{name}}}{{{@root.postfix}}} {
+    {{#if @root.serviceConstructor}}
+    {{@root.serviceConstructor}}
+    {{/if}}
 
     {{#each operations}}
     /**
@@ -36,7 +45,7 @@ export class {{{name}}}{{{@root.postfix}}} {
     {{/each}}
      * @throws ApiError
      */
-    public static {{{name}}}({{>parameters}}): CancelablePromise<{{>result}}> {
+    public{{#if @root.staticMethods}} static{{/if}} {{{name}}}({{>parameters}}): CancelablePromise<{{>result}}> {
         return __request({
             method: '{{{method}}}',
             path: `{{{path}}}`,
@@ -89,6 +98,9 @@ export class {{{name}}}{{{@root.postfix}}} {
                 {{/each}}
             },
             {{/if}}
+            {{#if @root.serviceRequestContext}}
+            context: {{@root.serviceRequestContext}},
+            {{/if}}
         });
     }
 

src/utils/writeClient.ts

@@ -2,6 +2,7 @@ import { resolve } from 'path';
 
 import type { Client } from '../client/interfaces/Client';
 import { HttpClient } from '../HttpClient';
+import { ServiceOptions } from '../index';
 import { mkdir, rmdir } from './fileSystem';
 import { isSubDirectory } from './isSubdirectory';
 import { Templates } from './registerHandlebarTemplates';
@@ -39,6 +40,7 @@ export async function writeClient(
     exportModels: boolean,
     exportSchemas: boolean,
     postfix: string,
+    serviceOptions: ServiceOptions,
     request?: string
 ): Promise<void> {
     const outputPath = resolve(process.cwd(), output);
@@ -67,7 +69,8 @@ export async function writeClient(
             httpClient,
             useUnionTypes,
             useOptions,
-            postfix
+            postfix,
+            serviceOptions
         );
     }
 

src/utils/writeClientServices.ts

@@ -1,4 +1,5 @@
 import { resolve } from 'path';
+import { ServiceOptions } from '..';
 
 import type { Service } from '../client/interfaces/Service';
 import { HttpClient } from '../HttpClient';
@@ -25,7 +26,8 @@ export async function writeClientServices(
     httpClient: HttpClient,
     useUnionTypes: boolean,
     useOptions: boolean,
-    postfix: string
+    postfix: string,
+    serviceOptions: ServiceOptions
 ): Promise<void> {
     for (const service of services) {
         const file = resolve(outputPath, `${service.name}${postfix}.ts`);
@@ -37,6 +39,7 @@ export async function writeClientServices(
             useVersion,
             useOptions,
             postfix,
+            ...serviceOptions,
         });
         await writeFile(file, format(templateResult));
     }

test/index.js

@@ -16,6 +16,15 @@ const generate = async (input, output) => {
         exportServices: true,
         // postfix: 'Api',
         // request: './test/custom/request.ts',
+        // serviceOptions: {
+        //     staticMethods: false,
+        //     serviceImports: `
+        //     import {Injectable} from '@angular/core';
+        //     import {HttpClient} from '@angular/common/http';
+        //     `,
+        //     serviceDecorator: `@Injectable()`,
+        //     serviceConstructor: `constructor(private http: HttpClient) {}`,
+        // },
     });
 };