Add 'inlineRequestOverrides' option to easily modify individual requests

Author: parrotmac

bin/index.js

@@ -16,6 +16,7 @@ const params = program
     .option('--name <value>', 'Custom client class name')
     .option('--useOptions', 'Use options instead of arguments')
     .option('--useUnionTypes', 'Use union types instead of enums')
+    .option('--inlineRequestOverrides', 'Permit specifying request options on a per-invocation basis')
     .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)
@@ -35,6 +36,7 @@ if (OpenAPI) {
         httpClient: params.client,
         clientName: params.name,
         useOptions: params.useOptions,
+        inlineRequestOverrides: params.inlineRequestOverrides,
         useUnionTypes: params.useUnionTypes,
         exportCore: JSON.parse(params.exportCore) === true,
         exportServices: JSON.parse(params.exportServices) === true,

bin/index.spec.js

@@ -23,6 +23,7 @@ describe('bin', () => {
             '--client',
             'fetch',
             '--useOptions',
+            '--inlineRequestOverrides',
             '--useUnionTypes',
             '--exportCore',
             'true',

docs/basic-usage.md

@@ -12,6 +12,7 @@ $ openapi --help
     -c, --client <value>      HTTP client to generate [fetch, xhr, node, axios, angular] (default: "fetch")
     --name <value>            Custom client class name
     --useOptions              Use options instead of arguments
+    --inlineRequestOverrides  Override request options on a per-invocation basis
     --useUnionTypes           Use union types instead of enums
     --exportCore <value>      Write core files to disk (default: true)
     --exportServices <value>  Write services to disk (default: true)

package.json

@@ -1,12 +1,12 @@
 {
-    "name": "openapi-typescript-codegen",
-    "version": "0.23.0",
+    "name": "@parrotmac/openapi-typescript-codegen",
+    "version": "0.23.0-hack5",
     "description": "Library that generates Typescript clients based on the OpenAPI specification.",
     "author": "Ferdi Koomen",
-    "homepage": "https://github.com/ferdikoomen/openapi-typescript-codegen",
+    "homepage": "https://github.com/parrotmac/openapi-typescript-codegen",
     "repository": {
         "type": "git",
-        "url": "git+https://github.com/ferdikoomen/openapi-typescript-codegen.git"
+        "url": "git+https://github.com/parrotmac/openapi-typescript-codegen.git"
     },
     "bugs": {
         "url": "https://github.com/ferdikoomen/openapi-typescript-codegen/issues"
@@ -31,10 +31,13 @@
             "email": "[email protected]"
         }
     ],
+    "publishConfig": {
+        "registry":"https://registry.npmjs.org"
+    },
     "main": "dist/index.js",
     "types": "types/index.d.ts",
     "bin": {
-        "openapi": "bin/index.js"
+        "custom-openapi": "bin/index.js"
     },
     "files": [
         "bin/index.js",

src/index.ts

@@ -18,6 +18,7 @@ export type Options = {
     httpClient?: HttpClient;
     clientName?: string;
     useOptions?: boolean;
+    inlineRequestOverrides?: boolean;
     useUnionTypes?: boolean;
     exportCore?: boolean;
     exportServices?: boolean;
@@ -39,6 +40,7 @@ export type Options = {
  * @param clientName Custom client class name
  * @param useOptions Use options or arguments functions
  * @param useUnionTypes Use union types instead of enums
+ * @param inlineRequestOverrides Provide a place within service methods to define arbitrary request modifications
  * @param exportCore Generate core client classes
  * @param exportServices Generate services
  * @param exportModels Generate models
@@ -54,6 +56,7 @@ export const generate = async ({
     httpClient = HttpClient.FETCH,
     clientName,
     useOptions = false,
+    inlineRequestOverrides = false,
     useUnionTypes = false,
     exportCore = true,
     exportServices = true,
@@ -83,6 +86,7 @@ export const generate = async ({
                 output,
                 httpClient,
                 useOptions,
+                inlineRequestOverrides,
                 useUnionTypes,
                 exportCore,
                 exportServices,
@@ -106,6 +110,7 @@ export const generate = async ({
                 output,
                 httpClient,
                 useOptions,
+                inlineRequestOverrides,
                 useUnionTypes,
                 exportCore,
                 exportServices,

src/templates/exportService.hbs

@@ -30,6 +30,9 @@ import type { BaseHttpRequest } from '../core/BaseHttpRequest';
 import { OpenAPI } from '../core/OpenAPI';
 import { request as __request } from '../core/request';
 {{/if}}
+{{#if @root.inlineRequestOverrides~}}
+import type { ApiRequestOptions } from '../core/ApiRequestOptions';
+{{/if}}
 
 {{#equals @root.httpClient 'angular'}}
 @Injectable()
@@ -143,6 +146,9 @@ export class {{{name}}}{{{@root.postfix}}} {
 				{{/each}}
 			},
 			{{/if}}
+			{{#if @root.inlineRequestOverrides}}
+			..._requestOverrides,
+			{{/if}}
 		});
 	}
 

src/templates/partials/parameters.hbs

@@ -4,6 +4,9 @@
 {{#each parameters}}
 {{{name}}}{{#if default}} = {{{default}}}{{/if}},
 {{/each}}
+{{#if @root.inlineRequestOverrides~}}
+_requestOverrides,
+{{/if}}
 }: {
 {{#each parameters}}
 {{#ifdef description deprecated}}
@@ -18,11 +21,19 @@
 {{/ifdef}}
 {{{name}}}{{>isRequired}}: {{>type}},
 {{/each}}
+    _requestOverrides?: Partial<ApiRequestOptions>,
 }
 {{~else}}
 
 {{#each parameters}}
 {{{name}}}{{>isRequired}}: {{>type}}{{#if default}} = {{{default}}}{{/if}},
 {{/each}}
 {{/if}}
+{{~else}}
+{{#if @root.inlineRequestOverrides~}}{
+    _requestOverrides,
+}: {
+    _requestOverrides?: Partial<ApiRequestOptions>,
+}
+{{/if}}
 {{/if}}

src/utils/writeClient.spec.ts

@@ -43,6 +43,7 @@ describe('writeClient', () => {
             HttpClient.FETCH,
             false,
             false,
+            false,
             true,
             true,
             true,

src/utils/writeClient.ts

@@ -38,6 +38,7 @@ export const writeClient = async (
     output: string,
     httpClient: HttpClient,
     useOptions: boolean,
+    inlineRequestOverrides: boolean,
     useUnionTypes: boolean,
     exportCore: boolean,
     exportServices: boolean,
@@ -74,6 +75,7 @@ export const writeClient = async (
             httpClient,
             useUnionTypes,
             useOptions,
+            inlineRequestOverrides,
             indent,
             postfix,
             clientName

src/utils/writeClientServices.spec.ts

@@ -39,7 +39,7 @@ describe('writeClientServices', () => {
             },
         };
 
-        await writeClientServices(services, templates, '/', HttpClient.FETCH, false, false, Indent.SPACE_4, 'Service');
+        await writeClientServices(services, templates, '/', HttpClient.FETCH, false, false, false, Indent.SPACE_4, 'Service');
 
         expect(writeFile).toBeCalledWith('/UserService.ts', `service${EOL}`);
     });