@korajs/devtools 0.4.0 → 0.5.0

package/dist/index.d.cts

@@ -1,163 +1,6 @@
-import { KoraEvent, KoraEventType, KoraEventEmitter, Operation } from '@korajs/core';
-
-/** A KoraEvent wrapped with a reception timestamp and sequential ID */
-interface TimestampedEvent {
-    /** Auto-incrementing sequential ID */
-    id: number;
-    /** The original framework event */
-    event: KoraEvent;
-    /** Date.now() when the instrumenter captured the event */
-    receivedAt: number;
-}
-/** Event categories for filtering and grouping */
-type EventCategory = 'operation' | 'merge' | 'sync' | 'query' | 'connection';
-/** Configuration for the Instrumenter */
-interface DevtoolsConfig {
-    /** Max events in the ring buffer (default: 10000) */
-    bufferSize?: number;
-    /** Enable message bridge for DevTools panel communication (default: true) */
-    bridgeEnabled?: boolean;
-    /** Custom message channel name (default: 'kora-devtools') */
-    channelName?: string;
-}
-/** Filter criteria for querying events */
-interface EventFilterCriteria {
-    /** Filter by event categories */
-    categories?: EventCategory[];
-    /** Filter by specific event types */
-    types?: KoraEventType[];
-    /** Filter by reception time range */
-    timeRange?: {
-        start: number;
-        end: number;
-    };
-    /** Filter by collection name (extracted from operation events) */
-    collection?: string;
-}
-/** Aggregated statistics computed from a set of events */
-interface EventStatistics {
-    totalEvents: number;
-    eventsByCategory: Record<EventCategory, number>;
-    eventsByType: Partial<Record<KoraEventType, number>>;
-    mergeConflicts: number;
-    constraintViolations: number;
-    avgMergeDuration: number | null;
-    avgQueryDuration: number | null;
-    syncOperationsSent: number;
-    syncOperationsReceived: number;
-}
-
-/**
- * Communicates between the page context and a DevTools panel via window.postMessage.
- * All messages are namespaced with a `source` field to avoid collisions with other
- * postMessage consumers on the page.
- *
- * Safe to instantiate in non-browser environments (SSR/Node) — all operations
- * become no-ops when `window` is not available.
- */
-declare class MessageBridge {
-    private readonly channelName;
-    private readonly listeners;
-    private readonly messageHandler;
-    private destroyed;
-    constructor(channelName?: string);
-    /**
-     * Post a timestamped event through the bridge.
-     * No-op if window is not available or the bridge has been destroyed.
-     */
-    send(event: TimestampedEvent): void;
-    /**
-     * Register a callback for events received through the bridge.
-     * Returns an unsubscribe function.
-     */
-    onReceive(callback: (event: TimestampedEvent) => void): () => void;
-    /**
-     * Remove all listeners and detach from window.
-     * After calling destroy, all operations become no-ops.
-     */
-    destroy(): void;
-}
-
-/**
- * Fixed-capacity ring buffer for storing timestamped events.
- * When the buffer is full, the oldest events are evicted to make room for new ones.
- * This prevents unbounded memory growth when events accumulate fast.
- */
-declare class EventBuffer {
-    private readonly _capacity;
-    private readonly buffer;
-    /** Index where the next event will be written */
-    private head;
-    /** Total number of events ever pushed (used to compute readable range) */
-    private _totalPushed;
-    constructor(capacity?: number);
-    /** Maximum number of events the buffer can hold */
-    get capacity(): number;
-    /** Current number of events in the buffer */
-    get size(): number;
-    /**
-     * Append an event to the buffer.
-     * If the buffer is at capacity, the oldest event is evicted.
-     */
-    push(event: TimestampedEvent): void;
-    /**
-     * Returns all events in insertion order (oldest first).
-     */
-    getAll(): readonly TimestampedEvent[];
-    /**
-     * Returns events whose sequential IDs fall within [start, end] (inclusive).
-     */
-    getRange(start: number, end: number): readonly TimestampedEvent[];
-    /**
-     * Returns events matching a specific KoraEventType.
-     */
-    getByType(type: KoraEventType): readonly TimestampedEvent[];
-    /** Remove all events from the buffer */
-    clear(): void;
-}
-
-/**
- * Core orchestrator for Kora DevTools instrumentation.
- *
- * Attaches to a KoraEventEmitter, records all emitted events into a ring buffer
- * with sequential IDs and reception timestamps, and optionally forwards them
- * through a MessageBridge for consumption by a DevTools panel.
- *
- * @example
- * ```typescript
- * const instrumenter = new Instrumenter(app.emitter, { bufferSize: 5000 })
- * const buffer = instrumenter.getBuffer()
- * // ... later
- * instrumenter.destroy()
- * ```
- */
-declare class Instrumenter {
-    private readonly emitter;
-    private readonly buffer;
-    private readonly bridge;
-    private readonly unsubscribers;
-    private nextId;
-    private paused;
-    private destroyed;
-    constructor(emitter: KoraEventEmitter, config?: DevtoolsConfig);
-    /** Access the underlying event buffer */
-    getBuffer(): EventBuffer;
-    /** Access the message bridge, or null if bridge is disabled */
-    getBridge(): MessageBridge | null;
-    /** Temporarily stop recording events. Events emitted while paused are dropped. */
-    pause(): void;
-    /** Resume recording events after a pause. */
-    resume(): void;
-    /** Whether the instrumenter is currently paused */
-    isPaused(): boolean;
-    /**
-     * Detach all listeners from the emitter and destroy the bridge.
-     * After calling destroy, the instrumenter is inert.
-     */
-    destroy(): void;
-    private attachListeners;
-    private handleEvent;
-}
+import { T as TimestampedEvent, E as EventFilterCriteria, a as EventCategory, b as EventStatistics } from './embed-overlay-Dwys5PYM.cjs';
+export { D as DevtoolsConfig, c as EventBuffer, I as Instrumenter, M as MessageBridge, m as mountKoraDevtoolsOverlay } from './embed-overlay-Dwys5PYM.cjs';
+import { KoraEventType, KoraEvent, Operation } from '@korajs/core';
 
 /**
  * Maps a KoraEventType to its EventCategory.
@@ -261,4 +104,4 @@ declare class PortRouter {
     private attachContent;
 }
 
-export { type DevtoolsConfig, EventBuffer, type EventCategory, type EventFilterCriteria, type EventStatistics, Instrumenter, MessageBridge, PortRouter, type TimestampedEvent, buildPanelModel, computeStatistics, filterEvents, getEventCategory, renderDevtoolsPanel };
+export { EventCategory, EventFilterCriteria, EventStatistics, PortRouter, TimestampedEvent, buildPanelModel, computeStatistics, filterEvents, getEventCategory, renderDevtoolsPanel };

package/dist/index.d.ts

@@ -1,163 +1,6 @@
-import { KoraEvent, KoraEventType, KoraEventEmitter, Operation } from '@korajs/core';
-
-/** A KoraEvent wrapped with a reception timestamp and sequential ID */
-interface TimestampedEvent {
-    /** Auto-incrementing sequential ID */
-    id: number;
-    /** The original framework event */
-    event: KoraEvent;
-    /** Date.now() when the instrumenter captured the event */
-    receivedAt: number;
-}
-/** Event categories for filtering and grouping */
-type EventCategory = 'operation' | 'merge' | 'sync' | 'query' | 'connection';
-/** Configuration for the Instrumenter */
-interface DevtoolsConfig {
-    /** Max events in the ring buffer (default: 10000) */
-    bufferSize?: number;
-    /** Enable message bridge for DevTools panel communication (default: true) */
-    bridgeEnabled?: boolean;
-    /** Custom message channel name (default: 'kora-devtools') */
-    channelName?: string;
-}
-/** Filter criteria for querying events */
-interface EventFilterCriteria {
-    /** Filter by event categories */
-    categories?: EventCategory[];
-    /** Filter by specific event types */
-    types?: KoraEventType[];
-    /** Filter by reception time range */
-    timeRange?: {
-        start: number;
-        end: number;
-    };
-    /** Filter by collection name (extracted from operation events) */
-    collection?: string;
-}
-/** Aggregated statistics computed from a set of events */
-interface EventStatistics {
-    totalEvents: number;
-    eventsByCategory: Record<EventCategory, number>;
-    eventsByType: Partial<Record<KoraEventType, number>>;
-    mergeConflicts: number;
-    constraintViolations: number;
-    avgMergeDuration: number | null;
-    avgQueryDuration: number | null;
-    syncOperationsSent: number;
-    syncOperationsReceived: number;
-}
-
-/**
- * Communicates between the page context and a DevTools panel via window.postMessage.
- * All messages are namespaced with a `source` field to avoid collisions with other
- * postMessage consumers on the page.
- *
- * Safe to instantiate in non-browser environments (SSR/Node) — all operations
- * become no-ops when `window` is not available.
- */
-declare class MessageBridge {
-    private readonly channelName;
-    private readonly listeners;
-    private readonly messageHandler;
-    private destroyed;
-    constructor(channelName?: string);
-    /**
-     * Post a timestamped event through the bridge.
-     * No-op if window is not available or the bridge has been destroyed.
-     */
-    send(event: TimestampedEvent): void;
-    /**
-     * Register a callback for events received through the bridge.
-     * Returns an unsubscribe function.
-     */
-    onReceive(callback: (event: TimestampedEvent) => void): () => void;
-    /**
-     * Remove all listeners and detach from window.
-     * After calling destroy, all operations become no-ops.
-     */
-    destroy(): void;
-}
-
-/**
- * Fixed-capacity ring buffer for storing timestamped events.
- * When the buffer is full, the oldest events are evicted to make room for new ones.
- * This prevents unbounded memory growth when events accumulate fast.
- */
-declare class EventBuffer {
-    private readonly _capacity;
-    private readonly buffer;
-    /** Index where the next event will be written */
-    private head;
-    /** Total number of events ever pushed (used to compute readable range) */
-    private _totalPushed;
-    constructor(capacity?: number);
-    /** Maximum number of events the buffer can hold */
-    get capacity(): number;
-    /** Current number of events in the buffer */
-    get size(): number;
-    /**
-     * Append an event to the buffer.
-     * If the buffer is at capacity, the oldest event is evicted.
-     */
-    push(event: TimestampedEvent): void;
-    /**
-     * Returns all events in insertion order (oldest first).
-     */
-    getAll(): readonly TimestampedEvent[];
-    /**
-     * Returns events whose sequential IDs fall within [start, end] (inclusive).
-     */
-    getRange(start: number, end: number): readonly TimestampedEvent[];
-    /**
-     * Returns events matching a specific KoraEventType.
-     */
-    getByType(type: KoraEventType): readonly TimestampedEvent[];
-    /** Remove all events from the buffer */
-    clear(): void;
-}
-
-/**
- * Core orchestrator for Kora DevTools instrumentation.
- *
- * Attaches to a KoraEventEmitter, records all emitted events into a ring buffer
- * with sequential IDs and reception timestamps, and optionally forwards them
- * through a MessageBridge for consumption by a DevTools panel.
- *
- * @example
- * ```typescript
- * const instrumenter = new Instrumenter(app.emitter, { bufferSize: 5000 })
- * const buffer = instrumenter.getBuffer()
- * // ... later
- * instrumenter.destroy()
- * ```
- */
-declare class Instrumenter {
-    private readonly emitter;
-    private readonly buffer;
-    private readonly bridge;
-    private readonly unsubscribers;
-    private nextId;
-    private paused;
-    private destroyed;
-    constructor(emitter: KoraEventEmitter, config?: DevtoolsConfig);
-    /** Access the underlying event buffer */
-    getBuffer(): EventBuffer;
-    /** Access the message bridge, or null if bridge is disabled */
-    getBridge(): MessageBridge | null;
-    /** Temporarily stop recording events. Events emitted while paused are dropped. */
-    pause(): void;
-    /** Resume recording events after a pause. */
-    resume(): void;
-    /** Whether the instrumenter is currently paused */
-    isPaused(): boolean;
-    /**
-     * Detach all listeners from the emitter and destroy the bridge.
-     * After calling destroy, the instrumenter is inert.
-     */
-    destroy(): void;
-    private attachListeners;
-    private handleEvent;
-}
+import { T as TimestampedEvent, E as EventFilterCriteria, a as EventCategory, b as EventStatistics } from './embed-overlay-Dwys5PYM.js';
+export { D as DevtoolsConfig, c as EventBuffer, I as Instrumenter, M as MessageBridge, m as mountKoraDevtoolsOverlay } from './embed-overlay-Dwys5PYM.js';
+import { KoraEventType, KoraEvent, Operation } from '@korajs/core';
 
 /**
  * Maps a KoraEventType to its EventCategory.
@@ -261,4 +104,4 @@ declare class PortRouter {
     private attachContent;
 }
 
-export { type DevtoolsConfig, EventBuffer, type EventCategory, type EventFilterCriteria, type EventStatistics, Instrumenter, MessageBridge, PortRouter, type TimestampedEvent, buildPanelModel, computeStatistics, filterEvents, getEventCategory, renderDevtoolsPanel };
+export { EventCategory, EventFilterCriteria, EventStatistics, PortRouter, TimestampedEvent, buildPanelModel, computeStatistics, filterEvents, getEventCategory, renderDevtoolsPanel };