@sheetpane/review 0.0.0-stage → 0.4.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Arpit Arya
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,126 @@
-# Temporary Holding Version
+# @sheetpane/review
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+**The review written into the download as a sheet of its own. Every error is listed on a *Review* sheet with a link to its cell. Optionally, each flagged cell is filled by severity, so a reviewer can work the list in Excel, fix the file and upload it again.**
+
+A plugin for `@sheetpane/grid`. It uses one hook, `exportPatch`, on the
+in-memory workbook, so it works for `<sheetpane-excel>` and for a store with
+no page. `@sheetpane/grid` is a peer and `@sheetpane/export` is a dependency.
+Versioned in lockstep with them. There is no `/ui` entry: the plugin adds two
+items to the Download menu and nothing else. Everything is written into the
+bytes the browser saves. Nothing is sent anywhere (SR-LAW-11).
+
+## Use
+
+```html
+<script type="module">
+  import '@sheetpane/grid';
+  import '@sheetpane/review'; // registers "review"
+</script>
+
+<sheetpane-excel pane="q3" plugins="review" src="/files/holdings.xlsx" mode="edit" author="Arpit"></sheetpane-excel>
+<sheetpane-errors pane="q3"></sheetpane-errors>
+```
+
+The Download menu gains **Add a Review sheet** (on by default) and **Colour
+flagged cells** (off by default). Each one applies to the next download.
+
+Without a page:
+
+```ts
+import { createWorkbook } from '@sheetpane/grid';
+import { review } from '@sheetpane/review';
+
+const plugin = review({ fill: true });           // colour flagged cells by default
+const store = createWorkbook({ plugins: [plugin] });
+await store.load(bytes, 'holdings.xlsx');
+const { blob } = await store.exportFile();        // the file, plus a Review sheet
+plugin.lastExport;                                // { sheet, listed, counts, filled, skipped }
+```
+
+## Options
+
+| option | default | what |
+|---|---|---|
+| `sheet` | `true` | Add the Review sheet. `export({ review: false })` leaves it out of one export. |
+| `fill` | `false` | Colour each flagged cell. `export({ reviewFills: true })` colours one export. |
+| `sheetName` | `'Review'` | The sheet's name. Characters Excel forbids are dropped, and the name is cut to 31 characters. |
+| `severities` | `['error', 'warning', 'note']` | The severities listed and coloured. Results such as `pass` and `skipped` are written only when you name them. `export({ reviewSeverities })` overrides it for one export. |
+| `layers` | every layer but `compare` | The layers listed and coloured. An error with no `layer` belongs to `review`. `@sheetpane/compare`'s `compare` layer is a comparison, not the review: it is listed only when named, as `@sheetpane/comments` writes it. `export({ reviewLayers })` overrides it for one export. |
+| `fills` | pale red, yellow, blue | A fill per severity, as `#RRGGBB`, `RRGGBB` or ARGB. `null` turns a severity's fill off. A value that is not a colour throws SP-5005. |
+
+## The Review sheet
+
+One row per error, below a header row that stays frozen. The workbook's own
+errors come first. Then, for each sheet in the file's order, its whole-sheet
+errors, then its cells from top to bottom and left to right.
+
+| column | value |
+|---|---|
+| ID | `ERR-0003` |
+| Sheet | the sheet's name; empty for an error about the workbook |
+| Cell | `I6` or `A14:J14`, as a link that opens the cell in Excel. A whole-sheet error reads *Whole sheet* and links to its A1. A workbook error reads *Whole workbook* and has no link. |
+| Severity · Type | `Error` · `Wrong value` |
+| Found · Expected · Message · Author | as in the review |
+| Status | `Open`, `Resolved` or `Accepted` |
+| Accepted · Accepted by · Accepted at | for an accepted error: *Accepted: \<reason\>*, who accepted it and when (UTC) |
+
+- **A user's own sheet is never overwritten.** If the file already has a
+  sheet called *Review* (in any case), the new one is *Review (2)*.
+- **The file's own comments are not listed.** These are errors with `author:
+  'file'`, which came from the file in the first place.
+- **Every cell is an inline string.** `sharedStrings.xml` is never touched,
+  and the links are internal hyperlinks, which need no relationship.
+- **No font is written** (SR-LAW-5). The header row is marked with a grey
+  fill instead of bold text.
+
+## Uploading an annotated file again
+
+A hidden, workbook-scoped defined name, `_sheetpane_review`, marks the sheet.
+`reviewSheetOf(book)` reads that name, so a host can leave the sheet out:
+
+```ts
+import { read } from '@sheetpane/import';
+import { reviewSheetOf } from '@sheetpane/review';
+
+const book = await read(bytes, { name: 'holdings.xlsx' });
+const skip = reviewSheetOf(book);                  // 'Review', or undefined
+const data = book.sheets.filter((s) => s.name !== skip);
+```
+
+When a file that already has a Review sheet is exported again, the plugin
+rewrites that sheet in place rather than adding a second one. There is one
+exception: if someone gave the sheet parts of its own in Excel, such as
+comments or a drawing, it is left alone and a new sheet is added.
+
+## Colouring flagged cells
+
+Each **open** error at a cell has its cells filled by severity. **Accepted**
+and **resolved** errors are not problems, so they are never filled.
+Whole-sheet and workbook errors are listed but not coloured. They appear in
+`lastExport.skipped` as `no-cell`.
+
+- **The cell's own format stays.** Its `xf` is cloned with a solid fill and
+  the cell points at the clone, so the number format, font, borders and
+  alignment are kept. One clone is made per format and colour. Existing
+  formats and fills are never edited, only added to.
+- **Nothing else changes.** Only the `s` of a flagged cell is written. Every
+  other row and cell keeps its exact bytes. A flagged cell the file does not
+  have is added empty, styled from its row or column.
+- **Two errors on one cell:** the worse severity's fill wins.
+- **A range over 10,000 cells** colours only the cells the file already has
+  in it (`range-capped`, SP-5003).
+- **No styles part:** nothing is coloured (`no-styles`, SP-5004), and the
+  sheet is still written.
+
+## What it does not do
+
+- It writes into an `.xlsx` download of an `.xlsx`. A CSV, or a CSV converted
+  to `.xlsx`, carries no plugin parts.
+- An empty review writes nothing.
+- Whether Excel opens the file without a repair prompt and follows each link
+  to its cell is checked by the decider on real Excel (W-30). These tests
+  check the parts sheetpane writes and reads, not Excel itself.
+
+Spec: [SR-REVIEW](../../records/0123_REVIEW.md). MIT.
+
+**Using an AI coding agent?** `npx sheetpane-skills install` puts sheetpane's skills for Claude Code, Kiro and Codex into your repository.

package/dist/fills.d.ts

@@ -0,0 +1,64 @@
+import { type RangePos } from '@sheetpane/export';
+/** The fill each problem severity gets by default (ARGB): Excel's *Bad*, *Neutral* and a pale blue. */
+export declare const DEFAULT_FILLS: Readonly<Record<string, string>>;
+/** The Review sheet's header fill (ARGB): a light grey. No font is written (SR-LAW-5). */
+export declare const HEADER_FILL = "FFD9D9D9";
+/** An error's range larger than this many cells colours only the cells the file already has in it (SP-5003). */
+export declare const MAX_FILL_CELLS = 10000;
+/**
+ * A colour as ARGB: `#C00000`, `C00000` or `FFC00000` → `FFC00000`.
+ *
+ * @param c - The colour.
+ * @returns The ARGB form, or undefined when it is not a hex colour.
+ */
+export declare function argb(c: string): string | undefined;
+/** The workbook's style tables, extended in memory: fills and cell formats are only ever appended. */
+export declare class StyleBook {
+    private readonly xml;
+    private readonly P;
+    private readonly xfs;
+    private readonly fillCount;
+    private readonly newFills;
+    private readonly newXfs;
+    private readonly fillOf;
+    private readonly xfOf;
+    constructor(xml: string);
+    /** Whether anything was added. */
+    get changed(): boolean;
+    /** The id of a solid fill in this colour, added once. */
+    fill(color: string): number;
+    /**
+     * A cell format that is format `s` with a solid fill — cloned once per format and colour.
+     *
+     * @param s - The cell's style index (a missing or unknown one is format 0).
+     * @param color - ARGB.
+     * @returns The new format's index.
+     */
+    clone(s: number, color: string): number;
+    /** The styles part with the new fills and formats appended and the counts set. */
+    toXml(): string;
+}
+/** What to colour on one sheet: whole cells by zero-based row and column, and ranges too large to fill whole. */
+export interface FillPlan {
+    /** row → column → severity. */
+    cells: Map<number, Map<number, string>>;
+    /** Over {@link MAX_FILL_CELLS}: only the cells the file has inside are coloured. */
+    wide: {
+        range: RangePos;
+        severity: string;
+    }[];
+}
+/** Adds a range to a plan; the worse severity wins on a cell. Returns false when the range was too large to fill whole. */
+export declare function planRange(plan: FillPlan, r: RangePos, severity: string, rank: (s: string) => number): boolean;
+/**
+ * Colours one sheet's flagged cells. Rows and cells not flagged are copied unchanged; a flagged cell keeps everything
+ * but its `s`; a flagged cell the file lacks is added empty, styled from its row (when `customFormat`) or column.
+ *
+ * @param xml - The worksheet part.
+ * @param plan - What to colour.
+ * @param rank - A severity's rank: lower is worse, and wins on a cell.
+ * @param styleFor - The style index for a cell of style `s` coloured for `severity`.
+ * @returns The worksheet part, coloured.
+ */
+export declare function fillSheet(xml: string, plan: FillPlan, rank: (s: string) => number, styleFor: (s: number, severity: string) => number): string;
+//# sourceMappingURL=fills.d.ts.map

package/dist/fills.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fills.d.ts","sourceRoot":"","sources":["../src/fills.ts"],"names":[],"mappings":"AAKA,OAAO,EAAkD,KAAK,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAGlG,uGAAuG;AACvG,eAAO,MAAM,aAAa,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAgE,CAAC;AAE5H,0FAA0F;AAC1F,eAAO,MAAM,WAAW,aAAa,CAAC;AAEtC,gHAAgH;AAChH,eAAO,MAAM,cAAc,QAAS,CAAC;AAErC;;;;;GAKG;AACH,wBAAgB,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAGlD;AAID,sGAAsG;AACtG,qBAAa,SAAS;IASR,OAAO,CAAC,QAAQ,CAAC,GAAG;IARhC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAS;IAC3B,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAW;IAC/B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAgB;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAgB;IACvC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA6B;IACpD,OAAO,CAAC,QAAQ,CAAC,IAAI,CAA6B;IAElD,YAA6B,GAAG,EAAE,MAAM,EAOvC;IAED,kCAAkC;IAClC,IAAI,OAAO,IAAI,OAAO,CAAmC;IAEzD,yDAAyD;IACzD,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAS1B;IAED;;;;;;OAMG;IACH,KAAK,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAWtC;IAED,kFAAkF;IAClF,KAAK,IAAI,MAAM,CAmBd;CACF;AAED,iHAAiH;AACjH,MAAM,WAAW,QAAQ;IACvB,+BAA+B;IAC/B,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACxC,oFAAoF;IACpF,IAAI,EAAE;QAAE,KAAK,EAAE,QAAQ,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CAC/C;AAED,2HAA2H;AAC3H,wBAAgB,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,MAAM,GAAG,OAAO,CAO7G;AAYD;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,MAAM,GAAG,MAAM,CAiF7I"}

package/dist/fills.js

@@ -0,0 +1,233 @@
+// Colouring flagged cells (W-59 DoD 3). Each flagged cell's own style (`xf`) is
+// cloned with a solid fill and the cell points at the clone, so its number
+// format, font, borders and alignment stay. Only the `s` of a flagged <c> is
+// changed (or a styled empty <c> added where the file has none); every other row
+// and cell is copied as the file has it, byte for byte.
+import { cellRef, getAttr, parseRange, setAttr, spError } from '@sheetpane/export';
+import { elementRe, openTag, prefixOf } from './xml.js';
+/** The fill each problem severity gets by default (ARGB): Excel's *Bad*, *Neutral* and a pale blue. */
+export const DEFAULT_FILLS = { error: 'FFFFC7CE', warning: 'FFFFEB9C', note: 'FFDDEBF7' };
+/** The Review sheet's header fill (ARGB): a light grey. No font is written (SR-LAW-5). */
+export const HEADER_FILL = 'FFD9D9D9';
+/** An error's range larger than this many cells colours only the cells the file already has in it (SP-5003). */
+export const MAX_FILL_CELLS = 10_000;
+/**
+ * A colour as ARGB: `#C00000`, `C00000` or `FFC00000` → `FFC00000`.
+ *
+ * @param c - The colour.
+ * @returns The ARGB form, or undefined when it is not a hex colour.
+ */
+export function argb(c) {
+    const h = c.trim().replace(/^#/, '').toUpperCase();
+    return /^[0-9A-F]{6}$/.test(h) ? `FF${h}` : /^[0-9A-F]{8}$/.test(h) ? h : undefined;
+}
+const block = (name) => new RegExp(`<(\\w+:)?${name}\\b([^>]*?)(?:/>|>([\\s\\S]*?)</\\1${name}>)`);
+/** The workbook's style tables, extended in memory: fills and cell formats are only ever appended. */
+export class StyleBook {
+    xml;
+    P;
+    xfs;
+    fillCount;
+    newFills = [];
+    newXfs = [];
+    fillOf = new Map();
+    xfOf = new Map();
+    constructor(xml) {
+        this.xml = xml;
+        this.P = prefixOf(xml, 'styleSheet');
+        const xfs = block('cellXfs').exec(xml);
+        if (!/<(?:\w+:)?styleSheet\b/.test(xml) || !xfs)
+            throw spError('SP-5002', 'sheetpane review: the styles part has no <cellXfs>');
+        this.xfs = [...(xfs[3] ?? '').matchAll(elementRe('xf'))].map((m) => m[0]);
+        const fills = block('fills').exec(xml);
+        this.fillCount = fills ? [...(fills[3] ?? '').matchAll(elementRe('fill'))].length : 2; // a missing <fills> is written with Excel's two required fills
+    }
+    /** Whether anything was added. */
+    get changed() { return this.newXfs.length > 0; }
+    /** The id of a solid fill in this colour, added once. */
+    fill(color) {
+        let id = this.fillOf.get(color);
+        if (id === undefined) {
+            const P = this.P;
+            id = this.fillCount + this.newFills.length;
+            this.newFills.push(`<${P}fill><${P}patternFill patternType="solid"><${P}fgColor rgb="${color}"/><${P}bgColor indexed="64"/></${P}patternFill></${P}fill>`);
+            this.fillOf.set(color, id);
+        }
+        return id;
+    }
+    /**
+     * A cell format that is format `s` with a solid fill — cloned once per format and colour.
+     *
+     * @param s - The cell's style index (a missing or unknown one is format 0).
+     * @param color - ARGB.
+     * @returns The new format's index.
+     */
+    clone(s, color) {
+        const k = `${s}|${color}`;
+        let id = this.xfOf.get(k);
+        if (id === undefined) {
+            const base = this.xfs[s] ?? this.xfs[0] ?? `<${this.P}xf numFmtId="0" fontId="0" fillId="0" borderId="0" xfId="0"/>`;
+            const tag = openTag(base);
+            id = this.xfs.length + this.newXfs.length;
+            this.newXfs.push(base.replace(tag, setAttr(setAttr(tag, 'fillId', String(this.fill(color))), 'applyFill', '1')));
+            this.xfOf.set(k, id);
+        }
+        return id;
+    }
+    /** The styles part with the new fills and formats appended and the counts set. */
+    toXml() {
+        const P = this.P;
+        let out = this.xml;
+        const grow = (name, items, count, missing) => {
+            const m = block(name).exec(out);
+            if (!m) {
+                out = missing();
+                return;
+            }
+            const open = setAttr(openTag(m[0]).replace(/\s*\/>$/, '>'), 'count', String(count));
+            out = out.replace(m[0], `${open}${m[3] ?? ''}${items}</${m[1] ?? ''}${name}>`);
+        };
+        grow('cellXfs', this.newXfs.join(''), this.xfs.length + this.newXfs.length, () => out);
+        if (this.newFills.length) {
+            grow('fills', this.newFills.join(''), this.fillCount + this.newFills.length, () => {
+                // CT_Stylesheet: numFmts, fonts, fills, borders, cellStyleXfs, cellXfs …
+                const at = out.search(/<(?:\w+:)?(?:borders|cellStyleXfs|cellXfs)\b/);
+                const fills = `<${P}fills count="${this.fillCount + this.newFills.length}"><${P}fill><${P}patternFill patternType="none"/></${P}fill><${P}fill><${P}patternFill patternType="gray125"/></${P}fill>${this.newFills.join('')}</${P}fills>`;
+                return out.slice(0, at) + fills + out.slice(at);
+            });
+        }
+        return out;
+    }
+}
+/** Adds a range to a plan; the worse severity wins on a cell. Returns false when the range was too large to fill whole. */
+export function planRange(plan, r, severity, rank) {
+    if ((r.bottom - r.top + 1) * (r.right - r.left + 1) > MAX_FILL_CELLS) {
+        plan.wide.push({ range: r, severity });
+        return false;
+    }
+    for (let row = r.top; row <= r.bottom; row++) {
+        const cols = plan.cells.get(row) ?? plan.cells.set(row, new Map()).get(row);
+        for (let col = r.left; col <= r.right; col++) {
+            const was = cols.get(col);
+            if (was === undefined || rank(severity) < rank(was))
+                cols.set(col, severity);
+        }
+    }
+    return true;
+}
+/** `<col min max style>` → the style a column gives a cell the file does not have. */
+function colStyles(xml) {
+    const cols = block('cols').exec(xml)?.[3] ?? '';
+    const spans = [...cols.matchAll(/<(?:\w+:)?col\b[^>]*>/g)].map((m) => ({ min: Number(getAttr(m[0], 'min')), max: Number(getAttr(m[0], 'max')), s: getAttr(m[0], 'style') }));
+    return (col) => { const c = spans.find((x) => x.min <= col + 1 && col + 1 <= x.max && x.s !== undefined); return c ? Number(c.s) : undefined; };
+}
+const ROW = /<(\w+:)?row\b[^>]*?(?:\/>|>[\s\S]*?<\/\1row>)/g;
+const CELL = /<(\w+:)?c\b[^>]*?(?:\/>|>[\s\S]*?<\/\1c>)/g;
+/**
+ * Colours one sheet's flagged cells. Rows and cells not flagged are copied unchanged; a flagged cell keeps everything
+ * but its `s`; a flagged cell the file lacks is added empty, styled from its row (when `customFormat`) or column.
+ *
+ * @param xml - The worksheet part.
+ * @param plan - What to colour.
+ * @param rank - A severity's rank: lower is worse, and wins on a cell.
+ * @param styleFor - The style index for a cell of style `s` coloured for `severity`.
+ * @returns The worksheet part, coloured.
+ */
+export function fillSheet(xml, plan, rank, styleFor) {
+    const sd = /<(\w+:)?sheetData\b[^>]*?(\/?)>/.exec(xml);
+    if (!sd)
+        throw spError('SP-5002', 'sheetpane review: the worksheet has no <sheetData>');
+    const P = sd[1] ?? '';
+    const start = sd.index + sd[0].length;
+    const end = sd[2] === '/' ? start : xml.indexOf(`</${P}sheetData>`, start);
+    if (end < 0)
+        throw spError('SP-5002', 'sheetpane review: <sheetData> is not closed');
+    const inner = xml.slice(start, end);
+    const colStyle = colStyles(xml);
+    let maxRow = -1, maxCol = -1;
+    const made = (row, col) => { maxRow = Math.max(maxRow, row); maxCol = Math.max(maxCol, col); };
+    const emptyCell = (row, col, base, sev) => { made(row, col); return `<${P}c r="${cellRef(row, col)}" s="${styleFor(base, sev)}"/>`; };
+    const newRow = (row) => {
+        const cols = [...plan.cells.get(row)].sort(([a], [b]) => a - b);
+        return `<${P}row r="${row + 1}">${cols.map(([col, sev]) => emptyCell(row, col, colStyle(col) ?? 0, sev)).join('')}</${P}row>`;
+    };
+    const wideSev = (row, col, sev) => {
+        for (const w of plan.wide)
+            if (w.range.top <= row && row <= w.range.bottom && w.range.left <= col && col <= w.range.right && (sev === undefined || rank(w.severity) < rank(sev)))
+                sev = w.severity;
+        return sev;
+    };
+    const pending = [...plan.cells.keys()].sort((a, b) => a - b);
+    let pi = 0, last = 0, prev = 0;
+    const out = [];
+    for (const m of inner.matchAll(ROW)) {
+        const tag = openTag(m[0]);
+        const r = Number(getAttr(tag, 'r') ?? prev + 1);
+        prev = r;
+        const row = r - 1;
+        out.push(inner.slice(last, m.index));
+        while (pi < pending.length && pending[pi] < row)
+            out.push(newRow(pending[pi++]));
+        const targets = pending[pi] === row ? plan.cells.get(pending[pi++]) : undefined;
+        const wide = plan.wide.some((w) => w.range.top <= row && row <= w.range.bottom);
+        out.push(targets || wide ? fillRow(m[0], tag, row, targets) : m[0]);
+        last = m.index + m[0].length;
+    }
+    while (pi < pending.length)
+        out.push(newRow(pending[pi++]));
+    out.push(inner.slice(last));
+    function fillRow(rowXml, tag, row, targets) {
+        const self = /\/>$/.test(tag);
+        const body = self ? '' : rowXml.slice(tag.length, rowXml.length - `</${P}row>`.length);
+        const custom = getAttr(tag, 'customFormat');
+        const rowStyle = custom === '1' || custom === 'true' ? Number(getAttr(tag, 's') ?? 0) : undefined;
+        const todo = new Map(targets ?? []);
+        const parts = [];
+        let at = 0, prevCol = -1, minCol = Infinity, maxNew = -1;
+        const addMissing = (before) => {
+            for (const col of [...todo.keys()].filter((c) => c < before).sort((a, b) => a - b)) {
+                parts.push(emptyCell(row, col, rowStyle ?? colStyle(col) ?? 0, todo.get(col)));
+                todo.delete(col);
+                minCol = Math.min(minCol, col);
+                maxNew = Math.max(maxNew, col);
+            }
+        };
+        for (const c of body.matchAll(CELL)) {
+            const ctag = openTag(c[0]);
+            const ref = getAttr(ctag, 'r');
+            const col = ref ? (parseRange(ref)?.left ?? prevCol + 1) : prevCol + 1;
+            prevCol = col;
+            parts.push(body.slice(at, c.index));
+            addMissing(col);
+            const sev = wideSev(row, col, todo.get(col));
+            todo.delete(col);
+            parts.push(sev === undefined ? c[0] : c[0].replace(ctag, setAttr(ctag, 's', String(styleFor(Number(getAttr(ctag, 's') ?? 0), sev)))));
+            at = c.index + c[0].length;
+        }
+        parts.push(body.slice(at));
+        addMissing(Infinity);
+        let open = self ? tag.replace(/\s*\/>$/, '>') : tag;
+        const spans = getAttr(open, 'spans');
+        if (spans && maxNew >= 0) {
+            const [a, b] = spans.split(':').map(Number);
+            if (Number.isFinite(a) && Number.isFinite(b))
+                open = setAttr(open, 'spans', `${Math.min(a, minCol + 1)}:${Math.max(b, maxNew + 1)}`);
+        }
+        return `${open}${parts.join('')}</${P}row>`;
+    }
+    const data = sd[2] === '/' ? `${sd[0].replace(/\s*\/>$/, '>')}${out.join('')}</${P}sheetData>` : `${sd[0]}${out.join('')}`;
+    let result = xml.slice(0, sd.index) + data + xml.slice(end);
+    if (maxRow >= 0)
+        result = widenDimension(result, maxRow, maxCol);
+    return result;
+}
+/** `<dimension ref>` grown to take in a cell the fills added. */
+function widenDimension(xml, row, col) {
+    const d = /<(?:\w+:)?dimension\b[^>]*>/.exec(xml);
+    const ref = d && getAttr(d[0], 'ref');
+    const r = ref ? parseRange(ref) : undefined;
+    if (!d || !r || (row <= r.bottom && col <= r.right))
+        return xml;
+    return xml.replace(d[0], setAttr(d[0], 'ref', `${cellRef(r.top, r.left)}:${cellRef(Math.max(r.bottom, row), Math.max(r.right, col))}`));
+}
+//# sourceMappingURL=fills.js.map

package/dist/fills.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fills.js","sourceRoot":"","sources":["../src/fills.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,2EAA2E;AAC3E,6EAA6E;AAC7E,iFAAiF;AACjF,wDAAwD;AACxD,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,EAAiB,MAAM,mBAAmB,CAAC;AAClG,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAExD,uGAAuG;AACvG,MAAM,CAAC,MAAM,aAAa,GAAqC,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;AAE5H,0FAA0F;AAC1F,MAAM,CAAC,MAAM,WAAW,GAAG,UAAU,CAAC;AAEtC,gHAAgH;AAChH,MAAM,CAAC,MAAM,cAAc,GAAG,MAAM,CAAC;AAErC;;;;;GAKG;AACH,MAAM,UAAU,IAAI,CAAC,CAAS;IAC5B,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;IACnD,OAAO,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACtF,CAAC;AAED,MAAM,KAAK,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,YAAY,IAAI,sCAAsC,IAAI,IAAI,CAAC,CAAC;AAE3G,sGAAsG;AACtG,MAAM,OAAO,SAAS;IASS,GAAG;IARf,CAAC,CAAS;IACV,GAAG,CAAW;IACd,SAAS,CAAS;IAClB,QAAQ,GAAa,EAAE,CAAC;IACxB,MAAM,GAAa,EAAE,CAAC;IACtB,MAAM,GAAG,IAAI,GAAG,EAAkB,CAAC;IACnC,IAAI,GAAG,IAAI,GAAG,EAAkB,CAAC;IAElD,YAA6B,GAAW;mBAAX,GAAG;QAC9B,IAAI,CAAC,CAAC,GAAG,QAAQ,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;QACrC,MAAM,GAAG,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACvC,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG;YAAE,MAAM,OAAO,CAAC,SAAS,EAAE,oDAAoD,CAAC,CAAC;QAChI,IAAI,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1E,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACvC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,+DAA+D;IACxJ,CAAC;IAED,kCAAkC;IAClC,IAAI,OAAO,KAAc,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;IAEzD,yDAAyD;IACzD,IAAI,CAAC,KAAa;QAChB,IAAI,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAChC,IAAI,EAAE,KAAK,SAAS,EAAE,CAAC;YACrB,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;YACjB,EAAE,GAAG,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;YAC3C,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,oCAAoC,CAAC,gBAAgB,KAAK,OAAO,CAAC,2BAA2B,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;YAC3J,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAC7B,CAAC;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,CAAS,EAAE,KAAa;QAC5B,MAAM,CAAC,GAAG,GAAG,CAAC,IAAI,KAAK,EAAE,CAAC;QAC1B,IAAI,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC1B,IAAI,EAAE,KAAK,SAAS,EAAE,CAAC;YACrB,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC,+DAA+D,CAAC;YACrH,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;YAC1B,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;YAC1C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;YACjH,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACvB,CAAC;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,kFAAkF;IAClF,KAAK;QACH,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;QACjB,IAAI,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC;QACnB,MAAM,IAAI,GAAG,CAAC,IAAY,EAAE,KAAa,EAAE,KAAa,EAAE,OAAqB,EAAE,EAAE;YACjF,MAAM,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAChC,IAAI,CAAC,CAAC,EAAE,CAAC;gBAAC,GAAG,GAAG,OAAO,EAAE,CAAC;gBAAC,OAAO;YAAC,CAAC;YACpC,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YACpF,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,GAAG,IAAI,GAAG,CAAC,CAAC;QACjF,CAAC,CAAC;QACF,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC;QACvF,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YACzB,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE;gBAChF,yEAAyE;gBACzE,MAAM,EAAE,GAAG,GAAG,CAAC,MAAM,CAAC,8CAA8C,CAAC,CAAC;gBACtE,MAAM,KAAK,GAAG,IAAI,CAAC,gBAAgB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,MAAM,CAAC,SAAS,CAAC,qCAAqC,CAAC,SAAS,CAAC,SAAS,CAAC,wCAAwC,CAAC,QAAQ,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC;gBACzO,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YAClD,CAAC,CAAC,CAAC;QACL,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;CACF;AAUD,2HAA2H;AAC3H,MAAM,UAAU,SAAS,CAAC,IAAc,EAAE,CAAW,EAAE,QAAgB,EAAE,IAA2B;IAClG,IAAI,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,cAAc,EAAE,CAAC;QAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;QAAC,OAAO,KAAK,CAAC;IAAC,CAAC;IAC/H,KAAK,IAAI,GAAG,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC;QAC7C,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC;QAC7E,KAAK,IAAI,GAAG,GAAG,CAAC,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC;YAAC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAAC,IAAI,GAAG,KAAK,SAAS,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC;gBAAE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;QAAC,CAAC;IAC5J,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,sFAAsF;AACtF,SAAS,SAAS,CAAC,GAAW;IAC5B,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAChD,MAAM,KAAK,GAAG,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,wBAAwB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;IAC7K,OAAO,CAAC,GAAG,EAAE,EAAE,GAAG,MAAM,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;AAClJ,CAAC;AAED,MAAM,GAAG,GAAG,gDAAgD,CAAC;AAC7D,MAAM,IAAI,GAAG,4CAA4C,CAAC;AAE1D;;;;;;;;;GASG;AACH,MAAM,UAAU,SAAS,CAAC,GAAW,EAAE,IAAc,EAAE,IAA2B,EAAE,QAAiD;IACnI,MAAM,EAAE,GAAG,iCAAiC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACvD,IAAI,CAAC,EAAE;QAAE,MAAM,OAAO,CAAC,SAAS,EAAE,oDAAoD,CAAC,CAAC;IACxF,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IACtB,MAAM,KAAK,GAAG,EAAE,CAAC,KAAK,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;IACtC,MAAM,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;IAC3E,IAAI,GAAG,GAAG,CAAC;QAAE,MAAM,OAAO,CAAC,SAAS,EAAE,6CAA6C,CAAC,CAAC;IACrF,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACpC,MAAM,QAAQ,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;IAChC,IAAI,MAAM,GAAG,CAAC,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,CAAC;IAC7B,MAAM,IAAI,GAAG,CAAC,GAAW,EAAE,GAAW,EAAE,EAAE,GAAG,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/G,MAAM,SAAS,GAAG,CAAC,GAAW,EAAE,GAAW,EAAE,IAAY,EAAE,GAAW,EAAE,EAAE,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,QAAQ,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,QAAQ,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACtK,MAAM,MAAM,GAAG,CAAC,GAAW,EAAE,EAAE;QAC7B,MAAM,IAAI,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QACjE,OAAO,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC,KAAK,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC;IAChI,CAAC,CAAC;IACF,MAAM,OAAO,GAAG,CAAC,GAAW,EAAE,GAAW,EAAE,GAAuB,EAAE,EAAE;QACpE,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,IAAI;YAAE,IAAI,CAAC,CAAC,KAAK,CAAC,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC,KAAK,CAAC,IAAI,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,GAAG,KAAK,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;gBAAE,GAAG,GAAG,CAAC,CAAC,QAAQ,CAAC;QACnM,OAAO,GAAG,CAAC;IACb,CAAC,CAAC;IAEF,MAAM,OAAO,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAC7D,IAAI,EAAE,GAAG,CAAC,EAAE,IAAI,GAAG,CAAC,EAAE,IAAI,GAAG,CAAC,CAAC;IAC/B,MAAM,GAAG,GAAa,EAAE,CAAC;IACzB,KAAK,MAAM,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACpC,MAAM,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1B,MAAM,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,CAAC,CAAC;QAChD,IAAI,GAAG,CAAC,CAAC;QACT,MAAM,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;QAClB,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;QACrC,OAAO,EAAE,GAAG,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,EAAE,CAAE,GAAG,GAAG;YAAE,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,EAAE,CAAE,CAAC,CAAC,CAAC;QACnF,MAAM,OAAO,GAAG,OAAO,CAAC,EAAE,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,EAAE,CAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACjF,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAChF,GAAG,CAAC,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACpE,IAAI,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;IAC/B,CAAC;IACD,OAAO,EAAE,GAAG,OAAO,CAAC,MAAM;QAAE,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,EAAE,CAAE,CAAC,CAAC,CAAC;IAC7D,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IAE5B,SAAS,OAAO,CAAC,MAAc,EAAE,GAAW,EAAE,GAAW,EAAE,OAAwC;QACjG,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC9B,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACvF,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;QAC5C,MAAM,QAAQ,GAAG,MAAM,KAAK,GAAG,IAAI,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAClG,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;QACpC,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,IAAI,EAAE,GAAG,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,EAAE,MAAM,GAAG,QAAQ,EAAE,MAAM,GAAG,CAAC,CAAC,CAAC;QACzD,MAAM,UAAU,GAAG,CAAC,MAAc,EAAE,EAAE;YACpC,KAAK,MAAM,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;gBACnF,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,QAAQ,IAAI,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC,CAAC,CAAC;gBAChF,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBACjB,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;gBAAC,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;YACjE,CAAC;QACH,CAAC,CAAC;QACF,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACpC,MAAM,IAAI,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC3B,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;YAC/B,MAAM,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,IAAI,IAAI,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC;YACvE,OAAO,GAAG,GAAG,CAAC;YACd,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;YACpC,UAAU,CAAC,GAAG,CAAC,CAAC;YAChB,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;YAC7C,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACjB,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,GAAG,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACtI,EAAE,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;QAC7B,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;QAC3B,UAAU,CAAC,QAAQ,CAAC,CAAC;QACrB,IAAI,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;QACpD,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACrC,IAAI,KAAK,IAAI,MAAM,IAAI,CAAC,EAAE,CAAC;YACzB,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YAC5C,IAAI,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;gBAAE,IAAI,GAAG,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,CAAE,EAAE,MAAM,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,CAAE,EAAE,MAAM,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC;QACzI,CAAC;QACD,OAAO,GAAG,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC;IAC9C,CAAC;IAED,MAAM,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;IAC3H,IAAI,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC5D,IAAI,MAAM,IAAI,CAAC;QAAE,MAAM,GAAG,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IACjE,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,iEAAiE;AACjE,SAAS,cAAc,CAAC,GAAW,EAAE,GAAW,EAAE,GAAW;IAC3D,MAAM,CAAC,GAAG,6BAA6B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAClD,MAAM,GAAG,GAAG,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACtC,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC5C,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,KAAK,CAAC;QAAE,OAAO,GAAG,CAAC;IAChE,OAAO,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAC1I,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,67 @@
+import { type Plugin, type Severity } from '@sheetpane/grid';
+import { type ReviewReport } from './write.js';
+/** Options for {@link review}. Each switch is the default for the Download menu's item; a host flips one per export with `export({ … })`. */
+export interface ReviewOptions {
+    /** Add the Review sheet. Default `true`; `export({ review: false })` leaves it out of one export. */
+    sheet?: boolean;
+    /** Colour each flagged cell by severity. Default `false`; `export({ reviewFills: true })` colours one export. */
+    fill?: boolean;
+    /** The Review sheet's name. Default `Review`; beside a sheet of that name it becomes `Review (2)`. */
+    sheetName?: string;
+    /**
+     * The severities listed and coloured. Default the problems — `error`, `warning`, `note`; results such as `pass`
+     * and `skipped` (W-50) only when listed. `export({ reviewSeverities: […] })` overrides it for one export.
+     */
+    severities?: readonly Severity[];
+    /**
+     * The layers listed and coloured (W-51); an error with no `layer` is `review`. Default every layer but `compare`
+     * (W-63: a comparison is not the review), which is listed only when named.
+     * `export({ reviewLayers: […] })` overrides it for one export.
+     */
+    layers?: readonly string[];
+    /** A fill per severity — `#RRGGBB`, `RRGGBB` or ARGB — over the defaults (`error` pale red, `warning` pale yellow, `note` pale blue); `null` colours none. */
+    fills?: Readonly<Record<string, string | null>>;
+}
+/** What one export wrote: the sheet's name, the ids listed, the counts by status, the ids coloured and what was skipped. */
+export type { ReviewReport, SkipReason } from './write.js';
+/** The review plugin, plus the report of its most recent export. */
+export interface ReviewPlugin extends Plugin {
+    /** What the most recent export wrote and skipped; undefined until one runs (or when there was nothing to write). */
+    readonly lastExport: ReviewReport | undefined;
+}
+/**
+ * The review plugin. On export (`exportPatch`), it adds a *Review* sheet listing every error — id, sheet, cell (a link
+ * to it), severity, type, found, expected, message, author, status, and for an accepted error *Accepted: <reason>*
+ * with who and when — and, when asked, fills each open error's cells by severity, cloning each cell's format so its
+ * own formatting stays. Whole-sheet and workbook errors are listed, never coloured. A defined name marks the sheet
+ * ({@link reviewSheetOf}). An `.xlsx` export only. Importing this module registers it as `review`.
+ *
+ * @param options - Defaults for the Download menu's *Add a Review sheet* and *Colour flagged cells*, the sheet's
+ *   name, the severities and layers written, and the fills.
+ * @returns The plugin (`id: 'review'`) with `lastExport`.
+ * @throws SP-5005 when a `fills` colour is not a hex colour.
+ * @see https://github.com/arpitarya/sheetpane/blob/main/records/0123_REVIEW.md
+ * @example
+ * ```ts
+ * import { createWorkbook } from '@sheetpane/grid';
+ * import { review } from '@sheetpane/review';
+ *
+ * const plugin = review({ fill: true });
+ * const book = createWorkbook({ plugins: [plugin] });
+ * await book.load(bytes, 'holdings.xlsx');
+ * const { blob } = await book.exportFile();
+ * plugin.lastExport?.counts; // { open, accepted, resolved }
+ * ```
+ * @example
+ * ```ts
+ * import '@sheetpane/review'; // registers `review`
+ * excel.setAttribute('plugins', 'review');
+ * const annotated = await excel.export({ reviewFills: true });
+ * const listOnly = await excel.export({ reviewSeverities: ['error'] });
+ * ```
+ */
+export declare function review(options?: ReviewOptions): ReviewPlugin;
+export { reviewSheetOf, REVIEW_NAME } from './sheet.js';
+export { COLUMNS, PROBLEM_SEVERITIES } from './rows.js';
+export { DEFAULT_FILLS, MAX_FILL_CELLS } from './fills.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAMA,OAAO,EAAqC,KAAK,MAAM,EAAE,KAAK,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAGhG,OAAO,EAAe,KAAK,YAAY,EAAE,MAAM,YAAY,CAAC;AAE5D,6IAA6I;AAC7I,MAAM,WAAW,aAAa;IAC5B,qGAAqG;IACrG,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,iHAAiH;IACjH,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,sGAAsG;IACtG,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,UAAU,CAAC,EAAE,SAAS,QAAQ,EAAE,CAAC;IACjC;;;;OAIG;IACH,MAAM,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC3B,8JAA8J;IAC9J,KAAK,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC;CACjD;AAED,4HAA4H;AAC5H,YAAY,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE3D,oEAAoE;AACpE,MAAM,WAAW,YAAa,SAAQ,MAAM;IAC1C,oHAAoH;IACpH,QAAQ,CAAC,UAAU,EAAE,YAAY,GAAG,SAAS,CAAC;CAC/C;AAOD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wBAAgB,MAAM,CAAC,OAAO,GAAE,aAAkB,GAAG,YAAY,CA8BhE;AAID,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACxD,OAAO,EAAE,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC"}

package/dist/index.js

@@ -0,0 +1,87 @@
+// @sheetpane/review — the review written into the download as a sheet of its
+// own, and optionally each flagged cell filled by severity (W-59). Export-only:
+// one `exportPatch` hook on the existing context, no seventh hook, no controls
+// beyond the Download menu's two switches. String XML only, so it runs in Node.
+// Nothing leaves the page (SR-LAW-11): the parts are written into the bytes the
+// browser saves.
+import { SEVERITY, registerPlugin, spError } from '@sheetpane/grid';
+import { DEFAULT_FILLS, argb } from './fills.js';
+import { PROBLEM_SEVERITIES, selectErrors } from './rows.js';
+import { writeReview } from './write.js';
+const strings = (v) => (Array.isArray(v) && v.every((x) => typeof x === 'string') ? v : undefined);
+/** `export({ reviewSeverities })` as the grid's severities: a list of names, each one SEVERITY knows (W-50). */
+const severitiesOf = (v) => (strings(v)?.every((s) => Object.hasOwn(SEVERITY, s)) ? v : undefined);
+const flag = (v, fallback) => (typeof v === 'boolean' ? v : fallback);
+/**
+ * The review plugin. On export (`exportPatch`), it adds a *Review* sheet listing every error — id, sheet, cell (a link
+ * to it), severity, type, found, expected, message, author, status, and for an accepted error *Accepted: <reason>*
+ * with who and when — and, when asked, fills each open error's cells by severity, cloning each cell's format so its
+ * own formatting stays. Whole-sheet and workbook errors are listed, never coloured. A defined name marks the sheet
+ * ({@link reviewSheetOf}). An `.xlsx` export only. Importing this module registers it as `review`.
+ *
+ * @param options - Defaults for the Download menu's *Add a Review sheet* and *Colour flagged cells*, the sheet's
+ *   name, the severities and layers written, and the fills.
+ * @returns The plugin (`id: 'review'`) with `lastExport`.
+ * @throws SP-5005 when a `fills` colour is not a hex colour.
+ * @see https://github.com/arpitarya/sheetpane/blob/main/records/0123_REVIEW.md
+ * @example
+ * ```ts
+ * import { createWorkbook } from '@sheetpane/grid';
+ * import { review } from '@sheetpane/review';
+ *
+ * const plugin = review({ fill: true });
+ * const book = createWorkbook({ plugins: [plugin] });
+ * await book.load(bytes, 'holdings.xlsx');
+ * const { blob } = await book.exportFile();
+ * plugin.lastExport?.counts; // { open, accepted, resolved }
+ * ```
+ * @example
+ * ```ts
+ * import '@sheetpane/review'; // registers `review`
+ * excel.setAttribute('plugins', 'review');
+ * const annotated = await excel.export({ reviewFills: true });
+ * const listOnly = await excel.export({ reviewSeverities: ['error'] });
+ * ```
+ */
+export function review(options = {}) {
+    const fills = { ...DEFAULT_FILLS };
+    for (const [sev, c] of Object.entries(options.fills ?? {})) {
+        if (c === null) {
+            delete fills[sev];
+            continue;
+        }
+        const v = argb(c);
+        if (!v)
+            throw spError('SP-5005', `sheetpane review: fill for "${sev}" is not a colour: ${JSON.stringify(c)}`, TypeError);
+        fills[sev] = v;
+    }
+    let last;
+    return {
+        id: 'review',
+        provides: ['exportPatch'],
+        // the Download menu's switches for this export (W-34)
+        exportOptions: [
+            { key: 'review', label: 'Add a Review sheet', default: options.sheet !== false },
+            { key: 'reviewFills', label: 'Colour flagged cells', default: options.fill === true },
+        ],
+        get lastExport() { return last; },
+        async exportPatch(patch, ctx) {
+            last = undefined;
+            const x = ctx.exportOptions ?? {};
+            const sheet = flag(x.review, options.sheet !== false), fill = flag(x.reviewFills, options.fill === true);
+            if (!sheet && !fill)
+                return;
+            const severities = severitiesOf(x.reviewSeverities) ?? options.severities ?? PROBLEM_SEVERITIES;
+            const layers = strings(x.reviewLayers) ?? options.layers;
+            const errors = selectErrors(ctx.snapshot().errors, { severities, layers }, patch.sheetNames());
+            if (!errors.length)
+                return;
+            last = await writeReview(patch, errors, { sheet, fill, sheetName: options.sheetName ?? 'Review', fills, order: [...PROBLEM_SEVERITIES, ...severities] });
+        },
+    };
+}
+registerPlugin('review', () => review());
+export { reviewSheetOf, REVIEW_NAME } from './sheet.js';
+export { COLUMNS, PROBLEM_SEVERITIES } from './rows.js';
+export { DEFAULT_FILLS, MAX_FILL_CELLS } from './fills.js';
+//# sourceMappingURL=index.js.map