allow use custom handlebar template to generate service, index, class

Anh Nguyen · Anh Nguyen · commit 72a4a3d557e1 · 2023-10-02T00:18:40.000-04:00
diff --git a/bin/index.js b/bin/index.js
@@ -19,11 +19,16 @@ const params = program
     .option('--exportCore <value>', 'Write core files to disk', true)
     .option('--exportServices <value>', 'Write services to disk', true)
     .option('--exportModels <value>', 'Write models to disk', true)
+    .option('--exportClient <value>', 'Write main Client file to disk', true)
+    .option('--exportIndex <value>', 'Write Index to disk', true)
     .option('--exportSchemas <value>', 'Write schemas to disk', false)
     .option('--indent <value>', 'Indentation options [4, 2, tabs]', '4')
     .option('--postfixServices <value>', 'Service name postfix', 'Service')
     .option('--postfixModels <value>', 'Model name postfix')
     .option('--request <value>', 'Path to custom request file')
+    .option('--serviceTemplate <value>', 'Path to custom service handlebars template to generate the service files')
+    .option('--clientTemplate <value>', 'Path to custom client handlebars template to generate the client file')
+    .option('--indexTemplate <value>', 'Path to custom index handlebars template to generate the index file')
     .parse(process.argv)
     .opts();
 
@@ -40,11 +45,16 @@ if (OpenAPI) {
         exportCore: JSON.parse(params.exportCore) === true,
         exportServices: JSON.parse(params.exportServices) === true,
         exportModels: JSON.parse(params.exportModels) === true,
+        exportClient: JSON.parse(params.exportClient) === true,
+        exportIndex: JSON.parse(params.exportIndex) === true,
         exportSchemas: JSON.parse(params.exportSchemas) === true,
         indent: params.indent,
         postfixServices: params.postfixServices,
         postfixModels: params.postfixModels,
         request: params.request,
+        serviceTemplate: params.serviceTemplate,
+        clientTemplate: params.clientTemplate,
+        indexTemplate: params.indexTemplate,
     })
         .then(() => {
             process.exit(0);
diff --git a/src/index.ts b/src/index.ts
@@ -1,3 +1,4 @@
+import { Client } from './client/interfaces/Client';
 import { HttpClient } from './HttpClient';
 import { Indent } from './Indent';
 import { parse as parseV2 } from './openApi/v2';
@@ -8,6 +9,9 @@ import { isString } from './utils/isString';
 import { postProcessClient } from './utils/postProcessClient';
 import { registerHandlebarTemplates } from './utils/registerHandlebarTemplates';
 import { writeClient } from './utils/writeClient';
+import { writeClientClassCustomTemplate } from './utils/writeCustomTemplate/clientClass';
+import { writeClientIndexCustomTemplate } from './utils/writeCustomTemplate/clientIndex';
+import { writeClientServicesCustomTemplate } from './utils/writeCustomTemplate/clientServices';
 
 export { HttpClient } from './HttpClient';
 export { Indent } from './Indent';
@@ -22,11 +26,16 @@ export type Options = {
     exportCore?: boolean;
     exportServices?: boolean;
     exportModels?: boolean;
+    exportClient?: boolean;
+    exportIndex?: boolean;
     exportSchemas?: boolean;
     indent?: Indent;
     postfixServices?: string;
     postfixModels?: string;
     request?: string;
+    serviceTemplate?: string;
+    clientTemplate?: string;
+    indexTemplate?: string;
     write?: boolean;
 };
 
@@ -60,11 +69,16 @@ export const generate = async ({
     exportCore = true,
     exportServices = true,
     exportModels = true,
+    exportClient = true,
+    exportIndex = true,
     exportSchemas = false,
     indent = Indent.SPACE_4,
     postfixServices = 'Service',
     postfixModels = '',
     request,
+    serviceTemplate,
+    clientTemplate,
+    indexTemplate,
     write = true,
 }: Options): Promise<void> => {
     const openApi = isString(input) ? await getOpenApiSpec(input) : input;
@@ -75,10 +89,11 @@ export const generate = async ({
         useOptions,
     });
 
+    let clientFinal: Client;
     switch (openApiVersion) {
         case OpenApiVersion.V2: {
             const client = parseV2(openApi);
-            const clientFinal = postProcessClient(client);
+            clientFinal = postProcessClient(client);
             if (!write) break;
             await writeClient(
                 clientFinal,
@@ -90,6 +105,8 @@ export const generate = async ({
                 exportCore,
                 exportServices,
                 exportModels,
+                exportClient,
+                exportIndex,
                 exportSchemas,
                 indent,
                 postfixServices,
@@ -102,7 +119,7 @@ export const generate = async ({
 
         case OpenApiVersion.V3: {
             const client = parseV3(openApi);
-            const clientFinal = postProcessClient(client);
+            clientFinal = postProcessClient(client);
             if (!write) break;
             await writeClient(
                 clientFinal,
@@ -114,6 +131,8 @@ export const generate = async ({
                 exportCore,
                 exportServices,
                 exportModels,
+                exportClient,
+                exportIndex,
                 exportSchemas,
                 indent,
                 postfixServices,
@@ -124,6 +143,55 @@ export const generate = async ({
             break;
         }
     }
+
+    if (serviceTemplate)
+        await writeClientServicesCustomTemplate(
+            clientFinal,
+            output,
+            httpClient,
+            useOptions,
+            useUnionTypes,
+            indent,
+            postfixServices,
+            postfixModels,
+            serviceTemplate,
+            exportClient,
+            exportModels,
+            exportSchemas,
+            clientName
+        );
+
+    if (clientTemplate)
+        await writeClientClassCustomTemplate(
+            clientFinal,
+            output,
+            httpClient,
+            useOptions,
+            useUnionTypes,
+            indent,
+            postfixServices,
+            clientTemplate,
+            clientName
+        );
+
+    if (indexTemplate)
+        await writeClientIndexCustomTemplate(
+            clientFinal,
+            output,
+            httpClient,
+            useOptions,
+            useUnionTypes,
+            indent,
+            postfixServices,
+            postfixModels,
+            indexTemplate,
+            exportCore,
+            exportServices,
+            exportModels,
+            exportSchemas,
+            exportClient,
+            clientName
+        );
 };
 
 export default {
diff --git a/src/utils/registerHandlebarHelpers.ts b/src/utils/registerHandlebarHelpers.ts
@@ -1,5 +1,5 @@
 import camelCase from 'camelcase';
-import Handlebars from 'handlebars/runtime';
+import HandlebarsRuntime from 'handlebars/runtime';
 import { EOL } from 'os';
 
 import type { Enum } from '../client/interfaces/Enum';
@@ -11,7 +11,10 @@ export const registerHandlebarHelpers = (root: {
     httpClient: HttpClient;
     useOptions: boolean;
     useUnionTypes: boolean;
+    handlebars?: typeof HandlebarsRuntime;
 }): void => {
+    const Handlebars = root.handlebars || HandlebarsRuntime;
+    
     Handlebars.registerHelper('ifdef', function (this: any, ...args): string {
         const options = args.pop();
         if (!args.every(value => !value)) {
diff --git a/src/utils/registerHandlebarTemplates.ts b/src/utils/registerHandlebarTemplates.ts
@@ -1,4 +1,4 @@
-import Handlebars from 'handlebars/runtime';
+import HandlebarsRuntime from 'handlebars/runtime';
 
 import { HttpClient } from '../HttpClient';
 import templateClient from '../templates/client.hbs';
@@ -113,7 +113,10 @@ export const registerHandlebarTemplates = (root: {
     httpClient: HttpClient;
     useOptions: boolean;
     useUnionTypes: boolean;
+    handlebars?: typeof HandlebarsRuntime;
 }): Templates => {
+    const Handlebars = root.handlebars || HandlebarsRuntime;
+
     registerHandlebarHelpers(root);
 
     // Main templates (entry points for the files we write to disk)
diff --git a/src/utils/writeClient.spec.ts b/src/utils/writeClient.spec.ts
@@ -47,6 +47,8 @@ describe('writeClient', () => {
             true,
             true,
             true,
+            true,
+            true,
             Indent.SPACE_4,
             'Service',
             'AppClient'
diff --git a/src/utils/writeClient.ts b/src/utils/writeClient.ts
@@ -43,6 +43,8 @@ export const writeClient = async (
     exportCore: boolean,
     exportServices: boolean,
     exportModels: boolean,
+    exportClient: boolean,
+    exportIndex: boolean,
     exportSchemas: boolean,
     indent: Indent,
     postfixServices: string,
@@ -94,12 +96,12 @@ export const writeClient = async (
         await writeClientModels(client.models, templates, outputPathModels, httpClient, useUnionTypes, indent);
     }
 
-    if (isDefined(clientName)) {
+    if (isDefined(clientName) && exportClient) {
         await mkdir(outputPath);
         await writeClientClass(client, templates, outputPath, httpClient, clientName, indent, postfixServices);
     }
 
-    if (exportCore || exportServices || exportSchemas || exportModels) {
+    if ((exportCore || exportServices || exportSchemas || exportModels) && exportIndex) {
         await mkdir(outputPath);
         await writeClientIndex(
             client,
diff --git a/src/utils/writeCustomTemplate/clientClass.ts b/src/utils/writeCustomTemplate/clientClass.ts
@@ -0,0 +1,54 @@
+import { readFile, remove } from 'fs-extra';
+import Handlebars from 'handlebars';
+import { resolve } from 'path';
+
+import { Client } from '../../client/interfaces/Client';
+import { HttpClient } from '../../HttpClient';
+import { Indent } from '../../Indent';
+import { writeFile } from '../fileSystem';
+import { formatCode } from '../formatCode';
+import { formatIndentation } from '../formatIndentation';
+import { getHttpRequestName } from '../getHttpRequestName';
+import { registerHandlebarTemplates } from '../registerHandlebarTemplates';
+import { sortModelsByName } from '../sortModelsByName';
+import { sortServicesByName } from '../sortServicesByName';
+
+export const writeClientClassCustomTemplate = async (
+    client: Client,
+    outputPath: string,
+    httpClient: HttpClient,
+    useOptions: boolean,
+    useUnionTypes: boolean,
+    indent: Indent,
+    postfix: string,
+    templatePath: string,
+    clientName?: string
+) => {
+    registerHandlebarTemplates({
+        httpClient,
+        useUnionTypes,
+        useOptions,
+        handlebars: Handlebars, // since we're not using precompiled templates, we need a different object here
+    });
+    Handlebars.registerHelper('capitalize', str => {
+        return str.charAt(0).toUpperCase() + str.slice(1);
+    });
+
+    const clientClassTemplate = Handlebars.compile(await readFile(templatePath, 'utf8'));
+
+    const clientClassFile = resolve(outputPath, `${clientName}.ts`);
+    await remove(clientClassFile);
+
+    const templateResult = clientClassTemplate({
+        clientName,
+        httpClient,
+        postfix,
+        server: client.server,
+        version: client.version,
+        models: sortModelsByName(client.models),
+        services: sortServicesByName(client.services),
+        httpRequest: getHttpRequestName(httpClient),
+    });
+
+    await writeFile(resolve(outputPath, `${clientName}.ts`), formatIndentation(formatCode(templateResult), indent));
+};
diff --git a/src/utils/writeCustomTemplate/clientIndex.ts b/src/utils/writeCustomTemplate/clientIndex.ts
@@ -0,0 +1,65 @@
+import { readFile, remove } from 'fs-extra';
+import Handlebars from 'handlebars';
+import { resolve } from 'path';
+
+import { Client } from '../../client/interfaces/Client';
+import { HttpClient } from '../../HttpClient';
+import { Indent } from '../../Indent';
+import { writeFile } from '../fileSystem';
+import { formatCode } from '../formatCode';
+import { formatIndentation } from '../formatIndentation';
+import { isDefined } from '../isDefined';
+import { registerHandlebarTemplates } from '../registerHandlebarTemplates';
+import { sortModelsByName } from '../sortModelsByName';
+import { sortServicesByName } from '../sortServicesByName';
+
+export const writeClientIndexCustomTemplate = async (
+    client: Client,
+    outputPath: string,
+    httpClient: HttpClient,
+    useOptions: boolean,
+    useUnionTypes: boolean,
+    indent: Indent,
+    postfixServices: string,
+    postfixModels: string,
+    templatePath: string,
+    exportCore: boolean,
+    exportServices: boolean,
+    exportModels: boolean,
+    exportSchemas: boolean,
+    exportClient: boolean,
+    clientName?: string
+) => {
+    registerHandlebarTemplates({
+        httpClient,
+        useUnionTypes,
+        useOptions,
+        handlebars: Handlebars, // since we're not using precompiled templates, we need a different object here
+    });
+    Handlebars.registerHelper('capitalize', str => {
+        return str.charAt(0).toUpperCase() + str.slice(1);
+    });
+
+    const indexTemplate = Handlebars.compile(await readFile(templatePath, 'utf8'));
+
+    const dir = resolve(outputPath, 'index.ts');
+    await remove(dir);
+
+    const templateResult = indexTemplate({
+        serviceBaseUrl: client.server,
+        exportCore,
+        exportServices,
+        exportModels,
+        exportSchemas,
+        useUnionTypes,
+        postfixServices,
+        postfixModels,
+        clientName,
+        server: client.server,
+        version: client.version,
+        models: sortModelsByName(client.models),
+        services: sortServicesByName(client.services),
+        exportClient: isDefined(clientName) && exportClient,
+    });
+    await writeFile(resolve(outputPath, 'index.ts'), formatIndentation(formatCode(templateResult), indent));
+};
diff --git a/src/utils/writeCustomTemplate/clientServices.ts b/src/utils/writeCustomTemplate/clientServices.ts
diff --git a/types/index.d.ts b/types/index.d.ts
