protons 2.0.2 → 3.0.1

package/CHANGELOG.md

@@ -1,88 +0,0 @@
-<a name="2.0.2"></a>
-## [2.0.2](https://github.com/ipfs/protons/compare/v2.0.1...v2.0.2) (2021-08-11)
-
-
-
-<a name="2.0.1"></a>
-## [2.0.1](https://github.com/ipfs/protons/compare/v2.0.0...v2.0.1) (2021-04-16)
-
-
-### Bug Fixes
-
-* update uint8arrays ([#15](https://github.com/ipfs/protons/issues/15)) ([8a9dbf9](https://github.com/ipfs/protons/commit/8a9dbf9))
-
-
-
-<a name="2.0.0"></a>
-# [2.0.0](https://github.com/ipfs/protons/compare/v1.2.1...v2.0.0) (2020-08-04)
-
-
-### Bug Fixes
-
-* replace node buffers with uint8arrays ([#14](https://github.com/ipfs/protons/issues/14)) ([d3547cb](https://github.com/ipfs/protons/commit/d3547cb))
-
-
-### BREAKING CHANGES
-
-* - Byte arrays returned from this module will now be UintArrays and not Node Buffers
-
-
-
-<a name="1.2.1"></a>
-## [1.2.1](https://github.com/ipfs/protons/compare/v1.2.0...v1.2.1) (2020-06-24)
-
-
-### Bug Fixes
-
-* **ci:** add empty commit to fix lint checks on master ([3b5276f](https://github.com/ipfs/protons/commit/3b5276f))
-
-
-### Features
-
-* support Uint8Array input in place of Buffer ([#13](https://github.com/ipfs/protons/issues/13)) ([6c7add4](https://github.com/ipfs/protons/commit/6c7add4)), closes [/github.com/ipfs/protons/blob/3b5276f052f2e17c2d806d27cd9a88e156588977/src/compile/encodings.js#L30-L43](https://github.com//github.com/ipfs/protons/blob/3b5276f052f2e17c2d806d27cd9a88e156588977/src/compile/encodings.js/issues/L30-L43) [#12](https://github.com/ipfs/protons/issues/12)
-
-
-
-<a name="1.2.0"></a>
-# [1.2.0](https://github.com/ipfs/protons/compare/v1.1.0...v1.2.0) (2020-04-24)
-
-
-
-<a name="1.1.0"></a>
-# [1.1.0](https://github.com/ipfs/protons/compare/v1.0.2...v1.1.0) (2020-04-24)
-
-
-
-<a name="1.0.2"></a>
-## [1.0.2](https://github.com/ipfs/protons/compare/v1.0.0...v1.0.2) (2020-03-18)
-
-
-### Bug Fixes
-
-* add buffer and allow browser tests ([#11](https://github.com/ipfs/protons/issues/11)) ([c1d3d7e](https://github.com/ipfs/protons/commit/c1d3d7e)), closes [ipfs/js-ipfs#2924](https://github.com/ipfs/js-ipfs/issues/2924)
-* make default value only return default value ([fce4635](https://github.com/ipfs/protons/commit/fce4635))
-
-
-### Features
-
-* adds accessor methods for object properties ([3beeb49](https://github.com/ipfs/protons/commit/3beeb49))
-
-
-
-<a name="1.0.0"></a>
-# [1.0.0](https://github.com/ipfs/protons/compare/122d5c0...v1.0.0) (2017-09-06)
-
-
-### Bug Fixes
-
-* updated for packed fixes ([122d5c0](https://github.com/ipfs/protons/commit/122d5c0))
-
-
-### Features
-
-* make benchmarks browser compatible ([9645adf](https://github.com/ipfs/protons/commit/9645adf))
-* rename to protons ([db6d2fb](https://github.com/ipfs/protons/commit/db6d2fb))
-* upgrade dependencies ([fd66b86](https://github.com/ipfs/protons/commit/fd66b86))
-
-
-

package/bench/bench.proto.js

@@ -1,30 +0,0 @@
-'use strict'
-
-module.exports = `message Bar {
-  message Foo {
-    optional uint32 baz = 1;
-  }
-
-  optional Foo tmp = 1;
-}
-
-enum FOO {
-  LOL=1;
-  ABE=3;
-}
-
-message Yo {
-  repeated FOO lol = 1;
-}
-
-message Lol {
-  optional string lol = 1;
-  required Bar b = 2;
-}
-
-message Test {
-  optional Lol meh = 6;
-  optional uint32 hello = 3;
-  optional string foo = 1;
-  optional bytes payload = 7;
-}`

package/bench/index.js

@@ -1,57 +0,0 @@
-'use strict'
-
-const Benchmark = require('benchmark')
-if (typeof window !== 'undefined') {
-  window.Benchmark = Benchmark
-}
-
-const protobuf = require('protocol-buffers')
-const protonsNpm = require('protons')
-const protons = require('../')
-const proto = require('./bench.proto')
-const messages = protobuf(proto)
-const messagesBuf = protons(proto)
-const messagesNpm = protonsNpm(proto)
-const uint8ArrayFromString = require('uint8arrays/from-string')
-
-const EXAMPLE = {
-  foo: 'hello',
-  hello: 42,
-  payload: uint8ArrayFromString('a'),
-  meh: {
-    b: {
-      tmp: {
-        baz: 1000
-      }
-    },
-    lol: 'lol'
-  }
-}
-
-const suite = new Benchmark.Suite()
-
-function add (name, encode, decode) {
-  const EXAMPLE_BUFFER = encode(EXAMPLE)
-
-  suite
-    .add(name + ' (encode)', function () {
-      return encode(EXAMPLE)
-    })
-    .add(name + ' (decode)', function () {
-      return decode(EXAMPLE_BUFFER)
-    })
-    .add(name + ' (encode + decode)', function () {
-      return decode(encode(EXAMPLE))
-    })
-}
-
-add('JSON', JSON.stringify, JSON.parse)
-add(`protocol-buffers@${require('protocol-buffers/package.json').version}`, messages.Test.encode, messages.Test.decode)
-add(`protons@${require('protons/package.json').version}`, messagesNpm.Test.encode, messagesNpm.Test.decode)
-add('local', messagesBuf.Test.encode, messagesBuf.Test.decode)
-
-suite
-  .on('cycle', (e) => {
-    console.log(String(e.target))
-  })
-  .run()

package/example.js

@@ -1,19 +0,0 @@
-/* eslint no-console: "off" */
-'use strict'
-
-var protobuf = require('./')
-var path = require('path')
-var fs = require('fs')
-
-var messages = protobuf(fs.readFileSync(path.join(__dirname, '/example.proto')))
-
-var ex = {
-  foo: 'hello world',
-  num: 42
-}
-
-var buf = messages.Test.encode(ex)
-
-console.log('test message', ex)
-console.log('encoded test message', buf)
-console.log('encoded test message decoded', messages.Test.decode(buf))

package/example.proto

@@ -1,4 +0,0 @@
-message Test {
-  optional string foo = 1;
-  required int32 num = 2;
-}

package/src/compile/decode.js

@@ -1,330 +0,0 @@
-/* eslint max-depth: 1 */
-'use strict'
-
-const varint = require('varint')
-const defined = require('./utils').defined
-
-function toSentenceCase (string) {
-  return `${string.substring(0, 1).toUpperCase()}${string.substring(1)}`
-}
-
-function addPropertyAccessors (obj, name, value, defaultValue) {
-  if (Object.prototype.hasOwnProperty.call(obj, name)) {
-    // have already added this property
-    return
-  }
-
-  const sentenceCaseName = toSentenceCase(name)
-
-  Object.defineProperties(obj, {
-    [name]: {
-      enumerable: true,
-      configurable: true,
-      set: (val) => {
-        value = val
-      },
-      get: () => {
-        if (value === undefined) {
-          return defaultValue
-        }
-
-        return value
-      }
-    },
-    [`has${sentenceCaseName}`]: {
-      configurable: true,
-      value: () => {
-        return value !== undefined
-      }
-    },
-    [`set${sentenceCaseName}`]: {
-      configurable: true,
-      value: (val) => {
-        value = val
-      }
-    },
-    [`get${sentenceCaseName}`]: {
-      configurable: true,
-      value: () => {
-        return value
-      }
-    },
-    [`clear${sentenceCaseName}`]: {
-      configurable: true,
-      value: () => {
-        value = undefined
-        obj[name] = undefined
-      }
-    }
-  })
-}
-
-function compileDecode (m, resolve, enc) {
-  const requiredFields = []
-  const fields = {}
-  const oneofFields = []
-  const vals = []
-
-  for (var i = 0; i < enc.length; i++) {
-    const field = m.fields[i]
-
-    fields[field.tag] = i
-
-    const def = field.options && field.options.default
-    const resolved = resolve(field.type, m.id, false)
-    vals[i] = [def, resolved && resolved.values]
-
-    m.fields[i].packed = field.repeated && field.options && field.options.packed && field.options.packed !== 'false'
-
-    if (field.required) {
-      requiredFields.push(field.name)
-    }
-
-    if (field.oneof) {
-      oneofFields.push(field.name)
-    }
-  }
-
-  function decodeField (e, field, obj, buf, dataView, offset, i) {
-    const name = field.name
-
-    if (field.oneof) {
-      // clear already defined oneof fields
-      const props = Object.keys(obj)
-      for (var j = 0; j < props.length; j++) {
-        if (oneofFields.indexOf(props[j]) > -1) {
-          const sentenceCase = toSentenceCase(props[j])
-          delete obj[`has${sentenceCase}`]
-          delete obj[`get${sentenceCase}`]
-          delete obj[`set${sentenceCase}`]
-          delete obj[`clear${sentenceCase}`]
-          delete obj[props[j]]
-        }
-      }
-    }
-
-    let value
-
-    if (e.message) {
-      const len = varint.decode(buf, offset)
-      offset += varint.decode.bytes
-
-      const decoded = e.decode(buf, dataView, offset, offset + len)
-
-      if (field.map) {
-        value = obj[name] || {}
-        value[decoded.key] = decoded.value
-      } else if (field.repeated) {
-        value = obj[name] || []
-        value.push(decoded)
-      } else {
-        value = decoded
-      }
-    } else {
-      if (field.repeated) {
-        value = obj[name] || []
-        value.push(e.decode(buf, dataView, offset))
-      } else {
-        value = e.decode(buf, dataView, offset)
-      }
-    }
-
-    addPropertyAccessors(obj, name, value)
-
-    offset += e.decode.bytes
-
-    return offset
-  }
-
-  return function decode (buf, view, offset, end) {
-    if (offset == null) {
-      offset = 0
-    }
-
-    if (end == null) {
-      end = buf.length
-    }
-
-    if (!(end <= buf.length && offset <= buf.length)) {
-      throw new Error('Decoded message is not valid')
-    }
-
-    if (!view) {
-      view = new DataView(buf.buffer, buf.byteOffset, buf.byteLength)
-    }
-
-    var oldOffset = offset
-    var obj = {}
-    var field
-
-    while (true) {
-      if (end <= offset) {
-        // finished
-
-        // check required methods
-        var name = ''
-        var j = 0
-        for (j = 0; j < requiredFields.length; j++) {
-          name = requiredFields[j]
-          if (!defined(obj[name])) {
-            throw new Error('Decoded message is not valid, missing required field: ' + name)
-          }
-        }
-
-        // fill out missing defaults
-        var val
-        var def
-        for (j = 0; j < enc.length; j++) {
-          field = m.fields[j]
-          def = vals[j][0]
-          val = vals[j][1]
-          name = field.name
-          let defaultVal
-
-          if (Object.prototype.hasOwnProperty.call(obj, name)) {
-            continue
-          }
-
-          var done = false
-
-          if (field.oneof) {
-            var props = Object.keys(obj)
-
-            for (var k = 0; k < props.length; k++) {
-              if (oneofFields.indexOf(props[k]) > -1) {
-                done = true
-                break
-              }
-            }
-          }
-
-          if (done) {
-            continue
-          }
-
-          if (val) { // is enum
-            if (field.repeated) {
-              def = []
-            } else {
-              def = (def && val[def]) ? val[def].value : val[Object.keys(val)[0]].value
-              def = parseInt(def || 0, 10)
-            }
-          } else {
-            defaultVal = defaultValue(field)
-            def = coerceValue(field, def)
-          }
-
-          addPropertyAccessors(obj, name, def, defaultVal)
-        }
-
-        decode.bytes = offset - oldOffset
-        return obj
-      }
-
-      var prefix = varint.decode(buf, offset)
-      offset += varint.decode.bytes
-      var tag = prefix >> 3
-
-      var i = fields[tag]
-
-      if (i == null) {
-        offset = skip(prefix & 7, buf, view, offset)
-        continue
-      }
-
-      var e = enc[i]
-      field = m.fields[i]
-
-      if (field.packed) {
-        var packedEnd = varint.decode(buf, offset)
-        offset += varint.decode.bytes
-        packedEnd += offset
-
-        while (offset < packedEnd) {
-          offset = decodeField(e, field, obj, buf, view, offset, i)
-        }
-      } else {
-        offset = decodeField(e, field, obj, buf, view, offset, i)
-      }
-    }
-  }
-}
-
-var skip = function (type, buffer, view, offset) {
-  switch (type) {
-    case 0:
-      varint.decode(buffer, offset)
-      return offset + varint.decode.bytes
-
-    case 1:
-      return offset + 8
-
-    case 2:
-      var len = varint.decode(buffer, offset)
-      return offset + varint.decode.bytes + len
-
-    case 3:
-    case 4:
-      throw new Error('Groups are not supported')
-
-    case 5:
-      return offset + 4
-    default:
-      throw new Error('Unknown wire type: ' + type)
-  }
-}
-
-var defaultValue = function (f) {
-  if (f.map) return {}
-  if (f.repeated) return []
-
-  switch (f.type) {
-    case 'string':
-      return ''
-    case 'bool':
-      return false
-    case 'float':
-    case 'double':
-    case 'sfixed32':
-    case 'fixed32':
-    case 'varint':
-    case 'enum':
-    case 'uint64':
-    case 'uint32':
-    case 'int64':
-    case 'int32':
-    case 'sint64':
-    case 'sint32':
-      return 0
-    default:
-      return null
-  }
-}
-
-var coerceValue = function (f, def) {
-  if (def === undefined) {
-    return def
-  }
-
-  switch (f.type) {
-    case 'bool':
-      return def === 'true'
-    case 'float':
-    case 'double':
-    case 'sfixed32':
-    case 'fixed32':
-    case 'varint':
-    case 'enum':
-    case 'uint64':
-    case 'uint32':
-    case 'int64':
-    case 'int32':
-    case 'sint64':
-    case 'sint32':
-      return parseInt(def, 10)
-    default:
-      return def
-  }
-}
-
-module.exports = compileDecode

package/src/compile/encode.js

@@ -1,133 +0,0 @@
-'use strict'
-
-var defined = require('./utils').defined
-var varint = require('varint')
-
-function compileEncode (m, resolve, enc, oneofs, encodingLength) {
-  const oneofsKeys = Object.keys(oneofs)
-  const encLength = enc.length
-  const ints = {}
-  for (let i = 0; i < encLength; i++) {
-    ints[i] = {
-      p: varint.encode(m.fields[i].tag << 3 | 2),
-      h: varint.encode(m.fields[i].tag << 3 | enc[i].type)
-    }
-
-    const field = m.fields[i]
-    m.fields[i].packed = field.repeated && field.options && field.options.packed && field.options.packed !== 'false'
-  }
-
-  function encodeField (buf, view, offset, h, e, packed, innerVal) {
-    let j = 0
-    if (!packed) {
-      for (j = 0; j < h.length; j++) {
-        buf[offset++] = h[j]
-      }
-    }
-
-    if (e.message) {
-      varint.encode(e.encodingLength(innerVal), buf, offset)
-      offset += varint.encode.bytes
-    }
-
-    e.encode(innerVal, buf, view, offset)
-
-    return offset + e.encode.bytes
-  }
-
-  return function encode (obj, buf, view, offset = 0) {
-    if (buf == null) {
-      buf = new Uint8Array(encodingLength(obj))
-    }
-
-    if (view == null) {
-      view = new DataView(buf.buffer, buf.byteOffset, buf.byteLength)
-    }
-
-    const oldOffset = offset
-    const objKeys = Object.keys(obj)
-    let i = 0
-
-    // oneof checks
-
-    let match = false
-    for (i = 0; i < oneofsKeys.length; i++) {
-      const name = oneofsKeys[i]
-      const prop = oneofs[i]
-      if (objKeys.indexOf(prop) > -1) {
-        if (match) {
-          throw new Error('only one of the properties defined in oneof ' + name + ' can be set')
-        }
-
-        match = true
-      }
-    }
-
-    for (i = 0; i < encLength; i++) {
-      const e = enc[i]
-      const field = m.fields[i] // was f
-      let val = obj[field.name]
-      let j = 0
-
-      if (!defined(val)) {
-        if (field.required) {
-          throw new Error(field.name + ' is required')
-        }
-        continue
-      }
-      const p = ints[i].p
-      const h = ints[i].h
-
-      const packed = field.packed
-
-      if (field.map) {
-        const tmp = Object.keys(val)
-        for (j = 0; j < tmp.length; j++) {
-          tmp[j] = {
-            key: tmp[j],
-            value: val[tmp[j]]
-          }
-        }
-        val = tmp
-      }
-
-      if (packed) {
-        let packedLen = 0
-        for (j = 0; j < val.length; j++) {
-          if (!Object.prototype.hasOwnProperty.call(val, j)) {
-            continue
-          }
-
-          packedLen += e.encodingLength(val[j])
-        }
-
-        if (packedLen) {
-          for (j = 0; j < h.length; j++) {
-            buf[offset++] = p[j]
-          }
-          varint.encode(packedLen, buf, offset)
-          offset += varint.encode.bytes
-        }
-      }
-
-      if (field.repeated) {
-        let innerVal
-        for (j = 0; j < val.length; j++) {
-          innerVal = val[j]
-          if (!defined(innerVal)) {
-            continue
-          }
-
-          offset = encodeField(buf, view, offset, h, e, packed, innerVal)
-        }
-      } else {
-        offset = encodeField(buf, view, offset, h, e, packed, val)
-      }
-    }
-
-    encode.bytes = offset - oldOffset
-    return buf
-  }
-}
-
-module.exports = compileEncode