nuxt-openapi-hyperfetch 0.1.0-alpha.1

package/dist/cli/messages.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Main messages used throughout the CLI
+ */
+export declare const MESSAGES: {
+    intro: string;
+    outro: {
+        success: string;
+        cancelled: string;
+        noComposables: string;
+    };
+    prompts: {
+        selectBackend: string;
+        inputPath: string;
+        outputPath: string;
+        selectComposables: string;
+        serverPath: string;
+        customPath: string;
+        enableBff: string;
+    };
+    steps: {
+        generatingOpenApi: string;
+    };
+};
+/**
+ * Predefined choices for select/multiselect prompts
+ */
+export declare const CHOICES: {
+    backends: ({
+        value: "official";
+        label: string;
+        hint: string;
+    } | {
+        value: "heyapi";
+        label: string;
+        hint: string;
+    })[];
+    composables: ({
+        value: string;
+        label: string;
+        hint: string;
+    } | {
+        value: string;
+        label: string;
+        hint?: undefined;
+    })[];
+    serverPaths: ({
+        value: string;
+        label: string;
+        hint: string;
+    } | {
+        value: string;
+        label: string;
+        hint?: undefined;
+    })[];
+};
+/**
+ * Default values for prompts
+ */
+export declare const DEFAULTS: {
+    inputPath: string;
+    outputPath: string;
+    serverPath: string;
+    customPath: string;
+    enableBff: boolean;
+};

package/dist/cli/messages.js

@@ -0,0 +1,86 @@
+/**
+ * Main messages used throughout the CLI
+ */
+export const MESSAGES = {
+    // Intro/Outro messages
+    intro: '🎨 Nuxt Swagger Generator',
+    outro: {
+        success: '🎉 All done! Your files are ready.',
+        cancelled: '👋 Operation cancelled.',
+        noComposables: '✓ OpenAPI files generated successfully!\nNo composables selected.',
+    },
+    // Prompt messages
+    prompts: {
+        selectBackend: 'Select the OpenAPI code generator:',
+        inputPath: 'Enter the path to your OpenAPI/Swagger file:',
+        outputPath: 'Enter the output directory for generated files:',
+        selectComposables: 'Select which composables you want to generate:',
+        serverPath: 'Where do you want to generate server routes?',
+        customPath: 'Enter custom server route path:',
+        enableBff: 'Enable BFF (Backend for Frontend) with transformers and auth?',
+    },
+    // Process step messages
+    steps: {
+        generatingOpenApi: 'Generating OpenAPI files',
+    },
+};
+/**
+ * Predefined choices for select/multiselect prompts
+ */
+export const CHOICES = {
+    // Generator backend options
+    backends: [
+        {
+            value: 'official',
+            label: 'OpenAPI Generator (official)',
+            hint: 'Requires Java 11+',
+        },
+        {
+            value: 'heyapi',
+            label: '@hey-api/openapi-ts (Node.js)',
+            hint: 'No Java required',
+        },
+    ],
+    // Composables selection
+    composables: [
+        {
+            value: 'useFetch',
+            label: 'useFetch - Nuxt useFetch composables',
+            hint: 'Recommended for most use cases',
+        },
+        {
+            value: 'useAsyncData',
+            label: 'useAsyncData - Nuxt useAsyncData composables',
+        },
+        {
+            value: 'nuxtServer',
+            label: 'Nuxt Server Routes - Generate server/api/* proxy routes',
+        },
+    ],
+    // Server path options
+    serverPaths: [
+        {
+            value: 'server/api',
+            label: 'server/api (recommended)',
+            hint: 'Standard Nuxt server directory',
+        },
+        {
+            value: 'src/server/api',
+            label: 'src/server/api',
+        },
+        {
+            value: 'custom',
+            label: 'Custom path...',
+        },
+    ],
+};
+/**
+ * Default values for prompts
+ */
+export const DEFAULTS = {
+    inputPath: './swagger.yaml',
+    outputPath: './swagger',
+    serverPath: 'server/api',
+    customPath: './server/api',
+    enableBff: true,
+};

package/dist/cli/prompts.d.ts

@@ -0,0 +1,30 @@
+import type { InitialInputs, ComposablesSelection, BffConfig, GeneratorBackend } from './types.js';
+/**
+ * Ask which OpenAPI generator backend to use
+ */
+export declare function promptGeneratorBackend(provided?: GeneratorBackend): Promise<GeneratorBackend>;
+/**
+ * Ask for input and output paths
+ * Only asks for paths that weren't provided via CLI arguments
+ */
+export declare function promptInitialInputs(inputProvided?: string, outputProvided?: string): Promise<InitialInputs>;
+/**
+ * Ask for the input path only (used when only nuxtServer is selected)
+ */
+export declare function promptInputPath(provided?: string): Promise<string>;
+/**
+ * Ask which composables to generate (multiselect)
+ * Allows user to select none, one, or multiple composables
+ */
+export declare function promptComposablesSelection(): Promise<ComposablesSelection>;
+/**
+ * Ask for server route path
+ * If user selects 'custom', prompts for custom path
+ * Returns the final path to use
+ */
+export declare function promptServerRoutePath(): Promise<string>;
+/**
+ * Ask about BFF (Backend for Frontend) support
+ * Returns whether BFF should be enabled
+ */
+export declare function promptBffConfig(): Promise<BffConfig>;

package/dist/cli/prompts.js

@@ -0,0 +1,118 @@
+/**
+ * All CLI prompts using @clack/prompts
+ * Each function handles a specific prompt flow and returns typed data
+ */
+import * as p from '@clack/prompts';
+import { checkCancellation, validateNonEmpty } from './utils.js';
+import { MESSAGES, CHOICES, DEFAULTS } from './messages.js';
+/**
+ * Ask which OpenAPI generator backend to use
+ */
+export async function promptGeneratorBackend(provided) {
+    if (provided) {
+        return provided;
+    }
+    const result = await p.select({
+        message: MESSAGES.prompts.selectBackend,
+        options: CHOICES.backends,
+        initialValue: 'official',
+    });
+    checkCancellation(result);
+    return result;
+}
+/**
+ * Ask for input and output paths
+ * Only asks for paths that weren't provided via CLI arguments
+ */
+export async function promptInitialInputs(inputProvided, outputProvided) {
+    let inputPath = inputProvided;
+    let outputPath = outputProvided;
+    // Ask for input path if not provided
+    if (!inputPath) {
+        const result = await p.text({
+            message: MESSAGES.prompts.inputPath,
+            placeholder: DEFAULTS.inputPath,
+            defaultValue: DEFAULTS.inputPath,
+        });
+        checkCancellation(result);
+        inputPath = result;
+    }
+    // Ask for output path if not provided
+    if (!outputPath) {
+        const result = await p.text({
+            message: MESSAGES.prompts.outputPath,
+            placeholder: DEFAULTS.outputPath,
+            defaultValue: DEFAULTS.outputPath,
+        });
+        checkCancellation(result);
+        outputPath = result;
+    }
+    return { inputPath, outputPath };
+}
+/**
+ * Ask for the input path only (used when only nuxtServer is selected)
+ */
+export async function promptInputPath(provided) {
+    if (provided) {
+        return provided;
+    }
+    const result = await p.text({
+        message: MESSAGES.prompts.inputPath,
+        placeholder: DEFAULTS.inputPath,
+        defaultValue: DEFAULTS.inputPath,
+    });
+    checkCancellation(result);
+    return result;
+}
+/**
+ * Ask which composables to generate (multiselect)
+ * Allows user to select none, one, or multiple composables
+ */
+export async function promptComposablesSelection() {
+    const result = await p.multiselect({
+        message: MESSAGES.prompts.selectComposables,
+        options: CHOICES.composables,
+        initialValues: ['useFetch'], // useFetch checked by default
+        required: false, // Allow empty selection
+    });
+    checkCancellation(result);
+    return { composables: result };
+}
+/**
+ * Ask for server route path
+ * If user selects 'custom', prompts for custom path
+ * Returns the final path to use
+ */
+export async function promptServerRoutePath() {
+    // First, ask for the path type
+    const pathResult = await p.select({
+        message: MESSAGES.prompts.serverPath,
+        options: CHOICES.serverPaths,
+        initialValue: DEFAULTS.serverPath,
+    });
+    checkCancellation(pathResult);
+    // If custom selected, ask for custom path
+    if (pathResult === 'custom') {
+        const customResult = await p.text({
+            message: MESSAGES.prompts.customPath,
+            placeholder: DEFAULTS.customPath,
+            defaultValue: DEFAULTS.customPath,
+            validate: validateNonEmpty,
+        });
+        checkCancellation(customResult);
+        return customResult;
+    }
+    return pathResult;
+}
+/**
+ * Ask about BFF (Backend for Frontend) support
+ * Returns whether BFF should be enabled
+ */
+export async function promptBffConfig() {
+    const result = await p.confirm({
+        message: MESSAGES.prompts.enableBff,
+        initialValue: DEFAULTS.enableBff,
+    });
+    checkCancellation(result);
+    return { enableBff: result };
+}

package/dist/cli/types.d.ts

@@ -0,0 +1,43 @@
+/**
+ * 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';

package/dist/cli/types.js

@@ -0,0 +1,4 @@
+/**
+ * TypeScript types for CLI prompts and responses
+ */
+export {};

package/dist/cli/utils.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Handle cancellation uniformly across all prompts
+ * This function never returns - it exits the process
+ */
+export declare function handleCancel(): never;
+/**
+ * Check if user cancelled the prompt and exit if so
+ * Use this after every prompt to handle Ctrl+C gracefully
+ *
+ * @param value - The value returned from a prompt
+ *
+ * @example
+ * const result = await p.text({ message: 'Enter name' });
+ * checkCancellation(result);
+ * // Now we know result is not a cancel symbol
+ */
+export declare function checkCancellation(value: unknown): void;
+/**
+ * Format a file path for display in messages
+ * Normalizes path separators and removes trailing slashes
+ */
+export declare function formatPath(path: string): string;
+/**
+ * Validate that a path is not empty
+ */
+export declare function validateNonEmpty(value: string | undefined): string | undefined;

package/dist/cli/utils.js

@@ -0,0 +1,45 @@
+/**
+ * Utility functions for CLI operations
+ */
+import * as p from '@clack/prompts';
+import { MESSAGES } from './messages.js';
+/**
+ * Handle cancellation uniformly across all prompts
+ * This function never returns - it exits the process
+ */
+export function handleCancel() {
+    p.cancel(MESSAGES.outro.cancelled);
+    process.exit(0);
+}
+/**
+ * Check if user cancelled the prompt and exit if so
+ * Use this after every prompt to handle Ctrl+C gracefully
+ *
+ * @param value - The value returned from a prompt
+ *
+ * @example
+ * const result = await p.text({ message: 'Enter name' });
+ * checkCancellation(result);
+ * // Now we know result is not a cancel symbol
+ */
+export function checkCancellation(value) {
+    if (p.isCancel(value)) {
+        handleCancel();
+    }
+}
+/**
+ * Format a file path for display in messages
+ * Normalizes path separators and removes trailing slashes
+ */
+export function formatPath(path) {
+    return path.replace(/\\/g, '/').replace(/\/$/, '');
+}
+/**
+ * Validate that a path is not empty
+ */
+export function validateNonEmpty(value) {
+    if (!value || value.trim() === '') {
+        return 'This field is required';
+    }
+    return undefined;
+}

package/dist/generate.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Check if Java is installed. Returns true if found, false otherwise.
+ */
+export declare function checkJavaInstalled(): boolean;
+export declare const generateOpenApiFiles: (input: string, output: string) => void;
+export declare const generateHeyApiFiles: (input: string, output: string) => Promise<void>;

package/dist/generate.js

@@ -0,0 +1,48 @@
+import { execSync } from 'child_process';
+import * as path from 'path';
+import { p, logSuccess, logError } from './cli/logger.js';
+/**
+ * Check if Java is installed. Returns true if found, false otherwise.
+ */
+export function checkJavaInstalled() {
+    try {
+        execSync('java -version', { stdio: 'ignore' });
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+export const generateOpenApiFiles = (input, output) => {
+    try {
+        const inputPath = path.resolve(input);
+        const outputPath = path.resolve(output);
+        p.log.info(`Input: ${inputPath}`);
+        p.log.info(`Output: ${outputPath}`);
+        execSync(`npx @openapitools/openapi-generator-cli generate -i "${inputPath}" -g typescript-fetch -o "${outputPath}"`, { stdio: 'inherit' });
+        logSuccess(`Files generated successfully in ${outputPath}`);
+    }
+    catch (error) {
+        logError(`Error generating files: ${String(error)}`);
+        process.exit(1);
+    }
+};
+export const generateHeyApiFiles = async (input, output) => {
+    try {
+        const inputPath = path.resolve(input);
+        const outputPath = path.resolve(output);
+        p.log.info(`Input: ${inputPath}`);
+        p.log.info(`Output: ${outputPath}`);
+        const { createClient } = await import('@hey-api/openapi-ts');
+        await createClient({
+            input: inputPath,
+            output: outputPath,
+            plugins: ['@hey-api/typescript', '@hey-api/sdk'],
+        });
+        logSuccess(`Files generated successfully in ${outputPath}`);
+    }
+    catch (error) {
+        logError(`Error generating files: ${String(error)}`);
+        process.exit(1);
+    }
+};

package/dist/generators/nuxt-server/bff-templates.d.ts

@@ -0,0 +1,25 @@
+import type { MethodInfo } from './types.js';
+/**
+ * Generate the Auth Context stub file
+ * This file is generated ONCE and never overwritten
+ */
+export declare function generateAuthContextStub(): string;
+/**
+ * Generate the Auth Types stub file
+ * This file is generated ONCE and never overwritten
+ */
+export declare function generateAuthTypesStub(): string;
+/**
+ * Generate a transformer stub for a specific resource
+ * This file is generated ONCE and never overwritten
+ */
+export declare function generateTransformerStub(resource: string, methods: MethodInfo[], inputDir: string): string;
+/**
+ * Generate transformer examples file
+ * This file is ALWAYS regenerated as a reference
+ */
+export declare function generateTransformerExamples(): string;
+/**
+ * Generate BFF README file
+ */
+export declare function generateBffReadme(): string;