WorkflowExtension

CORE · interface · Type contract

Additional nodes and routes merged into an existing definition.

Import

TypeScript

import type { WorkflowExtension } from '@jangts/agent-core/engine';

JavaScript

/** @typedef {import('@jangts/agent-core/engine').WorkflowExtension} WorkflowExtension */

Other public entry points:@jangts/agent-core, @jangts/agent-core/engine, @jangts/agent-core/types, @jangts/agent-core/structs.

Definition

interface WorkflowExtension<State, Result, App>

Type parameters

Type parameter	Constraint	Default type
State	—	—
Result	—	—
App	—	—

Field structure

Field	Type	Required	Description
nodes	readonly WorkflowNode<State, Result, App>[]	Required	Read-only. Nodes appended to the definition; ids must not collide with existing nodes.
routes	Readonly<Record<string, readonly WorkflowRoute<State, Result, App>[]>> | undefined	Optional	Read-only. Replacement route lists keyed by node id; other nodes keep their declared routes.
revision	string | undefined	Optional	Read-only. Extension revision, recorded so mixed definitions remain auditable.

Examples

• Reusing a base Workflow and Agent branches: add preserves the old Workflow and produces a new combined Workflow; fork inherits existing bindings and the branch origin.

A base Workflow produces a new version

Beginner · Node.js

TypeScript

import { AgentCoreEngine, defineWorkflow, route } from '@jangts/agent-core/engine';

type State = { name: string; answer?: string };
const workflow = defineWorkflow<State, string>({
  id: 'greeting',
  nodes: [{
    id: 'greet', description: '根据本次姓名生成问候', startsRound: true,
    run: state => ({ answer: '你好，' + state.name }),
    routes: [route.deliver('answer')],
  }],
});
const extended = workflow.add({
  nodes: [{ id: 'format', description: '为现有回答增加结尾',
    run: state => ({ answer: state.answer + '！' }), routes: [route.deliver('answer')] }],
  routes: { greet: [route.to('format')] },
});
console.log(await new AgentCoreEngine({ workflow: extended }).run({ name: 'Ivan' }));
console.log(workflow.ids()); // 基础定义仍然只有 greet

JavaScript

import { AgentCoreEngine, defineWorkflow, route } from '@jangts/agent-core/engine';
const workflow = defineWorkflow({
    id: 'greeting',
    nodes: [{
            id: 'greet', description: '根据本次姓名生成问候', startsRound: true,
            run: state => ({ answer: '你好，' + state.name }),
            routes: [route.deliver('answer')],
        }],
});
const extended = workflow.add({
    nodes: [{ id: 'format', description: '为现有回答增加结尾',
            run: state => ({ answer: state.answer + '！' }), routes: [route.deliver('answer')] }],
    routes: { greet: [route.to('format')] },
});
console.log(await new AgentCoreEngine({ workflow: extended }).run({ name: 'Ivan' }));
console.log(workflow.ids()); // 基础定义仍然只有 greet

Inherit the base Agent bindings and branch origin

Configuration · Node.js

TypeScript

import { AgentCoreEngine, defineWorkflow, route } from '@jangts/agent-core/engine';

type State = { name: string; answer?: string };
const workflow = defineWorkflow<State, string>({
  id: 'greeting',
  nodes: [{
    id: 'greet', description: '根据本次姓名生成问候', startsRound: true,
    run: state => ({ answer: '你好，' + state.name }),
    routes: [route.deliver('answer')],
  }],
});
const base = new AgentCoreEngine({ workflow });
const checkpoint = base.checkpoint({ name: 'Ivan' });
const branch = base.fork({ at: checkpoint });
console.log(await branch.run(checkpoint.read()));
console.log(branch.branch.parentBranchId === base.branch.branchId);

JavaScript

import { AgentCoreEngine, defineWorkflow, route } from '@jangts/agent-core/engine';
const workflow = defineWorkflow({
    id: 'greeting',
    nodes: [{
            id: 'greet', description: '根据本次姓名生成问候', startsRound: true,
            run: state => ({ answer: '你好，' + state.name }),
            routes: [route.deliver('answer')],
        }],
});
const base = new AgentCoreEngine({ workflow });
const checkpoint = base.checkpoint({ name: 'Ivan' });
const branch = base.fork({ at: checkpoint });
console.log(await branch.run(checkpoint.read()));
console.log(branch.branch.parentBranchId === base.branch.branchId);

Related policy source

• Execution implementation of the bounded loop, commit, and cancellation

Related definitions

• WorkflowNode
• WorkflowRoute