protobufjs 8.2.1 → 8.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "protobufjs",
-  "version": "8.2.1",
+  "version": "8.4.0",
   "versionScheme": "~",
   "description": "Protocol Buffers for JavaScript & TypeScript.",
   "author": "Daniel Wirtz <dcode+protobufjs@dcode.io>",
@@ -26,7 +26,7 @@
     "bench": "node bench",
     "build": "npm run build:bundle && npm run build:types",
     "build:bundle": "gulp --gulpfile scripts/gulpfile.js",
-    "build:types": "node cli/bin/pbts --main --global protobuf --out index.d.ts src/",
+    "build:types": "node cli/bin/pbts --main --global protobuf --out index.d.ts src/ && node cli/bin/pbts --main --import \"\\$protobuf=..\" --out ext/descriptor.generated.d.ts ext/descriptor.js && node cli/bin/pbts --main --out ext/textformat.generated.d.ts ext/textformat.js",
     "coverage": "npm run coverage:test && npm run coverage:report",
     "coverage:test": "nyc --silent tape -r ./lib/tape-adapter tests/*.js tests/node/*.js",
     "coverage:report": "nyc report --reporter=lcov --reporter=text",
@@ -42,15 +42,15 @@
     "prof": "node bench/prof",
     "test": "npm run test:sources && npm run test:types",
     "test:sources": "tape -r ./lib/tape-adapter tests/*.js tests/node/*.js",
-    "test:types": "tsc tests/comp_typescript.ts --types node --lib es2015 --esModuleInterop --strictNullChecks --experimentalDecorators --emitDecoratorMetadata && tsc tests/comp_descriptor.ts --types node --lib es2015 --esModuleInterop --noEmit --strictNullChecks && tsc tests/comp_textformat.ts --types node --lib es2015 --esModuleInterop --noEmit --strictNullChecks && tsc tests/data/test.js.ts --types node --lib es2015 --esModuleInterop --noEmit --strictNullChecks && tsc tests/data/*.ts --types node --lib es2015 --esModuleInterop --noEmit --strictNullChecks",
+    "test:types": "tsc tests/comp_typescript.ts --target es2019 --module commonjs --types node --lib es2019 --esModuleInterop --strictNullChecks --experimentalDecorators --emitDecoratorMetadata && tsc -p tsconfig.test-types.json",
     "make": "npm run lint:sources && npm run build && npm run lint:types && node ./scripts/gentests.js && npm test"
   },
   "dependencies": {
-    "@types/node": ">=13.7.0",
-    "long": "^5.0.0"
+    "long": "^5.3.2"
   },
   "devDependencies": {
     "@eslint/js": "^10.0.0",
+    "@types/node": ">=13.7.0",
     "browserify": "^17.0.0",
     "browserify-wrap": "^1.0.2",
     "bundle-collapser": "^1.3.0",

package/src/converter.js

@@ -209,7 +209,9 @@ function genValuePartial_toObject(gen, field, fieldIndex, dstProp, srcProp) {
             case "sint64":
             case "fixed64":
             case "sfixed64": gen
-            ("if(typeof m%s===\"number\")", srcProp)
+            ("if(typeof BigInt!==\"undefined\"&&o.longs===BigInt)")
+                ("d%s=typeof m%s===\"number\"?BigInt(m%s):util.Long.fromBits(m%s.low>>>0,m%s.high>>>0,%j).toBigInt()", dstProp, srcProp, srcProp, srcProp, srcProp, isUnsigned)
+            ("else if(typeof m%s===\"number\")", srcProp)
                 ("d%s=o.longs===String?String(m%s):m%s", dstProp, srcProp, srcProp)
             ("else") // Long-like
                 ("d%s=o.longs===String?util.Long.prototype.toString.call(m%s):o.longs===Number?new util.LongBits(m%s.low>>>0,m%s.high>>>0).toNumber(%s):m%s", dstProp, srcProp, srcProp, srcProp, isUnsigned ? "true": "", srcProp);
@@ -277,9 +279,9 @@ converter.toObject = function toObject(mtype) {
             else if (field.long) gen
         ("if(util.Long){")
             ("var n=new util.Long(%i,%i,%j)", field.typeDefault.low, field.typeDefault.high, field.typeDefault.unsigned)
-            ("d%s=o.longs===String?n.toString():o.longs===Number?n.toNumber():n", prop)
+            ("d%s=o.longs===String?n.toString():o.longs===Number?n.toNumber():typeof BigInt!==\"undefined\"&&o.longs===BigInt?n.toBigInt():n", prop)
         ("}else")
-            ("d%s=o.longs===String?%j:%i", prop, field.typeDefault.toString(), field.typeDefault.toNumber());
+            ("d%s=o.longs===String?%j:typeof BigInt!==\"undefined\"&&o.longs===BigInt?BigInt(%j):%i", prop, field.typeDefault.toString(), field.typeDefault.toString(), field.typeDefault.toNumber());
             else if (field.bytes) {
                 var arrayDefault = Array.prototype.slice.call(field.typeDefault);
                 gen

package/src/enum.js

@@ -17,7 +17,7 @@ var Namespace = require("./namespace"),
  * @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) {
@@ -46,7 +46,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 || {};
 
@@ -96,8 +96,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
  */
 
 /**
@@ -108,7 +113,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;

package/src/field.js

@@ -259,10 +259,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
  */
 
 /**

package/src/message.js

@@ -14,12 +14,9 @@ var util = require("./util/minimal");
 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]];
 }
 
 /**

package/src/method.js

@@ -111,7 +111,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
  */
 

package/src/object.js

@@ -142,7 +142,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

package/src/oneof.js

@@ -54,6 +54,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
  */
 
 /**

package/src/service.js

@@ -41,7 +41,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
  */
 
 /**

package/src/type.js

@@ -226,11 +226,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
  */
 
 /**
@@ -583,7 +585,7 @@ Type.prototype.fromObject = function fromObject(object) { // eslint-disable-line
  * Conversion options as used by {@link Type#toObject} and {@link Message.toObject}.
  * @interface IConversionOptions
  * @property {Function} [longs] Long conversion type.
- * Valid values are `String` and `Number` (the global types).
+ * Valid values are `BigInt`, `String` and `Number` (the global types).
  * Defaults to copy the present value, which is a possibly unsafe number without and a {@link Long} with a long library.
  * @property {Function} [enums] Enum value conversion type.
  * Only valid value is `String` (the global type).

package/src/typescript.js

@@ -0,0 +1,19 @@
+"use strict";
+/* eslint-disable no-unused-vars */
+
+// Global TypeScript helper typedefs. The unused vars anchor these typedefs so
+// both TypeScript checkJs and pbts can discover them from this script file.
+
+/**
+ * Constructor type.
+ * @template T
+ * @typedef {Function & { new(...params: any[]): T; prototype: T }} Constructor
+ */
+var Constructor;
+
+/**
+ * Properties type.
+ * @template T
+ * @typedef {{ [P in keyof T]?: T[P] }} Properties
+ */
+var Properties;

package/src/util/pool.js

@@ -16,7 +16,7 @@ module.exports = pool;
  * @param {number} start Start offset
  * @param {number} end End offset
  * @returns {Uint8Array} Buffer slice
- * @this {Uint8Array}
+ * @this Uint8Array
  */
 
 /**

package/tsconfig.json

@@ -1,8 +1,6 @@
 {
     "compilerOptions": {
-        "target": "ES5",
-        "experimentalDecorators": true,
-        "emitDecoratorMetadata": true,
-        "esModuleInterop": true
+        "target": "es2019",
+        "module": "commonjs"
     }
 }

package/src/typescript.jsdoc

@@ -1,15 +0,0 @@
-/**
- * Constructor type.
- * @interface Constructor
- * @extends Function
- * @template T
- * @tstype new(...params: any[]): T; prototype: T;
- */
-
-/**
- * Properties type.
- * @typedef Properties
- * @template T
- * @type {Object.<string,*>}
- * @tstype { [P in keyof T]?: T[P] }
- */