@codesoul-co/hypha-core / modules/runtime/runtime-activity-helper

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

Using this module

Use the Runtime activity helper module for executing runtime behavior at this boundary. It exports 2 classes, 1 interface.

Import from the package entrypoint

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

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

Usage patterns

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

Public exports

Symbol	Kind	Signature	Description
DefaultRuntimeActivityHelper	class	new DefaultRuntimeActivityHelper(options: DefaultRuntimeActivityHelperOptions): DefaultRuntimeActivityHelper	Default Runtime Activity Helper class with 6 public constructor or member entries; its exact declarations are listed below.
RuntimeEventActivityLifecycleCommitPort	class	new RuntimeEventActivityLifecycleCommitPort(events: RuntimeEventCommitPort): RuntimeEventActivityLifecycleCommitPort	Runtime Event Activity Lifecycle Commit Port class with 2 public constructor or member entries; its exact declarations are listed below.
DefaultRuntimeActivityHelperOptions	interface	interface DefaultRuntimeActivityHelperOptions	Default Runtime Activity Helper Options interface with 6 public fields or methods.

DefaultRuntimeActivityHelper

Default Runtime Activity Helper class with 6 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { DefaultRuntimeActivityHelper } from '@codesoul-co/hypha-core';
• Source module: modules/runtime/runtime-activity-helper

Declaration

export declare class DefaultRuntimeActivityHelper implements RuntimeActivityHelper {
    constructor(options: DefaultRuntimeActivityHelperOptions);
    tool(request: RuntimeActivityRequest): Promise<RuntimeActivityObservation>;
    memory(request: RuntimeActivityRequest): Promise<RuntimeActivityObservation>;
    model(request: RuntimeActivityRequest): Promise<RuntimeActivityObservation>;
    execution(request: RuntimeActivityRequest): Promise<RuntimeActivityObservation>;
    custom(request: RuntimeActivityRequest): Promise<RuntimeActivityObservation>;
}

Public members

Member	Kind	Signature	Description
constructor	constructor	(options: DefaultRuntimeActivityHelperOptions): DefaultRuntimeActivityHelper	Creates an instance of this class.
custom	method	custom(request: RuntimeActivityRequest): Promise<RuntimeActivityObservation>	Public method; parameters and return type are shown in the signature.
execution	method	execution(request: RuntimeActivityRequest): Promise<RuntimeActivityObservation>	Public method; parameters and return type are shown in the signature.
memory	method	memory(request: RuntimeActivityRequest): Promise<RuntimeActivityObservation>	Public method; parameters and return type are shown in the signature.
model	method	model(request: RuntimeActivityRequest): Promise<RuntimeActivityObservation>	Public method; parameters and return type are shown in the signature.
tool	method	tool(request: RuntimeActivityRequest): Promise<RuntimeActivityObservation>	Public method; parameters and return type are shown in the signature.

RuntimeEventActivityLifecycleCommitPort

Runtime Event Activity Lifecycle Commit Port class with 2 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { RuntimeEventActivityLifecycleCommitPort } from '@codesoul-co/hypha-core';
• Source module: modules/runtime/runtime-activity-helper

Declaration

export declare class RuntimeEventActivityLifecycleCommitPort implements RuntimeActivityLifecycleCommitPort {
    constructor(events: RuntimeEventCommitPort);
    append(request: RuntimeActivityLifecycleCommitRequest): Promise<FrameworkEvent>;
}

Public members

Member	Kind	Signature	Description
append	method	append(request: RuntimeActivityLifecycleCommitRequest): Promise<FrameworkEvent>	Public method; parameters and return type are shown in the signature.
constructor	constructor	(events: RuntimeEventCommitPort): RuntimeEventActivityLifecycleCommitPort	Creates an instance of this class.

DefaultRuntimeActivityHelperOptions

Default Runtime Activity Helper Options interface with 6 public fields or methods.

• Kind: interface
• Import: import type { DefaultRuntimeActivityHelperOptions } from '@codesoul-co/hypha-core';
• Source module: modules/runtime/runtime-activity-helper

Declaration

export interface DefaultRuntimeActivityHelperOptions {
    execution: RuntimeHelperExecutionScope;
    ids: RuntimeIdHelper;
    clock: {
        now(): Promise<string>;
    };
    dispatch: RuntimeActivityDispatchPort;
    lifecycle: RuntimeActivityLifecycleCommitPort;
    abortSignal: AbortSignal;
}

Contract members

Member	Kind	Signature	Description
abortSignal	property	abortSignal: AbortSignal	Public property; its type, readonly modifier and optionality are shown in the signature.
clock	property	clock: { now(): Promise<string>; }	Public property; its type, readonly modifier and optionality are shown in the signature.
dispatch	property	dispatch: RuntimeActivityDispatchPort	Public property; its type, readonly modifier and optionality are shown in the signature.
execution	property	execution: RuntimeHelperExecutionScope	Public property; its type, readonly modifier and optionality are shown in the signature.
ids	property	ids: RuntimeIdHelper	Public property; its type, readonly modifier and optionality are shown in the signature.
lifecycle	property	lifecycle: RuntimeActivityLifecycleCommitPort	Public property; its type, readonly modifier and optionality are shown in the signature.