@pglite-electric/client

Offline-first Electric SQL client for browsers. Companion to @pglite-electric/server.

Install

pnpm add @pglite-electric/client
# or
npm install @pglite-electric/client

Quick start

import { setup, registerPwa } from '@pglite-electric/client';

const client = await setup('myapp-user-sveltelectric', process.env.POSTGRES_DSN!, {
  electricUrl: 'http://localhost:3000',
  baseShapes: ['todos']
});

registerPwa();

Required backend setup

1. Enable logical replication in PostgreSQL and create a publication that Electric SQL can subscribe to.
2. Run the migrations exported by @pglite-electric/server (or copy the SQL from this repo) so tables like __auth_sessions, __magic_links, etc. exist.
3. Ensure application tables include __modified_at, __modified_by, and the triggers shown in scripts/migrate.js. Our server package exposes addTimestampTracking() for this.
4. Deploy the Electric SQL sync service and point the client at its /v1/shape endpoint.

Per-user databases

Call setup() with a unique name per identity (e.g. ${userSlug}-sveltelectric). Use destroyDB({ clearLocal: true, identifier }) on logout to wipe the IndexedDB store so another user can log in cleanly.

PWA helpers

• registerPwa & unregisterPwa register the default service worker.
• pwa/manifest.webmanifest, pwa/service-worker.ts, and icons are bundled for consumers to copy into their app.

Storage limits

Use estimateRemainingDBSpace() to check navigator.storage.estimate() and watch for QuotaExceededError when writing to the queue. Surface those errors so the UI can prompt the user to free space or grant persistent storage.