Glossary
Alphabetical reference of all Entity System terms and concepts.
ActionGroup : Logical grouping of EntityActions rendered as a dropdown menu (⋮) in the detail view. See Actions.
AggregateLayout : Abstract layout for displaying aggregate data (dashboards, analytics) without a specific entity instance. Builds its own data fetching. See Layouts.
Auditable : Mixin that adds createdAt, updatedAt, createdBy, updatedBy to EntityBase. The generator produces concrete @JsonKey(readValue: readFieldValue) declarations in the $EntityBase superclass. See EntityBase.
Authorize : Declarative authorization-expression DSL from vyuh_entity_annotations. Examples: Authorize.permission('lms.area.view'), Authorize.allOf([...]), Authorize.self(). Evaluated by an AuthorizationProvider.
AuthorizationGate : Top-level shell widget that ties the routed UI to the AuthorizationProvider lifecycle (loader on cold start, refresh indicator while in-flight). See Permissions.
AuthorizationProvider : Synchronous authorization provider for the entity system. Holds the current actor's permissions / roles / user-groups as cached sets and evaluates Authorize expressions via can(...). See Permissions.
AuthorizeFallback : Sealed class that describes what to render when AuthorizeGuard denies: FallbackHide, FallbackDisable, FallbackPlaceholder, FallbackRedact, FallbackWidget. See Permissions.
AuthorizeFallbackRegistry : Registry that maps an AuthorizeFallbackWidget subclass to a builder. Used when the resolved fallback is FallbackWidget(MyType). See Permissions.
AuthorizeGuard : Widget that conditionally renders its child based on an Authorize expression. Provides surface-specific factories (AuthorizeGuard.route, .menu, .tab, .section, .action, .fieldRead, .fieldWrite). Replaces the legacy PermissionGuard. See Permissions.
CacheKeyBuilder : Builds hierarchical cache keys in the format entityType:operation:params for the query caching system. See EntityApi.
CachingPolicy : Controls stale-while-revalidate behavior for HttpEntityApi. Configures stale duration and excluded operations. See EntityApi.
CollectionAction : Action that operates on a list selection or appears in the list-view header. Distinct from EntityAction which takes a specific entity. See Actions.
CollectionLayout : Abstract layout for displaying multiple entity instances (tables, grids, custom). Renamed from the legacy ListLayout. See Layouts.
ColumnPriority : essential / high / normal / low constants used by FieldDefinition.priority to drive adaptive column visibility. See EntityConfiguration.
CustomEditorPart : Callback-based editor part for custom editing interfaces (workflow designers, visual editors). See Editors.
DefaultEntityTransformer : Pass-through EntityTransformer that uses entity.toJson() and merges form data with existing entity data. See Editors.
Draftable : Mixin for entities that support draft workflows. Adds draftMetadata and helper getters. Requires Versionable. See EntityBase.
EditorAction : Semantic subclass of EntityAction for editor save / draft / cancel buttons. Carries an EditorActionType for styling and an executor that receives a SaveCallback from the controller. See Actions.
EditorActionCancelledException : Exception thrown by EditorAction.executor when the user cancels (e.g. dismisses the verification dialog). The controller catches it silently.
EditorActionType : Enum (save, draft, cancel) used for editor button styling only, never for behavioural branching.
EditorDisplayMode : Enum controlling how an entity editor is rendered: panel, fullWidth, or adaptive. See Editors.
EndpointBuilder : Constructs REST API endpoint URIs from a prefix path. Provides standard CRUD endpoint methods. Extended by VersionedEndpointBuilder and SingletonVersionedEndpointBuilder. See EntityApi.
EntityAction : Action that operates on a single entity instance (edit, delete, deactivate). Supports Authorize, isVisible, isEnabled, disabledTooltip, dynamic titleResolver. See Actions.
EntityActions : Container grouping inline, menu, collection, and header actions for an entity. Use StandardEntityActions.inline<T>() and StandardEntityActions.header<T>() for the standard set. See EntityConfiguration.
EntityApi : Abstract base class defining CRUD operations for an entity type. All entity types must provide an implementation. See EntityApi.
EntityBase : Abstract base class for all entities. Provides id and name. Audit / version / draft fields come from mixins. Extends ContentItem from vyuh_core. See EntityBase.
EntityCategory : Top-level category grouping for entities (e.g., general, operations, administration). Defaults to EntityCategory.general when not specified.
EntityComparisonLayout : Multi-entity rendering primitive — renders entity snapshots side-by-side. Used by audit delta cards and future trend / matrix views. See Layouts.
EntityConfiguration : The central configuration class for an entity type. Brings together metadata, API, layouts, editor, actions, and routing. See EntityConfiguration.
EntityDataExtractor : Static utility that extracts search documents from all registered entity configurations for indexing. See Services.
EntityEditor : Abstract base class for entity editors. Concrete subclasses are StandardEntityEditor (non-regulated) and SignatureDrivenEditor (regulated). See Editors.
EntityEditorPart : Abstract base class for parts that compose an entity editor. Parts render as tabs in multi-part editors. Built-in subclasses: FormEditorPart and CustomEditorPart. See Editors.
EntityHelpService : Service for managing contextual help content per entity type. Supports asset-based and runtime help registration. See Services.
EntityItemLayout : Single-entity rendering primitive — used by version cards, sidebars, command-palette previews. Looked up by identifier ('default', 'compact', …). See Layouts.
EntityLayout : Abstract layout for displaying a single entity instance. Used for detail tabs and summary views. See Layouts.
EntityLayouts : Container class grouping all layout types for an entity: list, details, items, comparisons, summary, dashboard, analytics. See Layouts.
EntityLocalizationService : Service providing localized strings for entity names, fields, actions, and error messages with multi-locale support. See Services.
EntityMetadata : Descriptive information about an entity type: display names, icon, identifier, schema type, visibility, and localization resolvers. See EntityConfiguration.
EntityNameCacheService : Service that caches entity names by identifier and ID, preventing redundant API calls for reference columns. Provides getName / getNameByType for direct string resolution. See Services.
EntityPermissionCache : Static cache for entity-scoped permission results — detail tab IDs, action IDs, and route permission booleans. Used internally by EntityLayouts to avoid re-running permission filters. Cleared via EntityConfiguration.clearAllPermissionCaches() on logout. See Permissions.
EntityRealtimeService : Service for subscribing to real-time entity updates using configurable strategies (polling, SSE). See Services.
EntityReference : Lightweight reference to another entity containing id, name, and optional description. Equality is based on id. See EntityBase.
EntityRoutePermissions : Defines required permissions for core entity routes (list, create, view, edit, dashboard). At runtime, evaluated via Authorize.anyPermission(perms). See Permissions.
EntityRouting : Consolidated routing configuration combining path patterns, route builder, selection mode, and route permissions. See EntityConfiguration.
EntitySelectionMode : Enum controlling how entity selection works in list views: none, navigate, or responsive. Used with EntityRouting.mode. See EntityConfiguration.
EntityService : Abstract base class for all entity services. Defines name, initialize(), and dispose(). See Services.
EntityServicesContainer : Type-safe container for registering and retrieving entity services. See Services.
EntitySystemPlugin : The main plugin that manages entity registrations, route generation, authorization, and service hosting. See Services.
EntityTransformer : Abstract class for transforming data between entity objects and form field values. See Editors.
FieldDefinition : Declarative field-definition base class for type-safe columns and filters. Subclasses include TextFieldDef, NumberFieldDef, EnumFieldDef, BooleanFieldDef, DateFieldDef, DateTimeFieldDef, ReferenceFieldDef. See EntityConfiguration.
FieldKey : Enum of standard entity field names (id, name, title, description, audit and version fields) used for customizable JSON key mapping. Renamed from the legacy EntityFieldKey. See EntityBase.
FieldKeyMap : Static final class mapper that converts FieldKey values to their actual JSON key strings. Supports customization for different backend conventions. Renamed from the legacy EntityFieldKeyMap. See EntityBase.
FormEditorPart : Built-in editor part that uses a Vyuh Form for entity editing. Handles form creation, validation, watch-field event broadcasting, and data extraction. See Editors.
HasActiveStatus : Mixin for entities with an isActive boolean property. See EntityBase.
HasCode : Mixin for entities with a code string property. See EntityBase.
HasDescription : Mixin for entities with an optional description string property. See EntityBase.
HasStatus : Mixin for entities with a status string property. See EntityBase.
HttpEntityApi : Standard HTTP/REST implementation of EntityApi. Provides default CRUD operations with query caching and a mutate family for custom endpoints. See EntityApi.
HttpMutationMethod : Enum (post, put, patch, delete) passed to HttpEntityApi.mutate. Kept as a first-class type for exhaustiveness checking.
InvalidationEvent : Describes what was invalidated in the query cache. Final class containing entityType, optional entityId, and optional mutationType. Broadcast on QueryCacheService.invalidations. See Services.
LayoutBase : Abstract base class for all entity layouts. Provides metadata: schema type, identifier, title, icon, Authorize gating, and localization. See Layouts.
LifecycleRequirements : Resolved verification / remarks / approvals shape for a regulated entity operation. Returned by a LifecycleResolver callback into SignatureDrivenEditor. See Editors.
LifecycleResolver : typedef Future<LifecycleRequirements> Function() — async callback provided by the app layer that resolves verification policy at runtime.
Mutation : Final class describing a cache change (entityType, MutationType, optional entityId). Used with HttpEntityApi.cachedGet / announce and QueryCacheService.subscribe / announce. See EntityApi.
MutationType : Enum (create, update, delete) used inside a Mutation.
NavigationPathBuilder : Generates URL paths for entity routes. Factory constructors: collection() for multi-instance, singleton() for single-instance. See EntityConfiguration.
OpenAuthorizationProvider : Built-in AuthorizationProvider that allows all operations. Default when no provider is supplied to EntitySystemPlugin. See Permissions.
QueryCacheService : Central service for stale-while-revalidate query caching with targeted invalidation. Provides both lightweight one-shot caching (used by HttpEntityApi.cachedGet) and reactive ObservableStream queries via cached_query_flutter. See Services.
RelatedEntityApi : Minimal API for managing many-to-many relationships using conventional REST routes (/parentIdentifier/:id/relationSegment). See EntityApi.
SearchSyncService : Service for syncing entity data to the search index for command-palette search. See Services.
SignatureDrivenEditor : Concrete regulated EntityEditor that resolves verification / remarks requirements via LifecycleResolver during init() and injects a verified-save action. See Editors.
SignatureVerificationService : Service for e-signature verification dialogs during entity operations. Only registered when EntitySystemPlugin receives a signatureProvider. See Services.
SingletonVersionedEndpointBuilder : Variant of VersionedEndpointBuilder for singleton entities — overrides getOne / update / delete to use the bare prefix without an /id.
SnakeCaseEntityTransformer : Transformer that auto-converts between snake_case entity JSON and camelCase form fields. Supports field exclusion and per-field transforms. See Editors.
StandardEntityActions : Helpers in vyuh_entity_system_ui that produce standard inline actions (Edit, Deactivate) and header actions (Create). The header Create falls back to the entity's routing.permissions.create for authorization. See Actions.
StandardEntityEditor : Concrete non-regulated EntityEditor. Plain save + cancel, no verification. See Editors.
UIVisibility : Sealed class declaring where an entity is exposed (RouteVisibility, MenuVisibility, SearchVisibility, DashboardVisibility). Pass a Set<UIVisibility> to EntityMetadata.visibility. See EntityConfiguration.
Versionable : Mixin for entities with version tracking. Adds versionNumber and isActive properties. Lives in versioning_audit/models/versioned_entity.dart. See EntityBase.
VersionableActions : Helper in vyuh_entity_system_ui that produces Edit + Deactivate + Activate actions for entities mixing in Versionable. Honours Draftable state for visibility and dynamic titles. See Actions.
VersionedEndpointBuilder : Extended EndpointBuilder with versioning and draft operation paths (versions, audit, compare, draft CRUD, restore, activate / deactivate). See EntityApi.