wiki-graph-sdk 0.7.0

package/dist/index.d.ts

@@ -0,0 +1,213 @@
+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';
+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 { WikiGraphConversionManager } from './conversions.js';
+export { WikiGraphConversionFormat, WikiGraphConversionInput, WikiGraphConversionOptions, WikiGraphConversionResult, WikiGraphSourceFormat } from './conversions.js';
+export { WikiGraphQueueWorkerOptions, requireKnowledgeGraphWikispineConfig, runWikiGraphQueueWorker } from './default-worker.js';
+export { DANGEROUS_RUNTIME_ENV_NAMES, WikiGraphEntryEnvPolicy, WikiGraphEntryRuntimeContext, WikiGraphEntryRuntimeOptions, createEntryRuntimeContext } from './entry-context.js';
+export { QueryEmbeddingResult, WikiGraphEmbeddingConfig, WikiGraphEmbeddingProvider, buildSearchIndexEmbeddingProvider, embedQueryText, embedQueryTextWithLocalConfig, readWikiGraphEmbeddingConfig } from './embedding.js';
+export { buildWikiGraphLLMOptions } from './llm.js';
+import { WikiGraphMaintenanceManager } from './maintenance.js';
+export { WikiGraphLegacyMigrationResult, WikiGraphMaintenanceTarget } from './maintenance.js';
+export { NodeDirectory, NodeFile, createNodeTemplateEnvironment, createNodeWikiGraphStorage, ensureNodeWikiGraphPlatform, getNodeResourcePath, installNodeWikiGraphPlatform, nodeWikiGraphPlatform, withNodeWikiGraphStorage, writeNodeFileHandle } from './node-platform.js';
+export { DEFAULT_GENERATION_JOB_CONCURRENCY, DEFAULT_GENERATION_REQUEST_CONCURRENCY, GenerationConcurrency, GenerationPerformanceHint, GenerationPlanningCost, createGenerationPerformanceHints, formatGenerationPlanningDuration, formatGenerationPlanningModel, planGenerationTask } from './planning.js';
+export { HostedProviderScope, WikiGraphProvider, WikiGraphRuntimeConfig, loadWikiGraphRuntimeConfig, resolveHostedProviderEndpoint, resolveWikispineConfig } from './runtime-config.js';
+export { createStageLLM, loadRequiredStageConfig } from './stage.js';
+export { nodeWikispineCommandRunner } from './wikispine.js';
+import 'zod';
+import 'node:fs/promises';
+import 'nunjucks';
+import 'wiki-graph-core/platform';
+
+interface WikiGraphProviderTestResult {
+    readonly durationMs: number;
+    readonly model?: string;
+    readonly provider?: string;
+    readonly response?: string;
+    readonly dimensions?: number;
+    readonly tokens?: number;
+    readonly endpoint?: string;
+    readonly metadata?: {
+        readonly format: string;
+        readonly qid_count: number;
+        readonly surface_count: number;
+    };
+}
+declare class WikiGraphConfigManager {
+    #private;
+    constructor(runtime: WikiGraphJobRuntime);
+    get(section: LocalConfigSection, options?: {
+        readonly maskSecrets?: boolean;
+    }): Promise<LocalConfigObject>;
+    replace(section: LocalConfigSection, value: LocalConfigObject): Promise<LocalConfigObject>;
+    put(section: LocalConfigSection, key: string, value: unknown): Promise<LocalConfigObject>;
+    delete(section: LocalConfigSection, key: string): Promise<LocalConfigObject>;
+    clear(section: LocalConfigSection): Promise<LocalConfigObject>;
+    testLLM(): Promise<WikiGraphProviderTestResult>;
+    testEmbedding(): Promise<WikiGraphProviderTestResult>;
+    testWikispine(): Promise<WikiGraphProviderTestResult>;
+}
+
+interface WikiGraphContinuationOptions {
+    /** Optional archive locator used to verify that the cursor belongs to it. */
+    readonly archive?: string;
+    readonly cursor: string;
+    readonly format?: ContinuationCursor["format"];
+    readonly limit?: number;
+    readonly signal?: AbortSignal;
+}
+interface WikiGraphContinuationContext {
+    readonly archiveKey: string;
+    readonly archivePath: string;
+    readonly backlinks?: boolean;
+    readonly chapters?: readonly number[];
+    readonly continuationKind?: ContinuationCursor["kind"];
+    readonly evidenceLimit?: number;
+    readonly format: ContinuationCursor["format"];
+    readonly ids?: readonly string[];
+    readonly indexScope: QueryIndexScope;
+    readonly libraryQuery?: "archive-members" | "objects";
+    readonly order?: "doc-asc" | "doc-desc";
+    readonly query?: string;
+    readonly role?: "any" | "object" | "self" | "subject" | undefined;
+    readonly skipUnindexed?: boolean;
+    readonly sourceContext?: number;
+    readonly targetUri?: string;
+    readonly triplePattern?: {
+        readonly objectQid?: string;
+        readonly predicate?: string;
+        readonly subjectQid?: string;
+    } | undefined;
+    readonly types: readonly string[] | null;
+}
+type ContinuationPageBase<TCursor extends ContinuationCursor> = {
+    readonly cursor: TCursor;
+    readonly format: TCursor["format"];
+    readonly limit: number;
+};
+type WikiGraphContinuationPage = (ContinuationPageBase<Extract<ContinuationCursor, {
+    readonly kind: "source-locators";
+}>> & {
+    readonly kind: "source-locators";
+    readonly result: ArchiveSourceLocatorResult;
+}) | (ContinuationPageBase<Extract<ContinuationCursor, {
+    readonly kind: "collection";
+}>> & {
+    readonly kind: "collection";
+    readonly result: ArchiveCollectionResult;
+}) | (ContinuationPageBase<Extract<ContinuationCursor, {
+    readonly kind: "search";
+}>> & {
+    readonly kind: "search";
+    readonly result: ArchiveFindResult;
+}) | (ContinuationPageBase<Extract<ContinuationCursor, {
+    readonly kind: "evidence";
+}>> & {
+    readonly kind: "evidence";
+    readonly result: ArchiveEvidence;
+}) | (ContinuationPageBase<Extract<ContinuationCursor, {
+    readonly kind: "related";
+}>> & {
+    readonly kind: "related";
+    readonly result: ArchiveRelatedResult;
+});
+declare class WikiGraphContinuationManager {
+    #private;
+    constructor(runtime: WikiGraphJobRuntime);
+    next(options: WikiGraphContinuationOptions): Promise<WikiGraphContinuationPage>;
+    create(context: WikiGraphContinuationContext, cursor: string | null | undefined): Promise<string | null>;
+}
+
+type WikiGraphLibraryTarget = ParsedWikiGraphLibraryUri | string;
+type WikiGraphLibrarySearchOptions = Omit<ArchiveFindOptions, "embeddingProvider">;
+type WikiGraphLibraryPageOptions = Omit<Parameters<typeof readWikiGraphLibraryPage>[2], "wikimediaResolver">;
+interface WikiGraphLibraryAddArchiveOptions {
+    readonly inputPath: string;
+    readonly target: WikiGraphLibraryTarget;
+    readonly to?: string;
+}
+interface WikiGraphLibraryMoveArchiveOptions {
+    readonly target: WikiGraphLibraryTarget;
+    readonly to: string;
+}
+declare class WikiGraphLibraryManager {
+    #private;
+    constructor(runtime: WikiGraphJobRuntime);
+    create(folder: string): Promise<WikiGraphLibrary>;
+    get(uri?: string): Promise<WikiGraphLibrary>;
+    addArchive(options: WikiGraphLibraryAddArchiveOptions): Promise<WikiGraphLibraryArchiveRecord>;
+    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>;
+    indexState(target: WikiGraphLibraryTarget): Promise<WikiGraphLibraryIndexState>;
+    rebuildIndex(target: WikiGraphLibraryTarget, onProgress?: Parameters<typeof rebuildWikiGraphLibraryIndex>[1]): Promise<WikiGraphLibraryIndexState>;
+    cleanIndex(target: WikiGraphLibraryTarget): Promise<WikiGraphLibraryIndexState>;
+    getMetadata(target: WikiGraphLibraryTarget): Promise<Readonly<Record<string, unknown>>>;
+    replaceMetadata(target: WikiGraphLibraryTarget, value: Readonly<Record<string, unknown>>): Promise<Readonly<Record<string, unknown>>>;
+    putMetadata(target: WikiGraphLibraryTarget, key: string, value: unknown): Promise<Readonly<Record<string, unknown>>>;
+    deleteMetadata(target: WikiGraphLibraryTarget, key: string): Promise<Readonly<Record<string, unknown>>>;
+    clearMetadata(target: WikiGraphLibraryTarget): Promise<Readonly<Record<string, unknown>>>;
+    search(target: WikiGraphLibraryTarget, query: string, options?: WikiGraphLibrarySearchOptions): Promise<ArchiveFindResult>;
+    searchArchiveMembers(target: WikiGraphLibraryTarget, query: string, options?: WikiGraphLibrarySearchOptions): Promise<ArchiveFindResult>;
+    objects(target: WikiGraphLibraryTarget, options?: ArchiveCollectionOptions): Promise<ArchiveCollectionResult>;
+    archiveMembers(target: WikiGraphLibraryTarget, options?: ArchiveCollectionOptions): Promise<ArchiveCollectionResult>;
+    page(target: WikiGraphLibraryTarget, objectUri: string, options?: WikiGraphLibraryPageOptions): Promise<ArchivePage>;
+    related(target: WikiGraphLibraryTarget, objectUri: string, options?: Parameters<typeof listRelatedWikiGraphLibraryObjects>[2]): Promise<ArchiveRelatedResult>;
+    evidence(target: WikiGraphLibraryTarget, objectUri: string, options?: Parameters<typeof listWikiGraphLibraryEvidence>[2]): Promise<ArchiveEvidence>;
+    pack(target: WikiGraphLibraryTarget, objectUri: string, budget?: number): Promise<ArchivePack>;
+    list(): Promise<readonly WikiGraphLibrary[]>;
+}
+declare class WikiGraphLibrary {
+    #private;
+    constructor(runtime: WikiGraphJobRuntime, record: WikiGraphLibraryRecord);
+    get snapshot(): WikiGraphLibraryRecord;
+    get uri(): string;
+    archives(): Promise<readonly WikiGraphLibraryArchiveRecord[]>;
+    scan(): Promise<WikiGraphLibraryScanResult>;
+    remove(): Promise<WikiGraphLibraryRecord>;
+}
+
+type WikiGraphSDKEnvPolicy = "development" | "production";
+interface WikiGraphSDKRuntimeContext {
+    readonly cwd: string;
+    readonly env: NodeJS.ProcessEnv;
+    readonly envPolicy: WikiGraphSDKEnvPolicy;
+    readonly stateDir?: string | undefined;
+}
+declare function withWikiGraphSDKRuntimeContext<T>(context: WikiGraphSDKRuntimeContext, operation: () => Promise<T> | T): Promise<T>;
+declare function getWikiGraphSDKRuntimeContext(): WikiGraphSDKRuntimeContext;
+declare function getWikiGraphSDKStateDir(): string | undefined;
+
+interface WikiGraphSDKOptions {
+    readonly cwd?: string;
+    readonly env?: NodeJS.ProcessEnv;
+    readonly envPolicy?: WikiGraphSDKEnvPolicy;
+    readonly stateDir?: string;
+}
+declare class WikiGraphSDK implements WikiGraphJobRuntime {
+    #private;
+    readonly archives: WikiGraphArchiveManager;
+    readonly conversions: WikiGraphConversionManager;
+    readonly config: WikiGraphConfigManager;
+    readonly continuations: WikiGraphContinuationManager;
+    readonly jobs: WikiGraphJobManager;
+    readonly libraries: WikiGraphLibraryManager;
+    readonly maintenance: WikiGraphMaintenanceManager;
+    constructor(options?: WikiGraphSDKOptions);
+    run<T>(operation: () => Promise<T> | T, signal?: AbortSignal, options?: {
+        readonly skipHomeBootstrap?: boolean;
+    }): Promise<T>;
+    close(): void;
+}
+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 };