ts-proto 1.105.2 → 1.106.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [1.106.0](https://github.com/stephenh/ts-proto/compare/v1.105.2...v1.106.0) (2022-02-21)
+
+
+### Features
+
+* Support json names containing non-alphanumeric characters ([#520](https://github.com/stephenh/ts-proto/issues/520)) ([ce44668](https://github.com/stephenh/ts-proto/commit/ce44668b8fe01b14f50ac3c5c950f73db769fa76))
+
 ## [1.105.2](https://github.com/stephenh/ts-proto/compare/v1.105.1...v1.105.2) (2022-02-17)
 
 

package/build/main.js

@@ -895,7 +895,8 @@ 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);
+        const jsonName = utils_1.getFieldJsonName(field, options);
+        const jsonProperty = utils_1.getPropertyAccessor('object', jsonName);
         // get code that extracts value from incoming object
         const readSnippet = (from) => {
             if (types_1.isEnum(field)) {
@@ -1013,8 +1014,8 @@ 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 `
-          ${fieldName}: ${ctx.utils.isObject}(object.${jsonName})
-            ? Object.entries(object.${jsonName}).reduce<${fieldType}>((acc, [key, value]) => {
+          ${fieldName}: ${ctx.utils.isObject}(${jsonProperty})
+            ? Object.entries(${jsonProperty}).reduce<${fieldType}>((acc, [key, value]) => {
                 acc[${i}] = ${readSnippet('value')};
                 return acc;
               }, {})
@@ -1024,12 +1025,12 @@ function generateFromJson(ctx, fullName, messageDesc) {
             else {
                 const readValueSnippet = readSnippet('e');
                 if (readValueSnippet.toString() === ts_poet_1.code `e`.toString()) {
-                    chunks.push(ts_poet_1.code `${fieldName}: Array.isArray(object?.${jsonName}) ? [...object.${jsonName}] : [],`);
+                    chunks.push(ts_poet_1.code `${fieldName}: Array.isArray(object?.${jsonName}) ? [...${jsonProperty}] : [],`);
                 }
                 else {
                     // Explicit `any` type required to make TS with noImplicitAny happy. `object` is also `any` here.
                     chunks.push(ts_poet_1.code `
-            ${fieldName}: Array.isArray(object?.${jsonName}) ? object.${jsonName}.map((e: any) => ${readValueSnippet}): [],
+            ${fieldName}: Array.isArray(object?.${jsonName}) ? ${jsonProperty}.map((e: any) => ${readValueSnippet}): [],
           `);
                 }
             }
@@ -1042,8 +1043,8 @@ function generateFromJson(ctx, fullName, messageDesc) {
                 const fieldName = case_1.maybeSnakeToCamel(messageDesc.oneofDecl[field.oneofIndex].name, options);
                 chunks.push(ts_poet_1.code `${fieldName}: `);
             }
-            const ternaryIf = ts_poet_1.code `${ctx.utils.isSet}(object.${jsonName})`;
-            const ternaryThen = ts_poet_1.code `{ $case: '${fieldName}', ${fieldName}: ${readSnippet(`object.${jsonName}`)}`;
+            const ternaryIf = ts_poet_1.code `${ctx.utils.isSet}(${jsonProperty})`;
+            const ternaryThen = ts_poet_1.code `{ $case: '${fieldName}', ${fieldName}: ${readSnippet(`${jsonProperty}`)}`;
             chunks.push(ts_poet_1.code `${ternaryIf} ? ${ternaryThen}} : `);
             if (field === lastCase) {
                 chunks.push(ts_poet_1.code `undefined,`);
@@ -1051,27 +1052,27 @@ function generateFromJson(ctx, fullName, messageDesc) {
         }
         else if (types_1.isAnyValueType(field)) {
             chunks.push(ts_poet_1.code `${fieldName}: ${ctx.utils.isSet}(object?.${jsonName})
-        ? ${readSnippet(`object.${jsonName}`)}
+        ? ${readSnippet(`${jsonProperty}`)}
         : undefined,
       `);
         }
         else if (types_1.isStructType(field)) {
-            chunks.push(ts_poet_1.code `${fieldName}: ${ctx.utils.isObject}(object.${jsonName})
-          ? ${readSnippet(`object.${jsonName}`)}
+            chunks.push(ts_poet_1.code `${fieldName}: ${ctx.utils.isObject}(${jsonProperty})
+          ? ${readSnippet(`${jsonProperty}`)}
           : undefined,`);
         }
         else if (types_1.isListValueType(field)) {
             chunks.push(ts_poet_1.code `
-        ${fieldName}: Array.isArray(object.${jsonName})
-          ? ${readSnippet(`object.${jsonName}`)}
+        ${fieldName}: Array.isArray(${jsonProperty})
+          ? ${readSnippet(`${jsonProperty}`)}
           : undefined,
       `);
         }
         else {
             const fallback = types_1.isWithinOneOf(field) ? 'undefined' : types_1.defaultValue(ctx, field);
             chunks.push(ts_poet_1.code `
-        ${fieldName}: ${ctx.utils.isSet}(object.${jsonName})
-          ? ${readSnippet(`object.${jsonName}`)}
+        ${fieldName}: ${ctx.utils.isSet}(${jsonProperty})
+          ? ${readSnippet(`${jsonProperty}`)}
           : ${fallback},
       `);
         }
@@ -1092,7 +1093,8 @@ 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 jsonName = utils_1.getFieldJsonName(field, options);
+        const jsonProperty = utils_1.getPropertyAccessor('obj', jsonName);
         const readSnippet = (from) => {
             if (types_1.isEnum(field)) {
                 const toJson = types_1.getEnumMethod(ctx, field.typeName, 'ToJSON');
@@ -1205,11 +1207,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.${jsonName} = ${v});`);
+            chunks.push(ts_poet_1.code `message.${oneofName}?.$case === '${fieldName}' && (${jsonProperty} = ${v});`);
         }
         else {
             const v = readSnippet(`message.${fieldName}`);
-            chunks.push(ts_poet_1.code `message.${fieldName} !== undefined && (obj.${jsonName} = ${v});`);
+            chunks.push(ts_poet_1.code `message.${fieldName} !== undefined && (${jsonProperty} = ${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.impProto = 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;
+exports.impProto = exports.getPropertyAccessor = exports.getFieldJsonName = 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,7 +144,7 @@ class FormattedMethodDescriptor {
     }
 }
 exports.FormattedMethodDescriptor = FormattedMethodDescriptor;
-function determineFieldJsonName(field, options) {
+function getFieldJsonName(field, options) {
     // jsonName will be camelCased by the protocol compiler, plus can be overridden by the user,
     // so just use that instead of our own maybeSnakeToCamel
     if (options.snakeToCamel.includes('json')) {
@@ -154,7 +154,20 @@ function determineFieldJsonName(field, options) {
         return field.name;
     }
 }
-exports.determineFieldJsonName = determineFieldJsonName;
+exports.getFieldJsonName = getFieldJsonName;
+/**
+ * Returns a snippet for reading an object's property, such as `foo.bar`, or `foo['bar']` if the property name contains unusual characters.
+ * For simplicity, we don't match the ECMA 5/6 rules for valid identifiers exactly, and return array syntax liberally.
+ * @param objectName
+ * @param propertyName
+ */
+function getPropertyAccessor(objectName, propertyName) {
+    let validIdentifier = /^[a-zA-Z_$][\w$]*$/;
+    return validIdentifier.test(propertyName)
+        ? `${objectName}.${propertyName}`
+        : `${objectName}[${JSON.stringify(propertyName)}]`;
+}
+exports.getPropertyAccessor = getPropertyAccessor;
 function impProto(options, module, type) {
     return ts_poet_1.imp(`${type}@./${module}${options.fileSuffix}`);
 }

package/package.json

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