@bufbuild/protobuf 1.9.0 → 2.0.0-alpha.2

package/dist/{esm/descriptor-set.d.ts → cjs/desc-types.d.ts}

@@ -1,44 +1,7 @@
-import type { DescriptorProto, Edition, EnumDescriptorProto, EnumValueDescriptorProto, FieldDescriptorProto, FileDescriptorProto, MethodDescriptorProto, OneofDescriptorProto, ServiceDescriptorProto } from "./google/protobuf/descriptor_pb.js";
-import { LongType, ScalarType } from "./scalar.js";
-import type { MethodIdempotency, MethodKind } from "./service-type.js";
-import type { MergedFeatureSet } from "./private/feature-set.js";
-/**
- * DescriptorSet provides a convenient interface for working with a set
- * of google.protobuf.FileDescriptorProto.
- *
- * When protobuf sources are compiled, each file is parsed into a
- * google.protobuf.FileDescriptorProto. Those messages describe all parts
- * of the source file that are required to generate code for them.
- *
- * DescriptorSet resolves references between the descriptors, hides
- * implementation details like synthetic map entry messages, and provides
- * simple access to comments.
- */
-export interface DescriptorSet {
-    /**
-     * All files, in the order they were added to the set.
-     */
-    readonly files: DescFile[];
-    /**
-     * All enumerations, indexed by their fully qualified type name.
-     * (We omit the leading dot.)
-     */
-    readonly enums: ReadonlyMap<string, DescEnum>;
-    /**
-     * All messages, indexed by their fully qualified type name.
-     * (We omit the leading dot.)
-     */
-    readonly messages: ReadonlyMap<string, DescMessage>;
-    /**
-     * All services, indexed by their fully qualified type name.
-     * (We omit the leading dot.)
-     */
-    readonly services: ReadonlyMap<string, DescService>;
-    /**
-     * All extensions, indexed by their fully qualified type name.
-     */
-    readonly extensions: ReadonlyMap<string, DescExtension>;
-}
+import type { DescriptorProto, Edition, EnumDescriptorProto, EnumValueDescriptorProto, FeatureSet_FieldPresence, FieldDescriptorProto, FileDescriptorProto, MethodDescriptorProto, MethodOptions_IdempotencyLevel, OneofDescriptorProto, ServiceDescriptorProto } from "./wkt/gen/google/protobuf/descriptor_pb.js";
+import type { LongType, ScalarType, ScalarValue } from "./reflect/scalar.js";
+export type SupportedEdition = Extract<Edition, Edition.EDITION_PROTO2 | Edition.EDITION_PROTO3 | Edition.EDITION_2023>;
+type SupportedFieldPresence = Extract<FeatureSet_FieldPresence, FeatureSet_FieldPresence.EXPLICIT | FeatureSet_FieldPresence.IMPLICIT | FeatureSet_FieldPresence.LEGACY_REQUIRED>;
 /**
  * A union of all descriptors, discriminated by a `kind` property.
  */
@@ -48,15 +11,11 @@ export type AnyDesc = DescFile | DescEnum | DescEnumValue | DescMessage | DescFi
  */
 export interface DescFile {
     readonly kind: "file";
-    /**
-     * The syntax specified in the protobuf source.
-     */
-    readonly syntax: "proto3" | "proto2" | "editions";
     /**
      * The edition of the protobuf file. Will be EDITION_PROTO2 for syntax="proto2",
      * EDITION_PROTO3 for syntax="proto3";
      */
-    readonly edition: Exclude<Edition, Edition.EDITION_1_TEST_ONLY | Edition.EDITION_2_TEST_ONLY | Edition.EDITION_99997_TEST_ONLY | Edition.EDITION_99998_TEST_ONLY | Edition.EDITION_99999_TEST_ONLY>;
+    readonly edition: SupportedEdition;
     /**
      * The name of the file, excluding the .proto suffix.
      * For a protobuf file `foo/bar.proto`, this is `foo/bar`.
@@ -93,18 +52,6 @@ export interface DescFile {
      * The compiler-generated descriptor.
      */
     readonly proto: FileDescriptorProto;
-    /**
-     * Get comments on the syntax element in the protobuf source.
-     */
-    getSyntaxComments(): DescComments;
-    /**
-     * Get comments on the package element in the protobuf source.
-     */
-    getPackageComments(): DescComments;
-    /**
-     * Get the edition features for this protobuf element.
-     */
-    getFeatures(): MergedFeatureSet;
     toString(): string;
 }
 /**
@@ -128,13 +75,18 @@ export interface DescEnum {
      * The parent message, if this enumeration was declared inside a message declaration.
      */
     readonly parent: DescMessage | undefined;
+    /**
+     * Enumerations can be open or closed.
+     * See https://protobuf.dev/programming-guides/enum/
+     */
+    readonly open: boolean;
     /**
      * Values declared for this enumeration.
      */
     readonly values: DescEnumValue[];
     /**
      * A prefix shared by all enum values.
-     * For example, `MY_ENUM_` for `enum MyEnum {MY_ENUM_A=0; MY_ENUM_B=1;}`
+     * For example, `my_enum_` for `enum MyEnum {MY_ENUM_A=0; MY_ENUM_B=1;}`
      */
     readonly sharedPrefix?: string;
     /**
@@ -145,25 +97,21 @@ export interface DescEnum {
      * The compiler-generated descriptor.
      */
     readonly proto: EnumDescriptorProto;
-    /**
-     * Get comments on the element in the protobuf source.
-     */
-    getComments(): DescComments;
-    /**
-     * Get the edition features for this protobuf element.
-     */
-    getFeatures(): MergedFeatureSet;
     toString(): string;
 }
 /**
  * Describes an individual value of an enumeration in a protobuf source file.
  */
 export interface DescEnumValue {
-    kind: "enum_value";
+    readonly kind: "enum_value";
     /**
      * The name of the enumeration value, as specified in the protobuf source.
      */
     readonly name: string;
+    /**
+     * A safe and idiomatic name for the value in a TypeScript enum.
+     */
+    readonly localName: string;
     /**
      * The enumeration this value belongs to.
      */
@@ -180,19 +128,6 @@ export interface DescEnumValue {
      * The compiler-generated descriptor.
      */
     readonly proto: EnumValueDescriptorProto;
-    /**
-     * Return a string that (closely) matches the definition of the enumeration
-     * value in the protobuf source.
-     */
-    declarationString(): string;
-    /**
-     * Get comments on the element in the protobuf source.
-     */
-    getComments(): DescComments;
-    /**
-     * Get the edition features for this protobuf element.
-     */
-    getFeatures(): MergedFeatureSet;
     toString(): string;
 }
 /**
@@ -221,6 +156,10 @@ export interface DescMessage {
      * group.
      */
     readonly fields: DescField[];
+    /**
+     * All fields of this message by their "localName".
+     */
+    readonly field: Record<string, DescField>;
     /**
      * Oneof groups declared for this message.
      * This does not include synthetic oneofs for proto3 optionals.
@@ -252,30 +191,28 @@ export interface DescMessage {
      * The compiler-generated descriptor.
      */
     readonly proto: DescriptorProto;
-    /**
-     * Get comments on the element in the protobuf source.
-     */
-    getComments(): DescComments;
-    /**
-     * Get the edition features for this protobuf element.
-     */
-    getFeatures(): MergedFeatureSet;
     toString(): string;
 }
 /**
  * Describes a field declaration in a protobuf source file.
  */
-export type DescField = DescFieldCommon & (DescFieldScalar | DescFieldMessage | DescFieldEnum | DescFieldMap) & {
+export type DescField = (descFieldScalar & descFieldCommon) | (descFieldList & descFieldCommon) | (descFieldMessage & descFieldCommon) | (descFieldEnum & descFieldCommon) | (descFieldMap & descFieldCommon);
+type descFieldCommon = descFieldAndExtensionShared & {
     readonly kind: "field";
     /**
      * The message this field is declared on.
      */
     readonly parent: DescMessage;
+    /**
+     * A safe and idiomatic name for the field as a property in ECMAScript.
+     */
+    readonly localName: string;
 };
 /**
  * Describes an extension in a protobuf source file.
  */
-export type DescExtension = DescFieldCommon & (DescFieldScalar | DescFieldMessage | DescFieldEnum | DescFieldMap) & {
+export type DescExtension = (Omit<descFieldScalar, "oneof"> & descExtensionCommon) | (Omit<descFieldEnum, "oneof"> & descExtensionCommon) | (Omit<descFieldMessage, "oneof"> & descExtensionCommon) | (descFieldList & descExtensionCommon);
+type descExtensionCommon = descFieldAndExtensionShared & {
     readonly kind: "extension";
     /**
      * The fully qualified name of the extension.
@@ -293,8 +230,12 @@ export type DescExtension = DescFieldCommon & (DescFieldScalar | DescFieldMessag
      * The message that this extension extends.
      */
     readonly extendee: DescMessage;
+    /**
+     * The `oneof` group this field belongs to, if any.
+     */
+    readonly oneof: undefined;
 };
-interface DescFieldCommon {
+interface descFieldAndExtensionShared {
     /**
      * The field name, as specified in the protobuf source
      */
@@ -304,66 +245,41 @@ interface DescFieldCommon {
      */
     readonly number: number;
     /**
-     * The `oneof` group this field belongs to, if any.
-     */
-    readonly oneof: DescOneof | undefined;
-    /**
-     * Whether this field was declared with `optional` in the protobuf source.
-     */
-    readonly optional: boolean;
-    /**
-     * Pack this repeated field?
+     * The field name in JSON.
      */
-    readonly packed: boolean;
-    /**
-     * Is this field packed by default? Only valid for repeated enum fields, and
-     * for repeated scalar fields except BYTES and STRING.
-     *
-     * In proto3 syntax, fields are packed by default. In proto2 syntax, fields
-     * are unpacked by default.
-     *
-     * With editions, the default is whatever the edition specifies as a default.
-     * In edition 2023, fields are packed by default.
-     */
-    readonly packedByDefault: boolean;
-    /**
-     * A user-defined name for the JSON format, set with the field option
-     * [json_name="foo"].
-     */
-    readonly jsonName: string | undefined;
+    readonly jsonName: string;
     /**
      * Marked as deprecated in the protobuf source.
      */
     readonly deprecated: boolean;
     /**
-     * The compiler-generated descriptor.
-     */
-    readonly proto: FieldDescriptorProto;
-    /**
-     * Get comments on the element in the protobuf source.
+     * Presence of the field.
+     * See https://protobuf.dev/programming-guides/field_presence/
      */
-    getComments(): DescComments;
+    readonly presence: SupportedFieldPresence;
     /**
-     * Return a string that (closely) matches the definition of the field in the
-     * protobuf source.
+     * The compiler-generated descriptor.
      */
-    declarationString(): string;
+    readonly proto: FieldDescriptorProto;
     /**
      * Get the edition features for this protobuf element.
      */
-    getFeatures(): MergedFeatureSet;
     toString(): string;
 }
-interface DescFieldScalar {
-    readonly fieldKind: "scalar";
+type descFieldSingularCommon = {
     /**
-     * Is the field repeated?
+     * The `oneof` group this field belongs to, if any.
+     *
+     * This does not include synthetic oneofs for proto3 optionals.
      */
-    readonly repeated: boolean;
+    readonly oneof: DescOneof | undefined;
+};
+type descFieldScalar<T extends ScalarType = ScalarType> = T extends T ? {
+    readonly fieldKind: "scalar";
     /**
      * Scalar type, if it is a scalar field.
      */
-    readonly scalar: ScalarType;
+    readonly scalar: T;
     /**
      * JavaScript type for 64 bit integral types (int64, uint64,
      * sint64, fixed64, sfixed64).
@@ -377,67 +293,41 @@ interface DescFieldScalar {
      * The enum type, if it is an enum field.
      */
     readonly enum: undefined;
-    /**
-     * The map key type, if this is a map field.
-     */
-    readonly mapKey: undefined;
-    /**
-     * The map value type, if this is a map field.
-     */
-    readonly mapValue: undefined;
     /**
      * Return the default value specified in the protobuf source.
-     * Only valid for proto2 syntax.
      */
-    getDefaultValue(): number | boolean | string | bigint | Uint8Array | undefined;
-}
-interface DescFieldMessage {
+    getDefaultValue(): ScalarValue<T> | undefined;
+} & descFieldSingularCommon : never;
+type descFieldMessage = {
     readonly fieldKind: "message";
-    /**
-     * Is the field repeated?
-     */
-    readonly repeated: boolean;
     /**
      * Scalar type, if it is a scalar field.
      */
     readonly scalar: undefined;
-    /**
-     * JavaScript type for 64 bit integral types (int64, uint64,
-     * sint64, fixed64, sfixed64).
-     */
-    readonly longType: undefined;
     /**
      * The message type, if it is a message field.
      */
     readonly message: DescMessage;
     /**
-     * The enum type, if it is an enum field.
+     * Encode the message delimited (a.k.a. proto2 group encoding), or
+     * length-prefixed?
      */
-    readonly enum: undefined;
+    readonly delimitedEncoding: boolean;
     /**
-     * The map key type, if this is a map field.
+     * The enum type, if it is an enum field.
      */
-    readonly mapKey: undefined;
+    readonly enum: undefined;
     /**
-     * The map value type, if this is a map field.
+     * Return the default value specified in the protobuf source.
      */
-    readonly mapValue: undefined;
-}
-interface DescFieldEnum {
+    getDefaultValue(): undefined;
+} & descFieldSingularCommon;
+type descFieldEnum = {
     readonly fieldKind: "enum";
-    /**
-     * Is the field repeated?
-     */
-    readonly repeated: boolean;
     /**
      * Scalar type, if it is a scalar field.
      */
     readonly scalar: undefined;
-    /**
-     * JavaScript type for 64 bit integral types (int64, uint64,
-     * sint64, fixed64, sfixed64).
-     */
-    readonly longType: undefined;
     /**
      * The message type, if it is a message field.
      */
@@ -447,96 +337,141 @@ interface DescFieldEnum {
      */
     readonly enum: DescEnum;
     /**
-     * The map key type, if this is a map field.
+     * Return the default value specified in the protobuf source.
      */
-    readonly mapKey: undefined;
+    getDefaultValue(): number | undefined;
+} & descFieldSingularCommon;
+type descFieldList = (descFieldListScalar & descFieldListCommon) | (descFieldListEnum & descFieldListCommon) | (descFieldListMessage & descFieldListCommon);
+type descFieldListCommon = {
+    readonly fieldKind: "list";
     /**
-     * The map value type, if this is a map field.
+     * Pack this repeated field? Only valid for repeated enum fields, and
+     * for repeated scalar fields except BYTES and STRING.
      */
-    readonly mapValue: undefined;
+    readonly packed: boolean;
     /**
-     * Return the default value specified in the protobuf source.
-     * Only valid for proto2 syntax.
+     * The `oneof` group this field belongs to, if any.
      */
-    getDefaultValue(): number | boolean | string | bigint | Uint8Array | undefined;
-}
-interface DescFieldMap {
-    readonly fieldKind: "map";
+    readonly oneof: undefined;
+};
+type descFieldListScalar<T extends ScalarType = ScalarType> = T extends T ? {
+    readonly listKind: "scalar";
+    /**
+     * The enum list element type.
+     */
+    readonly enum: undefined;
     /**
-     * Is the field repeated?
+     * The message list element type.
      */
-    readonly repeated: false;
+    readonly message: undefined;
     /**
-     * Scalar type, if it is a scalar field.
+     * Scalar list element type.
      */
-    readonly scalar: undefined;
+    readonly scalar: T;
     /**
      * JavaScript type for 64 bit integral types (int64, uint64,
      * sint64, fixed64, sfixed64).
      */
-    readonly longType: undefined;
+    readonly longType: LongType;
+} : never;
+type descFieldListEnum = {
+    readonly listKind: "enum";
     /**
-     * The message type, if it is a message field.
+     * The enum list element type.
+     */
+    readonly enum: DescEnum;
+    /**
+     * The message list element type.
      */
     readonly message: undefined;
     /**
-     * The enum type, if it is an enum field.
+     * Scalar list element type.
+     */
+    readonly scalar: undefined;
+};
+type descFieldListMessage = {
+    readonly listKind: "message";
+    /**
+     * The enum list element type.
      */
     readonly enum: undefined;
     /**
-     * The map key type, if this is a map field.
+     * The message list element type.
      */
-    readonly mapKey: Exclude<ScalarType, ScalarType.FLOAT | ScalarType.DOUBLE | ScalarType.BYTES>;
+    readonly message: DescMessage;
     /**
-     * The map value type, if this is a map field.
+     * Scalar list element type.
      */
-    readonly mapValue: DescFieldMapValueEnum | DescFieldMapValueMessage | DescFieldMapValueScalar;
-}
-interface DescFieldMapValueEnum {
-    readonly kind: "enum";
+    readonly scalar: undefined;
     /**
-     * The enum type, if this is a map field with enum values.
+     * Encode the message delimited (a.k.a. proto2 group encoding), or
+     * length-prefixed?
      */
-    readonly enum: DescEnum;
+    readonly delimitedEncoding: boolean;
+};
+type descFieldMap = (descFieldMapScalar & descFieldMapCommon) | (descFieldMapEnum & descFieldMapCommon) | (descFieldMapMessage & descFieldMapCommon);
+type descFieldMapCommon<T extends ScalarType = ScalarType> = T extends Exclude<ScalarType, ScalarType.FLOAT | ScalarType.DOUBLE | ScalarType.BYTES> ? {
+    readonly fieldKind: "map";
     /**
-     * The message this message field uses.
+     * The scalar map key type.
      */
-    readonly message: undefined;
+    readonly mapKey: T;
     /**
-     * Scalar type, if this is a map field with scalar values.
+     * The `oneof` group this field belongs to, if any.
      */
-    readonly scalar: undefined;
-}
-interface DescFieldMapValueMessage {
-    readonly kind: "message";
+    readonly oneof: undefined;
     /**
-     * The enum type, if this is a map field with enum values.
+     * Encode the map entry message delimited (a.k.a. proto2 group encoding),
+     * or length-prefixed? As of Edition 2023, this is always false for map fields,
+     * and also applies to map values, if they are messages.
+     */
+    readonly delimitedEncoding: false;
+} : never;
+type descFieldMapScalar<T extends ScalarType = ScalarType> = T extends T ? {
+    readonly mapKind: "scalar";
+    /**
+     * The enum map value type.
      */
     readonly enum: undefined;
     /**
-     * The message type, if this is a map field with message values.
+     * The message map value type.
      */
-    readonly message: DescMessage;
+    readonly message: undefined;
+    /**
+     * Scalar map value type.
+     */
+    readonly scalar: T;
+} : never;
+type descFieldMapEnum = {
+    readonly mapKind: "enum";
     /**
-     * Scalar type, if this is a map field with scalar values.
+     * The enum map value type.
+     */
+    readonly enum: DescEnum;
+    /**
+     * The message map value type.
+     */
+    readonly message: undefined;
+    /**
+     * Scalar map value type.
      */
     readonly scalar: undefined;
-}
-interface DescFieldMapValueScalar {
-    readonly kind: "scalar";
+};
+type descFieldMapMessage = {
+    readonly mapKind: "message";
     /**
-     * The enum type, if this is a map field with enum values.
+     * The enum map value type.
      */
     readonly enum: undefined;
     /**
-     * The message type, if this is a map field with message values.
+     * The message map value type.
      */
-    readonly message: undefined;
+    readonly message: DescMessage;
     /**
-     * Scalar type, if this is a map field with scalar values.
+     * Scalar map value type.
      */
-    readonly scalar: ScalarType;
-}
+    readonly scalar: undefined;
+};
 /**
  * Describes a oneof group in a protobuf source file.
  */
@@ -546,6 +481,10 @@ export interface DescOneof {
      * The name of the oneof group, as specified in the protobuf source.
      */
     readonly name: string;
+    /**
+     * A safe and idiomatic name for the oneof group as a property in ECMAScript.
+     */
+    readonly localName: string;
     /**
      * The message this oneof group was declared in.
      */
@@ -564,14 +503,6 @@ export interface DescOneof {
      * The compiler-generated descriptor.
      */
     readonly proto: OneofDescriptorProto;
-    /**
-     * Get comments on the element in the protobuf source.
-     */
-    getComments(): DescComments;
-    /**
-     * Get the edition features for this protobuf element.
-     */
-    getFeatures(): MergedFeatureSet;
     toString(): string;
 }
 /**
@@ -603,14 +534,6 @@ export interface DescService {
      * The compiler-generated descriptor.
      */
     readonly proto: ServiceDescriptorProto;
-    /**
-     * Get comments on the element in the protobuf source.
-     */
-    getComments(): DescComments;
-    /**
-     * Get the edition features for this protobuf element.
-     */
-    getFeatures(): MergedFeatureSet;
     toString(): string;
 }
 /**
@@ -622,6 +545,10 @@ export interface DescMethod {
      * The name of the RPC, as specified in the protobuf source.
      */
     readonly name: string;
+    /**
+     * A safe and idiomatic name for the RPC as a method in ECMAScript.
+     */
+    readonly localName: string;
     /**
      * The parent service.
      */
@@ -629,7 +556,7 @@ export interface DescMethod {
     /**
      * One of the four available method types.
      */
-    readonly methodKind: MethodKind;
+    readonly methodKind: "unary" | "server_streaming" | "client_streaming" | "bidi_streaming";
     /**
      * The message type for requests.
      */
@@ -641,7 +568,7 @@ export interface DescMethod {
     /**
      * The idempotency level declared in the protobuf source, if any.
      */
-    readonly idempotency?: MethodIdempotency;
+    readonly idempotency: MethodOptions_IdempotencyLevel;
     /**
      * Marked as deprecated in the protobuf source.
      */
@@ -650,14 +577,6 @@ export interface DescMethod {
      * The compiler-generated descriptor.
      */
     readonly proto: MethodDescriptorProto;
-    /**
-     * Get comments on the element in the protobuf source.
-     */
-    getComments(): DescComments;
-    /**
-     * Get the edition features for this protobuf element.
-     */
-    getFeatures(): MergedFeatureSet;
     toString(): string;
 }
 /**

package/dist/cjs/equals.d.ts

@@ -0,0 +1,9 @@
+import type { MessageShape } from "./types.js";
+import type { DescMessage } from "./desc-types.js";
+/**
+ * Compare two messages of the same type.
+ *
+ * Note that this function disregards extensions and unknown fields, and that
+ * NaN is not equal NaN, following the IEEE standard.
+ */
+export declare function equals<Desc extends DescMessage>(messageDesc: Desc, a: MessageShape<Desc>, b: MessageShape<Desc>): boolean;