@ansonlai/docx-redline-js 0.1.6 → 0.2.1

package/scripts/word-com-differential.ps1

@@ -0,0 +1,133 @@
+param(
+    [string]$FixturesDir = "tmp/validation-docx"
+)
+
+# Differential validation against desktop Microsoft Word (the authoritative
+# OOXML consumer). For each generated fixture, Word itself accepts all
+# revisions and then rejects all revisions, and the resulting document text
+# is compared to the expected outcomes recorded at generation time. This
+# makes Word an independent oracle for the redline engine instead of
+# verifying the library against its own accept/reject transforms.
+#
+# Usage:
+#   node scripts/export-validation-fixtures.mjs
+#   npm run smoke:word:diff
+
+$ErrorActionPreference = 'Stop'
+
+function Get-NormalizedText([string]$text) {
+    if ($null -eq $text) { return '' }
+    $text = $text -replace [string][char]7, ' '   # table cell markers
+    return ($text -replace '\s+', ' ').Trim()
+}
+
+$resolvedDir = Resolve-Path -LiteralPath $FixturesDir -ErrorAction SilentlyContinue
+if (-not $resolvedDir) {
+    Write-Error "Fixtures directory '$FixturesDir' not found. Run: node scripts/export-validation-fixtures.mjs"
+    exit 1
+}
+
+$expectations = Get-ChildItem -LiteralPath $resolvedDir -Filter '*.expected.json' | Sort-Object Name
+if ($expectations.Count -eq 0) {
+    Write-Error "No *.expected.json fixtures in '$resolvedDir'. Run: node scripts/export-validation-fixtures.mjs"
+    exit 1
+}
+
+$word = $null
+$failures = 0
+$results = @()
+
+function Open-FixtureDocument($word, [string]$path) {
+    # Single-argument Open: Windows PowerShell 5.1 COM binding rejects the
+    # long optional-parameter signature. Defaults leave the document
+    # writable, which accept/reject requires; nothing is ever saved.
+    return $word.Documents.Open($path)
+}
+
+try {
+    $word = New-Object -ComObject Word.Application
+    $word.Visible = $false
+    $word.DisplayAlerts = 0  # wdAlertsNone
+
+    foreach ($expectationFile in $expectations) {
+        $name = $expectationFile.BaseName -replace '\.expected$', ''
+        $docxPath = Join-Path $resolvedDir "$name.docx"
+        if (-not (Test-Path -LiteralPath $docxPath)) {
+            Write-Warning "SKIP ${name}: no matching .docx"
+            continue
+        }
+
+        # -Encoding UTF8 is required: Windows PowerShell 5.1 otherwise reads
+        # BOM-less UTF-8 sidecars as ANSI and garbles non-ASCII expectations.
+        $expected = Get-Content -LiteralPath $expectationFile.FullName -Raw -Encoding UTF8 | ConvertFrom-Json
+        $expectedAccepted = Get-NormalizedText $expected.expectedAcceptedText
+        $expectedRejected = Get-NormalizedText $expected.expectedRejectedText
+        $caseFailed = $false
+        $document = $null
+
+        # Phase 1: open cleanly, revisions present, accept-all matches intent.
+        try {
+            $document = Open-FixtureDocument $word ([string]$docxPath)
+            $revisionCount = $document.Revisions.Count
+            if ($revisionCount -lt 1) {
+                Write-Output "FAIL ${name}: Word sees no tracked revisions"
+                $caseFailed = $true
+            }
+            else {
+                $document.AcceptAllRevisions()
+                $acceptedText = Get-NormalizedText $document.Content.Text
+                if ($acceptedText -ne $expectedAccepted) {
+                    Write-Output "FAIL ${name}: accept-all mismatch"
+                    Write-Output "  expected: $expectedAccepted"
+                    Write-Output "  actual:   $acceptedText"
+                    $caseFailed = $true
+                }
+            }
+        }
+        catch {
+            Write-Output "FAIL ${name}: Word could not open/accept: $($_.Exception.Message)"
+            $caseFailed = $true
+        }
+        finally {
+            if ($null -ne $document) { $document.Close(0) | Out-Null; $document = $null }
+        }
+
+        # Phase 2: fresh open, reject-all restores the original text.
+        if (-not $caseFailed) {
+            try {
+                $document = Open-FixtureDocument $word ([string]$docxPath)
+                $document.RejectAllRevisions()
+                $rejectedText = Get-NormalizedText $document.Content.Text
+                if ($rejectedText -ne $expectedRejected) {
+                    Write-Output "FAIL ${name}: reject-all mismatch"
+                    Write-Output "  expected: $expectedRejected"
+                    Write-Output "  actual:   $rejectedText"
+                    $caseFailed = $true
+                }
+            }
+            catch {
+                Write-Output "FAIL ${name}: Word could not open/reject: $($_.Exception.Message)"
+                $caseFailed = $true
+            }
+            finally {
+                if ($null -ne $document) { $document.Close(0) | Out-Null; $document = $null }
+            }
+        }
+
+        if ($caseFailed) {
+            $failures++
+            $results += "FAIL $name"
+        }
+        else {
+            Write-Output "PASS ${name} (revisions: $revisionCount)"
+            $results += "PASS $name"
+        }
+    }
+}
+finally {
+    if ($null -ne $word) { $word.Quit() | Out-Null }
+}
+
+Write-Output ""
+Write-Output "Word differential: $($results.Count - $failures)/$($results.Count) fixtures passed."
+if ($failures -gt 0) { exit 1 }