bilmem 0.1.0

package/dist/install/index.d.ts

@@ -0,0 +1,373 @@
+import { S as Storage } from '../canonical-CglQQ0xc.js';
+import '../types-Nxq5Gzay.js';
+import '../search/index.js';
+
+type InstallScope = 'project' | 'global';
+interface InstallContext {
+    projectDir: string;
+    globalDir?: string;
+    scope: InstallScope;
+    bilmemCommand?: string;
+    bilmemArgs?: string[];
+    storage?: Storage;
+}
+interface DetectionResult {
+    detected: boolean;
+    confidence: 'high' | 'medium' | 'low';
+    reasons: string[];
+    supportedScopes: InstallScope[];
+}
+interface InstallState {
+    id: string;
+    name: string;
+    detected: boolean;
+    scope: InstallScope;
+    mcpConfigured: boolean;
+    mcpCommandMatches: boolean;
+    instructionInstalled: boolean;
+    instructionVersion?: number;
+    currentInstructionVersion: number;
+    configPath: string;
+    instructionPath: string;
+    details?: Record<string, unknown>;
+}
+interface InstallOptions {
+    scope: InstallScope;
+    dryRun?: boolean;
+    force?: boolean;
+}
+interface InstallResult {
+    id: string;
+    name: string;
+    success: boolean;
+    scope: InstallScope;
+    mcpChanged: boolean;
+    instructionChanged: boolean;
+    projectInitialized: boolean;
+    dryRun?: boolean;
+    message?: string;
+    warnings?: string[];
+    actionsTaken: string[];
+}
+interface UninstallOptions {
+    scope: InstallScope;
+    dryRun?: boolean;
+}
+interface UninstallResult {
+    id: string;
+    name: string;
+    success: boolean;
+    scope: InstallScope;
+    mcpRemoved: boolean;
+    instructionRemoved: boolean;
+    dryRun?: boolean;
+    message?: string;
+    warnings?: string[];
+    actionsTaken: string[];
+}
+interface VerifyResult {
+    valid: boolean;
+    mcpValid: boolean;
+    instructionValid: boolean;
+    commandResolvable: boolean;
+    issues: string[];
+    recommendations: string[];
+}
+interface AgentInstaller {
+    readonly id: string;
+    readonly name: string;
+    readonly supportedScopes: InstallScope[];
+    detect(context: InstallContext): Promise<DetectionResult>;
+    inspect(context: InstallContext): Promise<InstallState>;
+    install(context: InstallContext, options: InstallOptions): Promise<InstallResult>;
+    uninstall(context: InstallContext, options: UninstallOptions): Promise<UninstallResult>;
+    verify(context: InstallContext): Promise<VerifyResult>;
+}
+interface IntegrationRecord {
+    scope: InstallScope;
+    mcp: boolean;
+    mcpConfigPath?: string;
+    instructions: boolean;
+    instructionPath?: string;
+    version: number;
+    installedAt: string;
+    updatedAt?: string;
+}
+interface IntegrationsMetadata {
+    version: number;
+    integrations: Record<string, IntegrationRecord>;
+}
+interface CoreDoctorReport {
+    storage: {
+        initialized: boolean;
+        path: string;
+        status: 'ok' | 'error' | 'warning';
+        details?: string;
+    };
+    knowledge: {
+        count: number;
+        status: 'ok' | 'warning';
+        details?: string;
+    };
+    searchIndex: {
+        status: 'ok' | 'warning' | 'error';
+        details?: string;
+    };
+    mcpRuntime: {
+        status: 'ok' | 'warning' | 'error';
+        details?: string;
+    };
+}
+interface AgentDoctorReport {
+    id: string;
+    name: string;
+    detected: boolean;
+    scope: InstallScope;
+    mcp: {
+        status: 'ok' | 'missing' | 'outdated' | 'error';
+        details?: string;
+    };
+    instructions: {
+        status: 'ok' | 'missing' | 'outdated' | 'none';
+        details?: string;
+    };
+    command: {
+        status: 'ok' | 'warning' | 'error';
+        details?: string;
+    };
+    configPath: string;
+    instructionPath: string;
+}
+interface DoctorReport {
+    core: CoreDoctorReport;
+    agents: AgentDoctorReport[];
+    issuesCount: number;
+    canFix: boolean;
+}
+interface DoctorFixResult {
+    coreFixed: string[];
+    agentsFixed: Record<string, string[]>;
+    dryRun: boolean;
+}
+
+declare const CURRENT_INTEGRATION_VERSION = 1;
+declare const BILMEM_START_MARKER = "<!-- bilmem:start -->";
+declare const BILMEM_END_MARKER = "<!-- bilmem:end -->";
+/**
+ * Returns the minimal, token-efficient agent instruction snippet.
+ */
+declare function getAgentInstructionText(version?: number): string;
+/**
+ * Extracts the installed integration version from markdown content, or null if none.
+ */
+declare function extractInstructionVersion(content: string): number | null;
+/**
+ * Checks whether content contains a managed Bilmem instruction block.
+ */
+declare function hasBilmemInstruction(content: string): boolean;
+
+interface JsonReadResult {
+    exists: boolean;
+    data?: any;
+    raw?: string;
+    error?: string;
+}
+/**
+ * Atomically writes content to a file via a temporary file and rename.
+ */
+declare function writeAtomic(filePath: string, content: string): Promise<void>;
+/**
+ * Safely reads and parses a JSON file without throwing on missing file.
+ * Returns error string if JSON syntax is malformed.
+ */
+declare function safeReadJson(filePath: string): Promise<JsonReadResult>;
+/**
+ * Safely updates an MCP JSON configuration file by adding/updating the "bilmem" entry
+ * under "mcpServers", preserving all existing top-level keys and other MCP servers.
+ */
+declare function updateMcpJsonConfig(filePath: string, bilmemCommand?: string, bilmemArgs?: string[], dryRun?: boolean): Promise<{
+    changed: boolean;
+    created: boolean;
+    originalExisted: boolean;
+}>;
+/**
+ * Safely removes the "bilmem" entry from an MCP JSON configuration file,
+ * preserving all other settings and servers.
+ */
+declare function removeMcpJsonConfig(filePath: string, dryRun?: boolean): Promise<{
+    removed: boolean;
+    fileDeleted: boolean;
+}>;
+/**
+ * Safely inserts or updates the managed Bilmem instruction block in a markdown file.
+ * Preserves all surrounding content.
+ */
+declare function updateMarkdownInstructionFile(filePath: string, desiredBlock?: string, dryRun?: boolean): Promise<{
+    changed: boolean;
+    created: boolean;
+    originalExisted: boolean;
+}>;
+/**
+ * Safely removes only the managed Bilmem instruction block from a markdown file.
+ * Preserves all surrounding user content. If the file contains only the Bilmem block,
+ * removes the file.
+ */
+declare function removeMarkdownInstructionFile(filePath: string, dryRun?: boolean): Promise<{
+    removed: boolean;
+    fileDeleted: boolean;
+}>;
+/**
+ * Checks if a file or directory exists.
+ */
+declare function pathExists(p: string): Promise<boolean>;
+/**
+ * Fast cross-platform check whether a command executable is available in PATH.
+ */
+declare function isExecutableInPath(command: string): Promise<boolean>;
+
+declare function getIntegrationsFilePath(rootDir: string): string;
+/**
+ * Loads the current integrations metadata from .bilmem/integrations.json.
+ */
+declare function loadIntegrationsMetadata(rootDir: string): Promise<IntegrationsMetadata>;
+/**
+ * Saves integrations metadata to .bilmem/integrations.json.
+ */
+declare function saveIntegrationsMetadata(rootDir: string, meta: IntegrationsMetadata, dryRun?: boolean): Promise<void>;
+/**
+ * Records or updates an agent integration in .bilmem/integrations.json.
+ */
+declare function recordIntegration(rootDir: string, agentId: string, record: IntegrationRecord, dryRun?: boolean): Promise<void>;
+/**
+ * Removes an agent integration record from .bilmem/integrations.json.
+ */
+declare function removeIntegration(rootDir: string, agentId: string, dryRun?: boolean): Promise<void>;
+/**
+ * Retrieves the integration record for a specific agent.
+ */
+declare function getIntegrationRecord(rootDir: string, agentId: string): Promise<IntegrationRecord | undefined>;
+
+declare abstract class BaseAgentAdapter implements AgentInstaller {
+    abstract readonly id: string;
+    abstract readonly name: string;
+    readonly supportedScopes: InstallScope[];
+    abstract resolveConfigPath(context: InstallContext): string;
+    abstract resolveInstructionPath(context: InstallContext): string;
+    abstract detect(context: InstallContext): Promise<DetectionResult>;
+    inspect(context: InstallContext): Promise<InstallState>;
+    install(context: InstallContext, options: InstallOptions): Promise<InstallResult>;
+    uninstall(context: InstallContext, options: UninstallOptions): Promise<UninstallResult>;
+    verify(context: InstallContext): Promise<VerifyResult>;
+}
+
+declare class CursorAdapter extends BaseAgentAdapter {
+    readonly id = "cursor";
+    readonly name = "Cursor";
+    resolveConfigPath(context: InstallContext): string;
+    resolveInstructionPath(context: InstallContext): string;
+    detect(context: InstallContext): Promise<DetectionResult>;
+}
+
+declare class ClaudeAdapter extends BaseAgentAdapter {
+    readonly id = "claude";
+    readonly name = "Claude Code";
+    resolveConfigPath(context: InstallContext): string;
+    resolveInstructionPath(context: InstallContext): string;
+    detect(context: InstallContext): Promise<DetectionResult>;
+}
+
+declare class CodexAdapter extends BaseAgentAdapter {
+    readonly id = "codex";
+    readonly name = "Codex";
+    resolveConfigPath(context: InstallContext): string;
+    resolveInstructionPath(context: InstallContext): string;
+    detect(context: InstallContext): Promise<DetectionResult>;
+}
+
+declare class GeminiAdapter extends BaseAgentAdapter {
+    readonly id = "gemini";
+    readonly name = "Gemini CLI";
+    resolveConfigPath(context: InstallContext): string;
+    resolveInstructionPath(context: InstallContext): string;
+    detect(context: InstallContext): Promise<DetectionResult>;
+}
+
+declare function getAllAdapters(): AgentInstaller[];
+declare function getAdapter(id: string): AgentInstaller | undefined;
+interface DetectedAgent {
+    adapter: AgentInstaller;
+    detection: DetectionResult;
+}
+/**
+ * Runs detection across all registered adapters deterministically and cheaply.
+ */
+declare function detectAgents(context: InstallContext): Promise<DetectedAgent[]>;
+
+declare function runDoctor(context: InstallContext): Promise<DoctorReport>;
+declare function runDoctorFix(context: InstallContext, dryRun?: boolean): Promise<DoctorFixResult>;
+
+declare function formatInstallResult(results: InstallResult[], scope: InstallScope, projectDir: string, dryRun?: boolean): string;
+declare function formatUninstallResult(result: UninstallResult, dryRun?: boolean): string;
+declare function formatDoctorReport(report: DoctorReport): string;
+declare function formatDoctorFixResult(fixed: DoctorFixResult): string;
+
+interface CliInstallOptions {
+    detected?: boolean;
+    all?: boolean;
+    yes?: boolean;
+    global?: boolean;
+    dryRun?: boolean;
+    force?: boolean;
+    projectDir?: string;
+    globalDir?: string;
+    bilmemCommand?: string;
+    bilmemArgs?: string[];
+}
+interface CliUninstallOptions {
+    global?: boolean;
+    dryRun?: boolean;
+    projectDir?: string;
+    globalDir?: string;
+}
+interface CliDoctorOptions {
+    fix?: boolean;
+    dryRun?: boolean;
+    global?: boolean;
+    projectDir?: string;
+    globalDir?: string;
+}
+/**
+ * Creates an InstallContext from CLI arguments.
+ */
+declare function createInstallContext(options: {
+    scope?: InstallScope;
+    global?: boolean;
+    projectDir?: string;
+    globalDir?: string;
+    bilmemCommand?: string;
+    bilmemArgs?: string[];
+}): InstallContext;
+/**
+ * Main handler for `bilmem install [target]`.
+ */
+declare function handleInstallCommand(target?: string, options?: CliInstallOptions): Promise<{
+    success: boolean;
+    results: InstallResult[];
+    message?: string;
+}>;
+/**
+ * Main handler for `bilmem uninstall <target>`.
+ */
+declare function handleUninstallCommand(target: string, options?: CliUninstallOptions): Promise<{
+    success: boolean;
+    result: UninstallResult;
+}>;
+/**
+ * Main handler for `bilmem doctor`.
+ */
+declare function handleDoctorCommand(options?: CliDoctorOptions): Promise<{
+    report: DoctorReport;
+    fixed?: DoctorFixResult;
+}>;
+
+export { type AgentDoctorReport, type AgentInstaller, BILMEM_END_MARKER, BILMEM_START_MARKER, BaseAgentAdapter, CURRENT_INTEGRATION_VERSION, ClaudeAdapter, type CliDoctorOptions, type CliInstallOptions, type CliUninstallOptions, CodexAdapter, type CoreDoctorReport, CursorAdapter, type DetectedAgent, type DetectionResult, type DoctorFixResult, type DoctorReport, GeminiAdapter, type InstallContext, type InstallOptions, type InstallResult, type InstallScope, type InstallState, type IntegrationRecord, type IntegrationsMetadata, type JsonReadResult, type UninstallOptions, type UninstallResult, type VerifyResult, createInstallContext, detectAgents, extractInstructionVersion, formatDoctorFixResult, formatDoctorReport, formatInstallResult, formatUninstallResult, getAdapter, getAgentInstructionText, getAllAdapters, getIntegrationRecord, getIntegrationsFilePath, handleDoctorCommand, handleInstallCommand, handleUninstallCommand, hasBilmemInstruction, isExecutableInPath, loadIntegrationsMetadata, pathExists, recordIntegration, removeIntegration, removeMarkdownInstructionFile, removeMcpJsonConfig, runDoctor, runDoctorFix, safeReadJson, saveIntegrationsMetadata, updateMarkdownInstructionFile, updateMcpJsonConfig, writeAtomic };