nuxt-openapi-hyperfetch 0.2.7-alpha.1 → 0.2.8-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.
- package/.editorconfig +26 -26
- package/.prettierignore +17 -17
- package/CONTRIBUTING.md +291 -291
- package/INSTRUCTIONS.md +327 -327
- package/LICENSE +202 -202
- package/README.md +231 -231
- package/dist/cli/config.d.ts +9 -2
- package/dist/cli/config.js +1 -1
- package/dist/cli/logo.js +5 -5
- package/dist/cli/messages.d.ts +1 -0
- package/dist/cli/messages.js +2 -0
- package/dist/cli/prompts.d.ts +5 -0
- package/dist/cli/prompts.js +12 -0
- package/dist/cli/types.d.ts +1 -1
- package/dist/generators/components/connector-generator/templates.js +12 -12
- package/dist/generators/use-async-data/templates.js +17 -17
- package/dist/generators/use-fetch/templates.js +14 -14
- package/dist/index.js +39 -27
- package/dist/module/index.js +19 -0
- package/dist/module/types.d.ts +7 -0
- package/docs/API-REFERENCE.md +886 -886
- package/docs/generated-components.md +615 -615
- package/docs/headless-composables-ui.md +569 -569
- package/eslint.config.js +85 -85
- package/package.json +1 -1
- package/src/cli/config.ts +147 -140
- package/src/cli/logger.ts +124 -124
- package/src/cli/logo.ts +25 -25
- package/src/cli/messages.ts +4 -0
- package/src/cli/prompts.ts +14 -1
- package/src/cli/types.ts +50 -50
- package/src/generators/components/connector-generator/generator.ts +138 -138
- package/src/generators/components/connector-generator/templates.ts +254 -254
- package/src/generators/components/connector-generator/types.ts +34 -34
- package/src/generators/components/schema-analyzer/index.ts +44 -44
- package/src/generators/components/schema-analyzer/intent-detector.ts +187 -187
- package/src/generators/components/schema-analyzer/openapi-reader.ts +96 -96
- package/src/generators/components/schema-analyzer/resource-grouper.ts +166 -166
- package/src/generators/components/schema-analyzer/schema-field-mapper.ts +268 -268
- package/src/generators/components/schema-analyzer/types.ts +177 -177
- package/src/generators/nuxt-server/generator.ts +272 -272
- package/src/generators/shared/runtime/apiHelpers.ts +535 -535
- package/src/generators/shared/runtime/pagination.ts +323 -323
- package/src/generators/shared/runtime/useDeleteConnector.ts +109 -109
- package/src/generators/shared/runtime/useDetailConnector.ts +64 -64
- package/src/generators/shared/runtime/useFormConnector.ts +139 -139
- package/src/generators/shared/runtime/useListConnector.ts +148 -148
- package/src/generators/shared/runtime/zod-error-merger.ts +119 -119
- package/src/generators/shared/templates/api-callbacks-plugin.ts +399 -399
- package/src/generators/shared/templates/api-pagination-plugin.ts +158 -158
- package/src/generators/use-async-data/generator.ts +205 -205
- package/src/generators/use-async-data/runtime/useApiAsyncData.ts +329 -329
- package/src/generators/use-async-data/runtime/useApiAsyncDataRaw.ts +324 -324
- package/src/generators/use-async-data/templates.ts +257 -257
- package/src/generators/use-fetch/generator.ts +170 -170
- package/src/generators/use-fetch/runtime/useApiRequest.ts +354 -354
- package/src/generators/use-fetch/templates.ts +214 -214
- package/src/index.ts +305 -303
- package/src/module/index.ts +158 -133
- package/src/module/types.ts +39 -31
|
@@ -1,138 +1,138 @@
|
|
|
1
|
-
import * as path from 'path';
|
|
2
|
-
import fs from 'fs-extra';
|
|
3
|
-
import { fileURLToPath } from 'url';
|
|
4
|
-
import { format } from 'prettier';
|
|
5
|
-
import { analyzeSpec } from '../schema-analyzer/index.js';
|
|
6
|
-
import {
|
|
7
|
-
generateConnectorFile,
|
|
8
|
-
connectorFileName,
|
|
9
|
-
generateConnectorIndexFile,
|
|
10
|
-
} from './templates.js';
|
|
11
|
-
import type { ConnectorGeneratorOptions } from './types.js';
|
|
12
|
-
import { type Logger, createClackLogger } from '../../../cli/logger.js';
|
|
13
|
-
|
|
14
|
-
// Runtime files that must be copied to the user's project
|
|
15
|
-
const RUNTIME_FILES = [
|
|
16
|
-
'useListConnector.ts',
|
|
17
|
-
'useDetailConnector.ts',
|
|
18
|
-
'useFormConnector.ts',
|
|
19
|
-
'useDeleteConnector.ts',
|
|
20
|
-
'zod-error-merger.ts',
|
|
21
|
-
] as const;
|
|
22
|
-
|
|
23
|
-
/**
|
|
24
|
-
* Format TypeScript source with Prettier.
|
|
25
|
-
* Falls back to unformatted code on error.
|
|
26
|
-
*/
|
|
27
|
-
async function formatCode(code: string, logger: Logger): Promise<string> {
|
|
28
|
-
try {
|
|
29
|
-
return await format(code, { parser: 'typescript' });
|
|
30
|
-
} catch (error) {
|
|
31
|
-
logger.log.warn(`Prettier formatting failed: ${String(error)}`);
|
|
32
|
-
return code;
|
|
33
|
-
}
|
|
34
|
-
}
|
|
35
|
-
|
|
36
|
-
/**
|
|
37
|
-
* Generate headless connector composables from an OpenAPI spec.
|
|
38
|
-
*
|
|
39
|
-
* Steps:
|
|
40
|
-
* 1. Analyze the spec → ResourceMap (Schema Analyzer)
|
|
41
|
-
* 2. For each resource: generate connector source, format, write
|
|
42
|
-
* 3. Write an index barrel file
|
|
43
|
-
* 4. Copy runtime helpers to the user's project
|
|
44
|
-
*/
|
|
45
|
-
export async function generateConnectors(
|
|
46
|
-
options: ConnectorGeneratorOptions,
|
|
47
|
-
logger: Logger = createClackLogger()
|
|
48
|
-
): Promise<void> {
|
|
49
|
-
const spinner = logger.spinner();
|
|
50
|
-
|
|
51
|
-
const outputDir = path.resolve(options.outputDir);
|
|
52
|
-
const composablesRelDir = options.composablesRelDir ?? '../use-async-data';
|
|
53
|
-
const runtimeRelDir = options.runtimeRelDir ?? '../runtime';
|
|
54
|
-
|
|
55
|
-
// ── 1. Analyze spec ───────────────────────────────────────────────────────
|
|
56
|
-
spinner.start('Analyzing OpenAPI spec');
|
|
57
|
-
const resourceMap = analyzeSpec(options.inputSpec);
|
|
58
|
-
spinner.stop(`Found ${resourceMap.size} resource(s)`);
|
|
59
|
-
|
|
60
|
-
if (resourceMap.size === 0) {
|
|
61
|
-
logger.log.warn('No resources found in spec — nothing to generate');
|
|
62
|
-
return;
|
|
63
|
-
}
|
|
64
|
-
|
|
65
|
-
// ── 2. Prepare output directory ───────────────────────────────────────────
|
|
66
|
-
// emptyDir (not ensureDir) so stale connectors from previous runs are removed.
|
|
67
|
-
// If the resource got renamed in the spec the old file would otherwise linger.
|
|
68
|
-
spinner.start('Preparing output directory');
|
|
69
|
-
await fs.emptyDir(outputDir);
|
|
70
|
-
spinner.stop('Output directory ready');
|
|
71
|
-
|
|
72
|
-
// ── 3. Generate connector files ───────────────────────────────────────────
|
|
73
|
-
spinner.start('Generating connector composables');
|
|
74
|
-
let successCount = 0;
|
|
75
|
-
let errorCount = 0;
|
|
76
|
-
const generatedNames: string[] = [];
|
|
77
|
-
|
|
78
|
-
for (const resource of resourceMap.values()) {
|
|
79
|
-
try {
|
|
80
|
-
const code = generateConnectorFile(resource, composablesRelDir);
|
|
81
|
-
const formatted = await formatCode(code, logger);
|
|
82
|
-
const fileName = connectorFileName(resource.composableName);
|
|
83
|
-
const filePath = path.join(outputDir, fileName);
|
|
84
|
-
|
|
85
|
-
await fs.writeFile(filePath, formatted, 'utf-8');
|
|
86
|
-
generatedNames.push(resource.composableName);
|
|
87
|
-
successCount++;
|
|
88
|
-
} catch (error) {
|
|
89
|
-
logger.log.error(`Error generating ${resource.composableName}: ${String(error)}`);
|
|
90
|
-
errorCount++;
|
|
91
|
-
}
|
|
92
|
-
}
|
|
93
|
-
|
|
94
|
-
spinner.stop(`Generated ${successCount} connector(s)`);
|
|
95
|
-
|
|
96
|
-
// ── 4. Write barrel index ─────────────────────────────────────────────────
|
|
97
|
-
if (generatedNames.length > 0) {
|
|
98
|
-
try {
|
|
99
|
-
const indexCode = generateConnectorIndexFile(generatedNames);
|
|
100
|
-
const formattedIndex = await formatCode(indexCode, logger);
|
|
101
|
-
await fs.writeFile(path.join(outputDir, 'index.ts'), formattedIndex, 'utf-8');
|
|
102
|
-
} catch (error) {
|
|
103
|
-
logger.log.warn(`Could not write connector index: ${String(error)}`);
|
|
104
|
-
}
|
|
105
|
-
}
|
|
106
|
-
|
|
107
|
-
// ── 5. Copy runtime helpers ───────────────────────────────────────────────
|
|
108
|
-
// Runtime files (useListConnector, useFormConnector …) live in src/ and must
|
|
109
|
-
// be physical .ts files in the user's project so Nuxt/Vite can type-check them.
|
|
110
|
-
//
|
|
111
|
-
// Path resolution trick:
|
|
112
|
-
// • During development (ts-node / tsx): __dirname ≈ src/generators/components/connector-generator/
|
|
113
|
-
// • After `tsc` build: __dirname ≈ dist/generators/components/connector-generator/
|
|
114
|
-
//
|
|
115
|
-
// In both cases we need to land in src/generators/shared/runtime/, so we step
|
|
116
|
-
// up 4 levels and then re-enter src/ explicitly. This works because the repo
|
|
117
|
-
// always keeps src/ alongside dist/ in the published package (see "files" in package.json).
|
|
118
|
-
spinner.start('Copying runtime files');
|
|
119
|
-
const runtimeDir = path.resolve(outputDir, runtimeRelDir);
|
|
120
|
-
await fs.ensureDir(runtimeDir); // ensureDir (not emptyDir) — other runtime files may exist there
|
|
121
|
-
|
|
122
|
-
const __dirname = path.dirname(fileURLToPath(import.meta.url));
|
|
123
|
-
const runtimeSrcDir = path.resolve(__dirname, '../../../../src/generators/shared/runtime');
|
|
124
|
-
|
|
125
|
-
for (const file of RUNTIME_FILES) {
|
|
126
|
-
const src = path.join(runtimeSrcDir, file);
|
|
127
|
-
const dest = path.join(runtimeDir, file);
|
|
128
|
-
await fs.copyFile(src, dest);
|
|
129
|
-
}
|
|
130
|
-
|
|
131
|
-
spinner.stop('Runtime files copied');
|
|
132
|
-
|
|
133
|
-
// ── 6. Summary ────────────────────────────────────────────────────────────
|
|
134
|
-
if (errorCount > 0) {
|
|
135
|
-
logger.log.warn(`Completed with ${errorCount} error(s)`);
|
|
136
|
-
}
|
|
137
|
-
logger.log.success(`Generated ${successCount} connector(s) in ${outputDir}`);
|
|
138
|
-
}
|
|
1
|
+
import * as path from 'path';
|
|
2
|
+
import fs from 'fs-extra';
|
|
3
|
+
import { fileURLToPath } from 'url';
|
|
4
|
+
import { format } from 'prettier';
|
|
5
|
+
import { analyzeSpec } from '../schema-analyzer/index.js';
|
|
6
|
+
import {
|
|
7
|
+
generateConnectorFile,
|
|
8
|
+
connectorFileName,
|
|
9
|
+
generateConnectorIndexFile,
|
|
10
|
+
} from './templates.js';
|
|
11
|
+
import type { ConnectorGeneratorOptions } from './types.js';
|
|
12
|
+
import { type Logger, createClackLogger } from '../../../cli/logger.js';
|
|
13
|
+
|
|
14
|
+
// Runtime files that must be copied to the user's project
|
|
15
|
+
const RUNTIME_FILES = [
|
|
16
|
+
'useListConnector.ts',
|
|
17
|
+
'useDetailConnector.ts',
|
|
18
|
+
'useFormConnector.ts',
|
|
19
|
+
'useDeleteConnector.ts',
|
|
20
|
+
'zod-error-merger.ts',
|
|
21
|
+
] as const;
|
|
22
|
+
|
|
23
|
+
/**
|
|
24
|
+
* Format TypeScript source with Prettier.
|
|
25
|
+
* Falls back to unformatted code on error.
|
|
26
|
+
*/
|
|
27
|
+
async function formatCode(code: string, logger: Logger): Promise<string> {
|
|
28
|
+
try {
|
|
29
|
+
return await format(code, { parser: 'typescript' });
|
|
30
|
+
} catch (error) {
|
|
31
|
+
logger.log.warn(`Prettier formatting failed: ${String(error)}`);
|
|
32
|
+
return code;
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
/**
|
|
37
|
+
* Generate headless connector composables from an OpenAPI spec.
|
|
38
|
+
*
|
|
39
|
+
* Steps:
|
|
40
|
+
* 1. Analyze the spec → ResourceMap (Schema Analyzer)
|
|
41
|
+
* 2. For each resource: generate connector source, format, write
|
|
42
|
+
* 3. Write an index barrel file
|
|
43
|
+
* 4. Copy runtime helpers to the user's project
|
|
44
|
+
*/
|
|
45
|
+
export async function generateConnectors(
|
|
46
|
+
options: ConnectorGeneratorOptions,
|
|
47
|
+
logger: Logger = createClackLogger()
|
|
48
|
+
): Promise<void> {
|
|
49
|
+
const spinner = logger.spinner();
|
|
50
|
+
|
|
51
|
+
const outputDir = path.resolve(options.outputDir);
|
|
52
|
+
const composablesRelDir = options.composablesRelDir ?? '../use-async-data';
|
|
53
|
+
const runtimeRelDir = options.runtimeRelDir ?? '../runtime';
|
|
54
|
+
|
|
55
|
+
// ── 1. Analyze spec ───────────────────────────────────────────────────────
|
|
56
|
+
spinner.start('Analyzing OpenAPI spec');
|
|
57
|
+
const resourceMap = analyzeSpec(options.inputSpec);
|
|
58
|
+
spinner.stop(`Found ${resourceMap.size} resource(s)`);
|
|
59
|
+
|
|
60
|
+
if (resourceMap.size === 0) {
|
|
61
|
+
logger.log.warn('No resources found in spec — nothing to generate');
|
|
62
|
+
return;
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
// ── 2. Prepare output directory ───────────────────────────────────────────
|
|
66
|
+
// emptyDir (not ensureDir) so stale connectors from previous runs are removed.
|
|
67
|
+
// If the resource got renamed in the spec the old file would otherwise linger.
|
|
68
|
+
spinner.start('Preparing output directory');
|
|
69
|
+
await fs.emptyDir(outputDir);
|
|
70
|
+
spinner.stop('Output directory ready');
|
|
71
|
+
|
|
72
|
+
// ── 3. Generate connector files ───────────────────────────────────────────
|
|
73
|
+
spinner.start('Generating connector composables');
|
|
74
|
+
let successCount = 0;
|
|
75
|
+
let errorCount = 0;
|
|
76
|
+
const generatedNames: string[] = [];
|
|
77
|
+
|
|
78
|
+
for (const resource of resourceMap.values()) {
|
|
79
|
+
try {
|
|
80
|
+
const code = generateConnectorFile(resource, composablesRelDir);
|
|
81
|
+
const formatted = await formatCode(code, logger);
|
|
82
|
+
const fileName = connectorFileName(resource.composableName);
|
|
83
|
+
const filePath = path.join(outputDir, fileName);
|
|
84
|
+
|
|
85
|
+
await fs.writeFile(filePath, formatted, 'utf-8');
|
|
86
|
+
generatedNames.push(resource.composableName);
|
|
87
|
+
successCount++;
|
|
88
|
+
} catch (error) {
|
|
89
|
+
logger.log.error(`Error generating ${resource.composableName}: ${String(error)}`);
|
|
90
|
+
errorCount++;
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
spinner.stop(`Generated ${successCount} connector(s)`);
|
|
95
|
+
|
|
96
|
+
// ── 4. Write barrel index ─────────────────────────────────────────────────
|
|
97
|
+
if (generatedNames.length > 0) {
|
|
98
|
+
try {
|
|
99
|
+
const indexCode = generateConnectorIndexFile(generatedNames);
|
|
100
|
+
const formattedIndex = await formatCode(indexCode, logger);
|
|
101
|
+
await fs.writeFile(path.join(outputDir, 'index.ts'), formattedIndex, 'utf-8');
|
|
102
|
+
} catch (error) {
|
|
103
|
+
logger.log.warn(`Could not write connector index: ${String(error)}`);
|
|
104
|
+
}
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
// ── 5. Copy runtime helpers ───────────────────────────────────────────────
|
|
108
|
+
// Runtime files (useListConnector, useFormConnector …) live in src/ and must
|
|
109
|
+
// be physical .ts files in the user's project so Nuxt/Vite can type-check them.
|
|
110
|
+
//
|
|
111
|
+
// Path resolution trick:
|
|
112
|
+
// • During development (ts-node / tsx): __dirname ≈ src/generators/components/connector-generator/
|
|
113
|
+
// • After `tsc` build: __dirname ≈ dist/generators/components/connector-generator/
|
|
114
|
+
//
|
|
115
|
+
// In both cases we need to land in src/generators/shared/runtime/, so we step
|
|
116
|
+
// up 4 levels and then re-enter src/ explicitly. This works because the repo
|
|
117
|
+
// always keeps src/ alongside dist/ in the published package (see "files" in package.json).
|
|
118
|
+
spinner.start('Copying runtime files');
|
|
119
|
+
const runtimeDir = path.resolve(outputDir, runtimeRelDir);
|
|
120
|
+
await fs.ensureDir(runtimeDir); // ensureDir (not emptyDir) — other runtime files may exist there
|
|
121
|
+
|
|
122
|
+
const __dirname = path.dirname(fileURLToPath(import.meta.url));
|
|
123
|
+
const runtimeSrcDir = path.resolve(__dirname, '../../../../src/generators/shared/runtime');
|
|
124
|
+
|
|
125
|
+
for (const file of RUNTIME_FILES) {
|
|
126
|
+
const src = path.join(runtimeSrcDir, file);
|
|
127
|
+
const dest = path.join(runtimeDir, file);
|
|
128
|
+
await fs.copyFile(src, dest);
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
spinner.stop('Runtime files copied');
|
|
132
|
+
|
|
133
|
+
// ── 6. Summary ────────────────────────────────────────────────────────────
|
|
134
|
+
if (errorCount > 0) {
|
|
135
|
+
logger.log.warn(`Completed with ${errorCount} error(s)`);
|
|
136
|
+
}
|
|
137
|
+
logger.log.success(`Generated ${successCount} connector(s) in ${outputDir}`);
|
|
138
|
+
}
|