@iamrony777/baileys

Baileys - Typescript/Javascript WhatsApp Web API

About this Fork

The original repository was removed by its author and later taken over by WhiskeySockets. This current fork is based on that. I've only made additions such as custom stores for storing authentication, messages, etc., and merged a few pull requests. That's all.

If you encounter any issues after using this fork or any part of it, I recommend creating a new issue here rather than on WhiskeySocket's Discord server. AND EXPECT BUGS, LOTS OF BUGS (THIS IS UNSTABLE ASF)

NPM Package

Installation

Check .env.example first to setup databases

yarn install @iamrony777/baileys

or

yarn github:iamrony777/Baileys ## Directly from github repo

Then import your code using:

import makeWASocket, { ... } from '@iamrony777/baileys'

Connecting multi device (recommended)

I recommend to use Redis for storing auth data (as it is the fastest) and Mongo for storing chats, messages

WhatsApp provides a multi-device API that allows Baileys to be authenticated as a second WhatsApp client by scanning a QR code with WhatsApp on your phone.

import { MongoClient } from "mongodb";
import makeWASocket, {
  DisconnectReason,
  makeCacheableSignalKeyStore,
  makeMongoStore,
  useMongoDBAuthState,
} from "@iamrony777/baileys";
import { Boom } from "@hapi/boom";
import "dotenv/config";

async function connectToWhatsApp() {
  // MongoDB setup
  const mongo = new MongoClient(process.env.MONGODB_URL!, {
    socketTimeoutMS: 1_00_000,
    connectTimeoutMS: 1_00_000,
    waitQueueTimeoutMS: 1_00_000,
  });
  const authCollection = mongo.db("wpsessions").collection("auth");
  const { state, saveCreds } = await useMongoDBAuthState(authCollection);
  const store = makeMongoStore({ db: mongo.db("wpsessions"), autoDeleteStatusMessage: true });

  const sock = makeWASocket({
    auth: {
      creds: state.creds,
      /** caching makes the store faster to send/recv messages */
      keys: makeCacheableSignalKeyStore(state.keys),
    },

    // can provide additional config here
    printQRInTerminal: true,
  });

  // listen on events and update database
  store.bind(sock.ev);

  sock.ev.on("connection.update", async (update) => {
    const { connection, lastDisconnect } = update;
    if (connection === "close") {
      const shouldReconnect =
        (lastDisconnect?.error as Boom)?.output?.statusCode !==
        DisconnectReason.loggedOut;
      console.log(
        "connection closed due to ",
        lastDisconnect?.error,
        ", reconnecting ",
        shouldReconnect
      );
      // reconnect if not logged out
      if (shouldReconnect) {
        await mongo.close();
        connectToWhatsApp();
      }
    } else if (connection === "open") {
      console.log("opened connection");
      await sock.sendMessage(
        sock.user?.id!,
        {
          text: "Connected!",
        },
        { ephemeralExpiration: 1 * 60 }
      );
    }
  });

  sock.ev.on("messages.upsert", async (m) => {
    console.log(JSON.stringify(m, undefined, 2));

    // if message type is notify and not a protocol message
    if (
      m.type === "notify" &&
      !m.messages[0].message?.hasOwnProperty("protocolMessage")
    ) {
      console.log("replying to", m.messages[0].key.remoteJid);

      // await sock.sendMessage(m.messages[0].key.remoteJid!, {
      //   text: "Hello there!",
      // });
    }
  });

  sock.ev.on("creds.update", async () => {
    await saveCreds();
  });
}
// run in main file
connectToWhatsApp();

If the connection is successful, you will see a QR code printed on your terminal screen, scan it with WhatsApp on your phone and you'll be logged in!

Note: install qrcode-terminal using yarn add qrcode-terminal to auto-print the QR to the terminal.

Note: the code to support the legacy version of WA Web (pre multi-device) has been removed in v5. Only the standard multi-device connection is now supported. This is done as WA seems to have completely dropped support for the legacy version.

Note: I didn't add the search-by-contact-hash implementation by purpshell

Custom funtions added to this package

1. store?.getContactInfo(jid: string, socket: typeof makeWASocket)

if (events["contacts.update"]) {
  for (const update of events["contacts.update"]) {
    if (update.imgUrl === "changed") { // getting 
      const contact = await store?.getContactInfo(update.id!, sock);
      console.log(
        `contact ${contact?.name} ${contact?.id} has a new profile pic: ${contact?.imgUrl}`
      );
    }
  }
}

Everything besides store and auth connectors are same as the original repo.

Read here

Changelog

6.7.2 (2024-05-11)

Bug Fixes

• #681: Fixed import (credit to #611) (c218f37)
• enable viewOnce messages to quote (#736) (03f82f5)
• find platform type based on browser second argument (32533ed), closes #481 #228
• fix message content type detection (a07922b)
• fix pairing code (abe4256)
• inefficient method of extracting url from text (#741) (f5c1aff)
• master: final workflow fix (eb5eddd)
• master: fix lockfile (0792755)
• master: fix whiskeysockets publishing (649dee4)
• missing messages: revert to normal (#732) (9d2f9ed)
• missing-messages: linting and bug (c264633)
• missing-messages: linting fix (9d3dcfd)
• old_version in mobile connection (#722) (495bb67)
• quick test to diagnose working dir issue (b5e5239)
• retry: final commit: linting (767af0b)

Features

• Add max msg retry count (#572) (18990f8)
• add option for Windows browser (#303) (3fc5d4b)
• add support to ptvMessage in sendMessage method (#738) (111601b)
• auto version hash (#290) (6b4d917)
• fix-workflow: push to the 2 npm packages at the same time (#746) (098908d)
• If need approval to join the group in groupMetadata (#533) (c41be3a)
• memberAddMode and joinApprovalMode in groups.update (#532) (3efd3e0)
• Set in group settings memberAddMode and joinApprovalMode (#534) (408c007)

Bug Fixes

• Fix linting (cbffb29)