@ninjaxtools/slopdex 0.11.0 → 0.13.0

package/dist/index.d.ts

@@ -15,6 +15,7 @@ declare class CodeIndex {
     useDescriptions(options?: {
         signal?: AbortSignal;
     }): Promise<DescriptionStats>;
+    reindexFiles(options?: ReindexFilesOptions): Promise<ReindexFilesStats>;
     disableDescriptions(): DescriptionStats;
     searchDescription(options: SimilaritySearchOptions): Promise<SimilarityResult[]>;
     similaritySearch(options: SimilaritySearchOptions): Promise<SimilarityResult[]>;
@@ -28,8 +29,10 @@ declare class CodeIndex {
         nameRegex?: string;
     }): SimilarityResult[];
     vectorForFunction(functionId: number, kind?: "code" | "description"): number[];
+    vectorForFile(filePath: string): number[];
     searchByVector(vector: readonly number[], options: {
         descriptionVector?: readonly number[];
+        fileDescriptionVector?: readonly number[];
         limit: number;
         minSimilarity: number;
         maxSimilarity?: number;
@@ -112,14 +115,34 @@ interface DescriptionInput {
     callable: ParsedCallable;
     fileSource: string;
 }
+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 DescriptionStats {
     descriptionsCreated: number;
+    fileDescriptionsCreated: number;
     descriptionsEnabled: boolean;
 }
 interface CodeIndexOptions {
@@ -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. */
@@ -174,12 +206,14 @@ interface SimilarityScores {
     similarity: number;
     codeSimilarity?: number;
     descriptionSimilarity?: number;
+    fileDescriptionSimilarity?: number;
 }
 interface AnalysisSimilarity {
-    similarityMode: "code" | "code-description-average";
+    similarityMode: "code" | "code-description-file-average";
     similarityWeights: {
         code: number;
         description: number;
+        fileDescription: number;
     };
 }
 interface SimilarityResult extends SimilarityScores {
@@ -303,7 +337,7 @@ interface CohesionAnalysisOptions {
     }) => void;
 }
 interface CohesionReport<FunctionValue = IndexedFunction> {
-    schemaVersion: 2;
+    schemaVersion: 3;
     repository: {
         generation: number;
         gitCheckpoint: string | null;
@@ -335,6 +369,9 @@ interface IndexStatus {
     embeddingProfile: Required<EmbeddingProfile>;
     descriptionsEnabled: boolean;
     descriptionCount: number;
+    fileDescriptionCount: number;
+    describableFileCount: number;
+    staleFileDescriptionCount: number;
     descriptionProfile: DescriptionProfile | null;
     indexingErrorCount: number;
     failedFileCount: number;
@@ -374,11 +411,14 @@ interface OpenAIDescriptionProviderOptions {
     apiKey?: string;
     model?: string;
     baseUrl?: string;
+    provider?: DescriptionProviderName;
 }
+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;
     };
@@ -386,6 +426,10 @@ declare class OpenAIDescriptionProvider implements DescriptionProvider {
     describe(input: DescriptionInput, options?: {
         signal?: AbortSignal;
     }): Promise<string>;
+    describeFile(input: DescriptionFileInput, options?: {
+        signal?: AbortSignal;
+    }): Promise<string>;
+    startFile(input: DescriptionFileInput): DescriptionFileSession;
 }
 
 interface JinaEmbeddingProviderOptions {
@@ -428,6 +472,7 @@ 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 useDescriptions(index: CodeIndex, options?: {
     signal?: AbortSignal;
@@ -437,4 +482,4 @@ declare function searchDescription(index: CodeIndex, options: SimilaritySearchOp
 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 CohesionMetrics, type CohesionPair, type CohesionReport, type CrossSearchOptions, type CrossSearchResult, type CrossSearchSourceFilter, type DescriptionInput, type DescriptionProfile, type DescriptionProvider, 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 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, searchDescription, similaritySearch, updateFiles, updateFromGit, updateFromWorkingTree, useDescriptions };
+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 };