brakit 0.6.0

package/dist/index.d.ts

@@ -0,0 +1,203 @@
+import { IncomingMessage, ServerResponse, Server } from 'node:http';
+
+type HttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" | "OPTIONS" | (string & {});
+type FlatHeaders = Record<string, string>;
+interface TracedRequest {
+    id: string;
+    method: HttpMethod;
+    url: string;
+    path: string;
+    headers: FlatHeaders;
+    requestBody: string | null;
+    statusCode: number;
+    responseHeaders: FlatHeaders;
+    responseBody: string | null;
+    startedAt: number;
+    durationMs: number;
+    responseSize: number;
+    isStatic: boolean;
+}
+type RequestListener = (req: TracedRequest) => void;
+
+type Framework = "nextjs" | "remix" | "nuxt" | "vite" | "astro" | "custom" | "unknown";
+interface DetectedProject {
+    framework: Framework;
+    devCommand: string;
+    devBin: string;
+    defaultPort: number;
+    packageManager: "npm" | "yarn" | "pnpm" | "bun" | "unknown";
+}
+interface BrakitConfig {
+    proxyPort: number;
+    targetPort: number;
+    showStatic: boolean;
+    maxBodyCapture: number;
+    customCommand?: string;
+}
+
+type RequestCategory = "auth-handshake" | "auth-check" | "middleware" | "server-action" | "api-call" | "data-fetch" | "page-load" | "navigation" | "polling" | "static" | "unknown";
+interface LabeledRequest extends TracedRequest {
+    label: string;
+    category: RequestCategory;
+    sourcePage?: string;
+    isDuplicate?: boolean;
+    isStrictModeDupe?: boolean;
+    pollingCount?: number;
+    pollingDurationMs?: number;
+}
+interface RequestFlow {
+    id: string;
+    label: string;
+    requests: LabeledRequest[];
+    startTime: number;
+    totalDurationMs: number;
+    hasErrors: boolean;
+    warnings: string[];
+    sourcePage: string;
+    redundancyPct: number;
+}
+
+interface TelemetryEntry {
+    id: string;
+    parentRequestId: string | null;
+    timestamp: number;
+}
+interface TracedFetch extends TelemetryEntry {
+    url: string;
+    method: string;
+    statusCode: number;
+    durationMs: number;
+}
+interface TracedLog extends TelemetryEntry {
+    level: "log" | "warn" | "error" | "info" | "debug";
+    message: string;
+}
+interface TracedError extends TelemetryEntry {
+    name: string;
+    message: string;
+    stack: string;
+}
+type NormalizedOp = "SELECT" | "INSERT" | "UPDATE" | "DELETE" | "OTHER";
+interface TracedQuery extends TelemetryEntry {
+    driver: "pg" | "mysql2" | "prisma" | string;
+    sql?: string;
+    model?: string;
+    operation?: string;
+    durationMs: number;
+    rowCount?: number;
+    normalizedOp?: NormalizedOp;
+    table?: string;
+    source?: string;
+}
+type TelemetryEvent = {
+    type: "fetch";
+    data: Omit<TracedFetch, "id">;
+} | {
+    type: "log";
+    data: Omit<TracedLog, "id">;
+} | {
+    type: "error";
+    data: Omit<TracedError, "id">;
+} | {
+    type: "query";
+    data: Omit<TracedQuery, "id">;
+};
+
+type SecuritySeverity = "critical" | "warning" | "info";
+interface SecurityFinding {
+    severity: SecuritySeverity;
+    rule: string;
+    title: string;
+    desc: string;
+    hint: string;
+    endpoint: string;
+    count: number;
+}
+
+interface BrakitAdapter {
+    name: string;
+    detect(): boolean;
+    patch(emit: (event: TelemetryEvent) => void): void;
+    unpatch?(): void;
+}
+
+interface SecurityContext {
+    requests: readonly TracedRequest[];
+    logs: readonly TracedLog[];
+}
+interface SecurityRule {
+    id: string;
+    severity: SecuritySeverity;
+    name: string;
+    hint: string;
+    check(ctx: SecurityContext): SecurityFinding[];
+}
+
+declare class SecurityScanner {
+    private rules;
+    register(rule: SecurityRule): void;
+    scan(ctx: SecurityContext): SecurityFinding[];
+    getRules(): readonly SecurityRule[];
+}
+declare function createDefaultScanner(): SecurityScanner;
+
+type InsightSeverity = "critical" | "warning" | "info";
+type InsightType = "n1" | "cross-endpoint" | "redundant-query" | "error" | "error-hotspot" | "duplicate" | "slow" | "query-heavy" | "auth-overhead" | "select-star" | "high-rows" | "large-response" | "security";
+interface Insight {
+    severity: InsightSeverity;
+    type: InsightType;
+    title: string;
+    desc: string;
+    hint: string;
+    detail?: string;
+    nav?: string;
+}
+interface InsightContext {
+    requests: readonly TracedRequest[];
+    queries: readonly TracedQuery[];
+    errors: readonly TracedError[];
+    flows: readonly RequestFlow[];
+    securityFindings?: readonly SecurityFinding[];
+}
+declare function computeInsights(ctx: InsightContext): Insight[];
+
+type DashboardHandler = (req: IncomingMessage, res: ServerResponse, config: BrakitConfig) => void;
+declare function createProxyServer(config: BrakitConfig, handleDashboard: DashboardHandler): Server;
+
+declare function detectProject(rootDir: string): Promise<DetectedProject>;
+
+declare class AdapterRegistry {
+    private adapters;
+    private active;
+    register(adapter: BrakitAdapter): void;
+    patchAll(emit: (event: TelemetryEvent) => void): void;
+    unpatchAll(): void;
+    getActive(): readonly BrakitAdapter[];
+}
+
+type AnalysisListener = (insights: Insight[], findings: SecurityFinding[]) => void;
+declare class AnalysisEngine {
+    private debounceMs;
+    private scanner;
+    private cachedInsights;
+    private cachedFindings;
+    private debounceTimer;
+    private listeners;
+    private boundRequestListener;
+    private boundQueryListener;
+    private boundErrorListener;
+    private boundLogListener;
+    constructor(debounceMs?: number);
+    start(): void;
+    stop(): void;
+    onUpdate(fn: AnalysisListener): void;
+    offUpdate(fn: AnalysisListener): void;
+    getInsights(): readonly Insight[];
+    getFindings(): readonly SecurityFinding[];
+    private scheduleRecompute;
+    recompute(): void;
+}
+
+declare const VERSION: string;
+
+export { AdapterRegistry, AnalysisEngine, type BrakitAdapter, type BrakitConfig, type DetectedProject, type FlatHeaders, type Framework, type HttpMethod, type Insight, type InsightContext, type NormalizedOp, type RequestCategory, type RequestListener, type SecurityContext, type SecurityFinding, type SecurityRule, SecurityScanner, type SecuritySeverity, type TracedRequest, VERSION, computeInsights, createDefaultScanner, createProxyServer, detectProject };