ts-proto 1.161.1 → 1.162.0

package/README.markdown

@@ -477,6 +477,8 @@ Generated code will be placed in the Gradle build directory.
 
   Note that, as indicated, this means Object.keys will not include set-by-default fields, so if you have code that iterates over messages keys in a generic fashion, it will have to also iterate over keys inherited from the prototype.
 
+- With `--ts_proto_opt=useJsonName=true`, `json_name` defined in protofiles will be used instead of message field names.
+
 - With `--ts_proto_opt=useJsonWireFormat=true`, the generated code will reflect the JSON representation of Protobuf messages.
 
   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.

package/build/main.js

@@ -615,10 +615,10 @@ function generateInterfaceDeclaration(ctx, fullName, messageDesc, sourceInfo, fu
         }
         const info = sourceInfo.lookup(sourceInfo_1.Fields.message.field, index);
         (0, utils_1.maybeAddComment)(info, chunks, (_a = fieldDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated);
-        const name = (0, case_1.maybeSnakeToCamel)(fieldDesc.name, options);
+        const { validatedPropertyName } = (0, utils_1.propertyNameComposition)(fieldDesc, options);
         const isOptional = (0, types_1.isOptionalProperty)(fieldDesc, messageDesc.options, options);
         const type = (0, types_1.toTypeName)(ctx, messageDesc, fieldDesc, isOptional);
-        chunks.push((0, ts_poet_1.code) `${maybeReadonly(options)}${name}${isOptional ? "?" : ""}: ${type}, `);
+        chunks.push((0, ts_poet_1.code) `${maybeReadonly(options)}${validatedPropertyName}${isOptional ? "?" : ""}: ${type}, `);
     });
     if (ctx.options.unknownFields) {
         chunks.push((0, ts_poet_1.code) `_unknownFields?: {[key: number]: Uint8Array[]} | undefined,`);
@@ -669,7 +669,9 @@ function generateBaseInstanceFactory(ctx, fullName, messageDesc, fullTypeName) {
             const { oneofIndex } = field;
             if (!processedOneofs.has(oneofIndex)) {
                 processedOneofs.add(oneofIndex);
-                const name = (0, case_1.maybeSnakeToCamel)(messageDesc.oneofDecl[oneofIndex].name, ctx.options);
+                const name = options.useJsonName
+                    ? (0, utils_1.propertyNameComposition)(field, options).validatedPropertyName
+                    : (0, case_1.maybeSnakeToCamel)(messageDesc.oneofDecl[oneofIndex].name, ctx.options);
                 fields.push((0, ts_poet_1.code) `${name}: undefined`);
             }
             continue;
@@ -677,7 +679,7 @@ function generateBaseInstanceFactory(ctx, fullName, messageDesc, fullTypeName) {
         if (!options.initializeFieldsAsUndefined && (0, types_1.isOptionalProperty)(field, messageDesc.options, options)) {
             continue;
         }
-        const name = (0, case_1.maybeSnakeToCamel)(field.name, ctx.options);
+        const { validatedPropertyName } = (0, utils_1.propertyNameComposition)(field, options);
         const val = (0, types_1.isWithinOneOf)(field)
             ? "undefined"
             : (0, types_1.isMapType)(ctx, messageDesc, field)
@@ -687,7 +689,7 @@ function generateBaseInstanceFactory(ctx, fullName, messageDesc, fullTypeName) {
                 : (0, types_1.isRepeated)(field)
                     ? "[]"
                     : (0, types_1.defaultValue)(ctx, field);
-        fields.push((0, ts_poet_1.code) `${name}: ${val}`);
+        fields.push((0, ts_poet_1.code) `${validatedPropertyName}: ${val}`);
     }
     if ((0, options_1.addTypeToMessages)(options)) {
         fields.unshift((0, ts_poet_1.code) `$type: '${fullTypeName}'`);
@@ -795,7 +797,8 @@ function generateDecode(ctx, fullName, messageDesc) {
   `);
     // add a case for each incoming field
     messageDesc.field.forEach((field) => {
-        const fieldName = (0, case_1.maybeSnakeToCamel)(field.name, options);
+        const { propertyName } = (0, utils_1.propertyNameComposition)(field, options);
+        const messageProperty = (0, utils_1.getPropertyAccessor)("message", propertyName);
         chunks.push((0, ts_poet_1.code) `case ${field.number}:`);
         const tag = ((field.number << 3) | (0, types_1.basicWireType)(field.type)) >>> 0;
         const tagCheck = (0, ts_poet_1.code) `
@@ -816,15 +819,15 @@ function generateDecode(ctx, fullName, messageDesc) {
                 const generateMapType = (0, types_1.shouldGenerateJSMapType)(ctx, messageDesc, field);
                 let valueSetterSnippet;
                 if (generateMapType) {
-                    valueSetterSnippet = `message.${fieldName}${maybeNonNullAssertion}.set(${varName}.key, ${varName}.value)`;
+                    valueSetterSnippet = `${messageProperty}${maybeNonNullAssertion}.set(${varName}.key, ${varName}.value)`;
                 }
                 else {
-                    valueSetterSnippet = `message.${fieldName}${maybeNonNullAssertion}[${varName}.key] = ${varName}.value`;
+                    valueSetterSnippet = `${messageProperty}${maybeNonNullAssertion}[${varName}.key] = ${varName}.value`;
                 }
                 const initializerSnippet = initializerNecessary
                     ? `
-            if (message.${fieldName} === undefined) {
-              message.${fieldName} = ${generateMapType ? "new Map()" : "{}"};
+            if (${messageProperty} === undefined) {
+              ${messageProperty} = ${generateMapType ? "new Map()" : "{}"};
             }`
                     : "";
                 chunks.push((0, ts_poet_1.code) `
@@ -839,15 +842,15 @@ function generateDecode(ctx, fullName, messageDesc) {
             else {
                 const initializerSnippet = initializerNecessary
                     ? `
-            if (message.${fieldName} === undefined) {
-              message.${fieldName} = [];
+            if (${messageProperty} === undefined) {
+              ${messageProperty} = [];
             }`
                     : "";
                 if ((0, types_1.packedType)(field.type) === undefined) {
                     chunks.push((0, ts_poet_1.code) `
             ${tagCheck}
             ${initializerSnippet}
-            message.${fieldName}${maybeNonNullAssertion}.push(${readSnippet});
+            ${messageProperty}${maybeNonNullAssertion}.push(${readSnippet});
           `);
                 }
                 else {
@@ -855,7 +858,7 @@ function generateDecode(ctx, fullName, messageDesc) {
                     chunks.push((0, ts_poet_1.code) `
             if (tag === ${tag}) {
               ${initializerSnippet}
-              message.${fieldName}${maybeNonNullAssertion}.push(${readSnippet});
+              ${messageProperty}${maybeNonNullAssertion}.push(${readSnippet});
 
               continue;
             }
@@ -864,7 +867,7 @@ function generateDecode(ctx, fullName, messageDesc) {
               ${initializerSnippet}
               const end2 = reader.uint32() + reader.pos;
               while (reader.pos < end2) {
-                message.${fieldName}${maybeNonNullAssertion}.push(${readSnippet});
+                ${messageProperty}${maybeNonNullAssertion}.push(${readSnippet});
               }
 
               continue;
@@ -876,16 +879,18 @@ function generateDecode(ctx, fullName, messageDesc) {
             }
         }
         else if ((0, types_1.isWithinOneOfThatShouldBeUnion)(options, field)) {
-            let oneofName = (0, case_1.maybeSnakeToCamel)(messageDesc.oneofDecl[field.oneofIndex].name, options);
+            const oneofNameWithMessage = options.useJsonName
+                ? messageProperty
+                : (0, utils_1.getPropertyAccessor)("message", (0, case_1.maybeSnakeToCamel)(messageDesc.oneofDecl[field.oneofIndex].name, options));
             chunks.push((0, ts_poet_1.code) `
         ${tagCheck}
-        message.${oneofName} = { $case: '${fieldName}', ${fieldName}: ${readSnippet} };
+        ${oneofNameWithMessage} = { $case: '${propertyName}', ${propertyName}: ${readSnippet} };
       `);
         }
         else {
             chunks.push((0, ts_poet_1.code) `
         ${tagCheck}
-        message.${fieldName} = ${readSnippet};
+        ${messageProperty} = ${readSnippet};
       `);
         }
         if (!(0, types_1.isRepeated)(field) || (0, types_1.packedType)(field.type) === undefined) {
@@ -1020,7 +1025,8 @@ function generateEncode(ctx, fullName, messageDesc) {
         .reduce((result, field) => ((result[field.oneofIndex] || (result[field.oneofIndex] = [])).push(field), result), {});
     // then add a case for each field
     messageDesc.field.forEach((field) => {
-        const fieldName = (0, case_1.maybeSnakeToCamel)(field.name, options);
+        const { propertyName, validatedPropertyName } = (0, utils_1.propertyNameComposition)(field, options);
+        const messageProperty = (0, utils_1.getPropertyAccessor)("message", propertyName);
         // get a generic writer.doSomething based on the basic type
         const writeSnippet = getEncodeWriteSnippet(ctx, field);
         const isOptional = (0, types_1.isOptionalProperty)(field, messageDesc.options, options);
@@ -1039,14 +1045,14 @@ function generateEncode(ctx, fullName, messageDesc) {
                 const optionalAlternative = isOptional ? (useMapType ? " || new Map()" : " || {}") : "";
                 if (useMapType) {
                     chunks.push((0, ts_poet_1.code) `
-            (message.${fieldName}${optionalAlternative}).forEach((value, key) => {
+            (${messageProperty}${optionalAlternative}).forEach((value, key) => {
               ${entryWriteSnippet}
             });
           `);
                 }
                 else {
                     chunks.push((0, ts_poet_1.code) `
-            Object.entries(message.${fieldName}${optionalAlternative}).forEach(([key, value]) => {
+            Object.entries(${messageProperty}${optionalAlternative}).forEach(([key, value]) => {
               ${entryWriteSnippet}
             });
           `);
@@ -1054,13 +1060,13 @@ function generateEncode(ctx, fullName, messageDesc) {
             }
             else if ((0, types_1.packedType)(field.type) === undefined) {
                 const listWriteSnippet = (0, ts_poet_1.code) `
-          for (const v of message.${fieldName}) {
+          for (const v of ${messageProperty}) {
             ${writeSnippet("v!")};
           }
         `;
                 if (isOptional) {
                     chunks.push((0, ts_poet_1.code) `
-            if (message.${fieldName} !== undefined && message.${fieldName}.length !== 0) {
+            if (${messageProperty} !== undefined && ${messageProperty}.length !== 0) {
               ${listWriteSnippet}
             }
           `);
@@ -1078,14 +1084,14 @@ function generateEncode(ctx, fullName, messageDesc) {
                 const toNumber = (0, types_1.getEnumMethod)(ctx, field.typeName, "ToNumber");
                 const listWriteSnippet = (0, ts_poet_1.code) `
           writer.uint32(${tag}).fork();
-          for (const v of message.${fieldName}) {
+          for (const v of ${messageProperty}) {
             writer.${(0, types_1.toReaderCall)(field)}(${toNumber}(v));
           }
           writer.ldelim();
         `;
                 if (isOptional) {
                     chunks.push((0, ts_poet_1.code) `
-            if (message.${fieldName} !== undefined && message.${fieldName}.length !== 0) {
+            if (${messageProperty} !== undefined && ${messageProperty}.length !== 0) {
               ${listWriteSnippet}
             }
           `);
@@ -1100,7 +1106,7 @@ function generateEncode(ctx, fullName, messageDesc) {
                 const rhs = (x) => ((0, types_1.isLong)(field) && options.forceLong === options_1.LongOption.BIGINT ? `${x}.toString()` : x);
                 let listWriteSnippet = (0, ts_poet_1.code) `
           writer.uint32(${tag}).fork();
-          for (const v of message.${fieldName}) {
+          for (const v of ${messageProperty}) {
             writer.${(0, types_1.toReaderCall)(field)}(${rhs("v")});
           }
           writer.ldelim();
@@ -1113,9 +1119,9 @@ function generateEncode(ctx, fullName, messageDesc) {
                         case "sfixed64":
                             listWriteSnippet = (0, ts_poet_1.code) `
                 writer.uint32(${tag}).fork();
-                for (const v of message.${fieldName}) {
+                for (const v of ${messageProperty}) {
                   if (BigInt.asIntN(64, v) !== v) {
-                    throw new Error('a value provided in array field ${fieldName} of type ${fieldType} is too large');
+                    throw new Error('a value provided in array field ${propertyName} of type ${fieldType} is too large');
                   }
                   writer.${(0, types_1.toReaderCall)(field)}(${rhs("v")});
                 }
@@ -1126,9 +1132,9 @@ function generateEncode(ctx, fullName, messageDesc) {
                         case "fixed64":
                             listWriteSnippet = (0, ts_poet_1.code) `
                 writer.uint32(${tag}).fork();
-                for (const v of message.${fieldName}) {
+                for (const v of ${messageProperty}) {
                   if (BigInt.asUintN(64, v) !== v) {
-                    throw new Error('a value provided in array field ${fieldName} of type ${fieldType} is too large');
+                    throw new Error('a value provided in array field ${propertyName} of type ${fieldType} is too large');
                   }                
                   writer.${(0, types_1.toReaderCall)(field)}(${rhs("v")});
                 }
@@ -1141,7 +1147,7 @@ function generateEncode(ctx, fullName, messageDesc) {
                 }
                 if (isOptional) {
                     chunks.push((0, ts_poet_1.code) `
-            if (message.${fieldName} !== undefined && message.${fieldName}.length !== 0) {
+            if (${messageProperty} !== undefined && ${messageProperty}.length !== 0) {
               ${listWriteSnippet}
             }
           `);
@@ -1154,13 +1160,15 @@ function generateEncode(ctx, fullName, messageDesc) {
         else if ((0, types_1.isWithinOneOfThatShouldBeUnion)(options, field)) {
             if (!processedOneofs.has(field.oneofIndex)) {
                 processedOneofs.add(field.oneofIndex);
-                const oneofName = (0, case_1.maybeSnakeToCamel)(messageDesc.oneofDecl[field.oneofIndex].name, options);
-                chunks.push((0, ts_poet_1.code) `switch (message.${oneofName}?.$case) {`);
+                const oneofNameWithMessage = options.useJsonName
+                    ? messageProperty
+                    : (0, utils_1.getPropertyAccessor)("message", (0, case_1.maybeSnakeToCamel)(messageDesc.oneofDecl[field.oneofIndex].name, options));
+                chunks.push((0, ts_poet_1.code) `switch (${oneofNameWithMessage}?.$case) {`);
                 for (const oneOfField of oneOfFieldsDict[field.oneofIndex]) {
                     const writeSnippet = getEncodeWriteSnippet(ctx, oneOfField);
                     const oneOfFieldName = (0, case_1.maybeSnakeToCamel)(oneOfField.name, ctx.options);
                     chunks.push((0, ts_poet_1.code) `case "${oneOfFieldName}":
-            ${writeSnippet(`message.${oneofName}.${oneOfFieldName}`)};
+            ${writeSnippet(`${oneofNameWithMessage}.${oneOfFieldName}`)};
             break;`);
                 }
                 chunks.push((0, ts_poet_1.code) `}`);
@@ -1169,27 +1177,27 @@ function generateEncode(ctx, fullName, messageDesc) {
         else if ((0, types_1.isWithinOneOf)(field)) {
             // Oneofs don't have a default value check b/c they need to denote which-oneof presence
             chunks.push((0, ts_poet_1.code) `
-        if (message.${fieldName} !== undefined) {
-          ${writeSnippet(`message.${fieldName}`)};
+        if (${messageProperty} !== undefined) {
+          ${writeSnippet(`${messageProperty}`)};
         }
       `);
         }
         else if ((0, types_1.isMessage)(field)) {
             chunks.push((0, ts_poet_1.code) `
-        if (message.${fieldName} !== undefined) {
-          ${writeSnippet(`message.${fieldName}`)};
+        if (${messageProperty} !== undefined) {
+          ${writeSnippet(`${messageProperty}`)};
         }
       `);
         }
         else if ((0, types_1.isScalar)(field) || (0, types_1.isEnum)(field)) {
             chunks.push((0, ts_poet_1.code) `
-        if (${(0, types_1.notDefaultCheck)(ctx, field, messageDesc.options, `message.${fieldName}`)}) {
-          ${writeSnippet(`message.${fieldName}`)};
+        if (${(0, types_1.notDefaultCheck)(ctx, field, messageDesc.options, `${messageProperty}`)}) {
+          ${writeSnippet(`${messageProperty}`)};
         }
       `);
         }
         else {
-            chunks.push((0, ts_poet_1.code) `${writeSnippet(`message.${fieldName}`)};`);
+            chunks.push((0, ts_poet_1.code) `${writeSnippet(`${messageProperty}`)};`);
         }
     });
     if (options.unknownFields) {
@@ -1461,7 +1469,7 @@ function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
     // add a check for each incoming field
     messageDesc.field.forEach((field) => {
         var _a;
-        const fieldName = (0, case_1.maybeSnakeToCamel)(field.name, options);
+        const { validatedPropertyName: fieldName } = (0, utils_1.propertyNameComposition)(field, options);
         const jsonName = (0, utils_1.getFieldJsonName)(field, options);
         const jsonProperty = (0, utils_1.getPropertyAccessor)("object", jsonName);
         const jsonPropertyOptional = (0, utils_1.getPropertyAccessor)("object", jsonName, true);
@@ -1703,9 +1711,10 @@ function generateToJson(ctx, fullName, fullProtobufTypeName, messageDesc) {
   `);
     // then add a case for each field
     messageDesc.field.forEach((field) => {
-        const fieldName = (0, case_1.maybeSnakeToCamel)(field.name, options);
+        const { validatedPropertyName: fieldName, propertyName } = (0, utils_1.propertyNameComposition)(field, options);
         const jsonName = (0, utils_1.getFieldJsonName)(field, options);
         const jsonProperty = (0, utils_1.getPropertyAccessor)("obj", jsonName);
+        const messageProperty = (0, utils_1.getPropertyAccessor)("message", propertyName);
         const readSnippet = (from) => {
             if ((0, types_1.isEnum)(field)) {
                 const toJson = (0, types_1.getEnumMethod)(ctx, field.typeName, "ToJSON");
@@ -1797,9 +1806,9 @@ function generateToJson(ctx, fullName, fullProtobufTypeName, messageDesc) {
             const i = convertToObjectKey(ctx, messageDesc, field, "k");
             if ((0, types_1.shouldGenerateJSMapType)(ctx, messageDesc, field)) {
                 chunks.push((0, ts_poet_1.code) `
-          if (message.${fieldName}?.size) {
+          if (${messageProperty}?.size) {
             ${jsonProperty} = {};
-            message.${fieldName}.forEach((v, k) => {
+            ${messageProperty}.forEach((v, k) => {
               ${jsonProperty}[${i}] = ${readSnippet("v")};
             });
           }
@@ -1807,8 +1816,8 @@ function generateToJson(ctx, fullName, fullProtobufTypeName, messageDesc) {
             }
             else {
                 chunks.push((0, ts_poet_1.code) `
-        if (message.${fieldName}) {
-            const entries = Object.entries(message.${fieldName});
+        if (${messageProperty}) {
+            const entries = Object.entries(${messageProperty});
             if (entries.length > 0) {
               ${jsonProperty} = {};
               entries.forEach(([k, v]) => {
@@ -1824,28 +1833,30 @@ function generateToJson(ctx, fullName, fullProtobufTypeName, messageDesc) {
             const transformElement = readSnippet("e");
             const maybeMap = transformElement.toCodeString([]) !== "e" ? (0, ts_poet_1.code) `.map(e => ${transformElement})` : "";
             chunks.push((0, ts_poet_1.code) `
-        if (message.${fieldName}?.length) {
-          ${jsonProperty} = message.${fieldName}${maybeMap};
+        if (${messageProperty}?.length) {
+          ${jsonProperty} = ${messageProperty}${maybeMap};
         }
       `);
         }
         else if ((0, types_1.isWithinOneOfThatShouldBeUnion)(options, field)) {
             // oneofs in a union are only output as `oneof name = ...`
-            const oneofName = (0, case_1.maybeSnakeToCamel)(messageDesc.oneofDecl[field.oneofIndex].name, options);
+            const oneofNameWithMessage = options.useJsonName
+                ? messageProperty
+                : (0, utils_1.getPropertyAccessor)("message", (0, case_1.maybeSnakeToCamel)(messageDesc.oneofDecl[field.oneofIndex].name, options));
             chunks.push((0, ts_poet_1.code) `
-        if (message.${oneofName}?.$case === '${fieldName}') {
-          ${jsonProperty} = ${readSnippet(`message.${oneofName}.${fieldName}`)};
+        if (${oneofNameWithMessage}?.$case === '${fieldName}') {
+          ${jsonProperty} = ${readSnippet(`${oneofNameWithMessage}.${fieldName}`)};
         }
       `);
         }
         else {
             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`;
+                ? (0, types_1.notDefaultCheck)(ctx, field, messageDesc.options, `${messageProperty}`)
+                : `${messageProperty} !== undefined`;
             chunks.push((0, ts_poet_1.code) `
         if (${check}) {
-          ${jsonProperty} = ${readSnippet(`message.${fieldName}`)};
+          ${jsonProperty} = ${readSnippet(`${messageProperty}`)};
         }
       `);
         }
@@ -1891,7 +1902,9 @@ function generateFromPartial(ctx, fullName, messageDesc) {
     chunks.push((0, ts_poet_1.code) `const message = ${createBase}${maybeAsAny(options)};`);
     // add a check for each incoming field
     messageDesc.field.forEach((field) => {
-        const fieldName = (0, case_1.maybeSnakeToCamel)(field.name, options);
+        const { propertyName } = (0, utils_1.propertyNameComposition)(field, options);
+        const messageProperty = (0, utils_1.getPropertyAccessor)("message", propertyName);
+        const objectProperty = (0, utils_1.getPropertyAccessor)("object", propertyName);
         const readSnippet = (from) => {
             if (((0, types_1.isLong)(field) || (0, types_1.isLongValueType)(field)) && options.forceLong === options_1.LongOption.LONG) {
                 return (0, ts_poet_1.code) `Long.fromValue(${from})`;
@@ -1962,13 +1975,13 @@ function generateFromPartial(ctx, fullName, messageDesc) {
                 const fieldType = (0, types_1.toTypeName)(ctx, messageDesc, field);
                 const i = convertFromObjectKey(ctx, messageDesc, field, "key");
                 const noValueSnippet = noDefaultValue
-                    ? `(object.${fieldName} === undefined || object.${fieldName} === null) ? undefined : `
+                    ? `(${objectProperty} === undefined || ${objectProperty} === null) ? undefined : `
                     : "";
                 if ((0, types_1.shouldGenerateJSMapType)(ctx, messageDesc, field)) {
                     chunks.push((0, ts_poet_1.code) `
-            message.${fieldName} = ${noValueSnippet} (() => {
+            ${messageProperty} = ${noValueSnippet} (() => {
               const m = new Map();
-              (object.${fieldName} as ${fieldType} ?? new Map()).forEach((value, key) => {
+              (${objectProperty} as ${fieldType} ?? new Map()).forEach((value, key) => {
                 if (value !== undefined) {
                   m.set(key, ${readSnippet("value")});
                 }
@@ -1979,7 +1992,7 @@ function generateFromPartial(ctx, fullName, messageDesc) {
                 }
                 else {
                     chunks.push((0, ts_poet_1.code) `
-            message.${fieldName} = ${noValueSnippet} Object.entries(object.${fieldName} ?? {}).reduce<${fieldType}>((acc, [key, value]) => {
+            ${messageProperty} = ${noValueSnippet} Object.entries(${objectProperty} ?? {}).reduce<${fieldType}>((acc, [key, value]) => {
               if (value !== undefined) {
                 acc[${i}] = ${readSnippet("value")};
               }
@@ -1991,33 +2004,37 @@ function generateFromPartial(ctx, fullName, messageDesc) {
             else {
                 const fallback = noDefaultValue ? "undefined" : "[]";
                 chunks.push((0, ts_poet_1.code) `
-          message.${fieldName} = object.${fieldName}?.map((e) => ${readSnippet("e")}) || ${fallback};
+          ${messageProperty} = ${objectProperty}?.map((e) => ${readSnippet("e")}) || ${fallback};
         `);
             }
         }
         else if ((0, types_1.isWithinOneOfThatShouldBeUnion)(options, field)) {
-            let oneofName = (0, case_1.maybeSnakeToCamel)(messageDesc.oneofDecl[field.oneofIndex].name, options);
-            const v = readSnippet(`object.${oneofName}.${fieldName}`);
+            const oneofName = options.useJsonName
+                ? propertyName
+                : (0, case_1.maybeSnakeToCamel)(messageDesc.oneofDecl[field.oneofIndex].name, options);
+            const oneofNameWithMessage = (0, utils_1.getPropertyAccessor)("message", oneofName);
+            const oneofNameWithObject = (0, utils_1.getPropertyAccessor)("object", oneofName);
+            const v = readSnippet(`${oneofNameWithObject}.${propertyName}`);
             chunks.push((0, ts_poet_1.code) `
         if (
-          object.${oneofName}?.$case === '${fieldName}'
-          && object.${oneofName}?.${fieldName} !== undefined
-          && object.${oneofName}?.${fieldName} !== null
+          ${oneofNameWithObject}?.$case === '${propertyName}'
+          && ${oneofNameWithObject}?.${propertyName} !== undefined
+          && ${oneofNameWithObject}?.${propertyName} !== null
         ) {
-          message.${oneofName} = { $case: '${fieldName}', ${fieldName}: ${v} };
+          ${oneofNameWithMessage} = { $case: '${propertyName}', ${propertyName}: ${v} };
         }
       `);
         }
         else if (readSnippet(`x`).toCodeString([]) == "x") {
             // An optimized case of the else below that works when `readSnippet` returns the plain input
             const fallback = (0, types_1.isWithinOneOf)(field) || noDefaultValue ? "undefined" : (0, types_1.defaultValue)(ctx, field);
-            chunks.push((0, ts_poet_1.code) `message.${fieldName} = object.${fieldName} ?? ${fallback};`);
+            chunks.push((0, ts_poet_1.code) `${messageProperty} = ${objectProperty} ?? ${fallback};`);
         }
         else {
             const fallback = (0, types_1.isWithinOneOf)(field) || noDefaultValue ? "undefined" : (0, types_1.defaultValue)(ctx, field);
             chunks.push((0, ts_poet_1.code) `
-        message.${fieldName} = (object.${fieldName} !== undefined && object.${fieldName} !== null)
-          ? ${readSnippet(`object.${fieldName}`)}
+        ${messageProperty} = (${objectProperty} !== undefined && ${objectProperty} !== null)
+          ? ${readSnippet(`${objectProperty}`)}
           : ${fallback};
       `);
         }

package/build/options.js

@@ -77,6 +77,7 @@ function defaultOptions() {
         useAsyncIterable: false,
         unknownFields: false,
         usePrototypeForDefaults: false,
+        useJsonName: false,
         useJsonWireFormat: false,
         useNumericEnumForJson: false,
         initializeFieldsAsUndefined: true,

package/build/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.impProto = exports.impFile = 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.generateIndexFiles = exports.protoFilesToGenerate = void 0;
+exports.impProto = exports.impFile = exports.getPropertyAccessor = exports.propertyNameComposition = exports.getFieldJsonName = exports.FormattedMethodDescriptor = exports.assertInstanceOf = exports.maybePrefixPackage = exports.prefixDisableLinter = exports.maybeAddComment = exports.upperFirst = exports.lowerFirst = exports.singular = exports.fail = exports.readToBuffer = exports.generateIndexFiles = exports.protoFilesToGenerate = void 0;
 const path = require("path");
 const ts_poet_1 = require("ts-poet");
 const options_1 = require("./options");
@@ -181,6 +181,10 @@ class FormattedMethodDescriptor {
 }
 exports.FormattedMethodDescriptor = FormattedMethodDescriptor;
 function getFieldJsonName(field, options) {
+    // use "json_name" defined in a proto file
+    if (options.useJsonName) {
+        return field.jsonName;
+    }
     // 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")) {
@@ -195,6 +199,30 @@ function getFieldJsonName(field, options) {
     }
 }
 exports.getFieldJsonName = getFieldJsonName;
+function propertyNameComposition(field, options) {
+    if (options.useJsonName) {
+        const jsonName = field.jsonName;
+        return {
+            propertyName: jsonName,
+            validatedPropertyName: validateObjectProperty(jsonName),
+        };
+    }
+    const propertyName = (0, case_1.maybeSnakeToCamel)(field.name, options);
+    return {
+        propertyName,
+        validatedPropertyName: propertyName,
+    };
+}
+exports.propertyNameComposition = propertyNameComposition;
+/**
+ * https://github.com/eslint-community/eslint-plugin-security/blob/main/docs/the-dangers-of-square-bracket-notation.md
+ */
+function isValidateObjectProperty(propertyName) {
+    return /^[a-zA-Z_$][\w$]*$/.test(propertyName);
+}
+function validateObjectProperty(propertyName) {
+    return isValidateObjectProperty(propertyName) ? propertyName : JSON.stringify(propertyName);
+}
 /**
  * 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.
@@ -203,10 +231,9 @@ exports.getFieldJsonName = getFieldJsonName;
  * @param optional
  */
 function getPropertyAccessor(objectName, propertyName, optional = false) {
-    let validIdentifier = /^[a-zA-Z_$][\w$]*$/;
-    return validIdentifier.test(propertyName)
+    return isValidateObjectProperty(propertyName)
         ? `${objectName}${optional ? "?" : ""}.${propertyName}`
-        : `${objectName}${optional ? "?." : ""}[${JSON.stringify(propertyName)}]`;
+        : `${objectName}${optional ? "?." : ""}[${validateObjectProperty(propertyName)}]`;
 }
 exports.getPropertyAccessor = getPropertyAccessor;
 function impFile(options, spec) {

package/package.json

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