whalibmob 5.9.0 → 5.9.1

package/README.md

@@ -1112,6 +1112,7 @@ connect()
 | `app_state_sync` | `{ collections, applied }` | An app-state sync finished; see [Reading Changes Made Elsewhere](#app-state-sync) |
 | `app_state_mutation` | `{ collection, index, action, removed }` | An app-state change this library does not model |
 | `app_state_key_missing` | `{ collection, keyId }` | App state cannot be read until your phone shares this key |
+| `app_state_keys` | `{ keys }` | Your phone shared app-state sync keys; a sync starts automatically |
 
 `remote: true` on a chat event means the change was made on your phone or another
 linked device rather than by this session. Your own calls carry `synced` instead,

package/cli.js

@@ -600,6 +600,13 @@ function attachEvents(client) {
     _rl && (_rl.resume(), _rl.prompt(true));
   });
 
+  client.on('app_state_keys', (e) => {
+    _rl && _rl.pause();
+    out('  app state: received ' + e.keys.length + ' sync key(s) from your phone —' +
+        ' pins, archives, mutes and stars will sync from now on');
+    _rl && (_rl.resume(), _rl.prompt(true));
+  });
+
   client.on('decrypt_error', (e) => {
     _rl && _rl.pause();
     out('  DECRYPT_ERROR  from ' + e.from + '  id ' + e.id + '  : ' + (e.err && e.err.message));

package/lib/Client.js

@@ -1984,13 +1984,13 @@ class WhalibmobClient extends EventEmitter {
         if (decoded.type === 'protocol') {
           _whaDbg('[DBG] PROTO subtype=' + decoded.subtype + ' id=' + id);
 
-          // ── HISTORY_SYNC_NOTIFICATION ─────────────────────────────────────
-          if (decoded.subtype === 'history_sync' && decoded.historySyncNotification) {
+          // Keyed off what the message actually carried rather than off the
+          // type that announced it. A payload that is present is the payload,
+          // whatever the type number turns out to mean.
+          if (decoded.historySyncNotification) {
             this._handleHistorySync(decoded.historySyncNotification, id);
           }
-
-          // ── APP_STATE_SYNC_KEY_SHARE ──────────────────────────────────────
-          if (decoded.subtype === 'app_state_sync_key_share' && decoded.appStateSyncKeyShare) {
+          if (decoded.appStateSyncKeyShare) {
             this._handleAppStateSyncKeyShare(decoded.appStateSyncKeyShare);
           }
 
@@ -2025,10 +2025,10 @@ class WhalibmobClient extends EventEmitter {
         const decoded = this._decodeMsg(plaintext);
         if (decoded.type === 'senderKeyDistribution') return;
         if (decoded.type === 'protocol') {
-          if (decoded.subtype === 'history_sync' && decoded.historySyncNotification) {
+          if (decoded.historySyncNotification) {
             this._handleHistorySync(decoded.historySyncNotification, id);
           }
-          if (decoded.subtype === 'app_state_sync_key_share' && decoded.appStateSyncKeyShare) {
+          if (decoded.appStateSyncKeyShare) {
             this._handleAppStateSyncKeyShare(decoded.appStateSyncKeyShare);
           }
           return;
@@ -3700,6 +3700,15 @@ class WhalibmobClient extends EventEmitter {
     }
 
     this.emit('app_state_keys', { keys: keyShare.keys });
+
+    // The key is what app state was waiting on. Anything the server has been
+    // holding for us can be read now, so go and get it rather than sitting on
+    // it until the next dirty bit happens along.
+    if (this._connected && this._appState) {
+      this.syncAppState().catch(err => {
+        _whaDbg('[DBG] APP_STATE sync after key share failed: ' + (err && err.message));
+      });
+    }
   }
 
   /**

package/lib/proto/MessageProto.js

@@ -672,28 +672,38 @@ function decodeMessageContainer(buf) {
       try {
         const pm = _decodeFields(f[12]);
         const pmType = pm[2];
+        // ProtocolMessage.Type. These are not the field numbers the payloads
+        // live in and the two must not be confused: HISTORY_SYNC_NOTIFICATION
+        // is type 5 carried in field 6, APP_STATE_SYNC_KEY_SHARE is type 6
+        // carried in field 7. Having those two the wrong way round meant a key
+        // share was read as a history notification, looked in the field it does
+        // not use, found nothing, and was dropped — so app state could never be
+        // decrypted at all.
         const typeNames = {
           0:  'revoke',
           3:  'ephemeral',
-          5:  'app_state_sync_key_share',
-          6:  'history_sync',
-          10: 'app_state_sync'
+          4:  'ephemeral_sync_response',
+          5:  'history_sync',
+          6:  'app_state_sync_key_share',
+          7:  'app_state_sync_key_request',
+          9:  'initial_security_notification_setting_sync',
+          10: 'app_state_fatal_exception',
+          11: 'share_phone_number',
+          14: 'message_edit'
         };
         const subtype = typeNames[pmType] || String(pmType);
         msgResult = { type: 'protocol', subtype };
 
-        // ── HISTORY_SYNC_NOTIFICATION (pmType=6) ─────────────────────────────
-        // ProtocolMessage field 6 holds the HistorySyncNotification bytes.
-        if (pmType === 6 && pm[6] && Buffer.isBuffer(pm[6])) {
+        // The payloads are read by the field they occupy rather than by the
+        // type that announced them, so a type number this list does not know
+        // about still delivers what it carried.
+        if (pm[6] && Buffer.isBuffer(pm[6])) {
           try {
             const { decodeHistorySyncNotification } = require('../HistorySyncHandler');
             msgResult.historySyncNotification = decodeHistorySyncNotification(pm[6]);
           } catch (_hse) {}
         }
-
-        // ── APP_STATE_SYNC_KEY_SHARE (pmType=5) ──────────────────────────────
-        // ProtocolMessage field 7 holds the AppStateSyncKeyShare bytes.
-        if (pmType === 5 && pm[7] && Buffer.isBuffer(pm[7])) {
+        if (pm[7] && Buffer.isBuffer(pm[7])) {
           try {
             const { decodeAppStateSyncKeyShare } = require('../HistorySyncHandler');
             msgResult.appStateSyncKeyShare = decodeAppStateSyncKeyShare(pm[7]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "whalibmob",
-  "version": "5.9.0",
+  "version": "5.9.1",
   "description": "WhatsApp library for interaction with WhatsApp Mobile API no web",
   "author": "Kunboruto50",
   "main": "index.js",