ts-proto 2.10.0 → 2.11.0

package/README.markdown

@@ -414,6 +414,9 @@ Generated code will be placed in the Gradle build directory.
 
   The default behavior is `keys_json`, i.e. both will be camel cased, and `json_name` will be used if set.
 
+- With `--ts_proto_opt=protoJsonFormat=true` (default), the `toJSON` and `fromJSON`  methods follow the [protoJSON format](https://protobuf.dev/programming-guides/json). This means `toJSON` will output standard lowerCamelCase keys (or custom `json_name` if set). `fromJSON` will accept both the lowerCamelCase key (or `json_name`) AND the original proto field name.
+With `--ts_proto_opt=protoJsonFormat=false`, strict proto3 compliance is disabled. The JSON keys will simply follow the `snakeToCamel` option, and `fromJSON` will only accept that specific format.
+
 - With `--ts_proto_opt=outputEncodeMethods=false`, the `Message.encode` and `Message.decode` methods for working with protobuf-encoded/binary data will not be output.
 
   This is useful if you want "only types".

package/build/src/generate-struct-wrappers.js

@@ -36,7 +36,7 @@ function generateWrapDeep(ctx, fullProtoTypeName, fieldNames) {
       const struct = createBase${(0, utils_1.wrapTypeName)(ctx.options, "Struct")}();
       ${defaultFields}
       if (object !== undefined) {
-        for (const key of Object.keys(object)) {
+        for (const key of ${ctx.utils.globalThis}.Object.keys(object)) {
           ${setStatement}
         }
       }
@@ -105,7 +105,7 @@ function generateUnwrapDeep(ctx, fullProtoTypeName, fieldNames) {
             chunks.push((0, ts_poet_1.code) `unwrap(message: ${(0, utils_1.wrapTypeName)(ctx.options, "Struct")}): {[key: string]: any} {
         const object: { [key: string]: any } = {};
         if (message.fields) {
-          for (const key of Object.keys(message.fields)) {
+          for (const key of ${ctx.utils.globalThis}.Object.keys(message.fields)) {
             object[key] = Value.unwrap(message.fields[key]);
           }
         }
@@ -168,7 +168,7 @@ function generateWrapShallow(ctx, fullProtoTypeName, fieldNames) {
       const struct = createBase${(0, utils_1.wrapTypeName)(ctx.options, "Struct")}();
       ${defaultFields}
       if (object !== undefined) {
-        for (const key of Object.keys(object)) {
+        for (const key of ${ctx.utils.globalThis}.Object.keys(object)) {
           ${setStatement}
         }
       }
@@ -280,7 +280,7 @@ function generateUnwrapShallow(ctx, fullProtoTypeName, fieldNames) {
             chunks.push((0, ts_poet_1.code) `unwrap(message: ${(0, utils_1.wrapTypeName)(ctx.options, "Struct")}): {[key: string]: any} {
         const object: { [key: string]: any } = {};
         if (message.fields) {
-          for (const key of Object.keys(message.fields)) {
+          for (const key of ${ctx.utils.globalThis}.Object.keys(message.fields)) {
             object[key] = message.fields[key];
           }
         }

package/build/src/main.js

@@ -1358,7 +1358,8 @@ function generateEncode(ctx, fullName, messageDesc) {
         const isOptional = (0, types_1.isOptionalProperty)(field, messageDesc.options, options, currentFile.isProto3Syntax);
         if ((0, types_1.isRepeated)(field)) {
             if ((0, types_1.isMapType)(ctx, messageDesc, field)) {
-                const valueType = typeMap.get(field.typeName)[2].field[1];
+                const mapInfo = (0, types_1.detectMapType)(ctx, messageDesc, field);
+                const valueType = mapInfo.valueField;
                 const maybeTypeField = (0, options_1.addTypeToMessages)(options) ? `$type: '${field.typeName.slice(1)}',` : "";
                 const entryWriteSnippet = (0, types_1.isValueType)(ctx, valueType)
                     ? (0, ts_poet_1.code) `
@@ -1378,7 +1379,7 @@ function generateEncode(ctx, fullName, messageDesc) {
                 }
                 else {
                     chunks.push((0, ts_poet_1.code) `
-            Object.entries(${messageProperty}${optionalAlternative}).forEach(([key, value]) => {
+            ${utils.globalThis}.Object.entries(${messageProperty}${optionalAlternative}).forEach(([key, value]: [string, ${mapInfo.valueType}]) => {
               ${entryWriteSnippet}
             });
           `);
@@ -1533,7 +1534,7 @@ function generateEncode(ctx, fullName, messageDesc) {
     });
     if (options.unknownFields) {
         chunks.push((0, ts_poet_1.code) `if (message._unknownFields !== undefined) {
-      for (const [key, values] of Object.entries(message._unknownFields)) {
+      for (const [key, values] of ${utils.globalThis}.Object.entries(message._unknownFields)) {
         const tag = parseInt(key, 10);
         for (const value of values) {
           writer.uint32(tag).raw(value);
@@ -1926,7 +1927,7 @@ function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
                         }
                         else {
                             const cstr = (0, case_1.capitalize)(valueType.toCodeString([]));
-                            return (0, ts_poet_1.code) `${cstr}(${from})`;
+                            return (0, ts_poet_1.code) `${utils.globalThis}.${cstr}(${from})`;
                         }
                     }
                     else if ((0, types_1.isObjectId)(valueField) && options.useMongoObjectId) {
@@ -1963,33 +1964,59 @@ function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
         };
         const noDefaultValue = !options.initializeFieldsAsUndefined &&
             (0, types_1.isOptionalProperty)(field, messageDesc.options, options, currentFile.isProto3Syntax);
+        // if the protoJsonFormat option is enabled and the field name is different from the json name, we need to
+        // accept both formats in the fromJSON method.
+        let protoJsonComparison = (0, ts_poet_1.code) ``;
         // and then use the snippet to handle repeated fields if necessary
         if (canonicalFromJson[fullTypeName]?.[fieldName]) {
             chunks.push((0, ts_poet_1.code) `${fieldName}: ${canonicalFromJson[fullTypeName][fieldName]("object")},`);
         }
         else if ((0, types_1.isRepeated)(field)) {
             if ((0, types_1.isMapType)(ctx, messageDesc, field)) {
+                const mapInfo = (0, types_1.detectMapType)(ctx, messageDesc, field);
                 const fieldType = (0, types_1.toTypeName)(ctx, messageDesc, field);
                 const i = convertFromObjectKey(ctx, messageDesc, field, "key");
                 if ((0, types_1.shouldGenerateJSMapType)(ctx, messageDesc, field)) {
                     const fallback = noDefaultValue ? (0, utils_1.nullOrUndefined)(options) : "new Map()";
+                    if (options.protoJsonFormat && field.name !== field.jsonName) {
+                        const protoJsonProperty = (0, utils_1.getPropertyAccessor)("object", field.name);
+                        protoJsonComparison = (0, ts_poet_1.code) `
+                : ${ctx.utils.isObject}(${protoJsonProperty})
+                ? (${ctx.utils.globalThis}.Object.entries(${protoJsonProperty}) as [string, any][]).reduce((acc: ${fieldType}, [key, value]: [string, any]) => {
+                    acc.set(${i}, ${readSnippet("value")});
+                    return acc;
+                  }, new Map())
+              `;
+                    }
                     chunks.push((0, ts_poet_1.code) `
             ${fieldKey}: ${ctx.utils.isObject}(${jsonProperty})
-              ? Object.entries(${jsonProperty}).reduce<${fieldType}>((acc, [key, value]) => {
+              ? (${ctx.utils.globalThis}.Object.entries(${jsonProperty}) as [string, any][]).reduce((acc: ${fieldType}, [key, value]: [string, any]) => {
                   acc.set(${i}, ${readSnippet("value")});
                   return acc;
                 }, new Map())
+              ${protoJsonComparison}
               : ${fallback},
           `);
                 }
                 else {
                     const fallback = noDefaultValue ? (0, utils_1.nullOrUndefined)(options) : "{}";
+                    if (options.protoJsonFormat && field.name !== field.jsonName) {
+                        const protoJsonProperty = (0, utils_1.getPropertyAccessor)("object", field.name);
+                        protoJsonComparison = (0, ts_poet_1.code) `
+                 : ${ctx.utils.isObject}(${protoJsonProperty})
+                 ? (${ctx.utils.globalThis}.Object.entries(${protoJsonProperty}) as [string, any][]).reduce((acc: ${fieldType}, [key, value]: [string, any]) => {
+                     acc[${i}] = ${readSnippet("value")};
+                     return acc;
+                   }, {})
+               `;
+                    }
                     chunks.push((0, ts_poet_1.code) `
             ${fieldKey}: ${ctx.utils.isObject}(${jsonProperty})
-              ? Object.entries(${jsonProperty}).reduce<${fieldType}>((acc, [key, value]) => {
+              ? (${ctx.utils.globalThis}.Object.entries(${jsonProperty}) as [string, any][]).reduce((acc: ${fieldType}, [key, value]: [string, any]) => {
                   acc[${i}] = ${readSnippet("value")};
                   return acc;
                 }, {})
+              ${protoJsonComparison}
               : ${fallback},
           `);
                 }
@@ -1998,12 +2025,22 @@ function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
                 const fallback = noDefaultValue ? (0, utils_1.nullOrUndefined)(options) : "[]";
                 const needMap = readSnippet("e").toString() !== (0, ts_poet_1.code) `e`.toString();
                 if (!needMap) {
-                    chunks.push((0, ts_poet_1.code) `${fieldKey}: ${ctx.utils.globalThis}.Array.isArray(${jsonPropertyOptional}) ? [...${jsonProperty}] : [],`);
+                    if (options.protoJsonFormat && field.name !== field.jsonName) {
+                        const protoJsonProperty = (0, utils_1.getPropertyAccessor)("object", field.name);
+                        const protoJsonPropertyOptional = (0, utils_1.getPropertyAccessor)("object", field.name, true);
+                        protoJsonComparison = (0, ts_poet_1.code) ` : ${ctx.utils.globalThis}.Array.isArray(${protoJsonPropertyOptional}) ? [...${protoJsonProperty}]`;
+                    }
+                    chunks.push((0, ts_poet_1.code) `${fieldKey}: ${ctx.utils.globalThis}.Array.isArray(${jsonPropertyOptional}) ? [...${jsonProperty}] ${protoJsonComparison} : [],`);
                 }
                 else {
                     // Explicit `any` type required to make TS with noImplicitAny happy. `object` is also `any` here.
+                    if (options.protoJsonFormat && field.name !== field.jsonName) {
+                        const protoJsonProperty = (0, utils_1.getPropertyAccessor)("object", field.name);
+                        const protoJsonPropertyOptional = (0, utils_1.getPropertyAccessor)("object", field.name, true);
+                        protoJsonComparison = (0, ts_poet_1.code) ` : ${ctx.utils.globalThis}.Array.isArray(${protoJsonPropertyOptional}) ? ${protoJsonProperty}.map((e: any) => ${readSnippet("e")})`;
+                    }
                     chunks.push((0, ts_poet_1.code) `
-            ${fieldKey}: ${ctx.utils.globalThis}.Array.isArray(${jsonPropertyOptional}) ? ${jsonProperty}.map((e: any) => ${readSnippet("e")}): ${fallback},
+            ${fieldKey}: ${ctx.utils.globalThis}.Array.isArray(${jsonPropertyOptional}) ? ${jsonProperty}.map((e: any) => ${readSnippet("e")}) ${protoJsonComparison} : ${fallback},
           `);
                 }
             }
@@ -2020,33 +2057,59 @@ function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
             const ternaryIf = (0, ts_poet_1.code) `${ctx.utils.isSet}(${jsonProperty})`;
             const ternaryThen = (0, ts_poet_1.code) `{ $case: '${fieldName}', ${valueName}: ${readSnippet(`${jsonProperty}`)}`;
             chunks.push((0, ts_poet_1.code) `${ternaryIf} ? ${ternaryThen}} : `);
+            if (options.protoJsonFormat && field.name !== field.jsonName) {
+                const protoJsonProperty = (0, utils_1.getPropertyAccessor)("object", field.name);
+                const ternaryOriginalIf = (0, ts_poet_1.code) `${ctx.utils.isSet}(${protoJsonProperty})`;
+                const ternaryOriginalThen = (0, ts_poet_1.code) `{ $case: '${fieldName}', ${valueName}: ${readSnippet(`${protoJsonProperty}`)}`;
+                chunks.push((0, ts_poet_1.code) `${ternaryOriginalIf} ? ${ternaryOriginalThen}} : `);
+            }
             if (field === lastCase) {
                 chunks.push((0, ts_poet_1.code) `${(0, utils_1.nullOrUndefined)(options)},`);
             }
         }
         else if ((0, types_1.isAnyValueType)(field)) {
+            if (options.protoJsonFormat && field.name !== field.jsonName) {
+                const protoJsonProperty = (0, utils_1.getPropertyAccessor)("object", field.name);
+                const protoJsonPropertyOptional = (0, utils_1.getPropertyAccessor)("object", field.name, true);
+                protoJsonComparison = (0, ts_poet_1.code) ` : ${ctx.utils.isSet}(${protoJsonPropertyOptional}) ? ${readSnippet(`${protoJsonProperty}`)}`;
+            }
             chunks.push((0, ts_poet_1.code) `${fieldKey}: ${ctx.utils.isSet}(${jsonPropertyOptional})
         ? ${readSnippet(`${jsonProperty}`)}
+        ${protoJsonComparison}
         : ${(0, utils_1.nullOrUndefined)(options)},
       `);
         }
         else if ((0, types_1.isStructType)(field)) {
+            if (options.protoJsonFormat && field.name !== field.jsonName) {
+                const protoJsonProperty = (0, utils_1.getPropertyAccessor)("object", field.name);
+                protoJsonComparison = (0, ts_poet_1.code) ` : ${ctx.utils.isObject}(${protoJsonProperty}) ? ${readSnippet(`${protoJsonProperty}`)}`;
+            }
             chunks.push((0, ts_poet_1.code) `${fieldKey}: ${ctx.utils.isObject}(${jsonProperty})
           ? ${readSnippet(`${jsonProperty}`)}
+          ${protoJsonComparison}
           : ${(0, utils_1.nullOrUndefined)(options)},`);
         }
         else if ((0, types_1.isListValueType)(field)) {
+            if (options.protoJsonFormat && field.name !== field.jsonName) {
+                const protoJsonProperty = (0, utils_1.getPropertyAccessor)("object", field.name);
+                protoJsonComparison = (0, ts_poet_1.code) ` : ${ctx.utils.globalThis}.Array.isArray(${protoJsonProperty}) ? ${readSnippet(`${protoJsonProperty}`)}`;
+            }
             chunks.push((0, ts_poet_1.code) `
         ${fieldKey}: ${ctx.utils.globalThis}.Array.isArray(${jsonProperty})
           ? ${readSnippet(`${jsonProperty}`)}
+          ${protoJsonComparison}
           : ${(0, utils_1.nullOrUndefined)(options)},
       `);
         }
         else {
             const fallback = (0, types_1.isWithinOneOf)(field) || noDefaultValue ? (0, utils_1.nullOrUndefined)(options) : (0, types_1.defaultValue)(ctx, field);
+            if (options.protoJsonFormat && field.name !== field.jsonName) {
+                const protoJsonProperty = (0, utils_1.getPropertyAccessor)("object", field.name);
+                protoJsonComparison = (0, ts_poet_1.code) ` : ${ctx.utils.isSet}(${protoJsonProperty}) ? ${readSnippet(`${protoJsonProperty}`)}`;
+            }
             chunks.push((0, ts_poet_1.code) `
-        ${fieldKey}: ${ctx.utils.isSet}(${jsonProperty})
-          ? ${readSnippet(`${jsonProperty}`)}
+        ${fieldKey}: ${ctx.utils.isSet}(${jsonProperty}) ? ${readSnippet(`${jsonProperty}`)}
+        ${protoJsonComparison}
           : ${fallback},
       `);
         }
@@ -2216,9 +2279,10 @@ function generateToJson(ctx, fullName, fullProtobufTypeName, messageDesc) {
         `);
             }
             else {
+                const mapInfo = (0, types_1.detectMapType)(ctx, messageDesc, field);
                 chunks.push((0, ts_poet_1.code) `
         if (${messageProperty}) {
-            const entries = Object.entries(${messageProperty});
+            const entries = ${utils.globalThis}.Object.entries(${messageProperty}) as [string, ${mapInfo.valueType}][];
             if (entries.length > 0) {
               ${jsonProperty} = {};
               entries.forEach(([k, v]) => {
@@ -2390,6 +2454,7 @@ function generateFromPartial(ctx, fullName, messageDesc) {
         // and then use the snippet to handle repeated fields if necessary
         if ((0, types_1.isRepeated)(field)) {
             if ((0, types_1.isMapType)(ctx, messageDesc, field)) {
+                const mapInfo = (0, types_1.detectMapType)(ctx, messageDesc, field);
                 const fieldType = (0, types_1.toTypeName)(ctx, messageDesc, field);
                 const i = convertFromObjectKey(ctx, messageDesc, field, "key");
                 const noValueSnippet = noDefaultValue
@@ -2410,12 +2475,15 @@ function generateFromPartial(ctx, fullName, messageDesc) {
                 }
                 else {
                     chunks.push((0, ts_poet_1.code) `
-            ${messageProperty} = ${noValueSnippet} Object.entries(${objectProperty} ?? {}).reduce<${fieldType}>((acc, [key, value]) => {
-              if (value !== undefined) {
-                acc[${i}] = ${readSnippet("value")};
-              }
-              return acc;
-            }, {});
+            ${messageProperty} = ${noValueSnippet} (${utils.globalThis}.Object.entries(${objectProperty} ?? {}) as [string, ${mapInfo.valueType}][]).reduce(
+              (acc: ${fieldType}, [key, value]: [string, ${mapInfo.valueType}]) => {
+                if (value !== undefined) {
+                  acc[${i}] = ${readSnippet("value")};
+                }
+                return acc;
+              },
+              {},
+            );
           `);
                 }
             }

package/build/src/options.d.ts

@@ -45,6 +45,7 @@ export declare enum OutputSchemaOption {
 export type Options = {
     context: boolean;
     snakeToCamel: Array<"json" | "keys">;
+    protoJsonFormat: boolean;
     forceLong: LongOption;
     useJsTypeOverride: boolean;
     globalThisPolyfill: boolean;

package/build/src/options.js

@@ -60,6 +60,7 @@ function defaultOptions() {
     return {
         context: false,
         snakeToCamel: ["json", "keys"],
+        protoJsonFormat: true,
         emitDefaultValues: [],
         globalThisPolyfill: false,
         forceLong: LongOption.NUMBER,
@@ -204,6 +205,11 @@ function optionsFromParameter(parameter) {
     else if (typeof options.snakeToCamel === "string") {
         options.snakeToCamel = options.snakeToCamel.split("_");
     }
+    if (options.protoJsonFormat && !options.snakeToCamel.includes("json")) {
+        // protoJSONFormat implies snakeToCamel=json, Message field names must be mapped to lowerCamelCase and become JSON object keys.
+        // If the json_name field option is specified, the specified value will be used as the key instead.
+        options.snakeToCamel.push("json");
+    }
     if (options.emitDefaultValues === "json-methods") {
         options.emitDefaultValues = ["json-methods"];
     }

package/package.json

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