@dcl/ecs 7.24.1-27386133361.commit-558451f → 7.24.1-27387182535.commit-de44c20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (19) hide show
  1. package/dist/components/generated/pb/decentraland/sdk/components/avatar_locomotion_settings.gen.d.ts +6 -0
  2. package/dist/components/generated/pb/decentraland/sdk/components/avatar_locomotion_settings.gen.js +30 -0
  3. package/dist/components/generated/pb/decentraland/sdk/components/avatar_shape.gen.d.ts +8 -0
  4. package/dist/components/generated/pb/decentraland/sdk/components/avatar_shape.gen.js +9 -0
  5. package/dist/components/generated/pb/decentraland/sdk/components/virtual_camera.gen.d.ts +3 -0
  6. package/dist/components/generated/pb/decentraland/sdk/components/virtual_camera.gen.js +10 -1
  7. package/dist/components/generated/pb/google/protobuf/descriptor.gen.d.ts +640 -1
  8. package/dist/components/generated/pb/google/protobuf/descriptor.gen.js +260 -4
  9. package/dist/systems/triggerArea.js +1 -2
  10. package/dist-cjs/components/generated/pb/decentraland/sdk/components/avatar_locomotion_settings.gen.d.ts +6 -0
  11. package/dist-cjs/components/generated/pb/decentraland/sdk/components/avatar_locomotion_settings.gen.js +30 -0
  12. package/dist-cjs/components/generated/pb/decentraland/sdk/components/avatar_shape.gen.d.ts +8 -0
  13. package/dist-cjs/components/generated/pb/decentraland/sdk/components/avatar_shape.gen.js +10 -1
  14. package/dist-cjs/components/generated/pb/decentraland/sdk/components/virtual_camera.gen.d.ts +3 -0
  15. package/dist-cjs/components/generated/pb/decentraland/sdk/components/virtual_camera.gen.js +10 -1
  16. package/dist-cjs/components/generated/pb/google/protobuf/descriptor.gen.d.ts +640 -1
  17. package/dist-cjs/components/generated/pb/google/protobuf/descriptor.gen.js +261 -5
  18. package/dist-cjs/systems/triggerArea.js +1 -2
  19. package/package.json +2 -2
@@ -1,27 +1,52 @@
1
1
  import _m0 from "protobufjs/minimal";
2
+ /**
3
+ * The protocol compiler can output a FileDescriptorSet containing the .proto
4
+ * files it parses.
5
+ */
2
6
  /**
3
7
  * @public
4
8
  */
5
9
  export interface FileDescriptorSet {
6
10
  file: FileDescriptorProto[];
7
11
  }
12
+ /** Describes a complete .proto file. */
8
13
  /**
9
14
  * @public
10
15
  */
11
16
  export interface FileDescriptorProto {
17
+ /** file name, relative to root of source tree */
12
18
  name: string;
19
+ /** e.g. "foo", "foo.bar", etc. */
13
20
  package: string;
21
+ /** Names of files imported by this file. */
14
22
  dependency: string[];
23
+ /** Indexes of the public imported files in the dependency list above. */
15
24
  publicDependency: number[];
25
+ /**
26
+ * Indexes of the weak imported files in the dependency list.
27
+ * For Google-internal migration only. Do not use.
28
+ */
16
29
  weakDependency: number[];
30
+ /** All top-level definitions in this file. */
17
31
  messageType: DescriptorProto[];
18
32
  enumType: EnumDescriptorProto[];
19
33
  service: ServiceDescriptorProto[];
20
34
  extension: FieldDescriptorProto[];
21
35
  options: FileOptions | undefined;
36
+ /**
37
+ * This field contains optional information about the original source code.
38
+ * You may safely remove this entire field without harming runtime
39
+ * functionality of the descriptors -- the information is needed only by
40
+ * development tools.
41
+ */
22
42
  sourceCodeInfo: SourceCodeInfo | undefined;
43
+ /**
44
+ * The syntax of the proto file.
45
+ * The supported values are "proto2" and "proto3".
46
+ */
23
47
  syntax: string;
24
48
  }
49
+ /** Describes a message type. */
25
50
  /**
26
51
  * @public
27
52
  */
@@ -35,22 +60,44 @@ export interface DescriptorProto {
35
60
  oneofDecl: OneofDescriptorProto[];
36
61
  options: MessageOptions | undefined;
37
62
  reservedRange: DescriptorProto_ReservedRange[];
63
+ /**
64
+ * Reserved field names, which may not be used by fields in the same message.
65
+ * A given name may only be reserved once.
66
+ */
38
67
  reservedName: string[];
39
68
  }
40
69
  /**
41
70
  * @public
42
71
  */
43
72
  export interface DescriptorProto_ExtensionRange {
73
+ /** Inclusive. */
44
74
  start: number;
75
+ /** Exclusive. */
45
76
  end: number;
77
+ options: ExtensionRangeOptions | undefined;
46
78
  }
79
+ /**
80
+ * Range of reserved tag numbers. Reserved tag numbers may not be used by
81
+ * fields or extension ranges in the same message. Reserved ranges may
82
+ * not overlap.
83
+ */
47
84
  /**
48
85
  * @public
49
86
  */
50
87
  export interface DescriptorProto_ReservedRange {
88
+ /** Inclusive. */
51
89
  start: number;
90
+ /** Exclusive. */
52
91
  end: number;
53
92
  }
93
+ /**
94
+ * @public
95
+ */
96
+ export interface ExtensionRangeOptions {
97
+ /** The parser stores options it doesn't recognize here. See above. */
98
+ uninterpretedOption: UninterpretedOption[];
99
+ }
100
+ /** Describes a field within a message. */
54
101
  /**
55
102
  * @public
56
103
  */
@@ -58,45 +105,124 @@ export interface FieldDescriptorProto {
58
105
  name: string;
59
106
  number: number;
60
107
  label: FieldDescriptorProto_Label;
108
+ /**
109
+ * If type_name is set, this need not be set. If both this and type_name
110
+ * are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP.
111
+ */
61
112
  type: FieldDescriptorProto_Type;
113
+ /**
114
+ * For message and enum types, this is the name of the type. If the name
115
+ * starts with a '.', it is fully-qualified. Otherwise, C++-like scoping
116
+ * rules are used to find the type (i.e. first the nested types within this
117
+ * message are searched, then within the parent, on up to the root
118
+ * namespace).
119
+ */
62
120
  typeName: string;
121
+ /**
122
+ * For extensions, this is the name of the type being extended. It is
123
+ * resolved in the same manner as type_name.
124
+ */
63
125
  extendee: string;
126
+ /**
127
+ * For numeric types, contains the original text representation of the value.
128
+ * For booleans, "true" or "false".
129
+ * For strings, contains the default text contents (not escaped in any way).
130
+ * For bytes, contains the C escaped value. All bytes >= 128 are escaped.
131
+ */
64
132
  defaultValue: string;
133
+ /**
134
+ * If set, gives the index of a oneof in the containing type's oneof_decl
135
+ * list. This field is a member of that oneof.
136
+ */
65
137
  oneofIndex: number;
138
+ /**
139
+ * JSON name of this field. The value is set by protocol compiler. If the
140
+ * user has set a "json_name" option on this field, that option's value
141
+ * will be used. Otherwise, it's deduced from the field's name by converting
142
+ * it to camelCase.
143
+ */
66
144
  jsonName: string;
67
145
  options: FieldOptions | undefined;
146
+ /**
147
+ * If true, this is a proto3 "optional". When a proto3 field is optional, it
148
+ * tracks presence regardless of field type.
149
+ *
150
+ * When proto3_optional is true, this field must be belong to a oneof to
151
+ * signal to old proto3 clients that presence is tracked for this field. This
152
+ * oneof is known as a "synthetic" oneof, and this field must be its sole
153
+ * member (each proto3 optional field gets its own synthetic oneof). Synthetic
154
+ * oneofs exist in the descriptor only, and do not generate any API. Synthetic
155
+ * oneofs must be ordered after all "real" oneofs.
156
+ *
157
+ * For message fields, proto3_optional doesn't create any semantic change,
158
+ * since non-repeated message fields always track presence. However it still
159
+ * indicates the semantic detail of whether the user wrote "optional" or not.
160
+ * This can be useful for round-tripping the .proto file. For consistency we
161
+ * give message fields a synthetic oneof also, even though it is not required
162
+ * to track presence. This is especially important because the parser can't
163
+ * tell if a field is a message or an enum, so it must always create a
164
+ * synthetic oneof.
165
+ *
166
+ * Proto2 optional fields do not set this flag, because they already indicate
167
+ * optional with `LABEL_OPTIONAL`.
168
+ */
169
+ proto3Optional: boolean;
68
170
  }
69
171
  /**
70
172
  * @public
71
173
  */
72
174
  export declare const enum FieldDescriptorProto_Type {
175
+ /**
176
+ * TYPE_DOUBLE - 0 is reserved for errors.
177
+ * Order is weird for historical reasons.
178
+ */
73
179
  TYPE_DOUBLE = 1,
74
180
  TYPE_FLOAT = 2,
181
+ /**
182
+ * TYPE_INT64 - Not ZigZag encoded. Negative numbers take 10 bytes. Use TYPE_SINT64 if
183
+ * negative values are likely.
184
+ */
75
185
  TYPE_INT64 = 3,
76
186
  TYPE_UINT64 = 4,
187
+ /**
188
+ * TYPE_INT32 - Not ZigZag encoded. Negative numbers take 10 bytes. Use TYPE_SINT32 if
189
+ * negative values are likely.
190
+ */
77
191
  TYPE_INT32 = 5,
78
192
  TYPE_FIXED64 = 6,
79
193
  TYPE_FIXED32 = 7,
80
194
  TYPE_BOOL = 8,
81
195
  TYPE_STRING = 9,
196
+ /**
197
+ * TYPE_GROUP - Tag-delimited aggregate.
198
+ * Group type is deprecated and not supported in proto3. However, Proto3
199
+ * implementations should still be able to parse the group wire format and
200
+ * treat group fields as unknown fields.
201
+ */
82
202
  TYPE_GROUP = 10,
203
+ /** TYPE_MESSAGE - Length-delimited aggregate. */
83
204
  TYPE_MESSAGE = 11,
205
+ /** TYPE_BYTES - New in version 2. */
84
206
  TYPE_BYTES = 12,
85
207
  TYPE_UINT32 = 13,
86
208
  TYPE_ENUM = 14,
87
209
  TYPE_SFIXED32 = 15,
88
210
  TYPE_SFIXED64 = 16,
211
+ /** TYPE_SINT32 - Uses ZigZag encoding. */
89
212
  TYPE_SINT32 = 17,
213
+ /** TYPE_SINT64 - Uses ZigZag encoding. */
90
214
  TYPE_SINT64 = 18
91
215
  }
92
216
  /**
93
217
  * @public
94
218
  */
95
219
  export declare const enum FieldDescriptorProto_Label {
220
+ /** LABEL_OPTIONAL - 0 is reserved for errors */
96
221
  LABEL_OPTIONAL = 1,
97
222
  LABEL_REQUIRED = 2,
98
223
  LABEL_REPEATED = 3
99
224
  }
225
+ /** Describes a oneof. */
100
226
  /**
101
227
  * @public
102
228
  */
@@ -104,6 +230,7 @@ export interface OneofDescriptorProto {
104
230
  name: string;
105
231
  options: OneofOptions | undefined;
106
232
  }
233
+ /** Describes an enum type. */
107
234
  /**
108
235
  * @public
109
236
  */
@@ -111,7 +238,36 @@ export interface EnumDescriptorProto {
111
238
  name: string;
112
239
  value: EnumValueDescriptorProto[];
113
240
  options: EnumOptions | undefined;
241
+ /**
242
+ * Range of reserved numeric values. Reserved numeric values may not be used
243
+ * by enum values in the same enum declaration. Reserved ranges may not
244
+ * overlap.
245
+ */
246
+ reservedRange: EnumDescriptorProto_EnumReservedRange[];
247
+ /**
248
+ * Reserved enum value names, which may not be reused. A given name may only
249
+ * be reserved once.
250
+ */
251
+ reservedName: string[];
114
252
  }
253
+ /**
254
+ * Range of reserved numeric values. Reserved values may not be used by
255
+ * entries in the same enum. Reserved ranges may not overlap.
256
+ *
257
+ * Note that this is distinct from DescriptorProto.ReservedRange in that it
258
+ * is inclusive such that it can appropriately represent the entire int32
259
+ * domain.
260
+ */
261
+ /**
262
+ * @public
263
+ */
264
+ export interface EnumDescriptorProto_EnumReservedRange {
265
+ /** Inclusive. */
266
+ start: number;
267
+ /** Inclusive. */
268
+ end: number;
269
+ }
270
+ /** Describes a value within an enum. */
115
271
  /**
116
272
  * @public
117
273
  */
@@ -120,6 +276,7 @@ export interface EnumValueDescriptorProto {
120
276
  number: number;
121
277
  options: EnumValueOptions | undefined;
122
278
  }
279
+ /** Describes a service. */
123
280
  /**
124
281
  * @public
125
282
  */
@@ -128,72 +285,316 @@ export interface ServiceDescriptorProto {
128
285
  method: MethodDescriptorProto[];
129
286
  options: ServiceOptions | undefined;
130
287
  }
288
+ /** Describes a method of a service. */
131
289
  /**
132
290
  * @public
133
291
  */
134
292
  export interface MethodDescriptorProto {
135
293
  name: string;
294
+ /**
295
+ * Input and output type names. These are resolved in the same way as
296
+ * FieldDescriptorProto.type_name, but must refer to a message type.
297
+ */
136
298
  inputType: string;
137
299
  outputType: string;
138
300
  options: MethodOptions | undefined;
301
+ /** Identifies if client streams multiple client messages */
139
302
  clientStreaming: boolean;
303
+ /** Identifies if server streams multiple server messages */
140
304
  serverStreaming: boolean;
141
305
  }
142
306
  /**
143
307
  * @public
144
308
  */
145
309
  export interface FileOptions {
310
+ /**
311
+ * Sets the Java package where classes generated from this .proto will be
312
+ * placed. By default, the proto package is used, but this is often
313
+ * inappropriate because proto packages do not normally start with backwards
314
+ * domain names.
315
+ */
146
316
  javaPackage: string;
317
+ /**
318
+ * Controls the name of the wrapper Java class generated for the .proto file.
319
+ * That class will always contain the .proto file's getDescriptor() method as
320
+ * well as any top-level extensions defined in the .proto file.
321
+ * If java_multiple_files is disabled, then all the other classes from the
322
+ * .proto file will be nested inside the single wrapper outer class.
323
+ */
147
324
  javaOuterClassname: string;
325
+ /**
326
+ * If enabled, then the Java code generator will generate a separate .java
327
+ * file for each top-level message, enum, and service defined in the .proto
328
+ * file. Thus, these types will *not* be nested inside the wrapper class
329
+ * named by java_outer_classname. However, the wrapper class will still be
330
+ * generated to contain the file's getDescriptor() method as well as any
331
+ * top-level extensions defined in the file.
332
+ */
148
333
  javaMultipleFiles: boolean;
149
- /** @deprecated */
334
+ /**
335
+ * This option does nothing.
336
+ *
337
+ * @deprecated
338
+ */
150
339
  javaGenerateEqualsAndHash: boolean;
340
+ /**
341
+ * If set true, then the Java2 code generator will generate code that
342
+ * throws an exception whenever an attempt is made to assign a non-UTF-8
343
+ * byte sequence to a string field.
344
+ * Message reflection will do the same.
345
+ * However, an extension field still accepts non-UTF-8 byte sequences.
346
+ * This option has no effect on when used with the lite runtime.
347
+ */
151
348
  javaStringCheckUtf8: boolean;
152
349
  optimizeFor: FileOptions_OptimizeMode;
350
+ /**
351
+ * Sets the Go package where structs generated from this .proto will be
352
+ * placed. If omitted, the Go package will be derived from the following:
353
+ * - The basename of the package import path, if provided.
354
+ * - Otherwise, the package statement in the .proto file, if present.
355
+ * - Otherwise, the basename of the .proto file, without extension.
356
+ */
153
357
  goPackage: string;
358
+ /**
359
+ * Should generic services be generated in each language? "Generic" services
360
+ * are not specific to any particular RPC system. They are generated by the
361
+ * main code generators in each language (without additional plugins).
362
+ * Generic services were the only kind of service generation supported by
363
+ * early versions of google.protobuf.
364
+ *
365
+ * Generic services are now considered deprecated in favor of using plugins
366
+ * that generate code specific to your particular RPC system. Therefore,
367
+ * these default to false. Old code which depends on generic services should
368
+ * explicitly set them to true.
369
+ */
154
370
  ccGenericServices: boolean;
155
371
  javaGenericServices: boolean;
156
372
  pyGenericServices: boolean;
373
+ phpGenericServices: boolean;
374
+ /**
375
+ * Is this file deprecated?
376
+ * Depending on the target platform, this can emit Deprecated annotations
377
+ * for everything in the file, or it will be completely ignored; in the very
378
+ * least, this is a formalization for deprecating files.
379
+ */
157
380
  deprecated: boolean;
381
+ /**
382
+ * Enables the use of arenas for the proto messages in this file. This applies
383
+ * only to generated classes for C++.
384
+ */
158
385
  ccEnableArenas: boolean;
386
+ /**
387
+ * Sets the objective c class prefix which is prepended to all objective c
388
+ * generated classes from this .proto. There is no default.
389
+ */
159
390
  objcClassPrefix: string;
391
+ /** Namespace for generated classes; defaults to the package. */
160
392
  csharpNamespace: string;
393
+ /**
394
+ * By default Swift generators will take the proto package and CamelCase it
395
+ * replacing '.' with underscore and use that to prefix the types/symbols
396
+ * defined. When this options is provided, they will use this value instead
397
+ * to prefix the types/symbols defined.
398
+ */
399
+ swiftPrefix: string;
400
+ /**
401
+ * Sets the php class prefix which is prepended to all php generated classes
402
+ * from this .proto. Default is empty.
403
+ */
404
+ phpClassPrefix: string;
405
+ /**
406
+ * Use this option to change the namespace of php generated classes. Default
407
+ * is empty. When this option is empty, the package name will be used for
408
+ * determining the namespace.
409
+ */
410
+ phpNamespace: string;
411
+ /**
412
+ * Use this option to change the namespace of php generated metadata classes.
413
+ * Default is empty. When this option is empty, the proto file name will be
414
+ * used for determining the namespace.
415
+ */
416
+ phpMetadataNamespace: string;
417
+ /**
418
+ * Use this option to change the package of ruby generated classes. Default
419
+ * is empty. When this option is not set, the package name will be used for
420
+ * determining the ruby package.
421
+ */
422
+ rubyPackage: string;
423
+ /**
424
+ * The parser stores options it doesn't recognize here.
425
+ * See the documentation for the "Options" section above.
426
+ */
161
427
  uninterpretedOption: UninterpretedOption[];
162
428
  }
429
+ /** Generated classes can be optimized for speed or code size. */
163
430
  /**
164
431
  * @public
165
432
  */
166
433
  export declare const enum FileOptions_OptimizeMode {
434
+ /** SPEED - Generate complete code for parsing, serialization, */
167
435
  SPEED = 1,
436
+ /** CODE_SIZE - etc. */
168
437
  CODE_SIZE = 2,
438
+ /** LITE_RUNTIME - Generate code using MessageLite and the lite runtime. */
169
439
  LITE_RUNTIME = 3
170
440
  }
171
441
  /**
172
442
  * @public
173
443
  */
174
444
  export interface MessageOptions {
445
+ /**
446
+ * Set true to use the old proto1 MessageSet wire format for extensions.
447
+ * This is provided for backwards-compatibility with the MessageSet wire
448
+ * format. You should not use this for any other reason: It's less
449
+ * efficient, has fewer features, and is more complicated.
450
+ *
451
+ * The message must be defined exactly as follows:
452
+ * message Foo {
453
+ * option message_set_wire_format = true;
454
+ * extensions 4 to max;
455
+ * }
456
+ * Note that the message cannot have any defined fields; MessageSets only
457
+ * have extensions.
458
+ *
459
+ * All extensions of your type must be singular messages; e.g. they cannot
460
+ * be int32s, enums, or repeated messages.
461
+ *
462
+ * Because this is an option, the above two restrictions are not enforced by
463
+ * the protocol compiler.
464
+ */
175
465
  messageSetWireFormat: boolean;
466
+ /**
467
+ * Disables the generation of the standard "descriptor()" accessor, which can
468
+ * conflict with a field of the same name. This is meant to make migration
469
+ * from proto1 easier; new code should avoid fields named "descriptor".
470
+ */
176
471
  noStandardDescriptorAccessor: boolean;
472
+ /**
473
+ * Is this message deprecated?
474
+ * Depending on the target platform, this can emit Deprecated annotations
475
+ * for the message, or it will be completely ignored; in the very least,
476
+ * this is a formalization for deprecating messages.
477
+ */
177
478
  deprecated: boolean;
479
+ /**
480
+ * Whether the message is an automatically generated map entry type for the
481
+ * maps field.
482
+ *
483
+ * For maps fields:
484
+ * map<KeyType, ValueType> map_field = 1;
485
+ * The parsed descriptor looks like:
486
+ * message MapFieldEntry {
487
+ * option map_entry = true;
488
+ * optional KeyType key = 1;
489
+ * optional ValueType value = 2;
490
+ * }
491
+ * repeated MapFieldEntry map_field = 1;
492
+ *
493
+ * Implementations may choose not to generate the map_entry=true message, but
494
+ * use a native map in the target language to hold the keys and values.
495
+ * The reflection APIs in such implementations still need to work as
496
+ * if the field is a repeated message field.
497
+ *
498
+ * NOTE: Do not set the option in .proto files. Always use the maps syntax
499
+ * instead. The option should only be implicitly set by the proto compiler
500
+ * parser.
501
+ */
178
502
  mapEntry: boolean;
503
+ /** The parser stores options it doesn't recognize here. See above. */
179
504
  uninterpretedOption: UninterpretedOption[];
180
505
  }
181
506
  /**
182
507
  * @public
183
508
  */
184
509
  export interface FieldOptions {
510
+ /**
511
+ * The ctype option instructs the C++ code generator to use a different
512
+ * representation of the field than it normally would. See the specific
513
+ * options below. This option is not yet implemented in the open source
514
+ * release -- sorry, we'll try to include it in a future version!
515
+ */
185
516
  ctype: FieldOptions_CType;
517
+ /**
518
+ * The packed option can be enabled for repeated primitive fields to enable
519
+ * a more efficient representation on the wire. Rather than repeatedly
520
+ * writing the tag and type for each element, the entire array is encoded as
521
+ * a single length-delimited blob. In proto3, only explicit setting it to
522
+ * false will avoid using packed encoding.
523
+ */
186
524
  packed: boolean;
525
+ /**
526
+ * The jstype option determines the JavaScript type used for values of the
527
+ * field. The option is permitted only for 64 bit integral and fixed types
528
+ * (int64, uint64, sint64, fixed64, sfixed64). A field with jstype JS_STRING
529
+ * is represented as JavaScript string, which avoids loss of precision that
530
+ * can happen when a large value is converted to a floating point JavaScript.
531
+ * Specifying JS_NUMBER for the jstype causes the generated JavaScript code to
532
+ * use the JavaScript "number" type. The behavior of the default option
533
+ * JS_NORMAL is implementation dependent.
534
+ *
535
+ * This option is an enum to permit additional types to be added, e.g.
536
+ * goog.math.Integer.
537
+ */
187
538
  jstype: FieldOptions_JSType;
539
+ /**
540
+ * Should this field be parsed lazily? Lazy applies only to message-type
541
+ * fields. It means that when the outer message is initially parsed, the
542
+ * inner message's contents will not be parsed but instead stored in encoded
543
+ * form. The inner message will actually be parsed when it is first accessed.
544
+ *
545
+ * This is only a hint. Implementations are free to choose whether to use
546
+ * eager or lazy parsing regardless of the value of this option. However,
547
+ * setting this option true suggests that the protocol author believes that
548
+ * using lazy parsing on this field is worth the additional bookkeeping
549
+ * overhead typically needed to implement it.
550
+ *
551
+ * This option does not affect the public interface of any generated code;
552
+ * all method signatures remain the same. Furthermore, thread-safety of the
553
+ * interface is not affected by this option; const methods remain safe to
554
+ * call from multiple threads concurrently, while non-const methods continue
555
+ * to require exclusive access.
556
+ *
557
+ * Note that implementations may choose not to check required fields within
558
+ * a lazy sub-message. That is, calling IsInitialized() on the outer message
559
+ * may return true even if the inner message has missing required fields.
560
+ * This is necessary because otherwise the inner message would have to be
561
+ * parsed in order to perform the check, defeating the purpose of lazy
562
+ * parsing. An implementation which chooses not to check required fields
563
+ * must be consistent about it. That is, for any particular sub-message, the
564
+ * implementation must either *always* check its required fields, or *never*
565
+ * check its required fields, regardless of whether or not the message has
566
+ * been parsed.
567
+ *
568
+ * As of 2021, lazy does no correctness checks on the byte stream during
569
+ * parsing. This may lead to crashes if and when an invalid byte stream is
570
+ * finally parsed upon access.
571
+ *
572
+ * TODO(b/211906113): Enable validation on lazy fields.
573
+ */
188
574
  lazy: boolean;
575
+ /**
576
+ * unverified_lazy does no correctness checks on the byte stream. This should
577
+ * only be used where lazy with verification is prohibitive for performance
578
+ * reasons.
579
+ */
580
+ unverifiedLazy: boolean;
581
+ /**
582
+ * Is this field deprecated?
583
+ * Depending on the target platform, this can emit Deprecated annotations
584
+ * for accessors, or it will be completely ignored; in the very least, this
585
+ * is a formalization for deprecating fields.
586
+ */
189
587
  deprecated: boolean;
588
+ /** For Google-internal migration only. Do not use. */
190
589
  weak: boolean;
590
+ /** The parser stores options it doesn't recognize here. See above. */
191
591
  uninterpretedOption: UninterpretedOption[];
192
592
  }
193
593
  /**
194
594
  * @public
195
595
  */
196
596
  export declare const enum FieldOptions_CType {
597
+ /** STRING - Default mode. */
197
598
  STRING = 0,
198
599
  CORD = 1,
199
600
  STRING_PIECE = 2
@@ -202,50 +603,114 @@ export declare const enum FieldOptions_CType {
202
603
  * @public
203
604
  */
204
605
  export declare const enum FieldOptions_JSType {
606
+ /** JS_NORMAL - Use the default type. */
205
607
  JS_NORMAL = 0,
608
+ /** JS_STRING - Use JavaScript strings. */
206
609
  JS_STRING = 1,
610
+ /** JS_NUMBER - Use JavaScript numbers. */
207
611
  JS_NUMBER = 2
208
612
  }
209
613
  /**
210
614
  * @public
211
615
  */
212
616
  export interface OneofOptions {
617
+ /** The parser stores options it doesn't recognize here. See above. */
213
618
  uninterpretedOption: UninterpretedOption[];
214
619
  }
215
620
  /**
216
621
  * @public
217
622
  */
218
623
  export interface EnumOptions {
624
+ /**
625
+ * Set this option to true to allow mapping different tag names to the same
626
+ * value.
627
+ */
219
628
  allowAlias: boolean;
629
+ /**
630
+ * Is this enum deprecated?
631
+ * Depending on the target platform, this can emit Deprecated annotations
632
+ * for the enum, or it will be completely ignored; in the very least, this
633
+ * is a formalization for deprecating enums.
634
+ */
220
635
  deprecated: boolean;
636
+ /** The parser stores options it doesn't recognize here. See above. */
221
637
  uninterpretedOption: UninterpretedOption[];
222
638
  }
223
639
  /**
224
640
  * @public
225
641
  */
226
642
  export interface EnumValueOptions {
643
+ /**
644
+ * Is this enum value deprecated?
645
+ * Depending on the target platform, this can emit Deprecated annotations
646
+ * for the enum value, or it will be completely ignored; in the very least,
647
+ * this is a formalization for deprecating enum values.
648
+ */
227
649
  deprecated: boolean;
650
+ /** The parser stores options it doesn't recognize here. See above. */
228
651
  uninterpretedOption: UninterpretedOption[];
229
652
  }
230
653
  /**
231
654
  * @public
232
655
  */
233
656
  export interface ServiceOptions {
657
+ /**
658
+ * Is this service deprecated?
659
+ * Depending on the target platform, this can emit Deprecated annotations
660
+ * for the service, or it will be completely ignored; in the very least,
661
+ * this is a formalization for deprecating services.
662
+ */
234
663
  deprecated: boolean;
664
+ /** The parser stores options it doesn't recognize here. See above. */
235
665
  uninterpretedOption: UninterpretedOption[];
236
666
  }
237
667
  /**
238
668
  * @public
239
669
  */
240
670
  export interface MethodOptions {
671
+ /**
672
+ * Is this method deprecated?
673
+ * Depending on the target platform, this can emit Deprecated annotations
674
+ * for the method, or it will be completely ignored; in the very least,
675
+ * this is a formalization for deprecating methods.
676
+ */
241
677
  deprecated: boolean;
678
+ idempotencyLevel: MethodOptions_IdempotencyLevel;
679
+ /** The parser stores options it doesn't recognize here. See above. */
242
680
  uninterpretedOption: UninterpretedOption[];
243
681
  }
682
+ /**
683
+ * Is this method side-effect-free (or safe in HTTP parlance), or idempotent,
684
+ * or neither? HTTP based RPC implementation may choose GET verb for safe
685
+ * methods, and PUT verb for idempotent methods instead of the default POST.
686
+ */
687
+ /**
688
+ * @public
689
+ */
690
+ export declare const enum MethodOptions_IdempotencyLevel {
691
+ IDEMPOTENCY_UNKNOWN = 0,
692
+ /** NO_SIDE_EFFECTS - implies idempotent */
693
+ NO_SIDE_EFFECTS = 1,
694
+ /** IDEMPOTENT - idempotent, but may have side effects */
695
+ IDEMPOTENT = 2
696
+ }
697
+ /**
698
+ * A message representing a option the parser does not recognize. This only
699
+ * appears in options protos created by the compiler::Parser class.
700
+ * DescriptorPool resolves these when building Descriptor objects. Therefore,
701
+ * options protos in descriptor objects (e.g. returned by Descriptor::options(),
702
+ * or produced by Descriptor::CopyTo()) will never have UninterpretedOptions
703
+ * in them.
704
+ */
244
705
  /**
245
706
  * @public
246
707
  */
247
708
  export interface UninterpretedOption {
248
709
  name: UninterpretedOption_NamePart[];
710
+ /**
711
+ * The value of the uninterpreted option, in whatever type the tokenizer
712
+ * identified it as during parsing. Exactly one of these should be set.
713
+ */
249
714
  identifierValue: string;
250
715
  positiveIntValue: number;
251
716
  negativeIntValue: number;
@@ -253,6 +718,13 @@ export interface UninterpretedOption {
253
718
  stringValue: Uint8Array;
254
719
  aggregateValue: string;
255
720
  }
721
+ /**
722
+ * The name of the uninterpreted option. Each string represents a segment in
723
+ * a dot-separated name. is_extension is true iff a segment represents an
724
+ * extension (denoted with parentheses in options specs in .proto files).
725
+ * E.g.,{ ["foo", false], ["bar.baz", true], ["qux", false] } represents
726
+ * "foo.(bar.baz).qux".
727
+ */
256
728
  /**
257
729
  * @public
258
730
  */
@@ -260,35 +732,188 @@ export interface UninterpretedOption_NamePart {
260
732
  namePart: string;
261
733
  isExtension: boolean;
262
734
  }
735
+ /**
736
+ * Encapsulates information about the original source file from which a
737
+ * FileDescriptorProto was generated.
738
+ */
263
739
  /**
264
740
  * @public
265
741
  */
266
742
  export interface SourceCodeInfo {
743
+ /**
744
+ * A Location identifies a piece of source code in a .proto file which
745
+ * corresponds to a particular definition. This information is intended
746
+ * to be useful to IDEs, code indexers, documentation generators, and similar
747
+ * tools.
748
+ *
749
+ * For example, say we have a file like:
750
+ * message Foo {
751
+ * optional string foo = 1;
752
+ * }
753
+ * Let's look at just the field definition:
754
+ * optional string foo = 1;
755
+ * ^ ^^ ^^ ^ ^^^
756
+ * a bc de f ghi
757
+ * We have the following locations:
758
+ * span path represents
759
+ * [a,i) [ 4, 0, 2, 0 ] The whole field definition.
760
+ * [a,b) [ 4, 0, 2, 0, 4 ] The label (optional).
761
+ * [c,d) [ 4, 0, 2, 0, 5 ] The type (string).
762
+ * [e,f) [ 4, 0, 2, 0, 1 ] The name (foo).
763
+ * [g,h) [ 4, 0, 2, 0, 3 ] The number (1).
764
+ *
765
+ * Notes:
766
+ * - A location may refer to a repeated field itself (i.e. not to any
767
+ * particular index within it). This is used whenever a set of elements are
768
+ * logically enclosed in a single code segment. For example, an entire
769
+ * extend block (possibly containing multiple extension definitions) will
770
+ * have an outer location whose path refers to the "extensions" repeated
771
+ * field without an index.
772
+ * - Multiple locations may have the same path. This happens when a single
773
+ * logical declaration is spread out across multiple places. The most
774
+ * obvious example is the "extend" block again -- there may be multiple
775
+ * extend blocks in the same scope, each of which will have the same path.
776
+ * - A location's span is not always a subset of its parent's span. For
777
+ * example, the "extendee" of an extension declaration appears at the
778
+ * beginning of the "extend" block and is shared by all extensions within
779
+ * the block.
780
+ * - Just because a location's span is a subset of some other location's span
781
+ * does not mean that it is a descendant. For example, a "group" defines
782
+ * both a type and a field in a single declaration. Thus, the locations
783
+ * corresponding to the type and field and their components will overlap.
784
+ * - Code which tries to interpret locations should probably be designed to
785
+ * ignore those that it doesn't understand, as more types of locations could
786
+ * be recorded in the future.
787
+ */
267
788
  location: SourceCodeInfo_Location[];
268
789
  }
269
790
  /**
270
791
  * @public
271
792
  */
272
793
  export interface SourceCodeInfo_Location {
794
+ /**
795
+ * Identifies which part of the FileDescriptorProto was defined at this
796
+ * location.
797
+ *
798
+ * Each element is a field number or an index. They form a path from
799
+ * the root FileDescriptorProto to the place where the definition occurs.
800
+ * For example, this path:
801
+ * [ 4, 3, 2, 7, 1 ]
802
+ * refers to:
803
+ * file.message_type(3) // 4, 3
804
+ * .field(7) // 2, 7
805
+ * .name() // 1
806
+ * This is because FileDescriptorProto.message_type has field number 4:
807
+ * repeated DescriptorProto message_type = 4;
808
+ * and DescriptorProto.field has field number 2:
809
+ * repeated FieldDescriptorProto field = 2;
810
+ * and FieldDescriptorProto.name has field number 1:
811
+ * optional string name = 1;
812
+ *
813
+ * Thus, the above path gives the location of a field name. If we removed
814
+ * the last element:
815
+ * [ 4, 3, 2, 7 ]
816
+ * this path refers to the whole field declaration (from the beginning
817
+ * of the label to the terminating semicolon).
818
+ */
273
819
  path: number[];
820
+ /**
821
+ * Always has exactly three or four elements: start line, start column,
822
+ * end line (optional, otherwise assumed same as start line), end column.
823
+ * These are packed into a single field for efficiency. Note that line
824
+ * and column numbers are zero-based -- typically you will want to add
825
+ * 1 to each before displaying to a user.
826
+ */
274
827
  span: number[];
828
+ /**
829
+ * If this SourceCodeInfo represents a complete declaration, these are any
830
+ * comments appearing before and after the declaration which appear to be
831
+ * attached to the declaration.
832
+ *
833
+ * A series of line comments appearing on consecutive lines, with no other
834
+ * tokens appearing on those lines, will be treated as a single comment.
835
+ *
836
+ * leading_detached_comments will keep paragraphs of comments that appear
837
+ * before (but not connected to) the current element. Each paragraph,
838
+ * separated by empty lines, will be one comment element in the repeated
839
+ * field.
840
+ *
841
+ * Only the comment content is provided; comment markers (e.g. //) are
842
+ * stripped out. For block comments, leading whitespace and an asterisk
843
+ * will be stripped from the beginning of each line other than the first.
844
+ * Newlines are included in the output.
845
+ *
846
+ * Examples:
847
+ *
848
+ * optional int32 foo = 1; // Comment attached to foo.
849
+ * // Comment attached to bar.
850
+ * optional int32 bar = 2;
851
+ *
852
+ * optional string baz = 3;
853
+ * // Comment attached to baz.
854
+ * // Another line attached to baz.
855
+ *
856
+ * // Comment attached to qux.
857
+ * //
858
+ * // Another line attached to qux.
859
+ * optional double qux = 4;
860
+ *
861
+ * // Detached comment for corge. This is not leading or trailing comments
862
+ * // to qux or corge because there are blank lines separating it from
863
+ * // both.
864
+ *
865
+ * // Detached comment for corge paragraph 2.
866
+ *
867
+ * optional string corge = 5;
868
+ * /* Block comment attached
869
+ * * to corge. Leading asterisks
870
+ * * will be removed. * /
871
+ * /* Block comment attached to
872
+ * * grault. * /
873
+ * optional int32 grault = 6;
874
+ *
875
+ * // ignored detached comments.
876
+ */
275
877
  leadingComments: string;
276
878
  trailingComments: string;
277
879
  leadingDetachedComments: string[];
278
880
  }
881
+ /**
882
+ * Describes the relationship between generated code and its original source
883
+ * file. A GeneratedCodeInfo message is associated with only one generated
884
+ * source file, but may contain references to different source .proto files.
885
+ */
279
886
  /**
280
887
  * @public
281
888
  */
282
889
  export interface GeneratedCodeInfo {
890
+ /**
891
+ * An Annotation connects some span of text in generated code to an element
892
+ * of its generating .proto file.
893
+ */
283
894
  annotation: GeneratedCodeInfo_Annotation[];
284
895
  }
285
896
  /**
286
897
  * @public
287
898
  */
288
899
  export interface GeneratedCodeInfo_Annotation {
900
+ /**
901
+ * Identifies the element in the original source .proto file. This field
902
+ * is formatted the same as SourceCodeInfo.Location.path.
903
+ */
289
904
  path: number[];
905
+ /** Identifies the filesystem path to the original source .proto. */
290
906
  sourceFile: string;
907
+ /**
908
+ * Identifies the starting offset in bytes in the generated code
909
+ * that relates to the identified object.
910
+ */
291
911
  begin: number;
912
+ /**
913
+ * Identifies the ending offset in bytes in the generated code that
914
+ * relates to the identified offset. The end offset should be one past
915
+ * the last relevant byte (so the length of the text = end - begin).
916
+ */
292
917
  end: number;
293
918
  }
294
919
  /**
@@ -326,6 +951,13 @@ export declare namespace DescriptorProto_ReservedRange {
326
951
  function encode(message: DescriptorProto_ReservedRange, writer?: _m0.Writer): _m0.Writer;
327
952
  function decode(input: _m0.Reader | Uint8Array, length?: number): DescriptorProto_ReservedRange;
328
953
  }
954
+ /**
955
+ * @public
956
+ */
957
+ export declare namespace ExtensionRangeOptions {
958
+ function encode(message: ExtensionRangeOptions, writer?: _m0.Writer): _m0.Writer;
959
+ function decode(input: _m0.Reader | Uint8Array, length?: number): ExtensionRangeOptions;
960
+ }
329
961
  /**
330
962
  * @public
331
963
  */
@@ -347,6 +979,13 @@ export declare namespace EnumDescriptorProto {
347
979
  function encode(message: EnumDescriptorProto, writer?: _m0.Writer): _m0.Writer;
348
980
  function decode(input: _m0.Reader | Uint8Array, length?: number): EnumDescriptorProto;
349
981
  }
982
+ /**
983
+ * @public
984
+ */
985
+ export declare namespace EnumDescriptorProto_EnumReservedRange {
986
+ function encode(message: EnumDescriptorProto_EnumReservedRange, writer?: _m0.Writer): _m0.Writer;
987
+ function decode(input: _m0.Reader | Uint8Array, length?: number): EnumDescriptorProto_EnumReservedRange;
988
+ }
350
989
  /**
351
990
  * @public
352
991
  */