ts-proto 1.115.1 → 1.115.2

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [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/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.2",
   "description": "",
   "main": "build/plugin.js",
   "repository": "github:stephenh/ts-proto",