agents / Exports / BaseWorkflowConverter
Class: BaseWorkflowConverter<TInput, TOutput>
Base Workflow Converter Abstract Class
Provides common functionality for all workflow converters:
- Statistics tracking
- Logging with dependency injection
- Error handling and validation
- Performance monitoring
- Enable/disable functionality
Type parameters
| Name | Type | Description |
|---|---|---|
TInput | extends WorkflowData | Input workflow data type |
TOutput | extends WorkflowData | Output workflow data type |
Hierarchy
BaseWorkflowConverter
Implements
WorkflowConverterInterface<TInput,TOutput>
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new BaseWorkflowConverter<TInput, TOutput>(options?): BaseWorkflowConverter<TInput, TOutput>
Constructor following BaseModule pattern
Type parameters
| Name | Type |
|---|---|
TInput | extends WorkflowData |
TOutput | extends WorkflowData |
Parameters
| Name | Type | Description |
|---|---|---|
options | BaseWorkflowConverterOptions | Converter configuration options |
Returns
BaseWorkflowConverter<TInput, TOutput>
Defined in
packages/agents/src/abstracts/base-workflow-converter.ts:89
Properties
name
• Readonly Abstract name: string
Converter name for identification
Implementation of
WorkflowConverterInterface.name
Defined in
packages/agents/src/abstracts/base-workflow-converter.ts:62
version
• Readonly Abstract version: string
Converter version
Implementation of
WorkflowConverterInterface.version
Defined in
packages/agents/src/abstracts/base-workflow-converter.ts:63
sourceFormat
• Readonly Abstract sourceFormat: string
Source format that this converter accepts
Implementation of
WorkflowConverterInterface.sourceFormat
Defined in
packages/agents/src/abstracts/base-workflow-converter.ts:64
targetFormat
• Readonly Abstract targetFormat: string
Target format that this converter produces
Implementation of
WorkflowConverterInterface.targetFormat
Defined in
packages/agents/src/abstracts/base-workflow-converter.ts:65
enabled
• enabled: boolean
Enable/disable state following BaseModule pattern
Defined in
packages/agents/src/abstracts/base-workflow-converter.ts:68
Methods
convert
▸ convert(input, options?): Promise<WorkflowConversionResult<TOutput>>
Main conversion method with comprehensive error handling and metrics
Parameters
| Name | Type | Description |
|---|---|---|
input | TInput | Input workflow data |
options | WorkflowConversionOptions | Conversion options |
Returns
Promise<WorkflowConversionResult<TOutput>>
Promise resolving to conversion result
Implementation of
WorkflowConverterInterface.convert
Defined in
packages/agents/src/abstracts/base-workflow-converter.ts:106
validateInput
▸ validateInput(input): Promise<{ isValid: boolean ; errors: string[] ; warnings: string[] }>
Default input validation (can be overridden by subclasses)
Parameters
| Name | Type | Description |
|---|---|---|
input | TInput | Input workflow data |
Returns
Promise<{ isValid: boolean ; errors: string[] ; warnings: string[] }>
Promise resolving to validation result
Implementation of
WorkflowConverterInterface.validateInput
Defined in
packages/agents/src/abstracts/base-workflow-converter.ts:204
validateOutput
▸ validateOutput(output): Promise<{ isValid: boolean ; errors: string[] ; warnings: string[] }>
Default output validation (can be overridden by subclasses)
Parameters
| Name | Type | Description |
|---|---|---|
output | TOutput | Output workflow data |
Returns
Promise<{ isValid: boolean ; errors: string[] ; warnings: string[] }>
Promise resolving to validation result
Implementation of
WorkflowConverterInterface.validateOutput
Defined in
packages/agents/src/abstracts/base-workflow-converter.ts:232
canConvert
▸ canConvert(input): input is TInput
Default implementation for checking if converter can handle input Should be overridden by subclasses for specific type checking
Parameters
| Name | Type | Description |
|---|---|---|
input | WorkflowData | Input data to check |
Returns
input is TInput
True if converter can handle this input
Implementation of
WorkflowConverterInterface.canConvert
Defined in
packages/agents/src/abstracts/base-workflow-converter.ts:261
getStats
▸ getStats(): Object
Get converter statistics
Returns
Object
Converter performance metrics
| Name | Type |
|---|---|
totalConversions | number |
successfulConversions | number |
failedConversions | number |
averageProcessingTime | number |
lastConversionAt | undefined | Date |
Implementation of
WorkflowConverterInterface.getStats
Defined in
packages/agents/src/abstracts/base-workflow-converter.ts:271
resetStats
▸ resetStats(): void
Reset converter statistics
Returns
void
Implementation of
WorkflowConverterInterface.resetStats
Defined in
packages/agents/src/abstracts/base-workflow-converter.ts:286