@juzi/wechaty-grpc 1.0.16 → 1.0.18

package/dist/cjs/out/wechaty/puppet_pb_service.js

@@ -13,6 +13,7 @@ var wechaty_puppet_room_invitation_pb = require("../wechaty/puppet/room-invitati
 var wechaty_puppet_room_member_pb = require("../wechaty/puppet/room-member_pb");
 var wechaty_puppet_room_pb = require("../wechaty/puppet/room_pb");
 var wechaty_puppet_tag_pb = require("../wechaty/puppet/tag_pb");
+var wechaty_puppet_moment_pb = require("../wechaty/puppet/moment_pb");
 var grpc = require("@improbable-eng/grpc-web").grpc;
 
 var Puppet = (function () {
@@ -669,6 +670,69 @@ Puppet.TagTagContactList = {
   responseType: wechaty_puppet_tag_pb.TagTagContactListResponse
 };
 
+Puppet.momentPublish = {
+  methodName: "momentPublish",
+  service: Puppet,
+  requestStream: false,
+  responseStream: false,
+  requestType: wechaty_puppet_moment_pb.MomentPublishRequest,
+  responseType: wechaty_puppet_moment_pb.MomentPublishResponse
+};
+
+Puppet.momentComment = {
+  methodName: "momentComment",
+  service: Puppet,
+  requestStream: false,
+  responseStream: false,
+  requestType: wechaty_puppet_moment_pb.MomentCommentRequest,
+  responseType: wechaty_puppet_moment_pb.MomentCommentResponse
+};
+
+Puppet.momentLike = {
+  methodName: "momentLike",
+  service: Puppet,
+  requestStream: false,
+  responseStream: false,
+  requestType: wechaty_puppet_moment_pb.MomentLikeRequest,
+  responseType: wechaty_puppet_moment_pb.MomentLikeResponse
+};
+
+Puppet.momentSignature = {
+  methodName: "momentSignature",
+  service: Puppet,
+  requestStream: false,
+  responseStream: false,
+  requestType: wechaty_puppet_moment_pb.MomentSignatureRequest,
+  responseType: wechaty_puppet_moment_pb.MomentSignatureResponse
+};
+
+Puppet.momentCoverage = {
+  methodName: "momentCoverage",
+  service: Puppet,
+  requestStream: false,
+  responseStream: false,
+  requestType: wechaty_puppet_moment_pb.MomentCoverageRequest,
+  responseType: wechaty_puppet_moment_pb.MomentCoverageResponse
+};
+
+Puppet.momentPayload = {
+  methodName: "momentPayload",
+  service: Puppet,
+  requestStream: false,
+  responseStream: false,
+  requestType: wechaty_puppet_moment_pb.MomentPayloadRequest,
+  responseType: wechaty_puppet_moment_pb.MomentPayloadResponse
+};
+
+Puppet.momentPayloadSayable = {
+  methodName: "momentPayloadSayable",
+  service: Puppet,
+  requestStream: false,
+  responseStream: false,
+  requestType: wechaty_puppet_moment_pb.MomentPayloadSayableRequest,
+  responseType: wechaty_puppet_moment_pb.MomentPayloadSayableResponse
+};
+
 Puppet.Download = {
   methodName: "Download",
   service: Puppet,
@@ -2960,6 +3024,223 @@ PuppetClient.prototype.tagTagContactList = function tagTagContactList(requestMes
   };
 };
 
+PuppetClient.prototype.momentPublish = function momentPublish(requestMessage, metadata, callback) {
+  if (arguments.length === 2) {
+    callback = arguments[1];
+  }
+  var client = grpc.unary(Puppet.momentPublish, {
+    request: requestMessage,
+    host: this.serviceHost,
+    metadata: metadata,
+    transport: this.options.transport,
+    debug: this.options.debug,
+    onEnd: function (response) {
+      if (callback) {
+        if (response.status !== grpc.Code.OK) {
+          var err = new Error(response.statusMessage);
+          err.code = response.status;
+          err.metadata = response.trailers;
+          callback(err, null);
+        } else {
+          callback(null, response.message);
+        }
+      }
+    }
+  });
+  return {
+    cancel: function () {
+      callback = null;
+      client.close();
+    }
+  };
+};
+
+PuppetClient.prototype.momentComment = function momentComment(requestMessage, metadata, callback) {
+  if (arguments.length === 2) {
+    callback = arguments[1];
+  }
+  var client = grpc.unary(Puppet.momentComment, {
+    request: requestMessage,
+    host: this.serviceHost,
+    metadata: metadata,
+    transport: this.options.transport,
+    debug: this.options.debug,
+    onEnd: function (response) {
+      if (callback) {
+        if (response.status !== grpc.Code.OK) {
+          var err = new Error(response.statusMessage);
+          err.code = response.status;
+          err.metadata = response.trailers;
+          callback(err, null);
+        } else {
+          callback(null, response.message);
+        }
+      }
+    }
+  });
+  return {
+    cancel: function () {
+      callback = null;
+      client.close();
+    }
+  };
+};
+
+PuppetClient.prototype.momentLike = function momentLike(requestMessage, metadata, callback) {
+  if (arguments.length === 2) {
+    callback = arguments[1];
+  }
+  var client = grpc.unary(Puppet.momentLike, {
+    request: requestMessage,
+    host: this.serviceHost,
+    metadata: metadata,
+    transport: this.options.transport,
+    debug: this.options.debug,
+    onEnd: function (response) {
+      if (callback) {
+        if (response.status !== grpc.Code.OK) {
+          var err = new Error(response.statusMessage);
+          err.code = response.status;
+          err.metadata = response.trailers;
+          callback(err, null);
+        } else {
+          callback(null, response.message);
+        }
+      }
+    }
+  });
+  return {
+    cancel: function () {
+      callback = null;
+      client.close();
+    }
+  };
+};
+
+PuppetClient.prototype.momentSignature = function momentSignature(requestMessage, metadata, callback) {
+  if (arguments.length === 2) {
+    callback = arguments[1];
+  }
+  var client = grpc.unary(Puppet.momentSignature, {
+    request: requestMessage,
+    host: this.serviceHost,
+    metadata: metadata,
+    transport: this.options.transport,
+    debug: this.options.debug,
+    onEnd: function (response) {
+      if (callback) {
+        if (response.status !== grpc.Code.OK) {
+          var err = new Error(response.statusMessage);
+          err.code = response.status;
+          err.metadata = response.trailers;
+          callback(err, null);
+        } else {
+          callback(null, response.message);
+        }
+      }
+    }
+  });
+  return {
+    cancel: function () {
+      callback = null;
+      client.close();
+    }
+  };
+};
+
+PuppetClient.prototype.momentCoverage = function momentCoverage(requestMessage, metadata, callback) {
+  if (arguments.length === 2) {
+    callback = arguments[1];
+  }
+  var client = grpc.unary(Puppet.momentCoverage, {
+    request: requestMessage,
+    host: this.serviceHost,
+    metadata: metadata,
+    transport: this.options.transport,
+    debug: this.options.debug,
+    onEnd: function (response) {
+      if (callback) {
+        if (response.status !== grpc.Code.OK) {
+          var err = new Error(response.statusMessage);
+          err.code = response.status;
+          err.metadata = response.trailers;
+          callback(err, null);
+        } else {
+          callback(null, response.message);
+        }
+      }
+    }
+  });
+  return {
+    cancel: function () {
+      callback = null;
+      client.close();
+    }
+  };
+};
+
+PuppetClient.prototype.momentPayload = function momentPayload(requestMessage, metadata, callback) {
+  if (arguments.length === 2) {
+    callback = arguments[1];
+  }
+  var client = grpc.unary(Puppet.momentPayload, {
+    request: requestMessage,
+    host: this.serviceHost,
+    metadata: metadata,
+    transport: this.options.transport,
+    debug: this.options.debug,
+    onEnd: function (response) {
+      if (callback) {
+        if (response.status !== grpc.Code.OK) {
+          var err = new Error(response.statusMessage);
+          err.code = response.status;
+          err.metadata = response.trailers;
+          callback(err, null);
+        } else {
+          callback(null, response.message);
+        }
+      }
+    }
+  });
+  return {
+    cancel: function () {
+      callback = null;
+      client.close();
+    }
+  };
+};
+
+PuppetClient.prototype.momentPayloadSayable = function momentPayloadSayable(requestMessage, metadata, callback) {
+  if (arguments.length === 2) {
+    callback = arguments[1];
+  }
+  var client = grpc.unary(Puppet.momentPayloadSayable, {
+    request: requestMessage,
+    host: this.serviceHost,
+    metadata: metadata,
+    transport: this.options.transport,
+    debug: this.options.debug,
+    onEnd: function (response) {
+      if (callback) {
+        if (response.status !== grpc.Code.OK) {
+          var err = new Error(response.statusMessage);
+          err.code = response.status;
+          err.metadata = response.trailers;
+          callback(err, null);
+        } else {
+          callback(null, response.message);
+        }
+      }
+    }
+  });
+  return {
+    cancel: function () {
+      callback = null;
+      client.close();
+    }
+  };
+};
+
 PuppetClient.prototype.download = function download(requestMessage, metadata) {
   var listeners = {
     data: [],

package/dist/cjs/proto/wechaty/puppet/channel.proto

@@ -6,12 +6,12 @@ option java_package     = "io.github.wechaty.grpc.puppet";
 option csharp_namespace = "github.wechaty.grpc.puppet";
 
 message ChannelPayload {
-  string avatar    = 1;
-  string cover_url = 2;
-  string desc      = 3;
-  string extras    = 4;
-  int32  feed_type = 5;
-  string nickname  = 6;
-  string thumb_url = 7;
-  string url       = 8;
+  string avatar    = 1; // 头像
+  string cover_url = 2; // 封面地址
+  string desc      = 3; // 描述
+  string extras    = 4; // 额外信息，暂不明确含义，但传错会导致无法发出（红色感叹号）。应根据收到的视频号的extras字段填入。
+  int32  feed_type = 5; // 暂不明确含义，目前请固定传4
+  string nickname  = 6; // 用户名
+  string thumb_url = 7; // 缩略图地址
+  string url       = 8; // 视频号地址
 }

package/dist/cjs/proto/wechaty/puppet/contact.proto

@@ -7,17 +7,17 @@ option csharp_namespace = "github.wechaty.grpc.puppet";
 
 import "google/protobuf/wrappers.proto";
 
-enum ContactGender {
-  CONTACT_GENDER_UNSPECIFIED = 0;
-  CONTACT_GENDER_MALE        = 1;
-  CONTACT_GENDER_FEMALE      = 2;
+enum ContactGender { // 性别枚举
+  CONTACT_GENDER_UNSPECIFIED = 0; // 不明确
+  CONTACT_GENDER_MALE        = 1; // 男
+  CONTACT_GENDER_FEMALE      = 2; // 女
 }
 
-enum ContactType {
-  CONTACT_TYPE_UNSPECIFIED = 0;
-  CONTACT_TYPE_PERSONAL    = 1;
-  CONTACT_TYPE_OFFICIAL    = 2;
-  CONTACT_TYPE_CORPORATION = 3;
+enum ContactType { // 类型枚举
+  CONTACT_TYPE_UNSPECIFIED = 0; // 不明确
+  CONTACT_TYPE_PERSONAL    = 1; // 个微联系人
+  CONTACT_TYPE_OFFICIAL    = 2; // 公众号
+  CONTACT_TYPE_CORPORATION = 3; // 企微联系人
 }
 
 message ContactListRequest {}
@@ -30,17 +30,17 @@ message ContactPayloadRequest {
 }
 message ContactPayloadResponse {
   string        id        = 1;
-  ContactGender gender    = 2;
-  ContactType   type      = 3;
-  string        name      = 4;
-  string        avatar    = 5;
-  string        address   = 6;
-  string        alias     = 7;
-  string        city      = 8;
-  bool          friend    = 9;
-  string        province  = 10;
-  string        signature = 11;
-  bool          star      = 12;
+  ContactGender gender    = 2; // 性别
+  ContactType   type      = 3; // 类型
+  string        name      = 4; // 姓名
+  string        avatar    = 5; // 头像
+  string        address   = 6; // 地址
+  string        alias     = 7; // 别名，即备注
+  string        city      = 8; // 城市
+  bool          friend    = 9; // 是否为好友
+  string        province  = 10;// 省份
+  string        signature = 11;// 签名
+  bool          star      = 12;// 是否为特别好友
   /**
    * Huan(202203): in gRPC, we can freely rename the field name as long as the number keep consistent.
    *  so we can just rename `weixin` to `handle` here.
@@ -52,15 +52,15 @@ message ContactPayloadResponse {
    *
    * TODO: rename `weixin` to `handle` in v2.0.0
    */
-  string   weixin          = 13;
-  string   corporation     = 14;
-  string   title           = 15;
-  string   description     = 16;
-  bool     coworker        = 17;
-  repeated string phones   = 18;
-  string   additional_info = 19;
-
-  repeated string tag_ids = 20;
+  string   weixin          = 13;// IM专属id，在企微环境中特指weixinId
+  string   corporation     = 14;// 企业
+  string   title           = 15;// 头衔
+  string   description     = 16;// 描述
+  bool     coworker        = 17;// 是否为同事
+  repeated string phones   = 18;// 电话号码，企微中最多5个
+  string   additional_info = 19;// 额外信息，是由JS对象stringify得到的字符串，目前支持的内容包含addContactTime、corpId等。
+
+  repeated string tag_ids = 20; // 标签（的id）
 }
 
 message ContactSelfQRCodeRequest {}

package/dist/cjs/proto/wechaty/puppet/friendship.proto

@@ -8,16 +8,16 @@ option csharp_namespace = "github.wechaty.grpc.puppet";
 import "google/protobuf/wrappers.proto";
 import "wechaty/puppet/referrer.proto";
 
-enum FriendshipType {
-  FRIENDSHIP_TYPE_UNSPECIFIED = 0;
-  FRIENDSHIP_TYPE_CONFIRM     = 1;
-  FRIENDSHIP_TYPE_RECEIVE     = 2;
-  FRIENDSHIP_TYPE_VERIFY      = 3;
-  FRIENDSHIP_TYPE_DELETE      = 4;
-  FRIENDSHIP_TYPE_REMOVED     = 5;
+enum FriendshipType { // 事件类型
+  FRIENDSHIP_TYPE_UNSPECIFIED = 0; // 不明确
+  FRIENDSHIP_TYPE_CONFIRM     = 1; // 确认——双方互加后触发
+  FRIENDSHIP_TYPE_RECEIVE     = 2; // 收到——收到好友请求后触发
+  FRIENDSHIP_TYPE_VERIFY      = 3; // 验证——主动加他人为好友时触发，wxwork里暂无此事件
+  FRIENDSHIP_TYPE_DELETE      = 4; // 删除——主动删除好友时触发
+  FRIENDSHIP_TYPE_REMOVED     = 5; // 被删除——被他人删除好友时触发
 }
 
-enum FriendshipSceneType {
+enum FriendshipSceneType { // 事件场景 wxwork中未使用
   FRIENDSHIP_SCENE_TYPE_UNSPECIFIED = 0;
 
   FRIENDSHIP_SCENE_TYPE_QQ       = 1;
@@ -45,12 +45,12 @@ message FriendshipPayloadRequest {
 }
 message FriendshipPayloadResponse {
   string              id         = 1;
-  string              contact_id = 2;
-  string              hello      = 3;
-  FriendshipType      type       = 4;
-  string              stranger   = 5;
-  string              ticket     = 6;
-  FriendshipSceneType scene      = 7;
+  string              contact_id = 2; // 加好友的联系人id
+  string              hello      = 3; // 加好友的打招呼消息
+  FriendshipType      type       = 4; // 好友事件类型
+  string              stranger   = 5; // 不明确含义，wxwork中未使用
+  string              ticket     = 6; // 个微遗留字段，wxwork中会传corp_id
+  FriendshipSceneType scene      = 7; // 加好友的场景（例如通过名片添加、通过群添加等），wxwork未使用
 }
 
 message FriendshipSearchPhoneRequest {

package/dist/cjs/proto/wechaty/puppet/location.proto

@@ -6,9 +6,9 @@ option java_package     = "io.github.wechaty.grpc.puppet";
 option csharp_namespace = "github.wechaty.grpc.puppet";
 
 message LocationPayload {
-  float  accuracy  = 1;
-  string address   = 2;
-  double latitude  = 3;
-  double longitude = 4;
-  string name      = 5;
+  float  accuracy  = 1; // 精确度，默认为15
+  string address   = 2; // 地址，xx省xx市xx区xx路xx号
+  double latitude  = 3; // 纬度，北纬为正
+  double longitude = 4; // 经度，东经为正
+  string name      = 5; // 地址名，例如xx大厦
 }

package/dist/cjs/proto/wechaty/puppet/message.proto

@@ -20,28 +20,27 @@ import "wechaty/puppet/mini-program.proto";
 import "wechaty/puppet/url-link.proto";
 import "wechaty/puppet/channel.proto";
 
-
-enum MessageType {
+enum MessageType { // 消息类型
   MESSAGE_TYPE_UNSPECIFIED  = 0;
 
-  MESSAGE_TYPE_ATTACHMENT   = 1;
-  MESSAGE_TYPE_AUDIO        = 2;
-  MESSAGE_TYPE_CONTACT      = 3;
-  MESSAGE_TYPE_CHAT_HISTORY = 4;
-  MESSAGE_TYPE_EMOTCION     = 5;
-  MESSAGE_TYPE_IMAGE        = 6;
-  MESSAGE_TYPE_TEXT         = 7;
-  MESSAGE_TYPE_LOCATION     = 8;
-  MESSAGE_TYPE_MINI_PROGRAM = 9;
-  MESSAGE_TYPE_GROUP_NOTE   = 10;
-  MESSAGE_TYPE_TRANSFER     = 11;
-  MESSAGE_TYPE_RED_ENVELOPE = 12;
-  MESSAGE_TYPE_RECALLED     = 13;
-  MESSAGE_TYPE_URL          = 14;
-  MESSAGE_TYPE_VIDEO        = 15;
-  MESSAGE_TYPE_POST         = 16;
-  MESSAGE_TYPE_CHANNEL      = 17;
-  MESSAGE_TYPE_SYSTEM       = 18;
+  MESSAGE_TYPE_ATTACHMENT   = 1; // 文件消息
+  MESSAGE_TYPE_AUDIO        = 2; // 音频
+  MESSAGE_TYPE_CONTACT      = 3; // 名片
+  MESSAGE_TYPE_CHAT_HISTORY = 4; // 聊天记录，wxwork暂不支持
+  MESSAGE_TYPE_EMOTCION     = 5; // 表情
+  MESSAGE_TYPE_IMAGE        = 6; // 图片
+  MESSAGE_TYPE_TEXT         = 7; // 文本
+  MESSAGE_TYPE_LOCATION     = 8; // 地址
+  MESSAGE_TYPE_MINI_PROGRAM = 9; // 小程序
+  MESSAGE_TYPE_GROUP_NOTE   = 10;// 群接龙消息，wxwork中没有
+  MESSAGE_TYPE_TRANSFER     = 11;// 转账，wxwork中没有
+  MESSAGE_TYPE_RED_ENVELOPE = 12;// 红包，wxwork中没有
+  MESSAGE_TYPE_RECALLED     = 13;// 撤回
+  MESSAGE_TYPE_URL          = 14;// 链接
+  MESSAGE_TYPE_VIDEO        = 15;// 视频
+  MESSAGE_TYPE_POST         = 16;// 特殊的复合类型，wxwork中没有
+  MESSAGE_TYPE_CHANNEL      = 17;// 视频号
+  MESSAGE_TYPE_SYSTEM       = 18;// 系统消息
 }
 
 message MessagePayloadRequest {
@@ -49,25 +48,25 @@ message MessagePayloadRequest {
 }
 message MessagePayloadResponse {
   string      id                 = 1;
-  string      filename           = 2;
-  string      text               = 3;
+  string      filename           = 2; // 文件名
+  string      text               = 3; // 文本内容
   /**
    * @deprecated will be removed after Dec 31, 2022
    *  Huan(202109): use receive_time(10) instead
    */
   uint64      timestamp_deprecated = 4 [deprecated = true];
-  MessageType type               = 5;
-  string      talker_id          = 6;
-  string      room_id            = 7;
-  string      listener_id        = 8;
-  repeated    string mention_ids = 9;
-  google.protobuf.Timestamp receive_time = 10;
-  optional string quote_id       = 11;
+  MessageType type               = 5; // 类型
+  string      talker_id          = 6; // 发送者id
+  string      room_id            = 7; // 群聊id
+  string      listener_id        = 8; // 接受者id
+  repeated    string mention_ids = 9; // 群消息@人的id列表
+  google.protobuf.Timestamp receive_time = 10; // 收到消息时间
+  optional string quote_id       = 11; // 被引用的消息id
 }
 
 message MessageImageRequest {
   string    id   = 1;
-  ImageType type = 2;
+  ImageType type = 2; // 获取图片的类型（缩略图、原图）
 }
 message MessageImageResponse {
    string file_box = 1;
@@ -133,8 +132,8 @@ message MessageSendContactResponse {
 }
 
 message MessageSendFileRequest {
-  string conversation_id = 1;
-  string file_box = 2;
+  string conversation_id = 1; // 对话id
+  string file_box = 2; // 发送文件的fileBox.toJSON()
 }
 message MessageSendFileResponse {
   /**
@@ -146,11 +145,11 @@ message MessageSendFileResponse {
   string id = 2;
 }
 
-message MessageSendTextRequest {
-  string conversation_id = 1;
-  string text = 2;
-  repeated string mentional_ids = 3;
-  optional string quote_id = 4;
+message MessageSendTextRequest { // 发文本消息
+  string conversation_id = 1; // 对话id
+  string text = 2; // 文本内容
+  repeated string mentional_ids = 3; // @人id列表
+  optional string quote_id = 4; // 引用消息的id
 }
 message MessageSendTextResponse {
   /**
@@ -163,13 +162,13 @@ message MessageSendTextResponse {
 }
 
 message MessageSendMiniProgramRequest {
-  string conversation_id = 1;
+  string conversation_id = 1; // 对话id
   /**
    * Huan(202110): We should use payload instead of JSON.stringify string
    *  The compatible code will be removed after Dec 31, 2022
    */
   string mini_program_deprecated = 2 [deprecated = true]; // deprecated after Sep 31, 2021, remove compatible code after Dec 31, 2022
-  MiniProgramPayload mini_program = 3;
+  MiniProgramPayload mini_program = 3; // 小程序payload
 }
 message MessageSendMiniProgramResponse {
   /**
@@ -182,13 +181,13 @@ message MessageSendMiniProgramResponse {
 }
 
 message MessageSendUrlRequest {
-  string conversation_id = 1;
+  string conversation_id = 1; // 对话id
   /**
    * Huan(202110): We should use payload instead of JSON.stringify string
    *  The compatible code will be removed after Dec 31, 2022
    */
   string url_link_deprecated = 2 [deprecated = true]; // deprecated after Sep 31, 2021, remove compatible code after Dec 31, 2022
-  UrlLinkPayload url_link = 3;
+  UrlLinkPayload url_link = 3; // 链接payload
 }
 message MessageSendUrlResponse {
   /**
@@ -207,8 +206,8 @@ message MessageRecallResponse {
   bool success = 1;
 }
 message MessageForwardRequest{
-  string message_id = 1;
-  string conversation_id = 2;
+  string message_id = 1; // 要转发的消息id
+  string conversation_id = 2; // 对话id
 }
 message MessageForwardResponse {
   /**

package/dist/cjs/proto/wechaty/puppet/mini-program.proto

@@ -6,13 +6,13 @@ option java_package     = "io.github.wechaty.grpc.puppet";
 option csharp_namespace = "github.wechaty.grpc.puppet";
 
 message MiniProgramPayload {
-  string appid       = 1;
-  string description = 2;
-  string page_path   = 3;
-  string icon_url    = 4;
-  string share_id    = 5;
-  string thumb_url   = 6;
-  string title       = 7;
-  string username    = 8;
-  string thumb_key   = 9;
+  string appid       = 1; // appId，形式如wx4ff94de0d8038c25
+  string description = 2; // 描述(副标题)
+  string page_path   = 3; // 访问路径
+  string icon_url    = 4; // 图标路径
+  string share_id    = 5; // 发送小程序的用户id，可不填
+  string thumb_url   = 6; // 缩略图路径
+  string title       = 7; // 标题
+  string username    = 8; // 关联公众号id，形式gh_69105b80ea75@app
+  string thumb_key   = 9; // 缩略图的key，可不填
 }