`@codesoul-co/hypha-tools` / `execution-adapter`

Package index: @codesoul-co/hypha-tools
Source: packages/tools/src/execution-adapter.ts
Exports: 18

Using this module

Use the Execution adapter module for binding external or local providers to Hypha ports. It exports 2 classes, 1 constant, 3 functions, 10 interfaces, 2 types.

Import from the package entrypoint

import {
  ExecutionToolAdapter,
  ExecutionToolTerminalError,
  EXECUTION_TOOL_TERMINAL_STATES,
  hashExecutionToolInput,
  normalizeExecutionToolInput,
  validateExecutionToolRuntimeRequest,
} from '@codesoul-co/hypha-tools';

import type {
  ExecutionToolAdapterOptions,
  ExecutionToolDispatchFactoryRequest,
  ExecutionToolDispatchPlan,
  ExecutionToolEvidence,
  ExecutionToolObservation,
  ExecutionToolProvenance,
  ExecutionToolRuntimePort,
  ExecutionToolRuntimeRequest,
} from '@codesoul-co/hypha-tools';

// The complete export list is documented below.

Usage patterns

Use the 12 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 2 classes as constructable runtime implementations. Each symbol entry lists its constructor and public methods.
The module exposes 3 functions 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
`ExecutionToolAdapter`	class	`new ExecutionToolAdapter<TInput = unknown>(id: string, port: ExecutionToolRuntimePort, createDispatch: ExecutionToolDispatchFactory<TInput>, options: ExecutionToolAdapterOptions): ExecutionToolAdapter<TInput>`	Execution Tool Adapter class with 8 public constructor or member entries; its exact declarations are listed below.
`ExecutionToolTerminalError`	class	`new ExecutionToolTerminalError(observation: ExecutionToolObservation): ExecutionToolTerminalError`	Execution Tool Terminal Error class with 13 public constructor or member entries; its exact declarations are listed below.
`EXECUTION_TOOL_TERMINAL_STATES`	constant	`const EXECUTION_TOOL_TERMINAL_STATES: readonly ["completed", "failed", "timed_out", "cancelled", "unknown", "quarantined"]`	EXECUTION TOOL TERMINAL STATES constant exported by the `execution-adapter` module.
`hashExecutionToolInput`	function	`hashExecutionToolInput(input: unknown): string`	Hash Execution Tool Input function with 1 public call signature; parameters and return types are listed below.
`normalizeExecutionToolInput`	function	`normalizeExecutionToolInput<TInput>(input: TInput): TInput`	Normalize Execution Tool Input function with 1 public call signature; parameters and return types are listed below.
`validateExecutionToolRuntimeRequest`	function	`validateExecutionToolRuntimeRequest<TInput>(input: ExecutionToolRuntimeRequest<TInput>): ExecutionToolRuntimeRequest<TInput>`	Recomputes the normalized input digest at the Execution boundary. Runtime-port implementations must call this validator before delegating to a provider.
`ExecutionToolAdapterOptions`	interface	`interface ExecutionToolAdapterOptions`	Execution Tool Adapter Options interface with 6 public fields or methods.
`ExecutionToolDispatchFactoryRequest`	interface	`interface ExecutionToolDispatchFactoryRequest extends AdapterExecutionRequest<TInput>`	Execution Tool Dispatch Factory Request interface with 6 public fields or methods.
`ExecutionToolDispatchPlan`	interface	`interface ExecutionToolDispatchPlan`	Execution Tool Dispatch Plan interface with 3 public fields or methods.
`ExecutionToolEvidence`	interface	`interface ExecutionToolEvidence`	Execution Tool Evidence interface with 4 public fields or methods.
`ExecutionToolObservation`	interface	`interface ExecutionToolObservation extends ExecutionToolRuntimeResult`	Execution Tool Observation interface with 14 public fields or methods.
`ExecutionToolProvenance`	interface	`interface ExecutionToolProvenance`	Execution Tool Provenance interface with 7 public fields or methods.
`ExecutionToolRuntimePort`	interface	`interface ExecutionToolRuntimePort`	Execution Tool Runtime Port interface with 3 public fields or methods.
`ExecutionToolRuntimeRequest`	interface	`interface ExecutionToolRuntimeRequest`	Execution Tool Runtime Request interface with 4 public fields or methods.
`ExecutionToolRuntimeResult`	interface	`interface ExecutionToolRuntimeResult`	Execution Tool Runtime Result interface with 13 public fields or methods.
`ExecutionToolRuntimeScope`	interface	`interface ExecutionToolRuntimeScope`	Execution Tool Runtime Scope interface with 6 public fields or methods.
`ExecutionToolDispatchFactory`	type	`type ExecutionToolDispatchFactory = (request: ExecutionToolDispatchFactoryRequest<TInput>) => Promise<ExecutionToolDispatchPlan> \| ExecutionToolDispatchPlan`	Public type alias for Execution Tool Dispatch Factory; the declaration contains its complete type expression.
`ExecutionToolTerminalState`	type	`type ExecutionToolTerminalState = (typeof EXECUTION_TOOL_TERMINAL_STATES)[number]`	Public type alias for Execution Tool Terminal State; the declaration contains its complete type expression.

`ExecutionToolAdapter`

Execution Tool Adapter class with 8 public constructor or member entries; its exact declarations are listed below.

Kind: class
Import: import { ExecutionToolAdapter } from '@codesoul-co/hypha-tools';
Source module: execution-adapter

Declaration

text

export declare class ExecutionToolAdapter<TInput = unknown> implements ToolAdapter<TInput, ExecutionToolObservation> {
    readonly id: string;
    readonly source: ToolSource;
    constructor(id: string, port: ExecutionToolRuntimePort, createDispatch: ExecutionToolDispatchFactory<TInput>, options: ExecutionToolAdapterOptions);
    capabilities(): Promise<ToolAdapterCapabilities>;
    execute(request: AdapterExecutionRequest<TInput>): Promise<ToolExecutionEnvelope<ExecutionToolObservation>>;
    cancel(request: AdapterCancellationRequest): Promise<void>;
    health(): Promise<ProviderHealth>;
    close(): Promise<void>;
}

Public members

Member	Kind	Signature	Description
`cancel`	method	`cancel(request: AdapterCancellationRequest): Promise<void>`	Public method; parameters and return type are shown in the signature.
`capabilities`	method	`capabilities(): Promise<ToolAdapterCapabilities>`	Public method; parameters and return type are shown in the signature.
`close`	method	`close(): Promise<void>`	Public method; parameters and return type are shown in the signature.
`constructor`	constructor	`<TInput = unknown>(id: string, port: ExecutionToolRuntimePort, createDispatch: ExecutionToolDispatchFactory<TInput>, options: ExecutionToolAdapterOptions): ExecutionToolAdapter<TInput>`	Creates an instance of this class.
`execute`	method	`execute(request: AdapterExecutionRequest<TInput>): Promise<ToolExecutionEnvelope<ExecutionToolObservation>>`	Public method; parameters and return type are shown in the signature.
`health`	method	`health(): Promise<ProviderHealth>`	Public method; parameters and return type are shown in the signature.
`id`	property	`readonly id: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`source`	property	`readonly source: ToolSource`	Public property; its type, readonly modifier and optionality are shown in the signature.

`ExecutionToolTerminalError`

Execution Tool Terminal Error class with 13 public constructor or member entries; its exact declarations are listed below.

Kind: class
Import: import { ExecutionToolTerminalError } from '@codesoul-co/hypha-tools';
Source module: execution-adapter

Declaration

text

export declare class ExecutionToolTerminalError extends FrameworkError {
    readonly terminalState: Exclude<ExecutionToolTerminalState, 'completed'>;
    readonly executionError: NormalizedExecutionError;
    readonly observation: ExecutionToolObservation;
    constructor(observation: ExecutionToolObservation);
}

Public members

Member	Kind	Signature	Description
`cause`	property	`readonly cause?: unknown`	Public property; its type, readonly modifier and optionality are shown in the signature.
`code`	property	`readonly code: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`constructor`	constructor	`(observation: ExecutionToolObservation): ExecutionToolTerminalError`	Creates an instance of this class.
`context`	property	`readonly context?: Record<string, unknown>`	Public property; its type, readonly modifier and optionality are shown in the signature.
`executionError`	property	`readonly executionError: NormalizedExecutionError`	Public property; its type, readonly modifier and optionality are shown in the signature.
`message`	property	`message: 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.
`observation`	property	`readonly observation: ExecutionToolObservation`	Public property; its type, readonly modifier and optionality are shown in the signature.
`stack`	property	`stack?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`static captureStackTrace`	method	`static captureStackTrace(targetObject: object, constructorOpt?: Function): void`	Creates a `.stack` property on `targetObject`, which when accessed returns a string representing the location in the code at which `Error.captureStackTrace()` was called. js const myObject = {}; Error.captureStackTrace(myObject); myObject.stack; // Similar to `new Error().stack` The first line of the trace will be prefixed with `${myObject.name}: ${myObject.message}`. The optional `constructorOpt` argument accepts a function. If given, all frames above `constructorOpt`, including `constructorOpt`, will be omitted from the generated stack trace. The `constructorOpt` argument is useful for hiding implementation details of error generation from the user. For instance: `js function a() { b(); } function b() { c(); } function c() { // Create an error without stack trace to avoid calculating the stack trace twice. const { stackTraceLimit } = Error; Error.stackTraceLimit = 0; const error = new Error(); Error.stackTraceLimit = stackTraceLimit; // Capture the stack trace above function b Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace throw error; } a();`
`static prepareStackTrace`	method	`static prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any`	Public method; parameters and return type are shown in the signature.
`static stackTraceLimit`	property	`static stackTraceLimit: number`	The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames.
`terminalState`	property	`readonly terminalState: "unknown" \| "cancelled" \| "failed" \| "timed_out" \| "quarantined"`	Public property; its type, readonly modifier and optionality are shown in the signature.

`EXECUTION_TOOL_TERMINAL_STATES`

EXECUTION TOOL TERMINAL STATES constant exported by the execution-adapter module.

Kind: constant
Import: import { EXECUTION_TOOL_TERMINAL_STATES } from '@codesoul-co/hypha-tools';
Source module: execution-adapter

Declaration

text

export declare const EXECUTION_TOOL_TERMINAL_STATES: readonly ["completed", "failed", "timed_out", "cancelled", "unknown", "quarantined"];

`hashExecutionToolInput`

Hash Execution Tool Input function with 1 public call signature; parameters and return types are listed below.

Kind: function
Import: import { hashExecutionToolInput } from '@codesoul-co/hypha-tools';
Source module: execution-adapter

Declaration

text

export declare function hashExecutionToolInput(input: unknown): string;

Call signature

text

hashExecutionToolInput(input: unknown): string

Parameters

Parameter	Type	Required	Description
`input`	`unknown`	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.

`normalizeExecutionToolInput`

Normalize Execution Tool Input function with 1 public call signature; parameters and return types are listed below.

Kind: function
Import: import { normalizeExecutionToolInput } from '@codesoul-co/hypha-tools';
Source module: execution-adapter

Declaration

text

export declare function normalizeExecutionToolInput<TInput>(input: TInput): TInput;

Call signature

text

normalizeExecutionToolInput<TInput>(input: TInput): TInput

Parameters

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

Returns

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

`validateExecutionToolRuntimeRequest`

Recomputes the normalized input digest at the Execution boundary. Runtime-port implementations must call this validator before delegating to a provider.

Kind: function
Import: import { validateExecutionToolRuntimeRequest } from '@codesoul-co/hypha-tools';
Source module: execution-adapter

Declaration

text

export declare function validateExecutionToolRuntimeRequest<TInput>(input: ExecutionToolRuntimeRequest<TInput>): ExecutionToolRuntimeRequest<TInput>;

Call signature

text

validateExecutionToolRuntimeRequest<TInput>(input: ExecutionToolRuntimeRequest<TInput>): ExecutionToolRuntimeRequest<TInput>

Recomputes the normalized input digest at the Execution boundary. Runtime-port implementations must call this validator before delegating to a provider.

Parameters

Parameter	Type	Required	Description
`input`	`ExecutionToolRuntimeRequest<TInput>`	Yes	Required parameter; accepted values are defined by the type column.

Returns

Type: ExecutionToolRuntimeRequest<TInput>
Description: The return contract is defined by the type shown above.

`ExecutionToolAdapterOptions`

Execution Tool Adapter Options interface with 6 public fields or methods.

Kind: interface
Import: import type { ExecutionToolAdapterOptions } from '@codesoul-co/hypha-tools';
Source module: execution-adapter

Declaration

text

export interface ExecutionToolAdapterOptions {
    toolRevision: string;
    binding: ExecutionToolBinding;
    providerId: string;
    healthTimeoutMs?: number;
    maxEvidenceBytes?: number;
    now?: () => string;
}

Contract members

Member	Kind	Signature	Description
`binding`	property	`binding: ExecutionToolBinding`	Public property; its type, readonly modifier and optionality are shown in the signature.
`healthTimeoutMs`	property	`healthTimeoutMs?: number`	Public property; its type, readonly modifier and optionality are shown in the signature.
`maxEvidenceBytes`	property	`maxEvidenceBytes?: 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.
`providerId`	property	`providerId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`toolRevision`	property	`toolRevision: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`ExecutionToolDispatchFactoryRequest`

Execution Tool Dispatch Factory Request interface with 6 public fields or methods.

Kind: interface
Import: import type { ExecutionToolDispatchFactoryRequest } from '@codesoul-co/hypha-tools';
Source module: execution-adapter

Declaration

text

export interface ExecutionToolDispatchFactoryRequest<TInput> extends AdapterExecutionRequest<TInput> {
    normalizedInput: TInput;
    inputHash: string;
    signal: AbortSignal;
}

Contract members

Member	Kind	Signature	Description
`context`	property	`context: ToolCallContext`	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.
`inputHash`	property	`inputHash: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`normalizedInput`	property	`normalizedInput: TInput`	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.
`toolId`	property	`toolId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`ExecutionToolDispatchPlan`

Execution Tool Dispatch Plan interface with 3 public fields or methods.

Kind: interface
Import: import type { ExecutionToolDispatchPlan } from '@codesoul-co/hypha-tools';
Source module: execution-adapter

Declaration

text

export interface ExecutionToolDispatchPlan {
    dispatch: ExecutionDispatchRequest;
    expectedRevision: number;
    approvalExpiresAt?: string;
}

Contract members

Member	Kind	Signature	Description
`approvalExpiresAt`	property	`approvalExpiresAt?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`dispatch`	property	`dispatch: ExecutionDispatchRequest`	Public property; its type, readonly modifier and optionality are shown in the signature.
`expectedRevision`	property	`expectedRevision: number`	Public property; its type, readonly modifier and optionality are shown in the signature.

`ExecutionToolEvidence`

Execution Tool Evidence interface with 4 public fields or methods.

Kind: interface
Import: import type { ExecutionToolEvidence } from '@codesoul-co/hypha-tools';
Source module: execution-adapter

Declaration

text

export interface ExecutionToolEvidence {
    kind: 'authorization' | 'event' | 'receipt' | 'artifact' | 'snapshot' | 'trace';
    ref: string;
    hash?: string;
    recordedAt?: string;
}

Contract members

Member	Kind	Signature	Description
`hash`	property	`hash?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`kind`	property	`kind: "artifact" \| "event" \| "snapshot" \| "authorization" \| "trace" \| "receipt"`	Public property; its type, readonly modifier and optionality are shown in the signature.
`recordedAt`	property	`recordedAt?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`ref`	property	`ref: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`ExecutionToolObservation`

Execution Tool Observation interface with 14 public fields or methods.

Kind: interface
Import: import type { ExecutionToolObservation } from '@codesoul-co/hypha-tools';
Source module: execution-adapter

Declaration

text

export interface ExecutionToolObservation extends ExecutionToolRuntimeResult {
    evidenceHash: string;
}

Contract members

Member	Kind	Signature	Description
`activityResult`	property	`activityResult: ExecutionActivityResult`	Public property; its type, readonly modifier and optionality are shown in the signature.
`contractSnapshotRef`	property	`contractSnapshotRef: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`evidence`	property	`evidence: ExecutionToolEvidence[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`evidenceHash`	property	`evidenceHash: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`fencingToken`	property	`fencingToken: number`	Public property; its type, readonly modifier and optionality are shown in the signature.
`inputHash`	property	`inputHash: 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.
`provenance`	property	`provenance: ExecutionToolProvenance`	Public property; its type, readonly modifier and optionality are shown in the signature.
`revision`	property	`revision: number`	Public property; its type, readonly modifier and optionality are shown in the signature.
`scope`	property	`scope: ExecutionToolRuntimeScope`	Public property; its type, readonly modifier and optionality are shown in the signature.
`terminalState`	property	`terminalState: "unknown" \| "completed" \| "cancelled" \| "failed" \| "timed_out" \| "quarantined"`	Public property; its type, readonly modifier and optionality are shown in the signature.
`toolId`	property	`toolId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`toolOperation`	property	`toolOperation: "artifact" \| "command" \| "file_read" \| "file_write" \| "sandbox"`	Public property; its type, readonly modifier and optionality are shown in the signature.
`toolRevision`	property	`toolRevision: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`ExecutionToolProvenance`

Execution Tool Provenance interface with 7 public fields or methods.

Kind: interface
Import: import type { ExecutionToolProvenance } from '@codesoul-co/hypha-tools';
Source module: execution-adapter

Declaration

text

export interface ExecutionToolProvenance {
    providerId: string;
    authorizationEvidenceId: string;
    authorizationVerificationRef: string;
    terminalEventId: string;
    receivedAt: string;
    resultHash: string;
    receiptRef?: string;
}

Contract members

Member	Kind	Signature	Description
`authorizationEvidenceId`	property	`authorizationEvidenceId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`authorizationVerificationRef`	property	`authorizationVerificationRef: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`providerId`	property	`providerId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`receiptRef`	property	`receiptRef?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`receivedAt`	property	`receivedAt: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`resultHash`	property	`resultHash: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`terminalEventId`	property	`terminalEventId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`ExecutionToolRuntimePort`

Execution Tool Runtime Port interface with 3 public fields or methods.

Kind: interface
Import: import type { ExecutionToolRuntimePort } from '@codesoul-co/hypha-tools';
Source module: execution-adapter

Declaration

text

export interface ExecutionToolRuntimePort {
    execute(request: ExecutionToolRuntimeRequest, signal: AbortSignal): Promise<unknown>;
    health(signal: AbortSignal): Promise<unknown>;
    close?(): Promise<void>;
}

Contract members

Member	Kind	Signature	Description
`close`	method	`close?(): Promise<void>`	Public method; parameters and return type are shown in the signature.
`execute`	method	`execute(request: ExecutionToolRuntimeRequest, signal: AbortSignal): Promise<unknown>`	Public method; parameters and return type are shown in the signature.
`health`	method	`health(signal: AbortSignal): Promise<unknown>`	Public method; parameters and return type are shown in the signature.

`ExecutionToolRuntimeRequest`

Execution Tool Runtime Request interface with 4 public fields or methods.

Kind: interface
Import: import type { ExecutionToolRuntimeRequest } from '@codesoul-co/hypha-tools';
Source module: execution-adapter

Declaration

text

export interface ExecutionToolRuntimeRequest<TInput = unknown> {
    dispatch: ExecutionDispatchRequest;
    normalizedInput: TInput;
    inputHash: string;
    expectedRevision: number;
}

Contract members

Member	Kind	Signature	Description
`dispatch`	property	`dispatch: ExecutionDispatchRequest`	Public property; its type, readonly modifier and optionality are shown in the signature.
`expectedRevision`	property	`expectedRevision: number`	Public property; its type, readonly modifier and optionality are shown in the signature.
`inputHash`	property	`inputHash: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`normalizedInput`	property	`normalizedInput: TInput`	Public property; its type, readonly modifier and optionality are shown in the signature.

`ExecutionToolRuntimeResult`

Execution Tool Runtime Result interface with 13 public fields or methods.

Kind: interface
Import: import type { ExecutionToolRuntimeResult } from '@codesoul-co/hypha-tools';
Source module: execution-adapter

Declaration

text

export interface ExecutionToolRuntimeResult {
    activityResult: ExecutionActivityResult;
    scope: ExecutionToolRuntimeScope;
    toolId: string;
    toolRevision: string;
    contractSnapshotRef: string;
    toolOperation: ExecutionDispatchRequest['binding']['operation'];
    operationId: string;
    inputHash: string;
    revision: number;
    fencingToken: number;
    terminalState: ExecutionToolTerminalState;
    provenance: ExecutionToolProvenance;
    evidence: ExecutionToolEvidence[];
}

Contract members

Member	Kind	Signature	Description
`activityResult`	property	`activityResult: ExecutionActivityResult`	Public property; its type, readonly modifier and optionality are shown in the signature.
`contractSnapshotRef`	property	`contractSnapshotRef: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`evidence`	property	`evidence: ExecutionToolEvidence[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`fencingToken`	property	`fencingToken: number`	Public property; its type, readonly modifier and optionality are shown in the signature.
`inputHash`	property	`inputHash: 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.
`provenance`	property	`provenance: ExecutionToolProvenance`	Public property; its type, readonly modifier and optionality are shown in the signature.
`revision`	property	`revision: number`	Public property; its type, readonly modifier and optionality are shown in the signature.
`scope`	property	`scope: ExecutionToolRuntimeScope`	Public property; its type, readonly modifier and optionality are shown in the signature.
`terminalState`	property	`terminalState: "unknown" \| "completed" \| "cancelled" \| "failed" \| "timed_out" \| "quarantined"`	Public property; its type, readonly modifier and optionality are shown in the signature.
`toolId`	property	`toolId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`toolOperation`	property	`toolOperation: "artifact" \| "command" \| "file_read" \| "file_write" \| "sandbox"`	Public property; its type, readonly modifier and optionality are shown in the signature.
`toolRevision`	property	`toolRevision: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`ExecutionToolRuntimeScope`

Execution Tool Runtime Scope interface with 6 public fields or methods.

Kind: interface
Import: import type { ExecutionToolRuntimeScope } from '@codesoul-co/hypha-tools';
Source module: execution-adapter

Declaration

text

export interface ExecutionToolRuntimeScope {
    principalId: string;
    userId?: string;
    tenantId?: string;
    sessionId?: string;
    runId: string;
    workspaceId: string;
}

Contract members

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

`ExecutionToolDispatchFactory`

Public type alias for Execution Tool Dispatch Factory; the declaration contains its complete type expression.

Kind: type
Import: import type { ExecutionToolDispatchFactory } from '@codesoul-co/hypha-tools';
Source module: execution-adapter

Declaration

text

export type ExecutionToolDispatchFactory<TInput = unknown> = (request: ExecutionToolDispatchFactoryRequest<TInput>) => Promise<ExecutionToolDispatchPlan> | ExecutionToolDispatchPlan;

`ExecutionToolTerminalState`

Public type alias for Execution Tool Terminal State; the declaration contains its complete type expression.

Kind: type
Import: import type { ExecutionToolTerminalState } from '@codesoul-co/hypha-tools';
Source module: execution-adapter

Declaration

text

export type ExecutionToolTerminalState = (typeof EXECUTION_TOOL_TERMINAL_STATES)[number];

@codesoul-co/hypha-tools / execution-adapter ​

Using this module ​

Import from the package entrypoint ​

Usage patterns ​

Public exports ​

ExecutionToolAdapter ​

Declaration ​

Public members ​

ExecutionToolTerminalError ​

Declaration ​

Public members ​

EXECUTION_TOOL_TERMINAL_STATES ​

Declaration ​

hashExecutionToolInput ​

Declaration ​

Call signature ​

Parameters ​

Returns ​

normalizeExecutionToolInput ​

Declaration ​

Call signature ​

Parameters ​

Returns ​

validateExecutionToolRuntimeRequest ​

Declaration ​

Call signature ​

Parameters ​

Returns ​

ExecutionToolAdapterOptions ​

Declaration ​

Contract members ​

ExecutionToolDispatchFactoryRequest ​

Declaration ​

Contract members ​

ExecutionToolDispatchPlan ​

Declaration ​

Contract members ​

ExecutionToolEvidence ​

Declaration ​

Contract members ​

ExecutionToolObservation ​

Declaration ​

Contract members ​

ExecutionToolProvenance ​

Declaration ​

Contract members ​

ExecutionToolRuntimePort ​

Declaration ​

Contract members ​

ExecutionToolRuntimeRequest ​

Declaration ​

Contract members ​

ExecutionToolRuntimeResult ​

Declaration ​

Contract members ​

ExecutionToolRuntimeScope ​

Declaration ​

Contract members ​

ExecutionToolDispatchFactory ​

Declaration ​

ExecutionToolTerminalState ​

Declaration ​

`@codesoul-co/hypha-tools` / `execution-adapter`

Using this module

Import from the package entrypoint

Usage patterns

Public exports

`ExecutionToolAdapter`

Declaration

Public members

`ExecutionToolTerminalError`

Declaration

Public members

`EXECUTION_TOOL_TERMINAL_STATES`

Declaration

`hashExecutionToolInput`

Declaration

Call signature

Parameters

Returns

`normalizeExecutionToolInput`

Declaration

Call signature

Parameters

Returns

`validateExecutionToolRuntimeRequest`

Declaration

Call signature

Parameters

Returns

`ExecutionToolAdapterOptions`

Declaration

Contract members

`ExecutionToolDispatchFactoryRequest`

Declaration

Contract members

`ExecutionToolDispatchPlan`

Declaration

Contract members

`ExecutionToolEvidence`

Declaration

Contract members

`ExecutionToolObservation`

Declaration

Contract members

`ExecutionToolProvenance`

Declaration

Contract members

`ExecutionToolRuntimePort`

Declaration

Contract members

`ExecutionToolRuntimeRequest`

Declaration

Contract members

`ExecutionToolRuntimeResult`

Declaration

Contract members

`ExecutionToolRuntimeScope`

Declaration

Contract members

`ExecutionToolDispatchFactory`

Declaration

`ExecutionToolTerminalState`

Declaration