@bufbuild/protobuf 0.4.0 → 0.5.0

package/README.md

@@ -5,35 +5,39 @@ This package provides the runtime library for the code generator plugin
 
 ## Protocol Buffers for ECMAScript
 
-A complete implementation of [Protocol Buffers](https://developers.google.com/protocol-buffers)
-in TypeScript, suitable for web browsers and Node.js.  
-Learn more at [github.com/bufbuild/protobuf-es](https://github.com/bufbuild/protobuf-es).
+A complete implementation of [Protocol Buffers](https://developers.google.com/protocol-buffers) in TypeScript,
+suitable for web browsers and Node.js.
 
+**Protobuf-ES** is intended to be a solid, modern alternative to existing Protobuf implementations for the JavaScript ecosystem.  It is the first project in this space to provide a comprehensive plugin framework and decouple the base types from RPC functionality.
 
-It is a complete implementation of [Protocol Buffers](https://developers.google.com/protocol-buffers) 
-in TypeScript, suitable for web browsers and Node.js.
+Some additional features that set it apart from the others:
 
-For example, the following definition:
+- ECMAScript module support
+- First-class TypeScript support
+- Generation of idiomatic JavaScript and TypeScript code.
+- Generation of [much smaller bundles](packages/protobuf-bench)
+- Implementation of all proto3 features, including the [canonical JSON format](https://developers.google.com/protocol-buffers/docs/proto3#json).
+- Implementation of all proto2 features, except for extensions and the text format.  
+- Usage of standard JavaScript APIs instead of the [Closure Library](http://googlecode.blogspot.com/2009/11/introducing-closure-tools.html)
+- Compatibility is covered by the protocol buffers [conformance tests](packages/protobuf-conformance).
+- Descriptor and reflection support
 
-```protobuf
-message Person {
-  string name = 1;
-  int32 id = 2;  // Unique ID number for this person.
-  string email = 3;
-}
+## Installation
+
+```bash
+npm install @bufbuild/protobuf
 ```
 
-Is compiled to an ECMAScript class that can be used like this:
+## Documentation
 
-```typescript
-let pete = new Person({
-  name: "pete",
-  id: 123
-});
+To learn how to work with `@bufbuild/protobuf` check out the docs for the [Runtime API](https://github.com/bufbuild/protobuf-es/blob/main/docs/runtime_api.md)
+and the [generated code](https://github.com/bufbuild/protobuf-es/blob/main/docs/generated_code.md).
 
-let bytes = pete.toBinary();
-pete = Person.fromBinary(bytes);
-pete = Person.fromJsonString('{"name": "pete", "id": 123}');
-```
+Official documentation for the Protobuf-ES project can be found at [github.com/bufbuild/protobuf-es](https://github.com/bufbuild/protobuf-es).
+
+For more information on Buf, check out the official [Buf documentation](https://docs.buf.build/introduction).
+
+## Examples
+
+A complete code example can be found in the **Protobuf-ES** repo [here](https://github.com/bufbuild/protobuf-es/tree/main/packages/protobuf-example).
 
-Learn more at [github.com/bufbuild/protobuf-es](https://github.com/bufbuild/protobuf-es).

package/dist/cjs/google/protobuf/struct_pb.js

@@ -14,7 +14,7 @@
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ListValue = exports.Value = exports.Struct = exports.NullValue = void 0;
-// @generated by protoc-gen-es v0.4.0 with parameter "bootstrap_wkt=true,ts_nocheck=false,target=ts"
+// @generated by protoc-gen-es v0.5.0 with parameter "bootstrap_wkt=true,ts_nocheck=false,target=ts"
 // @generated from file google/protobuf/struct.proto (package google.protobuf, syntax proto3)
 /* eslint-disable */
 const proto3_js_1 = require("../../proto3.js");

package/dist/cjs/google/protobuf/type_pb.js

@@ -14,7 +14,7 @@
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Option = exports.EnumValue = exports.Enum = exports.Field_Cardinality = exports.Field_Kind = exports.Field = exports.Type = exports.Syntax = void 0;
-// @generated by protoc-gen-es v0.4.0 with parameter "bootstrap_wkt=true,ts_nocheck=false,target=ts"
+// @generated by protoc-gen-es v0.5.0 with parameter "bootstrap_wkt=true,ts_nocheck=false,target=ts"
 // @generated from file google/protobuf/type.proto (package google.protobuf, syntax proto3)
 /* eslint-disable */
 const proto3_js_1 = require("../../proto3.js");

package/dist/cjs/message.js

@@ -102,6 +102,9 @@ class Message {
      * unpacked, and this is only possible with a type registry to look up the
      * 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.
      */
     toJSON() {
         return this.toJson({

package/dist/esm/google/protobuf/struct_pb.js

@@ -11,7 +11,7 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-// @generated by protoc-gen-es v0.4.0 with parameter "bootstrap_wkt=true,ts_nocheck=false,target=ts"
+// @generated by protoc-gen-es v0.5.0 with parameter "bootstrap_wkt=true,ts_nocheck=false,target=ts"
 // @generated from file google/protobuf/struct.proto (package google.protobuf, syntax proto3)
 /* eslint-disable */
 import { proto3 } from "../../proto3.js";

package/dist/esm/google/protobuf/type_pb.js

@@ -11,7 +11,7 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-// @generated by protoc-gen-es v0.4.0 with parameter "bootstrap_wkt=true,ts_nocheck=false,target=ts"
+// @generated by protoc-gen-es v0.5.0 with parameter "bootstrap_wkt=true,ts_nocheck=false,target=ts"
 // @generated from file google/protobuf/type.proto (package google.protobuf, syntax proto3)
 /* eslint-disable */
 import { proto3 } from "../../proto3.js";

package/dist/esm/message.js

@@ -99,6 +99,9 @@ export class Message {
      * unpacked, and this is only possible with a type registry to look up the
      * 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.
      */
     toJSON() {
         return this.toJson({

package/dist/types/binary-encoding.d.ts

@@ -40,10 +40,10 @@ export declare enum WireType {
      */
     Bit32 = 5
 }
-declare type TextEncoderLike = {
+type TextEncoderLike = {
     encode(input?: string): Uint8Array;
 };
-declare type TextDecoderLike = {
+type TextDecoderLike = {
     decode(input?: Uint8Array): string;
 };
 export interface IBinaryReader {

package/dist/types/codegen-info.d.ts

@@ -11,8 +11,8 @@ interface CodegenInfo {
     readonly scalarDefaultValue: typeof scalarDefaultValue;
     readonly reifyWkt: typeof reifyWkt;
 }
-declare type RuntimeSymbolName = "proto2" | "proto3" | "Message" | "PartialMessage" | "PlainMessage" | "FieldList" | "MessageType" | "BinaryReadOptions" | "BinaryWriteOptions" | "JsonReadOptions" | "JsonWriteOptions" | "JsonValue" | "JsonObject" | "protoInt64" | "ScalarType" | "MethodKind" | "MethodIdempotency" | "IMessageTypeRegistry";
-declare type RuntimeSymbolInfo = {
+type RuntimeSymbolName = "proto2" | "proto3" | "Message" | "PartialMessage" | "PlainMessage" | "FieldList" | "MessageType" | "BinaryReadOptions" | "BinaryWriteOptions" | "JsonReadOptions" | "JsonWriteOptions" | "JsonValue" | "JsonObject" | "protoInt64" | "ScalarType" | "MethodKind" | "MethodIdempotency" | "IMessageTypeRegistry";
+type RuntimeSymbolInfo = {
     typeOnly: boolean;
     publicImportPath: string;
     privateImportPath: string;

package/dist/types/descriptor-set.d.ts

@@ -41,7 +41,7 @@ export interface DescriptorSet {
 /**
  * A union of all descriptors, discriminated by a `kind` property.
  */
-export declare type AnyDesc = DescFile | DescEnum | DescEnumValue | DescMessage | DescField | DescExtension | DescOneof | DescService | DescMethod;
+export type AnyDesc = DescFile | DescEnum | DescEnumValue | DescMessage | DescField | DescExtension | DescOneof | DescService | DescMethod;
 /**
  * Describes a protobuf source file.
  */
@@ -239,7 +239,7 @@ export interface DescMessage {
 /**
  * Describes a field declaration in a protobuf source file.
  */
-export declare type DescField = DescFieldCommon & (DescFieldScalar | DescFieldMessage | DescFieldEnum | DescFieldMap) & {
+export type DescField = DescFieldCommon & (DescFieldScalar | DescFieldMessage | DescFieldEnum | DescFieldMap) & {
     kind: "field";
     /**
      * The message this field is declared on.
@@ -249,7 +249,7 @@ export declare type DescField = DescFieldCommon & (DescFieldScalar | DescFieldMe
 /**
  * Describes an extension in a protobuf source file.
  */
-export declare type DescExtension = DescFieldCommon & (DescFieldScalar | DescFieldMessage | DescFieldEnum | DescFieldMap) & {
+export type DescExtension = DescFieldCommon & (DescFieldScalar | DescFieldMessage | DescFieldEnum | DescFieldMap) & {
     kind: "extension";
     /**
      * The fully qualified name of the extension.

package/dist/types/field.d.ts

@@ -24,7 +24,7 @@ import type { MessageType } from "./message-type.js";
  * - "oneof": If the field is member of a oneof group.
  * - "default": Only proto2: An explicit default value.
  */
-export declare type FieldInfo = fiRules<fiScalar> | fiRules<fiEnum> | fiRules<fiMessage> | fiRules<fiMap>;
+export type FieldInfo = fiRules<fiScalar> | fiRules<fiEnum> | fiRules<fiMessage> | fiRules<fiMap>;
 /**
  * Version of `FieldInfo` that allows the following properties
  * to be omitted:
@@ -34,7 +34,7 @@ export declare type FieldInfo = fiRules<fiScalar> | fiRules<fiEnum> | fiRules<fi
  * - "repeated": Can be omitted if false.
  * - "packed": Can be omitted if equal to the standard packing of the field.
  */
-export declare type PartialFieldInfo = fiPartialRules<fiScalar> | fiPartialRules<fiEnum> | fiPartialRules<fiMessage> | fiPartialRules<fiMap>;
+export type PartialFieldInfo = fiPartialRules<fiScalar> | fiPartialRules<fiEnum> | fiPartialRules<fiMessage> | fiPartialRules<fiMap>;
 /**
  * Provides convenient access to field information of a oneof.
  */
@@ -180,7 +180,7 @@ interface fiMap extends fiShared {
      */
     readonly default: undefined;
 }
-declare type fiRules<T> = Omit<T, "oneof" | "repeat" | "repeated" | "packed" | "opt"> & ({
+type fiRules<T> = Omit<T, "oneof" | "repeat" | "repeated" | "packed" | "opt"> & ({
     readonly repeated: false;
     readonly packed: false;
     readonly opt: false;
@@ -201,7 +201,7 @@ declare type fiRules<T> = Omit<T, "oneof" | "repeat" | "repeated" | "packed" | "
     readonly opt: false;
     readonly oneof: OneofInfo;
 });
-declare type fiPartialRules<T extends fiScalar | fiMap | fiEnum | fiMessage> = Omit<T, "jsonName" | "localName" | "oneof" | "repeat" | "repeated" | "packed" | "opt" | "default"> & ({
+type fiPartialRules<T extends fiScalar | fiMap | fiEnum | fiMessage> = Omit<T, "jsonName" | "localName" | "oneof" | "repeat" | "repeated" | "packed" | "opt" | "default"> & ({
     readonly jsonName?: string;
     readonly repeated?: false;
     readonly packed?: false;

package/dist/types/google/varint.d.ts

@@ -61,7 +61,7 @@ export declare function varint32write(value: number, bytes: number[]): void;
  * See https://github.com/protocolbuffers/protobuf/blob/8a71927d74a4ce34efe2d8769fda198f52d20d12/js/experimental/runtime/kernel/buffer_decoder.js#L220
  */
 export declare function varint32read(this: ReaderLike): number;
-declare type ReaderLike = {
+type ReaderLike = {
     buf: Uint8Array;
     pos: number;
     len: number;

package/dist/types/json-format.d.ts

@@ -101,10 +101,10 @@ export interface JsonWriteStringOptions extends JsonWriteOptions {
  * - object (with any JSON value as property)
  * - array (with any JSON value as element)
  */
-export declare type JsonValue = number | string | boolean | null | JsonObject | JsonValue[];
+export type JsonValue = number | string | boolean | null | JsonObject | JsonValue[];
 /**
  * Represents a JSON object.
  */
-export declare type JsonObject = {
+export type JsonObject = {
     [k: string]: JsonValue;
 };

package/dist/types/message.d.ts

@@ -65,8 +65,11 @@ export declare class Message<T extends Message<T> = AnyMessage> {
      * unpacked, and this is only possible with a type registry to look up the
      * 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.
      */
-    toJSON(): JsonValue;
+    protected toJSON(): JsonValue;
     /**
      * Retrieve the MessageType of this message - a singleton that represents
      * the protobuf message declaration and provides metadata for reflection-
@@ -79,10 +82,10 @@ export declare class Message<T extends Message<T> = AnyMessage> {
  * and oneof groups.  It is recursive, meaning it applies this same logic to all
  * nested message fields as well.
  */
-export declare type PlainMessage<T extends Message<T>> = {
+export type PlainMessage<T extends Message<T>> = {
     [P in keyof T as T[P] extends Function ? never : P]: PlainField<T[P]>;
 };
-declare type PlainField<F> = F extends (Date | Uint8Array | bigint | boolean | string | number) ? F : F extends Array<infer U> ? Array<PlainField<U>> : F extends ReadonlyArray<infer U> ? ReadonlyArray<PlainField<U>> : F extends Message<infer U> ? PlainMessage<U> : F extends OneofSelectedMessage<infer C, infer V> ? {
+type PlainField<F> = F extends (Date | Uint8Array | bigint | boolean | string | number) ? F : F extends Array<infer U> ? Array<PlainField<U>> : F extends ReadonlyArray<infer U> ? ReadonlyArray<PlainField<U>> : F extends Message<infer U> ? PlainMessage<U> : F extends OneofSelectedMessage<infer C, infer V> ? {
     case: C;
     value: PlainField<V>;
 } : F extends {
@@ -104,10 +107,10 @@ declare type PlainField<F> = F extends (Date | Uint8Array | bigint | boolean | s
  * PartialMessage is similar to the built-in type Partial<T>, but recursive,
  * and respects `oneof` groups.
  */
-export declare type PartialMessage<T extends Message<T>> = {
+export type PartialMessage<T extends Message<T>> = {
     [P in keyof T as T[P] extends Function ? never : P]?: PartialField<T[P]>;
 };
-declare type PartialField<F> = F extends (Date | Uint8Array | bigint | boolean | string | number) ? F : F extends Array<infer U> ? Array<PartialField<U>> : F extends ReadonlyArray<infer U> ? ReadonlyArray<PartialField<U>> : F extends Message<infer U> ? PartialMessage<U> : F extends OneofSelectedMessage<infer C, infer V> ? {
+type PartialField<F> = F extends (Date | Uint8Array | bigint | boolean | string | number) ? F : F extends Array<infer U> ? Array<PartialField<U>> : F extends ReadonlyArray<infer U> ? ReadonlyArray<PartialField<U>> : F extends Message<infer U> ? PartialMessage<U> : F extends OneofSelectedMessage<infer C, infer V> ? {
     case: C;
     value: PartialMessage<V>;
 } : F extends {
@@ -118,7 +121,7 @@ declare type PartialField<F> = F extends (Date | Uint8Array | bigint | boolean |
 } ? {
     [key: string | number]: PartialMessage<U>;
 } : F;
-declare type OneofSelectedMessage<K extends string, M extends Message<M>> = {
+type OneofSelectedMessage<K extends string, M extends Message<M>> = {
     case: K;
     value: M;
 };

package/dist/types/private/field-list.d.ts

@@ -1,6 +1,6 @@
 import type { FieldInfo, OneofInfo, PartialFieldInfo } from "../field.js";
 import type { FieldList } from "../field-list.js";
-export declare type FieldListSource = readonly PartialFieldInfo[] | readonly FieldInfo[] | (() => readonly PartialFieldInfo[]) | (() => readonly FieldInfo[]);
+export type FieldListSource = readonly PartialFieldInfo[] | readonly FieldInfo[] | (() => readonly PartialFieldInfo[]) | (() => readonly FieldInfo[]);
 export declare class InternalFieldList implements FieldList {
     private readonly _fields;
     private readonly _normalizer;

package/dist/types/private/json-format-common.d.ts

@@ -1,7 +1,7 @@
 import type { JsonFormat, JsonValue, JsonWriteOptions } from "../json-format.js";
 import { FieldInfo, ScalarType } from "../field.js";
 import type { EnumType } from "../enum.js";
-declare type JsonFormatWriteFieldFn = (field: FieldInfo, value: any, options: JsonWriteOptions) => JsonValue | undefined;
+type JsonFormatWriteFieldFn = (field: FieldInfo, value: any, options: JsonWriteOptions) => JsonValue | undefined;
 export declare function makeJsonFormatCommon(makeWriteField: (writeEnumFn: typeof writeEnum, writeScalarFn: typeof writeScalar) => JsonFormatWriteFieldFn): JsonFormat;
 declare function writeEnum(type: EnumType, value: number | undefined, emitIntrinsicDefault: boolean, enumAsInteger: boolean): JsonValue | undefined;
 declare function writeScalar(type: ScalarType, value: any, emitIntrinsicDefault: boolean): JsonValue | undefined;

package/dist/types/private/options-map.d.ts

@@ -2,6 +2,6 @@ import type { JsonValue } from "../json-format";
 /**
  *
  */
-export declare type OptionsMap = {
+export type OptionsMap = {
     readonly [extensionName: string]: JsonValue;
 };

package/dist/types/private/reify-wkt.d.ts

@@ -1,5 +1,5 @@
 import type { DescField, DescMessage, DescOneof } from "../descriptor-set.js";
-declare type DescWkt = {
+type DescWkt = {
     typeName: "google.protobuf.Any";
     typeUrl: DescField;
     value: DescField;

package/dist/types/service-type.d.ts

@@ -29,7 +29,7 @@ export interface ServiceType {
  * - "idempotency": User-provided indication whether the method will cause
  *   the same effect every time it is called.
  */
-export declare type MethodInfo<I extends Message<I> = AnyMessage, O extends Message<O> = AnyMessage> = MethodInfoUnary<I, O> | MethodInfoServerStreaming<I, O> | MethodInfoClientStreaming<I, O> | MethodInfoBiDiStreaming<I, O>;
+export type MethodInfo<I extends Message<I> = AnyMessage, O extends Message<O> = AnyMessage> = MethodInfoUnary<I, O> | MethodInfoServerStreaming<I, O> | MethodInfoClientStreaming<I, O> | MethodInfoBiDiStreaming<I, O>;
 /**
  * A unary method: rpc (Input) returns (Output)
  */

package/package.json

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