@ckeditor/ckeditor5-html-support 40.0.0 → 40.1.0

package/src/htmlpagedataprocessor.js

@@ -1,67 +1,67 @@
-/**
- * @license Copyright (c) 2003-2023, 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/htmlpagedataprocessor
- */
-import { HtmlDataProcessor, UpcastWriter } from 'ckeditor5/src/engine';
-/**
- * The full page HTML data processor class.
- * This data processor implementation uses HTML as input and output data.
- */
-export default class HtmlPageDataProcessor extends HtmlDataProcessor {
-    /**
-     * @inheritDoc
-     */
-    toView(data) {
-        // Ignore content that is not a full page source.
-        if (!data.match(/<(?:html|body|head|meta)(?:\s[^>]*)?>/i)) {
-            return super.toView(data);
-        }
-        // Store doctype and xml declaration in a separate properties as they can't be stringified later.
-        let docType = '';
-        let xmlDeclaration = '';
-        data = data.replace(/<!DOCTYPE[^>]*>/i, match => {
-            docType = match;
-            return '';
-        });
-        data = data.replace(/<\?xml\s[^?]*\?>/i, match => {
-            xmlDeclaration = match;
-            return '';
-        });
-        // Convert input HTML data to DOM DocumentFragment.
-        const domFragment = this._toDom(data);
-        // Convert DOM DocumentFragment to view DocumentFragment.
-        const viewFragment = this.domConverter.domToView(domFragment, { skipComments: this.skipComments });
-        const writer = new UpcastWriter(viewFragment.document);
-        // Using the DOM document with body content extracted as a skeleton of the page.
-        writer.setCustomProperty('$fullPageDocument', domFragment.ownerDocument.documentElement.outerHTML, viewFragment);
-        if (docType) {
-            writer.setCustomProperty('$fullPageDocType', docType, viewFragment);
-        }
-        if (xmlDeclaration) {
-            writer.setCustomProperty('$fullPageXmlDeclaration', xmlDeclaration, viewFragment);
-        }
-        return viewFragment;
-    }
-    /**
-     * @inheritDoc
-     */
-    toData(viewFragment) {
-        let data = super.toData(viewFragment);
-        const page = viewFragment.getCustomProperty('$fullPageDocument');
-        const docType = viewFragment.getCustomProperty('$fullPageDocType');
-        const xmlDeclaration = viewFragment.getCustomProperty('$fullPageXmlDeclaration');
-        if (page) {
-            data = page.replace(/<\/body\s*>/, data + '$&');
-            if (docType) {
-                data = docType + '\n' + data;
-            }
-            if (xmlDeclaration) {
-                data = xmlDeclaration + '\n' + data;
-            }
-        }
-        return data;
-    }
-}
+/**
+ * @license Copyright (c) 2003-2023, 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/htmlpagedataprocessor
+ */
+import { HtmlDataProcessor, UpcastWriter } from 'ckeditor5/src/engine';
+/**
+ * The full page HTML data processor class.
+ * This data processor implementation uses HTML as input and output data.
+ */
+export default class HtmlPageDataProcessor extends HtmlDataProcessor {
+    /**
+     * @inheritDoc
+     */
+    toView(data) {
+        // Ignore content that is not a full page source.
+        if (!data.match(/<(?:html|body|head|meta)(?:\s[^>]*)?>/i)) {
+            return super.toView(data);
+        }
+        // Store doctype and xml declaration in a separate properties as they can't be stringified later.
+        let docType = '';
+        let xmlDeclaration = '';
+        data = data.replace(/<!DOCTYPE[^>]*>/i, match => {
+            docType = match;
+            return '';
+        });
+        data = data.replace(/<\?xml\s[^?]*\?>/i, match => {
+            xmlDeclaration = match;
+            return '';
+        });
+        // Convert input HTML data to DOM DocumentFragment.
+        const domFragment = this._toDom(data);
+        // Convert DOM DocumentFragment to view DocumentFragment.
+        const viewFragment = this.domConverter.domToView(domFragment, { skipComments: this.skipComments });
+        const writer = new UpcastWriter(viewFragment.document);
+        // Using the DOM document with body content extracted as a skeleton of the page.
+        writer.setCustomProperty('$fullPageDocument', domFragment.ownerDocument.documentElement.outerHTML, viewFragment);
+        if (docType) {
+            writer.setCustomProperty('$fullPageDocType', docType, viewFragment);
+        }
+        if (xmlDeclaration) {
+            writer.setCustomProperty('$fullPageXmlDeclaration', xmlDeclaration, viewFragment);
+        }
+        return viewFragment;
+    }
+    /**
+     * @inheritDoc
+     */
+    toData(viewFragment) {
+        let data = super.toData(viewFragment);
+        const page = viewFragment.getCustomProperty('$fullPageDocument');
+        const docType = viewFragment.getCustomProperty('$fullPageDocType');
+        const xmlDeclaration = viewFragment.getCustomProperty('$fullPageXmlDeclaration');
+        if (page) {
+            data = page.replace(/<\/body\s*>/, data + '$&');
+            if (docType) {
+                data = docType + '\n' + data;
+            }
+            if (xmlDeclaration) {
+                data = xmlDeclaration + '\n' + data;
+            }
+        }
+        return data;
+    }
+}

package/src/index.d.ts

@@ -1,25 +1,25 @@
-/**
- * @license Copyright (c) 2003-2023, 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
- */
-export { default as GeneralHtmlSupport } from './generalhtmlsupport';
-export { default as DataFilter } from './datafilter';
-export { default as DataSchema, type DataSchemaBlockElementDefinition } from './dataschema';
-export { default as HtmlComment } from './htmlcomment';
-export { default as FullPage } from './fullpage';
-export { default as HtmlPageDataProcessor } from './htmlpagedataprocessor';
-export type { GeneralHtmlSupportConfig } from './generalhtmlsupportconfig';
-export type { default as CodeBlockElementSupport } from './integrations/codeblock';
-export type { default as CustomElementSupport } from './integrations/customelement';
-export type { default as DocumentListElementSupport } from './integrations/documentlist';
-export type { default as DualContentModelElementSupport } from './integrations/dualcontent';
-export type { default as HeadingElementSupport } from './integrations/heading';
-export type { default as ImageElementSupport } from './integrations/image';
-export type { default as MediaEmbedElementSupport } from './integrations/mediaembed';
-export type { default as ScriptElementSupport } from './integrations/script';
-export type { default as StyleElementSupport } from './integrations/style';
-export type { default as TableElementSupport } from './integrations/table';
-import './augmentation';
+/**
+ * @license Copyright (c) 2003-2023, 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
+ */
+export { default as GeneralHtmlSupport } from './generalhtmlsupport';
+export { default as DataFilter } from './datafilter';
+export { default as DataSchema, type DataSchemaBlockElementDefinition } from './dataschema';
+export { default as HtmlComment } from './htmlcomment';
+export { default as FullPage } from './fullpage';
+export { default as HtmlPageDataProcessor } from './htmlpagedataprocessor';
+export type { GeneralHtmlSupportConfig } from './generalhtmlsupportconfig';
+export type { default as CodeBlockElementSupport } from './integrations/codeblock';
+export type { default as CustomElementSupport } from './integrations/customelement';
+export type { default as DocumentListElementSupport } from './integrations/documentlist';
+export type { default as DualContentModelElementSupport } from './integrations/dualcontent';
+export type { default as HeadingElementSupport } from './integrations/heading';
+export type { default as ImageElementSupport } from './integrations/image';
+export type { default as MediaEmbedElementSupport } from './integrations/mediaembed';
+export type { default as ScriptElementSupport } from './integrations/script';
+export type { default as StyleElementSupport } from './integrations/style';
+export type { default as TableElementSupport } from './integrations/table';
+import './augmentation';

package/src/index.js

@@ -1,14 +1,14 @@
-/**
- * @license Copyright (c) 2003-2023, 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
- */
-export { default as GeneralHtmlSupport } from './generalhtmlsupport';
-export { default as DataFilter } from './datafilter';
-export { default as DataSchema } from './dataschema';
-export { default as HtmlComment } from './htmlcomment';
-export { default as FullPage } from './fullpage';
-export { default as HtmlPageDataProcessor } from './htmlpagedataprocessor';
-import './augmentation';
+/**
+ * @license Copyright (c) 2003-2023, 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
+ */
+export { default as GeneralHtmlSupport } from './generalhtmlsupport';
+export { default as DataFilter } from './datafilter';
+export { default as DataSchema } from './dataschema';
+export { default as HtmlComment } from './htmlcomment';
+export { default as FullPage } from './fullpage';
+export { default as HtmlPageDataProcessor } from './htmlpagedataprocessor';
+import './augmentation';

package/src/integrations/codeblock.d.ts

@@ -1,23 +1,23 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-import { Plugin } from 'ckeditor5/src/core';
-import DataFilter from '../datafilter';
-/**
- * Provides the General HTML Support integration with {@link module:code-block/codeblock~CodeBlock Code Block} feature.
- */
-export default class CodeBlockElementSupport extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof DataFilter];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "CodeBlockElementSupport";
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import DataFilter from '../datafilter';
+/**
+ * Provides the General HTML Support integration with {@link module:code-block/codeblock~CodeBlock Code Block} feature.
+ */
+export default class CodeBlockElementSupport extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof DataFilter];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "CodeBlockElementSupport";
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}

package/src/integrations/codeblock.js

@@ -1,101 +1,101 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-import { Plugin } from 'ckeditor5/src/core';
-import { updateViewAttributes } from '../utils';
-import DataFilter from '../datafilter';
-/**
- * Provides the General HTML Support integration with {@link module:code-block/codeblock~CodeBlock Code Block} feature.
- */
-export default class CodeBlockElementSupport extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [DataFilter];
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'CodeBlockElementSupport';
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        if (!this.editor.plugins.has('CodeBlockEditing')) {
-            return;
-        }
-        const dataFilter = this.editor.plugins.get(DataFilter);
-        dataFilter.on('register:pre', (evt, definition) => {
-            if (definition.model !== 'codeBlock') {
-                return;
-            }
-            const editor = this.editor;
-            const schema = editor.model.schema;
-            const conversion = editor.conversion;
-            // Extend codeBlock to allow attributes required by attribute filtration.
-            schema.extend('codeBlock', {
-                allowAttributes: ['htmlPreAttributes', 'htmlContentAttributes']
-            });
-            conversion.for('upcast').add(viewToModelCodeBlockAttributeConverter(dataFilter));
-            conversion.for('downcast').add(modelToViewCodeBlockAttributeConverter());
-            evt.stop();
-        });
-    }
-}
-/**
- * View-to-model conversion helper preserving allowed attributes on {@link module:code-block/codeblock~CodeBlock Code Block}
- * feature model element.
- *
- * Attributes are preserved as a value of `html*Attributes` model attribute.
- * @param dataFilter
- * @returns Returns a conversion callback.
- */
-function viewToModelCodeBlockAttributeConverter(dataFilter) {
-    return (dispatcher) => {
-        dispatcher.on('element:code', (evt, data, conversionApi) => {
-            const viewCodeElement = data.viewItem;
-            const viewPreElement = viewCodeElement.parent;
-            if (!viewPreElement || !viewPreElement.is('element', 'pre')) {
-                return;
-            }
-            preserveElementAttributes(viewPreElement, 'htmlPreAttributes');
-            preserveElementAttributes(viewCodeElement, 'htmlContentAttributes');
-            function preserveElementAttributes(viewElement, attributeName) {
-                const viewAttributes = dataFilter.processViewAttributes(viewElement, conversionApi);
-                if (viewAttributes) {
-                    conversionApi.writer.setAttribute(attributeName, viewAttributes, data.modelRange);
-                }
-            }
-        }, { priority: 'low' });
-    };
-}
-/**
- * Model-to-view conversion helper applying attributes from {@link module:code-block/codeblock~CodeBlock Code Block}
- * feature model element.
- * @returns Returns a conversion callback.
- */
-function modelToViewCodeBlockAttributeConverter() {
-    return (dispatcher) => {
-        dispatcher.on('attribute:htmlPreAttributes:codeBlock', (evt, data, conversionApi) => {
-            if (!conversionApi.consumable.consume(data.item, evt.name)) {
-                return;
-            }
-            const { attributeOldValue, attributeNewValue } = data;
-            const viewCodeElement = conversionApi.mapper.toViewElement(data.item);
-            const viewPreElement = viewCodeElement.parent;
-            updateViewAttributes(conversionApi.writer, attributeOldValue, attributeNewValue, viewPreElement);
-        });
-        dispatcher.on('attribute:htmlContentAttributes:codeBlock', (evt, data, conversionApi) => {
-            if (!conversionApi.consumable.consume(data.item, evt.name)) {
-                return;
-            }
-            const { attributeOldValue, attributeNewValue } = data;
-            const viewCodeElement = conversionApi.mapper.toViewElement(data.item);
-            updateViewAttributes(conversionApi.writer, attributeOldValue, attributeNewValue, viewCodeElement);
-        });
-    };
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import { updateViewAttributes } from '../utils';
+import DataFilter from '../datafilter';
+/**
+ * Provides the General HTML Support integration with {@link module:code-block/codeblock~CodeBlock Code Block} feature.
+ */
+export default class CodeBlockElementSupport extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [DataFilter];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'CodeBlockElementSupport';
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        if (!this.editor.plugins.has('CodeBlockEditing')) {
+            return;
+        }
+        const dataFilter = this.editor.plugins.get(DataFilter);
+        dataFilter.on('register:pre', (evt, definition) => {
+            if (definition.model !== 'codeBlock') {
+                return;
+            }
+            const editor = this.editor;
+            const schema = editor.model.schema;
+            const conversion = editor.conversion;
+            // Extend codeBlock to allow attributes required by attribute filtration.
+            schema.extend('codeBlock', {
+                allowAttributes: ['htmlPreAttributes', 'htmlContentAttributes']
+            });
+            conversion.for('upcast').add(viewToModelCodeBlockAttributeConverter(dataFilter));
+            conversion.for('downcast').add(modelToViewCodeBlockAttributeConverter());
+            evt.stop();
+        });
+    }
+}
+/**
+ * View-to-model conversion helper preserving allowed attributes on {@link module:code-block/codeblock~CodeBlock Code Block}
+ * feature model element.
+ *
+ * Attributes are preserved as a value of `html*Attributes` model attribute.
+ * @param dataFilter
+ * @returns Returns a conversion callback.
+ */
+function viewToModelCodeBlockAttributeConverter(dataFilter) {
+    return (dispatcher) => {
+        dispatcher.on('element:code', (evt, data, conversionApi) => {
+            const viewCodeElement = data.viewItem;
+            const viewPreElement = viewCodeElement.parent;
+            if (!viewPreElement || !viewPreElement.is('element', 'pre')) {
+                return;
+            }
+            preserveElementAttributes(viewPreElement, 'htmlPreAttributes');
+            preserveElementAttributes(viewCodeElement, 'htmlContentAttributes');
+            function preserveElementAttributes(viewElement, attributeName) {
+                const viewAttributes = dataFilter.processViewAttributes(viewElement, conversionApi);
+                if (viewAttributes) {
+                    conversionApi.writer.setAttribute(attributeName, viewAttributes, data.modelRange);
+                }
+            }
+        }, { priority: 'low' });
+    };
+}
+/**
+ * Model-to-view conversion helper applying attributes from {@link module:code-block/codeblock~CodeBlock Code Block}
+ * feature model element.
+ * @returns Returns a conversion callback.
+ */
+function modelToViewCodeBlockAttributeConverter() {
+    return (dispatcher) => {
+        dispatcher.on('attribute:htmlPreAttributes:codeBlock', (evt, data, conversionApi) => {
+            if (!conversionApi.consumable.consume(data.item, evt.name)) {
+                return;
+            }
+            const { attributeOldValue, attributeNewValue } = data;
+            const viewCodeElement = conversionApi.mapper.toViewElement(data.item);
+            const viewPreElement = viewCodeElement.parent;
+            updateViewAttributes(conversionApi.writer, attributeOldValue, attributeNewValue, viewPreElement);
+        });
+        dispatcher.on('attribute:htmlContentAttributes:codeBlock', (evt, data, conversionApi) => {
+            if (!conversionApi.consumable.consume(data.item, evt.name)) {
+                return;
+            }
+            const { attributeOldValue, attributeNewValue } = data;
+            const viewCodeElement = conversionApi.mapper.toViewElement(data.item);
+            updateViewAttributes(conversionApi.writer, attributeOldValue, attributeNewValue, viewCodeElement);
+        });
+    };
+}

package/src/integrations/customelement.d.ts

@@ -1,27 +1,27 @@
-/**
- * @license Copyright (c) 2003-2023, 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/customelement
- */
-import { Plugin } from 'ckeditor5/src/core';
-import DataSchema from '../dataschema';
-import DataFilter from '../datafilter';
-/**
- * Provides the General HTML Support for custom elements (not registered in the {@link module:html-support/dataschema~DataSchema}).
- */
-export default class CustomElementSupport extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof DataFilter, typeof DataSchema];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "CustomElementSupport";
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-}
+/**
+ * @license Copyright (c) 2003-2023, 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/customelement
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import DataSchema from '../dataschema';
+import DataFilter from '../datafilter';
+/**
+ * Provides the General HTML Support for custom elements (not registered in the {@link module:html-support/dataschema~DataSchema}).
+ */
+export default class CustomElementSupport extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof DataFilter, typeof DataSchema];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "CustomElementSupport";
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}