carbon-js-sdk 0.7.13 → 0.7.16

package/lib/codec/google/protobuf/descriptor.d.ts

@@ -1,6 +1,37 @@
 import Long from "long";
 import _m0 from "protobufjs/minimal";
 export declare const protobufPackage = "google.protobuf";
+/** The full set of known editions. */
+export declare enum Edition {
+    /** EDITION_UNKNOWN - A placeholder for an unknown edition value. */
+    EDITION_UNKNOWN = 0,
+    /**
+     * EDITION_PROTO2 - 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.
+     */
+    EDITION_PROTO2 = 998,
+    EDITION_PROTO3 = 999,
+    /**
+     * EDITION_2023 - 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.
+     */
+    EDITION_2023 = 1000,
+    /**
+     * EDITION_1_TEST_ONLY - Placeholder editions for testing feature resolution.  These should not be
+     * used or relyed on outside of tests.
+     */
+    EDITION_1_TEST_ONLY = 1,
+    EDITION_2_TEST_ONLY = 2,
+    EDITION_99997_TEST_ONLY = 99997,
+    EDITION_99998_TEST_ONLY = 99998,
+    EDITION_99999_TEST_ONLY = 99999,
+    UNRECOGNIZED = -1
+}
+export declare function editionFromJSON(object: any): Edition;
+export declare function editionToJSON(object: Edition): string;
 /**
  * The protocol compiler can output a FileDescriptorSet containing the .proto
  * files it parses.
@@ -43,8 +74,8 @@ export interface FileDescriptorProto {
      * If `edition` is present, this value must be "editions".
      */
     syntax: string;
-    /** The edition of the proto file, which is an opaque string. */
-    edition: string;
+    /** The edition of the proto file. */
+    edition: Edition;
 }
 /** Describes a message type. */
 export interface DescriptorProto {
@@ -84,6 +115,55 @@ export interface DescriptorProto_ReservedRange {
 export interface ExtensionRangeOptions {
     /** The parser stores options it doesn't recognize here. See above. */
     uninterpretedOption: UninterpretedOption[];
+    /**
+     * For external users: DO NOT USE. We are in the process of open sourcing
+     * extension declaration and executing internal cleanups before it can be
+     * used externally.
+     */
+    declaration: ExtensionRangeOptions_Declaration[];
+    /** Any features defined in the specific edition. */
+    features?: FeatureSet;
+    /**
+     * The verification state of the range.
+     * TODO: flip the default to DECLARATION once all empty ranges
+     * are marked as UNVERIFIED.
+     */
+    verification: ExtensionRangeOptions_VerificationState;
+}
+/** The verification state of the extension range. */
+export declare enum ExtensionRangeOptions_VerificationState {
+    /** DECLARATION - All the extensions of the range must be declared. */
+    DECLARATION = 0,
+    UNVERIFIED = 1,
+    UNRECOGNIZED = -1
+}
+export declare function extensionRangeOptions_VerificationStateFromJSON(object: any): ExtensionRangeOptions_VerificationState;
+export declare function extensionRangeOptions_VerificationStateToJSON(object: ExtensionRangeOptions_VerificationState): string;
+export interface ExtensionRangeOptions_Declaration {
+    /** The extension number declared within the extension range. */
+    number: number;
+    /**
+     * The fully-qualified name of the extension field. There must be a leading
+     * dot in front of the full name.
+     */
+    fullName: string;
+    /**
+     * The fully-qualified type name of the extension field. Unlike
+     * Metadata.type, Declaration.type must have a leading dot for messages
+     * and enums.
+     */
+    type: string;
+    /**
+     * If true, indicates that the number is reserved in the extension range,
+     * and any extension field with the number will fail to compile. Set this
+     * when a declared extension field is deleted.
+     */
+    reserved: boolean;
+    /**
+     * If true, indicates that the extension must be defined as repeated.
+     * Otherwise the extension must be defined as optional.
+     */
+    repeated: boolean;
 }
 /** Describes a field within a message. */
 export interface FieldDescriptorProto {
@@ -177,9 +257,10 @@ export declare enum FieldDescriptorProto_Type {
     TYPE_STRING = 9,
     /**
      * TYPE_GROUP - 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.
      */
     TYPE_GROUP = 10,
     /** TYPE_MESSAGE - Length-delimited aggregate. */
@@ -201,8 +282,13 @@ export declare function fieldDescriptorProto_TypeToJSON(object: FieldDescriptorP
 export declare enum FieldDescriptorProto_Label {
     /** LABEL_OPTIONAL - 0 is reserved for errors */
     LABEL_OPTIONAL = 1,
-    LABEL_REQUIRED = 2,
     LABEL_REPEATED = 3,
+    /**
+     * LABEL_REQUIRED - 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.
+     */
+    LABEL_REQUIRED = 2,
     UNRECOGNIZED = -1
 }
 export declare function fieldDescriptorProto_LabelFromJSON(object: any): FieldDescriptorProto_Label;
@@ -384,6 +470,8 @@ export interface FileOptions {
      * determining the ruby package.
      */
     rubyPackage: string;
+    /** Any features defined in the specific edition. */
+    features?: FeatureSet;
     /**
      * The parser stores options it doesn't recognize here.
      * See the documentation for the "Options" section above.
@@ -470,12 +558,14 @@ export interface 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.
      *
      * @deprecated
      */
     deprecatedLegacyJsonFieldConflicts: boolean;
+    /** Any features defined in the specific edition. */
+    features?: FeatureSet;
     /** The parser stores options it doesn't recognize here. See above. */
     uninterpretedOption: UninterpretedOption[];
 }
@@ -483,8 +573,10 @@ export interface FieldOptions {
     /**
      * The ctype option instructs the C++ code generator to use a different
      * representation of the field than it normally would.  See the specific
-     * options below.  This option is not yet implemented in the open source
-     * release -- sorry, we'll try to include it in a future version!
+     * options below.  This option is only implemented to support use of
+     * [ctype=CORD] and [ctype=STRING] (the default) on non-repeated fields of
+     * type "bytes" in the open source release -- sorry, we'll try to include
+     * other types in a future version!
      */
     ctype: FieldOptions_CType;
     /**
@@ -492,7 +584,9 @@ export interface 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.
      */
     packed: boolean;
     /**
@@ -563,13 +657,24 @@ export interface FieldOptions {
      */
     debugRedact: boolean;
     retention: FieldOptions_OptionRetention;
-    target: FieldOptions_OptionTargetType;
+    targets: FieldOptions_OptionTargetType[];
+    editionDefaults: FieldOptions_EditionDefault[];
+    /** Any features defined in the specific edition. */
+    features?: FeatureSet;
     /** The parser stores options it doesn't recognize here. See above. */
     uninterpretedOption: UninterpretedOption[];
 }
 export declare enum FieldOptions_CType {
     /** STRING - Default mode. */
     STRING = 0,
+    /**
+     * CORD - The option [ctype=CORD] may be applied to a non-repeated field of type
+     * "bytes". It indicates that in C++, the data should be stored in a Cord
+     * instead of a string.  For very large strings, this may reduce memory
+     * fragmentation. It may also allow better performance when parsing from a
+     * Cord, or when parsing with aliasing enabled, as the parsed Cord may then
+     * alias the original buffer.
+     */
     CORD = 1,
     STRING_PIECE = 2,
     UNRECOGNIZED = -1
@@ -621,7 +726,14 @@ export declare enum FieldOptions_OptionTargetType {
 }
 export declare function fieldOptions_OptionTargetTypeFromJSON(object: any): FieldOptions_OptionTargetType;
 export declare function fieldOptions_OptionTargetTypeToJSON(object: FieldOptions_OptionTargetType): string;
+export interface FieldOptions_EditionDefault {
+    edition: Edition;
+    /** Textproto value. */
+    value: string;
+}
 export interface OneofOptions {
+    /** Any features defined in the specific edition. */
+    features?: FeatureSet;
     /** The parser stores options it doesn't recognize here. See above. */
     uninterpretedOption: UninterpretedOption[];
 }
@@ -643,12 +755,14 @@ export interface 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.
      *
      * @deprecated
      */
     deprecatedLegacyJsonFieldConflicts: boolean;
+    /** Any features defined in the specific edition. */
+    features?: FeatureSet;
     /** The parser stores options it doesn't recognize here. See above. */
     uninterpretedOption: UninterpretedOption[];
 }
@@ -660,10 +774,20 @@ export interface EnumValueOptions {
      * this is a formalization for deprecating enum values.
      */
     deprecated: boolean;
+    /** Any features defined in the specific edition. */
+    features?: FeatureSet;
+    /**
+     * Indicate that fields annotated with this enum value should not be printed
+     * out when using debug formats, e.g. when the field contains sensitive
+     * credentials.
+     */
+    debugRedact: boolean;
     /** The parser stores options it doesn't recognize here. See above. */
     uninterpretedOption: UninterpretedOption[];
 }
 export interface ServiceOptions {
+    /** Any features defined in the specific edition. */
+    features?: FeatureSet;
     /**
      * Is this service deprecated?
      * Depending on the target platform, this can emit Deprecated annotations
@@ -683,6 +807,8 @@ export interface MethodOptions {
      */
     deprecated: boolean;
     idempotencyLevel: MethodOptions_IdempotencyLevel;
+    /** Any features defined in the specific edition. */
+    features?: FeatureSet;
     /** The parser stores options it doesn't recognize here. See above. */
     uninterpretedOption: UninterpretedOption[];
 }
@@ -733,6 +859,100 @@ export interface UninterpretedOption_NamePart {
     namePart: string;
     isExtension: boolean;
 }
+/**
+ * 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
+ * be designed and implemented to handle this, hopefully before we ever hit a
+ * conflict here.
+ */
+export interface FeatureSet {
+    fieldPresence: FeatureSet_FieldPresence;
+    enumType: FeatureSet_EnumType;
+    repeatedFieldEncoding: FeatureSet_RepeatedFieldEncoding;
+    utf8Validation: FeatureSet_Utf8Validation;
+    messageEncoding: FeatureSet_MessageEncoding;
+    jsonFormat: FeatureSet_JsonFormat;
+}
+export declare enum FeatureSet_FieldPresence {
+    FIELD_PRESENCE_UNKNOWN = 0,
+    EXPLICIT = 1,
+    IMPLICIT = 2,
+    LEGACY_REQUIRED = 3,
+    UNRECOGNIZED = -1
+}
+export declare function featureSet_FieldPresenceFromJSON(object: any): FeatureSet_FieldPresence;
+export declare function featureSet_FieldPresenceToJSON(object: FeatureSet_FieldPresence): string;
+export declare enum FeatureSet_EnumType {
+    ENUM_TYPE_UNKNOWN = 0,
+    OPEN = 1,
+    CLOSED = 2,
+    UNRECOGNIZED = -1
+}
+export declare function featureSet_EnumTypeFromJSON(object: any): FeatureSet_EnumType;
+export declare function featureSet_EnumTypeToJSON(object: FeatureSet_EnumType): string;
+export declare enum FeatureSet_RepeatedFieldEncoding {
+    REPEATED_FIELD_ENCODING_UNKNOWN = 0,
+    PACKED = 1,
+    EXPANDED = 2,
+    UNRECOGNIZED = -1
+}
+export declare function featureSet_RepeatedFieldEncodingFromJSON(object: any): FeatureSet_RepeatedFieldEncoding;
+export declare function featureSet_RepeatedFieldEncodingToJSON(object: FeatureSet_RepeatedFieldEncoding): string;
+export declare enum FeatureSet_Utf8Validation {
+    UTF8_VALIDATION_UNKNOWN = 0,
+    NONE = 1,
+    VERIFY = 2,
+    UNRECOGNIZED = -1
+}
+export declare function featureSet_Utf8ValidationFromJSON(object: any): FeatureSet_Utf8Validation;
+export declare function featureSet_Utf8ValidationToJSON(object: FeatureSet_Utf8Validation): string;
+export declare enum FeatureSet_MessageEncoding {
+    MESSAGE_ENCODING_UNKNOWN = 0,
+    LENGTH_PREFIXED = 1,
+    DELIMITED = 2,
+    UNRECOGNIZED = -1
+}
+export declare function featureSet_MessageEncodingFromJSON(object: any): FeatureSet_MessageEncoding;
+export declare function featureSet_MessageEncodingToJSON(object: FeatureSet_MessageEncoding): string;
+export declare enum FeatureSet_JsonFormat {
+    JSON_FORMAT_UNKNOWN = 0,
+    ALLOW = 1,
+    LEGACY_BEST_EFFORT = 2,
+    UNRECOGNIZED = -1
+}
+export declare function featureSet_JsonFormatFromJSON(object: any): FeatureSet_JsonFormat;
+export declare function featureSet_JsonFormatToJSON(object: FeatureSet_JsonFormat): string;
+/**
+ * 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.
+ */
+export interface FeatureSetDefaults {
+    defaults: FeatureSetDefaults_FeatureSetEditionDefault[];
+    /**
+     * The minimum supported edition (inclusive) when this was constructed.
+     * Editions before this will not have defaults.
+     */
+    minimumEdition: Edition;
+    /**
+     * The maximum known edition (inclusive) when this was constructed. Editions
+     * after this will not have reliable defaults.
+     */
+    maximumEdition: Edition;
+}
+/**
+ * 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.
+ */
+export interface FeatureSetDefaults_FeatureSetEditionDefault {
+    edition: Edition;
+    features?: FeatureSet;
+}
 /**
  * Encapsulates information about the original source file from which a
  * FileDescriptorProto was generated.
@@ -963,6 +1183,13 @@ export declare const ExtensionRangeOptions: {
     toJSON(message: ExtensionRangeOptions): unknown;
     fromPartial(object: DeepPartial<ExtensionRangeOptions>): ExtensionRangeOptions;
 };
+export declare const ExtensionRangeOptions_Declaration: {
+    encode(message: ExtensionRangeOptions_Declaration, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number | undefined): ExtensionRangeOptions_Declaration;
+    fromJSON(object: any): ExtensionRangeOptions_Declaration;
+    toJSON(message: ExtensionRangeOptions_Declaration): unknown;
+    fromPartial(object: DeepPartial<ExtensionRangeOptions_Declaration>): ExtensionRangeOptions_Declaration;
+};
 export declare const FieldDescriptorProto: {
     encode(message: FieldDescriptorProto, writer?: _m0.Writer): _m0.Writer;
     decode(input: _m0.Reader | Uint8Array, length?: number | undefined): FieldDescriptorProto;
@@ -1033,6 +1260,13 @@ export declare const FieldOptions: {
     toJSON(message: FieldOptions): unknown;
     fromPartial(object: DeepPartial<FieldOptions>): FieldOptions;
 };
+export declare const FieldOptions_EditionDefault: {
+    encode(message: FieldOptions_EditionDefault, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number | undefined): FieldOptions_EditionDefault;
+    fromJSON(object: any): FieldOptions_EditionDefault;
+    toJSON(message: FieldOptions_EditionDefault): unknown;
+    fromPartial(object: DeepPartial<FieldOptions_EditionDefault>): FieldOptions_EditionDefault;
+};
 export declare const OneofOptions: {
     encode(message: OneofOptions, writer?: _m0.Writer): _m0.Writer;
     decode(input: _m0.Reader | Uint8Array, length?: number | undefined): OneofOptions;
@@ -1082,6 +1316,27 @@ export declare const UninterpretedOption_NamePart: {
     toJSON(message: UninterpretedOption_NamePart): unknown;
     fromPartial(object: DeepPartial<UninterpretedOption_NamePart>): UninterpretedOption_NamePart;
 };
+export declare const FeatureSet: {
+    encode(message: FeatureSet, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number | undefined): FeatureSet;
+    fromJSON(object: any): FeatureSet;
+    toJSON(message: FeatureSet): unknown;
+    fromPartial(object: DeepPartial<FeatureSet>): FeatureSet;
+};
+export declare const FeatureSetDefaults: {
+    encode(message: FeatureSetDefaults, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number | undefined): FeatureSetDefaults;
+    fromJSON(object: any): FeatureSetDefaults;
+    toJSON(message: FeatureSetDefaults): unknown;
+    fromPartial(object: DeepPartial<FeatureSetDefaults>): FeatureSetDefaults;
+};
+export declare const FeatureSetDefaults_FeatureSetEditionDefault: {
+    encode(message: FeatureSetDefaults_FeatureSetEditionDefault, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number | undefined): FeatureSetDefaults_FeatureSetEditionDefault;
+    fromJSON(object: any): FeatureSetDefaults_FeatureSetEditionDefault;
+    toJSON(message: FeatureSetDefaults_FeatureSetEditionDefault): unknown;
+    fromPartial(object: DeepPartial<FeatureSetDefaults_FeatureSetEditionDefault>): FeatureSetDefaults_FeatureSetEditionDefault;
+};
 export declare const SourceCodeInfo: {
     encode(message: SourceCodeInfo, writer?: _m0.Writer): _m0.Writer;
     decode(input: _m0.Reader | Uint8Array, length?: number | undefined): SourceCodeInfo;