Improve stream message (#95)

* improve stream message definition

* 0.18.4

* change names

* wip...

* normalize name

* 0.18.5

* normalize name

* 0.18.6

* rename request & responses for more robust

* clean name

* 0.18.7

Co-authored-by: Huan LI (李卓桓) <[email protected]>

Author: windmemory

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chatie/grpc",
-  "version": "0.18.3",
+  "version": "0.18.7",
   "description": "gRPC for Chatie",
   "main": "dist/src/index.js",
   "typings": "dist/src/index.d.js",

proto/wechaty/puppet.proto

@@ -19,6 +19,7 @@ option go_package="github.com/wechaty/go-grpc/wechaty";
 import public "puppet/base.proto";
 import public "puppet/contact.proto";
 import public "puppet/event.proto";
+import public "puppet/filebox.proto";
 import public "puppet/friendship.proto";
 import public "puppet/message.proto";
 import public "puppet/room.proto";
@@ -90,22 +91,33 @@ service Puppet {
    * Message
    *
    */
-  rpc MessagePayload (puppet.MessagePayloadRequest)  returns (puppet.MessagePayloadResponse) {}
 
-  rpc MessageContact (puppet.MessageContactRequest) returns (puppet.MessageContactResponse) {}
-  // @deprecated: using MessageFileStream to transfer files
+  /**
+   * @deprecated: using MessageFileStream to transfer files
+   * Huan(202010): will be removed (replaced by MessageFileStream) after Dec 31, 2021
+   */
   rpc MessageFile (puppet.MessageFileRequest) returns (puppet.MessageFileResponse) {}
-  rpc MessageFileStream (puppet.MessageFileStreamRequest) returns (stream puppet.FileBoxChunk) {}
-  // @deprecated: using MessageImageStream to transfer images
+  /**
+   * @deprecated: using MessageImageStream to transfer images
+   * Huan(202010): will be removed (replaced by MessageImageStream) after Dec 31, 2021
+   */
   rpc MessageImage (puppet.MessageImageRequest) returns (puppet.MessageImageResponse) {}
-  rpc MessageImageStream (puppet.MessageImageStreamRequest) returns (stream puppet.FileBoxChunk) {}
+  /**
+   * @deprecated: using MesageSendFileStream to transfer file message to server
+   * Huan(202010): will be removed (replaced by MessageSendFileStream) after Dec 31, 2021
+   */
+  rpc MessageSendFile (puppet.MessageSendFileRequest) returns (puppet.MessageSendFileResponse) {}
+
+  rpc MessagePayload (puppet.MessagePayloadRequest)  returns (puppet.MessagePayloadResponse) {}
+
+  rpc MessageContact (puppet.MessageContactRequest) returns (puppet.MessageContactResponse) {}
+  rpc MessageFileStream (puppet.MessageFileStreamRequest) returns (stream puppet.MessageFileStreamResponse) {}
+  rpc MessageImageStream (puppet.MessageImageStreamRequest) returns (stream puppet.MessageImageStreamResponse) {}
   rpc MessageMiniProgram (puppet.MessageMiniProgramRequest) returns (puppet.MessageMiniProgramResponse) {}
   rpc MessageUrl (puppet.MessageUrlRequest) returns (puppet.MessageUrlResponse) {}
 
   rpc MessageSendContact (puppet.MessageSendContactRequest) returns (puppet.MessageSendContactResponse) {}
-  // @deprecated: using MesageSendFileStream to transfer file message to server
-  rpc MessageSendFile (puppet.MessageSendFileRequest) returns (puppet.MessageSendFileResponse) {}
-  rpc MessageSendFileStream (stream puppet.FileBoxChunk) returns (puppet.MessageSendFileStreamResponse) {}
+  rpc MessageSendFileStream (stream puppet.MessageSendFileStreamRequest) returns (puppet.MessageSendFileStreamResponse) {}
   rpc MessageSendText (puppet.MessageSendTextRequest) returns (puppet.MessageSendTextResponse) {}
   rpc MessageSendMiniProgram (puppet.MessageSendMiniProgramRequest) returns (puppet.MessageSendMiniProgramResponse) {}
   rpc MessageSendUrl (puppet.MessageSendUrlRequest) returns (puppet.MessageSendUrlResponse) {}

proto/wechaty/puppet/filebox.proto

@@ -0,0 +1,9 @@
+syntax = "proto3";
+package wechaty.puppet;
+
+message FileBoxChunk {
+  oneof payload {
+    bytes data = 1;
+    string name = 2;
+  }
+}

proto/wechaty/puppet/message.proto

@@ -7,6 +7,8 @@ option csharp_namespace = "github.wechaty.grpc.puppet";
 
 import "google/protobuf/wrappers.proto";
 
+import "puppet/filebox.proto";
+
 enum MessageType {
   MESSAGE_TYPE_UNSPECIFIED  = 0;
 
@@ -48,10 +50,6 @@ message MessagePayloadResponse {
   repeated    string mention_ids = 9;
 }
 
-message FileBoxChunk {
-  bytes data = 1;
-}
-
 message MessageImageRequest {
   string    id   = 1;
   ImageType type = 2;
@@ -64,6 +62,9 @@ message MessageImageStreamRequest {
   string id = 1;
   ImageType type = 2;
 }
+message MessageImageStreamResponse {
+  FileBoxChunk file_box_chunk = 1;
+}
 
 message MessageContactRequest {
   string id = 1;
@@ -82,6 +83,9 @@ message MessageFileResponse {
 message MessageFileStreamRequest {
   string id = 1;
 }
+message MessageFileStreamResponse {
+  FileBoxChunk file_box_chunk = 1;
+}
 
 message MessageMiniProgramRequest {
   string id = 1;
@@ -114,6 +118,12 @@ message MessageSendFileResponse {
   google.protobuf.StringValue id = 1;
 }
 
+message MessageSendFileStreamRequest {
+  oneof payload {
+    string conversation_id = 1;
+    FileBoxChunk file_box_chunk = 2;
+  };
+}
 message MessageSendFileStreamResponse {
   google.protobuf.StringValue id = 1;
 }