Policies

KIT · constant · Runtime value

Import

TypeScript

import { Policies } from '@jangts/agent-core/kits/policies';

JavaScript

import { Policies } from '@jangts/agent-core/kits/policies';

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

Definition

Member index

Member	Purpose
definePolicySet	See the overload below for full inputs and outputs.
defineRecoveryChain	See the overload below for full inputs and outputs.

Member details

definePolicySet

Policies.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 parameter	Constraint	Default type
Input	—	—
Kind	string	—

Parameter	Type	Passing	Description
definitions	readonly 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

Field	Type	Required	Description
assess	(input: Input) => { required: boolean; reasons: string[]; kinds: Kind[]; }	Required	See the type definition and usage context.
definitions	readonly Readonly<PolicyDefinition<Input, Kind>>[]	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<PolicyDefinition<Input, Kind>>>	Required	See the type definition and usage context.
entries	() => IterableIterator<readonly [string, Readonly<PolicyDefinition<Input, Kind>>]>	Required	See the type definition and usage context.
has	(id: string) => boolean	Required	See the type definition and usage context.
get	(id: string) => Readonly<PolicyDefinition<Input, Kind>> | undefined	Required	Returns the definition or undefined; the caller decides whether absence is an error.
require	(id: string) => Readonly<PolicyDefinition<Input, Kind>>	Required	Returns the definition or throws; use when the id is a required reference.

defineRecoveryChain

Policies.defineRecoveryChain<Input, Result>(definitions: readonly RecoveryDefinition<Input, Result>[]): Readonly<{ tryRecover: (input: Input, execution?: Partial<import("../structs/common.js").ExecutionContext>) => RecoveryResult<Result>; definitions: readonly Readonly<{ id: string; description: string; tryRecover(input: Input): RecoveryResult<Result>; }>[]; ids(): readonly string[]; values(): IterableIterator<Readonly<{ id: string; description: string; tryRecover(input: Input): RecoveryResult<Result>; }>>; entries(): IterableIterator<readonly [string, Readonly<{ id: string; description: string; tryRecover(input: Input): RecoveryResult<Result>; }>]>; has(id: string): boolean; get(id: string): Readonly<{ id: string; description: string; tryRecover(input: Input): RecoveryResult<Result>; }> | undefined; require(id: string): Readonly<{ id: string; description: string; tryRecover(input: Input): RecoveryResult<Result>; }>; }>

Compile an ordered recovery chain.

A handler reports whether it handled the input; handled undefined values remain explicit. The first handler that reports handled ends the walk, so declaration order is the precedence, and { handled: false } is the only way to fall through.

Type parameter	Constraint	Default type
Input	—	—
Result	—	—

Parameter	Type	Passing	Description
definitions	readonly RecoveryDefinition<Input, Result>[]	Required	—

Returns: Readonly<{ tryRecover: (input: Input, execution?: Partial<import("../structs/common.js").ExecutionContext>) => RecoveryResult<Result>; definitions: readonly Readonly<{ id: string; description: string; tryRecover(input: Input): RecoveryResult<Result>; }>[]; ids(): readonly string[]; values(): IterableIterator<Readonly<{ id: string; description: string; tryRecover(input: Input): RecoveryResult<Result>; }>>; entries(): IterableIterator<readonly [string, Readonly<{ id: string; description: string; tryRecover(input: Input): RecoveryResult<Result>; }>]>; has(id: string): boolean; get(id: string): Readonly<{ id: string; description: string; tryRecover(input: Input): RecoveryResult<Result>; }> \| undefined; require(id: string): Readonly<{ id: string; description: string; tryRecover(input: Input): RecoveryResult<Result>; }>; }>.

Return value structure

Field	Type	Required	Description
tryRecover	(input: Input, execution?: Partial<import("../structs/common.js").ExecutionContext>) => RecoveryResult<Result>	Required	See the type definition and usage context.
definitions	readonly Readonly<{ id: string; description: string; tryRecover(input: Input): RecoveryResult<Result>; }>[]	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<{ id: string; description: string; tryRecover(input: Input): RecoveryResult<Result>; }>>	Required	See the type definition and usage context.
entries	() => IterableIterator<readonly [string, Readonly<{ id: string; description: string; tryRecover(input: Input): RecoveryResult<Result>; }>]>	Required	See the type definition and usage context.
has	(id: string) => boolean	Required	See the type definition and usage context.
get	(id: string) => Readonly<{ id: string; description: string; tryRecover(input: Input): RecoveryResult<Result>; }> | undefined	Required	Returns the definition or undefined; the caller decides whether absence is an error.
require	(id: string) => Readonly<{ id: string; description: string; tryRecover(input: Input): RecoveryResult<Result>; }>	Required	Returns the definition or throws; use when the id is a required reference.

Examples

• Policies: all matches and the first recovery: A policy set collects every matching reason; a recovery chain selects the first explicitly handled result in order.

Declare when the same reply must be reviewed

Beginner · Node.js

TypeScript

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

JavaScript

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

TypeScript

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

JavaScript

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

Related policy source

• All matches and the first handled result

Related definitions

• definePolicySet
• defineRecoveryChain
• PolicyDefinition
• RecoveryDefinition