@bufbuild/protobuf 2.0.0-beta.3 → 2.1.0

package/dist/cjs/wkt/gen/google/protobuf/type_pb.d.ts

@@ -56,34 +56,50 @@ export type Type = Message<"google.protobuf.Type"> & {
     edition: string;
 };
 /**
- * JSON type for the message google.protobuf.Type.
+ * A protocol buffer message type.
+ *
+ * @generated from message google.protobuf.Type
  */
 export type TypeJson = {
     /**
+     * The fully qualified message name.
+     *
      * @generated from field: string name = 1;
      */
     name?: string;
     /**
+     * The list of fields.
+     *
      * @generated from field: repeated google.protobuf.Field fields = 2;
      */
     fields?: FieldJson[];
     /**
+     * The list of types appearing in `oneof` definitions in this type.
+     *
      * @generated from field: repeated string oneofs = 3;
      */
     oneofs?: string[];
     /**
+     * The protocol buffer options.
+     *
      * @generated from field: repeated google.protobuf.Option options = 4;
      */
     options?: OptionJson[];
     /**
+     * The source context.
+     *
      * @generated from field: google.protobuf.SourceContext source_context = 5;
      */
     sourceContext?: SourceContextJson;
     /**
+     * The source syntax.
+     *
      * @generated from field: google.protobuf.Syntax syntax = 6;
      */
     syntax?: SyntaxJson;
     /**
+     * The source edition string, only valid when syntax is SYNTAX_EDITIONS.
+     *
      * @generated from field: string edition = 7;
      */
     edition?: string;
@@ -163,46 +179,70 @@ export type Field = Message<"google.protobuf.Field"> & {
     defaultValue: string;
 };
 /**
- * JSON type for the message google.protobuf.Field.
+ * A single field of a message type.
+ *
+ * @generated from message google.protobuf.Field
  */
 export type FieldJson = {
     /**
+     * The field type.
+     *
      * @generated from field: google.protobuf.Field.Kind kind = 1;
      */
     kind?: Field_KindJson;
     /**
+     * The field cardinality.
+     *
      * @generated from field: google.protobuf.Field.Cardinality cardinality = 2;
      */
     cardinality?: Field_CardinalityJson;
     /**
+     * The field number.
+     *
      * @generated from field: int32 number = 3;
      */
     number?: number;
     /**
+     * The field name.
+     *
      * @generated from field: string name = 4;
      */
     name?: string;
     /**
+     * The field type URL, without the scheme, for message or enumeration
+     * types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
+     *
      * @generated from field: string type_url = 6;
      */
     typeUrl?: string;
     /**
+     * The index of the field type in `Type.oneofs`, for message or enumeration
+     * types. The first type has index 1; zero means the type is not in the list.
+     *
      * @generated from field: int32 oneof_index = 7;
      */
     oneofIndex?: number;
     /**
+     * Whether to use alternative packed wire representation.
+     *
      * @generated from field: bool packed = 8;
      */
     packed?: boolean;
     /**
+     * The protocol buffer options.
+     *
      * @generated from field: repeated google.protobuf.Option options = 9;
      */
     options?: OptionJson[];
     /**
+     * The field JSON name.
+     *
      * @generated from field: string json_name = 10;
      */
     jsonName?: string;
     /**
+     * The string value of the default value of this field. Proto2 syntax only.
+     *
      * @generated from field: string default_value = 11;
      */
     defaultValue?: string;
@@ -334,7 +374,9 @@ export declare enum Field_Kind {
     TYPE_SINT64 = 18
 }
 /**
- * JSON type for the enum google.protobuf.Field.Kind.
+ * Basic field types.
+ *
+ * @generated from enum google.protobuf.Field.Kind
  */
 export type Field_KindJson = "TYPE_UNKNOWN" | "TYPE_DOUBLE" | "TYPE_FLOAT" | "TYPE_INT64" | "TYPE_UINT64" | "TYPE_INT32" | "TYPE_FIXED64" | "TYPE_FIXED32" | "TYPE_BOOL" | "TYPE_STRING" | "TYPE_GROUP" | "TYPE_MESSAGE" | "TYPE_BYTES" | "TYPE_UINT32" | "TYPE_ENUM" | "TYPE_SFIXED32" | "TYPE_SFIXED64" | "TYPE_SINT32" | "TYPE_SINT64";
 /**
@@ -373,7 +415,9 @@ export declare enum Field_Cardinality {
     REPEATED = 3
 }
 /**
- * JSON type for the enum google.protobuf.Field.Cardinality.
+ * Whether a field is optional, required, or repeated.
+ *
+ * @generated from enum google.protobuf.Field.Cardinality
  */
 export type Field_CardinalityJson = "CARDINALITY_UNKNOWN" | "CARDINALITY_OPTIONAL" | "CARDINALITY_REQUIRED" | "CARDINALITY_REPEATED";
 /**
@@ -424,30 +468,44 @@ export type Enum = Message<"google.protobuf.Enum"> & {
     edition: string;
 };
 /**
- * JSON type for the message google.protobuf.Enum.
+ * Enum type definition.
+ *
+ * @generated from message google.protobuf.Enum
  */
 export type EnumJson = {
     /**
+     * Enum type name.
+     *
      * @generated from field: string name = 1;
      */
     name?: string;
     /**
+     * Enum value definitions.
+     *
      * @generated from field: repeated google.protobuf.EnumValue enumvalue = 2;
      */
     enumvalue?: EnumValueJson[];
     /**
+     * Protocol buffer options.
+     *
      * @generated from field: repeated google.protobuf.Option options = 3;
      */
     options?: OptionJson[];
     /**
+     * The source context.
+     *
      * @generated from field: google.protobuf.SourceContext source_context = 4;
      */
     sourceContext?: SourceContextJson;
     /**
+     * The source syntax.
+     *
      * @generated from field: google.protobuf.Syntax syntax = 5;
      */
     syntax?: SyntaxJson;
     /**
+     * The source edition string, only valid when syntax is SYNTAX_EDITIONS.
+     *
      * @generated from field: string edition = 6;
      */
     edition?: string;
@@ -483,18 +541,26 @@ export type EnumValue = Message<"google.protobuf.EnumValue"> & {
     options: Option[];
 };
 /**
- * JSON type for the message google.protobuf.EnumValue.
+ * Enum value definition.
+ *
+ * @generated from message google.protobuf.EnumValue
  */
 export type EnumValueJson = {
     /**
+     * Enum value name.
+     *
      * @generated from field: string name = 1;
      */
     name?: string;
     /**
+     * Enum value number.
+     *
      * @generated from field: int32 number = 2;
      */
     number?: number;
     /**
+     * Protocol buffer options.
+     *
      * @generated from field: repeated google.protobuf.Option options = 3;
      */
     options?: OptionJson[];
@@ -531,14 +597,27 @@ export type Option = Message<"google.protobuf.Option"> & {
     value?: Any;
 };
 /**
- * JSON type for the message google.protobuf.Option.
+ * A protocol buffer option, which can be attached to a message, field,
+ * enumeration, etc.
+ *
+ * @generated from message google.protobuf.Option
  */
 export type OptionJson = {
     /**
+     * The option's name. For protobuf built-in options (options defined in
+     * descriptor.proto), this is the short name. For example, `"map_entry"`.
+     * For custom options, it should be the fully-qualified name. For example,
+     * `"google.api.http"`.
+     *
      * @generated from field: string name = 1;
      */
     name?: string;
     /**
+     * The option's value packed in an Any message. If the value is a primitive,
+     * the corresponding wrapper type defined in google/protobuf/wrappers.proto
+     * should be used. If the value is an enum, it should be stored as an int32
+     * value using the google.protobuf.Int32Value type.
+     *
      * @generated from field: google.protobuf.Any value = 2;
      */
     value?: AnyJson;
@@ -574,7 +653,9 @@ export declare enum Syntax {
     EDITIONS = 2
 }
 /**
- * JSON type for the enum google.protobuf.Syntax.
+ * The syntax in which a protocol buffer element is defined.
+ *
+ * @generated from enum google.protobuf.Syntax
  */
 export type SyntaxJson = "SYNTAX_PROTO2" | "SYNTAX_PROTO3" | "SYNTAX_EDITIONS";
 /**

package/dist/cjs/wkt/gen/google/protobuf/wrappers_pb.d.ts

@@ -20,7 +20,11 @@ export type DoubleValue = Message<"google.protobuf.DoubleValue"> & {
     value: number;
 };
 /**
- * JSON type for the message google.protobuf.DoubleValue.
+ * Wrapper message for `double`.
+ *
+ * The JSON representation for `DoubleValue` is JSON number.
+ *
+ * @generated from message google.protobuf.DoubleValue
  */
 export type DoubleValueJson = number | "NaN" | "Infinity" | "-Infinity";
 /**
@@ -44,7 +48,11 @@ export type FloatValue = Message<"google.protobuf.FloatValue"> & {
     value: number;
 };
 /**
- * JSON type for the message google.protobuf.FloatValue.
+ * Wrapper message for `float`.
+ *
+ * The JSON representation for `FloatValue` is JSON number.
+ *
+ * @generated from message google.protobuf.FloatValue
  */
 export type FloatValueJson = number | "NaN" | "Infinity" | "-Infinity";
 /**
@@ -68,7 +76,11 @@ export type Int64Value = Message<"google.protobuf.Int64Value"> & {
     value: bigint;
 };
 /**
- * JSON type for the message google.protobuf.Int64Value.
+ * Wrapper message for `int64`.
+ *
+ * The JSON representation for `Int64Value` is JSON string.
+ *
+ * @generated from message google.protobuf.Int64Value
  */
 export type Int64ValueJson = string;
 /**
@@ -92,7 +104,11 @@ export type UInt64Value = Message<"google.protobuf.UInt64Value"> & {
     value: bigint;
 };
 /**
- * JSON type for the message google.protobuf.UInt64Value.
+ * Wrapper message for `uint64`.
+ *
+ * The JSON representation for `UInt64Value` is JSON string.
+ *
+ * @generated from message google.protobuf.UInt64Value
  */
 export type UInt64ValueJson = string;
 /**
@@ -116,7 +132,11 @@ export type Int32Value = Message<"google.protobuf.Int32Value"> & {
     value: number;
 };
 /**
- * JSON type for the message google.protobuf.Int32Value.
+ * Wrapper message for `int32`.
+ *
+ * The JSON representation for `Int32Value` is JSON number.
+ *
+ * @generated from message google.protobuf.Int32Value
  */
 export type Int32ValueJson = number;
 /**
@@ -140,7 +160,11 @@ export type UInt32Value = Message<"google.protobuf.UInt32Value"> & {
     value: number;
 };
 /**
- * JSON type for the message google.protobuf.UInt32Value.
+ * Wrapper message for `uint32`.
+ *
+ * The JSON representation for `UInt32Value` is JSON number.
+ *
+ * @generated from message google.protobuf.UInt32Value
  */
 export type UInt32ValueJson = number;
 /**
@@ -164,7 +188,11 @@ export type BoolValue = Message<"google.protobuf.BoolValue"> & {
     value: boolean;
 };
 /**
- * JSON type for the message google.protobuf.BoolValue.
+ * Wrapper message for `bool`.
+ *
+ * The JSON representation for `BoolValue` is JSON `true` and `false`.
+ *
+ * @generated from message google.protobuf.BoolValue
  */
 export type BoolValueJson = boolean;
 /**
@@ -188,7 +216,11 @@ export type StringValue = Message<"google.protobuf.StringValue"> & {
     value: string;
 };
 /**
- * JSON type for the message google.protobuf.StringValue.
+ * Wrapper message for `string`.
+ *
+ * The JSON representation for `StringValue` is JSON string.
+ *
+ * @generated from message google.protobuf.StringValue
  */
 export type StringValueJson = string;
 /**
@@ -212,7 +244,11 @@ export type BytesValue = Message<"google.protobuf.BytesValue"> & {
     value: Uint8Array;
 };
 /**
- * JSON type for the message google.protobuf.BytesValue.
+ * Wrapper message for `bytes`.
+ *
+ * The JSON representation for `BytesValue` is JSON string.
+ *
+ * @generated from message google.protobuf.BytesValue
  */
 export type BytesValueJson = string;
 /**

package/dist/esm/registry.js

@@ -224,7 +224,7 @@ const DELIMITED = 2;
 const OPEN = 1;
 // prettier-ignore
 // bootstrap-inject defaults: EDITION_PROTO2 to EDITION_2023: export const minimumEdition: SupportedEdition = $minimumEdition, maximumEdition: SupportedEdition = $maximumEdition;
-// generated from protoc v27.0
+// generated from protoc v28.0
 export const minimumEdition = 998, maximumEdition = 1000;
 const featureDefaults = {
     // EDITION_PROTO2
@@ -608,12 +608,14 @@ function newField(proto, parentOrFile, reg, oneof, mapEntries) {
             case TYPE_GROUP:
                 field.listKind = "message";
                 field.message = reg.getMessage(trimLeadingDot(proto.typeName));
+                // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
                 assert(field.message);
                 field.delimitedEncoding = isDelimitedEncoding(proto, parentOrFile);
                 break;
             case TYPE_ENUM:
                 field.listKind = "enum";
                 field.enum = reg.getEnum(trimLeadingDot(proto.typeName));
+                // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
                 assert(field.enum);
                 break;
             default:
@@ -631,7 +633,9 @@ function newField(proto, parentOrFile, reg, oneof, mapEntries) {
         case TYPE_GROUP:
             field.fieldKind = "message";
             field.message = reg.getMessage(trimLeadingDot(proto.typeName));
-            assert(field.message, `invalid FieldDescriptorProto: type_name ${proto.typeName} not found`);
+            assert(
+            // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
+            field.message, `invalid FieldDescriptorProto: type_name ${proto.typeName} not found`);
             field.delimitedEncoding = isDelimitedEncoding(proto, parentOrFile);
             field.getDefaultValue = () => undefined;
             break;
@@ -768,7 +772,9 @@ function findOneof(proto, allOneofs) {
         return undefined;
     }
     const oneof = allOneofs[proto.oneofIndex];
-    assert(oneof, `invalid FieldDescriptorProto: oneof #${proto.oneofIndex} for field #${proto.number} not found`);
+    assert(
+    // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
+    oneof, `invalid FieldDescriptorProto: oneof #${proto.oneofIndex} for field #${proto.number} not found`);
     return oneof;
 }
 /**

package/dist/esm/types.d.ts

@@ -28,7 +28,7 @@ export type MessageJsonType<Desc extends DescMessage> = Desc extends GenMessage<
  * Extract the init type from a message descriptor.
  * The init type is accepted by the function create().
  */
-export type MessageInitShape<Desc extends DescMessage> = Desc extends GenMessage<infer RuntimeShape> ? RuntimeShape | MessageInit<RuntimeShape> : Record<string, unknown>;
+export type MessageInitShape<Desc extends DescMessage> = Desc extends GenMessage<infer RuntimeShape> ? MessageInit<RuntimeShape> : Record<string, unknown>;
 /**
  * Extract the enum type of from an enum descriptor.
  */
@@ -58,8 +58,8 @@ export type UnknownField = {
  * The init type for a message, which makes all fields optional.
  * The init type is accepted by the function create().
  */
-type MessageInit<T extends Message> = {
-    [P in keyof T as P extends "$typeName" | "$unknown" ? never : P]?: FieldInit<T[P]>;
+type MessageInit<T extends Message> = T | {
+    [P in keyof T as P extends "$unknown" ? never : P]?: P extends "$typeName" ? never : FieldInit<T[P]>;
 };
 type FieldInit<F> = F extends (Date | Uint8Array | bigint | boolean | string | number) ? F : F extends Array<infer U> ? Array<FieldInit<U>> : F extends ReadonlyArray<infer U> ? ReadonlyArray<FieldInit<U>> : F extends Message ? MessageInit<F> : F extends OneofSelectedMessage<infer C, infer V> ? {
     case: C;

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

@@ -137,7 +137,94 @@ export type Any = Message<"google.protobuf.Any"> & {
     value: Uint8Array;
 };
 /**
- * JSON type for the message google.protobuf.Any.
+ * `Any` contains an arbitrary serialized protocol buffer message along with a
+ * URL that describes the type of the serialized message.
+ *
+ * Protobuf library provides support to pack/unpack Any values in the form
+ * of utility functions or additional generated methods of the Any type.
+ *
+ * Example 1: Pack and unpack a message in C++.
+ *
+ *     Foo foo = ...;
+ *     Any any;
+ *     any.PackFrom(foo);
+ *     ...
+ *     if (any.UnpackTo(&foo)) {
+ *       ...
+ *     }
+ *
+ * Example 2: Pack and unpack a message in Java.
+ *
+ *     Foo foo = ...;
+ *     Any any = Any.pack(foo);
+ *     ...
+ *     if (any.is(Foo.class)) {
+ *       foo = any.unpack(Foo.class);
+ *     }
+ *     // or ...
+ *     if (any.isSameTypeAs(Foo.getDefaultInstance())) {
+ *       foo = any.unpack(Foo.getDefaultInstance());
+ *     }
+ *
+ *  Example 3: Pack and unpack a message in Python.
+ *
+ *     foo = Foo(...)
+ *     any = Any()
+ *     any.Pack(foo)
+ *     ...
+ *     if any.Is(Foo.DESCRIPTOR):
+ *       any.Unpack(foo)
+ *       ...
+ *
+ *  Example 4: Pack and unpack a message in Go
+ *
+ *      foo := &pb.Foo{...}
+ *      any, err := anypb.New(foo)
+ *      if err != nil {
+ *        ...
+ *      }
+ *      ...
+ *      foo := &pb.Foo{}
+ *      if err := any.UnmarshalTo(foo); err != nil {
+ *        ...
+ *      }
+ *
+ * The pack methods provided by protobuf library will by default use
+ * 'type.googleapis.com/full.type.name' as the type URL and the unpack
+ * methods only use the fully qualified type name after the last '/'
+ * in the type URL, for example "foo.bar.com/x/y.z" will yield type
+ * name "y.z".
+ *
+ * JSON
+ * ====
+ * The JSON representation of an `Any` value uses the regular
+ * representation of the deserialized, embedded message, with an
+ * additional field `@type` which contains the type URL. Example:
+ *
+ *     package google.profile;
+ *     message Person {
+ *       string first_name = 1;
+ *       string last_name = 2;
+ *     }
+ *
+ *     {
+ *       "@type": "type.googleapis.com/google.profile.Person",
+ *       "firstName": <string>,
+ *       "lastName": <string>
+ *     }
+ *
+ * If the embedded message type is well-known and has a custom JSON
+ * representation, that representation will be embedded adding a field
+ * `value` which holds the custom JSON in addition to the `@type`
+ * field. Example (for message [google.protobuf.Duration][]):
+ *
+ *     {
+ *       "@type": "type.googleapis.com/google.protobuf.Duration",
+ *       "value": "1.212s"
+ *     }
+ *
+ *
+ * @generated from message google.protobuf.Any
  */
 export type AnyJson = {
     "@type"?: string;