@docx-editor.dev/core 2.30.0 → 2.32.0

package/README.md

@@ -114,6 +114,30 @@ Treat DOCX files as untrusted input. The engine validates URLs and limits XML en
 
 Anything you render from document data (a font name, a hyperlink target, a comment body) is still attacker-controlled at your boundary. Render it as text; do not build markup or URLs from it.
 
+## Which API for which job
+
+| Job | Use |
+| --- | --- |
+| Build a review UI in the browser | The React or Vue adapter hooks, plus the review hooks and `DocxEditorReview` from `@docx-editor.dev/pro/react` or `@docx-editor.dev/pro/vue`. |
+| Edit in a headless, server, or agent pipeline | The editing API in `@docx-editor.dev/editor-api`, which follows the Office.js object model. |
+
+| Task | Browser host (React or Vue) | Headless, server, or agent |
+| --- | --- | --- |
+| [Comment on found text](https://www.docx-editor.dev/docs/2.x/recipes/comment-on-found-text) | `editor.findMatches`, `editor.selectMatch`, then `useReview().comment` | `body.search`, then `Range.insertComment` |
+| Reply to a thread | `useReview().reply(item, text)` | `Comment.reply(text)` |
+| [Record a tracked replacement](https://www.docx-editor.dev/docs/2.x/recipes/tracked-replacement) | Suggesting mode, then `editor.exec({ type: 'replaceMatch', match, text })` | `document.changeTrackingMode = 'TrackMineOnly'`, then `Range.insertText(text, 'Replace')` |
+| [Propose an AI rewrite as tracked changes](https://www.docx-editor.dev/docs/2.x/recipes/propose-rewrite) | The same code through `DocxEditor.createBrowser` from `@docx-editor.dev/editor-api/browser` | `prepareRewrite` from `@docx-editor.dev/editor-api/agent` |
+| [Accept or reject a change](https://www.docx-editor.dev/docs/2.x/recipes/accept-reject-without-scrolling) | `useReview().accept(item)` or `useReview().reject(item)` | `Revision.accept()` or `Revision.reject()` |
+| [Open or reveal a change without scrolling](https://www.docx-editor.dev/docs/2.x/recipes/accept-reject-without-scrolling) | `useReview().setActive(key, { reveal: false })` | Not applicable: no viewport |
+| [Highlight ranges](https://www.docx-editor.dev/docs/2.x/recipes/highlight-ranges) | `useHighlights(name, source, options)` | Not applicable |
+| [Custom review rail cards](https://www.docx-editor.dev/docs/2.x/recipes/custom-review-cards) | `DocxEditorReview` with `preset` set to `false`, `useReview().items`, `useStackedReviewPositions`, and `useReviewRailMetrics` | Not applicable |
+| Comment-on-selection button | `DocxEditorReview.AddComment` as a direct child of `DocxEditorReview`, or `useEditorCommand('review.addComment')` | Not applicable |
+| Page setup and paragraph dialogs from a custom toolbar | `DocxEditor.PageSetupDialog` or `DocxEditor.ParagraphDialog` with `open` and a close handler (`onClose` in React, `@close` in Vue); enable the button from `usePageSetup().isEnabled` or `useParagraphFormat().isEnabled` | `Section.pageSetup`, and `Paragraph` properties such as `alignment` |
+
+The review hooks need `reviewModule()` from `@docx-editor.dev/pro` in the editor's modules, and an editor `author` for comments and tracked changes. The editing API takes its author from the `author` option of `DocxEditor.createServer`, imported from `@docx-editor.dev/editor-api`, or of `DocxEditor.createBrowser`, imported from `@docx-editor.dev/editor-api/browser`.
+
+This package ships the task recipes in [`docs/index.md`](./docs/index.md). They are also on the site: [Task recipes](https://www.docx-editor.dev/docs/2.x/recipes).
+
 ## Documentation
 
 - [Core overview](https://www.docx-editor.dev/docs/2.x/core)

package/dist/automation.cjs

@@ -1 +1 @@
-'use strict';var chunkWK5X2MMA_cjs=require('./chunk-WK5X2MMA.cjs');require('./chunk-HYASLE2G.cjs'),require('./chunk-QFKGI242.cjs'),require('./chunk-KJRTNY2Q.cjs'),require('./chunk-5RRAZMBU.cjs'),require('./chunk-YBMWBXST.cjs'),require('./chunk-WF7JZ755.cjs'),require('./chunk-PWTRJSES.cjs');Object.defineProperty(exports,"AUTOMATION_COMMAND_OPERATIONS",{enumerable:true,get:function(){return chunkWK5X2MMA_cjs.e}});Object.defineProperty(exports,"AUTOMATION_QUERY_OPERATIONS",{enumerable:true,get:function(){return chunkWK5X2MMA_cjs.d}});Object.defineProperty(exports,"AUTOMATION_SOLITARY_OPERATIONS",{enumerable:true,get:function(){return chunkWK5X2MMA_cjs.f}});Object.defineProperty(exports,"HEADER_FOOTER_VARIANTS",{enumerable:true,get:function(){return chunkWK5X2MMA_cjs.c}});Object.defineProperty(exports,"SERVER_AUTOMATION_CAPABILITIES",{enumerable:true,get:function(){return chunkWK5X2MMA_cjs.n}});Object.defineProperty(exports,"byteSizeBucket",{enumerable:true,get:function(){return chunkWK5X2MMA_cjs.u}});Object.defineProperty(exports,"countBucket",{enumerable:true,get:function(){return chunkWK5X2MMA_cjs.v}});Object.defineProperty(exports,"createAutomationPaginationProvider",{enumerable:true,get:function(){return chunkWK5X2MMA_cjs.l}});Object.defineProperty(exports,"createDiagnosticEmitter",{enumerable:true,get:function(){return chunkWK5X2MMA_cjs.w}});Object.defineProperty(exports,"createServerAutomationHost",{enumerable:true,get:function(){return chunkWK5X2MMA_cjs.o}});Object.defineProperty(exports,"diagnosticCause",{enumerable:true,get:function(){return chunkWK5X2MMA_cjs.y}});Object.defineProperty(exports,"diagnosticCauses",{enumerable:true,get:function(){return chunkWK5X2MMA_cjs.x}});Object.defineProperty(exports,"diagnosticCodes",{enumerable:true,get:function(){return chunkWK5X2MMA_cjs.q}});Object.defineProperty(exports,"diagnosticErrorName",{enumerable:true,get:function(){return chunkWK5X2MMA_cjs.A}});Object.defineProperty(exports,"documentPartKind",{enumerable:true,get:function(){return chunkWK5X2MMA_cjs.B}});Object.defineProperty(exports,"exceptionCause",{enumerable:true,get:function(){return chunkWK5X2MMA_cjs.z}});Object.defineProperty(exports,"explainDiagnostic",{enumerable:true,get:function(){return chunkWK5X2MMA_cjs.p}});Object.defineProperty(exports,"isAutomationCommand",{enumerable:true,get:function(){return chunkWK5X2MMA_cjs.h}});Object.defineProperty(exports,"isSolitaryAutomationCommand",{enumerable:true,get:function(){return chunkWK5X2MMA_cjs.g}});Object.defineProperty(exports,"openDiagnosticCode",{enumerable:true,get:function(){return chunkWK5X2MMA_cjs.r}});Object.defineProperty(exports,"paginationSnapshotOf",{enumerable:true,get:function(){return chunkWK5X2MMA_cjs.j}});Object.defineProperty(exports,"reviewDiagnosticCode",{enumerable:true,get:function(){return chunkWK5X2MMA_cjs.t}});Object.defineProperty(exports,"storeEditDiagnosticCode",{enumerable:true,get:function(){return chunkWK5X2MMA_cjs.s}});
+'use strict';var chunk3IEXDEFH_cjs=require('./chunk-3IEXDEFH.cjs');require('./chunk-TELQ52LG.cjs'),require('./chunk-FDSL5OJU.cjs'),require('./chunk-6UDJUI3W.cjs'),require('./chunk-OKMEMSKB.cjs'),require('./chunk-TJHE5EET.cjs'),require('./chunk-65XBN67F.cjs'),require('./chunk-O324RB6R.cjs'),require('./chunk-ZOZI27AW.cjs');Object.defineProperty(exports,"AUTOMATION_COMMAND_OPERATIONS",{enumerable:true,get:function(){return chunk3IEXDEFH_cjs.f}});Object.defineProperty(exports,"AUTOMATION_QUERY_OPERATIONS",{enumerable:true,get:function(){return chunk3IEXDEFH_cjs.e}});Object.defineProperty(exports,"AUTOMATION_SOLITARY_OPERATIONS",{enumerable:true,get:function(){return chunk3IEXDEFH_cjs.g}});Object.defineProperty(exports,"HEADER_FOOTER_VARIANTS",{enumerable:true,get:function(){return chunk3IEXDEFH_cjs.d}});Object.defineProperty(exports,"SERVER_AUTOMATION_CAPABILITIES",{enumerable:true,get:function(){return chunk3IEXDEFH_cjs.o}});Object.defineProperty(exports,"byteSizeBucket",{enumerable:true,get:function(){return chunk3IEXDEFH_cjs.w}});Object.defineProperty(exports,"countBucket",{enumerable:true,get:function(){return chunk3IEXDEFH_cjs.x}});Object.defineProperty(exports,"createAutomationPaginationProvider",{enumerable:true,get:function(){return chunk3IEXDEFH_cjs.m}});Object.defineProperty(exports,"createDiagnosticEmitter",{enumerable:true,get:function(){return chunk3IEXDEFH_cjs.y}});Object.defineProperty(exports,"createServerAutomationHost",{enumerable:true,get:function(){return chunk3IEXDEFH_cjs.p}});Object.defineProperty(exports,"diagnosticCause",{enumerable:true,get:function(){return chunk3IEXDEFH_cjs.A}});Object.defineProperty(exports,"diagnosticCauses",{enumerable:true,get:function(){return chunk3IEXDEFH_cjs.z}});Object.defineProperty(exports,"diagnosticCodes",{enumerable:true,get:function(){return chunk3IEXDEFH_cjs.s}});Object.defineProperty(exports,"diagnosticErrorName",{enumerable:true,get:function(){return chunk3IEXDEFH_cjs.C}});Object.defineProperty(exports,"documentPartKind",{enumerable:true,get:function(){return chunk3IEXDEFH_cjs.D}});Object.defineProperty(exports,"exceptionCause",{enumerable:true,get:function(){return chunk3IEXDEFH_cjs.B}});Object.defineProperty(exports,"explainDiagnostic",{enumerable:true,get:function(){return chunk3IEXDEFH_cjs.r}});Object.defineProperty(exports,"isAutomationCommand",{enumerable:true,get:function(){return chunk3IEXDEFH_cjs.i}});Object.defineProperty(exports,"isSolitaryAutomationCommand",{enumerable:true,get:function(){return chunk3IEXDEFH_cjs.h}});Object.defineProperty(exports,"openDiagnosticCode",{enumerable:true,get:function(){return chunk3IEXDEFH_cjs.t}});Object.defineProperty(exports,"paginationSnapshotOf",{enumerable:true,get:function(){return chunk3IEXDEFH_cjs.k}});Object.defineProperty(exports,"reviewDiagnosticCode",{enumerable:true,get:function(){return chunk3IEXDEFH_cjs.v}});Object.defineProperty(exports,"storeEditDiagnosticCode",{enumerable:true,get:function(){return chunk3IEXDEFH_cjs.u}});

package/dist/automation.d.ts

@@ -11,22 +11,21 @@
  * @packageDocumentation
  * @public
  */
-import { A as AutomationOperation, a as AutomationCapabilities, b as AutomationHost } from './protocol-CZ1uUlPO.js';
-export { c as AutomationAlignment, d as AutomationBatchRequest, e as AutomationBatchResponse, f as AutomationChangeEvent, g as AutomationContentControlLock, h as AutomationContentControlRangeLocation, i as AutomationContentControlScope, j as AutomationContentControlSubtype, k as AutomationContentControlValue, l as AutomationError, m as AutomationErrorCode, n as AutomationFontRead, o as AutomationFontWrite, p as AutomationHandle, q as AutomationHandleRef, r as AutomationObjectKind, s as AutomationOperationKind, t as AutomationOperationResult, u as AutomationPageOrientation, v as AutomationPageSetupRead, w as AutomationPageSetupWrite, x as AutomationParagraphFormatRead, y as AutomationParagraphFormatWrite, z as AutomationParagraphRef, B as AutomationPoint, C as AutomationReadingOrder, D as AutomationSaveResult, E as AutomationSearchOptions, F as AutomationSelectionMode, G as AutomationSpan, H as AutomationSpanRef, I as AutomationTextProjection, J as AutomationUnsubscribe, K as AutomationValue } from './protocol-CZ1uUlPO.js';
-import { c as HeaderFooterVariant, N as NoteKind, C as ContentLockPolicy } from './tree-package-store-DKhdEVym.js';
-import { T as TextMeasurer, S as SemanticLayout } from './semantic-records-CjcF26ZL.js';
-import { H as HeadlessDocumentView } from './headless-document-view-DZQN8Bnx.js';
-import { ao as OoxmlPackageLimits, ak as OoxmlPackageRejection } from './types-barrel-CA0xB8kH.js';
-export { ap as RevisionAuthorEntry, a8 as RevisionAuthorResult, aq as RevisionAuthorSkipReason, ar as RevisionBatchEntry, a9 as RevisionBatchResult, as as RevisionBatchSkipDetail, at as RevisionBatchSkipReason, au as RevisionSiteRefusal } from './types-barrel-CA0xB8kH.js';
+import { A as AutomationOperation, a as AutomationCapabilities, b as AutomationHost } from './protocol-DKa4qt7F.js';
+export { c as AutomationAlignment, d as AutomationAuthoringOperation, e as AutomationBatchRequest, f as AutomationBatchResponse, g as AutomationChangeEvent, h as AutomationContentControlLock, i as AutomationContentControlRangeLocation, j as AutomationContentControlScope, k as AutomationContentControlSubtype, l as AutomationContentControlValue, m as AutomationCustomNodePayload, n as AutomationEndpoint, o as AutomationError, p as AutomationErrorCode, q as AutomationFontRead, r as AutomationFontWrite, s as AutomationHandle, t as AutomationHandleRef, u as AutomationInlinePictureRead, v as AutomationInlinePictureWrite, w as AutomationListBullet, x as AutomationListLevelFormat, y as AutomationListNumbering, z as AutomationObjectKind, B as AutomationOperationKind, C as AutomationOperationResult, D as AutomationPageOrientation, E as AutomationPageSetupRead, F as AutomationPageSetupWrite, G as AutomationParagraphFormatRead, H as AutomationParagraphFormatWrite, I as AutomationParagraphRef, J as AutomationPoint, K as AutomationReadingOrder, L as AutomationSaveResult, M as AutomationSearchOptions, N as AutomationSelectionMode, O as AutomationShapeRead, P as AutomationShapeType, Q as AutomationSpan, R as AutomationSpanRef, S as AutomationTextProjection, T as AutomationUnsubscribe, U as AutomationValue } from './protocol-DKa4qt7F.js';
+import { c as HeaderFooterVariant, N as NoteKind, C as ContentLockPolicy } from './tree-package-store-CRHvMyNj.js';
+import { aD as OoxmlPackageLimits, aB as OoxmlPackageRejection } from './tree-op-types-C_S2niXW.js';
+export { aE as AutomationTableMutation, J as RevisionAuthorEntry, K as RevisionAuthorResult, L as RevisionAuthorSkipReason, M as RevisionBatchEntry, Q as RevisionBatchResult, T as RevisionBatchSkipDetail, U as RevisionBatchSkipReason, V as RevisionSiteRefusal } from './tree-op-types-C_S2niXW.js';
+import { T as TextMeasurer, S as SemanticLayout } from './semantic-records-BvN-WWst.js';
+import { H as HeadlessDocumentView } from './headless-document-view-Bcz9_Qva.js';
 import { CollaborationModuleContribution } from './collaboration.js';
-import { B as ByteSizeBucket, b as CountBucket, f as DocumentOpenDiagnosticCode, j as ReviewDiagnosticCode, E as EditDiagnosticCode } from './diagnostic-hints-2Bke6H_w.js';
-export { C as CollaborationDiagnosticCode, c as CustomNodeDiagnosticCode, d as DiagnosticCode, D as DiagnosticErrorName, e as DiagnosticExplanation, a as DocumentPartKind, g as DocumentSaveDiagnosticCode, F as FailureStage, h as FontDiagnosticCode, i as FormattingChangeKind, H as HistoryDiagnosticCode, P as PerformanceDiagnosticCode, R as ReviewChangeKind, k as ReviewOperation, l as diagnosticCodes, m as explainDiagnostic } from './diagnostic-hints-2Bke6H_w.js';
-export { a as diagnosticCause, d as diagnosticCauses, b as diagnosticErrorName, c as documentPartKind, e as exceptionCause } from './diagnostic-context-CcAO4q1s.js';
-import './image-resources-Bipz8toD.js';
-import './omml-equation-DP2WpUbK.js';
-import './editor-scope-7o9xweiJ.js';
+import { B as ByteSizeBucket, b as CountBucket, f as DocumentOpenDiagnosticCode, j as ReviewDiagnosticCode, E as EditDiagnosticCode } from './diagnostic-hints-DK8-V0fk.js';
+export { C as CollaborationDiagnosticCode, c as CustomNodeDiagnosticCode, d as DiagnosticCode, D as DiagnosticErrorName, e as DiagnosticExplanation, a as DocumentPartKind, g as DocumentSaveDiagnosticCode, F as FailureStage, h as FontDiagnosticCode, i as FormattingChangeKind, H as HistoryDiagnosticCode, P as PerformanceDiagnosticCode, R as ReviewChangeKind, k as ReviewOperation, l as diagnosticCodes, m as explainDiagnostic } from './diagnostic-hints-DK8-V0fk.js';
+export { a as diagnosticCause, d as diagnosticCauses, b as diagnosticErrorName, c as documentPartKind, e as exceptionCause } from './diagnostic-context-BtDUY3v2.js';
+export { c as HistoryGroup, H as HistoryGroupOutcome } from './editor-scope-B3L-1ALc.js';
+import './revision-projection-Cn6rZJ7H.js';
 import './collaboration/replication.js';
-import './failure-NS2lsya4.js';
+import './failure-6KGFrDO9.js';
 
 /** The variants a section can declare furniture for. */
 declare const HEADER_FOOTER_VARIANTS: readonly HeaderFooterVariant[];
@@ -63,9 +62,9 @@ type AutomationShapeOwnerStory = {
 };
 
 /** Operations that read. They never open a transaction. */
-declare const AUTOMATION_QUERY_OPERATIONS: readonly ["getTables", "getTable", "getTableRows", "getTableCells", "getTableCell", "getTableCellProperties", "getTableCellBody", "getFields", "getField", "getInlinePictures", "getInlinePicture", "getShapes", "getShape", "getShapeBody", "getChangeTrackingMode", "getDocument", "getDocumentProperty", "getBody", "getParagraphs", "getRange", "getSpanParagraphs", "getText", "getSpanText", "getParagraphId", "search", "getFont", "getParagraphFormat", "getStyle", "getSections", "getPageSetup", "getFurniture", "getNotes", "getNoteBody", "getNoteText", "getNoteKind", "getLists", "getListId", "getListById", "getListParagraphs", "getParagraphList", "getListLevel", "getHyperlink", "getBookmarks", "getBookmarkName", "getBookmarkRange", "getComments", "getCommentReplies", "getCommentId", "getCommentAuthor", "getCommentDate", "getCommentText", "getCommentRange", "getCommentResolved", "getRevisions", "getRevisionType", "getRevisionAuthor", "getRevisionDate", "getRevisionRange", "getContentControls", "getContentControlById", "getContentControlsByTag", "getContentControlsByTitle", "getContentControlTag", "getContentControlTitle", "getContentControlFileId", "getContentControlSubtype", "getContentControlLock", "getContentControlIsBound", "getContentControlPlaceholderShown", "getContentControlTemporary", "getContentControlText", "getContentControlParagraphs", "getContentControlRange"];
+declare const AUTOMATION_QUERY_OPERATIONS: readonly ["getTables", "getTable", "getTableRows", "getTableCells", "getTableCell", "getMergedTableCell", "getTableCellProperties", "getTableCellBody", "getFields", "getField", "getFieldResult", "getInlinePictures", "getInlinePicture", "getShapes", "getShape", "getShapeBody", "getChangeTrackingMode", "getDocument", "getDocumentProperty", "getBody", "getParagraphs", "getRange", "getSpanParagraphs", "getText", "getSpanText", "getTextRanges", "expandSpan", "getReviewedText", "getParagraphId", "search", "getFont", "getParagraphFormat", "getStyle", "getSections", "getPageSetup", "getFurniture", "getNotes", "getNoteBody", "getNoteText", "getNoteKind", "getLists", "getListId", "getListById", "getListParagraphs", "getParagraphList", "getListLevel", "getHyperlink", "getBookmarks", "getBookmarkName", "getBookmarkRange", "getBookmarkNames", "getBookmarkRangeByName", "getComments", "getCommentReplies", "getCommentId", "getCommentAuthor", "getCommentDate", "getCommentText", "getCommentRange", "getCommentResolved", "getRevisions", "getRevisionType", "getRevisionAuthor", "getRevisionDate", "getRevisionRange", "getReviewItemRange", "getContentControls", "getContentControlById", "getContentControlsByTag", "getContentControlsByTitle", "getContentControlTag", "getContentControlTitle", "getContentControlFileId", "getContentControlSubtype", "getContentControlLock", "getContentControlIsBound", "getContentControlPlaceholderShown", "getContentControlTemporary", "getContentControlText", "getContentControlParagraphs", "getContentControlRange"];
 /** Operations that write. Every one of these goes through the single transaction path. */
-declare const AUTOMATION_COMMAND_OPERATIONS: readonly ["removeDocumentInformation", "setDocumentProperties", "insertTableRows", "insertTable", "updateTable", "updateTableCell", "setInlinePicture", "deleteInlinePicture", "insertField", "setFieldCode", "deleteField", "updateFieldResult", "insertInlinePicture", "insertBreak", "setChangeTrackingMode", "proposeInsertion", "proposeDeletion", "proposeReplacement", "insertText", "replaceSpan", "replaceStoryBlocks", "insertParagraph", "splitParagraph", "deleteParagraph", "selectSpan", "selectBookmark", "setFont", "setParagraphFormat", "setStyle", "setPageSetup", "deleteNote", "setListLevel", "startNewList", "attachToList", "detachFromList", "setListLevelFormat", "insertListParagraph", "setHyperlink", "insertComment", "setCommentResolved", "replyToComment", "deleteComment", "acceptRevision", "rejectRevision", "resolveRevisionBatch", "setRevisionAuthorBatch", "acceptAllRevisions", "rejectAllRevisions", "setContentControlValue", "setContentControlProperties", "deleteContentControl", "insertContentControlText", "insertContentControl", "insertCustomNode"];
+declare const AUTOMATION_COMMAND_OPERATIONS: readonly ["removeDocumentInformation", "setDocumentProperties", "insertTableRows", "insertTable", "updateTable", "updateTableCell", "splitTableCell", "setInlinePicture", "deleteInlinePicture", "insertField", "insertOoxml", "setFieldCode", "setFieldResult", "deleteField", "updateFieldResult", "insertInlinePicture", "insertBreak", "setChangeTrackingMode", "proposeInsertion", "proposeDeletion", "proposeReplacement", "insertText", "replaceSpan", "replaceStoryBlocks", "insertParagraph", "splitParagraph", "deleteParagraph", "selectSpan", "selectBookmark", "insertBookmark", "deleteBookmark", "setFont", "setParagraphFormat", "setStyle", "setPageSetup", "deleteNote", "setListLevel", "startNewList", "attachToList", "detachFromList", "setListLevelFormat", "insertListParagraph", "setHyperlink", "insertComment", "setCommentResolved", "replyToComment", "deleteComment", "acceptRevision", "rejectRevision", "resolveRevisionBatch", "setRevisionAuthorBatch", "acceptAllRevisions", "rejectAllRevisions", "setContentControlValue", "setContentControlProperties", "deleteContentControl", "insertContentControlText", "insertContentControl", "insertCustomNode"];
 /**
  * Commands that commit as a PACKAGE transaction and therefore share a batch with nothing.
  *
@@ -165,15 +164,6 @@ interface ServerAutomationHostOptions {
  */
 declare function createServerAutomationHost(bytes: Uint8Array, options?: ServerAutomationHostOptions): ServerAutomationHostResult;
 
-/**
- * Anonymous diagnostics, the neutral half: store reasons → public codes, size and count
- * buckets, and one delivery path. The browser editor and the headless automation runtime both
- * build their diagnostics here, so a refusal gets the same public code on either host.
- *
- * Only the RESULT of a lookup leaves the engine. A raw reason can be a sentence, and a package
- * `detail` can name parts of the file, so neither is ever copied into a diagnostic.
- */
-
 /**
  * The public code for a refused open. `too-large` is the one reason two layers share: the
  * archive reports it WITH the limit it crossed, a single XML part reports it without one.
@@ -184,7 +174,8 @@ declare function openDiagnosticCode(reason: string, limit?: string): DocumentOpe
 /**
  * The public code for a store or host refusal reason, or `null` for a reason this table does
  * not know (a sentence, a binding reason). `unsupported-revision:<kind>` counts as
- * `unsupported-revision`.
+ * `unsupported-revision`, except `unsupported-revision:foreign-insertion`, which has its own
+ * code.
  *
  * @public
  */
@@ -211,4 +202,4 @@ interface DiagnosticEmitter<E> {
 declare function createDiagnosticEmitter<E>(listeners: () => Iterable<(event: E) => unknown>, now?: () => number): DiagnosticEmitter<E>;
 
 export { AUTOMATION_COMMAND_OPERATIONS, AUTOMATION_QUERY_OPERATIONS, AUTOMATION_SOLITARY_OPERATIONS, AutomationCapabilities, AutomationHost, AutomationOperation, ByteSizeBucket, ContentLockPolicy, CountBucket, DocumentOpenDiagnosticCode, EditDiagnosticCode, HEADER_FOOTER_VARIANTS, ReviewDiagnosticCode, SERVER_AUTOMATION_CAPABILITIES, byteSizeBucket, countBucket, createAutomationPaginationProvider, createDiagnosticEmitter, createServerAutomationHost, isAutomationCommand, isSolitaryAutomationCommand, openDiagnosticCode, paginationSnapshotOf, reviewDiagnosticCode, storeEditDiagnosticCode };
-export type { AutomationPaginationOptions, AutomationPaginationProvider, AutomationPaginationSnapshot, AutomationStoryId, DiagnosticEmitter, DiagnosticPayload, ServerAutomationHostOptions, ServerAutomationHostRejection, ServerAutomationHostResult };
+export type { AutomationPaginationOptions, AutomationPaginationProvider, AutomationPaginationSnapshot, AutomationShapeOwnerStory, AutomationStoryId, DiagnosticEmitter, DiagnosticPayload, ServerAutomationHostOptions, ServerAutomationHostRejection, ServerAutomationHostResult };

package/dist/automation.js

@@ -1 +1 @@
-export{e as AUTOMATION_COMMAND_OPERATIONS,d as AUTOMATION_QUERY_OPERATIONS,f as AUTOMATION_SOLITARY_OPERATIONS,c as HEADER_FOOTER_VARIANTS,n as SERVER_AUTOMATION_CAPABILITIES,u as byteSizeBucket,v as countBucket,l as createAutomationPaginationProvider,w as createDiagnosticEmitter,o as createServerAutomationHost,y as diagnosticCause,x as diagnosticCauses,q as diagnosticCodes,A as diagnosticErrorName,B as documentPartKind,z as exceptionCause,p as explainDiagnostic,h as isAutomationCommand,g as isSolitaryAutomationCommand,r as openDiagnosticCode,j as paginationSnapshotOf,t as reviewDiagnosticCode,s as storeEditDiagnosticCode}from'./chunk-5OTS2EJ7.js';import'./chunk-NKPUH3QJ.js';import'./chunk-UM26GH5B.js';import'./chunk-WPDD2Y32.js';import'./chunk-T32MGBJS.js';import'./chunk-PF5NJWS3.js';import'./chunk-YZGUBCHP.js';import'./chunk-5SPITS5F.js';
+export{f as AUTOMATION_COMMAND_OPERATIONS,e as AUTOMATION_QUERY_OPERATIONS,g as AUTOMATION_SOLITARY_OPERATIONS,d as HEADER_FOOTER_VARIANTS,o as SERVER_AUTOMATION_CAPABILITIES,w as byteSizeBucket,x as countBucket,m as createAutomationPaginationProvider,y as createDiagnosticEmitter,p as createServerAutomationHost,A as diagnosticCause,z as diagnosticCauses,s as diagnosticCodes,C as diagnosticErrorName,D as documentPartKind,B as exceptionCause,r as explainDiagnostic,i as isAutomationCommand,h as isSolitaryAutomationCommand,t as openDiagnosticCode,k as paginationSnapshotOf,v as reviewDiagnosticCode,u as storeEditDiagnosticCode}from'./chunk-UMMRURPE.js';import'./chunk-QXJKYNYZ.js';import'./chunk-DDFHKQFU.js';import'./chunk-ETDZFNMI.js';import'./chunk-L5TYBFDB.js';import'./chunk-ACLR4DMK.js';import'./chunk-HDOXACHP.js';import'./chunk-IILEENID.js';import'./chunk-GWM3AKUD.js';

package/dist/binding.cjs

@@ -1 +1 @@
-'use strict';var chunkBGCUTKWE_cjs=require('./chunk-BGCUTKWE.cjs');require('./chunk-FLBEJC6X.cjs'),require('./chunk-KJRTNY2Q.cjs'),require('./chunk-5RRAZMBU.cjs'),require('./chunk-YBMWBXST.cjs'),require('./chunk-WF7JZ755.cjs'),require('./chunk-PWTRJSES.cjs');Object.defineProperty(exports,"PROJECTION_ORIGIN",{enumerable:true,get:function(){return chunkBGCUTKWE_cjs.l}});Object.defineProperty(exports,"bodyParagraphs",{enumerable:true,get:function(){return chunkBGCUTKWE_cjs.c}});Object.defineProperty(exports,"docToTreeOps",{enumerable:true,get:function(){return chunkBGCUTKWE_cjs.f}});Object.defineProperty(exports,"mountTreeSurface",{enumerable:true,get:function(){return chunkBGCUTKWE_cjs.m}});Object.defineProperty(exports,"openTreeSession",{enumerable:true,get:function(){return chunkBGCUTKWE_cjs.j}});Object.defineProperty(exports,"partHasNode",{enumerable:true,get:function(){return chunkBGCUTKWE_cjs.g}});Object.defineProperty(exports,"reconcileDoc",{enumerable:true,get:function(){return chunkBGCUTKWE_cjs.h}});Object.defineProperty(exports,"runPropsOf",{enumerable:true,get:function(){return chunkBGCUTKWE_cjs.b}});Object.defineProperty(exports,"treeSchema",{enumerable:true,get:function(){return chunkBGCUTKWE_cjs.a}});Object.defineProperty(exports,"treeToDoc",{enumerable:true,get:function(){return chunkBGCUTKWE_cjs.e}});
+'use strict';var chunk25EXMBV2_cjs=require('./chunk-25EXMBV2.cjs');require('./chunk-XJYZVGQR.cjs'),require('./chunk-6UDJUI3W.cjs'),require('./chunk-OKMEMSKB.cjs'),require('./chunk-TJHE5EET.cjs'),require('./chunk-65XBN67F.cjs'),require('./chunk-O324RB6R.cjs'),require('./chunk-ZOZI27AW.cjs');Object.defineProperty(exports,"PROJECTION_ORIGIN",{enumerable:true,get:function(){return chunk25EXMBV2_cjs.n}});Object.defineProperty(exports,"bodyParagraphs",{enumerable:true,get:function(){return chunk25EXMBV2_cjs.c}});Object.defineProperty(exports,"docToTreeOps",{enumerable:true,get:function(){return chunk25EXMBV2_cjs.f}});Object.defineProperty(exports,"mountTreeSurface",{enumerable:true,get:function(){return chunk25EXMBV2_cjs.o}});Object.defineProperty(exports,"openTreeSession",{enumerable:true,get:function(){return chunk25EXMBV2_cjs.l}});Object.defineProperty(exports,"partHasNode",{enumerable:true,get:function(){return chunk25EXMBV2_cjs.g}});Object.defineProperty(exports,"reconcileDoc",{enumerable:true,get:function(){return chunk25EXMBV2_cjs.h}});Object.defineProperty(exports,"runPropsOf",{enumerable:true,get:function(){return chunk25EXMBV2_cjs.b}});Object.defineProperty(exports,"treeSchema",{enumerable:true,get:function(){return chunk25EXMBV2_cjs.a}});Object.defineProperty(exports,"treeToDoc",{enumerable:true,get:function(){return chunk25EXMBV2_cjs.e}});

package/dist/binding.d.ts

@@ -9,27 +9,28 @@
  * @public
  */
 import { Node, Schema } from 'prosemirror-model';
-import { am as OoxmlProperty, an as OoxmlPackageResult, ak as OoxmlPackageRejection } from './types-barrel-CA0xB8kH.js';
-import { T as TreeDocxSessionView, a as TreeApplyResult } from './tree-session-contract-CwnTEVLF.js';
-export { D as DocumentStyleEntry, M as MapResult, b as TreeApplyOptions, c as TreeBindingRejection, d as bodyParagraphs, e as docToTreeOps, p as partHasNode, r as reconcileDoc, t as treeToDoc } from './tree-session-contract-CwnTEVLF.js';
-import { C as ContentLockPolicy } from './tree-package-store-DKhdEVym.js';
-export { S as StoryScope, b as StoryTargetRejection } from './tree-package-store-DKhdEVym.js';
+import { az as OoxmlProperty, aA as OoxmlPackageResult, aB as OoxmlPackageRejection } from './tree-op-types-C_S2niXW.js';
+import { T as TreeDocxSessionView, a as TreeApplyResult } from './tree-session-contract-D1awo_dA.js';
+export { D as DocumentStyleEntry, M as MapResult, P as PackageWriteOptions, b as TreeApplyOptions, c as TreeBindingRejection, d as bodyParagraphs, e as docToTreeOps, p as partHasNode, r as reconcileDoc, t as treeToDoc } from './tree-session-contract-D1awo_dA.js';
+import { C as ContentLockPolicy } from './tree-package-store-CRHvMyNj.js';
+export { S as StoryScope, a as StoryTargetRejection } from './tree-package-store-CRHvMyNj.js';
 import { ReviewModuleContribution } from './contracts/modules.js';
 import { EditorView } from 'prosemirror-view';
-import './editor-scope-7o9xweiJ.js';
-import './image-resources-Bipz8toD.js';
-import './custom-node-writes-0v0Kgw1T.js';
-import './headless-document-view-DZQN8Bnx.js';
+import './editor-scope-B3L-1ALc.js';
+import './custom-node-writes-CLJKGD9t.js';
+import './headless-document-view-Bcz9_Qva.js';
 import './collaboration/replication.js';
-import './semantic-records-CjcF26ZL.js';
-import './omml-equation-DP2WpUbK.js';
-import './editor-DaEJd2so.js';
+import './revision-projection-Cn6rZJ7H.js';
+import './contracts/types.js';
+import './failure-6KGFrDO9.js';
+import './document-protection-NaniLHWF.js';
+import './editor-DZwOTmlR.js';
+import './editor-fonts-D_-vjuJi.js';
+import './diagnostic-hints-DK8-V0fk.js';
 import './contracts/document.js';
 import './contracts/interaction.js';
-import './semantic-interaction-Dc3pf3hr.js';
-import './document-protection-8eyMWIJ0.js';
-import './failure-NS2lsya4.js';
-import './diagnostic-hints-2Bke6H_w.js';
+import './semantic-interaction-CJoHLoOl.js';
+import './semantic-records-BvN-WWst.js';
 import './collaboration.js';
 
 /** Attributes carried by a projected paragraph. */

package/dist/binding.js

@@ -1 +1 @@
-export{l as PROJECTION_ORIGIN,c as bodyParagraphs,f as docToTreeOps,m as mountTreeSurface,j as openTreeSession,g as partHasNode,h as reconcileDoc,b as runPropsOf,a as treeSchema,e as treeToDoc}from'./chunk-2PV5L5NJ.js';import'./chunk-RJCQGJR7.js';import'./chunk-WPDD2Y32.js';import'./chunk-T32MGBJS.js';import'./chunk-PF5NJWS3.js';import'./chunk-YZGUBCHP.js';import'./chunk-5SPITS5F.js';
+export{n as PROJECTION_ORIGIN,c as bodyParagraphs,f as docToTreeOps,o as mountTreeSurface,l as openTreeSession,g as partHasNode,h as reconcileDoc,b as runPropsOf,a as treeSchema,e as treeToDoc}from'./chunk-GIY6NT2X.js';import'./chunk-B2BEELUE.js';import'./chunk-ETDZFNMI.js';import'./chunk-L5TYBFDB.js';import'./chunk-ACLR4DMK.js';import'./chunk-HDOXACHP.js';import'./chunk-IILEENID.js';import'./chunk-GWM3AKUD.js';

package/dist/bookmark-names-DDuAra_V.d.ts

@@ -0,0 +1,37 @@
+/** The longest name a bookmark is written with. */
+declare const MAX_AUTHORED_BOOKMARK_NAME_LENGTH = 40;
+/**
+ * Why a name cannot be written, or null when it can.
+ *
+ * - `empty`: no characters.
+ * - `tooLong`: more than {@link MAX_AUTHORED_BOOKMARK_NAME_LENGTH} characters.
+ * - `invalidStart`: the first character is not a letter or an underscore.
+ * - `invalidCharacter`: a later character is not a letter, a digit or an underscore.
+ *
+ * @public
+ */
+type BookmarkNameProblem = 'empty' | 'tooLong' | 'invalidStart' | 'invalidCharacter';
+/**
+ * Check a name before it is written. Measured in code points, so a letter outside the Basic
+ * Multilingual Plane counts once.
+ *
+ * @public
+ */
+declare function bookmarkNameProblem(name: string): BookmarkNameProblem | null;
+/**
+ * Whether a bookmark is hidden: its name starts with an underscore. Hidden bookmarks are the
+ * ones applications write for themselves, such as the targets of a table of contents.
+ *
+ * @public
+ */
+declare function isHiddenBookmarkName(name: string): boolean;
+/**
+ * The key two names are compared by. Names are case-insensitive, so `Intro` and `intro`
+ * share a key.
+ *
+ * @public
+ */
+declare function bookmarkNameKey(name: string): string;
+
+export { MAX_AUTHORED_BOOKMARK_NAME_LENGTH as M, bookmarkNameProblem as a, bookmarkNameKey as b, isHiddenBookmarkName as i };
+export type { BookmarkNameProblem as B };