`@codesoul-co/hypha-core` / `contracts/runtime`

Package index: @codesoul-co/hypha-core
Source: packages/core/src/contracts/runtime.ts
Exports: 20

Using this module

Use the Runtime module for declaring and runtime-validating contracts. It exports 6 constants, 8 interfaces, 6 types.

Import from the package entrypoint

import {
  RUNTIME_ERROR_CODES,
  RUNTIME_PRINCIPAL_TYPES,
  RUNTIME_RUN_STATUSES,
  RUNTIME_SESSION_STATUSES,
  RUNTIME_WAIT_STATUSES,
  RUNTIME_WAIT_TYPES,
} from '@codesoul-co/hypha-core';

import type {
  NormalizedRuntimeError,
  RunSignalRequest,
  RuntimePrincipal,
  RuntimeRun,
  RuntimeScope,
  RuntimeSession,
  RuntimeWaitRecord,
  RuntimeWaitRequest,
} from '@codesoul-co/hypha-core';

// The complete export list is documented below.

Usage patterns

Use the 14 type/interface exports as static contracts in application code, adapters, or tests. Import them with import type; they do not exist at runtime.
The 6 constant/enum exports provide stable values, schemas, definitions, or defaults. Reuse these exports instead of copying internal values into an application.

Public exports

Symbol	Kind	Signature	Description
`RUNTIME_ERROR_CODES`	constant	`const RUNTIME_ERROR_CODES: readonly ["RUNTIME_INVALID_INPUT", "RUNTIME_MESSAGE_BUS_UNAVAILABLE", "RUNTIME_MESSAGE_SCHEMA_INVALID", "RUNTIME_MESSAGE_DEAD_LETTERED", "RUNTIME_SESSION_QUEUE_CONFLICT", "RUNTIME_SESSION_QUEUE_OVERFLOW", "RUNTIME_FENCING_REJECTED", "RUNTIME_RESOURCE_CONFLICT", "RUNTIME_IDEMPOTENCY_CONFLICT", "RUNTIME_EVENT_STREAM_CORRUPT", "RUNTIME_RECOVERY_REQUIRES_REVIEW", "RUNTIME_RUN_NOT_FOUND", "RU...`	RUNTIME ERROR CODES constant exported by the `contracts/runtime` module.
`RUNTIME_PRINCIPAL_TYPES`	constant	`const RUNTIME_PRINCIPAL_TYPES: readonly ["user", "agent", "service", "system"]`	RUNTIME PRINCIPAL TYPES constant exported by the `contracts/runtime` module.
`RUNTIME_RUN_STATUSES`	constant	`const RUNTIME_RUN_STATUSES: readonly ["created", "queued", "starting", "acquiring", "running", "waiting", "waiting_human", "waiting_signal", "waiting_timer", "pausing", "paused", "retry_scheduled", "recovering", "cancelling", "completed", "failed", "cancelled", "timed_out"]`	RUNTIME RUN STATUSES constant exported by the `contracts/runtime` module.
`RUNTIME_SESSION_STATUSES`	constant	`const RUNTIME_SESSION_STATUSES: readonly ["active", "closed", "archived"]`	RUNTIME SESSION STATUSES constant exported by the `contracts/runtime` module.
`RUNTIME_WAIT_STATUSES`	constant	`const RUNTIME_WAIT_STATUSES: readonly ["waiting", "received", "expired", "cancelled"]`	RUNTIME WAIT STATUSES constant exported by the `contracts/runtime` module.
`RUNTIME_WAIT_TYPES`	constant	`const RUNTIME_WAIT_TYPES: readonly ["human", "signal", "timer", "external_operation"]`	RUNTIME WAIT TYPES constant exported by the `contracts/runtime` module.
`NormalizedRuntimeError`	interface	`interface NormalizedRuntimeError`	Normalized Runtime Error interface with 7 public fields or methods.
`RunSignalRequest`	interface	`interface RunSignalRequest`	Run Signal Request interface with 7 public fields or methods.
`RuntimePrincipal`	interface	`interface RuntimePrincipal`	Runtime Principal interface with 8 public fields or methods.
`RuntimeRun`	interface	`interface RuntimeRun`	Runtime Run interface with 32 public fields or methods.
`RuntimeScope`	interface	`interface RuntimeScope`	Runtime Scope interface with 6 public fields or methods.
`RuntimeSession`	interface	`interface RuntimeSession`	Runtime Session interface with 13 public fields or methods.
`RuntimeWaitRecord`	interface	`interface RuntimeWaitRecord`	Runtime Wait Record interface with 11 public fields or methods.
`RuntimeWaitRequest`	interface	`interface RuntimeWaitRequest`	Runtime Wait Request interface with 7 public fields or methods.
`RuntimeErrorCode`	type	`type RuntimeErrorCode = (typeof RUNTIME_ERROR_CODES)[number]`	Public type alias for Runtime Error Code; the declaration contains its complete type expression.
`RuntimePrincipalType`	type	`type RuntimePrincipalType = (typeof RUNTIME_PRINCIPAL_TYPES)[number]`	Public type alias for Runtime Principal Type; the declaration contains its complete type expression.
`RuntimeRunStatus`	type	`type RuntimeRunStatus = (typeof RUNTIME_RUN_STATUSES)[number]`	Public type alias for Runtime Run Status; the declaration contains its complete type expression.
`RuntimeSessionStatus`	type	`type RuntimeSessionStatus = (typeof RUNTIME_SESSION_STATUSES)[number]`	Public type alias for Runtime Session Status; the declaration contains its complete type expression.
`RuntimeWaitStatus`	type	`type RuntimeWaitStatus = (typeof RUNTIME_WAIT_STATUSES)[number]`	Public type alias for Runtime Wait Status; the declaration contains its complete type expression.
`RuntimeWaitType`	type	`type RuntimeWaitType = (typeof RUNTIME_WAIT_TYPES)[number]`	Public type alias for Runtime Wait Type; the declaration contains its complete type expression.

`RUNTIME_ERROR_CODES`

RUNTIME ERROR CODES constant exported by the contracts/runtime module.

Kind: constant
Import: import { RUNTIME_ERROR_CODES } from '@codesoul-co/hypha-core';
Source module: contracts/runtime

Declaration

text

export declare const RUNTIME_ERROR_CODES: readonly ["RUNTIME_INVALID_INPUT", "RUNTIME_MESSAGE_BUS_UNAVAILABLE", "RUNTIME_MESSAGE_SCHEMA_INVALID", "RUNTIME_MESSAGE_DEAD_LETTERED", "RUNTIME_SESSION_QUEUE_CONFLICT", "RUNTIME_SESSION_QUEUE_OVERFLOW", "RUNTIME_FENCING_REJECTED", "RUNTIME_RESOURCE_CONFLICT", "RUNTIME_IDEMPOTENCY_CONFLICT", "RUNTIME_EVENT_STREAM_CORRUPT", "RUNTIME_RECOVERY_REQUIRES_REVIEW", "RUNTIME_RUN_NOT_FOUND", "RUNTIME_RUN_CONFLICT", "RUNTIME_LEASE_CONFLICT", "RUNTIME_WORKFLOW_INVALID", "RUNTIME_PROCESS_MISMATCH", "RUNTIME_STATE_NOT_FOUND", "RUNTIME_TRANSITION_REJECTED", "RUNTIME_GUARD_FAILED", "RUNTIME_INVARIANT_FAILED", "RUNTIME_STATE_TIMEOUT", "RUNTIME_RUN_TIMEOUT", "RUNTIME_CANCELLED", "RUNTIME_SIGNAL_INVALID", "RUNTIME_SIGNAL_EXPIRED", "RUNTIME_RETRY_EXHAUSTED", "RUNTIME_CHECKPOINT_FAILED", "RUNTIME_EVENT_APPEND_FAILED", "RUNTIME_PROJECTION_FAILED", "RUNTIME_REPLAY_DIVERGENCE", "RUNTIME_INTERNAL_ERROR"];

`RUNTIME_PRINCIPAL_TYPES`

RUNTIME PRINCIPAL TYPES constant exported by the contracts/runtime module.

Kind: constant
Import: import { RUNTIME_PRINCIPAL_TYPES } from '@codesoul-co/hypha-core';
Source module: contracts/runtime

Declaration

text

export declare const RUNTIME_PRINCIPAL_TYPES: readonly ["user", "agent", "service", "system"];

`RUNTIME_RUN_STATUSES`

RUNTIME RUN STATUSES constant exported by the contracts/runtime module.

Kind: constant
Import: import { RUNTIME_RUN_STATUSES } from '@codesoul-co/hypha-core';
Source module: contracts/runtime

Declaration

text

export declare const RUNTIME_RUN_STATUSES: readonly ["created", "queued", "starting", "acquiring", "running", "waiting", "waiting_human", "waiting_signal", "waiting_timer", "pausing", "paused", "retry_scheduled", "recovering", "cancelling", "completed", "failed", "cancelled", "timed_out"];

`RUNTIME_SESSION_STATUSES`

RUNTIME SESSION STATUSES constant exported by the contracts/runtime module.

Kind: constant
Import: import { RUNTIME_SESSION_STATUSES } from '@codesoul-co/hypha-core';
Source module: contracts/runtime

Declaration

text

export declare const RUNTIME_SESSION_STATUSES: readonly ["active", "closed", "archived"];

`RUNTIME_WAIT_STATUSES`

RUNTIME WAIT STATUSES constant exported by the contracts/runtime module.

Kind: constant
Import: import { RUNTIME_WAIT_STATUSES } from '@codesoul-co/hypha-core';
Source module: contracts/runtime

Declaration

text

export declare const RUNTIME_WAIT_STATUSES: readonly ["waiting", "received", "expired", "cancelled"];

`RUNTIME_WAIT_TYPES`

RUNTIME WAIT TYPES constant exported by the contracts/runtime module.

Kind: constant
Import: import { RUNTIME_WAIT_TYPES } from '@codesoul-co/hypha-core';
Source module: contracts/runtime

Declaration

text

export declare const RUNTIME_WAIT_TYPES: readonly ["human", "signal", "timer", "external_operation"];

`NormalizedRuntimeError`

Normalized Runtime Error interface with 7 public fields or methods.

Kind: interface
Import: import type { NormalizedRuntimeError } from '@codesoul-co/hypha-core';
Source module: contracts/runtime

Declaration

text

export interface NormalizedRuntimeError {
    code: RuntimeErrorCode;
    message: string;
    retryable: boolean;
    stateId?: string;
    transitionId?: string;
    details?: Record<string, unknown>;
    causeRef?: string;
}

Contract members

Member	Kind	Signature	Description
`causeRef`	property	`causeRef?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`code`	property	`code: "RUNTIME_INVALID_INPUT" \| "RUNTIME_MESSAGE_BUS_UNAVAILABLE" \| "RUNTIME_MESSAGE_SCHEMA_INVALID" \| "RUNTIME_MESSAGE_DEAD_LETTERED" \| "RUNTIME_SESSION_QUEUE_CONFLICT" \| "RUNTIME_SESSION_QUEUE_OVERFLOW" \| "RUNTIME_FENCING_REJECTED" \| "RUNTIME_RESOURCE_CONFLICT" \| "RUNTIME_IDEMPOTENCY_CONFLICT" \| "RUNTIME_EVENT_STREAM_CORRUPT" \| "RUNTIME_RECOVERY_REQUIRES_REVIEW" \| "RUNTIME_RUN_NOT_FOUND" \| "RUNTIME_RUN_CONFLICT"...`	Public property; its type, readonly modifier and optionality are shown in the signature.
`details`	property	`details?: Record<string, unknown>`	Public property; its type, readonly modifier and optionality are shown in the signature.
`message`	property	`message: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`retryable`	property	`retryable: boolean`	Public property; its type, readonly modifier and optionality are shown in the signature.
`stateId`	property	`stateId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`transitionId`	property	`transitionId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`RunSignalRequest`

Run Signal Request interface with 7 public fields or methods.

Kind: interface
Import: import type { RunSignalRequest } from '@codesoul-co/hypha-core';
Source module: contracts/runtime

Declaration

text

export interface RunSignalRequest {
    signalId: string;
    runId: string;
    key: string;
    principal: RuntimePrincipal;
    payload: unknown;
    idempotencyKey?: string;
    sentAt: string;
}

Contract members

Member	Kind	Signature	Description
`idempotencyKey`	property	`idempotencyKey?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`key`	property	`key: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`payload`	property	`payload: unknown`	Public property; its type, readonly modifier and optionality are shown in the signature.
`principal`	property	`principal: RuntimePrincipal`	Public property; its type, readonly modifier and optionality are shown in the signature.
`runId`	property	`runId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`sentAt`	property	`sentAt: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`signalId`	property	`signalId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`RuntimePrincipal`

Runtime Principal interface with 8 public fields or methods.

Kind: interface
Import: import type { RuntimePrincipal } from '@codesoul-co/hypha-core';
Source module: contracts/runtime

Declaration

text

export interface RuntimePrincipal {
    principalId: string;
    type: RuntimePrincipalType;
    tenantId?: string;
    userId?: string;
    agentId?: string;
    roles?: string[];
    permissionScopes: string[];
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
`agentId`	property	`agentId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`metadata`	property	`metadata?: Record<string, unknown>`	Public property; its type, readonly modifier and optionality are shown in the signature.
`permissionScopes`	property	`permissionScopes: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`principalId`	property	`principalId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`roles`	property	`roles?: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`tenantId`	property	`tenantId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`type`	property	`type: "system" \| "agent" \| "user" \| "service"`	Public property; its type, readonly modifier and optionality are shown in the signature.
`userId`	property	`userId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`RuntimeRun`

Runtime Run interface with 32 public fields or methods.

Kind: interface
Import: import type { RuntimeRun } from '@codesoul-co/hypha-core';
Source module: contracts/runtime

Declaration

text

export interface RuntimeRun {
    id: string;
    revision: number;
    tenantId?: string;
    userId: string;
    workspaceId?: string;
    sessionId: string;
    domainPackRef?: SpecRef;
    workflowRef: SpecRef;
    workflowRevision: string;
    processSpecRef: string;
    processHash: string;
    rootAgentRef?: SpecRef;
    runtimeProfileRef?: SpecRef;
    status: RuntimeRunStatus;
    input: unknown;
    inputHash: string;
    output?: unknown;
    outputHash?: string;
    currentState?: string;
    terminalState?: string;
    correlationId: string;
    idempotencyKey?: string;
    deadlineAt?: string;
    cancelRequestedAt?: string;
    cancelReason?: string;
    createdAt: string;
    queuedAt?: string;
    startedAt?: string;
    updatedAt: string;
    completedAt?: string;
    error?: NormalizedRuntimeError;
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
`cancelReason`	property	`cancelReason?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`cancelRequestedAt`	property	`cancelRequestedAt?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`completedAt`	property	`completedAt?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`correlationId`	property	`correlationId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`createdAt`	property	`createdAt: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`currentState`	property	`currentState?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`deadlineAt`	property	`deadlineAt?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`domainPackRef`	property	`domainPackRef?: SpecRef`	Public property; its type, readonly modifier and optionality are shown in the signature.
`error`	property	`error?: NormalizedRuntimeError`	Public property; its type, readonly modifier and optionality are shown in the signature.
`id`	property	`id: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`idempotencyKey`	property	`idempotencyKey?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`input`	property	`input: unknown`	Public property; its type, readonly modifier and optionality are shown in the signature.
`inputHash`	property	`inputHash: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`metadata`	property	`metadata?: Record<string, unknown>`	Public property; its type, readonly modifier and optionality are shown in the signature.
`output`	property	`output?: unknown`	Public property; its type, readonly modifier and optionality are shown in the signature.
`outputHash`	property	`outputHash?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`processHash`	property	`processHash: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`processSpecRef`	property	`processSpecRef: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`queuedAt`	property	`queuedAt?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`revision`	property	`revision: number`	Public property; its type, readonly modifier and optionality are shown in the signature.
`rootAgentRef`	property	`rootAgentRef?: SpecRef`	Public property; its type, readonly modifier and optionality are shown in the signature.
`runtimeProfileRef`	property	`runtimeProfileRef?: SpecRef`	Public property; its type, readonly modifier and optionality are shown in the signature.
`sessionId`	property	`sessionId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`startedAt`	property	`startedAt?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`status`	property	`status: "completed" \| "queued" \| "starting" \| "running" \| "cancelling" \| "cancelled" \| "failed" \| "timed_out" \| "created" \| "acquiring" \| "waiting" \| "waiting_human" \| "waiting_signal" \| "waiting_timer" \| "pausing" \| "paused" \| "retry_scheduled" \| "recovering"`	Public property; its type, readonly modifier and optionality are shown in the signature.
`tenantId`	property	`tenantId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`terminalState`	property	`terminalState?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`updatedAt`	property	`updatedAt: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`userId`	property	`userId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`workflowRef`	property	`workflowRef: SpecRef`	Public property; its type, readonly modifier and optionality are shown in the signature.
`workflowRevision`	property	`workflowRevision: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`workspaceId`	property	`workspaceId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`RuntimeScope`

Runtime Scope interface with 6 public fields or methods.

Kind: interface
Import: import type { RuntimeScope } from '@codesoul-co/hypha-core';
Source module: contracts/runtime

Declaration

text

export interface RuntimeScope {
    tenantId?: string;
    userId: string;
    workspaceId?: string;
    sessionId: string;
    runId: string;
    agentId?: string;
}

Contract members

Member	Kind	Signature	Description
`agentId`	property	`agentId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`runId`	property	`runId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`sessionId`	property	`sessionId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`tenantId`	property	`tenantId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`userId`	property	`userId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`workspaceId`	property	`workspaceId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`RuntimeSession`

Runtime Session interface with 13 public fields or methods.

Kind: interface
Import: import type { RuntimeSession } from '@codesoul-co/hypha-core';
Source module: contracts/runtime

Declaration

text

export interface RuntimeSession {
    id: string;
    revision: number;
    tenantId?: string;
    userId: string;
    workspaceId?: string;
    domainPackRef?: SpecRef;
    sessionProfileRef?: SpecRef;
    title?: string;
    metadata: Record<string, unknown>;
    status: RuntimeSessionStatus;
    createdAt: string;
    updatedAt: string;
    closedAt?: string;
}

Contract members

Member	Kind	Signature	Description
`closedAt`	property	`closedAt?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`createdAt`	property	`createdAt: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`domainPackRef`	property	`domainPackRef?: SpecRef`	Public property; its type, readonly modifier and optionality are shown in the signature.
`id`	property	`id: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`metadata`	property	`metadata: Record<string, unknown>`	Public property; its type, readonly modifier and optionality are shown in the signature.
`revision`	property	`revision: number`	Public property; its type, readonly modifier and optionality are shown in the signature.
`sessionProfileRef`	property	`sessionProfileRef?: SpecRef`	Public property; its type, readonly modifier and optionality are shown in the signature.
`status`	property	`status: "archived" \| "active" \| "closed"`	Public property; its type, readonly modifier and optionality are shown in the signature.
`tenantId`	property	`tenantId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`title`	property	`title?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`updatedAt`	property	`updatedAt: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`userId`	property	`userId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`workspaceId`	property	`workspaceId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`RuntimeWaitRecord`

Runtime Wait Record interface with 11 public fields or methods.

Kind: interface
Import: import type { RuntimeWaitRecord } from '@codesoul-co/hypha-core';
Source module: contracts/runtime

Declaration

text

export interface RuntimeWaitRecord {
    id: string;
    runId: string;
    stateId: string;
    type: RuntimeWaitType;
    key?: string;
    status: RuntimeWaitStatus;
    expectedSchemaHash?: string;
    createdAt: string;
    expiresAt?: string;
    resolvedAt?: string;
    signalRef?: string;
}

Contract members

Member	Kind	Signature	Description
`createdAt`	property	`createdAt: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`expectedSchemaHash`	property	`expectedSchemaHash?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`expiresAt`	property	`expiresAt?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`id`	property	`id: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`key`	property	`key?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`resolvedAt`	property	`resolvedAt?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`runId`	property	`runId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`signalRef`	property	`signalRef?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`stateId`	property	`stateId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`status`	property	`status: "cancelled" \| "expired" \| "waiting" \| "received"`	Public property; its type, readonly modifier and optionality are shown in the signature.
`type`	property	`type: "human" \| "signal" \| "timer" \| "external_operation"`	Public property; its type, readonly modifier and optionality are shown in the signature.

`RuntimeWaitRequest`

Runtime Wait Request interface with 7 public fields or methods.

Kind: interface
Import: import type { RuntimeWaitRequest } from '@codesoul-co/hypha-core';
Source module: contracts/runtime

Declaration

text

export interface RuntimeWaitRequest {
    type: RuntimeWaitType;
    key?: string;
    expectedSchema?: JsonSchema;
    expiresAt?: string;
    timeoutTransitionId?: string;
    pendingActionRef?: string;
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
`expectedSchema`	property	`expectedSchema?: JsonSchema`	Public property; its type, readonly modifier and optionality are shown in the signature.
`expiresAt`	property	`expiresAt?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`key`	property	`key?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`metadata`	property	`metadata?: Record<string, unknown>`	Public property; its type, readonly modifier and optionality are shown in the signature.
`pendingActionRef`	property	`pendingActionRef?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`timeoutTransitionId`	property	`timeoutTransitionId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`type`	property	`type: "human" \| "signal" \| "timer" \| "external_operation"`	Public property; its type, readonly modifier and optionality are shown in the signature.

`RuntimeErrorCode`

Public type alias for Runtime Error Code; the declaration contains its complete type expression.

Kind: type
Import: import type { RuntimeErrorCode } from '@codesoul-co/hypha-core';
Source module: contracts/runtime

Declaration

text

export type RuntimeErrorCode = (typeof RUNTIME_ERROR_CODES)[number];

`RuntimePrincipalType`

Public type alias for Runtime Principal Type; the declaration contains its complete type expression.

Kind: type
Import: import type { RuntimePrincipalType } from '@codesoul-co/hypha-core';
Source module: contracts/runtime

Declaration

text

export type RuntimePrincipalType = (typeof RUNTIME_PRINCIPAL_TYPES)[number];

`RuntimeRunStatus`

Public type alias for Runtime Run Status; the declaration contains its complete type expression.

Kind: type
Import: import type { RuntimeRunStatus } from '@codesoul-co/hypha-core';
Source module: contracts/runtime

Declaration

text

export type RuntimeRunStatus = (typeof RUNTIME_RUN_STATUSES)[number];

`RuntimeSessionStatus`

Public type alias for Runtime Session Status; the declaration contains its complete type expression.

Kind: type
Import: import type { RuntimeSessionStatus } from '@codesoul-co/hypha-core';
Source module: contracts/runtime

Declaration

text

export type RuntimeSessionStatus = (typeof RUNTIME_SESSION_STATUSES)[number];

`RuntimeWaitStatus`

Public type alias for Runtime Wait Status; the declaration contains its complete type expression.

Kind: type
Import: import type { RuntimeWaitStatus } from '@codesoul-co/hypha-core';
Source module: contracts/runtime

Declaration

text

export type RuntimeWaitStatus = (typeof RUNTIME_WAIT_STATUSES)[number];

`RuntimeWaitType`

Public type alias for Runtime Wait Type; the declaration contains its complete type expression.

Kind: type
Import: import type { RuntimeWaitType } from '@codesoul-co/hypha-core';
Source module: contracts/runtime

Declaration

text

export type RuntimeWaitType = (typeof RUNTIME_WAIT_TYPES)[number];

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

Using this module ​

Import from the package entrypoint ​

Usage patterns ​

Public exports ​

RUNTIME_ERROR_CODES ​

Declaration ​

RUNTIME_PRINCIPAL_TYPES ​

Declaration ​

RUNTIME_RUN_STATUSES ​

Declaration ​

RUNTIME_SESSION_STATUSES ​

Declaration ​

RUNTIME_WAIT_STATUSES ​

Declaration ​

RUNTIME_WAIT_TYPES ​

Declaration ​

NormalizedRuntimeError ​

Declaration ​

Contract members ​

RunSignalRequest ​

Declaration ​

Contract members ​

RuntimePrincipal ​

Declaration ​

Contract members ​

RuntimeRun ​

Declaration ​

Contract members ​

RuntimeScope ​

Declaration ​

Contract members ​

RuntimeSession ​

Declaration ​

Contract members ​

RuntimeWaitRecord ​

Declaration ​

Contract members ​

RuntimeWaitRequest ​

Declaration ​

Contract members ​

RuntimeErrorCode ​

Declaration ​

RuntimePrincipalType ​

Declaration ​

RuntimeRunStatus ​

Declaration ​

RuntimeSessionStatus ​

Declaration ​

RuntimeWaitStatus ​

Declaration ​

RuntimeWaitType ​

Declaration ​

`@codesoul-co/hypha-core` / `contracts/runtime`

Using this module

Import from the package entrypoint

Usage patterns

Public exports

`RUNTIME_ERROR_CODES`

Declaration

`RUNTIME_PRINCIPAL_TYPES`

Declaration

`RUNTIME_RUN_STATUSES`

Declaration

`RUNTIME_SESSION_STATUSES`

Declaration

`RUNTIME_WAIT_STATUSES`

Declaration

`RUNTIME_WAIT_TYPES`

Declaration

`NormalizedRuntimeError`

Declaration

Contract members

`RunSignalRequest`

Declaration

Contract members

`RuntimePrincipal`

Declaration

Contract members

`RuntimeRun`

Declaration

Contract members

`RuntimeScope`

Declaration

Contract members

`RuntimeSession`

Declaration

Contract members

`RuntimeWaitRecord`

Declaration

Contract members

`RuntimeWaitRequest`

Declaration

Contract members

`RuntimeErrorCode`

Declaration

`RuntimePrincipalType`

Declaration

`RuntimeRunStatus`

Declaration

`RuntimeSessionStatus`

Declaration

`RuntimeWaitStatus`

Declaration

`RuntimeWaitType`

Declaration