@zapo-js/store-sqljs

SQLite-backed persistent store for zapo-js. Suitable for single-process bots, dev sessions, and small-to-medium production deployments that don't need a network database.

Backed by sql.js on Node and bun:sqlite on Bun (auto-detected). Lazy migrations run on first touch per domain; all writes go through withTransaction so partial failures roll back cleanly.

Install

npm install @zapo-js/store-sqljs@github:FgsiDev/Store-SQLJs sql.js

sql.js is a peer dependency on Node. Bun ships SQLite natively, so it's not required there.

Warning

• This is not an official package belonging to zapo-js packages, but I only made this for Termux users 🤗
• I changed the Better-Sqlite3 code to a better Sql.js for termux users, there are some that can't be used and error
• Credit By @vinikjkkj

Quick start

import { createStore, WaClient } from 'zapo-js'
import { createSqliteStore } from '@zapo-js/store-sqljs'

const store = createStore({
    backends: {
        sqljs: createSqliteStore({ path: '.auth/state.sqlite' })
    },
    providers: {
        auth: 'sqljs',
        signal: 'sqljs',
        senderKey: 'sqljs',
        appState: 'sqljs',
        // optional: archive messages/threads/contacts for later quote/addon decryption
        messages: 'sqljs',
        threads: 'sqljs',
        contacts: 'sqljs',
        privacyToken: 'sqljs'
    }
})

const client = new WaClient({ store, sessionId: 'default' })

Config

createSqliteStore(config) accepts:

Field	Description
path	Database file path. Use ':memory:' for an ephemeral DB. Mutually exclusive with connection.
connection	Pre-opened WaSqliteConnection to reuse instead of opening a new one. Caller owns the lifecycle (per-store destroy() does not close it).
driver	'auto' (default) / 'sqljs' / 'bun'. Ignored when connection is set.
pragmas	Extra PRAGMA statements merged on top of defaults. Ignored when connection is set.
tableNames	Per-domain table name overrides. Ignored when connection is set.
batchSizes	Per-domain bulk-read batch sizes.
cacheTtlMs	TTLs for the cache domains (retry, groupMetadata, deviceList, messageSecret).

The returned object is shaped as a WaStoreBackend ({ stores, caches }) - feed it to createStore({ backends: { sqljs: ... } }) and reference it by name in providers/cacheProviders.

Bring your own connection

To share a single SQLite connection with the rest of your application, open it yourself with openSqliteConnection and pass it through connection:

import { createSqliteStore, openSqliteConnection } from '@zapo-js/store-sqljs'

const connection = await openSqliteConnection({
    path: 'app.sqlite',
    sessionId: 'shared',
    pragmas: { journal_mode: 'WAL', synchronous: 'NORMAL' }
})

const store = createStore({
    backends: { sqljs: createSqliteStore({ connection }) },
    providers: { auth: 'sqljs', signal: 'sqljs', senderKey: 'sqljs', appState: 'sqljs' }
})

// ... use connection elsewhere in your app ...

await store.destroy()
connection.close() // you opened it, you close it

Notes

• Migrations are idempotent and run lazily. Sharing one DB file across many session ids is supported and recommended (each session is scoped by session_id).
• For high write throughput, set pragmas: { journal_mode: 'WAL', synchronous: 'NORMAL' }.
• The cache domains (retry, groupMetadata, deviceList, messageSecret) expire rows lazily on read; you don't need a background cleanup job.

See the main zapo-js docs for the full store contract and per-domain semantics.