@sigil-dev/grimoire 0.4.0 → 0.5.0

package/test/server.test.ts

@@ -78,3 +78,123 @@ describe("Server — API routes (+server.ts)", () => {
 		server.stop();
 	});
 });
+
+describe("Server — WebSocket routes", () => {
+	let wsDir: string;
+	let server: Awaited<ReturnType<typeof createServer>>;
+
+	beforeAll(async () => {
+		wsDir = join(tmpdir(), `grimoire-ws-${Date.now()}`);
+		await mkdir(join(wsDir, "echo"), { recursive: true });
+		await mkdir(join(wsDir, "params", "[docId]"), { recursive: true });
+		await mkdir(join(wsDir, "reject"), { recursive: true });
+		await mkdir(join(wsDir, "mixed"), { recursive: true });
+
+		// echo: upgrade() merges extra data, message handler echoes back
+		await writeFile(
+			join(wsDir, "echo", "+server.ts"),
+			`export function upgrade({ params }) {
+  return { sessionId: "abc123" };
+}
+export const websocket = {
+  message(ws, data) { ws.send("echo:" + data); },
+};`,
+		);
+
+		// params: no upgrade(), ws.data.params still available
+		await writeFile(
+			join(wsDir, "params", "[docId]", "+server.ts"),
+			`export const websocket = {
+  open(ws) { ws.send("docId:" + ws.data.params.docId); },
+};`,
+		);
+
+		// reject: upgrade() throws → 426
+		await writeFile(
+			join(wsDir, "reject", "+server.ts"),
+			`export function upgrade() {
+  throw new Error("Unauthorized");
+}
+export const websocket = {
+  message(ws, data) { ws.send(data); },
+};`,
+		);
+
+		// mixed: HTTP GET and WebSocket both exported
+		await writeFile(
+			join(wsDir, "mixed", "+server.ts"),
+			`export function GET() {
+  return Response.json({ kind: "http" });
+}
+export function upgrade({ params }) { return {}; }
+export const websocket = {
+  message(ws, data) { ws.send(data); },
+};`,
+		);
+
+		server = await createServer({ port: 3005, routes: wsDir });
+	});
+
+	afterAll(() => {
+		server.stop();
+	});
+
+	function wsConnect(path: string): Promise<WebSocket> {
+		return new Promise((resolve, reject) => {
+			const ws = new WebSocket(`ws://localhost:3005${path}`);
+			ws.onopen = () => resolve(ws);
+			ws.onerror = () => reject(new Error(`WebSocket connection failed: ${path}`));
+		});
+	}
+
+	function nextMessage(ws: WebSocket): Promise<string> {
+		return new Promise((resolve, reject) => {
+			const timer = setTimeout(() => reject(new Error("timeout waiting for message")), 2000);
+			ws.onmessage = (ev) => { clearTimeout(timer); resolve(String(ev.data)); };
+			ws.onerror = () => { clearTimeout(timer); reject(new Error("ws error")); };
+		});
+	}
+
+	test("message is echoed back", async () => {
+		const ws = await wsConnect("/echo");
+		const pending = nextMessage(ws);
+		ws.send("hello");
+		expect(await pending).toBe("echo:hello");
+		ws.close();
+	});
+
+	test("upgrade() return value merges into ws.data", async () => {
+		// sessionId set in upgrade() — echo route sends it back via a second message
+		const ws = new WebSocket("ws://localhost:3005/echo");
+		// just verify connection opens cleanly (sessionId is in ws.data server-side)
+		await new Promise<void>((resolve, reject) => {
+			const t = setTimeout(() => reject(new Error("timeout")), 2000);
+			ws.onopen = () => { clearTimeout(t); resolve(); };
+			ws.onerror = () => { clearTimeout(t); reject(new Error("connect failed")); };
+		});
+		ws.close();
+	});
+
+	test("ws.data.params available when no upgrade() export", async () => {
+		const ws = await wsConnect("/params/42");
+		expect(await nextMessage(ws)).toBe("docId:42");
+		ws.close();
+	});
+
+	test("upgrade() throwing rejects the connection", async () => {
+		await new Promise<void>((resolve, reject) => {
+			const ws = new WebSocket("ws://localhost:3005/reject");
+			const t = setTimeout(() => reject(new Error("timeout")), 2000);
+			ws.onopen = () => { clearTimeout(t); ws.close(); reject(new Error("should not have opened")); };
+			ws.onerror = () => { clearTimeout(t); resolve(); };
+			ws.onclose = (ev) => { clearTimeout(t); if (ev.code !== 1006) resolve(); else resolve(); };
+		});
+	});
+
+	test("plain HTTP GET on mixed route still works (no Upgrade header)", async () => {
+		const res = await fetch("http://localhost:3005/mixed");
+		expect(res.status).toBe(200);
+		const body = await res.json();
+		expect(body.kind).toBe("http");
+	});
+});

package/test/streaming.test.ts

@@ -1,132 +1,132 @@
-import { describe, expect, test } from "bun:test";
-import { renderRoute } from "../src/renderer";
-
-describe("Streaming SSR", () => {
-	test("returns a ReadableStream response", async () => {
-		const matched = {
-			route: {
-				path: "/",
-				params: {},
-				filePath: "data:text/javascript,export default (p) => '<div>hello</div>'",
-			},
-			params: {},
-		} as any;
-
-		const res = await renderRoute(matched, new Request("http://localhost/"));
-		expect(res.body).toBeInstanceOf(ReadableStream);
-	});
-
-	test("stream contains full HTML document", async () => {
-		const matched = {
-			route: {
-				path: "/test",
-				params: {},
-				filePath:
-					"data:text/javascript,export default (p) => '<p>streaming works</p>'",
-			},
-			params: {},
-		} as any;
-
-		const res = await renderRoute(matched, new Request("http://localhost/test"));
-		const html = await res.text();
-
-		expect(html).toContain("<!DOCTYPE html>");
-		expect(html).toContain('<meta charset="UTF-8" />');
-		expect(html).toContain("streaming works");
-		expect(html).toContain("</html>");
-		expect(html).toContain("__grimoire_state__");
-	});
-
-	test("stream includes state JSON with route pattern", async () => {
-		const matched = {
-			route: {
-				path: "/spells/:id",
-				params: {},
-				filePath:
-					"data:text/javascript,export default (p) => '<div>spell</div>'",
-			},
-			params: { id: "fireball" },
-		} as any;
-
-		const res = await renderRoute(
-			matched,
-			new Request("http://localhost/spells/fireball"),
-		);
-		const html = await res.text();
-
-		expect(html).toContain('"pattern":"/spells/:id"');
-		expect(html).toContain('"id":"fireball"');
-	});
-
-	test("head script tag comes before head content", async () => {
-		const matched = {
-			route: {
-				path: "/head-test",
-				params: {},
-				filePath:
-					"data:text/javascript,export default (p) => '<div>head</div>'",
-			},
-			params: {},
-		} as any;
-
-		const res = await renderRoute(matched, new Request("http://localhost/head-test"));
-		const html = await res.text();
-
-		const hydrateScript = html.indexOf("hydrate.js");
-		const headClosing = html.indexOf("</head>");
-		// hydrate.js should be in <head>
-		expect(hydrateScript).toBeGreaterThan(-1);
-		expect(hydrateScript).toBeLessThan(headClosing);
-	});
-
-	test("stream chunks arrive incrementally", async () => {
-		const matched = {
-			route: {
-				path: "/chunked",
-				params: {},
-				filePath:
-					"data:text/javascript,export default (p) => '<div>chunked</div>'",
-			},
-			params: {},
-		} as any;
-
-		const res = await renderRoute(matched, new Request("http://localhost/chunked"));
-		const reader = res.body!.getReader();
-		const chunks: string[] = [];
-
-		while (true) {
-			const { done, value } = await reader.read();
-			if (done) break;
-			// Bun ReadableStream returns Uint8Array
-			chunks.push(typeof value === "string" ? value : new TextDecoder().decode(value.buffer));
-		}
-
-		// Should have multiple chunks (at least DOCTYPE + body)
-		expect(chunks.length).toBeGreaterThan(1);
-		// First chunk should start with DOCTYPE
-		expect(chunks[0]).toContain("<!DOCTYPE html>");
-		// Last chunk should close the document
-		expect(chunks[chunks.length - 1]).toContain("</html>");
-	});
-
-	test("navigation request returns JSON not stream", async () => {
-		const matched = {
-			route: {
-				path: "/nav",
-				params: {},
-				filePath:
-					"data:text/javascript,export default (p) => '<div>nav</div>'",
-			},
-			params: {},
-		} as any;
-
-		const req = new Request("http://localhost/nav", {
-			headers: { "x-grimoire-navigate": "1" },
-		});
-		const res = await renderRoute(matched, req);
-		const json = await res.json();
-
-		expect(json.pattern).toBe("/nav");
-		expect(json.data).toBeDefined();
-	});
-});
+import { describe, expect, test } from "bun:test";
+import { renderRoute } from "../src/renderer";
+
+describe("Streaming SSR", () => {
+	test("returns a ReadableStream response", async () => {
+		const matched = {
+			route: {
+				path: "/",
+				params: {},
+				filePath: "data:text/javascript,export default (p) => '<div>hello</div>'",
+			},
+			params: {},
+		} as any;
+
+		const res = await renderRoute(matched, new Request("http://localhost/"));
+		expect(res.body).toBeInstanceOf(ReadableStream);
+	});
+
+	test("stream contains full HTML document", async () => {
+		const matched = {
+			route: {
+				path: "/test",
+				params: {},
+				filePath:
+					"data:text/javascript,export default (p) => '<p>streaming works</p>'",
+			},
+			params: {},
+		} as any;
+
+		const res = await renderRoute(matched, new Request("http://localhost/test"));
+		const html = await res.text();
+
+		expect(html).toContain("<!DOCTYPE html>");
+		expect(html).toContain('<meta charset="UTF-8" />');
+		expect(html).toContain("streaming works");
+		expect(html).toContain("</html>");
+		expect(html).toContain("__grimoire_state__");
+	});
+
+	test("stream includes state JSON with route pattern", async () => {
+		const matched = {
+			route: {
+				path: "/spells/:id",
+				params: {},
+				filePath:
+					"data:text/javascript,export default (p) => '<div>spell</div>'",
+			},
+			params: { id: "fireball" },
+		} as any;
+
+		const res = await renderRoute(
+			matched,
+			new Request("http://localhost/spells/fireball"),
+		);
+		const html = await res.text();
+
+		expect(html).toContain('"pattern":"/spells/:id"');
+		expect(html).toContain('"id":"fireball"');
+	});
+
+	test("head script tag comes before head content", async () => {
+		const matched = {
+			route: {
+				path: "/head-test",
+				params: {},
+				filePath:
+					"data:text/javascript,export default (p) => '<div>head</div>'",
+			},
+			params: {},
+		} as any;
+
+		const res = await renderRoute(matched, new Request("http://localhost/head-test"));
+		const html = await res.text();
+
+		const hydrateScript = html.indexOf("hydrate.js");
+		const headClosing = html.indexOf("</head>");
+		// hydrate.js should be in <head>
+		expect(hydrateScript).toBeGreaterThan(-1);
+		expect(hydrateScript).toBeLessThan(headClosing);
+	});
+
+	test("stream chunks arrive incrementally", async () => {
+		const matched = {
+			route: {
+				path: "/chunked",
+				params: {},
+				filePath:
+					"data:text/javascript,export default (p) => '<div>chunked</div>'",
+			},
+			params: {},
+		} as any;
+
+		const res = await renderRoute(matched, new Request("http://localhost/chunked"));
+		const reader = res.body!.getReader();
+		const chunks: string[] = [];
+
+		while (true) {
+			const { done, value } = await reader.read();
+			if (done) break;
+			// Bun ReadableStream returns Uint8Array
+			chunks.push(typeof value === "string" ? value : new TextDecoder().decode(value.buffer));
+		}
+
+		// Should have multiple chunks (at least DOCTYPE + body)
+		expect(chunks.length).toBeGreaterThan(1);
+		// First chunk should start with DOCTYPE
+		expect(chunks[0]).toContain("<!DOCTYPE html>");
+		// Last chunk should close the document
+		expect(chunks[chunks.length - 1]).toContain("</html>");
+	});
+
+	test("navigation request returns JSON not stream", async () => {
+		const matched = {
+			route: {
+				path: "/nav",
+				params: {},
+				filePath:
+					"data:text/javascript,export default (p) => '<div>nav</div>'",
+			},
+			params: {},
+		} as any;
+
+		const req = new Request("http://localhost/nav", {
+			headers: { "x-grimoire-navigate": "1" },
+		});
+		const res = await renderRoute(matched, req);
+		const json = await res.json();
+
+		expect(json.pattern).toBe("/nav");
+		expect(json.data).toBeDefined();
+	});
+});

package/test/typegen.test.ts

@@ -416,9 +416,9 @@ describe("generateTypes — route without +page.server.ts", () => {
 		expect(content).toContain("export type Actions = Record<string, never>;");
 	});
 
-	test("PageProps contains params", async () => {
+	test("PageProps contains data and params", async () => {
 		const content = await readGenerated("src/routes/blog");
-		expect(content).toContain("export type PageProps = { params: Params };");
+		expect(content).toContain("export type PageProps = { data: PageData; params: Params };");
 	});
 });
 
@@ -448,10 +448,10 @@ describe("generateTypes — route with +page.server.ts", () => {
 		expect(content).toContain('Awaited<ReturnType<_PS["load"]>>');
 	});
 
-	test("PageProps = PageData & { params: Params }", async () => {
+	test("PageProps = { data: PageData; params: Params }", async () => {
 		const content = await readGenerated("src/routes/blog/[slug]");
 		expect(content).toContain(
-			"export type PageProps = PageData & { params: Params };",
+			"export type PageProps = { data: PageData; params: Params };",
 		);
 	});
 
@@ -559,8 +559,8 @@ describe("tsc integration", () => {
 			join(routeDir, "check.ts"),
 			`import type { PageProps } from "./$types";
 declare const props: PageProps;
-const _title: string = props.post.title;
-const _views: number = props.post.views;
+const _title: string = props.data.post.title;
+const _views: number = props.data.post.views;
 const _slug: string = props.params.slug;
 export {};`,
 		);

package/.grimoire/_routes.dom.js

@@ -1,4 +0,0 @@
-
-export const routes = {
-
-};

package/.grimoire/_routes.hydrate.js

@@ -1,4 +0,0 @@
-
-export const routes = {
-
-};

package/.grimoire/compiled/0-C__Users_Cane1712_AppData_Local_Temp_grimoire-actions-1780503001657_protected__page.dom.js

@@ -1,9 +0,0 @@
-import { createSignal, createEffect, createMemo, reconcile, claim, claimText, claimComment, hydrateKeyedList, insert } from "@sigil-dev/runtime";
-export default function P() {
-  return (() => {
-    const _el0 = document.createElement("div");
-    _el0.classList.add("9i0yqs");
-    _el0.append(document.createTextNode("secret"));
-    return _el0;
-  })();
-}

package/.grimoire/compiled/0-C__Users_Cane1712_AppData_Local_Temp_grimoire-actions-1780503001657_protected__page.hydrate.js

@@ -1,11 +0,0 @@
-import { createSignal, createEffect, createMemo, reconcile, claim, claimText, claimComment, hydrateKeyedList, insert } from "@sigil-dev/runtime";
-export default function P() {
-  return (() => {
-    const _el0 = claim(__nodes, "div");
-    const _el1 = Array.from(_el0.childNodes);
-    _el0.classList.add("9i0yqs");
-    if (_el1.length === 0)
-      _el0.append(document.createTextNode("secret"));
-    return _el0;
-  })();
-}

package/.grimoire/compiled/0-C__Users_Cane1712_AppData_Local_Temp_grimoire-actions-1780503161592_protected__page.dom.js

@@ -1,4 +0,0 @@
-import { createSignal, createEffect, createMemo, reconcile, claim, claimText, claimComment, hydrateKeyedList, insert } from "@sigil-dev/runtime";
-export default function P() {
-  return "<div>secret</div>";
-}

package/.grimoire/compiled/0-C__Users_Cane1712_AppData_Local_Temp_grimoire-actions-1780503161592_protected__page.hydrate.js

@@ -1,4 +0,0 @@
-import { createSignal, createEffect, createMemo, reconcile, claim, claimText, claimComment, hydrateKeyedList, insert } from "@sigil-dev/runtime";
-export default function P() {
-  return "<div>secret</div>";
-}

package/.grimoire/compiled/0-C__Users_Cane1712_AppData_Local_Temp_grimoire-actions-1780503395872_login.dom.js

@@ -1,4 +0,0 @@
-import { createSignal, createEffect, createMemo, reconcile, claim, claimText, claimComment, hydrateKeyedList, insert } from "@sigil-dev/runtime";
-export default function Login() {
-  return "<form></form>";
-}

package/.grimoire/compiled/0-C__Users_Cane1712_AppData_Local_Temp_grimoire-actions-1780503395872_login.hydrate.js

@@ -1,4 +0,0 @@
-import { createSignal, createEffect, createMemo, reconcile, claim, claimText, claimComment, hydrateKeyedList, insert } from "@sigil-dev/runtime";
-export default function Login() {
-  return "<form></form>";
-}

package/.grimoire/compiled/0-C__Users_Cane1712_AppData_Local_Temp_grimoire-actions-1780503614350_login.dom.js

@@ -1,4 +0,0 @@
-import { createSignal, createEffect, createMemo, reconcile, claim, claimText, claimComment, hydrateKeyedList, insert } from "@sigil-dev/runtime";
-export default function Login() {
-  return "<form></form>";
-}

package/.grimoire/compiled/0-C__Users_Cane1712_AppData_Local_Temp_grimoire-actions-1780503614350_login.hydrate.js

@@ -1,4 +0,0 @@
-import { createSignal, createEffect, createMemo, reconcile, claim, claimText, claimComment, hydrateKeyedList, insert } from "@sigil-dev/runtime";
-export default function Login() {
-  return "<form></form>";
-}

package/.grimoire/compiled/1-C__Users_Cane1712_AppData_Local_Temp_grimoire-actions-1780503001657_login__page.dom.js

@@ -1,8 +0,0 @@
-import { createSignal, createEffect, createMemo, reconcile, claim, claimText, claimComment, hydrateKeyedList, insert } from "@sigil-dev/runtime";
-export default function Login() {
-  return (() => {
-    const _el0 = document.createElement("form");
-    _el0.classList.add("6ulz94");
-    return _el0;
-  })();
-}

package/.grimoire/compiled/1-C__Users_Cane1712_AppData_Local_Temp_grimoire-actions-1780503001657_login__page.hydrate.js

@@ -1,9 +0,0 @@
-import { createSignal, createEffect, createMemo, reconcile, claim, claimText, claimComment, hydrateKeyedList, insert } from "@sigil-dev/runtime";
-export default function Login() {
-  return (() => {
-    const _el0 = claim(__nodes, "form");
-    const _el1 = Array.from(_el0.childNodes);
-    _el0.classList.add("6ulz94");
-    return _el0;
-  })();
-}

package/.grimoire/compiled/1-C__Users_Cane1712_AppData_Local_Temp_grimoire-actions-1780503161592_login__page.dom.js

@@ -1,4 +0,0 @@
-import { createSignal, createEffect, createMemo, reconcile, claim, claimText, claimComment, hydrateKeyedList, insert } from "@sigil-dev/runtime";
-export default function Login() {
-  return "<form></form>";
-}

package/.grimoire/compiled/1-C__Users_Cane1712_AppData_Local_Temp_grimoire-actions-1780503161592_login__page.hydrate.js

@@ -1,4 +0,0 @@
-import { createSignal, createEffect, createMemo, reconcile, claim, claimText, claimComment, hydrateKeyedList, insert } from "@sigil-dev/runtime";
-export default function Login() {
-  return "<form></form>";
-}

package/.grimoire/compiled/1-C__Users_Cane1712_AppData_Local_Temp_grimoire-actions-1780503395872_protected.dom.js

@@ -1,4 +0,0 @@
-import { createSignal, createEffect, createMemo, reconcile, claim, claimText, claimComment, hydrateKeyedList, insert } from "@sigil-dev/runtime";
-export default function Protected() {
-  return "<div>secret</div>";
-}

package/.grimoire/compiled/1-C__Users_Cane1712_AppData_Local_Temp_grimoire-actions-1780503395872_protected.hydrate.js

@@ -1,4 +0,0 @@
-import { createSignal, createEffect, createMemo, reconcile, claim, claimText, claimComment, hydrateKeyedList, insert } from "@sigil-dev/runtime";
-export default function Protected() {
-  return "<div>secret</div>";
-}

package/.grimoire/compiled/1-C__Users_Cane1712_AppData_Local_Temp_grimoire-actions-1780503614350_protected.dom.js

@@ -1,4 +0,0 @@
-import { createSignal, createEffect, createMemo, reconcile, claim, claimText, claimComment, hydrateKeyedList, insert } from "@sigil-dev/runtime";
-export default function Protected() {
-  return "<div>secret</div>";
-}

package/.grimoire/compiled/1-C__Users_Cane1712_AppData_Local_Temp_grimoire-actions-1780503614350_protected.hydrate.js

@@ -1,4 +0,0 @@
-import { createSignal, createEffect, createMemo, reconcile, claim, claimText, claimComment, hydrateKeyedList, insert } from "@sigil-dev/runtime";
-export default function Protected() {
-  return "<div>secret</div>";
-}

package/.grimoire/tsconfig.generated.json

@@ -1,11 +0,0 @@
-{
-  "compilerOptions": {
-    "rootDirs": [
-      "..",
-      "./types"
-    ]
-  },
-  "include": [
-    "types/**/*.d.ts"
-  ]
-}

package/.grimoire/types/ambient.d.ts

@@ -1,6 +0,0 @@
-// Auto-generated by @sigil-dev/grimoire — do not edit
-
-declare namespace App {
-  // Extend this interface in your app's src/app.d.ts to add typed locals
-  interface Locals extends Record<string, unknown> {}
-}

package/.grimoire/types/api/hello/$types.d.ts

@@ -1,29 +0,0 @@
-// Auto-generated by @sigil-dev/grimoire — do not edit
-
-export type Params = {};
-
-export type PageData = Record<string, never>;
-export type PageProps = { params: Params };
-export type PageServerLoad = never;
-export type Actions = Record<string, never>;
-
-export type LayoutData = Record<string, never>;
-export type LayoutProps = LayoutData & { params: Params; children?: unknown };
-export type LayoutServerLoad = (ctx: {
-  params: Params;
-  request: Request;
-  url: URL;
-  locals: App.Locals;
-}) => Record<string, unknown> | Promise<Record<string, unknown>>;
-
-type _SRV = typeof import("C:/Users/Cane1712/AppData/Local/Temp/grimoire-server-1780504083027/api/hello/+server.js");
-type _HttpMethods = "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" | "OPTIONS";
-type _ServerKeys = Extract<keyof _SRV, _HttpMethods>;
-export type ServerHandlers = {
-  [K in _ServerKeys]: (ctx: {
-    params: Params;
-    request: Request;
-    url: URL;
-    locals: App.Locals;
-  }) => Response | Promise<Response>;
-};

package/.grimoire/types/api/items/$types.d.ts

@@ -1,29 +0,0 @@
-// Auto-generated by @sigil-dev/grimoire — do not edit
-
-export type Params = {};
-
-export type PageData = Record<string, never>;
-export type PageProps = { params: Params };
-export type PageServerLoad = never;
-export type Actions = Record<string, never>;
-
-export type LayoutData = Record<string, never>;
-export type LayoutProps = LayoutData & { params: Params; children?: unknown };
-export type LayoutServerLoad = (ctx: {
-  params: Params;
-  request: Request;
-  url: URL;
-  locals: App.Locals;
-}) => Record<string, unknown> | Promise<Record<string, unknown>>;
-
-type _SRV = typeof import("C:/Users/Cane1712/AppData/Local/Temp/grimoire-server-1780504083027/api/items/+server.js");
-type _HttpMethods = "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" | "OPTIONS";
-type _ServerKeys = Extract<keyof _SRV, _HttpMethods>;
-export type ServerHandlers = {
-  [K in _ServerKeys]: (ctx: {
-    params: Params;
-    request: Request;
-    url: URL;
-    locals: App.Locals;
-  }) => Response | Promise<Response>;
-};