trading-platform/orchestration/tareas/TASK-2026-01-25-OQI-003-TRADING-ADVANCED/06-DOCUMENTACION.md
Adrian Flores Cortes eb8ddadf40 [DOCS] docs: Add task documentation for TASK-2026-01-25-OQI-003-TRADING-ADVANCED
- METADATA.yml with CAPVED phases
- 05-EJECUCION.md with implementation details
- 06-DOCUMENTACION.md with API documentation
- _INDEX.yml updated (11 tasks, 10 completed)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-25 14:28:51 -06:00

229 lines
5.1 KiB
Markdown

# DOCUMENTACIÓN - TASK-2026-01-25-OQI-003-TRADING-ADVANCED
**Estado:** Completada
**Fecha:** 2026-01-25
---
## Propagación de Cambios
### Nivel: Proyecto (trading-platform)
| Documento | Estado | Cambio |
|-----------|--------|--------|
| FRONTEND_INVENTORY.yml | Actualizado | +4 componentes, total 90, OQI-003 al 45% |
| MASTER_INVENTORY.yml | Actualizado | component count 127, OQI-003 progress 45% |
| index.ts (trading/components) | Actualizado | 4 new exports + types |
### Nivel: Workspace
| Documento | Estado | Cambio |
|-----------|--------|--------|
| Submodule reference | Pendiente | 1 commit to trading-platform |
---
## API de Componentes Creados
### OrderBookDepthVisualization
```typescript
interface DepthLevel {
price: number;
quantity: number;
total: number;
}
interface DepthData {
bids: DepthLevel[];
asks: DepthLevel[];
midPrice: number;
spread: number;
spreadPercentage: number;
lastUpdate: Date;
}
interface DepthChartConfig {
showGrid: boolean;
showMidLine: boolean;
showTooltip: boolean;
animateChanges: boolean;
bidColor: string;
askColor: string;
fillOpacity: number;
strokeWidth: number;
priceRange: number;
}
interface OrderBookDepthVisualizationProps {
data: DepthData | null;
config?: Partial<DepthChartConfig>;
onPriceClick?: (price: number, side: 'bid' | 'ask') => void;
onRefresh?: () => void;
isLoading?: boolean;
height?: number;
compact?: boolean;
}
```
### MarketDepthPanel
```typescript
interface OrderLevel {
price: number;
quantity: number;
total: number;
orders?: number;
exchange?: string;
}
interface MarketDepthData {
symbol: string;
bids: OrderLevel[];
asks: OrderLevel[];
midPrice: number;
spread: number;
spreadPercentage: number;
imbalance: number;
lastUpdate: Date;
}
type ViewMode = 'table' | 'chart' | 'split';
type GroupingLevel = 'none' | '0.01' | '0.1' | '1' | '10' | '100';
interface MarketDepthPanelProps {
data: MarketDepthData | null;
onPriceClick?: (price: number, side: 'bid' | 'ask') => void;
onRefresh?: () => void;
onExport?: (format: 'csv' | 'json') => void;
isLoading?: boolean;
displayRows?: number;
compact?: boolean;
}
```
### SymbolComparisonChart
```typescript
interface PricePoint {
timestamp: number;
price: number;
volume?: number;
}
interface SymbolData {
symbol: string;
name: string;
data: PricePoint[];
color: string;
visible: boolean;
basePrice: number;
currentPrice: number;
change: number;
changePercent: number;
}
type NormalizationMode = 'absolute' | 'percentage' | 'indexed';
type TimeframeOption = '1D' | '1W' | '1M' | '3M' | '6M' | '1Y' | 'YTD' | 'ALL';
interface SymbolComparisonChartProps {
symbols: SymbolData[];
onAddSymbol?: () => void;
onRemoveSymbol?: (symbol: string) => void;
onToggleVisibility?: (symbol: string) => void;
onRefresh?: () => void;
onExport?: () => void;
onTimeframeChange?: (timeframe: TimeframeOption) => void;
isLoading?: boolean;
height?: number;
compact?: boolean;
}
```
### TradingScreener
```typescript
interface ScreenerResult {
symbol: string;
name: string;
sector?: string;
industry?: string;
exchange: string;
price: number;
change: number;
changePercent: number;
volume: number;
avgVolume: number;
marketCap?: number;
pe?: number;
eps?: number;
high52w: number;
low52w: number;
rsi?: number;
macdSignal?: 'bullish' | 'bearish' | 'neutral';
sma20?: number;
sma50?: number;
sma200?: number;
atr?: number;
beta?: number;
dividendYield?: number;
isFavorite?: boolean;
}
interface ScreenerFilter {
id: string;
field: keyof ScreenerResult;
operator: 'gt' | 'lt' | 'eq' | 'gte' | 'lte' | 'between' | 'contains';
value: number | string | [number, number];
enabled: boolean;
}
interface SavedScreener {
id: string;
name: string;
filters: ScreenerFilter[];
createdAt: Date;
}
interface TradingScreenerProps {
results: ScreenerResult[];
savedScreeners?: SavedScreener[];
onSearch?: (query: string) => void;
onFilterChange?: (filters: ScreenerFilter[]) => void;
onSaveScreener?: (name: string, filters: ScreenerFilter[]) => void;
onLoadScreener?: (screener: SavedScreener) => void;
onDeleteScreener?: (id: string) => void;
onSymbolClick?: (symbol: string) => void;
onAddToWatchlist?: (symbol: string) => void;
onToggleFavorite?: (symbol: string) => void;
onExport?: (format: 'csv' | 'json') => void;
onRefresh?: () => void;
isLoading?: boolean;
compact?: boolean;
}
```
---
## Checklist de Cierre
- [x] Componentes creados con JSDoc headers
- [x] Types exportados correctamente
- [x] index.ts barrel actualizado
- [x] FRONTEND_INVENTORY.yml actualizado
- [x] MASTER_INVENTORY.yml actualizado
- [x] Commits realizados con formato correcto
- [x] Push a los repositorios (frontend, trading-platform)
- [x] METADATA.yml de tarea creado
- [x] Documentación de ejecución completada
---
## Próxima Acción Recomendada
1. Ejecutar `npm run build` en frontend para validar tipos
2. Integrar componentes con API de datos reales
3. Implementar WebSocket para datos en tiempo real
4. Agregar tests unitarios para componentes críticos
5. Completar persistencia de drawing tools (ET-TRD-010)