@bufbuild/protobuf 2.0.0 → 2.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (33) hide show
  1. package/dist/cjs/registry.js +1 -1
  2. package/dist/cjs/types.d.ts +38 -4
  3. package/dist/cjs/wire/binary-encoding.js +4 -1
  4. package/dist/cjs/wkt/gen/google/protobuf/any_pb.d.ts +88 -1
  5. package/dist/cjs/wkt/gen/google/protobuf/api_pb.d.ts +148 -3
  6. package/dist/cjs/wkt/gen/google/protobuf/compiler/plugin_pb.d.ts +128 -5
  7. package/dist/cjs/wkt/gen/google/protobuf/descriptor_pb.d.ts +721 -55
  8. package/dist/cjs/wkt/gen/google/protobuf/descriptor_pb.js +1 -1
  9. package/dist/cjs/wkt/gen/google/protobuf/duration_pb.d.ts +61 -1
  10. package/dist/cjs/wkt/gen/google/protobuf/empty_pb.d.ts +10 -1
  11. package/dist/cjs/wkt/gen/google/protobuf/field_mask_pb.d.ts +201 -1
  12. package/dist/cjs/wkt/gen/google/protobuf/source_context_pb.d.ts +7 -1
  13. package/dist/cjs/wkt/gen/google/protobuf/struct_pb.d.ts +29 -4
  14. package/dist/cjs/wkt/gen/google/protobuf/timestamp_pb.d.ts +92 -1
  15. package/dist/cjs/wkt/gen/google/protobuf/type_pb.d.ts +89 -8
  16. package/dist/cjs/wkt/gen/google/protobuf/wrappers_pb.d.ts +45 -9
  17. package/dist/esm/registry.js +1 -1
  18. package/dist/esm/types.d.ts +38 -4
  19. package/dist/esm/wire/binary-encoding.js +4 -1
  20. package/dist/esm/wkt/gen/google/protobuf/any_pb.d.ts +88 -1
  21. package/dist/esm/wkt/gen/google/protobuf/api_pb.d.ts +148 -3
  22. package/dist/esm/wkt/gen/google/protobuf/compiler/plugin_pb.d.ts +128 -5
  23. package/dist/esm/wkt/gen/google/protobuf/descriptor_pb.d.ts +721 -55
  24. package/dist/esm/wkt/gen/google/protobuf/descriptor_pb.js +1 -1
  25. package/dist/esm/wkt/gen/google/protobuf/duration_pb.d.ts +61 -1
  26. package/dist/esm/wkt/gen/google/protobuf/empty_pb.d.ts +10 -1
  27. package/dist/esm/wkt/gen/google/protobuf/field_mask_pb.d.ts +201 -1
  28. package/dist/esm/wkt/gen/google/protobuf/source_context_pb.d.ts +7 -1
  29. package/dist/esm/wkt/gen/google/protobuf/struct_pb.d.ts +29 -4
  30. package/dist/esm/wkt/gen/google/protobuf/timestamp_pb.d.ts +92 -1
  31. package/dist/esm/wkt/gen/google/protobuf/type_pb.d.ts +89 -8
  32. package/dist/esm/wkt/gen/google/protobuf/wrappers_pb.d.ts +45 -9
  33. package/package.json +1 -1
@@ -17,7 +17,10 @@ export type FileDescriptorSet = Message<"google.protobuf.FileDescriptorSet"> & {
17
17
  file: FileDescriptorProto[];
18
18
  };
19
19
  /**
20
- * JSON type for the message google.protobuf.FileDescriptorSet.
20
+ * The protocol compiler can output a FileDescriptorSet containing the .proto
21
+ * files it parses.
22
+ *
23
+ * @generated from message google.protobuf.FileDescriptorSet
21
24
  */
22
25
  export type FileDescriptorSetJson = {
23
26
  /**
@@ -115,30 +118,45 @@ export type FileDescriptorProto = Message<"google.protobuf.FileDescriptorProto">
115
118
  edition: Edition;
116
119
  };
117
120
  /**
118
- * JSON type for the message google.protobuf.FileDescriptorProto.
121
+ * Describes a complete .proto file.
122
+ *
123
+ * @generated from message google.protobuf.FileDescriptorProto
119
124
  */
120
125
  export type FileDescriptorProtoJson = {
121
126
  /**
127
+ * file name, relative to root of source tree
128
+ *
122
129
  * @generated from field: optional string name = 1;
123
130
  */
124
131
  name?: string;
125
132
  /**
133
+ * e.g. "foo", "foo.bar", etc.
134
+ *
126
135
  * @generated from field: optional string package = 2;
127
136
  */
128
137
  package?: string;
129
138
  /**
139
+ * Names of files imported by this file.
140
+ *
130
141
  * @generated from field: repeated string dependency = 3;
131
142
  */
132
143
  dependency?: string[];
133
144
  /**
145
+ * Indexes of the public imported files in the dependency list above.
146
+ *
134
147
  * @generated from field: repeated int32 public_dependency = 10;
135
148
  */
136
149
  publicDependency?: number[];
137
150
  /**
151
+ * Indexes of the weak imported files in the dependency list.
152
+ * For Google-internal migration only. Do not use.
153
+ *
138
154
  * @generated from field: repeated int32 weak_dependency = 11;
139
155
  */
140
156
  weakDependency?: number[];
141
157
  /**
158
+ * All top-level definitions in this file.
159
+ *
142
160
  * @generated from field: repeated google.protobuf.DescriptorProto message_type = 4;
143
161
  */
144
162
  messageType?: DescriptorProtoJson[];
@@ -159,14 +177,26 @@ export type FileDescriptorProtoJson = {
159
177
  */
160
178
  options?: FileOptionsJson;
161
179
  /**
180
+ * This field contains optional information about the original source code.
181
+ * You may safely remove this entire field without harming runtime
182
+ * functionality of the descriptors -- the information is needed only by
183
+ * development tools.
184
+ *
162
185
  * @generated from field: optional google.protobuf.SourceCodeInfo source_code_info = 9;
163
186
  */
164
187
  sourceCodeInfo?: SourceCodeInfoJson;
165
188
  /**
189
+ * The syntax of the proto file.
190
+ * The supported values are "proto2", "proto3", and "editions".
191
+ *
192
+ * If `edition` is present, this value must be "editions".
193
+ *
166
194
  * @generated from field: optional string syntax = 12;
167
195
  */
168
196
  syntax?: string;
169
197
  /**
198
+ * The edition of the proto file.
199
+ *
170
200
  * @generated from field: optional google.protobuf.Edition edition = 14;
171
201
  */
172
202
  edition?: EditionJson;
@@ -227,7 +257,9 @@ export type DescriptorProto = Message<"google.protobuf.DescriptorProto"> & {
227
257
  reservedName: string[];
228
258
  };
229
259
  /**
230
- * JSON type for the message google.protobuf.DescriptorProto.
260
+ * Describes a message type.
261
+ *
262
+ * @generated from message google.protobuf.DescriptorProto
231
263
  */
232
264
  export type DescriptorProtoJson = {
233
265
  /**
@@ -267,6 +299,9 @@ export type DescriptorProtoJson = {
267
299
  */
268
300
  reservedRange?: DescriptorProto_ReservedRangeJson[];
269
301
  /**
302
+ * Reserved field names, which may not be used by fields in the same message.
303
+ * A given name may only be reserved once.
304
+ *
270
305
  * @generated from field: repeated string reserved_name = 10;
271
306
  */
272
307
  reservedName?: string[];
@@ -298,14 +333,18 @@ export type DescriptorProto_ExtensionRange = Message<"google.protobuf.Descriptor
298
333
  options?: ExtensionRangeOptions;
299
334
  };
300
335
  /**
301
- * JSON type for the message google.protobuf.DescriptorProto.ExtensionRange.
336
+ * @generated from message google.protobuf.DescriptorProto.ExtensionRange
302
337
  */
303
338
  export type DescriptorProto_ExtensionRangeJson = {
304
339
  /**
340
+ * Inclusive.
341
+ *
305
342
  * @generated from field: optional int32 start = 1;
306
343
  */
307
344
  start?: number;
308
345
  /**
346
+ * Exclusive.
347
+ *
309
348
  * @generated from field: optional int32 end = 2;
310
349
  */
311
350
  end?: number;
@@ -341,14 +380,22 @@ export type DescriptorProto_ReservedRange = Message<"google.protobuf.DescriptorP
341
380
  end: number;
342
381
  };
343
382
  /**
344
- * JSON type for the message google.protobuf.DescriptorProto.ReservedRange.
383
+ * Range of reserved tag numbers. Reserved tag numbers may not be used by
384
+ * fields or extension ranges in the same message. Reserved ranges may
385
+ * not overlap.
386
+ *
387
+ * @generated from message google.protobuf.DescriptorProto.ReservedRange
345
388
  */
346
389
  export type DescriptorProto_ReservedRangeJson = {
347
390
  /**
391
+ * Inclusive.
392
+ *
348
393
  * @generated from field: optional int32 start = 1;
349
394
  */
350
395
  start?: number;
351
396
  /**
397
+ * Exclusive.
398
+ *
352
399
  * @generated from field: optional int32 end = 2;
353
400
  */
354
401
  end?: number;
@@ -392,22 +439,34 @@ export type ExtensionRangeOptions = Message<"google.protobuf.ExtensionRangeOptio
392
439
  verification: ExtensionRangeOptions_VerificationState;
393
440
  };
394
441
  /**
395
- * JSON type for the message google.protobuf.ExtensionRangeOptions.
442
+ * @generated from message google.protobuf.ExtensionRangeOptions
396
443
  */
397
444
  export type ExtensionRangeOptionsJson = {
398
445
  /**
446
+ * The parser stores options it doesn't recognize here. See above.
447
+ *
399
448
  * @generated from field: repeated google.protobuf.UninterpretedOption uninterpreted_option = 999;
400
449
  */
401
450
  uninterpretedOption?: UninterpretedOptionJson[];
402
451
  /**
452
+ * For external users: DO NOT USE. We are in the process of open sourcing
453
+ * extension declaration and executing internal cleanups before it can be
454
+ * used externally.
455
+ *
403
456
  * @generated from field: repeated google.protobuf.ExtensionRangeOptions.Declaration declaration = 2;
404
457
  */
405
458
  declaration?: ExtensionRangeOptions_DeclarationJson[];
406
459
  /**
460
+ * Any features defined in the specific edition.
461
+ *
407
462
  * @generated from field: optional google.protobuf.FeatureSet features = 50;
408
463
  */
409
464
  features?: FeatureSetJson;
410
465
  /**
466
+ * The verification state of the range.
467
+ * TODO: flip the default to DECLARATION once all empty ranges
468
+ * are marked as UNVERIFIED.
469
+ *
411
470
  * @generated from field: optional google.protobuf.ExtensionRangeOptions.VerificationState verification = 3 [default = UNVERIFIED];
412
471
  */
413
472
  verification?: ExtensionRangeOptions_VerificationStateJson;
@@ -459,26 +518,42 @@ export type ExtensionRangeOptions_Declaration = Message<"google.protobuf.Extensi
459
518
  repeated: boolean;
460
519
  };
461
520
  /**
462
- * JSON type for the message google.protobuf.ExtensionRangeOptions.Declaration.
521
+ * @generated from message google.protobuf.ExtensionRangeOptions.Declaration
463
522
  */
464
523
  export type ExtensionRangeOptions_DeclarationJson = {
465
524
  /**
525
+ * The extension number declared within the extension range.
526
+ *
466
527
  * @generated from field: optional int32 number = 1;
467
528
  */
468
529
  number?: number;
469
530
  /**
531
+ * The fully-qualified name of the extension field. There must be a leading
532
+ * dot in front of the full name.
533
+ *
470
534
  * @generated from field: optional string full_name = 2;
471
535
  */
472
536
  fullName?: string;
473
537
  /**
538
+ * The fully-qualified type name of the extension field. Unlike
539
+ * Metadata.type, Declaration.type must have a leading dot for messages
540
+ * and enums.
541
+ *
474
542
  * @generated from field: optional string type = 3;
475
543
  */
476
544
  type?: string;
477
545
  /**
546
+ * If true, indicates that the number is reserved in the extension range,
547
+ * and any extension field with the number will fail to compile. Set this
548
+ * when a declared extension field is deleted.
549
+ *
478
550
  * @generated from field: optional bool reserved = 5;
479
551
  */
480
552
  reserved?: boolean;
481
553
  /**
554
+ * If true, indicates that the extension must be defined as repeated.
555
+ * Otherwise the extension must be defined as optional.
556
+ *
482
557
  * @generated from field: optional bool repeated = 6;
483
558
  */
484
559
  repeated?: boolean;
@@ -506,7 +581,9 @@ export declare enum ExtensionRangeOptions_VerificationState {
506
581
  UNVERIFIED = 1
507
582
  }
508
583
  /**
509
- * JSON type for the enum google.protobuf.ExtensionRangeOptions.VerificationState.
584
+ * The verification state of the extension range.
585
+ *
586
+ * @generated from enum google.protobuf.ExtensionRangeOptions.VerificationState
510
587
  */
511
588
  export type ExtensionRangeOptions_VerificationStateJson = "DECLARATION" | "UNVERIFIED";
512
589
  /**
@@ -612,7 +689,9 @@ export type FieldDescriptorProto = Message<"google.protobuf.FieldDescriptorProto
612
689
  proto3Optional: boolean;
613
690
  };
614
691
  /**
615
- * JSON type for the message google.protobuf.FieldDescriptorProto.
692
+ * Describes a field within a message.
693
+ *
694
+ * @generated from message google.protobuf.FieldDescriptorProto
616
695
  */
617
696
  export type FieldDescriptorProtoJson = {
618
697
  /**
@@ -628,26 +707,51 @@ export type FieldDescriptorProtoJson = {
628
707
  */
629
708
  label?: FieldDescriptorProto_LabelJson;
630
709
  /**
710
+ * If type_name is set, this need not be set. If both this and type_name
711
+ * are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP.
712
+ *
631
713
  * @generated from field: optional google.protobuf.FieldDescriptorProto.Type type = 5;
632
714
  */
633
715
  type?: FieldDescriptorProto_TypeJson;
634
716
  /**
717
+ * For message and enum types, this is the name of the type. If the name
718
+ * starts with a '.', it is fully-qualified. Otherwise, C++-like scoping
719
+ * rules are used to find the type (i.e. first the nested types within this
720
+ * message are searched, then within the parent, on up to the root
721
+ * namespace).
722
+ *
635
723
  * @generated from field: optional string type_name = 6;
636
724
  */
637
725
  typeName?: string;
638
726
  /**
727
+ * For extensions, this is the name of the type being extended. It is
728
+ * resolved in the same manner as type_name.
729
+ *
639
730
  * @generated from field: optional string extendee = 2;
640
731
  */
641
732
  extendee?: string;
642
733
  /**
734
+ * For numeric types, contains the original text representation of the value.
735
+ * For booleans, "true" or "false".
736
+ * For strings, contains the default text contents (not escaped in any way).
737
+ * For bytes, contains the C escaped value. All bytes >= 128 are escaped.
738
+ *
643
739
  * @generated from field: optional string default_value = 7;
644
740
  */
645
741
  defaultValue?: string;
646
742
  /**
743
+ * If set, gives the index of a oneof in the containing type's oneof_decl
744
+ * list. This field is a member of that oneof.
745
+ *
647
746
  * @generated from field: optional int32 oneof_index = 9;
648
747
  */
649
748
  oneofIndex?: number;
650
749
  /**
750
+ * JSON name of this field. The value is set by protocol compiler. If the
751
+ * user has set a "json_name" option on this field, that option's value
752
+ * will be used. Otherwise, it's deduced from the field's name by converting
753
+ * it to camelCase.
754
+ *
651
755
  * @generated from field: optional string json_name = 10;
652
756
  */
653
757
  jsonName?: string;
@@ -656,6 +760,28 @@ export type FieldDescriptorProtoJson = {
656
760
  */
657
761
  options?: FieldOptionsJson;
658
762
  /**
763
+ * If true, this is a proto3 "optional". When a proto3 field is optional, it
764
+ * tracks presence regardless of field type.
765
+ *
766
+ * When proto3_optional is true, this field must belong to a oneof to signal
767
+ * to old proto3 clients that presence is tracked for this field. This oneof
768
+ * is known as a "synthetic" oneof, and this field must be its sole member
769
+ * (each proto3 optional field gets its own synthetic oneof). Synthetic oneofs
770
+ * exist in the descriptor only, and do not generate any API. Synthetic oneofs
771
+ * must be ordered after all "real" oneofs.
772
+ *
773
+ * For message fields, proto3_optional doesn't create any semantic change,
774
+ * since non-repeated message fields always track presence. However it still
775
+ * indicates the semantic detail of whether the user wrote "optional" or not.
776
+ * This can be useful for round-tripping the .proto file. For consistency we
777
+ * give message fields a synthetic oneof also, even though it is not required
778
+ * to track presence. This is especially important because the parser can't
779
+ * tell if a field is a message or an enum, so it must always create a
780
+ * synthetic oneof.
781
+ *
782
+ * Proto2 optional fields do not set this flag, because they already indicate
783
+ * optional with `LABEL_OPTIONAL`.
784
+ *
659
785
  * @generated from field: optional bool proto3_optional = 17;
660
786
  */
661
787
  proto3Optional?: boolean;
@@ -766,7 +892,7 @@ export declare enum FieldDescriptorProto_Type {
766
892
  SINT64 = 18
767
893
  }
768
894
  /**
769
- * JSON type for the enum google.protobuf.FieldDescriptorProto.Type.
895
+ * @generated from enum google.protobuf.FieldDescriptorProto.Type
770
896
  */
771
897
  export type FieldDescriptorProto_TypeJson = "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";
772
898
  /**
@@ -797,7 +923,7 @@ export declare enum FieldDescriptorProto_Label {
797
923
  REQUIRED = 2
798
924
  }
799
925
  /**
800
- * JSON type for the enum google.protobuf.FieldDescriptorProto.Label.
926
+ * @generated from enum google.protobuf.FieldDescriptorProto.Label
801
927
  */
802
928
  export type FieldDescriptorProto_LabelJson = "LABEL_OPTIONAL" | "LABEL_REPEATED" | "LABEL_REQUIRED";
803
929
  /**
@@ -820,7 +946,9 @@ export type OneofDescriptorProto = Message<"google.protobuf.OneofDescriptorProto
820
946
  options?: OneofOptions;
821
947
  };
822
948
  /**
823
- * JSON type for the message google.protobuf.OneofDescriptorProto.
949
+ * Describes a oneof.
950
+ *
951
+ * @generated from message google.protobuf.OneofDescriptorProto
824
952
  */
825
953
  export type OneofDescriptorProtoJson = {
826
954
  /**
@@ -872,7 +1000,9 @@ export type EnumDescriptorProto = Message<"google.protobuf.EnumDescriptorProto">
872
1000
  reservedName: string[];
873
1001
  };
874
1002
  /**
875
- * JSON type for the message google.protobuf.EnumDescriptorProto.
1003
+ * Describes an enum type.
1004
+ *
1005
+ * @generated from message google.protobuf.EnumDescriptorProto
876
1006
  */
877
1007
  export type EnumDescriptorProtoJson = {
878
1008
  /**
@@ -888,10 +1018,17 @@ export type EnumDescriptorProtoJson = {
888
1018
  */
889
1019
  options?: EnumOptionsJson;
890
1020
  /**
1021
+ * Range of reserved numeric values. Reserved numeric values may not be used
1022
+ * by enum values in the same enum declaration. Reserved ranges may not
1023
+ * overlap.
1024
+ *
891
1025
  * @generated from field: repeated google.protobuf.EnumDescriptorProto.EnumReservedRange reserved_range = 4;
892
1026
  */
893
1027
  reservedRange?: EnumDescriptorProto_EnumReservedRangeJson[];
894
1028
  /**
1029
+ * Reserved enum value names, which may not be reused. A given name may only
1030
+ * be reserved once.
1031
+ *
895
1032
  * @generated from field: repeated string reserved_name = 5;
896
1033
  */
897
1034
  reservedName?: string[];
@@ -926,14 +1063,25 @@ export type EnumDescriptorProto_EnumReservedRange = Message<"google.protobuf.Enu
926
1063
  end: number;
927
1064
  };
928
1065
  /**
929
- * JSON type for the message google.protobuf.EnumDescriptorProto.EnumReservedRange.
1066
+ * Range of reserved numeric values. Reserved values may not be used by
1067
+ * entries in the same enum. Reserved ranges may not overlap.
1068
+ *
1069
+ * Note that this is distinct from DescriptorProto.ReservedRange in that it
1070
+ * is inclusive such that it can appropriately represent the entire int32
1071
+ * domain.
1072
+ *
1073
+ * @generated from message google.protobuf.EnumDescriptorProto.EnumReservedRange
930
1074
  */
931
1075
  export type EnumDescriptorProto_EnumReservedRangeJson = {
932
1076
  /**
1077
+ * Inclusive.
1078
+ *
933
1079
  * @generated from field: optional int32 start = 1;
934
1080
  */
935
1081
  start?: number;
936
1082
  /**
1083
+ * Inclusive.
1084
+ *
937
1085
  * @generated from field: optional int32 end = 2;
938
1086
  */
939
1087
  end?: number;
@@ -963,7 +1111,9 @@ export type EnumValueDescriptorProto = Message<"google.protobuf.EnumValueDescrip
963
1111
  options?: EnumValueOptions;
964
1112
  };
965
1113
  /**
966
- * JSON type for the message google.protobuf.EnumValueDescriptorProto.
1114
+ * Describes a value within an enum.
1115
+ *
1116
+ * @generated from message google.protobuf.EnumValueDescriptorProto
967
1117
  */
968
1118
  export type EnumValueDescriptorProtoJson = {
969
1119
  /**
@@ -1004,7 +1154,9 @@ export type ServiceDescriptorProto = Message<"google.protobuf.ServiceDescriptorP
1004
1154
  options?: ServiceOptions;
1005
1155
  };
1006
1156
  /**
1007
- * JSON type for the message google.protobuf.ServiceDescriptorProto.
1157
+ * Describes a service.
1158
+ *
1159
+ * @generated from message google.protobuf.ServiceDescriptorProto
1008
1160
  */
1009
1161
  export type ServiceDescriptorProtoJson = {
1010
1162
  /**
@@ -1064,7 +1216,9 @@ export type MethodDescriptorProto = Message<"google.protobuf.MethodDescriptorPro
1064
1216
  serverStreaming: boolean;
1065
1217
  };
1066
1218
  /**
1067
- * JSON type for the message google.protobuf.MethodDescriptorProto.
1219
+ * Describes a method of a service.
1220
+ *
1221
+ * @generated from message google.protobuf.MethodDescriptorProto
1068
1222
  */
1069
1223
  export type MethodDescriptorProtoJson = {
1070
1224
  /**
@@ -1072,6 +1226,9 @@ export type MethodDescriptorProtoJson = {
1072
1226
  */
1073
1227
  name?: string;
1074
1228
  /**
1229
+ * Input and output type names. These are resolved in the same way as
1230
+ * FieldDescriptorProto.type_name, but must refer to a message type.
1231
+ *
1075
1232
  * @generated from field: optional string input_type = 2;
1076
1233
  */
1077
1234
  inputType?: string;
@@ -1084,10 +1241,14 @@ export type MethodDescriptorProtoJson = {
1084
1241
  */
1085
1242
  options?: MethodOptionsJson;
1086
1243
  /**
1244
+ * Identifies if client streams multiple client messages
1245
+ *
1087
1246
  * @generated from field: optional bool client_streaming = 5 [default = false];
1088
1247
  */
1089
1248
  clientStreaming?: boolean;
1090
1249
  /**
1250
+ * Identifies if server streams multiple server messages
1251
+ *
1091
1252
  * @generated from field: optional bool server_streaming = 6 [default = false];
1092
1253
  */
1093
1254
  serverStreaming?: boolean;
@@ -1274,26 +1435,58 @@ export type FileOptions = Message<"google.protobuf.FileOptions"> & {
1274
1435
  uninterpretedOption: UninterpretedOption[];
1275
1436
  };
1276
1437
  /**
1277
- * JSON type for the message google.protobuf.FileOptions.
1438
+ * @generated from message google.protobuf.FileOptions
1278
1439
  */
1279
1440
  export type FileOptionsJson = {
1280
1441
  /**
1442
+ * Sets the Java package where classes generated from this .proto will be
1443
+ * placed. By default, the proto package is used, but this is often
1444
+ * inappropriate because proto packages do not normally start with backwards
1445
+ * domain names.
1446
+ *
1281
1447
  * @generated from field: optional string java_package = 1;
1282
1448
  */
1283
1449
  javaPackage?: string;
1284
1450
  /**
1451
+ * Controls the name of the wrapper Java class generated for the .proto file.
1452
+ * That class will always contain the .proto file's getDescriptor() method as
1453
+ * well as any top-level extensions defined in the .proto file.
1454
+ * If java_multiple_files is disabled, then all the other classes from the
1455
+ * .proto file will be nested inside the single wrapper outer class.
1456
+ *
1285
1457
  * @generated from field: optional string java_outer_classname = 8;
1286
1458
  */
1287
1459
  javaOuterClassname?: string;
1288
1460
  /**
1461
+ * If enabled, then the Java code generator will generate a separate .java
1462
+ * file for each top-level message, enum, and service defined in the .proto
1463
+ * file. Thus, these types will *not* be nested inside the wrapper class
1464
+ * named by java_outer_classname. However, the wrapper class will still be
1465
+ * generated to contain the file's getDescriptor() method as well as any
1466
+ * top-level extensions defined in the file.
1467
+ *
1289
1468
  * @generated from field: optional bool java_multiple_files = 10 [default = false];
1290
1469
  */
1291
1470
  javaMultipleFiles?: boolean;
1292
1471
  /**
1472
+ * This option does nothing.
1473
+ *
1293
1474
  * @generated from field: optional bool java_generate_equals_and_hash = 20 [deprecated = true];
1475
+ * @deprecated
1294
1476
  */
1295
1477
  javaGenerateEqualsAndHash?: boolean;
1296
1478
  /**
1479
+ * A proto2 file can set this to true to opt in to UTF-8 checking for Java,
1480
+ * which will throw an exception if invalid UTF-8 is parsed from the wire or
1481
+ * assigned to a string field.
1482
+ *
1483
+ * TODO: clarify exactly what kinds of field types this option
1484
+ * applies to, and update these docs accordingly.
1485
+ *
1486
+ * Proto3 files already perform these checks. Setting the option explicitly to
1487
+ * false has no effect: it cannot be used to opt proto3 files out of UTF-8
1488
+ * checks.
1489
+ *
1297
1490
  * @generated from field: optional bool java_string_check_utf8 = 27 [default = false];
1298
1491
  */
1299
1492
  javaStringCheckUtf8?: boolean;
@@ -1302,10 +1495,27 @@ export type FileOptionsJson = {
1302
1495
  */
1303
1496
  optimizeFor?: FileOptions_OptimizeModeJson;
1304
1497
  /**
1498
+ * Sets the Go package where structs generated from this .proto will be
1499
+ * placed. If omitted, the Go package will be derived from the following:
1500
+ * - The basename of the package import path, if provided.
1501
+ * - Otherwise, the package statement in the .proto file, if present.
1502
+ * - Otherwise, the basename of the .proto file, without extension.
1503
+ *
1305
1504
  * @generated from field: optional string go_package = 11;
1306
1505
  */
1307
1506
  goPackage?: string;
1308
1507
  /**
1508
+ * Should generic services be generated in each language? "Generic" services
1509
+ * are not specific to any particular RPC system. They are generated by the
1510
+ * main code generators in each language (without additional plugins).
1511
+ * Generic services were the only kind of service generation supported by
1512
+ * early versions of google.protobuf.
1513
+ *
1514
+ * Generic services are now considered deprecated in favor of using plugins
1515
+ * that generate code specific to your particular RPC system. Therefore,
1516
+ * these default to false. Old code which depends on generic services should
1517
+ * explicitly set them to true.
1518
+ *
1309
1519
  * @generated from field: optional bool cc_generic_services = 16 [default = false];
1310
1520
  */
1311
1521
  ccGenericServices?: boolean;
@@ -1318,46 +1528,84 @@ export type FileOptionsJson = {
1318
1528
  */
1319
1529
  pyGenericServices?: boolean;
1320
1530
  /**
1531
+ * Is this file deprecated?
1532
+ * Depending on the target platform, this can emit Deprecated annotations
1533
+ * for everything in the file, or it will be completely ignored; in the very
1534
+ * least, this is a formalization for deprecating files.
1535
+ *
1321
1536
  * @generated from field: optional bool deprecated = 23 [default = false];
1322
1537
  */
1323
1538
  deprecated?: boolean;
1324
1539
  /**
1540
+ * Enables the use of arenas for the proto messages in this file. This applies
1541
+ * only to generated classes for C++.
1542
+ *
1325
1543
  * @generated from field: optional bool cc_enable_arenas = 31 [default = true];
1326
1544
  */
1327
1545
  ccEnableArenas?: boolean;
1328
1546
  /**
1547
+ * Sets the objective c class prefix which is prepended to all objective c
1548
+ * generated classes from this .proto. There is no default.
1549
+ *
1329
1550
  * @generated from field: optional string objc_class_prefix = 36;
1330
1551
  */
1331
1552
  objcClassPrefix?: string;
1332
1553
  /**
1554
+ * Namespace for generated classes; defaults to the package.
1555
+ *
1333
1556
  * @generated from field: optional string csharp_namespace = 37;
1334
1557
  */
1335
1558
  csharpNamespace?: string;
1336
1559
  /**
1560
+ * By default Swift generators will take the proto package and CamelCase it
1561
+ * replacing '.' with underscore and use that to prefix the types/symbols
1562
+ * defined. When this options is provided, they will use this value instead
1563
+ * to prefix the types/symbols defined.
1564
+ *
1337
1565
  * @generated from field: optional string swift_prefix = 39;
1338
1566
  */
1339
1567
  swiftPrefix?: string;
1340
1568
  /**
1569
+ * Sets the php class prefix which is prepended to all php generated classes
1570
+ * from this .proto. Default is empty.
1571
+ *
1341
1572
  * @generated from field: optional string php_class_prefix = 40;
1342
1573
  */
1343
1574
  phpClassPrefix?: string;
1344
1575
  /**
1576
+ * Use this option to change the namespace of php generated classes. Default
1577
+ * is empty. When this option is empty, the package name will be used for
1578
+ * determining the namespace.
1579
+ *
1345
1580
  * @generated from field: optional string php_namespace = 41;
1346
1581
  */
1347
1582
  phpNamespace?: string;
1348
1583
  /**
1349
- * @generated from field: optional string php_metadata_namespace = 44;
1350
- */
1351
- phpMetadataNamespace?: string;
1584
+ * Use this option to change the namespace of php generated metadata classes.
1585
+ * Default is empty. When this option is empty, the proto file name will be
1586
+ * used for determining the namespace.
1587
+ *
1588
+ * @generated from field: optional string php_metadata_namespace = 44;
1589
+ */
1590
+ phpMetadataNamespace?: string;
1352
1591
  /**
1592
+ * Use this option to change the package of ruby generated classes. Default
1593
+ * is empty. When this option is not set, the package name will be used for
1594
+ * determining the ruby package.
1595
+ *
1353
1596
  * @generated from field: optional string ruby_package = 45;
1354
1597
  */
1355
1598
  rubyPackage?: string;
1356
1599
  /**
1600
+ * Any features defined in the specific edition.
1601
+ *
1357
1602
  * @generated from field: optional google.protobuf.FeatureSet features = 50;
1358
1603
  */
1359
1604
  features?: FeatureSetJson;
1360
1605
  /**
1606
+ * The parser stores options it doesn't recognize here.
1607
+ * See the documentation for the "Options" section above.
1608
+ *
1361
1609
  * @generated from field: repeated google.protobuf.UninterpretedOption uninterpreted_option = 999;
1362
1610
  */
1363
1611
  uninterpretedOption?: UninterpretedOptionJson[];
@@ -1395,7 +1643,9 @@ export declare enum FileOptions_OptimizeMode {
1395
1643
  LITE_RUNTIME = 3
1396
1644
  }
1397
1645
  /**
1398
- * JSON type for the enum google.protobuf.FileOptions.OptimizeMode.
1646
+ * Generated classes can be optimized for speed or code size.
1647
+ *
1648
+ * @generated from enum google.protobuf.FileOptions.OptimizeMode
1399
1649
  */
1400
1650
  export type FileOptions_OptimizeModeJson = "SPEED" | "CODE_SIZE" | "LITE_RUNTIME";
1401
1651
  /**
@@ -1502,34 +1752,100 @@ export type MessageOptions = Message<"google.protobuf.MessageOptions"> & {
1502
1752
  uninterpretedOption: UninterpretedOption[];
1503
1753
  };
1504
1754
  /**
1505
- * JSON type for the message google.protobuf.MessageOptions.
1755
+ * @generated from message google.protobuf.MessageOptions
1506
1756
  */
1507
1757
  export type MessageOptionsJson = {
1508
1758
  /**
1759
+ * Set true to use the old proto1 MessageSet wire format for extensions.
1760
+ * This is provided for backwards-compatibility with the MessageSet wire
1761
+ * format. You should not use this for any other reason: It's less
1762
+ * efficient, has fewer features, and is more complicated.
1763
+ *
1764
+ * The message must be defined exactly as follows:
1765
+ * message Foo {
1766
+ * option message_set_wire_format = true;
1767
+ * extensions 4 to max;
1768
+ * }
1769
+ * Note that the message cannot have any defined fields; MessageSets only
1770
+ * have extensions.
1771
+ *
1772
+ * All extensions of your type must be singular messages; e.g. they cannot
1773
+ * be int32s, enums, or repeated messages.
1774
+ *
1775
+ * Because this is an option, the above two restrictions are not enforced by
1776
+ * the protocol compiler.
1777
+ *
1509
1778
  * @generated from field: optional bool message_set_wire_format = 1 [default = false];
1510
1779
  */
1511
1780
  messageSetWireFormat?: boolean;
1512
1781
  /**
1782
+ * Disables the generation of the standard "descriptor()" accessor, which can
1783
+ * conflict with a field of the same name. This is meant to make migration
1784
+ * from proto1 easier; new code should avoid fields named "descriptor".
1785
+ *
1513
1786
  * @generated from field: optional bool no_standard_descriptor_accessor = 2 [default = false];
1514
1787
  */
1515
1788
  noStandardDescriptorAccessor?: boolean;
1516
1789
  /**
1790
+ * Is this message deprecated?
1791
+ * Depending on the target platform, this can emit Deprecated annotations
1792
+ * for the message, or it will be completely ignored; in the very least,
1793
+ * this is a formalization for deprecating messages.
1794
+ *
1517
1795
  * @generated from field: optional bool deprecated = 3 [default = false];
1518
1796
  */
1519
1797
  deprecated?: boolean;
1520
1798
  /**
1799
+ * Whether the message is an automatically generated map entry type for the
1800
+ * maps field.
1801
+ *
1802
+ * For maps fields:
1803
+ * map<KeyType, ValueType> map_field = 1;
1804
+ * The parsed descriptor looks like:
1805
+ * message MapFieldEntry {
1806
+ * option map_entry = true;
1807
+ * optional KeyType key = 1;
1808
+ * optional ValueType value = 2;
1809
+ * }
1810
+ * repeated MapFieldEntry map_field = 1;
1811
+ *
1812
+ * Implementations may choose not to generate the map_entry=true message, but
1813
+ * use a native map in the target language to hold the keys and values.
1814
+ * The reflection APIs in such implementations still need to work as
1815
+ * if the field is a repeated message field.
1816
+ *
1817
+ * NOTE: Do not set the option in .proto files. Always use the maps syntax
1818
+ * instead. The option should only be implicitly set by the proto compiler
1819
+ * parser.
1820
+ *
1521
1821
  * @generated from field: optional bool map_entry = 7;
1522
1822
  */
1523
1823
  mapEntry?: boolean;
1524
1824
  /**
1825
+ * Enable the legacy handling of JSON field name conflicts. This lowercases
1826
+ * and strips underscored from the fields before comparison in proto3 only.
1827
+ * The new behavior takes `json_name` into account and applies to proto2 as
1828
+ * well.
1829
+ *
1830
+ * This should only be used as a temporary measure against broken builds due
1831
+ * to the change in behavior for JSON field name conflicts.
1832
+ *
1833
+ * TODO This is legacy behavior we plan to remove once downstream
1834
+ * teams have had time to migrate.
1835
+ *
1525
1836
  * @generated from field: optional bool deprecated_legacy_json_field_conflicts = 11 [deprecated = true];
1837
+ * @deprecated
1526
1838
  */
1527
1839
  deprecatedLegacyJsonFieldConflicts?: boolean;
1528
1840
  /**
1841
+ * Any features defined in the specific edition.
1842
+ *
1529
1843
  * @generated from field: optional google.protobuf.FeatureSet features = 12;
1530
1844
  */
1531
1845
  features?: FeatureSetJson;
1532
1846
  /**
1847
+ * The parser stores options it doesn't recognize here. See above.
1848
+ *
1533
1849
  * @generated from field: repeated google.protobuf.UninterpretedOption uninterpreted_option = 999;
1534
1850
  */
1535
1851
  uninterpretedOption?: UninterpretedOptionJson[];
@@ -1544,12 +1860,13 @@ export declare const MessageOptionsSchema: GenMessage<MessageOptions, MessageOpt
1544
1860
  */
1545
1861
  export type FieldOptions = Message<"google.protobuf.FieldOptions"> & {
1546
1862
  /**
1863
+ * NOTE: ctype is deprecated. Use `features.(pb.cpp).string_type` instead.
1547
1864
  * The ctype option instructs the C++ code generator to use a different
1548
1865
  * representation of the field than it normally would. See the specific
1549
1866
  * options below. This option is only implemented to support use of
1550
1867
  * [ctype=CORD] and [ctype=STRING] (the default) on non-repeated fields of
1551
- * type "bytes" in the open source release -- sorry, we'll try to include
1552
- * other types in a future version!
1868
+ * type "bytes" in the open source release.
1869
+ * TODO: make ctype actually deprecated.
1553
1870
  *
1554
1871
  * @generated from field: optional google.protobuf.FieldOptions.CType ctype = 1 [default = STRING];
1555
1872
  */
@@ -1669,38 +1986,103 @@ export type FieldOptions = Message<"google.protobuf.FieldOptions"> & {
1669
1986
  uninterpretedOption: UninterpretedOption[];
1670
1987
  };
1671
1988
  /**
1672
- * JSON type for the message google.protobuf.FieldOptions.
1989
+ * @generated from message google.protobuf.FieldOptions
1673
1990
  */
1674
1991
  export type FieldOptionsJson = {
1675
1992
  /**
1993
+ * NOTE: ctype is deprecated. Use `features.(pb.cpp).string_type` instead.
1994
+ * The ctype option instructs the C++ code generator to use a different
1995
+ * representation of the field than it normally would. See the specific
1996
+ * options below. This option is only implemented to support use of
1997
+ * [ctype=CORD] and [ctype=STRING] (the default) on non-repeated fields of
1998
+ * type "bytes" in the open source release.
1999
+ * TODO: make ctype actually deprecated.
2000
+ *
1676
2001
  * @generated from field: optional google.protobuf.FieldOptions.CType ctype = 1 [default = STRING];
1677
2002
  */
1678
2003
  ctype?: FieldOptions_CTypeJson;
1679
2004
  /**
2005
+ * The packed option can be enabled for repeated primitive fields to enable
2006
+ * a more efficient representation on the wire. Rather than repeatedly
2007
+ * writing the tag and type for each element, the entire array is encoded as
2008
+ * a single length-delimited blob. In proto3, only explicit setting it to
2009
+ * false will avoid using packed encoding. This option is prohibited in
2010
+ * Editions, but the `repeated_field_encoding` feature can be used to control
2011
+ * the behavior.
2012
+ *
1680
2013
  * @generated from field: optional bool packed = 2;
1681
2014
  */
1682
2015
  packed?: boolean;
1683
2016
  /**
2017
+ * The jstype option determines the JavaScript type used for values of the
2018
+ * field. The option is permitted only for 64 bit integral and fixed types
2019
+ * (int64, uint64, sint64, fixed64, sfixed64). A field with jstype JS_STRING
2020
+ * is represented as JavaScript string, which avoids loss of precision that
2021
+ * can happen when a large value is converted to a floating point JavaScript.
2022
+ * Specifying JS_NUMBER for the jstype causes the generated JavaScript code to
2023
+ * use the JavaScript "number" type. The behavior of the default option
2024
+ * JS_NORMAL is implementation dependent.
2025
+ *
2026
+ * This option is an enum to permit additional types to be added, e.g.
2027
+ * goog.math.Integer.
2028
+ *
1684
2029
  * @generated from field: optional google.protobuf.FieldOptions.JSType jstype = 6 [default = JS_NORMAL];
1685
2030
  */
1686
2031
  jstype?: FieldOptions_JSTypeJson;
1687
2032
  /**
2033
+ * Should this field be parsed lazily? Lazy applies only to message-type
2034
+ * fields. It means that when the outer message is initially parsed, the
2035
+ * inner message's contents will not be parsed but instead stored in encoded
2036
+ * form. The inner message will actually be parsed when it is first accessed.
2037
+ *
2038
+ * This is only a hint. Implementations are free to choose whether to use
2039
+ * eager or lazy parsing regardless of the value of this option. However,
2040
+ * setting this option true suggests that the protocol author believes that
2041
+ * using lazy parsing on this field is worth the additional bookkeeping
2042
+ * overhead typically needed to implement it.
2043
+ *
2044
+ * This option does not affect the public interface of any generated code;
2045
+ * all method signatures remain the same. Furthermore, thread-safety of the
2046
+ * interface is not affected by this option; const methods remain safe to
2047
+ * call from multiple threads concurrently, while non-const methods continue
2048
+ * to require exclusive access.
2049
+ *
2050
+ * Note that lazy message fields are still eagerly verified to check
2051
+ * ill-formed wireformat or missing required fields. Calling IsInitialized()
2052
+ * on the outer message would fail if the inner message has missing required
2053
+ * fields. Failed verification would result in parsing failure (except when
2054
+ * uninitialized messages are acceptable).
2055
+ *
1688
2056
  * @generated from field: optional bool lazy = 5 [default = false];
1689
2057
  */
1690
2058
  lazy?: boolean;
1691
2059
  /**
2060
+ * unverified_lazy does no correctness checks on the byte stream. This should
2061
+ * only be used where lazy with verification is prohibitive for performance
2062
+ * reasons.
2063
+ *
1692
2064
  * @generated from field: optional bool unverified_lazy = 15 [default = false];
1693
2065
  */
1694
2066
  unverifiedLazy?: boolean;
1695
2067
  /**
2068
+ * Is this field deprecated?
2069
+ * Depending on the target platform, this can emit Deprecated annotations
2070
+ * for accessors, or it will be completely ignored; in the very least, this
2071
+ * is a formalization for deprecating fields.
2072
+ *
1696
2073
  * @generated from field: optional bool deprecated = 3 [default = false];
1697
2074
  */
1698
2075
  deprecated?: boolean;
1699
2076
  /**
2077
+ * For Google-internal migration only. Do not use.
2078
+ *
1700
2079
  * @generated from field: optional bool weak = 10 [default = false];
1701
2080
  */
1702
2081
  weak?: boolean;
1703
2082
  /**
2083
+ * Indicate that the field value should not be printed out when using debug
2084
+ * formats, e.g. when the field contains sensitive credentials.
2085
+ *
1704
2086
  * @generated from field: optional bool debug_redact = 16 [default = false];
1705
2087
  */
1706
2088
  debugRedact?: boolean;
@@ -1717,6 +2099,8 @@ export type FieldOptionsJson = {
1717
2099
  */
1718
2100
  editionDefaults?: FieldOptions_EditionDefaultJson[];
1719
2101
  /**
2102
+ * Any features defined in the specific edition.
2103
+ *
1720
2104
  * @generated from field: optional google.protobuf.FeatureSet features = 21;
1721
2105
  */
1722
2106
  features?: FeatureSetJson;
@@ -1725,6 +2109,8 @@ export type FieldOptionsJson = {
1725
2109
  */
1726
2110
  featureSupport?: FieldOptions_FeatureSupportJson;
1727
2111
  /**
2112
+ * The parser stores options it doesn't recognize here. See above.
2113
+ *
1728
2114
  * @generated from field: repeated google.protobuf.UninterpretedOption uninterpreted_option = 999;
1729
2115
  */
1730
2116
  uninterpretedOption?: UninterpretedOptionJson[];
@@ -1750,7 +2136,7 @@ export type FieldOptions_EditionDefault = Message<"google.protobuf.FieldOptions.
1750
2136
  value: string;
1751
2137
  };
1752
2138
  /**
1753
- * JSON type for the message google.protobuf.FieldOptions.EditionDefault.
2139
+ * @generated from message google.protobuf.FieldOptions.EditionDefault
1754
2140
  */
1755
2141
  export type FieldOptions_EditionDefaultJson = {
1756
2142
  /**
@@ -1758,6 +2144,8 @@ export type FieldOptions_EditionDefaultJson = {
1758
2144
  */
1759
2145
  edition?: EditionJson;
1760
2146
  /**
2147
+ * Textproto value.
2148
+ *
1761
2149
  * @generated from field: optional string value = 2;
1762
2150
  */
1763
2151
  value?: string;
@@ -1805,22 +2193,38 @@ export type FieldOptions_FeatureSupport = Message<"google.protobuf.FieldOptions.
1805
2193
  editionRemoved: Edition;
1806
2194
  };
1807
2195
  /**
1808
- * JSON type for the message google.protobuf.FieldOptions.FeatureSupport.
2196
+ * Information about the support window of a feature.
2197
+ *
2198
+ * @generated from message google.protobuf.FieldOptions.FeatureSupport
1809
2199
  */
1810
2200
  export type FieldOptions_FeatureSupportJson = {
1811
2201
  /**
2202
+ * The edition that this feature was first available in. In editions
2203
+ * earlier than this one, the default assigned to EDITION_LEGACY will be
2204
+ * used, and proto files will not be able to override it.
2205
+ *
1812
2206
  * @generated from field: optional google.protobuf.Edition edition_introduced = 1;
1813
2207
  */
1814
2208
  editionIntroduced?: EditionJson;
1815
2209
  /**
2210
+ * The edition this feature becomes deprecated in. Using this after this
2211
+ * edition may trigger warnings.
2212
+ *
1816
2213
  * @generated from field: optional google.protobuf.Edition edition_deprecated = 2;
1817
2214
  */
1818
2215
  editionDeprecated?: EditionJson;
1819
2216
  /**
2217
+ * The deprecation warning text if this feature is used after the edition it
2218
+ * was marked deprecated in.
2219
+ *
1820
2220
  * @generated from field: optional string deprecation_warning = 3;
1821
2221
  */
1822
2222
  deprecationWarning?: string;
1823
2223
  /**
2224
+ * The edition this feature is no longer available in. In editions after
2225
+ * this one, the last default assigned will be used, and proto files will
2226
+ * not be able to override it.
2227
+ *
1824
2228
  * @generated from field: optional google.protobuf.Edition edition_removed = 4;
1825
2229
  */
1826
2230
  editionRemoved?: EditionJson;
@@ -1857,7 +2261,7 @@ export declare enum FieldOptions_CType {
1857
2261
  STRING_PIECE = 2
1858
2262
  }
1859
2263
  /**
1860
- * JSON type for the enum google.protobuf.FieldOptions.CType.
2264
+ * @generated from enum google.protobuf.FieldOptions.CType
1861
2265
  */
1862
2266
  export type FieldOptions_CTypeJson = "STRING" | "CORD" | "STRING_PIECE";
1863
2267
  /**
@@ -1888,7 +2292,7 @@ export declare enum FieldOptions_JSType {
1888
2292
  JS_NUMBER = 2
1889
2293
  }
1890
2294
  /**
1891
- * JSON type for the enum google.protobuf.FieldOptions.JSType.
2295
+ * @generated from enum google.protobuf.FieldOptions.JSType
1892
2296
  */
1893
2297
  export type FieldOptions_JSTypeJson = "JS_NORMAL" | "JS_STRING" | "JS_NUMBER";
1894
2298
  /**
@@ -1917,7 +2321,11 @@ export declare enum FieldOptions_OptionRetention {
1917
2321
  RETENTION_SOURCE = 2
1918
2322
  }
1919
2323
  /**
1920
- * JSON type for the enum google.protobuf.FieldOptions.OptionRetention.
2324
+ * If set to RETENTION_SOURCE, the option will be omitted from the binary.
2325
+ * Note: as of January 2023, support for this is in progress and does not yet
2326
+ * have an effect (b/264593489).
2327
+ *
2328
+ * @generated from enum google.protobuf.FieldOptions.OptionRetention
1921
2329
  */
1922
2330
  export type FieldOptions_OptionRetentionJson = "RETENTION_UNKNOWN" | "RETENTION_RUNTIME" | "RETENTION_SOURCE";
1923
2331
  /**
@@ -1975,7 +2383,12 @@ export declare enum FieldOptions_OptionTargetType {
1975
2383
  TARGET_TYPE_METHOD = 9
1976
2384
  }
1977
2385
  /**
1978
- * JSON type for the enum google.protobuf.FieldOptions.OptionTargetType.
2386
+ * This indicates the types of entities that the field may apply to when used
2387
+ * as an option. If it is unset, then the field may be freely used as an
2388
+ * option on any kind of entity. Note: as of January 2023, support for this is
2389
+ * in progress and does not yet have an effect (b/264593489).
2390
+ *
2391
+ * @generated from enum google.protobuf.FieldOptions.OptionTargetType
1979
2392
  */
1980
2393
  export type FieldOptions_OptionTargetTypeJson = "TARGET_TYPE_UNKNOWN" | "TARGET_TYPE_FILE" | "TARGET_TYPE_EXTENSION_RANGE" | "TARGET_TYPE_MESSAGE" | "TARGET_TYPE_FIELD" | "TARGET_TYPE_ONEOF" | "TARGET_TYPE_ENUM" | "TARGET_TYPE_ENUM_ENTRY" | "TARGET_TYPE_SERVICE" | "TARGET_TYPE_METHOD";
1981
2394
  /**
@@ -2000,14 +2413,18 @@ export type OneofOptions = Message<"google.protobuf.OneofOptions"> & {
2000
2413
  uninterpretedOption: UninterpretedOption[];
2001
2414
  };
2002
2415
  /**
2003
- * JSON type for the message google.protobuf.OneofOptions.
2416
+ * @generated from message google.protobuf.OneofOptions
2004
2417
  */
2005
2418
  export type OneofOptionsJson = {
2006
2419
  /**
2420
+ * Any features defined in the specific edition.
2421
+ *
2007
2422
  * @generated from field: optional google.protobuf.FeatureSet features = 1;
2008
2423
  */
2009
2424
  features?: FeatureSetJson;
2010
2425
  /**
2426
+ * The parser stores options it doesn't recognize here. See above.
2427
+ *
2011
2428
  * @generated from field: repeated google.protobuf.UninterpretedOption uninterpreted_option = 999;
2012
2429
  */
2013
2430
  uninterpretedOption?: UninterpretedOptionJson[];
@@ -2063,26 +2480,46 @@ export type EnumOptions = Message<"google.protobuf.EnumOptions"> & {
2063
2480
  uninterpretedOption: UninterpretedOption[];
2064
2481
  };
2065
2482
  /**
2066
- * JSON type for the message google.protobuf.EnumOptions.
2483
+ * @generated from message google.protobuf.EnumOptions
2067
2484
  */
2068
2485
  export type EnumOptionsJson = {
2069
2486
  /**
2487
+ * Set this option to true to allow mapping different tag names to the same
2488
+ * value.
2489
+ *
2070
2490
  * @generated from field: optional bool allow_alias = 2;
2071
2491
  */
2072
2492
  allowAlias?: boolean;
2073
2493
  /**
2494
+ * Is this enum deprecated?
2495
+ * Depending on the target platform, this can emit Deprecated annotations
2496
+ * for the enum, or it will be completely ignored; in the very least, this
2497
+ * is a formalization for deprecating enums.
2498
+ *
2074
2499
  * @generated from field: optional bool deprecated = 3 [default = false];
2075
2500
  */
2076
2501
  deprecated?: boolean;
2077
2502
  /**
2503
+ * Enable the legacy handling of JSON field name conflicts. This lowercases
2504
+ * and strips underscored from the fields before comparison in proto3 only.
2505
+ * The new behavior takes `json_name` into account and applies to proto2 as
2506
+ * well.
2507
+ * TODO Remove this legacy behavior once downstream teams have
2508
+ * had time to migrate.
2509
+ *
2078
2510
  * @generated from field: optional bool deprecated_legacy_json_field_conflicts = 6 [deprecated = true];
2511
+ * @deprecated
2079
2512
  */
2080
2513
  deprecatedLegacyJsonFieldConflicts?: boolean;
2081
2514
  /**
2515
+ * Any features defined in the specific edition.
2516
+ *
2082
2517
  * @generated from field: optional google.protobuf.FeatureSet features = 7;
2083
2518
  */
2084
2519
  features?: FeatureSetJson;
2085
2520
  /**
2521
+ * The parser stores options it doesn't recognize here. See above.
2522
+ *
2086
2523
  * @generated from field: repeated google.protobuf.UninterpretedOption uninterpreted_option = 999;
2087
2524
  */
2088
2525
  uninterpretedOption?: UninterpretedOptionJson[];
@@ -2133,26 +2570,41 @@ export type EnumValueOptions = Message<"google.protobuf.EnumValueOptions"> & {
2133
2570
  uninterpretedOption: UninterpretedOption[];
2134
2571
  };
2135
2572
  /**
2136
- * JSON type for the message google.protobuf.EnumValueOptions.
2573
+ * @generated from message google.protobuf.EnumValueOptions
2137
2574
  */
2138
2575
  export type EnumValueOptionsJson = {
2139
2576
  /**
2577
+ * Is this enum value deprecated?
2578
+ * Depending on the target platform, this can emit Deprecated annotations
2579
+ * for the enum value, or it will be completely ignored; in the very least,
2580
+ * this is a formalization for deprecating enum values.
2581
+ *
2140
2582
  * @generated from field: optional bool deprecated = 1 [default = false];
2141
2583
  */
2142
2584
  deprecated?: boolean;
2143
2585
  /**
2586
+ * Any features defined in the specific edition.
2587
+ *
2144
2588
  * @generated from field: optional google.protobuf.FeatureSet features = 2;
2145
2589
  */
2146
2590
  features?: FeatureSetJson;
2147
2591
  /**
2592
+ * Indicate that fields annotated with this enum value should not be printed
2593
+ * out when using debug formats, e.g. when the field contains sensitive
2594
+ * credentials.
2595
+ *
2148
2596
  * @generated from field: optional bool debug_redact = 3 [default = false];
2149
2597
  */
2150
2598
  debugRedact?: boolean;
2151
2599
  /**
2600
+ * Information about the support window of a feature value.
2601
+ *
2152
2602
  * @generated from field: optional google.protobuf.FieldOptions.FeatureSupport feature_support = 4;
2153
2603
  */
2154
2604
  featureSupport?: FieldOptions_FeatureSupportJson;
2155
2605
  /**
2606
+ * The parser stores options it doesn't recognize here. See above.
2607
+ *
2156
2608
  * @generated from field: repeated google.protobuf.UninterpretedOption uninterpreted_option = 999;
2157
2609
  */
2158
2610
  uninterpretedOption?: UninterpretedOptionJson[];
@@ -2189,18 +2641,27 @@ export type ServiceOptions = Message<"google.protobuf.ServiceOptions"> & {
2189
2641
  uninterpretedOption: UninterpretedOption[];
2190
2642
  };
2191
2643
  /**
2192
- * JSON type for the message google.protobuf.ServiceOptions.
2644
+ * @generated from message google.protobuf.ServiceOptions
2193
2645
  */
2194
2646
  export type ServiceOptionsJson = {
2195
2647
  /**
2648
+ * Any features defined in the specific edition.
2649
+ *
2196
2650
  * @generated from field: optional google.protobuf.FeatureSet features = 34;
2197
2651
  */
2198
2652
  features?: FeatureSetJson;
2199
2653
  /**
2654
+ * Is this service deprecated?
2655
+ * Depending on the target platform, this can emit Deprecated annotations
2656
+ * for the service, or it will be completely ignored; in the very least,
2657
+ * this is a formalization for deprecating services.
2658
+ *
2200
2659
  * @generated from field: optional bool deprecated = 33 [default = false];
2201
2660
  */
2202
2661
  deprecated?: boolean;
2203
2662
  /**
2663
+ * The parser stores options it doesn't recognize here. See above.
2664
+ *
2204
2665
  * @generated from field: repeated google.protobuf.UninterpretedOption uninterpreted_option = 999;
2205
2666
  */
2206
2667
  uninterpretedOption?: UninterpretedOptionJson[];
@@ -2241,10 +2702,15 @@ export type MethodOptions = Message<"google.protobuf.MethodOptions"> & {
2241
2702
  uninterpretedOption: UninterpretedOption[];
2242
2703
  };
2243
2704
  /**
2244
- * JSON type for the message google.protobuf.MethodOptions.
2705
+ * @generated from message google.protobuf.MethodOptions
2245
2706
  */
2246
2707
  export type MethodOptionsJson = {
2247
2708
  /**
2709
+ * Is this method deprecated?
2710
+ * Depending on the target platform, this can emit Deprecated annotations
2711
+ * for the method, or it will be completely ignored; in the very least,
2712
+ * this is a formalization for deprecating methods.
2713
+ *
2248
2714
  * @generated from field: optional bool deprecated = 33 [default = false];
2249
2715
  */
2250
2716
  deprecated?: boolean;
@@ -2253,10 +2719,14 @@ export type MethodOptionsJson = {
2253
2719
  */
2254
2720
  idempotencyLevel?: MethodOptions_IdempotencyLevelJson;
2255
2721
  /**
2722
+ * Any features defined in the specific edition.
2723
+ *
2256
2724
  * @generated from field: optional google.protobuf.FeatureSet features = 35;
2257
2725
  */
2258
2726
  features?: FeatureSetJson;
2259
2727
  /**
2728
+ * The parser stores options it doesn't recognize here. See above.
2729
+ *
2260
2730
  * @generated from field: repeated google.protobuf.UninterpretedOption uninterpreted_option = 999;
2261
2731
  */
2262
2732
  uninterpretedOption?: UninterpretedOptionJson[];
@@ -2292,7 +2762,11 @@ export declare enum MethodOptions_IdempotencyLevel {
2292
2762
  IDEMPOTENT = 2
2293
2763
  }
2294
2764
  /**
2295
- * JSON type for the enum google.protobuf.MethodOptions.IdempotencyLevel.
2765
+ * Is this method side-effect-free (or safe in HTTP parlance), or idempotent,
2766
+ * or neither? HTTP based RPC implementation may choose GET verb for safe
2767
+ * methods, and PUT verb for idempotent methods instead of the default POST.
2768
+ *
2769
+ * @generated from enum google.protobuf.MethodOptions.IdempotencyLevel
2296
2770
  */
2297
2771
  export type MethodOptions_IdempotencyLevelJson = "IDEMPOTENCY_UNKNOWN" | "NO_SIDE_EFFECTS" | "IDEMPOTENT";
2298
2772
  /**
@@ -2343,7 +2817,14 @@ export type UninterpretedOption = Message<"google.protobuf.UninterpretedOption">
2343
2817
  aggregateValue: string;
2344
2818
  };
2345
2819
  /**
2346
- * JSON type for the message google.protobuf.UninterpretedOption.
2820
+ * A message representing a option the parser does not recognize. This only
2821
+ * appears in options protos created by the compiler::Parser class.
2822
+ * DescriptorPool resolves these when building Descriptor objects. Therefore,
2823
+ * options protos in descriptor objects (e.g. returned by Descriptor::options(),
2824
+ * or produced by Descriptor::CopyTo()) will never have UninterpretedOptions
2825
+ * in them.
2826
+ *
2827
+ * @generated from message google.protobuf.UninterpretedOption
2347
2828
  */
2348
2829
  export type UninterpretedOptionJson = {
2349
2830
  /**
@@ -2351,6 +2832,9 @@ export type UninterpretedOptionJson = {
2351
2832
  */
2352
2833
  name?: UninterpretedOption_NamePartJson[];
2353
2834
  /**
2835
+ * The value of the uninterpreted option, in whatever type the tokenizer
2836
+ * identified it as during parsing. Exactly one of these should be set.
2837
+ *
2354
2838
  * @generated from field: optional string identifier_value = 3;
2355
2839
  */
2356
2840
  identifierValue?: string;
@@ -2400,7 +2884,13 @@ export type UninterpretedOption_NamePart = Message<"google.protobuf.Uninterprete
2400
2884
  isExtension: boolean;
2401
2885
  };
2402
2886
  /**
2403
- * JSON type for the message google.protobuf.UninterpretedOption.NamePart.
2887
+ * The name of the uninterpreted option. Each string represents a segment in
2888
+ * a dot-separated name. is_extension is true iff a segment represents an
2889
+ * extension (denoted with parentheses in options specs in .proto files).
2890
+ * E.g.,{ ["foo", false], ["bar.baz", true], ["moo", false] } represents
2891
+ * "foo.(bar.baz).moo".
2892
+ *
2893
+ * @generated from message google.protobuf.UninterpretedOption.NamePart
2404
2894
  */
2405
2895
  export type UninterpretedOption_NamePartJson = {
2406
2896
  /**
@@ -2454,7 +2944,14 @@ export type FeatureSet = Message<"google.protobuf.FeatureSet"> & {
2454
2944
  jsonFormat: FeatureSet_JsonFormat;
2455
2945
  };
2456
2946
  /**
2457
- * JSON type for the message google.protobuf.FeatureSet.
2947
+ * TODO Enums in C++ gencode (and potentially other languages) are
2948
+ * not well scoped. This means that each of the feature enums below can clash
2949
+ * with each other. The short names we've chosen maximize call-site
2950
+ * readability, but leave us very open to this scenario. A future feature will
2951
+ * be designed and implemented to handle this, hopefully before we ever hit a
2952
+ * conflict here.
2953
+ *
2954
+ * @generated from message google.protobuf.FeatureSet
2458
2955
  */
2459
2956
  export type FeatureSetJson = {
2460
2957
  /**
@@ -2509,7 +3006,7 @@ export declare enum FeatureSet_FieldPresence {
2509
3006
  LEGACY_REQUIRED = 3
2510
3007
  }
2511
3008
  /**
2512
- * JSON type for the enum google.protobuf.FeatureSet.FieldPresence.
3009
+ * @generated from enum google.protobuf.FeatureSet.FieldPresence
2513
3010
  */
2514
3011
  export type FeatureSet_FieldPresenceJson = "FIELD_PRESENCE_UNKNOWN" | "EXPLICIT" | "IMPLICIT" | "LEGACY_REQUIRED";
2515
3012
  /**
@@ -2534,7 +3031,7 @@ export declare enum FeatureSet_EnumType {
2534
3031
  CLOSED = 2
2535
3032
  }
2536
3033
  /**
2537
- * JSON type for the enum google.protobuf.FeatureSet.EnumType.
3034
+ * @generated from enum google.protobuf.FeatureSet.EnumType
2538
3035
  */
2539
3036
  export type FeatureSet_EnumTypeJson = "ENUM_TYPE_UNKNOWN" | "OPEN" | "CLOSED";
2540
3037
  /**
@@ -2559,7 +3056,7 @@ export declare enum FeatureSet_RepeatedFieldEncoding {
2559
3056
  EXPANDED = 2
2560
3057
  }
2561
3058
  /**
2562
- * JSON type for the enum google.protobuf.FeatureSet.RepeatedFieldEncoding.
3059
+ * @generated from enum google.protobuf.FeatureSet.RepeatedFieldEncoding
2563
3060
  */
2564
3061
  export type FeatureSet_RepeatedFieldEncodingJson = "REPEATED_FIELD_ENCODING_UNKNOWN" | "PACKED" | "EXPANDED";
2565
3062
  /**
@@ -2584,7 +3081,7 @@ export declare enum FeatureSet_Utf8Validation {
2584
3081
  NONE = 3
2585
3082
  }
2586
3083
  /**
2587
- * JSON type for the enum google.protobuf.FeatureSet.Utf8Validation.
3084
+ * @generated from enum google.protobuf.FeatureSet.Utf8Validation
2588
3085
  */
2589
3086
  export type FeatureSet_Utf8ValidationJson = "UTF8_VALIDATION_UNKNOWN" | "VERIFY" | "NONE";
2590
3087
  /**
@@ -2609,7 +3106,7 @@ export declare enum FeatureSet_MessageEncoding {
2609
3106
  DELIMITED = 2
2610
3107
  }
2611
3108
  /**
2612
- * JSON type for the enum google.protobuf.FeatureSet.MessageEncoding.
3109
+ * @generated from enum google.protobuf.FeatureSet.MessageEncoding
2613
3110
  */
2614
3111
  export type FeatureSet_MessageEncodingJson = "MESSAGE_ENCODING_UNKNOWN" | "LENGTH_PREFIXED" | "DELIMITED";
2615
3112
  /**
@@ -2634,7 +3131,7 @@ export declare enum FeatureSet_JsonFormat {
2634
3131
  LEGACY_BEST_EFFORT = 2
2635
3132
  }
2636
3133
  /**
2637
- * JSON type for the enum google.protobuf.FeatureSet.JsonFormat.
3134
+ * @generated from enum google.protobuf.FeatureSet.JsonFormat
2638
3135
  */
2639
3136
  export type FeatureSet_JsonFormatJson = "JSON_FORMAT_UNKNOWN" | "ALLOW" | "LEGACY_BEST_EFFORT";
2640
3137
  /**
@@ -2670,7 +3167,12 @@ export type FeatureSetDefaults = Message<"google.protobuf.FeatureSetDefaults"> &
2670
3167
  maximumEdition: Edition;
2671
3168
  };
2672
3169
  /**
2673
- * JSON type for the message google.protobuf.FeatureSetDefaults.
3170
+ * A compiled specification for the defaults of a set of features. These
3171
+ * messages are generated from FeatureSet extensions and can be used to seed
3172
+ * feature resolution. The resolution with this object becomes a simple search
3173
+ * for the closest matching edition, followed by proto merges.
3174
+ *
3175
+ * @generated from message google.protobuf.FeatureSetDefaults
2674
3176
  */
2675
3177
  export type FeatureSetDefaultsJson = {
2676
3178
  /**
@@ -2678,10 +3180,16 @@ export type FeatureSetDefaultsJson = {
2678
3180
  */
2679
3181
  defaults?: FeatureSetDefaults_FeatureSetEditionDefaultJson[];
2680
3182
  /**
3183
+ * The minimum supported edition (inclusive) when this was constructed.
3184
+ * Editions before this will not have defaults.
3185
+ *
2681
3186
  * @generated from field: optional google.protobuf.Edition minimum_edition = 4;
2682
3187
  */
2683
3188
  minimumEdition?: EditionJson;
2684
3189
  /**
3190
+ * The maximum known edition (inclusive) when this was constructed. Editions
3191
+ * after this will not have reliable defaults.
3192
+ *
2685
3193
  * @generated from field: optional google.protobuf.Edition maximum_edition = 5;
2686
3194
  */
2687
3195
  maximumEdition?: EditionJson;
@@ -2718,7 +3226,12 @@ export type FeatureSetDefaults_FeatureSetEditionDefault = Message<"google.protob
2718
3226
  fixedFeatures?: FeatureSet;
2719
3227
  };
2720
3228
  /**
2721
- * JSON type for the message google.protobuf.FeatureSetDefaults.FeatureSetEditionDefault.
3229
+ * A map from every known edition with a unique set of defaults to its
3230
+ * defaults. Not all editions may be contained here. For a given edition,
3231
+ * the defaults at the closest matching edition ordered at or before it should
3232
+ * be used. This field must be in strict ascending order by edition.
3233
+ *
3234
+ * @generated from message google.protobuf.FeatureSetDefaults.FeatureSetEditionDefault
2722
3235
  */
2723
3236
  export type FeatureSetDefaults_FeatureSetEditionDefaultJson = {
2724
3237
  /**
@@ -2726,10 +3239,14 @@ export type FeatureSetDefaults_FeatureSetEditionDefaultJson = {
2726
3239
  */
2727
3240
  edition?: EditionJson;
2728
3241
  /**
3242
+ * Defaults of features that can be overridden in this edition.
3243
+ *
2729
3244
  * @generated from field: optional google.protobuf.FeatureSet overridable_features = 4;
2730
3245
  */
2731
3246
  overridableFeatures?: FeatureSetJson;
2732
3247
  /**
3248
+ * Defaults of features that can't be overridden in this edition.
3249
+ *
2733
3250
  * @generated from field: optional google.protobuf.FeatureSet fixed_features = 5;
2734
3251
  */
2735
3252
  fixedFeatures?: FeatureSetJson;
@@ -2796,10 +3313,57 @@ export type SourceCodeInfo = Message<"google.protobuf.SourceCodeInfo"> & {
2796
3313
  location: SourceCodeInfo_Location[];
2797
3314
  };
2798
3315
  /**
2799
- * JSON type for the message google.protobuf.SourceCodeInfo.
3316
+ * Encapsulates information about the original source file from which a
3317
+ * FileDescriptorProto was generated.
3318
+ *
3319
+ * @generated from message google.protobuf.SourceCodeInfo
2800
3320
  */
2801
3321
  export type SourceCodeInfoJson = {
2802
3322
  /**
3323
+ * A Location identifies a piece of source code in a .proto file which
3324
+ * corresponds to a particular definition. This information is intended
3325
+ * to be useful to IDEs, code indexers, documentation generators, and similar
3326
+ * tools.
3327
+ *
3328
+ * For example, say we have a file like:
3329
+ * message Foo {
3330
+ * optional string foo = 1;
3331
+ * }
3332
+ * Let's look at just the field definition:
3333
+ * optional string foo = 1;
3334
+ * ^ ^^ ^^ ^ ^^^
3335
+ * a bc de f ghi
3336
+ * We have the following locations:
3337
+ * span path represents
3338
+ * [a,i) [ 4, 0, 2, 0 ] The whole field definition.
3339
+ * [a,b) [ 4, 0, 2, 0, 4 ] The label (optional).
3340
+ * [c,d) [ 4, 0, 2, 0, 5 ] The type (string).
3341
+ * [e,f) [ 4, 0, 2, 0, 1 ] The name (foo).
3342
+ * [g,h) [ 4, 0, 2, 0, 3 ] The number (1).
3343
+ *
3344
+ * Notes:
3345
+ * - A location may refer to a repeated field itself (i.e. not to any
3346
+ * particular index within it). This is used whenever a set of elements are
3347
+ * logically enclosed in a single code segment. For example, an entire
3348
+ * extend block (possibly containing multiple extension definitions) will
3349
+ * have an outer location whose path refers to the "extensions" repeated
3350
+ * field without an index.
3351
+ * - Multiple locations may have the same path. This happens when a single
3352
+ * logical declaration is spread out across multiple places. The most
3353
+ * obvious example is the "extend" block again -- there may be multiple
3354
+ * extend blocks in the same scope, each of which will have the same path.
3355
+ * - A location's span is not always a subset of its parent's span. For
3356
+ * example, the "extendee" of an extension declaration appears at the
3357
+ * beginning of the "extend" block and is shared by all extensions within
3358
+ * the block.
3359
+ * - Just because a location's span is a subset of some other location's span
3360
+ * does not mean that it is a descendant. For example, a "group" defines
3361
+ * both a type and a field in a single declaration. Thus, the locations
3362
+ * corresponding to the type and field and their components will overlap.
3363
+ * - Code which tries to interpret locations should probably be designed to
3364
+ * ignore those that it doesn't understand, as more types of locations could
3365
+ * be recorded in the future.
3366
+ *
2803
3367
  * @generated from field: repeated google.protobuf.SourceCodeInfo.Location location = 1;
2804
3368
  */
2805
3369
  location?: SourceCodeInfo_LocationJson[];
@@ -2913,18 +3477,96 @@ export type SourceCodeInfo_Location = Message<"google.protobuf.SourceCodeInfo.Lo
2913
3477
  leadingDetachedComments: string[];
2914
3478
  };
2915
3479
  /**
2916
- * JSON type for the message google.protobuf.SourceCodeInfo.Location.
3480
+ * @generated from message google.protobuf.SourceCodeInfo.Location
2917
3481
  */
2918
3482
  export type SourceCodeInfo_LocationJson = {
2919
3483
  /**
3484
+ * Identifies which part of the FileDescriptorProto was defined at this
3485
+ * location.
3486
+ *
3487
+ * Each element is a field number or an index. They form a path from
3488
+ * the root FileDescriptorProto to the place where the definition appears.
3489
+ * For example, this path:
3490
+ * [ 4, 3, 2, 7, 1 ]
3491
+ * refers to:
3492
+ * file.message_type(3) // 4, 3
3493
+ * .field(7) // 2, 7
3494
+ * .name() // 1
3495
+ * This is because FileDescriptorProto.message_type has field number 4:
3496
+ * repeated DescriptorProto message_type = 4;
3497
+ * and DescriptorProto.field has field number 2:
3498
+ * repeated FieldDescriptorProto field = 2;
3499
+ * and FieldDescriptorProto.name has field number 1:
3500
+ * optional string name = 1;
3501
+ *
3502
+ * Thus, the above path gives the location of a field name. If we removed
3503
+ * the last element:
3504
+ * [ 4, 3, 2, 7 ]
3505
+ * this path refers to the whole field declaration (from the beginning
3506
+ * of the label to the terminating semicolon).
3507
+ *
2920
3508
  * @generated from field: repeated int32 path = 1 [packed = true];
2921
3509
  */
2922
3510
  path?: number[];
2923
3511
  /**
3512
+ * Always has exactly three or four elements: start line, start column,
3513
+ * end line (optional, otherwise assumed same as start line), end column.
3514
+ * These are packed into a single field for efficiency. Note that line
3515
+ * and column numbers are zero-based -- typically you will want to add
3516
+ * 1 to each before displaying to a user.
3517
+ *
2924
3518
  * @generated from field: repeated int32 span = 2 [packed = true];
2925
3519
  */
2926
3520
  span?: number[];
2927
3521
  /**
3522
+ * If this SourceCodeInfo represents a complete declaration, these are any
3523
+ * comments appearing before and after the declaration which appear to be
3524
+ * attached to the declaration.
3525
+ *
3526
+ * A series of line comments appearing on consecutive lines, with no other
3527
+ * tokens appearing on those lines, will be treated as a single comment.
3528
+ *
3529
+ * leading_detached_comments will keep paragraphs of comments that appear
3530
+ * before (but not connected to) the current element. Each paragraph,
3531
+ * separated by empty lines, will be one comment element in the repeated
3532
+ * field.
3533
+ *
3534
+ * Only the comment content is provided; comment markers (e.g. //) are
3535
+ * stripped out. For block comments, leading whitespace and an asterisk
3536
+ * will be stripped from the beginning of each line other than the first.
3537
+ * Newlines are included in the output.
3538
+ *
3539
+ * Examples:
3540
+ *
3541
+ * optional int32 foo = 1; // Comment attached to foo.
3542
+ * // Comment attached to bar.
3543
+ * optional int32 bar = 2;
3544
+ *
3545
+ * optional string baz = 3;
3546
+ * // Comment attached to baz.
3547
+ * // Another line attached to baz.
3548
+ *
3549
+ * // Comment attached to moo.
3550
+ * //
3551
+ * // Another line attached to moo.
3552
+ * optional double moo = 4;
3553
+ *
3554
+ * // Detached comment for corge. This is not leading or trailing comments
3555
+ * // to moo or corge because there are blank lines separating it from
3556
+ * // both.
3557
+ *
3558
+ * // Detached comment for corge paragraph 2.
3559
+ *
3560
+ * optional string corge = 5;
3561
+ * /* Block comment attached
3562
+ * * to corge. Leading asterisks
3563
+ * * will be removed. *\/
3564
+ * /* Block comment attached to
3565
+ * * grault. *\/
3566
+ * optional int32 grault = 6;
3567
+ *
3568
+ * // ignored detached comments.
3569
+ *
2928
3570
  * @generated from field: optional string leading_comments = 3;
2929
3571
  */
2930
3572
  leadingComments?: string;
@@ -2959,10 +3601,17 @@ export type GeneratedCodeInfo = Message<"google.protobuf.GeneratedCodeInfo"> & {
2959
3601
  annotation: GeneratedCodeInfo_Annotation[];
2960
3602
  };
2961
3603
  /**
2962
- * JSON type for the message google.protobuf.GeneratedCodeInfo.
3604
+ * Describes the relationship between generated code and its original source
3605
+ * file. A GeneratedCodeInfo message is associated with only one generated
3606
+ * source file, but may contain references to different source .proto files.
3607
+ *
3608
+ * @generated from message google.protobuf.GeneratedCodeInfo
2963
3609
  */
2964
3610
  export type GeneratedCodeInfoJson = {
2965
3611
  /**
3612
+ * An Annotation connects some span of text in generated code to an element
3613
+ * of its generating .proto file.
3614
+ *
2966
3615
  * @generated from field: repeated google.protobuf.GeneratedCodeInfo.Annotation annotation = 1;
2967
3616
  */
2968
3617
  annotation?: GeneratedCodeInfo_AnnotationJson[];
@@ -3010,22 +3659,34 @@ export type GeneratedCodeInfo_Annotation = Message<"google.protobuf.GeneratedCod
3010
3659
  semantic: GeneratedCodeInfo_Annotation_Semantic;
3011
3660
  };
3012
3661
  /**
3013
- * JSON type for the message google.protobuf.GeneratedCodeInfo.Annotation.
3662
+ * @generated from message google.protobuf.GeneratedCodeInfo.Annotation
3014
3663
  */
3015
3664
  export type GeneratedCodeInfo_AnnotationJson = {
3016
3665
  /**
3666
+ * Identifies the element in the original source .proto file. This field
3667
+ * is formatted the same as SourceCodeInfo.Location.path.
3668
+ *
3017
3669
  * @generated from field: repeated int32 path = 1 [packed = true];
3018
3670
  */
3019
3671
  path?: number[];
3020
3672
  /**
3673
+ * Identifies the filesystem path to the original source .proto.
3674
+ *
3021
3675
  * @generated from field: optional string source_file = 2;
3022
3676
  */
3023
3677
  sourceFile?: string;
3024
3678
  /**
3679
+ * Identifies the starting offset in bytes in the generated code
3680
+ * that relates to the identified object.
3681
+ *
3025
3682
  * @generated from field: optional int32 begin = 3;
3026
3683
  */
3027
3684
  begin?: number;
3028
3685
  /**
3686
+ * Identifies the ending offset in bytes in the generated code that
3687
+ * relates to the identified object. The end offset should be one past
3688
+ * the last relevant byte (so the length of the text = end - begin).
3689
+ *
3029
3690
  * @generated from field: optional int32 end = 4;
3030
3691
  */
3031
3692
  end?: number;
@@ -3066,7 +3727,10 @@ export declare enum GeneratedCodeInfo_Annotation_Semantic {
3066
3727
  ALIAS = 2
3067
3728
  }
3068
3729
  /**
3069
- * JSON type for the enum google.protobuf.GeneratedCodeInfo.Annotation.Semantic.
3730
+ * Represents the identified object's effect on the element in the original
3731
+ * .proto file.
3732
+ *
3733
+ * @generated from enum google.protobuf.GeneratedCodeInfo.Annotation.Semantic
3070
3734
  */
3071
3735
  export type GeneratedCodeInfo_Annotation_SemanticJson = "NONE" | "SET" | "ALIAS";
3072
3736
  /**
@@ -3150,7 +3814,9 @@ export declare enum Edition {
3150
3814
  EDITION_MAX = 2147483647
3151
3815
  }
3152
3816
  /**
3153
- * JSON type for the enum google.protobuf.Edition.
3817
+ * The full set of known editions.
3818
+ *
3819
+ * @generated from enum google.protobuf.Edition
3154
3820
  */
3155
3821
  export type EditionJson = "EDITION_UNKNOWN" | "EDITION_LEGACY" | "EDITION_PROTO2" | "EDITION_PROTO3" | "EDITION_2023" | "EDITION_2024" | "EDITION_1_TEST_ONLY" | "EDITION_2_TEST_ONLY" | "EDITION_99997_TEST_ONLY" | "EDITION_99998_TEST_ONLY" | "EDITION_99999_TEST_ONLY" | "EDITION_MAX";
3156
3822
  /**