@cf-sync/client 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +32 -0
- package/dist/client-tvsT_ixa.d.ts +714 -0
- package/dist/index.d.ts +139 -0
- package/dist/index.js +2051 -0
- package/dist/react.d.ts +49 -0
- package/dist/react.js +53 -0
- package/package.json +76 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Jacob Maynard
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# @cf-sync/client
|
|
2
|
+
|
|
3
|
+
The browser half of [cf-sync](https://github.com/InfinityBowman/cf-sync) — a server-authoritative sync engine on Cloudflare Durable Objects, with TanStack DB as the client store.
|
|
4
|
+
|
|
5
|
+
`SyncClient` owns the socket, the offline outbox, optimistic mutation replay, and presence; `createWorkspace` bootstraps it together with one typed TanStack DB collection per schema table.
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
npm install @cf-sync/client @cf-sync/protocol @tanstack/db zod
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
```ts
|
|
12
|
+
import { createWorkspace } from '@cf-sync/client'
|
|
13
|
+
import { app } from './schema' // your defineApp definition — same value the server uses
|
|
14
|
+
|
|
15
|
+
const { client, collections } = createWorkspace({
|
|
16
|
+
url: 'wss://your-worker',
|
|
17
|
+
workspaceId,
|
|
18
|
+
app,
|
|
19
|
+
persist: true, // IndexedDB mirror: instant reload hydration, durable offline outbox
|
|
20
|
+
})
|
|
21
|
+
|
|
22
|
+
collections.issues.insert({ id: ulid(), title: 'ship it' }) // optimistic, converges via the server
|
|
23
|
+
await client.mutate.issue.move({ id, column }) // typed intent mutation, one wire op
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Mutations are optimistic out of the box: the shared mutator runs locally as one atomic overlay, then is swapped for the server's authoritative patch on confirm — or rolled back together on rejection. A rejection always means the mutation will not apply.
|
|
27
|
+
|
|
28
|
+
React hooks ship at `@cf-sync/client/react`: `useSyncStatus` and `usePresence`. Read collections with `useLiveQuery` from `@tanstack/react-db` (both React and `@tanstack/react-db` are optional peers).
|
|
29
|
+
|
|
30
|
+
**Docs:** [Getting started](https://github.com/InfinityBowman/cf-sync/blob/main/docs/guide/getting-started.md) · [Mutations](https://github.com/InfinityBowman/cf-sync/blob/main/docs/guide/mutations.md) · [Offline & persistence](https://github.com/InfinityBowman/cf-sync/blob/main/docs/guide/offline-persistence.md) · [Presence](https://github.com/InfinityBowman/cf-sync/blob/main/docs/guide/presence.md) · [Repository](https://github.com/InfinityBowman/cf-sync)
|
|
31
|
+
|
|
32
|
+
MIT
|