@wooksjs/http-static 0.6.5 → 0.7.0

package/README.md

@@ -1,6 +1,4 @@
-# Wooks Serve File
-
-**!!! This is work-in-progress library, breaking changes are expected !!!**
+# @wooksjs/http-static
 
 <p align="center">
 <img src="../../wooks-logo.png" width="450px"><br>
@@ -9,71 +7,18 @@
 </a>
 </p>
 
-Wooks Serve File is composable static file server for [@wooksjs/event-http](https://github.com/wooksjs/wooksjs/tree/main/packages/event-http).
-
-`serveFile` returns a readable stream and prepares all the neccessary response headers (like content-length, content-type etc).
-
-- ✅ returns a readable stream
-- ✅ prepares all the neccessary response headers (like content-length, content-type etc)
-- ✅ can handle etag
-- ✅ can handle ranges
+Composable static file server for [@wooksjs/event-http](https://github.com/wooksjs/wooksjs/tree/main/packages/event-http). Serves files as readable streams with automatic content-type detection, ETag support, and range requests.
 
 ## Installation
 
-`npm install @wooksjs/http-static`
-
-## Usage
-
-```js
-import { serveFile } from '@wooksjs/http-static'
-// ...
-serveFile(filePath, options)
+```sh
+npm install @wooksjs/http-static
 ```
 
-**serveFile options**
-
-```ts
-{
-    // Any header to add
-    headers?: Record<string, string>,
-
-    // Cache-Control header
-    cacheControl?: TCacheControl,
-
-    // Expires header
-    expires?: Date | string | number,
-
-    // when true a header "Pragma: no-cache" will be added
-    pragmaNoCache?: boolean,
-
-    // the base directory path
-    baseDir?: string,
-
-    // default extension will be added to the filePath
-    defaultExt?: string,
-
-    // when true lists files in directory
-    listDirectory?: boolean,
-
-    // put 'index.html'
-    // to automatically serve it from the folder
-    index?: string,
-}
-```
-
-### Built-in file server example:
-
-```js
-import { useRouteParams } from 'wooks'
-import { serveFile } from '@wooksjs/http-static'
-app.get('static/*', () => {
-  const { get } = useRouteParams()
-  return serveFile(get('*'), { cacheControl: { maxAge: '10m' } })
-})
-```
+## Documentation
 
-`cacheControl` here is the same object as used in `useSetCacheControl().setCacheControl({ ... })` from `@wooksjs/event-http`
+For full documentation, visit [wooks.moost.org/webapp/static](https://wooks.moost.org/webapp/static).
 
-## Documentation
+## License
 
-To check out docs, visit [wooks.moost.org](https://wooks.moost.org/).
+MIT

package/dist/index.cjs

@@ -1247,11 +1247,9 @@ const { stat, readdir } = fs.promises;
 * @returns A readable stream, string body, or HTML directory listing.
 */
 async function serveFile(filePath, options = {}) {
-	const { status } = (0, __wooksjs_event_http.useResponse)();
-	const { setHeader, removeHeader } = (0, __wooksjs_event_http.useSetHeaders)();
+	const response = (0, __wooksjs_event_http.useResponse)();
 	const headers = (0, __wooksjs_event_http.useHeaders)();
 	const { method, url } = (0, __wooksjs_event_http.useRequest)();
-	const { setCacheControl, setExpires, setPragmaNoCache } = (0, __wooksjs_event_http.useSetCacheControl)();
 	const normalizedPath = normalizePath(filePath, options.baseDir);
 	if (!options.allowDotDot) {
 		const resolvedBase = path.default.resolve(options.baseDir || process.cwd());
@@ -1267,7 +1265,7 @@ async function serveFile(filePath, options = {}) {
 		}
 		throw new __wooksjs_event_http.HttpError(404);
 	}
-	status(200);
+	response.status = 200;
 	const etag = `"${[
 		fileStats.ino,
 		fileStats.size,
@@ -1275,25 +1273,25 @@ async function serveFile(filePath, options = {}) {
 	].join("-")}"`;
 	const lastModified = new Date(fileStats.mtime);
 	if (isNotModified(etag, lastModified, headers["if-none-match"] || "", headers["if-modified-since"] || "")) {
-		status(304);
+		response.status = 304;
 		return "";
 	}
-	setHeader("etag", etag);
-	setHeader("last-modified", lastModified.toUTCString());
-	if (options.cacheControl !== void 0) setCacheControl(options.cacheControl);
-	if (options.expires) setExpires(options.expires);
-	if (options.pragmaNoCache) setPragmaNoCache(options.pragmaNoCache);
+	response.setHeader("etag", etag);
+	response.setHeader("last-modified", lastModified.toUTCString());
+	if (options.cacheControl !== void 0) response.setCacheControl(options.cacheControl);
+	if (options.expires) response.setExpires(options.expires);
+	if (options.pragmaNoCache) response.setPragmaNoCache(options.pragmaNoCache);
 	if (fileStats.isDirectory()) {
 		if (options.listDirectory) return listDirectory(normalizedPath);
 		else if (options.index) {
-			if (!filePath.endsWith("/") && url && !url.endsWith("/")) return new __wooksjs_event_http.BaseHttpResponse().setStatus(302).setHeader("location", `${url}/`);
+			if (!filePath.endsWith("/") && url && !url.endsWith("/")) return response.setStatus(302).setHeader("location", `${url}/`);
 			return serveFile(path.default.join(filePath, options.index), {
 				...options,
 				index: ""
 			});
 		}
-		removeHeader("etag");
-		removeHeader("last-modified");
+		response.removeHeader("etag");
+		response.removeHeader("last-modified");
 		throw new __wooksjs_event_http.HttpError(404);
 	}
 	let range = headers.range;
@@ -1312,18 +1310,18 @@ async function serveFile(filePath, options = {}) {
 		const ifRangeTag = ifRange.startsWith("\"") ? ifRange : "";
 		const ifRangeDate = ifRangeTag ? "" : ifRange;
 		if (ifRange && !isNotModified(etag, lastModified, ifRangeTag, ifRangeDate)) {
-			status(200);
+			response.status = 200;
 			size = fileStats.size;
 			range = "";
 		} else {
-			setHeader("content-range", `bytes ${start}-${end}/${fileStats.size}`);
-			status(206);
+			response.setHeader("content-range", `bytes ${start}-${end}/${fileStats.size}`);
+			response.status = 206;
 		}
 	}
-	setHeader("accept-ranges", "bytes");
-	setHeader("content-type", getMimeType(normalizedPath) || "application/octet-stream");
-	setHeader("content-length", size);
-	if (options.headers) for (const header of Object.keys(options.headers)) setHeader(header, options.headers[header]);
+	response.setHeader("accept-ranges", "bytes");
+	response.setHeader("content-type", getMimeType(normalizedPath) || "application/octet-stream");
+	response.setHeader("content-length", size);
+	if (options.headers) for (const header of Object.keys(options.headers)) response.setHeader(header, options.headers[header]);
 	return method === "HEAD" ? "" : (0, fs.createReadStream)(normalizedPath, range ? {
 		start,
 		end
@@ -1340,7 +1338,7 @@ function isNotModified(etag, lastModified, clientEtag, clientLM) {
 	return false;
 }
 async function listDirectory(dirPath) {
-	const { setContentType } = (0, __wooksjs_event_http.useSetHeaders)();
+	const response = (0, __wooksjs_event_http.useResponse)();
 	const { url } = (0, __wooksjs_event_http.useRequest)();
 	const list = await readdir(dirPath);
 	const promises = [];
@@ -1363,7 +1361,7 @@ async function listDirectory(dirPath) {
 		name: "..",
 		dir: true
 	});
-	setContentType("text/html");
+	response.setContentType("text/html");
 	const styles = "<style type=\"text/css\">\nhtml { font-family: monospace }\nspan { padding: 0px 2px }\n.text { text-overflow: ellipsis; overflow: hidden; white-space: nowrap; }\n.icon { width: 20px; display: inline-block; text-align: center; }\n.name { width: 250px; display: inline-block; }\n.size { width: 80px; display: inline-block; color: grey; text-align: right; }\n.date { width: 200px; display: inline-block; color: grey; text-align: right; }\n\n</style>";
 	return `<html><head><title>Dir</title> ${styles} </head><body><ul>${detailedList.map((d) => `<li> <span class="icon">${d.dir ? "&#128193;" : "&#128462;"}</span><a href="${escapeHtml(path.default.join(url || "", d.name))}"><span class="name text">${escapeHtml(d.name)}</span></a><span class="size text">${d.size && (d.size > 1e4 ? `${Math.round(d.size / 1024 / 1024).toString()}Mb` : `${Math.round(d.size / 1024).toString()}Kb`) || ""}</span><span class="date text">${d.mtime && d.mtime.toISOString() || ""}</li>`).join("\n")}</ul></body></html>`;
 }

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { BaseHttpResponse, HttpError, useHeaders, useRequest, useResponse, useSetCacheControl, useSetHeaders } from "@wooksjs/event-http";
+import { HttpError, useHeaders, useRequest, useResponse } from "@wooksjs/event-http";
 import { createReadStream, promises } from "fs";
 import path from "path";
 
@@ -1224,11 +1224,9 @@ const { stat, readdir } = promises;
 * @returns A readable stream, string body, or HTML directory listing.
 */
 async function serveFile(filePath, options = {}) {
-	const { status } = useResponse();
-	const { setHeader, removeHeader } = useSetHeaders();
+	const response = useResponse();
 	const headers = useHeaders();
 	const { method, url } = useRequest();
-	const { setCacheControl, setExpires, setPragmaNoCache } = useSetCacheControl();
 	const normalizedPath = normalizePath(filePath, options.baseDir);
 	if (!options.allowDotDot) {
 		const resolvedBase = path.resolve(options.baseDir || process.cwd());
@@ -1244,7 +1242,7 @@ async function serveFile(filePath, options = {}) {
 		}
 		throw new HttpError(404);
 	}
-	status(200);
+	response.status = 200;
 	const etag = `"${[
 		fileStats.ino,
 		fileStats.size,
@@ -1252,25 +1250,25 @@ async function serveFile(filePath, options = {}) {
 	].join("-")}"`;
 	const lastModified = new Date(fileStats.mtime);
 	if (isNotModified(etag, lastModified, headers["if-none-match"] || "", headers["if-modified-since"] || "")) {
-		status(304);
+		response.status = 304;
 		return "";
 	}
-	setHeader("etag", etag);
-	setHeader("last-modified", lastModified.toUTCString());
-	if (options.cacheControl !== void 0) setCacheControl(options.cacheControl);
-	if (options.expires) setExpires(options.expires);
-	if (options.pragmaNoCache) setPragmaNoCache(options.pragmaNoCache);
+	response.setHeader("etag", etag);
+	response.setHeader("last-modified", lastModified.toUTCString());
+	if (options.cacheControl !== void 0) response.setCacheControl(options.cacheControl);
+	if (options.expires) response.setExpires(options.expires);
+	if (options.pragmaNoCache) response.setPragmaNoCache(options.pragmaNoCache);
 	if (fileStats.isDirectory()) {
 		if (options.listDirectory) return listDirectory(normalizedPath);
 		else if (options.index) {
-			if (!filePath.endsWith("/") && url && !url.endsWith("/")) return new BaseHttpResponse().setStatus(302).setHeader("location", `${url}/`);
+			if (!filePath.endsWith("/") && url && !url.endsWith("/")) return response.setStatus(302).setHeader("location", `${url}/`);
 			return serveFile(path.join(filePath, options.index), {
 				...options,
 				index: ""
 			});
 		}
-		removeHeader("etag");
-		removeHeader("last-modified");
+		response.removeHeader("etag");
+		response.removeHeader("last-modified");
 		throw new HttpError(404);
 	}
 	let range = headers.range;
@@ -1289,18 +1287,18 @@ async function serveFile(filePath, options = {}) {
 		const ifRangeTag = ifRange.startsWith("\"") ? ifRange : "";
 		const ifRangeDate = ifRangeTag ? "" : ifRange;
 		if (ifRange && !isNotModified(etag, lastModified, ifRangeTag, ifRangeDate)) {
-			status(200);
+			response.status = 200;
 			size = fileStats.size;
 			range = "";
 		} else {
-			setHeader("content-range", `bytes ${start}-${end}/${fileStats.size}`);
-			status(206);
+			response.setHeader("content-range", `bytes ${start}-${end}/${fileStats.size}`);
+			response.status = 206;
 		}
 	}
-	setHeader("accept-ranges", "bytes");
-	setHeader("content-type", getMimeType(normalizedPath) || "application/octet-stream");
-	setHeader("content-length", size);
-	if (options.headers) for (const header of Object.keys(options.headers)) setHeader(header, options.headers[header]);
+	response.setHeader("accept-ranges", "bytes");
+	response.setHeader("content-type", getMimeType(normalizedPath) || "application/octet-stream");
+	response.setHeader("content-length", size);
+	if (options.headers) for (const header of Object.keys(options.headers)) response.setHeader(header, options.headers[header]);
 	return method === "HEAD" ? "" : createReadStream(normalizedPath, range ? {
 		start,
 		end
@@ -1317,7 +1315,7 @@ function isNotModified(etag, lastModified, clientEtag, clientLM) {
 	return false;
 }
 async function listDirectory(dirPath) {
-	const { setContentType } = useSetHeaders();
+	const response = useResponse();
 	const { url } = useRequest();
 	const list = await readdir(dirPath);
 	const promises$1 = [];
@@ -1340,7 +1338,7 @@ async function listDirectory(dirPath) {
 		name: "..",
 		dir: true
 	});
-	setContentType("text/html");
+	response.setContentType("text/html");
 	const styles = "<style type=\"text/css\">\nhtml { font-family: monospace }\nspan { padding: 0px 2px }\n.text { text-overflow: ellipsis; overflow: hidden; white-space: nowrap; }\n.icon { width: 20px; display: inline-block; text-align: center; }\n.name { width: 250px; display: inline-block; }\n.size { width: 80px; display: inline-block; color: grey; text-align: right; }\n.date { width: 200px; display: inline-block; color: grey; text-align: right; }\n\n</style>";
 	return `<html><head><title>Dir</title> ${styles} </head><body><ul>${detailedList.map((d) => `<li> <span class="icon">${d.dir ? "&#128193;" : "&#128462;"}</span><a href="${escapeHtml(path.join(url || "", d.name))}"><span class="name text">${escapeHtml(d.name)}</span></a><span class="size text">${d.size && (d.size > 1e4 ? `${Math.round(d.size / 1024 / 1024).toString()}Mb` : `${Math.round(d.size / 1024).toString()}Kb`) || ""}</span><span class="date text">${d.mtime && d.mtime.toISOString() || ""}</li>`).join("\n")}</ul></body></html>`;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wooksjs/http-static",
-  "version": "0.6.5",
+  "version": "0.7.0",
   "description": "@wooksjs/http-static",
   "keywords": [
     "api",
@@ -42,10 +42,10 @@
   "devDependencies": {
     "typescript": "^5.9.3",
     "vitest": "^3.2.4",
-    "@wooksjs/event-http": "^0.6.5"
+    "@wooksjs/event-http": "^0.7.0"
   },
   "peerDependencies": {
-    "@wooksjs/event-http": "^0.6.5"
+    "@wooksjs/event-http": "^0.7.0"
   },
   "scripts": {
     "build": "rolldown -c ../../rolldown.config.mjs"