HYPHA / DOCS

简体中文

English

简体中文

English

@codesoul-co/hypha-core / contracts/execution-activities ​

模块用法 ​

用于声明并运行时校验契约。Execution activities 模块公开 1 常量、2 接口、2 类型。

从包入口导入 ​

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

import type {
  ExecutionActivityRequest,
  ExecutionActivityResult,
  ExecutionActivityStatus,
  WorkspaceOperationRequest,
} from '@codesoul-co/hypha-core';

使用要点 ​

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

公共导出 ​

Symbol种类签名说明
EXECUTION_ACTIVITY_STATUSES常量const EXECUTION_ACTIVITY_STATUSES: readonly ["completed", "failed", "timeout", "cancelled", "unknown"]由 contracts/execution-activities 模块导出的 EXECUTION ACTIVITY STATUSES 常量。
ExecutionActivityRequest接口interface ExecutionActivityRequestExecution Activity Request 接口，共包含 9 个公开字段或方法。
ExecutionActivityResult接口interface ExecutionActivityResultExecution Activity Result 接口，共包含 7 个公开字段或方法。
ExecutionActivityStatus类型type ExecutionActivityStatus = (typeof EXECUTION_ACTIVITY_STATUSES)[number]Execution Activity Status 公共类型别名；完整类型表达式见声明。
WorkspaceOperationRequest类型type WorkspaceOperationRequest = WorkspacePathRequest | WorkspaceListRequest | WorkspaceReadRequest | WorkspaceWriteRequest | WorkspaceDeleteRequest | WorkspaceSnapshotRequest | WorkspaceRestoreRequest | WorkspaceDiffRequest | WorkspacePatchRequestWorkspace Operation Request 公共类型别名；完整类型表达式见声明。

EXECUTION_ACTIVITY_STATUSES ​

由 contracts/execution-activities 模块导出的 EXECUTION ACTIVITY STATUSES 常量。

声明 ​

text
export declare const EXECUTION_ACTIVITY_STATUSES: readonly ["completed", "failed", "timeout", "cancelled", "unknown"];

ExecutionActivityRequest ​

Execution Activity Request 接口，共包含 9 个公开字段或方法。

声明 ​

text
export interface ExecutionActivityRequest {
    activityId: string;
    operationId: string;
    runId: string;
    stateAttemptId: string;
    workspaceId: string;
    request: CommandExecutionRequest | WorkspaceOperationRequest;
    fencingToken: number;
    deadlineAt?: string;
    idempotencyKey?: string;
}

契约成员 ​

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

ExecutionActivityResult ​

Execution Activity Result 接口，共包含 7 个公开字段或方法。

声明 ​

text
export interface ExecutionActivityResult {
    activityId: string;
    status: ExecutionActivityStatus;
    executionId?: string;
    artifactRefs?: string[];
    snapshotRef?: string;
    eventIds: string[];
    error?: NormalizedExecutionError;
}

契约成员 ​

成员种类签名说明
activityId属性activityId: string公开属性；类型、只读和可选状态以签名列为准。
artifactRefs属性artifactRefs?: string[]公开属性；类型、只读和可选状态以签名列为准。
error属性error?: NormalizedExecutionError公开属性；类型、只读和可选状态以签名列为准。
eventIds属性eventIds: string[]公开属性；类型、只读和可选状态以签名列为准。
executionId属性executionId?: string公开属性；类型、只读和可选状态以签名列为准。
snapshotRef属性snapshotRef?: string公开属性；类型、只读和可选状态以签名列为准。
status属性status: "unknown" | "completed" | "cancelled" | "failed" | "timeout"公开属性；类型、只读和可选状态以签名列为准。

ExecutionActivityStatus ​

Execution Activity Status 公共类型别名；完整类型表达式见声明。

声明 ​

text
export type ExecutionActivityStatus = (typeof EXECUTION_ACTIVITY_STATUSES)[number];

WorkspaceOperationRequest ​

Workspace Operation Request 公共类型别名；完整类型表达式见声明。

声明 ​

text
export type WorkspaceOperationRequest = WorkspacePathRequest | WorkspaceListRequest | WorkspaceReadRequest | WorkspaceWriteRequest | WorkspaceDeleteRequest | WorkspaceSnapshotRequest | WorkspaceRestoreRequest | WorkspaceDiffRequest | WorkspacePatchRequest;