@ckeditor/ckeditor5-html-support 29.2.0 → 32.0.0

package/src/integrations/mediaembed.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @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
  */
 
@@ -9,7 +9,6 @@
 
 import { Plugin } from 'ckeditor5/src/core';
 
-import { disallowedAttributesConverter } from '../converters';
 import { setViewAttributes } from '../conversionutils.js';
 import DataFilter from '../datafilter';
 import DataSchema from '../dataschema';
@@ -57,7 +56,6 @@ export default class MediaEmbedElementSupport extends Plugin {
 				]
 			} );
 
-			conversion.for( 'upcast' ).add( disallowedAttributesConverter( definition, dataFilter ) );
 			conversion.for( 'upcast' ).add( viewToModelMediaAttributesConverter( dataFilter, mediaElementName ) );
 			conversion.for( 'dataDowncast' ).add( modelToViewMediaAttributeConverter( mediaElementName ) );
 
@@ -68,39 +66,18 @@ export default class MediaEmbedElementSupport extends Plugin {
 
 function viewToModelMediaAttributesConverter( dataFilter, mediaElementName ) {
 	return dispatcher => {
-		// Here we want to be the first to convert (and consume) the figure element, otherwise GHS can pick it up and
-		// convert it to generic `htmlFigure`.
-		dispatcher.on( 'element:figure', upcastFigure, { priority: 'high' } );
-
-		// Handle media elements without `<figure>` container.
 		dispatcher.on( `element:${ mediaElementName }`, upcastMedia );
 	};
 
-	function upcastFigure( evt, data, conversionApi ) {
-		const viewFigureElement = data.viewItem;
-
-		// Convert only "media figure" elements.
-		if ( !conversionApi.consumable.test( viewFigureElement, { name: true, classes: 'media' } ) ) {
-			return;
-		}
-
-		// Find media element.
-		const viewMediaElement = Array.from( viewFigureElement.getChildren() )
-			.find( item => item.is( 'element', mediaElementName ) );
-
-		// Do not convert if media element is absent.
-		if ( !viewMediaElement ) {
-			return;
-		}
-
-		// Convert just the media element.
-		Object.assign( data, conversionApi.convertItem( viewMediaElement, data.modelCursor ) );
+	function upcastMedia( evt, data, conversionApi ) {
+		const viewMediaElement = data.viewItem;
+		const viewParent = viewMediaElement.parent;
 
 		preserveElementAttributes( viewMediaElement, 'htmlAttributes' );
-		preserveElementAttributes( viewFigureElement, 'htmlFigureAttributes' );
 
-		// Consume the figure to prevent converting it to `htmlFigure` by default GHS converters.
-		conversionApi.consumable.consume( viewFigureElement, { name: true } );
+		if ( viewParent.is( 'element', 'figure' ) && viewParent.hasClass( 'media' ) ) {
+			preserveElementAttributes( viewParent, 'htmlFigureAttributes' );
+		}
 
 		function preserveElementAttributes( viewElement, attributeName ) {
 			const viewAttributes = dataFilter._consumeAllowedAttributes( viewElement, conversionApi );
@@ -110,15 +87,6 @@ function viewToModelMediaAttributesConverter( dataFilter, mediaElementName ) {
 			}
 		}
 	}
-
-	function upcastMedia( evt, data, conversionApi ) {
-		const viewMediaElement = data.viewItem;
-		const viewAttributes = dataFilter._consumeAllowedAttributes( viewMediaElement, conversionApi );
-
-		if ( viewAttributes ) {
-			conversionApi.writer.setAttribute( 'htmlAttributes', viewAttributes, data.modelRange );
-		}
-	}
 }
 
 function modelToViewMediaAttributeConverter( mediaElementName ) {
@@ -133,7 +101,7 @@ function modelToViewMediaAttributeConverter( mediaElementName ) {
 				}
 
 				const containerElement = conversionApi.mapper.toViewElement( data.item );
-				const viewElement = getDescendantElement( conversionApi, containerElement, elementName );
+				const viewElement = getDescendantElement( conversionApi.writer, containerElement, elementName );
 
 				setViewAttributes( conversionApi.writer, data.attributeNewValue, viewElement );
 			} );
@@ -145,12 +113,12 @@ function modelToViewMediaAttributeConverter( mediaElementName ) {
 // Includes view element itself.
 //
 // @private
-// @param {module:engine/conversion/downcastdispatcher~DowncastConversionApi} conversionApi
+// @param {module:engine/view/downcastwriter~DowncastWriter} writer
 // @param {module:engine/view/element~Element} containerElement
 // @param {String} elementName
 // @returns {module:engine/view/element~Element|null}
-function getDescendantElement( conversionApi, containerElement, elementName ) {
-	const range = conversionApi.writer.createRangeOn( containerElement );
+function getDescendantElement( writer, containerElement, elementName ) {
+	const range = writer.createRangeOn( containerElement );
 
 	for ( const { item } of range.getWalker() ) {
 		if ( item.is( 'element', elementName ) ) {

package/src/integrations/script.js

@@ -0,0 +1,73 @@
+/**
+ * @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 html-support/integrations/script
+ */
+
+import { Plugin } from 'ckeditor5/src/core';
+import {
+	createObjectView,
+	modelToViewBlockAttributeConverter,
+	viewToModelBlockAttributeConverter,
+	viewToModelObjectConverter
+} from '../converters.js';
+
+import DataFilter from '../datafilter';
+
+/**
+ * Provides the General HTML Support for `script` elements.
+ *
+ * @extends module:core/plugin~Plugin
+ */
+export default class ScriptElementSupport extends Plugin {
+	/**
+	 * @inheritDoc
+	 */
+	static get requires() {
+		return [ DataFilter ];
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	init() {
+		const dataFilter = this.editor.plugins.get( DataFilter );
+
+		dataFilter.on( 'register:script', ( evt, definition ) => {
+			const editor = this.editor;
+			const schema = editor.model.schema;
+			const conversion = editor.conversion;
+
+			schema.register( 'htmlScript', definition.modelSchema );
+
+			schema.extend( 'htmlScript', {
+				allowAttributes: [ 'htmlAttributes', 'htmlContent' ]
+			} );
+
+			editor.data.registerRawContentMatcher( {
+				name: 'script'
+			} );
+
+			conversion.for( 'upcast' ).elementToElement( {
+				view: 'script',
+				model: viewToModelObjectConverter( definition )
+			} );
+
+			conversion.for( 'upcast' ).add( viewToModelBlockAttributeConverter( definition, dataFilter ) );
+
+			conversion.for( 'downcast' ).elementToElement( {
+				model: 'htmlScript',
+				view: ( modelElement, { writer } ) => {
+					return createObjectView( 'script', modelElement, writer );
+				}
+			} );
+
+			conversion.for( 'downcast' ).add( modelToViewBlockAttributeConverter( definition ) );
+
+			evt.stop();
+		} );
+	}
+}

package/src/integrations/table.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @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
  */
 
@@ -8,7 +8,6 @@
  */
 
 import { Plugin } from 'ckeditor5/src/core';
-import { disallowedAttributesConverter } from '../converters';
 import { setViewAttributes } from '../conversionutils.js';
 
 import DataFilter from '../datafilter';
@@ -54,16 +53,11 @@ export default class TableElementSupport extends Plugin {
 				]
 			} );
 
-			conversion.for( 'upcast' ).add( disallowedAttributesConverter( definition, dataFilter ) );
 			conversion.for( 'upcast' ).add( viewToModelTableAttributeConverter( dataFilter ) );
 			conversion.for( 'downcast' ).add( modelToViewTableAttributeConverter() );
 
 			evt.stop();
 		} );
-
-		dataFilter.on( 'register:figure', () => {
-			conversion.for( 'upcast' ).add( consumeTableFigureConverter() );
-		} );
 	}
 }
 
@@ -125,7 +119,7 @@ function modelToViewTableAttributeConverter() {
 				}
 
 				const containerElement = conversionApi.mapper.toViewElement( data.item );
-				const viewElement = getDescendantElement( conversionApi, containerElement, elementName );
+				const viewElement = getDescendantElement( conversionApi.writer, containerElement, elementName );
 
 				setViewAttributes( conversionApi.writer, data.attributeNewValue, viewElement );
 			} );
@@ -137,12 +131,12 @@ function modelToViewTableAttributeConverter() {
 // Includes view element itself.
 //
 // @private
-// @param {module:engine/conversion/downcastdispatcher~DowncastConversionApi} conversionApi
+// @param {module:engine/view/downcastwriter~DowncastWriter} writer
 // @param {module:engine/view/element~Element} containerElement
 // @param {String} elementName
 // @returns {module:engine/view/element~Element|null}
-function getDescendantElement( conversionApi, containerElement, elementName ) {
-	const range = conversionApi.writer.createRangeOn( containerElement );
+function getDescendantElement( writer, containerElement, elementName ) {
+	const range = writer.createRangeOn( containerElement );
 
 	for ( const { item } of range.getWalker() ) {
 		if ( item.is( 'element', elementName ) ) {
@@ -150,21 +144,3 @@ function getDescendantElement( conversionApi, containerElement, elementName ) {
 		}
 	}
 }
-
-// Conversion helper consuming figure element if it's a part of the Table feature
-// to avoid elementToElement conversion for figure with that context.
-//
-// @private
-// @returns {Function} Returns a conversion callback.
-function consumeTableFigureConverter() {
-	return dispatcher => {
-		dispatcher.on( 'element:figure', ( evt, data, conversionApi ) => {
-			for ( const childNode of data.viewItem.getChildren() ) {
-				if ( childNode.is( 'element', 'table' ) ) {
-					conversionApi.consumable.consume( data.viewItem, { name: true } );
-					return;
-				}
-			}
-		} );
-	};
-}

package/src/schemadefinitions.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * @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
  */
 
@@ -46,23 +46,10 @@
 //
 // Skipped hidden elements:
 // noscript
-// script
 
 export default {
 	block: [
 		// Existing features
-		{
-			model: 'heading1',
-			view: 'h2'
-		},
-		{
-			model: 'heading2',
-			view: 'h3'
-		},
-		{
-			model: 'heading3',
-			view: 'h4'
-		},
 		{
 			model: 'codeBlock',
 			view: 'pre'
@@ -111,6 +98,14 @@ export default {
 			model: 'caption',
 			view: 'figcaption'
 		},
+		{
+			model: 'imageBlock',
+			view: 'img'
+		},
+		{
+			model: 'imageInline',
+			view: 'img'
+		},
 
 		// Compatibility features
 		{
@@ -256,7 +251,7 @@ export default {
 			}
 		},
 		{
-			model: 'htmlSumary',
+			model: 'htmlSummary',
 			view: 'summary',
 			modelSchema: {
 				allowChildren: '$text',
@@ -318,15 +313,12 @@ export default {
 			view: 'hgroup',
 			modelSchema: {
 				allowChildren: [
-					'htmlHeading1',
-					'htmlHeading2',
-					'htmlHeading3',
-					'htmlHeading4',
-					'htmlHeading5',
-					'htmlHeading6',
-					'heading1',
-					'heading2',
-					'heading3'
+					'htmlH1',
+					'htmlH2',
+					'htmlH3',
+					'htmlH4',
+					'htmlH5',
+					'htmlH6'
 				],
 				isBlock: true
 			}
@@ -633,7 +625,7 @@ export default {
 				copyOnEnter: true
 			}
 		},
-		// TODO According to HTML-spec can behave as div-like element, althouth CKE4 only handles it as an inline element.
+		// TODO According to HTML-spec can behave as div-like element, although CKE4 only handles it as an inline element.
 		{
 			model: 'htmlDel',
 			view: 'del',
@@ -641,7 +633,7 @@ export default {
 				copyOnEnter: true
 			}
 		},
-		// TODO According to HTML-spec can behave as div-like element, althouth CKE4 only handles it as an inline element.
+		// TODO According to HTML-spec can behave as div-like element, although CKE4 only handles it as an inline element.
 		{
 			model: 'htmlIns',
 			view: 'ins',
@@ -839,6 +831,14 @@ export default {
 			modelSchema: {
 				inheritAllFrom: '$htmlObjectInline'
 			}
+		},
+		{
+			model: 'htmlScript',
+			view: 'script',
+			modelSchema: {
+				allowWhere: [ '$text', '$block' ],
+				isInline: true
+			}
 		}
 	]
 };

package/CHANGELOG.md

@@ -1,4 +0,0 @@
-Changelog
-=========
-
-All changes in the package are documented in the main repository. See: https://github.com/ckeditor/ckeditor5/blob/master/CHANGELOG.md.