ts-proto 1.87.1 → 1.88.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.
- package/CHANGELOG.md +7 -0
- package/README.markdown +189 -22
- package/build/encode.js +2 -0
- package/build/main.js +113 -3
- package/build/types.js +24 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,10 @@
|
|
|
1
|
+
# [1.88.0](https://github.com/stephenh/ts-proto/compare/v1.87.1...v1.88.0) (2021-11-22)
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
### Features
|
|
5
|
+
|
|
6
|
+
* Support for Google.Protobuf.Value, ListValue and Struct ([#396](https://github.com/stephenh/ts-proto/issues/396)) ([7dd9c16](https://github.com/stephenh/ts-proto/commit/7dd9c16ffdec4d9ea296fbdc30d390fe44192c42))
|
|
7
|
+
|
|
1
8
|
## [1.87.1](https://github.com/stephenh/ts-proto/compare/v1.87.0...v1.87.1) (2021-11-21)
|
|
2
9
|
|
|
3
10
|
|
package/README.markdown
CHANGED
|
@@ -22,10 +22,13 @@
|
|
|
22
22
|
- [Assumptions](#assumptions)
|
|
23
23
|
- [Todo](#todo)
|
|
24
24
|
- [OneOf Handling](#oneof-handling)
|
|
25
|
-
- [
|
|
25
|
+
- [Default Values and Unset Fields](#default-values-and-unset-fields)
|
|
26
|
+
- [Well-Known Types](#well-known-types)
|
|
27
|
+
- [Wrapper Types](#wrapper-types)
|
|
28
|
+
- [JSON Types (Struct Types)](#json-types-struct-types)
|
|
29
|
+
- [Timestamps](#timestamp)
|
|
26
30
|
- [Wrapper Types](#wrapper-types)
|
|
27
31
|
- [Number Types](#number-types)
|
|
28
|
-
- [Timestamps](#timestamps)
|
|
29
32
|
- [Current Status of Optional Values](#current-status-of-optional-values)
|
|
30
33
|
|
|
31
34
|
# Overview
|
|
@@ -399,29 +402,201 @@ As this will automatically enforce only one of `field_a` or `field_b` "being set
|
|
|
399
402
|
|
|
400
403
|
In ts-proto's currently-unscheduled 2.x release, `oneof=unions` will become the default behavior.
|
|
401
404
|
|
|
402
|
-
#
|
|
405
|
+
# Default values and unset fields
|
|
403
406
|
|
|
404
|
-
|
|
407
|
+
In core Protobuf, values that are _unset_ or equal to the default value are not sent over the wire.
|
|
408
|
+
The default value of a message is `undefined`. Primitive types take their natural default value, i.e. `string` is `''`, `number` is `0`, etc.
|
|
409
|
+
This behavior enables forward compatibility, as primitive fields will always have a value, even when omitted by outdated agents, but it also means _default_ and _unset_ values cannot be distinguished.
|
|
405
410
|
|
|
406
|
-
|
|
411
|
+
If you need primitive fields where you can detect set/unset, see [Wrapper Types](#wrapper-types).
|
|
407
412
|
|
|
408
|
-
|
|
413
|
+
**Encode / Decode**
|
|
409
414
|
|
|
410
|
-
|
|
415
|
+
`ts-proto` follows the Protobuf rules, and always returns default values for unsets fields when decoding, while omitting them from the output when serialized in binary format.
|
|
411
416
|
|
|
412
|
-
|
|
417
|
+
```protobuf
|
|
418
|
+
syntax = "proto3";
|
|
419
|
+
message Foo {
|
|
420
|
+
string bar = 1;
|
|
421
|
+
}
|
|
422
|
+
```
|
|
423
|
+
|
|
424
|
+
```typescript
|
|
425
|
+
protobufBytes; // assume this is an empty Foo object, in protobuf binary format
|
|
426
|
+
Foo.decode(protobufBytes); // => { bar: '' }
|
|
427
|
+
```
|
|
428
|
+
|
|
429
|
+
```typescript
|
|
430
|
+
Foo.encode({ bar: '' }); // => { }, writes an empty Foo object, in protobuf binary format
|
|
431
|
+
```
|
|
432
|
+
|
|
433
|
+
**fromJSON / toJSON**
|
|
434
|
+
|
|
435
|
+
Reading JSON will also initialize the default values. Since senders may either omit unset fields, or set them to the default value, use `fromJSON` to normalize the input.
|
|
436
|
+
|
|
437
|
+
```typescript
|
|
438
|
+
Foo.fromJSON({ }); // => { bar: '' }
|
|
439
|
+
Foo.fromJSON({ bar: '' }); // => { bar: '' }
|
|
440
|
+
Foo.fromJSON({ bar: 'baz' }); // => { bar: 'baz' }
|
|
441
|
+
```
|
|
442
|
+
|
|
443
|
+
When writing JSON, `ts-proto` currently does **not** normalize message when converting to JSON, other than omitting unset fields, but it may do so in the future.
|
|
444
|
+
|
|
445
|
+
```typescript
|
|
446
|
+
// Current ts-proto behavior
|
|
447
|
+
Foo.toJSON({ }); // => { }
|
|
448
|
+
Foo.toJSON({ bar: undefined }); // => { }
|
|
449
|
+
Foo.toJSON({ bar: '' }); // => { bar: '' } - note: this is the default value, but it's not omitted
|
|
450
|
+
Foo.toJSON({ bar: 'baz' }); // => { bar: 'baz' }
|
|
451
|
+
```
|
|
452
|
+
|
|
453
|
+
```typescript
|
|
454
|
+
// Possible future behavior, where ts-proto would normalize message
|
|
455
|
+
Foo.toJSON({ }); // => { }
|
|
456
|
+
Foo.toJSON({ bar: undefined }); // => { }
|
|
457
|
+
Foo.toJSON({ bar: '' }); // => { } - note: omitting the default value, as expected
|
|
458
|
+
Foo.toJSON({ bar: 'baz' }); // => { bar: 'baz' }
|
|
459
|
+
```
|
|
413
460
|
|
|
414
|
-
|
|
461
|
+
- Please open an issue if you need this behavior.
|
|
415
462
|
|
|
416
|
-
|
|
463
|
+
# Well-Known Types
|
|
417
464
|
|
|
418
|
-
|
|
465
|
+
Protobuf comes with several predefined message definitions, called "[Well-Known Types](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf)".
|
|
466
|
+
Their interpretation is defined by the Protobuf specification, and libraries are expected to convert these messages to corresponding native types in the target language.
|
|
419
467
|
|
|
420
|
-
|
|
468
|
+
`ts-proto` currently automatically converts these messages to their corresponding native types.
|
|
421
469
|
|
|
422
|
-
|
|
470
|
+
- Wrapper Types:
|
|
471
|
+
|
|
472
|
+
* [google.protobuf.DoubleValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#DoubleValue) ⇆ `number | undefined`
|
|
473
|
+
* [google.protobuf.FloatValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#FloatValue) ⇆ `number | undefined`
|
|
474
|
+
* [google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#Int64Value) ⇆ `number | undefined`
|
|
475
|
+
* [google.protobuf.UInt64Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#UInt64Value) ⇆ `number | undefined`
|
|
476
|
+
* [google.protobuf.Int32Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#Int32Value) ⇆ `number | undefined`
|
|
477
|
+
* [google.protobuf.UInt32Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#UInt32Value) ⇆ `number | undefined`
|
|
478
|
+
* [google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#BoolValue) ⇆ `boolean | undefined`
|
|
479
|
+
* [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#StringValue) ⇆ `string | undefined`
|
|
480
|
+
* [google.protobuf.BytesValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.BytesValue) ⇆ `Uint8Array | undefined`
|
|
481
|
+
|
|
482
|
+
- JSON Types (Struct Types):
|
|
483
|
+
|
|
484
|
+
* [google.protobuf.Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#Value) ⇆ `any | undefined` (i.e. `number | string | boolean | null | array | object`)
|
|
485
|
+
* [google.protobuf.ListValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#ListValue) ⇆ `any[]`
|
|
486
|
+
* [google.protobuf.Struct](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#Struct) ⇆ `{ [key: string]: any } | undefined`
|
|
487
|
+
|
|
488
|
+
## Wrapper Types
|
|
489
|
+
|
|
490
|
+
Wrapper Types are messages containing a single primitive field, and can be imported in `.proto` files with `import "google/protobuf/wrappers.proto"`.
|
|
491
|
+
|
|
492
|
+
|
|
493
|
+
Since these are _messages_, their default value is `undefined`, allowing you to distinguish unset primitives from their default values, when using Wrapper Types.
|
|
494
|
+
`ts-proto` generates these fields as `<primitive> | undefined`.
|
|
495
|
+
|
|
496
|
+
For example:
|
|
497
|
+
|
|
498
|
+
```protobuf
|
|
499
|
+
// Protobuf
|
|
500
|
+
syntax = "proto3";
|
|
501
|
+
|
|
502
|
+
import "google/protobuf/wrappers.proto";
|
|
503
|
+
|
|
504
|
+
message ExampleMessage {
|
|
505
|
+
google.protobuf.StringValue name = 1;
|
|
506
|
+
}
|
|
507
|
+
```
|
|
508
|
+
|
|
509
|
+
```typescript
|
|
510
|
+
// TypeScript
|
|
511
|
+
interface ExampleMessage {
|
|
512
|
+
name: string | undefined;
|
|
513
|
+
}
|
|
514
|
+
```
|
|
515
|
+
|
|
516
|
+
When encoding a message the primitive value is converted back to its corresponding wrapper type:
|
|
517
|
+
|
|
518
|
+
```typescript
|
|
519
|
+
ExampleMessage.encode({ name: 'foo' }) // => { name: { value: 'foo' } }, in binary
|
|
520
|
+
```
|
|
521
|
+
|
|
522
|
+
When calling toJSON, the value is not converted, because wrapper types are idiomatic in JSON.
|
|
523
|
+
|
|
524
|
+
```typescript
|
|
525
|
+
ExampleMessage.toJSON({ name: 'foo' }) // => { name: 'foo' }
|
|
526
|
+
```
|
|
527
|
+
|
|
528
|
+
## JSON Types (Struct Types)
|
|
529
|
+
|
|
530
|
+
Protobuf's language and types are not sufficient to represent all possible JSON values, since JSON may contain values whose type is unknown in advance.
|
|
531
|
+
For this reason, Protobuf offers several additional types to represent arbitrary JSON values.
|
|
532
|
+
|
|
533
|
+
These are called Struct Types, and can be imported in `.proto` files with `import "google/protobuf/struct.proto"`.
|
|
534
|
+
|
|
535
|
+
- [google.protobuf.Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#Value) ⇆ `any`
|
|
536
|
+
- This is the most general type, and can represent any JSON value (i.e. `number | string | boolean | null | array | object`).
|
|
537
|
+
- [google.protobuf.ListValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#ListValue) ⇆ `any[]`
|
|
538
|
+
- To represent a JSON array
|
|
539
|
+
- [google.protobuf.Struct](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#Struct) ⇆ `{ [key: string]: any }`
|
|
540
|
+
- To represent a JSON object
|
|
541
|
+
|
|
542
|
+
`ts-proto` automatically converts back and forth between these Struct Types and their corresponding JSON types.
|
|
543
|
+
|
|
544
|
+
Example:
|
|
545
|
+
|
|
546
|
+
```protobuf
|
|
547
|
+
// Protobuf
|
|
548
|
+
syntax = "proto3";
|
|
549
|
+
|
|
550
|
+
import "google/protobuf/struct.proto";
|
|
551
|
+
|
|
552
|
+
message ExampleMessage {
|
|
553
|
+
google.protobuf.Value anything = 1;
|
|
554
|
+
}
|
|
555
|
+
```
|
|
556
|
+
|
|
557
|
+
```typescript
|
|
558
|
+
// TypeScript
|
|
559
|
+
interface ExampleMessage {
|
|
560
|
+
anything: any | undefined;
|
|
561
|
+
}
|
|
562
|
+
```
|
|
563
|
+
|
|
564
|
+
Encoding a JSON value embedded in a message, converts it to a Struct Type:
|
|
565
|
+
```typescript
|
|
566
|
+
ExampleMessage.encode({ anything: { "name": "hello" } })
|
|
567
|
+
/* Outputs the following structure, encoded in protobuf binary format:
|
|
568
|
+
{
|
|
569
|
+
anything: Value {
|
|
570
|
+
structValue = Struct {
|
|
571
|
+
fields = [
|
|
572
|
+
MapEntry {
|
|
573
|
+
key = "name",
|
|
574
|
+
value = Value {
|
|
575
|
+
stringValue = "hello"
|
|
576
|
+
}
|
|
577
|
+
]
|
|
578
|
+
}
|
|
579
|
+
}
|
|
580
|
+
}
|
|
581
|
+
}*/
|
|
582
|
+
|
|
583
|
+
ExampleMessage.encode({ anything: true })
|
|
584
|
+
/* Outputs the following structure encoded in protobuf binary format:
|
|
585
|
+
{
|
|
586
|
+
anything: Value {
|
|
587
|
+
boolValue = true
|
|
588
|
+
}
|
|
589
|
+
}*/
|
|
590
|
+
```
|
|
591
|
+
|
|
592
|
+
## Timestamp
|
|
593
|
+
|
|
594
|
+
The representation of `google.protobuf.Timestamp` is configurable by the `useDate` flag.
|
|
595
|
+
|
|
596
|
+
| Protobuf well-known type | Default/`useDate=true` | `useDate=false` | `useDate=string` |
|
|
597
|
+
| --------------------------- | ---------------------- | ------------------------------------ | ---------------- |
|
|
598
|
+
| `google.protobuf.Timestamp` | `Date` | `{ seconds: number, nanos: number }` | `string` |
|
|
423
599
|
|
|
424
|
-
This makes dealing with `string | unset` in your code much nicer, albeit it's unfortunate that, in Protobuf core, this is not as simple as marking a `string name = 1` field as `optional`, i.e. you have to "dirty" your proto files a bit by knowing to use the `StringValue` convention.
|
|
425
600
|
|
|
426
601
|
# Number Types
|
|
427
602
|
|
|
@@ -452,14 +627,6 @@ The protobuf number types map to JavaScript types based on the `forceLong` confi
|
|
|
452
627
|
|
|
453
628
|
Where (\*) indicates they might throw an error at runtime.
|
|
454
629
|
|
|
455
|
-
# Timestamps
|
|
456
|
-
|
|
457
|
-
The representation of `google.protobuf.Timestamp` is configurable by the `useDate` flag.
|
|
458
|
-
|
|
459
|
-
| Protobuf well-known type | Default/`useDate=true` | `useDate=false` | `useDate=string` |
|
|
460
|
-
| --------------------------- | ---------------------- | ------------------------------------ | ---------------- |
|
|
461
|
-
| `google.protobuf.Timestamp` | `Date` | `{ seconds: number, nanos: number }` | `string` |
|
|
462
|
-
|
|
463
630
|
# Current Status of Optional Values
|
|
464
631
|
|
|
465
632
|
- Required primitives: use as-is, i.e. `string name = 1`.
|
package/build/encode.js
CHANGED
|
@@ -32,6 +32,8 @@ function generateEncoder(ctx, typeName) {
|
|
|
32
32
|
return ts_poet_1.code `${TypeValue}.encode({value: value ?? false}).finish()`;
|
|
33
33
|
case 'BytesValue':
|
|
34
34
|
return ts_poet_1.code `${TypeValue}.encode({value: value ?? new Uint8Array()}).finish()`;
|
|
35
|
+
case 'ListValue':
|
|
36
|
+
return ts_poet_1.code `${TypeValue}.encode({value: value ?? []]}).finish()`;
|
|
35
37
|
}
|
|
36
38
|
throw new Error(`unknown wrapper type: ${name}`);
|
|
37
39
|
}
|
package/build/main.js
CHANGED
|
@@ -184,6 +184,7 @@ function makeUtils(options) {
|
|
|
184
184
|
...makeDeepPartial(options, longs),
|
|
185
185
|
...makeTimestampMethods(options, longs),
|
|
186
186
|
...longs,
|
|
187
|
+
...makeWrappingUtils(),
|
|
187
188
|
};
|
|
188
189
|
}
|
|
189
190
|
exports.makeUtils = makeUtils;
|
|
@@ -240,6 +241,57 @@ function makeLongUtils(options, bytes) {
|
|
|
240
241
|
`);
|
|
241
242
|
return { numberToLong, longToNumber, longToString, longInit, Long };
|
|
242
243
|
}
|
|
244
|
+
function makeWrappingUtils() {
|
|
245
|
+
const wrapAnyValue = ts_poet_1.conditionalOutput('wrapAnyValue', ts_poet_1.code `function wrapAnyValue(value: any): Value {
|
|
246
|
+
if (value === null) {
|
|
247
|
+
return {nullValue: 0} as Value;
|
|
248
|
+
} else if (typeof value === 'boolean') {
|
|
249
|
+
return {boolValue: value} as Value;
|
|
250
|
+
} else if (typeof value === 'number') {
|
|
251
|
+
return {numberValue: value} as Value;
|
|
252
|
+
} else if (typeof value === 'string') {
|
|
253
|
+
return {stringValue: value} as Value;
|
|
254
|
+
} else if (Array.isArray(value)) {
|
|
255
|
+
return {listValue: value} as Value;
|
|
256
|
+
} else if (typeof value === 'object') {
|
|
257
|
+
return {structValue: value} as Value;
|
|
258
|
+
} else if (typeof value === 'undefined') {
|
|
259
|
+
return {} as Value;
|
|
260
|
+
} else {
|
|
261
|
+
throw new Error('Unsupported any value type: ' + typeof value);
|
|
262
|
+
}
|
|
263
|
+
}`);
|
|
264
|
+
const unwrapAnyValue = ts_poet_1.conditionalOutput('unwrapAnyValue', ts_poet_1.code `function unwrapAnyValue(value: Value): string | number | boolean | Object | null | Array<any> | undefined {
|
|
265
|
+
if (value.stringValue !== undefined) {
|
|
266
|
+
return value.stringValue;
|
|
267
|
+
} else if (value.numberValue !== undefined) {
|
|
268
|
+
return value.numberValue;
|
|
269
|
+
} else if (value.boolValue !== undefined) {
|
|
270
|
+
return value.boolValue;
|
|
271
|
+
} else if (value.structValue !== undefined) {
|
|
272
|
+
return value.structValue;
|
|
273
|
+
} else if (value.listValue !== undefined) {
|
|
274
|
+
return value.listValue;
|
|
275
|
+
} else if (value.nullValue !== undefined) {
|
|
276
|
+
return null;
|
|
277
|
+
}
|
|
278
|
+
}`);
|
|
279
|
+
const wrapStruct = ts_poet_1.conditionalOutput('wrapStruct', ts_poet_1.code `function wrapStruct(object: {[key: string]: any}): Struct {
|
|
280
|
+
const struct = Struct.fromPartial({});
|
|
281
|
+
Object.keys(object).forEach(key => {
|
|
282
|
+
struct.fields[key] = object[key];
|
|
283
|
+
});
|
|
284
|
+
return struct;
|
|
285
|
+
}`);
|
|
286
|
+
const unwrapStruct = ts_poet_1.conditionalOutput('unwrapStruct', ts_poet_1.code `function unwrapStruct(struct: Struct): {[key: string]: any} {
|
|
287
|
+
const object: { [key: string]: any } = {};
|
|
288
|
+
Object.keys(struct.fields).forEach(key => {
|
|
289
|
+
object[key] = struct.fields[key];
|
|
290
|
+
});
|
|
291
|
+
return object;
|
|
292
|
+
}`);
|
|
293
|
+
return { wrapAnyValue, unwrapAnyValue, wrapStruct, unwrapStruct };
|
|
294
|
+
}
|
|
243
295
|
function makeByteUtils() {
|
|
244
296
|
const globalThis = ts_poet_1.conditionalOutput('globalThis', ts_poet_1.code `
|
|
245
297
|
declare var self: any | undefined;
|
|
@@ -528,8 +580,18 @@ function generateDecode(ctx, fullName, messageDesc) {
|
|
|
528
580
|
}
|
|
529
581
|
}
|
|
530
582
|
else if (types_1.isValueType(ctx, field)) {
|
|
583
|
+
const unwrap = (decodedValue) => {
|
|
584
|
+
if (types_1.isAnyValueType(field))
|
|
585
|
+
return ts_poet_1.code `${ctx.utils.unwrapAnyValue}(${decodedValue})`;
|
|
586
|
+
if (types_1.isStructType(field))
|
|
587
|
+
return ts_poet_1.code `${ctx.utils.unwrapStruct}(${decodedValue})`;
|
|
588
|
+
if (types_1.isListValueType(field))
|
|
589
|
+
return ts_poet_1.code `${decodedValue}.values`;
|
|
590
|
+
return ts_poet_1.code `${decodedValue}.value`;
|
|
591
|
+
};
|
|
531
592
|
const type = types_1.basicTypeName(ctx, field, { keepValueType: true });
|
|
532
|
-
|
|
593
|
+
const decoder = ts_poet_1.code `${type}.decode(reader, reader.uint32())`;
|
|
594
|
+
readSnippet = ts_poet_1.code `${unwrap(decoder)}`;
|
|
533
595
|
}
|
|
534
596
|
else if (types_1.isTimestamp(field) && (options.useDate === options_1.DateOption.DATE || options.useDate === options_1.DateOption.STRING)) {
|
|
535
597
|
const type = types_1.basicTypeName(ctx, field, { keepValueType: true });
|
|
@@ -624,10 +686,19 @@ function generateEncode(ctx, fullName, messageDesc) {
|
|
|
624
686
|
writeSnippet = (place) => ts_poet_1.code `${type}.encode(${utils.toTimestamp}(${place}), writer.uint32(${tag}).fork()).ldelim()`;
|
|
625
687
|
}
|
|
626
688
|
else if (types_1.isValueType(ctx, field)) {
|
|
689
|
+
const maybeTypeField = options.outputTypeRegistry ? `$type: '${field.typeName.slice(1)}',` : '';
|
|
690
|
+
const wrappedValue = (place) => {
|
|
691
|
+
if (types_1.isAnyValueType(field))
|
|
692
|
+
return ts_poet_1.code `${ctx.utils.wrapAnyValue}(${place})`;
|
|
693
|
+
if (types_1.isListValueType(field))
|
|
694
|
+
return ts_poet_1.code `{values: ${place}}`;
|
|
695
|
+
if (types_1.isStructType(field))
|
|
696
|
+
return ts_poet_1.code `${ctx.utils.wrapStruct}(${place})`;
|
|
697
|
+
return ts_poet_1.code `{${maybeTypeField} value: ${place}!}`;
|
|
698
|
+
};
|
|
627
699
|
const tag = ((field.number << 3) | 2) >>> 0;
|
|
628
700
|
const type = types_1.basicTypeName(ctx, field, { keepValueType: true });
|
|
629
|
-
|
|
630
|
-
writeSnippet = (place) => ts_poet_1.code `${type}.encode({ ${maybeTypeField} value: ${place}! }, writer.uint32(${tag}).fork()).ldelim()`;
|
|
701
|
+
writeSnippet = (place) => ts_poet_1.code `${type}.encode(${wrappedValue(place)}, writer.uint32(${tag}).fork()).ldelim()`;
|
|
631
702
|
}
|
|
632
703
|
else if (types_1.isMessage(field)) {
|
|
633
704
|
const tag = ((field.number << 3) | 2) >>> 0;
|
|
@@ -775,6 +846,9 @@ function generateFromJson(ctx, fullName, messageDesc) {
|
|
|
775
846
|
(options.useDate === options_1.DateOption.DATE || options.useDate === options_1.DateOption.TIMESTAMP)) {
|
|
776
847
|
return ts_poet_1.code `${utils.fromJsonTimestamp}(${from})`;
|
|
777
848
|
}
|
|
849
|
+
else if (types_1.isAnyValueType(field) || types_1.isStructType(field)) {
|
|
850
|
+
return ts_poet_1.code `${from}`;
|
|
851
|
+
}
|
|
778
852
|
else if (types_1.isValueType(ctx, field)) {
|
|
779
853
|
const valueType = types_1.valueTypeName(ctx, field.typeName);
|
|
780
854
|
if (types_1.isLongValueType(field) && options.forceLong === options_1.LongOption.LONG) {
|
|
@@ -783,6 +857,9 @@ function generateFromJson(ctx, fullName, messageDesc) {
|
|
|
783
857
|
else if (types_1.isBytesValueType(field)) {
|
|
784
858
|
return ts_poet_1.code `new ${case_1.capitalize(valueType.toCodeString())}(${from})`;
|
|
785
859
|
}
|
|
860
|
+
else if (types_1.isListValueType(field)) {
|
|
861
|
+
return ts_poet_1.code `[...${from}]`;
|
|
862
|
+
}
|
|
786
863
|
else {
|
|
787
864
|
return ts_poet_1.code `${case_1.capitalize(valueType.toCodeString())}(${from})`;
|
|
788
865
|
}
|
|
@@ -822,6 +899,9 @@ function generateFromJson(ctx, fullName, messageDesc) {
|
|
|
822
899
|
const type = types_1.basicTypeName(ctx, valueType);
|
|
823
900
|
return ts_poet_1.code `${from} as ${type}`;
|
|
824
901
|
}
|
|
902
|
+
else if (types_1.isAnyValueType(valueType)) {
|
|
903
|
+
return ts_poet_1.code `${from}`;
|
|
904
|
+
}
|
|
825
905
|
else {
|
|
826
906
|
const type = types_1.basicTypeName(ctx, valueType);
|
|
827
907
|
return ts_poet_1.code `${type}.fromJSON(${from})`;
|
|
@@ -849,6 +929,11 @@ function generateFromJson(ctx, fullName, messageDesc) {
|
|
|
849
929
|
`);
|
|
850
930
|
chunks.push(ts_poet_1.code `}`);
|
|
851
931
|
}
|
|
932
|
+
else if (types_1.isAnyValueType(field)) {
|
|
933
|
+
chunks.push(ts_poet_1.code `
|
|
934
|
+
message.${fieldName} = Array.isArray(object?.${fieldName}) ? [...object.${fieldName}] : [];
|
|
935
|
+
`);
|
|
936
|
+
}
|
|
852
937
|
else {
|
|
853
938
|
// Explicit `any` type required to make TS with noImplicitAny happy. `object` is also `any` here.
|
|
854
939
|
chunks.push(ts_poet_1.code `
|
|
@@ -864,6 +949,19 @@ function generateFromJson(ctx, fullName, messageDesc) {
|
|
|
864
949
|
`);
|
|
865
950
|
chunks.push(ts_poet_1.code `}`);
|
|
866
951
|
}
|
|
952
|
+
else if (types_1.isAnyValueType(field)) {
|
|
953
|
+
chunks.push(ts_poet_1.code `message.${fieldName} = object.${fieldName};`);
|
|
954
|
+
}
|
|
955
|
+
else if (types_1.isStructType(field)) {
|
|
956
|
+
chunks.push(ts_poet_1.code `message.${fieldName} = typeof(object.${fieldName}) === 'object' ? object.${fieldName} : undefined;`);
|
|
957
|
+
}
|
|
958
|
+
else if (types_1.isListValueType(field)) {
|
|
959
|
+
chunks.push(ts_poet_1.code `
|
|
960
|
+
message.${fieldName} = Array.isArray(object?.${fieldName})
|
|
961
|
+
? ${readSnippet(`object.${fieldName}`)}
|
|
962
|
+
: ${'undefined'};
|
|
963
|
+
`);
|
|
964
|
+
}
|
|
867
965
|
else {
|
|
868
966
|
const fallback = types_1.isWithinOneOf(field) ? 'undefined' : types_1.defaultValue(ctx, field);
|
|
869
967
|
chunks.push(ts_poet_1.code `
|
|
@@ -930,11 +1028,17 @@ function generateToJson(ctx, fullName, messageDesc) {
|
|
|
930
1028
|
else if (types_1.isScalar(valueType) || types_1.isValueType(ctx, valueType)) {
|
|
931
1029
|
return ts_poet_1.code `${from}`;
|
|
932
1030
|
}
|
|
1031
|
+
else if (types_1.isAnyValueType(valueType)) {
|
|
1032
|
+
return ts_poet_1.code `${from}`;
|
|
1033
|
+
}
|
|
933
1034
|
else {
|
|
934
1035
|
const type = types_1.basicTypeName(ctx, valueType);
|
|
935
1036
|
return ts_poet_1.code `${type}.toJSON(${from})`;
|
|
936
1037
|
}
|
|
937
1038
|
}
|
|
1039
|
+
else if (types_1.isAnyValueType(field)) {
|
|
1040
|
+
return ts_poet_1.code `${from}`;
|
|
1041
|
+
}
|
|
938
1042
|
else if (types_1.isMessage(field) && !types_1.isValueType(ctx, field) && !types_1.isMapType(ctx, messageDesc, field)) {
|
|
939
1043
|
const type = types_1.basicTypeName(ctx, field, { keepValueType: true });
|
|
940
1044
|
return ts_poet_1.code `${from} ? ${type}.toJSON(${from}) : ${types_1.defaultValue(ctx, field)}`;
|
|
@@ -1030,6 +1134,9 @@ function generateFromPartial(ctx, fullName, messageDesc) {
|
|
|
1030
1134
|
return ts_poet_1.code `${cstr}(${from})`;
|
|
1031
1135
|
}
|
|
1032
1136
|
}
|
|
1137
|
+
else if (types_1.isAnyValueType(valueType)) {
|
|
1138
|
+
return ts_poet_1.code `${from}`;
|
|
1139
|
+
}
|
|
1033
1140
|
else if (types_1.isTimestamp(valueType) &&
|
|
1034
1141
|
(options.useDate === options_1.DateOption.DATE || options.useDate === options_1.DateOption.STRING)) {
|
|
1035
1142
|
return ts_poet_1.code `${from}`;
|
|
@@ -1042,6 +1149,9 @@ function generateFromPartial(ctx, fullName, messageDesc) {
|
|
|
1042
1149
|
return ts_poet_1.code `${type}.fromPartial(${from})`;
|
|
1043
1150
|
}
|
|
1044
1151
|
}
|
|
1152
|
+
else if (types_1.isAnyValueType(field)) {
|
|
1153
|
+
return ts_poet_1.code `${from}`;
|
|
1154
|
+
}
|
|
1045
1155
|
else {
|
|
1046
1156
|
const type = types_1.basicTypeName(ctx, field);
|
|
1047
1157
|
return ts_poet_1.code `${type}.fromPartial(${from})`;
|
package/build/types.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.detectBatchMethod = exports.responsePromiseOrObservable = exports.responseObservable = exports.responsePromise = exports.responseType = exports.requestType = exports.rawRequestType = exports.detectMapType = exports.toTypeName = exports.getEnumMethod = exports.messageToTypeName = exports.wrapperTypeName = exports.valueTypeName = exports.isEmptyType = exports.isLongValueType = exports.isBytesValueType = exports.isValueType = exports.isTimestamp = exports.isMapType = exports.isLong = exports.isRepeated = exports.isWithinOneOfThatShouldBeUnion = exports.isWithinOneOf = exports.isEnum = exports.isMessage = exports.isBytes = exports.isPrimitive = exports.isScalar = exports.createTypeMap = exports.notDefaultCheck = exports.defaultValue = exports.packedType = exports.toReaderCall = exports.basicTypeName = exports.basicLongWireType = exports.basicWireType = void 0;
|
|
3
|
+
exports.detectBatchMethod = exports.responsePromiseOrObservable = exports.responseObservable = exports.responsePromise = exports.responseType = exports.requestType = exports.rawRequestType = exports.detectMapType = exports.toTypeName = exports.getEnumMethod = exports.messageToTypeName = exports.wrapperTypeName = exports.valueTypeName = exports.isEmptyType = exports.isLongValueType = exports.isStructType = exports.isListValueTypeName = exports.isListValueType = exports.isBytesValueType = exports.isAnyValueType = exports.isValueType = exports.isTimestamp = exports.isMapType = exports.isLong = exports.isRepeated = exports.isWithinOneOfThatShouldBeUnion = exports.isWithinOneOf = exports.isEnum = exports.isMessage = exports.isBytes = exports.isPrimitive = exports.isScalar = exports.createTypeMap = exports.notDefaultCheck = exports.defaultValue = exports.packedType = exports.toReaderCall = exports.basicTypeName = exports.basicLongWireType = exports.basicWireType = void 0;
|
|
4
4
|
const ts_proto_descriptors_1 = require("ts-proto-descriptors");
|
|
5
5
|
const ts_poet_1 = require("ts-poet");
|
|
6
6
|
const options_1 = require("./options");
|
|
@@ -359,10 +359,26 @@ function isValueType(ctx, field) {
|
|
|
359
359
|
return valueTypeName(ctx, field.typeName) !== undefined;
|
|
360
360
|
}
|
|
361
361
|
exports.isValueType = isValueType;
|
|
362
|
+
function isAnyValueType(field) {
|
|
363
|
+
return field.typeName === '.google.protobuf.Value';
|
|
364
|
+
}
|
|
365
|
+
exports.isAnyValueType = isAnyValueType;
|
|
362
366
|
function isBytesValueType(field) {
|
|
363
367
|
return field.typeName === '.google.protobuf.BytesValue';
|
|
364
368
|
}
|
|
365
369
|
exports.isBytesValueType = isBytesValueType;
|
|
370
|
+
function isListValueType(field) {
|
|
371
|
+
return isListValueTypeName(field.typeName);
|
|
372
|
+
}
|
|
373
|
+
exports.isListValueType = isListValueType;
|
|
374
|
+
function isListValueTypeName(typeName) {
|
|
375
|
+
return typeName === 'google.protobuf.ListValue' || typeName === '.google.protobuf.ListValue';
|
|
376
|
+
}
|
|
377
|
+
exports.isListValueTypeName = isListValueTypeName;
|
|
378
|
+
function isStructType(field) {
|
|
379
|
+
return field.typeName === '.google.protobuf.Struct';
|
|
380
|
+
}
|
|
381
|
+
exports.isStructType = isStructType;
|
|
366
382
|
function isLongValueType(field) {
|
|
367
383
|
return field.typeName === '.google.protobuf.Int64Value' || field.typeName === '.google.protobuf.UInt64Value';
|
|
368
384
|
}
|
|
@@ -388,6 +404,12 @@ function valueTypeName(ctx, typeName) {
|
|
|
388
404
|
return ts_poet_1.code `boolean`;
|
|
389
405
|
case '.google.protobuf.BytesValue':
|
|
390
406
|
return ts_poet_1.code `Uint8Array`;
|
|
407
|
+
case '.google.protobuf.ListValue':
|
|
408
|
+
return ts_poet_1.code `Array<any>`;
|
|
409
|
+
case '.google.protobuf.Value':
|
|
410
|
+
return ts_poet_1.code `any`;
|
|
411
|
+
case '.google.protobuf.Struct':
|
|
412
|
+
return ts_poet_1.code `{[key: string]: any}`;
|
|
391
413
|
default:
|
|
392
414
|
return undefined;
|
|
393
415
|
}
|
|
@@ -404,6 +426,7 @@ function wrapperTypeName(typeName) {
|
|
|
404
426
|
case '.google.protobuf.UInt64Value':
|
|
405
427
|
case '.google.protobuf.BoolValue':
|
|
406
428
|
case '.google.protobuf.BytesValue':
|
|
429
|
+
case '.google.protobuf.ListValue':
|
|
407
430
|
case '.google.protobuf.Timestamp':
|
|
408
431
|
return typeName.split('.')[3];
|
|
409
432
|
default:
|