Live Blueprint Vocabulary
This page inventories the vocabulary exported by the current Blueprint packages. It is deliberately implementation-backed: a term appears here only when it exists in the public Dart API today.
This is the raw vocabulary index. Read the Complete Entity Grammar for member-level semantics and the UI Hint Vocabulary for rendering behavior.
Package boundaries
| Package | Role | Public declarations |
|---|---|---|
vyuh_blueprint | Industry-neutral declaration language, application composition, UI intent, assembly, DB/seed hints, and declaration-side execution records. | 409 |
vyuh_blueprint_protocol | Industry-neutral request, query, command, result, failure, projection, replay, and simulation wire contracts. | 56 |
vyuh_blueprint_server | Protocol host, planning/runtime, persistence, compiler, DDL, install, replay, health, and server adapters. | 95 |
The package boundary is semantic:
- a domain declares with
vyuh_blueprint - a client and server communicate with
vyuh_blueprint_protocol - a host executes and persists with
vyuh_blueprint_server
Entity, facet, field, action, evidence, audit, and UI are language terms. They are not package prefixes and do not imply an entity-specific runtime.
Reading rules
- Hold an object when the target is in the same declaration graph.
- Use a typed reference when the target is a catalog, configuration row, cross-module export, or extension binding.
- Use a raw string only for a physical identifier, wire value, data identity, external key, or human text.
- Resolve defaults once through the closest-wins cascade. Renderers must consume the effective result rather than traverse the graph.
- Every custom escape hatch is a named reference with arguments; it must fail validation when no compatible registry binding is installed.
Reference naming invariant
Every symbolic pointer value is named <Target>Ref. The public grammar does not use *Reference types:
FieldRef, notFieldReferenceDartRef, notDartReferenceSodRef, notSodReferenceActionRef,RuleRef,RoleRef,GroupRef, and the remaining catalog pointers follow the same rule
Ref means that the value points at a declaration, catalog entry, projection, extension, or other externally resolved target. A type that merely configures reference behavior is not itself a reference: ReferenceIdField is a field kind and UIReferenceHint is picker UI metadata. Local variables and public properties that hold a reference use a ...Ref name as well.
Language vocabulary
Program, assembly, and lineage
Blueprint, BlueprintUI, BlueprintValidator, BlueprintValidationError, BlueprintRuntimeError, BlueprintError, BlueprintDescriptor, BlueprintDescriptorSet, EffectiveBlueprint, EffectiveEntity, EntityDescriptor, EntityDescriptorSource, EntityUIOverride, EntityOrigin, EntityOriginKind, EntityOriginGraph, BlueprintAssembler, BlueprintBootstrapper, BootstrappedBlueprint, BootstrappedEntity, BlueprintApplicationValidator, BlueprintApplicationValidationError.
Modules, entities, facets, and state
Module, ModuleExport, EntityExport, DerivedValueExport, TriggerExport, Entity, EntityVersioning, Facet, IdentityFacet, IdentityFacetMarker, Lifecycle, Transition, Subscription, FacetProjection, EntityProjection, ProjectedField, ProjectedFieldRef, ProjectionMode, ProjectionAccess, ProjectionUIBehavior, StorageBinding, StoragePlacement, EntityDb, ModuleDb, FieldDb, EntitySeed, ModuleSeed, FieldSeed.
Field interpretation and field tokens
FieldType, TextType, IntegerType, BigIntType, DoubleType, DecimalType, BooleanType, TimestampType, DateType, IntervalType, UuidType, JsonbType, EnumType, DecisionType, Field, TextField, IntegerField, BigIntField, DoubleField, DecimalField, BooleanField, TimestampField, DateField, UuidField, JsonbField, EnumField, ListField, CodeField, NameField, DescriptionField, TenantIdField, SiteIdField, ActorField, StatusField, EffectiveFromField, EffectiveUntilField, ReferenceIdField, IdentifierField, IdentifierPattern, QuantityField, MoneyField, FileField, FileKind, RelatedField, SystemFields, Row, FieldDefaultExpr.
Field references, predicates, order, and aggregation
FieldRef, FieldPredicate, PredicateOp, Compare, AllMatch, AnyMatch, NoneMatch, MatchEverything, MatchNothing, FieldOrder, FieldOrderDirection, FieldNullPlacement, AggregatePredicate, AggregateTerm, AggregateOp.
Relationships and graph semantics
Relationship, RelationshipKind, RelationshipStorage, CascadeRule, EmbedHint, RelatedUI, RelationshipUI, UIRelationshipPresentation, UIReferenceHint.
Derived values and semantic measures
DerivedValue, DerivedValueTier, GeneratedColumnDerivedValue, SqlViewDerivedValue, MaterializedViewDerivedValue, ServerDerivedValue, RelatedField, UnitRef, CurrencyRef.
Identity patterns
IdentifierPattern, IdentifierSegment, LiteralSegment, ContextSegment, CodeSegment, SequenceSegment, ContextToken, ResetScope.
References and extension bindings
Ref, GrantRef, QualificationRef, ActionRef, TaskTemplateRef, RuleRef, RoleRef, GroupRef, EvidenceSourceRef, EvaluatorRef, UnitRef, CurrencyRef, DartRef, BlueprintExtensionRef, BlueprintExtensionKind, BlueprintExtensionSide, UIFieldTransformRef.
Actors, assignment, and work
ActorSet, Anyone, NoOne, Role, Group, ActorUser, ActorInField, Initiator, Grant, Qualified, AllOf, AnyOf, NoneOf, Locked, AssigneeSelector, UserSelector, GroupSelector, RoleSelector, DerivedSelector, AssignmentSpec, ClaimMode, TaskTemplate, TaskTemplateRef, TaskEscalation, TaskCompletionStrategy, ClaimSingle, ParallelAll, Quorum, SeparationOfDuties, SodRef, SodInitiator, SodFieldPath, SodSubject, TaskEffect.
Conditions and rules
Condition, AlwaysCondition, NeverCondition, PredicateCondition, ActorInSetCondition, AllCondition, AnyCondition, NotCondition, EvaluatorCondition, ActorHasGrantCondition, ActorQualifiedCondition, PolicyAllowsCondition, StateIsCondition, FieldEqualsCondition, ExistsCondition, EvidencePresentCondition, Rule, RuleKind, RulePhase, RuleSeverity.
Actions, lifecycle effects, and declaration-side records
Action, ActionScope, ActionStep, ActionUI, ActionContext, Trigger, TriggerSource, ConsistencyMode, Effect, TaskEffect, Rule, ActionError, ActionErrorKind, ActionErrorSeverity, SourceRef, SourceRefKind, ActionCapture, ContextSnapshot, SnapshotTarget, SnapshotStrategy, ActionEvent, ActionEventKind, ActionExecutionRequest, ActionExecutionResult, ActionPreflightResult, ActionPreflightFailure, ActionTransaction, ActionTransactionStatus, ActionSnapshot, ActionEventRecord, ActionDecisionTrace, ActionTraceEntry, ActionTraceKind, ActionTraceOutcome, RuleRegistry, ActionExecutor.
Compiled runtime artifacts
RuntimeArtifactCompilation, RuntimeBlueprintRevision, RuntimeBlueprintManifest, RuntimeEntityProjectionArtifact, RuntimeProjectionSourceArtifact, RuntimeFacetProjectionArtifact, RuntimeProjectionFieldArtifact, RuntimeActionCapabilityArtifact, RuntimeAppSurfaceArtifact, RuntimePolicyArtifact, RuntimeArtifactInstallSql, AppRuntimeArtifactCompiler, RuntimeArtifactSqlEmitter.
These are immutable products compiled from the declaration graph. They are not additional authoring concepts.
Evidence and audit
Evidence, EvidenceKind, AuditEnvelope, SignatureMode, EvidencePresentCondition, EvidenceSourceRef, EvidenceUI, AuditUI.
Database intent
ModuleDb, EntityDb, FieldDb, DbCrossEntityIndex, DbTrigger, DbView, DbRowScale, DbWriteRate, DbReadPattern, DbPartitionStrategy, DbAuditMode, DbRealtimeMode, DbRlsMode, DbOutboxMode, QueryPattern, DbCardinality, DbIndexKind.
Projection query posture is represented by QueryBehavior.
Seed intent
ModuleSeed, EntitySeed, FieldSeed, SeedDatasetSize, SeedRealism, SeedValueStrategy.
UI hint vocabulary
UI vocabulary describes intent. CDX and Studio own widget implementation.
Inheritance and effective resolution
QueryUI and action placements resolve property by property across Blueprint, module, and entity declarations. Field, relationship, action, facet, and entity hints are assembled into EffectiveEntityUI before the renderer sees them.
Cross-cutting UI intent
BlueprintUI, ModuleUI, EntityUI, EntityUIOverride, FacetUI, FieldUI, RelationshipUI, ActionUI, UIIcon, UIVisibility, UIPlacement, UIAccess, UIAccessRule, UIAccessFallback.
List and query intent
ListUI, ListLayoutUI, TableUI, TableColumnUI, GridUI, CardContentUI, KanbanUI, CalendarUI, TreeUI, TimelineUI, CustomUI, QueryUI, FieldPredicate, FieldOrder, UIColumnAppearance, UIColumnViewport, EffectiveEntityUI, SavedViewUI.
ListUI.auto() means “derive a stable table-and-grid recipe from typed entity and field metadata.” Explicit ListUI(layouts: [...]) is ordered and closed: the first layout is the default and every layout owns its own projection, query defaults, and composition. Auto is never permission for a renderer to guess from row values.
Field editor and value intent
FieldUI, UIFieldControl, UIFieldInput, UIOptionSearch, UIBooleanLabels, UIColumnAppearance, UIColumnViewport, UIFieldDerivation, UIFieldDerivationOverride, UIFieldTransform, UIJoinTransform, UITrimTransform, UIUpperCaseTransform, UILowerCaseTransform, UIReplacePatternTransform, UIFieldTransformRef, UIReferenceHint.
Built-in widgets:
auto, text, multilineText, number, decimal, checkbox, date, dateTime, enumSelect, referencePicker, jsonEditor, evidencePicker, signature, checklist, photoCapture, instrumentCapture, custom.
Input capabilities:
auto, never, create, update, createAndUpdate.
Option search:
auto, always, never.
Column appearances:
auto, identity, badge, status, metric, timestamp.
Responsive column thresholds:
always, sm, md, lg, xl, xxl.
Relationship intent
RelationshipUI, UIRelationshipPresentation, UIReferenceHint.
Presentations:
auto, picker, chips, list, table, cards, tree, graph, custom.
The hint also carries option search, projection, editor/detail/inverse visibility, inline-create permission, access, order, and picker/renderer extension refs.
Actions and placement
ActionUI, ActionPlacementRef, ActionPlacementUI, ActionUIRef, UIActionPresentation, UIActionOverflow, EffectiveActionCatalog, EffectiveActionCatalogEntry, EffectiveActionContext, EffectiveActionResolver, EffectiveAction, EffectiveActionSet, EffectiveActionState, EffectiveConditionEvaluator.
Presentations:
auto, icon, text, button.
Effective states:
hidden, disabled, enabled.
Known placements:
collection.toolbar, collection.menu, selection.toolbar, selection.menu, record.header, record.action-bar, record.menu, command-palette, tab.<id>.toolbar, tab.<id>.menu.
Facet sections and detail intent
FacetUI, UISectionKind, DetailUI, DetailUIKind, RelatedUI.
Section kinds:
form, detail, lifecycle, evidence, audit, relationships, analytics.
Detail kinds:
summary, details, analytics, history, audit, evidence, relationships, execution, custom.
Editor and form intent
EditorUI, EditorUIKind, EditorPresentation, EditorOperation, EditorPartUI, EditorPartKind, FormUI, FormSectionUI.
Editor kinds:
form, tabs, wizard, designer, custom.
Presentation:
adaptive, dock, dialog, page.
Operations:
create, update.
Parts:
form, relationship, designer, preview, audit, custom.
App, route, and portfolio intent
BlueprintApp, AppDescriptor, AppModule, AppFeatureRef, AppEntityUIScope, AppPortfolio, PortfolioApplication, RouteUI, AppRouteKind.
Route kinds:
entityList, entityDetail, editor, dashboard, inbox, settings, search, report, custom.
Workspace and shell intent
Workspace, WorkspaceDescriptor, WorkspaceRegion, Navigation, NavigationGroup, NavigationItem, AppShell, ShellDescriptor, AppScope, ActorUI, TenantUI, SiteUI, ScopeSelectorUI, MenuBarUI, MenuUI, MenuItemUI, MenuItemKind, UserMenuUI, AppearanceUI, AppThemeMode, CommandPaletteUI.
Operational application UI
InboxUI, InboxItemKind, DashboardUI, DashboardWidget, DashboardWidgetKind, SearchUI, SearchMode, SettingsUI, RealtimeUI, OfflineUI, OfflineStrategy, LocalizationUI, ProfileUI, NotificationUI, ActivityStreamUI, InspectorUI, PolicyUI, AccessUI, EvidenceUI, AuditUI, ExecutionUI, OfflineExecutionUI, ReportUI, ReportBlock, ReportBlockKind, ReportOutputKind, HelpUI, HelpFragment, HelpScope, SimulationUI, IntegrationUI, DemoUI.
SearchUI uses global_search by default. That standard projection contains the entity identity plus human identity fields (code, name, title, label, display_name, username, or email when present) and any further readable fields marked searchable. CommandPaletteUI.searchRefs names independent search providers; their tabs stream results independently rather than waiting for the slowest provider.
Every effective entity also exposes a standard reference projection for a single entity's top-line identity: id, the available code and human-name fields, and an optional description. Clients use it for labels and links rather than reading detail; the Blueprint query cache deduplicates identical entity-and-id requests and invalidates them from mutation announcements and the compiled relationship graph.
Deployment and status intent
DeploymentUI, DeploymentValue, StatusBarUI, StatusIndicator, StatusIndicatorKind, StatusIndicatorPlacement, StatusIndicatorSource, StatusIndicatorContext.
Protocol vocabulary
Request context and lineage
RequestContext, RequestLineage, RequestSource, ExecutionLimits, ActionReplayContext, ActionResumePolicy, ResumeIncompleteBehavior, ResumeSucceededBehavior.
The common executable/record boundary is BlueprintProtocolOperation, BlueprintProtocolRecord, and BlueprintProtocolExecutor.
Query and projection
BlueprintQueryRequest, QueryRecord, EntityProjection, EntityProjectionKind, FacetProjection, ProjectionField, ProjectionShape.
The query request embeds vyuh_query collection requests and results; CDX is a renderer/storage implementation detail, not the Blueprint wire language.
Actions and records
ActionRequest, ActionRequestFrame, ActionRequestStarted, ActionCommandAdded, ActionRequestSealed, ActionCommand, BlueprintStandardAction, ActionCommandRecord, ActionCommandRecordStatus, ActionRecord, ActionRecordStatus, ActionResult, ActionResultKind, ActionFailure, ActionFailureKind, ActionFailureSeverity, ActionRuleRecord, ActionIntegrityRecord, ActionEvidenceRecord, ActionEffectRecord, ActionDomainEventRecord, ActionSnapshotRecord.
Events, operations, errors, and remedies
ProtocolEvent, ProtocolEventKind, GeneratedProtocolOperation, BlueprintProtocolOperationKind, BlueprintProtocolRecordKind, BlueprintProtocolError, BlueprintProtocolErrorKind, BlueprintProtocolErrorLayer, BlueprintProtocolRemedy.
Declaration-side error vocabulary is ErrorDefinition, ErrorContextField, RemedyDefinition, ErrorRef, and RemedyRef. Module.errors and Module.remedies own the catalogs; Action.raises and Rule.errorRef reference them. Runtime ErrorDescriptor bindings supply the typed vyuh_errors parsers. See Errors and Remedies. At runtime, declared business failures derive from DomainException; failures owned by Blueprint derive from BlueprintProtocolException.
Simulation and agent loops
SimulationScenario, SimulationStep, SimulationRecord, SimulationRecordStatus, AgentLoopRequest, AgentLoopRecord, AgentLoopStatus, AgentLoopBudget.
Server vocabulary
Public host and target vocabulary
BlueprintTarget, BlueprintRegistry, BlueprintServer, PostgresBinding, BlueprintRuntimeArtifactBinding.
The network protocol remains an internal implementation boundary. Supporting types such as BlueprintProtocolsConfig, BlueprintPersistenceConfig, BlueprintPlugin, BlueprintPluginResolution, BindingFinding, BlueprintServerRuntime, and BlueprintRuntime are not additional application assembly concepts.
Route and health modules
BlueprintProtocolRouteModule, BlueprintEntityFacadeRouteModule, BlueprintExplorerRouteModule, BlueprintProtocolHealthSnapshot, BlueprintProtocolHealthIssue, BlueprintProtocolHealthStatus, BlueprintProtocolHealthProbe, DatabaseConnectionSupervisor, DatabaseConnectionStatus, DatabaseConnectionEvent.
Query and persistence
BlueprintProtocolDbExecutor, BlueprintQueryValidationException, ResolvedQuerySource, BlueprintCommandFactory.
Planning and execution
BlueprintRuntimeEngine, ExecutionPlan, ExecutionPhase, PlannedActionCommand, PlannedRule, PlannedSnapshotTarget, PlannedRuntimeEffect, RuntimeEffectKind, WriteTarget, LockTarget, ExecutionExplanation, RuleExplanation, EvaluatorContext, EvaluatorResult, ConditionEvaluator, EffectHandler.
Capability and assignment resolution
ActionCapability, CapabilityRoute, CapabilityDenial, ContextualCapabilityManifest, AssignmentResolutionContext, AssignmentResolver, AssignmentDirectory, QualificationResolver, EffectiveAssignment, AssignmentTraceEntry.
Policy, triggers, outbox, and replay
EntityPolicyContext, TriggerExecutor, TriggerResult, TriggerCommitted, TriggerDenied, TriggerInvalidTransition, SpawnResult, OutboxRunner, OutboxDrainable, OutboxDispatcher, DispatchedEvent, ReplayResult, BlueprintEntityHistoryReader.
Database compiler and generated artifacts
DbCompiler, DbPlan, DbModulePlan, DbEntityPlan, DbIndexPlan, DbTriggerPlan, DbCompilation, DbDiagnostic, DbDiagnosticSeverity, DatabaseDependencyPlan, DatabaseDependencyEdge, DatabaseDependencyCycle, DdlEmitter, EmittedDdl, RuntimeDdlEmitter, RuntimeDdl, RuntimeArtifactInstaller, DerivedArtifacts, EntityDerivedArtifacts, DerivedTable, DerivedColumn, DerivedConstraint, DerivedView, DerivedSchemaInfrastructure, ReverseRelationship.
Server runtime contract
BlueprintManifest, ExecutionLimits, identifiersPolicyDomain, AuditDecision, ActionCapability, ContextualCapabilityManifest.
Re-exported host substrate
vyuh_blueprint_server deliberately re-exports the host types needed to wire a server without importing its implementation package separately:
Actor, UserActor, ServiceActor, SystemActor, AnonymousActor, AuthContext, AuthFailed, AuthModule, AuthRequired, AuthStrategy, PolicyContext, PolicyDecision, PolicyEvaluator, PolicyRegistry, Allowed, Denied, DbAdapter, DbResult, DbSession, CompiledQuery, QueryCompiler, TelemetrySink, TelemetrySpan, NoOpTelemetrySink.
Naming boundaries
Blueprintis the single declarative, full-stack application definition;BlueprintAppandBlueprintServerare its executable client and server hosts.BlueprintDescriptorcontributes program packages;EntityDescriptorcontributes to an entity;BlueprintTargetbinds the Blueprint to executable server and infrastructure implementations.BlueprintServerRuntimeowns host integration;BlueprintRuntimeEngineplans and executes requests.EntityFeature/entityFeatureis the server feature boundary.ListUIis shared by entity declarations and assembled app UI. Assembly resolvesautointo typed layouts and preserves explicit layouts unchanged.UIPlacementis the module/entity disclosure set for route, menu, search, and dashboard placement.
Completeness test
A public term is covered when all applicable answers are explicit:
- What does it mean in the declaration?
- What may it reference, and is that reference typed?
- How is it validated?
- How does it inherit or assemble?
- What is generated for storage and protocol?
- How is it authorized and policy-reduced?
- How is it rendered, edited, formatted, queried, and made responsive?
- What extension binding may replace the default?
- What records, evidence, audit, events, and effects result?
- How is it replayed and explained?
- How is it tested in the generic runtime and in a concrete domain?