synclets
v0.0.8TypeScript
An open, storage-agnostic, sync engine development kit.
0/weekUpdated 1 months agoMITUnpacked: 364.0 KB
Published by jamesgpearce
npm install syncletsAn open, storage-agnostic, sync engine development kit.
Read about this new project!
What are Synclets?
Synclets are intended to make it easy to synchronize data between the different parts of your applications, whether between local storage and remote servers, between different devices, or even across worker boundaries.
Why Synclets?
We believe synchronization is a fundamental part of modern app development, especially in the context of rich client and local-first apps. We also believe that you shouldn't be locked into a specific storage solution, transport layer, or vendor in order to do so!
Store your data in...
PGlite
SQLite
Browser
Files
Memory...and synchronize it over:
WebSockets
BroadcastConnect to a data store
Synclets are designed to work with lots of different flavors of storage and transport. For example, you can easily connect to a local instance of PGlite.
``js
import {PGlite} from '@electric-sql/pglite';
import {createPgliteDataConnector} from 'synclets/pglite';
const pglite = await PGlite.create();
const dataConnector = createPgliteDataConnector({
depth: 1,
pglite,
});
`
You can store metadata about your data (primarily timestamps) separately, or in the same data store. For example, here we're using PGlite for metadata too.Metadata is stored separately
`js
import {createPgliteMetaConnector} from 'synclets/pglite';
const metaConnector = createPgliteMetaConnector({
depth: 1,
pglite,
});
`
Synclets are designed to work over a variety of transport layers. For example, to use WebSockets via a server use the Pick a transport layer
createWsClientTransport function.
`js
import {createWsClientTransport} from 'synclets/ws';
import {WebSocket} from 'ws';
const transport = createWsClientTransport({
webSocket: new WebSocket(
'wss://demo.synclets.org/room1',
),
});
`
Finally compose a We're good to go. Take a look at the sample in our launch announcement for a working example.And then put it all together
Synclet instance with your chosen data connector, meta connector, and transport - and start it!
`js
import {createSynclet} from 'synclets';
const synclet = await createSynclet({
dataConnector,
metaConnector,
transport,
});
await synclet.start();
// ...
await synclet.destroy();
``
The Synclets project is pre-alpha right now, so there is still plenty of work to be done! There are decent test suites in place for the core components, and some basic documentation, but we still need to build out more connectors, transports, and examples. We hope you like the idea of this project! If so, please follow us on GitHub, X, or BlueSky, and stay tuned for future updates as we continue to develop Synclets further. Also feel free to kick the tires on our very basic Vite template.What next?
Please follow along!
Meet the family
The Synclets project is part of a group of libraries designed to help make rich client and local-first apps easier to build. Check out the others:
TinyBase
A reactive data store and sync engine.
TinyWidgets
A collection of tiny, reusable, UI components.
TinyTick
A tiny but very useful task orchestrator.