@yui-bails/yui-bails 0.0.0-stage → 1.0.0

package/README.md

@@ -1,3 +1,1686 @@
-# Temporary Holding Version
+# Yui-Bails
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Una bails profesional para tu bot de WhatsApp 👑
+
+**Creador:** [AmilcarGit](https://github.com/AmilcarGit)
+
+<p align="center"><img alt="Yui-Bails" src="Media/logo.svg" height="90"/></p>
+
+<p align="center">
+  <img src="https://readme-typing-svg.demolab.com?font=Fira+Code&weight=800&size=28&duration=2600&pause=700&color=F72585&center=true&vCenter=true&width=700&height=55&lines=%E2%9A%A1+YUI+%C2%B7+BAILS+%E2%9A%A1" alt="yui bails" />
+</p>
+
+<p align="center">
+  <img src="https://readme-typing-svg.demolab.com?font=Fira+Code&weight=600&size=18&duration=2400&pause=500&color=00E5FF&center=true&vCenter=true&width=700&height=40&lines=%F0%9F%9A%80+Optimizado+a+fondo+%C2%B7+respuestas+en+ms+bajos;%F0%9F%94%98+Botones+nativos+%C2%B7+listas+%C2%B7+flows+incluidos;%F0%9F%A7%B9+Consola+limpia+%C2%B7+cero+ruido+de+prekeys;%E2%9C%82%EF%B8%8F+Sin+cosas+innecesarias+%C2%B7+puro+rendimiento" alt="features" />
+</p>
+
+<p align="center">
+  <img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="100%" alt="divider" />
+</p>
+
+<p align="center">
+  <a href="#-botones-nativos-incluidos"><img src="https://img.shields.io/badge/%F0%9F%94%98_BOTONES-NATIVOS-00e5ff?style=for-the-badge&labelColor=0d1117" alt="botones" /></a>
+  <a href="#-qué-trae-yui-bails"><img src="https://img.shields.io/badge/%E2%9A%A1_MODO-TURBO-f72585?style=for-the-badge&labelColor=0d1117" alt="turbo" /></a>
+  <a href="#-qué-trae-yui-bails"><img src="https://img.shields.io/badge/%F0%9F%A7%B9_CONSOLA-LIMPIA-9d4edd?style=for-the-badge&labelColor=0d1117" alt="consola" /></a>
+</p>
+
+<div align='center'>
+
+**Yui-Bails**, creada por **AmilcarGit**, es una librería WebSockets en TypeScript para la API de WhatsApp Web **optimizada para volar**: menos latencia, botones que sí se pintan, y una consola sin basura.
+
+</div>
+
+## ⚡ ¿Qué trae Yui-Bails?
+
+| | Mejora | Detalle |
+|---|---|---|
+| 🔘 | **Botones nativos** | `buttons` con respuesta rápida, URL, llamar, copiar código y menú desplegable — con el nodo `<biz>` que hace que **sí se rendericen** |
+| 📋 | **Listas** | `sections` para menús de lista en chats privados |
+| 🚀 | **Menos ms por mensaje** | Cache de dispositivos ×6 más duradero (se salta consultas al servidor antes de cada envío) |
+| 🧠 | **Cache de claves Signal ×3** | Menos lecturas de disco en cada cifrado/descifrado |
+| 🪶 | **Logger silencioso** | pino ya no serializa JSON en cada evento — CPU libre y panel limpio |
+| 🧹 | **Cero ruido de prekeys** | Adiós al spam de `Closing session: SessionEntry {...}` de libsignal |
+| 📡 | **Keep-alive 10s** | Detecta caídas de conexión 3× más rápido |
+| ⏱️ | **Sin bloqueos largos** | Reintentos de transacción 30s→2.5s peor caso · link preview con tope de 1.5s |
+| 🪄 | **Arranque ligero** | Sin sincronización de historial completo |
+| 🔄 | **Versión de WA Web al día** | Cada conexión pregunta a WhatsApp qué versión está sirviendo — se acabaron los `405`/`428` al vincular ([detalles](#whatsapp-web-version-fix-for-405--428-on-pairing)) |
+| ✨ | **Banner con flow** | Verás el banner de Yui-Bails apenas arranque |
+| 🧰 | **Helpers integrados** | `getSender`, `reply`, `react`, `sendButtons`, `sendList`, `sendPoll`, `downloadMedia` y conteo de votos de encuestas ([detalles](#-helpers-integrados)) |
+| 🛡️ | **Cola anti-ban** | Pausas aleatorias, límite por chat y "escribiendo…" automático ([detalles](#️-cola-anti-ban-sendqueue)) |
+| 📱 | **Multi-sesión** | Varios números de WhatsApp en un solo proceso con `makeSessionManager` ([detalles](#-multi-sesión-makesessionmanager)) |
+
+## 🔘 Botones nativos incluidos
+
+```js
+await sock.sendMessage(jid, {
+    text: 'Texto del mensaje', // con imagen/video usa "caption" en vez de "text"
+    footer: 'Pie de página',
+    title: 'Título',
+    buttons: [
+        { text: 'Respuesta rápida', id: '#menu' },
+        { text: 'Abrir web', url: 'https://ejemplo.com' },
+        { text: 'Llamar', call: '573001234567' },
+        { text: 'Copiar código', copy: 'CODIGO123' },
+        {
+            text: 'Desplegable',
+            sections: [{
+                title: 'Sección 1',
+                rows: [
+                    { title: 'Opción A', description: 'desc', id: '#a' },
+                    { title: 'Opción B', description: 'desc', id: '#b' }
+                ]
+            }]
+        }
+    ]
+}, { quoted: m })
+```
+
+Con imagen de cabecera:
+
+```js
+await sock.sendMessage(jid, {
+    image: { url: './imagen.jpg' }, // también video o document
+    caption: 'Texto del mensaje',
+    footer: 'Pie de página',
+    buttons: [{ text: 'Respuesta rápida', id: '#menu' }]
+})
+```
+
+Listas en chat privado:
+
+```js
+await sock.sendMessage(jid, {
+    text: 'Elige una opción',
+    title: 'Menú',
+    buttonText: 'Ver opciones',
+    sections: [{
+        title: 'Sección 1',
+        rows: [{ title: 'Opción A', description: 'desc', id: '#a' }]
+    }]
+})
+```
+
+La respuesta del usuario llega así (desenvuelve antes `msg.ephemeralMessage?.message || msg.viewOnceMessage?.message || msg`):
+
+```js
+// botón de respuesta rápida
+msg.buttonsResponseMessage?.selectedButtonId
+
+// desplegable / lista
+msg.listResponseMessage?.singleSelectReply?.selectedRowId
+
+// botones native flow (url/copiar/llamar no responden, son acciones directas)
+msg.interactiveResponseMessage?.nativeFlowResponseMessage?.paramsJson // -> JSON.parse(...).id
+```
+
+### ⚙️ Formato de botones (`buttonsFormat`)
+
+Cuando alguien toca un botón, **su teléfono** genera el mensaje de respuesta — no el bot. Según el formato con el que se enviaron los botones, esa respuesta se ve distinta para el resto del chat:
+
+| Formato | Los botones se pintan | La respuesta al tocar |
+|---|---|---|
+| `interactive` *(por defecto)* | En clientes modernos | `interactiveResponseMessage` — los clientes sin soporte muestran *"Recibiste un mensaje que no es compatible con tu versión de WhatsApp"* |
+| `buttons` | `ButtonsMessage` clásico | `buttonsResponseMessage` — **todos los clientes la ven como texto normal** |
+
+Si te molesta el aviso de "actualiza WhatsApp" que le sale a los demás, usa el formato clásico:
+
+```js
+// por mensaje
+await sock.sendMessage(jid, {
+    text: 'Elige una opción',
+    footer: 'Pie',
+    buttonsFormat: 'buttons',   // 👈
+    buttons: [{ text: 'Opción A', id: '#a' }]
+})
+```
+
+```bash
+# o globalmente, sin tocar los plugins
+YUI_BAILS_BUTTONS_FORMAT=buttons
+```
+
+Los botones de `url`, `call`, `copy` y `sections` no tienen equivalente clásico, así que siguen enviándose como native flow incluso en modo `buttons` (aunque esos no generan mensaje de respuesta, así que no producen el aviso).
+
+## 🧰 Helpers integrados
+
+Todo socket creado con `makeWASocket` ya los trae, no hay que importar nada.
+
+```js
+sock.ev.on('messages.upsert', async ({ messages }) => {
+  const msg = messages[0]
+
+  // Quién escribió: número real + id interno de WhatsApp (LID), aunque llegue solo uno
+  const sender = await sock.getSender(msg)
+  sender.number   // '51910227479'  (undefined si WhatsApp solo mandó el LID)
+  sender.id       // '269715926691844'  (id interno, parte de @lid)
+  sender.jid      // mejor jid para hablarle
+  sender.isGroup  // true / false
+  sender.is(['51910227479', '269715926691844'])  // ¿está en la lista? (ideal para owners)
+
+  await sock.reply(msg, 'Hola 👋')                 // responde citando
+  await sock.react(msg, '🔥')                      // reacciona
+
+  await sock.sendButtons(msg.key.remoteJid, {
+    text: 'Elige una opción',
+    buttons: [{ id: 'a', text: 'Opción A' }, { text: 'Web', url: 'https://example.com' }]
+  })
+
+  await sock.sendList(msg.key.remoteJid, {
+    text: 'Menú',
+    buttonText: 'Ver opciones',
+    sections: [{ title: 'Comandos', rows: [{ id: 'menu', title: 'Menú', description: 'Lista de comandos' }] }]
+  })
+
+  // Descarga en una sola llamada (también la del mensaje al que respondes)
+  const buffer = await sock.downloadMedia(msg)
+  const citada = await sock.downloadMedia(msg, { quoted: true })
+})
+```
+
+### Encuestas con conteo de votos
+
+```js
+const encuesta = await sock.sendPoll(jid, '¿Color favorito?', ['Rojo', 'Azul'])
+
+sock.ev.on('poll.votes', ({ pollName, votes, voter }) => {
+  // votes = [{ name: 'Rojo', voters: [...] }, { name: 'Azul', voters: [...] }]
+  console.log(pollName, votes.map(v => `${v.name}: ${v.voters.length}`))
+})
+
+sock.getPollVotes(encuesta.key) // resultado actual
+```
+
+> Para recibir los votos de encuestas que no envió este proceso, implementa `getMessage` en la config.
+
+## 🎛️ Botones avanzados
+
+### Carrusel de tarjetas
+
+Hasta 10 tarjetas que se deslizan, cada una con su imagen o video, textos y botones.
+
+```js
+await sock.sendCarousel(jid, {
+  text: 'Nuestro catálogo',
+  footer: 'Yui-Bails',
+  cards: [
+    {
+      image: { url: 'https://example.com/a.jpg' },
+      title: 'Plan básico',
+      body: 'Ideal para empezar',
+      buttons: [{ id: 'comprar_basico', text: 'Comprar' }, { text: 'Ver web', url: 'https://example.com' }]
+    },
+    { image: bufferDeImagen, title: 'Plan pro', body: 'Todo incluido', buttons: [{ id: 'comprar_pro', text: 'Comprar' }] }
+  ]
+})
+```
+
+### Responder a botones y menús sin complicarte
+
+```js
+// se ejecuta cuando alguien toca el botón o la fila con ese id (string, RegExp o función)
+sock.onButton('comprar_basico', async (msg, reply) => {
+  await sock.reply(msg, `Elegiste: ${reply.text}`)
+}, { once: true, onUsed: msg => sock.reply(msg, 'Este menú ya fue usado ✋') }) // solo el primer toque por menú
+
+sock.onList(/^fila_/, async (msg, reply) => sock.reply(msg, `Fila ${reply.id}`))
+sock.onReply(r => r.id.startsWith('x_'), handler) // botones y listas a la vez
+
+// esperar la siguiente respuesta de la misma persona en el mismo chat
+await sock.reply(msg, '¿Cómo te llamas?')
+const respuesta = await sock.awaitReply(msg, { timeoutMs: 30_000 })
+if (!respuesta) return sock.reply(msg, '⏱️ Se acabó el tiempo')
+```
+
+`onButton`, `onList` y `onReply` devuelven una función para quitar el manejador. `getReply(msg)` también está exportada si quieres leer el toque tú mismo.
+
+### Quitar los botones de un mensaje
+
+```js
+const enviado = await sock.sendButtons(jid, { text: 'Elige', buttons })
+// ...cuando ya lo usaron:
+await sock.disableButtons(enviado, '✅ Opción elegida')
+```
+
+`disableButtons` edita el mensaje para dejarlo como texto. WhatsApp puede negarse a editar algunos mensajes interactivos y entonces devuelve `false`; para garantizar un solo uso usa `{ once: true }` en `onButton`.
+
+### Icono de IA
+
+```js
+await sock.sendMessage(jid, { text: 'Hola, soy un bot', ai: true })
+```
+
+Marca el mensaje como enviado por un bot de negocio para que WhatsApp muestre el icono de IA. Que se muestre depende de la versión de WhatsApp de quien lo recibe.
+
+## 📊 Datos reales del bot
+
+Nada estimado: son contadores y mediciones de lo que hace tu bot.
+
+```js
+// Estado de la conexión, con un ping real a los servidores de WhatsApp
+const salud = await sock.health()
+// { state: 'open', uptimeMs, connectedMs, reconnects, queueSize,
+//   memory: { rssMB, heapUsedMB }, latencyMs: 142 }   ← latencyMs se mide en ese momento
+await sock.health({ ping: false }) // sin tocar la red
+
+// Contadores desde que arrancó (o desde resetStats)
+const stats = sock.getStats()
+// { since, sent, received, failed, sentByType: { text: 12, image: 2 }, receivedByType: {...} }
+
+// Hasta dónde llegó cada mensaje que enviaste
+sock.ev.on('message.status', ({ key, status, userJid }) => {
+  // status: 'sent' | 'delivered' | 'read' | 'played' | 'failed'
+  // en grupos llega uno por miembro (userJid)
+})
+sock.getMessageStatus(mensaje.key) // último estado conocido
+```
+
+`health()` no inventa nada: si no hay conexión devuelve `latencyMs: undefined` y el motivo en `pingError`. El estado de entrega solo llega para mensajes enviados por esta cuenta, y WhatsApp no informa "leído" si la otra persona desactivó las confirmaciones de lectura.
+
+## 👮 Permisos de grupo (con LID)
+
+Entienden los dos tipos de identidad de WhatsApp, así que funcionan aunque el grupo muestre LIDs en lugar de números.
+
+```js
+await sock.isAdmin(grupo, msg)            // msg, número, jid o el resultado de getSender
+await sock.isAdmin(grupo, '51910227479')
+await sock.isBotAdmin(grupo)
+const admins = await sock.getAdmins(grupo)
+
+await sock.kick(grupo, '51911111111')               // números o jids, uno o varios
+await sock.addMembers(grupo, ['51911111111', '51922222222'])
+await sock.promote(grupo, '51911111111')
+await sock.demote(grupo, '51911111111')
+```
+
+Usan la caché de grupos (se actualiza sola al cambiar miembros). Para expulsar, añadir o dar admin, el bot debe ser admin del grupo.
+
+## 🏷️ Menciones automáticas
+
+Escribe `@número` en un texto o pie de foto y se convierte en mención real; no hace falta armar `mentions`.
+
+```js
+await sock.sendMessage(grupo, { text: 'Hola @51910227479, bienvenido' })
+```
+
+Si el mensaje ya trae su propio `mentions`, se respeta. Solo cuentan números de 7 a 15 dígitos (`@nombre` no). Se desactiva con `autoMentions: false`.
+
+## 🧱 Estabilidad integrada
+
+Cosas que casi todos los bots acaban programando a mano, ya resueltas y activas por defecto:
+
+- **Sesión a prueba de cortes:** `useMultiFileAuthState` escribe `creds.json` en un archivo temporal y lo renombra, así un corte de luz o un cierre a mitad de guardado no lo deja a medias. Guarda además `creds.json.bak` (solo de archivos sanos) y, si el principal se daña, lo restaura solo.
+- **Reintentos sin configurar nada:** la librería guarda en memoria los últimos mensajes (`messageStore`, 1000 por defecto) para responder a los reintentos de WhatsApp y a los votos de encuestas. Tu `getMessage`, si lo pasas, tiene prioridad. `sock.messageStore` te da acceso.
+- **Caché de grupos:** la lista de miembros de cada grupo se guarda 5 minutos (se renueva sola si el grupo cambia), para no pedirla en cada envío y evitar límites. Si pasas tu propio `cachedGroupMetadata`, se respeta el tuyo.
+- **Resultado claro de cada envío:** `sock.sendSafe()` nunca lanza error y dice `sent`, `failed` o `unknown` (se agotó el tiempo o se cayó la conexión: puede que sí llegue; su `settled` da el resultado final).
+
+```js
+const sock = makeWASocket({
+  auth: state,
+  messageStore: { max: 2000 },                 // o false para desactivarlo
+  groupMetadataCache: { ttlMs: 10 * 60_000 }   // o false para desactivarla
+})
+
+const r = await sock.sendSafe(jid, 'hola', undefined, { timeoutMs: 15_000 })
+if (r.status === 'sent') console.log('enviado', r.message.key.id)
+if (r.status === 'unknown') console.log('quizá llegó:', (await r.settled).status)
+```
+
+## 🛡️ Cola anti-ban (`sendQueue`)
+
+Desactivada por defecto. Al activarla, todo lo que pase por `sock.sendMessage` (incluidos `reply`, `sendButtons`…) sale **uno a uno**, con pausas aleatorias, un límite por chat y el indicador "escribiendo…" proporcional al texto.
+
+```js
+const sock = makeWASocket({
+  auth: state,
+  sendQueue: true // o personaliza:
+  // sendQueue: { minDelayMs: 1000, maxDelayMs: 3000, perChatIntervalMs: 2000,
+  //              perChatLimit: { max: 15, windowMs: 60_000 }, typing: true }
+})
+
+sock.queue.size        // mensajes esperando
+sock.queue.clear()     // descarta los que faltan
+sock.sendMessageNow(jid, { text: 'urgente' }) // salta la cola
+```
+
+| Opción | Por defecto | Qué hace |
+|---|---|---|
+| `minDelayMs` / `maxDelayMs` | 800 / 2500 | Pausa aleatoria entre dos envíos |
+| `perChatIntervalMs` | 1500 | Mínimo entre dos mensajes al mismo chat |
+| `perChatLimit` | 20 por 60 s | Pasado el límite, los mensajes esperan |
+| `typing` | `true` | "escribiendo…" antes de los textos |
+| `typingMsPerChar` / `typingMinMs` / `typingMaxMs` | 30 / 500 / 3000 | Duración del "escribiendo…" |
+| `maxQueueSize` | 500 | Con la cola llena, `sendMessage` falla con 429 |
+
+Reduce el riesgo de bloqueo, pero no lo elimina: no escribas a números que no te conocen ni hagas spam.
+
+## 📱 Multi-sesión (`makeSessionManager`)
+
+Varios números de WhatsApp en un mismo proceso. Cada sesión guarda su login en `<authDir>/<id>/`, tiene su socket y se reconecta sola.
+
+```js
+import { makeSessionManager } from 'yui-bails'
+
+const sessions = makeSessionManager({
+  authDir: './sesiones',
+  config: { printQRInTerminal: false },
+  // se llama con cada socket nuevo (también tras reconectar)
+  setup: (sock, id) => {
+    sock.ev.on('messages.upsert', async ({ messages }) => {
+      await sock.reply(messages[0], `Hola desde la sesión ${id}`)
+    })
+  }
+})
+
+sessions.on('session.qr', ({ id, qr }) => console.log(id, 'escanea:', qr))
+sessions.on('session.pairing-code', ({ id, code }) => console.log(id, 'código:', code))
+sessions.on('session.open', ({ id, user }) => console.log(id, 'conectado como', user?.id))
+sessions.on('session.logged-out', ({ id }) => console.log(id, 'cerró sesión'))
+
+await sessions.start('ventas')                                  // QR
+await sessions.start('soporte', { pairingNumber: '51910227479' }) // código de vinculación
+await sessions.startAll()   // restaura todas las sesiones guardadas al arrancar
+
+sessions.get('ventas')      // el socket
+sessions.list()             // estado de cada sesión
+await sessions.stop('ventas')    // cierra pero conserva el login
+await sessions.logout('ventas')  // cierra sesión en WhatsApp y borra el login
+await sessions.stopAll()
+```
+
+Los ids solo admiten letras, números, `_`, `-` y `.` (son nombres de carpeta).
+
+## 🎛️ Variables de entorno
+
+| Variable | Efecto |
+|---|---|
+| `YUI_BAILS_BUTTONS_FORMAT=buttons` | Cambia el formato de botones a `ButtonsMessage` clásico (ver abajo) |
+| `YUI_BAILS_LOG_LEVEL=info` | Reactiva los logs internos (por defecto: silencio total) |
+| `YUI_BAILS_VERBOSE=1` | Muestra también el ruido de libsignal (desactiva el filtro) |
+| `YUI_BAILS_NO_BANNER=1` | Oculta el banner de arranque |
+
+<p align="center">
+  <img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="100%" alt="divider" />
+</p>
+
+<h2 align="center">📚 Guía de uso</h2>
+
+# Disclaimer
+This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with WhatsApp or any of its subsidiaries or its affiliates.
+The official WhatsApp website can be found at whatsapp.com. "WhatsApp" as well as related names, marks, emblems and images are registered trademarks of their respective owners.
+
+The maintainer of Yui-Bails does not in any way condone the use of this application in practices that violate the Terms of Service of WhatsApp. The maintainers of this application call upon the personal responsibility of its users to use this application in a fair way, as it is intended to be used.
+Use at your own discretion. Do not spam people with this. We discourage any stalkerware, bulk or automated messaging usage.
+
+##
+
+- Yui-Bails does not require Selenium or any other browser to be interface with WhatsApp Web, it does so directly using a **WebSocket**.
+- Not running Selenium or Chromium saves you like **half a gig** of ram :/
+- Yui-Bails supports interacting with the multi-device & web versions of WhatsApp.
+
+## Example
+
+Do check out & run [example.ts](Example/example.ts) to see an example usage of the library.
+The script covers most common use cases.
+To run the example script, download or clone the repo and then type the following in a terminal:
+1. ``` cd path/to/Yui-Bails ```
+2. ``` yarn ```
+3. ``` yarn example ```
+
+## Install
+
+Use the stable version (npm):
+```
+npm install yui-bails@npm:@yui-bails/yui-bails
+```
+The `yui-bails@npm:` part keeps the short name, so `import ... from 'yui-bails'` works.
+
+Use the edge version (no guarantee of stability, but latest fixes + features)
+```
+yarn add github:AmilcarGit/Yui-Bails
+```
+
+Then import your code using:
+```ts
+import makeWASocket from 'yui-bails'
+```
+
+# Index
+
+- [Connecting Account](#connecting-account)
+    - [Connect with QR-CODE](#starting-socket-with-qr-code)
+    - [Connect with Pairing Code](#starting-socket-with-pairing-code)
+    - [Receive Full History](#receive-full-history)
+- [Important Notes About Socket Config](#important-notes-about-socket-config)
+    - [Caching Group Metadata (Recommended)](#caching-group-metadata-recommended)
+    - [Improve Retry System & Decrypt Poll Votes](#improve-retry-system--decrypt-poll-votes)
+    - [Receive Notifications in Whatsapp App](#receive-notifications-in-whatsapp-app)
+
+- [Save Auth Info](#saving--restoring-sessions)
+- [Handling Events](#handling-events)
+    - [Example to Start](#example-to-start)
+    - [Decrypt Poll Votes](#decrypt-poll-votes)
+    - [Summary of Events on First Connection](#summary-of-events-on-first-connection)
+- [Implementing a Data Store](#implementing-a-data-store)
+- [Whatsapp IDs Explain](#whatsapp-ids-explain)
+- [Utility Functions](#utility-functions)
+- [Sending Messages](#sending-messages)
+    - [Non-Media Messages](#non-media-messages)
+        - [Text Message](#text-message)
+        - [Quote Message](#quote-message-works-with-all-types)
+        - [Mention User](#mention-user-works-with-most-types)
+        - [Forward Messages](#forward-messages)
+        - [Location Message](#location-message)
+        - [Contact Message](#contact-message)
+        - [Reaction Message](#reaction-message)
+        - [Pin Message](#pin-message)
+        - [Poll Message](#poll-message)
+    - [Sending with Link Preview](#sending-messages-with-link-previews)
+    - [Media Messages](#media-messages)
+        - [Gif Message](#gif-message)
+        - [Video Message](#video-message)
+        - [Audio Message](#audio-message)
+        - [Image Message](#image-message)
+        - [ViewOnce Message](#view-once-message)
+- [Modify Messages](#modify-messages)
+    - [Delete Messages (for everyone)](#deleting-messages-for-everyone)
+    - [Edit Messages](#editing-messages)
+- [Manipulating Media Messages](#manipulating-media-messages)
+    - [Thumbnail in Media Messages](#thumbnail-in-media-messages)
+    - [Downloading Media Messages](#downloading-media-messages)
+    - [Re-upload Media Message to Whatsapp](#re-upload-media-message-to-whatsapp)
+- [Reject Call](#reject-call)
+- [Send States in Chat](#send-states-in-chat)
+    - [Reading Messages](#reading-messages)
+    - [Update Presence](#update-presence)
+- [Modifying Chats](#modifying-chats)
+    - [Archive a Chat](#archive-a-chat)
+    - [Mute/Unmute a Chat](#muteunmute-a-chat)
+    - [Mark a Chat Read/Unread](#mark-a-chat-readunread)
+    - [Delete a Message for Me](#delete-a-message-for-me)
+    - [Delete a Chat](#delete-a-chat)
+    - [Star/Unstar a Message](#starunstar-a-message)
+    - [Disappearing Messages](#disappearing-messages)
+- [User Querys](#user-querys)
+    - [Check If ID Exists in Whatsapp](#check-if-id-exists-in-whatsapp)
+    - [Query Chat History (groups too)](#query-chat-history-groups-too)
+    - [Fetch Status](#fetch-status)
+    - [Fetch Profile Picture (groups too)](#fetch-profile-picture-groups-too)
+    - [Fetch Bussines Profile (such as description or category)](#fetch-bussines-profile-such-as-description-or-category)
+    - [Fetch Someone's Presence (if they're typing or online)](#fetch-someones-presence-if-theyre-typing-or-online)
+- [Change Profile](#change-profile)
+    - [Change Profile Status](#change-profile-status)
+    - [Change Profile Name](#change-profile-name)
+    - [Change Display Picture (groups too)](#change-display-picture-groups-too)
+    - [Remove display picture (groups too)](#remove-display-picture-groups-too)
+- [Groups](#groups)
+    - [Create a Group](#create-a-group)
+    - [Add/Remove or Demote/Promote](#addremove-or-demotepromote)
+    - [Change Subject (name)](#change-subject-name)
+    - [Change Description](#change-description)
+    - [Change Settings](#change-settings)
+    - [Leave a Group](#leave-a-group)
+    - [Get Invite Code](#get-invite-code)
+    - [Revoke Invite Code](#revoke-invite-code)
+    - [Join Using Invitation Code](#join-using-invitation-code)
+    - [Get Group Info by Invite Code](#get-group-info-by-invite-code)
+    - [Query Metadata (participants, name, description...)](#query-metadata-participants-name-description)
+    - [Join using groupInviteMessage](#join-using-groupinvitemessage)
+    - [Get Request Join List](#get-request-join-list)
+    - [Approve/Reject Request Join](#approvereject-request-join)
+    - [Get All Participating Groups Metadata](#get-all-participating-groups-metadata)
+    - [Toggle Ephemeral](#toggle-ephemeral)
+    - [Change Add Mode](#change-add-mode)
+- [Privacy](#privacy)
+    - [Block/Unblock User](#blockunblock-user)
+    - [Get Privacy Settings](#get-privacy-settings)
+    - [Get BlockList](#get-blocklist)
+    - [Update LastSeen Privacy](#update-lastseen-privacy)
+    - [Update Online Privacy](#update-online-privacy)
+    - [Update Profile Picture Privacy](#update-profile-picture-privacy)
+    - [Update Status Privacy](#update-status-privacy)
+    - [Update Read Receipts Privacy](#update-read-receipts-privacy)
+    - [Update Groups Add Privacy](#update-groups-add-privacy)
+    - [Update Default Disappearing Mode](#update-default-disappearing-mode)
+- [Broadcast Lists & Stories](#broadcast-lists--stories)
+    - [Send Broadcast & Stories](#send-broadcast--stories)
+    - [Query a Broadcast List's Recipients & Name](#query-a-broadcast-lists-recipients--name)
+- [Writing Custom Functionality](#writing-custom-functionality)
+    - [Enabling Debug Level in Yui-Bails Logs](#enabling-debug-level-in-yui-bails-logs)
+    - [How Whatsapp Communicate With Us](#how-whatsapp-communicate-with-us)
+    - [Register a Callback for Websocket Events](#register-a-callback-for-websocket-events)
+
+## Connecting Account
+
+WhatsApp provides a multi-device API that allows Yui-Bails to be authenticated as a second WhatsApp client by scanning a **QR code** or **Pairing Code** with WhatsApp on your phone.
+
+> [!NOTE]
+> **[Here](#example-to-start) is a simple example of event handling**
+
+> [!TIP]
+> **You can see all supported socket configs in the [SocketConfig type alias](src/Types) (Recommended)**
+
+### Starting socket with **QR-CODE**
+
+> [!TIP]
+> You can customize browser name if you connect with **QR-CODE**, with `Browser` constant, we have some browsers config, **see the [BrowsersMap type alias](src/Types)**
+
+```ts
+import makeWASocket from 'yui-bails'
+
+const sock = makeWASocket({
+    // can provide additional config here
+    browser: Browsers.ubuntu('My App'),
+    printQRInTerminal: true
+})
+```
+
+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!
+
+### Starting socket with **Pairing Code**
+
+
+> [!IMPORTANT]
+> Pairing Code isn't Mobile API, it's a method to connect Whatsapp Web without QR-CODE, you can connect only with one device, see [here](https://faq.whatsapp.com/1324084875126592/?cms_platform=web)
+
+The phone number can't have `+` or `()` or `-`, only numbers, you must provide country code
+
+```ts
+import makeWASocket from 'yui-bails'
+
+const sock = makeWASocket({
+    // can provide additional config here
+    printQRInTerminal: false //need to be false
+})
+
+if (!sock.authState.creds.registered) {
+    const number = 'XXXXXXXXXXX'
+    const code = await sock.requestPairingCode(number)
+    console.log(code)
+}
+```
+
+### Receive Full History
+
+1. Set `syncFullHistory` as `true`
+2. Yui-Bails, by default, use chrome browser config
+    - If you'd like to emulate a desktop connection (and receive more message history), this browser setting to your Socket config:
+
+```ts
+const sock = makeWASocket({
+    ...otherOpts,
+    // can use Windows, Ubuntu here too
+    browser: Browsers.macOS('Desktop'),
+    syncFullHistory: true
+})
+```
+
+## Important Notes About Socket Config
+
+### WhatsApp Web Version (fix for `405` / `428` on pairing)
+WhatsApp turns down the handshake of clients that announce an outdated web version, which shows up as a `405 Method Not Allowed` / `428` right when you try to get a QR or a pairing code.
+
+Yui-Bails solves it on its own: **every connection asks WhatsApp which web version it is serving right now** (`web.whatsapp.com/sw.js`, falling back to `check-update`) and connects with that one. No protobuf/platform spoofing involved — only the version.
+
+```ts
+// nothing to do: no `version` means "always the live one"
+const sock = makeWASocket({ auth: state })
+```
+
+- The fetched version is cached in memory for an hour and shared between sockets, so reconnecting costs no extra request. It is dropped automatically if WA answers `405`.
+- If WA can't be reached, the connection goes ahead with the version bundled in the library.
+- Passing `version` pins it and turns the sync off. To pin a fallback but still prefer the live version, set `syncWaWebVersion: true` as well:
+    ```ts
+    const sock = makeWASocket({
+        auth: state,
+        version: [2, 3000, 1035194821], // used only if WA can't be reached
+        syncWaWebVersion: true
+    })
+    ```
+- To opt out entirely, set `syncWaWebVersion: false`.
+
+### Caching Group Metadata (Recommended)
+- If you use yui-bails for groups, we recommend you to set `cachedGroupMetadata` in socket config, you need to implement a cache like this:
+
+    ```ts
+    const groupCache = new NodeCache({stdTTL: 5 * 60, useClones: false})
+
+    const sock = makeWASocket({
+        cachedGroupMetadata: async (jid) => groupCache.get(jid)
+    })
+
+    sock.ev.on('groups.update', async ([event]) => {
+        const metadata = await sock.groupMetadata(event.id)
+        groupCache.set(event.id, metadata)
+    })
+
+    sock.ev.on('group-participants.update', async (event) => {
+        const metadata = await sock.groupMetadata(event.id)
+        groupCache.set(event.id, metadata)
+    })
+    ```
+
+### Improve Retry System & Decrypt Poll Votes
+- If you want to improve sending message, retrying when error occurs and decrypt poll votes, you need to have a store and set `getMessage` config in socket like this:
+    ```ts
+    const sock = makeWASocket({
+        getMessage: async (key) => await getMessageFromStore(key)
+    })
+    ```
+
+### Receive Notifications in Whatsapp App
+- If you want to receive notifications in whatsapp app, set `markOnlineOnConnect` to `false`
+    ```ts
+    const sock = makeWASocket({
+        markOnlineOnConnect: false
+    })
+    ```
+## Saving & Restoring Sessions
+
+You obviously don't want to keep scanning the QR code every time you want to connect.
+
+So, you can load the credentials to log back in:
+```ts
+import makeWASocket, { useMultiFileAuthState } from 'yui-bails'
+
+const { state, saveCreds } = await useMultiFileAuthState('auth_info_yui')
+
+// will use the given state to connect
+// so if valid credentials are available -- it'll connect without QR
+const sock = makeWASocket({ auth: state })
+
+// this will be called as soon as the credentials are updated
+sock.ev.on('creds.update', saveCreds)
+```
+
+> [!IMPORTANT]
+> `useMultiFileAuthState` is a utility function to help save the auth state in a single folder, this function serves as a good guide to help write auth & key states for SQL/no-SQL databases, which I would recommend in any production grade system.
+
+> [!NOTE]
+> When a message is received/sent, due to signal sessions needing updating, the auth keys (`authState.keys`) will update. Whenever that happens, you must save the updated keys (`authState.keys.set()` is called). Not doing so will prevent your messages from reaching the recipient & cause other unexpected consequences. The `useMultiFileAuthState` function automatically takes care of that, but for any other serious implementation -- you will need to be very careful with the key state management.
+
+## Handling Events
+
+- Yui-Bails uses the EventEmitter syntax for events.
+They're all nicely typed up, so you shouldn't have any issues with an Intellisense editor like VS Code.
+
+> [!IMPORTANT]
+> **The events are in the [YuiEventMap type alias](src/Types)**, it's important you see all events
+
+You can listen to these events like this:
+```ts
+const sock = makeWASocket()
+sock.ev.on('messages.upsert', ({ messages }) => {
+    console.log('got messages', messages)
+})
+```
+
+### Example to Start
+
+> [!NOTE]
+> This example includes basic auth storage too
+
+> [!NOTE]
+> For reliable serialization of the authentication state, especially when storing as JSON, always use the BufferJSON utility.
+
+```ts
+import makeWASocket, { DisconnectReason, useMultiFileAuthState } from 'yui-bails'
+import { Boom } from '@hapi/boom'
+
+async function connectToWhatsApp () {
+    const { state, saveCreds } = await useMultiFileAuthState('auth_info_yui')
+    const sock = makeWASocket({
+        // can provide additional config here
+        auth: state,
+        printQRInTerminal: true
+    })
+    sock.ev.on('connection.update', (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) {
+                connectToWhatsApp()
+            }
+        } else if(connection === 'open') {
+            console.log('opened connection')
+        }
+    })
+    sock.ev.on('messages.upsert', event => {
+        for (const m of event.messages) {
+            console.log(JSON.stringify(m, undefined, 2))
+
+            console.log('replying to', m.key.remoteJid)
+            await sock.sendMessage(m.key.remoteJid!, { text: 'Hello Word' })
+        }
+    })
+
+    // to storage creds (session info) when it updates
+    sock.ev.on('creds.update', saveCreds)
+}
+// run in main file
+connectToWhatsApp()
+```
+
+> [!IMPORTANT]
+> In `messages.upsert` it's recommended to use a loop like `for (const message of event.messages)` to handle all messages in array
+
+### Decrypt Poll Votes
+
+- By default poll votes are encrypted and handled in `messages.update`
+- That's a simple example
+```ts
+sock.ev.on('messages.update', event => {
+    for(const { key, update } of event) {
+        if(update.pollUpdates) {
+            const pollCreation = await getMessage(key)
+            if(pollCreation) {
+                console.log(
+                    'got poll update, aggregation: ',
+                    getAggregateVotesInPollMessage({
+                        message: pollCreation,
+                        pollUpdates: update.pollUpdates,
+                    })
+                )
+            }
+        }
+    }
+})
+```
+
+- `getMessage` is a [store](#implementing-a-data-store) implementation (in your end)
+
+### Summary of Events on First Connection
+
+1. When you connect first time, `connection.update` will be fired requesting you to restart sock
+2. Then, history messages will be received in `messaging.history-set`
+
+## Implementing a Data Store
+
+- Yui-Bails does not come with a defacto storage for chats, contacts, or messages. However, a simple in-memory implementation has been provided. The store listens for chat updates, new messages, message updates, etc., to always have an up-to-date version of the data.
+
+> [!IMPORTANT]
+> I highly recommend building your own data store, as storing someone's entire chat history in memory is a terrible waste of RAM.
+
+It can be used as follows:
+
+```ts
+import makeWASocket, { makeInMemoryStore } from 'yui-bails'
+// the store maintains the data of the WA connection in memory
+// can be written out to a file & read from it
+const store = makeInMemoryStore({ })
+// can be read from a file
+store.readFromFile('./yui_store.json')
+// saves the state to a file every 10s
+setInterval(() => {
+    store.writeToFile('./yui_store.json')
+}, 10_000)
+
+const sock = makeWASocket({ })
+// will listen from this socket
+// the store can listen from a new socket once the current socket outlives its lifetime
+store.bind(sock.ev)
+
+sock.ev.on('chats.upsert', () => {
+    // can use 'store.chats' however you want, even after the socket dies out
+    // 'chats' => a KeyedDB instance
+    console.log('got chats', store.chats.all())
+})
+
+sock.ev.on('contacts.upsert', () => {
+    console.log('got contacts', Object.values(store.contacts))
+})
+
+```
+
+The store also provides some simple functions such as `loadMessages` that utilize the store to speed up data retrieval.
+
+## Whatsapp IDs Explain
+
+- `id` is the WhatsApp ID, called `jid` too, of the person or group you're sending the message to.
+    - It must be in the format ```[country code][phone number]@s.whatsapp.net```
+	    - Example for people: ```+19999999999@s.whatsapp.net```.
+	    - For groups, it must be in the format ``` 123456789-123345@g.us ```.
+    - For broadcast lists, it's `[timestamp of creation]@broadcast`.
+    - For stories, the ID is `status@broadcast`.
+
+## Utility Functions
+
+- `getContentType`, returns the content type for any message
+- `getDevice`, returns the device from message
+- `makeCacheableSignalKeyStore`, make auth store more fast
+- `downloadContentFromMessage`, download content from any message
+
+## Sending Messages
+
+- Send all types of messages with a single function
+    - **In the [AnyMessageContent type alias](src/Types) you can see all message contents supported, like text message**
+    - **In the [MiscMessageGenerationOptions type alias](src/Types) you can see all options supported, like quote message**
+
+    ```ts
+    const jid: string
+    const content: AnyMessageContent
+    const options: MiscMessageGenerationOptions
+
+    sock.sendMessage(jid, content, options)
+    ```
+
+### Non-Media Messages
+
+#### Text Message
+```ts
+await sock.sendMessage(jid, { text: 'hello word' })
+```
+
+#### Quote Message (works with all types)
+```ts
+await sock.sendMessage(jid, { text: 'hello word' }, { quoted: message })
+```
+
+#### Mention User (works with most types)
+- @number is to mention in text, it's optional
+```ts
+await sock.sendMessage(
+    jid,
+    {
+        text: '@12345678901',
+        mentions: ['12345678901@s.whatsapp.net']
+    }
+)
+```
+
+#### Forward Messages
+- You need to have message object, can be retrieved from [store](#implementing-a-data-store) or use a [message](src/Types) object
+```ts
+const msg = getMessageFromStore() // implement this on your end
+await sock.sendMessage(jid, { forward: msg }) // WA forward the message!
+```
+
+#### Location Message
+```ts
+await sock.sendMessage(
+    jid,
+    {
+        location: {
+            degreesLatitude: 24.121231,
+            degreesLongitude: 55.1121221
+        }
+    }
+)
+```
+#### Contact Message
+```ts
+const vcard = 'BEGIN:VCARD\n' // metadata of the contact card
+            + 'VERSION:3.0\n'
+            + 'FN:Jeff Singh\n' // full name
+            + 'ORG:Ashoka Uni;\n' // the organization of the contact
+            + 'TEL;type=CELL;type=VOICE;waid=911234567890:+91 12345 67890\n' // WhatsApp ID + phone number
+            + 'END:VCARD'
+
+await sock.sendMessage(
+    id,
+    {
+        contacts: {
+            displayName: 'Jeff',
+            contacts: [{ vcard }]
+        }
+    }
+)
+```
+
+#### Reaction Message
+- You need to pass the key of message, you can retrieve from [store](#implementing-a-data-store) or use a [key](src/Types) object
+```ts
+await sock.sendMessage(
+    jid,
+    {
+        react: {
+            text: '💖', // use an empty string to remove the reaction
+            key: message.key
+        }
+    }
+)
+```
+
+#### Pin Message
+- You need to pass the key of message, you can retrieve from [store](#implementing-a-data-store) or use a [key](src/Types) object
+
+- Time can be:
+
+| Time  | Seconds        |
+|-------|----------------|
+| 24h    | 86.400        |
+| 7d     | 604.800       |
+| 30d    | 2.592.000     |
+
+```ts
+await sock.sendMessage(
+    jid,
+    {
+        pin: {
+            type: 1, // 0 to remove
+            time: 86400
+            key: message.key
+        }
+    }
+)
+```
+
+#### Poll Message
+```ts
+await sock.sendMessage(
+    jid,
+    {
+        poll: {
+            name: 'My Poll',
+            values: ['Option 1', 'Option 2', ...],
+            selectableCount: 1,
+            toAnnouncementGroup: false // or true
+        }
+    }
+)
+```
+
+### Sending Messages with Link Previews
+
+1. By default, wa does not have link generation when sent from the web
+2. Yui-Bails has a function to generate the content for these link previews
+3. To enable this function's usage, add `link-preview-js` as a dependency to your project with `yarn add link-preview-js`
+4. Send a link:
+```ts
+await sock.sendMessage(
+    jid,
+    {
+        text: 'Hi, this was sent using https://github.com/AmilcarGit/Yui-Bails'
+    }
+)
+```
+
+### Media Messages
+
+Sending media (video, stickers, images) is easier & more efficient than ever.
+
+> [!NOTE]
+> In media messages, you can pass `{ stream: Stream }` or `{ url: Url }` or `Buffer` directly, you can see more in the [WAMediaUpload type alias](src/Types)
+
+- When specifying a media url, Yui-Bails never loads the entire buffer into memory; it even encrypts the media as a readable stream.
+
+> [!TIP]
+> It's recommended to use Stream or Url to save memory
+
+#### Gif Message
+- Whatsapp doesn't support `.gif` files, that's why we send gifs as common `.mp4` video with `gifPlayback` flag
+```ts
+await sock.sendMessage(
+    jid,
+    {
+        video: fs.readFileSync('Media/ma_gif.mp4'),
+        caption: 'hello word',
+        gifPlayback: true
+    }
+)
+```
+
+#### Video Message
+```ts
+await sock.sendMessage(
+    id,
+    {
+        video: {
+            url: './Media/ma_gif.mp4'
+        },
+        caption: 'hello word',
+	    ptv: false // if set to true, will send as a `video note`
+    }
+)
+```
+
+#### Audio Message
+- To audio message work in all devices you need to convert with some tool like `ffmpeg` with this flags:
+    ```bash
+        codec: libopus //ogg file
+        ac: 1 //one channel
+        avoid_negative_ts
+        make_zero
+    ```
+    - Example:
+    ```bash
+    ffmpeg -i input.mp4 -avoid_negative_ts make_zero -ac 1 output.ogg
+    ```
+```ts
+await sock.sendMessage(
+    jid,
+    {
+        audio: {
+            url: './Media/audio.mp3'
+        },
+        mimetype: 'audio/mp4'
+    }
+)
+```
+
+#### Image Message
+```ts
+await sock.sendMessage(
+    id,
+    {
+        image: {
+            url: './Media/ma_img.png'
+        },
+        caption: 'hello word'
+    }
+)
+```
+
+#### View Once Message
+
+- You can send all messages above as `viewOnce`, you only need to pass `viewOnce: true` in content object
+
+```ts
+await sock.sendMessage(
+    id,
+    {
+        image: {
+            url: './Media/ma_img.png'
+        },
+        viewOnce: true, //works with video, audio too
+        caption: 'hello word'
+    }
+)
+```
+
+## Modify Messages
+
+### Deleting Messages (for everyone)
+
+```ts
+const msg = await sock.sendMessage(jid, { text: 'hello word' })
+await sock.sendMessage(jid, { delete: msg.key })
+```
+
+**Note:** deleting for oneself is supported via `chatModify`, see in [this section](#modifying-chats)
+
+### Editing Messages
+
+- You can pass all editable contents here
+```ts
+await sock.sendMessage(jid, {
+      text: 'updated text goes here',
+      edit: response.key,
+    });
+```
+
+## Manipulating Media Messages
+
+### Thumbnail in Media Messages
+- For media messages, the thumbnail can be generated automatically for images & stickers provided you add `jimp` or `sharp` as a dependency in your project using `yarn add jimp` or `yarn add sharp`.
+- Thumbnails for videos can also be generated automatically, though, you need to have `ffmpeg` installed on your system.
+
+### Downloading Media Messages
+
+If you want to save the media you received
+```ts
+import { createWriteStream } from 'fs'
+import { downloadMediaMessage, getContentType } from 'yui-bails'
+
+sock.ev.on('messages.upsert', async ({ [m] }) => {
+    if (!m.message) return // if there is no text or media message
+    const messageType = getContentType(m) // get what type of message it is (text, image, video...)
+
+    // if the message is an image
+    if (messageType === 'imageMessage') {
+        // download the message
+        const stream = await downloadMediaMessage(
+            m,
+            'stream', // can be 'buffer' too
+            { },
+            {
+                logger,
+                // pass this so that yui-bails can request a reupload of media
+                // that has been deleted
+                reuploadRequest: sock.updateMediaMessage
+            }
+        )
+        // save to file
+        const writeStream = createWriteStream('./my-download.jpeg')
+        stream.pipe(writeStream)
+    }
+}
+```
+
+### Re-upload Media Message to Whatsapp
+
+- WhatsApp automatically removes old media from their servers. For the device to access said media -- a re-upload is required by another device that has it. This can be accomplished using:
+```ts
+await sock.updateMediaMessage(msg)
+```
+
+## Reject Call
+
+- You can obtain `callId` and `callFrom` from `call` event
+
+```ts
+await sock.rejectCall(callId, callFrom)
+```
+
+## Send States in Chat
+
+### Reading Messages
+- A set of message [keys](src/Types) must be explicitly marked read now.
+- You cannot mark an entire 'chat' read as it were with Yui-Bails Web.
+This means you have to keep track of unread messages.
+
+```ts
+const key: WAMessageKey
+// can pass multiple keys to read multiple messages as well
+await sock.readMessages([key])
+```
+
+The message ID is the unique identifier of the message that you are marking as read.
+On a `WAMessage`, the `messageID` can be accessed using ```messageID = message.key.id```.
+
+### Update Presence
+
+- ``` presence ``` can be one of the values in the [WAPresence type alias](src/Types)
+- The presence expires after about 10 seconds.
+- This lets the person/group with `jid` know whether you're online, offline, typing etc.
+
+```ts
+await sock.sendPresenceUpdate('available', jid)
+```
+
+> [!NOTE]
+> If a desktop client is active, WA doesn't send push notifications to the device. If you would like to receive said notifications -- mark your Yui-Bails client offline using `sock.sendPresenceUpdate('unavailable')`
+
+## Modifying Chats
+
+WA uses an encrypted form of communication to send chat/app updates. This has been implemented mostly and you can send the following updates:
+
+> [!IMPORTANT]
+> If you mess up one of your updates, WA can log you out of all your devices and you'll have to log in again.
+
+### Archive a Chat
+```ts
+const lastMsgInChat = await getLastMessageInChat(jid) // implement this on your end
+await sock.chatModify({ archive: true, lastMessages: [lastMsgInChat] }, jid)
+```
+### Mute/Unmute a Chat
+
+- Supported times:
+
+| Time  | Miliseconds     |
+|-------|-----------------|
+| Remove | null           |
+| 8h     | 86.400.000     |
+| 7d     | 604.800.000    |
+
+```ts
+// mute for 8 hours
+await sock.chatModify({ mute: 8 * 60 * 60 * 1000 }, jid)
+// unmute
+await sock.chatModify({ mute: null }, jid)
+```
+### Mark a Chat Read/Unread
+```ts
+const lastMsgInChat = await getLastMessageInChat(jid) // implement this on your end
+// mark it unread
+await sock.chatModify({ markRead: false, lastMessages: [lastMsgInChat] }, jid)
+```
+
+### Delete a Message for Me
+```ts
+await sock.chatModify(
+    {
+        clear: {
+            messages: [
+                {
+                    id: 'ATWYHDNNWU81732J',
+                    fromMe: true,
+                    timestamp: '1654823909'
+                }
+            ]
+        }
+    },
+    jid
+)
+
+```
+### Delete a Chat
+```ts
+const lastMsgInChat = await getLastMessageInChat(jid) // implement this on your end
+await sock.chatModify({
+        delete: true,
+        lastMessages: [
+            {
+                key: lastMsgInChat.key,
+                messageTimestamp: lastMsgInChat.messageTimestamp
+            }
+        ]
+    },
+    jid
+)
+```
+### Pin/Unpin a Chat
+```ts
+await sock.chatModify({
+        pin: true // or `false` to unpin
+    },
+    jid
+)
+```
+### Star/Unstar a Message
+```ts
+await sock.chatModify({
+        star: {
+            messages: [
+                {
+                    id: 'messageID',
+                    fromMe: true // or `false`
+                }
+            ],
+            star: true // - true: Star Message; false: Unstar Message
+        }
+    },
+    jid
+)
+```
+
+### Disappearing Messages
+
+- Ephemeral can be:
+
+| Time  | Seconds        |
+|-------|----------------|
+| Remove | 0          |
+| 24h    | 86.400     |
+| 7d     | 604.800    |
+| 90d    | 7.776.000  |
+
+- You need to pass in **Seconds**, default is 7 days
+
+```ts
+// turn on disappearing messages
+await sock.sendMessage(
+    jid,
+    // this is 1 week in seconds -- how long you want messages to appear for
+    { disappearingMessagesInChat: WA_DEFAULT_EPHEMERAL }
+)
+
+// will send as a disappearing message
+await sock.sendMessage(jid, { text: 'hello' }, { ephemeralExpiration: WA_DEFAULT_EPHEMERAL })
+
+// turn off disappearing messages
+await sock.sendMessage(
+    jid,
+    { disappearingMessagesInChat: false }
+)
+```
+
+## User Querys
+
+### Check If ID Exists in Whatsapp
+```ts
+const [result] = await sock.onWhatsApp(jid)
+if (result.exists) console.log (`${jid} exists on WhatsApp, as jid: ${result.jid}`)
+```
+
+### Query Chat History (groups too)
+
+- You need to have oldest message in chat
+```ts
+const msg = await getOldestMessageInChat(jid) // implement this on your end
+await sock.fetchMessageHistory(
+    50, //quantity (max: 50 per query)
+    msg.key,
+    msg.messageTimestamp
+)
+```
+- Messages will be received in `messaging.history-set` event
+
+### Fetch Status
+```ts
+const status = await sock.fetchStatus(jid)
+console.log('status: ' + status)
+```
+
+### Fetch Profile Picture (groups too)
+- To get the display picture of some person/group
+```ts
+// for low res picture
+const ppUrl = await sock.profilePictureUrl(jid)
+console.log(ppUrl)
+
+// for high res picture
+const ppUrl = await sock.profilePictureUrl(jid, 'image')
+```
+
+### Fetch Bussines Profile (such as description or category)
+```ts
+const profile = await sock.getBusinessProfile(jid)
+console.log('business description: ' + profile.description + ', category: ' + profile.category)
+```
+
+### Fetch Someone's Presence (if they're typing or online)
+```ts
+// the presence update is fetched and called here
+sock.ev.on('presence.update', console.log)
+
+// request updates for a chat
+await sock.presenceSubscribe(jid)
+```
+
+## Change Profile
+
+### Change Profile Status
+```ts
+await sock.updateProfileStatus('Hello World!')
+```
+### Change Profile Name
+```ts
+await sock.updateProfileName('My name')
+```
+### Change Display Picture (groups too)
+- To change your display picture or a group's
+
+> [!NOTE]
+> Like media messages, you can pass `{ stream: Stream }` or `{ url: Url }` or `Buffer` directly, you can see more in the [WAMediaUpload type alias](src/Types)
+
+```ts
+await sock.updateProfilePicture(jid, { url: './new-profile-picture.jpeg' })
+```
+### Remove display picture (groups too)
+```ts
+await sock.removeProfilePicture(jid)
+```
+
+## Groups
+
+- To change group properties you need to be admin
+
+### Create a Group
+```ts
+// title & participants
+const group = await sock.groupCreate('My Fab Group', ['1234@s.whatsapp.net', '4564@s.whatsapp.net'])
+console.log('created group with id: ' + group.gid)
+await sock.sendMessage(group.id, { text: 'hello there' }) // say hello to everyone on the group
+```
+### Add/Remove or Demote/Promote
+```ts
+// id & people to add to the group (will throw error if it fails)
+await sock.groupParticipantsUpdate(
+    jid,
+    ['abcd@s.whatsapp.net', 'efgh@s.whatsapp.net'],
+    'add' // replace this parameter with 'remove' or 'demote' or 'promote'
+)
+```
+### Change Subject (name)
+```ts
+await sock.groupUpdateSubject(jid, 'New Subject!')
+```
+### Change Description
+```ts
+await sock.groupUpdateDescription(jid, 'New Description!')
+```
+### Change Settings
+```ts
+// only allow admins to send messages
+await sock.groupSettingUpdate(jid, 'announcement')
+// allow everyone to send messages
+await sock.groupSettingUpdate(jid, 'not_announcement')
+// allow everyone to modify the group's settings -- like display picture etc.
+await sock.groupSettingUpdate(jid, 'unlocked')
+// only allow admins to modify the group's settings
+await sock.groupSettingUpdate(jid, 'locked')
+```
+### Leave a Group
+```ts
+// will throw error if it fails
+await sock.groupLeave(jid)
+```
+### Get Invite Code
+- To create link with code use `'https://chat.whatsapp.com/' + code`
+```ts
+const code = await sock.groupInviteCode(jid)
+console.log('group code: ' + code)
+```
+### Revoke Invite Code
+```ts
+const code = await sock.groupRevokeInvite(jid)
+console.log('New group code: ' + code)
+```
+### Join Using Invitation Code
+- Code can't have `https://chat.whatsapp.com/`, only code
+```ts
+const response = await sock.groupAcceptInvite(code)
+console.log('joined to: ' + response)
+```
+### Get Group Info by Invite Code
+```ts
+const response = await sock.groupGetInviteInfo(code)
+console.log('group information: ' + response)
+```
+### Query Metadata (participants, name, description...)
+```ts
+const metadata = await sock.groupMetadata(jid)
+console.log(metadata.id + ', title: ' + metadata.subject + ', description: ' + metadata.desc)
+```
+### Join using `groupInviteMessage`
+```ts
+const response = await sock.groupAcceptInviteV4(jid, groupInviteMessage)
+console.log('joined to: ' + response)
+```
+### Get Request Join List
+```ts
+const response = await sock.groupRequestParticipantsList(jid)
+console.log(response)
+```
+### Approve/Reject Request Join
+```ts
+const response = await sock.groupRequestParticipantsUpdate(
+    jid, // group id
+    ['abcd@s.whatsapp.net', 'efgh@s.whatsapp.net'],
+    'approve' // or 'reject'
+)
+console.log(response)
+```
+### Get All Participating Groups Metadata
+```ts
+const response = await sock.groupFetchAllParticipating()
+console.log(response)
+```
+### Toggle Ephemeral
+
+- Ephemeral can be:
+
+| Time  | Seconds        |
+|-------|----------------|
+| Remove | 0          |
+| 24h    | 86.400     |
+| 7d     | 604.800    |
+| 90d    | 7.776.000  |
+
+```ts
+await sock.groupToggleEphemeral(jid, 86400)
+```
+
+### Change Add Mode
+```ts
+await sock.groupMemberAddMode(
+    jid,
+    'all_member_add' // or 'admin_add'
+)
+```
+
+## Privacy
+
+### Block/Unblock User
+```ts
+await sock.updateBlockStatus(jid, 'block') // Block user
+await sock.updateBlockStatus(jid, 'unblock') // Unblock user
+```
+### Get Privacy Settings
+```ts
+const privacySettings = await sock.fetchPrivacySettings(true)
+console.log('privacy settings: ' + privacySettings)
+```
+### Get BlockList
+```ts
+const response = await sock.fetchBlocklist()
+console.log(response)
+```
+### Update LastSeen Privacy
+```ts
+const value = 'all' // 'contacts' | 'contact_blacklist' | 'none'
+await sock.updateLastSeenPrivacy(value)
+```
+### Update Online Privacy
+```ts
+const value = 'all' // 'match_last_seen'
+await sock.updateOnlinePrivacy(value)
+```
+### Update Profile Picture Privacy
+```ts
+const value = 'all' // 'contacts' | 'contact_blacklist' | 'none'
+await sock.updateProfilePicturePrivacy(value)
+```
+### Update Status Privacy
+```ts
+const value = 'all' // 'contacts' | 'contact_blacklist' | 'none'
+await sock.updateStatusPrivacy(value)
+```
+### Update Read Receipts Privacy
+```ts
+const value = 'all' // 'none'
+await sock.updateReadReceiptsPrivacy(value)
+```
+### Update Groups Add Privacy
+```ts
+const value = 'all' // 'contacts' | 'contact_blacklist'
+await sock.updateGroupsAddPrivacy(value)
+```
+### Update Default Disappearing Mode
+
+- Like [this](#disappearing-messages), ephemeral can be:
+
+| Time  | Seconds        |
+|-------|----------------|
+| Remove | 0          |
+| 24h    | 86.400     |
+| 7d     | 604.800    |
+| 90d    | 7.776.000  |
+
+```ts
+const ephemeral = 86400
+await sock.updateDefaultDisappearingMode(ephemeral)
+```
+
+## Broadcast Lists & Stories
+
+### Send Broadcast & Stories
+- Messages can be sent to broadcasts & stories. You need to add the following message options in sendMessage, like this:
+```ts
+await sock.sendMessage(
+    jid,
+    {
+        image: {
+            url: url
+        },
+        caption: caption
+    },
+    {
+        backgroundColor: backgroundColor,
+        font: font,
+        statusJidList: statusJidList,
+        broadcast: true
+    }
+)
+```
+- Message body can be a `extendedTextMessage` or `imageMessage` or `videoMessage` or `voiceMessage`, see the [AnyRegularMessageContent type alias](src/Types)
+- You can add `backgroundColor` and other options in the message options, see the [MiscMessageGenerationOptions type alias](src/Types)
+- `broadcast: true` enables broadcast mode
+- `statusJidList`: a list of people that you can get which you need to provide, which are the people who will get this status message.
+
+- You can send messages to broadcast lists the same way you send messages to groups & individual chats.
+- Right now, WA Web does not support creating broadcast lists, but you can still delete them.
+- Broadcast IDs are in the format `12345678@broadcast`
+### Query a Broadcast List's Recipients & Name
+```ts
+const bList = await sock.getBroadcastListInfo('1234@broadcast')
+console.log (`list name: ${bList.name}, recps: ${bList.recipients}`)
+```
+
+## Writing Custom Functionality
+Yui-Bails is written with custom functionality in mind. You can write your own extensions without re-writing the internals.
+
+### Enabling Debug Level in Yui-Bails Logs
+First, enable the logging of unhandled messages from WhatsApp by setting:
+```ts
+const sock = makeWASocket({
+    logger: P({ level: 'debug' }),
+})
+```
+This will enable you to see all sorts of messages WhatsApp sends in the console.
+
+### How Whatsapp Communicate With Us
+
+> [!TIP]
+> If you want to learn whatsapp protocol, we recommend to study about Libsignal Protocol and Noise Protocol
+
+- **Example:** Functionality to track the battery percentage of your phone. You enable logging and you'll see a message about your battery pop up in the console:
+    ```
+    {
+        "level": 10,
+        "fromMe": false,
+        "frame": {
+            "tag": "ib",
+            "attrs": {
+                "from": "@s.whatsapp.net"
+            },
+            "content": [
+                {
+                    "tag": "edge_routing",
+                    "attrs": {},
+                    "content": [
+                        {
+                            "tag": "routing_info",
+                            "attrs": {},
+                            "content": {
+                                "type": "Buffer",
+                                "data": [8,2,8,5]
+                            }
+                        }
+                    ]
+                }
+            ]
+        },
+        "msg":"communication"
+    }
+    ```
+
+The `'frame'` is what the message received is, it has three components:
+- `tag` -- what this frame is about (eg. message will have 'message')
+- `attrs` -- a string key-value pair with some metadata (contains ID of the message usually)
+- `content` -- the actual data (eg. a message node will have the actual message content in it)
+- read more about this format [here](/src/WABinary/readme.md)
+
+### Register a Callback for Websocket Events
+
+> [!TIP]
+> Recommended to see `onMessageReceived` function in `socket.ts` file to understand how websockets events are fired
+
+```ts
+// for any message with tag 'edge_routing'
+sock.ws.on('CB:edge_routing', (node: BinaryNode) => { })
+
+// for any message with tag 'edge_routing' and id attribute = abcd
+sock.ws.on('CB:edge_routing,id:abcd', (node: BinaryNode) => { })
+
+// for any message with tag 'edge_routing', id attribute = abcd & first content node routing_info
+sock.ws.on('CB:edge_routing,id:abcd,routing_info', (node: BinaryNode) => { })
+```
+
+# Licencia
+
+Licencia MIT. Consulta el archivo [LICENSE](LICENSE).
+
+Creado por [AmilcarGit](https://github.com/AmilcarGit).