@codesoul-co/hypha-core / modules/execution/recovery

• 包索引: @codesoul-co/hypha-core
• 源码: packages/core/src/modules/execution/recovery.ts
• 导出数: 5

模块用法

用于执行该边界的运行时行为。Recovery 模块公开 2 函数、2 接口、1 类型。

从包入口导入

import {
  adviseExecutionRecovery,
  classifyExecutionFailure,
} from '@codesoul-co/hypha-core';

import type {
  ExecutionFailureContext,
  ExecutionRecoveryAdvice,
  ExecutionRecoveryOperation,
} from '@codesoul-co/hypha-core';

使用要点

• 3 个类型/接口用于应用代码、Adapter 或测试中的静态契约；请使用 import type，运行时不应依赖它们。
• 2 个函数是该模块的直接操作入口；每个 overload 的必需/可选参数与返回类型均在下方列出。

公共导出

Symbol	种类	签名	说明
adviseExecutionRecovery	函数	adviseExecutionRecovery(failure: RecoveryFailure): ExecutionRecoveryAdvice	Advise Execution Recovery 函数，提供 1 个公开调用签名；参数与返回类型见下表。
classifyExecutionFailure	函数	classifyExecutionFailure(error: unknown, context: ExecutionFailureContext): RecoveryFailure	Classify Execution Failure 函数，提供 1 个公开调用签名；参数与返回类型见下表。
ExecutionFailureContext	接口	interface ExecutionFailureContext	Execution Failure Context 接口，共包含 14 个公开字段或方法。
ExecutionRecoveryAdvice	接口	interface ExecutionRecoveryAdvice	Execution Recovery Advice 接口，共包含 4 个公开字段或方法。
ExecutionRecoveryOperation	类型	type ExecutionRecoveryOperation = 'validate' | 'queue' | 'start' | 'poll' | 'cancel' | 'persist' | 'cleanup'	Execution Recovery Operation 公共类型别名；完整类型表达式见声明。

adviseExecutionRecovery

Advise Execution Recovery 函数，提供 1 个公开调用签名；参数与返回类型见下表。

• 种类: 函数
• 导入: import { adviseExecutionRecovery } from '@codesoul-co/hypha-core';
• 源码模块: modules/execution/recovery

声明

export declare function adviseExecutionRecovery(failure: RecoveryFailure): ExecutionRecoveryAdvice;

调用签名

adviseExecutionRecovery(failure: RecoveryFailure): ExecutionRecoveryAdvice

参数

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

返回值

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

classifyExecutionFailure

Classify Execution Failure 函数，提供 1 个公开调用签名；参数与返回类型见下表。

• 种类: 函数
• 导入: import { classifyExecutionFailure } from '@codesoul-co/hypha-core';
• 源码模块: modules/execution/recovery

声明

export declare function classifyExecutionFailure(error: unknown, context: ExecutionFailureContext): RecoveryFailure;

调用签名

classifyExecutionFailure(error: unknown, context: ExecutionFailureContext): RecoveryFailure

参数

参数	类型	必需	说明
error	unknown	是	必需参数；接受的值由类型列定义。
context	ExecutionFailureContext	是	必需参数；接受的值由类型列定义。

返回值

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

ExecutionFailureContext

Execution Failure Context 接口，共包含 14 个公开字段或方法。

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

声明

export interface ExecutionFailureContext {
    id: string;
    operation: ExecutionRecoveryOperation;
    occurredAt?: string;
    request?: CommandExecutionRequest;
    record?: ExecutionRecord;
    result?: CommandExecutionResult;
    assessment?: ExecutionRecoveryAssessment;
    providerId?: string;
    providerRevision?: string;
    policyRevision?: string;
    specRevision?: string;
    sideEffectState?: RecoverySideEffectState;
    compensationAvailable?: boolean;
    metadata?: Record<string, unknown>;
}

契约成员

成员	种类	签名	说明
assessment	属性	assessment?: ExecutionRecoveryAssessment	公开属性；类型、只读和可选状态以签名列为准。
compensationAvailable	属性	compensationAvailable?: boolean	公开属性；类型、只读和可选状态以签名列为准。
id	属性	id: string	公开属性；类型、只读和可选状态以签名列为准。
metadata	属性	metadata?: Record<string, unknown>	公开属性；类型、只读和可选状态以签名列为准。
occurredAt	属性	occurredAt?: string	公开属性；类型、只读和可选状态以签名列为准。
operation	属性	operation: ExecutionRecoveryOperation	公开属性；类型、只读和可选状态以签名列为准。
policyRevision	属性	policyRevision?: string	公开属性；类型、只读和可选状态以签名列为准。
providerId	属性	providerId?: string	公开属性；类型、只读和可选状态以签名列为准。
providerRevision	属性	providerRevision?: string	公开属性；类型、只读和可选状态以签名列为准。
record	属性	record?: ExecutionRecord	公开属性；类型、只读和可选状态以签名列为准。
request	属性	request?: CommandExecutionRequest	公开属性；类型、只读和可选状态以签名列为准。
result	属性	result?: CommandExecutionResult	公开属性；类型、只读和可选状态以签名列为准。
sideEffectState	属性	sideEffectState?: RecoverySideEffectState	公开属性；类型、只读和可选状态以签名列为准。
specRevision	属性	specRevision?: string	公开属性；类型、只读和可选状态以签名列为准。

ExecutionRecoveryAdvice

Execution Recovery Advice 接口，共包含 4 个公开字段或方法。

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

声明

export interface ExecutionRecoveryAdvice {
    strategy: RecoveryStrategy;
    reason: string;
    refreshRecordBeforeRetry: boolean;
    requireReceiptReconciliation: boolean;
}

契约成员

成员	种类	签名	说明
reason	属性	reason: string	公开属性；类型、只读和可选状态以签名列为准。
refreshRecordBeforeRetry	属性	refreshRecordBeforeRetry: boolean	公开属性；类型、只读和可选状态以签名列为准。
requireReceiptReconciliation	属性	requireReceiptReconciliation: boolean	公开属性；类型、只读和可选状态以签名列为准。
strategy	属性	strategy: "fail" | "retry" | "human_review" | "reconcile" | "fallback" | "degrade" | "compensate" | "wait" | "quarantine" | "cancel"	公开属性；类型、只读和可选状态以签名列为准。

ExecutionRecoveryOperation

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

• 种类: 类型
• 导入: import type { ExecutionRecoveryOperation } from '@codesoul-co/hypha-core';
• 源码模块: modules/execution/recovery

声明

export type ExecutionRecoveryOperation = 'validate' | 'queue' | 'start' | 'poll' | 'cancel' | 'persist' | 'cleanup';