tom_specs_core library
Core annotations and shared types for TomSpecs document model families.
Classes
- AccessKey
- The key a section is reached by in the DocSpecs access API.
- AllowedTags
- Restricts the set of tags that may be applied to sections of this type.
- Case
-
Binds one complex-subsection field of a OneOf container to a discriminator
value (
codespecs_mapping.md§8.2, csm-7-4/csmb6). - CodeSection
- A language-agnostic code block section.
- CodeSpecKind
-
The general, type-level half of the DocSpecs ↔ CodeSpecs link
(
codespecs_mapping.md§9.1). - CodeSpecsProjection
-
Marks a
@Documentroot as the CodeSpecs generation projection. - Comment
- Provides a short inline comment that appears in the outliner output.
- ContentHelp
- Provides content creation guidance for a section or field.
- ContentType
-
Annotates the
contentfield to declare the format of the content text. - DartCodeSection
- A Dart code block section.
- DdlCodeSection
- A DDL code block section.
- DetailedIn
- Marks a Solution Blueprint section class as one whose content is taken over as a top-level entry in the named Phase 3 DocSpec document.
- DiagramSection
- A generic Mermaid diagram section.
- DocSpecsForm
-
The parsed field values of a
@Form-annotated section (YRD5). - DocSpecsSection
- The universal section base type of the TomSpecs object model (YRD5).
- Document
- Marks a class as a document root in the specification model.
- ErDiagramSection
- A Mermaid ER diagram section.
- Field
- A single form field declaration.
- FlowDiagramSection
- A Mermaid flow chart diagram section.
- FollowUpKind
-
The follow-up taxonomy tag for a SOM follow-up subtree
(
codespecs_mapping.md§8.3). - ForEach
- Declares a bidirectional "for-each" constraint between a list field and a registry section type.
- Form
- Declares the form fields for a section whose content is structured as name-value pairs (one per line).
- GanttDiagramSection
- A Mermaid Gantt chart diagram section.
- Headline
- Predefined DEFAULT headline for a section (YRD4).
- MapsTo
- Marks a Solution Blueprint section class as the 1:1 mapping point to the named Phase 3 DocSpec document.
- Max
- Declares the maximum number of items allowed in a list field.
- MaxDepth
- Limits the maximum nesting depth of subsections within this section type.
- MaxLength
- Declares the maximum text length for a string field.
- Min
- Declares the minimum number of items required in a list field.
- MinLength
- Declares the minimum text length for a string field.
- NoArtifact
-
The third routing verdict: this section feeds no downstream artifact
(
codespecs_mapping.md§8.3). - OneOf
-
Declares a discriminated subsection group (closed choice) on a
container section class (
codespecs_mapping.md§8.2, csm-7-4/csmb6). - PatternCheck
- Declares a regex pattern that a field value must match.
- PatternCheckId
- Declares a regex pattern that section IDs must match after prefix resolution.
- Position
- Declares the ordering position of a subsection field within its parent.
- Prefix
- Declares the section-type prefix used for two-stage ID matching.
- Reference
- Declares a field as a reference to data owned elsewhere in the model tree.
- SectionId
- Declares the section ID that the annotated class has in the target specification document.
- SectionIdPattern
-
Declares the section ID pattern for items in a
List<T>field. - SequenceDiagramSection
- A Mermaid sequence diagram section.
- SerializationOrder
- Declares the serialization ordinal of a member within its declaring class.
- SqlCodeSection
- An SQL code block section.
- StandardReferences
- Records the public standard(s) a section or field is derived from, plus a short statement of what the section means.
- TextRequired
-
Marks that the
contenttext of a section must not be empty. - TextSection
- A free-text section that may contain narrative, diagrams, or references.
- Unused
-
Marks a
contentfield as unused — section text is not expected and will be ignored by tooling. - ValidationPrompt
- Provides an AI validation prompt for the section content.
Enums
- CodeSpecPart
-
The finalized catalogue of CodeSpecs "parts" (
codespecs_mapping.md§4.1). - FollowUpProcess
-
The follow-up-taxonomy vocabulary (
codespecs_mapping.md§8.3). - NoArtifactReason
-
Why a section is deliberately routed to neither CodeSpecs nor a follow-up
process (
codespecs_mapping.md§8.3).
Constants
-
deferredCodeSpecParts
→ const Set<
CodeSpecPart> -
The CodeSpecPart values that are deferred: reserved so a SOM section
can carry
@CodeSpecKindtoday, but with no@Cs*annotation, no built-ontom_coreclass and no generated code (codespecs_mapping.md§4.3).