ts-proto 1.89.0 → 1.90.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [1.90.0](https://github.com/stephenh/ts-proto/compare/v1.89.0...v1.90.0) (2021-11-24)
+
+
+### Features
+
+*  Add support for 'json_name' annotation ([#408](https://github.com/stephenh/ts-proto/issues/408)) ([b519717](https://github.com/stephenh/ts-proto/commit/b5197174bcaacb8f163cd197d52ab9c645d21d4c))
+
 # [1.89.0](https://github.com/stephenh/ts-proto/compare/v1.88.0...v1.89.0) (2021-11-24)
 
 

package/README.markdown

@@ -379,7 +379,6 @@ The test suite's proto files (i.e. `simple.proto`, `batching.proto`, etc.) curre
 # Todo
 
 - Support the string-based encoding of duration in `fromJSON`/`toJSON`
-- Support the `json_name` annotation
 - Make `oneof=unions` 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/main.js

@@ -814,6 +814,7 @@ function generateFromJson(ctx, fullName, messageDesc) {
     // add a check for each incoming field
     messageDesc.field.forEach((field) => {
         const fieldName = case_1.maybeSnakeToCamel(field.name, options);
+        const jsonName = utils_1.determineFieldJsonName(field, options);
         // get a generic 'reader.doSomething' bit that is specific to the basic type
         const readSnippet = (from) => {
             if (types_1.isEnum(field)) {
@@ -922,7 +923,7 @@ function generateFromJson(ctx, fullName, messageDesc) {
                 const fieldType = types_1.toTypeName(ctx, messageDesc, field);
                 const i = maybeCastToNumber(ctx, messageDesc, field, 'key');
                 chunks.push(ts_poet_1.code `
-          message.${fieldName} = Object.entries(object.${fieldName} ?? {}).reduce<${fieldType}>((acc, [key, value]) => {
+          message.${fieldName} = Object.entries(object.${jsonName} ?? {}).reduce<${fieldType}>((acc, [key, value]) => {
             acc[${i}] = ${readSnippet('value')};
             return acc;
           }, {});
@@ -930,21 +931,21 @@ function generateFromJson(ctx, fullName, messageDesc) {
             }
             else if (types_1.isAnyValueType(field)) {
                 chunks.push(ts_poet_1.code `
-          message.${fieldName} = Array.isArray(object?.${fieldName}) ? [...object.${fieldName}] : [];
+          message.${fieldName} = Array.isArray(object?.${jsonName}) ? [...object.${jsonName}] : [];
         `);
             }
             else {
                 // Explicit `any` type required to make TS with noImplicitAny happy. `object` is also `any` here.
                 chunks.push(ts_poet_1.code `
-          message.${fieldName} = (object.${fieldName} ?? []).map((e: any) => ${readSnippet('e')});
+          message.${fieldName} = (object.${jsonName} ?? []).map((e: any) => ${readSnippet('e')});
         `);
             }
         }
         else if (types_1.isWithinOneOfThatShouldBeUnion(options, field)) {
-            chunks.push(ts_poet_1.code `if (object.${fieldName} !== undefined && object.${fieldName} !== null) {`);
+            chunks.push(ts_poet_1.code `if (object.${jsonName} !== undefined && object.${jsonName} !== null) {`);
             const oneofName = case_1.maybeSnakeToCamel(messageDesc.oneofDecl[field.oneofIndex].name, options);
             chunks.push(ts_poet_1.code `
-        message.${oneofName} = { $case: '${fieldName}', ${fieldName}: ${readSnippet(`object.${fieldName}`)} }
+        message.${oneofName} = { $case: '${fieldName}', ${fieldName}: ${readSnippet(`object.${jsonName}`)} }
       `);
             chunks.push(ts_poet_1.code `}`);
         }
@@ -964,8 +965,8 @@ function generateFromJson(ctx, fullName, messageDesc) {
         else {
             const fallback = types_1.isWithinOneOf(field) ? 'undefined' : types_1.defaultValue(ctx, field);
             chunks.push(ts_poet_1.code `
-        message.${fieldName} = (object.${fieldName} !== undefined && object.${fieldName} !== null)
-          ? ${readSnippet(`object.${fieldName}`)}
+        message.${fieldName} = (object.${jsonName} !== undefined && object.${jsonName} !== null)
+          ? ${readSnippet(`object.${jsonName}`)}
           : ${fallback};
       `);
         }
@@ -986,6 +987,7 @@ function generateToJson(ctx, fullName, messageDesc) {
     // then add a case for each field
     messageDesc.field.forEach((field) => {
         const fieldName = case_1.maybeSnakeToCamel(field.name, options);
+        const jsonName = utils_1.determineFieldJsonName(field, options);
         const readSnippet = (from) => {
             if (types_1.isEnum(field)) {
                 const toJson = types_1.getEnumMethod(typeMap, field.typeName, 'ToJSON');
@@ -1061,10 +1063,10 @@ function generateToJson(ctx, fullName, messageDesc) {
         if (types_1.isMapType(ctx, messageDesc, field)) {
             // Maps might need their values transformed, i.e. bytes --> base64
             chunks.push(ts_poet_1.code `
-        obj.${fieldName} = {};
+        obj.${jsonName} = {};
         if (message.${fieldName}) {
           Object.entries(message.${fieldName}).forEach(([k, v]) => {
-            obj.${fieldName}[k] = ${readSnippet('v')};
+            obj.${jsonName}[k] = ${readSnippet('v')};
           });
         }
       `);
@@ -1073,9 +1075,9 @@ function generateToJson(ctx, fullName, messageDesc) {
             // Arrays might need their elements transformed
             chunks.push(ts_poet_1.code `
         if (message.${fieldName}) {
-          obj.${fieldName} = message.${fieldName}.map(e => ${readSnippet('e')});
+          obj.${jsonName} = message.${fieldName}.map(e => ${readSnippet('e')});
         } else {
-          obj.${fieldName} = [];
+          obj.${jsonName} = [];
         }
       `);
         }
@@ -1083,11 +1085,11 @@ function generateToJson(ctx, fullName, messageDesc) {
             // oneofs in a union are only output as `oneof name = ...`
             const oneofName = case_1.maybeSnakeToCamel(messageDesc.oneofDecl[field.oneofIndex].name, options);
             const v = readSnippet(`message.${oneofName}?.${fieldName}`);
-            chunks.push(ts_poet_1.code `message.${oneofName}?.$case === '${fieldName}' && (obj.${fieldName} = ${v});`);
+            chunks.push(ts_poet_1.code `message.${oneofName}?.$case === '${fieldName}' && (obj.${jsonName} = ${v});`);
         }
         else {
             const v = readSnippet(`message.${fieldName}`);
-            chunks.push(ts_poet_1.code `message.${fieldName} !== undefined && (obj.${fieldName} = ${v});`);
+            chunks.push(ts_poet_1.code `message.${fieldName} !== undefined && (obj.${jsonName} = ${v});`);
         }
     });
     chunks.push(ts_poet_1.code `return obj;`);

package/build/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FormattedMethodDescriptor = exports.assertInstanceOf = exports.maybePrefixPackage = exports.prefixDisableLinter = exports.maybeAddComment = exports.upperFirst = exports.lowerFirst = exports.singular = exports.fail = exports.readToBuffer = exports.protoFilesToGenerate = void 0;
+exports.determineFieldJsonName = exports.FormattedMethodDescriptor = exports.assertInstanceOf = exports.maybePrefixPackage = exports.prefixDisableLinter = exports.maybeAddComment = exports.upperFirst = exports.lowerFirst = exports.singular = exports.fail = exports.readToBuffer = exports.protoFilesToGenerate = void 0;
 const ts_poet_1 = require("ts-poet");
 const options_1 = require("./options");
 const case_1 = require("./case");
@@ -144,3 +144,12 @@ class FormattedMethodDescriptor {
     }
 }
 exports.FormattedMethodDescriptor = FormattedMethodDescriptor;
+function determineFieldJsonName(field, options) {
+    // By default jsonName is camelCased by the protocol compilier unless the user has
+    // set a "json_name" option on this field.
+    if (field.jsonName.length > 0) {
+        return field.jsonName;
+    }
+    return case_1.maybeSnakeToCamel(field.name, options);
+}
+exports.determineFieldJsonName = determineFieldJsonName;

package/package.json

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