nuxt-openapi-hyperfetch 0.1.0-alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (109) hide show
  1. package/.editorconfig +26 -0
  2. package/.prettierignore +17 -0
  3. package/.prettierrc.json +12 -0
  4. package/CONTRIBUTING.md +292 -0
  5. package/INSTRUCTIONS.md +327 -0
  6. package/LICENSE +202 -0
  7. package/README.md +202 -0
  8. package/dist/cli/config.d.ts +57 -0
  9. package/dist/cli/config.js +85 -0
  10. package/dist/cli/logger.d.ts +44 -0
  11. package/dist/cli/logger.js +58 -0
  12. package/dist/cli/logo.d.ts +6 -0
  13. package/dist/cli/logo.js +21 -0
  14. package/dist/cli/messages.d.ts +65 -0
  15. package/dist/cli/messages.js +86 -0
  16. package/dist/cli/prompts.d.ts +30 -0
  17. package/dist/cli/prompts.js +118 -0
  18. package/dist/cli/types.d.ts +43 -0
  19. package/dist/cli/types.js +4 -0
  20. package/dist/cli/utils.d.ts +26 -0
  21. package/dist/cli/utils.js +45 -0
  22. package/dist/generate.d.ts +6 -0
  23. package/dist/generate.js +48 -0
  24. package/dist/generators/nuxt-server/bff-templates.d.ts +25 -0
  25. package/dist/generators/nuxt-server/bff-templates.js +737 -0
  26. package/dist/generators/nuxt-server/generator.d.ts +7 -0
  27. package/dist/generators/nuxt-server/generator.js +206 -0
  28. package/dist/generators/nuxt-server/parser.d.ts +5 -0
  29. package/dist/generators/nuxt-server/parser.js +5 -0
  30. package/dist/generators/nuxt-server/templates.d.ts +35 -0
  31. package/dist/generators/nuxt-server/templates.js +412 -0
  32. package/dist/generators/nuxt-server/types.d.ts +5 -0
  33. package/dist/generators/nuxt-server/types.js +5 -0
  34. package/dist/generators/shared/parsers/heyapi-parser.d.ts +11 -0
  35. package/dist/generators/shared/parsers/heyapi-parser.js +248 -0
  36. package/dist/generators/shared/parsers/official-parser.d.ts +5 -0
  37. package/dist/generators/shared/parsers/official-parser.js +5 -0
  38. package/dist/generators/shared/runtime/apiHelpers.d.ts +183 -0
  39. package/dist/generators/shared/runtime/apiHelpers.js +268 -0
  40. package/dist/generators/shared/templates/api-callbacks-plugin.d.ts +178 -0
  41. package/dist/generators/shared/templates/api-callbacks-plugin.js +338 -0
  42. package/dist/generators/shared/types.d.ts +25 -0
  43. package/dist/generators/shared/types.js +4 -0
  44. package/dist/generators/tanstack-query/generator.d.ts +5 -0
  45. package/dist/generators/tanstack-query/generator.js +11 -0
  46. package/dist/generators/use-async-data/generator.d.ts +5 -0
  47. package/dist/generators/use-async-data/generator.js +156 -0
  48. package/dist/generators/use-async-data/parser.d.ts +5 -0
  49. package/dist/generators/use-async-data/parser.js +5 -0
  50. package/dist/generators/use-async-data/runtime/useApiAsyncData.d.ts +38 -0
  51. package/dist/generators/use-async-data/runtime/useApiAsyncData.js +122 -0
  52. package/dist/generators/use-async-data/runtime/useApiAsyncDataRaw.d.ts +54 -0
  53. package/dist/generators/use-async-data/runtime/useApiAsyncDataRaw.js +126 -0
  54. package/dist/generators/use-async-data/templates.d.ts +20 -0
  55. package/dist/generators/use-async-data/templates.js +191 -0
  56. package/dist/generators/use-async-data/types.d.ts +4 -0
  57. package/dist/generators/use-async-data/types.js +4 -0
  58. package/dist/generators/use-fetch/generator.d.ts +5 -0
  59. package/dist/generators/use-fetch/generator.js +131 -0
  60. package/dist/generators/use-fetch/parser.d.ts +9 -0
  61. package/dist/generators/use-fetch/parser.js +282 -0
  62. package/dist/generators/use-fetch/runtime/useApiRequest.d.ts +46 -0
  63. package/dist/generators/use-fetch/runtime/useApiRequest.js +158 -0
  64. package/dist/generators/use-fetch/templates.d.ts +16 -0
  65. package/dist/generators/use-fetch/templates.js +169 -0
  66. package/dist/generators/use-fetch/types.d.ts +5 -0
  67. package/dist/generators/use-fetch/types.js +5 -0
  68. package/dist/index.d.ts +2 -0
  69. package/dist/index.js +213 -0
  70. package/docs/API-REFERENCE.md +887 -0
  71. package/docs/ARCHITECTURE.md +649 -0
  72. package/docs/DEVELOPMENT.md +918 -0
  73. package/docs/QUICK-START.md +323 -0
  74. package/docs/README.md +155 -0
  75. package/docs/TROUBLESHOOTING.md +881 -0
  76. package/eslint.config.js +72 -0
  77. package/package.json +65 -0
  78. package/src/cli/config.ts +140 -0
  79. package/src/cli/logger.ts +66 -0
  80. package/src/cli/logo.ts +25 -0
  81. package/src/cli/messages.ts +97 -0
  82. package/src/cli/prompts.ts +143 -0
  83. package/src/cli/types.ts +50 -0
  84. package/src/cli/utils.ts +49 -0
  85. package/src/generate.ts +57 -0
  86. package/src/generators/nuxt-server/bff-templates.ts +754 -0
  87. package/src/generators/nuxt-server/generator.ts +270 -0
  88. package/src/generators/nuxt-server/parser.ts +5 -0
  89. package/src/generators/nuxt-server/templates.ts +483 -0
  90. package/src/generators/nuxt-server/types.ts +5 -0
  91. package/src/generators/shared/parsers/heyapi-parser.ts +307 -0
  92. package/src/generators/shared/parsers/official-parser.ts +5 -0
  93. package/src/generators/shared/runtime/apiHelpers.ts +466 -0
  94. package/src/generators/shared/templates/api-callbacks-plugin.ts +352 -0
  95. package/src/generators/shared/types.ts +27 -0
  96. package/src/generators/tanstack-query/generator.ts +11 -0
  97. package/src/generators/use-async-data/generator.ts +204 -0
  98. package/src/generators/use-async-data/parser.ts +5 -0
  99. package/src/generators/use-async-data/runtime/useApiAsyncData.ts +220 -0
  100. package/src/generators/use-async-data/runtime/useApiAsyncDataRaw.ts +236 -0
  101. package/src/generators/use-async-data/templates.ts +250 -0
  102. package/src/generators/use-async-data/types.ts +4 -0
  103. package/src/generators/use-fetch/generator.ts +169 -0
  104. package/src/generators/use-fetch/parser.ts +341 -0
  105. package/src/generators/use-fetch/runtime/useApiRequest.ts +223 -0
  106. package/src/generators/use-fetch/templates.ts +214 -0
  107. package/src/generators/use-fetch/types.ts +5 -0
  108. package/src/index.ts +265 -0
  109. package/tsconfig.json +15 -0
package/dist/index.js ADDED
@@ -0,0 +1,213 @@
1
+ #!/usr/bin/env node
2
+ import { Command } from 'commander';
3
+ import * as p from '@clack/prompts';
4
+ import { generateOpenApiFiles, generateHeyApiFiles, checkJavaInstalled } from './generate.js';
5
+ import { generateUseFetchComposables } from './generators/use-fetch/generator.js';
6
+ import { generateUseAsyncDataComposables } from './generators/use-async-data/generator.js';
7
+ import { generateNuxtServerRoutes } from './generators/nuxt-server/generator.js';
8
+ import { promptInitialInputs, promptInputPath, promptComposablesSelection, promptServerRoutePath, promptBffConfig, promptGeneratorBackend, } from './cli/prompts.js';
9
+ import { MESSAGES } from './cli/messages.js';
10
+ import { displayLogo } from './cli/logo.js';
11
+ import { loadConfig, mergeConfig, parseTags, parseGenerators } from './cli/config.js';
12
+ const program = new Command();
13
+ program.name('nxh').description('Nuxt OpenAPI Hyperfetch generator').version('1.0.0');
14
+ program
15
+ .command('generate')
16
+ .description('Generate all nuxt files and composables from OpenAPI spec')
17
+ .option('-i, --input <path>', 'OpenAPI file path or URL')
18
+ .option('-o, --output <path>', 'Output directory')
19
+ .option('--base-url <url>', 'Base URL for API requests')
20
+ .option('--mode <mode>', 'Generation mode: client or server', 'client')
21
+ .option('--tags <tags>', 'Generate only specific tags (comma-separated)')
22
+ .option('--exclude-tags <tags>', 'Exclude specific tags (comma-separated)')
23
+ .option('--overwrite', 'Overwrite existing files without prompting', false)
24
+ .option('--dry-run', 'Preview changes without writing files', false)
25
+ .option('-v, --verbose', 'Enable verbose logging', false)
26
+ .option('--watch', 'Watch mode - regenerate on file changes', false)
27
+ .option('--generators <types>', 'Generators to use: useFetch,useAsyncData,nuxtServer')
28
+ .option('--server-route-path <path>', 'Server route path (for nuxtServer mode)')
29
+ .option('--enable-bff', 'Enable BFF pattern (for nuxtServer mode)', false)
30
+ .option('--backend <type>', 'Generator backend: official (Java) or heyapi (Node.js)')
31
+ .action(async (options) => {
32
+ try {
33
+ // Load config file
34
+ const fileConfig = await loadConfig();
35
+ if (options.verbose && fileConfig) {
36
+ p.log.info('Loaded configuration from file');
37
+ }
38
+ // Parse and merge configuration
39
+ const config = mergeConfig(fileConfig, {
40
+ input: options.input,
41
+ output: options.output,
42
+ baseUrl: options.baseUrl,
43
+ mode: options.mode,
44
+ tags: parseTags(options.tags),
45
+ excludeTags: parseTags(options.excludeTags),
46
+ overwrite: options.overwrite,
47
+ dryRun: options.dryRun,
48
+ verbose: options.verbose,
49
+ watch: options.watch,
50
+ generators: parseGenerators(options.generators),
51
+ serverRoutePath: options.serverRoutePath,
52
+ enableBff: options.enableBff,
53
+ backend: options.backend === 'official' || options.backend === 'heyapi'
54
+ ? options.backend
55
+ : undefined,
56
+ });
57
+ if (config.verbose) {
58
+ console.log('Configuration:', config);
59
+ }
60
+ // Show logo and intro
61
+ displayLogo();
62
+ p.intro(MESSAGES.intro);
63
+ if (config.dryRun) {
64
+ p.log.warn('🔍 DRY RUN MODE - No files will be written');
65
+ }
66
+ // 0. Select generator engine (first question)
67
+ // Resolve engine from config.generator (user-facing) or config.backend (CLI flag)
68
+ // config.generator: 'openapi' | 'heyapi' → map 'openapi' to internal 'official'
69
+ const resolvedBackend = config.generator === 'openapi'
70
+ ? 'official'
71
+ : config.generator === 'heyapi'
72
+ ? 'heyapi'
73
+ : config.backend;
74
+ // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
75
+ const backend = await promptGeneratorBackend(resolvedBackend);
76
+ // Check Java availability when official backend is selected
77
+ if (backend === 'official' && !checkJavaInstalled()) {
78
+ p.log.error('Java not found. The OpenAPI Generator requires Java 11 or higher.\n' +
79
+ 'Install it from: https://adoptium.net\n' +
80
+ 'Or switch to @hey-api/openapi-ts which requires no Java.');
81
+ p.outro('Aborted.');
82
+ process.exit(1);
83
+ }
84
+ // 1. Determine composables to generate FIRST
85
+ let composables;
86
+ if (config.generators) {
87
+ composables = config.generators;
88
+ if (config.verbose) {
89
+ console.log(`Using generators from config: ${composables.join(', ')}`);
90
+ }
91
+ }
92
+ else {
93
+ const result = await promptComposablesSelection();
94
+ composables = result.composables;
95
+ }
96
+ if (composables.length === 0) {
97
+ p.outro(MESSAGES.outro.noComposables);
98
+ return;
99
+ }
100
+ // 2. Ask for paths based on which generators were selected
101
+ const needsComposables = composables.some((c) => c === 'useFetch' || c === 'useAsyncData');
102
+ const needsNuxtServer = composables.includes('nuxtServer');
103
+ let inputPath;
104
+ let outputPath;
105
+ if (needsComposables) {
106
+ // useFetch/useAsyncData: ask for both input (OpenAPI spec) and output (composables dir)
107
+ const inputs = await promptInitialInputs(config.input, config.output);
108
+ inputPath = inputs.inputPath;
109
+ outputPath = inputs.outputPath;
110
+ }
111
+ else {
112
+ // nuxtServer only: ask just for the OpenAPI spec, use default/config for output
113
+ inputPath = await promptInputPath(config.input);
114
+ outputPath = config.output ?? './swagger';
115
+ }
116
+ // 3. Ask for server route path if nuxtServer is selected
117
+ let serverRoutePath = config.serverRoutePath || '';
118
+ let enableBff = config.enableBff || false;
119
+ if (needsNuxtServer && !config.serverRoutePath) {
120
+ serverRoutePath = await promptServerRoutePath();
121
+ const bffConfig = await promptBffConfig();
122
+ enableBff = bffConfig.enableBff;
123
+ }
124
+ // Generate OpenAPI files
125
+ const s = p.spinner();
126
+ s.start(MESSAGES.steps.generatingOpenApi);
127
+ if (!config.dryRun) {
128
+ if (backend === 'heyapi') {
129
+ await generateHeyApiFiles(inputPath, outputPath);
130
+ }
131
+ else {
132
+ generateOpenApiFiles(inputPath, outputPath);
133
+ }
134
+ s.stop('OpenAPI files generated');
135
+ }
136
+ else {
137
+ s.stop('Would generate OpenAPI files (skipped in dry-run)');
138
+ }
139
+ // Generate selected composables
140
+ const composablesOutputDir = `${outputPath}/composables`;
141
+ for (const composable of composables) {
142
+ const spinner = p.spinner();
143
+ spinner.start(`Generating ${composable}...`);
144
+ // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
145
+ const generateOptions = { baseUrl: config.baseUrl, backend };
146
+ try {
147
+ switch (composable) {
148
+ case 'useFetch':
149
+ if (!config.dryRun) {
150
+ await generateUseFetchComposables(outputPath, `${composablesOutputDir}/use-fetch`, generateOptions);
151
+ spinner.stop(`✓ Generated useFetch composables`);
152
+ }
153
+ else {
154
+ spinner.stop(`Would generate useFetch composables (dry-run)`);
155
+ }
156
+ break;
157
+ case 'useAsyncData':
158
+ if (!config.dryRun) {
159
+ await generateUseAsyncDataComposables(outputPath, `${composablesOutputDir}/use-async-data`, generateOptions);
160
+ spinner.stop(`✓ Generated useAsyncData composables`);
161
+ }
162
+ else {
163
+ spinner.stop(`Would generate useAsyncData composables (dry-run)`);
164
+ }
165
+ break;
166
+ case 'nuxtServer':
167
+ if (!config.dryRun) {
168
+ // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
169
+ await generateNuxtServerRoutes(outputPath, serverRoutePath, { enableBff, backend });
170
+ spinner.stop(`✓ Generated Nuxt server routes`);
171
+ }
172
+ else {
173
+ spinner.stop(`Would generate Nuxt server routes (dry-run)`);
174
+ }
175
+ break;
176
+ }
177
+ }
178
+ catch (error) {
179
+ spinner.stop(`✗ Failed to generate ${composable}`);
180
+ throw error;
181
+ }
182
+ }
183
+ if (config.dryRun) {
184
+ p.outro('🔍 Dry run complete - no files were modified');
185
+ }
186
+ else {
187
+ p.outro(MESSAGES.outro.success);
188
+ }
189
+ }
190
+ catch (error) {
191
+ p.log.error(`Error: ${String(error)}`);
192
+ process.exit(1);
193
+ }
194
+ });
195
+ program
196
+ .command('use-fetch')
197
+ .description('Generate Nuxt useFetch composables from OpenAPI generated files')
198
+ .option('-i, --input <path>', 'OpenAPI generated files directory')
199
+ .option('-o, --output <path>', 'Output directory for composables')
200
+ .action(async (options) => {
201
+ if (!options.input || !options.output) {
202
+ p.log.error('Error: You must provide both --input and --output');
203
+ process.exit(1);
204
+ }
205
+ try {
206
+ await generateUseFetchComposables(options.input, options.output);
207
+ }
208
+ catch (error) {
209
+ p.log.error(`Error: ${String(error)}`);
210
+ process.exit(1);
211
+ }
212
+ });
213
+ program.parse();