@ckeditor/ckeditor5-engine 34.2.0 → 35.1.0

package/src/dataprocessor/basichtmlwriter.js

@@ -2,13 +2,10 @@
  * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
 /**
  * @module engine/dataprocessor/basichtmlwriter
  */
-
 /* globals document */
-
 /**
  * Basic HTML writer. It uses the native `innerHTML` property for basic conversion
  * from a document fragment to an HTML string.
@@ -16,17 +13,16 @@
  * @implements module:engine/dataprocessor/htmlwriter~HtmlWriter
  */
 export default class BasicHtmlWriter {
-	/**
-	 * Returns an HTML string created from the document fragment.
-	 *
-	 * @param {DocumentFragment} fragment
-	 * @returns {String}
-	 */
-	getHtml( fragment ) {
-		const doc = document.implementation.createHTMLDocument( '' );
-		const container = doc.createElement( 'div' );
-		container.appendChild( fragment );
-
-		return container.innerHTML;
-	}
+    /**
+     * Returns an HTML string created from the document fragment.
+     *
+     * @param {DocumentFragment} fragment
+     * @returns {String}
+     */
+    getHtml(fragment) {
+        const doc = document.implementation.createHTMLDocument('');
+        const container = doc.createElement('div');
+        container.appendChild(fragment);
+        return container.innerHTML;
+    }
 }

package/src/dataprocessor/dataprocessor.js

@@ -0,0 +1,5 @@
+/**
+ * @license Copyright (c) 2003-2022, 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/dataprocessor/htmldataprocessor.js

@@ -2,16 +2,12 @@
  * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
 /**
  * @module engine/dataprocessor/htmldataprocessor
  */
-
-/* globals document, DOMParser */
-
+/* globals DOMParser */
 import BasicHtmlWriter from './basichtmlwriter';
 import DomConverter from '../view/domconverter';
-
 /**
  * The HTML data processor class.
  * This data processor implementation uses HTML as input and output data.
@@ -19,116 +15,104 @@ import DomConverter from '../view/domconverter';
  * @implements module:engine/dataprocessor/dataprocessor~DataProcessor
  */
 export default class HtmlDataProcessor {
-	/**
-	 * Creates a new instance of the HTML data processor class.
-	 *
-	 * @param {module:engine/view/document~Document} document The view document instance.
-	 */
-	constructor( document ) {
-		/**
-		 * A DOM parser instance used to parse an HTML string to an HTML document.
-		 *
-		 * @member {DOMParser}
-		 */
-		this.domParser = new DOMParser();
-
-		/**
-		 * A DOM converter used to convert DOM elements to view elements.
-		 *
-		 * @member {module:engine/view/domconverter~DomConverter}
-		 */
-		this.domConverter = new DomConverter( document, { renderingMode: 'data' } );
-
-		/**
-		 * A basic HTML writer instance used to convert DOM elements to an HTML string.
-		 *
-		 * @member {module:engine/dataprocessor/htmlwriter~HtmlWriter}
-		 */
-		this.htmlWriter = new BasicHtmlWriter();
-	}
-
-	/**
-	 * Converts a provided {@link module:engine/view/documentfragment~DocumentFragment document fragment}
-	 * to data format — in this case to an HTML string.
-	 *
-	 * @param {module:engine/view/documentfragment~DocumentFragment} viewFragment
-	 * @returns {String} HTML string.
-	 */
-	toData( viewFragment ) {
-		// Convert view DocumentFragment to DOM DocumentFragment.
-		const domFragment = this.domConverter.viewToDom( viewFragment, document );
-
-		// Convert DOM DocumentFragment to HTML output.
-		return this.htmlWriter.getHtml( domFragment );
-	}
-
-	/**
-	 * Converts the provided HTML string to a view tree.
-	 *
-	 * @param {String} data An HTML string.
-	 * @returns {module:engine/view/node~Node|module:engine/view/documentfragment~DocumentFragment|null} A converted view element.
-	 */
-	toView( data ) {
-		// Convert input HTML data to DOM DocumentFragment.
-		const domFragment = this._toDom( data );
-
-		// Convert DOM DocumentFragment to view DocumentFragment.
-		return this.domConverter.domToView( domFragment );
-	}
-
-	/**
-	 * 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 the DOM to the 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 {module:engine/view/matcher~MatcherPattern} pattern Pattern matching all view elements whose content should
-	 * be treated as raw data.
-	 */
-	registerRawContentMatcher( pattern ) {
-		this.domConverter.registerRawContentMatcher( pattern );
-	}
-
-	/**
-	 * If the processor is set to use marked fillers, it will insert `&nbsp;` fillers wrapped in `<span>` elements
-	 * (`<span data-cke-filler="true">&nbsp;</span>`) instead of regular `&nbsp;` characters.
-	 *
-	 * This mode allows for a more precise handling of the block fillers (so they do not leak into the editor content) but
-	 * bloats the editor data with additional markup.
-	 *
-	 * This mode may be required by some features and will be turned on by them automatically.
-	 *
-	 * @param {'default'|'marked'} type Whether to use the default or the marked `&nbsp;` block fillers.
-	 */
-	useFillerType( type ) {
-		this.domConverter.blockFillerMode = type == 'marked' ? 'markedNbsp' : 'nbsp';
-	}
-
-	/**
-	 * Converts an HTML string to its DOM representation. Returns a document fragment containing nodes parsed from
-	 * the provided data.
-	 *
-	 * @private
-	 * @param {String} data
-	 * @returns {DocumentFragment}
-	 */
-	_toDom( data ) {
-		// Wrap data with a <body> tag so leading non-layout nodes (like <script>, <style>, HTML comment)
-		// will be preserved in the body collection.
-		// Do it only for data that is not a full HTML document.
-		if ( !data.match( /<(?:html|body|head|meta)(?:\s[^>]*)?>/i ) ) {
-			data = `<body>${ data }</body>`;
-		}
-
-		const document = this.domParser.parseFromString( data, 'text/html' );
-		const fragment = document.createDocumentFragment();
-		const bodyChildNodes = document.body.childNodes;
-
-		while ( bodyChildNodes.length > 0 ) {
-			fragment.appendChild( bodyChildNodes[ 0 ] );
-		}
-
-		return fragment;
-	}
+    /**
+     * Creates a new instance of the HTML data processor class.
+     *
+     * @param {module:engine/view/document~Document} document The view document instance.
+     */
+    constructor(document) {
+        /**
+         * A DOM parser instance used to parse an HTML string to an HTML document.
+         *
+         * @member {DOMParser}
+         */
+        this.domParser = new DOMParser();
+        /**
+         * A DOM converter used to convert DOM elements to view elements.
+         *
+         * @member {module:engine/view/domconverter~DomConverter}
+         */
+        this.domConverter = new DomConverter(document, { renderingMode: 'data' });
+        /**
+         * A basic HTML writer instance used to convert DOM elements to an HTML string.
+         *
+         * @member {module:engine/dataprocessor/htmlwriter~HtmlWriter}
+         */
+        this.htmlWriter = new BasicHtmlWriter();
+    }
+    /**
+     * Converts a provided {@link module:engine/view/documentfragment~DocumentFragment document fragment}
+     * to data format &mdash; in this case to an HTML string.
+     *
+     * @param {module:engine/view/documentfragment~DocumentFragment} viewFragment
+     * @returns {String} HTML string.
+     */
+    toData(viewFragment) {
+        // Convert view DocumentFragment to DOM DocumentFragment.
+        const domFragment = this.domConverter.viewToDom(viewFragment);
+        // Convert DOM DocumentFragment to HTML output.
+        return this.htmlWriter.getHtml(domFragment);
+    }
+    /**
+     * Converts the provided HTML string to a view tree.
+     *
+     * @param {String} data An HTML string.
+     * @returns {module:engine/view/node~Node|module:engine/view/documentfragment~DocumentFragment|null} A converted view element.
+     */
+    toView(data) {
+        // Convert input HTML data to DOM DocumentFragment.
+        const domFragment = this._toDom(data);
+        // Convert DOM DocumentFragment to view DocumentFragment.
+        return this.domConverter.domToView(domFragment);
+    }
+    /**
+     * 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 the DOM to the 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 {module:engine/view/matcher~MatcherPattern} pattern Pattern matching all view elements whose content should
+     * be treated as raw data.
+     */
+    registerRawContentMatcher(pattern) {
+        this.domConverter.registerRawContentMatcher(pattern);
+    }
+    /**
+     * If the processor is set to use marked fillers, it will insert `&nbsp;` fillers wrapped in `<span>` elements
+     * (`<span data-cke-filler="true">&nbsp;</span>`) instead of regular `&nbsp;` characters.
+     *
+     * This mode allows for a more precise handling of the block fillers (so they do not leak into the editor content) but
+     * bloats the editor data with additional markup.
+     *
+     * This mode may be required by some features and will be turned on by them automatically.
+     *
+     * @param {'default'|'marked'} type Whether to use the default or the marked `&nbsp;` block fillers.
+     */
+    useFillerType(type) {
+        this.domConverter.blockFillerMode = type == 'marked' ? 'markedNbsp' : 'nbsp';
+    }
+    /**
+     * Converts an HTML string to its DOM representation. Returns a document fragment containing nodes parsed from
+     * the provided data.
+     *
+     * @private
+     * @param {String} data
+     * @returns {DocumentFragment}
+     */
+    _toDom(data) {
+        // Wrap data with a <body> tag so leading non-layout nodes (like <script>, <style>, HTML comment)
+        // will be preserved in the body collection.
+        // Do it only for data that is not a full HTML document.
+        if (!data.match(/<(?:html|body|head|meta)(?:\s[^>]*)?>/i)) {
+            data = `<body>${data}</body>`;
+        }
+        const document = this.domParser.parseFromString(data, 'text/html');
+        const fragment = document.createDocumentFragment();
+        const bodyChildNodes = document.body.childNodes;
+        while (bodyChildNodes.length > 0) {
+            fragment.appendChild(bodyChildNodes[0]);
+        }
+        return fragment;
+    }
 }

package/src/dataprocessor/htmlwriter.js

@@ -2,21 +2,4 @@
  * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
-/**
- * @module engine/dataprocessor/htmlwriter
- */
-
-/**
- * The HTML writer interface.
- *
- * @interface module:engine/dataprocessor/htmlwriter~HtmlWriter
- */
-
-/**
- * Returns an HTML string created from a document fragment.
- *
- * @method module:engine/dataprocessor/htmlwriter~HtmlWriter#getHtml
- * @param {DocumentFragment} fragment
- * @returns {String}
- */
+export {};

package/src/dataprocessor/xmldataprocessor.js

@@ -2,16 +2,12 @@
  * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
 /**
  * @module engine/dataprocessor/xmldataprocessor
  */
-
-/* globals DOMParser, document */
-
+/* globals DOMParser */
 import BasicHtmlWriter from './basichtmlwriter';
 import DomConverter from '../view/domconverter';
-
 /**
  * The XML data processor class.
  * This data processor implementation uses XML as input and output data.
@@ -21,137 +17,120 @@ import DomConverter from '../view/domconverter';
  * @implements module:engine/dataprocessor/dataprocessor~DataProcessor
  */
 export default class XmlDataProcessor {
-	/**
-	 * Creates a new instance of the XML data processor class.
-	 *
-	 * @param {module:engine/view/document~Document} document The view document instance.
-	 * @param {Object} options Configuration options.
-	 * @param {Array.<String>} [options.namespaces=[]] A list of namespaces allowed to use in the XML input.
-	 */
-	constructor( document, options = {} ) {
-		/**
-		 * A list of namespaces allowed to use in the XML input.
-		 *
-		 * For example, registering namespaces [ 'attribute', 'container' ] allows to use `<attirbute:tagName></attribute:tagName>`
-		 * and `<container:tagName></container:tagName>` input. It is mainly for debugging.
-		 *
-		 * @member {Array.<String>}
-		 */
-		this.namespaces = options.namespaces || [];
-
-		/**
-		 * DOM parser instance used to parse an XML string to an XML document.
-		 *
-		 * @member {DOMParser}
-		 */
-		this.domParser = new DOMParser();
-
-		/**
-		 * DOM converter used to convert DOM elements to view elements.
-		 *
-		 * @member {module:engine/view/domconverter~DomConverter}
-		 */
-		this.domConverter = new DomConverter( document, { renderingMode: 'data' } );
-
-		/**
-		 * A basic HTML writer instance used to convert DOM elements to an XML string.
-		 * There is no need to use a dedicated XML writer because the basic HTML writer works well in this case.
-		 *
-		 * @member {module:engine/dataprocessor/htmlwriter~HtmlWriter}
-		 */
-		this.htmlWriter = new BasicHtmlWriter();
-	}
-
-	/**
-	 * Converts the provided {@link module:engine/view/documentfragment~DocumentFragment document fragment}
-	 * to data format &mdash; in this case an XML string.
-	 *
-	 * @param {module:engine/view/documentfragment~DocumentFragment} viewFragment
-	 * @returns {String} An XML string.
-	 */
-	toData( viewFragment ) {
-		// Convert view DocumentFragment to DOM DocumentFragment.
-		const domFragment = this.domConverter.viewToDom( viewFragment, document );
-
-		// Convert DOM DocumentFragment to XML output.
-		// There is no need to use dedicated for XML serializing method because BasicHtmlWriter works well in this case.
-		return this.htmlWriter.getHtml( domFragment );
-	}
-
-	/**
-	 * Converts the provided XML string to a view tree.
-	 *
-	 * @param {String} data An XML string.
-	 * @returns {module:engine/view/node~Node|module:engine/view/documentfragment~DocumentFragment|null} A converted view element.
-	 */
-	toView( data ) {
-		// Convert input XML data to DOM DocumentFragment.
-		const domFragment = this._toDom( data );
-
-		// Convert DOM DocumentFragment to view DocumentFragment.
-		return this.domConverter.domToView( domFragment, { keepOriginalCase: true } );
-	}
-
-	/**
-	 * 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 XML 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 {module:engine/view/matcher~MatcherPattern} pattern Pattern matching all view elements whose content should
-	 * be treated as raw data.
-	 */
-	registerRawContentMatcher( pattern ) {
-		this.domConverter.registerRawContentMatcher( pattern );
-	}
-
-	/**
-	 * If the processor is set to use marked fillers, it will insert `&nbsp;` fillers wrapped in `<span>` elements
-	 * (`<span data-cke-filler="true">&nbsp;</span>`) instead of regular `&nbsp;` characters.
-	 *
-	 * This mode allows for a more precise handling of block fillers (so they do not leak into editor content) but
-	 * bloats the editor data with additional markup.
-	 *
-	 * This mode may be required by some features and will be turned on by them automatically.
-	 *
-	 * @param {'default'|'marked'} type Whether to use the default or the marked `&nbsp;` block fillers.
-	 */
-	useFillerType( type ) {
-		this.domConverter.blockFillerMode = type == 'marked' ? 'markedNbsp' : 'nbsp';
-	}
-
-	/**
-	 * Converts an XML string to its DOM representation. Returns a document fragment containing nodes parsed from
-	 * the provided data.
-	 *
-	 * @private
-	 * @param {String} data
-	 * @returns {DocumentFragment}
-	 */
-	_toDom( data ) {
-		// Stringify namespaces.
-		const namespaces = this.namespaces.map( nsp => `xmlns:${ nsp }="nsp"` ).join( ' ' );
-
-		// Wrap data into root element with optional namespace definitions.
-		data = `<xml ${ namespaces }>${ data }</xml>`;
-
-		const parsedDocument = this.domParser.parseFromString( data, 'text/xml' );
-
-		// Parse validation.
-		const parserError = parsedDocument.querySelector( 'parsererror' );
-
-		if ( parserError ) {
-			throw new Error( 'Parse error - ' + parserError.textContent );
-		}
-
-		const fragment = parsedDocument.createDocumentFragment();
-		const nodes = parsedDocument.documentElement.childNodes;
-
-		while ( nodes.length > 0 ) {
-			fragment.appendChild( nodes[ 0 ] );
-		}
-
-		return fragment;
-	}
+    /**
+     * Creates a new instance of the XML data processor class.
+     *
+     * @param {module:engine/view/document~Document} document The view document instance.
+     * @param {Object} options Configuration options.
+     * @param {Array.<String>} [options.namespaces=[]] A list of namespaces allowed to use in the XML input.
+     */
+    constructor(document, options = {}) {
+        /**
+         * A list of namespaces allowed to use in the XML input.
+         *
+         * For example, registering namespaces [ 'attribute', 'container' ] allows to use `<attirbute:tagName></attribute:tagName>`
+         * and `<container:tagName></container:tagName>` input. It is mainly for debugging.
+         *
+         * @member {Array.<String>}
+         */
+        this.namespaces = options.namespaces || [];
+        /**
+         * DOM parser instance used to parse an XML string to an XML document.
+         *
+         * @member {DOMParser}
+         */
+        this.domParser = new DOMParser();
+        /**
+         * DOM converter used to convert DOM elements to view elements.
+         *
+         * @member {module:engine/view/domconverter~DomConverter}
+         */
+        this.domConverter = new DomConverter(document, { renderingMode: 'data' });
+        /**
+         * A basic HTML writer instance used to convert DOM elements to an XML string.
+         * There is no need to use a dedicated XML writer because the basic HTML writer works well in this case.
+         *
+         * @member {module:engine/dataprocessor/htmlwriter~HtmlWriter}
+         */
+        this.htmlWriter = new BasicHtmlWriter();
+    }
+    /**
+     * Converts the provided {@link module:engine/view/documentfragment~DocumentFragment document fragment}
+     * to data format &mdash; in this case an XML string.
+     *
+     * @param {module:engine/view/documentfragment~DocumentFragment} viewFragment
+     * @returns {String} An XML string.
+     */
+    toData(viewFragment) {
+        // Convert view DocumentFragment to DOM DocumentFragment.
+        const domFragment = this.domConverter.viewToDom(viewFragment);
+        // Convert DOM DocumentFragment to XML output.
+        // There is no need to use dedicated for XML serializing method because BasicHtmlWriter works well in this case.
+        return this.htmlWriter.getHtml(domFragment);
+    }
+    /**
+     * Converts the provided XML string to a view tree.
+     *
+     * @param {String} data An XML string.
+     * @returns {module:engine/view/node~Node|module:engine/view/documentfragment~DocumentFragment|null} A converted view element.
+     */
+    toView(data) {
+        // Convert input XML data to DOM DocumentFragment.
+        const domFragment = this._toDom(data);
+        // Convert DOM DocumentFragment to view DocumentFragment.
+        return this.domConverter.domToView(domFragment, { keepOriginalCase: true });
+    }
+    /**
+     * 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 XML 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 {module:engine/view/matcher~MatcherPattern} pattern Pattern matching all view elements whose content should
+     * be treated as raw data.
+     */
+    registerRawContentMatcher(pattern) {
+        this.domConverter.registerRawContentMatcher(pattern);
+    }
+    /**
+     * If the processor is set to use marked fillers, it will insert `&nbsp;` fillers wrapped in `<span>` elements
+     * (`<span data-cke-filler="true">&nbsp;</span>`) instead of regular `&nbsp;` characters.
+     *
+     * This mode allows for a more precise handling of block fillers (so they do not leak into editor content) but
+     * bloats the editor data with additional markup.
+     *
+     * This mode may be required by some features and will be turned on by them automatically.
+     *
+     * @param {'default'|'marked'} type Whether to use the default or the marked `&nbsp;` block fillers.
+     */
+    useFillerType(type) {
+        this.domConverter.blockFillerMode = type == 'marked' ? 'markedNbsp' : 'nbsp';
+    }
+    /**
+     * Converts an XML string to its DOM representation. Returns a document fragment containing nodes parsed from
+     * the provided data.
+     *
+     * @private
+     * @param {String} data
+     * @returns {DocumentFragment}
+     */
+    _toDom(data) {
+        // Stringify namespaces.
+        const namespaces = this.namespaces.map(nsp => `xmlns:${nsp}="nsp"`).join(' ');
+        // Wrap data into root element with optional namespace definitions.
+        data = `<xml ${namespaces}>${data}</xml>`;
+        const parsedDocument = this.domParser.parseFromString(data, 'text/xml');
+        // Parse validation.
+        const parserError = parsedDocument.querySelector('parsererror');
+        if (parserError) {
+            throw new Error('Parse error - ' + parserError.textContent);
+        }
+        const fragment = parsedDocument.createDocumentFragment();
+        const nodes = parsedDocument.documentElement.childNodes;
+        while (nodes.length > 0) {
+            fragment.appendChild(nodes[0]);
+        }
+        return fragment;
+    }
 }