Skip to content

agents / Exports / WorkflowConverterInterface

Interface: WorkflowConverterInterface<TInput, TOutput>

Workflow Converter Interface

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

Type parameters

NameTypeDescription
TInputextends WorkflowDataInput workflow data type
TOutputextends WorkflowDataOutput workflow data type

Implemented by

Table of contents

Properties

Methods

Properties

name

Readonly name: string

Converter name for identification

Defined in

packages/agents/src/interfaces/workflow-converter.ts:148


version

Readonly version: string

Converter version

Defined in

packages/agents/src/interfaces/workflow-converter.ts:151


sourceFormat

Readonly sourceFormat: string

Source format that this converter accepts

Defined in

packages/agents/src/interfaces/workflow-converter.ts:154


targetFormat

Readonly targetFormat: string

Target format that this converter produces

Defined in

packages/agents/src/interfaces/workflow-converter.ts:157

Methods

convert

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

Convert workflow data from input format to output format

Parameters

NameTypeDescription
inputTInputInput workflow data
options?WorkflowConversionOptionsConversion options

Returns

Promise<WorkflowConversionResult<TOutput>>

Promise resolving to conversion result

Defined in

packages/agents/src/interfaces/workflow-converter.ts:166


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/agents/src/interfaces/workflow-converter.ts:174


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/agents/src/interfaces/workflow-converter.ts:186


canConvert

canConvert(input): input is TInput

Check if this converter supports the given input format

Parameters

NameTypeDescription
inputWorkflowDataInput data to check

Returns

input is TInput

True if converter can handle this input

Defined in

packages/agents/src/interfaces/workflow-converter.ts:198


getStats

getStats(): Object

Get conversion statistics and metrics

Returns

Object

Converter performance metrics

NameType
totalConversionsnumber
successfulConversionsnumber
failedConversionsnumber
averageProcessingTimenumber
lastConversionAt?Date

Defined in

packages/agents/src/interfaces/workflow-converter.ts:205


resetStats

resetStats(): void

Reset converter statistics

Returns

void

Defined in

packages/agents/src/interfaces/workflow-converter.ts:216

Released under the MIT License.