@geekmidas/telescope 0.0.1

package/dist/Telescope-C5dyDYYB.d.cts

@@ -0,0 +1,133 @@
+import { ExceptionEntry, LogEntry, QueryOptions, RequestEntry, TelescopeEvent, TelescopeOptions, TelescopeStats } from "./types-BGDhFv4R.cjs";
+
+//#region src/Telescope.d.ts
+
+/**
+ * Framework-agnostic Telescope class for debugging and monitoring applications.
+ * Use framework-specific adapters (e.g., @geekmidas/telescope/hono) for integration.
+ */
+declare class Telescope {
+  private storage;
+  private options;
+  private wsClients;
+  private pruneInterval?;
+  constructor(options: TelescopeOptions);
+  /**
+   * Record a request entry
+   */
+  recordRequest(entry: Omit<RequestEntry, 'id' | 'timestamp'>): Promise<string>;
+  /**
+   * Log entry input for batch operations
+   */
+  private saveLogEntries;
+  /**
+   * Record log entries in batch.
+   * More efficient than individual calls for database storage.
+   *
+   * @example
+   * await telescope.log([
+   *   { level: 'info', message: 'Request started' },
+   *   { level: 'debug', message: 'Processing...', context: { step: 1 } },
+   * ]);
+   */
+  log(entries: Array<{
+    level: 'debug' | 'info' | 'warn' | 'error';
+    message: string;
+    context?: Record<string, unknown>;
+    requestId?: string;
+  }>): Promise<void>;
+  /**
+   * Log a debug message
+   */
+  debug(message: string, context?: Record<string, unknown>, requestId?: string): Promise<void>;
+  /**
+   * Log an info message
+   */
+  info(message: string, context?: Record<string, unknown>, requestId?: string): Promise<void>;
+  /**
+   * Log a warning message
+   */
+  warn(message: string, context?: Record<string, unknown>, requestId?: string): Promise<void>;
+  /**
+   * Log an error message
+   */
+  error(message: string, context?: Record<string, unknown>, requestId?: string): Promise<void>;
+  /**
+   * Record an exception
+   */
+  exception(error: Error, requestId?: string): Promise<void>;
+  /**
+   * Get requests from storage
+   */
+  getRequests(options?: QueryOptions): Promise<RequestEntry[]>;
+  /**
+   * Get a single request by ID
+   */
+  getRequest(id: string): Promise<RequestEntry | null>;
+  /**
+   * Get exceptions from storage
+   */
+  getExceptions(options?: QueryOptions): Promise<ExceptionEntry[]>;
+  /**
+   * Get a single exception by ID
+   */
+  getException(id: string): Promise<ExceptionEntry | null>;
+  /**
+   * Get logs from storage
+   */
+  getLogs(options?: QueryOptions): Promise<LogEntry[]>;
+  /**
+   * Get storage statistics
+   */
+  getStats(): Promise<TelescopeStats>;
+  /**
+   * Add a WebSocket client for real-time updates
+   */
+  addWsClient(ws: WebSocket): void;
+  /**
+   * Remove a WebSocket client
+   */
+  removeWsClient(ws: WebSocket): void;
+  /**
+   * Broadcast an event to all connected WebSocket clients
+   */
+  broadcast(event: TelescopeEvent): void;
+  /**
+   * Manually prune old entries
+   */
+  prune(olderThan: Date): Promise<number>;
+  /**
+   * Clean up resources
+   */
+  destroy(): void;
+  /**
+   * Get the telescope path
+   */
+  get path(): string;
+  /**
+   * Check if telescope is enabled
+   */
+  get enabled(): boolean;
+  /**
+   * Check if body recording is enabled
+   */
+  get recordBody(): boolean;
+  /**
+   * Get max body size
+   */
+  get maxBodySize(): number;
+  /**
+   * Check if a path should be ignored
+   */
+  shouldIgnore(path: string): boolean;
+  /**
+   * Get the dashboard HTML
+   */
+  getDashboardHtml(): string;
+  private normalizeOptions;
+  private parseStack;
+  private autoPrune;
+}
+//#endregion
+export { Telescope };
+//# sourceMappingURL=Telescope-C5dyDYYB.d.cts.map