Migrate to React 19, Typescript, Vite, and Vitest

[mrecachinas]

Migrates react-sigplot to React 19, TypeScript, Vite, and Vitest, and rewrites the class components as function components built on a shared useLayer hook.

Release: 1.0.0 (major)

This changes the public API, the sigplot dependency, and the package format, so it's a major release. Existing ^0.1.16 ranges stop below 0.2.0, so current users won't get it by accident.

Breaking changes since 0.1.16

Requirements

• React 19 (react / react-dom ^19). prop-types is no longer a peer dependency.
• sigplot ^3.1.7.
  • The old ^2.0.0-rc20 range actually installed 2.0.0-rc9, because npm sorts prerelease tags as strings.
  • Layer IDs from overlay_* are now UUID strings, and reload / push throw if given a numeric index. This only matters for code that calls the Plot API directly.

API

• The Layer base class is removed; write function components with usePlot().
• The Plugin base class is replaced by <Plugin plugin={instance} zorder={n} />.
• Children of <SigPlot> no longer receive an injected plot prop; use usePlot().
• A ref on <SigPlot> now receives the Plot itself (ref.current) instead of the component (ref.current.plot).
• href (HrefLayer), wsurl (WebsocketLayer), and data (BlueLayer) are required.
• BlueLayer replaces its layer when data changes, instead of calling reload.

Packaging

• ESM (dist/react-sigplot.js) and CommonJS (dist/react-sigplot.cjs) builds with type declarations. The main path has changed.
• The UMD build and window global are removed, since React 19 ships no UMD build.
• An exports map blocks deep imports.
• WPipeLayer is removed; it was never exported.

The README has a migration guide covering these.

Other changes

Fixes (also present in 0.1.16)

• HrefLayer replaces only its own layer when href changes. Before, it removed every layer on the plot.
• Removing a layer no longer breaks updates to its siblings, because layers are tracked by UUID instead of by position.
• SigPlot removes sigplot's window / document listeners on unmount.
• The canvas resizes before the browser paints, which fixes flicker while resizing.
• ArrayLayer and PipeLayer accept typed arrays.
• Options objects you pass in are no longer modified. sigplot deletes name from layer options, sets pipe on pipe headers, and fills in defaults on plot options, so it now gets a copy.
• Inline options like options={{ autol: 1 }} no longer redo work on every render. Options were compared by reference, so each parent render re-applied them and redrew every plot; they're now compared by value. In a Chromium benchmark with 3 plots re-rendering at 60 Hz, this cut main-thread time from 183 ms/s to 39 ms/s.
• Unmounted plots are released right away. Before, the last plots unmounted stayed in memory until React's next update, and sigplot's own module cache kept the newest plot.

New

• <BoxesPlugin> wraps sigplot's boxes plugin:
  • onAdd / onRemove / onMove / onSelect callbacks, which receive copies of the boxes;
  • addOnMtag, which adds a box on ctrl/⌘-drag;
  • a ref for addBox / removeBox / clearBoxes / getBoxes.
• onMtag on <SigPlot>, and usePlotEvent(type, handler) for any sigplot event.
• PlotOptions, DataHeader, and LayerOptions list the settings sigplot 3.1.7 reads, with docs.
  • They note which plot settings sigplot only reads at creation or only when they change.
  • Settings that aren't listed are still accepted.
• Types for every component and for the Plot API (Plot, LayerId, PlotPlugin, …).
• usePlot() and SigPlotContext.
• ref on <SigPlot>.

The boxes plugin, onMtag, and typed options are ported from #4 and updated for sigplot 3.x.

Tooling

• TypeScript 7, Vite 6, Vitest 4, and Biome replace Babel, webpack, Jest, and ESLint/Prettier.
• CI runs on main with Node 22, 24, and 26.
• prepack builds dist/ before every publish.
• Travis, jsdoc, and docgen configs are removed.

Testing

• Lint, type-check (source, tests, and example), 69 tests (99% statement coverage), and build all pass.
• @arethetypeswrong/cli finds no problems (node10, node16 CJS and ESM, bundler).
• Installed the tarball from npm pack in a fresh project and checked:
  • CommonJS require
  • Node ESM import
  • a Vitest import
  • tsc with skipLibCheck: false, both bundler and nodenext resolution
• Ran the demo (npm run dev) in Chromium and WebKit, and drew and moved boxes in Chromium.
• In Chromium, mounted and unmounted 20 plots (with layers, boxes, and onMtag) three times. After forced garbage collection, 0 Plots and 0 canvases remained.

Known issues

• Extra install size from sigplot. sigplot 3.x lists dev tools (budo, travis) as runtime dependencies. That adds about 300 packages to every install, including an elliptic advisory that has no fix. main's sigplot rc20 has the same problem; it needs a fix in sigplot.
• Docs site. The GitHub Pages docs site no longer builds. The README is now the reference.
• Package metadata. repository, homepage, and bugs in package.json still point to LGSInnovations/react-sigplot, the repo this one was forked from.