Core Concepts
Core Concepts explains the "why" behind VUEDA defaults and the contracts that let server and client work together predictably.
System Foundations
- Architecture Overview: Layers, boundaries, and main extension points.
- Canonical Registration and Model Discovery: Why models are registered and how info endpoints discover them.
- Contract-First Dynamic UI: Why UI is driven by server metadata rather than hardcoded forms.
- Model Feature Policy: How
class Vuedadeclares which framework features a model participates in.
Data and API Contracts
- Server-Client Metadata Contract: Model fields, actions, expands, filters, ordering, permissions.
- Field and Expand Semantics: Meaning of serializer fields, expandable relations, and sparse responses.
- Filtering and Ordering Semantics: How server filtersets/ordering shape client query controls.
- Error and Validation Contract: Validation payload shapes,
non_field_errors, and client form handling. - Primary Key and Identifier Discipline: Expected identifier formats and conversion across Python/JS boundaries.
Compatibility and Boundaries
- DRF Ecosystem Compatibility Boundaries: Hub for where VUEDA intentionally constrains or extends DRF-ecosystem defaults to preserve a contract-first, metadata-driven system.
- Nested Write Compatibility: How flex-fields and nested-writable behavior is composed and constrained for nested writes.
Authorization and Behavior
- Permission Model (CRUDL + Object + State): Full permission evaluation model in VUEDA.
- Authorization vs UI Semantics: Why UI visibility and route semantics differ from server authorization, including why client-side Django-permission evaluation is not authoritative.
- Action Contract and Availability:
available_actions, route actions, group filtering, and safe fallback behavior. - Workflow as a Permission Overlay: State permissions, transition permissions, and row-level outcomes.
- Row-Level Permission Filtering: Queryset/object checks and
listfiltering guarantees.
Client Runtime Model
- Reactive Data Flow (Stores + Composables): How stores/composables coordinate model info, config, and object data.
- Cancellable Network Operations: Why cancellation is built into CRUDL and fetch helpers.
- Form State and Validation Lifecycle: Client-side form graph, touched/modified/ignored state, and server error integration.
- Routing and View Resolution Model: How CRUDL routes and action routing resolve to concrete components.
- Theming and Customization: The four-scope model (instance, component, family, brand) and the mechanisms that map to each.
Operational Concepts
- Configuration Surface and Defaults: VUEDA defaults, required settings, and security-sensitive options.
- VDQ and Background Work Model: Queue item lifecycle, transition hooks, and async execution boundaries.