@crashsense/types 0.1.0

package/dist/index.d.mts

@@ -0,0 +1,354 @@
+type CrashCategory = 'runtime_error' | 'memory_issue' | 'event_loop_blocking' | 'framework_react' | 'framework_vue' | 'network_induced' | 'iframe_overload' | 'rendering' | 'mobile_device' | 'resource_exhaustion' | 'browser_compatibility';
+type CrashSeverity = 'critical' | 'error' | 'warning' | 'info';
+interface StackFrame {
+    filename: string;
+    function: string;
+    lineno: number;
+    colno: number;
+    inApp: boolean;
+    context?: string[];
+}
+type BreadcrumbType = 'click' | 'navigation' | 'network' | 'console' | 'state' | 'custom';
+interface Breadcrumb {
+    type: BreadcrumbType;
+    timestamp: number;
+    message: string;
+    data?: Record<string, unknown>;
+}
+type MemoryTrend = 'stable' | 'growing' | 'shrinking' | 'spike';
+interface MemoryState {
+    usedJSHeapSize: number | null;
+    totalJSHeapSize: number | null;
+    heapSizeLimit: number | null;
+    trend: MemoryTrend;
+    utilizationPercent: number | null;
+}
+interface CpuState {
+    longTasksLast30s: number;
+    avgLongTaskDuration: number;
+    maxLongTaskDuration: number;
+    estimatedBlockingTime: number;
+}
+interface EventLoopState {
+    isBlocked: boolean;
+    blockDuration: number | null;
+    fps: number;
+}
+interface NetworkState {
+    pendingRequests: number;
+    failedRequestsLast60s: number;
+    avgLatencyLast60s: number;
+    connectionType: string | null;
+    isOnline: boolean;
+}
+interface IframeState {
+    totalCount: number;
+    addedLast60s: number;
+    removedLast60s: number;
+    origins: string[];
+    crossOriginCount: number;
+}
+interface SystemState {
+    memory: MemoryState;
+    cpu: CpuState;
+    eventLoop: EventLoopState;
+    network: NetworkState;
+    iframe?: IframeState;
+}
+interface DeviceInfo {
+    userAgent: string;
+    platform: string;
+    vendor: string;
+    deviceMemory: number | null;
+    hardwareConcurrency: number | null;
+    viewport: {
+        width: number;
+        height: number;
+    };
+    devicePixelRatio: number;
+    touchSupport: boolean;
+    colorScheme: 'light' | 'dark';
+    reducedMotion: boolean;
+    language: string;
+    timezone: string;
+}
+interface FrameworkContext {
+    name: 'react' | 'vue' | 'vanilla' | string;
+    version: string;
+    adapter: string;
+    componentTree?: string[];
+    currentRoute?: string;
+    storeState?: Record<string, unknown>;
+    lifecycleStage?: string;
+    renderCount?: number;
+}
+interface ContributingFactor {
+    factor: string;
+    weight: number;
+    evidence: string;
+}
+interface CrashEvent {
+    id: string;
+    fingerprint: string;
+    timestamp: number;
+    sessionId: string;
+    category: CrashCategory;
+    subcategory: string;
+    severity: CrashSeverity;
+    confidence: number;
+    error: {
+        type: string;
+        message: string;
+        stack: StackFrame[];
+        raw: string;
+    };
+    system: SystemState;
+    device: DeviceInfo;
+    framework: FrameworkContext;
+    breadcrumbs: Breadcrumb[];
+    contributingFactors: ContributingFactor[];
+    meta: CrashEventMeta;
+}
+interface CrashEventMeta {
+    appId: string;
+    environment: string;
+    release?: string;
+    userId?: string;
+    tags: Record<string, string>;
+    sdkVersion: string;
+}
+interface RawCrashEvent {
+    id: string;
+    timestamp: number;
+    sessionId: string;
+    error: {
+        type: string;
+        message: string;
+        stack: StackFrame[];
+        raw: string;
+    };
+    system: Partial<SystemState>;
+    device: DeviceInfo;
+    framework: Partial<FrameworkContext>;
+    breadcrumbs: Breadcrumb[];
+    meta: CrashEventMeta;
+}
+interface CrashSenseConfig {
+    appId: string;
+    environment?: string;
+    release?: string;
+    sampleRate?: number;
+    maxEventsPerMinute?: number;
+    enableMemoryMonitoring?: boolean;
+    enableLongTaskMonitoring?: boolean;
+    enableNetworkMonitoring?: boolean;
+    enableIframeTracking?: boolean;
+    enablePreCrashWarning?: boolean;
+    preCrashMemoryThreshold?: number;
+    piiScrubbing?: boolean;
+    debug?: boolean;
+    onCrash?: (report: CrashReport) => void;
+}
+interface ResolvedConfig {
+    appId: string;
+    environment: string;
+    release: string;
+    sampleRate: number;
+    maxEventsPerMinute: number;
+    enableMemoryMonitoring: boolean;
+    enableLongTaskMonitoring: boolean;
+    enableNetworkMonitoring: boolean;
+    enableIframeTracking: boolean;
+    enablePreCrashWarning: boolean;
+    preCrashMemoryThreshold: number;
+    piiScrubbing: boolean;
+    debug: boolean;
+    onCrash: ((report: CrashReport) => void) | null;
+}
+interface CrashSensePlugin {
+    name: string;
+    setup(core: CrashSenseCore): void;
+    teardown(): void;
+    onCrashEvent?(event: CrashEvent): CrashEvent | null;
+}
+interface CrashSenseCore {
+    readonly config: ResolvedConfig;
+    readonly sessionId: string;
+    use(plugin: CrashSensePlugin): void;
+    captureException(error: unknown, context?: Record<string, unknown>): void;
+    captureMessage(message: string, severity?: CrashSeverity): void;
+    addBreadcrumb(breadcrumb: Omit<Breadcrumb, 'timestamp'>): void;
+    setUser(user: {
+        id: string;
+        [key: string]: unknown;
+    }): void;
+    setContext(key: string, value: Record<string, unknown>): void;
+    getSystemState(): SystemState;
+    getDeviceInfo(): DeviceInfo;
+    destroy(): void;
+    _reportRawEvent(event: RawCrashEvent): void;
+    _getEventBus(): EventBus;
+}
+type EventBusEventMap = {
+    'error': {
+        error: Error;
+        timestamp: number;
+    };
+    'unhandled_rejection': {
+        reason: unknown;
+        timestamp: number;
+    };
+    'memory_warning': {
+        utilization: number;
+        trend: MemoryTrend;
+        timestamp: number;
+    };
+    'long_task': {
+        duration: number;
+        startTime: number;
+        timestamp: number;
+    };
+    'network_failure': {
+        url: string;
+        status: number;
+        error: string;
+        timestamp: number;
+    };
+    'crash_detected': {
+        event: CrashEvent;
+    };
+    'iframe_added': {
+        src: string;
+        origin: string;
+        crossOrigin: boolean;
+        totalCount: number;
+        timestamp: number;
+    };
+    'iframe_removed': {
+        src: string;
+        totalCount: number;
+        timestamp: number;
+    };
+    'pre_crash_warning': {
+        level: PreCrashLevel;
+        memoryUtilization: number | null;
+        iframeCount: number;
+        reason: string;
+        timestamp: number;
+    };
+    'breadcrumb': Breadcrumb;
+};
+type PreCrashLevel = 'elevated' | 'critical' | 'imminent';
+interface EventBus {
+    on<K extends keyof EventBusEventMap>(event: K, handler: (data: EventBusEventMap[K]) => void): void;
+    off<K extends keyof EventBusEventMap>(event: K, handler: (data: EventBusEventMap[K]) => void): void;
+    emit<K extends keyof EventBusEventMap>(event: K, data: EventBusEventMap[K]): void;
+}
+interface CrashReport {
+    event: CrashEvent;
+    analysis: CrashAnalysis | null;
+    timestamp: number;
+}
+interface CrashAnalysis {
+    rootCause: string;
+    explanation: string;
+    fix: {
+        description: string;
+        code: string;
+        filename: string;
+    } | null;
+    prevention: string[];
+    confidence: number;
+    alternativeCauses: Array<{
+        cause: string;
+        likelihood: number;
+    }>;
+    source: 'heuristic' | 'ai' | 'hybrid';
+}
+interface AIConfig {
+    endpoint: string;
+    apiKey: string;
+    model?: string;
+    maxTokens?: number;
+    temperature?: number;
+    timeout?: number;
+    retries?: number;
+    provider?: 'openai' | 'anthropic' | 'google' | 'custom';
+}
+interface AIPayload {
+    crash_summary: {
+        category: CrashCategory;
+        subcategory: string;
+        heuristic_confidence: number;
+        severity: CrashSeverity;
+    };
+    error: {
+        type: string;
+        message: string;
+        stack_top_5: string[];
+        user_code_frames: string[];
+    };
+    system_state: {
+        memory_utilization: string;
+        memory_trend: MemoryTrend;
+        long_tasks_last_30s: number;
+        fps_at_crash: number;
+        pending_network_requests: number;
+        failed_requests_last_60s: number;
+    };
+    device: {
+        platform: string;
+        memory: string;
+        viewport: string;
+        connection: string;
+    };
+    framework: {
+        name: string;
+        version: string;
+        lifecycle_stage: string;
+        component_path: string[];
+        render_count_since_nav: number;
+    };
+    breadcrumbs_last_5: Array<{
+        type: BreadcrumbType;
+        message: string;
+        time: string;
+    }>;
+    contributing_factors: Array<{
+        factor: string;
+        weight: number;
+        evidence: string;
+    }>;
+}
+interface AIResponse {
+    rootCause: string;
+    explanation: string;
+    fix: {
+        description: string;
+        code: string;
+        filename: string;
+    };
+    prevention: string[];
+    confidence: number;
+    alternativeCauses: Array<{
+        cause: string;
+        likelihood: number;
+    }>;
+}
+interface NetworkRequest {
+    url: string;
+    method: string;
+    status: number;
+    duration: number;
+    startTime: number;
+    error: string | null;
+    responseSize: number | null;
+}
+interface ClassificationResult {
+    category: CrashCategory;
+    subcategory: string;
+    confidence: number;
+    contributingFactors: ContributingFactor[];
+}
+
+export type { AIConfig, AIPayload, AIResponse, Breadcrumb, BreadcrumbType, ClassificationResult, ContributingFactor, CpuState, CrashAnalysis, CrashCategory, CrashEvent, CrashEventMeta, CrashReport, CrashSenseConfig, CrashSenseCore, CrashSensePlugin, CrashSeverity, DeviceInfo, EventBus, EventBusEventMap, EventLoopState, FrameworkContext, IframeState, MemoryState, MemoryTrend, NetworkRequest, NetworkState, PreCrashLevel, RawCrashEvent, ResolvedConfig, StackFrame, SystemState };

package/dist/index.d.ts

@@ -0,0 +1,354 @@
+type CrashCategory = 'runtime_error' | 'memory_issue' | 'event_loop_blocking' | 'framework_react' | 'framework_vue' | 'network_induced' | 'iframe_overload' | 'rendering' | 'mobile_device' | 'resource_exhaustion' | 'browser_compatibility';
+type CrashSeverity = 'critical' | 'error' | 'warning' | 'info';
+interface StackFrame {
+    filename: string;
+    function: string;
+    lineno: number;
+    colno: number;
+    inApp: boolean;
+    context?: string[];
+}
+type BreadcrumbType = 'click' | 'navigation' | 'network' | 'console' | 'state' | 'custom';
+interface Breadcrumb {
+    type: BreadcrumbType;
+    timestamp: number;
+    message: string;
+    data?: Record<string, unknown>;
+}
+type MemoryTrend = 'stable' | 'growing' | 'shrinking' | 'spike';
+interface MemoryState {
+    usedJSHeapSize: number | null;
+    totalJSHeapSize: number | null;
+    heapSizeLimit: number | null;
+    trend: MemoryTrend;
+    utilizationPercent: number | null;
+}
+interface CpuState {
+    longTasksLast30s: number;
+    avgLongTaskDuration: number;
+    maxLongTaskDuration: number;
+    estimatedBlockingTime: number;
+}
+interface EventLoopState {
+    isBlocked: boolean;
+    blockDuration: number | null;
+    fps: number;
+}
+interface NetworkState {
+    pendingRequests: number;
+    failedRequestsLast60s: number;
+    avgLatencyLast60s: number;
+    connectionType: string | null;
+    isOnline: boolean;
+}
+interface IframeState {
+    totalCount: number;
+    addedLast60s: number;
+    removedLast60s: number;
+    origins: string[];
+    crossOriginCount: number;
+}
+interface SystemState {
+    memory: MemoryState;
+    cpu: CpuState;
+    eventLoop: EventLoopState;
+    network: NetworkState;
+    iframe?: IframeState;
+}
+interface DeviceInfo {
+    userAgent: string;
+    platform: string;
+    vendor: string;
+    deviceMemory: number | null;
+    hardwareConcurrency: number | null;
+    viewport: {
+        width: number;
+        height: number;
+    };
+    devicePixelRatio: number;
+    touchSupport: boolean;
+    colorScheme: 'light' | 'dark';
+    reducedMotion: boolean;
+    language: string;
+    timezone: string;
+}
+interface FrameworkContext {
+    name: 'react' | 'vue' | 'vanilla' | string;
+    version: string;
+    adapter: string;
+    componentTree?: string[];
+    currentRoute?: string;
+    storeState?: Record<string, unknown>;
+    lifecycleStage?: string;
+    renderCount?: number;
+}
+interface ContributingFactor {
+    factor: string;
+    weight: number;
+    evidence: string;
+}
+interface CrashEvent {
+    id: string;
+    fingerprint: string;
+    timestamp: number;
+    sessionId: string;
+    category: CrashCategory;
+    subcategory: string;
+    severity: CrashSeverity;
+    confidence: number;
+    error: {
+        type: string;
+        message: string;
+        stack: StackFrame[];
+        raw: string;
+    };
+    system: SystemState;
+    device: DeviceInfo;
+    framework: FrameworkContext;
+    breadcrumbs: Breadcrumb[];
+    contributingFactors: ContributingFactor[];
+    meta: CrashEventMeta;
+}
+interface CrashEventMeta {
+    appId: string;
+    environment: string;
+    release?: string;
+    userId?: string;
+    tags: Record<string, string>;
+    sdkVersion: string;
+}
+interface RawCrashEvent {
+    id: string;
+    timestamp: number;
+    sessionId: string;
+    error: {
+        type: string;
+        message: string;
+        stack: StackFrame[];
+        raw: string;
+    };
+    system: Partial<SystemState>;
+    device: DeviceInfo;
+    framework: Partial<FrameworkContext>;
+    breadcrumbs: Breadcrumb[];
+    meta: CrashEventMeta;
+}
+interface CrashSenseConfig {
+    appId: string;
+    environment?: string;
+    release?: string;
+    sampleRate?: number;
+    maxEventsPerMinute?: number;
+    enableMemoryMonitoring?: boolean;
+    enableLongTaskMonitoring?: boolean;
+    enableNetworkMonitoring?: boolean;
+    enableIframeTracking?: boolean;
+    enablePreCrashWarning?: boolean;
+    preCrashMemoryThreshold?: number;
+    piiScrubbing?: boolean;
+    debug?: boolean;
+    onCrash?: (report: CrashReport) => void;
+}
+interface ResolvedConfig {
+    appId: string;
+    environment: string;
+    release: string;
+    sampleRate: number;
+    maxEventsPerMinute: number;
+    enableMemoryMonitoring: boolean;
+    enableLongTaskMonitoring: boolean;
+    enableNetworkMonitoring: boolean;
+    enableIframeTracking: boolean;
+    enablePreCrashWarning: boolean;
+    preCrashMemoryThreshold: number;
+    piiScrubbing: boolean;
+    debug: boolean;
+    onCrash: ((report: CrashReport) => void) | null;
+}
+interface CrashSensePlugin {
+    name: string;
+    setup(core: CrashSenseCore): void;
+    teardown(): void;
+    onCrashEvent?(event: CrashEvent): CrashEvent | null;
+}
+interface CrashSenseCore {
+    readonly config: ResolvedConfig;
+    readonly sessionId: string;
+    use(plugin: CrashSensePlugin): void;
+    captureException(error: unknown, context?: Record<string, unknown>): void;
+    captureMessage(message: string, severity?: CrashSeverity): void;
+    addBreadcrumb(breadcrumb: Omit<Breadcrumb, 'timestamp'>): void;
+    setUser(user: {
+        id: string;
+        [key: string]: unknown;
+    }): void;
+    setContext(key: string, value: Record<string, unknown>): void;
+    getSystemState(): SystemState;
+    getDeviceInfo(): DeviceInfo;
+    destroy(): void;
+    _reportRawEvent(event: RawCrashEvent): void;
+    _getEventBus(): EventBus;
+}
+type EventBusEventMap = {
+    'error': {
+        error: Error;
+        timestamp: number;
+    };
+    'unhandled_rejection': {
+        reason: unknown;
+        timestamp: number;
+    };
+    'memory_warning': {
+        utilization: number;
+        trend: MemoryTrend;
+        timestamp: number;
+    };
+    'long_task': {
+        duration: number;
+        startTime: number;
+        timestamp: number;
+    };
+    'network_failure': {
+        url: string;
+        status: number;
+        error: string;
+        timestamp: number;
+    };
+    'crash_detected': {
+        event: CrashEvent;
+    };
+    'iframe_added': {
+        src: string;
+        origin: string;
+        crossOrigin: boolean;
+        totalCount: number;
+        timestamp: number;
+    };
+    'iframe_removed': {
+        src: string;
+        totalCount: number;
+        timestamp: number;
+    };
+    'pre_crash_warning': {
+        level: PreCrashLevel;
+        memoryUtilization: number | null;
+        iframeCount: number;
+        reason: string;
+        timestamp: number;
+    };
+    'breadcrumb': Breadcrumb;
+};
+type PreCrashLevel = 'elevated' | 'critical' | 'imminent';
+interface EventBus {
+    on<K extends keyof EventBusEventMap>(event: K, handler: (data: EventBusEventMap[K]) => void): void;
+    off<K extends keyof EventBusEventMap>(event: K, handler: (data: EventBusEventMap[K]) => void): void;
+    emit<K extends keyof EventBusEventMap>(event: K, data: EventBusEventMap[K]): void;
+}
+interface CrashReport {
+    event: CrashEvent;
+    analysis: CrashAnalysis | null;
+    timestamp: number;
+}
+interface CrashAnalysis {
+    rootCause: string;
+    explanation: string;
+    fix: {
+        description: string;
+        code: string;
+        filename: string;
+    } | null;
+    prevention: string[];
+    confidence: number;
+    alternativeCauses: Array<{
+        cause: string;
+        likelihood: number;
+    }>;
+    source: 'heuristic' | 'ai' | 'hybrid';
+}
+interface AIConfig {
+    endpoint: string;
+    apiKey: string;
+    model?: string;
+    maxTokens?: number;
+    temperature?: number;
+    timeout?: number;
+    retries?: number;
+    provider?: 'openai' | 'anthropic' | 'google' | 'custom';
+}
+interface AIPayload {
+    crash_summary: {
+        category: CrashCategory;
+        subcategory: string;
+        heuristic_confidence: number;
+        severity: CrashSeverity;
+    };
+    error: {
+        type: string;
+        message: string;
+        stack_top_5: string[];
+        user_code_frames: string[];
+    };
+    system_state: {
+        memory_utilization: string;
+        memory_trend: MemoryTrend;
+        long_tasks_last_30s: number;
+        fps_at_crash: number;
+        pending_network_requests: number;
+        failed_requests_last_60s: number;
+    };
+    device: {
+        platform: string;
+        memory: string;
+        viewport: string;
+        connection: string;
+    };
+    framework: {
+        name: string;
+        version: string;
+        lifecycle_stage: string;
+        component_path: string[];
+        render_count_since_nav: number;
+    };
+    breadcrumbs_last_5: Array<{
+        type: BreadcrumbType;
+        message: string;
+        time: string;
+    }>;
+    contributing_factors: Array<{
+        factor: string;
+        weight: number;
+        evidence: string;
+    }>;
+}
+interface AIResponse {
+    rootCause: string;
+    explanation: string;
+    fix: {
+        description: string;
+        code: string;
+        filename: string;
+    };
+    prevention: string[];
+    confidence: number;
+    alternativeCauses: Array<{
+        cause: string;
+        likelihood: number;
+    }>;
+}
+interface NetworkRequest {
+    url: string;
+    method: string;
+    status: number;
+    duration: number;
+    startTime: number;
+    error: string | null;
+    responseSize: number | null;
+}
+interface ClassificationResult {
+    category: CrashCategory;
+    subcategory: string;
+    confidence: number;
+    contributingFactors: ContributingFactor[];
+}
+
+export type { AIConfig, AIPayload, AIResponse, Breadcrumb, BreadcrumbType, ClassificationResult, ContributingFactor, CpuState, CrashAnalysis, CrashCategory, CrashEvent, CrashEventMeta, CrashReport, CrashSenseConfig, CrashSenseCore, CrashSensePlugin, CrashSeverity, DeviceInfo, EventBus, EventBusEventMap, EventLoopState, FrameworkContext, IframeState, MemoryState, MemoryTrend, NetworkRequest, NetworkState, PreCrashLevel, RawCrashEvent, ResolvedConfig, StackFrame, SystemState };

package/dist/index.js

@@ -0,0 +1,4 @@
+'use strict';
+
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.js"}

package/dist/index.mjs

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=index.mjs.map
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.mjs"}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@crashsense/types",
+  "version": "0.1.0",
+  "description": "Shared TypeScript type definitions for CrashSense",
+  "author": "hoainho <nhoxtvt@gmail.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hoainho/crashsense.git",
+    "directory": "packages/types"
+  },
+  "homepage": "https://github.com/hoainho/crashsense/tree/main/packages/types",
+  "bugs": {
+    "url": "https://github.com/hoainho/crashsense/issues"
+  },
+  "keywords": [
+    "crashsense",
+    "crash-detection",
+    "error-monitoring",
+    "typescript",
+    "types"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "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"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch"
+  },
+  "sideEffects": false
+}