@datasynx/agentic-ai-cartography 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,350 @@
+import { z } from 'zod';
+import { HookCallback } from '@anthropic-ai/claude-code';
+
+declare const NODE_TYPES: readonly ["host", "database_server", "database", "table", "web_service", "api_endpoint", "cache_server", "message_broker", "queue", "topic", "container", "pod", "k8s_cluster", "config_file", "unknown"];
+type NodeType = typeof NODE_TYPES[number];
+declare const EDGE_RELATIONSHIPS: readonly ["connects_to", "reads_from", "writes_to", "calls", "contains", "depends_on"];
+type EdgeRelationship = typeof EDGE_RELATIONSHIPS[number];
+declare const EVENT_TYPES: readonly ["process_start", "process_end", "connection_open", "connection_close", "window_focus", "tool_switch"];
+type EventType = typeof EVENT_TYPES[number];
+declare const NodeSchema: z.ZodObject<{
+    id: z.ZodString;
+    type: z.ZodEnum<["host", "database_server", "database", "table", "web_service", "api_endpoint", "cache_server", "message_broker", "queue", "topic", "container", "pod", "k8s_cluster", "config_file", "unknown"]>;
+    name: z.ZodString;
+    discoveredVia: z.ZodString;
+    confidence: z.ZodDefault<z.ZodNumber>;
+    metadata: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    tags: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    type: "host" | "database_server" | "database" | "table" | "web_service" | "api_endpoint" | "cache_server" | "message_broker" | "queue" | "topic" | "container" | "pod" | "k8s_cluster" | "config_file" | "unknown";
+    name: string;
+    discoveredVia: string;
+    confidence: number;
+    metadata: Record<string, unknown>;
+    tags: string[];
+}, {
+    id: string;
+    type: "host" | "database_server" | "database" | "table" | "web_service" | "api_endpoint" | "cache_server" | "message_broker" | "queue" | "topic" | "container" | "pod" | "k8s_cluster" | "config_file" | "unknown";
+    name: string;
+    discoveredVia: string;
+    confidence?: number | undefined;
+    metadata?: Record<string, unknown> | undefined;
+    tags?: string[] | undefined;
+}>;
+type DiscoveryNode = z.infer<typeof NodeSchema>;
+declare const EdgeSchema: z.ZodObject<{
+    sourceId: z.ZodString;
+    targetId: z.ZodString;
+    relationship: z.ZodEnum<["connects_to", "reads_from", "writes_to", "calls", "contains", "depends_on"]>;
+    evidence: z.ZodString;
+    confidence: z.ZodDefault<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    confidence: number;
+    sourceId: string;
+    targetId: string;
+    relationship: "connects_to" | "reads_from" | "writes_to" | "calls" | "contains" | "depends_on";
+    evidence: string;
+}, {
+    sourceId: string;
+    targetId: string;
+    relationship: "connects_to" | "reads_from" | "writes_to" | "calls" | "contains" | "depends_on";
+    evidence: string;
+    confidence?: number | undefined;
+}>;
+type DiscoveryEdge = z.infer<typeof EdgeSchema>;
+declare const EventSchema: z.ZodObject<{
+    eventType: z.ZodEnum<["process_start", "process_end", "connection_open", "connection_close", "window_focus", "tool_switch"]>;
+    process: z.ZodString;
+    pid: z.ZodNumber;
+    target: z.ZodOptional<z.ZodString>;
+    targetType: z.ZodOptional<z.ZodEnum<["host", "database_server", "database", "table", "web_service", "api_endpoint", "cache_server", "message_broker", "queue", "topic", "container", "pod", "k8s_cluster", "config_file", "unknown"]>>;
+    protocol: z.ZodOptional<z.ZodString>;
+    port: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    eventType: "process_start" | "process_end" | "connection_open" | "connection_close" | "window_focus" | "tool_switch";
+    process: string;
+    pid: number;
+    target?: string | undefined;
+    targetType?: "host" | "database_server" | "database" | "table" | "web_service" | "api_endpoint" | "cache_server" | "message_broker" | "queue" | "topic" | "container" | "pod" | "k8s_cluster" | "config_file" | "unknown" | undefined;
+    protocol?: string | undefined;
+    port?: number | undefined;
+}, {
+    eventType: "process_start" | "process_end" | "connection_open" | "connection_close" | "window_focus" | "tool_switch";
+    process: string;
+    pid: number;
+    target?: string | undefined;
+    targetType?: "host" | "database_server" | "database" | "table" | "web_service" | "api_endpoint" | "cache_server" | "message_broker" | "queue" | "topic" | "container" | "pod" | "k8s_cluster" | "config_file" | "unknown" | undefined;
+    protocol?: string | undefined;
+    port?: number | undefined;
+}>;
+type ActivityEvent = z.infer<typeof EventSchema>;
+declare const SOPStepSchema: z.ZodObject<{
+    order: z.ZodNumber;
+    instruction: z.ZodString;
+    tool: z.ZodString;
+    target: z.ZodOptional<z.ZodString>;
+    notes: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    order: number;
+    instruction: string;
+    tool: string;
+    target?: string | undefined;
+    notes?: string | undefined;
+}, {
+    order: number;
+    instruction: string;
+    tool: string;
+    target?: string | undefined;
+    notes?: string | undefined;
+}>;
+type SOPStep = z.infer<typeof SOPStepSchema>;
+declare const SOPSchema: z.ZodObject<{
+    title: z.ZodString;
+    description: z.ZodString;
+    steps: z.ZodArray<z.ZodObject<{
+        order: z.ZodNumber;
+        instruction: z.ZodString;
+        tool: z.ZodString;
+        target: z.ZodOptional<z.ZodString>;
+        notes: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        order: number;
+        instruction: string;
+        tool: string;
+        target?: string | undefined;
+        notes?: string | undefined;
+    }, {
+        order: number;
+        instruction: string;
+        tool: string;
+        target?: string | undefined;
+        notes?: string | undefined;
+    }>, "many">;
+    involvedSystems: z.ZodArray<z.ZodString, "many">;
+    estimatedDuration: z.ZodString;
+    frequency: z.ZodString;
+    confidence: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    confidence: number;
+    title: string;
+    description: string;
+    steps: {
+        order: number;
+        instruction: string;
+        tool: string;
+        target?: string | undefined;
+        notes?: string | undefined;
+    }[];
+    involvedSystems: string[];
+    estimatedDuration: string;
+    frequency: string;
+}, {
+    confidence: number;
+    title: string;
+    description: string;
+    steps: {
+        order: number;
+        instruction: string;
+        tool: string;
+        target?: string | undefined;
+        notes?: string | undefined;
+    }[];
+    involvedSystems: string[];
+    estimatedDuration: string;
+    frequency: string;
+}>;
+type SOP = z.infer<typeof SOPSchema>;
+interface NodeRow extends DiscoveryNode {
+    sessionId: string;
+    discoveredAt: string;
+    depth: number;
+    pathId?: string;
+}
+interface EdgeRow extends DiscoveryEdge {
+    id: string;
+    sessionId: string;
+    discoveredAt: string;
+    pathId?: string;
+}
+interface EventRow {
+    id: string;
+    sessionId: string;
+    taskId?: string;
+    timestamp: string;
+    eventType: EventType;
+    process: string;
+    pid: number;
+    target?: string;
+    targetType?: NodeType;
+    port?: number;
+    durationMs?: number;
+}
+interface TaskRow {
+    id: string;
+    sessionId: string;
+    description?: string;
+    startedAt: string;
+    completedAt?: string;
+    steps: string;
+    involvedServices: string;
+    status: 'active' | 'completed' | 'cancelled';
+    isSOPCandidate: boolean;
+}
+interface WorkflowRow {
+    id: string;
+    sessionId: string;
+    name?: string;
+    pattern: string;
+    taskIds: string;
+    occurrences: number;
+    firstSeen: string;
+    lastSeen: string;
+    avgDurationMs: number;
+    involvedServices: string;
+}
+interface SessionRow {
+    id: string;
+    mode: 'discover' | 'shadow';
+    startedAt: string;
+    completedAt?: string;
+    config: string;
+}
+type DaemonMessage = {
+    type: 'event';
+    data: EventRow;
+} | {
+    type: 'prompt';
+    id: string;
+    prompt: PendingPrompt;
+} | {
+    type: 'status';
+    data: ShadowStatus;
+} | {
+    type: 'agent-output';
+    text: string;
+} | {
+    type: 'info';
+    message: string;
+};
+type ClientMessage = {
+    type: 'prompt-response';
+    id: string;
+    answer: string;
+} | {
+    type: 'command';
+    command: 'new-task' | 'end-task' | 'status' | 'stop';
+} | {
+    type: 'task-description';
+    description: string;
+};
+interface PendingPrompt {
+    kind: 'node-approval' | 'task-boundary' | 'task-end';
+    context: Record<string, unknown>;
+    options: string[];
+    defaultAnswer: string;
+    timeoutMs: number;
+    createdAt: string;
+}
+interface ShadowStatus {
+    pid: number;
+    uptime: number;
+    nodeCount: number;
+    eventCount: number;
+    taskCount: number;
+    pendingPrompts: number;
+    autoSave: boolean;
+    mode: 'foreground' | 'daemon';
+    agentActive: boolean;
+    cyclesRun: number;
+    cyclesSkipped: number;
+}
+declare const MIN_POLL_INTERVAL_MS = 15000;
+interface CartographyConfig {
+    mode: 'discover' | 'shadow';
+    maxDepth: number;
+    maxTurns: number;
+    entryPoints: string[];
+    agentModel: string;
+    shadowMode: 'foreground' | 'daemon';
+    pollIntervalMs: number;
+    inactivityTimeoutMs: number;
+    promptTimeoutMs: number;
+    trackWindowFocus: boolean;
+    autoSaveNodes: boolean;
+    enableNotifications: boolean;
+    shadowModel: string;
+    organization?: string;
+    outputDir: string;
+    dbPath: string;
+    socketPath: string;
+    pidFile: string;
+    verbose: boolean;
+}
+declare function defaultConfig(overrides?: Partial<CartographyConfig>): CartographyConfig;
+
+declare class CartographyDB {
+    private db;
+    constructor(dbPath: string);
+    private migrate;
+    close(): void;
+    createSession(mode: 'discover' | 'shadow', config: CartographyConfig): string;
+    endSession(id: string): void;
+    getSession(id: string): SessionRow | undefined;
+    getLatestSession(mode?: string): SessionRow | undefined;
+    getSessions(): SessionRow[];
+    private mapSession;
+    upsertNode(sessionId: string, node: DiscoveryNode, depth?: number): void;
+    getNodes(sessionId: string): NodeRow[];
+    insertEdge(sessionId: string, edge: DiscoveryEdge): void;
+    getEdges(sessionId: string): EdgeRow[];
+    insertEvent(sessionId: string, event: ActivityEvent, taskId?: string): void;
+    getEvents(sessionId: string, since?: string): EventRow[];
+    startTask(sessionId: string, description?: string): string;
+    endCurrentTask(sessionId: string): void;
+    updateTaskDescription(sessionId: string, description: string): void;
+    getActiveTask(sessionId: string): TaskRow | undefined;
+    getTasks(sessionId: string): TaskRow[];
+    private mapTask;
+    insertWorkflow(sessionId: string, data: Omit<WorkflowRow, 'id'>): void;
+    getWorkflows(sessionId: string): WorkflowRow[];
+    insertSOP(sop: {
+        workflowId: string;
+    } & SOP): void;
+    getSOPs(sessionId: string): Array<SOP & {
+        id: string;
+        workflowId: string;
+    }>;
+    setApproval(pattern: string, action: 'save' | 'ignore' | 'auto'): void;
+    getApproval(pattern: string): string | undefined;
+    getStats(sessionId: string): {
+        nodes: number;
+        edges: number;
+        events: number;
+        tasks: number;
+    };
+}
+
+type McpServer = any;
+declare function stripSensitive(target: string): string;
+declare function createCartographyTools(db: CartographyDB, sessionId: string): Promise<McpServer>;
+
+declare const safetyHook: HookCallback;
+
+declare function runDiscovery(config: CartographyConfig, db: CartographyDB, sessionId: string, onOutput?: (text: string) => void): Promise<void>;
+declare function runShadowCycle(config: CartographyConfig, db: CartographyDB, sessionId: string, prevSnapshot: string, currSnapshot: string, onOutput?: (msg: unknown) => void): Promise<void>;
+declare function generateSOPs(db: CartographyDB, sessionId: string): Promise<number>;
+
+declare function generateTopologyMermaid(nodes: NodeRow[], edges: EdgeRow[]): string;
+declare function generateDependencyMermaid(nodes: NodeRow[], edges: EdgeRow[]): string;
+declare function generateWorkflowMermaid(sop: SOP): string;
+declare function exportBackstageYAML(nodes: NodeRow[], edges: EdgeRow[], org?: string): string;
+declare function exportJSON(db: CartographyDB, sessionId: string): string;
+declare function exportHTML(nodes: NodeRow[], edges: EdgeRow[]): string;
+declare function exportSOPMarkdown(sop: SOP): string;
+declare function exportAll(db: CartographyDB, sessionId: string, outputDir: string, formats?: string[]): void;
+
+declare function checkPrerequisites(): void;
+declare function checkPollInterval(intervalMs: number): number;
+
+export { type ActivityEvent, type CartographyConfig, CartographyDB, type ClientMessage, type DaemonMessage, type DiscoveryEdge, type DiscoveryNode, EDGE_RELATIONSHIPS, EVENT_TYPES, type EdgeRelationship, type EdgeRow, EdgeSchema, type EventRow, EventSchema, type EventType, MIN_POLL_INTERVAL_MS, NODE_TYPES, type NodeRow, NodeSchema, type NodeType, type PendingPrompt, type SOP, SOPSchema, type SOPStep, SOPStepSchema, type SessionRow, type ShadowStatus, type TaskRow, type WorkflowRow, checkPollInterval, checkPrerequisites, createCartographyTools, CartographyDB as default, defaultConfig, exportAll, exportBackstageYAML, exportHTML, exportJSON, exportSOPMarkdown, generateDependencyMermaid, generateSOPs, generateTopologyMermaid, generateWorkflowMermaid, runDiscovery, runShadowCycle, safetyHook, stripSensitive };