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

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

Using this module

Use the Runtime recovery module for declaring and runtime-validating contracts. It exports 5 constants, 15 interfaces, 5 types.

Import from the package entrypoint

import {
  RUNTIME_ACTIVITY_COMPENSATION_STATUSES,
  RUNTIME_ACTIVITY_RECONCILIATION_STATUSES,
  RUNTIME_RECOVERY_CANDIDATE_REASONS,
  RUNTIME_RECOVERY_DISPOSITIONS,
  RUNTIME_RECOVERY_SAFE_ACTIONS,
} from '@codesoul-co/hypha-core';

import type {
  RuntimeActivityCompensationRequest,
  RuntimeActivityCompensationResult,
  RuntimeActivityReconciliationPort,
  RuntimeActivityReconciliationRequest,
  RuntimeActivityReconciliationResult,
  RuntimeActivityRetryRequest,
  RuntimeCancellationRecoveryPort,
  RuntimeRecoveryCandidate,
} from '@codesoul-co/hypha-core';

// The complete export list is documented below.

Usage patterns

Use the 20 type/interface exports as static contracts in application code, adapters, or tests. Import them with import type; they do not exist at runtime.
The 5 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_ACTIVITY_COMPENSATION_STATUSES`	constant	`const RUNTIME_ACTIVITY_COMPENSATION_STATUSES: readonly ["completed", "failed", "requires_review"]`	RUNTIME ACTIVITY COMPENSATION STATUSES constant exported by the `contracts/runtime-recovery` module.
`RUNTIME_ACTIVITY_RECONCILIATION_STATUSES`	constant	`const RUNTIME_ACTIVITY_RECONCILIATION_STATUSES: readonly ["completed", "failed", "waiting", "cancelled", "not_started", "unknown"]`	RUNTIME ACTIVITY RECONCILIATION STATUSES constant exported by the `contracts/runtime-recovery` module.
`RUNTIME_RECOVERY_CANDIDATE_REASONS`	constant	`const RUNTIME_RECOVERY_CANDIDATE_REASONS: readonly ["LEASE_EXPIRED", "STATE_CLAIM_EXPIRED", "PROJECTION_BEHIND", "CHECKPOINT_BEHIND", "ACTIVITY_RESULT_UNAPPLIED", "ACTIVITY_COMPENSATION_REQUIRED", "ACTIVITY_REDISPATCH_INCOMPLETE", "MESSAGE_UNACKED", "OUTBOX_UNPUBLISHED", "WAIT_WITHOUT_REGISTRATION", "TIMER_OVERDUE", "SESSION_COMMAND_INCOMPLETE", "RUN_PROJECTION_CONFLICT", "CANCELLATION_INCOMPLETE", "CUSTOM"]`	RUNTIME RECOVERY CANDIDATE REASONS constant exported by the `contracts/runtime-recovery` module.
`RUNTIME_RECOVERY_DISPOSITIONS`	constant	`const RUNTIME_RECOVERY_DISPOSITIONS: readonly ["recovered", "reused", "requeued", "compensated", "requires_review", "lease_unavailable", "stale"]`	RUNTIME RECOVERY DISPOSITIONS constant exported by the `contracts/runtime-recovery` module.
`RUNTIME_RECOVERY_SAFE_ACTIONS`	constant	`const RUNTIME_RECOVERY_SAFE_ACTIONS: readonly ["rebuild_projection", "requeue", "apply_observation", "compensate_activity", "reconcile_redispatch", "restore_wait", "fire_timer", "republish_message", "mark_failed", "manual_review"]`	RUNTIME RECOVERY SAFE ACTIONS constant exported by the `contracts/runtime-recovery` module.
`RuntimeActivityCompensationRequest`	interface	`interface RuntimeActivityCompensationRequest`	Runtime Activity Compensation Request interface with 5 public fields or methods.
`RuntimeActivityCompensationResult`	interface	`interface RuntimeActivityCompensationResult`	Runtime Activity Compensation Result interface with 5 public fields or methods.
`RuntimeActivityReconciliationPort`	interface	`interface RuntimeActivityReconciliationPort`	Runtime Activity Reconciliation Port interface with 3 public fields or methods.
`RuntimeActivityReconciliationRequest`	interface	`interface RuntimeActivityReconciliationRequest`	Runtime Activity Reconciliation Request interface with 3 public fields or methods.
`RuntimeActivityReconciliationResult`	interface	`interface RuntimeActivityReconciliationResult`	Runtime Activity Reconciliation Result interface with 5 public fields or methods.
`RuntimeActivityRetryRequest`	interface	`interface RuntimeActivityRetryRequest extends RuntimeActivityReconciliationRequest`	Runtime Activity Retry Request interface with 4 public fields or methods.
`RuntimeCancellationRecoveryPort`	interface	`interface RuntimeCancellationRecoveryPort`	Runtime Cancellation Recovery Port interface with 1 public fields or methods.
`RuntimeRecoveryCandidate`	interface	`interface RuntimeRecoveryCandidate`	Runtime Recovery Candidate interface with 12 public fields or methods.
`RuntimeRecoveryCommand`	interface	`interface RuntimeRecoveryCommand`	Runtime Recovery Command interface with 4 public fields or methods.
`RuntimeRecoveryRequeuePort`	interface	`interface RuntimeRecoveryRequeuePort`	Runtime Recovery Requeue Port interface with 1 public fields or methods.
`RuntimeRecoveryRequeueRequest`	interface	`interface RuntimeRecoveryRequeueRequest`	Runtime Recovery Requeue Request interface with 7 public fields or methods.
`RuntimeRecoveryResult`	interface	`interface RuntimeRecoveryResult`	Runtime Recovery Result interface with 4 public fields or methods.
`RuntimeRecoveryScanRequest`	interface	`interface RuntimeRecoveryScanRequest`	Runtime Recovery Scan Request interface with 3 public fields or methods.
`RuntimeRecoveryScanResult`	interface	`interface RuntimeRecoveryScanResult`	Runtime Recovery Scan Result interface with 3 public fields or methods.
`RuntimeRecoveryScope`	interface	`interface RuntimeRecoveryScope`	Runtime Recovery Scope interface with 3 public fields or methods.
`RuntimeActivityCompensationStatus`	type	`type RuntimeActivityCompensationStatus = (typeof RUNTIME_ACTIVITY_COMPENSATION_STATUSES)[number]`	Public type alias for Runtime Activity Compensation Status; the declaration contains its complete type expression.
`RuntimeActivityReconciliationStatus`	type	`type RuntimeActivityReconciliationStatus = (typeof RUNTIME_ACTIVITY_RECONCILIATION_STATUSES)[number]`	Public type alias for Runtime Activity Reconciliation Status; the declaration contains its complete type expression.
`RuntimeRecoveryCandidateReason`	type	`type RuntimeRecoveryCandidateReason = (typeof RUNTIME_RECOVERY_CANDIDATE_REASONS)[number]`	Public type alias for Runtime Recovery Candidate Reason; the declaration contains its complete type expression.
`RuntimeRecoveryDisposition`	type	`type RuntimeRecoveryDisposition = (typeof RUNTIME_RECOVERY_DISPOSITIONS)[number]`	Public type alias for Runtime Recovery Disposition; the declaration contains its complete type expression.
`RuntimeRecoverySafeAction`	type	`type RuntimeRecoverySafeAction = (typeof RUNTIME_RECOVERY_SAFE_ACTIONS)[number]`	Public type alias for Runtime Recovery Safe Action; the declaration contains its complete type expression.

`RUNTIME_ACTIVITY_COMPENSATION_STATUSES`

RUNTIME ACTIVITY COMPENSATION STATUSES constant exported by the contracts/runtime-recovery module.

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

Declaration

text

export declare const RUNTIME_ACTIVITY_COMPENSATION_STATUSES: readonly ["completed", "failed", "requires_review"];

`RUNTIME_ACTIVITY_RECONCILIATION_STATUSES`

RUNTIME ACTIVITY RECONCILIATION STATUSES constant exported by the contracts/runtime-recovery module.

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

Declaration

text

export declare const RUNTIME_ACTIVITY_RECONCILIATION_STATUSES: readonly ["completed", "failed", "waiting", "cancelled", "not_started", "unknown"];

`RUNTIME_RECOVERY_CANDIDATE_REASONS`

RUNTIME RECOVERY CANDIDATE REASONS constant exported by the contracts/runtime-recovery module.

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

Declaration

text

export declare const RUNTIME_RECOVERY_CANDIDATE_REASONS: readonly ["LEASE_EXPIRED", "STATE_CLAIM_EXPIRED", "PROJECTION_BEHIND", "CHECKPOINT_BEHIND", "ACTIVITY_RESULT_UNAPPLIED", "ACTIVITY_COMPENSATION_REQUIRED", "ACTIVITY_REDISPATCH_INCOMPLETE", "MESSAGE_UNACKED", "OUTBOX_UNPUBLISHED", "WAIT_WITHOUT_REGISTRATION", "TIMER_OVERDUE", "SESSION_COMMAND_INCOMPLETE", "RUN_PROJECTION_CONFLICT", "CANCELLATION_INCOMPLETE", "CUSTOM"];

`RUNTIME_RECOVERY_DISPOSITIONS`

RUNTIME RECOVERY DISPOSITIONS constant exported by the contracts/runtime-recovery module.

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

Declaration

text

export declare const RUNTIME_RECOVERY_DISPOSITIONS: readonly ["recovered", "reused", "requeued", "compensated", "requires_review", "lease_unavailable", "stale"];

`RUNTIME_RECOVERY_SAFE_ACTIONS`

RUNTIME RECOVERY SAFE ACTIONS constant exported by the contracts/runtime-recovery module.

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

Declaration

text

export declare const RUNTIME_RECOVERY_SAFE_ACTIONS: readonly ["rebuild_projection", "requeue", "apply_observation", "compensate_activity", "reconcile_redispatch", "restore_wait", "fire_timer", "republish_message", "mark_failed", "manual_review"];

`RuntimeActivityCompensationRequest`

Runtime Activity Compensation Request interface with 5 public fields or methods.

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

Declaration

text

export interface RuntimeActivityCompensationRequest {
    invocation: RuntimeActivityInvocation;
    reason: string;
    requestedAt: string;
    fencingToken: number;
    idempotencyKey: string;
}

Contract members

Member	Kind	Signature	Description
`fencingToken`	property	`fencingToken: number`	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.
`invocation`	property	`invocation: RuntimeActivityInvocation<import("/Users/erwin/Downloads/codespace/Hypha/packages/core/dist/index").RuntimeJsonValue>`	Public property; its type, readonly modifier and optionality are shown in the signature.
`reason`	property	`reason: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`requestedAt`	property	`requestedAt: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`RuntimeActivityCompensationResult`

Runtime Activity Compensation Result interface with 5 public fields or methods.

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

Declaration

text

export interface RuntimeActivityCompensationResult {
    activityId: string;
    status: RuntimeActivityCompensationStatus;
    providerRevision?: string;
    receiptId?: string;
    errorCode?: string;
}

Contract members

Member	Kind	Signature	Description
`activityId`	property	`activityId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`errorCode`	property	`errorCode?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`providerRevision`	property	`providerRevision?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`receiptId`	property	`receiptId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`status`	property	`status: "completed" \| "failed" \| "requires_review"`	Public property; its type, readonly modifier and optionality are shown in the signature.

`RuntimeActivityReconciliationPort`

Runtime Activity Reconciliation Port interface with 3 public fields or methods.

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

Declaration

text

export interface RuntimeActivityReconciliationPort {
    reconcile(request: RuntimeActivityReconciliationRequest): Promise<RuntimeActivityReconciliationResult>;
    retry(request: RuntimeActivityRetryRequest): Promise<RuntimeActivityObservation>;
    compensate?(request: RuntimeActivityCompensationRequest): Promise<RuntimeActivityCompensationResult>;
}

Contract members

Member	Kind	Signature	Description
`compensate`	method	`compensate?(request: RuntimeActivityCompensationRequest): Promise<RuntimeActivityCompensationResult>`	Public method; parameters and return type are shown in the signature.
`reconcile`	method	`reconcile(request: RuntimeActivityReconciliationRequest): Promise<RuntimeActivityReconciliationResult>`	Public method; parameters and return type are shown in the signature.
`retry`	method	`retry(request: RuntimeActivityRetryRequest): Promise<RuntimeActivityObservation>`	Public method; parameters and return type are shown in the signature.

`RuntimeActivityReconciliationRequest`

Runtime Activity Reconciliation Request interface with 3 public fields or methods.

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

Declaration

text

export interface RuntimeActivityReconciliationRequest {
    invocation: RuntimeActivityInvocation;
    checkedAt: string;
    idempotencyKey: string;
}

Contract members

Member	Kind	Signature	Description
`checkedAt`	property	`checkedAt: 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.
`invocation`	property	`invocation: RuntimeActivityInvocation<import("/Users/erwin/Downloads/codespace/Hypha/packages/core/dist/index").RuntimeJsonValue>`	Public property; its type, readonly modifier and optionality are shown in the signature.

`RuntimeActivityReconciliationResult`

Runtime Activity Reconciliation Result interface with 5 public fields or methods.

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

Declaration

text

export interface RuntimeActivityReconciliationResult {
    activityId: string;
    status: RuntimeActivityReconciliationStatus;
    observation?: RuntimeActivityObservation;
    providerRevision?: string;
    receiptId?: string;
}

Contract members

Member	Kind	Signature	Description
`activityId`	property	`activityId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`observation`	property	`observation?: RuntimeActivityObservation<import("/Users/erwin/Downloads/codespace/Hypha/packages/core/dist/index").RuntimeJsonValue>`	Public property; its type, readonly modifier and optionality are shown in the signature.
`providerRevision`	property	`providerRevision?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`receiptId`	property	`receiptId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`status`	property	`status: "unknown" \| "completed" \| "cancelled" \| "failed" \| "not_started" \| "waiting"`	Public property; its type, readonly modifier and optionality are shown in the signature.

`RuntimeActivityRetryRequest`

Runtime Activity Retry Request interface with 4 public fields or methods.

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

Declaration

text

export interface RuntimeActivityRetryRequest extends RuntimeActivityReconciliationRequest {
    fencingToken: number;
}

Contract members

Member	Kind	Signature	Description
`checkedAt`	property	`checkedAt: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`fencingToken`	property	`fencingToken: number`	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.
`invocation`	property	`invocation: RuntimeActivityInvocation<import("/Users/erwin/Downloads/codespace/Hypha/packages/core/dist/index").RuntimeJsonValue>`	Public property; its type, readonly modifier and optionality are shown in the signature.

`RuntimeCancellationRecoveryPort`

Runtime Cancellation Recovery Port interface with 1 public fields or methods.

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

Declaration

text

export interface RuntimeCancellationRecoveryPort {
    cancel(input: RuntimeCancelCommand): Promise<RuntimeCancelResult>;
}

Contract members

Member	Kind	Signature	Description
`cancel`	method	`cancel(input: RuntimeCancelCommand): Promise<RuntimeCancelResult>`	Public method; parameters and return type are shown in the signature.

`RuntimeRecoveryCandidate`

Runtime Recovery Candidate interface with 12 public fields or methods.

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

Declaration

text

export interface RuntimeRecoveryCandidate {
    candidateId: string;
    scope: RuntimeRecoveryScope;
    reason: RuntimeRecoveryCandidateReason;
    safeAction: RuntimeRecoverySafeAction;
    eventHeadSequence: number;
    projectionSequence?: number;
    activityId?: string;
    redispatchRequestEventId?: string;
    stateId?: string;
    stateAttempt?: number;
    currentLease?: FencedRunLease;
    detectedAt: string;
}

Contract members

Member	Kind	Signature	Description
`activityId`	property	`activityId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`candidateId`	property	`candidateId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`currentLease`	property	`currentLease?: FencedRunLease`	Public property; its type, readonly modifier and optionality are shown in the signature.
`detectedAt`	property	`detectedAt: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`eventHeadSequence`	property	`eventHeadSequence: number`	Public property; its type, readonly modifier and optionality are shown in the signature.
`projectionSequence`	property	`projectionSequence?: number`	Public property; its type, readonly modifier and optionality are shown in the signature.
`reason`	property	`reason: "LEASE_EXPIRED" \| "STATE_CLAIM_EXPIRED" \| "PROJECTION_BEHIND" \| "CHECKPOINT_BEHIND" \| "ACTIVITY_RESULT_UNAPPLIED" \| "ACTIVITY_COMPENSATION_REQUIRED" \| "ACTIVITY_REDISPATCH_INCOMPLETE" \| "MESSAGE_UNACKED" \| "OUTBOX_UNPUBLISHED" \| "WAIT_WITHOUT_REGISTRATION" \| "TIMER_OVERDUE" \| "SESSION_COMMAND_INCOMPLETE" \| "RUN_PROJECTION_CONFLICT" \| "CANCELLATION_INCOMPLETE" \| "CUSTOM"`	Public property; its type, readonly modifier and optionality are shown in the signature.
`redispatchRequestEventId`	property	`redispatchRequestEventId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`safeAction`	property	`safeAction: "rebuild_projection" \| "requeue" \| "apply_observation" \| "compensate_activity" \| "reconcile_redispatch" \| "restore_wait" \| "fire_timer" \| "republish_message" \| "mark_failed" \| "manual_review"`	Public property; its type, readonly modifier and optionality are shown in the signature.
`scope`	property	`scope: RuntimeRecoveryScope`	Public property; its type, readonly modifier and optionality are shown in the signature.
`stateAttempt`	property	`stateAttempt?: number`	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.

`RuntimeRecoveryCommand`

Runtime Recovery Command interface with 4 public fields or methods.

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

Declaration

text

export interface RuntimeRecoveryCommand {
    candidate: RuntimeRecoveryCandidate;
    ownerId: string;
    leaseTtlMs: number;
    requestedAt: string;
}

Contract members

Member	Kind	Signature	Description
`candidate`	property	`candidate: RuntimeRecoveryCandidate`	Public property; its type, readonly modifier and optionality are shown in the signature.
`leaseTtlMs`	property	`leaseTtlMs: number`	Public property; its type, readonly modifier and optionality are shown in the signature.
`ownerId`	property	`ownerId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`requestedAt`	property	`requestedAt: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`RuntimeRecoveryRequeuePort`

Runtime Recovery Requeue Port interface with 1 public fields or methods.

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

Declaration

text

export interface RuntimeRecoveryRequeuePort {
    requeue(request: RuntimeRecoveryRequeueRequest): Promise<void>;
}

Contract members

Member	Kind	Signature	Description
`requeue`	method	`requeue(request: RuntimeRecoveryRequeueRequest): Promise<void>`	Public method; parameters and return type are shown in the signature.

`RuntimeRecoveryRequeueRequest`

Runtime Recovery Requeue Request interface with 7 public fields or methods.

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

Declaration

text

export interface RuntimeRecoveryRequeueRequest {
    scope: RuntimeRecoveryScope;
    reason: RuntimeRecoveryCandidateReason;
    requestedAt: string;
    fencingToken: number;
    expectedStateId?: string;
    expectedStateAttempt?: number;
    idempotencyKey: string;
}

Contract members

Member	Kind	Signature	Description
`expectedStateAttempt`	property	`expectedStateAttempt?: number`	Public property; its type, readonly modifier and optionality are shown in the signature.
`expectedStateId`	property	`expectedStateId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`fencingToken`	property	`fencingToken: number`	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.
`reason`	property	`reason: "LEASE_EXPIRED" \| "STATE_CLAIM_EXPIRED" \| "PROJECTION_BEHIND" \| "CHECKPOINT_BEHIND" \| "ACTIVITY_RESULT_UNAPPLIED" \| "ACTIVITY_COMPENSATION_REQUIRED" \| "ACTIVITY_REDISPATCH_INCOMPLETE" \| "MESSAGE_UNACKED" \| "OUTBOX_UNPUBLISHED" \| "WAIT_WITHOUT_REGISTRATION" \| "TIMER_OVERDUE" \| "SESSION_COMMAND_INCOMPLETE" \| "RUN_PROJECTION_CONFLICT" \| "CANCELLATION_INCOMPLETE" \| "CUSTOM"`	Public property; its type, readonly modifier and optionality are shown in the signature.
`requestedAt`	property	`requestedAt: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`scope`	property	`scope: RuntimeRecoveryScope`	Public property; its type, readonly modifier and optionality are shown in the signature.

`RuntimeRecoveryResult`

Runtime Recovery Result interface with 4 public fields or methods.

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

Declaration

text

export interface RuntimeRecoveryResult {
    candidateId: string;
    disposition: RuntimeRecoveryDisposition;
    eventIds: string[];
    projection?: RuntimeOrchestrationProjection;
}

Contract members

Member	Kind	Signature	Description
`candidateId`	property	`candidateId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`disposition`	property	`disposition: "recovered" \| "compensated" \| "reused" \| "requeued" \| "lease_unavailable" \| "requires_review" \| "stale"`	Public property; its type, readonly modifier and optionality are shown in the signature.
`eventIds`	property	`eventIds: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`projection`	property	`projection?: RuntimeOrchestrationProjection`	Public property; its type, readonly modifier and optionality are shown in the signature.

`RuntimeRecoveryScanRequest`

Runtime Recovery Scan Request interface with 3 public fields or methods.

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

Declaration

text

export interface RuntimeRecoveryScanRequest {
    checkedAt: string;
    limit: number;
    cursor?: string;
}

Contract members

Member	Kind	Signature	Description
`checkedAt`	property	`checkedAt: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`cursor`	property	`cursor?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`limit`	property	`limit: number`	Public property; its type, readonly modifier and optionality are shown in the signature.

`RuntimeRecoveryScanResult`

Runtime Recovery Scan Result interface with 3 public fields or methods.

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

Declaration

text

export interface RuntimeRecoveryScanResult {
    candidates: RuntimeRecoveryCandidate[];
    scannedStreams: number;
    nextCursor?: string;
}

Contract members

Member	Kind	Signature	Description
`candidates`	property	`candidates: RuntimeRecoveryCandidate[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`nextCursor`	property	`nextCursor?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`scannedStreams`	property	`scannedStreams: number`	Public property; its type, readonly modifier and optionality are shown in the signature.

`RuntimeRecoveryScope`

Runtime Recovery Scope interface with 3 public fields or methods.

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

Declaration

text

export interface RuntimeRecoveryScope {
    tenantId?: string;
    userId: string;
    runId: string;
}

Contract members

Member	Kind	Signature	Description
`runId`	property	`runId: 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.

`RuntimeActivityCompensationStatus`

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

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

Declaration

text

export type RuntimeActivityCompensationStatus = (typeof RUNTIME_ACTIVITY_COMPENSATION_STATUSES)[number];

`RuntimeActivityReconciliationStatus`

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

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

Declaration

text

export type RuntimeActivityReconciliationStatus = (typeof RUNTIME_ACTIVITY_RECONCILIATION_STATUSES)[number];

`RuntimeRecoveryCandidateReason`

Public type alias for Runtime Recovery Candidate Reason; the declaration contains its complete type expression.

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

Declaration

text

export type RuntimeRecoveryCandidateReason = (typeof RUNTIME_RECOVERY_CANDIDATE_REASONS)[number];

`RuntimeRecoveryDisposition`

Public type alias for Runtime Recovery Disposition; the declaration contains its complete type expression.

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

Declaration

text

export type RuntimeRecoveryDisposition = (typeof RUNTIME_RECOVERY_DISPOSITIONS)[number];

`RuntimeRecoverySafeAction`

Public type alias for Runtime Recovery Safe Action; the declaration contains its complete type expression.

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

Declaration

text

export type RuntimeRecoverySafeAction = (typeof RUNTIME_RECOVERY_SAFE_ACTIONS)[number];

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

Using this module ​

Import from the package entrypoint ​

Usage patterns ​

Public exports ​

RUNTIME_ACTIVITY_COMPENSATION_STATUSES ​

Declaration ​

RUNTIME_ACTIVITY_RECONCILIATION_STATUSES ​

Declaration ​

RUNTIME_RECOVERY_CANDIDATE_REASONS ​

Declaration ​

RUNTIME_RECOVERY_DISPOSITIONS ​

Declaration ​

RUNTIME_RECOVERY_SAFE_ACTIONS ​

Declaration ​

RuntimeActivityCompensationRequest ​

Declaration ​

Contract members ​

RuntimeActivityCompensationResult ​

Declaration ​

Contract members ​

RuntimeActivityReconciliationPort ​

Declaration ​

Contract members ​

RuntimeActivityReconciliationRequest ​

Declaration ​

Contract members ​

RuntimeActivityReconciliationResult ​

Declaration ​

Contract members ​

RuntimeActivityRetryRequest ​

Declaration ​

Contract members ​

RuntimeCancellationRecoveryPort ​

Declaration ​

Contract members ​

RuntimeRecoveryCandidate ​

Declaration ​

Contract members ​

RuntimeRecoveryCommand ​

Declaration ​

Contract members ​

RuntimeRecoveryRequeuePort ​

Declaration ​

Contract members ​

RuntimeRecoveryRequeueRequest ​

Declaration ​

Contract members ​

RuntimeRecoveryResult ​

Declaration ​

Contract members ​

RuntimeRecoveryScanRequest ​

Declaration ​

Contract members ​

RuntimeRecoveryScanResult ​

Declaration ​

Contract members ​

RuntimeRecoveryScope ​

Declaration ​

Contract members ​

RuntimeActivityCompensationStatus ​

Declaration ​

RuntimeActivityReconciliationStatus ​

Declaration ​

RuntimeRecoveryCandidateReason ​

Declaration ​

RuntimeRecoveryDisposition ​

Declaration ​

RuntimeRecoverySafeAction ​

Declaration ​

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

Using this module

Import from the package entrypoint

Usage patterns

Public exports

`RUNTIME_ACTIVITY_COMPENSATION_STATUSES`

Declaration

`RUNTIME_ACTIVITY_RECONCILIATION_STATUSES`

Declaration

`RUNTIME_RECOVERY_CANDIDATE_REASONS`

Declaration

`RUNTIME_RECOVERY_DISPOSITIONS`

Declaration

`RUNTIME_RECOVERY_SAFE_ACTIONS`

Declaration

`RuntimeActivityCompensationRequest`

Declaration

Contract members

`RuntimeActivityCompensationResult`

Declaration

Contract members

`RuntimeActivityReconciliationPort`

Declaration

Contract members

`RuntimeActivityReconciliationRequest`

Declaration

Contract members

`RuntimeActivityReconciliationResult`

Declaration

Contract members

`RuntimeActivityRetryRequest`

Declaration

Contract members

`RuntimeCancellationRecoveryPort`

Declaration

Contract members

`RuntimeRecoveryCandidate`

Declaration

Contract members

`RuntimeRecoveryCommand`

Declaration

Contract members

`RuntimeRecoveryRequeuePort`

Declaration

Contract members

`RuntimeRecoveryRequeueRequest`

Declaration

Contract members

`RuntimeRecoveryResult`

Declaration

Contract members

`RuntimeRecoveryScanRequest`

Declaration

Contract members

`RuntimeRecoveryScanResult`

Declaration

Contract members

`RuntimeRecoveryScope`

Declaration

Contract members

`RuntimeActivityCompensationStatus`

Declaration

`RuntimeActivityReconciliationStatus`

Declaration

`RuntimeRecoveryCandidateReason`

Declaration

`RuntimeRecoveryDisposition`

Declaration

`RuntimeRecoverySafeAction`

Declaration