Merge pull request #35 from nicolas-chaulet/feat/response-headers-3

fix(request): support returning raw result object
hey-api · Mar 4, 2024 · 5e37208 · 5e37208
2 parents 9bf43e2 + 1322362
commit 5e37208
Show file tree

Hide file tree

Showing 20 changed files with 547 additions and 57 deletions.
diff --git a/src/templates/core/OpenAPI.hbs b/src/templates/core/OpenAPI.hbs
@@ -1,30 +1,47 @@
 {{>header}}
 
 import type { ApiRequestOptions } from './ApiRequestOptions';
+import type { TConfig, TResult } from './types';
 
 type Resolver<T> = (options: ApiRequestOptions) => Promise<T>;
 type Headers = Record<string, string>;
 
 export type OpenAPIConfig = {
 	BASE: string;
-	VERSION: string;
-	WITH_CREDENTIALS: boolean;
 	CREDENTIALS: 'include' | 'omit' | 'same-origin';
+	ENCODE_PATH?: ((path: string) => string) | undefined;
+	HEADERS?: Headers | Resolver<Headers> | undefined;
+	PASSWORD?: string | Resolver<string> | undefined;
+	RESULT?: TResult;
 	TOKEN?: string | Resolver<string> | undefined;
 	USERNAME?: string | Resolver<string> | undefined;
-	PASSWORD?: string | Resolver<string> | undefined;
-	HEADERS?: Headers | Resolver<Headers> | undefined;
-	ENCODE_PATH?: ((path: string) => string) | undefined;
+	VERSION: string;
+	WITH_CREDENTIALS: boolean;
 };
 
 export const OpenAPI: OpenAPIConfig = {
 	BASE: '{{{server}}}',
-	VERSION: '{{{version}}}',
-	WITH_CREDENTIALS: false,
 	CREDENTIALS: 'include',
+	ENCODE_PATH: undefined,
+	HEADERS: undefined,
+	PASSWORD: undefined,
+	RESULT: 'body',
 	TOKEN: undefined,
 	USERNAME: undefined,
-	PASSWORD: undefined,
-	HEADERS: undefined,
-	ENCODE_PATH: undefined,
+	VERSION: '{{{version}}}',
+	WITH_CREDENTIALS: false,
+};
+
+export const mergeOpenApiConfig = <T extends TResult>(config: OpenAPIConfig, overrides: TConfig<T>) => {
+	const merged = { ...config };
+	Object.entries(overrides)
+		.filter(([key]) => key.startsWith('_'))
+		.forEach(([key, value]) => {
+			const k = key.slice(1).toLocaleUpperCase() as keyof typeof merged;
+			if (merged.hasOwnProperty(k)) {
+				// @ts-ignore
+				merged[k] = value;
+			}
+		});
+	return merged;
 };
diff --git a/src/templates/core/axios/request.hbs b/src/templates/core/axios/request.hbs
@@ -90,7 +90,7 @@ export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions, ax
 
 				catchErrorCodes(options, result);
 
-				resolve(result.body);
+				resolve(config.RESULT === 'raw' ? result : result.body);
 			}
 		} catch (error) {
 			reject(error);

diff --git a/src/templates/core/fetch/request.hbs b/src/templates/core/fetch/request.hbs
@@ -82,7 +82,7 @@ export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions): C
 
 				catchErrorCodes(options, result);
 
-				resolve(result.body);
+				resolve(config.RESULT === 'raw' ? result : result.body);
 			}
 		} catch (error) {
 			reject(error);

diff --git a/src/templates/core/node/request.hbs b/src/templates/core/node/request.hbs
@@ -87,7 +87,7 @@ export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions): C
 
 				catchErrorCodes(options, result);
 
-				resolve(result.body);
+				resolve(config.RESULT === 'raw' ? result : result.body);
 			}
 		} catch (error) {
 			reject(error);

diff --git a/src/templates/core/xhr/request.hbs b/src/templates/core/xhr/request.hbs
@@ -85,7 +85,7 @@ export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions): C
 
 				catchErrorCodes(options, result);
 
-				resolve(result.body);
+				resolve(config.RESULT === 'raw' ? result : result.body);
 			}
 		} catch (error) {
 			reject(error);

diff --git a/src/templates/exportService.hbs b/src/templates/exportService.hbs
@@ -27,10 +27,13 @@ import { BaseHttpRequest } from '../core/BaseHttpRequest';
 import type { BaseHttpRequest } from '../core/BaseHttpRequest';
 {{/equals}}
 {{else}}
-import { OpenAPI } from '../core/OpenAPI';
-import { request as __request } from '../core/request';
 {{#if @root.useOptions}}
+import { mergeOpenApiConfig, OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
 import type { TApiResponse, TConfig, TResult } from '../core/types';
+{{else}}
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
 {{/if}}
 {{/if}}
 
@@ -99,11 +102,11 @@ export class {{{name}}}{{{@root.postfix}}} {
 	{{#equals @root.httpClient 'angular'}}
 	public {{{name}}}{{>operationTypes}}({{>operationParameters}}): Observable<{{>operationResult}}> {
 		{{>destructureData}}
-		return __request(OpenAPI, this.http, {
+		return __request({{>requestConfig}}, this.http, {
 	{{else}}
 	public static {{{name}}}{{>operationTypes}}({{>operationParameters}}): CancelablePromise<{{>operationResult}}> {
 		{{>destructureData}}
-		return __request(OpenAPI, {
+		return __request({{>requestConfig}}, {
 	{{/equals}}
 	{{/if}}
 			method: '{{{method}}}',

diff --git a/src/templates/partials/destructureData.hbs b/src/templates/partials/destructureData.hbs
@@ -1,9 +1,8 @@
-{{#if parameters}}
 {{#if @root.useOptions~}}
 const {
 {{#each parameters}}
 {{{name}}}{{#if default}} = {{{default}}}{{/if}},
 {{/each}}
+    ...overrides
 } = data;
 {{/if}}
-{{/if}}
diff --git a/src/templates/partials/requestConfig.hbs b/src/templates/partials/requestConfig.hbs
@@ -0,0 +1,5 @@
+{{~#if @root.useOptions~}}
+mergeOpenApiConfig(OpenAPI, overrides)
+{{~else~}}
+OpenAPI
+{{~/if~}}
diff --git a/src/utils/registerHandlebarTemplates.ts b/src/utils/registerHandlebarTemplates.ts
@@ -69,6 +69,7 @@ import partialIsRequired from '../templates/partials/isRequired.hbs';
 import partialOperationParameters from '../templates/partials/operationParameters.hbs';
 import partialOperationResult from '../templates/partials/operationResult.hbs';
 import partialOperationTypes from '../templates/partials/operationTypes.hbs';
+import partialRequestConfig from '../templates/partials/requestConfig.hbs';
 import partialSchema from '../templates/partials/schema.hbs';
 import partialSchemaArray from '../templates/partials/schemaArray.hbs';
 import partialSchemaComposition from '../templates/partials/schemaComposition.hbs';
@@ -153,6 +154,7 @@ export const registerHandlebarTemplates = (
     Handlebars.registerPartial('operationParameters', Handlebars.template(partialOperationParameters));
     Handlebars.registerPartial('operationResult', Handlebars.template(partialOperationResult));
     Handlebars.registerPartial('operationTypes', Handlebars.template(partialOperationTypes));
+    Handlebars.registerPartial('requestConfig', Handlebars.template(partialRequestConfig));
     Handlebars.registerPartial('schema', Handlebars.template(partialSchema));
     Handlebars.registerPartial('schemaArray', Handlebars.template(partialSchemaArray));
     Handlebars.registerPartial('schemaComposition', Handlebars.template(partialSchemaComposition));