mirror of
https://github.com/FranP-code/Baileys.git
synced 2025-10-13 00:32:22 +00:00
Rewrite for extensibility & compactness
-This is a break from previous versions unfortunately -Connecting is now a promise -Chats, contacts & previously unread messages are supplied on connection -Groups! -Message confirmations are more reliable -Timeout queries & connections
This commit is contained in:
Adhiraj
282
WhatsAppWeb.js
282
WhatsAppWeb.js
@@ -1,19 +1,9 @@
|
||||
const BinaryCoding = require('./binary_coding/binary_encoder.js')
|
||||
|
||||
class WhatsAppWeb {
|
||||
|
||||
static version = [0,4,1296] // the version of WhatsApp Web we're telling the servers we are
|
||||
static browserDescriptions = ["Baileys", "Baileys"]
|
||||
|
||||
static Status = {
|
||||
notConnected: 0,
|
||||
connecting: 1,
|
||||
creatingNewConnection: 3,
|
||||
loggingIn: 4,
|
||||
connected: 5
|
||||
}
|
||||
|
||||
// set of statuses visible to other people; see updatePresence() in WhatsAppWeb.Send
|
||||
/**
|
||||
* set of statuses visible to other people; see updatePresence() in WhatsAppWeb.Send
|
||||
*/
|
||||
static Presence = {
|
||||
available: "available", // "online"
|
||||
unavailable: "unavailable", // "offline"
|
||||
@@ -21,13 +11,17 @@ class WhatsAppWeb {
|
||||
recording: "recording", // "recording..."
|
||||
paused: "paused" // I have no clue
|
||||
}
|
||||
// set of statuses visible to other people; see updatePresence() in WhatsAppWeb.Send
|
||||
/**
|
||||
* Status of a message sent or received
|
||||
*/
|
||||
static MessageStatus = {
|
||||
sent: "sent",
|
||||
received: "received",
|
||||
read: "read"
|
||||
}
|
||||
// set of message types that are supported by the library
|
||||
/**
|
||||
* set of message types that are supported by the library
|
||||
*/
|
||||
static MessageType = {
|
||||
text: "conversation",
|
||||
image: "imageMessage",
|
||||
@@ -35,57 +29,113 @@ class WhatsAppWeb {
|
||||
sticker: "stickerMessage",
|
||||
document: "documentMessage",
|
||||
extendedText: "extendedTextMessage"
|
||||
}
|
||||
/**
|
||||
* Tells us what kind of message it is
|
||||
*/
|
||||
static MessageStubTypes = {
|
||||
20: "addedToGroup",
|
||||
32: "leftGroup",
|
||||
39: "createdGroup"
|
||||
}
|
||||
|
||||
constructor() {
|
||||
this.conn = null // the websocket connection
|
||||
|
||||
this.authInfo = null // the auth info used to extablish new connections & restore connections
|
||||
|
||||
this.userMetaData = null // metadata of the user i.e. name, phone number, phone stats
|
||||
this.chats = {} // all chats of the user, mapped by the user ID
|
||||
this.msgCount = 0 // number of messages sent to the server; required field for sending messages etc.
|
||||
this.autoReconnect = true // reconnect automatically after an unexpected disconnect
|
||||
this.lastSeen = null // updated by sending a keep alive request to the server, and the server responds with our updated last seen
|
||||
|
||||
// object to hold the event handlers
|
||||
this.handlers = {
|
||||
onError: null,
|
||||
onConnected: null,
|
||||
presenceUpdated: null,
|
||||
onDisconnect: null,
|
||||
onUnreadMessage: null,
|
||||
gotContact: null,
|
||||
onMessageStatusChanged: null
|
||||
}
|
||||
|
||||
/** The version of WhatsApp Web we're telling the servers we are */
|
||||
this.version = [0,4,1296]
|
||||
this.browserDescriptions = ["Baileys", "Baileys"]
|
||||
/** The websocket connection
|
||||
* @private
|
||||
*/
|
||||
this.conn = null
|
||||
/** Data structure of tokens & IDs used to establish one's identiy to WhatsApp Web */
|
||||
this.authInfo = {
|
||||
clientID: null,
|
||||
serverToken: null,
|
||||
clientToken: null,
|
||||
encKey: null,
|
||||
macKey: null
|
||||
}
|
||||
/** Metadata like WhatsApp id, name set on WhatsApp etc. */
|
||||
this.userMetaData = {id: null, name: null, phone: null}
|
||||
/** @private */
|
||||
this.msgCount = 0 // (epoch) number of messages sent to the server; required field for sending messages etc.
|
||||
/** Shoud reconnect automatically after an unexpected disconnect */
|
||||
this.autoReconnect = true //
|
||||
/** @private */
|
||||
this.lastSeen = null // updated by sending a keep alive request to the server, and the server responds with our updated last seen
|
||||
/** Log messages that are not handled, so you can debug & see what custom stuff you can implement */
|
||||
this.logUnhandledMessages = false
|
||||
/** @private */
|
||||
this.callbacks = {}
|
||||
|
||||
this.encoder = new BinaryCoding.Encoder()
|
||||
this.decoder = new BinaryCoding.Decoder()
|
||||
|
||||
this.status = WhatsAppWeb.Status.notConnected
|
||||
}
|
||||
// error is a json array: [errorCode, "error description", optionalDescription]
|
||||
gotError (error) {
|
||||
this.handlers.onError(error) // tell the handler, we got an error
|
||||
}
|
||||
// called when established a connection to the WhatsApp servers successfully
|
||||
didConnectSuccessfully () {
|
||||
console.log("connected successfully")
|
||||
|
||||
this.status = WhatsAppWeb.Status.connected // update our status
|
||||
this.lastSeen = new Date() // set last seen to right now
|
||||
this.startKeepAliveRequest() // start sending keep alive requests (keeps the WebSocket alive & updates our last seen)
|
||||
|
||||
if (this.reconnectLoop) { // if we connected after being disconnected
|
||||
clearInterval(this.reconnectLoop) // kill the loop to reconnect us
|
||||
} else if (this.handlers.onConnected) { // if we connected for the first time, i.e. not after being disconnected
|
||||
this.handlers.onConnected()
|
||||
}
|
||||
}
|
||||
// base 64 encode the authentication credentials and return them, these can then be saved used to login again
|
||||
// see login () in WhatsAppWeb.Session
|
||||
this.decoder = new BinaryCoding.Decoder()
|
||||
|
||||
this.unexpectedDisconnect = (err) => { this.close () }
|
||||
}
|
||||
/**
|
||||
* Set the callback for unexpected disconnects
|
||||
* @param {function(object)} callback
|
||||
*/
|
||||
setOnUnexpectedDisconnect (callback) {
|
||||
this.unexpectedDisconnect = (err) => {
|
||||
this.close ()
|
||||
callback (err)
|
||||
}
|
||||
}
|
||||
/**
|
||||
* Set the callback for message status updates (when a message is delivered, read etc.)
|
||||
* @param {function(object)} callback
|
||||
*/
|
||||
setOnMessageStatusChange (callback) {
|
||||
const func = (json) => {
|
||||
json = json[1]
|
||||
var ids = json.id
|
||||
if (json.cmd === "ack") {
|
||||
ids = [json.id]
|
||||
}
|
||||
const ackTypes = [
|
||||
WhatsAppWeb.MessageStatus.sent,
|
||||
WhatsAppWeb.MessageStatus.received,
|
||||
WhatsAppWeb.MessageStatus.read
|
||||
]
|
||||
const data = {
|
||||
from: json.from,
|
||||
to: json.to,
|
||||
participant: json.participant,
|
||||
timestamp: new Date (json.t*1000),
|
||||
ids: ids,
|
||||
type: ackTypes[json.ack-1] ?? "unknown (" + json.ack + ")"
|
||||
}
|
||||
callback (data)
|
||||
}
|
||||
this.registerCallback ("Msg", func)
|
||||
this.registerCallback ("MsgInfo", func)
|
||||
}
|
||||
/**
|
||||
* Set the callback for new/unread messages, if someone sends a message, this callback will be fired
|
||||
* @param {function(object)} callback
|
||||
*/
|
||||
setOnUnreadMessage (callback) {
|
||||
this.registerCallback (["action", "add:relay", "message"], (json) => {
|
||||
const message = json[2][0][2]
|
||||
if (!message.key.fromMe) { // if this message was sent to us, notify
|
||||
callback (message)
|
||||
}
|
||||
})
|
||||
}
|
||||
/**
|
||||
* Set the callback for presence updates; if someone goes offline/online, this callback will be fired
|
||||
* @param {function(object)} callback
|
||||
*/
|
||||
setOnPresenceUpdate (callback) {
|
||||
this.registerCallback ("Presence", (json) => callback(json[1]))
|
||||
}
|
||||
/**
|
||||
* base 64 encode the authentication credentials and return them
|
||||
* these can then be used to login again by passing the object to the connect () function.
|
||||
* @see connect () in WhatsAppWeb.Session
|
||||
*/
|
||||
base64EncodedAuthInfo () {
|
||||
return {
|
||||
clientID: this.authInfo.clientID,
|
||||
@@ -93,14 +143,114 @@ class WhatsAppWeb {
|
||||
clientToken: this.authInfo.clientToken,
|
||||
encKey: this.authInfo.encKey.toString('base64'),
|
||||
macKey: this.authInfo.macKey.toString('base64')
|
||||
}
|
||||
}
|
||||
}
|
||||
log (text) {
|
||||
console.log ("[Baileys] " + text)
|
||||
}
|
||||
}
|
||||
|
||||
/* import the rest of the code */
|
||||
require("./WhatsAppWeb.Session.js")(WhatsAppWeb)
|
||||
require("./WhatsAppWeb.Recv.js")(WhatsAppWeb)
|
||||
require("./WhatsAppWeb.Send.js")(WhatsAppWeb)
|
||||
require("./WhatsAppWeb.Query")(WhatsAppWeb)
|
||||
/* Import the rest of the code */
|
||||
|
||||
const recv = require("./WhatsAppWeb.Recv")
|
||||
/** Called when a message is recieved on the socket */
|
||||
WhatsAppWeb.prototype.onMessageRecieved = recv.onMessageRecieved
|
||||
/** The type of notification one recieved */
|
||||
WhatsAppWeb.prototype.getNotificationType = recv.getNotificationType
|
||||
/** Register for a callback for a certain function, will cancel automatically after one execution */
|
||||
WhatsAppWeb.prototype.registerCallbackOneTime = recv.registerCallbackOneTime
|
||||
/** Register for a callback for a certain function */
|
||||
WhatsAppWeb.prototype.registerCallback = recv.registerCallback
|
||||
/** Cancel all further callback events associated with the given parameters */
|
||||
WhatsAppWeb.prototype.deregisterCallback = recv.deregisterCallback
|
||||
/** Wait for a message with a certain tag to be received */
|
||||
WhatsAppWeb.prototype.waitForMessage = recv.waitForMessage
|
||||
/** Decode a media message (video, image, document, audio) & save it to the given file */
|
||||
WhatsAppWeb.prototype.decodeMediaMessage = recv.decodeMediaMessage
|
||||
|
||||
const session = require("./WhatsAppWeb.Session")
|
||||
WhatsAppWeb.prototype.connect = session.connect
|
||||
WhatsAppWeb.prototype.beginAuthentication = session.beginAuthentication
|
||||
WhatsAppWeb.prototype.validateNewConnection = session.validateNewConnection
|
||||
WhatsAppWeb.prototype.respondToChallenge = session.respondToChallenge
|
||||
WhatsAppWeb.prototype.generateKeysForAuth = session.generateKeysForAuth
|
||||
WhatsAppWeb.prototype.startKeepAliveRequest = session.startKeepAliveRequest
|
||||
WhatsAppWeb.prototype.logout = session.logout
|
||||
WhatsAppWeb.prototype.close = session.close
|
||||
|
||||
const send = require("./WhatsAppWeb.Send")
|
||||
/** Send a read receipt to the given ID for a certain message */
|
||||
WhatsAppWeb.prototype.sendReadReceipt = send.sendReadReceipt
|
||||
/** Tell someone about your presence -- online, typing, offline etc.
|
||||
* @see WhatsAppWeb.Presence for all presence types
|
||||
*/
|
||||
WhatsAppWeb.prototype.updatePresence = send.updatePresence
|
||||
/**
|
||||
* Send a text message
|
||||
* @param {string} id the JID of the person/group you're sending the message to
|
||||
* @param {string} txt the actual text of the message
|
||||
* @param {object} [quoted] the message you may wanna quote along with this message
|
||||
* @param {Date} [timestamp] optionally set the timestamp of the message in Unix time MS
|
||||
* @return {Promise<[object, object]>}
|
||||
*/
|
||||
WhatsAppWeb.prototype.sendTextMessage = send.sendTextMessage
|
||||
/**
|
||||
* Send a media message
|
||||
* @param {string} id the JID of the person/group you're sending the message to
|
||||
* @param {Buffer} buffer the buffer of the actual media you're sending
|
||||
* @param {string} mediaType the type of media, can be one of WhatsAppWeb.MessageType
|
||||
* @param {Object} [info] object to hold some metadata or caption about the media
|
||||
* @param {string} [info.caption] caption to go along with the media
|
||||
* @param {string} [info.thumbnail] base64 encoded thumbnail for the media
|
||||
* @param {string} [info.mimetype] specify the Mimetype of the media (required for document messages)
|
||||
* @param {boolean} [info.gif] whether the media is a gif or not, only valid for video messages
|
||||
* @param {Date} [timestamp] optionally set the timestamp of the message in Unix time MS
|
||||
* @return {Promise<[object, object]>}
|
||||
*/
|
||||
WhatsAppWeb.prototype.sendMediaMessage = send.sendMediaMessage
|
||||
/** @private */
|
||||
WhatsAppWeb.prototype.sendMessage = send.sendMessage
|
||||
/** Generic function for group related queries */
|
||||
WhatsAppWeb.prototype.groupQuery = send.groupQuery
|
||||
/** Query something from the WhatsApp servers */
|
||||
WhatsAppWeb.prototype.query = send.query
|
||||
/** @private */
|
||||
WhatsAppWeb.prototype.sendBinary = send.sendBinary
|
||||
/** @private */
|
||||
WhatsAppWeb.prototype.sendJSON = send.sendJSON
|
||||
/** @private */
|
||||
WhatsAppWeb.prototype.send = send.send
|
||||
|
||||
const query = require("./WhatsAppWeb.Query")
|
||||
/** Query whether a given number is registered on WhatsApp */
|
||||
WhatsAppWeb.prototype.isOnWhatsApp = query.isOnWhatsApp
|
||||
/** Check the presence of a given person (online, offline) */
|
||||
WhatsAppWeb.prototype.requestPresenceUpdate = query.requestPresenceUpdate
|
||||
/** Query the status of the person */
|
||||
WhatsAppWeb.prototype.getStatus = query.getStatus
|
||||
/** Get the URL to download the profile picture of a person/group */
|
||||
WhatsAppWeb.prototype.getProfilePicture = query.getProfilePicture
|
||||
/** Query all your contacts */
|
||||
WhatsAppWeb.prototype.getContacts = query.getContacts
|
||||
/** Query all the people/groups you have a chat history with */
|
||||
WhatsAppWeb.prototype.getChats = query.getChats
|
||||
/** Query whether your phone is still connected to this WhatsApp Web */
|
||||
WhatsAppWeb.prototype.isPhoneConnected = query.isPhoneConnected
|
||||
/** Load the conversation with a group or person */
|
||||
WhatsAppWeb.prototype.loadConveration = query.loadConveration
|
||||
/** Load the entire friggin conversation with a group or person */
|
||||
WhatsAppWeb.prototype.loadEntireConversation = query.loadEntireConversation
|
||||
/** Create a group */
|
||||
WhatsAppWeb.prototype.groupCreate = query.groupCreate
|
||||
/** Leave a group */
|
||||
WhatsAppWeb.prototype.groupLeave = query.groupLeave
|
||||
/** Add somebody to the group */
|
||||
WhatsAppWeb.prototype.groupAdd = query.groupAdd
|
||||
/** Remove somebody from the group */
|
||||
WhatsAppWeb.prototype.groupRemove = query.groupRemove
|
||||
/** Make somebody admin on the group */
|
||||
WhatsAppWeb.prototype.groupMakeAdmin = query.groupMakeAdmin
|
||||
/** Get the invite code of the group */
|
||||
WhatsAppWeb.prototype.groupInviteCode = query.groupInviteCode
|
||||
|
||||
module.exports = WhatsAppWeb
|
||||
Reference in New Issue
Block a user