@error-explorer/node 1.1.1

package/dist/index.d.ts

@@ -0,0 +1,261 @@
+import { I as InitOptions, U as UserContext, B as Breadcrumb, C as CaptureContext, S as SeverityLevel, R as ResolvedConfig, a as InternalBreadcrumb, P as ProcessContext, O as OsContext, b as RuntimeContext, c as ServerContext, E as ExpressRequest, d as RequestContext, e as StackFrame } from './types-D5NSSblm.js';
+export { g as BreadcrumbLevel, f as BreadcrumbType, h as ErrorEvent, m as ExpressErrorMiddleware, l as ExpressMiddleware, k as ExpressNextFunction, j as ExpressResponse, Q as QueuedEvent, i as SdkInfo, T as TransportOptions } from './types-D5NSSblm.js';
+export { ErrorHandlerOptions, RequestHandlerOptions, errorHandler, requestHandler, setupExpress } from './middleware/express.js';
+export { HttpHandlerOptions, createTrackedServer, wrapHandler } from './middleware/http.js';
+import { IncomingMessage } from 'node:http';
+
+/**
+ * Main ErrorExplorer client for Node.js
+ */
+
+/**
+ * Main ErrorExplorer class - singleton pattern
+ */
+declare class ErrorExplorerClient {
+    private config;
+    private transport;
+    private initialized;
+    private tags;
+    private extra;
+    private contexts;
+    /**
+     * Initialize the SDK
+     */
+    init(options: InitOptions): void;
+    /**
+     * Check if SDK is initialized
+     */
+    isInitialized(): boolean;
+    /**
+     * Set user context
+     */
+    setUser(user: UserContext | null): void;
+    /**
+     * Clear user context
+     */
+    clearUser(): void;
+    /**
+     * Set a single tag
+     */
+    setTag(key: string, value: string): void;
+    /**
+     * Set multiple tags
+     */
+    setTags(tags: Record<string, string>): void;
+    /**
+     * Set extra data
+     */
+    setExtra(key: string, value: unknown): void;
+    /**
+     * Set a named context
+     */
+    setContext(name: string, context: Record<string, unknown>): void;
+    /**
+     * Add a manual breadcrumb
+     */
+    addBreadcrumb(breadcrumb: Breadcrumb): void;
+    /**
+     * Capture an exception manually
+     */
+    captureException(error: Error | unknown, context?: CaptureContext): string;
+    /**
+     * Capture a message manually
+     */
+    captureMessage(message: string, level?: SeverityLevel): string;
+    /**
+     * Flush all pending events (best effort)
+     */
+    flush(timeout?: number): Promise<boolean>;
+    /**
+     * Close the SDK and cleanup
+     */
+    close(timeout?: number): Promise<boolean>;
+    /**
+     * Handle a captured error from auto-capture
+     */
+    private handleCapturedError;
+    /**
+     * Check if an error should be ignored
+     */
+    private shouldIgnoreError;
+    /**
+     * Build a complete error event
+     */
+    private buildEvent;
+    /**
+     * Process event through beforeSend and send
+     */
+    private processAndSend;
+    /**
+     * Start all breadcrumb trackers
+     */
+    private startBreadcrumbTrackers;
+    /**
+     * Stop all breadcrumb trackers
+     */
+    private stopAllTrackers;
+}
+declare const ErrorExplorer: ErrorExplorerClient;
+
+/**
+ * Breadcrumb manager for @error-explorer/node SDK
+ */
+
+/**
+ * Breadcrumb manager singleton
+ */
+declare class BreadcrumbManager {
+    private breadcrumbs;
+    private maxBreadcrumbs;
+    /**
+     * Initialize with configuration
+     */
+    init(config: ResolvedConfig): void;
+    /**
+     * Add a breadcrumb
+     */
+    add(breadcrumb: Breadcrumb): void;
+    /**
+     * Get all breadcrumbs (oldest first)
+     */
+    getAll(): InternalBreadcrumb[];
+    /**
+     * Get the last N breadcrumbs
+     */
+    getLast(count: number): InternalBreadcrumb[];
+    /**
+     * Clear all breadcrumbs
+     */
+    clear(): void;
+    /**
+     * Reset manager
+     */
+    reset(): void;
+}
+declare function getBreadcrumbManager(): BreadcrumbManager | null;
+
+/**
+ * Process context collector
+ */
+
+/**
+ * Collect current process context
+ */
+declare function collectProcessContext(): ProcessContext;
+
+/**
+ * OS context collector
+ */
+
+declare function collectOsContext(): OsContext;
+
+/**
+ * Runtime context collector
+ */
+
+declare function collectRuntimeContext(): RuntimeContext;
+
+/**
+ * Server context collector
+ */
+
+/**
+ * Get current server context
+ */
+declare function getServerContext(): ServerContext;
+/**
+ * Set server name
+ */
+declare function setServerName(name: string): void;
+
+/**
+ * Request context extractor
+ */
+
+/**
+ * Extract request context from Node.js IncomingMessage or Express request
+ */
+declare function extractRequestContext(req: IncomingMessage | ExpressRequest): RequestContext;
+
+/**
+ * Stack trace parsing utilities for Node.js
+ */
+
+/**
+ * Parse a V8 stack trace string into structured frames
+ */
+declare function parseStackTrace(stack: string | undefined): StackFrame[];
+
+/**
+ * UUID generation utilities
+ */
+/**
+ * Generate a UUID v4
+ */
+declare function generateUuid(): string;
+/**
+ * Generate a short ID (8 chars)
+ */
+declare function generateShortId(): string;
+/**
+ * Generate a transaction ID
+ */
+declare function generateTransactionId(): string;
+
+/**
+ * HMAC signing for secure webhook requests
+ */
+declare class HmacSigner {
+    private secret;
+    constructor(secret: string);
+    /**
+     * Sign a payload with HMAC-SHA256
+     * @param payload - The JSON payload string to sign
+     * @param timestamp - Unix timestamp (defaults to current time)
+     * @returns Hex-encoded signature
+     */
+    sign(payload: string, timestamp?: number): string;
+    /**
+     * Build headers for a signed request
+     * @param payload - The JSON payload string
+     * @returns Headers object with signature and timestamp
+     */
+    buildHeaders(payload: string): Record<string, string>;
+    /**
+     * Verify a signature (useful for testing)
+     * @param payload - The payload that was signed
+     * @param signature - The signature to verify
+     * @param timestamp - The timestamp used in signing
+     * @param maxAge - Maximum age in seconds (default: 5 minutes)
+     */
+    verify(payload: string, signature: string, timestamp: number, maxAge?: number): boolean;
+}
+
+/**
+ * @error-explorer/node - Error Explorer SDK for Node.js
+ *
+ * Usage:
+ * ```typescript
+ * import { ErrorExplorer } from '@error-explorer/node';
+ *
+ * ErrorExplorer.init({
+ *   dsn: 'https://ee_xxx@error-explorer.com/api/v1/webhook',
+ *   environment: 'production',
+ *   release: '1.0.0',
+ * });
+ *
+ * // Manual capture
+ * try {
+ *   // ... your code
+ * } catch (error) {
+ *   ErrorExplorer.captureException(error);
+ * }
+ *
+ * // With Express
+ * import { requestHandler, errorHandler } from '@error-explorer/node/express';
+ * app.use(requestHandler());
+ * app.use(errorHandler());
+ * ```
+ */
+
+export { Breadcrumb, CaptureContext, ErrorExplorer, ExpressRequest, HmacSigner, InitOptions, InternalBreadcrumb, OsContext, ProcessContext, RequestContext, ResolvedConfig, RuntimeContext, ServerContext, SeverityLevel, StackFrame, UserContext, collectOsContext, collectProcessContext, collectRuntimeContext, ErrorExplorer as default, extractRequestContext, generateShortId, generateTransactionId, generateUuid, getBreadcrumbManager, getServerContext, parseStackTrace, setServerName };