defineAssociatedCatalog
SUPPORT · function · 运行时值
Compile independent and owner-derived Tool declarations, validating all references eagerly.
导入
import { defineAssociatedCatalog } from '@jangts/agent-core/support';import { defineAssociatedCatalog } from '@jangts/agent-core/support';其他公开入口:@jangts/agent-core/support。
定义
泛型参数
| 类型参数 | 约束 | 默认类型 |
|---|---|---|
Entry | AssociatedRegistration | — |
调用
defineAssociatedCatalog<Entry extends AssociatedRegistration>(entries: readonly Entry[], options?: AssociationOptions<Entry>): Readonly<{ tools: ModelToolCatalog<any>; bindings: ReadonlyCatalog<{ id: Entry["id"]; toolIds: readonly string[]; }>; sources: ReadonlyCatalog<{ id: string; sources: readonly Readonly<{ toolIds: readonly string[]; kind: "standalone" | "registration"; id: string; description: string; }>[]; }>; definitions: readonly Readonly<Entry>[]; ids(): readonly string[]; values(): IterableIterator<Readonly<Entry>>; entries(): IterableIterator<readonly [string, Readonly<Entry>]>; has(id: string): boolean; get(id: string): Readonly<Entry> | undefined; require(id: string): Readonly<Entry>; }>Compile independent and owner-derived Tool declarations, validating all references eagerly.
| 类型参数 | 约束 | 默认类型 |
|---|---|---|
Entry | AssociatedRegistration | — |
| 参数 | 类型 | 传递 | 说明 |
|---|---|---|---|
entries | readonly Entry[] | 必需 | — |
options | AssociationOptions<Entry> | 可省略 | — |
options 的字段
| 字段 | 类型 | 必需 | 说明 |
|---|---|---|---|
tools | readonly ModelToolRegistration[] | undefined | 可省略 | 只读。见类型定义及调用场景。 |
toolDefaults | ((entry: Readonly<Entry>) => ModelToolRegistration | undefined) | undefined | 可省略 | 只读。见类型定义及调用场景。 |
返回: Readonly<{ tools: ModelToolCatalog<any>; bindings: ReadonlyCatalog<{ id: Entry["id"]; toolIds: readonly string[]; }>; sources: ReadonlyCatalog<{ id: string; sources: readonly Readonly<{ toolIds: readonly string[]; kind: "standalone" \| "registration"; id: string; description: string; }>[]; }>; definitions: readonly Readonly<Entry>[]; ids(): readonly string[]; values(): IterableIterator<Readonly<Entry>>; entries(): IterableIterator<readonly [string, Readonly<Entry>]>; has(id: string): boolean; get(id: string): Readonly<Entry> \| undefined; require(id: string): Readonly<Entry>; }>。
返回值结构
| 字段 | 类型 | 必需 | 说明 |
|---|---|---|---|
tools | ModelToolCatalog<any> | 必需 | 见类型定义及调用场景。 |
bindings | ReadonlyCatalog<{ id: Entry["id"]; toolIds: readonly string[]; }> | 必需 | 见类型定义及调用场景。 |
sources | ReadonlyCatalog<{ id: string; sources: readonly Readonly<{ toolIds: readonly string[]; kind: "standalone" | "registration"; id: string; description: string; }>[]; }> | 必需 | 见类型定义及调用场景。 |
definitions | readonly Readonly<Entry>[] | 必需 | 只读。Definitions in registration order; each entry is frozen by the implementation. |
ids | () => readonly string[] | 必需 | Ids in the same order as definitions. |
values | () => IterableIterator<Readonly<Entry>> | 必需 | 见类型定义及调用场景。 |
entries | () => IterableIterator<readonly [string, Readonly<Entry>]> | 必需 | 见类型定义及调用场景。 |
has | (id: string) => boolean | 必需 | 见类型定义及调用场景。 |
get | (id: string) => Readonly<Entry> | undefined | 必需 | Returns the definition or undefined; the caller decides whether absence is an error. |
require | (id: string) => Readonly<Entry> | 必需 | Returns the definition or throws; use when the id is a required reference. |
使用示例
- 能力组合与声明式安装:集中列出模块、工具引用和注册顺序;通用循环只消费这份实际清单。
直接复用现有模块声明
入门 · Node.js
import { Support } from '@jangts/agent-core';
const modules = [{ id: 'service', description: '服务查询能力', tools: [{ id: 'get_status' }] }];
const catalog = Support.defineCapabilityCatalog(modules);
console.log(catalog.ids(), catalog.findToolOwner('get_status')?.id);import { Support } from '@jangts/agent-core';
const modules = [{ id: 'service', description: '服务查询能力', tools: [{ id: 'get_status' }] }];
const catalog = Support.defineCapabilityCatalog(modules);
console.log(catalog.ids(), catalog.findToolOwner('get_status')?.id);增加工具引用和有序安装
配置 · Node.js
import { Support } from '@jangts/agent-core';
const modules = [{ id: 'service', description: '服务查询', tools: [{ id: 'get_status' }],
references: [{ id: 'status-skill', requiredToolIds: ['get_status'], optionalToolIds: [] }] }];
const moduleCatalog = Support.defineCapabilityCatalog(modules, { toolReferences: module => module.references });
const registration = Support.defineRegistrationCatalog<{ installed: string[] }>([
{ id: 'service', register: app => { app.installed.push(moduleCatalog.require('service').id); } },
{ id: 'status-view', when: app => app.installed.includes('service'), register: app => { app.installed.push('status-view'); } },
]);
const app = { installed: [] as string[] };
registration.install(app);
console.log(app.installed);import { Support } from '@jangts/agent-core';
const modules = [{ id: 'service', description: '服务查询', tools: [{ id: 'get_status' }],
references: [{ id: 'status-skill', requiredToolIds: ['get_status'], optionalToolIds: [] }] }];
const moduleCatalog = Support.defineCapabilityCatalog(modules, { toolReferences: module => module.references });
const registration = Support.defineRegistrationCatalog([
{ id: 'service', register: app => { app.installed.push(moduleCatalog.require('service').id); } },
{ id: 'status-view', when: app => app.installed.includes('service'), register: app => { app.installed.push('status-view'); } },
]);
const app = { installed: [] };
registration.install(app);
console.log(app.installed);