@ninjaxtools/slopdex 0.10.0 → 0.13.0

package/dist/index.d.ts

@@ -3,7 +3,7 @@ declare class CodeIndex {
     readonly rootDir: string;
     readonly indexPath: string;
     readonly provider: EmbeddingProvider;
-    readonly summaryProvider: SummaryProvider;
+    readonly descriptionProvider: DescriptionProvider;
     constructor(options: CodeIndexOptions);
     close(): void;
     status(): IndexStatus;
@@ -12,14 +12,15 @@ declare class CodeIndex {
     updateFiles(options: UpdateFilesOptions): Promise<UpdateStats>;
     updateFromWorkingTree(options?: UpdateFromWorkingTreeOptions): Promise<UpdateStats>;
     updateFromGit(options?: UpdateFromGitOptions): Promise<UpdateStats>;
-    useSummaries(options?: {
+    useDescriptions(options?: {
         signal?: AbortSignal;
-    }): Promise<SummaryStats>;
-    disableSummaries(): SummaryStats;
-    searchSummary(options: SimilaritySearchOptions): Promise<SimilarityResult[]>;
+    }): Promise<DescriptionStats>;
+    reindexFiles(options?: ReindexFilesOptions): Promise<ReindexFilesStats>;
+    disableDescriptions(): DescriptionStats;
+    searchDescription(options: SimilaritySearchOptions): Promise<SimilarityResult[]>;
     similaritySearch(options: SimilaritySearchOptions): Promise<SimilarityResult[]>;
     similarToFunction(functionId: number, options: {
-        includeSummaries?: boolean;
+        includeDescriptions?: boolean;
         limit: number;
         minSimilarity: number;
         maxSimilarity?: number;
@@ -27,9 +28,11 @@ declare class CodeIndex {
         minLines?: number;
         nameRegex?: string;
     }): SimilarityResult[];
-    vectorForFunction(functionId: number, kind?: "code" | "summary"): number[];
+    vectorForFunction(functionId: number, kind?: "code" | "description"): number[];
+    vectorForFile(filePath: string): number[];
     searchByVector(vector: readonly number[], options: {
-        summaryVector?: readonly number[];
+        descriptionVector?: readonly number[];
+        fileDescriptionVector?: readonly number[];
         limit: number;
         minSimilarity: number;
         maxSimilarity?: number;
@@ -84,8 +87,8 @@ interface IndexedFunction extends ParsedCallable {
     lastSeenCommit: string | null;
     sourceMode: SourceMode;
     embeddingId: number;
-    summary: string | null;
-    summaryEmbeddingId: number | null;
+    description: string | null;
+    descriptionEmbeddingId: number | null;
 }
 interface EmbeddingProfile {
     provider: "openai" | "jina" | string;
@@ -102,31 +105,51 @@ interface EmbeddingProvider {
         signal?: AbortSignal;
     }): Promise<number[]>;
 }
-interface SummaryProfile {
+interface DescriptionProfile {
     provider: string;
     model: string;
     strategyVersion: string;
 }
-interface SummaryInput {
+interface DescriptionInput {
     repository: string;
     callable: ParsedCallable;
     fileSource: string;
 }
-interface SummaryProvider {
-    readonly profile: SummaryProfile;
-    summarize(input: SummaryInput, options?: {
+interface DescriptionFileInput {
+    repository: string;
+    path: string;
+    fileSource: string;
+}
+interface DescriptionFileSession {
+    describeFile(options?: {
+        signal?: AbortSignal;
+    }): Promise<string>;
+    replayFile(description: string): void;
+    describe(callable: ParsedCallable, options?: {
+        signal?: AbortSignal;
+    }): Promise<string>;
+    replay(callable: ParsedCallable, description: string): void;
+}
+interface DescriptionProvider {
+    readonly profile: DescriptionProfile;
+    describe(input: DescriptionInput, options?: {
+        signal?: AbortSignal;
+    }): Promise<string>;
+    describeFile(input: DescriptionFileInput, options?: {
         signal?: AbortSignal;
     }): Promise<string>;
+    startFile?(input: DescriptionFileInput): DescriptionFileSession;
 }
-interface SummaryStats {
-    summariesCreated: number;
-    summariesEnabled: boolean;
+interface DescriptionStats {
+    descriptionsCreated: number;
+    fileDescriptionsCreated: number;
+    descriptionsEnabled: boolean;
 }
 interface CodeIndexOptions {
     rootDir: string;
     indexPath?: string;
     provider: EmbeddingProvider;
-    summaryProvider?: SummaryProvider;
+    descriptionProvider?: DescriptionProvider;
     onWarning?: (message: string) => void;
     include?: readonly string[];
     exclude?: readonly string[];
@@ -161,6 +184,15 @@ interface UpdateStats {
     embeddingsCreated: number;
     checkpoint: string | null;
 }
+interface ReindexFilesOptions {
+    includeCallables?: boolean;
+    signal?: AbortSignal;
+}
+interface ReindexFilesStats {
+    filesReindexed: number;
+    fileDescriptionsCreated: number;
+    descriptionsCreated: number;
+}
 interface SimilaritySearchOptions {
     query: string;
     /** Restrict result qualified names before ranking and limiting. */
@@ -173,13 +205,15 @@ interface SimilaritySearchOptions {
 interface SimilarityScores {
     similarity: number;
     codeSimilarity?: number;
-    summarySimilarity?: number;
+    descriptionSimilarity?: number;
+    fileDescriptionSimilarity?: number;
 }
 interface AnalysisSimilarity {
-    similarityMode: "code" | "code-summary-average";
+    similarityMode: "code" | "code-description-file-average";
     similarityWeights: {
         code: number;
-        summary: number;
+        description: number;
+        fileDescription: number;
     };
 }
 interface SimilarityResult extends SimilarityScores {
@@ -221,8 +255,8 @@ interface CrossSearchResult {
     source: IndexedFunction;
     matches: SimilarityResult[];
     scoring?: AnalysisSimilarity & {
-        sourceSummaryProfile: SummaryProfile | null;
-        targetSummaryProfile: SummaryProfile | null;
+        sourceDescriptionProfile: DescriptionProfile | null;
+        targetDescriptionProfile: DescriptionProfile | null;
     };
 }
 type CohesionLocationCategory = "same-file" | "same-folder" | "different-folder";
@@ -277,7 +311,7 @@ interface CohesionGroup<FunctionValue = IndexedFunction> {
     maximumCohesionGap: number;
     members: FunctionValue[];
 }
-interface CohesionSummary {
+interface CohesionMetrics {
     scope: "repository" | "selected-sources";
     functionsAnalyzed: number;
     candidateFunctions: number;
@@ -303,12 +337,12 @@ interface CohesionAnalysisOptions {
     }) => void;
 }
 interface CohesionReport<FunctionValue = IndexedFunction> {
-    schemaVersion: 1;
+    schemaVersion: 3;
     repository: {
         generation: number;
         gitCheckpoint: string | null;
         embeddingProfile: Required<EmbeddingProfile>;
-        summaryProfile: SummaryProfile | null;
+        descriptionProfile: DescriptionProfile | null;
     };
     parameters: AnalysisSimilarity & {
         neighbors: number;
@@ -319,7 +353,7 @@ interface CohesionReport<FunctionValue = IndexedFunction> {
         nameRegex?: string;
         sourceFilter: CrossSearchSourceFilter;
     };
-    summary: CohesionSummary;
+    metrics: CohesionMetrics;
     pairs: CohesionPair<FunctionValue>[];
     files: CohesionFileReport<FunctionValue>[];
     groups: CohesionGroup<FunctionValue>[];
@@ -333,9 +367,12 @@ interface IndexStatus {
     generation: number;
     gitCheckpoint: string | null;
     embeddingProfile: Required<EmbeddingProfile>;
-    summariesEnabled: boolean;
-    summaryCount: number;
-    summaryProfile: SummaryProfile | null;
+    descriptionsEnabled: boolean;
+    descriptionCount: number;
+    fileDescriptionCount: number;
+    describableFileCount: number;
+    staleFileDescriptionCount: number;
+    descriptionProfile: DescriptionProfile | null;
     indexingErrorCount: number;
     failedFileCount: number;
 }
@@ -370,22 +407,29 @@ declare class OpenAIEmbeddingProvider implements EmbeddingProvider {
     }): Promise<number[]>;
 }
 
-interface OpenAISummaryProviderOptions {
+interface OpenAIDescriptionProviderOptions {
     apiKey?: string;
     model?: string;
     baseUrl?: string;
+    provider?: DescriptionProviderName;
 }
-declare class OpenAISummaryProvider implements SummaryProvider {
+declare const DESCRIPTION_PROVIDER_NAMES: readonly ["openai", "opencode", "opencode-go"];
+type DescriptionProviderName = typeof DESCRIPTION_PROVIDER_NAMES[number];
+declare class OpenAIDescriptionProvider implements DescriptionProvider {
     #private;
     readonly profile: {
-        provider: string;
+        provider: "openai" | "opencode" | "opencode-go";
         model: string;
         strategyVersion: string;
     };
-    constructor(options?: OpenAISummaryProviderOptions);
-    summarize(input: SummaryInput, options?: {
+    constructor(options?: OpenAIDescriptionProviderOptions);
+    describe(input: DescriptionInput, options?: {
+        signal?: AbortSignal;
+    }): Promise<string>;
+    describeFile(input: DescriptionFileInput, options?: {
         signal?: AbortSignal;
     }): Promise<string>;
+    startFile(input: DescriptionFileInput): DescriptionFileSession;
 }
 
 interface JinaEmbeddingProviderOptions {
@@ -428,13 +472,14 @@ declare function openCodeIndex(options: CodeIndexOptions): CodeIndex;
 declare function updateFiles(index: CodeIndex, options: UpdateFilesOptions): Promise<UpdateStats>;
 declare function updateFromGit(index: CodeIndex, options?: UpdateFromGitOptions): Promise<UpdateStats>;
 declare function updateFromWorkingTree(index: CodeIndex, options?: UpdateFromWorkingTreeOptions): Promise<UpdateStats>;
+declare function reindexFiles(index: CodeIndex, options?: ReindexFilesOptions): Promise<ReindexFilesStats>;
 declare function similaritySearch(index: CodeIndex, options: SimilaritySearchOptions): Promise<SimilarityResult[]>;
-declare function useSummaries(index: CodeIndex, options?: {
+declare function useDescriptions(index: CodeIndex, options?: {
     signal?: AbortSignal;
-}): Promise<SummaryStats>;
-declare function disableSummaries(index: CodeIndex): SummaryStats;
-declare function searchSummary(index: CodeIndex, options: SimilaritySearchOptions): Promise<SimilarityResult[]>;
+}): Promise<DescriptionStats>;
+declare function disableDescriptions(index: CodeIndex): DescriptionStats;
+declare function searchDescription(index: CodeIndex, options: SimilaritySearchOptions): Promise<SimilarityResult[]>;
 declare function crossSearchFunctions(options: CrossSearchOptions): AsyncGenerator<CrossSearchResult, any, any>;
 declare function analyzeCodeCohesion(options: CohesionAnalysisOptions): Promise<CohesionReport<IndexedFunction>>;
 
-export { type AnalysisSimilarity, type CallableKind, CodeIndex, CodeIndexError, type CodeIndexOptions, type CohesionAnalysisOptions, type CohesionFileReport, type CohesionFunctionReference, type CohesionGroup, type CohesionJsonReport, type CohesionLocation, type CohesionLocationCategory, type CohesionPair, type CohesionReport, type CohesionSummary, type CrossSearchOptions, type CrossSearchResult, type CrossSearchSourceFilter, type EmbeddingProfile, type EmbeddingProvider, GitDivergenceError, GitUnavailableError, IncompatibleIndexError, type IndexStatus, type IndexedFunction, type IndexingError, type IndexingIssue, JinaEmbeddingProvider, type JinaEmbeddingProviderOptions, OpenAIEmbeddingProvider, type OpenAIEmbeddingProviderOptions, OpenAISummaryProvider, type OpenAISummaryProviderOptions, type ParsedCallable, type SimilarityResult, type SimilarityScores, type SimilaritySearchOptions, type SourceMode, type SummaryInput, type SummaryProfile, type SummaryProvider, type SummaryStats, type SupportedLanguage, type UpdateFilesOptions, type UpdateFromGitOptions, type UpdateFromWorkingTreeOptions, type UpdateStats, analyzeCodeCohesion, analyzeCohesion, cohesionLocation, crossSearch, crossSearchFunctions, disableSummaries, openCodeIndex, readIndexErrors, searchSummary, similaritySearch, updateFiles, updateFromGit, updateFromWorkingTree, useSummaries };
+export { type AnalysisSimilarity, type CallableKind, CodeIndex, CodeIndexError, type CodeIndexOptions, type CohesionAnalysisOptions, type CohesionFileReport, type CohesionFunctionReference, type CohesionGroup, type CohesionJsonReport, type CohesionLocation, type CohesionLocationCategory, type CohesionMetrics, type CohesionPair, type CohesionReport, type CrossSearchOptions, type CrossSearchResult, type CrossSearchSourceFilter, type DescriptionFileInput, type DescriptionFileSession, type DescriptionInput, type DescriptionProfile, type DescriptionProvider, type DescriptionProviderName, type DescriptionStats, type EmbeddingProfile, type EmbeddingProvider, GitDivergenceError, GitUnavailableError, IncompatibleIndexError, type IndexStatus, type IndexedFunction, type IndexingError, type IndexingIssue, JinaEmbeddingProvider, type JinaEmbeddingProviderOptions, OpenAIDescriptionProvider, type OpenAIDescriptionProviderOptions, OpenAIEmbeddingProvider, type OpenAIEmbeddingProviderOptions, type ParsedCallable, type ReindexFilesOptions, type ReindexFilesStats, type SimilarityResult, type SimilarityScores, type SimilaritySearchOptions, type SourceMode, type SupportedLanguage, type UpdateFilesOptions, type UpdateFromGitOptions, type UpdateFromWorkingTreeOptions, type UpdateStats, analyzeCodeCohesion, analyzeCohesion, cohesionLocation, crossSearch, crossSearchFunctions, disableDescriptions, openCodeIndex, readIndexErrors, reindexFiles, searchDescription, similaritySearch, updateFiles, updateFromGit, updateFromWorkingTree, useDescriptions };