@e22m4u/js-trie-router 0.7.5 → 0.7.6

package/README.md

@@ -16,6 +16,7 @@ HTTP маршрутизатор для Node.js на основе
 ## Содержание
 
 - [Установка](#установка)
+- [Расширения](#расширения)
 - [Использование](#использование)
   - [Параметры маршрутизатора](#параметры-маршрутизатора)
   - [Контекст запроса](#контекст-запроса)
@@ -54,6 +55,15 @@ import {TrieRouter} from '@e22m4u/js-trie-router';
 const {TrieRouter} = require('@e22m4u/js-trie-router');
 ```
 
+## Расширения
+
+Расширение функционала выполняется с помощью NPM модулей.
+
+| модуль                                                                                         | описание                                       |
+|------------------------------------------------------------------------------------------------|------------------------------------------------|
+| [@e22m4u/js-trie-router-cors](https://www.npmjs.com/package/@e22m4u/js-trie-router-cors)       | Модуль поддержки CORS (кросс-доменные запросы) |
+| [@e22m4u/js-trie-router-openapi](https://www.npmjs.com/package/@e22m4u/js-trie-router-openapi) | Генерация OpenAPI документа и валидация данных |
+
 ## Использование
 
 Базовый пример создания экземпляра роутера, объявления маршрута

package/dist/cjs/index.cjs

@@ -43,6 +43,7 @@ __export(index_exports, {
   RequestQueryParser: () => RequestQueryParser,
   Route: () => Route,
   RouteRegistry: () => RouteRegistry,
+  RouterBranch: () => RouterBranch,
   RouterDataSender: () => RouterDataSender,
   RouterErrorSender: () => RouterErrorSender,
   RouterHookInvoker: () => RouterHookInvoker,
@@ -65,12 +66,14 @@ __export(index_exports, {
   isResponseSent: () => isResponseSent,
   isWritableStream: () => isWritableStream,
   mergeDeep: () => mergeDeep,
+  mergeRouterBranchDefinitions: () => mergeRouterBranchDefinitions,
   parseContentType: () => parseContentType,
   parseCookieString: () => parseCookieString,
   parseJsonBody: () => parseJsonBody,
   toCamelCase: () => toCamelCase,
   toPascalCase: () => toPascalCase,
-  validateRouteDefinition: () => validateRouteDefinition
+  validateRouteDefinition: () => validateRouteDefinition,
+  validateRouterBranchDefinition: () => validateRouterBranchDefinition
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -2428,8 +2431,8 @@ var _RouterDataSender = class _RouterDataSender extends DebuggableService {
       return;
     }
     if (isReadableStream(data)) {
-      if (!response.getHeader("content-type")) {
-        response.setHeader("content-type", "application/octet-stream");
+      if (!response.getHeader("Content-Type")) {
+        response.setHeader("Content-Type", "application/octet-stream");
       }
       data.pipe(response);
       debug("Sending response with a Stream.");
@@ -2441,13 +2444,13 @@ var _RouterDataSender = class _RouterDataSender extends DebuggableService {
       case "boolean":
       case "object":
         if (Buffer.isBuffer(data)) {
-          if (!response.getHeader("content-type")) {
-            response.setHeader("content-type", "application/octet-stream");
+          if (!response.getHeader("Content-Type")) {
+            response.setHeader("Content-Type", "application/octet-stream");
           }
           debugMsg = "Buffer has been sent as binary data.";
         } else {
-          if (!response.getHeader("content-type")) {
-            response.setHeader("content-type", "application/json");
+          if (!response.getHeader("Content-Type")) {
+            response.setHeader("Content-Type", "application/json");
           }
           debugMsg = (0, import_js_format21.format)(
             "%v has been sent as JSON.",
@@ -2457,8 +2460,8 @@ var _RouterDataSender = class _RouterDataSender extends DebuggableService {
         }
         break;
       default:
-        if (!response.getHeader("content-type")) {
-          response.setHeader("content-type", "text/plain");
+        if (!response.getHeader("Content-Type")) {
+          response.setHeader("Content-Type", "text/plain");
         }
         debugMsg = "Response data has been sent as plain text.";
         data = String(data);
@@ -2525,7 +2528,7 @@ var _RouterErrorSender = class _RouterErrorSender extends DebuggableService {
       console.error(error);
     }
     response.statusCode = statusCode;
-    response.setHeader("content-type", "application/json; charset=utf-8");
+    response.setHeader("Content-Type", "application/json; charset=utf-8");
     response.end(JSON.stringify(body, null, 2), "utf-8");
     debug(
       "%s error has been sent for the request %s %v.",
@@ -2544,7 +2547,7 @@ var _RouterErrorSender = class _RouterErrorSender extends DebuggableService {
   send404(request, response) {
     const debug = this.getDebuggerFor(this.send404);
     response.statusCode = 404;
-    response.setHeader("content-type", "text/plain; charset=utf-8");
+    response.setHeader("Content-Type", "text/plain; charset=utf-8");
     response.end("404 Not Found", "utf-8");
     debug(
       "404 error has been sent for the request %s %v.",
@@ -2797,6 +2800,7 @@ var TrieRouter = _TrieRouter;
   RequestQueryParser,
   Route,
   RouteRegistry,
+  RouterBranch,
   RouterDataSender,
   RouterErrorSender,
   RouterHookInvoker,
@@ -2819,10 +2823,12 @@ var TrieRouter = _TrieRouter;
   isResponseSent,
   isWritableStream,
   mergeDeep,
+  mergeRouterBranchDefinitions,
   parseContentType,
   parseCookieString,
   parseJsonBody,
   toCamelCase,
   toPascalCase,
-  validateRouteDefinition
+  validateRouteDefinition,
+  validateRouterBranchDefinition
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@e22m4u/js-trie-router",
-  "version": "0.7.5",
+  "version": "0.7.6",
   "description": "HTTP маршрутизатор для Node.js на основе префиксного дерева",
   "author": "Mikhail Evstropov <e22m4u@yandex.ru>",
   "license": "MIT",
@@ -11,10 +11,10 @@
     "server",
     "nodejs"
   ],
-  "homepage": "https://gitrepos.ru/e22m4u/js-trie-router",
+  "homepage": "https://gitverse.ru/e22m4u/js-trie-router",
   "repository": {
     "type": "git",
-    "url": "git+https://gitrepos.ru/e22m4u/js-trie-router.git"
+    "url": "git+https://gitverse.ru/e22m4u/js-trie-router.git"
   },
   "type": "module",
   "types": "./src/index.d.ts",

package/src/index.d.ts

@@ -3,6 +3,7 @@ export * from './route/index.js';
 export * from './utils/index.js';
 export * from './hooks/index.js';
 export * from './trie-router.js';
+export * from './branch/index.js';
 export * from './parsers/index.js';
 export * from './senders/index.js';
 export * from './request-context.js';

package/src/index.js

@@ -3,6 +3,7 @@ export * from './route/index.js';
 export * from './utils/index.js';
 export * from './hooks/index.js';
 export * from './trie-router.js';
+export * from './branch/index.js';
 export * from './parsers/index.js';
 export * from './senders/index.js';
 export * from './request-context.js';

package/src/senders/router-data-sender.js

@@ -33,10 +33,10 @@ export class RouterDataSender extends DebuggableService {
     // если ответ контроллера является стримом,
     // то поток отправляет бинарные данные
     if (isReadableStream(data)) {
-      // если заголовок "content-type" не определен ранее,
+      // если заголовок "Content-Type" не определен ранее,
       // то устанавливается заголовок потоковых данных
-      if (!response.getHeader('content-type')) {
-        response.setHeader('content-type', 'application/octet-stream');
+      if (!response.getHeader('Content-Type')) {
+        response.setHeader('Content-Type', 'application/octet-stream');
       }
       data.pipe(response);
       debug('Sending response with a Stream.');
@@ -49,21 +49,21 @@ export class RouterDataSender extends DebuggableService {
       case 'number':
       case 'boolean':
       case 'object':
-        // для бинарных данных предусмотрен специальный "content-type",
+        // для бинарных данных предусмотрен специальный "Content-Type",
         // который устанавливается автоматически, если не был определен
         // ранее (к примеру, в обработчике маршрута)
         if (Buffer.isBuffer(data)) {
-          if (!response.getHeader('content-type')) {
-            response.setHeader('content-type', 'application/octet-stream');
+          if (!response.getHeader('Content-Type')) {
+            response.setHeader('Content-Type', 'application/octet-stream');
           }
           debugMsg = 'Buffer has been sent as binary data.';
         }
         // объекты, массивы, числа и логические значения
         // отправляются в виде JSON строки, с соответствующим
-        // заголовком "content-type" (если не был определен)
+        // заголовком "Content-Type" (если не был определен)
         else {
-          if (!response.getHeader('content-type')) {
-            response.setHeader('content-type', 'application/json');
+          if (!response.getHeader('Content-Type')) {
+            response.setHeader('Content-Type', 'application/json');
           }
           debugMsg = format(
             '%v has been sent as JSON.',
@@ -73,8 +73,8 @@ export class RouterDataSender extends DebuggableService {
         }
         break;
       default:
-        if (!response.getHeader('content-type')) {
-          response.setHeader('content-type', 'text/plain');
+        if (!response.getHeader('Content-Type')) {
+          response.setHeader('Content-Type', 'text/plain');
         }
         debugMsg = 'Response data has been sent as plain text.';
         data = String(data);

package/src/senders/router-data-sender.spec.js

@@ -80,7 +80,7 @@ describe('RouterDataSender', function () {
       writable._final = function (callback) {
         const sentData = Buffer.concat(chunks).toString('utf-8');
         expect(sentData).to.be.eq(data);
-        const ct = res.getHeader('content-type');
+        const ct = res.getHeader('Content-Type');
         expect(ct).to.be.eq('application/octet-stream');
         callback();
         done();
@@ -90,7 +90,7 @@ describe('RouterDataSender', function () {
       S.send(res, stream);
     });
 
-    it('should allow override the "content-type" header for a readable stream', function (done) {
+    it('should allow override the "Content-Type" header for a readable stream', function (done) {
       const data = 'text';
       const stream = new Readable();
       stream._read = () => {};
@@ -98,7 +98,7 @@ describe('RouterDataSender', function () {
       stream.push(null);
       const res = createResponseMock();
       const contentType = 'custom/type';
-      res.setHeader('content-type', contentType);
+      res.setHeader('Content-Type', contentType);
       const writable = new Writable();
       const chunks = [];
       writable._write = function (chunk, encoding, done) {
@@ -108,7 +108,7 @@ describe('RouterDataSender', function () {
       writable._final = function (callback) {
         const sentData = Buffer.concat(chunks).toString('utf-8');
         expect(sentData).to.be.eq(data);
-        const ct = res.getHeader('content-type');
+        const ct = res.getHeader('Content-Type');
         expect(ct).to.be.eq(contentType);
         callback();
         done();
@@ -131,7 +131,7 @@ describe('RouterDataSender', function () {
         const sentJson = Buffer.concat(chunks).toString('utf-8');
         const sentData = JSON.parse(sentJson);
         expect(sentData).to.be.eql(data);
-        const ct = res.getHeader('content-type');
+        const ct = res.getHeader('Content-Type');
         expect(ct).to.be.eq('application/json');
         callback();
         done();
@@ -141,11 +141,11 @@ describe('RouterDataSender', function () {
       S.send(res, data);
     });
 
-    it('should allow override the "content-type" header for a number value', function (done) {
+    it('should allow override the "Content-Type" header for a number value', function (done) {
       const data = 10;
       const res = createResponseMock();
       const contentType = 'custom/type';
-      res.setHeader('content-type', contentType);
+      res.setHeader('Content-Type', contentType);
       const writable = new Writable();
       const chunks = [];
       writable._write = function (chunk, encoding, done) {
@@ -156,7 +156,7 @@ describe('RouterDataSender', function () {
         const sentJson = Buffer.concat(chunks).toString('utf-8');
         const sentData = JSON.parse(sentJson);
         expect(sentData).to.be.eql(data);
-        const ct = res.getHeader('content-type');
+        const ct = res.getHeader('Content-Type');
         expect(ct).to.be.eq(contentType);
         callback();
         done();
@@ -179,7 +179,7 @@ describe('RouterDataSender', function () {
         const sentJson = Buffer.concat(chunks).toString('utf-8');
         const sentData = JSON.parse(sentJson);
         expect(sentData).to.be.eql(data);
-        const ct = res.getHeader('content-type');
+        const ct = res.getHeader('Content-Type');
         expect(ct).to.be.eq('application/json');
         callback();
         done();
@@ -189,11 +189,11 @@ describe('RouterDataSender', function () {
       S.send(res, data);
     });
 
-    it('should allow override the "content-type" header for a boolean value', function (done) {
+    it('should allow override the "Content-Type" header for a boolean value', function (done) {
       const data = true;
       const res = createResponseMock();
       const contentType = 'custom/type';
-      res.setHeader('content-type', contentType);
+      res.setHeader('Content-Type', contentType);
       const writable = new Writable();
       const chunks = [];
       writable._write = function (chunk, encoding, done) {
@@ -204,7 +204,7 @@ describe('RouterDataSender', function () {
         const sentJson = Buffer.concat(chunks).toString('utf-8');
         const sentData = JSON.parse(sentJson);
         expect(sentData).to.be.eql(data);
-        const ct = res.getHeader('content-type');
+        const ct = res.getHeader('Content-Type');
         expect(ct).to.be.eq(contentType);
         callback();
         done();
@@ -226,7 +226,7 @@ describe('RouterDataSender', function () {
       writable._final = function (callback) {
         const sentData = Buffer.concat(chunks);
         expect(sentData).to.be.eql(sentData);
-        const ct = res.getHeader('content-type');
+        const ct = res.getHeader('Content-Type');
         expect(ct).to.be.eq('application/octet-stream');
         callback();
         done();
@@ -236,11 +236,11 @@ describe('RouterDataSender', function () {
       S.send(res, data);
     });
 
-    it('should allow override the "content-type" header for a Buffer', function (done) {
+    it('should allow override the "Content-Type" header for a Buffer', function (done) {
       const data = Buffer.from('text');
       const res = createResponseMock();
       const contentType = 'custom/type';
-      res.setHeader('content-type', contentType);
+      res.setHeader('Content-Type', contentType);
       const writable = new Writable();
       const chunks = [];
       writable._write = function (chunk, encoding, done) {
@@ -250,7 +250,7 @@ describe('RouterDataSender', function () {
       writable._final = function (callback) {
         const sentData = Buffer.concat(chunks);
         expect(sentData).to.be.eql(sentData);
-        const ct = res.getHeader('content-type');
+        const ct = res.getHeader('Content-Type');
         expect(ct).to.be.eq(contentType);
         callback();
         done();
@@ -273,7 +273,7 @@ describe('RouterDataSender', function () {
         const sentJson = Buffer.concat(chunks).toString('utf-8');
         const sentData = JSON.parse(sentJson);
         expect(sentData).to.be.eql(data);
-        const ct = res.getHeader('content-type');
+        const ct = res.getHeader('Content-Type');
         expect(ct).to.be.eq('application/json');
         callback();
         done();
@@ -283,11 +283,11 @@ describe('RouterDataSender', function () {
       S.send(res, data);
     });
 
-    it('should allow override the "content-type" header for an object value', function (done) {
+    it('should allow override the "Content-Type" header for an object value', function (done) {
       const data = {foo: 'bar'};
       const res = createResponseMock();
       const contentType = 'custom/type';
-      res.setHeader('content-type', contentType);
+      res.setHeader('Content-Type', contentType);
       const writable = new Writable();
       const chunks = [];
       writable._write = function (chunk, encoding, done) {
@@ -298,7 +298,7 @@ describe('RouterDataSender', function () {
         const sentJson = Buffer.concat(chunks).toString('utf-8');
         const sentData = JSON.parse(sentJson);
         expect(sentData).to.be.eql(data);
-        const ct = res.getHeader('content-type');
+        const ct = res.getHeader('Content-Type');
         expect(ct).to.be.eq(contentType);
         callback();
         done();
@@ -320,7 +320,7 @@ describe('RouterDataSender', function () {
       writable._final = function (callback) {
         const sentData = Buffer.concat(chunks).toString('utf-8');
         expect(sentData).to.be.eq(data);
-        const ct = res.getHeader('content-type');
+        const ct = res.getHeader('Content-Type');
         expect(ct).to.be.eq('text/plain');
         callback();
         done();
@@ -330,11 +330,11 @@ describe('RouterDataSender', function () {
       S.send(res, data);
     });
 
-    it('should allow override the "content-type" header for a string value', function (done) {
+    it('should allow override the "Content-Type" header for a string value', function (done) {
       const data = 'text';
       const res = createResponseMock();
       const contentType = 'custom/type';
-      res.setHeader('content-type', contentType);
+      res.setHeader('Content-Type', contentType);
       const writable = new Writable();
       const chunks = [];
       writable._write = function (chunk, encoding, done) {
@@ -344,7 +344,7 @@ describe('RouterDataSender', function () {
       writable._final = function (callback) {
         const sentData = Buffer.concat(chunks).toString('utf-8');
         expect(sentData).to.be.eq(data);
-        const ct = res.getHeader('content-type');
+        const ct = res.getHeader('Content-Type');
         expect(ct).to.be.eq(contentType);
         callback();
         done();

package/src/senders/router-error-sender.js

@@ -63,7 +63,7 @@ export class RouterErrorSender extends DebuggableService {
       console.error(error);
     }
     response.statusCode = statusCode;
-    response.setHeader('content-type', 'application/json; charset=utf-8');
+    response.setHeader('Content-Type', 'application/json; charset=utf-8');
     response.end(JSON.stringify(body, null, 2), 'utf-8');
     debug(
       '%s error has been sent for the request %s %v.',
@@ -83,7 +83,7 @@ export class RouterErrorSender extends DebuggableService {
   send404(request, response) {
     const debug = this.getDebuggerFor(this.send404);
     response.statusCode = 404;
-    response.setHeader('content-type', 'text/plain; charset=utf-8');
+    response.setHeader('Content-Type', 'text/plain; charset=utf-8');
     response.end('404 Not Found', 'utf-8');
     debug(
       '404 error has been sent for the request %s %v.',

package/src/senders/router-error-sender.spec.js

@@ -25,7 +25,7 @@ describe('RouterErrorSender', function () {
         const data = JSON.parse(json);
         expect(data).to.be.eql({error: {message: 'Unauthorized'}});
         expect(res.statusCode).to.be.eq(401);
-        const ct = res.getHeader('content-type');
+        const ct = res.getHeader('Content-Type');
         expect(ct).to.be.eq('application/json; charset=utf-8');
         callback();
         done();
@@ -57,7 +57,7 @@ describe('RouterErrorSender', function () {
         expect(data.error).not.to.have.property('shouldNotBeExposedProp');
         expect(data).to.be.eql(expectedData);
         expect(res.statusCode).to.be.eq(401);
-        const ct = res.getHeader('content-type');
+        const ct = res.getHeader('Content-Type');
         expect(ct).to.be.eq('application/json; charset=utf-8');
         callback();
         done();
@@ -82,7 +82,7 @@ describe('RouterErrorSender', function () {
         const body = Buffer.concat(chunks).toString('utf-8');
         expect(body).to.be.eql('404 Not Found');
         expect(res.statusCode).to.be.eq(404);
-        const ct = res.getHeader('content-type');
+        const ct = res.getHeader('Content-Type');
         expect(ct).to.be.eq('text/plain; charset=utf-8');
         callback();
         done();