ts-proto 1.157.1 → 1.158.1

package/README.markdown

@@ -79,7 +79,7 @@ It will also generate client implementations of `PingService`; currently [Twirp]
 - `protoc --plugin=./node_modules/.bin/protoc-gen-ts_proto --ts_proto_out=. ./simple.proto`
   - (Note that the output parameter name, `ts_proto_out`, is named based on the suffix of the plugin's name, i.e. "ts_proto" suffix in the `--plugin=./node_modules/.bin/protoc-gen-ts_proto` parameter becomes the `_out` prefix, per `protoc`'s CLI conventions.)
   - On Windows, use `protoc --plugin=protoc-gen-ts_proto=".\\node_modules\\.bin\\protoc-gen-ts_proto.cmd" --ts_proto_out=. ./simple.proto` (see [#93](https://github.com/stephenh/ts-proto/issues/93))
-  - Ensure you're using a modern `protoc`, i.e. the original `protoc` `3.0.0` doesn't support the `_opt` flag
+  - Ensure you're using a modern `protoc` (see [installation instructions for your platform](https://grpc.io/docs/protoc-installation/), i.e. `protoc` v`3.0.0` doesn't support the `_opt` flag
 
 This will generate `*.ts` source files for the given `*.proto` types.
 
@@ -517,6 +517,8 @@ Generated code will be placed in the Gradle build directory.
 
   This will disable `exportCommonSymbols` to avoid name collisions on the common symbols.
 
+- With `--emitDefaultValues=json-methods`, the generated toJSON method will emit scalars like `0` and `""` as json fields.
+
 ### NestJS Support
 
 We have a great way of working together with [nestjs](https://docs.nestjs.com/microservices/grpc). `ts-proto` generates `interfaces` and `decorators` for you controller, client. For more information see the [nestjs readme](NESTJS.markdown).

package/build/generate-async-iterable.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateDecodeTransform = exports.generateEncodeTransform = void 0;
 const ts_poet_1 = require("ts-poet");
 /** Creates a function to transform a message Source to a Uint8Array Source. */
-function generateEncodeTransform(fullName) {
+function generateEncodeTransform(utils, fullName) {
     return (0, ts_poet_1.code) `
     // encodeTransform encodes a source of message objects.
     // Transform<${fullName}, Uint8Array>
@@ -11,12 +11,12 @@ function generateEncodeTransform(fullName) {
       source: AsyncIterable<${fullName} | ${fullName}[]> | Iterable<${fullName} | ${fullName}[]>
     ): AsyncIterable<Uint8Array> {
       for await (const pkt of source) {
-        if (Array.isArray(pkt)) {
-          for (const p of pkt) {
+        if (${utils.globalThis}.Array.isArray(pkt)) {
+          for (const p of (pkt as any)) {
             yield* [${fullName}.encode(p).finish()]
           }
         } else {
-          yield* [${fullName}.encode(pkt).finish()]
+          yield* [${fullName}.encode(pkt as any).finish()]
         }
       }
     }
@@ -24,7 +24,7 @@ function generateEncodeTransform(fullName) {
 }
 exports.generateEncodeTransform = generateEncodeTransform;
 /** Creates a function to transform a Uint8Array Source to a message Source. */
-function generateDecodeTransform(fullName) {
+function generateDecodeTransform(utils, fullName) {
     return (0, ts_poet_1.code) `
     // decodeTransform decodes a source of encoded messages.
     // Transform<Uint8Array, ${fullName}>
@@ -32,12 +32,12 @@ function generateDecodeTransform(fullName) {
       source: AsyncIterable<Uint8Array | Uint8Array[]> | Iterable<Uint8Array | Uint8Array[]>
     ): AsyncIterable<${fullName}> {
       for await (const pkt of source) {
-        if (Array.isArray(pkt)) {
-          for (const p of pkt) {
+        if (${utils.globalThis}.Array.isArray(pkt)) {
+          for (const p of (pkt as any)) {
             yield* [${fullName}.decode(p)]
           }
         } else {
-          yield* [${fullName}.decode(pkt)]
+          yield* [${fullName}.decode(pkt as any)]
         }
       }
     }

package/build/generate-struct-wrappers.js

@@ -46,7 +46,7 @@ function generateWrapDeep(ctx, fullProtoTypeName, fieldNames) {
         result.${fieldNames.numberValue} = value;
       } else if (typeof value === 'string') {
         result.${fieldNames.stringValue} = value;
-      } else if (Array.isArray(value)) {
+      } else if (${ctx.utils.globalThis}.Array.isArray(value)) {
         result.${fieldNames.listValue} = ListValue.wrap(value);
       } else if (typeof value === 'object') {
         result.${fieldNames.structValue} = Struct.wrap(value);
@@ -126,7 +126,7 @@ function generateUnwrapDeep(ctx, fullProtoTypeName, fieldNames) {
     }
     if ((0, types_1.isListValueTypeName)(fullProtoTypeName)) {
         chunks.push((0, ts_poet_1.code) `unwrap(message: ${ctx.options.useReadonlyTypes ? "any" : "ListValue"}): Array<any> {
-      if (message?.hasOwnProperty('values') && Array.isArray(message.values)) {
+      if (message?.hasOwnProperty('values') && ${ctx.utils.globalThis}.Array.isArray(message.values)) {
         return message.values.map(Value.unwrap);
       } else {
         return message as any;
@@ -175,7 +175,7 @@ function generateWrapShallow(ctx, fullProtoTypeName, fieldNames) {
           result.kind = {$case: '${fieldNames.numberValue}', ${fieldNames.numberValue}: value};
         } else if (typeof value === 'string') {
           result.kind = {$case: '${fieldNames.stringValue}', ${fieldNames.stringValue}: value};
-        } else if (Array.isArray(value)) {
+        } else if (${ctx.utils.globalThis}.Array.isArray(value)) {
           result.kind = {$case: '${fieldNames.listValue}', ${fieldNames.listValue}: value};
         } else if (typeof value === 'object') {
           result.kind = {$case: '${fieldNames.structValue}', ${fieldNames.structValue}: value};
@@ -196,7 +196,7 @@ function generateWrapShallow(ctx, fullProtoTypeName, fieldNames) {
           result.${fieldNames.numberValue} = value;
         } else if (typeof value === 'string') {
           result.${fieldNames.stringValue} = value;
-        } else if (Array.isArray(value)) {
+        } else if (${ctx.utils.globalThis}.Array.isArray(value)) {
           result.${fieldNames.listValue} = value;
         } else if (typeof value === 'object') {
           result.${fieldNames.structValue} = value;
@@ -295,7 +295,7 @@ function generateUnwrapShallow(ctx, fullProtoTypeName, fieldNames) {
     }
     if ((0, types_1.isListValueTypeName)(fullProtoTypeName)) {
         chunks.push((0, ts_poet_1.code) `unwrap(message: ${ctx.options.useReadonlyTypes ? "any" : "ListValue"}): Array<any> {
-      if (message?.hasOwnProperty('values') && Array.isArray(message.values)) {
+      if (message?.hasOwnProperty('values') && ${ctx.utils.globalThis}.Array.isArray(message.values)) {
         return message.values;
       } else {
         return message as any;

package/build/main.js

@@ -121,8 +121,8 @@ function generateFile(ctx, fileDesc) {
                 }
             }
             if (options.useAsyncIterable) {
-                staticMembers.push((0, generate_async_iterable_1.generateEncodeTransform)(fullName));
-                staticMembers.push((0, generate_async_iterable_1.generateDecodeTransform)(fullName));
+                staticMembers.push((0, generate_async_iterable_1.generateEncodeTransform)(ctx.utils, fullName));
+                staticMembers.push((0, generate_async_iterable_1.generateDecodeTransform)(ctx.utils, fullName));
             }
             if (options.outputJsonMethods) {
                 if (options.outputJsonMethods === true || options.outputJsonMethods === "from-only") {
@@ -279,7 +279,7 @@ function makeUtils(options) {
         ...bytes,
         ...makeDeepPartial(options, longs),
         ...makeObjectIdMethods(),
-        ...makeTimestampMethods(options, longs),
+        ...makeTimestampMethods(options, longs, bytes),
         ...longs,
         ...makeComparisonUtils(),
         ...makeNiceGrpcServerStreamingMethodResult(),
@@ -346,7 +346,7 @@ function makeLongUtils(options, bytes) {
     `);
     const longToNumber = (0, ts_poet_1.conditionalOutput)("longToNumber", (0, ts_poet_1.code) `
       function longToNumber(long: ${Long}): number {
-        if (long.gt(Number.MAX_SAFE_INTEGER)) {
+        if (long.gt(${bytes.globalThis}.Number.MAX_SAFE_INTEGER)) {
           throw new ${bytes.globalThis}.Error("Value is larger than Number.MAX_SAFE_INTEGER")
         }
         return long.toNumber();
@@ -388,7 +388,7 @@ function makeByteUtils() {
         } else {
           const bin: string[] = [];
           arr.forEach((byte) => {
-            bin.push(String.fromCharCode(byte));
+            bin.push(${globalThis}.String.fromCharCode(byte));
           });
           return ${globalThis}.btoa(bin.join(''));
         }
@@ -459,7 +459,7 @@ function makeObjectIdMethods() {
     `);
     return { fromJsonObjectId, fromProtoObjectId, toProtoObjectId };
 }
-function makeTimestampMethods(options, longs) {
+function makeTimestampMethods(options, longs, bytes) {
     const Timestamp = (0, utils_1.impProto)(options, "google/protobuf/timestamp", "Timestamp");
     let seconds = "date.getTime() / 1_000";
     let toNumberCode = "t.seconds";
@@ -468,11 +468,11 @@ function makeTimestampMethods(options, longs) {
         seconds = (0, ts_poet_1.code) `${longs.numberToLong}(date.getTime() / 1_000)`;
     }
     else if (options.forceLong === options_1.LongOption.BIGINT) {
-        toNumberCode = "Number(t.seconds.toString())";
+        toNumberCode = (0, ts_poet_1.code) `${bytes.globalThis}.Number(t.seconds.toString())`;
         seconds = (0, ts_poet_1.code) `BigInt(Math.trunc(date.getTime() / 1_000))`;
     }
     else if (options.forceLong === options_1.LongOption.STRING) {
-        toNumberCode = "Number(t.seconds)";
+        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)
@@ -482,7 +482,7 @@ function makeTimestampMethods(options, longs) {
     const toTimestamp = (0, ts_poet_1.conditionalOutput)("toTimestamp", options.useDate === options_1.DateOption.STRING
         ? (0, ts_poet_1.code) `
           function toTimestamp(dateStr: string): ${Timestamp} {
-            const date = new Date(dateStr);
+            const date = new ${bytes.globalThis}.Date(dateStr);
             const seconds = ${seconds};
             const nanos = (date.getTime() % 1_000) * 1_000_000;
             return { ${maybeTypeField} seconds, nanos };
@@ -500,23 +500,23 @@ function makeTimestampMethods(options, longs) {
           function fromTimestamp(t: ${Timestamp}): string {
             let millis = (${toNumberCode} || 0) * 1_000;
             millis += (t.nanos || 0) / 1_000_000;
-            return new Date(millis).toISOString();
+            return new ${bytes.globalThis}.Date(millis).toISOString();
           }
         `
         : (0, ts_poet_1.code) `
           function fromTimestamp(t: ${Timestamp}): Date {
             let millis = (${toNumberCode} || 0) * 1_000;
             millis += (t.nanos || 0) / 1_000_000;
-            return new Date(millis);
+            return new ${bytes.globalThis}.Date(millis);
           }
         `);
     const fromJsonTimestamp = (0, ts_poet_1.conditionalOutput)("fromJsonTimestamp", options.useDate === options_1.DateOption.DATE
         ? (0, ts_poet_1.code) `
         function fromJsonTimestamp(o: any): Date {
-          if (o instanceof Date) {
+          if (o instanceof ${bytes.globalThis}.Date) {
             return o;
           } else if (typeof o === "string") {
-            return new Date(o);
+            return new ${bytes.globalThis}.Date(o);
           } else {
             return ${fromTimestamp}(Timestamp.fromJSON(o));
           }
@@ -524,10 +524,10 @@ function makeTimestampMethods(options, longs) {
       `
         : (0, ts_poet_1.code) `
         function fromJsonTimestamp(o: any): Timestamp {
-          if (o instanceof Date) {
+          if (o instanceof ${bytes.globalThis}.Date) {
             return ${toTimestamp}(o);
           } else if (typeof o === "string") {
-            return ${toTimestamp}(new Date(o));
+            return ${toTimestamp}(new ${bytes.globalThis}.Date(o));
           } else {
             return Timestamp.fromJSON(o);
           }
@@ -1399,9 +1399,9 @@ function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
     const canonicalFromJson = {
         ["google.protobuf.FieldMask"]: {
             paths: (from) => (0, ts_poet_1.code) `typeof(${from}) === 'string'
-        ? ${from}.split(",").filter(Boolean)
-        : Array.isArray(${from}?.paths)
-        ? ${from}.paths.map(String)
+        ? ${from}.split(",").filter(${ctx.utils.globalThis}.Boolean)
+        : ${ctx.utils.globalThis}.Array.isArray(${from}?.paths)
+        ? ${from}.paths.map(${ctx.utils.globalThis}.String)
         : []`,
         },
     };
@@ -1444,7 +1444,7 @@ function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
                 return (0, ts_poet_1.code) `${utils.fromJsonObjectId}(${from})`;
             }
             else if ((0, types_1.isTimestamp)(field) && options.useDate === options_1.DateOption.STRING) {
-                return (0, ts_poet_1.code) `String(${from})`;
+                return (0, ts_poet_1.code) `${utils.globalThis}.String(${from})`;
             }
             else if ((0, types_1.isTimestamp)(field) &&
                 (options.useDate === options_1.DateOption.DATE || options.useDate === options_1.DateOption.TIMESTAMP)) {
@@ -1507,7 +1507,7 @@ function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
                         return (0, ts_poet_1.code) `${utils.fromJsonObjectId}(${from})`;
                     }
                     else if ((0, types_1.isTimestamp)(valueField) && options.useDate === options_1.DateOption.STRING) {
-                        return (0, ts_poet_1.code) `String(${from})`;
+                        return (0, ts_poet_1.code) `${utils.globalThis}.String(${from})`;
                     }
                     else if ((0, types_1.isTimestamp)(valueField) &&
                         (options.useDate === options_1.DateOption.DATE || options.useDate === options_1.DateOption.TIMESTAMP)) {
@@ -1568,12 +1568,12 @@ function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
                 const fallback = noDefaultValue ? "undefined" : "[]";
                 const readValueSnippet = readSnippet("e");
                 if (readValueSnippet.toString() === (0, ts_poet_1.code) `e`.toString()) {
-                    chunks.push((0, ts_poet_1.code) `${fieldName}: Array.isArray(${jsonPropertyOptional}) ? [...${jsonProperty}] : [],`);
+                    chunks.push((0, ts_poet_1.code) `${fieldName}: ${ctx.utils.globalThis}.Array.isArray(${jsonPropertyOptional}) ? [...${jsonProperty}] : [],`);
                 }
                 else {
                     // Explicit `any` type required to make TS with noImplicitAny happy. `object` is also `any` here.
                     chunks.push((0, ts_poet_1.code) `
-            ${fieldName}: Array.isArray(${jsonPropertyOptional}) ? ${jsonProperty}.map((e: any) => ${readValueSnippet}): ${fallback},
+            ${fieldName}: ${ctx.utils.globalThis}.Array.isArray(${jsonPropertyOptional}) ? ${jsonProperty}.map((e: any) => ${readValueSnippet}): ${fallback},
           `);
                 }
             }
@@ -1606,7 +1606,7 @@ function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
         }
         else if ((0, types_1.isListValueType)(field)) {
             chunks.push((0, ts_poet_1.code) `
-        ${fieldName}: Array.isArray(${jsonProperty})
+        ${fieldName}: ${ctx.utils.globalThis}.Array.isArray(${jsonProperty})
           ? ${readSnippet(`${jsonProperty}`)}
           : undefined,
       `);
@@ -1786,7 +1786,8 @@ function generateToJson(ctx, fullName, fullProtobufTypeName, messageDesc) {
       `);
         }
         else {
-            const check = ((0, types_1.isScalar)(field) || (0, types_1.isEnum)(field)) && !(0, types_1.isWithinOneOf)(field)
+            let emitDefaultValuesForJson = ctx.options.emitDefaultValues.includes("json-methods");
+            const check = ((0, types_1.isScalar)(field) || (0, types_1.isEnum)(field)) && !((0, types_1.isWithinOneOf)(field) || emitDefaultValuesForJson)
                 ? (0, types_1.notDefaultCheck)(ctx, field, messageDesc.options, `message.${fieldName}`)
                 : `message.${fieldName} !== undefined`;
             chunks.push((0, ts_poet_1.code) `
@@ -1987,14 +1988,14 @@ function convertFromObjectKey(ctx, messageDesc, field, variableName) {
             return (0, ts_poet_1.code) `BigInt(${variableName})`;
         }
         else if (ctx.options.forceLong === options_1.LongOption.STRING) {
-            return (0, ts_poet_1.code) `String(${variableName})`;
+            return (0, ts_poet_1.code) `${ctx.utils.globalThis}.String(${variableName})`;
         }
         else {
-            return (0, ts_poet_1.code) `Number(${variableName})`;
+            return (0, ts_poet_1.code) `${ctx.utils.globalThis}.Number(${variableName})`;
         }
     }
     else {
-        return (0, ts_poet_1.code) `Number(${variableName})`;
+        return (0, ts_poet_1.code) `${ctx.utils.globalThis}.Number(${variableName})`;
     }
 }
 function convertToObjectKey(ctx, messageDesc, field, variableName) {

package/build/options.js

@@ -37,6 +37,7 @@ function defaultOptions() {
     return {
         context: false,
         snakeToCamel: ["json", "keys"],
+        emitDefaultValues: [],
         forceLong: LongOption.NUMBER,
         useOptionals: "none",
         useDate: DateOption.DATE,
@@ -147,6 +148,12 @@ function optionsFromParameter(parameter) {
     else if (typeof options.snakeToCamel === "string") {
         options.snakeToCamel = options.snakeToCamel.split("_");
     }
+    if (options.emitDefaultValues === "json-methods") {
+        options.emitDefaultValues = ["json-methods"];
+    }
+    else {
+        options.emitDefaultValues = [];
+    }
     if (options.useJsonWireFormat) {
         if (!options.onlyTypes) {
             // useJsonWireFormat requires onlyTypes=true

package/package.json

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