# automerge/automerge-repo architecture

> Architecture diagram of the GitHub repository automerge/automerge-repo, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/automerge/automerge-repo
- Repository: https://github.com/automerge/automerge-repo

## Overview

##### Main Components

a. Core Layer:
- Automerge-repo (central component)
- Document handling system (DocHandle, DocSynchronizer)
- Repository management (Repo)
- Synchronization system (Synchronizer, CollectionSynchronizer)

b. Adapter Layers:
- Storage Adapters
- IndexedDB (browser storage)
- NodeFS (filesystem storage)
- Network Adapters
- WebSocket (client/server communication)
- MessageChannel (cross-tab communication)
- BroadcastChannel (tab-to-tab sync)
- Frontend Framework Adapters
- React Hooks
- Svelte Store

**┌─ Application Layer ─────────────────────┐**
- React/Svelte Applications               │
- Framework Integration Layer ───────────┤
- React Hooks / Svelte Store             │
- Core Layer ──────────────────────────┤
- Automerge Repo                        │
- ┌─────────────┐ ┌─────────────┐      │
- Doc Handling │ │Synchronizer │      │
- ┘ └─────────────┘      │
- Adapter Layer ────────────────────────┤
- ┌─────────┐ ┌─────────┐ ┌──────────┐  │
- Storage  │ │Network  │ │Frontend  │  │
- Adapters │ │Adapters │ │Adapters  │  │
- ┘ └─────────┘ └──────────┘  │
- ┘

##### Important Details

a. Core Functionality:
- Document synchronization flows
- CRDT operations
- Event dispatch system

b. Storage Layer:
- IndexedDB for browser storage
- NodeFS for server storage
- Abstract storage interface

c. Network Layer:
- WebSocket connections
- Cross-tab communication
- Peer-to-peer sync capabilities

d. Framework Integration:
- React hooks interface
- Svelte store implementation

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Styles
    classDef core fill:#b3d1ff,stroke:#4d88ff
    classDef storage fill:#90EE90,stroke:#228B22
    classDef network fill:#FFB347,stroke:#FF8C00
    classDef frontend fill:#DDA0DD,stroke:#8B008B
    classDef application fill:#D3D3D3,stroke:#808080
    classDef server fill:#FFB6C1,stroke:#FF69B4

    %% Application Layer
    subgraph Applications
        ReactCounter["React Counter"]:::application
        ReactTodo["React Todo"]:::application
        SvelteCounter["Svelte Counter"]:::application
    end

    %% Framework Integration Layer
    subgraph FrameworkAdapters
        ReactHooks["React Hooks"]:::frontend
        SvelteStore["Svelte Store"]:::frontend
    end

    %% Core Layer
    subgraph CoreLayer
        Repo["Automerge Repo"]:::core
        DocHandle["Document Handle"]:::core
        Synchronizer["Synchronizer"]:::core
        DocSynchronizer["Doc Synchronizer"]:::core
        CollectionSynchronizer["Collection Synchronizer"]:::core
    end

    %% Adapter Layer
    subgraph StorageAdapters
        IndexedDB["IndexedDB Storage"]:::storage
        NodeFS["NodeFS Storage"]:::storage
    end

    subgraph NetworkAdapters
        WebSocket["WebSocket"]:::network
        MessageChannel["Message Channel"]:::network
        BroadcastChannel["Broadcast Channel"]:::network
    end

    %% Sync Server
    SyncServer["Sync Server"]:::server

    %% Relationships
    ReactCounter --> ReactHooks
    ReactTodo --> ReactHooks
    SvelteCounter --> SvelteStore

    ReactHooks --> Repo
    SvelteStore --> Repo

    Repo --> DocHandle
    Repo --> Synchronizer
    Synchronizer --> DocSynchronizer
    Synchronizer --> CollectionSynchronizer

    Repo --> StorageAdapters
    Repo --> NetworkAdapters

    WebSocket --> SyncServer

    %% Click Events
    click Repo "https://github.com/automerge/automerge-repo/blob/main/packages/automerge-repo/src/Repo.ts"
    click DocHandle "https://github.com/automerge/automerge-repo/blob/main/packages/automerge-repo/src/DocHandle.ts"
    click Synchronizer "https://github.com/automerge/automerge-repo/blob/main/packages/automerge-repo/src/synchronizer/Synchronizer.ts"
    click DocSynchronizer "https://github.com/automerge/automerge-repo/blob/main/packages/automerge-repo/src/synchronizer/DocSynchronizer.ts"
    click CollectionSynchronizer "https://github.com/automerge/automerge-repo/blob/main/packages/automerge-repo/src/synchronizer/CollectionSynchronizer.ts"
    click IndexedDB "https://github.com/automerge/automerge-repo/blob/main/packages/automerge-repo-storage-indexeddb/src/index.ts"
    click NodeFS "https://github.com/automerge/automerge-repo/blob/main/packages/automerge-repo-storage-nodefs/src/index.ts"
    click WebSocket "https://github.com/automerge/automerge-repo/blob/main/packages/automerge-repo-network-websocket/src/index.ts"
    click MessageChannel "https://github.com/automerge/automerge-repo/blob/main/packages/automerge-repo-network-messagechannel/src/index.ts"
    click BroadcastChannel "https://github.com/automerge/automerge-repo/blob/main/packages/automerge-repo-network-broadcastchannel/src/index.ts"
    click ReactHooks "https://github.com/automerge/automerge-repo/blob/main/packages/automerge-repo-react-hooks/src/index.ts"
    click SvelteStore "https://github.com/automerge/automerge-repo/blob/main/packages/automerge-repo-svelte-store/src/index.ts"
    click ReactCounter "https://github.com/automerge/automerge-repo/tree/main/examples/react-counter"
    click ReactTodo "https://github.com/automerge/automerge-repo/tree/main/examples/react-todo"
    click SvelteCounter "https://github.com/automerge/automerge-repo/tree/main/examples/svelte-counter"
    click SyncServer "https://github.com/automerge/automerge-repo/blob/main/examples/sync-server/index.js"

    %% Legend
    subgraph Legend
        CoreComponent["Core Component"]:::core
        StorageComponent["Storage Adapter"]:::storage
        NetworkComponent["Network Adapter"]:::network
        FrontendComponent["Frontend Adapter"]:::frontend
        ApplicationComponent["Application"]:::application
        ServerComponent["Server Component"]:::server
    end
```
