umbrella-context 0.1.39 → 0.1.41

package/dist/swarm/runtime.d.ts

@@ -0,0 +1,502 @@
+import { z } from "zod";
+declare const SwarmConfigSchema: z.ZodObject<{
+    enrichment: z.ZodDefault<z.ZodObject<{
+        edges: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            from: z.ZodString;
+            to: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            to: string;
+            from: string;
+        }, {
+            to: string;
+            from: string;
+        }>, "many">>;
+        enabled: z.ZodDefault<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        edges: {
+            to: string;
+            from: string;
+        }[];
+        enabled: boolean;
+    }, {
+        edges?: {
+            to: string;
+            from: string;
+        }[] | undefined;
+        enabled?: boolean | undefined;
+    }>>;
+    providers: z.ZodObject<{
+        gbrain: z.ZodOptional<z.ZodObject<{
+            enabled: z.ZodDefault<z.ZodBoolean>;
+            notesPath: z.ZodString;
+            readOnly: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+        }, "strip", z.ZodTypeAny, {
+            readOnly: boolean;
+            enabled: boolean;
+            notesPath: string;
+        }, {
+            notesPath: string;
+            readOnly?: boolean | undefined;
+            enabled?: boolean | undefined;
+        }>>;
+        localMarkdown: z.ZodOptional<z.ZodObject<{
+            enabled: z.ZodDefault<z.ZodBoolean>;
+            folders: z.ZodDefault<z.ZodArray<z.ZodObject<{
+                followWikilinks: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+                id: z.ZodString;
+                name: z.ZodString;
+                path: z.ZodString;
+                readOnly: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+            }, "strip", z.ZodTypeAny, {
+                id: string;
+                name: string;
+                path: string;
+                followWikilinks: boolean;
+                readOnly: boolean;
+            }, {
+                id: string;
+                name: string;
+                path: string;
+                followWikilinks?: boolean | undefined;
+                readOnly?: boolean | undefined;
+            }>, "many">>;
+        }, "strip", z.ZodTypeAny, {
+            folders: {
+                id: string;
+                name: string;
+                path: string;
+                followWikilinks: boolean;
+                readOnly: boolean;
+            }[];
+            enabled: boolean;
+        }, {
+            folders?: {
+                id: string;
+                name: string;
+                path: string;
+                followWikilinks?: boolean | undefined;
+                readOnly?: boolean | undefined;
+            }[] | undefined;
+            enabled?: boolean | undefined;
+        }>>;
+        memoryWiki: z.ZodOptional<z.ZodObject<{
+            enabled: z.ZodDefault<z.ZodBoolean>;
+            readOnly: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+            wikiPath: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            readOnly: boolean;
+            enabled: boolean;
+            wikiPath: string;
+        }, {
+            wikiPath: string;
+            readOnly?: boolean | undefined;
+            enabled?: boolean | undefined;
+        }>>;
+        obsidian: z.ZodOptional<z.ZodObject<{
+            enabled: z.ZodDefault<z.ZodBoolean>;
+            readOnly: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+            vaultPath: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            readOnly: boolean;
+            enabled: boolean;
+            vaultPath: string;
+        }, {
+            vaultPath: string;
+            readOnly?: boolean | undefined;
+            enabled?: boolean | undefined;
+        }>>;
+        umbrellaContext: z.ZodDefault<z.ZodObject<{
+            enabled: z.ZodDefault<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            enabled: boolean;
+        }, {
+            enabled?: boolean | undefined;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        umbrellaContext: {
+            enabled: boolean;
+        };
+        gbrain?: {
+            readOnly: boolean;
+            enabled: boolean;
+            notesPath: string;
+        } | undefined;
+        localMarkdown?: {
+            folders: {
+                id: string;
+                name: string;
+                path: string;
+                followWikilinks: boolean;
+                readOnly: boolean;
+            }[];
+            enabled: boolean;
+        } | undefined;
+        memoryWiki?: {
+            readOnly: boolean;
+            enabled: boolean;
+            wikiPath: string;
+        } | undefined;
+        obsidian?: {
+            readOnly: boolean;
+            enabled: boolean;
+            vaultPath: string;
+        } | undefined;
+    }, {
+        gbrain?: {
+            notesPath: string;
+            readOnly?: boolean | undefined;
+            enabled?: boolean | undefined;
+        } | undefined;
+        localMarkdown?: {
+            folders?: {
+                id: string;
+                name: string;
+                path: string;
+                followWikilinks?: boolean | undefined;
+                readOnly?: boolean | undefined;
+            }[] | undefined;
+            enabled?: boolean | undefined;
+        } | undefined;
+        memoryWiki?: {
+            wikiPath: string;
+            readOnly?: boolean | undefined;
+            enabled?: boolean | undefined;
+        } | undefined;
+        obsidian?: {
+            vaultPath: string;
+            readOnly?: boolean | undefined;
+            enabled?: boolean | undefined;
+        } | undefined;
+        umbrellaContext?: {
+            enabled?: boolean | undefined;
+        } | undefined;
+    }>;
+    routing: z.ZodDefault<z.ZodObject<{
+        cacheTtlMs: z.ZodDefault<z.ZodNumber>;
+        defaultMaxResults: z.ZodDefault<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        cacheTtlMs: number;
+        defaultMaxResults: number;
+    }, {
+        cacheTtlMs?: number | undefined;
+        defaultMaxResults?: number | undefined;
+    }>>;
+    version: z.ZodDefault<z.ZodLiteral<1>>;
+}, "strip", z.ZodTypeAny, {
+    providers: {
+        umbrellaContext: {
+            enabled: boolean;
+        };
+        gbrain?: {
+            readOnly: boolean;
+            enabled: boolean;
+            notesPath: string;
+        } | undefined;
+        localMarkdown?: {
+            folders: {
+                id: string;
+                name: string;
+                path: string;
+                followWikilinks: boolean;
+                readOnly: boolean;
+            }[];
+            enabled: boolean;
+        } | undefined;
+        memoryWiki?: {
+            readOnly: boolean;
+            enabled: boolean;
+            wikiPath: string;
+        } | undefined;
+        obsidian?: {
+            readOnly: boolean;
+            enabled: boolean;
+            vaultPath: string;
+        } | undefined;
+    };
+    version: 1;
+    enrichment: {
+        edges: {
+            to: string;
+            from: string;
+        }[];
+        enabled: boolean;
+    };
+    routing: {
+        cacheTtlMs: number;
+        defaultMaxResults: number;
+    };
+}, {
+    providers: {
+        gbrain?: {
+            notesPath: string;
+            readOnly?: boolean | undefined;
+            enabled?: boolean | undefined;
+        } | undefined;
+        localMarkdown?: {
+            folders?: {
+                id: string;
+                name: string;
+                path: string;
+                followWikilinks?: boolean | undefined;
+                readOnly?: boolean | undefined;
+            }[] | undefined;
+            enabled?: boolean | undefined;
+        } | undefined;
+        memoryWiki?: {
+            wikiPath: string;
+            readOnly?: boolean | undefined;
+            enabled?: boolean | undefined;
+        } | undefined;
+        obsidian?: {
+            vaultPath: string;
+            readOnly?: boolean | undefined;
+            enabled?: boolean | undefined;
+        } | undefined;
+        umbrellaContext?: {
+            enabled?: boolean | undefined;
+        } | undefined;
+    };
+    version?: 1 | undefined;
+    enrichment?: {
+        edges?: {
+            to: string;
+            from: string;
+        }[] | undefined;
+        enabled?: boolean | undefined;
+    } | undefined;
+    routing?: {
+        cacheTtlMs?: number | undefined;
+        defaultMaxResults?: number | undefined;
+    } | undefined;
+}>;
+export type SwarmConfig = z.infer<typeof SwarmConfigSchema>;
+export type SwarmProviderType = "umbrella-context" | "umbrella-source" | "obsidian" | "local-markdown" | "gbrain" | "memory-wiki";
+export type SwarmQueryHit = {
+    content: string;
+    id: string;
+    matchType: "graph" | "keyword";
+    provider: string;
+    providerLabel: string;
+    providerType: SwarmProviderType;
+    score: number;
+    source: string;
+};
+export type SwarmProviderMeta = {
+    available: boolean;
+    detail: string;
+    enrichedBy?: string;
+    enrichmentHints?: string[];
+    healthy: boolean;
+    latencyMs: number;
+    resultCount: number;
+    selected: boolean;
+    writable: boolean;
+};
+export type SwarmQueryResult = {
+    cached: boolean;
+    cacheTtlMs: number;
+    meta: {
+        enrichmentEdges: Array<{
+            from: string;
+            to: string;
+        }>;
+        providerCount: number;
+        providers: Record<string, SwarmProviderMeta>;
+        totalLatencyMs: number;
+    };
+    query: string;
+    results: SwarmQueryHit[];
+};
+export type SwarmStoreResult = {
+    fallback: boolean;
+    id?: string;
+    provider: string;
+    success: boolean;
+    targetType: SwarmProviderType;
+};
+export type SwarmStatusSummary = {
+    configPath: string;
+    configured: boolean;
+    healthyProviders: number;
+    providerCount: number;
+    writableProviders: number;
+};
+export declare function getSwarmConfigPath(cwd?: string): Promise<string>;
+export declare function hasSwarmConfig(cwd?: string): Promise<boolean>;
+export declare function loadSwarmConfig(cwd?: string): Promise<{
+    providers: {
+        umbrellaContext: {
+            enabled: boolean;
+        };
+        gbrain?: {
+            readOnly: boolean;
+            enabled: boolean;
+            notesPath: string;
+        } | undefined;
+        localMarkdown?: {
+            folders: {
+                id: string;
+                name: string;
+                path: string;
+                followWikilinks: boolean;
+                readOnly: boolean;
+            }[];
+            enabled: boolean;
+        } | undefined;
+        memoryWiki?: {
+            readOnly: boolean;
+            enabled: boolean;
+            wikiPath: string;
+        } | undefined;
+        obsidian?: {
+            readOnly: boolean;
+            enabled: boolean;
+            vaultPath: string;
+        } | undefined;
+    };
+    version: 1;
+    enrichment: {
+        edges: {
+            to: string;
+            from: string;
+        }[];
+        enabled: boolean;
+    };
+    routing: {
+        cacheTtlMs: number;
+        defaultMaxResults: number;
+    };
+} | null>;
+export declare function saveSwarmConfig(config: SwarmConfig, cwd?: string): Promise<void>;
+export declare function ensureSwarmConfigForLinkedSources(cwd?: string): Promise<{
+    configPath: string;
+    created: boolean;
+    ready: boolean;
+    config?: undefined;
+} | {
+    config: {
+        providers: {
+            umbrellaContext: {
+                enabled: boolean;
+            };
+            gbrain?: {
+                readOnly: boolean;
+                enabled: boolean;
+                notesPath: string;
+            } | undefined;
+            localMarkdown?: {
+                folders: {
+                    id: string;
+                    name: string;
+                    path: string;
+                    followWikilinks: boolean;
+                    readOnly: boolean;
+                }[];
+                enabled: boolean;
+            } | undefined;
+            memoryWiki?: {
+                readOnly: boolean;
+                enabled: boolean;
+                wikiPath: string;
+            } | undefined;
+            obsidian?: {
+                readOnly: boolean;
+                enabled: boolean;
+                vaultPath: string;
+            } | undefined;
+        };
+        version: 1;
+        enrichment: {
+            edges: {
+                to: string;
+                from: string;
+            }[];
+            enabled: boolean;
+        };
+        routing: {
+            cacheTtlMs: number;
+            defaultMaxResults: number;
+        };
+    };
+    configPath: string;
+    created: boolean;
+    ready: boolean;
+}>;
+export declare function formatSwarmQueryText(result: SwarmQueryResult, options?: {
+    explain?: boolean;
+}): string;
+export declare function getSwarmStatusSummary(cwd?: string): Promise<SwarmStatusSummary>;
+export declare function getSwarmStatus(cwd?: string): Promise<{
+    configured: boolean;
+    configPath: string;
+    enrichmentEdges: Array<{
+        from: string;
+        to: string;
+    }>;
+    providers: Array<{
+        id: string;
+        label: string;
+        type: SwarmProviderType;
+        available: boolean;
+        detail: string;
+        writable: boolean;
+    }>;
+    suggestions: string[];
+}>;
+export declare function executeSwarmQuery(query: string, opts?: {
+    explain?: boolean;
+    format?: "json" | "text";
+    maxResults?: number;
+    provider?: string;
+}, cwd?: string): Promise<SwarmQueryResult>;
+export declare function executeSwarmCurate(content: string, opts?: {
+    provider?: string;
+}, cwd?: string): Promise<SwarmStoreResult>;
+export declare function runSwarmOnboardWizard(cwd?: string): Promise<{
+    config: {
+        providers: {
+            umbrellaContext: {
+                enabled: boolean;
+            };
+            gbrain?: {
+                readOnly: boolean;
+                enabled: boolean;
+                notesPath: string;
+            } | undefined;
+            localMarkdown?: {
+                folders: {
+                    id: string;
+                    name: string;
+                    path: string;
+                    followWikilinks: boolean;
+                    readOnly: boolean;
+                }[];
+                enabled: boolean;
+            } | undefined;
+            memoryWiki?: {
+                readOnly: boolean;
+                enabled: boolean;
+                wikiPath: string;
+            } | undefined;
+            obsidian?: {
+                readOnly: boolean;
+                enabled: boolean;
+                vaultPath: string;
+            } | undefined;
+        };
+        version: 1;
+        enrichment: {
+            edges: {
+                to: string;
+                from: string;
+            }[];
+            enabled: boolean;
+        };
+        routing: {
+            cacheTtlMs: number;
+            defaultMaxResults: number;
+        };
+    };
+    configPath: string;
+}>;
+export {};