@neelegirl/baileys 2.1.3 → 2.1.4

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 (2) hide show
  1. package/README.md +89 -34
  2. package/package.json +20 -14
package/README.md CHANGED
@@ -1,37 +1,61 @@
1
- # @neelegirl/baileys
1
+ <div align="center">
2
2
 
3
- ![Neelegirl Baileys](https://files.catbox.moe/phppor.JPG)
3
+ # @neelegirl/baileys
4
4
 
5
- CJS-compatible Baileys fork for projects that depend on `require()` runtime behavior, especially `@neelegirl/wa-api`.
5
+ ### CJS-compatible WhatsApp Web API foundation for the Neelegirl ecosystem
6
6
 
7
- ## Status
7
+ [![Version](https://img.shields.io/badge/Version-2.1.4-ff69b4?style=for-the-badge)](https://www.npmjs.com/package/@neelegirl/baileys)
8
+ [![Upstream](https://img.shields.io/badge/Upstream-WhiskeySockets%2FBaileys%207.0.0--rc.9-9b59b6?style=for-the-badge)](https://github.com/WhiskeySockets/Baileys)
9
+ [![Node](https://img.shields.io/badge/Node-20%2B-2ea043?style=for-the-badge&logo=node.js)](https://nodejs.org)
10
+ [![License](https://img.shields.io/badge/License-MIT-f97316?style=for-the-badge)](LICENSE)
8
11
 
9
- - Upstream base: `WhiskeySockets/Baileys` `v7.0.0-rc.9`
10
- - Upstream tracking: latest WhatsApp Web version update from upstream master integrated
11
- - Local package version: `2.1.0`
12
- - Node.js: `>=20`
12
+ <p align="center">
13
+ <img src="https://files.catbox.moe/phppor.JPG" width="760" alt="Neelegirl Baileys Header" />
14
+ </p>
13
15
 
14
- ## What This Fork Keeps
16
+ | Package | Latest Version | Upstream Base |
17
+ |---|---:|---|
18
+ | `@neelegirl/baileys` | `2.1.4` | `WhiskeySockets/Baileys v7.0.0-rc.9` |
15
19
 
16
- - Existing QR handling logic (unchanged)
17
- - Existing message-id signature logic containing `NEELE` (unchanged)
18
- - CJS-first runtime shape used by current Neelegirl ecosystem
20
+ [Installation](#installation) · [Quickstart](#quickstart) · [Feature Overview](#feature-overview) · [Compatibility Notes](#compatibility-notes)
19
21
 
20
- ## What Is Included
22
+ </div>
21
23
 
22
- - Full socket/event/auth API surface exported from `lib/`
23
- - LID and hosted JID handling in receive/send pipelines
24
- - Group, community, newsletter, and media helpers
25
- - Store helpers (`makeInMemoryStore`, cache-manager store)
26
- - Optional QR terminal rendering via `qrcode-terminal`
24
+ ---
27
25
 
28
- ## Install
26
+ ## Table of Contents
27
+
28
+ - [Why this fork](#why-this-fork)
29
+ - [Installation](#installation)
30
+ - [Quickstart](#quickstart)
31
+ - [Feature Overview](#feature-overview)
32
+ - [Compatibility Notes](#compatibility-notes)
33
+ - [Word2Web Notes](#word2web-notes)
34
+ - [Changelog](#changelog)
35
+ - [Legal](#legal)
36
+
37
+ ---
38
+
39
+ ## Why this fork
40
+
41
+ `@neelegirl/baileys` keeps a CJS-first runtime for projects that depend on `require()` behavior while integrating relevant upstream updates.
42
+
43
+ This fork explicitly keeps two project-critical customizations unchanged:
44
+
45
+ - QR-code handling logic stays unchanged.
46
+ - Message-ID logic containing `NEELE` stays unchanged.
47
+
48
+ ---
49
+
50
+ ## Installation
29
51
 
30
52
  ```bash
31
53
  npm install @neelegirl/baileys
32
54
  ```
33
55
 
34
- ## Quick Start
56
+ ---
57
+
58
+ ## Quickstart
35
59
 
36
60
  ```js
37
61
  const {
@@ -42,42 +66,73 @@ const {
42
66
  Browsers,
43
67
  } = require('@neelegirl/baileys')
44
68
 
45
- async function boot() {
46
- const { state, saveCreds } = await useMultiFileAuthState('./wa_auth')
69
+ async function start() {
70
+ const { state, saveCreds } = await useMultiFileAuthState('./auth')
47
71
  const { version } = await fetchLatestBaileysVersion()
48
72
 
49
73
  const sock = makeWASocket({
50
- version,
51
74
  auth: state,
75
+ version,
52
76
  printQRInTerminal: true,
53
77
  browser: Browsers.ubuntu('Chrome'),
54
78
  })
55
79
 
56
80
  sock.ev.on('creds.update', saveCreds)
81
+
57
82
  sock.ev.on('connection.update', ({ connection, lastDisconnect }) => {
58
83
  if (connection === 'close') {
59
84
  const code = lastDisconnect?.error?.output?.statusCode
60
- if (code !== DisconnectReason.loggedOut) {
61
- boot()
62
- }
85
+ if (code !== DisconnectReason.loggedOut) start()
86
+ }
87
+
88
+ if (connection === 'open') {
89
+ console.log('Connected')
63
90
  }
64
91
  })
65
92
  }
66
93
 
67
- boot().catch(console.error)
94
+ start().catch(console.error)
68
95
  ```
69
96
 
97
+ ---
98
+
99
+ ## Feature Overview
100
+
101
+ - Socket, event, auth, and message APIs from the current local CJS distribution
102
+ - LID/JID handling in send and receive flows
103
+ - Group, community, newsletter, media, and store utilities
104
+ - Optional peers for QR rendering, preview extraction, and image/audio processing
105
+ - Runtime update-check support kept from the current Neelegirl package line
106
+
107
+ ---
108
+
70
109
  ## Compatibility Notes
71
110
 
72
- - This package intentionally stays CJS-oriented for compatibility with existing Neelegirl stacks.
73
- - Official upstream Baileys is ESM-first; direct drop-in replacement may break CJS consumers.
74
- - If you need strict upstream parity at source level, migrate consumers to ESM first.
111
+ - Runtime target: Node.js `>=20`
112
+ - Module shape: CJS-first (`main: lib/index.js`)
113
+ - Upstream policy: selective backporting from WhiskeySockets/Baileys for compatibility
114
+
115
+ If you need strict ESM parity with upstream source layout, migrate consumers to ESM first.
116
+
117
+ ---
118
+
119
+ ## Word2Web Notes
120
+
121
+ No dedicated Word2Web module is shipped in this package. Document or enable Word2Web behavior only in host projects where it is actually implemented.
122
+
123
+ ---
124
+
125
+ ## Changelog
126
+
127
+ ### 2.1.4
75
128
 
76
- ## Word2Web
129
+ - README restyled to match the main project presentation style
130
+ - Package metadata refined for publish consistency
131
+ - Dependency alignment with `@neelegirl/libsignal@^1.0.8`
132
+ - Existing QR and `NEELE` message-ID custom logic preserved
77
133
 
78
- No dedicated Word2Web module is shipped in this package. Do not assume Word2Web-specific behavior unless implemented in your host application.
134
+ ---
79
135
 
80
136
  ## Legal
81
137
 
82
- This project is not affiliated with WhatsApp.
83
- Use responsibly and comply with applicable laws and platform terms.
138
+ This project is not affiliated with WhatsApp. Use responsibly and comply with platform terms and local laws.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
- {
1
+ {
2
2
  "name": "@neelegirl/baileys",
3
- "version": "2.1.3",
4
- "description": "CJS-compatible Baileys fork for @neelegirl/wa-api, aligned with WhiskeySockets/Baileys 7.0.0-rc.9 + latest web version updates",
3
+ "version": "2.1.4",
4
+ "description": "CJS-compatible Baileys fork for Neelegirl projects, aligned with WhiskeySockets/Baileys 7.0.0-rc.9 and latest web version updates",
5
5
  "keywords": [
6
6
  "whatsapp",
7
7
  "js-whatsapp",
@@ -10,13 +10,18 @@
10
10
  "whatsapp-chat",
11
11
  "whatsapp-group",
12
12
  "automation",
13
- "multi-device"
13
+ "multi-device",
14
+ "neelegirl",
15
+ "baileys"
14
16
  ],
15
17
  "homepage": "https://github.com/neelegirl/baileys",
16
18
  "repository": {
17
19
  "type": "git",
18
20
  "url": "git+https://github.com/neelegirl/baileys.git"
19
21
  },
22
+ "bugs": {
23
+ "url": "https://github.com/neelegirl/baileys/issues"
24
+ },
20
25
  "license": "MIT",
21
26
  "author": "Neele",
22
27
  "main": "lib/index.js",
@@ -30,26 +35,27 @@
30
35
  "build:all": "tsc && typedoc",
31
36
  "build:docs": "typedoc",
32
37
  "build:tsc": "tsc",
33
- "preinstall": "node ./engine-requirements.js"
38
+ "preinstall": "node ./engine-requirements.js",
39
+ "test": "node -e \"console.log('No tests configured')\""
34
40
  },
35
41
  "dependencies": {
36
42
  "@adiwajshing/keyed-db": "^0.2.4",
37
43
  "@cacheable/node-cache": "^1.5.4",
38
44
  "@hapi/boom": "^9.1.3",
39
- "@neelegirl/libsignal": "^1.0.2",
45
+ "@neelegirl/libsignal": "^1.0.8",
40
46
  "async-mutex": "^0.5.0",
41
47
  "audio-decode": "^2.1.3",
42
48
  "axios": "^1.3.3",
43
49
  "cache-manager": "4.0.1",
44
50
  "futoin-hkdf": "^1.5.1",
45
51
  "libphonenumber-js": "^1.10.20",
52
+ "lru-cache": "^11.1.0",
46
53
  "music-metadata": "^7.12.3",
47
54
  "node-cache": "^5.1.2",
48
55
  "pino": "^7.0.0",
49
56
  "protobufjs": "^7.2.4",
50
57
  "uuid": "^9.0.0",
51
- "ws": "^8.13.0",
52
- "lru-cache": "^11.1.0"
58
+ "ws": "^8.13.0"
53
59
  },
54
60
  "devDependencies": {
55
61
  "@adiwajshing/eslint-config": "github:adiwajshing/eslint-config",
@@ -74,13 +80,16 @@
74
80
  "typescript": "^4.6.4"
75
81
  },
76
82
  "peerDependencies": {
83
+ "audio-decode": "^2.1.3",
77
84
  "jimp": "^0.22.12",
78
85
  "link-preview-js": "^3.0.0",
79
86
  "qrcode-terminal": "^0.12.0",
80
- "sharp": "^0.32.6",
81
- "audio-decode": "^2.1.3"
87
+ "sharp": "^0.32.6"
82
88
  },
83
89
  "peerDependenciesMeta": {
90
+ "audio-decode": {
91
+ "optional": true
92
+ },
84
93
  "jimp": {
85
94
  "optional": true
86
95
  },
@@ -92,13 +101,10 @@
92
101
  },
93
102
  "sharp": {
94
103
  "optional": true
95
- },
96
- "audio-decode": {
97
- "optional": true
98
104
  }
99
105
  },
100
106
  "packageManager": "yarn@1.22.19",
101
107
  "engines": {
102
108
  "node": ">=20.0.0"
103
109
  }
104
- }
110
+ }