@dark-yasiya/starforge 0.0.0-alpha.11

package/README.md

@@ -0,0 +1,1155 @@
+# 🔨 @DarkYasiyaNew/starforge
+
+[![Logo](https://files.catbox.moe/wbv9fk.png)](https://www.npmjs.com/package/@dark-yasiya/starforge)
+
+<p align="center">
+   A toolkit for building WhatsApp bots with .
+   <br><br>
+   <a href="https://www.npmjs.com/package/@dark-yasiya/starforge">
+      <img src="https://img.shields.io/npm/v/@DarkYasiyaNew/starforge?style=for-the-badge&logo=npm"/>
+   </a>
+   <a href="https://www.npmjs.com/package/@dark-yasiya/starforge">
+      <img src="https://img.shields.io/npm/dm/@DarkYasiyaNew/starforge?style=for-the-badge&logo=npm"/>
+   </a>
+   <a href="https://github.com/DarkYasiyaNew/starforge">
+      <img src="https://img.shields.io/github/stars/DarkYasiyaNew/starforge?style=for-the-badge&logo=github"/>
+   </a>
+   <a href="LICENSE">
+      <img src="https://img.shields.io/badge/license-Apache--2.0-blue?style=for-the-badge"/>
+   </a>
+   <a href="https://nodejs.org">
+      <img src="https://img.shields.io/badge/node-%3E%3D20-339933?logo=node.js&labelColor=green&logoColor=white&style=for-the-badge"/>
+   </a>
+   <a href="https://bun.sh">
+      <img src="https://img.shields.io/badge/bun-%3E%3D1.2-fbf0df?logo=bun&labelColor=14151a&logoColor=white&style=for-the-badge"/>
+   </a>
+   <a href="#">
+      <img src="https://img.shields.io/badge/ESM-only?logo=javascript&labelColor=yellow&logoColor=black&style=for-the-badge"/>
+   </a>
+</p>
+
+☕ For donation: [Saweria](https://yasiyamd.lk/DarkYasiyaNew)
+
+### 📋 Table of Content
+- [⚠️ Notice](#%EF%B8%8F-notice)
+- [📥 Installation](#-installation)
+- [🧩 Example](#-example)
+- [📄 Serialized Message](#-serialized-message)
+- [✉️ Sending Message](#%EF%B8%8F-sending-message)
+  - [💭 Text](#-text)
+  - [😄 Reaction](#-reaction)
+  - [📰 Link Preview](#-link-preview)
+  - [🖼️ Media](#%EF%B8%8F-media)
+  - [🗒️ Sticker](#%EF%B8%8F-sticker)
+  - [👤 Contact](#-contact)
+  - [📦 Sticker Pack](#-sticker-pack)
+  - [🖼️ Album](#%EF%B8%8F-album)
+  - [📊 Poll](#-poll)
+  - [📋 Poll Result](#-poll-result)
+  - [🗄️ Interactive](#%EF%B8%8F-interactive)
+  - [🎠 Carousel](#-carousel)
+  - [🔘 Legacy Button](#-legacy-button)
+  - [📋 Legacy List](#-legacy-list)
+  - [✨ Rich](#-rich)
+  - [↩️ Copy & Forward](#%EF%B8%8F-copy--forward)
+  - [🧰 Additional Options](#-additional-options)
+    - 🤖 [AI](#-additional-options)
+    - 🕒 [Read Timeout](#-additional-options)
+    - 👥 [Group Status](#-additional-options)
+    - 👁️ [Spoiler](#-additional-options)
+- [👤 Chats](#-chats)
+  - [rejectCall](#rejectcallcallid-string-callcreatorjid-string)
+  - [resolveUserJid](#resolveuserjidjid-string)
+  - [updateMemberLabel](#updatememberlabeljid-string-label-string)
+  - [setChatEphemeral](#setchatephemeraljid-string-durationsecs-number)
+- [🧳 Environments](#-environments)
+- [❤️ Credits](#%EF%B8%8F-credits)
+- [📄 License](#-license)
+
+### ⚠️ Notice
+
+This project is a toolkit for building WhatsApp bots with  and will be used for [@DarkYasiyaNew/starseed](https://github.com/DarkYasiyaNew/starseed#readme).
+
+**This library contains no hidden auto-follow code or behavior. It will never automatically follow or subscribe to WhatsApp Channels (Newsletters).**
+
+### 📥 Installation
+
+This library follows a user-controlled dependency model. Additional dependencies are not required unless you use the features that rely on them. Install only the dependencies you need.
+
+```bash
+npm install @DarkYasiyaNew/starforge magic-bytes.js qr sharp -js
+```
+
+- `qr` is required by `encodeQR()`.
+- `magic-bytes.js` is used by `detectFileType()`. Alternatively, you can install `file-type`.
+- `sharp` is used for image processing tasks such as generating thumbnails, creating favicons, `createMediaProcessor()`, and more. Alternatively, you can install `@napi-rs/image` or `jimp`. Only one image processing backend is needed.
+
+### 🧩 Example
+
+Here's a simple example using .
+
+```javascript
+import { WaClient, createStore } from '-js'
+import { createMediaProcessor, createSerializer, encodeQR, extendSocket } from '@DarkYasiyaNew/starforge'
+
+const store = createStore()
+const processor = createMediaProcessor()
+
+const client = new WaClient({
+  store,
+  sessionId: 'main',
+  media: { processor }
+})
+
+// Extend the client immediately after creating it
+extendSocket(client, {
+  // Custom message ID prefix
+  messageIdPrefix: 'STARFORGE',
+
+  // Simulate typing and recording states before sending messages
+  simulatePresence: true
+})
+
+// Create the serializer
+const serialize = createSerializer(client)
+
+client.on('auth_qr', async ({ qr }) => {
+  const { ascii, getPngBuffer } = await encodeQR(qr)
+  console.log('📷 Scan this QR', ascii)
+})
+
+client.on('connection', ({ status }) => {
+  if (status !== 'open') return
+  console.log('✅ Connected to WhatsApp')
+})
+
+client.on('message', async (m) => {
+  // The serializer adds several properties to "m"
+  m = await serialize(m)
+
+  if (m.text === 'ping') {
+    m.reply('🏓 Pong')
+  }
+})
+
+await client.connect()
+```
+
+> 📕 Note: `serialize` can also be used with other `message_*` events, such as `message_addon`.
+
+### 📃 Serialized Message
+
+The following example shows the serialized message payload.
+
+```javascript
+{
+  rawNode: {
+    tag: 'message',
+    attrs: {
+      from: '434311111111111111@lid',
+      type: 'text',
+      id: 'AC75D8A10E220E8692FC161EBB5FD34A',
+      sts: '2792725867333038',
+      notify: '‮‮',
+      sender_pn: '6287711111111@s.whatsapp.net',
+      t: '2792725867'
+    },
+    content: [ [Object], [Object] ]
+  },
+  key: {
+    remoteJid: '434311111111111111@lid',
+    id: 'AC75D8A10E220E8692FC161EBB5FD34A',
+    fromMe: false,
+    isGroup: false,
+    isBroadcast: false,
+    isNewsletter: false,
+    remoteJidAlt: '6287711111111@s.whatsapp.net',
+    senderDevice: 0
+  },
+  stanzaType: 'text',
+  offline: false,
+  timestampSeconds: 2792725867,
+  expirationSeconds: 86400,
+  pushName: '‮‮',
+  message: e {
+    extendedTextMessage: e {
+      endCardTiles: [],
+      text: '@DarkYasiyaNew/starforge',
+      previewType: 0,
+      contextInfo: [e],
+      inviteLinkGroupTypeV2: 0
+    },
+    messageContextInfo: e {
+      threadId: [],
+      deviceListMetadata: [e],
+      deviceListMetadataVersion: 2,
+      messageSecret: [Uint8Array]
+    }
+  },
+  id: 'AC75D8A10E220E8692FC161EBB5FD34A',
+  chat: '6287711111111@s.whatsapp.net',
+  sender: '6287711111111@s.whatsapp.net',
+  senderLid: '434311111111111111@lid',
+  device: 'android',
+  fromMe: false,
+  isGroup: false,
+  isPrivate: true,
+  isBroadcast: false,
+  isNewsletter: false,
+  isMedia: false,
+  msgType: 'extendedTextMessage',
+  msg: e {
+    endCardTiles: [],
+    text: '@DarkYasiyaNew/starforge',
+    previewType: 0,
+    contextInfo: e {
+      mentionedJid: [],
+      groupMentions: [],
+      statusAttributions: [],
+      stanzaId: 'ACF49F7488D66F81B72BD31FDB4A7ADD',
+      participant: '434311111111111111@lid',
+      quotedMessage: [e],
+      expiration: 86400,
+      ephemeralSettingTimestamp: [n],
+      disappearingMode: [e],
+      quotedType: 0
+    },
+    inviteLinkGroupTypeV2: 0
+  },
+  quoted: e {
+    interactiveAnnotations: [],
+    scanLengths: [],
+    annotations: [],
+    url: 'https://mmg.whatsapp.net/v/t62.7118-24/...',
+    mimetype: 'image/jpeg',
+    fileSha256: Uint8Array(32) [ 156, 238, ... ],
+    fileLength: n { low: 357606, high: 0, unsigned: true },
+    height: 1458,
+    width: 1220,
+    mediaKey: Uint8Array(32) [ 249, 219, ... ],
+    fileEncSha256: Uint8Array(32) [ 19, 147, ... ],
+    directPath: '/v/t62.7118-24/...',
+    mediaKeyTimestamp: n { low: 2792725790, high: 0, unsigned: false },
+    jpegThumbnail: Uint8Array(619) [ 255, 216, ... ],
+    contextInfo: e {
+      mentionedJid: [],
+      groupMentions: [],
+      statusAttributions: [Array],
+      pairedMediaType: 0,
+      statusSourceType: 0,
+      statusAudienceMetadata: [e],
+      mediaDomainInfo: [e]
+    },
+    id: 'ACF49F7488D66F81B72BD31FDB4A7ADD',
+    chat: '6287711111111@s.whatsapp.net',
+    sender: '6287711111111@s.whatsapp.net',
+    senderLid: '434311111111111111@lid',
+    device: 'android',
+    fromMe: false,
+    isGroup: false,
+    isPrivate: true,
+    isBroadcast: false,
+    isNewsletter: false,
+    isMedia: true,
+    msgType: 'imageMessage',
+    text: '',
+    expiration: 86400,
+    mentionedJid: [],
+    fakeObj: { key: [Object], message: [Object] },
+    reply: [AsyncFunction: replyMessage],
+    react: [AsyncFunction: reactMessage],
+    getProfilePicture: [AsyncFunction: getProfilePicture],
+    download: [AsyncFunction: downloadBytes],
+    downloadFile: [AsyncFunction: downloadFile]
+  },
+  expiration: 86400,
+  mentionedJid: [],
+  text: '@DarkYasiyaNew/starforge',
+  reply: [AsyncFunction (anonymous)],
+  react: [AsyncFunction: reactMessage],
+  getProfilePicture: [AsyncFunction: getProfilePicture]
+}
+```
+
+### ✉️ Sending Message
+
+> 📕 Note: You must call `extendSocket(client)` before using any of the following functions.
+
+#### 💭 Text
+
+`sendText(jid: string, rawText: string, quote?: object, extraContent?: object, options?: object)`
+
+```javascript
+client.sendText(jid, 'Hello 👋🏻', m)
+
+// Send as view once
+client.sendText(jid, 'Hello 👋🏻', m, {
+  viewOnce: true
+})
+
+// Send as a regular status
+client.sendText([jid, lid], 'Hello 👋🏻')
+
+// Send as a group status with a custom font color, background color, and font style
+client.sendText(jid, 'Hello 👋🏻', null, {
+  // RGB: 230, 230, 250
+  fontColor: '#E6E6FA',
+
+  // RGB: 75, 0, 130
+  backgroundColor: '#4B0082',
+
+  // MORNINGBREEZE_REGULAR
+  fontType: 7
+}, {
+  groupStatus: true
+})
+
+// Send with a spoiler, hiding the content between || pipes
+// (currently not all WhatsApp versions render it)
+client.sendText(m.chat, '🗄️ Secret Password: ||*4640*||', m)
+```
+
+#### 😄 Reaction
+
+`sendReact(jid: string, rawEmoji: string, target?: object, options?: object)`
+
+```javascript
+client.sendReact(jid, '🫪', m.key)
+
+// You can also react to a group status
+client.sendReact(jid, '🫪', m.key, { groupStatus: true })
+```
+
+#### 📰 Link Preview
+
+`sendAdText(jid: string, rawText: string, quote?: object, extraContent?: object, options?: object)`
+
+```javascript
+// Simple and basic usage
+client.sendAdText(jid, 'A tiny discovery ✨', m, {
+  title: 'Interesting Article!',
+  description: 'See more...',
+  thumbnail: /* Buffer | string | Readable */
+})
+
+client.sendAdText(jid, 'Something worth reading 📖', m, {
+  title: 'Interesting Article!',
+  description: 'See more...',
+  thumbnail: /* Buffer | string | Readable */,
+
+  // Custom thumbnail URL
+  thumbnailUrl: 'https://www.npmjs.com/package/@dark-yasiya/starforge',
+
+  // Custom favicon image
+  favicon: /* Buffer | string | Readable */,
+
+  // Render a large, high quality thumbnail
+  largeThumbnail: true,
+  width: 1920,
+  height: 1080
+})
+
+// Send as a group status
+client.sendAdText(jid, 'Fresh from the digital garden 🌿', null, {
+  title: 'Interesting Article!',
+  description: 'See more...',
+  thumbnail: /* Buffer | string | Readable */,
+
+  // RGB: 255, 214, 102
+  fontColor: '#FFD666',
+
+  // RGB: 24, 18, 43
+  backgroundColor: '#18122B',
+
+  // MORNINGBREEZE_REGULAR
+  fontType: 7
+}, {
+  groupStatus: true
+})
+```
+
+#### 🖼️ Media
+
+`sendMedia(jid: string, source: Buffer | string | Readable, rawText: string, quote?: object, extraContent?: object, options?: object)`
+
+```javascript
+client.sendMedia(jid, 'https://files.catbox.moe/jtofzb.jpeg', '🍂', m)
+
+// Send video as Motion Photo (a.k.a. Photo Live)
+client.sendMedia(jid, 'https://path-to-video.mp4/', '📽️ Motion Photo a.k.a. Photo Live', m, {
+   motionThumbnail: 'https://path-to-image.jpg'
+})
+
+client.sendMedia(jid, 'https://files.catbox.moe/jtofzb.jpeg', '🍂', m, {
+  // Force the media type
+  document: true,
+  audio: false,
+  ptt: false,
+  ptv: false,
+  sticker: false,
+  gifPlayback: false,
+
+  // Additional payload
+  fileName: 'Nature.jpeg',
+  mimetype: 'image/jpeg'
+})
+
+// Send as a regular status with Close Friends
+client.sendMedia([jid, lid], 'https://files.catbox.moe/jtofzb.jpeg', '🍂', null, null, {
+  closeFriends: {
+    name: 'To My Friends!',
+    emoji: '🍅'
+  }
+})
+
+// Send as a group status with Close Friends
+// Works with images, videos, and audio
+client.sendMedia(jid, 'https://files.catbox.moe/jtofzb.jpeg', '🍂', null, null, {
+  groupStatus: true,
+  closeFriends: {
+    name: 'To My Friends!',
+    emoji: '🍅'
+  }
+})
+```
+
+#### 🗒️ Sticker
+
+`sendSticker(jid: string, source: Buffer | string | Readable, quote?: object, extraContent?: object, options?: object)`
+
+```javascript
+client.sendSticker(jid, 'https://files.catbox.moe/jtofzb.jpeg', m)
+
+client.sendSticker(jid, 'https://files.catbox.moe/jtofzb.jpeg', m, {
+  // Add custom sticker metadata
+  isAiSticker: true,
+  premium: 0,
+
+  // Modify EXIF without external WebP dependencies
+  name: '@DarkYasiyaNew/starforge',
+  publisher: 'Stellar'
+})
+```
+
+#### 👤 Contact
+
+`sendContact(jid: string, contacts: object[], quote?: object, options?: object)`
+
+```javascript
+client.sendContact(jid, [{
+  name: 'James J. Jonah',
+  org: 'Daily Bugle',
+  email: 'james.jonah@example.com',
+  website: 'https://example.com',
+  location: 'New York, USA',
+  other: '',
+  number: '155512345678'
+}], m)
+
+// You can also send multiple contacts at once
+client.sendContact(jid, [{
+  name: 'James J. Jonah',
+  org: 'Daily Bugle',
+  email: 'james.jonah@example.com',
+  website: 'https://example.com',
+  location: 'New York, USA',
+  other: '',
+  number: '155512345678'
+}, {
+  name: 'Peter Parker',
+  org: 'Freelance Photographer',
+  email: 'peter.parker@example.com',
+  website: '',
+  location: 'New York, USA',
+  other: '',
+  number: '155598765432'
+}], m)
+```
+
+#### 📦 Sticker Pack
+
+`sendStickerPack(jid: string, sources: (Buffer | string | Readable)[], quote?: object, extraContent?: object, options?: object)`
+
+```javascript
+client.sendStickerPack(jid, [
+  'https://files.catbox.moe/jtofzb.jpeg',
+  'https://files.catbox.moe/jtofzb.jpeg'
+], m, {
+  name: 'My Sticker Pack 📦',
+  publisher: 'Stellar',
+  description: 'Limited Sticker!'
+})
+```
+
+#### 🖼️ Album
+
+`sendAlbum(jid: string, sources: object[], quote?: object, options?: object)`
+
+```javascript
+client.sendAlbum(jid, [{
+  media: /* Buffer | string | Readable */,
+  caption: '🌱 Media #1'
+}, {
+  media: /* Buffer | string | Readable */,
+  caption: '🌱 Media #2'
+}], m)
+
+// Send videos as Motion Photos
+// "sendAlbum()" uses the same motion thumbnail input format as "sendMedia()"
+client.sendAlbum(jid, [{
+  media: /* Buffer | string | Readable */,
+  motionThumbnail: /* Buffer | string | Readable */,
+  caption: '📽️ w/Motion Photo #1'
+}, {
+  media: /* Buffer | string | Readable */,
+  motionThumbnail: /* Buffer | string | Readable */,
+  caption: '📽️ w/Motion Photo #2'
+}], m)
+```
+
+#### 📊 Poll
+
+`sendPoll(jid: string, rawText: string, selections: string[] | object[], quote?: object, extraContent?: object, options?: object)`
+
+```javascript
+client.sendPoll(jid, '📊 Choose your favorite language', [
+  'JavaScript',
+  'Python',
+  'Rust'
+], m, {
+  announcementGroup: false,
+  multiSelect: false,
+  hideVoter: true,
+  endTime: Date.now() + 86_400_000,
+  canAddOption: false
+})
+```
+
+#### 📋 Poll Result
+
+`sendPollResult(jid: string, rawText: string, selections: string[] | object[], quote?: object, options?: object)`
+
+```javascript
+client.sendPollResult(jid, '📋 Poll Results', [{
+  name: 'JavaScript',
+  count: 20
+}, {
+  name: 'Python',
+  count: 18
+}, {
+  name: 'Rust',
+  count: 22
+}], m)
+```
+
+#### 🗄️ Interactive
+
+`sendInteractive(jid: string, rawButtons?: object[], quote?: object, extraContent?: object, options?: object)`
+
+```javascript
+const EXAMPLE_BUTTONS = [{
+  text: '👉🏻 Click Me',
+  id: 'command_id',
+
+  // You can add "icon" to each button to use a custom button icon
+  icon: 'DEFAULT' 
+}, {
+  text: '📃 Copy Code',
+  copy: '@DarkYasiyaNew/starforge'
+}, {
+  text: '🌐 Open URL',
+  url: 'https://www.npmjs.com/package/@dark-yasiya/starforge',
+
+  // More optional options for "cta_url"
+  merchantUrl: '',
+  canonicalUrl: '',
+  landingPageUrl: '',
+  isPaymentPreview: false,
+  useWebviewPresentation: 'full',
+  useWebview: true
+}, {
+  text: '📞 Call',
+  call: '94743548986'
+}, {
+  title: '👉🏻 Tap Here',
+  sections: [{
+    title: '🧩 Interesting Menu',
+    highlight_label: 'Popular',
+    rows: [{
+      header: '',
+      title: '⁉️ Coupon',
+      description: '',
+      id: 'free_coupon_id'
+    }]
+  }]
+}, {
+  // Add custom buttons
+  name: 'cta_reminder',
+  paramsJson: {},
+  icon: 'DOCUMENT'
+}]
+
+client.sendInteractive(jid, EXAMPLE_BUTTONS, m, {
+  text: '🗄️ Interactive Message',
+  footer: '@DarkYasiyaNew/starforge'
+})
+
+// Send with a media header
+client.sendInteractive(jid, EXAMPLE_BUTTONS, m, {
+  media: /* Buffer | string | Readable */,
+  text: '🗄️ Interactive Message'
+})
+
+// Send with a location header
+client.sendInteractive(jid, EXAMPLE_BUTTONS, m, {
+  location: {
+    name: '📍 Location Header',
+    address: '@DarkYasiyaNew/starforge'
+  },
+  media: /* Buffer | string | Readable */,
+  text: '🗄️ Interactive Message'
+})
+
+// Send with a product header
+client.sendInteractive(jid, EXAMPLE_BUTTONS, m, {
+  product: {
+    title: '🛒 Product Header',
+    businessOwnerJid: '94743548986@s.whatsapp.net'
+  },
+  media: /* Buffer | string | Readable */,
+  text: '🗄️ Interactive Message'
+})
+
+// Additional options
+client.sendInteractive(jid, EXAMPLE_BUTTONS, m, {
+  media: /* Buffer | string | Readable */,
+  title: '✨ Using Various Options',
+
+  // Classic footer text
+  text: '🗄️ Interactive Message',
+
+  // Audio footer
+  // (currently iOS only & not all WhatsApp versions render it)
+  audioFooter: /* Buffer | string | Readable */,
+
+  // Force header type
+  document: false,
+  location: false,
+  product: false,
+
+  // Wrap all buttons in a single option
+  optionText: '👉🏻 Tap Here',
+  optionTitle: '🧩 Wrapped Buttons',
+
+  // Limited time offer
+  offerText: '🔖 Limited Time Offer',
+  offerCode: '@DarkYasiyaNew/starforge',
+  offerUrl: 'https://www.npmjs.com/package/@dark-yasiya/starforge',
+  offerExpiration: Date.now() + 86_400_000
+})
+```
+
+#### 🎠 Carousel
+
+`sendCarousel(jid: string, rawCards: object[], quote?: object, extraContent?: object, options?: object)`
+
+```javascript
+const EXAMPLE_BUTTONS = [{
+  text: '🛒 Check Out!',
+  url: 'https://www.npmjs.com/package/@dark-yasiya/starforge',
+  icon: 'DEFAULT'
+}, {
+  text: '📞 Call Us',
+  call: '94743548986'
+}]
+
+const CARDS = [{
+  // Media is required for carousel cards
+  media: /* Buffer | string | Readable */,
+
+  text: 'Card #1',
+
+  // Optional
+  buttons: EXAMPLE_BUTTONS
+}, {
+  media: /* Buffer | string | Readable */,
+  title: '✨ Using Various Options',
+  text: 'Card #2',
+
+  // Classic footer text
+  footer: '@DarkYasiyaNew/starforge',
+
+  // Audio footer
+  // (currently iOS only & not all WhatsApp versions render it)
+  audioFooter: /* Buffer | string | Readable */,
+
+  // Force header type, carousel cards cannot use document or location headers
+  product: false,
+
+  // Wrap all buttons in a single option
+  optionText: '👉🏻 Tap Here',
+  optionTitle: '🧩 Wrapped Buttons',
+
+  // Limited time offer
+  offerText: '🔖 Limited Time Offer',
+  offerCode: '@DarkYasiyaNew/starforge',
+  offerUrl: 'https://www.npmjs.com/package/@dark-yasiya/starforge',
+  offerExpiration: Date.now() + 86_400_000,
+
+  buttons: EXAMPLE_BUTTONS
+}]
+
+client.sendCarousel(jid, CARDS, m, {
+  text: '🎠 Carousel Message',
+  footer: 'TESTING!'
+})
+```
+
+#### 🔘 Legacy Button
+
+`sendLegacyButton(jid: string, rawButtons: object[], quote?: object, extraContent?: object, options?: object)`
+
+```javascript
+// Regular buttons message
+client.sendLegacyButton(jid, [{
+  text: '👋🏻 SignUp',
+  id: '#SignUp'
+}], m, {
+  // Optional, change to "true" if want proper render on WhatsApp iOS
+  viewOnce: false,
+
+  text: '👆🏻 Buttons!',
+  footer: '@DarkYasiyaNew/starforge',
+})
+
+const EXAMPLE_BUTTONS = [{
+  text: '👋🏻 Rating',
+  id: '#Rating'
+}, {
+  text: '📋 Select',
+
+  // Force the button to use RESPONSE
+  // instead of NATIVE_FLOW (required when using a location header)
+  // type: 1,
+
+  sections: [{
+    title: '✨ Section 1',
+    rows: [{
+      header: '',
+      title: '💭 Secret Ingredient',
+      description: '',
+      id: '#SecretIngredient'
+    }]
+  }, {
+    title: '✨ Section 2',
+    highlight_label: '🔥 Popular',
+    rows: [{
+      header: '',
+      title: '🏷️ Coupon',
+      description: '',
+      id: '#CouponCode'
+    }]
+  }]
+}]
+
+// Buttons with Media & List
+client.sendLegacyButton(jid, EXAMPLE_BUTTONS, m, {
+  media: /* Buffer | string | Readable */,
+  text: '👆🏻 Buttons and List!',
+  footer: '@DarkYasiyaNew/starforge'
+})
+
+// Buttons with the legacy button style
+client.sendLegacyButton(jid, EXAMPLE_BUTTONS, m, {
+  location: {
+    name: '📍 Location Header',
+    address: '@DarkYasiyaNew/starforge'
+  },
+  media: /* Buffer | string | Readable */,
+  text: '👆🏻 Old Buttons and List!',
+  footer: '@DarkYasiyaNew/starforge'
+})
+```
+
+#### 📋 Legacy List
+
+`sendLegacyList(jid: string, rawSections: object[], quote?: object, extraContent?: object, options?: object)`
+
+```javascript
+// Regular list message
+client.sendLegacyList(jid, [{
+  title: '🚀 Menu 1',
+  rows: [{
+    title: '✨ AI',
+    description: '',
+    id: '#AI'
+  }]
+}, {
+  title: '🌱 Menu 2',
+  rows: [{
+    title: '🔍 Search',
+    description: '',
+    id: '#Search'
+  }]
+}], m, {
+  text: '📋 List!',
+  footer: '@DarkYasiyaNew/starforge',
+  buttonText: '📋 Select',
+  title: '👋🏻 Hello'
+})
+
+// Product list message
+client.sendLegacyList(jid, [{
+  title: '🚀 Menu 1',
+  products: [{
+    productId: '607964531532'
+  }, {
+    productId: '506965808593'
+  }]
+}, {
+  title: '🌱 Menu 2',
+  products: [{
+    productId: '676909529293'
+  }, {
+    productId: '656988410262'
+  }]
+}], m, {
+  header: {
+    productId: '656988410262',
+    thumbnail: /* Buffer | ArrayBufferLike */,
+    businessOwnerJid: '434311111111111111@lid'
+  },
+  text: '📋 List!',
+  footer: '@DarkYasiyaNew/starforge',
+  buttonText: '📋 Select',
+  title: '👋🏻 Hello'
+})
+```
+
+#### ✨ Rich
+
+`sendRich(jid: string, rawSections: string | object[], quote?: object, extraContent?: object, options?: object)`
+
+```javascript
+const EXAMPLE_TEXT = `
+Here's a table comparing grapes and bananas:
+
+| **Characteristic** | **Grapes** | **Banana** |
+| --- | --- | --- |
+| **Type** | Fruit, berry | Fruit, large herbaceous plant |
+| **Color** | Purple, red, or green | Yellow or green |
+| **Taste** | Sweet and slightly tart | Sweet and creamy |
+`
+
+client.sendRich(jid, EXAMPLE_TEXT, m)
+
+// More advanced rich message types
+client.sendRich(jid, [{
+  text: '# 🔨 @DarkYasiyaNew/starforge\n\n---\n',
+}, {
+  labels: [{
+    text: '🔨 Starforge',
+    type: 'NEGATIVE'
+  }, {
+    text: '⚡ ',
+    type: 'POSITIVE'
+  }, {
+    text: '📦 Modular',
+    type: 'NEUTRAL'
+  }]
+}, {
+  language: 'javascript',
+  code: `console.log("Hello World")`
+}, {
+  title: 'The Table',
+  table: [{
+    isHeading: true,
+    items: ['', 'Node.js', 'Bun', 'Deno']
+  }, {
+    isHeading: false,
+    items: ['Engine', 'V8 (C++)', 'JavaScriptCore (C++)', 'V8 (C++)']
+  }, {
+    isHeading: false,
+    items: ['Performance', '4/5', '5/5', '4/5']
+  }]
+}, {
+  extWidget: [{
+    title: '📋 Section 1',
+    buttons: ['menu', 'label', 'infos']
+  }, {
+    title: '📄 Section 2',
+    buttons: ['gif', 'runtime', 'order']
+  }],
+  canScroll: false
+}, {
+  // When adding an HTML primitive, set "disableEdit" to true if it causes lag or device stuttering
+  htmlPayload: `<h1>🔨 @DarkYasiyaNew/starforge</h1><p>A Baileys wrapper designed to make WhatsApp bot development simpler, cleaner, and more flexible.</p>`,
+  trustedSources: ['https://github.com/DarkYasiyaNew/starforge']
+}, {
+  video: 'https://path-to-video.com/',
+  thumbnailUrl: 'https://path-to-tiny-image.com/',
+  mime: 'video/mp4',
+  fileLength: 13_603,
+  duration: 60
+}, {
+  image: 'https://path-to-image.com/',
+  mime: 'image/jpeg'
+}, {
+  imagine: 'https://path-to-image.com/',
+  mime: 'image/jpeg'
+}, {
+  reels: [{
+    reelUrl: 'https://path-to-web.com/',
+    thumbnailUrl: 'https://path-to-image.com/',
+    creator: 'Dark Yasiya',
+    avatarUrl: 'https://path-to-tiny-image.com/',
+    title: 'Simple  Helper',
+    likesCount: 1,
+    sharesCount: 1,
+    viewCount: 1,
+    source: 'https://path-to-web.com/',
+    isVerified: true
+  }]
+}, {
+  posts: [{
+    caption: 'A  Helper',
+    title: '',
+    subtitle: '',
+    creator: 'Dark Yasiya',
+    avatarUrl: 'https://path-to-tiny-image.com/',
+    thumbnailUrl: 'https://path-to-image.com/',
+    likesCount: 1,
+    commentsCount: 1,
+    sharesCount: 1,
+    postUrl: 'https://path-to-web.com/',
+    deepLink: '',
+    footerLabel: '',
+    footerIcon: '',
+    sourceApp: 'FACEBOOK',
+    orientation: 'LANDSCAPE',
+    type: 'IMAGE',
+    isVerified: true,
+    isCarousel: false
+  }]
+}, {
+  title: 'Starseed Premium Script',
+  brand: 'Starseed',
+  price: 'Rp 150.000',
+  salePrice: 'Rp 75.000',
+  productUrl: 'https://path-to-web.com/',
+  imageUrl: 'https://path-to-image.com/',
+  additionalImages: [{
+      url: 'https://path-to-tiny-image.com/'
+  }]
+}, {
+  products: [{
+    title: 'Starseed Premium Script',
+    brand: 'Starseed',
+    price: 'Rp 150.000',
+    salePrice: 'Rp 75.000',
+    productUrl: 'https://path-to-web.com/',
+    imageUrl: 'https://path-to-image.com/'
+  }, {
+    title: 'Self-Bot Script',
+    brand: 'Starseed',
+    price: 'Rp 50.000',
+    productUrl: 'https://path-to-web.com/',
+    imageUrl: 'https://path-to-image.com/',
+    additionalImages: [{
+      url: 'https://path-to-tiny-image.com/'
+    }]
+  }]
+}, {
+  latex: 'https://quicklatex.com/cache3/82/ql_0676ade0cd04eda37aeb3d0bcd427682_l3.png',
+  expression: 'x^2 + 2x + 1',
+  mime: 'image/png',
+  width: 603,
+  height: 111,
+  fontHeight: 83.5,
+  padding: 15
+}, {
+  text: '- Citation:',
+  entities: [{
+    title: 'Example of Citation',
+    citationUrl: 'https://wa.me/0',
+    displayName: '@DarkYasiyaNew/starforge'
+  }]
+}, {
+  text: '- Inline Link:',
+  entities: [{
+    inlineUrl: 'https://wa.me/0',
+    displayName: '@DarkYasiyaNew/starforge',
+    isTrusted: true
+  }]
+}, {
+  text: '- LaTeX:',
+  entities: [{
+    expression: 'x^2 + 2x + 1',
+    latex: 'https://quicklatex.com/cache3/82/ql_0676ade0cd04eda37aeb3d0bcd427682_l3.png',
+    width: 603,
+    height: 111,
+    fontHeight: 83.5,
+    padding: 15
+  }]
+}, {
+  suggestion: '@DarkYasiyaNew/starforge'
+}, {
+  suggestions: ['@DarkYasiyaNew/starforge', ' Helper', '']
+}, {
+  suggestions: ['@DarkYasiyaNew/starforge', 'Rich Response', 'Scroll Layout'],
+  canScroll: true
+}, {
+  tip: '@DarkYasiyaNew/starforge'
+}, {
+  foaText: '# 🔥 LARGE Text'
+}, {
+   compactEntity: [{
+      title: 'my name',
+      subtitle: 'my subtitle',
+      secondarySubtitle: 'my secondary subtitle',
+      url: 'https://github.com/DarkYasiyaNew/starforge',
+      entityType: 'FOLLOW',
+      actionType: 'PAGE',
+      isVerified: true,
+      imageUrl: 'https://path-to-tiny-image.com/'
+   }]
+}, {
+  queryStatus: 'FETCHED',
+  motivation: 'Every journey begins with a place worth remembering.',
+  mapItems: [{
+    id: String(Date.now()),
+    name: 'Starforge Observatory',
+    description: 'A quiet little place beneath the city lights, perfect for curious minds, late-night conversations, and watching the stars.',
+    location: {
+      latitude: -6.175392,
+      longitude: 106.824964
+    },
+    address: {
+      street: 'Jl. Langit Senja No. 42',
+      region: 'Sri Lanka',
+      country: 'LK'
+    },
+    priceLevel: '$$',
+    openingStatus: 'OPEN',
+    type: 'PLACE',
+    timeZone: 'Asia/Colombo',
+    rating: { avgRating: 4.8 },
+    imageUrl: 'https://raw.githubusercontent.com/Dark-Yasiya/DARKYASIYA-DATABASE/main/MEDIA/IMAGE/yasiya-md-v3.jpg'
+  }]
+}, {
+  actionUrls: [{
+    text: '💰 Donate Me!',
+    url: 'https://yasiyamd.lk/DarkYasiyaNew'
+  }, {
+    text: '🌐 Google',
+    url: 'https://www.google.com/'
+  }]
+}, {
+  searchResults: [{
+    displayName: 'Simple  Helper',
+    sourceUrl: 'https://path-to-web.com/',
+    faviconUrl: 'https://path-to-tiny-image.com/',
+    mime: 'image/jpeg'
+  }]
+}], m, {
+  notify: false,
+  disclaimerText: 'Example Usage of sendRich()',
+  disableEdit: false,
+  disableForward: false,
+  forceAsFooter: false
+})
+```
+
+#### ↩️ Copy & Forward
+
+`sendCopy(jid: string, content: object, options?: object)`
+
+```javascript
+client.sendCopy(jid, m)
+
+// Custom forwarding score
+client.sendCopy(jid, m, { forwardScore: 1000 })
+
+// Disable forwarding score
+client.sendCopy(jid, m, { forwardScore: false })
+
+// Quote a message
+client.sendCopy(jid, m, { quote: m })
+```
+
+#### 🧰 Additional Options
+
+> 💡 Tip: You can use the following additional options in the `options` parameter of every function returned by `extendSocket()`.
+
+```javascript
+// Add an "AI" icon (only available in private chats)
+client.sendText(jid, '🤖 Hello', m, null, {
+   isAi: true
+})
+
+// The message will disappear 1 second after you open the chat
+client.sendText(jid, '🗄️ Secret Password: *4640*', m, null, {
+  readTimeout: 1
+})
+
+// Send the message as a group status
+client.sendText(jid, 'Group Status ✨', null, null, {
+  groupStatus: true,
+
+  // Optional, use this if you want to enable Close Friends
+  closeFriends: {
+    name: 'To My Friends!',
+    emoji: '🍅'
+  }
+})
+
+// Force send with a spoiler, hiding the content between || pipes
+client.sendText(jid, '👋🏻 Hello ||world!||', null, null, {
+   spoiler: true
+})
+```
+
+### 👤 Chats
+
+#### `rejectCall(callId: string, callCreatorJid: string)`
+
+#### `resolveUserJid(jid: string)`
+
+#### `updateMemberLabel(jid: string, label: string)`
+
+#### `setChatEphemeral(jid: string, durationSecs: number)`
+
+### 🧳 Environments
+
+The following environment variables are supported. They can be configured through the environment or a `.env` file using [`dotenv`](https://www.npmjs.com/package/dotenv).
+
+```ini
+# .env
+
+# Defaults to os.tmpdir() when unset
+TEMPORARY_PATH=
+
+FFMPEG_PATH=ffmpeg
+
+FFPROBE_PATH=ffprobe
+
+FFMPEG_TIMEOUT=60000
+
+FFPROBE_TIMEOUT=60000
+
+FETCH_TIMEOUT=60000
+```
+
+### ❤️ Credits
+
+<!-- Please do not replace my name with yours. It's disrespectful. -->
+
+**This project is created and maintained by [Dark Yasiya](https://github.com/DarkYasiyaNew)**
+
+Thanks to the [](https://github.com/DarkYasiyanew/YASIYA-MD/) maintainers and contributors for providing an amazing and modern TypeScript library for interacting with the WhatsApp Web API.
+
+Please do not remove or alter the original credits, copyright notices, or attributions.
+
+### 📄 License
+
+This library is licensed under the [Apache License 2.0](LICENSE)