option to expose response headers and body

NilsEckertSolace · NilsEckertSolace · commit d7761c71ebcb · 2022-02-14T11:19:50.000+01:00
diff --git a/bin/index.js b/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('--exposeHeadersAndBody', 'Return response headers and body (default is body only')
     .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)
@@ -36,6 +37,7 @@ if (OpenAPI) {
         clientName: params.name,
         useOptions: params.useOptions,
         useUnionTypes: params.useUnionTypes,
+        exposeHeadersAndBody: params.exposeHeadersAndBody,
         exportCore: JSON.parse(params.exportCore) === true,
         exportServices: JSON.parse(params.exportServices) === true,
         exportModels: JSON.parse(params.exportModels) === true,
diff --git a/src/index.ts b/src/index.ts
@@ -19,6 +19,7 @@ export type Options = {
     clientName?: string;
     useOptions?: boolean;
     useUnionTypes?: boolean;
+    exposeHeadersAndBody?: boolean;
     exportCore?: boolean;
     exportServices?: boolean;
     exportModels?: 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 exposeHeadersAndBody Return response headers and body (default is body only)
  * @param exportCore Generate core client classes
  * @param exportServices Generate services
  * @param exportModels Generate models
@@ -55,6 +57,7 @@ export const generate = async ({
     clientName,
     useOptions = false,
     useUnionTypes = false,
+    exposeHeadersAndBody = false,
     exportCore = true,
     exportServices = true,
     exportModels = true,
@@ -84,6 +87,7 @@ export const generate = async ({
                 httpClient,
                 useOptions,
                 useUnionTypes,
+                exposeHeadersAndBody,
                 exportCore,
                 exportServices,
                 exportModels,
@@ -107,6 +111,7 @@ export const generate = async ({
                 httpClient,
                 useOptions,
                 useUnionTypes,
+                exposeHeadersAndBody,
                 exportCore,
                 exportServices,
                 exportModels,
diff --git a/src/templates/core/BaseHttpRequest.hbs b/src/templates/core/BaseHttpRequest.hbs
@@ -28,7 +28,11 @@ export class BaseHttpRequest {
 		throw new Error('Not Implemented');
 	}
 	{{else}}
+	{{#if @root.exposeHeadersAndBody}}
+	public request<T>(options: ApiRequestOptions): CancelablePromise<{ headers: Record<string, string>; body: T; }> {
+	{{else}}
 	public request<T>(options: ApiRequestOptions): CancelablePromise<T> {
+	{{/if}}
 		throw new Error('Not Implemented');
 	}
 	{{/equals}}
diff --git a/src/templates/core/HttpRequest.hbs b/src/templates/core/HttpRequest.hbs
@@ -51,10 +51,18 @@ export class {{httpRequest}} extends BaseHttpRequest {
 	/**
 	 * Request method
 	 * @param options The request options from the service
+	 {{#if @root.exposeHeadersAndBody}}
+	 * @returns CancelablePromise<{ headers: Record<string, string>; body: T; }>
+	 {{else}}
 	 * @returns CancelablePromise<T>
+	 {{/if}}
 	 * @throws ApiError
 	 */
+	{{#if @root.exposeHeadersAndBody}}
+	public override request<T>(options: ApiRequestOptions): CancelablePromise<{ headers: Record<string, string>; body: T; }> {
+	{{else}} 
 	public override request<T>(options: ApiRequestOptions): CancelablePromise<T> {
+	{{/if}}
 		return __request(this.config, options);
 	}
 	{{/equals}}
diff --git a/src/templates/core/fetch/request.hbs b/src/templates/core/fetch/request.hbs
@@ -59,10 +59,21 @@ import type { OpenAPIConfig } from './OpenAPI';
  * Request method
  * @param config The OpenAPI configuration object
  * @param options The request options from the service
+ {{#if @root.exposeHeadersAndBody}}
+ * @returns CancelablePromise<{ headers: Record<string, string>; body: T; }>
+ {{else}}
  * @returns CancelablePromise<T>
+ {{/if}}
  * @throws ApiError
  */
+{{#if @root.exposeHeadersAndBody}}
+export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions): CancelablePromise<{
+	headers: Record<string, string>;
+	body: T;
+}> => {
+{{else}}
 export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions): CancelablePromise<T> => {
+{{/if}}
 	return new CancelablePromise(async (resolve, reject, onCancel) => {
 		try {
 			const url = getUrl(config, options);
@@ -73,19 +84,34 @@ export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions): C
 			if (!onCancel.isCancelled) {
 				const response = await sendRequest(config, options, url, body, formData, headers, onCancel);
 				const responseBody = await getResponseBody(response);
+				{{#if @root.exposeHeadersAndBody}}
+				const responseHeaders: Record<string, string> = {};
+				for (const header of Array.from(response.headers.keys())) {
+					responseHeaders[header] = response.headers.get(header) ?? '';
+				}
+				{{else}}
 				const responseHeader = getResponseHeader(response, options.responseHeader);
+				{{/if}}
 
 				const result: ApiResult = {
 					url,
 					ok: response.ok,
 					status: response.status,
 					statusText: response.statusText,
+					{{#if @root.exposeHeadersAndBody}}
+					body: responseBody,
+					{{else}}
 					body: responseHeader ?? responseBody,
+					{{/if}}
 				};
 
 				catchErrorCodes(options, result);
 
+        {{#if @root.exposeHeadersAndBody}}
+				resolve({ headers: responseHeaders, body: result.body });
+				{{else}}
 				resolve(result.body);
+				{{/if}}
 			}
 		} catch (error) {
 			reject(error);
diff --git a/src/templates/core/node/request.hbs b/src/templates/core/node/request.hbs
@@ -63,10 +63,21 @@ import type { OpenAPIConfig } from './OpenAPI';
  * Request method
  * @param config The OpenAPI configuration object
  * @param options The request options from the service
+ {{#if @root.exposeHeadersAndBody}}
+ * @returns CancelablePromise<{ headers: Record<string, string>; body: T; }>
+ {{else}}
  * @returns CancelablePromise<T>
+ {{/if}}
  * @throws ApiError
  */
+{{#if @root.exposeHeadersAndBody}}
+export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions): CancelablePromise<{
+	headers: Record<string, string>;
+	body: T;
+}> => {
+{{else}}
 export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions): CancelablePromise<T> => {
+{{/if}}
 	return new CancelablePromise(async (resolve, reject, onCancel) => {
 		try {
 			const url = getUrl(config, options);
@@ -77,19 +88,34 @@ export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions): C
 			if (!onCancel.isCancelled) {
 				const response = await sendRequest(options, url, body, formData, headers, onCancel);
 				const responseBody = await getResponseBody(response);
+				{{#if @root.exposeHeadersAndBody}}
+				const responseHeaders: Record<string, string> = {};
+				for (const header of Array.from(response.headers.keys())) {
+					responseHeaders[header] = response.headers.get(header) ?? '';
+				}
+				{{else}}
 				const responseHeader = getResponseHeader(response, options.responseHeader);
+				{{/if}}
 
 				const result: ApiResult = {
 					url,
 					ok: response.ok,
 					status: response.status,
 					statusText: response.statusText,
+					{{#if @root.exposeHeadersAndBody}}
+					body: responseBody,
+					{{else}}
 					body: responseHeader ?? responseBody,
+					{{/if}}
 				};
 
 				catchErrorCodes(options, result);
 
+        {{#if @root.exposeHeadersAndBody}}
+				resolve({ headers: responseHeaders, body: result.body });
+				{{else}}
 				resolve(result.body);
+				{{/if}}
 			}
 		} catch (error) {
 			reject(error);
diff --git a/src/templates/core/xhr/request.hbs b/src/templates/core/xhr/request.hbs
@@ -62,10 +62,21 @@ import type { OpenAPIConfig } from './OpenAPI';
  * Request method
  * @param config The OpenAPI configuration object
  * @param options The request options from the service
+ {{#if @root.exposeHeadersAndBody}}
+ * @returns CancelablePromise<{ headers: Record<string, string>; body: T; }>
+ {{else}}
  * @returns CancelablePromise<T>
+ {{/if}}
  * @throws ApiError
  */
+{{#if @root.exposeHeadersAndBody}}
+export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions): CancelablePromise<{
+	headers: Record<string, string>;
+	body: T;
+}> => {
+{{else}}
 export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions): CancelablePromise<T> => {
+{{/if}}
 	return new CancelablePromise(async (resolve, reject, onCancel) => {
 		try {
 			const url = getUrl(config, options);
@@ -76,19 +87,36 @@ export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions): C
 			if (!onCancel.isCancelled) {
 				const response = await sendRequest(config, options, url, body, formData, headers, onCancel);
 				const responseBody = getResponseBody(response);
+				{{#if @root.exposeHeadersAndBody}}
+				const responseHeaders: Record<string, string> = {};
+				const allResponseHeaders = response.getAllResponseHeaders() ?? '';
+				allResponseHeaders.split(/[\r\n]+/).forEach(line => {
+					const nv = line.split(': ', 2);
+					responseHeaders[nv[0]] = nv[1];
+				});
+				{{else}}
 				const responseHeader = getResponseHeader(response, options.responseHeader);
+				{{/if}}
 
 				const result: ApiResult = {
 					url,
 					ok: isSuccess(response.status),
 					status: response.status,
 					statusText: response.statusText,
+					{{#if @root.exposeHeadersAndBody}}
+					body: responseBody,
+					{{else}}
 					body: responseHeader ?? responseBody,
+					{{/if}}
 				};
 
 				catchErrorCodes(options, result);
 
+        {{#if @root.exposeHeadersAndBody}}
+				resolve({ headers: responseHeaders, body: result.body });
+				{{else}}
 				resolve(result.body);
+				{{/if}}
 			}
 		} catch (error) {
 			reject(error);
diff --git a/src/templates/exportService.hbs b/src/templates/exportService.hbs
@@ -73,15 +73,23 @@ export class {{{name}}}{{{@root.postfix}}} {
 	public {{{name}}}({{>parameters}}): Observable<{{>result}}> {
 		return this.httpRequest.request({
 	{{else}}
+  {{#if @root.exposeHeadersAndBody}}
+	public {{{name}}}({{>parameters}}): CancelablePromise<{ headers: Record<string, string>; body: {{>result}}; }> {
+	{{else}}
 	public {{{name}}}({{>parameters}}): CancelablePromise<{{>result}}> {
+	{{/if}}
 		return this.httpRequest.request({
 	{{/equals}}
 	{{else}}
 	{{#equals @root.httpClient 'angular'}}
 	public {{{name}}}({{>parameters}}): Observable<{{>result}}> {
 		return __request(OpenAPI, this.http, {
 	{{else}}
+	{{#if @root.exposeHeadersAndBody}}
+	public static {{{name}}}({{>parameters}}): CancelablePromise<{ headers: Record<string, string>; body: {{>result}}; }> {
+	{{else}}
 	public static {{{name}}}({{>parameters}}): CancelablePromise<{{>result}}> {
+	{{/if}}
 		return __request(OpenAPI, {
 	{{/equals}}
 	{{/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
@@ -22,6 +22,7 @@ import { writeClientServices } from './writeClientServices';
  * @param httpClient The selected httpClient (fetch, xhr, node or axios)
  * @param useOptions Use options or arguments functions
  * @param useUnionTypes Use union types instead of enums
+ * @param exposeHeadersAndBody Return response headers and body (default is body only)
  * @param exportCore Generate core client classes
  * @param exportServices Generate services
  * @param exportModels Generate models
@@ -39,6 +40,7 @@ export const writeClient = async (
     httpClient: HttpClient,
     useOptions: boolean,
     useUnionTypes: boolean,
+    exposeHeadersAndBody: boolean,
     exportCore: boolean,
     exportServices: boolean,
     exportModels: boolean,
@@ -61,7 +63,7 @@ export const writeClient = async (
     if (exportCore) {
         await rmdir(outputPathCore);
         await mkdir(outputPathCore);
-        await writeClientCore(client, templates, outputPathCore, httpClient, indent, clientName, request);
+        await writeClientCore(client, templates, outputPathCore, httpClient, exposeHeadersAndBody, indent, clientName, request);
     }
 
     if (exportServices) {
@@ -74,6 +76,7 @@ export const writeClient = async (
             httpClient,
             useUnionTypes,
             useOptions,
+            exposeHeadersAndBody,
             indent,
             postfix,
             clientName
diff --git a/src/utils/writeClientCore.spec.ts b/src/utils/writeClientCore.spec.ts
@@ -36,7 +36,7 @@ describe('writeClientCore', () => {
             },
         };
 
-        await writeClientCore(client, templates, '/', HttpClient.FETCH, Indent.SPACE_4);
+        await writeClientCore(client, templates, '/', HttpClient.FETCH, false, Indent.SPACE_4);
 
         expect(writeFile).toBeCalledWith('/OpenAPI.ts', 'settings');
         expect(writeFile).toBeCalledWith('/ApiError.ts', 'apiError');
diff --git a/src/utils/writeClientCore.ts b/src/utils/writeClientCore.ts
@@ -15,6 +15,7 @@ import type { Templates } from './registerHandlebarTemplates';
  * @param templates The loaded handlebar templates
  * @param outputPath Directory to write the generated files to
  * @param httpClient The selected httpClient (fetch, xhr, node or axios)
+ * @param exposeHeadersAndBody Return response headers and body (default is body only)
  * @param indent Indentation options (4, 2 or tab)
  * @param clientName Custom client class name
  * @param request Path to custom request file
@@ -24,6 +25,7 @@ export const writeClientCore = async (
     templates: Templates,
     outputPath: string,
     httpClient: HttpClient,
+    exposeHeadersAndBody: boolean,
     indent: Indent,
     clientName?: string,
     request?: string
@@ -33,6 +35,7 @@ export const writeClientCore = async (
         httpClient,
         clientName,
         httpRequest,
+        exposeHeadersAndBody,
         server: client.server,
         version: client.version,
     };
diff --git a/src/utils/writeClientServices.spec.ts b/src/utils/writeClientServices.spec.ts
@@ -37,7 +37,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');
     });
diff --git a/src/utils/writeClientServices.ts b/src/utils/writeClientServices.ts
@@ -17,6 +17,7 @@ import type { Templates } from './registerHandlebarTemplates';
  * @param httpClient The selected httpClient (fetch, xhr, node or axios)
  * @param useUnionTypes Use union types instead of enums
  * @param useOptions Use options or arguments functions
+ * @param exposeHeadersAndBody Return response headers and body (default is body only)
  * @param indent Indentation options (4, 2 or tab)
  * @param postfix Service name postfix
  * @param clientName Custom client class name
@@ -28,6 +29,7 @@ export const writeClientServices = async (
     httpClient: HttpClient,
     useUnionTypes: boolean,
     useOptions: boolean,
+    exposeHeadersAndBody: boolean,
     indent: Indent,
     postfix: string,
     clientName?: string
@@ -39,6 +41,7 @@ export const writeClientServices = async (
             httpClient,
             useUnionTypes,
             useOptions,
+            exposeHeadersAndBody,
             postfix,
             exportClient: isDefined(clientName),
         });

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,11 @@ export class BaseHttpRequest {`
`28`	`28`	`throw new Error('Not Implemented');`
`29`	`29`	`}`
`30`	`30`	`{{else}}`
	`31`	`+ {{#if @root.exposeHeadersAndBody}}`
	`32`	`+ public request<T>(options: ApiRequestOptions): CancelablePromise<{ headers: Record<string, string>; body: T; }> {`
	`33`	`+ {{else}}`
`31`	`34`	`public request<T>(options: ApiRequestOptions): CancelablePromise<T> {`
	`35`	`+ {{/if}}`
`32`	`36`	`throw new Error('Not Implemented');`
`33`	`37`	`}`
`34`	`38`	`{{/equals}}`
-Original file line number
+Diff line change
             HttpClient.FETCH,
             false,
             false,
 +            false,
             true,
             true,
             true,