ts-proto 1.128.0 → 1.129.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [1.129.0](https://github.com/stephenh/ts-proto/compare/v1.128.0...v1.129.0) (2022-10-16)
+
+
+### Features
+
+* support `useMapType` option ([#686](https://github.com/stephenh/ts-proto/issues/686)) ([f2e80ab](https://github.com/stephenh/ts-proto/commit/f2e80ab3ecc3a438ecbd88b2170b8119ebadfcd3))
+
 # [1.128.0](https://github.com/stephenh/ts-proto/compare/v1.127.0...v1.128.0) (2022-10-13)
 
 

package/README.markdown

@@ -458,6 +458,10 @@ Generated code will be placed in the Gradle build directory.
   - **Note**: Uses are accummulated, so multiple values are expected in the form of `--ts_proto_opt=M... --ts_proto_opt=M...` (one `ts_proto_opt` per mapping).
   - **Note**: Proto files that match mapped imports **will not be generated**.
 
+- With `--ts_proto_opt=useMapType=true`, the generated code for protobuf `map<key_type, value_type>` will become `Map<key_type, value_type>` that uses JavaScript Map type.
+
+  The default behavior is `useMapType=false`, which makes it generate the code for protobuf `map<key_type, value_type` with the key-value pair like `{[key: key_type]: value_type}`.
+
 ### 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/main.js

@@ -589,7 +589,9 @@ function generateBaseInstanceFactory(ctx, fullName, messageDesc, fullTypeName) {
         const val = (0, types_1.isWithinOneOf)(field)
             ? "undefined"
             : (0, types_1.isMapType)(ctx, messageDesc, field)
-                ? "{}"
+                ? ctx.options.useMapType
+                    ? "new Map()"
+                    : "{}"
                 : (0, types_1.isRepeated)(field)
                     ? "[]"
                     : (0, types_1.defaultValue)(ctx, field);
@@ -698,10 +700,13 @@ function generateDecode(ctx, fullName, messageDesc) {
             if ((0, types_1.isMapType)(ctx, messageDesc, field)) {
                 // We need a unique const within the `cast` statement
                 const varName = `entry${field.number}`;
+                const valueSetterSnippet = ctx.options.useMapType
+                    ? `message.${fieldName}${maybeNonNullAssertion}.set(${varName}.key, ${varName}.value)`
+                    : `message.${fieldName}${maybeNonNullAssertion}[${varName}.key] = ${varName}.value`;
                 chunks.push((0, ts_poet_1.code) `
           const ${varName} = ${readSnippet};
           if (${varName}.value !== undefined) {
-            message.${fieldName}${maybeNonNullAssertion}[${varName}.key] = ${varName}.value;
+            ${valueSetterSnippet};
           }
         `);
             }
@@ -822,11 +827,20 @@ function generateEncode(ctx, fullName, messageDesc) {
             `
                     : writeSnippet(`{ ${maybeTypeField} key: key as any, value }`);
                 const optionalAlternative = isOptional ? " || {}" : "";
-                chunks.push((0, ts_poet_1.code) `
-          Object.entries(message.${fieldName}${optionalAlternative}).forEach(([key, value]) => {
-            ${entryWriteSnippet}
-          });
-        `);
+                if (ctx.options.useMapType) {
+                    chunks.push((0, ts_poet_1.code) `
+            message.${fieldName}${optionalAlternative}.forEach((value, key) => {
+              ${entryWriteSnippet}
+            });
+          `);
+                }
+                else {
+                    chunks.push((0, ts_poet_1.code) `
+            Object.entries(message.${fieldName}${optionalAlternative}).forEach(([key, value]) => {
+              ${entryWriteSnippet}
+            });
+          `);
+                }
             }
             else if ((0, types_1.packedType)(field.type) === undefined) {
                 const listWriteSnippet = (0, ts_poet_1.code) `
@@ -1099,14 +1113,26 @@ function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
             if ((0, types_1.isMapType)(ctx, messageDesc, field)) {
                 const fieldType = (0, types_1.toTypeName)(ctx, messageDesc, field);
                 const i = maybeCastToNumber(ctx, messageDesc, field, "key");
-                chunks.push((0, ts_poet_1.code) `
-          ${fieldName}: ${ctx.utils.isObject}(${jsonProperty})
-            ? Object.entries(${jsonProperty}).reduce<${fieldType}>((acc, [key, value]) => {
-                acc[${i}] = ${readSnippet("value")};
-                return acc;
-              }, {})
-            : {},
-        `);
+                if (ctx.options.useMapType) {
+                    chunks.push((0, ts_poet_1.code) `
+            ${fieldName}: ${ctx.utils.isObject}(${jsonProperty})
+              ? Object.entries(${jsonProperty}).reduce<${fieldType}>((acc, [key, value]) => {
+                  acc.set(${i}, ${readSnippet("value")});
+                  return acc;
+                }, new Map())
+              : new Map(),
+          `);
+                }
+                else {
+                    chunks.push((0, ts_poet_1.code) `
+            ${fieldName}: ${ctx.utils.isObject}(${jsonProperty})
+              ? Object.entries(${jsonProperty}).reduce<${fieldType}>((acc, [key, value]) => {
+                  acc[${i}] = ${readSnippet("value")};
+                  return acc;
+                }, {})
+              : {},
+          `);
+                }
             }
             else {
                 const readValueSnippet = readSnippet("e");
@@ -1286,14 +1312,26 @@ function generateToJson(ctx, fullName, fullProtobufTypeName, messageDesc) {
         };
         if ((0, types_1.isMapType)(ctx, messageDesc, field)) {
             // Maps might need their values transformed, i.e. bytes --> base64
-            chunks.push((0, ts_poet_1.code) `
-        ${jsonProperty} = {};
-        if (message.${fieldName}) {
-          Object.entries(message.${fieldName}).forEach(([k, v]) => {
-            ${jsonProperty}[k] = ${readSnippet("v")};
-          });
-        }
-      `);
+            if (ctx.options.useMapType) {
+                chunks.push((0, ts_poet_1.code) `
+          ${jsonProperty} = {};
+          if (message.${fieldName}) {
+            message.${fieldName}.forEach((v, k) => {
+              ${jsonProperty}[k] = ${readSnippet("v")};
+            });
+          }
+        `);
+            }
+            else {
+                chunks.push((0, ts_poet_1.code) `
+          ${jsonProperty} = {};
+          if (message.${fieldName}) {
+            Object.entries(message.${fieldName}).forEach(([k, v]) => {
+              ${jsonProperty}[k] = ${readSnippet("v")};
+            });
+          }
+        `);
+            }
         }
         else if ((0, types_1.isRepeated)(field)) {
             // Arrays might need their elements transformed
@@ -1408,14 +1446,29 @@ function generateFromPartial(ctx, fullName, messageDesc) {
             if ((0, types_1.isMapType)(ctx, messageDesc, field)) {
                 const fieldType = (0, types_1.toTypeName)(ctx, messageDesc, field);
                 const i = maybeCastToNumber(ctx, messageDesc, field, "key");
-                chunks.push((0, ts_poet_1.code) `
-          message.${fieldName} = Object.entries(object.${fieldName} ?? {}).reduce<${fieldType}>((acc, [key, value]) => {
-            if (value !== undefined) {
-              acc[${i}] = ${readSnippet("value")};
-            }
-            return acc;
-          }, {});
-        `);
+                if (ctx.options.useMapType) {
+                    chunks.push((0, ts_poet_1.code) `
+            message.${fieldName} = (() => {
+              const m = new Map();
+              (object.${fieldName} as ${fieldType} ?? new Map()).forEach((value, key) => {
+                if (value !== undefined) {
+                  m.set(${i}, ${readSnippet("value")});
+                }
+              });
+              return m;
+            })();
+          `);
+                }
+                else {
+                    chunks.push((0, ts_poet_1.code) `
+            message.${fieldName} = Object.entries(object.${fieldName} ?? {}).reduce<${fieldType}>((acc, [key, value]) => {
+              if (value !== undefined) {
+                acc[${i}] = ${readSnippet("value")};
+              }
+              return acc;
+            }, {});
+          `);
+                }
             }
             else {
                 chunks.push((0, ts_poet_1.code) `

package/build/options.js

@@ -72,6 +72,7 @@ function defaultOptions() {
         useJsonWireFormat: false,
         useNumericEnumForJson: false,
         initializeFieldsAsUndefined: true,
+        useMapType: false,
         M: {},
     };
 }

package/build/types.js

@@ -557,6 +557,9 @@ function toTypeName(ctx, messageDesc, field) {
         const mapType = detectMapType(ctx, messageDesc, field);
         if (mapType) {
             const { keyType, valueType } = mapType;
+            if (ctx.options.useMapType) {
+                return (0, ts_poet_1.code) `Map<${keyType}, ${valueType}>`;
+            }
             return (0, ts_poet_1.code) `{ [key: ${keyType} ]: ${valueType} }`;
         }
         return (0, ts_poet_1.code) `${type}[]`;

package/package.json

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