@deathnaitsa/wa-api 2.0.28 → 2.1.0

package/CONFIG.md

@@ -0,0 +1,350 @@
+# Config-System - Nishi WhatsApp API
+
+## 🎯 Überblick
+
+Das neue Config-System ermöglicht zentrale Konfiguration aller API-Einstellungen über eine `wa-api.config.js` Datei.
+
+## ✨ Vorteile
+
+- **Keine Wiederholungen**: Einmal konfigurieren, überall verwenden
+- **Zentrale Verwaltung**: Alle Einstellungen an einem Ort
+- **Einfaches Deployment**: Config-Datei bearbeiten statt Code ändern
+- **Footer/Wasserzeichen**: Automatisch auf alle Nachrichten anwenden
+- **Überschreibbar**: Config-Defaults können jederzeit überschrieben werden
+
+## 🚀 Quick Start
+
+### 1. Config erstellen
+
+```javascript
+import { initConfig } from '@deathnaitsa/wa-api';
+
+initConfig(); // Erstellt wa-api.config.js
+```
+
+### 2. Config anpassen
+
+```javascript
+// wa-api.config.js
+export const waApiConfig = {
+    session: {
+        useSqlByDefault: true,      // Alle Sessions verwenden SQLite
+        autoReconnect: true,         // Auto-Reconnect für alle
+        printQR: true,
+    },
+    
+    footer: {
+        enabled: true,               // Footer aktivieren
+        text: 'Made with Nishi API 🚀',
+    },
+};
+```
+
+### 3. Verwenden
+
+```javascript
+// Verwendet automatisch Config-Einstellungen
+await startSession('bot1'); // SQLite + Auto-Reconnect aktiv!
+
+// Footer wird automatisch angehängt
+await sendText('bot1', jid, 'Hallo!');
+```
+
+## 📋 Verfügbare Config-Optionen
+
+### Session-Einstellungen
+```javascript
+session: {
+    useSqlByDefault: false,         // SQLite als Standard
+    browser: ['Chrome', '120.0.0', 'Windows'],
+    printQR: true,
+    credentialsDir: './sessions',
+    autoReconnect: false,
+    logLevel: 'silent',
+    markOnlineOnConnect: false,
+}
+```
+
+### Auto-Reconnect
+```javascript
+reconnect: {
+    maxRetries: 5,
+    initialDelay: 2000,
+    maxDelay: 30000,
+    multiplier: 2,
+}
+```
+
+### Footer/Wasserzeichen ⭐ NEU
+```javascript
+footer: {
+    enabled: false,                 // Footer aktivieren/deaktivieren
+    text: 'Nishi WhatsApp API',    // Footer-Text
+    applyToTypes: ['text', 'image', 'video', 'audio', 'document', 'sticker'], // Alle Typen!
+    onlyOutgoing: true,             // Nur ausgehende Nachrichten
+}
+```
+
+### Rate Limiting
+```javascript
+rateLimit: {
+    enabled: false,
+    maxMessages: 20,
+    interval: 60000,
+    queueInterval: 1000,
+}
+```
+
+### Webhooks
+```javascript
+webhook: {
+    defaultUrl: null,
+    timeout: 5000,
+    retry: true,
+    maxRetries: 3,
+}
+```
+
+### Statistiken
+```javascript
+stats: {
+    enabled: true,
+    filePath: './sessions/stats.json',
+    autoSaveInterval: 60000,
+}
+```
+
+### Message Store
+```javascript
+messageStore: {
+    enabled: true,
+    maxMessages: 1000,
+    maxAge: 24, // Stunden
+}
+```
+
+### Media
+```javascript
+media: {
+    autoDownload: false,
+    downloadDir: './media',
+    maxFileSize: 100, // MB
+}
+```
+
+### Sticker
+```javascript
+sticker: {
+    packname: 'Nishi API',
+    author: 'WhatsApp Bot',
+    categories: ['🤖', '🚀'],
+}
+```
+
+### Features
+```javascript
+features: {
+    groupManagement: true,
+    stories: true,
+    polls: true,
+    broadcast: true,
+    contacts: true,
+}
+```
+
+### Developer
+```javascript
+developer: {
+    debug: false,
+    verbose: false,
+    showStackTrace: true,
+}
+```
+
+## 🎨 Use Cases
+
+### Use Case 1: Production Setup
+```javascript
+// wa-api.config.js
+export const waApiConfig = {
+    session: {
+        useSqlByDefault: true,      // Nur 1 DB statt 100+ JSON-Files
+        autoReconnect: true,         // Auto-Reconnect aktiviert
+        logLevel: 'error',           // Nur Errors loggen
+    },
+    footer: {
+        enabled: true,
+        text: 'Support: @mybot',
+    },
+    stats: {
+        enabled: true,
+        autoSaveInterval: 300000,    // Alle 5 Minuten
+    },
+};
+```
+
+### Use Case 2: Development Setup
+```javascript
+// wa-api.config.js
+export const waApiConfig = {
+    session: {
+        useSqlByDefault: false,      // JSON-Files für schnelles Testen
+        autoReconnect: false,        // Kein Auto-Reconnect beim Debuggen
+        printQR: true,
+    },
+    footer: {
+        enabled: false,              // Kein Footer im Dev-Modus
+    },
+    developer: {
+        debug: true,
+        verbose: true,
+        showStackTrace: true,
+    },
+};
+```
+
+### Use Case 3: Bot mit Branding
+```javascript
+// wa-api.config.js
+export const waApiConfig = {
+    session: {
+        useSqlByDefault: true,
+        autoReconnect: true,
+    },
+    footer: {
+        enabled: true,
+        text: '🤖 MyCompany Bot | support@mycompany.com',
+        applyToTypes: ['text'],
+    },
+    sticker: {
+        packname: 'MyCompany Stickers',
+        author: 'MyCompany Bot',
+    },
+};
+```
+
+## 🔄 Config überschreiben
+
+Config-Defaults können jederzeit überschrieben werden:
+
+```javascript
+// Config sagt: useSqlByDefault: true
+await startSession('bot1'); // Verwendet SQLite
+
+// Für diese Session JSON-Files verwenden:
+await startSession('bot2', { sql: false }); // Überschreibt Config
+```
+
+## 📝 Footer-Implementierung
+
+Der Footer wird über WhatsApp's `interactiveMessage` mit `viewOnceMessage` implementiert und funktioniert für ALLE Nachrichtentypen:
+
+```javascript
+// Automatisch bei aktiviertem Footer:
+await sendText('bot', jid, 'Hallo Welt!');
+await sendImage('bot', jid, image, 'Schau mal!');
+await sendVideo('bot', jid, video, 'Cool!');
+await sendAudio('bot', jid, audio);
+await sendDocument('bot', jid, doc, 'Dokument');
+
+// Alle haben den Footer:
+// ┌─────────────────┐
+// │ Nachricht       │
+// │ oder Media      │
+// │                 │
+// │ Made with ❤️    │ ← Footer
+// └─────────────────┘
+```
+
+**Unterstützte Typen:**
+- ✅ Text
+- ✅ Image (mit Caption)
+- ✅ Video (mit Caption)
+- ✅ Audio
+- ✅ Document
+- ✅ Sticker
+
+## 🛠️ API
+
+### initConfig(targetDir)
+Erstellt `wa-api.config.js` im angegebenen Verzeichnis.
+
+```javascript
+import { initConfig } from '@deathnaitsa/wa-api';
+
+initConfig(); // Erstellt in process.cwd()
+initConfig('./my-project'); // Erstellt in ./my-project
+```
+
+### loadConfig(targetDir)
+Lädt Config aus Verzeichnis oder fällt zurück auf Defaults.
+
+```javascript
+import { loadConfig } from '@deathnaitsa/wa-api';
+
+const config = await loadConfig();
+console.log(config.footer.enabled);
+```
+
+### getConfigPath(targetDir)
+Gibt den Config-Pfad zurück.
+
+```javascript
+import { getConfigPath } from '@deathnaitsa/wa-api';
+
+console.log(getConfigPath()); // /path/to/project/wa-api.config.js
+```
+
+## 📦 Migration
+
+### Vorher (ohne Config)
+```javascript
+await startSession('bot1', { 
+    sql: true, 
+    autoReconnect: true,
+    printQR: true 
+});
+await startSession('bot2', { 
+    sql: true, 
+    autoReconnect: true,
+    printQR: true 
+});
+await startSession('bot3', { 
+    sql: true, 
+    autoReconnect: true,
+    printQR: true 
+});
+```
+
+### Nachher (mit Config)
+```javascript
+// wa-api.config.js
+export const waApiConfig = {
+    session: {
+        useSqlByDefault: true,
+        autoReconnect: true,
+        printQR: true,
+    },
+};
+
+// Code
+await startSession('bot1');
+await startSession('bot2');
+await startSession('bot3');
+```
+
+## 🎯 Zusammenfassung
+
+Das Config-System bietet:
+- ✅ Zentrale Konfiguration
+- ✅ Footer/Wasserzeichen Support
+- ✅ Keine Code-Änderungen für Config-Updates
+- ✅ Überschreibbare Defaults
+- ✅ Production-Ready
+- ✅ Development-Friendly
+
+Perfect für:
+- 🏢 Production Deployments
+- 🤖 Bot-Projekte mit Branding
+- 📊 Multi-Session Setups
+- 🔧 Flexible Konfigurationen

package/README.md

@@ -8,8 +8,7 @@ Eine minimalistische, stabile WhatsApp Multi-Device API basierend auf Baileys mi
 - [Features](#-features)
 - [Installation](#-installation)
 - [Quick Start](#-quick-start)
-  - [ES Modules](#es-modules-empfohlen)
-  - [CommonJS](#commonjs)
+- [Configuration](#-configuration)
 - [API Dokumentation](#-api-dokumentation)
   - [Session Management](#-session-management-implementiert)
   - [Nachrichten](#-nachrichten-implementiert)
@@ -87,13 +86,46 @@ npm install
 npm install better-sqlite3
 ```
 
+**Config-Datei erstellen (empfohlen)**
+```bash
+node -e "import('@deathnaitsa/wa-api').then(m => m.initConfig())"
+```
+
+Dies erstellt eine `wa-api.config.js` im Hauptverzeichnis mit allen verfügbaren Einstellungen.
+
 **Unterstützt beide Formate:**
 - ✅ **ES Modules** (import)
 - ✅ **CommonJS** (require)
 
 ## 🚀 Quick Start
 
-### ES Modules (empfohlen)
+### 1. Config erstellen (optional, aber empfohlen)
+```javascript
+import { initConfig } from '@deathnaitsa/wa-api';
+
+// Erstellt wa-api.config.js im Hauptverzeichnis
+initConfig();
+```
+
+Dann in `wa-api.config.js` deine Einstellungen anpassen:
+```javascript
+export const waApiConfig = {
+    session: {
+        useSqlByDefault: true,  // SQLite als Standard
+        printQR: true,
+        autoReconnect: true,
+    },
+    footer: {
+        enabled: true,          // Footer aktivieren
+        text: 'Powered by Nishi API 🚀',
+    },
+    // ... weitere Einstellungen
+};
+```
+
+### 2. Session starten
+
+#### ES Modules (empfohlen)
 ```javascript
 import { startSession, onMessage, sendText } from '@deathnaitsa/wa-api';
 
@@ -108,7 +140,7 @@ onMessage(async (msg) => {
 });
 ```
 
-### CommonJS
+#### CommonJS
 ```javascript
 const { startSession, onMessage, sendText } = require('@deathnaitsa/wa-api');
 
@@ -132,18 +164,27 @@ const { startSession, onMessage, sendText } = require('@deathnaitsa/wa-api');
 #### ✅ Session Management (Implementiert)
 ```javascript
 import { 
-    startSession,      // Session starten
-    stopSession,       // Session stoppen
-    restartSession,    // Session neu starten
-    client             // Direct client access
+    startSession,               // Session starten (mit QR-Code)
+    startSessionWithPairingCode,// Session mit Pairing Code starten
+    stopSession,                // Session stoppen
+    restartSession,             // Session neu starten
+    client                      // Direct client access
 } from '@deathnaitsa/wa-api';
 
-// Standard Session (JSON-Files)
+// Standard Session mit QR-Code (JSON-Files)
 await startSession('bot1');
 
+// Session mit Pairing Code (Alternative zu QR-Code)
+const { code } = await startSessionWithPairingCode('bot1', '491234567890');
+console.log('Gib diesen Code in WhatsApp ein:', code);
+// Telefonnummer ohne +, z.B. "491234567890" statt "+49 123 456 7890"
+
 // Session mit SQLite Auth (empfohlen für Production!)
 await startSession('bot1', { sql: true });
 
+// Pairing Code mit SQLite
+await startSessionWithPairingCode('bot1', '491234567890', { sql: true });
+
 // Weitere Optionen
 await startSession('bot1', {
     sql: true,              // ✅ SQLite statt JSON-Files
@@ -184,6 +225,114 @@ await startSession('main', {
 npm install better-sqlite3
 ```
 
+## ⚙️ Configuration
+
+Die Nishi WhatsApp API kann über eine zentrale Config-Datei konfiguriert werden. Dies erspart dir, bei jedem `startSession()` Aufruf die gleichen Optionen anzugeben.
+
+### Config-Datei erstellen
+
+```javascript
+import { initConfig } from '@deathnaitsa/wa-api';
+
+initConfig(); // Erstellt wa-api.config.js im Hauptverzeichnis
+```
+
+Oder über CLI:
+```bash
+node -e "import('@deathnaitsa/wa-api').then(m => m.initConfig())"
+```
+
+### Verfügbare Config-Optionen
+
+```javascript
+// wa-api.config.js
+export const waApiConfig = {
+    // Session-Einstellungen
+    session: {
+        useSqlByDefault: true,              // SQLite statt JSON-Files
+        browser: ['Chrome', '120.0.0', 'Windows'],
+        printQR: true,
+        credentialsDir: './sessions',
+        autoReconnect: true,
+        logLevel: 'silent',                 // 'trace', 'debug', 'info', 'warn', 'error', 'fatal', 'silent'
+        markOnlineOnConnect: false,
+    },
+
+    // Auto-Reconnect Einstellungen
+    reconnect: {
+        maxRetries: 5,
+        initialDelay: 2000,
+        maxDelay: 30000,
+        multiplier: 2,
+    },
+
+    // Footer/Wasserzeichen für Nachrichten ✨ NEU!
+    footer: {
+        enabled: true,                       // Footer aktivieren
+        text: 'Powered by Nishi API 🚀',    // Footer-Text
+        applyToTypes: ['text', 'image', 'video', 'audio', 'document', 'sticker'], // Alle Typen!
+        onlyOutgoing: true,
+    },
+
+    // Rate Limiting
+    rateLimit: {
+        enabled: false,
+        maxMessages: 20,
+        interval: 60000,
+        queueInterval: 1000,
+    },
+
+    // Webhook, Stats, Media, Sticker, Features, Developer...
+    // Siehe wa-api.config.js für alle Optionen
+};
+```
+
+### Config verwenden
+
+**Mit Config-Datei:**
+```javascript
+// wa-api.config.js: useSqlByDefault: true, autoReconnect: true
+
+import { startSession } from '@deathnaitsa/wa-api';
+
+// Verwendet automatisch SQLite und Auto-Reconnect aus Config
+await startSession('bot1');
+```
+
+**Config überschreiben:**
+```javascript
+// Config sagt: useSqlByDefault: true
+// Aber für diese Session wollen wir JSON-Files:
+await startSession('bot1', { sql: false });
+```
+
+### Footer/Wasserzeichen Beispiel
+
+```javascript
+// wa-api.config.js
+footer: {
+    enabled: true,
+    text: '🤖 Powered by Nishi Bot',
+    applyToTypes: ['text'],
+}
+```
+
+Jetzt haben **alle** Text-Nachrichten automatisch einen Footer:
+```javascript
+await sendText('bot1', jid, 'Hallo Welt!');
+// Wird gesendet mit Footer "🤖 Powered by Nishi Bot"
+
+// Funktioniert auch für Media:
+await sendImage('bot1', jid, image, 'Schau mal!');
+// Bild mit Caption + Footer
+
+await sendVideo('bot1', jid, video, 'Cool!');
+// Video mit Caption + Footer
+
+await sendDocument('bot1', jid, doc);
+// Dokument mit Footer
+```
+
 #### ✅ Nachrichten (Implementiert)
 ```javascript
 import { sendText, onMessage } from '@deathnaitsa/wa-api';
@@ -355,7 +504,13 @@ const buffer = await downloadMedia(message);
 
 #### ✅ Events (Implementiert)
 ```javascript
-import { onMessage, onConnected, onDisconnected, onQRUpdate } from '@deathnaitsa/wa-api';
+import { 
+    onMessage, 
+    onConnected, 
+    onDisconnected, 
+    onQRUpdate,
+    onPairingCode 
+} from '@deathnaitsa/wa-api';
 
 onMessage((msg) => {
     // Neue Nachricht empfangen
@@ -369,7 +524,7 @@ onDisconnected(({ sessionId, reason }) => {
     console.log(`${sessionId} getrennt: ${reason}`);
 });
 
-// QR-Code Updates (✅ Neu!)
+// QR-Code Updates
 onQRUpdate(({ sessionId, qr }) => {
     console.log(`📱 QR-Code für Session ${sessionId} generiert!`);
     console.log(`QR-String: ${qr}`);
@@ -381,6 +536,17 @@ onQRUpdate(({ sessionId, qr }) => {
     // 4. In Datenbank speichern
 });
 
+// Pairing Code Updates (✅ Neu!)
+onPairingCode(({ sessionId, phoneNumber, code }) => {
+    console.log(`🔐 Pairing Code für ${sessionId} (${phoneNumber}): ${code}`);
+    
+    // Beispiele für die Verwendung:
+    // 1. Code an Frontend/User anzeigen
+    // 2. Per SMS/Email versenden
+    // 3. In Datenbank speichern
+    // 4. Per WebSocket an Client schicken
+});
+
 // Weitere Events über Client:
 client.on('groups:update', ({ sessionId, updates }) => {});
 client.on('presence', ({ sessionId, id, presences }) => {});