@torpor/build 0.1.34 → 0.3.0

package/src/response/serverError.ts

@@ -3,9 +3,21 @@ import response from "./response";
 /**
  * 500 Server Error
  *
- * The server has encountered a situation it does not know how to handle.
+ * The HTTP 500 Internal Server Error server error response status code
+ * indicates that the server encountered an unexpected condition that prevented
+ * it from fulfilling the request. This error is a generic "catch-all" response
+ * to server issues, indicating that the server cannot find a more appropriate
+ * 5XX error to respond with.
  *
- * See https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500
+ * If you're a visitor seeing 500 errors on a web page, these issues require
+ * investigation by server owners or administrators. There are many possible
+ * causes of 500 errors, including: improper server configuration, out-of-memory
+ * (OOM) issues, unhandled exceptions, improper file permissions, or other
+ * complex factors. Server administrators may proactively log occurrences of
+ * server error responses, like the 500 status code, with details about the
+ * initiating requests to improve the stability of a service in the future.
+ *
+ * See https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/500
  */
 export default function serverError(body?: object | string): Response {
 	return response(500, body ?? "Server error");

package/src/response/temporaryRedirect.ts

@@ -0,0 +1,31 @@
+import transfer from "./transfer";
+
+/**
+ * 307 Temporary Redirect
+ *
+ * The HTTP 307 Temporary Redirect redirection response status code indicates
+ * that the resource requested has been temporarily moved to the URL in the
+ * Location header.
+ *
+ * A browser receiving this status will automatically request the resource at
+ * the URL in the Location header, redirecting the user to the new page. Search
+ * engines receiving this response will not attribute links to the original URL
+ * to the new resource, meaning no SEO value is transferred to the new URL.
+ *
+ * The method and the body of the original request are reused to perform the
+ * redirected request. In the cases where you want the request method to be
+ * changed to GET, use 303 See Other instead. This is useful when you want to
+ * give an answer to a successful PUT request that is not the uploaded resource,
+ * but a status monitor or confirmation message like "You have successfully
+ * uploaded XYZ".
+ *
+ * The difference between 307 and 302 is that 307 guarantees that the client
+ * will not change the request method and body when the redirected request is
+ * made. With 302, older clients incorrectly changed the method to GET. 307 and
+ * 302 responses are identical when the request method is GET.
+ *
+ * See https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/307
+ */
+export default function temporaryRedirect(location: string): Response {
+	return transfer(307, location);
+}

package/src/response/unauthorized.ts

@@ -3,11 +3,18 @@ import response from "./response";
 /**
  * 401 Unauthorized
  *
- * Although the HTTP standard specifies "unauthorized", semantically this
- * response means "unauthenticated". That is, the client must authenticate
- * itself to get the requested response.
+ * The HTTP 401 Unauthorized client error response status code indicates that a
+ * request was not successful because it lacks valid authentication credentials
+ * for the requested resource. This status code is sent with an HTTP
+ * WWW-Authenticate response header that contains information on the
+ * authentication scheme the server expects the client to include to make the
+ * request successfully.
  *
- * See https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/401
+ * A 401 Unauthorized is similar to the 403 Forbidden response, except that a
+ * 403 is returned when a request contains valid credentials, but the client
+ * does not have permissions to perform a certain action.
+ *
+ * See https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/401
  */
 export default function unauthorized(body?: object | string): Response {
 	return response(401, body ?? "Unauthorized");

package/src/response/unprocessable.ts

@@ -3,9 +3,15 @@ import response from "./response";
 /**
  * 422 Unprocessable Content
  *
- * The request was well-formed but was unable to be followed due to semantic errors.
+ * The HTTP 422 Unprocessable Content client error response status code
+ * indicates that the server understood the content type of the request content,
+ * and the syntax of the request content was correct, but it was unable to
+ * process the contained instructions.
  *
- * See https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/422
+ * Clients that receive a 422 response should expect that repeating the request
+ * without modification will fail with the same error.
+ *
+ * See https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/422
  */
 export default function unprocessable(body?: object | string): Response {
 	return response(422, body ?? "Unprocessable");

package/src/response.ts

@@ -1,15 +1,17 @@
 import badRequest from "./response/badRequest";
 import created from "./response/created";
 import forbidden from "./response/forbidden";
+import found from "./response/found";
 import methodNotAllowed from "./response/methodNotAllowed";
-import moved from "./response/moved";
+import movedPermanently from "./response/movedPermanently";
 import notFound from "./response/notFound";
 import notModified from "./response/notModified";
 import ok from "./response/ok";
-import redirect from "./response/redirect";
+import permanentRedirect from "./response/permanentRedirect";
 import response from "./response/response";
 import seeOther from "./response/seeOther";
 import serverError from "./response/serverError";
+import temporaryRedirect from "./response/temporaryRedirect";
 import transfer from "./response/transfer";
 import unauthorized from "./response/unauthorized";
 import unprocessable from "./response/unprocessable";
@@ -19,10 +21,12 @@ export {
 	ok,
 	created,
 	transfer,
+	movedPermanently,
+	found,
 	seeOther,
 	notModified,
-	redirect,
-	moved,
+	temporaryRedirect,
+	permanentRedirect,
 	badRequest,
 	unauthorized,
 	forbidden,

package/src/run/prepareTemplate.ts

@@ -0,0 +1,32 @@
+export default function prepareTemplate(template: string, clientScript: 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
+	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/{site → run}/run.ts

@@ -1,7 +1,7 @@
 import fs from "node:fs";
 import path from "node:path";
 import { transformWithEsbuild } from "vite";
-import Site from "./Site";
+import Site from "../site/Site";
 import runBuild from "./runBuild";
 import runDev from "./runDev";
 import runPreview from "./runPreview";

package/src/{site → run}/runBuild.ts

@@ -2,8 +2,8 @@ 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.ts";
-import manifest from "./manifest.ts";
+import Site from "../site/Site";
+import manifest from "../site/manifest.ts";
 
 // TODO: Don't cache index.html in dev?
 // TODO: Multiple hook.server locations

package/src/{site → run}/runDev.ts

@@ -7,8 +7,8 @@ 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.ts";
-import manifest from "./manifest.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> {

package/src/{site → run}/runPreview.ts

@@ -4,7 +4,7 @@ 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";
+import Site from "../site/Site";
 import prepareTemplate from "./prepareTemplate.ts";
 import runBuild from "./runBuild";
 
@@ -44,7 +44,8 @@ export default async function runPreview(site: Site): Promise<void> {
 			const file = path.join(site.root, "dist", "client", url.pathname);
 			if (existsSync(file)) {
 				// TODO: Stream the data?
-				return new Response(await fs.readFile(file), {
+				const body = bufferToArrayBuffer(await fs.readFile(file));
+				return new Response(body, {
 					status: 200,
 					headers: {
 						"Content-Type": contentType(path.extname(file)),
@@ -81,3 +82,12 @@ export default async function runPreview(site: Site): Promise<void> {
 	// 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 +1,6 @@
-import run from "./site/run";
-import runBuild from "./site/runBuild";
-import runDev from "./site/runDev";
-import runPreview from "./site/runPreview";
+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/Routerx.ts

@@ -1,4 +1,4 @@
-import pathToRegex from "../site/pathToRegex";
+import pathToRegex from "../utils/pathToRegex";
 import type HttpMethod from "./types/HttpMethod";
 import type MiddlewareFunction from "./types/MiddlewareFunction";
 import type ServerFunction from "./types/ServerFunction";
@@ -66,7 +66,7 @@ class MiddlewareHandler {
 	}
 }
 
-type Match = {
+interface Match {
 	fn: ServerFunction;
 	params?: Record<string, string>;
-};
+}

package/src/server/Server.ts

@@ -1,4 +1,4 @@
-import pathToRegex from "../site/pathToRegex";
+import pathToRegex from "../utils/pathToRegex";
 import ServerEvent from "./ServerEvent";
 import type MiddlewareFunction from "./types/MiddlewareFunction";
 import type ServerFunction from "./types/ServerFunction";
@@ -138,7 +138,7 @@ class RouteHandler {
 //	}
 //}
 
-type Match = {
+interface Match {
 	fn: ServerFunction;
 	params?: Record<string, string>;
-};
+}

package/src/server/ServerEvent.ts

@@ -3,7 +3,7 @@ import HeaderHelper from "./HeaderHelper";
 
 export default class ServerEvent {
 	request: Request;
-	response?: Response;
+	response: Response | undefined | void;
 	// TODO: Should we cast types??
 	params?: Record<string, string>;
 

package/src/server/connect/bufferToArrayBuffer.ts

@@ -0,0 +1,8 @@
+// From https://stackoverflow.com/a/79345620
+// No idea why it is needed
+export default function bufferToArrayBuffer(buffer: Buffer): ArrayBuffer {
+	return buffer.buffer.slice(
+		buffer.byteOffset,
+		buffer.byteOffset + buffer.byteLength,
+	) as ArrayBuffer;
+}

package/src/server/connect/connectMiddleware.ts

@@ -1,5 +1,6 @@
 import { IncomingMessage, ServerResponse } from "node:http";
 import type MiddlewareFunction from "../types/MiddlewareFunction";
+import bufferToArrayBuffer from "./bufferToArrayBuffer";
 import flattenHeaders from "./flattenHeaders";
 import nodeMessageToNodeResponse from "./nodeMessageToNodeResponse";
 import readableToBuffer from "./readableToBuffer";
@@ -27,7 +28,7 @@ export default function connectMiddleware(
 					: //(Readable.toWeb(readable) as ReadableStream);
 						// HACK: Chunked bodies are not being
 						// read correctly somewhere...
-						await readableToBuffer(readable);
+						bufferToArrayBuffer(await readableToBuffer(readable));
 				ev.response = new Response(responseBody, {
 					status,
 					headers: flattenHeaders(headers),
@@ -37,6 +38,7 @@ export default function connectMiddleware(
 
 			const cnext = async (error?: unknown) => {
 				if (error) {
+					// eslint-disable-next-line no-base-to-string
 					reject(error instanceof Error ? error : new Error(String(error)));
 				} else {
 					// TODO: Can we nest the next functions less? This is a bit weird
@@ -52,7 +54,7 @@ export default function connectMiddleware(
 					resolve();
 				}
 			} catch (e) {
-				cnext(e);
+				await cnext(e);
 			}
 		});
 	};

package/src/server/connect/nodeMessageToNodeResponse.ts

@@ -81,9 +81,9 @@ export default function nodeMessageToNodeResponse(
 	};
 }
 
-type ServerResponseResponse = {
+interface ServerResponseResponse {
 	res: ServerResponse;
 	onReadable: (
 		cb: (result: { readable: Readable; headers: OutgoingHttpHeaders; status: number }) => void,
 	) => void;
-};
+}

package/src/server/types/ServerFunction.ts

@@ -1,5 +1,7 @@
 import ServerEvent from "../ServerEvent";
 
-type ServerFunction = (e: ServerEvent) => Response | Promise<Response | undefined> | undefined;
+type ServerFunction = (
+	e: ServerEvent,
+) => Response | undefined | void | Promise<Response | undefined | void>;
 
 export default ServerFunction;

package/src/site/Router.ts

@@ -1,7 +1,7 @@
 import type LayoutHandler from "../types/LayoutHandler";
 import type ManifestRoute from "../types/ManifestRoute";
 import type RouteHandler from "../types/RouteHandler";
-import pathToRegex from "./pathToRegex";
+import pathToRegex from "../utils/pathToRegex";
 
 /**
  * A router that handles file routes with layouts, hooks, etc.
@@ -158,8 +158,8 @@ class Route {
 	}
 }
 
-type Match = {
+interface Match {
 	handler: RouteHandler;
 	params?: Record<string, string>;
 	query: URLSearchParams;
-};
+}