@juzi/wechaty-puppet-service 1.0.44 → 1.0.46

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@juzi/wechaty-puppet-service",
-  "version": "1.0.44",
+  "version": "1.0.46",
   "description": "Puppet Service for Wechaty",
   "type": "module",
   "exports": {
@@ -51,7 +51,7 @@
     "@chatie/eslint-config": "^1.0.4",
     "@chatie/semver": "^0.4.7",
     "@chatie/tsconfig": "^4.6.3",
-    "@juzi/wechaty-puppet": "^1.0.49",
+    "@juzi/wechaty-puppet": "^1.0.50",
     "@juzi/wechaty-puppet-mock": "^1.0.1",
     "@types/google-protobuf": "^3.15.5",
     "@types/lru-cache": "^7.5.0",
@@ -59,6 +59,7 @@
     "@types/temp": "^0.9.1",
     "@types/uuid": "^8.3.4",
     "@types/ws": "^8.5.3",
+    "esquery": "1.4.0",
     "get-port": "^6.1.2",
     "temp": "^0.9.4",
     "typed-emitter": "^1.5.0-from-event",
@@ -69,7 +70,7 @@
     "@juzi/wechaty-puppet": "^1.0.46"
   },
   "dependencies": {
-    "@juzi/wechaty-grpc": "^1.0.43",
+    "@juzi/wechaty-grpc": "^1.0.47",
     "@juzi/wechaty-redux": "^1.0.1",
     "clone-class": "^1.1.1",
     "ducks": "^1.0.2",

package/src/client/puppet-service.ts

@@ -58,7 +58,8 @@ import { packageJson }  from '../package-json.js'
 
 import { GrpcManager }  from './grpc-manager.js'
 import { PayloadStore } from './payload-store.js'
-import { channelPayloadToPb, channelPbToPayload, urlLinkPayloadToPb, urlLinkPbToPayload } from '../utils/pb-payload-helper.js'
+import { channelPayloadToPb, channelPbToPayload, postPayloadToPb, urlLinkPbToPayload } from '../utils/pb-payload-helper.js'
+import type { MessageBroadcastTargets, MessageBroadcastTargetType } from '@juzi/wechaty-puppet/dist/esm/src/schemas/message.js'
 
 export type PuppetServiceOptions = PUPPET.PuppetOptions & {
   authority?  : string
@@ -715,24 +716,24 @@ class PuppetService extends PUPPET.Puppet {
     if (payload.id) {
       throw new Error('cannot modify contactId')
     }
-    if (payload.gender) { request.setGender(payload.gender) }
-    if (payload.type) { request.setType(payload.type) }
-    if (payload.name) { request.setName(payload.name) }
-    if (payload.avatar) { request.setAvatar(payload.avatar) }
-    if (payload.address) { request.setAddress(payload.address) }
-    if (payload.alias) { request.setAlias(payload.alias) }
-    if (payload.city) { request.setCity(payload.city) }
-    if (payload.friend) { request.setFriend(payload.friend) }
-    if (payload.province) { request.setProvince(payload.province) }
-    if (payload.star) { request.setStar(payload.star) }
-    if (payload.weixin) { request.setWeixin(payload.weixin) }
-    if (payload.corporation) { request.setCorporation(payload.corporation) }
-    if (payload.title) { request.setTitle(payload.title) }
-    if (payload.description) { request.setDescription(payload.description) }
-    if (payload.coworker) { request.setCoworker(payload.coworker) }
-    if (payload.phone) { request.setPhonesList(payload.phone) }
-    if (payload.additionalInfo) { request.setAdditionalInfo(payload.additionalInfo) }
-    if (payload.tags) { request.setTagIdsList(payload.tags) }
+    if (typeof payload.gender !== 'undefined') { request.setGender(payload.gender) }
+    if (typeof payload.type !== 'undefined') { request.setType(payload.type) }
+    if (typeof payload.name !== 'undefined') { request.setName(payload.name) }
+    if (typeof payload.avatar !== 'undefined') { request.setAvatar(payload.avatar) }
+    if (typeof payload.address !== 'undefined') { request.setAddress(payload.address) }
+    if (typeof payload.alias !== 'undefined') { request.setAlias(payload.alias) }
+    if (typeof payload.city !== 'undefined') { request.setCity(payload.city) }
+    if (typeof payload.friend !== 'undefined') { request.setFriend(payload.friend) }
+    if (typeof payload.province !== 'undefined') { request.setProvince(payload.province) }
+    if (typeof payload.star !== 'undefined') { request.setStar(payload.star) }
+    if (typeof payload.weixin !== 'undefined') { request.setWeixin(payload.weixin) }
+    if (typeof payload.corporation !== 'undefined') { request.setCorporation(payload.corporation) }
+    if (typeof payload.title !== 'undefined') { request.setTitle(payload.title) }
+    if (typeof payload.description !== 'undefined') { request.setDescription(payload.description) }
+    if (typeof payload.coworker !== 'undefined') { request.setCoworker(payload.coworker) }
+    if (typeof payload.phone !== 'undefined') { request.setPhonesList(payload.phone) }
+    if (typeof payload.additionalInfo !== 'undefined') { request.setAdditionalInfo(payload.additionalInfo) }
+    if (typeof payload.tags !== 'undefined') { request.setTagIdsList(payload.tags) }
 
     await util.promisify(
       this.grpcManager.client.contactPayloadModify
@@ -1364,6 +1365,41 @@ class PuppetService extends PUPPET.Puppet {
     return payload
   }
 
+  override async getMessageBroadcastTarget (): Promise<MessageBroadcastTargets> {
+    log.verbose('PuppetService', 'getMessageBroadcastTarget()')
+
+    const request = new grpcPuppet.GetMessageBroadcastTargetRequest()
+
+    const response = await util.promisify(
+      this.grpcManager.client.getMessageBroadcastTarget.bind(this.grpcManager.client),
+    )(request)
+
+    return {
+      contactIds: response.getContactIdsList(),
+      roomIds: response.getRoomIdsList(),
+    }
+  }
+
+  override async createMessageBroadcast (targets: string[], type: MessageBroadcastTargetType, content: PUPPET.payloads.Post): Promise<string | void> {
+    log.verbose('PuppetService', 'createMessageBroadcast()')
+
+    if (!PUPPET.payloads.isPostClient(content)) {
+      throw new Error('can only create broadcast with client post')
+    }
+
+    const request = new grpcPuppet.CreateMessageBroadcastRequest()
+    const post = await postPayloadToPb(grpcPuppet, content, this.serializeFileBox.bind(this))
+    request.setContent(post)
+    request.setTargetIdsList(targets)
+    request.setType(type)
+
+    const response = await util.promisify(
+      this.grpcManager.client.createMessageBroadcast.bind(this.grpcManager.client),
+    )(request)
+
+    return response.getId()
+  }
+
   /**
    *
    * Room
@@ -2206,53 +2242,7 @@ class PuppetService extends PUPPET.Puppet {
       throw new Error('can only publish client post now')
     }
     const request = new grpcPuppet.MomentPublishRequest()
-    const post = new grpcPuppet.PostPayloadClient()
-    post.setType(grpcPuppet.PostType.POST_TYPE_MOMENT)
-    for (const item of payload.sayableList) {
-      const sayable = new grpcPuppet.PostSayable()
-      switch (item.type) {
-        case PUPPET.types.Sayable.Text:
-          sayable.setType(grpcPuppet.SayableType.SAYABLE_TYPE_TEXT)
-          sayable.setText(item.payload.text)
-          sayable.setMentionIdListList(item.payload.mentions)
-          break
-        case PUPPET.types.Sayable.Attachment: {
-          sayable.setType(grpcPuppet.SayableType.SAYABLE_TYPE_FILE)
-          const serializedFileBox = typeof item.payload.filebox === 'string' ? item.payload.filebox : await this.serializeFileBox(item.payload.filebox)
-          sayable.setFileBox(serializedFileBox)
-          break
-        }
-        case PUPPET.types.Sayable.Url: {
-          sayable.setType(grpcPuppet.SayableType.SAYABLE_TYPE_URL)
-          const urlLinkPayload = item.payload
-          const pbUrlLinkPayload = urlLinkPayloadToPb(grpcPuppet, urlLinkPayload)
-          sayable.setUrlLink(pbUrlLinkPayload)
-          break
-        }
-        case PUPPET.types.Sayable.Channel: {
-          sayable.setType(grpcPuppet.SayableType.SAYABLE_TYPE_CHANNEL)
-          const channelPayload = item.payload
-          const pbChannelPayload = channelPayloadToPb(grpcPuppet, channelPayload)
-          sayable.setChannel(pbChannelPayload)
-          break
-        }
-        default:
-          throw new Error(`postPublish unsupported type ${item.type}`)
-      }
-      post.addSayableList(sayable)
-    }
-    if (payload.rootId) { post.setRootId(payload.rootId) }
-    if (payload.parentId) { post.setParentId(payload.parentId) }
-    if (payload.location) {
-      const location = new grpcPuppet.LocationPayload()
-      location.setAccuracy(payload.location.accuracy)
-      location.setAddress(payload.location.address)
-      location.setName(payload.location.name)
-      location.setLatitude(payload.location.latitude)
-      location.setLongitude(payload.location.longitude)
-      post.setLocation(location)
-    }
-    post.setVisibleListList(payload.visibleList || [])
+    const post = await postPayloadToPb(grpcPuppet, payload, this.serializeFileBox.bind(this))
     request.setPost(post)
 
     const result = await util.promisify(

package/src/package-json.ts

@@ -4,7 +4,7 @@
 import type { PackageJson } from 'type-fest'
 export const packageJson: PackageJson = {
   "name": "@juzi/wechaty-puppet-service",
-  "version": "1.0.44",
+  "version": "1.0.46",
   "description": "Puppet Service for Wechaty",
   "type": "module",
   "exports": {
@@ -55,7 +55,7 @@ export const packageJson: PackageJson = {
     "@chatie/eslint-config": "^1.0.4",
     "@chatie/semver": "^0.4.7",
     "@chatie/tsconfig": "^4.6.3",
-    "@juzi/wechaty-puppet": "^1.0.49",
+    "@juzi/wechaty-puppet": "^1.0.50",
     "@juzi/wechaty-puppet-mock": "^1.0.1",
     "@types/google-protobuf": "^3.15.5",
     "@types/lru-cache": "^7.5.0",
@@ -63,6 +63,7 @@ export const packageJson: PackageJson = {
     "@types/temp": "^0.9.1",
     "@types/uuid": "^8.3.4",
     "@types/ws": "^8.5.3",
+    "esquery": "1.4.0",
     "get-port": "^6.1.2",
     "temp": "^0.9.4",
     "typed-emitter": "^1.5.0-from-event",
@@ -73,7 +74,7 @@ export const packageJson: PackageJson = {
     "@juzi/wechaty-puppet": "^1.0.46"
   },
   "dependencies": {
-    "@juzi/wechaty-grpc": "^1.0.43",
+    "@juzi/wechaty-grpc": "^1.0.47",
     "@juzi/wechaty-redux": "^1.0.1",
     "clone-class": "^1.1.1",
     "ducks": "^1.0.2",

package/src/server/puppet-implementation.ts

@@ -43,7 +43,7 @@ import {
 import { log } from '../config.js'
 import { grpcError }          from './grpc-error.js'
 import { EventStreamManager } from './event-stream-manager.js'
-import { channelPayloadToPb, channelPbToPayload, urlLinkPayloadToPb, urlLinkPbToPayload } from '../utils/pb-payload-helper.js'
+import { channelPayloadToPb, postPbToPayload, urlLinkPayloadToPb } from '../utils/pb-payload-helper.js'
 
 function puppetImplementation (
   puppet      : PUPPET.impls.PuppetInterface,
@@ -1100,6 +1100,54 @@ function puppetImplementation (
       }
     },
 
+    getMessageBroadcastTarget: async (call, callback) => {
+      log.verbose('PuppetServiceImpl', 'getMessageBroadcastTarget()')
+
+      void call
+      try {
+        const payload = await puppet.getMessageBroadcastTarget()
+
+        const response = new grpcPuppet.GetMessageBroadcastTargetResponse()
+        response.setContactIdsList(payload.contactIds || [])
+        response.setRoomIdsList(payload.roomIds || [])
+
+        return callback(null, response)
+      } catch (e) {
+        return grpcError('getMessageBroadcastTarget', e, callback)
+      }
+    },
+
+    createMessageBroadcast: async (call, callback) => {
+      log.verbose('PuppetServiceImpl', 'createMessageBroadcast()')
+
+      try {
+        const targets = call.request.getTargetIdsList()
+        const type = call.request.getType()
+        const post = call.request.getContent()
+
+        if (!post) {
+          throw new Error('no post found')
+        }
+        if (post.getType() !== grpcPuppet.PostType.POST_TYPE_BROADCAST) {
+          throw new Error('cannot create broadcast with non-broadcast post')
+        }
+
+        const payload = postPbToPayload(post, FileBoxUuid)
+
+        const id = await puppet.createMessageBroadcast(targets, type, payload)
+
+        const response = new grpcPuppet.CreateMessageBroadcastResponse()
+        if (id) {
+          response.setId(id)
+        }
+
+        return callback(null, response)
+
+      } catch (e) {
+        return grpcError('createMessageBroadcast', e, callback)
+      }
+    },
+
     roomAdd: async (call, callback) => {
       log.verbose('PuppetServiceImpl', 'roomAdd()')
 
@@ -1764,67 +1812,7 @@ function puppetImplementation (
         if (type !== grpcPuppet.PostType.POST_TYPE_MOMENT) {
           throw new Error('cannot publish non-moment post')
         }
-        const payload: PUPPET.payloads.PostClient = {
-          type: PUPPET.types.Post.Moment,
-          sayableList: [],
-          rootId: post.getRootId(),
-          parentId: post.getParentId(),
-          visibleList: post.getVisibleListList(),
-        }
-        const sayableList = post.getSayableListList()
-        for (const sayable of sayableList) {
-          let sayablePayload: PUPPET.payloads.Sayable | undefined
-          switch (sayable.getType()) {
-            case grpcPuppet.SayableType.SAYABLE_TYPE_TEXT:
-              sayablePayload = PUPPET.payloads.sayable.text(sayable.getText() || '', sayable.getMentionIdListList())
-              break
-            case grpcPuppet.SayableType.SAYABLE_TYPE_FILE: {
-              const fileJsonStr = sayable.getFileBox()
-              if (!fileJsonStr) {
-                break
-              }
-              const file = FileBoxUuid.fromJSON(fileJsonStr)
-              sayablePayload = PUPPET.payloads.sayable.attachment(file)
-              break
-            }
-            case grpcPuppet.SayableType.SAYABLE_TYPE_URL: {
-              const urlLinkPayloadPb = sayable.getUrlLink()
-              if (!urlLinkPayloadPb) {
-                break
-              }
-              const urlLinkPayload = urlLinkPbToPayload(urlLinkPayloadPb)
-              sayablePayload = PUPPET.payloads.sayable.url(urlLinkPayload)
-              break
-            }
-            case grpcPuppet.SayableType.SAYABLE_TYPE_CHANNEL: {
-              const channelPayloadPb = sayable.getChannel()
-              if (!channelPayloadPb) {
-                break
-              }
-              const channelPayload = channelPbToPayload(channelPayloadPb!)
-              sayablePayload = PUPPET.payloads.sayable.channel(channelPayload)
-              break
-            }
-            default:
-              throw new Error(`unsupported postSayableType type ${sayable.getType()}`)
-          }
-          if (sayablePayload) {
-            payload.sayableList.push(sayablePayload)
-          } else {
-            throw new Error(`unable to fetch sayable from ${JSON.stringify(sayable.toObject())}`)
-          }
-        }
-
-        const location = post.getLocation()
-        if (location) {
-          payload.location = {
-            name: location.getName() || '',
-            accuracy: location.getAccuracy() || 15,
-            address: location.getAddress() || '',
-            latitude: location.getLatitude(),
-            longitude: location.getLatitude(),
-          }
-        }
+        const payload = postPbToPayload(post, FileBoxUuid)
 
         const momentId = await puppet.postPublish(payload)
         const response = new grpcPuppet.MomentPublishResponse()

package/src/utils/pb-payload-helper.ts

@@ -1,8 +1,9 @@
-import type {
+import {
   puppet,
 } from '@juzi/wechaty-grpc'
 
-import type * as PUPPET from '@juzi/wechaty-puppet'
+import * as PUPPET from '@juzi/wechaty-puppet'
+import type { FileBox, FileBoxInterface } from 'file-box'
 
 type grpcPuppet = typeof puppet
 
@@ -21,6 +22,14 @@ export const miniProgramPayloadToPb = (grpcPuppet: grpcPuppet, miniProgramPayloa
   return pbMiniProgramPayload
 }
 
+export const miniProgramPbToPayload = (miniProgramPayloadPb: puppet.MiniProgramPayload) => {
+  const _miniProgramPayloadPb = miniProgramPayloadPb.toObject()
+  const miniProgramPayload: PUPPET.payloads.MiniProgram = {
+    ..._miniProgramPayloadPb,
+  }
+  return miniProgramPayload
+}
+
 export const urlLinkPayloadToPb = (grpcPuppet: grpcPuppet, urlLinkPayload: PUPPET.payloads.UrlLink) => {
   const pbUrlLinkPayload = new grpcPuppet.UrlLinkPayload()
   pbUrlLinkPayload.setUrl(urlLinkPayload.url)
@@ -60,3 +69,135 @@ export const channelPbToPayload = (channelPayloadPb: puppet.ChannelPayload) => {
   }
   return channelPayload
 }
+
+export const postPayloadToPb = async (grpcPuppet: grpcPuppet, payload: PUPPET.payloads.PostClient, serializeFileBox: (filebox: FileBoxInterface) => Promise<string>) => {
+  const pb = new grpcPuppet.PostPayloadClient()
+  pb.setType(payload.type || 0)
+  for (const item of payload.sayableList) {
+    const sayable = new grpcPuppet.PostSayable()
+    switch (item.type) {
+      case PUPPET.types.Sayable.Text:
+        sayable.setType(grpcPuppet.SayableType.SAYABLE_TYPE_TEXT)
+        sayable.setText(item.payload.text)
+        sayable.setMentionIdListList(item.payload.mentions)
+        break
+      case PUPPET.types.Sayable.Attachment: {
+        sayable.setType(grpcPuppet.SayableType.SAYABLE_TYPE_FILE)
+        const serializedFileBox = typeof item.payload.filebox === 'string' ? item.payload.filebox : (await serializeFileBox(item.payload.filebox))
+        sayable.setFileBox(serializedFileBox)
+        break
+      }
+      case PUPPET.types.Sayable.Url: {
+        sayable.setType(grpcPuppet.SayableType.SAYABLE_TYPE_URL)
+        const urlLinkPayload = item.payload
+        const pbUrlLinkPayload = urlLinkPayloadToPb(grpcPuppet, urlLinkPayload)
+        sayable.setUrlLink(pbUrlLinkPayload)
+        break
+      }
+      case PUPPET.types.Sayable.Channel: {
+        sayable.setType(grpcPuppet.SayableType.SAYABLE_TYPE_CHANNEL)
+        const channelPayload = item.payload
+        const pbChannelPayload = channelPayloadToPb(grpcPuppet, channelPayload)
+        sayable.setChannel(pbChannelPayload)
+        break
+      }
+      case PUPPET.types.Sayable.MiniProgram: {
+        sayable.setType(grpcPuppet.SayableType.SAYABLE_TYPE_MINIPROGRAM)
+        const miniProgramPayload = item.payload
+        const pbMiniProgramPayload = miniProgramPayloadToPb(grpcPuppet, miniProgramPayload)
+        sayable.setMiniProgram(pbMiniProgramPayload)
+        break
+      }
+      default:
+        throw new Error(`postPublish unsupported type ${item.type}`)
+    }
+    pb.addSayableList(sayable)
+  }
+  if (payload.rootId) { pb.setRootId(payload.rootId) }
+  if (payload.parentId) { pb.setParentId(payload.parentId) }
+  if (payload.location) {
+    const location = new grpcPuppet.LocationPayload()
+    location.setAccuracy(payload.location.accuracy)
+    location.setAddress(payload.location.address)
+    location.setName(payload.location.name)
+    location.setLatitude(payload.location.latitude)
+    location.setLongitude(payload.location.longitude)
+    pb.setLocation(location)
+  }
+  pb.setVisibleListList(payload.visibleList || [])
+  return pb
+}
+
+export const postPbToPayload = (post: puppet.PostPayloadClient, FileBoxUuid: typeof FileBox) => {
+  const payload: PUPPET.payloads.PostClient = {
+    type: post.getType(),
+    sayableList: [],
+    rootId: post.getRootId(),
+    parentId: post.getParentId(),
+    visibleList: post.getVisibleListList(),
+  }
+
+  const sayableList = post.getSayableListList()
+  for (const sayable of sayableList) {
+    let sayablePayload: PUPPET.payloads.Sayable | undefined
+    switch (sayable.getType()) {
+      case puppet.SayableType.SAYABLE_TYPE_TEXT:
+        sayablePayload = PUPPET.payloads.sayable.text(sayable.getText() || '', sayable.getMentionIdListList())
+        break
+      case puppet.SayableType.SAYABLE_TYPE_FILE: {
+        const fileJsonStr = sayable.getFileBox()
+        if (!fileJsonStr) {
+          break
+        }
+        const file = FileBoxUuid.fromJSON(fileJsonStr)
+        sayablePayload = PUPPET.payloads.sayable.attachment(file)
+        break
+      }
+      case puppet.SayableType.SAYABLE_TYPE_URL: {
+        const urlLinkPayloadPb = sayable.getUrlLink()
+        if (!urlLinkPayloadPb) {
+          break
+        }
+        const urlLinkPayload = urlLinkPbToPayload(urlLinkPayloadPb)
+        sayablePayload = PUPPET.payloads.sayable.url(urlLinkPayload)
+        break
+      }
+      case puppet.SayableType.SAYABLE_TYPE_CHANNEL: {
+        const channelPayloadPb = sayable.getChannel()
+        if (!channelPayloadPb) {
+          break
+        }
+        const channelPayload = channelPbToPayload(channelPayloadPb!)
+        sayablePayload = PUPPET.payloads.sayable.channel(channelPayload)
+        break
+      }
+      case puppet.SayableType.SAYABLE_TYPE_MINIPROGRAM: {
+        const miniProgramPayloadPb = sayable.getMiniProgram()
+        if (!miniProgramPayloadPb) {
+          break
+        }
+        const miniProgramPayload = miniProgramPbToPayload(miniProgramPayloadPb)
+        sayablePayload = PUPPET.payloads.sayable.miniProgram(miniProgramPayload)
+        break
+      }
+      default:
+        throw new Error(`unsupported postSayableType type ${sayable.getType()}`)
+    }
+    if (sayablePayload) {
+      payload.sayableList.push(sayablePayload)
+    } else {
+      throw new Error(`unable to fetch sayable from ${JSON.stringify(sayable.toObject())}`)
+    }
+  }
+  const location = post.getLocation()
+  if (location) {
+    payload.location = {
+      name: location.getName() || '',
+      accuracy: location.getAccuracy() || 15,
+      address: location.getAddress() || '',
+      latitude: location.getLatitude(),
+      longitude: location.getLatitude(),
+    }
+  }
+  return payload
+}