`@codesoul-co/hypha-core` / `events`

Package index: @codesoul-co/hypha-core
Source: packages/core/src/events.ts
Exports: 11

Using this module

Use the Events module for creating, recording, or reading Event contracts. It exports 1 class, 1 function, 6 interfaces, 3 types.

Import from the package entrypoint

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

import type {
  EventCreateInput,
  EventFilter,
  EventStore,
  FrameworkEvent,
  PersistedFrameworkEvent,
  TraceRecorder,
  FrameworkEventType,
  RuntimeActivityEventType,
} from '@codesoul-co/hypha-core';

// The complete export list is documented below.

Usage patterns

Use the 9 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.
The module exposes 1 function as direct operation entrypoints. Every overload, required/optional parameter, and return type is documented below.

Public exports

Symbol	Kind	Signature	Description
`InMemoryEventStore`	class	`new InMemoryEventStore(): InMemoryEventStore`	In Memory Event Store class with 4 public constructor or member entries; its exact declarations are listed below.
`createFrameworkEvent`	function	`createFrameworkEvent<TPayload = unknown>(input: EventCreateInput<TPayload>): FrameworkEvent<TPayload>`	Create Framework Event function with 1 public call signature; parameters and return types are listed below.
`EventCreateInput`	interface	`interface EventCreateInput`	Event Create Input interface with 20 public fields or methods.
`EventFilter`	interface	`interface EventFilter`	Event Filter interface with 6 public fields or methods.
`EventStore`	interface	`interface EventStore`	Event Store interface with 2 public fields or methods.
`FrameworkEvent`	interface	`interface FrameworkEvent`	Framework Event interface with 24 public fields or methods.
`PersistedFrameworkEvent`	interface	`interface PersistedFrameworkEvent extends FrameworkEvent<TPayload>`	Persisted Framework Event interface with 24 public fields or methods.
`TraceRecorder`	interface	`interface TraceRecorder`	Trace Recorder interface with 1 public fields or methods.
`FrameworkEventType`	type	`type FrameworkEventType = 'session.created' \| 'session.updated' \| 'session.closed' \| 'run.created' \| 'run.started' \| 'run.resume.requested' \| 'run.resumed' \| 'run.cancel.requested' \| 'run.cancelling' \| 'run.waiting_human' \| 'run.waiting_signal' \| 'run.waiting_timer' \| 'run.paused' \| 'run.completed' \| 'run.failed' \| 'run.cancelled' \| 'runtime.wait.created' \| 'runtime.wait.resolved' \| 'runtime.signal.received' \| 'ru...`	Public type alias for Framework Event Type; the declaration contains its complete type expression.
`RuntimeActivityEventType`	type	`type RuntimeActivityEventType = 'runtime.activity.requested' \| 'runtime.activity.completed' \| 'runtime.activity.failed' \| 'runtime.activity.waiting' \| 'runtime.activity.cancelled' \| 'runtime.activity.compensation.requested' \| 'runtime.activity.compensation.completed' \| 'runtime.activity.compensation.failed' \| 'activity.redispatch.requested' \| 'activity.redispatch.accepted' \| 'activity.redispatch.outcome_unknown'`	Public type alias for Runtime Activity Event Type; the declaration contains its complete type expression.
`RuntimeObservationEventType`	type	`type RuntimeObservationEventType = runtime.observation.${string}`	Public type alias for Runtime Observation Event Type; the declaration contains its complete type expression.

`InMemoryEventStore`

In Memory Event Store class with 4 public constructor or member entries; its exact declarations are listed below.

Kind: class
Import: import { InMemoryEventStore } from '@codesoul-co/hypha-core';
Source module: events

Declaration

text

export declare class InMemoryEventStore implements EventStore, TraceRecorder {
    append(event: FrameworkEvent): Promise<void>;
    record(event: FrameworkEvent): Promise<void>;
    list(filter?: EventFilter): Promise<FrameworkEvent[]>;
}

Public members

Member	Kind	Signature	Description
`append`	method	`append(event: FrameworkEvent): Promise<void>`	Public method; parameters and return type are shown in the signature.
`constructor`	constructor	`(): InMemoryEventStore`	Creates an instance of this class.
`list`	method	`list(filter?: EventFilter): Promise<FrameworkEvent[]>`	Public method; parameters and return type are shown in the signature.
`record`	method	`record(event: FrameworkEvent): Promise<void>`	Public method; parameters and return type are shown in the signature.

`createFrameworkEvent`

Create Framework Event function with 1 public call signature; parameters and return types are listed below.

Kind: function
Import: import { createFrameworkEvent } from '@codesoul-co/hypha-core';
Source module: events

Declaration

text

export declare function createFrameworkEvent<TPayload = unknown>(input: EventCreateInput<TPayload>): FrameworkEvent<TPayload>;

Call signature

text

createFrameworkEvent<TPayload = unknown>(input: EventCreateInput<TPayload>): FrameworkEvent<TPayload>

Parameters

Parameter	Type	Required	Description
`input`	`EventCreateInput<TPayload>`	Yes	Required parameter; accepted values are defined by the type column.

Returns

Type: FrameworkEvent<TPayload>
Description: The return contract is defined by the type shown above.

`EventCreateInput`

Event Create Input interface with 20 public fields or methods.

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

Declaration

text

export interface EventCreateInput<TPayload = unknown> {
    id: string;
    type: FrameworkEventType;
    version?: string;
    tenantId?: string;
    userId?: string;
    runId: string;
    payload: TPayload;
    workspaceId?: string;
    sessionId?: string;
    stepId?: string;
    agentId?: string;
    fsmState?: string;
    branchId?: string;
    correlationId?: string;
    causationId?: string;
    parentEventId?: string;
    idempotencyKey?: string;
    operationId?: string;
    timestamp?: 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.
`branchId`	property	`branchId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`causationId`	property	`causationId?: 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.
`fsmState`	property	`fsmState?: 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.
`idempotencyKey`	property	`idempotencyKey?: 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.
`operationId`	property	`operationId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`parentEventId`	property	`parentEventId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`payload`	property	`payload: TPayload`	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.
`stepId`	property	`stepId?: 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.
`timestamp`	property	`timestamp?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`type`	property	`type: FrameworkEventType`	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.
`version`	property	`version?: 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.

`EventFilter`

Event Filter interface with 6 public fields or methods.

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

Declaration

text

export interface EventFilter {
    tenantId?: string;
    userId?: string;
    workspaceId?: string;
    sessionId?: string;
    runId?: string;
    type?: FrameworkEventType;
}

Contract members

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

`EventStore`

Event Store interface with 2 public fields or methods.

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

Declaration

text

export interface EventStore {
    append(event: FrameworkEvent): Promise<void>;
    list(filter?: EventFilter): Promise<FrameworkEvent[]>;
}

Contract members

Member	Kind	Signature	Description
`append`	method	`append(event: FrameworkEvent): Promise<void>`	Public method; parameters and return type are shown in the signature.
`list`	method	`list(filter?: EventFilter): Promise<FrameworkEvent[]>`	Public method; parameters and return type are shown in the signature.

`FrameworkEvent`

Framework Event interface with 24 public fields or methods.

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

Declaration

text

export interface FrameworkEvent<TPayload = unknown> {
    id: string;
    type: FrameworkEventType;
    version?: string;
    tenantId?: string;
    userId?: string;
    workspaceId?: string;
    sessionId?: string;
    runId: string;
    stepId?: string;
    agentId?: string;
    fsmState?: string;
    branchId?: string;
    sequence?: number;
    globalSequence?: number;
    correlationId?: string;
    causationId?: string;
    parentEventId?: string;
    idempotencyKey?: string;
    operationId?: string;
    timestamp: string;
    recordedAt?: string;
    payload: TPayload;
    payloadHash?: 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.
`branchId`	property	`branchId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`causationId`	property	`causationId?: 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.
`fsmState`	property	`fsmState?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`globalSequence`	property	`globalSequence?: number`	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.
`metadata`	property	`metadata?: Record<string, unknown>`	Public property; its type, readonly modifier and optionality are shown in the signature.
`operationId`	property	`operationId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`parentEventId`	property	`parentEventId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`payload`	property	`payload: TPayload`	Public property; its type, readonly modifier and optionality are shown in the signature.
`payloadHash`	property	`payloadHash?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`recordedAt`	property	`recordedAt?: 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.
`sequence`	property	`sequence?: number`	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.
`stepId`	property	`stepId?: 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.
`timestamp`	property	`timestamp: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`type`	property	`type: FrameworkEventType`	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.
`version`	property	`version?: 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.

`PersistedFrameworkEvent`

Persisted Framework Event interface with 24 public fields or methods.

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

Declaration

text

export interface PersistedFrameworkEvent<TPayload = unknown> extends FrameworkEvent<TPayload> {
    version: string;
    userId: string;
    sequence: number;
    globalSequence: number;
    recordedAt: string;
    payloadHash: string;
}

Contract members

Member	Kind	Signature	Description
`agentId`	property	`agentId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`branchId`	property	`branchId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`causationId`	property	`causationId?: 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.
`fsmState`	property	`fsmState?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`globalSequence`	property	`globalSequence: number`	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.
`metadata`	property	`metadata?: Record<string, unknown>`	Public property; its type, readonly modifier and optionality are shown in the signature.
`operationId`	property	`operationId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`parentEventId`	property	`parentEventId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`payload`	property	`payload: TPayload`	Public property; its type, readonly modifier and optionality are shown in the signature.
`payloadHash`	property	`payloadHash: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`recordedAt`	property	`recordedAt: 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.
`sequence`	property	`sequence: number`	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.
`stepId`	property	`stepId?: 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.
`timestamp`	property	`timestamp: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`type`	property	`type: FrameworkEventType`	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.
`version`	property	`version: 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.

`TraceRecorder`

Trace Recorder interface with 1 public fields or methods.

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

Declaration

text

export interface TraceRecorder {
    record(event: FrameworkEvent): Promise<void>;
}

Contract members

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

`FrameworkEventType`

Public type alias for Framework Event Type; the declaration contains its complete type expression.

Kind: type
Import: import type { FrameworkEventType } from '@codesoul-co/hypha-core';
Source module: events

Declaration

text

export type FrameworkEventType = 'session.created' | 'session.updated' | 'session.closed' | 'run.created' | 'run.started' | 'run.resume.requested' | 'run.resumed' | 'run.cancel.requested' | 'run.cancelling' | 'run.waiting_human' | 'run.waiting_signal' | 'run.waiting_timer' | 'run.paused' | 'run.completed' | 'run.failed' | 'run.cancelled' | 'runtime.wait.created' | 'runtime.wait.resolved' | 'runtime.signal.received' | 'runtime.timer.created' | 'runtime.timer.fired' | 'runtime.checkpoint.created' | 'runtime.checkpoint.failed' | 'runtime.cancellation.propagated' | 'runtime.cancellation.failed' | 'recovery.case.opened' | 'recovery.strategy.selected' | 'recovery.attempt.started' | 'recovery.attempt.completed' | 'recovery.progress.detected' | 'recovery.case.resolved' | 'recovery.case.escalated' | 'recovery.knowledge.invalidated' | 'fsm.transition.requested' | 'fsm.transition.accepted' | 'fsm.transition.rejected' | 'fsm.state.entered' | 'fsm.state.exited' | 'thinking.started' | 'thinking.completed' | 'agent.deliberation.started' | 'agent.deliberation.completed' | 'reasoning.decision.recorded' | 'agent.reasoning.started' | 'agent.reasoning.completed' | 'agent.action.selected' | 'react.step.completed' | 'react.continuation.checkpointed' | 'react.continuation.suspended' | 'react.continuation.resumed' | 'inference.requested' | 'inference.completed' | 'inference.failed' | 'model.call.started' | 'model.call.completed' | 'model.call.failed' | 'llm.cache.lookup' | 'llm.cache.hit' | 'llm.cache.miss' | 'llm.cache.write' | 'llm.cache.bypass' | 'workcache.lookup' | 'workcache.hit' | 'workcache.miss' | 'workcache.write' | 'workcache.invalidate' | 'workcache.bypass' | 'workcache.prefix.materialized' | 'tool.call.requested' | 'tool.authorization.checked' | 'tool.invocation.state.changed' | 'tool.policy.checked' | 'tool.call.approved' | 'tool.call.rejected' | 'tool.call.started' | 'tool.call.completed' | 'tool.call.failed' | 'tool.call.timeout' | 'tool.call.retrying' | 'tool.call.cancellation.requested' | 'tool.call.cancelled' | 'tool.call.late_result' | 'tool.output.validated' | 'tool.output.invalid' | 'tool.resolved' | 'tool.contract.snapshot.created' | 'tool.contract.snapshot.resolved' | 'tool.idempotency.reused' | 'tool.idempotency.conflict' | 'tool.external_receipt.reconciled' | 'tool.cache.lookup' | 'tool.cache.hit' | 'tool.cache.miss' | 'tool.cache.write' | 'tool.cache.bypass' | 'mcp.capability.discovered' | 'mcp.capability.trust.evaluated' | 'mcp.capability.drift.detected' | 'mcp.capability.quarantined' | 'mcp.catalog.updated' | 'mcp.server.state.changed' | 'mcp.connection.starting' | 'mcp.connection.initialized' | 'mcp.connection.ready' | 'mcp.connection.degraded' | 'mcp.connection.reconnecting' | 'mcp.connection.closed' | 'mcp.connection.failed' | 'mcp.capability.discovery.started' | 'mcp.capability.normalized' | 'mcp.capability.imported' | 'mcp.capability.removed' | 'mcp.capability.approved' | 'mcp.catalog.refreshed' | 'mcp.request.started' | 'mcp.request.cancelled' | 'mcp.request.completed' | 'mcp.request.failed' | 'mcp.tool.normalized' | 'mcp.resource.normalized' | 'mcp.call.started' | 'mcp.call.completed' | 'mcp.call.failed' | 'tool.target.resolved' | 'tool.preview.generated' | 'tool.progress.reported' | 'skill.selected' | 'skill.loaded' | 'skill.executed' | 'skill.completed' | 'skill.failed' | 'workflow.stage.started' | 'workflow.stage.completed' | 'workflow.stage.failed' | 'workflow.condition.evaluated' | 'memory.extraction.requested' | 'memory.extraction.queued' | 'memory.extraction.started' | 'memory.extraction.candidate.extracted' | 'memory.extraction.candidate.rejected' | 'memory.extraction.awaiting_review' | 'memory.extraction.completed' | 'memory.extraction.failed' | 'memory.extraction.cancelled' | 'memory.extraction.cursor.advanced' | 'memory.maintenance.lookup.started' | 'memory.maintenance.lookup.completed' | 'memory.maintenance.decision.planned' | 'memory.maintenance.decision.applied' | 'memory.maintenance.decision.conflict' | 'memory.maintenance.review.requested' | 'memory.retrieval.candidates.generated' | 'memory.retrieval.ranking.completed' | 'memory.retrieval.rerank.failed' | 'memory.activity.requested' | 'memory.activity.completed' | 'memory.activity.failed' | 'memory.activity.cancelled' | 'memory.search.requested' | 'memory.search.completed' | 'memory.search.failed' | 'memory.write.reused' | 'memory.write.failed' | 'memory.update.requested' | 'memory.update.committed' | 'memory.update.conflict' | 'memory.update.failed' | 'memory.delete.requested' | 'memory.delete.partial' | 'memory.delete.completed' | 'memory.delete.failed' | 'memory.index.requested' | 'memory.index.started' | 'memory.index.completed' | 'memory.index.partial' | 'memory.index.failed' | 'memory.consolidation.started' | 'memory.consolidation.completed' | 'memory.consolidation.failed' | 'memory.decay.evaluated' | 'memory.reinforced' | 'memory.superseded' | 'memory.invalidated' | 'memory.retention.expired' | 'memory.context.build.requested' | 'memory.context.source.collected' | 'memory.context.item.filtered' | 'memory.context.item.ranked' | 'memory.context.item.truncated' | 'memory.context.item.compacted' | 'memory.context.provenance.attached' | 'memory.context.build.completed' | 'memory.context.build.failed' | 'context.source.loaded' | 'context.item.selected' | 'context.item.rejected' | 'context.build.failed' | 'memory.worker.started' | 'memory.worker.stopped' | 'memory.worker.failed' | 'memory.worker.dead_lettered' | 'memory.read.requested' | 'memory.read.completed' | 'memory.read.failed' | 'memory.write.requested' | 'memory.write.validated' | 'memory.write.committed' | 'memory.write.rejected' | 'context.build.started' | 'context.build.completed' | 'context.compacted' | 'react.continuation.quarantined' | 'human.review.requested' | 'human.review.approved' | 'human.review.rejected' | 'human.review.expired' | 'human.review.cancelled' | 'human.review.superseded' | 'human.review.resume.started' | 'human.review.resume.revalidated' | 'human.review.resume.failed' | 'human.review.resolved' | 'message.enqueued' | 'message.delivered' | 'message.acknowledged' | 'message.failed' | 'message.retrying' | 'message.dead_lettered' | 'eval.started' | 'eval.completed' | 'eval.failed' | 'replay.started' | 'replay.completed' | 'replay.failed' | 'regression.started' | 'regression.completed' | 'regression.failed' | 'workspace.create.requested' | 'workspace.created' | 'workspace.ready' | 'workspace.busy' | 'workspace.path.resolved' | 'workspace.path.denied' | 'workspace.quota.exceeded' | 'workspace.snapshot.requested' | 'workspace.snapshot.created' | 'workspace.snapshot.failed' | 'workspace.restore.requested' | 'workspace.restored' | 'workspace.restore.failed' | 'workspace.patch.checked' | 'workspace.patch.applied' | 'workspace.patch.conflict' | 'workspace.cleanup.started' | 'workspace.cleanup.completed' | 'workspace.cleanup.failed' | 'sandbox.create.requested' | 'sandbox.created' | 'sandbox.started' | 'sandbox.ready' | 'sandbox.degraded' | 'sandbox.terminate.requested' | 'sandbox.terminated' | 'sandbox.cleanup.completed' | 'sandbox.cleanup.failed' | 'command.execution.requested' | 'command.execution.validated' | 'command.execution.approval.required' | 'command.execution.queued' | 'command.execution.started' | 'command.execution.output.truncated' | 'command.execution.resource.exceeded' | 'command.execution.oom_killed' | 'command.execution.timeout' | 'command.execution.cancellation.requested' | 'command.execution.cancelled' | 'command.execution.completed' | 'command.execution.failed' | 'command.execution.result.unknown' | 'command.execution.recovered' | 'network.authorization.requested' | 'network.authorization.granted' | 'network.authorization.denied' | 'network.authorization.revoked' | 'artifact.create.requested' | 'artifact.created' | 'artifact.deduplicated' | 'artifact.create.failed' | 'artifact.read.requested' | 'artifact.read.completed' | 'artifact.version.created' | 'artifact.finalized' | 'artifact.archived' | 'artifact.invalidated' | 'artifact.delete.requested' | 'artifact.delete.blocked' | 'artifact.deleted' | 'artifact.delete.failed' | 'artifact.lineage.recorded' | 'artifact.retention.expired' | 'artifact.gc.completed' | 'artifact.gc.failed'
/** @deprecated Use the explicit Artifact lifecycle event names. */
 | 'artifact.updated'
/** @deprecated Use artifact.version.created. */
 | 'artifact.versioned' | RuntimeObservationEventType | RuntimeActivityEventType;

`RuntimeActivityEventType`

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

Kind: type
Import: import type { RuntimeActivityEventType } from '@codesoul-co/hypha-core';
Source module: events

Declaration

text

export type RuntimeActivityEventType = 'runtime.activity.requested' | 'runtime.activity.completed' | 'runtime.activity.failed' | 'runtime.activity.waiting' | 'runtime.activity.cancelled' | 'runtime.activity.compensation.requested' | 'runtime.activity.compensation.completed' | 'runtime.activity.compensation.failed' | 'activity.redispatch.requested' | 'activity.redispatch.accepted' | 'activity.redispatch.outcome_unknown';

`RuntimeObservationEventType`

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

Kind: type
Import: import type { RuntimeObservationEventType } from '@codesoul-co/hypha-core';
Source module: events

Declaration

text

export type RuntimeObservationEventType = `runtime.observation.${string}`;

@codesoul-co/hypha-core / events ​

Using this module ​

Import from the package entrypoint ​

Usage patterns ​

Public exports ​

InMemoryEventStore ​

Declaration ​

Public members ​

createFrameworkEvent ​

Declaration ​

Call signature ​

Parameters ​

Returns ​

EventCreateInput ​

Declaration ​

Contract members ​

EventFilter ​

Declaration ​

Contract members ​

EventStore ​

Declaration ​

Contract members ​

FrameworkEvent ​

Declaration ​

Contract members ​

PersistedFrameworkEvent ​

Declaration ​

Contract members ​

TraceRecorder ​

Declaration ​

Contract members ​

FrameworkEventType ​

Declaration ​

RuntimeActivityEventType ​

Declaration ​

RuntimeObservationEventType ​

Declaration ​

`@codesoul-co/hypha-core` / `events`

Using this module

Import from the package entrypoint

Usage patterns

Public exports

`InMemoryEventStore`

Declaration

Public members

`createFrameworkEvent`

Declaration

Call signature

Parameters

Returns

`EventCreateInput`

Declaration

Contract members

`EventFilter`

Declaration

Contract members

`EventStore`

Declaration

Contract members

`FrameworkEvent`

Declaration

Contract members

`PersistedFrameworkEvent`

Declaration

Contract members

`TraceRecorder`

Declaration

Contract members

`FrameworkEventType`

Declaration

`RuntimeActivityEventType`

Declaration

`RuntimeObservationEventType`

Declaration