add custom template options for generate api

Author: Sudhir

src/index.ts

@@ -27,6 +27,9 @@ export type Options = {
     postfixServices?: string;
     postfixModels?: string;
     request?: string;
+    resolveTemplates?: {
+        service?: string
+    };
     write?: boolean;
 };
 
@@ -48,6 +51,7 @@ export type Options = {
  * @param postfixServices Service name postfix
  * @param postfixModels Model name postfix
  * @param request Path to custom request file
+ * @param resolveTemplates Template files (in .hbs format) for services generated from OpenAPI spec.
  * @param write Write the files to disk (true or false)
  */
 export const generate = async ({
@@ -65,6 +69,7 @@ export const generate = async ({
     postfixServices = 'Service',
     postfixModels = '',
     request,
+    resolveTemplates,
     write = true,
 }: Options): Promise<void> => {
     const openApi = isString(input) ? await getOpenApiSpec(input) : input;
@@ -73,6 +78,7 @@ export const generate = async ({
         httpClient,
         useUnionTypes,
         useOptions,
+        resolveTemplates
     });
 
     switch (openApiVersion) {

src/utils/registerHandlebarTemplates.ts

@@ -84,6 +84,7 @@ import partialTypeIntersection from '../templates/partials/typeIntersection.hbs'
 import partialTypeReference from '../templates/partials/typeReference.hbs';
 import partialTypeUnion from '../templates/partials/typeUnion.hbs';
 import { registerHandlebarHelpers } from './registerHandlebarHelpers';
+import { resolveTemplate } from "./resolveTemplate";
 
 export interface Templates {
     index: Handlebars.TemplateDelegate;
@@ -113,17 +114,28 @@ export const registerHandlebarTemplates = (root: {
     httpClient: HttpClient;
     useOptions: boolean;
     useUnionTypes: boolean;
+    resolveTemplates?: {
+        service?: string
+    }
 }): Templates => {
     registerHandlebarHelpers(root);
 
+    const resolvedTemplates = {
+        service: root.resolveTemplates?.service
+            ? resolveTemplate(root.resolveTemplates.service)
+            : undefined
+    }
+
     // Main templates (entry points for the files we write to disk)
     const templates: Templates = {
         index: Handlebars.template(templateIndex),
         client: Handlebars.template(templateClient),
         exports: {
             model: Handlebars.template(templateExportModel),
             schema: Handlebars.template(templateExportSchema),
-            service: Handlebars.template(templateExportService),
+            service: resolvedTemplates.service
+                ? Handlebars.template(resolvedTemplates.service)
+                : Handlebars.template(templateExportService),
         },
         core: {
             settings: Handlebars.template(templateCoreSettings),

src/utils/resolveTemplate.ts

@@ -0,0 +1,19 @@
+import { readFileSync, writeFileSync, mkdtempSync } from 'fs';
+import { join, resolve } from 'path';
+import { execSync } from 'child_process';
+import handlebars from 'handlebars';
+
+const { precompile } = handlebars;
+
+export function resolveTemplate(templatePath: string) {
+    const source = readFileSync(templatePath).toString();
+    const compiled = precompile(source);
+
+    const tempDir = mkdtempSync('template-');
+    const tempFilePath = join(tempDir, 'template.js');
+    writeFileSync(tempFilePath, `module.exports = ${compiled};`);
+
+    const module = require(resolve(tempFilePath));
+    execSync(`rm -rf ${tempDir}`);
+    return module;
+}

test/customExportService.hbs

@@ -0,0 +1,154 @@
+{{>header}}
+
+// Custom comment
+
+{{#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}}
+{{#each imports}}
+import type { {{{this}}} } from '../models/{{{this}}}';
+{{/each}}
+
+{{/if}}
+{{#notEquals @root.httpClient 'angular'}}
+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';
+{{/if}}
+
+{{#equals @root.httpClient 'angular'}}
+@Injectable({
+  providedIn: 'root',
+})
+{{/equals}}
+export class {{{name}}}{{{@root.postfix}}} {
+	{{#if @root.exportClient}}
+
+	constructor(public readonly httpRequest: BaseHttpRequest) {}
+	{{else}}
+	{{#equals @root.httpClient 'angular'}}
+
+	constructor(public readonly http: HttpClient) {}
+	{{/equals}}
+	{{/if}}
+
+	{{#each operations}}
+	/**
+	{{#if deprecated}}
+	 * @deprecated
+	{{/if}}
+	{{#if summary}}
+	 * {{{escapeComment summary}}}
+	{{/if}}
+	{{#if description}}
+	 * {{{escapeComment description}}}
+	{{/if}}
+	{{#unless @root.useOptions}}
+	{{#if parameters}}
+	{{#each parameters}}
+	 * @param {{{name}}} {{#if description}}{{{escapeComment description}}}{{/if}}
+	{{/each}}
+	{{/if}}
+	{{/unless}}
+	{{#each results}}
+	 * @returns {{{type}}} {{#if description}}{{{escapeComment description}}}{{/if}}
+	{{/each}}
+	 * @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}}> {
+		return __request(OpenAPI, this.http, {
+	{{else}}
+	public static {{{name}}}({{>parameters}}): CancelablePromise<{{>result}}> {
+		return __request(OpenAPI, {
+	{{/equals}}
+	{{/if}}
+			method: '{{{method}}}',
+			url: '{{{path}}}',
+			{{#if parametersPath}}
+			path: {
+				{{#each parametersPath}}
+				'{{{prop}}}': {{{name}}},
+				{{/each}}
+			},
+			{{/if}}
+			{{#if parametersCookie}}
+			cookies: {
+				{{#each parametersCookie}}
+				'{{{prop}}}': {{{name}}},
+				{{/each}}
+			},
+			{{/if}}
+			{{#if parametersHeader}}
+			headers: {
+				{{#each parametersHeader}}
+				'{{{prop}}}': {{{name}}},
+				{{/each}}
+			},
+			{{/if}}
+			{{#if parametersQuery}}
+			query: {
+				{{#each parametersQuery}}
+				'{{{prop}}}': {{{name}}},
+				{{/each}}
+			},
+			{{/if}}
+			{{#if parametersForm}}
+			formData: {
+				{{#each parametersForm}}
+				'{{{prop}}}': {{{name}}},
+				{{/each}}
+			},
+			{{/if}}
+			{{#if parametersBody}}
+			{{#equals parametersBody.in 'formData'}}
+			formData: {{{parametersBody.name}}},
+			{{/equals}}
+			{{#equals parametersBody.in 'body'}}
+			body: {{{parametersBody.name}}},
+			{{/equals}}
+			{{#if parametersBody.mediaType}}
+			mediaType: '{{{parametersBody.mediaType}}}',
+			{{/if}}
+			{{/if}}
+			{{#if responseHeader}}
+			responseHeader: '{{{responseHeader}}}',
+			{{/if}}
+			{{#if errors}}
+			errors: {
+				{{#each errors}}
+				{{{code}}}: `{{{escapeDescription description}}}`,
+				{{/each}}
+			},
+			{{/if}}
+		});
+	}
+
+	{{/each}}
+}

test/index.js

@@ -18,6 +18,9 @@ const generate = async (input, output) => {
         // indent: OpenAPI.Indent.SPACE_2,
         // postfix: 'Service',
         // request: './test/custom/request.ts',
+        // resolveTemplates: {
+        //     service: 'test/customExportService.hbs'
+        // }
     });
 };
 

types/index.d.ts

@@ -28,6 +28,9 @@ export type Options = {
     postfixModels?: string;
     request?: string;
     write?: boolean;
+    resolveTemplates?: {
+        service?: string
+    }
 };
 
 export declare function generate(options: Options): Promise<void>;