nuxt-openapi-hyperfetch 0.2.7-alpha.1 → 0.2.8-alpha.1

package/src/module/index.ts

@@ -1,133 +1,158 @@
-import { defineNuxtModule, addImportsDir } from '@nuxt/kit';
-import { execSync } from 'child_process';
-import * as path from 'path';
-import { checkJavaInstalled } from '../generate.js';
-import { generateUseFetchComposables } from '../generators/use-fetch/generator.js';
-import { generateUseAsyncDataComposables } from '../generators/use-async-data/generator.js';
-import { generateNuxtServerRoutes } from '../generators/nuxt-server/generator.js';
-import { createConsoleLogger } from '../cli/logger.js';
-import type { ModuleOptions } from './types.js';
-
-export default defineNuxtModule<ModuleOptions>({
-  meta: {
-    name: 'nuxt-openapi-hyperfetch',
-    configKey: 'openApiHyperFetch',
-  },
-
-  defaults: {
-    output: './composables/api',
-    generators: ['useFetch', 'useAsyncData'],
-    backend: 'heyapi',
-    enableDevBuild: true,
-    enableProductionBuild: true,
-    enableAutoGeneration: false,
-    enableAutoImport: true,
-  },
-
-  setup(options: ModuleOptions, nuxt) {
-    // --- Guard: input is required ---
-    if (!options.input) {
-      console.warn(
-        '[nuxt-openapi-hyperfetch] No input configured — skipping generation.\n' +
-          "Add `openApiHyperFetch: { input: './swagger.yaml' }` to your nuxt.config.ts"
-      );
-      return;
-    }
-
-    const resolvedInput = path.resolve(nuxt.options.rootDir, options.input);
-    const resolvedOutput = path.resolve(nuxt.options.rootDir, options.output!);
-    const composablesOutputDir = path.join(resolvedOutput, 'composables');
-    const selectedGenerators = options.generators ?? ['useFetch', 'useAsyncData'];
-    const backend = options.backend ?? 'heyapi';
-    const logger = createConsoleLogger();
-
-    // --- Core generation function ---
-    const runGeneration = async () => {
-      logger.log.info('Generating OpenAPI composables...');
-
-      // 1. Generate OpenAPI SDK files
-      if (backend === 'official') {
-        if (!checkJavaInstalled()) {
-          throw new Error(
-            '[nuxt-openapi-hyperfetch] Java not found. The official backend requires Java 11+.\n' +
-              'Install from: https://adoptium.net or set backend: "heyapi" in nuxt.config.ts'
-          );
-        }
-        execSync(
-          `npx @openapitools/openapi-generator-cli generate -i "${resolvedInput}" -g typescript-fetch -o "${resolvedOutput}"`,
-          { stdio: 'inherit' }
-        );
-      } else {
-        const { createClient } = await import('@hey-api/openapi-ts');
-        await createClient({
-          input: resolvedInput,
-          output: resolvedOutput,
-          plugins: ['@hey-api/typescript', '@hey-api/sdk'],
-        });
-      }
-
-      // 2. Run selected composable generators
-      const genOptions = { backend };
-
-      if (selectedGenerators.includes('useFetch')) {
-        await generateUseFetchComposables(
-          resolvedOutput,
-          path.join(composablesOutputDir, 'use-fetch'),
-          genOptions,
-          logger
-        );
-      }
-
-      if (selectedGenerators.includes('useAsyncData')) {
-        await generateUseAsyncDataComposables(
-          resolvedOutput,
-          path.join(composablesOutputDir, 'use-async-data'),
-          genOptions,
-          logger
-        );
-      }
-
-      if (selectedGenerators.includes('nuxtServer')) {
-        const serverRoutePath = path.resolve(
-          nuxt.options.rootDir,
-          options.serverRoutePath ?? 'server/routes/api'
-        );
-        await generateNuxtServerRoutes(
-          resolvedOutput,
-          serverRoutePath,
-          { enableBff: options.enableBff, backend },
-          logger
-        );
-      }
-    };
-
-    // --- Hooks: dev build / production build ---
-    const isDev = nuxt.options.dev;
-    if ((isDev && options.enableDevBuild) || (!isDev && options.enableProductionBuild)) {
-      nuxt.hook('build:before', runGeneration);
-    }
-
-    // --- Hook: auto-regeneration on input file change (dev only) ---
-    if (options.enableAutoGeneration) {
-      nuxt.hook('builder:watch', async (event: string, watchedPath: string) => {
-        const absWatchedPath = path.resolve(nuxt.options.rootDir, watchedPath);
-        if (absWatchedPath === resolvedInput && (event === 'change' || event === 'add')) {
-          logger.log.info(`Detected change in ${watchedPath}, regenerating composables...`);
-          await runGeneration();
-        }
-      });
-    }
-
-    // --- Auto-import: register composable directories ---
-    if (options.enableAutoImport !== false) {
-      if (selectedGenerators.includes('useFetch')) {
-        addImportsDir(path.join(composablesOutputDir, 'use-fetch', 'composables'));
-      }
-      if (selectedGenerators.includes('useAsyncData')) {
-        addImportsDir(path.join(composablesOutputDir, 'use-async-data', 'composables'));
-      }
-    }
-  },
-});
-
-export type { ModuleOptions };
+import { defineNuxtModule, addImportsDir } from '@nuxt/kit';
+import { execSync } from 'child_process';
+import * as path from 'path';
+import { checkJavaInstalled } from '../generate.js';
+import { generateUseFetchComposables } from '../generators/use-fetch/generator.js';
+import { generateUseAsyncDataComposables } from '../generators/use-async-data/generator.js';
+import { generateNuxtServerRoutes } from '../generators/nuxt-server/generator.js';
+import { generateConnectors } from '../generators/components/connector-generator/generator.js';
+import { createConsoleLogger } from '../cli/logger.js';
+import type { ModuleOptions } from './types.js';
+
+export default defineNuxtModule<ModuleOptions>({
+  meta: {
+    name: 'nuxt-openapi-hyperfetch',
+    configKey: 'openApiHyperFetch',
+  },
+
+  defaults: {
+    output: './composables/api',
+    generators: ['useFetch', 'useAsyncData'],
+    backend: 'heyapi',
+    enableDevBuild: true,
+    enableProductionBuild: true,
+    enableAutoGeneration: false,
+    enableAutoImport: true,
+    createUseAsyncDataConnectors: false,
+  },
+
+  setup(options: ModuleOptions, nuxt) {
+    // --- Guard: input is required ---
+    if (!options.input) {
+      console.warn(
+        '[nuxt-openapi-hyperfetch] No input configured — skipping generation.\n' +
+          "Add `openApiHyperFetch: { input: './swagger.yaml' }` to your nuxt.config.ts"
+      );
+      return;
+    }
+
+    const resolvedInput = path.resolve(nuxt.options.rootDir, options.input);
+    const resolvedOutput = path.resolve(nuxt.options.rootDir, options.output!);
+    const composablesOutputDir = path.join(resolvedOutput, 'composables');
+    const selectedGenerators = options.generators ?? ['useFetch', 'useAsyncData'];
+    const backend = options.backend ?? 'heyapi';
+    const logger = createConsoleLogger();
+
+    // --- Core generation function ---
+    const runGeneration = async () => {
+      logger.log.info('Generating OpenAPI composables...');
+
+      // 1. Generate OpenAPI SDK files
+      if (backend === 'official') {
+        if (!checkJavaInstalled()) {
+          throw new Error(
+            '[nuxt-openapi-hyperfetch] Java not found. The official backend requires Java 11+.\n' +
+              'Install from: https://adoptium.net or set backend: "heyapi" in nuxt.config.ts'
+          );
+        }
+        execSync(
+          `npx @openapitools/openapi-generator-cli generate -i "${resolvedInput}" -g typescript-fetch -o "${resolvedOutput}"`,
+          { stdio: 'inherit' }
+        );
+      } else {
+        const { createClient } = await import('@hey-api/openapi-ts');
+        await createClient({
+          input: resolvedInput,
+          output: resolvedOutput,
+          plugins: ['@hey-api/typescript', '@hey-api/sdk'],
+        });
+      }
+
+      // 2. Run selected composable generators
+      const genOptions = { backend };
+
+      if (selectedGenerators.includes('useFetch')) {
+        await generateUseFetchComposables(
+          resolvedOutput,
+          path.join(composablesOutputDir, 'use-fetch'),
+          genOptions,
+          logger
+        );
+      }
+
+      if (selectedGenerators.includes('useAsyncData')) {
+        await generateUseAsyncDataComposables(
+          resolvedOutput,
+          path.join(composablesOutputDir, 'use-async-data'),
+          genOptions,
+          logger
+        );
+      }
+
+      if (selectedGenerators.includes('nuxtServer')) {
+        const serverRoutePath = path.resolve(
+          nuxt.options.rootDir,
+          options.serverRoutePath ?? 'server/routes/api'
+        );
+        await generateNuxtServerRoutes(
+          resolvedOutput,
+          serverRoutePath,
+          { enableBff: options.enableBff, backend },
+          logger
+        );
+      }
+
+      // 3. Generate headless connectors if requested (requires useAsyncData)
+      if (
+        options.createUseAsyncDataConnectors &&
+        selectedGenerators.includes('useAsyncData')
+      ) {
+        const connectorsOutputDir = path.join(composablesOutputDir, 'connectors');
+        const runtimeDir = path.join(resolvedOutput, 'runtime');
+        await generateConnectors(
+          {
+            inputSpec: resolvedInput,
+            outputDir: connectorsOutputDir,
+            composablesRelDir: '../use-async-data',
+            runtimeRelDir: '../../runtime',
+          },
+          logger
+        );
+        // Register #nxh alias so generated connector imports resolve
+        nuxt.options.alias['#nxh'] = runtimeDir;
+      }
+    };
+
+    // --- Hooks: dev build / production build ---
+    const isDev = nuxt.options.dev;
+    if ((isDev && options.enableDevBuild) || (!isDev && options.enableProductionBuild)) {
+      nuxt.hook('build:before', runGeneration);
+    }
+
+    // --- Hook: auto-regeneration on input file change (dev only) ---
+    if (options.enableAutoGeneration) {
+      nuxt.hook('builder:watch', async (event: string, watchedPath: string) => {
+        const absWatchedPath = path.resolve(nuxt.options.rootDir, watchedPath);
+        if (absWatchedPath === resolvedInput && (event === 'change' || event === 'add')) {
+          logger.log.info(`Detected change in ${watchedPath}, regenerating composables...`);
+          await runGeneration();
+        }
+      });
+    }
+
+    // --- Auto-import: register composable directories ---
+    if (options.enableAutoImport !== false) {
+      if (selectedGenerators.includes('useFetch')) {
+        addImportsDir(path.join(composablesOutputDir, 'use-fetch', 'composables'));
+      }
+      if (selectedGenerators.includes('useAsyncData')) {
+        addImportsDir(path.join(composablesOutputDir, 'use-async-data', 'composables'));
+      }
+      if (options.createUseAsyncDataConnectors && selectedGenerators.includes('useAsyncData')) {
+        addImportsDir(path.join(composablesOutputDir, 'connectors'));
+      }
+    }
+  },
+});
+
+export type { ModuleOptions };

package/src/module/types.ts

@@ -1,31 +1,39 @@
-import type { GeneratorConfig } from '../cli/config.js';
-
-/**
- * Configuration options for the nuxt-openapi-hyperfetch Nuxt module.
- * Extends the CLI GeneratorConfig so the same fields work in both nxh.config.js and nuxt.config.ts.
- */
-export interface ModuleOptions extends GeneratorConfig {
-  /**
-   * Generate composables before the dev server starts.
-   * @default true
-   */
-  enableDevBuild?: boolean;
-
-  /**
-   * Generate composables before the production build.
-   * @default true
-   */
-  enableProductionBuild?: boolean;
-
-  /**
-   * Watch the input file and regenerate composables on change (dev mode only).
-   * @default false
-   */
-  enableAutoGeneration?: boolean;
-
-  /**
-   * Automatically import generated useFetch/useAsyncData composables project-wide.
-   * @default true
-   */
-  enableAutoImport?: boolean;
-}
+import type { GeneratorConfig } from '../cli/config.js';
+
+/**
+ * Configuration options for the nuxt-openapi-hyperfetch Nuxt module.
+ * Extends the CLI GeneratorConfig so the same fields work in both nxh.config.js and nuxt.config.ts.
+ */
+export interface ModuleOptions extends GeneratorConfig {
+  /**
+   * Generate composables before the dev server starts.
+   * @default true
+   */
+  enableDevBuild?: boolean;
+
+  /**
+   * Generate composables before the production build.
+   * @default true
+   */
+  enableProductionBuild?: boolean;
+
+  /**
+   * Watch the input file and regenerate composables on change (dev mode only).
+   * @default false
+   */
+  enableAutoGeneration?: boolean;
+
+  /**
+   * Automatically import generated useFetch/useAsyncData composables project-wide.
+   * @default true
+   */
+  enableAutoImport?: boolean;
+
+  /**
+   * Generate headless UI connector composables on top of useAsyncData.
+   * Connectors provide ready-made logic for tables, pagination, forms and delete actions.
+   * Requires useAsyncData to also be in generators.
+   * @default false
+   */
+  createUseAsyncDataConnectors?: boolean;
+}