Skip to content

@codesoul-co/hypha-core / contracts/execution-human-task

模块用法

用于声明并运行时校验契约。Execution human task 模块公开 1 常量、9 接口。

从包入口导入

ts
import {
  EXECUTION_HUMAN_TASK_SUBJECT_VERSION,
} from '@codesoul-co/hypha-core';

import type {
  ExecutionHumanTaskActivityIdentity,
  ExecutionHumanTaskCommandSnapshot,
  ExecutionHumanTaskEnvironmentSnapshot,
  ExecutionHumanTaskExpectedEffects,
  ExecutionHumanTaskNetworkSnapshot,
  ExecutionHumanTaskRiskSnapshot,
  ExecutionHumanTaskSubject,
  ExecutionHumanTaskSubjectEnvelope,
} from '@codesoul-co/hypha-core';

// 完整导出列表见下方。

使用要点

  • 9 个类型/接口用于应用代码、Adapter 或测试中的静态契约;请使用 import type,运行时不应依赖它们。
  • 1 个常量/枚举提供稳定值、Schema、Definition 或默认配置;应复用这些导出,避免在应用中复制内部值。

公共导出

Symbol种类签名说明
EXECUTION_HUMAN_TASK_SUBJECT_VERSION常量const EXECUTION_HUMAN_TASK_SUBJECT_VERSION: "1.0.0"contracts/execution-human-task 模块导出的 EXECUTION HUMAN TASK SUBJECT VERSION 常量。
ExecutionHumanTaskActivityIdentity接口interface ExecutionHumanTaskActivityIdentityExecution Human Task Activity Identity 接口,共包含 7 个公开字段或方法。
ExecutionHumanTaskCommandSnapshot接口interface ExecutionHumanTaskCommandSnapshotExecution Human Task Command Snapshot 接口,共包含 12 个公开字段或方法。
ExecutionHumanTaskEnvironmentSnapshot接口interface ExecutionHumanTaskEnvironmentSnapshotExecution Human Task Environment Snapshot 接口,共包含 11 个公开字段或方法。
ExecutionHumanTaskExpectedEffects接口interface ExecutionHumanTaskExpectedEffectsExecution Human Task Expected Effects 接口,共包含 4 个公开字段或方法。
ExecutionHumanTaskNetworkSnapshot接口interface ExecutionHumanTaskNetworkSnapshotExecution Human Task Network Snapshot 接口,共包含 7 个公开字段或方法。
ExecutionHumanTaskRiskSnapshot接口interface ExecutionHumanTaskRiskSnapshotExecution Human Task Risk Snapshot 接口,共包含 5 个公开字段或方法。
ExecutionHumanTaskSubject接口interface ExecutionHumanTaskSubjectVersioned, redacted subject approved by a Runtime HumanTask before command dispatch. Environment values, stdin, Secret values, and arbitrary request metadata are intentionally absent.
ExecutionHumanTaskSubjectEnvelope接口interface ExecutionHumanTaskSubjectEnvelopeExecution Human Task Subject Envelope 接口,共包含 3 个公开字段或方法。
ExecutionHumanTaskToolIdentity接口interface ExecutionHumanTaskToolIdentityExecution Human Task Tool Identity 接口,共包含 6 个公开字段或方法。

EXECUTION_HUMAN_TASK_SUBJECT_VERSION

contracts/execution-human-task 模块导出的 EXECUTION HUMAN TASK SUBJECT VERSION 常量。

声明

text
export declare const EXECUTION_HUMAN_TASK_SUBJECT_VERSION: "1.0.0";

ExecutionHumanTaskActivityIdentity

Execution Human Task Activity Identity 接口,共包含 7 个公开字段或方法。

声明

text
export interface ExecutionHumanTaskActivityIdentity {
    activityId: string;
    operationId: string;
    runId: string;
    stateAttemptId: string;
    workspaceId: string;
    fencingToken: number;
    deadlineAt?: string;
}

契约成员

成员种类签名说明
activityId属性activityId: string公开属性;类型、只读和可选状态以签名列为准。
deadlineAt属性deadlineAt?: string公开属性;类型、只读和可选状态以签名列为准。
fencingToken属性fencingToken: number公开属性;类型、只读和可选状态以签名列为准。
operationId属性operationId: string公开属性;类型、只读和可选状态以签名列为准。
runId属性runId: string公开属性;类型、只读和可选状态以签名列为准。
stateAttemptId属性stateAttemptId: string公开属性;类型、只读和可选状态以签名列为准。
workspaceId属性workspaceId: string公开属性;类型、只读和可选状态以签名列为准。

ExecutionHumanTaskCommandSnapshot

Execution Human Task Command Snapshot 接口,共包含 12 个公开字段或方法。

声明

text
export interface ExecutionHumanTaskCommandSnapshot {
    executable: string;
    args: string[];
    cwd?: string;
    shell: boolean;
    environmentVariableNames: string[];
    secretRefs: string[];
    networkAuthorizationRef?: string;
    expectedWorkspaceSnapshotHash?: string;
    timeoutMs?: number;
    idleTimeoutMs?: number;
    maxStdoutBytes?: number;
    maxStderrBytes?: number;
}

契约成员

成员种类签名说明
args属性args: string[]公开属性;类型、只读和可选状态以签名列为准。
cwd属性cwd?: string公开属性;类型、只读和可选状态以签名列为准。
environmentVariableNames属性environmentVariableNames: string[]公开属性;类型、只读和可选状态以签名列为准。
executable属性executable: string公开属性;类型、只读和可选状态以签名列为准。
expectedWorkspaceSnapshotHash属性expectedWorkspaceSnapshotHash?: string公开属性;类型、只读和可选状态以签名列为准。
idleTimeoutMs属性idleTimeoutMs?: number公开属性;类型、只读和可选状态以签名列为准。
maxStderrBytes属性maxStderrBytes?: number公开属性;类型、只读和可选状态以签名列为准。
maxStdoutBytes属性maxStdoutBytes?: number公开属性;类型、只读和可选状态以签名列为准。
networkAuthorizationRef属性networkAuthorizationRef?: string公开属性;类型、只读和可选状态以签名列为准。
secretRefs属性secretRefs: string[]公开属性;类型、只读和可选状态以签名列为准。
shell属性shell: boolean公开属性;类型、只读和可选状态以签名列为准。
timeoutMs属性timeoutMs?: number公开属性;类型、只读和可选状态以签名列为准。

ExecutionHumanTaskEnvironmentSnapshot

Execution Human Task Environment Snapshot 接口,共包含 11 个公开字段或方法。

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

声明

text
export interface ExecutionHumanTaskEnvironmentSnapshot {
    id: string;
    version: string;
    revision: string;
    provider: 'mock' | 'local_process' | 'docker' | 'remote_sandbox' | 'custom';
    providerRef?: string;
    providerId: string;
    providerRevision: string;
    imageDigest?: string;
    mounts: SandboxMountSpec[];
    network: ExecutionHumanTaskNetworkSnapshot;
    resources: ResourceLimitSpec;
}

契约成员

成员种类签名说明
id属性id: string公开属性;类型、只读和可选状态以签名列为准。
imageDigest属性imageDigest?: string公开属性;类型、只读和可选状态以签名列为准。
mounts属性mounts: SandboxMountSpec[]公开属性;类型、只读和可选状态以签名列为准。
network属性network: ExecutionHumanTaskNetworkSnapshot公开属性;类型、只读和可选状态以签名列为准。
provider属性provider: "mock" | "local_process" | "docker" | "remote_sandbox" | "custom"公开属性;类型、只读和可选状态以签名列为准。
providerId属性providerId: string公开属性;类型、只读和可选状态以签名列为准。
providerRef属性providerRef?: string公开属性;类型、只读和可选状态以签名列为准。
providerRevision属性providerRevision: string公开属性;类型、只读和可选状态以签名列为准。
resources属性resources: ResourceLimitSpec公开属性;类型、只读和可选状态以签名列为准。
revision属性revision: string公开属性;类型、只读和可选状态以签名列为准。
version属性version: string公开属性;类型、只读和可选状态以签名列为准。

ExecutionHumanTaskExpectedEffects

Execution Human Task Expected Effects 接口,共包含 4 个公开字段或方法。

声明

text
export interface ExecutionHumanTaskExpectedEffects {
    workspaceWrite: boolean;
    networkAccess: boolean;
    secretAccess: boolean;
    artifactCapture: boolean;
}

契约成员

成员种类签名说明
artifactCapture属性artifactCapture: boolean公开属性;类型、只读和可选状态以签名列为准。
networkAccess属性networkAccess: boolean公开属性;类型、只读和可选状态以签名列为准。
secretAccess属性secretAccess: boolean公开属性;类型、只读和可选状态以签名列为准。
workspaceWrite属性workspaceWrite: boolean公开属性;类型、只读和可选状态以签名列为准。

ExecutionHumanTaskNetworkSnapshot

Execution Human Task Network Snapshot 接口,共包含 7 个公开字段或方法。

声明

text
export interface ExecutionHumanTaskNetworkSnapshot {
    mode: 'disabled' | 'restricted' | 'enabled' | 'task_authorized';
    allowedDomains: string[];
    allowedCidrs: string[];
    allowedPorts: number[];
    allowedProtocols: Array<'tcp' | 'udp' | 'http' | 'https' | 'dns'>;
    proxyRef?: string;
    authorizationRef?: string;
}

契约成员

成员种类签名说明
allowedCidrs属性allowedCidrs: string[]公开属性;类型、只读和可选状态以签名列为准。
allowedDomains属性allowedDomains: string[]公开属性;类型、只读和可选状态以签名列为准。
allowedPorts属性allowedPorts: number[]公开属性;类型、只读和可选状态以签名列为准。
allowedProtocols属性allowedProtocols: ("tcp" | "udp" | "http" | "https" | "dns")[]公开属性;类型、只读和可选状态以签名列为准。
authorizationRef属性authorizationRef?: string公开属性;类型、只读和可选状态以签名列为准。
mode属性mode: "disabled" | "restricted" | "enabled" | "task_authorized"公开属性;类型、只读和可选状态以签名列为准。
proxyRef属性proxyRef?: string公开属性;类型、只读和可选状态以签名列为准。

ExecutionHumanTaskRiskSnapshot

Execution Human Task Risk Snapshot 接口,共包含 5 个公开字段或方法。

声明

text
export interface ExecutionHumanTaskRiskSnapshot {
    assessmentId: string;
    level: RiskLevel;
    reasons: string[];
    matchedRules: string[];
    policyDecisionRef: string;
}

契约成员

成员种类签名说明
assessmentId属性assessmentId: string公开属性;类型、只读和可选状态以签名列为准。
level属性level: RiskLevel公开属性;类型、只读和可选状态以签名列为准。
matchedRules属性matchedRules: string[]公开属性;类型、只读和可选状态以签名列为准。
policyDecisionRef属性policyDecisionRef: string公开属性;类型、只读和可选状态以签名列为准。
reasons属性reasons: string[]公开属性;类型、只读和可选状态以签名列为准。

ExecutionHumanTaskSubject

Versioned, redacted subject approved by a Runtime HumanTask before command dispatch. Environment values, stdin, Secret values, and arbitrary request metadata are intentionally absent.

声明

text
export interface ExecutionHumanTaskSubject {
    id: string;
    version: typeof EXECUTION_HUMAN_TASK_SUBJECT_VERSION;
    kind: 'execution';
    capturedAt: string;
    principalId: string;
    inputHash: string;
    activity: ExecutionHumanTaskActivityIdentity;
    tool: ExecutionHumanTaskToolIdentity;
    command: ExecutionHumanTaskCommandSnapshot;
    environment: ExecutionHumanTaskEnvironmentSnapshot;
    risk: ExecutionHumanTaskRiskSnapshot;
    expectedEffects: ExecutionHumanTaskExpectedEffects;
}

契约成员

成员种类签名说明
activity属性activity: ExecutionHumanTaskActivityIdentity公开属性;类型、只读和可选状态以签名列为准。
capturedAt属性capturedAt: string公开属性;类型、只读和可选状态以签名列为准。
command属性command: ExecutionHumanTaskCommandSnapshot公开属性;类型、只读和可选状态以签名列为准。
environment属性environment: ExecutionHumanTaskEnvironmentSnapshot公开属性;类型、只读和可选状态以签名列为准。
expectedEffects属性expectedEffects: ExecutionHumanTaskExpectedEffects公开属性;类型、只读和可选状态以签名列为准。
id属性id: string公开属性;类型、只读和可选状态以签名列为准。
inputHash属性inputHash: string公开属性;类型、只读和可选状态以签名列为准。
kind属性kind: "execution"公开属性;类型、只读和可选状态以签名列为准。
principalId属性principalId: string公开属性;类型、只读和可选状态以签名列为准。
risk属性risk: ExecutionHumanTaskRiskSnapshot公开属性;类型、只读和可选状态以签名列为准。
tool属性tool: ExecutionHumanTaskToolIdentity公开属性;类型、只读和可选状态以签名列为准。
version属性version: "1.0.0"公开属性;类型、只读和可选状态以签名列为准。

ExecutionHumanTaskSubjectEnvelope

Execution Human Task Subject Envelope 接口,共包含 3 个公开字段或方法。

声明

text
export interface ExecutionHumanTaskSubjectEnvelope {
    subjectRef: string;
    subjectHash: string;
    subject: ExecutionHumanTaskSubject;
}

契约成员

成员种类签名说明
subject属性subject: ExecutionHumanTaskSubject公开属性;类型、只读和可选状态以签名列为准。
subjectHash属性subjectHash: string公开属性;类型、只读和可选状态以签名列为准。
subjectRef属性subjectRef: string公开属性;类型、只读和可选状态以签名列为准。

ExecutionHumanTaskToolIdentity

Execution Human Task Tool Identity 接口,共包含 6 个公开字段或方法。

声明

text
export interface ExecutionHumanTaskToolIdentity {
    toolId: string;
    toolRevision?: string;
    operation: ExecutionToolOperation;
    executionProfileRef: string;
    sideEffectLevel: ExecutionToolSideEffectLevel;
    humanReviewPolicyRef: string;
}

契约成员

成员种类签名说明
executionProfileRef属性executionProfileRef: string公开属性;类型、只读和可选状态以签名列为准。
humanReviewPolicyRef属性humanReviewPolicyRef: string公开属性;类型、只读和可选状态以签名列为准。
operation属性operation: "artifact" | "command" | "file_read" | "file_write" | "sandbox"公开属性;类型、只读和可选状态以签名列为准。
sideEffectLevel属性sideEffectLevel: ExecutionToolSideEffectLevel公开属性;类型、只读和可选状态以签名列为准。
toolId属性toolId: string公开属性;类型、只读和可选状态以签名列为准。
toolRevision属性toolRevision?: string公开属性;类型、只读和可选状态以签名列为准。