@deathnaitsa/wa-api 2.0.2 → 2.0.4

package/README.md

@@ -13,21 +13,24 @@ Eine minimalistische, stabile WhatsApp Multi-Device API basierend auf Baileys mi
 - Statistik-System mit JSON-Persistenz
 - Message Parsing mit Mentions & Quoted Messages
 - Uptime & Performance Tracking
+- **Media Support** (Bilder, Videos, GIF-Playback)
+- **Sticker Support** (Bilder, GIFs, Videos → Sticker mit wa-sticker-formatter)
+- Media Download
+- **Group Management** (Erstellen, Bearbeiten, Teilnehmer verwalten)
+- **Advanced Messaging** (Audio, Document, Location, Contact, Reactions)
+- **Contact Management** (Kontakte abrufen, Profilbilder, Status)
+- **Presence & Typing** (Tipp-Indikatoren, Aufnahme-Status)
 
 ### 🚧 In Entwicklung
-- Media Download/Upload
-- Group Management
-- Contact Handling
-- Message Reactions
-- Status/Story Features
-- Typing Indicators
-
-### 📋 Geplant
-- Auto-Reconnect Optionen
 - Message Queue System
 - Rate Limiting
 - Webhook Support
 
+### 📋 Geplant
+- Status/Story Features
+- Broadcast Lists
+- Auto-Reconnect Optionen
+
 ## ✨ Features
 
 - 🔄 **Multi-Session Support** - Unbegrenzt viele WhatsApp-Accounts parallel
@@ -45,8 +48,13 @@ Eine minimalistische, stabile WhatsApp Multi-Device API basierend auf Baileys mi
 npm install
 ```
 
+**Unterstützt beide Formate:**
+- ✅ **ES Modules** (import)
+- ✅ **CommonJS** (require)
+
 ## 🚀 Quick Start
 
+### ES Modules (empfohlen)
 ```javascript
 import { startSession, onMessage, sendText } from '@deathnaitsa/wa-api';
 
@@ -61,6 +69,23 @@ onMessage(async (msg) => {
 });
 ```
 
+### CommonJS
+```javascript
+const { startSession, onMessage, sendText } = require('@deathnaitsa/wa-api');
+
+(async () => {
+    await startSession('bot');
+
+    onMessage(async (msg) => {
+        console.log(`📨 ${msg.from}: ${msg.message}`);
+        
+        if (msg.message === '!ping') {
+            await sendText(msg.sessionId, msg.from, 'Pong! 🏓');
+        }
+    });
+})();
+```
+
 ## 📖 API Dokumentation
 
 ### Verfügbare Funktionen
@@ -99,17 +124,79 @@ onMessage((msg) => {
 });
 ```
 
-#### 🚧 Media (Teilweise implementiert)
+#### ✅ Media & Stickers (Implementiert)
 ```javascript
-import { client } from '@deathnaitsa/wa-api';
+import { 
+    sendImage, 
+    sendVideo, 
+    sendSticker,
+    sendImageAsSticker,
+    sendGifAsSticker,
+    sendVideoAsSticker,
+    downloadMedia 
+} from '@deathnaitsa/wa-api';
+
+// Bilder & Videos senden (✅ Implementiert)
+await sendImage('bot1', '4915123456789@s.whatsapp.net', './photo.jpg', 'Caption');
+await sendVideo('bot1', '4915123456789@s.whatsapp.net', './video.mp4', 'Caption');
+await sendVideo('bot1', '4915123456789@s.whatsapp.net', './gif.mp4', '', true); // GIF-Playback
+
+// Sticker senden (✅ Implementiert mit wa-sticker-formatter)
+// Universell - funktioniert mit Bildern, GIFs und Videos
+await sendSticker('bot1', '4915123456789@s.whatsapp.net', './image.png', {
+    packname: 'Mein Sticker Pack',
+    author: 'Bot Name',
+    type: 'default',  // 'default', 'crop', 'full', 'circle'
+    quality: 100,     // 1-100
+    categories: ['😂', '🎉']
+});
+
+// Spezialisierte Sticker-Funktionen
+await sendImageAsSticker('bot1', 'nummer@s.whatsapp.net', './photo.jpg', {
+    packname: 'Foto Pack',
+    author: 'Bot',
+    type: 'circle'    // Runder Sticker
+});
+
+await sendGifAsSticker('bot1', 'nummer@s.whatsapp.net', './animation.gif', {
+    packname: 'GIF Pack',
+    author: 'Bot'
+});
+
+await sendVideoAsSticker('bot1', 'nummer@s.whatsapp.net', './video.mp4', {
+    packname: 'Video Sticker',
+    author: 'Bot',
+    type: 'full'      // Vollbild ohne Crop
+});
+
+// Mit Buffer
+const fs = require('fs');
+const buffer = fs.readFileSync('./sticker.png');
+await sendSticker('bot1', 'nummer@s.whatsapp.net', buffer, {
+    packname: 'Buffer Pack',
+    author: 'Bot'
+});
+
+// Mit URL
+await sendSticker('bot1', 'nummer@s.whatsapp.net', 'https://example.com/image.png', {
+    packname: 'Online Pack',
+    author: 'Bot'
+});
 
 // Download Media (✅ Implementiert)
-const buffer = await client.downloadMedia(message);
+const buffer = await downloadMedia(message);
+```
+
+**Sticker-Optionen:**
+- `packname` - Name des Sticker-Packs (Standard: 'Nishi API')
+- `author` - Autor des Stickers (Standard: 'WhatsApp Bot')
+- `type` - Sticker-Typ: `'default'`, `'crop'`, `'full'`, `'circle'`
+- `quality` - Qualität: 1-100 (Standard: 100)
+- `categories` - Array von Emoji-Kategorien z.B. `['😂', '🎉']`
 
-// Send Media (❌ Noch nicht implementiert)
-// await client.sendImage(sessionId, jid, buffer, caption);
-// await client.sendVideo(sessionId, jid, buffer, caption);
-// await client.sendAudio(sessionId, jid, buffer);
+**Unterstützte Formate:**
+- Bilder: PNG, JPG, JPEG, WEBP
+- Animiert: GIF, MP4 (max. 10 Sekunden empfohlen)
 ```
 
 #### ✅ Events (Implementiert)
@@ -177,22 +264,194 @@ countReceivedMessage('bot1');
 
 #### ❌ Noch nicht implementiert
 ```javascript
-// Group Management
-// await client.createGroup(sessionId, subject, participants);
-// await client.leaveGroup(sessionId, groupJid);
-// await client.updateGroupSubject(sessionId, groupJid, subject);
-
-// Contact Management  
-// await client.getContacts(sessionId);
-// await client.blockUser(sessionId, jid);
-
 // Status/Stories
 // await client.sendStory(sessionId, content);
-// await client.getStatus(sessionId, jid);
+
+// Broadcast Lists
+// await client.createBroadcastList(sessionId, name, recipients);
+// await client.sendBroadcast(sessionId, broadcastListId, message);
 
 // Advanced Features
-// await client.sendReaction(sessionId, messageKey, emoji);
-// await client.sendPresenceUpdate(sessionId, type);
+// await client.queueMessage(sessionId, to, message, priority);
+// await client.setRateLimit(sessionId, messagesPerMinute);
+```
+
+## 🚀 Neue Features in v2.0
+
+### ✅ Group Management (Implementiert)
+```javascript
+import { 
+    createGroup,
+    getGroupMetadata,
+    updateGroupSubject,
+    updateGroupDescription,
+    addParticipants,
+    removeParticipants,
+    promoteParticipants,
+    demoteParticipants,
+    leaveGroup,
+    getGroupInviteCode,
+    acceptGroupInvite,
+    updateGroupSettings
+} from '@deathnaitsa/wa-api';
+
+// Gruppe erstellen
+const group = await createGroup('bot1', 'Meine Gruppe', [
+    '4915123456789@s.whatsapp.net',
+    '4915987654321@s.whatsapp.net'
+]);
+
+// Gruppen-Metadaten abrufen
+const metadata = await getGroupMetadata('bot1', 'groupId@g.us');
+console.log(metadata.subject, metadata.participants.length);
+
+// Gruppennamen ändern
+await updateGroupSubject('bot1', 'groupId@g.us', 'Neuer Name');
+
+// Beschreibung ändern
+await updateGroupDescription('bot1', 'groupId@g.us', 'Neue Beschreibung');
+
+// Teilnehmer hinzufügen
+await addParticipants('bot1', 'groupId@g.us', ['4915123456789@s.whatsapp.net']);
+
+// Teilnehmer entfernen
+await removeParticipants('bot1', 'groupId@g.us', ['4915123456789@s.whatsapp.net']);
+
+// Zum Admin machen
+await promoteParticipants('bot1', 'groupId@g.us', ['4915123456789@s.whatsapp.net']);
+
+// Admin-Rechte entfernen
+await demoteParticipants('bot1', 'groupId@g.us', ['4915123456789@s.whatsapp.net']);
+
+// Gruppe verlassen
+await leaveGroup('bot1', 'groupId@g.us');
+
+// Einladungslink erhalten
+const code = await getGroupInviteCode('bot1', 'groupId@g.us');
+console.log(`https://chat.whatsapp.com/${code}`);
+
+// Gruppe über Link beitreten
+await acceptGroupInvite('bot1', 'inviteCode');
+
+// Gruppen-Einstellungen (nur Admins können schreiben)
+await updateGroupSettings('bot1', 'groupId@g.us', 'announcement');
+// Alle können schreiben
+await updateGroupSettings('bot1', 'groupId@g.us', 'not_announcement');
+```
+
+### ✅ Advanced Messaging (Implementiert)
+```javascript
+import { 
+    sendAudio,
+    sendDocument,
+    sendLocation,
+    sendContact,
+    sendReaction,
+    deleteMessage
+} from '@deathnaitsa/wa-api';
+
+// Audio senden (Voice Message)
+await sendAudio('bot1', 'nummer@s.whatsapp.net', './audio.mp3', true);
+
+// Audio senden (normaler Audio-File)
+await sendAudio('bot1', 'nummer@s.whatsapp.net', './song.mp3', false);
+
+// Dokument senden
+await sendDocument('bot1', 'nummer@s.whatsapp.net', 
+    './file.pdf', 
+    'Dokument.pdf', 
+    'application/pdf',
+    'Hier ist das Dokument'
+);
+
+// Standort senden
+await sendLocation('bot1', 'nummer@s.whatsapp.net', 52.520008, 13.404954, 'Berlin');
+
+// Kontakt senden
+await sendContact('bot1', 'nummer@s.whatsapp.net', [
+    {
+        displayName: 'Max Mustermann',
+        vcard: 'BEGIN:VCARD\nVERSION:3.0\nFN:Max Mustermann\nTEL:+4915123456789\nEND:VCARD'
+    }
+]);
+
+// Reaktion senden
+await sendReaction('bot1', 'chatId@s.whatsapp.net', 'messageId', '👍');
+
+// Reaktion entfernen
+await sendReaction('bot1', 'chatId@s.whatsapp.net', 'messageId', '');
+
+// Nachricht löschen
+await deleteMessage('bot1', messageKey);
+```
+
+### ✅ Contact Management (Implementiert)
+```javascript
+import { 
+    getProfilePicture,
+    getContact,
+    checkNumbersOnWhatsApp,
+    blockContact,
+    unblockContact,
+    getBusinessProfile,
+    getStatus
+} from '@deathnaitsa/wa-api';
+
+// Profilbild URL abrufen
+const url = await getProfilePicture('bot1', '4915123456789@s.whatsapp.net');
+
+// Kontaktinfo
+const contact = await getContact('bot1', '4915123456789@s.whatsapp.net');
+
+// Nummern auf WhatsApp prüfen
+const results = await checkNumbersOnWhatsApp('bot1', ['4915123456789', '4915987654321']);
+
+// Kontakt blockieren
+await blockContact('bot1', '4915123456789@s.whatsapp.net');
+
+// Kontakt entblocken
+await unblockContact('bot1', '4915123456789@s.whatsapp.net');
+
+// Business-Profil abrufen
+const business = await getBusinessProfile('bot1', 'businessNumber@s.whatsapp.net');
+
+// Status/About abrufen
+const status = await getStatus('bot1', '4915123456789@s.whatsapp.net');
+console.log(status?.status);
+```
+
+### ✅ Presence & Typing (Implementiert)
+```javascript
+import { 
+    sendTyping,
+    sendRecording,
+    updateProfileStatus,
+    updateProfileName,
+    setProfilePicture,
+    markChatRead
+} from '@deathnaitsa/wa-api';
+
+// Tipp-Indikator anzeigen
+await sendTyping('bot1', 'chatId@s.whatsapp.net', true);
+// Stoppen
+await sendTyping('bot1', 'chatId@s.whatsapp.net', false);
+
+// Aufnahme-Indikator anzeigen
+await sendRecording('bot1', 'chatId@s.whatsapp.net', true);
+// Stoppen
+await sendRecording('bot1', 'chatId@s.whatsapp.net', false);
+
+// Eigenen Status ändern
+await updateProfileStatus('bot1', 'Verfügbar 🟢');
+
+// Eigenen Namen ändern
+await updateProfileName('bot1', 'Neuer Name');
+
+// Profilbild setzen
+await setProfilePicture('bot1', './profile.jpg');
+
+// Chat als gelesen markieren
+await markChatRead('bot1', 'chatId@s.whatsapp.net', [messageKey1, messageKey2]);
 ```
 
 ## 🎮 Bot-Beispiel
@@ -200,7 +459,12 @@ countReceivedMessage('bot1');
 Siehe `socket.js` für ein vollständiges Bot-Beispiel mit:
 - Chat-Assignment System (keine Doppel-Antworten bei mehreren Sessions)
 - Command-Lock System (keine Race-Conditions)
-- Deutsche Befehle (!ping, !stats, !gesamtstats, !neustart, etc.)
+- Deutsche Befehle
+  - **Basis**: !ping, !info, !liste, !stats, !gesamtstats
+  - **Gruppen**: !gruppeninfo, !gruppenlink, !gruppenname, !gruppenbio, !hinzufügen, !entfernen, !promoten, !demoten
+  - **Nachrichten**: !ort, !reaktion, !tippen, !aufnehmen
+  - **Profil & Kontakt**: !profilbild, !status, !kontakt, !meinestatus
+  - **Session**: !neustart, !pause, !fortsetzen, !stopp, !löschen, !start, !zuweisen, !zuweisungen
 - Session-Control Commands
 - Latenz-Messung
 
@@ -288,7 +552,8 @@ wa_credentials/             # Session-Daten
 
 ## 🔧 Technologie
 
-- **Baileys v6.7.9** - WhatsApp Multi-Device API
+- **Baileys v7.0.0** - WhatsApp Multi-Device API
+- **wa-sticker-formatter v4.4.4** - Sticker-Konvertierung
 - **Node.js v22+** - ES Modules
 - **Pino** - Logger (Silent Mode)
 - **QRCode-Terminal** - QR-Code Anzeige
@@ -302,28 +567,32 @@ wa_credentials/             # Session-Daten
 
 ## 🛠️ Bekannte Einschränkungen & Design-Entscheidungen
 
-### Nicht implementiert (Stand: November 2024)
-- ❌ Media Upload (Send Image/Video/Audio)
-- ❌ Group Management (Create/Leave/Update Groups)
-- ❌ Contact Management (Block/Unblock)
-- ❌ Status/Story Features
-- ❌ Message Reactions
-- ❌ Typing Indicators
-- ❌ Presence Updates (Online/Offline Status)
+### Nicht implementiert (Stand: Dezember 2024)
+- ❌ Status/Story Features (Upload/View/Delete Stories)
+- ❌ Broadcast Lists
 - ❌ Auto-Reconnect (bewusst einfach gehalten)
 - ❌ Message Queue/Rate Limiting
 - ❌ Webhook Support
+- ❌ Poll Messages
+- ❌ Chat Archive/Mute/Pin Features
+
+### Neu implementiert in v2.0 ✅
+- ✅ Group Management (Complete)
+- ✅ Advanced Messaging (Audio, Document, Location, Contact, Reactions)
+- ✅ Contact Management (Profile Pictures, Status, Block/Unblock)
+- ✅ Presence & Typing Indicators
+- ✅ Profile Updates (Status, Name, Picture)
 
 ### Design-Philosophie
 - **Einfachheit über Features** - Lieber stabil als feature-reich
 - **Kein Auto-Reconnect** - Manuelles Management für mehr Kontrolle
-- **Minimale Dependencies** - Nur Baileys, Pino, QRCode-Terminal
+- **Minimale Dependencies** - Nur Baileys, Pino, QRCode-Terminal, wa-sticker-formatter
 - **Event-Driven** - Keine Polling, nur Events
 - **Map-basiert** - Schnelle Session-Lookups
 
 ### Performance-Charakteristiken
 - ✅ Sehr schnelle Session-Switches
-- ✅ Geringer Memory-Footprint (~50MB pro Session)
+- ✅ Geringer Memory-Footprint (~50-80MB pro Session)
 - ✅ Keine Blocking Operations
 - ⚠️ Kein Built-in Rate Limiting (muss selbst implementiert werden)