@reportwright/react 0.13.1 → 0.13.2-rc.2

package/CHANGELOG.md

@@ -2,6 +2,57 @@
 
 All `@reportwright/*` packages (formerly `@pagewrightjs/*`) share one version. The versioning policy is in [CONTRIBUTING.md](CONTRIBUTING.md#versioning-semver).
 
+## 0.13.2-rc.2 — 2026-10-09 (release candidate)
+
+### Fixed (from the rc.1 release gate)
+- **E11 Viewer accessibility:** the scrolling page area (`div.vpages`) is keyboard-focusable (`tabindex="0"`), a named `region`, with a visible inset focus ring; the arrow keys scroll it (axe `scrollable-region-focusable`).
+- **E12 Designer arrow keys on pages with margins:** Arrow and Shift+Arrow move the selection by the whole step (1/10 pt, or 1/10 grid steps with Snap to grid). The step used to be clamped to the band's leftover width, so an item as wide as an A4 body with 36 pt margins (523.28 pt) moved 0.28 pt and then not at all. A keyboard nudge still stops at the band's start; overflow past its end shows in the Issues panel. Dragging still keeps items inside the band.
+- **E10 webpack and Next.js builds:** `@reportwright/viewer` (`dist/`, `dist/peer/`) and `@reportwright/cli` ship `pdfstreamworker.js` next to the bundles that name it with `new URL('./pdfstreamworker.js', import.meta.url)`, so bundlers resolve it. The parallel PDF paint worker itself is `@reportwright/engine`'s (Node only); the stand-ins answer that `exportPdfStream` with `parallel` needs the engine.
+- **E13 missing HarfBuzz subset WASM:** when `harfbuzz-subset.wasm` cannot be loaded (fonts then embed in full, PDFs many times larger), `exportPdf` and `exportPdfStream` warn once on the console and add a warning to the result (the model's `warnings`, the stream result's `warnings`), naming the expected path (`@reportwright/fonts/public/harfbuzz-subset.wasm`) and the fix: install `@reportwright/fonts`, or pass `subset: createSubsetter(() => wasmBytes)`.
+- **E09 importer:**
+  - files are read in their own encoding: a UTF-16 LE/BE or UTF-8 byte-order mark, else the XML declaration's `encoding` (ISO-8859-1, Latin-1, windows-1252, …), else UTF-8. `Straße` and `Grüße` survive. Applies to `pw import`, `pw import <folder>` and `POST /api/reports/import`.
+  - a compiled `.jasper` file gets "This is a compiled JasperReports file; import the .jrxml source instead."
+  - `pw import` prints each error once (it printed it twice, the second time cut short).
+- **E07 SQL connection pool:** a PostgreSQL or MySQL query that cannot get a pooled connection within `PW_DB_ACQUIRE_MS` (default 5000) fails with 503 and `Retry-After` instead of a 500; a connection that frees later goes back to the pool. A streaming query whose reader aborts frees its connection at once (the backend is terminated and the connection discarded) instead of holding it until the deadline. PostgreSQL queries run under `statement_timeout` from their first statement.
+
+## 0.13.2-rc.1 — 2026-10-09 (release candidate)
+
+### Changed
+- **The rename to ReportWright is finished; every old Pagewright name keeps working until 1.0.** New names, with the old one kept as a deprecated alias:
+  - report schema: `reportwright/report@1` is now what new and saved reports carry; `pagewright/report@1` is read as the same format (a server before 0.9 cannot open a report saved by 0.13.2).
+  - HTTP headers: `x-reportwright-pages`, `-ms`, `-warnings`, `-snapshot`, `-pending`, `-signature` (webhooks and the audit SIEM webhook) and `-idempotency-key` (mail) are sent together with the old `x-pagewright-*` header; the proxy secret is read from `x-reportwright-proxy-secret`, else `x-pagewright-proxy-secret`.
+  - Prometheus metrics: `/api/v1/metrics` emits every family as `reportwright_*` and again as `pagewright_*` (the old ones go in 1.0: move dashboards and alerts). `scripts/uptime-check.mjs` reads either.
+  - one console warning per page for `definePagewrightElements`, the `<pagewright-viewer>` / `<pagewright-designer>` tags, the Svelte `pagewrightViewer` / `pagewrightDesigner` actions, `window.Pagewright` and `/embed/pagewright-viewer.js` (and `-viewer.full.js`). The React and Vue `PagewrightViewer` / `PagewrightDesigner` stay the same components, without a warning; all are typed `@deprecated`.
+  - the live demo moved to https://mrarun005.github.io/reportwright-demo/ (the site build's default base is `/reportwright-demo/`).
+  - kept as they are, since changing them would break stored data: the `.pw.json` extension, the designer clipboard format `pagewright/items@1`, and the salts of the TOTP secret key and the audit checkpoint chain.
+- **The render worker is minified.** `engine.worker.js` (and `engine.worker.bwip.js`) in `@reportwright/viewer` and the embed builds are minified, still one file with no chunk imports, with a linked source map (`engine.worker.js.map`) beside it so worker stack traces stay readable. `engine.worker.js` 2,195,290 → 1,218,659 bytes (608 → 503 KB gzipped); `engine.worker.bwip.js` 1,651,602 → 973,261 bytes (315 → 267 KB gzipped). The size budget in tests/engine/b10-bundle-size.test.js is now 504 KB gzipped (was 600).
+- **Publishing verifies before `latest` moves.** The publish workflow publishes to the `next` dist-tag, installs all nine packages from the registry and smoke-tests them (imports, PDF/XLSX/DOCX export, `qpdf --check`, `pw render`, the viewer's files, the wrappers' peer), and only then moves `latest`.
+
+### Performance
+- **Trade-off made by 0.13.1: less memory, about 10–14% slower.** The 0.13.1 fixes for grouped sorts (N44: sort runs spill to disk in smaller runs, about 8 MB) and for streamed tagged PDFs (N44: tagged structure flushed per page) cost time for the memory they save: about 10–14% slower on the tester's 2 vCPU machine (not measured here). Memory: a 200,000-row grouped ledger peaks at 232 MB instead of 280 MB, and the same with 50 runs (1,000,000 rows' run count) 240 MB instead of 296 MB; a tagged streamed PDF at 50k/100k/200k rows holds 6.7/7.3/9.3 MB off-heap instead of 16.8/29.1/36.6 MB. `spillSorter({ runMB, mergeMB })` sets the sort's run size if speed matters more than memory.
+### Added
+- **`pw import <folder>`: bulk import.** Every `.rdl`, `.rdlc`, `.jrxml`, `.rptdesign` and `.rdlx-json` report in a folder (`--recursive` for subfolders) is imported into `-o <outDir>`, which mirrors the folder.
+  - One bad file never stops the batch. Exit 0 means all were imported, 2 some failed, 1 none.
+  - Subreports, SSRS shared data sources (`.rds`), JasperReports style templates (`.jrtx`) and images are resolved across the batch. Images are copied once per content. Unresolved references are listed per file.
+  - `import-report.json` and a standalone, escaped `import-report.html` give for each file the mapped, approximated and dropped counts, each item's reason, and every expression that was not translated with its line and column.
+  - `.pw-import.json` holds the hash of each written file, and a re-run skips an output the user edited unless `--force`.
+  - `--verify` renders each report with its embedded or sample data and compares it with the output it replaced.
+  - Paths from the folder are untrusted. Links that point outside it are refused, outputs stay in `outDir`, and `--max-files` and `--max-bytes` cap the input.
+  - The importers now return structured `items` (each item's notes, untranslated expressions and source position) and take a `resolve` option for shared data sources and style templates.
+  - Docs: the CLI README, "Bulk import". Test: tests/engine/c132-import-batch.test.js.
+- **`pw --version` / `pw -v`** prints the CLI version (from its package.json) and the version of the engine it carries.
+- **`showWarnings`** (viewer option, default `false`): shows the render's warnings under the pages; the designer's Preview always shows them. Documented in the viewer README and typed in `ViewerOptions`.
+- **ⓘ help tooltips in the designer.** Long help paragraphs (the Outline, Layers and Parts panels, field hints over 90 characters) sit behind an ⓘ button that opens on hover, keyboard focus or click and closes with Esc; the button is described by the text (`aria-describedby`).
+### Fixed
+- **An unchecked check box has no tick on the designer canvas.** The canvas drew ✓ in every check box; it now follows the value as the renderer does (`false`, `=False`, a missing value: empty), and dims the tick of a value only the data decides.
+- **Selecting an item no longer moves the canvas.** The canvas toolbar grew a second row (24 px) when the align buttons of a selection appeared; it now has one fixed height (it scrolls sideways when narrow) and its hint moved to the status bar.
+- **Keyboard nudge steps.** Arrow moves the selection 1 pt, or one grid step with Snap to grid on (a cell in cell mode); Shift+Arrow moves ten of them (it was 4 grid steps); positions stay rounded to 2 decimals.
+- **Render warnings in the viewer read as words.** The count says "8 warnings" or "1 warning", not "warning(s)".
+- **The Data panel lists a data set's fields when it declares none.** It said "No fields" next to 300 rows; it now detects them from inline JSON or the first rows of fetched data with the engine's own detection (`detectFields`, the one streaming uses) and marks them as detected.
+- **No cut-off text in the Inspector and the Outline.** The Regional "Division by zero" choice gets the full width ("Infinity (as SSRS)" was cut); a long name in the Outline wraps inside the panel, with the full name as its tooltip, and the item type and buttons move under it together.
+- **The parameter dialog's help matches the viewer.** The live-parameters option no longer says that turning it off adds a View report button (the button is always there), and the panel-columns help says the grid applies on a wide screen.
+- **Export options icon.** The sun-like gear is a sliders icon; the button keeps its name, Export options.
+
 ## 0.13.1 — 2026-10-09
 
 ### Fixed

package/README.md

@@ -1,17 +1,97 @@
 # @reportwright/react
 
+The ReportWright report viewer and drag-and-drop designer as React components.
+
 [![npm](https://img.shields.io/npm/v/%40reportwright%2Freact)](https://www.npmjs.com/package/@reportwright/react) [![license](https://img.shields.io/badge/license-MIT-blue)](https://github.com/MrArun005/reportwright/blob/main/LICENSE) [![Socket](https://socket.dev/api/badge/npm/package/@reportwright/react)](https://socket.dev/npm/package/@reportwright/react)
 
-The ReportWright viewer and designer as React components. React is a peer dependency; the viewer loads on mount, so it is safe in server-rendered apps (Next.js, Remix).
+**Live demo:** [mrarun005.github.io/reportwright-demo](https://mrarun005.github.io/reportwright-demo) ([Embed it](https://mrarun005.github.io/reportwright-demo/#embed) shows the wrapper code; the [designer playground](https://mrarun005.github.io/reportwright-demo/play.html) is the designer this package mounts).
+
+React is a peer dependency, and the components use your app's React (through `@reportwright/viewer/react-peer`), so the page loads React once. The viewer loads on mount, so it is safe in server-rendered apps (Next.js, Remix).
+
+## Install
+
+```bash
+npm i @reportwright/react @reportwright/viewer @reportwright/fonts
+cp -r node_modules/@reportwright/fonts/public public/pw     # serve the fonts as static files
+```
+
+Vite 7: set `worker: { format: 'es' }` in `vite.config.js` (see [`@reportwright/viewer`'s bundler setup](https://github.com/MrArun005/reportwright/tree/main/packages/viewer#bundler-setup-read-this-first)).
+
+## Quick start (30 seconds)
 
 ```jsx
-import { ReportWrightViewer, ReportWrightDesigner } from '@reportwright/react';
+import { createRoot } from 'react-dom/client';
+import { ReportWrightViewer } from '@reportwright/react';
+import definition from './orders.pw.json';   // the report from @reportwright/engine's README examples
+
+const orders = { rows: [{ customer: 'Asha Rao', amount: 1200.5 }, { customer: 'Ben Ode', amount: 80 }] };
+
+createRoot(document.getElementById('app')).render(
+  <ReportWrightViewer definition={definition} data={{ orders }} fontsUrl="/pw/fonts/" style={{ height: 720 }} />,
+);
+```
+
+Verified against this version with Vite 7 and React 18 in Chromium.
+
+## Examples
+
+**Control the viewer through a ref** (the ref gets the same `ViewerHandle` as `onReady`):
+
+```jsx
+import { useRef } from 'react';
+
+function Orders({ minAmount }) {
+  const viewer = useRef(null);
+  return (
+    <>
+      <button onClick={() => viewer.current?.setParameters({ minAmount })}>Apply</button>
+      <button onClick={async () => open(URL.createObjectURL(await viewer.current.export('xlsx')))}>Excel</button>
+      <ReportWrightViewer ref={viewer} definition={definition} data={{ orders }} fontsUrl="/pw/fonts/"
+        onReady={(h) => h.on('ready', ({ pages }) => console.log(pages, 'pages'))} onError={console.error} style={{ height: 720 }} />
+    </>
+  );
+}
+```
 
-<ReportWrightViewer definition={def} data={{ orders }} fontsUrl="/pw/fonts/" style={{ height: 720 }} />   {/* no server */}
+**Edit a report and save it to your own API:**
+
+```jsx
+import { ReportWrightDesigner } from '@reportwright/react';
+
+<ReportWrightDesigner definition={definition} fontsUrl="/pw/fonts/" toolbox={{ hide: ['map'] }} style={{ height: 760 }}
+  onSave={(def) => fetch('/api/reports/orders', { method: 'PUT', body: JSON.stringify(def) })} />
+```
+
+**With a self-hosted ReportWright server** (saved reports, SQL sources):
+
+```jsx
 <ReportWrightViewer server="https://reports.example.com" report="invoice" params={{ id: '42' }} style={{ height: 720 }} />
 <ReportWrightDesigner server="https://reports.example.com" definition={def} onSave={(d) => save(d)} toolbox={{ hide: ['map'] }} />
 ```
 
-Props are the options of `mountViewer` / `mountDesigner` (see `@reportwright/viewer`), plus `className`, `style` and `onReady(handle)`. A `ref` gets the same `ViewerHandle` as `onReady` (`setParameters`, `goToPage`, `export`, `on`, …; see `@reportwright/viewer`), so `const viewer = useRef(null)` … `<ReportWrightViewer ref={viewer} … />` then `viewer.current?.setParameters({ id: '7' })`. The viewer remounts when what it shows changes (compared by content, so inline objects are fine); the designer only for another `report` or a `definition` with different content, so it keeps its edits. If the viewer's code fails to load, the element shows the error and `onError(error)` is called. MIT.
+A runnable app is in the repository's [`examples/react`](https://github.com/MrArun005/reportwright/tree/main/examples/react).
+
+## Props
+
+Props are the options of `mountViewer` / `mountDesigner` (full table in [`@reportwright/viewer`](https://github.com/MrArun005/reportwright/tree/main/packages/viewer#options-reference)), plus:
+
+| Prop | Component | Meaning |
+|---|---|---|
+| `className`, `style` | both | on the host element |
+| `onReady(handle)` | both | the `ViewerHandle` / `DesignerHandle` (the viewer's own `onReady(error)` is not passed through) |
+| `onError(error)` | both | the viewer's code did not load (the element shows the message) |
+| `ref` | viewer | the `ViewerHandle` (`setParameters`, `setDefinition`, `goToPage`, `getPageCount`, `print`, `export`, `on`, `unmount`); `null` after unmount |
+
+The viewer remounts when what it shows changes (compared by content, so inline objects are fine); the designer only for another `report` or a `definition` with different content, so it keeps its edits. Types: `ReportWrightViewerProps`, `ReportWrightDesignerProps`.
+
+## Support
+
+React 18 or later (`react`, `react-dom` peers). Browsers and limits are the viewer's: see [`@reportwright/viewer`](https://github.com/MrArun005/reportwright/tree/main/packages/viewer#browser-support-and-limits).
 
 No server needed: pass `definition`, `data` (JSON by data source name) and `fontsUrl` (a copy of `@reportwright/fonts/public/fonts`). `server` (the [self-hosted ReportWright server](https://github.com/MrArun005/reportwright#docker)) is optional: see [what works standalone](https://github.com/MrArun005/reportwright/tree/main/packages/viewer#what-works-standalone-what-needs-the-server).
+
+## Related packages
+
+[`@reportwright/viewer`](https://github.com/MrArun005/reportwright/tree/main/packages/viewer) (what this wraps), [`@reportwright/engine`](https://github.com/MrArun005/reportwright/tree/main/packages/engine) (render the same reports in Node), [`@reportwright/fonts`](https://github.com/MrArun005/reportwright/tree/main/packages/fonts), and the [`vue`](https://github.com/MrArun005/reportwright/tree/main/packages/vue), [`svelte`](https://github.com/MrArun005/reportwright/tree/main/packages/svelte) and [`angular`](https://github.com/MrArun005/reportwright/tree/main/packages/angular) wrappers.
+
+MIT.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reportwright/react",
-  "version": "0.13.1",
+  "version": "0.13.2-rc.2",
   "publishConfig": {
     "access": "public"
   },
@@ -47,6 +47,6 @@
   "peerDependencies": {
     "react": ">=18",
     "react-dom": ">=18",
-    "@reportwright/viewer": "0.13.1"
+    "@reportwright/viewer": "0.13.2-rc.2"
   }
 }