@bufbuild/protobuf 0.5.0 → 1.1.0

package/dist/types/google/protobuf/type_pb.d.ts

@@ -1,3 +1,4 @@
+import { proto3 } from "../../proto3.js";
 import type { PartialMessage, PlainMessage } from "../../message.js";
 import { Message } from "../../message.js";
 import { SourceContext } from "./source_context_pb.js";
@@ -67,7 +68,7 @@ export declare class Type extends Message<Type> {
      */
     syntax: Syntax;
     constructor(data?: PartialMessage<Type>);
-    static readonly runtime: import("../../private/proto-runtime.js").ProtoRuntime;
+    static readonly runtime: typeof proto3;
     static readonly typeName = "google.protobuf.Type";
     static readonly fields: FieldList;
     static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): Type;
@@ -144,7 +145,7 @@ export declare class Field extends Message<Field> {
      */
     defaultValue: string;
     constructor(data?: PartialMessage<Field>);
-    static readonly runtime: import("../../private/proto-runtime.js").ProtoRuntime;
+    static readonly runtime: typeof proto3;
     static readonly typeName = "google.protobuf.Field";
     static readonly fields: FieldList;
     static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): Field;
@@ -341,7 +342,7 @@ export declare class Enum extends Message<Enum> {
      */
     syntax: Syntax;
     constructor(data?: PartialMessage<Enum>);
-    static readonly runtime: import("../../private/proto-runtime.js").ProtoRuntime;
+    static readonly runtime: typeof proto3;
     static readonly typeName = "google.protobuf.Enum";
     static readonly fields: FieldList;
     static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): Enum;
@@ -374,7 +375,7 @@ export declare class EnumValue extends Message<EnumValue> {
      */
     options: Option[];
     constructor(data?: PartialMessage<EnumValue>);
-    static readonly runtime: import("../../private/proto-runtime.js").ProtoRuntime;
+    static readonly runtime: typeof proto3;
     static readonly typeName = "google.protobuf.EnumValue";
     static readonly fields: FieldList;
     static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): EnumValue;
@@ -408,7 +409,7 @@ export declare class Option extends Message<Option> {
      */
     value?: Any;
     constructor(data?: PartialMessage<Option>);
-    static readonly runtime: import("../../private/proto-runtime.js").ProtoRuntime;
+    static readonly runtime: typeof proto3;
     static readonly typeName = "google.protobuf.Option";
     static readonly fields: FieldList;
     static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): Option;

package/dist/types/google/protobuf/wrappers_pb.d.ts

@@ -1,5 +1,6 @@
 import type { PartialMessage, PlainMessage } from "../../message.js";
 import { Message } from "../../message.js";
+import { proto3 } from "../../proto3.js";
 import type { JsonReadOptions, JsonValue, JsonWriteOptions } from "../../json-format.js";
 import type { FieldList } from "../../field-list.js";
 import type { BinaryReadOptions } from "../../binary-format.js";
@@ -20,7 +21,7 @@ export declare class DoubleValue extends Message<DoubleValue> {
     constructor(data?: PartialMessage<DoubleValue>);
     toJson(options?: Partial<JsonWriteOptions>): JsonValue;
     fromJson(json: JsonValue, options?: Partial<JsonReadOptions>): this;
-    static readonly runtime: import("../../private/proto-runtime.js").ProtoRuntime;
+    static readonly runtime: typeof proto3;
     static readonly typeName = "google.protobuf.DoubleValue";
     static readonly fields: FieldList;
     static readonly fieldWrapper: {
@@ -49,7 +50,7 @@ export declare class FloatValue extends Message<FloatValue> {
     constructor(data?: PartialMessage<FloatValue>);
     toJson(options?: Partial<JsonWriteOptions>): JsonValue;
     fromJson(json: JsonValue, options?: Partial<JsonReadOptions>): this;
-    static readonly runtime: import("../../private/proto-runtime.js").ProtoRuntime;
+    static readonly runtime: typeof proto3;
     static readonly typeName = "google.protobuf.FloatValue";
     static readonly fields: FieldList;
     static readonly fieldWrapper: {
@@ -78,7 +79,7 @@ export declare class Int64Value extends Message<Int64Value> {
     constructor(data?: PartialMessage<Int64Value>);
     toJson(options?: Partial<JsonWriteOptions>): JsonValue;
     fromJson(json: JsonValue, options?: Partial<JsonReadOptions>): this;
-    static readonly runtime: import("../../private/proto-runtime.js").ProtoRuntime;
+    static readonly runtime: typeof proto3;
     static readonly typeName = "google.protobuf.Int64Value";
     static readonly fields: FieldList;
     static readonly fieldWrapper: {
@@ -107,7 +108,7 @@ export declare class UInt64Value extends Message<UInt64Value> {
     constructor(data?: PartialMessage<UInt64Value>);
     toJson(options?: Partial<JsonWriteOptions>): JsonValue;
     fromJson(json: JsonValue, options?: Partial<JsonReadOptions>): this;
-    static readonly runtime: import("../../private/proto-runtime.js").ProtoRuntime;
+    static readonly runtime: typeof proto3;
     static readonly typeName = "google.protobuf.UInt64Value";
     static readonly fields: FieldList;
     static readonly fieldWrapper: {
@@ -136,7 +137,7 @@ export declare class Int32Value extends Message<Int32Value> {
     constructor(data?: PartialMessage<Int32Value>);
     toJson(options?: Partial<JsonWriteOptions>): JsonValue;
     fromJson(json: JsonValue, options?: Partial<JsonReadOptions>): this;
-    static readonly runtime: import("../../private/proto-runtime.js").ProtoRuntime;
+    static readonly runtime: typeof proto3;
     static readonly typeName = "google.protobuf.Int32Value";
     static readonly fields: FieldList;
     static readonly fieldWrapper: {
@@ -165,7 +166,7 @@ export declare class UInt32Value extends Message<UInt32Value> {
     constructor(data?: PartialMessage<UInt32Value>);
     toJson(options?: Partial<JsonWriteOptions>): JsonValue;
     fromJson(json: JsonValue, options?: Partial<JsonReadOptions>): this;
-    static readonly runtime: import("../../private/proto-runtime.js").ProtoRuntime;
+    static readonly runtime: typeof proto3;
     static readonly typeName = "google.protobuf.UInt32Value";
     static readonly fields: FieldList;
     static readonly fieldWrapper: {
@@ -194,7 +195,7 @@ export declare class BoolValue extends Message<BoolValue> {
     constructor(data?: PartialMessage<BoolValue>);
     toJson(options?: Partial<JsonWriteOptions>): JsonValue;
     fromJson(json: JsonValue, options?: Partial<JsonReadOptions>): this;
-    static readonly runtime: import("../../private/proto-runtime.js").ProtoRuntime;
+    static readonly runtime: typeof proto3;
     static readonly typeName = "google.protobuf.BoolValue";
     static readonly fields: FieldList;
     static readonly fieldWrapper: {
@@ -223,7 +224,7 @@ export declare class StringValue extends Message<StringValue> {
     constructor(data?: PartialMessage<StringValue>);
     toJson(options?: Partial<JsonWriteOptions>): JsonValue;
     fromJson(json: JsonValue, options?: Partial<JsonReadOptions>): this;
-    static readonly runtime: import("../../private/proto-runtime.js").ProtoRuntime;
+    static readonly runtime: typeof proto3;
     static readonly typeName = "google.protobuf.StringValue";
     static readonly fields: FieldList;
     static readonly fieldWrapper: {
@@ -252,7 +253,7 @@ export declare class BytesValue extends Message<BytesValue> {
     constructor(data?: PartialMessage<BytesValue>);
     toJson(options?: Partial<JsonWriteOptions>): JsonValue;
     fromJson(json: JsonValue, options?: Partial<JsonReadOptions>): this;
-    static readonly runtime: import("../../private/proto-runtime.js").ProtoRuntime;
+    static readonly runtime: typeof proto3;
     static readonly typeName = "google.protobuf.BytesValue";
     static readonly fields: FieldList;
     static readonly fieldWrapper: {

package/dist/types/index.d.ts

@@ -2,6 +2,7 @@ export { proto3 } from "./proto3.js";
 export { proto2 } from "./proto2.js";
 export { protoInt64 } from "./proto-int64.js";
 export { protoBase64 } from "./proto-base64.js";
+export { protoDelimited } from "./proto-delimited.js";
 export { codegenInfo } from "./codegen-info.js";
 export { Message, AnyMessage, PartialMessage, PlainMessage, } from "./message.js";
 export type { FieldInfo } from "./field.js";

package/dist/types/message.d.ts

@@ -66,8 +66,10 @@ export declare class Message<T extends Message<T> = AnyMessage> {
      * message type.  As a result, attempting to serialize a message with this
      * type will throw an Error.
      *
-     * Note that this method is protected because users should not need to invoke
-     * it directly -- they can use JSON.stringify.
+     * This method is protected because you should not need to invoke it
+     * directly -- instead use JSON.stringify or toJsonString for
+     * stringified JSON.  Alternatively, if actual JSON is desired, you should
+     * use toJson.
      */
     protected toJSON(): JsonValue;
     /**

package/dist/types/proto-delimited.d.ts

@@ -0,0 +1,54 @@
+import type { BinaryReadOptions, BinaryWriteOptions } from "./binary-format.js";
+import type { Message } from "./message.js";
+import type { MessageType } from "./message-type.js";
+/**
+ * protoDelimited provides functions to serialize and parse size-delimited
+ * messages.
+ *
+ * A size-delimited message is a varint size in bytes, followed by exactly
+ * that many bytes of a message serialized with the binary format.
+ *
+ * This size-delimited format is compatible with other implementations.
+ * For details, see https://github.com/protocolbuffers/protobuf/issues/10229
+ */
+export declare const protoDelimited: {
+    /**
+     * Serialize a message, prefixing it with its size.
+     */
+    enc(message: Message, options?: BinaryWriteOptions): Uint8Array;
+    /**
+     * Parse a size-delimited message, ignoring extra bytes.
+     */
+    dec<T extends Message<T>>(type: MessageType<T>, bytes: Uint8Array, options?: BinaryReadOptions): T;
+    /**
+     * Parse a stream of size-delimited messages.
+     */
+    decStream<T_1 extends Message<T_1>>(type: MessageType<T_1>, iterable: AsyncIterable<Uint8Array>): AsyncGenerator<T_1, void, unknown>;
+    /**
+     * Decodes the size from the given size-delimited message, which may be
+     * incomplete.
+     *
+     * Returns an object with the following properties:
+     * - size: The size of the delimited message in bytes
+     * - offset: The offset in the given byte array where the message starts
+     * - eof: true
+     *
+     * If the size-delimited data does not include all bytes of the varint size,
+     * the following object is returned:
+     * - size: null
+     * - offset: null
+     * - eof: false
+     *
+     * This function can be used to implement parsing of size-delimited messages
+     * from a stream.
+     */
+    peekSize(data: Uint8Array): {
+        readonly eof: false;
+        readonly size: number;
+        readonly offset: number;
+    } | {
+        readonly eof: true;
+        readonly size: null;
+        readonly offset: null;
+    };
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bufbuild/protobuf",
-  "version": "0.5.0",
+  "version": "1.1.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.",
   "repository": {