Skip to content
中文

definePolicySet ​

KIT · function · Runtime value

Compile a policy set that reports every matching reason.

Collect every matching reason; a configured mode cannot silently override a mandatory policy. assess returns the matched ids and deduplicated kinds rather than a single verdict, so callers keep the ordering information they need for messages and diagnostics.

Import ​

ts
import { definePolicySet } from '@jangts/agent-core/kits/policies';
js
import { definePolicySet } from '@jangts/agent-core/kits/policies';

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

Definition ​

Type parameters ​

Type parameterConstraintDefault type
Input——
Kindstring—

Call ​

ts
definePolicySet<Input, Kind extends string>(definitions: readonly PolicyDefinition<Input, Kind>[]): Readonly<{ assess(input: Input): { required: boolean; reasons: string[]; kinds: Kind[]; }; definitions: readonly Readonly<PolicyDefinition<Input, Kind>>[]; ids(): readonly string[]; values(): IterableIterator<Readonly<PolicyDefinition<Input, Kind>>>; entries(): IterableIterator<readonly [string, Readonly<PolicyDefinition<Input, Kind>>]>; has(id: string): boolean; get(id: string): Readonly<PolicyDefinition<Input, Kind>> | undefined; require(id: string): Readonly<PolicyDefinition<Input, Kind>>; }>

Compile a policy set that reports every matching reason.

Collect every matching reason; a configured mode cannot silently override a mandatory policy. assess returns the matched ids and deduplicated kinds rather than a single verdict, so callers keep the ordering information they need for messages and diagnostics.

Type parameterConstraintDefault type
Input——
Kindstring—
ParameterTypePassingDescription
definitionsreadonly PolicyDefinition<Input, Kind>[]Required—

Returns: Readonly<{ assess(input: Input): { required: boolean; reasons: string[]; kinds: Kind[]; }; definitions: readonly Readonly<PolicyDefinition<Input, Kind>>[]; ids(): readonly string[]; values(): IterableIterator<Readonly<PolicyDefinition<Input, Kind>>>; entries(): IterableIterator<readonly [string, Readonly<PolicyDefinition<Input, Kind>>]>; has(id: string): boolean; get(id: string): Readonly<PolicyDefinition<Input, Kind>> \| undefined; require(id: string): Readonly<PolicyDefinition<Input, Kind>>; }>.

Return value structure
FieldTypeRequiredDescription
assess(input: Input) => { required: boolean; reasons: string[]; kinds: Kind[]; }RequiredSee the type definition and usage context.
definitionsreadonly Readonly<PolicyDefinition<Input, Kind>>[]RequiredRead-only. Definitions in registration order; each entry is frozen by the implementation.
ids() => readonly string[]RequiredIds in the same order as definitions.
values() => IterableIterator<Readonly<PolicyDefinition<Input, Kind>>>RequiredSee the type definition and usage context.
entries() => IterableIterator<readonly [string, Readonly<PolicyDefinition<Input, Kind>>]>RequiredSee the type definition and usage context.
has(id: string) => booleanRequiredSee the type definition and usage context.
get(id: string) => Readonly<PolicyDefinition<Input, Kind>> | undefinedRequiredReturns the definition or undefined; the caller decides whether absence is an error.
require(id: string) => Readonly<PolicyDefinition<Input, Kind>>RequiredReturns the definition or throws; use when the id is a required reference.

Examples ​

Declare when the same reply must be reviewed ​

Beginner · Node.js

ts
import { Policies } from '@jangts/agent-core/kits/policies';
const policy = Policies.definePolicySet([
  { id: 'has-write', description: '有写操作就复核', kind: 'review', when: (input: { wrote: boolean }) => input.wrote },
]);
console.log(policy.assess({ wrote: true }));
js
import { Policies } from '@jangts/agent-core/kits/policies';
const policy = Policies.definePolicySet([
    { id: 'has-write', description: '有写操作就复核', kind: 'review', when: (input) => input.wrote },
]);
console.log(policy.assess({ wrote: true }));

Add another reason and ordered recovery ​

Configuration · Node.js

ts
import { Policies } from '@jangts/agent-core/kits/policies';
type Input = { wrote: boolean; uncertain: boolean; cancelled: boolean };
const policy = Policies.definePolicySet<Input, 'review'>([
  { id: 'has-write', description: '有写操作就复核', kind: 'review', when: input => input.wrote },
  { id: 'uncertain', description: '证据不确定就复核', kind: 'review', when: input => input.uncertain },
]);
const recovery = Policies.defineRecoveryChain<Input, string>([
  { id: 'cancelled', description: '取消时不发布答案', tryRecover: input => input.cancelled ? { handled: true, value: '任务已取消' } : { handled: false } },
  { id: 'needs-review', description: '未通过复核时明确说明', tryRecover: input => policy.assess(input).required ? { handled: true, value: '结果还需要复核' } : { handled: false } },
]);
const input = { wrote: true, uncertain: true, cancelled: false };
console.log(policy.assess(input), recovery.tryRecover(input));
js
import { Policies } from '@jangts/agent-core/kits/policies';
const policy = Policies.definePolicySet([
    { id: 'has-write', description: '有写操作就复核', kind: 'review', when: input => input.wrote },
    { id: 'uncertain', description: '证据不确定就复核', kind: 'review', when: input => input.uncertain },
]);
const recovery = Policies.defineRecoveryChain([
    { id: 'cancelled', description: '取消时不发布答案', tryRecover: input => input.cancelled ? { handled: true, value: '任务已取消' } : { handled: false } },
    { id: 'needs-review', description: '未通过复核时明确说明', tryRecover: input => policy.assess(input).required ? { handled: true, value: '结果还需要复核' } : { handled: false } },
]);
const input = { wrote: true, uncertain: true, cancelled: false };
console.log(policy.assess(input), recovery.tryRecover(input));

API reference, usage examples and developer guides.