@codesoul-co/hypha-harness / react-quantum-executor
- Package index:
@codesoul-co/hypha-harness - Source:
packages/harness/src/react-quantum-executor.ts - Exports: 19
Using this module
Use the React quantum executor module for executing runtime behavior at this boundary. It exports 3 classes, 1 constant, 1 function, 13 interfaces, 1 type.
Import from the package entrypoint
import {
ArtifactReActContextSnapshotStore,
ContinuationIdentityValidator,
ReActQuantumExecutor,
REACT_CONTEXT_SNAPSHOT_VERSION,
createContinuationReActQuantumDescriptor,
} from '@codesoul-co/hypha-harness';
import type {
ArtifactReActContextSnapshotStoreOptions,
ExecuteReActQuantumRequest,
ExecuteReActQuantumResult,
ReActContextSnapshot,
ReActContextSnapshotPutResult,
ReActContextSnapshotStore,
ReActOperationReceiptReconciler,
ReActQuantumExecutorOptions,
} from '@codesoul-co/hypha-harness';
// The complete export list is documented below.Usage patterns
- Use the 14 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 1 function as direct operation entrypoints. Every overload, required/optional parameter, and return type is documented below.
- The 1 constant/enum export provides stable values, schemas, definitions, or defaults. Reuse these exports instead of copying internal values into an application.
Public exports
| Symbol | Kind | Signature | Description |
|---|---|---|---|
ArtifactReActContextSnapshotStore | class | new ArtifactReActContextSnapshotStore(options: ArtifactReActContextSnapshotStoreOptions): ArtifactReActContextSnapshotStore | Durable content-addressed Context snapshots selected by the checkpoint scope hash. |
ContinuationIdentityValidator | class | new ContinuationIdentityValidator(): ContinuationIdentityValidator | Continuation Identity Validator class with 5 public constructor or member entries; its exact declarations are listed below. |
ReActQuantumExecutor | class | new ReActQuantumExecutor(options: ReActQuantumExecutorOptions): ReActQuantumExecutor | Rebuilds and executes exactly one fenced ReAct quantum from durable Runtime evidence. |
REACT_CONTEXT_SNAPSHOT_VERSION | constant | const REACT_CONTEXT_SNAPSHOT_VERSION: "1.0.0" | REACT CONTEXT SNAPSHOT VERSION constant exported by the react-quantum-executor module. |
createContinuationReActQuantumDescriptor | function | createContinuationReActQuantumDescriptor(command: Readonly<SessionCommandRecord>, input: unknown): ContinuationReActQuantumDescriptor | Create Continuation ReAct Quantum Descriptor function with 1 public call signature; parameters and return types are listed below. |
ArtifactReActContextSnapshotStoreOptions | interface | interface ArtifactReActContextSnapshotStoreOptions | Artifact ReAct Context Snapshot Store Options interface with 2 public fields or methods. |
ExecuteReActQuantumRequest | interface | interface ExecuteReActQuantumRequest | Execute ReAct Quantum Request interface with 3 public fields or methods. |
ExecuteReActQuantumResult | interface | interface ExecuteReActQuantumResult | Execute ReAct Quantum Result interface with 2 public fields or methods. |
ReActContextSnapshot | interface | interface ReActContextSnapshot | ReAct Context Snapshot interface with 7 public fields or methods. |
ReActContextSnapshotPutResult | interface | interface ReActContextSnapshotPutResult | ReAct Context Snapshot Put Result interface with 3 public fields or methods. |
ReActContextSnapshotStore | interface | interface ReActContextSnapshotStore | ReAct Context Snapshot Store interface with 3 public fields or methods. |
ReActOperationReceiptReconciler | interface | interface ReActOperationReceiptReconciler | ReAct Operation Receipt Reconciler interface with 1 public fields or methods. |
ReActQuantumExecutorOptions | interface | interface ReActQuantumExecutorOptions | ReAct Quantum Executor Options interface with 10 public fields or methods. |
ReActQuantumOutcomeRecorder | interface | interface ReActQuantumOutcomeRecorder | ReAct Quantum Outcome Recorder interface with 1 public fields or methods. |
ReActQuantumRevisionValidator | interface | interface ReActQuantumRevisionValidator | ReAct Quantum Revision Validator interface with 1 public fields or methods. |
ReActQuantumRunnerFactory | interface | interface ReActQuantumRunnerFactory | ReAct Quantum Runner Factory interface with 1 public fields or methods. |
ReActQuantumRuntimeReader | interface | interface ReActQuantumRuntimeReader | ReAct Quantum Runtime Reader interface with 1 public fields or methods. |
ReActQuantumRuntimeState | interface | interface ReActQuantumRuntimeState | ReAct Quantum Runtime State interface with 10 public fields or methods. |
ReActQuantumRuntimeStatus | type | type ReActQuantumRuntimeStatus = 'created' | 'running' | 'waiting_human' | 'completed' | 'failed' | 'cancelled' | Public type alias for ReAct Quantum Runtime Status; the declaration contains its complete type expression. |
ArtifactReActContextSnapshotStore
Durable content-addressed Context snapshots selected by the checkpoint scope hash.
- Kind: class
- Import:
import { ArtifactReActContextSnapshotStore } from '@codesoul-co/hypha-harness'; - Source module:
react-quantum-executor
Declaration
export declare class ArtifactReActContextSnapshotStore implements ReActContextSnapshotStore {
constructor(options: ArtifactReActContextSnapshotStoreOptions);
put(input: ReActContextSnapshot): Promise<ReActContextSnapshotPutResult>;
get(scopeHash: string): Promise<ReActContextSnapshot | null>;
delete(scopeHash: string): Promise<boolean>;
}Public members
| Member | Kind | Signature | Description |
|---|---|---|---|
constructor | constructor | (options: ArtifactReActContextSnapshotStoreOptions): ArtifactReActContextSnapshotStore | Creates an instance of this class. |
delete | method | delete(scopeHash: string): Promise<boolean> | Public method; parameters and return type are shown in the signature. |
get | method | get(scopeHash: string): Promise<ReActContextSnapshot | null> | Public method; parameters and return type are shown in the signature. |
put | method | put(input: ReActContextSnapshot): Promise<ReActContextSnapshotPutResult> | Public method; parameters and return type are shown in the signature. |
ContinuationIdentityValidator
Continuation Identity Validator class with 5 public constructor or member entries; its exact declarations are listed below.
- Kind: class
- Import:
import { ContinuationIdentityValidator } from '@codesoul-co/hypha-harness'; - Source module:
react-quantum-executor
Declaration
export declare class ContinuationIdentityValidator {
validateCommand(command: Readonly<SessionCommandRecord>, descriptor: Readonly<ContinuationReActQuantumDescriptor>): void;
validateCheckpoint(descriptor: Readonly<ContinuationReActQuantumDescriptor>, checkpoint: Readonly<ReActContinuationCheckpoint>, checkpointRef: string): void;
validateSnapshot(descriptor: Readonly<ReActQuantumDescriptor>, snapshot: Readonly<ReActContextSnapshot>): void;
validateRuntimeState(descriptor: Readonly<ReActQuantumDescriptor>, state: Readonly<ReActQuantumRuntimeState>): void;
}Public members
| Member | Kind | Signature | Description |
|---|---|---|---|
constructor | constructor | (): ContinuationIdentityValidator | Creates an instance of this class. |
validateCheckpoint | method | validateCheckpoint(descriptor: Readonly<ContinuationReActQuantumDescriptor>, checkpoint: Readonly<ReActContinuationCheckpoint>, checkpointRef: string): void | Public method; parameters and return type are shown in the signature. |
validateCommand | method | validateCommand(command: Readonly<SessionCommandRecord>, descriptor: Readonly<ContinuationReActQuantumDescriptor>): void | Public method; parameters and return type are shown in the signature. |
validateRuntimeState | method | validateRuntimeState(descriptor: Readonly<ReActQuantumDescriptor>, state: Readonly<ReActQuantumRuntimeState>): void | Public method; parameters and return type are shown in the signature. |
validateSnapshot | method | validateSnapshot(descriptor: Readonly<ReActQuantumDescriptor>, snapshot: Readonly<ReActContextSnapshot>): void | Public method; parameters and return type are shown in the signature. |
ReActQuantumExecutor
Rebuilds and executes exactly one fenced ReAct quantum from durable Runtime evidence.
- Kind: class
- Import:
import { ReActQuantumExecutor } from '@codesoul-co/hypha-harness'; - Source module:
react-quantum-executor
Declaration
export declare class ReActQuantumExecutor {
constructor(options: ReActQuantumExecutorOptions);
runOneQuantum(input: ExecuteReActQuantumRequest): Promise<ExecuteReActQuantumResult>;
}Public members
| Member | Kind | Signature | Description |
|---|---|---|---|
constructor | constructor | (options: ReActQuantumExecutorOptions): ReActQuantumExecutor | Creates an instance of this class. |
runOneQuantum | method | runOneQuantum(input: ExecuteReActQuantumRequest): Promise<ExecuteReActQuantumResult> | Public method; parameters and return type are shown in the signature. |
REACT_CONTEXT_SNAPSHOT_VERSION
REACT CONTEXT SNAPSHOT VERSION constant exported by the react-quantum-executor module.
- Kind: constant
- Import:
import { REACT_CONTEXT_SNAPSHOT_VERSION } from '@codesoul-co/hypha-harness'; - Source module:
react-quantum-executor
Declaration
export declare const REACT_CONTEXT_SNAPSHOT_VERSION: "1.0.0";createContinuationReActQuantumDescriptor
Create Continuation ReAct Quantum Descriptor function with 1 public call signature; parameters and return types are listed below.
- Kind: function
- Import:
import { createContinuationReActQuantumDescriptor } from '@codesoul-co/hypha-harness'; - Source module:
react-quantum-executor
Declaration
export declare function createContinuationReActQuantumDescriptor(command: Readonly<SessionCommandRecord>, input: unknown): ContinuationReActQuantumDescriptor;Call signature
createContinuationReActQuantumDescriptor(command: Readonly<SessionCommandRecord>, input: unknown): ContinuationReActQuantumDescriptorParameters
| Parameter | Type | Required | Description |
|---|---|---|---|
command | Readonly<SessionCommandRecord> | Yes | Required parameter; accepted values are defined by the type column. |
input | unknown | Yes | Required parameter; accepted values are defined by the type column. |
Returns
- Type:
ContinuationReActQuantumDescriptor - Description: The return contract is defined by the type shown above.
ArtifactReActContextSnapshotStoreOptions
Artifact ReAct Context Snapshot Store Options interface with 2 public fields or methods.
- Kind: interface
- Import:
import type { ArtifactReActContextSnapshotStoreOptions } from '@codesoul-co/hypha-harness'; - Source module:
react-quantum-executor
Declaration
export interface ArtifactReActContextSnapshotStoreOptions {
artifacts: ArtifactStoreProvider;
maxSnapshotBytes?: number;
}Contract members
| Member | Kind | Signature | Description |
|---|---|---|---|
artifacts | property | artifacts: ArtifactStoreProvider | Public property; its type, readonly modifier and optionality are shown in the signature. |
maxSnapshotBytes | property | maxSnapshotBytes?: number | Public property; its type, readonly modifier and optionality are shown in the signature. |
ExecuteReActQuantumRequest
Execute ReAct Quantum Request interface with 3 public fields or methods.
- Kind: interface
- Import:
import type { ExecuteReActQuantumRequest } from '@codesoul-co/hypha-harness'; - Source module:
react-quantum-executor
Declaration
export interface ExecuteReActQuantumRequest {
command?: Readonly<SessionCommandRecord>;
descriptor: ReActQuantumDescriptor;
signal: AbortSignal;
}Contract members
| Member | Kind | Signature | Description |
|---|---|---|---|
command | property | command?: Readonly<SessionCommandRecord> | Public property; its type, readonly modifier and optionality are shown in the signature. |
descriptor | property | descriptor: ReActQuantumDescriptor | Public property; its type, readonly modifier and optionality are shown in the signature. |
signal | property | signal: AbortSignal | Public property; its type, readonly modifier and optionality are shown in the signature. |
ExecuteReActQuantumResult
Execute ReAct Quantum Result interface with 2 public fields or methods.
- Kind: interface
- Import:
import type { ExecuteReActQuantumResult } from '@codesoul-co/hypha-harness'; - Source module:
react-quantum-executor
Declaration
export interface ExecuteReActQuantumResult {
disposition: 'completed' | 'suspended' | 'waiting_human' | 'cancelled' | 'failed' | 'terminal';
react?: ReActRunResult;
}Contract members
| Member | Kind | Signature | Description |
|---|---|---|---|
disposition | property | disposition: "completed" | "cancelled" | "failed" | "suspended" | "waiting_human" | "terminal" | 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. |
ReActContextSnapshot
ReAct Context Snapshot interface with 7 public fields or methods.
- Kind: interface
- Import:
import type { ReActContextSnapshot } from '@codesoul-co/hypha-harness'; - Source module:
react-quantum-executor
Declaration
export interface ReActContextSnapshot {
version: typeof REACT_CONTEXT_SNAPSHOT_VERSION;
runId: string;
stepId: string;
scopeHash: string;
agentRef: SpecRef;
context: ReActRunContext;
createdAt: string;
}Contract members
| Member | Kind | Signature | Description |
|---|---|---|---|
agentRef | property | agentRef: SpecRef | Public property; its type, readonly modifier and optionality are shown in the signature. |
context | property | context: ReActRunContext | 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. |
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. |
version | property | version: "1.0.0" | Public property; its type, readonly modifier and optionality are shown in the signature. |
ReActContextSnapshotPutResult
ReAct Context Snapshot Put Result interface with 3 public fields or methods.
- Kind: interface
- Import:
import type { ReActContextSnapshotPutResult } from '@codesoul-co/hypha-harness'; - Source module:
react-quantum-executor
Declaration
export interface ReActContextSnapshotPutResult {
snapshot: ReActContextSnapshot;
snapshotHash: string;
reused: boolean;
}Contract members
| Member | Kind | Signature | Description |
|---|---|---|---|
reused | property | reused: boolean | Public property; its type, readonly modifier and optionality are shown in the signature. |
snapshot | property | snapshot: ReActContextSnapshot | Public property; its type, readonly modifier and optionality are shown in the signature. |
snapshotHash | property | snapshotHash: string | Public property; its type, readonly modifier and optionality are shown in the signature. |
ReActContextSnapshotStore
ReAct Context Snapshot Store interface with 3 public fields or methods.
- Kind: interface
- Import:
import type { ReActContextSnapshotStore } from '@codesoul-co/hypha-harness'; - Source module:
react-quantum-executor
Declaration
export interface ReActContextSnapshotStore {
put(snapshot: ReActContextSnapshot): Promise<ReActContextSnapshotPutResult>;
get(scopeHash: string): Promise<ReActContextSnapshot | null>;
delete(scopeHash: string): Promise<boolean>;
}Contract members
| Member | Kind | Signature | Description |
|---|---|---|---|
delete | method | delete(scopeHash: string): Promise<boolean> | Public method; parameters and return type are shown in the signature. |
get | method | get(scopeHash: string): Promise<ReActContextSnapshot | null> | Public method; parameters and return type are shown in the signature. |
put | method | put(snapshot: ReActContextSnapshot): Promise<ReActContextSnapshotPutResult> | Public method; parameters and return type are shown in the signature. |
ReActOperationReceiptReconciler
ReAct Operation Receipt Reconciler interface with 1 public fields or methods.
- Kind: interface
- Import:
import type { ReActOperationReceiptReconciler } from '@codesoul-co/hypha-harness'; - Source module:
react-quantum-executor
Declaration
export interface ReActOperationReceiptReconciler {
reconcile(input: {
descriptor: Readonly<ReActQuantumDescriptor>;
receiptRefs: readonly string[];
signal: AbortSignal;
}): Promise<void>;
}Contract members
| Member | Kind | Signature | Description |
|---|---|---|---|
reconcile | method | reconcile(input: { descriptor: Readonly<ReActQuantumDescriptor>; receiptRefs: readonly string[]; signal: AbortSignal; }): Promise<void> | Public method; parameters and return type are shown in the signature. |
ReActQuantumExecutorOptions
ReAct Quantum Executor Options interface with 10 public fields or methods.
- Kind: interface
- Import:
import type { ReActQuantumExecutorOptions } from '@codesoul-co/hypha-harness'; - Source module:
react-quantum-executor
Declaration
export interface ReActQuantumExecutorOptions {
checkpoints: ReActContinuationCheckpointStore;
contextSnapshots: ReActContextSnapshotStore;
runtime: ReActQuantumRuntimeReader;
runnerFactory: ReActQuantumRunnerFactory;
outcomeRecorder: ReActQuantumOutcomeRecorder;
revisionValidator?: ReActQuantumRevisionValidator;
receiptReconciler?: ReActOperationReceiptReconciler;
checkpointReferenceFor?: (checkpoint: Readonly<ReActContinuationCheckpoint>) => string;
quantumIterations: number;
now?: () => string;
}Contract members
| Member | Kind | Signature | Description |
|---|---|---|---|
checkpointReferenceFor | method | checkpointReferenceFor?(checkpoint: Readonly<ReActContinuationCheckpoint>): string | Public method; parameters and return type are shown in the signature. |
checkpoints | property | checkpoints: ReActContinuationCheckpointStore | Public property; its type, readonly modifier and optionality are shown in the signature. |
contextSnapshots | property | contextSnapshots: ReActContextSnapshotStore | 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. |
outcomeRecorder | property | outcomeRecorder: ReActQuantumOutcomeRecorder | 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. |
receiptReconciler | property | receiptReconciler?: ReActOperationReceiptReconciler | Public property; its type, readonly modifier and optionality are shown in the signature. |
revisionValidator | property | revisionValidator?: ReActQuantumRevisionValidator | Public property; its type, readonly modifier and optionality are shown in the signature. |
runnerFactory | property | runnerFactory: ReActQuantumRunnerFactory | Public property; its type, readonly modifier and optionality are shown in the signature. |
runtime | property | runtime: ReActQuantumRuntimeReader | Public property; its type, readonly modifier and optionality are shown in the signature. |
ReActQuantumOutcomeRecorder
ReAct Quantum Outcome Recorder interface with 1 public fields or methods.
- Kind: interface
- Import:
import type { ReActQuantumOutcomeRecorder } from '@codesoul-co/hypha-harness'; - Source module:
react-quantum-executor
Declaration
export interface ReActQuantumOutcomeRecorder {
record(input: {
descriptor: Readonly<ReActQuantumDescriptor>;
state: Readonly<ReActQuantumRuntimeState>;
react: Readonly<ReActRunResult>;
disposition: Exclude<ExecuteReActQuantumResult['disposition'], 'terminal'>;
signal: AbortSignal;
}): Promise<void>;
}Contract members
| Member | Kind | Signature | Description |
|---|---|---|---|
record | method | record(input: { descriptor: Readonly<ReActQuantumDescriptor>; state: Readonly<ReActQuantumRuntimeState>; react: Readonly<ReActRunResult>; disposition: Exclude<ExecuteReActQuantumResult["disposition"], "terminal">; signal: AbortSignal; }): Promise<void> | Public method; parameters and return type are shown in the signature. |
ReActQuantumRevisionValidator
ReAct Quantum Revision Validator interface with 1 public fields or methods.
- Kind: interface
- Import:
import type { ReActQuantumRevisionValidator } from '@codesoul-co/hypha-harness'; - Source module:
react-quantum-executor
Declaration
export interface ReActQuantumRevisionValidator {
validate(descriptor: Readonly<ReActQuantumDescriptor>, state: Readonly<ReActQuantumRuntimeState>): Promise<void>;
}Contract members
| Member | Kind | Signature | Description |
|---|---|---|---|
validate | method | validate(descriptor: Readonly<ReActQuantumDescriptor>, state: Readonly<ReActQuantumRuntimeState>): Promise<void> | Public method; parameters and return type are shown in the signature. |
ReActQuantumRunnerFactory
ReAct Quantum Runner Factory interface with 1 public fields or methods.
- Kind: interface
- Import:
import type { ReActQuantumRunnerFactory } from '@codesoul-co/hypha-harness'; - Source module:
react-quantum-executor
Declaration
export interface ReActQuantumRunnerFactory {
create(input: {
descriptor: Readonly<ReActQuantumDescriptor>;
state: Readonly<ReActQuantumRuntimeState>;
snapshot: Readonly<ReActContextSnapshot>;
signal: AbortSignal;
}): Promise<Pick<ReActRunner, 'run'>>;
}Contract members
| Member | Kind | Signature | Description |
|---|---|---|---|
create | method | create(input: { descriptor: Readonly<ReActQuantumDescriptor>; state: Readonly<ReActQuantumRuntimeState>; snapshot: Readonly<ReActContextSnapshot>; signal: AbortSignal; }): Promise<Pick<ReActRunner, "run">> | Public method; parameters and return type are shown in the signature. |
ReActQuantumRuntimeReader
ReAct Quantum Runtime Reader interface with 1 public fields or methods.
- Kind: interface
- Import:
import type { ReActQuantumRuntimeReader } from '@codesoul-co/hypha-harness'; - Source module:
react-quantum-executor
Declaration
export interface ReActQuantumRuntimeReader {
replay(descriptor: Readonly<ReActQuantumDescriptor>): Promise<ReActQuantumRuntimeState>;
}Contract members
| Member | Kind | Signature | Description |
|---|---|---|---|
replay | method | replay(descriptor: Readonly<ReActQuantumDescriptor>): Promise<ReActQuantumRuntimeState> | Public method; parameters and return type are shown in the signature. |
ReActQuantumRuntimeState
ReAct Quantum Runtime State interface with 10 public fields or methods.
- Kind: interface
- Import:
import type { ReActQuantumRuntimeState } from '@codesoul-co/hypha-harness'; - Source module:
react-quantum-executor
Declaration
export interface ReActQuantumRuntimeState {
runId: string;
sessionId: string;
userId: string;
status: ReActQuantumRuntimeStatus;
cancellationRevision: number;
agentRef: SpecRef;
domainPackRef: SpecRef;
workflowRef?: SpecRef;
promptSnapshotHash: string;
capabilitySnapshotHash: string;
}Contract members
| Member | Kind | Signature | Description |
|---|---|---|---|
agentRef | property | agentRef: SpecRef | Public property; its type, readonly modifier and optionality are shown in the signature. |
cancellationRevision | property | cancellationRevision: number | Public property; its type, readonly modifier and optionality are shown in the signature. |
capabilitySnapshotHash | property | capabilitySnapshotHash: 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. |
promptSnapshotHash | property | promptSnapshotHash: 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. |
status | property | status: ReActQuantumRuntimeStatus | 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. |
ReActQuantumRuntimeStatus
Public type alias for ReAct Quantum Runtime Status; the declaration contains its complete type expression.
- Kind: type
- Import:
import type { ReActQuantumRuntimeStatus } from '@codesoul-co/hypha-harness'; - Source module:
react-quantum-executor
Declaration
export type ReActQuantumRuntimeStatus = 'created' | 'running' | 'waiting_human' | 'completed' | 'failed' | 'cancelled';