/// /// export class Position { constructor(commitPosition: number|Long, preparePosition: number|Long); readonly commitPosition: Long; readonly preparePosition: Long; } // Expose classes export class UserCredentials { constructor(username: string, password: string); readonly username: string; readonly password: string; } export class PersistentSubscriptionSettings { constructor(resolveLinkTos: boolean, startFrom: Long|number, extraStatistics: boolean, messageTimeout: number, maxRetryCount: number, liveBufferSize: number, readBatchSize: number, historyBufferSize: number, checkPointAfter: number, minCheckPointCount: number, maxCheckPointCount: number, maxSubscriberCount: number, namedConsumerStrategy: string) static create(): PersistentSubscriptionSettings; } export namespace SystemConsumerStrategies { const DispatchToSingle: string; const RoundRobin: string; const Pinned: string } export class GossipSeed { constructor(endPoint: TcpEndPoint, hostHeader: string); readonly endPoint: TcpEndPoint; readonly hostHeader: string; } // Expose errors export class WrongExpectedVersionError { readonly name: string; readonly action: string; readonly message: string; readonly stream?: string; readonly expectedVersion?: Long; readonly transactionId?: Long; } export class StreamDeletedError { readonly message: string; readonly stream?: string; readonly transactionId?: Long; } export class AccessDeniedError { readonly name: string; readonly action: string; readonly message: string; readonly stream?: string; readonly transactionId?: Long; } // Expose enums/constants export namespace expectedVersion { const any: number; const noStream: number; const emptyStream: number; } export namespace positions { const start: Position; const end: Position; } // systemMetadata // eventReadStatus // sliceReadStatus // Expose loggers export interface Logger { debug(fmt: string, ...args: any[]): void; info(fmt: string, ...args: any[]): void; error(fmt: string, ...args: any[]): void; } export class NoOpLogger implements Logger { constructor() debug(fmt: string, ...args: any[]): void; info(fmt: string, ...args: any[]): void; error(fmt: string, ...args: any[]): void; } export class FileLogger implements Logger { constructor(filePath: string, append: boolean); debug(fmt: string, ...args: any[]): void; info(fmt: string, ...args: any[]): void; error(fmt: string, ...args: any[]): void; } // export interface WriteResult { readonly nextExpectedVersion: Long; readonly logPosition: Position; } export interface RecordedEvent { readonly eventStreamId: string; readonly eventId: string; readonly eventNumber: Long; readonly eventType: string; readonly createdEpoch: number; readonly data?: Buffer; readonly metadata?: Buffer; readonly isJson: boolean; } export interface ResolvedEvent { readonly event?: RecordedEvent; readonly link?: RecordedEvent; readonly originalEvent?: RecordedEvent; readonly isResolved: boolean; readonly originalPosition?: Position; readonly originalStreamId: string; readonly originalEventNumber: Long; } export interface StreamEventsSlice { readonly status: string; // TODO: enum readonly stream: string; readonly fromEventNumber: Long; readonly readDirection: string; // TODO: enum readonly events: ResolvedEvent[]; readonly nextEventNumber: Long; readonly lastEventNumber: Long; readonly isEndOfStream: boolean; } export interface AllEventsSlice { readonly readDirection: string; // TODO enum readonly fromPosition: Position; readonly nextPosition: Position; readonly events: ResolvedEvent[]; readonly isEndOfStream: boolean; } export interface DeleteResult { readonly logPosition: Position; } export interface EventStoreTransaction { readonly transactionId: number; commit(): Promise; write(eventOrEvents: EventData | EventData[]): Promise; rollback(): void; } export interface EventReadResult { readonly status: string; readonly stream: string; readonly eventNumber: Long; readonly event: ResolvedEvent | null; } export interface EventStoreSubscription { readonly isSubscribedToAll: boolean; readonly streamId: string; readonly lastCommitPosition: Position; readonly lastEventNumber: Long; close(): void; unsubscribe(): void; } export interface EventStoreCatchUpSubscription { stop(): void; } export enum PersistentSubscriptionNakEventAction { Unknown = 0, Park = 1, Retry = 2, Skip = 3, Stop = 4 } export interface EventStorePersistentSubscription { acknowledge(events: ResolvedEvent | ResolvedEvent[]): void; fail(events: ResolvedEvent | ResolvedEvent[], action: PersistentSubscriptionNakEventAction, reason: string): void; stop(): void; } export interface RawStreamMetadataResult { readonly stream: string; readonly isStreamDeleted: boolean; readonly metastreamVersion: Long; readonly streamMetadata: any; } export interface PersistentSubscriptionCreateResult { readonly status: string; } export interface PersistentSubscriptionUpdateResult { readonly status: string; } export interface PersistentSubscriptionDeleteResult { readonly status: string; } // Callbacks export interface EventAppearedCallback { (subscription: TSubscription, event: ResolvedEvent): void | Promise; } export interface LiveProcessingStartedCallback { (subscription: EventStoreCatchUpSubscription): void; } export interface SubscriptionDroppedCallback { (subscription: TSubscription, reason: string, error?: Error): void; } export interface TcpEndPoint { port: number; host: string; } export interface HeartbeatInfo { connectionId: string; remoteEndPoint: TcpEndPoint; requestSentAt: number; requestPkgNumber: number; responseReceivedAt: number; responsePkgNumber: number; } export interface EventData { readonly eventId: string; readonly type: string; readonly isJson: boolean; readonly data: Buffer; readonly metadata: Buffer; } export interface EventStoreNodeConnection { connect(): Promise; close(): void; // write actions deleteStream(stream: string, expectedVersion: Long|number, hardDelete?: boolean, userCredentials?: UserCredentials): Promise; appendToStream(stream: string, expectedVersion: Long|number, eventOrEvents: EventData | EventData[], userCredentials?: UserCredentials): Promise; startTransaction(stream: string, expectedVersion: Long|number, userCredentials?: UserCredentials): Promise; continueTransaction(transactionId: number, userCredentials?: UserCredentials): EventStoreTransaction; // read actions readEvent(stream: string, eventNumber: Long|number, resolveLinkTos?: boolean, userCredentials?: UserCredentials): Promise; readStreamEventsForward(stream: string, start: Long|number, count: number, resolveLinkTos?: boolean, userCredentials?: UserCredentials): Promise; readStreamEventsBackward(stream: string, start: Long|number, count: number, resolveLinkTos?: boolean, userCredentials?: UserCredentials): Promise; readAllEventsForward(position: Position, maxCount: number, resolveLinkTos?: boolean, userCredentials?: UserCredentials): Promise; readAllEventsBackward(position: Position, maxCount: number, resolveLinkTos?: boolean, userCredentials?: UserCredentials): Promise; // subscription actions subscribeToStream(stream: string, resolveLinkTos: boolean, eventAppeared: EventAppearedCallback, subscriptionDropped?: SubscriptionDroppedCallback, userCredentials?: UserCredentials): Promise; subscribeToStreamFrom(stream: string, lastCheckpoint: number | null, resolveLinkTos: boolean, eventAppeared: EventAppearedCallback, liveProcessingStarted?: LiveProcessingStartedCallback, subscriptionDropped?: SubscriptionDroppedCallback, userCredentials?: UserCredentials, readBatchSize?: number): EventStoreCatchUpSubscription; subscribeToAll(resolveLinkTos: boolean, eventAppeared: EventAppearedCallback, subscriptionDropped?: SubscriptionDroppedCallback, userCredentials?: UserCredentials): Promise; subscribeToAllFrom(lastCheckpoint: Position | null, resolveLinkTos: boolean, eventAppeared: EventAppearedCallback, liveProcessingStarted?: LiveProcessingStartedCallback, subscriptionDropped?: SubscriptionDroppedCallback, userCredentials?: UserCredentials, readBatchSize?: number): EventStoreCatchUpSubscription; // persistent subscriptions createPersistentSubscription(stream: string, groupName: string, settings: PersistentSubscriptionSettings, userCredentials?: PersistentSubscriptionSettings): Promise; updatePersistentSubscription(stream: string, groupName: string, settings: PersistentSubscriptionSettings, userCredentials?: PersistentSubscriptionSettings): Promise; deletePersistentSubscription(stream: string, groupName: string, userCredentials?: PersistentSubscriptionSettings): Promise connectToPersistentSubscription(stream: string, groupName: string, eventAppeared: EventAppearedCallback, subscriptionDropped?: SubscriptionDroppedCallback, userCredentials?: UserCredentials, bufferSize?: number, autoAck?: boolean): Promise; // metadata actions setStreamMetadataRaw(stream: string, expectedMetastreamVersion: Long|number, metadata: any, userCredentials?: UserCredentials): Promise; getStreamMetadataRaw(stream: string, userCredentials?: UserCredentials): Promise; on(event: "connected" | "disconnected" | "reconnecting" | "closed" | "error" | "heartbeatInfo", listener: (arg: Error | string | TcpEndPoint | HeartbeatInfo) => void): this; once(event: "connected" | "disconnected" | "reconnecting" | "closed" | "error" | "heartbeatInfo", listener: (arg: Error | string | TcpEndPoint | HeartbeatInfo) => void): this; } // Expose helper functions export interface ConnectionSettings { log?: Logger, verboseLogging?: boolean, maxQueueSize?: number, maxConcurrentItems?: number, maxRetries?: number, maxReconnections?: number, requireMaster?: boolean, reconnectionDelay?: number, operationTimeout?: number, operationTimeoutCheckPeriod?: number, defaultUserCredentials?: UserCredentials, useSslConnection?: boolean, targetHost?: TcpEndPoint, validateServer?: boolean, failOnNoServerResponse?: boolean, heartbeatInterval?: number, heartbeatTimeout?: number, clientConnectionTimeout?: number, // Cluster Settings clusterDns?: string, maxDiscoverAttempts?: number, externalGossipPort?: number, gossipTimeout?: number } export function createConnection(settings: ConnectionSettings, endPointOrGossipSeed: string | TcpEndPoint | GossipSeed[], connectionName?: string): EventStoreNodeConnection; export function createJsonEventData(eventId: string, event: any, metadata?: any, type?: string): EventData; export function createEventData(eventId: string, type: string, isJson: boolean, data: Buffer, metadata?: Buffer): EventData;