wiki-graph-core 0.3.1

package/dist/document/document.d.ts

@@ -0,0 +1,153 @@
+import { BookMeta } from '../source/meta.js';
+import { TocFile } from '../source/toc.js';
+import { SourceAsset } from '../source/types.js';
+import { Database } from './database.js';
+import { ReadonlySerialTextStream, SerialTextStream, TextStreams } from './text-streams.js';
+import { ReadonlyChunkStore, ReadonlyFragmentGroupStore, ReadonlyGraphBuildParameterStore, ReadonlyReadingEdgeStore, ReadonlyMentionLinkStore, ReadonlyMentionStore, ReadonlyObjectMetadataStore, ReadonlySerialStore, ReadonlySnakeChunkStore, ReadonlySnakeEdgeStore, ReadonlySnakeStore, ChunkStore, FragmentGroupStore, GraphBuildParameterStore, ReadingEdgeStore, MentionLinkStore, MentionStore, ObjectMetadataStore, SerialStore, SnakeChunkStore, SnakeEdgeStore, SnakeStore } from './stores.js';
+import { SentenceId } from './types.js';
+import 'zod';
+import 'sqlite3';
+
+interface DocumentFileStore {
+    close(): Promise<void>;
+    deleteFile(path: string): Promise<void>;
+    deleteTree(path: string): Promise<void>;
+    ensureDirectory(path: string): Promise<void>;
+    initializeDatabaseSchema(): boolean;
+    markDatabaseDirty?(): void;
+    markSearchIndexDatabaseDirty?(): void;
+    openDatabaseReadonly(): boolean;
+    listFileContents?(path: string): Promise<ReadonlyMap<string, Uint8Array>>;
+    listFiles(path: string): Promise<readonly string[]>;
+    readFile(path: string): Promise<Uint8Array | undefined>;
+    resolveDatabasePath(documentPath: string): Promise<string>;
+    resolveSearchIndexDatabasePath?(documentPath: string): Promise<string>;
+    writeFile(path: string, content: string | Uint8Array, options: {
+        readonly overwrite?: boolean;
+    }): Promise<void>;
+}
+interface ReadonlyDocument {
+    readonly chunks: ReadonlyChunkStore;
+    readonly fragmentGroups: ReadonlyFragmentGroupStore;
+    readonly graphBuildParameters: ReadonlyGraphBuildParameterStore;
+    readonly readingEdges: ReadonlyReadingEdgeStore;
+    readonly mentionLinks: ReadonlyMentionLinkStore;
+    readonly mentions: ReadonlyMentionStore;
+    readonly metadata: ReadonlyObjectMetadataStore;
+    readonly serials: ReadonlySerialStore;
+    readonly snakeChunks: ReadonlySnakeChunkStore;
+    readonly snakeEdges: ReadonlySnakeEdgeStore;
+    readonly snakes: ReadonlySnakeStore;
+    getSentence(sentenceId: SentenceId): Promise<string>;
+    getSerialFragments(serialId: number): ReadonlySerialTextStream;
+    getSummaryFragments(serialId: number): ReadonlySerialTextStream;
+    openSession<T>(operation: (document: ReadonlyDocument) => Promise<T> | T): Promise<T>;
+    readDatabase<T>(operation: (database: Database) => Promise<T> | T): Promise<T>;
+    readSearchIndexDatabase<T>(operation: (database: Database) => Promise<T> | T): Promise<T>;
+    readBookMeta(): Promise<BookMeta | undefined>;
+    readCover(): Promise<SourceAsset | undefined>;
+    readSummary(serialId: number): Promise<string | undefined>;
+    readToc(): Promise<TocFile | undefined>;
+    release(): Promise<void>;
+}
+interface DocumentContext {
+    complete(): void;
+    dispose(): Promise<void>;
+    ownSerial(serialId: number): void;
+    run<T>(operation: () => Promise<T> | T): Promise<T>;
+}
+interface Document extends ReadonlyDocument {
+    readonly chunks: ChunkStore;
+    readonly fragmentGroups: FragmentGroupStore;
+    readonly graphBuildParameters: GraphBuildParameterStore;
+    readonly readingEdges: ReadingEdgeStore;
+    readonly mentionLinks: MentionLinkStore;
+    readonly mentions: MentionStore;
+    readonly metadata: ObjectMetadataStore;
+    readonly serials: SerialStore;
+    readonly snakeChunks: SnakeChunkStore;
+    readonly snakeEdges: SnakeEdgeStore;
+    readonly snakes: SnakeStore;
+    createContext(): DocumentContext;
+    getSerialFragments(serialId: number): SerialTextStream;
+    getSummaryFragments(serialId: number): SerialTextStream;
+    createSerial(): Promise<number>;
+    clearSerialGraph(serialId: number): Promise<void>;
+    clearSerialSource(serialId: number): Promise<void>;
+    deleteSerial(serialId: number): Promise<void>;
+    deleteSearchIndexDatabase(): Promise<void>;
+    deleteSummary(serialId: number): Promise<void>;
+    flush(): Promise<void>;
+    openSession<T>(operation: (document: Document) => Promise<T> | T): Promise<T>;
+    peekNextSerialId(): Promise<number>;
+    replaceBookMeta(meta: BookMeta): Promise<void>;
+    replaceToc(toc: TocFile): Promise<void>;
+    writeBookMeta(meta: BookMeta): Promise<void>;
+    writeCover(cover: SourceAsset): Promise<void>;
+    writeSummary(serialId: number, summary: string): Promise<void>;
+    writeToc(toc: TocFile): Promise<void>;
+    writeSearchIndexDatabase<T>(operation: (database: Database) => Promise<T> | T): Promise<T>;
+}
+declare class DirectoryDocument implements Document {
+    #private;
+    readonly chunks: ChunkStore;
+    readonly fragmentGroups: FragmentGroupStore;
+    readonly graphBuildParameters: GraphBuildParameterStore;
+    readonly readingEdges: ReadingEdgeStore;
+    readonly mentionLinks: MentionLinkStore;
+    readonly mentions: MentionStore;
+    readonly metadata: ObjectMetadataStore;
+    readonly path: string;
+    readonly serials: SerialStore;
+    readonly snakeChunks: SnakeChunkStore;
+    readonly snakeEdges: SnakeEdgeStore;
+    readonly snakes: SnakeStore;
+    constructor(database: Database, textStreams: TextStreams, path: string, fileStore?: DocumentFileStore);
+    static open(documentPath: string, options?: {
+        readonly fileStore?: DocumentFileStore;
+    }): Promise<DirectoryDocument>;
+    static openSession<T>(documentPath: string, operation: (document: DirectoryDocument) => Promise<T> | T): Promise<T>;
+    getSerialFragments(serialId: number): SerialTextStream;
+    getSummaryFragments(serialId: number): SerialTextStream;
+    createContext(): DocumentContext;
+    createSerial(): Promise<number>;
+    clearSerialGraph(serialId: number): Promise<void>;
+    clearSerialSource(serialId: number): Promise<void>;
+    deleteSerial(serialId: number): Promise<void>;
+    deleteSummary(serialId: number): Promise<void>;
+    getSentence(sentenceId: SentenceId): Promise<string>;
+    openSession<T>(operation: (document: Document) => Promise<T> | T): Promise<T>;
+    readDatabase<T>(operation: (database: Database) => Promise<T> | T): Promise<T>;
+    readSearchIndexDatabase<T>(operation: (database: Database) => Promise<T> | T): Promise<T>;
+    writeSearchIndexDatabase<T>(operation: (database: Database) => Promise<T> | T): Promise<T>;
+    deleteSearchIndexDatabase(): Promise<void>;
+    peekNextSerialId(): Promise<number>;
+    readBookMeta(): Promise<BookMeta | undefined>;
+    readCover(): Promise<SourceAsset | undefined>;
+    readSummary(serialId: number): Promise<string | undefined>;
+    readToc(): Promise<TocFile | undefined>;
+    writeBookMeta(meta: BookMeta): Promise<void>;
+    replaceBookMeta(meta: BookMeta): Promise<void>;
+    writeCover(cover: SourceAsset): Promise<void>;
+    writeSummary(serialId: number, summary: string): Promise<void>;
+    writeToc(toc: TocFile): Promise<void>;
+    replaceToc(toc: TocFile): Promise<void>;
+    flush(): Promise<void>;
+    release(): Promise<void>;
+    close(): Promise<void>;
+    runWithContext<T>(context: DirectoryDocumentContext, operation: () => Promise<T> | T): Promise<T>;
+    rollbackContext(context: DirectoryDocumentContext): Promise<void>;
+}
+declare class DirectoryDocumentContext implements DocumentContext {
+    #private;
+    constructor(document: DirectoryDocument);
+    complete(): void;
+    dispose(): Promise<void>;
+    ownSerial(serialId: number): void;
+    run<T>(operation: () => Promise<T> | T): Promise<T>;
+    listCreatedFilePaths(): readonly string[];
+    listOwnedSerialIds(): readonly number[];
+    registerCreatedFile(path: string): void;
+}
+
+export { DirectoryDocument, type Document, type DocumentContext, type DocumentFileStore, type ReadonlyDocument };