Adhiraj Singh
d0330d1863
This is a breaking change, 1. three events (chats.set, contacts.set, messages.set) are now just one `messaging-history.set` event 2. no need to debounce for app state sync 3. added a new "conditional" chat update to allow for correct app state sync despite not having the chat available on hand
87 lines
3.8 KiB
TypeScript
87 lines
3.8 KiB
TypeScript
import type { Boom } from '@hapi/boom'
|
|
import { proto } from '../../WAProto'
|
|
import { AuthenticationCreds } from './Auth'
|
|
import { WACallEvent } from './Call'
|
|
import { Chat, ChatUpdate, PresenceData } from './Chat'
|
|
import { Contact } from './Contact'
|
|
import { GroupMetadata, ParticipantAction } from './GroupMetadata'
|
|
import { MessageUpsertType, MessageUserReceiptUpdate, WAMessage, WAMessageKey, WAMessageUpdate } from './Message'
|
|
import { ConnectionState } from './State'
|
|
|
|
export type BaileysEventMap = {
|
|
/** connection state has been updated -- WS closed, opened, connecting etc. */
|
|
'connection.update': Partial<ConnectionState>
|
|
/** credentials updated -- some metadata, keys or something */
|
|
'creds.update': Partial<AuthenticationCreds>
|
|
/** set chats (history sync), everything is reverse chronologically sorted */
|
|
'messaging-history.set': {
|
|
chats: Chat[]
|
|
contacts: Contact[]
|
|
messages: WAMessage[]
|
|
isLatest: boolean
|
|
}
|
|
/** upsert chats */
|
|
'chats.upsert': Chat[]
|
|
/** update the given chats */
|
|
'chats.update': ChatUpdate[]
|
|
/** delete chats with given ID */
|
|
'chats.delete': string[]
|
|
/** presence of contact in a chat updated */
|
|
'presence.update': { id: string, presences: { [participant: string]: PresenceData } }
|
|
|
|
'contacts.upsert': Contact[]
|
|
'contacts.update': Partial<Contact>[]
|
|
|
|
'messages.delete': { keys: WAMessageKey[] } | { jid: string, all: true }
|
|
'messages.update': WAMessageUpdate[]
|
|
'messages.media-update': { key: WAMessageKey, media?: { ciphertext: Uint8Array, iv: Uint8Array }, error?: Boom }[]
|
|
/**
|
|
* add/update the given messages. If they were received while the connection was online,
|
|
* the update will have type: "notify"
|
|
* */
|
|
'messages.upsert': { messages: WAMessage[], type: MessageUpsertType }
|
|
/** message was reacted to. If reaction was removed -- then "reaction.text" will be falsey */
|
|
'messages.reaction': { key: WAMessageKey, reaction: proto.IReaction }[]
|
|
|
|
'message-receipt.update': MessageUserReceiptUpdate[]
|
|
|
|
'groups.upsert': GroupMetadata[]
|
|
'groups.update': Partial<GroupMetadata>[]
|
|
/** apply an action to participants in a group */
|
|
'group-participants.update': { id: string, participants: string[], action: ParticipantAction }
|
|
|
|
'blocklist.set': { blocklist: string[] }
|
|
'blocklist.update': { blocklist: string[], type: 'add' | 'remove' }
|
|
/** Receive an update on a call, including when the call was received, rejected, accepted */
|
|
'call': WACallEvent[]
|
|
}
|
|
|
|
export type BufferedEventData = {
|
|
historySets: {
|
|
chats: { [jid: string]: Chat }
|
|
contacts: { [jid: string]: Contact }
|
|
messages: { [uqId: string]: WAMessage }
|
|
empty: boolean
|
|
isLatest: boolean
|
|
}
|
|
chatUpserts: { [jid: string]: Chat }
|
|
chatUpdates: { [jid: string]: ChatUpdate }
|
|
chatDeletes: Set<string>
|
|
contactUpserts: { [jid: string]: Contact }
|
|
contactUpdates: { [jid: string]: Partial<Contact> }
|
|
messageUpserts: { [key: string]: { type: MessageUpsertType, message: WAMessage } }
|
|
messageUpdates: { [key: string]: WAMessageUpdate }
|
|
messageDeletes: { [key: string]: WAMessageKey }
|
|
messageReactions: { [key: string]: { key: WAMessageKey, reactions: proto.IReaction[] } }
|
|
messageReceipts: { [key: string]: { key: WAMessageKey, userReceipt: proto.IUserReceipt[] } },
|
|
groupUpdates: { [jid: string]: Partial<GroupMetadata> }
|
|
}
|
|
|
|
export type BaileysEvent = keyof BaileysEventMap
|
|
|
|
export interface BaileysEventEmitter {
|
|
on<T extends keyof BaileysEventMap>(event: T, listener: (arg: BaileysEventMap[T]) => void): void
|
|
off<T extends keyof BaileysEventMap>(event: T, listener: (arg: BaileysEventMap[T]) => void): void
|
|
removeAllListeners<T extends keyof BaileysEventMap>(event: T): void
|
|
emit<T extends keyof BaileysEventMap>(event: T, arg: BaileysEventMap[T]): boolean
|
|
} |