nuxt-openapi-hyperfetch 0.1.7-alpha.1 → 0.2.7-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 (97) hide show
  1. package/CONTRIBUTING.md +291 -292
  2. package/INSTRUCTIONS.md +327 -327
  3. package/LICENSE +202 -202
  4. package/README.md +231 -227
  5. package/dist/cli/logger.d.ts +26 -0
  6. package/dist/cli/logger.js +36 -0
  7. package/dist/cli/logo.js +5 -5
  8. package/dist/generators/components/connector-generator/generator.d.ts +12 -0
  9. package/dist/generators/components/connector-generator/generator.js +116 -0
  10. package/dist/generators/components/connector-generator/templates.d.ts +18 -0
  11. package/dist/generators/components/connector-generator/templates.js +222 -0
  12. package/dist/generators/components/connector-generator/types.d.ts +32 -0
  13. package/dist/generators/components/connector-generator/types.js +7 -0
  14. package/dist/generators/components/schema-analyzer/index.d.ts +17 -0
  15. package/dist/generators/components/schema-analyzer/index.js +20 -0
  16. package/dist/generators/components/schema-analyzer/intent-detector.d.ts +17 -0
  17. package/dist/generators/components/schema-analyzer/intent-detector.js +143 -0
  18. package/dist/generators/components/schema-analyzer/openapi-reader.d.ts +11 -0
  19. package/dist/generators/components/schema-analyzer/openapi-reader.js +76 -0
  20. package/dist/generators/components/schema-analyzer/resource-grouper.d.ts +6 -0
  21. package/dist/generators/components/schema-analyzer/resource-grouper.js +132 -0
  22. package/dist/generators/components/schema-analyzer/schema-field-mapper.d.ts +35 -0
  23. package/dist/generators/components/schema-analyzer/schema-field-mapper.js +220 -0
  24. package/dist/generators/components/schema-analyzer/types.d.ts +156 -0
  25. package/dist/generators/components/schema-analyzer/types.js +7 -0
  26. package/dist/generators/nuxt-server/generator.d.ts +2 -1
  27. package/dist/generators/nuxt-server/generator.js +21 -21
  28. package/dist/generators/shared/runtime/apiHelpers.d.ts +81 -41
  29. package/dist/generators/shared/runtime/apiHelpers.js +97 -104
  30. package/dist/generators/shared/runtime/pagination.d.ts +168 -0
  31. package/dist/generators/shared/runtime/pagination.js +179 -0
  32. package/dist/generators/shared/runtime/useDeleteConnector.d.ts +16 -0
  33. package/dist/generators/shared/runtime/useDeleteConnector.js +93 -0
  34. package/dist/generators/shared/runtime/useDetailConnector.d.ts +14 -0
  35. package/dist/generators/shared/runtime/useDetailConnector.js +50 -0
  36. package/dist/generators/shared/runtime/useFormConnector.d.ts +19 -0
  37. package/dist/generators/shared/runtime/useFormConnector.js +113 -0
  38. package/dist/generators/shared/runtime/useListConnector.d.ts +25 -0
  39. package/dist/generators/shared/runtime/useListConnector.js +125 -0
  40. package/dist/generators/shared/runtime/zod-error-merger.d.ts +23 -0
  41. package/dist/generators/shared/runtime/zod-error-merger.js +106 -0
  42. package/dist/generators/shared/templates/api-callbacks-plugin.js +54 -11
  43. package/dist/generators/shared/templates/api-pagination-plugin.d.ts +51 -0
  44. package/dist/generators/shared/templates/api-pagination-plugin.js +152 -0
  45. package/dist/generators/use-async-data/generator.d.ts +2 -1
  46. package/dist/generators/use-async-data/generator.js +14 -14
  47. package/dist/generators/use-async-data/runtime/useApiAsyncData.js +114 -13
  48. package/dist/generators/use-async-data/runtime/useApiAsyncDataRaw.js +88 -10
  49. package/dist/generators/use-async-data/templates.js +17 -17
  50. package/dist/generators/use-fetch/generator.d.ts +2 -1
  51. package/dist/generators/use-fetch/generator.js +12 -12
  52. package/dist/generators/use-fetch/runtime/useApiRequest.js +149 -40
  53. package/dist/generators/use-fetch/templates.js +14 -14
  54. package/dist/index.js +25 -0
  55. package/dist/module/index.d.ts +4 -0
  56. package/dist/module/index.js +93 -0
  57. package/dist/module/types.d.ts +27 -0
  58. package/dist/module/types.js +1 -0
  59. package/docs/API-REFERENCE.md +886 -887
  60. package/docs/generated-components.md +615 -0
  61. package/docs/headless-composables-ui.md +569 -0
  62. package/eslint.config.js +13 -0
  63. package/package.json +29 -2
  64. package/src/cli/config.ts +140 -140
  65. package/src/cli/logger.ts +124 -66
  66. package/src/cli/logo.ts +25 -25
  67. package/src/cli/types.ts +50 -50
  68. package/src/generators/components/connector-generator/generator.ts +138 -0
  69. package/src/generators/components/connector-generator/templates.ts +254 -0
  70. package/src/generators/components/connector-generator/types.ts +34 -0
  71. package/src/generators/components/schema-analyzer/index.ts +44 -0
  72. package/src/generators/components/schema-analyzer/intent-detector.ts +187 -0
  73. package/src/generators/components/schema-analyzer/openapi-reader.ts +96 -0
  74. package/src/generators/components/schema-analyzer/resource-grouper.ts +166 -0
  75. package/src/generators/components/schema-analyzer/schema-field-mapper.ts +268 -0
  76. package/src/generators/components/schema-analyzer/types.ts +177 -0
  77. package/src/generators/nuxt-server/generator.ts +272 -270
  78. package/src/generators/shared/runtime/apiHelpers.ts +535 -507
  79. package/src/generators/shared/runtime/pagination.ts +323 -0
  80. package/src/generators/shared/runtime/useDeleteConnector.ts +109 -0
  81. package/src/generators/shared/runtime/useDetailConnector.ts +64 -0
  82. package/src/generators/shared/runtime/useFormConnector.ts +139 -0
  83. package/src/generators/shared/runtime/useListConnector.ts +148 -0
  84. package/src/generators/shared/runtime/zod-error-merger.ts +119 -0
  85. package/src/generators/shared/templates/api-callbacks-plugin.ts +399 -352
  86. package/src/generators/shared/templates/api-pagination-plugin.ts +158 -0
  87. package/src/generators/use-async-data/generator.ts +205 -204
  88. package/src/generators/use-async-data/runtime/useApiAsyncData.ts +329 -229
  89. package/src/generators/use-async-data/runtime/useApiAsyncDataRaw.ts +324 -245
  90. package/src/generators/use-async-data/templates.ts +257 -257
  91. package/src/generators/use-fetch/generator.ts +170 -169
  92. package/src/generators/use-fetch/runtime/useApiRequest.ts +354 -234
  93. package/src/generators/use-fetch/templates.ts +214 -214
  94. package/src/index.ts +303 -265
  95. package/src/module/index.ts +133 -0
  96. package/src/module/types.ts +31 -0
  97. package/src/generators/tanstack-query/generator.ts +0 -11
@@ -1,169 +1,170 @@
1
- import * as path from 'path';
2
- import fs from 'fs-extra';
3
- import { fileURLToPath } from 'url';
4
- import { format } from 'prettier';
5
- import {
6
- getApiFiles as getApiFilesOfficial,
7
- parseApiFile as parseApiFileOfficial,
8
- } from './parser.js';
9
- import {
10
- getApiFiles as getApiFilesHeyApi,
11
- parseApiFile as parseApiFileHeyApi,
12
- } from '../shared/parsers/heyapi-parser.js';
13
- import { generateComposableFile, generateIndexFile, type GenerateOptions } from './templates.js';
14
- import type { MethodInfo } from './types.js';
15
- import { p, logSuccess, logError } from '../../cli/logger.js';
16
-
17
- /**
18
- * Main function to generate useFetch composables
19
- */
20
- export async function generateUseFetchComposables(
21
- inputDir: string,
22
- outputDir: string,
23
- options?: GenerateOptions
24
- ): Promise<void> {
25
- const mainSpinner = p.spinner();
26
-
27
- // Select parser based on chosen backend
28
- const getApiFiles = options?.backend === 'heyapi' ? getApiFilesHeyApi : getApiFilesOfficial;
29
- const parseApiFile = options?.backend === 'heyapi' ? parseApiFileHeyApi : parseApiFileOfficial;
30
-
31
- // 1. Get all API files
32
- mainSpinner.start('Scanning API files');
33
- const apiFiles = getApiFiles(inputDir);
34
- mainSpinner.stop(`Found ${apiFiles.length} API file(s)`);
35
-
36
- if (apiFiles.length === 0) {
37
- throw new Error('No API files found in the input directory');
38
- }
39
-
40
- // 2. Parse each API file
41
- mainSpinner.start('Parsing API files');
42
- const allMethods: MethodInfo[] = [];
43
-
44
- for (const file of apiFiles) {
45
- const fileName = path.basename(file);
46
- try {
47
- const apiInfo = parseApiFile(file);
48
- allMethods.push(...apiInfo.methods);
49
- } catch (error) {
50
- logError(`Error parsing ${fileName}: ${String(error)}`);
51
- }
52
- }
53
-
54
- mainSpinner.stop(`Found ${allMethods.length} methods to generate`);
55
-
56
- if (allMethods.length === 0) {
57
- p.log.warn('No methods found to generate');
58
- return;
59
- }
60
-
61
- // 3. Clean and create output directories
62
- mainSpinner.start('Preparing output directories');
63
- const composablesDir = path.join(outputDir, 'composables');
64
- const runtimeDir = path.join(outputDir, 'runtime');
65
- const sharedRuntimeDir = path.join(path.dirname(outputDir), 'shared', 'runtime');
66
- await fs.emptyDir(composablesDir);
67
- await fs.ensureDir(runtimeDir);
68
- await fs.ensureDir(sharedRuntimeDir);
69
- mainSpinner.stop('Output directories ready');
70
-
71
- // 4. Copy runtime helpers
72
- mainSpinner.start('Copying runtime files');
73
- // Derive __dirname equivalent for ESM
74
- const __dirname = path.dirname(fileURLToPath(import.meta.url));
75
- // When compiled, __dirname points to dist/generators/use-fetch/
76
- // We need to go back to src/ to get the original .ts files
77
-
78
- // Copy useApiRequest.ts
79
- const runtimeSource = path.resolve(
80
- __dirname,
81
- '../../../src/generators/use-fetch/runtime/useApiRequest.ts'
82
- );
83
- const runtimeDest = path.join(runtimeDir, 'useApiRequest.ts');
84
- await fs.copyFile(runtimeSource, runtimeDest);
85
-
86
- // Copy shared apiHelpers.ts
87
- const sharedHelpersSource = path.resolve(
88
- __dirname,
89
- '../../../src/generators/shared/runtime/apiHelpers.ts'
90
- );
91
- const sharedHelpersDest = path.join(sharedRuntimeDir, 'apiHelpers.ts');
92
- await fs.copyFile(sharedHelpersSource, sharedHelpersDest);
93
- mainSpinner.stop('Runtime files copied');
94
-
95
- // 5. Calculate relative import path from composables to APIs
96
- const relativePath = calculateRelativeImportPath(composablesDir, inputDir);
97
-
98
- // 6. Generate each composable
99
- mainSpinner.start('Generating composables');
100
- let successCount = 0;
101
- let errorCount = 0;
102
-
103
- for (const method of allMethods) {
104
- try {
105
- const code = generateComposableFile(method, relativePath, options);
106
- const formattedCode = await formatCode(code);
107
- const fileName = `${method.composableName}.ts`;
108
- const filePath = path.join(composablesDir, fileName);
109
-
110
- await fs.writeFile(filePath, formattedCode, 'utf-8');
111
- successCount++;
112
- } catch (error) {
113
- logError(`Error generating ${method.composableName}: ${String(error)}`);
114
- errorCount++;
115
- }
116
- }
117
-
118
- // 7. Generate index.ts
119
- const indexCode = generateIndexFile(allMethods.map((m) => m.composableName));
120
- const formattedIndex = await formatCode(indexCode);
121
- await fs.writeFile(path.join(outputDir, 'index.ts'), formattedIndex, 'utf-8');
122
- mainSpinner.stop(`Generated ${successCount} composables`);
123
-
124
- // 8. Summary
125
- if (errorCount > 0) {
126
- p.log.warn(`Completed with ${errorCount} error(s)`);
127
- }
128
- logSuccess(`Generated ${successCount} useFetch composable(s) in ${outputDir}`);
129
- }
130
-
131
- /**
132
- * Calculate relative import path from composables to APIs
133
- */
134
- function calculateRelativeImportPath(composablesDir: string, inputDir: string): string {
135
- // Import from the root index.ts which exports apis, models, and runtime
136
- let relativePath = path.relative(composablesDir, inputDir);
137
-
138
- // Convert Windows paths to Unix-style
139
- relativePath = relativePath.replace(/\\/g, '/');
140
-
141
- // Ensure it starts with './' or '../'
142
- if (!relativePath.startsWith('.')) {
143
- relativePath = './' + relativePath;
144
- }
145
-
146
- // Remove .ts extension and trailing /
147
- relativePath = relativePath.replace(/\.ts$/, '').replace(/\/$/, '');
148
-
149
- return relativePath;
150
- }
151
-
152
- /**
153
- * Format code with Prettier
154
- */
155
- async function formatCode(code: string): Promise<string> {
156
- try {
157
- return await format(code, {
158
- parser: 'typescript',
159
- semi: true,
160
- singleQuote: true,
161
- trailingComma: 'es5',
162
- printWidth: 80,
163
- tabWidth: 2,
164
- });
165
- } catch {
166
- p.log.warn('Could not format code with Prettier');
167
- return code;
168
- }
169
- }
1
+ import * as path from 'path';
2
+ import fs from 'fs-extra';
3
+ import { fileURLToPath } from 'url';
4
+ import { format } from 'prettier';
5
+ import {
6
+ getApiFiles as getApiFilesOfficial,
7
+ parseApiFile as parseApiFileOfficial,
8
+ } from './parser.js';
9
+ import {
10
+ getApiFiles as getApiFilesHeyApi,
11
+ parseApiFile as parseApiFileHeyApi,
12
+ } from '../shared/parsers/heyapi-parser.js';
13
+ import { generateComposableFile, generateIndexFile, type GenerateOptions } from './templates.js';
14
+ import type { MethodInfo } from './types.js';
15
+ import { type Logger, createClackLogger } from '../../cli/logger.js';
16
+
17
+ /**
18
+ * Main function to generate useFetch composables
19
+ */
20
+ export async function generateUseFetchComposables(
21
+ inputDir: string,
22
+ outputDir: string,
23
+ options?: GenerateOptions,
24
+ logger: Logger = createClackLogger()
25
+ ): Promise<void> {
26
+ const mainSpinner = logger.spinner();
27
+
28
+ // Select parser based on chosen backend
29
+ const getApiFiles = options?.backend === 'heyapi' ? getApiFilesHeyApi : getApiFilesOfficial;
30
+ const parseApiFile = options?.backend === 'heyapi' ? parseApiFileHeyApi : parseApiFileOfficial;
31
+
32
+ // 1. Get all API files
33
+ mainSpinner.start('Scanning API files');
34
+ const apiFiles = getApiFiles(inputDir);
35
+ mainSpinner.stop(`Found ${apiFiles.length} API file(s)`);
36
+
37
+ if (apiFiles.length === 0) {
38
+ throw new Error('No API files found in the input directory');
39
+ }
40
+
41
+ // 2. Parse each API file
42
+ mainSpinner.start('Parsing API files');
43
+ const allMethods: MethodInfo[] = [];
44
+
45
+ for (const file of apiFiles) {
46
+ const fileName = path.basename(file);
47
+ try {
48
+ const apiInfo = parseApiFile(file);
49
+ allMethods.push(...apiInfo.methods);
50
+ } catch (error) {
51
+ logger.log.error(`Error parsing ${fileName}: ${String(error)}`);
52
+ }
53
+ }
54
+
55
+ mainSpinner.stop(`Found ${allMethods.length} methods to generate`);
56
+
57
+ if (allMethods.length === 0) {
58
+ logger.log.warn('No methods found to generate');
59
+ return;
60
+ }
61
+
62
+ // 3. Clean and create output directories
63
+ mainSpinner.start('Preparing output directories');
64
+ const composablesDir = path.join(outputDir, 'composables');
65
+ const runtimeDir = path.join(outputDir, 'runtime');
66
+ const sharedRuntimeDir = path.join(path.dirname(outputDir), 'shared', 'runtime');
67
+ await fs.emptyDir(composablesDir);
68
+ await fs.ensureDir(runtimeDir);
69
+ await fs.ensureDir(sharedRuntimeDir);
70
+ mainSpinner.stop('Output directories ready');
71
+
72
+ // 4. Copy runtime helpers
73
+ mainSpinner.start('Copying runtime files');
74
+ // Derive __dirname equivalent for ESM
75
+ const __dirname = path.dirname(fileURLToPath(import.meta.url));
76
+ // When compiled, __dirname points to dist/generators/use-fetch/
77
+ // We need to go back to src/ to get the original .ts files
78
+
79
+ // Copy useApiRequest.ts
80
+ const runtimeSource = path.resolve(
81
+ __dirname,
82
+ '../../../src/generators/use-fetch/runtime/useApiRequest.ts'
83
+ );
84
+ const runtimeDest = path.join(runtimeDir, 'useApiRequest.ts');
85
+ await fs.copyFile(runtimeSource, runtimeDest);
86
+
87
+ // Copy shared apiHelpers.ts
88
+ const sharedHelpersSource = path.resolve(
89
+ __dirname,
90
+ '../../../src/generators/shared/runtime/apiHelpers.ts'
91
+ );
92
+ const sharedHelpersDest = path.join(sharedRuntimeDir, 'apiHelpers.ts');
93
+ await fs.copyFile(sharedHelpersSource, sharedHelpersDest);
94
+ mainSpinner.stop('Runtime files copied');
95
+
96
+ // 5. Calculate relative import path from composables to APIs
97
+ const relativePath = calculateRelativeImportPath(composablesDir, inputDir);
98
+
99
+ // 6. Generate each composable
100
+ mainSpinner.start('Generating composables');
101
+ let successCount = 0;
102
+ let errorCount = 0;
103
+
104
+ for (const method of allMethods) {
105
+ try {
106
+ const code = generateComposableFile(method, relativePath, options);
107
+ const formattedCode = await formatCode(code, logger);
108
+ const fileName = `${method.composableName}.ts`;
109
+ const filePath = path.join(composablesDir, fileName);
110
+
111
+ await fs.writeFile(filePath, formattedCode, 'utf-8');
112
+ successCount++;
113
+ } catch (error) {
114
+ logger.log.error(`Error generating ${method.composableName}: ${String(error)}`);
115
+ errorCount++;
116
+ }
117
+ }
118
+
119
+ // 7. Generate index.ts
120
+ const indexCode = generateIndexFile(allMethods.map((m) => m.composableName));
121
+ const formattedIndex = await formatCode(indexCode, logger);
122
+ await fs.writeFile(path.join(outputDir, 'index.ts'), formattedIndex, 'utf-8');
123
+ mainSpinner.stop(`Generated ${successCount} composables`);
124
+
125
+ // 8. Summary
126
+ if (errorCount > 0) {
127
+ logger.log.warn(`Completed with ${errorCount} error(s)`);
128
+ }
129
+ logger.log.success(`Generated ${successCount} useFetch composable(s) in ${outputDir}`);
130
+ }
131
+
132
+ /**
133
+ * Calculate relative import path from composables to APIs
134
+ */
135
+ function calculateRelativeImportPath(composablesDir: string, inputDir: string): string {
136
+ // Import from the root index.ts which exports apis, models, and runtime
137
+ let relativePath = path.relative(composablesDir, inputDir);
138
+
139
+ // Convert Windows paths to Unix-style
140
+ relativePath = relativePath.replace(/\\/g, '/');
141
+
142
+ // Ensure it starts with './' or '../'
143
+ if (!relativePath.startsWith('.')) {
144
+ relativePath = './' + relativePath;
145
+ }
146
+
147
+ // Remove .ts extension and trailing /
148
+ relativePath = relativePath.replace(/\.ts$/, '').replace(/\/$/, '');
149
+
150
+ return relativePath;
151
+ }
152
+
153
+ /**
154
+ * Format code with Prettier
155
+ */
156
+ async function formatCode(code: string, logger: Logger): Promise<string> {
157
+ try {
158
+ return await format(code, {
159
+ parser: 'typescript',
160
+ semi: true,
161
+ singleQuote: true,
162
+ trailingComma: 'es5',
163
+ printWidth: 80,
164
+ tabWidth: 2,
165
+ });
166
+ } catch {
167
+ logger.log.warn('Could not format code with Prettier');
168
+ return code;
169
+ }
170
+ }