# firebaseextended/firepad architecture

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

- Interactive diagram: https://gitdiagram.com/firebaseextended/firepad
- Repository: https://github.com/firebaseextended/firepad

## Overview

Firepad is an embeddable collaborative text and code editor backed by Firebase. A user edits through an editor integration; editor changes become operations, which the client reconciles and the Firebase adapter stores and distributes. The UI also supports rich-text formatting, entities, cursors, and undo/redo. The graph preserves the documented Ace, CodeMirror, and Monaco integrations and HTML parsing capability. Some branches are supported only by README statements; unsampled implementation details and uncertain links are omitted.

Main entry points: [`lib/firepad.js`](https://github.com/firebaseextended/firepad/blob/master/lib/firepad.js) (Firepad API), [`lib/editor-client.js`](https://github.com/firebaseextended/firepad/blob/master/lib/editor-client.js) (Editor client), [`lib/rich-text-codemirror-adapter.js`](https://github.com/firebaseextended/firepad/blob/master/lib/rich-text-codemirror-adapter.js) (Rich-text adapter), [`lib/firebase-adapter.js`](https://github.com/firebaseextended/firepad/blob/master/lib/firebase-adapter.js) (Firebase adapter)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["Editor entry"]
  node_firepad["Firepad API<br/>[firepad.js]"]
  node_headless["Headless API<br/>[headless.js]"]
end

subgraph group_collab["Collaboration and sync"]
  node_editor_client["Editor client<br/>[editor-client.js]"]
  node_client["OT client state<br/>[client.js]"]
  node_text_operation["Text operations<br/>[text-operation.js]"]
  node_undo["Undo manager<br/>[undo-manager.js]"]
  node_firebase_adapter["Firebase adapter"]
end

subgraph group_richtext["Rich-text editing"]
  node_rich_cm["Rich-text model"]
  node_annotation["Annotations<br/>[annotation-list.js]"]
  node_toolbar["Formatting toolbar"]
  node_entities["Rich-text entities<br/>[entity-manager.js]"]
  node_parse_html["HTML parser<br/>[parse-html.js]"]
  node_serialize_html["HTML serializer<br/>[serialize-html.js]"]
end

subgraph group_integrations["Editor integrations"]
  node_codemirror["CodeMirror editor"]
  node_ace["Ace editor"]
  node_monaco["Monaco editor"]
  node_cm_adapter["Rich-text adapter"]
  node_ace_adapter["Ace adapter<br/>[ace-adapter.coffee]"]
  node_monaco_adapter["Monaco adapter<br/>[monaco-adapter.js]"]
end

node_user(("Editor user"))
node_firebase[("Firebase Realtime Database")]
node_document_data[("Document history and presence")]

node_user -->|"edits through"| node_firepad
node_firepad -->|"configures"| node_cm_adapter
node_firepad -->|"creates"| node_toolbar
node_firepad -->|"parses HTML"| node_parse_html
node_firepad -->|"registers entities"| node_entities
node_firepad -->|"supports"| node_ace_adapter
node_firepad -->|"supports"| node_monaco_adapter
node_cm_adapter -->|"adapts editor"| node_codemirror
node_ace_adapter -.->|"adapts editor"| node_ace
node_monaco_adapter -->|"adapts editor"| node_monaco
node_cm_adapter -->|"applies operations"| node_rich_cm
node_rich_cm -->|"tracks annotations"| node_annotation
node_rich_cm -->|"renders entities"| node_entities
node_editor_client -->|"registers callbacks"| node_cm_adapter
node_editor_client -->|"extends"| node_client
node_editor_client -->|"manages history"| node_undo
node_editor_client -.->|"syncs operations"| node_firebase_adapter
node_client -->|"transforms operations"| node_text_operation
node_firebase_adapter -->|"uses SDK"| node_firebase
node_firebase_adapter -->|"reads and writes"| node_document_data
node_firebase -->|"stores revisions and cursors"| node_document_data
node_firepad -.->|"coordinates editing"| node_editor_client
node_firepad -.->|"exports HTML"| node_serialize_html

click node_firepad "https://github.com/firebaseextended/firepad/blob/master/lib/firepad.js"
click node_headless "https://github.com/firebaseextended/firepad/blob/master/lib/headless.js"
click node_cm_adapter "https://github.com/firebaseextended/firepad/blob/master/lib/rich-text-codemirror-adapter.js"
click node_ace_adapter "https://github.com/firebaseextended/firepad/blob/master/lib/ace-adapter.coffee"
click node_monaco_adapter "https://github.com/firebaseextended/firepad/blob/master/lib/monaco-adapter.js"
click node_rich_cm "https://github.com/firebaseextended/firepad/blob/master/lib/rich-text-codemirror.js"
click node_annotation "https://github.com/firebaseextended/firepad/blob/master/lib/annotation-list.js"
click node_toolbar "https://github.com/firebaseextended/firepad/blob/master/lib/rich-text-toolbar.js"
click node_entities "https://github.com/firebaseextended/firepad/blob/master/lib/entity-manager.js"
click node_parse_html "https://github.com/firebaseextended/firepad/blob/master/lib/parse-html.js"
click node_serialize_html "https://github.com/firebaseextended/firepad/blob/master/lib/serialize-html.js"
click node_editor_client "https://github.com/firebaseextended/firepad/blob/master/lib/editor-client.js"
click node_client "https://github.com/firebaseextended/firepad/blob/master/lib/client.js"
click node_text_operation "https://github.com/firebaseextended/firepad/blob/master/lib/text-operation.js"
click node_undo "https://github.com/firebaseextended/firepad/blob/master/lib/undo-manager.js"
click node_firebase_adapter "https://github.com/firebaseextended/firepad/blob/master/lib/firebase-adapter.js"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_firepad,node_headless,node_user toneBlue
class node_editor_client,node_client,node_text_operation,node_undo,node_firebase_adapter,node_firebase,node_document_data toneAmber
class node_rich_cm,node_annotation,node_toolbar,node_entities,node_parse_html,node_serialize_html toneMint
class node_codemirror,node_ace,node_monaco,node_cm_adapter,node_ace_adapter,node_monaco_adapter toneRose
```

## Components

### Editor entry

- [Firepad API](https://github.com/firebaseextended/firepad/blob/master/lib/firepad.js): `lib/firepad.js`
- [Headless API](https://github.com/firebaseextended/firepad/blob/master/lib/headless.js): `lib/headless.js`

### Collaboration and sync

- [Editor client](https://github.com/firebaseextended/firepad/blob/master/lib/editor-client.js): `lib/editor-client.js`
- [OT client state](https://github.com/firebaseextended/firepad/blob/master/lib/client.js): `lib/client.js`
- [Text operations](https://github.com/firebaseextended/firepad/blob/master/lib/text-operation.js): `lib/text-operation.js`
- [Undo manager](https://github.com/firebaseextended/firepad/blob/master/lib/undo-manager.js): `lib/undo-manager.js`
- [Firebase adapter](https://github.com/firebaseextended/firepad/blob/master/lib/firebase-adapter.js): `lib/firebase-adapter.js`

### Rich-text editing

- [Rich-text model](https://github.com/firebaseextended/firepad/blob/master/lib/rich-text-codemirror.js): `lib/rich-text-codemirror.js`
- [Annotations](https://github.com/firebaseextended/firepad/blob/master/lib/annotation-list.js): `lib/annotation-list.js`
- [Formatting toolbar](https://github.com/firebaseextended/firepad/blob/master/lib/rich-text-toolbar.js): `lib/rich-text-toolbar.js`
- [Rich-text entities](https://github.com/firebaseextended/firepad/blob/master/lib/entity-manager.js): `lib/entity-manager.js`
- [HTML parser](https://github.com/firebaseextended/firepad/blob/master/lib/parse-html.js): `lib/parse-html.js`
- [HTML serializer](https://github.com/firebaseextended/firepad/blob/master/lib/serialize-html.js): `lib/serialize-html.js`

### Editor integrations

- **CodeMirror editor**
- **Ace editor**
- **Monaco editor**
- [Rich-text adapter](https://github.com/firebaseextended/firepad/blob/master/lib/rich-text-codemirror-adapter.js): `lib/rich-text-codemirror-adapter.js`
- [Ace adapter](https://github.com/firebaseextended/firepad/blob/master/lib/ace-adapter.coffee): `lib/ace-adapter.coffee`
- [Monaco adapter](https://github.com/firebaseextended/firepad/blob/master/lib/monaco-adapter.js): `lib/monaco-adapter.js`

### Other components

- **Editor user**
- **Firebase Realtime Database**
- **Document history and presence**

## Connections

- Editor user → Firepad API: edits through (evidence: `README.md`)
- Firepad API → Rich-text adapter: configures (evidence: `lib/firepad.js`)
- Firepad API → Formatting toolbar: creates (evidence: `lib/firepad.js`)
- Firepad API → HTML parser: parses HTML (evidence: `lib/firepad.js`)
- Firepad API → Rich-text entities: registers entities (evidence: `lib/firepad.js`)
- Firepad API → Ace adapter: supports (evidence: `README.md`)
- Firepad API → Monaco adapter: supports (evidence: `README.md`)
- Rich-text adapter → CodeMirror editor: adapts editor (evidence: `lib/rich-text-codemirror-adapter.js`)
- Ace adapter → Ace editor: adapts editor
- Monaco adapter → Monaco editor: adapts editor (evidence: `lib/monaco-adapter.js`)
- Rich-text adapter → Rich-text model: applies operations (evidence: `lib/rich-text-codemirror-adapter.js`)
- Rich-text model → Annotations: tracks annotations (evidence: `lib/rich-text-codemirror.js`)
- Rich-text model → Rich-text entities: renders entities (evidence: `lib/rich-text-codemirror.js`)
- Editor client → Rich-text adapter: registers callbacks (evidence: `lib/editor-client.js`)
- Editor client → OT client state: extends (evidence: `lib/editor-client.js`)
- Editor client → Undo manager: manages history (evidence: `lib/editor-client.js`)
- Editor client → Firebase adapter: syncs operations
- OT client state → Text operations: transforms operations (evidence: `lib/client.js`)
- Firebase adapter → Firebase Realtime Database: uses SDK (evidence: `lib/firebase-adapter.js`)
- Firebase adapter → Document history and presence: reads and writes (evidence: `README.md`)
- Firebase Realtime Database → Document history and presence: stores revisions and cursors (evidence: `README.md`)
- Firepad API → Editor client: coordinates editing
- Firepad API → HTML serializer: exports HTML
