@pixerate/editor 0.20.0 → 0.22.0

package/README.md

@@ -6,6 +6,8 @@ Framework bindings: [`@pixerate/editor-react`](https://www.npmjs.com/package/@pi
 
 ```bash
 npm install @pixerate/editor
+# only if you use @pixerate/editor/canvas (or the agent canvas planner):
+npm install @dagrejs/dagre
 ```
 
 ## Prompt grammar
@@ -106,18 +108,20 @@ editor.commands.resolveComment(id); // also deleteComment, setActiveComment, foc
 store.subscribe((snapshot) => save(store.toJSON()));
 
 editor.commands.toggleTrackChanges();
-getTrackedChanges(editor); // [{ id, type: "insertion" | "deletion", author, from, to, text, … }]
+getTrackedChanges(editor); // [{ id, type: "insertion" | "deletion" | "format" | "block", author, from, to, text, description, … }]
 editor.commands.acceptChange(id); // rejectChange, acceptAllChanges, rejectAllChanges: one undo step each
 ```
 
 - **Comments** are `comment` marks holding a thread id; thread content lives in the headless `CommentStore` (`subscribe` / `getSnapshot`, cached snapshots, `toJSON` / `load`). Threads whose text is deleted are flagged `orphaned` and re-attach on undo.
-- **Track changes** marks typed and pasted text with an `insertion` mark and keeps deleted text with a `deletion` mark (struck through). Deleting your own insertion really deletes it. IME composition is tracked once it ends. Not tracked: formatting-only changes, block-structure changes (splitting/joining paragraphs, lists) and edits inside code blocks. Set the `TRACK_CHANGES_SKIP_META` transaction meta to apply a change untracked (e.g. `setContent`).
-- **Serializers** render tracked content as if all changes were accepted: `getEditorText`, `htmlToPlainText` and `getEditorMarkdown` drop deleted text by default. Pass `{ trackedChanges: "original" }` (as if rejected) or `"all"` (both). `resolveTrackedChanges(doc, view)` returns a resolved document. TipTap's own `editor.getText()` still includes deleted text.
-- Both extensions are also available as `createRichTextPreset({ comments: true, trackChanges: true })`. Mark styles use Tailwind classes; override them via `commentClass` / `activeClass` and `insertionHTMLAttributes` / `deletionHTMLAttributes`.
+- **Track changes** marks typed and pasted text with an `insertion` mark and keeps deleted text with a `deletion` mark (struck through). Deleting your own insertion really deletes it. IME composition is tracked once it ends. Insertions and deletions inside code blocks are tracked too (`trackCodeBlocks: false` turns that off). Set the `TRACK_CHANGES_SKIP_META` transaction meta to apply a change untracked (e.g. `setContent`).
+- **Tracked formatting** (`trackFormatting`, on by default): adding or removing marks (bold, italic, links, highlight, font size, …) on existing text records a `formatChange` mark holding the author, id and the `before` / `after` formatting, shown as a dotted underline. Descriptions read `Formatted: Bold`, `Removed formatting: Italic` or `Changed formatting: Font size`. Accept keeps the new formatting; reject restores the old. Adjacent or repeated formatting by the same author merges into one change, changing it back drops the record, and formatting a tracked insertion stays part of the insertion. Review marks, comments and bookmarks are never formatting (add more with `ignoredMarks`).
+- **Tracked block changes** (`trackBlocks`, on by default): changing a textblock's type or attributes (paragraph ↔ heading, heading level, code block, alignment) or its wrappers (bulleted/numbered/task lists, indenting, outdenting, quotes) stores the previous state in a `blockChange` node attribute on `blockTypes` (paragraph, heading, code block), shown with a margin bar. Descriptions read `Changed Paragraph to Heading 2`, `Wrapped in Bulleted list`, `Changed alignment to Center`. Reject restores the type, attributes and nesting. Paragraph splits and joins are not tracked (a split-off block does not inherit the record). `describeFormatChange` and `describeBlockChange` build the descriptions.
+- **Serializers** render tracked content as if all changes were accepted: `getEditorText`, `htmlToPlainText` and `getEditorMarkdown` drop deleted text and use the new formatting and block types by default. Pass `{ trackedChanges: "original" }` (as if rejected) or `"all"` (both). `resolveTrackedChanges(doc, view)` returns a resolved document. TipTap's own `editor.getText()` still includes deleted text.
+- Both extensions are also available as `createRichTextPreset({ comments: true, trackChanges: true })`. Mark styles use Tailwind classes; override them via `commentClass` / `activeClass` and `insertionHTMLAttributes` / `deletionHTMLAttributes` / `formatChangeHTMLAttributes` / `blockChangeClass`.
 
 ## File import and rich clipboard
 
-An import adapter registry maps file types (MIME types and extensions) to converters. Built-in `document` adapters cover markdown (`.md`, `.markdown`, `.mdown`, `.mkdn`, `.mkd`, `.Rmd`, `.md.txt`), HTML (sanitized with the same allowlist as markdown), plain text (`.txt`) and RTF (best-effort text extraction). The longest matching extension wins, then exact MIME types, then `priority`, then the most recent registration.
+An import adapter registry maps file types (MIME types and extensions) to converters. Built-in `document` adapters cover markdown (`.md`, `.markdown`, `.mdown`, `.mkdn`, `.mkd`, `.Rmd`, `.md.txt`), HTML (sanitized with the same allowlist as markdown), plain text (`.txt`), RTF (best-effort text extraction) and DOCX (`.docx`, `.docm`, `.dotx`). The longest matching extension wins, then exact MIME types, then `priority`, then the most recent registration.
 
 ```ts
 import { importFile, registerImportAdapter, getImportAccept } from "@pixerate/editor";
@@ -125,20 +129,27 @@ import { importFile, registerImportAdapter, getImportAccept } from "@pixerate/ed
 const { adapterId, result } = await importFile(file); // result: { html, text }
 input.accept = getImportAccept("document");
 
-// DOCX, PDF, zipped exports or CSV → spreadsheet are pluggable:
+// Other formats are pluggable:
 registerImportAdapter({
-  id: "docx",
-  label: "Word",
-  mimeTypes: ["application/vnd.openxmlformats-officedocument.wordprocessingml.document"],
-  extensions: [".docx"],
+  id: "odt",
+  label: "OpenDocument text",
+  mimeTypes: ["application/vnd.oasis.opendocument.text"],
+  extensions: [".odt"],
   target: "document",
   async import(_file, ctx) {
-    const html = await myDocxToHtml(await ctx.readArrayBuffer());
+    const html = await myOdtToHtml(await ctx.readArrayBuffer());
     return { html, text: htmlToPlainText(html) };
   },
 });
 ```
 
+### DOCX, PDF and zipped exports (no extra dependencies)
+
+- **DOCX** (built in): `docxImportAdapter` reads `word/document.xml` (located via `_rels/.rels`), styles, numbering, relationships and footnotes / endnotes with the platform `DOMParser`, and maps headings (`Heading1`–`6`, `Title`, outline levels), bold / italic / underline / strike / super- and subscript, hyperlinks (including `HYPERLINK` fields), nested bulleted / numbered lists, tables (`colspan` / `rowspan`, header rows), line breaks, tabs and embedded PNG / JPEG / GIF / WebP images (as data URLs; dropped by the editor when the image extension is off). Output goes through `sanitizeImportedHtml`. **Tracked changes are imported as if accepted** (`w:ins` kept, `w:del` dropped); `createDocxImportAdapter({ trackedChanges: "original" })` imports them as if rejected. Text boxes, shapes, charts, equations, comments and layout are not imported. Without a global `DOMParser` (plain Node) it throws `ImportError("unsupported_environment")`; pass one with `createDocxImportAdapter({ DOMParser })`. Other options: `images`, `maxImageSize` (10 MiB), `zip` limits.
+- **PDF** (opt-in, bring your own pdf.js): `registerImportAdapter(createPdfImportAdapter(pdfjs))` with any object shaped like `pdfjs-dist` (`getDocument({ data }).promise`, `page.getTextContent()`). Text items are grouped into lines by baseline and into paragraphs by larger-than-usual vertical gaps or blank lines; options `paragraphGap`, `maxPages`, `documentParams`. Text only. `pdfTextItemsToParagraphs` is exported for custom adapters.
+- **Zipped exports** (opt-in): `registerImportAdapter(zipImportAdapter)` imports a `.zip` of markdown / HTML / text / DOCX files (Notion, Confluence, Obsidian exports) with the registry's other adapters — index / README files first, then natural path order — with a heading per file (Notion ids stripped from titles). The result adds `files` and `skipped` (unsupported types, nested archives, failures). Not registered by default because `.zip` is a generic container: claiming every dropped archive would steal drops from other handlers. `createZipImportAdapter({ headings, headingLevel, maxFiles, registry, zip })` customizes it.
+- **ZIP reader**: `readZip(bytes, { maxEntries, maxTotalSize, unsafePaths })` parses the central directory (ZIP64 included) and lazily extracts stored / deflate entries via `DecompressionStream("deflate-raw")` (browsers, Node 18+), verifying CRC-32. It rejects encrypted entries, `..` / absolute names and archives over the entry or uncompressed-size caps (default 10 000 entries / 256 MiB, enforced on inflated bytes) with typed `ZipError`s. DOCX reads use 100 MiB / 5 000 entries.
+
 `FileImport` (or `createRichTextPreset({ fileImport: true })`) inserts dropped or pasted files at the drop position, and `FileImportController` / `pickImportFiles` back file-picker buttons. `RichClipboard` (or `richClipboard: true`) also writes copied content as `application/x.pixerate.document+json` (ProseMirror slice JSON plus a schema signature) and prefers it on paste when the schemas match, falling back to HTML / plain text. Both are opt-in, and `EditorController` keeps them on plain text in `plainTextMode`.
 
 ## Agent tool registry
@@ -187,10 +198,10 @@ Each module is also available as a subpath import:
 | `@pixerate/editor/history` | `HistoryManager`: a command-pattern undo/redo stack |
 | `@pixerate/editor/spreadsheet` | `SpreadsheetController`, formula parser/evaluator and dependency graph, formula function registry (`registerFormulaFunction`, `listFormulaFunctions`, `searchFormulaFunctions`, `getFormulaSignature`) and autocomplete helpers (`getFormulaHints`, `applyFormulaSuggestion`) |
 | `@pixerate/editor/image-editor` | `ImageEditorController` and Canvas 2D renderer: crop, adjustments, annotations, depth masks and AI hooks. Needs a DOM/canvas environment. |
-| `@pixerate/editor/canvas` | Node-graph layout (dagre), placement, trajectories, displacement, clipboard and streaming layout helpers |
+| `@pixerate/editor/canvas` | Node-graph layout (needs the optional `@dagrejs/dagre` peer), placement, trajectories, displacement, clipboard and streaming layout helpers |
 | `@pixerate/editor/agent` | MCP tool schemas, a planner for agent-driven canvas edits, and the dynamic `ToolRegistry` with editor/spreadsheet tool providers |
 
-The root entry (`@pixerate/editor`) re-exports everything, including TipTap. In backends, import from `@pixerate/editor/grammar` to keep the dependency graph small.
+The root entry (`@pixerate/editor`) re-exports everything except canvas, agent and image editor, including TipTap. Import from the narrowest subpath you need: `grammar`, `history`, `spreadsheet` and `image-editor` have no third-party imports, so a spreadsheet-only app bundles no TipTap, markdown or dagre code. The package is marked `sideEffects: false`, so unused root exports are also tree-shaken.
 
 ## License
 

package/dist/agent/index.cjs

@@ -2,12 +2,12 @@
 
 
 
-var _chunkTVRC4KVTcjs = require('../chunk-TVRC4KVT.cjs');
+var _chunkAA4ZEVCCcjs = require('../chunk-AA4ZEVCC.cjs');
 
 
 
 
-var _chunkJYRIOFENcjs = require('../chunk-JYRIOFEN.cjs');
+var _chunkSAZRENEZcjs = require('../chunk-SAZRENEZ.cjs');
 
 
 
@@ -762,7 +762,7 @@ function createToolRegistry(options) {
 var toEditor = (target) => "commands" in target ? target : target.editor;
 function replaceWithText(editor, from, to, text) {
   const { state, view } = editor;
-  const tr = /[\r\n]/.test(text) ? state.tr.replace(from, to, _chunkTVRC4KVTcjs.plainTextToSlice.call(void 0, text, state.schema)) : text ? state.tr.insertText(text, from, to) : state.tr.delete(from, to);
+  const tr = /[\r\n]/.test(text) ? state.tr.replace(from, to, _chunkAA4ZEVCCcjs.plainTextToSlice.call(void 0, text, state.schema)) : text ? state.tr.insertText(text, from, to) : state.tr.delete(from, to);
   view.dispatch(tr.scrollIntoView());
 }
 function selectionInfo(editor) {
@@ -788,7 +788,7 @@ function createRichTextToolProvider(target, options) {
     annotations: { readOnlyHint: true },
     handler: ({ format = "text" }) => {
       const ed = editor();
-      const content = format === "html" ? ed.getHTML() : format === "markdown" ? _chunkTVRC4KVTcjs.getEditorMarkdown.call(void 0, ed) : _chunkTVRC4KVTcjs.getEditorText.call(void 0, ed);
+      const content = format === "html" ? ed.getHTML() : format === "markdown" ? _chunkAA4ZEVCCcjs.getEditorMarkdown.call(void 0, ed) : _chunkAA4ZEVCCcjs.getEditorText.call(void 0, ed);
       return { format, content, selection: selectionInfo(ed), size: ed.state.doc.content.size };
     }
   };
@@ -855,7 +855,7 @@ var CELL_REF_REGEX = /^\$?([A-Za-z]{1,3})\$?(\d{1,7})$/;
 function parseCell(ref) {
   const match = CELL_REF_REGEX.exec(ref.trim());
   if (!match) throw new Error(`Invalid cell reference "${ref}". Use A1 notation, e.g. "B3".`);
-  return { col: _chunkJYRIOFENcjs.colNameToIndex.call(void 0, match[1].toUpperCase()), row: parseInt(match[2], 10) - 1 };
+  return { col: _chunkSAZRENEZcjs.colNameToIndex.call(void 0, match[1].toUpperCase()), row: parseInt(match[2], 10) - 1 };
 }
 function createSpreadsheetToolProvider(controller, options) {
   const lookup = (row, col) => {
@@ -896,14 +896,14 @@ function createSpreadsheetToolProvider(controller, options) {
           const cell = controller.getCell(found.rowDef.id, found.colDef.id);
           valueRow.push(_nullishCoalesce(cell.error, () => ( cell.value)));
           rawRow.push(cell.raw);
-          const error = _nullishCoalesce(cell.error, () => ( (_chunkJYRIOFENcjs.isFormulaError.call(void 0, cell.value) ? cell.value : void 0)));
-          if (error) errors.push({ cell: `${_chunkJYRIOFENcjs.indexToColName.call(void 0, c)}${r + 1}`, error });
+          const error = _nullishCoalesce(cell.error, () => ( (_chunkSAZRENEZcjs.isFormulaError.call(void 0, cell.value) ? cell.value : void 0)));
+          if (error) errors.push({ cell: `${_chunkSAZRENEZcjs.indexToColName.call(void 0, c)}${r + 1}`, error });
         }
         values.push(valueRow);
         raw.push(rawRow);
       }
       return {
-        range: values.length && values[0].length ? `${_chunkJYRIOFENcjs.indexToColName.call(void 0, c0)}${r0 + 1}:${_chunkJYRIOFENcjs.indexToColName.call(void 0, c1)}${r1 + 1}` : null,
+        range: values.length && values[0].length ? `${_chunkSAZRENEZcjs.indexToColName.call(void 0, c0)}${r0 + 1}:${_chunkSAZRENEZcjs.indexToColName.call(void 0, c1)}${r1 + 1}` : null,
         values,
         raw,
         errors,

package/dist/agent/index.d.cts

@@ -1,6 +1,6 @@
-import { C as CanvasNode, a as CanvasEdge, X as XYPosition, S as Side } from '../types-DMe0vFB1.cjs';
+import { C as CanvasNode, a as CanvasEdge, X as XYPosition, S as Side } from '../types-CJ4U-HHI.cjs';
 import { Editor } from '@tiptap/core';
-import { W as SpreadsheetController } from '../controller-OUdxPY-X.cjs';
+import { S as SpreadsheetController } from '../controller-B7GIybc4.cjs';
 
 /**
  * Agent presence state for visual multiplayer/agent choreography.

package/dist/agent/index.d.ts

@@ -1,6 +1,6 @@
-import { C as CanvasNode, a as CanvasEdge, X as XYPosition, S as Side } from '../types-DMe0vFB1.js';
+import { C as CanvasNode, a as CanvasEdge, X as XYPosition, S as Side } from '../types-CJ4U-HHI.js';
 import { Editor } from '@tiptap/core';
-import { W as SpreadsheetController } from '../controller-OUdxPY-X.js';
+import { S as SpreadsheetController } from '../controller-B7GIybc4.js';
 
 /**
  * Agent presence state for visual multiplayer/agent choreography.

package/dist/agent/index.js

@@ -2,12 +2,12 @@ import {
   getEditorMarkdown,
   getEditorText,
   plainTextToSlice
-} from "../chunk-3TYMNULT.js";
+} from "../chunk-MJZBNWG7.js";
 import {
   colNameToIndex,
   indexToColName,
   isFormulaError
-} from "../chunk-A7DKIA72.js";
+} from "../chunk-DENSCKFC.js";
 import {
   ensureLayout,
   getLayoutedNodes,