@codesoul-co/hypha-core / contracts/execution-port

• Package index: @codesoul-co/hypha-core
• Source: packages/core/src/contracts/execution-port.ts
• Exports: 6

Using this module

Use the Execution port module for declaring and runtime-validating contracts. It exports 6 interfaces.

Import from the package entrypoint

import type {
  ExecutionAuthorizationEvidence,
  ExecutionAuthorizationVerificationResult,
  ExecutionAuthorizationVerifier,
  ExecutionDispatchRequest,
  ExecutionOperationDispatcher,
  ExecutionPort,
} from '@codesoul-co/hypha-core';

Usage patterns

• Use the 6 type/interface exports as static contracts in application code, adapters, or tests. Import them with import type; they do not exist at runtime.

Public exports

Symbol	Kind	Signature	Description
ExecutionAuthorizationEvidence	interface	interface ExecutionAuthorizationEvidence	Execution Authorization Evidence interface with 14 public fields or methods.
ExecutionAuthorizationVerificationResult	interface	interface ExecutionAuthorizationVerificationResult	Execution Authorization Verification Result interface with 5 public fields or methods.
ExecutionAuthorizationVerifier	interface	interface ExecutionAuthorizationVerifier	Execution Authorization Verifier interface with 1 public fields or methods.
ExecutionDispatchRequest	interface	interface ExecutionDispatchRequest	Execution Dispatch Request interface with 4 public fields or methods.
ExecutionOperationDispatcher	interface	interface ExecutionOperationDispatcher	Execution Operation Dispatcher interface with 1 public fields or methods.
ExecutionPort	interface	interface ExecutionPort	Execution Port interface with 1 public fields or methods.

ExecutionAuthorizationEvidence

Execution Authorization Evidence interface with 14 public fields or methods.

• Kind: interface
• Import: import type { ExecutionAuthorizationEvidence } from '@codesoul-co/hypha-core';
• Source module: contracts/execution-port

Declaration

export interface ExecutionAuthorizationEvidence {
    id: string;
    invocationId: string;
    activityId: string;
    runId: string;
    toolId: string;
    toolRevision?: string;
    contractSnapshotRef?: string;
    principalId: string;
    inputHash: string;
    policyDecisionRef: string;
    riskAssessmentId: string;
    approvalRef?: string;
    authorizedAt: string;
    expiresAt?: string;
}

Contract members

Member	Kind	Signature	Description
activityId	property	activityId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
approvalRef	property	approvalRef?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
authorizedAt	property	authorizedAt: string	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.
expiresAt	property	expiresAt?: 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.
inputHash	property	inputHash: string	Public property; its type, readonly modifier and optionality are shown in the signature.
invocationId	property	invocationId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
policyDecisionRef	property	policyDecisionRef: string	Public property; its type, readonly modifier and optionality are shown in the signature.
principalId	property	principalId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
riskAssessmentId	property	riskAssessmentId: 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.
toolId	property	toolId: 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.

ExecutionAuthorizationVerificationResult

Execution Authorization Verification Result interface with 5 public fields or methods.

• Kind: interface
• Import: import type { ExecutionAuthorizationVerificationResult } from '@codesoul-co/hypha-core';
• Source module: contracts/execution-port

Declaration

export interface ExecutionAuthorizationVerificationResult {
    valid: boolean;
    verificationRef: string;
    verifiedAt: string;
    expiresAt?: string;
    reason?: string;
}

Contract members

Member	Kind	Signature	Description
expiresAt	property	expiresAt?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
reason	property	reason?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
valid	property	valid: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
verificationRef	property	verificationRef: string	Public property; its type, readonly modifier and optionality are shown in the signature.
verifiedAt	property	verifiedAt: string	Public property; its type, readonly modifier and optionality are shown in the signature.

ExecutionAuthorizationVerifier

Execution Authorization Verifier interface with 1 public fields or methods.

• Kind: interface
• Import: import type { ExecutionAuthorizationVerifier } from '@codesoul-co/hypha-core';
• Source module: contracts/execution-port

Declaration

export interface ExecutionAuthorizationVerifier {
    verify(request: ExecutionDispatchRequest, abortSignal: AbortSignal): Promise<ExecutionAuthorizationVerificationResult>;
}

Contract members

Member	Kind	Signature	Description
verify	method	verify(request: ExecutionDispatchRequest, abortSignal: AbortSignal): Promise<ExecutionAuthorizationVerificationResult>	Public method; parameters and return type are shown in the signature.

ExecutionDispatchRequest

Execution Dispatch Request interface with 4 public fields or methods.

• Kind: interface
• Import: import type { ExecutionDispatchRequest } from '@codesoul-co/hypha-core';
• Source module: contracts/execution-port

Declaration

export interface ExecutionDispatchRequest {
    activity: ExecutionActivityRequest;
    binding: ExecutionToolBinding;
    riskAssessment: ExecutionRiskAssessment;
    authorization: ExecutionAuthorizationEvidence;
}

Contract members

Member	Kind	Signature	Description
activity	property	activity: ExecutionActivityRequest	Public property; its type, readonly modifier and optionality are shown in the signature.
authorization	property	authorization: ExecutionAuthorizationEvidence	Public property; its type, readonly modifier and optionality are shown in the signature.
binding	property	binding: ExecutionToolBinding	Public property; its type, readonly modifier and optionality are shown in the signature.
riskAssessment	property	riskAssessment: ExecutionRiskAssessment	Public property; its type, readonly modifier and optionality are shown in the signature.

ExecutionOperationDispatcher

Execution Operation Dispatcher interface with 1 public fields or methods.

• Kind: interface
• Import: import type { ExecutionOperationDispatcher } from '@codesoul-co/hypha-core';
• Source module: contracts/execution-port

Declaration

export interface ExecutionOperationDispatcher {
    dispatch(request: ExecutionActivityRequest, abortSignal: AbortSignal): Promise<ExecutionActivityResult>;
}

Contract members

Member	Kind	Signature	Description
dispatch	method	dispatch(request: ExecutionActivityRequest, abortSignal: AbortSignal): Promise<ExecutionActivityResult>	Public method; parameters and return type are shown in the signature.

ExecutionPort

Execution Port interface with 1 public fields or methods.

• Kind: interface
• Import: import type { ExecutionPort } from '@codesoul-co/hypha-core';
• Source module: contracts/execution-port

Declaration

export interface ExecutionPort {
    execute(request: ExecutionDispatchRequest, abortSignal: AbortSignal): Promise<ExecutionActivityResult>;
}

Contract members

Member	Kind	Signature	Description
execute	method	execute(request: ExecutionDispatchRequest, abortSignal: AbortSignal): Promise<ExecutionActivityResult>	Public method; parameters and return type are shown in the signature.