client-axios, runtimeConfigPath, client.gent.ts & generated "import createClientConfig from path"

[thekingofspain]

I need some help on code generation option such that the client.gen.ts file creates the proper path for the import line for the createClientConfig.

I am using the following UserConfig to generate a series of client from the an openapi.json file:

  const userConfig: UserConfig = {
      input: {
        path: resolveRoot("config/api/Api.openapi.json"),
        filters: config.includeTags ? {
          tags: { include: config.includeTags }
        } : {
          tags: { exclude: config.excludeTags || [] }
        }
      },
      output: {
        format: "prettier",
        lint: "eslint",
        path: config.outputPath,
        clean: true // Optional: clean output directory before generation
      },
      plugins: [
        {
          name: "@hey-api/client-axios",
          runtimeConfigPath:  "common/src/api/utils/client-config.ts",
        },
        "@hey-api/schemas",
        {
          name: "@hey-api/transformers",
          dates: true,
        },
        {
          name: "@hey-api/typescript",
          enums: "typescript",
        },
        {
          name: "@hey-api/sdk",
          transformer: true
        }
      ],
    };

my directory structure:

    root
    - config/{apiName}  /* Api.openapi.json */
    - scripts /* generate-clients.ts script *?
    - common
    -- src
    --- api/{apiName}
    ---- client/{clientName}
    ---- utils/client-config.ts

I have tried alot of options around the runtimeConfigPath value passed to the client-axios, but one of two things happened:

• The code generation fails:

 root> npm run clients:generate

> project@0.0.1 clients:generate
> tsx scripts/generate-all-clients.ts

🚀 Starting client generation...

⚙️  Generating core client...
⏳ Generating from config\api\AOI_FastApi.openapi.json
🔥 Unexpected error occurred. Log saved to openapi-ts-error-1749482162833.log
🔥 Unexpected error occurred. File with id common/src/api/util/client-config.ts does not exist
❌ Critical error in core client generation:
Message: File with id common/src/api/util/client-config.ts does not exist
Stack: Error: File with id common/src/api/util/client-config.ts does not exist
    at le.relativePathToFile (node_modules\@hey-api\openapi-ts\src\generate\files.ts:231:15)
    at createClient (node_modules\@hey-api\openapi-ts\src\plugins\@hey-api\client-core\client.ts:54:22)
    at Object.mt (node_modules\@hey-api\openapi-ts\src\plugins\@hey-api\client-core\plugin.ts:14:3)
    at generateOutput (node_modules\@hey-api\openapi-ts\src\generate\output.ts:142:12)
    at Hs (node_modules\@hey-api\openapi-ts\src\createClient.ts:246:13)
    at async Promise.all (index 0)
    at async yN (node_modules\@hey-api\openapi-ts\src\index.ts:46:21)
    at async generateClients (scripts\generate-all-clients.ts:101:7)

• or the code generation works, but the generated import statement in the client.gen.ts file has a bad path for the clientConfig import statement:

import { createClientConfig } from '../../../../../../../../../client-config'; /* expecting "../../utils/client-config" */

[mrlubos]

Did you try ./common/src/api/utils/client-config.ts? I need to improve this btw

[thekingofspain]

Your suggestion worked, thanks!

There were three issues:

1. User Error - I was using the wrong path to the config. I blame vscode for listing files last vs first when a file and folder are at the same level.
2. Bug - Not using a ./ in the runtimeConfigPath always produces an error.
3. Bug - Using a ./ in the runtimeConfigPath never produces an error.

In my discussion example, the passed in runtimeConfigPath did not exist.

bad path

Generation Fails - Valid Error: config does not exist

      plugins: [
        {
          name: "@hey-api/client-axios",
          runtimeConfigPath:
            "{someBadPath}",
        },

Generation Succeeds - Should have failed however: config does not exist

      plugins: [
        {
          name: "@hey-api/client-axios",
          runtimeConfigPath:
            "./{someBadPath}",
        },

good path

Generation Failed - Invalid Error: config exists

      plugins: [
        {
          name: "@hey-api/client-axios",
          runtimeConfigPath:
            "{someGoodPath}",
        },

Generation Success- Good client.gen.tx: : config exists

      plugins: [
        {
          name: "@hey-api/client-axios",
          runtimeConfigPath:
            "./{someGoodPath}",
        },

Between being Friday and using _resolveRoot _ for around my other path variables in the script, I did not catch or introduced the initial path error. I know I did try using the ./ in the path, but at that time the path must have been wrong already.

const resolveRoot = (relativePath: string) => path.resolve(process.cwd(), relativePath);