@error-explorer/node 1.1.1

package/dist/types-D5NSSblm.d.ts

@@ -0,0 +1,255 @@
+import { IncomingMessage, ServerResponse } from 'node:http';
+
+/**
+ * Core types for @error-explorer/node SDK
+ */
+
+interface InitOptions {
+    /** Webhook token (required) - format: ee_xxx */
+    token?: string;
+    /** Full DSN URL (alternative to token) - format: http(s)://token@host/path */
+    dsn?: string;
+    /** Environment name (production, staging, development) */
+    environment?: string;
+    /** Application release/version */
+    release?: string;
+    /** Server/hostname name */
+    serverName?: string;
+    /** API endpoint URL (auto-detected from token/dsn) */
+    endpoint?: string;
+    /** Auto capture settings */
+    autoCapture?: {
+        /** Capture uncaughtException (default: true) */
+        uncaughtExceptions?: boolean;
+        /** Capture unhandledRejection (default: true) */
+        unhandledRejections?: boolean;
+        /** Capture console.error calls (default: false) */
+        console?: boolean;
+    };
+    /** Breadcrumbs settings */
+    breadcrumbs?: {
+        /** Enable breadcrumbs (default: true) */
+        enabled?: boolean;
+        /** Maximum breadcrumbs to keep (default: 50) */
+        maxBreadcrumbs?: number;
+        /** Track HTTP requests (default: true) */
+        http?: boolean;
+        /** Track console logs (default: true) */
+        console?: boolean;
+    };
+    /** Hook to modify/filter events before sending */
+    beforeSend?: (event: ErrorEvent) => ErrorEvent | null | Promise<ErrorEvent | null>;
+    /** Error messages to ignore */
+    ignoreErrors?: (string | RegExp)[];
+    /** Maximum retries for failed requests (default: 3) */
+    maxRetries?: number;
+    /** Request timeout in ms (default: 5000) */
+    timeout?: number;
+    /** Enable debug mode (default: false) */
+    debug?: boolean;
+    /** HMAC secret for signed requests (optional) */
+    hmacSecret?: string;
+    /** Exit on uncaughtException (default: true) - recommended to leave as true */
+    exitOnUncaughtException?: boolean;
+}
+interface UserContext {
+    id?: string;
+    email?: string;
+    username?: string;
+    name?: string;
+    ip_address?: string;
+    role?: string;
+    [key: string]: unknown;
+}
+type BreadcrumbType = 'http' | 'console' | 'query' | 'navigation' | 'error' | 'debug' | 'custom';
+type BreadcrumbLevel = 'debug' | 'info' | 'warning' | 'error';
+interface Breadcrumb {
+    type: BreadcrumbType;
+    category?: string;
+    message?: string;
+    level?: BreadcrumbLevel;
+    data?: Record<string, unknown>;
+    timestamp?: number;
+}
+interface InternalBreadcrumb extends Breadcrumb {
+    timestamp: number;
+}
+type SeverityLevel = 'critical' | 'error' | 'warning' | 'info' | 'notice' | 'debug';
+interface StackFrame {
+    filename?: string;
+    function?: string;
+    lineno?: number;
+    colno?: number;
+    in_app?: boolean;
+    context_line?: string;
+    pre_context?: string[];
+    post_context?: string[];
+    abs_path?: string;
+    module?: string;
+}
+interface ErrorEvent {
+    /** Error message */
+    message: string;
+    /** Exception class name (TypeError, Error, etc.) */
+    exception_class?: string;
+    /** Source file */
+    file?: string;
+    /** Line number */
+    line?: number;
+    /** Column number */
+    column?: number;
+    /** Full stack trace as string */
+    stack_trace?: string;
+    /** Parsed stack frames */
+    frames?: StackFrame[];
+    /** Severity level */
+    severity: SeverityLevel;
+    /** Environment */
+    environment?: string;
+    /** Release version */
+    release?: string;
+    /** ISO timestamp */
+    timestamp: string;
+    /** User context */
+    user?: UserContext;
+    /** Request context (from HTTP middleware) */
+    request?: RequestContext;
+    /** Server context */
+    server?: ServerContext;
+    /** Runtime context (Node.js info) */
+    runtime?: RuntimeContext;
+    /** OS context */
+    os?: OsContext;
+    /** Process context */
+    process?: ProcessContext;
+    /** Breadcrumbs (last N actions before error) */
+    breadcrumbs?: InternalBreadcrumb[];
+    /** Custom tags */
+    tags?: Record<string, string>;
+    /** Extra data */
+    extra?: Record<string, unknown>;
+    /** Custom contexts */
+    contexts?: Record<string, Record<string, unknown>>;
+    /** SDK info */
+    sdk: SdkInfo;
+    /** Event fingerprint for grouping */
+    fingerprint?: string[];
+    /** Transaction/request ID */
+    transaction?: string;
+}
+interface RequestContext {
+    url?: string;
+    method?: string;
+    headers?: Record<string, string | string[] | undefined>;
+    query_string?: string;
+    data?: unknown;
+    cookies?: Record<string, string>;
+    env?: Record<string, string>;
+}
+interface ServerContext {
+    name?: string;
+    hostname?: string;
+}
+interface RuntimeContext {
+    name: string;
+    version: string;
+}
+interface OsContext {
+    name?: string;
+    version?: string;
+    arch?: string;
+    kernel_version?: string;
+}
+interface ProcessContext {
+    pid: number;
+    ppid?: number;
+    uptime?: number;
+    memory?: {
+        rss: number;
+        heapTotal: number;
+        heapUsed: number;
+        external: number;
+        arrayBuffers?: number;
+    };
+    cpu?: {
+        user: number;
+        system: number;
+    };
+}
+interface SdkInfo {
+    name: string;
+    version: string;
+}
+interface CaptureContext {
+    tags?: Record<string, string>;
+    extra?: Record<string, unknown>;
+    user?: UserContext;
+    level?: SeverityLevel;
+    fingerprint?: string[];
+    request?: IncomingMessage;
+}
+interface TransportOptions {
+    endpoint: string;
+    token: string;
+    timeout: number;
+    maxRetries: number;
+    hmacSecret?: string;
+    debug?: boolean;
+}
+interface QueuedEvent {
+    event: ErrorEvent;
+    retries: number;
+    timestamp: number;
+}
+interface ResolvedConfig {
+    token: string;
+    endpoint: string;
+    environment: string;
+    release: string;
+    serverName: string;
+    autoCapture: {
+        uncaughtExceptions: boolean;
+        unhandledRejections: boolean;
+        console: boolean;
+    };
+    breadcrumbs: {
+        enabled: boolean;
+        maxBreadcrumbs: number;
+        http: boolean;
+        console: boolean;
+    };
+    beforeSend?: (event: ErrorEvent) => ErrorEvent | null | Promise<ErrorEvent | null>;
+    ignoreErrors: (string | RegExp)[];
+    maxRetries: number;
+    timeout: number;
+    debug: boolean;
+    hmacSecret?: string;
+    exitOnUncaughtException: boolean;
+}
+interface RequestWithErrorExplorer extends IncomingMessage {
+    errorExplorer?: {
+        transaction?: string;
+        user?: UserContext;
+        tags?: Record<string, string>;
+        extra?: Record<string, unknown>;
+        startTime?: number;
+    };
+}
+type ExpressRequest = RequestWithErrorExplorer & {
+    body?: unknown;
+    query?: Record<string, string>;
+    params?: Record<string, string>;
+    cookies?: Record<string, string>;
+    path?: string;
+    originalUrl?: string;
+    ip?: string;
+    ips?: string[];
+};
+type ExpressResponse = ServerResponse & {
+    statusCode: number;
+};
+type ExpressNextFunction = (error?: Error | unknown) => void;
+type ExpressMiddleware = (req: ExpressRequest, res: ExpressResponse, next: ExpressNextFunction) => void;
+type ExpressErrorMiddleware = (error: Error, req: ExpressRequest, res: ExpressResponse, next: ExpressNextFunction) => void;
+
+export type { Breadcrumb as B, CaptureContext as C, ExpressRequest as E, InitOptions as I, OsContext as O, ProcessContext as P, QueuedEvent as Q, ResolvedConfig as R, SeverityLevel as S, TransportOptions as T, UserContext as U, InternalBreadcrumb as a, RuntimeContext as b, ServerContext as c, RequestContext as d, StackFrame as e, BreadcrumbType as f, BreadcrumbLevel as g, ErrorEvent as h, SdkInfo as i, ExpressResponse as j, ExpressNextFunction as k, ExpressMiddleware as l, ExpressErrorMiddleware as m };

package/package.json

@@ -0,0 +1,78 @@
+{
+  "name": "@error-explorer/node",
+  "version": "1.1.1",
+  "type": "module",
+  "description": "Error Explorer SDK for Node.js - Automatic error tracking and monitoring",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./express": {
+      "types": "./dist/middleware/express.d.ts",
+      "import": "./dist/middleware/express.js",
+      "require": "./dist/middleware/express.cjs"
+    },
+    "./http": {
+      "types": "./dist/middleware/http.d.ts",
+      "import": "./dist/middleware/http.js",
+      "require": "./dist/middleware/http.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "build:watch": "tsup --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "lint": "eslint src --ext .ts",
+    "lint:fix": "eslint src --ext .ts --fix",
+    "typecheck": "tsc --noEmit",
+    "clean": "rm -rf dist",
+    "prepublishOnly": "npm run clean && npm run build"
+  },
+  "keywords": [
+    "error",
+    "tracking",
+    "monitoring",
+    "nodejs",
+    "express",
+    "error-explorer",
+    "breadcrumbs",
+    "logging",
+    "crash-reporting",
+    "exception-handling"
+  ],
+  "author": "Error Explorer",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Error-Explorer/SDKs.git",
+    "directory": "core/node"
+  },
+  "bugs": {
+    "url": "https://github.com/Error-Explorer/SDKs/issues"
+  },
+  "homepage": "https://github.com/Error-Explorer/SDKs/tree/main/core/node#readme",
+  "devDependencies": {
+    "@types/node": "^20.10.0",
+    "@typescript-eslint/eslint-plugin": "^6.13.0",
+    "@typescript-eslint/parser": "^6.13.0",
+    "@vitest/coverage-v8": "^1.1.0",
+    "eslint": "^8.55.0",
+    "tsup": "^8.0.1",
+    "typescript": "^5.3.0",
+    "vitest": "^1.1.0"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "sideEffects": false
+}