protobufjs 4.1.1 → 5.0.1

package/index.js

@@ -1,18 +1 @@
-/*
- Copyright 2013 Daniel Wirtz <dcode@dcode.io>
-
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
- */
-var ProtoBuf = require("./dist/ProtoBuf.js");
-
-module.exports = ProtoBuf;
+module.exports = require("./dist/protobuf.js");

package/package.json

@@ -1,23 +1,23 @@
 {
   "name": "protobufjs",
-  "version": "4.1.1",
+  "version": "5.0.1",
   "description": "Protocol Buffers for JavaScript. Finally.",
   "author": "Daniel Wirtz <dcode@dcode.io>",
   "contributors": [
     "Frank Xu <yyfrankyy@gmail.com>"
   ],
-  "main": "dist/ProtoBuf.js",
+  "main": "./dist/protobuf.js",
   "bin": {
     "pbjs": "./bin/pbjs"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/dcodeIO/ProtoBuf.js.git"
+    "url": "https://github.com/dcodeIO/protobuf.js.git"
   },
   "bugs": {
-    "url": "https://github.com/dcodeIO/ProtoBuf.js/issues"
+    "url": "https://github.com/dcodeIO/protobuf.js/issues"
   },
-  "homepage": "https://github.com/dcodeIO/ProtoBuf.js",
+  "homepage": "https://github.com/dcodeIO/protobuf.js",
   "keywords": [
     "net",
     "buffer",
@@ -29,7 +29,7 @@
   ],
   "dependencies": {
     "ascli": "~1",
-    "bytebuffer": "~4 >=4.1",
+    "bytebuffer": "~5",
     "glob": "^5.0.10",
     "yargs": "^3.10.0"
   },
@@ -45,7 +45,8 @@
     "node": ">=0.8"
   },
   "browser": {
-   "fs": false
+    "fs": false,
+    "path": false
   },
   "scripts": {
     "prepublish": "npm test",
@@ -54,11 +55,11 @@
     "build": "node scripts/build.js",
     "descriptor2json": "node bin/pbjs src/google/protobuf/descriptor.proto --target=json > src/google/protobuf/descriptor.json",
     "compile": "npm run-script compile-full && npm run-script compile-light",
-    "compile-full": "ccjs dist/ProtoBuf.js --create_source_map=dist/ProtoBuf.min.map --compilation_level=SIMPLE_OPTIMIZATIONS > dist/ProtoBuf.min.js",
-    "compile-light": "ccjs dist/ProtoBuf-light.js --create_source_map=dist/ProtoBuf-light.min.map --compilation_level=SIMPLE_OPTIMIZATIONS > dist/ProtoBuf-light.min.js",
+    "compile-full": "ccjs dist/protobuf.js --create_source_map=dist/protobuf.min.map --compilation_level=SIMPLE_OPTIMIZATIONS > dist/protobuf.min.js",
+    "compile-light": "ccjs dist/protobuf-light.js --create_source_map=dist/protobuf-light.min.map --compilation_level=SIMPLE_OPTIMIZATIONS > dist/protobuf-light.min.js",
     "compress": "npm run-script compress-full && npm run-script compress-light",
-    "compress-full": "gzip -c -9 dist/ProtoBuf.min.js > dist/ProtoBuf.min.js.gz",
-    "compress-light": "gzip -c -9 dist/ProtoBuf-light.min.js > dist/ProtoBuf-light.min.js.gz",
+    "compress-full": "gzip -c -9 dist/protobuf.min.js > dist/protobuf.min.js.gz",
+    "compress-light": "gzip -c -9 dist/protobuf-light.min.js > dist/protobuf-light.min.js.gz",
     "jsdoc": "node node_modules/jsdoc/jsdoc.js -c jsdoc.json"
   }
 }

package/sandbox/issue347/index.js

@@ -0,0 +1,27 @@
+var ProtoBuf = require('../../'),
+    ByteBuffer = ProtoBuf.ByteBuffer;
+var prototext = String(function() {
+/*
+package str;
+
+message Value {
+  oneof type {
+    string string = 1;
+    bytes bytes = 2;
+  }
+}
+*/
+}).match(/\/\*([^]*)\*\//)[1];
+
+var builder = ProtoBuf.loadProto(prototext);
+var messageValue = builder.build('str.Value');
+var bb = ByteBuffer.wrap([10, 1, 97, 10, 2, 98, 98, 10, 3, 99, 99, 99]);
+bb.printDebug();
+var value1 = messageValue.decode(bb);
+bb.printDebug();
+bb = ByteBuffer.wrap([10, 3, 99, 99, 99]);
+bb.printDebug();
+var value2 = messageValue.decode(bb);
+bb.printDebug();
+console.log('value1: %j', value1);
+console.log('value2: %j', value2);

package/sandbox/issue355/main.proto

@@ -0,0 +1,15 @@
+message A {
+    repeated group EntryResponse = 1 {
+        required ResponseType response_type = 2;
+        optional string id_string = 3;
+        optional string parent_id_string = 4;
+        optional int64 position_in_parent = 5;
+        optional int64 version = 6;
+        optional string name = 7;
+        optional string non_unique_name = 8;
+        optional string error_message = 9;
+        optional int64 mtime = 10;
+    }
+
+    message ResponseType {}
+}

package/scripts/build.js

@@ -14,11 +14,6 @@
  limitations under the License.
  */
 
-/**
- * @overview ProtoBuf.js Build Script (c) 2014 Daniel Wirtz <dcode@dcode.io>
- * Released under the Apache License, Version 2.0
- * see: https://github.com/dcodeIO/ProtoBuf.js for details
- */
 var MetaScript = require("metascript"),
     path = require("path"),
     fs = require("fs");
@@ -35,17 +30,17 @@ var scope = {
 };
 
 // Make full build
-console.log("Building ProtoBuf.js with scope", JSON.stringify(scope, null, 2));
+console.log("Building protobuf.js with scope", JSON.stringify(scope, null, 2));
 fs.writeFileSync(
-    path.join(distDir, "ProtoBuf.js"),
+    path.join(distDir, "protobuf.js"),
     MetaScript.transform(fs.readFileSync(filename = path.join(srcDir, "wrap.js")), filename, scope, srcDir)
 );
 
 // Make light build
 scope.DOTPROTO = false;
-console.log("Building ProtoBuf-light.js with scope", JSON.stringify(scope, null, 2));
+console.log("Building protobuf-light.js with scope", JSON.stringify(scope, null, 2));
 fs.writeFileSync(
-    path.join(distDir, "ProtoBuf-light.js"),
+    path.join(distDir, "protobuf-light.js"),
     MetaScript.transform(fs.readFileSync(filename = path.join(srcDir, "wrap.js")), filename, scope, srcDir)
 );
 

package/src/ProtoBuf/Builder/Message.js

@@ -340,18 +340,19 @@ MessagePrototype.calculate = function() {
  * @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;
@@ -498,7 +499,7 @@ function cloneRaw(obj, binaryAsBase64, longsAsStrings, resolvedType) {
         return binaryAsBase64 ? obj.toBase64() : obj.toBuffer();
     // Convert Longs to proper objects or strings
     if (ProtoBuf.Long.isLong(obj))
-        return longsAsStrings ? obj.toString() : new ProtoBuf.Long(obj);
+        return longsAsStrings ? obj.toString() : ProtoBuf.Long.fromValue(obj);
     var clone;
     // Clone arrays
     if (Array.isArray(obj)) {
@@ -560,6 +561,7 @@ MessagePrototype.encodeJSON = function() {
  * @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
@@ -568,7 +570,10 @@ MessagePrototype.encodeJSON = function() {
  * @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

package/src/ProtoBuf/Builder/Service.js

@@ -77,6 +77,9 @@ for (var i=0; i<rpc.length; i++) {
                         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));

package/src/ProtoBuf/Builder.js

@@ -243,13 +243,12 @@ ProtoBuf.Builder = (function(ProtoBuf, Lang, Reflect) {
                             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
@@ -288,8 +287,16 @@ ProtoBuf.Builder = (function(ProtoBuf, Lang, Reflect) {
                         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'])
@@ -358,7 +365,7 @@ ProtoBuf.Builder = (function(ProtoBuf, Lang, Reflect) {
         if (typeof filename === 'string') {
 
             if (ProtoBuf.Util.IS_NODE)
-                filename = ProtoBuf.Util.require("path")['resolve'](filename);
+                filename = require("path")['resolve'](filename);
             if (this.files[filename] === true)
                 return this.reset();
             this.files[filename] = true;
@@ -367,7 +374,7 @@ ProtoBuf.Builder = (function(ProtoBuf, Lang, Reflect) {
 
             var root = filename.root;
             if (ProtoBuf.Util.IS_NODE)
-                root = ProtoBuf.Util.require("path")['resolve'](root);
+                root = require("path")['resolve'](root);
             if (root.indexOf("\\") >= 0 || filename.file.indexOf("\\") >= 0)
                 delim = '\\';
             var fname = root + delim + filename.file;

package/src/ProtoBuf/DotProto/Parser.js

@@ -50,7 +50,8 @@ ParserPrototype.parse = function() {
         // "syntax": undefined
     };
     var token,
-        head = true;
+        head = true,
+        weak;
     try {
         while (token = this.tn.next()) {
             switch (token) {
@@ -67,11 +68,12 @@ ParserPrototype.parse = function() {
                     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)
@@ -396,6 +398,7 @@ ParserPrototype._parseMessage = function(parent, fld) {
         "enums": [],
         "messages": [],
         "options": {},
+        "services": [],
         "oneofs": {}
         // "extensions": undefined
     };
@@ -422,8 +425,12 @@ ParserPrototype._parseMessage = function(parent, fld) {
             this._parseMessage(msg);
         else if (token === "option")
             this._parseOption(msg);
+        else if (token === "service")
+            this._parseService(msg);
         else if (token === "extensions")
-            this._parseExtensions(msg);
+            msg["extensions"] = this._parseExtensionRanges();
+        else if (token === "reserved")
+            this._parseIgnored(); // TODO
         else if (token === "extend")
             this._parseExtend(msg);
         else if (Lang.TYPEREF.test(token)) {
@@ -438,6 +445,16 @@ ParserPrototype._parseMessage = function(parent, fld) {
     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
@@ -600,29 +617,43 @@ ParserPrototype._parseEnum = function(msg) {
 };
 
 /**
- * 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;
 };
 
 /**

package/src/ProtoBuf/Reflect/Element.js

@@ -102,9 +102,10 @@ function mkLong(value, unsigned) {
  * @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"]:

package/src/ProtoBuf/Reflect/Message/Field.js

@@ -165,9 +165,10 @@ FieldPrototype.build = function() {
  */
 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");

package/src/ProtoBuf/Reflect/Message.js

@@ -20,10 +20,10 @@ var Message = function(builder, parent, name, options, isGroup, syntax) {
 
     /**
      * Extensions range.
-     * @type {!Array.<number>}
+     * @type {!Array.<number>|undefined}
      * @expose
      */
-    this.extensions = [ProtoBuf.ID_MIN, ProtoBuf.ID_MAX];
+    this.extensions = undefined;
 
     /**
      * Runtime message class.
@@ -204,7 +204,7 @@ function skipTillGroupEnd(expectedId, buf) {
 /**
  * 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

package/src/ProtoBuf/Util.js

@@ -60,8 +60,9 @@ ProtoBuf.Util = (function() {
         if (callback && typeof callback != 'function')
             callback = null;
         if (Util.IS_NODE) {
+            var fs = require("fs");
             if (callback) {
-                Util.require("fs").readFile(path, function(err, data) {
+                fs.readFile(path, function(err, data) {
                     if (err)
                         callback(null);
                     else
@@ -69,7 +70,7 @@ ProtoBuf.Util = (function() {
                 });
             } else
                 try {
-                    return Util.require("fs").readFileSync(path);
+                    return fs.readFileSync(path);
                 } catch (e) {
                     return null;
                 }
@@ -99,18 +100,6 @@ ProtoBuf.Util = (function() {
         }
     };
 
-    /**
-     * Requires a node module.
-     * @function
-     * @param {string} path
-     * @returns {*}
-     * @throws Error If node require is not supported
-     * @expose
-     */
-    Util.require = Util.IS_NODE
-        ? function(path) { return nodeRequire(path); }
-        : function(path) { throw Error("node require is not supported by this platform")};
-
     /**
      * Converts a string to camel case.
      * @param {string} str

package/src/bower.json

@@ -2,7 +2,7 @@
     "name": "protobuf",
     "description": "Protocol Buffers for JavaScript. Finally.",
     "version": /*?== VERSION */,
-    "main": "dist/ProtoBuf.js",
+    "main": "dist/protobuf.js",
     "license": "Apache-2.0",
     "homepage": "http://dcode.io/",
     "dependencies": {

package/src/google/protobuf/descriptor.json

@@ -484,8 +484,10 @@
                 }
             ],
             "extensions": [
-                1000,
-                536870911
+                [
+                    1000,
+                    536870911
+                ]
             ],
             "enums": [
                 {
@@ -536,8 +538,10 @@
                 }
             ],
             "extensions": [
-                1000,
-                536870911
+                [
+                    1000,
+                    536870911
+                ]
             ]
         },
         {
@@ -599,8 +603,10 @@
                 }
             ],
             "extensions": [
-                1000,
-                536870911
+                [
+                    1000,
+                    536870911
+                ]
             ],
             "enums": [
                 {
@@ -642,8 +648,10 @@
                 }
             ],
             "extensions": [
-                1000,
-                536870911
+                [
+                    1000,
+                    536870911
+                ]
             ]
         },
         {
@@ -657,8 +665,10 @@
                 }
             ],
             "extensions": [
-                1000,
-                536870911
+                [
+                    1000,
+                    536870911
+                ]
             ]
         },
         {
@@ -672,8 +682,10 @@
                 }
             ],
             "extensions": [
-                1000,
-                536870911
+                [
+                    1000,
+                    536870911
+                ]
             ]
         },
         {
@@ -687,8 +699,10 @@
                 }
             ],
             "extensions": [
-                1000,
-                536870911
+                [
+                    1000,
+                    536870911
+                ]
             ]
         },
         {

package/src/wrap.js

@@ -15,23 +15,23 @@
  */
 
 /**
- * @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"), require);
+        module["exports"] = factory(require("bytebuffer"), true);
     /* Global */ else
         (global["dcodeIO"] = global["dcodeIO"] || {})["ProtoBuf"] = factory(global["dcodeIO"]["ByteBuffer"]);
 
-})(this, function(ByteBuffer, nodeRequire) {
+})(this, function(ByteBuffer, isCommonJS) {
     "use strict";
 
-    //? include("ProtoBuf.js");
+    //? include("protobuf.js");
 
     return ProtoBuf;
 });

package/tests/imports-weak.proto

@@ -0,0 +1,7 @@
+package My;
+
+import weak "example1.proto";
+
+message Test2 {
+    required Test1 test1 = 1;
+}