StoreSyncAdapter (Legacy)

WARNING

This documents the old Node.js API. The store sync layer has not yet been ported to the v2 architecture (RFC 012).

Synchronizes ISyncableStore instances across devices using the message bus.

Usage

import { StoreSyncAdapter } from '@vibecook/truffle';

const sync = new StoreSyncAdapter({
  localDeviceId: node.getLocalDevice().id,
  messageBus: node.getMessageBus(),
  stores: [myStore],
});

sync.start();

StoreSyncAdapterConfig

interface StoreSyncAdapterConfig {
  localDeviceId: string;
  messageBus: IMessageBus;
  stores: ISyncableStore[];
  logger?: Logger;
}

ISyncableStore Interface

Implement this interface to make your store syncable:

interface ISyncableStore<T = unknown> extends EventEmitter {
  readonly storeId: string;
  getLocalSlice(): DeviceSlice<T> | null;
  applyRemoteSlice(slice: DeviceSlice<T>): void;
  removeRemoteSlice(deviceId: string, reason: string): void;
  clearRemoteSlices(): void;

  // Events
  on(event: 'localChanged', listener: (slice: DeviceSlice<T>) => void): this;
  off(event: 'localChanged', listener: (slice: DeviceSlice<T>) => void): this;
}

DeviceSlice

interface DeviceSlice<T = unknown> {
  deviceId: string;
  data: T;
  updatedAt: number;
  version: number;
}