protobufjs 8.2.1 → 8.3.0

package/README.md

@@ -70,7 +70,7 @@ protobuf.js converts `.proto` field names to camelCase by default, so `awesome_f
 
 ### Load a schema
 
-```js
+```ts
 const protobuf = require("protobufjs");
 
 const root = protobuf.loadSync("awesome.proto");
@@ -81,7 +81,7 @@ Use `protobuf.load()` for the asynchronous variant.
 
 ### Encode and decode
 
-```js
+```ts
 const payload = { awesomeField: "hello" };
 
 // Optionally verify if the payload is of uncertain shape
@@ -103,7 +103,7 @@ Install [`long`](https://github.com/dcodeIO/long.js) with protobuf.js when exact
 
 ### Convert plain objects
 
-```js
+```ts
 const message = AwesomeMessage.fromObject({ awesomeField: 42 });
 const object = AwesomeMessage.toObject(message, {
   longs: String,
@@ -197,7 +197,7 @@ Bundling schemas avoids reparsing `.proto` files at runtime and can reduce brows
 npx pbjs -t json -o awesome.json awesome1.proto awesome2.proto ...
 ```
 
-```js
+```ts
 const bundle = require("./awesome.json");
 
 const root = protobuf.Root.fromJSON(bundle);
@@ -208,7 +208,7 @@ const AwesomeMessage = root.lookupType("awesomepackage.AwesomeMessage");
 npx pbjs -t json-module -w esm -o awesome.js --dts awesome.proto
 ```
 
-```js
+```ts
 import { awesomepackage } from "./awesome.js";
 
 const AwesomeMessage = awesomepackage.AwesomeMessage;
@@ -218,7 +218,45 @@ JSON modules export the reflection root and, with `-w esm`, also provide top-lev
 
 ### TypeScript integration
 
-TypeScript is a first-class target in protobuf.js. The runtime API is typed, and with `--dts`, both `json-module` and `static-module` emit ready-to-run JavaScript modules together with matching TypeScript declarations. No separate transpile step is necessary.
+protobuf.js works with TypeScript out of the box: the runtime API is typed, and generated declarations expose idiomatic TypeScript types with type-checked oneofs and JavaScript-friendly plain-object input. No separate `protoc` invocation or TypeScript transpile step is necessary.
+
+For example, given the oneof:
+
+```proto
+message Profile {
+  oneof contact {
+    string email = 1;
+    string phone = 2;
+  }
+}
+```
+
+Generated declarations narrow both the `contact` oneof and the concrete values:
+
+```ts
+const profile = Profile.create({
+  contact: "email",
+  email: "hello@example.com"
+});
+
+if (profile.contact === "email") {
+  profile.email; // string
+}
+
+const decoded = Profile.decode(bytes);
+if (decoded.phone != null) {
+  decoded.phone; // string
+}
+```
+
+Plain objects can use the same narrowed shape through a collision-free scoped type:
+
+```ts
+const object: Profile.$Shape = {
+  contact: "email",
+  email: "hello@example.com"
+};
+```
 
 ## Advanced usage
 
@@ -226,7 +264,7 @@ TypeScript is a first-class target in protobuf.js. The runtime API is typed, and
 
 The full and light builds can construct schemas directly through reflection:
 
-```js
+```ts
 const AwesomeMessage = new protobuf.Type("AwesomeMessage")
   .add(new protobuf.Field("awesomeField", 1, "string"));
 
@@ -237,30 +275,29 @@ const root = new protobuf.Root()
 
 ### Custom message classes
 
-Message classes can be extended by reusing the generated constructor:
-
-```js
-const AwesomeMessage = root.lookupType("awesomepackage.AwesomeMessage").ctor;
+A reflected type can use a custom class as its runtime constructor:
 
-AwesomeMessage.customStaticMethod = function() {
-  // ...
-};
-AwesomeMessage.prototype.customInstanceMethod = function() {
-  // ...
-};
-```
+```ts
+class AwesomeMessage extends protobuf.Message<AwesomeMessage> {
+  awesomeField = "";
 
-Alternatively, a custom constructor can be registered:
+  constructor(properties?: protobuf.Properties<AwesomeMessage>) {
+    super(properties);
+    // ...
+  }
 
-```js
-function AwesomeMessage(properties) {
-  // ...
+  customInstanceMethod() {
+    return this.awesomeField.toLowerCase();
+  }
 }
 
 root.lookupType("awesomepackage.AwesomeMessage").ctor = AwesomeMessage;
+
+const decoded = AwesomeMessage.decode(bytes);
+decoded.customInstanceMethod(); // string
 ```
 
-Custom constructors are populated with static `create`, `encode`, `encodeDelimited`, `decode`, `decodeDelimited`, `verify`, `fromObject`, `toObject`, and the instance method `toJSON`. The reflected type is available as `AwesomeMessage.$type` and `message.$type`.
+protobuf.js will populate the constructor with the usual static runtime methods and use it for decoded messages. In TypeScript, custom members are visible when using the custom class type in consuming code.
 
 ### Services
 

package/dist/light/protobuf.js

@@ -1,6 +1,6 @@
 /*!
- * protobuf.js v8.2.1 (c) 2016, daniel wirtz
- * compiled wed, 13 may 2026 10:17:57 utc
+ * protobuf.js v8.3.0 (c) 2016, daniel wirtz
+ * compiled wed, 13 may 2026 21:15:34 utc
  * licensed under the bsd-3-clause license
  * see: https://github.com/dcodeio/protobuf.js for details
  */
@@ -714,7 +714,7 @@ var Namespace = require(12),
  * @param {Object.<string,number>} [values] Enum values as an object, by name
  * @param {Object.<string,*>} [options] Declared options
  * @param {string} [comment] The comment for this enum
- * @param {Object.<string,string>} [comments] The value comments for this enum
+ * @param {Object.<string,string|null>} [comments] The value comments for this enum
  * @param {Object.<string,Object<string,*>>|undefined} [valuesOptions] The value options for this enum
  */
 function Enum(name, values, options, comment, comments, valuesOptions) {
@@ -743,7 +743,7 @@ function Enum(name, values, options, comment, comments, valuesOptions) {
 
     /**
      * Value comment texts, if any.
-     * @type {Object.<string,string>}
+     * @type {Object.<string,string|null>}
      */
     this.comments = comments || {};
 
@@ -793,8 +793,13 @@ Enum.prototype._resolveFeatures = function _resolveFeatures(edition) {
 /**
  * Enum descriptor.
  * @interface IEnum
+ * @property {string} [edition] Edition
  * @property {Object.<string,number>} values Enum values
  * @property {Object.<string,*>} [options] Enum options
+ * @property {Object.<string,Object.<string,*>>} [valuesOptions] Enum value options
+ * @property {Array.<number[]|string>} [reserved] Reserved ranges
+ * @property {string|null} [comment] Enum comment
+ * @property {Object.<string,string|null>} [comments] Value comments
  */
 
 /**
@@ -805,7 +810,7 @@ Enum.prototype._resolveFeatures = function _resolveFeatures(edition) {
  * @throws {TypeError} If arguments are invalid
  */
 Enum.fromJSON = function fromJSON(name, json) {
-    var enm = new Enum(name, json.values, json.options, json.comment, json.comments);
+    var enm = new Enum(name, json.values, json.options, json.comment, json.comments, json.valuesOptions);
     enm.reserved = json.reserved;
     if (json.edition)
         enm._edition = json.edition;
@@ -1184,10 +1189,12 @@ Field.prototype.setOption = function setOption(name, value, ifNotSet) {
 /**
  * Field descriptor.
  * @interface IField
+ * @property {string} [edition] Edition
  * @property {string} [rule="optional"] Field rule
  * @property {string} type Field type
  * @property {number} id Field id
  * @property {Object.<string,*>} [options] Field options
+ * @property {string|null} [comment] Field comment
  */
 
 /**
@@ -1670,12 +1677,9 @@ var util = require(34);
 function Message(properties) {
     // not used internally
     if (properties)
-        for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) {
-            var key = keys[i];
-            if (key === "__proto__")
-                continue;
-            this[key] = properties[key];
-        }
+        for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i)
+            if (properties[keys[i]] != null && keys[i] !== "__proto__")
+                this[keys[i]] = properties[keys[i]];
 }
 
 /**
@@ -1909,7 +1913,7 @@ function Method(name, type, requestType, responseType, requestStream, responseSt
  * @property {boolean} [requestStream=false] Whether requests are streamed
  * @property {boolean} [responseStream=false] Whether responses are streamed
  * @property {Object.<string,*>} [options] Method options
- * @property {string} comment Method comments
+ * @property {string|null} [comment] Method comment
  * @property {Array.<Object.<string,*>>} [parsedOptions] Method options properly parsed into objects
  */
 
@@ -2670,7 +2674,6 @@ Object.defineProperties(ReflectionObject.prototype, {
 /**
  * Converts this reflection object to its descriptor representation.
  * @returns {Object.<string,*>} Descriptor
- * @abstract
  */
 ReflectionObject.prototype.toJSON = /* istanbul ignore next */ function toJSON() {
     throw Error(); // not implemented, shouldn't happen
@@ -2967,6 +2970,7 @@ function OneOf(name, fieldNames, options, comment) {
  * @interface IOneOf
  * @property {Array.<string>} oneof Oneof field names
  * @property {Object.<string,*>} [options] Oneof options
+ * @property {string|null} [comment] Oneof comment
  */
 
 /**
@@ -4401,7 +4405,9 @@ function Service(name, options) {
  * Service descriptor.
  * @interface IService
  * @extends INamespace
+ * @property {string} [edition] Edition
  * @property {Object.<string,IMethod>} methods Method descriptors
+ * @property {string|null} [comment] Service comment
  */
 
 /**
@@ -4786,11 +4792,13 @@ function clearCache(type) {
  * Message type descriptor.
  * @interface IType
  * @extends INamespace
+ * @property {string} [edition] Edition
  * @property {Object.<string,IOneOf>} [oneofs] Oneof descriptors
  * @property {Object.<string,IField>} fields Field descriptors
  * @property {number[][]} [extensions] Extension ranges
  * @property {Array.<number[]|string>} [reserved] Reserved ranges
  * @property {boolean} [group=false] Whether a legacy group or not
+ * @property {string|null} [comment] Message type comment
  */
 
 /**