@codesoul-co/hypha-kernel / index

• Package index: @codesoul-co/hypha-kernel
• Source: packages/kernel/src/index.ts
• Exports: 85

Using this module

Aggregates the public entrypoint exports for @codesoul-co/hypha-kernel; applications import these symbols from the package entrypoint instead of internal file paths.

Import from the package entrypoint

import {
  BasicReActAgentRuntime,
  DefaultAgenticReasoner,
  DefaultContextBuilder,
  DefaultThinkingPlanner,
  DefaultVerifier,
  InMemoryReActContinuationCheckpointStore,
  MemoryContextBuilder,
  ReActAgentRunner,
} from '@codesoul-co/hypha-kernel';

import type {
  AgenticReasoner,
  AgenticReasonerInput,
  AgenticReasoningDecision,
  BasicReActAgentRuntimeOptions,
  BuiltAgentContext,
  ContextBudget,
  ContextBuilder,
  ContextBuildInput,
} from '@codesoul-co/hypha-kernel';

// The complete export list is documented below.

Usage patterns

• Use the 44 type/interface exports as static contracts in application code, adapters, or tests. Import them with import type; they do not exist at runtime.
• The module exposes 12 classes as constructable runtime implementations. Each symbol entry lists its constructor and public methods.
• The module exposes 8 functions as direct operation entrypoints. Every overload, required/optional parameter, and return type is documented below.
• The 21 constant/enum exports provide stable values, schemas, definitions, or defaults. Reuse these exports instead of copying internal values into an application.

Runtime validation example

import { agenticReasoningModeSchema } from '@codesoul-co/hypha-kernel';

declare function loadExternalInput(): unknown;
const input: unknown = loadExternalInput();
const parsed = agenticReasoningModeSchema.parse(input);

Parse untrusted configuration, network, or persisted input with the runtime schema before passing it to functions or classes that expect a validated contract.

Public exports

Symbol	Kind	Signature	Description
BasicReActAgentRuntime	class	new BasicReActAgentRuntime(options?: BasicReActAgentRuntimeOptions): BasicReActAgentRuntime	Basic ReAct Agent Runtime class with 4 public constructor or member entries; its exact declarations are listed below.
DefaultAgenticReasoner	class	new DefaultAgenticReasoner(now?: () => string): DefaultAgenticReasoner	Default Agentic Reasoner class with 2 public constructor or member entries; its exact declarations are listed below.
DefaultContextBuilder	class	new DefaultContextBuilder(): DefaultContextBuilder	Default Context Builder class with 2 public constructor or member entries; its exact declarations are listed below.
DefaultThinkingPlanner	class	new DefaultThinkingPlanner(now?: () => string): DefaultThinkingPlanner	Default Thinking Planner class with 2 public constructor or member entries; its exact declarations are listed below.
DefaultVerifier	class	new DefaultVerifier(): DefaultVerifier	Default Verifier class with 2 public constructor or member entries; its exact declarations are listed below.
InMemoryReActContinuationCheckpointStore	class	new InMemoryReActContinuationCheckpointStore(options?: InMemoryReActContinuationCheckpointStoreOptions): InMemoryReActContinuationCheckpointStore	In Memory ReAct Continuation Checkpoint Store class with 4 public constructor or member entries; its exact declarations are listed below.
MemoryContextBuilder	class	new MemoryContextBuilder(options: MemoryContextBuilderOptions): MemoryContextBuilder	Memory Context Builder class with 2 public constructor or member entries; its exact declarations are listed below.
ReActAgentRunner	class	new ReActAgentRunner(options: ReActAgentRunnerOptions): ReActAgentRunner	ReAct Agent Runner class with 2 public constructor or member entries; its exact declarations are listed below.
ReActRunner	class	new ReActRunner(runtime: ReActAgentRuntime, options: ReActRunnerOptions): ReActRunner	ReAct Runner class with 2 public constructor or member entries; its exact declarations are listed below.
ReasoningContextBuilder	class	new ReasoningContextBuilder(options?: ReasoningContextBuilderOptions): ReasoningContextBuilder	Reasoning Context Builder class with 2 public constructor or member entries; its exact declarations are listed below.
SkillContextBuilder	class	new SkillContextBuilder(options: SkillContextBuilderOptions): SkillContextBuilder	Skill Context Builder class with 2 public constructor or member entries; its exact declarations are listed below.
ToolRunnerActivityAdapter	class	new ToolRunnerActivityAdapter(runner: ToolRunner): ToolRunnerActivityAdapter	Tool Runner Activity Adapter class with 3 public constructor or member entries; its exact declarations are listed below.
agenticReasoningModeSchema	constant	const agenticReasoningModeSchema: z.ZodEnum<["react", "fsm_react", "tot", "critique"]>	Runtime schema for Agentic Reasoning Mode.
kernelSpecDefinitions	constant	const kernelSpecDefinitions: readonly [SpecSchemaDefinition<ReActAgentSpec>, SpecSchemaDefinition<ReasoningConfig>]	Kernel Spec Definitions constant exported by the index module.
kernelSpecJsonSchemas	constant	const kernelSpecJsonSchemas: Record<string, JsonSchema>	Kernel Spec JSON Schemas constant exported by the index module.
REACT_PHASE_ORDER	constant	const REACT_PHASE_ORDER: ReActPhase[]	REACT PHASE ORDER constant exported by the index module.
REACT_SUSPENSION_REASONS	constant	const REACT_SUSPENSION_REASONS: readonly ["quantum_exhausted", "iteration_budget_exhausted", "model_call_budget_exhausted", "tool_call_budget_exhausted", "token_budget_exhausted", "non_progress", "deadline_exceeded"]	REACT SUSPENSION REASONS constant exported by the index module.
reActActionSchema	constant	const reActActionSchema: z.ZodEffects<z.ZodObject<{ type: z.ZodEnum<["tool", "model", "finish", "human_review"]>; toolCallId: z.ZodOptional<z.ZodString>; target: z.ZodOptional<z.ZodString>; input: z.ZodOptional<z.ZodEffects<z.ZodUnknown, unknown, unknown>>; reason: z.ZodOptional<z.ZodString>; }, "strict", z.ZodTypeAny, { type: "human_review" | "tool" | "model" | "finish"; reason?: string | undefined; toolCallId?: ...	Runtime schema for Re Act Action.
reactAgentSpecDefinition	constant	const reactAgentSpecDefinition: SpecSchemaDefinition<ReActAgentSpec>	Runtime validation entrypoint for the React Agent spec, combining its parser, example and JSON Schema.
reactAgentSpecExample	constant	const reactAgentSpecExample: ReActAgentSpec	Valid example value for React Agent Spec.
reactAgentSpecJsonSchema	constant	const reactAgentSpecJsonSchema: JsonSchema	JSON Schema for React Agent Spec.
reactAgentSpecSchema	constant	const reactAgentSpecSchema: z.ZodObject<{ id: z.ZodString; version: z.ZodString; description: z.ZodOptional<z.ZodString>; owner: z.ZodOptional<z.ZodString>; tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; createdAt: z.ZodOptional<z.ZodString>; updatedAt: z.ZodOptional<z.ZodString>; } & { name: z.ZodString; modelAlias: z.ZodString; systemInstructions: z.ZodOptional<z.ZodString>; promptRefs: z.ZodOptional<z.Zo...	Runtime schema for React Agent Spec.
reActContinuationCheckpointJsonSchema	constant	const reActContinuationCheckpointJsonSchema: JsonSchema	JSON Schema for Re Act Continuation Checkpoint.
reActContinuationCheckpointSchema	constant	const reActContinuationCheckpointSchema: z.ZodEffects<z.ZodObject<{ version: z.ZodLiteral<"1.0.0">; runId: z.ZodString; stepId: z.ZodString; scopeHash: z.ZodString; agentRef: z.ZodObject<{ id: z.ZodString; version: z.ZodString; }, "strict", z.ZodTypeAny, { version: string; id: string; }, { version: string; id: string; }>; nextPhase: z.ZodEnum<["reason", "act"]>; messages: z.ZodArray<z.ZodObject<{ role: z.ZodEnum<[...	Runtime schema for Re Act Continuation Checkpoint.
reActExecutionBudgetJsonSchema	constant	const reActExecutionBudgetJsonSchema: JsonSchema	JSON Schema for Re Act Execution Budget.
reActExecutionBudgetSchema	constant	const reActExecutionBudgetSchema: z.ZodObject<{ maxIterations: z.ZodNumber; maxModelCalls: z.ZodNumber; maxToolCalls: z.ZodNumber; maxTotalTokens: z.ZodOptional<z.ZodNumber>; maxConsecutiveNoProgress: z.ZodNumber; quantumIterations: z.ZodNumber; deadlineAt: z.ZodOptional<z.ZodString>; }, "strict", z.ZodTypeAny, { maxIterations: number; maxModelCalls: number; maxToolCalls: number; maxConsecutiveNoProgress: number; ...	Runtime schema for Re Act Execution Budget.
reactPhaseSchema	constant	const reactPhaseSchema: z.ZodEnum<["observe", "reason", "select_action", "policy_check", "act", "observe_result", "verify", "memory_sync", "complete", "fail", "human_review", "suspend", "cancel"]>	Runtime schema for React Phase.
reasoningConfigExample	constant	const reasoningConfigExample: ReasoningConfig	Valid example value for Reasoning Config.
reasoningConfigJsonSchema	constant	const reasoningConfigJsonSchema: JsonSchema	JSON Schema for Reasoning Config.
reasoningConfigSchema	constant	const reasoningConfigSchema: z.ZodObject<{ thinkingMode: z.ZodOptional<z.ZodEnum<["none", "summary", "structured"]>>; agenticMode: z.ZodOptional<z.ZodEnum<["react", "fsm_react", "tot", "critique"]>>; maxSteps: z.ZodOptional<z.ZodNumber>; persist: z.ZodOptional<z.ZodEnum<["summary_only", "events_only"]>>; plannerRef: z.ZodOptional<z.ZodString>; reasonerRef: z.ZodOptional<z.ZodString>; metadata: z.ZodOptional<z.ZodR...	Runtime schema for Reasoning Config.
reasoningConfigSpecDefinition	constant	const reasoningConfigSpecDefinition: SpecSchemaDefinition<ReasoningConfig>	Runtime validation entrypoint for the Reasoning Config spec, combining its parser, example and JSON Schema.
reasoningPersistenceSchema	constant	const reasoningPersistenceSchema: z.ZodEnum<["summary_only", "events_only"]>	Runtime schema for Reasoning Persistence.
thinkingModeSchema	constant	const thinkingModeSchema: z.ZodEnum<["none", "summary", "structured"]>	Runtime schema for Thinking Mode.
createEpisodicMemorySync	function	createEpisodicMemorySync(options: EpisodicMemorySyncOptions): NonNullable<ReActRunnerOptions["syncMemory"]>	Create Episodic Memory Sync function with 1 public call signature; parameters and return types are listed below.
createReActStep	function	createReActStep(id: string, phase: ReActPhase, input?: unknown): ReActStep	Create ReAct Step function with 1 public call signature; parameters and return types are listed below.
reActContinuationScopeHash	function	reActContinuationScopeHash(context: ReActRunContext): string	Re Act Continuation Scope Hash function with 1 public call signature; parameters and return types are listed below.
validateReActAction	function	validateReActAction(input: unknown): ReActAction	Validate ReAct Action function with 1 public call signature; parameters and return types are listed below.
validateReActAgentSpec	function	validateReActAgentSpec(input: unknown): ReActAgentSpec	Validate ReAct Agent Spec function with 1 public call signature; parameters and return types are listed below.
validateReActContinuationCheckpoint	function	validateReActContinuationCheckpoint(input: unknown): ReActContinuationCheckpoint	Validate ReAct Continuation Checkpoint function with 1 public call signature; parameters and return types are listed below.
validateReActExecutionBudget	function	validateReActExecutionBudget(input: unknown): ReActExecutionBudget	Validate ReAct Execution Budget function with 1 public call signature; parameters and return types are listed below.
validateReasoningConfig	function	validateReasoningConfig(input: unknown): ReasoningConfig	Validate Reasoning Config function with 1 public call signature; parameters and return types are listed below.
AgenticReasoner	interface	interface AgenticReasoner	Agentic Reasoner interface with 1 public fields or methods.
AgenticReasonerInput	interface	interface AgenticReasonerInput	Agentic Reasoner Input interface with 3 public fields or methods.
AgenticReasoningDecision	interface	interface AgenticReasoningDecision	Agentic Reasoning Decision interface with 11 public fields or methods.
BasicReActAgentRuntimeOptions	interface	interface BasicReActAgentRuntimeOptions	Basic ReAct Agent Runtime Options interface with 1 public fields or methods.
BuiltAgentContext	interface	interface BuiltAgentContext extends ReActRunContext	Built Agent Context interface with 18 public fields or methods.
ContextBudget	interface	interface ContextBudget	Context Budget interface with 4 public fields or methods.
ContextBuilder	interface	interface ContextBuilder	Context Builder interface with 1 public fields or methods.
ContextBuildInput	interface	interface ContextBuildInput	Context Build Input interface with 12 public fields or methods.
ContextProvenance	interface	interface ContextProvenance	Context Provenance interface with 6 public fields or methods.
EpisodicMemorySyncOptions	interface	interface EpisodicMemorySyncOptions	Episodic Memory Sync Options interface with 7 public fields or methods.
InMemoryReActContinuationCheckpointStoreOptions	interface	interface InMemoryReActContinuationCheckpointStoreOptions	In Memory ReAct Continuation Checkpoint Store Options interface with 3 public fields or methods.
MemoryContextBuilderOptions	interface	interface MemoryContextBuilderOptions	Memory Context Builder Options interface with 7 public fields or methods.
MemoryContextItem	interface	interface MemoryContextItem	Memory Context Item interface with 5 public fields or methods.
ReActAction	interface	interface ReActAction	ReAct Action interface with 5 public fields or methods.
ReActAgentRunnerOptions	interface	interface ReActAgentRunnerOptions extends Omit<ReActRunnerOptions, 'toolRunner'>	ReAct Agent Runner Options interface with 25 public fields or methods.
ReActAgentRuntime	interface	interface ReActAgentRuntime	ReAct Agent Runtime interface with 3 public fields or methods.
ReActAgentSpec	interface	interface ReActAgentSpec extends VersionedSpec, SpecMetadata	ReAct Agent Spec interface with 17 public fields or methods.
ReActContinuationCheckpoint	interface	interface ReActContinuationCheckpoint	ReAct Continuation Checkpoint interface with 19 public fields or methods.
ReActContinuationCheckpointPutResult	interface	interface ReActContinuationCheckpointPutResult	ReAct Continuation Checkpoint Put Result interface with 2 public fields or methods.
ReActContinuationCheckpointStore	interface	interface ReActContinuationCheckpointStore	ReAct Continuation Checkpoint Store interface with 3 public fields or methods.
ReActExecutionBudget	interface	interface ReActExecutionBudget	Global limits survive process restarts through ReActContinuationCheckpoint. quantumIterations only bounds one worker turn; it is not a new total budget.
ReActObservation	interface	interface ReActObservation	ReAct Observation interface with 3 public fields or methods.
ReActRunContext	interface	interface ReActRunContext	ReAct Run Context interface with 14 public fields or methods.
ReActRunControl	interface	interface ReActRunControl	ReAct Run Control interface with 4 public fields or methods.
ReActRunnerOptions	interface	interface ReActRunnerOptions	ReAct Runner Options interface with 13 public fields or methods.
ReActRunResult	interface	interface ReActRunResult	ReAct Run Result interface with 8 public fields or methods.
ReActStep	interface	interface ReActStep	ReAct Step interface with 5 public fields or methods.
ReActSuspension	interface	interface ReActSuspension	ReAct Suspension interface with 4 public fields or methods.
ReasoningConfig	interface	interface ReasoningConfig	Reasoning Config interface with 7 public fields or methods.
ReasoningContextBuilderOptions	interface	interface ReasoningContextBuilderOptions	Reasoning Context Builder Options interface with 5 public fields or methods.
RequiredReasoningConfig	interface	interface RequiredReasoningConfig extends Required<Omit<ReasoningConfig, 'plannerRef' | 'reasonerRef' | 'metadata'>>	Required Reasoning Config interface with 7 public fields or methods.
SkillContextBuilderOptions	interface	interface SkillContextBuilderOptions	Skill Context Builder Options interface with 9 public fields or methods.
ThinkingPlan	interface	interface ThinkingPlan	Thinking Plan interface with 10 public fields or methods.
ThinkingPlanner	interface	interface ThinkingPlanner	Thinking Planner interface with 1 public fields or methods.
ThinkingPlannerInput	interface	interface ThinkingPlannerInput	Thinking Planner Input interface with 2 public fields or methods.
ToolActivityPort	interface	interface ToolActivityPort	Tool Activity Port interface with 2 public fields or methods.
ToolActivityRequest	interface	interface ToolActivityRequest	Tool Activity Request interface with 10 public fields or methods.
ToolActivityResult	interface	interface ToolActivityResult	Tool Activity Result interface with 7 public fields or methods.
Verifier	interface	interface Verifier	Verifier interface with 1 public fields or methods.
AgenticReasoningMode	type	type AgenticReasoningMode = 'react' | 'fsm_react' | 'tot' | 'critique'	Public type alias for Agentic Reasoning Mode; the declaration contains its complete type expression.
ReActPhase	type	type ReActPhase = 'observe' | 'reason' | 'select_action' | 'policy_check' | 'act' | 'observe_result' | 'verify' | 'memory_sync' | 'complete' | 'fail' | 'human_review' | 'suspend' | 'cancel'	Public type alias for ReAct Phase; the declaration contains its complete type expression.
ReActSuspensionReason	type	type ReActSuspensionReason = (typeof REACT_SUSPENSION_REASONS)[number]	Public type alias for ReAct Suspension Reason; the declaration contains its complete type expression.
ReasoningPersistence	type	type ReasoningPersistence = 'summary_only' | 'events_only'	Public type alias for Reasoning Persistence; the declaration contains its complete type expression.
ThinkingMode	type	type ThinkingMode = 'none' | 'summary' | 'structured'	Public type alias for Thinking Mode; the declaration contains its complete type expression.

BasicReActAgentRuntime

Basic ReAct Agent Runtime class with 4 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { BasicReActAgentRuntime } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export declare class BasicReActAgentRuntime implements ReActAgentRuntime {
    constructor(options?: BasicReActAgentRuntimeOptions);
    reason(context: ReActRunContext): Promise<InferenceRequest>;
    selectAction(response: InferenceResponse): Promise<ReActAction>;
    verify(context: ReActRunContext, observation: ReActObservation): Promise<ReActAction>;
}

Public members

Member	Kind	Signature	Description
constructor	constructor	(options?: BasicReActAgentRuntimeOptions): BasicReActAgentRuntime	Creates an instance of this class.
reason	method	reason(context: ReActRunContext): Promise<InferenceRequest>	Public method; parameters and return type are shown in the signature.
selectAction	method	selectAction(response: InferenceResponse): Promise<ReActAction>	Public method; parameters and return type are shown in the signature.
verify	method	verify(context: ReActRunContext, observation: ReActObservation): Promise<ReActAction>	Public method; parameters and return type are shown in the signature.

DefaultAgenticReasoner

Default Agentic Reasoner class with 2 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { DefaultAgenticReasoner } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export declare class DefaultAgenticReasoner implements AgenticReasoner {
    constructor(now?: () => string);
    decide(input: AgenticReasonerInput): Promise<AgenticReasoningDecision>;
}

Public members

Member	Kind	Signature	Description
constructor	constructor	(now?: () => string): DefaultAgenticReasoner	Creates an instance of this class.
decide	method	decide(input: AgenticReasonerInput): Promise<AgenticReasoningDecision>	Public method; parameters and return type are shown in the signature.

DefaultContextBuilder

Default Context Builder class with 2 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { DefaultContextBuilder } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export declare class DefaultContextBuilder implements ContextBuilder {
    build(input: ContextBuildInput): Promise<BuiltAgentContext>;
}

Public members

Member	Kind	Signature	Description
build	method	build(input: ContextBuildInput): Promise<BuiltAgentContext>	Public method; parameters and return type are shown in the signature.
constructor	constructor	(): DefaultContextBuilder	Creates an instance of this class.

DefaultThinkingPlanner

Default Thinking Planner class with 2 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { DefaultThinkingPlanner } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export declare class DefaultThinkingPlanner implements ThinkingPlanner {
    constructor(now?: () => string);
    plan(input: ThinkingPlannerInput): Promise<ThinkingPlan>;
}

Public members

Member	Kind	Signature	Description
constructor	constructor	(now?: () => string): DefaultThinkingPlanner	Creates an instance of this class.
plan	method	plan(input: ThinkingPlannerInput): Promise<ThinkingPlan>	Public method; parameters and return type are shown in the signature.

DefaultVerifier

Default Verifier class with 2 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { DefaultVerifier } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export declare class DefaultVerifier implements Verifier {
    verify(_context: ReActRunContext, observation: ReActObservation): Promise<ReActAction>;
}

Public members

Member	Kind	Signature	Description
constructor	constructor	(): DefaultVerifier	Creates an instance of this class.
verify	method	verify(_context: ReActRunContext, observation: ReActObservation): Promise<ReActAction>	Public method; parameters and return type are shown in the signature.

InMemoryReActContinuationCheckpointStore

In Memory ReAct Continuation Checkpoint Store class with 4 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { InMemoryReActContinuationCheckpointStore } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export declare class InMemoryReActContinuationCheckpointStore implements ReActContinuationCheckpointStore {
    constructor(options?: InMemoryReActContinuationCheckpointStoreOptions);
    put(input: ReActContinuationCheckpoint, idempotencyKey: string): Promise<ReActContinuationCheckpointPutResult>;
    get(runId: string, stepId: string, expectedScopeHash: string): Promise<ReActContinuationCheckpoint | null>;
    delete(runId: string, stepId: string, expectedScopeHash: string, expectedStepSequence?: number): Promise<boolean>;
}

Public members

Member	Kind	Signature	Description
constructor	constructor	(options?: InMemoryReActContinuationCheckpointStoreOptions): InMemoryReActContinuationCheckpointStore	Creates an instance of this class.
delete	method	delete(runId: string, stepId: string, expectedScopeHash: string, expectedStepSequence?: number): Promise<boolean>	Public method; parameters and return type are shown in the signature.
get	method	get(runId: string, stepId: string, expectedScopeHash: string): Promise<ReActContinuationCheckpoint | null>	Public method; parameters and return type are shown in the signature.
put	method	put(input: ReActContinuationCheckpoint, idempotencyKey: string): Promise<ReActContinuationCheckpointPutResult>	Public method; parameters and return type are shown in the signature.

MemoryContextBuilder

Memory Context Builder class with 2 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { MemoryContextBuilder } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export declare class MemoryContextBuilder implements ContextBuilder {
    constructor(options: MemoryContextBuilderOptions);
    build(input: ContextBuildInput): Promise<BuiltAgentContext>;
}

Public members

Member	Kind	Signature	Description
build	method	build(input: ContextBuildInput): Promise<BuiltAgentContext>	Public method; parameters and return type are shown in the signature.
constructor	constructor	(options: MemoryContextBuilderOptions): MemoryContextBuilder	Creates an instance of this class.

ReActAgentRunner

ReAct Agent Runner class with 2 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { ReActAgentRunner } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export declare class ReActAgentRunner {
    constructor(options: ReActAgentRunnerOptions);
    run(input: ContextBuildInput, control?: ReActRunControl): Promise<ReActRunResult>;
}

Public members

Member	Kind	Signature	Description
constructor	constructor	(options: ReActAgentRunnerOptions): ReActAgentRunner	Creates an instance of this class.
run	method	run(input: ContextBuildInput, control?: ReActRunControl): Promise<ReActRunResult>	Public method; parameters and return type are shown in the signature.

ReActRunner

ReAct Runner class with 2 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { ReActRunner } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export declare class ReActRunner {
    constructor(runtime: ReActAgentRuntime, options: ReActRunnerOptions);
    run(context: ReActRunContext, control?: ReActRunControl): Promise<ReActRunResult>;
}

Public members

Member	Kind	Signature	Description
constructor	constructor	(runtime: ReActAgentRuntime, options: ReActRunnerOptions): ReActRunner	Creates an instance of this class.
run	method	run(context: ReActRunContext, control?: ReActRunControl): Promise<ReActRunResult>	Public method; parameters and return type are shown in the signature.

ReasoningContextBuilder

Reasoning Context Builder class with 2 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { ReasoningContextBuilder } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export declare class ReasoningContextBuilder implements ContextBuilder {
    constructor(options?: ReasoningContextBuilderOptions);
    build(input: ContextBuildInput): Promise<BuiltAgentContext>;
}

Public members

Member	Kind	Signature	Description
build	method	build(input: ContextBuildInput): Promise<BuiltAgentContext>	Public method; parameters and return type are shown in the signature.
constructor	constructor	(options?: ReasoningContextBuilderOptions): ReasoningContextBuilder	Creates an instance of this class.

SkillContextBuilder

Skill Context Builder class with 2 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { SkillContextBuilder } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export declare class SkillContextBuilder implements ContextBuilder {
    constructor(options: SkillContextBuilderOptions);
    build(input: ContextBuildInput): Promise<BuiltAgentContext>;
}

Public members

Member	Kind	Signature	Description
build	method	build(input: ContextBuildInput): Promise<BuiltAgentContext>	Public method; parameters and return type are shown in the signature.
constructor	constructor	(options: SkillContextBuilderOptions): SkillContextBuilder	Creates an instance of this class.

ToolRunnerActivityAdapter

Tool Runner Activity Adapter class with 3 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { ToolRunnerActivityAdapter } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export declare class ToolRunnerActivityAdapter implements ToolActivityPort {
    constructor(runner: ToolRunner);
    execute(request: ToolActivityRequest): Promise<ToolActivityResult>;
    cancel(invocationId: string, reason?: string): Promise<ToolActivityResult | null>;
}

Public members

Member	Kind	Signature	Description
cancel	method	cancel(invocationId: string, reason?: string): Promise<ToolActivityResult | null>	Public method; parameters and return type are shown in the signature.
constructor	constructor	(runner: ToolRunner): ToolRunnerActivityAdapter	Creates an instance of this class.
execute	method	execute(request: ToolActivityRequest): Promise<ToolActivityResult>	Public method; parameters and return type are shown in the signature.

agenticReasoningModeSchema

Runtime schema for Agentic Reasoning Mode.

• Kind: constant
• Import: import { agenticReasoningModeSchema } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export declare const agenticReasoningModeSchema: z.ZodEnum<["react", "fsm_react", "tot", "critique"]>;

kernelSpecDefinitions

Kernel Spec Definitions constant exported by the index module.

• Kind: constant
• Import: import { kernelSpecDefinitions } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export declare const kernelSpecDefinitions: readonly [SpecSchemaDefinition<ReActAgentSpec>, SpecSchemaDefinition<ReasoningConfig>];

kernelSpecJsonSchemas

Kernel Spec JSON Schemas constant exported by the index module.

• Kind: constant
• Import: import { kernelSpecJsonSchemas } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export declare const kernelSpecJsonSchemas: Record<string, JsonSchema>;

REACT_PHASE_ORDER

REACT PHASE ORDER constant exported by the index module.

• Kind: constant
• Import: import { REACT_PHASE_ORDER } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export declare const REACT_PHASE_ORDER: ReActPhase[];

REACT_SUSPENSION_REASONS

REACT SUSPENSION REASONS constant exported by the index module.

• Kind: constant
• Import: import { REACT_SUSPENSION_REASONS } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export declare const REACT_SUSPENSION_REASONS: readonly ["quantum_exhausted", "iteration_budget_exhausted", "model_call_budget_exhausted", "tool_call_budget_exhausted", "token_budget_exhausted", "non_progress", "deadline_exceeded"];

reActActionSchema

Runtime schema for Re Act Action.

• Kind: constant
• Import: import { reActActionSchema } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export declare const reActActionSchema: z.ZodEffects<z.ZodObject<{ type: z.ZodEnum<["tool", "model", "finish", "human_review"]>; toolCallId: z.ZodOptional<z.ZodString>; target: z.ZodOptional<z.ZodString>; input: z.ZodOptional<z.ZodEffects<z.ZodUnknown, unknown, unknown>>; reason: z.ZodOptional<z.ZodString>; }, "strict", z.ZodTypeAny, { type: "human_review" | "tool" | "model" | "finish"; reason?: string | undefined; toolCallId?: string | undefined; target?: string | undefined; input?: unknown; }, { type: "human_review" | "tool" | "model" | "finish"; reason?: string | undefined; toolCallId?: string | undefined; target?: string | undefined; input?: unknown; }>, { type: "human_review" | "tool" | "model" | "finish"; reason?: string | undefined; toolCallId?: string | undefined; target?: string | undefined; input?: unknown; }, { type: "human_review" | "tool" | "model" | "finish"; reason?: string | undefined; toolCallId?: string | undefined; target?: string | undefined; input?: unknown; }>;

reactAgentSpecDefinition

Runtime validation entrypoint for the React Agent spec, combining its parser, example and JSON Schema.

• Kind: constant
• Import: import { reactAgentSpecDefinition } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export declare const reactAgentSpecDefinition: SpecSchemaDefinition<ReActAgentSpec>;

reactAgentSpecExample

Valid example value for React Agent Spec.

• Kind: constant
• Import: import { reactAgentSpecExample } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export declare const reactAgentSpecExample: ReActAgentSpec;

reactAgentSpecJsonSchema

JSON Schema for React Agent Spec.

• Kind: constant
• Import: import { reactAgentSpecJsonSchema } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export declare const reactAgentSpecJsonSchema: JsonSchema;

reactAgentSpecSchema

Runtime schema for React Agent Spec.

• Kind: constant
• Import: import { reactAgentSpecSchema } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

// Exact type resolved from the package entrypoint; see source for the compiler expansion.
export declare const reactAgentSpecSchema: (typeof import('@codesoul-co/hypha-kernel'))['reactAgentSpecSchema'];

This compiler-expanded constant type is compacted. Its public name, top-level type, and source location remain here; use the module’s exported interfaces, types, or runtime schema for input/output fields.

reActContinuationCheckpointJsonSchema

JSON Schema for Re Act Continuation Checkpoint.

• Kind: constant
• Import: import { reActContinuationCheckpointJsonSchema } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export declare const reActContinuationCheckpointJsonSchema: JsonSchema;

reActContinuationCheckpointSchema

Runtime schema for Re Act Continuation Checkpoint.

• Kind: constant
• Import: import { reActContinuationCheckpointSchema } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

// Exact type resolved from the package entrypoint; see source for the compiler expansion.
export declare const reActContinuationCheckpointSchema: (typeof import('@codesoul-co/hypha-kernel'))['reActContinuationCheckpointSchema'];

This compiler-expanded constant type is compacted. Its public name, top-level type, and source location remain here; use the module’s exported interfaces, types, or runtime schema for input/output fields.

reActExecutionBudgetJsonSchema

JSON Schema for Re Act Execution Budget.

• Kind: constant
• Import: import { reActExecutionBudgetJsonSchema } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export declare const reActExecutionBudgetJsonSchema: JsonSchema;

reActExecutionBudgetSchema

Runtime schema for Re Act Execution Budget.

• Kind: constant
• Import: import { reActExecutionBudgetSchema } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export declare const reActExecutionBudgetSchema: z.ZodObject<{ maxIterations: z.ZodNumber; maxModelCalls: z.ZodNumber; maxToolCalls: z.ZodNumber; maxTotalTokens: z.ZodOptional<z.ZodNumber>; maxConsecutiveNoProgress: z.ZodNumber; quantumIterations: z.ZodNumber; deadlineAt: z.ZodOptional<z.ZodString>; }, "strict", z.ZodTypeAny, { maxIterations: number; maxModelCalls: number; maxToolCalls: number; maxConsecutiveNoProgress: number; quantumIterations: number; maxTotalTokens?: number | undefined; deadlineAt?: string | undefined; }, { maxIterations: number; maxModelCalls: number; maxToolCalls: number; maxConsecutiveNoProgress: number; quantumIterations: number; maxTotalTokens?: number | undefined; deadlineAt?: string | undefined; }>;

reactPhaseSchema

Runtime schema for React Phase.

• Kind: constant
• Import: import { reactPhaseSchema } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export declare const reactPhaseSchema: z.ZodEnum<["observe", "reason", "select_action", "policy_check", "act", "observe_result", "verify", "memory_sync", "complete", "fail", "human_review", "suspend", "cancel"]>;

reasoningConfigExample

Valid example value for Reasoning Config.

• Kind: constant
• Import: import { reasoningConfigExample } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export declare const reasoningConfigExample: ReasoningConfig;

reasoningConfigJsonSchema

JSON Schema for Reasoning Config.

• Kind: constant
• Import: import { reasoningConfigJsonSchema } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export declare const reasoningConfigJsonSchema: JsonSchema;

reasoningConfigSchema

Runtime schema for Reasoning Config.

• Kind: constant
• Import: import { reasoningConfigSchema } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export declare const reasoningConfigSchema: z.ZodObject<{ thinkingMode: z.ZodOptional<z.ZodEnum<["none", "summary", "structured"]>>; agenticMode: z.ZodOptional<z.ZodEnum<["react", "fsm_react", "tot", "critique"]>>; maxSteps: z.ZodOptional<z.ZodNumber>; persist: z.ZodOptional<z.ZodEnum<["summary_only", "events_only"]>>; plannerRef: z.ZodOptional<z.ZodString>; reasonerRef: z.ZodOptional<z.ZodString>; metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>; }, "strip", z.ZodTypeAny, { thinkingMode?: "none" | "summary" | "structured" | undefined; agenticMode?: "react" | "fsm_react" | "tot" | "critique" | undefined; maxSteps?: number | undefined; persist?: "summary_only" | "events_only" | undefined; plannerRef?: string | undefined; reasonerRef?: string | undefined; metadata?: Record<string, unknown> | undefined; }, { thinkingMode?: "none" | "summary" | "structured" | undefined; agenticMode?: "react" | "fsm_react" | "tot" | "critique" | undefined; maxSteps?: number | undefined; persist?: "summary_only" | "events_only" | undefined; plannerRef?: string | undefined; reasonerRef?: string | undefined; metadata?: Record<string, unknown> | undefined; }>;

reasoningConfigSpecDefinition

Runtime validation entrypoint for the Reasoning Config spec, combining its parser, example and JSON Schema.

• Kind: constant
• Import: import { reasoningConfigSpecDefinition } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export declare const reasoningConfigSpecDefinition: SpecSchemaDefinition<ReasoningConfig>;

reasoningPersistenceSchema

Runtime schema for Reasoning Persistence.

• Kind: constant
• Import: import { reasoningPersistenceSchema } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export declare const reasoningPersistenceSchema: z.ZodEnum<["summary_only", "events_only"]>;

thinkingModeSchema

Runtime schema for Thinking Mode.

• Kind: constant
• Import: import { thinkingModeSchema } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export declare const thinkingModeSchema: z.ZodEnum<["none", "summary", "structured"]>;

createEpisodicMemorySync

Create Episodic Memory Sync function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { createEpisodicMemorySync } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export declare function createEpisodicMemorySync(options: EpisodicMemorySyncOptions): NonNullable<ReActRunnerOptions['syncMemory']>;

Call signature

createEpisodicMemorySync(options: EpisodicMemorySyncOptions): NonNullable<ReActRunnerOptions["syncMemory"]>

Parameters

Parameter	Type	Required	Description
options	EpisodicMemorySyncOptions	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: (context: ReActRunContext, observation: ReActObservation) => Promise<void>
• Description: The return contract is defined by the type shown above.

createReActStep

Create ReAct Step function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { createReActStep } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export declare function createReActStep(id: string, phase: ReActPhase, input?: unknown): ReActStep;

Call signature

createReActStep(id: string, phase: ReActPhase, input?: unknown): ReActStep

Parameters

Parameter	Type	Required	Description
id	string	Yes	Required parameter; accepted values are defined by the type column.
phase	ReActPhase	Yes	Required parameter; accepted values are defined by the type column.
input	unknown	No	Optional parameter; accepted values are defined by the type column.

Returns

• Type: ReActStep
• Description: The return contract is defined by the type shown above.

reActContinuationScopeHash

Re Act Continuation Scope Hash function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { reActContinuationScopeHash } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export declare function reActContinuationScopeHash(context: ReActRunContext): string;

Call signature

reActContinuationScopeHash(context: ReActRunContext): string

Parameters

Parameter	Type	Required	Description
context	ReActRunContext	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: string
• Description: The return contract is defined by the type shown above.

validateReActAction

Validate ReAct Action function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateReActAction } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export declare function validateReActAction(input: unknown): ReActAction;

Call signature

validateReActAction(input: unknown): ReActAction

Parameters

Parameter	Type	Required	Description
input	unknown	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: ReActAction
• Description: The return contract is defined by the type shown above.

validateReActAgentSpec

Validate ReAct Agent Spec function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateReActAgentSpec } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export declare function validateReActAgentSpec(input: unknown): ReActAgentSpec;

Call signature

validateReActAgentSpec(input: unknown): ReActAgentSpec

Parameters

Parameter	Type	Required	Description
input	unknown	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: ReActAgentSpec
• Description: The return contract is defined by the type shown above.

validateReActContinuationCheckpoint

Validate ReAct Continuation Checkpoint function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateReActContinuationCheckpoint } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export declare function validateReActContinuationCheckpoint(input: unknown): ReActContinuationCheckpoint;

Call signature

validateReActContinuationCheckpoint(input: unknown): ReActContinuationCheckpoint

Parameters

Parameter	Type	Required	Description
input	unknown	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: ReActContinuationCheckpoint
• Description: The return contract is defined by the type shown above.

validateReActExecutionBudget

Validate ReAct Execution Budget function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateReActExecutionBudget } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export declare function validateReActExecutionBudget(input: unknown): ReActExecutionBudget;

Call signature

validateReActExecutionBudget(input: unknown): ReActExecutionBudget

Parameters

Parameter	Type	Required	Description
input	unknown	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: ReActExecutionBudget
• Description: The return contract is defined by the type shown above.

validateReasoningConfig

Validate Reasoning Config function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateReasoningConfig } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export declare function validateReasoningConfig(input: unknown): ReasoningConfig;

Call signature

validateReasoningConfig(input: unknown): ReasoningConfig

Parameters

Parameter	Type	Required	Description
input	unknown	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: ReasoningConfig
• Description: The return contract is defined by the type shown above.

AgenticReasoner

Agentic Reasoner interface with 1 public fields or methods.

• Kind: interface
• Import: import type { AgenticReasoner } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export interface AgenticReasoner {
    decide(input: AgenticReasonerInput): Promise<AgenticReasoningDecision>;
}

Contract members

Member	Kind	Signature	Description
decide	method	decide(input: AgenticReasonerInput): Promise<AgenticReasoningDecision>	Public method; parameters and return type are shown in the signature.

AgenticReasonerInput

Agentic Reasoner Input interface with 3 public fields or methods.

• Kind: interface
• Import: import type { AgenticReasonerInput } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export interface AgenticReasonerInput {
    context: BuiltAgentContext;
    config: RequiredReasoningConfig;
    thinkingPlan?: ThinkingPlan;
}

Contract members

Member	Kind	Signature	Description
config	property	config: RequiredReasoningConfig	Public property; its type, readonly modifier and optionality are shown in the signature.
context	property	context: BuiltAgentContext	Public property; its type, readonly modifier and optionality are shown in the signature.
thinkingPlan	property	thinkingPlan?: ThinkingPlan	Public property; its type, readonly modifier and optionality are shown in the signature.

AgenticReasoningDecision

Agentic Reasoning Decision interface with 11 public fields or methods.

• Kind: interface
• Import: import type { AgenticReasoningDecision } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export interface AgenticReasoningDecision {
    id: string;
    mode: AgenticReasoningMode;
    recommendedPhase: ReActPhase;
    actionType: 'reason' | ReActAction['type'];
    toolCandidates: string[];
    requiresHumanReview: boolean;
    verificationStrategy: string;
    rationale: string;
    confidence?: number;
    createdAt: string;
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
actionType	property	actionType: "human_review" | "tool" | "model" | "reason" | "finish"	Public property; its type, readonly modifier and optionality are shown in the signature.
confidence	property	confidence?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
createdAt	property	createdAt: string	Public property; its type, readonly modifier and optionality are shown in the signature.
id	property	id: string	Public property; its type, readonly modifier and optionality are shown in the signature.
metadata	property	metadata?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
mode	property	mode: AgenticReasoningMode	Public property; its type, readonly modifier and optionality are shown in the signature.
rationale	property	rationale: string	Public property; its type, readonly modifier and optionality are shown in the signature.
recommendedPhase	property	recommendedPhase: ReActPhase	Public property; its type, readonly modifier and optionality are shown in the signature.
requiresHumanReview	property	requiresHumanReview: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
toolCandidates	property	toolCandidates: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
verificationStrategy	property	verificationStrategy: string	Public property; its type, readonly modifier and optionality are shown in the signature.

BasicReActAgentRuntimeOptions

Basic ReAct Agent Runtime Options interface with 1 public fields or methods.

• Kind: interface
• Import: import type { BasicReActAgentRuntimeOptions } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export interface BasicReActAgentRuntimeOptions {
    verifier?: Verifier;
}

Contract members

Member	Kind	Signature	Description
verifier	property	verifier?: Verifier	Public property; its type, readonly modifier and optionality are shown in the signature.

BuiltAgentContext

Built Agent Context interface with 18 public fields or methods.

• Kind: interface
• Import: import type { BuiltAgentContext } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export interface BuiltAgentContext extends ReActRunContext {
    sourceInput?: unknown;
    contextBudget?: ContextBudget;
    contextProvenance?: ContextProvenance[];
    memoryContext?: MemoryContextItem[];
}

Contract members

Member	Kind	Signature	Description
activeSkills	property	activeSkills?: LoadedSkillContext[]	Public property; its type, readonly modifier and optionality are shown in the signature.
agent	property	agent: ReActAgentSpec	Public property; its type, readonly modifier and optionality are shown in the signature.
contextBudget	property	contextBudget?: ContextBudget	Public property; its type, readonly modifier and optionality are shown in the signature.
contextProvenance	property	contextProvenance?: ContextProvenance[]	Public property; its type, readonly modifier and optionality are shown in the signature.
contextSpec	property	contextSpec?: ContextSpec	Public property; its type, readonly modifier and optionality are shown in the signature.
memoryContext	property	memoryContext?: MemoryContextItem[]	Public property; its type, readonly modifier and optionality are shown in the signature.
memoryScope	property	memoryScope?: MemoryScope	Public property; its type, readonly modifier and optionality are shown in the signature.
messages	property	messages: ModelMessage[]	Public property; its type, readonly modifier and optionality are shown in the signature.
metadata	property	metadata?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
reasoningConfig	property	reasoningConfig?: ReasoningConfig	Public property; its type, readonly modifier and optionality are shown in the signature.
reasoningDecision	property	reasoningDecision?: AgenticReasoningDecision	Public property; its type, readonly modifier and optionality are shown in the signature.
rejectedSkills	property	rejectedSkills?: { skillId: string; reason: string; }[]	Public property; its type, readonly modifier and optionality are shown in the signature.
runId	property	runId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
sourceInput	property	sourceInput?: unknown	Public property; its type, readonly modifier and optionality are shown in the signature.
stepId	property	stepId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
thinkingPlan	property	thinkingPlan?: ThinkingPlan	Public property; its type, readonly modifier and optionality are shown in the signature.
toolExecutionScope	property	toolExecutionScope?: ToolExecutionScope	Public property; its type, readonly modifier and optionality are shown in the signature.
toolPrincipal	property	toolPrincipal?: ToolPrincipal	Public property; its type, readonly modifier and optionality are shown in the signature.

ContextBudget

Context Budget interface with 4 public fields or methods.

• Kind: interface
• Import: import type { ContextBudget } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export interface ContextBudget {
    maxMessages?: number;
    maxMemoryItems?: number;
    maxMemoryChars?: number;
    maxTotalChars?: number;
}

Contract members

Member	Kind	Signature	Description
maxMemoryChars	property	maxMemoryChars?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
maxMemoryItems	property	maxMemoryItems?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
maxMessages	property	maxMessages?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
maxTotalChars	property	maxTotalChars?: number	Public property; its type, readonly modifier and optionality are shown in the signature.

ContextBuilder

Context Builder interface with 1 public fields or methods.

• Kind: interface
• Import: import type { ContextBuilder } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export interface ContextBuilder {
    build(input: ContextBuildInput): Promise<BuiltAgentContext>;
}

Contract members

Member	Kind	Signature	Description
build	method	build(input: ContextBuildInput): Promise<BuiltAgentContext>	Public method; parameters and return type are shown in the signature.

ContextBuildInput

Context Build Input interface with 12 public fields or methods.

• Kind: interface
• Import: import type { ContextBuildInput } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export interface ContextBuildInput<TInput = unknown> {
    runId: string;
    stepId: string;
    sessionId?: string;
    userId?: string;
    agent: ReActAgentSpec;
    input: TInput;
    messages?: ModelMessage[];
    memoryScope?: MemoryScope;
    contextSpec?: ContextSpec;
    metadata?: Record<string, unknown>;
    toolExecutionScope?: ToolExecutionScope;
    toolPrincipal?: ToolPrincipal;
}

Contract members

Member	Kind	Signature	Description
agent	property	agent: ReActAgentSpec	Public property; its type, readonly modifier and optionality are shown in the signature.
contextSpec	property	contextSpec?: ContextSpec	Public property; its type, readonly modifier and optionality are shown in the signature.
input	property	input: TInput	Public property; its type, readonly modifier and optionality are shown in the signature.
memoryScope	property	memoryScope?: MemoryScope	Public property; its type, readonly modifier and optionality are shown in the signature.
messages	property	messages?: ModelMessage[]	Public property; its type, readonly modifier and optionality are shown in the signature.
metadata	property	metadata?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
runId	property	runId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
sessionId	property	sessionId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
stepId	property	stepId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
toolExecutionScope	property	toolExecutionScope?: ToolExecutionScope	Public property; its type, readonly modifier and optionality are shown in the signature.
toolPrincipal	property	toolPrincipal?: ToolPrincipal	Public property; its type, readonly modifier and optionality are shown in the signature.
userId	property	userId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.

ContextProvenance

Context Provenance interface with 6 public fields or methods.

• Kind: interface
• Import: import type { ContextProvenance } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export interface ContextProvenance {
    source: 'memory' | 'input' | 'system' | 'skill';
    id: string;
    type?: string;
    score?: number;
    provenance?: Record<string, unknown>;
    includedAt: string;
}

Contract members

Member	Kind	Signature	Description
id	property	id: string	Public property; its type, readonly modifier and optionality are shown in the signature.
includedAt	property	includedAt: string	Public property; its type, readonly modifier and optionality are shown in the signature.
provenance	property	provenance?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
score	property	score?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
source	property	source: "memory" | "skill" | "system" | "input"	Public property; its type, readonly modifier and optionality are shown in the signature.
type	property	type?: string	Public property; its type, readonly modifier and optionality are shown in the signature.

EpisodicMemorySyncOptions

Episodic Memory Sync Options interface with 7 public fields or methods.

• Kind: interface
• Import: import type { EpisodicMemorySyncOptions } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export interface EpisodicMemorySyncOptions {
    memory: Pick<MemoryManager, 'write'>;
    now?: () => string;
    source?: string;
    idPrefix?: string;
    confidence?: number;
    visibility?: MemoryRecord['visibility'];
    allowLongTerm?: boolean;
}

Contract members

Member	Kind	Signature	Description
allowLongTerm	property	allowLongTerm?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
confidence	property	confidence?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
idPrefix	property	idPrefix?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
memory	property	memory: Pick<MemoryManager, "write">	Public property; its type, readonly modifier and optionality are shown in the signature.
now	method	now?(): string	Public method; parameters and return type are shown in the signature.
source	property	source?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
visibility	property	visibility?: "workspace" | "private" | "public"	Public property; its type, readonly modifier and optionality are shown in the signature.

InMemoryReActContinuationCheckpointStoreOptions

In Memory ReAct Continuation Checkpoint Store Options interface with 3 public fields or methods.

• Kind: interface
• Import: import type { InMemoryReActContinuationCheckpointStoreOptions } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export interface InMemoryReActContinuationCheckpointStoreOptions {
    maxCheckpoints?: number;
    maxIdempotencyRecords?: number;
    maxCheckpointBytes?: number;
}

Contract members

Member	Kind	Signature	Description
maxCheckpointBytes	property	maxCheckpointBytes?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
maxCheckpoints	property	maxCheckpoints?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
maxIdempotencyRecords	property	maxIdempotencyRecords?: number	Public property; its type, readonly modifier and optionality are shown in the signature.

MemoryContextBuilderOptions

Memory Context Builder Options interface with 7 public fields or methods.

• Kind: interface
• Import: import type { MemoryContextBuilderOptions } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export interface MemoryContextBuilderOptions {
    memory: Pick<MemoryManager, 'search'>;
    embeddings?: EmbeddingProvider;
    baseBuilder?: ContextBuilder;
    budget?: ContextBudget;
    memoryTypes?: MemoryType[];
    now?: () => string;
    query?: MemorySearchQuery | ((input: ContextBuildInput, base: BuiltAgentContext) => MemorySearchQuery | Promise<MemorySearchQuery>);
}

Contract members

Member	Kind	Signature	Description
baseBuilder	property	baseBuilder?: ContextBuilder	Public property; its type, readonly modifier and optionality are shown in the signature.
budget	property	budget?: ContextBudget	Public property; its type, readonly modifier and optionality are shown in the signature.
embeddings	property	embeddings?: EmbeddingProvider	Public property; its type, readonly modifier and optionality are shown in the signature.
memory	property	memory: Pick<MemoryManager, "search">	Public property; its type, readonly modifier and optionality are shown in the signature.
memoryTypes	property	memoryTypes?: MemoryType[]	Public property; its type, readonly modifier and optionality are shown in the signature.
now	method	now?(): string	Public method; parameters and return type are shown in the signature.
query	property	query?: MemorySearchQuery | ((input: ContextBuildInput, base: BuiltAgentContext) => MemorySearchQuery | Promise<MemorySearchQuery>)	Public property; its type, readonly modifier and optionality are shown in the signature.

MemoryContextItem

Memory Context Item interface with 5 public fields or methods.

• Kind: interface
• Import: import type { MemoryContextItem } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export interface MemoryContextItem {
    id: string;
    type: MemoryType;
    content: string;
    score?: number;
    provenance: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
content	property	content: string	Public property; its type, readonly modifier and optionality are shown in the signature.
id	property	id: string	Public property; its type, readonly modifier and optionality are shown in the signature.
provenance	property	provenance: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
score	property	score?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
type	property	type: MemoryType	Public property; its type, readonly modifier and optionality are shown in the signature.

ReActAction

ReAct Action interface with 5 public fields or methods.

• Kind: interface
• Import: import type { ReActAction } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export interface ReActAction {
    type: 'tool' | 'model' | 'finish' | 'human_review';
    toolCallId?: string;
    target?: string;
    input?: unknown;
    reason?: string;
}

Contract members

Member	Kind	Signature	Description
input	property	input?: unknown	Public property; its type, readonly modifier and optionality are shown in the signature.
reason	property	reason?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
target	property	target?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
toolCallId	property	toolCallId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
type	property	type: "human_review" | "tool" | "model" | "finish"	Public property; its type, readonly modifier and optionality are shown in the signature.

ReActAgentRunnerOptions

ReAct Agent Runner Options interface with 25 public fields or methods.

• Kind: interface
• Import: import type { ReActAgentRunnerOptions } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export interface ReActAgentRunnerOptions extends Omit<ReActRunnerOptions, 'toolRunner'> {
    toolRunner?: ToolRunner;
    contextBuilder?: ContextBuilder;
    verifier?: Verifier;
    runtime?: ReActAgentRuntime;
    thinkingPlanner?: ThinkingPlanner;
    agenticReasoner?: AgenticReasoner;
    reasoningConfig?: ReasoningConfig;
    skillRegistry?: SkillRegistry;
    skillSelector?: SkillSelector;
    skillContextLoader?: SkillContextLoader;
    skillPolicy?: SkillPolicy;
    allowedSkills?: SkillContextBuilderOptions['allowedSkills'];
    requiredSkills?: SkillContextBuilderOptions['requiredSkills'];
}

Contract members

Member	Kind	Signature	Description
agenticReasoner	property	agenticReasoner?: AgenticReasoner	Public property; its type, readonly modifier and optionality are shown in the signature.
allowedSkills	property	allowedSkills?: string[] | ((input: ContextBuildInput, base: BuiltAgentContext) => string[] | undefined | Promise<string[] | undefined>)	Public property; its type, readonly modifier and optionality are shown in the signature.
checkpointStore	property	checkpointStore?: ReActContinuationCheckpointStore	Public property; its type, readonly modifier and optionality are shown in the signature.
contextBuilder	property	contextBuilder?: ContextBuilder	Public property; its type, readonly modifier and optionality are shown in the signature.
continueAfterTool	property	continueAfterTool?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
executionBudget	property	executionBudget?: Partial<ReActExecutionBudget>	Public property; its type, readonly modifier and optionality are shown in the signature.
inference	property	inference: InferenceProvider	Public property; its type, readonly modifier and optionality are shown in the signature.
maxIterations	property	maxIterations?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
now	method	now?(): string	Public method; parameters and return type are shown in the signature.
onCheckpoint	method	onCheckpoint?(checkpoint: ReActContinuationCheckpoint): Promise<void> | void	Public method; parameters and return type are shown in the signature.
onResume	method	onResume?(checkpoint: ReActContinuationCheckpoint): Promise<void> | void	Public method; parameters and return type are shown in the signature.
onStep	method	onStep?(step: ReActStep): Promise<void> | void	Public method; parameters and return type are shown in the signature.
reasoningConfig	property	reasoningConfig?: ReasoningConfig	Public property; its type, readonly modifier and optionality are shown in the signature.
requiredSkills	property	requiredSkills?: string[] | ((input: ContextBuildInput, base: BuiltAgentContext) => string[] | undefined | Promise<string[] | undefined>)	Public property; its type, readonly modifier and optionality are shown in the signature.
resolveToolExecutionScope	method	resolveToolExecutionScope?(context: ReActRunContext, action: ReActAction): ToolExecutionScope | undefined	Public method; parameters and return type are shown in the signature.
retainCheckpointUntilOutcome	property	retainCheckpointUntilOutcome?: boolean	Keep the latest durable checkpoint until an outer transaction records the terminal/waiting outcome. Production quantum executors use this to avoid an unrecoverable gap between Runner completion and Event persistence.
runtime	property	runtime?: ReActAgentRuntime	Public property; its type, readonly modifier and optionality are shown in the signature.
skillContextLoader	property	skillContextLoader?: SkillContextLoader	Public property; its type, readonly modifier and optionality are shown in the signature.
skillPolicy	property	skillPolicy?: SkillPolicy	Public property; its type, readonly modifier and optionality are shown in the signature.
skillRegistry	property	skillRegistry?: SkillRegistry	Public property; its type, readonly modifier and optionality are shown in the signature.
skillSelector	property	skillSelector?: SkillSelector	Public property; its type, readonly modifier and optionality are shown in the signature.
syncMemory	method	syncMemory?(context: ReActRunContext, observation: ReActObservation): Promise<void>	Public method; parameters and return type are shown in the signature.
thinkingPlanner	property	thinkingPlanner?: ThinkingPlanner	Public property; its type, readonly modifier and optionality are shown in the signature.
toolRunner	property	toolRunner?: ToolRunner	Public property; its type, readonly modifier and optionality are shown in the signature.
verifier	property	verifier?: Verifier	Public property; its type, readonly modifier and optionality are shown in the signature.

ReActAgentRuntime

ReAct Agent Runtime interface with 3 public fields or methods.

• Kind: interface
• Import: import type { ReActAgentRuntime } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export interface ReActAgentRuntime {
    reason(context: ReActRunContext): Promise<InferenceRequest>;
    selectAction(response: InferenceResponse): Promise<ReActAction>;
    verify(context: ReActRunContext, observation: ReActObservation): Promise<ReActAction>;
}

Contract members

Member	Kind	Signature	Description
reason	method	reason(context: ReActRunContext): Promise<InferenceRequest>	Public method; parameters and return type are shown in the signature.
selectAction	method	selectAction(response: InferenceResponse): Promise<ReActAction>	Public method; parameters and return type are shown in the signature.
verify	method	verify(context: ReActRunContext, observation: ReActObservation): Promise<ReActAction>	Public method; parameters and return type are shown in the signature.

ReActAgentSpec

ReAct Agent Spec interface with 17 public fields or methods.

• Kind: interface
• Import: import type { ReActAgentSpec } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export interface ReActAgentSpec extends VersionedSpec, SpecMetadata {
    name: string;
    modelAlias: string;
    systemInstructions?: string;
    promptRefs?: AgentPromptRef[];
    skillRefs?: SkillRef[];
    toolRefs?: string[];
    memoryProfileRef?: string;
    policyRefs?: string[];
    contextSpecRef?: SpecRef;
    reasoning?: ReasoningConfig;
}

Contract members

Member	Kind	Signature	Description
contextSpecRef	property	contextSpecRef?: SpecRef	Public property; its type, readonly modifier and optionality are shown in the signature.
createdAt	property	createdAt?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
description	property	description?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
id	property	id: string	Public property; its type, readonly modifier and optionality are shown in the signature.
memoryProfileRef	property	memoryProfileRef?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
modelAlias	property	modelAlias: string	Public property; its type, readonly modifier and optionality are shown in the signature.
name	property	name: string	Public property; its type, readonly modifier and optionality are shown in the signature.
owner	property	owner?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
policyRefs	property	policyRefs?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
promptRefs	property	promptRefs?: AgentPromptRef[]	Public property; its type, readonly modifier and optionality are shown in the signature.
reasoning	property	reasoning?: ReasoningConfig	Public property; its type, readonly modifier and optionality are shown in the signature.
skillRefs	property	skillRefs?: SkillRef[]	Public property; its type, readonly modifier and optionality are shown in the signature.
systemInstructions	property	systemInstructions?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
tags	property	tags?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
toolRefs	property	toolRefs?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
updatedAt	property	updatedAt?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
version	property	version: string	Public property; its type, readonly modifier and optionality are shown in the signature.

ReActContinuationCheckpoint

ReAct Continuation Checkpoint interface with 19 public fields or methods.

• Kind: interface
• Import: import type { ReActContinuationCheckpoint } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export interface ReActContinuationCheckpoint {
    version: '1.0.0';
    runId: string;
    stepId: string;
    scopeHash: string;
    agentRef: SpecRef;
    nextPhase: 'reason' | 'act';
    messages: ModelMessage[];
    iterations: number;
    modelCalls: number;
    toolCalls: number;
    totalTokens: number;
    toolInvocationSequence: number;
    stepSequence: number;
    consecutiveNoProgress: number;
    lastProgressFingerprint?: string;
    pendingAction?: ReActAction;
    pendingToolInvocationId?: string;
    createdAt: string;
    updatedAt: string;
}

Contract members

Member	Kind	Signature	Description
agentRef	property	agentRef: SpecRef	Public property; its type, readonly modifier and optionality are shown in the signature.
consecutiveNoProgress	property	consecutiveNoProgress: number	Public property; its type, readonly modifier and optionality are shown in the signature.
createdAt	property	createdAt: string	Public property; its type, readonly modifier and optionality are shown in the signature.
iterations	property	iterations: number	Public property; its type, readonly modifier and optionality are shown in the signature.
lastProgressFingerprint	property	lastProgressFingerprint?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
messages	property	messages: ModelMessage[]	Public property; its type, readonly modifier and optionality are shown in the signature.
modelCalls	property	modelCalls: number	Public property; its type, readonly modifier and optionality are shown in the signature.
nextPhase	property	nextPhase: "reason" | "act"	Public property; its type, readonly modifier and optionality are shown in the signature.
pendingAction	property	pendingAction?: ReActAction	Public property; its type, readonly modifier and optionality are shown in the signature.
pendingToolInvocationId	property	pendingToolInvocationId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
runId	property	runId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
scopeHash	property	scopeHash: string	Public property; its type, readonly modifier and optionality are shown in the signature.
stepId	property	stepId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
stepSequence	property	stepSequence: number	Public property; its type, readonly modifier and optionality are shown in the signature.
toolCalls	property	toolCalls: number	Public property; its type, readonly modifier and optionality are shown in the signature.
toolInvocationSequence	property	toolInvocationSequence: number	Public property; its type, readonly modifier and optionality are shown in the signature.
totalTokens	property	totalTokens: number	Public property; its type, readonly modifier and optionality are shown in the signature.
updatedAt	property	updatedAt: string	Public property; its type, readonly modifier and optionality are shown in the signature.
version	property	version: "1.0.0"	Public property; its type, readonly modifier and optionality are shown in the signature.

ReActContinuationCheckpointPutResult

ReAct Continuation Checkpoint Put Result interface with 2 public fields or methods.

• Kind: interface
• Import: import type { ReActContinuationCheckpointPutResult } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export interface ReActContinuationCheckpointPutResult {
    checkpoint: ReActContinuationCheckpoint;
    reused: boolean;
}

Contract members

Member	Kind	Signature	Description
checkpoint	property	checkpoint: ReActContinuationCheckpoint	Public property; its type, readonly modifier and optionality are shown in the signature.
reused	property	reused: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.

ReActContinuationCheckpointStore

ReAct Continuation Checkpoint Store interface with 3 public fields or methods.

• Kind: interface
• Import: import type { ReActContinuationCheckpointStore } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export interface ReActContinuationCheckpointStore {
    put(checkpoint: ReActContinuationCheckpoint, idempotencyKey: string): Promise<ReActContinuationCheckpointPutResult>;
    get(runId: string, stepId: string, expectedScopeHash: string): Promise<ReActContinuationCheckpoint | null>;
    delete(runId: string, stepId: string, expectedScopeHash: string, expectedStepSequence?: number): Promise<boolean>;
}

Contract members

Member	Kind	Signature	Description
delete	method	delete(runId: string, stepId: string, expectedScopeHash: string, expectedStepSequence?: number): Promise<boolean>	Public method; parameters and return type are shown in the signature.
get	method	get(runId: string, stepId: string, expectedScopeHash: string): Promise<ReActContinuationCheckpoint | null>	Public method; parameters and return type are shown in the signature.
put	method	put(checkpoint: ReActContinuationCheckpoint, idempotencyKey: string): Promise<ReActContinuationCheckpointPutResult>	Public method; parameters and return type are shown in the signature.

ReActExecutionBudget

Global limits survive process restarts through ReActContinuationCheckpoint. quantumIterations only bounds one worker turn; it is not a new total budget.

• Kind: interface
• Import: import type { ReActExecutionBudget } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export interface ReActExecutionBudget {
    maxIterations: number;
    maxModelCalls: number;
    maxToolCalls: number;
    maxTotalTokens?: number;
    maxConsecutiveNoProgress: number;
    quantumIterations: number;
    deadlineAt?: string;
}

Contract members

Member	Kind	Signature	Description
deadlineAt	property	deadlineAt?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
maxConsecutiveNoProgress	property	maxConsecutiveNoProgress: number	Public property; its type, readonly modifier and optionality are shown in the signature.
maxIterations	property	maxIterations: number	Public property; its type, readonly modifier and optionality are shown in the signature.
maxModelCalls	property	maxModelCalls: number	Public property; its type, readonly modifier and optionality are shown in the signature.
maxToolCalls	property	maxToolCalls: number	Public property; its type, readonly modifier and optionality are shown in the signature.
maxTotalTokens	property	maxTotalTokens?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
quantumIterations	property	quantumIterations: number	Public property; its type, readonly modifier and optionality are shown in the signature.

ReActObservation

ReAct Observation interface with 3 public fields or methods.

• Kind: interface
• Import: import type { ReActObservation } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export interface ReActObservation<TValue = unknown> {
    source: 'model' | 'tool' | 'memory' | 'human' | 'system';
    value: TValue;
    provenance?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
provenance	property	provenance?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
source	property	source: "memory" | "system" | "human" | "tool" | "model"	Public property; its type, readonly modifier and optionality are shown in the signature.
value	property	value: TValue	Public property; its type, readonly modifier and optionality are shown in the signature.

ReActRunContext

ReAct Run Context interface with 14 public fields or methods.

• Kind: interface
• Import: import type { ReActRunContext } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export interface ReActRunContext {
    runId: string;
    stepId: string;
    agent: ReActAgentSpec;
    messages: ModelMessage[];
    memoryScope?: MemoryScope;
    contextSpec?: ContextSpec;
    metadata?: Record<string, unknown>;
    reasoningConfig?: ReasoningConfig;
    thinkingPlan?: ThinkingPlan;
    reasoningDecision?: AgenticReasoningDecision;
    activeSkills?: LoadedSkillContext[];
    rejectedSkills?: Array<{
        skillId: string;
        reason: string;
    }>;
    toolExecutionScope?: ToolExecutionScope;
    toolPrincipal?: ToolPrincipal;
}

Contract members

Member	Kind	Signature	Description
activeSkills	property	activeSkills?: LoadedSkillContext[]	Public property; its type, readonly modifier and optionality are shown in the signature.
agent	property	agent: ReActAgentSpec	Public property; its type, readonly modifier and optionality are shown in the signature.
contextSpec	property	contextSpec?: ContextSpec	Public property; its type, readonly modifier and optionality are shown in the signature.
memoryScope	property	memoryScope?: MemoryScope	Public property; its type, readonly modifier and optionality are shown in the signature.
messages	property	messages: ModelMessage[]	Public property; its type, readonly modifier and optionality are shown in the signature.
metadata	property	metadata?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
reasoningConfig	property	reasoningConfig?: ReasoningConfig	Public property; its type, readonly modifier and optionality are shown in the signature.
reasoningDecision	property	reasoningDecision?: AgenticReasoningDecision	Public property; its type, readonly modifier and optionality are shown in the signature.
rejectedSkills	property	rejectedSkills?: { skillId: string; reason: string; }[]	Public property; its type, readonly modifier and optionality are shown in the signature.
runId	property	runId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
stepId	property	stepId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
thinkingPlan	property	thinkingPlan?: ThinkingPlan	Public property; its type, readonly modifier and optionality are shown in the signature.
toolExecutionScope	property	toolExecutionScope?: ToolExecutionScope	Public property; its type, readonly modifier and optionality are shown in the signature.
toolPrincipal	property	toolPrincipal?: ToolPrincipal	Public property; its type, readonly modifier and optionality are shown in the signature.

ReActRunControl

ReAct Run Control interface with 4 public fields or methods.

• Kind: interface
• Import: import type { ReActRunControl } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export interface ReActRunControl {
    checkpoint?: ReActContinuationCheckpoint;
    executionBudget?: Partial<ReActExecutionBudget>;
    abortSignal?: AbortSignal;
    resumeFromCheckpointStore?: boolean;
}

Contract members

Member	Kind	Signature	Description
abortSignal	property	abortSignal?: AbortSignal	Public property; its type, readonly modifier and optionality are shown in the signature.
checkpoint	property	checkpoint?: ReActContinuationCheckpoint	Public property; its type, readonly modifier and optionality are shown in the signature.
executionBudget	property	executionBudget?: Partial<ReActExecutionBudget>	Public property; its type, readonly modifier and optionality are shown in the signature.
resumeFromCheckpointStore	property	resumeFromCheckpointStore?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.

ReActRunnerOptions

ReAct Runner Options interface with 13 public fields or methods.

• Kind: interface
• Import: import type { ReActRunnerOptions } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export interface ReActRunnerOptions {
    inference: InferenceProvider;
    toolRunner?: ToolRunner;
    maxIterations?: number;
    executionBudget?: Partial<ReActExecutionBudget>;
    checkpointStore?: ReActContinuationCheckpointStore;
    continueAfterTool?: boolean;
    onStep?: (step: ReActStep) => Promise<void> | void;
    onCheckpoint?: (checkpoint: ReActContinuationCheckpoint) => Promise<void> | void;
    onResume?: (checkpoint: ReActContinuationCheckpoint) => Promise<void> | void;
    syncMemory?: (context: ReActRunContext, observation: ReActObservation) => Promise<void>;
    /**
     * Keep the latest durable checkpoint until an outer transaction records the
     * terminal/waiting outcome. Production quantum executors use this to avoid
     * an unrecoverable gap between Runner completion and Event persistence.
     */
    retainCheckpointUntilOutcome?: boolean;
    resolveToolExecutionScope?: (context: ReActRunContext, action: ReActAction) => ToolExecutionScope | undefined;
    now?: () => string;
}

Contract members

Member	Kind	Signature	Description
checkpointStore	property	checkpointStore?: ReActContinuationCheckpointStore	Public property; its type, readonly modifier and optionality are shown in the signature.
continueAfterTool	property	continueAfterTool?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
executionBudget	property	executionBudget?: Partial<ReActExecutionBudget>	Public property; its type, readonly modifier and optionality are shown in the signature.
inference	property	inference: InferenceProvider	Public property; its type, readonly modifier and optionality are shown in the signature.
maxIterations	property	maxIterations?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
now	method	now?(): string	Public method; parameters and return type are shown in the signature.
onCheckpoint	method	onCheckpoint?(checkpoint: ReActContinuationCheckpoint): Promise<void> | void	Public method; parameters and return type are shown in the signature.
onResume	method	onResume?(checkpoint: ReActContinuationCheckpoint): Promise<void> | void	Public method; parameters and return type are shown in the signature.
onStep	method	onStep?(step: ReActStep): Promise<void> | void	Public method; parameters and return type are shown in the signature.
resolveToolExecutionScope	method	resolveToolExecutionScope?(context: ReActRunContext, action: ReActAction): ToolExecutionScope | undefined	Public method; parameters and return type are shown in the signature.
retainCheckpointUntilOutcome	property	retainCheckpointUntilOutcome?: boolean	Keep the latest durable checkpoint until an outer transaction records the terminal/waiting outcome. Production quantum executors use this to avoid an unrecoverable gap between Runner completion and Event persistence.
syncMemory	method	syncMemory?(context: ReActRunContext, observation: ReActObservation): Promise<void>	Public method; parameters and return type are shown in the signature.
toolRunner	property	toolRunner?: ToolRunner	Public property; its type, readonly modifier and optionality are shown in the signature.

ReActRunResult

ReAct Run Result interface with 8 public fields or methods.

• Kind: interface
• Import: import type { ReActRunResult } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export interface ReActRunResult {
    runId: string;
    status: 'completed' | 'failed' | 'human_review_required' | 'suspended' | 'cancelled';
    steps: ReActStep[];
    output?: unknown;
    finalAction?: ReActAction;
    checkpoint?: ReActContinuationCheckpoint;
    suspension?: ReActSuspension;
    error?: unknown;
}

Contract members

Member	Kind	Signature	Description
checkpoint	property	checkpoint?: ReActContinuationCheckpoint	Public property; its type, readonly modifier and optionality are shown in the signature.
error	property	error?: unknown	Public property; its type, readonly modifier and optionality are shown in the signature.
finalAction	property	finalAction?: ReActAction	Public property; its type, readonly modifier and optionality are shown in the signature.
output	property	output?: unknown	Public property; its type, readonly modifier and optionality are shown in the signature.
runId	property	runId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
status	property	status: "completed" | "cancelled" | "failed" | "suspended" | "human_review_required"	Public property; its type, readonly modifier and optionality are shown in the signature.
steps	property	steps: ReActStep[]	Public property; its type, readonly modifier and optionality are shown in the signature.
suspension	property	suspension?: ReActSuspension	Public property; its type, readonly modifier and optionality are shown in the signature.

ReActStep

ReAct Step interface with 5 public fields or methods.

• Kind: interface
• Import: import type { ReActStep } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export interface ReActStep {
    id: string;
    phase: ReActPhase;
    input?: unknown;
    output?: unknown;
    traceEventId?: string;
}

Contract members

Member	Kind	Signature	Description
id	property	id: string	Public property; its type, readonly modifier and optionality are shown in the signature.
input	property	input?: unknown	Public property; its type, readonly modifier and optionality are shown in the signature.
output	property	output?: unknown	Public property; its type, readonly modifier and optionality are shown in the signature.
phase	property	phase: ReActPhase	Public property; its type, readonly modifier and optionality are shown in the signature.
traceEventId	property	traceEventId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.

ReActSuspension

ReAct Suspension interface with 4 public fields or methods.

• Kind: interface
• Import: import type { ReActSuspension } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export interface ReActSuspension {
    reason: ReActSuspensionReason;
    retryable: boolean;
    requiresHumanReview: boolean;
    message: string;
}

Contract members

Member	Kind	Signature	Description
message	property	message: string	Public property; its type, readonly modifier and optionality are shown in the signature.
reason	property	reason: "quantum_exhausted" | "iteration_budget_exhausted" | "model_call_budget_exhausted" | "tool_call_budget_exhausted" | "token_budget_exhausted" | "non_progress" | "deadline_exceeded"	Public property; its type, readonly modifier and optionality are shown in the signature.
requiresHumanReview	property	requiresHumanReview: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
retryable	property	retryable: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.

ReasoningConfig

Reasoning Config interface with 7 public fields or methods.

• Kind: interface
• Import: import type { ReasoningConfig } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export interface ReasoningConfig {
    thinkingMode?: ThinkingMode;
    agenticMode?: AgenticReasoningMode;
    maxSteps?: number;
    persist?: ReasoningPersistence;
    plannerRef?: string;
    reasonerRef?: string;
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
agenticMode	property	agenticMode?: AgenticReasoningMode	Public property; its type, readonly modifier and optionality are shown in the signature.
maxSteps	property	maxSteps?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
metadata	property	metadata?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
persist	property	persist?: ReasoningPersistence	Public property; its type, readonly modifier and optionality are shown in the signature.
plannerRef	property	plannerRef?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
reasonerRef	property	reasonerRef?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
thinkingMode	property	thinkingMode?: ThinkingMode	Public property; its type, readonly modifier and optionality are shown in the signature.

ReasoningContextBuilderOptions

Reasoning Context Builder Options interface with 5 public fields or methods.

• Kind: interface
• Import: import type { ReasoningContextBuilderOptions } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export interface ReasoningContextBuilderOptions {
    baseBuilder?: ContextBuilder;
    planner?: ThinkingPlanner;
    reasoner?: AgenticReasoner;
    config?: ReasoningConfig;
    now?: () => string;
}

Contract members

Member	Kind	Signature	Description
baseBuilder	property	baseBuilder?: ContextBuilder	Public property; its type, readonly modifier and optionality are shown in the signature.
config	property	config?: ReasoningConfig	Public property; its type, readonly modifier and optionality are shown in the signature.
now	method	now?(): string	Public method; parameters and return type are shown in the signature.
planner	property	planner?: ThinkingPlanner	Public property; its type, readonly modifier and optionality are shown in the signature.
reasoner	property	reasoner?: AgenticReasoner	Public property; its type, readonly modifier and optionality are shown in the signature.

RequiredReasoningConfig

Required Reasoning Config interface with 7 public fields or methods.

• Kind: interface
• Import: import type { RequiredReasoningConfig } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export interface RequiredReasoningConfig extends Required<Omit<ReasoningConfig, 'plannerRef' | 'reasonerRef' | 'metadata'>> {
    plannerRef?: string;
    reasonerRef?: string;
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
agenticMode	property	agenticMode?: AgenticReasoningMode	Public property; its type, readonly modifier and optionality are shown in the signature.
maxSteps	property	maxSteps?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
metadata	property	metadata?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
persist	property	persist?: ReasoningPersistence	Public property; its type, readonly modifier and optionality are shown in the signature.
plannerRef	property	plannerRef?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
reasonerRef	property	reasonerRef?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
thinkingMode	property	thinkingMode?: ThinkingMode	Public property; its type, readonly modifier and optionality are shown in the signature.

SkillContextBuilderOptions

Skill Context Builder Options interface with 9 public fields or methods.

• Kind: interface
• Import: import type { SkillContextBuilderOptions } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export interface SkillContextBuilderOptions {
    registry: SkillRegistry;
    baseBuilder?: ContextBuilder;
    selector?: SkillSelector;
    contextLoader?: SkillContextLoader;
    policy?: SkillPolicy;
    allowedSkills?: string[] | ((input: ContextBuildInput, base: BuiltAgentContext) => string[] | undefined | Promise<string[] | undefined>);
    requiredSkills?: string[] | ((input: ContextBuildInput, base: BuiltAgentContext) => string[] | undefined | Promise<string[] | undefined>);
    availableToolRefs?: string[] | ((input: ContextBuildInput, base: BuiltAgentContext) => string[] | Promise<string[]>);
    now?: () => string;
}

Contract members

Member	Kind	Signature	Description
allowedSkills	property	allowedSkills?: string[] | ((input: ContextBuildInput, base: BuiltAgentContext) => string[] | undefined | Promise<string[] | undefined>)	Public property; its type, readonly modifier and optionality are shown in the signature.
availableToolRefs	property	availableToolRefs?: string[] | ((input: ContextBuildInput, base: BuiltAgentContext) => string[] | Promise<string[]>)	Public property; its type, readonly modifier and optionality are shown in the signature.
baseBuilder	property	baseBuilder?: ContextBuilder	Public property; its type, readonly modifier and optionality are shown in the signature.
contextLoader	property	contextLoader?: SkillContextLoader	Public property; its type, readonly modifier and optionality are shown in the signature.
now	method	now?(): string	Public method; parameters and return type are shown in the signature.
policy	property	policy?: SkillPolicy	Public property; its type, readonly modifier and optionality are shown in the signature.
registry	property	registry: SkillRegistry	Public property; its type, readonly modifier and optionality are shown in the signature.
requiredSkills	property	requiredSkills?: string[] | ((input: ContextBuildInput, base: BuiltAgentContext) => string[] | undefined | Promise<string[] | undefined>)	Public property; its type, readonly modifier and optionality are shown in the signature.
selector	property	selector?: SkillSelector	Public property; its type, readonly modifier and optionality are shown in the signature.

ThinkingPlan

Thinking Plan interface with 10 public fields or methods.

• Kind: interface
• Import: import type { ThinkingPlan } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export interface ThinkingPlan {
    id: string;
    mode: Exclude<ThinkingMode, 'none'>;
    intent: string;
    constraints: string[];
    successCriteria: string[];
    plan: string[];
    risks: string[];
    summary: string;
    createdAt: string;
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
constraints	property	constraints: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
createdAt	property	createdAt: string	Public property; its type, readonly modifier and optionality are shown in the signature.
id	property	id: string	Public property; its type, readonly modifier and optionality are shown in the signature.
intent	property	intent: string	Public property; its type, readonly modifier and optionality are shown in the signature.
metadata	property	metadata?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
mode	property	mode: "structured" | "summary"	Public property; its type, readonly modifier and optionality are shown in the signature.
plan	property	plan: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
risks	property	risks: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
successCriteria	property	successCriteria: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
summary	property	summary: string	Public property; its type, readonly modifier and optionality are shown in the signature.

ThinkingPlanner

Thinking Planner interface with 1 public fields or methods.

• Kind: interface
• Import: import type { ThinkingPlanner } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export interface ThinkingPlanner {
    plan(input: ThinkingPlannerInput): Promise<ThinkingPlan>;
}

Contract members

Member	Kind	Signature	Description
plan	method	plan(input: ThinkingPlannerInput): Promise<ThinkingPlan>	Public method; parameters and return type are shown in the signature.

ThinkingPlannerInput

Thinking Planner Input interface with 2 public fields or methods.

• Kind: interface
• Import: import type { ThinkingPlannerInput } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export interface ThinkingPlannerInput {
    context: BuiltAgentContext;
    config: RequiredReasoningConfig;
}

Contract members

Member	Kind	Signature	Description
config	property	config: RequiredReasoningConfig	Public property; its type, readonly modifier and optionality are shown in the signature.
context	property	context: BuiltAgentContext	Public property; its type, readonly modifier and optionality are shown in the signature.

ToolActivityPort

Tool Activity Port interface with 2 public fields or methods.

• Kind: interface
• Import: import type { ToolActivityPort } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export interface ToolActivityPort {
    execute(request: ToolActivityRequest): Promise<ToolActivityResult>;
    cancel(invocationId: string, reason?: string): Promise<ToolActivityResult | null>;
}

Contract members

Member	Kind	Signature	Description
cancel	method	cancel(invocationId: string, reason?: string): Promise<ToolActivityResult | null>	Public method; parameters and return type are shown in the signature.
execute	method	execute(request: ToolActivityRequest): Promise<ToolActivityResult>	Public method; parameters and return type are shown in the signature.

ToolActivityRequest

Tool Activity Request interface with 10 public fields or methods.

• Kind: interface
• Import: import type { ToolActivityRequest } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export interface ToolActivityRequest {
    operationId: string;
    invocationId: string;
    runId: string;
    stateAttemptId: string;
    toolRef: SpecRef;
    input: unknown;
    principal: ToolPrincipal;
    deadlineAt?: string;
    idempotencyKey?: string;
    contractSnapshotRef?: string;
}

Contract members

Member	Kind	Signature	Description
contractSnapshotRef	property	contractSnapshotRef?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
deadlineAt	property	deadlineAt?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
idempotencyKey	property	idempotencyKey?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
input	property	input: unknown	Public property; its type, readonly modifier and optionality are shown in the signature.
invocationId	property	invocationId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
operationId	property	operationId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
principal	property	principal: ToolPrincipal	Public property; its type, readonly modifier and optionality are shown in the signature.
runId	property	runId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
stateAttemptId	property	stateAttemptId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
toolRef	property	toolRef: SpecRef	Public property; its type, readonly modifier and optionality are shown in the signature.

ToolActivityResult

Tool Activity Result interface with 7 public fields or methods.

• Kind: interface
• Import: import type { ToolActivityResult } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export interface ToolActivityResult {
    invocationId: string;
    status: 'completed' | 'failed' | 'denied' | 'waiting_approval' | 'cancelled' | 'conflict';
    output?: unknown;
    artifactRefs?: string[];
    approvalRequestRef?: string;
    eventIds: string[];
    error?: NormalizedToolError;
}

Contract members

Member	Kind	Signature	Description
approvalRequestRef	property	approvalRequestRef?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
artifactRefs	property	artifactRefs?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
error	property	error?: NormalizedToolError	Public property; its type, readonly modifier and optionality are shown in the signature.
eventIds	property	eventIds: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
invocationId	property	invocationId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
output	property	output?: unknown	Public property; its type, readonly modifier and optionality are shown in the signature.
status	property	status: "completed" | "cancelled" | "failed" | "denied" | "conflict" | "waiting_approval"	Public property; its type, readonly modifier and optionality are shown in the signature.

Verifier

Verifier interface with 1 public fields or methods.

• Kind: interface
• Import: import type { Verifier } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export interface Verifier {
    verify(context: ReActRunContext, observation: ReActObservation): Promise<ReActAction>;
}

Contract members

Member	Kind	Signature	Description
verify	method	verify(context: ReActRunContext, observation: ReActObservation): Promise<ReActAction>	Public method; parameters and return type are shown in the signature.

AgenticReasoningMode

Public type alias for Agentic Reasoning Mode; the declaration contains its complete type expression.

• Kind: type
• Import: import type { AgenticReasoningMode } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export type AgenticReasoningMode = 'react' | 'fsm_react' | 'tot' | 'critique';

ReActPhase

Public type alias for ReAct Phase; the declaration contains its complete type expression.

• Kind: type
• Import: import type { ReActPhase } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export type ReActPhase = 'observe' | 'reason' | 'select_action' | 'policy_check' | 'act' | 'observe_result' | 'verify' | 'memory_sync' | 'complete' | 'fail' | 'human_review' | 'suspend' | 'cancel';

ReActSuspensionReason

Public type alias for ReAct Suspension Reason; the declaration contains its complete type expression.

• Kind: type
• Import: import type { ReActSuspensionReason } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export type ReActSuspensionReason = (typeof REACT_SUSPENSION_REASONS)[number];

ReasoningPersistence

Public type alias for Reasoning Persistence; the declaration contains its complete type expression.

• Kind: type
• Import: import type { ReasoningPersistence } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export type ReasoningPersistence = 'summary_only' | 'events_only';

ThinkingMode

Public type alias for Thinking Mode; the declaration contains its complete type expression.

• Kind: type
• Import: import type { ThinkingMode } from '@codesoul-co/hypha-kernel';
• Source module: index

Declaration

export type ThinkingMode = 'none' | 'summary' | 'structured';