@asaidimu/utils-database 3.1.1 → 3.1.2

package/index.d.mts

@@ -1,6 +1,5 @@
 import { QueryFilter, PaginationOptions } from '@asaidimu/query';
 import { IndexDefinition, SchemaDefinition, SchemaChange, DataTransform, PredicateMap } from '@asaidimu/anansi';
-import { EventBus } from '@core/events';
 import { StandardSchemaV1 } from '@standard-schema/spec';
 
 /**
@@ -741,23 +740,6 @@ declare const createIndexedDbStore: <T extends Record<string, any>>(config: Stor
 
 declare function DatabaseConnection(config: Omit<DatabaseConfig, "keyPath">, createStore: <T extends Record<string, any>>(config: StoreConfig, indexes: IndexDefinition[]) => Store<T>): Promise<Database>;
 
-interface MiddlewareContext {
-    collection?: string;
-    documentId?: string;
-    operation: string;
-    args: any[];
-    eventBus?: EventBus<any>;
-}
-type MaybePromise<T> = T | Promise<T>;
-type MiddlewareNext = () => MaybePromise<any>;
-type Middleware = (ctx: MiddlewareContext, next: MiddlewareNext) => MaybePromise<any>;
-declare class Pipeline {
-    private middlewares;
-    use(middleware: Middleware): void;
-    execute(ctx: MiddlewareContext, finalOperation: () => MaybePromise<any>): MaybePromise<any>;
-    wrap<T extends object>(target: T, baseContext: Partial<MiddlewareContext>): T;
-}
-
 interface MutexOptions {
     /**
      * Maximum number of pending requests allowed in the queue.
@@ -825,6 +807,76 @@ declare class Mutex {
     pending(): number;
 }
 
+/**
+ * Interface defining the shape of the EventBus.
+ * @template TEventMap - A record mapping event names to their respective payload types.
+ */
+interface EventBus<TEventMap extends Record<string, any>> {
+    /**
+     * Subscribes to a specific event by name.
+     * @param eventName - The name of the event to subscribe to.
+     * @param callback - The function to call when the event is emitted.
+     * @returns A function to unsubscribe from the event.
+     */
+    subscribe: <TEventName extends keyof TEventMap>(eventName: TEventName, callback: (payload: TEventMap[TEventName]) => void) => () => void;
+    /**
+     * Subscribes to an event and automatically unsubscribes after it fires once.
+     * @param eventName - The name of the event to subscribe to.
+     * @param callback - The function to call when the event is emitted.
+     * @returns A function to cancel the one-shot subscription before it fires.
+     */
+    once: <TEventName extends keyof TEventMap>(eventName: TEventName, callback: (payload: TEventMap[TEventName]) => void) => () => void;
+    /**
+     * Emits an event with a payload to all subscribed listeners.
+     * @param event - An object containing the event name and payload.
+     */
+    emit: <TEventName extends keyof TEventMap>(event: {
+        name: TEventName;
+        payload: TEventMap[TEventName];
+    }) => void;
+    /**
+     * Retrieves metrics about event bus usage.
+     * @returns An object containing various metrics.
+     */
+    metrics: () => EventMetrics;
+    /**
+     * Clears all subscriptions and resets metrics.
+     * After calling clear(), the bus is fully reset and can be reused —
+     * cross-tab communication is re-established if it was previously enabled.
+     */
+    clear: () => void;
+}
+/**
+ * Interface defining the metrics tracked by the EventBus.
+ */
+interface EventMetrics {
+    /** Total number of events emitted (both sync and deferred paths). */
+    totalEvents: number;
+    /** Number of active subscriptions across all event names. */
+    activeSubscriptions: number;
+    /** Map of event names to their emission counts. */
+    eventCounts: Map<string, number>;
+    /** Average duration of event dispatch in milliseconds. */
+    averageEmitDuration: number;
+}
+
+interface MiddlewareContext {
+    collection?: string;
+    documentId?: string;
+    operation: string;
+    args: any[];
+    eventBus?: EventBus<any>;
+}
+type MaybePromise<T> = T | Promise<T>;
+type MiddlewareNext = () => MaybePromise<any>;
+type Middleware = (ctx: MiddlewareContext, next: MiddlewareNext) => MaybePromise<any>;
+declare class Pipeline {
+    private middlewares;
+    use(middleware: Middleware): void;
+    execute(ctx: MiddlewareContext, finalOperation: () => MaybePromise<any>): MaybePromise<any>;
+    wrap<T extends object>(target: T, baseContext: Partial<MiddlewareContext>): T;
+}
+
 interface DocumentOptions<T extends Record<string, any>> {
     /**
      * The already-persisted initial state of the document.

package/index.d.ts

@@ -1,6 +1,5 @@
 import { QueryFilter, PaginationOptions } from '@asaidimu/query';
 import { IndexDefinition, SchemaDefinition, SchemaChange, DataTransform, PredicateMap } from '@asaidimu/anansi';
-import { EventBus } from '@core/events';
 import { StandardSchemaV1 } from '@standard-schema/spec';
 
 /**
@@ -741,23 +740,6 @@ declare const createIndexedDbStore: <T extends Record<string, any>>(config: Stor
 
 declare function DatabaseConnection(config: Omit<DatabaseConfig, "keyPath">, createStore: <T extends Record<string, any>>(config: StoreConfig, indexes: IndexDefinition[]) => Store<T>): Promise<Database>;
 
-interface MiddlewareContext {
-    collection?: string;
-    documentId?: string;
-    operation: string;
-    args: any[];
-    eventBus?: EventBus<any>;
-}
-type MaybePromise<T> = T | Promise<T>;
-type MiddlewareNext = () => MaybePromise<any>;
-type Middleware = (ctx: MiddlewareContext, next: MiddlewareNext) => MaybePromise<any>;
-declare class Pipeline {
-    private middlewares;
-    use(middleware: Middleware): void;
-    execute(ctx: MiddlewareContext, finalOperation: () => MaybePromise<any>): MaybePromise<any>;
-    wrap<T extends object>(target: T, baseContext: Partial<MiddlewareContext>): T;
-}
-
 interface MutexOptions {
     /**
      * Maximum number of pending requests allowed in the queue.
@@ -825,6 +807,76 @@ declare class Mutex {
     pending(): number;
 }
 
+/**
+ * Interface defining the shape of the EventBus.
+ * @template TEventMap - A record mapping event names to their respective payload types.
+ */
+interface EventBus<TEventMap extends Record<string, any>> {
+    /**
+     * Subscribes to a specific event by name.
+     * @param eventName - The name of the event to subscribe to.
+     * @param callback - The function to call when the event is emitted.
+     * @returns A function to unsubscribe from the event.
+     */
+    subscribe: <TEventName extends keyof TEventMap>(eventName: TEventName, callback: (payload: TEventMap[TEventName]) => void) => () => void;
+    /**
+     * Subscribes to an event and automatically unsubscribes after it fires once.
+     * @param eventName - The name of the event to subscribe to.
+     * @param callback - The function to call when the event is emitted.
+     * @returns A function to cancel the one-shot subscription before it fires.
+     */
+    once: <TEventName extends keyof TEventMap>(eventName: TEventName, callback: (payload: TEventMap[TEventName]) => void) => () => void;
+    /**
+     * Emits an event with a payload to all subscribed listeners.
+     * @param event - An object containing the event name and payload.
+     */
+    emit: <TEventName extends keyof TEventMap>(event: {
+        name: TEventName;
+        payload: TEventMap[TEventName];
+    }) => void;
+    /**
+     * Retrieves metrics about event bus usage.
+     * @returns An object containing various metrics.
+     */
+    metrics: () => EventMetrics;
+    /**
+     * Clears all subscriptions and resets metrics.
+     * After calling clear(), the bus is fully reset and can be reused —
+     * cross-tab communication is re-established if it was previously enabled.
+     */
+    clear: () => void;
+}
+/**
+ * Interface defining the metrics tracked by the EventBus.
+ */
+interface EventMetrics {
+    /** Total number of events emitted (both sync and deferred paths). */
+    totalEvents: number;
+    /** Number of active subscriptions across all event names. */
+    activeSubscriptions: number;
+    /** Map of event names to their emission counts. */
+    eventCounts: Map<string, number>;
+    /** Average duration of event dispatch in milliseconds. */
+    averageEmitDuration: number;
+}
+
+interface MiddlewareContext {
+    collection?: string;
+    documentId?: string;
+    operation: string;
+    args: any[];
+    eventBus?: EventBus<any>;
+}
+type MaybePromise<T> = T | Promise<T>;
+type MiddlewareNext = () => MaybePromise<any>;
+type Middleware = (ctx: MiddlewareContext, next: MiddlewareNext) => MaybePromise<any>;
+declare class Pipeline {
+    private middlewares;
+    use(middleware: Middleware): void;
+    execute(ctx: MiddlewareContext, finalOperation: () => MaybePromise<any>): MaybePromise<any>;
+    wrap<T extends object>(target: T, baseContext: Partial<MiddlewareContext>): T;
+}
+
 interface DocumentOptions<T extends Record<string, any>> {
     /**
      * The already-persisted initial state of the document.