@bufbuild/protobuf 1.4.1 → 1.5.0

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

@@ -1,6 +1,7 @@
-import type { DescriptorProto, EnumDescriptorProto, EnumValueDescriptorProto, FieldDescriptorProto, FileDescriptorProto, MethodDescriptorProto, OneofDescriptorProto, ServiceDescriptorProto } from "./google/protobuf/descriptor_pb.js";
-import type { ScalarType, LongType } from "./field.js";
+import type { DescriptorProto, Edition, EnumDescriptorProto, EnumValueDescriptorProto, FieldDescriptorProto, FileDescriptorProto, MethodDescriptorProto, OneofDescriptorProto, ServiceDescriptorProto } from "./google/protobuf/descriptor_pb.js";
+import type { LongType, ScalarType } from "./field.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.
@@ -50,7 +51,12 @@ export interface DescFile {
     /**
      * The syntax specified in the protobuf source.
      */
-    readonly syntax: "proto3" | "proto2";
+    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>;
     /**
      * The name of the file, excluding the .proto suffix.
      * For a protobuf file `foo/bar.proto`, this is `foo/bar`.
@@ -91,6 +97,10 @@ export interface DescFile {
      * Get comments on the package element in the protobuf source.
      */
     getPackageComments(): DescComments;
+    /**
+     * Get the edition features for this protobuf element.
+     */
+    getFeatures(): MergedFeatureSet;
     toString(): string;
 }
 /**
@@ -135,6 +145,10 @@ export interface DescEnum {
      * Get comments on the element in the protobuf source.
      */
     getComments(): DescComments;
+    /**
+     * Get the edition features for this protobuf element.
+     */
+    getFeatures(): MergedFeatureSet;
     toString(): string;
 }
 /**
@@ -171,6 +185,10 @@ export interface DescEnumValue {
      * Get comments on the element in the protobuf source.
      */
     getComments(): DescComments;
+    /**
+     * Get the edition features for this protobuf element.
+     */
+    getFeatures(): MergedFeatureSet;
     toString(): string;
 }
 /**
@@ -234,6 +252,10 @@ export interface DescMessage {
      * Get comments on the element in the protobuf source.
      */
     getComments(): DescComments;
+    /**
+     * Get the edition features for this protobuf element.
+     */
+    getFeatures(): MergedFeatureSet;
     toString(): string;
 }
 /**
@@ -290,10 +312,14 @@ interface DescFieldCommon {
      */
     readonly packed: boolean;
     /**
-     * Is this field packed by default? Only valid for enum fields, and for
-     * scalar fields except BYTES and STRING.
+     * 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;
     /**
@@ -318,6 +344,10 @@ interface DescFieldCommon {
      * protobuf source.
      */
     declarationString(): string;
+    /**
+     * Get the edition features for this protobuf element.
+     */
+    getFeatures(): MergedFeatureSet;
     toString(): string;
 }
 interface DescFieldScalar {
@@ -534,6 +564,10 @@ export interface DescOneof {
      * Get comments on the element in the protobuf source.
      */
     getComments(): DescComments;
+    /**
+     * Get the edition features for this protobuf element.
+     */
+    getFeatures(): MergedFeatureSet;
     toString(): string;
 }
 /**
@@ -569,6 +603,10 @@ export interface DescService {
      * Get comments on the element in the protobuf source.
      */
     getComments(): DescComments;
+    /**
+     * Get the edition features for this protobuf element.
+     */
+    getFeatures(): MergedFeatureSet;
     toString(): string;
 }
 /**
@@ -612,6 +650,10 @@ export interface DescMethod {
      * 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/esm/google/protobuf/any_pb.js

@@ -237,7 +237,7 @@ export class Any extends Message {
             throw new Error(`invalid type url: ${url}`);
         }
         const slash = url.lastIndexOf("/");
-        const name = slash > 0 ? url.substring(slash + 1) : url;
+        const name = slash >= 0 ? url.substring(slash + 1) : url;
         if (!name.length) {
             throw new Error(`invalid type url: ${url}`);
         }

package/dist/esm/google/protobuf/descriptor_pb.d.ts

@@ -1,9 +1,66 @@
+import { proto2 } from "../../proto2.js";
 import type { PartialMessage, PlainMessage } from "../../message.js";
 import { Message } from "../../message.js";
-import { proto2 } from "../../proto2.js";
 import type { FieldList } from "../../field-list.js";
 import type { BinaryReadOptions } from "../../binary-format.js";
 import type { JsonReadOptions, JsonValue } from "../../json-format.js";
+/**
+ * The full set of known editions.
+ *
+ * @generated from enum google.protobuf.Edition
+ */
+export declare enum Edition {
+    /**
+     * A placeholder for an unknown edition value.
+     *
+     * @generated from enum value: EDITION_UNKNOWN = 0;
+     */
+    EDITION_UNKNOWN = 0,
+    /**
+     * Legacy syntax "editions".  These pre-date editions, but behave much like
+     * distinct editions.  These can't be used to specify the edition of proto
+     * files, but feature definitions must supply proto2/proto3 defaults for
+     * backwards compatibility.
+     *
+     * @generated from enum value: EDITION_PROTO2 = 998;
+     */
+    EDITION_PROTO2 = 998,
+    /**
+     * @generated from enum value: EDITION_PROTO3 = 999;
+     */
+    EDITION_PROTO3 = 999,
+    /**
+     * Editions that have been released.  The specific values are arbitrary and
+     * should not be depended on, but they will always be time-ordered for easy
+     * comparison.
+     *
+     * @generated from enum value: EDITION_2023 = 1000;
+     */
+    EDITION_2023 = 1000,
+    /**
+     * Placeholder editions for testing feature resolution.  These should not be
+     * used or relyed on outside of tests.
+     *
+     * @generated from enum value: EDITION_1_TEST_ONLY = 1;
+     */
+    EDITION_1_TEST_ONLY = 1,
+    /**
+     * @generated from enum value: EDITION_2_TEST_ONLY = 2;
+     */
+    EDITION_2_TEST_ONLY = 2,
+    /**
+     * @generated from enum value: EDITION_99997_TEST_ONLY = 99997;
+     */
+    EDITION_99997_TEST_ONLY = 99997,
+    /**
+     * @generated from enum value: EDITION_99998_TEST_ONLY = 99998;
+     */
+    EDITION_99998_TEST_ONLY = 99998,
+    /**
+     * @generated from enum value: EDITION_99999_TEST_ONLY = 99999;
+     */
+    EDITION_99999_TEST_ONLY = 99999
+}
 /**
  * The protocol compiler can output a FileDescriptorSet containing the .proto
  * files it parses.
@@ -102,11 +159,11 @@ export declare class FileDescriptorProto extends Message<FileDescriptorProto> {
      */
     syntax?: string;
     /**
-     * The edition of the proto file, which is an opaque string.
+     * The edition of the proto file.
      *
-     * @generated from field: optional string edition = 13;
+     * @generated from field: optional google.protobuf.Edition edition = 14;
      */
-    edition?: string;
+    edition?: Edition;
     constructor(data?: PartialMessage<FileDescriptorProto>);
     static readonly runtime: typeof proto2;
     static readonly typeName = "google.protobuf.FileDescriptorProto";
@@ -258,7 +315,7 @@ export declare class ExtensionRangeOptions extends Message<ExtensionRangeOptions
     features?: FeatureSet;
     /**
      * The verification state of the range.
-     * TODO(b/278783756): flip the default to DECLARATION once all empty ranges
+     * TODO: flip the default to DECLARATION once all empty ranges
      * are marked as UNVERIFIED.
      *
      * @generated from field: optional google.protobuf.ExtensionRangeOptions.VerificationState verification = 3 [default = UNVERIFIED];
@@ -496,9 +553,10 @@ export declare enum FieldDescriptorProto_Type {
     STRING = 9,
     /**
      * Tag-delimited aggregate.
-     * Group type is deprecated and not supported in proto3. However, Proto3
+     * Group type is deprecated and not supported after google.protobuf. However, Proto3
      * implementations should still be able to parse the group wire format and
-     * treat group fields as unknown fields.
+     * treat group fields as unknown fields.  In Editions, the group wire format
+     * can be enabled via the `message_encoding` feature.
      *
      * @generated from enum value: TYPE_GROUP = 10;
      */
@@ -555,13 +613,17 @@ export declare enum FieldDescriptorProto_Label {
      */
     OPTIONAL = 1,
     /**
-     * @generated from enum value: LABEL_REQUIRED = 2;
+     * @generated from enum value: LABEL_REPEATED = 3;
      */
-    REQUIRED = 2,
+    REPEATED = 3,
     /**
-     * @generated from enum value: LABEL_REPEATED = 3;
+     * The required label is only allowed in google.protobuf.  In proto3 and Editions
+     * it's explicitly prohibited.  In Editions, the `field_presence` feature
+     * can be used to get this behavior.
+     *
+     * @generated from enum value: LABEL_REQUIRED = 2;
      */
-    REPEATED = 3
+    REQUIRED = 2
 }
 /**
  * Describes a oneof.
@@ -1050,7 +1112,7 @@ export declare class MessageOptions extends Message<MessageOptions> {
      * This should only be used as a temporary measure against broken builds due
      * to the change in behavior for JSON field name conflicts.
      *
-     * TODO(b/261750190) This is legacy behavior we plan to remove once downstream
+     * TODO This is legacy behavior we plan to remove once downstream
      * teams have had time to migrate.
      *
      * @generated from field: optional bool deprecated_legacy_json_field_conflicts = 11 [deprecated = true];
@@ -1098,7 +1160,9 @@ export declare class FieldOptions extends Message<FieldOptions> {
      * a more efficient representation on the wire. Rather than repeatedly
      * writing the tag and type for each element, the entire array is encoded as
      * a single length-delimited blob. In proto3, only explicit setting it to
-     * false will avoid using packed encoding.
+     * false will avoid using packed encoding.  This option is prohibited in
+     * Editions, but the `repeated_field_encoding` feature can be used to control
+     * the behavior.
      *
      * @generated from field: optional bool packed = 2;
      */
@@ -1342,9 +1406,9 @@ export declare enum FieldOptions_OptionTargetType {
  */
 export declare class FieldOptions_EditionDefault extends Message<FieldOptions_EditionDefault> {
     /**
-     * @generated from field: optional string edition = 1;
+     * @generated from field: optional google.protobuf.Edition edition = 3;
      */
-    edition?: string;
+    edition?: Edition;
     /**
      * Textproto value.
      *
@@ -1410,7 +1474,7 @@ export declare class EnumOptions extends Message<EnumOptions> {
      * and strips underscored from the fields before comparison in proto3 only.
      * The new behavior takes `json_name` into account and applies to proto2 as
      * well.
-     * TODO(b/261750190) Remove this legacy behavior once downstream teams have
+     * TODO Remove this legacy behavior once downstream teams have
      * had time to migrate.
      *
      * @generated from field: optional bool deprecated_legacy_json_field_conflicts = 6 [deprecated = true];
@@ -1656,7 +1720,7 @@ export declare class UninterpretedOption_NamePart extends Message<UninterpretedO
     static equals(a: UninterpretedOption_NamePart | PlainMessage<UninterpretedOption_NamePart> | undefined, b: UninterpretedOption_NamePart | PlainMessage<UninterpretedOption_NamePart> | undefined): boolean;
 }
 /**
- * TODO(b/274655146) Enums in C++ gencode (and potentially other languages) are
+ * TODO Enums in C++ gencode (and potentially other languages) are
  * not well scoped.  This means that each of the feature enums below can clash
  * with each other.  The short names we've chosen maximize call-site
  * readability, but leave us very open to this scenario.  A future feature will
@@ -1679,9 +1743,9 @@ export declare class FeatureSet extends Message<FeatureSet> {
      */
     repeatedFieldEncoding?: FeatureSet_RepeatedFieldEncoding;
     /**
-     * @generated from field: optional google.protobuf.FeatureSet.StringFieldValidation string_field_validation = 4;
+     * @generated from field: optional google.protobuf.FeatureSet.Utf8Validation utf8_validation = 4;
      */
-    stringFieldValidation?: FeatureSet_StringFieldValidation;
+    utf8Validation?: FeatureSet_Utf8Validation;
     /**
      * @generated from field: optional google.protobuf.FeatureSet.MessageEncoding message_encoding = 5;
      */
@@ -1690,10 +1754,6 @@ export declare class FeatureSet extends Message<FeatureSet> {
      * @generated from field: optional google.protobuf.FeatureSet.JsonFormat json_format = 6;
      */
     jsonFormat?: FeatureSet_JsonFormat;
-    /**
-     * @generated from field: optional google.protobuf.FeatureSet raw_features = 999;
-     */
-    rawFeatures?: FeatureSet;
     constructor(data?: PartialMessage<FeatureSet>);
     static readonly runtime: typeof proto2;
     static readonly typeName = "google.protobuf.FeatureSet";
@@ -1759,25 +1819,21 @@ export declare enum FeatureSet_RepeatedFieldEncoding {
     EXPANDED = 2
 }
 /**
- * @generated from enum google.protobuf.FeatureSet.StringFieldValidation
+ * @generated from enum google.protobuf.FeatureSet.Utf8Validation
  */
-export declare enum FeatureSet_StringFieldValidation {
-    /**
-     * @generated from enum value: STRING_FIELD_VALIDATION_UNKNOWN = 0;
-     */
-    STRING_FIELD_VALIDATION_UNKNOWN = 0,
+export declare enum FeatureSet_Utf8Validation {
     /**
-     * @generated from enum value: MANDATORY = 1;
+     * @generated from enum value: UTF8_VALIDATION_UNKNOWN = 0;
      */
-    MANDATORY = 1,
+    UTF8_VALIDATION_UNKNOWN = 0,
     /**
-     * @generated from enum value: HINT = 2;
+     * @generated from enum value: NONE = 1;
      */
-    HINT = 2,
+    NONE = 1,
     /**
-     * @generated from enum value: NONE = 3;
+     * @generated from enum value: VERIFY = 2;
      */
-    NONE = 3
+    VERIFY = 2
 }
 /**
  * @generated from enum google.protobuf.FeatureSet.MessageEncoding
@@ -1813,6 +1869,68 @@ export declare enum FeatureSet_JsonFormat {
      */
     LEGACY_BEST_EFFORT = 2
 }
+/**
+ * A compiled specification for the defaults of a set of features.  These
+ * messages are generated from FeatureSet extensions and can be used to seed
+ * feature resolution. The resolution with this object becomes a simple search
+ * for the closest matching edition, followed by proto merges.
+ *
+ * @generated from message google.protobuf.FeatureSetDefaults
+ */
+export declare class FeatureSetDefaults extends Message<FeatureSetDefaults> {
+    /**
+     * @generated from field: repeated google.protobuf.FeatureSetDefaults.FeatureSetEditionDefault defaults = 1;
+     */
+    defaults: FeatureSetDefaults_FeatureSetEditionDefault[];
+    /**
+     * The minimum supported edition (inclusive) when this was constructed.
+     * Editions before this will not have defaults.
+     *
+     * @generated from field: optional google.protobuf.Edition minimum_edition = 4;
+     */
+    minimumEdition?: Edition;
+    /**
+     * The maximum known edition (inclusive) when this was constructed. Editions
+     * after this will not have reliable defaults.
+     *
+     * @generated from field: optional google.protobuf.Edition maximum_edition = 5;
+     */
+    maximumEdition?: Edition;
+    constructor(data?: PartialMessage<FeatureSetDefaults>);
+    static readonly runtime: typeof proto2;
+    static readonly typeName = "google.protobuf.FeatureSetDefaults";
+    static readonly fields: FieldList;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): FeatureSetDefaults;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): FeatureSetDefaults;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): FeatureSetDefaults;
+    static equals(a: FeatureSetDefaults | PlainMessage<FeatureSetDefaults> | undefined, b: FeatureSetDefaults | PlainMessage<FeatureSetDefaults> | undefined): boolean;
+}
+/**
+ * A map from every known edition with a unique set of defaults to its
+ * defaults. Not all editions may be contained here.  For a given edition,
+ * the defaults at the closest matching edition ordered at or before it should
+ * be used.  This field must be in strict ascending order by edition.
+ *
+ * @generated from message google.protobuf.FeatureSetDefaults.FeatureSetEditionDefault
+ */
+export declare class FeatureSetDefaults_FeatureSetEditionDefault extends Message<FeatureSetDefaults_FeatureSetEditionDefault> {
+    /**
+     * @generated from field: optional google.protobuf.Edition edition = 3;
+     */
+    edition?: Edition;
+    /**
+     * @generated from field: optional google.protobuf.FeatureSet features = 2;
+     */
+    features?: FeatureSet;
+    constructor(data?: PartialMessage<FeatureSetDefaults_FeatureSetEditionDefault>);
+    static readonly runtime: typeof proto2;
+    static readonly typeName = "google.protobuf.FeatureSetDefaults.FeatureSetEditionDefault";
+    static readonly fields: FieldList;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): FeatureSetDefaults_FeatureSetEditionDefault;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): FeatureSetDefaults_FeatureSetEditionDefault;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): FeatureSetDefaults_FeatureSetEditionDefault;
+    static equals(a: FeatureSetDefaults_FeatureSetEditionDefault | PlainMessage<FeatureSetDefaults_FeatureSetEditionDefault> | undefined, b: FeatureSetDefaults_FeatureSetEditionDefault | PlainMessage<FeatureSetDefaults_FeatureSetEditionDefault> | undefined): boolean;
+}
 /**
  * Encapsulates information about the original source file from which a
  * FileDescriptorProto was generated.