add splitParamters and support for abortSignal

alerizzo · alerizzo · commit 428bc489232e · 2024-01-23T11:56:34.000Z
diff --git a/bin/index.js b/bin/index.js
@@ -15,6 +15,7 @@ const params = program
     .option('-c, --client <value>', 'HTTP client to generate [fetch, xhr, node, axios, angular]', 'fetch')
     .option('--name <value>', 'Custom client class name')
     .option('--useOptions', 'Use options instead of arguments')
+    .option('--splitParameters', 'User arguments for path parameters and options for query parameters')
     .option('--useUnionTypes', 'Use union types instead of enums')
     .option('--exportCore <value>', 'Write core files to disk', true)
     .option('--exportServices <value>', 'Write services to disk', true)
@@ -36,6 +37,7 @@ if (OpenAPI) {
         httpClient: params.client,
         clientName: params.name,
         useOptions: params.useOptions,
+        splitParameters: params.splitParameters,
         useUnionTypes: params.useUnionTypes,
         exportCore: JSON.parse(params.exportCore) === true,
         exportServices: JSON.parse(params.exportServices) === true,
diff --git a/package.json b/package.json
@@ -46,7 +46,8 @@
         "eslint": "eslint .",
         "eslint:fix": "eslint . --fix",
         "prepare": "npm run clean && npm run release",
-        "generate-codacy": "npm run build && rimraf ./generated && node ./bin/index.js --input ./samples/spec/codacy-api.yaml --output ./generated --useUnionTypes --indent 2 --client axios"
+        "generate-spa-codacy": "npm run build && rimraf ./generated && node ./bin/index.js --input ./samples/spec/codacy-api.yaml --output ./generated --useUnionTypes --indent 2 --client fetch --splitParameters",
+        "generate-ide-codacy": "npm run build && rimraf ./generated && node ./bin/index.js --input ./samples/spec/codacy-api.yaml --output ./generated --useUnionTypes --indent 2 --client axios"
     },
     "dependencies": {
         "@apidevtools/json-schema-ref-parser": "^10.1.0",
diff --git a/src/index.ts b/src/index.ts
@@ -18,6 +18,7 @@ export type Options = {
     httpClient?: HttpClient;
     clientName?: string;
     useOptions?: boolean;
+    splitParameters?: boolean;
     useUnionTypes?: boolean;
     exportCore?: boolean;
     exportServices?: boolean;
@@ -39,6 +40,7 @@ export type Options = {
  * @param httpClient The selected httpClient (fetch, xhr, node or axios)
  * @param clientName Custom client class name
  * @param useOptions Use options or arguments functions
+ * @param splitParameters User arguments for path parameters and options for query parameters
  * @param useUnionTypes Use union types instead of enums
  * @param exportCore Generate core client classes
  * @param exportServices Generate services
@@ -56,6 +58,7 @@ export const generate = async ({
     httpClient = HttpClient.FETCH,
     clientName,
     useOptions = false,
+    splitParameters = false,
     useUnionTypes = false,
     exportCore = true,
     exportServices = true,
@@ -86,6 +89,7 @@ export const generate = async ({
                 output,
                 httpClient,
                 useOptions,
+                splitParameters,
                 useUnionTypes,
                 exportCore,
                 exportServices,
@@ -110,6 +114,7 @@ export const generate = async ({
                 output,
                 httpClient,
                 useOptions,
+                splitParameters,
                 useUnionTypes,
                 exportCore,
                 exportServices,
diff --git a/src/templates/core/ApiRequestOptions.hbs b/src/templates/core/ApiRequestOptions.hbs
@@ -12,4 +12,5 @@ export type ApiRequestOptions = {
 	readonly mediaType?: string;
 	readonly responseHeader?: string;
 	readonly errors?: Record<number, string>;
+	readonly abortSignal?: AbortSignal;
 };
diff --git a/src/templates/core/fetch/sendRequest.hbs b/src/templates/core/fetch/sendRequest.hbs
@@ -9,11 +9,13 @@ export const sendRequest = async (
 ): Promise<Response> => {
 	const controller = new AbortController();
 
+	const combinedSignal = AbortSignal.any(controller.signal, options.abortSignal);
+
 	const request: RequestInit = {
 		headers,
 		body: body ?? formData,
 		method: options.method,
-		signal: controller.signal,
+		signal: combinedSignal,
 	};
 
 	if (config.WITH_CREDENTIALS) {
diff --git a/src/templates/core/node/sendRequest.hbs b/src/templates/core/node/sendRequest.hbs
@@ -8,11 +8,13 @@ export const sendRequest = async (
 ): Promise<Response> => {
 	const controller = new AbortController();
 
+	const combinedSignal = AbortSignal.any(controller.signal, options.abortSignal);
+
 	const request: RequestInit = {
 		headers,
 		method: options.method,
 		body: body ?? formData,
-		signal: controller.signal as AbortSignal,
+		signal: combinedSignal as AbortSignal,
 	};
 
 	onCancel(() => controller.abort());
diff --git a/src/templates/exportService.hbs b/src/templates/exportService.hbs
@@ -61,7 +61,13 @@ export class {{{name}}}{{{@root.postfix}}} {
 	{{#unless @root.useOptions}}
 	{{#if parameters}}
 	{{#each parameters}}
-	 * @param {{{name}}} {{#if description}}{{{escapeComment description}}}{{/if}}
+		{{#if @root.splitParameters~}}
+		{{#equals in 'path'}}
+	 	* @param {{{name}}} {{#if description}}{{{escapeComment description}}}{{/if}}
+		{{/equals}}
+		{{~else~}}
+	 	* @param {{{name}}} {{#if description}}{{{escapeComment description}}}{{/if}}
+		{{~/if~}}
 	{{/each}}
 	{{/if}}
 	{{/unless}}
@@ -117,6 +123,7 @@ export class {{{name}}}{{{@root.postfix}}} {
 				{{/each}}
 			},
 			{{/if}}
+			abortSignal,
 			{{#if parametersForm}}
 			formData: {
 				{{#each parametersForm}}
diff --git a/src/templates/partials/parameters.hbs b/src/templates/partials/parameters.hbs
@@ -9,20 +9,59 @@
 {{#ifdef description deprecated}}
 /**
 {{#if description}}
- * {{{escapeComment description}}}
+* {{{escapeComment description}}}
 {{/if}}
 {{#if deprecated}}
- * @deprecated
+* @deprecated
 {{/if}}
- */
+*/
 {{/ifdef}}
 {{{name}}}{{>isRequired}}: {{>type}},
 {{/each}}
 }
 {{~else}}
-
+{{#if @root.splitParameters~}}
 {{#each parameters}}
+{{#equals in 'path'}}
 {{{name}}}{{>isRequired}}: {{>type}}{{#if default}} = {{{default}}}{{/if}},
+{{/equals}}
 {{/each}}
+{
+{{#each parameters}}
+{{#notEquals in 'path'}}
+{{{name}}}{{#if default}} = {{{default}}}{{/if}},
+{{/notEquals}}
+{{/each}}
+abortSignal,
+}: {
+{{#each parameters}}
+{{#notEquals in 'path'}}
+{{#ifdef description deprecated}}
+/**
+{{#if description}}
+* {{{escapeComment description}}}
+{{/if}}
+{{#if deprecated}}
+* @deprecated
+{{/if}}
+*/
+{{/ifdef}}
+{{{name}}}{{>isRequired}}: {{>type}},
+{{/notEquals}}
+{{/each}}
+abortSignal?: AbortSignal
+}
+{{~else}}
+{{#each parameters}}
+{{{name}}}{{>isRequired}}: {{>type}}{{#if default}} = {{{default}}}{{/if}},
+{{/each}}
+abortSignal?: AbortSignal
+{{/if}}
+{{/if}}
+{{~else}}
+{{#if @root.useOptions}}{ abortSignal }: { abortSignal?: AbortSignal }{{~else}}
+{{#if @root.splitParameters}}{ abortSignal }: { abortSignal?: AbortSignal }{{~else}}
+abortSignal?: AbortSignal
+{{/if}}
 {{/if}}
 {{/if}}
diff --git a/src/utils/writeClient.spec.ts b/src/utils/writeClient.spec.ts
@@ -43,6 +43,7 @@ describe('writeClient', () => {
             HttpClient.FETCH,
             false,
             false,
+            false,
             true,
             true,
             true,
diff --git a/src/utils/writeClient.ts b/src/utils/writeClient.ts
@@ -39,6 +39,7 @@ export const writeClient = async (
     output: string,
     httpClient: HttpClient,
     useOptions: boolean,
+    splitParameters: boolean,
     useUnionTypes: boolean,
     exportCore: boolean,
     exportServices: boolean,
@@ -76,6 +77,7 @@ export const writeClient = async (
             httpClient,
             useUnionTypes,
             useOptions,
+            splitParameters,
             indent,
             postfixServices,
             clientName
diff --git a/src/utils/writeClientServices.spec.ts b/src/utils/writeClientServices.spec.ts
@@ -40,7 +40,17 @@ 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(resolve('/', '/UserService.ts'), `service${EOL}`);
     });
diff --git a/src/utils/writeClientServices.ts b/src/utils/writeClientServices.ts
@@ -28,6 +28,7 @@ export const writeClientServices = async (
     httpClient: HttpClient,
     useUnionTypes: boolean,
     useOptions: boolean,
+    splitParameters: boolean,
     indent: Indent,
     postfix: string,
     clientName?: string
@@ -39,6 +40,7 @@ export const writeClientServices = async (
             httpClient,
             useUnionTypes,
             useOptions,
+            splitParameters,
             postfix,
             exportClient: isDefined(clientName),
         });
diff --git a/test/e2e/scripts/generateClient.ts b/test/e2e/scripts/generateClient.ts
@@ -5,6 +5,7 @@ export const generateClient = async (
     version: string,
     client: 'fetch' | 'xhr' | 'node' | 'axios' | 'angular',
     useOptions: boolean = false,
+    splitParameters: boolean = false,
     useUnionTypes: boolean = false,
     clientName?: string
 ) => {
@@ -13,6 +14,7 @@ export const generateClient = async (
         output: `./test/e2e/generated/${dir}/`,
         httpClient: client,
         useOptions,
+        splitParameters,
         useUnionTypes,
         clientName,
     });
diff --git a/test/index.js b/test/index.js
@@ -9,6 +9,7 @@ const generate = async (input, output) => {
         output,
         httpClient: OpenAPI.HttpClient.FETCH,
         useOptions: true,
+        splitParameters: false,
         useUnionTypes: false,
         exportCore: true,
         exportSchemas: true,
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -18,6 +18,7 @@ export type Options = {
     httpClient?: HttpClient | 'fetch' | 'xhr' | 'node' | 'axios' | 'angular';
     clientName?: string;
     useOptions?: boolean;
+    splitParameters?: boolean;
     useUnionTypes?: boolean;
     exportCore?: boolean;
     exportServices?: boolean;

-Original file line number
+Diff line change
             HttpClient.FETCH,
             false,
             false,
 +            false,
             true,
             true,
             true,