@codexverified/baileys 2.14.14 → 2.17.18

package/README.md

@@ -1,11 +1,35 @@
-# @codexverified/baileys
+<div align="center">
 
-[![npm version](https://img.shields.io/npm/v/@codexverified/baileys.svg)](https://www.npmjs.com/package/@codexverified/baileys)
-[![node](https://img.shields.io/badge/node-%3E%3D20-brightgreen)](#at-a-glance)
-[![license](https://img.shields.io/badge/license-MIT-blue.svg)](#license-and-maintenance)
-[![types](https://img.shields.io/badge/types-included-blue)](#at-a-glance)
+# BAILEYS 
 
-> A readable, carefully maintained Baileys distribution for building reliable WhatsApp integrations with codexverified/baileys.
+### **The intelligent interactive and productivity layer for WhatsApp protocols.**
+
+<img src="https://readme-typing-svg.demolab.com?font=Space+Mono&size=22&pause=1200&color=00FFF0&center=true&vCenter=true&width=900&height=70&repeat=true&lines=BAILEYS+PROTOCOL.;NODE.JS+%2B+TYPESCRIPT.;RICH+MESSAGES+%2B+MEDIA.;BUILD+RELIABLE+INTEGRATIONS." alt="CodexVerified Baileys animated keywords" />
+
+<img src="https://i.imgur.com/dBaSKWF.gif" height="16" width="88%" alt="animated coloured divider" />
+
+<img src="https://raw.githubusercontent.com/codexverified/CODEX-AI/main/assets/rolling-circle.svg" width="90" alt="CodexVerified rolling circle" />
+
+[![Version](https://img.shields.io/badge/version-2.14.14-00FFF0?style=for-the-badge&labelColor=07111F)](https://www.npmjs.com/package/@codexverified/baileys)
+[![Developer CODEX](https://img.shields.io/badge/Developer-CODEX-B88CFF?style=for-the-badge&logo=telegram&labelColor=07111F)](https://t.me/codexverified)
+[![Node.js](https://img.shields.io/badge/node-%3E%3D20-7CFFB2?style=for-the-badge&logo=node.js&logoColor=white&labelColor=07111F)](https://nodejs.org/)
+[![Powered by codexverified/baileys](https://img.shields.io/badge/powered%20by-codexverified%2Fbaileys-25D366?style=for-the-badge&logo=whatsapp&logoColor=white&labelColor=07111F)](https://www.npmjs.com/package/@codexverified/baileys)
+[![License](https://img.shields.io/badge/license-MIT-B88CFF?style=for-the-badge&labelColor=07111F)](#license-and-maintenance)
+
+</div>
+
+<div align="center">
+
+[![Main WhatsApp Channel](https://img.shields.io/badge/WhatsApp%20Channel-Follow-25D366?style=for-the-badge&logo=whatsapp)](https://whatsapp.com/channel/0029Vb78BHmL2AU7fsANSH2y)
+[![Backup WhatsApp Channel](https://img.shields.io/badge/Backup%20Channel-Follow-25D366?style=for-the-badge&logo=whatsapp)](https://whatsapp.com/channel/0029Vb6sMEy96H4VI2w3I50F)
+[![Support Group](https://img.shields.io/badge/Support%20Group-Join-25D366?style=for-the-badge&logo=whatsapp)](https://chat.whatsapp.com/If0d4XKHITO2NUf6YvQ3Eg?s=cl&p=a&mlu=4&ilr=4)
+[![Telegram Channel](https://img.shields.io/badge/Telegram%20Channel-Join-26A5E4?style=for-the-badge&logo=telegram)](https://t.me/codex_tech_innovation)
+[![Telegram Group](https://img.shields.io/badge/Telegram%20Group-Join-26A5E4?style=for-the-badge&logo=telegram)](https://t.me/CODEXV3)
+[![Website](https://img.shields.io/badge/Website-Visit-00FFF0?style=for-the-badge&logo=vercel&logoColor=black)](https://codex-ai.site)
+
+</div>
+
+> A readable, carefully maintained Baileys distribution for building reliable WhatsApp integrations. built by codex 
 
 `@codexverified/baileys` is a Node.js and TypeScript library for creating WhatsApp automations over the Baileys protocol. It provides a socket-oriented API for authentication, messaging, media, interactive content, rich responses, newsletters, groups, communities, business features, account utilities, and carefully documented extensions.
 
@@ -34,13 +58,14 @@ The package is maintained by **Codex** under the **CodexVerified** organization.
 - [Comparison references](#comparison-references)
 - [Additional functional compatibility helpers](#additional-functional-compatibility-helpers)
 - [AI generation primitive](#ai-generation-primitive)
+- [New AIRich metadata helpers](#new-airich-metadata-helpers)
 
 ## At a glance
 
 | Property | Value |
 | --- | --- |
 | Package | `@codexverified/baileys` |
-| Version | `2.14.14` |
+| Version | `2.17.18` |
 | Runtime | Node.js 20 or newer |
 | Module format | ESM, with CommonJS compatibility where supported |
 | Type declarations | Included at `lib/index.d.ts` |
@@ -54,7 +79,7 @@ The package is maintained by **Codex** under the **CodexVerified** organization.
 | Method | Command | Notes |
 | --- | --- | --- |
 | From npm | `npm install @codexverified/baileys` | Standard install when published under your organization |
-| From local archive | `npm install ./codex-baileys-2.14.14.tgz` | Place the `.tgz` beside your application |
+| From local archive | `npm install ./codex-baileys-2.17.18.tgz` | Place the `.tgz` beside your application |
 | Source audit (no scripts) | `npm install --ignore-scripts` | Skips install hooks for local review |
 
 Both npm and archive installs use the same import name:
@@ -663,6 +688,134 @@ await sock.sendBotCommand(jid, {
 ```
 
 
+
+
+### Full-width stacked albums
+
+`sendAlbumMessage` sends a rich vertical album rather than the legacy parent/child album collection. Each image or video is rendered as one large media item on its own row. Provide at least two publicly fetchable media URLs. Both `{ image: { url } }` and the typed `{ type: 'image', data: { url } }` forms are accepted.
+
+```js
+await sock.sendAlbumMessage(jid, [
+  { image: { url: 'https://example.com/one.jpg' } },
+  { image: { url: 'https://example.com/two.jpg' } },
+  { image: { url: 'https://example.com/three.jpg' } }
+], { caption: 'Codex album' })
+```
+
+The rich album path is URL-based and does not upload local buffers. Remove accidental whitespace from URLs before sending; the implementation trims URL values, but clean URLs are recommended.
+
+### A2UI command menu
+
+`sendA2UICommandMenu` sends the large command/function menu UI: an optional image header, title, command rows, URL buttons, and a native-flow fallback. The `rows` entries use `[command, description]` tuples, matching the menu layout shown in the WhatsApp client.
+
+```js
+await sock.sendA2UICommandMenu(jid, {
+  image: { url: 'https://example.com/menu.jpg' },
+  title: 'Speed menu',
+  rows: [
+    ['.menu', 'Main menu'],
+    ['.ping', 'Speed check']
+  ],
+  buttons: [
+    { text: 'Website', url: 'https://example.com' },
+    { text: 'Support', url: 'https://example.com/support' }
+  ]
+})
+```
+
+
+### AIRich command menu and video grid
+
+The compatibility update also exposes the two AIRich layouts that were not already present in Codex. `sendAIRichCommandMenu` sends the manually serialized command card with an image, Markdown command table, optional widget CTAs, and footer URL actions. The image must be a publicly fetchable URL.
+
+```ts
+await sock.sendAIRichCommandMenu(jid, {
+  image: 'https://example.com/menu.png',
+  title: 'CODEX AI',
+  subtitle: 'Choose a command',
+  rows: [
+    ['.menu', 'Show the main menu'],
+    ['.ping', 'Check service latency']
+  ],
+  buttons: [
+    { id: 'docs', text: 'Documentation', url: 'https://example.com/docs' }
+  ],
+  footer: 'Developed by - CODEX TECHNOLOGY'
+})
+```
+
+`sendVideoGridMessage` sends at least two video URL items as a `GenAIGridLayoutViewModel` containing `GenAIVideoPrimitive` entries. It is separate from `sendAlbumMessage`, which uses the vertical album layout.
+
+```ts
+await sock.sendVideoGridMessage(jid, [
+  {
+    url: 'https://cdn.example.com/first.mp4',
+    title: 'First clip',
+    thumbnailUrl: 'https://cdn.example.com/first.jpg',
+    progressiveUrls: ['https://cdn.example.com/first-720p.mp4']
+  },
+  {
+    url: 'https://cdn.example.com/second.mp4',
+    title: 'Second clip',
+    thumbnailUrl: 'https://cdn.example.com/second.jpg'
+  }
+])
+```
+
+Both layouts are experimental WhatsApp protocol structures. Client rendering can change, and callers should provide a plain-message fallback where reliability matters.
+
+
+### Bot planning responses
+
+`sendBotPlanning` sends a bot-planning rich response with a summary, ordered step text, and optional planning/query-plan capabilities.
+
+```ts
+await sock.sendBotPlanning(jid, {
+  text: 'Preparing the deployment',
+  steps: [
+    { title: 'Build', body: 'Compile the application' },
+    { title: 'Verify', body: 'Run the checks' },
+    'Publish the release'
+  ],
+  queryPlan: true
+})
+```
+
+### Newsletter invite metadata
+
+`newsletterGetInviteInfo` accepts either a channel invite code or a WhatsApp channel invite URL and returns the resolved newsletter metadata, or `null` when WhatsApp does not return a matching record.
+
+```ts
+const info = await sock.newsletterGetInviteInfo('https://whatsapp.com/channel/INVITE_CODE')
+console.log(info?.id, info?.name, info?.invite)
+```
+
+The lookup is an explicit network request and does not follow, join, or subscribe to the channel.
+
+
+### Carousel, compatibility aliases, and source search
+
+`sendCarousel` normalizes card media, captions, footers, and buttons before sending a carousel message.
+
+```ts
+await sock.sendCarousel(jid, [
+  {
+    title: 'Documentation',
+    body: { text: 'Read the API guide' },
+    media: { image: { url: 'https://example.com/docs.jpg' } },
+    buttons: [{ text: 'Open', id: 'docs' }]
+  }
+])
+```
+
+`HoldOn` is retained as a compatibility alias for `sendRichButtonGrid`. New applications should prefer the descriptive Codex-named method.
+
+`grepCode(pattern, options)` searches installed package source files and returns matching file, line, column, and source-line information. It is an explicit diagnostic helper and performs no network access.
+
+```ts
+const matches = sock.grepCode('prepareVideoGridMessage', { includeReadme: true })
+```
+
 ### Interactive rich HTML
 
 The compatibility update also exposes `sendRichHtmlMessage`, which uses the interactive GenAI HTML primitive and supports embedded tabs. Only pass trusted, sanitized HTML; this is not a general-purpose HTML sanitizer.
@@ -677,3 +830,119 @@ await sock.sendRichHtmlMessage(jid, {
 ```
 
 Multiple tabs can be supplied with `tabs`; each tab may provide its own `html`, `url`, and `trustedSources`. The structure is experimental and depends on WhatsApp client support.
+
+
+## Codex unified responses and the built-in mini-app
+
+`sendCodexMessage` accepts one object containing any supported combination of text, links, media, products, reels, tables, code, LaTeX, or suggestions. Unsupported optional sections are ignored by the rich-response serializer, so callers can use one stable entry point for heterogeneous response data.
+
+```js
+await sock.sendCodexMessage(jid, {
+  text: 'Here is your result',
+  links: [{ text: 'Open the docs', url: 'https://example.com/docs' }],
+  table: {
+    title: 'Summary',
+    headers: ['Name', 'Status'],
+    rows: [['Codex', 'Ready']]
+  }
+})
+```
+
+`sendMiniApp` sends the bundled interactive mini-app as a trusted rich HTML screen. The helper does not fetch or execute caller-provided remote code; pass only presentation options such as `title` and keep authentication or business actions on your own server.
+
+```js
+await sock.sendMiniApp(jid, {
+  title: 'Codex mini-app'
+}, {
+  quoted: message
+})
+```
+
+The package also exports `BotCapabilityType`, `normalizeBotCapabilities`, `buildBotCapabilityMetadata`, and `buildBotRichResponse` for applications that need to construct compatible bot metadata.
+
+
+## New AIRich metadata helpers
+
+The package includes experimental helpers for protocol-backed rich clients. Rendering depends on the recipient's WhatsApp client version; these helpers do not call Meta AI or any private backend.
+
+```js
+await sock.sendA2UIMessage(jid, {
+  type: 'im_a2ui',
+  data: {
+    version: 'v0.9',
+    createSurface: {
+      surfaceId: 'custom-card',
+      catalogId: 'https://a2ui.org/specification/v0_9/catalogs/basic/catalog.json',
+      components: [{ id: 'root', component: 'Column', children: ['title'] }]
+    }
+  }
+})
+
+await sock.sendRichMap(jid, {
+  centerLatitude: 6.5244,
+  centerLongitude: 3.3792,
+  annotations: [{ latitude: 6.53, longitude: 3.38, title: 'Lagos', body: 'Nigeria' }],
+  showInfoList: true
+})
+
+await sock.sendBotPromptSuggestions(jid, {
+  text: 'Choose a follow-up',
+  suggestions: ['Summarize this', 'Translate this', 'Explain further'],
+  selectedPromptId: 'translate'
+})
+
+await sock.sendBotSources(jid, {
+  text: 'Relevant sources:',
+  sources: [{
+    provider: 2,
+    url: 'https://example.com/docs',
+    query: 'baileys proto',
+    title: 'Documentation',
+    citationNumber: 1
+  }]
+})
+
+await sock.sendRichDynamicMedia(jid, {
+  type: 'IMAGE',
+  url: 'https://example.com/image.jpg',
+  version: 1
+})
+
+await sock.sendBotPttTranscript(jid, {
+  text: 'Voice transcript',
+  transcript: 'Hello, this text came from a voice message.'
+})
+
+await sock.sendSocialEntity(jid, {
+  platform: 'YOUTUBE',
+  username: 'example',
+  title: 'Example creator',
+  imageUrl: 'https://example.com/avatar.png',
+  entityUrl: 'https://www.youtube.com/@example',
+  isVerified: true,
+  resultText: 'See results'
+})
+
+await sock.sendInstagramProfile(jid, {
+  username: 'example',
+  title: 'Example profile',
+  imageUrl: 'https://example.com/avatar.png',
+  entityUrl: 'https://www.instagram.com/example',
+  isVerified: true,
+  resultText: 'See results'
+})
+```
+
+The map, prompt, source, dynamic-media, transcript, A2UI, and social/entity payloads are serialized from the generated `WAProto` structures. Validate URLs, button identifiers, and any user-supplied metadata in your own application before sending.
+
+<div align="center">
+
+<sub>Thanks for reading my README.</sub>
+
+<img src="https://i.imgur.com/dBaSKWF.gif" height="16" width="88%" alt="animated coloured footer line" />
+
+<br><br>
+
+<img src="https://capsule-render.vercel.app/api?type=waving&color=00FFF0&height=100&section=footer" alt="@codexverified/baileys footer" />
+
+</div>