@codesoul-co/hypha-core / modules/runtime/runtime-recovery-service

• Package index: @codesoul-co/hypha-core
• Source: packages/core/src/modules/runtime/runtime-recovery-service.ts
• Exports: 3

Using this module

Use the Runtime recovery service module for executing runtime behavior at this boundary. It exports 1 class, 2 interfaces.

Import from the package entrypoint

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

import type {
  RuntimeActivityRedispatchRecoveryPort,
  RuntimeRecoveryServiceOptions,
} from '@codesoul-co/hypha-core';

Usage patterns

• Use the 2 type/interface exports as static contracts in application code, adapters, or tests. Import them with import type; they do not exist at runtime.
• The module exposes 1 class as constructable runtime implementations. Each symbol entry lists its constructor and public methods.

Public exports

Symbol	Kind	Signature	Description
RuntimeRecoveryService	class	new RuntimeRecoveryService(options: RuntimeRecoveryServiceOptions): RuntimeRecoveryService	Runtime Recovery Service class with 3 public constructor or member entries; its exact declarations are listed below.
RuntimeActivityRedispatchRecoveryPort	interface	interface RuntimeActivityRedispatchRecoveryPort	Runtime Activity Redispatch Recovery Port interface with 1 public fields or methods.
RuntimeRecoveryServiceOptions	interface	interface RuntimeRecoveryServiceOptions	Runtime Recovery Service Options interface with 11 public fields or methods.

RuntimeRecoveryService

Runtime Recovery Service class with 3 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { RuntimeRecoveryService } from '@codesoul-co/hypha-core';
• Source module: modules/runtime/runtime-recovery-service

Declaration

export declare class RuntimeRecoveryService {
    constructor(options: RuntimeRecoveryServiceOptions);
    scan(input: RuntimeRecoveryScanRequest): Promise<RuntimeRecoveryScanResult>;
    recover(input: RuntimeRecoveryCommand): Promise<RuntimeRecoveryResult>;
}

Public members

Member	Kind	Signature	Description
constructor	constructor	(options: RuntimeRecoveryServiceOptions): RuntimeRecoveryService	Creates an instance of this class.
recover	method	recover(input: RuntimeRecoveryCommand): Promise<RuntimeRecoveryResult>	Public method; parameters and return type are shown in the signature.
scan	method	scan(input: RuntimeRecoveryScanRequest): Promise<RuntimeRecoveryScanResult>	Public method; parameters and return type are shown in the signature.

RuntimeActivityRedispatchRecoveryPort

Runtime Activity Redispatch Recovery Port interface with 1 public fields or methods.

• Kind: interface
• Import: import type { RuntimeActivityRedispatchRecoveryPort } from '@codesoul-co/hypha-core';
• Source module: modules/runtime/runtime-recovery-service

Declaration

export interface RuntimeActivityRedispatchRecoveryPort {
    redispatch(command: RuntimeActivityRedispatchCommand): Promise<RuntimeActivityRedispatchResult>;
}

Contract members

Member	Kind	Signature	Description
redispatch	method	redispatch(command: RuntimeActivityRedispatchCommand): Promise<RuntimeActivityRedispatchResult>	Public method; parameters and return type are shown in the signature.

RuntimeRecoveryServiceOptions

Runtime Recovery Service Options interface with 11 public fields or methods.

• Kind: interface
• Import: import type { RuntimeRecoveryServiceOptions } from '@codesoul-co/hypha-core';
• Source module: modules/runtime/runtime-recovery-service

Declaration

export interface RuntimeRecoveryServiceOptions {
    events: EventRuntime;
    projections: ProjectionEngine;
    projectionStore: ProjectionStore<RuntimeOrchestrationProjection>;
    runLeases: RunLeaseStore;
    stateClaims: StateExecutionClaimStore;
    activities: RuntimeActivityReconciliationPort;
    redispatches: RuntimeActivityRedispatchRecoveryPort;
    cancellations: RuntimeCancellationRecoveryPort;
    requeue: RuntimeRecoveryRequeuePort;
    now?: () => string;
    nextId?: (namespace: string) => string;
}

Contract members

Member	Kind	Signature	Description
activities	property	activities: RuntimeActivityReconciliationPort	Public property; its type, readonly modifier and optionality are shown in the signature.
cancellations	property	cancellations: RuntimeCancellationRecoveryPort	Public property; its type, readonly modifier and optionality are shown in the signature.
events	property	events: EventRuntime	Public property; its type, readonly modifier and optionality are shown in the signature.
nextId	method	nextId?(namespace: string): string	Public method; parameters and return type are shown in the signature.
now	method	now?(): string	Public method; parameters and return type are shown in the signature.
projections	property	projections: ProjectionEngine	Public property; its type, readonly modifier and optionality are shown in the signature.
projectionStore	property	projectionStore: ProjectionStore<RuntimeOrchestrationProjection>	Public property; its type, readonly modifier and optionality are shown in the signature.
redispatches	property	redispatches: RuntimeActivityRedispatchRecoveryPort	Public property; its type, readonly modifier and optionality are shown in the signature.
requeue	property	requeue: RuntimeRecoveryRequeuePort	Public property; its type, readonly modifier and optionality are shown in the signature.
runLeases	property	runLeases: RunLeaseStore	Public property; its type, readonly modifier and optionality are shown in the signature.
stateClaims	property	stateClaims: StateExecutionClaimStore	Public property; its type, readonly modifier and optionality are shown in the signature.