wildfire chat server source initial submit
This commit is contained in:
Executable
+15
@@ -0,0 +1,15 @@
|
||||
**/node_modules/*
|
||||
bin/*
|
||||
cli/wrappers/*
|
||||
coverage/*
|
||||
dist/*
|
||||
docs/*
|
||||
lib/deep-equal/*
|
||||
lib/prelude.js
|
||||
lib/polyfill.js
|
||||
lib/tape-adapter.js
|
||||
lib/tsd-jsdoc/*
|
||||
lib/*/tests/*
|
||||
sandbox/*
|
||||
scripts/*
|
||||
tests/*
|
||||
+11
@@ -0,0 +1,11 @@
|
||||
protobuf.js version: <please fill in>
|
||||
|
||||
<please describe the expected and actual behavior>
|
||||
|
||||
```js
|
||||
<please provide a code snippet for reproduction>
|
||||
```
|
||||
|
||||
```
|
||||
<please paste the stack trace of the error if applicable>
|
||||
```
|
||||
Executable
+7
@@ -0,0 +1,7 @@
|
||||
*.log
|
||||
npm-debug.*
|
||||
node_modules/
|
||||
cli/node_modules/
|
||||
docs/
|
||||
coverage/
|
||||
sandbox/
|
||||
Executable
+10
@@ -0,0 +1,10 @@
|
||||
dist: trusty
|
||||
language: node_js
|
||||
node_js:
|
||||
- node
|
||||
- lts/*
|
||||
- 4.3.2
|
||||
- 4
|
||||
branches:
|
||||
only: master
|
||||
script: npm test && npm run bench
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"typescript.tsdk": "./node_modules/typescript/lib",
|
||||
"vsicons.presets.angular": false
|
||||
}
|
||||
Executable
+935
@@ -0,0 +1,935 @@
|
||||
# [6.8.8](https://github.com/dcodeIO/protobuf.js/releases/tag/6.8.8)
|
||||
|
||||
## Fixed
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/3001425b0d896d14188307cd0cc84ce195ad9e04) Persist recent index.d.ts changes in JSDoc<br />
|
||||
|
||||
# [6.8.7](https://github.com/dcodeIO/protobuf.js/releases/tag/6.8.7)
|
||||
|
||||
## Fixed
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/e8449c4bf1269a2cc423708db6f0b47a383d33f0) Fix package browser field descriptor ([#1046](https://github.com/dcodeIO/protobuf.js/issues/1046))<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/996b3fa0c598ecc73302bfc39208c44830f07b1a) Fix static codegen issues with uglifyjs3<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/a06317139b92fdd8c6b3b188fb7b9704dc8ccbf1) Fix lint issues / pbts on windows<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/a927a6646e8fdddebcb3e13bc8b28b041b3ee40a) Fix empty 'bytes' field decoding, now using Buffer where applicable ([#1020](https://github.com/dcodeIO/protobuf.js/issues/1020))<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/f13a81fb41fbef2ce9dcee13f23b7276c83fbcfd) Fix circular dependency of Namespace and Enum ([#994](https://github.com/dcodeIO/protobuf.js/issues/994))<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/c05c58fad61c16e5ce20ca19758e4782cdd5d2e3) Ignore optional commas in aggregate options ([#999](https://github.com/dcodeIO/protobuf.js/issues/999))<br />
|
||||
|
||||
## New
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/36fc964b8db1e4372c76b1baf9f03857cd875b07) Make Message<T> have a default type param ([#1086](https://github.com/dcodeIO/protobuf.js/issues/1086))<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/996b3fa0c598ecc73302bfc39208c44830f07b1a) Explicitly define service method names when generating static code, see [#857](https://github.com/dcodeIO/protobuf.js/issues/857)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/07c5d59e1da8c5533a39007ba332928206281408) Also handle services in ext/descriptor ([#1001](https://github.com/dcodeIO/protobuf.js/issues/1001))<br />
|
||||
|
||||
## CLI
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/2c5ef95818a310243f88ffba0331cd47ee603c0a) Extend list of ignored ESLint rules for pbjs, fixes [#1085](https://github.com/dcodeIO/protobuf.js/issues/1085)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/8576b49ad3e55b8beae2a8f044c51040484eef12) Fix declared return type of pbjs/pbts callback ([#1025](https://github.com/dcodeIO/protobuf.js/issues/1025))<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/9fceaa69667895e609a3ed78eb2efa7a0ecfb890) Added an option to pbts to allow custom imports ([#1038](https://github.com/dcodeIO/protobuf.js/issues/1038))<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/65d113b0079fa2570837f3cf95268ce24714a248) Get node executable path from process.execPath ([#1018](https://github.com/dcodeIO/protobuf.js/issues/1018))<br />
|
||||
|
||||
## Other
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/b611875cfbc1f98d8973a2e86f1506de84f00049) Slim down CI testing and remove some not ultimately necesssary dependencies with audit issues<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/812b38ddabb35e154f9ff94f32ad8ce2a70310f1) Move global handling to util, see [#995](https://github.com/dcodeIO/protobuf.js/issues/995)<br />
|
||||
|
||||
# [6.8.6](https://github.com/dcodeIO/protobuf.js/releases/tag/6.8.6)
|
||||
|
||||
## Fixed
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/2ee1028d631a328e152d7e09f2a0e0c5c83dc2aa) Fix typeRefRe being vulnerable to ReDoS<br />
|
||||
|
||||
# [6.8.5](https://github.com/dcodeIO/protobuf.js/releases/tag/6.8.6)
|
||||
|
||||
## New
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/462132f222d8febb8211d839635aad5b82dc6315) Preserve comments when serializing/deserializing with toJSON and fromJSON. ([#983](https://github.com/dcodeIO/protobuf.js/issues/983))<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/d29c0caa715a14214fc755b3cf10ac119cdaf199) Add more details to some frequent error messages ([#962](https://github.com/dcodeIO/protobuf.js/issues/962))<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/8400f87ad8ed2b47e659bc8bb6c3cf2467802425) Add IParseOptions#alternateCommentMode ([#968](https://github.com/dcodeIO/protobuf.js/issues/968))<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/d6e3b9e218896ec1910e02448b5ee87e4d96ede6) Added field_mask to built-in common wrappers ([#982](https://github.com/dcodeIO/protobuf.js/issues/982))<br />
|
||||
|
||||
## Other
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/635fef013fbb3523536d92c690ffd7d84829db35) Remove code climate config in order to use 'in-app' config instead<br />
|
||||
|
||||
# [6.8.4](https://github.com/dcodeIO/protobuf.js/releases/tag/6.8.4)
|
||||
|
||||
## Other
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/69440c023e6962c644715a0c95363ddf19db648f) Update jsdoc dependency (pinned vulnerable marked)<br />
|
||||
|
||||
# [6.8.3](https://github.com/dcodeIO/protobuf.js/releases/tag/6.8.3)
|
||||
|
||||
## CLI
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/cc991a058b0636f3454166c76de7b664cf23a8f4) Use correct safeProp in json-module target, see [#956](https://github.com/dcodeIO/protobuf.js/issues/956)<br />
|
||||
|
||||
# [6.8.2](https://github.com/dcodeIO/protobuf.js/releases/tag/6.8.2)
|
||||
|
||||
## Other
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/6fc6481d790648e9e2169a961ad31a732398c911) Include dist files in npm package, see [#955](https://github.com/dcodeIO/protobuf.js/issues/955)<br />
|
||||
|
||||
# [6.8.1](https://github.com/dcodeIO/protobuf.js/releases/tag/6.8.1)
|
||||
|
||||
## Fixed
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/db2dd49f6aab6ecd606eee334b95cc0969e483c2) Prevent invalid JSDoc names when generating service methods, see [#870](https://github.com/dcodeIO/protobuf.js/issues/870)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/62297998d681357ada70fb370b99bac5573e5054) Prevent parse errors when generating service method names, see [#870](https://github.com/dcodeIO/protobuf.js/issues/870)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/478f332e0fc1d0c318a70b1514b1d59c8c200c37) Support parsing nested option-values with or without ':' ([#951](https://github.com/dcodeIO/protobuf.js/issues/951), fixes [#946](https://github.com/dcodeIO/protobuf.js/issues/946))<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/83477ca8e0e1f814ac79a642ea656f047563613a) Add support for reserved keyword in enums ([#950](https://github.com/dcodeIO/protobuf.js/issues/950), fixes [#949](https://github.com/dcodeIO/protobuf.js/issues/949))<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/c482a5b76fd57769eae4308793e3ff8725264664) Unified safe property escapes and added a test for [#834](https://github.com/dcodeIO/protobuf.js/issues/834)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/1724581c36ecc4fc166ea14a9dd57af5e093a467) Fix codegen if type name starts with "Object"<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/adecd544c5fcbeba28d502645f895024e3552970) Fixed dependency for json-module to use "light".<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/2a8dd74fca70d4e6fb41328a7cee81d1d50ad7ad) Basic support for URL prefixes in google.protobuf.Any types.<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/be78a3d9bc8d9618950c77f9e261b422670042ce) fixed 'error is not defined linter warning when using static/static-module and es6<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/c712447b309ae81134c7afd60f8dfa5ecd3be230) Fixed wrong type_url for any type (no leading '.' allowed).<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/145bda25ee1de2c0678ce7b8a093669ec2526b1d) Fixed fromObject() for google.protobuf.Any types.<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/7dec43d9d847481ad93fca498fd970b3a4a14b11) Handle case where 'extendee' is undefined in ext/descriptor<br />
|
||||
|
||||
## CLI
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/20a26271423319085d321878edc5166a5449e68a) Sanitize CR-only line endings (coming from jsdoc?)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/19d2af12b5db5a0f668f50b0cae3ee0f8a7affc2) Make sure enum typings become generated ([#884](https://github.com/dcodeIO/protobuf.js/issues/884) didn't solve this)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/a2c72c08b0265b112d367fa3d33407ff0de955b9) Remove exclude and include patterns from jsdoc config<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/9afb8a2ff27c1e0a999d7331f3f65f568f5cced5) Skip defaults when generating proto3<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/952c7d1b478cc7c6de82475a17a1387992e8651f) Wait for both the 'end' and 'close' event to happen before finishing in pbts, see [#863](https://github.com/dcodeIO/protobuf.js/issues/863)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/ed7e2e71f5cde27c4128f4f2e3f4782cc51fbec7) Accept null for optional fields in generated static code<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/27cc66a539251216ef10aea04652d58113949df9) Annotate TS classes with @implements<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/05e7e0636727008c72549459b8594fa0442d346f) Annotate virtual oneofs as string literal unions<br />
|
||||
|
||||
## New
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/685adb0e7ef0f50e4b93a105013547884957cc98) Also check for reserved ids and names in enums<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/843d0d5b927968025ca11babff28495dd3bb2863) Also support 'reserved' in enum descriptors<br />
|
||||
|
||||
## Other
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/a8376b57fb0a858adff9dc8a1d1b5372eff9d85c) Include just relevant files in npm package, fixes [#781](https://github.com/dcodeIO/protobuf.js/issues/781)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/bda1bc6917c681516f6be8be8f0e84ba1262c4ce) Fix travis build<br />
|
||||
|
||||
# [6.8.0](https://github.com/dcodeIO/protobuf.js/releases/tag/6.8.0)
|
||||
|
||||
## Breaking
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/ff858003f525db542cbb270777b6fab3a230c9bb) Replaced Buffer and Long types with interfaces and removed stubs<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/22f907c49adbbdf09b72bde5299271dbe0ee9cbe) Removed Message#toObject in favor of having just the static version (unnecessary static code otherwise)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/c97b61811248df002f1fb93557b982bc0aa27309) Everything uses interfaces now instead of typedefs (SomethingProperties is now ISomething)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/b9f179064f3ddf683f13e0d4e17840301be64010) ReflectionObject#toJSON properly omits explicit undefined values<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/7a6f98b5e74f9e9142f9be3ba0683caeaff916c4) Initial implementation of TypeScript decorators<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/7a6f98b5e74f9e9142f9be3ba0683caeaff916c4) Refactored protobuf.Class away<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/7a6f98b5e74f9e9142f9be3ba0683caeaff916c4) TypeScript definitions now have (a lot of) generics<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/7a6f98b5e74f9e9142f9be3ba0683caeaff916c4) Removed deprecated features<br />
|
||||
|
||||
## Fixed
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/c306d19d806eb697913ffa2b8613f650127a4c50) Added 'undefined' besides 'null' as a valid value of an optional field, fixes [#826](https://github.com/dcodeIO/protobuf.js/issues/826)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/c5518c3bac0da9c2045e6f1baf0dee915afb4221) Fixed an issue with codegen typings, see [#819](https://github.com/dcodeIO/protobuf.js/issues/819)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/66d149e92ff1baddfdfd4b6a88ca9bcea6fc6195) Ported utf8 chunking mechanism to base64 as well, fixes [#800](https://github.com/dcodeIO/protobuf.js/issues/800)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/e1f9d9856c98a0f0eb1aa8bdf4ac0df467bee8b9) Also be more verbose when defining properties for ES6, fixes [#820](https://github.com/dcodeIO/protobuf.js/issues/820)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/cf36097305ab02047be5014eabeccc3154e18bde) Generate more verbose JSDoc comments for ES6 support, fixes [#820](https://github.com/dcodeIO/protobuf.js/issues/820)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/f2959795330966f13cb65bbb6034c88a01fc0bcc) Emit a maximum of one error var when generating verifiers, fixes [#786](https://github.com/dcodeIO/protobuf.js/issues/786)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/3b848a10b39c1897ca1ea3b5149ef72ae43fcd11) Fixed missing semicolon after 'extensions' and 'reserved' when generating proto files, fixes [#810](https://github.com/dcodeIO/protobuf.js/issues/810)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/eb1b40497e14a09facbc370676f486bed1376f52) Call npm with '--no-bin-links' when installing CLI deps, fixes [#823](https://github.com/dcodeIO/protobuf.js/issues/823)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/429de19d851477f1df2804d5bc0be30228cd0924) Fix Reader argument conversion in static module<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/03194c203d6ff61ae825e66f8a29ca204fa503b9) Use JSDoc, they said, it documents code, they said. Fixes [#770](https://github.com/dcodeIO/protobuf.js/issues/770)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/ec6a133ff541c638517e00f47b772990207c8640) parser should not confuse previous trailing line comments with comments for the next declaration, see [#762](https://github.com/dcodeIO/protobuf.js/issues/762)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/0589ace4dc9e5c565ff996cf6e6bf94e63f43c4e) Types should not clear constructor with cache (fixes decorators)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/056ecc3834a3b323aaaa676957efcbe3f52365a0) Namespace#lookup should also check in nested namespaces (wtf)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/ed34b093839652db2ff7b84db87857fc57d96038) Reader#bytes should also support plain arrays<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/514afcfa890aa598e93254576c4fd6062e0eff3b) Fix markdown for pipe in code in table<br />
|
||||
|
||||
## New
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/17c2797592bc4effd9aaae3ba9777c9550bb75ac) Upgrade to codegen 2<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/57d7d35ddbb9e3a28c396b4ef1ae3b150eeb8035) ext/descriptor enables interoperability between reflection and descriptor.proto (experimental), see [#757](https://github.com/dcodeIO/protobuf.js/issues/757)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/3939667ef1f37b025bd7f9476015890496d50e00) Added 'json' conversion option for proto3 JSON mapping compatibility of NaN and Infinity + additional documentation of util.toJSONOptions, see [#351](https://github.com/dcodeIO/protobuf.js/issues/351)<br />
|
||||
|
||||
## CLI
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/4eac28c7d3acefb0af7b82c62cf8d19bf3e7d37b) Use protobuf/minimal when pbjs target is static-module<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/3a959453fe63706c38ebbacda208e1f25f27dc99) Added closure wrapper<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/13bf9c2635e6a1a2711670fc8e28ae9d7b8d1c8f) Various improvements to statically generated JSDoc, also fixes [#772](https://github.com/dcodeIO/protobuf.js/issues/772)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/ffdc93c7cf7c8a716316b00864ea7c510e05b0c8) Check incompatible properties for namespaces only in tsd-jsdoc<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/fb3f9c70436d4f81bcd0bf62b71af4d253390e4f) Additional tsd-jsdoc handling of properties inside of namespaces and TS specific API exposure<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/2dcae25c99e2ed8afd01e27d21b106633b8c31b9) Several improvements to tsd-jsdoc emitted comments<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/ff858003f525db542cbb270777b6fab3a230c9bb) Further TypeScript definition improvements<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/22f907c49adbbdf09b72bde5299271dbe0ee9cbe) Relieved tsd files from unnecessary comments<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/22f907c49adbbdf09b72bde5299271dbe0ee9cbe) Generate TS namespaces for vars and functions with properties<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/b355115e619c6595ac9d91897cfe628ef0e46054) Prefer @tstype over @type when generating typedefs (tsd-jsdoc)<br />
|
||||
|
||||
## Docs
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/23f4b990375efcac2c144592cf4ca558722dcf2d) Replaced nullable types with explicit type|null for better tooling compatibility, also fixes [#766](https://github.com/dcodeIO/protobuf.js/issues/766) and fixes 767<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/6493f52013c92a34b8305a25068ec7b8c4c29d54) Added more info to ext/descriptor README, see [#757](https://github.com/dcodeIO/protobuf.js/issues/757)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/ef92da3768d8746dbfe72e77232f78b879fc811d) Additional notes on ext/descriptor<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/b646cf7499791a41b75eef2de1a80fb558d4159e) Updated CHANGELOG so everyone knows what's going on (and soon, breaking)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/35a663757efe188bea552aef017837bc6c6a481a) Additional docs on TS/decorators usage<br />
|
||||
|
||||
## Other
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/9726be0888a9461721447677e9dece16a682b9f6) Updated dist files<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/9726be0888a9461721447677e9dece16a682b9f6) Added package-lock.json<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/114f7ea9fa3813003afc3ebb453b2dd2262808e1) Minor formatting<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/8a6e464954b472fdbb4d46d9270fe3b4b3c7272d) Generate files<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/42f8a97630bcb30d197b0f1d6cbdd96879d27f96) Remove the no-constructor arg<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/6446247cd7edbb77f03dc42c557f568811286a39) Remove the ctor option.<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/2059ee0f6f951575d5c5d2dc5eb06b6fa34e27aa) Add support to generate types for JSON object.<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/7445da0f8cb2e450eff17723f25f366daaf3bbbb) aspromise performance pass<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/3f8b74ba6726567eaf68c4d447c120f75eac042f) codegen 2 performance pass, [#653](https://github.com/dcodeIO/protobuf.js/issues/653) might benefit<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/d44a7eec2fd393e5cb24196fb5818c8c278a0f34) Fixed minimal library including reflection functionality<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/a18e6db9f02696c66032bce7ef4c0eb0568a8048) Minor compression ratio tuning<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/b49a4edd38395e209bedac2e0bfb7b9d5c4e980b) Fixed failing test case + coverage<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/8f7111cacd236501b7e26791b9747b1974a2d9eb) Improved fromObject wrapper for google.protobuf.Any.<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/0e471a2516bde3cd3c27b2691afa0dcfbb01f042) Fixed failing tokenize test case<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/5867f076d8510fa97e3bd6642bbe61960f7fd196) Removed debug build, made it an extension<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/22f907c49adbbdf09b72bde5299271dbe0ee9cbe) Regenerated dist files<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/5bc3541d2da19e2857dc884f743d37c27e8e21f2) Even more documentation and typings for ext/descriptor<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/773e6347b57e4a5236b1ef0bb8d361e4b233caf7) ext/descriptor docs<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/773e6347b57e4a5236b1ef0bb8d361e4b233caf7) Decorators coverage<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/9a23ded94729ceeea2f87cb7e8460eaaaf1c8269) ext/descriptor support for various standard options, see [#757](https://github.com/dcodeIO/protobuf.js/issues/757)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/2d8ce6ec0abd261f9b261a44a0a258fdf57ecec3) ext/descriptor passes descriptor.proto test with no differences, see [#757](https://github.com/dcodeIO/protobuf.js/issues/757)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/3a20968c6d676312e4f2a510f7e079e0e0819daf) Properly remove unnecessary (packed) options from JSON descriptors<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/2a30df8bd5f20d91143a38c2232dafc3a6f3a7bd) Use typedefs in ext/descriptor (like everywhere else), see [#757](https://github.com/dcodeIO/protobuf.js/issues/757)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/1fc911cef01e081c04fb82ead685f49dde1403bb) Fixed obvious issues with ext/descriptor, does not throw anymore when throwing descriptor.proto itself at it, see [#757](https://github.com/dcodeIO/protobuf.js/issues/757)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/6c37dbd14f39dad687f2f89f1558a875f7dcc882) Added still missing root traversal to ext/descriptor, see [#757](https://github.com/dcodeIO/protobuf.js/issues/757)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/7ab136daa5eb2769b616b6b7522e45a4e33a59f6) Initial map fields support for ext/descriptor, see [#757](https://github.com/dcodeIO/protobuf.js/issues/757)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/708552bb84508364b6e6fdf73906aa69e83854e1) Added infrastructure for TypeScript support of extensions<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/23f26defa793b371c16b5f920fbacb3fb66bdf22) TypeScript generics improvements<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/e49bef863c0fb10257ec1001a3c5561755f2ec6b) More ext/descriptor progress, see [#757](https://github.com/dcodeIO/protobuf.js/issues/757)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/6b94336c1e6eec0f2eb1bd5dca73a7a8e71a2153) Just export the relevant namespace in ext/descriptor<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/fbb99489ed0c095174feff8f53431d30fb6c34a0) Initial descriptor.proto extension for reflection interoperability, see [#757](https://github.com/dcodeIO/protobuf.js/issues/757)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/48e66d975bf7b4e6bdbb68ec24386c98b16c54c5) Moved custom wrappers to its own module instead, also makes the API easier to use manually, see [#677](https://github.com/dcodeIO/protobuf.js/issues/677)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/0c6e639d08fdf9be12677bf678563ea631bafb2c) Added infrastructure for custom wrapping/unwrapping of special types, see [#677](https://github.com/dcodeIO/protobuf.js/issues/677)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/0425b584f49841d87a8249fef30c78cc31c1c742) More decorator progress (MapField.d, optional Type.d)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/7a6f98b5e74f9e9142f9be3ba0683caeaff916c4) tsd-jsdoc now has limited generics support<br />
|
||||
|
||||
# [6.7.3](https://github.com/dcodeIO/protobuf.js/releases/tag/6.7.3)
|
||||
|
||||
## Other
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/57f1da64945f2dc5537c6eaa53e08e8fdd477b67) long, @types/long and @types/node are just dependencies, see [#753](https://github.com/dcodeIO/protobuf.js/issues/753)<br />
|
||||
|
||||
# [6.7.2](https://github.com/dcodeIO/protobuf.js/releases/tag/6.7.2)
|
||||
|
||||
## New
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/a7621be0a56585defc72d863f4e891e476905692) Split up NamespaceDescriptor to make nested plain namespaces a thing, see [#749](https://github.com/dcodeIO/protobuf.js/issues/749)<br />
|
||||
|
||||
## Docs
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/e980e72ae3d4697ef0426c8a51608d31f516a2c4) More README<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/1f76749d0b9a780c7b6cb56be304f7327d74ebdb) Replaced 'runtime message' with 'message instance' for clarity<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/e6b6dedb550edbd0e54e212799e42aae2f1a87f1) Rephrased the Usage section around the concept of valid messages<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/0d8100ba87be768ebdec834ca2759693e0bf4325) Added toolset diagram to README<br />
|
||||
|
||||
## Other
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/3405ae8d1ea775c96c30d1ef5cde666c9c7341b3) Touched benchmark output metrics once more<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/e36b228f4bb8b1cd835bf31f8605b759a7f1f501) Fixed failing browser test<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/7b3bdb562ee7d30c1a557d7b7851d55de3091da4) Output more human friendly metrics from benchmark<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/59e447889057c4575f383630942fd308a35c12e6) Stripped down static bench code to what's necessary<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/f88dad098282ece65f5d6e224ca38305a8431829) Revamped benchmark, now also covers Google's JS implementation<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/45356be81ba7796faee0d4d8ad324abdd9f301fb) Updated dependencies and dist files<br />
|
||||
|
||||
# [6.7.1](https://github.com/dcodeIO/protobuf.js/releases/tag/6.7.1)
|
||||
|
||||
## New
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/3d23eed6f7c79007969672f06c1a9ccd691e2411) Made .verify behave more like .encode, see [#710](https://github.com/dcodeIO/protobuf.js/issues/710)<br />
|
||||
|
||||
## CLI
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/bed514290c105c3b606f760f2abba80510721c77) With null/undefined eliminated by constructors and .create, document message fields as non-optional where applicable (ideally used with TS & strictNullChecks), see [#743](https://github.com/dcodeIO/protobuf.js/issues/743)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/007b2329842679ddf994df7ec0f9c70e73ee3caf) Renamed --strict-long/message to --force-long/message with backward compatible aliases, see [#741](https://github.com/dcodeIO/protobuf.js/issues/741)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/6aae71f75e82ffd899869b0c952daf98991421b8) Keep $Properties with --strict-message but require actual instances within, see [#741](https://github.com/dcodeIO/protobuf.js/issues/741)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/c812cef0eff26998f14c9d58d4486464ad7b2bbc) Added --strict-message option to pbjs to strictly reference message instances instead of $Properties, see [#741](https://github.com/dcodeIO/protobuf.js/issues/741)<br />
|
||||
|
||||
## Docs
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/412407de9afb7ec3a999c4c9a3a1f388f971fce7) Restructured README<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/1c4d9d7f024bfa096ddc24aabbdf39211ed8637a) Added more information on typings usage, see [#744](https://github.com/dcodeIO/protobuf.js/issues/744)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/602065e16862751c515c2f3391ee8b880e8140b1) Clarified typescript example in README, see [#744](https://github.com/dcodeIO/protobuf.js/issues/744)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/79d0ba2cc71a156910a9d937683af164df694f08) Clarified that the service API targets clients consuming a service, see [#742](https://github.com/dcodeIO/protobuf.js/issues/742)<br />
|
||||
|
||||
## Other
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/a66f76452ba050088efd1aaebf3c503a55e6287c) Omit copying of undefined or null in constructors and .create, see [#743](https://github.com/dcodeIO/protobuf.js/issues/743)<br />
|
||||
|
||||
# [6.7.0](https://github.com/dcodeIO/protobuf.js/releases/tag/6.7.0)
|
||||
|
||||
## Breaking
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/9c1bbf10e445c3495b23a354f9cbee951b4b20f0) Namespace#lookupEnum should actually look up the reflected enum and not just its values<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/44a8d3af5da578c2e6bbe0a1b948d469bbe27ca1) Decoder now throws if required fields are missing, see [#695](https://github.com/dcodeIO/protobuf.js/issues/695) / [#696](https://github.com/dcodeIO/protobuf.js/issues/696)<br />
|
||||
|
||||
## Fixed
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/d1e3122e326480fdd44e96afd76ee72e9744b246) Added functionality to filter for multiple types at once in lookup(), used by lookupTypeOrEnum(), fixes [#740](https://github.com/dcodeIO/protobuf.js/issues/740)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/8aa21268aa5e0f568cb39e99a83b99ccb4084381) Ensure that fields have been resolved when looking up js types in static target, see [#731](https://github.com/dcodeIO/protobuf.js/issues/731)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/f755d36829b9f1effd7960fab3a86a141aeb9fea) Properly copy fields array before sorting in toObject, fixes [#729](https://github.com/dcodeIO/protobuf.js/issues/729)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/a06691f5b87f7e90fed0115b78ce6febc4479206) Actually emit TS compatible enums in static target if not aliases, see [#720](https://github.com/dcodeIO/protobuf.js/issues/720)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/b01bb58dec92ebf6950846d9b8d8e3df5442b15d) Hardened tokenize/parse, esp. comment parsing, see [#713](https://github.com/dcodeIO/protobuf.js/issues/713)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/bc76ad732fc0689cb0a2aeeb91b06ec5331d7972) Exclude any fields part of some oneof when populating defaults in toObject, see [#710](https://github.com/dcodeIO/protobuf.js/issues/710)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/68cdb5f11fdbb950623be089f98e1356cb7b1ea3) Most of the parser is not case insensitive, see [#705](https://github.com/dcodeIO/protobuf.js/issues/705)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/3e930b907a834a7da759478b8d3f52fef1da22d8) Retain options argument in Root#load when used with promises, see [#684](https://github.com/dcodeIO/protobuf.js/issues/684)<br />
|
||||
|
||||
## New
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/3c14ef42b3c8f2fef2d96d65d6e288211f86c9ef) Created a micromodule from (currently still bundled) float support<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/7ecae9e9f2e1324ef72bf5073463e01deff50cd6) util.isset(obj, prop) can be used to test if a message property is considered to be set, see [#728](https://github.com/dcodeIO/protobuf.js/issues/728)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/c04d4a5ab8f91899bd3e1b17fe4407370ef8abb7) Implemented stubs for long.js / node buffers to be used where either one isn't wanted, see [#718](https://github.com/dcodeIO/protobuf.js/issues/718)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/b9574ad02521a31ebd509cdaa269e7807da78d7c) Simplified reusing / replacing internal constructors<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/1f97b7af05b49ef69bd6e9d54906d1b7583f42c4) Constructors/.create always initialize proper mutable objects/arrays, see [#700](https://github.com/dcodeIO/protobuf.js/issues/700)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/adb4bb001a894dd8d00bcfe03457497eb994f6ba) Verifiers return an error if multiple fields part of the same oneof are set, see [#710](https://github.com/dcodeIO/protobuf.js/issues/710)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/fe93d436b430d01b563318bff591e0dd408c06a4) Added `oneofs: true` to ConversionOptions, see [#710](https://github.com/dcodeIO/protobuf.js/issues/710)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/228c882410d47a26576f839b15f1601e8aa7914d) Optional fields handle null just like undefined regardless of type see [#709](https://github.com/dcodeIO/protobuf.js/issues/709)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/da6af8138afa5343a47c12a8beedb99889c0dd51) Encoders no longer examine virtual oneof properties but encode whatever is present, see [#710](https://github.com/dcodeIO/protobuf.js/issues/710)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/ac26a7aa60359a37dbddaad139c0134b592b3325) pbjs now generates multiple exports when using ES6 syntax, see [#686](https://github.com/dcodeIO/protobuf.js/issues/686)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/c1ca65dc6987384af6f9fac2fbd7700fcf5765b2) Sequentially serialize fields ordered by id, as of the spec.<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/26d9fadb21a85ca0b5609156c26453ae875e4933) decode throws specific ProtocolError with a reference to the so far decoded message if required fields are missing + example<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/2b5577b238a452ae86aa395fb2ad3a3f45d755dc) Reader.create asserts that `buffer` is a valid buffer, see [#695](https://github.com/dcodeIO/protobuf.js/issues/695)<br />
|
||||
|
||||
## CLI
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/6f74d30f059e33a4678f28e7a50dc4878c54bed2) Exclude JSDoc on typedefs from generated d.ts files because typescript@next, see [#737](https://github.com/dcodeIO/protobuf.js/issues/737)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/2ebb1b781812e77de914cd260e7ab69612ffd99e) Prepare static code with estraverse instead of regular expressions, see [#732](https://github.com/dcodeIO/protobuf.js/issues/732)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/29ce6cae0cacc0f1d87ca47e64be6a81325aaa55) Moved tsd-jsdoc to future cli package, see [#716](https://github.com/dcodeIO/protobuf.js/issues/716)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/8de21e1a947ddb50a167147dd63ad29d37b6a891) $Properties are just a type that's satisfied, not implemented, by classes, see [#723](https://github.com/dcodeIO/protobuf.js/issues/723)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/4bfe0c239b9c337f8fa64ea64f6a71baf5639b84) More progress on decoupling the CLI<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/8a60174932d15198883ac3f07000ab4e7179a695) Fixed computed array indexes not being renamed in static code, see [#726](https://github.com/dcodeIO/protobuf.js/issues/726)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/8d9981588d17709791846de63f1f3bfd09433b03) Check upfront if key-var is required in static decoders with maps, see [#726](https://github.com/dcodeIO/protobuf.js/issues/726)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/16adff0c7b67c69a2133b6aac375365c5f2bdbf7) Fixed handling of stdout if callback is specified, see [#724](https://github.com/dcodeIO/protobuf.js/issues/724)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/6423a419fe45e648593833bf535ba1736b31ef63) Preparations for moving the CLI to its own package, see [#716](https://github.com/dcodeIO/protobuf.js/issues/716)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/afefa3de09620f50346bdcfa04d52952824c3c8d) Properly implement $Properties interface in JSDoc, see [#723](https://github.com/dcodeIO/protobuf.js/issues/723)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/a1f23e09fb5635275bb7646dfafc70caef74c6b8) Recursively use $Properties inside of $Properties in static code, see [#717](https://github.com/dcodeIO/protobuf.js/issues/717)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/c3f0a2124c661bb9ba35f92c21a98a4405d30b47) Added --strict-long option to pbjs to always emit 'Long' instead of 'number|Long' (only relevant with long.js), see [#718](https://github.com/dcodeIO/protobuf.js/issues/718)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/0bc4a14501f84f93afd6ce2933ad00749c82f4df) Statically emitted long type is 'Long' now instead of '$protobuf.Long', see [#718](https://github.com/dcodeIO/protobuf.js/issues/718)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/a75625d176b7478e0e506f05e2cee5e3d7a0d89a) Decoupled message properties as an interface in static code for TS intellisense support, see [#717](https://github.com/dcodeIO/protobuf.js/issues/717)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/23f14a61e8c2f68b06d1bb4ed20b938764c78860) Static code statically resolves types[..], see [#715](https://github.com/dcodeIO/protobuf.js/issues/715)<br />
|
||||
|
||||
## Docs
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/ef71e77726b6bf5978b948d598c18bf8b237ade4) Added type definitions for all possible JSON descriptors<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/4bfe0c239b9c337f8fa64ea64f6a71baf5639b84) Explained the JSON structure in README and moved CLI specific information to the CLI package<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/3ba3ad762f7486b4806ad1c45764e92a81ca24dd) Added information on how to use the stubs to README, see [#718](https://github.com/dcodeIO/protobuf.js/issues/718)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/a5dbba41341bf44876cd4226f08044f88148f37d) Added 'What is a valid message' section to README<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/6f8f2c1fdf92e6f81363d77bc059820b2376fe32) Added a hint on using .create to initial example<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/3ad28ec920e0fe8d0223db28804a7b3f8a6880c2) Even more usage for README<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/5a1f861a0f6b582faae7a4cc5c6ca7e4418086da) Additional information on general usage (README)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/320dea5a1d1387c72759e10a17afd77dc48c3de0) Restructured README to Installation, Usage and Examples sections<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/1c9055dd69f7696d2582942b307a1ac8ac0f5533) Added a longish section on the correct use of the toolset to README<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/99667c8e1ff0fd3dac83ce8c0cff5d0b1e347310) Added a few additional notes on core methods to README, see [#710](https://github.com/dcodeIO/protobuf.js/issues/710)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/2130bc97e44567e766ea8efacb365383c909dbd4) Extended traverse-types example, see [#693](https://github.com/dcodeIO/protobuf.js/issues/693)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/13e4aa3ff274ab42f1302e16fd59d074c5587b5b) Better explain how .verify, .encode and .decode are connected<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/7502dd2dfdaea111e5c1a902c524ad0a51ff9bd4) Documented that Type#encode respectively Message.encode do not implicitly .verify, see [#696](https://github.com/dcodeIO/protobuf.js/issues/696) [ci-skip]<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/e7e123aa0b6c05eb4156a761739e37c008a3cbc1) Documented throwing behavior of Reader.create and Message.decode<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/0fcde32306da77f02cb1ea81ed18a32cee01f17b) Added error handling notes to README, see [#696](https://github.com/dcodeIO/protobuf.js/issues/696)<br />
|
||||
|
||||
## Other
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/fef924e5f708f14dac5713aedc484535d36bfb47) Use @protobufjs/float<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/fef924e5f708f14dac5713aedc484535d36bfb47) Rebuilt dist files for 6.7.0<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/ca0dce2d7f34cd45e4c1cc753a97c58e05b3b9d2) Updated deps, ts fixes and regenerated dist files<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/2c2d4002d6776f3edde608bd813c37d798d87e6b) Manually merged gentests improvements, fixes [#733](https://github.com/dcodeIO/protobuf.js/issues/733)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/e4a6b6f81fa492a63b12f0da0c381612deff1973) Make sure that util.Long is overridden by AMD loaders only if present, see [#730](https://github.com/dcodeIO/protobuf.js/issues/730)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/fff1eb297a728ed6d334c591e7d796636859aa9a) Coverage for util.isset and service as a namespace<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/8401a47d030214a54b5ee30426ebc7a9d9c3773d) Shortened !== undefined && !== null to equivalent != null in static code<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/e1dd1bc2667de73bb65d876162131be2a4d9fef4) With stubs in place, 'number|Long' return values can be just 'Long' instead, see [#718](https://github.com/dcodeIO/protobuf.js/issues/718)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/404ba8e03a63f708a70a72f0208e0ca9826fe20b) Just alias as the actual ideal type when using stubs, see [#718](https://github.com/dcodeIO/protobuf.js/issues/718)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/270cc94c7c4b8ad84d19498672bfc854b55130c9) General cleanup + regenerated dist/test files<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/017161ce97ceef3b2d0ce648651a4636f187d78b) Simplified camel case regex, see [#714](https://github.com/dcodeIO/protobuf.js/issues/714)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/d410fd20f35d2a35eb314783b17b6570a40a99e8) Regenerated dist files and changelog for 6.7.0<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/88ca8f0d1eb334646ca2625c78e63fdd57221408) Retain alias order in static code for what it's worth, see [#712](https://github.com/dcodeIO/protobuf.js/issues/712)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/2a74fbf551e934b3212273e6a28ad65ac4436faf) Everything can be block- or line-style when parsing, see [#713](https://github.com/dcodeIO/protobuf.js/issues/713)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/47bb95a31784b935b9ced52aa773b9d66236105e) Determine necessary aliases depending on config, see [#712](https://github.com/dcodeIO/protobuf.js/issues/712)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/588ffd9b129869de0abcef1d69bfa18f2f25d8e1) Use more precise types for message-like plain objects<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/37b39c8d1a5307eea09aa24d7fd9233a8df5b7b6) Regenerated dist files<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/9c94813f9a5f1eb114d7c6112f7e87cb116fe9da) Regenerated relevant files<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/d7493efe1a86a60f6cdcf7976523e69523d3f7a3) Moved field comparer to util<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/fe917652f88df17d4dbaae1cd74f470385342be2) Updated tests to use new simplified encoder logic<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/b69173b4e7b514c40bb4a85b54ca5465492a235b) Updated path to tsd-jsdoc template used by pbts, see [#707](https://github.com/dcodeIO/protobuf.js/issues/707)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/5041fad9defdb0bc8131560e92f3b454d8e45273) Additional restructuring for moving configuration files out of the root folder<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/c0b7c9fa6309d345c4ce8e06fd86f27528f4ea66) Added codegen support for constructor functions, see [#700](https://github.com/dcodeIO/protobuf.js/issues/700)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/4573f9aabd7e8f883e530f4d0b055e5ec9b75219) Attempted to fix broken custom error test<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/4b49f500fce156b164c757d8f17be2338f767c82) Trying out a more aggressive aproach for custom error subclasses<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/95cd64ee514dc60d10daac5180726ff39594e8e8) Moved a few things out of the root folder<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/db1030ed257f9699a0bcf3bad0bbe8acccf5d766) Coverage for encoder compat. / protocolerror<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/948a4caf5092453fa091ac7a594ccd1cc5b503d2) Updated dist and generated test files<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/3ead13e83ecdc8715fbab916f7ccaf3fbfdf59ed) Added tslint<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/364e7d457ed4c11328e609f600a57b7bc4888554) Exclude dist/ from codeclimate checks<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/6e81fcb05f25386e3997399e6596e9d9414f0286) Also lint cli utilities<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/e7e123aa0b6c05eb4156a761739e37c008a3cbc1) Cache any regexp instance (perf)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/d89c45f8af0293fb34e6f12b37ceca49083e1faa) Use code climate badges<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/e70fbe3492c37f009dbaccf910c1e0f81e8f0f44) Updated travis to pipe to codeclimate, coverage<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/a7ab1036906bb7638193a9e991cb62c86108880a) More precise linter configuration<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/58688c178257051ceb2dfea8a63eb6be7dcf1cf1) Added codeclimate<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/4b21e00adc6fae42e6a88deaeb0b7c077c6ca50e) Moved cli deps placeholder creation to post install script<br />
|
||||
|
||||
# [6.6.5](https://github.com/dcodeIO/protobuf.js/releases/tag/6.6.5)
|
||||
|
||||
## Fixed
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/478ee51194878f24be8607e42e5259952607bd44) sfixed64 is not zig-zag encoded, see [#692](https://github.com/dcodeIO/protobuf.js/issues/692)<br />
|
||||
|
||||
## CLI
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/7a944538c89492abbed147915acea611f11c03a2) Added a placeholder to cli deps node_modules folder to make sure node can load from it<br />
|
||||
|
||||
## Other
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/83142e420eb1167b2162063a092ae8d89c9dd4b2) Restructured a few failing tests<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/367d55523a3ae88f21d47aa96447ec3e943d4620) Traversal example + minimalistic documentation<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/8eeffcbcd027c929e2a76accad588c61dfa2e37c) Added a custom getters/setters example for gRPC<br />
|
||||
|
||||
# [6.6.4](https://github.com/dcodeIO/protobuf.js/releases/tag/6.6.4)
|
||||
|
||||
## Fixed
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/88eb7a603a21643d5012a374c7d246f4c27620f3) Made sure that LongBits ctor is always called with unsigned 32 bits + static codegen compat., fixes [#690](https://github.com/dcodeIO/protobuf.js/issues/690)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/50e82fa7759be035a67c7818a1e3ebe0d6f453b6) Properly handle multiple ../.. in path.normalize, see [#688](https://github.com/dcodeIO/protobuf.js/issues/688)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/7c3506b3f0c5a08a887e97313828af0c21effc61) Post-merge, also tackles [#683](https://github.com/dcodeIO/protobuf.js/issues/683) (packed option for repeated enum values)<br />
|
||||
|
||||
## New
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/7f3f4600bcae6f2e4dadd5cdb055886193a539b7) Verify accepts non-null objects only, see [#685](https://github.com/dcodeIO/protobuf.js/issues/685)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/d65c22936183d04014d6a8eb880ae0ec33aeba6d) allow_alias enum option was not being honored. This case is now handled and a test case was added<br />
|
||||
|
||||
## CLI
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/2ddb76b6e93174787a68f68fb28d26b8ece7cc56) Added an experimental --sparse option to limit pbjs output to actually referenced types within main files<br />
|
||||
|
||||
## Docs
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/33d14c97600ed954193301aecbf8492076dd0179) Added explicit hint on Uint8Array to initial example, see [#670](https://github.com/dcodeIO/protobuf.js/issues/670)<br />
|
||||
|
||||
## Other
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/cbd4c622912688b47658fea00fd53603049b5104) Ranges and names support for reserved fields, see [#676](https://github.com/dcodeIO/protobuf.js/issues/676)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/487f8922d879955ba22f89b036f897b9753b0355) Updated depdendencies / rebuilt dist files<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/37536e5fa7a15fbc851040e09beb465bc22d9cf3) Use ?: instead of |undefined in .d.ts files<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/f8b415a2fc2d1b1eff19333600a010bcaaebf890) Mark optional fields as possibly being undefined<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/2ddb76b6e93174787a68f68fb28d26b8ece7cc56) Added a few more common google types from google/api, see [#433](https://github.com/dcodeIO/protobuf.js/issues/433)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/d246024f4c7d13ca970c91a757e2f47432a619df) Minor optimizations to dependencies, build process and tsd<br />
|
||||
|
||||
# [6.6.3](https://github.com/dcodeIO/protobuf.js/releases/tag/6.6.3)
|
||||
|
||||
## Fixed
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/0be01a14915e3e510038808fedbc67192a182d9b) Support node 4.2.0 to 4.4.7 buffers + travis case, see [#665](https://github.com/dcodeIO/protobuf.js/issues/665)<br />
|
||||
|
||||
## CLI
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/6a0920b2c32e7963741693f5a773b89f4b262688) Added ES6 syntax flag to pbjs, see [#667](https://github.com/dcodeIO/protobuf.js/issues/667)<br />
|
||||
|
||||
## Docs
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/c365242bdc28a47f5c6ab91bae34c277d1044eb3) Reference Buffer for BufferReader/Writer, see [#668](https://github.com/dcodeIO/protobuf.js/issues/668)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/43976072d13bb760a0689b54cc35bdea6817ca0d) Slightly shortened README<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/e64cf65b09047755899ec2330ca0fc2f4d7932c2) Additional notes on the distinction of different use cases / distributions, see [#666](https://github.com/dcodeIO/protobuf.js/issues/666)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/83758c99275c2bbd30f63ea1661284578f5c9d91) Extended README with additional information on JSON format<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/fdc3102689e8a3e8345eee5ead07ba3c9c3fe80c) Added extended usage instructions for TypeScript and custom classes to README, see [#666](https://github.com/dcodeIO/protobuf.js/issues/666)<br />
|
||||
|
||||
## Other
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/3701488cca6bc56ce6b7ad93c7b80e16de2571a7) Updated dist files<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/579068a45e285c7d2c69b359716dd6870352f46f) Updated test cases to use new buffer util<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/0be01a14915e3e510038808fedbc67192a182d9b) Added fetch test cases + some test cleanup<br />
|
||||
|
||||
# [6.6.2](https://github.com/dcodeIO/protobuf.js/releases/tag/6.6.2)
|
||||
|
||||
## Fixed
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/3aea1bf3d4920dc01603fda25b86e6436ae45ec2) Properly replace short vars when beautifying static code, see [#663](https://github.com/dcodeIO/protobuf.js/issues/663)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/b6cf228a82152f72f21b1b307983126395313470) Use custom prelude in order to exclude any module loader code from source (for webpack), see [#658](https://github.com/dcodeIO/protobuf.js/issues/658)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/2b12fb7db9d4eaa3b76b7198539946e97db684c4) Make sure to check optional inner messages for null when encoding, see [#658](https://github.com/dcodeIO/protobuf.js/issues/658)<br />
|
||||
|
||||
## New
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/276a594771329da8334984771cb536de7322d5b4) Initial attempt on a backwards compatible fetch implementation with binary support, see [#661](https://github.com/dcodeIO/protobuf.js/issues/661)<br />
|
||||
|
||||
## Other
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/2d81864fa5c4dac75913456d582e0bea9cf0dd80) Root#resolvePath skips files when returning null, see [#368](https://github.com/dcodeIO/protobuf.js/issues/368)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/aab3ec1a757aff0f11402c3fb943c003f092c1af) Changes callback on failed response decode in rpc service to pass actual error instead of 'error' string<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/9044178c052299670108f10621d6e9b3d56e8a40) Travis should exit with the respective error when running sauce tests<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/73721f12072d77263e72a3b27cd5cf9409db9f8b) Moved checks whether a test case is applicable to parent case<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/3fcd88c3f9b1a084b06cab2d5881cb5bb895869d) Added eventemitter tests and updated micromodule dependencies (so far)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/2db4305ca67d003d57aa14eb23f25eb6c3672034) Added lib/path tests and updated a few dependencies<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/2b12fb7db9d4eaa3b76b7198539946e97db684c4) Moved micro modules to lib so they can have their own tests etc.<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/b6dfa9f0a4c899b5c217d60d1c2bb835e06b2122) Updated travis<br />
|
||||
|
||||
# [6.6.1](https://github.com/dcodeIO/protobuf.js/releases/tag/6.6.1)
|
||||
|
||||
## Fixed
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/039ac77b062ee6ebf4ec84a5e6c6ece221e63401) Properly set up reflection when using light build<br />
|
||||
|
||||
# [6.6.0](https://github.com/dcodeIO/protobuf.js/releases/tag/6.6.0) ([release](https://github.com/dcodeIO/protobuf.js/releases/tag/6.6.0))
|
||||
|
||||
## Breaking
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/cdfe6bfba27fa1a1d0e61887597ad4bb16d7e5ed) Inlined / refactored away .testJSON, see [#653](https://github.com/dcodeIO/protobuf.js/issues/653)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/6a483a529ef9345ed217a23394a136db0d9f7771) Refactored util.extend away<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/27b16351f3286468e539c2ab382de4b52667cf5e) Reflected and statically generated services use common utility, now work exactly the same<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/dca26badfb843a597f81e98738e2fda3f66c7341) fromObject now throws for entirely bogus values (repeated, map and inner message fields), fixes [#601](https://github.com/dcodeIO/protobuf.js/issues/601)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/4bff9c356ef5c10b4aa34d1921a3b513e03dbb3d) Cleaned up library distributions, now is full / light / minimal with proper browserify support for each<br />
|
||||
|
||||
## Fixed
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/301f7762ef724229cd1df51e496eed8cfd2f10eb) Do not randomly remove slashes from comments, fixes [#656](https://github.com/dcodeIO/protobuf.js/issues/656)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/ef7be352baaec26bdcdce01a71fbee47bbdeec15) Properly parse nested textformat options, also tackles [#655](https://github.com/dcodeIO/protobuf.js/issues/655)<br />
|
||||
|
||||
## New
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/b4f4f48f1949876ae92808b0a5ca5f2b29cc011c) Relieved the requirement to call .resolveAll() on roots in order to populate static code-compatible properties, see [#653](https://github.com/dcodeIO/protobuf.js/issues/653)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/56c8ec4196d461383c3e1f271da02553d877ae81) Added a (highly experimental) debug build as a starting point for [#653](https://github.com/dcodeIO/protobuf.js/issues/653)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/c5d291f9bab045385c5938ba0f6cdf50a315461f) Full build depends on light build depends on minimal build, shares all relevant code<br />
|
||||
|
||||
## CLI
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/735da4315a98a6960f3b5089115e308548b91c07) Also reuse specified root in pbjs for JSON modules, see [#653](https://github.com/dcodeIO/protobuf.js/issues/653)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/3a056244d3acf339722d56549469a8df018e682e) Reuse specified root name in pbjs to be able to split definitions over multiple files more easily, see [#653](https://github.com/dcodeIO/protobuf.js/issues/653)<br />
|
||||
|
||||
## Docs
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/28ddf756ab83cc890761ef2bd84a0788d2ad040d) Improved pbjs/pbts examples, better covers reflection with definitions for static modules<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/6f0b44aea6cf72d23042810f05a7cede85239eb3) Fixed centered formatting on npm<br />
|
||||
|
||||
## Other
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/dd96dcdacb8eae94942f7016b8dc37a2569fe420) Various other minor improvements / assertions refactored away, see [#653](https://github.com/dcodeIO/protobuf.js/issues/653)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/3317a76fb56b9b31bb07ad672d6bdda94b79b6c3) Fixed some common reflection deopt sites, see [#653](https://github.com/dcodeIO/protobuf.js/issues/653)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/6a483a529ef9345ed217a23394a136db0d9f7771) Reflection performance pass, see [#653](https://github.com/dcodeIO/protobuf.js/issues/653)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/6a483a529ef9345ed217a23394a136db0d9f7771) Added TS definitions to alternative builds' index files<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/6a483a529ef9345ed217a23394a136db0d9f7771) Removed unnecessary prototype aliases, improves gzip ratio<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/641625fd64aca55b1163845e6787b58054ac36ec) Unified behaviour of and docs on Class constructor / Class.create<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/7299929b37267af2100237d4f8b4ed8610b9f7e1) Statically generated services actually inherit from rpc.Service<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/f4cf75e4e4192910b52dd5864a32ee138bd4e508) Do not try to run sauce tests for PRs<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/33da148e2b750ce06591c1c66ce4c46ccecc3c8f) Added utility to enable/disable debugging extensions to experimental debug build<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/fdb1a729ae5f8ab762c51699bc4bb721102ef0c8) Fixed node 0.12 tests<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/6bc5bb4a7649d6b91a5944a9ae20178d004c8856) Fixed coverage<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/6f0b44aea6cf72d23042810f05a7cede85239eb3) Added a test case for [#652](https://github.com/dcodeIO/protobuf.js/issues/652)<br />
|
||||
|
||||
# [6.5.3](https://github.com/dcodeIO/protobuf.js/releases/tag/6.5.3)
|
||||
|
||||
## Other
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/799d0303bf289bb720f2b27af59e44c3197f3fb7) In fromObject, check if object is already a runtime message, see [#652](https://github.com/dcodeIO/protobuf.js/issues/652)<br />
|
||||
|
||||
# [6.5.2](https://github.com/dcodeIO/protobuf.js/releases/tag/6.5.2)
|
||||
|
||||
## Docs
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/8cff92fe3b7ddb1930371edb4937cd0db9216e52) Added coverage reporting<br />
|
||||
|
||||
## CLI
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/cbaaae99b4e39a859664df0e6d20f0491169f489) Added version scheme warning to everything CLI so that we don't need this overly explicit in README<br />
|
||||
|
||||
## Other
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/6877b3399f1a4c33568221bffb4e298b01b14439) Coverage progress, 100%<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/711a9eb55cb796ec1e51af7d56ef2ebbd5903063) Coverage progress<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/e7526283ee4dd82231235afefbfad6af54ba8970) Attempted to fix badges once and for all<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/5aa296c901c2b460ee3be4530ede394e2a45e0ea) Coverage progress<br />
|
||||
|
||||
# [6.5.1](https://github.com/dcodeIO/protobuf.js/releases/tag/6.5.1)
|
||||
|
||||
## CLI
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/9719fd2fa8fd97899c54712a238091e8fd1c57b2) Reuse module paths when looking up cli dependencies, see [#648](https://github.com/dcodeIO/protobuf.js/issues/648)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/6302655d1304cf662f556be5d9fe7a016fcedc3c) Check actual module directories to determine if cli dependencies are present and bootstrap semver, see [#648](https://github.com/dcodeIO/protobuf.js/issues/648)<br />
|
||||
|
||||
## Docs
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/dfc7c4323bf98fb26ddcfcfbb6896a6d6e8450a4) Added a note on semver-incompatibility, see [#649](https://github.com/dcodeIO/protobuf.js/issues/649)<br />
|
||||
|
||||
## Other
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/49053ffa0ea8a4ba5ae048706dba1ab6f3bc803b) Coverage progress<br />
|
||||
|
||||
# [6.5.0](https://github.com/dcodeIO/protobuf.js/releases/tag/6.5.0) ([release](https://github.com/dcodeIO/protobuf.js/releases/tag/6.5.0))
|
||||
|
||||
## Breaking
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/3946e0fefea415f52a16ea7a74109ff40eee9643) Initial upgrade of converters to real generated functions, see [#620](https://github.com/dcodeIO/protobuf.js/issues/620)<br />
|
||||
|
||||
## Fixed
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/08cda241a3e095f3123f8a991bfd80aa3eae9400) An enum's default value present as a string looks up using typeDefault, not defaultValue which is an array if repeated<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/c7e14b1d684aaba2080195cc83900288c5019bbc) Use common utility for virtual oneof getters and setters in both reflection and static code, see [#644](https://github.com/dcodeIO/protobuf.js/issues/644)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/508984b7ff9529906be282375d36fdbada66b8e6) Properly use Type.toObject/Message.toObject within converters, see [#641](https://github.com/dcodeIO/protobuf.js/issues/641)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/5bca18f2d32e8687986e23edade7c2aeb6b6bac1) Generate null/undefined assertion in fromObject if actually NOT an enum, see [#620](https://github.com/dcodeIO/protobuf.js/issues/620)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/508984b7ff9529906be282375d36fdbada66b8e6) Replace ALL occurencies of types[%d].values in static code, see [#641](https://github.com/dcodeIO/protobuf.js/issues/641)<br />
|
||||
|
||||
## New
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/9b090bb1673aeb9b8f1d7162316fce4d7a3348f0) Switched to own property-aware encoders for compatibility, see [#639](https://github.com/dcodeIO/protobuf.js/issues/639)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/340d6aa82ac17c4a761c681fa71d5a0955032c8b) Now also parses comments, sets them on reflected objects and re-uses them when generating static code, see [#640](https://github.com/dcodeIO/protobuf.js/issues/640)<br />
|
||||
|
||||
## CLI
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/3cb82628159db4d2aa721b63619b16aadc5f1981) Further improved generated static code style<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/cda5c5452fa0797f1e4c375471aef96f844711f1) Removed scoping iifes from generated static code<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/def7b45fb9b5e01028cfa3bf2ecd8272575feb4d) Removed even more clutter from generated static code<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/dbd19fd9d3a57d033aad1d7173f7f66db8f8db3e) Removed various clutter from generated static code<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/1cc8a2460c7e161c9bc58fa441ec88e752df409c) Made sure that static target's replacement regexes don't match fields<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/d4272dbf5d0b2577af8efb74a94d246e2e0d728e) Also accept (trailing) triple-slash comments for compatibility with protoc-gen-doc, see [#640](https://github.com/dcodeIO/protobuf.js/issues/640)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/0a3862b75fa60ef732e0cd36d623f025acc2fb45) Use semver to validate that CLI dependencies actually satisfy the required version, see [#637](https://github.com/dcodeIO/protobuf.js/issues/637)<br />
|
||||
|
||||
## Docs
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/9e360ea6a74d41307483e51f18769df7f5b047b9) Added a hint on documenting .proto files for static code<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/d2a97bb818474645cf7ce1832952b2c3c739b234) Documented internally used codegen partials for what it's worth<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/079388ca65dfd581d74188a6ae49cfa01b103809) Updated converter documentation<br />
|
||||
|
||||
## Other
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/168e448dba723d98be05c55dd24769dfe3f43d35) Bundler provides useful stuff to uglify and a global var without extra bloat<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/32e0529387ef97182ad0b9ae135fd8b883ed66b4) Cleaned and categorized tests, coverage progress<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/3325e86930a3cb70358c689cb3016c1be991628f) Properly removed builtins from bundle<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/2c94b641fc5700c8781ac0b9fe796debac8d6893) Call hasOwnProperty builtin as late as possible decreasing the probability of having to call it at all (perf)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/818bcacde267be70a75e689f480a3caad6f80cf7) Slightly hardened codegen sprintf<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/818bcacde267be70a75e689f480a3caad6f80cf7) Significantly improved uint32 write performance<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/b5daa272407cb31945fd38c34bbef7c9edd1db1c) Cleaned up test case data and removed unused files<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/c280a4a18c6d81c3468177b2ea58ae3bc4f25e73) Removed now useless trailing comment checks, see [#640](https://github.com/dcodeIO/protobuf.js/issues/640)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/44167db494c49d9e4b561a66ad9ce2d8ed865a21) Ensured that pbjs' beautify does not break regular expressions in generated verify functions<br />
|
||||
|
||||
# [6.4.6](https://github.com/dcodeIO/protobuf.js/releases/tag/6.4.6)
|
||||
|
||||
## Fixed
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/e11012ce047e8b231ba7d8cc896b8e3a88bcb902) Case-sensitively test for legacy group definitions, fixes [#638](https://github.com/dcodeIO/protobuf.js/issues/638)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/7e57f4cdd284f886b936511b213a6468e4ddcdce) Properly parse text format options + simple test case, fixes [#636](https://github.com/dcodeIO/protobuf.js/issues/636)<br />
|
||||
|
||||
## Docs
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/fe4d97bbc4d33ce94352dde62ddcd44ead02d7ad) Added SVG logo, see [#629](https://github.com/dcodeIO/protobuf.js/issues/629)<br />
|
||||
|
||||
## Other
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/57990f7ed8ad5c512c28ad040908cee23bbf2aa8) Also refactored Service and Type to inherit from NamespaceBase, see [#635](https://github.com/dcodeIO/protobuf.js/issues/635)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/fe4d97bbc4d33ce94352dde62ddcd44ead02d7ad) Moved TS-compatible Namespace features to a virtual NamespaceBase class, compiles with strictNullChecks by default now, see [#635](https://github.com/dcodeIO/protobuf.js/issues/635)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/fe4d97bbc4d33ce94352dde62ddcd44ead02d7ad) Minor codegen enhancements<br />
|
||||
|
||||
# [6.4.5](https://github.com/dcodeIO/protobuf.js/releases/tag/6.4.5)
|
||||
|
||||
## Fixed
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/1154ce0867306e810cf62a5b41bdb0b765aa8ff3) Properly handle empty/noop Writer#ldelim, fixes [#625](https://github.com/dcodeIO/protobuf.js/issues/625)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/f303049f92c53970619375653be46fbb4e3b7d78) Properly annotate map fields in pbjs, fixes [#624](https://github.com/dcodeIO/protobuf.js/issues/624)<br />
|
||||
|
||||
## New
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/4b786282a906387e071a5a28e4842a46df588c7d) Made sure that Writer#bytes is always able to handle plain arrays<br />
|
||||
|
||||
## Other
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/1e6a8d10f291a16631376dd85d5dd385937e6a55) Slightly restructured utility to better support static code default values<br />
|
||||
|
||||
# [6.4.4](https://github.com/dcodeIO/protobuf.js/releases/tag/6.4.4)
|
||||
|
||||
## Fixed
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/26d68e36e438b590589e5beaec418c63b8f939cf) Dynamically resolve jsdoc when running pbts, fixes [#622](https://github.com/dcodeIO/protobuf.js/issues/622)<br />
|
||||
|
||||
## Docs
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/69c04d7d374e70337352cec9b445301cd7fe60d6) Explain 6.4.2 vs 6.4.3 in changelog<br />
|
||||
|
||||
# [6.4.3](https://github.com/dcodeIO/protobuf.js/releases/tag/6.4.4)
|
||||
|
||||
## Fixed
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/c2c39fc7cec5634ecd1fbaebbe199bf097269097) Fixed invalid definition of Field#packed property, also introduced decoder.compat mode (packed fields, on by default)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/11fb1a66ae31af675d0d9ce0240cd8e920ae75e7) Always decode packed/non-packed based on wire format only, see [#602](https://github.com/dcodeIO/protobuf.js/issues/602)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/c9a61e574f5a2b06f6b15b14c0c0ff56f8381d1f) Use full library for JSON modules and runtime dependency for static modules, fixes [#621](https://github.com/dcodeIO/protobuf.js/issues/621)<br />
|
||||
|
||||
## CLI
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/e88d13ca7ee971451b57d056f747215f37dfd3d7) Additional workarounds for on demand CLI dependencies, see [#618](https://github.com/dcodeIO/protobuf.js/issues/618)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/44f6357557ab3d881310024342bcc1e0d336a20c) Revised automatic setup of cli dependencies, see [#618](https://github.com/dcodeIO/protobuf.js/issues/618)<br />
|
||||
|
||||
## Other
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/e027a3c7855368837e477ce074ac65f191bf774a) Removed Android 4.0 test (no longer supported by sauce)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/8ba3c5efd182bc80fc36f9d5fe5e2b615b358236) Removed some unused utility, slightly more efficient codegen, additional comments<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/f22a34a071753bca416732ec4d01892263f543fb) Updated tests for new package.json layout<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/f22a34a071753bca416732ec4d01892263f543fb) Added break/continue label support to codegen<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/f2ffa0731aea7c431c59e452e0f74247d815a352) Updated dependencies, rebuilt dist files and changed logo to use an absolute url<br />
|
||||
|
||||
6.4.2 had been accidentally published as 6.4.3.
|
||||
|
||||
# [6.4.1](https://github.com/dcodeIO/protobuf.js/releases/tag/6.4.1)
|
||||
|
||||
## Fixed
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/9035d4872e32d6402c8e4d8c915d4f24d5192ea9) Added more default value checks to converter, fixes [#616](https://github.com/dcodeIO/protobuf.js/issues/616)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/62eef58aa3b002115ebded0fa58acc770cd4e4f4) Respect long defaults in converters<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/e3170a160079a3a7a99997a2661cdf654cb69e24) Convert inner messages and undefined/null values more thoroughly, fixes [#615](https://github.com/dcodeIO/protobuf.js/issues/615)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/b52089efcb9827537012bebe83d1a15738e214f4) Always use first defined enum value as field default, fixes [#613](https://github.com/dcodeIO/protobuf.js/issues/613)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/64f95f9fa1bbe42717d261aeec5c16d1a7aedcfb) Install correct 'tmp' dependency when running pbts without dev dependencies installed, fixes [#612](https://github.com/dcodeIO/protobuf.js/issues/612)<br />
|
||||
|
||||
## New
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/cba46c389ed56737184e5bc2bcce07243d52e5ce) Generate named constructors for runtime messages, see [#588](https://github.com/dcodeIO/protobuf.js/issues/588)<br />
|
||||
|
||||
## CLI
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/ee20b81f9451c56dc106177bbf9758840b99d0f8) pbjs/pbts no longer generate any volatile headers, see [#614](https://github.com/dcodeIO/protobuf.js/issues/614)<br />
|
||||
|
||||
## Docs
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/ec9d517d0b87ebe489f02097c2fc8005fae38904) Attempted to make broken shields less annoying<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/5cd4c2f2a94bc3c0f2c580040bce28dd42eaccec) Updated README<br />
|
||||
|
||||
## Other
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/0643f93f5c0d96ed0ece5b47f54993ac3a827f1b) Some cleanup and added a logo<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/169638382de9efe35a1079c5f2045c33b858059a) use $protobuf.Long<br />
|
||||
|
||||
# [6.4.0](https://github.com/dcodeIO/protobuf.js/releases/tag/6.4.0) ([release](https://github.com/dcodeIO/protobuf.js/releases/tag/6.4.0))
|
||||
|
||||
## Breaking
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/a017bf8a2dbdb7f9e7ce4c026bb6845174feb3b1) Dropped IE8 support<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/39bc1031bb502f8b677b3736dd283736ea4d92c1) Removed now unused util.longNeq which was used by early static code<br />
|
||||
|
||||
## Fixed
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/5915ff972482e7db2a73629244ab8a93685b2e55) Do not swallow errors in loadSync, also accept negative enum values in Enum#add, fixes [#609](https://github.com/dcodeIO/protobuf.js/issues/609)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/fde56c0de69b480343931264a01a1ead1e3156ec) Improved bytes field support, also fixes [#606](https://github.com/dcodeIO/protobuf.js/issues/606)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/0c03f327115d57c4cd5eea3a9a1fad672ed6bd44) Fall back to browser Reader when passing an Uint8Array under node, fixes [#605](https://github.com/dcodeIO/protobuf.js/issues/605)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/7eb3d456370d7d66b0856e32b2d2602abf598516) Respect optional properties when writing interfaces in tsd-jsdoc, fixes [#598](https://github.com/dcodeIO/protobuf.js/issues/598)<br />
|
||||
|
||||
## New
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/bcadffecb3a8b98fbbd34b45bae0e6af58f9c810) Instead of protobuf.parse.keepCase, fall back to protobuf.parse.defaults holding all possible defaults, see [#608](https://github.com/dcodeIO/protobuf.js/issues/608)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/a4d6a2af0d57a2e0cccf31e3462c8b2465239f8b) Added global ParseOptions#keepCase fallback as protobuf.parse.keepCase, see [#608](https://github.com/dcodeIO/protobuf.js/issues/608)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/a017bf8a2dbdb7f9e7ce4c026bb6845174feb3b1) Converters use code generation and support custom implementations<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/28ce07d9812f5e1743afef95a94532d2c9488a84) Be more verbose when throwing invalid wire type errors, see [#602](https://github.com/dcodeIO/protobuf.js/issues/602)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/40074bb69c3ca4fcefe09d4cfe01f3a86844a7e8) Added an asJSON-option to always populate array fields, even if defaults=false, see [#597](https://github.com/dcodeIO/protobuf.js/issues/597)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/a7d23240a278aac0bf01767b6096d692c09ae1ce) Attempt to improve TypeScript support by using explicit exports<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/cec253fb9a177ac810ec96f4f87186506091fa37) Copy-pasted typescript definitions to micro modules, see [#599](https://github.com/dcodeIO/protobuf.js/issues/599)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/1f18453c7bfcce65c258fa98a3e3d4577d2e550f) Emit an error on resolveAll() if any extension fields cannot be resolved, see [#595](https://github.com/dcodeIO/protobuf.js/issues/595) + test case<br />
|
||||
|
||||
## CLI
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/804739dbb75359b0034db0097fe82081e3870a53) Removed 'not recommend' label for --keep-case, see [#608](https://github.com/dcodeIO/protobuf.js/issues/608)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/9681854526f1813a6ef08becf130ef2fbc28b638) Added customizable linter configuration to pbjs<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/9681854526f1813a6ef08becf130ef2fbc28b638) Added stdin support to pbjs and pbts<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/407223b5ceca3304bc65cb48888abfdc917d5800) Static code no longer uses IE8 support utility<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/a017bf8a2dbdb7f9e7ce4c026bb6845174feb3b1) Generated static code now supports asJSON/from<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/3c775535517b8385a1d3c1bf056f3da3b4266f8c) Added support for TypeScript enums to pbts<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/0cda72a55a1f2567a5d981dc5d924e55b8070513) Added a few helpful comments to static code<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/24b293c297feff8bda5ee7a2f8f3f83d77c156d0) Slightly beautify statically generated code<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/65637ffce20099df97ffbcdce50faccc8e97c366) Do not wrap main definition as a module and export directly instead<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/65637ffce20099df97ffbcdce50faccc8e97c366) Generate prettier definitions with --no-comments<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/20d8a2dd93d3bbb6990594286f992e703fc4e334) Added variable arguments support to tsd-jsdoc<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/8493dbd9a923693e943f710918937d83ae3c4572) Reference dependency imports as a module to prevent name collisions, see [#596](https://github.com/dcodeIO/protobuf.js/issues/596)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/39a2ea361c50d7f4aaa0408a0d55bb13823b906c) Removed now unnecessary comment lines in generated static code<br />
|
||||
|
||||
## Docs
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/a4e41b55471d83a8bf265c6641c3c6e0eee82e31) Added notes on CSP-restricted environments to README, see [#593](https://github.com/dcodeIO/protobuf.js/issues/593)<br />
|
||||
|
||||
## Other
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/1a3effdad171ded0608e8da021ba8f9dd017f2ff) Added test case for asJSON with arrays=true, see [#597](https://github.com/dcodeIO/protobuf.js/issues/597)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/751a90f509b68a5f410d1f1844ccff2fc1fc056a) Added a tape adapter to assert message equality accross browsers<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/fde56c0de69b480343931264a01a1ead1e3156ec) Refactored some internal utility away<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/805291086f6212d1f108b3d8f36325cf1739c0bd) Reverted previous attempt on [#597](https://github.com/dcodeIO/protobuf.js/issues/597)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/c5160217ea95996375460c5403dfe37b913d392e) Minor tsd-jsdoc refactor<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/961dd03061fc2c43ab3bf22b3f9f5165504c1002) Removed unused sandbox files<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/f625eb8b0762f8f5d35bcd5fc445e52b92d8e77d) Updated package.json of micro modules to reference types, see [#599](https://github.com/dcodeIO/protobuf.js/issues/599)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/46ec8209b21cf9ff09ae8674e2a5bbc49fd4991b) Reference dependencies as imports in generated typescript definitions, see [#596](https://github.com/dcodeIO/protobuf.js/issues/596)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/3bab132b871798c7c50c60a4c14c2effdffa372e) Allow null values on optional long fields, see [#590](https://github.com/dcodeIO/protobuf.js/issues/590)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/31da56c177f1e11ffe0072ad5f58a55e3f8008fd) Various jsdoc improvements and a workaround for d.ts generation, see [#592](https://github.com/dcodeIO/protobuf.js/issues/592)<br />
|
||||
|
||||
# [6.3.1](https://github.com/dcodeIO/protobuf.js/releases/tag/6.3.1)
|
||||
|
||||
## Fixed
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/95ed6e9e8268711db24f44f0d7e58dd278ddac4c) Empty inner messages are always present on the wire + test case + removed now unused Writer#ldelim parameter, see [#585](https://github.com/dcodeIO/protobuf.js/issues/585)<br />
|
||||
|
||||
## CLI
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/e8a4d5373b1a00cc6eafa5b201b91d0e250cc00b) Expose tsd-jsdoc's comments option to pbts as --no-comments, see [#587](https://github.com/dcodeIO/protobuf.js/issues/587)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/6fe099259b5985d873ba5bec88c049d7491a11cc) Increase child process max buffer when running jsdoc from pbts, see [#587](https://github.com/dcodeIO/protobuf.js/issues/587)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/3d84ecdb4788d71b5d3928e74db78e8e54695f0a) pbjs now generates more convenient dot-notation property accessors<br />
|
||||
|
||||
## Other
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/1e0ebc064e4f2566cebf525d526d0b701447bd6a) And fixed IE8 again (should probably just drop IE8 for good)<br />
|
||||
|
||||
# [6.3.0](https://github.com/dcodeIO/protobuf.js/releases/tag/6.3.0)
|
||||
|
||||
## Breaking
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/a97956b1322b6ee62d4fc9af885658cd5855e521) Moved camelCase/underScore away from util to where actually used<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/c144e7386529b53235a4a5bdd8383bdb322f2825) Renamed asJSON option keys (enum to enums, long to longs) because enum is a reserved keyword<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/5b9ade428dca2df6a13277522f2916e22092a98b) Moved JSON/Message conversion to its own source file and added Message/Type.from + test case, see [#575](https://github.com/dcodeIO/protobuf.js/issues/575)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/0b0de2458a1ade1ccd4ceb789697be13290f856b) Relicensed the library and its components to BSD-3-Clause to match the official implementation (again)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/22a64c641d4897965035cc80e92667bd243f182f) Dropped support for browser buffer entirely (is an Uint8Array anyway), ensures performance and makes things simpler<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/22a64c641d4897965035cc80e92667bd243f182f) Removed dead parts of the Reader API<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/964f65a9dd94ae0a18b8be3d9a9c1b0b1fdf6424) Refactored BufferReader/Writer to their own files and removed unnecessary operations (node always has FloatXXArray and browser buffer uses ieee anyway)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/bfac0ea9afa3dbaf5caf79ddf0600c3c7772a538) Stripped out fallback encoder/decoder/verifier completely (even IE8 supports codegen), significantly reduces bundle size, can use static codegen elsewhere<br />
|
||||
|
||||
## Fixed
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/c3023a2f51fc74547f6c6e53cf75feed60f3a25c) Actually concatenate mixed custom options when parsing<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/0d66b839df0acec2aea0566d2c0bbcec46c3cd1d) Fixed a couple of issues with alternative browser builds<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/33706cdc201bc863774c4af6ac2c38ad96a276e6) Properly set long defaults on prototypes<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/0ea2740f0774b4c5c349b9c303f3fb2c2743c37b) Fixed reference error in minimal runtime, see [#580](https://github.com/dcodeIO/protobuf.js/issues/580)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/741b6d8fde84d9574676a729a29a428d99f0a0a0) Non-repeated empty messages are always present on the wire, see [#581](https://github.com/dcodeIO/protobuf.js/issues/581)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/7fac9d6a39bf42d316c1676082a2d0804bc55934) Properly check Buffer.prototype.set with node v4<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/3ad8108eab57e2b061ee6f1fddf964abe3f4cbc7) Prevent NRE and properly annotate verify signature in tsd-jsdoc, fixed [#572](https://github.com/dcodeIO/protobuf.js/issues/572)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/6c2415d599847cbdadc17dee3cdf369fc9facade) Fix directly using Buffer instead of util.Buffer<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/19e906c2a15acc6178b3bba6b19c2f021e681176) Added filter type to Namespace#lookup, fixes [#569](https://github.com/dcodeIO/protobuf.js/issues/569)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/9c9a66bf393d9d6927f35a9c18abf5d1c31db912) Fixed parsing enum inner options, see [#565](https://github.com/dcodeIO/protobuf.js/issues/565)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/ea7ba8b83890084d61012cb5386dc11dadfb3908) Fixed release links in README files<br />
|
||||
|
||||
## New
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/442471363f99e67fa97044f234a47b3c9b929dfa) Added a noparse build for completeness<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/bfee1cc3624d0fa21f9553c2f6ce2fcf7fcc09b7) Now compresses .gz files using zopfli to make them useful beyond being just a reference<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/aed134aa1cd7edd801de77c736cf5efe6fa61cb0) Updated non-bundled google types folder with missing descriptors and added wrappers to core<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/0b0de2458a1ade1ccd4ceb789697be13290f856b) Replaced the ieee754 implementation for old browsers with a faster, use-case specific one + simple test case<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/99ad9cc08721b834a197d4bbb67fa152d7ad79aa) Added .create to statically generated types and uppercase nested elements to reflection namespaces, see [#576](https://github.com/dcodeIO/protobuf.js/issues/576)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/99ad9cc08721b834a197d4bbb67fa152d7ad79aa) Also added Namespace#getEnum for completeness, see [#576](https://github.com/dcodeIO/protobuf.js/issues/576)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/ef43acff547c0cd84cfb7a892fe94504a586e491) Added Namespace#getEnum and changed #lookupEnum to the same behavior, see [#576](https://github.com/dcodeIO/protobuf.js/issues/576)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/1fcfdfe21c1b321d975a8a96d133a452c9a9c0d8) Added a heap of coverage comments for usually unused code paths to open things up<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/c234de7f0573ee30ed1ecb15aa82b74c0f994876) Added codegen test to determine if any ancient browsers don't actually support it<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/fed2000e7e461efdb1c3a1a1aeefa8b255a7c20b) Added legacy groups support to pbjs, see [#568](https://github.com/dcodeIO/protobuf.js/issues/568)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/974a1321da3614832aa0a5b2e7c923f66e4ba8ae) Initial support for legacy groups + test case, see [#568](https://github.com/dcodeIO/protobuf.js/issues/568)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/9c9a66bf393d9d6927f35a9c18abf5d1c31db912) Added asJSON bytes as Buffer, see [#566](https://github.com/dcodeIO/protobuf.js/issues/566)<br />
|
||||
|
||||
## CLI
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/c60cd397e902ae6851c017f2c298520b8336cbee) Annotated callback types in pbjs-generated services, see [#582](https://github.com/dcodeIO/protobuf.js/issues/582)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/3e7e4fc59e6d2d6c862410b4b427fbedccdb237b) Removed type/ns alias comment in static target to not confuse jsdoc unnecessarily<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/99ad9cc08721b834a197d4bbb67fa152d7ad79aa) Made pbjs use loadSync for deterministic outputs, see [#573](https://github.com/dcodeIO/protobuf.js/issues/573)<br />
|
||||
|
||||
## Docs
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/4d1f5facfcaaf5f2ab6a70b12443ff1b66e7b94e) Updated documentation on runtime and noparse builds<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/c59647a7542cbc4292248787e5f32bb99a9b8d46) Fixed an issue with the changelog generator skipping some commits<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/24f2c03af9f13f5404259866fdc8fed33bfaae25) Added notes on how to use pbjs and pbts programmatically<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/3544576116146b209246d71c7f7a9ed687950b26) Manually sorted old changelog entries<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/d5812571f335bae68f924aa1098519683a9f3e44) Initial changelog generator, see [#574](https://github.com/dcodeIO/protobuf.js/issues/574)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/ab3e236a967a032a98267a648f84d129fdb4d4a6) Added static/JSON module interchangeability to README<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/7939a4bd8baca5f7e07530fc93f27911a6d91c6f) Updated README and bundler according to dynamic require calls<br />
|
||||
|
||||
## Other
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/93e04f1db4a9ef3accff8d071c75be3d74c0cd4a) Added basic services test case<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/b5a068f5b79b6f00c4b05d9ac458878650ffa09a) Just polyfill Buffer.from / .allocUnsafe for good<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/4375a485789e14f7bf24bece819001154a03dca2) Added a test case to find out if all the fallbacks are just for IE8<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/deb2e82ed7eda41d065a09d120e91c0f7ecf1e6a) Commented out float assertions in float test including explanation<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/d3ebd5745b024033fbc2410ecad4d4e02abd67db) Expose array implementation used with (older) browsers on util for tests<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/b1b6a813c93da4c7459755186aa02ef2f3765c94) Updated test cases<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/99dc5faa7b39fdad8ebc102de4463f8deb7f48ff) Added assumptions to float test case<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/948ca2e3c5c62fedcd918d75539c261abf1a7347) Updated travis config to use C++11<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/c59647a7542cbc4292248787e5f32bb99a9b8d46) Updated / added additional LICENSE files where appropriate<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/333f0221814be976874862dc83d0b216e07d4012) Integrated changelog into build process, now also has 'npm run make' for everything, see [#574](https://github.com/dcodeIO/protobuf.js/issues/574)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/ab3e236a967a032a98267a648f84d129fdb4d4a6) Minor optimizations through providing type-hints<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/ab3e236a967a032a98267a648f84d129fdb4d4a6) Reverted shortened switch statements in verifier<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/ab3e236a967a032a98267a648f84d129fdb4d4a6) Enums can't be map key types<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/8ef6975b0bd372b79e9b638f43940424824e7176) Use custom require (now a micromodule) for all optional modules, see [#571](https://github.com/dcodeIO/protobuf.js/issues/571)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/e226f001e4e4633d64c52be4abc1915d7b7bd515) Support usage when size = 0<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/19e906c2a15acc6178b3bba6b19c2f021e681176) Reverted aliases frequently used in codegen for better gzip ratio<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/47b51ec95a540681cbed0bac1b2f02fc4cf0b73d) Shrinked bundle size - a bit<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/f8451f0058fdf7a1fac15ffc529e4e899c6b343c) Can finally run with --trace-deopt again without crashes<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/9c9a66bf393d9d6927f35a9c18abf5d1c31db912) Other minor optimizations<br />
|
||||
|
||||
# [6.2.1](https://github.com/dcodeIO/protobuf.js/releases/tag/6.2.1)
|
||||
|
||||
## New
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/1a6fdc9a11fb08506d09351f8e853384c2b8be25) Added ParseOptions to protobuf.parse and --keep-case for .proto sources to pbjs, see [#564](https://github.com/dcodeIO/protobuf.js/issues/564)<br />
|
||||
|
||||
## Other
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/fc383d0721d83f66b2d941f0d9361621839327e9) Better TypeScript definition support for @property-annotated objects<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/4531d75cddee9a99adcac814d52613116ba789f3) Can't just inline longNeq but can be simplified<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/8f25377cf99036794ba13b160a5060f312d1a7e7) Array abuse and varint optimization<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/90b201209a03e8022ada0ab9182f338fa0813651) Updated dependencies<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/f1110b0993ec86e0a4aee1735bd75b901952cb36) Other minor improvements to short ifs<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/c079c900e2d61c63d5508eafacbd00163d377482) Reader/Writer example<br />
|
||||
|
||||
# [6.2.0](https://github.com/dcodeIO/protobuf.js/releases/tag/6.2.0)
|
||||
|
||||
## Fixed
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/9b7b92a4c7f8caa460d687778dc0628a74cdde37) Fixed reserved names re, also ensure valid service method names, see [#559](https://github.com/dcodeIO/protobuf.js/issues/559)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/a83425049c9a78c5607bc35e8089e08ce78a741e) Fix d.ts whitespace on empty lines, added tsd-jsdoc LICENSE<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/5f9bede280aa998afb7898e8d2718b4a229e8e6f) Fix asJSON defaults option, make it work for repeated fields.<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/b0aef62191b65cbb305ece84a6652d76f98da259) Inlined any Reader/Writer#tag calls, also fixes [#556](https://github.com/dcodeIO/protobuf.js/issues/556)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/4d091d41caad9e63cd64003a08210b78878e01dd) Fix building default dist files with explicit runtime=false<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/096dfb686f88db38ed2d8111ed7aac36f8ba658a) Apply asJSON recursively<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/19c269f1dce1b35fa190f264896d0865a54a4fff) Ensure working reflection class names with minified builds<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/9c769504e0ffa6cbe0b6f8cdc14f1231bed7ee34) Lazily resolve (some) cyclic dependencies, see [#560](https://github.com/dcodeIO/protobuf.js/issues/560)<br />
|
||||
|
||||
## New
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/da07d8bbbede4175cc45ca46d883210c1082e295) Added protobuf.roots to minimal runtime, see [#554](https://github.com/dcodeIO/protobuf.js/issues/554)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/8f407a18607334185afcc85ee98dc1478322bd01) Repo now includes a restructured version of tsd-jsdoc with our changes incorporated for issues/prs, see [#550](https://github.com/dcodeIO/protobuf.js/issues/550)<br />
|
||||
|
||||
## CLI
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/1b5e4250415c6169eadb405561242f847d75044b) Updated pbjs arguments<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/4750e3111b9fdb107d0fc811e99904fbcdbb6de1) Pipe tsd-jsdoc output (requires dcodeIO/tsd-jsdoc/master) and respect cwd, see [#550](https://github.com/dcodeIO/protobuf.js/issues/550)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/75f4b6cb6325a3fc7cd8fed3de5dbe0b6b29c748) tsd-jsdoc progress<br />
|
||||
|
||||
## Docs
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/766171e4c8b6650ea9c6bc3e76c9c96973c2f546) README<br />
|
||||
|
||||
## Other
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/c33835cb1fe1872d823e94b0fff024dc624323e8) Added GH issue template<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/6f9ffb6307476d48f45dc4f936744b82982d386b) Path micromodule, dependencies<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/0b9b1d8505743995c5328daab1f1e124debc63bd) Test case for [#556](https://github.com/dcodeIO/protobuf.js/issues/556)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/74b2c5c5d33a46c3751ebeadc9d934d4ccb8286c) Raw alloc benchmark<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/fb74223b7273530d8baa53437ee96c65a387436d) Other minor optimizations<br />
|
||||
|
||||
# [6.1.1](https://github.com/dcodeIO/protobuf.js/releases/tag/6.1.1)
|
||||
|
||||
## Fixed
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/baea920fa6bf5746e0a7888cdbb089cd5d94fc90) Properly encode/decode map kv pairs as repeated messages (codegen and fallback), see [#547](https://github.com/dcodeIO/protobuf.js/issues/547)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/28a1d26f28daf855c949614ef485237c6bf316e5) Make genVerifyKey actually generate conditions for 32bit values and bool, fixes [#546](https://github.com/dcodeIO/protobuf.js/issues/546)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/3e9d8ea9a5cbb2e029b5c892714edd6926d2e5a7) Fix to generation of verify methods for bytes<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/e7893675ccdf18f0fdaea8f9a054a6b5402b060e) Take special care of oneofs when encoding (i.e. when explicitly set to defaults), see [#542](https://github.com/dcodeIO/protobuf.js/issues/542)<br />
|
||||
|
||||
## New
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/52cd8b5a891ec8e11611127c8cfa6b3a91ff78e3) Added Message#asJSON option for bytes conversion<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/01365ba9116ca1649b682635bb29814657c4133c) Added Namespace#lookupType and Namespace#lookupService (throw instead of returning null), see [#544](https://github.com/dcodeIO/protobuf.js/issues/544)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/a54fbc918ef6bd627113f05049ff704e07bf33b4) Provide prebuilt browser versions of the static runtime<br />
|
||||
|
||||
## CLI
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/3783af7ca9187a1d9b1bb278ca69e0188c7e4c66) Initial pbts CLI for generating TypeScript definitions, see [#550](https://github.com/dcodeIO/protobuf.js/issues/550)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/b8bce03405196b1779727f246229fd9217b4303d) Refactored json/static-module targets to use common wrappers<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/691231fbc453a243f48a97bfb86794ab5718ef49) Refactor cli to support multiple built-in wrappers, added named roots instead of always using global.root and added additionally necessary eslint comments, see [#540](https://github.com/dcodeIO/protobuf.js/issues/540)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/e3e77d0c7dc973d3a5948a49d123bdaf8a048030) Annotate namespaces generated by static target, see [#550](https://github.com/dcodeIO/protobuf.js/issues/550)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/aff21a71e6bd949647b1b7721ea4e1fe16bcd933) static target: Basic support for oneof fields, see [#542](https://github.com/dcodeIO/protobuf.js/issues/542)<br />
|
||||
|
||||
## Docs
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/b6b00aa7b0cd35e0e8f3c16b322788e9942668d4) Fix to reflection documentation<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/ed86f3acbeb6145be5f24dcd05efb287b539e61b) README on minimal runtime / available downloads<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/d31590b82d8bafe6657bf877d403f01a034ab4ba) Notes on descriptors vs static modules<br />
|
||||
|
||||
## Other
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/ce41d0ef21cee2d918bdc5c3b542d3b7638b6ead) A lot of minor optimizations to performance and gzip ratio<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/ecbb4a52fbab445e63bf23b91539e853efaefa47) Minimized base64 tables<br />
|
||||
|
||||
# [6.1.0](https://github.com/dcodeIO/protobuf.js/releases/tag/6.1.0)
|
||||
|
||||
## Breaking
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/a46cc4934b7e888ae80e06fd7fdf91e5bc7f54f5) Removed as-function overload for Reader/Writer, profiler stub, optimized version of Reader#int32<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/7983ee0ba15dc5c1daad82a067616865051848c9) Refactored Prototype and inherits away, is now Class and Message for more intuitive documentation and type refs<br />
|
||||
|
||||
## Fixed
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/c3c70fe3a47fd4f7c85dc80e1af7d9403fe349cd) Fixed failing test case on node < 6<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/66be5983321dd06460382d045eb87ed72a186776) Fixed serialization order of sfixed64, fixes [#536](https://github.com/dcodeIO/protobuf.js/issues/536)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/7def340833f9f1cc41f4835bd0d62e203b54d9eb) Fixed serialization order of fixed64, fallback to parseInt with no long lib, see [#534](https://github.com/dcodeIO/protobuf.js/issues/534)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/98a58d40ca7ee7afb1f76c5804e82619104644f6) Actually allow undefined as service method type, fixes [#528](https://github.com/dcodeIO/protobuf.js/issues/528)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/38d867fc50a4d7eb1ca07525c9e4c71b8782443e) Do not skip optional delimiter after aggregate options, fixes [#520](https://github.com/dcodeIO/protobuf.js/issues/520)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/67449db7c7416cbc59ad230c168cf6e6b6dba0c5) Verify empty base64 encoded strings for bytes fields, see [#535](https://github.com/dcodeIO/protobuf.js/issues/535)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/ef0fcb6d525c5aab13a39b4f393adf03f751c8c9) wrong spell role should be rule<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/55db92e21a26c04f524aeecb2316968c000e744d) decodeDelimited always forks if writer is specified, see [#531](https://github.com/dcodeIO/protobuf.js/issues/531)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/ebae1e18152617f11ac07827828f5740d4f2eb7e) Mimic spec-compliant behaviour in oneof getVirtual, see [#523](https://github.com/dcodeIO/protobuf.js/issues/523)<br />
|
||||
|
||||
## New
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/a0398f5880c434ff88fd8d420ba07cc29c5d39d3) Initial base64 string support for bytes fields, see [#535](https://github.com/dcodeIO/protobuf.js/issues/535)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/6a6c00c3e1def5d35c7fcaa1bbb6ce4e0fe67544) Initial type-checking verifier, see [#526](https://github.com/dcodeIO/protobuf.js/issues/526), added to bench out of competition<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/3aa984e063cd73e4687102b4abd8adc16582dbc4) Initial loadSync (node only), see [#529](https://github.com/dcodeIO/protobuf.js/issues/529)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/f1370ff5b0db2ebb73b975a3d7c7bd5b901cbfac) Initial RPC service implementaion, see [#529](https://github.com/dcodeIO/protobuf.js/issues/529)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/090d8eaf10704a811a73e1becd52f2307cbcad48) added 'defaults' option to Prototype#asJSON, see [#521](https://github.com/dcodeIO/protobuf.js/issues/521)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/7c28483d65cde148e61fe9993f1716960b39e049) Use Uint8Array pool in browsers, just like node does with buffers<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/4157a0ec2e54c4d19794cb16edddcd8d4fbd3e76) Also validate map fields, see [#526](https://github.com/dcodeIO/protobuf.js/issues/526) (this really needs some tests)<br />
|
||||
|
||||
## CLI
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/0ce099bf4f4666fd00403a2839e6da628b8328a9) Added json-module target to pbjs, renamed static to static-module, see [#522](https://github.com/dcodeIO/protobuf.js/issues/522)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/1d99442fe65fcaa2f9e33cc0186ef1336057e0cf) updated internals and static target to use immutable objects on prototypes<br />
|
||||
|
||||
## Docs
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/e6eaa91b9fe021b3356d4d7e42033a877bc45871) Added a couple of alternative signatures, protobuf.load returns promise or undefined, aliased Reader/Writer-as-function signature with Reader/Writer.create for typed dialects, see [#518](https://github.com/dcodeIO/protobuf.js/issues/518)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/9df6a3d4a654c3e122f97d9a594574c7bbb412da) Added variations for Root#load, see [#527](https://github.com/dcodeIO/protobuf.js/issues/527)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/193e65c006a8df8e9b72e0f23ace14a94952ee36) Added benchmark and profile related information to README<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/228a2027de35238feb867cb0485c78c755c4d17d) Added service example to README, see [#529](https://github.com/dcodeIO/protobuf.js/issues/529)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/1a8c720714bf867f1f0195b4690faefa4f65e66a) README on tests<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/014fb668dcf853874c67e3e0aeb7b488a149d35c) Update README/dist to reflect recent changes<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/11d844c010c5a22eff9d5824714fb67feca77b26) Minimal documentation for micromodules<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/47608dd8595b0df2b30dd18fef4b8207f73ed56a) Document all the callbacks, see [#527](https://github.com/dcodeIO/protobuf.js/issues/527)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/3891ab07bbe20cf84701605aa62453a6dbdb6af2) Documented streaming-rpc example a bit<br />
|
||||
|
||||
## Other
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/5606cb1bc41bc90cb069de676650729186b38640) Removed the need for triple-slash references in .d.ts by providing a minimal Long interface, see [#527](https://github.com/dcodeIO/protobuf.js/issues/527), see [#530](https://github.com/dcodeIO/protobuf.js/issues/530)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/adf3cc3d340f8b2a596c892c64457b15e42a771b) Transition to micromodules<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/f3a9589b74af6a1bf175f2b1994badf703d7abc4) Refactored argument order of utf8 for plausibility<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/14c207ed6e05a61e756fa4192efb2fa219734dd6) Restructured reusable micromodules<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/b510ba258986271f07007aebc5dcfea7cfd90cf4) Can't use Uint8Array#set on node < 6 buffers<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/78952a50ceee8e196b4f156eb01f7f693b5b8aac) Test case for [#531](https://github.com/dcodeIO/protobuf.js/issues/531)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/954577c6b421f7d7f4905bcc32f57e4ebaf548da) Safer signaling for synchronous load, see [#529](https://github.com/dcodeIO/protobuf.js/issues/529)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/9ea3766ff1b8fb7ccad028f44efe27d3b019eeb7) Proper end of stream signaling to rpcImpl, see [#529](https://github.com/dcodeIO/protobuf.js/issues/529)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/e4faf7fac9b34d4776f3c15dfef8d2ae54104567) Moved event emitter to util, also accepts listener context, see [#529](https://github.com/dcodeIO/protobuf.js/issues/529)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/9bdec62793ce77c954774cc19106bde4132f24fc) Probably the worst form of hiding require programmatically, see [#527](https://github.com/dcodeIO/protobuf.js/issues/527)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/4462d8b05d3aba37c865cf53e09b3199cf051a92) Attempt to hide require('fs') from webpack, see [#527](https://github.com/dcodeIO/protobuf.js/issues/527)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/7c3bf8d32cbf831b251730b3876c35c901926300) Trying out jsdoc variations, see [#527](https://github.com/dcodeIO/protobuf.js/issues/527)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/bb4059467287fefda8f966de575fd0f8f9690bd3) by the way, why not include the json->proto functionality into "util"?<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/f1008e6ee53ee50358e19c10df8608e950be4be3) Update proto.js<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/fc9014822d9cdeae8c6e454ccb66ee28f579826c) Automatic profile generation and processing<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/2a2f6dcab5beaaa98e55a005b3d02643c45504d6) Generalized buffer pool and moved it to util<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/53a16bf3ada4a60cc09757712e0046f3f2d9d094) Make shields visible on npm, yey<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/9004b9d0c5135a7f6df208ea658258bf2f9e6fc9) More shields, I love shields, and maybe a workaround for travis timing out when sauce takes forever<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/060a7916a2715a9e4cd4d05d7c331bec33e60b7e) Trying SauceLabs with higher concurrency<br />
|
||||
|
||||
# [6.0.2](https://github.com/dcodeIO/protobuf.js/releases/tag/6.0.2)
|
||||
|
||||
## Fixed
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/23d664384900eb65e44910def45f04be996fbba1) Fix packable float/double see [#513](https://github.com/dcodeIO/protobuf.js/issues/513)<br />
|
||||
|
||||
## New
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/54283d39c4c955b6a84f7f53d4940eec39e4df5e) Handle oneofs in prototype ctor, add non-ES5 fallbacks, test case<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/0ae66752362899b8407918a759b09938e82436e1) Be nice to AMD, allow reconfiguration of Reader/Writer interface<br />
|
||||
|
||||
## CLI
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/00f3574ef4ee8b237600e41839bf0066719c4469) Initial static codegen target for reference<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/81e36a7c14d89b487dfe7cfb2f8380fcdf0df392) pbjs static target services support<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/4885b8239eb74c72e665787ea0ece3336e493d7f) pbjs static target progress, uses customizable wrapper template<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/ad5abe7bac7885ba4f68df7eeb800d2e3b81750b) Static pbjs target progress, now generates usable CommonJS code, see [#512](https://github.com/dcodeIO/protobuf.js/issues/512)<br />
|
||||
|
||||
## Docs
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/d9634d218849fb49ff5dfb4597bbb2c2d43bbf08) TypeScript example<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/fce8276193a5a9fabad5e5fbeb2ccd4f0f3294a9) Adjectives, notes on browserify<br />
|
||||
|
||||
## Other
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/23d664384900eb65e44910def45f04be996fbba1) Refactor runtime util into separate file, reader/writer uses runtime util<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/f91c432a498bebc0adecef1562061b392611f51a) Also optimize reader with what we have learned<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/d83f799519fe69808c88e83d9ad66c645d15e963) More (shameless) writer over-optimization<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/8a2dbc610a06fe3a1a2695a3ab032d073b77760d) Trading package size for float speed<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/95c5538cfaf1daf6b4990f6aa7599779aaacf99f) Skip defining getters and setters on IE8 entirely, automate defining fallbacks<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/09865d069303e795e475c82afe2b2267abaa59ea) Unified proto/reflection/classes/static encoding API to always return a writer<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/98d6ae186a48416e4ff3030987caed285f40a4f7) plain js utf8 is faster for short strings<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/79fbbf48b8e4dc9c41dcbdef2b73c5f2608b0318) improve TypeScript support. add simple test script.<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/96fa07adec8b0ae05e07c2c40383267f25f2fc92) Use long.js dependency in tests, reference types instead of paths in .d.ts see [#503](https://github.com/dcodeIO/protobuf.js/issues/503)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/5785dee15d07fbcd14025a96686707173bd649a0) Restructured encoder / decoder to better support static code gen<br />
|
||||
|
||||
# [6.0.1](https://github.com/dcodeIO/protobuf.js/releases/tag/6.0.1)
|
||||
|
||||
## Fixed
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/799c1c1a84b255d1831cc84c3d24e61b36fa2530) Add support for long strings, fixes [#509](https://github.com/dcodeIO/protobuf.js/issues/509)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/6e5fdb67cb34f90932e95a51370e1652acc55b4c) expose zero on LongBits, fixes [#508](https://github.com/dcodeIO/protobuf.js/issues/508)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/aa922c07490f185c5f97cf28ebbd65200fc5e377) Fixed issues with Root.fromJSON/#addJSON, search global for Long<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/51fe45656b530efbba6dad92f92db2300aa18761) Properly exclude browserify's annoying _process, again, fixes [#502](https://github.com/dcodeIO/protobuf.js/issues/502)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/3c16e462a28c36abbc8a176eab9ac2e10ba68597) Remember loaded files earlier to prevent race conditions, fixes [#501](https://github.com/dcodeIO/protobuf.js/issues/501)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/4012a00a0578185d92fb6e7d3babd059fee6d6ab) Allow negative enum ids even if super inefficient (encodes as 10 bytes), fixes [#499](https://github.com/dcodeIO/protobuf.js/issues/499), fixes [#500](https://github.com/dcodeIO/protobuf.js/issues/500)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/96dd8f1729ad72e29dbe08dd01bc0ba08446dbe6) set resolvedResponseType on resolve(), fixes [#497](https://github.com/dcodeIO/protobuf.js/issues/497)<br />
|
||||
|
||||
## New
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/d3ae961765e193ec11227d96d699463de346423f) Initial take on runtime services, see [#507](https://github.com/dcodeIO/protobuf.js/issues/507)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/90cd46b3576ddb2d0a6fc6ae55da512db4be3acc) Include dist/ in npm package for frontend use<br />
|
||||
|
||||
## CLI
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/4affa1b7c0544229fb5f0d3948df6d832f6feadb) pbjs proto target field options, language-level compliance with jspb test.proto<br />
|
||||
|
||||
## Docs
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/6a06e95222d741c47a51bcec85cd20317de7c0b0) always use Uint8Array in docs for tsd, see [#503](https://github.com/dcodeIO/protobuf.js/issues/503)<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/637698316e095fc35f62a304daaca22654974966) Notes on dist files<br />
|
||||
|
||||
## Other
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/29ff3f10e367d6a2ae15fb4254f4073541559c65) Update eslint env<br />
|
||||
[:hash:](https://github.com/dcodeIO/protobuf.js/commit/943be1749c7d37945c11d1ebffbed9112c528d9f) Browser field in package.json isn't required<br />
|
||||
Executable
+39
@@ -0,0 +1,39 @@
|
||||
This license applies to all parts of protobuf.js except those files
|
||||
either explicitly including or referencing a different license or
|
||||
located in a directory containing a different LICENSE file.
|
||||
|
||||
---
|
||||
|
||||
Copyright (c) 2016, Daniel Wirtz All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are
|
||||
met:
|
||||
|
||||
* Redistributions of source code must retain the above copyright
|
||||
notice, this list of conditions and the following disclaimer.
|
||||
* Redistributions in binary form must reproduce the above copyright
|
||||
notice, this list of conditions and the following disclaimer in the
|
||||
documentation and/or other materials provided with the distribution.
|
||||
* Neither the name of its author, nor the names of its contributors
|
||||
may be used to endorse or promote products derived from this software
|
||||
without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
---
|
||||
|
||||
Code generated by the command line utilities is owned by the owner
|
||||
of the input file used when generating it. This code is not
|
||||
standalone and requires a support library to be linked with it. This
|
||||
support library is itself covered by the above license.
|
||||
Executable
+879
@@ -0,0 +1,879 @@
|
||||
<h1><p align="center"><img alt="protobuf.js" src="https://github.com/dcodeIO/protobuf.js/raw/master/pbjs.png" width="120" height="104" /></p></h1>
|
||||
<p align="center"><a href="https://npmjs.org/package/protobufjs"><img src="https://img.shields.io/npm/v/protobufjs.svg" alt=""></a> <a href="https://travis-ci.org/dcodeIO/protobuf.js"><img src="https://travis-ci.org/dcodeIO/protobuf.js.svg?branch=master" alt=""></a> <a href="https://npmjs.org/package/protobufjs"><img src="https://img.shields.io/npm/dm/protobufjs.svg" alt=""></a> <a href="https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=dcode%40dcode.io&item_name=Open%20Source%20Software%20Donation&item_number=dcodeIO%2Fprotobuf.js"><img alt="donate ❤" src="https://img.shields.io/badge/donate-❤-ff2244.svg"></a></p>
|
||||
|
||||
**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/)).
|
||||
|
||||
**protobuf.js** is a pure JavaScript implementation with [TypeScript](https://www.typescriptlang.org) support for [node.js](https://nodejs.org) and the browser. It's easy to use, blazingly fast and works out of the box with [.proto](https://developers.google.com/protocol-buffers/docs/proto) files!
|
||||
|
||||
Contents
|
||||
--------
|
||||
|
||||
* [Installation](#installation)<br />
|
||||
How to include protobuf.js in your project.
|
||||
|
||||
* [Usage](#usage)<br />
|
||||
A brief introduction to using the toolset.
|
||||
|
||||
* [Valid Message](#valid-message)
|
||||
* [Toolset](#toolset)<br />
|
||||
|
||||
* [Examples](#examples)<br />
|
||||
A few examples to get you started.
|
||||
|
||||
* [Using .proto files](#using-proto-files)
|
||||
* [Using JSON descriptors](#using-json-descriptors)
|
||||
* [Using reflection only](#using-reflection-only)
|
||||
* [Using custom classes](#using-custom-classes)
|
||||
* [Using services](#using-services)
|
||||
* [Usage with TypeScript](#usage-with-typescript)<br />
|
||||
|
||||
* [Command line](#command-line)<br />
|
||||
How to use the command line utility.
|
||||
|
||||
* [pbjs for JavaScript](#pbjs-for-javascript)
|
||||
* [pbts for TypeScript](#pbts-for-typescript)
|
||||
* [Reflection vs. static code](#reflection-vs-static-code)
|
||||
* [Command line API](#command-line-api)<br />
|
||||
|
||||
* [Additional documentation](#additional-documentation)<br />
|
||||
A list of available documentation resources.
|
||||
|
||||
* [Performance](#performance)<br />
|
||||
A few internals and a benchmark on performance.
|
||||
|
||||
* [Compatibility](#compatibility)<br />
|
||||
Notes on compatibility regarding browsers and optional libraries.
|
||||
|
||||
* [Building](#building)<br />
|
||||
How to build the library and its components yourself.
|
||||
|
||||
Installation
|
||||
---------------
|
||||
|
||||
### node.js
|
||||
|
||||
```
|
||||
$> npm install protobufjs [--save --save-prefix=~]
|
||||
```
|
||||
|
||||
```js
|
||||
var protobuf = require("protobufjs");
|
||||
```
|
||||
|
||||
**Note** that this library's versioning scheme is not semver-compatible for historical reasons. For guaranteed backward compatibility, always depend on `~6.A.B` instead of `^6.A.B` (hence the `--save-prefix` above).
|
||||
|
||||
### Browsers
|
||||
|
||||
Development:
|
||||
|
||||
```
|
||||
<script src="//cdn.rawgit.com/dcodeIO/protobuf.js/6.X.X/dist/protobuf.js"></script>
|
||||
```
|
||||
|
||||
Production:
|
||||
|
||||
```
|
||||
<script src="//cdn.rawgit.com/dcodeIO/protobuf.js/6.X.X/dist/protobuf.min.js"></script>
|
||||
```
|
||||
|
||||
**Remember** to replace the version tag with the exact [release](https://github.com/dcodeIO/protobuf.js/tags) your project depends upon.
|
||||
|
||||
The library supports CommonJS and AMD loaders and also exports globally as `protobuf`.
|
||||
|
||||
### Distributions
|
||||
|
||||
Where bundle size is a factor, there are additional stripped-down versions of the [full library][dist-full] (~19kb gzipped) available that exclude certain functionality:
|
||||
|
||||
* When working with JSON descriptors (i.e. generated by [pbjs](#pbjs-for-javascript)) and/or reflection only, see the [light library][dist-light] (~16kb gzipped) that excludes the parser. CommonJS entry point is:
|
||||
|
||||
```js
|
||||
var protobuf = require("protobufjs/light");
|
||||
```
|
||||
|
||||
* When working with statically generated code only, see the [minimal library][dist-minimal] (~6.5kb gzipped) that also excludes reflection. CommonJS entry point is:
|
||||
|
||||
```js
|
||||
var protobuf = require("protobufjs/minimal");
|
||||
```
|
||||
|
||||
[dist-full]: https://github.com/dcodeIO/protobuf.js/tree/master/dist
|
||||
[dist-light]: https://github.com/dcodeIO/protobuf.js/tree/master/dist/light
|
||||
[dist-minimal]: https://github.com/dcodeIO/protobuf.js/tree/master/dist/minimal
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
Because JavaScript is a dynamically typed language, protobuf.js introduces the concept of a **valid message** in order to provide the best possible [performance](#performance) (and, as a side product, proper typings):
|
||||
|
||||
### Valid message
|
||||
|
||||
> A valid message is an object (1) not missing any required fields and (2) exclusively composed of JS types understood by the wire format writer.
|
||||
|
||||
There are two possible types of valid messages and the encoder is able to work with both of these for convenience:
|
||||
|
||||
* **Message instances** (explicit instances of message classes with default values on their prototype) always (have to) satisfy the requirements of a valid message by design and
|
||||
* **Plain JavaScript objects** that just so happen to be composed in a way satisfying the requirements of a valid message as well.
|
||||
|
||||
In a nutshell, the wire format writer understands the following types:
|
||||
|
||||
| Field type | Expected JS type (create, encode) | Conversion (fromObject)
|
||||
|------------|-----------------------------------|------------------------
|
||||
| s-/u-/int32<br />s-/fixed32 | `number` (32 bit integer) | <code>value | 0</code> if signed<br />`value >>> 0` if unsigned
|
||||
| s-/u-/int64<br />s-/fixed64 | `Long`-like (optimal)<br />`number` (53 bit integer) | `Long.fromValue(value)` with long.js<br />`parseInt(value, 10)` otherwise
|
||||
| float<br />double | `number` | `Number(value)`
|
||||
| bool | `boolean` | `Boolean(value)`
|
||||
| string | `string` | `String(value)`
|
||||
| bytes | `Uint8Array` (optimal)<br />`Buffer` (optimal under node)<br />`Array.<number>` (8 bit integers) | `base64.decode(value)` if a `string`<br />`Object` with non-zero `.length` is assumed to be buffer-like
|
||||
| enum | `number` (32 bit integer) | Looks up the numeric id if a `string`
|
||||
| message | Valid message | `Message.fromObject(value)`
|
||||
|
||||
* Explicit `undefined` and `null` are considered as not set if the field is optional.
|
||||
* Repeated fields are `Array.<T>`.
|
||||
* Map fields are `Object.<string,T>` with the key being the string representation of the respective value or an 8 characters long binary hash string for `Long`-likes.
|
||||
* Types marked as *optimal* provide the best performance because no conversion step (i.e. number to low and high bits or base64 string to buffer) is required.
|
||||
|
||||
### Toolset
|
||||
|
||||
With that in mind and again for performance reasons, each message class provides a distinct set of methods with each method doing just one thing. This avoids unnecessary assertions / redundant operations where performance is a concern but also forces a user to perform verification (of plain JavaScript objects that *might* just so happen to be a valid message) explicitly where necessary - for example when dealing with user input.
|
||||
|
||||
**Note** that `Message` below refers to any message class.
|
||||
|
||||
* **Message.verify**(message: `Object`): `null|string`<br />
|
||||
verifies that a **plain JavaScript object** satisfies the requirements of a valid message and thus can be encoded without issues. Instead of throwing, it returns the error message as a string, if any.
|
||||
|
||||
```js
|
||||
var payload = "invalid (not an object)";
|
||||
var err = AwesomeMessage.verify(payload);
|
||||
if (err)
|
||||
throw Error(err);
|
||||
```
|
||||
|
||||
* **Message.encode**(message: `Message|Object` [, writer: `Writer`]): `Writer`<br />
|
||||
encodes a **message instance** or valid **plain JavaScript object**. This method does not implicitly verify the message and it's up to the user to make sure that the payload is a valid message.
|
||||
|
||||
```js
|
||||
var buffer = AwesomeMessage.encode(message).finish();
|
||||
```
|
||||
|
||||
* **Message.encodeDelimited**(message: `Message|Object` [, writer: `Writer`]): `Writer`<br />
|
||||
works like `Message.encode` but additionally prepends the length of the message as a varint.
|
||||
|
||||
* **Message.decode**(reader: `Reader|Uint8Array`): `Message`<br />
|
||||
decodes a buffer to a **message instance**. If required fields are missing, it throws a `util.ProtocolError` with an `instance` property set to the so far decoded message. If the wire format is invalid, it throws an `Error`.
|
||||
|
||||
```js
|
||||
try {
|
||||
var decodedMessage = AwesomeMessage.decode(buffer);
|
||||
} catch (e) {
|
||||
if (e instanceof protobuf.util.ProtocolError) {
|
||||
// e.instance holds the so far decoded message with missing required fields
|
||||
} else {
|
||||
// wire format is invalid
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
* **Message.decodeDelimited**(reader: `Reader|Uint8Array`): `Message`<br />
|
||||
works like `Message.decode` but additionally reads the length of the message prepended as a varint.
|
||||
|
||||
* **Message.create**(properties: `Object`): `Message`<br />
|
||||
creates a new **message instance** from a set of properties that satisfy the requirements of a valid message. Where applicable, it is recommended to prefer `Message.create` over `Message.fromObject` because it doesn't perform possibly redundant conversion.
|
||||
|
||||
```js
|
||||
var message = AwesomeMessage.create({ awesomeField: "AwesomeString" });
|
||||
```
|
||||
|
||||
* **Message.fromObject**(object: `Object`): `Message`<br />
|
||||
converts any non-valid **plain JavaScript object** to a **message instance** using the conversion steps outlined within the table above.
|
||||
|
||||
```js
|
||||
var message = AwesomeMessage.fromObject({ awesomeField: 42 });
|
||||
// converts awesomeField to a string
|
||||
```
|
||||
|
||||
* **Message.toObject**(message: `Message` [, options: `ConversionOptions`]): `Object`<br />
|
||||
converts a **message instance** to an arbitrary **plain JavaScript object** for interoperability with other libraries or storage. The resulting plain JavaScript object *might* still satisfy the requirements of a valid message depending on the actual conversion options specified, but most of the time it does not.
|
||||
|
||||
```js
|
||||
var object = AwesomeMessage.toObject(message, {
|
||||
enums: String, // enums as string names
|
||||
longs: String, // longs as strings (requires long.js)
|
||||
bytes: String, // bytes as base64 encoded strings
|
||||
defaults: true, // includes default values
|
||||
arrays: true, // populates empty arrays (repeated fields) even if defaults=false
|
||||
objects: true, // populates empty objects (map fields) even if defaults=false
|
||||
oneofs: true // includes virtual oneof fields set to the present field's name
|
||||
});
|
||||
```
|
||||
|
||||
For reference, the following diagram aims to display relationships between the different methods and the concept of a valid message:
|
||||
|
||||
<p align="center"><img alt="Toolset Diagram" src="http://dcode.io/protobuf.js/toolset.svg" /></p>
|
||||
|
||||
> In other words: `verify` indicates that calling `create` or `encode` directly on the plain object will [result in a valid message respectively] succeed. `fromObject`, on the other hand, does conversion from a broader range of plain objects to create valid messages. ([ref](https://github.com/dcodeIO/protobuf.js/issues/748#issuecomment-291925749))
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
### Using .proto files
|
||||
|
||||
It is possible to load existing .proto files using the full library, which parses and compiles the definitions to ready to use (reflection-based) message classes:
|
||||
|
||||
```protobuf
|
||||
// awesome.proto
|
||||
package awesomepackage;
|
||||
syntax = "proto3";
|
||||
|
||||
message AwesomeMessage {
|
||||
string awesome_field = 1; // becomes awesomeField
|
||||
}
|
||||
```
|
||||
|
||||
```js
|
||||
protobuf.load("awesome.proto", function(err, root) {
|
||||
if (err)
|
||||
throw err;
|
||||
|
||||
// Obtain a message type
|
||||
var AwesomeMessage = root.lookupType("awesomepackage.AwesomeMessage");
|
||||
|
||||
// Exemplary payload
|
||||
var payload = { awesomeField: "AwesomeString" };
|
||||
|
||||
// Verify the payload if necessary (i.e. when possibly incomplete or invalid)
|
||||
var errMsg = AwesomeMessage.verify(payload);
|
||||
if (errMsg)
|
||||
throw Error(errMsg);
|
||||
|
||||
// Create a new message
|
||||
var message = AwesomeMessage.create(payload); // or use .fromObject if conversion is necessary
|
||||
|
||||
// Encode a message to an Uint8Array (browser) or Buffer (node)
|
||||
var buffer = AwesomeMessage.encode(message).finish();
|
||||
// ... do something with buffer
|
||||
|
||||
// Decode an Uint8Array (browser) or Buffer (node) to a message
|
||||
var message = AwesomeMessage.decode(buffer);
|
||||
// ... do something with message
|
||||
|
||||
// If the application uses length-delimited buffers, there is also encodeDelimited and decodeDelimited.
|
||||
|
||||
// Maybe convert the message back to a plain object
|
||||
var object = AwesomeMessage.toObject(message, {
|
||||
longs: String,
|
||||
enums: String,
|
||||
bytes: String,
|
||||
// see ConversionOptions
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
Additionally, promise syntax can be used by omitting the callback, if preferred:
|
||||
|
||||
```js
|
||||
protobuf.load("awesome.proto")
|
||||
.then(function(root) {
|
||||
...
|
||||
});
|
||||
```
|
||||
|
||||
### Using JSON descriptors
|
||||
|
||||
The library utilizes JSON descriptors that are equivalent to a .proto definition. For example, the following is identical to the .proto definition seen above:
|
||||
|
||||
```json
|
||||
// awesome.json
|
||||
{
|
||||
"nested": {
|
||||
"AwesomeMessage": {
|
||||
"fields": {
|
||||
"awesomeField": {
|
||||
"type": "string",
|
||||
"id": 1
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
JSON descriptors closely resemble the internal reflection structure:
|
||||
|
||||
| Type (T) | Extends | Type-specific properties
|
||||
|--------------------|--------------------|-------------------------
|
||||
| *ReflectionObject* | | options
|
||||
| *Namespace* | *ReflectionObject* | nested
|
||||
| Root | *Namespace* | **nested**
|
||||
| Type | *Namespace* | **fields**
|
||||
| Enum | *ReflectionObject* | **values**
|
||||
| Field | *ReflectionObject* | rule, **type**, **id**
|
||||
| MapField | Field | **keyType**
|
||||
| OneOf | *ReflectionObject* | **oneof** (array of field names)
|
||||
| Service | *Namespace* | **methods**
|
||||
| Method | *ReflectionObject* | type, **requestType**, **responseType**, requestStream, responseStream
|
||||
|
||||
* **Bold properties** are required. *Italic types* are abstract.
|
||||
* `T.fromJSON(name, json)` creates the respective reflection object from a JSON descriptor
|
||||
* `T#toJSON()` creates a JSON descriptor from the respective reflection object (its name is used as the key within the parent)
|
||||
|
||||
Exclusively using JSON descriptors instead of .proto files enables the use of just the light library (the parser isn't required in this case).
|
||||
|
||||
A JSON descriptor can either be loaded the usual way:
|
||||
|
||||
```js
|
||||
protobuf.load("awesome.json", function(err, root) {
|
||||
if (err) throw err;
|
||||
|
||||
// Continue at "Obtain a message type" above
|
||||
});
|
||||
```
|
||||
|
||||
Or it can be loaded inline:
|
||||
|
||||
```js
|
||||
var jsonDescriptor = require("./awesome.json"); // exemplary for node
|
||||
|
||||
var root = protobuf.Root.fromJSON(jsonDescriptor);
|
||||
|
||||
// Continue at "Obtain a message type" above
|
||||
```
|
||||
|
||||
### Using reflection only
|
||||
|
||||
Both the full and the light library include full reflection support. One could, for example, define the .proto definitions seen in the examples above using just reflection:
|
||||
|
||||
```js
|
||||
...
|
||||
var Root = protobuf.Root,
|
||||
Type = protobuf.Type,
|
||||
Field = protobuf.Field;
|
||||
|
||||
var AwesomeMessage = new Type("AwesomeMessage").add(new Field("awesomeField", 1, "string"));
|
||||
|
||||
var root = new Root().define("awesomepackage").add(AwesomeMessage);
|
||||
|
||||
// Continue at "Create a new message" above
|
||||
...
|
||||
```
|
||||
|
||||
Detailed information on the reflection structure is available within the [API documentation](#additional-documentation).
|
||||
|
||||
### Using custom classes
|
||||
|
||||
Message classes can also be extended with custom functionality and it is also possible to register a custom constructor with a reflected message type:
|
||||
|
||||
```js
|
||||
...
|
||||
|
||||
// Define a custom constructor
|
||||
function AwesomeMessage(properties) {
|
||||
// custom initialization code
|
||||
...
|
||||
}
|
||||
|
||||
// Register the custom constructor with its reflected type (*)
|
||||
root.lookupType("awesomepackage.AwesomeMessage").ctor = AwesomeMessage;
|
||||
|
||||
// Define custom functionality
|
||||
AwesomeMessage.customStaticMethod = function() { ... };
|
||||
AwesomeMessage.prototype.customInstanceMethod = function() { ... };
|
||||
|
||||
// Continue at "Create a new message" above
|
||||
```
|
||||
|
||||
(*) Besides referencing its reflected type through `AwesomeMessage.$type` and `AwesomeMesage#$type`, the respective custom class is automatically populated with:
|
||||
|
||||
* `AwesomeMessage.create`
|
||||
* `AwesomeMessage.encode` and `AwesomeMessage.encodeDelimited`
|
||||
* `AwesomeMessage.decode` and `AwesomeMessage.decodeDelimited`
|
||||
* `AwesomeMessage.verify`
|
||||
* `AwesomeMessage.fromObject`, `AwesomeMessage.toObject`, `AwesomeMessage#toObject` and `AwesomeMessage#toJSON`
|
||||
|
||||
Afterwards, decoded messages of this type are `instanceof AwesomeMessage`.
|
||||
|
||||
Alternatively, it is also possible to reuse and extend the internal constructor if custom initialization code is not required:
|
||||
|
||||
```js
|
||||
...
|
||||
|
||||
// Reuse the internal constructor
|
||||
var AwesomeMessage = root.lookupType("awesomepackage.AwesomeMessage").ctor;
|
||||
|
||||
// Define custom functionality
|
||||
AwesomeMessage.customStaticMethod = function() { ... };
|
||||
AwesomeMessage.prototype.customInstanceMethod = function() { ... };
|
||||
|
||||
// Continue at "Create a new message" above
|
||||
```
|
||||
|
||||
### Using services
|
||||
|
||||
The library also supports consuming services but it doesn't make any assumptions about the actual transport channel. Instead, a user must provide a suitable RPC implementation, which is an asynchronous function that takes the reflected service method, the binary request and a node-style callback as its parameters:
|
||||
|
||||
```js
|
||||
function rpcImpl(method, requestData, callback) {
|
||||
// perform the request using an HTTP request or a WebSocket for example
|
||||
var responseData = ...;
|
||||
// and call the callback with the binary response afterwards:
|
||||
callback(null, responseData);
|
||||
}
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
```protobuf
|
||||
// greeter.proto
|
||||
syntax = "proto3";
|
||||
|
||||
service Greeter {
|
||||
rpc SayHello (HelloRequest) returns (HelloReply) {}
|
||||
}
|
||||
|
||||
message HelloRequest {
|
||||
string name = 1;
|
||||
}
|
||||
|
||||
message HelloReply {
|
||||
string message = 1;
|
||||
}
|
||||
```
|
||||
|
||||
```js
|
||||
...
|
||||
var Greeter = root.lookup("Greeter");
|
||||
var greeter = Greeter.create(/* see above */ rpcImpl, /* request delimited? */ false, /* response delimited? */ false);
|
||||
|
||||
greeter.sayHello({ name: 'you' }, function(err, response) {
|
||||
console.log('Greeting:', response.message);
|
||||
});
|
||||
```
|
||||
|
||||
Services also support promises:
|
||||
|
||||
```js
|
||||
greeter.sayHello({ name: 'you' })
|
||||
.then(function(response) {
|
||||
console.log('Greeting:', response.message);
|
||||
});
|
||||
```
|
||||
|
||||
There is also an [example for streaming RPC](https://github.com/dcodeIO/protobuf.js/blob/master/examples/streaming-rpc.js).
|
||||
|
||||
Note that the service API is meant for clients. Implementing a server-side endpoint pretty much always requires transport channel (i.e. http, websocket, etc.) specific code with the only common denominator being that it decodes and encodes messages.
|
||||
|
||||
### Usage with TypeScript
|
||||
|
||||
The library ships with its own [type definitions](https://github.com/dcodeIO/protobuf.js/blob/master/index.d.ts) and modern editors like [Visual Studio Code](https://code.visualstudio.com/) will automatically detect and use them for code completion.
|
||||
|
||||
The npm package depends on [@types/node](https://www.npmjs.com/package/@types/node) because of `Buffer` and [@types/long](https://www.npmjs.com/package/@types/long) because of `Long`. If you are not building for node and/or not using long.js, it should be safe to exclude them manually.
|
||||
|
||||
#### Using the JS API
|
||||
|
||||
The API shown above works pretty much the same with TypeScript. However, because everything is typed, accessing fields on instances of dynamically generated message classes requires either using bracket-notation (i.e. `message["awesomeField"]`) or explicit casts. Alternatively, it is possible to use a [typings file generated for its static counterpart](#pbts-for-typescript).
|
||||
|
||||
```ts
|
||||
import { load } from "protobufjs"; // respectively "./node_modules/protobufjs"
|
||||
|
||||
load("awesome.proto", function(err, root) {
|
||||
if (err)
|
||||
throw err;
|
||||
|
||||
// example code
|
||||
const AwesomeMessage = root.lookupType("awesomepackage.AwesomeMessage");
|
||||
|
||||
let message = AwesomeMessage.create({ awesomeField: "hello" });
|
||||
console.log(`message = ${JSON.stringify(message)}`);
|
||||
|
||||
let buffer = AwesomeMessage.encode(message).finish();
|
||||
console.log(`buffer = ${Array.prototype.toString.call(buffer)}`);
|
||||
|
||||
let decoded = AwesomeMessage.decode(buffer);
|
||||
console.log(`decoded = ${JSON.stringify(decoded)}`);
|
||||
});
|
||||
```
|
||||
|
||||
#### Using generated static code
|
||||
|
||||
If you generated static code to `bundle.js` using the CLI and its type definitions to `bundle.d.ts`, then you can just do:
|
||||
|
||||
```ts
|
||||
import { AwesomeMessage } from "./bundle.js";
|
||||
|
||||
// example code
|
||||
let message = AwesomeMessage.create({ awesomeField: "hello" });
|
||||
let buffer = AwesomeMessage.encode(message).finish();
|
||||
let decoded = AwesomeMessage.decode(buffer);
|
||||
```
|
||||
|
||||
#### Using decorators
|
||||
|
||||
The library also includes an early implementation of [decorators](https://www.typescriptlang.org/docs/handbook/decorators.html).
|
||||
|
||||
**Note** that decorators are an experimental feature in TypeScript and that declaration order is important depending on the JS target. For example, `@Field.d(2, AwesomeArrayMessage)` requires that `AwesomeArrayMessage` has been defined earlier when targeting `ES5`.
|
||||
|
||||
```ts
|
||||
import { Message, Type, Field, OneOf } from "protobufjs/light"; // respectively "./node_modules/protobufjs/light.js"
|
||||
|
||||
export class AwesomeSubMessage extends Message<AwesomeSubMessage> {
|
||||
|
||||
@Field.d(1, "string")
|
||||
public awesomeString: string;
|
||||
|
||||
}
|
||||
|
||||
export enum AwesomeEnum {
|
||||
ONE = 1,
|
||||
TWO = 2
|
||||
}
|
||||
|
||||
@Type.d("SuperAwesomeMessage")
|
||||
export class AwesomeMessage extends Message<AwesomeMessage> {
|
||||
|
||||
@Field.d(1, "string", "optional", "awesome default string")
|
||||
public awesomeField: string;
|
||||
|
||||
@Field.d(2, AwesomeSubMessage)
|
||||
public awesomeSubMessage: AwesomeSubMessage;
|
||||
|
||||
@Field.d(3, AwesomeEnum, "optional", AwesomeEnum.ONE)
|
||||
public awesomeEnum: AwesomeEnum;
|
||||
|
||||
@OneOf.d("awesomeSubMessage", "awesomeEnum")
|
||||
public which: string;
|
||||
|
||||
}
|
||||
|
||||
// example code
|
||||
let message = new AwesomeMessage({ awesomeField: "hello" });
|
||||
let buffer = AwesomeMessage.encode(message).finish();
|
||||
let decoded = AwesomeMessage.decode(buffer);
|
||||
```
|
||||
|
||||
Supported decorators are:
|
||||
|
||||
* **Type.d(typeName?: `string`)** *(optional)*<br />
|
||||
annotates a class as a protobuf message type. If `typeName` is not specified, the constructor's runtime function name is used for the reflected type.
|
||||
|
||||
* **Field.d<T>(fieldId: `number`, fieldType: `string | Constructor<T>`, fieldRule?: `"optional" | "required" | "repeated"`, defaultValue?: `T`)**<br />
|
||||
annotates a property as a protobuf field with the specified id and protobuf type.
|
||||
|
||||
* **MapField.d<T extends { [key: string]: any }>(fieldId: `number`, fieldKeyType: `string`, fieldValueType. `string | Constructor<{}>`)**<br />
|
||||
annotates a property as a protobuf map field with the specified id, protobuf key and value type.
|
||||
|
||||
* **OneOf.d<T extends string>(...fieldNames: `string[]`)**<br />
|
||||
annotates a property as a protobuf oneof covering the specified fields.
|
||||
|
||||
Other notes:
|
||||
|
||||
* Decorated types reside in `protobuf.roots["decorated"]` using a flat structure, so no duplicate names.
|
||||
* Enums are copied to a reflected enum with a generic name on decorator evaluation because referenced enum objects have no runtime name the decorator could use.
|
||||
* Default values must be specified as arguments to the decorator instead of using a property initializer for proper prototype behavior.
|
||||
* Property names on decorated classes must not be renamed on compile time (i.e. by a minifier) because decorators just receive the original field name as a string.
|
||||
|
||||
**ProTip!** Not as pretty, but you can [use decorators in plain JavaScript](https://github.com/dcodeIO/protobuf.js/blob/master/examples/js-decorators.js) as well.
|
||||
|
||||
Command line
|
||||
------------
|
||||
|
||||
**Note** that moving the CLI to [its own package](./cli) is a work in progress. At the moment, it's still part of the main package.
|
||||
|
||||
The command line interface (CLI) can be used to translate between file formats and to generate static code as well as TypeScript definitions.
|
||||
|
||||
### pbjs for JavaScript
|
||||
|
||||
```
|
||||
Translates between file formats and generates static code.
|
||||
|
||||
-t, --target Specifies the target format. Also accepts a path to require a custom target.
|
||||
|
||||
json JSON representation
|
||||
json-module JSON representation as a module
|
||||
proto2 Protocol Buffers, Version 2
|
||||
proto3 Protocol Buffers, Version 3
|
||||
static Static code without reflection (non-functional on its own)
|
||||
static-module Static code without reflection as a module
|
||||
|
||||
-p, --path Adds a directory to the include path.
|
||||
|
||||
-o, --out Saves to a file instead of writing to stdout.
|
||||
|
||||
--sparse Exports only those types referenced from a main file (experimental).
|
||||
|
||||
Module targets only:
|
||||
|
||||
-w, --wrap Specifies the wrapper to use. Also accepts a path to require a custom wrapper.
|
||||
|
||||
default Default wrapper supporting both CommonJS and AMD
|
||||
commonjs CommonJS wrapper
|
||||
amd AMD wrapper
|
||||
es6 ES6 wrapper (implies --es6)
|
||||
closure A closure adding to protobuf.roots where protobuf is a global
|
||||
|
||||
-r, --root Specifies an alternative protobuf.roots name.
|
||||
|
||||
-l, --lint Linter configuration. Defaults to protobuf.js-compatible rules:
|
||||
|
||||
eslint-disable block-scoped-var, no-redeclare, no-control-regex, no-prototype-builtins
|
||||
|
||||
--es6 Enables ES6 syntax (const/let instead of var)
|
||||
|
||||
Proto sources only:
|
||||
|
||||
--keep-case Keeps field casing instead of converting to camel case.
|
||||
|
||||
Static targets only:
|
||||
|
||||
--no-create Does not generate create functions used for reflection compatibility.
|
||||
--no-encode Does not generate encode functions.
|
||||
--no-decode Does not generate decode functions.
|
||||
--no-verify Does not generate verify functions.
|
||||
--no-convert Does not generate convert functions like from/toObject
|
||||
--no-delimited Does not generate delimited encode/decode functions.
|
||||
--no-beautify Does not beautify generated code.
|
||||
--no-comments Does not output any JSDoc comments.
|
||||
|
||||
--force-long Enfores the use of 'Long' for s-/u-/int64 and s-/fixed64 fields.
|
||||
--force-message Enfores the use of message instances instead of plain objects.
|
||||
|
||||
usage: pbjs [options] file1.proto file2.json ... (or pipe) other | pbjs [options] -
|
||||
```
|
||||
|
||||
For production environments it is recommended to bundle all your .proto files to a single .json file, which minimizes the number of network requests and avoids any parser overhead (hint: works with just the **light** library):
|
||||
|
||||
```
|
||||
$> pbjs -t json file1.proto file2.proto > bundle.json
|
||||
```
|
||||
|
||||
Now, either include this file in your final bundle:
|
||||
|
||||
```js
|
||||
var root = protobuf.Root.fromJSON(require("./bundle.json"));
|
||||
```
|
||||
|
||||
or load it the usual way:
|
||||
|
||||
```js
|
||||
protobuf.load("bundle.json", function(err, root) {
|
||||
...
|
||||
});
|
||||
```
|
||||
|
||||
Generated static code, on the other hand, works with just the **minimal** library. For example
|
||||
|
||||
```
|
||||
$> pbjs -t static-module -w commonjs -o compiled.js file1.proto file2.proto
|
||||
```
|
||||
|
||||
will generate static code for definitions within `file1.proto` and `file2.proto` to a CommonJS module `compiled.js`.
|
||||
|
||||
**ProTip!** Documenting your .proto files with `/** ... */`-blocks or (trailing) `/// ...` lines translates to generated static code.
|
||||
|
||||
|
||||
### pbts for TypeScript
|
||||
|
||||
```
|
||||
Generates TypeScript definitions from annotated JavaScript files.
|
||||
|
||||
-o, --out Saves to a file instead of writing to stdout.
|
||||
|
||||
-g, --global Name of the global object in browser environments, if any.
|
||||
|
||||
--no-comments Does not output any JSDoc comments.
|
||||
|
||||
Internal flags:
|
||||
|
||||
-n, --name Wraps everything in a module of the specified name.
|
||||
|
||||
-m, --main Whether building the main library without any imports.
|
||||
|
||||
usage: pbts [options] file1.js file2.js ... (or) other | pbts [options] -
|
||||
```
|
||||
|
||||
Picking up on the example above, the following not only generates static code to a CommonJS module `compiled.js` but also its respective TypeScript definitions to `compiled.d.ts`:
|
||||
|
||||
```
|
||||
$> pbjs -t static-module -w commonjs -o compiled.js file1.proto file2.proto
|
||||
$> pbts -o compiled.d.ts compiled.js
|
||||
```
|
||||
|
||||
Additionally, TypeScript definitions of static modules are compatible with their reflection-based counterparts (i.e. as exported by JSON modules), as long as the following conditions are met:
|
||||
|
||||
1. Instead of using `new SomeMessage(...)`, always use `SomeMessage.create(...)` because reflection objects do not provide a constructor.
|
||||
2. Types, services and enums must start with an uppercase letter to become available as properties of the reflected types as well (i.e. to be able to use `MyMessage.MyEnum` instead of `root.lookup("MyMessage.MyEnum")`).
|
||||
|
||||
For example, the following generates a JSON module `bundle.js` and a `bundle.d.ts`, but no static code:
|
||||
|
||||
```
|
||||
$> pbjs -t json-module -w commonjs -o bundle.js file1.proto file2.proto
|
||||
$> pbjs -t static-module file1.proto file2.proto | pbts -o bundle.d.ts -
|
||||
```
|
||||
|
||||
### Reflection vs. static code
|
||||
|
||||
While using .proto files directly requires the full library respectively pure reflection/JSON the light library, pretty much all code but the relatively short descriptors is shared.
|
||||
|
||||
Static code, on the other hand, requires just the minimal library, but generates additional source code without any reflection features. This also implies that there is a break-even point where statically generated code becomes larger than descriptor-based code once the amount of code generated exceeds the size of the full respectively light library.
|
||||
|
||||
There is no significant difference performance-wise as the code generated statically is pretty much the same as generated at runtime and both are largely interchangeable as seen in the previous section.
|
||||
|
||||
| Source | Library | Advantages | Tradeoffs
|
||||
|--------|---------|------------|-----------
|
||||
| .proto | full | Easily editable<br />Interoperability with other libraries<br />No compile step | Some parsing and possibly network overhead
|
||||
| JSON | light | Easily editable<br />No parsing overhead<br />Single bundle (no network overhead) | protobuf.js specific<br />Has a compile step
|
||||
| static | minimal | Works where `eval` access is restricted<br />Fully documented<br />Small footprint for small protos | Can be hard to edit<br />No reflection<br />Has a compile step
|
||||
|
||||
### Command line API
|
||||
|
||||
Both utilities can be used programmatically by providing command line arguments and a callback to their respective `main` functions:
|
||||
|
||||
```js
|
||||
var pbjs = require("protobufjs/cli/pbjs"); // or require("protobufjs/cli").pbjs / .pbts
|
||||
|
||||
pbjs.main([ "--target", "json-module", "path/to/myproto.proto" ], function(err, output) {
|
||||
if (err)
|
||||
throw err;
|
||||
// do something with output
|
||||
});
|
||||
```
|
||||
|
||||
Additional documentation
|
||||
------------------------
|
||||
|
||||
#### Protocol Buffers
|
||||
* [Google's Developer Guide](https://developers.google.com/protocol-buffers/docs/overview)
|
||||
|
||||
#### protobuf.js
|
||||
* [API Documentation](http://dcode.io/protobuf.js)
|
||||
* [CHANGELOG](https://github.com/dcodeIO/protobuf.js/blob/master/CHANGELOG.md)
|
||||
* [Frequently asked questions](https://github.com/dcodeIO/protobuf.js/wiki) on our wiki
|
||||
|
||||
#### Community
|
||||
* [Questions and answers](http://stackoverflow.com/search?tab=newest&q=protobuf.js) on StackOverflow
|
||||
|
||||
Performance
|
||||
-----------
|
||||
The package includes a benchmark that compares protobuf.js performance to native JSON (as far as this is possible) and [Google's JS implementation](https://github.com/google/protobuf/tree/master/js). On an i7-2600K running node 6.9.1 it yields:
|
||||
|
||||
```
|
||||
benchmarking encoding performance ...
|
||||
|
||||
protobuf.js (reflect) x 541,707 ops/sec ±1.13% (87 runs sampled)
|
||||
protobuf.js (static) x 548,134 ops/sec ±1.38% (89 runs sampled)
|
||||
JSON (string) x 318,076 ops/sec ±0.63% (93 runs sampled)
|
||||
JSON (buffer) x 179,165 ops/sec ±2.26% (91 runs sampled)
|
||||
google-protobuf x 74,406 ops/sec ±0.85% (86 runs sampled)
|
||||
|
||||
protobuf.js (static) was fastest
|
||||
protobuf.js (reflect) was 0.9% ops/sec slower (factor 1.0)
|
||||
JSON (string) was 41.5% ops/sec slower (factor 1.7)
|
||||
JSON (buffer) was 67.6% ops/sec slower (factor 3.1)
|
||||
google-protobuf was 86.4% ops/sec slower (factor 7.3)
|
||||
|
||||
benchmarking decoding performance ...
|
||||
|
||||
protobuf.js (reflect) x 1,383,981 ops/sec ±0.88% (93 runs sampled)
|
||||
protobuf.js (static) x 1,378,925 ops/sec ±0.81% (93 runs sampled)
|
||||
JSON (string) x 302,444 ops/sec ±0.81% (93 runs sampled)
|
||||
JSON (buffer) x 264,882 ops/sec ±0.81% (93 runs sampled)
|
||||
google-protobuf x 179,180 ops/sec ±0.64% (94 runs sampled)
|
||||
|
||||
protobuf.js (reflect) was fastest
|
||||
protobuf.js (static) was 0.3% ops/sec slower (factor 1.0)
|
||||
JSON (string) was 78.1% ops/sec slower (factor 4.6)
|
||||
JSON (buffer) was 80.8% ops/sec slower (factor 5.2)
|
||||
google-protobuf was 87.0% ops/sec slower (factor 7.7)
|
||||
|
||||
benchmarking combined performance ...
|
||||
|
||||
protobuf.js (reflect) x 275,900 ops/sec ±0.78% (90 runs sampled)
|
||||
protobuf.js (static) x 290,096 ops/sec ±0.96% (90 runs sampled)
|
||||
JSON (string) x 129,381 ops/sec ±0.77% (90 runs sampled)
|
||||
JSON (buffer) x 91,051 ops/sec ±0.94% (90 runs sampled)
|
||||
google-protobuf x 42,050 ops/sec ±0.85% (91 runs sampled)
|
||||
|
||||
protobuf.js (static) was fastest
|
||||
protobuf.js (reflect) was 4.7% ops/sec slower (factor 1.0)
|
||||
JSON (string) was 55.3% ops/sec slower (factor 2.2)
|
||||
JSON (buffer) was 68.6% ops/sec slower (factor 3.2)
|
||||
google-protobuf was 85.5% ops/sec slower (factor 6.9)
|
||||
```
|
||||
|
||||
These results are achieved by
|
||||
|
||||
* generating type-specific encoders, decoders, verifiers and converters at runtime
|
||||
* configuring the reader/writer interface according to the environment
|
||||
* using node-specific functionality where beneficial and, of course
|
||||
* avoiding unnecessary operations through splitting up [the toolset](#toolset).
|
||||
|
||||
You can also run [the benchmark](https://github.com/dcodeIO/protobuf.js/blob/master/bench/index.js) ...
|
||||
|
||||
```
|
||||
$> npm run bench
|
||||
```
|
||||
|
||||
and [the profiler](https://github.com/dcodeIO/protobuf.js/blob/master/bench/prof.js) yourself (the latter requires a recent version of node):
|
||||
|
||||
```
|
||||
$> npm run prof <encode|decode|encode-browser|decode-browser> [iterations=10000000]
|
||||
```
|
||||
|
||||
Note that as of this writing, the benchmark suite performs significantly slower on node 7.2.0 compared to 6.9.1 because moths.
|
||||
|
||||
Compatibility
|
||||
-------------
|
||||
|
||||
* Works in all modern and not-so-modern browsers except IE8.
|
||||
* Because the internals of this package do not rely on `google/protobuf/descriptor.proto`, options are parsed and presented literally.
|
||||
* If typed arrays are not supported by the environment, plain arrays will be used instead.
|
||||
* Support for pre-ES5 environments (except IE8) can be achieved by [using a polyfill](https://github.com/dcodeIO/protobuf.js/blob/master/scripts/polyfill.js).
|
||||
* Support for [Content Security Policy](https://w3c.github.io/webappsec-csp/)-restricted environments (like Chrome extensions without [unsafe-eval](https://developer.chrome.com/extensions/contentSecurityPolicy#relaxing-eval)) can be achieved by generating and using static code instead.
|
||||
* If a proper way to work with 64 bit values (uint64, int64 etc.) is required, just install [long.js](https://github.com/dcodeIO/long.js) alongside this library. All 64 bit numbers will then be returned as a `Long` instance instead of a possibly unsafe JavaScript number ([see](https://github.com/dcodeIO/long.js)).
|
||||
* For descriptor.proto interoperability, see [ext/descriptor](https://github.com/dcodeIO/protobuf.js/tree/master/ext/descriptor)
|
||||
|
||||
Building
|
||||
--------
|
||||
|
||||
To build the library or its components yourself, clone it from GitHub and install the development dependencies:
|
||||
|
||||
```
|
||||
$> git clone https://github.com/dcodeIO/protobuf.js.git
|
||||
$> cd protobuf.js
|
||||
$> npm install
|
||||
```
|
||||
|
||||
Building the respective development and production versions with their respective source maps to `dist/`:
|
||||
|
||||
```
|
||||
$> npm run build
|
||||
```
|
||||
|
||||
Building the documentation to `docs/`:
|
||||
|
||||
```
|
||||
$> npm run docs
|
||||
```
|
||||
|
||||
Building the TypeScript definition to `index.d.ts`:
|
||||
|
||||
```
|
||||
$> npm run types
|
||||
```
|
||||
|
||||
### Browserify integration
|
||||
|
||||
By default, protobuf.js integrates into any browserify build-process without requiring any optional modules. Hence:
|
||||
|
||||
* If int64 support is required, explicitly require the `long` module somewhere in your project as it will be excluded otherwise. This assumes that a global `require` function is present that protobuf.js can call to obtain the long module.
|
||||
|
||||
If there is no global `require` function present after bundling, it's also possible to assign the long module programmatically:
|
||||
|
||||
```js
|
||||
var Long = ...;
|
||||
|
||||
protobuf.util.Long = Long;
|
||||
protobuf.configure();
|
||||
```
|
||||
|
||||
* If you have any special requirements, there is [the bundler](https://github.com/dcodeIO/protobuf.js/blob/master/scripts/bundle.js) for reference.
|
||||
|
||||
**License:** [BSD 3-Clause License](https://opensource.org/licenses/BSD-3-Clause)
|
||||
Executable
+21
@@ -0,0 +1,21 @@
|
||||
{
|
||||
"string" : "Lorem ipsum dolor sit amet.",
|
||||
"uint32" : 9000,
|
||||
"inner" : {
|
||||
"int32" : 20161110,
|
||||
"innerInner" : {
|
||||
"long" : {
|
||||
"low": 1051,
|
||||
"high": 151234,
|
||||
"unsigned": false
|
||||
},
|
||||
"enum" : 1,
|
||||
"sint32": -42
|
||||
},
|
||||
"outer" : {
|
||||
"bool" : [ true, false, false, true, false, false, true ],
|
||||
"double": 204.8
|
||||
}
|
||||
},
|
||||
"float": 0.25
|
||||
}
|
||||
Executable
+40
@@ -0,0 +1,40 @@
|
||||
syntax = "proto3";
|
||||
|
||||
message Test {
|
||||
|
||||
string string = 1;
|
||||
uint32 uint32 = 2;
|
||||
Inner inner = 3;
|
||||
float float = 4; // make sure to set something that's fair to JSON
|
||||
|
||||
message Inner {
|
||||
|
||||
int32 int32 = 1;
|
||||
InnerInner innerInner = 2;
|
||||
Outer outer = 3;
|
||||
|
||||
message InnerInner {
|
||||
|
||||
int64 long = 1;
|
||||
Enum enum = 2;
|
||||
sint32 sint32 = 3;
|
||||
}
|
||||
}
|
||||
|
||||
enum Enum {
|
||||
|
||||
ONE = 0;
|
||||
TWO = 1;
|
||||
THREE = 2;
|
||||
FOUR = 3;
|
||||
FIVE = 4;
|
||||
}
|
||||
}
|
||||
|
||||
message Outer {
|
||||
|
||||
repeated bool bool = 1;
|
||||
double double = 2; // make sure to set something that's fair to JSON
|
||||
}
|
||||
|
||||
// bytes cannot be used
|
||||
+881
@@ -0,0 +1,881 @@
|
||||
/*eslint-disable*/
|
||||
/**
|
||||
* @fileoverview
|
||||
* @enhanceable
|
||||
* @public
|
||||
*/
|
||||
// GENERATED CODE -- DO NOT EDIT!
|
||||
|
||||
var jspb = require('google-protobuf');
|
||||
var goog = jspb;
|
||||
var global = Function('return this')();
|
||||
|
||||
goog.exportSymbol('proto.Outer', null, global);
|
||||
goog.exportSymbol('proto.Test', null, global);
|
||||
goog.exportSymbol('proto.Test.Enum', null, global);
|
||||
goog.exportSymbol('proto.Test.Inner', null, global);
|
||||
goog.exportSymbol('proto.Test.Inner.InnerInner', null, global);
|
||||
|
||||
/**
|
||||
* Generated by JsPbCodeGenerator.
|
||||
* @param {Array=} opt_data Optional initial data array, typically from a
|
||||
* server response, or constructed directly in Javascript. The array is used
|
||||
* in place and becomes part of the constructed object. It is not cloned.
|
||||
* If no data is provided, the constructed object will be empty, but still
|
||||
* valid.
|
||||
* @extends {jspb.Message}
|
||||
* @constructor
|
||||
*/
|
||||
proto.Test = function(opt_data) {
|
||||
jspb.Message.initialize(this, opt_data, 0, -1, null, null);
|
||||
};
|
||||
goog.inherits(proto.Test, jspb.Message);
|
||||
if (goog.DEBUG && !COMPILED) {
|
||||
proto.Test.displayName = 'proto.Test';
|
||||
}
|
||||
|
||||
|
||||
if (jspb.Message.GENERATE_TO_OBJECT) {
|
||||
/**
|
||||
* Creates an object representation of this proto suitable for use in Soy templates.
|
||||
* Field names that are reserved in JavaScript and will be renamed to pb_name.
|
||||
* To access a reserved field use, foo.pb_<name>, eg, foo.pb_default.
|
||||
* For the list of reserved names please see:
|
||||
* com.google.apps.jspb.JsClassTemplate.JS_RESERVED_WORDS.
|
||||
* @param {boolean=} opt_includeInstance Whether to include the JSPB instance
|
||||
* for transitional soy proto support: http://goto/soy-param-migration
|
||||
* @return {!Object}
|
||||
*/
|
||||
proto.Test.prototype.toObject = function(opt_includeInstance) {
|
||||
return proto.Test.toObject(opt_includeInstance, this);
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* Static version of the {@see toObject} method.
|
||||
* @param {boolean|undefined} includeInstance Whether to include the JSPB
|
||||
* instance for transitional soy proto support:
|
||||
* http://goto/soy-param-migration
|
||||
* @param {!proto.Test} msg The msg instance to transform.
|
||||
* @return {!Object}
|
||||
*/
|
||||
proto.Test.toObject = function(includeInstance, msg) {
|
||||
var f, obj = {
|
||||
string: jspb.Message.getFieldWithDefault(msg, 1, ""),
|
||||
uint32: jspb.Message.getFieldWithDefault(msg, 2, 0),
|
||||
inner: (f = msg.getInner()) && proto.Test.Inner.toObject(includeInstance, f),
|
||||
pb_float: +jspb.Message.getFieldWithDefault(msg, 4, 0.0)
|
||||
};
|
||||
|
||||
if (includeInstance) {
|
||||
obj.$jspbMessageInstance = msg;
|
||||
}
|
||||
return obj;
|
||||
};
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Deserializes binary data (in protobuf wire format).
|
||||
* @param {jspb.ByteSource} bytes The bytes to deserialize.
|
||||
* @return {!proto.Test}
|
||||
*/
|
||||
proto.Test.deserializeBinary = function(bytes) {
|
||||
var reader = new jspb.BinaryReader(bytes);
|
||||
var msg = new proto.Test;
|
||||
return proto.Test.deserializeBinaryFromReader(msg, reader);
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* Deserializes binary data (in protobuf wire format) from the
|
||||
* given reader into the given message object.
|
||||
* @param {!proto.Test} msg The message object to deserialize into.
|
||||
* @param {!jspb.BinaryReader} reader The BinaryReader to use.
|
||||
* @return {!proto.Test}
|
||||
*/
|
||||
proto.Test.deserializeBinaryFromReader = function(msg, reader) {
|
||||
while (reader.nextField()) {
|
||||
if (reader.isEndGroup()) {
|
||||
break;
|
||||
}
|
||||
var field = reader.getFieldNumber();
|
||||
switch (field) {
|
||||
case 1:
|
||||
var value = /** @type {string} */ (reader.readString());
|
||||
msg.setString(value);
|
||||
break;
|
||||
case 2:
|
||||
var value = /** @type {number} */ (reader.readUint32());
|
||||
msg.setUint32(value);
|
||||
break;
|
||||
case 3:
|
||||
var value = new proto.Test.Inner;
|
||||
reader.readMessage(value,proto.Test.Inner.deserializeBinaryFromReader);
|
||||
msg.setInner(value);
|
||||
break;
|
||||
case 4:
|
||||
var value = /** @type {number} */ (reader.readFloat());
|
||||
msg.setFloat(value);
|
||||
break;
|
||||
default:
|
||||
reader.skipField();
|
||||
break;
|
||||
}
|
||||
}
|
||||
return msg;
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* Serializes the message to binary data (in protobuf wire format).
|
||||
* @return {!Uint8Array}
|
||||
*/
|
||||
proto.Test.prototype.serializeBinary = function() {
|
||||
var writer = new jspb.BinaryWriter();
|
||||
proto.Test.serializeBinaryToWriter(this, writer);
|
||||
return writer.getResultBuffer();
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* Serializes the given message to binary data (in protobuf wire
|
||||
* format), writing to the given BinaryWriter.
|
||||
* @param {!proto.Test} message
|
||||
* @param {!jspb.BinaryWriter} writer
|
||||
*/
|
||||
proto.Test.serializeBinaryToWriter = function(message, writer) {
|
||||
var f = undefined;
|
||||
f = message.getString();
|
||||
if (f.length > 0) {
|
||||
writer.writeString(
|
||||
1,
|
||||
f
|
||||
);
|
||||
}
|
||||
f = message.getUint32();
|
||||
if (f !== 0) {
|
||||
writer.writeUint32(
|
||||
2,
|
||||
f
|
||||
);
|
||||
}
|
||||
f = message.getInner();
|
||||
if (f != null) {
|
||||
writer.writeMessage(
|
||||
3,
|
||||
f,
|
||||
proto.Test.Inner.serializeBinaryToWriter
|
||||
);
|
||||
}
|
||||
f = message.getFloat();
|
||||
if (f !== 0.0) {
|
||||
writer.writeFloat(
|
||||
4,
|
||||
f
|
||||
);
|
||||
}
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* @enum {number}
|
||||
*/
|
||||
proto.Test.Enum = {
|
||||
ONE: 0,
|
||||
TWO: 1,
|
||||
THREE: 2,
|
||||
FOUR: 3,
|
||||
FIVE: 4
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* Generated by JsPbCodeGenerator.
|
||||
* @param {Array=} opt_data Optional initial data array, typically from a
|
||||
* server response, or constructed directly in Javascript. The array is used
|
||||
* in place and becomes part of the constructed object. It is not cloned.
|
||||
* If no data is provided, the constructed object will be empty, but still
|
||||
* valid.
|
||||
* @extends {jspb.Message}
|
||||
* @constructor
|
||||
*/
|
||||
proto.Test.Inner = function(opt_data) {
|
||||
jspb.Message.initialize(this, opt_data, 0, -1, null, null);
|
||||
};
|
||||
goog.inherits(proto.Test.Inner, jspb.Message);
|
||||
if (goog.DEBUG && !COMPILED) {
|
||||
proto.Test.Inner.displayName = 'proto.Test.Inner';
|
||||
}
|
||||
|
||||
|
||||
if (jspb.Message.GENERATE_TO_OBJECT) {
|
||||
/**
|
||||
* Creates an object representation of this proto suitable for use in Soy templates.
|
||||
* Field names that are reserved in JavaScript and will be renamed to pb_name.
|
||||
* To access a reserved field use, foo.pb_<name>, eg, foo.pb_default.
|
||||
* For the list of reserved names please see:
|
||||
* com.google.apps.jspb.JsClassTemplate.JS_RESERVED_WORDS.
|
||||
* @param {boolean=} opt_includeInstance Whether to include the JSPB instance
|
||||
* for transitional soy proto support: http://goto/soy-param-migration
|
||||
* @return {!Object}
|
||||
*/
|
||||
proto.Test.Inner.prototype.toObject = function(opt_includeInstance) {
|
||||
return proto.Test.Inner.toObject(opt_includeInstance, this);
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* Static version of the {@see toObject} method.
|
||||
* @param {boolean|undefined} includeInstance Whether to include the JSPB
|
||||
* instance for transitional soy proto support:
|
||||
* http://goto/soy-param-migration
|
||||
* @param {!proto.Test.Inner} msg The msg instance to transform.
|
||||
* @return {!Object}
|
||||
*/
|
||||
proto.Test.Inner.toObject = function(includeInstance, msg) {
|
||||
var f, obj = {
|
||||
int32: jspb.Message.getFieldWithDefault(msg, 1, 0),
|
||||
innerinner: (f = msg.getInnerinner()) && proto.Test.Inner.InnerInner.toObject(includeInstance, f),
|
||||
outer: (f = msg.getOuter()) && proto.Outer.toObject(includeInstance, f)
|
||||
};
|
||||
|
||||
if (includeInstance) {
|
||||
obj.$jspbMessageInstance = msg;
|
||||
}
|
||||
return obj;
|
||||
};
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Deserializes binary data (in protobuf wire format).
|
||||
* @param {jspb.ByteSource} bytes The bytes to deserialize.
|
||||
* @return {!proto.Test.Inner}
|
||||
*/
|
||||
proto.Test.Inner.deserializeBinary = function(bytes) {
|
||||
var reader = new jspb.BinaryReader(bytes);
|
||||
var msg = new proto.Test.Inner;
|
||||
return proto.Test.Inner.deserializeBinaryFromReader(msg, reader);
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* Deserializes binary data (in protobuf wire format) from the
|
||||
* given reader into the given message object.
|
||||
* @param {!proto.Test.Inner} msg The message object to deserialize into.
|
||||
* @param {!jspb.BinaryReader} reader The BinaryReader to use.
|
||||
* @return {!proto.Test.Inner}
|
||||
*/
|
||||
proto.Test.Inner.deserializeBinaryFromReader = function(msg, reader) {
|
||||
while (reader.nextField()) {
|
||||
if (reader.isEndGroup()) {
|
||||
break;
|
||||
}
|
||||
var field = reader.getFieldNumber();
|
||||
switch (field) {
|
||||
case 1:
|
||||
var value = /** @type {number} */ (reader.readInt32());
|
||||
msg.setInt32(value);
|
||||
break;
|
||||
case 2:
|
||||
var value = new proto.Test.Inner.InnerInner;
|
||||
reader.readMessage(value,proto.Test.Inner.InnerInner.deserializeBinaryFromReader);
|
||||
msg.setInnerinner(value);
|
||||
break;
|
||||
case 3:
|
||||
var value = new proto.Outer;
|
||||
reader.readMessage(value,proto.Outer.deserializeBinaryFromReader);
|
||||
msg.setOuter(value);
|
||||
break;
|
||||
default:
|
||||
reader.skipField();
|
||||
break;
|
||||
}
|
||||
}
|
||||
return msg;
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* Serializes the message to binary data (in protobuf wire format).
|
||||
* @return {!Uint8Array}
|
||||
*/
|
||||
proto.Test.Inner.prototype.serializeBinary = function() {
|
||||
var writer = new jspb.BinaryWriter();
|
||||
proto.Test.Inner.serializeBinaryToWriter(this, writer);
|
||||
return writer.getResultBuffer();
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* Serializes the given message to binary data (in protobuf wire
|
||||
* format), writing to the given BinaryWriter.
|
||||
* @param {!proto.Test.Inner} message
|
||||
* @param {!jspb.BinaryWriter} writer
|
||||
*/
|
||||
proto.Test.Inner.serializeBinaryToWriter = function(message, writer) {
|
||||
var f = undefined;
|
||||
f = message.getInt32();
|
||||
if (f !== 0) {
|
||||
writer.writeInt32(
|
||||
1,
|
||||
f
|
||||
);
|
||||
}
|
||||
f = message.getInnerinner();
|
||||
if (f != null) {
|
||||
writer.writeMessage(
|
||||
2,
|
||||
f,
|
||||
proto.Test.Inner.InnerInner.serializeBinaryToWriter
|
||||
);
|
||||
}
|
||||
f = message.getOuter();
|
||||
if (f != null) {
|
||||
writer.writeMessage(
|
||||
3,
|
||||
f,
|
||||
proto.Outer.serializeBinaryToWriter
|
||||
);
|
||||
}
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Generated by JsPbCodeGenerator.
|
||||
* @param {Array=} opt_data Optional initial data array, typically from a
|
||||
* server response, or constructed directly in Javascript. The array is used
|
||||
* in place and becomes part of the constructed object. It is not cloned.
|
||||
* If no data is provided, the constructed object will be empty, but still
|
||||
* valid.
|
||||
* @extends {jspb.Message}
|
||||
* @constructor
|
||||
*/
|
||||
proto.Test.Inner.InnerInner = function(opt_data) {
|
||||
jspb.Message.initialize(this, opt_data, 0, -1, null, null);
|
||||
};
|
||||
goog.inherits(proto.Test.Inner.InnerInner, jspb.Message);
|
||||
if (goog.DEBUG && !COMPILED) {
|
||||
proto.Test.Inner.InnerInner.displayName = 'proto.Test.Inner.InnerInner';
|
||||
}
|
||||
|
||||
|
||||
if (jspb.Message.GENERATE_TO_OBJECT) {
|
||||
/**
|
||||
* Creates an object representation of this proto suitable for use in Soy templates.
|
||||
* Field names that are reserved in JavaScript and will be renamed to pb_name.
|
||||
* To access a reserved field use, foo.pb_<name>, eg, foo.pb_default.
|
||||
* For the list of reserved names please see:
|
||||
* com.google.apps.jspb.JsClassTemplate.JS_RESERVED_WORDS.
|
||||
* @param {boolean=} opt_includeInstance Whether to include the JSPB instance
|
||||
* for transitional soy proto support: http://goto/soy-param-migration
|
||||
* @return {!Object}
|
||||
*/
|
||||
proto.Test.Inner.InnerInner.prototype.toObject = function(opt_includeInstance) {
|
||||
return proto.Test.Inner.InnerInner.toObject(opt_includeInstance, this);
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* Static version of the {@see toObject} method.
|
||||
* @param {boolean|undefined} includeInstance Whether to include the JSPB
|
||||
* instance for transitional soy proto support:
|
||||
* http://goto/soy-param-migration
|
||||
* @param {!proto.Test.Inner.InnerInner} msg The msg instance to transform.
|
||||
* @return {!Object}
|
||||
*/
|
||||
proto.Test.Inner.InnerInner.toObject = function(includeInstance, msg) {
|
||||
var f, obj = {
|
||||
pb_long: jspb.Message.getFieldWithDefault(msg, 1, 0),
|
||||
pb_enum: jspb.Message.getFieldWithDefault(msg, 2, 0),
|
||||
sint32: jspb.Message.getFieldWithDefault(msg, 3, 0)
|
||||
};
|
||||
|
||||
if (includeInstance) {
|
||||
obj.$jspbMessageInstance = msg;
|
||||
}
|
||||
return obj;
|
||||
};
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Deserializes binary data (in protobuf wire format).
|
||||
* @param {jspb.ByteSource} bytes The bytes to deserialize.
|
||||
* @return {!proto.Test.Inner.InnerInner}
|
||||
*/
|
||||
proto.Test.Inner.InnerInner.deserializeBinary = function(bytes) {
|
||||
var reader = new jspb.BinaryReader(bytes);
|
||||
var msg = new proto.Test.Inner.InnerInner;
|
||||
return proto.Test.Inner.InnerInner.deserializeBinaryFromReader(msg, reader);
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* Deserializes binary data (in protobuf wire format) from the
|
||||
* given reader into the given message object.
|
||||
* @param {!proto.Test.Inner.InnerInner} msg The message object to deserialize into.
|
||||
* @param {!jspb.BinaryReader} reader The BinaryReader to use.
|
||||
* @return {!proto.Test.Inner.InnerInner}
|
||||
*/
|
||||
proto.Test.Inner.InnerInner.deserializeBinaryFromReader = function(msg, reader) {
|
||||
while (reader.nextField()) {
|
||||
if (reader.isEndGroup()) {
|
||||
break;
|
||||
}
|
||||
var field = reader.getFieldNumber();
|
||||
switch (field) {
|
||||
case 1:
|
||||
var value = /** @type {number} */ (reader.readInt64());
|
||||
msg.setLong(value);
|
||||
break;
|
||||
case 2:
|
||||
var value = /** @type {!proto.Test.Enum} */ (reader.readEnum());
|
||||
msg.setEnum(value);
|
||||
break;
|
||||
case 3:
|
||||
var value = /** @type {number} */ (reader.readSint32());
|
||||
msg.setSint32(value);
|
||||
break;
|
||||
default:
|
||||
reader.skipField();
|
||||
break;
|
||||
}
|
||||
}
|
||||
return msg;
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* Serializes the message to binary data (in protobuf wire format).
|
||||
* @return {!Uint8Array}
|
||||
*/
|
||||
proto.Test.Inner.InnerInner.prototype.serializeBinary = function() {
|
||||
var writer = new jspb.BinaryWriter();
|
||||
proto.Test.Inner.InnerInner.serializeBinaryToWriter(this, writer);
|
||||
return writer.getResultBuffer();
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* Serializes the given message to binary data (in protobuf wire
|
||||
* format), writing to the given BinaryWriter.
|
||||
* @param {!proto.Test.Inner.InnerInner} message
|
||||
* @param {!jspb.BinaryWriter} writer
|
||||
*/
|
||||
proto.Test.Inner.InnerInner.serializeBinaryToWriter = function(message, writer) {
|
||||
var f = undefined;
|
||||
f = message.getLong();
|
||||
if (f !== 0) {
|
||||
writer.writeInt64(
|
||||
1,
|
||||
f
|
||||
);
|
||||
}
|
||||
f = message.getEnum();
|
||||
if (f !== 0.0) {
|
||||
writer.writeEnum(
|
||||
2,
|
||||
f
|
||||
);
|
||||
}
|
||||
f = message.getSint32();
|
||||
if (f !== 0) {
|
||||
writer.writeSint32(
|
||||
3,
|
||||
f
|
||||
);
|
||||
}
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* optional int64 long = 1;
|
||||
* @return {number}
|
||||
*/
|
||||
proto.Test.Inner.InnerInner.prototype.getLong = function() {
|
||||
return /** @type {number} */ (jspb.Message.getFieldWithDefault(this, 1, 0));
|
||||
};
|
||||
|
||||
|
||||
/** @param {number} value */
|
||||
proto.Test.Inner.InnerInner.prototype.setLong = function(value) {
|
||||
jspb.Message.setField(this, 1, value);
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* optional Enum enum = 2;
|
||||
* @return {!proto.Test.Enum}
|
||||
*/
|
||||
proto.Test.Inner.InnerInner.prototype.getEnum = function() {
|
||||
return /** @type {!proto.Test.Enum} */ (jspb.Message.getFieldWithDefault(this, 2, 0));
|
||||
};
|
||||
|
||||
|
||||
/** @param {!proto.Test.Enum} value */
|
||||
proto.Test.Inner.InnerInner.prototype.setEnum = function(value) {
|
||||
jspb.Message.setField(this, 2, value);
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* optional sint32 sint32 = 3;
|
||||
* @return {number}
|
||||
*/
|
||||
proto.Test.Inner.InnerInner.prototype.getSint32 = function() {
|
||||
return /** @type {number} */ (jspb.Message.getFieldWithDefault(this, 3, 0));
|
||||
};
|
||||
|
||||
|
||||
/** @param {number} value */
|
||||
proto.Test.Inner.InnerInner.prototype.setSint32 = function(value) {
|
||||
jspb.Message.setField(this, 3, value);
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* optional int32 int32 = 1;
|
||||
* @return {number}
|
||||
*/
|
||||
proto.Test.Inner.prototype.getInt32 = function() {
|
||||
return /** @type {number} */ (jspb.Message.getFieldWithDefault(this, 1, 0));
|
||||
};
|
||||
|
||||
|
||||
/** @param {number} value */
|
||||
proto.Test.Inner.prototype.setInt32 = function(value) {
|
||||
jspb.Message.setField(this, 1, value);
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* optional InnerInner innerInner = 2;
|
||||
* @return {?proto.Test.Inner.InnerInner}
|
||||
*/
|
||||
proto.Test.Inner.prototype.getInnerinner = function() {
|
||||
return /** @type{?proto.Test.Inner.InnerInner} */ (
|
||||
jspb.Message.getWrapperField(this, proto.Test.Inner.InnerInner, 2));
|
||||
};
|
||||
|
||||
|
||||
/** @param {?proto.Test.Inner.InnerInner|undefined} value */
|
||||
proto.Test.Inner.prototype.setInnerinner = function(value) {
|
||||
jspb.Message.setWrapperField(this, 2, value);
|
||||
};
|
||||
|
||||
|
||||
proto.Test.Inner.prototype.clearInnerinner = function() {
|
||||
this.setInnerinner(undefined);
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* Returns whether this field is set.
|
||||
* @return {!boolean}
|
||||
*/
|
||||
proto.Test.Inner.prototype.hasInnerinner = function() {
|
||||
return jspb.Message.getField(this, 2) != null;
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* optional Outer outer = 3;
|
||||
* @return {?proto.Outer}
|
||||
*/
|
||||
proto.Test.Inner.prototype.getOuter = function() {
|
||||
return /** @type{?proto.Outer} */ (
|
||||
jspb.Message.getWrapperField(this, proto.Outer, 3));
|
||||
};
|
||||
|
||||
|
||||
/** @param {?proto.Outer|undefined} value */
|
||||
proto.Test.Inner.prototype.setOuter = function(value) {
|
||||
jspb.Message.setWrapperField(this, 3, value);
|
||||
};
|
||||
|
||||
|
||||
proto.Test.Inner.prototype.clearOuter = function() {
|
||||
this.setOuter(undefined);
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* Returns whether this field is set.
|
||||
* @return {!boolean}
|
||||
*/
|
||||
proto.Test.Inner.prototype.hasOuter = function() {
|
||||
return jspb.Message.getField(this, 3) != null;
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* optional string string = 1;
|
||||
* @return {string}
|
||||
*/
|
||||
proto.Test.prototype.getString = function() {
|
||||
return /** @type {string} */ (jspb.Message.getFieldWithDefault(this, 1, ""));
|
||||
};
|
||||
|
||||
|
||||
/** @param {string} value */
|
||||
proto.Test.prototype.setString = function(value) {
|
||||
jspb.Message.setField(this, 1, value);
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* optional uint32 uint32 = 2;
|
||||
* @return {number}
|
||||
*/
|
||||
proto.Test.prototype.getUint32 = function() {
|
||||
return /** @type {number} */ (jspb.Message.getFieldWithDefault(this, 2, 0));
|
||||
};
|
||||
|
||||
|
||||
/** @param {number} value */
|
||||
proto.Test.prototype.setUint32 = function(value) {
|
||||
jspb.Message.setField(this, 2, value);
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* optional Inner inner = 3;
|
||||
* @return {?proto.Test.Inner}
|
||||
*/
|
||||
proto.Test.prototype.getInner = function() {
|
||||
return /** @type{?proto.Test.Inner} */ (
|
||||
jspb.Message.getWrapperField(this, proto.Test.Inner, 3));
|
||||
};
|
||||
|
||||
|
||||
/** @param {?proto.Test.Inner|undefined} value */
|
||||
proto.Test.prototype.setInner = function(value) {
|
||||
jspb.Message.setWrapperField(this, 3, value);
|
||||
};
|
||||
|
||||
|
||||
proto.Test.prototype.clearInner = function() {
|
||||
this.setInner(undefined);
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* Returns whether this field is set.
|
||||
* @return {!boolean}
|
||||
*/
|
||||
proto.Test.prototype.hasInner = function() {
|
||||
return jspb.Message.getField(this, 3) != null;
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* optional float float = 4;
|
||||
* @return {number}
|
||||
*/
|
||||
proto.Test.prototype.getFloat = function() {
|
||||
return /** @type {number} */ (+jspb.Message.getFieldWithDefault(this, 4, 0.0));
|
||||
};
|
||||
|
||||
|
||||
/** @param {number} value */
|
||||
proto.Test.prototype.setFloat = function(value) {
|
||||
jspb.Message.setField(this, 4, value);
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Generated by JsPbCodeGenerator.
|
||||
* @param {Array=} opt_data Optional initial data array, typically from a
|
||||
* server response, or constructed directly in Javascript. The array is used
|
||||
* in place and becomes part of the constructed object. It is not cloned.
|
||||
* If no data is provided, the constructed object will be empty, but still
|
||||
* valid.
|
||||
* @extends {jspb.Message}
|
||||
* @constructor
|
||||
*/
|
||||
proto.Outer = function(opt_data) {
|
||||
jspb.Message.initialize(this, opt_data, 0, -1, proto.Outer.repeatedFields_, null);
|
||||
};
|
||||
goog.inherits(proto.Outer, jspb.Message);
|
||||
if (goog.DEBUG && !COMPILED) {
|
||||
proto.Outer.displayName = 'proto.Outer';
|
||||
}
|
||||
/**
|
||||
* List of repeated fields within this message type.
|
||||
* @private {!Array<number>}
|
||||
* @const
|
||||
*/
|
||||
proto.Outer.repeatedFields_ = [1];
|
||||
|
||||
|
||||
|
||||
if (jspb.Message.GENERATE_TO_OBJECT) {
|
||||
/**
|
||||
* Creates an object representation of this proto suitable for use in Soy templates.
|
||||
* Field names that are reserved in JavaScript and will be renamed to pb_name.
|
||||
* To access a reserved field use, foo.pb_<name>, eg, foo.pb_default.
|
||||
* For the list of reserved names please see:
|
||||
* com.google.apps.jspb.JsClassTemplate.JS_RESERVED_WORDS.
|
||||
* @param {boolean=} opt_includeInstance Whether to include the JSPB instance
|
||||
* for transitional soy proto support: http://goto/soy-param-migration
|
||||
* @return {!Object}
|
||||
*/
|
||||
proto.Outer.prototype.toObject = function(opt_includeInstance) {
|
||||
return proto.Outer.toObject(opt_includeInstance, this);
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* Static version of the {@see toObject} method.
|
||||
* @param {boolean|undefined} includeInstance Whether to include the JSPB
|
||||
* instance for transitional soy proto support:
|
||||
* http://goto/soy-param-migration
|
||||
* @param {!proto.Outer} msg The msg instance to transform.
|
||||
* @return {!Object}
|
||||
*/
|
||||
proto.Outer.toObject = function(includeInstance, msg) {
|
||||
var f, obj = {
|
||||
boolList: jspb.Message.getField(msg, 1),
|
||||
pb_double: +jspb.Message.getFieldWithDefault(msg, 2, 0.0)
|
||||
};
|
||||
|
||||
if (includeInstance) {
|
||||
obj.$jspbMessageInstance = msg;
|
||||
}
|
||||
return obj;
|
||||
};
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Deserializes binary data (in protobuf wire format).
|
||||
* @param {jspb.ByteSource} bytes The bytes to deserialize.
|
||||
* @return {!proto.Outer}
|
||||
*/
|
||||
proto.Outer.deserializeBinary = function(bytes) {
|
||||
var reader = new jspb.BinaryReader(bytes);
|
||||
var msg = new proto.Outer;
|
||||
return proto.Outer.deserializeBinaryFromReader(msg, reader);
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* Deserializes binary data (in protobuf wire format) from the
|
||||
* given reader into the given message object.
|
||||
* @param {!proto.Outer} msg The message object to deserialize into.
|
||||
* @param {!jspb.BinaryReader} reader The BinaryReader to use.
|
||||
* @return {!proto.Outer}
|
||||
*/
|
||||
proto.Outer.deserializeBinaryFromReader = function(msg, reader) {
|
||||
while (reader.nextField()) {
|
||||
if (reader.isEndGroup()) {
|
||||
break;
|
||||
}
|
||||
var field = reader.getFieldNumber();
|
||||
switch (field) {
|
||||
case 1:
|
||||
var value = /** @type {!Array.<boolean>} */ (reader.readPackedBool());
|
||||
msg.setBoolList(value);
|
||||
break;
|
||||
case 2:
|
||||
var value = /** @type {number} */ (reader.readDouble());
|
||||
msg.setDouble(value);
|
||||
break;
|
||||
default:
|
||||
reader.skipField();
|
||||
break;
|
||||
}
|
||||
}
|
||||
return msg;
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* Serializes the message to binary data (in protobuf wire format).
|
||||
* @return {!Uint8Array}
|
||||
*/
|
||||
proto.Outer.prototype.serializeBinary = function() {
|
||||
var writer = new jspb.BinaryWriter();
|
||||
proto.Outer.serializeBinaryToWriter(this, writer);
|
||||
return writer.getResultBuffer();
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* Serializes the given message to binary data (in protobuf wire
|
||||
* format), writing to the given BinaryWriter.
|
||||
* @param {!proto.Outer} message
|
||||
* @param {!jspb.BinaryWriter} writer
|
||||
*/
|
||||
proto.Outer.serializeBinaryToWriter = function(message, writer) {
|
||||
var f = undefined;
|
||||
f = message.getBoolList();
|
||||
if (f.length > 0) {
|
||||
writer.writePackedBool(
|
||||
1,
|
||||
f
|
||||
);
|
||||
}
|
||||
f = message.getDouble();
|
||||
if (f !== 0.0) {
|
||||
writer.writeDouble(
|
||||
2,
|
||||
f
|
||||
);
|
||||
}
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* repeated bool bool = 1;
|
||||
* Note that Boolean fields may be set to 0/1 when serialized from a Java server.
|
||||
* You should avoid comparisons like {@code val === true/false} in those cases.
|
||||
* If you change this array by adding, removing or replacing elements, or if you
|
||||
* replace the array itself, then you must call the setter to update it.
|
||||
* @return {!Array.<boolean>}
|
||||
*/
|
||||
proto.Outer.prototype.getBoolList = function() {
|
||||
return /** @type {!Array.<boolean>} */ (jspb.Message.getField(this, 1));
|
||||
};
|
||||
|
||||
|
||||
/** @param {!Array.<boolean>} value */
|
||||
proto.Outer.prototype.setBoolList = function(value) {
|
||||
jspb.Message.setField(this, 1, value || []);
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* @param {!boolean} value
|
||||
* @param {number=} opt_index
|
||||
*/
|
||||
proto.Outer.prototype.addBool = function(value, opt_index) {
|
||||
jspb.Message.addToRepeatedField(this, 1, value, opt_index);
|
||||
};
|
||||
|
||||
|
||||
proto.Outer.prototype.clearBoolList = function() {
|
||||
this.setBoolList([]);
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* optional double double = 2;
|
||||
* @return {number}
|
||||
*/
|
||||
proto.Outer.prototype.getDouble = function() {
|
||||
return /** @type {number} */ (+jspb.Message.getFieldWithDefault(this, 2, 0.0));
|
||||
};
|
||||
|
||||
|
||||
/** @param {number} value */
|
||||
proto.Outer.prototype.setDouble = function(value) {
|
||||
jspb.Message.setField(this, 2, value);
|
||||
};
|
||||
|
||||
|
||||
goog.object.extend(exports, proto);
|
||||
+240
@@ -0,0 +1,240 @@
|
||||
/*eslint-disable block-scoped-var, id-length, no-control-regex, no-magic-numbers, no-prototype-builtins, no-redeclare, no-shadow, no-var, sort-vars*/
|
||||
"use strict";
|
||||
|
||||
var $protobuf = require("../../minimal");
|
||||
|
||||
var $Reader = $protobuf.Reader, $Writer = $protobuf.Writer, $util = $protobuf.util;
|
||||
|
||||
var $root = $protobuf.roots.test_bench || ($protobuf.roots.test_bench = {});
|
||||
|
||||
$root.Test = (function() {
|
||||
|
||||
function Test(properties) {
|
||||
if (properties)
|
||||
for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i)
|
||||
if (properties[keys[i]] != null)
|
||||
this[keys[i]] = properties[keys[i]];
|
||||
}
|
||||
|
||||
Test.prototype.string = "";
|
||||
Test.prototype.uint32 = 0;
|
||||
Test.prototype.inner = null;
|
||||
Test.prototype.float = 0;
|
||||
|
||||
Test.encode = function encode(message, writer) {
|
||||
if (!writer)
|
||||
writer = $Writer.create();
|
||||
if (message.string != null && message.hasOwnProperty("string"))
|
||||
writer.uint32(10).string(message.string);
|
||||
if (message.uint32 != null && message.hasOwnProperty("uint32"))
|
||||
writer.uint32(16).uint32(message.uint32);
|
||||
if (message.inner != null && message.hasOwnProperty("inner"))
|
||||
$root.Test.Inner.encode(message.inner, writer.uint32(26).fork()).ldelim();
|
||||
if (message.float != null && message.hasOwnProperty("float"))
|
||||
writer.uint32(37).float(message.float);
|
||||
return writer;
|
||||
};
|
||||
|
||||
Test.decode = function decode(reader, length) {
|
||||
if (!(reader instanceof $Reader))
|
||||
reader = $Reader.create(reader);
|
||||
var end = length === undefined ? reader.len : reader.pos + length, message = new $root.Test();
|
||||
while (reader.pos < end) {
|
||||
var tag = reader.uint32();
|
||||
switch (tag >>> 3) {
|
||||
case 1:
|
||||
message.string = reader.string();
|
||||
break;
|
||||
case 2:
|
||||
message.uint32 = reader.uint32();
|
||||
break;
|
||||
case 3:
|
||||
message.inner = $root.Test.Inner.decode(reader, reader.uint32());
|
||||
break;
|
||||
case 4:
|
||||
message.float = reader.float();
|
||||
break;
|
||||
default:
|
||||
reader.skipType(tag & 7);
|
||||
break;
|
||||
}
|
||||
}
|
||||
return message;
|
||||
};
|
||||
|
||||
Test.Inner = (function() {
|
||||
|
||||
function Inner(properties) {
|
||||
if (properties)
|
||||
for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i)
|
||||
if (properties[keys[i]] != null)
|
||||
this[keys[i]] = properties[keys[i]];
|
||||
}
|
||||
|
||||
Inner.prototype.int32 = 0;
|
||||
Inner.prototype.innerInner = null;
|
||||
Inner.prototype.outer = null;
|
||||
|
||||
Inner.encode = function encode(message, writer) {
|
||||
if (!writer)
|
||||
writer = $Writer.create();
|
||||
if (message.int32 != null && message.hasOwnProperty("int32"))
|
||||
writer.uint32(8).int32(message.int32);
|
||||
if (message.innerInner != null && message.hasOwnProperty("innerInner"))
|
||||
$root.Test.Inner.InnerInner.encode(message.innerInner, writer.uint32(18).fork()).ldelim();
|
||||
if (message.outer != null && message.hasOwnProperty("outer"))
|
||||
$root.Outer.encode(message.outer, writer.uint32(26).fork()).ldelim();
|
||||
return writer;
|
||||
};
|
||||
|
||||
Inner.decode = function decode(reader, length) {
|
||||
if (!(reader instanceof $Reader))
|
||||
reader = $Reader.create(reader);
|
||||
var end = length === undefined ? reader.len : reader.pos + length, message = new $root.Test.Inner();
|
||||
while (reader.pos < end) {
|
||||
var tag = reader.uint32();
|
||||
switch (tag >>> 3) {
|
||||
case 1:
|
||||
message.int32 = reader.int32();
|
||||
break;
|
||||
case 2:
|
||||
message.innerInner = $root.Test.Inner.InnerInner.decode(reader, reader.uint32());
|
||||
break;
|
||||
case 3:
|
||||
message.outer = $root.Outer.decode(reader, reader.uint32());
|
||||
break;
|
||||
default:
|
||||
reader.skipType(tag & 7);
|
||||
break;
|
||||
}
|
||||
}
|
||||
return message;
|
||||
};
|
||||
|
||||
Inner.InnerInner = (function() {
|
||||
|
||||
function InnerInner(properties) {
|
||||
if (properties)
|
||||
for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i)
|
||||
if (properties[keys[i]] != null)
|
||||
this[keys[i]] = properties[keys[i]];
|
||||
}
|
||||
|
||||
InnerInner.prototype.long = $util.Long ? $util.Long.fromBits(0,0,false) : 0;
|
||||
InnerInner.prototype["enum"] = 0;
|
||||
InnerInner.prototype.sint32 = 0;
|
||||
|
||||
InnerInner.encode = function encode(message, writer) {
|
||||
if (!writer)
|
||||
writer = $Writer.create();
|
||||
if (message.long != null && message.hasOwnProperty("long"))
|
||||
writer.uint32(8).int64(message.long);
|
||||
if (message["enum"] != null && message.hasOwnProperty("enum"))
|
||||
writer.uint32(16).int32(message["enum"]);
|
||||
if (message.sint32 != null && message.hasOwnProperty("sint32"))
|
||||
writer.uint32(24).sint32(message.sint32);
|
||||
return writer;
|
||||
};
|
||||
|
||||
InnerInner.decode = function decode(reader, length) {
|
||||
if (!(reader instanceof $Reader))
|
||||
reader = $Reader.create(reader);
|
||||
var end = length === undefined ? reader.len : reader.pos + length, message = new $root.Test.Inner.InnerInner();
|
||||
while (reader.pos < end) {
|
||||
var tag = reader.uint32();
|
||||
switch (tag >>> 3) {
|
||||
case 1:
|
||||
message.long = reader.int64();
|
||||
break;
|
||||
case 2:
|
||||
message["enum"] = reader.int32();
|
||||
break;
|
||||
case 3:
|
||||
message.sint32 = reader.sint32();
|
||||
break;
|
||||
default:
|
||||
reader.skipType(tag & 7);
|
||||
break;
|
||||
}
|
||||
}
|
||||
return message;
|
||||
};
|
||||
|
||||
return InnerInner;
|
||||
})();
|
||||
|
||||
return Inner;
|
||||
})();
|
||||
|
||||
Test.Enum = (function() {
|
||||
var valuesById = {}, values = Object.create(valuesById);
|
||||
values[valuesById[0] = "ONE"] = 0;
|
||||
values[valuesById[1] = "TWO"] = 1;
|
||||
values[valuesById[2] = "THREE"] = 2;
|
||||
values[valuesById[3] = "FOUR"] = 3;
|
||||
values[valuesById[4] = "FIVE"] = 4;
|
||||
return values;
|
||||
})();
|
||||
|
||||
return Test;
|
||||
})();
|
||||
|
||||
$root.Outer = (function() {
|
||||
|
||||
function Outer(properties) {
|
||||
this.bool = [];
|
||||
if (properties)
|
||||
for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i)
|
||||
if (properties[keys[i]] != null)
|
||||
this[keys[i]] = properties[keys[i]];
|
||||
}
|
||||
|
||||
Outer.prototype.bool = $util.emptyArray;
|
||||
Outer.prototype.double = 0;
|
||||
|
||||
Outer.encode = function encode(message, writer) {
|
||||
if (!writer)
|
||||
writer = $Writer.create();
|
||||
if (message.bool != null && message.bool.length) {
|
||||
writer.uint32(10).fork();
|
||||
for (var i = 0; i < message.bool.length; ++i)
|
||||
writer.bool(message.bool[i]);
|
||||
writer.ldelim();
|
||||
}
|
||||
if (message.double != null && message.hasOwnProperty("double"))
|
||||
writer.uint32(17).double(message.double);
|
||||
return writer;
|
||||
};
|
||||
|
||||
Outer.decode = function decode(reader, length) {
|
||||
if (!(reader instanceof $Reader))
|
||||
reader = $Reader.create(reader);
|
||||
var end = length === undefined ? reader.len : reader.pos + length, message = new $root.Outer();
|
||||
while (reader.pos < end) {
|
||||
var tag = reader.uint32();
|
||||
switch (tag >>> 3) {
|
||||
case 1:
|
||||
if (!(message.bool && message.bool.length))
|
||||
message.bool = [];
|
||||
if ((tag & 7) === 2) {
|
||||
var end2 = reader.uint32() + reader.pos;
|
||||
while (reader.pos < end2)
|
||||
message.bool.push(reader.bool());
|
||||
} else
|
||||
message.bool.push(reader.bool());
|
||||
break;
|
||||
case 2:
|
||||
message.double = reader.double();
|
||||
break;
|
||||
default:
|
||||
reader.skipType(tag & 7);
|
||||
break;
|
||||
}
|
||||
}
|
||||
return message;
|
||||
};
|
||||
|
||||
return Outer;
|
||||
})();
|
||||
|
||||
module.exports = $root;
|
||||
Executable
+90
@@ -0,0 +1,90 @@
|
||||
"use strict";
|
||||
|
||||
// NOTE: This benchmark partly compares apples and oranges in that it measures protocol buffers,
|
||||
// which is purely a binary format, and JSON, which is purely a string format.
|
||||
//
|
||||
// This matters because strings aren't actually transfered over the network but must still be
|
||||
// converted to binary somewhere down the road. Because this can't be measured reliably, this
|
||||
// benchmark compares both pure string performance of JSON and additional binary conversion of the
|
||||
// same data using node buffers. Actual JSON performance on the network level should be somewhere
|
||||
// in between.
|
||||
|
||||
var newSuite = require("./suite"),
|
||||
payload = require("./data/bench.json");
|
||||
|
||||
var Buffer_from = Buffer.from !== Uint8Array.from && Buffer.from || function(value, encoding) { return new Buffer(value, encoding); };
|
||||
|
||||
// protobuf.js dynamic: load the proto and set up a buffer
|
||||
var pbjsCls = require("..").loadSync(require.resolve("./data/bench.proto")).resolveAll().lookup("Test");
|
||||
var pbjsMsg = payload; // alt: pbjsCls.fromObject(payload);
|
||||
var pbjsBuf = pbjsCls.encode(pbjsMsg).finish();
|
||||
|
||||
// protobuf.js static: load the proto
|
||||
var pbjsStaticCls = require("./data/static_pbjs.js").Test;
|
||||
|
||||
// JSON: set up a string and a buffer
|
||||
var jsonMsg = payload;
|
||||
var jsonStr = JSON.stringify(jsonMsg);
|
||||
var jsonBuf = Buffer_from(jsonStr, "utf8");
|
||||
|
||||
// google-protobuf: load the proto, set up an Uint8Array and a message
|
||||
var jspbCls = require("./data/static_jspb.js").Test;
|
||||
var jspbBuf = new Uint8Array(Array.prototype.slice.call(pbjsBuf));
|
||||
var jspbMsg = jspbCls.deserializeBinary(jspbBuf);
|
||||
|
||||
newSuite("encoding")
|
||||
|
||||
.add("protobuf.js (reflect)", function() {
|
||||
pbjsCls.encode(pbjsMsg).finish();
|
||||
})
|
||||
.add("protobuf.js (static)", function() {
|
||||
pbjsStaticCls.encode(pbjsMsg).finish();
|
||||
})
|
||||
.add("JSON (string)", function() {
|
||||
JSON.stringify(jsonMsg);
|
||||
})
|
||||
.add("JSON (buffer)", function() {
|
||||
Buffer_from(JSON.stringify(jsonMsg), "utf8");
|
||||
})
|
||||
.add("google-protobuf", function() {
|
||||
jspbMsg.serializeBinary();
|
||||
})
|
||||
.run();
|
||||
|
||||
newSuite("decoding")
|
||||
|
||||
.add("protobuf.js (reflect)", function() {
|
||||
pbjsCls.decode(pbjsBuf); // no allocation overhead, if you wondered
|
||||
})
|
||||
.add("protobuf.js (static)", function() {
|
||||
pbjsStaticCls.decode(pbjsBuf);
|
||||
})
|
||||
.add("JSON (string)", function() {
|
||||
JSON.parse(jsonStr);
|
||||
})
|
||||
.add("JSON (buffer)", function() {
|
||||
JSON.parse(jsonBuf.toString("utf8"));
|
||||
})
|
||||
.add("google-protobuf", function() {
|
||||
jspbCls.deserializeBinary(jspbBuf);
|
||||
})
|
||||
.run();
|
||||
|
||||
newSuite("combined")
|
||||
|
||||
.add("protobuf.js (reflect)", function() {
|
||||
pbjsCls.decode(pbjsCls.encode(pbjsMsg).finish());
|
||||
})
|
||||
.add("protobuf.js (static)", function() {
|
||||
pbjsStaticCls.decode(pbjsStaticCls.encode(pbjsMsg).finish());
|
||||
})
|
||||
.add("JSON (string)", function() {
|
||||
JSON.parse(JSON.stringify(jsonMsg));
|
||||
})
|
||||
.add("JSON (buffer)", function() {
|
||||
JSON.parse(Buffer_from(JSON.stringify(jsonMsg), "utf8").toString("utf8"));
|
||||
})
|
||||
.add("google-protobuf", function() {
|
||||
jspbCls.deserializeBinary(jspbMsg.serializeBinary());
|
||||
})
|
||||
.run();
|
||||
Executable
+102
@@ -0,0 +1,102 @@
|
||||
"use strict";
|
||||
|
||||
var fs = require("fs"),
|
||||
path = require("path");
|
||||
|
||||
// A profiling stub to measure encoding / decoding performance using benchmark data.
|
||||
|
||||
var commands = ["encode", "decode", "encode-browser", "decode-browser", "fromjson"];
|
||||
if (commands.indexOf(process.argv[2]) < 0) { // 0: node, 1: prof.js
|
||||
process.stderr.write("usage: " + path.basename(process.argv[1]) + " <" + commands.join("|") + "> [iterations=10000000]\n");
|
||||
return;
|
||||
}
|
||||
|
||||
// Spin up a node process with profiling enabled and process the generated log
|
||||
if (process.execArgv.indexOf("--prof") < 0) {
|
||||
process.stdout.write("cleaning up old logs ...\n");
|
||||
var child_process = require("child_process");
|
||||
var logRe = /^isolate-[0-9A-F]+-v8\.log$/;
|
||||
fs.readdirSync(process.cwd()).forEach(function readdirSync_it(file) {
|
||||
if (logRe.test(file))
|
||||
fs.unlink(file);
|
||||
});
|
||||
process.stdout.write("generating profile (may take a while) ...\n");
|
||||
child_process.execSync("node --prof --trace-deopt " + process.execArgv.join(" ") + " " + process.argv.slice(1).join(" "), {
|
||||
cwd: process.cwd(),
|
||||
stdio: "inherit"
|
||||
});
|
||||
process.stdout.write("processing profile ...\n");
|
||||
fs.readdirSync(process.cwd()).forEach(function readdirSync_it(file) {
|
||||
if (logRe.test(file)) {
|
||||
child_process.execSync("node --prof-process " + file, {
|
||||
cwd: process.cwd(),
|
||||
stdio: "inherit"
|
||||
});
|
||||
// fs.unlink(file);
|
||||
}
|
||||
});
|
||||
process.stdout.write("done.\n");
|
||||
return;
|
||||
}
|
||||
|
||||
// Actual profiling code
|
||||
var protobuf = require("..");
|
||||
|
||||
// protobuf.util.codegen.verbose = true;
|
||||
|
||||
var root, json;
|
||||
|
||||
if (process.argv[2] === "fromjson") {
|
||||
json = require("../tests/data/test.json");
|
||||
if (process.argv.indexOf("--resolve") < 0)
|
||||
for (var k = 0; k < 10000; ++k)
|
||||
protobuf.Root.fromJSON(json);
|
||||
else
|
||||
for (var l = 0; l < 10000; ++l)
|
||||
protobuf.Root.fromJSON(json).resolveAll();
|
||||
return;
|
||||
}
|
||||
|
||||
var Test, data, count;
|
||||
|
||||
if (process.argv.indexOf("--alt") < 0) {
|
||||
root = protobuf.parse(fs.readFileSync(require.resolve("../bench/data/bench.proto")).toString("utf8")).root;
|
||||
Test = root.lookup("Test");
|
||||
json = JSON.stringify(root);
|
||||
data = require("../bench/data/bench.json");
|
||||
count = 10000000;
|
||||
process.stdout.write("bench.proto");
|
||||
} else {
|
||||
root = protobuf.parse(fs.readFileSync(require.resolve("../tests/data/mapbox/vector_tile.proto")).toString("utf8")).root;
|
||||
Test = root.lookup("vector_tile.Tile");
|
||||
data = Test.decode(fs.readFileSync(require.resolve("../tests/data/mapbox/vector_tile.bin")));
|
||||
count = 1000;
|
||||
process.stdout.write("vector_tile.proto");
|
||||
}
|
||||
|
||||
if (process.argv.length > 3 && /^\d+$/.test(process.argv[3]))
|
||||
count = parseInt(process.argv[3], 10);
|
||||
process.stdout.write(" x " + count + "\n");
|
||||
|
||||
function setupBrowser() {
|
||||
protobuf.Writer.create = function create_browser() { return new protobuf.Writer(); };
|
||||
protobuf.Reader.create = function create_browser(buf) { return new protobuf.Reader(buf); };
|
||||
}
|
||||
|
||||
switch (process.argv[2]) {
|
||||
case "encode-browser":
|
||||
setupBrowser();
|
||||
// eslint-disable-line no-fallthrough
|
||||
case "encode":
|
||||
for (var i = 0; i < count; ++i)
|
||||
Test.encode(data).finish();
|
||||
break;
|
||||
case "decode-browser":
|
||||
setupBrowser();
|
||||
// eslint-disable-line no-fallthrough
|
||||
case "decode":
|
||||
var buf = Test.encode(data).finish();
|
||||
for (var j = 0; j < count; ++j)
|
||||
Test.decode(buf);
|
||||
break;
|
||||
}
|
||||
Executable
+45
@@ -0,0 +1,45 @@
|
||||
"use strict";
|
||||
module.exports = newSuite;
|
||||
|
||||
var benchmark = require("benchmark"),
|
||||
chalk = require("chalk");
|
||||
|
||||
var padSize = 23;
|
||||
|
||||
function newSuite(name) {
|
||||
var benches = [];
|
||||
return new benchmark.Suite(name)
|
||||
.on("add", function(event) {
|
||||
benches.push(event.target);
|
||||
})
|
||||
.on("start", function() {
|
||||
process.stdout.write(chalk.white.bold("benchmarking " + name + " performance ...") + "\n\n");
|
||||
})
|
||||
.on("cycle", function(event) {
|
||||
process.stdout.write(String(event.target) + "\n");
|
||||
})
|
||||
.on("complete", function() {
|
||||
if (benches.length > 1) {
|
||||
benches.sort(function(a, b) { return getHz(b) - getHz(a); });
|
||||
var fastest = benches[0],
|
||||
fastestHz = getHz(fastest);
|
||||
process.stdout.write("\n" + chalk.white(pad(fastest.name, padSize)) + " was " + chalk.green("fastest") + "\n");
|
||||
benches.slice(1).forEach(function(bench) {
|
||||
var hz = getHz(bench);
|
||||
var percent = 1 - hz / fastestHz;
|
||||
process.stdout.write(chalk.white(pad(bench.name, padSize)) + " was " + chalk.red((percent * 100).toFixed(1) + "% ops/sec slower (factor " + (fastestHz / hz).toFixed(1) + ")") + "\n");
|
||||
});
|
||||
}
|
||||
process.stdout.write("\n");
|
||||
});
|
||||
}
|
||||
|
||||
function getHz(bench) {
|
||||
return 1 / (bench.stats.mean + bench.stats.moe);
|
||||
}
|
||||
|
||||
function pad(str, len, l) {
|
||||
while (str.length < len)
|
||||
str = l ? str + " " : " " + str;
|
||||
return str;
|
||||
}
|
||||
Executable
+6
@@ -0,0 +1,6 @@
|
||||
#!/usr/bin/env node
|
||||
var path = require("path"),
|
||||
cli = require(path.join(__dirname, "..", "cli", "pbjs.js"));
|
||||
var ret = cli.main(process.argv.slice(2));
|
||||
if (typeof ret === 'number')
|
||||
process.exit(ret);
|
||||
Executable
+6
@@ -0,0 +1,6 @@
|
||||
#!/usr/bin/env node
|
||||
var path = require("path"),
|
||||
cli = require(path.join(__dirname, "..", "cli", "pbts.js"));
|
||||
var ret = cli.main(process.argv.slice(2));
|
||||
if (typeof ret === 'number')
|
||||
process.exit(ret);
|
||||
Executable
+33
@@ -0,0 +1,33 @@
|
||||
Copyright (c) 2016, Daniel Wirtz All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are
|
||||
met:
|
||||
|
||||
* Redistributions of source code must retain the above copyright
|
||||
notice, this list of conditions and the following disclaimer.
|
||||
* Redistributions in binary form must reproduce the above copyright
|
||||
notice, this list of conditions and the following disclaimer in the
|
||||
documentation and/or other materials provided with the distribution.
|
||||
* Neither the name of its author, nor the names of its contributors
|
||||
may be used to endorse or promote products derived from this software
|
||||
without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
---
|
||||
|
||||
Code generated by the command line utilities is owned by the owner
|
||||
of the input file used when generating it. This code is not
|
||||
standalone and requires a support library to be linked with it. This
|
||||
support library is itself covered by the above license.
|
||||
Executable
+11
@@ -0,0 +1,11 @@
|
||||
protobufjs-cli
|
||||
==============
|
||||
[](https://www.npmjs.com/package/protobufjs-cli)
|
||||
|
||||
Command line interface (CLI) for [protobuf.js](https://github.com/dcodeIO/protobuf.js). Translates between file formats and generates static code as well as TypeScript definitions.
|
||||
|
||||
* [CLI Documentation](https://github.com/dcodeIO/protobuf.js#command-line)
|
||||
|
||||
**Note** that moving the CLI to its own package is a work in progress. At the moment, it's still part of the main package.
|
||||
|
||||
**License:** [BSD 3-Clause License](https://opensource.org/licenses/BSD-3-Clause)
|
||||
Executable
+6
@@ -0,0 +1,6 @@
|
||||
#!/usr/bin/env node
|
||||
var path = require("path"),
|
||||
cli = require(path.join(__dirname, "..", "pbjs.js"));
|
||||
var ret = cli.main(process.argv.slice(2));
|
||||
if (typeof ret === 'number')
|
||||
process.exit(ret);
|
||||
Executable
+6
@@ -0,0 +1,6 @@
|
||||
#!/usr/bin/env node
|
||||
var path = require("path"),
|
||||
cli = require(path.join(__dirname, "..", "pbts.js"));
|
||||
var ret = cli.main(process.argv.slice(2));
|
||||
if (typeof ret === 'number')
|
||||
process.exit(ret);
|
||||
+3
@@ -0,0 +1,3 @@
|
||||
import * as pbjs from "./pbjs.js";
|
||||
import * as pbts from "./pbts.js";
|
||||
export { pbjs, pbts };
|
||||
Executable
+3
@@ -0,0 +1,3 @@
|
||||
"use strict";
|
||||
exports.pbjs = require("./pbjs");
|
||||
exports.pbts = require("./pbts");
|
||||
Executable
+18
@@ -0,0 +1,18 @@
|
||||
{
|
||||
"tags": {
|
||||
"allowUnknownTags": false
|
||||
},
|
||||
"plugins": [
|
||||
"./tsd-jsdoc/plugin"
|
||||
],
|
||||
"opts": {
|
||||
"encoding" : "utf8",
|
||||
"recurse" : true,
|
||||
"lenient" : true,
|
||||
"template" : "./tsd-jsdoc",
|
||||
|
||||
"private" : false,
|
||||
"comments" : true,
|
||||
"destination" : false
|
||||
}
|
||||
}
|
||||
+21
@@ -0,0 +1,21 @@
|
||||
The MIT License
|
||||
|
||||
Copyright (c) 2016 Chad Engler
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
+23
@@ -0,0 +1,23 @@
|
||||
protobuf.js fork of tsd-jsdoc
|
||||
=============================
|
||||
|
||||
This is a modified version of [tsd-jsdoc](https://github.com/englercj/tsd-jsdoc) v1.0.1 for use with protobuf.js, parked here so we can process issues and pull requests. The ultimate goal is to switch back to the a recent version of tsd-jsdoc once it meets our needs.
|
||||
|
||||
Options
|
||||
-------
|
||||
|
||||
* **module: `string`**<br />
|
||||
Wraps everything in a module of the specified name.
|
||||
|
||||
* **private: `boolean`**<br />
|
||||
Includes private members when set to `true`.
|
||||
|
||||
* **comments: `boolean`**<br />
|
||||
Skips comments when explicitly set to `false`.
|
||||
|
||||
* **destination: `string|boolean`**<br />
|
||||
Saves to the specified destination file or to console when set to `false`.
|
||||
|
||||
Setting options on the command line
|
||||
-----------------------------------
|
||||
Providing `-q, --query <queryString>` on the command line will set respectively override existing options. Example: `-q module=protobufjs`
|
||||
+21
@@ -0,0 +1,21 @@
|
||||
"use strict";
|
||||
exports.defineTags = function(dictionary) {
|
||||
|
||||
dictionary.defineTag("template", {
|
||||
mustHaveValue: true,
|
||||
canHaveType: false,
|
||||
canHaveName: false,
|
||||
onTagged: function(doclet, tag) {
|
||||
(doclet.templates || (doclet.templates = [])).push(tag.text);
|
||||
}
|
||||
});
|
||||
|
||||
dictionary.defineTag("tstype", {
|
||||
mustHaveValue: true,
|
||||
canHaveType: false,
|
||||
canHaveName: false,
|
||||
onTagged: function(doclet, tag) {
|
||||
doclet.tsType = tag.text;
|
||||
}
|
||||
});
|
||||
};
|
||||
+693
@@ -0,0 +1,693 @@
|
||||
"use strict";
|
||||
|
||||
var fs = require("fs");
|
||||
|
||||
// output stream
|
||||
var out = null;
|
||||
|
||||
// documentation data
|
||||
var data = null;
|
||||
|
||||
// already handled objects, by name
|
||||
var seen = {};
|
||||
|
||||
// indentation level
|
||||
var indent = 0;
|
||||
|
||||
// whether indent has been written for the current line yet
|
||||
var indentWritten = false;
|
||||
|
||||
// provided options
|
||||
var options = {};
|
||||
|
||||
// queued interfaces
|
||||
var queuedInterfaces = [];
|
||||
|
||||
// whether writing the first line
|
||||
var firstLine = true;
|
||||
|
||||
// JSDoc hook
|
||||
exports.publish = function publish(taffy, opts) {
|
||||
options = opts || {};
|
||||
|
||||
// query overrides options
|
||||
if (options.query)
|
||||
Object.keys(options.query).forEach(function(key) {
|
||||
if (key !== "query")
|
||||
switch (options[key] = options.query[key]) {
|
||||
case "true":
|
||||
options[key] = true;
|
||||
break;
|
||||
case "false":
|
||||
options[key] = false;
|
||||
break;
|
||||
case "null":
|
||||
options[key] = null;
|
||||
break;
|
||||
}
|
||||
});
|
||||
|
||||
// remove undocumented
|
||||
taffy({ undocumented: true }).remove();
|
||||
taffy({ ignore: true }).remove();
|
||||
taffy({ inherited: true }).remove();
|
||||
|
||||
// remove private
|
||||
if (!options.private)
|
||||
taffy({ access: "private" }).remove();
|
||||
|
||||
// setup output
|
||||
out = options.destination
|
||||
? fs.createWriteStream(options.destination)
|
||||
: process.stdout;
|
||||
|
||||
try {
|
||||
// setup environment
|
||||
data = taffy().get();
|
||||
indent = 0;
|
||||
indentWritten = false;
|
||||
firstLine = true;
|
||||
|
||||
// wrap everything in a module if configured
|
||||
if (options.module) {
|
||||
writeln("export = ", options.module, ";");
|
||||
writeln();
|
||||
writeln("declare namespace ", options.module, " {");
|
||||
writeln();
|
||||
++indent;
|
||||
}
|
||||
|
||||
// handle all
|
||||
getChildrenOf(undefined).forEach(function(child) {
|
||||
handleElement(child, null);
|
||||
});
|
||||
|
||||
// process queued
|
||||
while (queuedInterfaces.length) {
|
||||
var element = queuedInterfaces.shift();
|
||||
begin(element);
|
||||
writeInterface(element);
|
||||
writeln(";");
|
||||
}
|
||||
|
||||
// end wrap
|
||||
if (options.module) {
|
||||
--indent;
|
||||
writeln("}");
|
||||
}
|
||||
|
||||
// close file output
|
||||
if (out !== process.stdout)
|
||||
out.end();
|
||||
|
||||
} finally {
|
||||
// gc environment objects
|
||||
out = data = null;
|
||||
seen = options = {};
|
||||
queuedInterfaces = [];
|
||||
}
|
||||
};
|
||||
|
||||
//
|
||||
// Utility
|
||||
//
|
||||
|
||||
// writes one or multiple strings
|
||||
function write() {
|
||||
var s = Array.prototype.slice.call(arguments).join("");
|
||||
if (!indentWritten) {
|
||||
for (var i = 0; i < indent; ++i)
|
||||
s = " " + s;
|
||||
indentWritten = true;
|
||||
}
|
||||
out.write(s);
|
||||
firstLine = false;
|
||||
}
|
||||
|
||||
// writes zero or multiple strings, followed by a new line
|
||||
function writeln() {
|
||||
var s = Array.prototype.slice.call(arguments).join("");
|
||||
if (s.length)
|
||||
write(s, "\n");
|
||||
else if (!firstLine)
|
||||
out.write("\n");
|
||||
indentWritten = false;
|
||||
}
|
||||
|
||||
var keepTags = [
|
||||
"param",
|
||||
"returns",
|
||||
"throws",
|
||||
"see"
|
||||
];
|
||||
|
||||
// parses a comment into text and tags
|
||||
function parseComment(comment) {
|
||||
var lines = comment.replace(/^ *\/\*\* *|^ *\*\/| *\*\/ *$|^ *\* */mg, "").trim().split(/\r?\n|\r/g); // property.description has just "\r" ?!
|
||||
var desc;
|
||||
var text = [];
|
||||
var tags = null;
|
||||
for (var i = 0; i < lines.length; ++i) {
|
||||
var match = /^@(\w+)\b/.exec(lines[i]);
|
||||
if (match) {
|
||||
if (!tags) {
|
||||
tags = [];
|
||||
desc = text;
|
||||
}
|
||||
text = [];
|
||||
tags.push({ name: match[1], text: text });
|
||||
lines[i] = lines[i].substring(match[1].length + 1).trim();
|
||||
}
|
||||
if (lines[i].length || text.length)
|
||||
text.push(lines[i]);
|
||||
}
|
||||
return {
|
||||
text: desc || text,
|
||||
tags: tags || []
|
||||
};
|
||||
}
|
||||
|
||||
// writes a comment
|
||||
function writeComment(comment, otherwiseNewline) {
|
||||
if (!comment || options.comments === false) {
|
||||
if (otherwiseNewline)
|
||||
writeln();
|
||||
return;
|
||||
}
|
||||
if (typeof comment !== "object")
|
||||
comment = parseComment(comment);
|
||||
comment.tags = comment.tags.filter(function(tag) {
|
||||
return keepTags.indexOf(tag.name) > -1 && (tag.name !== "returns" || tag.text[0] !== "{undefined}");
|
||||
});
|
||||
writeln();
|
||||
if (!comment.tags.length && comment.text.length < 2) {
|
||||
writeln("/** " + comment.text[0] + " */");
|
||||
return;
|
||||
}
|
||||
writeln("/**");
|
||||
comment.text.forEach(function(line) {
|
||||
if (line.length)
|
||||
writeln(" * ", line);
|
||||
else
|
||||
writeln(" *");
|
||||
});
|
||||
comment.tags.forEach(function(tag) {
|
||||
var started = false;
|
||||
if (tag.text.length) {
|
||||
tag.text.forEach(function(line, i) {
|
||||
if (i > 0)
|
||||
write(" * ");
|
||||
else if (tag.name !== "throws")
|
||||
line = line.replace(/^\{[^\s]*} ?/, "");
|
||||
if (!line.length)
|
||||
return;
|
||||
if (!started) {
|
||||
write(" * @", tag.name, " ");
|
||||
started = true;
|
||||
}
|
||||
writeln(line);
|
||||
});
|
||||
}
|
||||
});
|
||||
writeln(" */");
|
||||
}
|
||||
|
||||
// recursively replaces all occurencies of re's match
|
||||
function replaceRecursive(name, re, fn) {
|
||||
var found;
|
||||
|
||||
function replacer() {
|
||||
found = true;
|
||||
return fn.apply(null, arguments);
|
||||
}
|
||||
|
||||
do {
|
||||
found = false;
|
||||
name = name.replace(re, replacer);
|
||||
} while (found);
|
||||
return name;
|
||||
}
|
||||
|
||||
// tests if an element is considered to be a class or class-like
|
||||
function isClassLike(element) {
|
||||
return isClass(element) || isInterface(element);
|
||||
}
|
||||
|
||||
// tests if an element is considered to be a class
|
||||
function isClass(element) {
|
||||
return element && element.kind === "class";
|
||||
}
|
||||
|
||||
// tests if an element is considered to be an interface
|
||||
function isInterface(element) {
|
||||
return element && (element.kind === "interface" || element.kind === "mixin");
|
||||
}
|
||||
|
||||
// tests if an element is considered to be a namespace
|
||||
function isNamespace(element) {
|
||||
return element && (element.kind === "namespace" || element.kind === "module");
|
||||
}
|
||||
|
||||
// gets all children of the specified parent
|
||||
function getChildrenOf(parent) {
|
||||
var memberof = parent ? parent.longname : undefined;
|
||||
return data.filter(function(element) {
|
||||
return element.memberof === memberof;
|
||||
});
|
||||
}
|
||||
|
||||
// gets the literal type of an element
|
||||
function getTypeOf(element) {
|
||||
if (element.tsType)
|
||||
return element.tsType.replace(/\r?\n|\r/g, "\n");
|
||||
var name = "any";
|
||||
var type = element.type;
|
||||
if (type && type.names && type.names.length) {
|
||||
if (type.names.length === 1)
|
||||
name = element.type.names[0].trim();
|
||||
else
|
||||
name = "(" + element.type.names.join("|") + ")";
|
||||
} else
|
||||
return name;
|
||||
|
||||
// Replace catchalls with any
|
||||
name = name.replace(/\*|\bmixed\b/g, "any");
|
||||
|
||||
// Ensure upper case Object for map expressions below
|
||||
name = name.replace(/\bobject\b/g, "Object");
|
||||
|
||||
// Correct Something.<Something> to Something<Something>
|
||||
name = replaceRecursive(name, /\b(?!Object|Array)([\w$]+)\.<([^>]*)>/gi, function($0, $1, $2) {
|
||||
return $1 + "<" + $2 + ">";
|
||||
});
|
||||
|
||||
// Replace Array.<string> with string[]
|
||||
name = replaceRecursive(name, /\bArray\.?<([^>]*)>/gi, function($0, $1) {
|
||||
return $1 + "[]";
|
||||
});
|
||||
|
||||
// Replace Object.<string,number> with { [k: string]: number }
|
||||
name = replaceRecursive(name, /\bObject\.?<([^,]*), *([^>]*)>/gi, function($0, $1, $2) {
|
||||
return "{ [k: " + $1 + "]: " + $2 + " }";
|
||||
});
|
||||
|
||||
// Replace functions (there are no signatures) with Function
|
||||
name = name.replace(/\bfunction(?:\(\))?\b/g, "Function");
|
||||
|
||||
// Convert plain Object back to just object
|
||||
name = name.replace(/\b(Object\b(?!\.))/g, function($0, $1) {
|
||||
return $1.toLowerCase();
|
||||
});
|
||||
|
||||
return name;
|
||||
}
|
||||
|
||||
// begins writing the definition of the specified element
|
||||
function begin(element, is_interface) {
|
||||
if (!seen[element.longname]) {
|
||||
if (isClass(element)) {
|
||||
var comment = parseComment(element.comment);
|
||||
var classdesc = comment.tags.find(function(tag) { return tag.name === "classdesc"; });
|
||||
if (classdesc) {
|
||||
comment.text = classdesc.text;
|
||||
comment.tags = [];
|
||||
}
|
||||
writeComment(comment, true);
|
||||
} else
|
||||
writeComment(element.comment, is_interface || isClassLike(element) || isNamespace(element) || element.isEnum || element.scope === "global");
|
||||
seen[element.longname] = element;
|
||||
} else
|
||||
writeln();
|
||||
if (element.scope !== "global" || options.module)
|
||||
return;
|
||||
write("export ");
|
||||
}
|
||||
|
||||
// writes the function signature describing element
|
||||
function writeFunctionSignature(element, isConstructor, isTypeDef) {
|
||||
write("(");
|
||||
|
||||
var params = {};
|
||||
|
||||
// this type
|
||||
if (element.this)
|
||||
params["this"] = {
|
||||
type: element.this.replace(/^{|}$/g, ""),
|
||||
optional: false
|
||||
};
|
||||
|
||||
// parameter types
|
||||
if (element.params)
|
||||
element.params.forEach(function(param) {
|
||||
var path = param.name.split(/\./g);
|
||||
if (path.length === 1)
|
||||
params[param.name] = {
|
||||
type: getTypeOf(param),
|
||||
variable: param.variable === true,
|
||||
optional: param.optional === true,
|
||||
defaultValue: param.defaultvalue // Not used yet (TODO)
|
||||
};
|
||||
else // Property syntax (TODO)
|
||||
params[path[0]].type = "{ [k: string]: any }";
|
||||
});
|
||||
|
||||
var paramNames = Object.keys(params);
|
||||
paramNames.forEach(function(name, i) {
|
||||
var param = params[name];
|
||||
var type = param.type;
|
||||
if (param.variable) {
|
||||
name = "..." + name;
|
||||
type = param.type.charAt(0) === "(" ? "any[]" : param.type + "[]";
|
||||
}
|
||||
write(name, !param.variable && param.optional ? "?: " : ": ", type);
|
||||
if (i < paramNames.length - 1)
|
||||
write(", ");
|
||||
});
|
||||
|
||||
write(")");
|
||||
|
||||
// return type
|
||||
if (!isConstructor) {
|
||||
write(isTypeDef ? " => " : ": ");
|
||||
var typeName;
|
||||
if (element.returns && element.returns.length && (typeName = getTypeOf(element.returns[0])) !== "undefined")
|
||||
write(typeName);
|
||||
else
|
||||
write("void");
|
||||
}
|
||||
}
|
||||
|
||||
// writes (a typedef as) an interface
|
||||
function writeInterface(element) {
|
||||
write("interface ", element.name);
|
||||
writeInterfaceBody(element);
|
||||
writeln();
|
||||
}
|
||||
|
||||
function writeInterfaceBody(element) {
|
||||
writeln("{");
|
||||
++indent;
|
||||
if (element.tsType)
|
||||
writeln(element.tsType.replace(/\r?\n|\r/g, "\n"));
|
||||
else if (element.properties && element.properties.length)
|
||||
element.properties.forEach(writeProperty);
|
||||
--indent;
|
||||
write("}");
|
||||
}
|
||||
|
||||
function writeProperty(property, declare) {
|
||||
writeComment(property.description);
|
||||
if (declare)
|
||||
write("let ");
|
||||
write(property.name);
|
||||
if (property.optional)
|
||||
write("?");
|
||||
writeln(": ", getTypeOf(property), ";");
|
||||
}
|
||||
|
||||
//
|
||||
// Handlers
|
||||
//
|
||||
|
||||
// handles a single element of any understood type
|
||||
function handleElement(element, parent) {
|
||||
if (element.scope === "inner")
|
||||
return false;
|
||||
|
||||
if (element.optional !== true && element.type && element.type.names && element.type.names.length) {
|
||||
for (var i = 0; i < element.type.names.length; i++) {
|
||||
if (element.type.names[i].toLowerCase() === "undefined") {
|
||||
// This element is actually optional. Set optional to true and
|
||||
// remove the 'undefined' type
|
||||
element.optional = true;
|
||||
element.type.names.splice(i, 1);
|
||||
i--;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (seen[element.longname])
|
||||
return true;
|
||||
if (isClassLike(element))
|
||||
handleClass(element, parent);
|
||||
else switch (element.kind) {
|
||||
case "module":
|
||||
case "namespace":
|
||||
handleNamespace(element, parent);
|
||||
break;
|
||||
case "constant":
|
||||
case "member":
|
||||
handleMember(element, parent);
|
||||
break;
|
||||
case "function":
|
||||
handleFunction(element, parent);
|
||||
break;
|
||||
case "typedef":
|
||||
handleTypeDef(element, parent);
|
||||
break;
|
||||
case "package":
|
||||
break;
|
||||
}
|
||||
seen[element.longname] = element;
|
||||
return true;
|
||||
}
|
||||
|
||||
// handles (just) a namespace
|
||||
function handleNamespace(element/*, parent*/) {
|
||||
var children = getChildrenOf(element);
|
||||
if (!children.length)
|
||||
return;
|
||||
var first = true;
|
||||
if (element.properties)
|
||||
element.properties.forEach(function(property) {
|
||||
if (!/^[$\w]+$/.test(property.name)) // incompatible in namespace
|
||||
return;
|
||||
if (first) {
|
||||
begin(element);
|
||||
writeln("namespace ", element.name, " {");
|
||||
++indent;
|
||||
first = false;
|
||||
}
|
||||
writeProperty(property, true);
|
||||
});
|
||||
children.forEach(function(child) {
|
||||
if (child.scope === "inner" || seen[child.longname])
|
||||
return;
|
||||
if (first) {
|
||||
begin(element);
|
||||
writeln("namespace ", element.name, " {");
|
||||
++indent;
|
||||
first = false;
|
||||
}
|
||||
handleElement(child, element);
|
||||
});
|
||||
if (!first) {
|
||||
--indent;
|
||||
writeln("}");
|
||||
}
|
||||
}
|
||||
|
||||
// a filter function to remove any module references
|
||||
function notAModuleReference(ref) {
|
||||
return ref.indexOf("module:") === -1;
|
||||
}
|
||||
|
||||
// handles a class or class-like
|
||||
function handleClass(element, parent) {
|
||||
var is_interface = isInterface(element);
|
||||
begin(element, is_interface);
|
||||
if (is_interface)
|
||||
write("interface ");
|
||||
else {
|
||||
if (element.virtual)
|
||||
write("abstract ");
|
||||
write("class ");
|
||||
}
|
||||
write(element.name);
|
||||
if (element.templates && element.templates.length)
|
||||
write("<", element.templates.join(", "), ">");
|
||||
write(" ");
|
||||
|
||||
// extended classes
|
||||
if (element.augments) {
|
||||
var augments = element.augments.filter(notAModuleReference);
|
||||
if (augments.length)
|
||||
write("extends ", augments[0], " ");
|
||||
}
|
||||
|
||||
// implemented interfaces
|
||||
var impls = [];
|
||||
if (element.implements)
|
||||
Array.prototype.push.apply(impls, element.implements);
|
||||
if (element.mixes)
|
||||
Array.prototype.push.apply(impls, element.mixes);
|
||||
impls = impls.filter(notAModuleReference);
|
||||
if (impls.length)
|
||||
write("implements ", impls.join(", "), " ");
|
||||
|
||||
writeln("{");
|
||||
++indent;
|
||||
|
||||
if (element.tsType)
|
||||
writeln(element.tsType.replace(/\r?\n|\r/g, "\n"));
|
||||
|
||||
// constructor
|
||||
if (!is_interface && !element.virtual)
|
||||
handleFunction(element, parent, true);
|
||||
|
||||
// properties
|
||||
if (is_interface && element.properties)
|
||||
element.properties.forEach(function(property) {
|
||||
writeProperty(property);
|
||||
});
|
||||
|
||||
// class-compatible members
|
||||
var incompatible = [];
|
||||
getChildrenOf(element).forEach(function(child) {
|
||||
if (isClassLike(child) || child.kind === "module" || child.kind === "typedef" || child.isEnum) {
|
||||
incompatible.push(child);
|
||||
return;
|
||||
}
|
||||
handleElement(child, element);
|
||||
});
|
||||
|
||||
--indent;
|
||||
writeln("}");
|
||||
|
||||
// class-incompatible members
|
||||
if (incompatible.length) {
|
||||
writeln();
|
||||
if (element.scope === "global" && !options.module)
|
||||
write("export ");
|
||||
writeln("namespace ", element.name, " {");
|
||||
++indent;
|
||||
incompatible.forEach(function(child) {
|
||||
handleElement(child, element);
|
||||
});
|
||||
--indent;
|
||||
writeln("}");
|
||||
}
|
||||
}
|
||||
|
||||
// handles a namespace or class member
|
||||
function handleMember(element, parent) {
|
||||
begin(element);
|
||||
|
||||
if (element.isEnum) {
|
||||
var stringEnum = false;
|
||||
element.properties.forEach(function(property) {
|
||||
if (isNaN(property.defaultvalue)) {
|
||||
stringEnum = true;
|
||||
}
|
||||
});
|
||||
if (stringEnum) {
|
||||
writeln("type ", element.name, " =");
|
||||
++indent;
|
||||
element.properties.forEach(function(property, i) {
|
||||
write(i === 0 ? "" : "| ", JSON.stringify(property.defaultvalue));
|
||||
});
|
||||
--indent;
|
||||
writeln(";");
|
||||
} else {
|
||||
writeln("enum ", element.name, " {");
|
||||
++indent;
|
||||
element.properties.forEach(function(property, i) {
|
||||
write(property.name);
|
||||
if (property.defaultvalue !== undefined)
|
||||
write(" = ", JSON.stringify(property.defaultvalue));
|
||||
if (i < element.properties.length - 1)
|
||||
writeln(",");
|
||||
else
|
||||
writeln();
|
||||
});
|
||||
--indent;
|
||||
writeln("}");
|
||||
}
|
||||
|
||||
} else {
|
||||
|
||||
var inClass = isClassLike(parent);
|
||||
if (inClass) {
|
||||
write(element.access || "public", " ");
|
||||
if (element.scope === "static")
|
||||
write("static ");
|
||||
if (element.readonly)
|
||||
write("readonly ");
|
||||
} else
|
||||
write(element.kind === "constant" ? "const " : "let ");
|
||||
|
||||
write(element.name);
|
||||
if (element.optional)
|
||||
write("?");
|
||||
write(": ");
|
||||
|
||||
if (element.type && element.type.names && /^Object\b/i.test(element.type.names[0]) && element.properties) {
|
||||
writeln("{");
|
||||
++indent;
|
||||
element.properties.forEach(function(property, i) {
|
||||
writeln(JSON.stringify(property.name), ": ", getTypeOf(property), i < element.properties.length - 1 ? "," : "");
|
||||
});
|
||||
--indent;
|
||||
writeln("};");
|
||||
} else
|
||||
writeln(getTypeOf(element), ";");
|
||||
}
|
||||
}
|
||||
|
||||
// handles a function or method
|
||||
function handleFunction(element, parent, isConstructor) {
|
||||
var insideClass = true;
|
||||
if (isConstructor) {
|
||||
writeComment(element.comment);
|
||||
write("constructor");
|
||||
} else {
|
||||
begin(element);
|
||||
insideClass = isClassLike(parent);
|
||||
if (insideClass) {
|
||||
write(element.access || "public", " ");
|
||||
if (element.scope === "static")
|
||||
write("static ");
|
||||
} else
|
||||
write("function ");
|
||||
write(element.name);
|
||||
if (element.templates && element.templates.length)
|
||||
write("<", element.templates.join(", "), ">");
|
||||
}
|
||||
writeFunctionSignature(element, isConstructor, false);
|
||||
writeln(";");
|
||||
if (!insideClass)
|
||||
handleNamespace(element);
|
||||
}
|
||||
|
||||
// handles a type definition (not a real type)
|
||||
function handleTypeDef(element, parent) {
|
||||
if (isInterface(element)) {
|
||||
if (isClassLike(parent))
|
||||
queuedInterfaces.push(element);
|
||||
else {
|
||||
begin(element);
|
||||
writeInterface(element);
|
||||
}
|
||||
} else {
|
||||
writeComment(element.comment, true);
|
||||
write("type ", element.name);
|
||||
if (element.templates && element.templates.length)
|
||||
write("<", element.templates.join(", "), ">");
|
||||
write(" = ");
|
||||
if (element.tsType)
|
||||
write(element.tsType.replace(/\r?\n|\r/g, "\n"));
|
||||
else {
|
||||
var type = getTypeOf(element);
|
||||
if (element.type && element.type.names.length === 1 && element.type.names[0] === "function")
|
||||
writeFunctionSignature(element, false, true);
|
||||
else if (type === "object") {
|
||||
if (element.properties && element.properties.length)
|
||||
writeInterfaceBody(element);
|
||||
else
|
||||
write("{}");
|
||||
} else
|
||||
write(type);
|
||||
}
|
||||
writeln(";");
|
||||
}
|
||||
}
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"version": "6.7.0",
|
||||
"lockfileVersion": 1,
|
||||
"requires": true,
|
||||
"dependencies": {
|
||||
"os-tmpdir": {
|
||||
"version": "1.0.2",
|
||||
"resolved": "https://registry.npmjs.org/os-tmpdir/-/os-tmpdir-1.0.2.tgz",
|
||||
"integrity": "sha1-u+Z0BseaqFxc/sdm/lc0VV36EnQ="
|
||||
},
|
||||
"tmp": {
|
||||
"version": "0.0.33",
|
||||
"resolved": "https://registry.npmjs.org/tmp/-/tmp-0.0.33.tgz",
|
||||
"integrity": "sha512-jRCJlojKnZ3addtTOjdIqoRuPEKBvNXcGYqzO6zWZX8KfKEpnGY5jfggJQ3EjKuu8D4bJRr0y+cYJFmYbImXGw==",
|
||||
"requires": {
|
||||
"os-tmpdir": "1.0.2"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Executable
+1
@@ -0,0 +1 @@
|
||||
{"version": "6.7.0"}
|
||||
+32
@@ -0,0 +1,32 @@
|
||||
{
|
||||
"name": "protobufjs-cli",
|
||||
"description": "Translates between file formats and generates static code as well as TypeScript definitions.",
|
||||
"version": "6.7.0",
|
||||
"author": "Daniel Wirtz <[email protected]>",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/dcodeIO/protobuf.js.git"
|
||||
},
|
||||
"license": "BSD-3-Clause",
|
||||
"main": "index.js",
|
||||
"types": "index.d.ts",
|
||||
"bin": {
|
||||
"pbjs": "bin/pbjs",
|
||||
"pbts": "bin/pbts"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"protobufjs": "~6.7.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"chalk": "^1.1.3",
|
||||
"escodegen": "^1.8.1",
|
||||
"espree": "^3.1.3",
|
||||
"estraverse": "^4.2.0",
|
||||
"glob": "^7.1.1",
|
||||
"jsdoc": "^3.4.2",
|
||||
"minimist": "^1.2.0",
|
||||
"semver": "^5.3.0",
|
||||
"tmp": "0.0.31",
|
||||
"uglify-js": "^2.8.15"
|
||||
}
|
||||
}
|
||||
+9
@@ -0,0 +1,9 @@
|
||||
type pbjsCallback = (err: Error|null, output?: string) => void;
|
||||
|
||||
/**
|
||||
* Runs pbjs programmatically.
|
||||
* @param {string[]} args Command line arguments
|
||||
* @param {function(?Error, string=)} [callback] Optional completion callback
|
||||
* @returns {number|undefined} Exit code, if known
|
||||
*/
|
||||
export function main(args: string[], callback?: pbjsCallback): number|undefined;
|
||||
Executable
+329
@@ -0,0 +1,329 @@
|
||||
"use strict";
|
||||
var path = require("path"),
|
||||
fs = require("fs"),
|
||||
pkg = require("./package.json"),
|
||||
util = require("./util");
|
||||
|
||||
util.setup();
|
||||
|
||||
var protobuf = require(util.pathToProtobufJs),
|
||||
minimist = require("minimist"),
|
||||
chalk = require("chalk"),
|
||||
glob = require("glob");
|
||||
|
||||
var targets = util.requireAll("./targets");
|
||||
|
||||
/**
|
||||
* Runs pbjs programmatically.
|
||||
* @param {string[]} args Command line arguments
|
||||
* @param {function(?Error, string=)} [callback] Optional completion callback
|
||||
* @returns {number|undefined} Exit code, if known
|
||||
*/
|
||||
exports.main = function main(args, callback) {
|
||||
var lintDefault = "eslint-disable " + [
|
||||
"block-scoped-var",
|
||||
"id-length",
|
||||
"no-control-regex",
|
||||
"no-magic-numbers",
|
||||
"no-prototype-builtins",
|
||||
"no-redeclare",
|
||||
"no-shadow",
|
||||
"no-var",
|
||||
"sort-vars"
|
||||
].join(", ");
|
||||
var argv = minimist(args, {
|
||||
alias: {
|
||||
target: "t",
|
||||
out: "o",
|
||||
path: "p",
|
||||
wrap: "w",
|
||||
root: "r",
|
||||
lint: "l",
|
||||
// backward compatibility:
|
||||
"force-long": "strict-long",
|
||||
"force-message": "strict-message"
|
||||
},
|
||||
string: [ "target", "out", "path", "wrap", "dependency", "root", "lint" ],
|
||||
boolean: [ "create", "encode", "decode", "verify", "convert", "delimited", "beautify", "comments", "es6", "sparse", "keep-case", "force-long", "force-number", "force-enum-string", "force-message" ],
|
||||
default: {
|
||||
target: "json",
|
||||
create: true,
|
||||
encode: true,
|
||||
decode: true,
|
||||
verify: true,
|
||||
convert: true,
|
||||
delimited: true,
|
||||
beautify: true,
|
||||
comments: true,
|
||||
es6: null,
|
||||
lint: lintDefault,
|
||||
"keep-case": false,
|
||||
"force-long": false,
|
||||
"force-number": false,
|
||||
"force-enum-string": false,
|
||||
"force-message": false
|
||||
}
|
||||
});
|
||||
|
||||
var target = targets[argv.target],
|
||||
files = argv._,
|
||||
paths = typeof argv.path === "string" ? [ argv.path ] : argv.path || [];
|
||||
|
||||
// alias hyphen args in camel case
|
||||
Object.keys(argv).forEach(function(key) {
|
||||
var camelKey = key.replace(/-([a-z])/g, function($0, $1) { return $1.toUpperCase(); });
|
||||
if (camelKey !== key)
|
||||
argv[camelKey] = argv[key];
|
||||
});
|
||||
|
||||
// protobuf.js package directory contains additional, otherwise non-bundled google types
|
||||
paths.push(path.relative(process.cwd(), path.join(__dirname, "..")) || ".");
|
||||
|
||||
if (!files.length) {
|
||||
var descs = Object.keys(targets).filter(function(key) { return !targets[key].private; }).map(function(key) {
|
||||
return " " + util.pad(key, 14, true) + targets[key].description;
|
||||
});
|
||||
if (callback)
|
||||
callback(Error("usage")); // eslint-disable-line callback-return
|
||||
else
|
||||
process.stderr.write([
|
||||
"protobuf.js v" + pkg.version + " CLI for JavaScript",
|
||||
"",
|
||||
chalk.bold.white("Translates between file formats and generates static code."),
|
||||
"",
|
||||
" -t, --target Specifies the target format. Also accepts a path to require a custom target.",
|
||||
"",
|
||||
descs.join("\n"),
|
||||
"",
|
||||
" -p, --path Adds a directory to the include path.",
|
||||
"",
|
||||
" -o, --out Saves to a file instead of writing to stdout.",
|
||||
"",
|
||||
" --sparse Exports only those types referenced from a main file (experimental).",
|
||||
"",
|
||||
chalk.bold.gray(" Module targets only:"),
|
||||
"",
|
||||
" -w, --wrap Specifies the wrapper to use. Also accepts a path to require a custom wrapper.",
|
||||
"",
|
||||
" default Default wrapper supporting both CommonJS and AMD",
|
||||
" commonjs CommonJS wrapper",
|
||||
" amd AMD wrapper",
|
||||
" es6 ES6 wrapper (implies --es6)",
|
||||
" closure A closure adding to protobuf.roots where protobuf is a global",
|
||||
"",
|
||||
" --dependency Specifies which version of protobuf to require. Accepts any valid module id",
|
||||
"",
|
||||
" -r, --root Specifies an alternative protobuf.roots name.",
|
||||
"",
|
||||
" -l, --lint Linter configuration. Defaults to protobuf.js-compatible rules:",
|
||||
"",
|
||||
" " + lintDefault,
|
||||
"",
|
||||
" --es6 Enables ES6 syntax (const/let instead of var)",
|
||||
"",
|
||||
chalk.bold.gray(" Proto sources only:"),
|
||||
"",
|
||||
" --keep-case Keeps field casing instead of converting to camel case.",
|
||||
"",
|
||||
chalk.bold.gray(" Static targets only:"),
|
||||
"",
|
||||
" --no-create Does not generate create functions used for reflection compatibility.",
|
||||
" --no-encode Does not generate encode functions.",
|
||||
" --no-decode Does not generate decode functions.",
|
||||
" --no-verify Does not generate verify functions.",
|
||||
" --no-convert Does not generate convert functions like from/toObject",
|
||||
" --no-delimited Does not generate delimited encode/decode functions.",
|
||||
" --no-beautify Does not beautify generated code.",
|
||||
" --no-comments Does not output any JSDoc comments.",
|
||||
"",
|
||||
" --force-long Enfores the use of 'Long' for s-/u-/int64 and s-/fixed64 fields.",
|
||||
" --force-number Enfores the use of 'number' for s-/u-/int64 and s-/fixed64 fields.",
|
||||
" --force-message Enfores the use of message instances instead of plain objects.",
|
||||
"",
|
||||
"usage: " + chalk.bold.green("pbjs") + " [options] file1.proto file2.json ..." + chalk.gray(" (or pipe) ") + "other | " + chalk.bold.green("pbjs") + " [options] -",
|
||||
""
|
||||
].join("\n"));
|
||||
return 1;
|
||||
}
|
||||
|
||||
if (typeof argv["strict-long"] === "boolean")
|
||||
argv["force-long"] = argv["strict-long"];
|
||||
|
||||
// Resolve glob expressions
|
||||
for (var i = 0; i < files.length;) {
|
||||
if (glob.hasMagic(files[i])) {
|
||||
var matches = glob.sync(files[i]);
|
||||
Array.prototype.splice.apply(files, [i, 1].concat(matches));
|
||||
i += matches.length;
|
||||
} else
|
||||
++i;
|
||||
}
|
||||
|
||||
// Require custom target
|
||||
if (!target)
|
||||
target = require(path.resolve(process.cwd(), argv.target));
|
||||
|
||||
var root = new protobuf.Root();
|
||||
|
||||
var mainFiles = [];
|
||||
|
||||
// Search include paths when resolving imports
|
||||
root.resolvePath = function pbjsResolvePath(origin, target) {
|
||||
var normOrigin = protobuf.util.path.normalize(origin),
|
||||
normTarget = protobuf.util.path.normalize(target);
|
||||
if (!normOrigin)
|
||||
mainFiles.push(normTarget);
|
||||
|
||||
var resolved = protobuf.util.path.resolve(normOrigin, normTarget, true);
|
||||
var idx = resolved.lastIndexOf("google/protobuf/");
|
||||
if (idx > -1) {
|
||||
var altname = resolved.substring(idx);
|
||||
if (altname in protobuf.common)
|
||||
resolved = altname;
|
||||
}
|
||||
|
||||
if (fs.existsSync(resolved))
|
||||
return resolved;
|
||||
|
||||
for (var i = 0; i < paths.length; ++i) {
|
||||
var iresolved = protobuf.util.path.resolve(paths[i] + "/", target);
|
||||
if (fs.existsSync(iresolved))
|
||||
return iresolved;
|
||||
}
|
||||
|
||||
return resolved;
|
||||
};
|
||||
|
||||
// Use es6 syntax if not explicitly specified on the command line and the es6 wrapper is used
|
||||
if (argv.wrap === "es6" || argv.es6) {
|
||||
argv.wrap = "es6";
|
||||
argv.es6 = true;
|
||||
}
|
||||
|
||||
var parseOptions = {
|
||||
"keepCase": argv["keep-case"] || false
|
||||
};
|
||||
|
||||
// Read from stdin
|
||||
if (files.length === 1 && files[0] === "-") {
|
||||
var data = [];
|
||||
process.stdin.on("data", function(chunk) {
|
||||
data.push(chunk);
|
||||
});
|
||||
process.stdin.on("end", function() {
|
||||
var source = Buffer.concat(data).toString("utf8");
|
||||
try {
|
||||
if (source.charAt(0) !== "{") {
|
||||
protobuf.parse.filename = "-";
|
||||
protobuf.parse(source, root, parseOptions);
|
||||
} else {
|
||||
var json = JSON.parse(source);
|
||||
root.setOptions(json.options).addJSON(json);
|
||||
}
|
||||
callTarget();
|
||||
} catch (err) {
|
||||
if (callback) {
|
||||
callback(err);
|
||||
return;
|
||||
}
|
||||
throw err;
|
||||
}
|
||||
});
|
||||
|
||||
// Load from disk
|
||||
} else {
|
||||
try {
|
||||
root.loadSync(files, parseOptions).resolveAll(); // sync is deterministic while async is not
|
||||
if (argv.sparse)
|
||||
sparsify(root);
|
||||
callTarget();
|
||||
} catch (err) {
|
||||
if (callback) {
|
||||
callback(err);
|
||||
return undefined;
|
||||
}
|
||||
throw err;
|
||||
}
|
||||
}
|
||||
|
||||
function markReferenced(tobj) {
|
||||
tobj.referenced = true;
|
||||
// also mark a type's fields and oneofs
|
||||
if (tobj.fieldsArray)
|
||||
tobj.fieldsArray.forEach(function(fobj) {
|
||||
fobj.referenced = true;
|
||||
});
|
||||
if (tobj.oneofsArray)
|
||||
tobj.oneofsArray.forEach(function(oobj) {
|
||||
oobj.referenced = true;
|
||||
});
|
||||
// also mark an extension field's extended type, but not its (other) fields
|
||||
if (tobj.extensionField)
|
||||
tobj.extensionField.parent.referenced = true;
|
||||
}
|
||||
|
||||
function sparsify(root) {
|
||||
|
||||
// 1. mark directly or indirectly referenced objects
|
||||
util.traverse(root, function(obj) {
|
||||
if (!obj.filename)
|
||||
return;
|
||||
if (mainFiles.indexOf(obj.filename) > -1)
|
||||
util.traverseResolved(obj, markReferenced);
|
||||
});
|
||||
|
||||
// 2. empty unreferenced objects
|
||||
util.traverse(root, function(obj) {
|
||||
var parent = obj.parent;
|
||||
if (!parent || obj.referenced) // root or referenced
|
||||
return;
|
||||
// remove unreferenced namespaces
|
||||
if (obj instanceof protobuf.Namespace) {
|
||||
var hasReferenced = false;
|
||||
util.traverse(obj, function(iobj) {
|
||||
if (iobj.referenced)
|
||||
hasReferenced = true;
|
||||
});
|
||||
if (hasReferenced) { // replace with plain namespace if a namespace subclass
|
||||
if (obj instanceof protobuf.Type || obj instanceof protobuf.Service) {
|
||||
var robj = new protobuf.Namespace(obj.name, obj.options);
|
||||
robj.nested = obj.nested;
|
||||
parent.add(robj);
|
||||
}
|
||||
} else // remove completely if nothing inside is referenced
|
||||
parent.remove(obj);
|
||||
|
||||
// remove everything else unreferenced
|
||||
} else if (!(obj instanceof protobuf.Namespace))
|
||||
parent.remove(obj);
|
||||
});
|
||||
|
||||
// 3. validate that everything is fine
|
||||
root.resolveAll();
|
||||
}
|
||||
|
||||
function callTarget() {
|
||||
target(root, argv, function targetCallback(err, output) {
|
||||
if (err) {
|
||||
if (callback)
|
||||
return callback(err);
|
||||
throw err;
|
||||
}
|
||||
try {
|
||||
if (argv.out)
|
||||
fs.writeFileSync(argv.out, output, { encoding: "utf8" });
|
||||
else if (!callback)
|
||||
process.stdout.write(output, "utf8");
|
||||
return callback
|
||||
? callback(null, output)
|
||||
: undefined;
|
||||
} catch (err) {
|
||||
if (callback)
|
||||
return callback(err);
|
||||
throw err;
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
return undefined;
|
||||
};
|
||||
+9
@@ -0,0 +1,9 @@
|
||||
type pbtsCallback = (err: Error|null, output?: string) => void;
|
||||
|
||||
/**
|
||||
* Runs pbts programmatically.
|
||||
* @param {string[]} args Command line arguments
|
||||
* @param {function(?Error, string=)} [callback] Optional completion callback
|
||||
* @returns {number|undefined} Exit code, if known
|
||||
*/
|
||||
export function main(args: string[], callback?: pbtsCallback): number|undefined;
|
||||
Executable
+197
@@ -0,0 +1,197 @@
|
||||
"use strict";
|
||||
var child_process = require("child_process"),
|
||||
path = require("path"),
|
||||
fs = require("fs"),
|
||||
pkg = require("./package.json"),
|
||||
util = require("./util");
|
||||
|
||||
util.setup();
|
||||
|
||||
var minimist = require("minimist"),
|
||||
chalk = require("chalk"),
|
||||
glob = require("glob"),
|
||||
tmp = require("tmp");
|
||||
|
||||
/**
|
||||
* Runs pbts programmatically.
|
||||
* @param {string[]} args Command line arguments
|
||||
* @param {function(?Error, string=)} [callback] Optional completion callback
|
||||
* @returns {number|undefined} Exit code, if known
|
||||
*/
|
||||
exports.main = function(args, callback) {
|
||||
var argv = minimist(args, {
|
||||
alias: {
|
||||
name: "n",
|
||||
out : "o",
|
||||
main: "m",
|
||||
global: "g",
|
||||
import: "i"
|
||||
},
|
||||
string: [ "name", "out", "global", "import" ],
|
||||
boolean: [ "comments", "main" ],
|
||||
default: {
|
||||
comments: true,
|
||||
main: false
|
||||
}
|
||||
});
|
||||
|
||||
var files = argv._;
|
||||
|
||||
if (!files.length) {
|
||||
if (callback)
|
||||
callback(Error("usage")); // eslint-disable-line callback-return
|
||||
else
|
||||
process.stderr.write([
|
||||
"protobuf.js v" + pkg.version + " CLI for TypeScript",
|
||||
"",
|
||||
chalk.bold.white("Generates TypeScript definitions from annotated JavaScript files."),
|
||||
"",
|
||||
" -o, --out Saves to a file instead of writing to stdout.",
|
||||
"",
|
||||
" -g, --global Name of the global object in browser environments, if any.",
|
||||
"",
|
||||
" -i, --import Comma delimited list of imports. Local names will equal camelCase of the basename.",
|
||||
"",
|
||||
" --no-comments Does not output any JSDoc comments.",
|
||||
"",
|
||||
chalk.bold.gray(" Internal flags:"),
|
||||
"",
|
||||
" -n, --name Wraps everything in a module of the specified name.",
|
||||
"",
|
||||
" -m, --main Whether building the main library without any imports.",
|
||||
"",
|
||||
"usage: " + chalk.bold.green("pbts") + " [options] file1.js file2.js ..." + chalk.bold.gray(" (or) ") + "other | " + chalk.bold.green("pbts") + " [options] -",
|
||||
""
|
||||
].join("\n"));
|
||||
return 1;
|
||||
}
|
||||
|
||||
// Resolve glob expressions
|
||||
for (var i = 0; i < files.length;) {
|
||||
if (glob.hasMagic(files[i])) {
|
||||
var matches = glob.sync(files[i]);
|
||||
Array.prototype.splice.apply(files, [i, 1].concat(matches));
|
||||
i += matches.length;
|
||||
} else
|
||||
++i;
|
||||
}
|
||||
|
||||
var cleanup = [];
|
||||
|
||||
// Read from stdin (to a temporary file)
|
||||
if (files.length === 1 && files[0] === "-") {
|
||||
var data = [];
|
||||
process.stdin.on("data", function(chunk) {
|
||||
data.push(chunk);
|
||||
});
|
||||
process.stdin.on("end", function() {
|
||||
files[0] = tmp.tmpNameSync() + ".js";
|
||||
fs.writeFileSync(files[0], Buffer.concat(data));
|
||||
cleanup.push(files[0]);
|
||||
callJsdoc();
|
||||
});
|
||||
|
||||
// Load from disk
|
||||
} else {
|
||||
callJsdoc();
|
||||
}
|
||||
|
||||
function callJsdoc() {
|
||||
|
||||
// There is no proper API for jsdoc, so this executes the CLI and pipes the output
|
||||
var basedir = path.join(__dirname, ".");
|
||||
var moduleName = argv.name || "null";
|
||||
var nodePath = process.execPath;
|
||||
var cmd = "\"" + nodePath + "\" \"" + require.resolve("jsdoc/jsdoc.js") + "\" -c \"" + path.join(basedir, "lib", "tsd-jsdoc.json") + "\" -q \"module=" + encodeURIComponent(moduleName) + "&comments=" + Boolean(argv.comments) + "\" " + files.map(function(file) { return "\"" + file + "\""; }).join(" ");
|
||||
var child = child_process.exec(cmd, {
|
||||
cwd: process.cwd(),
|
||||
argv0: "node",
|
||||
stdio: "pipe",
|
||||
maxBuffer: 1 << 24 // 16mb
|
||||
});
|
||||
var out = [];
|
||||
var ended = false;
|
||||
var closed = false;
|
||||
child.stdout.on("data", function(data) {
|
||||
out.push(data);
|
||||
});
|
||||
child.stdout.on("end", function() {
|
||||
if (closed) finish();
|
||||
else ended = true;
|
||||
});
|
||||
child.stderr.pipe(process.stderr);
|
||||
child.on("close", function(code) {
|
||||
// clean up temporary files, no matter what
|
||||
try { cleanup.forEach(fs.unlinkSync); } catch(e) {/**/} cleanup = [];
|
||||
|
||||
if (code) {
|
||||
out = out.join("").replace(/\s*JSDoc \d+\.\d+\.\d+ [^$]+/, "");
|
||||
process.stderr.write(out);
|
||||
var err = Error("code " + code);
|
||||
if (callback)
|
||||
return callback(err);
|
||||
throw err;
|
||||
}
|
||||
|
||||
if (ended) return finish();
|
||||
closed = true;
|
||||
return undefined;
|
||||
});
|
||||
|
||||
function getImportName(importItem) {
|
||||
return path.basename(importItem, ".js").replace(/([-_~.+]\w)/g, function(match) {
|
||||
return match[1].toUpperCase();
|
||||
});
|
||||
}
|
||||
|
||||
function finish() {
|
||||
var output = [];
|
||||
if (argv.main)
|
||||
output.push(
|
||||
"// DO NOT EDIT! This is a generated file. Edit the JSDoc in src/*.js instead and run 'npm run types'.",
|
||||
""
|
||||
);
|
||||
if (argv.global)
|
||||
output.push(
|
||||
"export as namespace " + argv.global + ";",
|
||||
""
|
||||
);
|
||||
|
||||
if (!argv.main) {
|
||||
// Ensure we have a usable array of imports
|
||||
var importArray = typeof argv.import === "string" ? argv.import.split(",") : argv.import || [];
|
||||
|
||||
// Build an object of imports and paths
|
||||
var imports = {
|
||||
$protobuf: "protobufjs"
|
||||
};
|
||||
importArray.forEach(function(importItem) {
|
||||
imports[getImportName(importItem)] = importItem;
|
||||
});
|
||||
|
||||
// Write out the imports
|
||||
Object.keys(imports).forEach(function(key) {
|
||||
output.push("import * as " + key + " from \"" + imports[key] + "\";");
|
||||
});
|
||||
}
|
||||
|
||||
output = output.join("\n") + "\n" + out.join("");
|
||||
|
||||
try {
|
||||
if (argv.out)
|
||||
fs.writeFileSync(argv.out, output, { encoding: "utf8" });
|
||||
else if (!callback)
|
||||
process.stdout.write(output, "utf8");
|
||||
return callback
|
||||
? callback(null, output)
|
||||
: undefined;
|
||||
} catch (err) {
|
||||
if (callback)
|
||||
return callback(err);
|
||||
throw err;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return undefined;
|
||||
};
|
||||
+38
@@ -0,0 +1,38 @@
|
||||
"use strict";
|
||||
module.exports = json_module;
|
||||
|
||||
var util = require("../util");
|
||||
|
||||
var protobuf = require("../..");
|
||||
|
||||
json_module.description = "JSON representation as a module";
|
||||
|
||||
function jsonSafeProp(json) {
|
||||
return json.replace(/^( +)"(\w+)":/mg, function($0, $1, $2) {
|
||||
return protobuf.util.safeProp($2).charAt(0) === "."
|
||||
? $1 + $2 + ":"
|
||||
: $0;
|
||||
});
|
||||
}
|
||||
|
||||
function json_module(root, options, callback) {
|
||||
try {
|
||||
var rootProp = protobuf.util.safeProp(options.root || "default");
|
||||
var output = [
|
||||
(options.es6 ? "const" : "var") + " $root = ($protobuf.roots" + rootProp + " || ($protobuf.roots" + rootProp + " = new $protobuf.Root()))\n"
|
||||
];
|
||||
if (root.options) {
|
||||
var optionsJson = jsonSafeProp(JSON.stringify(root.options, null, 2));
|
||||
output.push(".setOptions(" + optionsJson + ")\n");
|
||||
}
|
||||
var json = jsonSafeProp(JSON.stringify(root.nested, null, 2).trim());
|
||||
output.push(".addJSON(" + json + ");");
|
||||
output = util.wrap(output.join(""), protobuf.util.merge({ dependency: "protobufjs/light" }, options));
|
||||
process.nextTick(function() {
|
||||
callback(null, output);
|
||||
});
|
||||
} catch (e) {
|
||||
return callback(e);
|
||||
}
|
||||
return undefined;
|
||||
}
|
||||
Executable
+8
@@ -0,0 +1,8 @@
|
||||
"use strict";
|
||||
module.exports = json_target;
|
||||
|
||||
json_target.description = "JSON representation";
|
||||
|
||||
function json_target(root, options, callback) {
|
||||
callback(null, JSON.stringify(root, null, 2));
|
||||
}
|
||||
Executable
+326
@@ -0,0 +1,326 @@
|
||||
"use strict";
|
||||
module.exports = proto_target;
|
||||
|
||||
proto_target.private = true;
|
||||
|
||||
var protobuf = require("../..");
|
||||
|
||||
var Namespace = protobuf.Namespace,
|
||||
Enum = protobuf.Enum,
|
||||
Type = protobuf.Type,
|
||||
Field = protobuf.Field,
|
||||
OneOf = protobuf.OneOf,
|
||||
Service = protobuf.Service,
|
||||
Method = protobuf.Method,
|
||||
types = protobuf.types,
|
||||
util = protobuf.util;
|
||||
|
||||
function underScore(str) {
|
||||
return str.substring(0,1)
|
||||
+ str.substring(1)
|
||||
.replace(/([A-Z])(?=[a-z]|$)/g, function($0, $1) { return "_" + $1.toLowerCase(); });
|
||||
}
|
||||
|
||||
var out = [];
|
||||
var indent = 0;
|
||||
var first = false;
|
||||
var syntax = 3;
|
||||
|
||||
function proto_target(root, options, callback) {
|
||||
if (options) {
|
||||
switch (options.syntax) {
|
||||
case undefined:
|
||||
case "proto3":
|
||||
case "3":
|
||||
syntax = 3;
|
||||
break;
|
||||
case "proto2":
|
||||
case "2":
|
||||
syntax = 2;
|
||||
break;
|
||||
default:
|
||||
return callback(Error("invalid syntax: " + options.syntax));
|
||||
}
|
||||
}
|
||||
indent = 0;
|
||||
first = false;
|
||||
try {
|
||||
buildRoot(root);
|
||||
return callback(null, out.join("\n"));
|
||||
} catch (err) {
|
||||
return callback(err);
|
||||
} finally {
|
||||
out = [];
|
||||
syntax = 3;
|
||||
}
|
||||
}
|
||||
|
||||
function push(line) {
|
||||
if (line === "")
|
||||
out.push("");
|
||||
else {
|
||||
var ind = "";
|
||||
for (var i = 0; i < indent; ++i)
|
||||
ind += " ";
|
||||
out.push(ind + line);
|
||||
}
|
||||
}
|
||||
|
||||
function escape(str) {
|
||||
return str.replace(/[\\"']/g, "\\$&")
|
||||
.replace(/\r/g, "\\r")
|
||||
.replace(/\n/g, "\\n")
|
||||
.replace(/\u0000/g, "\\0"); // eslint-disable-line no-control-regex
|
||||
}
|
||||
|
||||
function value(v) {
|
||||
switch (typeof v) {
|
||||
case "boolean":
|
||||
return v ? "true" : "false";
|
||||
case "number":
|
||||
return v.toString();
|
||||
default:
|
||||
return "\"" + escape(String(v)) + "\"";
|
||||
}
|
||||
}
|
||||
|
||||
function buildRoot(root) {
|
||||
root.resolveAll();
|
||||
var pkg = [];
|
||||
var ptr = root;
|
||||
var repeat = true;
|
||||
do {
|
||||
var nested = ptr.nestedArray;
|
||||
if (nested.length === 1 && nested[0] instanceof Namespace && !(nested[0] instanceof Type || nested[0] instanceof Service)) {
|
||||
ptr = nested[0];
|
||||
if (ptr !== root)
|
||||
pkg.push(ptr.name);
|
||||
} else
|
||||
repeat = false;
|
||||
} while (repeat);
|
||||
out.push("syntax = \"proto" + syntax + "\";");
|
||||
if (pkg.length)
|
||||
out.push("", "package " + pkg.join(".") + ";");
|
||||
|
||||
buildOptions(ptr);
|
||||
ptr.nestedArray.forEach(build);
|
||||
}
|
||||
|
||||
function build(object) {
|
||||
if (object instanceof Enum)
|
||||
buildEnum(object);
|
||||
else if (object instanceof Type)
|
||||
buildType(object);
|
||||
else if (object instanceof Field)
|
||||
buildField(object);
|
||||
else if (object instanceof OneOf)
|
||||
buildOneOf(object);
|
||||
else if (object instanceof Service)
|
||||
buildService(object);
|
||||
else if (object instanceof Method)
|
||||
buildMethod(object);
|
||||
else
|
||||
buildNamespace(object);
|
||||
}
|
||||
|
||||
function buildNamespace(namespace) { // just a namespace, not a type etc.
|
||||
push("");
|
||||
push("message " + namespace.name + " {");
|
||||
++indent;
|
||||
buildOptions(namespace);
|
||||
consolidateExtends(namespace.nestedArray).remaining.forEach(build);
|
||||
--indent;
|
||||
push("}");
|
||||
}
|
||||
|
||||
function buildEnum(enm) {
|
||||
push("");
|
||||
push("enum " + enm.name + " {");
|
||||
buildOptions(enm);
|
||||
++indent; first = true;
|
||||
Object.keys(enm.values).forEach(function(name) {
|
||||
var val = enm.values[name];
|
||||
if (first) {
|
||||
push("");
|
||||
first = false;
|
||||
}
|
||||
push(name + " = " + val + ";");
|
||||
});
|
||||
--indent; first = false;
|
||||
push("}");
|
||||
}
|
||||
|
||||
function buildRanges(keyword, ranges) {
|
||||
if (ranges && ranges.length) {
|
||||
var parts = [];
|
||||
ranges.forEach(function(range) {
|
||||
if (typeof range === "string")
|
||||
parts.push("\"" + escape(range) + "\"");
|
||||
else if (range[0] === range[1])
|
||||
parts.push(range[0]);
|
||||
else
|
||||
parts.push(range[0] + " to " + (range[1] === 0x1FFFFFFF ? "max" : range[1]));
|
||||
});
|
||||
push("");
|
||||
push(keyword + " " + parts.join(", ") + ";");
|
||||
}
|
||||
}
|
||||
|
||||
function buildType(type) {
|
||||
if (type.group)
|
||||
return; // built with the sister-field
|
||||
push("");
|
||||
push("message " + type.name + " {");
|
||||
++indent;
|
||||
buildOptions(type);
|
||||
type.oneofsArray.forEach(build);
|
||||
first = true;
|
||||
type.fieldsArray.forEach(build);
|
||||
consolidateExtends(type.nestedArray).remaining.forEach(build);
|
||||
buildRanges("extensions", type.extensions);
|
||||
buildRanges("reserved", type.reserved);
|
||||
--indent;
|
||||
push("}");
|
||||
}
|
||||
|
||||
function buildField(field, passExtend) {
|
||||
if (field.partOf || field.declaringField || field.extend !== undefined && !passExtend)
|
||||
return;
|
||||
if (first) {
|
||||
first = false;
|
||||
push("");
|
||||
}
|
||||
if (field.resolvedType && field.resolvedType.group) {
|
||||
buildGroup(field);
|
||||
return;
|
||||
}
|
||||
var sb = [];
|
||||
if (field.map)
|
||||
sb.push("map<" + field.keyType + ", " + field.type + ">");
|
||||
else if (field.repeated)
|
||||
sb.push("repeated", field.type);
|
||||
else if (syntax === 2 || field.parent.group)
|
||||
sb.push(field.required ? "required" : "optional", field.type);
|
||||
else
|
||||
sb.push(field.type);
|
||||
sb.push(underScore(field.name), "=", field.id);
|
||||
var opts = buildFieldOptions(field);
|
||||
if (opts)
|
||||
sb.push(opts);
|
||||
push(sb.join(" ") + ";");
|
||||
}
|
||||
|
||||
function buildGroup(field) {
|
||||
push(field.rule + " group " + field.resolvedType.name + " = " + field.id + " {");
|
||||
++indent;
|
||||
buildOptions(field.resolvedType);
|
||||
first = true;
|
||||
field.resolvedType.fieldsArray.forEach(function(field) {
|
||||
buildField(field);
|
||||
});
|
||||
--indent;
|
||||
push("}");
|
||||
}
|
||||
|
||||
function buildFieldOptions(field) {
|
||||
var keys;
|
||||
if (!field.options || !(keys = Object.keys(field.options)).length)
|
||||
return null;
|
||||
var sb = [];
|
||||
keys.forEach(function(key) {
|
||||
var val = field.options[key];
|
||||
var wireType = types.packed[field.resolvedType instanceof Enum ? "int32" : field.type];
|
||||
switch (key) {
|
||||
case "packed":
|
||||
val = Boolean(val);
|
||||
// skip when not packable or syntax default
|
||||
if (wireType === undefined || syntax === 3 === val)
|
||||
return;
|
||||
break;
|
||||
case "default":
|
||||
if (syntax === 3)
|
||||
return;
|
||||
// skip default (resolved) default values
|
||||
if (field.long && !util.longNeq(field.defaultValue, types.defaults[field.type]) || !field.long && field.defaultValue === types.defaults[field.type])
|
||||
return;
|
||||
// enum defaults specified as strings are type references and not enclosed in quotes
|
||||
if (field.resolvedType instanceof Enum)
|
||||
break;
|
||||
// otherwise fallthrough
|
||||
default:
|
||||
val = value(val);
|
||||
break;
|
||||
}
|
||||
sb.push(key + "=" + val);
|
||||
});
|
||||
return sb.length
|
||||
? "[" + sb.join(", ") + "]"
|
||||
: null;
|
||||
}
|
||||
|
||||
function consolidateExtends(nested) {
|
||||
var ext = {};
|
||||
nested = nested.filter(function(obj) {
|
||||
if (!(obj instanceof Field) || obj.extend === undefined)
|
||||
return true;
|
||||
(ext[obj.extend] || (ext[obj.extend] = [])).push(obj);
|
||||
return false;
|
||||
});
|
||||
Object.keys(ext).forEach(function(extend) {
|
||||
push("");
|
||||
push("extend " + extend + " {");
|
||||
++indent; first = true;
|
||||
ext[extend].forEach(function(field) {
|
||||
buildField(field, true);
|
||||
});
|
||||
--indent;
|
||||
push("}");
|
||||
});
|
||||
return {
|
||||
remaining: nested
|
||||
};
|
||||
}
|
||||
|
||||
function buildOneOf(oneof) {
|
||||
push("");
|
||||
push("oneof " + underScore(oneof.name) + " {");
|
||||
++indent; first = true;
|
||||
oneof.oneof.forEach(function(fieldName) {
|
||||
var field = oneof.parent.get(fieldName);
|
||||
if (first) {
|
||||
first = false;
|
||||
push("");
|
||||
}
|
||||
var opts = buildFieldOptions(field);
|
||||
push(field.type + " " + underScore(field.name) + " = " + field.id + (opts ? " " + opts : "") + ";");
|
||||
});
|
||||
--indent;
|
||||
push("}");
|
||||
}
|
||||
|
||||
function buildService(service) {
|
||||
push("service " + service.name + " {");
|
||||
++indent;
|
||||
service.methodsArray.forEach(build);
|
||||
consolidateExtends(service.nestedArray).remaining.forEach(build);
|
||||
--indent;
|
||||
push("}");
|
||||
}
|
||||
|
||||
function buildMethod(method) {
|
||||
push(method.type + " " + method.name + " (" + (method.requestStream ? "stream " : "") + method.requestType + ") returns (" + (method.responseStream ? "stream " : "") + method.responseType + ");");
|
||||
}
|
||||
|
||||
function buildOptions(object) {
|
||||
if (!object.options)
|
||||
return;
|
||||
first = true;
|
||||
Object.keys(object.options).forEach(function(key) {
|
||||
if (first) {
|
||||
first = false;
|
||||
push("");
|
||||
}
|
||||
var val = object.options[key];
|
||||
push("option " + key + " = " + JSON.stringify(val) + ";");
|
||||
});
|
||||
}
|
||||
Executable
+10
@@ -0,0 +1,10 @@
|
||||
"use strict";
|
||||
module.exports = proto2_target;
|
||||
|
||||
var protobuf = require("../..");
|
||||
|
||||
proto2_target.description = "Protocol Buffers, Version 2";
|
||||
|
||||
function proto2_target(root, options, callback) {
|
||||
require("./proto")(root, protobuf.util.merge(options, { syntax: "proto2" }), callback);
|
||||
}
|
||||
Executable
+10
@@ -0,0 +1,10 @@
|
||||
"use strict";
|
||||
module.exports = proto3_target;
|
||||
|
||||
var protobuf = require("../..");
|
||||
|
||||
proto3_target.description = "Protocol Buffers, Version 3";
|
||||
|
||||
function proto3_target(root, options, callback) {
|
||||
require("./proto")(root, protobuf.util.merge(options, { syntax: "proto3" }), callback);
|
||||
}
|
||||
+29
@@ -0,0 +1,29 @@
|
||||
"use strict";
|
||||
module.exports = static_module_target;
|
||||
|
||||
// - The default wrapper supports AMD, CommonJS and the global scope (as window.root), in this order.
|
||||
// - You can specify a custom wrapper with the --wrap argument.
|
||||
// - CommonJS modules depend on the minimal build for reduced package size with browserify.
|
||||
// - AMD and global scope depend on the full library for now.
|
||||
|
||||
var util = require("../util");
|
||||
|
||||
var protobuf = require("../..");
|
||||
|
||||
static_module_target.description = "Static code without reflection as a module";
|
||||
|
||||
function static_module_target(root, options, callback) {
|
||||
require("./static")(root, options, function(err, output) {
|
||||
if (err) {
|
||||
callback(err);
|
||||
return;
|
||||
}
|
||||
try {
|
||||
output = util.wrap(output, protobuf.util.merge({ dependency: "protobufjs/minimal" }, options));
|
||||
} catch (e) {
|
||||
callback(e);
|
||||
return;
|
||||
}
|
||||
callback(null, output);
|
||||
});
|
||||
}
|
||||
Executable
+702
@@ -0,0 +1,702 @@
|
||||
"use strict";
|
||||
module.exports = static_target;
|
||||
|
||||
var protobuf = require("../.."),
|
||||
UglifyJS = require("uglify-js"),
|
||||
espree = require("espree"),
|
||||
escodegen = require("escodegen"),
|
||||
estraverse = require("estraverse");
|
||||
|
||||
var Type = protobuf.Type,
|
||||
Service = protobuf.Service,
|
||||
Enum = protobuf.Enum,
|
||||
Namespace = protobuf.Namespace,
|
||||
util = protobuf.util;
|
||||
|
||||
var out = [];
|
||||
var indent = 0;
|
||||
var config = {};
|
||||
|
||||
static_target.description = "Static code without reflection (non-functional on its own)";
|
||||
|
||||
function static_target(root, options, callback) {
|
||||
config = options;
|
||||
try {
|
||||
var aliases = [];
|
||||
if (config.decode)
|
||||
aliases.push("Reader");
|
||||
if (config.encode)
|
||||
aliases.push("Writer");
|
||||
aliases.push("util");
|
||||
if (aliases.length) {
|
||||
if (config.comments)
|
||||
push("// Common aliases");
|
||||
push((config.es6 ? "const " : "var ") + aliases.map(function(name) { return "$" + name + " = $protobuf." + name; }).join(", ") + ";");
|
||||
push("");
|
||||
}
|
||||
if (config.comments) {
|
||||
if (root.comment) {
|
||||
pushComment("@fileoverview " + root.comment);
|
||||
push("");
|
||||
}
|
||||
push("// Exported root namespace");
|
||||
}
|
||||
var rootProp = util.safeProp(config.root || "default");
|
||||
push((config.es6 ? "const" : "var") + " $root = $protobuf.roots" + rootProp + " || ($protobuf.roots" + rootProp + " = {});");
|
||||
buildNamespace(null, root);
|
||||
return callback(null, out.join("\n"));
|
||||
} catch (err) {
|
||||
return callback(err);
|
||||
} finally {
|
||||
out = [];
|
||||
indent = 0;
|
||||
config = {};
|
||||
}
|
||||
}
|
||||
|
||||
function push(line) {
|
||||
if (line === "")
|
||||
return out.push("");
|
||||
var ind = "";
|
||||
for (var i = 0; i < indent; ++i)
|
||||
ind += " ";
|
||||
return out.push(ind + line);
|
||||
}
|
||||
|
||||
function pushComment(lines) {
|
||||
if (!config.comments)
|
||||
return;
|
||||
var split = [];
|
||||
for (var i = 0; i < lines.length; ++i)
|
||||
if (lines[i] != null && lines[i].substring(0, 8) !== "@exclude")
|
||||
Array.prototype.push.apply(split, lines[i].split(/\r?\n/g));
|
||||
push("/**");
|
||||
split.forEach(function(line) {
|
||||
if (line === null)
|
||||
return;
|
||||
push(" * " + line.replace(/\*\//g, "* /"));
|
||||
});
|
||||
push(" */");
|
||||
}
|
||||
|
||||
function exportName(object, asInterface) {
|
||||
if (asInterface) {
|
||||
if (object.__interfaceName)
|
||||
return object.__interfaceName;
|
||||
} else if (object.__exportName)
|
||||
return object.__exportName;
|
||||
var parts = object.fullName.substring(1).split("."),
|
||||
i = 0;
|
||||
while (i < parts.length)
|
||||
parts[i] = escapeName(parts[i++]);
|
||||
if (asInterface)
|
||||
parts[i - 1] = "I" + parts[i - 1];
|
||||
return object[asInterface ? "__interfaceName" : "__exportName"] = parts.join(".");
|
||||
}
|
||||
|
||||
function escapeName(name) {
|
||||
if (!name)
|
||||
return "$root";
|
||||
return util.isReserved(name) ? name + "_" : name;
|
||||
}
|
||||
|
||||
function aOrAn(name) {
|
||||
return ((/^[hH](?:ou|on|ei)/.test(name) || /^[aeiouAEIOU][a-z]/.test(name)) && !/^us/i.test(name)
|
||||
? "an "
|
||||
: "a ") + name;
|
||||
}
|
||||
|
||||
function buildNamespace(ref, ns) {
|
||||
if (!ns)
|
||||
return;
|
||||
if (ns.name !== "") {
|
||||
push("");
|
||||
if (!ref && config.es6)
|
||||
push("export const " + escapeName(ns.name) + " = " + escapeName(ref) + "." + escapeName(ns.name) + " = (() => {");
|
||||
else
|
||||
push(escapeName(ref) + "." + escapeName(ns.name) + " = (function() {");
|
||||
++indent;
|
||||
}
|
||||
|
||||
if (ns instanceof Type) {
|
||||
buildType(undefined, ns);
|
||||
} else if (ns instanceof Service)
|
||||
buildService(undefined, ns);
|
||||
else if (ns.name !== "") {
|
||||
push("");
|
||||
pushComment([
|
||||
ns.comment || "Namespace " + ns.name + ".",
|
||||
ns.parent instanceof protobuf.Root ? "@exports " + escapeName(ns.name) : "@memberof " + exportName(ns.parent),
|
||||
"@namespace"
|
||||
]);
|
||||
push((config.es6 ? "const" : "var") + " " + escapeName(ns.name) + " = {};");
|
||||
}
|
||||
|
||||
ns.nestedArray.forEach(function(nested) {
|
||||
if (nested instanceof Enum)
|
||||
buildEnum(ns.name, nested);
|
||||
else if (nested instanceof Namespace)
|
||||
buildNamespace(ns.name, nested);
|
||||
});
|
||||
if (ns.name !== "") {
|
||||
push("");
|
||||
push("return " + escapeName(ns.name) + ";");
|
||||
--indent;
|
||||
push("})();");
|
||||
}
|
||||
}
|
||||
|
||||
var reduceableBlockStatements = {
|
||||
IfStatement: true,
|
||||
ForStatement: true,
|
||||
WhileStatement: true
|
||||
};
|
||||
|
||||
var shortVars = {
|
||||
"r": "reader",
|
||||
"w": "writer",
|
||||
"m": "message",
|
||||
"t": "tag",
|
||||
"l": "length",
|
||||
"c": "end", "c2": "end2",
|
||||
"k": "key",
|
||||
"ks": "keys", "ks2": "keys2",
|
||||
"e": "error",
|
||||
"f": "impl",
|
||||
"o": "options",
|
||||
"d": "object",
|
||||
"n": "long",
|
||||
"p": "properties"
|
||||
};
|
||||
|
||||
function beautifyCode(code) {
|
||||
// Add semicolons
|
||||
code = UglifyJS.minify(code, {
|
||||
compress: false,
|
||||
mangle: false,
|
||||
output: { beautify: true }
|
||||
}).code;
|
||||
// Properly beautify
|
||||
var ast = espree.parse(code);
|
||||
estraverse.replace(ast, {
|
||||
enter: function(node, parent) {
|
||||
// rename short vars
|
||||
if (node.type === "Identifier" && (parent.property !== node || parent.computed) && shortVars[node.name])
|
||||
return {
|
||||
"type": "Identifier",
|
||||
"name": shortVars[node.name]
|
||||
};
|
||||
// replace var with let if es6
|
||||
if (config.es6 && node.type === "VariableDeclaration" && node.kind === "var") {
|
||||
node.kind = "let";
|
||||
return undefined;
|
||||
}
|
||||
// remove braces around block statements with a single child
|
||||
if (node.type === "BlockStatement" && reduceableBlockStatements[parent.type] && node.body.length === 1)
|
||||
return node.body[0];
|
||||
return undefined;
|
||||
}
|
||||
});
|
||||
code = escodegen.generate(ast, {
|
||||
format: {
|
||||
newline: "\n",
|
||||
quotes: "double"
|
||||
}
|
||||
});
|
||||
// Add id, wireType comments
|
||||
if (config.comments)
|
||||
code = code.replace(/\.uint32\((\d+)\)/g, function($0, $1) {
|
||||
var id = $1 >>> 3,
|
||||
wireType = $1 & 7;
|
||||
return ".uint32(/* id " + id + ", wireType " + wireType + " =*/" + $1 + ")";
|
||||
});
|
||||
return code;
|
||||
}
|
||||
|
||||
var renameVars = {
|
||||
"Writer": "$Writer",
|
||||
"Reader": "$Reader",
|
||||
"util": "$util"
|
||||
};
|
||||
|
||||
function buildFunction(type, functionName, gen, scope) {
|
||||
var code = gen.toString(functionName)
|
||||
.replace(/((?!\.)types\[\d+])(\.values)/g, "$1"); // enums: use types[N] instead of reflected types[N].values
|
||||
|
||||
var ast = espree.parse(code);
|
||||
/* eslint-disable no-extra-parens */
|
||||
estraverse.replace(ast, {
|
||||
enter: function(node, parent) {
|
||||
// rename vars
|
||||
if (
|
||||
node.type === "Identifier" && renameVars[node.name]
|
||||
&& (
|
||||
(parent.type === "MemberExpression" && parent.object === node)
|
||||
|| (parent.type === "BinaryExpression" && parent.right === node)
|
||||
)
|
||||
)
|
||||
return {
|
||||
"type": "Identifier",
|
||||
"name": renameVars[node.name]
|
||||
};
|
||||
// replace this.ctor with the actual ctor
|
||||
if (
|
||||
node.type === "MemberExpression"
|
||||
&& node.object.type === "ThisExpression"
|
||||
&& node.property.type === "Identifier" && node.property.name === "ctor"
|
||||
)
|
||||
return {
|
||||
"type": "Identifier",
|
||||
"name": "$root" + type.fullName
|
||||
};
|
||||
// replace types[N] with the field's actual type
|
||||
if (
|
||||
node.type === "MemberExpression"
|
||||
&& node.object.type === "Identifier" && node.object.name === "types"
|
||||
&& node.property.type === "Literal"
|
||||
)
|
||||
return {
|
||||
"type": "Identifier",
|
||||
"name": "$root" + type.fieldsArray[node.property.value].resolvedType.fullName
|
||||
};
|
||||
return undefined;
|
||||
}
|
||||
});
|
||||
/* eslint-enable no-extra-parens */
|
||||
code = escodegen.generate(ast, {
|
||||
format: {
|
||||
newline: "\n",
|
||||
quotes: "double"
|
||||
}
|
||||
});
|
||||
|
||||
if (config.beautify)
|
||||
code = beautifyCode(code);
|
||||
|
||||
code = code.replace(/ {4}/g, "\t");
|
||||
|
||||
var hasScope = scope && Object.keys(scope).length,
|
||||
isCtor = functionName === type.name;
|
||||
|
||||
if (hasScope) // remove unused scope vars
|
||||
Object.keys(scope).forEach(function(key) {
|
||||
if (!new RegExp("\\b(" + key + ")\\b", "g").test(code))
|
||||
delete scope[key];
|
||||
});
|
||||
|
||||
var lines = code.split(/\n/g);
|
||||
if (isCtor) // constructor
|
||||
push(lines[0]);
|
||||
else if (hasScope) // enclose in an iife
|
||||
push(escapeName(type.name) + "." + escapeName(functionName) + " = (function(" + Object.keys(scope).map(escapeName).join(", ") + ") { return " + lines[0]);
|
||||
else
|
||||
push(escapeName(type.name) + "." + escapeName(functionName) + " = " + lines[0]);
|
||||
lines.slice(1, lines.length - 1).forEach(function(line) {
|
||||
var prev = indent;
|
||||
var i = 0;
|
||||
while (line.charAt(i++) === "\t")
|
||||
++indent;
|
||||
push(line.trim());
|
||||
indent = prev;
|
||||
});
|
||||
if (isCtor)
|
||||
push("}");
|
||||
else if (hasScope)
|
||||
push("};})(" + Object.keys(scope).map(function(key) { return scope[key]; }).join(", ") + ");");
|
||||
else
|
||||
push("};");
|
||||
}
|
||||
|
||||
function toJsType(field) {
|
||||
var type;
|
||||
|
||||
switch (field.type) {
|
||||
case "double":
|
||||
case "float":
|
||||
case "int32":
|
||||
case "uint32":
|
||||
case "sint32":
|
||||
case "fixed32":
|
||||
case "sfixed32":
|
||||
type = "number";
|
||||
break;
|
||||
case "int64":
|
||||
case "uint64":
|
||||
case "sint64":
|
||||
case "fixed64":
|
||||
case "sfixed64":
|
||||
type = config.forceLong ? "Long" : config.forceNumber ? "number" : "number|Long";
|
||||
break;
|
||||
case "bool":
|
||||
type = "boolean";
|
||||
break;
|
||||
case "string":
|
||||
type = "string";
|
||||
break;
|
||||
case "bytes":
|
||||
type = "Uint8Array";
|
||||
break;
|
||||
default:
|
||||
if (field.resolve().resolvedType)
|
||||
type = exportName(field.resolvedType, !(field.resolvedType instanceof protobuf.Enum || config.forceMessage));
|
||||
else
|
||||
type = "*"; // should not happen
|
||||
break;
|
||||
}
|
||||
if (field.map)
|
||||
return "Object.<string," + type + ">";
|
||||
if (field.repeated)
|
||||
return "Array.<" + type + ">";
|
||||
return type;
|
||||
}
|
||||
|
||||
function buildType(ref, type) {
|
||||
|
||||
if (config.comments) {
|
||||
var typeDef = [
|
||||
"Properties of " + aOrAn(type.name) + ".",
|
||||
type.parent instanceof protobuf.Root ? "@exports " + escapeName("I" + type.name) : "@memberof " + exportName(type.parent),
|
||||
"@interface " + escapeName("I" + type.name)
|
||||
];
|
||||
type.fieldsArray.forEach(function(field) {
|
||||
var prop = util.safeProp(field.name); // either .name or ["name"]
|
||||
prop = prop.substring(1, prop.charAt(0) === "[" ? prop.length - 1 : prop.length);
|
||||
var jsType = toJsType(field);
|
||||
if (field.optional)
|
||||
jsType = jsType + "|null";
|
||||
typeDef.push("@property {" + jsType + "} " + (field.optional ? "[" + prop + "]" : prop) + " " + (field.comment || type.name + " " + field.name));
|
||||
});
|
||||
push("");
|
||||
pushComment(typeDef);
|
||||
}
|
||||
|
||||
// constructor
|
||||
push("");
|
||||
pushComment([
|
||||
"Constructs a new " + type.name + ".",
|
||||
type.parent instanceof protobuf.Root ? "@exports " + escapeName(type.name) : "@memberof " + exportName(type.parent),
|
||||
"@classdesc " + (type.comment || "Represents " + aOrAn(type.name) + "."),
|
||||
config.comments ? "@implements " + escapeName("I" + type.name) : null,
|
||||
"@constructor",
|
||||
"@param {" + exportName(type, true) + "=} [" + (config.beautify ? "properties" : "p") + "] Properties to set"
|
||||
]);
|
||||
buildFunction(type, type.name, Type.generateConstructor(type));
|
||||
|
||||
// default values
|
||||
var firstField = true;
|
||||
type.fieldsArray.forEach(function(field) {
|
||||
field.resolve();
|
||||
var prop = util.safeProp(field.name);
|
||||
if (config.comments) {
|
||||
push("");
|
||||
var jsType = toJsType(field);
|
||||
if (field.optional && !field.map && !field.repeated && field.resolvedType instanceof Type)
|
||||
jsType = jsType + "|null|undefined";
|
||||
pushComment([
|
||||
field.comment || type.name + " " + field.name + ".",
|
||||
"@member {" + jsType + "} " + field.name,
|
||||
"@memberof " + exportName(type),
|
||||
"@instance"
|
||||
]);
|
||||
} else if (firstField) {
|
||||
push("");
|
||||
firstField = false;
|
||||
}
|
||||
if (field.repeated)
|
||||
push(escapeName(type.name) + ".prototype" + prop + " = $util.emptyArray;"); // overwritten in constructor
|
||||
else if (field.map)
|
||||
push(escapeName(type.name) + ".prototype" + prop + " = $util.emptyObject;"); // overwritten in constructor
|
||||
else if (field.long)
|
||||
push(escapeName(type.name) + ".prototype" + prop + " = $util.Long ? $util.Long.fromBits("
|
||||
+ JSON.stringify(field.typeDefault.low) + ","
|
||||
+ JSON.stringify(field.typeDefault.high) + ","
|
||||
+ JSON.stringify(field.typeDefault.unsigned)
|
||||
+ ") : " + field.typeDefault.toNumber(field.type.charAt(0) === "u") + ";");
|
||||
else if (field.bytes) {
|
||||
push(escapeName(type.name) + ".prototype" + prop + " = $util.newBuffer(" + JSON.stringify(Array.prototype.slice.call(field.typeDefault)) + ");");
|
||||
} else
|
||||
push(escapeName(type.name) + ".prototype" + prop + " = " + JSON.stringify(field.typeDefault) + ";");
|
||||
});
|
||||
|
||||
// virtual oneof fields
|
||||
var firstOneOf = true;
|
||||
type.oneofsArray.forEach(function(oneof) {
|
||||
if (firstOneOf) {
|
||||
firstOneOf = false;
|
||||
push("");
|
||||
if (config.comments)
|
||||
push("// OneOf field names bound to virtual getters and setters");
|
||||
push((config.es6 ? "let" : "var") + " $oneOfFields;");
|
||||
}
|
||||
oneof.resolve();
|
||||
push("");
|
||||
pushComment([
|
||||
oneof.comment || type.name + " " + oneof.name + ".",
|
||||
"@member {" + oneof.oneof.map(JSON.stringify).join("|") + "|undefined} " + escapeName(oneof.name),
|
||||
"@memberof " + exportName(type),
|
||||
"@instance"
|
||||
]);
|
||||
push("Object.defineProperty(" + escapeName(type.name) + ".prototype, " + JSON.stringify(oneof.name) +", {");
|
||||
++indent;
|
||||
push("get: $util.oneOfGetter($oneOfFields = [" + oneof.oneof.map(JSON.stringify).join(", ") + "]),");
|
||||
push("set: $util.oneOfSetter($oneOfFields)");
|
||||
--indent;
|
||||
push("});");
|
||||
});
|
||||
|
||||
if (config.create) {
|
||||
push("");
|
||||
pushComment([
|
||||
"Creates a new " + type.name + " instance using the specified properties.",
|
||||
"@function create",
|
||||
"@memberof " + exportName(type),
|
||||
"@static",
|
||||
"@param {" + exportName(type, true) + "=} [properties] Properties to set",
|
||||
"@returns {" + exportName(type) + "} " + type.name + " instance"
|
||||
]);
|
||||
push(escapeName(type.name) + ".create = function create(properties) {");
|
||||
++indent;
|
||||
push("return new " + escapeName(type.name) + "(properties);");
|
||||
--indent;
|
||||
push("};");
|
||||
}
|
||||
|
||||
if (config.encode) {
|
||||
push("");
|
||||
pushComment([
|
||||
"Encodes the specified " + type.name + " message. Does not implicitly {@link " + exportName(type) + ".verify|verify} messages.",
|
||||
"@function encode",
|
||||
"@memberof " + exportName(type),
|
||||
"@static",
|
||||
"@param {" + exportName(type, !config.forceMessage) + "} " + (config.beautify ? "message" : "m") + " " + type.name + " message or plain object to encode",
|
||||
"@param {$protobuf.Writer} [" + (config.beautify ? "writer" : "w") + "] Writer to encode to",
|
||||
"@returns {$protobuf.Writer} Writer"
|
||||
]);
|
||||
buildFunction(type, "encode", protobuf.encoder(type));
|
||||
|
||||
if (config.delimited) {
|
||||
push("");
|
||||
pushComment([
|
||||
"Encodes the specified " + type.name + " message, length delimited. Does not implicitly {@link " + exportName(type) + ".verify|verify} messages.",
|
||||
"@function encodeDelimited",
|
||||
"@memberof " + exportName(type),
|
||||
"@static",
|
||||
"@param {" + exportName(type, !config.forceMessage) + "} message " + type.name + " message or plain object to encode",
|
||||
"@param {$protobuf.Writer} [writer] Writer to encode to",
|
||||
"@returns {$protobuf.Writer} Writer"
|
||||
]);
|
||||
push(escapeName(type.name) + ".encodeDelimited = function encodeDelimited(message, writer) {");
|
||||
++indent;
|
||||
push("return this.encode(message, writer).ldelim();");
|
||||
--indent;
|
||||
push("};");
|
||||
}
|
||||
}
|
||||
|
||||
if (config.decode) {
|
||||
push("");
|
||||
pushComment([
|
||||
"Decodes " + aOrAn(type.name) + " message from the specified reader or buffer.",
|
||||
"@function decode",
|
||||
"@memberof " + exportName(type),
|
||||
"@static",
|
||||
"@param {$protobuf.Reader|Uint8Array} " + (config.beautify ? "reader" : "r") + " Reader or buffer to decode from",
|
||||
"@param {number} [" + (config.beautify ? "length" : "l") + "] Message length if known beforehand",
|
||||
"@returns {" + exportName(type) + "} " + type.name,
|
||||
"@throws {Error} If the payload is not a reader or valid buffer",
|
||||
"@throws {$protobuf.util.ProtocolError} If required fields are missing"
|
||||
]);
|
||||
buildFunction(type, "decode", protobuf.decoder(type));
|
||||
|
||||
if (config.delimited) {
|
||||
push("");
|
||||
pushComment([
|
||||
"Decodes " + aOrAn(type.name) + " message from the specified reader or buffer, length delimited.",
|
||||
"@function decodeDelimited",
|
||||
"@memberof " + exportName(type),
|
||||
"@static",
|
||||
"@param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from",
|
||||
"@returns {" + exportName(type) + "} " + type.name,
|
||||
"@throws {Error} If the payload is not a reader or valid buffer",
|
||||
"@throws {$protobuf.util.ProtocolError} If required fields are missing"
|
||||
]);
|
||||
push(escapeName(type.name) + ".decodeDelimited = function decodeDelimited(reader) {");
|
||||
++indent;
|
||||
push("if (!(reader instanceof $Reader))");
|
||||
++indent;
|
||||
push("reader = new $Reader(reader);");
|
||||
--indent;
|
||||
push("return this.decode(reader, reader.uint32());");
|
||||
--indent;
|
||||
push("};");
|
||||
}
|
||||
}
|
||||
|
||||
if (config.verify) {
|
||||
push("");
|
||||
pushComment([
|
||||
"Verifies " + aOrAn(type.name) + " message.",
|
||||
"@function verify",
|
||||
"@memberof " + exportName(type),
|
||||
"@static",
|
||||
"@param {Object.<string,*>} " + (config.beautify ? "message" : "m") + " Plain object to verify",
|
||||
"@returns {string|null} `null` if valid, otherwise the reason why it is not"
|
||||
]);
|
||||
buildFunction(type, "verify", protobuf.verifier(type));
|
||||
}
|
||||
|
||||
if (config.convert) {
|
||||
push("");
|
||||
pushComment([
|
||||
"Creates " + aOrAn(type.name) + " message from a plain object. Also converts values to their respective internal types.",
|
||||
"@function fromObject",
|
||||
"@memberof " + exportName(type),
|
||||
"@static",
|
||||
"@param {Object.<string,*>} " + (config.beautify ? "object" : "d") + " Plain object",
|
||||
"@returns {" + exportName(type) + "} " + type.name
|
||||
]);
|
||||
buildFunction(type, "fromObject", protobuf.converter.fromObject(type));
|
||||
|
||||
push("");
|
||||
pushComment([
|
||||
"Creates a plain object from " + aOrAn(type.name) + " message. Also converts values to other types if specified.",
|
||||
"@function toObject",
|
||||
"@memberof " + exportName(type),
|
||||
"@static",
|
||||
"@param {" + exportName(type) + "} " + (config.beautify ? "message" : "m") + " " + type.name,
|
||||
"@param {$protobuf.IConversionOptions} [" + (config.beautify ? "options" : "o") + "] Conversion options",
|
||||
"@returns {Object.<string,*>} Plain object"
|
||||
]);
|
||||
buildFunction(type, "toObject", protobuf.converter.toObject(type));
|
||||
|
||||
push("");
|
||||
pushComment([
|
||||
"Converts this " + type.name + " to JSON.",
|
||||
"@function toJSON",
|
||||
"@memberof " + exportName(type),
|
||||
"@instance",
|
||||
"@returns {Object.<string,*>} JSON object"
|
||||
]);
|
||||
push(escapeName(type.name) + ".prototype.toJSON = function toJSON() {");
|
||||
++indent;
|
||||
push("return this.constructor.toObject(this, $protobuf.util.toJSONOptions);");
|
||||
--indent;
|
||||
push("};");
|
||||
}
|
||||
}
|
||||
|
||||
function buildService(ref, service) {
|
||||
|
||||
push("");
|
||||
pushComment([
|
||||
"Constructs a new " + service.name + " service.",
|
||||
service.parent instanceof protobuf.Root ? "@exports " + escapeName(service.name) : "@memberof " + exportName(service.parent),
|
||||
"@classdesc " + (service.comment || "Represents " + aOrAn(service.name)),
|
||||
"@extends $protobuf.rpc.Service",
|
||||
"@constructor",
|
||||
"@param {$protobuf.RPCImpl} rpcImpl RPC implementation",
|
||||
"@param {boolean} [requestDelimited=false] Whether requests are length-delimited",
|
||||
"@param {boolean} [responseDelimited=false] Whether responses are length-delimited"
|
||||
]);
|
||||
push("function " + escapeName(service.name) + "(rpcImpl, requestDelimited, responseDelimited) {");
|
||||
++indent;
|
||||
push("$protobuf.rpc.Service.call(this, rpcImpl, requestDelimited, responseDelimited);");
|
||||
--indent;
|
||||
push("}");
|
||||
push("");
|
||||
push("(" + escapeName(service.name) + ".prototype = Object.create($protobuf.rpc.Service.prototype)).constructor = " + escapeName(service.name) + ";");
|
||||
|
||||
if (config.create) {
|
||||
push("");
|
||||
pushComment([
|
||||
"Creates new " + service.name + " service using the specified rpc implementation.",
|
||||
"@function create",
|
||||
"@memberof " + exportName(service),
|
||||
"@static",
|
||||
"@param {$protobuf.RPCImpl} rpcImpl RPC implementation",
|
||||
"@param {boolean} [requestDelimited=false] Whether requests are length-delimited",
|
||||
"@param {boolean} [responseDelimited=false] Whether responses are length-delimited",
|
||||
"@returns {" + escapeName(service.name) + "} RPC service. Useful where requests and/or responses are streamed."
|
||||
]);
|
||||
push(escapeName(service.name) + ".create = function create(rpcImpl, requestDelimited, responseDelimited) {");
|
||||
++indent;
|
||||
push("return new this(rpcImpl, requestDelimited, responseDelimited);");
|
||||
--indent;
|
||||
push("};");
|
||||
}
|
||||
|
||||
service.methodsArray.forEach(function(method) {
|
||||
method.resolve();
|
||||
var lcName = protobuf.util.lcFirst(method.name),
|
||||
cbName = escapeName(method.name + "Callback");
|
||||
push("");
|
||||
pushComment([
|
||||
"Callback as used by {@link " + exportName(service) + "#" + escapeName(lcName) + "}.",
|
||||
// This is a more specialized version of protobuf.rpc.ServiceCallback
|
||||
"@memberof " + exportName(service),
|
||||
"@typedef " + cbName,
|
||||
"@type {function}",
|
||||
"@param {Error|null} error Error, if any",
|
||||
"@param {" + exportName(method.resolvedResponseType) + "} [response] " + method.resolvedResponseType.name
|
||||
]);
|
||||
push("");
|
||||
pushComment([
|
||||
method.comment || "Calls " + method.name + ".",
|
||||
"@function " + lcName,
|
||||
"@memberof " + exportName(service),
|
||||
"@instance",
|
||||
"@param {" + exportName(method.resolvedRequestType, !config.forceMessage) + "} request " + method.resolvedRequestType.name + " message or plain object",
|
||||
"@param {" + exportName(service) + "." + cbName + "} callback Node-style callback called with the error, if any, and " + method.resolvedResponseType.name,
|
||||
"@returns {undefined}",
|
||||
"@variation 1"
|
||||
]);
|
||||
push("Object.defineProperty(" + escapeName(service.name) + ".prototype" + util.safeProp(lcName) + " = function " + escapeName(lcName) + "(request, callback) {");
|
||||
++indent;
|
||||
push("return this.rpcCall(" + escapeName(lcName) + ", $root." + exportName(method.resolvedRequestType) + ", $root." + exportName(method.resolvedResponseType) + ", request, callback);");
|
||||
--indent;
|
||||
push("}, \"name\", { value: " + JSON.stringify(method.name) + " });");
|
||||
if (config.comments)
|
||||
push("");
|
||||
pushComment([
|
||||
method.comment || "Calls " + method.name + ".",
|
||||
"@function " + lcName,
|
||||
"@memberof " + exportName(service),
|
||||
"@instance",
|
||||
"@param {" + exportName(method.resolvedRequestType, !config.forceMessage) + "} request " + method.resolvedRequestType.name + " message or plain object",
|
||||
"@returns {Promise<" + exportName(method.resolvedResponseType) + ">} Promise",
|
||||
"@variation 2"
|
||||
]);
|
||||
});
|
||||
}
|
||||
|
||||
function buildEnum(ref, enm) {
|
||||
|
||||
push("");
|
||||
var comment = [
|
||||
enm.comment || enm.name + " enum.",
|
||||
enm.parent instanceof protobuf.Root ? "@exports " + escapeName(enm.name) : "@name " + exportName(enm),
|
||||
config.forceEnumString ? "@enum {number}" : "@enum {string}",
|
||||
];
|
||||
Object.keys(enm.values).forEach(function(key) {
|
||||
var val = config.forceEnumString ? key : enm.values[key];
|
||||
comment.push((config.forceEnumString ? "@property {string} " : "@property {number} ") + key + "=" + val + " " + (enm.comments[key] || key + " value"));
|
||||
});
|
||||
pushComment(comment);
|
||||
push(escapeName(ref) + "." + escapeName(enm.name) + " = (function() {");
|
||||
++indent;
|
||||
push((config.es6 ? "const" : "var") + " valuesById = {}, values = Object.create(valuesById);");
|
||||
var aliased = [];
|
||||
Object.keys(enm.values).forEach(function(key) {
|
||||
var valueId = enm.values[key];
|
||||
var val = config.forceEnumString ? JSON.stringify(key) : valueId;
|
||||
if (aliased.indexOf(valueId) > -1)
|
||||
push("values[" + JSON.stringify(key) + "] = " + val + ";");
|
||||
else {
|
||||
push("values[valuesById[" + valueId + "] = " + JSON.stringify(key) + "] = " + val + ";");
|
||||
aliased.push(valueId);
|
||||
}
|
||||
});
|
||||
push("return values;");
|
||||
--indent;
|
||||
push("})();");
|
||||
}
|
||||
Executable
+183
@@ -0,0 +1,183 @@
|
||||
"use strict";
|
||||
var fs = require("fs"),
|
||||
path = require("path"),
|
||||
child_process = require("child_process");
|
||||
|
||||
var semver;
|
||||
|
||||
try {
|
||||
// installed as a peer dependency
|
||||
require.resolve("protobufjs");
|
||||
exports.pathToProtobufJs = "protobufjs";
|
||||
} catch (e) {
|
||||
// local development, i.e. forked from github
|
||||
exports.pathToProtobufJs = "..";
|
||||
}
|
||||
|
||||
var protobuf = require(exports.pathToProtobufJs);
|
||||
|
||||
function basenameCompare(a, b) {
|
||||
var aa = String(a).replace(/\.\w+$/, "").split(/(-?\d*\.?\d+)/g),
|
||||
bb = String(b).replace(/\.\w+$/, "").split(/(-?\d*\.?\d+)/g);
|
||||
for (var i = 0, k = Math.min(aa.length, bb.length); i < k; i++) {
|
||||
var x = parseFloat(aa[i]) || aa[i].toLowerCase(),
|
||||
y = parseFloat(bb[i]) || bb[i].toLowerCase();
|
||||
if (x < y)
|
||||
return -1;
|
||||
if (x > y)
|
||||
return 1;
|
||||
}
|
||||
return a.length < b.length ? -1 : 0;
|
||||
}
|
||||
|
||||
exports.requireAll = function requireAll(dirname) {
|
||||
dirname = path.join(__dirname, dirname);
|
||||
var files = fs.readdirSync(dirname).sort(basenameCompare),
|
||||
all = {};
|
||||
files.forEach(function(file) {
|
||||
var basename = path.basename(file, ".js"),
|
||||
extname = path.extname(file);
|
||||
if (extname === ".js")
|
||||
all[basename] = require(path.join(dirname, file));
|
||||
});
|
||||
return all;
|
||||
};
|
||||
|
||||
exports.traverse = function traverse(current, fn) {
|
||||
fn(current);
|
||||
if (current.fieldsArray)
|
||||
current.fieldsArray.forEach(function(field) {
|
||||
traverse(field, fn);
|
||||
});
|
||||
if (current.oneofsArray)
|
||||
current.oneofsArray.forEach(function(oneof) {
|
||||
traverse(oneof, fn);
|
||||
});
|
||||
if (current.methodsArray)
|
||||
current.methodsArray.forEach(function(method) {
|
||||
traverse(method, fn);
|
||||
});
|
||||
if (current.nestedArray)
|
||||
current.nestedArray.forEach(function(nested) {
|
||||
traverse(nested, fn);
|
||||
});
|
||||
};
|
||||
|
||||
exports.traverseResolved = function traverseResolved(current, fn) {
|
||||
fn(current);
|
||||
if (current.resolvedType)
|
||||
traverseResolved(current.resolvedType, fn);
|
||||
if (current.resolvedKeyType)
|
||||
traverseResolved(current.resolvedKeyType, fn);
|
||||
if (current.resolvedRequestType)
|
||||
traverseResolved(current.resolvedRequestType, fn);
|
||||
if (current.resolvedResponseType)
|
||||
traverseResolved(current.resolvedResponseType, fn);
|
||||
};
|
||||
|
||||
exports.inspect = function inspect(object, indent) {
|
||||
if (!object)
|
||||
return "";
|
||||
var chalk = require("chalk");
|
||||
var sb = [];
|
||||
if (!indent)
|
||||
indent = "";
|
||||
var ind = indent ? indent.substring(0, indent.length - 2) + "└ " : "";
|
||||
sb.push(
|
||||
ind + chalk.bold(object.toString()) + (object.visible ? " (visible)" : ""),
|
||||
indent + chalk.gray("parent: ") + object.parent
|
||||
);
|
||||
if (object instanceof protobuf.Field) {
|
||||
if (object.extend !== undefined)
|
||||
sb.push(indent + chalk.gray("extend: ") + object.extend);
|
||||
if (object.partOf)
|
||||
sb.push(indent + chalk.gray("oneof : ") + object.oneof);
|
||||
}
|
||||
sb.push("");
|
||||
if (object.fieldsArray)
|
||||
object.fieldsArray.forEach(function(field) {
|
||||
sb.push(inspect(field, indent + " "));
|
||||
});
|
||||
if (object.oneofsArray)
|
||||
object.oneofsArray.forEach(function(oneof) {
|
||||
sb.push(inspect(oneof, indent + " "));
|
||||
});
|
||||
if (object.methodsArray)
|
||||
object.methodsArray.forEach(function(service) {
|
||||
sb.push(inspect(service, indent + " "));
|
||||
});
|
||||
if (object.nestedArray)
|
||||
object.nestedArray.forEach(function(nested) {
|
||||
sb.push(inspect(nested, indent + " "));
|
||||
});
|
||||
return sb.join("\n");
|
||||
};
|
||||
|
||||
function modExists(name, version) {
|
||||
for (var i = 0; i < module.paths.length; ++i) {
|
||||
try {
|
||||
var pkg = JSON.parse(fs.readFileSync(path.join(module.paths[i], name, "package.json")));
|
||||
return semver
|
||||
? semver.satisfies(pkg.version, version)
|
||||
: parseInt(pkg.version, 10) === parseInt(version.replace(/^[\^~]/, ""), 10); // used for semver only
|
||||
} catch (e) {/**/}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
function modInstall(install) {
|
||||
child_process.execSync("npm --silent install " + (typeof install === "string" ? install : install.join(" ")), {
|
||||
cwd: __dirname,
|
||||
stdio: "ignore"
|
||||
});
|
||||
}
|
||||
|
||||
exports.setup = function() {
|
||||
var pkg = require(path.join(__dirname, "..", "package.json"));
|
||||
var version = pkg.dependencies["semver"] || pkg.devDependencies["semver"];
|
||||
if (!modExists("semver", version)) {
|
||||
process.stderr.write("installing semver@" + version + "\n");
|
||||
modInstall("semver@" + version);
|
||||
}
|
||||
semver = require("semver"); // used from now on for version comparison
|
||||
var install = [];
|
||||
pkg.cliDependencies.forEach(function(name) {
|
||||
if (name === "semver")
|
||||
return;
|
||||
version = pkg.dependencies[name] || pkg.devDependencies[name];
|
||||
if (!modExists(name, version)) {
|
||||
process.stderr.write("installing " + name + "@" + version + "\n");
|
||||
install.push(name + "@" + version);
|
||||
}
|
||||
});
|
||||
require("../scripts/postinstall"); // emit postinstall warning, if any
|
||||
if (!install.length)
|
||||
return;
|
||||
modInstall(install);
|
||||
};
|
||||
|
||||
exports.wrap = function(OUTPUT, options) {
|
||||
var name = options.wrap || "default";
|
||||
var wrap;
|
||||
try {
|
||||
// try built-in wrappers first
|
||||
wrap = fs.readFileSync(path.join(__dirname, "wrappers", name + ".js")).toString("utf8");
|
||||
} catch (e) {
|
||||
// otherwise fetch the custom one
|
||||
wrap = fs.readFileSync(path.resolve(process.cwd(), name)).toString("utf8");
|
||||
}
|
||||
wrap = wrap.replace(/\$DEPENDENCY/g, JSON.stringify(options.dependency || "protobufjs"));
|
||||
wrap = wrap.replace(/( *)\$OUTPUT;/, function($0, $1) {
|
||||
return $1.length ? OUTPUT.replace(/^/mg, $1) : OUTPUT;
|
||||
});
|
||||
if (options.lint !== "")
|
||||
wrap = "/*" + options.lint + "*/\n" + wrap;
|
||||
return wrap.replace(/\r?\n/g, "\n");
|
||||
};
|
||||
|
||||
exports.pad = function(str, len, l) {
|
||||
while (str.length < len)
|
||||
str = l ? str + " " : " " + str;
|
||||
return str;
|
||||
};
|
||||
|
||||
Executable
+7
@@ -0,0 +1,7 @@
|
||||
define([$DEPENDENCY], function($protobuf) {
|
||||
"use strict";
|
||||
|
||||
$OUTPUT;
|
||||
|
||||
return $root;
|
||||
});
|
||||
Executable
+7
@@ -0,0 +1,7 @@
|
||||
(function($protobuf) {
|
||||
"use strict";
|
||||
|
||||
$OUTPUT;
|
||||
|
||||
return $root;
|
||||
})(protobuf);
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
"use strict";
|
||||
|
||||
var $protobuf = require($DEPENDENCY);
|
||||
|
||||
$OUTPUT;
|
||||
|
||||
module.exports = $root;
|
||||
Executable
+15
@@ -0,0 +1,15 @@
|
||||
(function(global, factory) { /* global define, require, module */
|
||||
|
||||
/* AMD */ if (typeof define === 'function' && define.amd)
|
||||
define([$DEPENDENCY], factory);
|
||||
|
||||
/* CommonJS */ else if (typeof require === 'function' && typeof module === 'object' && module && module.exports)
|
||||
module.exports = factory(require($DEPENDENCY));
|
||||
|
||||
})(this, function($protobuf) {
|
||||
"use strict";
|
||||
|
||||
$OUTPUT;
|
||||
|
||||
return $root;
|
||||
});
|
||||
Executable
+5
@@ -0,0 +1,5 @@
|
||||
import * as $protobuf from $DEPENDENCY;
|
||||
|
||||
$OUTPUT;
|
||||
|
||||
export { $root as default };
|
||||
Executable
+127
@@ -0,0 +1,127 @@
|
||||
{
|
||||
"env": {
|
||||
"node": true,
|
||||
"browser": true
|
||||
},
|
||||
"globals": {
|
||||
"ArrayBuffer": true,
|
||||
"Uint8Array": true,
|
||||
"Float32Array": true,
|
||||
"Float64Array": true,
|
||||
"define": true,
|
||||
"global": true,
|
||||
"XMLHttpRequest": true,
|
||||
"Promise": true
|
||||
},
|
||||
"parserOptions": {
|
||||
"ecmaVersion": 5
|
||||
},
|
||||
"extends": "eslint:recommended",
|
||||
"rules": {
|
||||
|
||||
// Possible errors
|
||||
"no-extra-parens": 1, // turned on as the daily lecture
|
||||
"no-prototype-builtins": 1,
|
||||
"no-template-curly-in-string": 1,
|
||||
"no-unsafe-negation": 1,
|
||||
"valid-jsdoc": 1,
|
||||
|
||||
// Best practices
|
||||
"accessor-pairs": 1,
|
||||
"array-callback-return": 1,
|
||||
"block-scoped-var": 1,
|
||||
"class-methods-use-this": 1,
|
||||
"complexity": 0, // is sometimes necessary
|
||||
"consistent-return": 1,
|
||||
"curly": 0, // sometimes more braces than code
|
||||
"default-case": 0, // just forces unnecessary code
|
||||
"dot-location": 0, // looks nicer for chainables
|
||||
"dot-notation": 0, // not compatible with some reserved properties
|
||||
"eqeqeq": [1, "allow-null"],
|
||||
"guard-for-in": 1,
|
||||
"no-alert": 1,
|
||||
"no-caller": 1,
|
||||
"no-cond-assign": 0,
|
||||
"no-div-regex": 1,
|
||||
"no-else-return": 1,
|
||||
"no-empty-function": 1,
|
||||
"no-eval": 1,
|
||||
"no-extend-native": 1,
|
||||
"no-extra-bind": 1,
|
||||
"no-extra-label": 1,
|
||||
"no-floating-decimal": 1,
|
||||
"no-global-assign": 1,
|
||||
"no-implicit-coercion": 1,
|
||||
"no-implicit-globals": 1,
|
||||
"no-implied-eval": 1,
|
||||
"no-invalid-this": 1,
|
||||
"no-iterator": 1,
|
||||
"no-labels": 1,
|
||||
"no-lone-blocks": 1,
|
||||
"no-loop-func": 1,
|
||||
"no-magic-numbers": 0, // it's actually fun to turn this on here
|
||||
"no-new-func": 1,
|
||||
"no-new-wrappers": 1,
|
||||
"no-new": 1,
|
||||
"no-octal-escape": 1,
|
||||
"no-param-reassign": 0, // is necessary for varargs functions
|
||||
"no-proto": 1,
|
||||
"no-restricted-properties": 1,
|
||||
"no-sequences": 1,
|
||||
"no-script-url": 1,
|
||||
"no-self-compare": 1,
|
||||
"no-throw-literal": 1,
|
||||
"no-unmodified-loop-condition": 1,
|
||||
"no-unused-expressions": 1,
|
||||
"no-useless-call": 1,
|
||||
"no-useless-concat": 1,
|
||||
"no-useless-escape": 1,
|
||||
"no-useless-return": 1,
|
||||
"no-void": 1,
|
||||
"no-warning-comments": 1,
|
||||
"no-with": 1,
|
||||
"radix": 1,
|
||||
"vars-on-top": 0, // makes code harder to read, not faster
|
||||
"wrap-iife": 0, // used frequently where polyfilling
|
||||
"yoda": 1,
|
||||
|
||||
// Strict mode
|
||||
"strict": 1,
|
||||
|
||||
// Variables
|
||||
"init-declarations": 0, // because no-undef-init is on and we actually want undefineds
|
||||
"no-catch-shadow": 0, // no IE8 support anyway
|
||||
"no-label-var": 1,
|
||||
"no-restricted-globals": 1,
|
||||
"no-return-assign": 0, // can make sense.
|
||||
"no-shadow-restricted-names": 1,
|
||||
"no-shadow": 0, // this is javascript. it has forEach and all that stuff.
|
||||
"no-undef-init": 1,
|
||||
"no-undef": 2,
|
||||
"no-undefined": 0, // produces shorter code when testing against this
|
||||
"no-use-before-define": 0, // can actually be used for a better overview, i.e. with module.exports
|
||||
"no-unused-vars": 1, // a warning is sufficient
|
||||
|
||||
// Node.js and CommonJS
|
||||
"callback-return": 1,
|
||||
"global-require": 0, // only way to resolve cyclic references
|
||||
"handle-callback-err": 1,
|
||||
"no-mixed-requires": 1,
|
||||
"no-new-require": 1,
|
||||
"no-path-concat": 1,
|
||||
"no-process-env": 1,
|
||||
"no-process-exit": 1,
|
||||
"no-restricted-modules": 1,
|
||||
"no-sync": 0, // for loadSync
|
||||
|
||||
// Stylistic Issues
|
||||
"semi": 1, // maybe next time
|
||||
"no-extra-semi": 1,
|
||||
"quotes": 1, // useful for gzip
|
||||
"no-trailing-spaces": 1,
|
||||
"no-unneeded-ternary": 1,
|
||||
"unicode-bom": [2, "never"]
|
||||
|
||||
// ECMAScript 6 // maybe next time
|
||||
}
|
||||
}
|
||||
Executable
+5
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"instrumentation": {
|
||||
"root": "./src"
|
||||
}
|
||||
}
|
||||
Executable
+50
@@ -0,0 +1,50 @@
|
||||
{
|
||||
"tags": {
|
||||
"allowUnknownTags": true
|
||||
},
|
||||
"source": {
|
||||
"include": [
|
||||
"./src/",
|
||||
"./lib/aspromise/index.js",
|
||||
"./lib/base64/index.js",
|
||||
"./lib/codegen/index.js",
|
||||
"./lib/eventemitter/index.js",
|
||||
"./lib/fetch/index.js",
|
||||
"./lib/inquire/index.js",
|
||||
"./lib/path/index.js",
|
||||
"./lib/pool/index.js",
|
||||
"./lib/utf8/index.js"
|
||||
],
|
||||
"exclude": [],
|
||||
"includePattern": ".+\\.js(doc)?$",
|
||||
"excludePattern": "(^|\\/|\\\\)_"
|
||||
},
|
||||
"plugins": [
|
||||
"./node_modules/jsdoc/plugins/markdown"
|
||||
],
|
||||
"templates": {
|
||||
"cleverLinks" : false,
|
||||
"monospaceLinks": false,
|
||||
"default" : {
|
||||
"outputSourceFiles" : false
|
||||
},
|
||||
"applicationName": "protobuf.js",
|
||||
"googleAnalytics": "UA-40277577-3",
|
||||
"linenums" : true
|
||||
},
|
||||
"markdown" : {
|
||||
"parser" : "gfm",
|
||||
"hardwrap" : true,
|
||||
"idInHeadings" : true
|
||||
},
|
||||
"opts": {
|
||||
"encoding" : "utf8",
|
||||
"recurse" : true,
|
||||
"private" : false,
|
||||
"lenient" : false,
|
||||
"destination" : "./docs",
|
||||
"template" : "./node_modules/jaguarjs-jsdoc",
|
||||
"sourceRoot" : "https://github.com/dcodeIO/protobuf.js/blob/master/src/",
|
||||
"repo" : "https://github.com/dcodeIO/protobuf.js"
|
||||
}
|
||||
}
|
||||
Executable
+29
@@ -0,0 +1,29 @@
|
||||
{
|
||||
"extends": "tslint:recommended",
|
||||
"rules": {
|
||||
"array-type": [ true, "array" ],
|
||||
"no-namespace": false,
|
||||
"interface-name": [ false ],
|
||||
"interface-over-type-literal": true,
|
||||
"no-empty-interface": false,
|
||||
"max-line-length": [ false ],
|
||||
"trailing-comma": [ true, "never" ],
|
||||
"variable-name": [ false ],
|
||||
"max-classes-per-file": [ false ],
|
||||
"member-ordering": [ false ],
|
||||
"object-literal-sort-keys": false,
|
||||
"no-string-literal": false,
|
||||
"prefer-const": false,
|
||||
"adjacent-overload-signatures": false,
|
||||
"no-shadowed-variable": false,
|
||||
"ban-types": [
|
||||
true,
|
||||
["Object", "Avoid using the `Object` type. Did you mean `object`?"],
|
||||
// ["Function", "Avoid using the `Function` type. Prefer a specific function type, like `() => void`."],
|
||||
["Boolean", "Avoid using the `Boolean` type. Did you mean `boolean`?"],
|
||||
["Number", "Avoid using the `Number` type. Did you mean `number`?"],
|
||||
["String", "Avoid using the `String` type. Did you mean `string`?"],
|
||||
["Symbol", "Avoid using the `Symbol` type. Did you mean `symbol`?"]
|
||||
]
|
||||
}
|
||||
}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
This folder contains prebuilt browser versions of the full library. When sending pull requests, it is not required to update these.
|
||||
|
||||
Prebuilt files are in source control to enable pain-free frontend respectively CDN usage:
|
||||
|
||||
CDN usage
|
||||
---------
|
||||
|
||||
Development:
|
||||
```
|
||||
<script src="//cdn.rawgit.com/dcodeIO/protobuf.js/6.X.X/dist/protobuf.js"></script>
|
||||
```
|
||||
|
||||
Production:
|
||||
```
|
||||
<script src="//cdn.rawgit.com/dcodeIO/protobuf.js/6.X.X/dist/protobuf.min.js"></script>
|
||||
```
|
||||
|
||||
**NOTE:** Remember to replace the version tag with the exact [release](https://github.com/dcodeIO/protobuf.js/tags) your project depends upon.
|
||||
|
||||
Frontend usage
|
||||
--------------
|
||||
|
||||
Development:
|
||||
```
|
||||
<script src="node_modules/protobufjs/dist/protobuf.js"></script>
|
||||
```
|
||||
|
||||
Production:
|
||||
```
|
||||
<script src="node_modules/protobufjs/dist/protobuf.min.js"></script>
|
||||
```
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
This folder contains prebuilt browser versions of the light library suitable for use with reflection, static code and JSON descriptors / modules. When sending pull requests, it is not required to update these.
|
||||
|
||||
Prebuilt files are in source control to enable pain-free frontend respectively CDN usage:
|
||||
|
||||
CDN usage
|
||||
---------
|
||||
|
||||
Development:
|
||||
```
|
||||
<script src="//cdn.rawgit.com/dcodeIO/protobuf.js/6.X.X/dist/light/protobuf.js"></script>
|
||||
```
|
||||
|
||||
Production:
|
||||
```
|
||||
<script src="//cdn.rawgit.com/dcodeIO/protobuf.js/6.X.X/dist/light/protobuf.min.js"></script>
|
||||
```
|
||||
|
||||
**NOTE:** Remember to replace the version tag with the exact [release](https://github.com/dcodeIO/protobuf.js/tags) your project depends upon.
|
||||
|
||||
Frontend usage
|
||||
--------------
|
||||
|
||||
Development:
|
||||
```
|
||||
<script src="node_modules/protobufjs/dist/light/protobuf.js"></script>
|
||||
```
|
||||
|
||||
Production:
|
||||
```
|
||||
<script src="node_modules/protobufjs/dist/light/protobuf.min.js"></script>
|
||||
```
|
||||
+7152
File diff suppressed because it is too large
Load Diff
+1
File diff suppressed because one or more lines are too long
+8
File diff suppressed because one or more lines are too long
+1
File diff suppressed because one or more lines are too long
+31
@@ -0,0 +1,31 @@
|
||||
This folder contains prebuilt browser versions of the minimal library suitable for use with statically generated code only. When sending pull requests, it is not required to update these.
|
||||
|
||||
Prebuilt files are in source control to enable pain-free frontend respectively CDN usage:
|
||||
|
||||
CDN usage
|
||||
---------
|
||||
|
||||
Development:
|
||||
```
|
||||
<script src="//cdn.rawgit.com/dcodeIO/protobuf.js/6.X.X/dist/minimal/protobuf.js"></script>
|
||||
```
|
||||
|
||||
Production:
|
||||
```
|
||||
<script src="//cdn.rawgit.com/dcodeIO/protobuf.js/6.X.X/dist/minimal/protobuf.min.js"></script>
|
||||
```
|
||||
|
||||
**NOTE:** Remember to replace the version tag with the exact [release](https://github.com/dcodeIO/protobuf.js/tags) your project depends upon.
|
||||
|
||||
Frontend usage
|
||||
--------------
|
||||
|
||||
Development:
|
||||
```
|
||||
<script src="node_modules/protobufjs/dist/minimal/protobuf.js"></script>
|
||||
```
|
||||
|
||||
Production:
|
||||
```
|
||||
<script src="node_modules/protobufjs/dist/minimal/protobuf.min.js"></script>
|
||||
```
|
||||
+2684
File diff suppressed because it is too large
Load Diff
+1
File diff suppressed because one or more lines are too long
+8
File diff suppressed because one or more lines are too long
+1
File diff suppressed because one or more lines are too long
+8726
File diff suppressed because it is too large
Load Diff
+1
File diff suppressed because one or more lines are too long
+8
File diff suppressed because one or more lines are too long
+1
File diff suppressed because one or more lines are too long
+50
@@ -0,0 +1,50 @@
|
||||
// this example demonstrates a way to keep field casing (as defined within .proto files)
|
||||
// while still having virtual getters and setters for the camel cased counterparts.
|
||||
|
||||
/*eslint-disable strict, no-console*/
|
||||
var protobuf = require("..");
|
||||
|
||||
var proto = "syntax=\"proto3\";\
|
||||
message MyMessage {\
|
||||
string some_field = 1;\
|
||||
}";
|
||||
|
||||
var root = protobuf.parse(proto, { keepCase: true }).root; // or use Root#load
|
||||
|
||||
// converts a string from underscore notation to camel case
|
||||
function toCamelCase(str) {
|
||||
return str.substring(0,1) + str.substring(1).replace(/_([a-z])(?=[a-z]|$)/g, function($0, $1) { return $1.toUpperCase(); });
|
||||
}
|
||||
|
||||
// adds a virtual alias property
|
||||
function addAliasProperty(type, name, aliasName) {
|
||||
if (aliasName !== name)
|
||||
Object.defineProperty(type.ctor.prototype, aliasName, {
|
||||
get: function() { return this[name]; },
|
||||
set: function(value) { this[name] = value; }
|
||||
});
|
||||
}
|
||||
|
||||
// this function adds alternative getters and setters for the camel cased counterparts
|
||||
// to the runtime message's prototype (i.e. without having to register a custom class):
|
||||
function addVirtualCamelcaseFields(type) {
|
||||
type.fieldsArray.forEach(function(field) {
|
||||
addAliasProperty(type, field.name, toCamelCase(field.name));
|
||||
});
|
||||
type.oneofsArray.forEach(function(oneof) {
|
||||
addAliasProperty(type, oneof.name, toCamelCase(oneof.name));
|
||||
});
|
||||
return type;
|
||||
}
|
||||
|
||||
var MyMessage = addVirtualCamelcaseFields(root.lookup("MyMessage"));
|
||||
|
||||
var myMessage = MyMessage.create({
|
||||
some_field /* or someField */: "hello world"
|
||||
});
|
||||
|
||||
console.log(
|
||||
"someField:", myMessage.someField,
|
||||
"\nsome_field:", myMessage.some_field,
|
||||
"\nJSON:", JSON.stringify(myMessage)
|
||||
);
|
||||
+42
@@ -0,0 +1,42 @@
|
||||
// This example shows how decorators can be used with plain JavaScript. It's otherwise identical to
|
||||
// the README example.
|
||||
|
||||
/*eslint-disable strict, no-console*/
|
||||
var protobuf = require("../light");
|
||||
|
||||
var Type = protobuf.Type,
|
||||
Field = protobuf.Field,
|
||||
OneOf = protobuf.OneOf;
|
||||
|
||||
function AwesomeSubMessage(properties) {
|
||||
protobuf.Message.call(this, properties);
|
||||
}
|
||||
|
||||
(AwesomeSubMessage.prototype = Object.create(protobuf.Message)).constructor = AwesomeSubMessage;
|
||||
|
||||
Field.d(1, "string", "optional", "awesome default string")(AwesomeSubMessage.prototype, "awesomeField");
|
||||
|
||||
var AwesomeEnum = {
|
||||
ONE: 1,
|
||||
TWO: 2
|
||||
};
|
||||
|
||||
Type.d("SuperAwesomeMessage")(AwesomeMessage);
|
||||
function AwesomeMessage(properties) {
|
||||
protobuf.Message.call(this, properties);
|
||||
}
|
||||
|
||||
(AwesomeMessage.prototype = Object.create(protobuf.Message)).constructor = AwesomeMessage;
|
||||
|
||||
Field.d(1, "string", "optional", "awesome default string")(AwesomeMessage.prototype, "awesomeField");
|
||||
Field.d(2, AwesomeSubMessage)(AwesomeMessage.prototype, "awesomeSubMessage");
|
||||
Field.d(3, AwesomeEnum, "optional", AwesomeEnum.ONE)(AwesomeMessage.prototype, "awesomeEnum");
|
||||
OneOf.d("awesomeSubMessage", "awesomeEnum")(AwesomeMessage.prototype, "which");
|
||||
|
||||
// example code
|
||||
var message = new AwesomeMessage({ awesomeField: "hello" });
|
||||
var buffer = AwesomeMessage.encode(message).finish();
|
||||
var decoded = AwesomeMessage.decode(buffer);
|
||||
|
||||
console.log(decoded);
|
||||
console.log("internal name: " + AwesomeMessage.$type.name);
|
||||
+25
@@ -0,0 +1,25 @@
|
||||
// this example demonstrates how to use the reader/writer interface directly to read and write the
|
||||
// protobuf wire format.
|
||||
|
||||
/*eslint-disable strict, no-console*/
|
||||
var protobuf = require("../runtime"); // require("protobufjs/runtime");
|
||||
|
||||
// writing
|
||||
var buffer = protobuf.Writer.create()
|
||||
.uint32((1 << 3 | 2) >>> 0) // id 1, wireType 2
|
||||
.string("hello world!")
|
||||
.finish();
|
||||
|
||||
// reading
|
||||
var reader = protobuf.Reader.create(buffer);
|
||||
while (reader.pos < reader.len) {
|
||||
var tag = reader.uint32();
|
||||
switch (/*id*/ tag >>> 3) {
|
||||
case 1:
|
||||
console.log(reader.string());
|
||||
break;
|
||||
default:
|
||||
reader.skipType(/*wireType*/ tag & 7);
|
||||
break;
|
||||
}
|
||||
}
|
||||
+114
@@ -0,0 +1,114 @@
|
||||
// this example demonstrates how to consume a streaming rpc service.
|
||||
|
||||
/*eslint-disable strict, no-console*/
|
||||
var protobuf = require("..");
|
||||
|
||||
// Load a definition with services:
|
||||
|
||||
var root = protobuf.Root.fromJSON({
|
||||
nested: {
|
||||
Greeter: {
|
||||
methods: {
|
||||
"SayHello": {
|
||||
requestType: "Hello",
|
||||
requestStream: true,
|
||||
responseType: "World",
|
||||
responseStream: true
|
||||
}
|
||||
}
|
||||
},
|
||||
Hello: {
|
||||
fields: {
|
||||
name: {
|
||||
type: "string",
|
||||
id: 1
|
||||
}
|
||||
}
|
||||
},
|
||||
World: {
|
||||
fields: {
|
||||
message: {
|
||||
type: "string",
|
||||
id: 1
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
// Get its types:
|
||||
|
||||
var Greeter = root.lookup("Greeter"),
|
||||
Hello = root.lookup("Hello"),
|
||||
World = root.lookup("World");
|
||||
|
||||
// Provide a stream-aware RPC implementation:
|
||||
|
||||
var greeter = Greeter.create(/* rpcImpl */ (function() { // API documentation: Service#create
|
||||
var ended = false;
|
||||
return function myRPCImpl(method, requestData, callback) {
|
||||
if (ended)
|
||||
return;
|
||||
if (!requestData) {
|
||||
ended = true;
|
||||
return;
|
||||
}
|
||||
// in a real-world scenario, the client would now send requestData to a server using some
|
||||
// sort of transport layer (i.e. http), wait for responseData and call the callback.
|
||||
performRequestOverTransportChannel(requestData, function(responseData) {
|
||||
callback(null, responseData);
|
||||
});
|
||||
};
|
||||
})(), /* requestDelimited? */ true, /* responseDelimited? */ true);
|
||||
|
||||
// examplary server-side code for the sake of this example
|
||||
function performRequestOverTransportChannel(requestData, callback) {
|
||||
setTimeout(/* simulated delay */function() {
|
||||
// 1. server decodes the request
|
||||
var request = Hello.decodeDelimited(requestData);
|
||||
// 2. server handles the request and creates a response
|
||||
var response = { message: "Hello " + request.name };
|
||||
setTimeout(/* simulated delay */function() {
|
||||
// 3. server encodes and sends the response
|
||||
callback(World.encodeDelimited(response).finish());
|
||||
}, Math.random() * 250);
|
||||
}, Math.random() * 250);
|
||||
}
|
||||
|
||||
// Listen for events:
|
||||
|
||||
greeter.on("data", function(response, method) {
|
||||
console.log("data in " + method.name + ":", response.message);
|
||||
});
|
||||
|
||||
greeter.on("end", function() {
|
||||
console.log("end");
|
||||
});
|
||||
|
||||
greeter.on("error", function(err, method) {
|
||||
console.log("error in " + method.name + ":", err);
|
||||
});
|
||||
|
||||
// Call methods:
|
||||
|
||||
greeter.sayHello({ name: "one" });
|
||||
greeter.sayHello(Hello.create({ name: "two" })); // or use runtime messages
|
||||
|
||||
// Listen to and emit your own events if you like:
|
||||
|
||||
greeter.on("status", function(code, text) {
|
||||
console.log("custom status:", code, text);
|
||||
});
|
||||
|
||||
greeter.emit("status", 200, "OK");
|
||||
|
||||
// And, if applicable, end the service when you are done:
|
||||
|
||||
setTimeout(function() {
|
||||
greeter.end();
|
||||
// ^ Signals rpcImpl that the service has been ended client-side by calling it with a null buffer.
|
||||
// Likewise, rpcImpl can also end the stream by calling its callback with an explicit null buffer.
|
||||
greeter.sayHello({ name: "three" }, function(err) {
|
||||
console.error("this should fail: " + err.message);
|
||||
});
|
||||
}, 501);
|
||||
+42
@@ -0,0 +1,42 @@
|
||||
// this example demonstrates how to traverse through a root instance by calling a custom function
|
||||
// for each message type within.
|
||||
|
||||
/*eslint-disable strict, no-console*/
|
||||
var protobuf = require(".."); // require("protobufjs");
|
||||
|
||||
// traverse-types.proto
|
||||
var proto = "syntax=\"proto3\";\
|
||||
package example;\
|
||||
message Foo {\
|
||||
string a = 1;\
|
||||
}\
|
||||
message Bar {\
|
||||
uint32 b = 1;\
|
||||
\
|
||||
message Inner {\
|
||||
bytes c = 1;\
|
||||
}\
|
||||
}";
|
||||
|
||||
// the following is loading a string.
|
||||
// in a real application, it'd be more like protobuf.load("traverse-types.proto", ...)
|
||||
protobuf.parse.filename = "traverse-types.proto";
|
||||
var root = protobuf.parse(proto).root;
|
||||
|
||||
function traverseTypes(current, fn) {
|
||||
if (current instanceof protobuf.Type) // and/or protobuf.Enum, protobuf.Service etc.
|
||||
fn(current);
|
||||
if (current.nestedArray)
|
||||
current.nestedArray.forEach(function(nested) {
|
||||
traverseTypes(nested, fn);
|
||||
});
|
||||
}
|
||||
|
||||
traverseTypes(root, function(type) {
|
||||
console.log(
|
||||
type.constructor.className + " " + type.name
|
||||
+ "\n fully qualified name: " + type.fullName
|
||||
+ "\n defined in: " + type.filename
|
||||
+ "\n parent: " + type.parent + " in " + type.parent.filename
|
||||
);
|
||||
});
|
||||
Executable
+4
@@ -0,0 +1,4 @@
|
||||
protobufjs/ext/debug
|
||||
=========================
|
||||
|
||||
Experimental debugging extension.
|
||||
Executable
+71
@@ -0,0 +1,71 @@
|
||||
"use strict";
|
||||
var protobuf = require("../..");
|
||||
|
||||
/**
|
||||
* Debugging utility functions. Only present in debug builds.
|
||||
* @namespace
|
||||
*/
|
||||
var debug = protobuf.debug = module.exports = {};
|
||||
|
||||
var codegen = protobuf.util.codegen;
|
||||
|
||||
var debugFnRe = /function ([^(]+)\(([^)]*)\) {/g;
|
||||
|
||||
// Counts number of calls to any generated function
|
||||
function codegen_debug() {
|
||||
codegen_debug.supported = codegen.supported;
|
||||
codegen_debug.verbose = codegen.verbose;
|
||||
var gen = codegen.apply(null, Array.prototype.slice.call(arguments));
|
||||
gen.str = (function(str) { return function str_debug() {
|
||||
return str.apply(null, Array.prototype.slice.call(arguments)).replace(debugFnRe, "function $1($2) {\n\t$1.calls=($1.calls|0)+1");
|
||||
};})(gen.str);
|
||||
return gen;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a list of unused types within the specified root.
|
||||
* @param {NamespaceBase} ns Namespace to search
|
||||
* @returns {Type[]} Unused types
|
||||
*/
|
||||
debug.unusedTypes = function unusedTypes(ns) {
|
||||
|
||||
/* istanbul ignore if */
|
||||
if (!(ns instanceof protobuf.Namespace))
|
||||
throw TypeError("ns must be a Namespace");
|
||||
|
||||
/* istanbul ignore if */
|
||||
if (!ns.nested)
|
||||
return [];
|
||||
|
||||
var unused = [];
|
||||
for (var names = Object.keys(ns.nested), i = 0; i < names.length; ++i) {
|
||||
var nested = ns.nested[names[i]];
|
||||
if (nested instanceof protobuf.Type) {
|
||||
var calls = (nested.encode.calls|0)
|
||||
+ (nested.decode.calls|0)
|
||||
+ (nested.verify.calls|0)
|
||||
+ (nested.toObject.calls|0)
|
||||
+ (nested.fromObject.calls|0);
|
||||
if (!calls)
|
||||
unused.push(nested);
|
||||
} else if (nested instanceof protobuf.Namespace)
|
||||
Array.prototype.push.apply(unused, unusedTypes(nested));
|
||||
}
|
||||
return unused;
|
||||
};
|
||||
|
||||
/**
|
||||
* Enables debugging extensions.
|
||||
* @returns {undefined}
|
||||
*/
|
||||
debug.enable = function enable() {
|
||||
protobuf.util.codegen = codegen_debug;
|
||||
};
|
||||
|
||||
/**
|
||||
* Disables debugging extensions.
|
||||
* @returns {undefined}
|
||||
*/
|
||||
debug.disable = function disable() {
|
||||
protobuf.util.codegen = codegen;
|
||||
};
|
||||
+72
@@ -0,0 +1,72 @@
|
||||
protobufjs/ext/descriptor
|
||||
=========================
|
||||
|
||||
Experimental extension for interoperability with [descriptor.proto](https://github.com/google/protobuf/blob/master/src/google/protobuf/descriptor.proto) types.
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
```js
|
||||
var protobuf = require("protobufjs"), // requires the full library
|
||||
descriptor = require("protobufjs/ext/descriptor");
|
||||
|
||||
var root = ...;
|
||||
|
||||
// convert any existing root instance to the corresponding descriptor type
|
||||
var descriptor = root.toDescriptor("proto2");
|
||||
// ^ returns a FileDescriptorSet message, see table below
|
||||
|
||||
// encode to a descriptor buffer
|
||||
var buffer = descriptor.FileDescriptorSet.encode(descriptor).finish();
|
||||
|
||||
// decode from a descriptor buffer
|
||||
var decodedDescriptor = descriptor.FileDescriptorSet.decode(buffer);
|
||||
|
||||
// convert any existing descriptor to a root instance
|
||||
root = protobuf.Root.fromDescriptor(decodedDescriptor);
|
||||
// ^ expects a FileDescriptorSet message or buffer, see table below
|
||||
|
||||
// and start all over again
|
||||
```
|
||||
|
||||
API
|
||||
---
|
||||
|
||||
The extension adds `.fromDescriptor(descriptor[, syntax])` and `#toDescriptor([syntax])` methods to reflection objects and exports the `.google.protobuf` namespace of the internally used `Root` instance containing the following types present in descriptor.proto:
|
||||
|
||||
| Descriptor type | protobuf.js type | Remarks
|
||||
|-------------------------------|------------------|---------
|
||||
| **FileDescriptorSet** | Root |
|
||||
| FileDescriptorProto | | dependencies are not supported
|
||||
| FileOptions | |
|
||||
| FileOptionsOptimizeMode | |
|
||||
| SourceCodeInfo | | not supported
|
||||
| SourceCodeInfoLocation | |
|
||||
| GeneratedCodeInfo | | not supported
|
||||
| GeneratedCodeInfoAnnotation | |
|
||||
| **DescriptorProto** | Type |
|
||||
| MessageOptions | |
|
||||
| DescriptorProtoExtensionRange | |
|
||||
| DescriptorProtoReservedRange | |
|
||||
| **FieldDescriptorProto** | Field |
|
||||
| FieldDescriptorProtoLabel | |
|
||||
| FieldDescriptorProtoType | |
|
||||
| FieldOptions | |
|
||||
| FieldOptionsCType | |
|
||||
| FieldOptionsJSType | |
|
||||
| **OneofDescriptorProto** | OneOf |
|
||||
| OneofOptions | |
|
||||
| **EnumDescriptorProto** | Enum |
|
||||
| EnumOptions | |
|
||||
| EnumValueDescriptorProto | |
|
||||
| EnumValueOptions | | not supported
|
||||
| **ServiceDescriptorProto** | Service |
|
||||
| ServiceOptions | |
|
||||
| **MethodDescriptorProto** | Method |
|
||||
| MethodOptions | |
|
||||
| UninterpretedOption | | not supported
|
||||
| UninterpretedOptionNamePart | |
|
||||
|
||||
Note that not all features of descriptor.proto translate perfectly to a protobuf.js root instance. A root instance has only limited knowlege of packages or individual files for example, which is then compensated by guessing and generating fictional file names.
|
||||
|
||||
When using TypeScript, the respective interface types can be used to reference specific message instances (i.e. `protobuf.Message<IDescriptorProto>`).
|
||||
+191
@@ -0,0 +1,191 @@
|
||||
import * as $protobuf from "../..";
|
||||
export const FileDescriptorSet: $protobuf.Type;
|
||||
|
||||
export const FileDescriptorProto: $protobuf.Type;
|
||||
|
||||
export const DescriptorProto: $protobuf.Type & {
|
||||
ExtensionRange: $protobuf.Type,
|
||||
ReservedRange: $protobuf.Type
|
||||
};
|
||||
|
||||
export const FieldDescriptorProto: $protobuf.Type & {
|
||||
Label: $protobuf.Enum,
|
||||
Type: $protobuf.Enum
|
||||
};
|
||||
|
||||
export const OneofDescriptorProto: $protobuf.Type;
|
||||
|
||||
export const EnumDescriptorProto: $protobuf.Type;
|
||||
|
||||
export const ServiceDescriptorProto: $protobuf.Type;
|
||||
|
||||
export const EnumValueDescriptorProto: $protobuf.Type;
|
||||
|
||||
export const MethodDescriptorProto: $protobuf.Type;
|
||||
|
||||
export const FileOptions: $protobuf.Type & {
|
||||
OptimizeMode: $protobuf.Enum
|
||||
};
|
||||
|
||||
export const MessageOptions: $protobuf.Type;
|
||||
|
||||
export const FieldOptions: $protobuf.Type & {
|
||||
CType: $protobuf.Enum,
|
||||
JSType: $protobuf.Enum
|
||||
};
|
||||
|
||||
export const OneofOptions: $protobuf.Type;
|
||||
|
||||
export const EnumOptions: $protobuf.Type;
|
||||
|
||||
export const EnumValueOptions: $protobuf.Type;
|
||||
|
||||
export const ServiceOptions: $protobuf.Type;
|
||||
|
||||
export const MethodOptions: $protobuf.Type;
|
||||
|
||||
export const UninterpretedOption: $protobuf.Type & {
|
||||
NamePart: $protobuf.Type
|
||||
};
|
||||
|
||||
export const SourceCodeInfo: $protobuf.Type & {
|
||||
Location: $protobuf.Type
|
||||
};
|
||||
|
||||
export const GeneratedCodeInfo: $protobuf.Type & {
|
||||
Annotation: $protobuf.Type
|
||||
};
|
||||
|
||||
export interface IFileDescriptorSet {
|
||||
file: IFileDescriptorProto[];
|
||||
}
|
||||
|
||||
export interface IFileDescriptorProto {
|
||||
name?: string;
|
||||
package?: string;
|
||||
dependency?: any;
|
||||
publicDependency?: any;
|
||||
weakDependency?: any;
|
||||
messageType?: IDescriptorProto[];
|
||||
enumType?: IEnumDescriptorProto[];
|
||||
service?: IServiceDescriptorProto[];
|
||||
extension?: IFieldDescriptorProto[];
|
||||
options?: IFileOptions;
|
||||
sourceCodeInfo?: any;
|
||||
syntax?: string;
|
||||
}
|
||||
|
||||
export interface IFileOptions {
|
||||
javaPackage?: string;
|
||||
javaOuterClassname?: string;
|
||||
javaMultipleFiles?: boolean;
|
||||
javaGenerateEqualsAndHash?: boolean;
|
||||
javaStringCheckUtf8?: boolean;
|
||||
optimizeFor?: IFileOptionsOptimizeMode;
|
||||
goPackage?: string;
|
||||
ccGenericServices?: boolean;
|
||||
javaGenericServices?: boolean;
|
||||
pyGenericServices?: boolean;
|
||||
deprecated?: boolean;
|
||||
ccEnableArenas?: boolean;
|
||||
objcClassPrefix?: string;
|
||||
csharpNamespace?: string;
|
||||
}
|
||||
|
||||
type IFileOptionsOptimizeMode = number;
|
||||
|
||||
export interface IDescriptorProto {
|
||||
name?: string;
|
||||
field?: IFieldDescriptorProto[];
|
||||
extension?: IFieldDescriptorProto[];
|
||||
nestedType?: IDescriptorProto[];
|
||||
enumType?: IEnumDescriptorProto[];
|
||||
extensionRange?: IDescriptorProtoExtensionRange[];
|
||||
oneofDecl?: IOneofDescriptorProto[];
|
||||
options?: IMessageOptions;
|
||||
reservedRange?: IDescriptorProtoReservedRange[];
|
||||
reservedName?: string[];
|
||||
}
|
||||
|
||||
export interface IMessageOptions {
|
||||
mapEntry?: boolean;
|
||||
}
|
||||
|
||||
export interface IDescriptorProtoExtensionRange {
|
||||
start?: number;
|
||||
end?: number;
|
||||
}
|
||||
|
||||
export interface IDescriptorProtoReservedRange {
|
||||
start?: number;
|
||||
end?: number;
|
||||
}
|
||||
|
||||
export interface IFieldDescriptorProto {
|
||||
name?: string;
|
||||
number?: number;
|
||||
label?: IFieldDescriptorProtoLabel;
|
||||
type?: IFieldDescriptorProtoType;
|
||||
typeName?: string;
|
||||
extendee?: string;
|
||||
defaultValue?: string;
|
||||
oneofIndex?: number;
|
||||
jsonName?: any;
|
||||
options?: IFieldOptions;
|
||||
}
|
||||
|
||||
type IFieldDescriptorProtoLabel = number;
|
||||
|
||||
type IFieldDescriptorProtoType = number;
|
||||
|
||||
export interface IFieldOptions {
|
||||
packed?: boolean;
|
||||
jstype?: IFieldOptionsJSType;
|
||||
}
|
||||
|
||||
type IFieldOptionsJSType = number;
|
||||
|
||||
export interface IEnumDescriptorProto {
|
||||
name?: string;
|
||||
value?: IEnumValueDescriptorProto[];
|
||||
options?: IEnumOptions;
|
||||
}
|
||||
|
||||
export interface IEnumValueDescriptorProto {
|
||||
name?: string;
|
||||
number?: number;
|
||||
options?: any;
|
||||
}
|
||||
|
||||
export interface IEnumOptions {
|
||||
allowAlias?: boolean;
|
||||
deprecated?: boolean;
|
||||
}
|
||||
|
||||
export interface IOneofDescriptorProto {
|
||||
name?: string;
|
||||
options?: any;
|
||||
}
|
||||
|
||||
export interface IServiceDescriptorProto {
|
||||
name?: string;
|
||||
method?: IMethodDescriptorProto[];
|
||||
options?: IServiceOptions;
|
||||
}
|
||||
|
||||
export interface IServiceOptions {
|
||||
deprecated?: boolean;
|
||||
}
|
||||
|
||||
export interface IMethodDescriptorProto {
|
||||
name?: string;
|
||||
inputType?: string;
|
||||
outputType?: string;
|
||||
options?: IMethodOptions;
|
||||
clientStreaming?: boolean;
|
||||
serverStreaming?: boolean;
|
||||
}
|
||||
|
||||
export interface IMethodOptions {
|
||||
deprecated?: boolean;
|
||||
}
|
||||
Executable
+1052
File diff suppressed because it is too large
Load Diff
Executable
+54
@@ -0,0 +1,54 @@
|
||||
/*eslint-disable no-console*/
|
||||
"use strict";
|
||||
var protobuf = require("../../"),
|
||||
descriptor = require(".");
|
||||
|
||||
/* var proto = {
|
||||
nested: {
|
||||
Message: {
|
||||
fields: {
|
||||
foo: {
|
||||
type: "string",
|
||||
id: 1
|
||||
}
|
||||
},
|
||||
nested: {
|
||||
SubMessage: {
|
||||
fields: {}
|
||||
}
|
||||
}
|
||||
},
|
||||
Enum: {
|
||||
values: {
|
||||
ONE: 1,
|
||||
TWO: 2
|
||||
}
|
||||
}
|
||||
}
|
||||
}; */
|
||||
|
||||
// var root = protobuf.Root.fromJSON(proto).resolveAll();
|
||||
var root = protobuf.loadSync("tests/data/google/protobuf/descriptor.proto").resolveAll();
|
||||
|
||||
// console.log("Original proto", JSON.stringify(root, null, 2));
|
||||
|
||||
var msg = root.toDescriptor();
|
||||
|
||||
// console.log("\nDescriptor", JSON.stringify(msg.toObject(), null, 2));
|
||||
|
||||
var buf = descriptor.FileDescriptorSet.encode(msg).finish();
|
||||
var root2 = protobuf.Root.fromDescriptor(buf, "proto2").resolveAll();
|
||||
|
||||
// console.log("\nDecoded proto", JSON.stringify(root2, null, 2));
|
||||
|
||||
var diff = require("deep-diff").diff(root.toJSON(), root2.toJSON());
|
||||
if (diff) {
|
||||
diff.forEach(function(diff) {
|
||||
console.log(diff.kind + " @ " + diff.path.join("."));
|
||||
console.log("lhs:", typeof diff.lhs, diff.lhs);
|
||||
console.log("rhs:", typeof diff.rhs, diff.rhs);
|
||||
console.log();
|
||||
});
|
||||
process.exitCode = 1;
|
||||
} else
|
||||
console.log("no differences");
|
||||
Executable
+27
@@ -0,0 +1,27 @@
|
||||
Copyright 2014, Google Inc. All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are
|
||||
met:
|
||||
|
||||
* Redistributions of source code must retain the above copyright
|
||||
notice, this list of conditions and the following disclaimer.
|
||||
* Redistributions in binary form must reproduce the above
|
||||
copyright notice, this list of conditions and the following disclaimer
|
||||
in the documentation and/or other materials provided with the
|
||||
distribution.
|
||||
* Neither the name of Google Inc. nor the names of its
|
||||
contributors may be used to endorse or promote products derived from
|
||||
this software without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
Executable
+1
@@ -0,0 +1 @@
|
||||
This folder contains stripped and pre-parsed definitions of common Google types. These files are not used by protobuf.js directly but are here so you can use or include them where required.
|
||||
+83
@@ -0,0 +1,83 @@
|
||||
{
|
||||
"nested": {
|
||||
"google": {
|
||||
"nested": {
|
||||
"api": {
|
||||
"nested": {
|
||||
"http": {
|
||||
"type": "HttpRule",
|
||||
"id": 72295728,
|
||||
"extend": "google.protobuf.MethodOptions"
|
||||
},
|
||||
"HttpRule": {
|
||||
"oneofs": {
|
||||
"pattern": {
|
||||
"oneof": [
|
||||
"get",
|
||||
"put",
|
||||
"post",
|
||||
"delete",
|
||||
"patch",
|
||||
"custom"
|
||||
]
|
||||
}
|
||||
},
|
||||
"fields": {
|
||||
"get": {
|
||||
"type": "string",
|
||||
"id": 2
|
||||
},
|
||||
"put": {
|
||||
"type": "string",
|
||||
"id": 3
|
||||
},
|
||||
"post": {
|
||||
"type": "string",
|
||||
"id": 4
|
||||
},
|
||||
"delete": {
|
||||
"type": "string",
|
||||
"id": 5
|
||||
},
|
||||
"patch": {
|
||||
"type": "string",
|
||||
"id": 6
|
||||
},
|
||||
"custom": {
|
||||
"type": "CustomHttpPattern",
|
||||
"id": 8
|
||||
},
|
||||
"selector": {
|
||||
"type": "string",
|
||||
"id": 1
|
||||
},
|
||||
"body": {
|
||||
"type": "string",
|
||||
"id": 7
|
||||
},
|
||||
"additionalBindings": {
|
||||
"rule": "repeated",
|
||||
"type": "HttpRule",
|
||||
"id": 11
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"protobuf": {
|
||||
"nested": {
|
||||
"MethodOptions": {
|
||||
"fields": {},
|
||||
"extensions": [
|
||||
[
|
||||
1000,
|
||||
536870911
|
||||
]
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
+11
@@ -0,0 +1,11 @@
|
||||
syntax = "proto3";
|
||||
|
||||
package google.api;
|
||||
|
||||
import "google/api/http.proto";
|
||||
import "google/protobuf/descriptor.proto";
|
||||
|
||||
extend google.protobuf.MethodOptions {
|
||||
|
||||
HttpRule http = 72295728;
|
||||
}
|
||||
Executable
+86
@@ -0,0 +1,86 @@
|
||||
{
|
||||
"nested": {
|
||||
"google": {
|
||||
"nested": {
|
||||
"api": {
|
||||
"nested": {
|
||||
"Http": {
|
||||
"fields": {
|
||||
"rules": {
|
||||
"rule": "repeated",
|
||||
"type": "HttpRule",
|
||||
"id": 1
|
||||
}
|
||||
}
|
||||
},
|
||||
"HttpRule": {
|
||||
"oneofs": {
|
||||
"pattern": {
|
||||
"oneof": [
|
||||
"get",
|
||||
"put",
|
||||
"post",
|
||||
"delete",
|
||||
"patch",
|
||||
"custom"
|
||||
]
|
||||
}
|
||||
},
|
||||
"fields": {
|
||||
"get": {
|
||||
"type": "string",
|
||||
"id": 2
|
||||
},
|
||||
"put": {
|
||||
"type": "string",
|
||||
"id": 3
|
||||
},
|
||||
"post": {
|
||||
"type": "string",
|
||||
"id": 4
|
||||
},
|
||||
"delete": {
|
||||
"type": "string",
|
||||
"id": 5
|
||||
},
|
||||
"patch": {
|
||||
"type": "string",
|
||||
"id": 6
|
||||
},
|
||||
"custom": {
|
||||
"type": "CustomHttpPattern",
|
||||
"id": 8
|
||||
},
|
||||
"selector": {
|
||||
"type": "string",
|
||||
"id": 1
|
||||
},
|
||||
"body": {
|
||||
"type": "string",
|
||||
"id": 7
|
||||
},
|
||||
"additionalBindings": {
|
||||
"rule": "repeated",
|
||||
"type": "HttpRule",
|
||||
"id": 11
|
||||
}
|
||||
}
|
||||
},
|
||||
"CustomHttpPattern": {
|
||||
"fields": {
|
||||
"kind": {
|
||||
"type": "string",
|
||||
"id": 1
|
||||
},
|
||||
"path": {
|
||||
"type": "string",
|
||||
"id": 2
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Executable
+31
@@ -0,0 +1,31 @@
|
||||
syntax = "proto3";
|
||||
|
||||
package google.api;
|
||||
|
||||
message Http {
|
||||
|
||||
repeated HttpRule rules = 1;
|
||||
}
|
||||
|
||||
message HttpRule {
|
||||
|
||||
oneof pattern {
|
||||
|
||||
string get = 2;
|
||||
string put = 3;
|
||||
string post = 4;
|
||||
string delete = 5;
|
||||
string patch = 6;
|
||||
CustomHttpPattern custom = 8;
|
||||
}
|
||||
|
||||
string selector = 1;
|
||||
string body = 7;
|
||||
repeated HttpRule additional_bindings = 11;
|
||||
}
|
||||
|
||||
message CustomHttpPattern {
|
||||
|
||||
string kind = 1;
|
||||
string path = 2;
|
||||
}
|
||||
+118
@@ -0,0 +1,118 @@
|
||||
{
|
||||
"nested": {
|
||||
"google": {
|
||||
"nested": {
|
||||
"protobuf": {
|
||||
"nested": {
|
||||
"Api": {
|
||||
"fields": {
|
||||
"name": {
|
||||
"type": "string",
|
||||
"id": 1
|
||||
},
|
||||
"methods": {
|
||||
"rule": "repeated",
|
||||
"type": "Method",
|
||||
"id": 2
|
||||
},
|
||||
"options": {
|
||||
"rule": "repeated",
|
||||
"type": "Option",
|
||||
"id": 3
|
||||
},
|
||||
"version": {
|
||||
"type": "string",
|
||||
"id": 4
|
||||
},
|
||||
"sourceContext": {
|
||||
"type": "SourceContext",
|
||||
"id": 5
|
||||
},
|
||||
"mixins": {
|
||||
"rule": "repeated",
|
||||
"type": "Mixin",
|
||||
"id": 6
|
||||
},
|
||||
"syntax": {
|
||||
"type": "Syntax",
|
||||
"id": 7
|
||||
}
|
||||
}
|
||||
},
|
||||
"Method": {
|
||||
"fields": {
|
||||
"name": {
|
||||
"type": "string",
|
||||
"id": 1
|
||||
},
|
||||
"requestTypeUrl": {
|
||||
"type": "string",
|
||||
"id": 2
|
||||
},
|
||||
"requestStreaming": {
|
||||
"type": "bool",
|
||||
"id": 3
|
||||
},
|
||||
"responseTypeUrl": {
|
||||
"type": "string",
|
||||
"id": 4
|
||||
},
|
||||
"responseStreaming": {
|
||||
"type": "bool",
|
||||
"id": 5
|
||||
},
|
||||
"options": {
|
||||
"rule": "repeated",
|
||||
"type": "Option",
|
||||
"id": 6
|
||||
},
|
||||
"syntax": {
|
||||
"type": "Syntax",
|
||||
"id": 7
|
||||
}
|
||||
}
|
||||
},
|
||||
"Mixin": {
|
||||
"fields": {
|
||||
"name": {
|
||||
"type": "string",
|
||||
"id": 1
|
||||
},
|
||||
"root": {
|
||||
"type": "string",
|
||||
"id": 2
|
||||
}
|
||||
}
|
||||
},
|
||||
"SourceContext": {
|
||||
"fields": {
|
||||
"fileName": {
|
||||
"type": "string",
|
||||
"id": 1
|
||||
}
|
||||
}
|
||||
},
|
||||
"Option": {
|
||||
"fields": {
|
||||
"name": {
|
||||
"type": "string",
|
||||
"id": 1
|
||||
},
|
||||
"value": {
|
||||
"type": "Any",
|
||||
"id": 2
|
||||
}
|
||||
}
|
||||
},
|
||||
"Syntax": {
|
||||
"values": {
|
||||
"SYNTAX_PROTO2": 0,
|
||||
"SYNTAX_PROTO3": 1
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
+34
@@ -0,0 +1,34 @@
|
||||
syntax = "proto3";
|
||||
|
||||
package google.protobuf;
|
||||
|
||||
import "google/protobuf/source_context.proto";
|
||||
import "google/protobuf/type.proto";
|
||||
|
||||
message Api {
|
||||
|
||||
string name = 1;
|
||||
repeated Method methods = 2;
|
||||
repeated Option options = 3;
|
||||
string version = 4;
|
||||
SourceContext source_context = 5;
|
||||
repeated Mixin mixins = 6;
|
||||
Syntax syntax = 7;
|
||||
}
|
||||
|
||||
message Method {
|
||||
|
||||
string name = 1;
|
||||
string request_type_url = 2;
|
||||
bool request_streaming = 3;
|
||||
string response_type_url = 4;
|
||||
bool response_streaming = 5;
|
||||
repeated Option options = 6;
|
||||
Syntax syntax = 7;
|
||||
}
|
||||
|
||||
message Mixin {
|
||||
|
||||
string name = 1;
|
||||
string root = 2;
|
||||
}
|
||||
+739
@@ -0,0 +1,739 @@
|
||||
{
|
||||
"nested": {
|
||||
"google": {
|
||||
"nested": {
|
||||
"protobuf": {
|
||||
"nested": {
|
||||
"FileDescriptorSet": {
|
||||
"fields": {
|
||||
"file": {
|
||||
"rule": "repeated",
|
||||
"type": "FileDescriptorProto",
|
||||
"id": 1
|
||||
}
|
||||
}
|
||||
},
|
||||
"FileDescriptorProto": {
|
||||
"fields": {
|
||||
"name": {
|
||||
"type": "string",
|
||||
"id": 1
|
||||
},
|
||||
"package": {
|
||||
"type": "string",
|
||||
"id": 2
|
||||
},
|
||||
"dependency": {
|
||||
"rule": "repeated",
|
||||
"type": "string",
|
||||
"id": 3
|
||||
},
|
||||
"publicDependency": {
|
||||
"rule": "repeated",
|
||||
"type": "int32",
|
||||
"id": 10,
|
||||
"options": {
|
||||
"packed": false
|
||||
}
|
||||
},
|
||||
"weakDependency": {
|
||||
"rule": "repeated",
|
||||
"type": "int32",
|
||||
"id": 11,
|
||||
"options": {
|
||||
"packed": false
|
||||
}
|
||||
},
|
||||
"messageType": {
|
||||
"rule": "repeated",
|
||||
"type": "DescriptorProto",
|
||||
"id": 4
|
||||
},
|
||||
"enumType": {
|
||||
"rule": "repeated",
|
||||
"type": "EnumDescriptorProto",
|
||||
"id": 5
|
||||
},
|
||||
"service": {
|
||||
"rule": "repeated",
|
||||
"type": "ServiceDescriptorProto",
|
||||
"id": 6
|
||||
},
|
||||
"extension": {
|
||||
"rule": "repeated",
|
||||
"type": "FieldDescriptorProto",
|
||||
"id": 7
|
||||
},
|
||||
"options": {
|
||||
"type": "FileOptions",
|
||||
"id": 8
|
||||
},
|
||||
"sourceCodeInfo": {
|
||||
"type": "SourceCodeInfo",
|
||||
"id": 9
|
||||
},
|
||||
"syntax": {
|
||||
"type": "string",
|
||||
"id": 12
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescriptorProto": {
|
||||
"fields": {
|
||||
"name": {
|
||||
"type": "string",
|
||||
"id": 1
|
||||
},
|
||||
"field": {
|
||||
"rule": "repeated",
|
||||
"type": "FieldDescriptorProto",
|
||||
"id": 2
|
||||
},
|
||||
"extension": {
|
||||
"rule": "repeated",
|
||||
"type": "FieldDescriptorProto",
|
||||
"id": 6
|
||||
},
|
||||
"nestedType": {
|
||||
"rule": "repeated",
|
||||
"type": "DescriptorProto",
|
||||
"id": 3
|
||||
},
|
||||
"enumType": {
|
||||
"rule": "repeated",
|
||||
"type": "EnumDescriptorProto",
|
||||
"id": 4
|
||||
},
|
||||
"extensionRange": {
|
||||
"rule": "repeated",
|
||||
"type": "ExtensionRange",
|
||||
"id": 5
|
||||
},
|
||||
"oneofDecl": {
|
||||
"rule": "repeated",
|
||||
"type": "OneofDescriptorProto",
|
||||
"id": 8
|
||||
},
|
||||
"options": {
|
||||
"type": "MessageOptions",
|
||||
"id": 7
|
||||
},
|
||||
"reservedRange": {
|
||||
"rule": "repeated",
|
||||
"type": "ReservedRange",
|
||||
"id": 9
|
||||
},
|
||||
"reservedName": {
|
||||
"rule": "repeated",
|
||||
"type": "string",
|
||||
"id": 10
|
||||
}
|
||||
},
|
||||
"nested": {
|
||||
"ExtensionRange": {
|
||||
"fields": {
|
||||
"start": {
|
||||
"type": "int32",
|
||||
"id": 1
|
||||
},
|
||||
"end": {
|
||||
"type": "int32",
|
||||
"id": 2
|
||||
}
|
||||
}
|
||||
},
|
||||
"ReservedRange": {
|
||||
"fields": {
|
||||
"start": {
|
||||
"type": "int32",
|
||||
"id": 1
|
||||
},
|
||||
"end": {
|
||||
"type": "int32",
|
||||
"id": 2
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"FieldDescriptorProto": {
|
||||
"fields": {
|
||||
"name": {
|
||||
"type": "string",
|
||||
"id": 1
|
||||
},
|
||||
"number": {
|
||||
"type": "int32",
|
||||
"id": 3
|
||||
},
|
||||
"label": {
|
||||
"type": "Label",
|
||||
"id": 4
|
||||
},
|
||||
"type": {
|
||||
"type": "Type",
|
||||
"id": 5
|
||||
},
|
||||
"typeName": {
|
||||
"type": "string",
|
||||
"id": 6
|
||||
},
|
||||
"extendee": {
|
||||
"type": "string",
|
||||
"id": 2
|
||||
},
|
||||
"defaultValue": {
|
||||
"type": "string",
|
||||
"id": 7
|
||||
},
|
||||
"oneofIndex": {
|
||||
"type": "int32",
|
||||
"id": 9
|
||||
},
|
||||
"jsonName": {
|
||||
"type": "string",
|
||||
"id": 10
|
||||
},
|
||||
"options": {
|
||||
"type": "FieldOptions",
|
||||
"id": 8
|
||||
}
|
||||
},
|
||||
"nested": {
|
||||
"Type": {
|
||||
"values": {
|
||||
"TYPE_DOUBLE": 1,
|
||||
"TYPE_FLOAT": 2,
|
||||
"TYPE_INT64": 3,
|
||||
"TYPE_UINT64": 4,
|
||||
"TYPE_INT32": 5,
|
||||
"TYPE_FIXED64": 6,
|
||||
"TYPE_FIXED32": 7,
|
||||
"TYPE_BOOL": 8,
|
||||
"TYPE_STRING": 9,
|
||||
"TYPE_GROUP": 10,
|
||||
"TYPE_MESSAGE": 11,
|
||||
"TYPE_BYTES": 12,
|
||||
"TYPE_UINT32": 13,
|
||||
"TYPE_ENUM": 14,
|
||||
"TYPE_SFIXED32": 15,
|
||||
"TYPE_SFIXED64": 16,
|
||||
"TYPE_SINT32": 17,
|
||||
"TYPE_SINT64": 18
|
||||
}
|
||||
},
|
||||
"Label": {
|
||||
"values": {
|
||||
"LABEL_OPTIONAL": 1,
|
||||
"LABEL_REQUIRED": 2,
|
||||
"LABEL_REPEATED": 3
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"OneofDescriptorProto": {
|
||||
"fields": {
|
||||
"name": {
|
||||
"type": "string",
|
||||
"id": 1
|
||||
},
|
||||
"options": {
|
||||
"type": "OneofOptions",
|
||||
"id": 2
|
||||
}
|
||||
}
|
||||
},
|
||||
"EnumDescriptorProto": {
|
||||
"fields": {
|
||||
"name": {
|
||||
"type": "string",
|
||||
"id": 1
|
||||
},
|
||||
"value": {
|
||||
"rule": "repeated",
|
||||
"type": "EnumValueDescriptorProto",
|
||||
"id": 2
|
||||
},
|
||||
"options": {
|
||||
"type": "EnumOptions",
|
||||
"id": 3
|
||||
}
|
||||
}
|
||||
},
|
||||
"EnumValueDescriptorProto": {
|
||||
"fields": {
|
||||
"name": {
|
||||
"type": "string",
|
||||
"id": 1
|
||||
},
|
||||
"number": {
|
||||
"type": "int32",
|
||||
"id": 2
|
||||
},
|
||||
"options": {
|
||||
"type": "EnumValueOptions",
|
||||
"id": 3
|
||||
}
|
||||
}
|
||||
},
|
||||
"ServiceDescriptorProto": {
|
||||
"fields": {
|
||||
"name": {
|
||||
"type": "string",
|
||||
"id": 1
|
||||
},
|
||||
"method": {
|
||||
"rule": "repeated",
|
||||
"type": "MethodDescriptorProto",
|
||||
"id": 2
|
||||
},
|
||||
"options": {
|
||||
"type": "ServiceOptions",
|
||||
"id": 3
|
||||
}
|
||||
}
|
||||
},
|
||||
"MethodDescriptorProto": {
|
||||
"fields": {
|
||||
"name": {
|
||||
"type": "string",
|
||||
"id": 1
|
||||
},
|
||||
"inputType": {
|
||||
"type": "string",
|
||||
"id": 2
|
||||
},
|
||||
"outputType": {
|
||||
"type": "string",
|
||||
"id": 3
|
||||
},
|
||||
"options": {
|
||||
"type": "MethodOptions",
|
||||
"id": 4
|
||||
},
|
||||
"clientStreaming": {
|
||||
"type": "bool",
|
||||
"id": 5
|
||||
},
|
||||
"serverStreaming": {
|
||||
"type": "bool",
|
||||
"id": 6
|
||||
}
|
||||
}
|
||||
},
|
||||
"FileOptions": {
|
||||
"fields": {
|
||||
"javaPackage": {
|
||||
"type": "string",
|
||||
"id": 1
|
||||
},
|
||||
"javaOuterClassname": {
|
||||
"type": "string",
|
||||
"id": 8
|
||||
},
|
||||
"javaMultipleFiles": {
|
||||
"type": "bool",
|
||||
"id": 10
|
||||
},
|
||||
"javaGenerateEqualsAndHash": {
|
||||
"type": "bool",
|
||||
"id": 20,
|
||||
"options": {
|
||||
"deprecated": true
|
||||
}
|
||||
},
|
||||
"javaStringCheckUtf8": {
|
||||
"type": "bool",
|
||||
"id": 27
|
||||
},
|
||||
"optimizeFor": {
|
||||
"type": "OptimizeMode",
|
||||
"id": 9,
|
||||
"options": {
|
||||
"default": "SPEED"
|
||||
}
|
||||
},
|
||||
"goPackage": {
|
||||
"type": "string",
|
||||
"id": 11
|
||||
},
|
||||
"ccGenericServices": {
|
||||
"type": "bool",
|
||||
"id": 16
|
||||
},
|
||||
"javaGenericServices": {
|
||||
"type": "bool",
|
||||
"id": 17
|
||||
},
|
||||
"pyGenericServices": {
|
||||
"type": "bool",
|
||||
"id": 18
|
||||
},
|
||||
"deprecated": {
|
||||
"type": "bool",
|
||||
"id": 23
|
||||
},
|
||||
"ccEnableArenas": {
|
||||
"type": "bool",
|
||||
"id": 31
|
||||
},
|
||||
"objcClassPrefix": {
|
||||
"type": "string",
|
||||
"id": 36
|
||||
},
|
||||
"csharpNamespace": {
|
||||
"type": "string",
|
||||
"id": 37
|
||||
},
|
||||
"uninterpretedOption": {
|
||||
"rule": "repeated",
|
||||
"type": "UninterpretedOption",
|
||||
"id": 999
|
||||
}
|
||||
},
|
||||
"extensions": [
|
||||
[
|
||||
1000,
|
||||
536870911
|
||||
]
|
||||
],
|
||||
"reserved": [
|
||||
[
|
||||
38,
|
||||
38
|
||||
]
|
||||
],
|
||||
"nested": {
|
||||
"OptimizeMode": {
|
||||
"values": {
|
||||
"SPEED": 1,
|
||||
"CODE_SIZE": 2,
|
||||
"LITE_RUNTIME": 3
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"MessageOptions": {
|
||||
"fields": {
|
||||
"messageSetWireFormat": {
|
||||
"type": "bool",
|
||||
"id": 1
|
||||
},
|
||||
"noStandardDescriptorAccessor": {
|
||||
"type": "bool",
|
||||
"id": 2
|
||||
},
|
||||
"deprecated": {
|
||||
"type": "bool",
|
||||
"id": 3
|
||||
},
|
||||
"mapEntry": {
|
||||
"type": "bool",
|
||||
"id": 7
|
||||
},
|
||||
"uninterpretedOption": {
|
||||
"rule": "repeated",
|
||||
"type": "UninterpretedOption",
|
||||
"id": 999
|
||||
}
|
||||
},
|
||||
"extensions": [
|
||||
[
|
||||
1000,
|
||||
536870911
|
||||
]
|
||||
],
|
||||
"reserved": [
|
||||
[
|
||||
8,
|
||||
8
|
||||
]
|
||||
]
|
||||
},
|
||||
"FieldOptions": {
|
||||
"fields": {
|
||||
"ctype": {
|
||||
"type": "CType",
|
||||
"id": 1,
|
||||
"options": {
|
||||
"default": "STRING"
|
||||
}
|
||||
},
|
||||
"packed": {
|
||||
"type": "bool",
|
||||
"id": 2
|
||||
},
|
||||
"jstype": {
|
||||
"type": "JSType",
|
||||
"id": 6,
|
||||
"options": {
|
||||
"default": "JS_NORMAL"
|
||||
}
|
||||
},
|
||||
"lazy": {
|
||||
"type": "bool",
|
||||
"id": 5
|
||||
},
|
||||
"deprecated": {
|
||||
"type": "bool",
|
||||
"id": 3
|
||||
},
|
||||
"weak": {
|
||||
"type": "bool",
|
||||
"id": 10
|
||||
},
|
||||
"uninterpretedOption": {
|
||||
"rule": "repeated",
|
||||
"type": "UninterpretedOption",
|
||||
"id": 999
|
||||
}
|
||||
},
|
||||
"extensions": [
|
||||
[
|
||||
1000,
|
||||
536870911
|
||||
]
|
||||
],
|
||||
"reserved": [
|
||||
[
|
||||
4,
|
||||
4
|
||||
]
|
||||
],
|
||||
"nested": {
|
||||
"CType": {
|
||||
"values": {
|
||||
"STRING": 0,
|
||||
"CORD": 1,
|
||||
"STRING_PIECE": 2
|
||||
}
|
||||
},
|
||||
"JSType": {
|
||||
"values": {
|
||||
"JS_NORMAL": 0,
|
||||
"JS_STRING": 1,
|
||||
"JS_NUMBER": 2
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"OneofOptions": {
|
||||
"fields": {
|
||||
"uninterpretedOption": {
|
||||
"rule": "repeated",
|
||||
"type": "UninterpretedOption",
|
||||
"id": 999
|
||||
}
|
||||
},
|
||||
"extensions": [
|
||||
[
|
||||
1000,
|
||||
536870911
|
||||
]
|
||||
]
|
||||
},
|
||||
"EnumOptions": {
|
||||
"fields": {
|
||||
"allowAlias": {
|
||||
"type": "bool",
|
||||
"id": 2
|
||||
},
|
||||
"deprecated": {
|
||||
"type": "bool",
|
||||
"id": 3
|
||||
},
|
||||
"uninterpretedOption": {
|
||||
"rule": "repeated",
|
||||
"type": "UninterpretedOption",
|
||||
"id": 999
|
||||
}
|
||||
},
|
||||
"extensions": [
|
||||
[
|
||||
1000,
|
||||
536870911
|
||||
]
|
||||
]
|
||||
},
|
||||
"EnumValueOptions": {
|
||||
"fields": {
|
||||
"deprecated": {
|
||||
"type": "bool",
|
||||
"id": 1
|
||||
},
|
||||
"uninterpretedOption": {
|
||||
"rule": "repeated",
|
||||
"type": "UninterpretedOption",
|
||||
"id": 999
|
||||
}
|
||||
},
|
||||
"extensions": [
|
||||
[
|
||||
1000,
|
||||
536870911
|
||||
]
|
||||
]
|
||||
},
|
||||
"ServiceOptions": {
|
||||
"fields": {
|
||||
"deprecated": {
|
||||
"type": "bool",
|
||||
"id": 33
|
||||
},
|
||||
"uninterpretedOption": {
|
||||
"rule": "repeated",
|
||||
"type": "UninterpretedOption",
|
||||
"id": 999
|
||||
}
|
||||
},
|
||||
"extensions": [
|
||||
[
|
||||
1000,
|
||||
536870911
|
||||
]
|
||||
]
|
||||
},
|
||||
"MethodOptions": {
|
||||
"fields": {
|
||||
"deprecated": {
|
||||
"type": "bool",
|
||||
"id": 33
|
||||
},
|
||||
"uninterpretedOption": {
|
||||
"rule": "repeated",
|
||||
"type": "UninterpretedOption",
|
||||
"id": 999
|
||||
}
|
||||
},
|
||||
"extensions": [
|
||||
[
|
||||
1000,
|
||||
536870911
|
||||
]
|
||||
]
|
||||
},
|
||||
"UninterpretedOption": {
|
||||
"fields": {
|
||||
"name": {
|
||||
"rule": "repeated",
|
||||
"type": "NamePart",
|
||||
"id": 2
|
||||
},
|
||||
"identifierValue": {
|
||||
"type": "string",
|
||||
"id": 3
|
||||
},
|
||||
"positiveIntValue": {
|
||||
"type": "uint64",
|
||||
"id": 4
|
||||
},
|
||||
"negativeIntValue": {
|
||||
"type": "int64",
|
||||
"id": 5
|
||||
},
|
||||
"doubleValue": {
|
||||
"type": "double",
|
||||
"id": 6
|
||||
},
|
||||
"stringValue": {
|
||||
"type": "bytes",
|
||||
"id": 7
|
||||
},
|
||||
"aggregateValue": {
|
||||
"type": "string",
|
||||
"id": 8
|
||||
}
|
||||
},
|
||||
"nested": {
|
||||
"NamePart": {
|
||||
"fields": {
|
||||
"namePart": {
|
||||
"rule": "required",
|
||||
"type": "string",
|
||||
"id": 1
|
||||
},
|
||||
"isExtension": {
|
||||
"rule": "required",
|
||||
"type": "bool",
|
||||
"id": 2
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"SourceCodeInfo": {
|
||||
"fields": {
|
||||
"location": {
|
||||
"rule": "repeated",
|
||||
"type": "Location",
|
||||
"id": 1
|
||||
}
|
||||
},
|
||||
"nested": {
|
||||
"Location": {
|
||||
"fields": {
|
||||
"path": {
|
||||
"rule": "repeated",
|
||||
"type": "int32",
|
||||
"id": 1
|
||||
},
|
||||
"span": {
|
||||
"rule": "repeated",
|
||||
"type": "int32",
|
||||
"id": 2
|
||||
},
|
||||
"leadingComments": {
|
||||
"type": "string",
|
||||
"id": 3
|
||||
},
|
||||
"trailingComments": {
|
||||
"type": "string",
|
||||
"id": 4
|
||||
},
|
||||
"leadingDetachedComments": {
|
||||
"rule": "repeated",
|
||||
"type": "string",
|
||||
"id": 6
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"GeneratedCodeInfo": {
|
||||
"fields": {
|
||||
"annotation": {
|
||||
"rule": "repeated",
|
||||
"type": "Annotation",
|
||||
"id": 1
|
||||
}
|
||||
},
|
||||
"nested": {
|
||||
"Annotation": {
|
||||
"fields": {
|
||||
"path": {
|
||||
"rule": "repeated",
|
||||
"type": "int32",
|
||||
"id": 1
|
||||
},
|
||||
"sourceFile": {
|
||||
"type": "string",
|
||||
"id": 2
|
||||
},
|
||||
"begin": {
|
||||
"type": "int32",
|
||||
"id": 3
|
||||
},
|
||||
"end": {
|
||||
"type": "int32",
|
||||
"id": 4
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
+286
@@ -0,0 +1,286 @@
|
||||
syntax = "proto2";
|
||||
|
||||
package google.protobuf;
|
||||
|
||||
message FileDescriptorSet {
|
||||
|
||||
repeated FileDescriptorProto file = 1;
|
||||
}
|
||||
|
||||
message FileDescriptorProto {
|
||||
|
||||
optional string name = 1;
|
||||
optional string package = 2;
|
||||
repeated string dependency = 3;
|
||||
repeated int32 public_dependency = 10;
|
||||
repeated int32 weak_dependency = 11;
|
||||
repeated DescriptorProto message_type = 4;
|
||||
repeated EnumDescriptorProto enum_type = 5;
|
||||
repeated ServiceDescriptorProto service = 6;
|
||||
repeated FieldDescriptorProto extension = 7;
|
||||
optional FileOptions options = 8;
|
||||
optional SourceCodeInfo source_code_info = 9;
|
||||
optional string syntax = 12;
|
||||
}
|
||||
|
||||
message DescriptorProto {
|
||||
|
||||
optional string name = 1;
|
||||
repeated FieldDescriptorProto field = 2;
|
||||
repeated FieldDescriptorProto extension = 6;
|
||||
repeated DescriptorProto nested_type = 3;
|
||||
repeated EnumDescriptorProto enum_type = 4;
|
||||
repeated ExtensionRange extension_range = 5;
|
||||
repeated OneofDescriptorProto oneof_decl = 8;
|
||||
optional MessageOptions options = 7;
|
||||
repeated ReservedRange reserved_range = 9;
|
||||
repeated string reserved_name = 10;
|
||||
|
||||
message ExtensionRange {
|
||||
|
||||
optional int32 start = 1;
|
||||
optional int32 end = 2;
|
||||
}
|
||||
|
||||
message ReservedRange {
|
||||
|
||||
optional int32 start = 1;
|
||||
optional int32 end = 2;
|
||||
}
|
||||
}
|
||||
|
||||
message FieldDescriptorProto {
|
||||
|
||||
optional string name = 1;
|
||||
optional int32 number = 3;
|
||||
optional Label label = 4;
|
||||
optional Type type = 5;
|
||||
optional string type_name = 6;
|
||||
optional string extendee = 2;
|
||||
optional string default_value = 7;
|
||||
optional int32 oneof_index = 9;
|
||||
optional string json_name = 10;
|
||||
optional FieldOptions options = 8;
|
||||
|
||||
enum Type {
|
||||
|
||||
TYPE_DOUBLE = 1;
|
||||
TYPE_FLOAT = 2;
|
||||
TYPE_INT64 = 3;
|
||||
TYPE_UINT64 = 4;
|
||||
TYPE_INT32 = 5;
|
||||
TYPE_FIXED64 = 6;
|
||||
TYPE_FIXED32 = 7;
|
||||
TYPE_BOOL = 8;
|
||||
TYPE_STRING = 9;
|
||||
TYPE_GROUP = 10;
|
||||
TYPE_MESSAGE = 11;
|
||||
TYPE_BYTES = 12;
|
||||
TYPE_UINT32 = 13;
|
||||
TYPE_ENUM = 14;
|
||||
TYPE_SFIXED32 = 15;
|
||||
TYPE_SFIXED64 = 16;
|
||||
TYPE_SINT32 = 17;
|
||||
TYPE_SINT64 = 18;
|
||||
}
|
||||
|
||||
enum Label {
|
||||
|
||||
LABEL_OPTIONAL = 1;
|
||||
LABEL_REQUIRED = 2;
|
||||
LABEL_REPEATED = 3;
|
||||
}
|
||||
}
|
||||
|
||||
message OneofDescriptorProto {
|
||||
|
||||
optional string name = 1;
|
||||
optional OneofOptions options = 2;
|
||||
}
|
||||
|
||||
message EnumDescriptorProto {
|
||||
|
||||
optional string name = 1;
|
||||
repeated EnumValueDescriptorProto value = 2;
|
||||
optional EnumOptions options = 3;
|
||||
}
|
||||
|
||||
message EnumValueDescriptorProto {
|
||||
|
||||
optional string name = 1;
|
||||
optional int32 number = 2;
|
||||
optional EnumValueOptions options = 3;
|
||||
}
|
||||
|
||||
message ServiceDescriptorProto {
|
||||
|
||||
optional string name = 1;
|
||||
repeated MethodDescriptorProto method = 2;
|
||||
optional ServiceOptions options = 3;
|
||||
}
|
||||
|
||||
message MethodDescriptorProto {
|
||||
|
||||
optional string name = 1;
|
||||
optional string input_type = 2;
|
||||
optional string output_type = 3;
|
||||
optional MethodOptions options = 4;
|
||||
optional bool client_streaming = 5;
|
||||
optional bool server_streaming = 6;
|
||||
}
|
||||
|
||||
message FileOptions {
|
||||
|
||||
optional string java_package = 1;
|
||||
optional string java_outer_classname = 8;
|
||||
optional bool java_multiple_files = 10;
|
||||
optional bool java_generate_equals_and_hash = 20 [deprecated=true];
|
||||
optional bool java_string_check_utf8 = 27;
|
||||
optional OptimizeMode optimize_for = 9 [default=SPEED];
|
||||
optional string go_package = 11;
|
||||
optional bool cc_generic_services = 16;
|
||||
optional bool java_generic_services = 17;
|
||||
optional bool py_generic_services = 18;
|
||||
optional bool deprecated = 23;
|
||||
optional bool cc_enable_arenas = 31;
|
||||
optional string objc_class_prefix = 36;
|
||||
optional string csharp_namespace = 37;
|
||||
repeated UninterpretedOption uninterpreted_option = 999;
|
||||
|
||||
enum OptimizeMode {
|
||||
|
||||
SPEED = 1;
|
||||
CODE_SIZE = 2;
|
||||
LITE_RUNTIME = 3;
|
||||
}
|
||||
|
||||
extensions 1000 to max;
|
||||
|
||||
reserved 38;
|
||||
}
|
||||
|
||||
message MessageOptions {
|
||||
|
||||
optional bool message_set_wire_format = 1;
|
||||
optional bool no_standard_descriptor_accessor = 2;
|
||||
optional bool deprecated = 3;
|
||||
optional bool map_entry = 7;
|
||||
repeated UninterpretedOption uninterpreted_option = 999;
|
||||
|
||||
extensions 1000 to max;
|
||||
|
||||
reserved 8;
|
||||
}
|
||||
|
||||
message FieldOptions {
|
||||
|
||||
optional CType ctype = 1 [default=STRING];
|
||||
optional bool packed = 2;
|
||||
optional JSType jstype = 6 [default=JS_NORMAL];
|
||||
optional bool lazy = 5;
|
||||
optional bool deprecated = 3;
|
||||
optional bool weak = 10;
|
||||
repeated UninterpretedOption uninterpreted_option = 999;
|
||||
|
||||
enum CType {
|
||||
|
||||
STRING = 0;
|
||||
CORD = 1;
|
||||
STRING_PIECE = 2;
|
||||
}
|
||||
|
||||
enum JSType {
|
||||
|
||||
JS_NORMAL = 0;
|
||||
JS_STRING = 1;
|
||||
JS_NUMBER = 2;
|
||||
}
|
||||
|
||||
extensions 1000 to max;
|
||||
|
||||
reserved 4;
|
||||
}
|
||||
|
||||
message OneofOptions {
|
||||
|
||||
repeated UninterpretedOption uninterpreted_option = 999;
|
||||
|
||||
extensions 1000 to max;
|
||||
}
|
||||
|
||||
message EnumOptions {
|
||||
|
||||
optional bool allow_alias = 2;
|
||||
optional bool deprecated = 3;
|
||||
repeated UninterpretedOption uninterpreted_option = 999;
|
||||
|
||||
extensions 1000 to max;
|
||||
}
|
||||
|
||||
message EnumValueOptions {
|
||||
|
||||
optional bool deprecated = 1;
|
||||
repeated UninterpretedOption uninterpreted_option = 999;
|
||||
|
||||
extensions 1000 to max;
|
||||
}
|
||||
|
||||
message ServiceOptions {
|
||||
|
||||
optional bool deprecated = 33;
|
||||
repeated UninterpretedOption uninterpreted_option = 999;
|
||||
|
||||
extensions 1000 to max;
|
||||
}
|
||||
|
||||
message MethodOptions {
|
||||
|
||||
optional bool deprecated = 33;
|
||||
repeated UninterpretedOption uninterpreted_option = 999;
|
||||
|
||||
extensions 1000 to max;
|
||||
}
|
||||
|
||||
message UninterpretedOption {
|
||||
|
||||
repeated NamePart name = 2;
|
||||
optional string identifier_value = 3;
|
||||
optional uint64 positive_int_value = 4;
|
||||
optional int64 negative_int_value = 5;
|
||||
optional double double_value = 6;
|
||||
optional bytes string_value = 7;
|
||||
optional string aggregate_value = 8;
|
||||
|
||||
message NamePart {
|
||||
|
||||
required string name_part = 1;
|
||||
required bool is_extension = 2;
|
||||
}
|
||||
}
|
||||
|
||||
message SourceCodeInfo {
|
||||
|
||||
repeated Location location = 1;
|
||||
|
||||
message Location {
|
||||
|
||||
repeated int32 path = 1 [packed=true];
|
||||
repeated int32 span = 2 [packed=true];
|
||||
optional string leading_comments = 3;
|
||||
optional string trailing_comments = 4;
|
||||
repeated string leading_detached_comments = 6;
|
||||
}
|
||||
}
|
||||
|
||||
message GeneratedCodeInfo {
|
||||
|
||||
repeated Annotation annotation = 1;
|
||||
|
||||
message Annotation {
|
||||
|
||||
repeated int32 path = 1 [packed=true];
|
||||
optional string source_file = 2;
|
||||
optional int32 begin = 3;
|
||||
optional int32 end = 4;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"nested": {
|
||||
"google": {
|
||||
"nested": {
|
||||
"protobuf": {
|
||||
"nested": {
|
||||
"SourceContext": {
|
||||
"fields": {
|
||||
"fileName": {
|
||||
"type": "string",
|
||||
"id": 1
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,7 @@
|
||||
syntax = "proto3";
|
||||
|
||||
package google.protobuf;
|
||||
|
||||
message SourceContext {
|
||||
string file_name = 1;
|
||||
}
|
||||
+202
@@ -0,0 +1,202 @@
|
||||
{
|
||||
"nested": {
|
||||
"google": {
|
||||
"nested": {
|
||||
"protobuf": {
|
||||
"nested": {
|
||||
"Type": {
|
||||
"fields": {
|
||||
"name": {
|
||||
"type": "string",
|
||||
"id": 1
|
||||
},
|
||||
"fields": {
|
||||
"rule": "repeated",
|
||||
"type": "Field",
|
||||
"id": 2
|
||||
},
|
||||
"oneofs": {
|
||||
"rule": "repeated",
|
||||
"type": "string",
|
||||
"id": 3
|
||||
},
|
||||
"options": {
|
||||
"rule": "repeated",
|
||||
"type": "Option",
|
||||
"id": 4
|
||||
},
|
||||
"sourceContext": {
|
||||
"type": "SourceContext",
|
||||
"id": 5
|
||||
},
|
||||
"syntax": {
|
||||
"type": "Syntax",
|
||||
"id": 6
|
||||
}
|
||||
}
|
||||
},
|
||||
"Field": {
|
||||
"fields": {
|
||||
"kind": {
|
||||
"type": "Kind",
|
||||
"id": 1
|
||||
},
|
||||
"cardinality": {
|
||||
"type": "Cardinality",
|
||||
"id": 2
|
||||
},
|
||||
"number": {
|
||||
"type": "int32",
|
||||
"id": 3
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"id": 4
|
||||
},
|
||||
"typeUrl": {
|
||||
"type": "string",
|
||||
"id": 6
|
||||
},
|
||||
"oneofIndex": {
|
||||
"type": "int32",
|
||||
"id": 7
|
||||
},
|
||||
"packed": {
|
||||
"type": "bool",
|
||||
"id": 8
|
||||
},
|
||||
"options": {
|
||||
"rule": "repeated",
|
||||
"type": "Option",
|
||||
"id": 9
|
||||
},
|
||||
"jsonName": {
|
||||
"type": "string",
|
||||
"id": 10
|
||||
},
|
||||
"defaultValue": {
|
||||
"type": "string",
|
||||
"id": 11
|
||||
}
|
||||
},
|
||||
"nested": {
|
||||
"Kind": {
|
||||
"values": {
|
||||
"TYPE_UNKNOWN": 0,
|
||||
"TYPE_DOUBLE": 1,
|
||||
"TYPE_FLOAT": 2,
|
||||
"TYPE_INT64": 3,
|
||||
"TYPE_UINT64": 4,
|
||||
"TYPE_INT32": 5,
|
||||
"TYPE_FIXED64": 6,
|
||||
"TYPE_FIXED32": 7,
|
||||
"TYPE_BOOL": 8,
|
||||
"TYPE_STRING": 9,
|
||||
"TYPE_GROUP": 10,
|
||||
"TYPE_MESSAGE": 11,
|
||||
"TYPE_BYTES": 12,
|
||||
"TYPE_UINT32": 13,
|
||||
"TYPE_ENUM": 14,
|
||||
"TYPE_SFIXED32": 15,
|
||||
"TYPE_SFIXED64": 16,
|
||||
"TYPE_SINT32": 17,
|
||||
"TYPE_SINT64": 18
|
||||
}
|
||||
},
|
||||
"Cardinality": {
|
||||
"values": {
|
||||
"CARDINALITY_UNKNOWN": 0,
|
||||
"CARDINALITY_OPTIONAL": 1,
|
||||
"CARDINALITY_REQUIRED": 2,
|
||||
"CARDINALITY_REPEATED": 3
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"Enum": {
|
||||
"fields": {
|
||||
"name": {
|
||||
"type": "string",
|
||||
"id": 1
|
||||
},
|
||||
"enumvalue": {
|
||||
"rule": "repeated",
|
||||
"type": "EnumValue",
|
||||
"id": 2
|
||||
},
|
||||
"options": {
|
||||
"rule": "repeated",
|
||||
"type": "Option",
|
||||
"id": 3
|
||||
},
|
||||
"sourceContext": {
|
||||
"type": "SourceContext",
|
||||
"id": 4
|
||||
},
|
||||
"syntax": {
|
||||
"type": "Syntax",
|
||||
"id": 5
|
||||
}
|
||||
}
|
||||
},
|
||||
"EnumValue": {
|
||||
"fields": {
|
||||
"name": {
|
||||
"type": "string",
|
||||
"id": 1
|
||||
},
|
||||
"number": {
|
||||
"type": "int32",
|
||||
"id": 2
|
||||
},
|
||||
"options": {
|
||||
"rule": "repeated",
|
||||
"type": "Option",
|
||||
"id": 3
|
||||
}
|
||||
}
|
||||
},
|
||||
"Option": {
|
||||
"fields": {
|
||||
"name": {
|
||||
"type": "string",
|
||||
"id": 1
|
||||
},
|
||||
"value": {
|
||||
"type": "Any",
|
||||
"id": 2
|
||||
}
|
||||
}
|
||||
},
|
||||
"Syntax": {
|
||||
"values": {
|
||||
"SYNTAX_PROTO2": 0,
|
||||
"SYNTAX_PROTO3": 1
|
||||
}
|
||||
},
|
||||
"Any": {
|
||||
"fields": {
|
||||
"type_url": {
|
||||
"type": "string",
|
||||
"id": 1
|
||||
},
|
||||
"value": {
|
||||
"type": "bytes",
|
||||
"id": 2
|
||||
}
|
||||
}
|
||||
},
|
||||
"SourceContext": {
|
||||
"fields": {
|
||||
"fileName": {
|
||||
"type": "string",
|
||||
"id": 1
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
+89
@@ -0,0 +1,89 @@
|
||||
syntax = "proto3";
|
||||
|
||||
package google.protobuf;
|
||||
|
||||
import "google/protobuf/any.proto";
|
||||
import "google/protobuf/source_context.proto";
|
||||
|
||||
message Type {
|
||||
|
||||
string name = 1;
|
||||
repeated Field fields = 2;
|
||||
repeated string oneofs = 3;
|
||||
repeated Option options = 4;
|
||||
SourceContext source_context = 5;
|
||||
Syntax syntax = 6;
|
||||
}
|
||||
|
||||
message Field {
|
||||
|
||||
Kind kind = 1;
|
||||
Cardinality cardinality = 2;
|
||||
int32 number = 3;
|
||||
string name = 4;
|
||||
string type_url = 6;
|
||||
int32 oneof_index = 7;
|
||||
bool packed = 8;
|
||||
repeated Option options = 9;
|
||||
string json_name = 10;
|
||||
string default_value = 11;
|
||||
|
||||
enum Kind {
|
||||
|
||||
TYPE_UNKNOWN = 0;
|
||||
TYPE_DOUBLE = 1;
|
||||
TYPE_FLOAT = 2;
|
||||
TYPE_INT64 = 3;
|
||||
TYPE_UINT64 = 4;
|
||||
TYPE_INT32 = 5;
|
||||
TYPE_FIXED64 = 6;
|
||||
TYPE_FIXED32 = 7;
|
||||
TYPE_BOOL = 8;
|
||||
TYPE_STRING = 9;
|
||||
TYPE_GROUP = 10;
|
||||
TYPE_MESSAGE = 11;
|
||||
TYPE_BYTES = 12;
|
||||
TYPE_UINT32 = 13;
|
||||
TYPE_ENUM = 14;
|
||||
TYPE_SFIXED32 = 15;
|
||||
TYPE_SFIXED64 = 16;
|
||||
TYPE_SINT32 = 17;
|
||||
TYPE_SINT64 = 18;
|
||||
}
|
||||
|
||||
enum Cardinality {
|
||||
|
||||
CARDINALITY_UNKNOWN = 0;
|
||||
CARDINALITY_OPTIONAL = 1;
|
||||
CARDINALITY_REQUIRED = 2;
|
||||
CARDINALITY_REPEATED = 3;
|
||||
}
|
||||
}
|
||||
|
||||
message Enum {
|
||||
|
||||
string name = 1;
|
||||
repeated EnumValue enumvalue = 2;
|
||||
repeated Option options = 3;
|
||||
SourceContext source_context = 4;
|
||||
Syntax syntax = 5;
|
||||
}
|
||||
|
||||
message EnumValue {
|
||||
|
||||
string name = 1;
|
||||
int32 number = 2;
|
||||
repeated Option options = 3;
|
||||
}
|
||||
|
||||
message Option {
|
||||
|
||||
string name = 1;
|
||||
Any value = 2;
|
||||
}
|
||||
|
||||
enum Syntax {
|
||||
|
||||
SYNTAX_PROTO2 = 0;
|
||||
SYNTAX_PROTO3 = 1;
|
||||
}
|
||||
+2694
File diff suppressed because it is too large
Load Diff
Executable
+4
@@ -0,0 +1,4 @@
|
||||
// full library entry point.
|
||||
|
||||
"use strict";
|
||||
module.exports = require("./src/index");
|
||||
Executable
+26
@@ -0,0 +1,26 @@
|
||||
Copyright (c) 2016, Daniel Wirtz All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are
|
||||
met:
|
||||
|
||||
* Redistributions of source code must retain the above copyright
|
||||
notice, this list of conditions and the following disclaimer.
|
||||
* Redistributions in binary form must reproduce the above copyright
|
||||
notice, this list of conditions and the following disclaimer in the
|
||||
documentation and/or other materials provided with the distribution.
|
||||
* Neither the name of its author, nor the names of its contributors
|
||||
may be used to endorse or promote products derived from this software
|
||||
without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
Executable
+13
@@ -0,0 +1,13 @@
|
||||
@protobufjs/aspromise
|
||||
=====================
|
||||
[](https://www.npmjs.com/package/@protobufjs/aspromise)
|
||||
|
||||
Returns a promise from a node-style callback function.
|
||||
|
||||
API
|
||||
---
|
||||
|
||||
* **asPromise(fn: `function`, ctx: `Object`, ...params: `*`): `Promise<*>`**<br />
|
||||
Returns a promise from a node-style callback function.
|
||||
|
||||
**License:** [BSD 3-Clause License](https://opensource.org/licenses/BSD-3-Clause)
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
export = asPromise;
|
||||
|
||||
type asPromiseCallback = (error: Error | null, ...params: any[]) => {};
|
||||
|
||||
/**
|
||||
* Returns a promise from a node-style callback function.
|
||||
* @memberof util
|
||||
* @param {asPromiseCallback} fn Function to call
|
||||
* @param {*} ctx Function context
|
||||
* @param {...*} params Function arguments
|
||||
* @returns {Promise<*>} Promisified function
|
||||
*/
|
||||
declare function asPromise(fn: asPromiseCallback, ctx: any, ...params: any[]): Promise<any>;
|
||||
Executable
+52
@@ -0,0 +1,52 @@
|
||||
"use strict";
|
||||
module.exports = asPromise;
|
||||
|
||||
/**
|
||||
* Callback as used by {@link util.asPromise}.
|
||||
* @typedef asPromiseCallback
|
||||
* @type {function}
|
||||
* @param {Error|null} error Error, if any
|
||||
* @param {...*} params Additional arguments
|
||||
* @returns {undefined}
|
||||
*/
|
||||
|
||||
/**
|
||||
* Returns a promise from a node-style callback function.
|
||||
* @memberof util
|
||||
* @param {asPromiseCallback} fn Function to call
|
||||
* @param {*} ctx Function context
|
||||
* @param {...*} params Function arguments
|
||||
* @returns {Promise<*>} Promisified function
|
||||
*/
|
||||
function asPromise(fn, ctx/*, varargs */) {
|
||||
var params = new Array(arguments.length - 1),
|
||||
offset = 0,
|
||||
index = 2,
|
||||
pending = true;
|
||||
while (index < arguments.length)
|
||||
params[offset++] = arguments[index++];
|
||||
return new Promise(function executor(resolve, reject) {
|
||||
params[offset] = function callback(err/*, varargs */) {
|
||||
if (pending) {
|
||||
pending = false;
|
||||
if (err)
|
||||
reject(err);
|
||||
else {
|
||||
var params = new Array(arguments.length - 1),
|
||||
offset = 0;
|
||||
while (offset < params.length)
|
||||
params[offset++] = arguments[offset];
|
||||
resolve.apply(null, params);
|
||||
}
|
||||
}
|
||||
};
|
||||
try {
|
||||
fn.apply(ctx || null, params);
|
||||
} catch (err) {
|
||||
if (pending) {
|
||||
pending = false;
|
||||
reject(err);
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
+21
@@ -0,0 +1,21 @@
|
||||
{
|
||||
"name": "@protobufjs/aspromise",
|
||||
"description": "Returns a promise from a node-style callback function.",
|
||||
"version": "1.1.2",
|
||||
"author": "Daniel Wirtz <[email protected]>",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/dcodeIO/protobuf.js.git"
|
||||
},
|
||||
"license": "BSD-3-Clause",
|
||||
"main": "index.js",
|
||||
"types": "index.d.ts",
|
||||
"devDependencies": {
|
||||
"istanbul": "^0.4.5",
|
||||
"tape": "^4.6.3"
|
||||
},
|
||||
"scripts": {
|
||||
"test": "tape tests/*.js",
|
||||
"coverage": "istanbul cover node_modules/tape/bin/tape tests/*.js"
|
||||
}
|
||||
}
|
||||
+130
@@ -0,0 +1,130 @@
|
||||
var tape = require("tape");
|
||||
|
||||
var asPromise = require("..");
|
||||
|
||||
tape.test("aspromise", function(test) {
|
||||
|
||||
test.test(this.name + " - resolve", function(test) {
|
||||
|
||||
function fn(arg1, arg2, callback) {
|
||||
test.equal(this, ctx, "function should be called with this = ctx");
|
||||
test.equal(arg1, 1, "function should be called with arg1 = 1");
|
||||
test.equal(arg2, 2, "function should be called with arg2 = 2");
|
||||
callback(null, arg2);
|
||||
}
|
||||
|
||||
var ctx = {};
|
||||
|
||||
var promise = asPromise(fn, ctx, 1, 2);
|
||||
promise.then(function(arg2) {
|
||||
test.equal(arg2, 2, "promise should be resolved with arg2 = 2");
|
||||
test.end();
|
||||
}).catch(function(err) {
|
||||
test.fail("promise should not be rejected (" + err + ")");
|
||||
});
|
||||
});
|
||||
|
||||
test.test(this.name + " - reject", function(test) {
|
||||
|
||||
function fn(arg1, arg2, callback) {
|
||||
test.equal(this, ctx, "function should be called with this = ctx");
|
||||
test.equal(arg1, 1, "function should be called with arg1 = 1");
|
||||
test.equal(arg2, 2, "function should be called with arg2 = 2");
|
||||
callback(arg1);
|
||||
}
|
||||
|
||||
var ctx = {};
|
||||
|
||||
var promise = asPromise(fn, ctx, 1, 2);
|
||||
promise.then(function() {
|
||||
test.fail("promise should not be resolved");
|
||||
}).catch(function(err) {
|
||||
test.equal(err, 1, "promise should be rejected with err = 1");
|
||||
test.end();
|
||||
});
|
||||
});
|
||||
|
||||
test.test(this.name + " - resolve twice", function(test) {
|
||||
|
||||
function fn(arg1, arg2, callback) {
|
||||
test.equal(this, ctx, "function should be called with this = ctx");
|
||||
test.equal(arg1, 1, "function should be called with arg1 = 1");
|
||||
test.equal(arg2, 2, "function should be called with arg2 = 2");
|
||||
callback(null, arg2);
|
||||
callback(null, arg1);
|
||||
}
|
||||
|
||||
var ctx = {};
|
||||
var count = 0;
|
||||
|
||||
var promise = asPromise(fn, ctx, 1, 2);
|
||||
promise.then(function(arg2) {
|
||||
test.equal(arg2, 2, "promise should be resolved with arg2 = 2");
|
||||
if (++count > 1)
|
||||
test.fail("promise should not be resolved twice");
|
||||
test.end();
|
||||
}).catch(function(err) {
|
||||
test.fail("promise should not be rejected (" + err + ")");
|
||||
});
|
||||
});
|
||||
|
||||
test.test(this.name + " - reject twice", function(test) {
|
||||
|
||||
function fn(arg1, arg2, callback) {
|
||||
test.equal(this, ctx, "function should be called with this = ctx");
|
||||
test.equal(arg1, 1, "function should be called with arg1 = 1");
|
||||
test.equal(arg2, 2, "function should be called with arg2 = 2");
|
||||
callback(arg1);
|
||||
callback(arg2);
|
||||
}
|
||||
|
||||
var ctx = {};
|
||||
var count = 0;
|
||||
|
||||
var promise = asPromise(fn, ctx, 1, 2);
|
||||
promise.then(function() {
|
||||
test.fail("promise should not be resolved");
|
||||
}).catch(function(err) {
|
||||
test.equal(err, 1, "promise should be rejected with err = 1");
|
||||
if (++count > 1)
|
||||
test.fail("promise should not be rejected twice");
|
||||
test.end();
|
||||
});
|
||||
});
|
||||
|
||||
test.test(this.name + " - reject error", function(test) {
|
||||
|
||||
function fn(callback) {
|
||||
test.ok(arguments.length === 1 && typeof callback === "function", "function should be called with just a callback");
|
||||
throw 3;
|
||||
}
|
||||
|
||||
var promise = asPromise(fn, null);
|
||||
promise.then(function() {
|
||||
test.fail("promise should not be resolved");
|
||||
}).catch(function(err) {
|
||||
test.equal(err, 3, "promise should be rejected with err = 3");
|
||||
test.end();
|
||||
});
|
||||
});
|
||||
|
||||
test.test(this.name + " - reject and error", function(test) {
|
||||
|
||||
function fn(callback) {
|
||||
callback(3);
|
||||
throw 4;
|
||||
}
|
||||
|
||||
var count = 0;
|
||||
|
||||
var promise = asPromise(fn, null);
|
||||
promise.then(function() {
|
||||
test.fail("promise should not be resolved");
|
||||
}).catch(function(err) {
|
||||
test.equal(err, 3, "promise should be rejected with err = 3");
|
||||
if (++count > 1)
|
||||
test.fail("promise should not be rejected twice");
|
||||
test.end();
|
||||
});
|
||||
});
|
||||
});
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user