@juzi/wechaty-puppet-whatsapp 1.0.0

package/src/schema/event-name.ts

@@ -0,0 +1,8 @@
+export enum EventName {
+  SCAN = 'SCAN',
+  LOGIN = 'LOGIN',
+  READY = 'READY',
+  LOGOUT = 'LOGOUT',
+  ERROR = 'ERROR',
+  RESET = 'RESET',
+}

package/src/schema/fix-type.d.ts

@@ -0,0 +1,63 @@
+import type { SetOptional } from 'type-fest'
+import type {  Contact, MessageMedia, Client as _Client } from '@juzi/whatsapp-web.js'
+declare module '@juzi/whatsapp-web.js' {
+  declare namespace WAWebJS {
+    export type CreateGroupResult = {
+      gid: {
+        server: string
+        user: string
+        _serialized: string
+      }
+      missingParticipants: Record<string, string>
+    }
+
+    export enum GroupNotificationTypes {
+      ADD = 'add',
+      INVITE = 'invite',
+      REMOVE = 'remove',
+      LEAVE = 'leave',
+      SUBJECT = 'subject',
+      DESCRIPTION = 'description',
+      PICTURE = 'picture',
+      ANNOUNCE = 'announce',
+      RESTRICT = 'restrict',
+      CREATE = 'create',
+    }
+
+    /** Message type buttons */
+    export class Buttons {
+
+      body: string | MessageMedia
+      buttons: Array<{ body: string}>
+      title?: string | null
+      footer?: string | null
+
+      constructor(body: string, buttons: Array<{ body: string}>, title?: string | null, footer?: string | null)
+
+    }
+    export interface Row {
+
+      title: string
+      description?: string
+    }
+    export interface Section {
+
+      title: string
+      rows: Row []
+    }
+
+    /** Message type List */
+    export class List {
+
+      body: string
+      buttonText: string
+      sections: Row []
+      title?: string | null
+      footer?: string | null
+      constructor(body: string, buttonText: string, sections: Array<any>, title?: string | null, footer?: string | null)
+
+    }
+
+  }
+  export = WAWebJS
+}

package/src/schema/index.ts

@@ -0,0 +1 @@
+export * from './event-name.js'

package/src/schema/whatsapp-interface.ts

@@ -0,0 +1,31 @@
+import WAWebJS from '@juzi/whatsapp-web.js'
+import type { Class } from 'type-fest'
+
+export enum GroupNotificationTypes {
+  ADD = 'add',
+  INVITE = 'invite',
+  REMOVE = 'remove',
+  LEAVE = 'leave',
+  SUBJECT = 'subject',
+  DESCRIPTION = 'description',
+  PICTURE = 'picture',
+  ANNOUNCE = 'announce',
+  RESTRICT = 'restrict',
+  CREATE = 'create',
+}
+
+// @ts-ignore
+export const ContactClass = WAWebJS.Contact as Class<WAWebJS.Contact>
+// @ts-ignore
+export const MessageClass = WAWebJS.Message as Class<WAWebJS.Message>
+
+export const {
+  LocalAuth,
+  DefaultOptions,
+  MessageMedia,
+  MessageAck,
+  MessageTypes,
+  WAState,
+  WhatsWebURL,
+  Client,
+} = WAWebJS

package/src/schema/whatsapp-type.ts

@@ -0,0 +1,79 @@
+import type { Location } from '@juzi/whatsapp-web.js'
+import type WhatsApp from '@juzi/whatsapp-web.js'
+import type { SetOptional } from 'type-fest'
+
+export type {
+  Client as WhatsAppClientType,
+  ClientInfo,
+  ClientInfoPhone,
+  ClientOptions,
+  ClientSession,
+  BatteryInfo,
+  CreateGroupResult,
+  // GroupNotification,
+  ChatTypes,
+  Events,
+  MessageAck as MessageAckType,
+  Status,
+  WAState as WAStateType,
+  MessageInfo,
+  InviteV4Data,
+  Message as WhatsAppMessage,
+  // MessageId,
+  Location,
+  Label,
+  MessageSendOptions,
+  MediaFromURLOptions,
+  // MessageMedia,
+  MessageContent,
+  Contact as WhatsAppContact,
+  ContactId,
+  BusinessContact,
+  PrivateContact,
+  Chat,
+  MessageSearchOptions,
+  ChatId,
+  PrivateChat,
+  GroupParticipant,
+  ChangeParticipantsPermissions,
+  ChangeGroupParticipants,
+  // GroupChat,
+  ProductMetadata,
+  Product,
+  Order,
+  Payment,
+  Call,
+  Buttons,
+  Row,
+  List,
+} from '@juzi/whatsapp-web.js'
+
+export interface MessageId {
+  fromMe: boolean,
+  remote: string | {
+    server: string
+    user: string
+    _serialized: string,
+  },
+  id: string,
+  _serialized: string,
+}
+export type WhatsAppContactPayload = {
+  avatar: string
+} & Omit<WhatsApp.Contact, 'getProfilePicUrl' | 'getChat' | 'getCountryCode' | 'getFormattedNumber' | 'block' | 'unblock' | 'getAbout'>
+export type WhatsAppMessagePayload = {mentionedIds: string[], location?:Location, orderId?: string, id: MessageId} & Omit<WhatsApp.Message, 'id' | 'orderId' | 'location' | 'mentionedIds' | 'acceptGroupV4Invite' | 'delete' | 'downloadMedia' | 'getChat' | 'getContact' | 'getMentions' | 'getQuotedMessage' | 'reply' | 'forward' | 'star' | 'unstar' | 'getInfo' | 'getOrder' | 'getPayment' | 'duration' | 'rawData' | 'reload'>
+export interface GroupMetadata {
+  desc: string
+  owner: WhatsApp.ContactId
+  participants: WhatsApp.GroupParticipant[]
+}
+export type GroupChat = {groupMetadata:GroupMetadata} & SetOptional<WhatsApp.GroupChat, 'owner'>
+export interface GroupNotificationId {
+  fromMe: boolean,
+  remote: string,
+  id: string,
+  participant?: string,
+  _serialized: string,
+}
+
+export type GroupNotification = {id: GroupNotificationId} & Omit<WhatsApp.GroupNotification, 'id'>

package/src/whatsapp/event-handler/group-event-handler.ts

@@ -0,0 +1,95 @@
+/* eslint-disable no-case-declarations */
+import {
+  GroupNotificationTypes,
+} from '../../schema/whatsapp-interface.js'
+import WhatsAppBase from '../whatsapp-base.js'
+
+import type * as PUPPET from '@juzi/wechaty-puppet'
+import type {
+  GroupNotification,
+} from '../../schema/whatsapp-type.js'
+import { log } from '../../config.js'
+import {
+  genRoomTopicEvent,
+  genRoomAnnounce,
+  genRoomJoinEvent,
+} from '../../helper/pure-function/room-event-generator.js'
+
+const PRE = 'GroupEventHandler'
+
+export default class GroupEventHandler extends WhatsAppBase {
+
+  public async onRoomJoin (notification: GroupNotification) {
+    log.info(PRE, `onRoomJoin(${JSON.stringify(notification)})`)
+    const roomId = notification.id.remote
+    const roomJoinPayload: PUPPET.payloads.EventRoomJoin = {
+      inviteeIdList: notification.recipientIds,
+      inviterId: notification.author,
+      roomId,
+      timestamp: notification.timestamp,
+    }
+    await this.manager.syncRoomMemberList(roomId)
+    this.emit('room-join', roomJoinPayload)
+  }
+
+  public async onRoomLeave (notification: GroupNotification) {
+    log.info(PRE, `onRoomLeave(${JSON.stringify(notification)})`)
+    const { id, recipientIds } = notification
+    const roomId = id.remote
+    const isLeaveSelf = id.fromMe && recipientIds.length === 1 &&  recipientIds[0] === this.getBotId()
+    const roomLeavePayload: PUPPET.payloads.EventRoomLeave = {
+      removeeIdList: notification.recipientIds,
+      removerId: notification.author || isLeaveSelf ? this.getBotId() : '',
+      roomId,
+      timestamp: notification.timestamp,
+    }
+    const cacheManager = await this.manager.getCacheManager()
+    await cacheManager.removeRoomMemberFromList(roomId, notification.recipientIds)
+    this.emit('room-leave', roomLeavePayload)
+  }
+
+  public async onRoomUpdate (notification: GroupNotification) {
+    log.info(PRE, `onRoomUpdate(${JSON.stringify(notification)})`)
+    const roomId = notification.id.remote
+    const cacheManager = await this.manager.getCacheManager()
+    let roomPayload = await cacheManager.getContactOrRoomRawPayload(roomId)
+
+    if (!roomPayload) {
+      const rawRoom = await this.manager.requestManager.getContactById(roomId)
+      const avatar = await rawRoom.getProfilePicUrl()
+      roomPayload = Object.assign(rawRoom, { avatar })
+      await cacheManager.setContactOrRoomRawPayload(roomId, roomPayload)
+    }
+    const type = notification.type
+    switch (type) {
+      case GroupNotificationTypes.SUBJECT:
+        const roomTopicPayload = genRoomTopicEvent(notification, roomPayload)
+        roomPayload.name = notification.body
+        await cacheManager.setContactOrRoomRawPayload(roomId, roomPayload)
+        this.emit('room-topic', roomTopicPayload)
+        break
+      case GroupNotificationTypes.DESCRIPTION:
+        const roomChat = await this.manager.getRoomChatById(roomId)
+        const roomMetadata = roomChat.groupMetadata
+        const description = roomMetadata.desc
+        const msgPayload = genRoomAnnounce(notification, description)
+        await this.manager.processMessage(msgPayload as any) // FIXME: how to use method of another class which extends from the same base class.
+        break
+      case GroupNotificationTypes.CREATE:
+        const members = await this.manager.syncRoomMemberList(roomId)
+        const roomJoinPayload = genRoomJoinEvent(notification, members)
+        this.emit('room-join', roomJoinPayload)
+        break
+      case GroupNotificationTypes.PICTURE:
+        const rawRoom = await this.manager.requestManager.getContactById(roomId)
+        const avatar = await rawRoom.getProfilePicUrl() || ''
+        const roomPayloadInCache = await cacheManager.getContactOrRoomRawPayload(roomId)
+        if (roomPayloadInCache) {
+          roomPayloadInCache.avatar = avatar
+          await cacheManager.setContactOrRoomRawPayload(roomId, roomPayloadInCache)
+        }
+        break
+    }
+  }
+
+}

package/src/whatsapp/event-handler/login-event-handler.ts

@@ -0,0 +1,210 @@
+/* eslint-disable no-case-declarations */
+import * as PUPPET from '@juzi/wechaty-puppet'
+import {
+  MIN_BATTERY_VALUE_FOR_LOGOUT,
+  DEFAULT_TIMEOUT,
+  log,
+  STRINGS,
+  LANGUAGE,
+} from '../../config.js'
+import { WA_ERROR_TYPE } from '../../exception/error-type.js'
+import WAError from '../../exception/whatsapp-error.js'
+import {
+  WAState,
+} from '../../schema/whatsapp-interface.js'
+import WhatsAppBase from '../whatsapp-base.js'
+
+import type {
+  WhatsAppContact,
+  BatteryInfo,
+  WAStateType,
+} from '../../schema/whatsapp-type.js'
+import {
+  batchProcess,
+  isContactId,
+  isRoomId,
+} from '../../helper/miscellaneous.js'
+
+const PRE = 'LoginEventHandler'
+
+export default class LoginEventHandler extends WhatsAppBase { // FIXME: I have no good idea for this class name.
+
+  protected loadingData: boolean = false
+  private qrcodeOrLoginCheckTimer?: NodeJS.Timer
+  private hasLogin: boolean = false
+  private lastQRCodeTime = Date.now()
+
+  public onQRCode (qrcode: string) {
+    log.info(PRE, `onQRCode(${qrcode})`)
+    // NOTE: This event will not be fired if a session is specified.
+    this.lastQRCodeTime = Date.now()
+    this.hasLogin = false
+    this.emit('scan', { qrcode, status: PUPPET.types.ScanStatus.Waiting })
+    this.checkQRCodeOrLoginEvent()
+  }
+
+  private checkQRCodeOrLoginEvent () {
+    if (this.qrcodeOrLoginCheckTimer) {
+      return
+    }
+    this.qrcodeOrLoginCheckTimer = setInterval(() => {
+      if (!this.hasLogin && Date.now() > this.lastQRCodeTime + 2 * 60 * 1000) {
+        this.emit('error', 'can not get scan or login event more than 2 mins')
+      }
+    }, 25 * 1000)
+  }
+
+  public clearQrcodeOrLoginCheckTimer () {
+    if (!this.qrcodeOrLoginCheckTimer) {
+      return
+    }
+    clearInterval(this.qrcodeOrLoginCheckTimer)
+  }
+
+  public async onAuthenticated () {
+    log.info(PRE, 'onAuthenticated()')
+  }
+
+  public async onAuthFailure (message: string) {
+    log.warn(PRE, 'auth_failure: %s', message)
+    // avoid reuse invalid session data
+    await this.clearSession()
+  }
+
+  public async onWhatsAppReady () {
+    log.verbose(PRE, 'onWhatsAppReady()')
+    this.hasLogin = true
+    this.clearQrcodeOrLoginCheckTimer()
+    const contactOrRoomList = await this.manager.syncContactOrRoomList()
+    await this.onLogin(contactOrRoomList)
+    await this.onReady(contactOrRoomList)
+    this.manager.startSchedule()
+  }
+
+  public async onLogin (contactOrRoomList: WhatsAppContact[]) {
+    log.verbose(PRE, 'onLogin()')
+    const whatsapp = this.getWhatsAppClient()
+    try {
+      this.botId = whatsapp.info.wid._serialized
+    } catch (error) {
+      throw WAError(WA_ERROR_TYPE.ERR_INIT, `Can not get bot id from WhatsApp client, current state: ${await whatsapp.getState()}`, JSON.stringify(error))
+    }
+    log.info(PRE, `WhatsApp Client Info: ${JSON.stringify(whatsapp.info)}`)
+
+    await this.manager.initCache(this.botId)
+    const cacheManager = await this.manager.getCacheManager()
+
+    const botSelf = await this.manager.requestManager.getContactById(this.botId)
+    await cacheManager.setContactOrRoomRawPayload(this.botId, {
+      ...botSelf,
+      avatar: await this.manager.requestManager.getAvatarUrl(this.botId),
+    })
+
+    const batchSize = 500
+    await batchProcess(batchSize, contactOrRoomList, async (contactOrRoom: WhatsAppContact) => {
+      const contactOrRoomId = contactOrRoom.id._serialized
+      const contactInCache = await cacheManager.getContactOrRoomRawPayload(contactOrRoomId)
+      if (contactInCache) {
+        return
+      }
+      const contactWithAvatar = Object.assign(contactOrRoom, { avatar: '' })
+      await cacheManager.setContactOrRoomRawPayload(contactOrRoomId, contactWithAvatar)
+    })
+
+    this.emit('login', this.botId)
+    log.info(PRE, `onLogin(${this.botId}})`)
+  }
+
+  public async onReady (contactOrRoomList: WhatsAppContact[]) {
+    log.verbose(PRE, 'onReady()')
+    if (this.loadingData) {
+      log.verbose(PRE, 'onReady() loading data are under process.')
+      return
+    }
+    this.loadingData = true
+    let friendCount = 0
+    let contactCount = 0
+    let roomCount = 0
+
+    const cacheManager = await this.manager.getCacheManager()
+    const batchSize = 100
+    await batchProcess(batchSize, contactOrRoomList, async (contactOrRoom: WhatsAppContact) => {
+      const contactOrRoomId = contactOrRoom.id._serialized
+      const avatar = await contactOrRoom.getProfilePicUrl()
+      const contactWithAvatar = Object.assign(contactOrRoom, { avatar })
+      if (isContactId(contactOrRoomId)) {
+        contactCount++
+        if (contactOrRoom.isMyContact) {
+          friendCount++
+        }
+        await cacheManager.setContactOrRoomRawPayload(contactOrRoomId, contactWithAvatar)
+      } else if (isRoomId(contactOrRoomId)) {
+        const memberList = await this.manager.syncRoomMemberList(contactOrRoomId)
+        if (memberList.length > 0) {
+          roomCount++
+          await cacheManager.setContactOrRoomRawPayload(contactOrRoomId, contactWithAvatar)
+        } else {
+          await cacheManager.deleteContactOrRoom(contactOrRoomId)
+          await cacheManager.deleteRoomMemberIdList(contactOrRoomId)
+        }
+      } else {
+        log.warn(PRE, `Unknown contact type: ${JSON.stringify(contactOrRoom)}`)
+      }
+      await this.manager.processHistoryMessages(contactOrRoom)
+    })
+
+    log.info(PRE, `onReady() all contacts and rooms are ready, friendCount: ${friendCount} contactCount: ${contactCount} roomCount: ${roomCount}`)
+    this.emit('ready')
+    this.loadingData = false
+  }
+
+  public async onLogout (reason: string = STRINGS[LANGUAGE].LOGOUT_REASON.DEFAULT) {
+    log.verbose(PRE, `onLogout(${reason})`)
+    await this.clearSession()
+    this.hasLogin = false
+    this.manager.stopSchedule()
+    this.emit('logout', this.getBotId(), reason as string)
+    this.baseStop()
+  }
+
+  public async onChangeState (state: WAStateType) {
+    log.info(PRE, `onChangeState(${JSON.stringify(state)})`)
+    if (!this.botId) {
+      throw WAError(WA_ERROR_TYPE.ERR_INIT, 'No login bot id.')
+    }
+
+    switch (state) {
+      case WAState.TIMEOUT:
+        this.pendingLogoutEmitTimer = setTimeout(() => {
+          this.emit('logout', this.getBotId(), STRINGS[LANGUAGE].LOGOUT_REASON.NETWORK_TIMEOUT_IN_PHONE)
+          this.pendingLogoutEmitTimer = undefined
+        }, DEFAULT_TIMEOUT.TIMEOUT_WAIT_CONNECTED)
+        break
+      case WAState.CONNECTED:
+        this.clearPendingLogoutEmitTimer()
+        this.emit('login', this.botId)
+        this.loadingData = false
+        const contactOrRoomList = await this.manager.syncContactOrRoomList()
+        await this.onReady(contactOrRoomList)
+        break
+      default:
+        break
+    }
+  }
+
+  /**
+   * unsupported events
+   * leave logs to for further dev
+  */
+  public async onChangeBattery (batteryInfo: BatteryInfo) {
+    log.verbose(PRE, `onChangeBattery(${JSON.stringify(batteryInfo)})`)
+    if (!this.botId) {
+      throw WAError(WA_ERROR_TYPE.ERR_INIT, 'No login bot id.')
+    }
+
+    if (batteryInfo.battery <= MIN_BATTERY_VALUE_FOR_LOGOUT && !batteryInfo.plugged) {
+      this.emit('logout', this.botId, STRINGS[LANGUAGE].LOGOUT_REASON.BATTERY_LOWER_IN_PHONE)
+    }
+  }
+
+}