globalHeaders

Author: Alex0007

bin/index.js

@@ -11,6 +11,7 @@ program
     .option('-i, --input <value>', 'Path to swagger specification', './spec.json')
     .option('-o, --output <value>', 'Output directory', './generated')
     .option('-c, --client <value>', 'HTTP client to generate [fetch, xhr, node-fetch]', 'fetch')
+    .option('--globalHeaders <value>', 'Common HTTP headers')
     .option('--useOptions', 'Use options vs arguments style functions')
     .option('--useUnionTypes', 'Use inclusive union types')
     .option('--exportCore <value>', 'Generate core', true)
@@ -26,6 +27,7 @@ if (OpenAPI) {
         input: program.input,
         output: program.output,
         httpClient: program.client,
+        globalHeaders: program.globalHeaders ? JSON.parse(program.globalHeaders) : {},
         useOptions: program.useOptions,
         useUnionTypes: program.useUnionTypes,
         exportCore: JSON.parse(program.exportCore) === true,

package.json

@@ -63,7 +63,8 @@
         "js-yaml": "3.14.0",
         "mkdirp": "1.0.4",
         "path": "0.12.7",
-        "rimraf": "3.0.2"
+        "rimraf": "3.0.2",
+        "stringify-object": "^3.3.0"
     },
     "devDependencies": {
         "@babel/core": "7.11.0",
@@ -76,6 +77,7 @@
         "@types/mkdirp": "1.0.1",
         "@types/node": "14.0.27",
         "@types/rimraf": "3.0.0",
+        "@types/stringify-object": "^3.3.0",
         "@typescript-eslint/eslint-plugin": "3.7.1",
         "@typescript-eslint/parser": "3.7.1",
         "codecov": "3.7.2",

src/index.ts

@@ -10,13 +10,14 @@ import { writeClient } from './utils/writeClient';
 export enum HttpClient {
     FETCH = 'fetch',
     XHR = 'xhr',
-    NODE_FETCH = 'node-fetch'
+    NODE_FETCH = 'node-fetch',
 }
 
 export interface Options {
     input: string | Record<string, any>;
     output: string;
     httpClient?: HttpClient;
+    globalHeaders?: { [key: string]: any };
     useOptions?: boolean;
     useUnionTypes?: boolean;
     exportCore?: boolean;
@@ -33,6 +34,7 @@ export interface Options {
  * @param input The relative ___location of the OpenAPI spec.
  * @param output The relative ___location of the output directory.
  * @param httpClient The selected httpClient (fetch or XHR).
+ * @param globalHeaders Common HTTP headers
  * @param useOptions Use options or arguments functions.
  * @param useUnionTypes Use inclusive union types.
  * @param exportCore: Generate core client classes.
@@ -45,6 +47,7 @@ export async function generate({
     input,
     output,
     httpClient = HttpClient.FETCH,
+    globalHeaders = {},
     useOptions = false,
     useUnionTypes = false,
     exportCore = true,
@@ -64,7 +67,7 @@ export async function generate({
             const client = parseV2(openApi);
             const clientFinal = postProcessClient(client, useUnionTypes);
             if (write) {
-                await writeClient(clientFinal, templates, output, httpClient, useOptions, exportCore, exportServices, exportModels, exportSchemas);
+                await writeClient(clientFinal, templates, output, httpClient, globalHeaders, useOptions, exportCore, exportServices, exportModels, exportSchemas);
             }
             break;
         }
@@ -73,7 +76,7 @@ export async function generate({
             const client = parseV3(openApi);
             const clientFinal = postProcessClient(client, useUnionTypes);
             if (write) {
-                await writeClient(clientFinal, templates, output, httpClient, useOptions, exportCore, exportServices, exportModels, exportSchemas);
+                await writeClient(clientFinal, templates, output, httpClient, globalHeaders, useOptions, exportCore, exportServices, exportModels, exportSchemas);
             }
             break;
         }

src/templates/core/OpenAPI.hbs

@@ -9,6 +9,7 @@ interface Config {
     CLIENT: 'fetch' | 'xhr' | 'node-fetch';
     WITH_CREDENTIALS: boolean;
     TOKEN: string;
+    WITH_HEADERS: { [key: string]: any };
 }
 
 export const OpenAPI: Config = {
@@ -17,4 +18,5 @@ export const OpenAPI: Config = {
     CLIENT: '{{{httpClient}}}',
     WITH_CREDENTIALS: false,
     TOKEN: '',
+    WITH_HEADERS: {{{globalHeaders}}}
 };

src/templates/core/request.ts

@@ -28,6 +28,7 @@ export async function request(options: Readonly<RequestOptions>): Promise<Result
     // Create request headers
     const headers = new H({
         ...options.headers,
+        ...OpenAPI.WITH_HEADERS,
         Accept: 'application/json',
     });
 

src/utils/writeClient.spec.ts

@@ -16,14 +16,15 @@ describe('writeClient', () => {
         };
 
         const templates: Templates = {
+            servicesIndex: () => 'dummy',
             index: () => 'dummy',
             model: () => 'dummy',
             schema: () => 'dummy',
             service: () => 'dummy',
             settings: () => 'dummy',
         };
 
-        await writeClient(client, templates, '/', HttpClient.FETCH, false, true, true, true, true);
+        await writeClient(client, templates, '/', HttpClient.FETCH, {}, false, true, true, true, true);
 
         expect(rmdir).toBeCalled();
         expect(mkdir).toBeCalled();

src/utils/writeClient.ts

@@ -32,6 +32,7 @@ export async function writeClient(
     templates: Templates,
     output: string,
     httpClient: HttpClient,
+    globalHeaders: { [key: string]: any },
     useOptions: boolean,
     exportCore: boolean,
     exportServices: boolean,
@@ -64,9 +65,9 @@ export async function writeClient(
 
     if (exportServices) {
         await mkdir(outputPathServices);
-        await writeClientSettings(client, templates, outputPathCore, httpClient);
+        await writeClientSettings(client, templates, outputPathCore, httpClient, globalHeaders);
         await writeClientServices(client.services, templates, outputPathServices, useOptions);
-        await writeClientServicesIndex(client.services, templates, outputPathServices)
+        await writeClientServicesIndex(client.services, templates, outputPathServices);
     }
 
     if (exportSchemas) {

src/utils/writeClientServicesIndex.ts

@@ -7,11 +7,8 @@ import { Templates } from './registerHandlebarTemplates';
 
 export async function writeClientServicesIndex(services: Service[], templates: Templates, outputPath: string): Promise<void> {
     const templateResult = templates.servicesIndex({
-        services
+        services,
     });
-    
-    await writeFile(
-        path.resolve(outputPath, 'index.ts'),
-        format(templateResult)
-    );
+
+    await writeFile(path.resolve(outputPath, 'index.ts'), format(templateResult));
 }

src/utils/writeClientSettings.spec.ts

@@ -16,14 +16,15 @@ describe('writeClientSettings', () => {
         };
 
         const templates: Templates = {
+            servicesIndex: () => 'dummy',
             index: () => 'dummy',
             model: () => 'dummy',
             schema: () => 'dummy',
             service: () => 'dummy',
             settings: () => 'dummy',
         };
 
-        await writeClientSettings(client, templates, '/', HttpClient.FETCH);
+        await writeClientSettings(client, templates, '/', HttpClient.FETCH, {});
 
         expect(writeFile).toBeCalledWith('/OpenAPI.ts', 'dummy');
     });

src/utils/writeClientSettings.ts

@@ -1,22 +1,33 @@
 import * as path from 'path';
+import stringifyObject from 'stringify-object';
 
 import { Client } from '../client/interfaces/Client';
 import { HttpClient } from '../index';
 import { writeFile } from './fileSystem';
 import { Templates } from './registerHandlebarTemplates';
 
+const indent = '    ';
+
 /**
  * Generate OpenAPI configuration file "OpenAPI.ts"
  * @param client Client object, containing, models, schemas and services.
  * @param templates The loaded handlebar templates.
  * @param outputPath Directory to write the generated files to.
  * @param httpClient The selected httpClient (fetch or XHR).
+ * @param globalHeaders Common HTTP headers
  */
-export async function writeClientSettings(client: Client, templates: Templates, outputPath: string, httpClient: HttpClient): Promise<void> {
+export async function writeClientSettings(client: Client, templates: Templates, outputPath: string, httpClient: HttpClient, globalHeaders: { [key: string]: any }): Promise<void> {
     await writeFile(
         path.resolve(outputPath, 'OpenAPI.ts'),
         templates.settings({
             httpClient,
+            globalHeaders: stringifyObject(
+                globalHeaders,
+                {
+                    indent,
+                },
+                indent
+            ),
             server: client.server,
             version: client.version,
         })