@japofc/baileys 2.1.0

package/lib/Utils/use-multi-file-auth-state.js

@@ -0,0 +1,166 @@
+import { Mutex } from 'async-mutex';
+import { mkdir, readFile, readdir, stat, unlink, writeFile } from 'fs/promises';
+import { join } from 'path';
+import { proto } from '../../WAProto/index.js';
+import { initAuthCreds } from './auth-utils.js';
+import { BufferJSON } from './generics.js';
+// We need to lock files due to the fact that we are using async functions to read and write files
+// upstream issue #794
+// https://github.com/nodejs/node/issues/26338
+// Use a Map to store mutexes for each file path
+const fileLocks = new Map();
+// Get or create a mutex for a specific file path
+const getFileLock = (path) => {
+    let mutex = fileLocks.get(path);
+    if (!mutex) {
+        mutex = new Mutex();
+        fileLocks.set(path, mutex);
+    }
+    return mutex;
+};
+// JAP@Fix 25-08-26 (ENOSPC guard) --- useMultiFileAuthState writes one small file PER key id
+// (session-*, sender-key-*, sender-key-memory-*, pre-key-*, app-state-sync-key-*, ...) and never
+// prunes any of them on its own. Over months of uptime — especially in busy groups, where a
+// sender-key-memory file is created per (group, participant) pair — this silently accumulates into
+// hundreds of thousands of tiny files. That can hit the filesystem's inode/file-count ceiling and
+// start throwing ENOSPC on writes long before disk *space* usage looks anywhere near full (a
+// classic symptom: panel shows plenty of free MiB/GiB, but writes still fail with ENOSPC). When
+// that happens mid-session, auth writes (including the app-state-sync key from the "App state key
+// not present!" issue) fail silently and never actually persist.
+//
+// `sender-key-memory-*` entries are pure dedup/anti-replay cache — safe to delete anytime; Baileys
+// regenerates them on demand with zero functional loss (worst case: one redundant re-decrypt). They
+// also tend to be the single biggest contributor to file count in active groups, so they're the
+// safest and highest-impact thing to prune automatically. Everything else (creds, real sessions,
+// pre-keys, app-state-sync-keys) is left completely untouched — this never touches those.
+export const pruneStaleAuthFiles = async (folder, { maxAgeDays = 14, categories = ['sender-key-memory'], dryRun = false } = {}) => {
+    let entries;
+    try {
+        entries = await readdir(folder);
+    }
+    catch {
+        return { scanned: 0, removed: 0 };
+    }
+    const cutoff = Date.now() - maxAgeDays * 24 * 60 * 60 * 1000;
+    let scanned = 0;
+    let removed = 0;
+    await Promise.all(entries.map(async (name) => {
+        if (!categories.some((cat) => name.startsWith(`${cat}-`) && name.endsWith('.json'))) return;
+        scanned++;
+        const filePath = join(folder, name);
+        try {
+            const info = await stat(filePath);
+            if (info.mtimeMs < cutoff) {
+                if (!dryRun) await unlink(filePath).catch(() => { });
+                removed++;
+            }
+        }
+        catch {
+            // file vanished between readdir and stat — fine, nothing to prune
+        }
+    }));
+    return { scanned, removed };
+};
+/**
+ * stores the full authentication state in a single folder.
+ * Far more efficient than singlefileauthstate
+ *
+ * Again, I wouldn't endorse this for any production level use other than perhaps a bot.
+ * Would recommend writing an auth state for use with a proper SQL or No-SQL DB
+ * */
+export const useMultiFileAuthState = async (folder) => {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const writeData = async (data, file) => {
+        const filePath = join(folder, fixFileName(file));
+        const mutex = getFileLock(filePath);
+        return mutex.acquire().then(async (release) => {
+            try {
+                await writeFile(filePath, JSON.stringify(data, BufferJSON.replacer));
+            }
+            finally {
+                release();
+            }
+        });
+    };
+    const readData = async (file) => {
+        try {
+            const filePath = join(folder, fixFileName(file));
+            const mutex = getFileLock(filePath);
+            return await mutex.acquire().then(async (release) => {
+                try {
+                    const data = await readFile(filePath, { encoding: 'utf-8' });
+                    return JSON.parse(data, BufferJSON.reviver);
+                }
+                finally {
+                    release();
+                }
+            });
+        }
+        catch (error) {
+            return null;
+        }
+    };
+    const removeData = async (file) => {
+        try {
+            const filePath = join(folder, fixFileName(file));
+            const mutex = getFileLock(filePath);
+            return mutex.acquire().then(async (release) => {
+                try {
+                    await unlink(filePath);
+                }
+                catch {
+                }
+                finally {
+                    release();
+                }
+            });
+        }
+        catch { }
+    };
+    const folderInfo = await stat(folder).catch(() => { });
+    if (folderInfo) {
+        if (!folderInfo.isDirectory()) {
+            throw new Error(`found something that is not a directory at ${folder}, either delete it or specify a different location`);
+        }
+    }
+    else {
+        await mkdir(folder, { recursive: true });
+    }
+    // JAP@Fix 25-08-26 (ENOSPC guard) --- best-effort prune on every startup. Failures here must
+    // never block auth from loading, so this is intentionally fire-and-forget with its own catch.
+    pruneStaleAuthFiles(folder).catch(() => { });
+    const fixFileName = (file) => file?.replace(/\//g, '__')?.replace(/:/g, '-');
+    const creds = (await readData('creds.json')) || initAuthCreds();
+    return {
+        state: {
+            creds,
+            keys: {
+                get: async (type, ids) => {
+                    const data = {};
+                    await Promise.all(ids.map(async (id) => {
+                        let value = await readData(`${type}-${id}.json`);
+                        if (type === 'app-state-sync-key' && value) {
+                            value = proto.Message.AppStateSyncKeyData.fromObject(value);
+                        }
+                        data[id] = value;
+                    }));
+                    return data;
+                },
+                set: async (data) => {
+                    const tasks = [];
+                    for (const category in data) {
+                        for (const id in data[category]) {
+                            const value = data[category][id];
+                            const file = `${category}-${id}.json`;
+                            tasks.push(value ? writeData(value, file) : removeData(file));
+                        }
+                    }
+                    await Promise.all(tasks);
+                }
+            }
+        },
+        saveCreds: async () => {
+            return writeData(creds, 'creds.json');
+        }
+    };
+};

package/lib/Utils/use-single-file-auth-state.d.ts

@@ -0,0 +1,10 @@
+export function useSingleFileAuthState(fileName: any): Promise<{
+    state: {
+        creds: any;
+        keys: {
+            get: (type: any, ids: any) => {};
+            set: (data: any) => void;
+        };
+    };
+    saveCreds: () => void;
+}>;

package/lib/Utils/use-single-file-auth-state.js

@@ -0,0 +1,113 @@
+import { readFile, rename, stat, writeFile } from 'fs/promises';
+import { DEFAULT_CACHE_TTLS } from '../Defaults/index.js';
+import { proto } from '../../WAProto/index.js';
+import { initAuthCreds } from './auth-utils.js';
+import { BufferJSON } from './generics.js';
+import { LRUCache } from 'lru-cache';
+import { Mutex } from 'async-mutex';
+import defaultLogger from './logger.js';
+// JAP@Changes 25-03-26 --- Add useSingleFileAuthState with integrated cache
+const FLUSH_TIMEOUT_MS = 3000;
+// JAP@Changes 22-04-26 --- Enhanced useSingleFileAuthState with LRUCache
+export const useSingleFileAuthState = async (fileName) => {
+    const cache = new LRUCache({
+        max: 20000,
+        ttl: 1000 * DEFAULT_CACHE_TTLS.SIGNAL_STORE,
+        updateAgeOnGet: false,
+        updateAgeOnHas: false,
+        ttlAutopurge: true
+    });
+    // JAP@Changes 26-04-26 --- Add mutex for prevent race condition
+    const mutex = new Mutex();
+    let fileData = {};
+    let isLoaded = false;
+    let flushTimeout = null;
+    const loadKey = async () => {
+        return await mutex.runExclusive(async () => {
+            if (isLoaded)
+                return;
+            try {
+                const data = JSON.parse(await readFile(fileName, 'utf-8'), BufferJSON.reviver);
+                fileData = data || {};
+                for (const [keyName, value] of Object.entries(fileData)) {
+                    cache.set(keyName, value);
+                }
+            }
+            catch {
+                fileData = {};
+            }
+            isLoaded = true;
+        });
+    };
+    const flushKey = () => {
+        if (flushTimeout)
+            return;
+        flushTimeout = setTimeout(async () => {
+            flushTimeout = null;
+            await mutex.runExclusive(async () => {
+                try {
+                    const tempFile = fileName + '.temp';
+                    await writeFile(tempFile, JSON.stringify(fileData, BufferJSON.replacer));
+                    await rename(tempFile, fileName);
+                }
+                catch (err) {
+                    // JAP@Fix (bug 58): was silently swallowed — auth session could fail
+                    // to persist (disk full, permission error, etc.) with zero trace.
+                    defaultLogger.error({ err, fileName }, 'failed to flush auth state to disk');
+                }
+            });
+        }, FLUSH_TIMEOUT_MS);
+    };
+    const writeKey = (keyName, value) => {
+        cache.set(keyName, value);
+        fileData[keyName] = value;
+        flushKey();
+    };
+    const removeKey = (keyName) => {
+        cache.delete(keyName);
+        delete fileData[keyName];
+        flushKey();
+    };
+    const fileInfo = await stat(fileName).catch(() => null);
+    if (!fileInfo) {
+        await writeFile(fileName, '{}');
+    }
+    else if (!fileInfo.isFile()) {
+        throw new Error(`found something that is not a file at ${fileName}, either delete it or specify a different location`);
+    }
+    await loadKey();
+    const creds = fileData['creds'] || initAuthCreds();
+    return {
+        state: {
+            creds,
+            keys: {
+                get: (type, ids) => {
+                    const data = {};
+                    for (const id of ids) {
+                        const keyName = type + id;
+                        let value = cache.get(keyName);
+                        if (value === undefined && fileData[keyName] !== undefined) {
+                            value = fileData[keyName];
+                            cache.set(keyName, value);
+                        }
+                        if (type === 'app-state-sync-key' && value) {
+                            value = proto.Message.AppStateSyncKeyData.fromObject(value);
+                        }
+                        data[id] = value;
+                    }
+                    return data;
+                },
+                set: (data) => {
+                    for (const category in data) {
+                        for (const id in data[category]) {
+                            const keyName = category + id;
+                            const value = data[category][id];
+                            value ? writeKey(keyName, value) : removeKey(keyName);
+                        }
+                    }
+                }
+            }
+        },
+        saveCreds: () => writeKey('creds', creds)
+    };
+};

package/lib/Utils/use-sqlite-auth-state.d.ts

@@ -0,0 +1,11 @@
+export function useSqliteAuthState(opts: any): Promise<{
+    state: {
+        creds: any;
+        keys: {
+            get: (type: any, ids: any) => Promise<{}>;
+            set: (data: any) => Promise<void>;
+        };
+    };
+    saveCreds: () => Promise<void>;
+    close: () => Promise<void>;
+}>;

package/lib/Utils/use-sqlite-auth-state.js

@@ -0,0 +1,169 @@
+import { mkdir, readFile, stat, unlink, writeFile } from 'fs/promises';
+import { join } from 'path';
+import { proto } from '../../WAProto/index.js';
+import { initAuthCreds } from './auth-utils.js';
+import { BufferJSON } from './generics.js';
+async function loadBetterSqlite3() {
+    try {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const mod = (await import('better-sqlite3'));
+        return mod.default ?? mod;
+    }
+    catch (err) {
+        const helpful = new Error('`better-sqlite3` is required for `useSqliteAuthState`. Install it as a peer dependency: `npm install better-sqlite3` (or `yarn add better-sqlite3`).');
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        helpful.cause = err;
+        throw helpful;
+    }
+}
+const CREDS_ROW_KEY = '__creds__';
+const CREATE_SCHEMA_SQL = `
+CREATE TABLE IF NOT EXISTS creds (
+  key TEXT PRIMARY KEY,
+  value TEXT NOT NULL
+);
+CREATE TABLE IF NOT EXISTS signal_keys (
+  type TEXT NOT NULL,
+  id TEXT NOT NULL,
+  value TEXT NOT NULL,
+  PRIMARY KEY (type, id)
+);
+CREATE INDEX IF NOT EXISTS signal_keys_type_idx ON signal_keys(type);
+`;
+// JAP@Add 29-08-26 --- Migration tracking for the auth-state schema,
+// wa_migrations pattern (packages/store-sqlite/src/migrations.ts). Each entry
+// is `{ id, sql }`; applied migrations are recorded by id in `wa_migrations`
+// so `db.exec(...)` schema changes are only ever run once per database file,
+// letting future releases evolve the schema without a manual ALTER step from
+// the user. Kept as an ordered array (not a folder of files) since the schema
+// here is a single flat file with per-domain version keys.
+const MIGRATIONS = [
+    { id: '0001_init', sql: CREATE_SCHEMA_SQL }
+];
+function ensureMigrationsTable(db) {
+    db.exec('CREATE TABLE IF NOT EXISTS wa_migrations (id TEXT PRIMARY KEY, applied_at INTEGER NOT NULL)');
+}
+function runMigrations(db) {
+    ensureMigrationsTable(db);
+    const applied = new Set(db.prepare('SELECT id FROM wa_migrations').all().map((r) => r.id));
+    const insertMigration = db.prepare('INSERT INTO wa_migrations (id, applied_at) VALUES (?, ?)');
+    for (const migration of MIGRATIONS) {
+        if (applied.has(migration.id))
+            continue;
+        const tx = db.transaction(() => {
+            db.exec(migration.sql);
+            insertMigration.run(migration.id, Date.now());
+        });
+        tx();
+    }
+}
+export async function useSqliteAuthState(opts) {
+    let db;
+    if (opts.database) {
+        db = opts.database;
+    }
+    else {
+        const Database = await loadBetterSqlite3();
+        db = new Database(opts.dbPath);
+    }
+    // WAL mode allows concurrent reads alongside a single writer; matches
+    // what SQLite recommends for read-heavy workloads with sporadic writes.
+    db.pragma('journal_mode = WAL');
+    db.pragma('synchronous = NORMAL');
+    runMigrations(db);
+    // JAP@Fix (bug 8): periodic WAL checkpoint + cleanup old signal keys to prevent DB bloat.
+    // Runs every 30 minutes. WAL checkpoint reclaims WAL file space; key cleanup removes stale session entries.
+    const _walCleanupInterval = setInterval(() => {
+        try {
+            db.pragma('wal_checkpoint(PASSIVE)');
+            // Remove signal keys older than 30 days (pre-keys, session keys that have expired)
+            // Only removes types that are safe to prune (not creds or app-state-sync-key)
+            const pruneTypes = ['pre-key', 'session'];
+            for (const type of pruneTypes) {
+                try {
+                    // Keep last 500 per type to avoid breaking active sessions
+                    db.prepare(`
+                        DELETE FROM signal_keys WHERE type = ? AND id NOT IN (
+                            SELECT id FROM signal_keys WHERE type = ? ORDER BY rowid DESC LIMIT 500
+                        )
+                    `).run(type, type);
+                } catch { /* ignore per-type errors */ }
+            }
+        } catch { /* ignore checkpoint errors — non-fatal */ }
+    }, 30 * 60 * 1000);
+    // Allow Node process to exit even if interval is still running
+    if (_walCleanupInterval.unref) _walCleanupInterval.unref();
+    const stmts = {
+        credsSelect: db.prepare('SELECT value FROM creds WHERE key = ?'),
+        credsUpsert: db.prepare('INSERT INTO creds (key, value) VALUES (?, ?) ON CONFLICT(key) DO UPDATE SET value = excluded.value'),
+        keySelect: db.prepare('SELECT value FROM signal_keys WHERE type = ? AND id = ?'),
+        keyUpsert: db.prepare('INSERT INTO signal_keys (type, id, value) VALUES (?, ?, ?) ON CONFLICT(type, id) DO UPDATE SET value = excluded.value'),
+        keyDelete: db.prepare('DELETE FROM signal_keys WHERE type = ? AND id = ?'),
+        keyListIds: db.prepare('SELECT id FROM signal_keys WHERE type = ?'),
+        keyList: db.prepare('SELECT id, value FROM signal_keys WHERE type = ?'),
+        clearKeys: db.prepare('DELETE FROM signal_keys')
+    };
+    const loadCreds = () => {
+        const row = stmts.credsSelect.get(CREDS_ROW_KEY);
+        if (!row)
+            return initAuthCreds();
+        return JSON.parse(row.value, BufferJSON.reviver);
+    };
+    const persistCreds = (creds) => {
+        stmts.credsUpsert.run(CREDS_ROW_KEY, JSON.stringify(creds, BufferJSON.replacer));
+    };
+    const creds = loadCreds();
+    return {
+        state: {
+            creds,
+            keys: {
+                get: async (type, ids) => {
+                    const data = {};
+                    for (const id of ids) {
+                        const row = stmts.keySelect.get(type, id);
+                        if (row) {
+                            let value = JSON.parse(row.value, BufferJSON.reviver);
+                            if (type === 'app-state-sync-key' && value) {
+                                value = proto.Message.AppStateSyncKeyData.fromObject(value);
+                            }
+                            data[id] = value;
+                        }
+                    }
+                    return data;
+                },
+                set: async (data) => {
+                    const writeTx = db.transaction(() => {
+                        for (const category in data) {
+                            for (const id in data[category]) {
+                                const value = data[category][id];
+                                if (value) {
+                                    const stringified = JSON.stringify(value, BufferJSON.replacer);
+                                    stmts.keyUpsert.run(category, id, stringified);
+                                }
+                                else {
+                                    stmts.keyDelete.run(category, id);
+                                }
+                            }
+                        }
+                    });
+                    writeTx();
+                }
+            }
+        },
+        saveCreds: async () => {
+            persistCreds(creds);
+        },
+        // JAP@Fix: release the WAL cleanup interval and (if we opened it ourselves)
+        // the underlying db handle. Without this, every useSqliteAuthState() call
+        // (e.g. re-pairing / rotating sessions) leaked a timer + open sqlite fd forever.
+        close: async () => {
+            clearInterval(_walCleanupInterval);
+            if (!opts.database) {
+                try {
+                    db.close();
+                }
+                catch { /* already closed */ }
+            }
+        }
+    };
+}

package/lib/Utils/validate-connection.d.ts

@@ -0,0 +1,42 @@
+export function generateLoginNode(userJid: any, config: any): any;
+export function generateRegistrationNode({ registrationId, signedPreKey, signedIdentityKey }: {
+    registrationId: any;
+    signedPreKey: any;
+    signedIdentityKey: any;
+}, config: any): any;
+export function configureSuccessfulPairing(stanza: any, { advSecretKey, signedIdentityKey, signalIdentities }: {
+    advSecretKey: any;
+    signedIdentityKey: any;
+    signalIdentities: any;
+}): {
+    creds: {
+        account: any;
+        me: {
+            id: any;
+            name: any;
+            lid: any;
+        };
+        signalIdentities: any[];
+        platform: any;
+    };
+    reply: {
+        tag: string;
+        attrs: {
+            to: string;
+            type: string;
+            id: any;
+        };
+        content: {
+            tag: string;
+            attrs: {};
+            content: {
+                tag: string;
+                attrs: {
+                    'key-index': any;
+                };
+                content: any;
+            }[];
+        }[];
+    };
+};
+export function encodeSignedDeviceIdentity(account: any, includeSignatureKey: any): any;