@codesoul-co/hypha-core / modules/execution-activities/index
模块用法
用于执行该边界的运行时行为。Index 模块公开 11 常量、3 函数。
从包入口导入
ts
import {
executionActivityJsonSchemas,
executionActivityRequestExample,
executionActivityRequestJsonSchema,
executionActivityRequestSchema,
executionActivityResultExample,
executionActivityResultJsonSchema,
executionActivityResultSchema,
executionActivityStatusSchema,
} from '@codesoul-co/hypha-core';
// 完整导出列表见下方。使用要点
- 3 个函数是该模块的直接操作入口；每个 overload 的必需/可选参数与返回类型均在下方列出。
- 11 个常量/枚举提供稳定值、Schema、Definition 或默认配置；应复用这些导出，避免在应用中复制内部值。
运行时校验示例
ts
import { executionActivityRequestSchema } from '@codesoul-co/hypha-core';
declare function loadExternalInput(): unknown;
const input: unknown = loadExternalInput();
const parsed = executionActivityRequestSchema.parse(input);配置、网络请求或持久化数据等不可信输入应先通过 Runtime Schema，再传给只接受已校验契约的函数或类。
公共导出
| Symbol | 种类 | 签名 | 说明 |
|---|---|---|---|
executionActivityJsonSchemas | 常量 | const executionActivityJsonSchemas: Record<string, JsonSchema> | 由 modules/execution-activities/index 模块导出的 Execution Activity JSON Schemas 常量。 |
executionActivityRequestExample | 常量 | const executionActivityRequestExample: ExecutionActivityRequest | Execution Activity Request 的有效示例值。 |
executionActivityRequestJsonSchema | 常量 | const executionActivityRequestJsonSchema: JsonSchema | Execution Activity Request 的 JSON Schema。 |
executionActivityRequestSchema | 常量 | const executionActivityRequestSchema: z.ZodEffects<z.ZodObject<{ activityId: z.ZodString; operationId: z.ZodString; runId: z.ZodString; stateAttemptId: z.ZodString; workspaceId: z.ZodString; request: z.ZodUnion<[z.ZodEffects<z.ZodObject<{ executionId: z.ZodOptional<z.ZodString>; operationId: z.ZodString; principal: z.ZodObject<{ principalId: z.ZodString; type: z.ZodEnum<["user", "agent", "service", "system"]>; ten... | Execution Activity Request 的运行时 Schema。 |
executionActivityResultExample | 常量 | const executionActivityResultExample: ExecutionActivityResult | Execution Activity Result 的有效示例值。 |
executionActivityResultJsonSchema | 常量 | const executionActivityResultJsonSchema: JsonSchema | Execution Activity Result 的 JSON Schema。 |
executionActivityResultSchema | 常量 | const executionActivityResultSchema: z.ZodEffects<z.ZodObject<{ activityId: z.ZodString; status: z.ZodEnum<["completed", "failed", "timeout", "cancelled", "unknown"]>; executionId: z.ZodOptional<z.ZodString>; artifactRefs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; snapshotRef: z.ZodOptional<z.ZodString>; eventIds: z.ZodArray<z.ZodString, "many">; error: z.ZodOptional<z.ZodObject<{ code: z.ZodEnum<["EXECUTION... | Execution Activity Result 的运行时 Schema。 |
executionActivityStatusSchema | 常量 | const executionActivityStatusSchema: z.ZodEnum<["completed", "failed", "timeout", "cancelled", "unknown"]> | Execution Activity Status 的运行时 Schema。 |
workspaceExecutionActivityRequestExample | 常量 | const workspaceExecutionActivityRequestExample: ExecutionActivityRequest | Workspace Execution Activity Request 的有效示例值。 |
workspaceOperationRequestJsonSchema | 常量 | const workspaceOperationRequestJsonSchema: JsonSchema | Workspace Operation Request 的 JSON Schema。 |
workspaceOperationRequestSchema | 常量 | const workspaceOperationRequestSchema: z.ZodUnion<[z.ZodObject<{ workspaceId: z.ZodString; principal: z.ZodObject<{ principalId: z.ZodString; type: z.ZodEnum<["user", "agent", "service", "system"]>; tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodOptional<z.ZodString>; agentId: z.ZodOptional<z.ZodString>; roles: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; permissionScopes: z.ZodArray<z.ZodString, "many">; m... | Workspace Operation Request 的运行时 Schema。 |
validateExecutionActivityRequest | 函数 | validateExecutionActivityRequest(input: unknown): ExecutionActivityRequest | Validate Execution Activity Request 函数，提供 1 个公开调用签名；参数与返回类型见下表。 |
validateExecutionActivityResult | 函数 | validateExecutionActivityResult(input: unknown): ExecutionActivityResult | Validate Execution Activity Result 函数，提供 1 个公开调用签名；参数与返回类型见下表。 |
validateWorkspaceOperationRequest | 函数 | validateWorkspaceOperationRequest(input: unknown): WorkspaceOperationRequest | Validate Workspace Operation Request 函数，提供 1 个公开调用签名；参数与返回类型见下表。 |
executionActivityJsonSchemas
由 modules/execution-activities/index 模块导出的 Execution Activity JSON Schemas 常量。
- 种类: 常量
- 导入:
import { executionActivityJsonSchemas } from '@codesoul-co/hypha-core'; - 源码模块:
modules/execution-activities/index
声明
text
export declare const executionActivityJsonSchemas: Record<string, JsonSchema>;executionActivityRequestExample
Execution Activity Request 的有效示例值。
- 种类: 常量
- 导入:
import { executionActivityRequestExample } from '@codesoul-co/hypha-core'; - 源码模块:
modules/execution-activities/index
声明
text
export declare const executionActivityRequestExample: ExecutionActivityRequest;executionActivityRequestJsonSchema
Execution Activity Request 的 JSON Schema。
- 种类: 常量
- 导入:
import { executionActivityRequestJsonSchema } from '@codesoul-co/hypha-core'; - 源码模块:
modules/execution-activities/index
声明
text
export declare const executionActivityRequestJsonSchema: JsonSchema;executionActivityRequestSchema
Execution Activity Request 的运行时 Schema。
- 种类: 常量
- 导入:
import { executionActivityRequestSchema } from '@codesoul-co/hypha-core'; - 源码模块:
modules/execution-activities/index
声明
text
// 精确类型由包入口解析；完整编译器展开定义见源码链接。
export declare const executionActivityRequestSchema: (typeof import('@codesoul-co/hypha-core'))['executionActivityRequestSchema'];该常量的编译器展开类型已压缩；它的公共名称、顶层类型与源码位置仍保留在本条目中。相关输入/输出字段请使用同模块导出的接口、类型或 Runtime Schema。
executionActivityResultExample
Execution Activity Result 的有效示例值。
- 种类: 常量
- 导入:
import { executionActivityResultExample } from '@codesoul-co/hypha-core'; - 源码模块:
modules/execution-activities/index
声明
text
export declare const executionActivityResultExample: ExecutionActivityResult;executionActivityResultJsonSchema
Execution Activity Result 的 JSON Schema。
- 种类: 常量
- 导入:
import { executionActivityResultJsonSchema } from '@codesoul-co/hypha-core'; - 源码模块:
modules/execution-activities/index
声明
text
export declare const executionActivityResultJsonSchema: JsonSchema;executionActivityResultSchema
Execution Activity Result 的运行时 Schema。
- 种类: 常量
- 导入:
import { executionActivityResultSchema } from '@codesoul-co/hypha-core'; - 源码模块:
modules/execution-activities/index
声明
text
// 精确类型由包入口解析；完整编译器展开定义见源码链接。
export declare const executionActivityResultSchema: (typeof import('@codesoul-co/hypha-core'))['executionActivityResultSchema'];该常量的编译器展开类型已压缩；它的公共名称、顶层类型与源码位置仍保留在本条目中。相关输入/输出字段请使用同模块导出的接口、类型或 Runtime Schema。
executionActivityStatusSchema
Execution Activity Status 的运行时 Schema。
- 种类: 常量
- 导入:
import { executionActivityStatusSchema } from '@codesoul-co/hypha-core'; - 源码模块:
modules/execution-activities/index
声明
text
export declare const executionActivityStatusSchema: z.ZodEnum<["completed", "failed", "timeout", "cancelled", "unknown"]>;workspaceExecutionActivityRequestExample
Workspace Execution Activity Request 的有效示例值。
- 种类: 常量
- 导入:
import { workspaceExecutionActivityRequestExample } from '@codesoul-co/hypha-core'; - 源码模块:
modules/execution-activities/index
声明
text
export declare const workspaceExecutionActivityRequestExample: ExecutionActivityRequest;workspaceOperationRequestJsonSchema
Workspace Operation Request 的 JSON Schema。
- 种类: 常量
- 导入:
import { workspaceOperationRequestJsonSchema } from '@codesoul-co/hypha-core'; - 源码模块:
modules/execution-activities/index
声明
text
export declare const workspaceOperationRequestJsonSchema: JsonSchema;workspaceOperationRequestSchema
Workspace Operation Request 的运行时 Schema。
- 种类: 常量
- 导入:
import { workspaceOperationRequestSchema } from '@codesoul-co/hypha-core'; - 源码模块:
modules/execution-activities/index
声明
text
// 精确类型由包入口解析；完整编译器展开定义见源码链接。
export declare const workspaceOperationRequestSchema: (typeof import('@codesoul-co/hypha-core'))['workspaceOperationRequestSchema'];该常量的编译器展开类型已压缩；它的公共名称、顶层类型与源码位置仍保留在本条目中。相关输入/输出字段请使用同模块导出的接口、类型或 Runtime Schema。
validateExecutionActivityRequest
Validate Execution Activity Request 函数，提供 1 个公开调用签名；参数与返回类型见下表。
- 种类: 函数
- 导入:
import { validateExecutionActivityRequest } from '@codesoul-co/hypha-core'; - 源码模块:
modules/execution-activities/index
声明
text
export declare function validateExecutionActivityRequest(input: unknown): ExecutionActivityRequest;调用签名
text
validateExecutionActivityRequest(input: unknown): ExecutionActivityRequest参数
| 参数 | 类型 | 必需 | 说明 |
|---|---|---|---|
input | unknown | 是 | 必需参数；接受的值由类型列定义。 |
返回值
- 类型:
ExecutionActivityRequest - 说明: 返回值契约由上述类型定义。
validateExecutionActivityResult
Validate Execution Activity Result 函数，提供 1 个公开调用签名；参数与返回类型见下表。
- 种类: 函数
- 导入:
import { validateExecutionActivityResult } from '@codesoul-co/hypha-core'; - 源码模块:
modules/execution-activities/index
声明
text
export declare function validateExecutionActivityResult(input: unknown): ExecutionActivityResult;调用签名
text
validateExecutionActivityResult(input: unknown): ExecutionActivityResult参数
| 参数 | 类型 | 必需 | 说明 |
|---|---|---|---|
input | unknown | 是 | 必需参数；接受的值由类型列定义。 |
返回值
- 类型:
ExecutionActivityResult - 说明: 返回值契约由上述类型定义。
validateWorkspaceOperationRequest
Validate Workspace Operation Request 函数，提供 1 个公开调用签名；参数与返回类型见下表。
- 种类: 函数
- 导入:
import { validateWorkspaceOperationRequest } from '@codesoul-co/hypha-core'; - 源码模块:
modules/execution-activities/index
声明
text
export declare function validateWorkspaceOperationRequest(input: unknown): WorkspaceOperationRequest;调用签名
text
validateWorkspaceOperationRequest(input: unknown): WorkspaceOperationRequest参数
| 参数 | 类型 | 必需 | 说明 |
|---|---|---|---|
input | unknown | 是 | 必需参数；接受的值由类型列定义。 |
返回值
- 类型:
WorkspaceOperationRequest - 说明: 返回值契约由上述类型定义。