protobufjs 5.0.1 → 5.0.2

package/.travis.yml

@@ -1,5 +1,6 @@
 language: node_js
 node_js:
   - 0.12
-  - 4.2
+  - 4
+  - 6
 sudo: false

package/README.md

@@ -1,4 +1,4 @@
-![protobuf.js - Protocol Buffers for JavaScript. Finally.](https://raw.github.com/dcodeIO/protobuf.js/master/protobuf.png)
+protobuf.js 5 [![Build Status](https://travis-ci.org/dcodeIO/protobuf.js.svg?branch=ProtoBuf5)](https://travis-ci.org/dcodeIO/protobuf.js) [![Donate](https://img.shields.io/badge/paypal-donate-yellow.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=dcode%40dcode.io&item_name=%3C3%20protobuf.js)
 =====================================
 **Protocol Buffers** are a language-neutral, platform-neutral, extensible way of serializing structured data for use
 in communications protocols, data storage, and more, originally designed at Google ([see](https://developers.google.com/protocol-buffers/docs/overview)).
@@ -7,13 +7,10 @@ in communications protocols, data storage, and more, originally designed at Goog
 including a .proto parser, message class building and simple encoding and decoding. There is no compilation step
 required, it's super easy to use and it works out of the box on .proto files!
 
-[![Build Status](https://travis-ci.org/dcodeIO/protobuf.js.svg?branch=master)](https://travis-ci.org/dcodeIO/protobuf.js)
-[![Donate](https://raw.githubusercontent.com/dcodeIO/protobuf.js/master/donate.png)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=dcode%40dcode.io&item_name=%3C3%20protobuf.js)
-
 Getting started
 ---------------
 * **Step 1:** Become familar with [Google's Protocol Buffers (protobuf)](https://developers.google.com/protocol-buffers/docs/overview)
-* **Step 2:** Head straight to [our wiki for up to date usage information, changes and examples](https://github.com/dcodeIO/protobuf.js/wiki)
+* **Step 2:** Read on or head straight to [our wiki](https://github.com/dcodeIO/protobuf.js/wiki) for additional information
 * **Step 3:** Build something cool! :-)
 
 Features
@@ -28,35 +25,160 @@ Features
 * Fully compatible to the official implementation including advanced features
 * proto2js command line utility
 
+Installation
+------------
+
+### node.js / CommonJS
+
+```
+$> npm install protobufjs
+```
+
+```js
+var ProtoBuf = require("protobufjs");
+...
+```
+
+### RequireJS / AMD
+
+Requires [bytebuffer.js](http://github.com/dcodeIO/bytebuffer.js). Optionally depends on [long.js](https://github.com/dcodeIO/long.js) for long (int64) support. If you do not require long support, you can skip the Long.js config. RequireJS example:
+
+```js
+require(["protobuf"], function(ProtoBuf) {
+    ...
+});
+```
+
+Or as a module dependency:
+
+```js
+define("MyModule", ["protobuf"], function(ProtoBuf) {
+    ...
+});
+```
+
+### Browser
+
+Requires [bytebuffer.js](http://github.com/dcodeIO/bytebuffer.js). Optionally depends on [long.js](https://github.com/dcodeIO/long.js) for long (int64) support. If you do not require long support, you can skip the Long.js include.
+
+```html
+<!-- Order is important -->
+<script src="long.min.js"></script>
+<script src="bytebuffer.min.js"></script>
+<script src="protobuf.min.js"></script>
+```
+
+```js
+var ProtoBuf = dcodeIO.ProtoBuf;
+...
+```
+
+Getting started
+---------------
+
+*Note:* You'll need the full build to load .proto data. light builds are able to load JSON only.
+
+### Loading .proto files
+
+To load a .proto file, use:
+
+**API:** `ProtoBuf.loadProtoFile(source[, callback[, builder]]):Builder|undefined`
+
+```js
+// Synchronously
+var builder = ProtoBuf.loadProtoFile("path/to/file.proto");
+
+// Asynchronously
+ProtoBuf.loadProtoFile("path/to/file.proto", function(err, builder) {
+    ...
+});
+```
+
+`ProtoBuf.loadProtoFile` also accepts an object specifying the import root directory and the file to load as its first parameter: `{root: string, file: string}`. Additionally, an already created and then reused builder can be specified as the last argument, which is useful if all the definitions shall reside in a single namespace.
+
+### Loading .proto strings
+
+**API:** `ProtoBuf.loadProto(source[, builder][, filename]):Builder`
+
+```js
+var builder = ProtoBuf.loadProto(...protoString..., "myproto.proto");
+```
+
+### Loading JSON files and strings
+
+To load the (raw) JSON counterpart generated through pbjs, use `ProtoBuf.loadJsonFile` respectively `ProtoBuf.loadJson`. It's the same API.
+
+If you generated classes or modules with it, loading is done just by including respectively requiring the resulting file. Loading is handled transparently in this case.
+
+When using JSON only, you can use protobuf-light.js or protobuf-light.min.js instead, which do NOT include the ProtoBuf.DotProto package for parsing and are therefore smaller.
+
+Command line
+------------
+Since ProtoBuf.js 4.0.0 the library ships with the `pbjs` command line utility. With it it's possible to convert between .proto and JSON descriptors and even to generate the code required to access runtime structures as pure JS (classes), an AMD module or a CommonJS module.
+
+```
+
+ _ |_ . _
+|_)|_)|_)           ProtoBuf.js v4.0.0-b3 https://github.com/dcodeIO/ProtoBuf.js
+|     '
+
+CLI utility to convert between .proto and JSON syntax / to generate classes.
+
+Usage: pbjs <filename> [options] [> outFile]
+
+Options:
+  --help, -h        Show help  [boolean]
+  --version, -v     Show version number  [boolean]
+  --source, -s      Specifies the source format. Valid formats are:
+
+                       json       Plain JSON descriptor
+                       proto      Plain .proto descriptor
+
+  --target, -t      Specifies the target format. Valid formats are:
+
+                       amd        Runtime structures as AMD module
+                       commonjs   Runtime structures as CommonJS module
+                       js         Runtime structures
+                       json       Plain JSON descriptor
+                       proto      Plain .proto descriptor
+
+  --using, -u       Specifies an option to apply to the volatile builder
+                    loading the source, e.g. convertFieldsToCamelCase.
+  --min, -m         Minifies the output.  [default: false]
+  --path, -p        Adds a directory to the include path.
+  --legacy, -l      Includes legacy descriptors from google/protobuf/ if
+                    explicitly referenced.  [default: false]
+  --quiet, -q       Suppresses any informatory output to stderr.  [default: false]
+  --use, -i         Specifies an option to apply to the emitted builder
+                    utilized by your program, e.g. populateAccessors.
+  --exports, -e     Specifies the namespace to export. Defaults to export
+                    the root namespace.
+  --dependency, -d  Library dependency to use when generating classes.
+                    Defaults to 'protobufjs' for CommonJS, 'ProtoBuf' for
+                    AMD modules and 'dcodeIO.ProtoBuf' for classes.
+```
+
 Documentation
 -------------
 * [Read the official protobuf guide](https://developers.google.com/protocol-buffers/docs/overview)
-* [Read our wiki](https://github.com/dcodeIO/protobuf.js/wiki)
-* [Read the API docs](http://htmlpreview.github.io/?https://raw.githubusercontent.com/dcodeIO/protobuf.js/master/docs/ProtoBuf.html)
-* [Check out the examples](https://github.com/dcodeIO/protobuf.js/tree/master/examples)
+* [Read the API docs](http://htmlpreview.github.io/?https://raw.githubusercontent.com/dcodeIO/protobuf.js/ProtoBuf5/docs/ProtoBuf.html)
+* [Check out the examples](https://github.com/dcodeIO/protobuf.js/tree/ProtoBuf5/examples)
 
 Tests
 -----
-* [View source](https://github.com/dcodeIO/protobuf.js/blob/master/tests/suite.js)
-* [View report](https://travis-ci.org/dcodeIO/protobuf.js)
+* [View source](https://github.com/dcodeIO/protobuf.js/blob/ProtoBuf5/tests/suite.js)
 
 Downloads
 ---------
-* [Distributions](https://github.com/dcodeIO/protobuf.js/tree/master/dist)
-* [ZIP-Archive](https://github.com/dcodeIO/protobuf.js/archive/master.zip)
-* [Tarball](https://github.com/dcodeIO/protobuf.js/tarball/master)
+* [Distributions](https://github.com/dcodeIO/protobuf.js/tree/ProtoBuf5/dist)
+* [ZIP-Archive](https://github.com/dcodeIO/protobuf.js/archive/ProtoBuf5.zip)
+* [Tarball](https://github.com/dcodeIO/protobuf.js/tarball/ProtoBuf5)
 
 CDN usage
 ---------
 ```html
-<script src="//cdn.rawgit.com/dcodeIO/protobuf.js/VERSION/dist/protobuf.js"></script>
+<script src="//cdn.rawgit.com/dcodeIO/protobuf.js/5.0.1/dist/protobuf.min.js"></script>
 ```
-With `VERSION` replaced by [a valid tag](https://github.com/dcodeIO/protobuf.js/releases) or just `master` for testing
-the latest master build.
-
-Contributors
-------------
-[Daniel Wirtz](https://github.com/dcodeIO) (maintainer), [Frank Xu](https://github.com/yyfrankyy),
-[Dretch](https://github.com/Dretch), [shirmin](https://github.com/shirmin), [Nikolai Vavilov](https://github.com/seishun)
+With the version pointing to the exact [release](https://github.com/dcodeIO/protobuf.js/releases) your project depends upon.
 
-**License:** [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html) - Logo derived from [W3C HTML5 Logos](http://www.w3.org/html/logo/) (CC A 3.0)
+**License:** [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html)

package/bin/pbjs

@@ -1,2 +1,2 @@
-#!/usr/bin/env node
-process.exit(require(__dirname+"/../cli/pbjs.js").main(process.argv));
+#!/usr/bin/env node
+process.exit(require(__dirname+"/../cli/pbjs.js").main(process.argv));

package/bower.json

@@ -1,12 +1,12 @@
 {
     "name": "protobuf",
     "description": "Protocol Buffers for JavaScript. Finally.",
-    "version": "5.0.1",
+    "version": "5.0.2",
     "main": "dist/protobuf.js",
     "license": "Apache-2.0",
     "homepage": "http://dcode.io/",
     "dependencies": {
-        "bytebuffer": "~3"
+        "bytebuffer": "~5"
     },
     "keywords": ["net", "buffer", "protobuf", "serialization", "bytebuffer", "websocket", "webrtc"],
     "ignore": [

package/cli/pbjs/targets/amd.js

@@ -30,7 +30,7 @@ var ProtoBuf = require("../../../index.js"),
 var amd = module.exports = function(builder, options) {
     options = options || {};
     return [
-        "define([", JSON.stringify(options.dependency || "ProtoBuf"), "]", options.min ? "," : ", ",
+        "define([", JSON.stringify(options.dependency || "protobuf"), "]", options.min ? "," : ", ",
         "function(ProtoBuf)", options.min ? "{" : " {\n    ",
         "return ProtoBuf",
         util.indent(js.build(builder, options), options.min ? "" : "    "), options.min ? "" : "\n",

package/cli/pbjs/targets/json.js

@@ -58,11 +58,14 @@ json.description = description;
 function buildNamespace(ns, out) {
     var messages, enums, services;
     util.extend(out, {
+        "syntax"   : ns.syntax   || 'proto2',
         "options"  : out.options || {},
         "messages" : messages = [],
         "enums"    : enums    = [],
         "services" : services = []
     });
+    if (!(ns instanceof ProtoBuf.Reflect.Message))
+        out['isNamespace'] = true;
     util.extend(out["options"], buildOptions(ns.options));
     ns.getChildren(ProtoBuf.Reflect.Enum).forEach(function(enm) {
         enums.push(buildEnum(enm));
@@ -131,6 +134,7 @@ function buildOptions(options) {
             case 'string':
             case 'number':
             case 'boolean':
+            case 'object':
                 break;
             default:
                 throw Error("Illegal option type: "+typeof(val));
@@ -148,6 +152,7 @@ function buildMessage(msg) {
     var fields, oneofs;
     var out = {
         "name"     : msg.name,
+        "syntax"   : msg.syntax || 'proto2',
         "options"  : {},
         "fields"   : fields   = [],
         "oneofs"   : oneofs   = {}
@@ -207,6 +212,7 @@ function buildEnum(enm) {
     var values;
     var out = {
         "name"    : enm.name,
+        "syntax"  : enm.syntax || 'proto2',
         "values"  : values = []
     };
     enm.getChildren(ProtoBuf.Reflect.Enum.Value).forEach(function(val) {
@@ -244,7 +250,9 @@ function buildService(svc) {
     svc.getChildren(ProtoBuf.Reflect.Service.RPCMethod).forEach(function(mtd) {
         rpc[mtd.name] = {
             "request": svc.qn(mtd.resolvedRequestType),
+            "request_stream": mtd.requestStream,
             "response": svc.qn(mtd.resolvedResponseType),
+            "response_stream": mtd.responseStream,
             "options": buildOptions(mtd.options)
         };
     });

package/cli/pbjs/util.js

@@ -124,5 +124,5 @@ util.groupExtensions = function(ns) {
  * @returns {boolean}
  */
 util.isDescriptor = function(name) {
-    return /^google\/protobuf\//.test(name);
+    return /^google\/protobuf\/descriptor/.test(name);
 };

package/cli/pbjs.js

@@ -175,7 +175,7 @@ pbjs.main = function(argv) {
             },
             dependency: {
                 alias: "d",
-                describe: "Library dependency to use when generating classes.\nDefaults to 'protobufjs' for CommonJS, 'ProtoBuf' for\nAMD modules and 'dcodeIO.ProtoBuf' for classes."
+                describe: "Library dependency to use when generating classes.\nDefaults to 'protobufjs' for CommonJS, 'protobuf' for\nAMD modules and 'dcodeIO.ProtoBuf' for classes."
             }
         })
         .alias("help", "h")