Architecture
Overview of the main systems and package layers in UCD.js
This section is the reference entrypoint for UCD.js architecture. Use it as a table of contents for system flow, package boundaries, app boundaries, and deeper package-level internals.
Start Here
If you are trying to orient yourself quickly:
- Read Data Flow for the end-to-end system picture.
- Read Package Layers for dependency direction and package roles.
- Use Apps or Packages for deeper notes on a specific area.
System Views
Data Flow
End-to-end flow from raw UCD files to client consumption
Package Layers
Detailed package dependency graph organized by layer
Architecture Areas
Apps
Per-app architecture notes and boundaries
Packages
Per-package architecture notes and extension points
Common Entry Points
These are the pages you will likely want most often when working in the repo:
UCD Store
Store internals, lockfile lifecycle, and method-level sequence diagrams.
FS Backend
Backend abstraction used by lockfile and ucd-store.
Lockfile
Canonical on-disk state for mirrored versions and snapshots.
Client
Endpoint discovery and typed HTTP resource wrappers.
Pipeline Server
Execution UI, server boundary, and inspection model.
API App
Public serving layer and API-facing application boundary.
By Intent
- Learn how data moves through the system: Data Flow
- Understand dependency direction and layering: Package Layers
- Inspect an app boundary: Apps
- Inspect a package boundary: Packages
- Jump straight to store internals: UCD Store