@bufbuild/protobuf 2.0.0 → 2.2.0

package/dist/esm/wkt/gen/google/protobuf/api_pb.d.ts

@@ -85,34 +85,79 @@ export type Api = Message<"google.protobuf.Api"> & {
     syntax: Syntax;
 };
 /**
- * JSON type for the message google.protobuf.Api.
+ * Api is a light-weight descriptor for an API Interface.
+ *
+ * Interfaces are also described as "protocol buffer services" in some contexts,
+ * such as by the "service" keyword in a .proto file, but they are different
+ * from API Services, which represent a concrete implementation of an interface
+ * as opposed to simply a description of methods and bindings. They are also
+ * sometimes simply referred to as "APIs" in other contexts, such as the name of
+ * this message itself. See https://cloud.google.com/apis/design/glossary for
+ * detailed terminology.
+ *
+ * @generated from message google.protobuf.Api
  */
 export type ApiJson = {
     /**
+     * The fully qualified name of this interface, including package name
+     * followed by the interface's simple name.
+     *
      * @generated from field: string name = 1;
      */
     name?: string;
     /**
+     * The methods of this interface, in unspecified order.
+     *
      * @generated from field: repeated google.protobuf.Method methods = 2;
      */
     methods?: MethodJson[];
     /**
+     * Any metadata attached to the interface.
+     *
      * @generated from field: repeated google.protobuf.Option options = 3;
      */
     options?: OptionJson[];
     /**
+     * A version string for this interface. If specified, must have the form
+     * `major-version.minor-version`, as in `1.10`. If the minor version is
+     * omitted, it defaults to zero. If the entire version field is empty, the
+     * major version is derived from the package name, as outlined below. If the
+     * field is not empty, the version in the package name will be verified to be
+     * consistent with what is provided here.
+     *
+     * The versioning schema uses [semantic
+     * versioning](http://semver.org) where the major version number
+     * indicates a breaking change and the minor version an additive,
+     * non-breaking change. Both version numbers are signals to users
+     * what to expect from different versions, and should be carefully
+     * chosen based on the product plan.
+     *
+     * The major version is also reflected in the package name of the
+     * interface, which must end in `v<major-version>`, as in
+     * `google.feature.v1`. For major versions 0 and 1, the suffix can
+     * be omitted. Zero major versions must only be used for
+     * experimental, non-GA interfaces.
+     *
+     *
      * @generated from field: string version = 4;
      */
     version?: string;
     /**
+     * Source context for the protocol buffer service represented by this
+     * message.
+     *
      * @generated from field: google.protobuf.SourceContext source_context = 5;
      */
     sourceContext?: SourceContextJson;
     /**
+     * Included interfaces. See [Mixin][].
+     *
      * @generated from field: repeated google.protobuf.Mixin mixins = 6;
      */
     mixins?: MixinJson[];
     /**
+     * The source syntax of the service.
+     *
      * @generated from field: google.protobuf.Syntax syntax = 7;
      */
     syntax?: SyntaxJson;
@@ -172,34 +217,50 @@ export type Method = Message<"google.protobuf.Method"> & {
     syntax: Syntax;
 };
 /**
- * JSON type for the message google.protobuf.Method.
+ * Method represents a method of an API interface.
+ *
+ * @generated from message google.protobuf.Method
  */
 export type MethodJson = {
     /**
+     * The simple name of this method.
+     *
      * @generated from field: string name = 1;
      */
     name?: string;
     /**
+     * A URL of the input message type.
+     *
      * @generated from field: string request_type_url = 2;
      */
     requestTypeUrl?: string;
     /**
+     * If true, the request is streamed.
+     *
      * @generated from field: bool request_streaming = 3;
      */
     requestStreaming?: boolean;
     /**
+     * The URL of the output message type.
+     *
      * @generated from field: string response_type_url = 4;
      */
     responseTypeUrl?: string;
     /**
+     * If true, the response is streamed.
+     *
      * @generated from field: bool response_streaming = 5;
      */
     responseStreaming?: boolean;
     /**
+     * Any metadata attached to the method.
+     *
      * @generated from field: repeated google.protobuf.Option options = 6;
      */
     options?: OptionJson[];
     /**
+     * The source syntax of this method.
+     *
      * @generated from field: google.protobuf.Syntax syntax = 7;
      */
     syntax?: SyntaxJson;
@@ -307,14 +368,98 @@ export type Mixin = Message<"google.protobuf.Mixin"> & {
     root: string;
 };
 /**
- * JSON type for the message google.protobuf.Mixin.
+ * Declares an API Interface to be included in this interface. The including
+ * interface must redeclare all the methods from the included interface, but
+ * documentation and options are inherited as follows:
+ *
+ * - If after comment and whitespace stripping, the documentation
+ *   string of the redeclared method is empty, it will be inherited
+ *   from the original method.
+ *
+ * - Each annotation belonging to the service config (http,
+ *   visibility) which is not set in the redeclared method will be
+ *   inherited.
+ *
+ * - If an http annotation is inherited, the path pattern will be
+ *   modified as follows. Any version prefix will be replaced by the
+ *   version of the including interface plus the [root][] path if
+ *   specified.
+ *
+ * Example of a simple mixin:
+ *
+ *     package google.acl.v1;
+ *     service AccessControl {
+ *       // Get the underlying ACL object.
+ *       rpc GetAcl(GetAclRequest) returns (Acl) {
+ *         option (google.api.http).get = "/v1/{resource=**}:getAcl";
+ *       }
+ *     }
+ *
+ *     package google.storage.v2;
+ *     service Storage {
+ *       rpc GetAcl(GetAclRequest) returns (Acl);
+ *
+ *       // Get a data record.
+ *       rpc GetData(GetDataRequest) returns (Data) {
+ *         option (google.api.http).get = "/v2/{resource=**}";
+ *       }
+ *     }
+ *
+ * Example of a mixin configuration:
+ *
+ *     apis:
+ *     - name: google.storage.v2.Storage
+ *       mixins:
+ *       - name: google.acl.v1.AccessControl
+ *
+ * The mixin construct implies that all methods in `AccessControl` are
+ * also declared with same name and request/response types in
+ * `Storage`. A documentation generator or annotation processor will
+ * see the effective `Storage.GetAcl` method after inherting
+ * documentation and annotations as follows:
+ *
+ *     service Storage {
+ *       // Get the underlying ACL object.
+ *       rpc GetAcl(GetAclRequest) returns (Acl) {
+ *         option (google.api.http).get = "/v2/{resource=**}:getAcl";
+ *       }
+ *       ...
+ *     }
+ *
+ * Note how the version in the path pattern changed from `v1` to `v2`.
+ *
+ * If the `root` field in the mixin is specified, it should be a
+ * relative path under which inherited HTTP paths are placed. Example:
+ *
+ *     apis:
+ *     - name: google.storage.v2.Storage
+ *       mixins:
+ *       - name: google.acl.v1.AccessControl
+ *         root: acls
+ *
+ * This implies the following inherited HTTP annotation:
+ *
+ *     service Storage {
+ *       // Get the underlying ACL object.
+ *       rpc GetAcl(GetAclRequest) returns (Acl) {
+ *         option (google.api.http).get = "/v2/acls/{resource=**}:getAcl";
+ *       }
+ *       ...
+ *     }
+ *
+ * @generated from message google.protobuf.Mixin
  */
 export type MixinJson = {
     /**
+     * The fully qualified name of the interface which is included.
+     *
      * @generated from field: string name = 1;
      */
     name?: string;
     /**
+     * If non-empty specifies a path under which inherited HTTP paths
+     * are rooted.
+     *
      * @generated from field: string root = 2;
      */
     root?: string;

package/dist/esm/wkt/gen/google/protobuf/compiler/plugin_pb.d.ts

@@ -32,7 +32,9 @@ export type Version = Message<"google.protobuf.compiler.Version"> & {
     suffix: string;
 };
 /**
- * JSON type for the message google.protobuf.compiler.Version.
+ * The version number of protocol compiler.
+ *
+ * @generated from message google.protobuf.compiler.Version
  */
 export type VersionJson = {
     /**
@@ -48,6 +50,9 @@ export type VersionJson = {
      */
     patch?: number;
     /**
+     * A suffix for alpha, beta or rc release, e.g., "alpha-1", "rc2". It should
+     * be empty for mainline stable releases.
+     *
      * @generated from field: optional string suffix = 4;
      */
     suffix?: string;
@@ -117,26 +122,60 @@ export type CodeGeneratorRequest = Message<"google.protobuf.compiler.CodeGenerat
     compilerVersion?: Version;
 };
 /**
- * JSON type for the message google.protobuf.compiler.CodeGeneratorRequest.
+ * An encoded CodeGeneratorRequest is written to the plugin's stdin.
+ *
+ * @generated from message google.protobuf.compiler.CodeGeneratorRequest
  */
 export type CodeGeneratorRequestJson = {
     /**
+     * The .proto files that were explicitly listed on the command-line.  The
+     * code generator should generate code only for these files.  Each file's
+     * descriptor will be included in proto_file, below.
+     *
      * @generated from field: repeated string file_to_generate = 1;
      */
     fileToGenerate?: string[];
     /**
+     * The generator parameter passed on the command-line.
+     *
      * @generated from field: optional string parameter = 2;
      */
     parameter?: string;
     /**
+     * FileDescriptorProtos for all files in files_to_generate and everything
+     * they import.  The files will appear in topological order, so each file
+     * appears before any file that imports it.
+     *
+     * Note: the files listed in files_to_generate will include runtime-retention
+     * options only, but all other files will include source-retention options.
+     * The source_file_descriptors field below is available in case you need
+     * source-retention options for files_to_generate.
+     *
+     * protoc guarantees that all proto_files will be written after
+     * the fields above, even though this is not technically guaranteed by the
+     * protobuf wire format.  This theoretically could allow a plugin to stream
+     * in the FileDescriptorProtos and handle them one by one rather than read
+     * the entire set into memory at once.  However, as of this writing, this
+     * is not similarly optimized on protoc's end -- it will store all fields in
+     * memory at once before sending them to the plugin.
+     *
+     * Type names of fields and extensions in the FileDescriptorProto are always
+     * fully qualified.
+     *
      * @generated from field: repeated google.protobuf.FileDescriptorProto proto_file = 15;
      */
     protoFile?: FileDescriptorProtoJson[];
     /**
+     * File descriptors with all options, including source-retention options.
+     * These descriptors are only provided for the files listed in
+     * files_to_generate.
+     *
      * @generated from field: repeated google.protobuf.FileDescriptorProto source_file_descriptors = 17;
      */
     sourceFileDescriptors?: FileDescriptorProtoJson[];
     /**
+     * The version number of protocol compiler.
+     *
      * @generated from field: optional google.protobuf.compiler.Version compiler_version = 3;
      */
     compilerVersion?: VersionJson;
@@ -196,22 +235,46 @@ export type CodeGeneratorResponse = Message<"google.protobuf.compiler.CodeGenera
     file: CodeGeneratorResponse_File[];
 };
 /**
- * JSON type for the message google.protobuf.compiler.CodeGeneratorResponse.
+ * The plugin writes an encoded CodeGeneratorResponse to stdout.
+ *
+ * @generated from message google.protobuf.compiler.CodeGeneratorResponse
  */
 export type CodeGeneratorResponseJson = {
     /**
+     * Error message.  If non-empty, code generation failed.  The plugin process
+     * should exit with status code zero even if it reports an error in this way.
+     *
+     * This should be used to indicate errors in .proto files which prevent the
+     * code generator from generating correct code.  Errors which indicate a
+     * problem in protoc itself -- such as the input CodeGeneratorRequest being
+     * unparseable -- should be reported by writing a message to stderr and
+     * exiting with a non-zero status code.
+     *
      * @generated from field: optional string error = 1;
      */
     error?: string;
     /**
+     * A bitmask of supported features that the code generator supports.
+     * This is a bitwise "or" of values from the Feature enum.
+     *
      * @generated from field: optional uint64 supported_features = 2;
      */
     supportedFeatures?: string;
     /**
+     * The minimum edition this plugin supports.  This will be treated as an
+     * Edition enum, but we want to allow unknown values.  It should be specified
+     * according the edition enum value, *not* the edition number.  Only takes
+     * effect for plugins that have FEATURE_SUPPORTS_EDITIONS set.
+     *
      * @generated from field: optional int32 minimum_edition = 3;
      */
     minimumEdition?: number;
     /**
+     * The maximum edition this plugin supports.  This will be treated as an
+     * Edition enum, but we want to allow unknown values.  It should be specified
+     * according the edition enum value, *not* the edition number.  Only takes
+     * effect for plugins that have FEATURE_SUPPORTS_EDITIONS set.
+     *
      * @generated from field: optional int32 maximum_edition = 4;
      */
     maximumEdition?: number;
@@ -305,22 +368,80 @@ export type CodeGeneratorResponse_File = Message<"google.protobuf.compiler.CodeG
     generatedCodeInfo?: GeneratedCodeInfo;
 };
 /**
- * JSON type for the message google.protobuf.compiler.CodeGeneratorResponse.File.
+ * Represents a single generated file.
+ *
+ * @generated from message google.protobuf.compiler.CodeGeneratorResponse.File
  */
 export type CodeGeneratorResponse_FileJson = {
     /**
+     * The file name, relative to the output directory.  The name must not
+     * contain "." or ".." components and must be relative, not be absolute (so,
+     * the file cannot lie outside the output directory).  "/" must be used as
+     * the path separator, not "\".
+     *
+     * If the name is omitted, the content will be appended to the previous
+     * file.  This allows the generator to break large files into small chunks,
+     * and allows the generated text to be streamed back to protoc so that large
+     * files need not reside completely in memory at one time.  Note that as of
+     * this writing protoc does not optimize for this -- it will read the entire
+     * CodeGeneratorResponse before writing files to disk.
+     *
      * @generated from field: optional string name = 1;
      */
     name?: string;
     /**
+     * If non-empty, indicates that the named file should already exist, and the
+     * content here is to be inserted into that file at a defined insertion
+     * point.  This feature allows a code generator to extend the output
+     * produced by another code generator.  The original generator may provide
+     * insertion points by placing special annotations in the file that look
+     * like:
+     *   @@protoc_insertion_point(NAME)
+     * The annotation can have arbitrary text before and after it on the line,
+     * which allows it to be placed in a comment.  NAME should be replaced with
+     * an identifier naming the point -- this is what other generators will use
+     * as the insertion_point.  Code inserted at this point will be placed
+     * immediately above the line containing the insertion point (thus multiple
+     * insertions to the same point will come out in the order they were added).
+     * The double-@ is intended to make it unlikely that the generated code
+     * could contain things that look like insertion points by accident.
+     *
+     * For example, the C++ code generator places the following line in the
+     * .pb.h files that it generates:
+     *   // @@protoc_insertion_point(namespace_scope)
+     * This line appears within the scope of the file's package namespace, but
+     * outside of any particular class.  Another plugin can then specify the
+     * insertion_point "namespace_scope" to generate additional classes or
+     * other declarations that should be placed in this scope.
+     *
+     * Note that if the line containing the insertion point begins with
+     * whitespace, the same whitespace will be added to every line of the
+     * inserted text.  This is useful for languages like Python, where
+     * indentation matters.  In these languages, the insertion point comment
+     * should be indented the same amount as any inserted code will need to be
+     * in order to work correctly in that context.
+     *
+     * The code generator that generates the initial file and the one which
+     * inserts into it must both run as part of a single invocation of protoc.
+     * Code generators are executed in the order in which they appear on the
+     * command line.
+     *
+     * If |insertion_point| is present, |name| must also be present.
+     *
      * @generated from field: optional string insertion_point = 2;
      */
     insertionPoint?: string;
     /**
+     * The file contents.
+     *
      * @generated from field: optional string content = 15;
      */
     content?: string;
     /**
+     * Information describing the file content being inserted. If an insertion
+     * point is used, this information will be appropriately offset and inserted
+     * into the code generation metadata for the generated files.
+     *
      * @generated from field: optional google.protobuf.GeneratedCodeInfo generated_code_info = 16;
      */
     generatedCodeInfo?: GeneratedCodeInfoJson;
@@ -350,7 +471,9 @@ export declare enum CodeGeneratorResponse_Feature {
     SUPPORTS_EDITIONS = 2
 }
 /**
- * JSON type for the enum google.protobuf.compiler.CodeGeneratorResponse.Feature.
+ * Sync with code_generator.h.
+ *
+ * @generated from enum google.protobuf.compiler.CodeGeneratorResponse.Feature
  */
 export type CodeGeneratorResponse_FeatureJson = "FEATURE_NONE" | "FEATURE_PROTO3_OPTIONAL" | "FEATURE_SUPPORTS_EDITIONS";
 /**