# transloadit/uppy architecture

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

- Interactive diagram: https://gitdiagram.com/transloadit/uppy
- Repository: https://github.com/transloadit/uppy

## Overview

Uppy is a modular JavaScript file-uploader monorepo. Its principal workflow is to collect local or remote media, manage and optionally edit it in a UI, then upload it to a destination or processing service. Core coordinates plugins and upload state; Companion provides server-side support for remote providers. The README documents the major plugin capabilities and example wiring, but most plugin implementations were not sampled, so the graph omits uncertain internal call relationships.

Main entry points: [`packages/@uppy/core/src/Uppy.ts`](https://github.com/transloadit/uppy/blob/main/packages/%40uppy/core/src/Uppy.ts) (Uppy Core), [`packages/@uppy/drag-drop/src/DragDrop.tsx`](https://github.com/transloadit/uppy/blob/main/packages/%40uppy/drag-drop/src/DragDrop.tsx) (Drag and Drop), [`packages/@uppy/companion/src/companion.ts`](https://github.com/transloadit/uppy/blob/main/packages/%40uppy/companion/src/companion.ts) (Companion Server), [`packages/@uppy/dashboard/src/Dashboard.tsx`](https://github.com/transloadit/uppy/blob/main/packages/%40uppy/dashboard/src/Dashboard.tsx) (Dashboard)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_core["Upload Core"]
  node_core_runtime["Uppy Core<br/>[Uppy.ts]"]
  node_plugin_api["Plugin API<br/>[BasePlugin.ts]"]
  node_state[("Upload State<br/>[index.ts]")]
end

subgraph group_sources["File Sources"]
  node_dragdrop["Drag and Drop<br/>[DragDrop.tsx]"]
  node_webcam["Camera Capture"]
  node_remote_sources["Remote Sources"]
  node_provider_plugins["Provider Plugins<br/>[GoogleDrive.tsx]"]
  node_companion["Companion Server<br/>[companion.ts]"]
end

subgraph group_ui["User Interfaces"]
  node_dashboard["Dashboard<br/>[Dashboard.tsx]"]
  node_framework_uis["Framework UIs"]
end

subgraph group_processing["Processing"]
  node_image_editor["Image Editor<br/>[ImageEditor.tsx]"]
  node_transloadit["Transloadit Processing<br/>[Client.ts]"]
  node_golden_retriever["File Recovery<br/>[index.ts]"]
end

subgraph group_delivery["Destinations"]
  node_tus["Resumable Upload<br/>[index.ts]"]
  node_aws_s3["AWS S3 Upload<br/>[S3Uploader.ts]"]
  node_xhr["XHR Upload"]
end

node_user(("Uploader"))
node_provider_services["Cloud Providers"]
node_upload_targets["Upload Targets"]

node_user -->|"selects files"| node_dashboard
node_user -->|"drops files"| node_dragdrop
node_dashboard -->|"configures"| node_core_runtime
node_framework_uis -->|"integrates"| node_core_runtime
node_core_runtime -->|"registers plugins"| node_plugin_api
node_core_runtime -.->|"tracks uploads"| node_state
node_dragdrop -->|"adds files"| node_core_runtime
node_webcam -->|"adds captures"| node_core_runtime
node_remote_sources -->|"imports files"| node_core_runtime
node_provider_plugins -->|"uses server support"| node_companion
node_companion -->|"accesses providers"| node_provider_services
node_image_editor -->|"edits files"| node_core_runtime
node_golden_retriever -->|"recovers uploads"| node_core_runtime
node_core_runtime -->|"coordinates upload"| node_tus
node_core_runtime -->|"coordinates upload"| node_aws_s3
node_core_runtime -->|"coordinates upload"| node_xhr
node_tus -->|"uploads resumably"| node_upload_targets
node_aws_s3 -->|"uploads files"| node_upload_targets
node_xhr -->|"uploads files"| node_upload_targets
node_core_runtime -->|"starts processing"| node_transloadit

click node_core_runtime "https://github.com/transloadit/uppy/blob/main/packages/%40uppy/core/src/Uppy.ts"
click node_plugin_api "https://github.com/transloadit/uppy/blob/main/packages/%40uppy/core/src/BasePlugin.ts"
click node_state "https://github.com/transloadit/uppy/blob/main/packages/%40uppy/core/src/store/index.ts"
click node_dashboard "https://github.com/transloadit/uppy/blob/main/packages/%40uppy/dashboard/src/Dashboard.tsx"
click node_framework_uis "https://github.com/transloadit/uppy/tree/main/packages/%40uppy/react/src"
click node_dragdrop "https://github.com/transloadit/uppy/blob/main/packages/%40uppy/drag-drop/src/DragDrop.tsx"
click node_webcam "https://github.com/transloadit/uppy/tree/main/packages/%40uppy/webcam/src"
click node_remote_sources "https://github.com/transloadit/uppy/tree/main/packages/%40uppy/remote-sources/src"
click node_provider_plugins "https://github.com/transloadit/uppy/blob/main/packages/%40uppy/google-drive/src/GoogleDrive.tsx"
click node_companion "https://github.com/transloadit/uppy/blob/main/packages/%40uppy/companion/src/companion.ts"
click node_image_editor "https://github.com/transloadit/uppy/blob/main/packages/%40uppy/image-editor/src/ImageEditor.tsx"
click node_transloadit "https://github.com/transloadit/uppy/blob/main/packages/%40uppy/transloadit/src/Client.ts"
click node_golden_retriever "https://github.com/transloadit/uppy/blob/main/packages/%40uppy/golden-retriever/src/index.ts"
click node_tus "https://github.com/transloadit/uppy/blob/main/packages/%40uppy/tus/src/index.ts"
click node_aws_s3 "https://github.com/transloadit/uppy/blob/main/packages/%40uppy/aws-s3/src/S3Uploader.ts"
click node_xhr "https://github.com/transloadit/uppy/tree/main/packages/%40uppy/xhr-upload/src"

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_core_runtime,node_plugin_api,node_state toneBlue
class node_dragdrop,node_webcam,node_remote_sources,node_provider_plugins,node_companion toneAmber
class node_dashboard,node_framework_uis toneMint
class node_image_editor,node_transloadit,node_golden_retriever toneRose
class node_tus,node_aws_s3,node_xhr,node_user,node_provider_services,node_upload_targets toneIndigo
```

## Components

### Upload Core

- [Uppy Core](https://github.com/transloadit/uppy/blob/main/packages/%40uppy/core/src/Uppy.ts): `packages/@uppy/core/src/Uppy.ts`
- [Plugin API](https://github.com/transloadit/uppy/blob/main/packages/%40uppy/core/src/BasePlugin.ts): `packages/@uppy/core/src/BasePlugin.ts`
- [Upload State](https://github.com/transloadit/uppy/blob/main/packages/%40uppy/core/src/store/index.ts): `packages/@uppy/core/src/store/index.ts`

### File Sources

- [Drag and Drop](https://github.com/transloadit/uppy/blob/main/packages/%40uppy/drag-drop/src/DragDrop.tsx): `packages/@uppy/drag-drop/src/DragDrop.tsx`
- [Camera Capture](https://github.com/transloadit/uppy/tree/main/packages/%40uppy/webcam/src): `packages/@uppy/webcam/src`
- [Remote Sources](https://github.com/transloadit/uppy/tree/main/packages/%40uppy/remote-sources/src): `packages/@uppy/remote-sources/src`
- [Provider Plugins](https://github.com/transloadit/uppy/blob/main/packages/%40uppy/google-drive/src/GoogleDrive.tsx): `packages/@uppy/google-drive/src/GoogleDrive.tsx`
- [Companion Server](https://github.com/transloadit/uppy/blob/main/packages/%40uppy/companion/src/companion.ts): `packages/@uppy/companion/src/companion.ts`

### User Interfaces

- [Dashboard](https://github.com/transloadit/uppy/blob/main/packages/%40uppy/dashboard/src/Dashboard.tsx): `packages/@uppy/dashboard/src/Dashboard.tsx`
- [Framework UIs](https://github.com/transloadit/uppy/tree/main/packages/%40uppy/react/src): `packages/@uppy/react/src`

### Processing

- [Image Editor](https://github.com/transloadit/uppy/blob/main/packages/%40uppy/image-editor/src/ImageEditor.tsx): `packages/@uppy/image-editor/src/ImageEditor.tsx`
- [Transloadit Processing](https://github.com/transloadit/uppy/blob/main/packages/%40uppy/transloadit/src/Client.ts): `packages/@uppy/transloadit/src/Client.ts`
- [File Recovery](https://github.com/transloadit/uppy/blob/main/packages/%40uppy/golden-retriever/src/index.ts): `packages/@uppy/golden-retriever/src/index.ts`

### Destinations

- [Resumable Upload](https://github.com/transloadit/uppy/blob/main/packages/%40uppy/tus/src/index.ts): `packages/@uppy/tus/src/index.ts`
- [AWS S3 Upload](https://github.com/transloadit/uppy/blob/main/packages/%40uppy/aws-s3/src/S3Uploader.ts): `packages/@uppy/aws-s3/src/S3Uploader.ts`
- [XHR Upload](https://github.com/transloadit/uppy/tree/main/packages/%40uppy/xhr-upload/src): `packages/@uppy/xhr-upload/src`

### Other components

- **Uploader**
- **Cloud Providers**
- **Upload Targets**

## Connections

- Uploader → Dashboard: selects files (evidence: `README.md`)
- Uploader → Drag and Drop: drops files (evidence: `README.md`)
- Dashboard → Uppy Core: configures (evidence: `README.md`)
- Framework UIs → Uppy Core: integrates (evidence: `README.md`)
- Uppy Core → Plugin API: registers plugins (evidence: `README.md`)
- Uppy Core → Upload State: tracks uploads (evidence: `packages/@uppy/core/src/Uppy.ts`)
- Drag and Drop → Uppy Core: adds files (evidence: `README.md`)
- Camera Capture → Uppy Core: adds captures (evidence: `README.md`)
- Remote Sources → Uppy Core: imports files (evidence: `README.md`)
- Provider Plugins → Companion Server: uses server support (evidence: `README.md`)
- Companion Server → Cloud Providers: accesses providers (evidence: `README.md`)
- Image Editor → Uppy Core: edits files (evidence: `README.md`)
- File Recovery → Uppy Core: recovers uploads (evidence: `README.md`)
- Uppy Core → Resumable Upload: coordinates upload (evidence: `README.md`)
- Uppy Core → AWS S3 Upload: coordinates upload (evidence: `README.md`)
- Uppy Core → XHR Upload: coordinates upload (evidence: `README.md`)
- Resumable Upload → Upload Targets: uploads resumably (evidence: `README.md`)
- AWS S3 Upload → Upload Targets: uploads files (evidence: `README.md`)
- XHR Upload → Upload Targets: uploads files (evidence: `README.md`)
- Uppy Core → Transloadit Processing: starts processing (evidence: `README.md`)
