feat: support Uint8Array input in place of Buffer

src/compile/encodings.js

@@ -4,6 +4,32 @@ var varint = require('varint')
 var svarint = require('signed-varint')
 const { Buffer } = require('buffer')
 
+/**
+ * @template T
+ * @typedef {{bytes?:number} & function(T, Buffer, number):Buffer} Encoder
+ */
+/**
+ * @template T
+ * @typedef {{bytes?:number} & function(Buffer, number):T} Decoder
+ */
+
+/**
+ * @template T
+ * @typedef {Object} Codec
+ * @property {number} type
+ * @property {Encoder<T>} encode
+ * @property {Decoder<T>} decode
+ * @property {function(T):number} encodingLength
+ */
+
+/**
+ * @template T
+ * @param {number} type
+ * @param {Encoder<T>} encode
+ * @param {Decoder<T>} decode
+ * @param {function(T):number} encodingLength
+ * @returns {Codec<T>}
+ */
 var encoder = function (type, encode, decode, encodingLength) {
   encode.bytes = decode.bytes = 0
 
@@ -17,7 +43,12 @@ var encoder = function (type, encode, decode, encodingLength) {
 
 exports.make = encoder
 
-exports.bytes = (function (tag) {
+/** @type {Codec<Uint8Array>} */
+exports.bytes = (function () {
+  /**
+   * @param {Uint8Array|string} val
+   * @returns {number}
+   */
   var bufferLength = function (val) {
     return Buffer.isBuffer(val) ? val.length : Buffer.byteLength(val)
   }
@@ -34,7 +65,7 @@ exports.bytes = (function (tag) {
     varint.encode(len, buffer, offset)
     offset += varint.encode.bytes
 
-    if (Buffer.isBuffer(val)) val.copy(buffer, offset)
+    if (val instanceof Uint8Array) buffer.set(val, offset)
     else buffer.write(val, offset, len)
     offset += len
 
@@ -58,6 +89,7 @@ exports.bytes = (function (tag) {
   return encoder(2, encode, decode, encodingLength)
 })()
 
+/** @type {Codec<string>} */
 exports.string = (function () {
   var encodingLength = function (val) {
     var len = Buffer.byteLength(val)
@@ -94,7 +126,12 @@ exports.string = (function () {
   return encoder(2, encode, decode, encodingLength)
 })()
 
+/** @type {Codec<boolean>} */
 exports.bool = (function () {
+  /**
+   * @param {boolean} val
+   * @returns {number}
+   */
   var encodingLength = function (val) {
     return 1
   }
@@ -114,6 +151,7 @@ exports.bool = (function () {
   return encoder(0, encode, decode, encodingLength)
 })()
 
+/** @type {Codec<number>} */
 exports.int32 = (function () {
   var decode = function (buffer, offset) {
     var val = varint.decode(buffer, offset)
@@ -134,6 +172,7 @@ exports.int32 = (function () {
   return encoder(0, encode, decode, encodingLength)
 })()
 
+/** @type {Codec<number>} */
 exports.int64 = (function () {
   var decode = function (buffer, offset) {
     var val = varint.decode(buffer, offset)
@@ -178,11 +217,13 @@ exports.int64 = (function () {
   return encoder(0, encode, decode, encodingLength)
 })()
 
+/** @type {Codec<number>} */
 exports.sint32 =
 exports.sint64 = (function () {
   return encoder(0, svarint.encode, svarint.decode, svarint.encodingLength)
 })()
 
+/** @type {Codec<number>} */
 exports.uint32 =
 exports.uint64 =
 exports.enum =
@@ -191,14 +232,15 @@ exports.varint = (function () {
 })()
 
 // we cannot represent these in javascript so we just use buffers
+/** @type {Codec<Uint8Array>} */
 exports.fixed64 =
 exports.sfixed64 = (function () {
   var encodingLength = function (val) {
     return 8
   }
 
   var encode = function (val, buffer, offset) {
-    val.copy(buffer, offset)
+    buffer.set(val, offset)
     encode.bytes = 8
     return buffer
   }
@@ -232,6 +274,7 @@ exports.double = (function () {
   return encoder(1, encode, decode, encodingLength)
 })()
 
+/** @type {Codec<number>} */
 exports.fixed32 = (function () {
   var encodingLength = function (val) {
     return 4
@@ -252,6 +295,7 @@ exports.fixed32 = (function () {
   return encoder(5, encode, decode, encodingLength)
 })()
 
+/** @type {Codec<number>} */
 exports.sfixed32 = (function () {
   var encodingLength = function (val) {
     return 4
@@ -272,6 +316,7 @@ exports.sfixed32 = (function () {
   return encoder(5, encode, decode, encodingLength)
 })()
 
+/** @type {Codec<number>} */
 exports.float = (function () {
   var encodingLength = function (val) {
     return 4

test/bytes.js

@@ -6,7 +6,7 @@ var Bytes = protobuf(require('./test.proto')).Bytes
 
 tape('bytes encode + decode', function (t) {
   var b1 = Bytes.encode({
-    req: Buffer.from([0, 1, 2, 3])
+    req: Uint8Array.from([0, 1, 2, 3])
   })
 
   var o1 = Bytes.decode(b1)

test/corrupted.js

@@ -27,7 +27,7 @@ var messages = protobuf(protoStr)
 tape('invalid message decode', function (t) {
   var didFail = false
   try {
-    messages.ABC.decode(Buffer.from([8, 182, 168, 235, 144, 178, 41]))
+    messages.ABC.decode(Uint8Array.from([8, 182, 168, 235, 144, 178, 41]))
   } catch (e) {
     didFail = true
   }

test/custom-types.js

@@ -8,7 +8,7 @@ tape('custom types encode + decode', function (t) {
   var b1 = CustomType.encode({
     req: {
       num: 5,
-      payload: Buffer.from([])
+      payload: Uint8Array.from([])
     }
   })
 

test/nested.js

@@ -7,20 +7,20 @@ var Nested = protobuf(require('./test.proto')).Nested
 tape('nested encode', function (t) {
   var b1 = Nested.encode({
     num: 1,
-    payload: Buffer.from('lol'),
+    payload: new TextEncoder().encode('lol'),
     meh: {
       num: 2,
-      payload: Buffer.from('bar')
+      payload: new TextEncoder().encode('bar')
     }
   })
 
   var b2 = Nested.encode({
     num: 1,
-    payload: Buffer.from('lol'),
+    payload: new TextEncoder().encode('lol'),
     meeeh: 42,
     meh: {
       num: 2,
-      payload: Buffer.from('bar')
+      payload: new TextEncoder().encode('bar')
     }
   })
 
@@ -31,10 +31,10 @@ tape('nested encode', function (t) {
 tape('nested encode + decode', function (t) {
   var b1 = Nested.encode({
     num: 1,
-    payload: Buffer.from('lol'),
+    payload: new TextEncoder().encode('lol'),
     meh: {
       num: 2,
-      payload: Buffer.from('bar')
+      payload: new TextEncoder().encode('bar')
     }
   })
 
@@ -48,11 +48,11 @@ tape('nested encode + decode', function (t) {
 
   var b2 = Nested.encode({
     num: 1,
-    payload: Buffer.from('lol'),
+    payload: new TextEncoder().encode('lol'),
     meeeh: 42,
     meh: {
       num: 2,
-      payload: Buffer.from('bar')
+      payload: new TextEncoder().encode('bar')
     }
   })
 

test/repeated.js

@@ -8,20 +8,20 @@ tape('repeated encode', function (t) {
   var b1 = Repeated.encode({
     list: [{
       num: 1,
-      payload: Buffer.from('lol')
+      payload: new TextEncoder().encode('lol')
     }, {
       num: 2,
-      payload: Buffer.from('lol1')
+      payload: new TextEncoder().encode('lol1')
     }]
   })
 
   var b2 = Repeated.encode({
     list: [{
       num: 1,
-      payload: Buffer.from('lol')
+      payload: new TextEncoder().encode('lol')
     }, {
       num: 2,
-      payload: Buffer.from('lol1'),
+      payload: new TextEncoder().encode('lol1'),
       meeeeh: 100
     }],
     meeh: 42
@@ -35,10 +35,10 @@ tape('repeated encode + decode', function (t) {
   var b1 = Repeated.encode({
     list: [{
       num: 1,
-      payload: Buffer.from('lol')
+      payload: new TextEncoder().encode('lol')
     }, {
       num: 2,
-      payload: Buffer.from('lol1')
+      payload: new TextEncoder().encode('lol1')
     }]
   })
 
@@ -53,10 +53,10 @@ tape('repeated encode + decode', function (t) {
   var b2 = Repeated.encode({
     list: [{
       num: 1,
-      payload: Buffer.from('lol')
+      payload: new TextEncoder().encode('lol')
     }, {
       num: 2,
-      payload: Buffer.from('lol1'),
+      payload: new TextEncoder().encode('lol1'),
       meeeeh: 100
     }],
     meeh: 42