@arcaelas/whatsapp 7.4.0 → 7.4.2

package/build/cjs/index.d.ts

@@ -7,6 +7,7 @@ import WhatsApp from './lib/whatsapp';
 export { WhatsApp };
 export default WhatsApp;
 export type IWhatsApp = ConstructorParameters<typeof WhatsApp>[0];
+export type { Farewell } from './lib/whatsapp';
 export type DisconnectOptions = NonNullable<Parameters<WhatsApp['disconnect']>[0]>;
 export type ReconnectOption = NonNullable<IWhatsApp['reconnect']>;
 export { FileSystemEngine, RedisEngine, S3Engine, SQLiteEngine, serialize, deserialize } from './lib/store';

package/build/cjs/lib/chat/index.js

@@ -215,7 +215,22 @@ function chat(init) {
          */
         async seen() {
             const last = await tail(this._raw.id);
-            await init.socket.chatModify({ markRead: true, lastMessages: last.messages }, this._raw.id);
+            // Marcar leído se acusa con recibos, no con una mutación del estado de la app.
+            // `chatModify({ markRead })` emite un app patch, y cuando el estado local va por
+            // detrás del servidor —lo normal en un dispositivo recién vinculado, que arranca en
+            // v0— WhatsApp responde al patch expulsando el dispositivo: `conflict
+            // (device_removed)`. Abrir un chat basta para provocarlo, así que la línea se caía
+            // sola al primer chat que se mirara. Los recibos no tocan el estado de la app.
+            // Marking read is acknowledged with receipts, not with an app-state mutation.
+            // `chatModify({ markRead })` emits an app patch, and when the local state trails the
+            // server —the norm on a freshly linked device, which starts at v0— WhatsApp answers
+            // that patch by dropping the device: `conflict (device_removed)`. Opening a chat was
+            // enough to trigger it, so the line died on the first chat anyone looked at.
+            // Receipts leave the app state alone.
+            const keys = last.messages.map(({ key }) => ({ remoteJid: key.remoteJid, id: key.id, participant: undefined }));
+            if (keys.length) {
+                await init.socket.readMessages(keys);
+            }
             this._raw.unread_count = 0;
             await init.engine.set(`/chat/${this._raw.id}`, (0, store_1.serialize)(this._raw), this._raw.activity ?? last.at);
             return true;

package/build/cjs/lib/whatsapp/index.d.ts

@@ -32,10 +32,37 @@ interface Options {
      * more than one should name them.
      */
     device?: string;
+    /**
+     * Nivel del log interno de baileys; `silent` por defecto. En silencio un cierre remoto no
+     * deja rastro de por qué ocurrió: `Farewell` da el código, pero el intercambio que llevó
+     * hasta él —el nodo que WhatsApp rechazó— sólo aparece subiendo esto a `debug` o `trace`.
+     * Level of baileys' internal log; `silent` by default. Kept silent, a remote close leaves no
+     * trace of why it happened: `Farewell` gives the code, but the exchange leading to it —the
+     * node WhatsApp rejected— only shows up by raising this to `debug` or `trace`.
+     */
+    debug?: 'silent' | 'fatal' | 'error' | 'warn' | 'info' | 'debug' | 'trace';
+}
+/**
+ * Por qué se cerró la sesión. Sin esto un cierre remoto es indistinguible de otro: el evento
+ * sólo decía «se cerró», el logger va en silencio y `autoclean` borra la evidencia antes de que
+ * nadie pueda mirarla, así que no queda con qué diagnosticar por qué WhatsApp echó la línea.
+ * Why the session closed. Without it one remote close is indistinguishable from another: the
+ * event only said «it closed», the logger runs silent and `autoclean` wipes the evidence before
+ * anyone can look at it, leaving nothing to diagnose why WhatsApp dropped the line.
+ */
+export interface Farewell {
+    /** Código de baileys, si vino. / Baileys status code, if any. */
+    code: number | null;
+    /** Nombre del motivo (`loggedOut`, `connectionReplaced`, `badSession`…) o `unknown`. / Reason name or `unknown`. */
+    reason: string;
+    /** El teléfono desvinculó la sesión: no se reintenta y las credenciales ya no sirven. / The phone unlinked it: no retry, credentials are dead. */
+    expired: boolean;
+    /** Mensaje del error subyacente, si lo hubo. / Underlying error message, if any. */
+    detail: string | null;
 }
 interface EventMap {
     connected: [WhatsApp];
-    disconnected: [WhatsApp];
+    disconnected: [WhatsApp, Farewell];
     'contact:created': [ContactInstance, ChatInstance, WhatsApp];
     'contact:updated': [ContactInstance, ChatInstance, WhatsApp];
     'chat:created': [ChatInstance, WhatsApp];

package/build/cjs/lib/whatsapp/index.js

@@ -53,6 +53,25 @@ const store_1 = require("../../lib/store");
  * whole. That is not a name: taking it hides the real one, which is stored on the own contact
  * card.
  */
+/**
+ * Cola por ruta para las escrituras de sesión. Baileys emite `creds.update` varias veces
+ * seguidas y lanza `keys.set` en paralelo; sin serializar, dos escrituras sobre el mismo
+ * archivo pueden resolverse en orden inverso y dejar el estado viejo encima del nuevo. Un
+ * archivo íntegro pero atrasado no se nota —el `tmp+rename` del engine lo deja bien formado—,
+ * y es peor que uno corrupto: WhatsApp lo rechaza en el handshake y cierra la sesión.
+ * Su propia referencia (`useMultiFileAuthState`) toma un mutex por archivo por esto mismo.
+ * Per-path queue for session writes. Baileys emits `creds.update` several times in a row and
+ * fires `keys.set` in parallel; without serializing, two writes to the same file can settle in
+ * reverse order and leave the old state on top of the new one. A whole but stale file goes
+ * unnoticed —the engine's `tmp+rename` leaves it well formed— and is worse than a corrupt one:
+ * WhatsApp rejects it at the handshake and closes the session. Their own reference
+ * (`useMultiFileAuthState`) takes a mutex per file for this very reason.
+ */
+const queued = (locks, path, work) => {
+    const next = (locks.get(path) ?? Promise.resolve()).then(work, work);
+    locks.set(path, next.catch(() => { }));
+    return next;
+};
 const readable = (value) => (value && !/^\+?[\d\s·•∙⋅]+$/.test(value) ? value : null);
 class WhatsApp {
     #event = new node_events_1.EventEmitter();
@@ -86,7 +105,7 @@ class WhatsApp {
     }
     async connect(callback) {
         const { engine } = this;
-        const { phone, method, autoclean = true, sync = true, reconnect = true, device } = this.#options;
+        const { phone, method, autoclean = true, sync = true, reconnect = true, device, debug } = this.#options;
         const digits = phone !== undefined ? String(phone).replace(/\D+/g, '') : '';
         const budget = reconnect === false ? 0 : reconnect === true ? null : typeof reconnect === 'number' ? reconnect : reconnect.max ?? null;
         const wait = typeof reconnect === 'object' ? (reconnect.interval ?? 60) * 1_000 : 60_000;
@@ -99,6 +118,7 @@ class WhatsApp {
         let alive = null;
         let timer = null;
         let chain = Promise.resolve();
+        const locks = new Map();
         return new Promise((resolve, reject) => {
             const start = async () => {
                 const creds = (0, store_1.deserialize)(await engine.get('/session/creds')) ?? (0, baileys_1.initAuthCreds)();
@@ -120,14 +140,15 @@ class WhatsApp {
                                 return data;
                             },
                             set: async (data) => {
-                                await Promise.all(Object.entries(data).flatMap(([category, entries]) => Object.entries(entries).map(([id, value]) => value != null
-                                    ? engine.set(`/session/${category}/${id}`, (0, store_1.serialize)(value))
-                                    : engine.unset(`/session/${category}/${id}`))));
+                                await Promise.all(Object.entries(data).flatMap(([category, entries]) => Object.entries(entries).map(([id, value]) => {
+                                    const path = `/session/${category}/${id}`;
+                                    return queued(locks, path, () => (value != null ? engine.set(path, (0, store_1.serialize)(value)) : engine.unset(path)));
+                                })));
                             },
                         },
                     },
                     browser: baileys_1.Browsers.windows(device ?? 'Chrome'),
-                    logger: (0, pino_1.default)({ level: 'silent' }),
+                    logger: (0, pino_1.default)({ level: debug ?? 'silent' }),
                     syncFullHistory: sync,
                     shouldSyncHistoryMessage: ({ syncType }) => sync || syncType !== baileys_1.proto.HistorySync.HistorySyncType.FULL,
                     // Cuando el receptor no puede descifrar pide un retry; el cache interno de
@@ -272,7 +293,7 @@ class WhatsApp {
                         }
                     }
                 };
-                socket.ev.on('creds.update', () => engine.set('/session/creds', (0, store_1.serialize)(creds)));
+                socket.ev.on('creds.update', () => queued(locks, '/session/creds', () => engine.set('/session/creds', (0, store_1.serialize)(creds))));
                 socket.ev.on('connection.update', async ({ connection, lastDisconnect, qr }) => {
                     if (qr && !creds.registered) {
                         await callback(digits && (method ?? 'otp') === 'otp'
@@ -295,11 +316,25 @@ class WhatsApp {
                     else if (connection === 'close') {
                         const code = lastDisconnect?.error?.output?.statusCode;
                         const transient = code === baileys_1.DisconnectReason.restartRequired;
+                        const farewell = {
+                            code: code ?? null,
+                            reason: Object.entries(baileys_1.DisconnectReason).find(([, value]) => value === code)?.[0] ?? 'unknown',
+                            expired: code === baileys_1.DisconnectReason.loggedOut,
+                            detail: lastDisconnect?.error instanceof Error ? lastDisconnect.error.message : null,
+                        };
                         if (code === baileys_1.DisconnectReason.loggedOut) {
+                            // Las escrituras en vuelo tienen que aterrizar antes de borrar, o una
+                            // de ellas resucita las credenciales justo después del clear y la
+                            // siguiente conexión arranca con restos de una sesión ya muerta.
+                            // In-flight writes must land before wiping, or one of them resurrects
+                            // the credentials right after the clear and the next connection starts
+                            // on the leftovers of an already dead session.
+                            await Promise.allSettled([...locks.values()]);
+                            locks.clear();
                             await (autoclean ? engine.clear() : engine.unset('/session/creds'));
                         }
                         if (connected && !transient && !silent) {
-                            this.emit('disconnected', this);
+                            this.emit('disconnected', this, farewell);
                         }
                         if (intentional) {
                             /* cierre pedido por disconnect(): sin reintentos / close requested by disconnect(): no retries */

package/build/esm/index.d.ts

@@ -7,6 +7,7 @@ import WhatsApp from './lib/whatsapp/index.js';
 export { WhatsApp };
 export default WhatsApp;
 export type IWhatsApp = ConstructorParameters<typeof WhatsApp>[0];
+export type { Farewell } from './lib/whatsapp/index.js';
 export type DisconnectOptions = NonNullable<Parameters<WhatsApp['disconnect']>[0]>;
 export type ReconnectOption = NonNullable<IWhatsApp['reconnect']>;
 export { FileSystemEngine, RedisEngine, S3Engine, SQLiteEngine, serialize, deserialize } from './lib/store/index.js';

package/build/esm/lib/chat/index.js

@@ -211,7 +211,22 @@ export function chat(init) {
          */
         async seen() {
             const last = await tail(this._raw.id);
-            await init.socket.chatModify({ markRead: true, lastMessages: last.messages }, this._raw.id);
+            // Marcar leído se acusa con recibos, no con una mutación del estado de la app.
+            // `chatModify({ markRead })` emite un app patch, y cuando el estado local va por
+            // detrás del servidor —lo normal en un dispositivo recién vinculado, que arranca en
+            // v0— WhatsApp responde al patch expulsando el dispositivo: `conflict
+            // (device_removed)`. Abrir un chat basta para provocarlo, así que la línea se caía
+            // sola al primer chat que se mirara. Los recibos no tocan el estado de la app.
+            // Marking read is acknowledged with receipts, not with an app-state mutation.
+            // `chatModify({ markRead })` emits an app patch, and when the local state trails the
+            // server —the norm on a freshly linked device, which starts at v0— WhatsApp answers
+            // that patch by dropping the device: `conflict (device_removed)`. Opening a chat was
+            // enough to trigger it, so the line died on the first chat anyone looked at.
+            // Receipts leave the app state alone.
+            const keys = last.messages.map(({ key }) => ({ remoteJid: key.remoteJid, id: key.id, participant: undefined }));
+            if (keys.length) {
+                await init.socket.readMessages(keys);
+            }
             this._raw.unread_count = 0;
             await init.engine.set(`/chat/${this._raw.id}`, serialize(this._raw), this._raw.activity ?? last.at);
             return true;

package/build/esm/lib/whatsapp/index.d.ts

@@ -32,10 +32,37 @@ interface Options {
      * more than one should name them.
      */
     device?: string;
+    /**
+     * Nivel del log interno de baileys; `silent` por defecto. En silencio un cierre remoto no
+     * deja rastro de por qué ocurrió: `Farewell` da el código, pero el intercambio que llevó
+     * hasta él —el nodo que WhatsApp rechazó— sólo aparece subiendo esto a `debug` o `trace`.
+     * Level of baileys' internal log; `silent` by default. Kept silent, a remote close leaves no
+     * trace of why it happened: `Farewell` gives the code, but the exchange leading to it —the
+     * node WhatsApp rejected— only shows up by raising this to `debug` or `trace`.
+     */
+    debug?: 'silent' | 'fatal' | 'error' | 'warn' | 'info' | 'debug' | 'trace';
+}
+/**
+ * Por qué se cerró la sesión. Sin esto un cierre remoto es indistinguible de otro: el evento
+ * sólo decía «se cerró», el logger va en silencio y `autoclean` borra la evidencia antes de que
+ * nadie pueda mirarla, así que no queda con qué diagnosticar por qué WhatsApp echó la línea.
+ * Why the session closed. Without it one remote close is indistinguishable from another: the
+ * event only said «it closed», the logger runs silent and `autoclean` wipes the evidence before
+ * anyone can look at it, leaving nothing to diagnose why WhatsApp dropped the line.
+ */
+export interface Farewell {
+    /** Código de baileys, si vino. / Baileys status code, if any. */
+    code: number | null;
+    /** Nombre del motivo (`loggedOut`, `connectionReplaced`, `badSession`…) o `unknown`. / Reason name or `unknown`. */
+    reason: string;
+    /** El teléfono desvinculó la sesión: no se reintenta y las credenciales ya no sirven. / The phone unlinked it: no retry, credentials are dead. */
+    expired: boolean;
+    /** Mensaje del error subyacente, si lo hubo. / Underlying error message, if any. */
+    detail: string | null;
 }
 interface EventMap {
     connected: [WhatsApp];
-    disconnected: [WhatsApp];
+    disconnected: [WhatsApp, Farewell];
     'contact:created': [ContactInstance, ChatInstance, WhatsApp];
     'contact:updated': [ContactInstance, ChatInstance, WhatsApp];
     'chat:created': [ChatInstance, WhatsApp];

package/build/esm/lib/whatsapp/index.js

@@ -15,6 +15,25 @@ import { deserialize, jid_of, serialize } from '../../lib/store/index.js';
  * whole. That is not a name: taking it hides the real one, which is stored on the own contact
  * card.
  */
+/**
+ * Cola por ruta para las escrituras de sesión. Baileys emite `creds.update` varias veces
+ * seguidas y lanza `keys.set` en paralelo; sin serializar, dos escrituras sobre el mismo
+ * archivo pueden resolverse en orden inverso y dejar el estado viejo encima del nuevo. Un
+ * archivo íntegro pero atrasado no se nota —el `tmp+rename` del engine lo deja bien formado—,
+ * y es peor que uno corrupto: WhatsApp lo rechaza en el handshake y cierra la sesión.
+ * Su propia referencia (`useMultiFileAuthState`) toma un mutex por archivo por esto mismo.
+ * Per-path queue for session writes. Baileys emits `creds.update` several times in a row and
+ * fires `keys.set` in parallel; without serializing, two writes to the same file can settle in
+ * reverse order and leave the old state on top of the new one. A whole but stale file goes
+ * unnoticed —the engine's `tmp+rename` leaves it well formed— and is worse than a corrupt one:
+ * WhatsApp rejects it at the handshake and closes the session. Their own reference
+ * (`useMultiFileAuthState`) takes a mutex per file for this very reason.
+ */
+const queued = (locks, path, work) => {
+    const next = (locks.get(path) ?? Promise.resolve()).then(work, work);
+    locks.set(path, next.catch(() => { }));
+    return next;
+};
 const readable = (value) => (value && !/^\+?[\d\s·•∙⋅]+$/.test(value) ? value : null);
 export default class WhatsApp {
     #event = new EventEmitter();
@@ -48,7 +67,7 @@ export default class WhatsApp {
     }
     async connect(callback) {
         const { engine } = this;
-        const { phone, method, autoclean = true, sync = true, reconnect = true, device } = this.#options;
+        const { phone, method, autoclean = true, sync = true, reconnect = true, device, debug } = this.#options;
         const digits = phone !== undefined ? String(phone).replace(/\D+/g, '') : '';
         const budget = reconnect === false ? 0 : reconnect === true ? null : typeof reconnect === 'number' ? reconnect : reconnect.max ?? null;
         const wait = typeof reconnect === 'object' ? (reconnect.interval ?? 60) * 1_000 : 60_000;
@@ -61,6 +80,7 @@ export default class WhatsApp {
         let alive = null;
         let timer = null;
         let chain = Promise.resolve();
+        const locks = new Map();
         return new Promise((resolve, reject) => {
             const start = async () => {
                 const creds = deserialize(await engine.get('/session/creds')) ?? initAuthCreds();
@@ -82,14 +102,15 @@ export default class WhatsApp {
                                 return data;
                             },
                             set: async (data) => {
-                                await Promise.all(Object.entries(data).flatMap(([category, entries]) => Object.entries(entries).map(([id, value]) => value != null
-                                    ? engine.set(`/session/${category}/${id}`, serialize(value))
-                                    : engine.unset(`/session/${category}/${id}`))));
+                                await Promise.all(Object.entries(data).flatMap(([category, entries]) => Object.entries(entries).map(([id, value]) => {
+                                    const path = `/session/${category}/${id}`;
+                                    return queued(locks, path, () => (value != null ? engine.set(path, serialize(value)) : engine.unset(path)));
+                                })));
                             },
                         },
                     },
                     browser: Browsers.windows(device ?? 'Chrome'),
-                    logger: pino({ level: 'silent' }),
+                    logger: pino({ level: debug ?? 'silent' }),
                     syncFullHistory: sync,
                     shouldSyncHistoryMessage: ({ syncType }) => sync || syncType !== proto.HistorySync.HistorySyncType.FULL,
                     // Cuando el receptor no puede descifrar pide un retry; el cache interno de
@@ -234,7 +255,7 @@ export default class WhatsApp {
                         }
                     }
                 };
-                socket.ev.on('creds.update', () => engine.set('/session/creds', serialize(creds)));
+                socket.ev.on('creds.update', () => queued(locks, '/session/creds', () => engine.set('/session/creds', serialize(creds))));
                 socket.ev.on('connection.update', async ({ connection, lastDisconnect, qr }) => {
                     if (qr && !creds.registered) {
                         await callback(digits && (method ?? 'otp') === 'otp'
@@ -257,11 +278,25 @@ export default class WhatsApp {
                     else if (connection === 'close') {
                         const code = lastDisconnect?.error?.output?.statusCode;
                         const transient = code === DisconnectReason.restartRequired;
+                        const farewell = {
+                            code: code ?? null,
+                            reason: Object.entries(DisconnectReason).find(([, value]) => value === code)?.[0] ?? 'unknown',
+                            expired: code === DisconnectReason.loggedOut,
+                            detail: lastDisconnect?.error instanceof Error ? lastDisconnect.error.message : null,
+                        };
                         if (code === DisconnectReason.loggedOut) {
+                            // Las escrituras en vuelo tienen que aterrizar antes de borrar, o una
+                            // de ellas resucita las credenciales justo después del clear y la
+                            // siguiente conexión arranca con restos de una sesión ya muerta.
+                            // In-flight writes must land before wiping, or one of them resurrects
+                            // the credentials right after the clear and the next connection starts
+                            // on the leftovers of an already dead session.
+                            await Promise.allSettled([...locks.values()]);
+                            locks.clear();
                             await (autoclean ? engine.clear() : engine.unset('/session/creds'));
                         }
                         if (connected && !transient && !silent) {
-                            this.emit('disconnected', this);
+                            this.emit('disconnected', this, farewell);
                         }
                         if (intentional) {
                             /* cierre pedido por disconnect(): sin reintentos / close requested by disconnect(): no retries */

package/package.json

@@ -72,7 +72,7 @@
     "release": "npm publish --access public"
   },
   "types": "./build/esm/index.d.ts",
-  "version": "7.4.0",
+  "version": "7.4.2",
   "engines": {
     "node": ">=20"
   },