protobufjs 8.6.1 → 8.6.3

package/index.d.ts

@@ -100,6 +100,11 @@ export namespace common {
         value?: Uint8Array;
     }
 
+    /** Properties of a google.protobuf.FieldMask message. */
+    interface IFieldMask {
+        paths?: string[];
+    }
+
     /**
      * Gets the root definition of the specified common proto file.
      *
@@ -585,7 +590,7 @@ export class Message<T extends object = object> {
      */
     constructor(properties?: Properties<T>);
 
-    /** Unknown fields preserved while decoding */
+    /** Unknown fields preserved while decoding when enabled */
     $unknowns?: Uint8Array[];
 
     /** Reference to the reflected type. */
@@ -1340,6 +1345,12 @@ export class Reader {
      */
     string(): string;
 
+    /**
+     * Reads a string preceeded by its byte length as a varint, rejecting invalid UTF8.
+     * @returns Value read
+     */
+    stringVerify(): string;
+
     /**
      * Skips the specified number of bytes if specified, otherwise skips a varint.
      * @param [length] Length if known, otherwise a varint is assumed
@@ -1711,6 +1722,7 @@ export class Type extends NamespaceBase {
     /**
      * The registered constructor, if any registered, otherwise a generic constructor.
      * Assigning a function replaces the internal constructor. If the function does not extend {@link Message} yet, its prototype will be setup accordingly and static methods will be populated. If it already extends {@link Message}, it will just replace the internal constructor.
+     * When assigning manually, add the type to its parent namespace/root first if fields reference other reflected types, because constructor setup resolves field defaults.
      */
     ctor: Constructor<{}>;
 
@@ -2633,6 +2645,15 @@ export namespace util {
          */
         function read(buffer: Uint8Array, start: number, end: number): string;
 
+        /**
+         * Reads UTF8 bytes as a string, rejecting invalid UTF8.
+         * @param buffer Source buffer
+         * @param start Source start
+         * @param end Source end
+         * @returns String read
+         */
+        function readStrict(buffer: Uint8Array, start: number, end: number): string;
+
         /**
          * Writes a string as UTF8 bytes.
          * @param string Source string
@@ -2660,6 +2681,15 @@ export namespace util {
      */
     function toObject(array: any[]): { [k: string]: any };
 
+    /**
+     * Removes the first matching value from an object.
+     * @param object Object to remove from
+     * @param value Value to remove
+     * @param [key] Optional key for fast path removal
+     * @returns `true` if removed, otherwise `false`
+     */
+    function remove(object: ({ [k: string]: any }|undefined), value: any, key?: string): boolean;
+
     /**
      * Tests whether the specified name is a reserved word in JS.
      * @param name Name to test

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "protobufjs",
-  "version": "8.6.1",
+  "version": "8.6.3",
   "description": "Protocol Buffers for JavaScript & TypeScript.",
   "author": "Daniel Wirtz <dcode+protobufjs@dcode.io>",
   "license": "BSD-3-Clause",

package/src/common.js

@@ -363,9 +363,9 @@ common("field_mask", {
 
     /**
      * Properties of a google.protobuf.FieldMask message.
-     * @interface IDoubleValue
+     * @interface IFieldMask
      * @type {Object}
-     * @property {number} [value]
+     * @property {string[]} [paths]
      * @memberof common
      */
     FieldMask: {

package/src/decoder.js

@@ -9,6 +9,10 @@ function missing(field) {
     return "missing required '" + field.name + "'";
 }
 
+function stringMethod(field) {
+    return field._features.utf8_validation === "VERIFY" ? "stringVerify" : "string";
+}
+
 /**
  * Generates a decoder specific to the specified message type.
  * @param {Type} mtype Message type
@@ -78,7 +82,7 @@ function decoder(mtype) {
                         ("case 1:")
                             ("if(u!==%i)", types.mapKey[field.keyType])
                                 ("break")
-                            ("k=r.%s()", field.keyType)
+                            ("k=r.%s()", field.keyType === "string" ? stringMethod(field) : field.keyType)
                             ("continue")
                         ("case 2:")
                             ("if(u!==%i)", types.basic[type] === undefined ? 2 : types.basic[type])
@@ -87,7 +91,7 @@ function decoder(mtype) {
             if (types.basic[type] === undefined) gen
                             ("v=types[%i].decode(r,r.uint32(),undefined,q+1)", i); // can't be groups
             else gen
-                            ("v=r.%s()", type);
+                            ("v=r.%s()", type === "string" ? stringMethod(field) : type);
 
             gen
                             ("continue")
@@ -134,7 +138,7 @@ function decoder(mtype) {
                 else gen
                     ("%s.push(types[%i].decode(r,r.uint32(),undefined,q+1))", ref, i);
             } else gen
-                    ("%s.push(r.%s())", ref, type);
+                    ("%s.push(r.%s())", ref, type === "string" ? stringMethod(field) : type);
 
         // Non-repeated
         } else if (types.basic[type] === undefined) {
@@ -152,7 +156,7 @@ function decoder(mtype) {
             ("case %i:{", field.id)
                 ("if(u!==%i)", types.basic[type])
                     ("break")
-                ("%s=r.%s()", ref, type);
+                ("%s=r.%s()", ref, type === "string" ? stringMethod(field) : type);
         } else {
             gen
             ("case %i:{", field.id)
@@ -162,7 +166,9 @@ function decoder(mtype) {
                 // TODO: Protoc rejects open enums whose first value is not zero.
                 // We should do the same, but for v8 this would be a regression.
                 ("if((v=r.%s())!==%j)", type, field.typeDefault);
-            else if (type === "string" || type === "bytes") gen
+            else if (type === "string") gen
+                ("if((v=r.%s()).length)", stringMethod(field));
+            else if (type === "bytes") gen
                 ("if((v=r.%s()).length)", type);
             else if (types.long[type] !== undefined) gen
                 ("if(typeof(v=r.%s())===\"object\"?v.low||v.high:v!==0)", type);

package/src/index-light.js

@@ -1,7 +1,7 @@
 "use strict";
-var protobuf = module.exports = require("./index-minimal");
+exports = module.exports = require("./index-minimal");
 
-protobuf.build = "light";
+exports.build = "light";
 
 /**
  * A node-style callback as used by {@link load} and {@link Root#load}.
@@ -23,9 +23,9 @@ protobuf.build = "light";
 function load(filename, root, callback) {
     if (typeof root === "function") {
         callback = root;
-        root = new protobuf.Root();
+        root = new exports.Root();
     } else if (!root)
-        root = new protobuf.Root();
+        root = new exports.Root();
     return root.load(filename, callback);
 }
 
@@ -53,7 +53,7 @@ function load(filename, root, callback) {
  */
 // function load(filename:string, [root:Root]):Promise<Root>
 
-protobuf.load = load;
+exports.load = load;
 
 /**
  * Synchronously loads one or multiple .proto or preprocessed .json files into a common root namespace (node only).
@@ -65,40 +65,40 @@ protobuf.load = load;
  */
 function loadSync(filename, root) {
     if (!root)
-        root = new protobuf.Root();
+        root = new exports.Root();
     return root.loadSync(filename);
 }
 
-protobuf.loadSync = loadSync;
+exports.loadSync = loadSync;
 
 // Serialization
-protobuf.encoder          = require("./encoder");
-protobuf.decoder          = require("./decoder");
-protobuf.verifier         = require("./verifier");
-protobuf.converter        = require("./converter");
+exports.encoder          = require("./encoder");
+exports.decoder          = require("./decoder");
+exports.verifier         = require("./verifier");
+exports.converter        = require("./converter");
 
 // Reflection
-protobuf.ReflectionObject = require("./object");
-protobuf.Namespace        = require("./namespace");
-protobuf.Root             = require("./root");
-protobuf.Enum             = require("./enum");
-protobuf.Type             = require("./type");
-protobuf.Field            = require("./field");
-protobuf.OneOf            = require("./oneof");
-protobuf.MapField         = require("./mapfield");
-protobuf.Service          = require("./service");
-protobuf.Method           = require("./method");
+exports.ReflectionObject = require("./object");
+exports.Namespace        = require("./namespace");
+exports.Root             = require("./root");
+exports.Enum             = require("./enum");
+exports.Type             = require("./type");
+exports.Field            = require("./field");
+exports.OneOf            = require("./oneof");
+exports.MapField         = require("./mapfield");
+exports.Service          = require("./service");
+exports.Method           = require("./method");
 
 // Runtime
-protobuf.Message          = require("./message");
-protobuf.wrappers         = require("./wrappers");
+exports.Message          = require("./message");
+exports.wrappers         = require("./wrappers");
 
 // Utility
-protobuf.types            = require("./types");
-protobuf.util             = require("./util");
+exports.types            = require("./types");
+exports.util             = require("./util");
 
 // Set up possibly cyclic reflection dependencies
-protobuf.ReflectionObject._configure(protobuf.Root);
-protobuf.Namespace._configure(protobuf.Type, protobuf.Service, protobuf.Enum);
-protobuf.Root._configure(protobuf.Type, undefined, {});
-protobuf.Field._configure(protobuf.Type);
+exports.ReflectionObject._configure(exports.Root);
+exports.Namespace._configure(exports.Type, exports.Service, exports.Enum);
+exports.Root._configure(exports.Type, undefined, {});
+exports.Field._configure(exports.Type);

package/src/index-minimal.js

@@ -1,5 +1,4 @@
 "use strict";
-var protobuf = exports;
 
 /**
  * Build type, one of `"full"`, `"light"` or `"minimal"`.
@@ -7,19 +6,19 @@ var protobuf = exports;
  * @type {string}
  * @const
  */
-protobuf.build = "minimal";
+exports.build = "minimal";
 
 // Serialization
-protobuf.Writer       = require("./writer");
-protobuf.BufferWriter = require("./writer_buffer");
-protobuf.Reader       = require("./reader");
-protobuf.BufferReader = require("./reader_buffer");
+exports.Writer       = require("./writer");
+exports.BufferWriter = require("./writer_buffer");
+exports.Reader       = require("./reader");
+exports.BufferReader = require("./reader_buffer");
 
 // Utility
-protobuf.util         = require("./util/minimal");
-protobuf.rpc          = require("./rpc");
-protobuf.roots        = require("./roots");
-protobuf.configure    = configure;
+exports.util         = require("./util/minimal");
+exports.rpc          = require("./rpc");
+exports.roots        = require("./roots");
+exports.configure    = configure;
 
 /* istanbul ignore next */
 /**
@@ -27,9 +26,9 @@ protobuf.configure    = configure;
  * @returns {undefined}
  */
 function configure() {
-    protobuf.util._configure();
-    protobuf.Writer._configure(protobuf.BufferWriter);
-    protobuf.Reader._configure(protobuf.BufferReader);
+    exports.util._configure();
+    exports.Writer._configure(exports.BufferWriter);
+    exports.Reader._configure(exports.BufferReader);
 }
 
 // Set up buffer utility according to the environment

package/src/index.js

@@ -1,12 +1,12 @@
 "use strict";
-var protobuf = module.exports = require("./index-light");
+exports = module.exports = require("./index-light");
 
-protobuf.build = "full";
+exports.build = "full";
 
 // Parser
-protobuf.tokenize         = require("./tokenize");
-protobuf.parse            = require("./parse");
-protobuf.common           = require("./common");
+exports.tokenize         = require("./tokenize");
+exports.parse            = require("./parse");
+exports.common           = require("./common");
 
 // Configure parser
-protobuf.Root._configure(protobuf.Type, protobuf.parse, protobuf.common);
+exports.Root._configure(exports.Type, exports.parse, exports.common);

package/src/message.js

@@ -8,7 +8,7 @@ var util = require("./util/minimal");
  * @classdesc Abstract runtime message.
  * @constructor
  * @param {Properties<T>} [properties] Properties to set
- * @property {Array.<Uint8Array>} [$unknowns] Unknown fields preserved while decoding
+ * @property {Array.<Uint8Array>} [$unknowns] Unknown fields preserved while decoding when enabled
  * @template T extends object = object
  */
 function Message(properties) {

package/src/namespace.js

@@ -321,7 +321,8 @@ Namespace.prototype.remove = function remove(object) {
     if (object.parent !== this)
         throw Error(object + " is not a member of " + this);
 
-    delete this.nested[object.name];
+    if (!util.remove(this.nested, object, object.name))
+        throw Error(object + " is not a member of " + this);
     if (!Object.keys(this.nested).length)
         this.nested = undefined;
 

package/src/reader.js

@@ -224,18 +224,16 @@ function readLongVarint() {
             return bits;
         i = 0;
     } else {
-        for (; i < 3; ++i) {
+        for (; i < 4; ++i) {
             /* istanbul ignore if */
             if (this.pos >= this.len)
                 throw indexOutOfRange(this);
-            // 1st..3th
+            // 1st..4th
             bits.lo = (bits.lo | (this.buf[this.pos] & 127) << i * 7) >>> 0;
             if (this.buf[this.pos++] < 128)
                 return bits;
         }
-        // 4th
-        bits.lo = (bits.lo | (this.buf[this.pos++] & 127) << i * 7) >>> 0;
-        return bits;
+        throw indexOutOfRange(this);
     }
     if (this.len - this.pos > 4) { // fast route (hi)
         for (; i < 5; ++i) {
@@ -429,6 +427,23 @@ Reader.prototype.string = function read_string() {
     return utf8.read(this.buf, start, end);
 };
 
+/**
+ * Reads a string preceeded by its byte length as a varint, rejecting invalid UTF8.
+ * @returns {string} Value read
+ */
+Reader.prototype.stringVerify = function read_string_verify() {
+    var length = this.uint32(),
+        start  = this.pos,
+        end    = this.pos + length;
+
+    /* istanbul ignore if */
+    if (end > this.len)
+        throw indexOutOfRange(this, length);
+
+    this.pos = end;
+    return utf8.readStrict(this.buf, start, end);
+};
+
 /**
  * Skips the specified number of bytes if specified, otherwise skips a varint.
  * @param {number} [length] Length if known, otherwise a varint is assumed
@@ -460,7 +475,7 @@ Reader.recursionLimit = util.recursionLimit;
  * Whether readers discard unknown fields while decoding.
  * @type {boolean}
  */
-Reader.discardUnknown = false;
+Reader.discardUnknown = true;
 
 /**
  * Skips the next element of the specified wire type.

package/src/type.js

@@ -155,6 +155,7 @@ Object.defineProperties(Type.prototype, {
     /**
      * The registered constructor, if any registered, otherwise a generic constructor.
      * Assigning a function replaces the internal constructor. If the function does not extend {@link Message} yet, its prototype will be setup accordingly and static methods will be populated. If it already extends {@link Message}, it will just replace the internal constructor.
+     * When assigning manually, add the type to its parent namespace/root first if fields reference other reflected types, because constructor setup resolves field defaults.
      * @name Type#ctor
      * @type {Constructor<{}>}
      */
@@ -424,10 +425,9 @@ Type.prototype.remove = function remove(object) {
         // See Type#add for the reason why extension fields are excluded here.
 
         /* istanbul ignore if */
-        if (!this.fields || this.fields[object.name] !== object)
+        if (!util.remove(this.fields, object, object.name))
             throw Error(object + " is not a member of " + this);
 
-        delete this.fields[object.name];
         object.parent = null;
         object.onRemove(this);
         return clearCache(this);
@@ -435,10 +435,9 @@ Type.prototype.remove = function remove(object) {
     if (object instanceof OneOf) {
 
         /* istanbul ignore if */
-        if (!this.oneofs || this.oneofs[object.name] !== object)
+        if (!util.remove(this.oneofs, object, object.name))
             throw Error(object + " is not a member of " + this);
 
-        delete this.oneofs[object.name];
         object.parent = null;
         object.onRemove(this);
         return clearCache(this);

package/src/util/path.js

@@ -7,6 +7,28 @@
  */
 var path = exports;
 
+var urlRe = /^[a-zA-Z][a-zA-Z0-9+.-]+:\/\//;
+
+function normalizeUrl(path) {
+    if (typeof URL === "undefined" || !urlRe.test(path))
+        return null;
+    try {
+        return new URL(path).href;
+    } catch (e) {
+        return null;
+    }
+}
+
+function resolveUrl(originPath, includePath) {
+    if (typeof URL === "undefined" || !urlRe.test(originPath) || urlRe.test(includePath))
+        return null;
+    try {
+        return new URL(includePath, originPath).href;
+    } catch (e) {
+        return null;
+    }
+}
+
 var isAbsolute =
 /**
  * Tests if the specified path is absolute.
@@ -24,6 +46,9 @@ var normalize =
  * @returns {string} Normalized path
  */
 path.normalize = function normalize(path) {
+    var normalizedUrl = normalizeUrl(path);
+    if (normalizedUrl)
+        return normalizedUrl;
     var firstTwoCharacters = path.substring(0,2);
     var uncPrefix = "";
     if (firstTwoCharacters === "\\\\") {
@@ -62,8 +87,11 @@ path.normalize = function normalize(path) {
  * @returns {string} Path to the include file
  */
 path.resolve = function resolve(originPath, includePath, alreadyNormalized) {
+    var resolvedUrl = resolveUrl(originPath, includePath);
+    if (resolvedUrl)
+        return resolvedUrl;
     if (!alreadyNormalized)
-        includePath = normalize(includePath);
+        includePath = normalize(includePath); // path or absolute url
     if (isAbsolute(includePath))
         return includePath;
     if (!alreadyNormalized)

package/src/util/utf8.js

@@ -6,7 +6,8 @@
  * @namespace
  */
 var utf8 = exports,
-    replacementChar = "\ufffd";
+    replacementChar = "\ufffd",
+    strictDecoder = new TextDecoder("utf-8", { fatal: true, ignoreBOM: true });
 
 /**
  * Calculates the UTF8 byte length of a string.
@@ -95,6 +96,56 @@ utf8.read = function utf8_read_ascii(buffer, start, end) {
     return str;
 };
 
+function utf8_read_strict(buffer, start, end) {
+    var source = start === 0 && end === buffer.length
+        ? buffer
+        : buffer.subarray
+            ? buffer.subarray(start, end)
+            : buffer.slice(start, end);
+    if (Array.isArray(source))
+        source = Uint8Array.from(source);
+    return strictDecoder.decode(source);
+}
+
+/**
+ * Reads UTF8 bytes as a string, rejecting invalid UTF8.
+ * @param {Uint8Array} buffer Source buffer
+ * @param {number} start Source start
+ * @param {number} end Source end
+ * @returns {string} String read
+ */
+utf8.readStrict = function utf8_read_strict_ascii(buffer, start, end) {
+    if (end - start < 1)
+        return "";
+
+    var str = "",
+        i = start,
+        c1, c2, c3, c4, c5, c6, c7, c8;
+
+    for (; i + 7 < end; i += 8) {
+        c1 = buffer[i];
+        c2 = buffer[i + 1];
+        c3 = buffer[i + 2];
+        c4 = buffer[i + 3];
+        c5 = buffer[i + 4];
+        c6 = buffer[i + 5];
+        c7 = buffer[i + 6];
+        c8 = buffer[i + 7];
+        if ((c1 | c2 | c3 | c4 | c5 | c6 | c7 | c8) & 0x80)
+            return str + utf8_read_strict(buffer, i, end);
+        str += String.fromCharCode(c1, c2, c3, c4, c5, c6, c7, c8);
+    }
+
+    for (; i < end; ++i) {
+        c1 = buffer[i];
+        if (c1 & 0x80)
+            return str + utf8_read_strict(buffer, i, end);
+        str += String.fromCharCode(c1);
+    }
+
+    return str;
+};
+
 /**
  * Writes a string as UTF8 bytes.
  * @param {string} string Source string

package/src/util.js

@@ -58,6 +58,28 @@ util.toObject = function toObject(array) {
     return object;
 };
 
+/**
+ * Removes the first matching value from an object.
+ * @param {Object.<string,*>|undefined} object Object to remove from
+ * @param {*} value Value to remove
+ * @param {string} [key] Optional key for fast path removal
+ * @returns {boolean} `true` if removed, otherwise `false`
+ */
+util.remove = function remove(object, value, key) {
+    if (!object)
+        return false;
+    if (key !== undefined && Object.prototype.hasOwnProperty.call(object, key) && object[key] === value) {
+        delete object[key];
+        return true;
+    }
+    for (var names = Object.keys(object), i = 0; i < names.length; ++i)
+        if (object[names[i]] === value) {
+            delete object[names[i]];
+            return true;
+        }
+    return false;
+};
+
 /**
  * Tests whether the specified name is a reserved word in JS.
  * @param {string} name Name to test