Merge pull request #1987 from hey-api/fix/export-from-index-nested

fix: correct path to nested plugin files when using exportFromIndex

Author: mrlubos

.changeset/wet-cycles-confess.md

@@ -0,0 +1,5 @@
+---
+'@hey-api/openapi-ts': patch
+---
+
+fix: correct path to nested plugin files when using exportFromIndex

packages/openapi-ts-tests/test/openapi-ts.config.ts

@@ -36,12 +36,7 @@ export default defineConfig(() => {
       //   openapi: '3.1.0',
       //   paths: {},
       // },
-      path: path.resolve(
-        __dirname,
-        'spec',
-        '3.1.x',
-        'discriminator-mapped-many.yaml',
-      ),
+      path: path.resolve(__dirname, 'spec', '3.1.x', 'full.json'),
       // path: 'http://localhost:4000/',
       // path: 'https://get.heyapi.dev/',
       // path: 'https://get.heyapi.dev/hey-api/backend?branch=main&version=1.0.0',
@@ -76,7 +71,7 @@ export default defineConfig(() => {
         // bundle: true,
         // bundleSource_EXPERIMENTAL: true,
         // exportFromIndex: true,
-        // name: '@hey-api/client-fetch',
+        name: '@hey-api/client-fetch',
         // strictBaseUrl: true,
       },
       {
@@ -108,7 +103,7 @@ export default defineConfig(() => {
         // enumsCase: 'camelCase',
         // exportInlineEnums: true,
         // identifierCase: 'preserve',
-        name: '@hey-api/typescript',
+        // name: '@hey-api/typescript',
         // readOnlyWriteOnlyBehavior: 'off',
         // readableNameBuilder: 'Readable{{name}}',
         // writableNameBuilder: 'Writable{{name}}',
@@ -118,11 +113,12 @@ export default defineConfig(() => {
         // name: 'fastify',
       },
       {
-        // name: '@tanstack/react-query',
+        exportFromIndex: true,
+        name: '@tanstack/react-query',
       },
       {
         // exportFromIndex: true,
-        name: 'zod',
+        // name: 'zod',
       },
     ],
     // useOptions: false,

packages/openapi-ts/src/generate/__tests__/index.test.ts

@@ -68,14 +68,17 @@ describe('generateIndexFile', () => {
     const files: Parameters<typeof generateIndexFile>[0]['files'] = {
       schemas: new TypeScriptFile({
         dir: '/',
+        id: 'schemas',
         name: 'schemas.ts',
       }),
       sdk: new TypeScriptFile({
         dir: '/',
+        id: 'sdk',
         name: 'sdk.ts',
       }),
       types: new TypeScriptFile({
         dir: '/',
+        id: 'types',
         name: 'types.ts',
       }),
     };

packages/openapi-ts/src/generate/files.ts

@@ -59,6 +59,7 @@ export class TypeScriptFile {
    */
   private _exportFromIndex: boolean;
   private _headers: Array<string> = [];
+  private _id: string;
   private _identifierCase: StringCase | undefined;
   private _imports = new Map<string, Map<string, ImportExportItemObject>>();
   private _items: Array<ts.Node | string> = [];
@@ -80,6 +81,7 @@ export class TypeScriptFile {
     dir,
     exportFromIndex = false,
     header = true,
+    id,
     identifierCase,
     name,
   }: {
@@ -89,10 +91,17 @@ export class TypeScriptFile {
      */
     exportFromIndex?: boolean;
     header?: boolean;
+    /**
+     * Unique file ID. Used to generate correct relative paths to the file.
+     * This should be refactored later as it's basically the file name unless
+     * nested inside another folder.
+     */
+    id: string;
     identifierCase?: StringCase;
     name: string;
   }) {
     this._exportFromIndex = exportFromIndex;
+    this._id = id;
     this._identifierCase = identifierCase;
     this._name = this._setName(name);
     this._path = path.resolve(dir, this._name);
@@ -138,6 +147,10 @@ export class TypeScriptFile {
     return this._exportFromIndex;
   }
 
+  public get id(): string {
+    return this._id;
+  }
+
   public identifier({
     namespace,
     ...args

packages/openapi-ts/src/generate/indexFile.ts

@@ -9,6 +9,7 @@ export const generateIndexFile = ({ files }: { files: Files }): void => {
 
   files.index = new TypeScriptFile({
     dir: config.output.path,
+    id: 'index',
     name: 'index.ts',
   });
 

packages/openapi-ts/src/generate/output.ts

@@ -90,6 +90,7 @@ export const generateLegacyOutput = async ({
     );
     files[plugin.name] = new TypeScriptFile({
       dir: outputDir,
+      id: `legacy-unused-${plugin.name}`,
       name: `${outputParts[outputParts.length - 1]}.ts`,
     });
     plugin._handlerLegacy({
@@ -162,7 +163,10 @@ export const generateOutput = async ({ context }: { context: IR.Context }) => {
         // what's exported so we can support named exports
         indexFile.add(
           compiler.exportAllDeclaration({
-            module: `./${fileName}`,
+            module: indexFile.relativePathToFile({
+              context,
+              id: file.id,
+            }),
           }),
         );
       }

packages/openapi-ts/src/ir/context.ts

@@ -136,6 +136,7 @@ export class IRContext<Spec extends Record<string, any> = any> {
     const createdFile = new TypeScriptFile({
       dir: outputDir,
       exportFromIndex: file.exportFromIndex,
+      id: file.id,
       identifierCase: file.identifierCase,
       name: `${outputParts[outputParts.length - 1]}.ts`,
     });

packages/openapi-ts/src/plugins/@hey-api/schemas/plugin-legacy.ts

@@ -77,6 +77,7 @@ export const handlerLegacy: Plugin.LegacyHandler<Config> = ({
 
   files.schemas = new TypeScriptFile({
     dir: config.output.path,
+    id: 'schemas',
     name: 'schemas.ts',
   });
 

packages/openapi-ts/src/plugins/@hey-api/sdk/__tests__/plugin.test.ts

@@ -111,6 +111,7 @@ describe('handlerLegacy', () => {
 
     files.types = new TypeScriptFile({
       dir: '/',
+      id: 'types',
       name: 'types.ts',
     });
 
@@ -234,6 +235,7 @@ describe('methodNameBuilder', () => {
 
     files.types = new TypeScriptFile({
       dir: '/',
+      id: 'types',
       name: 'types.ts',
     });
 
@@ -318,6 +320,7 @@ describe('methodNameBuilder', () => {
 
     files.types = new TypeScriptFile({
       dir: '/',
+      id: 'types',
       name: 'types.ts',
     });
 
@@ -404,6 +407,7 @@ describe('methodNameBuilder', () => {
 
     files.types = new TypeScriptFile({
       dir: '/',
+      id: 'types',
       name: 'types.ts',
     });
 

packages/openapi-ts/src/plugins/@hey-api/sdk/plugin-legacy.ts

@@ -802,6 +802,7 @@ export const handlerLegacy: Plugin.LegacyHandler<Config> = ({
 
   files.sdk = new TypeScriptFile({
     dir: config.output.path,
+    id: 'sdk',
     name: `${sdkOutput}.ts`,
   });