ts-proto 2.19.0 → 2.21.0

package/README.markdown

@@ -481,10 +481,18 @@ 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.
 
+- With `--ts_proto_opt=nestJs=client` or `--ts_proto_opt=nestJs=server`, only the client-side or server-side NestJS service output will be generated, with the same changed defaults as `nestJs=true`.
+
+  With `nestJs=client`, only the `FooServiceClient` interface is generated, i.e. there is no `FooServiceController` interface or `@FooServiceControllerMethods()` decorator, so the output doesn't import `@nestjs/microservices`. With `nestJs=server`, only the controller interface and decorator are generated. The message types and the `FOO_PACKAGE_NAME`/`FOO_SERVICE_NAME` consts are generated in both cases.
+
+  `nestJs=client,nestJs=server` is the same as `nestJs=true`.
+
 - With `--ts_proto_opt=useDate=false`, fields of type `google.protobuf.Timestamp` will not be mapped to type `Date` in the generated types. See [Timestamp](#timestamp) for more details.
 
 - With `--ts_proto_opt=useMongoObjectId=true`, fields of a type called ObjectId where the message is constructed to have on field called value that is a string will be mapped to type `mongodb.ObjectId` in the generated types. This will require your project to install the mongodb npm package. See [ObjectId](#objectid) for more details.

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/build/src/main.js

@@ -69,7 +69,7 @@ function generateFile(ctx, fileDesc) {
         chunks.push((0, enums_1.generateEnum)(ctx, fullName, enumDesc, sInfo));
     });
     // If nestJs=true export [package]_PACKAGE_NAME and [service]_SERVICE_NAME const
-    if (options.nestJs) {
+    if (options.nestJs.length > 0) {
         if (options.exportCommonSymbols) {
             const prefix = (0, case_1.camelToSnake)(fileDesc.package.replace(/\./g, "_"));
             chunks.push((0, ts_poet_1.code) `export const ${prefix}_PACKAGE_NAME = '${fileDesc.package}';`);
@@ -85,7 +85,7 @@ function generateFile(ctx, fileDesc) {
         options.outputJsonMethods ||
         options.outputTypeAnnotations ||
         options.outputTypeRegistry ||
-        options.nestJs) {
+        options.nestJs.length > 0) {
         // then add the encoder/decoder/base instance
         (0, visit_1.visit)(fileDesc, sourceInfo, (fullName, message, _sInfo, fullProtoTypeName) => {
             const fullTypeName = (0, utils_1.maybePrefixPackage)(fileDesc, fullProtoTypeName);
@@ -98,7 +98,7 @@ function generateFile(ctx, fileDesc) {
                 (options.outputDecodeIncludeTypes === "" ||
                     new RegExp(options.outputDecodeIncludeTypes).test(fullTypeName))) ||
                 options.outputPartialMethods ||
-                (outputWrapAndUnwrap && !(options.nestJs && (0, types_1.isAnyValueTypeName)(fullTypeName)))) {
+                (outputWrapAndUnwrap && !(options.nestJs.length > 0 && (0, types_1.isAnyValueTypeName)(fullTypeName)))) {
                 chunks.push(generateBaseInstanceFactory(ctx, fullName, message, fullTypeName));
             }
             const staticMembers = [];
@@ -168,7 +168,7 @@ function generateFile(ctx, fileDesc) {
                 structValue: (0, utils_1.getFieldName)({ name: "struct_value", jsonName: (0, case_1.snakeToCamel)("struct_value") }, ctx.options),
                 listValue: (0, utils_1.getFieldName)({ name: "list_value", jsonName: (0, case_1.snakeToCamel)("list_value") }, ctx.options),
             };
-            if (options.nestJs) {
+            if (options.nestJs.length > 0) {
                 staticMembers.push(...(0, generate_struct_wrappers_1.generateWrapDeep)(ctx, fullTypeName, structFieldNames));
                 staticMembers.push(...(0, generate_struct_wrappers_1.generateUnwrapDeep)(ctx, fullTypeName, structFieldNames));
             }
@@ -232,7 +232,7 @@ function generateFile(ctx, fileDesc) {
             chunks.push((0, ts_poet_1.code) `export const ${name}: ${ctx.utils.Extension}<${type}> = ${extensionInfo};`);
         }
     }
-    if (options.nestJs) {
+    if (options.nestJs.length > 0) {
         if (fileDesc.messageType.find(hasStructTypeField)) {
             chunks.push(makeProtobufStructWrapper(options));
         }
@@ -240,14 +240,18 @@ function generateFile(ctx, fileDesc) {
     let hasServerStreamingMethods = false;
     let hasStreamingMethods = false;
     (0, visit_1.visitServices)(fileDesc, sourceInfo, (serviceDesc, sInfo) => {
-        if (options.nestJs) {
+        if (options.nestJs.length > 0) {
             // NestJS is sufficiently different that we special case the client/server interfaces
-            // generate nestjs grpc client interface
-            chunks.push((0, generate_nestjs_1.generateNestjsServiceClient)(ctx, fileDesc, sInfo, serviceDesc));
-            // and the service controller interface
-            chunks.push((0, generate_nestjs_1.generateNestjsServiceController)(ctx, fileDesc, sInfo, serviceDesc));
-            // generate nestjs grpc service controller decorator
-            chunks.push((0, generate_nestjs_1.generateNestjsGrpcServiceMethodsDecorator)(ctx, fileDesc, serviceDesc));
+            if (options.nestJs.includes("client")) {
+                // generate nestjs grpc client interface
+                chunks.push((0, generate_nestjs_1.generateNestjsServiceClient)(ctx, fileDesc, sInfo, serviceDesc));
+            }
+            if (options.nestJs.includes("server")) {
+                // generate nestjs grpc service controller interface
+                chunks.push((0, generate_nestjs_1.generateNestjsServiceController)(ctx, fileDesc, sInfo, serviceDesc));
+                // generate nestjs grpc service controller decorator
+                chunks.push((0, generate_nestjs_1.generateNestjsGrpcServiceMethodsDecorator)(ctx, fileDesc, serviceDesc));
+            }
             let serviceConstName = `${(0, case_1.camelToSnake)(serviceDesc.name)}_NAME`;
             if (!serviceDesc.name.toLowerCase().endsWith("service")) {
                 serviceConstName = `${(0, case_1.camelToSnake)(serviceDesc.name)}_SERVICE_NAME`;

package/build/src/options.d.ts

@@ -84,7 +84,7 @@ export type Options = {
     useNestjsFqnServiceName: boolean;
     returnObservable: boolean;
     lowerCaseServiceMethods: boolean;
-    nestJs: boolean;
+    nestJs: Array<"client" | "server">;
     env: EnvOption;
     unrecognizedEnum: boolean;
     unrecognizedEnumName: string;

package/build/src/options.js

@@ -100,7 +100,7 @@ function defaultOptions() {
         metadataType: undefined,
         addNestjsRestParameter: false,
         useNestjsFqnServiceName: false,
-        nestJs: false,
+        nestJs: [],
         env: EnvOption.BOTH,
         unrecognizedEnum: true,
         unrecognizedEnumName: "UNRECOGNIZED",
@@ -162,17 +162,32 @@ function optionsFromParameter(parameter) {
         }
         Object.assign(options, parsed);
     }
+    // Treat nestJs=true as both the client & server interfaces, and nestJs=false as neither
+    if (options.nestJs === true) {
+        options.nestJs = ["client", "server"];
+    }
+    else if (options.nestJs === false) {
+        options.nestJs = [];
+    }
+    else if (typeof options.nestJs === "string") {
+        options.nestJs = [options.nestJs];
+    }
+    for (const value of options.nestJs) {
+        if (value !== "client" && value !== "server") {
+            throw new Error(`nestJs must be true, false, client, or server, but got '${value}'`);
+        }
+    }
     // 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;
+        options.nestJs = [];
     }
     else if (!options.outputJsonMethods &&
         !options.outputEncodeMethods &&
         !options.outputClientImpl &&
-        !options.nestJs) {
+        options.nestJs.length === 0) {
         options.onlyTypes = true;
     }
     // Treat forceLong=true as LONG
@@ -189,11 +204,11 @@ function optionsFromParameter(parameter) {
     }
     // Assume the user wants the default service output, unless they're using nestJs, which has
     // its own controllers output (although nestjs users can ask for other services too).
-    if (options.outputServices.length == 0 && !options.nestJs) {
+    if (options.outputServices.length == 0 && options.nestJs.length === 0) {
         options.outputServices = [ServiceOption.DEFAULT];
     }
     // If using nestJs + other services, add the encode methods back
-    if (options.nestJs && options.outputServices.length > 0) {
+    if (options.nestJs.length > 0 && options.outputServices.length > 0) {
         options.outputEncodeMethods = true;
     }
     // Handle outputSchema=true
@@ -242,7 +257,7 @@ function optionsFromParameter(parameter) {
             options.useDate = DateOption.STRING;
         }
     }
-    if (options.nestJs) {
+    if (options.nestJs.length > 0) {
         options.initializeFieldsAsUndefined = false;
     }
     else {
@@ -267,7 +282,7 @@ function optionsFromParameter(parameter) {
         (options.outputTypeRegistry ||
             options.outputTypeAnnotations === "static-only" ||
             options.outputServices.includes(ServiceOption.GENERIC) ||
-            options.nestJs ||
+            options.nestJs.length > 0 ||
             options.useMongoObjectId)) {
         throw new Error("outputStandaloneFunctions=true can't be used with outputTypeRegistry=true, outputTypeAnnotations=static-only, outputServices=generic-definitions, nestJs=true, or useMongoObjectId=true");
     }

package/package.json

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