@useavalon/avalon 0.1.11 → 0.1.13

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 (141) hide show
  1. package/README.md +54 -54
  2. package/mod.ts +302 -302
  3. package/package.json +49 -26
  4. package/src/build/integration-bundler-plugin.ts +116 -116
  5. package/src/build/integration-config.ts +168 -168
  6. package/src/build/integration-detection-plugin.ts +117 -117
  7. package/src/build/integration-resolver-plugin.ts +90 -90
  8. package/src/build/island-manifest.ts +269 -269
  9. package/src/build/island-types-generator.ts +476 -476
  10. package/src/build/mdx-island-transform.ts +464 -464
  11. package/src/build/mdx-plugin.ts +98 -98
  12. package/src/build/page-island-transform.ts +598 -598
  13. package/src/build/prop-extractors/index.ts +21 -21
  14. package/src/build/prop-extractors/lit.ts +140 -140
  15. package/src/build/prop-extractors/qwik.ts +16 -16
  16. package/src/build/prop-extractors/solid.ts +125 -125
  17. package/src/build/prop-extractors/svelte.ts +194 -194
  18. package/src/build/prop-extractors/vue.ts +111 -111
  19. package/src/build/sidecar-file-manager.ts +104 -104
  20. package/src/build/sidecar-renderer.ts +30 -30
  21. package/src/client/adapters/index.ts +21 -13
  22. package/src/client/components.ts +35 -35
  23. package/src/client/css-hmr-handler.ts +344 -344
  24. package/src/client/framework-adapter.ts +462 -462
  25. package/src/client/hmr-coordinator.ts +396 -396
  26. package/src/client/hmr-error-overlay.js +533 -533
  27. package/src/client/main.js +824 -816
  28. package/src/client/types/framework-runtime.d.ts +68 -68
  29. package/src/client/types/vite-hmr.d.ts +46 -46
  30. package/src/client/types/vite-virtual-modules.d.ts +70 -60
  31. package/src/components/Image.tsx +123 -123
  32. package/src/components/IslandErrorBoundary.tsx +145 -145
  33. package/src/components/LayoutDataErrorBoundary.tsx +141 -141
  34. package/src/components/LayoutErrorBoundary.tsx +127 -127
  35. package/src/components/PersistentIsland.tsx +52 -52
  36. package/src/components/StreamingErrorBoundary.tsx +233 -233
  37. package/src/components/StreamingLayout.tsx +538 -538
  38. package/src/core/components/component-analyzer.ts +192 -192
  39. package/src/core/components/component-detection.ts +508 -508
  40. package/src/core/components/enhanced-framework-detector.ts +500 -500
  41. package/src/core/components/framework-registry.ts +563 -563
  42. package/src/core/content/mdx-processor.ts +46 -46
  43. package/src/core/integrations/index.ts +19 -19
  44. package/src/core/integrations/loader.ts +125 -125
  45. package/src/core/integrations/registry.ts +175 -175
  46. package/src/core/islands/island-persistence.ts +325 -325
  47. package/src/core/islands/island-state-serializer.ts +258 -258
  48. package/src/core/islands/persistent-island-context.tsx +80 -80
  49. package/src/core/islands/use-persistent-state.ts +68 -68
  50. package/src/core/layout/enhanced-layout-resolver.ts +322 -322
  51. package/src/core/layout/layout-cache-manager.ts +485 -485
  52. package/src/core/layout/layout-composer.ts +357 -357
  53. package/src/core/layout/layout-data-loader.ts +516 -516
  54. package/src/core/layout/layout-discovery.ts +243 -243
  55. package/src/core/layout/layout-matcher.ts +299 -299
  56. package/src/core/layout/layout-types.ts +110 -110
  57. package/src/core/modules/framework-module-resolver.ts +273 -273
  58. package/src/islands/component-analysis.ts +213 -213
  59. package/src/islands/css-utils.ts +565 -565
  60. package/src/islands/discovery/index.ts +80 -80
  61. package/src/islands/discovery/registry.ts +340 -340
  62. package/src/islands/discovery/resolver.ts +477 -477
  63. package/src/islands/discovery/scanner.ts +386 -386
  64. package/src/islands/discovery/types.ts +117 -117
  65. package/src/islands/discovery/validator.ts +544 -544
  66. package/src/islands/discovery/watcher.ts +368 -368
  67. package/src/islands/framework-detection.ts +428 -428
  68. package/src/islands/integration-loader.ts +490 -490
  69. package/src/islands/island.tsx +565 -565
  70. package/src/islands/render-cache.ts +550 -550
  71. package/src/islands/types.ts +80 -80
  72. package/src/islands/universal-css-collector.ts +157 -157
  73. package/src/islands/universal-head-collector.ts +137 -137
  74. package/src/layout-system.d.ts +592 -592
  75. package/src/layout-system.ts +218 -218
  76. package/src/middleware/discovery.ts +268 -268
  77. package/src/middleware/executor.ts +315 -315
  78. package/src/middleware/index.ts +76 -76
  79. package/src/middleware/types.ts +99 -99
  80. package/src/nitro/build-config.ts +575 -575
  81. package/src/nitro/config.ts +483 -483
  82. package/src/nitro/error-handler.ts +636 -636
  83. package/src/nitro/index.ts +173 -173
  84. package/src/nitro/island-manifest.ts +584 -584
  85. package/src/nitro/middleware-adapter.ts +260 -260
  86. package/src/nitro/renderer.ts +1471 -1471
  87. package/src/nitro/route-discovery.ts +439 -439
  88. package/src/nitro/types.ts +321 -321
  89. package/src/render/collect-css.ts +198 -198
  90. package/src/render/error-pages.ts +79 -79
  91. package/src/render/isolated-ssr-renderer.ts +654 -654
  92. package/src/render/ssr.ts +1030 -1030
  93. package/src/schemas/api.ts +30 -30
  94. package/src/schemas/core.ts +64 -64
  95. package/src/schemas/index.ts +212 -212
  96. package/src/schemas/layout.ts +279 -279
  97. package/src/schemas/routing/index.ts +38 -38
  98. package/src/schemas/routing.ts +376 -376
  99. package/src/types/as-island.ts +20 -20
  100. package/src/types/image.d.ts +106 -106
  101. package/src/types/index.d.ts +22 -22
  102. package/src/types/island-jsx.d.ts +33 -33
  103. package/src/types/island-prop.d.ts +20 -20
  104. package/src/types/layout.ts +285 -285
  105. package/src/types/mdx.d.ts +6 -6
  106. package/src/types/routing.ts +555 -555
  107. package/src/types/types.ts +5 -5
  108. package/src/types/urlpattern.d.ts +49 -49
  109. package/src/types/vite-env.d.ts +11 -11
  110. package/src/utils/dev-logger.ts +299 -299
  111. package/src/utils/fs.ts +151 -151
  112. package/src/vite-plugin/auto-discover.ts +551 -551
  113. package/src/vite-plugin/config.ts +266 -266
  114. package/src/vite-plugin/errors.ts +127 -127
  115. package/src/vite-plugin/image-optimization.ts +156 -156
  116. package/src/vite-plugin/integration-activator.ts +126 -126
  117. package/src/vite-plugin/island-sidecar-plugin.ts +176 -176
  118. package/src/vite-plugin/module-discovery.ts +189 -189
  119. package/src/vite-plugin/nitro-integration.ts +1354 -1354
  120. package/src/vite-plugin/plugin.ts +403 -409
  121. package/src/vite-plugin/types.ts +327 -327
  122. package/src/vite-plugin/validation.ts +228 -228
  123. package/src/client/adapters/index.js +0 -12
  124. package/src/client/adapters/lit-adapter.js +0 -467
  125. package/src/client/adapters/lit-adapter.ts +0 -654
  126. package/src/client/adapters/preact-adapter.js +0 -223
  127. package/src/client/adapters/preact-adapter.ts +0 -331
  128. package/src/client/adapters/qwik-adapter.js +0 -259
  129. package/src/client/adapters/qwik-adapter.ts +0 -345
  130. package/src/client/adapters/react-adapter.js +0 -220
  131. package/src/client/adapters/react-adapter.ts +0 -353
  132. package/src/client/adapters/solid-adapter.js +0 -295
  133. package/src/client/adapters/solid-adapter.ts +0 -451
  134. package/src/client/adapters/svelte-adapter.js +0 -368
  135. package/src/client/adapters/svelte-adapter.ts +0 -524
  136. package/src/client/adapters/vue-adapter.js +0 -278
  137. package/src/client/adapters/vue-adapter.ts +0 -467
  138. package/src/client/components.js +0 -23
  139. package/src/client/css-hmr-handler.js +0 -263
  140. package/src/client/framework-adapter.js +0 -283
  141. package/src/client/hmr-coordinator.js +0 -274
@@ -1,476 +1,476 @@
1
- /**
2
- * Island Types Generator
3
- *
4
- * Generates TypeScript declaration files (.d.ts) for discovered islands.
5
- * Provides type information including namespace and qualified names for
6
- * better IDE support and type safety when referencing islands.
7
- */
8
-
9
- import { resolve, dirname, relative } from "node:path";
10
- import { writeFile, mkdir } from "node:fs/promises";
11
- import type {
12
- DiscoveredIsland,
13
- IslandDirectory,
14
- IslandCollision,
15
- } from "../islands/discovery/types.ts";
16
- import {
17
- createIslandRegistry,
18
- getQualifiedIslandName,
19
- } from "../islands/discovery/index.ts";
20
-
21
- /**
22
- * Options for type generation
23
- */
24
- export interface IslandTypeGeneratorOptions {
25
- /** Output directory for generated types (default: "src/types") */
26
- outputDir?: string;
27
- /** Whether to generate a single file or per-directory files (default: "single") */
28
- mode?: "single" | "per-directory";
29
- /** Module name for the generated types (default: "avalon-islands") */
30
- moduleName?: string;
31
- /** Whether to include JSDoc comments (default: true) */
32
- includeJsDoc?: boolean;
33
- }
34
-
35
- /**
36
- * Default options for type generation
37
- */
38
- const DEFAULT_OPTIONS: Required<IslandTypeGeneratorOptions> = {
39
- outputDir: "src/types",
40
- mode: "single",
41
- moduleName: "avalon-islands",
42
- includeJsDoc: true,
43
- };
44
-
45
- /**
46
- * Result of type generation
47
- */
48
- export interface TypeGenerationResult {
49
- /** Whether generation was successful */
50
- success: boolean;
51
- /** Generated file paths */
52
- files: string[];
53
- /** Number of islands typed */
54
- islandCount: number;
55
- /** Any errors that occurred */
56
- errors: string[];
57
- }
58
-
59
- /**
60
- * Generate TypeScript declaration files for all discovered islands.
61
- *
62
- * @param projectRoot - The root directory of the project
63
- * @param options - Options for type generation
64
- * @returns Result of the type generation
65
- */
66
- export async function generateIslandTypes(
67
- projectRoot: string,
68
- options: IslandTypeGeneratorOptions = {}
69
- ): Promise<TypeGenerationResult> {
70
- const opts = { ...DEFAULT_OPTIONS, ...options };
71
- const result: TypeGenerationResult = {
72
- success: true,
73
- files: [],
74
- islandCount: 0,
75
- errors: [],
76
- };
77
-
78
- try {
79
- // Discover all islands
80
- const registry = await createIslandRegistry(projectRoot);
81
- const islands = registry.getAllIslands();
82
- const directories = registry.directories;
83
- const collisions = registry.collisions;
84
-
85
- result.islandCount = islands.length;
86
-
87
- if (islands.length === 0) {
88
- return result;
89
- }
90
-
91
- if (opts.mode === "single") {
92
- // Generate a single declaration file
93
- const content = generateSingleTypeFile(
94
- islands,
95
- directories,
96
- collisions,
97
- opts
98
- );
99
- const outputPath = resolve(projectRoot, opts.outputDir, "islands.d.ts");
100
-
101
- await ensureDir(dirname(outputPath));
102
- await writeFile(outputPath, content);
103
- result.files.push(outputPath);
104
- } else {
105
- // Generate per-directory declaration files
106
- const filesByDir = await generatePerDirectoryTypeFiles(
107
- islands,
108
- directories,
109
- projectRoot,
110
- opts
111
- );
112
- result.files.push(...filesByDir);
113
- }
114
- } catch (error) {
115
- result.success = false;
116
- result.errors.push(error instanceof Error ? error.message : String(error));
117
- }
118
-
119
- return result;
120
- }
121
-
122
- /**
123
- * Generate a single TypeScript declaration file for all islands.
124
- */
125
- function generateSingleTypeFile(
126
- islands: DiscoveredIsland[],
127
- directories: IslandDirectory[],
128
- collisions: IslandCollision[],
129
- options: Required<IslandTypeGeneratorOptions>
130
- ): string {
131
- const lines: string[] = [];
132
-
133
- // Header
134
- lines.push("/**");
135
- lines.push(" * Auto-generated TypeScript declarations for Avalon islands.");
136
- lines.push(" * Do not edit this file manually - it will be overwritten.");
137
- lines.push(` * Generated at: ${new Date().toISOString()}`);
138
- lines.push(" */");
139
- lines.push("");
140
-
141
- // Module declaration
142
- lines.push(`declare module "${options.moduleName}" {`);
143
- lines.push("");
144
-
145
- // Island directory info
146
- if (options.includeJsDoc) {
147
- lines.push(" /**");
148
- lines.push(" * Discovered island directories");
149
- lines.push(" */");
150
- }
151
- lines.push(" export const islandDirectories: readonly string[];");
152
- lines.push("");
153
-
154
- // Generate types for each island
155
- const islandsByNamespace = groupIslandsByNamespace(islands);
156
-
157
- for (const [namespace, nsIslands] of islandsByNamespace) {
158
- if (namespace === "") {
159
- // Default namespace - export directly
160
- lines.push(" // Default islands (src/islands/)");
161
- for (const island of nsIslands) {
162
- lines.push(...generateIslandTypeDeclaration(island, options, " "));
163
- }
164
- } else {
165
- // Nested namespace - create namespace block
166
- const namespaceParts = namespace.split("/");
167
- const nsName = namespaceParts.map(p => toPascalCase(p)).join("");
168
-
169
- lines.push(` // Islands from ${namespace}/islands/`);
170
- lines.push(` export namespace ${nsName} {`);
171
- for (const island of nsIslands) {
172
- lines.push(...generateIslandTypeDeclaration(island, options, " "));
173
- }
174
- lines.push(" }");
175
- }
176
- lines.push("");
177
- }
178
-
179
- // Island map type
180
- lines.push(" /**");
181
- lines.push(" * Map of all island qualified names to their component types");
182
- lines.push(" */");
183
- lines.push(" export interface IslandMap {");
184
- for (const island of islands) {
185
- const qualifiedName = getQualifiedIslandName(island);
186
- lines.push(` "${qualifiedName}": typeof ${getIslandTypeName(island)};`);
187
- }
188
- lines.push(" }");
189
- lines.push("");
190
-
191
- // Collision warnings
192
- if (collisions.length > 0) {
193
- lines.push(" /**");
194
- lines.push(" * Warning: The following island names have collisions.");
195
- lines.push(" * Use qualified names (namespace/name) to disambiguate.");
196
- lines.push(" */");
197
- lines.push(" export type CollidingIslandNames =");
198
- const collisionNames = collisions.map(c => ` | "${c.name}"`);
199
- lines.push(collisionNames.join("\n") + ";");
200
- lines.push("");
201
- }
202
-
203
- // Helper type for island resolution
204
- lines.push(" /**");
205
- lines.push(" * Get the component type for an island by name or qualified name");
206
- lines.push(" */");
207
- lines.push(" export type GetIsland<K extends keyof IslandMap> = IslandMap[K];");
208
- lines.push("");
209
-
210
- lines.push("}");
211
- lines.push("");
212
-
213
- // Global augmentation for Island component props
214
- lines.push("// Augment the Island component props with discovered islands");
215
- lines.push("declare global {");
216
- lines.push(" namespace Avalon {");
217
- lines.push(" interface DiscoveredIslands {");
218
- for (const island of islands) {
219
- const qualifiedName = getQualifiedIslandName(island);
220
- lines.push(` "${qualifiedName}": true;`);
221
- }
222
- lines.push(" }");
223
- lines.push(" }");
224
- lines.push("}");
225
- lines.push("");
226
-
227
- return lines.join("\n");
228
- }
229
-
230
- /**
231
- * Generate per-directory TypeScript declaration files.
232
- */
233
- async function generatePerDirectoryTypeFiles(
234
- islands: DiscoveredIsland[],
235
- directories: IslandDirectory[],
236
- projectRoot: string,
237
- options: Required<IslandTypeGeneratorOptions>
238
- ): Promise<string[]> {
239
- const files: string[] = [];
240
- const islandsByDir = new Map<string, DiscoveredIsland[]>();
241
-
242
- // Group islands by directory
243
- for (const island of islands) {
244
- const dirPath = island.directory.path;
245
- const existing = islandsByDir.get(dirPath) || [];
246
- existing.push(island);
247
- islandsByDir.set(dirPath, existing);
248
- }
249
-
250
- // Generate a file for each directory
251
- for (const directory of directories) {
252
- const dirIslands = islandsByDir.get(directory.path) || [];
253
- if (dirIslands.length === 0) continue;
254
-
255
- const content = generateDirectoryTypeFile(directory, dirIslands, options);
256
- const outputPath = resolve(
257
- projectRoot,
258
- directory.path,
259
- "islands.d.ts"
260
- );
261
-
262
- await ensureDir(dirname(outputPath));
263
- await writeFile(outputPath, content);
264
- files.push(outputPath);
265
- }
266
-
267
- // Generate index file that re-exports all
268
- const indexContent = generateIndexTypeFile(directories, projectRoot, options);
269
- const indexPath = resolve(projectRoot, options.outputDir, "islands.d.ts");
270
-
271
- await ensureDir(dirname(indexPath));
272
- await writeFile(indexPath, indexContent);
273
- files.push(indexPath);
274
-
275
- return files;
276
- }
277
-
278
- /**
279
- * Generate a TypeScript declaration file for a single directory.
280
- */
281
- function generateDirectoryTypeFile(
282
- directory: IslandDirectory,
283
- islands: DiscoveredIsland[],
284
- options: Required<IslandTypeGeneratorOptions>
285
- ): string {
286
- const lines: string[] = [];
287
-
288
- lines.push("/**");
289
- lines.push(` * Auto-generated TypeScript declarations for islands in ${directory.relativePath}`);
290
- lines.push(" * Do not edit this file manually - it will be overwritten.");
291
- lines.push(" */");
292
- lines.push("");
293
-
294
- for (const island of islands) {
295
- lines.push(...generateIslandTypeDeclaration(island, options, ""));
296
- }
297
-
298
- return lines.join("\n");
299
- }
300
-
301
- /**
302
- * Generate an index file that re-exports all island types.
303
- */
304
- function generateIndexTypeFile(
305
- directories: IslandDirectory[],
306
- projectRoot: string,
307
- options: Required<IslandTypeGeneratorOptions>
308
- ): string {
309
- const lines: string[] = [];
310
-
311
- lines.push("/**");
312
- lines.push(" * Auto-generated index for all island type declarations.");
313
- lines.push(" * Do not edit this file manually - it will be overwritten.");
314
- lines.push(" */");
315
- lines.push("");
316
-
317
- for (const directory of directories) {
318
- const relativePath = relative(
319
- resolve(projectRoot, options.outputDir),
320
- resolve(projectRoot, directory.path, "islands.d.ts")
321
- ).replace(/\\/g, "/").replace(/\.d\.ts$/, "");
322
-
323
- lines.push(`export * from "${relativePath}";`);
324
- }
325
-
326
- return lines.join("\n");
327
- }
328
-
329
- /**
330
- * Generate type declaration for a single island.
331
- */
332
- function generateIslandTypeDeclaration(
333
- island: DiscoveredIsland,
334
- options: Required<IslandTypeGeneratorOptions>,
335
- indent: string
336
- ): string[] {
337
- const lines: string[] = [];
338
- const typeName = getIslandTypeName(island);
339
-
340
- if (options.includeJsDoc) {
341
- lines.push(`${indent}/**`);
342
- lines.push(`${indent} * Island component: ${island.name}`);
343
- lines.push(`${indent} * Framework: ${island.framework}`);
344
- lines.push(`${indent} * Source: ${island.relativePath}`);
345
- if (island.namespace) {
346
- lines.push(`${indent} * Namespace: ${island.namespace}`);
347
- }
348
- lines.push(`${indent} */`);
349
- }
350
-
351
- // Generate appropriate type based on framework
352
- const componentType = getFrameworkComponentType(island.framework);
353
- lines.push(`${indent}export const ${typeName}: ${componentType};`);
354
-
355
- return lines;
356
- }
357
-
358
- /**
359
- * Get the TypeScript type name for an island.
360
- */
361
- function getIslandTypeName(island: DiscoveredIsland): string {
362
- // Use the component name directly (already PascalCase)
363
- return island.name;
364
- }
365
-
366
- /**
367
- * Get the appropriate component type for a framework.
368
- */
369
- function getFrameworkComponentType(framework: string): string {
370
- switch (framework) {
371
- case "preact":
372
- return "import('preact').FunctionComponent<any>";
373
- case "react":
374
- return "import('react').FC<any>";
375
- case "vue":
376
- return "import('vue').DefineComponent<any, any, any>";
377
- case "svelte":
378
- return "import('svelte').SvelteComponent";
379
- case "solid":
380
- return "import('solid-js').Component<any>";
381
- case "lit":
382
- return "typeof import('lit').LitElement";
383
- default:
384
- return "unknown";
385
- }
386
- }
387
-
388
- /**
389
- * Group islands by their namespace.
390
- */
391
- function groupIslandsByNamespace(
392
- islands: DiscoveredIsland[]
393
- ): Map<string, DiscoveredIsland[]> {
394
- const grouped = new Map<string, DiscoveredIsland[]>();
395
-
396
- for (const island of islands) {
397
- const existing = grouped.get(island.namespace) || [];
398
- existing.push(island);
399
- grouped.set(island.namespace, existing);
400
- }
401
-
402
- // Sort by namespace (empty string first, then alphabetically)
403
- const sorted = new Map<string, DiscoveredIsland[]>();
404
- const keys = Array.from(grouped.keys()).sort((a, b) => {
405
- if (a === "") return -1;
406
- if (b === "") return 1;
407
- return a.localeCompare(b);
408
- });
409
-
410
- for (const key of keys) {
411
- sorted.set(key, grouped.get(key)!);
412
- }
413
-
414
- return sorted;
415
- }
416
-
417
- /**
418
- * Convert a string to PascalCase.
419
- */
420
- function toPascalCase(str: string): string {
421
- return str
422
- .split(/[-_\s]+/)
423
- .map(word => word.charAt(0).toUpperCase() + word.slice(1).toLowerCase())
424
- .join("");
425
- }
426
-
427
- /**
428
- * Ensure a directory exists.
429
- */
430
- async function ensureDir(path: string): Promise<void> {
431
- try {
432
- await mkdir(path, { recursive: true });
433
- } catch (error) {
434
- if (!(error instanceof Error) || (error as NodeJS.ErrnoException).code !== 'EEXIST') {
435
- throw error;
436
- }
437
- }
438
- }
439
-
440
- /**
441
- * Watch for island changes and regenerate types.
442
- *
443
- * @param projectRoot - The root directory of the project
444
- * @param options - Options for type generation
445
- * @returns Cleanup function to stop watching
446
- */
447
- export async function watchAndGenerateTypes(
448
- projectRoot: string,
449
- options: IslandTypeGeneratorOptions = {}
450
- ): Promise<() => void> {
451
- const { createIslandWatcher, createIslandRegistry } = await import(
452
- "../islands/discovery/index.ts"
453
- );
454
-
455
- const registry = await createIslandRegistry(projectRoot);
456
- const watcher = createIslandWatcher(projectRoot, registry);
457
-
458
- // Generate initial types
459
- await generateIslandTypes(projectRoot, options);
460
-
461
- // Watch for changes
462
- const cleanup = await watcher.watch(async (event) => {
463
- // Rebuild registry and regenerate types
464
- await registry.rebuild();
465
- const result = await generateIslandTypes(projectRoot, options);
466
-
467
- if (!result.success) {
468
- console.error(`❌ Failed to regenerate types:`, result.errors);
469
- }
470
- });
471
-
472
- return () => {
473
- cleanup();
474
- watcher.stop();
475
- };
476
- }
1
+ /**
2
+ * Island Types Generator
3
+ *
4
+ * Generates TypeScript declaration files (.d.ts) for discovered islands.
5
+ * Provides type information including namespace and qualified names for
6
+ * better IDE support and type safety when referencing islands.
7
+ */
8
+
9
+ import { resolve, dirname, relative } from "node:path";
10
+ import { writeFile, mkdir } from "node:fs/promises";
11
+ import type {
12
+ DiscoveredIsland,
13
+ IslandDirectory,
14
+ IslandCollision,
15
+ } from "../islands/discovery/types.ts";
16
+ import {
17
+ createIslandRegistry,
18
+ getQualifiedIslandName,
19
+ } from "../islands/discovery/index.ts";
20
+
21
+ /**
22
+ * Options for type generation
23
+ */
24
+ export interface IslandTypeGeneratorOptions {
25
+ /** Output directory for generated types (default: "src/types") */
26
+ outputDir?: string;
27
+ /** Whether to generate a single file or per-directory files (default: "single") */
28
+ mode?: "single" | "per-directory";
29
+ /** Module name for the generated types (default: "avalon-islands") */
30
+ moduleName?: string;
31
+ /** Whether to include JSDoc comments (default: true) */
32
+ includeJsDoc?: boolean;
33
+ }
34
+
35
+ /**
36
+ * Default options for type generation
37
+ */
38
+ const DEFAULT_OPTIONS: Required<IslandTypeGeneratorOptions> = {
39
+ outputDir: "src/types",
40
+ mode: "single",
41
+ moduleName: "avalon-islands",
42
+ includeJsDoc: true,
43
+ };
44
+
45
+ /**
46
+ * Result of type generation
47
+ */
48
+ export interface TypeGenerationResult {
49
+ /** Whether generation was successful */
50
+ success: boolean;
51
+ /** Generated file paths */
52
+ files: string[];
53
+ /** Number of islands typed */
54
+ islandCount: number;
55
+ /** Any errors that occurred */
56
+ errors: string[];
57
+ }
58
+
59
+ /**
60
+ * Generate TypeScript declaration files for all discovered islands.
61
+ *
62
+ * @param projectRoot - The root directory of the project
63
+ * @param options - Options for type generation
64
+ * @returns Result of the type generation
65
+ */
66
+ export async function generateIslandTypes(
67
+ projectRoot: string,
68
+ options: IslandTypeGeneratorOptions = {}
69
+ ): Promise<TypeGenerationResult> {
70
+ const opts = { ...DEFAULT_OPTIONS, ...options };
71
+ const result: TypeGenerationResult = {
72
+ success: true,
73
+ files: [],
74
+ islandCount: 0,
75
+ errors: [],
76
+ };
77
+
78
+ try {
79
+ // Discover all islands
80
+ const registry = await createIslandRegistry(projectRoot);
81
+ const islands = registry.getAllIslands();
82
+ const directories = registry.directories;
83
+ const collisions = registry.collisions;
84
+
85
+ result.islandCount = islands.length;
86
+
87
+ if (islands.length === 0) {
88
+ return result;
89
+ }
90
+
91
+ if (opts.mode === "single") {
92
+ // Generate a single declaration file
93
+ const content = generateSingleTypeFile(
94
+ islands,
95
+ directories,
96
+ collisions,
97
+ opts
98
+ );
99
+ const outputPath = resolve(projectRoot, opts.outputDir, "islands.d.ts");
100
+
101
+ await ensureDir(dirname(outputPath));
102
+ await writeFile(outputPath, content);
103
+ result.files.push(outputPath);
104
+ } else {
105
+ // Generate per-directory declaration files
106
+ const filesByDir = await generatePerDirectoryTypeFiles(
107
+ islands,
108
+ directories,
109
+ projectRoot,
110
+ opts
111
+ );
112
+ result.files.push(...filesByDir);
113
+ }
114
+ } catch (error) {
115
+ result.success = false;
116
+ result.errors.push(error instanceof Error ? error.message : String(error));
117
+ }
118
+
119
+ return result;
120
+ }
121
+
122
+ /**
123
+ * Generate a single TypeScript declaration file for all islands.
124
+ */
125
+ function generateSingleTypeFile(
126
+ islands: DiscoveredIsland[],
127
+ directories: IslandDirectory[],
128
+ collisions: IslandCollision[],
129
+ options: Required<IslandTypeGeneratorOptions>
130
+ ): string {
131
+ const lines: string[] = [];
132
+
133
+ // Header
134
+ lines.push("/**");
135
+ lines.push(" * Auto-generated TypeScript declarations for Avalon islands.");
136
+ lines.push(" * Do not edit this file manually - it will be overwritten.");
137
+ lines.push(` * Generated at: ${new Date().toISOString()}`);
138
+ lines.push(" */");
139
+ lines.push("");
140
+
141
+ // Module declaration
142
+ lines.push(`declare module "${options.moduleName}" {`);
143
+ lines.push("");
144
+
145
+ // Island directory info
146
+ if (options.includeJsDoc) {
147
+ lines.push(" /**");
148
+ lines.push(" * Discovered island directories");
149
+ lines.push(" */");
150
+ }
151
+ lines.push(" export const islandDirectories: readonly string[];");
152
+ lines.push("");
153
+
154
+ // Generate types for each island
155
+ const islandsByNamespace = groupIslandsByNamespace(islands);
156
+
157
+ for (const [namespace, nsIslands] of islandsByNamespace) {
158
+ if (namespace === "") {
159
+ // Default namespace - export directly
160
+ lines.push(" // Default islands (src/islands/)");
161
+ for (const island of nsIslands) {
162
+ lines.push(...generateIslandTypeDeclaration(island, options, " "));
163
+ }
164
+ } else {
165
+ // Nested namespace - create namespace block
166
+ const namespaceParts = namespace.split("/");
167
+ const nsName = namespaceParts.map(p => toPascalCase(p)).join("");
168
+
169
+ lines.push(` // Islands from ${namespace}/islands/`);
170
+ lines.push(` export namespace ${nsName} {`);
171
+ for (const island of nsIslands) {
172
+ lines.push(...generateIslandTypeDeclaration(island, options, " "));
173
+ }
174
+ lines.push(" }");
175
+ }
176
+ lines.push("");
177
+ }
178
+
179
+ // Island map type
180
+ lines.push(" /**");
181
+ lines.push(" * Map of all island qualified names to their component types");
182
+ lines.push(" */");
183
+ lines.push(" export interface IslandMap {");
184
+ for (const island of islands) {
185
+ const qualifiedName = getQualifiedIslandName(island);
186
+ lines.push(` "${qualifiedName}": typeof ${getIslandTypeName(island)};`);
187
+ }
188
+ lines.push(" }");
189
+ lines.push("");
190
+
191
+ // Collision warnings
192
+ if (collisions.length > 0) {
193
+ lines.push(" /**");
194
+ lines.push(" * Warning: The following island names have collisions.");
195
+ lines.push(" * Use qualified names (namespace/name) to disambiguate.");
196
+ lines.push(" */");
197
+ lines.push(" export type CollidingIslandNames =");
198
+ const collisionNames = collisions.map(c => ` | "${c.name}"`);
199
+ lines.push(collisionNames.join("\n") + ";");
200
+ lines.push("");
201
+ }
202
+
203
+ // Helper type for island resolution
204
+ lines.push(" /**");
205
+ lines.push(" * Get the component type for an island by name or qualified name");
206
+ lines.push(" */");
207
+ lines.push(" export type GetIsland<K extends keyof IslandMap> = IslandMap[K];");
208
+ lines.push("");
209
+
210
+ lines.push("}");
211
+ lines.push("");
212
+
213
+ // Global augmentation for Island component props
214
+ lines.push("// Augment the Island component props with discovered islands");
215
+ lines.push("declare global {");
216
+ lines.push(" namespace Avalon {");
217
+ lines.push(" interface DiscoveredIslands {");
218
+ for (const island of islands) {
219
+ const qualifiedName = getQualifiedIslandName(island);
220
+ lines.push(` "${qualifiedName}": true;`);
221
+ }
222
+ lines.push(" }");
223
+ lines.push(" }");
224
+ lines.push("}");
225
+ lines.push("");
226
+
227
+ return lines.join("\n");
228
+ }
229
+
230
+ /**
231
+ * Generate per-directory TypeScript declaration files.
232
+ */
233
+ async function generatePerDirectoryTypeFiles(
234
+ islands: DiscoveredIsland[],
235
+ directories: IslandDirectory[],
236
+ projectRoot: string,
237
+ options: Required<IslandTypeGeneratorOptions>
238
+ ): Promise<string[]> {
239
+ const files: string[] = [];
240
+ const islandsByDir = new Map<string, DiscoveredIsland[]>();
241
+
242
+ // Group islands by directory
243
+ for (const island of islands) {
244
+ const dirPath = island.directory.path;
245
+ const existing = islandsByDir.get(dirPath) || [];
246
+ existing.push(island);
247
+ islandsByDir.set(dirPath, existing);
248
+ }
249
+
250
+ // Generate a file for each directory
251
+ for (const directory of directories) {
252
+ const dirIslands = islandsByDir.get(directory.path) || [];
253
+ if (dirIslands.length === 0) continue;
254
+
255
+ const content = generateDirectoryTypeFile(directory, dirIslands, options);
256
+ const outputPath = resolve(
257
+ projectRoot,
258
+ directory.path,
259
+ "islands.d.ts"
260
+ );
261
+
262
+ await ensureDir(dirname(outputPath));
263
+ await writeFile(outputPath, content);
264
+ files.push(outputPath);
265
+ }
266
+
267
+ // Generate index file that re-exports all
268
+ const indexContent = generateIndexTypeFile(directories, projectRoot, options);
269
+ const indexPath = resolve(projectRoot, options.outputDir, "islands.d.ts");
270
+
271
+ await ensureDir(dirname(indexPath));
272
+ await writeFile(indexPath, indexContent);
273
+ files.push(indexPath);
274
+
275
+ return files;
276
+ }
277
+
278
+ /**
279
+ * Generate a TypeScript declaration file for a single directory.
280
+ */
281
+ function generateDirectoryTypeFile(
282
+ directory: IslandDirectory,
283
+ islands: DiscoveredIsland[],
284
+ options: Required<IslandTypeGeneratorOptions>
285
+ ): string {
286
+ const lines: string[] = [];
287
+
288
+ lines.push("/**");
289
+ lines.push(` * Auto-generated TypeScript declarations for islands in ${directory.relativePath}`);
290
+ lines.push(" * Do not edit this file manually - it will be overwritten.");
291
+ lines.push(" */");
292
+ lines.push("");
293
+
294
+ for (const island of islands) {
295
+ lines.push(...generateIslandTypeDeclaration(island, options, ""));
296
+ }
297
+
298
+ return lines.join("\n");
299
+ }
300
+
301
+ /**
302
+ * Generate an index file that re-exports all island types.
303
+ */
304
+ function generateIndexTypeFile(
305
+ directories: IslandDirectory[],
306
+ projectRoot: string,
307
+ options: Required<IslandTypeGeneratorOptions>
308
+ ): string {
309
+ const lines: string[] = [];
310
+
311
+ lines.push("/**");
312
+ lines.push(" * Auto-generated index for all island type declarations.");
313
+ lines.push(" * Do not edit this file manually - it will be overwritten.");
314
+ lines.push(" */");
315
+ lines.push("");
316
+
317
+ for (const directory of directories) {
318
+ const relativePath = relative(
319
+ resolve(projectRoot, options.outputDir),
320
+ resolve(projectRoot, directory.path, "islands.d.ts")
321
+ ).replace(/\\/g, "/").replace(/\.d\.ts$/, "");
322
+
323
+ lines.push(`export * from "${relativePath}";`);
324
+ }
325
+
326
+ return lines.join("\n");
327
+ }
328
+
329
+ /**
330
+ * Generate type declaration for a single island.
331
+ */
332
+ function generateIslandTypeDeclaration(
333
+ island: DiscoveredIsland,
334
+ options: Required<IslandTypeGeneratorOptions>,
335
+ indent: string
336
+ ): string[] {
337
+ const lines: string[] = [];
338
+ const typeName = getIslandTypeName(island);
339
+
340
+ if (options.includeJsDoc) {
341
+ lines.push(`${indent}/**`);
342
+ lines.push(`${indent} * Island component: ${island.name}`);
343
+ lines.push(`${indent} * Framework: ${island.framework}`);
344
+ lines.push(`${indent} * Source: ${island.relativePath}`);
345
+ if (island.namespace) {
346
+ lines.push(`${indent} * Namespace: ${island.namespace}`);
347
+ }
348
+ lines.push(`${indent} */`);
349
+ }
350
+
351
+ // Generate appropriate type based on framework
352
+ const componentType = getFrameworkComponentType(island.framework);
353
+ lines.push(`${indent}export const ${typeName}: ${componentType};`);
354
+
355
+ return lines;
356
+ }
357
+
358
+ /**
359
+ * Get the TypeScript type name for an island.
360
+ */
361
+ function getIslandTypeName(island: DiscoveredIsland): string {
362
+ // Use the component name directly (already PascalCase)
363
+ return island.name;
364
+ }
365
+
366
+ /**
367
+ * Get the appropriate component type for a framework.
368
+ */
369
+ function getFrameworkComponentType(framework: string): string {
370
+ switch (framework) {
371
+ case "preact":
372
+ return "import('preact').FunctionComponent<any>";
373
+ case "react":
374
+ return "import('react').FC<any>";
375
+ case "vue":
376
+ return "import('vue').DefineComponent<any, any, any>";
377
+ case "svelte":
378
+ return "import('svelte').SvelteComponent";
379
+ case "solid":
380
+ return "import('solid-js').Component<any>";
381
+ case "lit":
382
+ return "typeof import('lit').LitElement";
383
+ default:
384
+ return "unknown";
385
+ }
386
+ }
387
+
388
+ /**
389
+ * Group islands by their namespace.
390
+ */
391
+ function groupIslandsByNamespace(
392
+ islands: DiscoveredIsland[]
393
+ ): Map<string, DiscoveredIsland[]> {
394
+ const grouped = new Map<string, DiscoveredIsland[]>();
395
+
396
+ for (const island of islands) {
397
+ const existing = grouped.get(island.namespace) || [];
398
+ existing.push(island);
399
+ grouped.set(island.namespace, existing);
400
+ }
401
+
402
+ // Sort by namespace (empty string first, then alphabetically)
403
+ const sorted = new Map<string, DiscoveredIsland[]>();
404
+ const keys = Array.from(grouped.keys()).sort((a, b) => {
405
+ if (a === "") return -1;
406
+ if (b === "") return 1;
407
+ return a.localeCompare(b);
408
+ });
409
+
410
+ for (const key of keys) {
411
+ sorted.set(key, grouped.get(key)!);
412
+ }
413
+
414
+ return sorted;
415
+ }
416
+
417
+ /**
418
+ * Convert a string to PascalCase.
419
+ */
420
+ function toPascalCase(str: string): string {
421
+ return str
422
+ .split(/[-_\s]+/)
423
+ .map(word => word.charAt(0).toUpperCase() + word.slice(1).toLowerCase())
424
+ .join("");
425
+ }
426
+
427
+ /**
428
+ * Ensure a directory exists.
429
+ */
430
+ async function ensureDir(path: string): Promise<void> {
431
+ try {
432
+ await mkdir(path, { recursive: true });
433
+ } catch (error) {
434
+ if (!(error instanceof Error) || (error as NodeJS.ErrnoException).code !== 'EEXIST') {
435
+ throw error;
436
+ }
437
+ }
438
+ }
439
+
440
+ /**
441
+ * Watch for island changes and regenerate types.
442
+ *
443
+ * @param projectRoot - The root directory of the project
444
+ * @param options - Options for type generation
445
+ * @returns Cleanup function to stop watching
446
+ */
447
+ export async function watchAndGenerateTypes(
448
+ projectRoot: string,
449
+ options: IslandTypeGeneratorOptions = {}
450
+ ): Promise<() => void> {
451
+ const { createIslandWatcher, createIslandRegistry } = await import(
452
+ "../islands/discovery/index.ts"
453
+ );
454
+
455
+ const registry = await createIslandRegistry(projectRoot);
456
+ const watcher = createIslandWatcher(projectRoot, registry);
457
+
458
+ // Generate initial types
459
+ await generateIslandTypes(projectRoot, options);
460
+
461
+ // Watch for changes
462
+ const cleanup = await watcher.watch(async (event) => {
463
+ // Rebuild registry and regenerate types
464
+ await registry.rebuild();
465
+ const result = await generateIslandTypes(projectRoot, options);
466
+
467
+ if (!result.success) {
468
+ console.error(`❌ Failed to regenerate types:`, result.errors);
469
+ }
470
+ });
471
+
472
+ return () => {
473
+ cleanup();
474
+ watcher.stop();
475
+ };
476
+ }