Skip to content

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

模块用法

用于声明并运行时校验契约。Execution port 模块公开 6 接口。

从包入口导入

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

使用要点

  • 6 个类型/接口用于应用代码、Adapter 或测试中的静态契约;请使用 import type,运行时不应依赖它们。

公共导出

Symbol种类签名说明
ExecutionAuthorizationEvidence接口interface ExecutionAuthorizationEvidenceExecution Authorization Evidence 接口,共包含 14 个公开字段或方法。
ExecutionAuthorizationVerificationResult接口interface ExecutionAuthorizationVerificationResultExecution Authorization Verification Result 接口,共包含 5 个公开字段或方法。
ExecutionAuthorizationVerifier接口interface ExecutionAuthorizationVerifierExecution Authorization Verifier 接口,共包含 1 个公开字段或方法。
ExecutionDispatchRequest接口interface ExecutionDispatchRequestExecution Dispatch Request 接口,共包含 4 个公开字段或方法。
ExecutionOperationDispatcher接口interface ExecutionOperationDispatcherExecution Operation Dispatcher 接口,共包含 1 个公开字段或方法。
ExecutionPort接口interface ExecutionPortExecution Port 接口,共包含 1 个公开字段或方法。

ExecutionAuthorizationEvidence

Execution Authorization Evidence 接口,共包含 14 个公开字段或方法。

  • 种类: 接口
  • 导入: import type { ExecutionAuthorizationEvidence } from '@codesoul-co/hypha-core';
  • 源码模块: contracts/execution-port

声明

text
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;
}

契约成员

成员种类签名说明
activityId属性activityId: string公开属性;类型、只读和可选状态以签名列为准。
approvalRef属性approvalRef?: string公开属性;类型、只读和可选状态以签名列为准。
authorizedAt属性authorizedAt: string公开属性;类型、只读和可选状态以签名列为准。
contractSnapshotRef属性contractSnapshotRef?: string公开属性;类型、只读和可选状态以签名列为准。
expiresAt属性expiresAt?: string公开属性;类型、只读和可选状态以签名列为准。
id属性id: string公开属性;类型、只读和可选状态以签名列为准。
inputHash属性inputHash: string公开属性;类型、只读和可选状态以签名列为准。
invocationId属性invocationId: string公开属性;类型、只读和可选状态以签名列为准。
policyDecisionRef属性policyDecisionRef: string公开属性;类型、只读和可选状态以签名列为准。
principalId属性principalId: string公开属性;类型、只读和可选状态以签名列为准。
riskAssessmentId属性riskAssessmentId: string公开属性;类型、只读和可选状态以签名列为准。
runId属性runId: string公开属性;类型、只读和可选状态以签名列为准。
toolId属性toolId: string公开属性;类型、只读和可选状态以签名列为准。
toolRevision属性toolRevision?: string公开属性;类型、只读和可选状态以签名列为准。

ExecutionAuthorizationVerificationResult

Execution Authorization Verification Result 接口,共包含 5 个公开字段或方法。

  • 种类: 接口
  • 导入: import type { ExecutionAuthorizationVerificationResult } from '@codesoul-co/hypha-core';
  • 源码模块: contracts/execution-port

声明

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

契约成员

成员种类签名说明
expiresAt属性expiresAt?: string公开属性;类型、只读和可选状态以签名列为准。
reason属性reason?: string公开属性;类型、只读和可选状态以签名列为准。
valid属性valid: boolean公开属性;类型、只读和可选状态以签名列为准。
verificationRef属性verificationRef: string公开属性;类型、只读和可选状态以签名列为准。
verifiedAt属性verifiedAt: string公开属性;类型、只读和可选状态以签名列为准。

ExecutionAuthorizationVerifier

Execution Authorization Verifier 接口,共包含 1 个公开字段或方法。

  • 种类: 接口
  • 导入: import type { ExecutionAuthorizationVerifier } from '@codesoul-co/hypha-core';
  • 源码模块: contracts/execution-port

声明

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

契约成员

成员种类签名说明
verify方法verify(request: ExecutionDispatchRequest, abortSignal: AbortSignal): Promise<ExecutionAuthorizationVerificationResult>公开方法;参数与返回类型以签名列为准。

ExecutionDispatchRequest

Execution Dispatch Request 接口,共包含 4 个公开字段或方法。

  • 种类: 接口
  • 导入: import type { ExecutionDispatchRequest } from '@codesoul-co/hypha-core';
  • 源码模块: contracts/execution-port

声明

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

契约成员

成员种类签名说明
activity属性activity: ExecutionActivityRequest公开属性;类型、只读和可选状态以签名列为准。
authorization属性authorization: ExecutionAuthorizationEvidence公开属性;类型、只读和可选状态以签名列为准。
binding属性binding: ExecutionToolBinding公开属性;类型、只读和可选状态以签名列为准。
riskAssessment属性riskAssessment: ExecutionRiskAssessment公开属性;类型、只读和可选状态以签名列为准。

ExecutionOperationDispatcher

Execution Operation Dispatcher 接口,共包含 1 个公开字段或方法。

  • 种类: 接口
  • 导入: import type { ExecutionOperationDispatcher } from '@codesoul-co/hypha-core';
  • 源码模块: contracts/execution-port

声明

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

契约成员

成员种类签名说明
dispatch方法dispatch(request: ExecutionActivityRequest, abortSignal: AbortSignal): Promise<ExecutionActivityResult>公开方法;参数与返回类型以签名列为准。

ExecutionPort

Execution Port 接口,共包含 1 个公开字段或方法。

  • 种类: 接口
  • 导入: import type { ExecutionPort } from '@codesoul-co/hypha-core';
  • 源码模块: contracts/execution-port

声明

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

契约成员

成员种类签名说明
execute方法execute(request: ExecutionDispatchRequest, abortSignal: AbortSignal): Promise<ExecutionActivityResult>公开方法;参数与返回类型以签名列为准。