ts-proto 2.6.0 → 2.7.0

package/README.markdown

@@ -530,7 +530,7 @@ Generated code will be placed in the Gradle build directory.
 
 - With `--ts_proto_opt=useNumericEnumForJson=true`, the JSON converter (`toJSON`) will encode enum values as int, rather than a string literal.
 
-- With `--ts_proto_opt=initializeFieldsAsUndefined=false`, all optional field initializers will be omitted from the generated base instances.
+- With `--ts_proto_opt=initializeFieldsAsUndefined=false`, all optional field initializers will be omitted from the generated base instances. This can be useful if you're using Next.js and `getServerSideProps`, see [#492](https://github.com/stephenh/ts-proto/issues/492). The default is `true` to ideally get the best v8 performance by avoiding "changing shapes" as fields are incrementally set.
 
 - With `--ts_proto_opt=disableProto2Optionals=true`, all optional fields on proto2 files will not be set to be optional. Please note that this flag is primarily for preserving ts-proto's legacy handling of proto2 files, to avoid breaking changes, and as a result, it is not intended to be used moving forward.
 
@@ -645,6 +645,7 @@ export interface User {
 
 This option allows the library to act in a compatible way with the [Wire implementation](https://square.github.io/wire/) maintained and used by Square/Block. Note: this option should only be used in combination with other client/server code generated using Wire or ts-proto with this option enabled.
 
+- With `--ts_proto_opt=useDuration=string`, the generated code will use the `string` type for `google.protobuf.Duration` instead of `{seconds: number, nano: number}`.
 
 ### NestJS Support
 
@@ -701,8 +702,8 @@ const sendRequest: RpcImpl = (service, method, data) => {
       return argument;
     }
 
-    // Using passThrough as the serialize and deserialize functions
-    conn.makeUnaryRequest(path, passThrough, passThrough, data, resultCallback);
+    // Using passThrough as the deserialize functions
+    conn.makeUnaryRequest(path, d => Buffer.from(d), passThrough, data, resultCallback);
   });
 };
 
@@ -794,7 +795,6 @@ ts-protoc --ts_proto_out=./output -I=./protos ./protoc/*.proto
 
 # Todo
 
-- Support the string-based encoding of duration in `fromJSON`/`toJSON`
 - Make `oneof=unions-value` the default behavior in 2.0
 - Probably change `forceLong` default in 2.0, should default to `forceLong=long`
 - Make `esModuleInterop=true` the default in 2.0

package/build/src/main.js

@@ -1737,6 +1737,19 @@ function generateExtension(ctx, message, extension) {
 function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
     const { options, utils, currentFile } = ctx;
     const chunks = [];
+    // Handle Duration string format as a special case
+    if (fullTypeName === "google.protobuf.Duration" && ctx.options.useDuration === options_1.DurationOption.STRING) {
+        return (0, ts_poet_1.code) `
+      fromJSON(object: string): ${fullName} {
+        const match = object.match(/^(-?[0-9.]+)s$/);
+        if (!match) throw new Error('Invalid duration string');
+        const seconds = Number(match[1]);
+        const wholeSeconds = Math.trunc(seconds);
+        const nanos = Math.round((seconds - wholeSeconds) * 1e9);
+        return { seconds: wholeSeconds, nanos };
+      }
+    `;
+    }
     // create the basic function declaration
     chunks.push((0, ts_poet_1.code) `
     fromJSON(${messageDesc.field.length > 0 ? "object" : "_"}: any): ${fullName} {
@@ -1984,7 +1997,7 @@ function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
     chunks.push((0, ts_poet_1.code) `}`);
     return (0, ts_poet_1.joinCode)(chunks, { on: "\n" });
 }
-function generateCanonicalToJson(fullName, fullProtobufTypeName, { useOptionals, useNullAsOptional }) {
+function generateCanonicalToJson(fullName, fullProtobufTypeName, { useOptionals, useNullAsOptional, useDuration }) {
     if ((0, types_1.isFieldMaskTypeName)(fullProtobufTypeName)) {
         const returnType = useOptionals === "all" ? `string | ${(0, utils_1.nullOrUndefined)({ useNullAsOptional })}` : "string";
         const pathModifier = useOptionals === "all" ? "?" : "";
@@ -1993,6 +2006,15 @@ function generateCanonicalToJson(fullName, fullProtobufTypeName, { useOptionals,
       return message.paths${pathModifier}.join(',');
     }
   `;
+    }
+    if (fullProtobufTypeName === "google.protobuf.Duration" && useDuration === options_1.DurationOption.STRING) {
+        return (0, ts_poet_1.code) `
+    toJSON(message: ${fullName}): string {
+        const secs = Number(message.seconds);
+        const nanos = message.nanos;
+        return \`\${secs + nanos/1e9}s\`;
+    }
+    `;
     }
     return undefined;
 }

package/build/src/options.d.ts

@@ -15,6 +15,10 @@ export declare enum JsonTimestampOption {
     RFC3339 = "rfc3339",
     RAW = "raw"
 }
+export declare enum DurationOption {
+    DURATION = "duration",
+    STRING = "string"
+}
 export declare enum EnvOption {
     NODE = "node",
     BROWSER = "browser",
@@ -108,6 +112,7 @@ export type Options = {
     bigIntLiteral: boolean;
     typePrefix: string;
     typeSuffix: string;
+    useDuration: DurationOption;
 };
 export declare function defaultOptions(): Options;
 export declare function optionsFromParameter(parameter: string | undefined): Options;

package/build/src/options.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OutputSchemaOption = exports.ServiceOption = exports.OneofOption = exports.EnvOption = exports.JsonTimestampOption = exports.DateOption = exports.LongOption = void 0;
+exports.OutputSchemaOption = exports.ServiceOption = exports.OneofOption = exports.EnvOption = exports.DurationOption = exports.JsonTimestampOption = exports.DateOption = exports.LongOption = void 0;
 exports.defaultOptions = defaultOptions;
 exports.optionsFromParameter = optionsFromParameter;
 exports.getTsPoetOpts = getTsPoetOpts;
@@ -24,6 +24,11 @@ var JsonTimestampOption;
     JsonTimestampOption["RFC3339"] = "rfc3339";
     JsonTimestampOption["RAW"] = "raw";
 })(JsonTimestampOption || (exports.JsonTimestampOption = JsonTimestampOption = {}));
+var DurationOption;
+(function (DurationOption) {
+    DurationOption["DURATION"] = "duration";
+    DurationOption["STRING"] = "string";
+})(DurationOption || (exports.DurationOption = DurationOption = {}));
 var EnvOption;
 (function (EnvOption) {
     EnvOption["NODE"] = "node";
@@ -120,6 +125,7 @@ function defaultOptions() {
         bigIntLiteral: true,
         typePrefix: "",
         typeSuffix: "",
+        useDuration: DurationOption.DURATION,
     };
 }
 const nestJsOptions = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-proto",
-  "version": "2.6.0",
+  "version": "2.7.0",
   "description": "",
   "main": "build/src/plugin.js",
   "repository": "github:stephenh/ts-proto",