@codesoul-co/hypha-core / contracts/session-queue-schemas

• Package index: @codesoul-co/hypha-core
• Source: packages/core/src/contracts/session-queue-schemas.ts
• Exports: 32

Using this module

Use the Session queue schemas module for declaring and runtime-validating contracts. It exports 24 constants, 8 functions.

Import from the package entrypoint

import {
  cancelSessionCommandsRequestDefinition,
  cancelSessionCommandsRequestSchema,
  cancelSessionCommandsResultDefinition,
  cancelSessionCommandsResultSchema,
  closeDeadLetterSessionCommandRequestDefinition,
  closeDeadLetterSessionCommandRequestSchema,
  listStuckSessionCommandsRequestSchema,
  redriveDeadLetterSessionCommandRequestDefinition,
} from '@codesoul-co/hypha-core';

// The complete export list is documented below.

Usage patterns

• The module exposes 8 functions as direct operation entrypoints. Every overload, required/optional parameter, and return type is documented below.
• The 24 constant/enum exports provide stable values, schemas, definitions, or defaults. Reuse these exports instead of copying internal values into an application.

Runtime validation example

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

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

Parse untrusted configuration, network, or persisted input with the runtime schema before passing it to functions or classes that expect a validated contract.

Public exports

Symbol	Kind	Signature	Description
cancelSessionCommandsRequestDefinition	constant	const cancelSessionCommandsRequestDefinition: SpecSchemaDefinition<CancelSessionCommandsRequest>	Cancel Session Commands Request Definition constant exported by the contracts/session-queue-schemas module.
cancelSessionCommandsRequestSchema	constant	const cancelSessionCommandsRequestSchema: z.ZodObject<{ version: z.ZodLiteral<"1.0.0">; scope: z.ZodObject<{ tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodString; sessionId: z.ZodString; }, "strict", z.ZodTypeAny, { userId: string; sessionId: string; tenantId?: string | undefined; }, { userId: string; sessionId: string; tenantId?: string | undefined; }>; targetRunId: z.ZodString; cancellationCommandId: z.ZodS...	Runtime schema for Cancel Session Commands Request.
cancelSessionCommandsResultDefinition	constant	const cancelSessionCommandsResultDefinition: SpecSchemaDefinition<CancelSessionCommandsResult>	Cancel Session Commands Result Definition constant exported by the contracts/session-queue-schemas module.
cancelSessionCommandsResultSchema	constant	const cancelSessionCommandsResultSchema: z.ZodObject<{ targetRunId: z.ZodString; cancelledCommandIds: z.ZodArray<z.ZodString, "many">; alreadyCancelledCommandIds: z.ZodArray<z.ZodString, "many">; alreadyTerminalCommandIds: z.ZodArray<z.ZodString, "many">; }, "strict", z.ZodTypeAny, { targetRunId: string; cancelledCommandIds: string[]; alreadyCancelledCommandIds: string[]; alreadyTerminalCommandIds: string[]; }, { ...	Runtime schema for Cancel Session Commands Result.
closeDeadLetterSessionCommandRequestDefinition	constant	const closeDeadLetterSessionCommandRequestDefinition: SpecSchemaDefinition<CloseDeadLetterSessionCommandRequest>	Close Dead Letter Session Command Request Definition constant exported by the contracts/session-queue-schemas module.
closeDeadLetterSessionCommandRequestSchema	constant	const closeDeadLetterSessionCommandRequestSchema: z.ZodObject<{ version: z.ZodLiteral<"1.0.0">; scope: z.ZodObject<{ tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodString; sessionId: z.ZodString; }, "strict", z.ZodTypeAny, { userId: string; sessionId: string; tenantId?: string | undefined; }, { userId: string; sessionId: string; tenantId?: string | undefined; }>; commandId: z.ZodString; operatorId: z.ZodString...	Runtime schema for Close Dead Letter Session Command Request.
listStuckSessionCommandsRequestSchema	constant	const listStuckSessionCommandsRequestSchema: z.ZodObject<{ scope: z.ZodObject<{ tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodString; sessionId: z.ZodString; }, "strict", z.ZodTypeAny, { userId: string; sessionId: string; tenantId?: string | undefined; }, { userId: string; sessionId: string; tenantId?: string | undefined; }>; checkedAt: z.ZodString; graceMs: z.ZodOptional<z.ZodNumber>; limit: z.ZodOptional<z....	Runtime schema for List Stuck Session Commands Request.
redriveDeadLetterSessionCommandRequestDefinition	constant	const redriveDeadLetterSessionCommandRequestDefinition: SpecSchemaDefinition<RedriveDeadLetterSessionCommandRequest>	Redrive Dead Letter Session Command Request Definition constant exported by the contracts/session-queue-schemas module.
redriveDeadLetterSessionCommandRequestSchema	constant	const redriveDeadLetterSessionCommandRequestSchema: z.ZodObject<{ version: z.ZodLiteral<"1.0.0">; scope: z.ZodObject<{ tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodString; sessionId: z.ZodString; }, "strict", z.ZodTypeAny, { userId: string; sessionId: string; tenantId?: string | undefined; }, { userId: string; sessionId: string; tenantId?: string | undefined; }>; sourceCommandId: z.ZodString; id: z.ZodString...	Runtime schema for Redrive Dead Letter Session Command Request.
sessionCommandDeadLetterResolutionSchema	constant	const sessionCommandDeadLetterResolutionSchema: z.ZodEffects<z.ZodObject<{ version: z.ZodLiteral<"1.0.0">; disposition: z.ZodEnum<["redriven", "closed"]>; operatorId: z.ZodString; reason: z.ZodString; resolvedAt: z.ZodString; redriveCommandId: z.ZodOptional<z.ZodString>; }, "strict", z.ZodTypeAny, { version: "1.0.0"; reason: string; disposition: "closed" | "redriven"; resolvedAt: string; operatorId: string; redriv...	Runtime schema for Session Command Dead Letter Resolution.
sessionCommandLeaseRecoverySchema	constant	const sessionCommandLeaseRecoverySchema: z.ZodObject<{ version: z.ZodLiteral<"1.0.0">; previousWorkerId: z.ZodString; previousLeaseEpoch: z.ZodNumber; leaseExpiredAt: z.ZodString; recoveredAt: z.ZodString; disposition: z.ZodEnum<["requeued", "dead_lettered"]>; }, "strict", z.ZodTypeAny, { version: "1.0.0"; disposition: "requeued" | "dead_lettered"; previousWorkerId: string; previousLeaseEpoch: number; leaseExpired...	Runtime schema for Session Command Lease Recovery.
sessionCommandRecordDefinition	constant	const sessionCommandRecordDefinition: SpecSchemaDefinition<SessionCommandRecord>	Session Command Record Definition constant exported by the contracts/session-queue-schemas module.
sessionCommandRecordExample	constant	const sessionCommandRecordExample: SessionCommandRecord	Valid example value for Session Command Record.
sessionCommandRecordJsonSchema	constant	const sessionCommandRecordJsonSchema: JsonSchema	JSON Schema for Session Command Record.
sessionCommandRecordSchema	constant	const sessionCommandRecordSchema: z.ZodEffects<z.ZodObject<{ id: z.ZodString; commandType: z.ZodEnum<["start_run", "user_input", "resume", "signal", "cancel", "transition", "continue_react", "close_session"]>; idempotencyKey: z.ZodString; tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodString; workspaceId: z.ZodOptional<z.ZodString>; sessionId: z.ZodString; targetRunId: z.ZodOptional<z.ZodString>; enqueueSequen...	Runtime schema for Session Command Record.
sessionCommandRedriveSchema	constant	const sessionCommandRedriveSchema: z.ZodObject<{ version: z.ZodLiteral<"1.0.0">; sourceCommandId: z.ZodString; operatorId: z.ZodString; reason: z.ZodString; requestedAt: z.ZodString; }, "strict", z.ZodTypeAny, { version: "1.0.0"; reason: string; requestedAt: string; sourceCommandId: string; operatorId: string; }, { version: "1.0.0"; reason: string; requestedAt: string; sourceCommandId: string; operatorId: string; }>	Runtime schema for Session Command Redrive.
sessionCommandStatusSchema	constant	const sessionCommandStatusSchema: z.ZodEnum<["queued", "claimed", "applied", "reused", "rejected", "expired", "failed", "dead_letter", "dead_letter_resolved"]>	Runtime schema for Session Command Status.
sessionCommandTypeSchema	constant	const sessionCommandTypeSchema: z.ZodEnum<["start_run", "user_input", "resume", "signal", "cancel", "transition", "continue_react", "close_session"]>	Runtime schema for Session Command Type.
sessionQueueContractDefinitions	constant	const sessionQueueContractDefinitions: readonly [SpecSchemaDefinition<SessionCommandRecord>, SpecSchemaDefinition<CancelSessionCommandsRequest>, SpecSchemaDefinition<CancelSessionCommandsResult>, SpecSchemaDefinition<RedriveDeadLetterSessionCommandRequest>, SpecSchemaDefinition<CloseDeadLetterSessionCommandRequest>, SpecSchemaDefinition<SessionQueueHealthSnapshot>]	Session Queue Contract Definitions constant exported by the contracts/session-queue-schemas module.
sessionQueueContractJsonSchemas	constant	const sessionQueueContractJsonSchemas: Record<string, JsonSchema>	Session Queue Contract JSON Schemas constant exported by the contracts/session-queue-schemas module.
sessionQueueHealthSnapshotDefinition	constant	const sessionQueueHealthSnapshotDefinition: SpecSchemaDefinition<SessionQueueHealthSnapshot>	Session Queue Health Snapshot Definition constant exported by the contracts/session-queue-schemas module.
sessionQueueHealthSnapshotSchema	constant	const sessionQueueHealthSnapshotSchema: z.ZodEffects<z.ZodObject<{ version: z.ZodLiteral<"1.0.0">; totalCommands: z.ZodNumber; pendingCommands: z.ZodNumber; queuedCommands: z.ZodNumber; claimedCommands: z.ZodNumber; deadLetterCommands: z.ZodNumber; resolvedDeadLetterCommands: z.ZodNumber; retryingCommands: z.ZodNumber; redeliveredCommands: z.ZodNumber; recoveredExpiredLeases: z.ZodNumber; leaseRecoveryCount: z.Zod...	Runtime schema for Session Queue Health Snapshot.
sessionQueueScopeSchema	constant	const sessionQueueScopeSchema: z.ZodObject<{ tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodString; sessionId: z.ZodString; }, "strict", z.ZodTypeAny, { userId: string; sessionId: string; tenantId?: string | undefined; }, { userId: string; sessionId: string; tenantId?: string | undefined; }>	Runtime schema for Session Queue Scope.
stuckSessionCommandSchema	constant	const stuckSessionCommandSchema: z.ZodObject<{ command: z.ZodEffects<z.ZodObject<{ id: z.ZodString; commandType: z.ZodEnum<["start_run", "user_input", "resume", "signal", "cancel", "transition", "continue_react", "close_session"]>; idempotencyKey: z.ZodString; tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodString; workspaceId: z.ZodOptional<z.ZodString>; sessionId: z.ZodString; targetRunId: z.ZodOptional<z.Zod...	Runtime schema for Stuck Session Command.
validateCancelSessionCommandsRequest	function	validateCancelSessionCommandsRequest(input: unknown): CancelSessionCommandsRequest	Validate Cancel Session Commands Request function with 1 public call signature; parameters and return types are listed below.
validateCancelSessionCommandsResult	function	validateCancelSessionCommandsResult(input: unknown): CancelSessionCommandsResult	Validate Cancel Session Commands Result function with 1 public call signature; parameters and return types are listed below.
validateCloseDeadLetterSessionCommandRequest	function	validateCloseDeadLetterSessionCommandRequest(input: unknown): CloseDeadLetterSessionCommandRequest	Validate Close Dead Letter Session Command Request function with 1 public call signature; parameters and return types are listed below.
validateListStuckSessionCommandsRequest	function	validateListStuckSessionCommandsRequest(input: unknown): ListStuckSessionCommandsRequest	Validate List Stuck Session Commands Request function with 1 public call signature; parameters and return types are listed below.
validateRedriveDeadLetterSessionCommandRequest	function	validateRedriveDeadLetterSessionCommandRequest(input: unknown): RedriveDeadLetterSessionCommandRequest	Validate Redrive Dead Letter Session Command Request function with 1 public call signature; parameters and return types are listed below.
validateSessionCommandRecord	function	validateSessionCommandRecord(input: unknown): SessionCommandRecord	Validate Session Command Record function with 1 public call signature; parameters and return types are listed below.
validateSessionQueueHealthSnapshot	function	validateSessionQueueHealthSnapshot(input: unknown): SessionQueueHealthSnapshot	Validate Session Queue Health Snapshot function with 1 public call signature; parameters and return types are listed below.
validateStuckSessionCommand	function	validateStuckSessionCommand(input: unknown): StuckSessionCommand	Validate Stuck Session Command function with 1 public call signature; parameters and return types are listed below.

cancelSessionCommandsRequestDefinition

Cancel Session Commands Request Definition constant exported by the contracts/session-queue-schemas module.

• Kind: constant
• Import: import { cancelSessionCommandsRequestDefinition } from '@codesoul-co/hypha-core';
• Source module: contracts/session-queue-schemas

Declaration

export declare const cancelSessionCommandsRequestDefinition: SpecSchemaDefinition<CancelSessionCommandsRequest>;

cancelSessionCommandsRequestSchema

Runtime schema for Cancel Session Commands Request.

• Kind: constant
• Import: import { cancelSessionCommandsRequestSchema } from '@codesoul-co/hypha-core';
• Source module: contracts/session-queue-schemas

Declaration

export declare const cancelSessionCommandsRequestSchema: z.ZodObject<{ version: z.ZodLiteral<"1.0.0">; scope: z.ZodObject<{ tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodString; sessionId: z.ZodString; }, "strict", z.ZodTypeAny, { userId: string; sessionId: string; tenantId?: string | undefined; }, { userId: string; sessionId: string; tenantId?: string | undefined; }>; targetRunId: z.ZodString; cancellationCommandId: z.ZodString; reason: z.ZodString; cancelledAt: z.ZodString; }, "strict", z.ZodTypeAny, { version: "1.0.0"; reason: string; scope: { userId: string; sessionId: string; tenantId?: string | undefined; }; targetRunId: string; cancellationCommandId: string; cancelledAt: string; }, { version: "1.0.0"; reason: string; scope: { userId: string; sessionId: string; tenantId?: string | undefined; }; targetRunId: string; cancellationCommandId: string; cancelledAt: string; }>;

cancelSessionCommandsResultDefinition

Cancel Session Commands Result Definition constant exported by the contracts/session-queue-schemas module.

• Kind: constant
• Import: import { cancelSessionCommandsResultDefinition } from '@codesoul-co/hypha-core';
• Source module: contracts/session-queue-schemas

Declaration

export declare const cancelSessionCommandsResultDefinition: SpecSchemaDefinition<CancelSessionCommandsResult>;

cancelSessionCommandsResultSchema

Runtime schema for Cancel Session Commands Result.

• Kind: constant
• Import: import { cancelSessionCommandsResultSchema } from '@codesoul-co/hypha-core';
• Source module: contracts/session-queue-schemas

Declaration

export declare const cancelSessionCommandsResultSchema: z.ZodObject<{ targetRunId: z.ZodString; cancelledCommandIds: z.ZodArray<z.ZodString, "many">; alreadyCancelledCommandIds: z.ZodArray<z.ZodString, "many">; alreadyTerminalCommandIds: z.ZodArray<z.ZodString, "many">; }, "strict", z.ZodTypeAny, { targetRunId: string; cancelledCommandIds: string[]; alreadyCancelledCommandIds: string[]; alreadyTerminalCommandIds: string[]; }, { targetRunId: string; cancelledCommandIds: string[]; alreadyCancelledCommandIds: string[]; alreadyTerminalCommandIds: string[]; }>;

closeDeadLetterSessionCommandRequestDefinition

Close Dead Letter Session Command Request Definition constant exported by the contracts/session-queue-schemas module.

• Kind: constant
• Import: import { closeDeadLetterSessionCommandRequestDefinition } from '@codesoul-co/hypha-core';
• Source module: contracts/session-queue-schemas

Declaration

export declare const closeDeadLetterSessionCommandRequestDefinition: SpecSchemaDefinition<CloseDeadLetterSessionCommandRequest>;

closeDeadLetterSessionCommandRequestSchema

Runtime schema for Close Dead Letter Session Command Request.

• Kind: constant
• Import: import { closeDeadLetterSessionCommandRequestSchema } from '@codesoul-co/hypha-core';
• Source module: contracts/session-queue-schemas

Declaration

export declare const closeDeadLetterSessionCommandRequestSchema: z.ZodObject<{ version: z.ZodLiteral<"1.0.0">; scope: z.ZodObject<{ tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodString; sessionId: z.ZodString; }, "strict", z.ZodTypeAny, { userId: string; sessionId: string; tenantId?: string | undefined; }, { userId: string; sessionId: string; tenantId?: string | undefined; }>; commandId: z.ZodString; operatorId: z.ZodString; reason: z.ZodString; closedAt: z.ZodString; }, "strict", z.ZodTypeAny, { version: "1.0.0"; reason: string; scope: { userId: string; sessionId: string; tenantId?: string | undefined; }; commandId: string; operatorId: string; closedAt: string; }, { version: "1.0.0"; reason: string; scope: { userId: string; sessionId: string; tenantId?: string | undefined; }; commandId: string; operatorId: string; closedAt: string; }>;

listStuckSessionCommandsRequestSchema

Runtime schema for List Stuck Session Commands Request.

• Kind: constant
• Import: import { listStuckSessionCommandsRequestSchema } from '@codesoul-co/hypha-core';
• Source module: contracts/session-queue-schemas

Declaration

export declare const listStuckSessionCommandsRequestSchema: z.ZodObject<{ scope: z.ZodObject<{ tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodString; sessionId: z.ZodString; }, "strict", z.ZodTypeAny, { userId: string; sessionId: string; tenantId?: string | undefined; }, { userId: string; sessionId: string; tenantId?: string | undefined; }>; checkedAt: z.ZodString; graceMs: z.ZodOptional<z.ZodNumber>; limit: z.ZodOptional<z.ZodNumber>; }, "strict", z.ZodTypeAny, { scope: { userId: string; sessionId: string; tenantId?: string | undefined; }; checkedAt: string; limit?: number | undefined; graceMs?: number | undefined; }, { scope: { userId: string; sessionId: string; tenantId?: string | undefined; }; checkedAt: string; limit?: number | undefined; graceMs?: number | undefined; }>;

redriveDeadLetterSessionCommandRequestDefinition

Redrive Dead Letter Session Command Request Definition constant exported by the contracts/session-queue-schemas module.

• Kind: constant
• Import: import { redriveDeadLetterSessionCommandRequestDefinition } from '@codesoul-co/hypha-core';
• Source module: contracts/session-queue-schemas

Declaration

export declare const redriveDeadLetterSessionCommandRequestDefinition: SpecSchemaDefinition<RedriveDeadLetterSessionCommandRequest>;

redriveDeadLetterSessionCommandRequestSchema

Runtime schema for Redrive Dead Letter Session Command Request.

• Kind: constant
• Import: import { redriveDeadLetterSessionCommandRequestSchema } from '@codesoul-co/hypha-core';
• Source module: contracts/session-queue-schemas

Declaration

export declare const redriveDeadLetterSessionCommandRequestSchema: z.ZodObject<{ version: z.ZodLiteral<"1.0.0">; scope: z.ZodObject<{ tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodString; sessionId: z.ZodString; }, "strict", z.ZodTypeAny, { userId: string; sessionId: string; tenantId?: string | undefined; }, { userId: string; sessionId: string; tenantId?: string | undefined; }>; sourceCommandId: z.ZodString; id: z.ZodString; idempotencyKey: z.ZodString; operatorId: z.ZodString; reason: z.ZodString; requestedAt: z.ZodOptional<z.ZodString>; availableAt: z.ZodOptional<z.ZodString>; expiresAt: z.ZodOptional<z.ZodString>; priority: z.ZodOptional<z.ZodNumber>; maxAttempts: z.ZodOptional<z.ZodNumber>; }, "strict", z.ZodTypeAny, { id: string; version: "1.0.0"; reason: string; idempotencyKey: string; scope: { userId: string; sessionId: string; tenantId?: string | undefined; }; sourceCommandId: string; operatorId: string; expiresAt?: string | undefined; requestedAt?: string | undefined; maxAttempts?: number | undefined; priority?: number | undefined; availableAt?: string | undefined; }, { id: string; version: "1.0.0"; reason: string; idempotencyKey: string; scope: { userId: string; sessionId: string; tenantId?: string | undefined; }; sourceCommandId: string; operatorId: string; expiresAt?: string | undefined; requestedAt?: string | undefined; maxAttempts?: number | undefined; priority?: number | undefined; availableAt?: string | undefined; }>;

sessionCommandDeadLetterResolutionSchema

Runtime schema for Session Command Dead Letter Resolution.

• Kind: constant
• Import: import { sessionCommandDeadLetterResolutionSchema } from '@codesoul-co/hypha-core';
• Source module: contracts/session-queue-schemas

Declaration

export declare const sessionCommandDeadLetterResolutionSchema: z.ZodEffects<z.ZodObject<{ version: z.ZodLiteral<"1.0.0">; disposition: z.ZodEnum<["redriven", "closed"]>; operatorId: z.ZodString; reason: z.ZodString; resolvedAt: z.ZodString; redriveCommandId: z.ZodOptional<z.ZodString>; }, "strict", z.ZodTypeAny, { version: "1.0.0"; reason: string; disposition: "closed" | "redriven"; resolvedAt: string; operatorId: string; redriveCommandId?: string | undefined; }, { version: "1.0.0"; reason: string; disposition: "closed" | "redriven"; resolvedAt: string; operatorId: string; redriveCommandId?: string | undefined; }>, { version: "1.0.0"; reason: string; disposition: "closed" | "redriven"; resolvedAt: string; operatorId: string; redriveCommandId?: string | undefined; }, { version: "1.0.0"; reason: string; disposition: "closed" | "redriven"; resolvedAt: string; operatorId: string; redriveCommandId?: string | undefined; }>;

sessionCommandLeaseRecoverySchema

Runtime schema for Session Command Lease Recovery.

• Kind: constant
• Import: import { sessionCommandLeaseRecoverySchema } from '@codesoul-co/hypha-core';
• Source module: contracts/session-queue-schemas

Declaration

export declare const sessionCommandLeaseRecoverySchema: z.ZodObject<{ version: z.ZodLiteral<"1.0.0">; previousWorkerId: z.ZodString; previousLeaseEpoch: z.ZodNumber; leaseExpiredAt: z.ZodString; recoveredAt: z.ZodString; disposition: z.ZodEnum<["requeued", "dead_lettered"]>; }, "strict", z.ZodTypeAny, { version: "1.0.0"; disposition: "requeued" | "dead_lettered"; previousWorkerId: string; previousLeaseEpoch: number; leaseExpiredAt: string; recoveredAt: string; }, { version: "1.0.0"; disposition: "requeued" | "dead_lettered"; previousWorkerId: string; previousLeaseEpoch: number; leaseExpiredAt: string; recoveredAt: string; }>;

sessionCommandRecordDefinition

Session Command Record Definition constant exported by the contracts/session-queue-schemas module.

• Kind: constant
• Import: import { sessionCommandRecordDefinition } from '@codesoul-co/hypha-core';
• Source module: contracts/session-queue-schemas

Declaration

export declare const sessionCommandRecordDefinition: SpecSchemaDefinition<SessionCommandRecord>;

sessionCommandRecordExample

Valid example value for Session Command Record.

• Kind: constant
• Import: import { sessionCommandRecordExample } from '@codesoul-co/hypha-core';
• Source module: contracts/session-queue-schemas

Declaration

export declare const sessionCommandRecordExample: SessionCommandRecord;

sessionCommandRecordJsonSchema

JSON Schema for Session Command Record.

• Kind: constant
• Import: import { sessionCommandRecordJsonSchema } from '@codesoul-co/hypha-core';
• Source module: contracts/session-queue-schemas

Declaration

export declare const sessionCommandRecordJsonSchema: JsonSchema;

sessionCommandRecordSchema

Runtime schema for Session Command Record.

• Kind: constant
• Import: import { sessionCommandRecordSchema } from '@codesoul-co/hypha-core';
• Source module: contracts/session-queue-schemas

Declaration

// Exact type resolved from the package entrypoint; see source for the compiler expansion.
export declare const sessionCommandRecordSchema: (typeof import('@codesoul-co/hypha-core'))['sessionCommandRecordSchema'];

This compiler-expanded constant type is compacted. Its public name, top-level type, and source location remain here; use the module’s exported interfaces, types, or runtime schema for input/output fields.

sessionCommandRedriveSchema

Runtime schema for Session Command Redrive.

• Kind: constant
• Import: import { sessionCommandRedriveSchema } from '@codesoul-co/hypha-core';
• Source module: contracts/session-queue-schemas

Declaration

export declare const sessionCommandRedriveSchema: z.ZodObject<{ version: z.ZodLiteral<"1.0.0">; sourceCommandId: z.ZodString; operatorId: z.ZodString; reason: z.ZodString; requestedAt: z.ZodString; }, "strict", z.ZodTypeAny, { version: "1.0.0"; reason: string; requestedAt: string; sourceCommandId: string; operatorId: string; }, { version: "1.0.0"; reason: string; requestedAt: string; sourceCommandId: string; operatorId: string; }>;

sessionCommandStatusSchema

Runtime schema for Session Command Status.

• Kind: constant
• Import: import { sessionCommandStatusSchema } from '@codesoul-co/hypha-core';
• Source module: contracts/session-queue-schemas

Declaration

export declare const sessionCommandStatusSchema: z.ZodEnum<["queued", "claimed", "applied", "reused", "rejected", "expired", "failed", "dead_letter", "dead_letter_resolved"]>;

sessionCommandTypeSchema

Runtime schema for Session Command Type.

• Kind: constant
• Import: import { sessionCommandTypeSchema } from '@codesoul-co/hypha-core';
• Source module: contracts/session-queue-schemas

Declaration

export declare const sessionCommandTypeSchema: z.ZodEnum<["start_run", "user_input", "resume", "signal", "cancel", "transition", "continue_react", "close_session"]>;

sessionQueueContractDefinitions

Session Queue Contract Definitions constant exported by the contracts/session-queue-schemas module.

• Kind: constant
• Import: import { sessionQueueContractDefinitions } from '@codesoul-co/hypha-core';
• Source module: contracts/session-queue-schemas

Declaration

export declare const sessionQueueContractDefinitions: readonly [SpecSchemaDefinition<SessionCommandRecord>, SpecSchemaDefinition<CancelSessionCommandsRequest>, SpecSchemaDefinition<CancelSessionCommandsResult>, SpecSchemaDefinition<RedriveDeadLetterSessionCommandRequest>, SpecSchemaDefinition<CloseDeadLetterSessionCommandRequest>, SpecSchemaDefinition<SessionQueueHealthSnapshot>];

sessionQueueContractJsonSchemas

Session Queue Contract JSON Schemas constant exported by the contracts/session-queue-schemas module.

• Kind: constant
• Import: import { sessionQueueContractJsonSchemas } from '@codesoul-co/hypha-core';
• Source module: contracts/session-queue-schemas

Declaration

export declare const sessionQueueContractJsonSchemas: Record<string, JsonSchema>;

sessionQueueHealthSnapshotDefinition

Session Queue Health Snapshot Definition constant exported by the contracts/session-queue-schemas module.

• Kind: constant
• Import: import { sessionQueueHealthSnapshotDefinition } from '@codesoul-co/hypha-core';
• Source module: contracts/session-queue-schemas

Declaration

export declare const sessionQueueHealthSnapshotDefinition: SpecSchemaDefinition<SessionQueueHealthSnapshot>;

sessionQueueHealthSnapshotSchema

Runtime schema for Session Queue Health Snapshot.

• Kind: constant
• Import: import { sessionQueueHealthSnapshotSchema } from '@codesoul-co/hypha-core';
• Source module: contracts/session-queue-schemas

Declaration

export declare const sessionQueueHealthSnapshotSchema: z.ZodEffects<z.ZodObject<{ version: z.ZodLiteral<"1.0.0">; totalCommands: z.ZodNumber; pendingCommands: z.ZodNumber; queuedCommands: z.ZodNumber; claimedCommands: z.ZodNumber; deadLetterCommands: z.ZodNumber; resolvedDeadLetterCommands: z.ZodNumber; retryingCommands: z.ZodNumber; redeliveredCommands: z.ZodNumber; recoveredExpiredLeases: z.ZodNumber; leaseRecoveryCount: z.ZodNumber; oldestPendingAgeMs: z.ZodOptional<z.ZodNumber>; }, "strict", z.ZodTypeAny, { 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 | undefined; }, { 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 | undefined; }>, { 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 | undefined; }, { 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 | undefined; }>;

sessionQueueScopeSchema

Runtime schema for Session Queue Scope.

• Kind: constant
• Import: import { sessionQueueScopeSchema } from '@codesoul-co/hypha-core';
• Source module: contracts/session-queue-schemas

Declaration

export declare const sessionQueueScopeSchema: z.ZodObject<{ tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodString; sessionId: z.ZodString; }, "strict", z.ZodTypeAny, { userId: string; sessionId: string; tenantId?: string | undefined; }, { userId: string; sessionId: string; tenantId?: string | undefined; }>;

stuckSessionCommandSchema

Runtime schema for Stuck Session Command.

• Kind: constant
• Import: import { stuckSessionCommandSchema } from '@codesoul-co/hypha-core';
• Source module: contracts/session-queue-schemas

Declaration

// Exact type resolved from the package entrypoint; see source for the compiler expansion.
export declare const stuckSessionCommandSchema: (typeof import('@codesoul-co/hypha-core'))['stuckSessionCommandSchema'];

This compiler-expanded constant type is compacted. Its public name, top-level type, and source location remain here; use the module’s exported interfaces, types, or runtime schema for input/output fields.

validateCancelSessionCommandsRequest

Validate Cancel Session Commands Request function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateCancelSessionCommandsRequest } from '@codesoul-co/hypha-core';
• Source module: contracts/session-queue-schemas

Declaration

export declare function validateCancelSessionCommandsRequest(input: unknown): CancelSessionCommandsRequest;

Call signature

validateCancelSessionCommandsRequest(input: unknown): CancelSessionCommandsRequest

Parameters

Parameter	Type	Required	Description
input	unknown	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: CancelSessionCommandsRequest
• Description: The return contract is defined by the type shown above.

validateCancelSessionCommandsResult

Validate Cancel Session Commands Result function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateCancelSessionCommandsResult } from '@codesoul-co/hypha-core';
• Source module: contracts/session-queue-schemas

Declaration

export declare function validateCancelSessionCommandsResult(input: unknown): CancelSessionCommandsResult;

Call signature

validateCancelSessionCommandsResult(input: unknown): CancelSessionCommandsResult

Parameters

Parameter	Type	Required	Description
input	unknown	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: CancelSessionCommandsResult
• Description: The return contract is defined by the type shown above.

validateCloseDeadLetterSessionCommandRequest

Validate Close Dead Letter Session Command Request function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateCloseDeadLetterSessionCommandRequest } from '@codesoul-co/hypha-core';
• Source module: contracts/session-queue-schemas

Declaration

export declare function validateCloseDeadLetterSessionCommandRequest(input: unknown): CloseDeadLetterSessionCommandRequest;

Call signature

validateCloseDeadLetterSessionCommandRequest(input: unknown): CloseDeadLetterSessionCommandRequest

Parameters

Parameter	Type	Required	Description
input	unknown	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: CloseDeadLetterSessionCommandRequest
• Description: The return contract is defined by the type shown above.

validateListStuckSessionCommandsRequest

Validate List Stuck Session Commands Request function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateListStuckSessionCommandsRequest } from '@codesoul-co/hypha-core';
• Source module: contracts/session-queue-schemas

Declaration

export declare function validateListStuckSessionCommandsRequest(input: unknown): ListStuckSessionCommandsRequest;

Call signature

validateListStuckSessionCommandsRequest(input: unknown): ListStuckSessionCommandsRequest

Parameters

Parameter	Type	Required	Description
input	unknown	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: ListStuckSessionCommandsRequest
• Description: The return contract is defined by the type shown above.

validateRedriveDeadLetterSessionCommandRequest

Validate Redrive Dead Letter Session Command Request function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateRedriveDeadLetterSessionCommandRequest } from '@codesoul-co/hypha-core';
• Source module: contracts/session-queue-schemas

Declaration

export declare function validateRedriveDeadLetterSessionCommandRequest(input: unknown): RedriveDeadLetterSessionCommandRequest;

Call signature

validateRedriveDeadLetterSessionCommandRequest(input: unknown): RedriveDeadLetterSessionCommandRequest

Parameters

Parameter	Type	Required	Description
input	unknown	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: RedriveDeadLetterSessionCommandRequest
• Description: The return contract is defined by the type shown above.

validateSessionCommandRecord

Validate Session Command Record function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateSessionCommandRecord } from '@codesoul-co/hypha-core';
• Source module: contracts/session-queue-schemas

Declaration

export declare function validateSessionCommandRecord(input: unknown): SessionCommandRecord;

Call signature

validateSessionCommandRecord(input: unknown): SessionCommandRecord

Parameters

Parameter	Type	Required	Description
input	unknown	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: SessionCommandRecord
• Description: The return contract is defined by the type shown above.

validateSessionQueueHealthSnapshot

Validate Session Queue Health Snapshot function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateSessionQueueHealthSnapshot } from '@codesoul-co/hypha-core';
• Source module: contracts/session-queue-schemas

Declaration

export declare function validateSessionQueueHealthSnapshot(input: unknown): SessionQueueHealthSnapshot;

Call signature

validateSessionQueueHealthSnapshot(input: unknown): SessionQueueHealthSnapshot

Parameters

Parameter	Type	Required	Description
input	unknown	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: SessionQueueHealthSnapshot
• Description: The return contract is defined by the type shown above.

validateStuckSessionCommand

Validate Stuck Session Command function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateStuckSessionCommand } from '@codesoul-co/hypha-core';
• Source module: contracts/session-queue-schemas

Declaration

export declare function validateStuckSessionCommand(input: unknown): StuckSessionCommand;

Call signature

validateStuckSessionCommand(input: unknown): StuckSessionCommand

Parameters

Parameter	Type	Required	Description
input	unknown	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: StuckSessionCommand
• Description: The return contract is defined by the type shown above.