@borutowaileys/library v6.12.42

@borutowaileys/library

## What's New

- **May 2025:** Pairing code issues fixed with full support for the latest WhatsApp Web protocol. UPDATED The last protocol used by whatsapp to ensure the best compatibility Have Fun

GitHub Repository: https://github.com/gyovannyvpn123/borutowaileys-library.git

🚀 Features

• Multi-Device Support: Connect across multiple sessions seamlessly.
• Robust Messaging: Send and receive text, stickers, and rich media.
• Group Management: Create, schedule actions, and manage permissions.
• Advanced Media Handling: Compress, resize, watermark, and OCR.
• Code-Free Authentication: QR-less pairing for headless environments.
• Event-Driven Architecture: React to incoming messages, connection updates, and more.
• State Synchronization: Keep message history in sync across devices.
• Webhook Integrations: Push events to external services.
• Built-In Rate Limiter: Stay within WhatsApp’s limits to avoid blocks.
• Cache with TTL: In-memory storage with persistence and automatic expiration.

📦 Installation

npm install @borutowaileys/library

🏁 Quick Start

// index.cjs
// This is a simple WhatsApp bot using the @borutowaileys/library.
// It connects to WhatsApp Web using a QR code, asks for a phone number, and sends a test message.
// You can extend this script as much as you like — see comments below!

const {
  makeWASocket,
  useMultiFileAuthState,
  DisconnectReason,
  fetchLatestBaileysVersion,
  delay
} = require('@borutowaileys/library');

const readline = require('readline');
const qrcode = require('qrcode-terminal');

// 🔲 Show the QR code in the terminal so the user can scan it with WhatsApp
const displayQRCode = (qr) => {
  console.log('\n📷 Scan the QR code below using WhatsApp (Settings > Linked Devices > Link a device):\n');
  qrcode.generate(qr, { small: true });
};

// 📞 Ask user to enter a phone number to send a message to
const askPhoneNumber = () => {
  return new Promise((resolve) => {
    const rl = readline.createInterface({
      input: process.stdin,
      output: process.stdout
    });
    rl.question('\n📞 Enter a phone number to send a message (e.g. 123456789): ', (input) => {
      rl.close();
      resolve(input.trim());
    });
  });
};

// 🔄 Handle connection events and pairing
const waitForPairing = (sock) => {
  sock.ev.on('connection.update', async ({ connection, qr, lastDisconnect }) => {
    if (connection === 'close') {
      const reason = lastDisconnect?.error?.output?.statusCode;
      if (reason === DisconnectReason.loggedOut) {
        console.error('⚠️ You have been logged out. Please re-authenticate.');
        process.exit();
      } else {
        console.log('🔁 Trying to reconnect...');
        startBot(); // Restart connection
      }
    }

    if (qr) {
      displayQRCode(qr); // Show QR code
    }

    if (connection === 'open') {
      console.log('\n✅ Successfully connected to WhatsApp!');
      await delay(2000);

      // 📥 Ask for phone number and send message
      const phone = await askPhoneNumber();
      const jid = `${phone}@s.whatsapp.net`;

      await sock.sendMessage(jid, { text: '👋 Hello! This is a message from your Boruto bot.' });
      console.log(`📨 Message sent to ${phone}`);

      // 💡 You can extend this to send images, audio, or messages from files!
      // Example ideas:
      // - Read from a .txt file and send multiple messages
      // - Use a loop to send messages every X seconds
      // - Send to a group instead of a single contact
    }
  });
};

// 🚀 Start the WhatsApp bot
async function startBot() {
  const { version } = await fetchLatestBaileysVersion();
  const { state, saveCreds } = await useMultiFileAuthState('./auth');

  const sock = makeWASocket({
    version,
    auth: state,
    printQRInTerminal: false, // QR is printed manually using qrcode-terminal
    browser: ['Boruto', 'Termux', '1.0.0'],
  });

  sock.ev.on('creds.update', saveCreds);
  waitForPairing(sock);
}

// 🟢 Start everything
startBot();

🌟 Advanced Capabilities

Rate Limiting

Keep your bot safe from blocks by capping request rates.

const { createEnhancedSocket } = require('@borutowaileys/library');

const sock = createEnhancedSocket({
  rateLimiter: { maxRequests: 15, timeWindow: 60000 }
});

try {
  await sock.sendWithRateLimit(jid, { text: 'This message respects rate limits' });
} catch (err) {
  console.error(err.message);
}

Image Processing & OCR

Extract text and manipulate media in one place.

// Text extraction
const text = await sock.extractTextFromImage(imageBuffer);
console.log('Extracted text:', text);

// Compress, resize, watermark
const compressed = await sock.compressImage(imageBuffer, 80);
const resized    = await sock.resizeImage(imageBuffer, 800, 600);
const watermarked = await sock.addWatermark(imageBuffer, watermarkBuffer, { opacity: 0.5, x: 10, y: 10 });

Group Administration

Automate group creation, scheduling, and moderation.

// Create advanced group
const group = await sock.createGroupWithOptions(
  'My Awesome Group',
  ['123456789@s.whatsapp.net'],
  { description: 'Group for enthusiasts', picture: fs.readFileSync('icon.jpg'), restrict: true }
);

// Schedule an action
await sock.scheduleGroupAction(
  group.id,
  'message',
  Date.now() + 3600000,
  { message: { text: 'Scheduled announcement' } }
);

Webhook Integrations

Real-time events delivered to your services.

sock.setupWebhook('https://example.com/webhook', ['message.received', 'message.sent']);

await sock.sendMessage(jid, { text: 'Silent message' }, { silentWebhook: true });

sock.removeWebhook('https://example.com/webhook');

Built-In Caching

Fast in-memory store with TTL and persistence.

sock.cacheSet('user:1234', userData, 3600); // 1 hour
const data = sock.cacheGet('user:1234');
sock.cacheClear();

📖 Documentation

Explore the full API, guides, and examples in the docs folder or online at https://borutowaileys.dev/docs

⚖️ License

Released under the MIT License.