@neelegirl/wa-api 1.6.4 → 1.6.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/dist/Socket/index.js +1 -1
  2. package/package.json +5 -5
  3. package/readme.md +113 -36
package/dist/Socket/index.js CHANGED
@@ -16,7 +16,7 @@ const sessions = new Map();
16
16
  const callback = new Map();
17
17
  const retryCount = new Map();
18
18
 
19
- let CURRENT_WA_API_VERSION = "1.5.1";
19
+ let CURRENT_WA_API_VERSION = "1.6.5";
20
20
  let waApiUpdateCheckDone = false;
21
21
 
22
22
  try {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
- {
1
+ {
2
2
  "name": "@neelegirl/wa-api",
3
- "version": "1.6.4",
3
+ "version": "1.6.5",
4
4
  "description": "Multi-session WhatsApp API wrapper built on @neelegirl/baileys",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -25,7 +25,7 @@
25
25
  "author": "Neele",
26
26
  "license": "MIT",
27
27
  "dependencies": {
28
- "@neelegirl/baileys": "^2.1.4",
28
+ "@neelegirl/baileys": "^2.1.5",
29
29
  "pino": "^8.11.0"
30
30
  },
31
31
  "devDependencies": {
@@ -41,9 +41,9 @@
41
41
  "neelegirl"
42
42
  ],
43
43
  "peerDependencies": {
44
- "@neelegirl/baileys": "^2.1.4"
44
+ "@neelegirl/baileys": "^2.1.5"
45
45
  },
46
46
  "engines": {
47
47
  "node": ">=20.0.0"
48
48
  }
49
- }
49
+ }
package/readme.md CHANGED
@@ -4,8 +4,8 @@
4
4
 
5
5
  ### High-level multi-session WhatsApp API on top of @neelegirl/baileys
6
6
 
7
- [![Version](https://img.shields.io/badge/Version-1.6.4-ff69b4?style=for-the-badge)](https://www.npmjs.com/package/@neelegirl/wa-api)
8
- [![Core](https://img.shields.io/badge/Core-@neelegirl%2Fbaileys%202.1.4-9b59b6?style=for-the-badge)](https://www.npmjs.com/package/@neelegirl/baileys)
7
+ [![Version](https://img.shields.io/badge/Version-1.6.5-ff69b4?style=for-the-badge)](https://www.npmjs.com/package/@neelegirl/wa-api)
8
+ [![Core](https://img.shields.io/badge/Core-@neelegirl%2Fbaileys%202.1.5-9b59b6?style=for-the-badge)](https://www.npmjs.com/package/@neelegirl/baileys)
9
9
  [![Node](https://img.shields.io/badge/Node-20%2B-2ea043?style=for-the-badge&logo=node.js)](https://nodejs.org)
10
10
  [![License](https://img.shields.io/badge/License-MIT-f97316?style=for-the-badge)](LICENSE)
11
11
 
@@ -13,40 +13,43 @@
13
13
  <img src="https://files.catbox.moe/6np1ii.JPG" width="760" alt="Neelegirl wa-api Header" />
14
14
  </p>
15
15
 
16
- | Package | Latest Version | Depends On |
16
+ | Paket | Version | Abhaengigkeit |
17
17
  |---|---:|---|
18
- | `@neelegirl/wa-api` | `1.6.4` | `@neelegirl/baileys ^2.1.4` |
18
+ | `@neelegirl/wa-api` | `1.6.5` | `@neelegirl/baileys ^2.1.5` |
19
19
 
20
- [Installation](#installation) · [Quickstart](#quickstart) · [API Overview](#api-overview) · [Operational Notes](#operational-notes)
20
+ [Installation](#installation) · [Quickstart](#quickstart) · [Session-Logik](#session-logik) · [Messaging](#messaging)
21
21
 
22
22
  </div>
23
23
 
24
24
  ---
25
25
 
26
- ## Table of Contents
26
+ ## Inhaltsverzeichnis
27
27
 
28
- - [Overview](#overview)
28
+ - [Uebersicht](#uebersicht)
29
29
  - [Installation](#installation)
30
30
  - [Quickstart](#quickstart)
31
- - [API Overview](#api-overview)
32
- - [Operational Notes](#operational-notes)
33
- - [Word2Web Notes](#word2web-notes)
31
+ - [Session-Logik](#session-logik)
32
+ - [Messaging](#messaging)
33
+ - [Event-System](#event-system)
34
+ - [Aenderungen und Hinweise](#aenderungen--hinweise)
35
+ - [libsignal Bezug](#libsignal-bezug)
36
+ - [Word2Web Hinweise](#word2web-hinweise)
34
37
  - [Changelog](#changelog)
35
38
  - [Legal](#legal)
36
39
 
37
40
  ---
38
41
 
39
- ## Overview
42
+ ## Uebersicht
40
43
 
41
- `@neelegirl/wa-api` provides a higher-level interface for multi-session WhatsApp automation while delegating socket/runtime behavior to `@neelegirl/baileys`.
44
+ `@neelegirl/wa-api` ist die higher-level API fuer Multi-Session-Betrieb. Die eigentliche WhatsApp-Socket-Laufzeit kommt aus `@neelegirl/baileys`, wa-api kapselt darauf Sessionverwaltung, Callback-Flow und vereinfachtes Messaging.
42
45
 
43
- Main capabilities:
46
+ Aus den Quell-READMEs uebernommen und auf den echten Stand angepasst:
44
47
 
45
- - Session lifecycle management (`start`, `stop`, `delete`, `load`)
46
- - QR callback flow and pairing-code callback flow
47
- - Message receive/update callbacks
48
- - Helper senders (`sendMessage`, `sendStatusMentions`, `relayMessage`)
49
- - File-based credential persistence per session
48
+ - Session-Start per QR oder Pairing-Code
49
+ - Session-Laden aus Storage
50
+ - Event-Hooks fuer Message/Connection/QR/Pairing
51
+ - Helper fuer `sendMessage`, `sendStatusMentions`, `relayMessage`
52
+ - technische Hinweise zu Reconnect, Credentials-Pfad und Update-Check
50
53
 
51
54
  ---
52
55
 
@@ -56,6 +59,16 @@ Main capabilities:
56
59
  npm install @neelegirl/wa-api
57
60
  ```
58
61
 
62
+ Import:
63
+
64
+ ```js
65
+ // CommonJS
66
+ const wa = require('@neelegirl/wa-api')
67
+
68
+ // ESM (namespace import auf CJS)
69
+ import * as wa from '@neelegirl/wa-api'
70
+ ```
71
+
59
72
  ---
60
73
 
61
74
  ## Quickstart
@@ -64,7 +77,7 @@ npm install @neelegirl/wa-api
64
77
  const wa = require('@neelegirl/wa-api')
65
78
 
66
79
  wa.onQRUpdated(({ sessionId, qr }) => {
67
- console.log('QR updated:', sessionId)
80
+ console.log('QR for', sessionId)
68
81
  console.log(qr)
69
82
  })
70
83
 
@@ -86,24 +99,61 @@ wa.startSession('main', { printQR: true }).catch(console.error)
86
99
 
87
100
  ---
88
101
 
89
- ## API Overview
102
+ ## Session-Logik
90
103
 
91
- Session lifecycle:
104
+ ### Starten
92
105
 
93
- - `startSession(sessionId, options)`
106
+ - `startSession(sessionId, { printQR })`
94
107
  - `startSessionWithPairingCode(sessionId, { phoneNumber }, pairingCode?)`
95
- - `deleteSession(sessionId)`
108
+
109
+ ### Verwalten
110
+
96
111
  - `getSession(sessionId)`
97
112
  - `getAllSession()`
113
+ - `deleteSession(sessionId)`
98
114
  - `loadSessionsFromStorage()`
99
115
 
100
- Messaging:
116
+ ### Laufzeitverhalten
117
+
118
+ - Credentials-Verzeichnisse: `wa_credentials/<session>_credentials`
119
+ - Auto-Reconnect bis zu 10 Versuche (außer bei `loggedOut`)
120
+ - npm-Update-Check fuer `@neelegirl/wa-api` einmal pro Prozess
121
+
122
+ ---
123
+
124
+ ## Messaging
125
+
126
+ ### API
101
127
 
102
128
  - `sendMessage(sessionId, jidOrPhone, content, options?)`
103
129
  - `sendStatusMentions(sessionId, content, options?)`
104
130
  - `relayMessage(sessionId, jidOrPhone, content, options?)`
105
131
 
106
- Event hooks:
132
+ ### Beispiele
133
+
134
+ ```js
135
+ // Text
136
+ await wa.sendMessage('main', '491234567890', { text: 'Hallo' })
137
+
138
+ // Bild
139
+ await wa.sendMessage('main', '491234567890@s.whatsapp.net', {
140
+ image: { url: './image.jpg' },
141
+ caption: 'Bild-Text'
142
+ })
143
+
144
+ // Antwort mit Quote
145
+ await wa.sendMessage('main', '491234567890@s.whatsapp.net', {
146
+ text: 'Antwort'
147
+ }, {
148
+ quoted: originalMessage
149
+ })
150
+ ```
151
+
152
+ Hinweis: Eingehende Nachrichten erhalten Helper wie `saveImage`, `saveVideo`, `saveDocument`.
153
+
154
+ ---
155
+
156
+ ## Event-System
107
157
 
108
158
  - `onMessageReceived(listener)`
109
159
  - `onMessageUpdate(listener)`
@@ -113,33 +163,60 @@ Event hooks:
113
163
  - `onDisconnected(listener)`
114
164
  - `onPairingCode(listener)`
115
165
 
166
+ Beispiel:
167
+
168
+ ```js
169
+ wa.onMessageUpdate((sessionId, data) => {
170
+ console.log('Update in', sessionId, data.messageStatus)
171
+ })
172
+ ```
173
+
116
174
  ---
117
175
 
118
- ## Operational Notes
176
+ ## Aenderungen & Hinweise
119
177
 
120
- - Node.js `>=20` required
121
- - Credentials default path: `wa_credentials/<session>_credentials`
122
- - Reconnect retries are handled internally
123
- - Depends on `@neelegirl/baileys` runtime behavior, including custom Neelegirl compatibility logic
178
+ Diese README uebernimmt die Erklaerungslogik aus den zwei Desktop-Quellen und bereinigt dabei veraltete oder widerspruechliche Punkte.
179
+
180
+ Bewusst uebernommen:
181
+
182
+ - Multi-Session-Nutzungslogik
183
+ - Event- und Messaging-Erklaerungen
184
+ - technische Hinweise zu Stability/Update/Session-Speicherung
185
+
186
+ Bewusst nicht 1:1 uebernommen:
187
+
188
+ - veraltete Versionsangaben und alte Badge-Werte
189
+ - Aussagen zu Features, die im lokalen Paket nicht eindeutig vorhanden sind
190
+
191
+ ---
192
+
193
+ ## libsignal Bezug
194
+
195
+ wa-api nutzt libsignal nicht direkt als API, aber indirekt ueber `@neelegirl/baileys`. Der Krypto-/Session-Unterbau (Identity, PreKeys, SessionCipher) kommt damit aus `@neelegirl/libsignal`.
124
196
 
125
197
  ---
126
198
 
127
- ## Word2Web Notes
199
+ ## Word2Web Hinweise
128
200
 
129
- No dedicated Word2Web module is bundled in this package. Only document Word2Web behavior if implemented by your own host app.
201
+ Kein dediziertes Word2Web-Modul im Paket. Word2Web-spezifische Hinweise sollten nur dokumentiert werden, wenn deine Host-App die entsprechende Logik bereitstellt.
130
202
 
131
203
  ---
132
204
 
133
205
  ## Changelog
134
206
 
207
+ ### 1.6.5
208
+
209
+ - README inhaltlich aus den Quell-READMEs zusammengefuehrt und technisch bereinigt
210
+ - Session-/Messaging-/Event-Doku auf echte `dist`-Exports abgestimmt
211
+ - Abhaengigkeit und Peer-Range auf `@neelegirl/baileys ^2.1.5` aktualisiert
212
+
135
213
  ### 1.6.4
136
214
 
137
- - README restyled to match the main project presentation style
138
- - Package metadata aligned with current dependency versions
139
- - Dependency/peer range updated to `@neelegirl/baileys ^2.1.4`
215
+ - Style-/Layout-Refresh der Dokumentation
216
+ - API- und Paketmetadaten konsistent gemacht
140
217
 
141
218
  ---
142
219
 
143
220
  ## Legal
144
221
 
145
- This project is not affiliated with WhatsApp. Use responsibly and comply with platform terms and local laws.
222
+ Dieses Projekt ist nicht mit WhatsApp verbunden. Nutzung nur in Uebereinstimmung mit geltendem Recht und Plattformregeln.