protobufjs 3.6.0 → 3.8.2

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "protobufjs",
-    "version": "3.6.0",
+    "version": "3.8.2",
     "description": "Protocol Buffers for JavaScript. Finally.",
     "author": "Daniel Wirtz <dcode@dcode.io>",
     "contributors": [
@@ -20,14 +20,14 @@
     },
     "keywords": ["net", "buffer", "protobuf", "serialization", "bytebuffer", "websocket", "webrtc"],
     "dependencies": {
-        "bytebuffer": "~3.3",
+        "bytebuffer": "~3 >=3.5",
         "ascli": "~0.3"
     },
     "devDependencies": {
         "testjs": "~1",
         "metascript": ">=0.18 <1",
         "closurecompiler": "~1",
-        "jsdoc": "~3.3"
+        "jsdoc": "~3.3.0-alpha10"
     },
     "license": "Apache-2.0",
     "engines": {

package/scripts/build.js

@@ -1,58 +1,58 @@
-/*
- 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.
- */
-
-/**
- * @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");
-
-var rootDir = path.join(__dirname, ".."),
-    srcDir  = path.join(rootDir, "src"),
-    distDir = path.join(rootDir, "dist"),
-    pkg = require(path.join(rootDir, "package.json")),
-    filename;
-
-var scope = {
-    VERSION: pkg.version,           // Version
-    NOPARSE: false                  // Whether to exclude the ProtoBuf.DotProto package (no parser, JSON only) or not
-};
-
-// Make full build
-console.log("Building ProtoBuf.js with scope", JSON.stringify(scope, null, 2));
-fs.writeFileSync(
-    path.join(distDir, "ProtoBuf.js"),
-    MetaScript.transform(fs.readFileSync(filename = path.join(srcDir, "ProtoBuf.js")), filename, scope, srcDir)
-);
-
-// Make NOPARSE build
-scope.NOPARSE = true;
-console.log("Building ProtoBuf.noparse.js with scope", JSON.stringify(scope, null, 2));
-fs.writeFileSync(
-    path.join(distDir, "ProtoBuf.noparse.js"),
-    MetaScript.transform(fs.readFileSync(filename = path.join(srcDir, "ProtoBuf.js")), filename, scope, srcDir)
-);
-
-// Update bower.json
-scope = { VERSION: pkg.version };
-console.log("Updating bower.json with scope", JSON.stringify(scope, null, 2));
-fs.writeFileSync(
-    path.join(rootDir, "bower.json"),
-    MetaScript.transform(fs.readFileSync(filename = path.join(srcDir, "bower.json")), filename, scope, srcDir)
-);
+/*
+ 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.
+ */
+
+/**
+ * @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");
+
+var rootDir = path.join(__dirname, ".."),
+    srcDir  = path.join(rootDir, "src"),
+    distDir = path.join(rootDir, "dist"),
+    pkg = require(path.join(rootDir, "package.json")),
+    filename;
+
+var scope = {
+    VERSION: pkg.version,           // Version
+    NOPARSE: false                  // Whether to exclude the ProtoBuf.DotProto package (no parser, JSON only) or not
+};
+
+// Make full build
+console.log("Building ProtoBuf.js with scope", JSON.stringify(scope, null, 2));
+fs.writeFileSync(
+    path.join(distDir, "ProtoBuf.js"),
+    MetaScript.transform(fs.readFileSync(filename = path.join(srcDir, "ProtoBuf.js")), filename, scope, srcDir)
+);
+
+// Make NOPARSE build
+scope.NOPARSE = true;
+console.log("Building ProtoBuf.noparse.js with scope", JSON.stringify(scope, null, 2));
+fs.writeFileSync(
+    path.join(distDir, "ProtoBuf.noparse.js"),
+    MetaScript.transform(fs.readFileSync(filename = path.join(srcDir, "ProtoBuf.js")), filename, scope, srcDir)
+);
+
+// Update bower.json
+scope = { VERSION: pkg.version };
+console.log("Updating bower.json with scope", JSON.stringify(scope, null, 2));
+fs.writeFileSync(
+    path.join(rootDir, "bower.json"),
+    MetaScript.transform(fs.readFileSync(filename = path.join(srcDir, "bower.json")), filename, scope, srcDir)
+);

package/src/ProtoBuf/Builder/Message.js

@@ -2,7 +2,8 @@
  // --- Scope ------------------
  // T : Reflect.Message instance
  */
-var fields = T.getChildren(ProtoBuf.Reflect.Message.Field);
+var fields = T.getChildren(ProtoBuf.Reflect.Message.Field),
+    oneofs = T.getChildren(ProtoBuf.Reflect.Message.OneOf);
 
 /**
  * Constructs a new runtime Message.
@@ -16,9 +17,13 @@ var fields = T.getChildren(ProtoBuf.Reflect.Message.Field);
 var Message = function(values, var_args) {
     ProtoBuf.Builder.Message.call(this);
 
-    // Create fields on the object itself and set default values
-    for (var i=0, k=fields.length, field; i<k; ++i) {
-        this[(field = fields[i]).name] = field.repeated ? [] : null;
+    // Create virtual oneof properties
+    for (var i=0, k=oneofs.length; i<k; ++i)
+        this[oneofs[i].name] = null;
+    // Create fields and set default values
+    for (i=0, k=fields.length; i<k; ++i) {
+        var field = fields[i];
+        this[field.name] = field.repeated ? [] : null;
         if (field.required && field.defaultValue !== null)
             this[field.name] = field.defaultValue;
     }
@@ -34,21 +39,17 @@ var Message = function(values, var_args) {
             var keys = Object.keys(values);
             for (i=0, k=keys.length; i<k; ++i)
                 this.$set(keys[i], values[keys[i]]); // May throw
-        } else // set field values from arguments, in declaration order
+        } else // Set field values from arguments, in declaration order
             for (i=0, k=arguments.length; i<k; ++i)
                 this.$set(fields[i].name, arguments[i]); // May throw
     }
 };
 
 /**
- * The message's reflection type.
- * @name ProtoBuf.Builder.Message#$type
- * @type {!ProtoBuf.Reflect.Message}
- * @expose
+ * @alias ProtoBuf.Builder.Message.prototype
+ * @inner
  */
-
-// Extends ProtoBuf.Builder.Message
-Message.prototype = Object.create(ProtoBuf.Builder.Message.prototype);
+var MessagePrototype = Message.prototype = Object.create(ProtoBuf.Builder.Message.prototype);
 
 /**
  * Adds a value to a repeated field.
@@ -60,14 +61,16 @@ Message.prototype = Object.create(ProtoBuf.Builder.Message.prototype);
  * @throws {Error} If the value cannot be added
  * @expose
  */
-Message.prototype.add = function(key, value, noAssert) {
-    var field = T.getChild(key);
-    if (!field)
-        throw Error(this+"#"+key+" is undefined");
-    if (!(field instanceof ProtoBuf.Reflect.Message.Field))
-        throw Error(this+"#"+key+" is not a field: "+field.toString(true)); // May throw if it's an enum or embedded message
-    if (!field.repeated)
-        throw Error(this+"#"+key+" is not a repeated field");
+MessagePrototype.add = function(key, value, noAssert) {
+    var field = T._fieldsByName[key];
+    if (!noAssert) {
+        if (!field)
+            throw Error(this+"#"+key+" is undefined");
+        if (!(field instanceof ProtoBuf.Reflect.Message.Field))
+            throw Error(this+"#"+key+" is not a field: "+field.toString(true)); // May throw if it's an enum or embedded message
+        if (!field.repeated)
+            throw Error(this+"#"+key+" is not a repeated field");
+    }
     if (this[field.name] === null)
         this[field.name] = [];
     this[field.name].push(noAssert ? value : field.verifyValue(value, true));
@@ -83,7 +86,7 @@ Message.prototype.add = function(key, value, noAssert) {
  * @throws {Error} If the value cannot be added
  * @expose
  */
-Message.prototype.$add = Message.prototype.add;
+MessagePrototype.$add = MessagePrototype.add;
 
 /**
  * Sets a field's value.
@@ -96,23 +99,31 @@ Message.prototype.$add = Message.prototype.add;
  * @throws {Error} If the value cannot be set
  * @expose
  */
-Message.prototype.set = function(key, value, noAssert) {
+MessagePrototype.set = function(key, value, noAssert) {
     if (key && typeof key === 'object') {
         for (var i in key)
             if (key.hasOwnProperty(i))
                 this.$set(i, key[i], noAssert);
         return this;
     }
-    if (noAssert) {
-        this[key] = value;
-        return this;
+    var field = T._fieldsByName[key];
+    if (!noAssert) {
+        if (!field)
+            throw Error(this+"#"+key+" is not a field: undefined");
+        if (!(field instanceof ProtoBuf.Reflect.Message.Field))
+            throw Error(this+"#"+key+" is not a field: "+field.toString(true));
+        this[field.name] = (value = field.verifyValue(value)); // May throw
+    } else {
+        this[field.name] = value;
+    }
+    if (field.oneof) {
+        if (value !== null) {
+            if (this[field.oneof.name] !== null)
+                this[this[field.oneof.name]] = null; // Unset the previous (field name is the oneof field's value)
+            this[field.oneof.name] = field.name;
+        } else if (field.oneof.name === key)
+            this[field.oneof.name] = null;
     }
-    var field = T.getChild(key);
-    if (!field)
-        throw Error(this+"#"+key+" is not a field: undefined");
-    if (!(field instanceof ProtoBuf.Reflect.Message.Field))
-        throw Error(this+"#"+key+" is not a field: "+field.toString(true));
-    this[field.name] = field.verifyValue(value); // May throw
     return this;
 };
 
@@ -122,26 +133,26 @@ Message.prototype.set = function(key, value, noAssert) {
  * @function
  * @param {string} key Key
  * @param {*} value Value to set
- * @param {boolean=} noAssert Whether to assert the value or not (asserts by default)
+ * @param {boolean=} noAssert Whether to not assert the value, defaults to `false`
  * @throws {Error} If the value cannot be set
  * @expose
  */
-Message.prototype.$set = Message.prototype.set;
+MessagePrototype.$set = MessagePrototype.set;
 
 /**
  * Gets a field's value.
  * @name ProtoBuf.Builder.Message#get
  * @function
  * @param {string} key Key
- * @param {boolean=} noAssert Whether to no assert for an actual field, defaults to `false`
+ * @param {boolean=} noAssert Whether to not assert for an actual field, defaults to `false`
  * @return {*} Value
  * @throws {Error} If there is no such field
  * @expose
  */
-Message.prototype.get = function(key, noAssert) {
+MessagePrototype.get = function(key, noAssert) {
     if (noAssert)
         return this[key];
-    var field = T.getChild(key);
+    var field = T._fieldsByName[key];
     if (!field || !(field instanceof ProtoBuf.Reflect.Message.Field))
         throw Error(this+"#"+key+" is not a field: undefined");
     if (!(field instanceof ProtoBuf.Reflect.Message.Field))
@@ -158,7 +169,7 @@ Message.prototype.get = function(key, noAssert) {
  * @throws {Error} If there is no such field
  * @expose
  */
-Message.prototype.$get = Message.prototype.get;
+MessagePrototype.$get = MessagePrototype.get;
 
 // Getters and setters
 
@@ -168,72 +179,91 @@ for (var i=0; i<fields.length; i++) {
     if (field instanceof ProtoBuf.Reflect.Message.ExtensionField)
         continue;
 
-    if (ProtoBuf.populateAccessors)
+    if (T.builder.options['populateAccessors'])
         (function(field) {
             // set/get[SomeValue]
             var Name = field.originalName.replace(/(_[a-zA-Z])/g, function(match) {
                 return match.toUpperCase().replace('_','');
             });
-            Name = Name.substring(0,1).toUpperCase()+Name.substring(1);
+            Name = Name.substring(0,1).toUpperCase() + Name.substring(1);
 
-            // set/get_[some_value]
+            // set/get_[some_value] FIXME: Do we really need these?
             var name = field.originalName.replace(/([A-Z])/g, function(match) {
                 return "_"+match;
             });
 
+            /**
+             * The current field's unbound setter function.
+             * @function
+             * @param {*} value
+             * @param {boolean=} noAssert
+             * @returns {!ProtoBuf.Builder.Message}
+             * @inner
+             */
+            var setter = function(value, noAssert) {
+                this[field.name] = noAssert ? value : field.verifyValue(value);
+                return this;
+            };
+
+            /**
+             * The current field's unbound getter function.
+             * @function
+             * @returns {*}
+             * @inner
+             */
+            var getter = function() {
+                return this[field.name];
+            };
+
             /**
              * Sets a value. This method is present for each field, but only if there is no name conflict with
-             * another field.
+             *  another field.
              * @name ProtoBuf.Builder.Message#set[SomeField]
              * @function
              * @param {*} value Value to set
+             * @param {boolean=} noAssert Whether to not assert the value, defaults to `false`
+             * @returns {!ProtoBuf.Builder.Message} this
              * @abstract
              * @throws {Error} If the value cannot be set
              */
             if (T.getChild("set"+Name) === null)
-                Message.prototype["set"+Name] = function(value) {
-                    this.$set(field.name, value);
-                };
+                MessagePrototype["set"+Name] = setter;
 
             /**
              * Sets a value. This method is present for each field, but only if there is no name conflict with
-             * another field.
+             *  another field.
              * @name ProtoBuf.Builder.Message#set_[some_field]
              * @function
              * @param {*} value Value to set
+             * @param {boolean=} noAssert Whether to not assert the value, defaults to `false`
+             * @returns {!ProtoBuf.Builder.Message} this
              * @abstract
              * @throws {Error} If the value cannot be set
              */
             if (T.getChild("set_"+name) === null)
-                Message.prototype["set_"+name] = function(value) {
-                    this.$set(field.name, value);
-                };
+                MessagePrototype["set_"+name] = setter;
 
             /**
              * Gets a value. This method is present for each field, but only if there is no name conflict with
-             * another field.
+             *  another field.
              * @name ProtoBuf.Builder.Message#get[SomeField]
              * @function
              * @abstract
              * @return {*} The value
              */
             if (T.getChild("get"+Name) === null)
-                Message.prototype["get"+Name] = function() {
-                    return this.$get(field.name); // Does not throw, field exists
-                };
+                MessagePrototype["get"+Name] = getter;
 
             /**
              * Gets a value. This method is present for each field, but only if there is no name conflict with
-             * another field.
+             *  another field.
              * @name ProtoBuf.Builder.Message#get_[some_field]
              * @function
              * @return {*} The value
              * @abstract
              */
             if (T.getChild("get_"+name) === null)
-                Message.prototype["get_"+name] = function() {
-                    return this.$get(field.name); // Does not throw, field exists
-                };
+                MessagePrototype["get_"+name] = getter;
 
         })(field);
 }
@@ -254,7 +284,7 @@ for (var i=0; i<fields.length; i++) {
  * @see ProtoBuf.Builder.Message#encodeHex
  * @see ProtoBuf.Builder.Message#encodeAB
  */
-Message.prototype.encode = function(buffer, noVerify) {
+MessagePrototype.encode = function(buffer, noVerify) {
     if (typeof buffer === 'boolean')
         noVerify = buffer,
         buffer = undefined;
@@ -280,7 +310,7 @@ Message.prototype.encode = function(buffer, noVerify) {
  * @throws {Error} If the message cannot be calculated or if required fields are missing.
  * @expose
  */
-Message.prototype.calculate = function() {
+MessagePrototype.calculate = function() {
     return T.calculate(this);
 };
 
@@ -294,7 +324,7 @@ Message.prototype.calculate = function() {
  *  returns the encoded ByteBuffer in the `encoded` property on the error.
  * @expose
  */
-Message.prototype.encodeDelimited = function(buffer) {
+MessagePrototype.encodeDelimited = function(buffer) {
     var isNew = false;
     if (!buffer)
         buffer = new ByteBuffer(),
@@ -315,7 +345,7 @@ Message.prototype.encodeDelimited = function(buffer) {
  *  returns the encoded ArrayBuffer in the `encoded` property on the error.
  * @expose
  */
-Message.prototype.encodeAB = function() {
+MessagePrototype.encodeAB = function() {
     try {
         return this.encode().toArrayBuffer();
     } catch (e) {
@@ -333,7 +363,7 @@ Message.prototype.encodeAB = function() {
  *  returns the encoded ArrayBuffer in the `encoded` property on the error.
  * @expose
  */
-Message.prototype.toArrayBuffer = Message.prototype.encodeAB;
+MessagePrototype.toArrayBuffer = MessagePrototype.encodeAB;
 
 /**
  * Directly encodes the message to a node Buffer.
@@ -344,7 +374,7 @@ Message.prototype.toArrayBuffer = Message.prototype.encodeAB;
  *  missing. The later still returns the encoded node Buffer in the `encoded` property on the error.
  * @expose
  */
-Message.prototype.encodeNB = function() {
+MessagePrototype.encodeNB = function() {
     try {
         return this.encode().toBuffer();
     } catch (e) {
@@ -362,7 +392,7 @@ Message.prototype.encodeNB = function() {
  *  returns the encoded node Buffer in the `encoded` property on the error.
  * @expose
  */
-Message.prototype.toBuffer = Message.prototype.encodeNB;
+MessagePrototype.toBuffer = MessagePrototype.encodeNB;
 
 /**
  * Directly encodes the message to a base64 encoded string.
@@ -373,7 +403,7 @@ Message.prototype.toBuffer = Message.prototype.encodeNB;
  *  still returns the encoded base64 string in the `encoded` property on the error.
  * @expose
  */
-Message.prototype.encode64 = function() {
+MessagePrototype.encode64 = function() {
     try {
         return this.encode().toBase64();
     } catch (e) {
@@ -391,7 +421,7 @@ Message.prototype.encode64 = function() {
  *  returns the encoded base64 string in the `encoded` property on the error.
  * @expose
  */
-Message.prototype.toBase64 = Message.prototype.encode64;
+MessagePrototype.toBase64 = MessagePrototype.encode64;
 
 /**
  * Directly encodes the message to a hex encoded string.
@@ -402,7 +432,7 @@ Message.prototype.toBase64 = Message.prototype.encode64;
  *  still returns the encoded hex string in the `encoded` property on the error.
  * @expose
  */
-Message.prototype.encodeHex = function() {
+MessagePrototype.encodeHex = function() {
     try {
         return this.encode().toHex();
     } catch (e) {
@@ -420,38 +450,38 @@ Message.prototype.encodeHex = function() {
  *  returns the encoded hex string in the `encoded` property on the error.
  * @expose
  */
-Message.prototype.toHex = Message.prototype.encodeHex;
+MessagePrototype.toHex = MessagePrototype.encodeHex;
 
 /**
  * Clones a message object to a raw object.
  * @param {*} obj Object to clone
- * @param {boolean} includeBuffers Whether to include native buffer data or not
+ * @param {boolean} includeBinaryAsBase64 Whether to include binary data as base64 strings or not
  * @returns {*} Cloned object
  * @inner
  */
-function cloneRaw(obj, includeBuffers) {
+function cloneRaw(obj, includeBinaryAsBase64) {
     var clone = {};
     for (var i in obj)
         if (obj.hasOwnProperty(i)) {
             if (obj[i] === null || typeof obj[i] !== 'object')
                 clone[i] = obj[i];
             else if (obj[i] instanceof ByteBuffer) {
-                if (includeBuffers)
-                    clone[i] = obj.toBuffer();
+                if (includeBinaryAsBase64)
+                    clone[i] = obj[i].toBase64();
             } else // is a non-null object
-                clone[i] = cloneRaw(obj[i], includeBuffers);
+                clone[i] = cloneRaw(obj[i], includeBinaryAsBase64);
         }
     return clone;
 }
 
 /**
  * Returns the message's raw payload.
- * @param {boolean=} includeBuffers Whether to include native buffer data or not, defaults to `false`
+ * @param {boolean=} includeBinaryAsBase64 Whether to include binary data as base64 strings or not, defaults to `false`
  * @returns {Object.<string,*>} Raw payload
  * @expose
  */
-Message.prototype.toRaw = function(includeBuffers) {
-    return cloneRaw(this, !!includeBuffers);
+MessagePrototype.toRaw = function(includeBinaryAsBase64) {
+    return cloneRaw(this, !!includeBinaryAsBase64);
 };
 
 /**
@@ -552,7 +582,7 @@ Message.decodeHex = function(str) {
  * @return {string} String representation as of ".Fully.Qualified.MessageName"
  * @expose
  */
-Message.prototype.toString = function() {
+MessagePrototype.toString = function() {
     return T.toString();
 };
 
@@ -576,6 +606,6 @@ var $type; // cc
 
 if (Object.defineProperty)
     Object.defineProperty(Message, '$options', { "value": T.buildOpt() }),
-    Object.defineProperty(Message.prototype, "$type", {
+    Object.defineProperty(MessagePrototype, "$type", {
         get: function() { return T; }
     });

package/src/ProtoBuf/Builder/Service.js

@@ -27,12 +27,15 @@ var Service = function(rpcImpl) {
     };
 };
 
-// Extends ProtoBuf.Builder.Service
-Service.prototype = Object.create(ProtoBuf.Builder.Service.prototype);
+/**
+ * @alias ProtoBuf.Builder.Service.prototype
+ * @inner
+ */
+var ServicePrototype = Service.prototype = Object.create(ProtoBuf.Builder.Service.prototype);
 
 if (Object.defineProperty)
     Object.defineProperty(Service, "$options", { "value": T.buildOpt() }),
-    Object.defineProperty(Service.prototype, "$options", { "value": Service["$options"] });
+    Object.defineProperty(ServicePrototype, "$options", { "value": Service["$options"] });
 
 /**
  * Asynchronously performs an RPC call using the given RPC implementation.
@@ -60,7 +63,7 @@ for (var i=0; i<rpc.length; i++) {
     (function(method) {
 
         // service#Method(message, callback)
-        Service.prototype[method.name] = function(req, callback) {
+        ServicePrototype[method.name] = function(req, callback) {
             try {
                 if (!req || !(req instanceof method.resolvedRequestType.clazz)) {
                     setTimeout(callback.bind(this, Error("Illegal request type provided to service method "+T.name+"#"+method.name)), 0);
@@ -90,6 +93,6 @@ for (var i=0; i<rpc.length; i++) {
 
         if (Object.defineProperty)
             Object.defineProperty(Service[method.name], "$options", { "value": method.buildOpt() }),
-            Object.defineProperty(Service.prototype[method.name], "$options", { "value": Service[method.name]["$options"] });
+            Object.defineProperty(ServicePrototype[method.name], "$options", { "value": Service[method.name]["$options"] });
     })(rpc[i]);
 }