# udashframework/udash-core architecture

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

- Interactive diagram: https://gitdiagram.com/udashframework/udash-core
- Repository: https://github.com/udashframework/udash-core

## Overview

Udash is a Scala.js web-application framework. Its central user-facing capability is reactive data binding: application code creates typed properties and sequences, derives synchronized views, and observes changes. For client/server work, typed REST and RPC interfaces provide communication; the repository also includes authorization, translations, CSS support, and a guide application demonstrating server wiring. The tree does not include the documented routing or UI-component implementations, so those are not mapped. Edges are limited to README statements and sampled/index evidence; unsampled implementation details are omitted.

Main entry points: [`core/src/main/scala/io/udash/properties/PropertyCreator.scala`](https://github.com/udashframework/udash-core/blob/master/core/src/main/scala/io/udash/properties/PropertyCreator.scala) (Property creation), [`rest/src/main/scala/io/udash/rest/raw/RawRest.scala`](https://github.com/udashframework/udash-core/blob/master/rest/src/main/scala/io/udash/rest/raw/RawRest.scala) (REST dispatch), [`core/src/main/scala/io/udash/properties/single/ReadableProperty.scala`](https://github.com/udashframework/udash-core/blob/master/core/src/main/scala/io/udash/properties/single/ReadableProperty.scala) (Readable properties), [`rest/src/main/scala/io/udash/rest/SttpRestClient.scala`](https://github.com/udashframework/udash-core/blob/master/rest/src/main/scala/io/udash/rest/SttpRestClient.scala) (STTP REST client)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_reactive["Reactive properties"]
  node_property_api["Property API<br/>[Property.scala]"]
  node_readable_property["Readable properties"]
  node_property_creator["Property creation"]
  node_seq_property["Sequence properties<br/>[SeqProperty.scala]"]
  node_readable_seq["Readable sequences"]
  node_callback_seq["Callback sequencing"]
  node_registration["Callback registration<br/>[Registration.scala]"]
  node_property_macros["Model macros"]
end

subgraph group_transport["Client-server transport"]
  node_rest_api["Typed REST APIs"]
  node_raw_rest["REST dispatch<br/>[RawRest.scala]"]
  node_rest_client["STTP REST client"]
  node_jetty_client["Jetty REST client"]
  node_rest_body["HTTP body encoding<br/>[HttpBody.scala]"]
  node_rest_values["REST value encoding<br/>[PlainValue.scala]"]
  node_rest_response["REST responses<br/>[RestResponse.scala]"]
  node_rpc_api["Typed RPC interfaces"]
  node_raw_rpc["RPC runtime<br/>[rawrpc.scala]"]
  node_rpc_codecs["RPC exception codecs"]
end

subgraph group_crosscut["Shared framework services"]
  node_auth["Authorization checks<br/>[AuthRequires.scala]"]
  node_translation["Translations"]
  node_styles["CSS styles<br/>[CssBase.scala]"]
end

subgraph group_guide["Guide application"]
  node_guide_server["Guide server"]
  node_guide_rpc["Guide RPC interfaces"]
  node_guide_rest["Guide REST interfaces"]
  node_guide_styles["Guide styles"]
end

node_appdev(("Application developer"))

node_appdev -->|"binds data"| node_property_api
node_property_api -->|"creates via"| node_property_creator
node_property_creator -->|"creates sequences"| node_seq_property
node_readable_property -->|"transforms to"| node_readable_seq
node_readable_seq -->|"registers listeners"| node_registration
node_readable_property -->|"queues updates"| node_callback_seq
node_property_macros -->|"materializes"| node_property_creator
node_appdev -->|"defines endpoints"| node_rest_api
node_rest_client -->|"dispatches requests"| node_raw_rest
node_jetty_client -->|"implements transport"| node_raw_rest
node_raw_rest -->|"parses bodies"| node_rest_body
node_rest_client -->|"handles responses"| node_rest_response
node_appdev -->|"defines interfaces"| node_rpc_api
node_rpc_api -.->|"uses runtime"| node_raw_rpc
node_raw_rpc -->|"uses codecs"| node_rpc_codecs
node_appdev -->|"declares requirements"| node_auth
node_appdev -->|"localizes content"| node_translation
node_appdev -->|"defines styling"| node_styles
node_guide_server -->|"exposes RPC"| node_guide_rpc
node_guide_server -->|"exposes REST"| node_guide_rest
node_guide_styles -->|"builds on"| node_styles

click node_property_api "https://github.com/udashframework/udash-core/blob/master/core/src/main/scala/io/udash/properties/single/Property.scala"
click node_readable_property "https://github.com/udashframework/udash-core/blob/master/core/src/main/scala/io/udash/properties/single/ReadableProperty.scala"
click node_property_creator "https://github.com/udashframework/udash-core/blob/master/core/src/main/scala/io/udash/properties/PropertyCreator.scala"
click node_seq_property "https://github.com/udashframework/udash-core/blob/master/core/src/main/scala/io/udash/properties/seq/SeqProperty.scala"
click node_readable_seq "https://github.com/udashframework/udash-core/blob/master/core/src/main/scala/io/udash/properties/seq/ReadableSeqProperty.scala"
click node_callback_seq "https://github.com/udashframework/udash-core/blob/master/core/src/main/scala/io/udash/properties/CallbackSequencer.scala"
click node_registration "https://github.com/udashframework/udash-core/blob/master/utils/src/main/scala/io/udash/utils/Registration.scala"
click node_property_macros "https://github.com/udashframework/udash-core/blob/master/macros/src/main/scala/io/udash/macros/PropertyMacros.scala"
click node_rest_api "https://github.com/udashframework/udash-core/blob/master/rest/src/main/scala/io/udash/rest/ContextualServerAndClientRestApis.scala"
click node_raw_rest "https://github.com/udashframework/udash-core/blob/master/rest/src/main/scala/io/udash/rest/raw/RawRest.scala"
click node_rest_client "https://github.com/udashframework/udash-core/blob/master/rest/src/main/scala/io/udash/rest/SttpRestClient.scala"
click node_jetty_client "https://github.com/udashframework/udash-core/blob/master/rest/jetty/src/main/scala/io/udash/rest/jetty/JettyRestClient.scala"
click node_rest_body "https://github.com/udashframework/udash-core/blob/master/rest/src/main/scala/io/udash/rest/raw/HttpBody.scala"
click node_rest_values "https://github.com/udashframework/udash-core/blob/master/rest/src/main/scala/io/udash/rest/raw/PlainValue.scala"
click node_rest_response "https://github.com/udashframework/udash-core/blob/master/rest/src/main/scala/io/udash/rest/raw/RestResponse.scala"
click node_rpc_api "https://github.com/udashframework/udash-core/blob/master/rpc/src/main/scala/io/udash/rpc/UsesRemoteRPC.scala"
click node_raw_rpc "https://github.com/udashframework/udash-core/blob/master/rpc/src/main/scala/io/udash/rpc/rawrpc.scala"
click node_rpc_codecs "https://github.com/udashframework/udash-core/blob/master/rpc/src/main/scala/io/udash/rpc/serialization/ExceptionCodecRegistry.scala"
click node_auth "https://github.com/udashframework/udash-core/blob/master/auth/src/main/scala/io/udash/auth/AuthRequires.scala"
click node_translation "https://github.com/udashframework/udash-core/blob/master/i18n/src/main/scala/io/udash/i18n/TranslationKey.scala"
click node_styles "https://github.com/udashframework/udash-core/blob/master/css/src/main/scala/io/udash/css/CssBase.scala"
click node_guide_server "https://github.com/udashframework/udash-core/blob/master/guide/backend/src/main/scala/io/udash/web/server/ApplicationServer.scala"
click node_guide_rpc "https://github.com/udashframework/udash-core/blob/master/guide/backend/src/main/scala/io/udash/web/guide/rpc/ExposedRpcInterfaces.scala"
click node_guide_rest "https://github.com/udashframework/udash-core/blob/master/guide/backend/src/main/scala/io/udash/web/guide/rest/ExposedRestInterfaces.scala"
click node_guide_styles "https://github.com/udashframework/udash-core/blob/master/guide/shared/src/main/scala/io/udash/web/commons/styles/DefaultStyles.scala"

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_property_api,node_readable_property,node_property_creator,node_seq_property,node_readable_seq,node_callback_seq,node_registration,node_property_macros toneBlue
class node_rest_api,node_raw_rest,node_rest_client,node_jetty_client,node_rest_body,node_rest_values,node_rest_response,node_rpc_api,node_raw_rpc,node_rpc_codecs toneAmber
class node_auth,node_translation,node_styles toneMint
class node_guide_server,node_guide_rpc,node_guide_rest,node_guide_styles toneRose
class node_appdev toneIndigo
```

## Components

### Reactive properties

- [Property API](https://github.com/udashframework/udash-core/blob/master/core/src/main/scala/io/udash/properties/single/Property.scala): `core/src/main/scala/io/udash/properties/single/Property.scala`
- [Readable properties](https://github.com/udashframework/udash-core/blob/master/core/src/main/scala/io/udash/properties/single/ReadableProperty.scala): `core/src/main/scala/io/udash/properties/single/ReadableProperty.scala`
- [Property creation](https://github.com/udashframework/udash-core/blob/master/core/src/main/scala/io/udash/properties/PropertyCreator.scala): `core/src/main/scala/io/udash/properties/PropertyCreator.scala`
- [Sequence properties](https://github.com/udashframework/udash-core/blob/master/core/src/main/scala/io/udash/properties/seq/SeqProperty.scala): `core/src/main/scala/io/udash/properties/seq/SeqProperty.scala`
- [Readable sequences](https://github.com/udashframework/udash-core/blob/master/core/src/main/scala/io/udash/properties/seq/ReadableSeqProperty.scala): `core/src/main/scala/io/udash/properties/seq/ReadableSeqProperty.scala`
- [Callback sequencing](https://github.com/udashframework/udash-core/blob/master/core/src/main/scala/io/udash/properties/CallbackSequencer.scala): `core/src/main/scala/io/udash/properties/CallbackSequencer.scala`
- [Callback registration](https://github.com/udashframework/udash-core/blob/master/utils/src/main/scala/io/udash/utils/Registration.scala): `utils/src/main/scala/io/udash/utils/Registration.scala`
- [Model macros](https://github.com/udashframework/udash-core/blob/master/macros/src/main/scala/io/udash/macros/PropertyMacros.scala): `macros/src/main/scala/io/udash/macros/PropertyMacros.scala`

### Client-server transport

- [Typed REST APIs](https://github.com/udashframework/udash-core/blob/master/rest/src/main/scala/io/udash/rest/ContextualServerAndClientRestApis.scala): `rest/src/main/scala/io/udash/rest/ContextualServerAndClientRestApis.scala`
- [REST dispatch](https://github.com/udashframework/udash-core/blob/master/rest/src/main/scala/io/udash/rest/raw/RawRest.scala): `rest/src/main/scala/io/udash/rest/raw/RawRest.scala`
- [STTP REST client](https://github.com/udashframework/udash-core/blob/master/rest/src/main/scala/io/udash/rest/SttpRestClient.scala): `rest/src/main/scala/io/udash/rest/SttpRestClient.scala`
- [Jetty REST client](https://github.com/udashframework/udash-core/blob/master/rest/jetty/src/main/scala/io/udash/rest/jetty/JettyRestClient.scala): `rest/jetty/src/main/scala/io/udash/rest/jetty/JettyRestClient.scala`
- [HTTP body encoding](https://github.com/udashframework/udash-core/blob/master/rest/src/main/scala/io/udash/rest/raw/HttpBody.scala): `rest/src/main/scala/io/udash/rest/raw/HttpBody.scala`
- [REST value encoding](https://github.com/udashframework/udash-core/blob/master/rest/src/main/scala/io/udash/rest/raw/PlainValue.scala): `rest/src/main/scala/io/udash/rest/raw/PlainValue.scala`
- [REST responses](https://github.com/udashframework/udash-core/blob/master/rest/src/main/scala/io/udash/rest/raw/RestResponse.scala): `rest/src/main/scala/io/udash/rest/raw/RestResponse.scala`
- [Typed RPC interfaces](https://github.com/udashframework/udash-core/blob/master/rpc/src/main/scala/io/udash/rpc/UsesRemoteRPC.scala): `rpc/src/main/scala/io/udash/rpc/UsesRemoteRPC.scala`
- [RPC runtime](https://github.com/udashframework/udash-core/blob/master/rpc/src/main/scala/io/udash/rpc/rawrpc.scala): `rpc/src/main/scala/io/udash/rpc/rawrpc.scala`
- [RPC exception codecs](https://github.com/udashframework/udash-core/blob/master/rpc/src/main/scala/io/udash/rpc/serialization/ExceptionCodecRegistry.scala): `rpc/src/main/scala/io/udash/rpc/serialization/ExceptionCodecRegistry.scala`

### Shared framework services

- [Authorization checks](https://github.com/udashframework/udash-core/blob/master/auth/src/main/scala/io/udash/auth/AuthRequires.scala): `auth/src/main/scala/io/udash/auth/AuthRequires.scala`
- [Translations](https://github.com/udashframework/udash-core/blob/master/i18n/src/main/scala/io/udash/i18n/TranslationKey.scala): `i18n/src/main/scala/io/udash/i18n/TranslationKey.scala`
- [CSS styles](https://github.com/udashframework/udash-core/blob/master/css/src/main/scala/io/udash/css/CssBase.scala): `css/src/main/scala/io/udash/css/CssBase.scala`

### Guide application

- [Guide server](https://github.com/udashframework/udash-core/blob/master/guide/backend/src/main/scala/io/udash/web/server/ApplicationServer.scala): `guide/backend/src/main/scala/io/udash/web/server/ApplicationServer.scala`
- [Guide RPC interfaces](https://github.com/udashframework/udash-core/blob/master/guide/backend/src/main/scala/io/udash/web/guide/rpc/ExposedRpcInterfaces.scala): `guide/backend/src/main/scala/io/udash/web/guide/rpc/ExposedRpcInterfaces.scala`
- [Guide REST interfaces](https://github.com/udashframework/udash-core/blob/master/guide/backend/src/main/scala/io/udash/web/guide/rest/ExposedRestInterfaces.scala): `guide/backend/src/main/scala/io/udash/web/guide/rest/ExposedRestInterfaces.scala`
- [Guide styles](https://github.com/udashframework/udash-core/blob/master/guide/shared/src/main/scala/io/udash/web/commons/styles/DefaultStyles.scala): `guide/shared/src/main/scala/io/udash/web/commons/styles/DefaultStyles.scala`

### Other components

- **Application developer**

## Connections

- Application developer → Property API: binds data
- Property API → Property creation: creates via (evidence: `core/src/main/scala/io/udash/properties/single/Property.scala`)
- Property creation → Sequence properties: creates sequences (evidence: `core/src/main/scala/io/udash/properties/PropertyCreator.scala`)
- Readable properties → Readable sequences: transforms to (evidence: `core/src/main/scala/io/udash/properties/single/ReadableProperty.scala`)
- Readable sequences → Callback registration: registers listeners (evidence: `core/src/main/scala/io/udash/properties/seq/ReadableSeqProperty.scala`)
- Readable properties → Callback sequencing: queues updates (evidence: `core/src/main/scala/io/udash/properties/single/ReadableProperty.scala`)
- Model macros → Property creation: materializes (evidence: `macros/src/main/scala/io/udash/macros/PropertyMacros.scala`)
- Application developer → Typed REST APIs: defines endpoints
- STTP REST client → REST dispatch: dispatches requests (evidence: `rest/src/main/scala/io/udash/rest/SttpRestClient.scala`)
- Jetty REST client → REST dispatch: implements transport (evidence: `rest/jetty/src/main/scala/io/udash/rest/jetty/JettyRestClient.scala`)
- REST dispatch → HTTP body encoding: parses bodies (evidence: `rest/src/main/scala/io/udash/rest/raw/RawRest.scala`)
- STTP REST client → REST responses: handles responses (evidence: `rest/src/main/scala/io/udash/rest/SttpRestClient.scala`)
- Application developer → Typed RPC interfaces: defines interfaces
- Typed RPC interfaces → RPC runtime: uses runtime
- RPC runtime → RPC exception codecs: uses codecs (evidence: `rpc/src/main/scala/io/udash/rpc/rawrpc.scala`)
- Application developer → Authorization checks: declares requirements (evidence: `auth/src/main/scala/io/udash/auth/AuthRequires.scala`)
- Application developer → Translations: localizes content
- Application developer → CSS styles: defines styling
- Guide server → Guide RPC interfaces: exposes RPC (evidence: `guide/backend/src/main/scala/io/udash/web/server/ApplicationServer.scala`)
- Guide server → Guide REST interfaces: exposes REST (evidence: `guide/backend/src/main/scala/io/udash/web/server/ApplicationServer.scala`)
- Guide styles → CSS styles: builds on (evidence: `guide/shared/src/main/scala/io/udash/web/commons/styles/DefaultStyles.scala`)
