@deathnaitsa/wa-api 2.1.1 → 2.1.2

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