@swarmvaultai/engine 0.4.0 → 0.6.0

package/dist/index.d.ts

@@ -54,6 +54,9 @@ type PageStatus = "draft" | "candidate" | "active" | "archived";
 type PageManager = "system" | "human";
 type ApprovalEntryStatus = "pending" | "accepted" | "rejected";
 type ApprovalChangeType = "create" | "update" | "delete" | "promote";
+type ApprovalBundleType = "compile" | "generated_output" | "source_review" | "guided_source" | "guided_session";
+type ApprovalEntryLabel = "source-brief" | "source-review" | "source-guide" | "guided-update";
+type GuidedSourceSessionStatus = "awaiting_input" | "ready_to_stage" | "staged" | "accepted" | "rejected";
 type SourceKind = "markdown" | "text" | "pdf" | "image" | "html" | "docx" | "epub" | "csv" | "xlsx" | "pptx" | "transcript" | "chat_export" | "email" | "calendar" | "binary" | "code";
 type SourceCaptureType = "arxiv" | "doi" | "tweet" | "article" | "url";
 type SourceClass = "first_party" | "third_party" | "resource" | "generated";
@@ -218,6 +221,7 @@ interface ResolvedPaths {
     benchmarkPath: string;
     jobsLogPath: string;
     sessionsDir: string;
+    sourceSessionsDir: string;
     approvalsDir: string;
     watchDir: string;
     watchStatusPath: string;
@@ -585,15 +589,22 @@ interface ApprovalEntry {
     sourceIds: string[];
     nextPath?: string;
     previousPath?: string;
+    label?: ApprovalEntryLabel;
 }
 interface ApprovalManifest {
     approvalId: string;
     createdAt: string;
+    bundleType?: ApprovalBundleType;
+    title?: string;
+    sourceSessionId?: string;
     entries: ApprovalEntry[];
 }
 interface ApprovalSummary {
     approvalId: string;
     createdAt: string;
+    bundleType?: ApprovalBundleType;
+    title?: string;
+    sourceSessionId?: string;
     entryCount: number;
     pendingCount: number;
     acceptedCount: number;
@@ -626,6 +637,7 @@ interface CompileOptions {
 }
 interface InitOptions {
     obsidian?: boolean;
+    profile?: "default" | "personal-research";
 }
 interface CompileResult {
     graphPath: string;
@@ -763,6 +775,8 @@ interface ManagedSourceAddOptions {
     compile?: boolean;
     brief?: boolean;
     review?: boolean;
+    guide?: boolean;
+    guideAnswers?: GuidedSourceSessionAnswers;
     maxPages?: number;
     maxDepth?: number;
 }
@@ -775,16 +789,43 @@ interface ManagedSourceAddResult {
     compile?: CompileResult;
     briefGenerated: boolean;
     review?: SourceReviewResult;
+    guide?: SourceGuideResult;
 }
 interface ManagedSourceReloadResult {
     sources: ManagedSourceRecord[];
     compile?: CompileResult;
     briefPaths: string[];
     reviews: SourceReviewResult[];
+    guides: SourceGuideResult[];
 }
 interface ManagedSourceDeleteResult {
     removed: ManagedSourceRecord;
 }
+interface GuidedSourceSessionQuestion {
+    id: string;
+    prompt: string;
+    answer?: string;
+}
+type GuidedSourceSessionAnswers = Record<string, string> | string[];
+interface GuidedSourceSessionRecord {
+    sessionId: string;
+    scopeId: string;
+    scopeTitle: string;
+    sourceIds: string[];
+    kind?: string;
+    status: GuidedSourceSessionStatus;
+    createdAt: string;
+    updatedAt: string;
+    questions: GuidedSourceSessionQuestion[];
+    briefPath?: string;
+    reviewPath?: string;
+    guidePath?: string;
+    sessionPath?: string;
+    approvalId?: string;
+    approvalDir?: string;
+    targetedPagePaths: string[];
+    stagedUpdatePaths: string[];
+}
 interface SourceReviewResult {
     sourceId: string;
     pageId: string;
@@ -793,6 +834,25 @@ interface SourceReviewResult {
     approvalId?: string;
     approvalDir?: string;
 }
+interface SourceGuideResult {
+    sourceId: string;
+    pageId?: string;
+    guidePath?: string;
+    reviewPageId?: string;
+    reviewPath?: string;
+    sessionId: string;
+    sessionPath: string;
+    sessionStatePath: string;
+    status: GuidedSourceSessionStatus;
+    questions: GuidedSourceSessionQuestion[];
+    awaitingInput?: boolean;
+    targetedPagePaths: string[];
+    stagedUpdatePaths: string[];
+    briefPath?: string;
+    staged: boolean;
+    approvalId?: string;
+    approvalDir?: string;
+}
 interface GitHookStatus {
     repoRoot: string | null;
     postCommit: "installed" | "not_installed" | "other_content";
@@ -1196,13 +1256,15 @@ declare function installAgent(rootDir: string, agent: AgentType, options?: Insta
 declare function installConfiguredAgents(rootDir: string): Promise<InstallAgentResult[]>;
 
 declare function defaultVaultConfig(): VaultConfig;
-declare function defaultVaultSchema(): string;
+declare function defaultVaultSchema(profile?: "default" | "personal-research"): string;
 declare function resolvePaths(rootDir: string, config?: VaultConfig, configPath?: string, schemaPath?: string): ResolvedPaths;
 declare function loadVaultConfig(rootDir: string): Promise<{
     config: VaultConfig;
     paths: ResolvedPaths;
 }>;
-declare function initWorkspace(rootDir: string): Promise<{
+declare function initWorkspace(rootDir: string, options?: {
+    profile?: "default" | "personal-research";
+}): Promise<{
     config: VaultConfig;
     paths: ResolvedPaths;
 }>;
@@ -1270,13 +1332,24 @@ interface LoadedVaultSchemas {
 declare function loadVaultSchemas(rootDir: string): Promise<LoadedVaultSchemas>;
 declare function loadVaultSchema(rootDir: string): Promise<VaultSchema>;
 
-type SourceReviewScope = {
+type SourceScope = {
     id: string;
     title: string;
     sourceIds: string[];
+    kind?: string;
+    briefPath?: string;
 };
-declare function reviewSourceScope(rootDir: string, scope: SourceReviewScope): Promise<SourceReviewResult>;
+declare function reviewSourceScope(rootDir: string, scope: SourceScope): Promise<SourceReviewResult>;
+declare function guideSourceScope(rootDir: string, scope: SourceScope, options?: {
+    answers?: GuidedSourceSessionAnswers;
+}): Promise<SourceGuideResult>;
 declare function reviewManagedSource(rootDir: string, id: string): Promise<SourceReviewResult>;
+declare function guideManagedSource(rootDir: string, id: string, options?: {
+    answers?: GuidedSourceSessionAnswers;
+}): Promise<SourceGuideResult>;
+declare function resumeSourceSession(rootDir: string, id: string, options?: {
+    answers?: GuidedSourceSessionAnswers;
+}): Promise<SourceGuideResult>;
 declare function listManagedSourceRecords(rootDir: string): Promise<ManagedSourceRecord[]>;
 declare function addManagedSource(rootDir: string, input: string, options?: ManagedSourceAddOptions): Promise<ManagedSourceAddResult>;
 declare function reloadManagedSources(rootDir: string, options?: ManagedSourceReloadOptions): Promise<ManagedSourceReloadResult>;
@@ -1295,7 +1368,12 @@ declare function stageGeneratedOutputPages(rootDir: string, stagedPages: Array<{
     page: GraphPage;
     content: string;
     assetFiles?: GeneratedOutputArtifacts["assetFiles"];
-}>): Promise<{
+    label?: ApprovalEntryLabel;
+}>, options?: {
+    bundleType?: ApprovalBundleType;
+    title?: string;
+    sourceSessionId?: string;
+}): Promise<{
     approvalId: string;
     approvalDir: string;
 }>;
@@ -1379,4 +1457,4 @@ declare function getWatchStatus(rootDir: string): Promise<WatchStatusResult>;
 declare function createWebSearchAdapter(id: string, config: WebSearchProviderConfig, rootDir: string): Promise<WebSearchAdapter>;
 declare function getWebSearchAdapterForTask(rootDir: string, task: "deepLintProvider"): Promise<WebSearchAdapter>;
 
-export { type AddOptions, type AddResult, type AgentType, type AnalyzedTerm, type ApprovalChangeType, type ApprovalDetail, type ApprovalEntry, type ApprovalEntryDetail, type ApprovalEntryStatus, type ApprovalManifest, type ApprovalSummary, type BenchmarkArtifact, type BenchmarkOptions, type BenchmarkQuestionResult, type BenchmarkSummary, 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 DirectoryIngestResult, type DirectoryIngestSkip, type EmbeddingCacheArtifact, type EmbeddingCacheEntry, type EvidenceClass, type ExploreOptions, type ExploreResult, type ExploreStepResult, type ExtractionClaim, type ExtractionKind, type ExtractionTerm, type Freshness, type GenerationAttachment, type GenerationRequest, type GenerationResponse, type GitHookStatus, type GraphArtifact, 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 ImageGenerationRequest, type ImageGenerationResponse, type ImageVisionExtraction, type InboxImportResult, type InboxImportSkip, type IngestOptions, type InitOptions, type InputIngestResult, type InstallAgentOptions, type InstallAgentResult, 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 Neo4jGraphSinkConfig, 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 ProviderAdapter, type ProviderCapability, type ProviderConfig, type ProviderRoleExecutorConfig, type ProviderType, type QueryOptions, type QueryResult, type RepoSyncResult, type ResolvedPaths, type ReviewActionResult, type RoleExecutorConfig, type SceneElement, type SceneSpec, type ScheduleController, type ScheduleJobConfig, type ScheduleStateRecord, type ScheduleTriggerConfig, type ScheduledCompileTask, 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 SourceKind, type SourceManifest, type SourceRationale, type SourceReviewResult, type VaultConfig, type WatchController, type WatchOptions, type WatchRepoSyncResult, type WatchRunRecord, type WatchStatusResult, type WebSearchAdapter, type WebSearchProviderConfig, type WebSearchProviderType, type WebSearchResult, acceptApproval, addInput, addManagedSource, agentTypeSchema, archiveCandidate, assertProviderCapability, benchmarkVault, bootstrapDemo, compileVault, createMcpServer, createProvider, createWebSearchAdapter, defaultVaultConfig, defaultVaultSchema, deleteManagedSource, explainGraphVault, exploreVault, exportGraphFormat, exportGraphHtml, getGitHookStatus, getProviderForTask, getWatchStatus, getWebSearchAdapterForTask, getWorkspaceInfo, importInbox, ingestDirectory, ingestInput, ingestInputDetailed, initVault, initWorkspace, installAgent, installConfiguredAgents, installGitHooks, lintVault, listApprovals, listCandidates, listGodNodes, listGraphHyperedges, listManagedSourceRecords, listManifests, listPages, listSchedules, listTrackedRepoRoots, loadVaultConfig, loadVaultSchema, loadVaultSchemas, pathGraphVault, promoteCandidate, providerCapabilitySchema, providerTypeSchema, pushGraphNeo4j, queryGraphVault, queryVault, readApproval, readExtractedText, readGraphReport, readPage, rejectApproval, reloadManagedSources, resolvePaths, reviewManagedSource, reviewSourceScope, runSchedule, runWatchCycle, searchVault, serveSchedules, stageGeneratedOutputPages, startGraphServer, startMcpServer, syncTrackedRepos, syncTrackedReposForWatch, uninstallGitHooks, watchVault, webSearchProviderTypeSchema };
+export { type AddOptions, type AddResult, type AgentType, type AnalyzedTerm, type ApprovalBundleType, type ApprovalChangeType, type ApprovalDetail, type ApprovalEntry, type ApprovalEntryDetail, type ApprovalEntryLabel, type ApprovalEntryStatus, type ApprovalManifest, type ApprovalSummary, type BenchmarkArtifact, type BenchmarkOptions, type BenchmarkQuestionResult, type BenchmarkSummary, 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 DirectoryIngestResult, type DirectoryIngestSkip, type EmbeddingCacheArtifact, type EmbeddingCacheEntry, type EvidenceClass, type ExploreOptions, type ExploreResult, type ExploreStepResult, type ExtractionClaim, type ExtractionKind, type ExtractionTerm, type Freshness, type GenerationAttachment, type GenerationRequest, type GenerationResponse, type GitHookStatus, type GraphArtifact, 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 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, 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 Neo4jGraphSinkConfig, 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 ProviderAdapter, type ProviderCapability, type ProviderConfig, type ProviderRoleExecutorConfig, type ProviderType, type QueryOptions, type QueryResult, type RepoSyncResult, type ResolvedPaths, type ReviewActionResult, type RoleExecutorConfig, type SceneElement, type SceneSpec, type ScheduleController, type ScheduleJobConfig, type ScheduleStateRecord, type ScheduleTriggerConfig, type ScheduledCompileTask, 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 VaultConfig, type WatchController, type WatchOptions, type WatchRepoSyncResult, type WatchRunRecord, type WatchStatusResult, type WebSearchAdapter, type WebSearchProviderConfig, type WebSearchProviderType, type WebSearchResult, acceptApproval, addInput, addManagedSource, agentTypeSchema, archiveCandidate, assertProviderCapability, benchmarkVault, bootstrapDemo, compileVault, createMcpServer, createProvider, createWebSearchAdapter, defaultVaultConfig, defaultVaultSchema, deleteManagedSource, explainGraphVault, exploreVault, exportGraphFormat, exportGraphHtml, getGitHookStatus, getProviderForTask, getWatchStatus, getWebSearchAdapterForTask, getWorkspaceInfo, guideManagedSource, guideSourceScope, importInbox, ingestDirectory, ingestInput, ingestInputDetailed, initVault, initWorkspace, installAgent, installConfiguredAgents, installGitHooks, lintVault, listApprovals, listCandidates, listGodNodes, listGraphHyperedges, listManagedSourceRecords, listManifests, listPages, listSchedules, listTrackedRepoRoots, loadVaultConfig, loadVaultSchema, loadVaultSchemas, pathGraphVault, promoteCandidate, providerCapabilitySchema, providerTypeSchema, pushGraphNeo4j, queryGraphVault, queryVault, readApproval, readExtractedText, readGraphReport, readPage, rejectApproval, reloadManagedSources, resolvePaths, resumeSourceSession, reviewManagedSource, reviewSourceScope, runSchedule, runWatchCycle, searchVault, serveSchedules, stageGeneratedOutputPages, startGraphServer, startMcpServer, syncTrackedRepos, syncTrackedReposForWatch, uninstallGitHooks, watchVault, webSearchProviderTypeSchema };