babylon-mcp/src/search/types.ts
Michael Mainguy 5459fe9179 feat: Add TypeScript API documentation indexing and search with improved test coverage
## New Features
- Implemented TSDoc extraction using TypeDoc API
- Added API documentation indexing with LanceDB vector search
- Created search_babylon_api MCP tool for querying API docs
- Added 6 indexing and testing scripts

## API Indexing System
- TSDocExtractor: Parses TypeScript source files and extracts documentation
- ApiIndexer: Converts API docs to embeddings and stores in LanceDB
- Support for all Babylon.js packages (core, gui, materials, loaders, etc.)
- Successfully indexed 44,253 API entries from core package

## Bug Fixes
- Fixed TypeScript strict mode errors with exactOptionalPropertyTypes
- Fixed optional property handling in tsConfigPath and returns fields
- Resolved EventEmitter MaxListeners warning in test suite
- Updated all failing handler tests for real implementation

## Test Coverage Improvements
- Added 27 new tests (92 → 119 tests passing)
- Lines: 93.88% (was 82.53%, target 80%) ✓
- Functions: 100% (was 91.17%, target 80%) ✓
- Statements: 93.3% (was 81.58%, target 80%) ✓
- Branches: 69.72% (was 51.37%, target 75%)

## New Test Files
- src/search/lancedb-search.test.ts (15 tests)
- Enhanced handlers.test.ts with API search tests
- Enhanced document-parser.test.ts with edge case tests

## Scripts Added
- scripts/index-api.ts: Index all Babylon.js API documentation
- scripts/test-api-indexing.ts: Test API indexing for core package
- scripts/test-api-search.ts: Test API search functionality
- scripts/get-api-details.ts: Display detailed API documentation
- scripts/search-handmenu-api.ts: Search for HandMenu API examples

## Technical Details
- TypeDoc integration for TSDoc extraction
- Vector embeddings using Xenova/all-MiniLM-L6-v2 model
- Semantic search across 11 Babylon.js packages
- GitHub source links with line numbers in search results

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-23 05:58:16 -06:00

77 lines
1.4 KiB
TypeScript

export interface DocumentMetadata {
filePath: string;
title: string;
description: string;
keywords: string[];
category: string;
breadcrumbs: string[];
content: string;
headings: Heading[];
codeBlocks: CodeBlock[];
furtherReading: RelatedLink[];
playgroundIds: string[];
lastModified: Date;
}
export interface Heading {
level: number;
text: string;
id: string;
}
export interface CodeBlock {
language: string;
code: string;
lineStart: number;
}
export interface RelatedLink {
title: string;
url: string;
}
export interface SearchOptions {
limit?: number;
category?: string;
queryType?: 'keyword' | 'semantic' | 'hybrid';
}
export interface SearchResult {
title: string;
description: string;
content: string;
url: string;
category: string;
score: number;
keywords: string[];
}
export interface ApiDocumentation {
name: string;
fullName: string;
kind: string;
summary: string;
description: string;
examples: string[];
parameters: ApiParameter[];
returns?: ApiReturn | undefined;
type?: string | undefined;
deprecated?: string | undefined;
see: string[];
since?: string | undefined;
sourceFile: string;
sourceLine: number;
}
export interface ApiParameter {
name: string;
type: string;
description: string;
optional: boolean;
}
export interface ApiReturn {
type: string;
description: string;
}