@e22m4u/js-trie-router 0.0.16 → 0.0.18

package/README.md

@@ -1,25 +1,23 @@
 ## @e22m4u/js-trie-router
 
-*English | [Русский](./README-ru.md)*
+HTTP маршрутизатор для Node.js на основе
+[префиксного дерева](https://ru.wikipedia.org/wiki/Trie) (trie).
 
-HTTP router for Node.js based on
-a [prefix tree](https://en.wikipedia.org/wiki/Trie) (trie).
+- Поддержка [path-to-regexp](https://github.com/pillarjs/path-to-regexp) синтаксиса.
+- Автоматический парсинг JSON-тела запроса.
+- Парсинг строки запроса и заголовка `cookie`.
+- Поддержка `preHandler` и `postHandler` хуков.
+- Позволяет использовать асинхронные обработчики.
 
-- Supports [path-to-regexp](https://github.com/pillarjs/path-to-regexp) syntax.
-- Parses JSON request body automatically.
-- Parses query string and `cookie` header.
-- Supports `preHandler` and `postHandler` hooks.
-- Supports asynchronous handlers.
+## Установка
 
-## Installation
-
-Node.js 16 or higher is required.
+Требуется Node.js 16 и выше.
 
 ```bash
 npm install @e22m4u/js-trie-router
 ```
 
-The module supports ESM and CommonJS standards.
+Модуль поддерживает ESM и CommonJS стандарты.
 
 *ESM*
 
@@ -33,51 +31,51 @@ import {TrieRouter} from '@e22m4u/js-trie-router';
 const {TrieRouter} = require('@e22m4u/js-trie-router');
 ```
 
-## Overview
+## Обзор
 
-A basic example of creating a router instance, defining
-a route and startup Node.js HTTP server.
+Базовый пример создания экземпляра роутера, объявления маршрута
+и передачи слушателя запросов HTTP серверу.
 
 ```js
 import http from 'http';
 import {TrieRouter} from '@e22m4u/js-trie-router';
 
-const server = new http.Server(); // Node.js HTTP server
-const router = new TrieRouter();  // TrieRouter instance
+const server = new http.Server(); // создание экземпляра HTTP сервера
+const router = new TrieRouter();  // создание экземпляра роутера
 
-router.defineRoute({              // route definition
-  method: 'GET',                  // request method "GET", "POST", etc.
-  path: '/',                      // path template, example "/user/:id"
-  handler(ctx) {                  // route handler
+router.defineRoute({
+  method: 'GET',                  // метод запроса "GET", "POST" и т.д.
+  path: '/',                      // шаблон пути, пример "/user/:id"
+  handler(ctx) {                  // обработчик маршрута
     return 'Hello world!';
   },
 });
 
-server.on('request', router.requestListener); // inject request listener
-server.listen(3000, 'localhost');             // listen for requests
+server.on('request', router.requestListener); // подключение роутера
+server.listen(3000, 'localhost');             // прослушивание запросов
 
 // Open in browser http://localhost:3000
 ```
 
-### Request context
+### Контекст запроса
 
-The first parameter of a route handler is an instance
-of the `RequestContext` class which has a properties
-set with contents of a parsed incoming request.
+Первый параметр обработчика маршрута принимает экземпляр класса
+`RequestContext` с набором свойств, содержащих разобранные
+данные входящего запроса.
 
-- `container: ServiceContainer` instance of [service container](https://npmjs.com/package/@e22m4u/js-service)
-- `req: IncomingMessage` native incoming request stream
-- `res: ServerResponse` native server response stream
-- `params: ParsedParams` key-value object with path parameters
-- `query: ParsedQuery` key-value object with query string parameters
-- `headers: ParsedHeaders` key-value object with request headers
-- `cookie: ParsedCookie` key-value object of parsed `cookie` header
-- `method: string` request method in uppercase, e.g. `GET`, `POST`, etc.
-- `path: string` path including query string, e.g. `/myPath?foo=bar`
-- `pathname: string` request path, e.g. `/myMath`
-- `body: unknown` request body
+- `container: ServiceContainer` экземпляр [сервис-контейнера](https://npmjs.com/package/@e22m4u/js-service)
+- `req: IncomingMessage` нативный поток входящего запроса
+- `res: ServerResponse` нативный поток ответа сервера
+- `params: ParsedParams` объект ключ-значение с параметрами пути
+- `query: ParsedQuery` объект ключ-значение с параметрами строки запроса
+- `headers: ParsedHeaders` объект ключ-значение с заголовками запроса 
+- `cookie: ParsedCookie` объект ключ-значение разобранного заголовка `cookie`
+- `method: string` метод запроса в верхнем регистре, например `GET`, `POST` и т.д.
+- `path: string` путь включающий строку запроса, например `/myPath?foo=bar`
+- `pathname: string` путь запроса, например `/myMath`
+- `body: unknown` тело запроса
 
-Example of accessing the context from a route handler.
+Пример доступа к контексту из обработчика маршрута.
 
 ```js
 router.defineRoute({
@@ -100,12 +98,12 @@ router.defineRoute({
 });
 ```
 
-### Response sending
+### Отправка ответа
 
-Return value of a route handler is used as response data.
-Value type affects representation of a response data. For example,
-if a response data is of type `object`, it will be automatically
-serialized to JSON.
+Возвращаемое значение обработчика маршрута используется в качестве ответа
+сервера. Тип значения влияет на представление возвращаемых данных. Например,
+если результатом будет являться тип `object`, то такое значение автоматически
+сериализуется в JSON.
 
 | value     | content-type             |
 |-----------|--------------------------|
@@ -116,20 +114,19 @@ serialized to JSON.
 | `Buffer`  | application/octet-stream |
 | `Stream`  | application/octet-stream |
 
-Example of sending data as JSON.
+Пример возвращаемого значения обработчиком маршрута.
 
 ```js
-router.defineRoute({     // register a route
+router.defineRoute({     // регистрация маршрута
   // ...
-  handler(ctx) {         // incoming request handler
-    return {foo: 'bar'}; // response will be encoded to JSON
+  handler(ctx) {         // обработчик входящего запроса
+    return {foo: 'bar'}; // ответ будет представлен в виде JSON
   },
 });
 ```
 
-The request context `ctx` contains a native instance
-of the `ServerResponse` class from the `http` module,
-which can be used for manual response management.
+Контекст запроса `ctx` содержит нативный экземпляр класса `ServerResponse`
+модуля `http`, который может быть использован для ручного управления ответом.
 
 ```js
 router.defineRoute({
@@ -142,27 +139,27 @@ router.defineRoute({
 });
 ```
 
-### Route hooks
+### Хуки маршрута
 
-Defining a route with the `defineRoute` method allows
-to set up hooks to monitor and intercept requests and
-responses for a specific route.
+Определение маршрута методом `defineRoute` позволяет задать хуки
+для отслеживания и перехвата входящего запроса и ответа
+конкретного маршрута.
 
-- `preHandler` executes before a route handler
-- `postHandler` executes after a route handler
+- `preHandler` выполняется перед вызовом обработчика
+- `postHandler` выполняется после вызова обработчика
 
 #### preHandler
 
-Before calling a route handler, operations such as authorization
-and request validation may be performed in the `preHandler`
-hook.
+Перед вызовом обработчика маршрута может потребоваться выполнение
+таких операции как авторизация и проверка параметров запроса. Для
+этого можно использовать хук `preHandler`.
 
 ```js
-router.defineRoute({ // register a route
+router.defineRoute({ // регистрация маршрута
   // ...
   preHandler(ctx) {
-    // before the route handler
-    console.log(`incoming request ${ctx.method} ${ctx.path}`);
+    // перед обработчиком маршрута
+    console.log(`Incoming request ${ctx.method} ${ctx.path}`);
     // > incoming request GET /myPath
   },
   handler(ctx) {
@@ -171,86 +168,85 @@ router.defineRoute({ // register a route
 });
 ```
 
-A route handler will not be called if `preHandler` hook
-returns a value other than `undefined` and `null`, because
-that value will be sent as response data.
+Если хук `preHandler` возвращает значение отличное от `undefined` и `null`,
+то такое значение будет использовано в качестве ответа сервера, а вызов
+обработчика маршрута будет пропущен.
 
 ```js
-router.defineRoute({ // register a route
+router.defineRoute({ // регистрация маршрута
   // ...
   preHandler(ctx) {
-    // return the response data
+    // возвращение ответа сервера
     return 'Are you authorized?';
   },
   handler(ctx) {
-    // this handler will not be called
-    // because the "preHandler" hook
-    // has already sent the data
+    // данный обработчик не будет вызван, так как
+    // хук "preHandler" уже отправил ответ
   },
 });
 ```
 
 #### postHandler
 
-Return value of a route handler is passed to the second
-parameter of `postHandler` hook. It may be useful to modify
-the value before being sent.
+Возвращаемое значение обработчика маршрута передается вторым аргументом
+хука `postHandler`. По аналогии с `preHandler`, если возвращаемое
+значение отличается от `undefined` и `null`, то такое значение будет
+использовано в качестве ответа сервера. Это может быть полезно для
+модификации возвращаемого ответа.
 
 ```js
 router.defineRoute({
   // ...
   handler(ctx) {
-    // return the response data
     return 'Hello world!';
   },
   postHandler(ctx, data) {
-    // modify the response data before send
+    // после обработчика маршрута
     return data.toUpperCase(); // HELLO WORLD!
   },
 });
 ```
 
-### Global hooks
+### Глобальные хуки
 
-A `TrieRouter` instance allows to set up global hooks
-that have higher priority over route hooks and are
-called first.
+Экземпляр роутера `TrieRouter` позволяет задать глобальные хуки, которые
+имеют более высокий приоритет перед хуками маршрута, и вызываются
+в первую очередь.
 
-- `preHandler` executes before each route handler
-- `postHandler` executes after each route handler
+- `preHandler` выполняется перед вызовом обработчика каждого маршрута
+- `postHandler` выполняется после вызова обработчика каждого маршрута
 
-Global hooks can be added using the `addHook` method
-of a router instance, where the first parameter
-is the hook name and the second is a function.
+Добавить глобальные хуки можно методом `addHook` экземпляра роутера,
+где первым параметром передается название хука, а вторым его функция.
 
 ```js
 router.addHook('preHandler', (ctx) => {
-  // before a route handler
+  // перед обработчиком маршрута
 });
 
 router.addHook('postHandler', (ctx, data) => {
-  // after a route handler
+  // после обработчика маршрута
 });
 ```
 
-Similar to route hooks, if a global hook returns
-a value other than `undefined` and `null`, that
-value will be sent as response data.
+Аналогично хукам маршрута, если глобальный хук возвращает значение
+отличное от `undefined` и `null`, то такое значение будет использовано
+как ответ сервера.
 
-## Debugging
+## Отладка
 
-Set the `DEBUG` variable to enable log output.
+Установка переменной `DEBUG` включает вывод логов.
 
 ```bash
 DEBUG=jsTrieRouter* npm run test
 ```
 
-## Testing
+## Тестирование
 
 ```bash
 npm run test
 ```
 
-## License
+## Лицензия
 
 MIT

package/dist/cjs/index.cjs

@@ -29,8 +29,8 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.js
-var src_exports = {};
-__export(src_exports, {
+var index_exports = {};
+__export(index_exports, {
   BUFFER_ENCODING_LIST: () => BUFFER_ENCODING_LIST,
   BodyParser: () => BodyParser,
   CookieParser: () => CookieParser,
@@ -66,7 +66,7 @@ __export(src_exports, {
   parseJsonBody: () => parseJsonBody,
   toCamelCase: () => toCamelCase
 });
-module.exports = __toCommonJS(src_exports);
+module.exports = __toCommonJS(index_exports);
 
 // src/route.js
 var import_js_format14 = require("@e22m4u/js-format");

package/package.json

@@ -1,7 +1,21 @@
 {
   "name": "@e22m4u/js-trie-router",
-  "version": "0.0.16",
-  "description": "HTTP router for Node.js based on a prefix tree",
+  "version": "0.0.18",
+  "description": "HTTP маршрутизатор для Node.js на основе префиксного дерева",
+  "author": "e22m4u <e22m4u@yandex.ru>",
+  "license": "MIT",
+  "keywords": [
+    "router",
+    "trie",
+    "http",
+    "server",
+    "nodejs"
+  ],
+  "homepage": "https://github.com/e22m4u/js-trie-router",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/e22m4u/js-trie-router.git"
+  },
   "type": "module",
   "types": "./src/index.d.ts",
   "module": "./src/index.js",
@@ -23,47 +37,33 @@
     "build:cjs": "rimraf ./dist/cjs && node --no-warnings=ExperimentalWarning build-cjs.js",
     "prepare": "husky"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/e22m4u/js-trie-router.git"
-  },
-  "keywords": [
-    "router",
-    "trie",
-    "http",
-    "server",
-    "nodejs"
-  ],
-  "author": "e22m4u <e22m4u@yandex.ru>",
-  "license": "MIT",
-  "homepage": "https://github.com/e22m4u/js-trie-router",
   "dependencies": {
-    "@e22m4u/js-format": "~0.1.7",
-    "@e22m4u/js-path-trie": "~0.0.8",
-    "@e22m4u/js-service": "~0.1.11",
-    "debug": "~4.3.7",
+    "@e22m4u/js-format": "~0.1.0",
+    "@e22m4u/js-path-trie": "~0.0.1",
+    "@e22m4u/js-service": "~0.2.0",
+    "debug": "~4.4.0",
     "http-errors": "~2.0.0",
     "statuses": "~2.0.1"
   },
   "devDependencies": {
-    "@commitlint/cli": "~19.6.0",
-    "@commitlint/config-conventional": "~19.6.0",
-    "@eslint/js": "~9.15.0",
-    "@types/chai-as-promised": "~8.0.1",
-    "c8": "~10.1.2",
-    "chai": "~5.1.2",
-    "chai-as-promised": "~8.0.0",
-    "esbuild": "~0.24.0",
-    "eslint": "~9.15.0",
-    "eslint-config-prettier": "~9.1.0",
+    "@commitlint/cli": "~19.8.0",
+    "@commitlint/config-conventional": "~19.8.0",
+    "@eslint/js": "~9.25.1",
+    "@types/chai-as-promised": "~8.0.2",
+    "c8": "~10.1.3",
+    "chai": "~5.2.0",
+    "chai-as-promised": "~8.0.1",
+    "esbuild": "~0.25.3",
+    "eslint": "~9.25.1",
+    "eslint-config-prettier": "~10.1.2",
     "eslint-plugin-chai-expect": "~3.1.0",
-    "eslint-plugin-jsdoc": "~50.5.0",
+    "eslint-plugin-jsdoc": "~50.6.10",
     "eslint-plugin-mocha": "~10.5.0",
-    "globals": "~15.12.0",
+    "globals": "~16.0.0",
     "husky": "~9.1.7",
-    "mocha": "~10.8.2",
-    "prettier": "~3.3.3",
-    "rimraf": "^6.0.1",
-    "typescript": "~5.7.2"
+    "mocha": "~11.1.0",
+    "prettier": "~3.5.3",
+    "rimraf": "~6.0.1",
+    "typescript": "~5.8.3"
   }
 }

package/README-ru.md

@@ -1,254 +0,0 @@
-## @e22m4u/js-trie-router
-
-*[English](./README.md) | Русский*
-
-HTTP роутер для Node.js на основе
-[префиксного дерева](https://ru.wikipedia.org/wiki/Trie) (trie).
-
-- Поддержка [path-to-regexp](https://github.com/pillarjs/path-to-regexp) синтаксиса.
-- Автоматический парсинг JSON-тела запроса.
-- Парсинг строки запроса и заголовка `cookie`.
-- Поддержка `preHandler` и `postHandler` хуков.
-- Позволяет использовать асинхронные обработчики.
-
-## Установка
-
-Требуется Node.js 16 и выше.
-
-```bash
-npm install @e22m4u/js-trie-router
-```
-
-Модуль поддерживает ESM и CommonJS стандарты.
-
-*ESM*
-
-```js
-import {TrieRouter} from '@e22m4u/js-trie-router';
-```
-
-*CommonJS*
-
-```js
-const {TrieRouter} = require('@e22m4u/js-trie-router');
-```
-
-## Обзор
-
-Базовый пример создания экземпляра роутера, объявления маршрута
-и передачи слушателя запросов HTTP серверу.
-
-```js
-import http from 'http';
-import {TrieRouter} from '@e22m4u/js-trie-router';
-
-const server = new http.Server(); // создание экземпляра HTTP сервера
-const router = new TrieRouter();  // создание экземпляра роутера
-
-router.defineRoute({
-  method: 'GET',                  // метод запроса "GET", "POST" и т.д.
-  path: '/',                      // шаблон пути, пример "/user/:id"
-  handler(ctx) {                  // обработчик маршрута
-    return 'Hello world!';
-  },
-});
-
-server.on('request', router.requestListener); // подключение роутера
-server.listen(3000, 'localhost');             // прослушивание запросов
-
-// Open in browser http://localhost:3000
-```
-
-### Контекст запроса
-
-Первый параметр обработчика маршрута принимает экземпляр класса
-`RequestContext` с набором свойств, содержащих разобранные
-данные входящего запроса.
-
-- `container: ServiceContainer` экземпляр [сервис-контейнера](https://npmjs.com/package/@e22m4u/js-service)
-- `req: IncomingMessage` нативный поток входящего запроса
-- `res: ServerResponse` нативный поток ответа сервера
-- `params: ParsedParams` объект ключ-значение с параметрами пути
-- `query: ParsedQuery` объект ключ-значение с параметрами строки запроса
-- `headers: ParsedHeaders` объект ключ-значение с заголовками запроса 
-- `cookie: ParsedCookie` объект ключ-значение разобранного заголовка `cookie`
-- `method: string` метод запроса в верхнем регистре, например `GET`, `POST` и т.д.
-- `path: string` путь включающий строку запроса, например `/myPath?foo=bar`
-- `pathname: string` путь запроса, например `/myMath`
-- `body: unknown` тело запроса
-
-Пример доступа к контексту из обработчика маршрута.
-
-```js
-router.defineRoute({
-  method: 'GET',
-  path: '/users/:id',
-  handler(ctx) {
-    // GET /users/10?include=city
-    // Cookie: foo=bar; baz=qux;
-    console.log(ctx.req);      // IncomingMessage
-    console.log(ctx.res);      // ServerResponse
-    console.log(ctx.params);   // {id: 10}
-    console.log(ctx.query);    // {include: 'city'}
-    console.log(ctx.headers);  // {cookie: 'foo=bar; baz=qux;'}
-    console.log(ctx.cookie);   // {foo: 'bar', baz: 'qux'}
-    console.log(ctx.method);   // "GET"
-    console.log(ctx.path);     // "/users/10?include=city"
-    console.log(ctx.pathname); // "/users/10"
-    // ...
-  },
-});
-```
-
-### Отправка ответа
-
-Возвращаемое значение обработчика маршрута используется в качестве ответа
-сервера. Тип значения влияет на представление возвращаемых данных. Например,
-если результатом будет являться тип `object`, то такое значение автоматически
-сериализуется в JSON.
-
-| value     | content-type             |
-|-----------|--------------------------|
-| `string`  | text/plain               |
-| `number`  | application/json         |
-| `boolean` | application/json         |
-| `object`  | application/json         |
-| `Buffer`  | application/octet-stream |
-| `Stream`  | application/octet-stream |
-
-Пример возвращаемого значения обработчиком маршрута.
-
-```js
-router.defineRoute({     // регистрация маршрута
-  // ...
-  handler(ctx) {         // обработчик входящего запроса
-    return {foo: 'bar'}; // ответ будет представлен в виде JSON
-  },
-});
-```
-
-Контекст запроса `ctx` содержит нативный экземпляр класса `ServerResponse`
-модуля `http`, который может быть использован для ручного управления ответом.
-
-```js
-router.defineRoute({
-  // ...
-  handler(ctx) {
-    res.statusCode = 404;
-    res.setHeader('content-type', 'text/plain; charset=utf-8');
-    res.end('404 Not Found', 'utf-8');
-  },
-});
-```
-
-### Хуки маршрута
-
-Определение маршрута методом `defineRoute` позволяет задать хуки
-для отслеживания и перехвата входящего запроса и ответа
-конкретного маршрута.
-
-- `preHandler` выполняется перед вызовом обработчика
-- `postHandler` выполняется после вызова обработчика
-
-#### preHandler
-
-Перед вызовом обработчика маршрута может потребоваться выполнение
-таких операции как авторизация и проверка параметров запроса. Для
-этого можно использовать хук `preHandler`.
-
-```js
-router.defineRoute({ // регистрация маршрута
-  // ...
-  preHandler(ctx) {
-    // перед обработчиком маршрута
-    console.log(`Incoming request ${ctx.method} ${ctx.path}`);
-    // > incoming request GET /myPath
-  },
-  handler(ctx) {
-    return 'Hello world!';
-  },
-});
-```
-
-Если хук `preHandler` возвращает значение отличное от `undefined` и `null`,
-то такое значение будет использовано в качестве ответа сервера, а вызов
-обработчика маршрута будет пропущен.
-
-```js
-router.defineRoute({ // регистрация маршрута
-  // ...
-  preHandler(ctx) {
-    // возвращение ответа сервера
-    return 'Are you authorized?';
-  },
-  handler(ctx) {
-    // данный обработчик не будет вызван, так как
-    // хук "preHandler" уже отправил ответ
-  },
-});
-```
-
-#### postHandler
-
-Возвращаемое значение обработчика маршрута передается вторым аргументом
-хука `postHandler`. По аналогии с `preHandler`, если возвращаемое
-значение отличается от `undefined` и `null`, то такое значение будет
-использовано в качестве ответа сервера. Это может быть полезно для
-модификации возвращаемого ответа.
-
-```js
-router.defineRoute({
-  // ...
-  handler(ctx) {
-    return 'Hello world!';
-  },
-  postHandler(ctx, data) {
-    // после обработчика маршрута
-    return data.toUpperCase(); // HELLO WORLD!
-  },
-});
-```
-
-### Глобальные хуки
-
-Экземпляр роутера `TrieRouter` позволяет задать глобальные хуки, которые
-имеют более высокий приоритет перед хуками маршрута, и вызываются
-в первую очередь.
-
-- `preHandler` выполняется перед вызовом обработчика каждого маршрута
-- `postHandler` выполняется после вызова обработчика каждого маршрута
-
-Добавить глобальные хуки можно методом `addHook` экземпляра роутера,
-где первым параметром передается название хука, а вторым его функция.
-
-```js
-router.addHook('preHandler', (ctx) => {
-  // перед обработчиком маршрута
-});
-
-router.addHook('postHandler', (ctx, data) => {
-  // после обработчика маршрута
-});
-```
-
-Аналогично хукам маршрута, если глобальный хук возвращает значение
-отличное от `undefined` и `null`, то такое значение будет использовано
-как ответ сервера.
-
-## Отладка
-
-Установка переменной `DEBUG` включает вывод логов.
-
-```bash
-DEBUG=jsTrieRouter* npm run test
-```
-
-## Тестирование
-
-```bash
-npm run test
-```
-
-## Лицензия
-
-MIT