CommandDefinition

KIT · interface · Type contract

Declarative command shape before compilation.

Import

TypeScript

import type { CommandDefinition } from '@jangts/agent-core/kits/interaction';

JavaScript

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

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

Definition

interface CommandDefinition<Value, Result, Args>

Type parameters

Type parameter	Constraint	Default type
Value	object	—
Result	—	Value
Args	unknown[]	[]

Field structure

Field	Type	Required	Description
category	InteractionCategory | undefined	Optional	Read-only. Declared purpose; validated against the frozen category list.
version	number | undefined	Optional	Read-only. Protocol version, used to reject incompatible registrations.
description	string | undefined	Optional	Read-only. See the type definition and usage context.
terminal	boolean | undefined	Optional	Read-only. Marks a command that ends the interaction.
discriminator	{ readonly field: string; readonly value: string; } | undefined	Optional	Read-only. Constant field identifying the command; its value is forced to the command id.
fields	readonly string[] | Readonly<Record<string, ProtocolField>>	Required	Read-only. Field declarations by name, or an ordered list of field names.
ownedFields	readonly string[] | undefined	Optional	Read-only. Fields the program writes; may name fields not declared in fields.
additionalProperties	boolean | undefined	Optional	Read-only. Whether fields outside the declaration are rejected; defaults to the compiler policy.
optionalPresence	"own" | "defined" | undefined	Optional	Read-only. 'defined' rejects an explicitly undefined optional property; 'own' preserves its presence.
modes	readonly string[] | undefined	Optional	Read-only. App-declared modes in which the command is available.
error	ProtocolReason<Value, Args> | undefined	Optional	Read-only. Rejection wording for the command as a whole.
tags	readonly string[] | undefined	Optional	Read-only. Diagnostic tags attached to rejections from this command.
checks	readonly ProtocolCheck<Value, Args>[] | undefined	Optional	Read-only. Declarative rejection rules, evaluated in order after the structural checks.
refine	((value: Value, ...args: Args) => void) | undefined	Optional	Read-only. Domain checks/bindings only; invoked after structural and declarative checks.
format	((value: Value, ...args: Args) => Result) | undefined	Optional	Read-only. Formats the validated value into the command result.

Examples

• Interaction: declare commands and bind local handlers: The fields, purpose, selector, checks, and handler of a command come from one declaration; the model cannot add executable handlers.

First define one explanatory command and validate it

Beginner · Node.js

TypeScript

import { Interaction } from '@jangts/agent-core/kits/interaction';
const protocol = Interaction.define({
  commandField: 'type', commands: {
    reply: { category: 'presentation', description: '展示已确认说明', fields: { text: { required: true, jsonSchema: { type: 'string' } } },
      checks: [{ occur: value => typeof value.text !== 'string', error: 'text 必须是字符串' }] },
  },
});
console.log(protocol.receive({ type: 'reply', text: '普通对象也能实现接口。' }));
console.log(protocol.modelJsonSchema);

JavaScript

import { Interaction } from '@jangts/agent-core/kits/interaction';
const protocol = Interaction.define({
    commandField: 'type', commands: {
        reply: { category: 'presentation', description: '展示已确认说明', fields: { text: { required: true, jsonSchema: { type: 'string' } } },
            checks: [{ occur: value => typeof value.text !== 'string', error: 'text 必须是字符串' }] },
    },
});
console.log(protocol.receive({ type: 'reply', text: '普通对象也能实现接口。' }));
console.log(protocol.modelJsonSchema);

Keep the same protocol and add complete handler binding

Configuration · Node.js

TypeScript

import { Interaction } from '@jangts/agent-core/kits/interaction';
const protocol = Interaction.define({
  commandField: 'type', commands: {
    reply: { category: 'presentation', description: '展示已确认说明', fields: { text: { required: true, jsonSchema: { type: 'string' } } }, checks: [{ occur: value => typeof value.text !== 'string', error: 'text 必须是字符串' }] },
    unavailable: { category: 'receipt', description: '说明资料不可用', fields: {} },
  },
});
const dispatcher = Interaction.bind(protocol, {
  reply: value => '说明：' + String(value.text),
  unavailable: () => '资料暂不可用',
});
console.log(dispatcher.dispatch({ type: 'reply', text: '普通对象也能实现接口。' }, undefined));
console.log(dispatcher.catalog);

JavaScript

import { Interaction } from '@jangts/agent-core/kits/interaction';
const protocol = Interaction.define({
    commandField: 'type', commands: {
        reply: { category: 'presentation', description: '展示已确认说明', fields: { text: { required: true, jsonSchema: { type: 'string' } } }, checks: [{ occur: value => typeof value.text !== 'string', error: 'text 必须是字符串' }] },
        unavailable: { category: 'receipt', description: '说明资料不可用', fields: {} },
    },
});
const dispatcher = Interaction.bind(protocol, {
    reply: value => '说明：' + String(value.text),
    unavailable: () => '资料暂不可用',
});
console.log(dispatcher.dispatch({ type: 'reply', text: '普通对象也能实现接口。' }, undefined));
console.log(dispatcher.catalog);

Related policy source

• Fields, checks, and the model Schema
• Selectors and command receiving
• Bind local handlers by validated command

Related definitions

• InteractionCategory
• ProtocolCheck
• ProtocolField
• ProtocolReason