wiki-graph-core 0.3.1 → 0.4.0

package/dist/index-B8NNnQ8P.d.ts

@@ -1,424 +0,0 @@
-import { Database } from './document/database.js';
-import { Document, ReadonlyDocument } from './document/document.js';
-import { MentionLinkRecord, MentionRecord, ReadingEdgeRecord } from './document/types.js';
-import { BookMeta } from './source/meta.js';
-import { WikipageResolverOptions } from './wikipage/types.js';
-import { GraphNeighbor } from './facade/graph.js';
-import { ChapterEntry, ChapterTree } from './facade/chapter.js';
-
-declare const TEXT_SENTENCE_KIND: {
-    readonly source: 1;
-    readonly summary: 2;
-};
-type TextSentenceKind = (typeof TEXT_SENTENCE_KIND)[keyof typeof TEXT_SENTENCE_KIND];
-declare const SEARCH_OBJECT_PROPERTY_OWNER_KIND: {
-    readonly chapter: 1;
-    readonly chunk: 2;
-    readonly entity: 3;
-};
-type SearchObjectPropertyOwnerKind = (typeof SEARCH_OBJECT_PROPERTY_OWNER_KIND)[keyof typeof SEARCH_OBJECT_PROPERTY_OWNER_KIND];
-declare const SEARCH_OBJECT_PROPERTY_KIND: {
-    readonly title: 1;
-    readonly label: 1;
-    readonly content: 2;
-    readonly surface: 1;
-};
-type SearchObjectPropertyKind = (typeof SEARCH_OBJECT_PROPERTY_KIND)[keyof typeof SEARCH_OBJECT_PROPERTY_KIND];
-interface TextSentenceRecordInput {
-    readonly chapterId: number;
-    readonly kind: TextSentenceKind;
-    readonly sentenceIndex: number;
-    readonly text: string;
-    readonly wordsCount: number;
-}
-interface SearchObjectPropertyRecordInput {
-    readonly chapterId?: number;
-    readonly ownerId: string;
-    readonly ownerKind: SearchObjectPropertyOwnerKind;
-    readonly propertyKind: SearchObjectPropertyKind;
-    readonly text: string;
-}
-interface SearchIndexInput {
-    readonly objectProperties: readonly SearchObjectPropertyRecordInput[];
-    readonly textSentences: readonly TextSentenceRecordInput[];
-}
-type SearchIndexProgressPhase = "checking" | "clearing" | "collecting" | "finalizing" | "indexing-objects" | "indexing-text";
-interface SearchIndexProgressEvent {
-    readonly done?: number;
-    readonly phase: SearchIndexProgressPhase;
-    readonly total?: number;
-    readonly unit?: "chapter" | "object" | "sentence";
-}
-type SearchIndexProgressReporter = (event: SearchIndexProgressEvent) => void | Promise<void>;
-type SearchIndexStatus = "current" | "dirty" | "missing";
-interface SearchIndexTextHit {
-    readonly chapterId: number;
-    readonly kind: TextSentenceKind;
-    readonly rank: number;
-    readonly score: number;
-    readonly sentenceIndex: number;
-    readonly wordsCount: number;
-}
-interface SearchIndexObjectHit {
-    readonly chapterId?: number;
-    readonly ownerId: string;
-    readonly ownerKind: SearchObjectPropertyOwnerKind;
-    readonly propertyKind: SearchObjectPropertyKind;
-    readonly score: number;
-}
-interface SearchIndexQueryResult {
-    readonly objectHits: readonly SearchIndexObjectHit[];
-    readonly terms: readonly string[];
-    readonly textHits: readonly SearchIndexTextHit[];
-}
-declare const SEARCH_INDEX_FTS_HIT_LIMIT = 32000;
-interface ArchiveIndexSettings {
-    readonly ftsEmbedded: boolean;
-}
-declare function readArchiveIndexSettings(document: ReadonlyDocument): Promise<ArchiveIndexSettings>;
-declare function setFtsIndexEmbedded(document: Document, embedded: boolean): Promise<void>;
-declare function isSearchIndexCurrent(document: ReadonlyDocument, input?: SearchIndexInput): Promise<boolean>;
-declare function readSearchIndexStatus(document: ReadonlyDocument, input?: SearchIndexInput): Promise<SearchIndexStatus>;
-declare function ensureSearchIndex(document: Document, input: SearchIndexInput, progress?: SearchIndexProgressReporter): Promise<void>;
-declare function querySearchIndex(document: ReadonlyDocument, query: string, options?: {
-    readonly chapters?: readonly number[];
-    readonly match?: ArchiveFindMatch;
-    readonly objectHitLimit?: number;
-    readonly textAfter?: {
-        readonly chapterId: number;
-        readonly kind: TextSentenceKind;
-        readonly rank: number;
-        readonly sentenceIndex: number;
-    };
-    readonly textHitLimit?: number;
-    readonly types?: readonly ArchiveFindObjectType[] | null;
-}): Promise<SearchIndexQueryResult | undefined>;
-declare function createSearchIndexFingerprint(input: SearchIndexInput): string;
-declare function readSearchIndexFingerprintFromDatabase(database: Database): Promise<string | undefined>;
-
-type ArchiveObjectType = "chapter" | "chapter-title" | "chapter-tree" | "edge" | "entity" | "fragment" | "meta" | "node" | "source" | "state" | "summary" | "triple";
-type ChapterStateTarget = "knowledge-graph" | "reading-graph" | "reading-summary" | "source";
-type ChapterStateValue = "missing" | "ready";
-type ChapterState = Record<ChapterStateTarget, ChapterStateValue>;
-type ArchiveCollectionType = "chapter" | "chapter-title" | "entity" | "fragment" | "meta" | "node" | "source" | "summary" | "triple";
-type ArchiveFindObjectType = "chapter" | "chapter-title" | "chapter-tree" | "entity" | "fragment" | "meta" | "node" | "source" | "summary" | "triple";
-type ArchiveFindFilterType = "chapter" | "chapter-title" | "entity" | "fragment" | "meta" | "node" | "source" | "summary" | "triple";
-interface ArchiveIndex {
-    readonly chapters: readonly ChapterEntry[];
-    readonly edgeCount: number;
-    readonly meta: BookMeta | undefined;
-    readonly nodeCount: number;
-    readonly summaryCount: number;
-}
-interface ArchiveFindHit {
-    readonly backlinks?: ArchiveBacklinks;
-    readonly chapter?: number;
-    readonly evidence?: ArchiveFindEvidencePreview;
-    readonly evidenceLinks?: readonly MentionLinkRecord[];
-    readonly evidenceMentions?: readonly EntityEvidenceMention[];
-    readonly field: ArchiveFindField;
-    readonly id: string;
-    readonly matchCount?: number;
-    readonly matchedTerms?: readonly string[];
-    readonly missingTerms?: readonly string[];
-    readonly position?: ArchiveFindPosition;
-    readonly score?: number;
-    readonly snippet: string;
-    readonly state?: ChapterState;
-    readonly title: string;
-    readonly triple?: {
-        readonly objectLabel: string;
-        readonly predicate: string;
-        readonly subjectLabel: string;
-    };
-    readonly type: ArchiveFindObjectType;
-}
-interface EntityEvidenceMention {
-    readonly match: Pick<ArchiveFindHit, "matchCount" | "matchedTerms" | "missingTerms" | "score">;
-    readonly mention: MentionRecord;
-}
-interface ArchiveFindEvidencePreview {
-    readonly nextCursor: string | null;
-    readonly shown: number;
-    readonly sources: readonly ArchiveEvidenceItem[];
-    readonly total: number;
-}
-type ArchiveFindField = "content" | "metadata" | "source" | "summary" | "title";
-interface ArchiveFindOptions {
-    readonly archiveKey?: string;
-    readonly backlinks?: boolean;
-    readonly chapters?: readonly number[];
-    readonly cursor?: string;
-    readonly evidenceLimit?: number;
-    readonly ids?: readonly string[];
-    readonly limit?: number;
-    readonly match?: ArchiveFindMatch;
-    readonly order?: ArchiveFindOrder;
-    readonly sourceContext?: number;
-    readonly triplePattern?: ArchiveTriplePattern;
-    readonly types?: readonly ArchiveFindFilterType[];
-}
-type ArchiveFindOrder = "doc-asc" | "doc-desc";
-type ArchiveFindMatch = "all" | "any";
-interface ArchiveFindPosition {
-    readonly chapter: number;
-    readonly documentOrder?: number;
-    readonly fragment?: number;
-    readonly sentence?: number;
-}
-interface ArchiveFindResult {
-    readonly chapters: readonly number[] | null;
-    readonly items: readonly ArchiveFindHit[];
-    readonly lens: ArchiveFindLens;
-    readonly lensHint: ArchiveFindLensHint | null;
-    readonly limit: number;
-    readonly match: ArchiveFindMatch;
-    readonly nextCursor: string | null;
-    readonly order: ArchiveFindOrder;
-    readonly query: string;
-    readonly terms: readonly string[];
-    readonly types: readonly ArchiveFindFilterType[] | null;
-}
-type ArchiveFindLens = "broad" | "exact" | "typed";
-interface ArchiveFindLensHint {
-    readonly lenses: {
-        readonly chapter: string;
-        readonly chunk: string;
-        readonly entity: string;
-        readonly node: string;
-        readonly triple: string;
-    };
-    readonly message: string;
-}
-interface ArchiveCollectionOptions {
-    readonly backlinks?: boolean;
-    readonly chapters?: readonly number[];
-    readonly cursor?: string;
-    readonly evidenceLimit?: number;
-    readonly ids?: readonly string[];
-    readonly limit?: number;
-    readonly order?: ArchiveFindOrder;
-    readonly sourceContext?: number;
-    readonly triplePattern?: ArchiveTriplePattern;
-    readonly types?: readonly ArchiveCollectionType[];
-}
-interface ArchiveTriplePattern {
-    readonly objectQid?: string;
-    readonly predicate?: string;
-    readonly subjectQid?: string;
-}
-interface ArchiveCollectionResult {
-    readonly chapters: readonly number[] | null;
-    readonly ids: readonly string[] | null;
-    readonly items: readonly ArchiveFindHit[];
-    readonly limit: number;
-    readonly nextCursor: string | null;
-    readonly order: ArchiveFindOrder;
-    readonly types: readonly ArchiveCollectionType[] | null;
-}
-interface ArchiveBacklinks {
-    readonly chunks: ArchiveBacklinkBucket;
-    readonly entities: ArchiveBacklinkBucket;
-    readonly triples: ArchiveBacklinkBucket;
-}
-interface ArchiveBacklinkBucket {
-    readonly items: readonly ArchiveFindHit[];
-    readonly limit: number;
-    readonly nextCursor: string | null;
-}
-type ArchiveListKind = "chapters" | "edges" | "fragments" | "meta" | "nodes" | "summaries";
-type ArchiveListItem = {
-    readonly evidence?: ArchiveFindEvidencePreview;
-    readonly id: string;
-    readonly label: string;
-    readonly score?: number;
-    readonly state?: ChapterState;
-    readonly summary: string;
-    readonly type: Exclude<ArchiveObjectType, "triple">;
-} | {
-    readonly evidence?: ArchiveFindEvidencePreview;
-    readonly id: string;
-    readonly label: string;
-    readonly evidenceLinks?: readonly MentionLinkRecord[];
-    readonly objectLabel: string;
-    readonly objectQid: string;
-    readonly predicate: string;
-    readonly score?: number;
-    readonly subjectLabel: string;
-    readonly subjectQid: string;
-    readonly summary: string;
-    readonly type: "triple";
-};
-type ArchivePage = {
-    readonly id: string;
-    readonly state: ChapterState;
-    readonly title: string;
-    readonly type: "chapter";
-} | {
-    readonly id: string;
-    readonly title: string;
-    readonly type: "chapter-title";
-} | {
-    readonly id: string;
-    readonly title: string;
-    readonly tree: ChapterTree;
-    readonly type: "chapter-tree";
-} | {
-    readonly generatedNodeSummary: string;
-    readonly id: string;
-    readonly incoming: readonly GraphNeighbor[];
-    readonly neighbors: readonly GraphNeighbor[];
-    readonly outgoing: readonly GraphNeighbor[];
-    readonly position: ArchiveFindPosition | undefined;
-    readonly sourceFragments: readonly ArchiveNodeSourceFragment[];
-    readonly title: string;
-    readonly type: "node";
-} | {
-    readonly backlinks?: ArchiveBacklinks;
-    readonly fragment: ArchiveSourceFragment;
-    readonly id: string;
-    readonly nextFragmentId: string | undefined;
-    readonly nodes: readonly ArchiveNodeLabel[];
-    readonly previousFragmentId: string | undefined;
-    readonly title: string;
-    readonly type: "fragment";
-} | {
-    readonly content: string;
-    readonly id: string;
-    readonly title: string;
-    readonly type: "summary";
-} | {
-    readonly evidence: ArchiveFindEvidencePreview;
-    readonly id: string;
-    readonly label: string;
-    readonly labels: readonly string[];
-    readonly mentionCount: number;
-    readonly qid: string;
-    readonly type: "entity";
-} | {
-    readonly en: ArchiveEntityWikipageLocale | null;
-    readonly id: string;
-    readonly type: "entity-wikipage";
-    readonly zh: ArchiveEntityWikipageLocale | null;
-} | {
-    readonly evidence: ArchiveFindEvidencePreview;
-    readonly id: string;
-    readonly label: string;
-    readonly objectQid: string;
-    readonly predicate: string;
-    readonly subjectQid: string;
-    readonly type: "triple";
-} | {
-    readonly authors?: readonly string[];
-    readonly description?: string;
-    readonly id: string;
-    readonly publisher?: string;
-    readonly title: string;
-    readonly type: "meta";
-} | {
-    readonly id: string;
-    readonly state: ChapterState;
-    readonly type: "state";
-} | {
-    readonly id: string;
-    readonly target: ChapterStateTarget;
-    readonly type: "state";
-    readonly value: ChapterStateValue;
-};
-interface ArchiveEntityWikipageLocale {
-    readonly description?: string;
-    readonly title: string;
-    readonly url: string;
-}
-interface ArchivePack {
-    readonly anchor: ArchivePage;
-    readonly budget: number;
-    readonly related: readonly ArchiveListItem[];
-}
-type ArchiveRelatedRole = "any" | "object" | "self" | "subject";
-interface ArchiveRelatedOptions {
-    readonly cursor?: string;
-    readonly evidenceLimit?: number;
-    readonly limit?: number;
-    readonly order?: ArchiveFindOrder;
-    readonly query?: string;
-    readonly role?: ArchiveRelatedRole;
-    readonly sourceContext?: number;
-}
-interface ArchiveRelatedResult {
-    readonly items: readonly ArchiveListItem[];
-    readonly limit: number;
-    readonly nextCursor: string | null;
-}
-interface ArchiveEvidence {
-    readonly items: readonly ArchiveEvidenceItem[];
-    readonly limit: number;
-    readonly nextCursor: string | null;
-}
-interface ArchiveEvidenceItem {
-    readonly chapterId: number;
-    readonly endSentenceIndex: number;
-    readonly fragmentId?: number;
-    readonly id: string;
-    readonly score?: number;
-    readonly source: string;
-    readonly startSentenceIndex: number;
-    readonly title: string;
-    readonly type: "source";
-}
-interface ArchiveNodeLabel {
-    readonly id: string;
-    readonly title: string;
-}
-interface ArchiveSourceFragment {
-    readonly fragmentId?: number;
-    readonly id: string;
-    readonly preview: string;
-    readonly sentenceCount: number;
-    readonly text: string;
-    readonly wordsCount: number;
-}
-interface ArchiveNodeSourceFragment {
-    readonly id: string;
-    readonly text: string;
-    readonly truncated: boolean;
-}
-interface ArchiveEvidenceOptions {
-    readonly cursor?: string;
-    readonly limit?: number;
-    readonly order?: ArchiveFindOrder;
-    readonly query?: string;
-    readonly sourceContext?: number;
-}
-interface ArchivePageOptions {
-    readonly backlinks?: boolean;
-    readonly evidenceLimit?: number;
-    readonly order?: ArchiveFindOrder;
-    readonly sourceContext?: number;
-    readonly wikipageResolverOptions?: WikipageResolverOptions;
-}
-declare function getArchiveIndex(document: ReadonlyDocument): Promise<ArchiveIndex>;
-declare function listArchiveObjects(document: ReadonlyDocument, kind: ArchiveListKind): Promise<readonly ArchiveListItem[]>;
-declare function listArchiveCollection(document: ReadonlyDocument, options?: ArchiveCollectionOptions): Promise<ArchiveCollectionResult>;
-declare function findArchiveObjects(document: ReadonlyDocument, query: string, options?: ArchiveFindOptions): Promise<ArchiveFindResult>;
-declare function rebuildArchiveSearchIndex(document: Document, progress?: SearchIndexProgressReporter): Promise<void>;
-declare function isArchiveSearchIndexCurrent(document: ReadonlyDocument): Promise<boolean>;
-declare function readArchiveSearchIndexStatus(document: ReadonlyDocument): Promise<"current" | "dirty" | "missing">;
-declare function clearDirtyArchiveSearchIndex(document: Document): Promise<void>;
-declare function createArchiveSearchIndexFingerprint(document: ReadonlyDocument): Promise<string>;
-declare function grepArchiveObjects(document: ReadonlyDocument, query: string, options?: ArchiveFindOptions): Promise<ArchiveFindResult>;
-declare function readArchiveText(document: ReadonlyDocument, id: string): Promise<string>;
-declare function readArchivePage(document: ReadonlyDocument, id: string, options?: ArchivePageOptions): Promise<ArchivePage>;
-declare function listArchiveLinks(document: ReadonlyDocument, id: string, direction: "backlinks" | "links"): Promise<readonly GraphNeighbor[]>;
-declare function listAllArchiveLinks(document: ReadonlyDocument, id: string): Promise<readonly GraphNeighbor[]>;
-declare function listRelatedArchiveObjects(document: ReadonlyDocument, id: string, options?: ArchiveRelatedOptions): Promise<ArchiveRelatedResult>;
-declare function listArchiveEvidence(document: ReadonlyDocument, uri: string, options?: ArchiveEvidenceOptions): Promise<ArchiveEvidence>;
-declare function packArchiveContext(document: ReadonlyDocument, id: string, budget: number): Promise<ArchivePack>;
-declare function formatChapterId(chapterId: number): string;
-declare function formatChapterTitleId(chapterId: number): string;
-declare function formatEdgeId(edge: ReadingEdgeRecord): string;
-declare function formatNodeId(nodeId: number): string;
-declare function formatSummaryId(chapterId: number): string;
-declare function formatFragmentId(serialId: number, fragmentId: number): string;
-
-export { isArchiveSearchIndexCurrent as $, type ArchiveBacklinkBucket as A, SEARCH_OBJECT_PROPERTY_KIND as B, SEARCH_OBJECT_PROPERTY_OWNER_KIND as C, type SearchIndexInput as D, type SearchIndexObjectHit as E, type SearchIndexProgressEvent as F, type SearchIndexProgressPhase as G, type SearchIndexProgressReporter as H, type SearchIndexQueryResult as I, type SearchIndexStatus as J, type SearchIndexTextHit as K, type SearchObjectPropertyKind as L, type SearchObjectPropertyOwnerKind as M, type TextSentenceKind as N, clearDirtyArchiveSearchIndex as O, createArchiveSearchIndexFingerprint as P, createSearchIndexFingerprint as Q, ensureSearchIndex as R, SEARCH_INDEX_FTS_HIT_LIMIT as S, TEXT_SENTENCE_KIND as T, findArchiveObjects as U, formatChapterId as V, formatEdgeId as W, formatNodeId as X, formatSummaryId as Y, getArchiveIndex as Z, grepArchiveObjects as _, type ArchiveBacklinks as a, isSearchIndexCurrent as a0, listAllArchiveLinks as a1, listArchiveCollection as a2, listArchiveEvidence as a3, listArchiveLinks as a4, listArchiveObjects as a5, listRelatedArchiveObjects as a6, packArchiveContext as a7, querySearchIndex as a8, readArchiveIndexSettings as a9, readArchivePage as aa, readArchiveSearchIndexStatus as ab, readArchiveText as ac, readSearchIndexFingerprintFromDatabase as ad, readSearchIndexStatus as ae, rebuildArchiveSearchIndex as af, setFtsIndexEmbedded as ag, type SearchObjectPropertyRecordInput as ah, type TextSentenceRecordInput as ai, type ArchiveEntityWikipageLocale as aj, type ArchiveEvidenceOptions as ak, type ArchiveFindLens as al, type ArchiveFindLensHint as am, type ArchiveFindMatch as an, type ArchivePageOptions as ao, type ArchiveRelatedOptions as ap, type ArchiveRelatedRole as aq, type ArchiveSourceFragment as ar, formatChapterTitleId as as, formatFragmentId as at, type ArchiveCollectionOptions as b, type ArchiveCollectionResult as c, type ArchiveCollectionType as d, type ArchiveEvidence as e, type ArchiveEvidenceItem as f, type ArchiveFindEvidencePreview as g, type ArchiveFindField as h, type ArchiveFindFilterType as i, type ArchiveFindHit as j, type ArchiveFindObjectType as k, type ArchiveFindOptions as l, type ArchiveFindOrder as m, type ArchiveFindPosition as n, type ArchiveFindResult as o, type ArchiveIndex as p, type ArchiveIndexSettings as q, type ArchiveListItem as r, type ArchiveListKind as s, type ArchiveNodeLabel as t, type ArchiveNodeSourceFragment as u, type ArchiveObjectType as v, type ArchivePack as w, type ArchivePage as x, type ArchiveRelatedResult as y, type ArchiveTriplePattern as z };