ts-proto 1.109.1 → 1.110.2

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+## [1.110.2](https://github.com/stephenh/ts-proto/compare/v1.110.1...v1.110.2) (2022-03-27)
+
+
+### Bug Fixes
+
+* **Grpc-Web:** Fix compilation failure when a service definition contains a client streaming call. ([#535](https://github.com/stephenh/ts-proto/issues/535)) ([0c83892](https://github.com/stephenh/ts-proto/commit/0c83892693d5755c9fe848b442b5e666192103ab))
+
+## [1.110.1](https://github.com/stephenh/ts-proto/compare/v1.110.0...v1.110.1) (2022-03-25)
+
+
+### Bug Fixes
+
+* Use a module star import for protobuf types. ([#540](https://github.com/stephenh/ts-proto/issues/540)) ([f5b7700](https://github.com/stephenh/ts-proto/commit/f5b770083dffe72338beb4a09432a2a917760eae))
+
+# [1.110.0](https://github.com/stephenh/ts-proto/compare/v1.109.1...v1.110.0) (2022-03-15)
+
+
+### Features
+
+* Add generic metadata parameter to the generic service definition interface. ([#530](https://github.com/stephenh/ts-proto/issues/530)) ([0f5525a](https://github.com/stephenh/ts-proto/commit/0f5525ade80e7b69889dfd091a458e21bb14a265))
+
 ## [1.109.1](https://github.com/stephenh/ts-proto/compare/v1.109.0...v1.109.1) (2022-03-13)
 
 

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=metadataType=Foo@./some-file`, ts-proto add a generic (framework-agnostic) metadata field to the generic service definition.
+
 - 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.

package/build/generate-grpc-web.js

@@ -28,31 +28,40 @@ function generateGrpcClientImpl(ctx, fileDesc, serviceDesc) {
         utils_1.assertInstanceOf(methodDesc, utils_1.FormattedMethodDescriptor);
         chunks.push(ts_poet_1.code `this.${methodDesc.formattedName} = this.${methodDesc.formattedName}.bind(this);`);
     }
-    chunks.push(ts_poet_1.code `}\n`);
+    chunks.push(ts_poet_1.code `}`);
     // Create a method for each FooService method
     for (const methodDesc of serviceDesc.method) {
         chunks.push(generateRpcMethod(ctx, serviceDesc, methodDesc));
     }
     chunks.push(ts_poet_1.code `}`);
-    return ts_poet_1.joinCode(chunks, { trim: false });
+    return ts_poet_1.joinCode(chunks, { trim: false, on: '\n' });
 }
 exports.generateGrpcClientImpl = generateGrpcClientImpl;
 /** Creates the RPC methods that client code actually calls. */
 function generateRpcMethod(ctx, serviceDesc, methodDesc) {
     utils_1.assertInstanceOf(methodDesc, utils_1.FormattedMethodDescriptor);
-    const { options, utils } = ctx;
-    const inputType = types_1.requestType(ctx, methodDesc);
-    const partialInputType = ts_poet_1.code `${utils.DeepPartial}<${inputType}>`;
+    const requestMessage = types_1.rawRequestType(ctx, methodDesc);
+    const inputType = types_1.requestType(ctx, methodDesc, true);
     const returns = types_1.responsePromiseOrObservable(ctx, methodDesc);
+    if (methodDesc.clientStreaming) {
+        return ts_poet_1.code `
+    ${methodDesc.formattedName}(
+      request: ${inputType},
+      metadata?: grpc.Metadata,
+    ): ${returns} {
+      throw new Error('ts-proto does not yet support client streaming!');
+    }
+  `;
+    }
     const method = methodDesc.serverStreaming ? 'invoke' : 'unary';
     return ts_poet_1.code `
     ${methodDesc.formattedName}(
-      request: ${partialInputType},
+      request: ${inputType},
       metadata?: grpc.Metadata,
     ): ${returns} {
       return this.rpc.${method}(
         ${methodDescName(serviceDesc, methodDesc)},
-        ${inputType}.fromPartial(request),
+        ${requestMessage}.fromPartial(request),
         metadata,
       );
     }

package/build/generate-services.js

@@ -35,12 +35,10 @@ function generateService(ctx, fileDesc, sourceInfo, serviceDesc) {
         if (options.context) {
             params.push(ts_poet_1.code `ctx: Context`);
         }
-        let inputType = types_1.requestType(ctx, methodDesc);
         // the grpc-web clients auto-`fromPartial` the input before handing off to grpc-web's
         // serde runtime, so it's okay to accept partial results from the client
-        if (options.outputClientImpl === 'grpc-web') {
-            inputType = ts_poet_1.code `${utils.DeepPartial}<${inputType}>`;
-        }
+        const partialInput = options.outputClientImpl === 'grpc-web';
+        const inputType = types_1.requestType(ctx, methodDesc, partialInput);
         params.push(ts_poet_1.code `request: ${inputType}`);
         // Use metadata as last argument for interface only configuration
         if (options.outputClientImpl === 'grpc-web') {
@@ -52,6 +50,10 @@ function generateService(ctx, fileDesc, sourceInfo, serviceDesc) {
             const q = options.addNestjsRestParameter ? '' : '?';
             params.push(ts_poet_1.code `metadata${q}: ${Metadata}`);
         }
+        else if (options.metadataType) {
+            const Metadata = ts_poet_1.imp(options.metadataType);
+            params.push(ts_poet_1.code `metadata?: ${Metadata}`);
+        }
         if (options.addNestjsRestParameter) {
             params.push(ts_poet_1.code `...rest: any`);
         }

package/build/main.js

@@ -138,7 +138,9 @@ function generateFile(ctx, fileDesc) {
                         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.clientStreaming) {
+                                chunks.push(generate_grpc_web_1.generateGrpcMethodDesc(ctx, serviceDesc, method));
+                            }
                             if (method.serverStreaming) {
                                 hasServerStreamingMethods = true;
                             }

package/build/options.js

@@ -54,6 +54,7 @@ function defaultOptions() {
         outputServices: [],
         returnObservable: false,
         addGrpcMetadata: false,
+        metadataType: undefined,
         addNestjsRestParameter: false,
         nestJs: false,
         env: EnvOption.BOTH,
@@ -140,11 +141,6 @@ function parseParameter(parameter) {
     return options;
 }
 function getTsPoetOpts(options) {
-    if (options.esModuleInterop) {
-        return { forceDefaultImport: ['protobufjs/minimal'] };
-    }
-    else {
-        return {};
-    }
+    return { forceModuleImport: ['protobufjs/minimal'] };
 }
 exports.getTsPoetOpts = getTsPoetOpts;

package/build/types.js

@@ -601,8 +601,11 @@ function rawRequestType(ctx, methodDesc) {
     return messageToTypeName(ctx, methodDesc.inputType);
 }
 exports.rawRequestType = rawRequestType;
-function requestType(ctx, methodDesc) {
+function requestType(ctx, methodDesc, partial = false) {
     let typeName = rawRequestType(ctx, methodDesc);
+    if (partial) {
+        typeName = ts_poet_1.code `${ctx.utils.DeepPartial}<${typeName}>`;
+    }
     if (methodDesc.clientStreaming) {
         return ts_poet_1.code `${ts_poet_1.imp('Observable@rxjs')}<${typeName}>`;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-proto",
-  "version": "1.109.1",
+  "version": "1.110.2",
   "description": "",
   "main": "build/plugin.js",
   "repository": "github:stephenh/ts-proto",
@@ -64,7 +64,7 @@
     "dataloader": "^1.4.0",
     "object-hash": "^1.3.1",
     "protobufjs": "^6.8.8",
-    "ts-poet": "^4.10.0",
+    "ts-poet": "^4.11.0",
     "ts-proto-descriptors": "1.6.0"
   }
 }