@torpor/build 1.0.0 → 1.0.1

package/src/run/runPreview.ts

@@ -1,84 +0,0 @@
-import { configDotenv } from "dotenv";
-import { existsSync, promises as fs } from "node:fs";
-import path from "node:path";
-import { serverError } from "../response.ts";
-import Server from "../server/Server.ts";
-import contentType from "../server/contentType.ts";
-import Site from "../site/Site";
-import prepareTemplate from "./prepareTemplate.ts";
-import runBuild from "./runBuild";
-
-export default async function runPreview(site: Site): Promise<void> {
-	// Build the site
-	await runBuild(site);
-
-	const distFolder = path.resolve(site.root, "dist");
-	const clientFolder = path.join(distFolder, "client");
-	const serverFolder = path.join(distFolder, "server");
-
-	// Read site.html if present, and find the client script file in /assets.
-	// An endpoints-only site has no site.html, and no template is needed
-	let template: string | undefined;
-	const siteHtml = path.join(clientFolder, "site.html");
-	if (existsSync(siteHtml)) {
-		let clientScript = (await fs.readdir(path.join(clientFolder, "assets"))).find((f) =>
-			f.startsWith("clientEntry-"),
-		);
-		if (!clientScript) {
-			throw new Error("clientEntry.js not found");
-		}
-		clientScript = `/assets/${clientScript}`;
-
-		template = await fs.readFile(siteHtml, "utf-8");
-
-		// Prepare site.html so that we can just splice components into it
-		template = prepareTemplate(template, clientScript);
-	}
-
-	// Configure the server
-	const server = new Server();
-
-	// Serve dist/client/assets statically
-	server.add("/assets/*", async (ev) => {
-		try {
-			const url = new URL(ev.request.url);
-			const file = path.join(site.root, "dist", "client", url.pathname);
-			if (existsSync(file)) {
-				const body = await fs.readFile(file);
-				return new Response(body, {
-					status: 200,
-					headers: {
-						"Content-Type": contentType(path.extname(file)),
-					},
-				});
-			}
-		} catch (e: any) {
-			return serverError(e);
-		}
-	});
-
-	// Every request (GET, POST, etc) goes through loadEndPoint
-	const serverScript = path.resolve(serverFolder, "serverEntry.js");
-	server.add("*", async (ev) => {
-		try {
-			// Load the server entry
-			const { load } = await import(serverScript);
-
-			// Render the app HTML (or fetch server data etc) via serverEntry's
-			// exported `load` function
-			return await load(ev, template);
-		} catch (e: any) {
-			return serverError(e);
-		}
-	});
-
-	// Load environment variables from a `.env` file, with defaults if not set
-	configDotenv();
-
-	process.env.PROTOCOL ??= "http:";
-	process.env.HOST ??= "localhost";
-	process.env.PORT ??= "7059";
-
-	// Serve the site
-	site.adapter.serve(server, site);
-}

package/src/run/staleTorpCopies.ts

@@ -1,100 +0,0 @@
-import { existsSync, readFileSync, readdirSync } from "node:fs";
-import path from "node:path";
-import type { PackageJson } from "../utils/torporPackages";
-import { findWorkspaceRoot, workspaceDependencyDirs } from "./depCache";
-
-/**
- * Workspace packages that ship copies of their .torp components (e.g.
- * @torpor/ui copies its src .torp files into dist/ during its build) can go
- * stale: a site resolves the package to its dist folder, so edits to src
- * silently keep serving the OLD components until the package is rebuilt.
- * The symptom is confusing -- e.g. a TypeError about a renamed slot prop
- * after a component's API changed.
- *
- * reportStaleTorpCopies runs at `tb --dev` startup: for every workspace
- * dependency with both src and dist folders, it compares the .torp files and
- * reports anything missing from dist, differing from src, or left over in
- * dist without a src file.
- */
-
-/**
- * Reports stale dist .torp copies in the site's workspace dependencies.
- * Never throws -- a broken check must not break dev startup.
- */
-export function reportStaleTorpCopies(siteRoot: string, log?: (message: string) => void): void {
-	try {
-		const workspaceRoot = findWorkspaceRoot(siteRoot);
-		if (!workspaceRoot) return;
-
-		for (const dir of workspaceDependencyDirs(siteRoot, workspaceRoot)) {
-			const srcFolder = path.join(dir, "src");
-			const distFolder = path.join(dir, "dist");
-			// Only packages that ship dist copies of src .torp files are
-			// checked; packages without the folders (or with neither .torp
-			// set) are skipped
-			if (!existsSync(srcFolder) || !existsSync(distFolder)) continue;
-			const src = collectTorpFiles(srcFolder);
-			const dist = collectTorpFiles(distFolder);
-			if (src.size === 0 && dist.size === 0) continue;
-
-			const problems: string[] = [];
-			for (const [rel, content] of src) {
-				const distContent = dist.get(rel);
-				if (distContent === undefined) {
-					problems.push(`${rel} (not copied to dist)`);
-				} else if (distContent !== content) {
-					problems.push(`${rel} (differs from src)`);
-				}
-			}
-			for (const rel of dist.keys()) {
-				if (!src.has(rel)) {
-					problems.push(`${rel} (left over in dist, no src file)`);
-				}
-			}
-			if (problems.length === 0) continue;
-
-			const shown = problems
-				.slice(0, 5)
-				.map((p) => `  ${p}`)
-				.join("\n");
-			const more = problems.length > 5 ? `\n  ... and ${problems.length - 5} more` : "";
-			log?.(
-				`${packageLabel(dir, workspaceRoot)}'s dist .torp copies are stale, so the site is ` +
-					`serving OLD components:\n${shown}${more}\n` +
-					`Rebuild the package (e.g. \`pnpm build\` in ` +
-					`${path.relative(workspaceRoot, dir) || "."}) and restart \`tb --dev\`.`,
-			);
-		}
-	} catch (e) {
-		if (process.env.TORPOR_DEBUG_CACHE) throw e;
-	}
-}
-
-function collectTorpFiles(folder: string): Map<string, string> {
-	const files = new Map<string, string>();
-	collect(folder, folder, files);
-	return files;
-}
-
-function collect(folder: string, root: string, files: Map<string, string>): void {
-	for (const entry of readdirSync(folder, { withFileTypes: true })) {
-		if (entry.name === "node_modules" || entry.name === ".git") continue;
-		const full = path.join(folder, entry.name);
-		if (entry.isDirectory()) {
-			collect(full, root, files);
-			continue;
-		}
-		if (!entry.isFile() || !entry.name.endsWith(".torp")) continue;
-		files.set(path.relative(root, full).replaceAll("\\", "/"), readFileSync(full, "utf8"));
-	}
-}
-
-function packageLabel(dir: string, workspaceRoot: string): string {
-	try {
-		const pkg: PackageJson = JSON.parse(readFileSync(path.join(dir, "package.json"), "utf8"));
-		if (pkg.name) return pkg.name;
-	} catch {
-		// Fall through to the relative path
-	}
-	return path.relative(workspaceRoot, dir) || dir;
-}

package/src/run.ts

@@ -1,7 +0,0 @@
-import run from "./run/run";
-import runBuild from "./run/runBuild";
-import runDev from "./run/runDev";
-import runOpenApi from "./run/runOpenApi";
-import runPreview from "./run/runPreview";
-
-export { run, runDev, runBuild, runPreview, runOpenApi };

package/src/schema.ts

@@ -1,7 +0,0 @@
-import validate from "./validation/validate";
-
-export { validate };
-
-export { default as ValidationError } from "./validation/ValidationError";
-
-export type { StandardSchemaV1 } from "./types/StandardSchema";

package/src/server/CookieHelper.ts

@@ -1,46 +0,0 @@
-import { type SerializeOptions, parseCookie, stringifySetCookie } from "cookie";
-
-export default class CookieHelper {
-	request: Request;
-	cookies: Map<string, string> = new Map();
-
-	constructor(request: Request) {
-		this.request = request;
-	}
-
-	get(name: string): string | undefined {
-		// If it's been set, return the value from the map
-		if (this.cookies.has(name)) {
-			// The stored value is a serialized Set-Cookie header; pull the
-			// "name=value" prefix off and re-parse to get just the value
-			return parseCookie(this.cookies.get(name)!)[name];
-		}
-
-		// Otherwise, return the value from the `cookie` header
-		const header = this.request.headers.get("Cookie");
-		return parseCookie(header ?? "")[name];
-	}
-
-	set(name: string, value: string, options?: SerializeOptions): void {
-		// Set a cookie header with some default values for security
-		options ??= {};
-		options.httpOnly ??= true;
-		options.secure ??= true;
-		options.sameSite ??= "lax";
-
-		this.cookies.set(name, stringifySetCookie({ name, value, ...options }));
-	}
-
-	delete(name: string, options?: SerializeOptions): void {
-		// Set a cookie header with an empty value and an immediate expiry date.
-		// Apply the same secure defaults as `set` so a previously-set Secure
-		// cookie is actually overridden by the deletion.
-		options ??= {};
-		options.httpOnly ??= true;
-		options.secure ??= true;
-		options.sameSite ??= "lax";
-		options.expires = new Date(0);
-
-		this.cookies.set(name, stringifySetCookie({ name, value: "", ...options }));
-	}
-}

package/src/server/HeaderHelper.ts

@@ -1,25 +0,0 @@
-export default class HeaderHelper {
-	request: Request;
-	headers: Map<string, string> = new Map();
-
-	constructor(request: Request) {
-		this.request = request;
-	}
-
-	get(name: string): string | undefined {
-		// If it's been set, return the updated value
-		if (this.headers.has(name)) {
-			return this.headers.get(name);
-		}
-		// Otherwise, return the value from the header
-		return this.request.headers.get(name) ?? undefined;
-	}
-
-	set(name: string, value: string): void {
-		this.headers.set(name, value);
-	}
-
-	delete(name: string): void {
-		this.headers.delete(name);
-	}
-}

package/src/server/Server.ts

@@ -1,168 +0,0 @@
-import PathTrie from "../utils/pathTrie";
-import ServerEvent from "./ServerEvent";
-import type MiddlewareFunction from "./types/MiddlewareFunction";
-import type ServerFunction from "./types/ServerFunction";
-
-/**
- * A Fetch API Request/Response server.
- */
-export default class Server {
-	// TODO: We don't use any of the routes, just add("*") in runDev/runBuild...
-	routes: RouteHandler[] = [];
-	// Match index for the routes above
-	#trie = new PathTrie<RouteHandler>();
-	// TODO: We only use the Vite middleware here
-	middleware: MiddlewareFunction[] = [];
-
-	constructor() {
-		this.routes = [];
-		this.middleware = [];
-	}
-
-	/**
-	 * The standard Fetch API method that should work in any runtime (including
-	 * Node with polyfills).
-	 * @returns
-	 */
-	fetch = async (input: RequestInfo | URL, init?: RequestInit): Promise<Response> => {
-		// Use the request as-is when we were given one, so that the adapter
-		// doesn't pay for constructing it twice
-		const request = input instanceof Request && !init ? input : new Request(input, init);
-		const url = new URL(request.url);
-		const match = this.match(url.pathname);
-		let ev = new ServerEvent(request, match?.params, url);
-
-		if (this.middleware.length) {
-			// TODO: Get middleware that applies to this route only?
-			let entered = 0;
-			let response: Response | undefined = undefined;
-			let error: unknown = undefined;
-			try {
-				for (; entered < this.middleware.length && !response; entered++) {
-					// A middleware returns a Response to short-circuit the request
-					const result = await this.middleware[entered].enter?.(ev);
-					if (result) {
-						response = result;
-					}
-				}
-				if (!response && match) {
-					const result = await match.fn(ev);
-					if (result) {
-						response = result;
-					}
-				}
-			} catch (e) {
-				// Exits can handle the error by returning a Response; if none
-				// does, it is rethrown below
-				error = e;
-				ev.error = e;
-			} finally {
-				if (response) {
-					ev.response = response;
-				}
-				// Run exit hooks in reverse order for the middleware that were
-				// entered. An exit hook can return a Response to replace the
-				// response, or to handle ev.error
-				while (entered > 0) {
-					entered--;
-					const result = await this.middleware[entered].exit?.(ev);
-					if (result) {
-						response = result;
-						ev.response = result;
-					}
-				}
-			}
-			if (error && !response) {
-				throw error;
-			}
-		} else if (match) {
-			ev.response = await match.fn(ev);
-		} else {
-			return new Response(null, { status: 404 });
-		}
-
-		// TODO: Should I be returning 200 if there's no response? Because it's not an error??
-		ev.response ??= new Response(null, { status: 200 });
-		ev.addHeaders();
-
-		return ev.response;
-	};
-
-	/**
-	 * Adds a server function at a route path.
-	 * @param path The route path pattern.
-	 * @param fn The function to call when the pattern is matched.
-	 * @returns
-	 */
-	add(path: string, fn: ServerFunction): Server {
-		let handler = new RouteHandler(path, fn);
-		this.routes.push(handler);
-		this.#trie.insert(path, handler);
-		this.#sortRoutes();
-		return this;
-	}
-
-	match(path: string): Match | undefined {
-		const found = this.#trie.match(path);
-		if (found) {
-			return {
-				fn: found.value.fn,
-				params: found.params,
-			};
-		}
-		console.log(`Server path not found: ${path}`);
-	}
-
-	// TODO:
-	//use(path: string, ...fn: MiddlewareFunction[])
-	use(...fn: MiddlewareFunction[]): Server {
-		this.middleware = this.middleware.concat(fn);
-		return this;
-	}
-
-	#sortRoutes() {
-		this.routes = this.routes.sort((a, b) => {
-			// Sort [param]s after paths
-			// There might be a quicker/easier way to do this
-			for (let i = 0; i < Math.min(a.path.length, b.path.length); i++) {
-				if (a.path[i] === "[" && b.path[i] !== "[") {
-					return 1;
-				} else if (b.path[i] === "[" && a.path[i] !== "[") {
-					return -1;
-				} else if (a.path[i] === b.path[i]) {
-					// Keep going...
-				} else {
-					return a.path[i].localeCompare(b.path[i]);
-				}
-			}
-			return a.path.length - b.path.length;
-		});
-	}
-}
-
-class RouteHandler {
-	path: string;
-	fn: ServerFunction;
-
-	constructor(path: string, fn: ServerFunction) {
-		this.path = path;
-		this.fn = fn;
-	}
-}
-
-//class MiddlewareHandler {
-//	path: string;
-//	regex: RegExp;
-//	fn: MiddlewareFunction;
-//
-//	constructor(path: string, fn: MiddlewareFunction) {
-//		this.path = path;
-//		this.regex = pathToRegex(path);
-//		this.fn = fn;
-//	}
-//}
-
-interface Match {
-	fn: ServerFunction;
-	params?: Record<string, string>;
-}

package/src/server/ServerEvent.ts

@@ -1,62 +0,0 @@
-import CookieHelper from "./CookieHelper";
-import HeaderHelper from "./HeaderHelper";
-
-export default class ServerEvent {
-	request: Request;
-	response: Response | undefined | void;
-	/**
-	 * Set when the route handler (or a middleware enter hook) threw an
-	 * error. Exit hooks can return a Response to handle it; if none does,
-	 * the error is rethrown to the caller.
-	 */
-	error: unknown;
-	// TODO: Should we cast types??
-	params?: Record<string, string>;
-
-	adapter: any;
-
-	cookies: CookieHelper;
-	headers: HeaderHelper;
-
-	// Parsed once per request; Server.fetch passes the URL it already needed
-	// for matching so it isn't parsed twice
-	#url: URL | undefined;
-
-	/** The request URL, parsed lazily. */
-	get url(): URL {
-		return (this.#url ??= new URL(this.request.url));
-	}
-
-	constructor(request: Request, params?: Record<string, string>, url?: URL) {
-		this.request = request;
-		this.params = params;
-		this.#url = url;
-		this.cookies = new CookieHelper(request);
-		this.headers = new HeaderHelper(request);
-
-		// Adapters may have added the `adapter` property to globalThis
-		// @ts-ignore
-		this.adapter = globalThis.adapter;
-	}
-
-	addHeaders(): void {
-		if (!this.response) {
-			throw new Error("Response not created yet");
-		}
-
-		for (let cookie of this.cookies.cookies.values()) {
-			this.response.headers.append("set-cookie", cookie);
-		}
-
-		for (let header of this.headers.headers.entries()) {
-			this.response.headers.append(header[0], header[1]);
-		}
-	}
-
-	/**
-	 * Reads the request body as JSON.
-	 */
-	json(): Promise<unknown> {
-		return this.request.json();
-	}
-}

package/src/server/connect/connectMiddleware.ts

@@ -1,85 +0,0 @@
-import { IncomingMessage, ServerResponse } from "node:http";
-import { Readable } from "node:stream";
-import type MiddlewareFunction from "../types/MiddlewareFunction";
-import flattenHeaders from "./flattenHeaders";
-import nodeMessageToNodeResponse from "./nodeMessageToNodeResponse";
-import requestToNodeMessage from "./requestToNodeMessage";
-
-// From https://github.com/vikejs/vike-node/blob/main/packages/vike-node/src/runtime/adapters/connectToWeb.ts
-
-/**
- * Converts a Connect-style middleware to a torpor middleware.
- *
- * If the Connect handler writes a response, it is returned from the `enter`
- * hook and the middleware chain is short-circuited. If the handler calls
- * `next()`, the rest of the chain runs after this middleware completes.
- *
- * @param handler - The Connect-style middleware function to be converted.
- * @returns A middleware whose `enter` hook handles the web request.
- */
-export default function connectMiddleware(
-	handler: ConnectMiddleware | ConnectMiddlewareBoolean,
-): MiddlewareFunction {
-	return {
-		enter: (ev) =>
-			new Promise<Response | void>((resolve, reject) => {
-				const req = requestToNodeMessage(ev.request);
-				const { res, onReadable } = nodeMessageToNodeResponse(req);
-
-				onReadable(({ readable, headers, status }) => {
-					const responseBody: ReadableStream | null = statusCodesWithoutBody.includes(status)
-						? null
-						: (Readable.toWeb(readable) as unknown as ReadableStream);
-					resolve(
-						new Response(responseBody, {
-							status,
-							headers: flattenHeaders(headers),
-						}),
-					);
-				});
-
-				const cnext = (error?: unknown) => {
-					if (error) {
-						// eslint-disable-next-line no-base-to-string
-						reject(error instanceof Error ? error : new Error(String(error)));
-					} else {
-						// The Connect handler is passing the request on
-						resolve();
-					}
-				};
-
-				Promise.resolve(handler(req, res, cnext))
-					.then((handled) => {
-						if (handled === false) {
-							res.destroy();
-							// Returning false signals that the request was handled,
-							// so return an empty response to stop the chain
-							resolve(new Response(null, { status: 200 }));
-						}
-					})
-					.catch((e: unknown) => {
-						cnext(e);
-					});
-			}),
-	};
-}
-
-const statusCodesWithoutBody = [
-	100, // Continue
-	101, // Switching Protocols
-	102, // Processing (WebDAV)
-	103, // Early Hints
-	204, // No Content
-	205, // Reset Content
-	304, // Not Modified
-];
-
-type NextFunction = (err?: unknown) => void;
-type ConnectMiddleware<
-	PlatformRequest extends IncomingMessage = IncomingMessage,
-	PlatformResponse extends ServerResponse = ServerResponse,
-> = (req: PlatformRequest, res: PlatformResponse, next: NextFunction) => void | Promise<void>;
-type ConnectMiddlewareBoolean<
-	PlatformRequest extends IncomingMessage = IncomingMessage,
-	PlatformResponse extends ServerResponse = ServerResponse,
-> = (req: PlatformRequest, res: PlatformResponse, next: NextFunction) => boolean | Promise<boolean>;

package/src/server/connect/flattenHeaders.ts

@@ -1,22 +0,0 @@
-import { IncomingHttpHeaders } from "node:http";
-import { OutgoingHttpHeaders } from "node:http2";
-
-export default function flattenHeaders(
-	headers: IncomingHttpHeaders | OutgoingHttpHeaders,
-): HeadersInit {
-	const flatHeaders = new Headers();
-	for (const [key, value] of Object.entries(headers)) {
-		if (value === undefined || value === null) {
-			continue;
-		} else if (Array.isArray(value)) {
-			for (const v of value) {
-				if (v !== undefined && v !== null) {
-					flatHeaders.append(key, String(v));
-				}
-			}
-		} else {
-			flatHeaders.set(key, String(value));
-		}
-	}
-	return flatHeaders;
-}