refactor(nx-plugin): handle configs from builtin client packages

Author: seriouslag

packages/nx-plugin/package.json

@@ -48,21 +48,22 @@
   "executors": "./executors.json",
   "generators": "./generators.json",
   "dependencies": {
-    "@hey-api/json-schema-ref-parser": "1.0.6",
+    "@hey-api/json-schema-ref-parser": "^1.0.6",
     "@hey-api/openapi-ts": "workspace:*",
-    "@nx/devkit": "21.0.3",
+    "@nx/devkit": "^21.3.5",
     "api-smart-diff": "^1.0.6",
-    "latest-version": "9.0.0",
-    "nx": "21.0.3",
+    "latest-version": "^9.0.0",
+    "nx": "^21.3.5",
+    "prettier": "^3.6.2",
     "swagger2openapi": "^7.0.8",
-    "tslib": "2.8.1",
-    "xcurl": "2.1.2"
+    "tslib": "^2.8.1",
+    "xcurl": "^2.1.2"
   },
   "devDependencies": {
     "@config/vite-base": "workspace:*",
     "@types/swagger2openapi": "^7.0.4",
-    "typescript": "5.8.3",
-    "vitest": "3.1.1"
+    "typescript": "^5.8.3",
+    "vitest": "^3.2.4"
   },
   "files": [
     "executors.json",

packages/nx-plugin/src/executors/update-api/updateApi.spec.ts

@@ -20,13 +20,19 @@ vi.mock('@hey-api/openapi-ts/internal', async (importOriginal) => {
   return {
     ...actual,
     initConfigs: vi.fn((config: Parameters<typeof initConfigs>[0]) =>
-      Promise.resolve([
-        {
-          input: config?.input ?? 'default-input',
-          output: config?.output ?? 'default-output',
-          plugins: config?.plugins ?? [],
-        },
-      ]),
+      Promise.resolve({
+        dependencies: [],
+        results: [
+          {
+            config: {
+              input: config?.input ?? 'default-input',
+              output: config?.output ?? 'default-output',
+              plugins: config?.plugins ?? [],
+            },
+            errors: [],
+          },
+        ],
+      }),
     ),
   };
 });

packages/nx-plugin/src/generators/openapi-client/openapiClient.spec.ts

@@ -30,13 +30,19 @@ vi.mock('@hey-api/openapi-ts/internal', async (importOriginal) => {
   return {
     ...actual,
     initConfigs: vi.fn((config: Parameters<typeof initConfigs>[0]) =>
-      Promise.resolve([
-        {
-          input: config?.input ?? 'default-input',
-          output: config?.output ?? 'default-output',
-          plugins: config?.plugins ?? [],
-        },
-      ]),
+      Promise.resolve({
+        dependencies: [],
+        results: [
+          {
+            config: {
+              input: config?.input ?? 'default-input',
+              output: config?.output ?? 'default-output',
+              plugins: config?.plugins ?? [],
+            },
+            errors: [],
+          },
+        ],
+      }),
     ),
   };
 });
@@ -215,7 +221,7 @@ describe('openapi-client generator', () => {
   });
 
   describe('updatePackageJson', () => {
-    it('should update package.json with correct dependencies', async () => {
+    it('should not add the fetch client to the package.json', async () => {
       const { options, tree } = await getGeneratorOptions({
         name: `test-api-${randomUUID()}`,
         tempDirectory,
@@ -252,7 +258,49 @@ describe('openapi-client generator', () => {
       });
 
       const packageJson = readJson(tree, `${projectRoot}/package.json`);
-      expect(packageJson.dependencies['@hey-api/client-fetch']).toBeDefined();
+      expect(
+        packageJson.dependencies['@hey-api/client-fetch'],
+      ).not.toBeDefined();
+    });
+
+    it('should add the random client to the package.json', async () => {
+      const { options, tree } = await getGeneratorOptions({
+        name: `test-api-${randomUUID()}`,
+        tempDirectory,
+      });
+      const normalizedOptions = normalizeOptions(options);
+      const { projectName, projectRoot, projectScope } = normalizedOptions;
+
+      // Create initial package.json
+      tree.write(
+        `${projectRoot}/package.json`,
+        JSON.stringify({
+          dependencies: {},
+          devDependencies: {},
+          name: `${projectScope}/${projectName}`,
+        }),
+      );
+
+      // Create tsconfig.base.json
+      tree.write(
+        'tsconfig.base.json',
+        JSON.stringify({
+          compilerOptions: {
+            paths: {},
+          },
+        }),
+      );
+
+      await updatePackageJson({
+        clientType: 'MyRandomClient',
+        isPrivate: true,
+        plugins: [],
+        projectRoot,
+        tree,
+      });
+
+      const packageJson = readJson(tree, `${projectRoot}/package.json`);
+      expect(packageJson.dependencies['MyRandomClient']).toBeDefined();
     });
 
     it('should update tsconfig with correct dependencies', async () => {

packages/nx-plugin/src/generators/openapi-client/openapiClient.ts

@@ -897,8 +897,19 @@ export async function updatePackageJson({
 }) {
   const { default: latestVersion } = await import('latest-version');
 
+  const nonPackageClients = [
+    '@hey-api/client-fetch',
+    '@hey-api/client-axios',
+    '@hey-api/client-nuxt',
+    '@hey-api/client-next',
+  ];
   // add the client as a dependency
-  const clientDetails = getPackageDetails(clientType);
+  const clientDetails = nonPackageClients.includes(clientType)
+    ? {
+        packageName: clientType,
+        packageVersion: undefined,
+      }
+    : getPackageDetails(clientType);
   // add the openapi-ts as a dependency
   const openApiTsDetails = getPackageDetails('@hey-api/openapi-ts');
 
@@ -923,13 +934,16 @@ export async function updatePackageJson({
   ]);
 
   // Update package.json to add dependencies and scripts
-  const deps = results.reduce(
-    (acc, result) => {
-      acc[result.packageName] = result.packageVersion;
-      return acc;
-    },
-    {} as Record<string, string>,
-  );
+  const deps = results
+    // filter out the packages that have no version
+    .filter((v) => v.packageVersion !== undefined)
+    .reduce(
+      (acc, result) => {
+        acc[result.packageName] = result.packageVersion;
+        return acc;
+      },
+      {} as Record<string, string>,
+    );
 
   if ((await clientDetails).packageName === '@hey-api/client-axios') {
     const axiosVersion = await latestVersion('axios');

packages/nx-plugin/src/utils.spec.ts

@@ -46,13 +46,19 @@ vi.mock('@hey-api/openapi-ts/internal', async (importOriginal) => {
       }),
     ),
     initConfigs: vi.fn((config: Parameters<typeof initConfigs>[0]) =>
-      Promise.resolve([
-        {
-          input: config?.input ?? 'default-input',
-          output: config?.output ?? 'default-output',
-          plugins: config?.plugins ?? [],
-        },
-      ]),
+      Promise.resolve({
+        dependencies: [],
+        results: [
+          {
+            config: {
+              input: config?.input ?? 'default-input',
+              output: config?.output ?? 'default-output',
+              plugins: config?.plugins ?? [],
+            },
+            errors: [],
+          },
+        ],
+      }),
     ),
     parseOpenApiSpec: vi.fn(() => ({
       spec: {

packages/nx-plugin/src/utils.ts

@@ -136,14 +136,29 @@ export async function bundleAndDereferenceSpecFile({
       plugins: [client, ...plugins] as ClientConfig['plugins'],
     });
     // getting the first config
-    const config = configs[0];
+    const dependencies = configs.dependencies;
+    const firstResult = configs.results[0];
+    if (!firstResult) {
+      logger.error('Failed to load config.');
+      throw new Error('Failed to load config.');
+    }
+    // check if the config is valid
+    const { config, errors } = firstResult;
+    const firstError = errors[0];
+    if (firstError && !config) {
+      logger.error(`Failed to load config: ${firstError.message}`);
+      throw new Error(`Failed to load config: ${firstError.message}`, {
+        cause: firstError,
+      });
+    }
     if (!config) {
       logger.error('Failed to load config.');
       throw new Error('Failed to load config.');
     }
     logger.debug(`Parsing spec...`);
     const context = parseOpenApiSpec({
       config,
+      dependencies,
       spec,
     });
     if (!context) {