@ckeditor/ckeditor5-html-support 45.2.1 → 46.0.0-alpha.1

package/dist/index.js

@@ -4,9 +4,9 @@
  */
 import { Plugin } from '@ckeditor/ckeditor5-core/dist/index.js';
 import { toArray, priorities, CKEditorError, isValidAttributeName, uid, logWarning, global } from '@ckeditor/ckeditor5-utils/dist/index.js';
-import { Matcher, StylesMap, UpcastWriter, HtmlDataProcessor } from '@ckeditor/ckeditor5-engine/dist/index.js';
+import { Matcher, StylesMap, ViewUpcastWriter, HtmlDataProcessor } from '@ckeditor/ckeditor5-engine/dist/index.js';
 import { toWidget, Widget } from '@ckeditor/ckeditor5-widget/dist/index.js';
-import { startCase, cloneDeep, mergeWith, isPlainObject, isEqual } from 'es-toolkit/compat';
+import { cloneDeep, startCase, mergeWith, isPlainObject, isEqual } from 'es-toolkit/compat';
 import { Enter } from '@ckeditor/ckeditor5-enter/dist/index.js';
 
 /**
@@ -16,6 +16,7 @@ import { Enter } from '@ckeditor/ckeditor5-enter/dist/index.js';
 * @param oldViewAttributes The previous GHS attribute value.
 * @param newViewAttributes The current GHS attribute value.
 * @param viewElement The view element to update.
+* @internal
 */ function updateViewAttributes(writer, oldViewAttributes, newViewAttributes, viewElement) {
     if (oldViewAttributes) {
         removeViewAttributes(writer, oldViewAttributes, viewElement);
@@ -30,6 +31,7 @@ import { Enter } from '@ckeditor/ckeditor5-enter/dist/index.js';
  * @param writer The view writer.
  * @param viewAttributes The GHS attribute value.
  * @param viewElement The view element to update.
+ * @internal
  */ function setViewAttributes(writer, viewAttributes, viewElement) {
     if (viewAttributes.attributes) {
         for (const [key, value] of Object.entries(viewAttributes.attributes)){
@@ -49,6 +51,7 @@ import { Enter } from '@ckeditor/ckeditor5-enter/dist/index.js';
  * @param writer The view writer.
  * @param viewAttributes The GHS attribute value.
  * @param viewElement The view element to update.
+ * @internal
  */ function removeViewAttributes(writer, viewAttributes, viewElement) {
     if (viewAttributes.attributes) {
         for (const [key] of Object.entries(viewAttributes.attributes)){
@@ -66,6 +69,8 @@ import { Enter } from '@ckeditor/ckeditor5-enter/dist/index.js';
 }
 /**
 * Merges view element attribute objects.
+*
+* @internal
 */ function mergeViewElementAttributes(target, source) {
     const result = cloneDeep(target);
     let key = 'attributes';
@@ -129,16 +134,43 @@ function modifyGhsAttribute(writer, item, ghsAttributeName, subject, callback) {
         }
     }
 }
+/**
+ * Strips the `styles`, and `classes` keys from the GHS attribute value on the given item.
+ *
+ * @internal
+ */ function removeFormatting(ghsAttributeName, itemRange, writer) {
+    for (const item of itemRange.getItems({
+        shallow: true
+    })){
+        const value = item.getAttribute(ghsAttributeName);
+        // Copy only attributes to the new attribute value.
+        if (value && value.attributes && Object.keys(value.attributes).length) {
+            // But reset the GHS attribute only when there is anything more than just attributes.
+            if (Object.keys(value).length > 1) {
+                writer.setAttribute(ghsAttributeName, {
+                    attributes: value.attributes
+                }, item);
+            }
+        } else {
+            // There are no attributes, so remove the GHS attribute completely.
+            writer.removeAttribute(ghsAttributeName, item);
+        }
+    }
+}
 /**
  * Transforms passed string to PascalCase format. Examples:
  * * `div` => `Div`
  * * `h1` => `H1`
  * * `table` => `Table`
+ *
+ * @internal
  */ function toPascalCase(data) {
     return startCase(data).replace(/ /g, '');
 }
 /**
  * Returns the attribute name of the model element that holds raw HTML attributes.
+ *
+ * @internal
  */ function getHtmlAttributeName(viewElementName) {
     return `html${toPascalCase(viewElementName)}Attributes`;
 }
@@ -149,6 +181,7 @@ function modifyGhsAttribute(writer, item, ghsAttributeName, subject, callback) {
  * Preserves object element content in `htmlContent` attribute.
  *
  * @returns Returns a conversion callback.
+ * @internal
 */ function viewToModelObjectConverter({ model: modelName }) {
     return (viewElement, conversionApi)=>{
         // Let's keep element HTML and its attributes, so we can rebuild element in downcast conversions.
@@ -161,6 +194,7 @@ function modifyGhsAttribute(writer, item, ghsAttributeName, subject, callback) {
  * Conversion helper converting an object element to an HTML object widget.
  *
  * @returns Returns a conversion callback.
+ * @internal
 */ function toObjectWidgetConverter(editor, { view: viewName, isInline }) {
     const t = editor.t;
     return (modelElement, { writer })=>{
@@ -184,6 +218,8 @@ function modifyGhsAttribute(writer, item, ghsAttributeName, subject, callback) {
 }
 /**
 * Creates object view element from the given model element.
+*
+* @internal
 */ function createObjectView(viewName, modelElement, writer) {
     return writer.createRawElement(viewName, null, (domElement, domConverter)=>{
         domConverter.setContentOf(domElement, modelElement.getAttribute('htmlContent'));
@@ -193,6 +229,7 @@ function modifyGhsAttribute(writer, item, ghsAttributeName, subject, callback) {
  * View-to-attribute conversion helper preserving inline element attributes on `$text`.
  *
  * @returns Returns a conversion callback.
+ * @internal
 */ function viewToAttributeInlineConverter({ view: viewName, model: attributeKey, allowEmpty }, dataFilter) {
     return (dispatcher)=>{
         dispatcher.on(`element:${viewName}`, (evt, data, conversionApi)=>{
@@ -247,6 +284,8 @@ function modifyGhsAttribute(writer, item, ghsAttributeName, subject, callback) {
 }
 /**
  * Conversion helper converting an empty inline model element to an HTML element or widget.
+ *
+ * @internal
  */ function emptyInlineModelElementToViewConverter({ model: attributeKey, view: viewName }, asWidget) {
     return (item, { writer, consumable })=>{
         if (!item.hasAttribute(attributeKey)) {
@@ -264,6 +303,7 @@ function modifyGhsAttribute(writer, item, ghsAttributeName, subject, callback) {
  * Attribute-to-view conversion helper applying attributes to view element preserved on `$text`.
  *
  * @returns Returns a conversion callback.
+ * @internal
 */ function attributeToViewInlineConverter({ priority, view: viewName }) {
     return (attributeValue, conversionApi)=>{
         if (!attributeValue) {
@@ -283,6 +323,7 @@ function modifyGhsAttribute(writer, item, ghsAttributeName, subject, callback) {
  * All matched attributes will be preserved on `html*Attributes` attribute.
  *
  * @returns Returns a conversion callback.
+ * @internal
 */ function viewToModelBlockAttributeConverter({ view: viewName }, dataFilter) {
     return (dispatcher)=>{
         dispatcher.on(`element:${viewName}`, (evt, data, conversionApi)=>{
@@ -308,6 +349,7 @@ function modifyGhsAttribute(writer, item, ghsAttributeName, subject, callback) {
  * for block elements.
  *
  * @returns Returns a conversion callback.
+ * @internal
 */ function modelToViewBlockAttributeConverter({ view: viewName, model: modelName }) {
     return (dispatcher)=>{
         dispatcher.on(`attribute:${getHtmlAttributeName(viewName)}:${modelName}`, (evt, data, conversionApi)=>{
@@ -327,48 +369,51 @@ function modifyGhsAttribute(writer, item, ghsAttributeName, subject, callback) {
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
  */ /**
  * @module html-support/schemadefinitions
- */ // Skipped elements due to HTML deprecation:
-// * noframes (not sure if we should provide support for this element. CKE4 is not supporting frameset and frame,
-//   but it will unpack <frameset><noframes>foobar</noframes></frameset> to <noframes>foobar</noframes>, so there
-//   may be some content loss. Although using noframes as a standalone element seems invalid)
-// * keygen (this one is also empty)
-// * applet (support is limited mostly to old IE)
-// * basefont (this one is also empty)
-// * isindex (basically no support for modern browsers at all)
-//
-// Skipped elements due to lack empty element support:
-// * hr
-// * area
-// * br
-// * command
-// * map
-// * wbr
-// * colgroup -> col
-//
-// Skipped elements due to complexity:
-// * datalist with option elements used as a data source for input[list] element
-//
-// Skipped elements as they are handled as an object content:
-// * track
-// * source
-// * option
-// * param
-// * optgroup
-//
-// Skipped full page HTML elements:
-// * body
-// * html
-// * title
-// * head
-// * meta
-// * link
-// * etc...
-//
-// Skipped hidden elements:
-// noscript
-//
-// When adding elements to this list, update the feature guide listing, too.
-var defaultConfig = {
+ */ /**
+ * Skipped elements due to HTML deprecation:
+ * * noframes (not sure if we should provide support for this element. CKE4 is not supporting frameset and frame,
+ *   but it will unpack <frameset><noframes>foobar</noframes></frameset> to <noframes>foobar</noframes>, so there
+ *   may be some content loss. Although using noframes as a standalone element seems invalid)
+ * * keygen (this one is also empty)
+ * * applet (support is limited mostly to old IE)
+ * * basefont (this one is also empty)
+ * * isindex (basically no support for modern browsers at all)
+ *
+ * Skipped elements due to lack empty element support:
+ * * hr
+ * * area
+ * * br
+ * * command
+ * * map
+ * * wbr
+ * * colgroup -> col
+ *
+ * Skipped elements due to complexity:
+ * * datalist with option elements used as a data source for input[list] element
+ *
+ * Skipped elements as they are handled as an object content:
+ * * track
+ * * source
+ * * option
+ * * param
+ * * optgroup
+ *
+ * Skipped full page HTML elements:
+ * * body
+ * * html
+ * * title
+ * * head
+ * * meta
+ * * link
+ * * etc...
+ *
+ * Skipped hidden elements:
+ * noscript
+ *
+ * When adding elements to this list, update the feature guide listing, too.
+ *
+ * @internal
+ */ const defaultConfig = {
     block: [
         // Existing features.
         {
@@ -1029,7 +1074,10 @@ var defaultConfig = {
             model: 'htmlA',
             view: 'a',
             priority: 5,
-            coupledAttribute: 'linkHref'
+            coupledAttribute: 'linkHref',
+            attributeProperties: {
+                isFormatting: true
+            }
         },
         {
             model: 'htmlStrong',
@@ -2075,7 +2123,7 @@ var defaultConfig = {
         const schema = editor.model.schema;
         const conversion = editor.conversion;
         const attributeKey = definition.model;
-        // This element is stored in the model as an attribute on a block element, for example DocumentLists.
+        // This element is stored in the model as an attribute on a block element, for example Lists.
         if (definition.appliesToBlock) {
             return;
         }
@@ -2431,9 +2479,10 @@ var defaultConfig = {
  * * model element HTML is semantically correct and easier to work with.
  *
  * If element contains any block element, it will be treated as a sectioning element and registered using
- * {@link module:html-support/dataschema~DataSchemaDefinition#model} and
- * {@link module:html-support/dataschema~DataSchemaDefinition#modelSchema} in editor schema.
- * Otherwise, it will be registered under {@link module:html-support/dataschema~DataSchemaBlockElementDefinition#paragraphLikeModel} model
+ * {@link module:html-support/dataschema~HtmlSupportDataSchemaDefinition#model} and
+ * {@link module:html-support/dataschema~HtmlSupportDataSchemaDefinition#modelSchema} in editor schema.
+ * Otherwise, it will be registered under
+ * {@link module:html-support/dataschema~HtmlSupportDataSchemaBlockElementDefinition#paragraphLikeModel} model
  * name with model schema accepting only inline content (inheriting from `$block`).
  */ class DualContentModelElementSupport extends Plugin {
     /**
@@ -3567,8 +3616,9 @@ const STYLE_ATTRIBUTES_TO_PROPAGATE = [
                     if (viewElement.is('element', 'template') && viewElement.getCustomProperty('$rawContent')) {
                         htmlContent = viewElement.getCustomProperty('$rawContent');
                     } else {
-                        // Store the whole element in the attribute so that DomConverter will be able to use the pre like element context.
-                        const viewWriter = new UpcastWriter(viewElement.document);
+                        // Store the whole element in the attribute so that ViewDomConverter
+                        // will be able to use the pre like element context.
+                        const viewWriter = new ViewUpcastWriter(viewElement.document);
                         const documentFragment = viewWriter.createDocumentFragment(viewElement);
                         const domFragment = editor.data.htmlProcessor.domConverter.viewToDom(documentFragment);
                         const domElement = domFragment.firstChild;
@@ -3690,6 +3740,12 @@ const STYLE_ATTRIBUTES_TO_PROPAGATE = [
         dataFilter.loadAllowedConfig(editor.config.get('htmlSupport.allow') || []);
         dataFilter.loadDisallowedConfig(editor.config.get('htmlSupport.disallow') || []);
     }
+    /**
+	 * @inheritDoc
+	 */ afterInit() {
+        const removeFormatCommand = this.editor.commands.get('removeFormat');
+        removeFormatCommand?.registerCustomAttribute((attributeName)=>attributeName.startsWith('html') && attributeName.endsWith('Attributes'), removeFormatting);
+    }
     /**
 	 * Returns a GHS model attribute name related to a given view element name.
 	 *
@@ -4095,7 +4151,7 @@ const STYLE_ATTRIBUTES_TO_PROPAGATE = [
         const viewFragment = this.domConverter.domToView(domFragment, {
             skipComments: this.skipComments
         });
-        const writer = new UpcastWriter(viewFragment.document);
+        const writer = new ViewUpcastWriter(viewFragment.document);
         // Using the DOM document with body content extracted as a skeleton of the page.
         writer.setCustomProperty('$fullPageDocument', domFragment.ownerDocument.documentElement.outerHTML, viewFragment);
         // List of `<style>` elements extracted from document's `<head>` element.
@@ -4206,7 +4262,7 @@ const STYLE_ATTRIBUTES_TO_PROPAGATE = [
             if (!root.hasAttribute('$fullPageDocument')) {
                 return;
             }
-            const writer = new UpcastWriter(viewFragment.document);
+            const writer = new ViewUpcastWriter(viewFragment.document);
             for (const name of properties){
                 const value = root.getAttribute(name);
                 if (value) {
@@ -4439,5 +4495,5 @@ const EMPTY_BLOCK_MODEL_ATTRIBUTE = 'htmlEmptyBlock';
     };
 }
 
-export { DataFilter, DataSchema, EmptyBlock, FullPage, GeneralHtmlSupport, HtmlComment, HtmlPageDataProcessor };
+export { DataFilter, DataSchema, EmptyBlock, FullPage, GeneralHtmlSupport, HtmlComment, HtmlPageDataProcessor, defaultConfig as _HTML_SUPPORT_SCHEMA_DEFINITIONS, attributeToViewInlineConverter as _attributeToInlineHtmlSupportConverter, createObjectView as _createObjectHtmlSupportView, emptyInlineModelElementToViewConverter as _emptyInlineModelElementToViewHtmlSupportConverter, getHtmlAttributeName as _getHtmlSupportAttributeName, getDescendantElement as _getHtmlSupportDescendantElement, mergeViewElementAttributes as _mergeHtmlSupportViewElementAttributes, modelToViewBlockAttributeConverter as _modelToViewBlockAttributeHtmlSupportConverter, modifyGhsAttribute as _modifyHtmlSupportGhsAttribute, removeViewAttributes as _removeHtmlSupportViewAttributes, setViewAttributes as _setHtmlSupportViewAttributes, toPascalCase as _toHtmlSupportPascalCase, toObjectWidgetConverter as _toObjectWidgetHtmlSupportConverter, updateViewAttributes as _updateHtmlSupportViewAttributes, viewToAttributeInlineConverter as _viewToAttributeInlineHtmlSupportConverter, viewToModelBlockAttributeConverter as _viewToModelBlockAttributeHtmlSupportConverter, viewToModelObjectConverter as _viewToModelObjectContentHtmlSupportConverter };
 //# sourceMappingURL=index.js.map