@prbe.ai/electron-sdk 0.1.3 → 0.1.5

package/dist/types-DHT-JxMT.d.mts

@@ -0,0 +1,401 @@
+import { EventEmitter } from 'events';
+
+/**
+ * interactions.ts — Types for user interaction during investigations
+ *
+ * Defines the contract between tools (which request interactions) and
+ * host apps (which present UI and collect responses).
+ */
+declare enum InteractionType {
+    ASK_QUESTION = "ask_question",
+    REQUEST_PERMISSION = "request_permission",
+    REQUEST_PATH_ACCESS = "request_path_access"
+}
+interface AskQuestionPayload {
+    type: InteractionType.ASK_QUESTION;
+    interactionId: string;
+    question: string;
+    context?: string;
+}
+interface RequestPermissionPayload {
+    type: InteractionType.REQUEST_PERMISSION;
+    interactionId: string;
+    action: string;
+    command: string;
+    reason?: string;
+}
+interface RequestPathAccessPayload {
+    type: InteractionType.REQUEST_PATH_ACCESS;
+    interactionId: string;
+    path: string;
+    reason: string;
+}
+type InteractionPayload = AskQuestionPayload | RequestPermissionPayload | RequestPathAccessPayload;
+interface AskQuestionResponse {
+    type: InteractionType.ASK_QUESTION;
+    answer: string;
+}
+interface RequestPermissionResponse {
+    type: InteractionType.REQUEST_PERMISSION;
+    approved: boolean;
+}
+interface RequestPathAccessResponse {
+    type: InteractionType.REQUEST_PATH_ACCESS;
+    granted: boolean;
+}
+type InteractionResponse = AskQuestionResponse | RequestPermissionResponse | RequestPathAccessResponse;
+declare enum InvestigationSource {
+    USER = "user",
+    CONTEXT_REQUEST = "context_request"
+}
+interface PRBEInteractionRequester {
+    requestUserInteraction(payload: InteractionPayload): Promise<InteractionResponse>;
+    readonly investigationSource: InvestigationSource;
+}
+interface PRBEInteractionHandler {
+    handleInteraction(payload: InteractionPayload): Promise<InteractionResponse>;
+}
+interface ResolvedInteraction {
+    interactionId: string;
+    payload: InteractionPayload;
+    response: InteractionResponse;
+    /** Number of events at time of resolution — used to split thinking bubbles */
+    eventIndex: number;
+}
+
+/**
+ * models.ts — WSMessage, WSMessageType, tool types, config, errors
+ *
+ * All types must match the Swift SDK + middleware protocol exactly.
+ */
+declare enum WSMessageType {
+    START = "start",
+    TOOL_RESULT = "tool_result",
+    UPLOAD_REQUEST = "upload_request",
+    CANCEL = "cancel",
+    PONG = "pong",
+    THOUGHT = "thought",
+    TOOL_CALL = "tool_call",
+    SERVER_TOOL_CALL = "server_tool_call",
+    SERVER_OBSERVATION = "server_observation",
+    UPLOAD_URL = "upload_url",
+    SESSION_CONFIG = "session_config",
+    COMPLETE = "complete",
+    ERROR = "error",
+    PING = "ping"
+}
+interface WSMessage {
+    type: WSMessageType;
+    id?: string;
+    name?: string;
+    content?: string;
+    metadata?: Record<string, unknown>;
+}
+declare enum ToolParamType {
+    STRING = "STRING",
+    BOOLEAN = "BOOLEAN",
+    INTEGER = "INTEGER"
+}
+interface PRBEToolParameter {
+    name: string;
+    type: ToolParamType;
+    description: string;
+    required: boolean;
+}
+interface PRBEToolDeclaration {
+    name: string;
+    description: string;
+    parameters: PRBEToolParameter[];
+    /** When true, the middleware uses a longer timeout for this tool (user interaction required). */
+    interactive?: boolean;
+}
+declare enum ToolName {
+    CLIENT_LIST_DIRECTORY = "client_list_directory",
+    CLIENT_READ_FILE = "client_read_file",
+    CLIENT_SEARCH_CONTENT = "client_search_content",
+    CLIENT_FIND_FILES = "client_find_files",
+    CLIENT_FLAG_FILE = "client_flag_file",
+    CLIENT_READ_APP_LOGS = "client_read_app_logs",
+    CLIENT_SEARCH_APP_LOGS = "client_search_app_logs",
+    CLIENT_CLEAR_APP_LOGS = "client_clear_app_logs",
+    CLIENT_FLAG_APP_LOGS = "client_flag_app_logs",
+    CLIENT_ASK_USER = "client_ask_user",
+    CLIENT_BASH_EXECUTE = "client_bash_execute"
+}
+declare enum PRBEAgentConfigKey {
+    API_KEY = "apiKey",
+    AUTO_APPROVED_DIRS = "autoApprovedDirs",
+    POLLING_INTERVAL = "pollingInterval",
+    MAX_LOG_ENTRIES = "maxLogEntries",
+    CAPTURE_CONSOLE = "captureConsole",
+    BACKGROUND_POLLING = "backgroundPolling",
+    INTERACTION_HANDLER = "interactionHandler",
+    ELECTRON_LOG = "electronLog",
+    IPC_MAIN = "ipcMain",
+    RENDERER_LOG_CHANNEL = "rendererLogChannel",
+    APP_DATA_PATH = "appDataPath"
+}
+interface PRBEAgentConfig {
+    [PRBEAgentConfigKey.API_KEY]: string;
+    [PRBEAgentConfigKey.AUTO_APPROVED_DIRS]: string[];
+    [PRBEAgentConfigKey.POLLING_INTERVAL]?: number;
+    [PRBEAgentConfigKey.MAX_LOG_ENTRIES]?: number;
+    [PRBEAgentConfigKey.CAPTURE_CONSOLE]?: boolean;
+    [PRBEAgentConfigKey.BACKGROUND_POLLING]?: boolean;
+    [PRBEAgentConfigKey.INTERACTION_HANDLER]?: PRBEInteractionHandler;
+    /** electron-log instance (v5) — SDK hooks into its transports to capture main-process logs */
+    [PRBEAgentConfigKey.ELECTRON_LOG]?: {
+        hooks: {
+            push: (hook: (...args: any[]) => any) => void;
+        };
+    };
+    /** Electron ipcMain instance — SDK listens for renderer log forwarding */
+    [PRBEAgentConfigKey.IPC_MAIN]?: {
+        on: (channel: string, listener: (event: any, ...args: any[]) => void) => void;
+    };
+    /** IPC channel name for renderer log forwarding (default: "prbe-renderer-log") */
+    [PRBEAgentConfigKey.RENDERER_LOG_CHANNEL]?: string;
+    /** Path to the application's data directory (e.g. Electron userData). Sent to the agent so it explores this directory first. */
+    [PRBEAgentConfigKey.APP_DATA_PATH]?: string;
+}
+declare enum PRBEAgentStatusType {
+    STARTED = "started",
+    THINKING = "thinking",
+    TOOL_CALL = "tool_call",
+    THOUGHT = "thought",
+    OBSERVATION = "observation",
+    COMPLETED = "completed",
+    ERROR = "error",
+    AWAITING_INTERACTION = "awaiting_interaction"
+}
+type PRBEAgentStatus = {
+    type: PRBEAgentStatusType.STARTED;
+} | {
+    type: PRBEAgentStatusType.THINKING;
+} | {
+    type: PRBEAgentStatusType.TOOL_CALL;
+    name: string;
+    label: string;
+} | {
+    type: PRBEAgentStatusType.THOUGHT;
+    text: string;
+} | {
+    type: PRBEAgentStatusType.OBSERVATION;
+    text: string;
+} | {
+    type: PRBEAgentStatusType.COMPLETED;
+    report: string;
+    userSummary: string;
+} | {
+    type: PRBEAgentStatusType.ERROR;
+    message: string;
+} | {
+    type: PRBEAgentStatusType.AWAITING_INTERACTION;
+    interactionPayload: InteractionPayload;
+};
+interface InvestigationResult {
+    report: string;
+    userSummary: string;
+    ticketId?: string;
+}
+interface FlaggedFileIn {
+    originalPath: string;
+    reason?: string;
+    data: Buffer;
+    isText: boolean;
+}
+interface PollRequest {
+    agent_id: string;
+    ticket_ids: string[];
+}
+interface ContextRequestOut {
+    id: string;
+    query: string;
+    slug?: string;
+    is_active: boolean;
+    created_at: string;
+}
+interface TicketStatusOut {
+    ticket_id: string;
+    status: string;
+    context_requests: ContextRequestOut[];
+}
+interface PollResponse {
+    tickets: TicketStatusOut[];
+}
+interface TicketInfoRequest {
+    ticket_ids: string[];
+}
+interface TicketInfoOut {
+    ticket_id: string;
+    title: string;
+    status: string;
+    priority?: string;
+    description?: string;
+    session_count: number;
+}
+interface TicketInfoResponse {
+    tickets: TicketInfoOut[];
+}
+interface PRBEStatusEvent {
+    id: string;
+    label: string;
+    detail?: string;
+    isCompleted: boolean;
+    isExpanded: boolean;
+}
+interface PRBECRInvestigation {
+    id: string;
+    query: string;
+    slug?: string;
+    events: PRBEStatusEvent[];
+    isRunning: boolean;
+    isCompleted: boolean;
+    isFailed: boolean;
+    report: string;
+    summary: string;
+    errorMessage?: string;
+    startedAt: Date;
+    pendingInteraction?: InteractionPayload;
+    resolvedInteractions?: ResolvedInteraction[];
+}
+interface PRBECompletedInvestigation {
+    id: string;
+    query: string;
+    report: string;
+    summary: string;
+    completedAt: Date;
+}
+declare enum PRBEAgentErrorType {
+    SERVER_ERROR = "server_error",
+    NETWORK_ERROR = "network_error",
+    CANCELLED = "cancelled",
+    MAX_ITERATIONS = "max_iterations"
+}
+declare class PRBEAgentError extends Error {
+    readonly errorType: PRBEAgentErrorType;
+    readonly statusCode?: number;
+    constructor(errorType: PRBEAgentErrorType, message: string, statusCode?: number);
+}
+declare function redactPII(text: string): string;
+declare const API_URL = "https://api.prbe.ai";
+declare const MIDDLEWARE_URL = "wss://middleware.prbe.ai";
+
+/**
+ * state.ts — PRBEAgentState: EventEmitter-based observable investigation state
+ *
+ * Mirrors PRBEAgentState.swift but uses Node.js EventEmitter instead of Combine/@Published.
+ * Host apps subscribe to events for UI updates.
+ */
+
+declare enum PRBEStateEvent {
+    /** Emitted on any state change. Payload: void */
+    STATUS = "status",
+    /** Emitted when a new event is appended. Payload: PRBEStatusEvent */
+    EVENT = "event",
+    /** Emitted when investigation completes. Payload: { report: string; summary: string } */
+    COMPLETE = "complete",
+    /** Emitted on error. Payload: { message: string } */
+    ERROR = "error",
+    /** Emitted when a background CR starts. Payload: PRBECRInvestigation */
+    CR_START = "cr-start",
+    /** Emitted when a background CR completes/fails. Payload: PRBECRInvestigation */
+    CR_COMPLETE = "cr-complete",
+    /** Emitted when tracked ticket IDs change. Payload: string[] */
+    TICKETS_CHANGED = "tickets-changed",
+    /** Emitted when ticket info is updated. Payload: TicketInfoOut[] */
+    TICKET_INFO = "ticket-info",
+    /** Emitted when an interaction is requested. Payload: InteractionPayload */
+    INTERACTION_REQUESTED = "interaction-requested",
+    /** Emitted when an interaction is resolved. Payload: void */
+    INTERACTION_RESOLVED = "interaction-resolved"
+}
+declare class PRBEAgentState extends EventEmitter {
+    isInvestigating: boolean;
+    events: PRBEStatusEvent[];
+    report: string;
+    summary: string;
+    currentQuery: string;
+    investigationError?: string;
+    pendingInteraction?: InteractionPayload;
+    resolvedInteractions: ResolvedInteraction[];
+    completedInvestigations: PRBECompletedInvestigation[];
+    activeCRs: Map<string, PRBECRInvestigation>;
+    completedCRs: PRBECRInvestigation[];
+    trackedTicketIDs: string[];
+    ticketInfo: TicketInfoOut[];
+    get hasActiveWork(): boolean;
+    get activeCRCount(): number;
+    get isActive(): boolean;
+    beginInvestigation(query: string): void;
+    resetInvestigation(): void;
+    appendEvent(label: string, detail?: string, completed?: boolean): void;
+    attachObservation(text: string): void;
+    completeInvestigation(report: string, summary: string): void;
+    failInvestigation(message: string): void;
+    setPendingInteraction(payload: InteractionPayload): void;
+    clearPendingInteraction(): void;
+    setCRPendingInteraction(crID: string, payload: InteractionPayload): void;
+    clearCRPendingInteraction(crID: string): void;
+    resolveInteraction(response: InteractionResponse): void;
+    resolveCRInteraction(crID: string, response: InteractionResponse): void;
+    toggleExpansion(eventId: string): void;
+    beginCR(id: string, query: string, slug?: string): void;
+    appendCREvent(crID: string, label: string, detail?: string, completed?: boolean): void;
+    attachCRObservation(crID: string, text: string): void;
+    completeCR(id: string, report: string, summary: string): void;
+    failCR(id: string, message: string): void;
+    updateTrackedTicketIDs(ids: string[]): void;
+    updateTicketInfo(info: TicketInfoOut[]): void;
+}
+
+/**
+ * serialization.ts — IPC-safe serialization of agent state
+ *
+ * Converts live PRBEAgentState (with Map, Date, EventEmitter) into
+ * plain JSON-safe objects suitable for IPC or structured clone.
+ */
+
+interface PRBESerializedCR {
+    id: string;
+    query: string;
+    slug?: string;
+    events: PRBEStatusEvent[];
+    isRunning: boolean;
+    isCompleted: boolean;
+    isFailed: boolean;
+    report: string;
+    summary: string;
+    errorMessage?: string;
+    startedAt: string;
+    pendingInteraction?: InteractionPayload;
+    resolvedInteractions?: ResolvedInteraction[];
+}
+type PRBESerializedTicket = TicketInfoOut;
+interface PRBESerializedCompletedInvestigation {
+    id: string;
+    query: string;
+    report: string;
+    summary: string;
+    completedAt: string;
+}
+interface PRBESerializedState {
+    isInvestigating: boolean;
+    events: PRBEStatusEvent[];
+    report: string;
+    summary: string;
+    currentQuery: string;
+    investigationError?: string;
+    pendingInteraction?: InteractionPayload;
+    resolvedInteractions: ResolvedInteraction[];
+    completedInvestigations: PRBESerializedCompletedInvestigation[];
+    activeCRs: PRBESerializedCR[];
+    completedCRs: PRBESerializedCR[];
+    trackedTicketIDs: string[];
+    ticketInfo: PRBESerializedTicket[];
+    hasActiveWork: boolean;
+}
+declare const DEFAULT_PRBE_STATE: PRBESerializedState;
+declare function serializePRBEState(state: PRBEAgentState): PRBESerializedState;
+
+export { API_URL as A, type RequestPathAccessResponse as B, type ContextRequestOut as C, DEFAULT_PRBE_STATE as D, type RequestPermissionPayload as E, type FlaggedFileIn as F, type RequestPermissionResponse as G, type ResolvedInteraction as H, InvestigationSource as I, type TicketInfoRequest as J, type TicketInfoResponse as K, type TicketStatusOut as L, MIDDLEWARE_URL as M, ToolName as N, ToolParamType as O, type PRBEToolDeclaration as P, WSMessageType as Q, type RequestPathAccessPayload as R, redactPII as S, type TicketInfoOut as T, serializePRBEState as U, type WSMessage as W, type PRBEToolParameter as a, type PRBEInteractionRequester as b, PRBEAgentState as c, type PRBEAgentConfig as d, type InteractionPayload as e, type InteractionResponse as f, type PollResponse as g, type AskQuestionPayload as h, type AskQuestionResponse as i, InteractionType as j, type InvestigationResult as k, PRBEAgentConfigKey as l, PRBEAgentError as m, PRBEAgentErrorType as n, type PRBEAgentStatus as o, PRBEAgentStatusType as p, type PRBECRInvestigation as q, type PRBECompletedInvestigation as r, type PRBEInteractionHandler as s, type PRBESerializedCR as t, type PRBESerializedCompletedInvestigation as u, type PRBESerializedState as v, type PRBESerializedTicket as w, PRBEStateEvent as x, type PRBEStatusEvent as y, type PollRequest as z };