Added custom httpClient generation

Author: Запасной Александр Сергеевич

README.md

@@ -20,6 +20,7 @@
 - Supports JSON and YAML files for input
 - Supports generation through CLI, Node.js and NPX
 - Supports tsc and @babel/plugin-transform-typescript
+- Supports custom httpClients with methods GET, POST, PUT, DELETE
 
 
 ## Install
@@ -37,21 +38,23 @@ $ openapi --help
   Usage: openapi [options]
 
   Options:
-    -V, --version             output the version number
-    -i, --input <value>       OpenAPI specification, can be a path, url or string content (required)
-    -o, --output <value>      Output directory (required)
-    -c, --client <value>      HTTP client to generate [fetch, xhr, node] (default: "fetch")
-    --useOptions              Use options instead of arguments
-    --useUnionTypes           Use union types instead of enums
-    --exportCore <value>      Write core files to disk (default: true)
-    --exportServices <value>  Write services to disk (default: true)
-    --exportModels <value>    Write models to disk (default: true)
-    --exportSchemas <value>   Write schemas to disk (default: false)
+    -V, --version                   output the version number
+    -i, --input <value>             OpenAPI specification, can be a path, url or string content (required)
+    -o, --output <value>            Output directory (required)
+    -c, --client <value>            HTTP client to generate [fetch, xhr, node, httpClient] (default: "fetch")
+    --httpClientLibrary <value>     Library for httpClient with methods GET, POST, PUT, DELETE
+    --useOptions                    Use options instead of arguments
+    --useUnionTypes                 Use union types instead of enums
+    --exportCore <value>            Write core files to disk (default: true)
+    --exportServices <value>        Write services to disk (default: true)
+    --exportModels <value>          Write models to disk (default: true)
+    --exportSchemas <value>         Write schemas to disk (default: false)
 
   Examples
     $ openapi --input ./spec.json
     $ openapi --input ./spec.json --output ./dist
     $ openapi --input ./spec.json --output ./dist --client xhr
+    $ openapi --input ./spec.json --output ./dist --client httpClient --httpClientLibrary @myapp/XHR/HttpClient
 ```
 
 

bin/index.js

@@ -12,7 +12,8 @@ program
     .version(pkg.version)
     .requiredOption('-i, --input <value>', 'OpenAPI specification, can be a path, url or string content (required)')
     .requiredOption('-o, --output <value>', 'Output directory (required)')
-    .option('-c, --client <value>', 'HTTP client to generate [fetch, xhr, node]', 'fetch')
+    .option('-c, --client <value>', 'HTTP client to generate [fetch, xhr, node, httpClient]', 'fetch')
+    .option('--httpClientLibrary <value>', 'Library for httpClient with methods GET, POST, PUT, DELETE', '')
     .option('--useOptions', 'Use options instead of arguments')
     .option('--useUnionTypes', 'Use union types instead of enums')
     .option('--exportCore <value>', 'Write core files to disk', true)
@@ -28,6 +29,7 @@ if (OpenAPI) {
         input: program.input,
         output: program.output,
         httpClient: program.client,
+        httpClientLibrary: program.httpClientLibrary,
         useOptions: program.useOptions,
         useUnionTypes: program.useUnionTypes,
         exportCore: JSON.parse(program.exportCore) === true,

package.json

@@ -1,15 +1,15 @@
 {
-    "name": "openapi-typescript-codegen",
-    "version": "0.7.0",
-    "description": "Library that generates Typescript clients based on the OpenAPI specification.",
-    "author": "Ferdi Koomen",
-    "homepage": "https://github.com/ferdikoomen/openapi-typescript-codegen",
+    "name": "openapi-typescript-codegen-with-custom-client",
+    "version": "0.0.1",
+    "description": "Fork of library that generates Typescript clients based on the OpenAPI specification.",
+    "author": "Sundved",
+    "homepage": "https://github.com/Sundved/openapi-typescript-codegen",
     "repository": {
         "type": "git",
-        "url": "git+https://github.com/ferdikoomen/openapi-typescript-codegen.git"
+        "url": "git+https://github.com/Sundved/openapi-typescript-codegen.git"
     },
     "bugs": {
-        "url": "https://github.com/ferdikoomen/openapi-typescript-codegen/issues"
+        "url": "https://github.com/Sundved/openapi-typescript-codegen/issues"
     },
     "license": "MIT",
     "keywords": [
@@ -27,8 +27,8 @@
     ],
     "maintainers": [
         {
-            "name": "Ferdi Koomen",
-            "email": "info@madebyferdi.com"
+            "name": "Sundved",
+            "email": "sundved@gmail.com"
         }
     ],
     "main": "dist/index.js",
@@ -57,8 +57,7 @@
         "eslint:fix": "eslint \"./src/**/*.ts\" \"./bin/index.js\" \"./types/index.d.ts\" --fix",
         "prettier": "prettier \"./src/**/*.ts\" \"./bin/index.js\" \"./types/index.d.ts\" --check",
         "prettier:fix": "prettier \"./src/**/*.ts\" \"./bin/index.js\" \"./types/index.d.ts\" --write",
-        "prepublish": "yarn run clean && yarn run release",
-        "codecov": "codecov --token=66c30c23-8954-4892-bef9-fbaed0a2e42b"
+        "prepublish": "yarn run clean && yarn run release"
     },
     "dependencies": {
         "camelcase": "^6.2.0",
@@ -82,7 +81,6 @@
         "@types/node-fetch": "2.5.7",
         "@typescript-eslint/eslint-plugin": "4.8.1",
         "@typescript-eslint/parser": "4.8.2",
-        "codecov": "3.8.1",
         "eslint": "7.14.0",
         "eslint-config-prettier": "6.15.0",
         "eslint-plugin-prettier": "3.1.4",

src/index.ts

@@ -11,6 +11,7 @@ export enum HttpClient {
     FETCH = 'fetch',
     XHR = 'xhr',
     NODE = 'node',
+    HTTP_CLIENT = 'httpClient',
 }
 
 export type Options = {
@@ -23,6 +24,7 @@ export type Options = {
     exportServices?: boolean;
     exportModels?: boolean;
     exportSchemas?: boolean;
+    httpClientLibrary?: string;
     write?: boolean;
 };
 
@@ -39,6 +41,7 @@ export type Options = {
  * @param exportServices: Generate services
  * @param exportModels: Generate models
  * @param exportSchemas: Generate schemas
+ * @param httpClientLibrary Library for httpClient
  * @param write Write the files to disk (true or false)
  */
 export async function generate({
@@ -51,6 +54,7 @@ export async function generate({
     exportServices = true,
     exportModels = true,
     exportSchemas = false,
+    httpClientLibrary = '',
     write = true,
 }: Options): Promise<void> {
     const openApi = isString(input) ? await getOpenApiSpec(input) : input;
@@ -62,15 +66,15 @@ export async function generate({
             const client = parseV2(openApi);
             const clientFinal = postProcessClient(client);
             if (!write) break;
-            await writeClient(clientFinal, templates, output, httpClient, useOptions, useUnionTypes, exportCore, exportServices, exportModels, exportSchemas);
+            await writeClient(clientFinal, templates, output, httpClient, useOptions, useUnionTypes, exportCore, exportServices, exportModels, exportSchemas, httpClientLibrary);
             break;
         }
 
         case OpenApiVersion.V3: {
             const client = parseV3(openApi);
             const clientFinal = postProcessClient(client);
             if (!write) break;
-            await writeClient(clientFinal, templates, output, httpClient, useOptions, useUnionTypes, exportCore, exportServices, exportModels, exportSchemas);
+            await writeClient(clientFinal, templates, output, httpClient, useOptions, useUnionTypes, exportCore, exportServices, exportModels, exportSchemas, httpClientLibrary);
             break;
         }
     }

src/templates/core/functions/getUrl.hbs

@@ -3,7 +3,7 @@ function getUrl(options: ApiRequestOptions): string {
     const url = `${OpenAPI.BASE}${path}`;
 
     if (options.query) {
-        return `${url}${getQueryString(options.query)}`;
+        return `${url}${getQueryString({...options.query, ts: new Date().getTime()})}`;
     }
     return url;
 }

src/templates/core/httpClient/request.hbs

@@ -0,0 +1,26 @@
+{{>header}}
+import type { ApiRequestOptions } from './ApiRequestOptions';
+import { OpenAPI } from './OpenAPI';
+
+{{>functions/isDefined}}
+
+
+{{>functions/getQueryString}}
+
+
+{{>functions/getUrl}}
+
+
+{{>httpClient/sendRequest}}
+
+
+/**
+ * Request using XHR client
+ * @param options The request options from the the service
+ * @result ApiResult
+ */
+export function request(options: ApiRequestOptions): Promise<any> {
+    const url = getUrl(options);
+
+    return sendRequest(options, url);
+}

src/templates/core/httpClient/sendRequest.hbs

@@ -0,0 +1,15 @@
+import {DELETE, GET, POST, PUT} from '{{>httpClientLibrary}}';
+
+async function sendRequest(options: ApiRequestOptions, url: string): Promise<any> {
+
+    switch (options.method) {
+        case 'GET':
+            return GET(url);
+        case 'POST':
+            return POST(url, getRequestBody(options));
+        case 'PUT':
+            return PUT(url, getRequestBody(options));
+        case 'DELETE':
+            return DELETE(url, getRequestBody(options));
+    }
+}

src/templates/core/request.hbs

@@ -1,3 +1,4 @@
 {{#equals @root.httpClient 'fetch'}}{{>fetch/request}}{{/equals}}
 {{#equals @root.httpClient 'xhr'}}{{>xhr/request}}{{/equals}}
 {{#equals @root.httpClient 'node'}}{{>node/request}}{{/equals}}
+{{#equals @root.httpClient 'httpClient'}}{{>httpClient/request}}{{/equals}}

src/utils/registerHandlebarTemplates.ts

@@ -20,6 +20,8 @@ import functionIsString from '../templates/core/functions/isString.hbs';
 import functionIsStringWithValue from '../templates/core/functions/isStringWithValue.hbs';
 import functionIsSuccess from '../templates/core/functions/isSuccess.hbs';
 import functionResolve from '../templates/core/functions/resolve.hbs';
+import httpClientRequest from '../templates/core/httpClient/request.hbs';
+import httpClientSendRequest from '../templates/core/httpClient/sendRequest.hbs';
 import nodeGetHeaders from '../templates/core/node/getHeaders.hbs';
 import nodeGetRequestBody from '../templates/core/node/getRequestBody.hbs';
 import nodeGetResponseBody from '../templates/core/node/getResponseBody.hbs';
@@ -165,6 +167,10 @@ export function registerHandlebarTemplates(): Templates {
     Handlebars.registerPartial('xhr/sendRequest', Handlebars.template(xhrSendRequest));
     Handlebars.registerPartial('xhr/request', Handlebars.template(xhrRequest));
 
+    // Specific files for the httpClient client implementation
+    Handlebars.registerPartial('httpClient/sendRequest', Handlebars.template(httpClientSendRequest));
+    Handlebars.registerPartial('httpClient/request', Handlebars.template(httpClientRequest));
+
     // Specific files for the node client implementation
     Handlebars.registerPartial('node/getHeaders', Handlebars.template(nodeGetHeaders));
     Handlebars.registerPartial('node/getRequestBody', Handlebars.template(nodeGetRequestBody));

src/utils/writeClient.ts

@@ -23,6 +23,7 @@ import { writeClientServices } from './writeClientServices';
  * @param exportServices: Generate services
  * @param exportModels: Generate models
  * @param exportSchemas: Generate schemas
+ * @param httpClientLibrary: Library for httpClient
  */
 export async function writeClient(
     client: Client,
@@ -34,7 +35,8 @@ export async function writeClient(
     exportCore: boolean,
     exportServices: boolean,
     exportModels: boolean,
-    exportSchemas: boolean
+    exportSchemas: boolean,
+    httpClientLibrary: string
 ): Promise<void> {
     const outputPath = path.resolve(process.cwd(), output);
     const outputPathCore = path.resolve(outputPath, 'core');
@@ -55,7 +57,7 @@ export async function writeClient(
     if (exportServices) {
         await rmdir(outputPathServices);
         await mkdir(outputPathServices);
-        await writeClientServices(client.services, templates, outputPathServices, httpClient, useUnionTypes, useOptions);
+        await writeClientServices(client.services, templates, outputPathServices, httpClient, useUnionTypes, useOptions, httpClientLibrary);
     }
 
     if (exportSchemas) {