diff --git a/.changeset/content-control-blocks.md b/.changeset/content-control-blocks.md deleted file mode 100644 index d596309..0000000 --- a/.changeset/content-control-blocks.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -"@office-kit/docx": minor -"@office-kit/docx-editor": patch ---- - -`contentControlBlocks(block)` reads the paragraphs and tables inside a block-level content control (``), the wrapper Word puts around cover pages, watermarks and tables of contents. The editor canvas uses it to show that content (read-only) instead of a "preserved content" placeholder, so watermarks and cover pages now appear on the page. diff --git a/.changeset/deprecate-append-apis.md b/.changeset/deprecate-append-apis.md deleted file mode 100644 index e1455dc..0000000 --- a/.changeset/deprecate-append-apis.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@office-kit/docx": minor ---- - -`addTableOfContents`, `appendMergeField` and `addBookmark` are deprecated in favour of `insertTableOfContents`, `insertMergeField` and `insertBookmark`, which do the same and more (any position, computed TOC entries, bookmarks over part of a paragraph). The deprecated functions keep working until the next major release. diff --git a/.changeset/docx-editor-initial.md b/.changeset/docx-editor-initial.md deleted file mode 100644 index 21af592..0000000 --- a/.changeset/docx-editor-initial.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -"@office-kit/docx-editor": minor -"@office-kit/docx": patch ---- - -feat: add `@office-kit/docx-editor` — an MS Office-like WYSIWYG editing core - -New package that turns `@office-kit/docx` into a Word-like editor: an -`EditorModel` with undo/redo, a command layer (text/paragraph/structure/list/ -table/image/style/section/header-footer/references/review) where every mutation -routes through the `@office-kit/docx` public API, an AST→HTML canvas renderer, -and DOM-selection mapping. A SvelteKit ribbon UI ships at the site's `/editor` -route. - -The editing surface is interactive: Enter splits the paragraph at the caret and -Backspace/Delete merge across paragraph boundaries (`splitParagraphCommand` / -`mergeBackCommand`, backed by the library's `splitParagraphAt` / -`mergeParagraphIntoPrevious`); the caret is preserved across structural -re-renders; Ctrl+Z/Y drive undo/redo; paste inserts plain text (multi-line → -paragraphs) keeping the AST in sync; and the UI adds live word/character count, -find & replace, zoom, caret-synced font/size/style, and heading-styled rendering -so the document reads with real visual hierarchy. - -Character formatting is now selection-precise: bolding (or any run format on) a -partial selection splits runs at the selection boundaries and formats only the -selected characters instead of the whole line — backed by the library's -`isolateParagraphRunRange` / `runTextLength`. The ribbon UI is localized into -six languages (English, 日本語, Español, Français, Deutsch, 中文) with a -language switcher. - -Completeness against the WordprocessingML spec is enforced by a capability -ledger: every element in the ECMA-376 schema universe is classified as -`edit` / `render` / `preserve`, and a test fails the build if any element is -unclassified or an editable element's command goes missing. - -The library gains generic property setters so the editor can reach the long -tail of WordprocessingML formatting without a bespoke function per element: - -- run / paragraph: `setRunOnOff` / `setRunValProp` / `getRunProp` and the - `setParagraphOnOff` / `setParagraphValProp` / `getParagraphProp` equivalents; -- any properties container: `setElementOnOff` / `setElementValProp` / - `getElementProp` / `makePropsElement` (for `` / `` / - `` / ``); -- document settings: `setDocumentSettingOnOff` / `setDocumentSettingVal` / - `getDocumentSetting` (creates `word/settings.xml` on demand); -- style definitions: `setStyleOnOff` / `setStyleValProp` / `getStyleProp`; -- numbering levels: `setNumberingLevelVal` / `setNumberingLevelOnOff` / - `getNumberingLevelProp`; -- images: `imageDrawings` / `setImageSizeEmu` / `setImageAltText` / - `getImageInfo` (resize and alt-text existing pictures); -- raw XML nodes: `setElementAttr` / `getElementAttr` / `childElementsOf` / - `appendChildElement` — the universal escape hatch that lets the editor edit - any element (DrawingML shape geometry, OMML math, legacy VML) by attribute or - child, since these live inline in `document.xml` and flush through the - document AST on save; -- arbitrary XML parts: `xmlPartNames` / `getRawPartRoot` / `markRawPartDirty` — - open, edit, and re-serialize any XML part (fontTable, settings, styles, - numbering, comments, foot-/endnotes, headers, footers, webSettings, docProps), - so every OOXML element in the whole package is reachable and editable; -- caret-level structure: `splitParagraphAt` / `mergeParagraphIntoPrevious` — - split a paragraph at a run/offset and merge a paragraph into the previous one - (the primitives behind Enter and Backspace-at-start); -- selection formatting: `isolateParagraphRunRange` / `runTextLength` — isolate a - character range into its own run(s) so formatting applies to exactly the - selected text. - -Also newly exported from `@office-kit/docx` (they are part of the public -surface as parameter/return/AST types): `BuildStyleOptions`, `BuildTableOptions`, -`DocumentCoreProperties`, `DocumentAppProperties`, and the raw XML AST types -`XmlElement` / `XmlNode` / `XmlAttr` / `QName`. - -Commands are atomic: `runCommand` returns the command's result, and a command -that throws (including rejected input such as an out-of-range table size or a -non-http(s)/mailto hyperlink) leaves the document, selection and redo history -unchanged (`EditorModel.abortEdit`). `replaceAllCommand`, `insertTextCommand` and -`deleteSelectionCommand` route Find & Replace, paste, and typing or deleting -over a selection (also across paragraphs) through the same undoable path. -Consecutive keystrokes undo as one step, Shift+Enter breaks the line at the -caret, and hyperlinks and field results are visible on the canvas. Enter, -Backspace and Delete inside a table cell split and join that cell's -paragraphs. IME input that starts over a selection replaces it in one undo -step. `splitParagraphAt` moves a paragraph's -section break to the second half instead of duplicating it. diff --git a/.changeset/docx-editor-word-ui.md b/.changeset/docx-editor-word-ui.md deleted file mode 100644 index 00ff167..0000000 --- a/.changeset/docx-editor-word-ui.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -"@office-kit/docx-editor": minor ---- - -feat: the editor reports and writes formatting the way Microsoft Word does - -- New `createStyleResolver(doc)` returns a paragraph's and a run's effective - formatting: document defaults, the paragraph style's `basedOn` chain, the - character style and direct formatting, with theme fonts looked up. The canvas - renders these values, so headings take their look from `styles.xml`. - Also new: `pageGeometry(doc)`, `highlightCss(value)`, `RunRef`. -- Bold / Italic / Strikethrough / Underline toggles and the alignment buttons - read the effective value. Turning off formatting that comes from a style - writes an explicit off value (``, ``), - as Word does. -- `clearFormattingCommand` now matches Word's Clear All Formatting: a caret - resets its paragraph to Normal; a range clears every character property - except the highlight and resets the paragraphs whose mark it includes. - Previously it wrote explicit `false` values and left color, size and font. -- New `indentStepCommand` (Increase / Decrease Indent in 0.5 in steps), - `setLineSpacingCommand` with `lineSpacingOf`, and `setVertAlignCommand` - (Subscript / Superscript). -- The canvas uses the section's page size and margins, renders paragraph - indents and spacing, and draws tables with their own width, columns, cell - margins and borders (none when the document defines none). diff --git a/.changeset/east-asian-units.md b/.changeset/east-asian-units.md deleted file mode 100644 index ca1954e..0000000 --- a/.changeset/east-asian-units.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -"@office-kit/docx": minor ---- - -`setParagraphIndent` and `setParagraphSpacing` take East Asian units, as Japanese and Chinese Word write them: - -- Indents in hundredths of a character: `leftChars`, `rightChars`, `firstLineChars` and `hangingChars` ("2 字" is `200`). -- Spacing in hundredths of a line: `beforeLines` and `afterLines` ("0.5 行" is `50`). diff --git a/.changeset/editor-adversarial-fixes.md b/.changeset/editor-adversarial-fixes.md deleted file mode 100644 index 930d257..0000000 --- a/.changeset/editor-adversarial-fixes.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -"@office-kit/docx-editor": patch ---- - -Editing fixes found by adversarial testing: - -- Deleting or typing over a selection that crosses table cells no longer fails silently: within one table the covered cells are emptied, and a selection that leaves the table deletes the rows it touches, as in Word. -- Backspace at the start of a paragraph after a table no longer joins it to the paragraph above the table. An empty paragraph there is removed and the caret moves to the table's last cell. -- Bold, italic, font and other character formatting with a caret (no selection) now behaves like Word: inside a word it formats the whole word (Japanese words included); elsewhere it applies to the text typed next instead of the whole run. -- `runPoint` places a caret after the placeholder of an empty run, so text typed there lands in that run. -- New `isEmptyParagraph` export. diff --git a/.changeset/editor-canvas.md b/.changeset/editor-canvas.md deleted file mode 100644 index 79ab398..0000000 --- a/.changeset/editor-canvas.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -"@office-kit/docx": minor -"@office-kit/docx-editor": minor ---- - -Headers, footers and notes can now be read and edited as stories of their own. - -- `@office-kit/docx`: - - `storyBody` / `storyView` give typed access to the body of a header, footer, footnote, endnote or comment. Edits to it are saved with the document. - - `sectionProperties`, `resolveHeaderFooter`, `ensureHeaderFooter`, `isHeaderFooterLinked` and `setHeaderFooterLinked` resolve a section's first, even or default header or footer, including what it inherits from the previous section, and support "Link to Previous". -- `@office-kit/docx-editor`: - - A `DocPosition` may carry a `story`, so selection, typing and formatting commands work inside headers, footers and notes. - - New `stories.*` commands: - - turn "Different First Page" and "Different Odd & Even Pages" on and off; - - set the header and footer distances; - - link a header or footer to the previous section. - - The new layout module (`paginate`, `documentSections`, `createFlagResolver`, `formatNumber`) breaks a document into pages. It handles: - - sections and columns; - - keep with next, keep lines together and widow/orphan control; - - table rows split across pages, with repeated header rows; - - footnote areas. diff --git a/.changeset/editor-design-layout.md b/.changeset/editor-design-layout.md deleted file mode 100644 index d2f6430..0000000 --- a/.changeset/editor-design-layout.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -"@office-kit/docx": minor -"@office-kit/docx-editor": minor ---- - -Add Word's Design and Layout features. - -- `@office-kit/docx`: section layout (`getSectionProperties`, `setSectionProperties` and `insertSectionBreak` for columns, line numbering, page borders, the document grid, vertical alignment, text direction and section start), with a `scope` for `setPageSize`, `setPageMargins` and `setPageOrientation`. Also themes (`setTheme`, `setThemeColors`, `setThemeFonts`, `setThemeEffects`, `getTheme`, plus the built-in Office themes and schemes), style sets (`applyStyleSet`, `currentStyleSet`), default paragraph spacing, page colour including gradient fills (`setPageColor`), and text or picture watermarks (`setWatermark`, `getWatermark`). Document settings are now written in schema order. -- `@office-kit/docx-editor`: `design.*` and `layout.*` commands for the Design and Layout ribbon tabs and the Page Setup, Columns, Line Numbers, Hyphenation, Text Direction and Page Borders dialogs. Section commands take a `target` of the whole document, the caret section or "this point forward". Also adds the `resolveSectionLayout`, `resolvePageBackground`, `resolveTheme` and `themePalette` helpers. diff --git a/.changeset/editor-east-asian-fonts.md b/.changeset/editor-east-asian-fonts.md deleted file mode 100644 index e3021b6..0000000 --- a/.changeset/editor-east-asian-fonts.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -"@office-kit/docx-editor": patch ---- - -`setFontCommand` now treats East Asian fonts the way Word's font box does: - -- An East Asian font, such as 游明朝, ＭＳ ゴシック or SimSun, is applied to East Asian text as well as Latin text. -- A Latin font, such as Arial, changes only the Latin text, so Japanese text keeps its font. - -Two new exports, `isEastAsianFont` and `hasEastAsianText`, expose the checks this uses. diff --git a/.changeset/editor-east-asian-typography.md b/.changeset/editor-east-asian-typography.md deleted file mode 100644 index 881a0c6..0000000 --- a/.changeset/editor-east-asian-typography.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -"@office-kit/docx-editor": patch ---- - -The canvas now lays out Japanese and Chinese documents the way Word does. Line heights and spacing were checked against Japanese Word for Mac 16: - -- **Vertical text (縦書き).** A section with `textDirection` `tbRl` is laid out top to bottom, right to left, and pages break where Word breaks them. -- **Document grid (§17.6.5).** Lines snap to whole grid lines; for example, 10.5 pt 游明朝 takes one 18 pt line and 28 pt takes three. Auto line spacing scales the grid line, as in Word. A character grid spaces the characters out to the grid pitch. -- **East Asian units.** Indents in characters and spacing in lines are converted to points. -- **Single line height.** 游明朝 and 游ゴシック use the font's own single-line height (1.447 × the size). -- **Character formatting.** - - Emphasis marks (傍点) - - Fit Text (均等割り付け), including a width shared by runs with the same id - - Character scale (文字の拡大/縮小) - - Combine Characters / Two Lines in One (組み文字・割注) - - Horizontal-in-vertical (縦中横) -- **Paragraph settings.** Distributed alignment; kinsoku line breaking; word wrap; hanging punctuation; and the automatic space between Japanese and Latin text or numbers (`autoSpaceDE` / `autoSpaceDN`). -- **Fonts.** Japanese and Chinese font names (游明朝, ＭＳ 明朝, メイリオ, 宋体 …) fall back to the system's Japanese or Chinese fonts. diff --git a/.changeset/editor-final-paragraph.md b/.changeset/editor-final-paragraph.md deleted file mode 100644 index 845aa4e..0000000 --- a/.changeset/editor-final-paragraph.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@office-kit/docx-editor": patch ---- - -The editor keeps a paragraph after a table that ends the document, as Word does. Before, there was no way to type below such a table. This affected documents that end with a table, and tables inserted at the end of a document. diff --git a/.changeset/editor-home.md b/.changeset/editor-home.md deleted file mode 100644 index 05c1c8c..0000000 --- a/.changeset/editor-home.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -"@office-kit/docx": minor -"@office-kit/docx-editor": minor ---- - -Word's Home tab formatting. - -- `@office-kit/docx` adds character and paragraph formatting helpers: - - Theme colours (`setRunColor`) and every underline style with an underline colour (`setRunUnderline`). - - Theme fonts (`setRunFont`), character shading and borders (`setRunShading`, `setRunBorder`). - - Paragraph border sides (`setParagraphBorder`) and tab stops (`setParagraphTabs` / `getParagraphTabs`). - - Phonetic guides (`buildRubyRun` / `readRuby`) and enclosed characters (`buildEnclosedCharacterRuns`). - - Custom list definitions with restart (`addListDefinition`, `restartList`). - - Word's built-in styles created on first use (`builtinStyles`, `ensureBuiltinStyle`) and style editing (`updateStyleFormatting`). -- Saved documents now always list property children in the order the schema requires, which Word needs to open the file. -- `@office-kit/docx-editor` adds Home tab commands: - - Font and Paragraph dialog patches, Change Case, Format Painter, Asian layout and Fit Text. - - Border presets, paragraph sorting, and the Bullet / Numbering / Multilevel libraries with restart and continue. - - Applying, creating, modifying and deleting styles. - - Word-style Find and Replace with wildcards, special characters and format filters. -- The canvas now draws list numbers, text effects, run shading and borders, paragraph borders, and ruby. diff --git a/.changeset/editor-insert.md b/.changeset/editor-insert.md deleted file mode 100644 index 252a08e..0000000 --- a/.changeset/editor-insert.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -"@office-kit/docx": minor -"@office-kit/docx-editor": minor ---- - -feat: Word's Insert tab — fields, links, symbols, equations, pages and page numbers - -`@office-kit/docx` can now place what Word's Insert tab places at a character offset of a paragraph: - -- Complex fields (`insertField`, `buildComplexField`) with computed results. DATE/TIME (`\@` pictures with localized month and day names via `lang`), document properties, statistics, `=` formulas, IF/COMPARE, SEQ, REF/PAGEREF/NOTEREF, USERNAME and more. `updateFields` recomputes them, `complexFields` lists them, and `insertFormField` writes legacy form fields. -- Links with ScreenTips, target frames and in-document anchors (`insertHyperlink`, `editHyperlink`, `removeHyperlink`, `paragraphHyperlinks`). -- Range bookmarks (`insertBookmark`) and Word's hidden `_Ref` bookmarks for cross-references (`ensureReferenceBookmark`). -- Symbol-font characters as `w:sym` and the special hyphens (`insertSymbol`). -- Equations as OMML from a linear format (UnicodeMath), and back (`insertEquation`, `buildEquation`, `equationLinear`, `setEquation`). -- Drop caps (`setDropCap` / `getDropCap`) and VML signature lines (`insertSignatureLine`). -- Cover pages, header and footer content, page numbers and their format (`pgNumType`), and merging another document's body with its styles, lists and relationships (`insertDocumentContent`). - -`@office-kit/docx-editor` adds commands for all of these, plus: - -- Queries the Insert dialogs need: headings, bookmarks, notes, numbered items and captions to reference, the link at the caret, and the equation under a rendered element. -- Canvas rendering of field results (with a field-code view), symbol-font characters, and equations as MathML. diff --git a/.changeset/editor-pictures.md b/.changeset/editor-pictures.md deleted file mode 100644 index 2a2fd4a..0000000 --- a/.changeset/editor-pictures.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -"@office-kit/docx": minor -"@office-kit/docx-editor": minor ---- - -Pictures, charts and object arrangement. - -`@office-kit/docx` adds a picture API (`src/api/picture.ts`): - -- `readDrawing` reads a ``: wrap, anchor position, crop, shape, border, effects, color adjustments and image. -- Arrange: `setDrawingWrap`, `setDrawingPosition`, `setDrawingAnchorOptions`, `arrangeDrawing` (Bring Forward / Send Backward and their variants), `setDrawingTransform`, `setDrawingName`, `setDrawingHidden`, `setDrawingAspectLock`, `setDrawingHyperlink` and `removeDrawing`. -- Picture formatting: `setPictureCrop`, `setPictureGeometry`, `setPictureOutline`, `setPictureEffects`, `setPictureColorAdjustments`, `changePicture` and `resetPicture`. -- Charts: `addChartRun`, `readChart` and `setChart` write a real chart part with an embedded workbook. -- `imagePixelSize` and `imageNaturalSizeEmu` read image dimensions. - -Everything is written as ECMA-376 markup, with no Office extension namespaces. - -Fixed: `setImageSizeEmu` no longer writes into an `a:ext` that sits inside an extension list. - -`@office-kit/docx-editor` adds: - -- Rendering for floating and inline pictures and charts: wrapping, z-order, rotation, crop, effects and blip adjustments. -- `layoutFloatingObjects` and `floatFrameStart` for placing floating objects in the browser. -- Picture, arrange and chart commands, including `drawing.layout` for the Layout Options dialog and `chart.insert` / `chart.edit`. diff --git a/.changeset/editor-references-mailings.md b/.changeset/editor-references-mailings.md deleted file mode 100644 index 93200b0..0000000 --- a/.changeset/editor-references-mailings.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -"@office-kit/docx": minor -"@office-kit/docx-editor": minor ---- - -feat: Word's References and Mailings features, with field results computed so a saved document reads correctly before Word updates it. - -- **References** (`@office-kit/docx`): - - Tables of contents and tables of figures: `insertTableOfContents`, `removeTableOfContents`, `setTocLevel`, and `updateTables`. Page numbers come from an optional page provider. - - Footnotes and endnotes: `insertNote`, `noteMarks` (numbering per `w:footnotePr` / `w:endnotePr`), `setNoteProperties`, `noteText` / `setNoteText`, and `convertNotes`. - - Citations and bibliography: sources are stored in the §22.6 customXml part. Use `setBibliographySources`, `setBibliographyStyle`, `insertCitation` and `insertBibliography`. APA and MLA are fully supported; Chicago, IEEE and the numeric styles are approximated. - - Captions: `insertCaption` writes SEQ fields with chapter numbers. `addCaptionLabel` adds a caption label. - - Index: `markIndexEntry`, `markAllIndexEntries` and `insertIndex`. - - Table of authorities: `markAuthorityCitation` and `insertTableOfAuthorities`. -- **Mailings** (`@office-kit/docx`): - - Envelopes and labels: `addEnvelope` and `createLabelDocument`. - - Mail merge setup: `setMailMergeDocumentType`, plus CSV recipient lists via `parseRecipientCsv` and `attachRecipientList`. Match Fields and recipient inclusion are stored in `w:odso`. - - Merge fields and rules: `insertMergeField`, `insertAddressBlock`, `insertGreetingLine`, and `insertMergeRule`, which covers ASK, FILLIN, IF, MERGEREC, MERGESEQ, NEXT, NEXTIF, SET and SKIPIF. - - Preview and merge: `previewMailMerge` and `mergeToNewDocument`, which puts one section per record. -- **Editor** (`@office-kit/docx-editor`): References and Mailings commands for all of the above, plus `findNoteReference` and `selectedText` queries for the ribbon UI. diff --git a/.changeset/editor-review-view.md b/.changeset/editor-review-view.md deleted file mode 100644 index a09a118..0000000 --- a/.changeset/editor-review-view.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -"@office-kit/docx": minor -"@office-kit/docx-editor": minor ---- - -Review and View features. - -`@office-kit/docx`: - -- Tracked changes: `revisions`, `acceptRevisions` / `rejectRevisions` by id, and recording edits as tracked (`insertTrackedText`, `deleteTrackedText`, `trackParagraphMark`, `trackRunFormatChange`, `trackParagraphFormatChange`). Runs inside `` / `` now parse as runs that carry `revision`, so they are editable and save back as the same wrappers. -- `compareDocuments`: diffs two documents into a new document of tracked changes. -- Comments: `comments`, `setCommentText` and `removeComment`. `addComment` accepts a `range`. -- Proofing: `getRunLanguage` / `setRunLanguage`, plus a Word-compatible `wordCount`. -- `checkAccessibility` and `contrastRatio`. -- Document protection: `protectDocument` / `unprotectDocument` with ECMA-376 SHA-512 password hashes, `writeProtection` (Always Open Read-Only, password to modify), and editable exceptions. -- `documentView` / `documentZoom`, custom properties (`customProperties`, `setCustomProperty`, `removeCustomProperty`) and the `hyperlinkBase` app property. -- Settings written through `setDocumentSettingOnOff` / `Val` now follow the schema order of `CT_Settings`. - -`@office-kit/docx-editor`: - -- While Track Changes is on, typing, deleting, splitting and merging paragraphs, and formatting are recorded as revisions. -- Review commands: comments, accept / reject, language, protection. -- Outline commands: level, promote / demote, move. -- Navigation to the previous / next change or comment. -- Review markup classes on the rendered document. -- `protectionRefusal` / `isEditingLocked`, so a UI can honour Restrict Editing. diff --git a/.changeset/editor-rich-paste.md b/.changeset/editor-rich-paste.md deleted file mode 100644 index 4ba0b7a..0000000 --- a/.changeset/editor-rich-paste.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -"@office-kit/docx-editor": patch ---- - -Formatted paste and pending formatting: - -- New `insertFragmentCommand` and `parseClipboardHtml`: pasting HTML (from Word, a web page, Google Docs or the editor itself) keeps bold, italic, underline, strikethrough, superscript / subscript, text color, headings, bullet and numbered lists with their levels, line breaks, tabs and tables. As in Word, the first pasted paragraph continues the caret's paragraph and a pasted table goes between its halves; inside a table cell a pasted table becomes paragraphs. -- New `releasePendingFormat`: formatting set at a caret (Bold with no selection, say) and left without typing is dropped once the caret moves on, as in Word, instead of leaving an empty run behind. diff --git a/.changeset/editor-shapes.md b/.changeset/editor-shapes.md deleted file mode 100644 index 1a7929d..0000000 --- a/.changeset/editor-shapes.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -"@office-kit/docx": minor -"@office-kit/docx-editor": minor ---- - -Shapes, text boxes, WordArt, ink and SmartArt. - -- `@office-kit/docx`: build and edit VML shapes (`addShape` with about 120 Word presets, `addWordArt`, ink strokes, `addDrawingCanvas`, groups), with fill (solid, gradient, pattern, picture), outline, shadow, layout, wrapping, z-order, alt text, linked text boxes and vertical text. Insert and edit SmartArt graphics (`addSmartArt`, `setSmartArtNodes`, layouts, colours, styles, size, `removeSmartArt`) as ECMA-376 DrawingML diagram parts. Existing VML from Word documents is read, including shape types. -- `@office-kit/docx-editor`: renders VML shapes, text boxes, WordArt, ink and SmartArt on the canvas (`renderPictHtml` is exported for watermarks), with commands for every Shape Format, SmartArt Design and Draw tab action, editable text boxes, and Ink to Shape recognition (`recognizeInkShape`). diff --git a/.changeset/editor-spacing-lines.md b/.changeset/editor-spacing-lines.md deleted file mode 100644 index 6c1759d..0000000 --- a/.changeset/editor-spacing-lines.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -"@office-kit/docx-editor": patch ---- - -`layoutSpacingCommand` takes spacing in lines (`beforeLines` / `afterLines`, hundredths of a line), the unit Japanese Word's 段落前 / 段落後 boxes use. It also writes the equivalent twips at the section's grid pitch. `spacingLineTwips` returns that pitch. - -`layoutIndentCommand` and `layoutSpacingCommand` keep a paragraph's existing character and line units (`leftChars`, `beforeLines` …). Setting a value in twips clears the matching unit, so the new value shows. Before, a unit that was set kept overriding the new twips value. diff --git a/.changeset/editor-style-resolution.md b/.changeset/editor-style-resolution.md deleted file mode 100644 index 054e87a..0000000 --- a/.changeset/editor-style-resolution.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@office-kit/docx-editor": patch ---- - -Style resolution follows more of ECMA-376: toggle properties (bold, italic, caps …) toggle across the table, paragraph and character style levels (§17.7.3), list numbers take their level's run properties (§17.9.24), and complex-script text (Arabic, Hebrew, Thai …) uses its own bold, italic, size and font (`bCs`, `iCs`, `szCs`, `w:cs`). The canvas lists the East Asian and complex-script fonts after the Latin one, so each script draws in its own font. diff --git a/.changeset/editor-tables.md b/.changeset/editor-tables.md deleted file mode 100644 index bc27088..0000000 --- a/.changeset/editor-tables.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -"@office-kit/docx": minor -"@office-kit/docx-editor": minor ---- - -Tables, the way Word edits them. - -`@office-kit/docx` gains Word's table operations: insert and delete rows and columns at any position, delete cells (shifting left or up), merge and split cells, split a table, set table / cell widths, alignment, indent, layout, cell spacing, default and per-cell margins, text direction, floating position and alt text, distribute and AutoFit columns, apply borders to any cell range (including diagonals), sort rows, convert text to a table and back with a chosen separator (`unwrapTable` now takes `{ separator }`), and evaluate table formulas (`=SUM(ABOVE)` …). It also ships Word's 105 built-in table styles (Table Grid, Plain / Grid / List Tables in every accent), colored from the document's theme, with Table Style Options (`w:tblLook`) and per-region style formatting. Table property setters now write their children in schema order. - -`@office-kit/docx-editor` adds commands for every Table Design and Table Layout action, renders tables with their style's conditional formatting (header / total rows, first / last columns, banding with the style's band sizes, corner cells), merged cells, row heights, cell margins, vertical alignment, text direction, diagonal borders, cell spacing and nested tables, and exposes the cell-range selection, Tab navigation, gallery previews and a Table Properties snapshot. diff --git a/.changeset/editor-tabs-drop-caps.md b/.changeset/editor-tabs-drop-caps.md deleted file mode 100644 index 525a9ee..0000000 --- a/.changeset/editor-tabs-drop-caps.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -"@office-kit/docx-editor": patch ---- - -The canvas now lays out tabs against the paragraph's tab stops, as Word does: - -- Custom stops are inherited through styles, and `clear` stops remove inherited ones. -- Past the custom stops, tabs go to the document's default tab interval. -- Right, center and decimal stops align the text that follows the tab. -- Dot, hyphen, underscore, heavy and middle-dot leaders are drawn. - -Typing a tab now works too. Tab inserts a tab character, and at the start of a list item Tab and Shift+Tab change the item's level. A caret steps over a tab as a single character. - -Drop caps (`w:framePr w:dropCap`) float into the lines of the paragraph that follows them, instead of sitting on a line of their own. diff --git a/.changeset/highlight-named-colors.md b/.changeset/highlight-named-colors.md deleted file mode 100644 index 0ee0d08..0000000 --- a/.changeset/highlight-named-colors.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -"@office-kit/docx": minor -"@office-kit/docx-editor": minor ---- - -fix: highlight is written only as a valid `ST_HighlightColor` name - -`` accepts only 16 named colors and `none` (ECMA-376 -§17.18.40). Before this fix, `setRunFormat`, `appendTextRun`, `setParagraphText` -and `setTableCellText` wrote any string there (e.g. `FFFF00`), producing a file -that does not conform to the schema. They now throw a `RangeError`, without -changing the document, for any other value. The new `HIGHLIGHT_COLORS` export -(with the `HighlightColor` type) lists the accepted values. `getRunFormat` still -returns whatever a file holds. - -In the editor, `setHighlightCommand` takes `{ color: HighlightColor }` instead of -a hex string and rejects anything else before changing the document. The site -ribbon's highlight control is now a named list instead of a color picker. diff --git a/.changeset/preserve-element-attributes.md b/.changeset/preserve-element-attributes.md deleted file mode 100644 index b715088..0000000 --- a/.changeset/preserve-element-attributes.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -"@office-kit/docx": patch ---- - -fix: saving a document dropped the attributes of ``, ``, ``, -``, `` and ``, including `w14:paraId`, `w14:textId` and -`w:rsid*`. They are now kept on save. The parsed nodes carry them as an -optional `attrs` field. diff --git a/.changeset/run-format-color-size-validation.md b/.changeset/run-format-color-size-validation.md deleted file mode 100644 index f24f5a4..0000000 --- a/.changeset/run-format-color-size-validation.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -"@office-kit/docx": minor -"@office-kit/docx-editor": minor ---- - -fix: run color and font size are written only as schema-valid values - -`setRunFormat`, `appendTextRun`, `setParagraphText` and `setTableCellText` used -to write any `color` string and any `fontSizeHalfPoints` number into -`` / ``. Values like `"red"`, `"#FF0000"`, `-1`, -`23.5` or `NaN` produced files that do not conform to the schema. These writers -now throw a `RangeError`, before changing anything, unless: - -- `color` is six hex digits without `#` (either case) or `"auto"` (ST_HexColor); -- `fontSizeHalfPoints` is a non-negative safe integer (ST_HpsMeasure). `0` stays - valid; there is no application-specific upper bound. - -Untyped JavaScript callers get the same check on the runtime type: a `color` -that is not a string (e.g. the number `123456`, `null`) or a size that is not a -number (e.g. `"24"`) is rejected rather than stringified. - -One case that used to pass silently now throws: `appendTextRun(p, text, { color: "" })` -ignored the empty color, and now rejects it like `setRunFormat` does. -`getRunFormat` still returns whatever a file holds, and untouched values are -saved unchanged. - -In the editor, `setColorCommand` (a leading `#` is still dropped) and -`setFontSizeCommand` (points, rounded to half-points) reject invalid values -before the document changes, with undo and redo history kept. - -The editor canvas also no longer lets a crafted file break out of a run's -`style` attribute: the attribute is HTML-escaped, only six-digit hex colors -become CSS, and quotes, backslashes and line breaks are dropped from font names -when rendering. The document itself is not changed. diff --git a/.changeset/table-search-size-units-range-runs.md b/.changeset/table-search-size-units-range-runs.md deleted file mode 100644 index 1fa7bcd..0000000 --- a/.changeset/table-search-size-units-range-runs.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -"@office-kit/docx": patch -"@office-kit/docx-editor": patch ---- - -fix: find / replace reach table cells, unit font sizes read correctly, and range state sees middle runs - -- `findText` and `replaceText` (and the body part of `findTextEverywhere` / - `replaceTextEverywhere`) skipped every paragraph inside a table cell, despite - promising "every paragraph" / "every occurrence". They now include cell - paragraphs, in document order, so counts and replacements cover tables. A - table nested inside a cell is still kept as raw XML and not searched. -- `getRunFormat` read `` as 12 half-points (6 pt) because it - ignored the unit. Universal measures (`pt`, `pc`, `pi`, `in`, `cm`, `mm`) are - now converted exactly, so `"12pt"` reads as 24. A value that is not a whole - number of half-points (`"3mm"`) or is invalid (`"-4"`, `"12px"`) leaves - `fontSizeHalfPoints` unset instead of being guessed; the XML keeps the value - as written. -- In the editor, `runsInRange` returned every run of the paragraphs at both - ends of a range, not just the runs the range touches as documented. It now - returns exactly the covered runs (a collapsed caret still returns its - paragraph's runs). The site ribbon uses it, so a differently formatted run in - the middle of a selection shows the field as "Mixed", and choosing a value - applies it to the whole range. diff --git a/.changeset/wordart-toc-in-word.md b/.changeset/wordart-toc-in-word.md deleted file mode 100644 index 7c8c0b0..0000000 --- a/.changeset/wordart-toc-in-word.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -"@office-kit/docx": patch ---- - -Fix two problems that showed up when the file was opened in Word: - -- `addWordArt` now writes the text-path shape type (`_x0000_t136`) that the shape refers to. Without it, Word drew a broken-picture placeholder. -- In a section with no `w:pgMar`, tables of contents, indexes and other generated content now place their right tab at Word's default margins (1 in each side). Before, the tab sat at the page edge. diff --git a/.changeset/wrapped-runs.md b/.changeset/wrapped-runs.md deleted file mode 100644 index 8b37ade..0000000 --- a/.changeset/wrapped-runs.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -"@office-kit/docx": minor -"@office-kit/docx-editor": patch ---- - -`wrappedRuns(inline)` reads the runs inside a hyperlink, simple field, inline content control, smart tag, custom XML or bidi override. The editor canvas uses it so link text shows its own formatting, as Word does: the Hyperlink style for an ordinary link, and plain text for a table of contents entry, instead of always blue and underlined. diff --git a/CHANGELOG.md b/CHANGELOG.md index 2b7d234..9c13d38 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,297 @@ # Changelog +## 0.2.0 + +### Minor Changes + +- 48ed589: `contentControlBlocks(block)` reads the paragraphs and tables inside a block-level content control (``), the wrapper Word puts around cover pages, watermarks and tables of contents. The editor canvas uses it to show that content (read-only) instead of a "preserved content" placeholder, so watermarks and cover pages now appear on the page. +- 48ed589: `addTableOfContents`, `appendMergeField` and `addBookmark` are deprecated in favour of `insertTableOfContents`, `insertMergeField` and `insertBookmark`, which do the same and more (any position, computed TOC entries, bookmarks over part of a paragraph). The deprecated functions keep working until the next major release. +- 49e6e8a: `setParagraphIndent` and `setParagraphSpacing` take East Asian units, as Japanese and Chinese Word write them: + + - Indents in hundredths of a character: `leftChars`, `rightChars`, `firstLineChars` and `hangingChars` ("2 字" is `200`). + - Spacing in hundredths of a line: `beforeLines` and `afterLines` ("0.5 行" is `50`). + +- 48ed589: Headers, footers and notes can now be read and edited as stories of their own. + + - `@office-kit/docx`: + - `storyBody` / `storyView` give typed access to the body of a header, footer, footnote, endnote or comment. Edits to it are saved with the document. + - `sectionProperties`, `resolveHeaderFooter`, `ensureHeaderFooter`, `isHeaderFooterLinked` and `setHeaderFooterLinked` resolve a section's first, even or default header or footer, including what it inherits from the previous section, and support "Link to Previous". + - `@office-kit/docx-editor`: + - A `DocPosition` may carry a `story`, so selection, typing and formatting commands work inside headers, footers and notes. + - New `stories.*` commands: + - turn "Different First Page" and "Different Odd & Even Pages" on and off; + - set the header and footer distances; + - link a header or footer to the previous section. + - The new layout module (`paginate`, `documentSections`, `createFlagResolver`, `formatNumber`) breaks a document into pages. It handles: + - sections and columns; + - keep with next, keep lines together and widow/orphan control; + - table rows split across pages, with repeated header rows; + - footnote areas. + +- 48ed589: Add Word's Design and Layout features. + + - `@office-kit/docx`: section layout (`getSectionProperties`, `setSectionProperties` and `insertSectionBreak` for columns, line numbering, page borders, the document grid, vertical alignment, text direction and section start), with a `scope` for `setPageSize`, `setPageMargins` and `setPageOrientation`. Also themes (`setTheme`, `setThemeColors`, `setThemeFonts`, `setThemeEffects`, `getTheme`, plus the built-in Office themes and schemes), style sets (`applyStyleSet`, `currentStyleSet`), default paragraph spacing, page colour including gradient fills (`setPageColor`), and text or picture watermarks (`setWatermark`, `getWatermark`). Document settings are now written in schema order. + - `@office-kit/docx-editor`: `design.*` and `layout.*` commands for the Design and Layout ribbon tabs and the Page Setup, Columns, Line Numbers, Hyphenation, Text Direction and Page Borders dialogs. Section commands take a `target` of the whole document, the caret section or "this point forward". Also adds the `resolveSectionLayout`, `resolvePageBackground`, `resolveTheme` and `themePalette` helpers. + +- 48ed589: Word's Home tab formatting. + + - `@office-kit/docx` adds character and paragraph formatting helpers: + - Theme colours (`setRunColor`) and every underline style with an underline colour (`setRunUnderline`). + - Theme fonts (`setRunFont`), character shading and borders (`setRunShading`, `setRunBorder`). + - Paragraph border sides (`setParagraphBorder`) and tab stops (`setParagraphTabs` / `getParagraphTabs`). + - Phonetic guides (`buildRubyRun` / `readRuby`) and enclosed characters (`buildEnclosedCharacterRuns`). + - Custom list definitions with restart (`addListDefinition`, `restartList`). + - Word's built-in styles created on first use (`builtinStyles`, `ensureBuiltinStyle`) and style editing (`updateStyleFormatting`). + - Saved documents now always list property children in the order the schema requires, which Word needs to open the file. + - `@office-kit/docx-editor` adds Home tab commands: + - Font and Paragraph dialog patches, Change Case, Format Painter, Asian layout and Fit Text. + - Border presets, paragraph sorting, and the Bullet / Numbering / Multilevel libraries with restart and continue. + - Applying, creating, modifying and deleting styles. + - Word-style Find and Replace with wildcards, special characters and format filters. + - The canvas now draws list numbers, text effects, run shading and borders, paragraph borders, and ruby. + +- 48ed589: feat: Word's Insert tab — fields, links, symbols, equations, pages and page numbers + + `@office-kit/docx` can now place what Word's Insert tab places at a character offset of a paragraph: + + - Complex fields (`insertField`, `buildComplexField`) with computed results. DATE/TIME (`\@` pictures with localized month and day names via `lang`), document properties, statistics, `=` formulas, IF/COMPARE, SEQ, REF/PAGEREF/NOTEREF, USERNAME and more. `updateFields` recomputes them, `complexFields` lists them, and `insertFormField` writes legacy form fields. + - Links with ScreenTips, target frames and in-document anchors (`insertHyperlink`, `editHyperlink`, `removeHyperlink`, `paragraphHyperlinks`). + - Range bookmarks (`insertBookmark`) and Word's hidden `_Ref` bookmarks for cross-references (`ensureReferenceBookmark`). + - Symbol-font characters as `w:sym` and the special hyphens (`insertSymbol`). + - Equations as OMML from a linear format (UnicodeMath), and back (`insertEquation`, `buildEquation`, `equationLinear`, `setEquation`). + - Drop caps (`setDropCap` / `getDropCap`) and VML signature lines (`insertSignatureLine`). + - Cover pages, header and footer content, page numbers and their format (`pgNumType`), and merging another document's body with its styles, lists and relationships (`insertDocumentContent`). + + `@office-kit/docx-editor` adds commands for all of these, plus: + + - Queries the Insert dialogs need: headings, bookmarks, notes, numbered items and captions to reference, the link at the caret, and the equation under a rendered element. + - Canvas rendering of field results (with a field-code view), symbol-font characters, and equations as MathML. + +- 48ed589: Pictures, charts and object arrangement. + + `@office-kit/docx` adds a picture API (`src/api/picture.ts`): + + - `readDrawing` reads a ``: wrap, anchor position, crop, shape, border, effects, color adjustments and image. + - Arrange: `setDrawingWrap`, `setDrawingPosition`, `setDrawingAnchorOptions`, `arrangeDrawing` (Bring Forward / Send Backward and their variants), `setDrawingTransform`, `setDrawingName`, `setDrawingHidden`, `setDrawingAspectLock`, `setDrawingHyperlink` and `removeDrawing`. + - Picture formatting: `setPictureCrop`, `setPictureGeometry`, `setPictureOutline`, `setPictureEffects`, `setPictureColorAdjustments`, `changePicture` and `resetPicture`. + - Charts: `addChartRun`, `readChart` and `setChart` write a real chart part with an embedded workbook. + - `imagePixelSize` and `imageNaturalSizeEmu` read image dimensions. + + Everything is written as ECMA-376 markup, with no Office extension namespaces. + + Fixed: `setImageSizeEmu` no longer writes into an `a:ext` that sits inside an extension list. + + `@office-kit/docx-editor` adds: + + - Rendering for floating and inline pictures and charts: wrapping, z-order, rotation, crop, effects and blip adjustments. + - `layoutFloatingObjects` and `floatFrameStart` for placing floating objects in the browser. + - Picture, arrange and chart commands, including `drawing.layout` for the Layout Options dialog and `chart.insert` / `chart.edit`. + +- 48ed589: feat: Word's References and Mailings features, with field results computed so a saved document reads correctly before Word updates it. + + - **References** (`@office-kit/docx`): + - Tables of contents and tables of figures: `insertTableOfContents`, `removeTableOfContents`, `setTocLevel`, and `updateTables`. Page numbers come from an optional page provider. + - Footnotes and endnotes: `insertNote`, `noteMarks` (numbering per `w:footnotePr` / `w:endnotePr`), `setNoteProperties`, `noteText` / `setNoteText`, and `convertNotes`. + - Citations and bibliography: sources are stored in the §22.6 customXml part. Use `setBibliographySources`, `setBibliographyStyle`, `insertCitation` and `insertBibliography`. APA and MLA are fully supported; Chicago, IEEE and the numeric styles are approximated. + - Captions: `insertCaption` writes SEQ fields with chapter numbers. `addCaptionLabel` adds a caption label. + - Index: `markIndexEntry`, `markAllIndexEntries` and `insertIndex`. + - Table of authorities: `markAuthorityCitation` and `insertTableOfAuthorities`. + - **Mailings** (`@office-kit/docx`): + - Envelopes and labels: `addEnvelope` and `createLabelDocument`. + - Mail merge setup: `setMailMergeDocumentType`, plus CSV recipient lists via `parseRecipientCsv` and `attachRecipientList`. Match Fields and recipient inclusion are stored in `w:odso`. + - Merge fields and rules: `insertMergeField`, `insertAddressBlock`, `insertGreetingLine`, and `insertMergeRule`, which covers ASK, FILLIN, IF, MERGEREC, MERGESEQ, NEXT, NEXTIF, SET and SKIPIF. + - Preview and merge: `previewMailMerge` and `mergeToNewDocument`, which puts one section per record. + - **Editor** (`@office-kit/docx-editor`): References and Mailings commands for all of the above, plus `findNoteReference` and `selectedText` queries for the ribbon UI. + +- 48ed589: Review and View features. + + `@office-kit/docx`: + + - Tracked changes: `revisions`, `acceptRevisions` / `rejectRevisions` by id, and recording edits as tracked (`insertTrackedText`, `deleteTrackedText`, `trackParagraphMark`, `trackRunFormatChange`, `trackParagraphFormatChange`). Runs inside `` / `` now parse as runs that carry `revision`, so they are editable and save back as the same wrappers. + - `compareDocuments`: diffs two documents into a new document of tracked changes. + - Comments: `comments`, `setCommentText` and `removeComment`. `addComment` accepts a `range`. + - Proofing: `getRunLanguage` / `setRunLanguage`, plus a Word-compatible `wordCount`. + - `checkAccessibility` and `contrastRatio`. + - Document protection: `protectDocument` / `unprotectDocument` with ECMA-376 SHA-512 password hashes, `writeProtection` (Always Open Read-Only, password to modify), and editable exceptions. + - `documentView` / `documentZoom`, custom properties (`customProperties`, `setCustomProperty`, `removeCustomProperty`) and the `hyperlinkBase` app property. + - Settings written through `setDocumentSettingOnOff` / `Val` now follow the schema order of `CT_Settings`. + + `@office-kit/docx-editor`: + + - While Track Changes is on, typing, deleting, splitting and merging paragraphs, and formatting are recorded as revisions. + - Review commands: comments, accept / reject, language, protection. + - Outline commands: level, promote / demote, move. + - Navigation to the previous / next change or comment. + - Review markup classes on the rendered document. + - `protectionRefusal` / `isEditingLocked`, so a UI can honour Restrict Editing. + +- 48ed589: Shapes, text boxes, WordArt, ink and SmartArt. + + - `@office-kit/docx`: build and edit VML shapes (`addShape` with about 120 Word presets, `addWordArt`, ink strokes, `addDrawingCanvas`, groups), with fill (solid, gradient, pattern, picture), outline, shadow, layout, wrapping, z-order, alt text, linked text boxes and vertical text. Insert and edit SmartArt graphics (`addSmartArt`, `setSmartArtNodes`, layouts, colours, styles, size, `removeSmartArt`) as ECMA-376 DrawingML diagram parts. Existing VML from Word documents is read, including shape types. + - `@office-kit/docx-editor`: renders VML shapes, text boxes, WordArt, ink and SmartArt on the canvas (`renderPictHtml` is exported for watermarks), with commands for every Shape Format, SmartArt Design and Draw tab action, editable text boxes, and Ink to Shape recognition (`recognizeInkShape`). + +- 48ed589: Tables, the way Word edits them. + + `@office-kit/docx` gains Word's table operations: insert and delete rows and columns at any position, delete cells (shifting left or up), merge and split cells, split a table, set table / cell widths, alignment, indent, layout, cell spacing, default and per-cell margins, text direction, floating position and alt text, distribute and AutoFit columns, apply borders to any cell range (including diagonals), sort rows, convert text to a table and back with a chosen separator (`unwrapTable` now takes `{ separator }`), and evaluate table formulas (`=SUM(ABOVE)` …). It also ships Word's 105 built-in table styles (Table Grid, Plain / Grid / List Tables in every accent), colored from the document's theme, with Table Style Options (`w:tblLook`) and per-region style formatting. Table property setters now write their children in schema order. + + `@office-kit/docx-editor` adds commands for every Table Design and Table Layout action, renders tables with their style's conditional formatting (header / total rows, first / last columns, banding with the style's band sizes, corner cells), merged cells, row heights, cell margins, vertical alignment, text direction, diagonal borders, cell spacing and nested tables, and exposes the cell-range selection, Tab navigation, gallery previews and a Table Properties snapshot. + +- 48ed589: fix: highlight is written only as a valid `ST_HighlightColor` name + + `` accepts only 16 named colors and `none` (ECMA-376 + §17.18.40). Before this fix, `setRunFormat`, `appendTextRun`, `setParagraphText` + and `setTableCellText` wrote any string there (e.g. `FFFF00`), producing a file + that does not conform to the schema. They now throw a `RangeError`, without + changing the document, for any other value. The new `HIGHLIGHT_COLORS` export + (with the `HighlightColor` type) lists the accepted values. `getRunFormat` still + returns whatever a file holds. + + In the editor, `setHighlightCommand` takes `{ color: HighlightColor }` instead of + a hex string and rejects anything else before changing the document. The site + ribbon's highlight control is now a named list instead of a color picker. + +- 48ed589: fix: run color and font size are written only as schema-valid values + + `setRunFormat`, `appendTextRun`, `setParagraphText` and `setTableCellText` used + to write any `color` string and any `fontSizeHalfPoints` number into + `` / ``. Values like `"red"`, `"#FF0000"`, `-1`, + `23.5` or `NaN` produced files that do not conform to the schema. These writers + now throw a `RangeError`, before changing anything, unless: + + - `color` is six hex digits without `#` (either case) or `"auto"` (ST_HexColor); + - `fontSizeHalfPoints` is a non-negative safe integer (ST_HpsMeasure). `0` stays + valid; there is no application-specific upper bound. + + Untyped JavaScript callers get the same check on the runtime type: a `color` + that is not a string (e.g. the number `123456`, `null`) or a size that is not a + number (e.g. `"24"`) is rejected rather than stringified. + + One case that used to pass silently now throws: `appendTextRun(p, text, { color: "" })` + ignored the empty color, and now rejects it like `setRunFormat` does. + `getRunFormat` still returns whatever a file holds, and untouched values are + saved unchanged. + + In the editor, `setColorCommand` (a leading `#` is still dropped) and + `setFontSizeCommand` (points, rounded to half-points) reject invalid values + before the document changes, with undo and redo history kept. + + The editor canvas also no longer lets a crafted file break out of a run's + `style` attribute: the attribute is HTML-escaped, only six-digit hex colors + become CSS, and quotes, backslashes and line breaks are dropped from font names + when rendering. The document itself is not changed. + +- 48ed589: `wrappedRuns(inline)` reads the runs inside a hyperlink, simple field, inline content control, smart tag, custom XML or bidi override. The editor canvas uses it so link text shows its own formatting, as Word does: the Hyperlink style for an ordinary link, and plain text for a table of contents entry, instead of always blue and underlined. + +### Patch Changes + +- 48ed589: feat: add `@office-kit/docx-editor` — an MS Office-like WYSIWYG editing core + + New package that turns `@office-kit/docx` into a Word-like editor: an + `EditorModel` with undo/redo, a command layer (text/paragraph/structure/list/ + table/image/style/section/header-footer/references/review) where every mutation + routes through the `@office-kit/docx` public API, an AST→HTML canvas renderer, + and DOM-selection mapping. A SvelteKit ribbon UI ships at the site's `/editor` + route. + + The editing surface is interactive: Enter splits the paragraph at the caret and + Backspace/Delete merge across paragraph boundaries (`splitParagraphCommand` / + `mergeBackCommand`, backed by the library's `splitParagraphAt` / + `mergeParagraphIntoPrevious`); the caret is preserved across structural + re-renders; Ctrl+Z/Y drive undo/redo; paste inserts plain text (multi-line → + paragraphs) keeping the AST in sync; and the UI adds live word/character count, + find & replace, zoom, caret-synced font/size/style, and heading-styled rendering + so the document reads with real visual hierarchy. + + Character formatting is now selection-precise: bolding (or any run format on) a + partial selection splits runs at the selection boundaries and formats only the + selected characters instead of the whole line — backed by the library's + `isolateParagraphRunRange` / `runTextLength`. The ribbon UI is localized into + six languages (English, 日本語, Español, Français, Deutsch, 中文) with a + language switcher. + + Completeness against the WordprocessingML spec is enforced by a capability + ledger: every element in the ECMA-376 schema universe is classified as + `edit` / `render` / `preserve`, and a test fails the build if any element is + unclassified or an editable element's command goes missing. + + The library gains generic property setters so the editor can reach the long + tail of WordprocessingML formatting without a bespoke function per element: + + - run / paragraph: `setRunOnOff` / `setRunValProp` / `getRunProp` and the + `setParagraphOnOff` / `setParagraphValProp` / `getParagraphProp` equivalents; + - any properties container: `setElementOnOff` / `setElementValProp` / + `getElementProp` / `makePropsElement` (for `` / `` / + `` / ``); + - document settings: `setDocumentSettingOnOff` / `setDocumentSettingVal` / + `getDocumentSetting` (creates `word/settings.xml` on demand); + - style definitions: `setStyleOnOff` / `setStyleValProp` / `getStyleProp`; + - numbering levels: `setNumberingLevelVal` / `setNumberingLevelOnOff` / + `getNumberingLevelProp`; + - images: `imageDrawings` / `setImageSizeEmu` / `setImageAltText` / + `getImageInfo` (resize and alt-text existing pictures); + - raw XML nodes: `setElementAttr` / `getElementAttr` / `childElementsOf` / + `appendChildElement` — the universal escape hatch that lets the editor edit + any element (DrawingML shape geometry, OMML math, legacy VML) by attribute or + child, since these live inline in `document.xml` and flush through the + document AST on save; + - arbitrary XML parts: `xmlPartNames` / `getRawPartRoot` / `markRawPartDirty` — + open, edit, and re-serialize any XML part (fontTable, settings, styles, + numbering, comments, foot-/endnotes, headers, footers, webSettings, docProps), + so every OOXML element in the whole package is reachable and editable; + - caret-level structure: `splitParagraphAt` / `mergeParagraphIntoPrevious` — + split a paragraph at a run/offset and merge a paragraph into the previous one + (the primitives behind Enter and Backspace-at-start); + - selection formatting: `isolateParagraphRunRange` / `runTextLength` — isolate a + character range into its own run(s) so formatting applies to exactly the + selected text. + + Also newly exported from `@office-kit/docx` (they are part of the public + surface as parameter/return/AST types): `BuildStyleOptions`, `BuildTableOptions`, + `DocumentCoreProperties`, `DocumentAppProperties`, and the raw XML AST types + `XmlElement` / `XmlNode` / `XmlAttr` / `QName`. + + Commands are atomic: `runCommand` returns the command's result, and a command + that throws (including rejected input such as an out-of-range table size or a + non-http(s)/mailto hyperlink) leaves the document, selection and redo history + unchanged (`EditorModel.abortEdit`). `replaceAllCommand`, `insertTextCommand` and + `deleteSelectionCommand` route Find & Replace, paste, and typing or deleting + over a selection (also across paragraphs) through the same undoable path. + Consecutive keystrokes undo as one step, Shift+Enter breaks the line at the + caret, and hyperlinks and field results are visible on the canvas. Enter, + Backspace and Delete inside a table cell split and join that cell's + paragraphs. IME input that starts over a selection replaces it in one undo + step. `splitParagraphAt` moves a paragraph's + section break to the second half instead of duplicating it. + +- 48ed589: fix: saving a document dropped the attributes of ``, ``, ``, + ``, `` and ``, including `w14:paraId`, `w14:textId` and + `w:rsid*`. They are now kept on save. The parsed nodes carry them as an + optional `attrs` field. +- 48ed589: fix: find / replace reach table cells, unit font sizes read correctly, and range state sees middle runs + + - `findText` and `replaceText` (and the body part of `findTextEverywhere` / + `replaceTextEverywhere`) skipped every paragraph inside a table cell, despite + promising "every paragraph" / "every occurrence". They now include cell + paragraphs, in document order, so counts and replacements cover tables. A + table nested inside a cell is still kept as raw XML and not searched. + - `getRunFormat` read `` as 12 half-points (6 pt) because it + ignored the unit. Universal measures (`pt`, `pc`, `pi`, `in`, `cm`, `mm`) are + now converted exactly, so `"12pt"` reads as 24. A value that is not a whole + number of half-points (`"3mm"`) or is invalid (`"-4"`, `"12px"`) leaves + `fontSizeHalfPoints` unset instead of being guessed; the XML keeps the value + as written. + - In the editor, `runsInRange` returned every run of the paragraphs at both + ends of a range, not just the runs the range touches as documented. It now + returns exactly the covered runs (a collapsed caret still returns its + paragraph's runs). The site ribbon uses it, so a differently formatted run in + the middle of a selection shows the field as "Mixed", and choosing a value + applies it to the whole range. + +- 48ed589: Fix two problems that showed up when the file was opened in Word: + + - `addWordArt` now writes the text-path shape type (`_x0000_t136`) that the shape refers to. Without it, Word drew a broken-picture placeholder. + - In a section with no `w:pgMar`, tables of contents, indexes and other generated content now place their right tab at Word's default margins (1 in each side). Before, the tab sat at the page edge. + ## 0.1.0 ### Minor Changes @@ -25,6 +317,7 @@ this file is a hand-curated overview. standalone functions instead of classes. The motivation is tree-shaking: classes carry every method along with the prototype, so a bundler can't drop unused operations once an instance escapes. + - `Docx` is an `interface` (just `{ opc, document, partName, … }`). - `Docx.create(…)` → `createDocx(…)`. `Docx.open(bytes)` → `openDocx(bytes)`. `Docx.fromBlob(blob)` → `fromBlob(blob)`. diff --git a/package.json b/package.json index 13d38a0..c351851 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@office-kit/docx", - "version": "0.1.1", + "version": "0.2.0", "description": "OOXML-compliant .docx generation for browser and Node.js.", "keywords": [ "docx", diff --git a/packages/editor/CHANGELOG.md b/packages/editor/CHANGELOG.md new file mode 100644 index 0000000..e18a5c5 --- /dev/null +++ b/packages/editor/CHANGELOG.md @@ -0,0 +1,372 @@ +# @office-kit/docx-editor + +## 0.1.0 + +### Minor Changes + +- 48ed589: feat: add `@office-kit/docx-editor` — an MS Office-like WYSIWYG editing core + + New package that turns `@office-kit/docx` into a Word-like editor: an + `EditorModel` with undo/redo, a command layer (text/paragraph/structure/list/ + table/image/style/section/header-footer/references/review) where every mutation + routes through the `@office-kit/docx` public API, an AST→HTML canvas renderer, + and DOM-selection mapping. A SvelteKit ribbon UI ships at the site's `/editor` + route. + + The editing surface is interactive: Enter splits the paragraph at the caret and + Backspace/Delete merge across paragraph boundaries (`splitParagraphCommand` / + `mergeBackCommand`, backed by the library's `splitParagraphAt` / + `mergeParagraphIntoPrevious`); the caret is preserved across structural + re-renders; Ctrl+Z/Y drive undo/redo; paste inserts plain text (multi-line → + paragraphs) keeping the AST in sync; and the UI adds live word/character count, + find & replace, zoom, caret-synced font/size/style, and heading-styled rendering + so the document reads with real visual hierarchy. + + Character formatting is now selection-precise: bolding (or any run format on) a + partial selection splits runs at the selection boundaries and formats only the + selected characters instead of the whole line — backed by the library's + `isolateParagraphRunRange` / `runTextLength`. The ribbon UI is localized into + six languages (English, 日本語, Español, Français, Deutsch, 中文) with a + language switcher. + + Completeness against the WordprocessingML spec is enforced by a capability + ledger: every element in the ECMA-376 schema universe is classified as + `edit` / `render` / `preserve`, and a test fails the build if any element is + unclassified or an editable element's command goes missing. + + The library gains generic property setters so the editor can reach the long + tail of WordprocessingML formatting without a bespoke function per element: + + - run / paragraph: `setRunOnOff` / `setRunValProp` / `getRunProp` and the + `setParagraphOnOff` / `setParagraphValProp` / `getParagraphProp` equivalents; + - any properties container: `setElementOnOff` / `setElementValProp` / + `getElementProp` / `makePropsElement` (for `` / `` / + `` / ``); + - document settings: `setDocumentSettingOnOff` / `setDocumentSettingVal` / + `getDocumentSetting` (creates `word/settings.xml` on demand); + - style definitions: `setStyleOnOff` / `setStyleValProp` / `getStyleProp`; + - numbering levels: `setNumberingLevelVal` / `setNumberingLevelOnOff` / + `getNumberingLevelProp`; + - images: `imageDrawings` / `setImageSizeEmu` / `setImageAltText` / + `getImageInfo` (resize and alt-text existing pictures); + - raw XML nodes: `setElementAttr` / `getElementAttr` / `childElementsOf` / + `appendChildElement` — the universal escape hatch that lets the editor edit + any element (DrawingML shape geometry, OMML math, legacy VML) by attribute or + child, since these live inline in `document.xml` and flush through the + document AST on save; + - arbitrary XML parts: `xmlPartNames` / `getRawPartRoot` / `markRawPartDirty` — + open, edit, and re-serialize any XML part (fontTable, settings, styles, + numbering, comments, foot-/endnotes, headers, footers, webSettings, docProps), + so every OOXML element in the whole package is reachable and editable; + - caret-level structure: `splitParagraphAt` / `mergeParagraphIntoPrevious` — + split a paragraph at a run/offset and merge a paragraph into the previous one + (the primitives behind Enter and Backspace-at-start); + - selection formatting: `isolateParagraphRunRange` / `runTextLength` — isolate a + character range into its own run(s) so formatting applies to exactly the + selected text. + + Also newly exported from `@office-kit/docx` (they are part of the public + surface as parameter/return/AST types): `BuildStyleOptions`, `BuildTableOptions`, + `DocumentCoreProperties`, `DocumentAppProperties`, and the raw XML AST types + `XmlElement` / `XmlNode` / `XmlAttr` / `QName`. + + Commands are atomic: `runCommand` returns the command's result, and a command + that throws (including rejected input such as an out-of-range table size or a + non-http(s)/mailto hyperlink) leaves the document, selection and redo history + unchanged (`EditorModel.abortEdit`). `replaceAllCommand`, `insertTextCommand` and + `deleteSelectionCommand` route Find & Replace, paste, and typing or deleting + over a selection (also across paragraphs) through the same undoable path. + Consecutive keystrokes undo as one step, Shift+Enter breaks the line at the + caret, and hyperlinks and field results are visible on the canvas. Enter, + Backspace and Delete inside a table cell split and join that cell's + paragraphs. IME input that starts over a selection replaces it in one undo + step. `splitParagraphAt` moves a paragraph's + section break to the second half instead of duplicating it. + +- 48ed589: feat: the editor reports and writes formatting the way Microsoft Word does + + - New `createStyleResolver(doc)` returns a paragraph's and a run's effective + formatting: document defaults, the paragraph style's `basedOn` chain, the + character style and direct formatting, with theme fonts looked up. The canvas + renders these values, so headings take their look from `styles.xml`. + Also new: `pageGeometry(doc)`, `highlightCss(value)`, `RunRef`. + - Bold / Italic / Strikethrough / Underline toggles and the alignment buttons + read the effective value. Turning off formatting that comes from a style + writes an explicit off value (``, ``), + as Word does. + - `clearFormattingCommand` now matches Word's Clear All Formatting: a caret + resets its paragraph to Normal; a range clears every character property + except the highlight and resets the paragraphs whose mark it includes. + Previously it wrote explicit `false` values and left color, size and font. + - New `indentStepCommand` (Increase / Decrease Indent in 0.5 in steps), + `setLineSpacingCommand` with `lineSpacingOf`, and `setVertAlignCommand` + (Subscript / Superscript). + - The canvas uses the section's page size and margins, renders paragraph + indents and spacing, and draws tables with their own width, columns, cell + margins and borders (none when the document defines none). + +- 48ed589: Headers, footers and notes can now be read and edited as stories of their own. + + - `@office-kit/docx`: + - `storyBody` / `storyView` give typed access to the body of a header, footer, footnote, endnote or comment. Edits to it are saved with the document. + - `sectionProperties`, `resolveHeaderFooter`, `ensureHeaderFooter`, `isHeaderFooterLinked` and `setHeaderFooterLinked` resolve a section's first, even or default header or footer, including what it inherits from the previous section, and support "Link to Previous". + - `@office-kit/docx-editor`: + - A `DocPosition` may carry a `story`, so selection, typing and formatting commands work inside headers, footers and notes. + - New `stories.*` commands: + - turn "Different First Page" and "Different Odd & Even Pages" on and off; + - set the header and footer distances; + - link a header or footer to the previous section. + - The new layout module (`paginate`, `documentSections`, `createFlagResolver`, `formatNumber`) breaks a document into pages. It handles: + - sections and columns; + - keep with next, keep lines together and widow/orphan control; + - table rows split across pages, with repeated header rows; + - footnote areas. + +- 48ed589: Add Word's Design and Layout features. + + - `@office-kit/docx`: section layout (`getSectionProperties`, `setSectionProperties` and `insertSectionBreak` for columns, line numbering, page borders, the document grid, vertical alignment, text direction and section start), with a `scope` for `setPageSize`, `setPageMargins` and `setPageOrientation`. Also themes (`setTheme`, `setThemeColors`, `setThemeFonts`, `setThemeEffects`, `getTheme`, plus the built-in Office themes and schemes), style sets (`applyStyleSet`, `currentStyleSet`), default paragraph spacing, page colour including gradient fills (`setPageColor`), and text or picture watermarks (`setWatermark`, `getWatermark`). Document settings are now written in schema order. + - `@office-kit/docx-editor`: `design.*` and `layout.*` commands for the Design and Layout ribbon tabs and the Page Setup, Columns, Line Numbers, Hyphenation, Text Direction and Page Borders dialogs. Section commands take a `target` of the whole document, the caret section or "this point forward". Also adds the `resolveSectionLayout`, `resolvePageBackground`, `resolveTheme` and `themePalette` helpers. + +- 48ed589: Word's Home tab formatting. + + - `@office-kit/docx` adds character and paragraph formatting helpers: + - Theme colours (`setRunColor`) and every underline style with an underline colour (`setRunUnderline`). + - Theme fonts (`setRunFont`), character shading and borders (`setRunShading`, `setRunBorder`). + - Paragraph border sides (`setParagraphBorder`) and tab stops (`setParagraphTabs` / `getParagraphTabs`). + - Phonetic guides (`buildRubyRun` / `readRuby`) and enclosed characters (`buildEnclosedCharacterRuns`). + - Custom list definitions with restart (`addListDefinition`, `restartList`). + - Word's built-in styles created on first use (`builtinStyles`, `ensureBuiltinStyle`) and style editing (`updateStyleFormatting`). + - Saved documents now always list property children in the order the schema requires, which Word needs to open the file. + - `@office-kit/docx-editor` adds Home tab commands: + - Font and Paragraph dialog patches, Change Case, Format Painter, Asian layout and Fit Text. + - Border presets, paragraph sorting, and the Bullet / Numbering / Multilevel libraries with restart and continue. + - Applying, creating, modifying and deleting styles. + - Word-style Find and Replace with wildcards, special characters and format filters. + - The canvas now draws list numbers, text effects, run shading and borders, paragraph borders, and ruby. + +- 48ed589: feat: Word's Insert tab — fields, links, symbols, equations, pages and page numbers + + `@office-kit/docx` can now place what Word's Insert tab places at a character offset of a paragraph: + + - Complex fields (`insertField`, `buildComplexField`) with computed results. DATE/TIME (`\@` pictures with localized month and day names via `lang`), document properties, statistics, `=` formulas, IF/COMPARE, SEQ, REF/PAGEREF/NOTEREF, USERNAME and more. `updateFields` recomputes them, `complexFields` lists them, and `insertFormField` writes legacy form fields. + - Links with ScreenTips, target frames and in-document anchors (`insertHyperlink`, `editHyperlink`, `removeHyperlink`, `paragraphHyperlinks`). + - Range bookmarks (`insertBookmark`) and Word's hidden `_Ref` bookmarks for cross-references (`ensureReferenceBookmark`). + - Symbol-font characters as `w:sym` and the special hyphens (`insertSymbol`). + - Equations as OMML from a linear format (UnicodeMath), and back (`insertEquation`, `buildEquation`, `equationLinear`, `setEquation`). + - Drop caps (`setDropCap` / `getDropCap`) and VML signature lines (`insertSignatureLine`). + - Cover pages, header and footer content, page numbers and their format (`pgNumType`), and merging another document's body with its styles, lists and relationships (`insertDocumentContent`). + + `@office-kit/docx-editor` adds commands for all of these, plus: + + - Queries the Insert dialogs need: headings, bookmarks, notes, numbered items and captions to reference, the link at the caret, and the equation under a rendered element. + - Canvas rendering of field results (with a field-code view), symbol-font characters, and equations as MathML. + +- 48ed589: Pictures, charts and object arrangement. + + `@office-kit/docx` adds a picture API (`src/api/picture.ts`): + + - `readDrawing` reads a ``: wrap, anchor position, crop, shape, border, effects, color adjustments and image. + - Arrange: `setDrawingWrap`, `setDrawingPosition`, `setDrawingAnchorOptions`, `arrangeDrawing` (Bring Forward / Send Backward and their variants), `setDrawingTransform`, `setDrawingName`, `setDrawingHidden`, `setDrawingAspectLock`, `setDrawingHyperlink` and `removeDrawing`. + - Picture formatting: `setPictureCrop`, `setPictureGeometry`, `setPictureOutline`, `setPictureEffects`, `setPictureColorAdjustments`, `changePicture` and `resetPicture`. + - Charts: `addChartRun`, `readChart` and `setChart` write a real chart part with an embedded workbook. + - `imagePixelSize` and `imageNaturalSizeEmu` read image dimensions. + + Everything is written as ECMA-376 markup, with no Office extension namespaces. + + Fixed: `setImageSizeEmu` no longer writes into an `a:ext` that sits inside an extension list. + + `@office-kit/docx-editor` adds: + + - Rendering for floating and inline pictures and charts: wrapping, z-order, rotation, crop, effects and blip adjustments. + - `layoutFloatingObjects` and `floatFrameStart` for placing floating objects in the browser. + - Picture, arrange and chart commands, including `drawing.layout` for the Layout Options dialog and `chart.insert` / `chart.edit`. + +- 48ed589: feat: Word's References and Mailings features, with field results computed so a saved document reads correctly before Word updates it. + + - **References** (`@office-kit/docx`): + - Tables of contents and tables of figures: `insertTableOfContents`, `removeTableOfContents`, `setTocLevel`, and `updateTables`. Page numbers come from an optional page provider. + - Footnotes and endnotes: `insertNote`, `noteMarks` (numbering per `w:footnotePr` / `w:endnotePr`), `setNoteProperties`, `noteText` / `setNoteText`, and `convertNotes`. + - Citations and bibliography: sources are stored in the §22.6 customXml part. Use `setBibliographySources`, `setBibliographyStyle`, `insertCitation` and `insertBibliography`. APA and MLA are fully supported; Chicago, IEEE and the numeric styles are approximated. + - Captions: `insertCaption` writes SEQ fields with chapter numbers. `addCaptionLabel` adds a caption label. + - Index: `markIndexEntry`, `markAllIndexEntries` and `insertIndex`. + - Table of authorities: `markAuthorityCitation` and `insertTableOfAuthorities`. + - **Mailings** (`@office-kit/docx`): + - Envelopes and labels: `addEnvelope` and `createLabelDocument`. + - Mail merge setup: `setMailMergeDocumentType`, plus CSV recipient lists via `parseRecipientCsv` and `attachRecipientList`. Match Fields and recipient inclusion are stored in `w:odso`. + - Merge fields and rules: `insertMergeField`, `insertAddressBlock`, `insertGreetingLine`, and `insertMergeRule`, which covers ASK, FILLIN, IF, MERGEREC, MERGESEQ, NEXT, NEXTIF, SET and SKIPIF. + - Preview and merge: `previewMailMerge` and `mergeToNewDocument`, which puts one section per record. + - **Editor** (`@office-kit/docx-editor`): References and Mailings commands for all of the above, plus `findNoteReference` and `selectedText` queries for the ribbon UI. + +- 48ed589: Review and View features. + + `@office-kit/docx`: + + - Tracked changes: `revisions`, `acceptRevisions` / `rejectRevisions` by id, and recording edits as tracked (`insertTrackedText`, `deleteTrackedText`, `trackParagraphMark`, `trackRunFormatChange`, `trackParagraphFormatChange`). Runs inside `` / `` now parse as runs that carry `revision`, so they are editable and save back as the same wrappers. + - `compareDocuments`: diffs two documents into a new document of tracked changes. + - Comments: `comments`, `setCommentText` and `removeComment`. `addComment` accepts a `range`. + - Proofing: `getRunLanguage` / `setRunLanguage`, plus a Word-compatible `wordCount`. + - `checkAccessibility` and `contrastRatio`. + - Document protection: `protectDocument` / `unprotectDocument` with ECMA-376 SHA-512 password hashes, `writeProtection` (Always Open Read-Only, password to modify), and editable exceptions. + - `documentView` / `documentZoom`, custom properties (`customProperties`, `setCustomProperty`, `removeCustomProperty`) and the `hyperlinkBase` app property. + - Settings written through `setDocumentSettingOnOff` / `Val` now follow the schema order of `CT_Settings`. + + `@office-kit/docx-editor`: + + - While Track Changes is on, typing, deleting, splitting and merging paragraphs, and formatting are recorded as revisions. + - Review commands: comments, accept / reject, language, protection. + - Outline commands: level, promote / demote, move. + - Navigation to the previous / next change or comment. + - Review markup classes on the rendered document. + - `protectionRefusal` / `isEditingLocked`, so a UI can honour Restrict Editing. + +- 48ed589: Shapes, text boxes, WordArt, ink and SmartArt. + + - `@office-kit/docx`: build and edit VML shapes (`addShape` with about 120 Word presets, `addWordArt`, ink strokes, `addDrawingCanvas`, groups), with fill (solid, gradient, pattern, picture), outline, shadow, layout, wrapping, z-order, alt text, linked text boxes and vertical text. Insert and edit SmartArt graphics (`addSmartArt`, `setSmartArtNodes`, layouts, colours, styles, size, `removeSmartArt`) as ECMA-376 DrawingML diagram parts. Existing VML from Word documents is read, including shape types. + - `@office-kit/docx-editor`: renders VML shapes, text boxes, WordArt, ink and SmartArt on the canvas (`renderPictHtml` is exported for watermarks), with commands for every Shape Format, SmartArt Design and Draw tab action, editable text boxes, and Ink to Shape recognition (`recognizeInkShape`). + +- 48ed589: Tables, the way Word edits them. + + `@office-kit/docx` gains Word's table operations: insert and delete rows and columns at any position, delete cells (shifting left or up), merge and split cells, split a table, set table / cell widths, alignment, indent, layout, cell spacing, default and per-cell margins, text direction, floating position and alt text, distribute and AutoFit columns, apply borders to any cell range (including diagonals), sort rows, convert text to a table and back with a chosen separator (`unwrapTable` now takes `{ separator }`), and evaluate table formulas (`=SUM(ABOVE)` …). It also ships Word's 105 built-in table styles (Table Grid, Plain / Grid / List Tables in every accent), colored from the document's theme, with Table Style Options (`w:tblLook`) and per-region style formatting. Table property setters now write their children in schema order. + + `@office-kit/docx-editor` adds commands for every Table Design and Table Layout action, renders tables with their style's conditional formatting (header / total rows, first / last columns, banding with the style's band sizes, corner cells), merged cells, row heights, cell margins, vertical alignment, text direction, diagonal borders, cell spacing and nested tables, and exposes the cell-range selection, Tab navigation, gallery previews and a Table Properties snapshot. + +- 48ed589: fix: highlight is written only as a valid `ST_HighlightColor` name + + `` accepts only 16 named colors and `none` (ECMA-376 + §17.18.40). Before this fix, `setRunFormat`, `appendTextRun`, `setParagraphText` + and `setTableCellText` wrote any string there (e.g. `FFFF00`), producing a file + that does not conform to the schema. They now throw a `RangeError`, without + changing the document, for any other value. The new `HIGHLIGHT_COLORS` export + (with the `HighlightColor` type) lists the accepted values. `getRunFormat` still + returns whatever a file holds. + + In the editor, `setHighlightCommand` takes `{ color: HighlightColor }` instead of + a hex string and rejects anything else before changing the document. The site + ribbon's highlight control is now a named list instead of a color picker. + +- 48ed589: fix: run color and font size are written only as schema-valid values + + `setRunFormat`, `appendTextRun`, `setParagraphText` and `setTableCellText` used + to write any `color` string and any `fontSizeHalfPoints` number into + `` / ``. Values like `"red"`, `"#FF0000"`, `-1`, + `23.5` or `NaN` produced files that do not conform to the schema. These writers + now throw a `RangeError`, before changing anything, unless: + + - `color` is six hex digits without `#` (either case) or `"auto"` (ST_HexColor); + - `fontSizeHalfPoints` is a non-negative safe integer (ST_HpsMeasure). `0` stays + valid; there is no application-specific upper bound. + + Untyped JavaScript callers get the same check on the runtime type: a `color` + that is not a string (e.g. the number `123456`, `null`) or a size that is not a + number (e.g. `"24"`) is rejected rather than stringified. + + One case that used to pass silently now throws: `appendTextRun(p, text, { color: "" })` + ignored the empty color, and now rejects it like `setRunFormat` does. + `getRunFormat` still returns whatever a file holds, and untouched values are + saved unchanged. + + In the editor, `setColorCommand` (a leading `#` is still dropped) and + `setFontSizeCommand` (points, rounded to half-points) reject invalid values + before the document changes, with undo and redo history kept. + + The editor canvas also no longer lets a crafted file break out of a run's + `style` attribute: the attribute is HTML-escaped, only six-digit hex colors + become CSS, and quotes, backslashes and line breaks are dropped from font names + when rendering. The document itself is not changed. + +### Patch Changes + +- 48ed589: `contentControlBlocks(block)` reads the paragraphs and tables inside a block-level content control (``), the wrapper Word puts around cover pages, watermarks and tables of contents. The editor canvas uses it to show that content (read-only) instead of a "preserved content" placeholder, so watermarks and cover pages now appear on the page. +- ecb138d: Editing fixes found by adversarial testing: + + - Deleting or typing over a selection that crosses table cells no longer fails silently: within one table the covered cells are emptied, and a selection that leaves the table deletes the rows it touches, as in Word. + - Backspace at the start of a paragraph after a table no longer joins it to the paragraph above the table. An empty paragraph there is removed and the caret moves to the table's last cell. + - Bold, italic, font and other character formatting with a caret (no selection) now behaves like Word: inside a word it formats the whole word (Japanese words included); elsewhere it applies to the text typed next instead of the whole run. + - `runPoint` places a caret after the placeholder of an empty run, so text typed there lands in that run. + - New `isEmptyParagraph` export. + +- d1523b7: `setFontCommand` now treats East Asian fonts the way Word's font box does: + + - An East Asian font, such as 游明朝, ＭＳ ゴシック or SimSun, is applied to East Asian text as well as Latin text. + - A Latin font, such as Arial, changes only the Latin text, so Japanese text keeps its font. + + Two new exports, `isEastAsianFont` and `hasEastAsianText`, expose the checks this uses. + +- 49e6e8a: The canvas now lays out Japanese and Chinese documents the way Word does. Line heights and spacing were checked against Japanese Word for Mac 16: + + - **Vertical text (縦書き).** A section with `textDirection` `tbRl` is laid out top to bottom, right to left, and pages break where Word breaks them. + - **Document grid (§17.6.5).** Lines snap to whole grid lines; for example, 10.5 pt 游明朝 takes one 18 pt line and 28 pt takes three. Auto line spacing scales the grid line, as in Word. A character grid spaces the characters out to the grid pitch. + - **East Asian units.** Indents in characters and spacing in lines are converted to points. + - **Single line height.** 游明朝 and 游ゴシック use the font's own single-line height (1.447 × the size). + - **Character formatting.** + - Emphasis marks (傍点) + - Fit Text (均等割り付け), including a width shared by runs with the same id + - Character scale (文字の拡大/縮小) + - Combine Characters / Two Lines in One (組み文字・割注) + - Horizontal-in-vertical (縦中横) + - **Paragraph settings.** Distributed alignment; kinsoku line breaking; word wrap; hanging punctuation; and the automatic space between Japanese and Latin text or numbers (`autoSpaceDE` / `autoSpaceDN`). + - **Fonts.** Japanese and Chinese font names (游明朝, ＭＳ 明朝, メイリオ, 宋体 …) fall back to the system's Japanese or Chinese fonts. + +- baf2d5c: The editor keeps a paragraph after a table that ends the document, as Word does. Before, there was no way to type below such a table. This affected documents that end with a table, and tables inserted at the end of a document. +- 4dd27ca: Formatted paste and pending formatting: + + - New `insertFragmentCommand` and `parseClipboardHtml`: pasting HTML (from Word, a web page, Google Docs or the editor itself) keeps bold, italic, underline, strikethrough, superscript / subscript, text color, headings, bullet and numbered lists with their levels, line breaks, tabs and tables. As in Word, the first pasted paragraph continues the caret's paragraph and a pasted table goes between its halves; inside a table cell a pasted table becomes paragraphs. + - New `releasePendingFormat`: formatting set at a caret (Bold with no selection, say) and left without typing is dropped once the caret moves on, as in Word, instead of leaving an empty run behind. + +- 49e6e8a: `layoutSpacingCommand` takes spacing in lines (`beforeLines` / `afterLines`, hundredths of a line), the unit Japanese Word's 段落前 / 段落後 boxes use. It also writes the equivalent twips at the section's grid pitch. `spacingLineTwips` returns that pitch. + + `layoutIndentCommand` and `layoutSpacingCommand` keep a paragraph's existing character and line units (`leftChars`, `beforeLines` …). Setting a value in twips clears the matching unit, so the new value shows. Before, a unit that was set kept overriding the new twips value. + +- 48ed589: Style resolution follows more of ECMA-376: toggle properties (bold, italic, caps …) toggle across the table, paragraph and character style levels (§17.7.3), list numbers take their level's run properties (§17.9.24), and complex-script text (Arabic, Hebrew, Thai …) uses its own bold, italic, size and font (`bCs`, `iCs`, `szCs`, `w:cs`). The canvas lists the East Asian and complex-script fonts after the Latin one, so each script draws in its own font. +- 48ed589: The canvas now lays out tabs against the paragraph's tab stops, as Word does: + + - Custom stops are inherited through styles, and `clear` stops remove inherited ones. + - Past the custom stops, tabs go to the document's default tab interval. + - Right, center and decimal stops align the text that follows the tab. + - Dot, hyphen, underscore, heavy and middle-dot leaders are drawn. + + Typing a tab now works too. Tab inserts a tab character, and at the start of a list item Tab and Shift+Tab change the item's level. A caret steps over a tab as a single character. + + Drop caps (`w:framePr w:dropCap`) float into the lines of the paragraph that follows them, instead of sitting on a line of their own. + +- 48ed589: fix: find / replace reach table cells, unit font sizes read correctly, and range state sees middle runs + + - `findText` and `replaceText` (and the body part of `findTextEverywhere` / + `replaceTextEverywhere`) skipped every paragraph inside a table cell, despite + promising "every paragraph" / "every occurrence". They now include cell + paragraphs, in document order, so counts and replacements cover tables. A + table nested inside a cell is still kept as raw XML and not searched. + - `getRunFormat` read `` as 12 half-points (6 pt) because it + ignored the unit. Universal measures (`pt`, `pc`, `pi`, `in`, `cm`, `mm`) are + now converted exactly, so `"12pt"` reads as 24. A value that is not a whole + number of half-points (`"3mm"`) or is invalid (`"-4"`, `"12px"`) leaves + `fontSizeHalfPoints` unset instead of being guessed; the XML keeps the value + as written. + - In the editor, `runsInRange` returned every run of the paragraphs at both + ends of a range, not just the runs the range touches as documented. It now + returns exactly the covered runs (a collapsed caret still returns its + paragraph's runs). The site ribbon uses it, so a differently formatted run in + the middle of a selection shows the field as "Mixed", and choosing a value + applies it to the whole range. + +- 48ed589: `wrappedRuns(inline)` reads the runs inside a hyperlink, simple field, inline content control, smart tag, custom XML or bidi override. The editor canvas uses it so link text shows its own formatting, as Word does: the Hyperlink style for an ordinary link, and plain text for a table of contents entry, instead of always blue and underlined. +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [49e6e8a] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] + - @office-kit/docx@0.2.0 diff --git a/packages/editor/package.json b/packages/editor/package.json index 8e3a0c2..411ddbb 100644 --- a/packages/editor/package.json +++ b/packages/editor/package.json @@ -1,6 +1,6 @@ { "name": "@office-kit/docx-editor", - "version": "0.0.0", + "version": "0.1.0", "description": "MS Office-like WYSIWYG editing core for word-kit .docx documents. Framework-agnostic; every edit routes through @office-kit/docx.", "keywords": [ "docx", diff --git a/packages/preview/CHANGELOG.md b/packages/preview/CHANGELOG.md index 1230349..f0b9ba0 100644 --- a/packages/preview/CHANGELOG.md +++ b/packages/preview/CHANGELOG.md @@ -1,5 +1,30 @@ # @office-kit/docx-preview +## 0.1.1 + +### Patch Changes + +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [49e6e8a] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] + - @office-kit/docx@0.2.0 + ## 0.1.0 ### Minor Changes diff --git a/packages/preview/package.json b/packages/preview/package.json index a14549c..247062d 100644 --- a/packages/preview/package.json +++ b/packages/preview/package.json @@ -1,6 +1,6 @@ { "name": "@office-kit/docx-preview", - "version": "0.1.0", + "version": "0.1.1", "description": "Browser preview for word-kit .docx documents.", "keywords": [ "docx", diff --git a/site/CHANGELOG.md b/site/CHANGELOG.md index ebecb6f..fa1d205 100644 --- a/site/CHANGELOG.md +++ b/site/CHANGELOG.md @@ -1,5 +1,41 @@ # word-kit-site +## 0.0.2 + +### Patch Changes + +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [49e6e8a] +- Updated dependencies [ecb138d] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [d1523b7] +- Updated dependencies [49e6e8a] +- Updated dependencies [baf2d5c] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [4dd27ca] +- Updated dependencies [48ed589] +- Updated dependencies [49e6e8a] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] +- Updated dependencies [48ed589] + - @office-kit/docx@0.2.0 + - @office-kit/docx-editor@0.1.0 + - @office-kit/docx-preview@0.1.1 + ## 0.0.1 ### Patch Changes diff --git a/site/package.json b/site/package.json index 4405e1f..a7c7b8d 100644 --- a/site/package.json +++ b/site/package.json @@ -1,6 +1,6 @@ { "name": "word-kit-site", - "version": "0.0.1", + "version": "0.0.2", "private": true, "type": "module", "scripts": {