@torpor/build 0.4.14 → 1.0.1

package/src/run/prepareTemplate.ts

@@ -1,39 +0,0 @@
-export default function prepareTemplate(
-	template: string,
-	clientScript: string,
-	clientDevScript?: string,
-): string {
-	let result = template;
-
-	// Put %COMPONENT_HEAD% before </head>
-	// This is where styles will go
-	let headStart = result.indexOf("</head>");
-	if (headStart === -1) {
-		throw new Error(`Couldn't find <head> end tag`);
-	}
-	result = result.substring(0, headStart) + "%COMPONENT_HEAD%" + result.substring(headStart);
-
-	// Put %COMPONENT_BODY% inside <div id="app"></div>
-	// This is where the component's HTML will go
-	let bodyStart = regexIndexOf(result, /<div\s+id=("app"|'app'|app)\s+/);
-	bodyStart = result.indexOf(">", bodyStart) + 1;
-	let bodyEnd = result.indexOf("</div>", bodyStart);
-	if (bodyStart === -1 || bodyEnd === -1) {
-		throw new Error(`Couldn't find <div id="app"></div>`);
-	}
-	result = result.substring(0, bodyStart) + "%COMPONENT_BODY%" + result.substring(bodyEnd);
-
-	// Add the clientEntry script at the very end, for hydrating and navigating
-	if (clientDevScript) {
-		result += `<script type="module" src="${clientDevScript}"></script>`;
-	}
-	result += `<script type="module" src="${clientScript}"></script>`;
-
-	return result;
-}
-
-// From https://stackoverflow.com/a/274094
-function regexIndexOf(string: string, regex: RegExp, position?: number) {
-	var indexOf = string.substring(position || 0).search(regex);
-	return indexOf >= 0 ? indexOf + (position || 0) : indexOf;
-}

package/src/run/run.ts

@@ -1,62 +0,0 @@
-import fs from "node:fs";
-import path from "node:path";
-import { transformWithEsbuild } from "vite";
-import Site from "../site/Site";
-import runBuild from "./runBuild";
-import runDev from "./runDev";
-import runPreview from "./runPreview";
-
-export default async function run(
-	folder: string,
-	mode: "dev" | "build" | "preview",
-): Promise<void> {
-	// Look for and load a site.config.js/ts file in the working directory
-	let configFile = "";
-	let deleteConfigFile = false;
-	const jsConfigFile = path.join(folder, "site.config.js");
-	const tsConfigFile = path.join(folder, "site.config.ts");
-	if (fs.existsSync(jsConfigFile)) {
-		// If it's JS, we can just import it straight up
-		configFile = jsConfigFile;
-	} else if (fs.existsSync(tsConfigFile)) {
-		// If it's TS, we need to convert it to JS
-		// TODO: Put the generated file somewhere better (dist?)
-		configFile = path.join(folder, "site.config.temp.js");
-		let source = fs.readFileSync(tsConfigFile, "utf-8");
-		let transformed = await transformWithEsbuild(source, tsConfigFile, {
-			loader: "ts",
-		});
-		fs.writeFileSync(configFile, transformed.code);
-		deleteConfigFile = true;
-	} else {
-		throw new Error("site.config file not found");
-	}
-
-	const site = (await import(configFile)).default as Site;
-	if (!site || !site.root || !site.routes) {
-		throw new Error("Invalid site in config file");
-	}
-	if (deleteConfigFile) {
-		fs.rmSync(configFile);
-	}
-
-	switch (mode) {
-		case "dev": {
-			await runDev(site);
-			break;
-		}
-		case "build": {
-			await runBuild(site);
-			break;
-		}
-		case "preview": {
-			await runPreview(site);
-			break;
-		}
-		default: {
-			console.log("No mode passed, running in dev");
-			await runDev(site);
-			break;
-		}
-	}
-}

package/src/run/runBuild.ts

@@ -1,77 +0,0 @@
-import torpor from "@torpor/unplugin/vite";
-import { existsSync, promises as fs } from "node:fs";
-import path from "node:path";
-import { build, defineConfig } from "vite";
-import Site from "../site/Site";
-import manifest from "../site/manifest.ts";
-
-// TODO: Don't cache index.html in dev?
-// TODO: Multiple hook.server locations
-// TODO: Don't reload layouts during client routing
-// TODO: Call the correct +page and +server routes when in the same folder
-
-export default async function runBuild(site: Site): Promise<void> {
-	// Delete the dist folder if it exists
-	const distFolder = path.resolve(site.root, "dist");
-	if (existsSync(distFolder)) {
-		await fs.rm(distFolder, { recursive: true });
-	}
-	const clientFolder = path.join(distFolder, "client");
-	const serverFolder = path.join(distFolder, "server");
-
-	// HOOK: Prebuild
-	if (site.adapter.prebuild) {
-		await site.adapter.prebuild(site);
-	}
-
-	// TODO: From a setting
-	let siteHtml = path.resolve(site.root, "src/site.html");
-
-	const siteFolder = path.resolve(site.root, "./node_modules/@torpor/build/src/site/");
-	let clientScript = path.join(siteFolder, "clientEntry.ts");
-	let serverScript = path.join(siteFolder, "serverEntry.ts");
-
-	// Build the client assets, including site.html and the route files
-	// EXCLUDING anything with `server.js` in the name
-	const clientConfig = structuredClone(site.viteConfig ?? {});
-	clientConfig.plugins = [manifest(site), torpor(), ...site.plugins];
-	clientConfig.build ??= {};
-	clientConfig.build.outDir = clientFolder;
-	clientConfig.build.rollupOptions ??= {};
-	clientConfig.build.rollupOptions.input = [
-		siteHtml,
-		clientScript,
-		...site.routes
-			.filter((r) => !/server\.(ts|js)$/.test(r.file))
-			.map((r) => path.resolve(site.root, r.file)),
-		...site.inputs.filter((f) => !/server\.(ts|js)$/.test(f)),
-	];
-	clientConfig.build.ssrManifest = true;
-	await build(defineConfig(clientConfig));
-
-	// Build the server assets, including the server entry script and the route
-	// files
-	const serverConfig = structuredClone(site.viteConfig ?? {});
-	serverConfig.plugins = [manifest(site, true), torpor(), ...site.plugins];
-	serverConfig.build ??= {};
-	serverConfig.build.outDir = serverFolder;
-	serverConfig.build.rollupOptions ??= {};
-	serverConfig.build.rollupOptions.input = [
-		serverScript,
-		...site.routes.map((r) => path.resolve(site.root, r.file)),
-		...site.inputs,
-	];
-	serverConfig.build.ssr = serverScript;
-	await build(defineConfig(serverConfig));
-
-	// Move the site.html file into /client
-	// HACK: Should do this in Rollup if possible?
-	siteHtml = path.join(clientFolder, "site.html");
-	await fs.rename(path.join(clientFolder, "src", "site.html"), siteHtml);
-	await fs.rm(path.join(clientFolder, "src"), { recursive: true });
-
-	// HOOK: Postbuild
-	if (site.adapter.postbuild) {
-		await site.adapter.postbuild(site);
-	}
-}

package/src/run/runDev.ts

@@ -1,89 +0,0 @@
-import estorpor from "@torpor/unplugin/esbuild";
-import torpor from "@torpor/unplugin/vite";
-import { configDotenv } from "dotenv";
-import { promises as fs } from "node:fs";
-import path from "node:path";
-import { createServer as createViteServer } from "vite";
-import { serverError } from "../response.ts";
-import Server from "../server/Server.ts";
-import connectMiddleware from "../server/connect/connectMiddleware.ts";
-import Site from "../site/Site.ts";
-import manifest from "../site/manifest.ts";
-import prepareTemplate from "./prepareTemplate.ts";
-
-export default async function runDev(site: Site): Promise<void> {
-	const server = new Server();
-
-	// Create the Vite server in middleware mode and configure the app type as
-	// "custom", disabling Vite's own HTML serving logic so the parent server
-	// can take control
-	const config = structuredClone(site.viteConfig ?? {});
-	config.server = { middlewareMode: true };
-	config.appType = "custom";
-	config.plugins = [manifest(site, true), torpor({ dev: true }), ...site.plugins];
-
-	// HACK: To be able to import `.torp` files from barrel files in
-	// node_modules, we need to add their libraries to `ssr.noExternal` in
-	// site.config.ts, and let esbuild know how to compile them here
-	config.optimizeDeps ??= {};
-	config.optimizeDeps.extensions ??= [];
-	config.optimizeDeps.extensions.push(".torp");
-	config.optimizeDeps.esbuildOptions ??= {};
-	config.optimizeDeps.esbuildOptions.plugins ??= [];
-	config.optimizeDeps.esbuildOptions.plugins.push(estorpor());
-
-	const vite = await createViteServer(config);
-
-	// Read site.html
-	// It's called site.html because @torpor/build builds the site (html, routes
-	// etc) while the user builds the app (components etc)
-	const templateFile = path.resolve(site.root, "src/site.html");
-	let template = await fs.readFile(templateFile, "utf-8");
-
-	// Apply Vite HTML transforms. This injects the Vite HMR client, and also
-	// applies HTML transforms from Vite plugins. Note that we only support a
-	// universal transform, not individual transforms for each route
-	template = await vite.transformIndexHtml("", template);
-
-	const siteFolder = path.resolve(site.root, "./node_modules/@torpor/build/src/site/");
-	let clientScript = path.join(siteFolder, "clientEntry.ts");
-	let clientDevScript = path.join(siteFolder, "clientEntryDev.ts");
-	let serverScript = path.join(siteFolder, "serverEntry.ts");
-
-	// Prepare site.html so that we can just splice components into it
-	template = prepareTemplate(template, clientScript, clientDevScript);
-
-	// Use Vite's Connect instance as middleware. We need to wrap it with
-	// createMiddlewareHandler that converts Connect middleware to
-	// Request/Response web handlers
-	server.use(connectMiddleware(vite.middlewares));
-
-	// Every request (GET, POST, etc) goes through loadEndPoint
-	server.add("*", async (ev) => {
-		try {
-			// Load the server entry. ssrLoadModule automatically transforms ESM
-			// source code to be usable in Node.js. No bundling is required, and
-			// it provides efficient invalidation similar to HMR
-			const { load } = await vite.ssrLoadModule(serverScript);
-
-			// Render the app HTML (or fetch server data etc) via serverEntry's
-			// exported `load` function
-			return await load(ev, template);
-		} catch (e: any) {
-			// If an error is caught, let Vite fix the stack trace so it maps
-			// back to your actual source code
-			vite.ssrFixStacktrace(e);
-			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/runPreview.ts

@@ -1,93 +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");
-
-	// Find the client script file in /assets
-	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}`;
-
-	// Read site.html
-	// It's called site.html because @torpor/build builds the site (html, routes
-	// etc) while the user builds the app (components etc)
-	let siteHtml = path.join(clientFolder, "site.html");
-	let 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)) {
-				// TODO: Stream the data?
-				const body = bufferToArrayBuffer(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);
-}
-
-// From https://stackoverflow.com/a/79345620
-// No idea why it is needed
-function bufferToArrayBuffer(buffer: Buffer): ArrayBuffer {
-	return buffer.buffer.slice(
-		buffer.byteOffset,
-		buffer.byteOffset + buffer.byteLength,
-	) as ArrayBuffer;
-}

package/src/run.ts

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

package/src/server/CookieHelper.ts

@@ -1,36 +0,0 @@
-import { SerializeOptions, parse, serialize } 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)) {
-			return parse(this.cookies.get(name)!)[name];
-		}
-		// Otherwise, return the value from the `cookie` header
-		const header = this.request.headers.get("cookie");
-		return parse(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, serialize(name, value, options));
-	}
-
-	delete(name: string, options?: SerializeOptions): void {
-		// Set a cookie header with an immediate expiry date
-		options ??= {};
-		options.expires = new Date(0);
-		this.cookies.set(name, serialize(name, "", 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/Routerx.ts

@@ -1,72 +0,0 @@
-import pathToRegex from "../utils/pathToRegex";
-import type HttpMethod from "./types/HttpMethod";
-import type MiddlewareFunction from "./types/MiddlewareFunction";
-import type ServerFunction from "./types/ServerFunction";
-
-// This is not actually used anywhere, for now at least
-
-export default class Router {
-	methods: Map<HttpMethod, RouteHandler[]> = new Map<HttpMethod, RouteHandler[]>();
-	middleware: MiddlewareHandler[] = [];
-
-	constructor() {
-		// Create all method handlers up front so we don't have to worry about
-		// checking if they exist. Using a non-standard method will just error
-		this.methods.set("GET", []);
-		this.methods.set("HEAD", []);
-		this.methods.set("PATCH", []);
-		this.methods.set("POST", []);
-		this.methods.set("PUT", []);
-		this.methods.set("DELETE", []);
-		this.methods.set("OPTIONS", []);
-		this.methods.set("CONNECT", []);
-		this.methods.set("TRACE", []);
-	}
-
-	add(method: HttpMethod, path: string, fn: ServerFunction): Router {
-		this.methods.get(method)!.push(new RouteHandler(path, fn));
-		return this;
-	}
-
-	match(method: HttpMethod, path: string): Match | undefined {
-		for (let handler of this.methods.get(method)!) {
-			let match = path.match(handler.regex);
-			if (match) {
-				console.log("found", handler);
-				return {
-					fn: handler.fn,
-					params: match.groups,
-				};
-			}
-		}
-	}
-}
-
-class RouteHandler {
-	path: string;
-	regex: RegExp;
-	fn: ServerFunction;
-
-	constructor(path: string, fn: ServerFunction) {
-		this.path = path;
-		this.regex = pathToRegex(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/Server.ts

@@ -1,144 +0,0 @@
-import pathToRegex from "../utils/pathToRegex";
-import ServerEvent from "./ServerEvent";
-import type MiddlewareFunction from "./types/MiddlewareFunction";
-import type ServerFunction from "./types/ServerFunction";
-
-const noop = () => {};
-
-/**
- * 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[] = [];
-	// 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> => {
-		const request = new Request(input, init);
-		const url = new URL(request.url);
-		const match = this.match(url.pathname);
-		let ev = new ServerEvent(request, match?.params);
-
-		if (this.middleware.length) {
-			// TODO: Get middleware that applies to this route only?
-			await this.middleware[0](ev, buildNext(this.middleware, 0));
-			function buildNext(middleware: MiddlewareFunction[], i: number): () => void | Promise<void> {
-				if (ev.response) {
-					return noop;
-				}
-
-				if (i < middleware.length - 1) {
-					let next = middleware[i + 1];
-					return async () => next(ev, buildNext(middleware, i + 1));
-				} else {
-					return match
-						? async () => {
-								ev.response = await match.fn(ev);
-							}
-						: noop;
-				}
-			}
-		} 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 {
-		this.routes.push(new RouteHandler(path, fn));
-		this.#sortRoutes();
-		return this;
-	}
-
-	match(path: string): Match | undefined {
-		for (let handler of this.routes) {
-			let match = path.match(handler.regex);
-			if (match) {
-				return {
-					fn: handler.fn,
-					params: match.groups,
-				};
-			}
-		}
-		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;
-	regex: RegExp;
-	fn: ServerFunction;
-
-	constructor(path: string, fn: ServerFunction) {
-		this.path = path;
-		this.regex = pathToRegex(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,39 +0,0 @@
-import CookieHelper from "./CookieHelper";
-import HeaderHelper from "./HeaderHelper";
-
-export default class ServerEvent {
-	request: Request;
-	response: Response | undefined | void;
-	// TODO: Should we cast types??
-	params?: Record<string, string>;
-
-	adapter: any;
-
-	cookies: CookieHelper;
-	headers: HeaderHelper;
-
-	constructor(request: Request, params?: Record<string, string>) {
-		this.request = request;
-		this.params = params;
-		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]);
-		}
-	}
-}