@juzi/wechaty-grpc 1.0.0

package/dist/cjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/dist/cjs/proto/wechaty/deprecated/file-box.proto

@@ -0,0 +1,61 @@
+/**
+ * Huan(202110): Deprecated
+ *  - use Puppet.Download / Puppet.Upload
+ *  - use DownloadResponse & UploadRequest to streaming chunks
+ *
+ * This file will be removed after Dec 31, 2022
+ */
+syntax = "proto3";
+package wechaty.puppet;
+
+option go_package       = "github.com/wechaty/go-grpc/wechaty/puppet";
+option csharp_namespace = "github.wechaty.grpc.puppet";
+
+import "google/protobuf/wrappers.proto";
+import "wechaty/puppet/image.proto";
+
+message FileBoxChunk {
+  /**
+   * Huan(202110): `oneof xxx {}` seems equal with `optional`?
+   *  to be confirmed.
+   */
+  // oneof payload {
+  optional bytes data  = 1;
+  optional string name = 2;
+  // }
+}
+
+message MessageImageStreamRequest {
+  string    id   = 1;
+  ImageType type = 2;
+}
+message MessageImageStreamResponse {
+  FileBoxChunk file_box_chunk = 1;
+}
+
+message MessageFileStreamRequest {
+  string id = 1;
+}
+message MessageFileStreamResponse {
+  FileBoxChunk file_box_chunk = 1;
+}
+
+message MessageSendFileStreamRequest {
+  /**
+   * Huan(202110): `oneof xxx {}` seems equal with `optional`?
+   *  to be confirmed.
+   */
+  // oneof payload {
+  optional string conversation_id      = 1;
+  optional FileBoxChunk file_box_chunk = 2;
+  // };
+}
+message MessageSendFileStreamResponse {
+  /**
+   * @deprecated:
+   *  Huan(202109): Wrapper types must not be used going forward.
+   *    https://cloud.google.com/apis/design/design_patterns#optional_primitive_fields
+   */
+  google.protobuf.StringValue id_string_value_deprecated = 1 [deprecated = true]; // Deprecated after Sep 31, 2021, will be removed after Dec 31, 2022
+  string id = 2;
+}

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

@@ -0,0 +1,46 @@
+syntax = "proto3";
+package wechaty.puppet;
+
+option go_package       = "github.com/wechaty/go-grpc/wechaty/puppet";
+option java_package     = "io.github.wechaty.grpc.puppet";
+option csharp_namespace = "github.wechaty.grpc.puppet";
+
+enum PayloadType {
+  PAYLOAD_TYPE_UNSPECIFIED = 0;
+  PAYLOAD_TYPE_MESSAGE     = 1;
+  PAYLOAD_TYPE_CONTACT     = 2;
+  PAYLOAD_TYPE_ROOM        = 3;
+  PAYLOAD_TYPE_ROOM_MEMBER = 4;
+  PAYLOAD_TYPE_FRIENDSHIP  = 5;
+}
+
+message StartRequest {}
+message StartResponse {}
+
+message StopRequest {}
+message StopResponse {}
+
+message VersionRequest {}
+message VersionResponse {
+  string version = 1;
+}
+
+message LogoutRequest {}
+message LogoutResponse {}
+
+message DingRequest {
+  string data = 1;
+}
+message DingResponse {
+  /**
+   * Ding has no return value
+   *  Puppet should emit a `ding` event when it receives a `ding()` call
+   */
+}
+
+message DirtyPayloadRequest {
+  PayloadType type = 1;
+  string id = 2;
+}
+
+message DirtyPayloadResponse {}

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

@@ -0,0 +1,122 @@
+syntax = "proto3";
+package wechaty.puppet;
+
+option go_package="github.com/wechaty/go-grpc/wechaty/puppet";
+option java_package="io.github.wechaty.grpc.puppet";
+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 ContactType {
+  CONTACT_TYPE_UNSPECIFIED = 0;
+  CONTACT_TYPE_PERSONAL    = 1;
+  CONTACT_TYPE_OFFICIAL    = 2;
+  CONTACT_TYPE_CORPORATION = 3;
+}
+
+message ContactListRequest {}
+message ContactListResponse {
+  repeated string ids = 1;
+}
+
+message ContactPayloadRequest {
+  string id = 1;
+}
+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;
+  /**
+   * 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.
+   *
+   * (Huan(20220329): use `weixin` for now, until we upgrade to v2.0
+   *  the `wechaty-grpc@1.0.0` will use the latest v1.x automatically when running `npm install`
+   *    which will causing a breaking change.
+   *  @link https://github.com/wechaty/getting-started/issues/254
+   *
+   * 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;
+}
+
+message ContactSelfQRCodeRequest {}
+message ContactSelfQRCodeResponse {
+  string qrcode = 1;
+}
+
+message ContactSelfNameRequest {
+  string name = 1;
+}
+message ContactSelfNameResponse {}
+
+message ContactSelfSignatureRequest {
+  string signature = 1;
+}
+message ContactSelfSignatureResponse {}
+
+message ContactAliasRequest {
+  string id = 1;
+  // nullable
+  google.protobuf.StringValue alias_string_value_deprecated = 2 [deprecated = true];  // DEPRECATED, will be removed after Dec 31, 2022
+  optional string alias = 3;
+}
+message ContactAliasResponse {
+  google.protobuf.StringValue alias_string_value_deprecated = 1 [deprecated = true];  // DEPRECATED, will be removed after Dec 31, 2022
+  string alias = 2;
+}
+
+message ContactAvatarRequest {
+  string id = 1;
+  google.protobuf.StringValue filebox_string_value_deprecated = 2 [deprecated = true];  // DEPRECATED, will be removed after Dec 31, 2022
+  optional string file_box = 3;
+}
+message ContactAvatarResponse {
+  google.protobuf.StringValue filebox_string_value_deprecated = 1 [deprecated = true];  // DEPRECATED, will be removed after Dec 31, 2022
+  string file_box = 2;
+}
+
+message ContactPhoneRequest {
+  string contact_id = 1;
+  repeated string phones = 2;
+}
+
+message ContactPhoneResponse {
+  repeated string phones = 2;
+}
+
+message ContactCorporationRemarkRequest {
+  string contact_id = 1;
+  google.protobuf.StringValue corporation_remark_string_value_deprecated = 2 [deprecated = true];  // DEPRECATED, will be removed after Dec 31, 2022
+  string corporation_remark = 3;
+}
+
+message ContactCorporationRemarkResponse {}
+
+message ContactDescriptionRequest {
+  string contact_id = 1;
+  google.protobuf.StringValue description_string_value_deprecated = 2 [deprecated = true];  // DEPRECATED, will be removed after Dec 31, 2022
+  string description = 3;
+}
+
+message ContactDescriptionResponse {}

package/dist/cjs/proto/wechaty/puppet/download-upload.proto

@@ -0,0 +1,19 @@
+syntax = "proto3";
+package wechaty.puppet;
+
+option go_package="github.com/wechaty/go-grpc/wechaty/puppet";
+option csharp_namespace = "github.wechaty.grpc.puppet";
+
+message UploadRequest {
+  bytes chunk = 1;
+}
+message UploadResponse {
+  string id = 1;
+}
+
+message DownloadRequest {
+  string id = 1;
+}
+message DownloadResponse {
+  bytes chunk = 1;
+}

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

@@ -0,0 +1,38 @@
+syntax = "proto3";
+package wechaty.puppet;
+
+option go_package="github.com/wechaty/go-grpc/wechaty/puppet";
+option java_package="io.github.wechaty.grpc.puppet";
+option csharp_namespace = "github.wechaty.grpc.puppet";
+
+enum EventType {
+  EVENT_TYPE_UNSPECIFIED = 0;
+
+  EVENT_TYPE_HEARTBEAT = 1;
+  EVENT_TYPE_MESSAGE   = 2;
+  EVENT_TYPE_DONG      = 3;
+  EVENT_TYPE_POST      = 4;
+
+  reserved 5 to 15;
+
+  EVENT_TYPE_ERROR       = 16;
+  EVENT_TYPE_FRIENDSHIP  = 17;
+  EVENT_TYPE_ROOM_INVITE = 18;
+  EVENT_TYPE_ROOM_JOIN   = 19;
+  EVENT_TYPE_ROOM_LEAVE  = 20;
+  EVENT_TYPE_ROOM_TOPIC  = 21;
+  EVENT_TYPE_SCAN        = 22;
+  EVENT_TYPE_READY       = 23;
+  EVENT_TYPE_RESET       = 24;
+  EVENT_TYPE_LOGIN       = 25;
+  EVENT_TYPE_LOGOUT      = 26;
+  EVENT_TYPE_DIRTY       = 27;
+}
+
+message EventRequest {}
+
+message EventResponse {
+  EventType type = 1;
+  // TODO: Huan(202002) consider to use a PB Map?
+  string payload = 2; // JSON.stringify({ ... })
+}

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

@@ -0,0 +1,106 @@
+syntax = "proto3";
+package wechaty.puppet;
+
+option go_package="github.com/wechaty/go-grpc/wechaty/puppet";
+option java_package="io.github.wechaty.grpc.puppet";
+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;
+}
+
+enum FriendshipSceneType {
+  FRIENDSHIP_SCENE_TYPE_UNSPECIFIED = 0;
+
+  FRIENDSHIP_SCENE_TYPE_QQ       = 1;
+  FRIENDSHIP_SCENE_TYPE_EMAIL    = 2;
+  FRIENDSHIP_SCENE_TYPE_WEIXIN   = 3;
+  FRIENDSHIP_SCENE_TYPE_QQTBD    = 12;
+  FRIENDSHIP_SCENE_TYPE_ROOM     = 14;
+  FRIENDSHIP_SCENE_TYPE_PHONE    = 15;
+  FRIENDSHIP_SCENE_TYPE_CARD     = 17;
+  FRIENDSHIP_SCENE_TYPE_LOCATION = 18;
+  FRIENDSHIP_SCENE_TYPE_BOTTLE   = 25;
+  FRIENDSHIP_SCENE_TYPE_SHAKING  = 29;
+  FRIENDSHIP_SCENE_TYPE_QRCODE   = 30;
+}
+
+message FriendshipPayloadRequest {
+  string                      id      = 1;
+  /**
+   * Huan(202003):
+   *  What's the reason we need belowing payload?
+   *  We should remove it if possible.
+   */
+  google.protobuf.StringValue payload_string_value_deprecated = 2 [deprecated = true];  // DEPRECATED, will be removed after Dec 31, 2022
+  string payload = 3;
+}
+message FriendshipPayloadResponse {
+  string              id         = 1;
+  string              contact_id = 2;
+  string              hello      = 3;
+  FriendshipType      type       = 4;
+  string              stranger   = 5;
+  string              ticket     = 6;
+  FriendshipSceneType scene      = 7;
+}
+
+message FriendshipSearchPhoneRequest {
+  string phone = 1;
+}
+message FriendshipSearchPhoneResponse {
+  // nullable
+  google.protobuf.StringValue contact_id_string_value_deprecated = 1 [deprecated = true];  // DEPRECATED, will be removed after Dec 31, 2022
+  string contact_id = 2;
+}
+
+/**
+ * Huan(202003): we just rename the payload message because gRPC only care about the message structure
+ *  (and as long as we keep consistent with the old structure).
+ *
+ *  @link https://github.com/wechaty/grpc/pull/173
+ *
+ * Rename:
+ *  1. `FriendshipSearchWeixinRequest`    -> `FriendshipSearchHandleRequest`
+ *  2. `FriendshipSearchWeixinReqsponse`  -> `FriendshipSearchHandleResponse`
+ */
+message FriendshipSearchHandleRequest {
+  /**
+   * 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.
+   *
+   * (Huan(20220329): use `weixin` for now, until we upgrade to v2.0
+   *  the `wechaty-grpc@1.0.0` will use the latest v1.x automatically when running `npm install`
+   *    which will causing a breaking change.
+   *  @link https://github.com/wechaty/getting-started/issues/254
+   *
+   * TODO: rename `weixin` to `handle` in v2.0.0
+   */
+  string weixin = 1;
+}
+message FriendshipSearchHandleResponse {
+  // nullable
+  google.protobuf.StringValue contact_id_string_value_deprecated = 1 [deprecated = true];  // DEPRECATED, will be removed after Dec 31, 2022
+  string contact_id = 2;
+}
+
+message FriendshipAddRequest {
+  string contact_id = 1;
+  string hello = 2;
+  google.protobuf.StringValue source_room_id_string_value_deprecated = 3 [deprecated = true]; // Deprecated: will be removed after Dec 31, 2022
+  google.protobuf.StringValue source_contact_id_string_value_deprecated = 4 [deprecated = true];  // Deprecated: will be removed after Dec 31, 2022
+  Referrer referrer = 5;
+}
+
+message FriendshipAddResponse {}
+
+message FriendshipAcceptRequest {
+  string id = 1;
+}
+message FriendshipAcceptResponse {}

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

@@ -0,0 +1,13 @@
+syntax = "proto3";
+package wechaty.puppet;
+
+option go_package="github.com/wechaty/go-grpc/wechaty/puppet";
+option java_package="io.github.wechaty.grpc.puppet";
+option csharp_namespace = "github.wechaty.grpc.puppet";
+
+enum ImageType {
+  IMAGE_TYPE_UNSPECIFIED = 0;
+  IMAGE_TYPE_THUMBNAIL   = 1;
+  IMAGE_TYPE_HD          = 2;
+  IMAGE_TYPE_ARTWORK     = 3;
+}

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

@@ -0,0 +1,14 @@
+syntax = "proto3";
+package wechaty.puppet;
+
+option go_package       = "github.com/wechaty/go-grpc/wechaty/puppet";
+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;
+}

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

@@ -0,0 +1,230 @@
+syntax = "proto3";
+package wechaty.puppet;
+
+option go_package="github.com/wechaty/go-grpc/wechaty/puppet";
+option java_package="io.github.wechaty.grpc.puppet";
+option csharp_namespace = "github.wechaty.grpc.puppet";
+
+import "google/protobuf/timestamp.proto";
+
+/**
+ * @deprecated
+ *  Huan(202109): will be removed after Dec 31, 2022
+ *    https://cloud.google.com/apis/design/design_patterns#optional_primitive_fields
+ */
+import "google/protobuf/wrappers.proto";
+
+import "wechaty/puppet/image.proto";
+import "wechaty/puppet/location.proto";
+import "wechaty/puppet/mini-program.proto";
+import "wechaty/puppet/url-link.proto";
+
+enum MessageType {
+  MESSAGE_TYPE_UNSPECIFIED  = 0;
+
+  MESSAGE_TYPE_ATTACHMENT   = 1;
+  MESSAGE_TYPE_AUDIO        = 2;
+  MESSAGE_TYPE_CONTACT      = 3;
+  MESSAGE_TYPE_EMOTICON     = 4;
+  MESSAGE_TYPE_IMAGE        = 5;
+  MESSAGE_TYPE_TEXT         = 6;
+  MESSAGE_TYPE_VIDEO        = 7;
+  MESSAGE_TYPE_CHAT_HISTORY = 8;
+  MESSAGE_TYPE_LOCATION     = 9;
+  MESSAGE_TYPE_MINI_PROGRAM = 10;
+  MESSAGE_TYPE_TRANSFER     = 11;
+  MESSAGE_TYPE_RED_ENVELOPE = 12;
+  MESSAGE_TYPE_RECALLED     = 13;
+  MESSAGE_TYPE_URL          = 14;
+}
+
+message MessagePayloadRequest {
+  string id = 1;
+}
+message MessagePayloadResponse {
+  string      id                 = 1;
+  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;
+}
+
+message MessageImageRequest {
+  string    id   = 1;
+  ImageType type = 2;
+}
+message MessageImageResponse {
+   string file_box = 1;
+}
+
+message MessageContactRequest {
+  string id = 1;
+}
+message MessageContactResponse {
+  string id = 1;
+}
+
+message MessageFileRequest {
+  string id = 1;
+}
+message MessageFileResponse {
+   string file_box = 1;
+}
+
+message MessageMiniProgramRequest {
+  string id = 1;
+}
+message MessageMiniProgramResponse {
+  /**
+   * 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 = 1 [deprecated = true]; // deprecated after Sep 31, 2021, remove compatible code after Dec 31, 2022
+  MiniProgramPayload mini_program = 2;
+}
+
+message MessageUrlRequest {
+  string id = 1;
+}
+message MessageUrlResponse {
+  /**
+   * 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 = 1 [deprecated = true]; // deprecated after Sep 31, 2021, remove compatible code after Dec 31, 2022
+  UrlLinkPayload url_link = 2;
+}
+
+message MessageSendContactRequest {
+  string conversation_id = 1;
+  string contact_id = 2;
+}
+message MessageSendContactResponse {
+  /**
+   * @deprecated:
+   *  Huan(202109): Wrapper types must not be used going forward.
+   *    https://cloud.google.com/apis/design/design_patterns#optional_primitive_fields
+   */
+  google.protobuf.StringValue id_string_value_deprecated = 1 [deprecated = true]; // Deprecated after Sep 31, 2021, will be removed after Dec 31, 2022
+  string id = 2;
+}
+
+message MessageSendFileRequest {
+  string conversation_id = 1;
+  string file_box = 2;
+}
+message MessageSendFileResponse {
+  /**
+   * @deprecated:
+   *  Huan(202109): Wrapper types must not be used going forward.
+   *    https://cloud.google.com/apis/design/design_patterns#optional_primitive_fields
+   */
+  google.protobuf.StringValue id_string_value_deprecated = 1 [deprecated = true]; // Deprecated after Sep 31, 2021, will be removed after Dec 31, 2022
+  string id = 2;
+}
+
+message MessageSendTextRequest {
+  string conversation_id = 1;
+  string text = 2;
+
+  // Huan(202011) FIXME: Issue #99
+  // https://github.com/wechaty/grpc/issues/99
+  repeated string mentional_ids = 3;
+}
+message MessageSendTextResponse {
+  /**
+   * @deprecated:
+   *  Huan(202109): Wrapper types must not be used going forward.
+   *    https://cloud.google.com/apis/design/design_patterns#optional_primitive_fields
+   */
+  google.protobuf.StringValue id_string_value_deprecated = 1 [deprecated = true]; // Deprecated after Sep 31, 2021, will be removed after Dec 31, 2022
+  string id = 2;
+}
+
+message MessageSendMiniProgramRequest {
+  string conversation_id = 1;
+  /**
+   * 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;
+}
+message MessageSendMiniProgramResponse {
+  /**
+   * @deprecated:
+   *  Huan(202109): Wrapper types must not be used going forward.
+   *    https://cloud.google.com/apis/design/design_patterns#optional_primitive_fields
+   */
+  google.protobuf.StringValue id_string_value_deprecated = 1 [deprecated = true]; // Deprecated after Sep 31, 2021, will be removed after Dec 31, 2022
+  string id = 2;
+}
+
+message MessageSendUrlRequest {
+  string conversation_id = 1;
+  /**
+   * 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;
+}
+message MessageSendUrlResponse {
+  /**
+   * @deprecated:
+   *  Huan(202109): Wrapper types must not be used going forward.
+   *    https://cloud.google.com/apis/design/design_patterns#optional_primitive_fields
+   */
+  google.protobuf.StringValue id_string_value_deprecated = 1 [deprecated = true]; // Deprecated after Sep 31, 2021, will be removed after Dec 31, 2022
+  string id = 2;
+}
+
+message MessageRecallRequest {
+  string id = 1;
+}
+message MessageRecallResponse {
+  bool success = 1;
+}
+message MessageForwardRequest{
+  string message_id = 1;
+  string conversation_id = 2;
+}
+message MessageForwardResponse {
+  /**
+   * @deprecated: use payload instead.
+   *  Huan(202109): Wrapper types must not be used going forward.
+   *    https://cloud.google.com/apis/design/design_patterns#optional_primitive_fields
+   */
+  google.protobuf.StringValue id_string_value_deprecated = 1 [deprecated = true]; // Deprecated after Sep 31, 2021, will be removed after Dec 31, 2022
+  string id = 2;
+}
+
+message MessageLocationRequest{
+  string id = 1;
+}
+message MessageLocationResponse {
+  LocationPayload location = 1;
+}
+
+message MessageSendLocationRequest {
+  string conversation_id = 1;
+  LocationPayload location = 2;
+}
+message MessageSendLocationResponse {
+  /**
+   * Huan(202110): we will not use wrappers any more by following the Google Style Guide:
+   *  If not using optional would add complexity or ambiguity, then use optional primitive fields,
+   *  Wrapper types must not be used going forward.
+   *  — Optional Primitive Fields (https://cloud.google.com/apis/design/design_patterns.md#optional-primitive-fields)
+   */
+  string id = 1;
+}

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

@@ -0,0 +1,18 @@
+syntax = "proto3";
+package wechaty.puppet;
+
+option go_package       = "github.com/wechaty/go-grpc/wechaty/puppet";
+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;
+}

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

@@ -0,0 +1,16 @@
+syntax = "proto3";
+package wechaty.puppet;
+
+option csharp_namespace = "github.wechaty.grpc.puppet";
+option go_package       = "github.com/wechaty/go-grpc/wechaty/puppet";
+option java_package     = "io.github.wechaty.grpc.puppet";
+
+/**
+ * "Referrer" and "Referral" refers to different things. "Referrer" is something or somebody who refers. "Referral" is the act of referring.
+ *  - https://english.stackexchange.com/questions/33135/referrer-versus-referral-versus-referer
+ */
+message Referrer {
+  string contact_id = 1;
+  string room_id    = 2;
+}
+