nuxt-openapi-hyperfetch 0.2.7-alpha.1 → 0.3.0-beta

package/dist/generators/components/connector-generator/templates.js

@@ -1,18 +1,18 @@
 import { pascalCase, kebabCase } from 'change-case';
 // ─── File header ──────────────────────────────────────────────────────────────
 function generateFileHeader() {
-    return `/**
- * ⚠️ AUTO-GENERATED FILE - DO NOT EDIT MANUALLY
- *
- * This file was automatically generated by nuxt-openapi-generator.
- * Any manual changes will be overwritten on the next generation.
- *
- * @generated by nuxt-openapi-generator
- * @see https://github.com/dmartindiaz/nuxt-openapi-hyperfetch
- */
-
-/* eslint-disable */
-// @ts-nocheck
+    return `/**
+ * ⚠️ AUTO-GENERATED FILE - DO NOT EDIT MANUALLY
+ *
+ * This file was automatically generated by nuxt-openapi-generator.
+ * Any manual changes will be overwritten on the next generation.
+ *
+ * @generated by nuxt-openapi-generator
+ * @see https://github.com/dmartindiaz/nuxt-openapi-hyperfetch
+ */
+
+/* eslint-disable */
+// @ts-nocheck
 `;
 }
 // ─── Naming helpers ───────────────────────────────────────────────────────────
@@ -103,19 +103,59 @@ function buildZodSchemas(resource) {
     }
     return lines.join('\n');
 }
+/**
+ * Build a const array with the column definitions inferred from the resource.
+ * Returns an empty string if the resource has no columns.
+ */
+function buildColumns(resource) {
+    if (!resource.columns || resource.columns.length === 0) {
+        return '';
+    }
+    const camel = resource.composableName
+        .replace(/^use/, '')
+        .replace(/Connector$/, '')
+        .replace(/^./, (c) => c.toLowerCase());
+    const varName = `${camel}Columns`;
+    const entries = resource.columns
+        .map((col) => `  { key: '${col.key}', label: '${col.label}', type: '${col.type}' }`)
+        .join(',\n');
+    return `const ${varName} = [\n${entries},\n];`;
+}
 /**
  * Build the body of the exported connector function.
  */
 function buildFunctionBody(resource) {
     const pascal = pascalCase(resource.name);
+    const hasColumns = resource.columns && resource.columns.length > 0;
+    const camel = resource.composableName
+        .replace(/^use/, '')
+        .replace(/Connector$/, '')
+        .replace(/^./, (c) => c.toLowerCase());
+    const columnsVar = `${camel}Columns`;
     const subConnectors = [];
+    // Destructure options param — only what's relevant for this resource
+    const optionKeys = [];
+    if (resource.listEndpoint && hasColumns) {
+        optionKeys.push('columnLabels', 'columnLabel');
+    }
+    if (resource.createEndpoint && resource.zodSchemas.create) {
+        optionKeys.push('createSchema');
+    }
+    if (resource.updateEndpoint && resource.zodSchemas.update) {
+        optionKeys.push('updateSchema');
+    }
+    const optionsDestructure = optionKeys.length > 0 ? `  const { ${optionKeys.join(', ')} } = options;\n` : '';
     if (resource.listEndpoint) {
         const fn = toAsyncDataName(resource.listEndpoint.operationId);
         // paginated: true tells useListConnector to expose pagination helpers
         // (goToPage, nextPage, prevPage, setPerPage, pagination ref).
         // We set it whenever the spec declares a list endpoint that has a response schema,
         // which is a reliable proxy for "this API returns structured data worth paginating".
-        const opts = resource.listEndpoint.responseSchema ? '{ paginated: true }' : '{}';
+        const paginatedFlag = resource.listEndpoint.responseSchema ? 'paginated: true' : '';
+        const columnsArg = hasColumns ? `columns: ${columnsVar}` : '';
+        const labelArgs = hasColumns ? 'columnLabels, columnLabel' : '';
+        const allArgs = [paginatedFlag, columnsArg, labelArgs].filter(Boolean).join(', ');
+        const opts = allArgs ? `{ ${allArgs} }` : '{}';
         subConnectors.push(`  const table = useListConnector(${fn}, ${opts});`);
     }
     if (resource.detailEndpoint) {
@@ -124,7 +164,9 @@ function buildFunctionBody(resource) {
     }
     if (resource.createEndpoint) {
         const fn = toAsyncDataName(resource.createEndpoint.operationId);
-        const schemaArg = resource.zodSchemas.create ? `{ schema: ${pascal}CreateSchema }` : '{}';
+        const schemaArg = resource.zodSchemas.create
+            ? `{ schema: ${pascal}CreateSchema, schemaOverride: createSchema }`
+            : '{}';
         subConnectors.push(`  const createForm = useFormConnector(${fn}, ${schemaArg});`);
     }
     if (resource.updateEndpoint) {
@@ -139,11 +181,11 @@ function buildFunctionBody(resource) {
         let schemaArg = '{}';
         if (resource.zodSchemas.update && hasDetail) {
             // Best case: validate AND pre-fill from detail
-            schemaArg = `{ schema: ${pascal}UpdateSchema, loadWith: detail }`;
+            schemaArg = `{ schema: ${pascal}UpdateSchema, schemaOverride: updateSchema, loadWith: detail }`;
         }
         else if (resource.zodSchemas.update) {
             // Validate, but no detail endpoint to pre-fill from
-            schemaArg = `{ schema: ${pascal}UpdateSchema }`;
+            schemaArg = `{ schema: ${pascal}UpdateSchema, schemaOverride: updateSchema }`;
         }
         else if (hasDetail) {
             // No Zod schema (no request body in spec), but still pre-fill from detail
@@ -174,11 +216,14 @@ function buildFunctionBody(resource) {
     }
     const returnStatement = `  return { ${returnKeys.join(', ')} };`;
     return [
-        `export function ${resource.composableName}() {`,
+        `export function ${resource.composableName}(options = {}) {`,
+        optionsDestructure.trimEnd(),
         ...subConnectors,
         returnStatement,
         `}`,
-    ].join('\n');
+    ]
+        .filter((s) => s !== '')
+        .join('\n');
 }
 // ─── Public API ───────────────────────────────────────────────────────────────
 /**
@@ -192,14 +237,18 @@ export function generateConnectorFile(resource, composablesRelDir) {
     const header = generateFileHeader();
     const imports = buildImports(resource, composablesRelDir);
     const schemas = buildZodSchemas(resource);
+    const columns = buildColumns(resource);
     const fn = buildFunctionBody(resource);
-    // Assemble file: header + imports + (optional) Zod blocks + function body.
+    // Assemble file: header + imports + (optional) Zod blocks + columns const + function body.
     // Each section ends with its own trailing newline; join with \n adds one blank
     // line between sections, which matches Prettier's output for this structure.
     const parts = [header, imports];
     if (schemas.trim()) {
         parts.push(schemas);
     }
+    if (columns.trim()) {
+        parts.push(columns);
+    }
     parts.push(fn);
     return parts.join('\n') + '\n';
 }

package/dist/generators/shared/runtime/useFormConnector.js

@@ -18,7 +18,14 @@ import { mergeZodErrors } from './zod-error-merger.js';
  * @param options        { schema, fields, loadWith?, errorConfig? }
  */
 export function useFormConnector(composableFn, options = {}) {
-    const { schema, fields = [], loadWith = null, errorConfig = {} } = options;
+    const { schema: baseSchema, schemaOverride, fields = [], loadWith = null, errorConfig = {} } = options;
+    // Resolve the active schema:
+    //   schemaOverride(base) — extend or refine the generated schema
+    //   schemaOverride        — replace the generated schema entirely
+    //   baseSchema            — the generated schema unchanged (default)
+    const schema = schemaOverride
+        ? (typeof schemaOverride === 'function' ? schemaOverride(baseSchema) : schemaOverride)
+        : baseSchema;
     // ── Form state ─────────────────────────────────────────────────────────────
     const model = ref({});
     const errors = ref({});

package/dist/generators/shared/runtime/useListConnector.js

@@ -16,7 +16,7 @@ import { ref, computed, shallowRef } from 'vue';
  * @param options       Configuration for the list connector
  */
 export function useListConnector(composableFn, options = {}) {
-    const { paginated = false, columns = [] } = options;
+    const { paginated = false, columns = [], columnLabels = {}, columnLabel = null } = options;
     // ── Execute the underlying composable ──────────────────────────────────────
     const composable = composableFn({ paginated });
     // ── Derived state ──────────────────────────────────────────────────────────
@@ -36,16 +36,16 @@ export function useListConnector(composableFn, options = {}) {
     // Pagination — passthrough from the underlying composable when paginated: true
     const pagination = computed(() => composable.pagination?.value ?? null);
     function goToPage(page) {
-        composable.goToPage?.(page);
+        composable.pagination?.value?.goToPage?.(page);
     }
     function nextPage() {
-        composable.nextPage?.();
+        composable.pagination?.value?.nextPage?.();
     }
     function prevPage() {
-        composable.prevPage?.();
+        composable.pagination?.value?.prevPage?.();
     }
     function setPerPage(n) {
-        composable.setPerPage?.(n);
+        composable.pagination?.value?.setPerPage?.(n);
     }
     // ── Row selection ──────────────────────────────────────────────────────────
     const selected = ref([]);
@@ -95,10 +95,17 @@ export function useListConnector(composableFn, options = {}) {
     function remove(row) {
         _deleteTarget.value = row;
     }
+    // Apply label overrides: columnLabel function takes priority over columnLabels map
+    const resolvedColumns = computed(() => columns.map((col) => ({
+        ...col,
+        label: columnLabel
+            ? columnLabel(col.key)
+            : (columnLabels[col.key] ?? col.label),
+    })));
     return {
         // State
         rows,
-        columns: computed(() => columns),
+        columns: resolvedColumns,
         loading,
         error,
         // Pagination

package/dist/generators/use-async-data/generator.js

@@ -66,6 +66,10 @@ export async function generateUseAsyncDataComposables(inputDir, outputDir, optio
     const sharedHelpersSource = path.resolve(__dirname, '../../../src/generators/shared/runtime/apiHelpers.ts');
     const sharedHelpersDest = path.join(sharedRuntimeDir, 'apiHelpers.ts');
     await fs.copyFile(sharedHelpersSource, sharedHelpersDest);
+    // Copy shared pagination.ts
+    const sharedPaginationSource = path.resolve(__dirname, '../../../src/generators/shared/runtime/pagination.ts');
+    const sharedPaginationDest = path.join(sharedRuntimeDir, 'pagination.ts');
+    await fs.copyFile(sharedPaginationSource, sharedPaginationDest);
     mainSpinner.stop('Runtime files copied');
     // 5. Calculate relative import path from composables to APIs
     const relativePath = calculateRelativeImportPath(composablesDir, inputDir);

package/dist/generators/use-async-data/runtime/useApiAsyncData.js

@@ -232,10 +232,10 @@ export function useApiAsyncData(key, url, options) {
             ...paginationState.value,
             hasNextPage: hasNextPage.value,
             hasPrevPage: hasPrevPage.value,
+            goToPage,
+            nextPage,
+            prevPage,
+            setPerPage,
         })),
-        goToPage,
-        nextPage,
-        prevPage,
-        setPerPage,
     };
 }

package/dist/generators/use-async-data/runtime/useApiAsyncDataRaw.js

@@ -213,10 +213,10 @@ export function useApiAsyncDataRaw(key, url, options) {
             ...paginationState.value,
             hasNextPage: hasNextPage.value,
             hasPrevPage: hasPrevPage.value,
+            goToPage,
+            nextPage,
+            prevPage,
+            setPerPage,
         })),
-        goToPage,
-        nextPage,
-        prevPage,
-        setPerPage,
     };
 }

package/dist/generators/use-async-data/templates.js

@@ -2,18 +2,18 @@
  * Generate file header with auto-generation warning
  */
 function generateFileHeader() {
-    return `/**
- * ⚠️ AUTO-GENERATED FILE - DO NOT EDIT MANUALLY
- *
- * This file was automatically generated by nuxt-openapi-generator.
- * Any manual changes will be overwritten on the next generation.
- *
- * @generated by nuxt-openapi-generator
- * @see https://github.com/dmartindiaz/nuxt-openapi-hyperfetch
- */
-
-/* eslint-disable */
-// @ts-nocheck
+    return `/**
+ * ⚠️ AUTO-GENERATED FILE - DO NOT EDIT MANUALLY
+ *
+ * This file was automatically generated by nuxt-openapi-generator.
+ * Any manual changes will be overwritten on the next generation.
+ *
+ * @generated by nuxt-openapi-generator
+ * @see https://github.com/dmartindiaz/nuxt-openapi-hyperfetch
+ */
+
+/* eslint-disable */
+// @ts-nocheck
 `;
 }
 /**
@@ -120,11 +120,11 @@ function generateFunctionBody(method, isRaw, generateOptions) {
     const argsExtraction = hasParams
         ? `  const _hasKey = typeof args[0] === 'string'\n  const params = _hasKey ? args[1] : args[0]\n  const options = _hasKey ? { cacheKey: args[0], ...args[2] } : args[1]`
         : `  const _hasKey = typeof args[0] === 'string'\n  const options = _hasKey ? { cacheKey: args[0], ...args[1] } : args[0]`;
-    return `${description}export function ${composableName}(key: string, ${args})
-export function ${composableName}(${args})
-export function ${composableName}(...args: any[]) {
-${argsExtraction}${pInit}
-  return ${wrapperFunction}${responseTypeGeneric}(${key}, ${url}, ${fetchOptions})
+    return `${description}export function ${composableName}(key: string, ${args})
+export function ${composableName}(${args})
+export function ${composableName}(...args: any[]) {
+${argsExtraction}${pInit}
+  return ${wrapperFunction}${responseTypeGeneric}(${key}, ${url}, ${fetchOptions})
 }`;
 }
 /**

package/dist/generators/use-fetch/generator.js

@@ -62,6 +62,10 @@ export async function generateUseFetchComposables(inputDir, outputDir, options,
     const sharedHelpersSource = path.resolve(__dirname, '../../../src/generators/shared/runtime/apiHelpers.ts');
     const sharedHelpersDest = path.join(sharedRuntimeDir, 'apiHelpers.ts');
     await fs.copyFile(sharedHelpersSource, sharedHelpersDest);
+    // Copy shared pagination.ts
+    const sharedPaginationSource = path.resolve(__dirname, '../../../src/generators/shared/runtime/pagination.ts');
+    const sharedPaginationDest = path.join(sharedRuntimeDir, 'pagination.ts');
+    await fs.copyFile(sharedPaginationSource, sharedPaginationDest);
     mainSpinner.stop('Runtime files copied');
     // 5. Calculate relative import path from composables to APIs
     const relativePath = calculateRelativeImportPath(composablesDir, inputDir);

package/dist/generators/use-fetch/templates.js

@@ -2,18 +2,18 @@
  * Generate file header with auto-generation warning
  */
 function generateFileHeader() {
-    return `/**
- * ⚠️ AUTO-GENERATED FILE - DO NOT EDIT MANUALLY
- *
- * This file was automatically generated by nuxt-openapi-generator.
- * Any manual changes will be overwritten on the next generation.
- *
- * @generated by nuxt-openapi-generator
- * @see https://github.com/dmartindiaz/nuxt-openapi-hyperfetch
- */
-
-/* eslint-disable */
-// @ts-nocheck
+    return `/**
+ * ⚠️ AUTO-GENERATED FILE - DO NOT EDIT MANUALLY
+ *
+ * This file was automatically generated by nuxt-openapi-generator.
+ * Any manual changes will be overwritten on the next generation.
+ *
+ * @generated by nuxt-openapi-generator
+ * @see https://github.com/dmartindiaz/nuxt-openapi-hyperfetch
+ */
+
+/* eslint-disable */
+// @ts-nocheck
 `;
 }
 /**
@@ -95,8 +95,8 @@ function generateFunctionBody(method, options) {
     const fetchOptions = generateFetchOptions(method, options);
     const description = method.description ? `/**\n * ${method.description}\n */\n` : '';
     const pInit = hasParams ? `\n  const p = shallowRef(params)` : '';
-    return `${description}export const ${method.composableName} = (${args}) => {${pInit}
-  return useApiRequest${responseTypeGeneric}(${url}, ${fetchOptions})
+    return `${description}export const ${method.composableName} = (${args}) => {${pInit}
+  return useApiRequest${responseTypeGeneric}(${url}, ${fetchOptions})
 }`;
 }
 /**

package/dist/index.js

@@ -6,7 +6,7 @@ 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 { promptInitialInputs, promptInputPath, promptComposablesSelection, promptServerRoutePath, promptBffConfig, promptGeneratorBackend, } from './cli/prompts.js';
+import { promptInitialInputs, promptInputPath, promptComposablesSelection, promptServerRoutePath, promptBffConfig, promptGeneratorBackend, promptConnectors, } from './cli/prompts.js';
 import { MESSAGES } from './cli/messages.js';
 import { displayLogo } from './cli/logo.js';
 import { loadConfig, mergeConfig, parseTags, parseGenerators } from './cli/config.js';
@@ -26,6 +26,7 @@ program
     .option('-v, --verbose', 'Enable verbose logging', false)
     .option('--watch', 'Watch mode - regenerate on file changes', false)
     .option('--generators <types>', 'Generators to use: useFetch,useAsyncData,nuxtServer')
+    .option('--connectors', 'Generate headless UI connectors on top of useAsyncData', false)
     .option('--server-route-path <path>', 'Server route path (for nuxtServer mode)')
     .option('--enable-bff', 'Enable BFF pattern (for nuxtServer mode)', false)
     .option('--backend <type>', 'Generator backend: official (Java) or heyapi (Node.js)')
@@ -54,6 +55,8 @@ program
             backend: options.backend === 'official' || options.backend === 'heyapi'
                 ? options.backend
                 : undefined,
+            // Only propagate if explicitly passed — undefined means "ask the user"
+            createUseAsyncDataConnectors: options.connectors === true ? true : undefined,
         });
         if (config.verbose) {
             console.log('Configuration:', config);
@@ -85,7 +88,8 @@ program
         // 1. Determine composables to generate FIRST
         let composables;
         if (config.generators) {
-            composables = config.generators;
+            // filter out 'connectors' — handled separately below
+            composables = config.generators.filter((g) => g !== 'connectors');
             if (config.verbose) {
                 console.log(`Using generators from config: ${composables.join(', ')}`);
             }
@@ -114,7 +118,17 @@ program
             inputPath = await promptInputPath(config.input);
             outputPath = config.output ?? './swagger';
         }
-        // 3. Ask for server route path if nuxtServer is selected
+        // 3. Ask whether to generate headless connectors (only if useAsyncData selected)
+        let generateConnectorsFlag = false;
+        if (composables.includes('useAsyncData')) {
+            if (config.createUseAsyncDataConnectors !== undefined) {
+                generateConnectorsFlag = config.createUseAsyncDataConnectors;
+            }
+            else {
+                generateConnectorsFlag = await promptConnectors();
+            }
+        }
+        // 4. Ask for server route path if nuxtServer is selected
         let serverRoutePath = config.serverRoutePath || '';
         let enableBff = config.enableBff || false;
         if (needsNuxtServer && !config.serverRoutePath) {
@@ -181,6 +195,29 @@ program
                 throw error;
             }
         }
+        // Generate headless connectors if requested (requires useAsyncData)
+        if (generateConnectorsFlag) {
+            const spinner = p.spinner();
+            spinner.start('Generating headless UI connectors...');
+            try {
+                if (!config.dryRun) {
+                    await generateConnectors({
+                        inputSpec: inputPath,
+                        outputDir: `${composablesOutputDir}/connectors`,
+                        composablesRelDir: '../use-async-data',
+                        runtimeRelDir: '../../runtime',
+                    });
+                    spinner.stop('✓ Generated headless UI connectors');
+                }
+                else {
+                    spinner.stop('Would generate headless UI connectors (dry-run)');
+                }
+            }
+            catch (error) {
+                spinner.stop('✗ Failed to generate connectors');
+                throw error;
+            }
+        }
         if (config.dryRun) {
             p.outro('🔍 Dry run complete - no files were modified');
         }
@@ -211,28 +248,4 @@ program
         process.exit(1);
     }
 });
-program
-    .command('connectors')
-    .description('Generate headless connector composables from an OpenAPI spec')
-    .requiredOption('-i, --input <path>', 'Path to OpenAPI YAML or JSON spec')
-    .requiredOption('-o, --output <path>', 'Output directory for connector composables')
-    .option('--composables-dir <relPath>', 'Relative path from output dir to useAsyncData composables (default: ../use-async-data)')
-    .option('--runtime-dir <relPath>', 'Relative path from output dir where runtime helpers are copied (default: ../runtime)')
-    .action(async (options) => {
-    try {
-        displayLogo();
-        p.intro('Generating connector composables…');
-        await generateConnectors({
-            inputSpec: options.input,
-            outputDir: options.output,
-            composablesRelDir: options.composablesDir,
-            runtimeRelDir: options.runtimeDir,
-        });
-        p.outro('Done!');
-    }
-    catch (error) {
-        p.log.error(`Error: ${String(error)}`);
-        process.exit(1);
-    }
-});
 program.parse();

package/dist/module/index.js

@@ -5,6 +5,7 @@ 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';
 export default defineNuxtModule({
     meta: {
@@ -19,6 +20,7 @@ export default defineNuxtModule({
         enableProductionBuild: true,
         enableAutoGeneration: false,
         enableAutoImport: true,
+        createUseAsyncDataConnectors: false,
     },
     setup(options, nuxt) {
         // --- Guard: input is required ---
@@ -64,6 +66,20 @@ export default defineNuxtModule({
                 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;
@@ -88,6 +104,9 @@ export default defineNuxtModule({
             if (selectedGenerators.includes('useAsyncData')) {
                 addImportsDir(path.join(composablesOutputDir, 'use-async-data', 'composables'));
             }
+            if (options.createUseAsyncDataConnectors && selectedGenerators.includes('useAsyncData')) {
+                addImportsDir(path.join(composablesOutputDir, 'connectors'));
+            }
         }
     },
 });

package/dist/module/types.d.ts

@@ -24,4 +24,11 @@ export interface ModuleOptions extends GeneratorConfig {
      * @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;
 }