protobufjs 4.1.3 → 5.0.3

package/dist/{ProtoBuf.js → protobuf.js}

@@ -15,14 +15,14 @@
  */
 
 /**
- * @license ProtoBuf.js (c) 2013 Daniel Wirtz <dcode@dcode.io>
+ * @license protobuf.js (c) 2013 Daniel Wirtz <dcode@dcode.io>
  * Released under the Apache License, Version 2.0
- * see: https://github.com/dcodeIO/ProtoBuf.js for details
+ * see: https://github.com/dcodeIO/protobuf.js for details
  */
 (function(global, factory) {
 
     /* AMD */ if (typeof define === 'function' && define["amd"])
-        define(["ByteBuffer"], factory);
+        define(["bytebuffer"], factory);
     /* CommonJS */ else if (typeof require === "function" && typeof module === "object" && module && module["exports"])
         module["exports"] = factory(require("bytebuffer"), true);
     /* Global */ else
@@ -57,7 +57,7 @@
      * @const
      * @expose
      */
-    ProtoBuf.VERSION = "4.1.3";
+    ProtoBuf.VERSION = "5.0.3";
 
     /**
      * Wire types.
@@ -429,10 +429,10 @@
         TYPEDEF: /^[a-zA-Z][a-zA-Z_0-9]*$/,
 
         // Type references
-        TYPEREF: /^(?:\.?[a-zA-Z_][a-zA-Z_0-9]*)+$/,
+        TYPEREF: /^(?:\.?[a-zA-Z_][a-zA-Z_0-9]*)(?:\.[a-zA-Z_][a-zA-Z_0-9]*)*$/,
 
         // Fully qualified type references
-        FQTYPEREF: /^(?:\.[a-zA-Z][a-zA-Z_0-9]*)+$/,
+        FQTYPEREF: /^(?:\.[a-zA-Z_][a-zA-Z_0-9]*)+$/,
 
         // All numbers
         NUMBER: /^-?(?:[1-9][0-9]*|0|0[xX][0-9a-fA-F]+|0[0-7]+|([0-9]*(\.[0-9]*)?([Ee][+-]?[0-9]+)?)|inf|nan)$/,
@@ -725,7 +725,8 @@
                 // "syntax": undefined
             };
             var token,
-                head = true;
+                head = true,
+                weak;
             try {
                 while (token = this.tn.next()) {
                     switch (token) {
@@ -742,11 +743,12 @@
                             if (!head)
                                 throw Error("unexpected 'import'");
                             token = this.tn.peek();
-                            if (token === "public") // ignored
+                            if (token === "public" || (weak = token === "weak")) // token ignored
                                 this.tn.next();
                             token = this._readString();
                             this.tn.skip(";");
-                            topLevel["imports"].push(token);
+                            if (!weak) // import ignored
+                                topLevel["imports"].push(token);
                             break;
                         case 'syntax':
                             if (!head)
@@ -1071,6 +1073,7 @@
                 "enums": [],
                 "messages": [],
                 "options": {},
+                "services": [],
                 "oneofs": {}
                 // "extensions": undefined
             };
@@ -1097,8 +1100,16 @@
                     this._parseMessage(msg);
                 else if (token === "option")
                     this._parseOption(msg);
+                else if (token === "service")
+                    this._parseService(msg);
                 else if (token === "extensions")
-                    this._parseExtensions(msg);
+                    if (msg.hasOwnProperty("extensions")) {
+                        msg["extensions"] = msg["extensions"].concat(this._parseExtensionRanges())
+                    } else {
+                        msg["extensions"] = this._parseExtensionRanges();
+                    }
+                else if (token === "reserved")
+                    this._parseIgnored(); // TODO
                 else if (token === "extend")
                     this._parseExtend(msg);
                 else if (Lang.TYPEREF.test(token)) {
@@ -1113,6 +1124,16 @@
             return msg;
         };
 
+        /**
+         * Parses an ignored statement.
+         * @private
+         */
+        ParserPrototype._parseIgnored = function() {
+            while (this.tn.peek() !== ';')
+                this.tn.next();
+            this.tn.skip(";");
+        };
+
         /**
          * Parses a message field.
          * @param {!Object} msg Message definition
@@ -1275,29 +1296,43 @@
         };
 
         /**
-         * Parses an extensions statement.
-         * @param {!Object} msg Message object
+         * Parses extension / reserved ranges.
+         * @returns {!Array.<!Array.<number>>}
          * @private
          */
-        ParserPrototype._parseExtensions = function(msg) {
-            var token = this.tn.next(),
+        ParserPrototype._parseExtensionRanges = function() {
+            var ranges = [];
+            var token,
+                range,
+                value;
+            do {
                 range = [];
-            if (token === "min")
-                range.push(ProtoBuf.ID_MIN);
-            else if (token === "max")
-                range.push(ProtoBuf.ID_MAX);
-            else
-                range.push(mkNumber(token));
-            this.tn.skip("to");
-            token = this.tn.next();
-            if (token === "min")
-                range.push(ProtoBuf.ID_MIN);
-            else if (token === "max")
-                range.push(ProtoBuf.ID_MAX);
-            else
-                range.push(mkNumber(token));
+                while (true) {
+                    token = this.tn.next();
+                    switch (token) {
+                        case "min":
+                            value = ProtoBuf.ID_MIN;
+                            break;
+                        case "max":
+                            value = ProtoBuf.ID_MAX;
+                            break;
+                        default:
+                            value = mkNumber(token);
+                            break;
+                    }
+                    range.push(value);
+                    if (range.length === 2)
+                        break;
+                    if (this.tn.peek() !== "to") {
+                        range.push(value);
+                        break;
+                    }
+                    this.tn.next();
+                }
+                ranges.push(range);
+            } while (this.tn.omit(","));
             this.tn.skip(";");
-            msg["extensions"] = range;
+            return ranges;
         };
 
         /**
@@ -1678,9 +1713,11 @@
          * converted to string form if so.
          * @param {string} syntax Syntax level of defining message type, e.g.,
          * proto2 or proto3.
+         * @param {string} name Name of the field containing this element (for error
+         * messages)
          * @constructor
          */
-        var Element = function(type, resolvedType, isMapKey, syntax) {
+        var Element = function(type, resolvedType, isMapKey, syntax, name) {
 
             /**
              * Element type, as a string (e.g., int32).
@@ -1706,6 +1743,12 @@
              */
             this.syntax = syntax;
 
+            /**
+             * Name of the field containing this element (for error messages)
+             * @type {string}
+             */
+            this.name = name;
+
             if (isMapKey && ProtoBuf.MAP_KEY_TYPES.indexOf(type) < 0)
                 throw Error("Invalid map key type: " + type.name);
         };
@@ -1756,6 +1799,10 @@
             throw Error("not convertible to Long");
         }
 
+        ElementPrototype.toString = function() {
+            return (this.name || '') + (this.isMapKey ? 'map' : 'value') + ' element';
+        }
+
         /**
          * Checks if the given value can be set for an element of this type (singular
          * field or one element of a repeated field or map).
@@ -1765,9 +1812,10 @@
          * @expose
          */
         ElementPrototype.verifyValue = function(value) {
-            var fail = function(val, msg) {
-                throw Error("Illegal value for "+this.toString(true)+" of type "+this.type.name+": "+val+" ("+msg+")");
-            }.bind(this);
+            var self = this;
+            function fail(val, msg) {
+                throw Error("Illegal value for "+self.toString(true)+" of type "+self.type.name+": "+val+" ("+msg+")");
+            }
             switch (this.type) {
                 // Signed 32bit
                 case ProtoBuf.TYPES["int32"]:
@@ -2257,10 +2305,10 @@
 
             /**
              * Extensions range.
-             * @type {!Array.<number>}
+             * @type {!Array.<number>|undefined}
              * @expose
              */
-            this.extensions = [ProtoBuf.ID_MIN, ProtoBuf.ID_MAX];
+            this.extensions = undefined;
 
             /**
              * Runtime message class.
@@ -2429,9 +2477,11 @@
                 MessagePrototype.set = function(keyOrObj, value, noAssert) {
                     if (keyOrObj && typeof keyOrObj === 'object') {
                         noAssert = value;
-                        for (var ikey in keyOrObj)
-                            if (keyOrObj.hasOwnProperty(ikey) && typeof (value = keyOrObj[ikey]) !== 'undefined')
+                        for (var ikey in keyOrObj) {
+                            // Check if virtual oneof field - don't set these
+                            if (keyOrObj.hasOwnProperty(ikey) && typeof (value = keyOrObj[ikey]) !== 'undefined' && T._oneofsByName[ikey] === undefined)
                                 this.$set(ikey, value, noAssert);
+                        }
                         return this;
                     }
                     var field = T._fieldsByName[keyOrObj];
@@ -2659,18 +2709,19 @@
                  * @name ProtoBuf.Builder.Message#encodeDelimited
                  * @function
                  * @param {(!ByteBuffer|boolean)=} buffer ByteBuffer to encode to. Will create a new one and flip it if omitted.
+                 * @param {boolean=} noVerify Whether to not verify field values, defaults to `false`
                  * @return {!ByteBuffer} Encoded message as a ByteBuffer
                  * @throws {Error} If the message cannot be encoded or if required fields are missing. The later still
                  *  returns the encoded ByteBuffer in the `encoded` property on the error.
                  * @expose
                  */
-                MessagePrototype.encodeDelimited = function(buffer) {
+                MessagePrototype.encodeDelimited = function(buffer, noVerify) {
                     var isNew = false;
                     if (!buffer)
                         buffer = new ByteBuffer(),
                         isNew = true;
                     var enc = new ByteBuffer().LE();
-                    T.encode(this, enc).flip();
+                    T.encode(this, enc, noVerify).flip();
                     buffer.writeVarint32(enc.remaining());
                     buffer.append(enc);
                     return isNew ? buffer.flip() : buffer;
@@ -2879,6 +2930,7 @@
                  * @name ProtoBuf.Builder.Message.decode
                  * @function
                  * @param {!ByteBuffer|!ArrayBuffer|!Buffer|string} buffer Buffer to decode from
+                 * @param {(number|string)=} length Message length. Defaults to decode all the remainig data.
                  * @param {string=} enc Encoding if buffer is a string: hex, utf8 (not recommended), defaults to base64
                  * @return {!ProtoBuf.Builder.Message} Decoded message
                  * @throws {Error} If the message cannot be decoded or if required fields are missing. The later still
@@ -2887,13 +2939,17 @@
                  * @see ProtoBuf.Builder.Message.decode64
                  * @see ProtoBuf.Builder.Message.decodeHex
                  */
-                Message.decode = function(buffer, enc) {
+                Message.decode = function(buffer, length, enc) {
+                    if (typeof length === 'string')
+                        enc = length,
+                        length = -1;
                     if (typeof buffer === 'string')
                         buffer = ByteBuffer.wrap(buffer, enc ? enc : "base64");
-                    buffer = ByteBuffer.isByteBuffer(buffer) ? buffer : ByteBuffer.wrap(buffer); // May throw
+                    else if (!ByteBuffer.isByteBuffer(buffer))
+                        buffer = ByteBuffer.wrap(buffer); // May throw
                     var le = buffer.littleEndian;
                     try {
-                        var msg = T.decode(buffer.LE());
+                        var msg = T.decode(buffer.LE(), length);
                         buffer.LE(le);
                         return msg;
                     } catch (e) {
@@ -2916,7 +2972,8 @@
                 Message.decodeDelimited = function(buffer, enc) {
                     if (typeof buffer === 'string')
                         buffer = ByteBuffer.wrap(buffer, enc ? enc : "base64");
-                    buffer = ByteBuffer.isByteBuffer(buffer) ? buffer : ByteBuffer.wrap(buffer); // May throw
+                    else if (!ByteBuffer.isByteBuffer(buffer))
+                        buffer = ByteBuffer.wrap(buffer); // May throw
                     if (buffer.remaining() < 1)
                         return null;
                     var off = buffer.offset,
@@ -3038,6 +3095,7 @@
             this._fields = [];
             this._fieldsById = {};
             this._fieldsByName = {};
+            this._oneofsByName = {};
             for (var i=0, k=this.children.length, child; i<k; i++) {
                 child = this.children[i];
                 if (child instanceof Enum || child instanceof Message || child instanceof Service) {
@@ -3049,6 +3107,9 @@
                     this._fields.push(child),
                     this._fieldsById[child.id] = child,
                     this._fieldsByName[child.name] = child;
+                else if (child instanceof Message.OneOf) {
+                    this._oneofsByName[child.name] = child;
+                }
                 else if (!(child instanceof Message.OneOf) && !(child instanceof Extension)) // Not built
                     throw Error("Illegal reflect child of "+this.toString(true)+": "+this.children[i].toString(true));
             }
@@ -3148,14 +3209,15 @@
         /**
          * Decodes an encoded message and returns the decoded message.
          * @param {ByteBuffer} buffer ByteBuffer to decode from
-         * @param {number=} length Message length. Defaults to decode all the available data.
+         * @param {number=} length Message length. Defaults to decode all remaining data.
          * @param {number=} expectedGroupEndId Expected GROUPEND id if this is a legacy group
          * @return {ProtoBuf.Builder.Message} Decoded message
          * @throws {Error} If the message cannot be decoded
          * @expose
          */
         MessagePrototype.decode = function(buffer, length, expectedGroupEndId) {
-            length = typeof length === 'number' ? length : -1;
+            if (typeof length !== 'number')
+                length = -1;
             var start = buffer.offset,
                 msg = new (this.clazz)(),
                 tag, wireType, id, field;
@@ -3374,9 +3436,9 @@
          * @expose
          */
         FieldPrototype.build = function() {
-            this.element = new Element(this.type, this.resolvedType, false, this.syntax);
+            this.element = new Element(this.type, this.resolvedType, false, this.syntax, this.name);
             if (this.map)
-                this.keyElement = new Element(this.keyType, undefined, true, this.syntax);
+                this.keyElement = new Element(this.keyType, undefined, true, this.syntax, this.name);
 
             // In proto3, fields do not have field presence, and every field is set to
             // its type's default value ("", 0, 0.0, or false).
@@ -3398,9 +3460,10 @@
          */
         FieldPrototype.verifyValue = function(value, skipRepeated) {
             skipRepeated = skipRepeated || false;
-            var fail = function(val, msg) {
-                throw Error("Illegal value for "+this.toString(true)+" of type "+this.type.name+": "+val+" ("+msg+")");
-            }.bind(this);
+            var self = this;
+            function fail(val, msg) {
+                throw Error("Illegal value for "+self.toString(true)+" of type "+self.type.name+": "+val+" ("+msg+")");
+            }
             if (value === null) { // NULL values for optional fields
                 if (this.required)
                     fail(typeof value, "required");
@@ -4014,6 +4077,9 @@
                                         callback(err);
                                         return;
                                     }
+                                    // Coalesce to empty string when service response has empty content
+                                    if (res === null)
+                                        res = ''
                                     try { res = method.resolvedResponseType.clazz.decode(res); } catch (notABuffer) {}
                                     if (!res || !(res instanceof method.resolvedResponseType.clazz)) {
                                         callback(Error("Illegal response type received in service method "+ T.name+"#"+method.name));
@@ -4457,13 +4523,12 @@
                                 subObj.push(svc);
                             });
 
-                        // Set extension range
+                        // Set extension ranges
                         if (def["extensions"]) {
-                            obj.extensions = def["extensions"];
-                            if (obj.extensions[0] < ProtoBuf.ID_MIN)
-                                obj.extensions[0] = ProtoBuf.ID_MIN;
-                            if (obj.extensions[1] > ProtoBuf.ID_MAX)
-                                obj.extensions[1] = ProtoBuf.ID_MAX;
+                            if (typeof def["extensions"][0] === 'number') // pre 5.0.1
+                                obj.extensions = [ def["extensions"] ];
+                            else
+                                obj.extensions = def["extensions"];
                         }
 
                         // Create on top of current namespace
@@ -4502,8 +4567,16 @@
                             def["fields"].forEach(function(fld) {
                                 if (obj.getChild(fld['id']|0) !== null)
                                     throw Error("duplicate extended field id in "+obj.name+": "+fld['id']);
-                                if (fld['id'] < obj.extensions[0] || fld['id'] > obj.extensions[1])
-                                    throw Error("illegal extended field id in "+obj.name+": "+fld['id']+" ("+obj.extensions.join(' to ')+" expected)");
+                                // Check if field id is allowed to be extended
+                                if (obj.extensions) {
+                                    var valid = false;
+                                    obj.extensions.forEach(function(range) {
+                                        if (fld["id"] >= range[0] && fld["id"] <= range[1])
+                                            valid = true;
+                                    });
+                                    if (!valid)
+                                        throw Error("illegal extended field id in "+obj.name+": "+fld['id']+" (not within valid ranges)");
+                                }
                                 // Convert extension field names to camel case notation if the override is set
                                 var name = fld["name"];
                                 if (this.options['convertFieldsToCamelCase'])
@@ -4584,7 +4657,11 @@
                     root = require("path")['resolve'](root);
                 if (root.indexOf("\\") >= 0 || filename.file.indexOf("\\") >= 0)
                     delim = '\\';
-                var fname = root + delim + filename.file;
+                var fname;
+                if (ProtoBuf.Util.IS_NODE)
+                    fname = require("path")['join'](root, filename.file);
+                else
+                    fname = root + delim + filename.file;
                 if (this.files[fname] === true)
                     return this.reset();
                 this.files[fname] = true;
@@ -4630,7 +4707,10 @@
                         var importFilename = json['imports'][i];
                         if (importFilename === "google/protobuf/descriptor.proto")
                             continue; // Not needed and therefore not used
-                        importFilename = importRoot + delim + importFilename;
+                        if (ProtoBuf.Util.IS_NODE)
+                            importFilename = require("path")['join'](importRoot, importFilename);
+                        else
+                            importFilename = importRoot + delim + importFilename;
                         if (this.files[importFilename] === true)
                             continue; // Already imported
                         if (/\.proto$/i.test(importFilename) && !ProtoBuf.DotProto)       // If this is a light build
@@ -4728,6 +4808,16 @@
                     this.ptr.keyType = ProtoBuf.TYPES[this.ptr.keyType];
                 }
 
+                // If it's a repeated and packable field then proto3 mandates it should be packed by
+                // default
+                if (
+                  this.ptr.syntax === 'proto3' &&
+                  this.ptr.repeated && this.ptr.options.packed === undefined &&
+                  ProtoBuf.PACKABLE_WIRE_TYPES.indexOf(this.ptr.type.wireType) !== -1
+                ) {
+                  this.ptr.options.packed = true;
+                }
+
             } else if (this.ptr instanceof ProtoBuf.Reflect.Service.Method) {
 
                 if (this.ptr instanceof ProtoBuf.Reflect.Service.RPCMethod) {