compact-encoding 2.15.0 → 2.16.0

package/README.md

@@ -143,6 +143,7 @@ to build others on top. Feel free to PR more that are missing.
 * `cenc.fixed32` - Encodes a fixed 32 byte buffer.
 * `cenc.fixed64` - Encodes a fixed 64 byte buffer.
 * `cenc.fixed(n)` - Makes a fixed sized encoder.
+* `cenc.date(d)` - Encodes a date object.
 * `cenc.array(enc)` - Makes an array encoder from another encoder. Arrays are uint prefixed with their length.
 * `cenc.raw.array(enc)` - Makes an array encoder from another encoder, without a length prefixed.
 * `cenc.json` - Encodes a JSON value as utf-8.

package/index.js

@@ -39,6 +39,7 @@ const uint8 = exports.uint8 = {
     state.end += 1
   },
   encode (state, n) {
+    validateUint(n)
     state.buffer[state.start++] = n
   },
   decode (state) {
@@ -52,6 +53,7 @@ const uint16 = exports.uint16 = {
     state.end += 2
   },
   encode (state, n) {
+    validateUint(n)
     state.buffer[state.start++] = n
     state.buffer[state.start++] = n >>> 8
   },
@@ -69,6 +71,7 @@ const uint24 = exports.uint24 = {
     state.end += 3
   },
   encode (state, n) {
+    validateUint(n)
     state.buffer[state.start++] = n
     state.buffer[state.start++] = n >>> 8
     state.buffer[state.start++] = n >>> 16
@@ -88,6 +91,7 @@ const uint32 = exports.uint32 = {
     state.end += 4
   },
   encode (state, n) {
+    validateUint(n)
     state.buffer[state.start++] = n
     state.buffer[state.start++] = n >>> 8
     state.buffer[state.start++] = n >>> 16
@@ -109,6 +113,7 @@ const uint40 = exports.uint40 = {
     state.end += 5
   },
   encode (state, n) {
+    validateUint(n)
     const r = Math.floor(n / 0x100)
     uint8.encode(state, n)
     uint32.encode(state, r)
@@ -124,6 +129,7 @@ const uint48 = exports.uint48 = {
     state.end += 6
   },
   encode (state, n) {
+    validateUint(n)
     const r = Math.floor(n / 0x10000)
     uint16.encode(state, n)
     uint32.encode(state, r)
@@ -139,6 +145,7 @@ const uint56 = exports.uint56 = {
     state.end += 7
   },
   encode (state, n) {
+    validateUint(n)
     const r = Math.floor(n / 0x1000000)
     uint24.encode(state, n)
     uint32.encode(state, r)
@@ -154,6 +161,7 @@ const uint64 = exports.uint64 = {
     state.end += 8
   },
   encode (state, n) {
+    validateUint(n)
     const r = Math.floor(n / 0x100000000)
     uint32.encode(state, n)
     uint32.encode(state, r)
@@ -420,6 +428,7 @@ exports.bool = {
 const fixed = exports.fixed = function fixed (n) {
   return {
     preencode (state, s) {
+      if (s.byteLength !== n) throw new Error('Incorrect buffer size')
       state.end += n
     },
     encode (state, s) {
@@ -483,6 +492,18 @@ exports.frame = function frame (enc) {
   }
 }
 
+exports.date = {
+  preencode (state, d) {
+    uint.preencode(state, d.getTime())
+  },
+  encode (state, d) {
+    uint.encode(state, d.getTime())
+  },
+  decode (state, d) {
+    return new Date(uint.decode(state))
+  }
+}
+
 exports.json = {
   preencode (state, v) {
     utf8.preencode(state, JSON.stringify(v))
@@ -582,7 +603,8 @@ const anyTypes = [
   exports.int,
   exports.float64,
   anyArray,
-  anyObject
+  anyObject,
+  exports.date
 ]
 
 const any = exports.any = {
@@ -613,6 +635,7 @@ function getType (o) {
     return 6
   }
   if (Array.isArray(o)) return 7
+  if (o instanceof Date) return 9
   if (typeof o === 'object') return 8
 
   throw new Error('Unsupported type for ' + o)
@@ -737,3 +760,7 @@ function zigZagEncodeBigInt (n) {
   // 0, -1, 1, -2, 2, ...
   return n < 0n ? (2n * -n) - 1n : n === 0n ? 0n : 2n * n
 }
+
+function validateUint (n) {
+  if ((n >= 0) === false /* Handles NaN as well */) throw new Error('uint must be positive')
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "compact-encoding",
-  "version": "2.15.0",
+  "version": "2.16.0",
   "description": "A series of compact encoding schemes for building small and fast parsers and serializers",
   "main": "index.js",
   "dependencies": {

package/test.js

@@ -565,6 +565,19 @@ test('fixed n', function (t) {
   t.exception(() => fixed.decode(state))
 })
 
+test('error for incorrect buffer sizes when encoding fixed-length buffers', function (t) {
+  const smallbuf = b4a.from('aa', 'hex')
+  const bigBuf = b4a.from('aa'.repeat(500), 'hex')
+
+  t.exception(() => enc.encode(enc.fixed32, smallbuf), /Incorrect buffer size/)
+  t.exception(() => enc.encode(enc.fixed64, smallbuf), /Incorrect buffer size/)
+  t.exception(() => enc.encode(enc.fixed(100), smallbuf), /Incorrect buffer size/)
+
+  t.exception(() => enc.encode(enc.fixed32, bigBuf), /Incorrect buffer size/)
+  t.exception(() => enc.encode(enc.fixed64, bigBuf), /Incorrect buffer size/)
+  t.exception(() => enc.encode(enc.fixed(100), bigBuf), /Incorrect buffer size/)
+})
+
 test('array', function (t) {
   const state = enc.state()
   const arr = enc.array(enc.bool)
@@ -797,6 +810,12 @@ test('lexint: unpack', function (t) {
   }
 })
 
+test('date', function (t) {
+  const d = new Date()
+
+  t.alike(enc.decode(enc.date, enc.encode(enc.date, d)), d)
+})
+
 test('any', function (t) {
   const o = {
     hello: 'world',
@@ -804,6 +823,7 @@ test('any', function (t) {
     neg: -42,
     arr: [{ yes: 1 }, { no: false }],
     nest: {},
+    today: new Date(),
     float: 0.54
   }