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

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 (68) hide show
  1. package/.editorconfig +26 -26
  2. package/.prettierignore +17 -17
  3. package/CONTRIBUTING.md +291 -291
  4. package/INSTRUCTIONS.md +327 -327
  5. package/LICENSE +202 -202
  6. package/README.md +309 -231
  7. package/dist/cli/config.d.ts +9 -2
  8. package/dist/cli/config.js +1 -1
  9. package/dist/cli/logo.js +5 -5
  10. package/dist/cli/messages.d.ts +1 -0
  11. package/dist/cli/messages.js +2 -0
  12. package/dist/cli/prompts.d.ts +5 -0
  13. package/dist/cli/prompts.js +12 -0
  14. package/dist/cli/types.d.ts +1 -1
  15. package/dist/generators/components/connector-generator/templates.js +68 -19
  16. package/dist/generators/shared/runtime/useFormConnector.js +8 -1
  17. package/dist/generators/shared/runtime/useListConnector.js +13 -6
  18. package/dist/generators/use-async-data/generator.js +4 -0
  19. package/dist/generators/use-async-data/runtime/useApiAsyncData.js +4 -4
  20. package/dist/generators/use-async-data/runtime/useApiAsyncDataRaw.js +4 -4
  21. package/dist/generators/use-async-data/templates.js +17 -17
  22. package/dist/generators/use-fetch/generator.js +4 -0
  23. package/dist/generators/use-fetch/templates.js +14 -14
  24. package/dist/index.js +40 -27
  25. package/dist/module/index.js +19 -0
  26. package/dist/module/types.d.ts +7 -0
  27. package/docs/API-REFERENCE.md +886 -886
  28. package/docs/generated-components.md +615 -615
  29. package/docs/headless-composables-ui.md +569 -569
  30. package/eslint.config.js +85 -85
  31. package/package.json +1 -1
  32. package/src/cli/config.ts +147 -140
  33. package/src/cli/logger.ts +124 -124
  34. package/src/cli/logo.ts +25 -25
  35. package/src/cli/messages.ts +4 -0
  36. package/src/cli/prompts.ts +14 -1
  37. package/src/cli/types.ts +50 -50
  38. package/src/generators/components/connector-generator/generator.ts +138 -138
  39. package/src/generators/components/connector-generator/templates.ts +307 -254
  40. package/src/generators/components/connector-generator/types.ts +34 -34
  41. package/src/generators/components/schema-analyzer/index.ts +44 -44
  42. package/src/generators/components/schema-analyzer/intent-detector.ts +187 -187
  43. package/src/generators/components/schema-analyzer/openapi-reader.ts +96 -96
  44. package/src/generators/components/schema-analyzer/resource-grouper.ts +166 -166
  45. package/src/generators/components/schema-analyzer/schema-field-mapper.ts +268 -268
  46. package/src/generators/components/schema-analyzer/types.ts +177 -177
  47. package/src/generators/nuxt-server/generator.ts +272 -272
  48. package/src/generators/shared/runtime/apiHelpers.ts +535 -535
  49. package/src/generators/shared/runtime/pagination.ts +323 -323
  50. package/src/generators/shared/runtime/useDeleteConnector.ts +109 -109
  51. package/src/generators/shared/runtime/useDetailConnector.ts +64 -64
  52. package/src/generators/shared/runtime/useFormConnector.ts +147 -139
  53. package/src/generators/shared/runtime/useListConnector.ts +158 -148
  54. package/src/generators/shared/runtime/zod-error-merger.ts +119 -119
  55. package/src/generators/shared/templates/api-callbacks-plugin.ts +399 -399
  56. package/src/generators/shared/templates/api-pagination-plugin.ts +158 -158
  57. package/src/generators/use-async-data/generator.ts +213 -205
  58. package/src/generators/use-async-data/runtime/useApiAsyncData.ts +329 -329
  59. package/src/generators/use-async-data/runtime/useApiAsyncDataRaw.ts +324 -324
  60. package/src/generators/use-async-data/templates.ts +257 -257
  61. package/src/generators/use-fetch/generator.ts +178 -170
  62. package/src/generators/use-fetch/runtime/useApiRequest.ts +354 -354
  63. package/src/generators/use-fetch/templates.ts +214 -214
  64. package/src/index.ts +306 -303
  65. package/src/module/index.ts +158 -133
  66. package/src/module/types.ts +39 -31
  67. package/dist/generators/tanstack-query/generator.d.ts +0 -5
  68. package/dist/generators/tanstack-query/generator.js +0 -11
@@ -1,214 +1,214 @@
1
- import type { MethodInfo } from './types.js';
2
-
3
- /**
4
- * Generate file header with auto-generation warning
5
- */
6
- function generateFileHeader(): string {
7
- return `/**
8
- * ⚠️ AUTO-GENERATED FILE - DO NOT EDIT MANUALLY
9
- *
10
- * This file was automatically generated by nuxt-openapi-generator.
11
- * Any manual changes will be overwritten on the next generation.
12
- *
13
- * @generated by nuxt-openapi-generator
14
- * @see https://github.com/dmartindiaz/nuxt-openapi-hyperfetch
15
- */
16
-
17
- /* eslint-disable */
18
- // @ts-nocheck
19
- `;
20
- }
21
-
22
- /**
23
- * Options for code generation
24
- */
25
- export interface GenerateOptions {
26
- baseUrl?: string;
27
- backend?: string;
28
- }
29
-
30
- /**
31
- * Generate a useFetch composable function
32
- */
33
- export function generateComposableFile(
34
- method: MethodInfo,
35
- apiImportPath: string,
36
- options?: GenerateOptions
37
- ): string {
38
- const header = generateFileHeader();
39
- const imports = generateImports(method, apiImportPath);
40
- const functionBody = generateFunctionBody(method, options);
41
-
42
- return `${header}${imports}\n\n${functionBody}\n`;
43
- }
44
-
45
- /**
46
- * Extract base type names from a type string
47
- * Examples:
48
- * Pet[] -> Pet
49
- * Array<Pet> -> Pet
50
- * Pet -> Pet
51
- * { [key: string]: Pet } -> (empty, it's anonymous)
52
- */
53
- function extractBaseTypes(type: string): string[] {
54
- if (!type) {
55
- return [];
56
- }
57
-
58
- // Handle array syntax: Pet[]
59
- const arrayMatch = type.match(/^(\w+)\[\]$/);
60
- if (arrayMatch) {
61
- return [arrayMatch[1]];
62
- }
63
-
64
- // Handle Array generic: Array<Pet>
65
- const arrayGenericMatch = type.match(/^Array<(\w+)>$/);
66
- if (arrayGenericMatch) {
67
- return [arrayGenericMatch[1]];
68
- }
69
-
70
- // If it's a simple named type (single word, PascalCase), include it
71
- if (/^[A-Z][a-zA-Z0-9]*$/.test(type)) {
72
- return [type];
73
- }
74
-
75
- // For complex types, don't extract anything
76
- return [];
77
- }
78
-
79
- /**
80
- * Generate import statements
81
- */
82
- function generateImports(method: MethodInfo, apiImportPath: string): string {
83
- const typeNames = new Set<string>();
84
-
85
- // Extract base types from request type
86
- if (method.requestType) {
87
- const extracted = extractBaseTypes(method.requestType);
88
- extracted.forEach((t) => typeNames.add(t));
89
- }
90
-
91
- // Extract base types from response type
92
- if (method.responseType && method.responseType !== 'void') {
93
- const extracted = extractBaseTypes(method.responseType);
94
- extracted.forEach((t) => typeNames.add(t));
95
- }
96
-
97
- let imports = '';
98
-
99
- // Import types from API (only if we have named types to import)
100
- if (typeNames.size > 0) {
101
- imports += `import type { ${Array.from(typeNames).join(', ')} } from '${apiImportPath}';\n`;
102
- }
103
-
104
- // Import runtime helper
105
- imports += `import { useApiRequest, type ApiRequestOptions } from '../runtime/useApiRequest';`;
106
-
107
- return imports;
108
- }
109
-
110
- /**
111
- }
112
-
113
- /**
114
- * Generate the composable function body
115
- */
116
- function generateFunctionBody(method: MethodInfo, options?: GenerateOptions): string {
117
- const hasParams = !!method.requestType;
118
- const paramsArg = hasParams ? `params: ${method.requestType}` : '';
119
- const optionsType = `ApiRequestOptions<${method.responseType}>`;
120
- const optionsArg = `options?: ${optionsType}`;
121
- const args = hasParams ? `${paramsArg}, ${optionsArg}` : optionsArg;
122
-
123
- const responseTypeGeneric = method.responseType !== 'void' ? `<${method.responseType}>` : '';
124
-
125
- const url = generateUrl(method);
126
- const fetchOptions = generateFetchOptions(method, options);
127
-
128
- const description = method.description ? `/**\n * ${method.description}\n */\n` : '';
129
-
130
- const pInit = hasParams ? `\n const p = shallowRef(params)` : '';
131
-
132
- return `${description}export const ${method.composableName} = (${args}) => {${pInit}
133
- return useApiRequest${responseTypeGeneric}(${url}, ${fetchOptions})
134
- }`;
135
- }
136
-
137
- /**
138
- * Generate URL (with path params if needed)
139
- */
140
- function generateUrl(method: MethodInfo): string {
141
- if (method.pathParams.length === 0) {
142
- return `'${method.path}'`;
143
- }
144
-
145
- let url = method.path;
146
- for (const param of method.pathParams) {
147
- const accessor = method.paramsShape === 'nested' ? `p.value.path.${param}` : `p.value.${param}`;
148
- url = url.replace(`{${param}}`, `\${${accessor}}`);
149
- }
150
-
151
- return `() => \`${url}\``;
152
- }
153
-
154
- /**
155
- * Generate fetch options object
156
- */
157
- function generateFetchOptions(method: MethodInfo, generateOptions?: GenerateOptions): string {
158
- const options: string[] = [];
159
-
160
- // Method
161
- options.push(`method: '${method.httpMethod}'`);
162
-
163
- // Base URL (if provided in config)
164
- if (generateOptions?.baseUrl) {
165
- options.push(`baseURL: '${generateOptions.baseUrl}'`);
166
- }
167
-
168
- // Body
169
- if (method.hasBody) {
170
- if (method.paramsShape === 'nested') {
171
- options.push(`body: computed(() => p.value.body)`);
172
- } else if (method.bodyField) {
173
- options.push(`body: computed(() => p.value.${method.bodyField})`);
174
- }
175
- }
176
-
177
- // Query params
178
- if (method.hasQueryParams) {
179
- if (method.paramsShape === 'nested') {
180
- options.push(`query: computed(() => p.value.query)`);
181
- } else if (method.queryParams.length > 0) {
182
- const queryObj = method.queryParams
183
- .map((param) => `${param}: p.value.${param}`)
184
- .join(',\n ');
185
- options.push(`query: computed(() => ({\n ${queryObj}\n }))`);
186
- }
187
- }
188
-
189
- // Headers
190
- if (Object.keys(method.headers).length > 0) {
191
- const headersEntries = Object.entries(method.headers)
192
- .map(([key, value]) => `'${key}': '${value}'`)
193
- .join(',\n ');
194
- options.push(`headers: {\n ${headersEntries},\n ...options?.headers\n }`);
195
- }
196
-
197
- // Spread options
198
- options.push('...options');
199
-
200
- const optionsStr = options.join(',\n ');
201
- return `{\n ${optionsStr}\n }`;
202
- }
203
-
204
- /**
205
- * Generate index.ts that exports all composables
206
- */
207
- export function generateIndexFile(composableNames: string[]): string {
208
- const header = generateFileHeader();
209
- const exports = composableNames
210
- .map((name) => `export { ${name} } from './composables/${name}'`)
211
- .join('\n');
212
-
213
- return `${header}${exports}\n`;
214
- }
1
+ import type { MethodInfo } from './types.js';
2
+
3
+ /**
4
+ * Generate file header with auto-generation warning
5
+ */
6
+ function generateFileHeader(): string {
7
+ return `/**
8
+ * ⚠️ AUTO-GENERATED FILE - DO NOT EDIT MANUALLY
9
+ *
10
+ * This file was automatically generated by nuxt-openapi-generator.
11
+ * Any manual changes will be overwritten on the next generation.
12
+ *
13
+ * @generated by nuxt-openapi-generator
14
+ * @see https://github.com/dmartindiaz/nuxt-openapi-hyperfetch
15
+ */
16
+
17
+ /* eslint-disable */
18
+ // @ts-nocheck
19
+ `;
20
+ }
21
+
22
+ /**
23
+ * Options for code generation
24
+ */
25
+ export interface GenerateOptions {
26
+ baseUrl?: string;
27
+ backend?: string;
28
+ }
29
+
30
+ /**
31
+ * Generate a useFetch composable function
32
+ */
33
+ export function generateComposableFile(
34
+ method: MethodInfo,
35
+ apiImportPath: string,
36
+ options?: GenerateOptions
37
+ ): string {
38
+ const header = generateFileHeader();
39
+ const imports = generateImports(method, apiImportPath);
40
+ const functionBody = generateFunctionBody(method, options);
41
+
42
+ return `${header}${imports}\n\n${functionBody}\n`;
43
+ }
44
+
45
+ /**
46
+ * Extract base type names from a type string
47
+ * Examples:
48
+ * Pet[] -> Pet
49
+ * Array<Pet> -> Pet
50
+ * Pet -> Pet
51
+ * { [key: string]: Pet } -> (empty, it's anonymous)
52
+ */
53
+ function extractBaseTypes(type: string): string[] {
54
+ if (!type) {
55
+ return [];
56
+ }
57
+
58
+ // Handle array syntax: Pet[]
59
+ const arrayMatch = type.match(/^(\w+)\[\]$/);
60
+ if (arrayMatch) {
61
+ return [arrayMatch[1]];
62
+ }
63
+
64
+ // Handle Array generic: Array<Pet>
65
+ const arrayGenericMatch = type.match(/^Array<(\w+)>$/);
66
+ if (arrayGenericMatch) {
67
+ return [arrayGenericMatch[1]];
68
+ }
69
+
70
+ // If it's a simple named type (single word, PascalCase), include it
71
+ if (/^[A-Z][a-zA-Z0-9]*$/.test(type)) {
72
+ return [type];
73
+ }
74
+
75
+ // For complex types, don't extract anything
76
+ return [];
77
+ }
78
+
79
+ /**
80
+ * Generate import statements
81
+ */
82
+ function generateImports(method: MethodInfo, apiImportPath: string): string {
83
+ const typeNames = new Set<string>();
84
+
85
+ // Extract base types from request type
86
+ if (method.requestType) {
87
+ const extracted = extractBaseTypes(method.requestType);
88
+ extracted.forEach((t) => typeNames.add(t));
89
+ }
90
+
91
+ // Extract base types from response type
92
+ if (method.responseType && method.responseType !== 'void') {
93
+ const extracted = extractBaseTypes(method.responseType);
94
+ extracted.forEach((t) => typeNames.add(t));
95
+ }
96
+
97
+ let imports = '';
98
+
99
+ // Import types from API (only if we have named types to import)
100
+ if (typeNames.size > 0) {
101
+ imports += `import type { ${Array.from(typeNames).join(', ')} } from '${apiImportPath}';\n`;
102
+ }
103
+
104
+ // Import runtime helper
105
+ imports += `import { useApiRequest, type ApiRequestOptions } from '../runtime/useApiRequest';`;
106
+
107
+ return imports;
108
+ }
109
+
110
+ /**
111
+ }
112
+
113
+ /**
114
+ * Generate the composable function body
115
+ */
116
+ function generateFunctionBody(method: MethodInfo, options?: GenerateOptions): string {
117
+ const hasParams = !!method.requestType;
118
+ const paramsArg = hasParams ? `params: ${method.requestType}` : '';
119
+ const optionsType = `ApiRequestOptions<${method.responseType}>`;
120
+ const optionsArg = `options?: ${optionsType}`;
121
+ const args = hasParams ? `${paramsArg}, ${optionsArg}` : optionsArg;
122
+
123
+ const responseTypeGeneric = method.responseType !== 'void' ? `<${method.responseType}>` : '';
124
+
125
+ const url = generateUrl(method);
126
+ const fetchOptions = generateFetchOptions(method, options);
127
+
128
+ const description = method.description ? `/**\n * ${method.description}\n */\n` : '';
129
+
130
+ const pInit = hasParams ? `\n const p = shallowRef(params)` : '';
131
+
132
+ return `${description}export const ${method.composableName} = (${args}) => {${pInit}
133
+ return useApiRequest${responseTypeGeneric}(${url}, ${fetchOptions})
134
+ }`;
135
+ }
136
+
137
+ /**
138
+ * Generate URL (with path params if needed)
139
+ */
140
+ function generateUrl(method: MethodInfo): string {
141
+ if (method.pathParams.length === 0) {
142
+ return `'${method.path}'`;
143
+ }
144
+
145
+ let url = method.path;
146
+ for (const param of method.pathParams) {
147
+ const accessor = method.paramsShape === 'nested' ? `p.value.path.${param}` : `p.value.${param}`;
148
+ url = url.replace(`{${param}}`, `\${${accessor}}`);
149
+ }
150
+
151
+ return `() => \`${url}\``;
152
+ }
153
+
154
+ /**
155
+ * Generate fetch options object
156
+ */
157
+ function generateFetchOptions(method: MethodInfo, generateOptions?: GenerateOptions): string {
158
+ const options: string[] = [];
159
+
160
+ // Method
161
+ options.push(`method: '${method.httpMethod}'`);
162
+
163
+ // Base URL (if provided in config)
164
+ if (generateOptions?.baseUrl) {
165
+ options.push(`baseURL: '${generateOptions.baseUrl}'`);
166
+ }
167
+
168
+ // Body
169
+ if (method.hasBody) {
170
+ if (method.paramsShape === 'nested') {
171
+ options.push(`body: computed(() => p.value.body)`);
172
+ } else if (method.bodyField) {
173
+ options.push(`body: computed(() => p.value.${method.bodyField})`);
174
+ }
175
+ }
176
+
177
+ // Query params
178
+ if (method.hasQueryParams) {
179
+ if (method.paramsShape === 'nested') {
180
+ options.push(`query: computed(() => p.value.query)`);
181
+ } else if (method.queryParams.length > 0) {
182
+ const queryObj = method.queryParams
183
+ .map((param) => `${param}: p.value.${param}`)
184
+ .join(',\n ');
185
+ options.push(`query: computed(() => ({\n ${queryObj}\n }))`);
186
+ }
187
+ }
188
+
189
+ // Headers
190
+ if (Object.keys(method.headers).length > 0) {
191
+ const headersEntries = Object.entries(method.headers)
192
+ .map(([key, value]) => `'${key}': '${value}'`)
193
+ .join(',\n ');
194
+ options.push(`headers: {\n ${headersEntries},\n ...options?.headers\n }`);
195
+ }
196
+
197
+ // Spread options
198
+ options.push('...options');
199
+
200
+ const optionsStr = options.join(',\n ');
201
+ return `{\n ${optionsStr}\n }`;
202
+ }
203
+
204
+ /**
205
+ * Generate index.ts that exports all composables
206
+ */
207
+ export function generateIndexFile(composableNames: string[]): string {
208
+ const header = generateFileHeader();
209
+ const exports = composableNames
210
+ .map((name) => `export { ${name} } from './composables/${name}'`)
211
+ .join('\n');
212
+
213
+ return `${header}${exports}\n`;
214
+ }