@uncaughtdev/core 0.1.0

package/dist/types-CjgYXVc_.d.mts

@@ -0,0 +1,164 @@
+/** How captured events are delivered. */
+type TransportMode = 'remote' | 'local' | 'console';
+/** Severity levels mirroring syslog. */
+type SeverityLevel = 'fatal' | 'error' | 'warning' | 'info' | 'debug';
+/**
+ * Configuration object passed to `initUncaught()`.
+ */
+interface UncaughtConfig {
+    /** Project key used for authentication with the remote endpoint. */
+    projectKey?: string;
+    /** Remote ingestion endpoint URL. Required when transport is 'remote'. */
+    endpoint?: string;
+    /** Deployment environment label (e.g. "production", "staging"). */
+    environment?: string;
+    /** Release / version identifier. */
+    release?: string;
+    /** When true, the SDK logs internal debug information to the console. */
+    debug?: boolean;
+    /** Master kill-switch. When false the SDK is completely inert. Defaults to true. */
+    enabled?: boolean;
+    /** Maximum number of breadcrumbs retained in the ring buffer. Defaults to 20. */
+    maxBreadcrumbs?: number;
+    /** Rate-limit: max events accepted per 60-second sliding window. Defaults to 30. */
+    maxEventsPerMinute?: number;
+    /**
+     * Lifecycle hook invoked just before an event is sent.
+     * Return `null` to discard the event.
+     */
+    beforeSend?: (event: UncaughtEvent) => UncaughtEvent | null;
+    /** Additional key patterns to redact during sanitization. */
+    sanitizeKeys?: string[];
+    /**
+     * An array of strings or RegExp patterns.  If the error message matches any
+     * of these the event is silently dropped.
+     */
+    ignoreErrors?: Array<string | RegExp>;
+    /** Transport strategy. Defaults to 'local'. */
+    transport?: TransportMode;
+    /**
+     * Directory used by the local-file transport.
+     * Defaults to `process.cwd() + '/.uncaught'`.
+     */
+    localOutputDir?: string;
+}
+/** Structured representation of a captured error. */
+interface ErrorInfo {
+    message: string;
+    type: string;
+    stack?: string;
+    componentStack?: string;
+    raw?: unknown;
+}
+/** Contextual HTTP request information attached to an event. */
+interface RequestInfo {
+    method?: string;
+    url?: string;
+    headers?: Record<string, string>;
+    body?: unknown;
+    query?: Record<string, string>;
+}
+/** Information about a failed external operation (DB, auth, API, etc.). */
+interface OperationInfo {
+    provider: string;
+    type: string;
+    method: string;
+    params?: Record<string, unknown>;
+    errorCode?: string;
+    errorDetails?: string;
+}
+/** User context attached to events. */
+interface UserInfo {
+    id?: string;
+    email?: string;
+    username?: string;
+    [key: string]: unknown;
+}
+/** SDK metadata shipped with every event. */
+interface SdkInfo {
+    name: string;
+    version: string;
+}
+/**
+ * The canonical event payload sent to transports.
+ */
+interface UncaughtEvent {
+    eventId: string;
+    timestamp: string;
+    projectKey?: string;
+    level: SeverityLevel;
+    fingerprint: string;
+    error: ErrorInfo;
+    breadcrumbs: Breadcrumb[];
+    request?: RequestInfo;
+    operation?: OperationInfo;
+    environment?: EnvironmentInfo;
+    user?: UserInfo;
+    fixPrompt: string;
+    sdk: SdkInfo;
+}
+/** Breadcrumb categories. */
+type BreadcrumbType = 'click' | 'navigation' | 'api_call' | 'db_query' | 'auth' | 'console' | 'custom';
+/** A single breadcrumb entry. */
+interface Breadcrumb {
+    type: BreadcrumbType;
+    category: string;
+    message: string;
+    timestamp: string;
+    data?: Record<string, unknown>;
+    level?: SeverityLevel;
+}
+/** Public interface of the breadcrumb ring-buffer store. */
+interface BreadcrumbStore {
+    /** Append a breadcrumb (auto-timestamps). */
+    add(crumb: Omit<Breadcrumb, 'timestamp'>): void;
+    /** Return all stored breadcrumbs in chronological order (copies). */
+    getAll(): Breadcrumb[];
+    /** Return the most recent `n` breadcrumbs (copies). */
+    getLast(n: number): Breadcrumb[];
+    /** Empty the buffer. */
+    clear(): void;
+}
+/** Detected runtime / platform information. */
+interface EnvironmentInfo {
+    framework?: string;
+    frameworkVersion?: string;
+    runtime?: string;
+    runtimeVersion?: string;
+    platform?: string;
+    os?: string;
+    browser?: string;
+    browserVersion?: string;
+    deviceType?: string;
+    locale?: string;
+    timezone?: string;
+    url?: string;
+}
+/** Options used to configure a remote transport. */
+interface TransportOptions {
+    endpoint: string;
+    projectKey: string;
+    maxRetries?: number;
+    batchSize?: number;
+    flushIntervalMs?: number;
+}
+/** A transport implementation capable of delivering events. */
+interface Transport {
+    send(event: UncaughtEvent): void;
+    flush(): Promise<void>;
+}
+type IssueStatus = 'open' | 'resolved' | 'ignored';
+interface IssueEntry {
+    fingerprint: string;
+    title: string;
+    errorType: string;
+    count: number;
+    affectedUsers: string[];
+    firstSeen: string;
+    lastSeen: string;
+    status: IssueStatus;
+    fixPromptFile: string;
+    latestEventFile: string;
+}
+
+export type { Breadcrumb as B, EnvironmentInfo as E, IssueEntry as I, OperationInfo as O, RequestInfo as R, SeverityLevel as S, Transport as T, UncaughtEvent as U, UncaughtConfig as a, UserInfo as b, BreadcrumbStore as c, BreadcrumbType as d, ErrorInfo as e, IssueStatus as f, SdkInfo as g, TransportMode as h, TransportOptions as i };

package/dist/types-CjgYXVc_.d.ts

@@ -0,0 +1,164 @@
+/** How captured events are delivered. */
+type TransportMode = 'remote' | 'local' | 'console';
+/** Severity levels mirroring syslog. */
+type SeverityLevel = 'fatal' | 'error' | 'warning' | 'info' | 'debug';
+/**
+ * Configuration object passed to `initUncaught()`.
+ */
+interface UncaughtConfig {
+    /** Project key used for authentication with the remote endpoint. */
+    projectKey?: string;
+    /** Remote ingestion endpoint URL. Required when transport is 'remote'. */
+    endpoint?: string;
+    /** Deployment environment label (e.g. "production", "staging"). */
+    environment?: string;
+    /** Release / version identifier. */
+    release?: string;
+    /** When true, the SDK logs internal debug information to the console. */
+    debug?: boolean;
+    /** Master kill-switch. When false the SDK is completely inert. Defaults to true. */
+    enabled?: boolean;
+    /** Maximum number of breadcrumbs retained in the ring buffer. Defaults to 20. */
+    maxBreadcrumbs?: number;
+    /** Rate-limit: max events accepted per 60-second sliding window. Defaults to 30. */
+    maxEventsPerMinute?: number;
+    /**
+     * Lifecycle hook invoked just before an event is sent.
+     * Return `null` to discard the event.
+     */
+    beforeSend?: (event: UncaughtEvent) => UncaughtEvent | null;
+    /** Additional key patterns to redact during sanitization. */
+    sanitizeKeys?: string[];
+    /**
+     * An array of strings or RegExp patterns.  If the error message matches any
+     * of these the event is silently dropped.
+     */
+    ignoreErrors?: Array<string | RegExp>;
+    /** Transport strategy. Defaults to 'local'. */
+    transport?: TransportMode;
+    /**
+     * Directory used by the local-file transport.
+     * Defaults to `process.cwd() + '/.uncaught'`.
+     */
+    localOutputDir?: string;
+}
+/** Structured representation of a captured error. */
+interface ErrorInfo {
+    message: string;
+    type: string;
+    stack?: string;
+    componentStack?: string;
+    raw?: unknown;
+}
+/** Contextual HTTP request information attached to an event. */
+interface RequestInfo {
+    method?: string;
+    url?: string;
+    headers?: Record<string, string>;
+    body?: unknown;
+    query?: Record<string, string>;
+}
+/** Information about a failed external operation (DB, auth, API, etc.). */
+interface OperationInfo {
+    provider: string;
+    type: string;
+    method: string;
+    params?: Record<string, unknown>;
+    errorCode?: string;
+    errorDetails?: string;
+}
+/** User context attached to events. */
+interface UserInfo {
+    id?: string;
+    email?: string;
+    username?: string;
+    [key: string]: unknown;
+}
+/** SDK metadata shipped with every event. */
+interface SdkInfo {
+    name: string;
+    version: string;
+}
+/**
+ * The canonical event payload sent to transports.
+ */
+interface UncaughtEvent {
+    eventId: string;
+    timestamp: string;
+    projectKey?: string;
+    level: SeverityLevel;
+    fingerprint: string;
+    error: ErrorInfo;
+    breadcrumbs: Breadcrumb[];
+    request?: RequestInfo;
+    operation?: OperationInfo;
+    environment?: EnvironmentInfo;
+    user?: UserInfo;
+    fixPrompt: string;
+    sdk: SdkInfo;
+}
+/** Breadcrumb categories. */
+type BreadcrumbType = 'click' | 'navigation' | 'api_call' | 'db_query' | 'auth' | 'console' | 'custom';
+/** A single breadcrumb entry. */
+interface Breadcrumb {
+    type: BreadcrumbType;
+    category: string;
+    message: string;
+    timestamp: string;
+    data?: Record<string, unknown>;
+    level?: SeverityLevel;
+}
+/** Public interface of the breadcrumb ring-buffer store. */
+interface BreadcrumbStore {
+    /** Append a breadcrumb (auto-timestamps). */
+    add(crumb: Omit<Breadcrumb, 'timestamp'>): void;
+    /** Return all stored breadcrumbs in chronological order (copies). */
+    getAll(): Breadcrumb[];
+    /** Return the most recent `n` breadcrumbs (copies). */
+    getLast(n: number): Breadcrumb[];
+    /** Empty the buffer. */
+    clear(): void;
+}
+/** Detected runtime / platform information. */
+interface EnvironmentInfo {
+    framework?: string;
+    frameworkVersion?: string;
+    runtime?: string;
+    runtimeVersion?: string;
+    platform?: string;
+    os?: string;
+    browser?: string;
+    browserVersion?: string;
+    deviceType?: string;
+    locale?: string;
+    timezone?: string;
+    url?: string;
+}
+/** Options used to configure a remote transport. */
+interface TransportOptions {
+    endpoint: string;
+    projectKey: string;
+    maxRetries?: number;
+    batchSize?: number;
+    flushIntervalMs?: number;
+}
+/** A transport implementation capable of delivering events. */
+interface Transport {
+    send(event: UncaughtEvent): void;
+    flush(): Promise<void>;
+}
+type IssueStatus = 'open' | 'resolved' | 'ignored';
+interface IssueEntry {
+    fingerprint: string;
+    title: string;
+    errorType: string;
+    count: number;
+    affectedUsers: string[];
+    firstSeen: string;
+    lastSeen: string;
+    status: IssueStatus;
+    fixPromptFile: string;
+    latestEventFile: string;
+}
+
+export type { Breadcrumb as B, EnvironmentInfo as E, IssueEntry as I, OperationInfo as O, RequestInfo as R, SeverityLevel as S, Transport as T, UncaughtEvent as U, UncaughtConfig as a, UserInfo as b, BreadcrumbStore as c, BreadcrumbType as d, ErrorInfo as e, IssueStatus as f, SdkInfo as g, TransportMode as h, TransportOptions as i };

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@uncaughtdev/core",
+  "version": "0.1.0",
+  "description": "Core engine for Uncaught error monitoring — transport, breadcrumbs, and fix prompt generation",
+  "license": "MIT",
+  "author": "Uncaught",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/AjeeshDevops/uncaught.git",
+    "directory": "packages/core"
+  },
+  "homepage": "https://github.com/AjeeshDevops/uncaught#readme",
+  "keywords": [
+    "error",
+    "monitoring",
+    "debugging",
+    "error-tracking",
+    "developer-tools",
+    "vibe-coding",
+    "ai-debugging"
+  ],
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    },
+    "./local-api-handler": {
+      "types": "./dist/local-api-handler.d.ts",
+      "import": "./dist/local-api-handler.mjs",
+      "require": "./dist/local-api-handler.js"
+    },
+    "./local-api-handler/pages": {
+      "types": "./dist/local-api-handler-pages.d.ts",
+      "import": "./dist/local-api-handler-pages.mjs",
+      "require": "./dist/local-api-handler-pages.js"
+    }
+  },
+  "bin": {
+    "uncaught": "./dist/local-viewer.js"
+  },
+  "sideEffects": false,
+  "files": [
+    "dist"
+  ],
+  "devDependencies": {
+    "@types/node": "^25.3.3",
+    "tsup": "^8.0.0",
+    "typescript": "^5.4.0",
+    "vitest": "^1.6.0"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "vitest run",
+    "lint": "eslint src/",
+    "typecheck": "tsc --noEmit",
+    "clean": "rm -rf dist"
+  }
+}