@swarmvaultai/engine 1.0.1 → 1.2.0

package/dist/index.d.ts

@@ -27,6 +27,7 @@ declare const providerTypeSchema: z.ZodEnum<{
     together: "together";
     xai: "xai";
     cerebras: "cerebras";
+    "local-whisper": "local-whisper";
     custom: "custom";
 }>;
 type ProviderType = z.infer<typeof providerTypeSchema>;
@@ -161,6 +162,14 @@ interface ProviderConfig {
     module?: string;
     capabilities?: ProviderCapability[];
     apiStyle?: "responses" | "chat";
+    /** local-whisper: override the binary discovery search. */
+    binaryPath?: string;
+    /** local-whisper: explicit path to the ggml model file. */
+    modelPath?: string;
+    /** local-whisper: extra CLI flags forwarded to whisper.cpp. */
+    extraArgs?: string[];
+    /** local-whisper: thread count passed as `-t`. */
+    threads?: number;
 }
 interface WebSearchProviderConfig {
     type: WebSearchProviderType;
@@ -1611,6 +1620,48 @@ interface GraphReportArtifact {
         warnings: string[];
     };
 }
+interface GraphShareArtifact {
+    generatedAt: string;
+    vaultName: string;
+    tagline: string;
+    overview: {
+        sources: number;
+        nodes: number;
+        edges: number;
+        pages: number;
+        communities: number;
+    };
+    firstPartyOverview: {
+        nodes: number;
+        edges: number;
+        pages: number;
+        communities: number;
+    };
+    highlights: {
+        topHubs: Array<{
+            nodeId: string;
+            label: string;
+            degree?: number;
+        }>;
+        bridgeNodes: Array<{
+            nodeId: string;
+            label: string;
+            bridgeScore?: number;
+        }>;
+        surprisingConnections: Array<{
+            sourceLabel: string;
+            targetLabel: string;
+            relation: string;
+            why: string;
+        }>;
+        suggestedQuestions: string[];
+    };
+    knowledgeGaps: string[];
+    shortPost: string;
+    relatedNodeIds: string[];
+    relatedPageIds: string[];
+    relatedSourceIds: string[];
+}
 interface ScheduledCompileTask {
     type: "compile";
     approve?: boolean;
@@ -1952,6 +2003,13 @@ type GraphPushInternalOptions = GraphPushNeo4jOptions & {
 };
 declare function pushGraphNeo4j(rootDir: string, options?: GraphPushInternalOptions): Promise<GraphPushResult>;
 
+declare function buildGraphShareArtifact(input: {
+    graph: GraphArtifact;
+    report?: GraphReportArtifact | null;
+    vaultName?: string;
+}): GraphShareArtifact;
+declare function renderGraphShareMarkdown(artifact: GraphShareArtifact): string;
+
 declare function graphDiff(oldGraph: GraphArtifact, newGraph: GraphArtifact): GraphDiffResult;
 /**
  * Compute the blast radius of changing a file/module by tracing reverse import
@@ -2075,6 +2133,132 @@ declare function runMigration(rootDir: string, options?: {
     dryRun?: boolean;
 }): Promise<MigrationResult>;
 
+declare abstract class BaseProviderAdapter implements ProviderAdapter {
+    readonly id: string;
+    readonly type: ProviderType;
+    readonly model: string;
+    readonly capabilities: Set<ProviderCapability>;
+    constructor(id: string, type: ProviderType, model: string, capabilities: ProviderCapability[]);
+    abstract generateText(request: GenerationRequest): Promise<GenerationResponse>;
+    embedTexts(_texts: string[]): Promise<number[][]>;
+    generateImage(_request: ImageGenerationRequest): Promise<ImageGenerationResponse>;
+    transcribeAudio(_request: AudioTranscriptionRequest): Promise<AudioTranscriptionResponse>;
+    generateStructured<T>(request: GenerationRequest, schema: z.ZodType<T>): Promise<T>;
+    protected encodeAttachments(attachments?: GenerationAttachment[]): Promise<Array<{
+        mimeType: string;
+        base64: string;
+    }>>;
+}
+
+interface LocalWhisperAdapterOptions {
+    binaryPath?: string;
+    model?: string;
+    modelPath?: string;
+    extraArgs?: string[];
+    threads?: number;
+    /**
+     * Replaces the default `child_process.spawn`-based runner. Exposed so unit
+     * tests can exercise the adapter without requiring a real whisper.cpp binary
+     * on `$PATH`.
+     */
+    runner?: WhisperRunner;
+    /** Overrides the directory used for temp audio files. */
+    tmpDir?: string;
+    /** Overrides environment variable lookup. */
+    env?: NodeJS.ProcessEnv;
+    /** Overrides `$HOME` used to resolve the default models directory. */
+    homeDir?: string;
+}
+type WhisperRunner = (input: {
+    binaryPath: string;
+    args: string[];
+}) => Promise<WhisperRunResult>;
+interface WhisperRunResult {
+    code: number;
+    stdout: string;
+    stderr: string;
+}
+declare class LocalWhisperProviderAdapter extends BaseProviderAdapter {
+    private readonly options;
+    constructor(id: string, model: string, options?: LocalWhisperAdapterOptions);
+    generateText(_request: GenerationRequest): Promise<GenerationResponse>;
+    transcribeAudio(request: AudioTranscriptionRequest): Promise<AudioTranscriptionResponse>;
+    private extensionForRequest;
+    private resolveBinaryPath;
+    private resolveModelPath;
+}
+
+/**
+ * Approximate download sizes for the shipped ggml models. Used only for
+ * user-facing "this will download ~X MB" summaries — no correctness depends on
+ * these being exact.
+ */
+declare const LOCAL_WHISPER_MODEL_SIZES: Readonly<Record<string, string>>;
+interface LocalWhisperDiscoveryOptions {
+    env?: NodeJS.ProcessEnv;
+}
+interface LocalWhisperBinaryDiscovery {
+    binaryPath: string | null;
+    candidates: string[];
+    source: "config" | "env" | "path" | "not-found";
+}
+declare function discoverLocalWhisperBinary(options?: LocalWhisperDiscoveryOptions): Promise<LocalWhisperBinaryDiscovery>;
+declare function expectedModelPath(modelName: string, homeDir?: string): string;
+declare function modelDownloadUrl(modelName: string): string;
+interface DownloadProgress {
+    downloadedBytes: number;
+    totalBytes?: number;
+}
+interface DownloadOptions {
+    modelName: string;
+    homeDir?: string;
+    onProgress?: (progress: DownloadProgress) => void;
+    fetchImpl?: typeof fetch;
+}
+interface DownloadResult {
+    path: string;
+    bytes: number;
+}
+declare function downloadWhisperModel(options: DownloadOptions): Promise<DownloadResult>;
+interface ProviderRegistrationOptions {
+    rootDir: string;
+    providerId?: string;
+    model: string;
+    setAsAudioProvider?: boolean;
+    binaryPath?: string;
+    modelPath?: string;
+    threads?: number;
+}
+interface ProviderRegistrationResult {
+    providerId: string;
+    configPath: string;
+    providerWasAdded: boolean;
+    providerWasUpdated: boolean;
+    audioProviderSet: boolean;
+    previousAudioProvider?: string;
+}
+declare function registerLocalWhisperProvider(options: ProviderRegistrationOptions): Promise<ProviderRegistrationResult>;
+interface LocalWhisperSetupStatus {
+    binary: {
+        found: boolean;
+        path: string | null;
+        source: LocalWhisperBinaryDiscovery["source"];
+        installHint: string;
+    };
+    model: {
+        name: string;
+        expectedPath: string;
+        exists: boolean;
+        downloadUrl: string;
+        approximateSize: string | undefined;
+    };
+}
+interface SummarizeSetupOptions extends LocalWhisperDiscoveryOptions {
+    modelName: string;
+    homeDir?: string;
+}
+declare function summarizeLocalWhisperSetup(options: SummarizeSetupOptions): Promise<LocalWhisperSetupStatus>;
+
 /**
  * Canonical capability matrix for the OpenAI-compatible provider family.
  *
@@ -2429,4 +2613,4 @@ declare function createWebSearchAdapter(id: string, config: WebSearchProviderCon
 type WebSearchTaskId = "deepLintProvider" | "queryProvider" | "exploreProvider";
 declare function getWebSearchAdapterForTask(rootDir: string, task: WebSearchTaskId): Promise<WebSearchAdapter>;
 
-export { ALL_MIGRATIONS, type AddOptions, type AddResult, type AgentType, type AnalyzedTerm, type ApprovalBundleType, type ApprovalChangeType, type ApprovalDetail, type ApprovalDiffHunk, type ApprovalDiffLine, type ApprovalEntry, type ApprovalEntryDetail, type ApprovalEntryLabel, type ApprovalEntryStatus, type ApprovalFrontmatterChange, type ApprovalManifest, type ApprovalStructuredDiff, type ApprovalSummary, type AudioTranscriptionRequest, type AudioTranscriptionResponse, type BenchmarkArtifact, type BenchmarkByClassEntry, type BenchmarkOptions, type BenchmarkQuestionResult, type BenchmarkSummary, type BlastRadiusResult, type CandidatePromotionConfig, type CandidateRecord, type ChartDatum, type ChartSpec, type ClaimStatus, type CodeAnalysis, type CodeDiagnostic, type CodeImport, type CodeIndexArtifact, type CodeIndexEntry, type CodeLanguage, type CodeSymbol, type CodeSymbolKind, type CommandRoleExecutorConfig, type CompileOptions, type CompileResult, type CompileState, type ConsolidationConfig, type ConsolidationPromotion, type ConsolidationResult, DEFAULT_CONSOLIDATION_CONFIG, DEFAULT_HALF_LIFE_DAYS, DEFAULT_HALF_LIFE_DAYS_BY_SOURCE_CLASS, DEFAULT_PROMOTION_CONFIG, DEFAULT_REDACTION_PATTERNS, DEFAULT_STALE_THRESHOLD, type DegradationOutcome, type DirectoryIngestFailure, type DirectoryIngestResult, type DirectoryIngestSkip, type EmbeddingCacheArtifact, type EmbeddingCacheEntry, type EvidenceClass, type ExploreOptions, type ExploreResult, type ExploreStepResult, type ExtractionClaim, type ExtractionKind, type ExtractionTerm, type Freshness, type FreshnessConfig, type GenerationAttachment, type GenerationRequest, type GenerationResponse, type GitHookStatus, type GraphArtifact, type GraphDiffResult, type GraphEdge, type GraphExplainNeighbor, type GraphExplainResult, type GraphExportFormat, type GraphExportResult, type GraphHyperedge, type GraphNode, type GraphPage, type GraphPathResult, type GraphPushCounts, type GraphPushNeo4jOptions, type GraphPushResult, type GraphQueryMatch, type GraphQueryResult, type GraphReportArtifact, type GuidedSessionMode, type GuidedSourceSessionAnswers, type GuidedSourceSessionQuestion, type GuidedSourceSessionRecord, type GuidedSourceSessionStatus, type ImageGenerationRequest, type ImageGenerationResponse, type ImageVisionExtraction, type InboxImportResult, type InboxImportSkip, type IngestOptions, type InitOptions, type InputIngestResult, type InstallAgentOptions, type InstallAgentResult, LARGE_REPO_NODE_THRESHOLD, type LintFinding, type LintOptions, type ManagedSourceAddOptions, type ManagedSourceAddResult, type ManagedSourceDeleteResult, type ManagedSourceKind, type ManagedSourceRecord, type ManagedSourceReloadOptions, type ManagedSourceReloadResult, type ManagedSourceStatus, type ManagedSourceSyncCounts, type ManagedSourcesArtifact, type MemoryTier, type MigrationPlan, type MigrationResult, type MigrationStep, type Neo4jGraphSinkConfig, OPENAI_COMPATIBLE_CAPABILITY_MATRIX, type OpenAiCompatiblePresetId, type OrchestrationConfig, type OrchestrationFinding, type OrchestrationProposal, type OrchestrationRole, type OrchestrationRoleConfig, type OrchestrationRoleResult, type OutputAsset, type OutputAssetRole, type OutputFormat, type OutputOrigin, type PageKind, type PageManager, type PageStatus, type PendingSemanticRefreshEntry, type Polarity, type PromotionDecision, type PromotionGateKind, type PromotionGateResult, type PromotionSession, type ProviderAdapter, type ProviderCapability, type ProviderConfig, type ProviderPresetCapability, type ProviderRoleExecutorConfig, type ProviderType, type QueryOptions, type QueryResult, type RedactionMatchSummary, type RedactionPatternConfig, type RedactionSettings, type RedactionSummary, type RepoSyncResult, type ResolvedLargeRepoDefaults, type ResolvedPaths, type ReviewActionResult, type RoleExecutorConfig, type SceneElement, type SceneSpec, type ScheduleController, type ScheduleJobConfig, type ScheduleStateRecord, type ScheduleTriggerConfig, type ScheduledCompileTask, type ScheduledConsolidateTask, type ScheduledExploreTask, type ScheduledLintTask, type ScheduledQueryTask, type ScheduledRunResult, type ScheduledTaskConfig, type SearchResult, type SourceAnalysis, type SourceAttachment, type SourceCaptureType, type SourceClaim, type SourceClass, type SourceExtractionArtifact, type SourceGuideResult, type SourceKind, type SourceManifest, type SourceRationale, type SourceReviewResult, type SynthesizedHubEdge, type SynthesizedHubNode, type SynthesizedHyperedgeHubs, type VaultConfig, type VaultDashboardPack, type VaultProfileConfig, type VaultProfilePreset, type VaultVersionRecord, type WatchConfig, type WatchController, type WatchOptions, type WatchRepoSyncResult, type WatchRunRecord, type WatchStatusResult, type WebSearchAdapter, type WebSearchProviderConfig, type WebSearchProviderType, type WebSearchResult, acceptApproval, addInput, addManagedSource, addWatchedRoot, agentTypeSchema, applyDecayToPages, archiveCandidate, assertProviderCapability, autoCommitWikiChanges, benchmarkVault, blastRadius, blastRadiusVault, bootstrapDemo, buildConfiguredRedactor, buildRedactor, compileVault, computeDecayScore, consolidateVault, createMcpServer, createProvider, createSupersessionEdge, createWebSearchAdapter, defaultVaultConfig, defaultVaultSchema, deleteManagedSource, detectVaultVersion, estimatePageTokens, estimateTokens, evaluateCandidateForPromotion, explainGraphVault, exploreVault, exportGraphFormat, exportGraphHtml, exportGraphReportHtml, exportObsidianCanvas, exportObsidianVault, getGitHookStatus, getProviderForTask, getWatchStatus, getWebSearchAdapterForTask, getWorkspaceInfo, graphDiff, guideManagedSource, guideSourceScope, importInbox, ingestDirectory, ingestInput, ingestInputDetailed, initVault, initWorkspace, installAgent, installConfiguredAgents, installGitHooks, lintVault, listApprovals, listCandidates, listGodNodes, listGraphHyperedges, listManagedSourceRecords, listManifests, listPages, listSchedules, listTrackedRepoRoots, listWatchedRoots, loadVaultConfig, loadVaultSchema, loadVaultSchemas, lookupPresetCapabilities, markSuperseded, pathGraphVault, persistDecayFrontmatter, planMigration, previewCandidatePromotions, promoteCandidate, providerCapabilitySchema, providerTypeSchema, pushGraphNeo4j, queryGraphVault, queryVault, readApproval, readExtractedText, readGraphReport, readPage, rejectApproval, reloadManagedSources, removeWatchedRoot, resetDecay, resolveConsolidationConfig, resolveDecayConfig, resolveLargeRepoDefaults, resolvePaths, resolveRedactionPatterns, resolveWatchedRepoRoots, resumeSourceSession, reviewManagedSource, reviewSourceScope, runAutoPromotion, runConsolidation, runDecayPass, runMigration, runSchedule, runWatchCycle, searchVault, serveSchedules, stageGeneratedOutputPages, startGraphServer, startMcpServer, syncTrackedRepos, syncTrackedReposForWatch, synthesizeHyperedgeHubs, trimToTokenBudget, uninstallGitHooks, watchVault, webSearchProviderTypeSchema, withCapabilityFallback };
+export { ALL_MIGRATIONS, type AddOptions, type AddResult, type AgentType, type AnalyzedTerm, type ApprovalBundleType, type ApprovalChangeType, type ApprovalDetail, type ApprovalDiffHunk, type ApprovalDiffLine, type ApprovalEntry, type ApprovalEntryDetail, type ApprovalEntryLabel, type ApprovalEntryStatus, type ApprovalFrontmatterChange, type ApprovalManifest, type ApprovalStructuredDiff, type ApprovalSummary, type AudioTranscriptionRequest, type AudioTranscriptionResponse, type BenchmarkArtifact, type BenchmarkByClassEntry, type BenchmarkOptions, type BenchmarkQuestionResult, type BenchmarkSummary, type BlastRadiusResult, type CandidatePromotionConfig, type CandidateRecord, type ChartDatum, type ChartSpec, type ClaimStatus, type CodeAnalysis, type CodeDiagnostic, type CodeImport, type CodeIndexArtifact, type CodeIndexEntry, type CodeLanguage, type CodeSymbol, type CodeSymbolKind, type CommandRoleExecutorConfig, type CompileOptions, type CompileResult, type CompileState, type ConsolidationConfig, type ConsolidationPromotion, type ConsolidationResult, DEFAULT_CONSOLIDATION_CONFIG, DEFAULT_HALF_LIFE_DAYS, DEFAULT_HALF_LIFE_DAYS_BY_SOURCE_CLASS, DEFAULT_PROMOTION_CONFIG, DEFAULT_REDACTION_PATTERNS, DEFAULT_STALE_THRESHOLD, type DegradationOutcome, type DirectoryIngestFailure, type DirectoryIngestResult, type DirectoryIngestSkip, type EmbeddingCacheArtifact, type EmbeddingCacheEntry, type EvidenceClass, type ExploreOptions, type ExploreResult, type ExploreStepResult, type ExtractionClaim, type ExtractionKind, type ExtractionTerm, type Freshness, type FreshnessConfig, type GenerationAttachment, type GenerationRequest, type GenerationResponse, type GitHookStatus, type GraphArtifact, type GraphDiffResult, type GraphEdge, type GraphExplainNeighbor, type GraphExplainResult, type GraphExportFormat, type GraphExportResult, type GraphHyperedge, type GraphNode, type GraphPage, type GraphPathResult, type GraphPushCounts, type GraphPushNeo4jOptions, type GraphPushResult, type GraphQueryMatch, type GraphQueryResult, type GraphReportArtifact, type GraphShareArtifact, type GuidedSessionMode, type GuidedSourceSessionAnswers, type GuidedSourceSessionQuestion, type GuidedSourceSessionRecord, type GuidedSourceSessionStatus, type ImageGenerationRequest, type ImageGenerationResponse, type ImageVisionExtraction, type InboxImportResult, type InboxImportSkip, type IngestOptions, type InitOptions, type InputIngestResult, type InstallAgentOptions, type InstallAgentResult, LARGE_REPO_NODE_THRESHOLD, LOCAL_WHISPER_MODEL_SIZES, type LintFinding, type LintOptions, type LocalWhisperAdapterOptions, type LocalWhisperBinaryDiscovery, LocalWhisperProviderAdapter, type LocalWhisperSetupStatus, type ManagedSourceAddOptions, type ManagedSourceAddResult, type ManagedSourceDeleteResult, type ManagedSourceKind, type ManagedSourceRecord, type ManagedSourceReloadOptions, type ManagedSourceReloadResult, type ManagedSourceStatus, type ManagedSourceSyncCounts, type ManagedSourcesArtifact, type MemoryTier, type MigrationPlan, type MigrationResult, type MigrationStep, type Neo4jGraphSinkConfig, OPENAI_COMPATIBLE_CAPABILITY_MATRIX, type OpenAiCompatiblePresetId, type OrchestrationConfig, type OrchestrationFinding, type OrchestrationProposal, type OrchestrationRole, type OrchestrationRoleConfig, type OrchestrationRoleResult, type OutputAsset, type OutputAssetRole, type OutputFormat, type OutputOrigin, type PageKind, type PageManager, type PageStatus, type PendingSemanticRefreshEntry, type Polarity, type PromotionDecision, type PromotionGateKind, type PromotionGateResult, type PromotionSession, type ProviderAdapter, type ProviderCapability, type ProviderConfig, type ProviderPresetCapability, type ProviderRegistrationOptions, type ProviderRegistrationResult, type ProviderRoleExecutorConfig, type ProviderType, type QueryOptions, type QueryResult, type RedactionMatchSummary, type RedactionPatternConfig, type RedactionSettings, type RedactionSummary, type RepoSyncResult, type ResolvedLargeRepoDefaults, type ResolvedPaths, type ReviewActionResult, type RoleExecutorConfig, type SceneElement, type SceneSpec, type ScheduleController, type ScheduleJobConfig, type ScheduleStateRecord, type ScheduleTriggerConfig, type ScheduledCompileTask, type ScheduledConsolidateTask, type ScheduledExploreTask, type ScheduledLintTask, type ScheduledQueryTask, type ScheduledRunResult, type ScheduledTaskConfig, type SearchResult, type SourceAnalysis, type SourceAttachment, type SourceCaptureType, type SourceClaim, type SourceClass, type SourceExtractionArtifact, type SourceGuideResult, type SourceKind, type SourceManifest, type SourceRationale, type SourceReviewResult, type SynthesizedHubEdge, type SynthesizedHubNode, type SynthesizedHyperedgeHubs, type VaultConfig, type VaultDashboardPack, type VaultProfileConfig, type VaultProfilePreset, type VaultVersionRecord, type WatchConfig, type WatchController, type WatchOptions, type WatchRepoSyncResult, type WatchRunRecord, type WatchStatusResult, type WebSearchAdapter, type WebSearchProviderConfig, type WebSearchProviderType, type WebSearchResult, type WhisperRunResult, type WhisperRunner, acceptApproval, addInput, addManagedSource, addWatchedRoot, agentTypeSchema, applyDecayToPages, archiveCandidate, assertProviderCapability, autoCommitWikiChanges, benchmarkVault, blastRadius, blastRadiusVault, bootstrapDemo, buildConfiguredRedactor, buildGraphShareArtifact, buildRedactor, compileVault, computeDecayScore, consolidateVault, createMcpServer, createProvider, createSupersessionEdge, createWebSearchAdapter, defaultVaultConfig, defaultVaultSchema, deleteManagedSource, detectVaultVersion, discoverLocalWhisperBinary, downloadWhisperModel, estimatePageTokens, estimateTokens, evaluateCandidateForPromotion, expectedModelPath, explainGraphVault, exploreVault, exportGraphFormat, exportGraphHtml, exportGraphReportHtml, exportObsidianCanvas, exportObsidianVault, getGitHookStatus, getProviderForTask, getWatchStatus, getWebSearchAdapterForTask, getWorkspaceInfo, graphDiff, guideManagedSource, guideSourceScope, importInbox, ingestDirectory, ingestInput, ingestInputDetailed, initVault, initWorkspace, installAgent, installConfiguredAgents, installGitHooks, lintVault, listApprovals, listCandidates, listGodNodes, listGraphHyperedges, listManagedSourceRecords, listManifests, listPages, listSchedules, listTrackedRepoRoots, listWatchedRoots, loadVaultConfig, loadVaultSchema, loadVaultSchemas, lookupPresetCapabilities, markSuperseded, modelDownloadUrl, pathGraphVault, persistDecayFrontmatter, planMigration, previewCandidatePromotions, promoteCandidate, providerCapabilitySchema, providerTypeSchema, pushGraphNeo4j, queryGraphVault, queryVault, readApproval, readExtractedText, readGraphReport, readPage, registerLocalWhisperProvider, rejectApproval, reloadManagedSources, removeWatchedRoot, renderGraphShareMarkdown, resetDecay, resolveConsolidationConfig, resolveDecayConfig, resolveLargeRepoDefaults, resolvePaths, resolveRedactionPatterns, resolveWatchedRepoRoots, resumeSourceSession, reviewManagedSource, reviewSourceScope, runAutoPromotion, runConsolidation, runDecayPass, runMigration, runSchedule, runWatchCycle, searchVault, serveSchedules, stageGeneratedOutputPages, startGraphServer, startMcpServer, summarizeLocalWhisperSetup, syncTrackedRepos, syncTrackedReposForWatch, synthesizeHyperedgeHubs, trimToTokenBudget, uninstallGitHooks, watchVault, webSearchProviderTypeSchema, withCapabilityFallback };