fix test feedback from @grumpyTofu

Author: phryneas

packages/rtk-query-codegen-openapi/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@rtk-query/codgen-openapi",
   "version": "1.0.0-alpha.1",
-  "main": "index.js",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
   "author": "Lenz Weber",
   "license": "MIT",
   "repository": {

packages/rtk-query-codegen-openapi/src/generate.ts

@@ -16,15 +16,7 @@ import {
 import type { OpenAPIV3 } from 'openapi-types';
 import { generateReactHooks } from './generators/react-hooks';
 import type { EndpointOverrides, GenerationOptions, OperationDefinition } from './types';
-import { OutputFileOptions } from './types';
-import {
-  capitalize,
-  getOperationDefinitions,
-  getV3Doc,
-  isQuery as testIsQuery,
-  MESSAGES,
-  removeUndefined,
-} from './utils';
+import { capitalize, getOperationDefinitions, getV3Doc, isQuery as testIsQuery, removeUndefined } from './utils';
 import type { ObjectPropertyDefinitions } from './codegen';
 import { generateCreateApiCall, generateEndpointDefinition, generateImportNode } from './codegen';
 
@@ -45,7 +37,7 @@ function patternMatches(pattern?: string | RegExp | (string | RegExp)[]) {
     if (!pattern) return true;
     const operationName = getOperationName(operationDefinition);
     return filters.some((filter) =>
-      typeof filter === 'string' ? filter == operationName : filter?.test(operationName)
+      typeof filter === 'string' ? filter === operationName : filter?.test(operationName)
     );
   };
 }
@@ -97,17 +89,20 @@ export async function generateApi(
     return declaration;
   }
 
-  if (outputFile && outputFile !== '-') {
+  if (outputFile) {
     outputFile = path.resolve(process.cwd(), outputFile);
-    apiFile = path.relative(path.dirname(outputFile), apiFile);
+    if (apiFile.startsWith('.')) {
+      apiFile = path.relative(path.dirname(outputFile), apiFile);
+      if (!apiFile.startsWith('.')) apiFile = './' + apiFile;
+    }
   }
   apiFile = apiFile.replace(/\.[jt]sx?$/, '');
 
   const sourceCode = printer.printNode(
     ts.EmitHint.Unspecified,
     factory.createSourceFile(
       [
-        generateImportNode(apiFile, { api: apiImport }),
+        generateImportNode(apiFile, { [apiImport]: 'api' }),
         generateCreateApiCall({
           endpointDefinitions: factory.createObjectLiteralExpression(
             operationDefinitions.map((operationDefinition) =>
@@ -350,25 +345,25 @@ export async function generateApi(
                   factory.createIdentifier('method'),
                   factory.createStringLiteral(verb.toUpperCase())
                 ),
-            bodyParameter == undefined
+            bodyParameter === undefined
               ? undefined
               : factory.createPropertyAssignment(
                   factory.createIdentifier('body'),
                   factory.createPropertyAccessExpression(rootObject, factory.createIdentifier(bodyParameter.name))
                 ),
-            cookieParameters.length == 0
+            cookieParameters.length === 0
               ? undefined
               : factory.createPropertyAssignment(
                   factory.createIdentifier('cookies'),
                   generateQuerArgObjectLiteralExpression(cookieParameters, rootObject)
                 ),
-            headerParameters.length == 0
+            headerParameters.length === 0
               ? undefined
               : factory.createPropertyAssignment(
                   factory.createIdentifier('headers'),
                   generateQuerArgObjectLiteralExpression(headerParameters, rootObject)
                 ),
-            queryParameters.length == 0
+            queryParameters.length === 0
               ? undefined
               : factory.createPropertyAssignment(
                   factory.createIdentifier('params'),
@@ -381,10 +376,12 @@ export async function generateApi(
     );
   }
 
+  // eslint-disable-next-line no-empty-pattern
   function generateQueryEndpointProps({}: { operationDefinition: OperationDefinition }): ObjectPropertyDefinitions {
     return {}; /* TODO needs implementation - skip for now */
   }
 
+  // eslint-disable-next-line no-empty-pattern
   function generateMutationEndpointProps({}: { operationDefinition: OperationDefinition }): ObjectPropertyDefinitions {
     return {}; /* TODO needs implementation - skip for now */
   }

packages/rtk-query-codegen-openapi/test/generateEndpoints.test.ts

@@ -1,5 +1,7 @@
 import { resolve } from 'path';
 import { generateEndpoints } from '../src';
+import fs from 'fs';
+import path from 'path';
 
 test('calling without `outputFile` returns the generated api', async () => {
   const api = await generateEndpoints({
@@ -72,6 +74,54 @@ test('should use brackets in a querystring urls arg, when the arg contains full
     apiFile: './fixtures/emptyApi.ts',
     schemaFile: resolve(__dirname, 'fixtures/params.json'),
   });
+  // eslint-disable-next-line no-template-curly-in-string
   expect(api).toContain('`/api/v1/list/${queryArg["item.id"]}`');
   expect(api).toMatchSnapshot();
 });
+
+test('apiImport builds correct `import` statement', async () => {
+  const api = await generateEndpoints({
+    apiFile: './fixtures/emptyApi.ts',
+    schemaFile: resolve(__dirname, 'fixtures/params.json'),
+    filterEndpoints: [],
+    apiImport: 'myApi',
+  });
+  expect(api).toContain('myApi as api');
+});
+
+describe('import paths', () => {
+  beforeEach(async () => {
+    const dir = resolve(__dirname, 'tmp');
+    const files = await fs.promises.readdir(dir);
+    for (const file of files) {
+      if (!file.startsWith('.')) await fs.promises.unlink(path.join(dir, file));
+    }
+  });
+
+  test('should create paths relative to `outFile` when `apiFile` is relative (different folder)', async () => {
+    process.chdir(__dirname);
+    await generateEndpoints({
+      apiFile: './fixtures/emptyApi.ts',
+      outputFile: './tmp/out.ts',
+      schemaFile: resolve(__dirname, 'fixtures/petstore.json'),
+      filterEndpoints: [],
+      hooks: true,
+    });
+    expect(await fs.promises.readFile('./tmp/out.ts', 'utf8')).toContain("import { api } from '../fixtures/emptyApi'");
+  });
+
+  test('should create paths relative to `outFile` when `apiFile` is relative (same folder)', async () => {
+    process.chdir(__dirname);
+
+    await fs.promises.writeFile('./tmp/emptyApi.ts', await fs.promises.readFile('./fixtures/emptyApi.ts'));
+
+    await generateEndpoints({
+      apiFile: './tmp/emptyApi.ts',
+      outputFile: './tmp/out.ts',
+      schemaFile: resolve(__dirname, 'fixtures/petstore.json'),
+      filterEndpoints: [],
+      hooks: true,
+    });
+    expect(await fs.promises.readFile('./tmp/out.ts', 'utf8')).toContain("import { api } from './emptyApi'");
+  });
+});