jeffemmett
/
canvas-website
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
canvas-website/src/automerge
History
Jeff Emmett 71e7e5de05 fix: remove ImageGen references to fix build 
Remove ImageGenShape import and references from useAutomergeStoreV2.ts
to fix TypeScript build error. ImageGen feature files are not yet committed.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
 		2025-11-16 04:17:49 -07:00
..
AutomergeToTLStore.ts fix custom shape type validation errors 2025-11-16 03:13:07 -07:00
CloudflareAdapter.ts update obsidian shape deployment 2025-11-12 16:23:08 -08:00
MinimalSanitization.ts pin object, fix fathom, and a bunch of other things 2025-11-11 22:32:36 -08:00
README.md everything working in dev 2025-11-10 11:06:13 -08:00
TLStoreToAutomerge.ts prevent coordinate collapse on reload 2025-11-16 03:03:39 -07:00
default_store.ts everything working in dev 2025-11-10 11:06:13 -08:00
index.ts everything working in dev 2025-11-10 11:06:13 -08:00
useAutomergeStoreV2.ts fix: remove ImageGen references to fix build 2025-11-16 04:17:49 -07:00
useAutomergeSync.ts final update fix old data conversion 2025-11-10 15:38:53 -08:00
useAutomergeSyncRepo.ts pin object, fix fathom, and a bunch of other things 2025-11-11 22:32:36 -08:00

README.md

Automerge Integration for TLdraw

This directory contains the Automerge-based sync implementation that replaces the TLdraw sync system.

Files

  • AutomergeToTLStore.ts - Converts Automerge patches to TLdraw store updates
  • TLStoreToAutomerge.ts - Converts TLdraw store changes to Automerge document updates
  • useAutomergeStoreV2.ts - Core React hook for managing Automerge document state with TLdraw
  • useAutomergeSync.ts - Main sync hook that replaces useSync from TLdraw (uses V2 internally)
  • CloudflareAdapter.ts - Adapter for Cloudflare Durable Objects and R2 storage
  • default_store.ts - Default TLdraw store structure for new documents
  • index.ts - Main exports

Benefits over TLdraw Sync

  1. Better Conflict Resolution: Automerge's CRDT nature handles concurrent edits more elegantly
  2. Offline-First: Works seamlessly offline and syncs when reconnected
  3. Smaller Sync Payloads: Only sends changes (patches) rather than full state
  4. Cross-Session Persistence: Better handling of data across different devices/sessions
  5. Automatic Merging: No manual conflict resolution needed

Usage

Replace the TLdraw sync import:

// Old
import { useSync } from "@tldraw/sync"

// New
import { useAutomergeSync } from "@/automerge/useAutomergeSync"

The API is identical, so no other changes are needed in your components.

Cloudflare Integration

The system uses:

  • Durable Objects: For real-time WebSocket connections and document state management
  • R2 Storage: For persistent document storage
  • Automerge Network Adapter: Custom adapter for Cloudflare's infrastructure

Migration

To switch from TLdraw sync to Automerge sync:

  1. Update the Board component to use useAutomergeSync
  2. Deploy the new worker with Automerge Durable Object
  3. Update the URI to use /automerge/connect/ instead of /connect/

The migration is backward compatible - existing TLdraw sync will continue to work while you test the new system.