@codesoul-co/hypha-adapters-local / local-process-execution-provider

• Package index: @codesoul-co/hypha-adapters-local
• Source: packages/adapters-local/src/local-process-execution-provider.ts
• Exports: 2

Using this module

Use the Local process execution provider module for binding external or local providers to Hypha ports. It exports 1 class, 1 interface.

Import from the package entrypoint

import {
  LocalProcessExecutionProvider,
} from '@codesoul-co/hypha-adapters-local';

import type {
  LocalProcessExecutionProviderOptions,
} from '@codesoul-co/hypha-adapters-local';

Usage patterns

• Use the 1 type/interface export as static contracts in application code, adapters, or tests. Import them with import type; they do not exist at runtime.
• The module exposes 1 class as constructable runtime implementations. Each symbol entry lists its constructor and public methods.

Public exports

Symbol	Kind	Signature	Description
LocalProcessExecutionProvider	class	new LocalProcessExecutionProvider(options: LocalProcessExecutionProviderOptions): LocalProcessExecutionProvider	Trusted-development provider. Workspace checks are confinement, not OS isolation.
LocalProcessExecutionProviderOptions	interface	interface LocalProcessExecutionProviderOptions extends LocalProcessPolicyResolverOptions	Local Process Execution Provider Options interface with 26 public fields or methods.

LocalProcessExecutionProvider

Trusted-development provider. Workspace checks are confinement, not OS isolation.

• Kind: class
• Import: import { LocalProcessExecutionProvider } from '@codesoul-co/hypha-adapters-local';
• Source module: local-process-execution-provider

Declaration

export declare class LocalProcessExecutionProvider implements SandboxProvider {
    readonly id: string;
    constructor(options: LocalProcessExecutionProviderOptions);
    capabilities(): Promise<SandboxProviderCapabilities>;
    create(input: SandboxCreateRequest): Promise<SandboxRecord>;
    start(input: SandboxStartRequest): Promise<SandboxRecord>;
    execute(input: CommandExecutionRequest): Promise<CommandExecutionResult>;
    streamOutput(input: RemoteOutputStreamRequest): AsyncIterable<CommandOutputChunk>;
    cancel(input: ExecutionCancelRequest): Promise<void>;
    terminate(input: SandboxTerminateRequest): Promise<void>;
    status(input: SandboxStatusRequest): Promise<SandboxRecord | null>;
    cleanup(input: SandboxCleanupRequest): Promise<void>;
    health(): Promise<ProviderHealth>;
    close(): Promise<void>;
}

Public members

Member	Kind	Signature	Description
cancel	method	cancel(input: ExecutionCancelRequest): Promise<void>	Public method; parameters and return type are shown in the signature.
capabilities	method	capabilities(): Promise<SandboxProviderCapabilities>	Public method; parameters and return type are shown in the signature.
cleanup	method	cleanup(input: SandboxCleanupRequest): Promise<void>	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	(options: LocalProcessExecutionProviderOptions): LocalProcessExecutionProvider	Creates an instance of this class.
create	method	create(input: SandboxCreateRequest): Promise<SandboxRecord>	Public method; parameters and return type are shown in the signature.
execute	method	execute(input: CommandExecutionRequest): Promise<CommandExecutionResult>	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.
start	method	start(input: SandboxStartRequest): Promise<SandboxRecord>	Public method; parameters and return type are shown in the signature.
status	method	status(input: SandboxStatusRequest): Promise<SandboxRecord | null>	Public method; parameters and return type are shown in the signature.
streamOutput	method	streamOutput(input: RemoteOutputStreamRequest): AsyncIterable<CommandOutputChunk>	Public method; parameters and return type are shown in the signature.
terminate	method	terminate(input: SandboxTerminateRequest): Promise<void>	Public method; parameters and return type are shown in the signature.

LocalProcessExecutionProviderOptions

Local Process Execution Provider Options interface with 26 public fields or methods.

• Kind: interface
• Import: import type { LocalProcessExecutionProviderOptions } from '@codesoul-co/hypha-adapters-local';
• Source module: local-process-execution-provider

Declaration

export interface LocalProcessExecutionProviderOptions extends LocalProcessPolicyResolverOptions {
    gracefulTerminationMs?: number;
    maxTrackedFiles?: number;
    maxTrackedBytes?: number;
    allowBestEffortWindowsProcessTreeKill?: boolean;
    id?: string;
    now?: () => string;
    sandboxId?: (request: SandboxCreateRequest) => string;
    executionId?: (request: CommandExecutionRequest) => string;
    supervisor?: LocalProcessSupervisor;
    outputArtifacts?: LocalProcessOutputArtifactPort;
    maxRetainedOutputChunks?: number;
    maxTrackedOutputStreams?: number;
}

Contract members

Member	Kind	Signature	Description
allowBestEffortWindowsProcessTreeKill	property	allowBestEffortWindowsProcessTreeKill?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
baseEnvironment	property	baseEnvironment?: Record<string, string>	Public property; its type, readonly modifier and optionality are shown in the signature.
executables	property	executables: Record<string, string>	Public property; its type, readonly modifier and optionality are shown in the signature.
executionId	method	executionId?(request: CommandExecutionRequest): string	Public method; parameters and return type are shown in the signature.
gracefulTerminationMs	property	gracefulTerminationMs?: number	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.
inheritEnvironment	property	inheritEnvironment?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
maxArgumentBytes	property	maxArgumentBytes?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
maxArgumentCount	property	maxArgumentCount?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
maxCombinedOutputBytes	property	maxCombinedOutputBytes?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
maxEnvironmentValueBytes	property	maxEnvironmentValueBytes?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
maxEnvironmentVariables	property	maxEnvironmentVariables?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
maxExecutionTimeoutMs	property	maxExecutionTimeoutMs?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
maxRetainedOutputChunks	property	maxRetainedOutputChunks?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
maxStderrBytes	property	maxStderrBytes?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
maxStdoutBytes	property	maxStdoutBytes?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
maxTotalArgumentBytes	property	maxTotalArgumentBytes?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
maxTotalEnvironmentBytes	property	maxTotalEnvironmentBytes?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
maxTrackedBytes	property	maxTrackedBytes?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
maxTrackedFiles	property	maxTrackedFiles?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
maxTrackedOutputStreams	property	maxTrackedOutputStreams?: 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.
outputArtifacts	property	outputArtifacts?: LocalProcessOutputArtifactPort	Public property; its type, readonly modifier and optionality are shown in the signature.
sandboxId	method	sandboxId?(request: SandboxCreateRequest): string	Public method; parameters and return type are shown in the signature.
supervisor	property	supervisor?: LocalProcessSupervisor	Public property; its type, readonly modifier and optionality are shown in the signature.
workspaceRoot	property	workspaceRoot: string	Public property; its type, readonly modifier and optionality are shown in the signature.