/** * The Eventsy class represents a system for logging and managing events. It utilizes Dobby for database operations and provides methods for logging events, retrieving events by type, performing full-text searches, and more. This class is designed to be flexible and adaptable to various event logging needs. */ import { Dobby } from "https://esm.town/v/yawnxyz/dobby"; /** * Represents an events logger system. */ export class Eventsy { private dobby: Dobby; private namespace: string; private databaseName: string; private indexes: { name: string; columns: string[] }[]; private ftsIndexes: { name: string; columns: string[] }[]; /** * Initializes a new instance of the Eventsy class. * * @param {Object} options - The options for initializing the Eventsy instance. * @param {string} options.namespace - The namespace for the events. * @param {string} options.databaseName - The name of the database. * @param {{ name: string; columns: string[] }[]} options.indexes - The indexes for the database. * @param {{ name: string; columns: string[] }[]} options.ftsIndexes - The full-text search indexes for the database. */ constructor({ namespace, databaseName, indexes = [], ftsIndexes = [] }: { namespace: string; databaseName: string; indexes?: { name: string; columns: string[] }[]; ftsIndexes?: { name: string; columns: string[] }[]; }) { this.namespace = namespace; this.databaseName = databaseName; this.indexes = indexes; this.ftsIndexes = ftsIndexes; // Initialize Dobby with the necessary tables, indexes, and FTS indexes this.dobby = new Dobby( databaseName, [ { name: 'id', type: 'INTEGER', primaryKey: true }, { name: 'type', type: 'TEXT', notNull: true }, { name: 'aggregateId', type: 'TEXT' }, { name: 'description', type: 'TEXT' }, { name: 'eventData', type: 'JSON', notNull: true }, { name: 'timestamp', type: 'INTEGER', notNull: true }, { name: 'version', type: 'INTEGER', notNull: true }, { name: 'namespace', type: 'TEXT' }, { name: 'owner', type: 'TEXT' }, { name: 'schema', type: 'JSON' }, { name: 'collections', type: 'JSONARRAY' }, ], indexes, ftsIndexes ); // Initialize the database and create indexes this.initializeDatabase(); } /** * Initializes the database and creates indexes. */ private async initializeDatabase() { await this.dobby.createDatabase(); // Additional setup if needed } /** * Logs an event. * * @param {{ type: string; aggregateId?: string; description?: string; eventData: object; version?: number }} options - The options for logging the event. * @param {string} options.type - The type of the event. * @param {string} [options.aggregateId] - The aggregate ID of the event. * @param {string} [options.description] - The description of the event. * @param {object} options.eventData - The data of the event. * @param {number} [options.version=1] - The version of the event. * @returns {Promise} A promise that resolves when the event is logged. */ async logEvent({ type, aggregateId, description, eventData, version = 1 }: { type: string, aggregateId?: string, description?: string, eventData: object, version?: number }): Promise { const event = { type, aggregateId, description, eventData, version, timestamp: Date.now(), namespace: this.namespace }; await this.dobby.insert(event); } /** * Retrieves events by type. * * @param {string} eventType - The type of events to retrieve. * @param {number} [limit=100] - The maximum number of events to retrieve. * @returns {Promise} A promise that resolves to an array of events. */ async getEventsByType(eventType: string, limit: number = 100): Promise { return await this.dobby.filter({ type: eventType, namespace: this.namespace }, { limit }); } /** * Performs a full-text search on events. * * @param {string} ftsIndex - The name of the full-text search index. * @param {string} query - The search query. * @param {{ limit?: number; offset?: number }} options - The options for the search. * @param {number} [options.limit] - The maximum number of results to return. * @param {number} [options.offset] - The offset for pagination. * @returns {Promise} A promise that resolves to an array of search results. */ async ftsSearch(ftsIndex: string, query: string, options: { limit?: number, offset?: number } = {}): Promise { return await this.dobby.fullTextSearch(ftsIndex, query, options); } /** * Retrieves events by aggregate ID. * * @param {string} aggregateId - The aggregate ID of the events to retrieve. * @returns {Promise} A promise that resolves to an array of events. */ async getEventsByAggregateId(aggregateId: string): Promise { return await this.dobby.filter({ aggregateId, namespace: this.namespace }); } /** * Retrieves the latest events. * * @param {number} [limit=100] - The maximum number of events to retrieve. * @returns {Promise} A promise that resolves to an array of the latest events. */ async getLatestEvents(limit: number = 100): Promise { return await this.dobby.filter({ namespace: this.namespace }, { limit, orderBy: { timestamp: 'desc' } }); } /** * Gets the underlying Dobby instance. * * @returns {Dobby} The Dobby instance. */ getDobbyInstance(): Dobby { return this.dobby; } } // Export Eventsy class for Val Town and local Deno export default (typeof Deno !== "undefined" && Deno.env.get("valtown")) ? Eventsy : { Eventsy };

eventsy

Versions

v1

v0