ts-proto 1.165.3 → 1.166.1

package/README.markdown

@@ -899,12 +899,14 @@ ExampleMessage.encode({ anything: true });
 The representation of `google.protobuf.Timestamp` is configurable by the `useDate` flag.
 The `useJsonTimestamp` flag controls precision when `useDate` is `false`.
 
-| Protobuf well-known type    | Default/`useDate=true` | `useDate=false`                      | `useDate=string` |
-| --------------------------- | ---------------------- | ------------------------------------ | ---------------- |
-| `google.protobuf.Timestamp` | `Date`                 | `{ seconds: number, nanos: number }` | `string`         |
+| Protobuf well-known type    | Default/`useDate=true` | `useDate=false`                      | `useDate=string` | `useDate=string-nano` |
+| --------------------------- | ---------------------- | ------------------------------------ | ---------------- | --------------------- |
+| `google.protobuf.Timestamp` | `Date`                 | `{ seconds: number, nanos: number }` | `string`         | `string`              |
 
 When using `useDate=false` and `useJsonTimestamp=raw` timestamp is represented as `{ seconds: number, nanos: number }`, but has nanosecond precision.
 
+When using `useDate=string-nano` timestamp is represented as an ISO string with nanosecond precision `1970-01-01T14:27:59.987654321Z` and relies on [nano-date](https://www.npmjs.com/package/nano-date) library for conversion. You'll need to install it in your project.
+
 # Number Types
 
 Numbers are by default assumed to be plain JavaScript `number`s.

package/build/encode.js

@@ -13,7 +13,9 @@ function generateEncoder(ctx, typeName) {
     if (name == "Timestamp") {
         const TimestampValue = (0, utils_1.impProto)(ctx.options, "google/protobuf/timestamp", name);
         let value = (0, ts_poet_1.code) `value`;
-        if (ctx.options.useDate === options_1.DateOption.DATE || ctx.options.useDate === options_1.DateOption.STRING) {
+        if (ctx.options.useDate === options_1.DateOption.DATE ||
+            ctx.options.useDate === options_1.DateOption.STRING ||
+            ctx.options.useDate === options_1.DateOption.STRING_NANO) {
             value = (0, ts_poet_1.code) `${ctx.utils.toTimestamp}(${value})`;
         }
         return (0, ts_poet_1.code) `${TimestampValue}.encode(${value}).finish()`;
@@ -59,7 +61,9 @@ function generateDecoder(ctx, typeName) {
     if (name == "Timestamp") {
         TypeValue = (0, utils_1.impProto)(ctx.options, "google/protobuf/timestamp", name);
         const decoder = (0, ts_poet_1.code) `${TypeValue}.decode(value)`;
-        if (ctx.options.useDate === options_1.DateOption.DATE || ctx.options.useDate === options_1.DateOption.STRING) {
+        if (ctx.options.useDate === options_1.DateOption.DATE ||
+            ctx.options.useDate === options_1.DateOption.STRING ||
+            ctx.options.useDate === options_1.DateOption.STRING_NANO) {
             return (0, ts_poet_1.code) `${ctx.utils.fromTimestamp}(${decoder})`;
         }
         return decoder;

package/build/main.js

@@ -181,7 +181,7 @@ function generateFile(ctx, fileDesc) {
     let hasStreamingMethods = false;
     (0, visit_1.visitServices)(fileDesc, sourceInfo, (serviceDesc, sInfo) => {
         if (options.nestJs) {
-            // NestJS is sufficiently different that we special case all of the client/server interfaces
+            // NestJS is sufficiently different that we special case the client/server interfaces
             // generate nestjs grpc client interface
             chunks.push((0, generate_nestjs_1.generateNestjsServiceClient)(ctx, fileDesc, sInfo, serviceDesc));
             // and the service controller interface
@@ -194,40 +194,38 @@ function generateFile(ctx, fileDesc) {
             }
             chunks.push((0, ts_poet_1.code) `export const ${serviceConstName} = "${serviceDesc.name}";`);
         }
-        else {
-            const uniqueServices = [...new Set(options.outputServices)].sort();
-            uniqueServices.forEach((outputService) => {
-                if (outputService === options_1.ServiceOption.GRPC) {
-                    chunks.push((0, generate_grpc_js_1.generateGrpcJsService)(ctx, fileDesc, sInfo, serviceDesc));
-                }
-                else if (outputService === options_1.ServiceOption.NICE_GRPC) {
-                    chunks.push((0, generate_nice_grpc_1.generateNiceGrpcService)(ctx, fileDesc, sInfo, serviceDesc));
-                }
-                else if (outputService === options_1.ServiceOption.GENERIC) {
-                    chunks.push((0, generate_generic_service_definition_1.generateGenericServiceDefinition)(ctx, fileDesc, sInfo, serviceDesc));
+        const uniqueServices = [...new Set(options.outputServices)].sort();
+        uniqueServices.forEach((outputService) => {
+            if (outputService === options_1.ServiceOption.GRPC) {
+                chunks.push((0, generate_grpc_js_1.generateGrpcJsService)(ctx, fileDesc, sInfo, serviceDesc));
+            }
+            else if (outputService === options_1.ServiceOption.NICE_GRPC) {
+                chunks.push((0, generate_nice_grpc_1.generateNiceGrpcService)(ctx, fileDesc, sInfo, serviceDesc));
+            }
+            else if (outputService === options_1.ServiceOption.GENERIC) {
+                chunks.push((0, generate_generic_service_definition_1.generateGenericServiceDefinition)(ctx, fileDesc, sInfo, serviceDesc));
+            }
+            else if (outputService === options_1.ServiceOption.DEFAULT) {
+                // This service could be Twirp or grpc-web or JSON (maybe). So far all of their
+                // interfaces are fairly similar so we share the same service interface.
+                chunks.push((0, generate_services_1.generateService)(ctx, fileDesc, sInfo, serviceDesc));
+                if (options.outputClientImpl === true) {
+                    chunks.push((0, generate_services_1.generateServiceClientImpl)(ctx, fileDesc, serviceDesc));
                 }
-                else if (outputService === options_1.ServiceOption.DEFAULT) {
-                    // This service could be Twirp or grpc-web or JSON (maybe). So far all of their
-                    // interfaces are fairly similar so we share the same service interface.
-                    chunks.push((0, generate_services_1.generateService)(ctx, fileDesc, sInfo, serviceDesc));
-                    if (options.outputClientImpl === true) {
-                        chunks.push((0, generate_services_1.generateServiceClientImpl)(ctx, fileDesc, serviceDesc));
-                    }
-                    else if (options.outputClientImpl === "grpc-web") {
-                        chunks.push((0, generate_grpc_web_1.generateGrpcClientImpl)(ctx, fileDesc, serviceDesc));
-                        chunks.push((0, generate_grpc_web_1.generateGrpcServiceDesc)(fileDesc, serviceDesc));
-                        serviceDesc.method.forEach((method) => {
-                            if (!method.clientStreaming) {
-                                chunks.push((0, generate_grpc_web_1.generateGrpcMethodDesc)(ctx, serviceDesc, method));
-                            }
-                            if (method.serverStreaming) {
-                                hasServerStreamingMethods = true;
-                            }
-                        });
-                    }
+                else if (options.outputClientImpl === "grpc-web") {
+                    chunks.push((0, generate_grpc_web_1.generateGrpcClientImpl)(ctx, fileDesc, serviceDesc));
+                    chunks.push((0, generate_grpc_web_1.generateGrpcServiceDesc)(fileDesc, serviceDesc));
+                    serviceDesc.method.forEach((method) => {
+                        if (!method.clientStreaming) {
+                            chunks.push((0, generate_grpc_web_1.generateGrpcMethodDesc)(ctx, serviceDesc, method));
+                        }
+                        if (method.serverStreaming) {
+                            hasServerStreamingMethods = true;
+                        }
+                    });
                 }
-            });
-        }
+            }
+        });
         serviceDesc.method.forEach((methodDesc, _index) => {
             if (methodDesc.serverStreaming || methodDesc.clientStreaming) {
                 hasStreamingMethods = true;
@@ -462,23 +460,21 @@ function makeObjectIdMethods() {
 }
 function makeTimestampMethods(options, longs, bytes) {
     const Timestamp = (0, utils_1.impProto)(options, "google/protobuf/timestamp", "Timestamp");
-    let seconds = "date.getTime() / 1_000";
+    const NanoDate = (0, ts_poet_1.imp)("NanoDate=nano-date");
+    let seconds = "Math.trunc(date.getTime() / 1_000)";
     let toNumberCode = "t.seconds";
     const makeToNumberCode = (methodCall) => `t.seconds${options.useOptionals === "all" ? "?" : ""}.${methodCall}`;
     if (options.forceLong === options_1.LongOption.LONG) {
         toNumberCode = makeToNumberCode("toNumber()");
-        seconds = (0, ts_poet_1.code) `${longs.numberToLong}(date.getTime() / 1_000)`;
+        seconds = (0, ts_poet_1.code) `${longs.numberToLong}(${seconds})`;
     }
     else if (options.forceLong === options_1.LongOption.BIGINT) {
         toNumberCode = (0, ts_poet_1.code) `${bytes.globalThis}.Number(${makeToNumberCode("toString()")})`;
-        seconds = (0, ts_poet_1.code) `BigInt(Math.trunc(date.getTime() / 1_000))`;
+        seconds = (0, ts_poet_1.code) `BigInt(${seconds})`;
     }
     else if (options.forceLong === options_1.LongOption.STRING) {
         toNumberCode = (0, ts_poet_1.code) `${bytes.globalThis}.Number(t.seconds)`;
-        // Must discard the fractional piece here
-        // Otherwise the fraction ends up on the seconds when parsed as a Long
-        // (note this only occurs when the string is > 8 characters)
-        seconds = "Math.trunc(date.getTime() / 1_000).toString()";
+        seconds = (0, ts_poet_1.code) `${seconds}.toString()`;
     }
     const maybeTypeField = (0, options_1.addTypeToMessages)(options) ? `$type: 'google.protobuf.Timestamp',` : "";
     const toTimestamp = (0, ts_poet_1.conditionalOutput)("toTimestamp", options.useDate === options_1.DateOption.STRING
@@ -490,7 +486,24 @@ function makeTimestampMethods(options, longs, bytes) {
             return { ${maybeTypeField} seconds, nanos };
           }
         `
-        : (0, ts_poet_1.code) `
+        : options.useDate === options_1.DateOption.STRING_NANO
+            ? (0, ts_poet_1.code) `
+          function toTimestamp(dateStr: string): ${Timestamp} {
+            const nanoDate = new ${NanoDate}(dateStr);
+
+            const date = {
+              getTime: (): number => nanoDate.valueOf(),
+            } as const;
+            const seconds = ${seconds};
+
+            let nanos = nanoDate.getMilliseconds() * 1_000_000;
+            nanos += nanoDate.getMicroseconds() * 1_000;
+            nanos += nanoDate.getNanoseconds();
+
+            return { ${maybeTypeField} seconds, nanos };
+          }
+        `
+            : (0, ts_poet_1.code) `
           function toTimestamp(date: Date): ${Timestamp} {
             const seconds = ${seconds};
             const nanos = (date.getTime() % 1_000) * 1_000_000;
@@ -505,7 +518,23 @@ function makeTimestampMethods(options, longs, bytes) {
             return new ${bytes.globalThis}.Date(millis).toISOString();
           }
         `
-        : (0, ts_poet_1.code) `
+        : options.useDate === options_1.DateOption.STRING_NANO
+            ? (0, ts_poet_1.code) `
+          function fromTimestamp(t: ${Timestamp}): string {
+            const seconds = ${toNumberCode} || 0;
+            const nanos = (t.nanos || 0) % 1_000;
+            const micros = Math.trunc(((t.nanos || 0) % 1_000_000) / 1_000)
+            let millis = seconds * 1_000;
+            millis += Math.trunc((t.nanos || 0) / 1_000_000);
+
+            const nanoDate = new ${NanoDate}(millis);
+            nanoDate.setMicroseconds(micros);
+            nanoDate.setNanoseconds(nanos);
+
+            return nanoDate.toISOStringFull();
+          }
+        `
+            : (0, ts_poet_1.code) `
           function fromTimestamp(t: ${Timestamp}): Date {
             let millis = (${toNumberCode} || 0) * 1_000;
             millis += (t.nanos || 0) / 1_000_000;
@@ -748,7 +777,10 @@ function getDecodeReadSnippet(ctx, field) {
         const decoder = (0, ts_poet_1.code) `${type}.decode(reader, reader.uint32())`;
         readSnippet = (0, ts_poet_1.code) `${unwrap(decoder)}`;
     }
-    else if ((0, types_1.isTimestamp)(field) && (options.useDate === options_1.DateOption.DATE || options.useDate === options_1.DateOption.STRING)) {
+    else if ((0, types_1.isTimestamp)(field) &&
+        (options.useDate === options_1.DateOption.DATE ||
+            options.useDate === options_1.DateOption.STRING ||
+            options.useDate === options_1.DateOption.STRING_NANO)) {
         const type = (0, types_1.basicTypeName)(ctx, field, { keepValueType: true });
         readSnippet = (0, ts_poet_1.code) `${utils.fromTimestamp}(${type}.decode(reader, reader.uint32()))`;
     }
@@ -977,7 +1009,10 @@ function getEncodeWriteSnippet(ctx, field) {
         const type = (0, types_1.basicTypeName)(ctx, field, { keepValueType: true });
         return (place) => (0, ts_poet_1.code) `${type}.encode(${utils.toProtoObjectId}(${place}), writer.uint32(${tag}).fork()).ldelim()`;
     }
-    else if ((0, types_1.isTimestamp)(field) && (options.useDate === options_1.DateOption.DATE || options.useDate === options_1.DateOption.STRING)) {
+    else if ((0, types_1.isTimestamp)(field) &&
+        (options.useDate === options_1.DateOption.DATE ||
+            options.useDate === options_1.DateOption.STRING ||
+            options.useDate === options_1.DateOption.STRING_NANO)) {
         const tag = ((field.number << 3) | 2) >>> 0;
         const type = (0, types_1.basicTypeName)(ctx, field, { keepValueType: true });
         return (place) => (0, ts_poet_1.code) `${type}.encode(${utils.toTimestamp}(${place}), writer.uint32(${tag}).fork()).ldelim()`;
@@ -1316,7 +1351,10 @@ function generateExtension(ctx, message, extension) {
                 const type = (0, types_1.basicTypeName)(ctx, field, { keepValueType: true });
                 return (place) => (0, ts_poet_1.code) `${type}.encode(${utils.toProtoObjectId}(${place}), writer.fork()).ldelim()`;
             }
-            else if ((0, types_1.isTimestamp)(field) && (options.useDate === options_1.DateOption.DATE || options.useDate === options_1.DateOption.STRING)) {
+            else if ((0, types_1.isTimestamp)(field) &&
+                (options.useDate === options_1.DateOption.DATE ||
+                    options.useDate === options_1.DateOption.STRING ||
+                    options.useDate === options_1.DateOption.STRING_NANO)) {
                 const type = (0, types_1.basicTypeName)(ctx, field, { keepValueType: true });
                 return (place) => (0, ts_poet_1.code) `${type}.encode(${utils.toTimestamp}(${place}), writer.fork()).ldelim()`;
             }
@@ -1505,7 +1543,8 @@ function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
             else if ((0, types_1.isObjectId)(field) && options.useMongoObjectId) {
                 return (0, ts_poet_1.code) `${utils.fromJsonObjectId}(${from})`;
             }
-            else if ((0, types_1.isTimestamp)(field) && options.useDate === options_1.DateOption.STRING) {
+            else if ((0, types_1.isTimestamp)(field) &&
+                (options.useDate === options_1.DateOption.STRING || options.useDate === options_1.DateOption.STRING_NANO)) {
                 return (0, ts_poet_1.code) `${utils.globalThis}.String(${from})`;
             }
             else if ((0, types_1.isTimestamp)(field) &&
@@ -1568,7 +1607,8 @@ function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
                     else if ((0, types_1.isObjectId)(valueField) && options.useMongoObjectId) {
                         return (0, ts_poet_1.code) `${utils.fromJsonObjectId}(${from})`;
                     }
-                    else if ((0, types_1.isTimestamp)(valueField) && options.useDate === options_1.DateOption.STRING) {
+                    else if ((0, types_1.isTimestamp)(valueField) &&
+                        (options.useDate === options_1.DateOption.STRING || options.useDate === options_1.DateOption.STRING_NANO)) {
                         return (0, ts_poet_1.code) `${utils.globalThis}.String(${from})`;
                     }
                     else if ((0, types_1.isTimestamp)(valueField) &&
@@ -1729,7 +1769,8 @@ function generateToJson(ctx, fullName, fullProtobufTypeName, messageDesc) {
             else if ((0, types_1.isTimestamp)(field) && options.useDate === options_1.DateOption.DATE) {
                 return (0, ts_poet_1.code) `${from}.toISOString()`;
             }
-            else if ((0, types_1.isTimestamp)(field) && options.useDate === options_1.DateOption.STRING) {
+            else if ((0, types_1.isTimestamp)(field) &&
+                (options.useDate === options_1.DateOption.STRING || options.useDate === options_1.DateOption.STRING_NANO)) {
                 return (0, ts_poet_1.code) `${from}`;
             }
             else if ((0, types_1.isTimestamp)(field) && options.useDate === options_1.DateOption.TIMESTAMP) {
@@ -1754,7 +1795,8 @@ function generateToJson(ctx, fullName, fullProtobufTypeName, messageDesc) {
                 else if ((0, types_1.isTimestamp)(valueType) && options.useDate === options_1.DateOption.DATE) {
                     return (0, ts_poet_1.code) `${from}.toISOString()`;
                 }
-                else if ((0, types_1.isTimestamp)(valueType) && options.useDate === options_1.DateOption.STRING) {
+                else if ((0, types_1.isTimestamp)(valueType) &&
+                    (options.useDate === options_1.DateOption.STRING || options.useDate === options_1.DateOption.STRING_NANO)) {
                     return (0, ts_poet_1.code) `${from}`;
                 }
                 else if ((0, types_1.isTimestamp)(valueType) && options.useDate === options_1.DateOption.TIMESTAMP) {
@@ -1919,7 +1961,10 @@ function generateFromPartial(ctx, fullName, messageDesc) {
                 return (0, ts_poet_1.code) `${from} as mongodb.ObjectId`;
             }
             else if ((0, types_1.isPrimitive)(field) ||
-                ((0, types_1.isTimestamp)(field) && (options.useDate === options_1.DateOption.DATE || options.useDate === options_1.DateOption.STRING)) ||
+                ((0, types_1.isTimestamp)(field) &&
+                    (options.useDate === options_1.DateOption.DATE ||
+                        options.useDate === options_1.DateOption.STRING ||
+                        options.useDate === options_1.DateOption.STRING_NANO)) ||
                 (0, types_1.isValueType)(ctx, field)) {
                 return (0, ts_poet_1.code) `${from}`;
             }
@@ -1951,7 +1996,9 @@ function generateFromPartial(ctx, fullName, messageDesc) {
                         return (0, ts_poet_1.code) `${from} as mongodb.ObjectId`;
                     }
                     else if ((0, types_1.isTimestamp)(valueField) &&
-                        (options.useDate === options_1.DateOption.DATE || options.useDate === options_1.DateOption.STRING)) {
+                        (options.useDate === options_1.DateOption.DATE ||
+                            options.useDate === options_1.DateOption.STRING ||
+                            options.useDate === options_1.DateOption.STRING_NANO)) {
                         return (0, ts_poet_1.code) `${from}`;
                     }
                     else if ((0, types_1.isValueType)(ctx, valueField)) {

package/build/options.js

@@ -12,6 +12,7 @@ var DateOption;
 (function (DateOption) {
     DateOption["DATE"] = "date";
     DateOption["STRING"] = "string";
+    DateOption["STRING_NANO"] = "string-nano";
     DateOption["TIMESTAMP"] = "timestamp";
 })(DateOption || (exports.DateOption = DateOption = {}));
 var JsonTimestampOption;
@@ -141,9 +142,15 @@ function optionsFromParameter(parameter) {
     if (typeof options.outputServices == "string") {
         options.outputServices = [options.outputServices];
     }
-    if (options.outputServices.length == 0) {
+    // Assume the user wants the default service output, unless they're using nestJs, which has
+    // its own controllers output (although nestjs users can ask for other services too).
+    if (options.outputServices.length == 0 && !options.nestJs) {
         options.outputServices = [ServiceOption.DEFAULT];
     }
+    // If using nestJs + other services, add the encode methods back
+    if (options.nestJs && options.outputServices.length > 0) {
+        options.outputEncodeMethods = true;
+    }
     if (options.useDate === true) {
         // Treat useDate=true as DATE
         options.useDate = DateOption.DATE;

package/build/types.js

@@ -554,7 +554,7 @@ function messageToTypeName(ctx, protoType, typeOptions = {}) {
         if (options.useDate == options_1.DateOption.DATE) {
             return (0, ts_poet_1.code) `Date`;
         }
-        if (options.useDate == options_1.DateOption.STRING) {
+        if (options.useDate == options_1.DateOption.STRING || options.useDate == options_1.DateOption.STRING_NANO) {
             return (0, ts_poet_1.code) `string`;
         }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-proto",
-  "version": "1.165.3",
+  "version": "1.166.1",
   "description": "",
   "main": "build/plugin.js",
   "repository": "github:stephenh/ts-proto",
@@ -52,6 +52,7 @@
     "jest": "^29.6.1",
     "jest-ts-webcompat-resolver": "^1.0.0",
     "mongodb": "^5.7.0",
+    "nano-date": "^4.1.0",
     "nice-grpc": "^2.1.4",
     "object-hash": "^3.0.0",
     "prettier": "^2.8.8",