Skip to content

Commit

Permalink
feat: Add support for useDate=string (#221)
Browse files Browse the repository at this point in the history
* Add support for useDate=string

Co-authored-by: @actuosus <[email protected]>
Co-authored-by: @jessebutterfield <[email protected]>

* fix: remove redundant check for undefined

* fix: run codegen again for changes in master

* fix: update-bins and run codegen again for changes in master

This is libprotoc 3.13.0, I guess it's the expected version otherwise there
would be more changes than this.

Co-authored-by: @actuosus <[email protected]>
Co-authored-by: @jessebutterfield <[email protected]>
  • Loading branch information
3 people authored Apr 2, 2021
1 parent 94b9522 commit d967a9a
Show file tree
Hide file tree
Showing 28 changed files with 1,218 additions and 81 deletions.
11 changes: 10 additions & 1 deletion README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
- [Primitive Types](#primitive-types)
- [Wrapper Types](#wrapper-types)
- [Number Types](#number-types)
- [Timestamps](#timestamps)
- [Current Status of Optional Values](#current-status-of-optional-values)

# Overview
Expand Down Expand Up @@ -292,7 +293,7 @@ protoc --plugin=node_modules/ts-proto/protoc-gen-ts_proto ./batching.proto -I.

Note that `addGrpcMetadata`, `addNestjsRestParameter` and `returnObservable` will still be false.

- With `--ts_proto_opt=useDate=false`, fields of type `google.protobuf.Timestamp` will not be mapped to type `Date` in the generated types.
- With `--ts_proto_opt=useDate=false`, fields of type `google.protobuf.Timestamp` will not be mapped to type `Date` in the generated types. See [Timestamps](#timestamps) for more details.

- With `--ts_proto_opt=outputSchema=true`, meta typings will be generated that can later be used in other code generators.

Expand Down Expand Up @@ -411,6 +412,14 @@ The protobuf number types map to JavaScript types based on the `forceLong` confi

Where (\*) indicates they might throw an error at runtime.

# Timestamps

The representation of `google.protobuf.Timestamp` is configurable by the `useDate` flag.

| Protobuf well-known type | Default/`useDate=true` | `useDate=false` | `useDate=string` |
| --------------------------- | ---------------------- | ------------------------------------ | ---------------- |
| `google.protobuf.Timestamp` | `Date` | `{ seconds: number, nanos: number }` | `string` |

# Current Status of Optional Values

- Required primitives: use as-is, i.e. `string name = 1`.
Expand Down
3 changes: 1 addition & 2 deletions integration/simple-optionals/import_dir/thing.ts
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,7 @@ export const ImportedThing = {

toJSON(message: ImportedThing): unknown {
const obj: any = {};
message.createdAt !== undefined &&
(obj.createdAt = message.createdAt !== undefined ? message.createdAt.toISOString() : null);
message.createdAt !== undefined && (obj.createdAt = message.createdAt.toISOString());
return obj;
},

Expand Down
3 changes: 1 addition & 2 deletions integration/simple-optionals/simple.ts
Original file line number Diff line number Diff line change
Expand Up @@ -402,8 +402,7 @@ export const Simple = {
const obj: any = {};
message.name !== undefined && (obj.name = message.name);
message.age !== undefined && (obj.age = message.age);
message.createdAt !== undefined &&
(obj.createdAt = message.createdAt !== undefined ? message.createdAt.toISOString() : null);
message.createdAt !== undefined && (obj.createdAt = message.createdAt.toISOString());
message.child !== undefined && (obj.child = message.child ? Child.toJSON(message.child) : undefined);
message.state !== undefined && (obj.state = stateEnumToJSON(message.state));
if (message.grandChildren) {
Expand Down
3 changes: 1 addition & 2 deletions integration/simple-optionals/thing.ts
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,7 @@ export const ImportedThing = {

toJSON(message: ImportedThing): unknown {
const obj: any = {};
message.createdAt !== undefined &&
(obj.createdAt = message.createdAt !== undefined ? message.createdAt.toISOString() : null);
message.createdAt !== undefined && (obj.createdAt = message.createdAt.toISOString());
return obj;
},

Expand Down
3 changes: 1 addition & 2 deletions integration/simple-snake/import_dir/thing.ts
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,7 @@ export const ImportedThing = {

toJSON(message: ImportedThing): unknown {
const obj: any = {};
message.created_at !== undefined &&
(obj.created_at = message.created_at !== undefined ? message.created_at.toISOString() : null);
message.created_at !== undefined && (obj.created_at = message.created_at.toISOString());
return obj;
},

Expand Down
3 changes: 1 addition & 2 deletions integration/simple-snake/simple.ts
Original file line number Diff line number Diff line change
Expand Up @@ -402,8 +402,7 @@ export const Simple = {
const obj: any = {};
message.name !== undefined && (obj.name = message.name);
message.age !== undefined && (obj.age = message.age);
message.created_at !== undefined &&
(obj.created_at = message.created_at !== undefined ? message.created_at.toISOString() : null);
message.created_at !== undefined && (obj.created_at = message.created_at.toISOString());
message.child !== undefined && (obj.child = message.child ? Child.toJSON(message.child) : undefined);
message.state !== undefined && (obj.state = stateEnumToJSON(message.state));
if (message.grand_children) {
Expand Down
3 changes: 1 addition & 2 deletions integration/simple-unrecognized-enum/import_dir/thing.ts
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,7 @@ export const ImportedThing = {

toJSON(message: ImportedThing): unknown {
const obj: any = {};
message.createdAt !== undefined &&
(obj.createdAt = message.createdAt !== undefined ? message.createdAt.toISOString() : null);
message.createdAt !== undefined && (obj.createdAt = message.createdAt.toISOString());
return obj;
},

Expand Down
3 changes: 1 addition & 2 deletions integration/simple-unrecognized-enum/simple.ts
Original file line number Diff line number Diff line change
Expand Up @@ -393,8 +393,7 @@ export const Simple = {
const obj: any = {};
message.name !== undefined && (obj.name = message.name);
message.age !== undefined && (obj.age = message.age);
message.createdAt !== undefined &&
(obj.createdAt = message.createdAt !== undefined ? message.createdAt.toISOString() : null);
message.createdAt !== undefined && (obj.createdAt = message.createdAt.toISOString());
message.child !== undefined && (obj.child = message.child ? Child.toJSON(message.child) : undefined);
message.state !== undefined && (obj.state = stateEnumToJSON(message.state));
if (message.grandChildren) {
Expand Down
3 changes: 1 addition & 2 deletions integration/simple/import_dir/thing.ts
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,7 @@ export const ImportedThing = {

toJSON(message: ImportedThing): unknown {
const obj: any = {};
message.createdAt !== undefined &&
(obj.createdAt = message.createdAt !== undefined ? message.createdAt.toISOString() : null);
message.createdAt !== undefined && (obj.createdAt = message.createdAt.toISOString());
return obj;
},

Expand Down
8 changes: 3 additions & 5 deletions integration/simple/simple.ts
Original file line number Diff line number Diff line change
Expand Up @@ -480,8 +480,7 @@ export const Simple = {
const obj: any = {};
message.name !== undefined && (obj.name = message.name);
message.age !== undefined && (obj.age = message.age);
message.createdAt !== undefined &&
(obj.createdAt = message.createdAt !== undefined ? message.createdAt.toISOString() : null);
message.createdAt !== undefined && (obj.createdAt = message.createdAt.toISOString());
message.child !== undefined && (obj.child = message.child ? Child.toJSON(message.child) : undefined);
message.state !== undefined && (obj.state = stateEnumToJSON(message.state));
if (message.grandChildren) {
Expand Down Expand Up @@ -1620,7 +1619,7 @@ export const SimpleWithMap_MapOfTimestampsEntry = {
toJSON(message: SimpleWithMap_MapOfTimestampsEntry): unknown {
const obj: any = {};
message.key !== undefined && (obj.key = message.key);
message.value !== undefined && (obj.value = message.value !== undefined ? message.value.toISOString() : null);
message.value !== undefined && (obj.value = message.value.toISOString());
return obj;
},

Expand Down Expand Up @@ -2466,8 +2465,7 @@ export const SimpleButOptional = {
const obj: any = {};
message.name !== undefined && (obj.name = message.name);
message.age !== undefined && (obj.age = message.age);
message.createdAt !== undefined &&
(obj.createdAt = message.createdAt !== undefined ? message.createdAt.toISOString() : null);
message.createdAt !== undefined && (obj.createdAt = message.createdAt.toISOString());
message.child !== undefined && (obj.child = message.child ? Child.toJSON(message.child) : undefined);
message.state !== undefined &&
(obj.state = message.state !== undefined ? stateEnumToJSON(message.state) : undefined);
Expand Down
3 changes: 1 addition & 2 deletions integration/type-registry/foo.ts
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,7 @@ export const Foo = {

toJSON(message: Foo): unknown {
const obj: any = {};
message.timestamp !== undefined &&
(obj.timestamp = message.timestamp !== undefined ? message.timestamp.toISOString() : null);
message.timestamp !== undefined && (obj.timestamp = message.timestamp.toISOString());
return obj;
},

Expand Down
3 changes: 1 addition & 2 deletions integration/use-date-false/metadata.ts
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,7 @@ export const Metadata = {

toJSON(message: Metadata): unknown {
const obj: any = {};
message.lastEdited !== undefined &&
(obj.lastEdited = message.lastEdited !== undefined ? fromTimestamp(message.lastEdited).toISOString() : null);
message.lastEdited !== undefined && (obj.lastEdited = fromTimestamp(message.lastEdited).toISOString());
return obj;
},

Expand Down
212 changes: 212 additions & 0 deletions integration/use-date-string/google/protobuf/timestamp.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,212 @@
/* eslint-disable */
import { util, configure, Writer, Reader } from 'protobufjs/minimal';
import * as Long from 'long';

export const protobufPackage = 'google.protobuf';

/**
* A Timestamp represents a point in time independent of any time zone or local
* calendar, encoded as a count of seconds and fractions of seconds at
* nanosecond resolution. The count is relative to an epoch at UTC midnight on
* January 1, 1970, in the proleptic Gregorian calendar which extends the
* Gregorian calendar backwards to year one.
*
* All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
* second table is needed for interpretation, using a [24-hour linear
* smear](https://developers.google.com/time/smear).
*
* The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
* restricting to that range, we ensure that we can convert to and from [RFC
* 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
*
* # Examples
*
* Example 1: Compute Timestamp from POSIX `time()`.
*
* Timestamp timestamp;
* timestamp.set_seconds(time(NULL));
* timestamp.set_nanos(0);
*
* Example 2: Compute Timestamp from POSIX `gettimeofday()`.
*
* struct timeval tv;
* gettimeofday(&tv, NULL);
*
* Timestamp timestamp;
* timestamp.set_seconds(tv.tv_sec);
* timestamp.set_nanos(tv.tv_usec * 1000);
*
* Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
*
* FILETIME ft;
* GetSystemTimeAsFileTime(&ft);
* UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
*
* // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
* // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
* Timestamp timestamp;
* timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
* timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
*
* Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
*
* long millis = System.currentTimeMillis();
*
* Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
* .setNanos((int) ((millis % 1000) * 1000000)).build();
*
*
* Example 5: Compute Timestamp from current time in Python.
*
* timestamp = Timestamp()
* timestamp.GetCurrentTime()
*
* # JSON Mapping
*
* In JSON format, the Timestamp type is encoded as a string in the
* [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the
* format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z"
* where {year} is always expressed using four digits while {month}, {day},
* {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional
* seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
* are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
* is required. A proto3 JSON serializer should always use UTC (as indicated by
* "Z") when printing the Timestamp type and a proto3 JSON parser should be
* able to accept both UTC and other timezones (as indicated by an offset).
*
* For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
* 01:30 UTC on January 15, 2017.
*
* In JavaScript, one can convert a Date object to this format using the
* standard
* [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)
* method. In Python, a standard `datetime.datetime` object can be converted
* to this format using
* [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with
* the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
* the Joda Time's [`ISODateTimeFormat.dateTime()`](
* http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D
* ) to obtain a formatter capable of generating timestamps in this format.
*/
export interface Timestamp {
/**
* Represents seconds of UTC time since Unix epoch
* 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
* 9999-12-31T23:59:59Z inclusive.
*/
seconds: number;
/**
* Non-negative fractions of a second at nanosecond resolution. Negative
* second values with fractions must still have non-negative nanos values
* that count forward in time. Must be from 0 to 999,999,999
* inclusive.
*/
nanos: number;
}

const baseTimestamp: object = { seconds: 0, nanos: 0 };

export const Timestamp = {
encode(message: Timestamp, writer: Writer = Writer.create()): Writer {
if (message.seconds !== 0) {
writer.uint32(8).int64(message.seconds);
}
if (message.nanos !== 0) {
writer.uint32(16).int32(message.nanos);
}
return writer;
},

decode(input: Reader | Uint8Array, length?: number): Timestamp {
const reader = input instanceof Uint8Array ? new Reader(input) : input;
let end = length === undefined ? reader.len : reader.pos + length;
const message = { ...baseTimestamp } as Timestamp;
while (reader.pos < end) {
const tag = reader.uint32();
switch (tag >>> 3) {
case 1:
message.seconds = longToNumber(reader.int64() as Long);
break;
case 2:
message.nanos = reader.int32();
break;
default:
reader.skipType(tag & 7);
break;
}
}
return message;
},

fromJSON(object: any): Timestamp {
const message = { ...baseTimestamp } as Timestamp;
if (object.seconds !== undefined && object.seconds !== null) {
message.seconds = Number(object.seconds);
} else {
message.seconds = 0;
}
if (object.nanos !== undefined && object.nanos !== null) {
message.nanos = Number(object.nanos);
} else {
message.nanos = 0;
}
return message;
},

toJSON(message: Timestamp): unknown {
const obj: any = {};
message.seconds !== undefined && (obj.seconds = message.seconds);
message.nanos !== undefined && (obj.nanos = message.nanos);
return obj;
},

fromPartial(object: DeepPartial<Timestamp>): Timestamp {
const message = { ...baseTimestamp } as Timestamp;
if (object.seconds !== undefined && object.seconds !== null) {
message.seconds = object.seconds;
} else {
message.seconds = 0;
}
if (object.nanos !== undefined && object.nanos !== null) {
message.nanos = object.nanos;
} else {
message.nanos = 0;
}
return message;
},
};

declare var self: any | undefined;
declare var window: any | undefined;
var globalThis: any = (() => {
if (typeof globalThis !== 'undefined') return globalThis;
if (typeof self !== 'undefined') return self;
if (typeof window !== 'undefined') return window;
if (typeof global !== 'undefined') return global;
throw 'Unable to locate global object';
})();

type Builtin = Date | Function | Uint8Array | string | number | undefined;
export type DeepPartial<T> = T extends Builtin
? T
: T extends Array<infer U>
? Array<DeepPartial<U>>
: T extends ReadonlyArray<infer U>
? ReadonlyArray<DeepPartial<U>>
: T extends {}
? { [K in keyof T]?: DeepPartial<T[K]> }
: Partial<T>;

function longToNumber(long: Long): number {
if (long.gt(Number.MAX_SAFE_INTEGER)) {
throw new globalThis.Error('Value is larger than Number.MAX_SAFE_INTEGER');
}
return long.toNumber();
}

// If you get a compile-error about 'Constructor<Long> and ... have no overlap',
// add '--ts_proto_opt=esModuleInterop=true' as a flag when calling 'protoc'.
if (util.Long !== Long) {
util.Long = Long as any;
configure();
}
1 change: 1 addition & 0 deletions integration/use-date-string/parameters.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
useDate=string
Loading

0 comments on commit d967a9a

Please sign in to comment.