ts-proto 1.106.2 → 1.109.0

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+# [1.109.0](https://github.com/stephenh/ts-proto/compare/v1.108.0...v1.109.0) (2022-03-13)
+
+
+### Features
+
+* import proto as type import if onlyTypes is set ([25d8e8b](https://github.com/stephenh/ts-proto/commit/25d8e8b9042142f1032feadc8a799b7a01115cc2))
+
+# [1.108.0](https://github.com/stephenh/ts-proto/compare/v1.107.0...v1.108.0) (2022-03-07)
+
+
+### Features
+
+* represent field masks as `string[]` ([#525](https://github.com/stephenh/ts-proto/issues/525)) ([903b216](https://github.com/stephenh/ts-proto/commit/903b216238db025e24ec3cfb2d20063aec1a40ed))
+
+# [1.107.0](https://github.com/stephenh/ts-proto/compare/v1.106.2...v1.107.0) (2022-03-04)
+
+
+### Features
+
+* Allow simultaneous services and generic service definitions ([#512](https://github.com/stephenh/ts-proto/issues/512)) ([680831e](https://github.com/stephenh/ts-proto/commit/680831e76f1a4ceb4337442a157d7e702cb14bfc))
+
 ## [1.106.2](https://github.com/stephenh/ts-proto/compare/v1.106.1...v1.106.2) (2022-02-27)
 
 

package/README.markdown

@@ -362,6 +362,8 @@ Generated code will be placed in the Gradle build directory.
 
 - With `--ts_proto_opt=outputServices=generic-definitions`, ts-proto will output generic (framework-agnostic) service definitions. These definitions contain descriptors for each method with links to request and response types, which allows to generate server and client stubs at runtime, and also generate strong types for them at compile time. An example of a library that uses this approach is [nice-grpc](https://github.com/deeplay-io/nice-grpc).
 
+- With `--ts_proto_opt=outputServices=generic-definitions,outputServices=default`, ts-proto will output both generic definitions and interfaces.  This is useful if you want to rely on the interfaces, but also have some reflection capabilities at runtime.
+
 - With `--ts_proto_opt=outputServices=false`, or `=none`, ts-proto will output NO service definitions.
 
 - With `--ts_proto_opt=emitImportedFiles=false`, ts-proto will not emit `google/protobuf/*` files unless you explicit add files to `protoc` like this
@@ -620,24 +622,19 @@ Their interpretation is defined by the Protobuf specification, and libraries are
 
 `ts-proto` currently automatically converts these messages to their corresponding native types.
 
-- Wrapper Types:
-
-  * [google.protobuf.DoubleValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#DoubleValue) ⇆ `number | undefined`
-  * [google.protobuf.FloatValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#FloatValue) ⇆ `number | undefined`
-  * [google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#Int64Value) ⇆ `number | undefined`
-  * [google.protobuf.UInt64Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#UInt64Value) ⇆ `number | undefined`
-  * [google.protobuf.Int32Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#Int32Value) ⇆ `number | undefined`
-  * [google.protobuf.UInt32Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#UInt32Value) ⇆ `number | undefined`
-  * [google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#BoolValue) ⇆ `boolean | undefined`
-  * [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#StringValue) ⇆ `string | undefined`
-  * [google.protobuf.BytesValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.BytesValue) ⇆ `Uint8Array | undefined`
-
-- JSON Types (Struct Types):
-
-  * [google.protobuf.Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#Value)  ⇆ `any | undefined` (i.e. `number | string | boolean | null | array | object`)
-  * [google.protobuf.ListValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#ListValue) ⇆ `any[]`
-  * [google.protobuf.Struct](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#Struct) ⇆ `{ [key: string]: any } | undefined`
-  * [google.protobuf.FieldMask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask) ⇆ `string[]` (only in the JSON, `FieldMask` is still a message)
+ * [google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#boolvalue) ⇆ `boolean`
+ * [google.protobuf.BytesValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#bytesvalue) ⇆ `Uint8Array`
+ * [google.protobuf.DoubleValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#doublevalue) ⇆ `number`
+ * [google.protobuf.FieldMask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask) ⇆ `string[]`
+ * [google.protobuf.FloatValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#floatvalue) ⇆ `number`
+ * [google.protobuf.Int32Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#int32value) ⇆ `number`
+ * [google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#int64value) ⇆ `number`
+ * [google.protobuf.ListValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#listvalue) ⇆ `any[]`
+ * [google.protobuf.UInt32Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#uint32value) ⇆ `number`
+ * [google.protobuf.UInt64Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#uint64value) ⇆ `number`
+ * [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#stringvalue) ⇆ `string`
+ * [google.protobuf.Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#value)  ⇆ `any` (i.e. `number | string | boolean | null | array | object`)
+ * [google.protobuf.Struct](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) ⇆ `{ [key: string]: any }`
 
 ## Wrapper Types
 

package/build/main.js

@@ -80,8 +80,8 @@ function generateFile(ctx, fileDesc) {
                 staticMembers.push(generateDecode(ctx, fullName, message));
             }
             if (options.outputJsonMethods) {
-                staticMembers.push(generateFromJson(ctx, fullName, message));
-                staticMembers.push(generateToJson(ctx, fullName, message));
+                staticMembers.push(generateFromJson(ctx, fullName, fullTypeName, message));
+                staticMembers.push(generateToJson(ctx, fullName, fullTypeName, message));
             }
             if (options.outputPartialMethods) {
                 staticMembers.push(generateFromPartial(ctx, fullName, message));
@@ -118,29 +118,34 @@ function generateFile(ctx, fileDesc) {
             }
             chunks.push(ts_poet_1.code `export const ${serviceConstName} = "${serviceDesc.name}";`);
         }
-        else if (options.outputServices === options_1.ServiceOption.GRPC) {
-            chunks.push(generate_grpc_js_1.generateGrpcJsService(ctx, fileDesc, sInfo, serviceDesc));
-        }
-        else if (options.outputServices === options_1.ServiceOption.GENERIC) {
-            chunks.push(generate_generic_service_definition_1.generateGenericServiceDefinition(ctx, fileDesc, sInfo, serviceDesc));
-        }
-        else if (options.outputServices === options_1.ServiceOption.DEFAULT) {
-            // This service could be Twirp or grpc-web or JSON (maybe). So far all of their
-            // interfaces are fairly similar so we share the same service interface.
-            chunks.push(generate_services_1.generateService(ctx, fileDesc, sInfo, serviceDesc));
-            if (options.outputClientImpl === true) {
-                chunks.push(generate_services_1.generateServiceClientImpl(ctx, fileDesc, serviceDesc));
-            }
-            else if (options.outputClientImpl === 'grpc-web') {
-                chunks.push(generate_grpc_web_1.generateGrpcClientImpl(ctx, fileDesc, serviceDesc));
-                chunks.push(generate_grpc_web_1.generateGrpcServiceDesc(fileDesc, serviceDesc));
-                serviceDesc.method.forEach((method) => {
-                    chunks.push(generate_grpc_web_1.generateGrpcMethodDesc(ctx, serviceDesc, method));
-                    if (method.serverStreaming) {
-                        hasServerStreamingMethods = true;
+        else {
+            const uniqueServices = [...new Set(options.outputServices)].sort();
+            uniqueServices.forEach((outputService) => {
+                if (outputService === options_1.ServiceOption.GRPC) {
+                    chunks.push(generate_grpc_js_1.generateGrpcJsService(ctx, fileDesc, sInfo, serviceDesc));
+                }
+                else if (outputService === options_1.ServiceOption.GENERIC) {
+                    chunks.push(generate_generic_service_definition_1.generateGenericServiceDefinition(ctx, fileDesc, sInfo, serviceDesc));
+                }
+                else if (outputService === options_1.ServiceOption.DEFAULT) {
+                    // This service could be Twirp or grpc-web or JSON (maybe). So far all of their
+                    // interfaces are fairly similar so we share the same service interface.
+                    chunks.push(generate_services_1.generateService(ctx, fileDesc, sInfo, serviceDesc));
+                    if (options.outputClientImpl === true) {
+                        chunks.push(generate_services_1.generateServiceClientImpl(ctx, fileDesc, serviceDesc));
                     }
-                });
-            }
+                    else if (options.outputClientImpl === 'grpc-web') {
+                        chunks.push(generate_grpc_web_1.generateGrpcClientImpl(ctx, fileDesc, serviceDesc));
+                        chunks.push(generate_grpc_web_1.generateGrpcServiceDesc(fileDesc, serviceDesc));
+                        serviceDesc.method.forEach((method) => {
+                            chunks.push(generate_grpc_web_1.generateGrpcMethodDesc(ctx, serviceDesc, method));
+                            if (method.serverStreaming) {
+                                hasServerStreamingMethods = true;
+                            }
+                        });
+                    }
+                }
+            });
         }
         serviceDesc.method.forEach((methodDesc, index) => {
             if (methodDesc.serverStreaming || methodDesc.clientStreaming) {
@@ -148,7 +153,9 @@ function generateFile(ctx, fileDesc) {
             }
         });
     });
-    if (options.outputServices === options_1.ServiceOption.DEFAULT && options.outputClientImpl && fileDesc.service.length > 0) {
+    if (options.outputServices.includes(options_1.ServiceOption.DEFAULT) &&
+        options.outputClientImpl &&
+        fileDesc.service.length > 0) {
         if (options.outputClientImpl === true) {
             chunks.push(generate_services_1.generateRpcType(ctx, hasStreamingMethods));
         }
@@ -597,7 +604,7 @@ function generateDecode(ctx, fullName, messageDesc) {
         else if (types_1.isValueType(ctx, field)) {
             const type = types_1.basicTypeName(ctx, field, { keepValueType: true });
             const unwrap = (decodedValue) => {
-                if (types_1.isListValueType(field) || types_1.isStructType(field) || types_1.isAnyValueType(field)) {
+                if (types_1.isListValueType(field) || types_1.isStructType(field) || types_1.isAnyValueType(field) || types_1.isFieldMaskType(field)) {
                     return ts_poet_1.code `${type}.unwrap(${decodedValue})`;
                 }
                 return ts_poet_1.code `${decodedValue}.value`;
@@ -722,7 +729,7 @@ function generateEncode(ctx, fullName, messageDesc) {
             const maybeTypeField = options.outputTypeRegistry ? `$type: '${field.typeName.slice(1)}',` : '';
             const type = types_1.basicTypeName(ctx, field, { keepValueType: true });
             const wrappedValue = (place) => {
-                if (types_1.isAnyValueType(field) || types_1.isListValueType(field) || types_1.isStructType(field)) {
+                if (types_1.isAnyValueType(field) || types_1.isListValueType(field) || types_1.isStructType(field) || types_1.isFieldMaskType(field)) {
                     return ts_poet_1.code `${type}.wrap(${place})`;
                 }
                 return ts_poet_1.code `{${maybeTypeField} value: ${place}!}`;
@@ -880,7 +887,7 @@ function generateEncode(ctx, fullName, messageDesc) {
  * This is very similar to decode, we loop through looking for properties, with
  * a few special cases for https://developers.google.com/protocol-buffers/docs/proto3#json.
  * */
-function generateFromJson(ctx, fullName, messageDesc) {
+function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
     const { options, utils, typeMap } = ctx;
     const chunks = [];
     // create the basic function declaration
@@ -892,8 +899,18 @@ function generateFromJson(ctx, fullName, messageDesc) {
         chunks.push(ts_poet_1.code `$type: ${fullName}.$type,`);
     }
     const oneofFieldsCases = messageDesc.oneofDecl.map((oneof, oneofIndex) => messageDesc.field.filter(types_1.isWithinOneOf).filter((field) => field.oneofIndex === oneofIndex));
+    const canonicalFromJson = {
+        ['google.protobuf.FieldMask']: {
+            paths: (from) => ts_poet_1.code `typeof(${from}) === 'string'
+        ? ${from}.split(",").filter(Boolean)
+        : Array.isArray(${from}?.paths)
+        ? ${from}.paths.map(String)
+        : []`,
+        },
+    };
     // add a check for each incoming field
     messageDesc.field.forEach((field) => {
+        var _a;
         const fieldName = case_1.maybeSnakeToCamel(field.name, options);
         const jsonName = utils_1.getFieldJsonName(field, options);
         const jsonProperty = utils_1.getPropertyAccessor('object', jsonName);
@@ -937,7 +954,8 @@ function generateFromJson(ctx, fullName, messageDesc) {
                 return ts_poet_1.code `${from}`;
             }
             else if (types_1.isFieldMaskType(field)) {
-                return ts_poet_1.code `{paths: ${from}.split(",")}`;
+                const type = types_1.basicTypeName(ctx, field, { keepValueType: true });
+                return ts_poet_1.code `${type}.unwrap(${type}.fromJSON(${from}))`;
             }
             else if (types_1.isListValueType(field)) {
                 return ts_poet_1.code `[...${from}]`;
@@ -1010,7 +1028,10 @@ function generateFromJson(ctx, fullName, messageDesc) {
             }
         };
         // and then use the snippet to handle repeated fields if necessary
-        if (types_1.isRepeated(field)) {
+        if ((_a = canonicalFromJson[fullTypeName]) === null || _a === void 0 ? void 0 : _a[fieldName]) {
+            chunks.push(ts_poet_1.code `${fieldName}: ${canonicalFromJson[fullTypeName][fieldName]('object')},`);
+        }
+        else if (types_1.isRepeated(field)) {
             if (types_1.isMapType(ctx, messageDesc, field)) {
                 const fieldType = types_1.toTypeName(ctx, messageDesc, field);
                 const i = maybeCastToNumber(ctx, messageDesc, field, 'key');
@@ -1083,9 +1104,24 @@ function generateFromJson(ctx, fullName, messageDesc) {
     chunks.push(ts_poet_1.code `}`);
     return ts_poet_1.joinCode(chunks, { on: '\n' });
 }
-function generateToJson(ctx, fullName, messageDesc) {
+function generateCanonicalToJson(fullName, fullProtobufTypeName) {
+    if (types_1.isFieldMaskTypeName(fullProtobufTypeName)) {
+        return ts_poet_1.code `
+    toJSON(message: ${fullName}): string {
+      return message.paths.join(',');
+    }
+  `;
+    }
+    return undefined;
+}
+function generateToJson(ctx, fullName, fullProtobufTypeName, messageDesc) {
     const { options, utils, typeMap } = ctx;
     const chunks = [];
+    const canonicalToJson = generateCanonicalToJson(fullName, fullProtobufTypeName);
+    if (canonicalToJson) {
+        chunks.push(canonicalToJson);
+        return ts_poet_1.joinCode(chunks, { on: '\n' });
+    }
     // create the basic function declaration
     chunks.push(ts_poet_1.code `
     toJSON(${messageDesc.field.length > 0 ? 'message' : '_'}: ${fullName}): unknown {
@@ -1158,7 +1194,8 @@ function generateToJson(ctx, fullName, messageDesc) {
                 return ts_poet_1.code `${from}`;
             }
             else if (types_1.isFieldMaskType(field)) {
-                return ts_poet_1.code `${from}.paths.join()`;
+                const type = types_1.basicTypeName(ctx, field, { keepValueType: true });
+                return ts_poet_1.code `${type}.toJSON(${type}.wrap(${from}))`;
             }
             else if (types_1.isMessage(field) && !types_1.isValueType(ctx, field) && !types_1.isMapType(ctx, messageDesc, field)) {
                 const type = types_1.basicTypeName(ctx, field, { keepValueType: true });
@@ -1424,6 +1461,11 @@ function generateWrap(ctx, fullProtoTypeName) {
       return result;
     }`);
     }
+    if (types_1.isFieldMaskTypeName(fullProtoTypeName)) {
+        chunks.push(ts_poet_1.code `wrap(paths: string[]): FieldMask {
+      return {paths: paths};
+    }`);
+    }
     return chunks;
 }
 function generateUnwrap(ctx, fullProtoTypeName) {
@@ -1481,6 +1523,11 @@ function generateUnwrap(ctx, fullProtoTypeName) {
       return message.values;
     }`);
     }
+    if (types_1.isFieldMaskTypeName(fullProtoTypeName)) {
+        chunks.push(ts_poet_1.code `unwrap(message: FieldMask): string[] {
+      return message.paths;
+    }`);
+    }
     return chunks;
 }
 exports.contextTypeVar = 'Context extends DataLoaders';

package/build/options.js

@@ -51,7 +51,7 @@ function defaultOptions() {
         constEnums: false,
         enumsAsLiterals: false,
         outputClientImpl: true,
-        outputServices: ServiceOption.DEFAULT,
+        outputServices: [],
         returnObservable: false,
         addGrpcMetadata: false,
         addNestjsRestParameter: false,
@@ -95,7 +95,14 @@ function optionsFromParameter(parameter) {
     }
     // Treat outputServices=false as NONE
     if (options.outputServices === false) {
-        options.outputServices = ServiceOption.NONE;
+        options.outputServices = [ServiceOption.NONE];
+    }
+    // Existing type-coercion inside parseParameter leaves a little to be desired.
+    if (typeof options.outputServices == 'string') {
+        options.outputServices = [options.outputServices];
+    }
+    if (options.outputServices.length == 0) {
+        options.outputServices = [ServiceOption.DEFAULT];
     }
     if (options.useDate === true) {
         // Treat useDate=true as DATE

package/build/types.js

@@ -458,6 +458,8 @@ function valueTypeName(ctx, typeName) {
             return ts_poet_1.code `any`;
         case '.google.protobuf.Struct':
             return ts_poet_1.code `{[key: string]: any}`;
+        case '.google.protobuf.FieldMask':
+            return ts_poet_1.code `string[]`;
         default:
             return undefined;
     }

package/build/utils.js

@@ -137,7 +137,7 @@ class FormattedMethodDescriptor {
      */
     static formatName(methodName, options) {
         let result = methodName;
-        if (options.lowerCaseServiceMethods || options.outputServices === options_1.ServiceOption.GRPC) {
+        if (options.lowerCaseServiceMethods || options.outputServices.includes(options_1.ServiceOption.GRPC)) {
             result = case_1.camelCase(result);
         }
         return result;
@@ -170,6 +170,12 @@ function getPropertyAccessor(objectName, propertyName, optional = false) {
 }
 exports.getPropertyAccessor = getPropertyAccessor;
 function impProto(options, module, type) {
-    return ts_poet_1.imp(`${type}@./${module}${options.fileSuffix}`);
+    const importString = `${type}@./${module}${options.fileSuffix}`;
+    if (options.onlyTypes) {
+        return ts_poet_1.imp('t:' + importString);
+    }
+    else {
+        return ts_poet_1.imp(importString);
+    }
 }
 exports.impProto = impProto;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-proto",
-  "version": "1.106.2",
+  "version": "1.109.0",
   "description": "",
   "main": "build/plugin.js",
   "repository": "github:stephenh/ts-proto",
@@ -11,6 +11,7 @@
     "build": "yarn tsc",
     "build:test": "yarn proto2bin && yarn proto2pbjs && yarn bin2ts",
     "build:test:local": "yarn proto2bin:local && yarn proto2pbjs:local && yarn bin2ts:local",
+    "prepare": "yarn build",
     "proto2bin": "docker-compose run --rm protoc update-bins.sh",
     "proto2bin-node": "docker-compose run --rm node update-bins.sh",
     "proto2pbjs": "docker-compose run --rm protoc pbjs.sh",
@@ -63,7 +64,7 @@
     "dataloader": "^1.4.0",
     "object-hash": "^1.3.1",
     "protobufjs": "^6.8.8",
-    "ts-poet": "^4.5.0",
+    "ts-poet": "^4.10.0",
     "ts-proto-descriptors": "1.6.0"
   }
 }