@useavalon/avalon 0.1.0

package/README.md

@@ -0,0 +1,54 @@
+# @useavalon/avalon
+
+Core framework package for [Avalon](https://useavalon.dev) — a multi-framework islands architecture for the modern web.
+
+## Features
+
+- Islands architecture with zero JavaScript by default
+- Multi-framework support (React, Preact, Vue, Svelte, Solid, Lit, Qwik)
+- Selective hydration (`on:client`, `on:visible`, `on:idle`, `on:interaction`)
+- File-system routing with nested layouts
+- API routes and middleware
+- MDX support with rehype/remark plugins
+- SSR with streaming support
+- Edge deployment via Nitro (Node, Deno, Bun, Cloudflare, Vercel, etc.)
+- Vite 8 powered with HMR
+
+## Quick start
+
+```bash
+npm create avalon@latest
+# or
+bun create avalon
+```
+
+Or install manually:
+
+```bash
+bun add @useavalon/avalon
+```
+
+## Usage
+
+```tsx
+// pages/index.tsx
+import Counter from '../components/Counter.tsx';
+
+export default function Home() {
+  return (
+    <div>
+      <h1>Hello Avalon</h1>
+      <Counter island={{ condition: 'on:visible' }} />
+    </div>
+  );
+}
+```
+
+## Links
+
+- [Documentation](https://useavalon.dev/docs/introduction)
+- [GitHub](https://github.com/useAvalon/Avalon)
+
+## License
+
+MIT

package/mod.ts

@@ -0,0 +1,301 @@
+// === Core Avalon + Vite Architecture ===
+
+// Vite Plugin - unified configuration API
+export {
+	avalon,
+	getResolvedConfig,
+	getPagesDir,
+	getLayoutsDir,
+	getNitroConfig,
+	isNitroEnabled,
+} from './src/vite-plugin/plugin.ts';
+export type {
+	AvalonPluginConfig,
+	IntegrationName,
+	ResolvedAvalonConfig,
+	MDXConfig,
+	ResolvedMDXConfig,
+	AvalonNitroConfig,
+	CacheOptions,
+	RouteRule,
+	NitroConfigOutput,
+	AvalonRuntimeConfig,
+} from './src/vite-plugin/types.ts';
+
+// Nitro Integration - virtual modules and coordination
+export {
+	createNitroIntegration,
+	createNitroCoordinationPlugin,
+	createVirtualModulesPlugin,
+	getViteDevServer,
+	getAvalonConfig,
+	isDevelopmentMode,
+	VIRTUAL_MODULE_IDS,
+	RESOLVED_VIRTUAL_IDS,
+} from './src/vite-plugin/nitro-integration.ts';
+export type { NitroIntegrationResult, NitroCoordinationPluginOptions } from './src/vite-plugin/nitro-integration.ts';
+
+// Main exports
+export { renderToHtml } from './src/render/ssr.ts';
+
+// Universal Island component (single function auto-detects framework)
+export { default as Island, renderIsland, type IslandProps } from './src/islands/island.tsx';
+
+// Island utilities
+export {
+	addSvelteSSRCSS,
+	getSvelteSSRCSS,
+	getSvelteSSRCSSForHead,
+	getSvelteSSRCSSStats,
+	getSvelteComponentCSS,
+	clearSvelteComponentCSS,
+	generateComponentScopeId,
+} from './src/islands/css-utils.ts';
+export { detectFramework, detectFrameworkFromSrc, resolveIslandPath } from './src/islands/framework-detection.ts';
+export { analyzeComponentFile, renderComponentSSROnly } from './src/islands/component-analysis.ts';
+export type { Framework, RenderParams, SvelteSSRCSSEntry } from './src/islands/types.ts';
+
+// Island render cache utilities
+export {
+	clearCache,
+	clearIslandCache,
+	invalidateCacheForPath,
+	invalidateCacheForFile,
+	getCacheStats,
+	logCacheStats,
+	configureCache,
+	getCacheConfig,
+} from './src/islands/render-cache.ts';
+export type { CacheConfig as IslandCacheConfig, CacheStats as IslandCacheStats } from './src/islands/render-cache.ts';
+
+// Island Discovery Utilities (optional - for advanced use cases)
+// Note: Islands are detected by usage (island prop), not by directory.
+// These utilities are provided for tooling that needs to scan component files.
+export {
+	// Scanner functions
+	discoverIslandDirectories,
+	discoverIslandsInDirectory,
+	discoverAllIslands,
+	isIslandsDirectory,
+	getDefaultIslandsPath,
+	hasDefaultIslandsDirectory,
+	getQualifiedIslandName,
+	parseQualifiedIslandName,
+	// Registry
+	IslandRegistry,
+	createIslandRegistry,
+	// Resolver
+	IslandResolver,
+	createIslandResolver,
+	// Validator
+	IslandValidator,
+	createIslandValidator,
+	validateAllIslands,
+	formatValidationError,
+	formatValidationWarning,
+	formatCircularDependency,
+	formatValidationResult,
+	// Watcher
+	IslandWatcher,
+	createIslandWatcher,
+	// Type utilities
+	ISLAND_FILE_EXTENSIONS,
+	DEFAULT_DISCOVERY_CONFIG,
+	isSupportedIslandExtension,
+} from './src/islands/discovery/index.ts';
+
+// Island Discovery Types
+export type {
+	IslandDirectory,
+	DiscoveredIsland,
+	IslandCollision,
+	IslandChangeEvent,
+	IslandFileExtension,
+	IslandDiscoveryConfig,
+	ResolutionResult,
+	ImportPathOptions,
+	ValidationResult,
+	ValidationError,
+	ValidationWarning,
+	CircularDependency,
+	IslandChangeCallback,
+	IslandWatcherOptions,
+} from './src/islands/discovery/index.ts';
+
+// Integration system
+export {
+	loadIntegration,
+	detectAndLoadIntegration,
+	preloadIntegrations,
+	detectFrameworksFromPageContent,
+	DEFAULT_PRELOAD_FRAMEWORKS,
+} from './src/islands/integration-loader.ts';
+export type { PreloadIntegrationsOptions } from './src/islands/integration-loader.ts';
+export { registry as integrationRegistry } from './src/core/integrations/registry.ts';
+export type {
+	Integration,
+	RenderParams as IntegrationRenderParams,
+	RenderResult,
+	IntegrationConfig,
+} from '@useavalon/core';
+
+// Build utilities
+export { generateIslandManifest, loadIslandManifest, getIslandBundlePath } from './src/build/island-manifest.ts';
+export type {
+	IslandManifest,
+	IslandEntry,
+	ExtendedIslandManifest,
+	ExtendedIslandEntry,
+} from './src/build/island-manifest.ts';
+
+// MDX island transform (auto-wraps island imports in MDX with Island() calls)
+export { mdxIslandTransform } from './src/build/mdx-island-transform.ts';
+export type { MDXIslandTransformOptions } from './src/build/mdx-island-transform.ts';
+
+// Page island transform (auto-wraps island imports in TSX pages when using `island` prop)
+export { pageIslandTransform } from './src/build/page-island-transform.ts';
+export type { PageIslandTransformOptions } from './src/build/page-island-transform.ts';
+
+// Island directive type for the `island` prop
+export type { IslandDirective } from './src/types/island-prop.d.ts';
+export { asIsland } from './src/types/as-island.ts';
+
+// Island type generation
+export { generateIslandTypes, watchAndGenerateTypes } from './src/build/island-types-generator.ts';
+export type { IslandTypeGeneratorOptions, TypeGenerationResult } from './src/build/island-types-generator.ts';
+
+// Build command (batteries included)
+// Note: This is exported as a function that dynamically imports the build module
+// to avoid top-level await issues when SSR loading modules that import from @useavalon/avalon
+export async function build(_options?: Record<string, unknown>) {
+	const { build: buildFn } = await import('../../scripts/build.ts');
+	return buildFn();
+}
+
+// Middleware system (Nitro-aligned)
+// Note: defineMiddleware removed — use defineHandler from 'nitro/h3' directly.
+// Scoped middleware discovery/execution is Avalon's value-add over Nitro.
+export {
+	discoverScopedMiddleware,
+	executeScopedMiddleware,
+	clearMiddlewareCache,
+	invalidateMiddleware,
+	getMatchingMiddleware,
+	clearDiscoveryCache,
+	hasContextValue,
+	getContextValue,
+	setContextValue,
+	getMiddlewareCacheSize,
+} from './src/middleware/index.ts';
+
+export type {
+	MiddlewareHandler,
+	MiddlewareFileExport,
+	MiddlewareRoute,
+	MiddlewareDiscoveryOptions,
+	MiddlewareExecutorOptions,
+} from './src/middleware/types.ts';
+
+// Layout system - comprehensive export (all layout functionality)
+export * from './src/layout-system.ts';
+
+// Core types
+export type { RenderOptions, MetaTag, ScriptConfig } from './src/schemas/core.ts';
+export type { ApiRoute, ApiMethod } from './src/schemas/api.ts';
+export type { MiddlewareContext } from './src/nitro/middleware-adapter.ts';
+
+// Layout data loading types
+export type { LayoutDataLoadingResult, LayoutDataLoadingOptions } from './src/core/layout/layout-data-loader.ts';
+
+// Enhanced layout resolver types
+export type { EnhancedLayoutResolverOptions } from './src/core/layout/enhanced-layout-resolver.ts';
+
+// Layout cache types (essential only)
+export type { CacheEntry, CacheStats, CacheConfig } from './src/core/layout/layout-cache-manager.ts';
+
+// Layout system types - comprehensive export
+export type {
+	// Core layout types (from hand-written interfaces — proper types, no Zod inference)
+	LayoutProps,
+	LayoutContext,
+	LayoutData,
+	LayoutRoute,
+	LayoutHandler,
+	LayoutDiscoveryOptions,
+	LayoutConfig,
+	RouteInfo,
+	LayoutRule,
+	LayoutLoader,
+	ResolvedLayout,
+	LayoutCache,
+	LayoutErrorInfo
+} from './src/core/layout/layout-types.ts';
+
+export type {
+	// Zod-inferred types for schemas that don't have hand-written equivalents
+	EnhancedLayoutContext,
+
+	// Persistent islands types
+	IslandState,
+	PersistentIslandProps,
+	PersistentIslandContext,
+	IslandStateSaver,
+	IslandStateLoader,
+	IslandStateClearer,
+
+	// Error boundary types
+	LayoutErrorBoundaryProps,
+	ErrorRecoveryStrategy,
+	LayoutErrorHandler,
+	LayoutRetryFunction,
+	LayoutFallbackRenderer,
+
+	// Streaming types
+	StreamingLayoutProps,
+	StreamingComponent,
+	StreamingReadyCheck,
+
+	// Function types
+	LayoutMatcherFunction,
+} from './src/schemas/layout.ts';
+
+// Persistent islands system
+export { IslandPersistence, defaultIslandPersistence } from './src/core/islands/island-persistence.ts';
+export { IslandStateSerializer } from './src/core/islands/island-state-serializer.ts';
+export {
+	createPersistentIslandContext,
+	usePersistentIslandContext,
+	PersistentIslandProvider,
+} from './src/core/islands/persistent-island-context.tsx';
+export { PersistentIsland } from './src/components/PersistentIsland.tsx';
+export { usePersistentState } from './src/core/islands/use-persistent-state.ts';
+
+// Error boundary system
+export { LayoutErrorBoundary } from './src/components/LayoutErrorBoundary.tsx';
+export { LayoutDataErrorBoundary } from './src/components/LayoutDataErrorBoundary.tsx';
+export { IslandErrorBoundary, withIslandErrorBoundary } from './src/components/IslandErrorBoundary.tsx';
+export { StreamingErrorBoundary, withStreamingErrorBoundary } from './src/components/StreamingErrorBoundary.tsx';
+
+// Layout system interfaces
+export type {
+	ILayoutDiscovery,
+	ILayoutMatcher,
+	ILayoutComposer,
+	IIslandPersistence,
+	ILayoutErrorRecovery,
+	ILayoutStreaming,
+	IEnhancedLayoutResolver,
+	ILayoutComponent,
+	IPersistentIslandComponent,
+	ILayoutErrorBoundaryComponent,
+	IStreamingLayoutComponent,
+	LayoutModule,
+	PageModule,
+	LayoutResolutionContext,
+	LayoutPerformanceMetrics,
+	LayoutDebugInfo,
+	LayoutEventType,
+	LayoutEventData,
+	LayoutEventHandler,
+	ILayoutEventEmitter,
+} from './src/types/layout.ts';

package/package.json

@@ -0,0 +1,85 @@
+{
+	"name": "@useavalon/avalon",
+	"version": "0.1.0",
+	"description": "Multi-framework islands architecture for the modern web",
+	"license": "MIT",
+	"type": "module",
+	"repository": "github:useAvalon/Avalon",
+	"homepage": "https://useavalon.dev",
+	"keywords": ["avalon", "islands", "ssr", "vite", "preact", "multi-framework", "hydration"],
+	"exports": {
+		".": "./mod.ts",
+		"./client": "./src/client/components.ts",
+		"./middleware": "./src/middleware/index.ts",
+		"./nitro/renderer": "./src/nitro/renderer.ts",
+		"./nitro/types": "./src/nitro/types.ts",
+		"./nitro/config": "./src/nitro/config.ts",
+		"./types/island-jsx": "./src/types/island-jsx.d.ts",
+		"./types": "./src/types/index.d.ts"
+	},
+	"typesVersions": {
+		"*": {
+			"types": ["./src/types/index.d.ts"]
+		}
+	},
+	"files": ["mod.ts", "src/**/*.ts", "src/**/*.tsx", "src/**/*.js", "src/**/*.d.ts", "README.md"],
+	"devDependencies": {
+		"@types/mime-types": "^3.0.1"
+	},
+	"dependencies": {
+		"@useavalon/core": "0.1.0",
+		"@mdx-js/react": "^3.0.0",
+		"@mdx-js/rollup": "^3.0.0",
+		"@types/mdx": "^2.0.0",
+		"consola": "^3.4.2",
+		"cookie-es": "^2.0.0",
+		"croner": "^10.0.1",
+		"crossws": "^0.4.3",
+		"db0": "^0.3.4",
+		"defu": "^6.1.4",
+		"destr": "^2.0.5",
+		"error-stack-parser-es": "^1.0.5",
+		"get-port-please": "^3.2.0",
+		"h3": "^2.0.1-rc.16",
+		"hast-util-to-text": "^4.0.0",
+		"hookable": "^6.0.1",
+		"jiti": "^2.6.1",
+		"kleur": "^4.1.5",
+		"lowlight": "^3.1.0",
+		"marked": "^17.0.4",
+		"mime-types": "^3.0.2",
+		"nf3": "^0.3.11",
+		"nitro": "3.0.1-alpha.2",
+		"ofetch": "^2.0.0-alpha.3",
+		"ohash": "^2.0.11",
+		"oxc-minify": "^0.117.0",
+		"oxc-transform": "^0.117.0",
+		"preact": "10.28.4",
+		"preact-render-to-string": "6.6.6",
+		"rehype-highlight": "^7.0.0",
+		"remark-frontmatter": "^5.0.0",
+		"remark-gfm": "^4.0.0",
+		"remark-mdx-frontmatter": "^5.0.0",
+		"rendu": "^0.0.7",
+		"rolldown": "^1.0.0-rc.8",
+		"rollup": "^4.55.0",
+		"rou3": "^0.8.1",
+		"scule": "^1.3.0",
+		"srvx": "^0.11.9",
+		"std-env": "^3.9.0",
+		"supports-color": "^10.2.2",
+		"typescript": "5.9.3",
+		"ufo": "^1.6.3",
+		"unctx": "^2.4.1",
+		"undici": "^7.18.2",
+		"unenv": "^2.0.0-rc.24",
+		"unified": "^11.0.0",
+		"unstorage": "^2.0.0-alpha.5",
+		"vite": "8.0.0",
+		"vite-imagetools": "^7.0.5",
+		"xml2js": "^0.6.2",
+		"youch": "^4.1.0-beta.13",
+		"youch-core": "^0.3.3",
+		"zod": "4.3.6"
+	}
+}