ts-proto 1.84.0 → 1.85.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [1.85.0](https://github.com/stephenh/ts-proto/compare/v1.84.0...v1.85.0) (2021-11-02)
+
+
+### Features
+
+* Streaming support ([#373](https://github.com/stephenh/ts-proto/issues/373)) ([459b94f](https://github.com/stephenh/ts-proto/commit/459b94f5b2988d58d186461332e888c3e511603a))
+
 # [1.84.0](https://github.com/stephenh/ts-proto/compare/v1.83.3...v1.84.0) (2021-11-02)
 
 

package/build/generate-grpc-web.js

@@ -43,9 +43,7 @@ function generateRpcMethod(ctx, serviceDesc, methodDesc) {
     const { options, utils } = ctx;
     const inputType = types_1.requestType(ctx, methodDesc);
     const partialInputType = ts_poet_1.code `${utils.DeepPartial}<${inputType}>`;
-    const returns = options.returnObservable || methodDesc.serverStreaming
-        ? types_1.responseObservable(ctx, methodDesc)
-        : types_1.responsePromise(ctx, methodDesc);
+    const returns = types_1.responsePromiseOrObservable(ctx, methodDesc);
     const method = methodDesc.serverStreaming ? 'invoke' : 'unary';
     return ts_poet_1.code `
     ${methodDesc.formattedName}(

package/build/generate-services.js

@@ -55,15 +55,7 @@ function generateService(ctx, fileDesc, sourceInfo, serviceDesc) {
         if (options.addNestjsRestParameter) {
             params.push(ts_poet_1.code `...rest: any`);
         }
-        // Return observable for interface only configuration, passing returnObservable=true and methodDesc.serverStreaming=true
-        let returnType;
-        if (options.returnObservable || methodDesc.serverStreaming) {
-            returnType = types_1.responseObservable(ctx, methodDesc);
-        }
-        else {
-            returnType = types_1.responsePromise(ctx, methodDesc);
-        }
-        chunks.push(ts_poet_1.code `${methodDesc.formattedName}(${ts_poet_1.joinCode(params, { on: ',' })}): ${returnType};`);
+        chunks.push(ts_poet_1.code `${methodDesc.formattedName}(${ts_poet_1.joinCode(params, { on: ',' })}): ${types_1.responsePromiseOrObservable(ctx, methodDesc)};`);
         // If this is a batch method, auto-generate the singular version of it
         if (options.context) {
             const batchMethod = types_1.detectBatchMethod(ctx, fileDesc, serviceDesc, methodDesc);
@@ -83,22 +75,50 @@ function generateRegularRpcMethod(ctx, fileDesc, serviceDesc, methodDesc) {
     utils_1.assertInstanceOf(methodDesc, utils_1.FormattedMethodDescriptor);
     const { options } = ctx;
     const Reader = ts_poet_1.imp('Reader@protobufjs/minimal');
+    const rawInputType = types_1.rawRequestType(ctx, methodDesc);
     const inputType = types_1.requestType(ctx, methodDesc);
     const outputType = types_1.responseType(ctx, methodDesc);
     const params = [...(options.context ? [ts_poet_1.code `ctx: Context`] : []), ts_poet_1.code `request: ${inputType}`];
     const maybeCtx = options.context ? 'ctx,' : '';
+    let encode = ts_poet_1.code `${rawInputType}.encode(request).finish()`;
+    let decode = ts_poet_1.code `data => ${outputType}.decode(new ${Reader}(data))`;
+    if (methodDesc.clientStreaming) {
+        encode = ts_poet_1.code `request.pipe(${ts_poet_1.imp('map@rxjs/operators')}(request => ${encode}))`;
+    }
+    let returnVariable;
+    if (options.returnObservable || methodDesc.serverStreaming) {
+        returnVariable = 'result';
+        decode = ts_poet_1.code `result.pipe(${ts_poet_1.imp('map@rxjs/operators')}(${decode}))`;
+    }
+    else {
+        returnVariable = 'promise';
+        decode = ts_poet_1.code `promise.then(${decode})`;
+    }
+    let rpcMethod;
+    if (methodDesc.clientStreaming && methodDesc.serverStreaming) {
+        rpcMethod = 'bidirectionalStreamingRequest';
+    }
+    else if (methodDesc.serverStreaming) {
+        rpcMethod = 'serverStreamingRequest';
+    }
+    else if (methodDesc.clientStreaming) {
+        rpcMethod = 'clientStreamingRequest';
+    }
+    else {
+        rpcMethod = 'request';
+    }
     return ts_poet_1.code `
     ${methodDesc.formattedName}(
       ${ts_poet_1.joinCode(params, { on: ',' })}
-    ): ${types_1.responsePromise(ctx, methodDesc)} {
-      const data = ${inputType}.encode(request).finish();
-      const promise = this.rpc.request(
+    ): ${types_1.responsePromiseOrObservable(ctx, methodDesc)} {
+      const data = ${encode};
+      const ${returnVariable} = this.rpc.${rpcMethod}(
         ${maybeCtx}
         "${utils_1.maybePrefixPackage(fileDesc, serviceDesc.name)}",
         "${methodDesc.name}",
         data
       );
-      return promise.then(data => ${outputType}.decode(new ${Reader}(data)));
+      return ${decode};
     }
   `;
 }
@@ -217,24 +237,41 @@ function generateCachingRpcMethod(ctx, fileDesc, serviceDesc, methodDesc) {
  *
  * This lets clients pass in their own request-promise-ish client.
  *
+ * This also requires clientStreamingRequest, serverStreamingRequest and
+ * bidirectionalStreamingRequest methods if any of the RPCs is streaming.
+ *
  * We don't export this because if a project uses multiple `*.proto` files,
  * we don't want our the barrel imports in `index.ts` to have multiple `Rpc`
  * types.
  */
-function generateRpcType(ctx) {
+function generateRpcType(ctx, hasStreamingMethods) {
     const { options } = ctx;
     const maybeContext = options.context ? '<Context>' : '';
     const maybeContextParam = options.context ? 'ctx: Context,' : '';
-    return ts_poet_1.code `
-    interface Rpc${maybeContext} {
-      request(
+    const methods = [[ts_poet_1.code `request`, ts_poet_1.code `Uint8Array`, ts_poet_1.code `Promise<Uint8Array>`]];
+    if (hasStreamingMethods) {
+        const observable = ts_poet_1.imp('Observable@rxjs');
+        methods.push([ts_poet_1.code `clientStreamingRequest`, ts_poet_1.code `${observable}<Uint8Array>`, ts_poet_1.code `Promise<Uint8Array>`]);
+        methods.push([ts_poet_1.code `serverStreamingRequest`, ts_poet_1.code `Uint8Array`, ts_poet_1.code `${observable}<Uint8Array>`]);
+        methods.push([
+            ts_poet_1.code `bidirectionalStreamingRequest`,
+            ts_poet_1.code `${observable}<Uint8Array>`,
+            ts_poet_1.code `${observable}<Uint8Array>`,
+        ]);
+    }
+    const chunks = [];
+    chunks.push(ts_poet_1.code `    interface Rpc${maybeContext} {`);
+    methods.forEach((method) => {
+        chunks.push(ts_poet_1.code `
+      ${method[0]}(
         ${maybeContextParam}
         service: string,
         method: string,
-        data: Uint8Array
-      ): Promise<Uint8Array>;
-    }
-  `;
+        data: ${method[1]}
+      ): ${method[2]};`);
+    });
+    chunks.push(ts_poet_1.code `    }`);
+    return ts_poet_1.joinCode(chunks, { on: '\n' });
 }
 exports.generateRpcType = generateRpcType;
 function generateDataLoadersType() {

package/build/main.js

@@ -91,6 +91,7 @@ function generateFile(ctx, fileDesc) {
             }
         }, options);
     }
+    let hasServerStreamingMethods = false;
     let hasStreamingMethods = false;
     visit_1.visitServices(fileDesc, sourceInfo, (serviceDesc, sInfo) => {
         if (options.nestJs) {
@@ -126,18 +127,23 @@ function generateFile(ctx, fileDesc) {
                 serviceDesc.method.forEach((method) => {
                     chunks.push(generate_grpc_web_1.generateGrpcMethodDesc(ctx, serviceDesc, method));
                     if (method.serverStreaming) {
-                        hasStreamingMethods = true;
+                        hasServerStreamingMethods = true;
                     }
                 });
             }
         }
+        serviceDesc.method.forEach((methodDesc, index) => {
+            if (methodDesc.serverStreaming || methodDesc.clientStreaming) {
+                hasStreamingMethods = true;
+            }
+        });
     });
     if (options.outputServices === options_1.ServiceOption.DEFAULT && options.outputClientImpl && fileDesc.service.length > 0) {
         if (options.outputClientImpl === true) {
-            chunks.push(generate_services_1.generateRpcType(ctx));
+            chunks.push(generate_services_1.generateRpcType(ctx, hasStreamingMethods));
         }
         else if (options.outputClientImpl === 'grpc-web') {
-            chunks.push(generate_grpc_web_1.addGrpcWebMisc(ctx, hasStreamingMethods));
+            chunks.push(generate_grpc_web_1.addGrpcWebMisc(ctx, hasServerStreamingMethods));
         }
     }
     if (options.context) {

package/build/types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.detectBatchMethod = exports.responseObservable = exports.responsePromise = exports.responseType = exports.requestType = exports.detectMapType = exports.toTypeName = exports.getEnumMethod = exports.messageToTypeName = exports.wrapperTypeName = exports.valueTypeName = exports.isEmptyType = exports.isLongValueType = exports.isBytesValueType = exports.isValueType = exports.isTimestamp = exports.isMapType = exports.isLong = exports.isRepeated = exports.isWithinOneOfThatShouldBeUnion = exports.isWithinOneOf = exports.isEnum = exports.isMessage = exports.isBytes = exports.isPrimitive = exports.isScalar = exports.createTypeMap = exports.notDefaultCheck = exports.defaultValue = exports.packedType = exports.toReaderCall = exports.basicTypeName = exports.basicLongWireType = exports.basicWireType = void 0;
+exports.detectBatchMethod = exports.responsePromiseOrObservable = exports.responseObservable = exports.responsePromise = exports.responseType = exports.requestType = exports.rawRequestType = exports.detectMapType = exports.toTypeName = exports.getEnumMethod = exports.messageToTypeName = exports.wrapperTypeName = exports.valueTypeName = exports.isEmptyType = exports.isLongValueType = exports.isBytesValueType = exports.isValueType = exports.isTimestamp = exports.isMapType = exports.isLong = exports.isRepeated = exports.isWithinOneOfThatShouldBeUnion = exports.isWithinOneOf = exports.isEnum = exports.isMessage = exports.isBytes = exports.isPrimitive = exports.isScalar = exports.createTypeMap = exports.notDefaultCheck = exports.defaultValue = exports.packedType = exports.toReaderCall = exports.basicTypeName = exports.basicLongWireType = exports.basicWireType = void 0;
 const ts_proto_descriptors_1 = require("ts-proto-descriptors");
 const ts_poet_1 = require("ts-poet");
 const options_1 = require("./options");
@@ -512,8 +512,12 @@ function detectMapType(ctx, messageDesc, fieldDesc) {
     return undefined;
 }
 exports.detectMapType = detectMapType;
+function rawRequestType(ctx, methodDesc) {
+    return messageToTypeName(ctx, methodDesc.inputType);
+}
+exports.rawRequestType = rawRequestType;
 function requestType(ctx, methodDesc) {
-    let typeName = messageToTypeName(ctx, methodDesc.inputType);
+    let typeName = rawRequestType(ctx, methodDesc);
     if (methodDesc.clientStreaming) {
         return ts_poet_1.code `${ts_poet_1.imp('Observable@rxjs')}<${typeName}>`;
     }
@@ -532,6 +536,14 @@ function responseObservable(ctx, methodDesc) {
     return ts_poet_1.code `${ts_poet_1.imp('Observable@rxjs')}<${responseType(ctx, methodDesc)}>`;
 }
 exports.responseObservable = responseObservable;
+function responsePromiseOrObservable(ctx, methodDesc) {
+    const { options } = ctx;
+    if (options.returnObservable || methodDesc.serverStreaming) {
+        return responseObservable(ctx, methodDesc);
+    }
+    return responsePromise(ctx, methodDesc);
+}
+exports.responsePromiseOrObservable = responsePromiseOrObservable;
 function detectBatchMethod(ctx, fileDesc, serviceDesc, methodDesc) {
     const { typeMap } = ctx;
     const nameMatches = methodDesc.name.startsWith('Batch');

package/package.json

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