ts-proto 1.128.0 → 1.130.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [1.130.0](https://github.com/stephenh/ts-proto/compare/v1.129.0...v1.130.0) (2022-10-22)
+
+
+### Features
+
+* support `useReadonlyTypes` option ([#691](https://github.com/stephenh/ts-proto/issues/691)) ([4b87334](https://github.com/stephenh/ts-proto/commit/4b8733452fb59cea3b9fb4721159b97e6df59854))
+
+# [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,12 @@ 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}`.
+
+- With `--ts_proto_opt=useReadonlyTypes=true`, the generated types will be declared as immutable using typescript's `readonly` modifer.
+
 ### 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

@@ -530,7 +530,7 @@ function generateInterfaceDeclaration(ctx, fullName, messageDesc, sourceInfo, fu
         const name = (0, case_1.maybeSnakeToCamel)(fieldDesc.name, options);
         const type = (0, types_1.toTypeName)(ctx, messageDesc, fieldDesc);
         const q = (0, types_1.isOptionalProperty)(fieldDesc, messageDesc.options, options) ? "?" : "";
-        chunks.push((0, ts_poet_1.code) `${name}${q}: ${type}, `);
+        chunks.push((0, ts_poet_1.code) `${ctx.options.useReadonlyTypes ? "readonly " : ""}${name}${q}: ${type}, `);
     });
     chunks.push((0, ts_poet_1.code) `}`);
     return (0, ts_poet_1.joinCode)(chunks, { on: "\n" });
@@ -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);
@@ -621,8 +623,8 @@ function generateDecode(ctx, fullName, messageDesc) {
     ): ${fullName} {
       const reader = input instanceof ${Reader} ? input : new ${Reader}(input);
       let end = length === undefined ? reader.len : reader.pos + length;
-      const message = ${createBase};
   `);
+    chunks.push((0, ts_poet_1.code) `const message = ${createBase}${options.useReadonlyTypes ? " as any" : ""};`);
     if (options.unknownFields) {
         chunks.push((0, ts_poet_1.code) `(message as any)._unknownFields = {}`);
     }
@@ -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
@@ -1339,7 +1377,7 @@ function generateFromPartial(ctx, fullName, messageDesc) {
     if (options.usePrototypeForDefaults) {
         createBase = (0, ts_poet_1.code) `Object.create(${createBase}) as ${fullName}`;
     }
-    chunks.push((0, ts_poet_1.code) `const message = ${createBase};`);
+    chunks.push((0, ts_poet_1.code) `const message = ${createBase}${options.useReadonlyTypes ? " as any" : ""};`);
     // add a check for each incoming field
     messageDesc.field.forEach((field) => {
         const fieldName = (0, case_1.maybeSnakeToCamel)(field.name, options);
@@ -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) `
@@ -1471,7 +1524,7 @@ function generateWrap(ctx, fullProtoTypeName, fieldNames) {
     if ((0, types_1.isAnyValueTypeName)(fullProtoTypeName)) {
         if (ctx.options.oneof === options_1.OneofOption.UNIONS) {
             chunks.push((0, ts_poet_1.code) `wrap(value: any): Value {
-        const result = createBaseValue();
+        const result = createBaseValue()${ctx.options.useReadonlyTypes ? " as any" : ""};
 
         if (value === null) {
           result.kind = {$case: '${fieldNames.nullValue}', ${fieldNames.nullValue}: NullValue.NULL_VALUE};
@@ -1494,7 +1547,7 @@ function generateWrap(ctx, fullProtoTypeName, fieldNames) {
         }
         else {
             chunks.push((0, ts_poet_1.code) `wrap(value: any): Value {
-        const result = createBaseValue();
+        const result = createBaseValue()${ctx.options.useReadonlyTypes ? " as any" : ""};
 
         if (value === null) {
           result.${fieldNames.nullValue} = NullValue.NULL_VALUE;
@@ -1517,8 +1570,8 @@ function generateWrap(ctx, fullProtoTypeName, fieldNames) {
         }
     }
     if ((0, types_1.isListValueTypeName)(fullProtoTypeName)) {
-        chunks.push((0, ts_poet_1.code) `wrap(value: Array<any> | undefined): ListValue {
-      const result = createBaseListValue();
+        chunks.push((0, ts_poet_1.code) `wrap(value: ${ctx.options.useReadonlyTypes ? "ReadonlyArray<any>" : "Array<any>"} | undefined): ListValue {
+      const result = createBaseListValue()${ctx.options.useReadonlyTypes ? " as any" : ""};
 
       result.values = value ?? [];
 
@@ -1526,8 +1579,8 @@ function generateWrap(ctx, fullProtoTypeName, fieldNames) {
     }`);
     }
     if ((0, types_1.isFieldMaskTypeName)(fullProtoTypeName)) {
-        chunks.push((0, ts_poet_1.code) `wrap(paths: string[]): FieldMask {
-      const result = createBaseFieldMask();
+        chunks.push((0, ts_poet_1.code) `wrap(paths: ${ctx.options.useReadonlyTypes ? "readonly " : ""} string[]): FieldMask {
+      const result = createBaseFieldMask()${ctx.options.useReadonlyTypes ? " as any" : ""};
 
       result.paths = paths;
 
@@ -1587,12 +1640,12 @@ function generateUnwrap(ctx, fullProtoTypeName, fieldNames) {
         }
     }
     if ((0, types_1.isListValueTypeName)(fullProtoTypeName)) {
-        chunks.push((0, ts_poet_1.code) `unwrap(message: ListValue): Array<any> {
+        chunks.push((0, ts_poet_1.code) `unwrap(message: ${ctx.options.useReadonlyTypes ? "any" : "ListValue"}): Array<any> {
       return message.values;
     }`);
     }
     if ((0, types_1.isFieldMaskTypeName)(fullProtoTypeName)) {
-        chunks.push((0, ts_poet_1.code) `unwrap(message: FieldMask): string[] {
+        chunks.push((0, ts_poet_1.code) `unwrap(message: ${ctx.options.useReadonlyTypes ? "any" : "FieldMask"}): string[] {
       return message.paths;
     }`);
     }

package/build/options.js

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

package/build/types.js

@@ -457,13 +457,17 @@ function valueTypeName(ctx, typeName) {
                     ? (0, ts_poet_1.code) `string`
                     : (0, ts_poet_1.code) `Uint8Array`;
         case ".google.protobuf.ListValue":
-            return (0, ts_poet_1.code) `Array<any>`;
+            return ctx.options.useReadonlyTypes ? (0, ts_poet_1.code) `ReadonlyArray<any>` : (0, ts_poet_1.code) `Array<any>`;
         case ".google.protobuf.Value":
             return (0, ts_poet_1.code) `any`;
         case ".google.protobuf.Struct":
-            return (0, ts_poet_1.code) `{[key: string]: any}`;
+            return ctx.options.useReadonlyTypes ? (0, ts_poet_1.code) `{readonly [key: string]: any}` : (0, ts_poet_1.code) `{[key: string]: any}`;
         case ".google.protobuf.FieldMask":
-            return ctx.options.useJsonWireFormat ? (0, ts_poet_1.code) `string` : (0, ts_poet_1.code) `string[]`;
+            return ctx.options.useJsonWireFormat
+                ? (0, ts_poet_1.code) `string`
+                : ctx.options.useReadonlyTypes
+                    ? (0, ts_poet_1.code) `readonly string[]`
+                    : (0, ts_poet_1.code) `string[]`;
         case ".google.protobuf.Duration":
             return ctx.options.useJsonWireFormat ? (0, ts_poet_1.code) `string` : undefined;
         case ".google.protobuf.Timestamp":
@@ -557,8 +561,14 @@ 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} }`;
         }
+        if (ctx.options.useReadonlyTypes) {
+            return (0, ts_poet_1.code) `readonly ${type}[]`;
+        }
         return (0, ts_poet_1.code) `${type}[]`;
     }
     if (isValueType(ctx, field)) {

package/package.json

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