Validation

Import these from @grafloria/engine.

Functions

createConnectionGroupValidator

Creates a connection validator that enforces connection group restrictions

Rules:

• Nodes in the same connection group can connect to each other
• Nodes with no connection group can connect to any node
• Nodes in different connection groups cannot connect

Usage:

typescript
Copy
const validator = createConnectionGroupValidator(engine);
connectionStateManager.addValidator(validator);

ts
Copy
function createConnectionGroupValidator(engine: DiagramEngine)

isConnectionAllowedByGroup

Check if a connection between two ports is allowed based on connection groups This is a standalone function that doesn't require a validator to be registered

ts
Copy
function isConnectionAllowedByGroup(
  sourcePort: PortModel,
  targetPort: PortModel,
  engine: DiagramEngine
): boolean

Classes

TypeRegistry

ts
Copy
class TypeRegistry

Methods

• registerNodeType(definition: NodeTypeDefinition): void — Register a node type
• registerPortType(definition: PortTypeDefinition): void — Register a port type
• registerLinkType(definition: LinkTypeDefinition): void — Register a link type
• registerGroupType(definition: GroupTypeDefinition): void — Register a group type
• unregisterNodeType(type: string): boolean — Unregister a node type
• unregisterPortType(type: string): boolean — Unregister a port type
• unregisterLinkType(type: string): boolean — Unregister a link type
• unregisterGroupType(type: string): boolean — Unregister a group type
• getNodeType(type: string): NodeTypeDefinition | undefined — Get node type definition
• getPortType(type: string): PortTypeDefinition | undefined — Get port type definition
• getLinkType(type: string): LinkTypeDefinition | undefined — Get link type definition
• getGroupType(type: string): GroupTypeDefinition | undefined — Get group type definition
• hasNodeType(type: string): boolean — Check if node type exists
• hasPortType(type: string): boolean — Check if port type exists
• hasLinkType(type: string): boolean — Check if link type exists
• hasGroupType(type: string): boolean — Check if group type exists
• listNodeTypes(): NodeTypeDefinition[] — List all node types
• listPortTypes(): PortTypeDefinition[] — List all port types
• listLinkTypes(): LinkTypeDefinition[] — List all link types
• listGroupTypes(): GroupTypeDefinition[] — List all group types
• clear(): void — Clear all registered types
• getStats(): { nodeTypes: number; portTypes: number; linkTypes: number; groupTypes: number; } — Get type statistics
• resolveNodeType(type: string): NodeTypeDefinition — Resolve a node type with all inherited properties
• getNodeTypesByCategory(category: string): NodeTypeDefinition[] — Get all node types in a category
• getNodeTypesByFamily(family: string): NodeTypeDefinition[] — Get all node types in a family
• getNodeTypesByTag(tag: string): NodeTypeDefinition[] — Get all node types with a specific tag
• getNodeTypesByTemplate(templateId: string): NodeTypeDefinition[] — Get all node types using a specific template Includes types that inherit template ID from parent

ValidationEngine

ts
Copy
class ValidationEngine

Methods

• constructor(typeRegistry: TypeRegistry, eventBus?: EventBus)
• enableRealTimeValidation(): void — Enable real-time validation
• disableRealTimeValidation(): void — Disable real-time validation
• isRealTimeValidationEnabled(): boolean — Check if real-time validation is enabled
• validateDiagram( diagram: DiagramModel, options: ValidationOptions = {} ): ValidationResult — Validate entire diagram
• validateNode( node: NodeModel, options: ValidationOptions = {} ): ValidationResult — Validate a node
• validatePort( port: PortModel, node: NodeModel, options: ValidationOptions = {} ): ValidationResult — Validate a port
• validateLink( link: LinkModel, diagram: DiagramModel, options: ValidationOptions = {} ): ValidationResult — Validate a link
• validateHierarchy( node: NodeModel, diagram: DiagramModel, options: ValidationOptions = {} ): ValidationResult — Validate node hierarchy
• validateGroup( group: GroupModel, diagram: DiagramModel, options: ValidationOptions = {} ): ValidationResult — Validate group
• validateLayout( group: GroupModel, diagram: DiagramModel, options: ValidationOptions = {} ): ValidationResult — Validate layout configuration
• addRule( entityType: 'diagram' | 'node' | 'port' | 'link', rule: ValidationRule ): void — Add custom validation rule
• clearRules(entityType: 'diagram' | 'node' | 'port' | 'link'): void — Remove all custom rules for an entity type
• clearAllRules(): void — Clear all custom rules
• getRulesCount(entityType?: 'diagram' | 'node' | 'port' | 'link'): number — Get custom rules count

Interfaces

GroupTypeDefinition

ts
Copy
interface GroupTypeDefinition

Properties

LinkTypeDefinition

ts
Copy
interface LinkTypeDefinition

Properties

NodeTypeDefinition

ts
Copy
interface NodeTypeDefinition

Properties

PortTypeDefinition

ts
Copy
interface PortTypeDefinition

Properties

ValidationOptions

ts
Copy
interface ValidationOptions

Properties

Types

ValidationRule

ts
Copy
type ValidationRule<T = any> = (entity: T) => ValidationResult;