feat: allow inlining standalone clients with

hey-api · Jul 17, 2024 · 13a647a · 13a647a
1 parent 96ad83b
commit 13a647a
Show file tree

Hide file tree

Showing 76 changed files with 6,268 additions and 5,713 deletions.
diff --git a/.changeset/silver-apples-build.md b/.changeset/silver-apples-build.md
@@ -0,0 +1,5 @@
+---
+'@hey-api/openapi-ts': minor
+---
+
+feat: allow inlining standalone clients with `client.inline = true`
diff --git a/.nvmrc b/.nvmrc
@@ -1 +1 @@
-20.9.0
+20.10.0
diff --git a/packages/openapi-ts/package.json b/packages/openapi-ts/package.json
@@ -81,6 +81,7 @@
     "@angular/platform-browser": "17.3.9",
     "@angular/platform-browser-dynamic": "17.3.9",
     "@angular/router": "17.3.9",
+    "@hey-api/client-fetch": "workspace:*",
     "@rollup/plugin-json": "6.1.0",
     "@rollup/plugin-node-resolve": "15.2.3",
     "@types/cross-spawn": "6.0.6",

diff --git a/packages/openapi-ts/src/compiler/module.ts b/packages/openapi-ts/src/compiler/module.ts
@@ -9,35 +9,43 @@ import {
 
 /**
  * Create export all declaration. Example: `export * from './y'`.
- * @param module - module to export from.
+ * @param module - module containing exports
  * @returns ts.ExportDeclaration
  */
-export const createExportAllDeclaration = (module: string) =>
-  ts.factory.createExportDeclaration(
+export const createExportAllDeclaration = ({
+  module,
+}: {
+  module: string;
+}): ts.ExportDeclaration => {
+  const statement = ts.factory.createExportDeclaration(
     undefined,
     false,
     undefined,
     ots.string(module),
   );
+  return statement;
+};
 
 type ImportExportItem = ImportExportItemObject | string;
 
 /**
  * Create a named export declaration. Example: `export { X } from './y'`.
- * @param items - the items to export.
- * @param module - module to export it from.
- * @returns ExportDeclaration
+ * @param exports - named imports to export
+ * @param module - module containing exports
+ * @returns ts.ExportDeclaration
  */
-export const createNamedExportDeclarations = (
-  items: Array<ImportExportItem> | ImportExportItem,
-  module: string,
-): ts.ExportDeclaration => {
-  items = Array.isArray(items) ? items : [items];
-  const exportedTypes = Array.isArray(items) ? items : [items];
+export const createNamedExportDeclarations = ({
+  exports,
+  module,
+}: {
+  exports: Array<ImportExportItem> | ImportExportItem;
+  module: string;
+}): ts.ExportDeclaration => {
+  const exportedTypes = Array.isArray(exports) ? exports : [exports];
   const hasNonTypeExport = exportedTypes.some(
     (item) => typeof item !== 'object' || !item.asType,
   );
-  const elements = items.map((name) => {
+  const elements = exportedTypes.map((name) => {
     const item = typeof name === 'string' ? { name } : name;
     return ots.export({
       alias: item.alias,
@@ -101,15 +109,18 @@ export const createExportConstVariable = ({
 
 /**
  * Create a named import declaration. Example: `import { X } from './y'`.
- * @param items - the items to export.
- * @param module - module to export it from.
- * @returns ImportDeclaration
+ * @param imports - named exports to import
+ * @param module - module containing imports
+ * @returns ts.ImportDeclaration
  */
-export const createNamedImportDeclarations = (
-  items: Array<ImportExportItem> | ImportExportItem,
-  module: string,
-): ts.ImportDeclaration => {
-  const importedTypes = Array.isArray(items) ? items : [items];
+export const createNamedImportDeclarations = ({
+  imports,
+  module,
+}: {
+  imports: Array<ImportExportItem> | ImportExportItem;
+  module: string;
+}): ts.ImportDeclaration => {
+  const importedTypes = Array.isArray(imports) ? imports : [imports];
   const hasNonTypeImport = importedTypes.some(
     (item) => typeof item !== 'object' || !item.asType,
   );

diff --git a/packages/openapi-ts/src/generate/__tests__/class.spec.ts b/packages/openapi-ts/src/generate/__tests__/class.spec.ts
@@ -11,7 +11,9 @@ vi.mock('node:fs');
 describe('generateClientClass', () => {
   it('writes to filesystem', async () => {
     setConfig({
-      client: 'fetch',
+      client: {
+        name: 'fetch',
+      },
       configFile: '',
       debug: false,
       dryRun: false,

diff --git a/packages/openapi-ts/src/generate/__tests__/core.spec.ts b/packages/openapi-ts/src/generate/__tests__/core.spec.ts
@@ -25,7 +25,9 @@ describe('generateCore', () => {
     };
 
     setConfig({
-      client: 'fetch',
+      client: {
+        name: 'fetch',
+      },
       configFile: '',
       debug: false,
       dryRun: false,
@@ -82,7 +84,9 @@ describe('generateCore', () => {
     };
 
     const config = setConfig({
-      client: 'fetch',
+      client: {
+        name: 'fetch',
+      },
       configFile: '',
       debug: false,
       dryRun: false,
@@ -122,7 +126,9 @@ describe('generateCore', () => {
 
     const config = setConfig({
       base: 'foo',
-      client: 'fetch',
+      client: {
+        name: 'fetch',
+      },
       configFile: '',
       debug: false,
       dryRun: false,

diff --git a/packages/openapi-ts/src/generate/__tests__/index.spec.ts b/packages/openapi-ts/src/generate/__tests__/index.spec.ts
@@ -12,7 +12,9 @@ vi.mock('node:fs');
 describe('generateIndexFile', () => {
   it('writes to filesystem', async () => {
     setConfig({
-      client: 'fetch',
+      client: {
+        name: 'fetch',
+      },
       configFile: '',
       debug: false,
       dryRun: false,

diff --git a/packages/openapi-ts/src/generate/__tests__/output.spec.ts b/packages/openapi-ts/src/generate/__tests__/output.spec.ts
@@ -11,7 +11,9 @@ vi.mock('node:fs');
 describe('generateOutput', () => {
   it('writes to filesystem', async () => {
     setConfig({
-      client: 'fetch',
+      client: {
+        name: 'fetch',
+      },
       configFile: '',
       debug: false,
       dryRun: false,

diff --git a/packages/openapi-ts/src/generate/__tests__/schemas.spec.ts b/packages/openapi-ts/src/generate/__tests__/schemas.spec.ts
@@ -13,7 +13,9 @@ vi.mock('node:fs');
 describe('generateSchemas', () => {
   it('writes to filesystem', async () => {
     setConfig({
-      client: 'fetch',
+      client: {
+        name: 'fetch',
+      },
       configFile: '',
       debug: false,
       dryRun: false,

diff --git a/packages/openapi-ts/src/generate/__tests__/services.spec.ts b/packages/openapi-ts/src/generate/__tests__/services.spec.ts
@@ -13,7 +13,9 @@ vi.mock('node:fs');
 describe('generateServices', () => {
   it('writes to filesystem', async () => {
     setConfig({
-      client: 'fetch',
+      client: {
+        name: 'fetch',
+      },
       configFile: '',
       debug: false,
       dryRun: false,
@@ -129,7 +131,9 @@ describe('methodNameBuilder', () => {
 
   it('use default name', async () => {
     setConfig({
-      client: 'fetch',
+      client: {
+        name: 'fetch',
+      },
       configFile: '',
       debug: false,
       dryRun: false,
@@ -169,7 +173,9 @@ describe('methodNameBuilder', () => {
     const methodNameBuilder = vi.fn().mockReturnValue('customName');
 
     setConfig({
-      client: 'fetch',
+      client: {
+        name: 'fetch',
+      },
       configFile: '',
       debug: false,
       dryRun: false,
@@ -212,7 +218,9 @@ describe('methodNameBuilder', () => {
     const methodNameBuilder = vi.fn().mockReturnValue('customName');
 
     setConfig({
-      client: 'fetch',
+      client: {
+        name: 'fetch',
+      },
       configFile: '',
       debug: false,
       dryRun: false,

diff --git a/packages/openapi-ts/src/generate/__tests__/types.spec.ts b/packages/openapi-ts/src/generate/__tests__/types.spec.ts
@@ -12,7 +12,9 @@ vi.mock('node:fs');
 describe('generateTypes', () => {
   it('writes to filesystem', async () => {
     setConfig({
-      client: 'fetch',
+      client: {
+        name: 'fetch',
+      },
       configFile: '',
       debug: false,
       dryRun: false,

diff --git a/packages/openapi-ts/src/generate/client.ts b/packages/openapi-ts/src/generate/client.ts
@@ -0,0 +1,49 @@
+import { copyFileSync, readFileSync, writeFileSync } from 'node:fs';
+import { createRequire } from 'node:module';
+import path from 'node:path';
+
+import { getConfig, isStandaloneClient } from '../utils/config';
+import { ensureDirSync } from './utils';
+
+const require = createRequire(import.meta.url);
+
+/**
+ * (optional) Creates a `client.ts` file containing the same exports as a
+ * standalone client package. Creates a `core` directory containing the modules
+ * from standalone client. These files are generated only when `client.inline`
+ * is set to true.
+ */
+export const generateClient = async (
+  outputPath: string,
+  moduleName: string,
+) => {
+  const config = getConfig();
+
+  if (!isStandaloneClient(config) || !config.client.inline) {
+    return;
+  }
+
+  // create directory for client modules
+  const dirPath = path.resolve(outputPath, 'core');
+  ensureDirSync(dirPath);
+
+  const clientModulePath = require.resolve(moduleName);
+  const clientSrcPath = `${clientModulePath.slice(0, clientModulePath.indexOf('/dist/'))}/src`;
+
+  // copy client modules
+  const files = ['index.ts', 'types.ts', 'utils.ts'];
+  files.forEach((file) => {
+    copyFileSync(
+      path.resolve(clientSrcPath, file),
+      path.resolve(dirPath, file),
+    );
+  });
+
+  // copy index file with cherry-picked exports
+  const nodeIndexFile = readFileSync(
+    path.resolve(clientSrcPath, 'node', 'index.ts'),
+    'utf-8',
+  );
+  const indexFile = nodeIndexFile.replaceAll('../', './core/');
+  writeFileSync(path.resolve(outputPath, 'client.ts'), indexFile, 'utf-8');
+};
diff --git a/packages/openapi-ts/src/generate/core.ts b/packages/openapi-ts/src/generate/core.ts
@@ -68,7 +68,7 @@ export const generateCore = async (
         ...context,
       }),
     );
-    if (config.client !== 'angular') {
+    if (config.client.name !== 'angular') {
       await writeFileSync(
         path.resolve(outputPath, 'CancelablePromise.ts'),
         templates.core.cancelablePromise({

diff --git a/packages/openapi-ts/src/generate/indexFile.ts b/packages/openapi-ts/src/generate/indexFile.ts
@@ -9,37 +9,50 @@ export const generateIndexFile = async ({
   const config = getConfig();
 
   if (config.name) {
-    files.index.add(compiler.export.named([config.name], `./${config.name}`));
+    files.index.add(
+      compiler.export.named({
+        exports: config.name,
+        module: `./${config.name}`,
+      }),
+    );
   }
 
   if (config.exportCore) {
-    files.index.add(compiler.export.named('ApiError', './core/ApiError'));
+    files.index.add(
+      compiler.export.named({
+        exports: 'ApiError',
+        module: './core/ApiError',
+      }),
+    );
     if (config.services.response === 'response') {
       files.index.add(
-        compiler.export.named(
-          { asType: true, name: 'ApiResult' },
-          './core/ApiResult',
-        ),
+        compiler.export.named({
+          exports: { asType: true, name: 'ApiResult' },
+          module: './core/ApiResult',
+        }),
       );
     }
     if (config.name) {
       files.index.add(
-        compiler.export.named('BaseHttpRequest', './core/BaseHttpRequest'),
+        compiler.export.named({
+          exports: 'BaseHttpRequest',
+          module: './core/BaseHttpRequest',
+        }),
       );
     }
-    if (config.client !== 'angular') {
+    if (config.client.name !== 'angular') {
       files.index.add(
-        compiler.export.named(
-          ['CancelablePromise', 'CancelError'],
-          './core/CancelablePromise',
-        ),
+        compiler.export.named({
+          exports: ['CancelablePromise', 'CancelError'],
+          module: './core/CancelablePromise',
+        }),
       );
     }
     files.index.add(
-      compiler.export.named(
-        ['OpenAPI', { asType: true, name: 'OpenAPIConfig' }],
-        './core/OpenAPI',
-      ),
+      compiler.export.named({
+        exports: ['OpenAPI', { asType: true, name: 'OpenAPIConfig' }],
+        module: './core/OpenAPI',
+      }),
     );
   }
 
@@ -48,6 +61,10 @@ export const generateIndexFile = async ({
       return;
     }
 
-    files.index.add(compiler.export.all(`./${file.getName(false)}`));
+    files.index.add(
+      compiler.export.all({
+        module: `./${file.getName(false)}`,
+      }),
+    );
   });
 };