Skip to content

RDE-R1: release react-data-export 1.0.0-alpha.1 - #195

Merged
securedeveloper merged 3 commits into
mainfrom
rde-r1-release-alpha.1
Nov 16, 2026
Merged

securedeveloper merged 3 commits into
mainfrom
rde-r1-release-alpha.1

Conversation

@securedeveloper

@securedeveloper securedeveloper commented Nov 16, 2026 •

Copy link
Copy Markdown
Owner

Summary

RDE-R1: the release PR for react-data-export 1.0.0-alpha.1, the first 1.0 prerelease: dataset export, table export, and the CSV StrictMode fix, on javascript-excel 2.0, with the migration guide.

Merging this publishes react-data-export@1.0.0-alpha.1 to npm with dist-tag next; latest stays 0.6.0. Before merging, register the trusted publisher for react-data-export on npmjs.com (Settings → Trusted publishing → GitHub Actions):

  • owner securedeveloper
  • repository react-data-export
  • workflow release.yml
  • environment npm

Do it on the day of the merge, since an unused config expires after 2 days.

Release recipe (re-cut from scratch, no hand edits)

  1. git reset --hard origin/main at 83a33c7. That includes RDE-1.18: playground (dataset editor, live preview, <ExcelExport> and useExcelExport) #196 (playground with the Table tab), RDE-1.12: migration guide from 0.6 to 1.0 #197 (migration guide), RDE-1.9.1: CSV exports started on mount download once under StrictMode #198 (CSV fix) and RDE-1.11.1: table exports in the bundler fixtures #199 (bundler fixtures).
  2. Added the approved community credit lines (docs/triage-1.0.md, RDE-1.13: issue and PR triage for 1.0 (done) #200) as a patch changeset in its own commit (16c93eb), so the changelog entry carries a hash.
  3. npx changeset pre enter alpha.
  4. npm run version-packages:
    packages/react-data-export/src/index.ts: version constant 1.0.0-alpha.0 -> 1.0.0-alpha.1
    
    The version is exactly 1.0.0-alpha.1 (Changesets), and the version export is synced (scripts/sync-version.mjs).
  5. A separate docs commit (67282ae) updates the READMEs.
file change (release commit c9fb174)
packages/react-data-export/package.json version → 1.0.0-alpha.1
packages/react-data-export/src/index.ts export const version = '1.0.0-alpha.1'
packages/react-data-export/CHANGELOG.md new, see below. The root CHANGELOG.md (0.x history) is untouched.
apps/playground/package.json react-data-export → 1.0.0-alpha.1 (the exact pin, in sync)
package-lock.json workspace entries → 1.0.0-alpha.1 (fresh npm ci clean)
.changeset/pre.json new, {"mode":"pre","tag":"alpha"}
.changeset/*.md → .changeset/pre/*.md the 4 consumed changesets (Changesets 3's pre-mode layout)

CHANGELOG

# react-data-export

## 1.0.0-alpha.1

### Minor Changes

- 05a07db: Add the 1.0 dataset module, built on javascript-excel 2.0:
  - `exportDataset(dataset, options)` and `exportWorkbook({ sheets, activeSheet }, options)` build sheets with javascript-excel's `fromDataset`/`fromDatasets`, write `.xlsx` (`toBlob`) or `.csv` (`toCsvBlob`) and download through `javascript-excel/dom`. They resolve with `{ blob, filename, format, warnings }`. Falsy sheets are skipped, `download: false` only builds the file, and `signal`/`onProgress` are supported.
  - `useExcelExport(defaults)` adds `status`, `progress`, `error` and `result`, stable functions, `abort()`, and aborts running exports on unmount (StrictMode-safe).
  - `<ExcelExport dataset | workbook>` renders a default button or a render prop with a `run()` that never rejects, and reports through `onExported`/`onError`.
  - The entry is marked `"use client"`. The dataset, column, style and option types are javascript-excel's own, re-exported (`Dataset`, `ColumnDef`, `LeafColumn`, `GroupColumn`, `DatasetBlock`, `DatasetOptions`, `Style`, `CellInput`, `WriteOptions`, `CsvWriteOptions`, `Progress`, `ExcelWarning`, `DocProperties`), along with `isExcelError` and `sanitizeSheetName`.
  
  The scaffold placeholder `useVersion` is removed.
- e4e9492: Add table export, built on javascript-excel 2.0's `fromTable`:
  - `exportTable(tableOrRef, options)` reads an HTML `<table>` (an element, or a ref read when called). `colspan`/`rowspan` become merges, `<thead>` rows become headers, hidden and `[data-export-ignore]` rows are skipped, and `data-*` hints are honoured. It exports `.xlsx` or `.csv` with the same options and the same `{ blob, filename, format, warnings }` result as `exportDataset`. `fromTable` options pass through unchanged.
  - `useTableExport(ref, defaults)` and `<ExportTableButton tableRef>` share the state, abort, unmount and trigger behaviour of `useExcelExport` and `<ExcelExport>`.
  - An empty ref rejects with a `TypeError` before anything is built. `FromTableOptions`, `TableElement` and `TableCellElement` are re-exported.

### Patch Changes

- 16c93eb: Thanks to the community pull requests whose ideas shaped 1.0:
  - #143 by @samuelhulla: correct the `ExcelCell` typing (#141).
  - #161 by @atefBB: document the real `alignment.horizontal` values.
  - #165 by @mehmetyilmaz001: nested object access in columns (`user.name`, #164).
  - #167 by @apperside: a callback after the file is generated.
  - #171 by @xaviergeorge: fix the `ExcelCell` value type (#141).
  - #174 by @tobwithu: make the types work with React + TypeScript.
  - #176 by @saeedkhal: skip falsy (conditional) columns.
  - #180 by @imsuvesh: ship the type declarations where npm resolves them (#179, #146, #64).
- de3f774: CSV exports started on mount under React 18/19 StrictMode no longer download twice. `toCsvBlob` is synchronous, so a CSV export (build, write, download) used to finish inside the first effect run, before StrictMode's simulated unmount could abort it. Every export (`exportDataset`, `exportWorkbook`, `exportTable`, and the hooks and components built on them) now yields once and re-checks its signal before building. xlsx exports were not affected.

Both modules (minor), plus the #198 CSV StrictMode patch and the community credits for the 8 pull requests (#143 #161 #165 #167 #171 #174 #176 #180). The credits are a patch changeset, so the version stays exactly 1.0.0-alpha.1. The handles above are inside a code block here, so this PR notifies nobody; contributors are thanked in the approved comments after the publish.

READMEs (docs commit 67282ae)

  • Root README:
    • "1.0 prereleases are on npm's next tag: npm install react-data-export@next", listing both modules, saying the API may still change before 1.0.0, and linking the migration guide
    • "0.6.x stays on npm unchanged, and latest is still 0.6.0", so a plain install keeps getting 0.6.0
    • the legacy docs remain at the v0.6.0 tag
    • RDE-1.12: migration guide from 0.6 to 1.0 #197's "Migrating from 0.x" section is unchanged
  • Package README (the npm page): a 1.0 prerelease (@next) and clean break, with a direct link to docs/migration.md; latest stays 0.6.0, with the v0.6.0 docs link; a dataset + table example; and a link to docs/api.md.
  • There's no "coming" or "not yet" wording left. Both READMEs are version-neutral, so the next alpha needs no README edit. npm run docs:check reports "ok 10 example blocks match their files".

Release dry run (CI on this PR)

From Release dry run (run 43871284235, job 133312831829):

ℹ tests 49
ℹ pass 49
npm 11.19.1; react-data-export: HEAD 1.0.0-alpha.1, HEAD~1 1.0.0-alpha.0, npm (not published)
release: 1.0.0-alpha.0 -> 1.0.0-alpha.1, not on npm yet: publish with --tag next
+ react-data-export@1.0.0-alpha.1

Version changed 1.0.0-alpha.0 → 1.0.0-alpha.1, not on npm, so it would publish with --tag next. Manual recovery is open for this version (the ## 1.0.0-alpha.1 section exists): release: manual run: 1.0.0-alpha.1 not on npm yet: publish with --tag next.

npm pack --dry-run (built package)

Tarball Contents
1.1kB LICENSE
1.7kB README.md
12.0kB dist/index.cjs
6.9kB dist/index.d.cts
6.9kB dist/index.d.ts
11.2kB dist/index.js
1.8kB package.json
Tarball Details
name: react-data-export
version: 1.0.0-alpha.1
filename: react-data-export-1.0.0-alpha.1.tgz
package size: 8.0 kB
unpacked size: 41.6 kB
total files: 7

Verification

  • Local, from a clean npm ci (Node 24.18; javascript-excel 2.0.0-alpha.2 from npm), all passing:
    • docs:check
    • typecheck (library + playground + docs examples)
    • tests (64 passed, 1 skipped: the React-major guard)
    • playground tests (10 passed) and the playground build
    • build
    • lint:pkg (publint "All good!", attw "No problems found")
    • smoke (esm ok 1.0.0-alpha.1 export.xlsx 3954 bytes, cjs ok 1.0.0-alpha.1 export.csv 9 bytes, types ok)
  • CI on this PR: 34/34 pass: Node 22/24 / React 17/18/19, Consumer TS (+ cells), Bundlers, Pack and Release dry run.

On merge

The Release job:

  1. verifies
  2. runs npm publish ./packages/react-data-export --tag next, with provenance
  3. creates the v1.0.0-alpha.1 tag and a prerelease GitHub Release with the CHANGELOG notes

If the push run fails before publishing, run gh workflow run release.yml --ref main.

@securedeveloper securedeveloper changed the title RDE-R1: release react-data-export 1.0.0-alpha.1 (hold) RDE-R1: release react-data-export 1.0.0-alpha.1 Nov 16, 2026
…angelog

The credit lines approved in the 1.0 triage plan (docs/triage-1.0.md,
#200). A patch changeset, so the version stays 1.0.0-alpha.1.
Enter Changesets pre mode (alpha) and run `npm run version-packages`:
1.0.0-alpha.0 -> 1.0.0-alpha.1. Consumes the dataset-module and
table-module changesets (minor), the CSV StrictMode fix and the
community credits (patch) into packages/react-data-export/CHANGELOG.md
(kept under .changeset/pre/ while in pre mode); the version constant
was synced by scripts/sync-version.mjs and the playground's exact pin
bumped. No hand edits. The root CHANGELOG.md (0.x history) is untouched.

Merging this publishes 1.0.0-alpha.1 to npm with dist-tag next;
latest stays 0.6.0.
@securedeveloper
securedeveloper merged commit 12d2cbf into main Nov 16, 2026
34 checks passed
@securedeveloper
securedeveloper deleted the rde-r1-release-alpha.1 branch November 16, 2026 13:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant