@jsenv/server 16.3.6 → 17.0.0

package/dist/ws/ws.js

@@ -243,11 +243,11 @@ function requireLimiter () {
 	return limiter;
 }
 
-var permessageDeflate;
+var permessageDeflate$1;
 var hasRequiredPermessageDeflate;
 
 function requirePermessageDeflate () {
-	if (hasRequiredPermessageDeflate) return permessageDeflate;
+	if (hasRequiredPermessageDeflate) return permessageDeflate$1;
 	hasRequiredPermessageDeflate = 1;
 
 	const zlib = require$$0;
@@ -287,6 +287,9 @@ function requirePermessageDeflate () {
 	   *     acknowledge disabling of client context takeover
 	   * @param {Number} [options.concurrencyLimit=10] The number of concurrent
 	   *     calls to zlib
+	   * @param {Boolean} [options.isServer=false] Create the instance in either
+	   *     server or client mode
+	   * @param {Number} [options.maxPayload=0] The maximum allowed message length
 	   * @param {(Boolean|Number)} [options.serverMaxWindowBits] Request/confirm the
 	   *     use of a custom server window size
 	   * @param {Boolean} [options.serverNoContextTakeover=false] Request/accept
@@ -297,16 +300,13 @@ function requirePermessageDeflate () {
 	   *     deflate
 	   * @param {Object} [options.zlibInflateOptions] Options to pass to zlib on
 	   *     inflate
-	   * @param {Boolean} [isServer=false] Create the instance in either server or
-	   *     client mode
-	   * @param {Number} [maxPayload=0] The maximum allowed message length
 	   */
-	  constructor(options, isServer, maxPayload) {
-	    this._maxPayload = maxPayload | 0;
+	  constructor(options) {
 	    this._options = options || {};
 	    this._threshold =
 	      this._options.threshold !== undefined ? this._options.threshold : 1024;
-	    this._isServer = !!isServer;
+	    this._maxPayload = this._options.maxPayload | 0;
+	    this._isServer = !!this._options.isServer;
 	    this._deflate = null;
 	    this._inflate = null;
 
@@ -710,7 +710,7 @@ function requirePermessageDeflate () {
 	  }
 	}
 
-	permessageDeflate = PerMessageDeflate;
+	permessageDeflate$1 = PerMessageDeflate;
 
 	/**
 	 * The listener of the `zlib.DeflateRaw` stream `'data'` event.
@@ -776,7 +776,7 @@ function requirePermessageDeflate () {
 	  err[kStatusCode] = 1007;
 	  this[kCallback](err);
 	}
-	return permessageDeflate;
+	return permessageDeflate$1;
 }
 
 var validation = {exports: {}};
@@ -2564,11 +2564,11 @@ function requireEventTarget () {
 	return eventTarget;
 }
 
-var extension;
+var extension$1;
 var hasRequiredExtension;
 
 function requireExtension () {
-	if (hasRequiredExtension) return extension;
+	if (hasRequiredExtension) return extension$1;
 	hasRequiredExtension = 1;
 
 	const { tokenChars } = requireValidation();
@@ -2771,8 +2771,8 @@ function requireExtension () {
 	    .join(', ');
 	}
 
-	extension = { format, parse };
-	return extension;
+	extension$1 = { format, parse };
+	return extension$1;
 }
 
 /* eslint no-unused-vars: ["error", { "varsIgnorePattern": "^Duplex|Readable$", "caughtErrors": "none" }] */
@@ -3475,7 +3475,7 @@ function requireWebsocket () {
 	  } else {
 	    try {
 	      parsedUrl = new URL(address);
-	    } catch (e) {
+	    } catch {
 	      throw new SyntaxError(`Invalid URL: ${address}`);
 	    }
 	  }
@@ -3537,11 +3537,11 @@ function requireWebsocket () {
 	  opts.timeout = opts.handshakeTimeout;
 
 	  if (opts.perMessageDeflate) {
-	    perMessageDeflate = new PerMessageDeflate(
-	      opts.perMessageDeflate !== true ? opts.perMessageDeflate : {},
-	      false,
-	      opts.maxPayload
-	    );
+	    perMessageDeflate = new PerMessageDeflate({
+	      ...opts.perMessageDeflate,
+	      isServer: false,
+	      maxPayload: opts.maxPayload
+	    });
 	    opts.headers['Sec-WebSocket-Extensions'] = format({
 	      [PerMessageDeflate.extensionName]: perMessageDeflate.offer()
 	    });
@@ -4348,17 +4348,19 @@ function requireStream () {
 
 requireStream();
 
+requireExtension();
+
+requirePermessageDeflate();
+
 requireReceiver();
 
 requireSender();
 
-requireWebsocket();
-
-var subprotocol;
+var subprotocol$1;
 var hasRequiredSubprotocol;
 
 function requireSubprotocol () {
-	if (hasRequiredSubprotocol) return subprotocol;
+	if (hasRequiredSubprotocol) return subprotocol$1;
 	hasRequiredSubprotocol = 1;
 
 	const { tokenChars } = requireValidation();
@@ -4420,10 +4422,14 @@ function requireSubprotocol () {
 	  return protocols;
 	}
 
-	subprotocol = { parse };
-	return subprotocol;
+	subprotocol$1 = { parse };
+	return subprotocol$1;
 }
 
+requireSubprotocol();
+
+requireWebsocket();
+
 /* eslint no-unused-vars: ["error", { "varsIgnorePattern": "^Duplex$", "caughtErrors": "none" }] */
 
 var websocketServer$1;
@@ -4724,11 +4730,11 @@ function requireWebsocketServer () {
 	      this.options.perMessageDeflate &&
 	      secWebSocketExtensions !== undefined
 	    ) {
-	      const perMessageDeflate = new PerMessageDeflate(
-	        this.options.perMessageDeflate,
-	        true,
-	        this.options.maxPayload
-	      );
+	      const perMessageDeflate = new PerMessageDeflate({
+	        ...this.options.perMessageDeflate,
+	        isServer: true,
+	        maxPayload: this.options.maxPayload
+	      });
 
 	      try {
 	        const offers = extension.parse(secWebSocketExtensions);

package/index.js

@@ -0,0 +1,56 @@
+/*
+ * This file is the first file executed by code using the package
+ * Its responsability is to export what is documented
+ * Ideally this file should be kept simple to help discovering codebase progressively.
+ */
+
+// tslint:disable:ordered-imports
+
+export { startServer } from "./src/start_server.js";
+
+export {
+  STOP_REASON_INTERNAL_ERROR,
+  STOP_REASON_PROCESS_SIGHUP,
+  STOP_REASON_PROCESS_SIGTERM,
+  STOP_REASON_PROCESS_SIGINT,
+  STOP_REASON_PROCESS_BEFORE_EXIT,
+  STOP_REASON_PROCESS_EXIT,
+  STOP_REASON_NOT_SPECIFIED,
+} from "./src/stop_reasons.js";
+export { serverPluginErrorHandler } from "./src/plugins/error_handler/server_plugin_error_handler.js";
+
+// webSocket
+export { WebSocketResponse } from "./src/web_socket_response.js";
+// long polling
+export { ProgressiveResponse } from "./src/progressive_response.js";
+// Server event (can be used to push events to clients that can be connected with WebSocket or EventSource)
+export { ServerEvents, LazyServerEvents } from "./src/server_events.js";
+
+// CORS
+export {
+  serverPluginCORS,
+  jsenvAccessControlAllowedHeaders,
+  jsenvAccessControlAllowedMethods,
+} from "./src/plugins/cors/server_plugin_cors.js";
+
+// filesystem
+export {
+  createFileSystemFetch,
+  fetchFileSystem,
+} from "./src/plugins/filesystem/fetch_filesystem.js";
+export { serveDirectory } from "./src/plugins/filesystem/serve_directory.js";
+export { serverPluginStaticFiles } from "./src/plugins/filesystem/server_plugin_static_files.js";
+
+// content-negotiation
+export { pickContentType } from "./src/content_negotiation/pick_content_type.js";
+export { pickContentEncoding } from "./src/content_negotiation/pick_content_encoding.js";
+export { pickContentLanguage } from "./src/content_negotiation/pick_content_language.js";
+export { serverPluginResponseAcceptanceCheck } from "./src/plugins/response_acceptance_check/server_plugin_response_acceptance_check.js";
+
+// others
+export { composeTwoResponses } from "./src/internal/response_composition.js";
+export { serverPluginRequestAliases } from "./src/plugins/request_aliases/server_plugin_request_aliases.js";
+export { findFreePort } from "./src/internal/listen.js";
+
+// internal (used by @jsenv/core)
+export { createPluginsController } from "./src/plugins_controller.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/server",
-  "version": "16.3.6",
+  "version": "17.0.0",
   "description": "A modern Node.js HTTP server with declarative routing, content negotiation, and WebSocket support",
   "repository": {
     "type": "git",
@@ -19,23 +19,24 @@
   "exports": {
     ".": {
       "import": {
-        "dev:jsenv": "./src/main.js",
+        "dev:jsenv": "./index.js",
         "default": "./dist/jsenv_server.js"
       }
     },
     "./*": "./*"
   },
-  "main": "./src/main.js",
+  "main": "./index.js",
   "files": [
     "/dist/",
-    "/src/"
+    "/src/",
+    "/index.js"
   ],
   "scripts": {
     "build": "node --experimental-import-meta-resolve ./scripts/build.mjs",
     "prepublishOnly": "npm run build"
   },
   "dependencies": {
-    "launch-editor": "2.13.1"
+    "launch-editor": "2.13.2"
   },
   "devDependencies": {
     "@jsenv/abort": "../../tooling/abort",
@@ -57,7 +58,7 @@
     "formidable": "3.5.4",
     "playwright": "1.58.1",
     "undici": "7.24.2",
-    "ws": "8.19.0"
+    "ws": "8.20.0"
   },
   "engines": {
     "node": ">=22.13.1"

package/src/{services/autoreload_on_server_restart/jsenv_service_autoreload_on_server_restart.js → plugins/autoreload_on_server_restart/server_plugin_autoreload_on_server_restart.js}

@@ -1,6 +1,6 @@
 import { LazyServerEvents } from "../../server_events.js";
 
-export const jsenvServiceAutoreloadOnRestart = () => {
+export const serverPluginAutoreloadOnRestart = () => {
   const aliveServerEvents = new LazyServerEvents(() => {});
 
   return {

package/src/{services/cors/jsenv_service_cors.js → plugins/cors/server_plugin_cors.js}

@@ -13,7 +13,7 @@ export const jsenvAccessControlAllowedMethods = [
   "OPTIONS",
 ];
 
-export const jsenvServiceCORS = ({
+export const serverPluginCORS = ({
   accessControlAllowedOrigins = [],
   accessControlAllowedMethods = jsenvAccessControlAllowedMethods,
   accessControlAllowedHeaders = jsenvAccessControlAllowedHeaders,

package/src/{services → plugins}/default_body_4xx_5xx/client/4xx.html

@@ -60,6 +60,6 @@
       <p class="error_message">${statusMessage}</p>
       <a href="/" jsenv-ignore class="home_link">Return to Home</a>
     </div>
-    <script src="/@jsenv/server/src/services/autoreload_on_server_restart/client/autoreload_on_server_restart.js?inline"></script>
+    <script src="/@jsenv/server/src/plugins/autoreload_on_server_restart/client/autoreload_on_server_restart.js?inline"></script>
   </body>
 </html>

package/src/{services/default_body_4xx_5xx/jsenv_service_default_body_4xx_5xx.js → plugins/default_body_4xx_5xx/server_plugin_default_body_4xx_5xx.js}

@@ -1,10 +1,11 @@
 import { readFileSync } from "node:fs";
+
 import { pickContentType } from "../../content_negotiation/pick_content_type.js";
 import { replacePlaceholdersInHtml } from "../../replace_placeholder_in_html.js";
 
 const clientErrorHtmlTemplateFileUrl = import.meta.resolve("./client/4xx.html");
 
-export const jsenvServiceDefaultBody4xx5xx = () => {
+export const serverPluginDefaultBody4xx5xx = () => {
   return {
     name: "jsenv:default_body_4xx_5xx",
 

package/src/{services/error_handler/jsenv_service_error_handler.js → plugins/error_handler/server_plugin_error_handler.js}

@@ -5,7 +5,7 @@ import { replacePlaceholdersInHtml } from "../../replace_placeholder_in_html.js"
 
 const internalErrorHtmlFileUrl = import.meta.resolve("./client/500.html");
 
-export const jsenvServiceErrorHandler = ({ sendErrorDetails = false } = {}) => {
+export const serverPluginErrorHandler = ({ sendErrorDetails = false } = {}) => {
   return {
     name: "jsenv:error_handler",
     handleError: (serverInternalError, { request }) => {

package/src/{filesystem → plugins/filesystem}/fetch_filesystem.js

@@ -6,14 +6,15 @@
 
 import { CONTENT_TYPE } from "@jsenv/utils/src/content_type/content_type.js";
 import { createReadStream, readFile, statSync } from "node:fs";
-import { pickContentEncoding } from "../content_negotiation/pick_content_encoding.js";
-import { convertFileSystemErrorToResponseProperties } from "../internal/convertFileSystemErrorToResponseProperties.js";
-import { bufferToEtag } from "../internal/etag.js";
+
+import { pickContentEncoding } from "../../content_negotiation/pick_content_encoding.js";
+import { composeTwoResponses } from "../../internal/response_composition.js";
+import { bufferToEtag } from "./etag.js";
+import { convertFileSystemErrorToResponseProperties } from "./filesystem_error_to_response.js";
 import {
   fileSystemPathToUrl,
   isFileSystemPath,
-} from "../internal/filesystem.js";
-import { composeTwoResponses } from "../internal/response_composition.js";
+} from "./filesystem_path_and_url.js";
 import { serveDirectory } from "./serve_directory.js";
 
 export const createFileSystemFetch = (directoryUrl, options) => {

package/src/{filesystem → plugins/filesystem}/serve_directory.js

@@ -1,5 +1,6 @@
 import { lstatSync, readdirSync } from "node:fs";
-import { pickContentType } from "../content_negotiation/pick_content_type.js";
+
+import { pickContentType } from "../../content_negotiation/pick_content_type.js";
 
 export const serveDirectory = (
   url,

package/src/plugins/filesystem/server_plugin_static_files.js

@@ -0,0 +1,44 @@
+import { urlToExtension, urlToPathname } from "@jsenv/urls";
+
+import { createFileSystemFetch } from "./fetch_filesystem.js";
+
+export const serverPluginStaticFiles = ({ directoryUrl, mainFilePath }) => {
+  return {
+    name: "jsenv:static_files",
+    routes: [
+      {
+        endpoint: "GET *",
+        description: "Serve static files.",
+        fetch: (request, helpers) => {
+          const urlIsVersioned = new URL(request.url).searchParams.has("v");
+          if (mainFilePath && request.resource === "/") {
+            request = {
+              ...request,
+              resource: `/${mainFilePath}`,
+            };
+          }
+          const urlObject = new URL(request.resource.slice(1), directoryUrl);
+          return createFileSystemFetch(directoryUrl, {
+            cacheControl: urlIsVersioned
+              ? `private,max-age=${SECONDS_IN_30_DAYS},immutable`
+              : "private,max-age=0,must-revalidate",
+            etagEnabled: true,
+            compressionEnabled: true,
+            rootDirectoryUrl: directoryUrl,
+            canReadDirectory: true,
+            ENOENTFallback: () => {
+              if (
+                !urlToExtension(urlObject) &&
+                !urlToPathname(urlObject).endsWith("/")
+              ) {
+                return new URL(mainFilePath, directoryUrl);
+              }
+              return null;
+            },
+          })(request, helpers);
+        },
+      },
+    ],
+  };
+};
+const SECONDS_IN_30_DAYS = 60 * 60 * 24 * 30;

package/src/{services/internal_client_files/jsenv_service_internal_client_files.js → plugins/internal_client_files/server_plugin_internal_client_files.js}

@@ -3,7 +3,7 @@ import { readFileSync } from "node:fs";
 
 const jsenvServerRootDirectoryUrl = import.meta.resolve("../../../");
 
-export const jsenvServiceInternalClientFiles = () => {
+export const serverPluginInternalClientFiles = () => {
   return {
     name: "jsenv:internal_client_files",
 

package/src/{services/open_file/jsenv_service_open_file.js → plugins/open_file/server_plugin_open_file.js}

@@ -1,7 +1,7 @@
 import { urlToFileSystemPath } from "@jsenv/urls";
 import { createRequire } from "node:module";
 
-export const jsenvServiceOpenFile = () => {
+export const serverPluginOpenFile = () => {
   return {
     name: "jsenv:open_file",
     routes: [

package/src/{services/request_aliases/jsenv_service_request_aliases.js → plugins/request_aliases/server_plugin_request_aliases.js}

@@ -1,6 +1,6 @@
 import { URL_META } from "@jsenv/url-meta";
 
-export const jsenvServiceRequestAliases = (resourceAliases) => {
+export const serverPluginRequestAliases = (resourceAliases) => {
   const aliases = {};
   Object.keys(resourceAliases).forEach((key) => {
     aliases[asFileUrl(key)] = asFileUrl(resourceAliases[key]);

package/src/{services/response_acceptance_check/jsenv_service_response_acceptance_check.js → plugins/response_acceptance_check/server_plugin_response_acceptance_check.js}

@@ -2,7 +2,7 @@ import { pickContentEncoding } from "@jsenv/server/src/content_negotiation/pick_
 import { pickContentLanguage } from "@jsenv/server/src/content_negotiation/pick_content_language.js";
 import { pickContentType } from "@jsenv/server/src/content_negotiation/pick_content_type.js";
 
-export const jsenvServiceResponseAcceptanceCheck = () => {
+export const serverPluginResponseAcceptanceCheck = () => {
   return {
     name: "jsenv:response_acceptance_check",
     inspectResponse: (request, { response, warn }) => {

package/src/{services → plugins}/route_inspector/client/route_inspector.html

@@ -14,8 +14,8 @@
         }
       }
     </script>
-    <script src="/@jsenv/server/src/services/route_inspector/client/code_block.js?inline"></script>
-    <script src="/@jsenv/server/src/services/autoreload_on_server_restart/client/autoreload_on_server_restart.js?inline"></script>
+    <script src="/@jsenv/server/src/plugins/route_inspector/client/code_block.js?inline"></script>
+    <script src="/@jsenv/server/src/plugins/autoreload_on_server_restart/client/autoreload_on_server_restart.js?inline"></script>
   </head>
   <body>
     <style>

package/src/{services/route_inspector/jsenv_service_route_inspector.js → plugins/route_inspector/server_plugin_route_inspector.js}

@@ -3,7 +3,7 @@ import { readFileSync } from "node:fs";
 const routeInspectorHtmlFileUrl = import.meta
   .resolve("./client/route_inspector.html");
 
-export const jsenvServiceRouteInspector = () => {
+export const serverPluginRouteInspector = () => {
   return {
     name: "jsenv:route_inspector",
     routes: [

package/src/plugins/server_plugins_controller.js

@@ -0,0 +1,21 @@
+import { createPluginsController } from "../plugins_controller.js";
+
+export const createServerPluginsController = async (serverPlugins) => {
+  const jsenvServerPluginsController = await createPluginsController({
+    plugins: serverPlugins,
+    pluginDescription: {
+      name: "server plugin",
+      properties: {
+        serverListening: { type: "hook" },
+        redirectRequest: { type: "hook" },
+        augmentRouteFetchSecondArg: { type: "hook" },
+        handleError: { type: "hook" },
+        onResponsePush: { type: "hook" },
+        injectResponseProperties: { type: "hook" },
+        serverStopped: { type: "hook" },
+        routes: {}, // routes are handled separately (used to populate the router)
+      },
+    },
+  });
+  return jsenvServerPluginsController;
+};