@sigil-dev/grimoire 0.4.0 → 0.5.0

package/index.ts

@@ -1,23 +1,29 @@
-export type { RouteFile, RouteTree } from "./src/scanner";
-export { scanRoutes } from "./src/scanner";
-export { createServer } from "./src/server";
-export { fail, isFailResult } from "./src/fail";
-export type { FailResult } from "./src/fail";
-export { redirect, isRedirectResult } from "./src/redirect";
-export type { RedirectResult } from "./src/redirect";
-export { error, isErrorResult } from "./src/error";
-export type { ErrorResult } from "./src/error";
-export type { Handle, RequestEvent, Cookies, CookieOptions, ResolveFunction } from "./src/hooks";
-export { sequence, createHooks } from "./src/hooks";
-export type { TypegenConfig } from "./src/typegen";
-export { generateTypes } from "./src/typegen";
-export type {
-	GrimoireConfig,
-	GrimoirePlugin,
-	LoadContext,
-	RenderContext,
-	RouteInfo,
-	TypedLoadContext,
-} from "./src/types";
-export { defineConfig } from "./src/types";
-export { Head } from "./src/head";
+export type { RouteFile, RouteTree } from "./src/scanner";
+export { scanRoutes } from "./src/scanner";
+export { buildProject } from "./src/build";
+export { createServer } from "./src/server";
+export { fail, isFailResult } from "./src/fail";
+export type { FailResult } from "./src/fail";
+export { redirect, isRedirectResult } from "./src/redirect";
+export type { RedirectResult } from "./src/redirect";
+export { error, isErrorResult } from "./src/error";
+export type { ErrorResult } from "./src/error";
+export type { Handle, RequestEvent, Cookies, CookieOptions, ResolveFunction } from "./src/hooks";
+export { parseCookies } from "./src/cookie-utils";
+export { sequence, createHooks } from "./src/hooks";
+export type { TypegenConfig } from "./src/typegen";
+export { generateTypes } from "./src/typegen";
+export type {
+	GrimoireConfig,
+	GrimoirePlugin,
+	LoadContext,
+	RenderContext,
+	RouteInfo,
+	TypedLoadContext,
+	PageServerLoad,
+	LayoutServerLoad,
+	RequestHandler,
+	WsRouteHandler,
+} from "./src/types";
+export { defineConfig } from "./src/types";
+export { Head } from "./src/head";

package/package.json

@@ -3,7 +3,7 @@
 	"module": "index.ts",
 	"type": "module",
 	"private": false,
-	"version": "0.4.0",
+	"version": "0.5.0",
 	"devDependencies": {
 		"@types/bun": "latest"
 	},

package/public/__grimoire__/client.js

@@ -1,62 +1,31 @@
-// .grimoire/_routes.dom.js
+// .grimoire/_routes.ts
 var routes = {};
 
-// src/scope.ts
-function withEffectScope(fn) {
-  const prev = globalThis.__sigilEffectScope;
-  const disposers = [];
-  globalThis.__sigilEffectScope = disposers;
-  try {
-    fn();
-  } finally {
-    globalThis.__sigilEffectScope = prev;
-  }
-  return () => {
-    for (const d of disposers)
-      d();
-    disposers.length = 0;
-  };
-}
-
 // src/client-router.ts
 var routeMap = {};
-var disposeCurrentPage = null;
 async function navigate(path) {
   const res = await fetch(path, { headers: { "x-grimoire-navigate": "1" } });
   const json = await res.json();
+  console.log("navigate response:", json);
   const { data, params, pattern, head } = json;
   const Page = routeMap[pattern];
   if (!Page) {
     window.location.href = path;
     return;
   }
-  disposeCurrentPage?.();
-  disposeCurrentPage = null;
-  globalThis.__nodes = [];
-  let node;
-  disposeCurrentPage = withEffectScope(() => {
-    node = Page({ data, params });
-  });
+  const node = Page({ ...data, params });
   const slot = document.getElementById("grimoire-page");
   if (!slot)
     return;
   slot.replaceChildren(node);
   updateHead(head);
   history.pushState({}, "", path);
-  currentPath = path;
   window.scrollTo(0, 0);
 }
-var currentPath = location.pathname;
-function initRouter(routes2, initialDispose) {
+function initRouter(routes2) {
   routeMap = routes2;
-  disposeCurrentPage = initialDispose ?? null;
   document.addEventListener("click", handleClick);
-  window.addEventListener("popstate", () => {
-    if (location.pathname !== currentPath) {
-      currentPath = location.pathname;
-      navigate(location.pathname);
-    }
-  });
+  window.addEventListener("popstate", () => navigate(location.pathname));
 }
 function updateHead(headHtml) {
   document.querySelectorAll("[data-grimoire-head]").forEach((el) => el.remove());

package/public/__grimoire__/hydrate.js

@@ -1,62 +1,31 @@
-// .grimoire/_routes.hydrate.js
+// .grimoire/_routes.ts
 var routes = {};
 
-// src/scope.ts
-function withEffectScope(fn) {
-  const prev = globalThis.__sigilEffectScope;
-  const disposers = [];
-  globalThis.__sigilEffectScope = disposers;
-  try {
-    fn();
-  } finally {
-    globalThis.__sigilEffectScope = prev;
-  }
-  return () => {
-    for (const d of disposers)
-      d();
-    disposers.length = 0;
-  };
-}
-
 // src/client-router.ts
 var routeMap = {};
-var disposeCurrentPage = null;
 async function navigate(path) {
   const res = await fetch(path, { headers: { "x-grimoire-navigate": "1" } });
   const json = await res.json();
+  console.log("navigate response:", json);
   const { data, params, pattern, head } = json;
   const Page = routeMap[pattern];
   if (!Page) {
     window.location.href = path;
     return;
   }
-  disposeCurrentPage?.();
-  disposeCurrentPage = null;
-  globalThis.__nodes = [];
-  let node;
-  disposeCurrentPage = withEffectScope(() => {
-    node = Page({ data, params });
-  });
+  const node = Page({ ...data, params });
   const slot = document.getElementById("grimoire-page");
   if (!slot)
     return;
   slot.replaceChildren(node);
   updateHead(head);
   history.pushState({}, "", path);
-  currentPath = path;
   window.scrollTo(0, 0);
 }
-var currentPath = location.pathname;
-function initRouter(routes2, initialDispose) {
+function initRouter(routes2) {
   routeMap = routes2;
-  disposeCurrentPage = initialDispose ?? null;
   document.addEventListener("click", handleClick);
-  window.addEventListener("popstate", () => {
-    if (location.pathname !== currentPath) {
-      currentPath = location.pathname;
-      navigate(location.pathname);
-    }
-  });
+  window.addEventListener("popstate", () => navigate(location.pathname));
 }
 function updateHead(headHtml) {
   document.querySelectorAll("[data-grimoire-head]").forEach((el) => el.remove());
@@ -84,18 +53,11 @@ function handleClick(e) {
 
 // src/hydrate.ts
 var stateEl = document.getElementById("__grimoire_state__");
-var initialDispose;
 if (stateEl) {
   const state = JSON.parse(stateEl.textContent);
   const Page = routes[state.pattern];
   if (Page) {
-    const slot = document.getElementById("grimoire-page");
-    if (slot) {
-      globalThis.__nodes = Array.from(slot.childNodes);
-      initialDispose = withEffectScope(() => {
-        Page({ data: state.data, params: state.params });
-      });
-    }
+    Page({ ...state.data, params: state.params });
   }
 }
-initRouter(routes, initialDispose);
+initRouter(routes);

package/src/build.ts

@@ -0,0 +1,88 @@
+import { mkdir } from "fs/promises";
+import { isAbsolute, join } from "path";
+import { sigil } from "@sigil-dev/compiler/bun";
+import { generateManifest } from "./manifest-gen";
+import { runHook } from "./plugins";
+import { scanRoutes } from "./scanner";
+import type { RouteTree } from "./scanner";
+import { transformRoutes } from "./transform-routes";
+import { generateTypes } from "./typegen";
+import type { BuildResult, GrimoireConfig, GrimoirePlugin } from "./types";
+
+export async function buildProject(
+	config: GrimoireConfig,
+	plugins: GrimoirePlugin[] = [],
+): Promise<{ result: BuildResult; tree: RouteTree }> {
+	await runHook(plugins, "onBuildStart");
+
+	const { routes = "src/routes" } = config;
+
+	const routesDir = isAbsolute(routes)
+		? routes.replace(/\0/g, "")
+		: join(process.cwd(), routes).replace(/\0/g, "");
+	const tree = await scanRoutes(routesDir, process.cwd());
+
+	await mkdir(join(process.cwd(), ".grimoire"), { recursive: true });
+
+	await generateTypes(tree, {
+		projectRoot: process.cwd(),
+		routesDir,
+		outDir: join(process.cwd(), ".grimoire/types"),
+	});
+
+	const compiledDir = join(process.cwd(), ".grimoire/compiled");
+	await mkdir(compiledDir, { recursive: true });
+
+	const pageRoutes = tree.routes.filter(
+		(r) => r.type === "page" || r.type === "simple",
+	);
+	const [hydrateFiles, domFiles] = await Promise.all([
+		transformRoutes(pageRoutes, compiledDir, "hydrate", plugins),
+		transformRoutes(pageRoutes, compiledDir, "dom", plugins),
+	]);
+
+	const hydrateManifest = join(process.cwd(), ".grimoire/_routes.hydrate.js");
+	const domManifest = join(process.cwd(), ".grimoire/_routes.dom.js");
+	await Promise.all([
+		Bun.write(hydrateManifest, generateManifest(pageRoutes, hydrateFiles)),
+		Bun.write(domManifest, generateManifest(pageRoutes, domFiles)),
+	]);
+
+	const makeRoutesPlugin = (manifestPath: string) => ({
+		name: "grimoire-routes",
+		setup(build: any) {
+			build.onResolve({ filter: /^#grimoire-routes$/ }, () => ({
+				path: manifestPath,
+			}));
+		},
+	});
+
+	const [hydrateResult, domResult] = await Promise.all([
+		Bun.build({
+			entrypoints: [join(import.meta.dir, "./hydrate.ts")],
+			outdir: join(process.cwd(), "public/__grimoire__"),
+			plugins: [sigil({ mode: "hydrate" }), makeRoutesPlugin(hydrateManifest)],
+		}),
+		Bun.build({
+			entrypoints: [join(import.meta.dir, "./client.ts")],
+			outdir: join(process.cwd(), "public/__grimoire__"),
+			plugins: [sigil({ mode: "dom" }), makeRoutesPlugin(domManifest)],
+		}),
+	]);
+
+	if (!hydrateResult.success) {
+		for (const log of hydrateResult.logs) console.error(log);
+	}
+	if (!domResult.success) {
+		for (const log of domResult.logs) console.error(log);
+	}
+
+	const result: BuildResult = {
+		success: hydrateResult.success && domResult.success,
+		outputs: [...hydrateResult.outputs, ...domResult.outputs].map((o) => o.path),
+		errors: [...hydrateResult.logs, ...domResult.logs].map(String),
+	};
+
+	await runHook(plugins, "onBuildEnd", result);
+	return { result, tree };
+}

package/src/cookie-utils.ts

@@ -1,66 +1,66 @@
-/**
- * Parse cookies from a Cookie header string.
- */
-export function parseCookies(cookieHeader: string): Map<string, string> {
-	const map = new Map<string, string>();
-	if (!cookieHeader) return map;
-	for (const pair of cookieHeader.split(";")) {
-		const [name, ...rest] = pair.split("=");
-		if (name) map.set(name.trim(), rest.join("=").trim());
-	}
-	return map;
-}
-
-/**
- * Build a Set-Cookie header from name, value, and options.
- */
-export function serializeCookie(
-	name: string,
-	value: string,
-	options?: {
-		path?: string;
-		domain?: string;
-		maxAge?: number;
-		expires?: Date;
-		httpOnly?: boolean;
-		secure?: boolean;
-		sameSite?: "strict" | "lax" | "none";
-	},
-): string {
-	let cookie = `${name}=${encodeURIComponent(value)}`;
-	if (options?.path) cookie += `; Path=${options.path}`;
-	if (options?.domain) cookie += `; Domain=${options.domain}`;
-	if (options?.maxAge != null) cookie += `; Max-Age=${options.maxAge}`;
-	if (options?.expires) cookie += `; Expires=${options.expires.toUTCString()}`;
-	if (options?.httpOnly) cookie += "; HttpOnly";
-	if (options?.secure) cookie += "; Secure";
-	if (options?.sameSite) cookie += `; SameSite=${options.sameSite}`;
-	return cookie;
-}
-
-/**
- * Create a Cookies helper from a Cookie header string.
- */
-export function createCookies(
-	cookieHeader: string,
-): import("./hooks").Cookies & { toHeaders(): string[] } {
-	const store = parseCookies(cookieHeader);
-	const pending: string[] = [];
-
-	return {
-		get(name: string) {
-			return store.get(name);
-		},
-		set(name: string, value: string, options?: any) {
-			store.set(name, value);
-			pending.push(serializeCookie(name, value, options));
-		},
-		delete(name: string) {
-			store.delete(name);
-			pending.push(serializeCookie(name, "", { maxAge: 0 }));
-		},
-		toHeaders() {
-			return pending;
-		},
-	};
-}
+/**
+ * Parse cookies from a Cookie header string.
+ */
+export function parseCookies(cookieHeader: string): Map<string, string> {
+	const map = new Map<string, string>();
+	if (!cookieHeader) return map;
+	for (const pair of cookieHeader.split(";")) {
+		const [name, ...rest] = pair.split("=");
+		if (name) map.set(name.trim(), rest.join("=").trim());
+	}
+	return map;
+}
+
+/**
+ * Build a Set-Cookie header from name, value, and options.
+ */
+export function serializeCookie(
+	name: string,
+	value: string,
+	options?: {
+		path?: string;
+		domain?: string;
+		maxAge?: number;
+		expires?: Date;
+		httpOnly?: boolean;
+		secure?: boolean;
+		sameSite?: "strict" | "lax" | "none";
+	},
+): string {
+	let cookie = `${name}=${encodeURIComponent(value)}`;
+	if (options?.path) cookie += `; Path=${options.path}`;
+	if (options?.domain) cookie += `; Domain=${options.domain}`;
+	if (options?.maxAge != null) cookie += `; Max-Age=${options.maxAge}`;
+	if (options?.expires) cookie += `; Expires=${options.expires.toUTCString()}`;
+	if (options?.httpOnly) cookie += "; HttpOnly";
+	if (options?.secure) cookie += "; Secure";
+	if (options?.sameSite) cookie += `; SameSite=${options.sameSite}`;
+	return cookie;
+}
+
+/**
+ * Create a Cookies helper from a Cookie header string.
+ */
+export function createCookies(
+	cookieHeader: string,
+): import("./hooks").Cookies & { toHeaders(): string[] } {
+	const store = parseCookies(cookieHeader);
+	const pending: string[] = [];
+
+	return {
+		get(name: string) {
+			return store.get(name);
+		},
+		set(name: string, value: string, options?: any) {
+			store.set(name, value);
+			pending.push(serializeCookie(name, value, options));
+		},
+		delete(name: string) {
+			store.delete(name);
+			pending.push(serializeCookie(name, "", { maxAge: 0 }));
+		},
+		toHeaders() {
+			return pending;
+		},
+	};
+}

package/src/plugins.ts

@@ -1,12 +1,26 @@
-import type { GrimoirePlugin } from "./types";
+import type { BuildResult, GrimoirePlugin, LoadContext, Route, Server } from "./types";
 
-export async function runHook(
+// Fire-and-forget hooks routed through runHook.
+// onRequest and onRouteRender are intentionally excluded: they have distinct
+// calling conventions (middleware chain / inline transform loop) handled in server.ts.
+// Keep HookArgs in sync with GrimoirePlugin in types.ts.
+type HookArgs = {
+	onStart:      [server: Server];
+	onStop:       [reason: "shutdown" | "restart"];
+	onBuildStart: [];
+	onBuildEnd:   [result: BuildResult];
+	onRouteLoad:  [route: Route, context: LoadContext];
+};
+type FireAndForgetHook = keyof HookArgs;
+
+export async function runHook<K extends FireAndForgetHook>(
 	plugins: GrimoirePlugin[],
-	hook: keyof GrimoirePlugin,
-	...args: any
+	hook: K,
+	...args: HookArgs[K]
 ): Promise<void> {
 	for (const plugin of plugins) {
-		await (plugin[hook] as any)?.(...args);
+		const fn = plugin[hook] as ((...a: any[]) => any) | undefined;
+		await fn?.(...args);
 	}
 }
 

package/src/renderer.ts

@@ -2,10 +2,11 @@ import { SafeHtml } from "@sigil-dev/runtime";
 import { isErrorResult } from "./error";
 import { runWithContext } from "./context";
 import { collectHead, initHead } from "./head";
+import { runHook } from "./plugins";
 import { isRedirectResult } from "./redirect";
 import { findClosestError, type MatchedRoute } from "./router";
 import type { RouteFile } from "./scanner";
-import type { LoadContext } from "./types";
+import type { GrimoirePlugin, LoadContext, Route } from "./types";
 
 export type ModuleLoader = (path: string) => Promise<any>;
 
@@ -28,6 +29,7 @@ export async function renderRoute(
 	errorRoutes: RouteFile[] = [],
 	loadModule: ModuleLoader = (path) => import(path),
 	locals: Record<string, any> = {},
+	plugins: GrimoirePlugin[] = [],
 ): Promise<Response> {
 	return runWithContext(async () => {
 		const context: LoadContext = {
@@ -39,6 +41,15 @@ export async function renderRoute(
 
 		initHead();
 
+		const route: Route = {
+			path: matched.route.path,
+			params: matched.params,
+			filePath: matched.route.filePath,
+			loadPath: matched.pageServer?.filePath,
+			layoutPath: matched.layout?.filePath,
+		};
+		await runHook(plugins, "onRouteLoad", route, context);
+
 		let layoutData: unknown;
 		if (matched.layoutServer) {
 			try {