@bufbuild/protobuf 2.12.0 → 2.13.0

package/dist/esm/wire/binary-encoding.d.ts

@@ -194,9 +194,11 @@ export declare class BinaryReader {
      * Skip one element and return the skipped data.
      *
      * When skipping StartGroup, provide the tags field number to check for
-     * matching field number in the EndGroup tag.
+     * matching field number in the EndGroup tag. Recursion into nested groups
+     * is guarded by the `recursionLimit` argument: When the limit is reached,
+     * this method throws.
      */
-    skip(wireType: WireType, fieldNo?: number): Uint8Array;
+    skip(wireType: WireType, fieldNo?: number, recursionLimit?: number): Uint8Array;
     protected varint64: () => [number, number];
     /**
      * Throws error if position in byte array is out of range.

package/dist/esm/wire/binary-encoding.js

@@ -324,9 +324,11 @@ export class BinaryReader {
      * Skip one element and return the skipped data.
      *
      * When skipping StartGroup, provide the tags field number to check for
-     * matching field number in the EndGroup tag.
+     * matching field number in the EndGroup tag. Recursion into nested groups
+     * is guarded by the `recursionLimit` argument: When the limit is reached,
+     * this method throws.
      */
-    skip(wireType, fieldNo) {
+    skip(wireType, fieldNo, recursionLimit = 100) {
         let start = this.pos;
         switch (wireType) {
             case WireType.Varint:
@@ -345,6 +347,9 @@ export class BinaryReader {
                 this.pos += len;
                 break;
             case WireType.StartGroup:
+                if (recursionLimit <= 0) {
+                    throw new Error("maximum recursion depth reached");
+                }
                 for (;;) {
                     const [fn, wt] = this.tag();
                     if (wt === WireType.EndGroup) {
@@ -353,7 +358,7 @@ export class BinaryReader {
                         }
                         break;
                     }
-                    this.skip(wt, fn);
+                    this.skip(wt, fn, recursionLimit - 1);
                 }
                 break;
             default:

package/dist/esm/wire/size-delimited.d.ts

@@ -12,6 +12,20 @@ import type { BinaryReadOptions } from "../from-binary.js";
  * For details, see https://github.com/protocolbuffers/protobuf/issues/10229
  */
 export declare function sizeDelimitedEncode<Desc extends DescMessage>(messageDesc: Desc, message: MessageShape<Desc>, options?: BinaryWriteOptions): Uint8Array;
+/**
+ * Options for parsing size-delimited messages from a stream.
+ */
+export interface SizeDelimitedDecodeOptions extends BinaryReadOptions {
+    /**
+     * Limit the size of a single message in the stream, in bytes.
+     *
+     * If a message in the stream declares a size exceeding this limit, an
+     * error is raised before the message is buffered.
+     *
+     * The default limit is 64 MiB.
+     */
+    readMaxBytes: number;
+}
 /**
  * Parse a stream of size-delimited messages.
  *
@@ -20,8 +34,12 @@ export declare function sizeDelimitedEncode<Desc extends DescMessage>(messageDes
  *
  * This size-delimited format is compatible with other implementations.
  * For details, see https://github.com/protocolbuffers/protobuf/issues/10229
+ *
+ * Messages exceeding the limit given with the option readMaxBytes raise an
+ * error. The limit is 64 MiB by default. All other options are the
+ * standard binary read options, passed through to decode each message.
  */
-export declare function sizeDelimitedDecodeStream<Desc extends DescMessage>(messageDesc: Desc, iterable: AsyncIterable<Uint8Array>, options?: BinaryReadOptions): AsyncIterableIterator<MessageShape<Desc>>;
+export declare function sizeDelimitedDecodeStream<Desc extends DescMessage>(messageDesc: Desc, iterable: AsyncIterable<Uint8Array>, options?: Partial<SizeDelimitedDecodeOptions>): AsyncIterableIterator<MessageShape<Desc>>;
 /**
  * Decodes the size from the given size-delimited message, which may be
  * incomplete.

package/dist/esm/wire/size-delimited.js

@@ -48,6 +48,34 @@ export function sizeDelimitedEncode(messageDesc, message, options) {
     writer.bytes(toBinary(messageDesc, message, options));
     return writer.finish();
 }
+// Default for SizeDelimitedDecodeOptions.readMaxBytes.
+const defaultReadMaxBytes = 64 * 1024 * 1024; // 64 MiB
+/**
+ * A growable byte buffer. Used in place of a resizable ArrayBuffer, which is
+ * not widely available.
+ */
+class ByteBuffer {
+    constructor() {
+        this.buffer = new Uint8Array(0);
+        this.length = 0;
+    }
+    get byteLength() {
+        return this.length;
+    }
+    bytes() {
+        return this.buffer.subarray(0, this.length);
+    }
+    append(chunk) {
+        const newByteLength = this.length + chunk.byteLength;
+        if (newByteLength > this.buffer.byteLength) {
+            const grown = new Uint8Array(Math.max(this.buffer.byteLength * 2, newByteLength));
+            grown.set(this.buffer.subarray(0, this.length));
+            this.buffer = grown;
+        }
+        this.buffer.set(chunk, this.length);
+        this.length += chunk.byteLength;
+    }
+}
 /**
  * Parse a stream of size-delimited messages.
  *
@@ -56,43 +84,53 @@ export function sizeDelimitedEncode(messageDesc, message, options) {
  *
  * This size-delimited format is compatible with other implementations.
  * For details, see https://github.com/protocolbuffers/protobuf/issues/10229
+ *
+ * Messages exceeding the limit given with the option readMaxBytes raise an
+ * error. The limit is 64 MiB by default. All other options are the
+ * standard binary read options, passed through to decode each message.
  */
 export function sizeDelimitedDecodeStream(messageDesc, iterable, options) {
     return __asyncGenerator(this, arguments, function* sizeDelimitedDecodeStream_1() {
         var _a, e_1, _b, _c;
-        // append chunk to buffer, returning updated buffer
-        function append(buffer, chunk) {
-            const n = new Uint8Array(buffer.byteLength + chunk.byteLength);
-            n.set(buffer);
-            n.set(chunk, buffer.length);
-            return n;
-        }
-        let buffer = new Uint8Array(0);
+        var _d;
+        const readMaxBytes = (_d = options === null || options === void 0 ? void 0 : options.readMaxBytes) !== null && _d !== void 0 ? _d : defaultReadMaxBytes;
+        let buffer = new ByteBuffer();
         try {
-            for (var _d = true, iterable_1 = __asyncValues(iterable), iterable_1_1; iterable_1_1 = yield __await(iterable_1.next()), _a = iterable_1_1.done, !_a; _d = true) {
+            for (var _e = true, iterable_1 = __asyncValues(iterable), iterable_1_1; iterable_1_1 = yield __await(iterable_1.next()), _a = iterable_1_1.done, !_a; _e = true) {
                 _c = iterable_1_1.value;
-                _d = false;
+                _e = false;
                 const chunk = _c;
-                buffer = append(buffer, chunk);
+                buffer.append(chunk);
+                const bytes = buffer.bytes();
+                let offset = 0;
                 for (;;) {
-                    const size = sizeDelimitedPeek(buffer);
+                    const size = sizeDelimitedPeek(bytes.subarray(offset));
                     if (size.eof) {
                         // size is incomplete, buffer more data
                         break;
                     }
-                    if (size.offset + size.size > buffer.byteLength) {
+                    if (size.size > readMaxBytes) {
+                        throw new Error(`message size ${size.size} is larger than configured readMaxBytes ${readMaxBytes}`);
+                    }
+                    const messageStart = offset + size.offset;
+                    const messageEnd = messageStart + size.size;
+                    if (messageEnd > bytes.byteLength) {
                         // message is incomplete, buffer more data
                         break;
                     }
-                    yield yield __await(fromBinary(messageDesc, buffer.subarray(size.offset, size.offset + size.size), options));
-                    buffer = buffer.subarray(size.offset + size.size);
+                    yield yield __await(fromBinary(messageDesc, bytes.subarray(messageStart, messageEnd), options));
+                    offset = messageEnd;
+                }
+                if (offset > 0) {
+                    buffer = new ByteBuffer();
+                    buffer.append(bytes.subarray(offset));
                 }
             }
         }
         catch (e_1_1) { e_1 = { error: e_1_1 }; }
         finally {
             try {
-                if (!_d && !_a && (_b = iterable_1.return)) yield __await(_b.call(iterable_1));
+                if (!_e && !_a && (_b = iterable_1.return)) yield __await(_b.call(iterable_1));
             }
             finally { if (e_1) throw e_1.error; }
         }

package/package.json

@@ -1,19 +1,22 @@
 {
   "name": "@bufbuild/protobuf",
-  "version": "2.12.0",
+  "version": "2.13.0",
   "license": "(Apache-2.0 AND BSD-3-Clause)",
-  "description": "A complete implementation of Protocol Buffers in TypeScript, suitable for web browsers and Node.js.",
-  "keywords": ["protobuf", "schema", "typescript", "ecmascript"],
+  "description": "Protocol Buffers for ECMAScript. The only JavaScript Protobuf library that is fully-compliant with Protobuf conformance tests.",
+  "keywords": [
+    "protobuf",
+    "schema",
+    "typescript",
+    "ecmascript"
+  ],
+  "homepage": "https://protobufes.com/",
   "repository": {
     "type": "git",
     "url": "https://github.com/bufbuild/protobuf-es.git",
     "directory": "packages/protobuf"
   },
   "scripts": {
-    "prebuild": "rm -rf ./dist/*",
-    "build": "npm run build:cjs && npm run build:esm",
-    "build:cjs": "../../node_modules/typescript/bin/tsc --project tsconfig.json --module commonjs --verbatimModuleSyntax false --moduleResolution node10 --outDir ./dist/cjs && echo >./dist/cjs/package.json '{\"type\":\"commonjs\"}'",
-    "build:esm": "../../node_modules/typescript/bin/tsc --project tsconfig.json --outDir ./dist/esm",
+    "build": "tshy",
     "bootstrap": "npm run bootstrap:inject && npm run bootstrap:wkt",
     "bootstrap:inject": "node scripts/bootstrap-inject.mjs src",
     "bootstrap:wkt": "protoc --es_out=src/wkt/gen --es_opt=bootstrap_wkt=true,target=ts,import_extension=js,json_types=true --proto_path $(upstream-include wkt) $(upstream-files wkt)",
@@ -25,44 +28,120 @@
   },
   "type": "module",
   "sideEffects": false,
-  "main": "./dist/cjs/index.js",
+  "tshy": {
+    "selfLink": false,
+    "exports": {
+      ".": "./src/index.ts",
+      "./codegenv1": "./src/codegenv1/index.ts",
+      "./codegenv2": "./src/codegenv2/index.ts",
+      "./reflect": "./src/reflect/index.ts",
+      "./wkt": "./src/wkt/index.ts",
+      "./wire": "./src/wire/index.ts",
+      "./txtpb": "./src/txtpb/index.ts"
+    }
+  },
+  "devDependencies": {
+    "tshy": "^4.1.3",
+    "upstream-protobuf": "*"
+  },
+  "files": [
+    "dist/**"
+  ],
   "exports": {
     ".": {
-      "import": "./dist/esm/index.js",
-      "require": "./dist/cjs/index.js"
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/commonjs/index.d.ts",
+        "default": "./dist/commonjs/index.js"
+      }
     },
     "./codegenv1": {
-      "import": "./dist/esm/codegenv1/index.js",
-      "require": "./dist/cjs/codegenv1/index.js"
+      "import": {
+        "types": "./dist/esm/codegenv1/index.d.ts",
+        "default": "./dist/esm/codegenv1/index.js"
+      },
+      "require": {
+        "types": "./dist/commonjs/codegenv1/index.d.ts",
+        "default": "./dist/commonjs/codegenv1/index.js"
+      }
     },
     "./codegenv2": {
-      "import": "./dist/esm/codegenv2/index.js",
-      "require": "./dist/cjs/codegenv2/index.js"
+      "import": {
+        "types": "./dist/esm/codegenv2/index.d.ts",
+        "default": "./dist/esm/codegenv2/index.js"
+      },
+      "require": {
+        "types": "./dist/commonjs/codegenv2/index.d.ts",
+        "default": "./dist/commonjs/codegenv2/index.js"
+      }
     },
     "./reflect": {
-      "import": "./dist/esm/reflect/index.js",
-      "require": "./dist/cjs/reflect/index.js"
+      "import": {
+        "types": "./dist/esm/reflect/index.d.ts",
+        "default": "./dist/esm/reflect/index.js"
+      },
+      "require": {
+        "types": "./dist/commonjs/reflect/index.d.ts",
+        "default": "./dist/commonjs/reflect/index.js"
+      }
     },
     "./wkt": {
-      "import": "./dist/esm/wkt/index.js",
-      "require": "./dist/cjs/wkt/index.js"
+      "import": {
+        "types": "./dist/esm/wkt/index.d.ts",
+        "default": "./dist/esm/wkt/index.js"
+      },
+      "require": {
+        "types": "./dist/commonjs/wkt/index.d.ts",
+        "default": "./dist/commonjs/wkt/index.js"
+      }
     },
     "./wire": {
-      "import": "./dist/esm/wire/index.js",
-      "require": "./dist/cjs/wire/index.js"
+      "import": {
+        "types": "./dist/esm/wire/index.d.ts",
+        "default": "./dist/esm/wire/index.js"
+      },
+      "require": {
+        "types": "./dist/commonjs/wire/index.d.ts",
+        "default": "./dist/commonjs/wire/index.js"
+      }
+    },
+    "./txtpb": {
+      "import": {
+        "types": "./dist/esm/txtpb/index.d.ts",
+        "default": "./dist/esm/txtpb/index.js"
+      },
+      "require": {
+        "types": "./dist/commonjs/txtpb/index.d.ts",
+        "default": "./dist/commonjs/txtpb/index.js"
+      }
     }
   },
+  "main": "./dist/commonjs/index.js",
+  "types": "./dist/commonjs/index.d.ts",
+  "module": "./dist/esm/index.js",
   "typesVersions": {
     "*": {
-      "codegenv1": ["./dist/cjs/codegenv1/index.d.ts"],
-      "codegenv2": ["./dist/cjs/codegenv2/index.d.ts"],
-      "reflect": ["./dist/cjs/reflect/index.d.ts"],
-      "wkt": ["./dist/cjs/wkt/index.d.ts"],
-      "wire": ["./dist/cjs/wire/index.d.ts"]
+      "codegenv1": [
+        "./dist/commonjs/codegenv1/index.d.ts"
+      ],
+      "codegenv2": [
+        "./dist/commonjs/codegenv2/index.d.ts"
+      ],
+      "reflect": [
+        "./dist/commonjs/reflect/index.d.ts"
+      ],
+      "wkt": [
+        "./dist/commonjs/wkt/index.d.ts"
+      ],
+      "wire": [
+        "./dist/commonjs/wire/index.d.ts"
+      ],
+      "txtpb": [
+        "./dist/commonjs/txtpb/index.d.ts"
+      ]
     }
-  },
-  "devDependencies": {
-    "upstream-protobuf": "*"
-  },
-  "files": ["dist/**"]
+  }
 }

package/dist/cjs/codegenv2/enum.d.ts

@@ -1,18 +0,0 @@
-import type { DescEnum, DescFile } from "../descriptors.js";
-import type { GenEnum } from "./types.js";
-import type { JsonValue } from "../json-value.js";
-/**
- * Hydrate an enum descriptor.
- *
- * @private
- */
-export declare function enumDesc<Shape extends number, JsonType extends JsonValue = JsonValue>(file: DescFile, path: number, ...paths: number[]): GenEnum<Shape, JsonType>;
-/**
- * Construct a TypeScript enum object at runtime from a descriptor.
- */
-export declare function tsEnum(desc: DescEnum): enumObject;
-type enumObject = {
-    [key: number]: string;
-    [k: string]: number | string;
-};
-export {};

package/dist/cjs/package.json

@@ -1 +0,0 @@
-{"type":"commonjs"}

package/dist/cjs/reflect/scalar.d.ts

@@ -1,21 +0,0 @@
-import { ScalarType } from "../descriptors.js";
-/**
- * ScalarValue maps from a scalar field type to a TypeScript value type.
- */
-export type ScalarValue<T = ScalarType, LongAsString extends boolean = false> = T extends ScalarType.STRING ? string : T extends ScalarType.INT32 ? number : T extends ScalarType.UINT32 ? number : T extends ScalarType.SINT32 ? number : T extends ScalarType.FIXED32 ? number : T extends ScalarType.SFIXED32 ? number : T extends ScalarType.FLOAT ? number : T extends ScalarType.DOUBLE ? number : T extends ScalarType.INT64 ? LongAsString extends true ? string : bigint : T extends ScalarType.SINT64 ? LongAsString extends true ? string : bigint : T extends ScalarType.SFIXED64 ? LongAsString extends true ? string : bigint : T extends ScalarType.UINT64 ? LongAsString extends true ? string : bigint : T extends ScalarType.FIXED64 ? LongAsString extends true ? string : bigint : T extends ScalarType.BOOL ? boolean : T extends ScalarType.BYTES ? Uint8Array : never;
-/**
- * Returns true if both scalar values are equal.
- */
-export declare function scalarEquals(type: ScalarType, a: ScalarValue | undefined, b: ScalarValue | undefined): boolean;
-/**
- * Returns the zero value for the given scalar type.
- */
-export declare function scalarZeroValue<T extends ScalarType, LongAsString extends boolean>(type: T, longAsString: LongAsString): ScalarValue<T, LongAsString>;
-/**
- * Returns true for a zero-value. For example, an integer has the zero-value `0`,
- * a boolean is `false`, a string is `""`, and bytes is an empty Uint8Array.
- *
- * In proto3, zero-values are not written to the wire, unless the field is
- * optional or repeated.
- */
-export declare function isScalarZeroValue(type: ScalarType, value: unknown): boolean;