Merge pull request #215 from hey-api/feat/all-services-in-one-file

.changeset/blue-flies-behave.md

@@ -0,0 +1,5 @@
+---
+"@hey-api/openapi-ts": minor
+---
+
+feat(client): generate all services in single `services.ts` file

rollup.config.ts

@@ -45,7 +45,6 @@ export function handlebarsPlugin(): Plugin {
                         ifNotNullNotUndefined: true,
                         ifOperationDataOptional: true,
                         intersection: true,
-                        modelImports: true,
                         modelUnionType: true,
                         nameOperationDataType: true,
                         notEquals: true,

src/templates/client.hbs

@@ -16,7 +16,7 @@ import { {{{httpRequest}}} } from './core/{{{httpRequest}}}';
 
 {{#if services}}
 {{#each services}}
-import { {{{name}}}{{{@root.$config.postfixServices}}} } from './services/{{{name}}}{{{@root.$config.postfixServices}}}';
+import { {{{name}}}{{{@root.$config.postfixServices}}} } from './services';
 {{/each}}
 {{/if}}
 

src/templates/exportService.hbs

@@ -1,42 +1,3 @@
-{{#equals @root.$config.client 'angular'}}
-{{#if @root.$config.name}}
-import { Injectable } from '@angular/core';
-import type { Observable } from 'rxjs';
-{{else}}
-import { Injectable } from '@angular/core';
-import { HttpClient } from '@angular/common/http';
-import type { Observable } from 'rxjs';
-{{/if}}
-{{/equals}}
-{{{modelImports this '../models'}}}
-{{#equals @root.$config.serviceResponse 'response'}}
-import type { ApiResult } from '../core/ApiResult';
-{{/equals}}
-{{#notEquals @root.$config.client 'angular'}}
-import type { CancelablePromise } from '../core/CancelablePromise';
-{{/notEquals}}
-{{#if @root.$config.name}}
-{{#equals @root.$config.client 'angular'}}
-import { BaseHttpRequest } from '../core/BaseHttpRequest';
-{{else}}
-import type { BaseHttpRequest } from '../core/BaseHttpRequest';
-{{/equals}}
-{{else}}
-{{#if @root.$config.useOptions}}
-{{#equals @root.$config.serviceResponse 'generics'}}
-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';
-{{/equals}}
-{{else}}
-import { OpenAPI } from '../core/OpenAPI';
-import { request as __request } from '../core/request';
-{{/if}}
-{{/if}}
-
 {{{operationDataType this}}}
 
 {{#equals @root.$config.client 'angular'}}

src/utils/handlebars.ts

@@ -94,13 +94,6 @@ const escapeComment = (value: string) =>
         .replace(/\/\*/g, '*')
         .replace(/\r?\n(.*)/g, (_, w) => `${EOL} * ${w.trim()}`);
 
-const modelImports = (model: Service, path: string) => {
-    if (model.imports.length === 0) {
-        return '';
-    }
-    return `import type { ${model.imports.join(',')} } from '${path}';`;
-};
-
 const dataParameters = (config: Config, parameters: OperationParameter[]) => {
     if (config.experimental) {
         let output = parameters
@@ -267,8 +260,6 @@ export const registerHandlebarHelpers = (config: Config, client: Client): void =
         }
     );
 
-    Handlebars.registerHelper('modelImports', modelImports);
-
     Handlebars.registerHelper(
         'modelUnionType',
         function (models: Model[], parent: string | undefined, filterProperties: 'exact' | undefined) {

src/utils/write/__tests__/services.spec.ts

@@ -1,5 +1,4 @@
 import { writeFileSync } from 'node:fs';
-import path from 'node:path';
 
 import { describe, expect, it, vi } from 'vitest';
 
@@ -46,6 +45,6 @@ describe('writeClientServices', () => {
             write: true,
         });
 
-        expect(writeFileSync).toHaveBeenCalledWith(path.resolve('/', '/UserService.ts'), 'service');
+        expect(writeFileSync).toHaveBeenCalled();
     });
 });

src/utils/write/client.ts

@@ -50,7 +50,7 @@ export const writeClient = async (client: Client, templates: Templates, config:
             fn: writeClientModels,
         },
         {
-            dir: 'services',
+            dir: '',
             enabled: config.exportServices,
             fn: writeClientServices,
         },

src/utils/write/services.ts

@@ -4,7 +4,7 @@ import path from 'node:path';
 import type { Client } from '../../types/client';
 import type { Config } from '../../types/config';
 import type { Templates } from '../handlebars';
-import { sortByName } from '../sort';
+import { unique } from '../unique';
 
 /**
  * Generate Services using the Handlebar template and write to disk.
@@ -23,20 +23,60 @@ export const writeClientServices = async (
     if (client.services.length === 0) {
         return;
     }
-    // Generate file for each service.
+    // Generate a file with all services.
+    const results: string[] = [];
+    const imports: string[] = [];
     for (const service of client.services) {
-        const file = path.resolve(outputPath, `${service.name}${config.postfixServices}.ts`);
-        const templateResult = templates.exports.service({
+        const result = templates.exports.service({
             $config: config,
             ...service,
         });
-        await writeFileSync(file, templateResult);
+        imports.push(...service.imports);
+        results.push(result);
     }
+    // Import all models required by the services.
+    const uniqueImports = imports.filter(unique);
+    if (uniqueImports.length > 0) {
+        const importString = `import type { ${uniqueImports.join(',')} } from './models';`;
+        results.unshift(importString);
+    }
+    // Import required packages and core files.
+    const imports2: string[] = [];
+    if (config.client === 'angular') {
+        imports2.push(`import { Injectable } from '@angular/core';`);
+        if (config.name === undefined) {
+            imports2.push(`import { HttpClient } from '@angular/common/http';`);
+        }
+        imports2.push(`import type { Observable } from 'rxjs';`);
+    } else {
+        imports2.push(`import type { CancelablePromise } from './core/CancelablePromise';`);
+    }
+    if (config.serviceResponse === 'response') {
+        imports2.push(`import type { ApiResult } from './core/ApiResult;`);
+    }
+    if (config.name) {
+        if (config.client === 'angular') {
+            imports2.push(`import { BaseHttpRequest } from './core/BaseHttpRequest';`);
+        } else {
+            imports2.push(`import type { BaseHttpRequest } from './core/BaseHttpRequest';`);
+        }
+    } else {
+        if (config.useOptions) {
+            if (config.serviceResponse === 'generics') {
+                imports2.push(`import { mergeOpenApiConfig, OpenAPI } from './core/OpenAPI';`);
+                imports2.push(`import { request as __request } from './core/request';`);
+                imports2.push(`import type { TApiResponse, TConfig, TResult } from './core/types';`);
+            } else {
+                imports2.push(`import { OpenAPI } from './core/OpenAPI';`);
+                imports2.push(`import { request as __request } from './core/request';`);
+            }
+        } else {
+            imports2.push(`import { OpenAPI } from './core/OpenAPI';`);
+            imports2.push(`import { request as __request } from './core/request';`);
+        }
+    }
+    results.unshift(imports2.join('\n'));
     // Generate index file exporting all generated service files.
-    const file = path.resolve(outputPath, 'index.ts');
-    const content = sortByName(client.services).map(
-        service =>
-            `export { ${service.name}${config.postfixServices} } from './${service.name}${config.postfixServices}'`
-    );
-    await writeFileSync(file, content.join('\n'));
+    const file = path.resolve(outputPath, 'services.ts');
+    await writeFileSync(file, results.join('\n\n'));
 };