@justybase/spreadsheet-tasks 1.3.3 → 2.0.0

package/CHANGELOG.md

@@ -0,0 +1,38 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [2.0.0] - 2026-07-25
+
+### Breaking
+
+- `XlsbReader.read()` is now `async` and returns `Promise<boolean>` (same as `XlsxReader`).
+  Update loops from `while (reader.read())` to `while (await reader.read())`.
+- Package entry points moved under `dist/cjs` and `dist/esm` with an `exports` map.
+  Most consumers of `@justybase/spreadsheet-tasks` need no import path changes.
+
+### Added
+
+- `CellValue` / `PrimitiveCellValue` types for writer and reader cell APIs
+- Shared writer helpers: `sanitizeSheetName`, column-width helpers, `StreamingSheetState`
+- Dual package build (CJS + ESM) via `tsup`
+- Browser sources under `src/browser/` with `npm run build:browser`
+- `docs/PACKAGING.md` (ZIP library rationale + dual package notes)
+- Dist surface smoke test (`npm run test:dist`)
+
+### Changed
+
+- `XlsbWriter` / `XlsxWriter` share sanitization, autofit, and streaming state helpers
+- Tests import from `src/` (published surface still verified via `test:dist`)
+- ZIP type definitions use `@types/*` only (hand-written ambient modules removed)
+
+### Browser
+
+- Source of truth is TypeScript in `src/browser/`; `browser/*.js` writer sources are generated bundles
+
+## [1.3.2] - previous
+
+See git history for 1.x changes.

package/README.md

@@ -24,37 +24,44 @@ A high-performance TypeScript library for reading and writing Excel files in XLS
 | Read (50K rows) | 118 ms | 276 ms | **2.3x faster** |
 | File Size | 1.49 MB | 2.83 MB | **47% smaller** |
 
-## 📦 Installation
+## Installation
 
 ```bash
 npm install @justybase/spreadsheet-tasks
 ```
 
-## 🌐 Browser Support & CDN (Zero Dependencies)
+CJS and ESM are both supported:
 
-This library includes browser-compatible modules to generate XLSB and XLSX files directly on the client side without relying on Node.js APIs or external dependencies.
+```js
+const { XlsbWriter } = require('@justybase/spreadsheet-tasks');
+import { XlsbWriter } from '@justybase/spreadsheet-tasks';
+```
 
-To bundle the browser version into a single minified file (e.g. for deployment to a CDN), run the following command in the project root:
+## Browser Support & CDN (Zero Dependencies)
+
+Browser writers live in TypeScript under `src/browser/` and are bundled with:
 
 ```bash
-npx esbuild browser/browser-spreadsheet.js --bundle --minify --format=esm --outfile=browser/justybase-spreadsheet.min.js
+npm run build:browser
 ```
 
-You can then import this single file via a script tag in any web application:
+This produces:
+
+- `browser/justybase-spreadsheet.min.js` — IIFE (`JustybaseSpreadsheet` global)
+- `browser/browser-spreadsheet.js` — ESM for local demos (`demo.html`, `test.html`)
 
 ```html
 <script type="module">
-  import { downloadXlsb, downloadXlsx } from 'https://your-cdn.com/justybase-spreadsheet.min.js';
-  
-  const headers = ["ID", "Name", "Score"];
+  import { downloadXlsb, downloadXlsx, F } from './browser-spreadsheet.js';
+
+  const headers = ['ID', 'Name', 'Score'];
   const rows = [
-    [1, "Alice", 99.5],
-    [2, "Bob", 88.0]
+    [1, 'Alice', 99.5],
+    [2, 'Bob', 88.0],
   ];
-  
-  // Generates the file and triggers the browser download automatically
+
   document.getElementById('downloadBtn').addEventListener('click', () => {
-    downloadXlsb('report.xlsb', rows, headers, { headerStyle: 'bold+fill' });
+    downloadXlsb('report.xlsb', rows, headers);
   });
 </script>
 ```
@@ -66,7 +73,9 @@ You can then import this single file via a script tag in any web application:
 - Frozen and styled headers (styles: `bold`, `fill`, `bold+fill`)
 - Auto-filters enabled by default
 
-## 🔧 Quick Start
+See [CHANGELOG.md](./CHANGELOG.md) for v2 breaking changes (`await reader.read()`).
+
+## Quick Start
 
 ### Writing Excel Files
 
@@ -148,7 +157,7 @@ await reader.open('data.xlsb');
 
 console.log('Sheet names:', reader.getSheetNames());
 
-while (reader.read()) {
+while (await reader.read()) {
     const row = [];
     for (let i = 0; i < reader.fieldCount; i++) {
         row.push(reader.getValue(i));