@dou-ui/sheet 0.0.0-stage → 0.1.0-alpha.0

package/dist/core/clipboard.js

@@ -0,0 +1,141 @@
+import { formatValue, parseInput } from "./format.js";
+import { cellOf, valueOf } from "./model.js";
+import { shownValue } from "../formula/values.js";
+import { parseCSV } from "./csv.js";
+import { linkTarget } from "./link.js";
+// src/core/clipboard.ts
+var MARK = "data-dou-sheet";
+/** A cell's text in tab-separated text: quoted when it has a tab, a line break or a quote. */
+function tsvField(text) {
+	return /[\t\n\r"]/.test(text) ? `"${text.replaceAll("\"", "\"\"")}"` : text;
+}
+var escapeHTML = (text) => text.replace(/[&<>"']/g, (c) => `&#${c.charCodeAt(0)};`);
+function cssOf(style, align) {
+	if (!style && !align) return "";
+	let css = "";
+	if (style?.bold) css += "font-weight:bold;";
+	if (style?.italic) css += "font-style:italic;";
+	const lines = [style?.underline && "underline", style?.strike && "line-through"].filter(Boolean);
+	if (lines.length) css += `text-decoration:${lines.join(" ")};`;
+	if (style?.color) css += `color:${style.color};`;
+	if (style?.background) css += `background-color:${style.background};`;
+	if (style?.wrap) css += "white-space:pre-wrap;";
+	const textAlign = style?.align ?? align;
+	if (textAlign) css += `text-align:${textAlign};`;
+	return css;
+}
+/** The clipboard's text and HTML for a block of cells, with the text as the cells show it. */
+function formatClip(clip, options = {}) {
+	const { locale, text: textOf, result } = options;
+	const styles = clip.styles ?? {};
+	const text = [];
+	let rows = "";
+	for (const [row, line] of clip.cells.entries()) {
+		const fields = [];
+		let cols = "";
+		for (const [col, input] of line.entries()) {
+			const cell = cellOf(input);
+			const value = shownValue(valueOf(input), result, row, col);
+			const shown = textOf?.(input, value) ?? formatValue(value, cell?.format, locale);
+			fields.push(tsvField(shown));
+			const css = cssOf(cell?.style ? styles[cell.style] : void 0, typeof value === "number" ? "right" : void 0);
+			let body = escapeHTML(shown).replaceAll("\n", "<br>");
+			const target = linkTarget(cell?.link);
+			if (target?.kind === "web") body = `<a href="${escapeHTML(target.href)}">${body}</a>`;
+			cols += `<td${css ? ` style="${css}"` : ""}>${body}</td>`;
+		}
+		text.push(fields.join("	"));
+		rows += `<tr>${cols}</tr>`;
+	}
+	const data = escapeHTML(JSON.stringify(clip));
+	return {
+		text: text.join("\n"),
+		html: `<table ${MARK}="${data}" style="border-collapse:collapse"><tbody>${rows}</tbody></table>`
+	};
+}
+/** Splits tab-separated text into rows of fields, reading quoted fields. */
+function parseTSV(text) {
+	return parseCSV(text, "	");
+}
+/** The text a table cell shows, with its line breaks. */
+function cellText(cell) {
+	let text = "";
+	const walk = (node) => {
+		if (node.nodeType === 3) text += node.textContent?.replace(/\s+/g, " ") ?? "";
+		else if (node.nodeName === "BR") text += "\n";
+		else {
+			if (/^(P|DIV|LI)$/.test(node.nodeName) && text !== "" && !text.endsWith("\n")) text += "\n";
+			node.childNodes.forEach(walk);
+		}
+	};
+	walk(cell);
+	return text.replace(/ *\n */g, "\n").trim();
+}
+/** Reads a typed-looking text into a cell, keeping the format it implies. */
+function inputOf(text) {
+	const { value, format } = parseInput(text);
+	if (value == null) return void 0;
+	return format ? {
+		value,
+		format
+	} : value;
+}
+/** Reads a table from HTML: rows and cells, with merged cells spread over the cells they cover. */
+function readTable(table) {
+	const out = [];
+	const taken = [];
+	let r = 0;
+	for (const tr of table.querySelectorAll("tr")) {
+		if (tr.closest("table") !== table) continue;
+		const line = out[r] ??= [];
+		let c = 0;
+		for (const td of tr.children) {
+			if (td.nodeName !== "TD" && td.nodeName !== "TH") continue;
+			while (taken[r]?.[c]) c++;
+			line[c] = inputOf(cellText(td));
+			const anchors = td.querySelectorAll("a[href]");
+			const href = anchors.length === 1 ? anchors[0].getAttribute("href") : null;
+			const target = href ? linkTarget(href) : null;
+			if (target?.kind === "web") line[c] = {
+				...cellOf(line[c]),
+				link: target.href
+			};
+			const rowSpan = Math.max(1, Number(td.getAttribute("rowspan")) || 1);
+			const colSpan = Math.max(1, Number(td.getAttribute("colspan")) || 1);
+			for (let dr = 0; dr < rowSpan; dr++) for (let dc = 0; dc < colSpan; dc++) {
+				if (dr === 0 && dc === 0) continue;
+				(taken[r + dr] ??= [])[c + dc] = true;
+				if (dr === 0) line[c + dc] = void 0;
+			}
+			c += colSpan;
+		}
+		r++;
+	}
+	return out.map((line) => Array.from(line, (cell) => cell));
+}
+/**
+* Reads what was pasted. Cells copied from a sheet come back as they were;
+* a table from elsewhere, or tab-separated text, comes back as values read
+* the way typing them would, with formats such as `0%` they imply.
+* `null` when there is nothing to paste.
+*/
+function parseClip(data) {
+	if (data.html && typeof DOMParser !== "undefined") {
+		const page = new DOMParser().parseFromString(data.html, "text/html");
+		const marked = page.querySelector(`table[${MARK}]`);
+		if (marked) try {
+			const clip = JSON.parse(marked.getAttribute(MARK));
+			if (Array.isArray(clip.cells)) return clip;
+		} catch {}
+		const table = page.querySelector("table");
+		if (table) {
+			const cells = readTable(table);
+			if (cells.length) return { cells };
+		}
+	}
+	if (data.text == null || data.text === "") return null;
+	return { cells: parseTSV(data.text.replace(/\r?\n$/, "")).map((line) => line.map(inputOf)) };
+}
+export { formatClip, parseClip, parseTSV };
+
+//# sourceMappingURL=clipboard.js.map

package/dist/core/clipboard.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clipboard.js","names":[],"sources":["../../src/core/clipboard.ts"],"sourcesContent":["import { parseCSV } from './csv'\nimport { formatValue, parseInput } from './format'\nimport { linkTarget } from './link'\nimport { cellOf, valueOf, type SheetCellInput, type SheetStyle, type SheetValue } from './model'\nimport { shownValue, type SheetResult } from '../formula/values'\n\n/*\n * Copying cells out as text and as a table, and reading them back from\n * either, so a block of cells moves between this grid, other spreadsheet\n * programs and web pages.\n *\n * Plain text is tab-separated, one row per line, with what each cell shows.\n * The table carries the same text with simple formatting for programs that\n * read tables, and the cells themselves (values, formats and styles) for\n * pasting into a sheet again without losing anything.\n */\n\n/** A block of cells on the clipboard. */\nexport interface SheetClip {\n  /** The cells, row by row. */\n  cells: SheetCellInput[][]\n  /** The named styles the cells use. */\n  styles?: Record<string, SheetStyle>\n  /** Where the block was copied from, so formulas can move along when pasted. */\n  from?: { row: number; col: number }\n  /** Set when the block was cut: pasting it moves the cells. */\n  cut?: string\n}\n\nconst MARK = 'data-dou-sheet'\n\n/** A cell's text in tab-separated text: quoted when it has a tab, a line break or a quote. */\nfunction tsvField(text: string) {\n  return /[\\t\\n\\r\"]/.test(text) ? `\"${text.replaceAll('\"', '\"\"')}\"` : text\n}\n\nconst escapeHTML = (text: string) => text.replace(/[&<>\"']/g, (c) => `&#${c.charCodeAt(0)};`)\n\nfunction cssOf(style: SheetStyle | undefined, align: string | undefined) {\n  if (!style && !align) return ''\n  let css = ''\n  if (style?.bold) css += 'font-weight:bold;'\n  if (style?.italic) css += 'font-style:italic;'\n  const lines = [style?.underline && 'underline', style?.strike && 'line-through'].filter(Boolean)\n  if (lines.length) css += `text-decoration:${lines.join(' ')};`\n  if (style?.color) css += `color:${style.color};`\n  if (style?.background) css += `background-color:${style.background};`\n  if (style?.wrap) css += 'white-space:pre-wrap;'\n  const textAlign = style?.align ?? align\n  if (textAlign) css += `text-align:${textAlign};`\n  return css\n}\n\n/** How `formatClip` writes cells as text. */\nexport interface SheetClipFormat {\n  /** The language dates are shown in. */\n  locale?: string\n  /**\n   * What a formula comes to, by its row and column in the clip, e.g. from\n   * `SheetFormulaEngine.result`; the formula itself by default.\n   */\n  result?: (row: number, col: number) => SheetResult\n  /**\n   * A cell's text, e.g. as its cell type shows it; `undefined` uses its\n   * format. `value` is its value, or its formula's result.\n   */\n  text?: (input: SheetCellInput, value: SheetValue) => string | undefined\n}\n\n/** The clipboard's text and HTML for a block of cells, with the text as the cells show it. */\nexport function formatClip(clip: SheetClip, options: SheetClipFormat = {}) {\n  const { locale, text: textOf, result } = options\n  const styles = clip.styles ?? {}\n  const text: string[] = []\n  let rows = ''\n  for (const [row, line] of clip.cells.entries()) {\n    const fields: string[] = []\n    let cols = ''\n    for (const [col, input] of line.entries()) {\n      const cell = cellOf(input)\n      const value = shownValue(valueOf(input), result, row, col)\n      const shown = textOf?.(input, value) ?? formatValue(value, cell?.format, locale)\n      fields.push(tsvField(shown))\n      const style = cell?.style ? styles[cell.style] : undefined\n      const css = cssOf(style, typeof value === 'number' ? 'right' : undefined)\n      let body = escapeHTML(shown).replaceAll('\\n', '<br>')\n      // a link to a web page stays one in other programs\n      const target = linkTarget(cell?.link)\n      if (target?.kind === 'web') body = `<a href=\"${escapeHTML(target.href)}\">${body}</a>`\n      cols += `<td${css ? ` style=\"${css}\"` : ''}>${body}</td>`\n    }\n    text.push(fields.join('\\t'))\n    rows += `<tr>${cols}</tr>`\n  }\n  const data = escapeHTML(JSON.stringify(clip))\n  return {\n    text: text.join('\\n'),\n    html: `<table ${MARK}=\"${data}\" style=\"border-collapse:collapse\"><tbody>${rows}</tbody></table>`,\n  }\n}\n\n/** Splits tab-separated text into rows of fields, reading quoted fields. */\nexport function parseTSV(text: string): string[][] {\n  return parseCSV(text, '\\t')\n}\n\n/** The text a table cell shows, with its line breaks. */\nfunction cellText(cell: Element) {\n  let text = ''\n  const walk = (node: Node) => {\n    if (node.nodeType === 3) text += node.textContent?.replace(/\\s+/g, ' ') ?? ''\n    else if (node.nodeName === 'BR') text += '\\n'\n    else {\n      const block = /^(P|DIV|LI)$/.test(node.nodeName) && text !== '' && !text.endsWith('\\n')\n      if (block) text += '\\n'\n      node.childNodes.forEach(walk)\n    }\n  }\n  walk(cell)\n  return text.replace(/ *\\n */g, '\\n').trim()\n}\n\n/** Reads a typed-looking text into a cell, keeping the format it implies. */\nfunction inputOf(text: string): SheetCellInput {\n  const { value, format } = parseInput(text)\n  if (value == null) return undefined\n  return format ? { value, format } : value\n}\n\n/** Reads a table from HTML: rows and cells, with merged cells spread over the cells they cover. */\nfunction readTable(table: Element): SheetCellInput[][] {\n  const out: SheetCellInput[][] = []\n  // cells taken by a row span from above\n  const taken: boolean[][] = []\n  let r = 0\n  for (const tr of table.querySelectorAll('tr')) {\n    if (tr.closest('table') !== table) continue\n    const line = (out[r] ??= [])\n    let c = 0\n    for (const td of tr.children) {\n      if (td.nodeName !== 'TD' && td.nodeName !== 'TH') continue\n      while (taken[r]?.[c]) c++\n      line[c] = inputOf(cellText(td))\n      // a cell that is one link to a web page keeps it\n      const anchors = td.querySelectorAll('a[href]')\n      const href = anchors.length === 1 ? anchors[0]!.getAttribute('href') : null\n      const target = href ? linkTarget(href) : null\n      if (target?.kind === 'web') line[c] = { ...cellOf(line[c]), link: target.href }\n      const rowSpan = Math.max(1, Number(td.getAttribute('rowspan')) || 1)\n      const colSpan = Math.max(1, Number(td.getAttribute('colspan')) || 1)\n      for (let dr = 0; dr < rowSpan; dr++)\n        for (let dc = 0; dc < colSpan; dc++) {\n          if (dr === 0 && dc === 0) continue\n          ;(taken[r + dr] ??= [])[c + dc] = true\n          if (dr === 0) line[c + dc] = undefined\n        }\n      c += colSpan\n    }\n    r++\n  }\n  return out.map((line) => Array.from(line, (cell) => cell))\n}\n\n/**\n * Reads what was pasted. Cells copied from a sheet come back as they were;\n * a table from elsewhere, or tab-separated text, comes back as values read\n * the way typing them would, with formats such as `0%` they imply.\n * `null` when there is nothing to paste.\n */\nexport function parseClip(data: { html?: string; text?: string }): SheetClip | null {\n  if (data.html && typeof DOMParser !== 'undefined') {\n    const page = new DOMParser().parseFromString(data.html, 'text/html')\n    const marked = page.querySelector(`table[${MARK}]`)\n    if (marked) {\n      try {\n        const clip = JSON.parse(marked.getAttribute(MARK)!) as SheetClip\n        if (Array.isArray(clip.cells)) return clip\n      } catch {\n        // not ours after all: read it as a table\n      }\n    }\n    const table = page.querySelector('table')\n    if (table) {\n      const cells = readTable(table)\n      if (cells.length) return { cells }\n    }\n  }\n  if (data.text == null || data.text === '') return null\n  // a single line copied from a page may end with a line break\n  const text = data.text.replace(/\\r?\\n$/, '')\n  return { cells: parseTSV(text).map((line) => line.map(inputOf)) }\n}\n"],"mappings":";;;;;;AA6BA,IAAM,OAAO;;AAGb,SAAS,SAAS,MAAc;CAC9B,OAAO,YAAY,KAAK,IAAI,IAAI,IAAI,KAAK,WAAW,MAAK,MAAI,EAAE,KAAK;AACtE;AAEA,IAAM,cAAc,SAAiB,KAAK,QAAQ,aAAa,MAAM,KAAK,EAAE,WAAW,CAAC,EAAE,EAAE;AAE5F,SAAS,MAAM,OAA+B,OAA2B;CACvE,IAAI,CAAC,SAAS,CAAC,OAAO,OAAO;CAC7B,IAAI,MAAM;CACV,IAAI,OAAO,MAAM,OAAO;CACxB,IAAI,OAAO,QAAQ,OAAO;CAC1B,MAAM,QAAQ,CAAC,OAAO,aAAa,aAAa,OAAO,UAAU,cAAc,CAAC,CAAC,OAAO,OAAO;CAC/F,IAAI,MAAM,QAAQ,OAAO,mBAAmB,MAAM,KAAK,GAAG,EAAE;CAC5D,IAAI,OAAO,OAAO,OAAO,SAAS,MAAM,MAAM;CAC9C,IAAI,OAAO,YAAY,OAAO,oBAAoB,MAAM,WAAW;CACnE,IAAI,OAAO,MAAM,OAAO;CACxB,MAAM,YAAY,OAAO,SAAS;CAClC,IAAI,WAAW,OAAO,cAAc,UAAU;CAC9C,OAAO;AACT;;AAmBA,SAAgB,WAAW,MAAiB,UAA2B,CAAC,GAAG;CACzE,MAAM,EAAE,QAAQ,MAAM,QAAQ,WAAW;CACzC,MAAM,SAAS,KAAK,UAAU,CAAC;CAC/B,MAAM,OAAiB,CAAC;CACxB,IAAI,OAAO;CACX,KAAK,MAAM,CAAC,KAAK,SAAS,KAAK,MAAM,QAAQ,GAAG;EAC9C,MAAM,SAAmB,CAAC;EAC1B,IAAI,OAAO;EACX,KAAK,MAAM,CAAC,KAAK,UAAU,KAAK,QAAQ,GAAG;GACzC,MAAM,OAAO,OAAO,KAAK;GACzB,MAAM,QAAQ,WAAW,QAAQ,KAAK,GAAG,QAAQ,KAAK,GAAG;GACzD,MAAM,QAAQ,SAAS,OAAO,KAAK,KAAK,YAAY,OAAO,MAAM,QAAQ,MAAM;GAC/E,OAAO,KAAK,SAAS,KAAK,CAAC;GAE3B,MAAM,MAAM,MADE,MAAM,QAAQ,OAAO,KAAK,SAAS,KAAA,GACxB,OAAO,UAAU,WAAW,UAAU,KAAA,CAAS;GACxE,IAAI,OAAO,WAAW,KAAK,CAAC,CAAC,WAAW,MAAM,MAAM;GAEpD,MAAM,SAAS,WAAW,MAAM,IAAI;GACpC,IAAI,QAAQ,SAAS,OAAO,OAAO,YAAY,WAAW,OAAO,IAAI,EAAE,IAAI,KAAK;GAChF,QAAQ,MAAM,MAAM,WAAW,IAAI,KAAK,GAAG,GAAG,KAAK;EACrD;EACA,KAAK,KAAK,OAAO,KAAK,GAAI,CAAC;EAC3B,QAAQ,OAAO,KAAK;CACtB;CACA,MAAM,OAAO,WAAW,KAAK,UAAU,IAAI,CAAC;CAC5C,OAAO;EACL,MAAM,KAAK,KAAK,IAAI;EACpB,MAAM,UAAU,KAAK,IAAI,KAAK,4CAA4C,KAAK;CACjF;AACF;;AAGA,SAAgB,SAAS,MAA0B;CACjD,OAAO,SAAS,MAAM,GAAI;AAC5B;;AAGA,SAAS,SAAS,MAAe;CAC/B,IAAI,OAAO;CACX,MAAM,QAAQ,SAAe;EAC3B,IAAI,KAAK,aAAa,GAAG,QAAQ,KAAK,aAAa,QAAQ,QAAQ,GAAG,KAAK;OACtE,IAAI,KAAK,aAAa,MAAM,QAAQ;OACpC;GAEH,IADc,eAAe,KAAK,KAAK,QAAQ,KAAK,SAAS,MAAM,CAAC,KAAK,SAAS,IAAI,GAC3E,QAAQ;GACnB,KAAK,WAAW,QAAQ,IAAI;EAC9B;CACF;CACA,KAAK,IAAI;CACT,OAAO,KAAK,QAAQ,WAAW,IAAI,CAAC,CAAC,KAAK;AAC5C;;AAGA,SAAS,QAAQ,MAA8B;CAC7C,MAAM,EAAE,OAAO,WAAW,WAAW,IAAI;CACzC,IAAI,SAAS,MAAM,OAAO,KAAA;CAC1B,OAAO,SAAS;EAAE;EAAO;CAAO,IAAI;AACtC;;AAGA,SAAS,UAAU,OAAoC;CACrD,MAAM,MAA0B,CAAC;CAEjC,MAAM,QAAqB,CAAC;CAC5B,IAAI,IAAI;CACR,KAAK,MAAM,MAAM,MAAM,iBAAiB,IAAI,GAAG;EAC7C,IAAI,GAAG,QAAQ,OAAO,MAAM,OAAO;EACnC,MAAM,OAAQ,IAAI,OAAO,CAAC;EAC1B,IAAI,IAAI;EACR,KAAK,MAAM,MAAM,GAAG,UAAU;GAC5B,IAAI,GAAG,aAAa,QAAQ,GAAG,aAAa,MAAM;GAClD,OAAO,MAAM,EAAE,GAAG,IAAI;GACtB,KAAK,KAAK,QAAQ,SAAS,EAAE,CAAC;GAE9B,MAAM,UAAU,GAAG,iBAAiB,SAAS;GAC7C,MAAM,OAAO,QAAQ,WAAW,IAAI,QAAQ,EAAE,CAAE,aAAa,MAAM,IAAI;GACvE,MAAM,SAAS,OAAO,WAAW,IAAI,IAAI;GACzC,IAAI,QAAQ,SAAS,OAAO,KAAK,KAAK;IAAE,GAAG,OAAO,KAAK,EAAE;IAAG,MAAM,OAAO;GAAK;GAC9E,MAAM,UAAU,KAAK,IAAI,GAAG,OAAO,GAAG,aAAa,SAAS,CAAC,KAAK,CAAC;GACnE,MAAM,UAAU,KAAK,IAAI,GAAG,OAAO,GAAG,aAAa,SAAS,CAAC,KAAK,CAAC;GACnE,KAAK,IAAI,KAAK,GAAG,KAAK,SAAS,MAC7B,KAAK,IAAI,KAAK,GAAG,KAAK,SAAS,MAAM;IACnC,IAAI,OAAO,KAAK,OAAO,GAAG;IACzB,CAAC,MAAM,IAAI,QAAQ,CAAC,EAAA,CAAG,IAAI,MAAM;IAClC,IAAI,OAAO,GAAG,KAAK,IAAI,MAAM,KAAA;GAC/B;GACF,KAAK;EACP;EACA;CACF;CACA,OAAO,IAAI,KAAK,SAAS,MAAM,KAAK,OAAO,SAAS,IAAI,CAAC;AAC3D;;;;;;;AAQA,SAAgB,UAAU,MAA0D;CAClF,IAAI,KAAK,QAAQ,OAAO,cAAc,aAAa;EACjD,MAAM,OAAO,IAAI,UAAU,CAAC,CAAC,gBAAgB,KAAK,MAAM,WAAW;EACnE,MAAM,SAAS,KAAK,cAAc,SAAS,KAAK,EAAE;EAClD,IAAI,QACF,IAAI;GACF,MAAM,OAAO,KAAK,MAAM,OAAO,aAAa,IAAI,CAAE;GAClD,IAAI,MAAM,QAAQ,KAAK,KAAK,GAAG,OAAO;EACxC,QAAQ,CAER;EAEF,MAAM,QAAQ,KAAK,cAAc,OAAO;EACxC,IAAI,OAAO;GACT,MAAM,QAAQ,UAAU,KAAK;GAC7B,IAAI,MAAM,QAAQ,OAAO,EAAE,MAAM;EACnC;CACF;CACA,IAAI,KAAK,QAAQ,QAAQ,KAAK,SAAS,IAAI,OAAO;CAGlD,OAAO,EAAE,OAAO,SADH,KAAK,KAAK,QAAQ,UAAU,EAChB,CAAI,CAAC,CAAC,KAAK,SAAS,KAAK,IAAI,OAAO,CAAC,EAAE;AAClE"}

package/dist/core/commands.js

@@ -0,0 +1,63 @@
+// src/core/commands.ts
+var labelOf = (label, messages) => typeof label === "function" ? label(messages) : label ?? "";
+/** Declares a command; only gives it a type. */
+function defineSheetCommand(command) {
+	return command;
+}
+/**
+* Puts the built-in commands and the extensions' together. An extension's
+* command with a name already taken is an error, unless it says `override`
+* and the name is a built-in one.
+*/
+function mergeCommands(builtin, added) {
+	const map = new Map(Object.entries(builtin));
+	const owner = /* @__PURE__ */ new Map();
+	for (const { extension, commands } of added) for (const name in commands) {
+		const command = commands[name];
+		const taken = owner.get(name);
+		if (taken) throw new Error(`[@dou-ui/sheet] the command "${name}" is added by both "${taken}" and "${extension}"`);
+		if (map.has(name) && !command.override) throw new Error(`[@dou-ui/sheet] "${extension}" adds the command "${name}", which the sheet already has; set \`override: true\` to replace it`);
+		owner.set(name, extension);
+		map.set(name, command);
+	}
+	return map;
+}
+/** The `commands` of a context, over the commands by name. */
+function createCommands(commands, context, builtin = {}) {
+	const find = (name) => {
+		const command = commands().get(name);
+		if (!command) throw new Error(`[@dou-ui/sheet] there is no command "${name}"`);
+		return command;
+	};
+	const can = (name) => {
+		const command = commands().get(name);
+		return !!command && (command.enabled?.(context()) ?? true);
+	};
+	return {
+		run(name, arg) {
+			const command = find(name);
+			const ctx = context();
+			if (command.enabled && !command.enabled(ctx)) return false;
+			return command.run(ctx, arg) !== false;
+		},
+		can,
+		pressed: (name) => !!commands().get(name)?.pressed?.(context()),
+		get(name) {
+			const command = commands().get(name);
+			if (!command) return void 0;
+			return {
+				name,
+				label: labelOf(command.label, context().messages.value),
+				icon: command.icon,
+				shortcut: command.shortcut,
+				toggle: !!command.pressed,
+				builtin: builtin[name] === command
+			};
+		},
+		has: (name) => commands().has(name),
+		names: () => [...commands().keys()]
+	};
+}
+export { createCommands, defineSheetCommand, labelOf, mergeCommands };
+
+//# sourceMappingURL=commands.js.map

package/dist/core/commands.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"commands.js","names":[],"sources":["../../src/core/commands.ts"],"sourcesContent":["import type { Component } from 'vue'\nimport type { SheetContext } from '../context'\nimport type { SheetMessages } from '../locale'\n\n/** Text shown in a menu or tooltip: fixed, or read from the sheet's messages so it follows the language. */\nexport type SheetLabel = string | ((messages: SheetMessages) => string)\n\nexport const labelOf = (label: SheetLabel | undefined, messages: SheetMessages) =>\n  typeof label === 'function' ? label(messages) : (label ?? '')\n\n/**\n * Something the sheet can do, by name: toolbar items, menu items and keys\n * can all refer to it, and take its label, icon and state from it.\n */\nexport interface SheetCommand<Arg = any> {\n  label: SheetLabel\n  icon?: Component\n  /**\n   * The key shown beside it, written as in `useHotkey` (e.g. `mod+shift+e`).\n   * Only a hint: bind the key with the extension's `keymap`.\n   */\n  shortcut?: string\n  /**\n   * Does it. `arg` is what the caller passes to `commands.run`, if anything.\n   * Return `false` when there was nothing to do.\n   */\n  run: (context: SheetContext, arg?: Arg) => boolean | void | Promise<unknown>\n  /** Whether it can be run now; greyed out in menus and the toolbar when not. Defaults to `true`. */\n  enabled?: (context: SheetContext) => boolean\n  /** For a command that turns something on and off: whether it is on, e.g. bold for a bold cell. */\n  pressed?: (context: SheetContext) => boolean\n  /**\n   * Lets it replace the built-in command of the same name. Without it, a\n   * name the sheet already has is an error, so a command isn't replaced by accident.\n   */\n  override?: boolean\n}\n\n/** Declares a command; only gives it a type. */\nexport function defineSheetCommand<Arg = any>(command: SheetCommand<Arg>): SheetCommand<Arg> {\n  return command\n}\n\n/** A command as menus and the toolbar show it. */\nexport interface SheetCommandInfo {\n  name: string\n  label: string\n  icon?: Component\n  shortcut?: string\n  /** Whether it turns something on and off (it has `pressed`). */\n  toggle: boolean\n  /** Whether it is the sheet's own, not added or replaced by an extension. */\n  builtin: boolean\n}\n\n/** The commands of a sheet, by name, for `useSheet().commands`. */\nexport interface SheetCommands {\n  /**\n   * Runs a command. Returns `false` when it can't be run now (`enabled`\n   * says no) or it had nothing to do; `true` otherwise, also while an\n   * asynchronous one is still running. An unknown name is an error.\n   */\n  run: (name: string, arg?: unknown) => boolean\n  /** Whether a command is there and can be run now. */\n  can: (name: string) => boolean\n  /** Whether a command that turns something on and off is on. */\n  pressed: (name: string) => boolean\n  /** A command's label, icon and shortcut, or `undefined` when there is none by that name. */\n  get: (name: string) => SheetCommandInfo | undefined\n  /** Whether there is a command by that name. */\n  has: (name: string) => boolean\n  /** The names of every command, built in and added. */\n  names: () => string[]\n}\n\n/**\n * Puts the built-in commands and the extensions' together. An extension's\n * command with a name already taken is an error, unless it says `override`\n * and the name is a built-in one.\n */\nexport function mergeCommands(\n  builtin: Readonly<Record<string, SheetCommand>>,\n  added: readonly { extension: string; commands: Readonly<Record<string, SheetCommand>> }[],\n) {\n  const map = new Map<string, SheetCommand>(Object.entries(builtin))\n  const owner = new Map<string, string>()\n  for (const { extension, commands } of added)\n    for (const name in commands) {\n      const command = commands[name]!\n      const taken = owner.get(name)\n      if (taken)\n        throw new Error(\n          `[@dou-ui/sheet] the command \"${name}\" is added by both \"${taken}\" and \"${extension}\"`,\n        )\n      if (map.has(name) && !command.override)\n        throw new Error(\n          `[@dou-ui/sheet] \"${extension}\" adds the command \"${name}\", which the sheet already has; set \\`override: true\\` to replace it`,\n        )\n      owner.set(name, extension)\n      map.set(name, command)\n    }\n  return map\n}\n\n/** The `commands` of a context, over the commands by name. */\nexport function createCommands(\n  commands: () => ReadonlyMap<string, SheetCommand>,\n  context: () => SheetContext,\n  builtin: Readonly<Record<string, SheetCommand>> = {},\n): SheetCommands {\n  const find = (name: string) => {\n    const command = commands().get(name)\n    if (!command) throw new Error(`[@dou-ui/sheet] there is no command \"${name}\"`)\n    return command\n  }\n  const can = (name: string) => {\n    const command = commands().get(name)\n    return !!command && (command.enabled?.(context()) ?? true)\n  }\n  return {\n    run(name, arg) {\n      const command = find(name)\n      const ctx = context()\n      if (command.enabled && !command.enabled(ctx)) return false\n      // a promise counts as done: it is the command's to report how it went\n      return command.run(ctx, arg) !== false\n    },\n    can,\n    pressed: (name) => !!commands().get(name)?.pressed?.(context()),\n    get(name) {\n      const command = commands().get(name)\n      if (!command) return undefined\n      return {\n        name,\n        label: labelOf(command.label, context().messages.value),\n        icon: command.icon,\n        shortcut: command.shortcut,\n        toggle: !!command.pressed,\n        builtin: builtin[name] === command,\n      }\n    },\n    has: (name) => commands().has(name),\n    names: () => [...commands().keys()],\n  }\n}\n"],"mappings":";AAOA,IAAa,WAAW,OAA+B,aACrD,OAAO,UAAU,aAAa,MAAM,QAAQ,IAAK,SAAS;;AA+B5D,SAAgB,mBAA8B,SAA+C;CAC3F,OAAO;AACT;;;;;;AAuCA,SAAgB,cACd,SACA,OACA;CACA,MAAM,MAAM,IAAI,IAA0B,OAAO,QAAQ,OAAO,CAAC;CACjE,MAAM,wBAAQ,IAAI,IAAoB;CACtC,KAAK,MAAM,EAAE,WAAW,cAAc,OACpC,KAAK,MAAM,QAAQ,UAAU;EAC3B,MAAM,UAAU,SAAS;EACzB,MAAM,QAAQ,MAAM,IAAI,IAAI;EAC5B,IAAI,OACF,MAAM,IAAI,MACR,gCAAgC,KAAK,sBAAsB,MAAM,SAAS,UAAU,EACtF;EACF,IAAI,IAAI,IAAI,IAAI,KAAK,CAAC,QAAQ,UAC5B,MAAM,IAAI,MACR,oBAAoB,UAAU,sBAAsB,KAAK,qEAC3D;EACF,MAAM,IAAI,MAAM,SAAS;EACzB,IAAI,IAAI,MAAM,OAAO;CACvB;CACF,OAAO;AACT;;AAGA,SAAgB,eACd,UACA,SACA,UAAkD,CAAC,GACpC;CACf,MAAM,QAAQ,SAAiB;EAC7B,MAAM,UAAU,SAAS,CAAC,CAAC,IAAI,IAAI;EACnC,IAAI,CAAC,SAAS,MAAM,IAAI,MAAM,wCAAwC,KAAK,EAAE;EAC7E,OAAO;CACT;CACA,MAAM,OAAO,SAAiB;EAC5B,MAAM,UAAU,SAAS,CAAC,CAAC,IAAI,IAAI;EACnC,OAAO,CAAC,CAAC,YAAY,QAAQ,UAAU,QAAQ,CAAC,KAAK;CACvD;CACA,OAAO;EACL,IAAI,MAAM,KAAK;GACb,MAAM,UAAU,KAAK,IAAI;GACzB,MAAM,MAAM,QAAQ;GACpB,IAAI,QAAQ,WAAW,CAAC,QAAQ,QAAQ,GAAG,GAAG,OAAO;GAErD,OAAO,QAAQ,IAAI,KAAK,GAAG,MAAM;EACnC;EACA;EACA,UAAU,SAAS,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,IAAI,CAAC,EAAE,UAAU,QAAQ,CAAC;EAC9D,IAAI,MAAM;GACR,MAAM,UAAU,SAAS,CAAC,CAAC,IAAI,IAAI;GACnC,IAAI,CAAC,SAAS,OAAO,KAAA;GACrB,OAAO;IACL;IACA,OAAO,QAAQ,QAAQ,OAAO,QAAQ,CAAC,CAAC,SAAS,KAAK;IACtD,MAAM,QAAQ;IACd,UAAU,QAAQ;IAClB,QAAQ,CAAC,CAAC,QAAQ;IAClB,SAAS,QAAQ,UAAU;GAC7B;EACF;EACA,MAAM,SAAS,SAAS,CAAC,CAAC,IAAI,IAAI;EAClC,aAAa,CAAC,GAAG,SAAS,CAAC,CAAC,KAAK,CAAC;CACpC;AACF"}

package/dist/core/comments.js

@@ -0,0 +1,74 @@
+import { formatCell } from "./address.js";
+import { sheetKey } from "./transaction.js";
+// src/core/comments.ts
+/** Every anchored thread in a workbook, by thread id. */
+function sheetCommentAnchors(book) {
+	const out = /* @__PURE__ */ new Map();
+	for (const sheet of book.sheets) {
+		const key = sheetKey(sheet);
+		sheet.cells.forEach((line, row) => line?.forEach((cell, col) => {
+			if (cell && typeof cell === "object" && cell.comment && !out.has(cell.comment)) out.set(cell.comment, {
+				sheet: key,
+				row,
+				col,
+				address: formatCell({
+					row,
+					col
+				})
+			});
+		}));
+	}
+	return out;
+}
+/** Where a line number goes with a step; `-1` once its line is gone. */
+function follow(step, axis, at) {
+	if (step.type === "insertLines" && step.axis === axis) return at >= step.index ? at + step.count : at;
+	if (step.type === "removeLines" && step.axis === axis) {
+		if (at < step.index) return at;
+		return at < step.index + step.count ? -1 : at - step.count;
+	}
+	if (step.type === "moveLines" && step.axis === axis) {
+		const { from, count, to } = step;
+		if (at >= from && at < from + count) return (to > from ? to - count : to) + at - from;
+		if (to > from && at >= from + count && at < to) return at - count;
+		if (to < from && at >= to && at < from) return at + count;
+	}
+	return at;
+}
+/**
+* Puts back the threads `tr` took off their cells by restoring what the
+* cells held before them, as undo and redo do. `before` is
+* `sheetCommentAnchors` of the workbook `tr` started from. A thread `tr`
+* itself puts on another cell (undoing a move) goes there instead, and one
+* whose row, column or sheet `tr` removed stays off. The threads are put
+* back in `into`, by default `tr` itself; give another transaction that
+* starts where `tr` ended to keep them a separate change.
+*/
+function keepCommentAnchors(before, tr, into = tr) {
+	if (!before.size) return;
+	const now = sheetCommentAnchors(into.doc);
+	for (const [id, anchor] of before) {
+		if (now.has(id)) continue;
+		let { row, col } = anchor;
+		let gone = false;
+		for (const step of tr.steps) {
+			if (step.type === "removeSheet" && step.sheet === anchor.sheet) gone = true;
+			if (!("sheet" in step) || step.sheet !== anchor.sheet) continue;
+			row = follow(step, "row", row);
+			col = follow(step, "col", col);
+			if (row < 0 || col < 0) gone = true;
+		}
+		if (gone || into.indexOf(anchor.sheet) === -1) continue;
+		const at = {
+			sheet: anchor.sheet,
+			row,
+			col
+		};
+		const cell = into.getCell(at);
+		if (cell && typeof cell === "object" && cell.comment) continue;
+		into.updateCell(at, { comment: id });
+	}
+}
+export { keepCommentAnchors, sheetCommentAnchors };
+
+//# sourceMappingURL=comments.js.map

package/dist/core/comments.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"comments.js","names":[],"sources":["../../src/core/comments.ts"],"sourcesContent":["import { formatCell } from './address'\nimport type { SheetWorkbook } from './model'\nimport { sheetKey, type SheetStep, type SheetTransaction } from './transaction'\n\n/*\n * Comment threads on cells. A cell names the thread it is about with\n * `comment`, one thread per cell; the discussions themselves live outside\n * the workbook (`v-model:comments`). A merged cell's thread is on its top\n * left cell.\n *\n * Writing or taking off an anchor is not a change to undo: undoing some\n * typing keeps the thread on its cell. `keepCommentAnchors` puts back the\n * anchors an undo or redo would otherwise take with the cells it restores.\n */\n\n/** Where a thread is: its sheet (by `id`, or name) and cell. */\nexport interface SheetCommentAnchor {\n  sheet: string\n  row: number\n  col: number\n  /** The cell as people write it, e.g. `B3`. */\n  address: string\n}\n\n/** Every anchored thread in a workbook, by thread id. */\nexport function sheetCommentAnchors(book: SheetWorkbook): Map<string, SheetCommentAnchor> {\n  const out = new Map<string, SheetCommentAnchor>()\n  for (const sheet of book.sheets) {\n    const key = sheetKey(sheet)\n    sheet.cells.forEach((line, row) =>\n      line?.forEach((cell, col) => {\n        if (cell && typeof cell === 'object' && cell.comment && !out.has(cell.comment))\n          out.set(cell.comment, { sheet: key, row, col, address: formatCell({ row, col }) })\n      }),\n    )\n  }\n  return out\n}\n\n/** Where a line number goes with a step; `-1` once its line is gone. */\nfunction follow(step: SheetStep, axis: 'row' | 'col', at: number) {\n  if (step.type === 'insertLines' && step.axis === axis)\n    return at >= step.index ? at + step.count : at\n  if (step.type === 'removeLines' && step.axis === axis) {\n    if (at < step.index) return at\n    return at < step.index + step.count ? -1 : at - step.count\n  }\n  if (step.type === 'moveLines' && step.axis === axis) {\n    const { from, count, to } = step\n    if (at >= from && at < from + count) return (to > from ? to - count : to) + at - from\n    if (to > from && at >= from + count && at < to) return at - count\n    if (to < from && at >= to && at < from) return at + count\n  }\n  return at\n}\n\n/**\n * Puts back the threads `tr` took off their cells by restoring what the\n * cells held before them, as undo and redo do. `before` is\n * `sheetCommentAnchors` of the workbook `tr` started from. A thread `tr`\n * itself puts on another cell (undoing a move) goes there instead, and one\n * whose row, column or sheet `tr` removed stays off. The threads are put\n * back in `into`, by default `tr` itself; give another transaction that\n * starts where `tr` ended to keep them a separate change.\n */\nexport function keepCommentAnchors(\n  before: ReadonlyMap<string, SheetCommentAnchor>,\n  tr: SheetTransaction,\n  into: SheetTransaction = tr,\n) {\n  if (!before.size) return\n  const now = sheetCommentAnchors(into.doc)\n  for (const [id, anchor] of before) {\n    if (now.has(id)) continue\n    let { row, col } = anchor\n    let gone = false\n    for (const step of tr.steps) {\n      if (step.type === 'removeSheet' && step.sheet === anchor.sheet) gone = true\n      if (!('sheet' in step) || step.sheet !== anchor.sheet) continue\n      row = follow(step, 'row', row)\n      col = follow(step, 'col', col)\n      if (row < 0 || col < 0) gone = true\n    }\n    if (gone || into.indexOf(anchor.sheet) === -1) continue\n    const at = { sheet: anchor.sheet, row, col }\n    const cell = into.getCell(at)\n    if (cell && typeof cell === 'object' && cell.comment) continue\n    into.updateCell(at, { comment: id })\n  }\n}\n"],"mappings":";;;;AAyBA,SAAgB,oBAAoB,MAAsD;CACxF,MAAM,sBAAM,IAAI,IAAgC;CAChD,KAAK,MAAM,SAAS,KAAK,QAAQ;EAC/B,MAAM,MAAM,SAAS,KAAK;EAC1B,MAAM,MAAM,SAAS,MAAM,QACzB,MAAM,SAAS,MAAM,QAAQ;GAC3B,IAAI,QAAQ,OAAO,SAAS,YAAY,KAAK,WAAW,CAAC,IAAI,IAAI,KAAK,OAAO,GAC3E,IAAI,IAAI,KAAK,SAAS;IAAE,OAAO;IAAK;IAAK;IAAK,SAAS,WAAW;KAAE;KAAK;IAAI,CAAC;GAAE,CAAC;EACrF,CAAC,CACH;CACF;CACA,OAAO;AACT;;AAGA,SAAS,OAAO,MAAiB,MAAqB,IAAY;CAChE,IAAI,KAAK,SAAS,iBAAiB,KAAK,SAAS,MAC/C,OAAO,MAAM,KAAK,QAAQ,KAAK,KAAK,QAAQ;CAC9C,IAAI,KAAK,SAAS,iBAAiB,KAAK,SAAS,MAAM;EACrD,IAAI,KAAK,KAAK,OAAO,OAAO;EAC5B,OAAO,KAAK,KAAK,QAAQ,KAAK,QAAQ,KAAK,KAAK,KAAK;CACvD;CACA,IAAI,KAAK,SAAS,eAAe,KAAK,SAAS,MAAM;EACnD,MAAM,EAAE,MAAM,OAAO,OAAO;EAC5B,IAAI,MAAM,QAAQ,KAAK,OAAO,OAAO,QAAQ,KAAK,OAAO,KAAK,QAAQ,MAAM,KAAK;EACjF,IAAI,KAAK,QAAQ,MAAM,OAAO,SAAS,KAAK,IAAI,OAAO,KAAK;EAC5D,IAAI,KAAK,QAAQ,MAAM,MAAM,KAAK,MAAM,OAAO,KAAK;CACtD;CACA,OAAO;AACT;;;;;;;;;;AAWA,SAAgB,mBACd,QACA,IACA,OAAyB,IACzB;CACA,IAAI,CAAC,OAAO,MAAM;CAClB,MAAM,MAAM,oBAAoB,KAAK,GAAG;CACxC,KAAK,MAAM,CAAC,IAAI,WAAW,QAAQ;EACjC,IAAI,IAAI,IAAI,EAAE,GAAG;EACjB,IAAI,EAAE,KAAK,QAAQ;EACnB,IAAI,OAAO;EACX,KAAK,MAAM,QAAQ,GAAG,OAAO;GAC3B,IAAI,KAAK,SAAS,iBAAiB,KAAK,UAAU,OAAO,OAAO,OAAO;GACvE,IAAI,EAAE,WAAW,SAAS,KAAK,UAAU,OAAO,OAAO;GACvD,MAAM,OAAO,MAAM,OAAO,GAAG;GAC7B,MAAM,OAAO,MAAM,OAAO,GAAG;GAC7B,IAAI,MAAM,KAAK,MAAM,GAAG,OAAO;EACjC;EACA,IAAI,QAAQ,KAAK,QAAQ,OAAO,KAAK,MAAM,IAAI;EAC/C,MAAM,KAAK;GAAE,OAAO,OAAO;GAAO;GAAK;EAAI;EAC3C,MAAM,OAAO,KAAK,QAAQ,EAAE;EAC5B,IAAI,QAAQ,OAAO,SAAS,YAAY,KAAK,SAAS;EACtD,KAAK,WAAW,IAAI,EAAE,SAAS,GAAG,CAAC;CACrC;AACF"}