wechaty-puppet-matrix 0.0.36 → 0.0.38

package/src/matrix/events/event-room-leave.ts

@@ -50,8 +50,6 @@ export default async (puppet: PUPPET.Puppet, message: MessagePayload): Promise<E
   if (!isRoomId(roomId) || message.msgType !== WechatMessageType.Sys) {
     return null
   }
-  // @ts-ignore
-  await puppet._updateRoom(roomId)
 
   /**
    * 1. 我将别人移除
@@ -63,8 +61,11 @@ export default async (puppet: PUPPET.Puppet, message: MessagePayload): Promise<E
     YOU_REMOVE_OTHER_REGEX_LIST.some((re) => !!(matches = message.msg.match(re)))
     // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
     if (matches) {
+      // @ts-ignore
+      await puppet._updateRoom(roomId)
       const removerName = matches[2]!
-      const removerId = (await puppet.roomMemberSearch(roomId, removerName))[0]!
+      // @ts-ignore
+      const removerId = await puppet._searchRoomMemberInfo(roomId, removerName)
 
       return {
         removeeIdList: [ removerId ],
@@ -88,7 +89,8 @@ export default async (puppet: PUPPET.Puppet, message: MessagePayload): Promise<E
     // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
     if (matches) {
       const removerName = matches[2]!
-      const removerId = (await puppet.roomMemberSearch(roomId, removerName))[0]!
+      // @ts-ignore
+      const removerId = await puppet._searchRoomMemberInfo(roomId, removerName)
 
       return {
         removeeIdList: [ puppet.currentUserId ],

package/src/matrix/events/event-room-topic.ts

@@ -47,7 +47,8 @@ export default async (puppet: PUPPET.Puppet, message: MessagePayload): Promise<E
       const changeName = match[1]
       let changeId = ''
       if (changeName) {
-        changeId = (await puppet.roomMemberSearch(roomId, changeName))[0]!
+        // @ts-ignore
+        changeId = await puppet._searchRoomMemberInfo(roomId, changeName)
       }
       return {
         changerId: changeId,

package/src/matrix/messages/sysmsg/message-revokemsg.ts

@@ -60,10 +60,9 @@ export async function getRevokeOriginalMessage (puppet: PUPPET.Puppet, revokemsg
 
 export async function getRevokeOperatorIdForRoomMessage (puppet: PUPPET.Puppet, revokemsgPayload:RevokeMsgMessagePayload) : Promise<string | null> {
   if (isRoomId(revokemsgPayload.session) || isIMRoomId(revokemsgPayload.session)) {
-    const contactIdList = await puppet.roomMemberSearch(revokemsgPayload.session, revokemsgPayload.operatorNickName!)
-    if (contactIdList.length) {
-      return contactIdList[0]!
-    }
+    // @ts-ignore
+    const contactId = await puppet._searchRoomMemberInfo(revokemsgPayload.session, revokemsgPayload.operatorNickName!)
+    return contactId
   }
 
   return null

package/src/matrix/schema-mapper/contact.ts

@@ -11,7 +11,7 @@ export function engineContactToWechaty (contact?: ContactPayload): PUPPET.payloa
       gender: contact.sex, // 性别
       id: contact.wxid, // wxid
       name: contact.name, // 昵称
-      friend: !!contact.isFriend, // 是否是好友
+      friend: contact.contactType === 2 || !!contact.isFriend, // 是否是好友
       phone: [],
       province: contact.province,
       signature: contact.sign, // 签名

package/src/matrix/service/request.ts

@@ -6,7 +6,7 @@ import WebSocket from 'ws'
 import * as PUPPET from '@juzi/wechaty-puppet'
 import { format, getUnixTime } from 'date-fns'
 import { xmlToJson } from '../utils/xml-to-json.js'
-import { isRoomId } from '../utils/is-type.js'
+import { isRoomId, getContactType } from '../utils/is-type.js'
 import imageSize from 'image-size'
 import fs from 'fs-extra'
 import os from 'os'
@@ -45,7 +45,12 @@ export enum NotifyTypeEnum {
   RoomMemberAdd = 1046, // set
   RoomMemberUpdate = 1047,
   RoomMemberDel = 1048, // set
-  SyncMsgFailed = 2006 // 需要调用 restore 接口
+  SyncMsgFailed = 2006, // 需要调用 restore 接口
+  WxNotifyTypeCmdIdModContact = 1200,
+  WxNotifyTypeCmdIdDelContact = 1201,
+  WxNotifyTypeOpenImContactAdd = 1202,
+  WxNotifyTypeOpenImContactDel = 1203,
+  WxNotifyTypeOpenImRoomContactChange = 1204,
 }
 
 /**
@@ -173,6 +178,8 @@ export interface ContactPayload {
    * 群公告
    */
   announcement?: string;
+  chatroomVersion?: number;
+  chatroomInfoVersion?: number;
 }
 
 /**
@@ -650,6 +657,7 @@ class Client extends EventEmitter {
   server: any
   tokenInfo: any
   hasEmitLogout: boolean
+  private lastInitSeqInfo: { contactSeq: number; roomSeq: number; }
 
   // @ts-ignore
   override emit(event: 'hook', detail: BaseEvent): boolean;
@@ -684,6 +692,7 @@ class Client extends EventEmitter {
     this.restoreTimes = 0
     this.maxRestoreTimes = 1
     this.hasExpired = false
+    this.lastInitSeqInfo = { contactSeq: 0, roomSeq: 0 }
   }
 
   destroy () {
@@ -751,7 +760,7 @@ class Client extends EventEmitter {
       log.error('Token info not available')
       return
     }
-
+    // @ts-ignore
     function randomRange (min: number, max: number) {
       // min最小值，max最大值
       return Math.floor(Math.random() * (max - min)) + min
@@ -760,10 +769,13 @@ class Client extends EventEmitter {
     const client = mqtt.connect(this.tokenInfo.mqServer, {
       username: this.tokenInfo.mqUser,
       password: this.tokenInfo.mqPsd,
-      keepalive: 60,
-      reconnectPeriod: 100,
+      keepalive: 120,
+      reconnectPeriod: 3000,
       connectTimeout: 60 * 1000,
-      clientId: this.tokenInfo.guid + randomRange(1, 10000),
+      clean: true,
+      // @ts-ignore
+      family: 4,
+      clientId: this.tokenInfo.guid,
     })
 
     client.on('connect', () => {
@@ -917,24 +929,26 @@ class Client extends EventEmitter {
         this.emit('logout', data.errmsg)
         break
       case NotifyTypeEnum.RoomMemberAdd:
-        this.emit('room-join', {
-          roomId: data.room_username,
-          inviterId: data.member_list[0]?.invite_username,
-          joinIds: data.member_list.map((item: any) => item.username),
-          joinUsers: data.member_list.map((data: any) => ({
-            wxNum: data?.alias,
-            wxid: data?.username || '',
-            name: data?.nickname || '',
-            sex: data?.sex,
-            alias: '',
-            province: data?.province || '',
-            city: data?.city || '',
-            country: data?.country || '',
-            avatar: data?.big_headimg_url || data?.small_headimg_url || '',
-            description: '',
-            labelIdlist: data?.labelid_list,
-          })),
-        })
+        // @ts-ignore
+        // const params = {
+        //   roomId: data.room_username,
+        //   inviterId: data.member_list[0]?.invite_username,
+        //   joinIds: data.member_list.map((item: any) => item.username),
+        //   joinUsers: data.member_list.map((data: any) => ({
+        //     wxNum: data?.alias,
+        //     wxid: data?.username || '',
+        //     name: data?.nickname || '',
+        //     sex: data?.sex,
+        //     alias: '',
+        //     province: data?.province || '',
+        //     city: data?.city || '',
+        //     country: data?.country || '',
+        //     avatar: data?.big_headimg_url || data?.small_headimg_url || '',
+        //     description: '',
+        //     labelIdlist: data?.labelid_list,
+        //   })),
+        // }
+        // this.emit('room-join', params)
         break
       case NotifyTypeEnum.RoomMemberDel:
         // @ts-ignore
@@ -948,6 +962,11 @@ class Client extends EventEmitter {
           void this.restore()
         }
         break
+      case NotifyTypeEnum.WxNotifyTypeCmdIdModContact:
+      case NotifyTypeEnum.WxNotifyTypeCmdIdDelContact:
+        log.info('contact change sync start')
+        await this.syncContact(false)
+        break
       default:
         log.info('other data', JSON.stringify(data))
     }
@@ -1354,6 +1373,7 @@ class Client extends EventEmitter {
         if (contactInfo) {
           const contact = contactInfo.contact
           return {
+            contactType: getContactType(contact?.userName?.string || '', contact?.bitVal, contact?.verifyFlag),
             wxNum: contact.alias,
             wxid: contact?.userName?.string || '',
             name: contact?.nickName?.string || '',
@@ -1365,6 +1385,8 @@ class Client extends EventEmitter {
             avatar: contact?.bigHeadImgUrl || contact?.smallHeadImgUrl || '',
             description: contact?.description,
             labelIdlist: contact?.labelIdlist,
+            chatroomInfoVersion: contactInfo?.chatroomInfoVersion,
+            chatroomVersion: contactInfo?.chatroomVersion,
           }
         }
         return undefined
@@ -1373,6 +1395,7 @@ class Client extends EventEmitter {
           = res.contactList?.map((contactInfo: any) => {
             const contact = contactInfo.contact
             return {
+              contactType: getContactType(contact?.userName?.string || '', contact?.bitVal, contact?.verifyFlag),
               wxNum: contact.alias,
               wxid: contact?.userName?.string || '',
               name: contact?.nickName?.string || '',
@@ -1384,6 +1407,8 @@ class Client extends EventEmitter {
               avatar: contact?.bigHeadImgUrl || contact?.smallHeadImgUrl || '',
               description: contact?.description,
               labelIdlist: contact?.labelIdlist,
+              chatroomInfoVersion: contactInfo?.chatroomInfoVersion,
+              chatroomVersion: contactInfo?.chatroomVersion,
             }
           }) || []
         return contacts
@@ -1515,21 +1540,34 @@ class Client extends EventEmitter {
   /**
    * 同步联系人
    */
-  public async syncContact (): Promise<void> {
+  public async syncContact (init?: boolean): Promise<void> {
     try {
+      if (init) {
+        this.lastInitSeqInfo = { contactSeq: 0, roomSeq: 0 }
+      }
       const res = await this.postData({
         path: '/contact/init_contact',
         data: {
-          contact_seq: 0,
-          room_seq: 0,
+          contact_seq: this.lastInitSeqInfo.contactSeq || 0,
+          room_seq: this.lastInitSeqInfo.roomSeq || 0,
         },
       })
-      const contactUsernameList = res.contactUsernameList || []
-      const contactsInfo: ContactPayload[] = (await this.searchContact(
-        contactUsernameList,
-      )) as ContactPayload[]
-      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-      this.emit('update-contacts', contactsInfo || [])
+      const currentWxcontactSeq = res?.currentWxcontactSeq || 0
+      const currentRoomSeq = res?.currentChatRoomContactSeq || 0
+      const continueFlag = res?.continueFlag || false
+      this.lastInitSeqInfo = { contactSeq: currentWxcontactSeq, roomSeq: currentRoomSeq }
+      const contactUsernameList = res?.contactUsernameList || []
+      if (contactUsernameList.length) {
+        const contactsInfo = await this.searchContact(
+          contactUsernameList,
+        )
+        // @ts-ignore
+        this.emit('update-contacts', contactsInfo || [])
+      }
+
+      if (continueFlag) {
+        await this.syncContact()
+      }
     } catch (e) {
       log.error(PRE, 'syncContact(): %s', e)
     }
@@ -1672,16 +1710,18 @@ class Client extends EventEmitter {
         },
       })
       const memeberIdList: string[]
-        = res?.allMemberUserNameList.map((item: any) => item.string) || []
+        = res?.allMemberUserNameList?.map((item: any) => item.string) || []
       const allMemberCount = res.allMemberCount
       const ownerId = res.chatRoomOwner
       const adminIdList: string[]
-        = res?.adminUserNameList.map((item: any) => item.string) || []
+        = res?.adminUserNameList?.map((item: any) => item.string) || []
       const memberList: ContactPayload[] = res?.newChatroomData?.chatRoomMember
-        .filter((item: any) => item.username)
+        ?.filter((item: any) => item.userName)
         .map((item: any) => ({
-          wxid: item.username, // wxid
-          groupNick: item?.nickname, // 群昵称
+          wxid: item.userName, // wxid
+          name: item?.nickName,
+          displayName: item?.displayName,
+          groupNick: item?.nickName, // 群昵称
           avatarMinUrl: item?.smallHeadImgUrl,
           avatarMaxUrl: item?.bigHeadImgUrl,
           avatar: item?.bigHeadImgUrl || item?.smallHeadImgUrl, // 头像
@@ -1695,60 +1735,8 @@ class Client extends EventEmitter {
         memberList,
       }
     } catch (e) {
-      log.error(PRE, 'getGroupMembers(%s): %s', roomId, e)
-      return []
-    }
-  }
-
-  /**
-   * 获取群成员列表
-   * @param roomId 群id
-   * @param page
-   * @param pageSize
-   */
-  public async getGroupMembers (
-    roomId: string,
-    page: number = 1,
-    pageSize: number = 100,
-  ): Promise<ContactPayload[]> {
-    try {
-      const res = await this.postData({
-        path: '/room/get_chatroom_members',
-        data: {
-          room_username: roomId,
-          page_num: page,
-          page_size: pageSize,
-        },
-      })
-
-      const totalPage = res.total_page || 1
-      const memberList = res.room_list
-        .filter((item: any) => item.username)
-        .map((item: any) => ({
-          wxid: item.username, // wxid
-          groupNick: item?.nickname, // 群昵称
-          avatarMinUrl: item?.small_headimg_url,
-          avatarMaxUrl: item?.big_headimg_url,
-          avatar: item?.big_headimg_url || item?.small_headimg_url, // 头像
-          inviterUserName: item?.invite_username, // 邀请人
-          country: item?.country,
-          province: item?.province,
-          city: item?.city,
-          displayName: item?.display_name, // 群备注
-          sex: item?.sex,
-          wxNum: item?.alias,
-          alias: item?.remark,
-        }))
-
-      if (page < totalPage) {
-        const nextPageContacts = await this.getGroupMembers(roomId, page + 1, pageSize)
-        return memberList.concat(nextPageContacts)
-      } else {
-        return memberList
-      }
-    } catch (e) {
-      log.error(PRE, 'getGroupMembers(%s): %s', roomId, e)
-      return []
+      log.error(PRE, 'getGroupMembersDetail(%s): %s', roomId, e)
+      return {}
     }
   }
 

package/src/matrix/utils/is-type.ts

@@ -70,3 +70,37 @@ export function isPayload (payload?: object): boolean {
   }
   return false
 }
+
+export enum ContactType {
+  Stranger = 0,
+  System = 1,
+  Friend = 2,
+  Mp = 3,
+  ChatRoom = 4
+}
+
+export function getContactType (username: string, bitVal = 0, verifyFlag = 0) {
+
+  // 是群聊
+  if (username.includes('@chatroom')) {
+    return ContactType.ChatRoom
+  }
+
+  // 是公众号
+  if (verifyFlag !== 0) {
+    return ContactType.Mp
+  }
+
+  // 是系统账号
+  if (officeWxid.includes(username)) {
+    return ContactType.System
+  }
+
+  // 是好友
+  if ((bitVal & 1) === 1) {
+    return ContactType.Friend
+  }
+
+  // 陌生人
+  return ContactType.Stranger
+}

package/src/puppet-matrix.ts

@@ -10,7 +10,7 @@ import type { FileBoxMetadataMessage } from './matrix/types.js'
 import Client from './matrix/service/request.js'
 import { getUnixTime } from 'date-fns'
 
-import { delay, mergeWithFallback } from './matrix/utils/index.js'
+import { mergeWithFallback } from './matrix/utils/index.js'
 import path from 'path'
 // 参考
 import { CacheManager, RoomMemberMap } from './matrix/cache-manager.js'
@@ -144,15 +144,6 @@ class PuppetMatrix extends PUPPET.Puppet {
           removerId: this._self?.wxid,
           timestamp: getUnixTime(Date.now()),
         }
-        for (const leaveId of leaveIds) {
-          await this._cacheMgr?.deleteSingleRoomMember(roomId, leaveId)
-          const roomInfo = await this._cacheMgr?.getRoom(roomId)
-          if (roomInfo && roomInfo.chatroommemberList) {
-            roomInfo.chatroommemberList = roomInfo.chatroommemberList.filter(member => member !== leaveId)
-            await this._cacheMgr?.setRoom(roomId, roomInfo)
-          }
-        }
-
         this.emit('room-leave', payload)
       }))
       this._client.on('room-join', this.wrapAsync(async ({ roomId, inviterId, joinIds, joinUsers }: { roomId: string, inviterId: string, joinIds: string[], joinUsers: ContactPayload[] }) => {
@@ -415,12 +406,10 @@ class PuppetMatrix extends PUPPET.Puppet {
   public async ready (): Promise<void> {
     try {
       await this._client?.getContactList(1, 100)
-      await this._client?.getOpenImContactList(1, 100)
-      await delay(2000)
       await this._client?.getGroupList(1, 100)
-      await delay(2000)
+      await this._client?.getOpenImContactList(1, 100)
       await this._client?.getOfficeList(1, 100)
-
+      await this.syncContact(true)
       log.silly(PRE, 'on ready')
 
       setTimeout(() => {
@@ -1273,6 +1262,22 @@ class PuppetMatrix extends PUPPET.Puppet {
     }
   }
 
+  // @ts-ignore
+  private async _searchRoomMemberInfo (roomId: string, name: string): Promise<string | undefined> {
+    const localRes = await this.roomMemberSearch(roomId, name)
+    if (localRes.length > 0) {
+      return localRes[0]
+    }
+    const roomMemberMap = await this._getRoomMemberList(roomId)
+    const searchMember = Object.values(roomMemberMap).find((member: ContactPayload) => {
+      if (member.name === name || member.alias === name || member.remark === name || member.displayName === name) {
+        return true
+      }
+      return false
+    })
+    return searchMember?.wxid || ''
+  }
+
   /**
    * 解析群成员信息
    * @param rawPayload
@@ -1446,7 +1451,8 @@ class PuppetMatrix extends PUPPET.Puppet {
 
     // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
     if (!ret || (ret && !Object.keys(ret).length) || force) {
-      const resMembers = await this._client?.getGroupMembers(roomId) || []
+      const roomMemberDetail = await this._client?.getGroupMembersDetail(roomId)
+      const resMembers = roomMemberDetail?.memberList || []
 
       const roomMemberMap: RoomMemberMap = {}
       for (const roomMember of resMembers) {
@@ -1459,6 +1465,7 @@ class PuppetMatrix extends PUPPET.Puppet {
           roomMemberMap[roomMember.wxid] = MemberInfo
         } else {
           MemberInfo = await this._cacheMgr!.getContact(roomMember.wxid) as ContactPayload
+          MemberInfo = mergeWithFallback(MemberInfo, roomMember)
           roomMemberMap[roomMember.wxid] = MemberInfo
         }
       }
@@ -1534,7 +1541,6 @@ class PuppetMatrix extends PUPPET.Puppet {
 
     if (isRoomId(contact.wxid)) {
       const oldRoomPayload = await this._cacheMgr!.getRoom(contact.wxid)
-
       const roomId = contact.wxid
       let finalPayload: ContactPayload = contact
       if (oldRoomPayload) {
@@ -1644,7 +1650,6 @@ class PuppetMatrix extends PUPPET.Puppet {
       }
       case EventType.RoomJoin: {
         const roomJoin: PUPPET.payloads.EventRoomJoin = event.payload
-        await this._updateRoomMember(roomJoin.roomId)
         for (const joinId of roomJoin.inviteeIdList) {
           if (this._roomJoinTemp[`${roomJoin.roomId}-${joinId}`]) {
             roomJoin.inviteeIdList = roomJoin.inviteeIdList.filter(id => id !== joinId)
@@ -1660,22 +1665,49 @@ class PuppetMatrix extends PUPPET.Puppet {
         break
       }
       case EventType.RoomLeave: {
-        // const roomLeave: PUPPET.payloads.EventRoomLeave = event.payload
-        // this.emit('room-leave', roomLeave)
-
-        // await this._updateRoomMember(roomLeave.roomId)
+        const roomLeave: PUPPET.payloads.EventRoomLeave = event.payload
+        this.emit('room-leave', roomLeave)
         break
       }
       case EventType.RoomTopic: {
         const roomTopic: PUPPET.payloads.EventRoomTopic = event.payload
         this.emit('room-topic', roomTopic)
+        await this._refreshContact(roomTopic.roomId)
         break
       }
     }
   }
 
+  private async _refreshRoomInfo (roomId: string): Promise<ContactPayload | undefined> {
+    const roomDetail = await this._client?.searchContact([ roomId ]) as ContactPayload | undefined
+    if (roomDetail && roomDetail.wxid) {
+      await this._updateContactCache(roomDetail as ContactPayload)
+      return roomDetail
+    }
+    return {
+      wxNum: '',
+      wxid: roomId || '',
+      name: '',
+      sex: 0,
+      alias: '',
+      province: '',
+      city: '',
+      country: '',
+      avatar: '',
+      description: '',
+      labelIdlist: '',
+      scene: '',
+      sign: '',
+      snsBgImg: '',
+    }
+  }
+
   // 刷新用户信息
   private async _refreshContact (wxid: string, isFriend?: number): Promise<ContactPayload | undefined> {
+    if (isRoomId(wxid)) {
+      const res = await this._refreshRoomInfo(wxid)
+      return res
+    }
     const contact = await this._client?.searchContactDetail([ wxid ]) as ContactPayload | undefined
     // may return contact with empty payload, empty username, nickname, etc.
     if (contact && !contact.wxid) {
@@ -1790,16 +1822,12 @@ class PuppetMatrix extends PUPPET.Puppet {
   }
 
   // @ts-ignore
-  public async syncContact () {
+  public async syncContact (init?: boolean) {
     if (!this.currentUserId) {
       throw new Error('Can not sync contact before login')
     }
     log.info('syncContact')
-    await this._client!.syncContact()
-    await this._client?.getGroupList(1, 100)
-    await this._client?.getContactList(1, 100)
-    await this._client?.getOpenImContactList(1, 100)
-    await this._client?.getOfficeList(1, 100)
+    await this._client!.syncContact(init)
   }
 
 }

package/src/utils/normalize-filebox.ts

@@ -1,6 +1,3 @@
-import type {
-  FileBox,
-}                     from 'file-box'
 import {
   FileBoxType,
   FileBoxInterface,
@@ -64,27 +61,6 @@ const canPassthrough = (fileBox: FileBoxInterface) => {
 
 }
 
-const normalizeFileBoxUuid = (FileBoxUuid: typeof FileBox) => async (fileBox: FileBoxInterface) => {
-  if (canPassthrough(fileBox)) {
-    return fileBox
-  }
-
-  const stream = await fileBox.toStream()
-
-  const uuid = await FileBoxUuid
-    .fromStream(stream, fileBox.name)
-    .toUuid()
-
-  const uuidFileBox = FileBoxUuid.fromUuid(uuid, {
-    md5  : fileBox.md5,
-    name : fileBox.name,
-    size : fileBox.size,
-  })
-
-  return uuidFileBox
-}
-
 export {
   canPassthrough,
-  normalizeFileBoxUuid,
 }