@octanejs/vite-plugin 0.1.5 → 0.1.9

package/src/server/virtual-entry.js

@@ -1,184 +1 @@
-// @ts-check
-/**
- * Production server-entry generator.
- *
- * `generateServerEntry` emits the module the SSR sub-build (closeBundle in
- * src/index.js) uses as its Rollup input. The generated module statically
- * imports every RenderRoute entry/layout module (compiled in server mode by
- * the octane plugin the sub-build inherits from the app's vite.config) plus
- * octane.config.ts itself, wires them into `createHandler`, and:
- *
- *   - exports `handler`  — the Web fetch handler `(Request) => Promise<Response>`
- *   - exports `nodeHandler` — a Node `(req, res)` wrapper for serverless
- *     platforms (e.g. a Vercel Node function does
- *     `export { nodeHandler as default } from '../dist/server/entry.js'`)
- *   - auto-boots when run directly (`node dist/server/entry.js`): the
- *     adapter's `serve()` when configured, else the built-in Node server
- *     (static dist/client assets + the handler).
- *
- * It is unused in dev (dev SSR loads modules through `vite.ssrLoadModule`).
- */
-
-/** @import { Route } from '@octanejs/vite-plugin' */
-/** @import { ClientAssetEntry } from '../../types/production.d.ts' */
-
-import { get_route_entry_path } from '../routes.js';
-
-/**
- * @typedef {Object} ServerEntryOptions
- * @property {Route[]} routes - Route definitions from octane.config.ts
- * @property {string} octaneConfigPath - Absolute path to octane.config.ts
- * @property {Record<string, ClientAssetEntry>} [clientAssetMap] - Route entry path → built client asset paths
- */
-
-/**
- * @param {ServerEntryOptions} options
- * @returns {string} The generated JavaScript module source
- */
-export function generateServerEntry(options) {
-	const { routes, octaneConfigPath, clientAssetMap = {} } = options;
-
-	// Unique page-entry and layout module paths (multiple routes may share both).
-	/** @type {Map<string, string>} module path → import variable name */
-	const page_imports = new Map();
-	/** @type {Map<string, string>} */
-	const layout_imports = new Map();
-
-	for (const route of routes) {
-		if (route.type !== 'render') continue;
-		const entryPath = get_route_entry_path(route.entry);
-		if (entryPath && !page_imports.has(entryPath)) {
-			page_imports.set(entryPath, `_page_${page_imports.size}`);
-		}
-		if (typeof route.layout === 'string' && !layout_imports.has(route.layout)) {
-			layout_imports.set(route.layout, `_layout_${layout_imports.size}`);
-		}
-	}
-
-	const import_lines = [];
-	for (const [modulePath, varName] of page_imports) {
-		import_lines.push(`import * as ${varName} from ${JSON.stringify(modulePath)};`);
-	}
-	for (const [modulePath, varName] of layout_imports) {
-		import_lines.push(`import * as ${varName} from ${JSON.stringify(modulePath)};`);
-	}
-
-	// The manifest maps MODULE PATHS to module namespaces; createHandler picks
-	// the export per-route with the same `get_component_export` dev uses.
-	const component_entries = [...page_imports]
-		.map(([modulePath, varName]) => `\t${JSON.stringify(modulePath)}: ${varName},`)
-		.join('\n');
-	const layout_entries = [...layout_imports]
-		.map(([modulePath, varName]) => `\t${JSON.stringify(modulePath)}: ${varName},`)
-		.join('\n');
-
-	return `\
-// Auto-generated by @octanejs/vite-plugin — the production server entry.
-// Do not edit; regenerated on every build.
-
-import { readFileSync } from 'node:fs';
-import { createHash } from 'node:crypto';
-import { AsyncLocalStorage } from 'node:async_hooks';
-import { fileURLToPath } from 'node:url';
-import { dirname, join, resolve } from 'node:path';
-
-import { renderToReadableStream, executeServerFunction } from 'octane/server';
-import { prerender } from 'octane/static';
-import { createHandler, resolveOctaneConfig } from '@octanejs/vite-plugin/production';
-import { createNodeServer, nodeRequestToWebRequest, sendWebResponse } from '@octanejs/vite-plugin/node';
-
-// The app config — bundled (the sub-build aliases '@octanejs/vite-plugin' to
-// its config-surface facade, so this does not drag the compiler in).
-import _rawOctaneConfig from ${JSON.stringify(octaneConfigPath)};
-
-${import_lines.join('\n')}
-
-const octaneConfig = resolveOctaneConfig(_rawOctaneConfig);
-
-// Platform primitives: the adapter's when configured, else Node defaults.
-// (hash mirrors the compiler's module-server hashing: sha-256 hex, 8 chars.)
-const runtime = octaneConfig.adapter?.runtime ?? {
-	hash: (str) => createHash('sha256').update(str).digest('hex').slice(0, 8),
-	createAsyncContext: () => {
-		const als = new AsyncLocalStorage();
-		return { run: (store, fn) => als.run(store, fn), getStore: () => als.getStore() };
-	},
-};
-
-const __dirname = dirname(fileURLToPath(import.meta.url));
-// The HTML template is the BUILT client index.html (hashed hydrate script and
-// asset links already in place), moved next to this entry by the build.
-const htmlTemplate = readFileSync(join(__dirname, './index.html'), 'utf-8');
-
-const components = {
-${component_entries}
-};
-
-const layouts = {
-${layout_entries}
-};
-
-const clientAssets = ${JSON.stringify(clientAssetMap, null, '\t')};
-
-export const handler = createHandler(
-	{
-		routes: octaneConfig.router.routes,
-		components,
-		layouts,
-		middlewares: octaneConfig.middlewares,
-		trustProxy: octaneConfig.server.trustProxy,
-		render: octaneConfig.server.render,
-		rootBoundary: octaneConfig.rootBoundary,
-		preHydrate: octaneConfig.router.preHydrate ?? null,
-		rpcModules: {},
-		runtime,
-		clientAssets,
-	},
-	{
-		renderToReadableStream,
-		prerender,
-		htmlTemplate,
-		executeServerFunction,
-	},
-);
-
-/**
- * Node-style (req, res) wrapper — for serverless platforms whose functions
- * speak Node HTTP (e.g. Vercel's Node runtime).
- */
-export async function nodeHandler(req, res) {
-	try {
-		const response = await handler(nodeRequestToWebRequest(req));
-		await sendWebResponse(res, response);
-	} catch (error) {
-		console.error('[@octanejs/vite-plugin] Request error:', error);
-		if (!res.headersSent) {
-			res.statusCode = 500;
-			res.setHeader('Content-Type', 'text/plain; charset=utf-8');
-		}
-		res.end('Internal Server Error');
-	}
-}
-
-// Auto-boot when run directly (node dist/server/entry.js); stay quiet when
-// imported by a serverless wrapper.
-const isMainModule =
-	typeof process !== 'undefined' &&
-	process.argv[1] &&
-	fileURLToPath(import.meta.url) === resolve(process.argv[1]);
-
-if (isMainModule) {
-	const port = process.env.PORT ? parseInt(process.env.PORT, 10) : 3000;
-	if (isNaN(port) || port < 1 || port > 65535) {
-		console.error('[@octanejs/vite-plugin] Invalid PORT value:', process.env.PORT);
-		process.exit(1);
-	}
-	const staticDir = join(__dirname, '../client');
-	const server = octaneConfig.adapter?.serve
-		? octaneConfig.adapter.serve(handler, { static: { dir: staticDir } })
-		: createNodeServer(handler, { staticDir });
-	server.listen(port);
-	console.log('[@octanejs/vite-plugin] Production server listening on port ' + port);
-}
-`;
-}
+export { generateServerEntry, generateServerManifestEntry } from '@octanejs/app-core/codegen';

package/types/index.d.ts

@@ -1,278 +1,70 @@
-import type { Plugin, BuildEnvironmentOptions, ViteDevServer } from 'vite';
-import type { RuntimePrimitives } from '@ripple-ts/adapter';
+import type { Plugin, ViteDevServer } from 'vite';
+import type {
+	ConfigModuleRunner,
+	ExperimentalRendererConfigOptions,
+	LoadedOctaneConfig,
+	OctaneConfigOptions,
+	ResolvedOctaneConfig,
+} from '@octanejs/app-core';
 
-// ============================================================================
-// Plugin exports
-// ============================================================================
+export * from '@octanejs/app-core';
 
 export interface OctanePluginOptions {
 	/** Override the client HMR default (on in serve mode, off for SSR). */
 	hmr?: boolean;
+	/** Enable component profiling in client transforms. */
+	profile?: boolean;
 	/**
 	 * Path fragments the compiler's plain `.ts`/`.js` hook-slotting pass must
-	 * skip — hand-slot-forwarding library sources that would otherwise be
-	 * double-slotted. Published bindings live in node_modules and are skipped
-	 * automatically; set this for monorepo / aliased-to-source setups where
-	 * pnpm symlinks resolve `@octanejs/*` imports to `packages/*\/src` paths
-	 * (e.g. `['/packages/tanstack-router/src/']`).
+	 * skip. Prefer package manifest `octane.hookSlots.manual` declarations.
+	 * With `requireDirective`, excluded paths are exempt from Octane ownership
+	 * entirely — including `.tsrx`/`.tsx` — for projects routing those paths
+	 * through a different tsrx compiler (e.g. `@tsrx/react`).
 	 */
 	exclude?: string[];
+	/**
+	 * Mixed-toolchain ownership gate: when `true`, Octane compiles only
+	 * project modules that declare `'use octane'` in their directive prologue.
+	 * Undirected project `.tsx`/`.ts`/`.js` pass through to the host
+	 * framework's own pipeline (e.g. React's JSX transform); an undirected
+	 * project `.tsrx` is a build error. Installed and linked packages keep
+	 * their Octane package-manifest decision. The directive is always
+	 * tolerated and stripped from compiled output, even when this is off.
+	 * @default false
+	 */
+	requireDirective?: boolean;
+	/**
+	 * @experimental Full renderer-config override. When omitted, the compiler
+	 * reads `compiler.renderers` from `octane.config.ts` before transforming modules.
+	 */
+	renderers?: ExperimentalRendererConfigOptions;
 }
 
-/**
- * The octane metaframework plugin. Returns an array:
- * `[octane(), metaPlugin]` — the first compiles `.tsrx`, the second owns
- * config / routing / dev SSR / hydrate.
- */
+/** The Octane compiler plugin plus Vite app/metaframework integration. */
 export function octane(options?: OctanePluginOptions): Plugin[];
 
-/**
- * Is this a request the Vite dev server owns (module / asset / internal
- * namespace / transform query), as opposed to a page navigation? The dev SSR
- * middleware uses it so a catch-all RenderRoute never swallows Vite requests.
- *
- * `fileRoots` (the Vite root + publicDir) gate the file-extension heuristic:
- * an extension-bearing path is only Vite's when it names a real file under
- * one of them, so page URLs like `/docs/v2.0` still SSR. Without `fileRoots`
- * any extension counts (conservative).
- */
+/** Return whether a dev request belongs to Vite rather than an app route. */
 export function isViteOwnedUrl(url: URL, fileRoots?: string[]): boolean;
-export function defineConfig(options: OctaneConfigOptions): OctaneConfigOptions;
+
+export interface ViteLoadConfigOptions {
+	vite?: ViteDevServer;
+	moduleRunner?: ConfigModuleRunner | ConfigModuleRunner['loadModule'];
+	requireAdapter?: boolean;
+	configFile?: string;
+	cacheDir?: string;
+}
+
+export function getOctaneConfigPath(projectRoot: string, configFile?: string): string;
+export function octaneConfigExists(projectRoot: string, configFile?: string): boolean;
+export function loadOctaneConfig(
+	projectRoot: string,
+	options?: ViteLoadConfigOptions,
+): Promise<ResolvedOctaneConfig>;
+export function loadOctaneConfigWithMetadata(
+	projectRoot: string,
+	options?: ViteLoadConfigOptions,
+): Promise<LoadedOctaneConfig>;
 export function resolveOctaneConfig(
 	raw: OctaneConfigOptions,
 	options?: { requireAdapter?: boolean },
 ): ResolvedOctaneConfig;
-export function getOctaneConfigPath(projectRoot: string): string;
-export function octaneConfigExists(projectRoot: string): boolean;
-export function loadOctaneConfig(
-	projectRoot: string,
-	options?: { vite?: ViteDevServer; requireAdapter?: boolean },
-): Promise<ResolvedOctaneConfig>;
-
-// ============================================================================
-// Route classes
-// ============================================================================
-
-export class RenderRoute {
-	readonly type: 'render';
-	path: string;
-	entry: RenderRouteEntry;
-	layout?: string;
-	before: Middleware[];
-	status?: number;
-	constructor(options: RenderRouteOptions);
-}
-
-export class ServerRoute {
-	readonly type: 'server';
-	path: string;
-	methods: string[];
-	handler: RouteHandler;
-	before: Middleware[];
-	after: Middleware[];
-	constructor(options: ServerRouteOptions);
-}
-
-export type Route = RenderRoute | ServerRoute;
-
-// ============================================================================
-// Route options
-// ============================================================================
-
-export interface RenderRouteOptions {
-	/** URL path pattern (e.g., '/', '/posts/:id', '/docs/*slug') */
-	path: string;
-	/** Path to the component entry file, optionally with a preferred named export */
-	entry: RenderRouteEntry;
-	/** Path to the layout component (wraps the entry) */
-	layout?: string;
-	/** Middleware to run before rendering */
-	before?: Middleware[];
-	/**
-	 * HTTP status for the rendered response (default 200). Set 404 on a
-	 * catch-all route so the SSR'd not-found page reports its real status.
-	 */
-	status?: number;
-}
-
-export interface ServerRouteOptions {
-	/** URL path pattern (e.g., '/api/hello', '/api/posts/:id') */
-	path: string;
-	/** HTTP methods to handle (default: ['GET']) */
-	methods?: string[];
-	/** Request handler that returns a Response */
-	handler: RouteHandler;
-	/** Middleware to run before the handler */
-	before?: Middleware[];
-	/** Middleware to run after the handler */
-	after?: Middleware[];
-}
-
-// ============================================================================
-// Context and middleware
-// ============================================================================
-
-export interface Context {
-	/** The incoming Request object */
-	request: Request;
-	/** URL parameters extracted from the route pattern */
-	params: Record<string, string>;
-	/** Parsed URL object */
-	url: URL;
-	/** Shared state for passing data between middlewares */
-	state: Map<string, unknown>;
-}
-
-export type NextFunction = () => Promise<Response>;
-export type Middleware = (context: Context, next: NextFunction) => Response | Promise<Response>;
-export type RouteHandler = (context: Context) => Response | Promise<Response>;
-
-// ============================================================================
-// Configuration
-// ============================================================================
-
-export type Component<T = Record<string, any>> = (
-	scope: any,
-	props: T,
-	extra?: any,
-) => string | void;
-
-export type RenderRouteEntry = string | readonly [exportName: string, path: string];
-
-/**
- * Props every RenderRoute component (and layout) receives: the route params
- * and the request `url` (pathname + search, origin-free — the client hydrate
- * entry re-renders with the identical string).
- */
-export interface RenderRouteProps {
-	params: Record<string, string>;
-	url: string;
-}
-
-/**
- * The app hook run by the client hydrate entry BEFORE `hydrateRoot` (config
- * `router.preHydrate`): commit client-side state the server already resolved —
- * typically a client router loading its match tree — so the first hydration
- * pass adopts the same tree the server rendered.
- */
-export type PreHydrateHook = (info: {
-	url: string;
-	params: Record<string, string>;
-}) => void | Promise<void>;
-
-export interface RootBoundaryOptions {
-	pending?: Component<Record<string, never>>;
-	catch?: Component<{ error: unknown; reset: () => void }>;
-}
-
-export interface OctaneConfigOptions {
-	build?: {
-		/** Output directory for the production build. @default 'dist' */
-		outDir?: string;
-		minify?: boolean;
-		target?: BuildEnvironmentOptions['target'];
-	};
-	adapter?: OctaneAdapter;
-	router?: {
-		routes: Route[];
-		/**
-		 * Vite-root path (e.g. '/src/pre-hydrate.ts') of a module whose default
-		 * export is a {@link PreHydrateHook}. The client hydrate entry imports it
-		 * and awaits the hook before calling `hydrateRoot`.
-		 */
-		preHydrate?: string;
-	};
-	/** Global root pending/catch UI used by client and SSR render roots */
-	rootBoundary?: RootBoundaryOptions;
-	/** Global middlewares applied to all routes */
-	middlewares?: Middleware[];
-	platform?: {
-		env: Record<string, string>;
-	};
-	server?: {
-		/**
-		 * Trust `X-Forwarded-Proto` / `X-Forwarded-Host` when deriving the
-		 * request origin. Enable only behind a trusted reverse proxy.
-		 * @default false
-		 */
-		trustProxy?: boolean;
-		/**
-		 * Production SSR mode: 'streaming' (default) flushes the shell at
-		 * first await and streams suspense segments out-of-order (same engine
-		 * as dev SSR); 'buffered' awaits everything (`prerender`) and sends
-		 * one document — for hosts that break streamed responses.
-		 * @default 'streaming'
-		 */
-		render?: 'streaming' | 'buffered';
-	};
-}
-
-/**
- * Resolved configuration with all defaults applied.
- */
-export interface ResolvedOctaneConfig {
-	build: {
-		/** @default 'dist' */
-		outDir: string;
-		minify?: boolean;
-		target?: BuildEnvironmentOptions['target'];
-	};
-	adapter?: OctaneAdapter;
-	router: {
-		routes: Route[];
-		preHydrate?: string;
-	};
-	rootBoundary: RootBoundaryOptions;
-	/** @default [] */
-	middlewares: Middleware[];
-	platform: {
-		/** @default {} */
-		env: Record<string, string>;
-	};
-	server: {
-		/** @default false */
-		trustProxy: boolean;
-		/** @default 'streaming' */
-		render: 'streaming' | 'buffered';
-	};
-}
-
-/**
- * The build context @octanejs/vite-plugin passes to an adapter's `adapt()`
- * after `vite build` produced both bundles.
- */
-export interface AdaptContext {
-	/** Absolute project root (the Vite root). */
-	root: string;
-	/** The config `build.outDir` (relative to root, e.g. 'dist'). */
-	outDir: string;
-	/** Absolute path of the static client bundle ({outDir}/client). */
-	clientDir: string;
-	/** Absolute path of the server bundle ({outDir}/server, contains entry.js). */
-	serverDir: string;
-	/** Prefixed build logger. */
-	log: (message: string) => void;
-}
-
-/**
- * The octane.config.ts `adapter` contract. All parts are optional and
- * independent:
- *
- * - `adapt(ctx)` — post-build hook: restructure dist/client + dist/server for
- *   a deployment target (e.g. @octanejs/adapter-vercel emits `.vercel/output`).
- * - `serve(handler, opts)` — replaces the generated server entry's built-in
- *   Node boot when running `node dist/server/entry.js` / `octane-preview`.
- * - `runtime` — platform primitives (hashing, async context) replacing the
- *   entry's Node defaults; needed on non-Node runtimes.
- */
-export interface OctaneAdapter {
-	name?: string;
-	adapt?: (ctx: AdaptContext) => void | Promise<void>;
-	serve?: AdapterServeFunction;
-	runtime?: RuntimePrimitives;
-}
-
-export type AdapterServeFunction = (
-	handler: (request: Request, platform?: unknown) => Response | Promise<Response>,
-	options?: Record<string, unknown>,
-) => { listen: (port?: number) => unknown; close: () => void };

package/types/node.d.ts

@@ -1,31 +1 @@
-import type { IncomingMessage, ServerResponse, Server } from 'node:http';
-
-/** Convert a Node.js IncomingMessage to a Web Request. */
-export function nodeRequestToWebRequest(nodeRequest: IncomingMessage): Request;
-
-/**
- * Pipe a Web Response to a Node.js ServerResponse, streaming chunk-by-chunk
- * (a streaming SSR body flushes as it renders).
- */
-export function sendWebResponse(nodeResponse: ServerResponse, webResponse: Response): Promise<void>;
-
-/**
- * Serve a static file from `staticDir` when the request path maps to one.
- * `/assets/*` (hash-named build output) gets immutable caching; other files
- * revalidate. Returns true when the request was handled.
- */
-export function serveStaticFile(
-	req: IncomingMessage,
-	res: ServerResponse,
-	staticDir: string,
-): boolean;
-
-/**
- * Minimal production HTTP server: static files from `staticDir` first (the
- * built client assets), then the fetch-style SSR handler. The default boot for
- * `node dist/server/entry.js` when octane.config.ts has no adapter.
- */
-export function createNodeServer(
-	handler: (request: Request) => Response | Promise<Response>,
-	options?: { staticDir?: string },
-): { listen: (port?: number) => Server; close: () => void };
+export * from '@octanejs/app-core/node';

package/types/production.d.ts

@@ -1,71 +1 @@
-import type { RuntimePrimitives } from '@ripple-ts/adapter';
-import type {
-	Route,
-	Middleware,
-	ResolvedOctaneConfig,
-	OctaneConfigOptions,
-	RootBoundaryOptions,
-} from '@octanejs/vite-plugin';
-import type { RenderResult, StreamOptions, RenderOptions } from 'octane/server';
-
-export function resolveOctaneConfig(
-	raw: OctaneConfigOptions,
-	options?: { requireAdapter?: boolean },
-): ResolvedOctaneConfig;
-
-export interface ClientAssetEntry {
-	/** Path to the built JS file (relative to the client output dir) */
-	js: string;
-	/** Paths to the built CSS files (relative to the client output dir) */
-	css: string[];
-}
-
-export interface ServerManifest {
-	routes: Route[];
-	/** RenderRoute entry module path → module namespace (export picked per-route) */
-	components: Record<string, Record<string, unknown>>;
-	/** Layout module path → module namespace */
-	layouts: Record<string, Record<string, unknown>>;
-	middlewares: Middleware[];
-	/** Trust X-Forwarded-* headers when deriving origin for RPC fetch */
-	trustProxy?: boolean;
-	/** 'streaming' (default) renders via renderToReadableStream; 'buffered' awaits everything via prerender */
-	render?: 'streaming' | 'buffered';
-	rootBoundary?: RootBoundaryOptions;
-	/** config `router.preHydrate`, serialized into #__octane_data for the client entry */
-	preHydrate?: string | null;
-	/** Map of entry path → `module server` namespace for RPC support */
-	rpcModules?: Record<string, Record<string, Function>>;
-	/** Platform primitives (adapter's, or the generated entry's Node defaults) */
-	runtime?: RuntimePrimitives;
-	/** Route entry module path → built client asset paths (preload tags) */
-	clientAssets?: Record<string, ClientAssetEntry>;
-}
-
-export interface HandlerOptions {
-	/** `renderToReadableStream` from 'octane/server' (the streaming engine dev SSR uses) */
-	renderToReadableStream: (
-		component: Function,
-		props?: unknown,
-		options?: StreamOptions,
-	) => Promise<ReadableStream<Uint8Array>>;
-	/** `prerender` from 'octane/static' (the buffered await-everything fallback) */
-	prerender: (
-		component: Function,
-		props?: unknown,
-		options?: RenderOptions,
-	) => Promise<RenderResult>;
-	/** The BUILT dist client index.html (moved to dist/server by the build) */
-	htmlTemplate: string;
-	/** RPC executor from 'octane/server' */
-	executeServerFunction: (fn: Function, body: string) => Promise<string>;
-}
-
-/**
- * Production fetch-handler factory. Mirrors the dev middleware's render path
- * byte-for-byte in everything hydration can see (see server/production.js).
- */
-export function createHandler(
-	manifest: ServerManifest,
-	options: HandlerOptions,
-): (request: Request) => Promise<Response>;
+export * from '@octanejs/app-core/production';