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