Skip to content

agent-core / Exports / IWorkflowConverter

Interface: IWorkflowConverter<TInput, TOutput>

Workflow Converter Interface

Core interface for converting between different workflow representations. All workflow converters must implement this interface.

Type parameters

NameTypeDescription
TInputextends IWorkflowDataInput workflow data type
TOutputextends IWorkflowDataOutput workflow data type

Table of contents

Properties

Methods

Properties

name

Readonly name: string

Converter name for identification

Defined in

packages/agent-core/src/interfaces/workflow-converter.ts:161


version

Readonly version: string

Converter version

Defined in

packages/agent-core/src/interfaces/workflow-converter.ts:164


sourceFormat

Readonly sourceFormat: string

Source format that this converter accepts

Defined in

packages/agent-core/src/interfaces/workflow-converter.ts:167


targetFormat

Readonly targetFormat: string

Target format that this converter produces

Defined in

packages/agent-core/src/interfaces/workflow-converter.ts:170

Methods

convert

convert(input, options?): Promise<IWorkflowConversionResult<TOutput>>

Convert workflow data from input format to output format

Parameters

NameTypeDescription
inputTInputInput workflow data
options?IWorkflowConversionOptionsConversion options

Returns

Promise<IWorkflowConversionResult<TOutput>>

Promise resolving to conversion result

Defined in

packages/agent-core/src/interfaces/workflow-converter.ts:179


validateInput

validateInput(input): Promise<{ isValid: boolean ; errors: string[] ; warnings: string[] }>

Validate input data before conversion

Parameters

NameTypeDescription
inputTInputInput workflow data

Returns

Promise<{ isValid: boolean ; errors: string[] ; warnings: string[] }>

Promise resolving to validation result

Defined in

packages/agent-core/src/interfaces/workflow-converter.ts:190


validateOutput

validateOutput(output): Promise<{ isValid: boolean ; errors: string[] ; warnings: string[] }>

Validate output data after conversion

Parameters

NameTypeDescription
outputTOutputOutput workflow data

Returns

Promise<{ isValid: boolean ; errors: string[] ; warnings: string[] }>

Promise resolving to validation result

Defined in

packages/agent-core/src/interfaces/workflow-converter.ts:202


canConvert

canConvert(input): input is TInput

Check if this converter supports the given input format

Parameters

NameTypeDescription
inputIWorkflowDataInput data to check

Returns

input is TInput

True if converter can handle this input

Defined in

packages/agent-core/src/interfaces/workflow-converter.ts:214


getStats

getStats(): Object

Get conversion statistics and metrics

Returns

Object

Converter performance metrics

NameType
totalConversionsnumber
successfulConversionsnumber
failedConversionsnumber
averageProcessingTimenumber
lastConversionAt?Date

Defined in

packages/agent-core/src/interfaces/workflow-converter.ts:221


resetStats

resetStats(): void

Reset converter statistics

Returns

void

Defined in

packages/agent-core/src/interfaces/workflow-converter.ts:232

Released under the MIT License.