@ansonlai/docx-redline-js 0.5.2 → 0.5.3

package/AGENTS.md

@@ -144,12 +144,30 @@ const result = await applyOperationsToDocumentXml(documentXml, operations, 'Agen
 The operation runner uses these field names:
 
 ```js
-const operations = [
+const operations = [
   { type: 'redline', target: 'Old paragraph text', modified: 'New paragraph text', targetRef: 12 },
   { type: 'comment', target: 'Paragraph text', textToComment: 'anchor text', commentContent: 'Comment body', targetRef: 18 },
   { type: 'highlight', target: 'Paragraph text', textToHighlight: 'anchor text', color: 'yellow', targetRef: 24 }
-];
-```
+];
+```
+
+To counterpropose text for a paragraph wholly deleted by another reviewer,
+use explicit restoration intent. A normal `redline` remains fail-closed with
+`FOREIGN_PARAGRAPH_MARK_DELETION`:
+
+```js
+const restoration = {
+  type: 'restore',
+  target: { paragraphId: '1A2B3C4D' },
+  modified: 'Restored or adjusted paragraph text.',
+  author: 'Editor'
+};
+```
+
+For a contiguous range, provide `targetEnd`/`targetEndRef` and one string per
+source paragraph in `modified`. Restoration always uses tracked changes,
+preserves the deleted source paragraph, and inserts the counterproposal before
+it with a fresh paragraph ID.
 
 `targetRef` is an optional 1-based paragraph reference used to disambiguate
 duplicate text. An operation-level `author` overrides the batch author; batch
@@ -398,6 +416,9 @@ When the CLI or runner returns an error code, follow these specific recovery act
 | `OVERLAPPING_TEXT_EDITS` | Multiple operations target the same paragraph concurrently. | Consolidate all changes to the same paragraph into a single `redline` or `replace` operation. |
 | `EXISTING_REVISIONS` | Target paragraph contains tracked changes from another author. | Fails closed to protect third-party review marks. If editing inside that reviewer's pending insertion is intended, pass `--existing-revisions slice-cross-author` (or `existingRevisions: 'slice-cross-author'`). Do not pass `accept-all-first` without explicit user authorization. |
 | `PATCH_ROUNDTRIP_MISMATCH` | A cross-author surgical edit did not reconstruct the requested modified text exactly. | Treat the operation as unapplied. Re-extract the exact paragraph text and split the edit into a narrower operation that does not cross the reported structural boundary. |
+| `FOREIGN_PARAGRAPH_MARK_DELETION` | A normal edit attempted to write into a paragraph wholly deleted by another reviewer. | Use an explicit `restore` operation if the user intends to counterpropose that paragraph; otherwise leave the deletion unresolved. |
+| `RESTORATION_STATE_REQUIRED` / `RESTORATION_COUNT_MISMATCH` | A `restore` target is not a wholly foreign-deleted paragraph, or its replacement count does not match the paragraph range. | Re-inspect the document and target the deleted paragraph by stable descriptor; provide exactly one replacement string per source paragraph. |
+| `UNSAFE_DELETED_TABLE_ROW` / `UNSUPPORTED_MOVE_REVISION` / `SECTION_BREAK_PARAGRAPH` / `UNSAFE_PARAGRAPH_PLACEMENT` | Paragraph restoration cannot preserve the source structural boundary safely. | Do not retry as an ordinary redline. Resolve the row/move/section/placement condition manually or narrow the restoration to a safe paragraph. |
 | `COMMENTED_CONTENT_MERGE` / `COMMENTED_CONTENT_DELETE` | Operation would overwrite, revert, or delete content with comments. | Fails closed to prevent orphaned comment threads. Report the comment author and text to the user; resolve the comment before re-editing. |
 | `INVALID_OPERATION` | Operation object violates schema or has incompatible fields. | Validate the JSON structure against [`document-operations.schema.json`](file:///c:/Users/Phara/Desktop/Projects/Docx%20Redline%20JS/docs/schemas/document-operations.schema.json) before targeting is attempted. |
 | `STRUCTURED_CONTENT_INVALID` | Malformed Markdown table or structure in replacement text. | Ensure tables include a separator row (`\| --- \| --- \|`) and consistent column counts; do not downgrade to raw text. |

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## Unreleased
+
+### Safety Fixes
+
+- **Foreign deleted-paragraph resurrection guard**: Refuses non-empty same-paragraph edits when another author owns the paragraph-mark deletion and all existing paragraph content is deleted. The operation now returns `FOREIGN_PARAGRAPH_MARK_DELETION` with the owning author instead of emitting lifecycle-unsafe OOXML; atomic document operations roll back byte-for-byte. `validateRedlineOoxml` reports already-authored instances as warnings.
+
+### New Features
+
+- **Explicit paragraph restoration (`type: 'restore'`)**: Restores or counterproposes another reviewer's pending whole-paragraph deletion as a separately tracked sibling paragraph. The source deletion remains untouched; the restored paragraph receives its own inserted paragraph mark, content insertion, sanitized paragraph properties, and fresh `w14:paraId`. Single paragraphs and contiguous ranges are supported, with full Accept/Reject lifecycle verification and structured refusals at unsafe table-row, move, section-break, and terminal-paragraph boundaries.
+
 ## 0.5.1
 
 ### Highlights & New Features
@@ -19,9 +29,11 @@
 
 - **Validation Update (`validateRedlineOoxml`)**: Refined `NESTED_REVISION` checks to permit direct `<w:ins><w:del>...</w:del></w:ins>` nesting (standard ECMA-376 and Word Desktop behavior), while continuing to strictly reject `ins/ins`, `del/del`, and `del/ins` nesting.
 - **Slicing Round-Trip Guard**: Cross-author surgical edits now preserve whitespace-only insertions (including ordinary-space replacements for NBSP characters beside hyperlinks) and verify the exact accepted-view text before reporting success. A mismatch fails closed with `PATCH_ROUNDTRIP_MISMATCH` and returns the original OOXML unchanged.
+- **Hyperlink-Adjacent Replacement Anchoring**: Paired replacements immediately before or after a hyperlink now retain a stable insertion point after the deletion run is split, preventing qualifiers from being relocated past the hyperlink or following formatted runs.
+- **Multiple Same-Run Insertions**: Insertion-only slicing operations with multiple edit points now apply from right to left against a refreshed live span index, preventing an earlier run split from relocating later insertions.
 - **Insertion Stress Hardening**: Slicing now detects edge whitespace changes exactly, uses a character-local insertion-only diff when the original text is an exact subsequence of the modified text, and coalesces new text into an existing same-author carrier when foreign revisions are also present. This prevents repeated phrases from relocating insertions and prevents invalid `w:ins/w:ins` nesting in mixed-author paragraphs.
 - **Preflight Inspection**: `preflightOperations` now inspects and validates `slice-cross-author` batches, reporting pending foreign-author carrier targets as `ready` instead of `EXISTING_REVISIONS`.
-- **Test Suite Expansion**: Added 6 new test suites covering 36 Word Desktop COM golden fixtures, carrier splitting invariants, the SYN-01..12d synthetic test matrix, PKG-01..06 strict package differential replay, the repeated-text/hyperlink whitespace regression, and 76 deterministic insertion stress scenarios (expanding the suite from 88 to 94 passing suites).
+- **Test Suite Expansion**: Added 7 new test suites covering 36 Word Desktop COM golden fixtures, carrier splitting invariants, the SYN-01..12d synthetic test matrix, PKG-01..06 strict package differential replay, the repeated-text/hyperlink whitespace regression, 76 deterministic insertion stress scenarios, and 12 replacement-anchor lifecycle scenarios (expanding the suite from 88 to 95 passing suites).
 
 ## 0.5.0
 

package/README.md

@@ -520,14 +520,27 @@ import { applyOperationToDocumentXml } from '@ansonlai/docx-redline-js/standalon
 const zip = await JSZip.loadAsync(docxBuffer);
 const documentXml = await zip.file('word/document.xml').async('string');
 
-const opResult = await applyOperationToDocumentXml(
+const opResult = await applyOperationToDocumentXml(
   documentXml,
   { type: 'redline', target: 'old text', modified: 'new text' },
   'Editor'
-);
+);
+
+// Restoring another reviewer's pending whole-paragraph deletion requires
+// explicit intent. The restored counterproposal becomes a separately tracked
+// sibling paragraph; a normal redline operation remains fail-closed.
+const restoration = await applyOperationToDocumentXml(
+  documentXml,
+  {
+    type: 'restore',
+    target: { paragraphId: '1A2B3C4D' },
+    modified: 'Restored or adjusted paragraph text.'
+  },
+  'Editor'
+);
 
 // applyOperationToDocumentXml(...) returns a full w:document payload.
-zip.file('word/document.xml', opResult.documentXml);
+zip.file('word/document.xml', opResult.documentXml);
 
 const fragmentResult = await applyRedlineToOxml(
   paragraphOoxml,

package/core/paragraph-revision-safety.js

@@ -0,0 +1,213 @@
+const NON_CONTENT_CHILDREN = new Set([
+    'pPr',
+    'bookmarkStart', 'bookmarkEnd',
+    'commentRangeStart', 'commentRangeEnd', 'commentReference',
+    'customXmlInsRangeStart', 'customXmlInsRangeEnd',
+    'customXmlDelRangeStart', 'customXmlDelRangeEnd',
+    'moveFromRangeStart', 'moveFromRangeEnd',
+    'moveToRangeStart', 'moveToRangeEnd',
+    'permStart', 'permEnd', 'proofErr'
+]);
+
+function localNameOf(node) {
+    return String(node?.localName || node?.nodeName || '').replace(/^.*:/, '');
+}
+
+function directElementChildren(node) {
+    return Array.from(node?.childNodes || []).filter(child => child.nodeType === 1);
+}
+
+function directChild(node, localName) {
+    return directElementChildren(node).find(child => localNameOf(child) === localName) || null;
+}
+
+function wordAttribute(node, localName) {
+    return node?.getAttribute?.(`w:${localName}`)
+        || node?.getAttribute?.(localName)
+        || '';
+}
+
+function normalizedAuthor(author) {
+    return String(author || '').trim().toLowerCase();
+}
+
+function isAnchorOnlyRun(node) {
+    if (localNameOf(node) !== 'r') return false;
+    return directElementChildren(node).every(child => [
+        'rPr', 'commentReference',
+        'bookmarkStart', 'bookmarkEnd',
+        'commentRangeStart', 'commentRangeEnd',
+        'proofErr'
+    ].includes(localNameOf(child)));
+}
+
+function isNonContentChild(node) {
+    return NON_CONTENT_CHILDREN.has(localNameOf(node)) || isAnchorOnlyRun(node);
+}
+
+function isWhollyDeletedContentNode(node) {
+    if (localNameOf(node) === 'del') return true;
+    if (!['customXml', 'smartTag', 'sdt', 'sdtContent'].includes(localNameOf(node))) return false;
+    const contentChildren = directElementChildren(node).filter(child => (
+        !isNonContentChild(child) && localNameOf(child) !== 'sdtPr'
+    ));
+    return contentChildren.every(isWhollyDeletedContentNode);
+}
+
+function paragraphFallsWithinMoveFromRange(paragraph) {
+    const root = paragraph?.ownerDocument?.documentElement || null;
+    if (!root) return false;
+    const openIds = new Set();
+    for (const node of [root, ...Array.from(root.getElementsByTagName?.('*') || [])]) {
+        if (node === paragraph && openIds.size > 0) return true;
+        const name = localNameOf(node);
+        const id = wordAttribute(node, 'id');
+        if (name === 'moveFromRangeStart' && id !== '') openIds.add(id);
+        if (name === 'moveFromRangeEnd' && id !== '') openIds.delete(id);
+    }
+    return false;
+}
+
+function paragraphMarkDeletion(paragraph) {
+    const pPr = directChild(paragraph, 'pPr');
+    const rPr = directChild(pPr, 'rPr');
+    return directChild(rPr, 'del');
+}
+
+function hasVisibleInsertionContent(insertion) {
+    for (const node of Array.from(insertion?.getElementsByTagName?.('*') || [])) {
+        const localName = localNameOf(node);
+        if (!['t', 'tab', 'br', 'cr', 'noBreakHyphen', 'softHyphen'].includes(localName)) continue;
+        let ancestor = node.parentNode;
+        let hidden = false;
+        while (ancestor && ancestor !== insertion) {
+            const ancestorName = localNameOf(ancestor);
+            if (ancestorName === 'del' || ancestorName === 'moveFrom') {
+                hidden = true;
+                break;
+            }
+            ancestor = ancestor.parentNode;
+        }
+        if (hidden) continue;
+        if (localName !== 't' || (node.textContent || '').length > 0) return true;
+    }
+    return false;
+}
+
+/**
+ * Detects the pre-mutation resurrection target defined by WP08: a paragraph
+ * mark deleted by another author with no surviving content in that paragraph.
+ */
+export function inspectForeignDeletedParagraphTarget(paragraph, mutationAuthor) {
+    const markDeletion = paragraphMarkDeletion(paragraph);
+    if (!markDeletion) {
+        return {
+            matches: false,
+            hasParagraphMarkDeletion: false,
+            foreignParagraphMarkDeletion: false,
+            allContentDeleted: false,
+            ownerAuthor: null,
+            markDeletion: null
+        };
+    }
+
+    const ownerAuthor = wordAttribute(markDeletion, 'author') || null;
+    const foreignParagraphMarkDeletion = !ownerAuthor
+        || normalizedAuthor(ownerAuthor) !== normalizedAuthor(mutationAuthor);
+
+    const contentChildren = directElementChildren(paragraph)
+        .filter(child => !isNonContentChild(child));
+    const allContentDeleted = contentChildren.every(isWhollyDeletedContentNode);
+    return {
+        matches: foreignParagraphMarkDeletion && allContentDeleted,
+        hasParagraphMarkDeletion: true,
+        foreignParagraphMarkDeletion,
+        allContentDeleted,
+        ownerAuthor,
+        markDeletion
+    };
+}
+
+export function getParagraphRestorationRefusal(paragraph) {
+    const pPr = directChild(paragraph, 'pPr');
+    if (directChild(pPr, 'sectPr')) {
+        return {
+            code: 'SECTION_BREAK_PARAGRAPH',
+            message: 'Refusing to restore a deleted paragraph whose paragraph properties contain a section break.'
+        };
+    }
+
+    let ancestor = paragraph?.parentNode || null;
+    while (ancestor) {
+        if (localNameOf(ancestor) === 'moveFrom') {
+            return {
+                code: 'UNSUPPORTED_MOVE_REVISION',
+                message: 'Refusing to restore a paragraph that is part of a pending move-from revision.'
+            };
+        }
+        ancestor = ancestor.parentNode;
+    }
+    if (
+        paragraphFallsWithinMoveFromRange(paragraph)
+        ||
+        paragraph?.getElementsByTagName?.('*')
+        && Array.from(paragraph.getElementsByTagName('*')).some(node => ['moveFrom', 'moveFromRangeStart', 'moveFromRangeEnd'].includes(localNameOf(node)))
+    ) {
+        return {
+            code: 'UNSUPPORTED_MOVE_REVISION',
+            message: 'Refusing to restore a paragraph that is part of a pending move-from revision.'
+        };
+    }
+
+    let row = paragraph?.parentNode || null;
+    while (row && localNameOf(row) !== 'tr') row = row.parentNode;
+    const rowProperties = directChild(row, 'trPr');
+    if (rowProperties && directChild(rowProperties, 'del')) {
+        return {
+            code: 'UNSAFE_DELETED_TABLE_ROW',
+            message: 'Refusing to restore a paragraph inside a table row with a pending row deletion.'
+        };
+    }
+
+    let sibling = paragraph?.nextSibling || null;
+    while (sibling && (sibling.nodeType !== 1 || localNameOf(sibling) !== 'p')) sibling = sibling.nextSibling;
+    if (!sibling) {
+        return {
+            code: 'UNSAFE_PARAGRAPH_PLACEMENT',
+            message: 'Refusing to restore a deleted paragraph without a following paragraph in the same structural container.'
+        };
+    }
+
+    return null;
+}
+
+/**
+ * Finds already-authored same-paragraph resurrection shapes. This is a
+ * warning-only validation predicate because standalone validation has no
+ * mutation baseline with which to prove when a foreign insertion was added.
+ */
+export function findForeignDeletedParagraphResurrections(root) {
+    const paragraphs = localNameOf(root) === 'p'
+        ? [root]
+        : Array.from(root?.getElementsByTagName?.('*') || []).filter(node => localNameOf(node) === 'p');
+    const matches = [];
+
+    for (const paragraph of paragraphs) {
+        const markDeletion = paragraphMarkDeletion(paragraph);
+        if (!markDeletion) continue;
+        const ownerAuthor = wordAttribute(markDeletion, 'author') || null;
+        const contentChildren = directElementChildren(paragraph)
+            .filter(child => !isNonContentChild(child));
+        const foreignInsertions = contentChildren.filter(child => {
+            if (localNameOf(child) !== 'ins' || !hasVisibleInsertionContent(child)) return false;
+            return normalizedAuthor(wordAttribute(child, 'author')) !== normalizedAuthor(ownerAuthor);
+        });
+        const onlyDeletedContentAndForeignInsertions = contentChildren.every(child => {
+            return isWhollyDeletedContentNode(child) || foreignInsertions.includes(child);
+        });
+        if (foreignInsertions.length > 0 && onlyDeletedContentAndForeignInsertions) {
+            matches.push({ paragraph, markDeletion, ownerAuthor, foreignInsertions });
+        }
+    }
+    return matches;
+}

package/core/paragraph-targeting.js

@@ -459,6 +459,25 @@ export function resolveTargetParagraph(xmlDoc, options = {}) {
         return { paragraph: byId, resolvedBy: 'paragraph_id' };
     }
 
+    if (descriptor?.fingerprint && !cleanTargetText && !parsedRef) {
+        let fingerprintCandidates = (paragraphMetadataIndex?.entries || [])
+            .filter(candidate => candidate.fingerprint === descriptor.fingerprint);
+        if (typeof descriptor.inTable === 'boolean') {
+            fingerprintCandidates = fingerprintCandidates.filter(candidate => candidate.inTable === descriptor.inTable);
+        }
+        if (fingerprintCandidates.length === 1) {
+            return { paragraph: fingerprintCandidates[0].paragraph, resolvedBy: 'fingerprint' };
+        }
+        if (fingerprintCandidates.length > 1) {
+            throw createTargetError(
+                'AMBIGUOUS_TARGET',
+                'Target fingerprint matched multiple paragraphs; provide paragraphId or index.',
+                fingerprintCandidates.map(serializeTargetCandidate)
+            );
+        }
+        throw createTargetError('TARGET_NOT_FOUND', `Target fingerprint not found: "${descriptor.fingerprint}".`);
+    }
+
     let candidates = [];
     if (cleanTargetText) {
         const unfilteredCandidates = findStrictTargetCandidates(xmlDoc, cleanTargetText, paragraphMetadataIndex);

package/core/redline-validation.js

@@ -10,6 +10,7 @@
 
 import { parseXml } from '../adapters/xml-adapter.js';
 import { NS_W } from './types.js';
+import { findForeignDeletedParagraphResurrections } from './paragraph-revision-safety.js';
 
 const REVISION_ID_ELEMENTS = new Set(['ins', 'del', 'rPrChange', 'pPrChange']);
 const REVISION_DATE_PATTERN = /^\d{4}-\d{2}-\d{2}T/;
@@ -180,5 +181,17 @@ export function validateRedlineOoxml(oxml) {
         }
     }
 
+    // Structurally valid but lifecycle-unsafe: accepting the paragraph-mark
+    // deletion can merge or discard a foreign insertion placed into a
+    // paragraph whose pre-existing content is otherwise wholly deleted.
+    for (const resurrection of findForeignDeletedParagraphResurrections(doc)) {
+        const ownerAuthor = resurrection.ownerAuthor || 'unattributed';
+        addIssue(
+            'FOREIGN_PARAGRAPH_MARK_DELETION',
+            'warning',
+            `Paragraph deleted by ${ownerAuthor} also contains non-empty insertion content from another author; Accept/Reject lifecycle may not preserve the apparent restoration.`
+        );
+    }
+
     return { valid: !issues.some(issue => issue.severity === 'error'), issues };
 }