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

package/src/cli/logger.ts

@@ -1,124 +1,124 @@
-/**
- * Centralized logging utilities using @clack/prompts
- * Re-exports @clack for easy use across the project
- */
-import * as p from '@clack/prompts';
-
-/**
- * Re-export @clack/prompts for consistent usage
- */
-export { p };
-
-/**
- * Create and manage a spinner for long operations
- *
- * @example
- * const spinner = createSpinner();
- * spinner.start('Processing files');
- * // do work
- * spinner.stop('Files processed');
- */
-export function createSpinner() {
-  return p.spinner();
-}
-
-/**
- * Log a success message (replaces console.log with ✓)
- */
-export function logSuccess(message: string) {
-  p.log.success(message);
-}
-
-/**
- * Log an error message
- */
-export function logError(message: string) {
-  p.log.error(message);
-}
-
-/**
- * Log a warning message
- */
-export function logWarning(message: string) {
-  p.log.warn(message);
-}
-
-/**
- * Log an info message
- */
-export function logInfo(message: string) {
-  p.log.info(message);
-}
-
-/**
- * Display a note/box with multiple lines of information
- * Great for "Next steps" sections
- */
-export function logNote(message: string, title?: string) {
-  p.note(message, title);
-}
-
-/**
- * Display section separator
- */
-export function logStep(message: string) {
-  p.log.step(message);
-}
-
-// ---------------------------------------------------------------------------
-// Logger abstraction — allows generators to run in both CLI and Nuxt module
-// ---------------------------------------------------------------------------
-
-/**
- * Abstract logger interface used by generators.
- * Decouples generator output from @clack/prompts so the same generators work
- * in the interactive CLI and in the Nuxt module (where clack is irrelevant).
- */
-export interface Logger {
-  spinner(): { start(msg: string): void; stop(msg: string): void };
-  log: {
-    warn(msg: string): void;
-    info(msg: string): void;
-    success(msg: string): void;
-    error(msg: string): void;
-  };
-  note(msg: string, title?: string): void;
-}
-
-/**
- * Creates a Logger backed by @clack/prompts — used by the CLI.
- */
-export function createClackLogger(): Logger {
-  return {
-    spinner: () => p.spinner(),
-    log: {
-      warn: (msg) => p.log.warn(msg),
-      info: (msg) => p.log.info(msg),
-      success: (msg) => p.log.success(msg),
-      error: (msg) => p.log.error(msg),
-    },
-    note: (msg, title) => p.note(msg, title),
-  };
-}
-
-/**
- * Creates a Logger backed by console — used by the Nuxt module.
- */
-export function createConsoleLogger(): Logger {
-  const prefix = '[nuxt-openapi-hyperfetch]';
-  return {
-    spinner() {
-      return {
-        start: (msg: string) => console.log(`${prefix} ⏳ ${msg}`),
-        stop: (msg: string) => console.log(`${prefix} ✓ ${msg}`),
-      };
-    },
-    log: {
-      warn: (msg) => console.warn(`${prefix} ⚠ ${msg}`),
-      info: (msg) => console.info(`${prefix} ℹ ${msg}`),
-      success: (msg) => console.log(`${prefix} ✓ ${msg}`),
-      error: (msg) => console.error(`${prefix} ✗ ${msg}`),
-    },
-    note: (msg, title) => console.log(title ? `\n${prefix} ${title}:\n${msg}\n` : `\n${msg}\n`),
-  };
-}
+/**
+ * Centralized logging utilities using @clack/prompts
+ * Re-exports @clack for easy use across the project
+ */
+import * as p from '@clack/prompts';
+
+/**
+ * Re-export @clack/prompts for consistent usage
+ */
+export { p };
+
+/**
+ * Create and manage a spinner for long operations
+ *
+ * @example
+ * const spinner = createSpinner();
+ * spinner.start('Processing files');
+ * // do work
+ * spinner.stop('Files processed');
+ */
+export function createSpinner() {
+  return p.spinner();
+}
+
+/**
+ * Log a success message (replaces console.log with ✓)
+ */
+export function logSuccess(message: string) {
+  p.log.success(message);
+}
+
+/**
+ * Log an error message
+ */
+export function logError(message: string) {
+  p.log.error(message);
+}
+
+/**
+ * Log a warning message
+ */
+export function logWarning(message: string) {
+  p.log.warn(message);
+}
+
+/**
+ * Log an info message
+ */
+export function logInfo(message: string) {
+  p.log.info(message);
+}
+
+/**
+ * Display a note/box with multiple lines of information
+ * Great for "Next steps" sections
+ */
+export function logNote(message: string, title?: string) {
+  p.note(message, title);
+}
+
+/**
+ * Display section separator
+ */
+export function logStep(message: string) {
+  p.log.step(message);
+}
+
+// ---------------------------------------------------------------------------
+// Logger abstraction — allows generators to run in both CLI and Nuxt module
+// ---------------------------------------------------------------------------
+
+/**
+ * Abstract logger interface used by generators.
+ * Decouples generator output from @clack/prompts so the same generators work
+ * in the interactive CLI and in the Nuxt module (where clack is irrelevant).
+ */
+export interface Logger {
+  spinner(): { start(msg: string): void; stop(msg: string): void };
+  log: {
+    warn(msg: string): void;
+    info(msg: string): void;
+    success(msg: string): void;
+    error(msg: string): void;
+  };
+  note(msg: string, title?: string): void;
+}
+
+/**
+ * Creates a Logger backed by @clack/prompts — used by the CLI.
+ */
+export function createClackLogger(): Logger {
+  return {
+    spinner: () => p.spinner(),
+    log: {
+      warn: (msg) => p.log.warn(msg),
+      info: (msg) => p.log.info(msg),
+      success: (msg) => p.log.success(msg),
+      error: (msg) => p.log.error(msg),
+    },
+    note: (msg, title) => p.note(msg, title),
+  };
+}
+
+/**
+ * Creates a Logger backed by console — used by the Nuxt module.
+ */
+export function createConsoleLogger(): Logger {
+  const prefix = '[nuxt-openapi-hyperfetch]';
+  return {
+    spinner() {
+      return {
+        start: (msg: string) => console.log(`${prefix} ⏳ ${msg}`),
+        stop: (msg: string) => console.log(`${prefix} ✓ ${msg}`),
+      };
+    },
+    log: {
+      warn: (msg) => console.warn(`${prefix} ⚠ ${msg}`),
+      info: (msg) => console.info(`${prefix} ℹ ${msg}`),
+      success: (msg) => console.log(`${prefix} ✓ ${msg}`),
+      error: (msg) => console.error(`${prefix} ✗ ${msg}`),
+    },
+    note: (msg, title) => console.log(title ? `\n${prefix} ${title}:\n${msg}\n` : `\n${msg}\n`),
+  };
+}

package/src/cli/logo.ts

@@ -1,25 +1,25 @@
-import gradient from 'gradient-string';
-
-const NUXT_LOGO = `███╗   ██╗██╗   ██╗██╗  ██╗████████╗
-████╗  ██║██║   ██║╚██╗██╔╝╚══██╔══╝
-██╔██╗ ██║██║   ██║ ╚███╔╝    ██║
-██║╚██╗██║██║   ██║ ██╔██╗    ██║
-██║ ╚████║╚██████╔╝██╔╝ ██╗   ██║
-╚═╝  ╚═══╝ ╚═════╝ ╚═╝  ╚═╝   ╚═╝`;
-
-const SUBTITLE = 'Nuxt OpenAPI Generator - useFetch, useAsyncData & Nuxt server';
-
-/**
- * Display the Nuxt logo with gradient colors
- * - Green gradient for Nuxt logo (official Nuxt color #00DC82)
- * - Blue gradient for Swagger subtitle
- */
-export function displayLogo(): void {
-  const nuxtGradient = gradient('#00DC82', '#00E090');
-  const swaggerGradient = gradient('#3B82F6', '#0EA5E9');
-
-  console.log('\n');
-  console.log(nuxtGradient(NUXT_LOGO));
-  console.log(swaggerGradient(SUBTITLE));
-  console.log('\n');
-}
+import gradient from 'gradient-string';
+
+const NUXT_LOGO = `███╗   ██╗██╗   ██╗██╗  ██╗████████╗
+████╗  ██║██║   ██║╚██╗██╔╝╚══██╔══╝
+██╔██╗ ██║██║   ██║ ╚███╔╝    ██║
+██║╚██╗██║██║   ██║ ██╔██╗    ██║
+██║ ╚████║╚██████╔╝██╔╝ ██╗   ██║
+╚═╝  ╚═══╝ ╚═════╝ ╚═╝  ╚═╝   ╚═╝`;
+
+const SUBTITLE = 'Nuxt OpenAPI Generator - useFetch, useAsyncData & Nuxt server';
+
+/**
+ * Display the Nuxt logo with gradient colors
+ * - Green gradient for Nuxt logo (official Nuxt color #00DC82)
+ * - Blue gradient for Swagger subtitle
+ */
+export function displayLogo(): void {
+  const nuxtGradient = gradient('#00DC82', '#00E090');
+  const swaggerGradient = gradient('#3B82F6', '#0EA5E9');
+
+  console.log('\n');
+  console.log(nuxtGradient(NUXT_LOGO));
+  console.log(swaggerGradient(SUBTITLE));
+  console.log('\n');
+}

package/src/cli/messages.ts

@@ -67,6 +67,10 @@ export const CHOICES = {
     },
   ],
 
+  // Connectors prompt (shown only when useAsyncData is selected)
+  connectorsPrompt:
+    'Generate headless UI connectors? (tables, pagination, forms & delete logic built on top of useAsyncData)',
+
   // Server path options
   serverPaths: [
     {

package/src/cli/prompts.ts

@@ -96,7 +96,7 @@ export async function promptComposablesSelection(): Promise<ComposablesSelection
   });
   checkCancellation(result);
 
-  return { composables: result as ComposableType[] };
+  return { composables: result as ('useFetch' | 'useAsyncData' | 'nuxtServer')[] };
 }
 
 /**
@@ -141,3 +141,16 @@ export async function promptBffConfig(): Promise<BffConfig> {
 
   return { enableBff: result as boolean };
 }
+
+/**
+ * Ask whether to generate headless UI connectors on top of useAsyncData.
+ * Only called when useAsyncData was selected and no config value is present.
+ */
+export async function promptConnectors(): Promise<boolean> {
+  const result = await p.confirm({
+    message: CHOICES.connectorsPrompt,
+    initialValue: false,
+  });
+  checkCancellation(result);
+  return result as boolean;
+}

package/src/cli/types.ts

@@ -1,50 +1,50 @@
-/**
- * TypeScript types for CLI prompts and responses
- */
-
-/**
- * Generator backend selector (internal)
- */
-export type GeneratorBackend = 'official' | 'heyapi';
-
-/**
- * Generator engine value for nxh.config — user-facing alias
- * 'openapi' maps to the official Java-based OpenAPI Generator
- * 'heyapi' maps to @hey-api/openapi-ts (Node.js native)
- */
-export type ConfigGenerator = 'openapi' | 'heyapi';
-
-/**
- * Initial input and output paths
- */
-export interface InitialInputs {
-  inputPath: string;
-  outputPath: string;
-}
-
-/**
- * Composables selection (checkbox response)
- */
-export interface ComposablesSelection {
-  composables: Array<'useFetch' | 'useAsyncData' | 'nuxtServer'>;
-}
-
-/**
- * Server route path configuration
- */
-export interface ServerRouteConfig {
-  serverPath: string;
-  customPath?: string;
-}
-
-/**
- * BFF (Backend for Frontend) configuration
- */
-export interface BffConfig {
-  enableBff: boolean;
-}
-
-/**
- * Valid composable types
- */
-export type ComposableType = 'useFetch' | 'useAsyncData' | 'nuxtServer';
+/**
+ * TypeScript types for CLI prompts and responses
+ */
+
+/**
+ * Generator backend selector (internal)
+ */
+export type GeneratorBackend = 'official' | 'heyapi';
+
+/**
+ * Generator engine value for nxh.config — user-facing alias
+ * 'openapi' maps to the official Java-based OpenAPI Generator
+ * 'heyapi' maps to @hey-api/openapi-ts (Node.js native)
+ */
+export type ConfigGenerator = 'openapi' | 'heyapi';
+
+/**
+ * Initial input and output paths
+ */
+export interface InitialInputs {
+  inputPath: string;
+  outputPath: string;
+}
+
+/**
+ * Composables selection (checkbox response)
+ */
+export interface ComposablesSelection {
+  composables: Array<'useFetch' | 'useAsyncData' | 'nuxtServer'>;
+}
+
+/**
+ * Server route path configuration
+ */
+export interface ServerRouteConfig {
+  serverPath: string;
+  customPath?: string;
+}
+
+/**
+ * BFF (Backend for Frontend) configuration
+ */
+export interface BffConfig {
+  enableBff: boolean;
+}
+
+/**
+ * Valid composable types
+ */
+export type ComposableType = 'useFetch' | 'useAsyncData' | 'nuxtServer' | 'connectors';

package/src/generators/components/connector-generator/generator.ts

@@ -0,0 +1,138 @@
+import * as path from 'path';
+import fs from 'fs-extra';
+import { fileURLToPath } from 'url';
+import { format } from 'prettier';
+import { analyzeSpec } from '../schema-analyzer/index.js';
+import {
+  generateConnectorFile,
+  connectorFileName,
+  generateConnectorIndexFile,
+} from './templates.js';
+import type { ConnectorGeneratorOptions } from './types.js';
+import { type Logger, createClackLogger } from '../../../cli/logger.js';
+
+// Runtime files that must be copied to the user's project
+const RUNTIME_FILES = [
+  'useListConnector.ts',
+  'useDetailConnector.ts',
+  'useFormConnector.ts',
+  'useDeleteConnector.ts',
+  'zod-error-merger.ts',
+] as const;
+
+/**
+ * Format TypeScript source with Prettier.
+ * Falls back to unformatted code on error.
+ */
+async function formatCode(code: string, logger: Logger): Promise<string> {
+  try {
+    return await format(code, { parser: 'typescript' });
+  } catch (error) {
+    logger.log.warn(`Prettier formatting failed: ${String(error)}`);
+    return code;
+  }
+}
+
+/**
+ * Generate headless connector composables from an OpenAPI spec.
+ *
+ * Steps:
+ *  1. Analyze the spec → ResourceMap (Schema Analyzer)
+ *  2. For each resource: generate connector source, format, write
+ *  3. Write an index barrel file
+ *  4. Copy runtime helpers to the user's project
+ */
+export async function generateConnectors(
+  options: ConnectorGeneratorOptions,
+  logger: Logger = createClackLogger()
+): Promise<void> {
+  const spinner = logger.spinner();
+
+  const outputDir = path.resolve(options.outputDir);
+  const composablesRelDir = options.composablesRelDir ?? '../use-async-data';
+  const runtimeRelDir = options.runtimeRelDir ?? '../runtime';
+
+  // ── 1. Analyze spec ───────────────────────────────────────────────────────
+  spinner.start('Analyzing OpenAPI spec');
+  const resourceMap = analyzeSpec(options.inputSpec);
+  spinner.stop(`Found ${resourceMap.size} resource(s)`);
+
+  if (resourceMap.size === 0) {
+    logger.log.warn('No resources found in spec — nothing to generate');
+    return;
+  }
+
+  // ── 2. Prepare output directory ───────────────────────────────────────────
+  // emptyDir (not ensureDir) so stale connectors from previous runs are removed.
+  // If the resource got renamed in the spec the old file would otherwise linger.
+  spinner.start('Preparing output directory');
+  await fs.emptyDir(outputDir);
+  spinner.stop('Output directory ready');
+
+  // ── 3. Generate connector files ───────────────────────────────────────────
+  spinner.start('Generating connector composables');
+  let successCount = 0;
+  let errorCount = 0;
+  const generatedNames: string[] = [];
+
+  for (const resource of resourceMap.values()) {
+    try {
+      const code = generateConnectorFile(resource, composablesRelDir);
+      const formatted = await formatCode(code, logger);
+      const fileName = connectorFileName(resource.composableName);
+      const filePath = path.join(outputDir, fileName);
+
+      await fs.writeFile(filePath, formatted, 'utf-8');
+      generatedNames.push(resource.composableName);
+      successCount++;
+    } catch (error) {
+      logger.log.error(`Error generating ${resource.composableName}: ${String(error)}`);
+      errorCount++;
+    }
+  }
+
+  spinner.stop(`Generated ${successCount} connector(s)`);
+
+  // ── 4. Write barrel index ─────────────────────────────────────────────────
+  if (generatedNames.length > 0) {
+    try {
+      const indexCode = generateConnectorIndexFile(generatedNames);
+      const formattedIndex = await formatCode(indexCode, logger);
+      await fs.writeFile(path.join(outputDir, 'index.ts'), formattedIndex, 'utf-8');
+    } catch (error) {
+      logger.log.warn(`Could not write connector index: ${String(error)}`);
+    }
+  }
+
+  // ── 5. Copy runtime helpers ───────────────────────────────────────────────
+  // Runtime files (useListConnector, useFormConnector …) live in src/ and must
+  // be physical .ts files in the user's project so Nuxt/Vite can type-check them.
+  //
+  // Path resolution trick:
+  //   •  During development (ts-node / tsx):  __dirname ≈ src/generators/components/connector-generator/
+  //   •  After `tsc` build:                   __dirname ≈ dist/generators/components/connector-generator/
+  //
+  // In both cases we need to land in src/generators/shared/runtime/, so we step
+  // up 4 levels and then re-enter src/ explicitly.  This works because the repo
+  // always keeps src/ alongside dist/ in the published package (see "files" in package.json).
+  spinner.start('Copying runtime files');
+  const runtimeDir = path.resolve(outputDir, runtimeRelDir);
+  await fs.ensureDir(runtimeDir); // ensureDir (not emptyDir) — other runtime files may exist there
+
+  const __dirname = path.dirname(fileURLToPath(import.meta.url));
+  const runtimeSrcDir = path.resolve(__dirname, '../../../../src/generators/shared/runtime');
+
+  for (const file of RUNTIME_FILES) {
+    const src = path.join(runtimeSrcDir, file);
+    const dest = path.join(runtimeDir, file);
+    await fs.copyFile(src, dest);
+  }
+
+  spinner.stop('Runtime files copied');
+
+  // ── 6. Summary ────────────────────────────────────────────────────────────
+  if (errorCount > 0) {
+    logger.log.warn(`Completed with ${errorCount} error(s)`);
+  }
+  logger.log.success(`Generated ${successCount} connector(s) in ${outputDir}`);
+}