refactor(types): allow passing config

hey-api · Mar 4, 2024 · 07e0240 · 07e0240
1 parent d5e382c
commit 07e0240
Show file tree

Hide file tree

Showing 17 changed files with 898 additions and 236 deletions.
diff --git a/src/templates/core/ApiResult.hbs b/src/templates/core/ApiResult.hbs
@@ -1,9 +1,9 @@
 {{>header}}
 
-export type ApiResult = {
-	readonly url: string;
+export type ApiResult<TData = any> = {
+	readonly body: TData;
 	readonly ok: boolean;
 	readonly status: number;
 	readonly statusText: string;
-	readonly body: any;
+	readonly url: string;
 };
diff --git a/src/templates/core/types.hbs b/src/templates/core/types.hbs
@@ -0,0 +1,14 @@
+{{>header}}
+
+import type { ApiResult } from './ApiResult';
+
+export type TResult = 'body' | 'raw';
+
+export type TApiResponse<T extends TResult, TData> =
+  Exclude<T, 'raw'> extends never
+    ? ApiResult<TData>
+    : ApiResult<TData>['body'];
+
+export type TConfig<T extends TResult> = {
+  _result?: T;
+};
diff --git a/src/templates/exportService.hbs b/src/templates/exportService.hbs
@@ -29,6 +29,9 @@ import type { BaseHttpRequest } from '../core/BaseHttpRequest';
 {{else}}
 import { OpenAPI } from '../core/OpenAPI';
 import { request as __request } from '../core/request';
+{{#if @root.useOptions}}
+import type { TApiResponse, TConfig, TResult } from '../core/types';
+{{/if}}
 {{/if}}
 
 {{#if @root.useOptions}}
@@ -84,21 +87,21 @@ export class {{{name}}}{{{@root.postfix}}} {
 	 */
 	{{#if @root.exportClient}}
 	{{#equals @root.httpClient 'angular'}}
-	public {{{name}}}({{>parameters}}): Observable<{{>result}}> {
+	public {{{name}}}{{>operationTypes}}({{>operationParameters}}): Observable<{{>operationResult}}> {
 		{{>destructureData}}
 		return this.httpRequest.request({
 	{{else}}
-	public {{{name}}}({{>parameters}}): CancelablePromise<{{>result}}> {
+	public {{{name}}}{{>operationTypes}}({{>operationParameters}}): CancelablePromise<{{>operationResult}}> {
 		{{>destructureData}}
 		return this.httpRequest.request({
 	{{/equals}}
 	{{else}}
 	{{#equals @root.httpClient 'angular'}}
-	public {{{name}}}({{>parameters}}): Observable<{{>result}}> {
+	public {{{name}}}{{>operationTypes}}({{>operationParameters}}): Observable<{{>operationResult}}> {
 		{{>destructureData}}
 		return __request(OpenAPI, this.http, {
 	{{else}}
-	public static {{{name}}}({{>parameters}}): CancelablePromise<{{>result}}> {
+	public static {{{name}}}{{>operationTypes}}({{>operationParameters}}): CancelablePromise<{{>operationResult}}> {
 		{{>destructureData}}
 		return __request(OpenAPI, {
 	{{/equals}}

diff --git a/src/templates/partials/parameters.hbs → ...emplates/partials/operationParameters.hbs b/src/templates/partials/parameters.hbs → ...emplates/partials/operationParameters.hbs
@@ -1,7 +1,7 @@
-{{#if parameters}}
 {{#if @root.useOptions~}}
-data: {{{nameOperationDataType name}}}{{#ifOperationDataOptional parameters}} = {}{{/ifOperationDataOptional}}
+data: {{#if parameters}}{{{nameOperationDataType name}}} & {{/if}}TConfig<T>{{#ifOperationDataOptional parameters}} = {}{{/ifOperationDataOptional}}
 {{~else}}
+{{#if parameters}}
 
 {{#each parameters}}
 {{{name}}}{{>isRequired}}: {{>type}}{{#if default}} = {{{default}}}{{/if}},

diff --git a/src/templates/partials/result.hbs → src/templates/partials/operationResult.hbs b/src/templates/partials/result.hbs → src/templates/partials/operationResult.hbs
@@ -1,5 +1,10 @@
+{{~#if @root.useOptions~}}
+TApiResponse<T, {{/if~}}
 {{~#if results~}}
 {{#each results}}{{>type}}{{#unless @last}} | {{/unless}}{{/each}}
 {{~else~}}
 void
 {{~/if~}}
+{{~#if @root.useOptions~}}
+>
+{{~/if~}}
diff --git a/src/templates/partials/operationTypes.hbs b/src/templates/partials/operationTypes.hbs
@@ -0,0 +1,3 @@
+{{#if @root.useOptions~}}
+<T extends TResult>
+{{~/if}}
diff --git a/src/utils/registerHandlebarTemplates.ts b/src/utils/registerHandlebarTemplates.ts
@@ -45,6 +45,7 @@ import nodeRequest from '../templates/core/node/request.hbs';
 import nodeSendRequest from '../templates/core/node/sendRequest.hbs';
 import templateCoreSettings from '../templates/core/OpenAPI.hbs';
 import templateCoreRequest from '../templates/core/request.hbs';
+import templateCoreTypes from '../templates/core/types.hbs';
 import xhrGetHeaders from '../templates/core/xhr/getHeaders.hbs';
 import xhrGetRequestBody from '../templates/core/xhr/getRequestBody.hbs';
 import xhrGetResponseBody from '../templates/core/xhr/getResponseBody.hbs';
@@ -65,8 +66,9 @@ import partialHeader from '../templates/partials/header.hbs';
 import partialIsNullable from '../templates/partials/isNullable.hbs';
 import partialIsReadOnly from '../templates/partials/isReadOnly.hbs';
 import partialIsRequired from '../templates/partials/isRequired.hbs';
-import partialParameters from '../templates/partials/parameters.hbs';
-import partialResult from '../templates/partials/result.hbs';
+import partialOperationParameters from '../templates/partials/operationParameters.hbs';
+import partialOperationResult from '../templates/partials/operationResult.hbs';
+import partialOperationTypes from '../templates/partials/operationTypes.hbs';
 import partialSchema from '../templates/partials/schema.hbs';
 import partialSchemaArray from '../templates/partials/schemaArray.hbs';
 import partialSchemaComposition from '../templates/partials/schemaComposition.hbs';
@@ -96,6 +98,7 @@ export interface Templates {
         httpRequest: Handlebars.TemplateDelegate;
         request: Handlebars.TemplateDelegate;
         settings: Handlebars.TemplateDelegate;
+        types: Handlebars.TemplateDelegate;
     };
     exports: {
         model: Handlebars.TemplateDelegate;
@@ -126,6 +129,7 @@ export const registerHandlebarTemplates = (
             httpRequest: Handlebars.template(templateCoreHttpRequest),
             request: Handlebars.template(templateCoreRequest),
             settings: Handlebars.template(templateCoreSettings),
+            types: Handlebars.template(templateCoreTypes),
         },
         exports: {
             model: Handlebars.template(templateExportModel),
@@ -146,8 +150,9 @@ export const registerHandlebarTemplates = (
     Handlebars.registerPartial('isNullable', Handlebars.template(partialIsNullable));
     Handlebars.registerPartial('isReadOnly', Handlebars.template(partialIsReadOnly));
     Handlebars.registerPartial('isRequired', Handlebars.template(partialIsRequired));
-    Handlebars.registerPartial('parameters', Handlebars.template(partialParameters));
-    Handlebars.registerPartial('result', Handlebars.template(partialResult));
+    Handlebars.registerPartial('operationParameters', Handlebars.template(partialOperationParameters));
+    Handlebars.registerPartial('operationResult', Handlebars.template(partialOperationResult));
+    Handlebars.registerPartial('operationTypes', Handlebars.template(partialOperationTypes));
     Handlebars.registerPartial('schema', Handlebars.template(partialSchema));
     Handlebars.registerPartial('schemaArray', Handlebars.template(partialSchemaArray));
     Handlebars.registerPartial('schemaComposition', Handlebars.template(partialSchemaComposition));

diff --git a/src/utils/writeClient.spec.ts b/src/utils/writeClient.spec.ts
@@ -17,23 +17,24 @@ describe('writeClient', () => {
         };
 
         const templates: Templates = {
-            index: () => 'index',
             client: () => 'client',
-            exports: {
-                model: () => 'model',
-                schema: () => 'schema',
-                service: () => 'service',
-            },
             core: {
-                settings: () => 'settings',
                 apiError: () => 'apiError',
                 apiRequestOptions: () => 'apiRequestOptions',
                 apiResult: () => 'apiResult',
-                cancelablePromise: () => 'cancelablePromise',
-                request: () => 'request',
                 baseHttpRequest: () => 'baseHttpRequest',
+                cancelablePromise: () => 'cancelablePromise',
                 httpRequest: () => 'httpRequest',
+                request: () => 'request',
+                settings: () => 'settings',
+                types: () => 'types',
             },
+            exports: {
+                model: () => 'model',
+                schema: () => 'schema',
+                service: () => 'service',
+            },
+            index: () => 'index',
         };
 
         await writeClient(client, templates, {

diff --git a/src/utils/writeClientClass.spec.ts b/src/utils/writeClientClass.spec.ts
@@ -17,23 +17,24 @@ describe('writeClientClass', () => {
         };
 
         const templates: Templates = {
-            index: () => 'index',
             client: () => 'client',
-            exports: {
-                model: () => 'model',
-                schema: () => 'schema',
-                service: () => 'service',
-            },
             core: {
-                settings: () => 'settings',
                 apiError: () => 'apiError',
                 apiRequestOptions: () => 'apiRequestOptions',
                 apiResult: () => 'apiResult',
-                cancelablePromise: () => 'cancelablePromise',
-                request: () => 'request',
                 baseHttpRequest: () => 'baseHttpRequest',
+                cancelablePromise: () => 'cancelablePromise',
                 httpRequest: () => 'httpRequest',
+                request: () => 'request',
+                settings: () => 'settings',
+                types: () => 'types',
             },
+            exports: {
+                model: () => 'model',
+                schema: () => 'schema',
+                service: () => 'service',
+            },
+            index: () => 'index',
         };
 
         await writeClientClass(client, templates, './dist', HttpClient.FETCH, 'AppClient', Indent.SPACE_4, '');

diff --git a/src/utils/writeClientCore.spec.ts b/src/utils/writeClientCore.spec.ts
@@ -20,23 +20,24 @@ describe('writeClientCore', () => {
         };
 
         const templates: Templates = {
-            index: () => 'index',
             client: () => 'client',
-            exports: {
-                model: () => 'model',
-                schema: () => 'schema',
-                service: () => 'service',
-            },
             core: {
-                settings: () => 'settings',
                 apiError: () => 'apiError',
                 apiRequestOptions: () => 'apiRequestOptions',
                 apiResult: () => 'apiResult',
-                cancelablePromise: () => 'cancelablePromise',
-                request: () => 'request',
                 baseHttpRequest: () => 'baseHttpRequest',
+                cancelablePromise: () => 'cancelablePromise',
                 httpRequest: () => 'httpRequest',
+                request: () => 'request',
+                settings: () => 'settings',
+                types: () => 'types',
             },
+            exports: {
+                model: () => 'model',
+                schema: () => 'schema',
+                service: () => 'service',
+            },
+            index: () => 'index',
         };
 
         await writeClientCore(client, templates, '/', HttpClient.FETCH, Indent.SPACE_4);
@@ -47,5 +48,6 @@ describe('writeClientCore', () => {
         expect(writeFile).toBeCalledWith(resolve('/', '/ApiResult.ts'), `apiResult${EOL}`);
         expect(writeFile).toBeCalledWith(resolve('/', '/CancelablePromise.ts'), `cancelablePromise${EOL}`);
         expect(writeFile).toBeCalledWith(resolve('/', '/request.ts'), `request${EOL}`);
+        expect(writeFile).toBeCalledWith(resolve('/', '/types.ts'), `types${EOL}`);
     });
 });
diff --git a/src/utils/writeClientCore.ts b/src/utils/writeClientCore.ts
@@ -48,6 +48,7 @@ export const writeClientCore = async (
         i(templates.core.cancelablePromise(context), indent)
     );
     await writeFile(Path.resolve(outputPath, 'request.ts'), i(templates.core.request(context), indent));
+    await writeFile(Path.resolve(outputPath, 'types.ts'), i(templates.core.types(context), indent));
 
     if (Boolean(clientName)) {
         await writeFile(

diff --git a/src/utils/writeClientIndex.spec.ts b/src/utils/writeClientIndex.spec.ts
@@ -17,23 +17,24 @@ describe('writeClientIndex', () => {
         };
 
         const templates: Templates = {
-            index: () => 'index',
             client: () => 'client',
-            exports: {
-                model: () => 'model',
-                schema: () => 'schema',
-                service: () => 'service',
-            },
             core: {
-                settings: () => 'settings',
                 apiError: () => 'apiError',
                 apiRequestOptions: () => 'apiRequestOptions',
                 apiResult: () => 'apiResult',
-                cancelablePromise: () => 'cancelablePromise',
-                request: () => 'request',
                 baseHttpRequest: () => 'baseHttpRequest',
+                cancelablePromise: () => 'cancelablePromise',
                 httpRequest: () => 'httpRequest',
+                request: () => 'request',
+                settings: () => 'settings',
+                types: () => 'types',
             },
+            exports: {
+                model: () => 'model',
+                schema: () => 'schema',
+                service: () => 'service',
+            },
+            index: () => 'index',
         };
 
         await writeClientIndex(client, templates, '/', true, true, true, true, true, 'Service', '');

diff --git a/src/utils/writeClientModels.spec.ts b/src/utils/writeClientModels.spec.ts
@@ -33,23 +33,24 @@ describe('writeClientModels', () => {
         ];
 
         const templates: Templates = {
-            index: () => 'index',
             client: () => 'client',
-            exports: {
-                model: () => 'model',
-                schema: () => 'schema',
-                service: () => 'service',
-            },
             core: {
-                settings: () => 'settings',
                 apiError: () => 'apiError',
                 apiRequestOptions: () => 'apiRequestOptions',
                 apiResult: () => 'apiResult',
-                cancelablePromise: () => 'cancelablePromise',
-                request: () => 'request',
                 baseHttpRequest: () => 'baseHttpRequest',
+                cancelablePromise: () => 'cancelablePromise',
                 httpRequest: () => 'httpRequest',
+                request: () => 'request',
+                settings: () => 'settings',
+                types: () => 'types',
             },
+            exports: {
+                model: () => 'model',
+                schema: () => 'schema',
+                service: () => 'service',
+            },
+            index: () => 'index',
         };
 
         await writeClientModels(models, templates, '/', {

diff --git a/src/utils/writeClientSchemas.spec.ts b/src/utils/writeClientSchemas.spec.ts
@@ -33,23 +33,24 @@ describe('writeClientSchemas', () => {
         ];
 
         const templates: Templates = {
-            index: () => 'index',
             client: () => 'client',
-            exports: {
-                model: () => 'model',
-                schema: () => 'schema',
-                service: () => 'service',
-            },
             core: {
-                settings: () => 'settings',
                 apiError: () => 'apiError',
                 apiRequestOptions: () => 'apiRequestOptions',
                 apiResult: () => 'apiResult',
-                cancelablePromise: () => 'cancelablePromise',
-                request: () => 'request',
                 baseHttpRequest: () => 'baseHttpRequest',
+                cancelablePromise: () => 'cancelablePromise',
                 httpRequest: () => 'httpRequest',
+                request: () => 'request',
+                settings: () => 'settings',
+                types: () => 'types',
             },
+            exports: {
+                model: () => 'model',
+                schema: () => 'schema',
+                service: () => 'service',
+            },
+            index: () => 'index',
         };
 
         await writeClientSchemas(models, templates, '/', HttpClient.FETCH, false, Indent.SPACE_4);

diff --git a/src/utils/writeClientServices.spec.ts b/src/utils/writeClientServices.spec.ts
@@ -21,23 +21,24 @@ describe('writeClientServices', () => {
         ];
 
         const templates: Templates = {
-            index: () => 'index',
             client: () => 'client',
-            exports: {
-                model: () => 'model',
-                schema: () => 'schema',
-                service: () => 'service',
-            },
             core: {
-                settings: () => 'settings',
                 apiError: () => 'apiError',
                 apiRequestOptions: () => 'apiRequestOptions',
                 apiResult: () => 'apiResult',
-                cancelablePromise: () => 'cancelablePromise',
-                request: () => 'request',
                 baseHttpRequest: () => 'baseHttpRequest',
+                cancelablePromise: () => 'cancelablePromise',
                 httpRequest: () => 'httpRequest',
+                request: () => 'request',
+                settings: () => 'settings',
+                types: () => 'types',
             },
+            exports: {
+                model: () => 'model',
+                schema: () => 'schema',
+                service: () => 'service',
+            },
+            index: () => 'index',
         };
 
         await writeClientServices(services, templates, '/', {