@e22m4u/js-trie-router 0.7.2 → 0.7.3

package/dist/cjs/index.cjs

@@ -2071,12 +2071,28 @@ var _TrieRouterOptions = class _TrieRouterOptions {
    */
   _requestBodyBytesLimit = 512 * 1024;
   // 512kb
+  /**
+   * Request body bytes limit.
+   *
+   * @type {number}
+   */
+  get requestBodyBytesLimit() {
+    return this._requestBodyBytesLimit;
+  }
   /**
    * Ignored media types.
    *
    * @type {string[]}
    */
   _ignoredMediaTypes = [];
+  /**
+   * Ignored media types.
+   *
+   * @type {string[]}
+   */
+  get ignoredMediaTypes() {
+    return this._ignoredMediaTypes;
+  }
   /**
    * Constructor.
    *
@@ -2118,74 +2134,9 @@ var _TrieRouterOptions = class _TrieRouterOptions {
           this._ignoredMediaTypes.push(mediaTypeLc);
         }
       });
+      Object.freeze(this._ignoredMediaTypes);
     }
   }
-  /**
-   * Get request body bytes limit.
-   *
-   * @param {number} limit
-   * @returns {this}
-   */
-  setRequestBodyBytesLimit(limit) {
-    if (typeof limit !== "number" || limit < 0) {
-      throw new import_js_format18.InvalidArgumentError(
-        'Parameter "limit" must be a positive Number or 0, but %v was given.',
-        limit
-      );
-    }
-    this._requestBodyBytesLimit = limit;
-    return this;
-  }
-  /**
-   * Get request body bytes limit.
-   *
-   * @returns {number}
-   */
-  getRequestBodyBytesLimit() {
-    return this._requestBodyBytesLimit;
-  }
-  /**
-   * Get ignored media types.
-   *
-   * @param {string} mediaType
-   * @returns {this}
-   */
-  addIgnoredMediaType(mediaType) {
-    if (!mediaType || typeof mediaType !== "string") {
-      throw new import_js_format18.InvalidArgumentError(
-        'Parameter "mediaType" must be a non-empty String, but %v was given.',
-        mediaType
-      );
-    }
-    const mediaTypeLc = mediaType.toLowerCase();
-    if (!this._ignoredMediaTypes.includes(mediaTypeLc)) {
-      this._ignoredMediaTypes.push(mediaTypeLc);
-    }
-    return this;
-  }
-  /**
-   * Has ignored media type.
-   *
-   * @param {string} mediaType
-   * @returns {boolean}
-   */
-  hasIgnoredMediaType(mediaType) {
-    if (!mediaType || typeof mediaType !== "string") {
-      throw new import_js_format18.InvalidArgumentError(
-        'Parameter "mediaType" must be a non-empty String, but %v was given.',
-        mediaType
-      );
-    }
-    return this._ignoredMediaTypes.includes(mediaType.toLowerCase());
-  }
-  /**
-   * Get ignored media types.
-   *
-   * @returns {string[]}
-   */
-  getIgnoredMediaTypes() {
-    return this._ignoredMediaTypes.slice();
-  }
 };
 __name(_TrieRouterOptions, "TrieRouterOptions");
 var TrieRouterOptions = _TrieRouterOptions;
@@ -2307,12 +2258,13 @@ var _RequestBodyParser = class _RequestBodyParser extends DebuggableService {
       );
     }
     const options = this.getService(TrieRouterOptions);
-    const isMediaTypeIgnored = options.hasIgnoredMediaType(mediaType);
+    const mediaTypeLc = mediaType.toLowerCase();
+    const isMediaTypeIgnored = options.ignoredMediaTypes.includes(mediaTypeLc);
     if (isMediaTypeIgnored) {
       debug("Media type %v is ignored.", mediaType);
       return;
     }
-    const parser = this._parsers[mediaType.toLowerCase()];
+    const parser = this._parsers[mediaTypeLc];
     if (!parser) {
       throw createError(
         import_http_errors2.default.UnsupportedMediaType,
@@ -2320,7 +2272,7 @@ var _RequestBodyParser = class _RequestBodyParser extends DebuggableService {
         mediaType
       );
     }
-    const bodyBytesLimit = options.getRequestBodyBytesLimit();
+    const bodyBytesLimit = options.requestBodyBytesLimit;
     debug("Fetching a request body.");
     debug("Body limit is %v bytes.", bodyBytesLimit);
     return fetchRequestBody(request, bodyBytesLimit).then((rawBody) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@e22m4u/js-trie-router",
-  "version": "0.7.2",
+  "version": "0.7.3",
   "description": "HTTP маршрутизатор для Node.js на основе префиксного дерева",
   "author": "Mikhail Evstropov <e22m4u@yandex.ru>",
   "license": "MIT",

package/src/parsers/request-body-parser.js

@@ -147,14 +147,15 @@ export class RequestBodyParser extends DebuggableService {
     // если текущий медиа тип исключен
     // настройками, то парсинг пропускается
     const options = this.getService(TrieRouterOptions);
-    const isMediaTypeIgnored = options.hasIgnoredMediaType(mediaType);
+    const mediaTypeLc = mediaType.toLowerCase();
+    const isMediaTypeIgnored = options.ignoredMediaTypes.includes(mediaTypeLc);
     if (isMediaTypeIgnored) {
       debug('Media type %v is ignored.', mediaType);
       return;
     }
     // если парсер для текущего медиа типа
     // не определен, то выбрасывается ошибка
-    const parser = this._parsers[mediaType.toLowerCase()];
+    const parser = this._parsers[mediaTypeLc];
     if (!parser) {
       throw createError(
         HttpErrors.UnsupportedMediaType,
@@ -164,7 +165,7 @@ export class RequestBodyParser extends DebuggableService {
     }
     // определение максимального количества
     // байт, извлекаемых из тела запроса
-    const bodyBytesLimit = options.getRequestBodyBytesLimit();
+    const bodyBytesLimit = options.requestBodyBytesLimit;
     debug('Fetching a request body.');
     debug('Body limit is %v bytes.', bodyBytesLimit);
     // извлечение тела запроса для последующего

package/src/trie-router-options.d.ts

@@ -11,33 +11,19 @@ export type TrieRouterOptionsInput = {
  */
 export declare class TrieRouterOptions {
   /**
-   * Get request body bytes limit.
-   *
-   * @param limit
-   */
-  setRequestBodyBytesLimit(limit: number): this;
-
-  /**
-   * Get request body bytes limit.
+   * Request body bytes limit.
    */
-  getRequestBodyBytesLimit(): number;
+  get requestBodyBytesLimit(): number;
 
   /**
-   * Get ignored media types.
-   *
-   * @param mediaType
+   * Request body bytes limit.
    */
-  addIgnoredMediaType(mediaType: string): this;
+  get ignoredMediaTypes(): string[];
 
   /**
-   * Has ignored media type.
+   * Constructor.
    *
-   * @param mediaType
-   */
-  hasIgnoredMediaType(mediaType: string): boolean;
-
-  /**
-   * Get ignored media types.
+   * @param options
    */
-  getIgnoredMediaTypes(): string[];
+  constructor(options?: TrieRouterOptionsInput);
 }

package/src/trie-router-options.js

@@ -11,6 +11,15 @@ export class TrieRouterOptions {
    */
   _requestBodyBytesLimit = 512 * 1024; // 512kb
 
+  /**
+   * Request body bytes limit.
+   *
+   * @type {number}
+   */
+  get requestBodyBytesLimit() {
+    return this._requestBodyBytesLimit;
+  }
+
   /**
    * Ignored media types.
    *
@@ -18,6 +27,15 @@ export class TrieRouterOptions {
    */
   _ignoredMediaTypes = [];
 
+  /**
+   * Ignored media types.
+   *
+   * @type {string[]}
+   */
+  get ignoredMediaTypes() {
+    return this._ignoredMediaTypes;
+  }
+
   /**
    * Constructor.
    *
@@ -66,77 +84,7 @@ export class TrieRouterOptions {
           this._ignoredMediaTypes.push(mediaTypeLc);
         }
       });
+      Object.freeze(this._ignoredMediaTypes);
     }
   }
-
-  /**
-   * Get request body bytes limit.
-   *
-   * @param {number} limit
-   * @returns {this}
-   */
-  setRequestBodyBytesLimit(limit) {
-    if (typeof limit !== 'number' || limit < 0) {
-      throw new InvalidArgumentError(
-        'Parameter "limit" must be a positive Number or 0, but %v was given.',
-        limit,
-      );
-    }
-    this._requestBodyBytesLimit = limit;
-    return this;
-  }
-
-  /**
-   * Get request body bytes limit.
-   *
-   * @returns {number}
-   */
-  getRequestBodyBytesLimit() {
-    return this._requestBodyBytesLimit;
-  }
-
-  /**
-   * Get ignored media types.
-   *
-   * @param {string} mediaType
-   * @returns {this}
-   */
-  addIgnoredMediaType(mediaType) {
-    if (!mediaType || typeof mediaType !== 'string') {
-      throw new InvalidArgumentError(
-        'Parameter "mediaType" must be a non-empty String, but %v was given.',
-        mediaType,
-      );
-    }
-    const mediaTypeLc = mediaType.toLowerCase();
-    if (!this._ignoredMediaTypes.includes(mediaTypeLc)) {
-      this._ignoredMediaTypes.push(mediaTypeLc);
-    }
-    return this;
-  }
-
-  /**
-   * Has ignored media type.
-   *
-   * @param {string} mediaType
-   * @returns {boolean}
-   */
-  hasIgnoredMediaType(mediaType) {
-    if (!mediaType || typeof mediaType !== 'string') {
-      throw new InvalidArgumentError(
-        'Parameter "mediaType" must be a non-empty String, but %v was given.',
-        mediaType,
-      );
-    }
-    return this._ignoredMediaTypes.includes(mediaType.toLowerCase());
-  }
-
-  /**
-   * Get ignored media types.
-   *
-   * @returns {string[]}
-   */
-  getIgnoredMediaTypes() {
-    return this._ignoredMediaTypes.slice();
-  }
 }

package/src/trie-router-options.spec.js

@@ -87,210 +87,31 @@ describe('TrieRouterOptions', function () {
     it('should set the option "requestBodyBytesLimit" to the current instance', function () {
       const value = 10;
       const inst = new TrieRouterOptions({requestBodyBytesLimit: value});
-      expect(inst.getRequestBodyBytesLimit()).to.be.eq(value);
+      expect(inst.requestBodyBytesLimit).to.be.eq(value);
     });
 
     it('should add elements of the option "ignoredMediaTypes" to the current instance', function () {
       const value = ['text/plain', 'text/html'];
       const inst = new TrieRouterOptions({ignoredMediaTypes: value});
-      expect(inst.getIgnoredMediaTypes()).to.include(value[0]);
-      expect(inst.getIgnoredMediaTypes()).to.include(value[1]);
+      expect(inst.ignoredMediaTypes).to.be.eql(['text/plain', 'text/html']);
     });
 
     it('should add elements of the option "ignoredMediaTypes" without duplicates', function () {
       const value = ['text/plain', 'text/html', 'text/plain'];
       const inst = new TrieRouterOptions({ignoredMediaTypes: value});
-      expect(inst.getIgnoredMediaTypes()).to.be.eql([
-        'text/plain',
-        'text/html',
-      ]);
+      expect(inst.ignoredMediaTypes).to.be.eql(['text/plain', 'text/html']);
     });
 
-    it('should convert ignored media types to lower case', function () {
-      const inst = new TrieRouterOptions({ignoredMediaTypes: ['TEXT/PLAIN']});
-      expect(inst.getIgnoredMediaTypes()).to.be.eql(['text/plain']);
-    });
-  });
-
-  describe('setRequestBodyBytesLimit', function () {
-    it('should require the parameter "value" to be a positive number or zero', function () {
-      const throwable = v => () => {
-        const S = new TrieRouterOptions();
-        S.setRequestBodyBytesLimit(v);
-      };
-      const error = s =>
-        format(
-          'Parameter "limit" must be a positive Number or 0, but %s was given.',
-          s,
-        );
-      expect(throwable('str')).to.throw(error('"str"'));
-      expect(throwable('')).to.throw(error('""'));
-      expect(throwable(-1)).to.throw(error('-1'));
-      expect(throwable(true)).to.throw(error('true'));
-      expect(throwable(false)).to.throw(error('false'));
-      expect(throwable([])).to.throw(error('Array'));
-      expect(throwable({})).to.throw(error('Object'));
-      expect(throwable(undefined)).to.throw(error('undefined'));
-      expect(throwable(null)).to.throw(error('null'));
-      throwable(10)();
-      throwable(0)();
-    });
-
-    it('should set the option value to the current instance', function () {
-      const S = new TrieRouterOptions();
-      const customValue = 10;
-      S.setRequestBodyBytesLimit(customValue);
-      const res = S.getRequestBodyBytesLimit();
-      expect(res).to.be.eq(customValue);
-    });
-
-    it('should return the current instance to allow chaining', function () {
-      const S = new TrieRouterOptions();
-      const res = S.setRequestBodyBytesLimit(10);
-      expect(res).to.be.eq(S);
-    });
-  });
-
-  describe('getRequestBodyBytesLimit', function () {
-    it('should return a default value when the option is not specified', function () {
-      const defaultValue = 512 * 1024; // 512kb
-      const inst = new TrieRouterOptions();
-      expect(inst.getRequestBodyBytesLimit()).to.be.eq(defaultValue);
-    });
-
-    it('should return a value specified in the constructor', function () {
-      const customValue = 10;
-      const inst = new TrieRouterOptions({requestBodyBytesLimit: customValue});
-      expect(inst.getRequestBodyBytesLimit()).to.be.eq(customValue);
-    });
-  });
-
-  describe('addIgnoredMediaType', function () {
-    it('should require the parameter "mediaType" to be a non-empty String', function () {
-      const throwable = v => () => {
-        const S = new TrieRouterOptions();
-        S.addIgnoredMediaType(v);
-      };
-      const error = s =>
-        format(
-          'Parameter "mediaType" must be a non-empty String, ' +
-            'but %s was given.',
-          s,
-        );
-      expect(throwable('')).to.throw(error('""'));
-      expect(throwable(10)).to.throw(error('10'));
-      expect(throwable(0)).to.throw(error('0'));
-      expect(throwable(true)).to.throw(error('true'));
-      expect(throwable(false)).to.throw(error('false'));
-      expect(throwable([])).to.throw(error('Array'));
-      expect(throwable({})).to.throw(error('Object'));
-      expect(throwable(undefined)).to.throw(error('undefined'));
-      expect(throwable(null)).to.throw(error('null'));
-      throwable('text/plain')();
-    });
-
-    it('should add an ignored media type to the current instance', function () {
-      const S = new TrieRouterOptions();
-      const mediaType = 'text/plain';
-      expect(S.hasIgnoredMediaType(mediaType)).to.be.false;
-      S.addIgnoredMediaType(mediaType);
-      expect(S.hasIgnoredMediaType(mediaType)).to.be.true;
-    });
-
-    it('should return the current instance to allow chaining', function () {
-      const S = new TrieRouterOptions();
-      const res = S.addIgnoredMediaType('text/plain');
-      expect(res).to.be.eq(S);
-    });
-  });
-
-  describe('hasIgnoredMediaType', function () {
-    it('should require the parameter "mediaType" to be a non-empty String', function () {
-      const throwable = v => () => {
-        const S = new TrieRouterOptions();
-        S.hasIgnoredMediaType(v);
-      };
-      const error = s =>
-        format(
-          'Parameter "mediaType" must be a non-empty String, ' +
-            'but %s was given.',
-          s,
-        );
-      expect(throwable('')).to.throw(error('""'));
-      expect(throwable(10)).to.throw(error('10'));
-      expect(throwable(0)).to.throw(error('0'));
-      expect(throwable(true)).to.throw(error('true'));
-      expect(throwable(false)).to.throw(error('false'));
-      expect(throwable([])).to.throw(error('Array'));
-      expect(throwable({})).to.throw(error('Object'));
-      expect(throwable(undefined)).to.throw(error('undefined'));
-      expect(throwable(null)).to.throw(error('null'));
-      throwable('text/plain')();
-    });
-
-    it('should return true when the given type is registered', function () {
-      const S = new TrieRouterOptions();
-      const mediaType = 'text/plain';
-      expect(S.hasIgnoredMediaType(mediaType)).to.be.false;
-      S.addIgnoredMediaType(mediaType);
-      expect(S.hasIgnoredMediaType(mediaType)).to.be.true;
-    });
-
-    it('should lookup the media type in case-insensitive mode', function () {
-      const S = new TrieRouterOptions();
-      S.addIgnoredMediaType('TeXt/PlAiN');
-      expect(S.hasIgnoredMediaType('tExT/pLaIn')).to.be.true;
-    });
-
-    it('should not add duplicates even with different cases', function () {
-      const S = new TrieRouterOptions();
-      S.addIgnoredMediaType('text/plain');
-      S.addIgnoredMediaType('TEXT/PLAIN');
-      S.addIgnoredMediaType('text/plain');
-      const res = S.getIgnoredMediaTypes();
-      expect(res).to.have.lengthOf(1);
-      expect(res[0]).to.be.eq('text/plain');
-    });
-  });
-
-  describe('getIgnoredMediaTypes', function () {
-    it('should return media types specified in the constructor', function () {
-      const mediaTypes = ['text/plain', 'text/html'];
-      const S = new TrieRouterOptions({ignoredMediaTypes: mediaTypes});
-      const res = S.getIgnoredMediaTypes();
-      expect(res).to.be.eql(mediaTypes);
-    });
-
-    it('should return media types added by the "addIgnoredMediaType" method', function () {
-      const mediaTypes = ['text/plain', 'text/html'];
-      const S = new TrieRouterOptions();
-      S.addIgnoredMediaType(mediaTypes[0]);
-      S.addIgnoredMediaType(mediaTypes[1]);
-      const res = S.getIgnoredMediaTypes();
-      expect(res).to.be.eql(mediaTypes);
-    });
-
-    it('should combine media types specified by the constructor and the "addIgnoredMediaType" method', function () {
+    it('should freeze the option "ignoredMediaTypes" to prevent mutations', function () {
       const mediaTypes = ['text/plain', 'text/html'];
-      const S = new TrieRouterOptions({ignoredMediaTypes: [mediaTypes[0]]});
-      S.addIgnoredMediaType(mediaTypes[1]);
-      const res = S.getIgnoredMediaTypes();
-      expect(res).to.be.eql(mediaTypes);
+      const inst = new TrieRouterOptions({ignoredMediaTypes: mediaTypes});
+      const res = inst.ignoredMediaTypes;
+      expect(Object.isFrozen(res)).to.be.true;
     });
 
-    it('should return a clone of the media type list that prevents mutate the state', function () {
-      const mediaTypes = ['text/plain', 'text/html'];
-      const S = new TrieRouterOptions();
-      S.addIgnoredMediaType(mediaTypes[0]);
-      S.addIgnoredMediaType(mediaTypes[1]);
-      const res1 = S.getIgnoredMediaTypes();
-      const res2 = S.getIgnoredMediaTypes();
-      expect(res1).to.be.eql(mediaTypes);
-      expect(res2).to.be.eql(mediaTypes);
-      expect(res1).to.be.not.eq(res2);
-      res1[0] = '123';
-      const res3 = S.getIgnoredMediaTypes();
-      expect(res3).to.be.eql(mediaTypes);
+    it('should convert ignored media types to lower case', function () {
+      const inst = new TrieRouterOptions({ignoredMediaTypes: ['TEXT/PLAIN']});
+      expect(inst.ignoredMediaTypes).to.be.eql(['text/plain']);
     });
   });
 });

package/src/trie-router.spec.js

@@ -28,7 +28,7 @@ describe('TrieRouter', function () {
       const optionsInput = {requestBodyBytesLimit: 10};
       const router = new TrieRouter(optionsInput);
       const options = router.getService(TrieRouterOptions);
-      expect(options.getRequestBodyBytesLimit()).to.be.eq(10);
+      expect(options.requestBodyBytesLimit).to.be.eq(10);
     });
 
     it('should use the service container and the router options from parameters', function () {
@@ -37,7 +37,7 @@ describe('TrieRouter', function () {
       const router = new TrieRouter(container, optionsInput);
       const options = router.getService(TrieRouterOptions);
       expect(router.container).to.be.eq(container);
-      expect(options.getRequestBodyBytesLimit()).to.be.eq(10);
+      expect(options.requestBodyBytesLimit).to.be.eq(10);
     });
   });