ts-proto 2.20.0 → 2.21.0

package/README.markdown

@@ -481,7 +481,9 @@ With `--ts_proto_opt=protoJsonFormat=false`, strict proto3 compliance is disable
 
 - With `--ts_proto_opt=nestJs=true`, the defaults will change to generate [NestJS protobuf](https://docs.nestjs.com/microservices/grpc) friendly types & service interfaces that can be used in both the client-side and server-side of NestJS protobuf implementations. See the [nestjs readme](NESTJS.markdown) for more information and implementation examples.
 
-  Specifically `outputEncodeMethods`, `outputJsonMethods`, and `outputClientImpl` will all be false, `lowerCaseServiceMethods` will be true and `outputServices` will be ignored.
+  Specifically `outputEncodeMethods`, `outputJsonMethods`, `outputPartialMethods`, and `outputClientImpl` will all be false, `lowerCaseServiceMethods` will be true and `outputServices` will be ignored.
+
+  If `outputPartialMethods=true` is set as well, the `FooServiceClient` methods will accept `DeepPartial` requests and the `FooServiceController` methods may return `DeepPartial` responses, since any missing fields are received as their default values.
 
   Note that `addGrpcMetadata`, `addNestjsRestParameter`, `returnObservable` and `useNestjsFqnServiceName` will still be false.
 

package/build/src/generate-nestjs.js

@@ -34,20 +34,26 @@ function generateNestjsServiceController(ctx, fileDesc, sourceInfo, serviceDesc)
         if (options.addNestjsRestParameter) {
             params.push((0, ts_poet_1.code) `...rest: any`);
         }
+        // NestJS encodes the response with @grpc/proto-loader, which leaves out any missing fields,
+        // i.e. the client receives them as their default values, so it's okay to accept partial responses
+        let outputType = (0, types_1.responseType)(ctx, methodDesc);
+        if (options.outputPartialMethods) {
+            outputType = (0, ts_poet_1.code) `${ctx.utils.DeepPartial}<${outputType}>`;
+        }
         // Return observable for interface only configuration, passing returnObservable=true and methodDesc.serverStreaming=true
         let returns;
         if ((0, types_1.isEmptyType)(methodDesc.outputType)) {
             returns = (0, ts_poet_1.code) `void | Promise<void>`;
         }
         else if (options.returnObservable || methodDesc.serverStreaming) {
-            returns = (0, ts_poet_1.code) `${(0, types_1.responseObservable)(ctx, methodDesc)}`;
+            returns = (0, ts_poet_1.code) `${(0, types_1.observableType)(ctx)}<${outputType}>`;
         }
         else {
             // generate nestjs union type
             returns = (0, ts_poet_1.code) `
-        ${(0, types_1.responsePromise)(ctx, methodDesc)}
-        | ${(0, types_1.responseObservable)(ctx, methodDesc)}
-        | ${(0, types_1.responseType)(ctx, methodDesc)}
+        Promise<${outputType}>
+        | ${(0, types_1.observableType)(ctx)}<${outputType}>
+        | ${outputType}
       `;
         }
         chunks.push((0, ts_poet_1.code) `
@@ -84,7 +90,9 @@ function generateNestjsServiceClient(ctx, fileDesc, sourceInfo, serviceDesc) {
         if (options.context) {
             params.push((0, ts_poet_1.code) `ctx: Context`);
         }
-        params.push((0, ts_poet_1.code) `request: ${(0, types_1.requestType)(ctx, methodDesc)}`);
+        // NestJS encodes the request with @grpc/proto-loader, which leaves out any missing fields,
+        // i.e. the server receives them as their default values, so it's okay to accept partial requests
+        params.push((0, ts_poet_1.code) `request: ${(0, types_1.requestType)(ctx, methodDesc, options.outputPartialMethods)}`);
         // Use metadata as last argument for interface only configuration
         if (options.addGrpcMetadata) {
             const q = options.addNestjsRestParameter ? "" : "?";

package/package.json

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