agents / Exports / WorkflowValidatorInterface
Interface: WorkflowValidatorInterface<TWorkflowData>
Workflow Validator Interface
Core interface for validating workflow data structures. All workflow validators must implement this interface.
Type parameters
| Name | Type | Description |
|---|---|---|
TWorkflowData | extends WorkflowData | Type of workflow data to validate |
Implemented by
Table of contents
Properties
Methods
Properties
name
• Readonly name: string
Validator name for identification
Defined in
packages/agents/src/interfaces/workflow-validator.ts:154
version
• Readonly version: string
Validator version
Defined in
packages/agents/src/interfaces/workflow-validator.ts:157
dataFormat
• Readonly dataFormat: string
Data format that this validator handles
Defined in
packages/agents/src/interfaces/workflow-validator.ts:160
availableRules
• Readonly availableRules: string[]
Available validation rules
Defined in
packages/agents/src/interfaces/workflow-validator.ts:163
Methods
validate
▸ validate(data, options?): Promise<ValidationResult>
Validate workflow data
Parameters
| Name | Type | Description |
|---|---|---|
data | TWorkflowData | Workflow data to validate |
options? | ValidationOptions | Validation options |
Returns
Promise<ValidationResult>
Promise resolving to validation result
Defined in
packages/agents/src/interfaces/workflow-validator.ts:172
validateRule
▸ validateRule(data, rule, options?): Promise<ValidationResult>
Validate specific aspect of workflow data
Parameters
| Name | Type | Description |
|---|---|---|
data | TWorkflowData | Workflow data to validate |
rule | string | Specific rule to apply |
options? | ValidationOptions | Validation options |
Returns
Promise<ValidationResult>
Promise resolving to validation result for this rule
Defined in
packages/agents/src/interfaces/workflow-validator.ts:182
canValidate
▸ canValidate(data): data is TWorkflowData
Check if validator can handle the given data format
Parameters
| Name | Type | Description |
|---|---|---|
data | WorkflowData | Data to check |
Returns
data is TWorkflowData
True if validator can handle this data
Defined in
packages/agents/src/interfaces/workflow-validator.ts:190
getRuleDescriptions
▸ getRuleDescriptions(): Map<string, { description: string ; severity: ValidationSeverity ; category: string ; enabled: boolean }>
Get available validation rules with descriptions
Returns
Map<string, { description: string ; severity: ValidationSeverity ; category: string ; enabled: boolean }>
Map of rule names to descriptions
Defined in
packages/agents/src/interfaces/workflow-validator.ts:197
configureRules
▸ configureRules(rules): void
Enable or disable specific validation rules
Parameters
| Name | Type | Description |
|---|---|---|
rules | Map<string, boolean> | Map of rule names to enabled status |
Returns
void
Defined in
packages/agents/src/interfaces/workflow-validator.ts:209
autoRecover
▸ autoRecover(data, issues): Promise<{ recoveredData: TWorkflowData ; recoveryResult: { success: boolean ; issuesFixed: ValidationIssue[] ; remainingIssues: ValidationIssue[] ; appliedFixes: string[] } }>
Perform automatic recovery for validation issues
Parameters
| Name | Type | Description |
|---|---|---|
data | TWorkflowData | Original workflow data |
issues | ValidationIssue[] | Validation issues to recover from |
Returns
Promise<{ recoveredData: TWorkflowData ; recoveryResult: { success: boolean ; issuesFixed: ValidationIssue[] ; remainingIssues: ValidationIssue[] ; appliedFixes: string[] } }>
Promise resolving to recovered data and recovery result
Defined in
packages/agents/src/interfaces/workflow-validator.ts:218
getStats
▸ getStats(): Object
Get validator statistics and metrics
Returns
Object
Validator performance metrics
| Name | Type |
|---|---|
totalValidations | number |
successfulValidations | number |
failedValidations | number |
averageProcessingTime | number |
averageIssueCount | number |
mostCommonIssues | { rule: string ; count: number ; severity: ValidationSeverity }[] |
lastValidationAt? | Date |
Defined in
packages/agents/src/interfaces/workflow-validator.ts:233
resetStats
▸ resetStats(): void
Reset validator statistics
Returns
void