protobufjs 8.6.5 → 8.7.0

package/index.d.ts

@@ -1212,7 +1212,7 @@ export interface IToJSONOptions {
  */
 export function parse(source: string, root: Root, options?: IParseOptions): IParserResult;
 
-/** Wire format reader using `Uint8Array` if available, otherwise `Array`. */
+/** Wire format reader using `Uint8Array`. */
 export class Reader {
 
     /**
@@ -1230,6 +1230,9 @@ export class Reader {
     /** Read buffer length. */
     len: number;
 
+    /** Cached DataView for packed reads. */
+    view: (DataView|null);
+
     /** Whether to discard unknown fields while decoding. */
     discardUnknown: boolean;
 
@@ -1333,6 +1336,97 @@ export class Reader {
      */
     double(): number;
 
+    /**
+     * Reads a packed repeated field of unsigned 32 bit varints.
+     * @param [array] Array to read into; a new one is created if omitted
+     * @returns Array read into
+     */
+    uint32s(array?: number[]): number[];
+
+    /**
+     * Reads a packed repeated field of signed 32 bit varints.
+     * @param [array] Array to read into; a new one is created if omitted
+     * @returns Array read into
+     */
+    int32s(array?: number[]): number[];
+
+    /**
+     * Reads a packed repeated field of zig-zag encoded signed 32 bit varints.
+     * @param [array] Array to read into; a new one is created if omitted
+     * @returns Array read into
+     */
+    sint32s(array?: number[]): number[];
+
+    /**
+     * Reads a packed repeated field of booleans.
+     * @param [array] Array to read into; a new one is created if omitted
+     * @returns Array read into
+     */
+    bools(array?: boolean[]): boolean[];
+
+    /**
+     * Reads a packed repeated field of unsigned 32 bit fixed values.
+     * @param [array] Array to read into; a new one is created if omitted
+     * @returns Array read into
+     */
+    fixed32s(array?: number[]): number[];
+
+    /**
+     * Reads a packed repeated field of signed 32 bit fixed values.
+     * @param [array] Array to read into; a new one is created if omitted
+     * @returns Array read into
+     */
+    sfixed32s(array?: number[]): number[];
+
+    /**
+     * Reads a packed repeated field of floats (32 bit).
+     * @param [array] Array to read into; a new one is created if omitted
+     * @returns Array read into
+     */
+    floats(array?: number[]): number[];
+
+    /**
+     * Reads a packed repeated field of doubles (64 bit float).
+     * @param [array] Array to read into; a new one is created if omitted
+     * @returns Array read into
+     */
+    doubles(array?: number[]): number[];
+
+    /**
+     * Reads a packed repeated field of unsigned 64 bit varints.
+     * @param [array] Array to read into; a new one is created if omitted
+     * @returns Array read into
+     */
+    uint64s(array?: (Long|number)[]): (Long|number)[];
+
+    /**
+     * Reads a packed repeated field of signed 64 bit varints.
+     * @param [array] Array to read into; a new one is created if omitted
+     * @returns Array read into
+     */
+    int64s(array?: (Long|number)[]): (Long|number)[];
+
+    /**
+     * Reads a packed repeated field of zig-zag encoded signed 64 bit varints.
+     * @param [array] Array to read into; a new one is created if omitted
+     * @returns Array read into
+     */
+    sint64s(array?: (Long|number)[]): (Long|number)[];
+
+    /**
+     * Reads a packed repeated field of unsigned 64 bit fixed values.
+     * @param [array] Array to read into; a new one is created if omitted
+     * @returns Array read into
+     */
+    fixed64s(array?: (Long|number)[]): (Long|number)[];
+
+    /**
+     * Reads a packed repeated field of signed 64 bit fixed values.
+     * @param [array] Array to read into; a new one is created if omitted
+     * @returns Array read into
+     */
+    sfixed64s(array?: (Long|number)[]): (Long|number)[];
+
     /**
      * Reads a sequence of bytes preceeded by its length as a varint.
      * @returns Value read
@@ -2464,7 +2558,10 @@ export namespace util {
      */
     function newBuffer(sizeOrArray?: (number|number[])): (Uint8Array|Buffer);
 
-    /** Array implementation used in the browser. `Uint8Array` if supported, otherwise `Array`. */
+    /**
+     * Array implementation used in the browser.
+     * @deprecated Use `Uint8Array` instead.
+     */
     let Array: Constructor<Uint8Array>;
 
     /** Long.js's Long class if available. */
@@ -2626,7 +2723,7 @@ export namespace util {
      */
     function pool(alloc: PoolAllocator, slice: PoolSlicer, size?: number): PoolAllocator;
 
-    /** A minimal UTF8 implementation for number arrays. */
+    /** A minimal UTF8 implementation. */
     namespace utf8 {
 
         /**
@@ -2803,23 +2900,29 @@ export interface IWrapper {
     toObject?: WrapperToObjectConverter;
 }
 
-/** Wire format writer using `Uint8Array` if available, otherwise `Array`. */
+/** Wire format writer using `Uint8Array`. */
 export class Writer {
 
     /** Constructs a new writer instance. */
     constructor();
 
-    /** Current length. */
-    len: number;
+    /** Write cursor into {@link Writer#buf}. */
+    pos: number;
 
-    /** Operations head. */
-    head: object;
+    /** Backing buffer. */
+    buf: Uint8Array;
 
-    /** Operations tail */
-    tail: object;
+    /** Cached DataView over {@link Writer#buf}. */
+    view: (DataView|null);
 
-    /** Linked forked states. */
-    states: (object|null);
+    /** Stack of forked length-prefix positions. */
+    states: (number[]|null);
+
+    /**
+     * Current write position.
+     * @deprecated Use {@link Writer#pos} instead.
+     */
+    len: number;
 
     /**
      * Creates a new writer.
@@ -2951,9 +3054,99 @@ export class Writer {
      */
     string(value: string): Writer;
 
+    /**
+     * Writes an array of unsigned 32 bit values as a packed repeated field.
+     * @param value Values to write
+     * @returns `this`
+     */
+    uint32s(value: number[]): Writer;
+
+    /**
+     * Writes an array of signed 32 bit values as a packed repeated field.
+     * @param value Values to write
+     * @returns `this`
+     */
+    int32s(value: number[]): Writer;
+
+    /**
+     * Writes an array of 32 bit values as packed, zig-zag encoded varints.
+     * @param value Values to write
+     * @returns `this`
+     */
+    sint32s(value: number[]): Writer;
+
+    /**
+     * Writes an array of unsigned 64 bit values as a packed repeated field.
+     * @param value Values to write
+     * @returns `this`
+     */
+    uint64s(value: (Long|number|string)[]): Writer;
+
+    /**
+     * Writes an array of signed 64 bit values as a packed repeated field.
+     * @param value Values to write
+     * @returns `this`
+     */
+    int64s(value: (Long|number|string)[]): Writer;
+
+    /**
+     * Writes an array of 64 bit values as packed, zig-zag encoded varints.
+     * @param value Values to write
+     * @returns `this`
+     */
+    sint64s(value: (Long|number|string)[]): Writer;
+
+    /**
+     * Writes an array of boolish values as a packed repeated field.
+     * @param value Values to write
+     * @returns `this`
+     */
+    bools(value: boolean[]): Writer;
+
+    /**
+     * Writes an array of unsigned 32 bit values as packed, fixed 32 bits.
+     * @param value Values to write
+     * @returns `this`
+     */
+    fixed32s(value: number[]): Writer;
+
+    /**
+     * Writes an array of signed 32 bit values as packed, fixed 32 bits.
+     * @param value Values to write
+     * @returns `this`
+     */
+    sfixed32s(value: number[]): Writer;
+
+    /**
+     * Writes an array of unsigned 64 bit values as packed, fixed 64 bits.
+     * @param value Values to write
+     * @returns `this`
+     */
+    fixed64s(value: (Long|number|string)[]): Writer;
+
+    /**
+     * Writes an array of signed 64 bit values as packed, fixed 64 bits.
+     * @param value Values to write
+     * @returns `this`
+     */
+    sfixed64s(value: (Long|number|string)[]): Writer;
+
+    /**
+     * Writes an array of floats (32 bit) as a packed repeated field.
+     * @param value Values to write
+     * @returns `this`
+     */
+    floats(value: number[]): Writer;
+
+    /**
+     * Writes an array of doubles (64 bit float) as a packed repeated field.
+     * @param value Values to write
+     * @returns `this`
+     */
+    doubles(value: number[]): Writer;
+
     /**
      * Forks this writer's state by pushing it to a stack.
-     * Calling {@link Writer#reset|reset} or {@link Writer#ldelim|ldelim} resets the writer to the previous state.
      * @returns `this`
      */
     fork(): Writer;
@@ -2965,21 +3158,23 @@ export class Writer {
     reset(): Writer;
 
     /**
-     * Resets to the last state and appends the fork state's current write length as a varint followed by its operations.
+     * Resets to the last state and prepends the fork state's current write length as a varint.
      * @returns `this`
      */
     ldelim(): Writer;
 
     /**
      * Finishes the write operation.
+     * Returns a buffer sized to the written data by default.
+     * @param [shared=false] Whether to return a shared view instead of a unique copy
      * @returns Finished buffer
      */
-    finish(): Uint8Array;
+    finish(shared?: boolean): Uint8Array;
 
     /**
      * Finishes the write operation, writing into the provided buffer.
      * The caller must ensure that `buf` has enough space starting at `offset`
-     * to hold {@link Writer#len} bytes.
+     * to hold {@link Writer#pos} bytes.
      * @param buf Target buffer
      * @param [offset=0] Offset to start writing at
      * @returns The provided buffer
@@ -3000,13 +3195,6 @@ export class BufferWriter extends Writer {
      */
     static alloc(size: number): Buffer;
 
-    /**
-     * Writes raw bytes without a tag or length prefix.
-     * @param value Raw bytes
-     * @returns `this`
-     */
-    raw(value: Uint8Array): BufferWriter;
-
     /**
      * Finishes the write operation.
      * @returns Finished buffer

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "protobufjs",
-  "version": "8.6.5",
+  "version": "8.7.0",
   "description": "Protocol Buffers for JavaScript & TypeScript.",
   "author": "Daniel Wirtz <dcode+protobufjs@dcode.io>",
   "license": "BSD-3-Clause",
@@ -22,7 +22,7 @@
     "fs": false
   },
   "scripts": {
-    "bench": "node bench",
+    "bench": "npm --prefix bench run bench",
     "build": "npm run build:bundle && npm run build:types",
     "build:bundle": "gulp --gulpfile scripts/gulpfile.js",
     "build:tests": "node ./scripts/gentests.js",

package/src/decoder.js

@@ -141,13 +141,9 @@ function decoder(mtype) {
             if (types.packed[type] !== undefined) {
                 gen
                 ("if(u===2){");
-                if (!closed) gen
-                    ("if(!(%s&&%s.length))", ref, ref)
-                        ("%s=[]", ref);
-                gen
-                    ("var c2=r.uint32()+r.pos");
                 if (closed) {
                     gen
+                    ("var c2=r.uint32()+r.pos")
                     ("while(r.pos<c2){")
                         ("s=r.pos")
                         ("v=r.%s()", type)
@@ -159,8 +155,9 @@ function decoder(mtype) {
                             genPreserveUnknown(gen, "util.rawField(" + field.id + ",0,r.raw(s,r.pos))")
                     ("}");
                 } else gen
-                    ("while(r.pos<c2)")
-                        ("%s.push(r.%s())", ref, type);
+                    ("if(!(%s&&%s.length))", ref, ref)
+                        ("%s=[]", ref)
+                    ("r.%ss(%s)", type, ref);
                 gen
                     ("continue")
                 ("}");

package/src/encoder.js

@@ -72,10 +72,7 @@ function encoder(mtype) {
             // Packed repeated
             if (field.packed && types.packed[type] !== undefined) { gen
 
-        ("w.uint32(%i).fork()", (field.id << 3 | 2) >>> 0)
-        ("for(var i=0;i<%s.length;++i)", ref)
-            ("w.%s(%s[i])", type, ref)
-        ("w.ldelim()");
+        ("w.uint32(%i).%ss(%s)", (field.id << 3 | 2) >>> 0, type, ref);
 
             // Non-packed
             } else { gen

package/src/index-minimal.js

@@ -26,7 +26,6 @@ exports.configure    = configure;
  * @returns {undefined}
  */
 function configure() {
-    exports.util._configure();
     exports.Writer._configure(exports.BufferWriter);
     exports.Reader._configure(exports.BufferReader);
 }

package/src/parse.js

@@ -220,6 +220,9 @@ function parse(source, root, options) {
     }
 
     function parseId(token, acceptNegative, max) {
+        if (token === null) {
+            throw illegal(token, "end of input");
+        }
         switch (token) {
             case "max": case "MAX": case "Max":
                 return max || maxFieldId;
@@ -252,7 +255,7 @@ function parse(source, root, options) {
         pkg = next();
 
         /* istanbul ignore if */
-        if (!typeRefRe.test(pkg))
+        if (pkg === null || !typeRefRe.test(pkg))
             throw illegal(pkg, "name");
 
         ptr = ptr.define(pkg);
@@ -389,7 +392,7 @@ function parse(source, root, options) {
             throw Error("max depth exceeded");
 
         /* istanbul ignore if */
-        if (!nameRe.test(token = next()))
+        if ((token = next()) === null || !nameRe.test(token))
             throw illegal(token, "type name");
 
         var type = new Type(token);
@@ -456,6 +459,9 @@ function parse(source, root, options) {
 
     function parseField(parent, rule, extend, depth) {
         var type = next();
+        if (type === null) {
+            throw illegal(type, "end of input");
+        }
         if (type === "group") {
             parseGroup(parent, rule, extend, depth);
             return;
@@ -467,8 +473,12 @@ function parse(source, root, options) {
         //    package  .subpackage field       tokens: "package" ".subpackage" [TYPE NAME ENDS HERE] "field"
         // Keep reading tokens until we get a type name with no period at the end,
         // and the next token does not start with a period.
-        while (type.endsWith(".") || peek().startsWith(".")) {
-            type += next();
+        while (type.endsWith(".") || (peek() || "").startsWith(".")) {
+            var part = next();
+            if (part === null) {
+                throw illegal(part, "end of input");
+            }
+            type += part;
         }
 
         /* istanbul ignore if */
@@ -476,6 +486,9 @@ function parse(source, root, options) {
             throw illegal(type, "type");
 
         var name = next();
+        if (name === null) {
+            throw illegal(name, "end of input");
+        }
 
         /* istanbul ignore if */
 
@@ -528,7 +541,7 @@ function parse(source, root, options) {
         var name = next();
 
         /* istanbul ignore if */
-        if (!nameRe.test(name))
+        if (name === null || !nameRe.test(name))
             throw illegal(name, "name");
 
         var fieldName = util.lcFirst(name);
@@ -626,7 +639,7 @@ function parse(source, root, options) {
         var name = next();
 
         /* istanbul ignore if */
-        if (!nameRe.test(name))
+        if (name === null || !nameRe.test(name))
             throw illegal(name, "name");
 
         skip("=");
@@ -653,7 +666,7 @@ function parse(source, root, options) {
     function parseOneOf(parent, token, depth) {
 
         /* istanbul ignore if */
-        if (!nameRe.test(token = next()))
+        if ((token = next()) === null || !nameRe.test(token))
             throw illegal(token, "name");
 
         var oneof = new OneOf(applyCase(token));
@@ -672,7 +685,7 @@ function parse(source, root, options) {
     function parseEnum(parent, token) {
 
         /* istanbul ignore if */
-        if (!nameRe.test(token = next()))
+        if ((token = next()) === null || !nameRe.test(token))
             throw illegal(token, "name");
 
         var enm = new Enum(token);
@@ -745,6 +758,9 @@ function parse(source, root, options) {
             }
 
             while (token !== "=") {
+                if (token === null) {
+                    throw illegal(token, "end of input");
+                }
                 if (token === "(") {
                     var parensValue = next();
                     skip(")");
@@ -851,15 +867,12 @@ function parse(source, root, options) {
         // lift json_name onto Field
         if (name === "json_name" && parent instanceof Field) {
             parent.jsonName = value;
-            return;
         }
         if (parent.setOption)
             parent.setOption(name, value);
     }
 
     function setParsedOption(parent, name, value, propName) {
-        if (name === "json_name" && parent instanceof Field)
-            return; // lifted onto Field#jsonName above
         if (parent.setParsedOption)
             parent.setParsedOption(name, value, propName);
     }
@@ -881,7 +894,7 @@ function parse(source, root, options) {
             throw Error("max depth exceeded");
 
         /* istanbul ignore if */
-        if (!nameRe.test(token = next()))
+        if ((token = next()) === null || !nameRe.test(token))
             throw illegal(token, "service name");
 
         var service = new Service(token);
@@ -959,7 +972,7 @@ function parse(source, root, options) {
     function parseExtension(parent, token, depth) {
 
         /* istanbul ignore if */
-        if (!typeRefRe.test(token = next()))
+        if ((token = next()) === null || !typeRefRe.test(token))
             throw illegal(token, "reference");
 
         var reference = token;