VibeLayer

Framework-independent local-first sync runtime for TypeScript applications and coding agents.

VibeLayer provides:

• a read-only local entity store
• durable named mutation queues
• IndexedDB and in-memory storage adapters
• ordered push and pull synchronization
• field-level conflict policies
• retry, diagnostics, and restart recovery

Your application supplies its schema, mutations, backend transport, and UI bindings.

Install

npm install vibelayer

Minimal Setup

import {
  MemoryStorageAdapter,
  SyncClient,
  defineMutations,
  defineSchema,
} from 'vibelayer';

const schema = defineSchema({
  entities: {
    todo: {
      fields: {
        id: { type: 'string' },
        title: {
          type: 'string',
          durableDraft: true,
          conflict: 'localDirtyWins',
        },
      },
    },
  },
});

const mutations = defineMutations({
  'todo.create': {
    description: 'Create a todo locally.',
    affects: ['todo'],
    apply({ tx }, input: { id: string; title: string }) {
      tx.upsert('todo', input);
    },
  },
});

const client = await SyncClient.create({
  schema,
  mutations,
  storage: new MemoryStorageAdapter(),
  transport: {
    async push(request) {
      return {
        ackedMutationIds: request.mutations.map((mutation) => mutation.id),
      };
    },
  },
});

await client.mutate('todo.create', {
  id: crypto.randomUUID(),
  title: 'Local first',
});

const pendingTodos = client.query('todo', {
  where: { status: 'pending' },
});

const unsubscribe = pendingTodos.subscribe((todos) => {
  renderTodos(todos);
});

await client.sync.push();
unsubscribe();

When integrating an existing REST fetch, reconcile the response and render the canonical local result:

const result = await client.sync.reconcileSnapshot('todo', remoteTodos);
const canonicalTodo = result.entities.todo?.todo_1;
const syncInfo = client.getEntitySyncInfo('todo', 'todo_1');

syncInfo exposes the entity state, dirty fields, effects, and mutation IDs. For full application rendering, subscribe to client.store. For filtered views, use client.query() so local mutations and remote reconcile results automatically move records into or out of the rendered list.

Use IndexedDbStorageAdapter for durable browser persistence. Production transports must map named mutations to your backend and make offline creates idempotent.

Documentation

• Getting Started
• Transport Adapters
• Complete Todo Example
• Repository README

Requires Node.js 18.19 or newer for development tooling. Browser persistence uses the native IndexedDB API.

License

MIT