wiki-graph-sdk 0.7.0 → 0.8.0

package/dist/index.d.ts

@@ -1,11 +1,13 @@
 import { WikiGraphArchiveManager } from './archives.js';
-export { WikiGraphArchiveCover, WikiGraphArchiveCreateOptions, WikiGraphArchiveCreateResult, WikiGraphArchiveEvidenceOptions, WikiGraphArchiveExistsError, WikiGraphArchiveHandle, WikiGraphArchiveIndexStatus, WikiGraphArchiveIndexSyncOptions, WikiGraphArchiveInspectChapterReference, WikiGraphArchiveInspectCoverage, WikiGraphArchiveInspectImprovement, WikiGraphArchiveInspectReport, WikiGraphArchiveListOptions, WikiGraphArchiveLocation, WikiGraphArchivePageOptions, WikiGraphArchiveRelatedOptions, WikiGraphArchiveScope, WikiGraphArchiveScopeOptions, WikiGraphArchiveSearchOptions, WikiGraphArchiveWriteOptions, WikiGraphChapterArtifactStatus, WikiGraphChapterMoveOptions, WikiGraphChapterResetStage, WikiGraphChapterSourceOptions, WikiGraphChapterTreeInput, WikiGraphOperationOptions, createWikiGraphArchiveInspectReport, resolveWikiGraphArchiveLocation } from './archives.js';
+export { WikiGraphArchiveChapterInspection, WikiGraphArchiveCover, WikiGraphArchiveCreateOptions, WikiGraphArchiveCreateResult, WikiGraphArchiveEvidenceOptions, WikiGraphArchiveExistsError, WikiGraphArchiveHandle, WikiGraphArchiveIndexArtifactInspection, WikiGraphArchiveIndexStatus, WikiGraphArchiveIndexSyncOptions, WikiGraphArchiveInspection, WikiGraphArchiveListOptions, WikiGraphArchivePageOptions, WikiGraphArchiveRelatedOptions, WikiGraphArchiveScope, WikiGraphArchiveScopeOptions, WikiGraphArchiveSearchOptions, WikiGraphArchiveWriteOptions, WikiGraphChapterArtifactStatus, WikiGraphChapterMoveOptions, WikiGraphChapterResetStage, WikiGraphChapterSourceOptions, WikiGraphChapterTreeInput, WikiGraphOperationOptions, inspectWikiGraphArchive } from './archives.js';
+import { W as WikiGraphArchiveTarget } from './target-CZ7elwmj.js';
+export { a as WikiGraphArchiveOwnershipError } from './target-CZ7elwmj.js';
 import { LocalConfigSection, LocalConfigObject } from './local-config.js';
 export { LOCAL_CONFIG_SECTIONS, clearLocalConfigSection, deleteLocalConfigValue, maskLocalConfigSection, normalizeLocalConfigKey, parseLocalConfigSection, putLocalConfigValue, readLocalConfigSection, replaceLocalConfigSection, validateLocalConfigSection } from './local-config.js';
-import { W as WikiGraphJobRuntime, a as WikiGraphJobManager } from './jobs-Dd5PMSId.js';
-export { b as WikiGraphJob, c as WikiGraphJobBackend, d as WikiGraphJobChapterReference, e as WikiGraphJobCreateOptions, f as WikiGraphJobEnqueueOptions, g as WikiGraphJobEnqueuePlan, h as WikiGraphJobEnqueueResult, i as WikiGraphJobEventListener, j as WikiGraphJobEventsOptions, k as WikiGraphJobListOptions, l as WikiGraphJobSubscriptionOptions } from './jobs-Dd5PMSId.js';
-import { ContinuationCursor, QueryIndexScope, ArchiveSourceLocatorResult, ArchiveCollectionResult, ArchiveFindResult, ArchiveEvidence, ArchiveRelatedResult, WikiGraphLibraryRecord, WikiGraphLibraryArchiveRecord, WikiGraphLibraryScanResult, ParsedWikiGraphLibraryUri, WikiGraphLibraryIndexState, rebuildWikiGraphLibraryIndex, ArchiveFindOptions, ArchiveCollectionOptions, readWikiGraphLibraryPage, ArchivePage, listRelatedWikiGraphLibraryObjects, listWikiGraphLibraryEvidence, ArchivePack } from 'wiki-graph-core';
-export { ArchiveBacklinkBucket, ArchiveBacklinks, ArchiveCollectionOptions, ArchiveCollectionResult, ArchiveEvidence, ArchiveEvidenceItem, ArchiveFindEvidencePreview, ArchiveFindHit, ArchiveFindOptions, ArchiveFindResult, ArchiveListItem, ArchivePack, ArchivePage, ArchiveRelatedResult, ArchiveSourceLocator, ArchiveSourceLocatorResult, ArchiveTriplePattern, BookMeta, BuildJob, BuildJobEvent, BuildJobProgressCounter, BuildJobTarget, ChapterDetails, ChapterEntry, ChapterStage, ChapterTree, ChapterTreeApplyResult, ContinuationCursor, DEFAULT_EXTRACTION_PROMPT, DEFAULT_KNOWLEDGE_GRAPH_RECALL_PROMPT, File, IndexArtifactKind, LLMPaymentRequiredError, LocatedWikiGraphUri, ParsedWikiGraphLibraryUri, QueryIndexScope, SearchIndexEmbeddingProvider, WIKI_GRAPH_URI_PREFIX, WikiGraphError, WikiGraphLLMOptions, WikiGraphLibraryArchiveRecord, WikiGraphLibraryIndexState, WikiGraphLibraryRecord, WikiGraphLibraryScanResult, WikiGraphMaintenanceUpgradeResult, WikiGraphProgressCallback, WikiGraphProgressEvent, WikispineProvider, formatError, formatLocatedChapterResourceUri, formatLocatedChapterSourceCollectionUri, formatLocatedChapterUri, formatLocatedWikiGraphUri, formatWikiGraphCommandUri, formatWikiGraphLibraryUri, isSourceLocatorScopeUri, isWikiGraphLibraryUri, parseChapterPath, parseChapterTreeInput, parseChapterUriPath, parseLocatedWikiGraphUri, parseSourceTextJsonl, parseWikiGraphLibraryUri, parseWikiGraphUriSyntax, resolveExtractionPrompt, resolveKnowledgeGraphRecallPrompt } from 'wiki-graph-core';
+import { W as WikiGraphJobRuntime, a as WikiGraphJobManager } from './jobs-xIm_kshM.js';
+export { b as WikiGraphJob, c as WikiGraphJobBackend, d as WikiGraphJobChapterReference, e as WikiGraphJobCreateOptions, f as WikiGraphJobEnqueueOptions, g as WikiGraphJobEnqueuePlan, h as WikiGraphJobEnqueueResult, i as WikiGraphJobEventListener, j as WikiGraphJobEventsOptions, k as WikiGraphJobListOptions, l as WikiGraphJobSnapshot, m as WikiGraphJobSubscriptionOptions } from './jobs-xIm_kshM.js';
+import { ContinuationCursor, QueryIndexScope, ArchiveSourceLocatorResult, ArchiveCollectionResult, ArchiveFindResult, ArchiveEvidence, ArchiveRelatedResult, WikiGraphLibraryRecord, WikiGraphLibraryArchiveRecord, ParsedWikiGraphLibraryUri, WikiGraphLibraryIndexState, rebuildWikiGraphLibraryIndex, ArchiveFindOptions, ArchiveCollectionOptions, readWikiGraphLibraryPage, ArchivePage, listRelatedWikiGraphLibraryObjects, listWikiGraphLibraryEvidence, ArchivePack } from 'wiki-graph-core';
+export { ArchiveBacklinkBucket, ArchiveBacklinks, ArchiveCollectionOptions, ArchiveCollectionResult, ArchiveEvidence, ArchiveEvidenceItem, ArchiveFindEvidencePreview, ArchiveFindHit, ArchiveFindOptions, ArchiveFindResult, ArchiveListItem, ArchivePack, ArchivePage, ArchiveRelatedResult, ArchiveSourceLocator, ArchiveSourceLocatorResult, ArchiveTriplePattern, BookMeta, BuildJobEvent, BuildJobProgressCounter, BuildJobTarget, ChapterDetails, ChapterEntry, ChapterStage, ChapterTree, ChapterTreeApplyResult, ContinuationCursor, DEFAULT_EXTRACTION_PROMPT, DEFAULT_KNOWLEDGE_GRAPH_RECALL_PROMPT, IndexArtifactKind, LLMPaymentRequiredError, LocatedWikiGraphUri, ParsedWikiGraphLibraryUri, QueryIndexScope, SearchIndexEmbeddingProvider, SourceArtifactInput, WIKI_GRAPH_URI_PREFIX, WikiGraphError, WikiGraphLLMOptions, WikiGraphLibraryIndexState, WikiGraphMaintenanceUpgradeResult, WikiGraphProgressCallback, WikiGraphProgressEvent, WikispineProvider, formatError, formatLocatedChapterResourceUri, formatLocatedChapterSourceCollectionUri, formatLocatedChapterUri, formatLocatedWikiGraphUri, formatWikiGraphCommandUri, formatWikiGraphLibraryUri, isSourceLocatorScopeUri, isWikiGraphLibraryUri, parseChapterPath, parseChapterTreeInput, parseChapterUriPath, parseLocatedWikiGraphUri, parseSourceTextJsonl, parseWikiGraphLibraryUri, parseWikiGraphUriSyntax, resolveExtractionPrompt, resolveKnowledgeGraphRecallPrompt } from 'wiki-graph-core';
 import { WikiGraphConversionManager } from './conversions.js';
 export { WikiGraphConversionFormat, WikiGraphConversionInput, WikiGraphConversionOptions, WikiGraphConversionResult, WikiGraphSourceFormat } from './conversions.js';
 export { WikiGraphQueueWorkerOptions, requireKnowledgeGraphWikispineConfig, runWikiGraphQueueWorker } from './default-worker.js';
@@ -55,7 +57,7 @@ declare class WikiGraphConfigManager {
 
 interface WikiGraphContinuationOptions {
     /** Optional archive locator used to verify that the cursor belongs to it. */
-    readonly archive?: string;
+    readonly archive?: WikiGraphArchiveTarget;
     readonly cursor: string;
     readonly format?: ContinuationCursor["format"];
     readonly limit?: number;
@@ -125,7 +127,9 @@ declare class WikiGraphContinuationManager {
 
 type WikiGraphLibraryTarget = ParsedWikiGraphLibraryUri | string;
 type WikiGraphLibrarySearchOptions = Omit<ArchiveFindOptions, "embeddingProvider">;
-type WikiGraphLibraryPageOptions = Omit<Parameters<typeof readWikiGraphLibraryPage>[2], "wikimediaResolver">;
+type WikiGraphLibraryPageOptions = Omit<Parameters<typeof readWikiGraphLibraryPage>[2], "wikimediaResolver"> & {
+    readonly signal?: AbortSignal;
+};
 interface WikiGraphLibraryAddArchiveOptions {
     readonly inputPath: string;
     readonly target: WikiGraphLibraryTarget;
@@ -135,19 +139,32 @@ interface WikiGraphLibraryMoveArchiveOptions {
     readonly target: WikiGraphLibraryTarget;
     readonly to: string;
 }
+interface WikiGraphLibraryReplaceArchiveOptions {
+    readonly inputPath: string;
+    readonly target: WikiGraphLibraryTarget;
+}
+interface WikiGraphLibrarySnapshot extends Omit<WikiGraphLibraryRecord, "folder" | "staging"> {
+    readonly folderPath: string;
+}
+type WikiGraphLibraryArchiveSnapshot = Omit<WikiGraphLibraryArchiveRecord, "file">;
+interface WikiGraphLibraryScanSnapshot {
+    readonly archives: readonly WikiGraphLibraryArchiveSnapshot[];
+    readonly library?: WikiGraphLibrarySnapshot;
+}
 declare class WikiGraphLibraryManager {
     #private;
     constructor(runtime: WikiGraphJobRuntime);
     create(folder: string): Promise<WikiGraphLibrary>;
     get(uri?: string): Promise<WikiGraphLibrary>;
-    addArchive(options: WikiGraphLibraryAddArchiveOptions): Promise<WikiGraphLibraryArchiveRecord>;
+    addArchive(options: WikiGraphLibraryAddArchiveOptions): Promise<WikiGraphLibraryArchiveSnapshot>;
     assertCurrent(target: WikiGraphLibraryTarget): Promise<void>;
-    rebind(target: WikiGraphLibraryTarget, folder: string): Promise<WikiGraphLibraryScanResult>;
-    remove(target: WikiGraphLibraryTarget): Promise<WikiGraphLibraryRecord>;
-    scan(target: WikiGraphLibraryTarget): Promise<WikiGraphLibraryScanResult>;
-    getArchive(target: WikiGraphLibraryTarget): Promise<WikiGraphLibraryArchiveRecord>;
-    moveArchive(options: WikiGraphLibraryMoveArchiveOptions): Promise<WikiGraphLibraryArchiveRecord>;
-    removeArchive(target: WikiGraphLibraryTarget): Promise<WikiGraphLibraryArchiveRecord>;
+    rebind(target: WikiGraphLibraryTarget, folder: string): Promise<WikiGraphLibraryScanSnapshot>;
+    remove(target: WikiGraphLibraryTarget): Promise<WikiGraphLibrarySnapshot>;
+    scan(target: WikiGraphLibraryTarget): Promise<WikiGraphLibraryScanSnapshot>;
+    getArchive(target: WikiGraphLibraryTarget): Promise<WikiGraphLibraryArchiveSnapshot>;
+    moveArchive(options: WikiGraphLibraryMoveArchiveOptions): Promise<WikiGraphLibraryArchiveSnapshot>;
+    removeArchive(target: WikiGraphLibraryTarget): Promise<WikiGraphLibraryArchiveSnapshot>;
+    replaceArchive(options: WikiGraphLibraryReplaceArchiveOptions): Promise<WikiGraphLibraryArchiveSnapshot>;
     indexState(target: WikiGraphLibraryTarget): Promise<WikiGraphLibraryIndexState>;
     rebuildIndex(target: WikiGraphLibraryTarget, onProgress?: Parameters<typeof rebuildWikiGraphLibraryIndex>[1]): Promise<WikiGraphLibraryIndexState>;
     cleanIndex(target: WikiGraphLibraryTarget): Promise<WikiGraphLibraryIndexState>;
@@ -169,11 +186,11 @@ declare class WikiGraphLibraryManager {
 declare class WikiGraphLibrary {
     #private;
     constructor(runtime: WikiGraphJobRuntime, record: WikiGraphLibraryRecord);
-    get snapshot(): WikiGraphLibraryRecord;
+    get snapshot(): WikiGraphLibrarySnapshot;
     get uri(): string;
-    archives(): Promise<readonly WikiGraphLibraryArchiveRecord[]>;
-    scan(): Promise<WikiGraphLibraryScanResult>;
-    remove(): Promise<WikiGraphLibraryRecord>;
+    archives(): Promise<readonly WikiGraphLibraryArchiveSnapshot[]>;
+    scan(): Promise<WikiGraphLibraryScanSnapshot>;
+    remove(): Promise<WikiGraphLibrarySnapshot>;
 }
 
 type WikiGraphSDKEnvPolicy = "development" | "production";
@@ -210,4 +227,4 @@ declare class WikiGraphSDK implements WikiGraphJobRuntime {
 }
 declare function createWikiGraphSDK(options?: WikiGraphSDKOptions): WikiGraphSDK;
 
-export { LocalConfigObject, LocalConfigSection, WikiGraphArchiveManager, WikiGraphConfigManager, type WikiGraphContinuationContext, WikiGraphContinuationManager, type WikiGraphContinuationOptions, type WikiGraphContinuationPage, WikiGraphConversionManager, WikiGraphJobManager, WikiGraphJobRuntime, WikiGraphLibrary, type WikiGraphLibraryAddArchiveOptions, WikiGraphLibraryManager, type WikiGraphLibraryMoveArchiveOptions, type WikiGraphLibraryPageOptions, type WikiGraphLibrarySearchOptions, type WikiGraphLibraryTarget, WikiGraphMaintenanceManager, type WikiGraphProviderTestResult, WikiGraphSDK, type WikiGraphSDKEnvPolicy, type WikiGraphSDKOptions, type WikiGraphSDKRuntimeContext, createWikiGraphSDK, getWikiGraphSDKRuntimeContext, getWikiGraphSDKStateDir, withWikiGraphSDKRuntimeContext };
+export { LocalConfigObject, LocalConfigSection, WikiGraphArchiveManager, WikiGraphArchiveTarget, WikiGraphConfigManager, type WikiGraphContinuationContext, WikiGraphContinuationManager, type WikiGraphContinuationOptions, type WikiGraphContinuationPage, WikiGraphConversionManager, WikiGraphJobManager, WikiGraphJobRuntime, WikiGraphLibrary, type WikiGraphLibraryAddArchiveOptions, type WikiGraphLibraryArchiveSnapshot, WikiGraphLibraryManager, type WikiGraphLibraryMoveArchiveOptions, type WikiGraphLibraryPageOptions, type WikiGraphLibraryReplaceArchiveOptions, type WikiGraphLibraryScanSnapshot, type WikiGraphLibrarySearchOptions, type WikiGraphLibrarySnapshot, type WikiGraphLibraryTarget, WikiGraphMaintenanceManager, type WikiGraphProviderTestResult, WikiGraphSDK, type WikiGraphSDKEnvPolicy, type WikiGraphSDKOptions, type WikiGraphSDKRuntimeContext, createWikiGraphSDK, getWikiGraphSDKRuntimeContext, getWikiGraphSDKStateDir, withWikiGraphSDKRuntimeContext };