`@codesoul-co/hypha-harness` / `runtime`

Package index: @codesoul-co/hypha-harness
Source: packages/harness/src/runtime.ts
Exports: 20

Using this module

Use the Runtime module for executing runtime behavior at this boundary. It exports 3 classes, 4 functions, 13 interfaces.

Import from the package entrypoint

import {
  EventFirstRuntime,
  HarnessedReActFSMRunner,
  RunManager,
  projectAudit,
  projectReplay,
  projectRun,
  projectSession,
} from '@codesoul-co/hypha-harness';

import type {
  AppendRunEventInput,
  AuditProjection,
  CreateRunInput,
  CreateSessionInput,
  HarnessedReActFSMRunInput,
  HarnessedReActFSMRunnerOptions,
  HarnessedReActFSMRunResult,
  RegressionProjection,
} from '@codesoul-co/hypha-harness';

// The complete export list is documented below.

Usage patterns

Use the 13 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 3 classes as constructable runtime implementations. Each symbol entry lists its constructor and public methods.
The module exposes 4 functions as direct operation entrypoints. Every overload, required/optional parameter, and return type is documented below.

Public exports

Symbol	Kind	Signature	Description
`EventFirstRuntime`	class	`new EventFirstRuntime(events?: EventStore): EventFirstRuntime`	Event First Runtime class with 10 public constructor or member entries; its exact declarations are listed below.
`HarnessedReActFSMRunner`	class	`new HarnessedReActFSMRunner(options: HarnessedReActFSMRunnerOptions): HarnessedReActFSMRunner`	Harnessed ReAct FSM Runner class with 2 public constructor or member entries; its exact declarations are listed below.
`RunManager`	class	`new RunManager(options?: RunManagerOptions): RunManager`	Run Manager class with 36 public constructor or member entries; its exact declarations are listed below.
`projectAudit`	function	`projectAudit(events: FrameworkEvent[]): AuditProjection`	Project Audit function with 1 public call signature; parameters and return types are listed below.
`projectReplay`	function	`projectReplay(events: FrameworkEvent[]): ReplayProjection`	Project Replay function with 1 public call signature; parameters and return types are listed below.
`projectRun`	function	`projectRun(events: FrameworkEvent[]): RuntimeRun \| null`	Project Run function with 1 public call signature; parameters and return types are listed below.
`projectSession`	function	`projectSession(events: FrameworkEvent[]): RuntimeSession \| null`	Project Session function with 1 public call signature; parameters and return types are listed below.
`AppendRunEventInput`	interface	`interface AppendRunEventInput`	Append Run Event Input interface with 11 public fields or methods.
`AuditProjection`	interface	`interface AuditProjection`	Audit Projection interface with 8 public fields or methods.
`CreateRunInput`	interface	`interface CreateRunInput`	Create Run Input interface with 9 public fields or methods.
`CreateSessionInput`	interface	`interface CreateSessionInput`	Create Session Input interface with 6 public fields or methods.
`HarnessedReActFSMRunInput`	interface	`interface HarnessedReActFSMRunInput extends ContextBuildInput<TInput>`	Harnessed ReAct FSM Run Input interface with 16 public fields or methods.
`HarnessedReActFSMRunnerOptions`	interface	`interface HarnessedReActFSMRunnerOptions`	Harnessed ReAct FSM Runner Options interface with 22 public fields or methods.
`HarnessedReActFSMRunResult`	interface	`interface HarnessedReActFSMRunResult`	Harnessed ReAct FSM Run Result interface with 4 public fields or methods.
`RegressionProjection`	interface	`interface RegressionProjection`	Regression Projection interface with 8 public fields or methods.
`ReplayProjection`	interface	`interface ReplayProjection`	Replay Projection interface with 16 public fields or methods.
`RunExecutionContext`	interface	`interface RunExecutionContext`	Run Execution Context interface with 4 public fields or methods.
`RunManagerOptions`	interface	`interface RunManagerOptions`	Run Manager Options interface with 2 public fields or methods.
`RuntimeRun`	interface	`interface RuntimeRun`	Runtime Run interface with 12 public fields or methods.
`RuntimeSession`	interface	`interface RuntimeSession`	Runtime Session interface with 8 public fields or methods.

`EventFirstRuntime`

Event First Runtime class with 10 public constructor or member entries; its exact declarations are listed below.

Kind: class
Import: import { EventFirstRuntime } from '@codesoul-co/hypha-harness';
Source module: runtime

Declaration

text

export declare class EventFirstRuntime {
    constructor(events?: EventStore);
    createSession(input: CreateSessionInput): Promise<RuntimeSession>;
    createRun(input: CreateRunInput): Promise<RuntimeRun>;
    appendRunEvent(input: AppendRunEventInput): Promise<FrameworkEvent>;
    projectSession(sessionId: string): Promise<RuntimeSession | null>;
    projectRun(runId: string): Promise<RuntimeRun | null>;
    projectReplay(runId: string): Promise<ReplayProjection>;
    projectAudit(runId: string): Promise<AuditProjection>;
    projectRegression(runId: string): Promise<RegressionProjection>;
    listEvents(runId: string): Promise<FrameworkEvent[]>;
}

Public members

Member	Kind	Signature	Description
`appendRunEvent`	method	`appendRunEvent(input: AppendRunEventInput): Promise<FrameworkEvent>`	Public method; parameters and return type are shown in the signature.
`constructor`	constructor	`(events?: EventStore): EventFirstRuntime`	Creates an instance of this class.
`createRun`	method	`createRun(input: CreateRunInput): Promise<RuntimeRun>`	Public method; parameters and return type are shown in the signature.
`createSession`	method	`createSession(input: CreateSessionInput): Promise<RuntimeSession>`	Public method; parameters and return type are shown in the signature.
`listEvents`	method	`listEvents(runId: string): Promise<FrameworkEvent[]>`	Public method; parameters and return type are shown in the signature.
`projectAudit`	method	`projectAudit(runId: string): Promise<AuditProjection>`	Public method; parameters and return type are shown in the signature.
`projectRegression`	method	`projectRegression(runId: string): Promise<RegressionProjection>`	Public method; parameters and return type are shown in the signature.
`projectReplay`	method	`projectReplay(runId: string): Promise<ReplayProjection>`	Public method; parameters and return type are shown in the signature.
`projectRun`	method	`projectRun(runId: string): Promise<RuntimeRun \| null>`	Public method; parameters and return type are shown in the signature.
`projectSession`	method	`projectSession(sessionId: string): Promise<RuntimeSession \| null>`	Public method; parameters and return type are shown in the signature.

`HarnessedReActFSMRunner`

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

Kind: class
Import: import { HarnessedReActFSMRunner } from '@codesoul-co/hypha-harness';
Source module: runtime

Declaration

text

export declare class HarnessedReActFSMRunner {
    constructor(options: HarnessedReActFSMRunnerOptions);
    run(input: HarnessedReActFSMRunInput): Promise<HarnessedReActFSMRunResult>;
}

Public members

Member	Kind	Signature	Description
`constructor`	constructor	`(options: HarnessedReActFSMRunnerOptions): HarnessedReActFSMRunner`	Creates an instance of this class.
`run`	method	`run(input: HarnessedReActFSMRunInput): Promise<HarnessedReActFSMRunResult>`	Public method; parameters and return type are shown in the signature.

`RunManager`

Run Manager class with 36 public constructor or member entries; its exact declarations are listed below.

Kind: class
Import: import { RunManager } from '@codesoul-co/hypha-harness';
Source module: runtime

Declaration

text

export declare class RunManager {
    constructor(options?: RunManagerOptions);
    eventRuntime(): EventFirstRuntime;
    createSession(input: CreateSessionInput): Promise<RuntimeSession>;
    createRun(input: CreateRunInput): Promise<RuntimeRun>;
    appendRunEvent(input: AppendRunEventInput): Promise<FrameworkEvent>;
    startRun(run: RuntimeRun, timestamp?: string): Promise<FrameworkEvent>;
    recordTransitionAccepted(context: RunExecutionContext, transition: StateTransition): Promise<FrameworkEvent>;
    recordStateEntered(context: RunExecutionContext, record: FSMStateEnteredRecord): Promise<FrameworkEvent>;
    recordContextBuildStarted(context: RunExecutionContext): Promise<FrameworkEvent>;
    recordContextBuildCompleted(context: RunExecutionContext, payload: Record<string, unknown>): Promise<FrameworkEvent>;
    recordSkillSelected(context: RunExecutionContext, payload: Record<string, unknown>): Promise<FrameworkEvent>;
    recordSkillLoaded(context: RunExecutionContext, payload: Record<string, unknown>): Promise<FrameworkEvent>;
    recordSkillCompleted(context: RunExecutionContext, payload: Record<string, unknown>): Promise<FrameworkEvent>;
    recordThinkingStarted(context: RunExecutionContext, payload: Record<string, unknown>): Promise<FrameworkEvent>;
    recordThinkingCompleted(context: RunExecutionContext, payload: Record<string, unknown>): Promise<FrameworkEvent>;
    recordAgentDeliberationStarted(context: RunExecutionContext, payload: Record<string, unknown>): Promise<FrameworkEvent>;
    recordAgentDeliberationCompleted(context: RunExecutionContext, payload: Record<string, unknown>): Promise<FrameworkEvent>;
    recordReasoningDecision(context: RunExecutionContext, payload: Record<string, unknown>): Promise<FrameworkEvent>;
    recordReactStep(context: RunExecutionContext, step: ReActStep): Promise<FrameworkEvent>;
    recordReactContinuationCheckpoint(context: RunExecutionContext, checkpoint: ReActContinuationCheckpoint): Promise<FrameworkEvent>;
    recordReactContinuationResumed(context: RunExecutionContext, checkpoint: ReActContinuationCheckpoint, resumedAt: string): Promise<FrameworkEvent>;
    recordReactContinuationSuspended(context: RunExecutionContext, result: ReActRunResult): Promise<FrameworkEvent>;
    completeRun(context: RunExecutionContext, output: unknown, timestamp?: string): Promise<FrameworkEvent>;
    waitForHumanReview(context: RunExecutionContext, payload?: Record<string, unknown>, timestamp?: string): Promise<FrameworkEvent>;
    recordHumanReviewRequested(context: RunExecutionContext, payload?: Record<string, unknown>, timestamp?: string): Promise<FrameworkEvent>;
    recordHumanReviewApproved(context: RunExecutionContext, payload?: Record<string, unknown>, timestamp?: string): Promise<FrameworkEvent>;
    recordHumanReviewRejected(context: RunExecutionContext, payload?: Record<string, unknown>, timestamp?: string): Promise<FrameworkEvent>;
    recordContextCompacted(context: RunExecutionContext, payload?: Record<string, unknown>, timestamp?: string): Promise<FrameworkEvent>;
    cancelRun(context: RunExecutionContext, reason?: string, timestamp?: string): Promise<FrameworkEvent>;
    failRun(context: RunExecutionContext, error: unknown, timestamp?: string): Promise<FrameworkEvent>;
    listEvents(runId: string): Promise<FrameworkEvent[]>;
    projectRun(runId: string): Promise<RuntimeRun | null>;
    projectSession(sessionId: string): Promise<RuntimeSession | null>;
    projectReplay(runId: string): Promise<ReplayProjection>;
    projectAudit(runId: string): Promise<AuditProjection>;
    projectRegression(runId: string): Promise<RegressionProjection>;
}

Public members

Member	Kind	Signature	Description
`appendRunEvent`	method	`appendRunEvent(input: AppendRunEventInput): Promise<FrameworkEvent>`	Public method; parameters and return type are shown in the signature.
`cancelRun`	method	`cancelRun(context: RunExecutionContext, reason?: string, timestamp?: string): Promise<FrameworkEvent>`	Public method; parameters and return type are shown in the signature.
`completeRun`	method	`completeRun(context: RunExecutionContext, output: unknown, timestamp?: string): Promise<FrameworkEvent>`	Public method; parameters and return type are shown in the signature.
`constructor`	constructor	`(options?: RunManagerOptions): RunManager`	Creates an instance of this class.
`createRun`	method	`createRun(input: CreateRunInput): Promise<RuntimeRun>`	Public method; parameters and return type are shown in the signature.
`createSession`	method	`createSession(input: CreateSessionInput): Promise<RuntimeSession>`	Public method; parameters and return type are shown in the signature.
`eventRuntime`	method	`eventRuntime(): EventFirstRuntime`	Public method; parameters and return type are shown in the signature.
`failRun`	method	`failRun(context: RunExecutionContext, error: unknown, timestamp?: string): Promise<FrameworkEvent>`	Public method; parameters and return type are shown in the signature.
`listEvents`	method	`listEvents(runId: string): Promise<FrameworkEvent[]>`	Public method; parameters and return type are shown in the signature.
`projectAudit`	method	`projectAudit(runId: string): Promise<AuditProjection>`	Public method; parameters and return type are shown in the signature.
`projectRegression`	method	`projectRegression(runId: string): Promise<RegressionProjection>`	Public method; parameters and return type are shown in the signature.
`projectReplay`	method	`projectReplay(runId: string): Promise<ReplayProjection>`	Public method; parameters and return type are shown in the signature.
`projectRun`	method	`projectRun(runId: string): Promise<RuntimeRun \| null>`	Public method; parameters and return type are shown in the signature.
`projectSession`	method	`projectSession(sessionId: string): Promise<RuntimeSession \| null>`	Public method; parameters and return type are shown in the signature.
`recordAgentDeliberationCompleted`	method	`recordAgentDeliberationCompleted(context: RunExecutionContext, payload: Record<string, unknown>): Promise<FrameworkEvent>`	Public method; parameters and return type are shown in the signature.
`recordAgentDeliberationStarted`	method	`recordAgentDeliberationStarted(context: RunExecutionContext, payload: Record<string, unknown>): Promise<FrameworkEvent>`	Public method; parameters and return type are shown in the signature.
`recordContextBuildCompleted`	method	`recordContextBuildCompleted(context: RunExecutionContext, payload: Record<string, unknown>): Promise<FrameworkEvent>`	Public method; parameters and return type are shown in the signature.
`recordContextBuildStarted`	method	`recordContextBuildStarted(context: RunExecutionContext): Promise<FrameworkEvent>`	Public method; parameters and return type are shown in the signature.
`recordContextCompacted`	method	`recordContextCompacted(context: RunExecutionContext, payload?: Record<string, unknown>, timestamp?: string): Promise<FrameworkEvent>`	Public method; parameters and return type are shown in the signature.
`recordHumanReviewApproved`	method	`recordHumanReviewApproved(context: RunExecutionContext, payload?: Record<string, unknown>, timestamp?: string): Promise<FrameworkEvent>`	Public method; parameters and return type are shown in the signature.
`recordHumanReviewRejected`	method	`recordHumanReviewRejected(context: RunExecutionContext, payload?: Record<string, unknown>, timestamp?: string): Promise<FrameworkEvent>`	Public method; parameters and return type are shown in the signature.
`recordHumanReviewRequested`	method	`recordHumanReviewRequested(context: RunExecutionContext, payload?: Record<string, unknown>, timestamp?: string): Promise<FrameworkEvent>`	Public method; parameters and return type are shown in the signature.
`recordReactContinuationCheckpoint`	method	`recordReactContinuationCheckpoint(context: RunExecutionContext, checkpoint: ReActContinuationCheckpoint): Promise<FrameworkEvent>`	Public method; parameters and return type are shown in the signature.
`recordReactContinuationResumed`	method	`recordReactContinuationResumed(context: RunExecutionContext, checkpoint: ReActContinuationCheckpoint, resumedAt: string): Promise<FrameworkEvent>`	Public method; parameters and return type are shown in the signature.
`recordReactContinuationSuspended`	method	`recordReactContinuationSuspended(context: RunExecutionContext, result: ReActRunResult): Promise<FrameworkEvent>`	Public method; parameters and return type are shown in the signature.
`recordReactStep`	method	`recordReactStep(context: RunExecutionContext, step: ReActStep): Promise<FrameworkEvent>`	Public method; parameters and return type are shown in the signature.
`recordReasoningDecision`	method	`recordReasoningDecision(context: RunExecutionContext, payload: Record<string, unknown>): Promise<FrameworkEvent>`	Public method; parameters and return type are shown in the signature.
`recordSkillCompleted`	method	`recordSkillCompleted(context: RunExecutionContext, payload: Record<string, unknown>): Promise<FrameworkEvent>`	Public method; parameters and return type are shown in the signature.
`recordSkillLoaded`	method	`recordSkillLoaded(context: RunExecutionContext, payload: Record<string, unknown>): Promise<FrameworkEvent>`	Public method; parameters and return type are shown in the signature.
`recordSkillSelected`	method	`recordSkillSelected(context: RunExecutionContext, payload: Record<string, unknown>): Promise<FrameworkEvent>`	Public method; parameters and return type are shown in the signature.
`recordStateEntered`	method	`recordStateEntered(context: RunExecutionContext, record: FSMStateEnteredRecord): Promise<FrameworkEvent>`	Public method; parameters and return type are shown in the signature.
`recordThinkingCompleted`	method	`recordThinkingCompleted(context: RunExecutionContext, payload: Record<string, unknown>): Promise<FrameworkEvent>`	Public method; parameters and return type are shown in the signature.
`recordThinkingStarted`	method	`recordThinkingStarted(context: RunExecutionContext, payload: Record<string, unknown>): Promise<FrameworkEvent>`	Public method; parameters and return type are shown in the signature.
`recordTransitionAccepted`	method	`recordTransitionAccepted(context: RunExecutionContext, transition: StateTransition): Promise<FrameworkEvent>`	Public method; parameters and return type are shown in the signature.
`startRun`	method	`startRun(run: RuntimeRun, timestamp?: string): Promise<FrameworkEvent>`	Public method; parameters and return type are shown in the signature.
`waitForHumanReview`	method	`waitForHumanReview(context: RunExecutionContext, payload?: Record<string, unknown>, timestamp?: string): Promise<FrameworkEvent>`	Public method; parameters and return type are shown in the signature.

`projectAudit`

Project Audit function with 1 public call signature; parameters and return types are listed below.

Kind: function
Import: import { projectAudit } from '@codesoul-co/hypha-harness';
Source module: runtime

Declaration

text

export declare function projectAudit(events: FrameworkEvent[]): AuditProjection;

Call signature

text

projectAudit(events: FrameworkEvent[]): AuditProjection

Parameters

Parameter	Type	Required	Description
`events`	`FrameworkEvent<unknown>[]`	Yes	Required parameter; accepted values are defined by the type column.

Returns

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

`projectReplay`

Project Replay function with 1 public call signature; parameters and return types are listed below.

Kind: function
Import: import { projectReplay } from '@codesoul-co/hypha-harness';
Source module: runtime

Declaration

text

export declare function projectReplay(events: FrameworkEvent[]): ReplayProjection;

Call signature

text

projectReplay(events: FrameworkEvent[]): ReplayProjection

Parameters

Parameter	Type	Required	Description
`events`	`FrameworkEvent<unknown>[]`	Yes	Required parameter; accepted values are defined by the type column.

Returns

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

`projectRun`

Project Run function with 1 public call signature; parameters and return types are listed below.

Kind: function
Import: import { projectRun } from '@codesoul-co/hypha-harness';
Source module: runtime

Declaration

text

export declare function projectRun(events: FrameworkEvent[]): RuntimeRun | null;

Call signature

text

projectRun(events: FrameworkEvent[]): RuntimeRun | null

Parameters

Parameter	Type	Required	Description
`events`	`FrameworkEvent<unknown>[]`	Yes	Required parameter; accepted values are defined by the type column.

Returns

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

`projectSession`

Project Session function with 1 public call signature; parameters and return types are listed below.

Kind: function
Import: import { projectSession } from '@codesoul-co/hypha-harness';
Source module: runtime

Declaration

text

export declare function projectSession(events: FrameworkEvent[]): RuntimeSession | null;

Call signature

text

projectSession(events: FrameworkEvent[]): RuntimeSession | null

Parameters

Parameter	Type	Required	Description
`events`	`FrameworkEvent<unknown>[]`	Yes	Required parameter; accepted values are defined by the type column.

Returns

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

`AppendRunEventInput`

Append Run Event Input interface with 11 public fields or methods.

Kind: interface
Import: import type { AppendRunEventInput } from '@codesoul-co/hypha-harness';
Source module: runtime

Declaration

text

export interface AppendRunEventInput<TPayload = unknown> {
    id: string;
    type: FrameworkEvent['type'];
    runId: string;
    sessionId: string;
    userId: string;
    payload: TPayload;
    stepId?: string;
    fsmState?: string;
    agentId?: string;
    timestamp?: string;
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
`agentId`	property	`agentId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`fsmState`	property	`fsmState?: 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.
`payload`	property	`payload: TPayload`	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.
`timestamp`	property	`timestamp?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`type`	property	`type: import("/Users/erwin/Downloads/codespace/Hypha/packages/core/dist/events").FrameworkEventType`	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.

`AuditProjection`

Audit Projection interface with 8 public fields or methods.

Kind: interface
Import: import type { AuditProjection } from '@codesoul-co/hypha-harness';
Source module: runtime

Declaration

text

export interface AuditProjection {
    runId: string;
    eventCount: number;
    policyDecisionCount: number;
    memoryWriteCount: number;
    reasoningDecisionCount: number;
    skillActivationCount: number;
    toolCallCount: number;
    missingRunIds: string[];
}

Contract members

Member	Kind	Signature	Description
`eventCount`	property	`eventCount: number`	Public property; its type, readonly modifier and optionality are shown in the signature.
`memoryWriteCount`	property	`memoryWriteCount: number`	Public property; its type, readonly modifier and optionality are shown in the signature.
`missingRunIds`	property	`missingRunIds: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`policyDecisionCount`	property	`policyDecisionCount: number`	Public property; its type, readonly modifier and optionality are shown in the signature.
`reasoningDecisionCount`	property	`reasoningDecisionCount: number`	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.
`skillActivationCount`	property	`skillActivationCount: number`	Public property; its type, readonly modifier and optionality are shown in the signature.
`toolCallCount`	property	`toolCallCount: number`	Public property; its type, readonly modifier and optionality are shown in the signature.

`CreateRunInput`

Create Run Input interface with 9 public fields or methods.

Kind: interface
Import: import type { CreateRunInput } from '@codesoul-co/hypha-harness';
Source module: runtime

Declaration

text

export interface CreateRunInput {
    id: string;
    sessionId: string;
    userId: string;
    domainPackRef?: SpecRef;
    workflowRef?: SpecRef;
    agentRef?: SpecRef;
    input?: unknown;
    metadata?: Record<string, unknown>;
    timestamp?: string;
}

Contract members

Member	Kind	Signature	Description
`agentRef`	property	`agentRef?: SpecRef`	Public property; its type, readonly modifier and optionality are shown in the signature.
`domainPackRef`	property	`domainPackRef?: SpecRef`	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.
`input`	property	`input?: unknown`	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.
`sessionId`	property	`sessionId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`timestamp`	property	`timestamp?: string`	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.
`workflowRef`	property	`workflowRef?: SpecRef`	Public property; its type, readonly modifier and optionality are shown in the signature.

`CreateSessionInput`

Create Session Input interface with 6 public fields or methods.

Kind: interface
Import: import type { CreateSessionInput } from '@codesoul-co/hypha-harness';
Source module: runtime

Declaration

text

export interface CreateSessionInput {
    id: string;
    userId: string;
    domainPackRef?: SpecRef;
    sessionProfileRef?: SpecRef;
    metadata?: Record<string, unknown>;
    timestamp?: string;
}

Contract members

Member	Kind	Signature	Description
`domainPackRef`	property	`domainPackRef?: SpecRef`	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.
`sessionProfileRef`	property	`sessionProfileRef?: SpecRef`	Public property; its type, readonly modifier and optionality are shown in the signature.
`timestamp`	property	`timestamp?: string`	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.

`HarnessedReActFSMRunInput`

Harnessed ReAct FSM Run Input interface with 16 public fields or methods.

Kind: interface
Import: import type { HarnessedReActFSMRunInput } from '@codesoul-co/hypha-harness';
Source module: runtime

Declaration

text

export interface HarnessedReActFSMRunInput<TInput = unknown> extends ContextBuildInput<TInput> {
    sessionId: string;
    userId: string;
    domainPackRef?: SpecRef;
    workflowRef?: SpecRef;
    createSession?: boolean;
    resumeFromCheckpoint?: boolean;
}

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.
`createSession`	property	`createSession?: boolean`	Public property; its type, readonly modifier and optionality are shown in the signature.
`domainPackRef`	property	`domainPackRef?: SpecRef`	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.
`resumeFromCheckpoint`	property	`resumeFromCheckpoint?: boolean`	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.
`workflowRef`	property	`workflowRef?: SpecRef`	Public property; its type, readonly modifier and optionality are shown in the signature.

`HarnessedReActFSMRunnerOptions`

Harnessed ReAct FSM Runner Options interface with 22 public fields or methods.

Kind: interface
Import: import type { HarnessedReActFSMRunnerOptions } from '@codesoul-co/hypha-harness';
Source module: runtime

Declaration

text

export interface HarnessedReActFSMRunnerOptions {
    inference: InferenceProvider;
    toolRunner?: ToolRunner;
    runManager?: RunManager;
    fsmSpec?: FSMProcessSpec;
    contextBuilder?: ContextBuilder;
    skillRegistry?: SkillRegistry;
    skillSelector?: SkillSelector;
    skillContextLoader?: SkillContextLoader;
    skillPolicy?: SkillPolicy;
    allowedSkills?: SkillContextBuilderOptions['allowedSkills'];
    requiredSkills?: SkillContextBuilderOptions['requiredSkills'];
    thinkingPlanner?: ThinkingPlanner;
    agenticReasoner?: AgenticReasoner;
    reasoningConfig?: ReasoningConfig;
    verifier?: Verifier;
    reactRuntime?: ReActAgentRuntime;
    maxIterations?: number;
    executionBudget?: Partial<ReActExecutionBudget>;
    reactCheckpointStore?: ReActContinuationCheckpointStore;
    continueAfterTool?: boolean;
    resolveToolExecutionScope?: (input: {
        fsmState: string;
        context: BuiltAgentContext;
        toolId: string;
    }) => ToolExecutionScope | undefined;
    now?: () => string;
}

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.
`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.
`fsmSpec`	property	`fsmSpec?: FSMProcessSpec`	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.
`reactCheckpointStore`	property	`reactCheckpointStore?: ReActContinuationCheckpointStore`	Public property; its type, readonly modifier and optionality are shown in the signature.
`reactRuntime`	property	`reactRuntime?: ReActAgentRuntime`	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.
`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?(input: { fsmState: string; context: BuiltAgentContext; toolId: string; }): ToolExecutionScope \| undefined`	Public method; parameters and return type are shown in the signature.
`runManager`	property	`runManager?: RunManager`	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.
`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.

`HarnessedReActFSMRunResult`

Harnessed ReAct FSM Run Result interface with 4 public fields or methods.

Kind: interface
Import: import type { HarnessedReActFSMRunResult } from '@codesoul-co/hypha-harness';
Source module: runtime

Declaration

text

export interface HarnessedReActFSMRunResult {
    run: RuntimeRun;
    react: ReActRunResult;
    fsmSnapshot: ReturnType<FSMRuntime['getSnapshot']>;
    events: FrameworkEvent[];
}

Contract members

Member	Kind	Signature	Description
`events`	property	`events: FrameworkEvent<unknown>[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`fsmSnapshot`	property	`fsmSnapshot: import("/Users/erwin/Downloads/codespace/Hypha/packages/fsm/dist/index").FSMSnapshot`	Public property; its type, readonly modifier and optionality are shown in the signature.
`react`	property	`react: ReActRunResult`	Public property; its type, readonly modifier and optionality are shown in the signature.
`run`	property	`run: RuntimeRun`	Public property; its type, readonly modifier and optionality are shown in the signature.

`RegressionProjection`

Regression Projection interface with 8 public fields or methods.

Kind: interface
Import: import type { RegressionProjection } from '@codesoul-co/hypha-harness';
Source module: runtime

Declaration

text

export interface RegressionProjection {
    runId: string;
    eventTypes: string[];
    statePath: string[];
    toolCalls: Array<{
        toolId?: unknown;
        status: string;
    }>;
    memoryWriteCount: number;
    reasoningDecisionCount: number;
    skillActivationCount: number;
    finalOutput?: unknown;
}

Contract members

Member	Kind	Signature	Description
`eventTypes`	property	`eventTypes: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`finalOutput`	property	`finalOutput?: unknown`	Public property; its type, readonly modifier and optionality are shown in the signature.
`memoryWriteCount`	property	`memoryWriteCount: number`	Public property; its type, readonly modifier and optionality are shown in the signature.
`reasoningDecisionCount`	property	`reasoningDecisionCount: number`	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.
`skillActivationCount`	property	`skillActivationCount: number`	Public property; its type, readonly modifier and optionality are shown in the signature.
`statePath`	property	`statePath: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`toolCalls`	property	`toolCalls: { toolId?: unknown; status: string; }[]`	Public property; its type, readonly modifier and optionality are shown in the signature.

`ReplayProjection`

Replay Projection interface with 16 public fields or methods.

Kind: interface
Import: import type { ReplayProjection } from '@codesoul-co/hypha-harness';
Source module: runtime

Declaration

text

export interface ReplayProjection {
    runId: string;
    events: FrameworkEvent[];
    statePath: string[];
    toolCallEventIds: string[];
    policyDecisionEventIds: string[];
    memoryEventIds: string[];
    reasoningEventIds: string[];
    skillEventIds: string[];
    modelCalls: FrameworkEvent[];
    toolCalls: FrameworkEvent[];
    memoryReads: FrameworkEvent[];
    memoryWrites: FrameworkEvent[];
    reasoningEvents: FrameworkEvent[];
    skillEvents: FrameworkEvent[];
    policyDecisions: FrameworkEvent[];
    finalOutput?: unknown;
}

Contract members

Member	Kind	Signature	Description
`events`	property	`events: FrameworkEvent<unknown>[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`finalOutput`	property	`finalOutput?: unknown`	Public property; its type, readonly modifier and optionality are shown in the signature.
`memoryEventIds`	property	`memoryEventIds: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`memoryReads`	property	`memoryReads: FrameworkEvent<unknown>[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`memoryWrites`	property	`memoryWrites: FrameworkEvent<unknown>[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`modelCalls`	property	`modelCalls: FrameworkEvent<unknown>[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`policyDecisionEventIds`	property	`policyDecisionEventIds: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`policyDecisions`	property	`policyDecisions: FrameworkEvent<unknown>[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`reasoningEventIds`	property	`reasoningEventIds: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`reasoningEvents`	property	`reasoningEvents: FrameworkEvent<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.
`skillEventIds`	property	`skillEventIds: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`skillEvents`	property	`skillEvents: FrameworkEvent<unknown>[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`statePath`	property	`statePath: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`toolCallEventIds`	property	`toolCallEventIds: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`toolCalls`	property	`toolCalls: FrameworkEvent<unknown>[]`	Public property; its type, readonly modifier and optionality are shown in the signature.

`RunExecutionContext`

Run Execution Context interface with 4 public fields or methods.

Kind: interface
Import: import type { RunExecutionContext } from '@codesoul-co/hypha-harness';
Source module: runtime

Declaration

text

export interface RunExecutionContext {
    runId: string;
    sessionId: string;
    userId: string;
    agentId?: string;
}

Contract members

Member	Kind	Signature	Description
`agentId`	property	`agentId?: 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.
`sessionId`	property	`sessionId: string`	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.

`RunManagerOptions`

Run Manager Options interface with 2 public fields or methods.

Kind: interface
Import: import type { RunManagerOptions } from '@codesoul-co/hypha-harness';
Source module: runtime

Declaration

text

export interface RunManagerOptions {
    runtime?: EventFirstRuntime;
    operationalTelemetry?: RuntimeOperationalTelemetry;
}

Contract members

Member	Kind	Signature	Description
`operationalTelemetry`	property	`operationalTelemetry?: RuntimeOperationalTelemetry`	Public property; its type, readonly modifier and optionality are shown in the signature.
`runtime`	property	`runtime?: EventFirstRuntime`	Public property; its type, readonly modifier and optionality are shown in the signature.

`RuntimeRun`

Runtime Run interface with 12 public fields or methods.

Kind: interface
Import: import type { RuntimeRun } from '@codesoul-co/hypha-harness';
Source module: runtime

Declaration

text

export interface RuntimeRun {
    id: string;
    sessionId: string;
    userId: string;
    domainPackRef?: SpecRef;
    workflowRef?: SpecRef;
    agentRef?: SpecRef;
    status: 'queued' | 'running' | 'waiting_human' | 'completed' | 'failed' | 'cancelled';
    createdAt: string;
    updatedAt: string;
    completedAt?: string;
    input?: unknown;
    output?: unknown;
}

Contract members

Member	Kind	Signature	Description
`agentRef`	property	`agentRef?: SpecRef`	Public property; its type, readonly modifier and optionality are shown in the signature.
`completedAt`	property	`completedAt?: 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.
`domainPackRef`	property	`domainPackRef?: SpecRef`	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.
`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.
`sessionId`	property	`sessionId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`status`	property	`status: "completed" \| "queued" \| "running" \| "cancelled" \| "failed" \| "waiting_human"`	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.
`userId`	property	`userId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`workflowRef`	property	`workflowRef?: SpecRef`	Public property; its type, readonly modifier and optionality are shown in the signature.

`RuntimeSession`

Runtime Session interface with 8 public fields or methods.

Kind: interface
Import: import type { RuntimeSession } from '@codesoul-co/hypha-harness';
Source module: runtime

Declaration

text

export interface RuntimeSession {
    id: string;
    userId: string;
    domainPackRef?: SpecRef;
    sessionProfileRef?: SpecRef;
    metadata: Record<string, unknown>;
    status: 'active' | 'closed';
    createdAt: string;
    updatedAt: string;
}

Contract members

Member	Kind	Signature	Description
`createdAt`	property	`createdAt: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`domainPackRef`	property	`domainPackRef?: SpecRef`	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.
`sessionProfileRef`	property	`sessionProfileRef?: SpecRef`	Public property; its type, readonly modifier and optionality are shown in the signature.
`status`	property	`status: "active" \| "closed"`	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.
`userId`	property	`userId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

@codesoul-co/hypha-harness / runtime ​

Using this module ​

Import from the package entrypoint ​

Usage patterns ​

Public exports ​

EventFirstRuntime ​

Declaration ​

Public members ​

HarnessedReActFSMRunner ​

Declaration ​

Public members ​

RunManager ​

Declaration ​

Public members ​

projectAudit ​

Declaration ​

Call signature ​

Parameters ​

Returns ​

projectReplay ​

Declaration ​

Call signature ​

Parameters ​

Returns ​

projectRun ​

Declaration ​

Call signature ​

Parameters ​

Returns ​

projectSession ​

Declaration ​

Call signature ​

Parameters ​

Returns ​

AppendRunEventInput ​

Declaration ​

Contract members ​

AuditProjection ​

Declaration ​

Contract members ​

CreateRunInput ​

Declaration ​

Contract members ​

CreateSessionInput ​

Declaration ​

Contract members ​

HarnessedReActFSMRunInput ​

Declaration ​

Contract members ​

HarnessedReActFSMRunnerOptions ​

Declaration ​

Contract members ​

HarnessedReActFSMRunResult ​

Declaration ​

Contract members ​

RegressionProjection ​

Declaration ​

Contract members ​

ReplayProjection ​

Declaration ​

Contract members ​

RunExecutionContext ​

Declaration ​

Contract members ​

RunManagerOptions ​

Declaration ​

Contract members ​

RuntimeRun ​

Declaration ​

Contract members ​

RuntimeSession ​

Declaration ​

Contract members ​

`@codesoul-co/hypha-harness` / `runtime`

Using this module

Import from the package entrypoint

Usage patterns

Public exports

`EventFirstRuntime`

Declaration

Public members

`HarnessedReActFSMRunner`

Declaration

Public members

`RunManager`

Declaration

Public members

`projectAudit`

Declaration

Call signature

Parameters

Returns

`projectReplay`

Declaration

Call signature

Parameters

Returns

`projectRun`

Declaration

Call signature

Parameters

Returns

`projectSession`

Declaration

Call signature

Parameters

Returns

`AppendRunEventInput`

Declaration

Contract members

`AuditProjection`

Declaration

Contract members

`CreateRunInput`

Declaration

Contract members

`CreateSessionInput`

Declaration

Contract members

`HarnessedReActFSMRunInput`

Declaration

Contract members

`HarnessedReActFSMRunnerOptions`

Declaration

Contract members

`HarnessedReActFSMRunResult`

Declaration

Contract members

`RegressionProjection`

Declaration

Contract members

`ReplayProjection`

Declaration

Contract members

`RunExecutionContext`

Declaration

Contract members

`RunManagerOptions`

Declaration

Contract members

`RuntimeRun`

Declaration

Contract members

`RuntimeSession`

Declaration

Contract members