add --serviceTemplate option

Author: mb21

README.md

@@ -1,5 +1,36 @@
 # OpenAPI Typescript Codegen
 
+Fork ([diff](https://github.com/ferdikoomen/openapi-typescript-codegen/compare/master...DND-IT:openapi-typescript-codegen:master))
+which adds a `--serviceTemplate` option. A variant of this fork is also in [this pull request](https://github.com/ferdikoomen/openapi-typescript-codegen/pull/1268) to the original upstream repo.
+
+Can be used in another project by adding to `package.json`:
+
+```json
+"openapi-typescript-codegen": "https://github.com/DND-IT/openapi-typescript-codegen.git#master",
+```
+
+To update or modify this fork, check it out locally:
+
+    git clone [email protected]:DND-IT/openapi-typescript-codegen.git
+    cd openapi-typescript-codegen
+    git remote add upstream [email protected]:ferdikoomen/openapi-typescript-codegen.git
+
+To pull in changes from original repo:
+
+    git fetch upstream
+    git rebase upstream/master master
+    npm ci
+
+To build a new version and test it locally in disco project:
+
+    npm run release
+    cp dist/index.js ../disco/node_modules/openapi-typescript-codegen/dist/index.js`
+
+To release a new version, run `npm run release` and push everything, including the `dist/index.js` file to GitHub. Then, in the project using it, delete the
+`openapi-typescript-codegen` entry in the `package-lock.json` and run `npm install` to install the new version.
+
+---
+
 [![NPM][npm-image]][npm-url]
 [![License][license-image]][license-url]
 [![Coverage][coverage-image]][coverage-url]
@@ -51,6 +82,7 @@ $ openapi --help
     --postfixServices         Service name postfix (default: "Service")
     --postfixModels           Model name postfix
     --request <value>         Path to custom request file
+    --serviceTemplate         Path to custom service handlebars template to generate the service files
     -h, --help                display help for command
 
   Examples

bin/index.js

@@ -25,6 +25,7 @@ const params = program
     .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')
     .parse(process.argv)
     .opts();
 
@@ -46,6 +47,7 @@ if (OpenAPI) {
         postfixServices: params.postfixServices ?? params.postfix,
         postfixModels: params.postfixModels,
         request: params.request,
+        serviceTemplate: params.serviceTemplate,
     })
         .then(() => {
             process.exit(0);

src/index.ts

@@ -8,6 +8,7 @@ import { isString } from './utils/isString';
 import { postProcessClient } from './utils/postProcessClient';
 import { registerHandlebarTemplates } from './utils/registerHandlebarTemplates';
 import { writeClient } from './utils/writeClient';
+import { writeClientServicesCustomTemplate } from './utils/writeClientServicesCustomTemplate';
 
 export { HttpClient } from './HttpClient';
 export { Indent } from './Indent';
@@ -27,6 +28,7 @@ export type Options = {
     postfixServices?: string;
     postfixModels?: string;
     request?: string;
+    serviceTemplate?: string;
     write?: boolean;
 };
 
@@ -65,6 +67,7 @@ export const generate = async ({
     postfixServices = 'Service',
     postfixModels = '',
     request,
+    serviceTemplate,
     write = true,
 }: Options): Promise<void> => {
     const openApi = isString(input) ? await getOpenApiSpec(input) : input;
@@ -75,10 +78,15 @@ export const generate = async ({
         useOptions,
     });
 
+    if (serviceTemplate) {
+        exportServices = false;
+    }
+
+    let clientFinal;
     switch (openApiVersion) {
         case OpenApiVersion.V2: {
             const client = parseV2(openApi);
-            const clientFinal = postProcessClient(client);
+            clientFinal = postProcessClient(client);
             if (!write) break;
             await writeClient(
                 clientFinal,
@@ -102,7 +110,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,
@@ -124,6 +132,19 @@ export const generate = async ({
             break;
         }
     }
+
+    if (serviceTemplate) {
+        await writeClientServicesCustomTemplate(
+            clientFinal,
+            output,
+            httpClient,
+            useOptions,
+            useUnionTypes,
+            indent,
+            postfixServices,
+            serviceTemplate
+        );
+    }
 };
 
 export default {

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)) {

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)

src/utils/writeClientServicesCustomTemplate.ts

@@ -0,0 +1,58 @@
+import { mkdir, readFile, remove } from 'fs-extra';
+import Handlebars from 'handlebars';
+import { resolve } from 'path';
+
+import { Client } from '../client/interfaces/Client';
+import { OperationParameter } from '../client/interfaces/OperationParameter';
+import { HttpClient } from '../HttpClient';
+import { Indent } from '../Indent';
+import { writeFile } from './fileSystem';
+import { formatCode } from './formatCode';
+import { formatIndentation } from './formatIndentation';
+import { registerHandlebarTemplates } from './registerHandlebarTemplates';
+
+export const writeClientServicesCustomTemplate = async (
+    client: Client,
+    outputPath: string,
+    httpClient: HttpClient,
+    useOptions: boolean,
+    useUnionTypes: boolean,
+    indent: Indent,
+    postfix: string,
+    templatePath: string
+) => {
+    registerHandlebarTemplates({
+        httpClient,
+        useUnionTypes,
+        useOptions,
+        handlebars: Handlebars, // since we're not using precompiled templates, we need a different object here
+    });
+    Handlebars.registerHelper('capitalize', (str: string) => {
+        return str.charAt(0).toUpperCase() + str.slice(1);
+    });
+    Handlebars.registerHelper('buildUrlStr', (path: string, parametersPath?: OperationParameter[]) => {
+        parametersPath?.forEach(param => {
+            path = path.replace(`{${param.prop}}`, '${' + param.name + '}');
+        });
+        return path;
+    });
+
+    const serviceTemplate = Handlebars.compile(await readFile(templatePath, 'utf8'));
+
+    const servicesDir = resolve(outputPath, 'services');
+    await remove(servicesDir);
+    await mkdir(servicesDir);
+
+    for (const service of client.services) {
+        const file = resolve(outputPath, `services/${service.name}${postfix}.ts`);
+        const templateResult = serviceTemplate({
+            ...service,
+            serviceBaseUrl: client.server,
+            httpClient,
+            useUnionTypes,
+            useOptions,
+            postfix,
+        });
+        await writeFile(file, formatIndentation(formatCode(templateResult), indent));
+    }
+};