@designcrowd/library.brand-page 6.1.1-json-prereq-4 → 6.1.1

package/lib/src/brand-page/utils/migration/migration-20.js

@@ -1,66 +0,0 @@
-import { hasRTEContent, toRteJson, resolveHtmlParser, } from '../../../brand-page-maker/utils';
-/**
- * BP-5787 — migrate existing inline-HTML RTE content to Tiptap JSON.
- *
- * The editor emits, and the renderer reads, Tiptap JSON. Existing
- * published/saved sites still hold RTE fields as HTML strings. This converts
- * them on load, in EVERY environment:
- *   - maker (browser): the loaded model is JSON, so the next save persists JSON.
- *   - web-renderer (SSR / server API routes): converted on read, so old sites
- *     are normalised without a re-save and downstream code can treat RTE as JSON.
- *
- * This is a one-time, versioned migration (runAlways is NOT set): legacy sites
- * are at model version < 20 and convert on first load in any environment; once
- * `v` is stamped to 20 the conversion is skipped. This is only safe because the
- * AI section builders now emit Tiptap JSON directly (they no longer write HTML),
- * so there is no recurring post-load source of HTML to normalise.
- *
- * HTML→JSON parsing needs a DOM parser. Rather than mutate a global `window`,
- * the parser is resolved once (native `DOMParser` in the browser, a jsdom
- * `DOMParser` instance on the server) and threaded explicitly through the
- * conversion — see resolveHtmlParser / toRteJson. No global state is touched, so
- * the pass is safe on any server runtime and under concurrent requests.
- *
- * Scope: only HTML-RTE strings (hasRTEContent) are converted. Plain strings,
- * numbers, and already-JSON docs are left untouched, so the migration is
- * idempotent (re-running on JSON content is a no-op — non-string values are
- * skipped). Nested RTE inside item arrays (textItems, testimonials, images…)
- * is handled by recursing into arrays; style objects are intentionally not
- * descended into (they never hold RTE content).
- */
-const convertRteStringsToJson = (value, parser) => {
-    if (Array.isArray(value)) {
-        value.forEach((item) => convertRteStringsToJson(item, parser));
-        return;
-    }
-    if (!value || typeof value !== 'object')
-        return;
-    const record = value;
-    Object.keys(record).forEach((key) => {
-        const field = record[key];
-        if (typeof field === 'string' && hasRTEContent(field)) {
-            const json = toRteJson(field, parser);
-            if (json)
-                record[key] = json;
-        }
-        else if (Array.isArray(field)) {
-            convertRteStringsToJson(field, parser);
-        }
-    });
-};
-const convertModel = (brandPageModel, parser) => {
-    for (const page of brandPageModel.pages) {
-        for (const content of page.contents) {
-            convertRteStringsToJson(content, parser);
-        }
-    }
-};
-export const migration20 = async (migrationResult) => {
-    const { brandPageModel } = migrationResult;
-    // Resolve a DOM parser for this environment (native in the browser, a jsdom
-    // instance on the server — never touching globals), then convert every
-    // HTML-RTE field to Tiptap JSON with it.
-    const parser = await resolveHtmlParser();
-    convertModel(brandPageModel, parser);
-    return migrationResult;
-};

package/lib/src/brand-page-maker/__fixtures__/complex-rte.fixture.d.ts

@@ -1,22 +0,0 @@
-/**
- * BP-5787 — golden-master fixture for the RTE HTML→JSON migration.
- *
- * A single rich-text value that exercises every mark/node the editor can emit,
- * so one snapshot guards the whole serialisation surface. Captured as a baseline
- * on the current HTML pipeline; after the migration the JSON pipeline must
- * reproduce byte-identical rendered output (see rte-render-parity.test.ts).
- *
- * Coverage:
- *  - block nodes: heading (h2), paragraph, text-align (center / right)
- *  - inline marks: bold, italic, underline, strike
- *  - textStyle attrs: fontFamily, fontSize (em), letterSpacing (em), lineHeight (unitless)
- *  - colour: theme TOKEN ref (var(--logo-text-color)) AND a literal hex (#FF0000)
- *  - highlight (background colour via <mark>)
- *  - links: internal (target=_self) and external (target=_blank rel=noopener)
- */
-export declare const COMPLEX_RTE_HTML = "<h2 style=\"text-align: center\"><span style=\"color: var(--logo-text-color)\">Themed heading</span></h2><p><strong>bold</strong> <em>italic</em> <u>underline</u> <s>strike</s> <span style=\"font-family: Montserrat; font-size: 1.5em; letter-spacing: 0.05em; line-height: 1.4\">styled span</span> <mark data-color=\"#ffe08a\" style=\"background-color: #ffe08a\">highlight</mark> <span style=\"color: #FF0000\">literal hex</span> <a target=\"_self\" href=\"/about\">internal link</a> <a target=\"_blank\" rel=\"noopener noreferrer nofollow\" href=\"https://example.com\">external link</a></p><p style=\"text-align: right\">second paragraph, right-aligned</p>";
-/**
- * The theme-token CSS variable that MUST survive the HTML→JSON round-trip
- * (BP-5787 stores token refs instead of flattening them to rgb()).
- */
-export declare const THEME_TOKEN_REF = "var(--logo-text-color)";

package/lib/src/brand-page-maker/__fixtures__/complex-rte.fixture.js

@@ -1,22 +0,0 @@
-/**
- * BP-5787 — golden-master fixture for the RTE HTML→JSON migration.
- *
- * A single rich-text value that exercises every mark/node the editor can emit,
- * so one snapshot guards the whole serialisation surface. Captured as a baseline
- * on the current HTML pipeline; after the migration the JSON pipeline must
- * reproduce byte-identical rendered output (see rte-render-parity.test.ts).
- *
- * Coverage:
- *  - block nodes: heading (h2), paragraph, text-align (center / right)
- *  - inline marks: bold, italic, underline, strike
- *  - textStyle attrs: fontFamily, fontSize (em), letterSpacing (em), lineHeight (unitless)
- *  - colour: theme TOKEN ref (var(--logo-text-color)) AND a literal hex (#FF0000)
- *  - highlight (background colour via <mark>)
- *  - links: internal (target=_self) and external (target=_blank rel=noopener)
- */
-export const COMPLEX_RTE_HTML = `<h2 style="text-align: center"><span style="color: var(--logo-text-color)">Themed heading</span></h2><p><strong>bold</strong> <em>italic</em> <u>underline</u> <s>strike</s> <span style="font-family: Montserrat; font-size: 1.5em; letter-spacing: 0.05em; line-height: 1.4">styled span</span> <mark data-color="#ffe08a" style="background-color: #ffe08a">highlight</mark> <span style="color: #FF0000">literal hex</span> <a target="_self" href="/about">internal link</a> <a target="_blank" rel="noopener noreferrer nofollow" href="https://example.com">external link</a></p><p style="text-align: right">second paragraph, right-aligned</p>`;
-/**
- * The theme-token CSS variable that MUST survive the HTML→JSON round-trip
- * (BP-5787 stores token refs instead of flattening them to rgb()).
- */
-export const THEME_TOKEN_REF = 'var(--logo-text-color)';

package/lib/src/brand-page-maker/composables/rich-text-editor/extensions/FontFamily.d.ts

@@ -1,14 +0,0 @@
-/**
- * BP-5787 — font-family with quote-stripping parse.
- *
- * The stock extension stores whatever `element.style.fontFamily` returns. For
- * multi-word families (e.g. "Open Sans", "Playwrite AU") the browser quotes the
- * value, so parsing HTML — pasting RTE-styled text between editors, or the
- * HTML→JSON migration — yields a value that still contains the quote chars
- * (`"Open Sans"`). That value then (a) no longer matches the font list and,
- * worse, (b) is dropped by the native RTE sanitiser (`sanitizeRteJson`), whose
- * `isSafeCssValue` rejects any value containing `"` `'` `;` — so the font is
- * silently lost. Mirror the FontSize/LetterSpacing extensions and strip the
- * quotes on parse so the stored value is always the bare family name.
- */
-export declare const FontFamily: import("@tiptap/core").Extension<import("@tiptap/extension-text-style").FontFamilyOptions, any>;

package/lib/src/brand-page-maker/composables/rich-text-editor/extensions/FontFamily.js

@@ -1,39 +0,0 @@
-import TiptapFontFamily from '@tiptap/extension-font-family';
-/**
- * BP-5787 — font-family with quote-stripping parse.
- *
- * The stock extension stores whatever `element.style.fontFamily` returns. For
- * multi-word families (e.g. "Open Sans", "Playwrite AU") the browser quotes the
- * value, so parsing HTML — pasting RTE-styled text between editors, or the
- * HTML→JSON migration — yields a value that still contains the quote chars
- * (`"Open Sans"`). That value then (a) no longer matches the font list and,
- * worse, (b) is dropped by the native RTE sanitiser (`sanitizeRteJson`), whose
- * `isSafeCssValue` rejects any value containing `"` `'` `;` — so the font is
- * silently lost. Mirror the FontSize/LetterSpacing extensions and strip the
- * quotes on parse so the stored value is always the bare family name.
- */
-export const FontFamily = TiptapFontFamily.extend({
-    addGlobalAttributes() {
-        return [
-            {
-                types: this.options.types,
-                attributes: {
-                    fontFamily: {
-                        default: null,
-                        // Strip quotes only — keep '' for an absent value so the stored
-                        // JSON shape matches the other textStyle attrs (FontSize etc.).
-                        parseHTML: (element) => element.style.fontFamily?.replace(/['"]+/g, ''),
-                        renderHTML: (attributes) => {
-                            if (!attributes.fontFamily) {
-                                return {};
-                            }
-                            return {
-                                style: `font-family: ${attributes.fontFamily}`,
-                            };
-                        },
-                    },
-                },
-            },
-        ];
-    },
-});

package/lib/src/brand-page-maker/composables/rich-text-editor/getRteExtensions.d.ts

@@ -1,28 +0,0 @@
-import type { Extensions } from '@tiptap/vue-3';
-/**
- * Single source of truth for the Tiptap extension set (BP-5787).
- *
- * The live editor, the headless serialiser (useExternalRichTextEditor), and
- * the upcoming render-from-JSON path must all use the SAME extensions, or
- * rendered output drifts from what the user authored. This factory removes the
- * previous duplication while preserving each consumer's exact configuration.
- *
- * Known, intentional differences are parameterised:
- *  - `restrictStarterKit` — the live editor disables list/hr/code nodes.
- *  - `editing` — only the live editor carries the Placeholder + MaxLength plugins
- *    (neither affects serialised output; they are editing-time only).
- *
- * Link target/rel are NOT parameterised: they are a pure function of the href
- * applied in the Link mark's renderHTML (below), so every consumer — live
- * editor, static renderer, schema check — emits identical link markup.
- */
-export interface RteExtensionOptions {
-    /** Disable StarterKit nodes the editor doesn't use (lists, hr, code). */
-    restrictStarterKit?: boolean;
-    /** When present, add the live-editing-only plugins (Placeholder, MaxLength). */
-    editing?: {
-        placeholder?: string;
-        maxLength?: number;
-    };
-}
-export declare const getRteExtensions: (options?: RteExtensionOptions) => Extensions;

package/lib/src/brand-page-maker/composables/rich-text-editor/getRteExtensions.js

@@ -1,117 +0,0 @@
-import StarterKit from '@tiptap/starter-kit';
-import Underline from '@tiptap/extension-underline';
-import { TextStyle, FontSize, LineHeight } from '@tiptap/extension-text-style';
-import TextAlign from '@tiptap/extension-text-align';
-import ColorExtension from '@tiptap/extension-color';
-import Highlight from '@tiptap/extension-highlight';
-import Placeholder from '@tiptap/extension-placeholder';
-import Link from '@tiptap/extension-link';
-import { FontFamily } from './extensions/FontFamily';
-import { LetterSpacing } from './extensions/LetterSpacing';
-import { MaxLength } from './extensions/MaxLength';
-import { AutoLink } from './extensions/AutoLink';
-import { isHrefPageId } from './hyperlink';
-export const getRteExtensions = (options = {}) => {
-    const { restrictStarterKit = false, editing } = options;
-    const extensions = [
-        // v3 StarterKit bundles Link + Underline; we register both separately (with
-        // custom Link config), so disable the bundled copies to avoid duplicate
-        // extension errors.
-        // trailingNode: false — v3 StarterKit adds a TrailingNode plugin (not in v2)
-        // that appends an empty paragraph after any non-paragraph trailing block.
-        // Disabled to keep editor/stored-content behaviour identical to v2 (BP-5787
-        // is backward-compat-first); revisit as a standalone UX change if wanted.
-        restrictStarterKit
-            ? StarterKit.configure({
-                link: false,
-                underline: false,
-                trailingNode: false,
-                bulletList: false,
-                orderedList: false,
-                listItem: false,
-                horizontalRule: false,
-                codeBlock: false,
-                code: false,
-            })
-            : StarterKit.configure({
-                link: false,
-                underline: false,
-                trailingNode: false,
-            }),
-        Underline,
-        // priority: 99 — render the textStyle <span> (which carries font-size) as the
-        // OUTERMOST inline mark, so decoration marks (<u>/<s>) nest INSIDE it and
-        // inherit the applied font-size. v3's extension-text-style defaults to
-        // priority 101, which flips this: <u>/<s> end up outside the font-size span
-        // and inherit only the base paragraph size. Since text-decoration thickness
-        // AND vertical position are computed from the decorating element's own font,
-        // that produced thin, mis-centred underline/strike on large text — a
-        // regression vs v2's serializer, which emitted the font-size span outermost
-        // (BP-5787, backward-compat-first).
-        TextStyle.extend({ priority: 99 }).configure({
-            mergeNestedSpanStyles: true,
-        }),
-        TextAlign.configure({
-            types: ['heading', 'paragraph'],
-        }),
-        FontFamily.configure({
-            types: ['textStyle'],
-        }),
-        // FontSize + LineHeight are now shipped natively by @tiptap/extension-text-style.
-        FontSize.configure({ types: ['textStyle'] }),
-        LetterSpacing,
-        LineHeight.configure({ types: ['textStyle'] }),
-        ColorExtension.configure({
-            types: ['textStyle'],
-        }),
-        Highlight.configure({
-            multicolor: true,
-        }),
-    ];
-    // Live-editing-only plugins sit between Highlight and Link (original order).
-    if (editing) {
-        extensions.push(Placeholder.configure({ placeholder: editing.placeholder }), MaxLength.configure({ maxLength: editing.maxLength }));
-    }
-    extensions.push(Link.extend({
-        // External-link policy lives at the serialisation boundary: target/rel are
-        // a pure function of the href, applied whenever a link mark renders to <a>
-        // (live editor DOM + static renderer alike). They are neither stored on the
-        // mark nor the sanitiser's concern — the sanitiser validates href only
-        // (see rte-sanitize.util.ts). This is what the old, unsupported
-        // `HTMLAttributes: (attrs) => …` function was trying (and failing) to do:
-        // Tiptap types HTMLAttributes as a static object, so a function silently
-        // no-ops, which is why fresh links lost target/rel after the JSON migration.
-        renderHTML(props) {
-            const href = props.HTMLAttributes.href;
-            const isExternal = typeof href === 'string' &&
-                (href.startsWith('http://') || href.startsWith('https://'));
-            const HTMLAttributes = {
-                ...props.HTMLAttributes,
-                target: isExternal ? '_blank' : null,
-                rel: isExternal ? 'noopener noreferrer' : null,
-            };
-            // Delegate to the base renderHTML so its XSS href-strip guard still runs.
-            // base Link always defines renderHTML, so the ?? branch is a defensive
-            // fallback only (never taken in practice); href is pre-validated by the
-            // sanitiser and isAllowedUri regardless.
-            return (this.parent?.({ ...props, HTMLAttributes }) ?? [
-                'a',
-                HTMLAttributes,
-                0,
-            ]);
-        },
-    }).configure({
-        openOnClick: false,
-        defaultProtocol: 'https',
-        autolink: true,
-        // Override Tiptap's built-in Link defaults ({ target: '_blank', rel:
-        // 'noopener noreferrer nofollow' }) with nulls: target/rel are NOT stored on
-        // the mark, they are derived from the href at render time (see renderHTML
-        // above). configure() deep-merges HTMLAttributes, so an empty {} would leave
-        // those built-in defaults in place and stamp them onto every link — hence
-        // the explicit nulls.
-        HTMLAttributes: { target: null, rel: null },
-        isAllowedUri: (url, ctx) => ctx.defaultValidate(url) || isHrefPageId(url),
-    }), AutoLink);
-    return extensions;
-};

package/lib/src/brand-page-maker/utils/rte-render.util.d.ts

@@ -1,63 +0,0 @@
-import type { JSONContent } from '@tiptap/vue-3';
-import { isTiptapDocument, getRteJsonPlainText } from './rich-text-editor.util';
-export { isTiptapDocument, getRteJsonPlainText };
-/**
- * BP-5787 — the boundary plumbing for storing RTE as Tiptap JSON.
- *
- * An RTE field is either a legacy inline-HTML string (pre-migration, or a
- * not-yet-migrated published site) or a Tiptap JSON document (post-migration).
- * These helpers let every consumer treat the two uniformly:
- *
- *   - isTiptapDocument — the canonical discriminator (object with type 'doc').
- *   - renderRteToHtml  — render either form to final HTML for display.
- *   - toRteJson        — normalise either form to JSON for storage.
- *
- * The schema-driven core of both directions is Tiptap/ProseMirror, fed by the
- * single-source-of-truth extension set (getRteExtensions) — so the mapping lives
- * in the extensions' schema, not a hand-maintained copy that drifts:
- *
- *   - renderRteToHtml uses @tiptap/static-renderer (renderToHTMLString). It is
- *     DOM-less, so it runs on the server (SSR/publish/preview), not just the
- *     browser, and needs no Editor instance.
- *   - toRteJson turns an HTML string into a DOM node with an INJECTED parser and
- *     feeds it to ProseMirror's schema-driven DOMParser. The HTML→DOM step needs
- *     a DOM parser; rather than read the global `window.DOMParser` (as Tiptap's
- *     `generateJSON` does — unusable on a pure-node server and fragile across SSR
- *     execution contexts), the parser is supplied by the caller: the native
- *     `DOMParser` in the browser, a jsdom `DOMParser` *instance* on the server
- *     (see resolveHtmlParser). No global is ever mutated, so the conversion is
- *     fully isomorphic regardless of how the SSR host bundles/executes this code.
- */
-export type RichTextValue = string | JSONContent;
-/**
- * A `DOMParser`-compatible object: turns an HTML string into a Document whose
- * `body` is a DOM node ProseMirror can parse. The browser's native `DOMParser`
- * and jsdom's `DOMParser` both satisfy this, so the DOM dependency is injected
- * rather than read from a global.
- */
-export interface HtmlParser {
-    parseFromString(html: string, type: 'text/html'): Document;
-}
-/**
- * Render an RTE value to final HTML. Legacy HTML strings pass through untouched
- * (they are already HTML); Tiptap JSON is serialised by @tiptap/static-renderer
- * from the extension schema — no editor, no DOM — so it works on the server
- * (SSR/publish), not just the browser.
- */
-export declare const renderRteToHtml: (value: RichTextValue | null | undefined) => string;
-/**
- * Resolve an HtmlParser for the current runtime: the native `DOMParser` in the
- * browser (and jsdom-based test envs), or a jsdom `DOMParser` INSTANCE on a
- * pure-node server — created and returned directly, never assigned to a global,
- * so it is immune to SSR execution-context differences. The jsdom specifier is
- * assembled at runtime so no bundler follows it into a browser build. Memoised
- * on the server (JSDOM construction is relatively expensive).
- */
-export declare const resolveHtmlParser: () => Promise<HtmlParser>;
-/**
- * Normalise an RTE value to a Tiptap JSON document. HTML strings are parsed with
- * `parser` (defaults to the browser's native DOMParser); JSON documents pass
- * through unchanged. Returns undefined for empty/blank input so callers can omit
- * empty fields.
- */
-export declare const toRteJson: (value: RichTextValue | null | undefined, parser?: HtmlParser) => JSONContent | undefined;

package/lib/src/brand-page-maker/utils/rte-render.util.js

@@ -1,95 +0,0 @@
-import { getSchema } from '@tiptap/core';
-import { DOMParser as ProseMirrorDOMParser } from '@tiptap/pm/model';
-import { renderToHTMLString } from '@tiptap/static-renderer/pm/html-string';
-import { getRteExtensions } from '../composables/rich-text-editor/getRteExtensions';
-import { isTiptapDocument, getRteJsonPlainText } from './rich-text-editor.util';
-export { isTiptapDocument, getRteJsonPlainText };
-// One extension set shared by both directions (render + parse). Schema knowledge
-// lives here, once — Tiptap/extension upgrades propagate to both automatically.
-const RTE_EXTENSIONS = getRteExtensions();
-// ProseMirror schema derived once from the shared extension set. This is the
-// schema-driven heart of HTML→JSON (no drift); only the HTML→DOM step is injected.
-const RTE_SCHEMA = getSchema(RTE_EXTENSIONS);
-/**
- * Render an RTE value to final HTML. Legacy HTML strings pass through untouched
- * (they are already HTML); Tiptap JSON is serialised by @tiptap/static-renderer
- * from the extension schema — no editor, no DOM — so it works on the server
- * (SSR/publish), not just the browser.
- */
-export const renderRteToHtml = (value) => {
-    if (value == null || value === '')
-        return '';
-    if (typeof value === 'string')
-        return value;
-    return renderToHTMLString({ content: value, extensions: RTE_EXTENSIONS });
-};
-// Tiptap's elementFromString strips whitespace-only text nodes (pretty-print
-// indentation between tags) before parsing; replicate it so injected-parser
-// output stays identical to the previous generateJSON-based conversion.
-const stripIndentationTextNodes = (node) => {
-    const children = node.childNodes;
-    for (let i = children.length - 1; i >= 0; i -= 1) {
-        const child = children[i];
-        if (child.nodeType === 3 &&
-            child.nodeValue &&
-            /^(\n\s\s|\n)$/.test(child.nodeValue)) {
-            node.removeChild(child);
-        }
-        else if (child.nodeType === 1) {
-            stripIndentationTextNodes(child);
-        }
-    }
-    return node;
-};
-const htmlToRteJson = (html, parser) => {
-    const body = parser.parseFromString(`<body>${html}</body>`, 'text/html').body;
-    const dom = stripIndentationTextNodes(body);
-    return ProseMirrorDOMParser.fromSchema(RTE_SCHEMA).parse(dom).toJSON();
-};
-let serverParserPromise = null;
-/**
- * Resolve an HtmlParser for the current runtime: the native `DOMParser` in the
- * browser (and jsdom-based test envs), or a jsdom `DOMParser` INSTANCE on a
- * pure-node server — created and returned directly, never assigned to a global,
- * so it is immune to SSR execution-context differences. The jsdom specifier is
- * assembled at runtime so no bundler follows it into a browser build. Memoised
- * on the server (JSDOM construction is relatively expensive).
- */
-export const resolveHtmlParser = async () => {
-    if (typeof DOMParser !== 'undefined')
-        return new DOMParser();
-    if (!serverParserPromise) {
-        const jsdomModuleId = ['js', 'dom'].join('');
-        serverParserPromise = import(/* @vite-ignore */ jsdomModuleId)
-            .then((mod) => {
-            const { JSDOM } = mod;
-            const { DOMParser: JsdomDOMParser } = new JSDOM('').window;
-            return new JsdomDOMParser();
-        })
-            .catch((error) => {
-            // Don't cache the failure — let a later call retry the import.
-            serverParserPromise = null;
-            throw error;
-        });
-    }
-    return serverParserPromise;
-};
-const getDefaultParser = () => {
-    if (typeof DOMParser !== 'undefined')
-        return new DOMParser();
-    throw new Error('toRteJson: no global DOMParser in this environment. On the server, pass an ' +
-        'explicit parser as the second argument (see resolveHtmlParser).');
-};
-/**
- * Normalise an RTE value to a Tiptap JSON document. HTML strings are parsed with
- * `parser` (defaults to the browser's native DOMParser); JSON documents pass
- * through unchanged. Returns undefined for empty/blank input so callers can omit
- * empty fields.
- */
-export const toRteJson = (value, parser) => {
-    if (value == null || value === '')
-        return undefined;
-    if (isTiptapDocument(value))
-        return value;
-    return htmlToRteJson(value, parser ?? getDefaultParser());
-};

package/lib/src/brand-page-maker/utils/rte-sanitize.util.d.ts

@@ -1,6 +0,0 @@
-import type { JSONContent } from '@tiptap/vue-3';
-/**
- * Sanitise a Tiptap JSON document (returns a new clean doc). Returns a minimal
- * empty doc if the input isn't a usable document.
- */
-export declare const sanitizeRteJson: (doc: unknown) => JSONContent;

package/lib/src/brand-page-maker/utils/rte-sanitize.util.js

@@ -1,156 +0,0 @@
-import { validateAndSanitizeHref } from './rich-text-editor.util';
-/**
- * BP-5787 — native JSON sanitiser for RTE content.
- *
- * Operates directly on the Tiptap document tree: no editor instantiation, no
- * HTML round-trip, no DOMPurify. This is the hot path (runs on every editor
- * update and on the server sanitise gate), so it is a single, allocation-light
- * recursive walk.
- *
- * Security model (mirrors the HTML allowlist it replaces):
- *  - only allow-listed node and mark types survive; everything else is dropped;
- *  - textStyle / highlight attrs are restricted to known keys whose values must
- *    be "safe CSS values" (no quotes/angle-brackets/extra declarations/url()/
- *    expression()), preventing CSS-injection when the value is later rendered
- *    into a `style="…"` attribute;
- *  - link hrefs go through the same validateAndSanitizeHref used by the HTML
- *    sanitiser; unsafe links lose their href (and the mark);
- *  - heading levels are clamped to 1–6.
- */
-// ProseMirror node types the editor schema can legitimately produce.
-const ALLOWED_NODE_TYPES = new Set([
-    'doc',
-    'paragraph',
-    'heading',
-    'text',
-    'hardBreak',
-    'bulletList',
-    'orderedList',
-    'listItem',
-    'blockquote',
-    'codeBlock',
-    'horizontalRule',
-]);
-// Inline mark types the editor produces (strong/em/u/s/code/span/mark/a).
-const ALLOWED_MARK_TYPES = new Set([
-    'bold',
-    'italic',
-    'underline',
-    'strike',
-    'code',
-    'textStyle',
-    'highlight',
-    'link',
-]);
-// textStyle attrs map to the allow-listed CSS properties (font-weight →
-// bold mark, text-decoration → underline/strike, text-align → node attr,
-// background-color → highlight, so they are intentionally not here).
-const ALLOWED_TEXT_STYLE_ATTRS = new Set([
-    'color',
-    'fontFamily',
-    'fontSize',
-    'letterSpacing',
-    'lineHeight',
-]);
-/**
- * A safe CSS value is a short string free of characters that could inject an
- * extra declaration or escape the attribute, and free of the url()/expression()
- * vectors. Legitimate values — `rgb(255, 0, 0)`, `#FF0000`,
- * `var(--logo-text-color)`, `Open Sans`, `1.5em` — all pass.
- */
-const isSafeCssValue = (value) => typeof value === 'string' &&
-    value.length > 0 &&
-    value.length <= 200 &&
-    !/[<>"';]/.test(value) &&
-    !/url\s*\(/i.test(value) &&
-    !/expression\s*\(/i.test(value);
-const sanitizeTextStyleAttrs = (attrs) => {
-    const clean = {};
-    for (const key of Object.keys(attrs)) {
-        if (!ALLOWED_TEXT_STYLE_ATTRS.has(key))
-            continue;
-        const value = attrs[key];
-        // Tiptap emits '' for unset textStyle slots — preserve them.
-        if (value === '' || value == null) {
-            clean[key] = '';
-        }
-        else if (isSafeCssValue(value)) {
-            clean[key] = value;
-        }
-        // else: drop the unsafe value
-    }
-    return Object.keys(clean).length ? clean : null;
-};
-const sanitizeMark = (mark) => {
-    const type = mark?.type;
-    if (!type || !ALLOWED_MARK_TYPES.has(type))
-        return null;
-    const attrs = mark.attrs;
-    if (type === 'link') {
-        const href = typeof attrs?.href === 'string'
-            ? validateAndSanitizeHref(attrs.href)
-            : null;
-        if (!href)
-            return null; // drop links with unsafe/empty href
-        // href only — the sanitiser validates, it does not enrich. target/rel are
-        // a render-time policy derived from the href in the Link mark's renderHTML
-        // (see getRteExtensions.ts), so they are neither stored nor re-added here.
-        return { type, attrs: { href } };
-    }
-    if (type === 'textStyle') {
-        const clean = attrs ? sanitizeTextStyleAttrs(attrs) : null;
-        return clean ? { type, attrs: clean } : null;
-    }
-    if (type === 'highlight') {
-        return isSafeCssValue(attrs?.color)
-            ? { type, attrs: { color: attrs.color } }
-            : { type };
-    }
-    // Plain marks (bold/italic/underline/strike/code) carry no attrs.
-    return { type };
-};
-const ALIGN_VALUES = new Set(['left', 'center', 'right', 'justify']);
-const sanitizeNode = (node) => {
-    const type = node?.type;
-    if (!type || !ALLOWED_NODE_TYPES.has(type))
-        return null;
-    const clean = { type };
-    const attrs = {};
-    if (type === 'heading') {
-        const level = Number(node.attrs?.level);
-        attrs.level = level >= 1 && level <= 6 ? level : 1;
-    }
-    if (type === 'heading' || type === 'paragraph') {
-        const align = node.attrs?.textAlign;
-        if (typeof align === 'string' && ALIGN_VALUES.has(align)) {
-            attrs.textAlign = align;
-        }
-    }
-    if (Object.keys(attrs).length)
-        clean.attrs = attrs;
-    if (typeof node.text === 'string')
-        clean.text = node.text;
-    if (Array.isArray(node.marks)) {
-        const marks = node.marks
-            .map((m) => sanitizeMark(m))
-            .filter(Boolean);
-        if (marks && marks.length)
-            clean.marks = marks;
-    }
-    if (Array.isArray(node.content)) {
-        const content = node.content
-            .map(sanitizeNode)
-            .filter(Boolean);
-        if (content.length)
-            clean.content = content;
-    }
-    return clean;
-};
-/**
- * Sanitise a Tiptap JSON document (returns a new clean doc). Returns a minimal
- * empty doc if the input isn't a usable document.
- */
-export const sanitizeRteJson = (doc) => {
-    const clean = doc && typeof doc === 'object' ? sanitizeNode(doc) : null;
-    return clean && clean.type === 'doc' ? clean : { type: 'doc', content: [] };
-};