Initial Commit

This commit is contained in:
2026-05-27 23:29:53 +01:00
commit fbc70f96e6
10000 changed files with 1102152 additions and 0 deletions

View File

@@ -0,0 +1,112 @@
# OpenSpec Change: enterprise-react-timeline
- **Change ID**: enterprise-react-timeline
- **Package**: `@suaveplan/react-timeline`
- **Category**: react
- **Target path**: `react/ui/react-timeline`
- **Status**: PROPOSED
- **Date**: 2026-04-24
- **Reference spec**: `/mnt/s/web/suaveplan/enterprise/react-timeline.md`
---
## Summary
Deliver `@suaveplan/react-timeline` on genesis from scratch at enterprise quality. A hybrid DOM+Canvas React timeline library with three view modes: `Timeline` (horizontal scrolling), `Gantt` (dependency arrows), and `Calendar` (day/week/month grid). Ships building-block primitives, a headless layout engine, `TimelineProvider`, seven headless hooks, Canvas renderers, and time-math utilities. TypeScript generics on `TMeta` let events carry arbitrary metadata. Genesis adds `@suaveplan/react-virtual` integration for large event sets, `@suaveplan/error`-backed errors, OTel instrumentation, hook playground stories, and Playwright visual-regression snapshots.
---
## Current-state audit (genesis)
Package does not exist on genesis — fresh build.
---
## Available workspace deps on genesis
| Package | Role |
|---|---|
| `@suaveplan/error` (`workspace:^`) | `TimelineError` |
| `@suaveplan/types` (`workspace:^`) | Shared types |
| `@suaveplan/react-translate` (`workspace:^`) | i18n |
| `@suaveplan/react-virtual` (`workspace:^`) | Virtual row rendering for large event sets |
| `zod` (`catalog:forms`) | Config schemas |
| `@opentelemetry/api` (`catalog:observability`) | Span events |
External: `clsx catalog:ui`, `tailwind-merge catalog:ui`, `tslib catalog:build`. React 18 peer.
---
## Preserved public API surface
### Components
`Timeline<TMeta>`, `Gantt<TMeta>`, `Calendar<TMeta>`, `EventBar`, `GridLines`, `Marker`, `TimeRuler`, `TrackRow`, `TimelineTooltip`, `DependencyArrow`
### Context
`TimelineProvider`, `useTimelineContext`
### Engine
`computeLayout`
### Hooks
`useTimeline`, `useDrag`, `usePan`, `useScale`, `useSelection`, `useVirtual`, `useZoom`
### Canvas renderers
`drawGridLines`, `drawTrackLines`, `setupCanvas`, `drawEvents`, `drawDependencyArrows`
### Time utilities
`addTime`, `clampDate`, `dateToPixel`, `diffMs`, `generateTicks`, `pixelToDate`, `snapToGrid`
### Types
Full `TMeta`-generic type set including `TimelineEvent`, `TimelineTrack`, `TimeScaleConfig`, `LayoutResult`, `DragState`, `SelectionState`.
---
## New additions for genesis
1. **`@suaveplan/react-virtual` integration** — `useVirtual` hook delegates to `@suaveplan/react-virtual` `useVirtualList` when event count > 500.
2. **Timezone-aware `TimeScaleConfig`** — optional `timeZone: string` field; all pixel math uses UTC offsets.
3. **Collision avoidance story** — `Gantt` stories include overlapping events demonstrating lane computation.
4. **Hook playground stories** — one story per hook showing its isolated state.
5. **Playwright visual-regression snapshots** — Canvas rendering verified via screenshot diffing.
---
## File layout
```text
react/ui/react-timeline/
package.json
tsconfig.json
vitest.config.ts
src/
index.ts
core/
context/ (tsx + types + md + test + index)
engine/ (ts + types + md + test + index)
types/ (ts + md)
components/
timeline/ gantt/ calendar/
event-bar/ grid-lines/ marker/ time-ruler/
track-row/ tooltip/ dependency-arrow/
hooks/
use-timeline/ use-drag/ use-pan/ use-scale/
use-selection/ use-virtual/ use-zoom/
renderers/
canvas-renderer/ event-renderer/
utils/
cn/ time-utils/ layout/ scale-config/
styles/
timeline.css
tests/
integration.test.tsx
e2e/
timeline.spec.ts
```

View File

@@ -0,0 +1,91 @@
# Tasks: enterprise-react-timeline
**Change ID**: enterprise-react-timeline
**Package**: `@suaveplan/react-timeline`
**Target path**: `react/ui/react-timeline`
**Prerequisite packages on Verdaccio**: `@suaveplan/error`, `@suaveplan/types`, `@suaveplan/react-translate`, `@suaveplan/react-virtual`
---
## 0. Pre-flight (non-negotiable)
- [ ] 0.1 Confirm clean working tree (`git status` reports nothing) and no in-flight worktrees with uncommitted work (`git worktree list` then `git status` in each)
- [ ] 0.2 If any worktrees exist under `.claude/worktrees/`, account for each one: still-active agent, work-pending-merge, or stale-and-prune. Stale worktrees MUST be removed (`git worktree remove`) before opening a new one — code that has been lost twice on main is the failure mode this guards against.
- [ ] 0.3 Confirm the package set in `MANIFEST.md` matches `find packages -maxdepth 3 -name package.json` count. Drift here means a prior change archived without regenerating the manifest.
## 1. Scaffold
- [ ] Create directory tree per proposal layout.
- [ ] Write `package.json` at `0.1.0` with `"sideEffects": ["**/*.css"]`, exports map.
- [ ] Dependencies: `@suaveplan/error workspace:^`, `@suaveplan/types workspace:^`, `@suaveplan/react-translate workspace:^`, `@suaveplan/react-virtual workspace:^`, `clsx catalog:ui`, `tailwind-merge catalog:ui`, `zod catalog:forms`, `@opentelemetry/api catalog:observability`, `tslib catalog:build`.
- [ ] Write `tsconfig.json`, `vitest.config.ts`, scripts.
---
## 2. Types and errors
- [ ] Define `TimelineError` extending `SuaveplanError`; codes: `TIMELINE_INVALID_EVENT`, `TIMELINE_LAYOUT_FAILED`.
- [ ] Define all public types: `TimelineEvent<TMeta>`, `TimelineTrack<TMeta>`, `TimeScaleConfig` (with optional `timeZone`), `LayoutResult`, `DragState`, `SelectionState`, `DependencyEdge`.
- [ ] Write Zod `TimeScaleConfigSchema`.
---
## 3. Core context and engine
- [ ] Implement `TimelineProvider` — context value with scale, view, viewport, event store, dispatch.
- [ ] Implement `useTimelineContext` — throws `TimelineError(TIMELINE_INVALID_EVENT)` when used outside provider.
- [ ] Implement `computeLayout<TMeta>(events, tracks, scale)` — overlap resolution (greedy lane assignment), returns `LayoutResult` with per-event pixel bounds and lane index.
- [ ] Write tests + md for context and engine. `{ timeout: 5000 }`.
---
## 4. Hooks (7)
For each hook:
- [ ] Implement with full types, using `TimelineProvider` state.
- [ ] `useVirtual` — delegates to `@suaveplan/react-virtual` `useVirtualList` when event count > 500; falls back to full render below.
- [ ] Write `<hook>.test.ts` (≤500 lines) + `<hook>.md` + `<hook>.stories.tsx` (playground variant).
---
## 5. Canvas renderers
- [ ] `src/renderers/canvas-renderer/` — `drawGridLines(ctx, scale, viewport)`, `drawTrackLines(ctx, tracks, scale)`, `setupCanvas(canvas, dpr)`.
- [ ] `src/renderers/event-renderer/` — `drawEvents(ctx, items, scale)`, `drawDependencyArrows(ctx, edges, scale)`.
- [ ] Write tests using `OffscreenCanvas` (available in Node via `@suaveplan/testing` polyfill). Write md.
---
## 6. Components
For each component (`Timeline`, `Gantt`, `Calendar`, primitives):
- [ ] Implement component referencing context + engine + renderers.
- [ ] `Timeline` + `Gantt` + `Calendar` — each has stories: `default`, `large-dataset` (1000 events), `gantt-dependencies`, `calendar-month`, `playground`.
- [ ] All primitive components — stories: `default`, `playground`.
- [ ] Write test + md for every component.
---
## 7. Time utilities
- [ ] Implement `addTime`, `clampDate`, `dateToPixel`, `diffMs`, `generateTicks`, `pixelToDate`, `snapToGrid` in `src/utils/time-utils/`.
- [ ] Timezone-aware: `dateToPixel` and `pixelToDate` accept optional `timeZone`.
- [ ] Write `time-utils.test.ts` (≤500 lines), `time-utils.md`.
---
## 8. Integration and E2E
- [ ] `tests/integration.test.tsx` — `Timeline` with 50 events: layout produced, no overlapping items in same lane; `Gantt` renders dependency arrows.
- [ ] `e2e/timeline.spec.ts` — Playwright: render `Timeline`, take screenshot snapshot; render `Gantt` with overlapping events, verify lane separation visually.
---
## 9. Verify and publish
- [ ] `bunx turbo lint typecheck test --filter=@suaveplan/react-timeline` — green.
- [ ] `bunx turbo test:coverage --filter=@suaveplan/react-timeline` — 100%.
- [ ] `bun scripts/publish.ts --package @suaveplan/react-timeline`.
- [ ] Archive change folder.