HYPHA / DOCS

简体中文

English

简体中文

English

@codesoul-co/hypha-core / contracts/runtime-activity-schemas ​

模块用法 ​

用于声明并运行时校验契约。Runtime activity schemas 模块公开 13 常量、4 函数。

从包入口导入 ​

ts
import {
  runtimeActivityContractDefinitions,
  runtimeActivityContractJsonSchemas,
  runtimeActivityDescriptorDefinition,
  runtimeActivityDescriptorExample,
  runtimeActivityDescriptorJsonSchema,
  runtimeActivityDescriptorSchema,
  runtimeActivityInvocationSchema,
  runtimeActivityObservationJsonSchema,
} from '@codesoul-co/hypha-core';

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

使用要点 ​

  • 4 个函数是该模块的直接操作入口；每个 overload 的必需/可选参数与返回类型均在下方列出。
  • 13 个常量/枚举提供稳定值、Schema、Definition 或默认配置；应复用这些导出，避免在应用中复制内部值。

运行时校验示例 ​

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

declare function loadExternalInput(): unknown;
const input: unknown = loadExternalInput();
const parsed = runtimeActivityDescriptorSchema.parse(input);

配置、网络请求或持久化数据等不可信输入应先通过 Runtime Schema，再传给只接受已校验契约的函数或类。

公共导出 ​

Symbol种类签名说明
runtimeActivityContractDefinitions常量const runtimeActivityContractDefinitions: readonly [SpecSchemaDefinition<RuntimeActivityRequest<RuntimeJsonValue>>, SpecSchemaDefinition<RuntimeActivityDescriptor>]由 contracts/runtime-activity-schemas 模块导出的 Runtime Activity Contract Definitions 常量。
runtimeActivityContractJsonSchemas常量const runtimeActivityContractJsonSchemas: Record<string, JsonSchema>由 contracts/runtime-activity-schemas 模块导出的 Runtime Activity Contract JSON Schemas 常量。
runtimeActivityDescriptorDefinition常量const runtimeActivityDescriptorDefinition: SpecSchemaDefinition<RuntimeActivityDescriptor>由 contracts/runtime-activity-schemas 模块导出的 Runtime Activity Descriptor Definition 常量。
runtimeActivityDescriptorExample常量const runtimeActivityDescriptorExample: RuntimeActivityDescriptorRuntime Activity Descriptor 的有效示例值。
runtimeActivityDescriptorJsonSchema常量const runtimeActivityDescriptorJsonSchema: JsonSchemaRuntime Activity Descriptor 的 JSON Schema。
runtimeActivityDescriptorSchema常量const runtimeActivityDescriptorSchema: z.ZodObject<{ version: z.ZodLiteral<"1.0.0">; activityId: z.ZodString; activityKind: z.ZodEnum<["react_quantum", "tool", "memory", "execution", "mcp", "policy"]>; runId: z.ZodString; stateId: z.ZodString; stateAttempt: z.ZodNumber; operationId: z.ZodString; inputRef: z.ZodString; inputHash: z.ZodString; providerRef: z.ZodOptional<z.ZodString>; providerRevision: z.ZodOptional<...Runtime Activity Descriptor 的运行时 Schema。
runtimeActivityInvocationSchema常量const runtimeActivityInvocationSchema: z.ZodObject<{ activityId: z.ZodString; operationId: z.ZodString; activityType: z.ZodEnum<["tool", "memory", "model", "execution", "custom"]>; target: z.ZodString; input: z.ZodType<RuntimeJsonValue, z.ZodTypeDef, RuntimeJsonValue>; scope: z.ZodObject<{ tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodString; workspaceId: z.ZodOptional<z.ZodString>; sessionId: z.ZodString; ru...Runtime Activity Invocation 的运行时 Schema。
runtimeActivityObservationJsonSchema常量const runtimeActivityObservationJsonSchema: JsonSchemaRuntime Activity Observation 的 JSON Schema。
runtimeActivityObservationSchema常量const runtimeActivityObservationSchema: z.ZodEffects<z.ZodObject<{ activityId: z.ZodString; status: z.ZodEnum<["completed", "failed", "waiting", "cancelled"]>; eventIds: z.ZodArray<z.ZodString, "many">; output: z.ZodOptional<z.ZodType<RuntimeJsonValue, z.ZodTypeDef, RuntimeJsonValue>>; artifactRefs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; retryable: z.ZodOptional<z.ZodBoolean>; error: z.ZodOptional<z.ZodOb...Runtime Activity Observation 的运行时 Schema。
runtimeActivityRequestDefinition常量const runtimeActivityRequestDefinition: SpecSchemaDefinition<RuntimeActivityRequest<RuntimeJsonValue>>由 contracts/runtime-activity-schemas 模块导出的 Runtime Activity Request Definition 常量。
runtimeActivityRequestExample常量const runtimeActivityRequestExample: RuntimeActivityRequest<RuntimeJsonValue>Runtime Activity Request 的有效示例值。
runtimeActivityRequestJsonSchema常量const runtimeActivityRequestJsonSchema: JsonSchemaRuntime Activity Request 的 JSON Schema。
runtimeActivityRequestSchema常量const runtimeActivityRequestSchema: z.ZodObject<{ target: z.ZodString; input: z.ZodType<RuntimeJsonValue, z.ZodTypeDef, RuntimeJsonValue>; options: z.ZodOptional<z.ZodObject<{ effect: z.ZodOptional<z.ZodEnum<["pure", "idempotent", "external_effect", "irreversible"]>>; timeoutMs: z.ZodOptional<z.ZodNumber>; retry: z.ZodOptional<z.ZodEffects<z.ZodObject<{ maxAttempts: z.ZodNumber; initialDelayMs: z.ZodOptional<z.Zod...Runtime Activity Request 的运行时 Schema。
validateRuntimeActivityDescriptor函数validateRuntimeActivityDescriptor(input: unknown): RuntimeActivityDescriptorValidate Runtime Activity Descriptor 函数，提供 1 个公开调用签名；参数与返回类型见下表。
validateRuntimeActivityInvocation函数validateRuntimeActivityInvocation(input: unknown): RuntimeActivityInvocationValidate Runtime Activity Invocation 函数，提供 1 个公开调用签名；参数与返回类型见下表。
validateRuntimeActivityObservation函数validateRuntimeActivityObservation(input: unknown): RuntimeActivityObservationValidate Runtime Activity Observation 函数，提供 1 个公开调用签名；参数与返回类型见下表。
validateRuntimeActivityRequest函数validateRuntimeActivityRequest(input: unknown): RuntimeActivityRequestValidate Runtime Activity Request 函数，提供 1 个公开调用签名；参数与返回类型见下表。

runtimeActivityContractDefinitions ​

由 contracts/runtime-activity-schemas 模块导出的 Runtime Activity Contract Definitions 常量。

声明 ​

text
export declare const runtimeActivityContractDefinitions: readonly [SpecSchemaDefinition<RuntimeActivityRequest<RuntimeJsonValue>>, SpecSchemaDefinition<RuntimeActivityDescriptor>];

runtimeActivityContractJsonSchemas ​

由 contracts/runtime-activity-schemas 模块导出的 Runtime Activity Contract JSON Schemas 常量。

声明 ​

text
export declare const runtimeActivityContractJsonSchemas: Record<string, JsonSchema>;

runtimeActivityDescriptorDefinition ​

由 contracts/runtime-activity-schemas 模块导出的 Runtime Activity Descriptor Definition 常量。

声明 ​

text
export declare const runtimeActivityDescriptorDefinition: SpecSchemaDefinition<RuntimeActivityDescriptor>;

runtimeActivityDescriptorExample ​

Runtime Activity Descriptor 的有效示例值。

声明 ​

text
export declare const runtimeActivityDescriptorExample: RuntimeActivityDescriptor;

runtimeActivityDescriptorJsonSchema ​

Runtime Activity Descriptor 的 JSON Schema。

声明 ​

text
export declare const runtimeActivityDescriptorJsonSchema: JsonSchema;

runtimeActivityDescriptorSchema ​

Runtime Activity Descriptor 的运行时 Schema。

声明 ​

text
export declare const runtimeActivityDescriptorSchema: z.ZodObject<{ version: z.ZodLiteral<"1.0.0">; activityId: z.ZodString; activityKind: z.ZodEnum<["react_quantum", "tool", "memory", "execution", "mcp", "policy"]>; runId: z.ZodString; stateId: z.ZodString; stateAttempt: z.ZodNumber; operationId: z.ZodString; inputRef: z.ZodString; inputHash: z.ZodString; providerRef: z.ZodOptional<z.ZodString>; providerRevision: z.ZodOptional<z.ZodString>; idempotencyKey: z.ZodString; deadlineAt: z.ZodOptional<z.ZodString>; }, "strict", z.ZodTypeAny, { operationId: string; version: "1.0.0"; runId: string; idempotencyKey: string; stateAttempt: number; stateId: string; activityId: string; activityKind: "tool" | "memory" | "execution" | "policy" | "mcp" | "react_quantum"; inputRef: string; inputHash: string; providerRevision?: string | undefined; providerRef?: string | undefined; deadlineAt?: string | undefined; }, { operationId: string; version: "1.0.0"; runId: string; idempotencyKey: string; stateAttempt: number; stateId: string; activityId: string; activityKind: "tool" | "memory" | "execution" | "policy" | "mcp" | "react_quantum"; inputRef: string; inputHash: string; providerRevision?: string | undefined; providerRef?: string | undefined; deadlineAt?: string | undefined; }>;

runtimeActivityInvocationSchema ​

Runtime Activity Invocation 的运行时 Schema。

声明 ​

text
export declare const runtimeActivityInvocationSchema: z.ZodObject<{ activityId: z.ZodString; operationId: z.ZodString; activityType: z.ZodEnum<["tool", "memory", "model", "execution", "custom"]>; target: z.ZodString; input: z.ZodType<RuntimeJsonValue, z.ZodTypeDef, RuntimeJsonValue>; scope: z.ZodObject<{ tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodString; workspaceId: z.ZodOptional<z.ZodString>; sessionId: z.ZodString; runId: z.ZodString; agentId: z.ZodOptional<z.ZodString>; }, "strict", z.ZodTypeAny, { sessionId: string; runId: string; userId: string; workspaceId?: string | undefined; agentId?: string | undefined; tenantId?: string | undefined; }, { sessionId: string; runId: string; userId: string; workspaceId?: string | undefined; agentId?: string | undefined; tenantId?: string | undefined; }>; stateId: z.ZodString; stateAttempt: z.ZodNumber; fencingToken: z.ZodNumber; correlationId: z.ZodString; causationId: z.ZodOptional<z.ZodString>; idempotencyKey: z.ZodString; requestedAt: z.ZodString; effect: z.ZodEnum<["pure", "idempotent", "external_effect", "irreversible"]>; timeoutMs: z.ZodOptional<z.ZodNumber>; retry: z.ZodOptional<z.ZodEffects<z.ZodObject<{ maxAttempts: z.ZodNumber; initialDelayMs: z.ZodOptional<z.ZodNumber>; maxDelayMs: z.ZodOptional<z.ZodNumber>; }, "strict", z.ZodTypeAny, { maxAttempts: number; initialDelayMs?: number | undefined; maxDelayMs?: number | undefined; }, { maxAttempts: number; initialDelayMs?: number | undefined; maxDelayMs?: number | undefined; }>, { maxAttempts: number; initialDelayMs?: number | undefined; maxDelayMs?: number | undefined; }, { maxAttempts: number; initialDelayMs?: number | undefined; maxDelayMs?: number | undefined; }>>; metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodType<RuntimeJsonValue, z.ZodTypeDef, RuntimeJsonValue>>>; }, "strict", z.ZodTypeAny, { operationId: string; effect: "pure" | "idempotent" | "external_effect" | "irreversible"; correlationId: string; idempotencyKey: string; scope: { sessionId: string; runId: string; userId: string; workspaceId?: string | undefined; agentId?: string | undefined; tenantId?: string | undefined; }; stateAttempt: number; stateId: string; requestedAt: string; fencingToken: number; activityId: string; activityType: "custom" | "tool" | "memory" | "model" | "execution"; input: RuntimeJsonValue; target: string; metadata?: Record<string, RuntimeJsonValue> | undefined; causationId?: string | undefined; timeoutMs?: number | undefined; retry?: { maxAttempts: number; initialDelayMs?: number | undefined; maxDelayMs?: number | undefined; } | undefined; }, { operationId: string; effect: "pure" | "idempotent" | "external_effect" | "irreversible"; correlationId: string; idempotencyKey: string; scope: { sessionId: string; runId: string; userId: string; workspaceId?: string | undefined; agentId?: string | undefined; tenantId?: string | undefined; }; stateAttempt: number; stateId: string; requestedAt: string; fencingToken: number; activityId: string; activityType: "custom" | "tool" | "memory" | "model" | "execution"; input: RuntimeJsonValue; target: string; metadata?: Record<string, RuntimeJsonValue> | undefined; causationId?: string | undefined; timeoutMs?: number | undefined; retry?: { maxAttempts: number; initialDelayMs?: number | undefined; maxDelayMs?: number | undefined; } | undefined; }>;

runtimeActivityObservationJsonSchema ​

Runtime Activity Observation 的 JSON Schema。

声明 ​

text
export declare const runtimeActivityObservationJsonSchema: JsonSchema;

runtimeActivityObservationSchema ​

Runtime Activity Observation 的运行时 Schema。

声明 ​

text
// 精确类型由包入口解析；完整编译器展开定义见源码链接。
export declare const runtimeActivityObservationSchema: (typeof import('@codesoul-co/hypha-core'))['runtimeActivityObservationSchema'];

该常量的编译器展开类型已压缩；它的公共名称、顶层类型与源码位置仍保留在本条目中。相关输入/输出字段请使用同模块导出的接口、类型或 Runtime Schema。

runtimeActivityRequestDefinition ​

由 contracts/runtime-activity-schemas 模块导出的 Runtime Activity Request Definition 常量。

声明 ​

text
export declare const runtimeActivityRequestDefinition: SpecSchemaDefinition<RuntimeActivityRequest<RuntimeJsonValue>>;

runtimeActivityRequestExample ​

Runtime Activity Request 的有效示例值。

声明 ​

text
export declare const runtimeActivityRequestExample: RuntimeActivityRequest<RuntimeJsonValue>;

runtimeActivityRequestJsonSchema ​

Runtime Activity Request 的 JSON Schema。

声明 ​

text
export declare const runtimeActivityRequestJsonSchema: JsonSchema;

runtimeActivityRequestSchema ​

Runtime Activity Request 的运行时 Schema。

声明 ​

text
export declare const runtimeActivityRequestSchema: z.ZodObject<{ target: z.ZodString; input: z.ZodType<RuntimeJsonValue, z.ZodTypeDef, RuntimeJsonValue>; options: z.ZodOptional<z.ZodObject<{ effect: z.ZodOptional<z.ZodEnum<["pure", "idempotent", "external_effect", "irreversible"]>>; timeoutMs: z.ZodOptional<z.ZodNumber>; retry: z.ZodOptional<z.ZodEffects<z.ZodObject<{ maxAttempts: z.ZodNumber; initialDelayMs: z.ZodOptional<z.ZodNumber>; maxDelayMs: z.ZodOptional<z.ZodNumber>; }, "strict", z.ZodTypeAny, { maxAttempts: number; initialDelayMs?: number | undefined; maxDelayMs?: number | undefined; }, { maxAttempts: number; initialDelayMs?: number | undefined; maxDelayMs?: number | undefined; }>, { maxAttempts: number; initialDelayMs?: number | undefined; maxDelayMs?: number | undefined; }, { maxAttempts: number; initialDelayMs?: number | undefined; maxDelayMs?: number | undefined; }>>; idempotencyKey: z.ZodOptional<z.ZodString>; causationId: z.ZodOptional<z.ZodString>; metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodType<RuntimeJsonValue, z.ZodTypeDef, RuntimeJsonValue>>>; }, "strict", z.ZodTypeAny, { metadata?: Record<string, RuntimeJsonValue> | undefined; effect?: "pure" | "idempotent" | "external_effect" | "irreversible" | undefined; causationId?: string | undefined; idempotencyKey?: string | undefined; timeoutMs?: number | undefined; retry?: { maxAttempts: number; initialDelayMs?: number | undefined; maxDelayMs?: number | undefined; } | undefined; }, { metadata?: Record<string, RuntimeJsonValue> | undefined; effect?: "pure" | "idempotent" | "external_effect" | "irreversible" | undefined; causationId?: string | undefined; idempotencyKey?: string | undefined; timeoutMs?: number | undefined; retry?: { maxAttempts: number; initialDelayMs?: number | undefined; maxDelayMs?: number | undefined; } | undefined; }>>; }, "strict", z.ZodTypeAny, { input: RuntimeJsonValue; target: string; options?: { metadata?: Record<string, RuntimeJsonValue> | undefined; effect?: "pure" | "idempotent" | "external_effect" | "irreversible" | undefined; causationId?: string | undefined; idempotencyKey?: string | undefined; timeoutMs?: number | undefined; retry?: { maxAttempts: number; initialDelayMs?: number | undefined; maxDelayMs?: number | undefined; } | undefined; } | undefined; }, { input: RuntimeJsonValue; target: string; options?: { metadata?: Record<string, RuntimeJsonValue> | undefined; effect?: "pure" | "idempotent" | "external_effect" | "irreversible" | undefined; causationId?: string | undefined; idempotencyKey?: string | undefined; timeoutMs?: number | undefined; retry?: { maxAttempts: number; initialDelayMs?: number | undefined; maxDelayMs?: number | undefined; } | undefined; } | undefined; }>;

validateRuntimeActivityDescriptor ​

Validate Runtime Activity Descriptor 函数，提供 1 个公开调用签名；参数与返回类型见下表。

声明 ​

text
export declare function validateRuntimeActivityDescriptor(input: unknown): RuntimeActivityDescriptor;

调用签名 ​

text
validateRuntimeActivityDescriptor(input: unknown): RuntimeActivityDescriptor

参数 ​

参数类型必需说明
inputunknown是必需参数；接受的值由类型列定义。

返回值 ​

  • 类型: RuntimeActivityDescriptor
  • 说明: 返回值契约由上述类型定义。

validateRuntimeActivityInvocation ​

Validate Runtime Activity Invocation 函数，提供 1 个公开调用签名；参数与返回类型见下表。

声明 ​

text
export declare function validateRuntimeActivityInvocation(input: unknown): RuntimeActivityInvocation;

调用签名 ​

text
validateRuntimeActivityInvocation(input: unknown): RuntimeActivityInvocation

参数 ​

参数类型必需说明
inputunknown是必需参数；接受的值由类型列定义。

返回值 ​

  • 类型: RuntimeActivityInvocation<RuntimeJsonValue>
  • 说明: 返回值契约由上述类型定义。

validateRuntimeActivityObservation ​

Validate Runtime Activity Observation 函数，提供 1 个公开调用签名；参数与返回类型见下表。

声明 ​

text
export declare function validateRuntimeActivityObservation(input: unknown): RuntimeActivityObservation;

调用签名 ​

text
validateRuntimeActivityObservation(input: unknown): RuntimeActivityObservation

参数 ​

参数类型必需说明
inputunknown是必需参数；接受的值由类型列定义。

返回值 ​

  • 类型: RuntimeActivityObservation<RuntimeJsonValue>
  • 说明: 返回值契约由上述类型定义。

validateRuntimeActivityRequest ​

Validate Runtime Activity Request 函数，提供 1 个公开调用签名；参数与返回类型见下表。

声明 ​

text
export declare function validateRuntimeActivityRequest(input: unknown): RuntimeActivityRequest;

调用签名 ​

text
validateRuntimeActivityRequest(input: unknown): RuntimeActivityRequest

参数 ​

参数类型必需说明
inputunknown是必需参数；接受的值由类型列定义。

返回值 ​

  • 类型: RuntimeActivityRequest<RuntimeJsonValue>
  • 说明: 返回值契约由上述类型定义。