@neelegirly/baileys 2.2.22 → 2.2.24

package/README.md

@@ -1,3 +1,57 @@
+<pre align="center">
+💖 Neelegirly Ecosystem Clean Stability Update 💖
+4 Packages · 1 App · PM2 only runs the app
+</pre>
+
+# 🌸 @neelegirly/baileys
+
+WhatsApp Web API core connection layer.
+
+## Clean Architecture
+
+```text
+@neelegirly/libsignal
+        ↓
+@neelegirly/baileys
+        ↓
+@neelegirly/wa-api
+        ↓
+App (PM2 managed)
+        ↓
+@neelegirly/downloader (optional utility)
+```
+
+## Official Package Role
+
+- Depends on @neelegirly/libsignal
+- Core connection layer
+- Used by @neelegirly/wa-api
+
+## PM2 Rule
+
+> WA-API handles sessions internally. PM2 only runs the app.
+
+Start your app with PM2 like this:
+
+```bash
+pm2 start index.js --name bot
+```
+
+Do not start one PM2 process per session. Sessions belong inside the app through `@neelegirly/wa-api`.
+
+## Install
+
+```bash
+npm install @neelegirly/baileys
+```
+
+## Clean Stability Release
+
+This release clarifies the ecosystem structure and removes workspace/core confusion from the documentation.
+
+
+---
+
 <div align="center">
 
 # 🌸 @neelegirly/baileys 🌸

package/lib/Socket/chats.js

@@ -544,7 +544,7 @@ const makeChatsSocket = (config) => {
                     const { patches, hasMorePatches, snapshot } = decoded[name]
                     try {
                         if (snapshot) {
-                            const { state: newState, mutationMap } = await Utils_1.decodeSyncdSnapshot(name, snapshot, getAppStateSyncKey, initialVersionMap[name], appStateMacVerification.snapshot)
+                            const { state: newState, mutationMap } = await Utils_1.decodeSyncdSnapshot(name, snapshot, getAppStateSyncKey, initialVersionMap[name], appStateMacVerification.snapshot, logger)
                             states[name] = newState
                             Object.assign(globalMutationMap, mutationMap)
                             logger.info(`restored state of ${name} from snapshot to v${newState.version} with mutations`)

package/lib/Socket/messages-recv.js

@@ -896,9 +896,19 @@ const makeMessagesRecvSocket = (config) => {
           node.attrs.participant_username
         );
         break;
-      case "newsletter":
-        handleNewsletterNotification(node.attrs.from, child);
+      case "newsletter": {
+        const newsletterChildren = WABinary_1.getAllBinaryNodeChildren(node);
+        const nodesToHandle = newsletterChildren.length
+          ? newsletterChildren
+          : child
+          ? [child]
+          : [];
+
+        for (const newsletterChild of nodesToHandle) {
+          handleNewsletterNotification(node.attrs.from, newsletterChild);
+        }
         break;
+      }
       case "mex":
         await handleMexNotification(node.attrs.from, child);
         break;

package/lib/Utils/chat-utils.d.ts

@@ -85,7 +85,7 @@ export declare const extractSyncdPatches: (result: BinaryNode, options: AxiosReq
 
 export declare const downloadExternalBlob: (blob: proto.IExternalBlobReference, options: AxiosRequestConfig<{}>) => Promise<Buffer>
 export declare const downloadExternalPatch: (blob: proto.IExternalBlobReference, options: AxiosRequestConfig<{}>) => Promise<proto.SyncdMutations>
-export declare const decodeSyncdSnapshot: (name: WAPatchName, snapshot: proto.ISyncdSnapshot, getAppStateSyncKey: FetchAppStateSyncKey, minimumVersionNumber: number | undefined, validateMacs?: boolean) => Promise<{
+export declare const decodeSyncdSnapshot: (name: WAPatchName, snapshot: proto.ISyncdSnapshot, getAppStateSyncKey: FetchAppStateSyncKey, minimumVersionNumber: number | undefined, validateMacs?: boolean, logger?: ILogger) => Promise<{
     state: LTHashState
     mutationMap: ChatMutationMap
 }>

package/lib/Utils/chat-utils.js

@@ -179,18 +179,33 @@ const decodeSyncdMutations = async (msgMutations, initialState, getAppStateSyncK
         // otherwise, if it's only a record -- it'll be a SET mutation
         const operation = 'operation' in msgMutation ? msgMutation.operation : WAProto_1.proto.SyncdMutation.SyncdOperation.SET
         const record = ('record' in msgMutation && !!msgMutation.record) ? msgMutation.record : msgMutation
-        const key = await getKey(record.keyId.id)
+        let key
+        try {
+            key = await getKey(record.keyId.id)
+        }
+        catch (error) {
+            if (isMissingKeyError(error)) {
+                throw error
+            }
+            continue
+        }
         const content = Buffer.from(record.value.blob)
         const encContent = content.slice(0, -32)
         const ogValueMac = content.slice(-32)
         if (validateMacs) {
             const contentHmac = generateMac(operation, encContent, record.keyId.id, key.valueMacKey)
             if (Buffer.compare(contentHmac, ogValueMac) !== 0) {
-                throw new boom_1.Boom('HMAC content verification failed')
+                continue
             }
         }
-        const result = crypto_1.aesDecrypt(encContent, key.valueEncryptionKey)
-        const syncAction = WAProto_1.proto.SyncActionData.decode(result)
+        let syncAction
+        try {
+            const result = crypto_1.aesDecrypt(encContent, key.valueEncryptionKey)
+            syncAction = WAProto_1.proto.SyncActionData.decode(result)
+        }
+        catch (error) {
+            continue
+        }
         if (validateMacs) {
             const hmac = crypto_1.hmacSign(syncAction.index, key.indexKey)
             if (Buffer.compare(hmac, record.index.blob) !== 0) {
@@ -286,7 +301,7 @@ const downloadExternalPatch = async (blob, options) => {
     return syncData
 }
 
-const decodeSyncdSnapshot = async (name, snapshot, getAppStateSyncKey, minimumVersionNumber, validateMacs = true) => {
+const decodeSyncdSnapshot = async (name, snapshot, getAppStateSyncKey, minimumVersionNumber, validateMacs = true, logger) => {
     const newState = newLTHashState()
     newState.version = generics_1.toNumber(snapshot.version.version)
     const mutationMap = {}
@@ -309,7 +324,7 @@ const decodeSyncdSnapshot = async (name, snapshot, getAppStateSyncKey, minimumVe
         const result = await mutationKeys(keyEnc.keyData)
         const computedSnapshotMac = generateSnapshotMac(newState.hash, newState.version, name, result.snapshotMacKey)
         if (Buffer.compare(snapshot.mac, computedSnapshotMac) !== 0) {
-            throw new boom_1.Boom(`failed to verify LTHash at ${newState.version} of ${name} from snapshot`)
+            logger?.warn({ name, version: newState.version }, 'LTHash verification failed on snapshot, continuing with partial state')
         }
     }
     return {
@@ -335,13 +350,24 @@ const decodePatches = async (name, syncds, initial, getAppStateSyncKey, options,
         const patchVersion = generics_1.toNumber(version.version)
         newState.version = patchVersion
         const shouldMutate = typeof minimumVersionNumber === 'undefined' || patchVersion > minimumVersionNumber
-        const decodeResult = await decodeSyncdPatch(syncd, name, newState, getAppStateSyncKey, shouldMutate
-            ? mutation => {
-                var _a
-                const index = mutation.syncAction.index?.toString()
-                mutationMap[index] = mutation
+        let decodeResult
+        try {
+            decodeResult = await decodeSyncdPatch(syncd, name, newState, getAppStateSyncKey, shouldMutate
+                ? mutation => {
+                    var _a
+                    const index = mutation.syncAction.index?.toString()
+                    mutationMap[index] = mutation
+                }
+                : (() => { }), validateMacs)
+        }
+        catch (error) {
+            if (isMissingKeyError(error)) {
+                throw error
             }
-            : (() => { }), true)
+            logger?.warn({ name, version: patchVersion, error: error?.stack || error }, 'failed to decode patch, skipping')
+            syncd.mutations = []
+            continue
+        }
         newState.hash = decodeResult.hash
         newState.indexValueMap = decodeResult.indexValueMap
         if (validateMacs) {
@@ -353,7 +379,8 @@ const decodePatches = async (name, syncds, initial, getAppStateSyncKey, options,
             const result = await mutationKeys(keyEnc.keyData)
             const computedSnapshotMac = generateSnapshotMac(newState.hash, newState.version, name, result.snapshotMacKey)
             if (Buffer.compare(snapshotMac, computedSnapshotMac) !== 0) {
-                throw new boom_1.Boom(`failed to verify LTHash at ${newState.version} of ${name}`)
+                logger?.warn({ name, version: newState.version }, 'LTHash verification failed, skipping remaining patches')
+                break
             }
         }
         // clear memory used up by the mutations

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neelegirly/baileys",
-  "version": "2.2.22",
+  "version": "2.2.24",
   "description": "Neelegirly fork of Baileys: multi-device WhatsApp Web API for Node.js",
   "keywords": [
     "whatsapp",
@@ -44,7 +44,7 @@
     "@adiwajshing/keyed-db": "^0.2.4",
     "@cacheable/node-cache": "^1.5.4",
     "@hapi/boom": "^9.1.3",
-    "@neelegirly/libsignal": "1.0.31",
+    "@neelegirly/libsignal": "1.0.32",
     "async-mutex": "^0.5.0",
     "audio-decode": "^2.1.3",
     "axios": "^1.3.3",
@@ -59,7 +59,7 @@
     "ws": "^8.13.0"
   },
   "overrides": {
-    "@neelegirly/libsignal": "1.0.31"
+    "@neelegirly/libsignal": "1.0.32"
   },
   "devDependencies": {
     "@adiwajshing/eslint-config": "github:adiwajshing/eslint-config",