@threadbase-sh/scanner 0.7.2

package/dist/index.d.ts

@@ -0,0 +1,269 @@
+import { LoggerOptions, Logger } from 'pino';
+export { Logger, LoggerOptions } from 'pino';
+
+type MessageSender = "user" | "assistant";
+type Include = "all" | "conversations" | "subagents" | "teammates";
+type View = "flat" | "tree" | "grouped";
+type SortOrder = "recent" | "oldest" | "messages-desc" | "messages-asc" | "alpha";
+declare const VALID_SORT_ORDERS: SortOrder[];
+interface Profile {
+    id: string;
+    label: string;
+    configDir: string;
+    enabled: boolean;
+    emoji?: string;
+    scanHistory?: boolean;
+}
+interface ContentTier {
+    name: string;
+    previewMax: number;
+    snippetMax: number;
+}
+interface MessageSnapshot {
+    text: string;
+    timestamp: string;
+}
+interface ConversationMeta {
+    id: string;
+    filePath: string;
+    sessionId: string;
+    sessionName: string;
+    projectPath: string;
+    projectName: string;
+    account: string;
+    timestamp: string;
+    messageCount: number;
+    lastMessageSender: MessageSender;
+    preview: string;
+    contentSnippet: string;
+    gitBranch: string | null;
+    model: string | null;
+    isSubagent: boolean;
+    parentSessionId: string | null;
+    isTeammate: boolean;
+    teamName: string | null;
+    toolNames: string[];
+    firstMessage: MessageSnapshot | null;
+    lastMessage: MessageSnapshot | null;
+    lastPrompt?: string;
+}
+interface TreeConversation extends ConversationMeta {
+    subagents: ConversationMeta[];
+}
+interface GroupedConversations {
+    [groupKey: string]: ConversationMeta[];
+}
+interface FileStatEntry {
+    mtimeMs: number;
+    size: number;
+}
+interface ScanOptions {
+    profiles?: Profile[];
+    tier?: string;
+    tiers?: Record<string, ContentTier>;
+    include?: Include;
+    view?: View;
+    sort?: SortOrder;
+    since?: string;
+    project?: string;
+    account?: string;
+    limit?: number;
+    offset?: number;
+    onProgress?: (scanned: number, total: number) => void;
+    onBatch?: (metas: ConversationMeta[]) => void;
+    /** Known file stats from a previous scan. Files whose (mtimeMs, size) match
+     *  are skipped — the cached ConversationMeta is reused instead. */
+    statCache?: Map<string, {
+        stat: FileStatEntry;
+        meta: ConversationMeta;
+    }>;
+}
+interface ScanResult {
+    conversations: ConversationMeta[] | TreeConversation[] | GroupedConversations;
+    total: number;
+    scanned: number;
+}
+interface SearchOptions extends ScanOptions {
+    fields?: string[];
+}
+interface SearchMatch {
+    field: string;
+    snippet: string;
+}
+interface SearchResult {
+    meta: ConversationMeta;
+    score: number;
+    matches: SearchMatch[];
+}
+interface GetConversationOptions {
+    profiles?: Profile[];
+}
+interface GetConversationPageOptions {
+    beforeIndex?: number;
+    limit: number;
+}
+interface ConversationPage {
+    messages: ConversationMessage[];
+    total: number;
+    fromIndex: number;
+}
+interface SingleFilePage extends ConversationPage {
+    conversation: Conversation;
+}
+interface TurnDuration {
+    durationMs: number;
+    messageCount: number;
+    uuid?: string;
+}
+interface DeferredToolsDeltaAttachment {
+    type: "deferred_tools_delta";
+    addedNames: string[];
+    addedLines: unknown[];
+    removedNames: string[];
+}
+type AttachmentSidecar = DeferredToolsDeltaAttachment | {
+    type: string;
+    [key: string]: unknown;
+};
+interface ToolUseBlock {
+    id: string;
+    name: string;
+    input: Record<string, unknown>;
+}
+interface ToolResultBlock {
+    toolUseId: string;
+    type: "edit" | "write" | "read" | "bash" | "grep" | "glob" | "taskAgent" | "taskCreate" | "taskUpdate" | "generic";
+    content: Record<string, unknown>;
+    isError?: boolean;
+}
+interface TeamInfo {
+    teammateId: string;
+    summary?: string;
+    color?: string;
+}
+interface MessageMetadata {
+    model?: string;
+    stopReason?: string | null;
+    inputTokens?: number;
+    outputTokens?: number;
+    cacheReadTokens?: number;
+    cacheCreationTokens?: number;
+    gitBranch?: string;
+    version?: string;
+    toolUses?: string[];
+    toolUseBlocks?: ToolUseBlock[];
+    toolResults?: ToolResultBlock[];
+    teamName?: string;
+    teamInfo?: TeamInfo;
+}
+interface ConversationMessage {
+    role: MessageSender;
+    text: string;
+    timestamp: string;
+    uuid?: string;
+    metadata?: MessageMetadata;
+    isToolResult?: boolean;
+    isThinking?: boolean;
+    thinkingContent?: string;
+    thinkingSignature?: string;
+    parentUuid?: string | null;
+    requestId?: string;
+    promptId?: string;
+    isSidechain?: boolean;
+    permissionMode?: string;
+    hasImages?: boolean;
+    attachment?: AttachmentSidecar;
+}
+interface Conversation {
+    id: string;
+    filePath: string;
+    projectPath: string;
+    projectName: string;
+    sessionId: string;
+    sessionName: string;
+    messages: ConversationMessage[];
+    fullText: string;
+    timestamp: string;
+    messageCount: number;
+    account: string;
+    turnDurations?: TurnDuration[];
+    lastPrompt?: string;
+}
+
+declare function applySort(metas: ConversationMeta[], order: SortOrder): ConversationMeta[];
+declare function applySinceFilter(metas: ConversationMeta[], since: string): ConversationMeta[];
+declare function applyIncludeFilter(metas: ConversationMeta[], include: Include): ConversationMeta[];
+declare function applyProjectFilter(metas: ConversationMeta[], project: string): ConversationMeta[];
+declare function applyAccountFilter(metas: ConversationMeta[], account: string): ConversationMeta[];
+declare function applyPagination<T>(items: T[], limit: number, offset: number): {
+    items: T[];
+    total: number;
+};
+
+declare function readGitBranch(projectPath: string): string | null;
+
+declare class SearchIndexer {
+    private index;
+    private documents;
+    constructor();
+    private createIndex;
+    addDocument(meta: ConversationMeta): void;
+    buildIndex(metas: ConversationMeta[]): void;
+    search(query: string, options?: {
+        fields?: string[];
+        limit?: number;
+    }): SearchResult[];
+    private getRecent;
+    private generateMatches;
+    getDocumentCount(): number;
+    updateDocument(meta: ConversationMeta): void;
+    removeDocument(id: string): void;
+    clear(): void;
+}
+
+declare function createLogger(options?: LoggerOptions | Logger): Logger;
+declare function setLogger(logger: Logger): void;
+declare function getLogger(): Logger;
+
+declare function resolveConfigDir(configDir: string): string;
+declare function getProjectsDir(profile: Profile): string;
+declare function detectDefaultProfile(): Promise<Profile>;
+declare function loadProfiles(configPath: string): Promise<Profile[]>;
+declare function saveProfiles(profiles: Profile[], configPath: string): Promise<void>;
+
+declare class ConversationScanner {
+    private metadataCache;
+    private conversationLRU;
+    private sessionIdIndex;
+    private projects;
+    private indexer;
+    private lastTier;
+    constructor(options?: {
+        metadataCacheSize?: number;
+        conversationCacheSize?: number;
+    });
+    scan(options?: ScanOptions): Promise<ScanResult>;
+    search(query: string, options?: SearchOptions): Promise<SearchResult[]>;
+    getConversation(id: string, _options?: GetConversationOptions): Promise<Conversation | null>;
+    getConversationPage(id: string, options: GetConversationPageOptions): Promise<ConversationPage | null>;
+    parseSingleFilePage(filePath: string, account: string | undefined, options: GetConversationPageOptions): Promise<SingleFilePage | null>;
+    refreshFile(filePath: string, account?: string): Promise<ConversationMeta | null>;
+    getMetadataCache(): Map<string, ConversationMeta>;
+    getProjects(): string[];
+    private resolveProfiles;
+    private transformView;
+    private toTree;
+    private toGrouped;
+}
+
+declare function cleanSystemTags(text: string): string;
+
+declare const DEFAULT_TIERS: Record<string, ContentTier>;
+declare function resolveTier(tierName: string, customTiers?: Record<string, ContentTier>): ContentTier;
+
+declare function resetDefaultScanner(): void;
+declare function scan(options?: ScanOptions, scanner?: ConversationScanner): Promise<ScanResult>;
+declare function search(query: string, options?: SearchOptions, scanner?: ConversationScanner): Promise<SearchResult[]>;
+declare function getConversation(id: string, options?: GetConversationOptions, scanner?: ConversationScanner): Promise<Conversation | null>;
+
+export { type AttachmentSidecar, type ContentTier, type Conversation, type ConversationMessage, type ConversationMeta, type ConversationPage, ConversationScanner, DEFAULT_TIERS, type DeferredToolsDeltaAttachment, type FileStatEntry, type GetConversationOptions, type GetConversationPageOptions, type GroupedConversations, type Include, type MessageMetadata, type MessageSender, type MessageSnapshot, type Profile, type ScanOptions, type ScanResult, SearchIndexer, type SearchMatch, type SearchOptions, type SearchResult, type SingleFilePage, type SortOrder, type TeamInfo, type ToolResultBlock, type ToolUseBlock, type TreeConversation, type TurnDuration, VALID_SORT_ORDERS, type View, applyAccountFilter, applyIncludeFilter, applyPagination, applyProjectFilter, applySinceFilter, applySort, cleanSystemTags, createLogger, detectDefaultProfile, getConversation, getLogger, getProjectsDir, loadProfiles, readGitBranch, resetDefaultScanner, resolveConfigDir, resolveTier, saveProfiles, scan, search, setLogger };