vynect/venom
Venom
Venom is a TypeScript library for building automated bots that interact with WhatsApp. It provides a complete toolkit for programmatically managing chats, groups, and messages by bridging into the WhatsApp Web protocol through WebSocket communication. The library handles authentication via QR code scanning, session persistence to avoid repeated logins, and real-time event listening for message delivery, edits, deletions, and connection state changes.
The library offers a command-based routing system that directs incoming messages to handler functions based on pattern matching, alongside an event-driven pipeline for processing messages through middleware. It includes group state management for tracking membership and roles, multi-format media encoding for sending images, videos, documents, and audio, and a polling-free connection monitor that uses WebSocket keep-alives. Session credentials can be saved and restored from local storage to maintain persistent connections.
Venom supports sending and receiving text, media, and interactive messages such as polls, list menus, and buttons. It provides tools for managing group settings including creation, participant control, and admin roles, as well as chat organization features like pinning, archiving, muting, and deleting conversations. The library also includes device management capabilities for monitoring connection state, battery level, and app version, along with profile management for updating status, display name, and profile picture.
Features
- WhatsApp Bot Frameworks - Builds automated bots for WhatsApp to handle customer service, media sending, and message processing without manual intervention.
- WhatsApp Group - Creates and manages WhatsApp groups by adding or removing participants, promoting admins, and updating group settings.
- Group Settings Management - Creates groups, adds or removes participants, promotes or demotes admins, and changes group descriptions to control group membership.
- WhatsApp Session Persisters - Saves and restores WhatsApp authentication credentials to avoid repeated QR code scans.
- WhatsApp Messaging Integrations - Sends and receives text, media, and interactive messages programmatically through WhatsApp to automate communication workflows.
- Message Handlers - Implements an event-driven system for listening to incoming messages and triggering automated responses.
- Text Message Senders - Sends text messages to contacts or groups programmatically without manual intervention.
- WebSocket Protocol Bridges - Interacts with WhatsApp Web by intercepting and injecting WebSocket messages to emulate a browser client session.
- Messaging Event Callbacks - Triggers callbacks when messages are sent, edited, deleted, or when their delivery status changes to react in real time.
- WhatsApp Interaction Handlers - Processes incoming WhatsApp messages, commands, or events in real time to automate replies.
- WhatsApp Message Receptions - Listens for and processes new WhatsApp messages as they arrive in real time.
- WhatsApp Text Senders - Sends plain text messages to any contact or group using the chat identifier.
- WhatsApp Session Lifecycles - Manages WhatsApp session lifecycles including QR code login, connection state, and session persistence.
- WhatsApp Session Initiations - Manages WhatsApp device connections with QR code login, session persistence, and connection state monitoring.
- Persistent Token Authenticators - Saves and restores authentication credentials from a local store to avoid repeated QR code scans.
- Event-Driven Messaging Systems - Processes messages through a chain of event listeners and middleware for real-time automation.
- WhatsApp Event Listeners - Listening to real-time WhatsApp events such as message delivery, edits, deletions, and connection state changes to trigger automated responses.
- Pattern-Matching Routers - Routes incoming messages to handler functions using pattern matching for automated replies.
- Group Managers - Ships a dedicated component for creating and managing WhatsApp groups with participant and admin controls.
- Chat Media Senders - Sends images, videos, audio files, documents, and stickers to contacts or groups.
- Media Senders - Provides a utility for sending images, videos, documents, and audio files to WhatsApp contacts and groups.
- Media Payload Encoders - Encodes images, videos, documents, and audio into WhatsApp-compatible binary payloads for transmission.
- Chat Organization - Pins, archives, mutes, deletes, or clears chats and marks messages as unseen to keep the conversation list tidy.
- In-Memory Group State Trackers - Maintains an in-memory representation of group membership and roles for administrative actions.
- WebSocket Keep-Alive Monitors - Uses WebSocket keep-alive and event callbacks to track connection state without periodic polling.
- Chat Message Retrieval - Fetches all chats, contacts, groups, and messages including unread and archived items to review past conversations.
- State Change Monitoring - Monitors connection state transitions and stream status to detect conflicts or disconnections and respond accordingly.
- WhatsApp Interactive Senders - Sends polls, list menus, and buttons with reply options to engage recipients in structured conversations.
- Chat - Transmits images, videos, documents, or audio files to chats through the bot interface.
