Free, Open Source, Self-Hosted WhatsApp API Gateway
TypeScript apibotgatewayself-hostedwhatsappwhatsapp-apiwhatsapp-automationwhatsapp-botwhatsapp-gatewaywhatsapp-gateway-apiwhatsapp-webwhatsapp-web-api
import { describe, expect, it } from 'vitest';
import { OpenWAClient } from '../src';
import { MockTransport } from './helpers';
function client(t: MockTransport): OpenWAClient {
return new OpenWAClient({ baseUrl: 'http://x', apiKey: 'k', fetch: t.asFetch() });
}
describe('SessionsResource — exact paths', () => {
it('list/get/create/delete/start/stop/logout/forceKill', async () => {
const t = new MockTransport()
.on('GET', /\/sessions$/, { body: [] })
.on('GET', /\/sessions\/s1$/, { body: { id: 's1', name: 'n', status: 'ready' } })
.on('POST', /\/sessions$/, { body: { id: 's1', name: 'n', status: 'created' } })
.on('DELETE', /\/sessions\/s1$/, { status: 204 })
.on('POST', /\/sessions\/s1\/start$/, { body: { id: 's1', name: 'n', status: 'initializing' } })
.on('POST', /\/sessions\/s1\/stop$/, { body: { id: 's1', name: 'n', status: 'disconnected' } })
.on('POST', /\/sessions\/s1\/logout$/, { body: { id: 's1', name: 'n', status: 'disconnected' } })
.on('POST', /\/sessions\/s1\/force-kill$/, { body: { id: 's1', name: 'n', status: 'disconnected' } });
const c = client(t);
await c.sessions.list();
expect(t.lastCall!.url).toBe('http://x/api/sessions');
await c.sessions.get('s1');
expect(t.lastCall!.url).toBe('http://x/api/sessions/s1');
await c.sessions.create({ name: 'n' });
expect(t.lastCall!.body).toEqual({ name: 'n' });
await c.sessions.start('s1');
expect(t.lastCall!.url).toBe('http://x/api/sessions/s1/start');
await c.sessions.stop('s1');
await c.sessions.logout('s1');
expect(t.lastCall!.url).toBe('http://x/api/sessions/s1/logout');
await c.sessions.forceKill('s1');
expect(t.lastCall!.url).toBe('http://x/api/sessions/s1/force-kill');
await c.sessions.delete('s1');
expect(t.lastCall!.method).toBe('DELETE');
});
it('list serialises the name filter into the query string', async () => {
const t = new MockTransport().on('GET', /\/sessions$/, { body: [] });
await client(t).sessions.list({ name: 'my-bot', limit: 5 });
expect(t.lastCall!.url).toBe('http://x/api/sessions?name=my-bot&limit=5');
});
it('getQrCode / requestPairingCode / stats', async () => {
const t = new MockTransport()
.on('GET', /\/qr$/, { body: { qrCode: 'data:image/png;base64,xxx', status: 'qr_ready' } })
.on('POST', /\/pairing-code$/, { body: { pairingCode: 'ABCD1234', status: 'qr_ready' } })
.on('GET', /\/stats\/overview$/, {
body: { total: 1, active: 1, ready: 1, disconnected: 0, byStatus: { ready: 1 } },
});
const c = client(t);
await c.sessions.getQrCode('s1');
expect(t.lastCall!.url).toBe('http://x/api/sessions/s1/qr');
await c.sessions.requestPairingCode('s1', { phoneNumber: '628123456789' });
expect(t.lastCall!.url).toBe('http://x/api/sessions/s1/pairing-code');
expect(t.lastCall!.body).toEqual({ phoneNumber: '628123456789' });
await c.sessions.stats();
expect(t.lastCall!.url).toBe('http://x/api/sessions/stats/overview');
});
it('setOnlinePresence — PUT with the availability flag', async () => {
const t = new MockTransport().on('PUT', /\/presence$/, { body: { success: true } });
await client(t).sessions.setOnlinePresence('s1', { available: false });
expect(t.lastCall!.method).toBe('PUT');
// The account's own presence, not a chat's: no chat id in the path and no /subscribe suffix.
expect(t.lastCall!.url).toBe('http://x/api/sessions/s1/presence');
expect(t.lastCall!.body).toEqual({ available: false });
});
});