@e22m4u/js-http-static-router 0.1.2 → 0.2.0

package/dist/cjs/index.cjs

@@ -48,7 +48,10 @@ __name(escapeRegexp, "escapeRegexp");
 
 // src/static-route.js
 var import_js_format = require("@e22m4u/js-format");
-var _StaticRoute = class _StaticRoute {
+var StaticRoute = class {
+  static {
+    __name(this, "StaticRoute");
+  }
   /**
    * Remote path.
    *
@@ -93,7 +96,7 @@ var _StaticRoute = class _StaticRoute {
     }
     if (!routeDef.remotePath.startsWith("/")) {
       throw new import_js_format.InvalidArgumentError(
-        'Option "remotePath" must starts with "/", but %v was given.',
+        'Option "remotePath" must start with "/", but %v was given.',
         routeDef.remotePath
       );
     }
@@ -103,42 +106,70 @@ var _StaticRoute = class _StaticRoute {
         routeDef.resourcePath
       );
     }
-    const resourcePath = import_path.default.resolve(routeDef.resourcePath);
+    if (!import_path.default.isAbsolute(routeDef.resourcePath)) {
+      throw new import_js_format.InvalidArgumentError(
+        'Option "resourcePath" must be an absolute path, but %v was given.',
+        routeDef.resourcePath
+      );
+    }
     let stats;
     try {
-      stats = import_fs.default.statSync(resourcePath);
+      stats = import_fs.default.statSync(routeDef.resourcePath);
     } catch (error) {
       console.error(error);
       throw new import_js_format.InvalidArgumentError(
         "Resource path %v does not exist.",
-        resourcePath
+        routeDef.resourcePath
       );
     }
     const isFile = stats.isFile();
     const escapedRemotePath = escapeRegexp(routeDef.remotePath);
-    const regexp = isFile ? new RegExp(`^${escapedRemotePath}$`) : new RegExp(`^${escapedRemotePath}(?:$|\\/)`);
+    let regexp;
+    if (isFile) {
+      regexp = new RegExp(`^${escapedRemotePath}$`);
+    } else if (escapedRemotePath === "/") {
+      regexp = new RegExp(`^(?:$|\\/)`);
+    } else {
+      regexp = new RegExp(`^${escapedRemotePath}(?:$|\\/)`);
+    }
     this.remotePath = routeDef.remotePath;
-    this.resourcePath = resourcePath;
+    this.resourcePath = routeDef.resourcePath;
     this.regexp = regexp;
     this.isFile = isFile;
   }
 };
-__name(_StaticRoute, "StaticRoute");
-var StaticRoute = _StaticRoute;
 
 // src/http-static-router.js
 var import_path2 = __toESM(require("path"), 1);
 var import_mime_types = __toESM(require("mime-types"), 1);
-var import_http = require("http");
 var import_fs2 = __toESM(require("fs"), 1);
 
-// src/utils/get-pathname-from-url.js
+// src/utils/create-error.js
 var import_js_format2 = require("@e22m4u/js-format");
+
+// src/utils/fetch-request-body.js
+var import_http_errors = __toESM(require("http-errors"), 1);
+var import_js_format4 = require("@e22m4u/js-format");
+
+// src/utils/parse-content-type.js
+var import_js_format3 = require("@e22m4u/js-format");
+
+// src/utils/create-request-mock.js
+var import_js_format7 = require("@e22m4u/js-format");
+
+// src/utils/parse-cookie-string.js
+var import_js_format5 = require("@e22m4u/js-format");
+
+// src/utils/create-cookie-string.js
+var import_js_format6 = require("@e22m4u/js-format");
+
+// src/utils/get-pathname-from-url.js
+var import_js_format8 = require("@e22m4u/js-format");
 var HOST_RE = /^https?:\/\/[^/]+/;
 var QUERY_STRING_RE = /\?.*$/;
 function getPathnameFromUrl(url) {
   if (typeof url !== "string") {
-    throw new import_js_format2.InvalidArgumentError(
+    throw new import_js_format8.InvalidArgumentError(
       'Parameter "url" must be a String, but %v was given.',
       url
     );
@@ -148,9 +179,12 @@ function getPathnameFromUrl(url) {
 __name(getPathnameFromUrl, "getPathnameFromUrl");
 
 // src/http-static-router.js
-var import_js_format3 = require("@e22m4u/js-format");
+var import_js_format9 = require("@e22m4u/js-format");
 var import_js_service = require("@e22m4u/js-service");
-var _HttpStaticRouter = class _HttpStaticRouter extends import_js_service.DebuggableService {
+var HttpStaticRouter = class extends import_js_service.DebuggableService {
+  static {
+    __name(this, "HttpStaticRouter");
+  }
   /**
    * Routes.
    *
@@ -180,9 +214,9 @@ var _HttpStaticRouter = class _HttpStaticRouter extends import_js_service.Debugg
       super(containerOrOptions, debugOptions);
     } else if (containerOrOptions !== void 0) {
       if (!containerOrOptions || typeof containerOrOptions !== "object" || Array.isArray(containerOrOptions)) {
-        throw new import_js_format3.InvalidArgumentError(
-          'Parameter "containerOrOptions" must be an Object or an instance of ServiceContainer, but %v was given.',
-          options
+        throw new import_js_format9.InvalidArgumentError(
+          "First parameter must be an Object or an instance of ServiceContainer, but %v was given.",
+          containerOrOptions
         );
       }
       super(void 0, debugOptions);
@@ -195,20 +229,20 @@ var _HttpStaticRouter = class _HttpStaticRouter extends import_js_service.Debugg
     }
     if (options !== void 0) {
       if (!options || typeof options !== "object" || Array.isArray(options)) {
-        throw new import_js_format3.InvalidArgumentError(
+        throw new import_js_format9.InvalidArgumentError(
           'Parameter "options" must be an Object, but %v was given.',
           options
         );
       }
       if (options.baseDir !== void 0) {
         if (typeof options.baseDir !== "string") {
-          throw new import_js_format3.InvalidArgumentError(
+          throw new import_js_format9.InvalidArgumentError(
             'Option "baseDir" must be a String, but %v was given.',
             options.baseDir
           );
         }
         if (!import_path2.default.isAbsolute(options.baseDir)) {
-          throw new import_js_format3.InvalidArgumentError(
+          throw new import_js_format9.InvalidArgumentError(
             'Option "baseDir" must be an absolute path, but %v was given.',
             options.baseDir
           );
@@ -222,15 +256,21 @@ var _HttpStaticRouter = class _HttpStaticRouter extends import_js_service.Debugg
    * Define route.
    *
    * @param {import('./static-route.js').StaticRouteDefinition} routeDef
-   * @returns {this}
+   * @returns {import('./static-route.js').StaticRoute}
    */
   defineRoute(routeDef) {
     if (!routeDef || typeof routeDef !== "object" || Array.isArray(routeDef)) {
-      throw new import_js_format3.InvalidArgumentError(
+      throw new import_js_format9.InvalidArgumentError(
         'Parameter "routeDef" must be an Object, but %v was given.',
         routeDef
       );
     }
+    if (typeof routeDef.resourcePath !== "string") {
+      throw new import_js_format9.InvalidArgumentError(
+        'Option "resourcePath" must be a String, but %v was given.',
+        routeDef.resourcePath
+      );
+    }
     if (this._options.baseDir !== void 0 && !import_path2.default.isAbsolute(routeDef.resourcePath)) {
       routeDef = { ...routeDef };
       routeDef.resourcePath = import_path2.default.join(
@@ -238,19 +278,30 @@ var _HttpStaticRouter = class _HttpStaticRouter extends import_js_service.Debugg
         routeDef.resourcePath
       );
     }
+    if (this._options.baseDir === void 0 && !import_path2.default.isAbsolute(routeDef.resourcePath)) {
+      throw new import_js_format9.InvalidArgumentError(
+        'Option "resourcePath" must be an absolute path when the router option "basePath" is not specified, but %v was given.',
+        routeDef.resourcePath
+      );
+    }
     const debug = this.getDebuggerFor(this.defineRoute);
     const route = new StaticRoute(routeDef);
     debug("Adding a new route.");
-    debug("Resource path is %v.", route.resourcePath);
     debug("Remote path is %v.", route.remotePath);
+    debug("Resource path is %v.", route.resourcePath);
     debug("Resource type is %s.", route.isFile ? "File" : "Folder");
     this._routes.push(route);
     this._routes.sort((a, b) => b.remotePath.length - a.remotePath.length);
-    return this;
+    return route;
   }
   /**
    * Handle request.
    *
+   * Метод возвращает Promise, который разрешается как:
+   *   - false, если маршрут не совпал, файл не найден
+   *     или метод запроса не поддерживается;
+   *   - true, во всех остальных случаях;
+   *
    * @param {import('http').IncomingMessage} request
    * @param {import('http').ServerResponse} response
    * @returns {Promise<boolean>}
@@ -258,7 +309,7 @@ var _HttpStaticRouter = class _HttpStaticRouter extends import_js_service.Debugg
   async handleRequest(request, response) {
     const fileInfo = await this._findFileForRequest(request);
     if (fileInfo !== void 0) {
-      this._sendFile(request, response, fileInfo);
+      await this._sendFile(request, response, fileInfo);
       return true;
     }
     return false;
@@ -270,12 +321,6 @@ var _HttpStaticRouter = class _HttpStaticRouter extends import_js_service.Debugg
    * @returns {Promise<FileInfo|undefined>|undefined}
    */
   async _findFileForRequest(request) {
-    if (!(request instanceof import_http.IncomingMessage)) {
-      throw new import_js_format3.InvalidArgumentError(
-        'Parameter "request" must be an instance of IncomingMessage, but %v was given.',
-        request
-      );
-    }
     const debug = this.getDebuggerFor(this._findFileForRequest);
     debug("File finding for an incoming request.");
     debug("Incoming request %s %v.", request.method, request.url);
@@ -300,13 +345,14 @@ var _HttpStaticRouter = class _HttpStaticRouter extends import_js_service.Debugg
     }
     debug("Walking through %v routes.", this._routes.length);
     for (const route of this._routes) {
-      const isMatched = route.regexp.test(requestPath);
+      const isMatched = route.regexp.test(requestPath || "/");
       if (isMatched) {
         debug("Matched route %v.", route.remotePath);
         let targetPath = route.resourcePath;
+        let extraPath = "";
         if (!route.isFile) {
-          const relativePath = requestPath.replace(route.regexp, "");
-          targetPath = import_path2.default.join(route.resourcePath, relativePath);
+          extraPath = requestPath.replace(route.regexp, "");
+          targetPath = import_path2.default.join(route.resourcePath, extraPath);
         }
         targetPath = import_path2.default.resolve(targetPath);
         const resourceRoot = import_path2.default.resolve(route.resourcePath);
@@ -324,15 +370,15 @@ var _HttpStaticRouter = class _HttpStaticRouter extends import_js_service.Debugg
           });
         });
         if (fileSize !== void 0) {
-          if (requestPath.endsWith("/")) {
+          if (extraPath && extraPath.endsWith("/")) {
             continue;
           }
-          debug("File found %v.", targetPath);
+          debug("Found file %v.", targetPath);
           return { path: targetPath, size: fileSize };
         }
       }
     }
-    debug("File not found.");
+    debug("File was not found.");
   }
   /**
    * Send file.
@@ -340,29 +386,37 @@ var _HttpStaticRouter = class _HttpStaticRouter extends import_js_service.Debugg
    * @param {import('http').IncomingMessage} request
    * @param {import('http').ServerResponse} response
    * @param {FileInfo} fileInfo
+   * @returns {Promise<void>}
    */
-  _sendFile(request, response, fileInfo) {
+  async _sendFile(request, response, fileInfo) {
+    let resolve;
+    const promise = new Promise((res) => resolve = res);
     const debug = this.getDebuggerFor(this._sendFile);
     debug("File sending for an incoming request.");
     debug("Incoming request %s %v.", request.method, request.url);
     debug("File path %v.", fileInfo.path);
     debug("File size %v bytes.", fileInfo.size);
-    if (request.method !== "GET" && request.method !== "HEAD") {
-      debug("Method not allowed.");
-      return;
-    }
     const extname = import_path2.default.extname(fileInfo.path);
     const contentType = import_mime_types.default.contentType(extname) || "application/octet-stream";
     const fileStream = (0, import_fs2.createReadStream)(fileInfo.path);
     fileStream.on("error", (error) => {
       debug("Unable to open a file stream.");
-      this._handleFsError(error, response);
+      console.error(error);
+      if (response.headersSent) {
+        response.destroy();
+        resolve();
+        return;
+      }
+      response.statusCode = 500;
+      response.setHeader("Content-Type", "text/plain; charset=utf-8");
+      response.write("500 Internal Server Error");
+      response.end();
+      resolve();
     });
     fileStream.on("open", () => {
-      response.writeHead(200, {
-        "Content-Type": contentType,
-        "Content-Length": fileInfo.size
-      });
+      response.statusCode = 200;
+      response.setHeader("Content-Type", contentType);
+      response.setHeader("Content-Length", fileInfo.size);
       if (request.method === "HEAD") {
         response.end();
         debug("Response has been sent without a body for the HEAD request.");
@@ -372,35 +426,19 @@ var _HttpStaticRouter = class _HttpStaticRouter extends import_js_service.Debugg
       fileStream.pipe(response);
     });
     request.on("close", () => {
-      debug("File has been sent.");
-      fileStream.destroy();
+      if (!response.writableFinished) {
+        debug("Request closed prematurely by the client.");
+        fileStream.destroy();
+        resolve();
+      }
     });
-  }
-  /**
-   * Handle filesystem error.
-   *
-   * @param {object} error
-   * @param {object} response
-   * @returns {undefined}
-   */
-  _handleFsError(error, response) {
-    if (response.headersSent) {
-      response.destroy();
-      return;
-    }
-    if ("code" in error && error.code === "ENOENT") {
-      response.writeHead(404, { "Content-Type": "text/plain" });
-      response.write("404 Not Found");
-      response.end();
-    } else {
-      response.writeHead(500, { "Content-Type": "text/plain" });
-      response.write("500 Internal Server Error");
-      response.end();
-    }
+    response.on("finish", () => {
+      debug("File has been sent successfully.");
+      resolve();
+    });
+    return promise;
   }
 };
-__name(_HttpStaticRouter, "HttpStaticRouter");
-var HttpStaticRouter = _HttpStaticRouter;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   HttpStaticRouter,

package/example/server.js

@@ -1,3 +1,4 @@
+import path from 'path';
 import http from 'http';
 import {HttpStaticRouter} from '@e22m4u/js-http-static-router';
 
@@ -6,25 +7,33 @@ const staticRouter = new HttpStaticRouter({
   // при использовании опции "baseDir", относительные пути
   // в регистрируемых маршрутах будут разрешаться относительно
   // указанного адреса файловой системы
-  baseDir: import.meta.dirname,
+  baseDir: path.join(import.meta.dirname, '../static'),
 });
 
-// экспозиция содержимого директории "/static"
-// для доступа по адресу "/assets/{file_name}"
+// объявление файла "index.html"
+// в качестве индексной страницы
 staticRouter.defineRoute({
-  remotePath: '/assets',    // путь маршрута
-  resourcePath: './static', // файловый путь
+  remotePath: '/',
+  resourcePath: './index.html',
 });
 
-// объявление файла "./index.html"
-// для доступа по адресу "/home"
+// объявление файла "page.html"
+// доступным по адресу "/page"
 staticRouter.defineRoute({
-  remotePath: '/home',
-  resourcePath: './static/index.html',
+  remotePath: '/page',
+  resourcePath: './page.html',
+});
+
+// экспозиция содержимого директории "assets"
+// для доступа относительно корня
+// пример: http://localhost:3000/assets/rabbit.txt
+staticRouter.defineRoute({
+  remotePath: '/',
+  resourcePath: './assets',
 });
 
 // создание HTTP сервера и определение
-// функции для обработки запросов
+// слушателя для обработки запросов
 const server = new http.Server();
 server.on('request', async (req, res) => {
   const fileSent = await staticRouter.handleRequest(req, res);
@@ -38,7 +47,8 @@ server.on('request', async (req, res) => {
 server.listen(3000, () => {
   console.log('Server is running on http://localhost:3000');
   console.log('Try to open:');
-  console.log('http://localhost:3000/home');
-  console.log('http://localhost:3000/assets/file.txt');
-  console.log('http://localhost:3000/assets/nested/file.txt');
+  console.log('http://localhost:3000');
+  console.log('http://localhost:3000/page');
+  console.log('http://localhost:3000/rabbit.txt');
+  console.log('http://localhost:3000/nested/heart.txt');
 });

package/mocha.setup.js

@@ -0,0 +1,4 @@
+import * as chai from 'chai';
+import chaiAsPromised from 'chai-as-promised';
+
+chai.use(chaiAsPromised);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@e22m4u/js-http-static-router",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "description": "HTTP-маршрутизатор статичных ресурсов для Node.js",
   "author": "Mikhail Evstropov <e22m4u@yandex.ru>",
   "license": "MIT",
@@ -24,7 +24,7 @@
     "require": "./dist/cjs/index.cjs"
   },
   "engines": {
-    "node": ">=12"
+    "node": ">=18"
   },
   "scripts": {
     "lint": "tsc && eslint ./src",
@@ -39,6 +39,7 @@
   "dependencies": {
     "@e22m4u/js-format": "~0.4.0",
     "@e22m4u/js-service": "~0.6.1",
+    "http-errors": "~2.0.1",
     "mime-types": "~3.0.2"
   },
   "devDependencies": {
@@ -49,6 +50,7 @@
     "@types/mocha": "~10.0.10",
     "c8": "~11.0.0",
     "chai": "~6.2.2",
+    "chai-as-promised": "~8.0.2",
     "esbuild": "~0.27.3",
     "eslint": "~9.39.2",
     "eslint-config-prettier": "~10.1.8",

package/src/http-static-router.d.ts

@@ -1,6 +1,6 @@
 import {ServerResponse} from 'node:http';
 import {IncomingMessage} from 'node:http';
-import {StaticRouteDefinition} from './static-route.js';
+import {StaticRoute, StaticRouteDefinition} from './static-route.js';
 import {DebuggableService, ServiceContainer} from '@e22m4u/js-service';
 
 /**
@@ -14,6 +14,11 @@ export type HttpStaticRouterOptions = {
  * Http static router.
  */
 export declare class HttpStaticRouter extends DebuggableService {
+  /**
+   * Constructor.
+   */
+  constructor();
+  
   /**
    * Constructor.
    *
@@ -41,7 +46,7 @@ export declare class HttpStaticRouter extends DebuggableService {
    *
    * @param routeDef
    */
-  defineRoute(routeDef: StaticRouteDefinition): this;
+  defineRoute(routeDef: StaticRouteDefinition): StaticRoute;
 
   /**
    * Handle request.