Add collaborative reference merge guard

collaborative-reference-merge-guard/README.md

@@ -0,0 +1,37 @@
+# Collaborative Reference Merge Guard
+
+This module adds a self-contained reference library merge guard for issue #12, Real-time collaborative research editor & interface.
+
+It validates concurrent Zotero, BibTeX, and EndNote-style library merges before a collaborative manuscript is exported. It detects DOI/PMID duplicate records, citation-key collisions, stale in-text citation anchors, locked-reference edits, incomplete source metadata, and unresolved merge conflicts.
+
+The module is dependency-free, uses only synthetic sample data, and performs no calls to Zotero, EndNote, Crossref, PubMed, browser sessions, credentials, or external services.
+
+## Files
+
+- `index.js`: merge evaluation logic and reviewer packet formatter.
+- `sample-data.js`: three synthetic collaborative editor scenarios.
+- `test.js`: Node test coverage for hold, review, and export-ready decisions.
+- `demo.js`: writes JSON, Markdown, SVG, and MP4 reviewer artifacts under `reports/`.
+- `requirements-map.md`: maps the implementation to issue #12 requirements.
+
+## Run
+
+```bash
+node --test collaborative-reference-merge-guard/test.js
+node collaborative-reference-merge-guard/demo.js
+```
+
+To generate `reports/demo.mp4`, set `FFMPEG_PATH` to a local ffmpeg binary before running `demo.js`.
+
+## Outputs
+
+- `reports/reference-merge-packet.json`
+- `reports/reference-merge-review.md`
+- `reports/summary.svg`
+- `reports/demo.mp4`
+
+## Decision Model
+
+- `hold-export`: blocking duplicate identifiers, citation-key collisions, stale anchors, or locked-reference edits are present.
+- `merge-review`: no blockers, but incomplete metadata or unresolved import conflicts need human review.
+- `export-ready`: merged references and manuscript citations are safe to sync and export.

collaborative-reference-merge-guard/demo.js

@@ -0,0 +1,148 @@
+const fs = require('node:fs');
+const path = require('node:path');
+const {spawnSync} = require('node:child_process');
+
+const {
+  evaluateReferenceLibraryMerge,
+  buildReferenceMergePacket,
+} = require('./index');
+const {scenarios} = require('./sample-data');
+
+const reportsDir = path.join(__dirname, 'reports');
+const framesDir = path.join(reportsDir, 'frames');
+fs.mkdirSync(reportsDir, {recursive: true});
+
+const evaluations = scenarios.map((scenario) => ({
+  scenario: scenario.name,
+  ...evaluateReferenceLibraryMerge(scenario),
+}));
+
+const decisionCounts = evaluations.reduce((counts, item) => {
+  counts[item.decision] = (counts[item.decision] || 0) + 1;
+  return counts;
+}, {});
+
+const totals = evaluations.reduce(
+  (sum, item) => {
+    sum.findings += item.summary.findingCount;
+    sum.blocking += item.summary.blockingFindingCount;
+    sum.review += item.summary.reviewFindingCount;
+    sum.gated += item.gatedActions.length;
+    return sum;
+  },
+  {findings: 0, blocking: 0, review: 0, gated: 0}
+);
+
+const packetJson = JSON.stringify(evaluations, null, 2);
+const reviewerPacket = evaluations.map(buildReferenceMergePacket).join('\n---\n');
+const svg = `<svg xmlns="http://www.w3.org/2000/svg" width="960" height="540" viewBox="0 0 960 540">
+  <rect width="960" height="540" fill="#18251f"/>
+  <text x="48" y="72" fill="#f8fafc" font-family="Arial, sans-serif" font-size="32" font-weight="700">Collaborative Reference Merge Guard</text>
+  <text x="48" y="112" fill="#bbf7d0" font-family="Arial, sans-serif" font-size="18">Checks Zotero, BibTeX, and EndNote merges before collaborative manuscript export</text>
+  <g transform="translate(48 154)">
+    <rect width="260" height="148" rx="8" fill="#991b1b"/>
+    <text x="24" y="46" fill="#fee2e2" font-family="Arial, sans-serif" font-size="20" font-weight="700">Hold Export</text>
+    <text x="24" y="108" fill="#fef2f2" font-family="Arial, sans-serif" font-size="56" font-weight="700">${decisionCounts['hold-export'] || 0}</text>
+  </g>
+  <g transform="translate(350 154)">
+    <rect width="260" height="148" rx="8" fill="#a16207"/>
+    <text x="24" y="46" fill="#fef3c7" font-family="Arial, sans-serif" font-size="20" font-weight="700">Merge Review</text>
+    <text x="24" y="108" fill="#fffbeb" font-family="Arial, sans-serif" font-size="56" font-weight="700">${decisionCounts['merge-review'] || 0}</text>
+  </g>
+  <g transform="translate(652 154)">
+    <rect width="260" height="148" rx="8" fill="#047857"/>
+    <text x="24" y="46" fill="#d1fae5" font-family="Arial, sans-serif" font-size="20" font-weight="700">Export Ready</text>
+    <text x="24" y="108" fill="#ecfdf5" font-family="Arial, sans-serif" font-size="56" font-weight="700">${decisionCounts['export-ready'] || 0}</text>
+  </g>
+  <text x="48" y="374" fill="#e5e7eb" font-family="Arial, sans-serif" font-size="22">Findings: ${totals.findings} | Blocking: ${totals.blocking} | Review: ${totals.review} | Gated actions: ${totals.gated}</text>
+  <text x="48" y="418" fill="#d1d5db" font-family="Arial, sans-serif" font-size="18">Checks: DOI/PMID duplicates, key collisions, stale citation anchors, locked edits, source metadata, unresolved merge conflicts</text>
+  <text x="48" y="472" fill="#9ca3af" font-family="Arial, sans-serif" font-size="16">Synthetic reference data only. No Zotero, EndNote, Crossref, PubMed, browser, credential, or network calls.</text>
+</svg>
+`;
+
+fs.writeFileSync(path.join(reportsDir, 'reference-merge-packet.json'), `${packetJson}\n`);
+fs.writeFileSync(path.join(reportsDir, 'reference-merge-review.md'), reviewerPacket);
+fs.writeFileSync(path.join(reportsDir, 'summary.svg'), svg);
+
+function fillRect(buffer, width, x0, y0, rectWidth, rectHeight, color) {
+  const [r, g, b] = color;
+  const height = Math.floor(buffer.length / (width * 3));
+  const x1 = Math.min(width, x0 + rectWidth);
+  const y1 = Math.min(height, y0 + rectHeight);
+  for (let y = Math.max(0, y0); y < y1; y += 1) {
+    for (let x = Math.max(0, x0); x < x1; x += 1) {
+      const offset = (y * width + x) * 3;
+      buffer[offset] = r;
+      buffer[offset + 1] = g;
+      buffer[offset + 2] = b;
+    }
+  }
+}
+
+function writePpmFrame(filePath, frameIndex, frameCount) {
+  const width = 640;
+  const height = 360;
+  const buffer = Buffer.alloc(width * height * 3);
+  for (let i = 0; i < width * height; i += 1) {
+    buffer[i * 3] = 24;
+    buffer[i * 3 + 1] = 37;
+    buffer[i * 3 + 2] = 31;
+  }
+
+  const progress = frameIndex / Math.max(1, frameCount - 1);
+  fillRect(buffer, width, 42, 42, 556, 42, [248, 250, 252]);
+  fillRect(buffer, width, 42, 112, 150, 118, [153, 27, 27]);
+  fillRect(buffer, width, 245, 112, 150, 118, [161, 98, 7]);
+  fillRect(buffer, width, 448, 112, 150, 118, [4, 120, 87]);
+  fillRect(buffer, width, 78, 260, 112, 30, [248, 113, 113]);
+  fillRect(buffer, width, 264, 260, 112, 30, [251, 191, 36]);
+  fillRect(buffer, width, 450, 260, 112, 30, [52, 211, 153]);
+  fillRect(buffer, width, 42, 318, Math.round(556 * progress), 18, [187, 247, 208]);
+  fillRect(buffer, width, 42 + Math.round(508 * progress), 309, 48, 36, [240, 253, 244]);
+
+  const header = Buffer.from(`P6\n${width} ${height}\n255\n`);
+  fs.writeFileSync(filePath, Buffer.concat([header, buffer]));
+}
+
+function createDemoVideo() {
+  const ffmpegPath = process.env.FFMPEG_PATH;
+  if (!ffmpegPath) {
+    console.log('FFMPEG_PATH not set; skipped MP4 generation.');
+    return;
+  }
+
+  fs.rmSync(framesDir, {recursive: true, force: true});
+  fs.mkdirSync(framesDir, {recursive: true});
+  const frameCount = 72;
+  for (let index = 0; index < frameCount; index += 1) {
+    writePpmFrame(path.join(framesDir, `frame-${String(index).padStart(3, '0')}.ppm`), index, frameCount);
+  }
+
+  const output = path.join(reportsDir, 'demo.mp4');
+  const result = spawnSync(ffmpegPath, [
+    '-y',
+    '-framerate',
+    '24',
+    '-i',
+    path.join(framesDir, 'frame-%03d.ppm'),
+    '-c:v',
+    'libx264',
+    '-pix_fmt',
+    'yuv420p',
+    output,
+  ], {encoding: 'utf8'});
+
+  fs.rmSync(framesDir, {recursive: true, force: true});
+  if (result.status !== 0) {
+    throw new Error(result.stderr || 'ffmpeg failed');
+  }
+}
+
+createDemoVideo();
+
+console.log(JSON.stringify({
+  scenarios: evaluations.length,
+  reportsDir,
+  decisions: decisionCounts,
+  totals,
+}, null, 2));