@richscripts/richtexteditor 2.4.0 → 2.4.1

package/migration/index.js

@@ -0,0 +1,242 @@
+"use strict";
+
+var SOURCES = ["tinymce", "ckeditor", "froala", "quill", "tiptap", "lexical"];
+var COMMANDS = {
+  bold: "bold", italic: "italic", underline: "underline", strike: "strikethrough", strikethrough: "strikethrough",
+  bullist: "insertunorderedlist", bulletedlist: "insertunorderedlist", bulletlist: "insertunorderedlist",
+  numlist: "insertorderedlist", numberedlist: "insertorderedlist", orderedlist: "insertorderedlist",
+  link: "insertlink", insertlink: "insertlink", image: "insertimage", imageupload: "insertimage", insertimage: "insertimage",
+  table: "inserttable", inserttable: "inserttable", blockquote: "blockquote", code: "code", codesample: "insertcode",
+  undo: "undo", redo: "redo", alignleft: "justifyleft", aligncenter: "justifycenter", alignright: "justifyright",
+  alignjustify: "justifyfull", removeformat: "removeformat", sourcecode: "htmlcode", fullscreen: "fullpage"
+};
+
+function assertSource(source) {
+  source = String(source || "").toLowerCase().replace(/[^a-z]/g, "");
+  if (source === "ckeditor5") { source = "ckeditor"; }
+  if (SOURCES.indexOf(source) < 0) { throw new TypeError("Unsupported migration source: " + source); }
+  return source;
+}
+function escapeHtml(value) { return String(value == null ? "" : value).replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;"); }
+function safeHref(value) {
+  var href = String(value || "").trim();
+  return /^(?:https?:|mailto:|tel:|#|\/)/i.test(href) ? href : "";
+}
+function safeTarget(value) { value = String(value || ""); return /^(?:_blank|_self|_parent|_top)$/i.test(value) ? value.toLowerCase() : ""; }
+function safeDimension(value) { var number = Number(value); return Number.isFinite(number) && number > 0 ? String(Math.round(number)) : ""; }
+function positiveSpan(value) { var number = Number(value); return Number.isInteger(number) && number > 1 ? String(number) : ""; }
+function linkAttributes(attrs) {
+  attrs = attrs || {}; var output = "", target = safeTarget(attrs.target), rel = String(attrs.rel || "").trim();
+  if (target) output += " target=\"" + target + "\"";
+  if (rel && /^[a-z\s-]+$/i.test(rel)) output += " rel=\"" + escapeHtml(rel) + "\"";
+  return output;
+}
+function imageAttributes(attrs) {
+  attrs = attrs || {}; var output = " alt=\"" + escapeHtml(attrs.alt || "") + "\"", width = safeDimension(attrs.width), height = safeDimension(attrs.height);
+  if (attrs.title) output += " title=\"" + escapeHtml(attrs.title) + "\"";
+  if (width) output += " width=\"" + width + "\"";
+  if (height) output += " height=\"" + height + "\"";
+  return output;
+}
+function unique(values) { return values.filter(function (value, index) { return values.indexOf(value) === index; }); }
+function recordFinding(inventory, kind, name, path) {
+  var existing = inventory.filter(function (item) { return item.kind === kind && item.name === name; })[0];
+  if (existing) { existing.count += 1; if (path && existing.paths.indexOf(path) < 0) existing.paths.push(path); }
+  else inventory.push({ kind: kind, name: name, count: 1, paths: path ? [path] : [] });
+}
+function customConverter(options, source, kind, name) {
+  var sourceConverters = options && options.converters && options.converters[source];
+  var group = sourceConverters && sourceConverters[kind + "s"];
+  return group && Object.prototype.hasOwnProperty.call(group, name) && typeof group[name] === "function" ? group[name] : null;
+}
+function runCustomConverter(options, source, kind, name, value, context, warnings, applied) {
+  var converter = customConverter(options, source, kind, name), result;
+  if (!converter) return null;
+  result = converter(value, Object.assign({ source: source, kind: kind, name: name }, context || {}));
+  if (result == null) return null;
+  if (typeof result === "string") result = { html: result };
+  if (!result || typeof result.html !== "string") throw new TypeError("Custom " + source + " " + kind + " converter for " + name + " must return an HTML string or { html, warnings? }");
+  if (result.warnings != null) {
+    if (!Array.isArray(result.warnings) || result.warnings.some(function (warning) { return typeof warning !== "string"; })) throw new TypeError("Custom converter warnings must be an array of strings");
+    result.warnings.forEach(function (warning) { warnings.push(warning); });
+  }
+  recordFinding(applied, kind, name, context && context.path);
+  return result.html;
+}
+function flattenToolbar(value, output) {
+  output = output || [];
+  if (Array.isArray(value)) { value.forEach(function (item) { flattenToolbar(item, output); }); }
+  else if (value && typeof value === "object") {
+    if (Array.isArray(value.items)) { flattenToolbar(value.items, output); }
+    else if (value.header != null) { output.push("formatblock"); }
+    else if (value.list) { output.push(value.list === "ordered" ? "orderedlist" : "bulletlist"); }
+  } else if (typeof value === "string") { value.split(/[\s|,]+/).filter(Boolean).forEach(function (item) { output.push(item); }); }
+  return output;
+}
+function mapToolbar(value) {
+  var unknown = [], mapped = [];
+  flattenToolbar(value).forEach(function (raw) {
+    var key = String(raw).toLowerCase().replace(/[^a-z]/g, "");
+    if (!key || key === "separator") { return; }
+    if (COMMANDS[key]) { if (mapped.indexOf(COMMANDS[key]) < 0) { mapped.push(COMMANDS[key]); } }
+    else { unknown.push(String(raw)); }
+  });
+  return { commands: mapped, unmapped: unique(unknown) };
+}
+function migrateConfig(source, input) {
+  source = assertSource(source); input = input || {};
+  var config = {}, warnings = [], toolbarValue;
+  if (source === "tinymce") { toolbarValue = input.toolbar; config.placeholder = input.placeholder; config.height = input.height; config.width = input.width; if (input.readonly != null) config.readOnly = !!input.readonly; }
+  if (source === "ckeditor") { toolbarValue = input.toolbar && (input.toolbar.items || input.toolbar); config.placeholder = input.placeholder; config.contentLang = typeof input.language === "string" ? input.language : input.language && input.language.ui; }
+  if (source === "froala") { toolbarValue = input.toolbarButtons; config.placeholder = input.placeholderText; config.height = input.height || input.heightMin; config.maxLength = input.charCounterMax; if (input.editable === false) config.readOnly = true; }
+  if (source === "quill") { toolbarValue = input.modules && input.modules.toolbar; config.placeholder = input.placeholder; config.readOnly = !!input.readOnly; if (input.theme && input.theme !== "snow") warnings.push("Quill theme requires a RichTextEditor skin/CSS migration."); }
+  if (source === "tiptap") { toolbarValue = input.toolbar; config.placeholder = input.placeholder; config.readOnly = input.editable === false; if (input.extensions) warnings.push("Tiptap extensions require feature-by-feature mapping; inspect unmapped extensions manually."); }
+  if (source === "lexical") { toolbarValue = input.toolbar; config.readOnly = input.editable === false; config.contentLang = input.language; if (input.nodes) warnings.push("Lexical custom nodes require a serializer or custom RichTextEditor plugin."); }
+  Object.keys(config).forEach(function (key) { if (config[key] == null || config[key] === "") delete config[key]; });
+  var toolbar = mapToolbar(toolbarValue);
+  if (toolbar.commands.length) { config.toolbar = "custom"; config.toolbar_custom = "{" + toolbar.commands.join(",") + "}"; }
+  if (toolbar.unmapped.length) warnings.push("Unmapped toolbar items: " + toolbar.unmapped.join(", "));
+  return { source: source, config: config, mappedCommands: toolbar.commands, unmapped: toolbar.unmapped, warnings: warnings };
+}
+
+function applyMarks(text, attrs, warnings, context) {
+  var html = escapeHtml(text), href;
+  attrs = attrs || {};
+  if (attrs.code) html = "<code>" + html + "</code>";
+  if (attrs.bold) html = "<strong>" + html + "</strong>";
+  if (attrs.italic) html = "<em>" + html + "</em>";
+  if (attrs.underline) html = "<u>" + html + "</u>";
+  if (attrs.strike) html = "<s>" + html + "</s>";
+  href = safeHref(attrs.link); if (href) html = "<a href=\"" + escapeHtml(href) + "\"" + linkAttributes(attrs) + ">" + html + "</a>";
+  else if (attrs.link && warnings) warnings.push("Unsafe " + (context || "content") + " link URL was removed.");
+  return html;
+}
+function renderQuillLists(items) {
+  var roots = [], path = [];
+  function appendList(container, type) {
+    var list = { type: type, items: [] };
+    container.push(list);
+    return list;
+  }
+  items.forEach(function (item) {
+    var depth = Math.max(0, Math.floor(Number(item.indent) || 0));
+    if (depth > path.length) depth = path.length;
+    path.length = depth + 1;
+    var container = roots;
+    if (depth > 0) {
+      var parentList = path[depth - 1], parentItem = parentList && parentList.items[parentList.items.length - 1];
+      if (!parentItem) { depth = 0; path.length = 1; }
+      else container = parentItem.children;
+    }
+    var list = path[depth];
+    if (!list || list.type !== item.type || container.indexOf(list) < 0) {
+      list = appendList(container, item.type);
+      path[depth] = list;
+      path.length = depth + 1;
+    }
+    list.items.push({ html: item.html, checked: item.checked, children: [] });
+  });
+  function render(list) {
+    var tag = list.type === "ol" ? "ol" : "ul", listAttrs = list.type === "check" ? " data-type=\"taskList\"" : "";
+    return "<" + tag + listAttrs + ">" + list.items.map(function (item) {
+      var itemAttrs = list.type === "check" ? " data-type=\"taskItem\" data-checked=\"" + (item.checked ? "true" : "false") + "\"" : "";
+      return "<li" + itemAttrs + ">" + item.html + item.children.map(render).join("") + "</li>";
+    }).join("") + "</" + tag + ">";
+  }
+  return roots.map(render).join("");
+}
+function quillToHtml(delta, warnings, options, applied, unsupported) {
+  var ops = delta && Array.isArray(delta.ops) ? delta.ops : [], blocks = [], line = "", listItems = [];
+  function flushList() { if (listItems.length) { blocks.push(renderQuillLists(listItems)); listItems = []; } }
+  function flushLine(attrs) {
+    attrs = attrs || {};
+    if (attrs.list) { listItems.push({ type: attrs.list === "ordered" ? "ol" : attrs.list === "checked" || attrs.list === "unchecked" ? "check" : "ul", checked: attrs.list === "checked", indent: attrs.indent, html: line || "<br>" }); }
+    else { flushList(); var tag = attrs.header ? "h" + Math.max(1, Math.min(6, Number(attrs.header))) : attrs["code-block"] ? "pre" : attrs.blockquote ? "blockquote" : "p"; blocks.push("<" + tag + ">" + (line || "<br>") + "</" + tag + ">"); }
+    line = "";
+  }
+  ops.forEach(function (op, opIndex) {
+    if (typeof op.insert !== "string") {
+      var embed = op.insert || {}, imageUrl, videoUrl;
+      if (embed.image != null) { imageUrl = safeHref(embed.image); if (imageUrl) line += "<img src=\"" + escapeHtml(imageUrl) + "\"" + imageAttributes(op.attributes) + ">"; else warnings.push("Unsafe Quill image URL was removed."); }
+      else if (embed.formula != null) line += "<span class=\"rte-math-inline\" data-tex=\"" + escapeHtml(embed.formula) + "\">" + escapeHtml(embed.formula) + "</span>";
+      else if (embed.video != null) { videoUrl = safeHref(embed.video); if (videoUrl) line += "<a href=\"" + escapeHtml(videoUrl) + "\">" + escapeHtml(videoUrl) + "</a>"; else warnings.push("Unsafe Quill video URL was removed."); }
+      else {
+        var embedNames = Object.keys(embed), embedPath = "ops[" + opIndex + "].insert", handled = embedNames.length === 1 ? runCustomConverter(options, "quill", "embed", embedNames[0], embed[embedNames[0]], { operation: op, attributes: op.attributes || {}, path: embedPath + "." + embedNames[0] }, warnings, applied) : null;
+        if (handled != null) line += handled;
+        else { embedNames.forEach(function (name) { recordFinding(unsupported, "embed", name, embedPath + "." + name); }); warnings.push("Quill embed requires manual migration: " + embedNames.join(", ")); }
+      }
+      return;
+    }
+    var parts = op.insert.split("\n");
+    parts.forEach(function (part, index) { line += applyMarks(part, op.attributes, warnings, "Quill"); if (index < parts.length - 1) flushLine(op.attributes); });
+  });
+  if (line) flushLine({}); flushList(); return blocks.join("");
+}
+function tiptapNode(node, warnings, options, applied, unsupported, path) {
+  path = path || "$";
+  if (!node) return ""; if (node.type === "text") { var html = escapeHtml(node.text || ""); (node.marks || []).forEach(function (mark, markIndex) { var type = mark.type, href, handled, markPath = path + ".marks[" + markIndex + "]"; if (type === "bold") html = "<strong>" + html + "</strong>"; else if (type === "italic") html = "<em>" + html + "</em>"; else if (type === "underline") html = "<u>" + html + "</u>"; else if (type === "strike") html = "<s>" + html + "</s>"; else if (type === "code") html = "<code>" + html + "</code>"; else if (type === "link" && (href = safeHref(mark.attrs && mark.attrs.href))) html = "<a href=\"" + escapeHtml(href) + "\"" + linkAttributes(mark.attrs) + ">" + html + "</a>"; else if (type === "link") warnings.push("Unsafe Tiptap link URL was removed."); else if (["bold","italic","underline","strike","code"].indexOf(type) < 0) { handled = runCustomConverter(options, "tiptap", "mark", type, mark, { html: html, node: node, path: markPath }, warnings, applied); if (handled != null) html = handled; else { recordFinding(unsupported, "mark", type, markPath); warnings.push("Unsupported Tiptap mark: " + type); } } }); return html; }
+  var children = (node.content || []).map(function (child, index) { return tiptapNode(child, warnings, options, applied, unsupported, path + ".content[" + index + "]"); }).join("");
+  var tags = { doc: "", paragraph: "p", heading: "h" + Math.max(1, Math.min(6, Number(node.attrs && node.attrs.level || 1))), bulletList: "ul", orderedList: "ol", listItem: "li", blockquote: "blockquote", codeBlock: "pre", hardBreak: "br", horizontalRule: "hr", table: "table", tableRow: "tr", tableHeader: "th", tableCell: "td" };
+  if (node.type === "image") { var imageSrc = safeHref(node.attrs && node.attrs.src); if (!imageSrc && node.attrs && node.attrs.src) warnings.push("Unsafe Tiptap image URL was removed."); return imageSrc ? "<img src=\"" + escapeHtml(imageSrc) + "\"" + imageAttributes(node.attrs) + ">" : ""; }
+  if (node.type === "taskList") return "<ul data-type=\"taskList\">" + children + "</ul>";
+  if (node.type === "taskItem") return "<li data-type=\"taskItem\" data-checked=\"" + (node.attrs && node.attrs.checked ? "true" : "false") + "\">" + children + "</li>";
+  if (!(node.type in tags)) { var handledNode = runCustomConverter(options, "tiptap", "node", node.type, node, { childrenHtml: children, path: path }, warnings, applied); if (handledNode != null) return handledNode; recordFinding(unsupported, "node", node.type, path); warnings.push("Unsupported Tiptap node: " + node.type); return children; }
+  var tag = tags[node.type]; if (!tag) return children; if (tag === "br" || tag === "hr") return "<" + tag + ">"; var attrs = "";
+  if (tag === "td" || tag === "th") { var colspan = positiveSpan(node.attrs && node.attrs.colspan), rowspan = positiveSpan(node.attrs && node.attrs.rowspan); if (colspan) attrs += " colspan=\"" + colspan + "\""; if (rowspan) attrs += " rowspan=\"" + rowspan + "\""; }
+  return "<" + tag + attrs + ">" + children + "</" + tag + ">";
+}
+function lexicalNode(node, warnings, options, applied, unsupported, path) {
+  path = path || "$";
+  if (!node) return "";
+  if (node.type === "text") { var format = Number(node.format || 0), attrs = { bold: !!(format & 1), italic: !!(format & 2), strike: !!(format & 4), underline: !!(format & 8), code: !!(format & 16) }; return applyMarks(node.text || "", attrs); }
+  var children = (node.children || []).map(function (child, index) { return lexicalNode(child, warnings, options, applied, unsupported, path + ".children[" + index + "]"); }).join("");
+  if (node.type === "root") return children;
+  if (node.type === "link" || node.type === "autolink") { var href = safeHref(node.url); if (!href && node.url) warnings.push("Unsafe Lexical link URL was removed."); return href ? "<a href=\"" + escapeHtml(href) + "\"" + linkAttributes({ target: node.target, rel: node.rel }) + ">" + children + "</a>" : children; }
+  var tag = node.type === "heading" ? (/^h[1-6]$/.test(node.tag) ? node.tag : "h2") : ({ paragraph: "p", quote: "blockquote", list: node.listType === "number" ? "ol" : "ul", listitem: "li", linebreak: "br", code: "pre", table: "table", tablerow: "tr", tablecell: node.headerState ? "th" : "td" })[node.type];
+  if (!tag) { var handledNode = runCustomConverter(options, "lexical", "node", node.type, node, { childrenHtml: children, path: path }, warnings, applied); if (handledNode != null) return handledNode; recordFinding(unsupported, "node", node.type, path); warnings.push("Unsupported Lexical node: " + node.type); return children; }
+  if (tag === "br") return "<br>"; var attrs = "";
+  if (node.type === "list" && node.listType === "check") attrs += " data-type=\"taskList\"";
+  if (node.type === "listitem" && typeof node.checked === "boolean") attrs += " data-type=\"taskItem\" data-checked=\"" + (node.checked ? "true" : "false") + "\"";
+  if (tag === "td" || tag === "th") { var colspan = positiveSpan(node.colSpan), rowspan = positiveSpan(node.rowSpan); if (colspan) attrs += " colspan=\"" + colspan + "\""; if (rowspan) attrs += " rowspan=\"" + rowspan + "\""; }
+  return "<" + tag + attrs + ">" + children + "</" + tag + ">";
+}
+function convertContent(source, value, options) {
+  source = assertSource(source); var warnings = [], appliedConverters = [], unsupportedContent = [], html = "";
+  if (source === "quill") html = quillToHtml(value, warnings, options, appliedConverters, unsupportedContent);
+  else if (source === "tiptap") html = tiptapNode(value && value.type ? value : value && value.doc, warnings, options, appliedConverters, unsupportedContent, "$" );
+  else if (source === "lexical") html = lexicalNode(value && value.root ? value.root : value, warnings, options, appliedConverters, unsupportedContent, "$" );
+  else { if (typeof value !== "string") throw new TypeError(source + " content must be an HTML string"); html = cleanVendorHtml(source, value); }
+  return { source: source, html: html, warnings: unique(warnings), unsupportedContent: unsupportedContent, appliedConverters: appliedConverters };
+}
+function cleanVendorHtml(source, html) {
+  var patterns = source === "ckeditor" ? [/\sdata-list-item-id=("[^"]*"|'[^']*')/gi, /\sdata-ck-[\w-]+=("[^"]*"|'[^']*')/gi]
+    : source === "tinymce" ? [/\sdata-mce-[\w-]+=("[^"]*"|'[^']*')/gi]
+    : source === "froala" ? [/\sdata-fr-[\w-]+=("[^"]*"|'[^']*')/gi] : [];
+  patterns.forEach(function (pattern) { html = html.replace(pattern, ""); });
+  return html;
+}
+function readLegacyContent(source, editor) {
+  source = assertSource(source); if (!editor) throw new TypeError("A legacy editor instance is required");
+  if (source === "tinymce" && typeof editor.getContent === "function") return editor.getContent();
+  if (source === "ckeditor" && typeof editor.getData === "function") return editor.getData();
+  if (source === "froala" && editor.html && typeof editor.html.get === "function") return editor.html.get();
+  if (source === "quill" && typeof editor.getContents === "function") return editor.getContents();
+  if (source === "tiptap") return typeof editor.getJSON === "function" ? editor.getJSON() : editor.getHTML();
+  if (source === "lexical" && typeof editor.getEditorState === "function") return editor.getEditorState().toJSON();
+  throw new TypeError("The supplied " + source + " instance does not expose its expected content API");
+}
+function migrateEditor(source, legacyEditor, richTextEditor, options) {
+  var result = convertContent(source, readLegacyContent(source, legacyEditor), options);
+  if (!richTextEditor || typeof richTextEditor.setHTMLCode !== "function") throw new TypeError("RichTextEditor instance must expose setHTMLCode(html)");
+  richTextEditor.setHTMLCode(result.html); return result;
+}
+
+function createMigrationReport(source, options) {
+  options = options || {}; var configResult = migrateConfig(source, options.config || {}), contentResult = convertContent(source, options.content == null ? (assertSource(source) === "quill" ? { ops: [] } : assertSource(source) === "tiptap" ? { type: "doc", content: [] } : assertSource(source) === "lexical" ? { root: { type: "root", children: [] } } : "") : options.content, { converters: options.converters });
+  var warnings = unique(configResult.warnings.concat(contentResult.warnings));
+  var blockers = warnings.filter(function (warning) { return /Unsafe |Unsupported |requires manual migration/i.test(warning); });
+  var manualReview = ["Custom plugins and schemas", "Collaboration, comments, and tracked changes", "Uploads and asset URLs", "Permissions and application data", "Representative saved output comparison"];
+  return { source: configResult.source, readyForCutover: blockers.length === 0, config: configResult.config, html: contentResult.html, mappedCommands: configResult.mappedCommands, unmapped: configResult.unmapped, unsupportedContent: contentResult.unsupportedContent, appliedConverters: contentResult.appliedConverters, blockers: blockers, warnings: warnings, manualReview: manualReview };
+}
+
+module.exports = { SOURCES: SOURCES.slice(), COMMANDS: Object.assign({}, COMMANDS), convertContent: convertContent, createMigrationReport: createMigrationReport, mapToolbar: mapToolbar, migrateConfig: migrateConfig, migrateEditor: migrateEditor, readLegacyContent: readLegacyContent };

package/migration/report-schema-v2.json

@@ -0,0 +1,127 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "urn:richtexteditor:migration-report:2",
+  "title": "RichTextEditor migration report schema v2",
+  "oneOf": [
+    { "$ref": "#/$defs/singleReport" },
+    { "$ref": "#/$defs/batchReport" }
+  ],
+  "$defs": {
+    "generator": {
+      "type": "object",
+      "required": ["name", "version"],
+      "properties": {
+        "name": { "const": "@richscripts/richtexteditor" },
+        "version": { "type": "string", "minLength": 1 }
+      },
+      "additionalProperties": false
+    },
+    "converterModule": {
+      "oneOf": [
+        { "type": "null" },
+        {
+          "type": "object",
+          "required": ["label", "sha256", "hashVerifiedBeforeExecution"],
+          "properties": {
+            "label": { "type": "string", "minLength": 1 },
+            "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" },
+            "hashVerifiedBeforeExecution": { "type": "boolean" }
+          },
+          "additionalProperties": false
+        }
+      ]
+    },
+    "finding": {
+      "type": "object",
+      "required": ["kind", "name", "count", "paths"],
+      "properties": {
+        "kind": { "enum": ["embed", "node", "mark"] },
+        "name": { "type": "string", "minLength": 1 },
+        "count": { "type": "integer", "minimum": 1 },
+        "paths": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }
+      },
+      "additionalProperties": false
+    },
+    "documentReport": {
+      "type": "object",
+      "required": ["source", "readyForCutover", "config", "html", "mappedCommands", "unmapped", "unsupportedContent", "appliedConverters", "blockers", "warnings", "manualReview"],
+      "properties": {
+        "id": { "type": "string" },
+        "source": { "type": "string", "minLength": 1 },
+        "readyForCutover": { "type": "boolean" },
+        "config": { "type": "object" },
+        "html": { "type": "string" },
+        "mappedCommands": { "type": "array", "items": { "type": "string" } },
+        "unmapped": { "type": "array", "items": { "type": "string" } },
+        "unsupportedContent": { "type": "array", "items": { "$ref": "#/$defs/finding" } },
+        "appliedConverters": { "type": "array", "items": { "$ref": "#/$defs/finding" } },
+        "blockers": { "type": "array", "items": { "type": "string" } },
+        "warnings": { "type": "array", "items": { "type": "string" } },
+        "manualReview": { "type": "array", "items": { "type": "string" } }
+      },
+      "additionalProperties": true
+    },
+    "singleReport": {
+      "allOf": [
+        { "$ref": "#/$defs/documentReport" },
+        {
+          "type": "object",
+          "required": ["schemaVersion", "generator", "converterModule"],
+          "properties": {
+            "schemaVersion": { "const": 2 },
+            "generator": { "$ref": "#/$defs/generator" },
+            "converterModule": { "$ref": "#/$defs/converterModule" }
+          }
+        }
+      ]
+    },
+    "unsupportedTotal": {
+      "type": "object",
+      "required": ["source", "kind", "name", "count", "documents"],
+      "properties": {
+        "source": { "type": "string" },
+        "kind": { "enum": ["embed", "node", "mark"] },
+        "name": { "type": "string" },
+        "count": { "type": "integer", "minimum": 1 },
+        "documents": { "type": "integer", "minimum": 1 }
+      },
+      "additionalProperties": false
+    },
+    "batchReport": {
+      "type": "object",
+      "required": ["schemaVersion", "generator", "converterModule", "readyForCutover", "summary", "reports"],
+      "properties": {
+        "schemaVersion": { "const": 2 },
+        "generator": { "$ref": "#/$defs/generator" },
+        "converterModule": { "$ref": "#/$defs/converterModule" },
+        "readyForCutover": { "type": "boolean" },
+        "summary": {
+          "type": "object",
+          "required": ["documents", "readyDocuments", "blockedDocuments", "unsupportedTotals", "unsupportedByDocument"],
+          "properties": {
+            "documents": { "type": "integer", "minimum": 1 },
+            "readyDocuments": { "type": "integer", "minimum": 0 },
+            "blockedDocuments": { "type": "integer", "minimum": 0 },
+            "unsupportedTotals": { "type": "array", "items": { "$ref": "#/$defs/unsupportedTotal" } },
+            "unsupportedByDocument": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "required": ["id", "source", "items"],
+                "properties": {
+                  "id": { "type": "string" },
+                  "source": { "type": "string" },
+                  "items": { "type": "array", "items": { "$ref": "#/$defs/finding" } }
+                },
+                "additionalProperties": false
+              }
+            }
+          },
+          "additionalProperties": false
+        },
+        "reports": { "type": "array", "minItems": 1, "items": { "$ref": "#/$defs/documentReport" } }
+      },
+      "additionalProperties": false
+    }
+  }
+}

package/package.json

@@ -1,14 +1,19 @@
 {
   "name": "@richscripts/richtexteditor",
   "publishConfig": { "access": "public" },
-  "version": "2.4.0",
+  "version": "2.4.1",
   "description": "A full-featured JavaScript rich text editor (WYSIWYG) with toolbar, plugins, i18n support, a built-in AI Toolkit (Ask AI, AI Chat, AI Review drawer, BYOK resolver), structured content APIs (JSON/Markdown), and an optional collaboration / review stack: slash commands, @mentions, human-author Track Changes, threaded comments, revision history, and Yjs-backed presence. Ships React, Vue, and server-safe conversion helpers.",
   "main": "./richtexteditor/rte.js",
+  "bin": {
+    "rte-migration-report": "./migration/cli.js"
+  },
   "scripts": {
     "test:server": "node tests/run-all.test.js",
     "test:admin": "node tests/run-all.test.js",
     "test": "node tests/run-all.test.js",
     "smoke:pack": "node tests/smoke-pack.js",
+    "artifact:migration": "node scripts/build-migration-fidelity-artifact.js",
+    "artifact:migration:runtime": "npm --prefix vendor-runtime-tests ci && npm --prefix vendor-runtime-tests run generate && node scripts/build-migration-fidelity-artifact.js",
     "guard:protected": "node tests/guard-protected-bundle.js",
     "prepublishOnly": "node tests/guard-protected-bundle.js"
   },
@@ -39,6 +44,10 @@
       "types": "./headless/index.d.ts",
       "default": "./headless/index.js"
     },
+    "./migration": {
+      "types": "./migration/index.d.ts",
+      "default": "./migration/index.js"
+    },
     "./server": {
       "types": "./server/index.d.ts",
       "default": "./server/index.js"
@@ -60,6 +69,7 @@
     "headless",
     "index.d.ts",
     "integrations",
+    "migration",
     "react",
     "richtexteditor",
     "server",