@codesoul-co/hypha-core / contracts/session-queue
模块用法
用于声明并运行时校验契约。Session queue 模块公开 5 常量、20 接口、2 类型。
从包入口导入
ts
import {
DEFAULT_SESSION_COMMAND_MAX_ATTEMPTS,
SESSION_COMMAND_MAX_ATTEMPTS_LIMIT,
SESSION_COMMAND_RUN_CANCELLED_CODE,
SESSION_COMMAND_STATUSES,
SESSION_COMMAND_TYPES,
} from '@codesoul-co/hypha-core';
import type {
CancelSessionCommandsRequest,
CancelSessionCommandsResult,
ClaimSessionCommandRequest,
CloseDeadLetterSessionCommandRequest,
CompleteSessionCommandRequest,
EnqueueSessionCommandRequest,
FailSessionCommandRequest,
ListSessionCommandsRequest,
} from '@codesoul-co/hypha-core';
// 完整导出列表见下方。使用要点
- 22 个类型/接口用于应用代码、Adapter 或测试中的静态契约；请使用
import type，运行时不应依赖它们。 - 5 个常量/枚举提供稳定值、Schema、Definition 或默认配置；应复用这些导出，避免在应用中复制内部值。
公共导出
| Symbol | 种类 | 签名 | 说明 |
|---|---|---|---|
DEFAULT_SESSION_COMMAND_MAX_ATTEMPTS | 常量 | const DEFAULT_SESSION_COMMAND_MAX_ATTEMPTS: 5 | 由 contracts/session-queue 模块导出的 DEFAULT SESSION COMMAND MAX ATTEMPTS 常量。 |
SESSION_COMMAND_MAX_ATTEMPTS_LIMIT | 常量 | const SESSION_COMMAND_MAX_ATTEMPTS_LIMIT: 100 | 由 contracts/session-queue 模块导出的 SESSION COMMAND MAX ATTEMPTS LIMIT 常量。 |
SESSION_COMMAND_RUN_CANCELLED_CODE | 常量 | const SESSION_COMMAND_RUN_CANCELLED_CODE: "RUNTIME_RUN_CANCELLED" | 由 contracts/session-queue 模块导出的 SESSION COMMAND RUN CANCELLED CODE 常量。 |
SESSION_COMMAND_STATUSES | 常量 | const SESSION_COMMAND_STATUSES: readonly ["queued", "claimed", "applied", "reused", "rejected", "expired", "failed", "dead_letter", "dead_letter_resolved"] | 由 contracts/session-queue 模块导出的 SESSION COMMAND STATUSES 常量。 |
SESSION_COMMAND_TYPES | 常量 | const SESSION_COMMAND_TYPES: readonly ["start_run", "user_input", "resume", "signal", "cancel", "transition", "continue_react", "close_session"] | 由 contracts/session-queue 模块导出的 SESSION COMMAND TYPES 常量。 |
CancelSessionCommandsRequest | 接口 | interface CancelSessionCommandsRequest | Cancel Session Commands Request 接口，共包含 6 个公开字段或方法。 |
CancelSessionCommandsResult | 接口 | interface CancelSessionCommandsResult | Cancel Session Commands Result 接口，共包含 4 个公开字段或方法。 |
ClaimSessionCommandRequest | 接口 | interface ClaimSessionCommandRequest | Claim Session Command Request 接口，共包含 4 个公开字段或方法。 |
CloseDeadLetterSessionCommandRequest | 接口 | interface CloseDeadLetterSessionCommandRequest | Close Dead Letter Session Command Request 接口，共包含 6 个公开字段或方法。 |
CompleteSessionCommandRequest | 接口 | interface CompleteSessionCommandRequest | Complete Session Command Request 接口，共包含 7 个公开字段或方法。 |
EnqueueSessionCommandRequest | 接口 | interface EnqueueSessionCommandRequest | Enqueue Session Command Request 接口，共包含 15 个公开字段或方法。 |
FailSessionCommandRequest | 接口 | interface FailSessionCommandRequest | Fail Session Command Request 接口，共包含 7 个公开字段或方法。 |
ListSessionCommandsRequest | 接口 | interface ListSessionCommandsRequest | List Session Commands Request 接口，共包含 4 个公开字段或方法。 |
ListStuckSessionCommandsRequest | 接口 | interface ListStuckSessionCommandsRequest | List Stuck Session Commands Request 接口，共包含 4 个公开字段或方法。 |
RedriveDeadLetterSessionCommandRequest | 接口 | interface RedriveDeadLetterSessionCommandRequest | Redrive Dead Letter Session Command Request 接口，共包含 12 个公开字段或方法。 |
ReleaseSessionCommandRequest | 接口 | interface ReleaseSessionCommandRequest | Release Session Command Request 接口，共包含 6 个公开字段或方法。 |
RenewSessionCommandRequest | 接口 | interface RenewSessionCommandRequest | Renew Session Command Request 接口，共包含 6 个公开字段或方法。 |
SessionCommandClaim | 接口 | interface SessionCommandClaim | Session Command Claim 接口，共包含 5 个公开字段或方法。 |
SessionCommandDeadLetterResolution | 接口 | interface SessionCommandDeadLetterResolution | Session Command Dead Letter Resolution 接口，共包含 6 个公开字段或方法。 |
SessionCommandLeaseRecovery | 接口 | interface SessionCommandLeaseRecovery | Session Command Lease Recovery 接口，共包含 6 个公开字段或方法。 |
SessionCommandRecord | 接口 | interface SessionCommandRecord | Session Command Record 接口，共包含 29 个公开字段或方法。 |
SessionCommandRedrive | 接口 | interface SessionCommandRedrive | Session Command Redrive 接口，共包含 5 个公开字段或方法。 |
SessionQueueHealthSnapshot | 接口 | interface SessionQueueHealthSnapshot extends Record<string, unknown> | Session Queue Health Snapshot 接口，共包含 12 个公开字段或方法。 |
SessionQueueScope | 接口 | interface SessionQueueScope | Session Queue Scope 接口，共包含 3 个公开字段或方法。 |
StuckSessionCommand | 接口 | interface StuckSessionCommand | Stuck Session Command 接口，共包含 3 个公开字段或方法。 |
SessionCommandStatus | 类型 | type SessionCommandStatus = (typeof SESSION_COMMAND_STATUSES)[number] | Session Command Status 公共类型别名；完整类型表达式见声明。 |
SessionCommandType | 类型 | type SessionCommandType = (typeof SESSION_COMMAND_TYPES)[number] | Session Command Type 公共类型别名；完整类型表达式见声明。 |
DEFAULT_SESSION_COMMAND_MAX_ATTEMPTS
由 contracts/session-queue 模块导出的 DEFAULT SESSION COMMAND MAX ATTEMPTS 常量。
- 种类: 常量
- 导入:
import { DEFAULT_SESSION_COMMAND_MAX_ATTEMPTS } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/session-queue
声明
text
export declare const DEFAULT_SESSION_COMMAND_MAX_ATTEMPTS: 5;SESSION_COMMAND_MAX_ATTEMPTS_LIMIT
由 contracts/session-queue 模块导出的 SESSION COMMAND MAX ATTEMPTS LIMIT 常量。
- 种类: 常量
- 导入:
import { SESSION_COMMAND_MAX_ATTEMPTS_LIMIT } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/session-queue
声明
text
export declare const SESSION_COMMAND_MAX_ATTEMPTS_LIMIT: 100;SESSION_COMMAND_RUN_CANCELLED_CODE
由 contracts/session-queue 模块导出的 SESSION COMMAND RUN CANCELLED CODE 常量。
- 种类: 常量
- 导入:
import { SESSION_COMMAND_RUN_CANCELLED_CODE } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/session-queue
声明
text
export declare const SESSION_COMMAND_RUN_CANCELLED_CODE: "RUNTIME_RUN_CANCELLED";SESSION_COMMAND_STATUSES
由 contracts/session-queue 模块导出的 SESSION COMMAND STATUSES 常量。
- 种类: 常量
- 导入:
import { SESSION_COMMAND_STATUSES } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/session-queue
声明
text
export declare const SESSION_COMMAND_STATUSES: readonly ["queued", "claimed", "applied", "reused", "rejected", "expired", "failed", "dead_letter", "dead_letter_resolved"];SESSION_COMMAND_TYPES
由 contracts/session-queue 模块导出的 SESSION COMMAND TYPES 常量。
- 种类: 常量
- 导入:
import { SESSION_COMMAND_TYPES } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/session-queue
声明
text
export declare const SESSION_COMMAND_TYPES: readonly ["start_run", "user_input", "resume", "signal", "cancel", "transition", "continue_react", "close_session"];CancelSessionCommandsRequest
Cancel Session Commands Request 接口，共包含 6 个公开字段或方法。
- 种类: 接口
- 导入:
import type { CancelSessionCommandsRequest } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/session-queue
声明
text
export interface CancelSessionCommandsRequest {
version: '1.0.0';
scope: SessionQueueScope;
targetRunId: string;
cancellationCommandId: string;
reason: string;
cancelledAt: string;
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
cancellationCommandId | 属性 | cancellationCommandId: string | 公开属性；类型、只读和可选状态以签名列为准。 |
cancelledAt | 属性 | cancelledAt: string | 公开属性；类型、只读和可选状态以签名列为准。 |
reason | 属性 | reason: string | 公开属性；类型、只读和可选状态以签名列为准。 |
scope | 属性 | scope: SessionQueueScope | 公开属性；类型、只读和可选状态以签名列为准。 |
targetRunId | 属性 | targetRunId: string | 公开属性；类型、只读和可选状态以签名列为准。 |
version | 属性 | version: "1.0.0" | 公开属性；类型、只读和可选状态以签名列为准。 |
CancelSessionCommandsResult
Cancel Session Commands Result 接口，共包含 4 个公开字段或方法。
- 种类: 接口
- 导入:
import type { CancelSessionCommandsResult } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/session-queue
声明
text
export interface CancelSessionCommandsResult {
targetRunId: string;
cancelledCommandIds: string[];
alreadyCancelledCommandIds: string[];
alreadyTerminalCommandIds: string[];
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
alreadyCancelledCommandIds | 属性 | alreadyCancelledCommandIds: string[] | 公开属性；类型、只读和可选状态以签名列为准。 |
alreadyTerminalCommandIds | 属性 | alreadyTerminalCommandIds: string[] | 公开属性；类型、只读和可选状态以签名列为准。 |
cancelledCommandIds | 属性 | cancelledCommandIds: string[] | 公开属性；类型、只读和可选状态以签名列为准。 |
targetRunId | 属性 | targetRunId: string | 公开属性；类型、只读和可选状态以签名列为准。 |
ClaimSessionCommandRequest
Claim Session Command Request 接口，共包含 4 个公开字段或方法。
- 种类: 接口
- 导入:
import type { ClaimSessionCommandRequest } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/session-queue
声明
text
export interface ClaimSessionCommandRequest {
workerId: string;
now: string;
leaseMs: number;
scope?: SessionQueueScope;
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
leaseMs | 属性 | leaseMs: number | 公开属性；类型、只读和可选状态以签名列为准。 |
now | 属性 | now: string | 公开属性；类型、只读和可选状态以签名列为准。 |
scope | 属性 | scope?: SessionQueueScope | 公开属性；类型、只读和可选状态以签名列为准。 |
workerId | 属性 | workerId: string | 公开属性；类型、只读和可选状态以签名列为准。 |
CloseDeadLetterSessionCommandRequest
Close Dead Letter Session Command Request 接口，共包含 6 个公开字段或方法。
- 种类: 接口
- 导入:
import type { CloseDeadLetterSessionCommandRequest } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/session-queue
声明
text
export interface CloseDeadLetterSessionCommandRequest {
version: '1.0.0';
scope: SessionQueueScope;
commandId: string;
operatorId: string;
reason: string;
closedAt: string;
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
closedAt | 属性 | closedAt: string | 公开属性；类型、只读和可选状态以签名列为准。 |
commandId | 属性 | commandId: string | 公开属性；类型、只读和可选状态以签名列为准。 |
operatorId | 属性 | operatorId: string | 公开属性；类型、只读和可选状态以签名列为准。 |
reason | 属性 | reason: string | 公开属性；类型、只读和可选状态以签名列为准。 |
scope | 属性 | scope: SessionQueueScope | 公开属性；类型、只读和可选状态以签名列为准。 |
version | 属性 | version: "1.0.0" | 公开属性；类型、只读和可选状态以签名列为准。 |
CompleteSessionCommandRequest
Complete Session Command Request 接口，共包含 7 个公开字段或方法。
- 种类: 接口
- 导入:
import type { CompleteSessionCommandRequest } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/session-queue
声明
text
export interface CompleteSessionCommandRequest {
commandId: string;
workerId: string;
claimToken: string;
leaseEpoch: number;
completedAt: string;
resultRunId?: string;
resultEventIds?: string[];
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
claimToken | 属性 | claimToken: string | 公开属性；类型、只读和可选状态以签名列为准。 |
commandId | 属性 | commandId: string | 公开属性；类型、只读和可选状态以签名列为准。 |
completedAt | 属性 | completedAt: string | 公开属性；类型、只读和可选状态以签名列为准。 |
leaseEpoch | 属性 | leaseEpoch: number | 公开属性；类型、只读和可选状态以签名列为准。 |
resultEventIds | 属性 | resultEventIds?: string[] | 公开属性；类型、只读和可选状态以签名列为准。 |
resultRunId | 属性 | resultRunId?: string | 公开属性；类型、只读和可选状态以签名列为准。 |
workerId | 属性 | workerId: string | 公开属性；类型、只读和可选状态以签名列为准。 |
EnqueueSessionCommandRequest
Enqueue Session Command Request 接口，共包含 15 个公开字段或方法。
- 种类: 接口
- 导入:
import type { EnqueueSessionCommandRequest } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/session-queue
声明
text
export interface EnqueueSessionCommandRequest {
id: string;
commandType: SessionCommandType;
idempotencyKey: string;
tenantId?: string;
userId: string;
workspaceId?: string;
sessionId: string;
targetRunId?: string;
priority?: number;
maxAttempts?: number;
payloadRef?: string;
payloadHash: string;
createdAt?: string;
availableAt?: string;
expiresAt?: string;
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
availableAt | 属性 | availableAt?: string | 公开属性；类型、只读和可选状态以签名列为准。 |
commandType | 属性 | commandType: "user_input" | "cancel" | "signal" | "start_run" | "resume" | "transition" | "continue_react" | "close_session" | 公开属性；类型、只读和可选状态以签名列为准。 |
createdAt | 属性 | createdAt?: string | 公开属性；类型、只读和可选状态以签名列为准。 |
expiresAt | 属性 | expiresAt?: string | 公开属性；类型、只读和可选状态以签名列为准。 |
id | 属性 | id: string | 公开属性；类型、只读和可选状态以签名列为准。 |
idempotencyKey | 属性 | idempotencyKey: string | 公开属性；类型、只读和可选状态以签名列为准。 |
maxAttempts | 属性 | maxAttempts?: number | 公开属性；类型、只读和可选状态以签名列为准。 |
payloadHash | 属性 | payloadHash: string | 公开属性；类型、只读和可选状态以签名列为准。 |
payloadRef | 属性 | payloadRef?: string | 公开属性；类型、只读和可选状态以签名列为准。 |
priority | 属性 | priority?: number | 公开属性；类型、只读和可选状态以签名列为准。 |
sessionId | 属性 | sessionId: string | 公开属性；类型、只读和可选状态以签名列为准。 |
targetRunId | 属性 | targetRunId?: string | 公开属性；类型、只读和可选状态以签名列为准。 |
tenantId | 属性 | tenantId?: string | 公开属性；类型、只读和可选状态以签名列为准。 |
userId | 属性 | userId: string | 公开属性；类型、只读和可选状态以签名列为准。 |
workspaceId | 属性 | workspaceId?: string | 公开属性；类型、只读和可选状态以签名列为准。 |
FailSessionCommandRequest
Fail Session Command Request 接口，共包含 7 个公开字段或方法。
- 种类: 接口
- 导入:
import type { FailSessionCommandRequest } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/session-queue
声明
text
export interface FailSessionCommandRequest {
commandId: string;
workerId: string;
claimToken: string;
leaseEpoch: number;
failedAt: string;
rejectionCode: string;
deadLetter?: boolean;
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
claimToken | 属性 | claimToken: string | 公开属性；类型、只读和可选状态以签名列为准。 |
commandId | 属性 | commandId: string | 公开属性；类型、只读和可选状态以签名列为准。 |
deadLetter | 属性 | deadLetter?: boolean | 公开属性；类型、只读和可选状态以签名列为准。 |
failedAt | 属性 | failedAt: string | 公开属性；类型、只读和可选状态以签名列为准。 |
leaseEpoch | 属性 | leaseEpoch: number | 公开属性；类型、只读和可选状态以签名列为准。 |
rejectionCode | 属性 | rejectionCode: string | 公开属性；类型、只读和可选状态以签名列为准。 |
workerId | 属性 | workerId: string | 公开属性；类型、只读和可选状态以签名列为准。 |
ListSessionCommandsRequest
List Session Commands Request 接口，共包含 4 个公开字段或方法。
- 种类: 接口
- 导入:
import type { ListSessionCommandsRequest } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/session-queue
声明
text
export interface ListSessionCommandsRequest {
scope: SessionQueueScope;
statuses?: SessionCommandStatus[];
fromSequence?: number;
limit?: number;
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
fromSequence | 属性 | fromSequence?: number | 公开属性；类型、只读和可选状态以签名列为准。 |
limit | 属性 | limit?: number | 公开属性；类型、只读和可选状态以签名列为准。 |
scope | 属性 | scope: SessionQueueScope | 公开属性；类型、只读和可选状态以签名列为准。 |
statuses | 属性 | statuses?: ("rejected" | "queued" | "failed" | "expired" | "applied" | "dead_letter" | "claimed" | "reused" | "dead_letter_resolved")[] | 公开属性；类型、只读和可选状态以签名列为准。 |
ListStuckSessionCommandsRequest
List Stuck Session Commands Request 接口，共包含 4 个公开字段或方法。
- 种类: 接口
- 导入:
import type { ListStuckSessionCommandsRequest } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/session-queue
声明
text
export interface ListStuckSessionCommandsRequest {
scope: SessionQueueScope;
checkedAt: string;
graceMs?: number;
limit?: number;
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
checkedAt | 属性 | checkedAt: string | 公开属性；类型、只读和可选状态以签名列为准。 |
graceMs | 属性 | graceMs?: number | 公开属性；类型、只读和可选状态以签名列为准。 |
limit | 属性 | limit?: number | 公开属性；类型、只读和可选状态以签名列为准。 |
scope | 属性 | scope: SessionQueueScope | 公开属性；类型、只读和可选状态以签名列为准。 |
RedriveDeadLetterSessionCommandRequest
Redrive Dead Letter Session Command Request 接口，共包含 12 个公开字段或方法。
- 种类: 接口
- 导入:
import type { RedriveDeadLetterSessionCommandRequest } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/session-queue
声明
text
export interface RedriveDeadLetterSessionCommandRequest {
version: '1.0.0';
scope: SessionQueueScope;
sourceCommandId: string;
id: string;
idempotencyKey: string;
operatorId: string;
reason: string;
requestedAt?: string;
availableAt?: string;
expiresAt?: string;
priority?: number;
maxAttempts?: number;
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
availableAt | 属性 | availableAt?: string | 公开属性；类型、只读和可选状态以签名列为准。 |
expiresAt | 属性 | expiresAt?: string | 公开属性；类型、只读和可选状态以签名列为准。 |
id | 属性 | id: string | 公开属性；类型、只读和可选状态以签名列为准。 |
idempotencyKey | 属性 | idempotencyKey: string | 公开属性；类型、只读和可选状态以签名列为准。 |
maxAttempts | 属性 | maxAttempts?: number | 公开属性；类型、只读和可选状态以签名列为准。 |
operatorId | 属性 | operatorId: string | 公开属性；类型、只读和可选状态以签名列为准。 |
priority | 属性 | priority?: number | 公开属性；类型、只读和可选状态以签名列为准。 |
reason | 属性 | reason: string | 公开属性；类型、只读和可选状态以签名列为准。 |
requestedAt | 属性 | requestedAt?: string | 公开属性；类型、只读和可选状态以签名列为准。 |
scope | 属性 | scope: SessionQueueScope | 公开属性；类型、只读和可选状态以签名列为准。 |
sourceCommandId | 属性 | sourceCommandId: string | 公开属性；类型、只读和可选状态以签名列为准。 |
version | 属性 | version: "1.0.0" | 公开属性；类型、只读和可选状态以签名列为准。 |
ReleaseSessionCommandRequest
Release Session Command Request 接口，共包含 6 个公开字段或方法。
- 种类: 接口
- 导入:
import type { ReleaseSessionCommandRequest } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/session-queue
声明
text
export interface ReleaseSessionCommandRequest {
commandId: string;
workerId: string;
claimToken: string;
leaseEpoch: number;
releasedAt: string;
availableAt?: string;
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
availableAt | 属性 | availableAt?: string | 公开属性；类型、只读和可选状态以签名列为准。 |
claimToken | 属性 | claimToken: string | 公开属性；类型、只读和可选状态以签名列为准。 |
commandId | 属性 | commandId: string | 公开属性；类型、只读和可选状态以签名列为准。 |
leaseEpoch | 属性 | leaseEpoch: number | 公开属性；类型、只读和可选状态以签名列为准。 |
releasedAt | 属性 | releasedAt: string | 公开属性；类型、只读和可选状态以签名列为准。 |
workerId | 属性 | workerId: string | 公开属性；类型、只读和可选状态以签名列为准。 |
RenewSessionCommandRequest
Renew Session Command Request 接口，共包含 6 个公开字段或方法。
- 种类: 接口
- 导入:
import type { RenewSessionCommandRequest } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/session-queue
声明
text
export interface RenewSessionCommandRequest {
commandId: string;
workerId: string;
claimToken: string;
leaseEpoch: number;
renewedAt: string;
leaseMs: number;
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
claimToken | 属性 | claimToken: string | 公开属性；类型、只读和可选状态以签名列为准。 |
commandId | 属性 | commandId: string | 公开属性；类型、只读和可选状态以签名列为准。 |
leaseEpoch | 属性 | leaseEpoch: number | 公开属性；类型、只读和可选状态以签名列为准。 |
leaseMs | 属性 | leaseMs: number | 公开属性；类型、只读和可选状态以签名列为准。 |
renewedAt | 属性 | renewedAt: string | 公开属性；类型、只读和可选状态以签名列为准。 |
workerId | 属性 | workerId: string | 公开属性；类型、只读和可选状态以签名列为准。 |
SessionCommandClaim
Session Command Claim 接口，共包含 5 个公开字段或方法。
- 种类: 接口
- 导入:
import type { SessionCommandClaim } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/session-queue
声明
text
export interface SessionCommandClaim {
commandId: string;
workerId: string;
claimToken: string;
leaseEpoch: number;
leaseExpiresAt: string;
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
claimToken | 属性 | claimToken: string | 公开属性；类型、只读和可选状态以签名列为准。 |
commandId | 属性 | commandId: string | 公开属性；类型、只读和可选状态以签名列为准。 |
leaseEpoch | 属性 | leaseEpoch: number | 公开属性；类型、只读和可选状态以签名列为准。 |
leaseExpiresAt | 属性 | leaseExpiresAt: string | 公开属性；类型、只读和可选状态以签名列为准。 |
workerId | 属性 | workerId: string | 公开属性；类型、只读和可选状态以签名列为准。 |
SessionCommandDeadLetterResolution
Session Command Dead Letter Resolution 接口，共包含 6 个公开字段或方法。
- 种类: 接口
- 导入:
import type { SessionCommandDeadLetterResolution } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/session-queue
声明
text
export interface SessionCommandDeadLetterResolution {
version: '1.0.0';
disposition: 'redriven' | 'closed';
operatorId: string;
reason: string;
resolvedAt: string;
redriveCommandId?: string;
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
disposition | 属性 | disposition: "closed" | "redriven" | 公开属性；类型、只读和可选状态以签名列为准。 |
operatorId | 属性 | operatorId: string | 公开属性；类型、只读和可选状态以签名列为准。 |
reason | 属性 | reason: string | 公开属性；类型、只读和可选状态以签名列为准。 |
redriveCommandId | 属性 | redriveCommandId?: string | 公开属性；类型、只读和可选状态以签名列为准。 |
resolvedAt | 属性 | resolvedAt: string | 公开属性；类型、只读和可选状态以签名列为准。 |
version | 属性 | version: "1.0.0" | 公开属性；类型、只读和可选状态以签名列为准。 |
SessionCommandLeaseRecovery
Session Command Lease Recovery 接口，共包含 6 个公开字段或方法。
- 种类: 接口
- 导入:
import type { SessionCommandLeaseRecovery } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/session-queue
声明
text
export interface SessionCommandLeaseRecovery {
version: '1.0.0';
previousWorkerId: string;
previousLeaseEpoch: number;
leaseExpiredAt: string;
recoveredAt: string;
disposition: 'requeued' | 'dead_lettered';
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
disposition | 属性 | disposition: "requeued" | "dead_lettered" | 公开属性；类型、只读和可选状态以签名列为准。 |
leaseExpiredAt | 属性 | leaseExpiredAt: string | 公开属性；类型、只读和可选状态以签名列为准。 |
previousLeaseEpoch | 属性 | previousLeaseEpoch: number | 公开属性；类型、只读和可选状态以签名列为准。 |
previousWorkerId | 属性 | previousWorkerId: string | 公开属性；类型、只读和可选状态以签名列为准。 |
recoveredAt | 属性 | recoveredAt: string | 公开属性；类型、只读和可选状态以签名列为准。 |
version | 属性 | version: "1.0.0" | 公开属性；类型、只读和可选状态以签名列为准。 |
SessionCommandRecord
Session Command Record 接口，共包含 29 个公开字段或方法。
- 种类: 接口
- 导入:
import type { SessionCommandRecord } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/session-queue
声明
text
export interface SessionCommandRecord {
id: string;
commandType: SessionCommandType;
idempotencyKey: string;
tenantId?: string;
userId: string;
workspaceId?: string;
sessionId: string;
targetRunId?: string;
enqueueSequence: number;
priority: number;
attempts: number;
maxAttempts: number;
leaseEpoch: number;
payloadRef?: string;
payloadHash: string;
status: SessionCommandStatus;
claimedBy?: string;
claimToken?: string;
leaseExpiresAt?: string;
resultRunId?: string;
resultEventIds?: string[];
rejectionCode?: string;
createdAt: string;
availableAt: string;
expiresAt?: string;
completedAt?: string;
redrive?: SessionCommandRedrive;
deadLetterResolution?: SessionCommandDeadLetterResolution;
leaseRecoveries?: SessionCommandLeaseRecovery[];
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
attempts | 属性 | attempts: number | 公开属性；类型、只读和可选状态以签名列为准。 |
availableAt | 属性 | availableAt: string | 公开属性；类型、只读和可选状态以签名列为准。 |
claimedBy | 属性 | claimedBy?: string | 公开属性；类型、只读和可选状态以签名列为准。 |
claimToken | 属性 | claimToken?: string | 公开属性；类型、只读和可选状态以签名列为准。 |
commandType | 属性 | commandType: "user_input" | "cancel" | "signal" | "start_run" | "resume" | "transition" | "continue_react" | "close_session" | 公开属性；类型、只读和可选状态以签名列为准。 |
completedAt | 属性 | completedAt?: string | 公开属性；类型、只读和可选状态以签名列为准。 |
createdAt | 属性 | createdAt: string | 公开属性；类型、只读和可选状态以签名列为准。 |
deadLetterResolution | 属性 | deadLetterResolution?: SessionCommandDeadLetterResolution | 公开属性；类型、只读和可选状态以签名列为准。 |
enqueueSequence | 属性 | enqueueSequence: number | 公开属性；类型、只读和可选状态以签名列为准。 |
expiresAt | 属性 | expiresAt?: string | 公开属性；类型、只读和可选状态以签名列为准。 |
id | 属性 | id: string | 公开属性；类型、只读和可选状态以签名列为准。 |
idempotencyKey | 属性 | idempotencyKey: string | 公开属性；类型、只读和可选状态以签名列为准。 |
leaseEpoch | 属性 | leaseEpoch: number | 公开属性；类型、只读和可选状态以签名列为准。 |
leaseExpiresAt | 属性 | leaseExpiresAt?: string | 公开属性；类型、只读和可选状态以签名列为准。 |
leaseRecoveries | 属性 | leaseRecoveries?: SessionCommandLeaseRecovery[] | 公开属性；类型、只读和可选状态以签名列为准。 |
maxAttempts | 属性 | maxAttempts: number | 公开属性；类型、只读和可选状态以签名列为准。 |
payloadHash | 属性 | payloadHash: string | 公开属性；类型、只读和可选状态以签名列为准。 |
payloadRef | 属性 | payloadRef?: string | 公开属性；类型、只读和可选状态以签名列为准。 |
priority | 属性 | priority: number | 公开属性；类型、只读和可选状态以签名列为准。 |
redrive | 属性 | redrive?: SessionCommandRedrive | 公开属性；类型、只读和可选状态以签名列为准。 |
rejectionCode | 属性 | rejectionCode?: string | 公开属性；类型、只读和可选状态以签名列为准。 |
resultEventIds | 属性 | resultEventIds?: string[] | 公开属性；类型、只读和可选状态以签名列为准。 |
resultRunId | 属性 | resultRunId?: string | 公开属性；类型、只读和可选状态以签名列为准。 |
sessionId | 属性 | sessionId: string | 公开属性；类型、只读和可选状态以签名列为准。 |
status | 属性 | status: "rejected" | "queued" | "failed" | "expired" | "applied" | "dead_letter" | "claimed" | "reused" | "dead_letter_resolved" | 公开属性；类型、只读和可选状态以签名列为准。 |
targetRunId | 属性 | targetRunId?: string | 公开属性；类型、只读和可选状态以签名列为准。 |
tenantId | 属性 | tenantId?: string | 公开属性；类型、只读和可选状态以签名列为准。 |
userId | 属性 | userId: string | 公开属性；类型、只读和可选状态以签名列为准。 |
workspaceId | 属性 | workspaceId?: string | 公开属性；类型、只读和可选状态以签名列为准。 |
SessionCommandRedrive
Session Command Redrive 接口，共包含 5 个公开字段或方法。
- 种类: 接口
- 导入:
import type { SessionCommandRedrive } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/session-queue
声明
text
export interface SessionCommandRedrive {
version: '1.0.0';
sourceCommandId: string;
operatorId: string;
reason: string;
requestedAt: string;
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
operatorId | 属性 | operatorId: string | 公开属性；类型、只读和可选状态以签名列为准。 |
reason | 属性 | reason: string | 公开属性；类型、只读和可选状态以签名列为准。 |
requestedAt | 属性 | requestedAt: string | 公开属性；类型、只读和可选状态以签名列为准。 |
sourceCommandId | 属性 | sourceCommandId: string | 公开属性；类型、只读和可选状态以签名列为准。 |
version | 属性 | version: "1.0.0" | 公开属性；类型、只读和可选状态以签名列为准。 |
SessionQueueHealthSnapshot
Session Queue Health Snapshot 接口，共包含 12 个公开字段或方法。
- 种类: 接口
- 导入:
import type { SessionQueueHealthSnapshot } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/session-queue
声明
text
export interface SessionQueueHealthSnapshot extends Record<string, unknown> {
version: '1.0.0';
totalCommands: number;
pendingCommands: number;
queuedCommands: number;
claimedCommands: number;
deadLetterCommands: number;
resolvedDeadLetterCommands: number;
retryingCommands: number;
redeliveredCommands: number;
recoveredExpiredLeases: number;
leaseRecoveryCount: number;
oldestPendingAgeMs?: number;
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
claimedCommands | 属性 | claimedCommands: number | 公开属性；类型、只读和可选状态以签名列为准。 |
deadLetterCommands | 属性 | deadLetterCommands: number | 公开属性；类型、只读和可选状态以签名列为准。 |
leaseRecoveryCount | 属性 | leaseRecoveryCount: number | 公开属性；类型、只读和可选状态以签名列为准。 |
oldestPendingAgeMs | 属性 | oldestPendingAgeMs?: number | 公开属性；类型、只读和可选状态以签名列为准。 |
pendingCommands | 属性 | pendingCommands: number | 公开属性；类型、只读和可选状态以签名列为准。 |
queuedCommands | 属性 | queuedCommands: number | 公开属性；类型、只读和可选状态以签名列为准。 |
recoveredExpiredLeases | 属性 | recoveredExpiredLeases: number | 公开属性；类型、只读和可选状态以签名列为准。 |
redeliveredCommands | 属性 | redeliveredCommands: number | 公开属性；类型、只读和可选状态以签名列为准。 |
resolvedDeadLetterCommands | 属性 | resolvedDeadLetterCommands: number | 公开属性；类型、只读和可选状态以签名列为准。 |
retryingCommands | 属性 | retryingCommands: number | 公开属性；类型、只读和可选状态以签名列为准。 |
totalCommands | 属性 | totalCommands: number | 公开属性；类型、只读和可选状态以签名列为准。 |
version | 属性 | version: "1.0.0" | 公开属性；类型、只读和可选状态以签名列为准。 |
SessionQueueScope
Session Queue Scope 接口，共包含 3 个公开字段或方法。
- 种类: 接口
- 导入:
import type { SessionQueueScope } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/session-queue
声明
text
export interface SessionQueueScope {
tenantId?: string;
userId: string;
sessionId: string;
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
sessionId | 属性 | sessionId: string | 公开属性；类型、只读和可选状态以签名列为准。 |
tenantId | 属性 | tenantId?: string | 公开属性；类型、只读和可选状态以签名列为准。 |
userId | 属性 | userId: string | 公开属性；类型、只读和可选状态以签名列为准。 |
StuckSessionCommand
Stuck Session Command 接口，共包含 3 个公开字段或方法。
- 种类: 接口
- 导入:
import type { StuckSessionCommand } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/session-queue
声明
text
export interface StuckSessionCommand {
command: SessionCommandRecord;
detectedAt: string;
overdueMs: number;
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
command | 属性 | command: SessionCommandRecord | 公开属性；类型、只读和可选状态以签名列为准。 |
detectedAt | 属性 | detectedAt: string | 公开属性；类型、只读和可选状态以签名列为准。 |
overdueMs | 属性 | overdueMs: number | 公开属性；类型、只读和可选状态以签名列为准。 |
SessionCommandStatus
Session Command Status 公共类型别名；完整类型表达式见声明。
- 种类: 类型
- 导入:
import type { SessionCommandStatus } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/session-queue
声明
text
export type SessionCommandStatus = (typeof SESSION_COMMAND_STATUSES)[number];SessionCommandType
Session Command Type 公共类型别名；完整类型表达式见声明。
- 种类: 类型
- 导入:
import type { SessionCommandType } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/session-queue
声明
text
export type SessionCommandType = (typeof SESSION_COMMAND_TYPES)[number];