@stratasync/client

Client orchestration, outbox management, identity maps, query execution, and undo/redo for Strata Sync.

Installation


npm install @stratasync/client

@stratasync/client depends on @stratasync/core and @stratasync/y-doc as workspace dependencies.

Wire up storage, transport, and reactivity, then call start().


import { createSyncClient } from

Published with Edda

Property / Method	Type	Description
`state`	`SyncClientState`	Current sync state.
`connectionState`	`ConnectionState`	Current connection state.
`lastSyncId`	`number`	Last sync ID received from server.
`lastError`	`Error \| null`	Last error (if any).
`clientId`	`string`	Client instance identifier.
`start()`	`Promise<void>`	Start the sync lifecycle.
`stop()`	`Promise<void>`	Stop the sync lifecycle.
`syncNow()`	`Promise<void>`	Force an immediate sync.
`clearAll()`	`Promise<void>`	Clear all local data.
`getPendingCount()`	`Promise<number>`	Pending transaction count.

Method	Type	Description
`get(modelName, id)`	`Promise<T \| null>`	Get a model by ID.
`getCached(modelName, id)`	`T \| null`	Get from identity map.
`ensureModel(modelName, id)`	`Promise<T \| null>`	Load if not cached.
`getAll(modelName, options?)`	`Promise<T[]>`	Get all models of a type.
`query(modelName, options?)`	`Promise<QueryResult<T>>`	Query with filters.
`getIdentityMap(modelName)`	`Map<string, T>`	Raw identity map access.
`isModelMissing(modelName, id)`	`boolean`	Check if model not found.

Method	Type	Description
`onEvent(callback)`	`() => void`	Subscribe to events. Returns unsubscribe.
`onStateChange(callback)`	`() => void`	Subscribe to state changes.
`onConnectionStateChange(callback)`	`() => void`	Subscribe to connection changes.

Export	Description
`IdentityMap`	In-memory cache that deduplicates model instances by ID.
`IdentityMapRegistry`	Manages multiple `IdentityMap` instances, one per model type.
`OutboxManager`	Manages the pending transaction outbox for offline-first persistence.
`SyncOrchestrator`	Coordinates the full sync lifecycle (bootstrap, deltas, reconnection).
`executeQuery`	Runs a query against the identity map with filter operators and sorting.