Changelog History
Page 3
-
v6.8.1 Changes
November 27, 2017🛠 Fixed
👀 :hash: Prevent invalid JSDoc names when generating service methods, see #870 👀 :hash: Prevent parse errors when generating service method names, see #870 📜 :hash: Support parsing nested option-values with or without ':' (#951, fixes #946) 🛠 :hash: Add support for reserved keyword in enums (#950, fixes #949) ✅ :hash: Unified safe property escapes and added a test for #834 :hash: Fix codegen if type name starts with "Object" 🛠 :hash: Fixed dependency for json-module to use "light". 🛠 :hash: Basic support for URL prefixes in google.protobuf.Any types. 👕 :hash: fixed 'error is not defined linter warning when using static/static-module and es6 🛠 :hash: Fixed wrong type_url for any type (no leading '.' allowed). 🛠 :hash: Fixed fromObject() for google.protobuf.Any types. :hash: Handle case where 'extendee' is undefined in ext/descriptor
CLI
:hash: Sanitize CR-only line endings (coming from jsdoc?) :hash: Make sure enum typings become generated (#884 didn't solve this) 🚚 :hash: Remove exclude and include patterns from jsdoc config 0️⃣ :hash: Skip defaults when generating proto3 👀 :hash: Wait for both the 'end' and 'close' event to happen before finishing in pbts, see #863 :hash: Accept null for optional fields in generated static code :hash: Annotate TS classes with @implements :hash: Annotate virtual oneofs as string literal unions
🆕 New
:hash: Also check for reserved ids and names in enums 👍 :hash: Also support 'reserved' in enum descriptors
Other
📦 :hash: Include just relevant files in npm package, fixes #781 🏗 :hash: Fix travis build
-
v6.8.0 Changes
June 09, 2017💥 Breaking
🚚 :hash: Replaced Buffer and Long types with interfaces and removed stubs 🚚 :hash: Removed Message#toObject in favor of having just the static version (unnecessary static code otherwise) :hash: Everything uses interfaces now instead of typedefs (SomethingProperties is now ISomething) :hash: ReflectionObject#toJSON properly omits explicit undefined values :hash: Initial implementation of TypeScript decorators 🔨 :hash: Refactored protobuf.Class away :hash: TypeScript definitions now have (a lot of) generics 🚚 :hash: Removed deprecated features
🛠 Fixed
🛠 :hash: Added 'undefined' besides 'null' as a valid value of an optional field, fixes #826 👀 :hash: Fixed an issue with codegen typings, see #819 🛠 :hash: Ported utf8 chunking mechanism to base64 as well, fixes #800 🛠 :hash: Also be more verbose when defining properties for ES6, fixes #820 🛠 :hash: Generate more verbose JSDoc comments for ES6 support, fixes #820 🛠 :hash: Emit a maximum of one error var when generating verifiers, fixes #786 🛠 :hash: Fixed missing semicolon after 'extensions' and 'reserved' when generating proto files, fixes #810 🛠 :hash: Call npm with '--no-bin-links' when installing CLI deps, fixes #823 :hash: Fix Reader argument conversion in static module 🛠 :hash: Use JSDoc, they said, it documents code, they said. Fixes #770 👀 :hash: parser should not confuse previous trailing line comments with comments for the next declaration, see #762 🛠 :hash: Types should not clear constructor with cache (fixes decorators) :hash: Namespace#lookup should also check in nested namespaces (wtf) 👍 :hash: Reader#bytes should also support plain arrays :hash: Fix markdown for pipe in code in table
🆕 New
⬆️ :hash: Upgrade to codegen 2 👀 :hash: ext/descriptor enables interoperability between reflection and descriptor.proto (experimental), see #757 📚 :hash: Added 'json' conversion option for proto3 JSON mapping compatibility of NaN and Infinity + additional documentation of util.toJSONOptions, see #351
CLI
:hash: Use protobuf/minimal when pbjs target is static-module :hash: Added closure wrapper 🛠 :hash: Various improvements to statically generated JSDoc, also fixes #772 :hash: Check incompatible properties for namespaces only in tsd-jsdoc :hash: Additional tsd-jsdoc handling of properties inside of namespaces and TS specific API exposure :hash: Several improvements to tsd-jsdoc emitted comments :hash: Further TypeScript definition improvements :hash: Relieved tsd files from unnecessary comments :hash: Generate TS namespaces for vars and functions with properties :hash: Prefer @tstype over @type when generating typedefs (tsd-jsdoc)
📄 Docs
🛠 :hash: Replaced nullable types with explicit type|null for better tooling compatibility, also fixes #766 and fixes 767 👀 :hash: Added more info to ext/descriptor README, see #757 :hash: Additional notes on ext/descriptor ⚡️ :hash: Updated CHANGELOG so everyone knows what's going on (and soon, breaking) 📄 :hash: Additional docs on TS/decorators usage
Other
⚡️ :hash: Updated dist files 🔒 :hash: Added package-lock.json :hash: Minor formatting :hash: Generate files 🚚 :hash: Remove the no-constructor arg 🚚 :hash: Remove the ctor option. 👍 :hash: Add support to generate types for JSON object. 🐎 :hash: aspromise performance pass 🐎 :hash: codegen 2 performance pass, #653 might benefit 🛠 :hash: Fixed minimal library including reflection functionality :hash: Minor compression ratio tuning ✅ :hash: Fixed failing test case + coverage :hash: Improved fromObject wrapper for google.protobuf.Any. ✅ :hash: Fixed failing tokenize test case 🏗 :hash: Removed debug build, made it an extension :hash: Regenerated dist files 📚 :hash: Even more documentation and typings for ext/descriptor 📄 :hash: ext/descriptor docs :hash: Decorators coverage 👀 :hash: ext/descriptor support for various standard options, see #757 👀 :hash: ext/descriptor passes descriptor.proto test with no differences, see #757 🚚 :hash: Properly remove unnecessary (packed) options from JSON descriptors 👀 :hash: Use typedefs in ext/descriptor (like everywhere else), see #757 👀 :hash: Fixed obvious issues with ext/descriptor, does not throw anymore when throwing descriptor.proto itself at it, see #757 👀 :hash: Added still missing root traversal to ext/descriptor, see #757 👀 :hash: Initial map fields support for ext/descriptor, see #757 👍 :hash: Added infrastructure for TypeScript support of extensions :hash: TypeScript generics improvements 👀 :hash: More ext/descriptor progress, see #757 :hash: Just export the relevant namespace in ext/descriptor 👀 :hash: Initial descriptor.proto extension for reflection interoperability, see #757 👀 :hash: Moved custom wrappers to its own module instead, also makes the API easier to use manually, see #677 👀 :hash: Added infrastructure for custom wrapping/unwrapping of special types, see #677 :hash: More decorator progress (MapField.d, optional Type.d) 👍 :hash: tsd-jsdoc now has limited generics support
-
v6.7.2 Changes
🆕 New
👀 :hash: Split up NamespaceDescriptor to make nested plain namespaces a thing, see #749
📄 Docs
:hash: More README :hash: Replaced 'runtime message' with 'message instance' for clarity :hash: Rephrased the Usage section around the concept of valid messages :hash: Added toolset diagram to README
Other
:hash: Touched benchmark output metrics once more ✅ :hash: Fixed failing browser test 🙋♂ :hash: Output more human friendly metrics from benchmark :hash: Stripped down static bench code to what's necessary :hash: Revamped benchmark, now also covers Google's JS implementation ⚡️ :hash: Updated dependencies and dist files
-
v6.7.1 Changes
🆕 New
👀 :hash: Made .verify behave more like .encode, see #710
CLI
👀 :hash: With null/undefined eliminated by constructors and .create, document message fields as non-optional where applicable (ideally used with TS & strictNullChecks), see #743 👀 :hash: Renamed --strict-long/message to --force-long/message with backward compatible aliases, see #741 👀 :hash: Keep $Properties with --strict-message but require actual instances within, see #741 👀 :hash: Added --strict-message option to pbjs to strictly reference message instances instead of $Properties, see #741
📄 Docs
:hash: Restructured README 👀 :hash: Added more information on typings usage, see #744 👀 :hash: Clarified typescript example in README, see #744 👀 :hash: Clarified that the service API targets clients consuming a service, see #742
Other
👀 :hash: Omit copying of undefined or null in constructors and .create, see #743
-
v6.7.0 Changes
💥 Breaking
:hash: Namespace#lookupEnum should actually look up the reflected enum and not just its values 👀 :hash: Decoder now throws if required fields are missing, see #695 / #696
🛠 Fixed
🛠 :hash: Added functionality to filter for multiple types at once in lookup(), used by lookupTypeOrEnum(), fixes #740 👀 :hash: Ensure that fields have been resolved when looking up js types in static target, see #731 🛠 :hash: Properly copy fields array before sorting in toObject, fixes #729 👀 :hash: Actually emit TS compatible enums in static target if not aliases, see #720 👀 :hash: Hardened tokenize/parse, esp. comment parsing, see #713 👀 :hash: Exclude any fields part of some oneof when populating defaults in toObject, see #710 👀 :hash: Most of the parser is not case insensitive, see #705 👀 :hash: Retain options argument in Root#load when used with promises, see #684
🆕 New
👍 :hash: Created a micromodule from (currently still bundled) float support 👀 :hash: util.isset(obj, prop) can be used to test if a message property is considered to be set, see #728 👀 :hash: Implemented stubs for long.js / node buffers to be used where either one isn't wanted, see #718 :hash: Simplified reusing / replacing internal constructors 👀 :hash: Constructors/.create always initialize proper mutable objects/arrays, see #700 👀 :hash: Verifiers return an error if multiple fields part of the same oneof are set, see #710 👀 :hash: Added
oneofs: trueto ConversionOptions, see #710 👀 :hash: Optional fields handle null just like undefined regardless of type see #709 👀 :hash: Encoders no longer examine virtual oneof properties but encode whatever is present, see #710 👀 :hash: pbjs now generates multiple exports when using ES6 syntax, see #686 :hash: Sequentially serialize fields ordered by id, as of the spec. :hash: decode throws specific ProtocolError with a reference to the so far decoded message if required fields are missing + example 👀 :hash: Reader.create asserts thatbufferis a valid buffer, see #695CLI
👀 :hash: Exclude JSDoc on typedefs from generated d.ts files because typescript@next, see #737 👀 :hash: Prepare static code with estraverse instead of regular expressions, see #732 👀 :hash: Moved tsd-jsdoc to future cli package, see #716 👀 :hash: $Properties are just a type that's satisfied, not implemented, by classes, see #723 :hash: More progress on decoupling the CLI 👀 :hash: Fixed computed array indexes not being renamed in static code, see #726 👀 :hash: Check upfront if key-var is required in static decoders with maps, see #726 👀 :hash: Fixed handling of stdout if callback is specified, see #724 👀 :hash: Preparations for moving the CLI to its own package, see #716 👀 :hash: Properly implement $Properties interface in JSDoc, see #723 👀 :hash: Recursively use $Properties inside of $Properties in static code, see #717 👀 :hash: Added --strict-long option to pbjs to always emit 'Long' instead of 'number|Long' (only relevant with long.js), see #718 👀 :hash: Statically emitted long type is 'Long' now instead of '$protobuf.Long', see #718 👀 :hash: Decoupled message properties as an interface in static code for TS intellisense support, see #717 👀 :hash: Static code statically resolves types[..], see #715
📄 Docs
:hash: Added type definitions for all possible JSON descriptors 📦 :hash: Explained the JSON structure in README and moved CLI specific information to the CLI package 👀 :hash: Added information on how to use the stubs to README, see #718 :hash: Added 'What is a valid message' section to README :hash: Added a hint on using .create to initial example :hash: Even more usage for README :hash: Additional information on general usage (README) :hash: Restructured README to Installation, Usage and Examples sections :hash: Added a longish section on the correct use of the toolset to README 👀 :hash: Added a few additional notes on core methods to README, see #710 👀 :hash: Extended traverse-types example, see #693 👍 :hash: Better explain how .verify, .encode and .decode are connected 👀 :hash: Documented that Type#encode respectively Message.encode do not implicitly .verify, see #696 [ci-skip] :hash: Documented throwing behavior of Reader.create and Message.decode 👀 :hash: Added error handling notes to README, see #696
Other
:hash: Use @protobufjs/float :hash: Rebuilt dist files for 6.7.0 ⚡️ :hash: Updated deps, ts fixes and regenerated dist files 🔀 :hash: Manually merged gentests improvements, fixes #733 👀 :hash: Make sure that util.Long is overridden by AMD loaders only if present, see #730 :hash: Coverage for util.isset and service as a namespace :hash: Shortened !== undefined && !== null to equivalent != null in static code 👀 :hash: With stubs in place, 'number|Long' return values can be just 'Long' instead, see #718 👀 :hash: Just alias as the actual ideal type when using stubs, see #718 ✅ :hash: General cleanup + regenerated dist/test files 👀 :hash: Simplified camel case regex, see #714 :hash: Regenerated dist files and changelog for 6.7.0 👀 :hash: Retain alias order in static code for what it's worth, see #712 💅 :hash: Everything can be block- or line-style when parsing, see #713 👀 :hash: Determine necessary aliases depending on config, see #712 :hash: Use more precise types for message-like plain objects :hash: Regenerated dist files :hash: Regenerated relevant files 🚚 :hash: Moved field comparer to util ⚡️ :hash: Updated tests to use new simplified encoder logic ⚡️ :hash: Updated path to tsd-jsdoc template used by pbts, see #707 🔧 :hash: Additional restructuring for moving configuration files out of the root folder 👀 :hash: Added codegen support for constructor functions, see #700 ✅ :hash: Attempted to fix broken custom error test :hash: Trying out a more aggressive aproach for custom error subclasses 🚚 :hash: Moved a few things out of the root folder :hash: Coverage for encoder compat. / protocolerror ⚡️ :hash: Updated dist and generated test files 👕 :hash: Added tslint :hash: Exclude dist/ from codeclimate checks 👕 :hash: Also lint cli utilities :hash: Cache any regexp instance (perf) :hash: Use code climate badges ⚡️ :hash: Updated travis to pipe to codeclimate, coverage 👕 :hash: More precise linter configuration :hash: Added codeclimate 🚚 :hash: Moved cli deps placeholder creation to post install script
-
v6.6.5 Changes
🛠 Fixed
👀 :hash: sfixed64 is not zig-zag encoded, see #692
CLI
:hash: Added a placeholder to cli deps node_modules folder to make sure node can load from it
Other
✅ :hash: Restructured a few failing tests 📚 :hash: Traversal example + minimalistic documentation :hash: Added a custom getters/setters example for gRPC
-
v6.6.4 Changes
🛠 Fixed
🛠 :hash: Made sure that LongBits ctor is always called with unsigned 32 bits + static codegen compat., fixes #690 👀 :hash: Properly handle multiple ../.. in path.normalize, see #688 🔀 :hash: Post-merge, also tackles #683 (packed option for repeated enum values)
🆕 New
👀 :hash: Verify accepts non-null objects only, see #685 ✅ :hash: allow_alias enum option was not being honored. This case is now handled and a test case was added
CLI
📜 :hash: Added an experimental --sparse option to limit pbjs output to actually referenced types within main files
📄 Docs
👀 :hash: Added explicit hint on Uint8Array to initial example, see #670
Other
👀 :hash: Ranges and names support for reserved fields, see #676 ⚡️ :hash: Updated depdendencies / rebuilt dist files :hash: Use ?: instead of |undefined in .d.ts files :hash: Mark optional fields as possibly being undefined 👀 :hash: Added a few more common google types from google/api, see #433 🏗 :hash: Minor optimizations to dependencies, build process and tsd
-
v6.6.3 Changes
🛠 Fixed
👀 :hash: Support node 4.2.0 to 4.4.7 buffers + travis case, see #665
CLI
👀 :hash: Added ES6 syntax flag to pbjs, see #667
📄 Docs
👀 :hash: Reference Buffer for BufferReader/Writer, see #668 :hash: Slightly shortened README 👀 :hash: Additional notes on the distinction of different use cases / distributions, see #666 :hash: Extended README with additional information on JSON format 👀 :hash: Added extended usage instructions for TypeScript and custom classes to README, see #666
Other
⚡️ :hash: Updated dist files ⚡️ :hash: Updated test cases to use new buffer util ✅ :hash: Added fetch test cases + some test cleanup
-
v6.6.2 Changes
🛠 Fixed
👀 :hash: Properly replace short vars when beautifying static code, see #663 👀 :hash: Use custom prelude in order to exclude any module loader code from source (for webpack), see #658 👀 :hash: Make sure to check optional inner messages for null when encoding, see #658
🆕 New
👀 :hash: Initial attempt on a backwards compatible fetch implementation with binary support, see #661
Other
👀 :hash: Root#resolvePath skips files when returning null, see #368 :hash: Changes callback on failed response decode in rpc service to pass actual error instead of 'error' string ✅ :hash: Travis should exit with the respective error when running sauce tests 🚚 :hash: Moved checks whether a test case is applicable to parent case ⚡️ :hash: Added eventemitter tests and updated micromodule dependencies (so far) ⚡️ :hash: Added lib/path tests and updated a few dependencies 🚚 :hash: Moved micro modules to lib so they can have their own tests etc. ⚡️ :hash: Updated travis