@codesoul-co/hypha-adapters-local / runtime-event-store

• Package index: @codesoul-co/hypha-adapters-local
• Source: packages/adapters-local/src/runtime-event-store.ts
• Exports: 3

Using this module

Use the Runtime event store module for creating, recording, or reading Event contracts. It exports 1 class, 2 interfaces.

Import from the package entrypoint

import {
  SQLiteDurableEventStore,
} from '@codesoul-co/hypha-adapters-local';

import type {
  SQLiteDurableEventStoreOptions,
  SQLiteImportedEventResetResult,
} from '@codesoul-co/hypha-adapters-local';

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
SQLiteDurableEventStore	class	new SQLiteDurableEventStore(options: SQLiteDurableEventStoreOptions): SQLiteDurableEventStore	SQLite Durable Event Store class with 10 public constructor or member entries; its exact declarations are listed below.
SQLiteDurableEventStoreOptions	interface	interface SQLiteDurableEventStoreOptions	SQLite Durable Event Store Options interface with 3 public fields or methods.
SQLiteImportedEventResetResult	interface	interface SQLiteImportedEventResetResult	SQLite Imported Event Reset Result interface with 3 public fields or methods.

SQLiteDurableEventStore

SQLite Durable Event Store class with 10 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { SQLiteDurableEventStore } from '@codesoul-co/hypha-adapters-local';
• Source module: runtime-event-store

Declaration

export declare class SQLiteDurableEventStore implements DurableEventStore, CanonicalEventScanPort {
    constructor(options: SQLiteDurableEventStoreOptions);
    append(request: EventAppendRequest): Promise<EventAppendResult>;
    readStream(scope: EventStreamScope, fromSequence?: number): Promise<PersistedFrameworkEvent[]>;
    readById(scope: EventStreamScope, eventId: string): Promise<PersistedFrameworkEvent | null>;
    getStreamHead(scope: EventStreamScope): Promise<EventStreamHead | null>;
    listStreamHeads(request?: ListEventStreamHeadsRequest): Promise<ListEventStreamHeadsResult>;
    health(): Promise<ProviderHealth>;
    resetUnauditedImportedEvents(): Promise<SQLiteImportedEventResetResult>;
    scanCanonicalEvents(request: ScanCanonicalEventsRequest): Promise<ScanCanonicalEventsResult>;
    close(): void;
}

Public members

Member	Kind	Signature	Description
append	method	append(request: EventAppendRequest): Promise<EventAppendResult>	Public method; parameters and return type are shown in the signature.
close	method	close(): void	Public method; parameters and return type are shown in the signature.
constructor	constructor	(options: SQLiteDurableEventStoreOptions): SQLiteDurableEventStore	Creates an instance of this class.
getStreamHead	method	getStreamHead(scope: EventStreamScope): Promise<EventStreamHead | null>	Public method; parameters and return type are shown in the signature.
health	method	health(): Promise<ProviderHealth>	Public method; parameters and return type are shown in the signature.
listStreamHeads	method	listStreamHeads(request?: ListEventStreamHeadsRequest): Promise<ListEventStreamHeadsResult>	Public method; parameters and return type are shown in the signature.
readById	method	readById(scope: EventStreamScope, eventId: string): Promise<PersistedFrameworkEvent | null>	Public method; parameters and return type are shown in the signature.
readStream	method	readStream(scope: EventStreamScope, fromSequence?: number): Promise<PersistedFrameworkEvent[]>	Public method; parameters and return type are shown in the signature.
resetUnauditedImportedEvents	method	resetUnauditedImportedEvents(): Promise<SQLiteImportedEventResetResult>	Clears only an incomplete compatibility import. A successful integrity watermark or any live/non-imported Event makes the operation fail closed.
scanCanonicalEvents	method	scanCanonicalEvents(request: ScanCanonicalEventsRequest): Promise<ScanCanonicalEventsResult>	Public method; parameters and return type are shown in the signature.

SQLiteDurableEventStoreOptions

SQLite Durable Event Store Options interface with 3 public fields or methods.

• Kind: interface
• Import: import type { SQLiteDurableEventStoreOptions } from '@codesoul-co/hypha-adapters-local';
• Source module: runtime-event-store

Declaration

export interface SQLiteDurableEventStoreOptions {
    filename: string;
    schemaRegistry: EventSchemaRegistry;
    now?: () => string;
}

Contract members

Member	Kind	Signature	Description
filename	property	filename: string	Public property; its type, readonly modifier and optionality are shown in the signature.
now	method	now?(): string	Public method; parameters and return type are shown in the signature.
schemaRegistry	property	schemaRegistry: EventSchemaRegistry	Public property; its type, readonly modifier and optionality are shown in the signature.

SQLiteImportedEventResetResult

SQLite Imported Event Reset Result interface with 3 public fields or methods.

• Kind: interface
• Import: import type { SQLiteImportedEventResetResult } from '@codesoul-co/hypha-adapters-local';
• Source module: runtime-event-store

Declaration

export interface SQLiteImportedEventResetResult {
    reset: boolean;
    deletedEvents: number;
    reason: 'empty' | 'reset' | 'audited_history' | 'non_imported_events';
}

Contract members

Member	Kind	Signature	Description
deletedEvents	property	deletedEvents: number	Public property; its type, readonly modifier and optionality are shown in the signature.
reason	property	reason: "empty" | "reset" | "audited_history" | "non_imported_events"	Public property; its type, readonly modifier and optionality are shown in the signature.
reset	property	reset: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.