ts-proto 1.120.0 → 1.121.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [1.121.0](https://github.com/stephenh/ts-proto/compare/v1.120.0...v1.121.0) (2022-07-28)
+
+
+### Features
+
+* Add use-numeric-enum-json option. ([#625](https://github.com/stephenh/ts-proto/issues/625)) ([cd53d8c](https://github.com/stephenh/ts-proto/commit/cd53d8cacd6b4b8fa6517242020b216dd18eebdf))
+
 # [1.120.0](https://github.com/stephenh/ts-proto/compare/v1.119.0...v1.120.0) (2022-07-21)
 
 

package/README.markdown

@@ -435,6 +435,8 @@ Generated code will be placed in the Gradle build directory.
   Requires `onlyTypes=true`. Implies `useDate=string` and `stringEnums=true`. This option is to generate types that can be directly used with marshalling/unmarshalling Protobuf messages serialized as JSON.  
   You may also want to set `useOptionals=all`, as gRPC gateways are not required to send default value for scalar values.
 
+- With '--ts_proto_opt=useNumericEnumForJson=true`, the JSON converter (`toJSON`) will encode enum values as int, rather than a string literal.
+
 ### 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/enums.js

@@ -91,17 +91,31 @@ function generateEnumToJson(ctx, fullName, enumDesc) {
     const { options, utils } = ctx;
     const chunks = [];
     const functionName = (0, case_1.camelCase)(fullName) + 'ToJSON';
-    chunks.push((0, ts_poet_1.code) `export function ${(0, ts_poet_1.def)(functionName)}(object: ${fullName}): string {`);
+    chunks.push((0, ts_poet_1.code) `export function ${(0, ts_poet_1.def)(functionName)}(object: ${fullName}): ${ctx.options.useNumericEnumForJson ? 'number' : 'string'} {`);
     chunks.push((0, ts_poet_1.code) `switch (object) {`);
     for (const valueDesc of enumDesc.value) {
-        chunks.push((0, ts_poet_1.code) `case ${fullName}.${valueDesc.name}: return "${valueDesc.name}";`);
+        if (ctx.options.useNumericEnumForJson) {
+            chunks.push((0, ts_poet_1.code) `case ${fullName}.${valueDesc.name}: return ${valueDesc.number};`);
+        }
+        else {
+            chunks.push((0, ts_poet_1.code) `case ${fullName}.${valueDesc.name}: return "${valueDesc.name}";`);
+        }
     }
     if (options.unrecognizedEnum) {
         chunks.push((0, ts_poet_1.code) `
-      case ${fullName}.${UNRECOGNIZED_ENUM_NAME}:
+      case ${fullName}.${UNRECOGNIZED_ENUM_NAME}:`);
+        if (ctx.options.useNumericEnumForJson) {
+            chunks.push((0, ts_poet_1.code) `
+      default:
+        return ${UNRECOGNIZED_ENUM_VALUE};
+    `);
+        }
+        else {
+            chunks.push((0, ts_poet_1.code) `
       default:
         return "${UNRECOGNIZED_ENUM_NAME}";
     `);
+        }
     }
     else {
         // We use globalThis to avoid conflicts on protobuf types named `Error`.

package/build/main.js

@@ -1481,7 +1481,11 @@ function generateWrap(ctx, fullProtoTypeName, fieldNames) {
     }
     if ((0, types_1.isFieldMaskTypeName)(fullProtoTypeName)) {
         chunks.push((0, ts_poet_1.code) `wrap(paths: string[]): FieldMask {
-      return {paths: paths};
+      const result = createBaseFieldMask();
+
+      result.paths = paths;
+
+      return result;
     }`);
     }
     return chunks;

package/build/options.js

@@ -70,6 +70,7 @@ function defaultOptions() {
         unknownFields: false,
         usePrototypeForDefaults: false,
         useJsonWireFormat: false,
+        useNumericEnumForJson: false,
     };
 }
 exports.defaultOptions = defaultOptions;

package/package.json

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