Web Adapter

Installation

npm install @livestore/adapter-web @livestore/wa-sqlite

Example

main.ts

import { makePersistedAdapter } from '@livestore/adapter-web'
import LiveStoreSharedWorker from '@livestore/adapter-web/shared-worker?sharedworker'

const adapter = makePersistedAdapter({
  storage: { type: 'opfs' },
  worker: LiveStoreWorker,
  sharedWorker: LiveStoreSharedWorker,
})

livestore.worker.ts index.ts

import { makeWorker } from '@livestore/adapter-web/worker'

import { schema } from './schema/index.ts'

makeWorker({ schema })

import { defineMaterializer, Events, makeSchema, Schema, State } from '@livestore/livestore'

const tables = {
  todos: State.SQLite.table({
    name: 'todos',
    columns: {
      id: State.SQLite.text({ primaryKey: true }),
      text: State.SQLite.text(),
      completed: State.SQLite.boolean({ default: false }),
    },
  }),
} as const

const events = {
  todoCreated: Events.synced({
    name: 'v1.TodoCreated',
    schema: Schema.Struct({ id: Schema.String, text: Schema.String }),
  }),
} as const

const materializers = State.SQLite.materializers(events, {
  [events.todoCreated.name]: defineMaterializer(events.todoCreated, ({ id, text }) =>
    tables.todos.insert({ id, text, completed: false }),
  ),
})

const state = State.SQLite.makeState({ tables, materializers })

export const schema = makeSchema({ events, state })

Adding a sync backend

sync-backend.ts index.ts

import { makeWorker } from '@livestore/adapter-web/worker'
import { makeWsSync } from '@livestore/sync-cf/client'

import { schema } from './schema/index.ts'

makeWorker({ schema, sync: { backend: makeWsSync({ url: 'ws://localhost:8787' }) } })

import { defineMaterializer, Events, makeSchema, Schema, State } from '@livestore/livestore'

const tables = {
  todos: State.SQLite.table({
    name: 'todos',
    columns: {
      id: State.SQLite.text({ primaryKey: true }),
      text: State.SQLite.text(),
      completed: State.SQLite.boolean({ default: false }),
    },
  }),
} as const

const events = {
  todoCreated: Events.synced({
    name: 'v1.TodoCreated',
    schema: Schema.Struct({ id: Schema.String, text: Schema.String }),
  }),
} as const

const materializers = State.SQLite.materializers(events, {
  [events.todoCreated.name]: defineMaterializer(events.todoCreated, ({ id, text }) =>
    tables.todos.insert({ id, text, completed: false }),
  ),
})

const state = State.SQLite.makeState({ tables, materializers })

export const schema = makeSchema({ events, state })

In-memory adapter

You can also use the in-memory adapter which can be useful in certain scenarios (e.g. testing).

in-memory.ts

import { makeInMemoryAdapter } from '@livestore/adapter-web'

Web worker

• Make sure your schema doesn’t depend on any code which needs to run in the main thread (e.g. avoid importing from files using React)
  • Unfortunately this constraints you from co-locating your table definitions in component files.
  • You might be able to still work around this by using the following import in your worker:

    import '@livestore/adapter-web/worker-vite-dev-polyfill'

Why is there a dedicated web worker and a shared worker?

• Shared worker:
  • Needed to allow tabs to communicate with each other using a binary message channel.
  • The shared worker mostly acts as a proxy to the dedicated web worker.
• Dedicated web worker (also called “leader worker” via leader election mechanism using web locks):
  • Acts as the leader/single writer for the storage.
  • Also handles connection to sync backend.
  • Currently needed for synchronous OPFS API which isn’t supported in a shared worker. (Hopefully won’t be needed in the future anymore.)

Why not use a service worker?

• While service workers seem similar to shared workers (i.e. only a single instance across all tabs), they serve different purposes and have different trade-offs.
• Service workers are meant to be used to intercept network requests and tend to “shut down” when there are no requests for some period of time making them unsuitable for our use case.
• Also note that service workers don’t support some needed APIs such as OPFS.

Storage

LiveStore currently only support OPFS to locally persist its data. In the future we might add support for other storage types (e.g. IndexedDB).

During development (NODE_ENV !== 'production'), LiveStore automatically copies older state database files into archive/ inside the OPFS directory for the store (e.g. livestore-<storeId>@<version>/archive/). The three most recent copies are retained so you can inspect pre-migration data; older archives are pruned. In production, we delete outdated state databases immediately.

LiveStore also uses window.sessionStorage to retain the identity of a client session (e.g. tab/window) across reloads.

Resetting local persistence

Resetting local persistence only clears data stored in the browser and does not affect any connected sync backend.

In case you want to reset the local persistence of a client, you can provide the resetPersistence option to the adapter.

reset-persistence.ts

import { makePersistedAdapter } from '@livestore/adapter-web'
import LiveStoreSharedWorker from '@livestore/adapter-web/shared-worker?sharedworker'

const resetPersistence = import.meta.env.DEV && new URLSearchParams(window.location.search).get('reset') !== null

if (resetPersistence) {
  const searchParams = new URLSearchParams(window.location.search)
  searchParams.delete('reset')
  window.history.replaceState(null, '', `${window.location.pathname}?${searchParams.toString()}`)
}

const adapter = makePersistedAdapter({
  storage: { type: 'opfs' },
  worker: LiveStoreWorker,
  sharedWorker: LiveStoreSharedWorker,
  resetPersistence,
})

If you want to reset persistence manually, you can:

1. Clear site data in Chrome DevTools (Application tab > Storage > Clear site data)
2. Use console command if the above doesn’t work due to a Chrome OPFS bug:

const opfsRoot = await navigator.storage.getDirectory();
await opfsRoot.remove();

Note: Only use this during development while the app is running.

Architecture diagram

Assuming the web adapter in a multi-client, multi-tab browser application, a diagram looks like this:

Other notes

• The web adapter is using some browser APIs that might require a HTTPS connection (e.g. navigator.locks). It’s recommended to even use HTTPS during local development (e.g. via Caddy).

Browser support

• Notable required browser APIs: OPFS, SharedWorker, navigator.locks, WASM
• The web adapter of LiveStore currently doesn’t work on Android browsers as they don’t support the SharedWorker API (see Chromium bug).

Best Practices

• It’s recommended to develop in an incognito window to avoid issues with persistent storage (e.g. OPFS).

FAQ

What’s the bundle size of the web adapter?

LiveStore with the web adapter adds two parts to your application bundle:

• The LiveStore JavaScript bundle (~180KB gzipped)
• SQLite WASM (~300KB gzipped)