LifecycleHooks

KIT · interface · 类型合同

Everything one tool declares for a request.

Declaring id turns the tool into an invocation owner, so protocol and call become required in practice; the registry rejects a partial declaration. Every other hook is optional and returning nothing expresses "no opinion".

导入

TypeScript

import type { LifecycleHooks } from '@jangts/agent-core/kits/tools';

JavaScript

/** @typedef {import('@jangts/agent-core/kits/tools').LifecycleHooks} LifecycleHooks */

其他公开入口：@jangts/agent-core、@jangts/agent-core/types、@jangts/agent-core/structs、@jangts/agent-core/kits/tools、@jangts/agent-core/kits。

定义

interface LifecycleHooks<Types, Protocol>

泛型参数

类型参数	约束	默认类型
Types	ToolRuntimeTypes	—
Protocol	LifecycleProtocol	LifecycleProtocol

字段结构

字段	类型	必需	说明
id	string | undefined	可省略	Invocation id this tool owns; must be unique across registered tools.
protocol	Protocol | undefined	可省略	Output protocol of the invocation.
call	((value: unknown, context: Types["context"], execution: ToolExecutionContext) => void) | undefined	可省略	Executes the invocation. Must be synchronous and return nothing.
authorize	((decision: Types["decision"], context: Types["context"]) => void) | undefined	可省略	Permission check for the decision; runs before execution.
resume	((decision: Types["decision"], context: Types["context"]) => boolean) | undefined	可省略	Returns true when this invocation is a valid continuation of the decision.
complete	((decision: Types["decision"], context: Types["context"]) => Types["decision"] | undefined) | undefined	可省略	Normalizes the decision after the invocation; returning undefined keeps it unchanged.
inspect	((decision: Types["decision"], context: Types["context"]) => void) | undefined	可省略	Observes the decision before any invocation runs.
finalize	((decision: Types["decision"], context: Types["context"], phase: Types["phase"]) => void) | undefined	可省略	Runs finalization for one phase.
rules	((context: Types["context"]) => { order: number; text: string; }[]) | undefined	可省略	Extra rules contributed to the model context, ordered by order.
modelFields	((context: Types["context"], placement: Types["placement"]) => ToolModelField<Types["placement"]>[]) | undefined	可省略	Model-context fields for one placement, ordered by order.
visibleText	((text: string, context: Types["context"]) => string) | undefined	可省略	Rewrites visible text produced by this tool.
reviewDraft	((draft: unknown, context: Types["context"]) => unknown) | undefined	可省略	Reviews a draft before delivery.
composition	((context: Types["context"]) => Types["composition"] | undefined) | undefined	可省略	Builds the tool's composition value for the current context.
recoveryContext	((context: Types["context"]) => unknown) | undefined	可省略	Extra context used when recovering a previous attempt.
projectContext	((context: unknown) => unknown) | undefined	可省略	Projects the stored context before it is shown or persisted.
missingInteractionAllowed	((decision: Types["decision"], context: Types["context"]) => boolean) | undefined	可省略	Returns true when an absent interaction is acceptable in this phase.
supportsGoal	((goalId: string, context: Types["context"]) => boolean | undefined) | undefined	可省略	Vetoes a goal by returning false; silence (undefined) means support.

使用示例

• 装饰器：处理类与已有实例方法：类装饰代办定义实例化，方法装饰绑定原对象；输出仍走原 define、构造和 bind。

类拥有配置与私有辅助方法，不手写 new

入门 · TypeScript 标准装饰器

TypeScript

import { AgentCoreEngine, defineWorkflow } from '@jangts/agent-core';
import type { WorkflowNode } from '@jangts/agent-core';
import { node, nodePool } from '@jangts/agent-core/support/decorators';
import type { Node } from '@jangts/agent-core/support/decorators';
type State = { text: string; answer?: string };
@node<State, string>('greet', { ns: 'greeting' })
class Greeting implements Node<State, string> {
  readonly description = '生成问候';
  readonly routes = [{ complete: (state: Readonly<State>) => state.answer! }];
  #prefix = '你好，';
  run(state: Readonly<State>) { return { answer: this._format(state.text) }; }
  private _format(text: string) { return this.#prefix + text.trim(); }
}
const flow = defineWorkflow<State, string>({ id: 'greeting', nodes: nodePool.getAll('greeting') });
console.log(await new AgentCoreEngine({ workflow: flow }).run({ text: '访客' }));

JavaScript

var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
    return c > 3 && r && Object.defineProperty(target, key, r), r;
};
import { AgentCoreEngine, defineWorkflow } from '@jangts/agent-core';
import { node, nodePool } from '@jangts/agent-core/support/decorators';
let Greeting = class Greeting {
    description = '生成问候';
    routes = [{ complete: (state) => state.answer }];
    #prefix = '你好，';
    run(state) { return { answer: this._format(state.text) }; }
    _format(text) { return this.#prefix + text.trim(); }
};
Greeting = __decorate([
    node('greet', { ns: 'greeting' })
], Greeting);
const flow = defineWorkflow({ id: 'greeting', nodes: nodePool.getAll('greeting') });
console.log(await new AgentCoreEngine({ workflow: flow }).run({ text: '访客' }));

保留服务方法名，自动绑定原对象

配置 · TypeScript 标准装饰器

TypeScript

import type { WorkflowNode } from '@jangts/agent-core';
import { node, nodePool } from '@jangts/agent-core/support/decorators';
type State = { text: string; answer?: string };
class GreetingService {
  constructor(private readonly prefix: string) {}
  @node<State, string>('reply', { ns: 'service',
    description: '调用现有服务',
    routes: [{ complete: (state: Readonly<State>) => state.answer! }],
  })
  answer(state: Readonly<State>) { return { answer: this.prefix + state.text }; }
}
const service = new GreetingService('你好，');
const definition = nodePool.get<WorkflowNode<State, string>>('reply', 'service')!;
console.log(definition === nodePool.get('reply', 'service'));

JavaScript

var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
    return c > 3 && r && Object.defineProperty(target, key, r), r;
};
import { node, nodePool } from '@jangts/agent-core/support/decorators';
class GreetingService {
    prefix;
    constructor(prefix) {
        this.prefix = prefix;
    }
    answer(state) { return { answer: this.prefix + state.text }; }
}
__decorate([
    node('reply', { ns: 'service',
        description: '调用现有服务',
        routes: [{ complete: (state) => state.answer }],
    })
], GreetingService.prototype, "answer", null);
const service = new GreetingService('你好，');
const definition = nodePool.get('reply', 'service');
console.log(definition === nodePool.get('reply', 'service'));

相关定义

• LifecycleProtocol
• ToolExecutionContext
• ToolModelField
• ToolRuntimeTypes