@fatehan/tsrp 1.3.47 → 1.3.49

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.
@@ -0,0 +1,1333 @@
1
+ import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
2
+ import Long from "long";
3
+ export declare const protobufPackage = "google.protobuf";
4
+ /** The full set of known editions. */
5
+ export declare enum Edition {
6
+ /** EDITION_UNKNOWN - A placeholder for an unknown edition value. */
7
+ EDITION_UNKNOWN = 0,
8
+ /**
9
+ * EDITION_LEGACY - A placeholder edition for specifying default behaviors *before* a feature
10
+ * was first introduced. This is effectively an "infinite past".
11
+ */
12
+ EDITION_LEGACY = 900,
13
+ /**
14
+ * EDITION_PROTO2 - Legacy syntax "editions". These pre-date editions, but behave much like
15
+ * distinct editions. These can't be used to specify the edition of proto
16
+ * files, but feature definitions must supply proto2/proto3 defaults for
17
+ * backwards compatibility.
18
+ */
19
+ EDITION_PROTO2 = 998,
20
+ EDITION_PROTO3 = 999,
21
+ /**
22
+ * EDITION_2023 - Editions that have been released. The specific values are arbitrary and
23
+ * should not be depended on, but they will always be time-ordered for easy
24
+ * comparison.
25
+ */
26
+ EDITION_2023 = 1000,
27
+ EDITION_2024 = 1001,
28
+ /**
29
+ * EDITION_1_TEST_ONLY - Placeholder editions for testing feature resolution. These should not be
30
+ * used or relied on outside of tests.
31
+ */
32
+ EDITION_1_TEST_ONLY = 1,
33
+ EDITION_2_TEST_ONLY = 2,
34
+ EDITION_99997_TEST_ONLY = 99997,
35
+ EDITION_99998_TEST_ONLY = 99998,
36
+ EDITION_99999_TEST_ONLY = 99999,
37
+ /**
38
+ * EDITION_MAX - Placeholder for specifying unbounded edition support. This should only
39
+ * ever be used by plugins that can expect to never require any changes to
40
+ * support a new edition.
41
+ */
42
+ EDITION_MAX = 2147483647,
43
+ UNRECOGNIZED = -1
44
+ }
45
+ export declare function editionFromJSON(object: any): Edition;
46
+ export declare function editionToJSON(object: Edition): string;
47
+ /**
48
+ * Describes the 'visibility' of a symbol with respect to the proto import
49
+ * system. Symbols can only be imported when the visibility rules do not prevent
50
+ * it (ex: local symbols cannot be imported). Visibility modifiers can only set
51
+ * on `message` and `enum` as they are the only types available to be referenced
52
+ * from other files.
53
+ */
54
+ export declare enum SymbolVisibility {
55
+ VISIBILITY_UNSET = 0,
56
+ VISIBILITY_LOCAL = 1,
57
+ VISIBILITY_EXPORT = 2,
58
+ UNRECOGNIZED = -1
59
+ }
60
+ export declare function symbolVisibilityFromJSON(object: any): SymbolVisibility;
61
+ export declare function symbolVisibilityToJSON(object: SymbolVisibility): string;
62
+ /**
63
+ * The protocol compiler can output a FileDescriptorSet containing the .proto
64
+ * files it parses.
65
+ */
66
+ export interface FileDescriptorSet {
67
+ file: FileDescriptorProto[];
68
+ }
69
+ /** Describes a complete .proto file. */
70
+ export interface FileDescriptorProto {
71
+ /** file name, relative to root of source tree */
72
+ name?: string | undefined;
73
+ /** e.g. "foo", "foo.bar", etc. */
74
+ package?: string | undefined;
75
+ /** Names of files imported by this file. */
76
+ dependency: string[];
77
+ /** Indexes of the public imported files in the dependency list above. */
78
+ publicDependency: number[];
79
+ /**
80
+ * Indexes of the weak imported files in the dependency list.
81
+ * For Google-internal migration only. Do not use.
82
+ */
83
+ weakDependency: number[];
84
+ /**
85
+ * Names of files imported by this file purely for the purpose of providing
86
+ * option extensions. These are excluded from the dependency list above.
87
+ */
88
+ optionDependency: string[];
89
+ /** All top-level definitions in this file. */
90
+ messageType: DescriptorProto[];
91
+ enumType: EnumDescriptorProto[];
92
+ service: ServiceDescriptorProto[];
93
+ extension: FieldDescriptorProto[];
94
+ options?: FileOptions | undefined;
95
+ /**
96
+ * This field contains optional information about the original source code.
97
+ * You may safely remove this entire field without harming runtime
98
+ * functionality of the descriptors -- the information is needed only by
99
+ * development tools.
100
+ */
101
+ sourceCodeInfo?: SourceCodeInfo | undefined;
102
+ /**
103
+ * The syntax of the proto file.
104
+ * The supported values are "proto2", "proto3", and "editions".
105
+ *
106
+ * If `edition` is present, this value must be "editions".
107
+ * WARNING: This field should only be used by protobuf plugins or special
108
+ * cases like the proto compiler. Other uses are discouraged and
109
+ * developers should rely on the protoreflect APIs for their client language.
110
+ */
111
+ syntax?: string | undefined;
112
+ /**
113
+ * The edition of the proto file.
114
+ * WARNING: This field should only be used by protobuf plugins or special
115
+ * cases like the proto compiler. Other uses are discouraged and
116
+ * developers should rely on the protoreflect APIs for their client language.
117
+ */
118
+ edition?: Edition | undefined;
119
+ }
120
+ /** Describes a message type. */
121
+ export interface DescriptorProto {
122
+ name?: string | undefined;
123
+ field: FieldDescriptorProto[];
124
+ extension: FieldDescriptorProto[];
125
+ nestedType: DescriptorProto[];
126
+ enumType: EnumDescriptorProto[];
127
+ extensionRange: DescriptorProto_ExtensionRange[];
128
+ oneofDecl: OneofDescriptorProto[];
129
+ options?: MessageOptions | undefined;
130
+ reservedRange: DescriptorProto_ReservedRange[];
131
+ /**
132
+ * Reserved field names, which may not be used by fields in the same message.
133
+ * A given name may only be reserved once.
134
+ */
135
+ reservedName: string[];
136
+ /** Support for `export` and `local` keywords on enums. */
137
+ visibility?: SymbolVisibility | undefined;
138
+ }
139
+ export interface DescriptorProto_ExtensionRange {
140
+ /** Inclusive. */
141
+ start?: number | undefined;
142
+ /** Exclusive. */
143
+ end?: number | undefined;
144
+ options?: ExtensionRangeOptions | undefined;
145
+ }
146
+ /**
147
+ * Range of reserved tag numbers. Reserved tag numbers may not be used by
148
+ * fields or extension ranges in the same message. Reserved ranges may
149
+ * not overlap.
150
+ */
151
+ export interface DescriptorProto_ReservedRange {
152
+ /** Inclusive. */
153
+ start?: number | undefined;
154
+ /** Exclusive. */
155
+ end?: number | undefined;
156
+ }
157
+ export interface ExtensionRangeOptions {
158
+ /** The parser stores options it doesn't recognize here. See above. */
159
+ uninterpretedOption: UninterpretedOption[];
160
+ /**
161
+ * For external users: DO NOT USE. We are in the process of open sourcing
162
+ * extension declaration and executing internal cleanups before it can be
163
+ * used externally.
164
+ */
165
+ declaration: ExtensionRangeOptions_Declaration[];
166
+ /** Any features defined in the specific edition. */
167
+ features?: FeatureSet | undefined;
168
+ /**
169
+ * The verification state of the range.
170
+ * TODO: flip the default to DECLARATION once all empty ranges
171
+ * are marked as UNVERIFIED.
172
+ */
173
+ verification?: ExtensionRangeOptions_VerificationState | undefined;
174
+ }
175
+ /** The verification state of the extension range. */
176
+ export declare enum ExtensionRangeOptions_VerificationState {
177
+ /** DECLARATION - All the extensions of the range must be declared. */
178
+ DECLARATION = 0,
179
+ UNVERIFIED = 1,
180
+ UNRECOGNIZED = -1
181
+ }
182
+ export declare function extensionRangeOptions_VerificationStateFromJSON(object: any): ExtensionRangeOptions_VerificationState;
183
+ export declare function extensionRangeOptions_VerificationStateToJSON(object: ExtensionRangeOptions_VerificationState): string;
184
+ export interface ExtensionRangeOptions_Declaration {
185
+ /** The extension number declared within the extension range. */
186
+ number?: number | undefined;
187
+ /**
188
+ * The fully-qualified name of the extension field. There must be a leading
189
+ * dot in front of the full name.
190
+ */
191
+ fullName?: string | undefined;
192
+ /**
193
+ * The fully-qualified type name of the extension field. Unlike
194
+ * Metadata.type, Declaration.type must have a leading dot for messages
195
+ * and enums.
196
+ */
197
+ type?: string | undefined;
198
+ /**
199
+ * If true, indicates that the number is reserved in the extension range,
200
+ * and any extension field with the number will fail to compile. Set this
201
+ * when a declared extension field is deleted.
202
+ */
203
+ reserved?: boolean | undefined;
204
+ /**
205
+ * If true, indicates that the extension must be defined as repeated.
206
+ * Otherwise the extension must be defined as optional.
207
+ */
208
+ repeated?: boolean | undefined;
209
+ }
210
+ /** Describes a field within a message. */
211
+ export interface FieldDescriptorProto {
212
+ name?: string | undefined;
213
+ number?: number | undefined;
214
+ label?: FieldDescriptorProto_Label | undefined;
215
+ /**
216
+ * If type_name is set, this need not be set. If both this and type_name
217
+ * are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP.
218
+ */
219
+ type?: FieldDescriptorProto_Type | undefined;
220
+ /**
221
+ * For message and enum types, this is the name of the type. If the name
222
+ * starts with a '.', it is fully-qualified. Otherwise, C++-like scoping
223
+ * rules are used to find the type (i.e. first the nested types within this
224
+ * message are searched, then within the parent, on up to the root
225
+ * namespace).
226
+ */
227
+ typeName?: string | undefined;
228
+ /**
229
+ * For extensions, this is the name of the type being extended. It is
230
+ * resolved in the same manner as type_name.
231
+ */
232
+ extendee?: string | undefined;
233
+ /**
234
+ * For numeric types, contains the original text representation of the value.
235
+ * For booleans, "true" or "false".
236
+ * For strings, contains the default text contents (not escaped in any way).
237
+ * For bytes, contains the C escaped value. All bytes >= 128 are escaped.
238
+ */
239
+ defaultValue?: string | undefined;
240
+ /**
241
+ * If set, gives the index of a oneof in the containing type's oneof_decl
242
+ * list. This field is a member of that oneof.
243
+ */
244
+ oneofIndex?: number | undefined;
245
+ /**
246
+ * JSON name of this field. The value is set by protocol compiler. If the
247
+ * user has set a "json_name" option on this field, that option's value
248
+ * will be used. Otherwise, it's deduced from the field's name by converting
249
+ * it to camelCase.
250
+ */
251
+ jsonName?: string | undefined;
252
+ options?: FieldOptions | undefined;
253
+ /**
254
+ * If true, this is a proto3 "optional". When a proto3 field is optional, it
255
+ * tracks presence regardless of field type.
256
+ *
257
+ * When proto3_optional is true, this field must belong to a oneof to signal
258
+ * to old proto3 clients that presence is tracked for this field. This oneof
259
+ * is known as a "synthetic" oneof, and this field must be its sole member
260
+ * (each proto3 optional field gets its own synthetic oneof). Synthetic oneofs
261
+ * exist in the descriptor only, and do not generate any API. Synthetic oneofs
262
+ * must be ordered after all "real" oneofs.
263
+ *
264
+ * For message fields, proto3_optional doesn't create any semantic change,
265
+ * since non-repeated message fields always track presence. However it still
266
+ * indicates the semantic detail of whether the user wrote "optional" or not.
267
+ * This can be useful for round-tripping the .proto file. For consistency we
268
+ * give message fields a synthetic oneof also, even though it is not required
269
+ * to track presence. This is especially important because the parser can't
270
+ * tell if a field is a message or an enum, so it must always create a
271
+ * synthetic oneof.
272
+ *
273
+ * Proto2 optional fields do not set this flag, because they already indicate
274
+ * optional with `LABEL_OPTIONAL`.
275
+ */
276
+ proto3Optional?: boolean | undefined;
277
+ }
278
+ export declare enum FieldDescriptorProto_Type {
279
+ /**
280
+ * TYPE_DOUBLE - 0 is reserved for errors.
281
+ * Order is weird for historical reasons.
282
+ */
283
+ TYPE_DOUBLE = 1,
284
+ TYPE_FLOAT = 2,
285
+ /**
286
+ * TYPE_INT64 - Not ZigZag encoded. Negative numbers take 10 bytes. Use TYPE_SINT64 if
287
+ * negative values are likely.
288
+ */
289
+ TYPE_INT64 = 3,
290
+ TYPE_UINT64 = 4,
291
+ /**
292
+ * TYPE_INT32 - Not ZigZag encoded. Negative numbers take 10 bytes. Use TYPE_SINT32 if
293
+ * negative values are likely.
294
+ */
295
+ TYPE_INT32 = 5,
296
+ TYPE_FIXED64 = 6,
297
+ TYPE_FIXED32 = 7,
298
+ TYPE_BOOL = 8,
299
+ TYPE_STRING = 9,
300
+ /**
301
+ * TYPE_GROUP - Tag-delimited aggregate.
302
+ * Group type is deprecated and not supported after google.protobuf. However, Proto3
303
+ * implementations should still be able to parse the group wire format and
304
+ * treat group fields as unknown fields. In Editions, the group wire format
305
+ * can be enabled via the `message_encoding` feature.
306
+ */
307
+ TYPE_GROUP = 10,
308
+ /** TYPE_MESSAGE - Length-delimited aggregate. */
309
+ TYPE_MESSAGE = 11,
310
+ /** TYPE_BYTES - New in version 2. */
311
+ TYPE_BYTES = 12,
312
+ TYPE_UINT32 = 13,
313
+ TYPE_ENUM = 14,
314
+ TYPE_SFIXED32 = 15,
315
+ TYPE_SFIXED64 = 16,
316
+ /** TYPE_SINT32 - Uses ZigZag encoding. */
317
+ TYPE_SINT32 = 17,
318
+ /** TYPE_SINT64 - Uses ZigZag encoding. */
319
+ TYPE_SINT64 = 18,
320
+ UNRECOGNIZED = -1
321
+ }
322
+ export declare function fieldDescriptorProto_TypeFromJSON(object: any): FieldDescriptorProto_Type;
323
+ export declare function fieldDescriptorProto_TypeToJSON(object: FieldDescriptorProto_Type): string;
324
+ export declare enum FieldDescriptorProto_Label {
325
+ /** LABEL_OPTIONAL - 0 is reserved for errors */
326
+ LABEL_OPTIONAL = 1,
327
+ LABEL_REPEATED = 3,
328
+ /**
329
+ * LABEL_REQUIRED - The required label is only allowed in google.protobuf. In proto3 and Editions
330
+ * it's explicitly prohibited. In Editions, the `field_presence` feature
331
+ * can be used to get this behavior.
332
+ */
333
+ LABEL_REQUIRED = 2,
334
+ UNRECOGNIZED = -1
335
+ }
336
+ export declare function fieldDescriptorProto_LabelFromJSON(object: any): FieldDescriptorProto_Label;
337
+ export declare function fieldDescriptorProto_LabelToJSON(object: FieldDescriptorProto_Label): string;
338
+ /** Describes a oneof. */
339
+ export interface OneofDescriptorProto {
340
+ name?: string | undefined;
341
+ options?: OneofOptions | undefined;
342
+ }
343
+ /** Describes an enum type. */
344
+ export interface EnumDescriptorProto {
345
+ name?: string | undefined;
346
+ value: EnumValueDescriptorProto[];
347
+ options?: EnumOptions | undefined;
348
+ /**
349
+ * Range of reserved numeric values. Reserved numeric values may not be used
350
+ * by enum values in the same enum declaration. Reserved ranges may not
351
+ * overlap.
352
+ */
353
+ reservedRange: EnumDescriptorProto_EnumReservedRange[];
354
+ /**
355
+ * Reserved enum value names, which may not be reused. A given name may only
356
+ * be reserved once.
357
+ */
358
+ reservedName: string[];
359
+ /** Support for `export` and `local` keywords on enums. */
360
+ visibility?: SymbolVisibility | undefined;
361
+ }
362
+ /**
363
+ * Range of reserved numeric values. Reserved values may not be used by
364
+ * entries in the same enum. Reserved ranges may not overlap.
365
+ *
366
+ * Note that this is distinct from DescriptorProto.ReservedRange in that it
367
+ * is inclusive such that it can appropriately represent the entire int32
368
+ * domain.
369
+ */
370
+ export interface EnumDescriptorProto_EnumReservedRange {
371
+ /** Inclusive. */
372
+ start?: number | undefined;
373
+ /** Inclusive. */
374
+ end?: number | undefined;
375
+ }
376
+ /** Describes a value within an enum. */
377
+ export interface EnumValueDescriptorProto {
378
+ name?: string | undefined;
379
+ number?: number | undefined;
380
+ options?: EnumValueOptions | undefined;
381
+ }
382
+ /** Describes a service. */
383
+ export interface ServiceDescriptorProto {
384
+ name?: string | undefined;
385
+ method: MethodDescriptorProto[];
386
+ options?: ServiceOptions | undefined;
387
+ }
388
+ /** Describes a method of a service. */
389
+ export interface MethodDescriptorProto {
390
+ name?: string | undefined;
391
+ /**
392
+ * Input and output type names. These are resolved in the same way as
393
+ * FieldDescriptorProto.type_name, but must refer to a message type.
394
+ */
395
+ inputType?: string | undefined;
396
+ outputType?: string | undefined;
397
+ options?: MethodOptions | undefined;
398
+ /** Identifies if client streams multiple client messages */
399
+ clientStreaming?: boolean | undefined;
400
+ /** Identifies if server streams multiple server messages */
401
+ serverStreaming?: boolean | undefined;
402
+ }
403
+ export interface FileOptions {
404
+ /**
405
+ * Sets the Java package where classes generated from this .proto will be
406
+ * placed. By default, the proto package is used, but this is often
407
+ * inappropriate because proto packages do not normally start with backwards
408
+ * domain names.
409
+ */
410
+ javaPackage?: string | undefined;
411
+ /**
412
+ * Controls the name of the wrapper Java class generated for the .proto file.
413
+ * That class will always contain the .proto file's getDescriptor() method as
414
+ * well as any top-level extensions defined in the .proto file.
415
+ * If java_multiple_files is disabled, then all the other classes from the
416
+ * .proto file will be nested inside the single wrapper outer class.
417
+ */
418
+ javaOuterClassname?: string | undefined;
419
+ /**
420
+ * If enabled, then the Java code generator will generate a separate .java
421
+ * file for each top-level message, enum, and service defined in the .proto
422
+ * file. Thus, these types will *not* be nested inside the wrapper class
423
+ * named by java_outer_classname. However, the wrapper class will still be
424
+ * generated to contain the file's getDescriptor() method as well as any
425
+ * top-level extensions defined in the file.
426
+ */
427
+ javaMultipleFiles?: boolean | undefined;
428
+ /**
429
+ * This option does nothing.
430
+ *
431
+ * @deprecated
432
+ */
433
+ javaGenerateEqualsAndHash?: boolean | undefined;
434
+ /**
435
+ * A proto2 file can set this to true to opt in to UTF-8 checking for Java,
436
+ * which will throw an exception if invalid UTF-8 is parsed from the wire or
437
+ * assigned to a string field.
438
+ *
439
+ * TODO: clarify exactly what kinds of field types this option
440
+ * applies to, and update these docs accordingly.
441
+ *
442
+ * Proto3 files already perform these checks. Setting the option explicitly to
443
+ * false has no effect: it cannot be used to opt proto3 files out of UTF-8
444
+ * checks.
445
+ */
446
+ javaStringCheckUtf8?: boolean | undefined;
447
+ optimizeFor?: FileOptions_OptimizeMode | undefined;
448
+ /**
449
+ * Sets the Go package where structs generated from this .proto will be
450
+ * placed. If omitted, the Go package will be derived from the following:
451
+ * - The basename of the package import path, if provided.
452
+ * - Otherwise, the package statement in the .proto file, if present.
453
+ * - Otherwise, the basename of the .proto file, without extension.
454
+ */
455
+ goPackage?: string | undefined;
456
+ /**
457
+ * Should generic services be generated in each language? "Generic" services
458
+ * are not specific to any particular RPC system. They are generated by the
459
+ * main code generators in each language (without additional plugins).
460
+ * Generic services were the only kind of service generation supported by
461
+ * early versions of google.protobuf.
462
+ *
463
+ * Generic services are now considered deprecated in favor of using plugins
464
+ * that generate code specific to your particular RPC system. Therefore,
465
+ * these default to false. Old code which depends on generic services should
466
+ * explicitly set them to true.
467
+ */
468
+ ccGenericServices?: boolean | undefined;
469
+ javaGenericServices?: boolean | undefined;
470
+ pyGenericServices?: boolean | undefined;
471
+ /**
472
+ * Is this file deprecated?
473
+ * Depending on the target platform, this can emit Deprecated annotations
474
+ * for everything in the file, or it will be completely ignored; in the very
475
+ * least, this is a formalization for deprecating files.
476
+ */
477
+ deprecated?: boolean | undefined;
478
+ /**
479
+ * Enables the use of arenas for the proto messages in this file. This applies
480
+ * only to generated classes for C++.
481
+ */
482
+ ccEnableArenas?: boolean | undefined;
483
+ /**
484
+ * Sets the objective c class prefix which is prepended to all objective c
485
+ * generated classes from this .proto. There is no default.
486
+ */
487
+ objcClassPrefix?: string | undefined;
488
+ /** Namespace for generated classes; defaults to the package. */
489
+ csharpNamespace?: string | undefined;
490
+ /**
491
+ * By default Swift generators will take the proto package and CamelCase it
492
+ * replacing '.' with underscore and use that to prefix the types/symbols
493
+ * defined. When this options is provided, they will use this value instead
494
+ * to prefix the types/symbols defined.
495
+ */
496
+ swiftPrefix?: string | undefined;
497
+ /**
498
+ * Sets the php class prefix which is prepended to all php generated classes
499
+ * from this .proto. Default is empty.
500
+ */
501
+ phpClassPrefix?: string | undefined;
502
+ /**
503
+ * Use this option to change the namespace of php generated classes. Default
504
+ * is empty. When this option is empty, the package name will be used for
505
+ * determining the namespace.
506
+ */
507
+ phpNamespace?: string | undefined;
508
+ /**
509
+ * Use this option to change the namespace of php generated metadata classes.
510
+ * Default is empty. When this option is empty, the proto file name will be
511
+ * used for determining the namespace.
512
+ */
513
+ phpMetadataNamespace?: string | undefined;
514
+ /**
515
+ * Use this option to change the package of ruby generated classes. Default
516
+ * is empty. When this option is not set, the package name will be used for
517
+ * determining the ruby package.
518
+ */
519
+ rubyPackage?: string | undefined;
520
+ /**
521
+ * Any features defined in the specific edition.
522
+ * WARNING: This field should only be used by protobuf plugins or special
523
+ * cases like the proto compiler. Other uses are discouraged and
524
+ * developers should rely on the protoreflect APIs for their client language.
525
+ */
526
+ features?: FeatureSet | undefined;
527
+ /**
528
+ * The parser stores options it doesn't recognize here.
529
+ * See the documentation for the "Options" section above.
530
+ */
531
+ uninterpretedOption: UninterpretedOption[];
532
+ }
533
+ /** Generated classes can be optimized for speed or code size. */
534
+ export declare enum FileOptions_OptimizeMode {
535
+ /** SPEED - Generate complete code for parsing, serialization, */
536
+ SPEED = 1,
537
+ /** CODE_SIZE - etc. */
538
+ CODE_SIZE = 2,
539
+ /** LITE_RUNTIME - Generate code using MessageLite and the lite runtime. */
540
+ LITE_RUNTIME = 3,
541
+ UNRECOGNIZED = -1
542
+ }
543
+ export declare function fileOptions_OptimizeModeFromJSON(object: any): FileOptions_OptimizeMode;
544
+ export declare function fileOptions_OptimizeModeToJSON(object: FileOptions_OptimizeMode): string;
545
+ export interface MessageOptions {
546
+ /**
547
+ * Set true to use the old proto1 MessageSet wire format for extensions.
548
+ * This is provided for backwards-compatibility with the MessageSet wire
549
+ * format. You should not use this for any other reason: It's less
550
+ * efficient, has fewer features, and is more complicated.
551
+ *
552
+ * The message must be defined exactly as follows:
553
+ * message Foo {
554
+ * option message_set_wire_format = true;
555
+ * extensions 4 to max;
556
+ * }
557
+ * Note that the message cannot have any defined fields; MessageSets only
558
+ * have extensions.
559
+ *
560
+ * All extensions of your type must be singular messages; e.g. they cannot
561
+ * be int32s, enums, or repeated messages.
562
+ *
563
+ * Because this is an option, the above two restrictions are not enforced by
564
+ * the protocol compiler.
565
+ */
566
+ messageSetWireFormat?: boolean | undefined;
567
+ /**
568
+ * Disables the generation of the standard "descriptor()" accessor, which can
569
+ * conflict with a field of the same name. This is meant to make migration
570
+ * from proto1 easier; new code should avoid fields named "descriptor".
571
+ */
572
+ noStandardDescriptorAccessor?: boolean | undefined;
573
+ /**
574
+ * Is this message deprecated?
575
+ * Depending on the target platform, this can emit Deprecated annotations
576
+ * for the message, or it will be completely ignored; in the very least,
577
+ * this is a formalization for deprecating messages.
578
+ */
579
+ deprecated?: boolean | undefined;
580
+ /**
581
+ * Whether the message is an automatically generated map entry type for the
582
+ * maps field.
583
+ *
584
+ * For maps fields:
585
+ * map<KeyType, ValueType> map_field = 1;
586
+ * The parsed descriptor looks like:
587
+ * message MapFieldEntry {
588
+ * option map_entry = true;
589
+ * optional KeyType key = 1;
590
+ * optional ValueType value = 2;
591
+ * }
592
+ * repeated MapFieldEntry map_field = 1;
593
+ *
594
+ * Implementations may choose not to generate the map_entry=true message, but
595
+ * use a native map in the target language to hold the keys and values.
596
+ * The reflection APIs in such implementations still need to work as
597
+ * if the field is a repeated message field.
598
+ *
599
+ * NOTE: Do not set the option in .proto files. Always use the maps syntax
600
+ * instead. The option should only be implicitly set by the proto compiler
601
+ * parser.
602
+ */
603
+ mapEntry?: boolean | undefined;
604
+ /**
605
+ * Enable the legacy handling of JSON field name conflicts. This lowercases
606
+ * and strips underscored from the fields before comparison in proto3 only.
607
+ * The new behavior takes `json_name` into account and applies to proto2 as
608
+ * well.
609
+ *
610
+ * This should only be used as a temporary measure against broken builds due
611
+ * to the change in behavior for JSON field name conflicts.
612
+ *
613
+ * TODO This is legacy behavior we plan to remove once downstream
614
+ * teams have had time to migrate.
615
+ *
616
+ * @deprecated
617
+ */
618
+ deprecatedLegacyJsonFieldConflicts?: boolean | undefined;
619
+ /**
620
+ * Any features defined in the specific edition.
621
+ * WARNING: This field should only be used by protobuf plugins or special
622
+ * cases like the proto compiler. Other uses are discouraged and
623
+ * developers should rely on the protoreflect APIs for their client language.
624
+ */
625
+ features?: FeatureSet | undefined;
626
+ /** The parser stores options it doesn't recognize here. See above. */
627
+ uninterpretedOption: UninterpretedOption[];
628
+ }
629
+ export interface FieldOptions {
630
+ /**
631
+ * NOTE: ctype is deprecated. Use `features.(pb.cpp).string_type` instead.
632
+ * The ctype option instructs the C++ code generator to use a different
633
+ * representation of the field than it normally would. See the specific
634
+ * options below. This option is only implemented to support use of
635
+ * [ctype=CORD] and [ctype=STRING] (the default) on non-repeated fields of
636
+ * type "bytes" in the open source release.
637
+ * TODO: make ctype actually deprecated.
638
+ */
639
+ ctype?: FieldOptions_CType | undefined;
640
+ /**
641
+ * The packed option can be enabled for repeated primitive fields to enable
642
+ * a more efficient representation on the wire. Rather than repeatedly
643
+ * writing the tag and type for each element, the entire array is encoded as
644
+ * a single length-delimited blob. In proto3, only explicit setting it to
645
+ * false will avoid using packed encoding. This option is prohibited in
646
+ * Editions, but the `repeated_field_encoding` feature can be used to control
647
+ * the behavior.
648
+ */
649
+ packed?: boolean | undefined;
650
+ /**
651
+ * The jstype option determines the JavaScript type used for values of the
652
+ * field. The option is permitted only for 64 bit integral and fixed types
653
+ * (int64, uint64, sint64, fixed64, sfixed64). A field with jstype JS_STRING
654
+ * is represented as JavaScript string, which avoids loss of precision that
655
+ * can happen when a large value is converted to a floating point JavaScript.
656
+ * Specifying JS_NUMBER for the jstype causes the generated JavaScript code to
657
+ * use the JavaScript "number" type. The behavior of the default option
658
+ * JS_NORMAL is implementation dependent.
659
+ *
660
+ * This option is an enum to permit additional types to be added, e.g.
661
+ * goog.math.Integer.
662
+ */
663
+ jstype?: FieldOptions_JSType | undefined;
664
+ /**
665
+ * Should this field be parsed lazily? Lazy applies only to message-type
666
+ * fields. It means that when the outer message is initially parsed, the
667
+ * inner message's contents will not be parsed but instead stored in encoded
668
+ * form. The inner message will actually be parsed when it is first accessed.
669
+ *
670
+ * This is only a hint. Implementations are free to choose whether to use
671
+ * eager or lazy parsing regardless of the value of this option. However,
672
+ * setting this option true suggests that the protocol author believes that
673
+ * using lazy parsing on this field is worth the additional bookkeeping
674
+ * overhead typically needed to implement it.
675
+ *
676
+ * This option does not affect the public interface of any generated code;
677
+ * all method signatures remain the same. Furthermore, thread-safety of the
678
+ * interface is not affected by this option; const methods remain safe to
679
+ * call from multiple threads concurrently, while non-const methods continue
680
+ * to require exclusive access.
681
+ *
682
+ * Note that lazy message fields are still eagerly verified to check
683
+ * ill-formed wireformat or missing required fields. Calling IsInitialized()
684
+ * on the outer message would fail if the inner message has missing required
685
+ * fields. Failed verification would result in parsing failure (except when
686
+ * uninitialized messages are acceptable).
687
+ */
688
+ lazy?: boolean | undefined;
689
+ /**
690
+ * unverified_lazy does no correctness checks on the byte stream. This should
691
+ * only be used where lazy with verification is prohibitive for performance
692
+ * reasons.
693
+ */
694
+ unverifiedLazy?: boolean | undefined;
695
+ /**
696
+ * Is this field deprecated?
697
+ * Depending on the target platform, this can emit Deprecated annotations
698
+ * for accessors, or it will be completely ignored; in the very least, this
699
+ * is a formalization for deprecating fields.
700
+ */
701
+ deprecated?: boolean | undefined;
702
+ /** For Google-internal migration only. Do not use. */
703
+ weak?: boolean | undefined;
704
+ /**
705
+ * Indicate that the field value should not be printed out when using debug
706
+ * formats, e.g. when the field contains sensitive credentials.
707
+ */
708
+ debugRedact?: boolean | undefined;
709
+ retention?: FieldOptions_OptionRetention | undefined;
710
+ targets: FieldOptions_OptionTargetType[];
711
+ editionDefaults: FieldOptions_EditionDefault[];
712
+ /**
713
+ * Any features defined in the specific edition.
714
+ * WARNING: This field should only be used by protobuf plugins or special
715
+ * cases like the proto compiler. Other uses are discouraged and
716
+ * developers should rely on the protoreflect APIs for their client language.
717
+ */
718
+ features?: FeatureSet | undefined;
719
+ featureSupport?: FieldOptions_FeatureSupport | undefined;
720
+ /** The parser stores options it doesn't recognize here. See above. */
721
+ uninterpretedOption: UninterpretedOption[];
722
+ }
723
+ export declare enum FieldOptions_CType {
724
+ /** STRING - Default mode. */
725
+ STRING = 0,
726
+ /**
727
+ * CORD - The option [ctype=CORD] may be applied to a non-repeated field of type
728
+ * "bytes". It indicates that in C++, the data should be stored in a Cord
729
+ * instead of a string. For very large strings, this may reduce memory
730
+ * fragmentation. It may also allow better performance when parsing from a
731
+ * Cord, or when parsing with aliasing enabled, as the parsed Cord may then
732
+ * alias the original buffer.
733
+ */
734
+ CORD = 1,
735
+ STRING_PIECE = 2,
736
+ UNRECOGNIZED = -1
737
+ }
738
+ export declare function fieldOptions_CTypeFromJSON(object: any): FieldOptions_CType;
739
+ export declare function fieldOptions_CTypeToJSON(object: FieldOptions_CType): string;
740
+ export declare enum FieldOptions_JSType {
741
+ /** JS_NORMAL - Use the default type. */
742
+ JS_NORMAL = 0,
743
+ /** JS_STRING - Use JavaScript strings. */
744
+ JS_STRING = 1,
745
+ /** JS_NUMBER - Use JavaScript numbers. */
746
+ JS_NUMBER = 2,
747
+ UNRECOGNIZED = -1
748
+ }
749
+ export declare function fieldOptions_JSTypeFromJSON(object: any): FieldOptions_JSType;
750
+ export declare function fieldOptions_JSTypeToJSON(object: FieldOptions_JSType): string;
751
+ /** If set to RETENTION_SOURCE, the option will be omitted from the binary. */
752
+ export declare enum FieldOptions_OptionRetention {
753
+ RETENTION_UNKNOWN = 0,
754
+ RETENTION_RUNTIME = 1,
755
+ RETENTION_SOURCE = 2,
756
+ UNRECOGNIZED = -1
757
+ }
758
+ export declare function fieldOptions_OptionRetentionFromJSON(object: any): FieldOptions_OptionRetention;
759
+ export declare function fieldOptions_OptionRetentionToJSON(object: FieldOptions_OptionRetention): string;
760
+ /**
761
+ * This indicates the types of entities that the field may apply to when used
762
+ * as an option. If it is unset, then the field may be freely used as an
763
+ * option on any kind of entity.
764
+ */
765
+ export declare enum FieldOptions_OptionTargetType {
766
+ TARGET_TYPE_UNKNOWN = 0,
767
+ TARGET_TYPE_FILE = 1,
768
+ TARGET_TYPE_EXTENSION_RANGE = 2,
769
+ TARGET_TYPE_MESSAGE = 3,
770
+ TARGET_TYPE_FIELD = 4,
771
+ TARGET_TYPE_ONEOF = 5,
772
+ TARGET_TYPE_ENUM = 6,
773
+ TARGET_TYPE_ENUM_ENTRY = 7,
774
+ TARGET_TYPE_SERVICE = 8,
775
+ TARGET_TYPE_METHOD = 9,
776
+ UNRECOGNIZED = -1
777
+ }
778
+ export declare function fieldOptions_OptionTargetTypeFromJSON(object: any): FieldOptions_OptionTargetType;
779
+ export declare function fieldOptions_OptionTargetTypeToJSON(object: FieldOptions_OptionTargetType): string;
780
+ export interface FieldOptions_EditionDefault {
781
+ edition?: Edition | undefined;
782
+ /** Textproto value. */
783
+ value?: string | undefined;
784
+ }
785
+ /** Information about the support window of a feature. */
786
+ export interface FieldOptions_FeatureSupport {
787
+ /**
788
+ * The edition that this feature was first available in. In editions
789
+ * earlier than this one, the default assigned to EDITION_LEGACY will be
790
+ * used, and proto files will not be able to override it.
791
+ */
792
+ editionIntroduced?: Edition | undefined;
793
+ /**
794
+ * The edition this feature becomes deprecated in. Using this after this
795
+ * edition may trigger warnings.
796
+ */
797
+ editionDeprecated?: Edition | undefined;
798
+ /**
799
+ * The deprecation warning text if this feature is used after the edition it
800
+ * was marked deprecated in.
801
+ */
802
+ deprecationWarning?: string | undefined;
803
+ /**
804
+ * The edition this feature is no longer available in. In editions after
805
+ * this one, the last default assigned will be used, and proto files will
806
+ * not be able to override it.
807
+ */
808
+ editionRemoved?: Edition | undefined;
809
+ }
810
+ export interface OneofOptions {
811
+ /**
812
+ * Any features defined in the specific edition.
813
+ * WARNING: This field should only be used by protobuf plugins or special
814
+ * cases like the proto compiler. Other uses are discouraged and
815
+ * developers should rely on the protoreflect APIs for their client language.
816
+ */
817
+ features?: FeatureSet | undefined;
818
+ /** The parser stores options it doesn't recognize here. See above. */
819
+ uninterpretedOption: UninterpretedOption[];
820
+ }
821
+ export interface EnumOptions {
822
+ /**
823
+ * Set this option to true to allow mapping different tag names to the same
824
+ * value.
825
+ */
826
+ allowAlias?: boolean | undefined;
827
+ /**
828
+ * Is this enum deprecated?
829
+ * Depending on the target platform, this can emit Deprecated annotations
830
+ * for the enum, or it will be completely ignored; in the very least, this
831
+ * is a formalization for deprecating enums.
832
+ */
833
+ deprecated?: boolean | undefined;
834
+ /**
835
+ * Enable the legacy handling of JSON field name conflicts. This lowercases
836
+ * and strips underscored from the fields before comparison in proto3 only.
837
+ * The new behavior takes `json_name` into account and applies to proto2 as
838
+ * well.
839
+ * TODO Remove this legacy behavior once downstream teams have
840
+ * had time to migrate.
841
+ *
842
+ * @deprecated
843
+ */
844
+ deprecatedLegacyJsonFieldConflicts?: boolean | undefined;
845
+ /**
846
+ * Any features defined in the specific edition.
847
+ * WARNING: This field should only be used by protobuf plugins or special
848
+ * cases like the proto compiler. Other uses are discouraged and
849
+ * developers should rely on the protoreflect APIs for their client language.
850
+ */
851
+ features?: FeatureSet | undefined;
852
+ /** The parser stores options it doesn't recognize here. See above. */
853
+ uninterpretedOption: UninterpretedOption[];
854
+ }
855
+ export interface EnumValueOptions {
856
+ /**
857
+ * Is this enum value deprecated?
858
+ * Depending on the target platform, this can emit Deprecated annotations
859
+ * for the enum value, or it will be completely ignored; in the very least,
860
+ * this is a formalization for deprecating enum values.
861
+ */
862
+ deprecated?: boolean | undefined;
863
+ /**
864
+ * Any features defined in the specific edition.
865
+ * WARNING: This field should only be used by protobuf plugins or special
866
+ * cases like the proto compiler. Other uses are discouraged and
867
+ * developers should rely on the protoreflect APIs for their client language.
868
+ */
869
+ features?: FeatureSet | undefined;
870
+ /**
871
+ * Indicate that fields annotated with this enum value should not be printed
872
+ * out when using debug formats, e.g. when the field contains sensitive
873
+ * credentials.
874
+ */
875
+ debugRedact?: boolean | undefined;
876
+ /** Information about the support window of a feature value. */
877
+ featureSupport?: FieldOptions_FeatureSupport | undefined;
878
+ /** The parser stores options it doesn't recognize here. See above. */
879
+ uninterpretedOption: UninterpretedOption[];
880
+ }
881
+ export interface ServiceOptions {
882
+ /**
883
+ * Any features defined in the specific edition.
884
+ * WARNING: This field should only be used by protobuf plugins or special
885
+ * cases like the proto compiler. Other uses are discouraged and
886
+ * developers should rely on the protoreflect APIs for their client language.
887
+ */
888
+ features?: FeatureSet | undefined;
889
+ /**
890
+ * Is this service deprecated?
891
+ * Depending on the target platform, this can emit Deprecated annotations
892
+ * for the service, or it will be completely ignored; in the very least,
893
+ * this is a formalization for deprecating services.
894
+ */
895
+ deprecated?: boolean | undefined;
896
+ /** The parser stores options it doesn't recognize here. See above. */
897
+ uninterpretedOption: UninterpretedOption[];
898
+ }
899
+ export interface MethodOptions {
900
+ /**
901
+ * Is this method deprecated?
902
+ * Depending on the target platform, this can emit Deprecated annotations
903
+ * for the method, or it will be completely ignored; in the very least,
904
+ * this is a formalization for deprecating methods.
905
+ */
906
+ deprecated?: boolean | undefined;
907
+ idempotencyLevel?: MethodOptions_IdempotencyLevel | undefined;
908
+ /**
909
+ * Any features defined in the specific edition.
910
+ * WARNING: This field should only be used by protobuf plugins or special
911
+ * cases like the proto compiler. Other uses are discouraged and
912
+ * developers should rely on the protoreflect APIs for their client language.
913
+ */
914
+ features?: FeatureSet | undefined;
915
+ /** The parser stores options it doesn't recognize here. See above. */
916
+ uninterpretedOption: UninterpretedOption[];
917
+ }
918
+ /**
919
+ * Is this method side-effect-free (or safe in HTTP parlance), or idempotent,
920
+ * or neither? HTTP based RPC implementation may choose GET verb for safe
921
+ * methods, and PUT verb for idempotent methods instead of the default POST.
922
+ */
923
+ export declare enum MethodOptions_IdempotencyLevel {
924
+ IDEMPOTENCY_UNKNOWN = 0,
925
+ /** NO_SIDE_EFFECTS - implies idempotent */
926
+ NO_SIDE_EFFECTS = 1,
927
+ /** IDEMPOTENT - idempotent, but may have side effects */
928
+ IDEMPOTENT = 2,
929
+ UNRECOGNIZED = -1
930
+ }
931
+ export declare function methodOptions_IdempotencyLevelFromJSON(object: any): MethodOptions_IdempotencyLevel;
932
+ export declare function methodOptions_IdempotencyLevelToJSON(object: MethodOptions_IdempotencyLevel): string;
933
+ /**
934
+ * A message representing a option the parser does not recognize. This only
935
+ * appears in options protos created by the compiler::Parser class.
936
+ * DescriptorPool resolves these when building Descriptor objects. Therefore,
937
+ * options protos in descriptor objects (e.g. returned by Descriptor::options(),
938
+ * or produced by Descriptor::CopyTo()) will never have UninterpretedOptions
939
+ * in them.
940
+ */
941
+ export interface UninterpretedOption {
942
+ name: UninterpretedOption_NamePart[];
943
+ /**
944
+ * The value of the uninterpreted option, in whatever type the tokenizer
945
+ * identified it as during parsing. Exactly one of these should be set.
946
+ */
947
+ identifierValue?: string | undefined;
948
+ positiveIntValue?: Long | undefined;
949
+ negativeIntValue?: Long | undefined;
950
+ doubleValue?: number | undefined;
951
+ stringValue?: Uint8Array | undefined;
952
+ aggregateValue?: string | undefined;
953
+ }
954
+ /**
955
+ * The name of the uninterpreted option. Each string represents a segment in
956
+ * a dot-separated name. is_extension is true iff a segment represents an
957
+ * extension (denoted with parentheses in options specs in .proto files).
958
+ * E.g.,{ ["foo", false], ["bar.baz", true], ["moo", false] } represents
959
+ * "foo.(bar.baz).moo".
960
+ */
961
+ export interface UninterpretedOption_NamePart {
962
+ namePart: string;
963
+ isExtension: boolean;
964
+ }
965
+ /**
966
+ * TODO Enums in C++ gencode (and potentially other languages) are
967
+ * not well scoped. This means that each of the feature enums below can clash
968
+ * with each other. The short names we've chosen maximize call-site
969
+ * readability, but leave us very open to this scenario. A future feature will
970
+ * be designed and implemented to handle this, hopefully before we ever hit a
971
+ * conflict here.
972
+ */
973
+ export interface FeatureSet {
974
+ fieldPresence?: FeatureSet_FieldPresence | undefined;
975
+ enumType?: FeatureSet_EnumType | undefined;
976
+ repeatedFieldEncoding?: FeatureSet_RepeatedFieldEncoding | undefined;
977
+ utf8Validation?: FeatureSet_Utf8Validation | undefined;
978
+ messageEncoding?: FeatureSet_MessageEncoding | undefined;
979
+ jsonFormat?: FeatureSet_JsonFormat | undefined;
980
+ enforceNamingStyle?: FeatureSet_EnforceNamingStyle | undefined;
981
+ defaultSymbolVisibility?: FeatureSet_VisibilityFeature_DefaultSymbolVisibility | undefined;
982
+ }
983
+ export declare enum FeatureSet_FieldPresence {
984
+ FIELD_PRESENCE_UNKNOWN = 0,
985
+ EXPLICIT = 1,
986
+ IMPLICIT = 2,
987
+ LEGACY_REQUIRED = 3,
988
+ UNRECOGNIZED = -1
989
+ }
990
+ export declare function featureSet_FieldPresenceFromJSON(object: any): FeatureSet_FieldPresence;
991
+ export declare function featureSet_FieldPresenceToJSON(object: FeatureSet_FieldPresence): string;
992
+ export declare enum FeatureSet_EnumType {
993
+ ENUM_TYPE_UNKNOWN = 0,
994
+ OPEN = 1,
995
+ CLOSED = 2,
996
+ UNRECOGNIZED = -1
997
+ }
998
+ export declare function featureSet_EnumTypeFromJSON(object: any): FeatureSet_EnumType;
999
+ export declare function featureSet_EnumTypeToJSON(object: FeatureSet_EnumType): string;
1000
+ export declare enum FeatureSet_RepeatedFieldEncoding {
1001
+ REPEATED_FIELD_ENCODING_UNKNOWN = 0,
1002
+ PACKED = 1,
1003
+ EXPANDED = 2,
1004
+ UNRECOGNIZED = -1
1005
+ }
1006
+ export declare function featureSet_RepeatedFieldEncodingFromJSON(object: any): FeatureSet_RepeatedFieldEncoding;
1007
+ export declare function featureSet_RepeatedFieldEncodingToJSON(object: FeatureSet_RepeatedFieldEncoding): string;
1008
+ export declare enum FeatureSet_Utf8Validation {
1009
+ UTF8_VALIDATION_UNKNOWN = 0,
1010
+ VERIFY = 2,
1011
+ NONE = 3,
1012
+ UNRECOGNIZED = -1
1013
+ }
1014
+ export declare function featureSet_Utf8ValidationFromJSON(object: any): FeatureSet_Utf8Validation;
1015
+ export declare function featureSet_Utf8ValidationToJSON(object: FeatureSet_Utf8Validation): string;
1016
+ export declare enum FeatureSet_MessageEncoding {
1017
+ MESSAGE_ENCODING_UNKNOWN = 0,
1018
+ LENGTH_PREFIXED = 1,
1019
+ DELIMITED = 2,
1020
+ UNRECOGNIZED = -1
1021
+ }
1022
+ export declare function featureSet_MessageEncodingFromJSON(object: any): FeatureSet_MessageEncoding;
1023
+ export declare function featureSet_MessageEncodingToJSON(object: FeatureSet_MessageEncoding): string;
1024
+ export declare enum FeatureSet_JsonFormat {
1025
+ JSON_FORMAT_UNKNOWN = 0,
1026
+ ALLOW = 1,
1027
+ LEGACY_BEST_EFFORT = 2,
1028
+ UNRECOGNIZED = -1
1029
+ }
1030
+ export declare function featureSet_JsonFormatFromJSON(object: any): FeatureSet_JsonFormat;
1031
+ export declare function featureSet_JsonFormatToJSON(object: FeatureSet_JsonFormat): string;
1032
+ export declare enum FeatureSet_EnforceNamingStyle {
1033
+ ENFORCE_NAMING_STYLE_UNKNOWN = 0,
1034
+ STYLE2024 = 1,
1035
+ STYLE_LEGACY = 2,
1036
+ UNRECOGNIZED = -1
1037
+ }
1038
+ export declare function featureSet_EnforceNamingStyleFromJSON(object: any): FeatureSet_EnforceNamingStyle;
1039
+ export declare function featureSet_EnforceNamingStyleToJSON(object: FeatureSet_EnforceNamingStyle): string;
1040
+ export interface FeatureSet_VisibilityFeature {
1041
+ }
1042
+ export declare enum FeatureSet_VisibilityFeature_DefaultSymbolVisibility {
1043
+ DEFAULT_SYMBOL_VISIBILITY_UNKNOWN = 0,
1044
+ /** EXPORT_ALL - Default pre-EDITION_2024, all UNSET visibility are export. */
1045
+ EXPORT_ALL = 1,
1046
+ /** EXPORT_TOP_LEVEL - All top-level symbols default to export, nested default to local. */
1047
+ EXPORT_TOP_LEVEL = 2,
1048
+ /** LOCAL_ALL - All symbols default to local. */
1049
+ LOCAL_ALL = 3,
1050
+ /**
1051
+ * STRICT - All symbols local by default. Nested types cannot be exported.
1052
+ * With special case caveat for message { enum {} reserved 1 to max; }
1053
+ * This is the recommended setting for new protos.
1054
+ */
1055
+ STRICT = 4,
1056
+ UNRECOGNIZED = -1
1057
+ }
1058
+ export declare function featureSet_VisibilityFeature_DefaultSymbolVisibilityFromJSON(object: any): FeatureSet_VisibilityFeature_DefaultSymbolVisibility;
1059
+ export declare function featureSet_VisibilityFeature_DefaultSymbolVisibilityToJSON(object: FeatureSet_VisibilityFeature_DefaultSymbolVisibility): string;
1060
+ /**
1061
+ * A compiled specification for the defaults of a set of features. These
1062
+ * messages are generated from FeatureSet extensions and can be used to seed
1063
+ * feature resolution. The resolution with this object becomes a simple search
1064
+ * for the closest matching edition, followed by proto merges.
1065
+ */
1066
+ export interface FeatureSetDefaults {
1067
+ defaults: FeatureSetDefaults_FeatureSetEditionDefault[];
1068
+ /**
1069
+ * The minimum supported edition (inclusive) when this was constructed.
1070
+ * Editions before this will not have defaults.
1071
+ */
1072
+ minimumEdition?: Edition | undefined;
1073
+ /**
1074
+ * The maximum known edition (inclusive) when this was constructed. Editions
1075
+ * after this will not have reliable defaults.
1076
+ */
1077
+ maximumEdition?: Edition | undefined;
1078
+ }
1079
+ /**
1080
+ * A map from every known edition with a unique set of defaults to its
1081
+ * defaults. Not all editions may be contained here. For a given edition,
1082
+ * the defaults at the closest matching edition ordered at or before it should
1083
+ * be used. This field must be in strict ascending order by edition.
1084
+ */
1085
+ export interface FeatureSetDefaults_FeatureSetEditionDefault {
1086
+ edition?: Edition | undefined;
1087
+ /** Defaults of features that can be overridden in this edition. */
1088
+ overridableFeatures?: FeatureSet | undefined;
1089
+ /** Defaults of features that can't be overridden in this edition. */
1090
+ fixedFeatures?: FeatureSet | undefined;
1091
+ }
1092
+ /**
1093
+ * Encapsulates information about the original source file from which a
1094
+ * FileDescriptorProto was generated.
1095
+ */
1096
+ export interface SourceCodeInfo {
1097
+ /**
1098
+ * A Location identifies a piece of source code in a .proto file which
1099
+ * corresponds to a particular definition. This information is intended
1100
+ * to be useful to IDEs, code indexers, documentation generators, and similar
1101
+ * tools.
1102
+ *
1103
+ * For example, say we have a file like:
1104
+ * message Foo {
1105
+ * optional string foo = 1;
1106
+ * }
1107
+ * Let's look at just the field definition:
1108
+ * optional string foo = 1;
1109
+ * ^ ^^ ^^ ^ ^^^
1110
+ * a bc de f ghi
1111
+ * We have the following locations:
1112
+ * span path represents
1113
+ * [a,i) [ 4, 0, 2, 0 ] The whole field definition.
1114
+ * [a,b) [ 4, 0, 2, 0, 4 ] The label (optional).
1115
+ * [c,d) [ 4, 0, 2, 0, 5 ] The type (string).
1116
+ * [e,f) [ 4, 0, 2, 0, 1 ] The name (foo).
1117
+ * [g,h) [ 4, 0, 2, 0, 3 ] The number (1).
1118
+ *
1119
+ * Notes:
1120
+ * - A location may refer to a repeated field itself (i.e. not to any
1121
+ * particular index within it). This is used whenever a set of elements are
1122
+ * logically enclosed in a single code segment. For example, an entire
1123
+ * extend block (possibly containing multiple extension definitions) will
1124
+ * have an outer location whose path refers to the "extensions" repeated
1125
+ * field without an index.
1126
+ * - Multiple locations may have the same path. This happens when a single
1127
+ * logical declaration is spread out across multiple places. The most
1128
+ * obvious example is the "extend" block again -- there may be multiple
1129
+ * extend blocks in the same scope, each of which will have the same path.
1130
+ * - A location's span is not always a subset of its parent's span. For
1131
+ * example, the "extendee" of an extension declaration appears at the
1132
+ * beginning of the "extend" block and is shared by all extensions within
1133
+ * the block.
1134
+ * - Just because a location's span is a subset of some other location's span
1135
+ * does not mean that it is a descendant. For example, a "group" defines
1136
+ * both a type and a field in a single declaration. Thus, the locations
1137
+ * corresponding to the type and field and their components will overlap.
1138
+ * - Code which tries to interpret locations should probably be designed to
1139
+ * ignore those that it doesn't understand, as more types of locations could
1140
+ * be recorded in the future.
1141
+ */
1142
+ location: SourceCodeInfo_Location[];
1143
+ }
1144
+ export interface SourceCodeInfo_Location {
1145
+ /**
1146
+ * Identifies which part of the FileDescriptorProto was defined at this
1147
+ * location.
1148
+ *
1149
+ * Each element is a field number or an index. They form a path from
1150
+ * the root FileDescriptorProto to the place where the definition appears.
1151
+ * For example, this path:
1152
+ * [ 4, 3, 2, 7, 1 ]
1153
+ * refers to:
1154
+ * file.message_type(3) // 4, 3
1155
+ * .field(7) // 2, 7
1156
+ * .name() // 1
1157
+ * This is because FileDescriptorProto.message_type has field number 4:
1158
+ * repeated DescriptorProto message_type = 4;
1159
+ * and DescriptorProto.field has field number 2:
1160
+ * repeated FieldDescriptorProto field = 2;
1161
+ * and FieldDescriptorProto.name has field number 1:
1162
+ * optional string name = 1;
1163
+ *
1164
+ * Thus, the above path gives the location of a field name. If we removed
1165
+ * the last element:
1166
+ * [ 4, 3, 2, 7 ]
1167
+ * this path refers to the whole field declaration (from the beginning
1168
+ * of the label to the terminating semicolon).
1169
+ */
1170
+ path: number[];
1171
+ /**
1172
+ * Always has exactly three or four elements: start line, start column,
1173
+ * end line (optional, otherwise assumed same as start line), end column.
1174
+ * These are packed into a single field for efficiency. Note that line
1175
+ * and column numbers are zero-based -- typically you will want to add
1176
+ * 1 to each before displaying to a user.
1177
+ */
1178
+ span: number[];
1179
+ /**
1180
+ * If this SourceCodeInfo represents a complete declaration, these are any
1181
+ * comments appearing before and after the declaration which appear to be
1182
+ * attached to the declaration.
1183
+ *
1184
+ * A series of line comments appearing on consecutive lines, with no other
1185
+ * tokens appearing on those lines, will be treated as a single comment.
1186
+ *
1187
+ * leading_detached_comments will keep paragraphs of comments that appear
1188
+ * before (but not connected to) the current element. Each paragraph,
1189
+ * separated by empty lines, will be one comment element in the repeated
1190
+ * field.
1191
+ *
1192
+ * Only the comment content is provided; comment markers (e.g. //) are
1193
+ * stripped out. For block comments, leading whitespace and an asterisk
1194
+ * will be stripped from the beginning of each line other than the first.
1195
+ * Newlines are included in the output.
1196
+ *
1197
+ * Examples:
1198
+ *
1199
+ * optional int32 foo = 1; // Comment attached to foo.
1200
+ * // Comment attached to bar.
1201
+ * optional int32 bar = 2;
1202
+ *
1203
+ * optional string baz = 3;
1204
+ * // Comment attached to baz.
1205
+ * // Another line attached to baz.
1206
+ *
1207
+ * // Comment attached to moo.
1208
+ * //
1209
+ * // Another line attached to moo.
1210
+ * optional double moo = 4;
1211
+ *
1212
+ * // Detached comment for corge. This is not leading or trailing comments
1213
+ * // to moo or corge because there are blank lines separating it from
1214
+ * // both.
1215
+ *
1216
+ * // Detached comment for corge paragraph 2.
1217
+ *
1218
+ * optional string corge = 5;
1219
+ * /* Block comment attached
1220
+ * * to corge. Leading asterisks
1221
+ * * will be removed. * /
1222
+ * /* Block comment attached to
1223
+ * * grault. * /
1224
+ * optional int32 grault = 6;
1225
+ *
1226
+ * // ignored detached comments.
1227
+ */
1228
+ leadingComments?: string | undefined;
1229
+ trailingComments?: string | undefined;
1230
+ leadingDetachedComments: string[];
1231
+ }
1232
+ /**
1233
+ * Describes the relationship between generated code and its original source
1234
+ * file. A GeneratedCodeInfo message is associated with only one generated
1235
+ * source file, but may contain references to different source .proto files.
1236
+ */
1237
+ export interface GeneratedCodeInfo {
1238
+ /**
1239
+ * An Annotation connects some span of text in generated code to an element
1240
+ * of its generating .proto file.
1241
+ */
1242
+ annotation: GeneratedCodeInfo_Annotation[];
1243
+ }
1244
+ export interface GeneratedCodeInfo_Annotation {
1245
+ /**
1246
+ * Identifies the element in the original source .proto file. This field
1247
+ * is formatted the same as SourceCodeInfo.Location.path.
1248
+ */
1249
+ path: number[];
1250
+ /** Identifies the filesystem path to the original source .proto. */
1251
+ sourceFile?: string | undefined;
1252
+ /**
1253
+ * Identifies the starting offset in bytes in the generated code
1254
+ * that relates to the identified object.
1255
+ */
1256
+ begin?: number | undefined;
1257
+ /**
1258
+ * Identifies the ending offset in bytes in the generated code that
1259
+ * relates to the identified object. The end offset should be one past
1260
+ * the last relevant byte (so the length of the text = end - begin).
1261
+ */
1262
+ end?: number | undefined;
1263
+ semantic?: GeneratedCodeInfo_Annotation_Semantic | undefined;
1264
+ }
1265
+ /**
1266
+ * Represents the identified object's effect on the element in the original
1267
+ * .proto file.
1268
+ */
1269
+ export declare enum GeneratedCodeInfo_Annotation_Semantic {
1270
+ /** NONE - There is no effect or the effect is indescribable. */
1271
+ NONE = 0,
1272
+ /** SET - The element is set or otherwise mutated. */
1273
+ SET = 1,
1274
+ /** ALIAS - An alias to the element is returned. */
1275
+ ALIAS = 2,
1276
+ UNRECOGNIZED = -1
1277
+ }
1278
+ export declare function generatedCodeInfo_Annotation_SemanticFromJSON(object: any): GeneratedCodeInfo_Annotation_Semantic;
1279
+ export declare function generatedCodeInfo_Annotation_SemanticToJSON(object: GeneratedCodeInfo_Annotation_Semantic): string;
1280
+ export declare const FileDescriptorSet: MessageFns<FileDescriptorSet>;
1281
+ export declare const FileDescriptorProto: MessageFns<FileDescriptorProto>;
1282
+ export declare const DescriptorProto: MessageFns<DescriptorProto>;
1283
+ export declare const DescriptorProto_ExtensionRange: MessageFns<DescriptorProto_ExtensionRange>;
1284
+ export declare const DescriptorProto_ReservedRange: MessageFns<DescriptorProto_ReservedRange>;
1285
+ export declare const ExtensionRangeOptions: MessageFns<ExtensionRangeOptions>;
1286
+ export declare const ExtensionRangeOptions_Declaration: MessageFns<ExtensionRangeOptions_Declaration>;
1287
+ export declare const FieldDescriptorProto: MessageFns<FieldDescriptorProto>;
1288
+ export declare const OneofDescriptorProto: MessageFns<OneofDescriptorProto>;
1289
+ export declare const EnumDescriptorProto: MessageFns<EnumDescriptorProto>;
1290
+ export declare const EnumDescriptorProto_EnumReservedRange: MessageFns<EnumDescriptorProto_EnumReservedRange>;
1291
+ export declare const EnumValueDescriptorProto: MessageFns<EnumValueDescriptorProto>;
1292
+ export declare const ServiceDescriptorProto: MessageFns<ServiceDescriptorProto>;
1293
+ export declare const MethodDescriptorProto: MessageFns<MethodDescriptorProto>;
1294
+ export declare const FileOptions: MessageFns<FileOptions>;
1295
+ export declare const MessageOptions: MessageFns<MessageOptions>;
1296
+ export declare const FieldOptions: MessageFns<FieldOptions>;
1297
+ export declare const FieldOptions_EditionDefault: MessageFns<FieldOptions_EditionDefault>;
1298
+ export declare const FieldOptions_FeatureSupport: MessageFns<FieldOptions_FeatureSupport>;
1299
+ export declare const OneofOptions: MessageFns<OneofOptions>;
1300
+ export declare const EnumOptions: MessageFns<EnumOptions>;
1301
+ export declare const EnumValueOptions: MessageFns<EnumValueOptions>;
1302
+ export declare const ServiceOptions: MessageFns<ServiceOptions>;
1303
+ export declare const MethodOptions: MessageFns<MethodOptions>;
1304
+ export declare const UninterpretedOption: MessageFns<UninterpretedOption>;
1305
+ export declare const UninterpretedOption_NamePart: MessageFns<UninterpretedOption_NamePart>;
1306
+ export declare const FeatureSet: MessageFns<FeatureSet>;
1307
+ export declare const FeatureSet_VisibilityFeature: MessageFns<FeatureSet_VisibilityFeature>;
1308
+ export declare const FeatureSetDefaults: MessageFns<FeatureSetDefaults>;
1309
+ export declare const FeatureSetDefaults_FeatureSetEditionDefault: MessageFns<FeatureSetDefaults_FeatureSetEditionDefault>;
1310
+ export declare const SourceCodeInfo: MessageFns<SourceCodeInfo>;
1311
+ export declare const SourceCodeInfo_Location: MessageFns<SourceCodeInfo_Location>;
1312
+ export declare const GeneratedCodeInfo: MessageFns<GeneratedCodeInfo>;
1313
+ export declare const GeneratedCodeInfo_Annotation: MessageFns<GeneratedCodeInfo_Annotation>;
1314
+ type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
1315
+ export type DeepPartial<T> = T extends Builtin ? T : T extends Long ? string | number | Long : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
1316
+ [K in keyof T]?: DeepPartial<T[K]>;
1317
+ } : Partial<T>;
1318
+ type KeysOfUnion<T> = T extends T ? keyof T : never;
1319
+ export type Exact<P, I extends P> = P extends Builtin ? P : P & {
1320
+ [K in keyof P]: Exact<P[K], I[K]>;
1321
+ } & {
1322
+ [K in Exclude<keyof I, KeysOfUnion<P>>]: never;
1323
+ };
1324
+ export interface MessageFns<T> {
1325
+ encode(message: T, writer?: BinaryWriter): BinaryWriter;
1326
+ decode(input: BinaryReader | Uint8Array, length?: number): T;
1327
+ fromJSON(object: any): T;
1328
+ toJSON(message: T): unknown;
1329
+ create<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
1330
+ fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
1331
+ }
1332
+ export {};
1333
+ //# sourceMappingURL=descriptor.d.ts.map