@sheetpane/review 0.0.0-stage → 0.4.0

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,6EAA6E;AAC7E,gFAAgF;AAChF,+EAA+E;AAC/E,gFAAgF;AAChF,gFAAgF;AAChF,iBAAiB;AACjB,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,OAAO,EAA8B,MAAM,iBAAiB,CAAC;AAChG,OAAO,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAqB,MAAM,YAAY,CAAC;AAkC5D,MAAM,OAAO,GAAG,CAAC,CAAU,EAAwB,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAE,CAAc,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;AAChJ,gHAAgH;AAChH,MAAM,YAAY,GAAG,CAAC,CAAU,EAA0B,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAE,CAAgB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;AACpJ,MAAM,IAAI,GAAG,CAAC,CAAU,EAAE,QAAiB,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;AAExF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,UAAU,MAAM,CAAC,OAAO,GAAkB,EAAE;IAChD,MAAM,KAAK,GAA2B,EAAE,GAAG,aAAa,EAAE,CAAC;IAC3D,KAAK,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE,CAAC;QAC3D,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;YAAC,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC;YAAC,SAAS;QAAC,CAAC;QAChD,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,IAAI,CAAC,CAAC;YAAE,MAAM,OAAO,CAAC,SAAS,EAAE,+BAA+B,GAAG,sBAAsB,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC;QACzH,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACjB,CAAC;IACD,IAAI,IAA8B,CAAC;IACnC,OAAO;QACL,EAAE,EAAE,QAAQ;QACZ,QAAQ,EAAE,CAAC,aAAa,CAAC;QACzB,sDAAsD;QACtD,aAAa,EAAE;YACb,EAAE,GAAG,EAAE,QAAQ,EAAE,KAAK,EAAE,oBAAoB,EAAE,OAAO,EAAE,OAAO,CAAC,KAAK,KAAK,KAAK,EAAE;YAChF,EAAE,GAAG,EAAE,aAAa,EAAE,KAAK,EAAE,sBAAsB,EAAE,OAAO,EAAE,OAAO,CAAC,IAAI,KAAK,IAAI,EAAE;SACtF;QACD,IAAI,UAAU,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;QACjC,KAAK,CAAC,WAAW,CAAC,KAAK,EAAE,GAAG;YAC1B,IAAI,GAAG,SAAS,CAAC;YACjB,MAAM,CAAC,GAAG,GAAG,CAAC,aAAa,IAAI,EAAE,CAAC;YAClC,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,KAAK,KAAK,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,WAAW,EAAE,OAAO,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;YACzG,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI;gBAAE,OAAO;YAC5B,MAAM,UAAU,GAAG,YAAY,CAAC,CAAC,CAAC,gBAAgB,CAAC,IAAI,OAAO,CAAC,UAAU,IAAI,kBAAkB,CAAC;YAChG,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC;YACzD,MAAM,MAAM,GAAG,YAAY,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE,EAAE,KAAK,CAAC,UAAU,EAAE,CAAC,CAAC;YAC/F,IAAI,CAAC,MAAM,CAAC,MAAM;gBAAE,OAAO;YAC3B,IAAI,GAAG,MAAM,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,GAAG,kBAAkB,EAAE,GAAG,UAAU,CAAC,EAAE,CAAC,CAAC;QAC3J,CAAC;KACF,CAAC;AACJ,CAAC;AAED,cAAc,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC;AAEzC,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/rows.d.ts

@@ -0,0 +1,49 @@
+import { type ProblemSeverity, type Severity, type SheetpaneError } from '@sheetpane/grid';
+/** The severities that are problems — what the review lists and colours unless `severities` names others. */
+export declare const PROBLEM_SEVERITIES: readonly ProblemSeverity[];
+/** The Review sheet's columns, left to right. */
+export declare const COLUMNS: readonly ['ID', 'Sheet', 'Cell', 'Severity', 'Type', 'Found', 'Expected', 'Message', 'Author', 'Status', 'Accepted', 'Accepted by', 'Accepted at'];
+/** Column widths in Excel's character units, one per {@link COLUMNS} entry. */
+export declare const WIDTHS: readonly number[];
+/** One row of the Review sheet: the cells' text, and where the Cell column links to. */
+export interface ReviewRow {
+    /** The error. */
+    error: SheetpaneError;
+    /** One string per {@link COLUMNS} entry; `''` leaves the cell empty. */
+    cells: string[];
+    /** The internal hyperlink of the Cell column (`'Holdings'!I6`), or undefined for none. */
+    link: string | undefined;
+}
+/** What the export lists. */
+export interface Selection {
+    /** The severities listed; default {@link PROBLEM_SEVERITIES}. */
+    severities?: readonly Severity[] | undefined;
+    /** The layers listed (an error with no `layer` is `review`); default every layer but `compare` (W-63), which is listed only when named. */
+    layers?: readonly string[] | undefined;
+}
+/** A sheet name quoted for a reference: `'Q3 ''final'''!`. */
+export declare const quoteSheet: (name: string) => string;
+/** `2026-10-19T09:12:00.000Z` → `2026-10-19 09:12 UTC`; anything unreadable as it is. */
+export declare function when(iso: string | undefined): string;
+/** `@sheetpane/compare`'s layer (W-63): a comparison is not the review, so it is listed only when `layers` names it — as `@sheetpane/comments` writes it. */
+export declare const COMPARE_LAYER = "compare";
+/**
+ * The errors one export lists: not the file's own comments (`author: 'file'`), only the severities and layers
+ * asked for (by default every layer but `compare`); the workbook's errors first, then each sheet in the file's order — its whole-sheet errors, then its
+ * cells top to bottom, left to right.
+ *
+ * @param errors - The store's errors.
+ * @param sel - The severities and layers to list.
+ * @param sheetOrder - The file's sheet names, in order.
+ * @returns The errors to list, in order.
+ */
+export declare function selectErrors(errors: readonly SheetpaneError[], sel: Selection, sheetOrder: readonly string[]): SheetpaneError[];
+/**
+ * The Review sheet's row for one error. An accepted error (W-69) reads *Accepted: <reason>*, with who and when.
+ *
+ * @param e - The error.
+ * @param hasSheet - Whether the file has a sheet by this name (no link otherwise).
+ * @returns The row's cells and its link.
+ */
+export declare function rowOf(e: SheetpaneError, hasSheet: (name: string) => boolean): ReviewRow;
+//# sourceMappingURL=rows.d.ts.map

package/dist/rows.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rows.d.ts","sourceRoot":"","sources":["../src/rows.ts"],"names":[],"mappings":"AAEA,OAAO,EAA0E,KAAK,eAAe,EAAE,KAAK,QAAQ,EAAE,KAAK,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAGnK,6GAA6G;AAC7G,eAAO,MAAM,kBAAkB,EAAE,SAAS,eAAe,EAAiC,CAAC;AAE3F,iDAAiD;AACjD,eAAO,MAAM,OAAO,YAAI,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,aAAa,EAAE,aAAa,CAAU,CAAC;AAE1K,+EAA+E;AAC/E,eAAO,MAAM,MAAM,EAAE,SAAS,MAAM,EAAyD,CAAC;AAE9F,wFAAwF;AACxF,MAAM,WAAW,SAAS;IACxB,iBAAiB;IACjB,KAAK,EAAE,cAAc,CAAC;IACtB,wEAAwE;IACxE,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,0FAA0F;IAC1F,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;CAC1B;AAED,6BAA6B;AAC7B,MAAM,WAAW,SAAS;IACxB,iEAAiE;IACjE,UAAU,CAAC,EAAE,SAAS,QAAQ,EAAE,GAAG,SAAS,CAAC;IAC7C,2IAA2I;IAC3I,MAAM,CAAC,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,CAAC;CACxC;AAED,8DAA8D;AAC9D,eAAO,MAAM,UAAU,SAAU,MAAM,KAAG,MAAyC,CAAC;AAOpF,yFAAyF;AACzF,wBAAgB,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,CAIpD;AAED,6JAA6J;AAC7J,eAAO,MAAM,aAAa,YAAY,CAAC;AAEvC;;;;;;;;;GASG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,SAAS,cAAc,EAAE,EAAE,GAAG,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,MAAM,EAAE,GAAG,cAAc,EAAE,CAc/H;AAED;;;;;;GAMG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,cAAc,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,GAAG,SAAS,CAiBvF"}

package/dist/rows.js

@@ -0,0 +1,79 @@
+// Which errors the review lists, in which order, and the text of each row
+// (W-59 DoD 1, 5). Pure functions over the store's errors: no XML here.
+import { BUILTIN_TYPE_NAMES, DEFAULT_ERROR_TYPES, SEVERITY, errorScope, layerOf } from '@sheetpane/grid';
+import { parseRange } from '@sheetpane/export';
+/** The severities that are problems — what the review lists and colours unless `severities` names others. */
+export const PROBLEM_SEVERITIES = ['error', 'warning', 'note'];
+/** The Review sheet's columns, left to right. */
+export const COLUMNS = ['ID', 'Sheet', 'Cell', 'Severity', 'Type', 'Found', 'Expected', 'Message', 'Author', 'Status', 'Accepted', 'Accepted by', 'Accepted at'];
+/** Column widths in Excel's character units, one per {@link COLUMNS} entry. */
+export const WIDTHS = [11, 16, 12, 10, 18, 18, 18, 60, 14, 10, 40, 14, 18];
+/** A sheet name quoted for a reference: `'Q3 ''final'''!`. */
+export const quoteSheet = (name) => `'${name.replace(/'/g, "''")}'`;
+const typeName = (id) => DEFAULT_ERROR_TYPES.find((t) => t.id === id)?.name ?? BUILTIN_TYPE_NAMES[id] ?? id;
+const cap = (s) => (s ? s[0].toUpperCase() + s.slice(1) : s);
+/** A severity's name as the panel shows it — `Passed` and `Not checked` for W-50's results; one from an old saved review that is no severity, capitalised. */
+const severityName = (s) => SEVERITY[s]?.name ?? cap(s);
+/** `2026-10-19T09:12:00.000Z` → `2026-10-19 09:12 UTC`; anything unreadable as it is. */
+export function when(iso) {
+    if (!iso)
+        return '';
+    const d = new Date(iso);
+    return Number.isNaN(d.getTime()) ? iso : `${d.toISOString().slice(0, 16).replace('T', ' ')} UTC`;
+}
+/** `@sheetpane/compare`'s layer (W-63): a comparison is not the review, so it is listed only when `layers` names it — as `@sheetpane/comments` writes it. */
+export const COMPARE_LAYER = 'compare';
+/**
+ * The errors one export lists: not the file's own comments (`author: 'file'`), only the severities and layers
+ * asked for (by default every layer but `compare`); the workbook's errors first, then each sheet in the file's order — its whole-sheet errors, then its
+ * cells top to bottom, left to right.
+ *
+ * @param errors - The store's errors.
+ * @param sel - The severities and layers to list.
+ * @param sheetOrder - The file's sheet names, in order.
+ * @returns The errors to list, in order.
+ */
+export function selectErrors(errors, sel, sheetOrder) {
+    const sev = new Set(sel.severities ?? PROBLEM_SEVERITIES);
+    const layers = sel.layers ? new Set(sel.layers) : undefined;
+    const picked = errors.filter((e) => e.author !== 'file' && sev.has(e.severity) && (layers ? layers.has(layerOf(e)) : layerOf(e) !== COMPARE_LAYER));
+    const sheetIx = (s) => { const i = sheetOrder.indexOf(s); return i < 0 ? sheetOrder.length : i; };
+    const key = (e) => {
+        const scope = errorScope(e);
+        if (scope === 'workbook')
+            return [0, 0, 0, 0];
+        const r = scope === 'cell' ? parseRange(e.range) : undefined;
+        return [1, sheetIx(e.sheet), scope === 'sheet' ? -1 : (r?.top ?? Number.MAX_SAFE_INTEGER), r?.left ?? 0];
+    };
+    const keyed = picked.map((e, i) => ({ e, i, k: key(e) }));
+    keyed.sort((a, b) => a.k[0] - b.k[0] || a.k[1] - b.k[1] || (a.k[1] === sheetOrder.length ? a.e.sheet.localeCompare(b.e.sheet) : 0) || a.k[2] - b.k[2] || a.k[3] - b.k[3] || a.i - b.i);
+    return keyed.map((x) => x.e);
+}
+/**
+ * The Review sheet's row for one error. An accepted error (W-69) reads *Accepted: <reason>*, with who and when.
+ *
+ * @param e - The error.
+ * @param hasSheet - Whether the file has a sheet by this name (no link otherwise).
+ * @returns The row's cells and its link.
+ */
+export function rowOf(e, hasSheet) {
+    const scope = errorScope(e);
+    const range = e.range.trim().toUpperCase().replace(/\$/g, '');
+    const cell = scope === 'workbook' ? 'Whole workbook' : scope === 'sheet' ? 'Whole sheet' : range;
+    const accepted = e.status === 'accepted';
+    const cells = [
+        e.id, e.sheet, cell, severityName(e.severity), typeName(e.type), e.found, e.expected, e.message, e.author, cap(e.status),
+        accepted ? `Accepted: ${e.reason ?? ''}` : '',
+        accepted ? (e.acceptedBy?.trim() || e.author) : '',
+        accepted ? when(e.acceptedAt) : '',
+    ];
+    let link;
+    if (scope !== 'workbook' && hasSheet(e.sheet)) {
+        if (scope === 'sheet')
+            link = `${quoteSheet(e.sheet)}!A1`;
+        else if (parseRange(range))
+            link = `${quoteSheet(e.sheet)}!${range}`;
+    }
+    return { error: e, cells, link };
+}
+//# sourceMappingURL=rows.js.map

package/dist/rows.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rows.js","sourceRoot":"","sources":["../src/rows.ts"],"names":[],"mappings":"AAAA,0EAA0E;AAC1E,wEAAwE;AACxE,OAAO,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,QAAQ,EAAE,UAAU,EAAE,OAAO,EAA4D,MAAM,iBAAiB,CAAC;AACnK,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAE/C,6GAA6G;AAC7G,MAAM,CAAC,MAAM,kBAAkB,GAA+B,CAAC,OAAO,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;AAE3F,iDAAiD;AACjD,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,aAAa,EAAE,aAAa,CAAU,CAAC;AAE1K,+EAA+E;AAC/E,MAAM,CAAC,MAAM,MAAM,GAAsB,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;AAoB9F,8DAA8D;AAC9D,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC;AAEpF,MAAM,QAAQ,GAAG,CAAC,EAAU,EAAE,EAAE,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,IAAI,kBAAkB,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC;AACpH,MAAM,GAAG,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAE,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACtE,8JAA8J;AAC9J,MAAM,YAAY,GAAG,CAAC,CAAW,EAAU,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC;AAE1E,yFAAyF;AACzF,MAAM,UAAU,IAAI,CAAC,GAAuB;IAC1C,IAAI,CAAC,GAAG;QAAE,OAAO,EAAE,CAAC;IACpB,MAAM,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC;IACxB,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,MAAM,CAAC;AACnG,CAAC;AAED,6JAA6J;AAC7J,MAAM,CAAC,MAAM,aAAa,GAAG,SAAS,CAAC;AAEvC;;;;;;;;;GASG;AACH,MAAM,UAAU,YAAY,CAAC,MAAiC,EAAE,GAAc,EAAE,UAA6B;IAC3G,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,UAAU,IAAI,kBAAkB,CAAC,CAAC;IAC1D,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC5D,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,aAAa,CAAC,CAAC,CAAC;IACpJ,MAAM,OAAO,GAAG,CAAC,CAAS,EAAE,EAAE,GAAG,MAAM,CAAC,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1G,MAAM,GAAG,GAAG,CAAC,CAAiB,EAAY,EAAE;QAC1C,MAAM,KAAK,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;QAC5B,IAAI,KAAK,KAAK,UAAU;YAAE,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QAC9C,MAAM,CAAC,GAAG,KAAK,KAAK,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC7D,OAAO,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,KAAK,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,MAAM,CAAC,gBAAgB,CAAC,EAAE,CAAC,EAAE,IAAI,IAAI,CAAC,CAAC,CAAC;IAC3G,CAAC,CAAC;IACF,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC1D,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/L,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC/B,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,KAAK,CAAC,CAAiB,EAAE,QAAmC;IAC1E,MAAM,KAAK,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;IAC5B,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAC9D,MAAM,IAAI,GAAG,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,KAAK,KAAK,OAAO,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC;IACjG,MAAM,QAAQ,GAAG,CAAC,CAAC,MAAM,KAAK,UAAU,CAAC;IACzC,MAAM,KAAK,GAAG;QACZ,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC;QACxH,QAAQ,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,MAAM,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE;QAC7C,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE;QAClD,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE;KACnC,CAAC;IACF,IAAI,IAAwB,CAAC;IAC7B,IAAI,KAAK,KAAK,UAAU,IAAI,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;QAC9C,IAAI,KAAK,KAAK,OAAO;YAAE,IAAI,GAAG,GAAG,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC;aACrD,IAAI,UAAU,CAAC,KAAK,CAAC;YAAE,IAAI,GAAG,GAAG,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,KAAK,EAAE,CAAC;IACvE,CAAC;IACD,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;AACnC,CAAC"}

package/dist/sheet.d.ts

@@ -0,0 +1,74 @@
+import { type ReviewRow } from './rows.js';
+import { type PatchContext } from './xml.js';
+/** The defined name that marks the Review sheet: workbook-scoped, hidden, over the table (`'Review'!$A$1:$M$4`). */
+export declare const REVIEW_NAME = "_sheetpane_review";
+/**
+ * A usable sheet name from what the host asked for: forbidden characters dropped, apostrophes trimmed from the ends,
+ * at most 31 characters; `Review` when nothing is left.
+ *
+ * @param name - The name asked for.
+ * @returns A name Excel accepts.
+ */
+export declare function cleanSheetName(name: string): string;
+/**
+ * A name no sheet has, compared as Excel compares them (ignoring case): `Review`, else `Review (2)`, `Review (3)`…
+ * trimmed so the whole stays within 31 characters. A user's sheet is never overwritten.
+ *
+ * @param base - The clean name.
+ * @param taken - The workbook's sheet names.
+ * @returns A free name.
+ */
+export declare function uniqueSheetName(base: string, taken: readonly string[]): string;
+/** The sheet a formula like `'Q3 ''x'''!$A$1:$M$9` (or `Review!A1`) points at. */
+export declare function sheetOfFormula(formula: string): string | undefined;
+/**
+ * Which sheet of a workbook is a Review sheet sheetpane wrote, by its defined name — so a host can leave it out
+ * when the annotated file is uploaded again.
+ *
+ * @param book - A workbook as `@sheetpane/import` reads it (its `definedNames` and `sheets`).
+ * @returns The Review sheet's name, or undefined when the file has none.
+ * @example
+ * ```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);
+ * ```
+ * @see https://github.com/arpitarya/sheetpane/blob/main/records/0123_REVIEW.md
+ */
+export declare function reviewSheetOf(book: {
+    definedNames: readonly {
+        name: string;
+        formula: string;
+    }[];
+    sheets: readonly {
+        name: string;
+    }[];
+}): string | undefined;
+/** The worksheet XML: a frozen header row, column widths, one row per error, the Cell column's links. */
+export declare function sheetXml(rows: readonly ReviewRow[], headerStyle: number | undefined): string;
+/** Puts the marker name in the workbook part, replacing an earlier one; `<definedNames>` is created in schema position when missing. */
+export declare function setMarker(wb: string, formula: string): string;
+/** Adds `<sheet name sheetId r:id>` at the end of `<sheets>`, binding the relationships namespace on the root when missing. */
+export declare function addSheet(wb: string, name: string, rId: string): string;
+/**
+ * Writes the Review sheet. An earlier Review sheet this plugin wrote (the marker names it, and it has no parts of
+ * its own) is rewritten in place; otherwise a new sheet is added last, under a name no sheet has.
+ *
+ * @param patch - The export's package.
+ * @param rows - The rows, in order.
+ * @param o - The name asked for and the header's style index (none: unstyled).
+ * @returns The name and part of the sheet written.
+ */
+export declare function writeReviewSheet(patch: PatchContext, rows: readonly ReviewRow[], o: {
+    name: string;
+    headerStyle?: number | undefined;
+}): Promise<{
+    name: string;
+    path: string;
+}>;
+/** The workbook's styles part, through its relationship. */
+export declare function stylesPath(patch: PatchContext): Promise<string | undefined>;
+//# sourceMappingURL=sheet.d.ts.map

package/dist/sheet.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sheet.d.ts","sourceRoot":"","sources":["../src/sheet.ts"],"names":[],"mappings":"AAMA,OAAO,EAA+B,KAAK,SAAS,EAAE,MAAM,WAAW,CAAC;AACxE,OAAO,EACiG,KAAK,YAAY,EACxH,MAAM,UAAU,CAAC;AAElB,oHAAoH;AACpH,eAAO,MAAM,WAAW,sBAAsB,CAAC;AAK/C;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAGnD;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,MAAM,EAAE,GAAG,MAAM,CAQ9E;AAED,kFAAkF;AAClF,wBAAgB,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAMlE;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE;IAAE,YAAY,EAAE,SAAS;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAAC,MAAM,EAAE,SAAS;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;CAAE,GAAG,MAAM,GAAG,SAAS,CAI3J;AAED,yGAAyG;AACzG,wBAAgB,QAAQ,CAAC,IAAI,EAAE,SAAS,SAAS,EAAE,EAAE,WAAW,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,CAY5F;AAED,wIAAwI;AACxI,wBAAgB,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAc7D;AAED,+HAA+H;AAC/H,wBAAgB,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAetE;AAED;;;;;;;;GAQG;AACH,wBAAsB,gBAAgB,CAAC,KAAK,EAAE,YAAY,EAAE,IAAI,EAAE,SAAS,SAAS,EAAE,EAAE,CAAC,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,GAAG,OAAO,CAAC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC,CA0BtL;AAQD,4DAA4D;AAC5D,wBAAsB,UAAU,CAAC,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAKjF"}

package/dist/sheet.js

@@ -0,0 +1,181 @@
+// The Review sheet (W-59 DoD 2): a new worksheet part, its relationship and
+// content type, a <sheet> in the workbook, and a defined name that marks it so a
+// host can skip it when the file comes back. Every cell is an inline string, so
+// sharedStrings is never touched. Links are internal hyperlinks (`location`),
+// which need no relationship.
+import { cellRef, escapeAttr, escapeText, getAttr, parseRels, relsPathOf, resolveTarget, setAttr, spError, unescapeXml } from '@sheetpane/export';
+import { COLUMNS, WIDTHS, quoteSheet } from './rows.js';
+import { CT_WORKSHEET, NS_MAIN, NS_R, REL_WORKSHEET, XML_DECL, freeName, inlineText, prefixOf, relativeTarget, } from './xml.js';
+/** The defined name that marks the Review sheet: workbook-scoped, hidden, over the table (`'Review'!$A$1:$M$4`). */
+export const REVIEW_NAME = '_sheetpane_review';
+/** Characters a sheet name may not hold. */
+const BAD = /[[\]:*?/\\]/g;
+/**
+ * A usable sheet name from what the host asked for: forbidden characters dropped, apostrophes trimmed from the ends,
+ * at most 31 characters; `Review` when nothing is left.
+ *
+ * @param name - The name asked for.
+ * @returns A name Excel accepts.
+ */
+export function cleanSheetName(name) {
+    const s = name.replace(BAD, '').replace(/^'+|'+$/g, '').trim().slice(0, 31).replace(/'+$/, '');
+    return s || 'Review';
+}
+/**
+ * A name no sheet has, compared as Excel compares them (ignoring case): `Review`, else `Review (2)`, `Review (3)`…
+ * trimmed so the whole stays within 31 characters. A user's sheet is never overwritten.
+ *
+ * @param base - The clean name.
+ * @param taken - The workbook's sheet names.
+ * @returns A free name.
+ */
+export function uniqueSheetName(base, taken) {
+    const have = new Set(taken.map((t) => t.toLowerCase()));
+    if (!have.has(base.toLowerCase()))
+        return base;
+    for (let n = 2;; n++) {
+        const tail = ` (${n})`;
+        const name = base.slice(0, 31 - tail.length).replace(/'+$/, '') + tail;
+        if (!have.has(name.toLowerCase()))
+            return name;
+    }
+}
+/** The sheet a formula like `'Q3 ''x'''!$A$1:$M$9` (or `Review!A1`) points at. */
+export function sheetOfFormula(formula) {
+    const f = formula.trim().replace(/^=/, '');
+    const q = /^'((?:[^']|'')+)'!/.exec(f);
+    if (q)
+        return q[1].replace(/''/g, "'");
+    const p = /^([^'!]+)!/.exec(f);
+    return p ? p[1] : undefined;
+}
+/**
+ * Which sheet of a workbook is a Review sheet sheetpane wrote, by its defined name — so a host can leave it out
+ * when the annotated file is uploaded again.
+ *
+ * @param book - A workbook as `@sheetpane/import` reads it (its `definedNames` and `sheets`).
+ * @returns The Review sheet's name, or undefined when the file has none.
+ * @example
+ * ```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);
+ * ```
+ * @see https://github.com/arpitarya/sheetpane/blob/main/records/0123_REVIEW.md
+ */
+export function reviewSheetOf(book) {
+    const d = book.definedNames.find((n) => n.name.toLowerCase() === REVIEW_NAME);
+    const name = d && sheetOfFormula(d.formula);
+    return name !== undefined && book.sheets.some((s) => s.name === name) ? name : undefined;
+}
+/** The worksheet XML: a frozen header row, column widths, one row per error, the Cell column's links. */
+export function sheetXml(rows, headerStyle) {
+    const last = cellRef(rows.length, COLUMNS.length - 1);
+    const cell = (r, c, text, s) => (text === '' ? '' : `<c r="${cellRef(r, c)}"${s ? ` s="${s}"` : ''} t="inlineStr">${inlineText(text)}</c>`);
+    const head = `<row r="1">${COLUMNS.map((h, c) => cell(0, c, h, headerStyle)).join('')}</row>`;
+    const body = rows.map((row, i) => `<row r="${i + 2}">${row.cells.map((t, c) => cell(i + 1, c, t)).join('')}</row>`).join('');
+    const links = rows.map((row, i) => (row.link ? `<hyperlink ref="${cellRef(i + 1, 2)}" location="${escapeAttr(row.link)}" display="${escapeAttr(row.cells[2])}"/>` : '')).join('');
+    const cols = WIDTHS.map((w, i) => `<col min="${i + 1}" max="${i + 1}" width="${w}" customWidth="1"/>`).join('');
+    return `${XML_DECL}<worksheet xmlns="${NS_MAIN}" xmlns:r="${NS_R}"><dimension ref="A1:${last}"/>`
+        + '<sheetViews><sheetView workbookViewId="0"><pane ySplit="1" topLeftCell="A2" activePane="bottomLeft" state="frozen"/><selection pane="bottomLeft" activeCell="A2" sqref="A2"/></sheetView></sheetViews>'
+        + `<sheetFormatPr defaultRowHeight="15"/><cols>${cols}</cols><sheetData>${head}${body}</sheetData>`
+        + (links ? `<hyperlinks>${links}</hyperlinks>` : '')
+        + '<pageMargins left="0.7" right="0.7" top="0.75" bottom="0.75" header="0.3" footer="0.3"/></worksheet>';
+}
+/** Puts the marker name in the workbook part, replacing an earlier one; `<definedNames>` is created in schema position when missing. */
+export function setMarker(wb, formula) {
+    const P = prefixOf(wb, 'workbook');
+    const el = `<${P}definedName name="${REVIEW_NAME}" hidden="1">${escapeText(formula)}</${P}definedName>`;
+    let out = wb.replace(new RegExp(`<(?:\\w+:)?definedName\\b[^>]*\\bname\\s*=\\s*"${REVIEW_NAME}"[^>]*?(?:/>|>[\\s\\S]*?</(?:\\w+:)?definedName>)`, 'gi'), '');
+    const self = /<(?:\w+:)?definedNames\b[^>]*\/>/.exec(out);
+    if (self)
+        return out.replace(self[0], `<${P}definedNames>${el}</${P}definedNames>`);
+    const close = new RegExp(`</(?:\\w+:)?definedNames>`).exec(out);
+    if (close)
+        return out.slice(0, close.index) + el + out.slice(close.index);
+    // CT_Workbook: … sheets, functionGroups, externalReferences, definedNames …
+    for (const name of ['externalReferences', 'functionGroups', 'sheets']) {
+        const m = new RegExp(`</(?:\\w+:)?${name}>|<(?:\\w+:)?${name}\\b[^>]*/>`).exec(out);
+        if (m) {
+            const at = m.index + m[0].length;
+            return `${out.slice(0, at)}<${P}definedNames>${el}</${P}definedNames>${out.slice(at)}`;
+        }
+    }
+    throw spError('SP-5001', 'sheetpane review: the workbook part has no <sheets>');
+}
+/** Adds `<sheet name sheetId r:id>` at the end of `<sheets>`, binding the relationships namespace on the root when missing. */
+export function addSheet(wb, name, rId) {
+    const root = /<(\w+:)?workbook\b[^>]*>/.exec(wb);
+    if (!root)
+        throw spError('SP-5001', 'sheetpane review: not a workbook part');
+    const P = root[1] ?? '';
+    let out = wb, rp = 'r';
+    const bound = [...root[0].matchAll(/\sxmlns:([\w.-]+)\s*=\s*"([^"]*)"/g)].find((m) => m[2] === NS_R);
+    if (bound)
+        rp = bound[1];
+    else {
+        if (/\sxmlns:r\s*=/.test(root[0]))
+            rp = 'spr';
+        out = out.replace(root[0], setAttr(root[0], `xmlns:${rp}`, NS_R));
+    }
+    const ids = [...out.matchAll(/<(?:\w+:)?sheet\b[^>]*>/g)].map((m) => Number(getAttr(m[0], 'sheetId') ?? 0)).filter(Number.isFinite);
+    const el = `<${P}sheet name="${escapeAttr(name)}" sheetId="${Math.max(0, ...ids) + 1}" ${rp}:id="${rId}"/>`;
+    const close = /<\/(?:\w+:)?sheets>/.exec(out);
+    if (close)
+        return out.slice(0, close.index) + el + out.slice(close.index);
+    const self = /<(?:\w+:)?sheets\b[^>]*\/>/.exec(out);
+    if (self)
+        return out.replace(self[0], `<${P}sheets>${el}</${P}sheets>`);
+    throw spError('SP-5001', 'sheetpane review: the workbook part has no <sheets>');
+}
+/**
+ * Writes the Review sheet. An earlier Review sheet this plugin wrote (the marker names it, and it has no parts of
+ * its own) is rewritten in place; otherwise a new sheet is added last, under a name no sheet has.
+ *
+ * @param patch - The export's package.
+ * @param rows - The rows, in order.
+ * @param o - The name asked for and the header's style index (none: unstyled).
+ * @returns The name and part of the sheet written.
+ */
+export async function writeReviewSheet(patch, rows, o) {
+    const wbPath = patch.workbookPath();
+    const wb = await patch.readText(wbPath);
+    if (wb === undefined)
+        throw spError('SP-5001', 'sheetpane review: no workbook part');
+    const xml = sheetXml(rows, o.headerStyle);
+    const range = `$A$1:$${cellRef(rows.length, COLUMNS.length - 1).replace(/(\d+)$/, '$$$1')}`;
+    // an earlier export's Review sheet, found by its marker: replaced, not repeated
+    const marker = [...wb.matchAll(/<(?:\w+:)?definedName\b[^>]*>([\s\S]*?)<\/(?:\w+:)?definedName>/g)].find((m) => (getAttr(m[0], 'name') ?? '').toLowerCase() === REVIEW_NAME);
+    const earlier = marker && sheetOfFormula(unescapeXml(marker[1]));
+    const earlierPath = earlier !== undefined ? patch.sheetPath(earlier) : undefined;
+    if (earlier !== undefined && earlierPath && !(await hasRelationships(patch, earlierPath))) {
+        const next = setMarker(wb, `${quoteSheet(earlier)}!${range}`);
+        patch.write(earlierPath, xml);
+        patch.write(wbPath, next);
+        return { name: earlier, path: earlierPath };
+    }
+    const name = uniqueSheetName(cleanSheetName(o.name), patch.sheetNames());
+    setMarker(addSheet(wb, name, 'rId0'), ''); // the workbook part is checked before anything is written
+    const path = freeName((p) => patch.has(p), 'xl/worksheets/sheet', '.xml');
+    patch.write(path, xml);
+    const rId = await patch.addRelationship(wbPath, REL_WORKSHEET, relativeTarget(wbPath, path));
+    await patch.setContentType(path, CT_WORKSHEET);
+    patch.write(wbPath, setMarker(addSheet(wb, name, rId), `${quoteSheet(name)}!${range}`));
+    return { name, path };
+}
+/** Whether a part has any relationship of its own (a Review sheet someone gave comments or a drawing in Excel). */
+async function hasRelationships(patch, part) {
+    const rels = await patch.readText(relsPathOf(part));
+    return !!rels && parseRels(rels).length > 0;
+}
+/** The workbook's styles part, through its relationship. */
+export async function stylesPath(patch) {
+    const wb = patch.workbookPath();
+    const rels = await patch.readText(relsPathOf(wb));
+    const r = rels && parseRels(rels).find((x) => x.type.endsWith('/styles') && x.mode !== 'External');
+    return r ? resolveTarget(wb, r.target) : undefined;
+}
+//# sourceMappingURL=sheet.js.map

package/dist/sheet.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sheet.js","sourceRoot":"","sources":["../src/sheet.ts"],"names":[],"mappings":"AAAA,4EAA4E;AAC5E,iFAAiF;AACjF,gFAAgF;AAChF,8EAA8E;AAC9E,8BAA8B;AAC9B,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,aAAa,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAClJ,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAkB,MAAM,WAAW,CAAC;AACxE,OAAO,EACL,YAAY,EAAE,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,cAAc,GACrG,MAAM,UAAU,CAAC;AAElB,oHAAoH;AACpH,MAAM,CAAC,MAAM,WAAW,GAAG,mBAAmB,CAAC;AAE/C,4CAA4C;AAC5C,MAAM,GAAG,GAAG,cAAc,CAAC;AAE3B;;;;;;GAMG;AACH,MAAM,UAAU,cAAc,CAAC,IAAY;IACzC,MAAM,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAC/F,OAAO,CAAC,IAAI,QAAQ,CAAC;AACvB,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,eAAe,CAAC,IAAY,EAAE,KAAwB;IACpE,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;IACxD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;QAAE,OAAO,IAAI,CAAC;IAC/C,KAAK,IAAI,CAAC,GAAG,CAAC,GAAI,CAAC,EAAE,EAAE,CAAC;QACtB,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC;QACvB,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC;QACvE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YAAE,OAAO,IAAI,CAAC;IACjD,CAAC;AACH,CAAC;AAED,kFAAkF;AAClF,MAAM,UAAU,cAAc,CAAC,OAAe;IAC5C,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAC3C,MAAM,CAAC,GAAG,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACvC,IAAI,CAAC;QAAE,OAAO,CAAC,CAAC,CAAC,CAAE,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACxC,MAAM,CAAC,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC/B,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AAC9B,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,aAAa,CAAC,IAAyG;IACrI,MAAM,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,WAAW,CAAC,CAAC;IAC9E,MAAM,IAAI,GAAG,CAAC,IAAI,cAAc,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;IAC5C,OAAO,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;AAC3F,CAAC;AAED,yGAAyG;AACzG,MAAM,UAAU,QAAQ,CAAC,IAA0B,EAAE,WAA+B;IAClF,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACtD,MAAM,IAAI,GAAG,CAAC,CAAS,EAAE,CAAS,EAAE,IAAY,EAAE,CAAU,EAAE,EAAE,CAAC,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,kBAAkB,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC7K,MAAM,IAAI,GAAG,cAAc,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC;IAC9F,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC7H,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,mBAAmB,OAAO,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,eAAe,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,cAAc,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAE,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACnL,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,aAAa,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,YAAY,CAAC,qBAAqB,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAChH,OAAO,GAAG,QAAQ,qBAAqB,OAAO,cAAc,IAAI,wBAAwB,IAAI,KAAK;UAC7F,wMAAwM;UACxM,+CAA+C,IAAI,qBAAqB,IAAI,GAAG,IAAI,cAAc;UACjG,CAAC,KAAK,CAAC,CAAC,CAAC,eAAe,KAAK,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC;UAClD,sGAAsG,CAAC;AAC7G,CAAC;AAED,wIAAwI;AACxI,MAAM,UAAU,SAAS,CAAC,EAAU,EAAE,OAAe;IACnD,MAAM,CAAC,GAAG,QAAQ,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC;IACnC,MAAM,EAAE,GAAG,IAAI,CAAC,qBAAqB,WAAW,gBAAgB,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,cAAc,CAAC;IACxG,IAAI,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,kDAAkD,WAAW,mDAAmD,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;IAC7J,MAAM,IAAI,GAAG,kCAAkC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC1D,IAAI,IAAI;QAAE,OAAO,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,gBAAgB,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IACpF,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,2BAA2B,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAChE,IAAI,KAAK;QAAE,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC1E,4EAA4E;IAC5E,KAAK,MAAM,IAAI,IAAI,CAAC,oBAAoB,EAAE,gBAAgB,EAAE,QAAQ,CAAC,EAAE,CAAC;QACtE,MAAM,CAAC,GAAG,IAAI,MAAM,CAAC,eAAe,IAAI,gBAAgB,IAAI,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACpF,IAAI,CAAC,EAAE,CAAC;YAAC,MAAM,EAAE,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;YAAC,OAAO,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,gBAAgB,EAAE,KAAK,CAAC,gBAAgB,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC;QAAC,CAAC;IACtI,CAAC;IACD,MAAM,OAAO,CAAC,SAAS,EAAE,qDAAqD,CAAC,CAAC;AAClF,CAAC;AAED,+HAA+H;AAC/H,MAAM,UAAU,QAAQ,CAAC,EAAU,EAAE,IAAY,EAAE,GAAW;IAC5D,MAAM,IAAI,GAAG,0BAA0B,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjD,IAAI,CAAC,IAAI;QAAE,MAAM,OAAO,CAAC,SAAS,EAAE,uCAAuC,CAAC,CAAC;IAC7E,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IACxB,IAAI,GAAG,GAAG,EAAE,EAAE,EAAE,GAAG,GAAG,CAAC;IACvB,MAAM,KAAK,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,oCAAoC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC;IACrG,IAAI,KAAK;QAAE,EAAE,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC;SACrB,CAAC;QAAC,IAAI,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAAE,EAAE,GAAG,KAAK,CAAC;QAAC,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC;IAAC,CAAC;IAC1H,MAAM,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,QAAQ,CAAC,0BAA0B,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACpI,MAAM,EAAE,GAAG,IAAI,CAAC,eAAe,UAAU,CAAC,IAAI,CAAC,cAAc,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,GAAG,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,GAAG,KAAK,CAAC;IAC5G,MAAM,KAAK,GAAG,qBAAqB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC9C,IAAI,KAAK;QAAE,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC1E,MAAM,IAAI,GAAG,4BAA4B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACpD,IAAI,IAAI;QAAE,OAAO,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IACxE,MAAM,OAAO,CAAC,SAAS,EAAE,qDAAqD,CAAC,CAAC;AAClF,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,KAAmB,EAAE,IAA0B,EAAE,CAAqD;IAC3I,MAAM,MAAM,GAAG,KAAK,CAAC,YAAY,EAAE,CAAC;IACpC,MAAM,EAAE,GAAG,MAAM,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IACxC,IAAI,EAAE,KAAK,SAAS;QAAE,MAAM,OAAO,CAAC,SAAS,EAAE,oCAAoC,CAAC,CAAC;IACrF,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,WAAW,CAAC,CAAC;IAC1C,MAAM,KAAK,GAAG,SAAS,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,CAAC;IAE5F,gFAAgF;IAChF,MAAM,MAAM,GAAG,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,kEAAkE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,WAAW,EAAE,KAAK,WAAW,CAAC,CAAC;IAC7K,MAAM,OAAO,GAAG,MAAM,IAAI,cAAc,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC;IAClE,MAAM,WAAW,GAAG,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACjF,IAAI,OAAO,KAAK,SAAS,IAAI,WAAW,IAAI,CAAC,CAAC,MAAM,gBAAgB,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC;QAC1F,MAAM,IAAI,GAAG,SAAS,CAAC,EAAE,EAAE,GAAG,UAAU,CAAC,OAAO,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC;QAC9D,KAAK,CAAC,KAAK,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;QAC9B,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAC1B,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;IAC9C,CAAC;IAED,MAAM,IAAI,GAAG,eAAe,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,UAAU,EAAE,CAAC,CAAC;IACzE,SAAS,CAAC,QAAQ,CAAC,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,0DAA0D;IACrG,MAAM,IAAI,GAAG,QAAQ,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,MAAM,CAAC,CAAC;IAC1E,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IACvB,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,eAAe,CAAC,MAAM,EAAE,aAAa,EAAE,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;IAC7F,MAAM,KAAK,CAAC,cAAc,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;IAC/C,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,SAAS,CAAC,QAAQ,CAAC,EAAE,EAAE,IAAI,EAAE,GAAG,CAAC,EAAE,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC;IACxF,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;AACxB,CAAC;AAED,mHAAmH;AACnH,KAAK,UAAU,gBAAgB,CAAC,KAAmB,EAAE,IAAY;IAC/D,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;IACpD,OAAO,CAAC,CAAC,IAAI,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;AAC9C,CAAC;AAED,4DAA4D;AAC5D,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,KAAmB;IAClD,MAAM,EAAE,GAAG,KAAK,CAAC,YAAY,EAAE,CAAC;IAChC,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;IAClD,MAAM,CAAC,GAAG,IAAI,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC;IACnG,OAAO,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACrD,CAAC"}

package/dist/write.d.ts

@@ -0,0 +1,53 @@
+import { type Severity, type SheetpaneError, type SpCode } from '@sheetpane/grid';
+import type { PatchContext } from './xml.js';
+/** Why an error's cells were not (or not all) coloured. */
+export type SkipReason = 'no-cell' | 'no-sheet' | 'bad-range' | 'range-capped' | 'no-styles' | 'unreadable-part';
+/** What one export wrote. */
+export interface ReviewReport {
+    /** The Review sheet's name as written (`Review`, or `Review (2)` beside a user's own *Review*); undefined when none was written. */
+    sheet: string | undefined;
+    /** The ids listed on the Review sheet, in its order. */
+    listed: string[];
+    /** The listed errors by status: an accepted error (W-69) is never counted with the open ones. */
+    counts: {
+        open: number;
+        accepted: number;
+        resolved: number;
+    };
+    /** The ids whose cells were coloured. */
+    filled: string[];
+    /**
+     * Errors whose cells were not coloured, and why: `no-cell` — about a whole sheet or the workbook (W-55), listed,
+     * never coloured; `no-sheet` / `bad-range` — nowhere to colour; `range-capped` — over 10,000 cells, so only the
+     * cells the file has were coloured (SP-5003); `no-styles` — the file has no readable styles part (SP-5004);
+     * `unreadable-part` — the sheet could not be read, so it was left as it was (SP-5002).
+     */
+    skipped: {
+        id: string;
+        reason: SkipReason;
+        code?: SpCode;
+    }[];
+}
+/** How one export writes. */
+export interface WriteOptions {
+    /** Write the Review sheet. */
+    sheet: boolean;
+    /** Colour flagged cells. */
+    fill: boolean;
+    /** The Review sheet's name, as asked for. */
+    sheetName: string;
+    /** Severity → ARGB fill; a severity not named is not coloured. */
+    fills: Readonly<Record<string, string>>;
+    /** Severities, worst first: on a cell flagged twice, the worse one's fill wins. */
+    order: readonly Severity[];
+}
+/**
+ * Writes the review into the package.
+ *
+ * @param patch - The export's package.
+ * @param errors - The errors to list, in order (already selected).
+ * @param o - What to write.
+ * @returns What was written and skipped.
+ */
+export declare function writeReview(patch: PatchContext, errors: readonly SheetpaneError[], o: WriteOptions): Promise<ReviewReport>;
+//# sourceMappingURL=write.d.ts.map

package/dist/write.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"write.d.ts","sourceRoot":"","sources":["../src/write.ts"],"names":[],"mappings":"AAIA,OAAO,EAAyB,KAAK,QAAQ,EAAE,KAAK,cAAc,EAAE,KAAK,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAKzG,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAE7C,2DAA2D;AAC3D,MAAM,MAAM,UAAU,GAAG,SAAS,GAAG,UAAU,GAAG,WAAW,GAAG,cAAc,GAAG,WAAW,GAAG,iBAAiB,CAAC;AAEjH,6BAA6B;AAC7B,MAAM,WAAW,YAAY;IAC3B,oIAAoI;IACpI,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,wDAAwD;IACxD,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,iGAAiG;IACjG,MAAM,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC;IAC7D,yCAAyC;IACzC,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB;;;;;OAKG;IACH,OAAO,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,UAAU,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CAC9D;AAED,6BAA6B;AAC7B,MAAM,WAAW,YAAY;IAC3B,8BAA8B;IAC9B,KAAK,EAAE,OAAO,CAAC;IACf,4BAA4B;IAC5B,IAAI,EAAE,OAAO,CAAC;IACd,6CAA6C;IAC7C,SAAS,EAAE,MAAM,CAAC;IAClB,kEAAkE;IAClE,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACxC,mFAAmF;IACnF,KAAK,EAAE,SAAS,QAAQ,EAAE,CAAC;CAC5B;AAED;;;;;;;GAOG;AACH,wBAAsB,WAAW,CAAC,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,SAAS,cAAc,EAAE,EAAE,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC,CAuDhI"}

package/dist/write.js

@@ -0,0 +1,99 @@
+// exportPatch: the whole review write — fills first (each sheet's flagged
+// cells), then the Review sheet, then the styles part once with every fill and
+// cloned format appended. A part that cannot be read is left as it was, and
+// what was not written is reported (W-59 DoD 2, 3, 5).
+import { errorScope, spMessage } from '@sheetpane/grid';
+import { parseRange, spError } from '@sheetpane/export';
+import { HEADER_FILL, StyleBook, fillSheet, planRange } from './fills.js';
+import { rowOf } from './rows.js';
+import { stylesPath, writeReviewSheet } from './sheet.js';
+/**
+ * Writes the review into the package.
+ *
+ * @param patch - The export's package.
+ * @param errors - The errors to list, in order (already selected).
+ * @param o - What to write.
+ * @returns What was written and skipped.
+ */
+export async function writeReview(patch, errors, o) {
+    const report = { sheet: undefined, listed: [], filled: [], skipped: [], counts: { open: 0, accepted: 0, resolved: 0 } };
+    const rank = (s) => { const i = o.order.findIndex((x) => x === s); return i < 0 ? o.order.length : i; };
+    const sp = await stylesPath(patch);
+    let book;
+    try {
+        const x = sp ? await patch.readText(sp) : undefined;
+        book = x === undefined ? undefined : new StyleBook(x);
+    }
+    catch {
+        book = undefined;
+    }
+    // 1 · the flagged cells: open errors at a cell, with a fill for their severity
+    if (o.fill) {
+        const bySheet = new Map();
+        for (const e of errors) {
+            if (e.status !== 'open' || !o.fills[e.severity])
+                continue; // an accepted or resolved error is not a problem
+            if (errorScope(e) !== 'cell') {
+                report.skipped.push({ id: e.id, reason: 'no-cell' });
+                continue;
+            }
+            if (!patch.sheetPath(e.sheet)) {
+                report.skipped.push({ id: e.id, reason: 'no-sheet' });
+                continue;
+            }
+            const r = parseRange(e.range.replace(/\$/g, ''));
+            if (!r) {
+                report.skipped.push({ id: e.id, reason: 'bad-range' });
+                continue;
+            }
+            if (!book) {
+                report.skipped.push({ id: e.id, reason: 'no-styles', code: 'SP-5004' });
+                continue;
+            }
+            (bySheet.get(e.sheet) ?? bySheet.set(e.sheet, []).get(e.sheet)).push({ e, r });
+        }
+        for (const [sheet, items] of bySheet) {
+            const path = patch.sheetPath(sheet);
+            const plan = { cells: new Map(), wide: [] };
+            const capped = [];
+            for (const { e, r } of items)
+                if (!planRange(plan, r, e.severity, rank))
+                    capped.push(e.id);
+            try {
+                const xml = await patch.readText(path);
+                if (xml === undefined)
+                    throw spError('SP-5002', `sheetpane review: no part ${path}`);
+                patch.write(path, fillSheet(xml, plan, rank, (s, sev) => book.clone(s, o.fills[sev])));
+                report.filled.push(...items.map(({ e }) => e.id));
+                for (const id of capped)
+                    report.skipped.push({ id, reason: 'range-capped', code: 'SP-5003' });
+            }
+            catch (err) {
+                console.error(spMessage('SP-5002', `sheetpane review: cells on sheet "${sheet}" not coloured`), err);
+                for (const { e } of items)
+                    report.skipped.push({ id: e.id, reason: 'unreadable-part', code: 'SP-5002' });
+            }
+        }
+    }
+    // 2 · the Review sheet
+    if (o.sheet) {
+        const names = new Set(patch.sheetNames());
+        const rows = errors.map((e) => rowOf(e, (n) => names.has(n)));
+        try {
+            const written = await writeReviewSheet(patch, rows, { name: o.sheetName, headerStyle: book?.clone(0, HEADER_FILL) });
+            report.sheet = written.name;
+            report.listed = errors.map((e) => e.id);
+            for (const e of errors)
+                if (e.status === 'open' || e.status === 'accepted' || e.status === 'resolved')
+                    report.counts[e.status]++;
+        }
+        catch (err) {
+            console.error(spMessage('SP-5001', 'sheetpane review: the Review sheet was not written'), err);
+        }
+    }
+    // 3 · the styles part, once
+    if (sp && book?.changed)
+        patch.write(sp, book.toXml());
+    return report;
+}
+//# sourceMappingURL=write.js.map

package/dist/write.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"write.js","sourceRoot":"","sources":["../src/write.ts"],"names":[],"mappings":"AAAA,0EAA0E;AAC1E,+EAA+E;AAC/E,4EAA4E;AAC5E,uDAAuD;AACvD,OAAO,EAAE,UAAU,EAAE,SAAS,EAAmD,MAAM,iBAAiB,CAAC;AACzG,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAiB,MAAM,YAAY,CAAC;AACzF,OAAO,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAuC1D;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,KAAmB,EAAE,MAAiC,EAAE,CAAe;IACvG,MAAM,MAAM,GAAiB,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC;IACtI,MAAM,IAAI,GAAG,CAAC,CAAS,EAAE,EAAE,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAEhH,MAAM,EAAE,GAAG,MAAM,UAAU,CAAC,KAAK,CAAC,CAAC;IACnC,IAAI,IAA2B,CAAC;IAChC,IAAI,CAAC;QAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAAC,IAAI,GAAG,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC;IAAC,CAAC;IAAC,MAAM,CAAC;QAAC,IAAI,GAAG,SAAS,CAAC;IAAC,CAAC;IAE/I,+EAA+E;IAC/E,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;QACX,MAAM,OAAO,GAAG,IAAI,GAAG,EAAkF,CAAC;QAC1G,KAAK,MAAM,CAAC,IAAI,MAAM,EAAE,CAAC;YACvB,IAAI,CAAC,CAAC,MAAM,KAAK,MAAM,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC;gBAAE,SAAS,CAAC,iDAAiD;YAC5G,IAAI,UAAU,CAAC,CAAC,CAAC,KAAK,MAAM,EAAE,CAAC;gBAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;gBAAC,SAAS;YAAC,CAAC;YACjG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;gBAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC;gBAAC,SAAS;YAAC,CAAC;YACnG,MAAM,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;YACjD,IAAI,CAAC,CAAC,EAAE,CAAC;gBAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC;gBAAC,SAAS;YAAC,CAAC;YAC7E,IAAI,CAAC,IAAI,EAAE,CAAC;gBAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;gBAAC,SAAS;YAAC,CAAC;YACjG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAE,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;QAClF,CAAC;QACD,KAAK,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,OAAO,EAAE,CAAC;YACrC,MAAM,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC,KAAK,CAAE,CAAC;YACrC,MAAM,IAAI,GAAa,EAAE,KAAK,EAAE,IAAI,GAAG,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;YACtD,MAAM,MAAM,GAAa,EAAE,CAAC;YAC5B,KAAK,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,KAAK;gBAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE,IAAI,CAAC;oBAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YAC3F,IAAI,CAAC;gBACH,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBACvC,IAAI,GAAG,KAAK,SAAS;oBAAE,MAAM,OAAO,CAAC,SAAS,EAAE,6BAA6B,IAAI,EAAE,CAAC,CAAC;gBACrF,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,CAAC,IAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAE,CAAC,CAAC,CAAC,CAAC;gBACzF,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gBAClD,KAAK,MAAM,EAAE,IAAI,MAAM;oBAAE,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,cAAc,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;YAChG,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,SAAS,EAAE,qCAAqC,KAAK,gBAAgB,CAAC,EAAE,GAAG,CAAC,CAAC;gBACrG,KAAK,MAAM,EAAE,CAAC,EAAE,IAAI,KAAK;oBAAE,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,iBAAiB,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;YAC3G,CAAC;QACH,CAAC;IACH,CAAC;IAED,uBAAuB;IACvB,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC;QACZ,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC,CAAC;QAC1C,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC9D,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,MAAM,gBAAgB,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,SAAS,EAAE,WAAW,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC,EAAE,CAAC,CAAC;YACrH,MAAM,CAAC,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;YAC5B,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YACxC,KAAK,MAAM,CAAC,IAAI,MAAM;gBAAE,IAAI,CAAC,CAAC,MAAM,KAAK,MAAM,IAAI,CAAC,CAAC,MAAM,KAAK,UAAU,IAAI,CAAC,CAAC,MAAM,KAAK,UAAU;oBAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC;QACnI,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,SAAS,EAAE,oDAAoD,CAAC,EAAE,GAAG,CAAC,CAAC;QACjG,CAAC;IACH,CAAC;IAED,4BAA4B;IAC5B,IAAI,EAAE,IAAI,IAAI,EAAE,OAAO;QAAE,KAAK,CAAC,KAAK,CAAC,EAAE,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;IACvD,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/xml.d.ts

@@ -0,0 +1,23 @@
+import type { Plugin } from '@sheetpane/grid';
+/** What `exportPatch` is handed: the package, through `@sheetpane/export`'s context. */
+export type PatchContext = Parameters<NonNullable<Plugin['exportPatch']>>[0];
+export declare const XML_DECL = "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n";
+export declare const NS_MAIN = "http://schemas.openxmlformats.org/spreadsheetml/2006/main";
+export declare const NS_R = "http://schemas.openxmlformats.org/officeDocument/2006/relationships";
+export declare const REL_WORKSHEET = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/worksheet";
+export declare const CT_WORKSHEET = "application/vnd.openxmlformats-officedocument.spreadsheetml.worksheet+xml";
+/** The most text a cell holds. */
+export declare const MAX_TEXT = 32767;
+/** An element, self-closed or not, by local name (any prefix): `<x:xf …/>` or `<xf …>…</xf>`. */
+export declare const elementRe: (name: string, flags?: string) => RegExp;
+/** The opening tag of an element's text. */
+export declare const openTag: (xml: string) => string;
+/** A cell's text as an inline-string body: cleaned of what XML forbids, at most 32,767 characters, SpreadsheetML-escaped. */
+export declare function inlineText(s: string, P?: string): string;
+/** The relative target from one part to another: `xl/workbook.xml` → `xl/worksheets/sheet3.xml` is `worksheets/sheet3.xml`. */
+export declare function relativeTarget(fromPart: string, toPart: string): string;
+/** A part name that does not exist yet: `prefix` + n + `suffix`, smallest n from 1. */
+export declare function freeName(has: (p: string) => boolean, prefix: string, suffix: string): string;
+/** The namespace prefix (with its colon, or `''`) the root element of a part uses. */
+export declare const prefixOf: (xml: string, root: string) => string;
+//# sourceMappingURL=xml.d.ts.map