SubFlowStepInput

CORE · interface · Type contract

Input accepted by write; the logger assigns the step id and sequence.

Import

TypeScript

import type { SubFlowStepInput } from '@jangts/agent-core/diagnostics';

JavaScript

/** @typedef {import('@jangts/agent-core/diagnostics').SubFlowStepInput} SubFlowStepInput */

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

Definition

interface SubFlowStepInput

Extends or implements: Omit<ReportedStep, 'stepId' \| 'kind'>.

Field structure

Field	Type	Required	Description
kind	string | undefined	Optional	Read-only. Optional family classification; defaults to the custom type when omitted.
payload	Readonly<Record<string, SubFlowValue>> | undefined	Optional	Read-only. See the type definition and usage context.
subnodeId	string | undefined	Optional	Read-only. Logical subnode grouping within this node visit; independent of individual log ids.
type	string | undefined	Optional	Read-only. App-defined business log type; never a write/fix operation enum.
parentStepId	string | undefined	Optional	Read-only. Reported parent step, forming a tree; absent for a top-level step.
relatedDefinitionId	string | undefined	Optional	Read-only. Self-reported reference only; never a workflow dispatch identity.
relatedInvocationId	string | undefined	Optional	Read-only. Real model/tool invocation identity, kept separate from the node-local subnode id.
name	string	Required	Read-only. Short reported label.
status	"error" | "success" | "unknown" | "planned" | "running" | "cancelled" | "skipped" | undefined	Optional	Read-only. Reported lifecycle status; omission means the node did not report one.
usedModel	boolean | undefined	Optional	Read-only. This step's own reported model use, never a descendant rollup.
startedAtMs	number | undefined	Optional	Read-only. Reported start instant in epoch milliseconds.
endedAtMs	number | undefined	Optional	Read-only. Reported end instant in epoch milliseconds; only meaningful for terminal statuses.
nextStepIds	readonly string[] | undefined	Optional	Read-only. Reported successor step ids, for display only.
caseId	string | undefined	Optional	Read-only. Reported case or variant id, interpreted by the App.
summary	string | undefined	Optional	Read-only. Reported one-line summary.

Examples

• Process observation and node reports: The App subscribes to Core execution facts; nodes report their own usedModel and use an instance sub-logger to record intent first and then results, while the Loop owns identity and logging.

Observe the nodes and model events a task passes through

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 agent = new AgentCoreEngine({ workflow, execution: {
  observe: { event(event) { console.log(event.type, event.eventId); } },
} });
console.log(await agent.run({ name: 'Ivan' }));

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 agent = new AgentCoreEngine({ workflow, execution: {
        observe: { event(event) { console.log(event.type, event.eventId); } },
    } });
console.log(await agent.run({ name: 'Ivan' }));

Report a business stage while the node executes

Configuration · Node.js

The node only reports facts it knows; Core owns node identity and execution association.

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, context) {
    context.report({ payload: { phase: 'formatting' } });
    return { answer: '你好，' + state.name };
  }, routes: [route.deliver('answer')],
}] });
const agent = new AgentCoreEngine({ workflow, execution: {
  observe: { event(event) { console.log(event.type); } },
} });
console.log(await agent.run({ name: 'Ivan' }));

JavaScript

import { AgentCoreEngine, defineWorkflow, route } from '@jangts/agent-core/engine';
const workflow = defineWorkflow({ id: 'greeting', nodes: [{
            id: 'greet', description: '生成问候', startsRound: true,
            run(state, context) {
                context.report({ payload: { phase: 'formatting' } });
                return { answer: '你好，' + state.name };
            }, routes: [route.deliver('answer')],
        }] });
const agent = new AgentCoreEngine({ workflow, execution: {
        observe: { event(event) { console.log(event.type); } },
    } });
console.log(await agent.run({ name: 'Ivan' }));

Related policy source

• Shared execution fact source and consumption isolation
• Sub-step statuses and their progression

Related definitions

• ReportedStep
• SubFlowValue