@thi.ng/bencode 2.1.4 → 2.1.7

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2021-12-13T10:26:00Z
+- **Last updated**: 2022-05-07T11:33:35Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,14 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+### [2.1.6](https://github.com/thi-ng/umbrella/tree/@thi.ng/bencode@2.1.6) (2022-04-07)
+
+#### 🩹 Bug fixes
+
+- fix [#342](https://github.com/thi-ng/umbrella/issues/342), support signed ints ([66615be](https://github.com/thi-ng/umbrella/commit/66615be))
+  - add inf/NaN checks
+  - add tests
+
 ## [2.1.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/bencode@2.1.0) (2021-11-17)
 
 #### 🚀 Features

package/README.md

@@ -30,7 +30,7 @@ decoder for structured data.
 
 #### Booleans
 
-Will be converted to `0` or `1`.
+Will be converted to `0` or `1` integers.
 
 #### String handling
 
@@ -40,13 +40,14 @@ Bencode strings (e.g. `len:xxx...`), but are used as is.
 
 #### Floating point values
 
-This implementation has optional (non-standard) support for floating
-point values. If these are not desired (e.g. for compatibility reasons),
-all numeric values MUST be pre-rounded to integers. The encoder only
-chooses the custom float encoding iff a number has a fractional part.
-Floats are encoded similarly to standard ints (i.e. as text), but using
-`f` as prefix. Furthermore, only floats with an absolute value in the
-semi-open `[1e-6,1e21)` interval can be encoded.
+This implementation has optional (non-standard) support for floating point
+values. If these are not desired (e.g. for compatibility reasons), all numeric
+values MUST be pre-rounded to integers. The encoder only chooses the custom
+float encoding iff a number has a fractional part. Floats are encoded similarly
+to standard ints (i.e. as text), but using `f` as prefix. Furthermore, only
+floats with an absolute value in the semi-open `[1e-6,1e21)` interval can be
+encoded. Float values requiring exponential notation will throw an error during
+encoding.
 
 ### Status
 
@@ -77,7 +78,7 @@ node --experimental-repl-await
 > const bencode = await import("@thi.ng/bencode");
 ```
 
-Package sizes (gzipped, pre-treeshake): ESM: 1.22 KB
+Package sizes (gzipped, pre-treeshake): ESM: 1.30 KB
 
 ## Dependencies
 
@@ -135,4 +136,4 @@ If this project contributes to an academic publication, please cite it as:
 
 ## License
 
-© 2016 - 2021 Karsten Schmidt // Apache Software License 2.0
+© 2016 - 2022 Karsten Schmidt // Apache Software License 2.0

package/decode.js

@@ -91,13 +91,18 @@ const collect = (stack, x, utf8 = false) => {
 const readInt = (iter, acc, end = 101 /* END */) => {
     let i;
     let x;
+    let isSigned = false;
     while (!(i = iter.next()).done) {
         x = i.value;
         if (x >= 48 /* ZERO */ && x <= 57 /* NINE */) {
             acc = acc * 10 + x - 48 /* ZERO */;
         }
+        else if (x === 45 /* MINUS */) {
+            assert(!isSigned, `invalid int literal`);
+            isSigned = true;
+        }
         else if (x === end) {
-            return acc;
+            return isSigned ? -acc : acc;
         }
         else {
             illegalState(`expected digit, got 0x${x.toString(16)}`);

package/encode.js

@@ -26,9 +26,13 @@ const encodeBin = defmulti((x) => isNumber(x)
                     : isPlainObject(x)
                         ? 4 /* DICT */
                         : unsupported(`unsupported data type: ${x}`), {}, {
-    [0 /* INT */]: (x) => [str(`i${Math.floor(x)}e`)],
+    [0 /* INT */]: (x) => {
+        __ensureValidNumber(x);
+        return [str(`i${Math.floor(x)}e`)];
+    },
     [1 /* FLOAT */]: (x) => {
-        assert(FLOAT_RE.test(x.toString()), `exponential notation not allowed (${x})`);
+        __ensureValidNumber(x);
+        assert(FLOAT_RE.test(x.toString()), `values requiring exponential notation not allowed (${x})`);
         return [str(`f${x}e`)];
     },
     [3 /* BINARY */]: (buf) => [
@@ -47,3 +51,8 @@ const encodeBin = defmulti((x) => isNumber(x)
         u8(101 /* END */),
     ],
 });
+/** @internal */
+const __ensureValidNumber = (x) => {
+    assert(isFinite(x), `can't encode infinite value`);
+    assert(!isNaN(x), `can't encode NaN`);
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/bencode",
-  "version": "2.1.4",
+  "version": "2.1.7",
   "description": "Bencode binary encoder / decoder with optional UTF8 encoding & floating point support",
   "type": "module",
   "module": "./index.js",
@@ -34,20 +34,20 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/arrays": "^2.1.3",
-    "@thi.ng/checks": "^3.1.3",
-    "@thi.ng/defmulti": "^2.1.3",
-    "@thi.ng/errors": "^2.1.3",
-    "@thi.ng/transducers": "^8.2.0",
-    "@thi.ng/transducers-binary": "^2.1.4"
+    "@thi.ng/arrays": "^2.2.2",
+    "@thi.ng/checks": "^3.1.6",
+    "@thi.ng/defmulti": "^2.1.6",
+    "@thi.ng/errors": "^2.1.6",
+    "@thi.ng/transducers": "^8.3.2",
+    "@thi.ng/transducers-binary": "^2.1.7"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.19.2",
-    "@thi.ng/testament": "^0.2.3",
+    "@microsoft/api-extractor": "^7.23.1",
+    "@thi.ng/testament": "^0.2.6",
     "rimraf": "^3.0.2",
     "tools": "^0.0.1",
-    "typedoc": "^0.22.10",
-    "typescript": "^4.5.3"
+    "typedoc": "^0.22.15",
+    "typescript": "^4.6.4"
   },
   "keywords": [
     "array",
@@ -70,14 +70,14 @@
   ],
   "exports": {
     ".": {
-      "import": "./index.js"
+      "default": "./index.js"
     },
     "./decode": {
-      "import": "./decode.js"
+      "default": "./decode.js"
     },
     "./encode": {
-      "import": "./encode.js"
+      "default": "./encode.js"
     }
   },
-  "gitHead": "1ba92c6b9509e74e509b4c0b875fc380a97bbbc1\n"
+  "gitHead": "cf084be5fd5932226054d2dd32bad35481379f5d\n"
 }