ts-proto 1.129.0 → 1.131.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [1.131.0](https://github.com/stephenh/ts-proto/compare/v1.130.0...v1.131.0) (2022-10-25)
+
+
+### Features
+
+* option useSnakeTypeName ([#694](https://github.com/stephenh/ts-proto/issues/694)) ([ad73ff9](https://github.com/stephenh/ts-proto/commit/ad73ff9341d0d593156d10b5d96c4a47afdc802d))
+
+# [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)
 
 

package/README.markdown

@@ -462,6 +462,26 @@ Generated code will be placed in the Gradle build directory.
 
   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.
+
+- With `--ts_proto_opt=useSnakeTypeName=false` will remove snake casing from types. 
+  
+  Example Protobuf
+  ```protobuf
+  message Box {
+      message Element {
+            message Image {
+                  enum Alignment {
+                        LEFT = 1;
+                        CENTER = 2;
+                        RIGHT = 3;
+                  }
+            }
+        }
+  }
+  ```
+  by default this is enabled which would generate a type of `Box_Element_Image_Alignment`. By disabling this option the type that is generated would be `BoxElementImageAlignment`. 
+
 ### 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" });
@@ -623,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 = {}`);
     }
@@ -1377,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);
@@ -1524,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};
@@ -1547,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;
@@ -1570,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 ?? [];
 
@@ -1579,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;
 
@@ -1640,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

@@ -73,6 +73,8 @@ function defaultOptions() {
         useNumericEnumForJson: false,
         initializeFieldsAsUndefined: true,
         useMapType: false,
+        useReadonlyTypes: false,
+        useSnakeTypeName: true,
         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":
@@ -562,6 +566,9 @@ function toTypeName(ctx, messageDesc, field) {
             }
             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/build/visit.js

@@ -23,7 +23,8 @@ function visit(proto, sourceInfo, messageFn, options, enumFn = () => { }, tsPref
         const tsFullName = tsPrefix + (0, case_1.maybeSnakeToCamel)(messageName(message), options);
         const nestedSourceInfo = sourceInfo.open(childType, index);
         messageFn(tsFullName, message, nestedSourceInfo, protoFullName);
-        visit(message, nestedSourceInfo, messageFn, options, enumFn, tsFullName + "_", protoFullName + ".");
+        const delim = options.useSnakeTypeName ? "_" : "";
+        visit(message, nestedSourceInfo, messageFn, options, enumFn, tsFullName + delim, protoFullName + ".");
     });
 }
 exports.visit = visit;

package/package.json

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