defineCapabilityCatalog

SUPPORT · function · Runtime value

Build a frozen capability catalog from application module declarations.

Each module must carry a non-empty description, and every contributed tool ID must be unique across modules. Reference projections run during construction and must be synchronous.

Import

TypeScript

import { defineCapabilityCatalog } from '@jangts/agent-core/support';

JavaScript

import { defineCapabilityCatalog } from '@jangts/agent-core/support';

Other public entry points:@jangts/agent-core/support.

Definition

Type parameters

Type parameter	Constraint	Default type
Module	CapabilityModule	—

Call

defineCapabilityCatalog<Module extends CapabilityModule>(definitions: readonly Module[], options?: CapabilityCatalogOptions<Module>): Readonly<{ tools: readonly Module["tools"][number][]; findToolOwner(toolId: string): Readonly<Module> | undefined; definitions: readonly Readonly<Module>[]; ids(): readonly string[]; values(): IterableIterator<Readonly<Module>>; entries(): IterableIterator<readonly [string, Readonly<Module>]>; has(id: string): boolean; get(id: string): Readonly<Module> | undefined; require(id: string): Readonly<Module>; }>

Build a frozen capability catalog from application module declarations.

Each module must carry a non-empty description, and every contributed tool ID must be unique across modules. Reference projections run during construction and must be synchronous.

Type parameter	Constraint	Default type
Module	CapabilityModule	—

Parameter	Type	Passing	Description
definitions	readonly Module[]	Required	—
options	CapabilityCatalogOptions<Module>	Optional	—

Fields of options

Field	Type	Required	Description
toolReferences	((module: Readonly<Module>) => readonly CapabilityToolReferences[]) | undefined	Optional	Read-only. Projects a module's tool references; must be synchronous and is checked at construction.

Returns: Readonly<{ tools: readonly Module["tools"][number][]; findToolOwner(toolId: string): Readonly<Module> \| undefined; definitions: readonly Readonly<Module>[]; ids(): readonly string[]; values(): IterableIterator<Readonly<Module>>; entries(): IterableIterator<readonly [string, Readonly<Module>]>; has(id: string): boolean; get(id: string): Readonly<Module> \| undefined; require(id: string): Readonly<Module>; }>.

Return value structure

Field	Type	Required	Description
tools	readonly Module["tools"][number][]	Required	See the type definition and usage context.
findToolOwner	(toolId: string) => Readonly<Module> | undefined	Required	See the type definition and usage context.
definitions	readonly Readonly<Module>[]	Required	Read-only. Definitions in registration order; each entry is frozen by the implementation.
ids	() => readonly string[]	Required	Ids in the same order as definitions.
values	() => IterableIterator<Readonly<Module>>	Required	See the type definition and usage context.
entries	() => IterableIterator<readonly [string, Readonly<Module>]>	Required	See the type definition and usage context.
has	(id: string) => boolean	Required	See the type definition and usage context.
get	(id: string) => Readonly<Module> | undefined	Required	Returns the definition or undefined; the caller decides whether absence is an error.
require	(id: string) => Readonly<Module>	Required	Returns the definition or throws; use when the id is a required reference.

Examples

• Tool module composition and declarative installation: List modules, tool references, and registration order in one place; the generic loop consumes only that actual list.

Reuse existing module declarations directly

Beginner · Node.js

TypeScript

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);

JavaScript

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);

Add tool references and ordered installation

Configuration · Node.js

TypeScript

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);

JavaScript

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);

Related policy source

• Reference checks and same-source tool module composition
• Owner-to-tool relationship projection

Related definitions

• CapabilityCatalogOptions
• CapabilityModule