@spider-analyzer/timeline 4.0.3 → 5.0.0

package/CHANGELOG.md

@@ -1,4 +1,73 @@
-##4.0.0
+## 5.0.0
+
+First v5 release on npm. Major rework focused on decoupling consumers
+from `moment-timezone` / `@material-ui/styles` / `lodash-es`, and
+simplifying the zoom-state API. See `MIGRATION-v5.md` for a
+step-by-step upgrade guide.
+
+### Breaking — public API
+
+- **Instants are native `Date` everywhere.** Every prop and callback
+  argument that used to be a `moment` object is now a plain `Date`.
+- **Durations are plain numbers (milliseconds).** `biggestVisibleDomain`,
+  `biggestTimeSpan`, `smallestResolution` no longer accept
+  `moment.Duration`.
+- **`timeZone: string`** (IANA name) is now required. It threads into
+  the internal tz-aware time engine so formatting is correct regardless
+  of host settings.
+- **`domain` replaces `domains`.** The zoom-history stack is moved
+  inside the component. The host passes a single
+  `domain: {min, max} | null` and observes changes via
+  `onDomainChange(domain)`. Pass `null` on first render to defer to
+  `onLoadDefaultDomain()`. Hosts gain **zoom-out-to-previous-view undo
+  for free** — the breadcrumb is kept internally.
+- **`onDomainChange(domain)`** replaces `onUpdateDomains(domains)`.
+- **`onTimeSpanChange({start, stop})`** replaces `onCustomRange(start, stop)`.
+- **`onLoadHisto({intervalMs, start, end})`** — object shape (was
+  positional args).
+- **`onLoadDefaultDomain(): Domain | Promise<Domain> | void`** — may
+  now return the default (sync or async). The component seeds its
+  internal stack from the returned value.
+- **`@material-ui/styles` peerDep removed.** The library ships one
+  `dist/timeline.css` with rules keyed on `tl-<slot>` class names.
+  Consumers override via `classes={{ <slot>: 'my-class' }}` and plain
+  CSS in their own stylesheet.
+- **Peer deps slim.** Only React ≥ 16.8 now; no more MUI / moment
+  peer-pulls.
+
+### Removed runtime dependencies
+
+- `@material-ui/styles` — replaced by static CSS + `classes` prop.
+- `moment-timezone` — replaced internally by Luxon (via a moment-API
+  shim, `src/moment-shim.ts`); drops ~300 KB from consumer bundles
+  that didn't already use moment.
+- `lodash-es` — replaced by ~50 lines of local helpers in
+  `src/utils.ts`.
+
+### Internal
+
+- `src/TimeLine.jsx` class component → `src/TimeLine.tsx` function
+  component with hooks (`useState` / `useEffect` / `useRef` /
+  `useCallback` / `forwardRef` + `useImperativeHandle`). Behavior
+  preserved; every prior `componentDidUpdate` branch now lives in a
+  focused effect.
+- `src/index.ts` with a full typed public API; tsup emits `.d.ts`
+  alongside ESM + CJS.
+- Babel build replaced by tsup (ESM + CJS + `.d.ts` + CSS). ≈85 KB
+  ESM; `luxon` is external so consumers dedupe.
+- `src/time.ts` funnels the Date ↔ Luxon conversion at the boundary —
+  one file to touch if we ever swap the time engine again.
+- `rc-tooltip` bumped 5 → 6; migrated `visible` → `open`.
+- Vitest + Testing Library regression suite (12 tests).
+- Demo app modernized to Vite + React 18 + luxon; Docker / koa / webpack
+  stack removed.
+
+## 4.1.0
+- React 18 / 19 peer support (peerDependency widened to `^16.8.0 || ^17 || ^18 || ^19`; React 15 no longer supported — hooks are required).
+- Fix: replaced `defaultProps` on function components (Cursor, ToolTip, XAxis, YAxis, XGrid, YGrid) with default-parameter destructuring. Removes the React 18.3 deprecation warning and keeps the component working in React 19 where `defaultProps` on function components is removed.
+- Dev: added Vitest + Testing Library regression suite (12 tests covering render, ref API, onLoadHisto/onLoadDefaultDomain/onUpdateDomains contracts, zoomIn/zoomOut stack semantics, shiftTimeLine).
+
+## 4.0.0
 - Changed to moment-timezone to manage change of default timezone in parent application
 
 ## 3.4.0