@ckeditor/ckeditor5-markdown-gfm 0.0.0-internal-20241017.0

package/dist/pastefrommarkdownexperimental.d.ts

@@ -0,0 +1,82 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module markdown-gfm/pastefrommarkdownexperimental
+ */
+import { Plugin, type Editor } from 'ckeditor5/src/core.js';
+import { ClipboardPipeline } from 'ckeditor5/src/clipboard.js';
+/**
+ * The GitHub Flavored Markdown (GFM) paste plugin.
+ *
+ * For a detailed overview, check the {@glink features/pasting/paste-markdown Paste Markdown feature} guide.
+ */
+export default class PasteFromMarkdownExperimental extends Plugin {
+    /**
+     * @internal
+     */
+    private _gfmDataProcessor;
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "PasteFromMarkdownExperimental";
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin(): true;
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof ClipboardPipeline];
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * Determines if the code copied from a website in the `text/html` type can be parsed as Markdown.
+     * It removes any OS-specific HTML tags, for example, <meta> on macOS and <!--StartFragment--> on Windows.
+     * Then removes a single wrapper HTML tag or wrappers for sibling tags, and if there are no more tags left,
+     * returns the remaining text. Returns null if there are any remaining HTML tags detected.
+     *
+     * @param htmlString Clipboard content in the `text/html` type format.
+     */
+    private _parseMarkdownFromHtml;
+    /**
+     * Removes OS-specific tags.
+     *
+     * @param htmlString Clipboard content in the `text/html` type format.
+     */
+    private _removeOsSpecificTags;
+    /**
+     * If the input HTML string contains any first-level formatting tags
+     * like <b>, <strong>, or <i>, we should not treat it as Markdown.
+     *
+     * @param htmlString Clipboard content.
+     */
+    private _containsOnlyAllowedFirstLevelTags;
+    /**
+     * Removes multiple HTML wrapper tags from a list of sibling HTML tags.
+     *
+     * @param htmlString Clipboard content without any OS-specific tags.
+     */
+    private _removeFirstLevelWrapperTagsAndBrs;
+    /**
+     * Determines if a string contains any HTML tags.
+     */
+    private _containsAnyRemainingHtmlTags;
+    /**
+     * Replaces the reserved HTML entities with the actual characters.
+     *
+     * @param htmlString Clipboard content without any tags.
+     */
+    private _replaceHtmlReservedEntitiesWithCharacters;
+}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@ckeditor/ckeditor5-markdown-gfm",
+  "version": "0.0.0-internal-20241017.0",
+  "description": "GitHub Flavored Markdown data processor for CKEditor 5.",
+  "keywords": [
+    "ckeditor",
+    "ckeditor5",
+    "ckeditor 5",
+    "ckeditor5-feature",
+    "ckeditor5-plugin",
+    "ckeditor5-dll"
+  ],
+  "type": "module",
+  "main": "src/index.js",
+  "dependencies": {
+    "@ckeditor/ckeditor5-clipboard": "0.0.0-internal-20241017.0",
+    "@ckeditor/ckeditor5-core": "0.0.0-internal-20241017.0",
+    "@ckeditor/ckeditor5-engine": "0.0.0-internal-20241017.0",
+    "ckeditor5": "0.0.0-internal-20241017.0",
+    "marked": "4.0.12",
+    "turndown": "7.2.0",
+    "turndown-plugin-gfm": "1.0.2"
+  },
+  "author": "CKSource (http://cksource.com/)",
+  "license": "GPL-2.0-or-later",
+  "homepage": "https://ckeditor.com/ckeditor-5",
+  "bugs": "https://github.com/ckeditor/ckeditor5/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ckeditor/ckeditor5.git",
+    "directory": "packages/ckeditor5-markdown-gfm"
+  },
+  "files": [
+    "dist",
+    "lang",
+    "src/**/*.js",
+    "src/**/*.d.ts",
+    "theme",
+    "build",
+    "ckeditor5-metadata.json",
+    "CHANGELOG.md"
+  ],
+  "types": "src/index.d.ts"
+}

package/src/augmentation.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import type { Markdown, PasteFromMarkdownExperimental } from './index.js';
+declare module '@ckeditor/ckeditor5-core' {
+    interface PluginsMap {
+        [Markdown.pluginName]: Markdown;
+        [PasteFromMarkdownExperimental.pluginName]: PasteFromMarkdownExperimental;
+    }
+}

package/src/augmentation.js

@@ -0,0 +1,5 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+export {};

package/src/gfmdataprocessor.d.ts

@@ -0,0 +1,70 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module markdown-gfm/gfmdataprocessor
+ */
+import { type DataProcessor, type ViewDocument, type ViewDocumentFragment, type MatcherPattern } from 'ckeditor5/src/engine.js';
+/**
+ * This data processor implementation uses GitHub Flavored Markdown as input/output data.
+ *
+ * See the {@glink features/markdown Markdown output} guide to learn more on how to enable it.
+ */
+export default class GFMDataProcessor implements DataProcessor {
+    /**
+     * HTML data processor used to process HTML produced by the Markdown-to-HTML converter and the other way.
+     */
+    private _htmlDP;
+    /**
+     * Helper for converting Markdown to HTML.
+     */
+    private _markdown2html;
+    /**
+     * Helper for converting HTML to Markdown.
+     */
+    private _html2markdown;
+    /**
+     * Creates a new instance of the Markdown data processor class.
+     */
+    constructor(document: ViewDocument);
+    /**
+     * Keeps the specified element in the output as HTML. This is useful if the editor contains
+     * features producing HTML that is not a part of the Markdown standard.
+     *
+     * By default, all HTML tags are removed.
+     *
+     * @param element The element name to be kept.
+     */
+    keepHtml(element: keyof HTMLElementTagNameMap): void;
+    /**
+     * Converts the provided Markdown string to a view tree.
+     *
+     * @param data A Markdown string.
+     * @returns The converted view element.
+     */
+    toView(data: string): ViewDocumentFragment;
+    /**
+     * Converts the provided {@link module:engine/view/documentfragment~DocumentFragment} to data format – in this
+     * case to a Markdown string.
+     *
+     * @returns Markdown string.
+     */
+    toData(viewFragment: ViewDocumentFragment): string;
+    /**
+     * Registers a {@link module:engine/view/matcher~MatcherPattern} for view elements whose content should be treated as raw data
+     * and not processed during the conversion from Markdown to view elements.
+     *
+     * The raw data can be later accessed by a
+     * {@link module:engine/view/element~Element#getCustomProperty custom property of a view element} called `"$rawContent"`.
+     *
+     * @param pattern The pattern matching all view elements whose content should
+     * be treated as raw data.
+     */
+    registerRawContentMatcher(pattern: MatcherPattern): void;
+    /**
+     * This method does not have any effect on the data processor result. It exists for compatibility with the
+     * {@link module:engine/dataprocessor/dataprocessor~DataProcessor `DataProcessor` interface}.
+     */
+    useFillerType(): void;
+}

package/src/gfmdataprocessor.js

@@ -0,0 +1,74 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module markdown-gfm/gfmdataprocessor
+ */
+import { HtmlDataProcessor } from 'ckeditor5/src/engine.js';
+import { MarkdownToHtml } from './markdown2html/markdown2html.js';
+import { HtmlToMarkdown } from './html2markdown/html2markdown.js';
+/**
+ * This data processor implementation uses GitHub Flavored Markdown as input/output data.
+ *
+ * See the {@glink features/markdown Markdown output} guide to learn more on how to enable it.
+ */
+export default class GFMDataProcessor {
+    /**
+     * Creates a new instance of the Markdown data processor class.
+     */
+    constructor(document) {
+        this._htmlDP = new HtmlDataProcessor(document);
+        this._markdown2html = new MarkdownToHtml();
+        this._html2markdown = new HtmlToMarkdown();
+    }
+    /**
+     * Keeps the specified element in the output as HTML. This is useful if the editor contains
+     * features producing HTML that is not a part of the Markdown standard.
+     *
+     * By default, all HTML tags are removed.
+     *
+     * @param element The element name to be kept.
+     */
+    keepHtml(element) {
+        this._html2markdown.keep([element]);
+    }
+    /**
+     * Converts the provided Markdown string to a view tree.
+     *
+     * @param data A Markdown string.
+     * @returns The converted view element.
+     */
+    toView(data) {
+        const html = this._markdown2html.parse(data);
+        return this._htmlDP.toView(html);
+    }
+    /**
+     * Converts the provided {@link module:engine/view/documentfragment~DocumentFragment} to data format – in this
+     * case to a Markdown string.
+     *
+     * @returns Markdown string.
+     */
+    toData(viewFragment) {
+        const html = this._htmlDP.toData(viewFragment);
+        return this._html2markdown.parse(html);
+    }
+    /**
+     * Registers a {@link module:engine/view/matcher~MatcherPattern} for view elements whose content should be treated as raw data
+     * and not processed during the conversion from Markdown to view elements.
+     *
+     * The raw data can be later accessed by a
+     * {@link module:engine/view/element~Element#getCustomProperty custom property of a view element} called `"$rawContent"`.
+     *
+     * @param pattern The pattern matching all view elements whose content should
+     * be treated as raw data.
+     */
+    registerRawContentMatcher(pattern) {
+        this._htmlDP.registerRawContentMatcher(pattern);
+    }
+    /**
+     * This method does not have any effect on the data processor result. It exists for compatibility with the
+     * {@link module:engine/dataprocessor/dataprocessor~DataProcessor `DataProcessor` interface}.
+     */
+    useFillerType() { }
+}

package/src/html2markdown/html2markdown.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module markdown-gfm/html2markdown/html2markdown
+ */
+import Turndown from 'turndown';
+/**
+ * This is a helper class used by the {@link module:markdown-gfm/markdown Markdown feature} to convert HTML to Markdown.
+ */
+export declare class HtmlToMarkdown {
+    private _parser;
+    constructor();
+    parse(html: string): string;
+    keep(elements: Turndown.Filter): void;
+    private _createParser;
+    private _todoList;
+}

package/src/html2markdown/html2markdown.js

@@ -0,0 +1,134 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module markdown-gfm/html2markdown/html2markdown
+ */
+import Turndown from 'turndown';
+// There no avaialble types for 'turndown-plugin-gfm' module and it's not worth to generate them on our own.
+/* eslint-disable @typescript-eslint/ban-ts-comment */
+// @ts-ignore
+import { gfm } from 'turndown-plugin-gfm';
+const autolinkRegex = /* #__PURE__ */ new RegExp(
+// Prefix.
+/\b(?:(?:https?|ftp):\/\/|www\.)/.source +
+    // Domain name.
+    /(?![-_])(?:[-_a-z0-9\u00a1-\uffff]{1,63}\.)+(?:[a-z\u00a1-\uffff]{2,63})/.source +
+    // The rest.
+    /(?:[^\s<>]*)/.source, 'gi');
+class UpdatedTurndown extends Turndown {
+    escape(string) {
+        const originalEscape = super.escape;
+        function escape(string) {
+            string = originalEscape(string);
+            // Escape "<".
+            string = string.replace(/</g, '\\<');
+            return string;
+        }
+        // Urls should not be escaped. Our strategy is using a regex to find them and escape everything
+        // which is out of the matches parts.
+        let escaped = '';
+        let lastLinkEnd = 0;
+        for (const match of this._matchAutolink(string)) {
+            const index = match.index;
+            // Append the substring between the last match and the current one (if anything).
+            if (index > lastLinkEnd) {
+                escaped += escape(string.substring(lastLinkEnd, index));
+            }
+            const matchedURL = match[0];
+            escaped += matchedURL;
+            lastLinkEnd = index + matchedURL.length;
+        }
+        // Add text after the last link or at the string start if no matches.
+        if (lastLinkEnd < string.length) {
+            escaped += escape(string.substring(lastLinkEnd, string.length));
+        }
+        return escaped;
+    }
+    /**
+     * Trimming end of link.
+     * https://github.github.com/gfm/#autolinks-extension-
+     */
+    *_matchAutolink(string) {
+        for (const match of string.matchAll(autolinkRegex)) {
+            const matched = match[0];
+            const length = this._autolinkFindEnd(matched);
+            yield Object.assign([matched.substring(0, length)], { index: match.index });
+            // We could adjust regex.lastIndex but it's not needed because what we skipped is for sure not a valid URL.
+        }
+    }
+    /**
+     * Returns the new length of the link (after it would trim trailing characters).
+     */
+    _autolinkFindEnd(string) {
+        let length = string.length;
+        while (length > 0) {
+            const char = string[length - 1];
+            if ('?!.,:*_~\'"'.includes(char)) {
+                length--;
+            }
+            else if (char == ')') {
+                let openBrackets = 0;
+                for (let i = 0; i < length; i++) {
+                    if (string[i] == '(') {
+                        openBrackets++;
+                    }
+                    else if (string[i] == ')') {
+                        openBrackets--;
+                    }
+                }
+                // If there is fewer opening brackets then closing ones we should remove a closing bracket.
+                if (openBrackets < 0) {
+                    length--;
+                }
+                else {
+                    break;
+                }
+            }
+            else {
+                break;
+            }
+        }
+        return length;
+    }
+}
+/**
+ * This is a helper class used by the {@link module:markdown-gfm/markdown Markdown feature} to convert HTML to Markdown.
+ */
+export class HtmlToMarkdown {
+    constructor() {
+        this._parser = this._createParser();
+    }
+    parse(html) {
+        return this._parser.turndown(html);
+    }
+    keep(elements) {
+        this._parser.keep(elements);
+    }
+    _createParser() {
+        const parser = new UpdatedTurndown({
+            codeBlockStyle: 'fenced',
+            hr: '---',
+            headingStyle: 'atx'
+        });
+        parser.use([
+            gfm,
+            this._todoList
+        ]);
+        return parser;
+    }
+    // This is a copy of the original taskListItems rule from turndown-plugin-gfm, with minor changes.
+    _todoList(turndown) {
+        turndown.addRule('taskListItems', {
+            filter(node) {
+                return node.type === 'checkbox' &&
+                    // Changes here as CKEditor outputs a deeper structure.
+                    (node.parentNode.nodeName === 'LI' || node.parentNode.parentNode.nodeName === 'LI');
+            },
+            replacement(content, node) {
+                return (node.checked ? '[x]' : '[ ]') + ' ';
+            }
+        });
+    }
+}

package/src/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module markdown-gfm
+ */
+export { default as Markdown } from './markdown.js';
+export { default as PasteFromMarkdownExperimental } from './pastefrommarkdownexperimental.js';
+import './augmentation.js';

package/src/index.js

@@ -0,0 +1,10 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module markdown-gfm
+ */
+export { default as Markdown } from './markdown.js';
+export { default as PasteFromMarkdownExperimental } from './pastefrommarkdownexperimental.js';
+import './augmentation.js';

package/src/markdown.d.ts

@@ -0,0 +1,27 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module markdown-gfm/markdown
+ */
+import { Plugin, type Editor } from 'ckeditor5/src/core.js';
+/**
+ * The GitHub Flavored Markdown (GFM) plugin.
+ *
+ * For a detailed overview, check the {@glink features/markdown Markdown feature} guide.
+ */
+export default class Markdown extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "Markdown";
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin(): true;
+}

package/src/markdown.js

@@ -0,0 +1,35 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module markdown-gfm/markdown
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import GFMDataProcessor from './gfmdataprocessor.js';
+/**
+ * The GitHub Flavored Markdown (GFM) plugin.
+ *
+ * For a detailed overview, check the {@glink features/markdown Markdown feature} guide.
+ */
+export default class Markdown extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    constructor(editor) {
+        super(editor);
+        editor.data.processor = new GFMDataProcessor(editor.data.viewDocument);
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'Markdown';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin() {
+        return true;
+    }
+}

package/src/markdown2html/markdown2html.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * This is a helper class used by the {@link module:markdown-gfm/markdown Markdown feature} to convert Markdown to HTML.
+ */
+export declare class MarkdownToHtml {
+    private _parser;
+    private _options;
+    constructor();
+    parse(markdown: string): string;
+}

package/src/markdown2html/markdown2html.js

@@ -0,0 +1,48 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module markdown-gfm/markdown2html/markdown2html
+ */
+import { marked } from 'marked';
+/**
+ * This is a helper class used by the {@link module:markdown-gfm/markdown Markdown feature} to convert Markdown to HTML.
+ */
+export class MarkdownToHtml {
+    constructor() {
+        this._options = {
+            gfm: true,
+            breaks: true,
+            tables: true,
+            xhtml: true,
+            headerIds: false
+        };
+        // Overrides.
+        marked.use({
+            tokenizer: {
+                // Disable the autolink rule in the lexer.
+                autolink: () => null,
+                url: () => null
+            },
+            renderer: {
+                checkbox(...args) {
+                    // Remove bogus space after <input type="checkbox"> because it would be preserved
+                    // by DomConverter as it's next to an inline object.
+                    return Object.getPrototypeOf(this).checkbox.call(this, ...args).trimRight();
+                },
+                code(...args) {
+                    // Since marked v1.2.8, every <code> gets a trailing "\n" whether it originally
+                    // ended with one or not (see https://github.com/markedjs/marked/issues/1884 to learn why).
+                    // This results in a redundant soft break in the model when loaded into the editor, which
+                    // is best prevented at this stage. See https://github.com/ckeditor/ckeditor5/issues/11124.
+                    return Object.getPrototypeOf(this).code.call(this, ...args).replace('\n</code>', '</code>');
+                }
+            }
+        });
+        this._parser = marked;
+    }
+    parse(markdown) {
+        return this._parser.parse(markdown, this._options);
+    }
+}

package/src/pastefrommarkdownexperimental.d.ts

@@ -0,0 +1,78 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module markdown-gfm/pastefrommarkdownexperimental
+ */
+import { Plugin, type Editor } from 'ckeditor5/src/core.js';
+import { ClipboardPipeline } from 'ckeditor5/src/clipboard.js';
+/**
+ * The GitHub Flavored Markdown (GFM) paste plugin.
+ *
+ * For a detailed overview, check the {@glink features/pasting/paste-markdown Paste Markdown feature} guide.
+ */
+export default class PasteFromMarkdownExperimental extends Plugin {
+    /**
+     * @internal
+     */
+    private _gfmDataProcessor;
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "PasteFromMarkdownExperimental";
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin(): true;
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof ClipboardPipeline];
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * Determines if the code copied from a website in the `text/html` type can be parsed as Markdown.
+     * It removes any OS-specific HTML tags, for example, <meta> on macOS and <!--StartFragment--> on Windows.
+     * Then removes a single wrapper HTML tag or wrappers for sibling tags, and if there are no more tags left,
+     * returns the remaining text. Returns null if there are any remaining HTML tags detected.
+     *
+     * @param htmlString Clipboard content in the `text/html` type format.
+     */
+    private _parseMarkdownFromHtml;
+    /**
+     * Removes OS-specific tags.
+     *
+     * @param htmlString Clipboard content in the `text/html` type format.
+     */
+    private _removeOsSpecificTags;
+    /**
+     * If the input HTML string contains any first-level formatting tags
+     * like <b>, <strong>, or <i>, we should not treat it as Markdown.
+     *
+     * @param htmlString Clipboard content.
+     */
+    private _containsOnlyAllowedFirstLevelTags;
+    /**
+     * Removes multiple HTML wrapper tags from a list of sibling HTML tags.
+     *
+     * @param htmlString Clipboard content without any OS-specific tags.
+     */
+    private _removeFirstLevelWrapperTagsAndBrs;
+    /**
+     * Determines if a string contains any HTML tags.
+     */
+    private _containsAnyRemainingHtmlTags;
+    /**
+     * Replaces the reserved HTML entities with the actual characters.
+     *
+     * @param htmlString Clipboard content without any tags.
+     */
+    private _replaceHtmlReservedEntitiesWithCharacters;
+}