ts-proto 1.115.1 → 1.115.4

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+## [1.115.4](https://github.com/stephenh/ts-proto/compare/v1.115.3...v1.115.4) (2022-06-05)
+
+
+### Bug Fixes
+
+* Struct wrap/unwrap snake case [#579](https://github.com/stephenh/ts-proto/issues/579) ([#588](https://github.com/stephenh/ts-proto/issues/588)) ([33f89bf](https://github.com/stephenh/ts-proto/commit/33f89bfcf0d5d9e64a6fd360eaefc140055e9291))
+
+## [1.115.3](https://github.com/stephenh/ts-proto/compare/v1.115.2...v1.115.3) (2022-06-03)
+
+
+### Bug Fixes
+
+* Fix ts-poet typo in package.json. ([#589](https://github.com/stephenh/ts-proto/issues/589)) ([5211347](https://github.com/stephenh/ts-proto/commit/5211347cb21ac7d117349a32a87c0d017999c44a))
+
+## [1.115.2](https://github.com/stephenh/ts-proto/compare/v1.115.1...v1.115.2) (2022-06-03)
+
+
+### Bug Fixes
+
+* simplify handling useJsonWireFormat=true and fix onlyTypes=true ([#583](https://github.com/stephenh/ts-proto/issues/583)) ([6e7f938](https://github.com/stephenh/ts-proto/commit/6e7f9387d144f506ded982604f32981ac5e327de))
+
 ## [1.115.1](https://github.com/stephenh/ts-proto/compare/v1.115.0...v1.115.1) (2022-06-02)
 
 

package/README.markdown

@@ -396,7 +396,7 @@ Generated code will be placed in the Gradle build directory.
 
 - With `--ts_proto_opt=onlyTypes=true`, only types will be emitted, and imports for `long` and `protobufjs/minimal` will be excluded.
 
-  Note: _This is a combination_ of `outputJsonMethods=false,outputEncodeMethods=false,outputClientImpl=false,nestJs=false`
+  This is the same as setting `outputJsonMethods=false,outputEncodeMethods=false,outputClientImpl=false,nestJs=false`
 
 - With `--ts_proto_opt=usePrototypeForDefaults=true`, the generated code will wrap new objects with `Object.create`.
 
@@ -411,12 +411,6 @@ Generated code will be placed in the Gradle build directory.
   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.  
   You may also want to set `useOptionals=all`, as gRPC gateways are not required to send default value for scalar values.
 
-### Only Types
-
-If you're looking for `ts-proto` to generate only types for your Protobuf types then passing all three of `outputEncodeMethods`, `outputJsonMethods`, and `outputClientImpl` as `false` is probably what you want, i.e.:
-
-`--ts_proto_opt=onlyTypes=true`.
-
 ### 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/enums.js

@@ -20,16 +20,15 @@ function generateEnum(ctx, fullName, enumDesc, sourceInfo) {
         chunks.push(ts_poet_1.code `export ${options.constEnums ? 'const ' : ''}enum ${ts_poet_1.def(fullName)} {`);
     }
     const delimiter = options.enumsAsLiterals ? ':' : '=';
-    const stringEnums = options.stringEnums || (options.onlyTypes && options.useJsonWireFormat);
     enumDesc.value.forEach((valueDesc, index) => {
         var _a;
         const info = sourceInfo.lookup(sourceInfo_1.Fields.enum.value, index);
         utils_1.maybeAddComment(info, chunks, (_a = valueDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated, `${valueDesc.name} - `);
-        chunks.push(ts_poet_1.code `${valueDesc.name} ${delimiter} ${stringEnums ? `"${valueDesc.name}"` : valueDesc.number.toString()},`);
+        chunks.push(ts_poet_1.code `${valueDesc.name} ${delimiter} ${options.stringEnums ? `"${valueDesc.name}"` : valueDesc.number.toString()},`);
     });
     if (options.unrecognizedEnum)
         chunks.push(ts_poet_1.code `
-      ${UNRECOGNIZED_ENUM_NAME} ${delimiter} ${stringEnums ? `"${UNRECOGNIZED_ENUM_NAME}"` : UNRECOGNIZED_ENUM_VALUE.toString()},`);
+      ${UNRECOGNIZED_ENUM_NAME} ${delimiter} ${options.stringEnums ? `"${UNRECOGNIZED_ENUM_NAME}"` : UNRECOGNIZED_ENUM_VALUE.toString()},`);
     if (options.enumsAsLiterals) {
         chunks.push(ts_poet_1.code `} as const`);
         chunks.push(ts_poet_1.code `\n`);
@@ -38,7 +37,7 @@ function generateEnum(ctx, fullName, enumDesc, sourceInfo) {
     else {
         chunks.push(ts_poet_1.code `}`);
     }
-    if (options.outputJsonMethods || (stringEnums && options.outputEncodeMethods)) {
+    if (options.outputJsonMethods || (options.stringEnums && options.outputEncodeMethods)) {
         chunks.push(ts_poet_1.code `\n`);
         chunks.push(generateEnumFromJson(ctx, fullName, enumDesc));
     }
@@ -46,7 +45,7 @@ function generateEnum(ctx, fullName, enumDesc, sourceInfo) {
         chunks.push(ts_poet_1.code `\n`);
         chunks.push(generateEnumToJson(ctx, fullName, enumDesc));
     }
-    if (stringEnums && options.outputEncodeMethods) {
+    if (options.stringEnums && options.outputEncodeMethods) {
         chunks.push(ts_poet_1.code `\n`);
         chunks.push(generateEnumToNumber(ctx, fullName, enumDesc));
     }

package/build/main.js

@@ -87,8 +87,16 @@ function generateFile(ctx, fileDesc) {
             if (options.outputPartialMethods) {
                 staticMembers.push(generateFromPartial(ctx, fullName, message));
             }
-            staticMembers.push(...generateWrap(ctx, fullTypeName));
-            staticMembers.push(...generateUnwrap(ctx, fullTypeName));
+            const structFieldNames = {
+                nullValue: case_1.maybeSnakeToCamel('null_value', ctx.options),
+                numberValue: case_1.maybeSnakeToCamel('number_value', ctx.options),
+                stringValue: case_1.maybeSnakeToCamel('string_value', ctx.options),
+                boolValue: case_1.maybeSnakeToCamel('bool_value', ctx.options),
+                structValue: case_1.maybeSnakeToCamel('struct_value', ctx.options),
+                listValue: case_1.maybeSnakeToCamel('list_value', ctx.options),
+            };
+            staticMembers.push(...generateWrap(ctx, fullTypeName, structFieldNames));
+            staticMembers.push(...generateUnwrap(ctx, fullTypeName, structFieldNames));
             chunks.push(ts_poet_1.code `
           export const ${ts_poet_1.def(fullName)} = {
             ${ts_poet_1.joinCode(staticMembers, { on: ',\n\n' })}
@@ -1405,7 +1413,7 @@ function generateFromPartial(ctx, fullName, messageDesc) {
     chunks.push(ts_poet_1.code `}`);
     return ts_poet_1.joinCode(chunks, { on: '\n' });
 }
-function generateWrap(ctx, fullProtoTypeName) {
+function generateWrap(ctx, fullProtoTypeName, fieldNames) {
     const chunks = [];
     if (types_1.isStructTypeName(fullProtoTypeName)) {
         chunks.push(ts_poet_1.code `wrap(object: {[key: string]: any} | undefined): Struct {
@@ -1424,17 +1432,17 @@ function generateWrap(ctx, fullProtoTypeName) {
         const result = createBaseValue();
 
         if (value === null) {
-          result.kind = {$case: 'nullValue', nullValue: NullValue.NULL_VALUE};
+          result.kind = {$case: '${fieldNames.nullValue}', ${fieldNames.nullValue}: NullValue.NULL_VALUE};
         } else if (typeof value === 'boolean') {
-          result.kind = {$case: 'boolValue', boolValue: value};
+          result.kind = {$case: '${fieldNames.boolValue}', ${fieldNames.boolValue}: value};
         } else if (typeof value === 'number') {
-          result.kind = {$case: 'numberValue', numberValue: value};
+          result.kind = {$case: '${fieldNames.numberValue}', ${fieldNames.numberValue}: value};
         } else if (typeof value === 'string') {
-          result.kind = {$case: 'stringValue', stringValue: value};
+          result.kind = {$case: '${fieldNames.stringValue}', ${fieldNames.stringValue}: value};
         } else if (Array.isArray(value)) {
-          result.kind = {$case: 'listValue', listValue: value};
+          result.kind = {$case: '${fieldNames.listValue}', ${fieldNames.listValue}: value};
         } else if (typeof value === 'object') {
-          result.kind = {$case: 'structValue', structValue: value};
+          result.kind = {$case: '${fieldNames.structValue}', ${fieldNames.structValue}: value};
         } else if (typeof value !== 'undefined') {
           throw new Error('Unsupported any value type: ' + typeof value);
         }
@@ -1447,17 +1455,17 @@ function generateWrap(ctx, fullProtoTypeName) {
         const result = createBaseValue();
 
         if (value === null) {
-          result.nullValue = NullValue.NULL_VALUE;
+          result.${fieldNames.nullValue} = NullValue.NULL_VALUE;
         } else if (typeof value === 'boolean') {
-          result.boolValue = value;
+          result.${fieldNames.boolValue} = value;
         } else if (typeof value === 'number') {
-          result.numberValue = value;
+          result.${fieldNames.numberValue} = value;
         } else if (typeof value === 'string') {
-          result.stringValue = value;
+          result.${fieldNames.stringValue} = value;
         } else if (Array.isArray(value)) {
-          result.listValue = value;
+          result.${fieldNames.listValue} = value;
         } else if (typeof value === 'object') {
-          result.structValue = value;
+          result.${fieldNames.structValue} = value;
         } else if (typeof value !== 'undefined') {
           throw new Error('Unsupported any value type: ' + typeof value);
         }
@@ -1482,7 +1490,7 @@ function generateWrap(ctx, fullProtoTypeName) {
     }
     return chunks;
 }
-function generateUnwrap(ctx, fullProtoTypeName) {
+function generateUnwrap(ctx, fullProtoTypeName, fieldNames) {
     const chunks = [];
     if (types_1.isStructTypeName(fullProtoTypeName)) {
         chunks.push(ts_poet_1.code `unwrap(message: Struct): {[key: string]: any} {
@@ -1496,18 +1504,18 @@ function generateUnwrap(ctx, fullProtoTypeName) {
     if (types_1.isAnyValueTypeName(fullProtoTypeName)) {
         if (ctx.options.oneof === options_1.OneofOption.UNIONS) {
             chunks.push(ts_poet_1.code `unwrap(message: Value): string | number | boolean | Object | null | Array<any> | undefined {
-        if (message.kind?.$case === 'nullValue') {
+        if (message.kind?.$case === '${fieldNames.nullValue}') {
           return null;
-        } else if (message.kind?.$case === 'numberValue') {
-          return message.kind?.numberValue;
-        } else if (message.kind?.$case === 'stringValue') {
-          return message.kind?.stringValue;
-        } else if (message.kind?.$case === 'boolValue') {
-          return message.kind?.boolValue;
-        } else if (message.kind?.$case === 'structValue') {
-          return message.kind?.structValue;
-        } else if (message.kind?.$case === 'listValue') {
-          return message.kind?.listValue;
+        } else if (message.kind?.$case === '${fieldNames.numberValue}') {
+          return message.kind?.${fieldNames.numberValue};
+        } else if (message.kind?.$case === '${fieldNames.stringValue}') {
+          return message.kind?.${fieldNames.stringValue};
+        } else if (message.kind?.$case === '${fieldNames.boolValue}') {
+          return message.kind?.${fieldNames.boolValue};
+        } else if (message.kind?.$case === '${fieldNames.structValue}') {
+          return message.kind?.${fieldNames.structValue};
+        } else if (message.kind?.$case === '${fieldNames.listValue}') {
+          return message.kind?.${fieldNames.listValue};
         } else {
           return undefined;
         }
@@ -1515,17 +1523,17 @@ function generateUnwrap(ctx, fullProtoTypeName) {
         }
         else {
             chunks.push(ts_poet_1.code `unwrap(message: Value): string | number | boolean | Object | null | Array<any> | undefined {
-      if (message?.stringValue !== undefined) {
-        return message.stringValue;
-      } else if (message?.numberValue !== undefined) {
-        return message.numberValue;
-      } else if (message?.boolValue !== undefined) {
-        return message.boolValue;
-      } else if (message?.structValue !== undefined) {
-        return message.structValue;
-      } else if (message?.listValue !== undefined) {
-          return message.listValue;
-      } else if (message?.nullValue !== undefined) {
+      if (message?.${fieldNames.stringValue} !== undefined) {
+        return message.${fieldNames.stringValue};
+      } else if (message?.${fieldNames.numberValue} !== undefined) {
+        return message.${fieldNames.numberValue};
+      } else if (message?.${fieldNames.boolValue} !== undefined) {
+        return message.${fieldNames.boolValue};
+      } else if (message?.${fieldNames.structValue} !== undefined) {
+        return message.${fieldNames.structValue};
+      } else if (message?.${fieldNames.listValue} !== undefined) {
+          return message.${fieldNames.listValue};
+      } else if (message?.${fieldNames.nullValue} !== undefined) {
         return null;
       }
       return undefined;

package/build/options.js

@@ -88,8 +88,17 @@ function optionsFromParameter(parameter) {
         }
         Object.assign(options, parsed);
     }
-    // We should promote onlyTypes to its own documented flag, but just an alias for now
-    if (!options.outputJsonMethods && !options.outputEncodeMethods && !options.outputClientImpl && !options.nestJs) {
+    // onlyTypes=true implies outputJsonMethods=false,outputEncodeMethods=false,outputClientImpl=false,nestJs=false
+    if (options.onlyTypes) {
+        options.outputJsonMethods = false;
+        options.outputEncodeMethods = false;
+        options.outputClientImpl = false;
+        options.nestJs = false;
+    }
+    else if (!options.outputJsonMethods &&
+        !options.outputEncodeMethods &&
+        !options.outputClientImpl &&
+        !options.nestJs) {
         options.onlyTypes = true;
     }
     // Treat forceLong=true as LONG
@@ -124,6 +133,17 @@ function optionsFromParameter(parameter) {
     else if (typeof options.snakeToCamel === 'string') {
         options.snakeToCamel = [options.snakeToCamel];
     }
+    if (options.useJsonWireFormat) {
+        if (!options.onlyTypes) {
+            // useJsonWireFormat requires onlyTypes=true
+            options.useJsonWireFormat = false;
+        }
+        else {
+            // useJsonWireFormat implies stringEnums=true and useDate=string
+            options.stringEnums = true;
+            options.useDate = DateOption.STRING;
+        }
+    }
     return options;
 }
 exports.optionsFromParameter = optionsFromParameter;

package/build/types.js

@@ -436,7 +436,6 @@ function isEmptyType(typeName) {
 }
 exports.isEmptyType = isEmptyType;
 function valueTypeName(ctx, typeName) {
-    const useJsonWireFormat = ctx.options.onlyTypes && ctx.options.useJsonWireFormat;
     switch (typeName) {
         case '.google.protobuf.StringValue':
             return ts_poet_1.code `string`;
@@ -452,7 +451,11 @@ function valueTypeName(ctx, typeName) {
         case '.google.protobuf.BoolValue':
             return ts_poet_1.code `boolean`;
         case '.google.protobuf.BytesValue':
-            return ctx.options.env === options_1.EnvOption.NODE ? ts_poet_1.code `Buffer` : useJsonWireFormat ? ts_poet_1.code `string` : ts_poet_1.code `Uint8Array`;
+            return ctx.options.env === options_1.EnvOption.NODE
+                ? ts_poet_1.code `Buffer`
+                : ctx.options.useJsonWireFormat
+                    ? ts_poet_1.code `string`
+                    : ts_poet_1.code `Uint8Array`;
         case '.google.protobuf.ListValue':
             return ts_poet_1.code `Array<any>`;
         case '.google.protobuf.Value':
@@ -460,11 +463,11 @@ function valueTypeName(ctx, typeName) {
         case '.google.protobuf.Struct':
             return ts_poet_1.code `{[key: string]: any}`;
         case '.google.protobuf.FieldMask':
-            return useJsonWireFormat ? ts_poet_1.code `string` : ts_poet_1.code `string[]`;
+            return ctx.options.useJsonWireFormat ? ts_poet_1.code `string` : ts_poet_1.code `string[]`;
         case '.google.protobuf.Duration':
-            return useJsonWireFormat ? ts_poet_1.code `string` : undefined;
+            return ctx.options.useJsonWireFormat ? ts_poet_1.code `string` : undefined;
         case '.google.protobuf.Timestamp':
-            return useJsonWireFormat ? ts_poet_1.code `string` : undefined;
+            return ctx.options.useJsonWireFormat ? ts_poet_1.code `string` : undefined;
         default:
             return undefined;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-proto",
-  "version": "1.115.1",
+  "version": "1.115.4",
   "description": "",
   "main": "build/plugin.js",
   "repository": "github:stephenh/ts-proto",
@@ -66,7 +66,7 @@
     "dataloader": "^1.4.0",
     "object-hash": "^1.3.1",
     "protobufjs": "^6.11.3",
-    "ts-poet": "^t 4.11.0",
+    "ts-poet": "^4.11.0",
     "ts-proto-descriptors": "1.6.0"
   }
 }