@ckeditor/ckeditor5-html-embed 40.0.0 → 40.1.0

package/LICENSE.md

@@ -2,7 +2,7 @@ Software License Agreement
 ==========================
 
 **CKEditor&nbsp;5 HTML embed feature**  – https://github.com/ckeditor/ckeditor5-html-embed <br>
-Copyright (c) 2003-2023, [CKSource Holding sp. z o.o.](https://cksource.com) All rights reserved.
+Copyright (c) 2003–2023, [CKSource Holding sp. z o.o.](https://cksource.com) All rights reserved.
 
 Licensed under the terms of [GNU General Public License Version 2 or later](http://www.gnu.org/licenses/gpl.html).
 
@@ -14,4 +14,4 @@ Where not otherwise indicated, all CKEditor content is authored by CKSource engi
 Trademarks
 ----------
 
-**CKEditor** is a trademark of [CKSource Holding sp. z o.o.](https://cksource.com) All other brand and product names are trademarks, registered trademarks or service marks of their respective holders.
+**CKEditor** is a trademark of [CKSource Holding sp. z o.o.](https://cksource.com) All other brand and product names are trademarks, registered trademarks, or service marks of their respective holders.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-html-embed",
-  "version": "40.0.0",
+  "version": "40.1.0",
   "description": "HTML embed feature for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -12,7 +12,7 @@
   ],
   "main": "src/index.js",
   "dependencies": {
-    "ckeditor5": "40.0.0"
+    "ckeditor5": "40.1.0"
   },
   "author": "CKSource (http://cksource.com/)",
   "license": "GPL-2.0-or-later",

package/src/augmentation.d.ts

@@ -1,24 +1,24 @@
-/**
- * @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 type { HtmlEmbed, HtmlEmbedCommand, HtmlEmbedConfig, HtmlEmbedEditing, HtmlEmbedUI } from './index';
-declare module '@ckeditor/ckeditor5-core' {
-    interface EditorConfig {
-        /**
-         * The configuration of the HTML embed feature. Introduced by the {@link module:html-embed/htmlembedediting~HtmlEmbedEditing}
-         * feature.
-         *
-         * Read more in {@link module:core/editor/editorconfig~EditorConfig all editor options}.
-         */
-        htmlEmbed?: HtmlEmbedConfig;
-    }
-    interface PluginsMap {
-        [HtmlEmbed.pluginName]: HtmlEmbed;
-        [HtmlEmbedEditing.pluginName]: HtmlEmbedEditing;
-        [HtmlEmbedUI.pluginName]: HtmlEmbedUI;
-    }
-    interface CommandsMap {
-        htmlEmbed: HtmlEmbedCommand;
-    }
-}
+/**
+ * @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 type { HtmlEmbed, HtmlEmbedCommand, HtmlEmbedConfig, HtmlEmbedEditing, HtmlEmbedUI } from './index';
+declare module '@ckeditor/ckeditor5-core' {
+    interface EditorConfig {
+        /**
+         * The configuration of the HTML embed feature. Introduced by the {@link module:html-embed/htmlembedediting~HtmlEmbedEditing}
+         * feature.
+         *
+         * Read more in {@link module:core/editor/editorconfig~EditorConfig all editor options}.
+         */
+        htmlEmbed?: HtmlEmbedConfig;
+    }
+    interface PluginsMap {
+        [HtmlEmbed.pluginName]: HtmlEmbed;
+        [HtmlEmbedEditing.pluginName]: HtmlEmbedEditing;
+        [HtmlEmbedUI.pluginName]: HtmlEmbedUI;
+    }
+    interface CommandsMap {
+        htmlEmbed: HtmlEmbedCommand;
+    }
+}

package/src/augmentation.js

@@ -1,5 +1,5 @@
-/**
- * @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
- */
-export {};
+/**
+ * @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
+ */
+export {};

package/src/htmlembed.d.ts

@@ -1,28 +1,28 @@
-/**
- * @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-embed/htmlembed
- */
-import { Plugin } from 'ckeditor5/src/core';
-import { Widget } from 'ckeditor5/src/widget';
-import HtmlEmbedEditing from './htmlembedediting';
-import HtmlEmbedUI from './htmlembedui';
-/**
- * The HTML embed feature.
- *
- * It allows inserting HTML snippets directly into the editor.
- *
- * For a detailed overview, check the {@glink features/html/html-embed HTML embed feature} documentation.
- */
-export default class HtmlEmbed extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof HtmlEmbedEditing, typeof HtmlEmbedUI, typeof Widget];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "HtmlEmbed";
-}
+/**
+ * @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-embed/htmlembed
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import { Widget } from 'ckeditor5/src/widget';
+import HtmlEmbedEditing from './htmlembedediting';
+import HtmlEmbedUI from './htmlembedui';
+/**
+ * The HTML embed feature.
+ *
+ * It allows inserting HTML snippets directly into the editor.
+ *
+ * For a detailed overview, check the {@glink features/html/html-embed HTML embed feature} documentation.
+ */
+export default class HtmlEmbed extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof HtmlEmbedEditing, typeof HtmlEmbedUI, typeof Widget];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "HtmlEmbed";
+}

package/src/htmlembed.js

@@ -1,32 +1,32 @@
-/**
- * @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-embed/htmlembed
- */
-import { Plugin } from 'ckeditor5/src/core';
-import { Widget } from 'ckeditor5/src/widget';
-import HtmlEmbedEditing from './htmlembedediting';
-import HtmlEmbedUI from './htmlembedui';
-/**
- * The HTML embed feature.
- *
- * It allows inserting HTML snippets directly into the editor.
- *
- * For a detailed overview, check the {@glink features/html/html-embed HTML embed feature} documentation.
- */
-export default class HtmlEmbed extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [HtmlEmbedEditing, HtmlEmbedUI, Widget];
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'HtmlEmbed';
-    }
-}
+/**
+ * @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-embed/htmlembed
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import { Widget } from 'ckeditor5/src/widget';
+import HtmlEmbedEditing from './htmlembedediting';
+import HtmlEmbedUI from './htmlembedui';
+/**
+ * The HTML embed feature.
+ *
+ * It allows inserting HTML snippets directly into the editor.
+ *
+ * For a detailed overview, check the {@glink features/html/html-embed HTML embed feature} documentation.
+ */
+export default class HtmlEmbed extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [HtmlEmbedEditing, HtmlEmbedUI, Widget];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'HtmlEmbed';
+    }
+}

package/src/htmlembedcommand.d.ts

@@ -1,44 +1,44 @@
-/**
- * @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 { Command } from 'ckeditor5/src/core';
-/**
- * The insert HTML embed element command.
- *
- * The command is registered by {@link module:html-embed/htmlembedediting~HtmlEmbedEditing} as `'htmlEmbed'`.
- *
- * To insert an empty HTML embed element at the current selection, execute the command:
- *
- * ```ts
- * editor.execute( 'htmlEmbed' );
- * ```
- *
- * You can specify the initial content of a new HTML embed in the argument:
- *
- * ```ts
- * editor.execute( 'htmlEmbed', '<b>Initial content.</b>' );
- * ```
- *
- * To update the content of the HTML embed, select it in the model and pass the content in the argument:
- *
- * ```ts
- * editor.execute( 'htmlEmbed', '<b>New content of an existing embed.</b>' );
- * ```
- */
-export default class HtmlEmbedCommand extends Command {
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * Executes the command, which either:
-     *
-     * * creates and inserts a new HTML embed element if none was selected,
-     * * updates the content of the HTML embed if one was selected.
-     *
-     * @fires execute
-     * @param value When passed, the value (content) will be set on a new embed or a selected one.
-     */
-    execute(value?: string): 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 { Command } from 'ckeditor5/src/core';
+/**
+ * The insert HTML embed element command.
+ *
+ * The command is registered by {@link module:html-embed/htmlembedediting~HtmlEmbedEditing} as `'htmlEmbed'`.
+ *
+ * To insert an empty HTML embed element at the current selection, execute the command:
+ *
+ * ```ts
+ * editor.execute( 'htmlEmbed' );
+ * ```
+ *
+ * You can specify the initial content of a new HTML embed in the argument:
+ *
+ * ```ts
+ * editor.execute( 'htmlEmbed', '<b>Initial content.</b>' );
+ * ```
+ *
+ * To update the content of the HTML embed, select it in the model and pass the content in the argument:
+ *
+ * ```ts
+ * editor.execute( 'htmlEmbed', '<b>New content of an existing embed.</b>' );
+ * ```
+ */
+export default class HtmlEmbedCommand extends Command {
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * Executes the command, which either:
+     *
+     * * creates and inserts a new HTML embed element if none was selected,
+     * * updates the content of the HTML embed if one was selected.
+     *
+     * @fires execute
+     * @param value When passed, the value (content) will be set on a new embed or a selected one.
+     */
+    execute(value?: string): void;
+}

package/src/htmlembedcommand.js

@@ -1,95 +1,95 @@
-/**
- * @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 { Command } from 'ckeditor5/src/core';
-import { findOptimalInsertionRange } from 'ckeditor5/src/widget';
-/**
- * The insert HTML embed element command.
- *
- * The command is registered by {@link module:html-embed/htmlembedediting~HtmlEmbedEditing} as `'htmlEmbed'`.
- *
- * To insert an empty HTML embed element at the current selection, execute the command:
- *
- * ```ts
- * editor.execute( 'htmlEmbed' );
- * ```
- *
- * You can specify the initial content of a new HTML embed in the argument:
- *
- * ```ts
- * editor.execute( 'htmlEmbed', '<b>Initial content.</b>' );
- * ```
- *
- * To update the content of the HTML embed, select it in the model and pass the content in the argument:
- *
- * ```ts
- * editor.execute( 'htmlEmbed', '<b>New content of an existing embed.</b>' );
- * ```
- */
-export default class HtmlEmbedCommand extends Command {
-    /**
-     * @inheritDoc
-     */
-    refresh() {
-        const model = this.editor.model;
-        const schema = model.schema;
-        const selection = model.document.selection;
-        const selectedRawHtmlElement = getSelectedRawHtmlModelWidget(selection);
-        this.isEnabled = isHtmlEmbedAllowedInParent(selection, schema, model);
-        this.value = selectedRawHtmlElement ? selectedRawHtmlElement.getAttribute('value') || '' : null;
-    }
-    /**
-     * Executes the command, which either:
-     *
-     * * creates and inserts a new HTML embed element if none was selected,
-     * * updates the content of the HTML embed if one was selected.
-     *
-     * @fires execute
-     * @param value When passed, the value (content) will be set on a new embed or a selected one.
-     */
-    execute(value) {
-        const model = this.editor.model;
-        const selection = model.document.selection;
-        model.change(writer => {
-            let htmlEmbedElement;
-            // If the command has a non-null value, there must be some HTML embed selected in the model.
-            if (this.value !== null) {
-                htmlEmbedElement = getSelectedRawHtmlModelWidget(selection);
-            }
-            else {
-                htmlEmbedElement = writer.createElement('rawHtml');
-                model.insertObject(htmlEmbedElement, null, null, { setSelection: 'on' });
-            }
-            writer.setAttribute('value', value, htmlEmbedElement);
-        });
-    }
-}
-/**
- * Checks if an HTML embed is allowed by the schema in the optimal insertion parent.
- */
-function isHtmlEmbedAllowedInParent(selection, schema, model) {
-    const parent = getInsertHtmlEmbedParent(selection, model);
-    return schema.checkChild(parent, 'rawHtml');
-}
-/**
- * Returns a node that will be used to insert a html embed with `model.insertContent` to check if a html embed element can be placed there.
- */
-function getInsertHtmlEmbedParent(selection, model) {
-    const insertionRange = findOptimalInsertionRange(selection, model);
-    const parent = insertionRange.start.parent;
-    if (parent.isEmpty && !parent.is('rootElement')) {
-        return parent.parent;
-    }
-    return parent;
-}
-/**
- * Returns the selected HTML embed element in the model, if any.
- */
-function getSelectedRawHtmlModelWidget(selection) {
-    const selectedElement = selection.getSelectedElement();
-    if (selectedElement && selectedElement.is('element', 'rawHtml')) {
-        return selectedElement;
-    }
-    return null;
-}
+/**
+ * @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 { Command } from 'ckeditor5/src/core';
+import { findOptimalInsertionRange } from 'ckeditor5/src/widget';
+/**
+ * The insert HTML embed element command.
+ *
+ * The command is registered by {@link module:html-embed/htmlembedediting~HtmlEmbedEditing} as `'htmlEmbed'`.
+ *
+ * To insert an empty HTML embed element at the current selection, execute the command:
+ *
+ * ```ts
+ * editor.execute( 'htmlEmbed' );
+ * ```
+ *
+ * You can specify the initial content of a new HTML embed in the argument:
+ *
+ * ```ts
+ * editor.execute( 'htmlEmbed', '<b>Initial content.</b>' );
+ * ```
+ *
+ * To update the content of the HTML embed, select it in the model and pass the content in the argument:
+ *
+ * ```ts
+ * editor.execute( 'htmlEmbed', '<b>New content of an existing embed.</b>' );
+ * ```
+ */
+export default class HtmlEmbedCommand extends Command {
+    /**
+     * @inheritDoc
+     */
+    refresh() {
+        const model = this.editor.model;
+        const schema = model.schema;
+        const selection = model.document.selection;
+        const selectedRawHtmlElement = getSelectedRawHtmlModelWidget(selection);
+        this.isEnabled = isHtmlEmbedAllowedInParent(selection, schema, model);
+        this.value = selectedRawHtmlElement ? selectedRawHtmlElement.getAttribute('value') || '' : null;
+    }
+    /**
+     * Executes the command, which either:
+     *
+     * * creates and inserts a new HTML embed element if none was selected,
+     * * updates the content of the HTML embed if one was selected.
+     *
+     * @fires execute
+     * @param value When passed, the value (content) will be set on a new embed or a selected one.
+     */
+    execute(value) {
+        const model = this.editor.model;
+        const selection = model.document.selection;
+        model.change(writer => {
+            let htmlEmbedElement;
+            // If the command has a non-null value, there must be some HTML embed selected in the model.
+            if (this.value !== null) {
+                htmlEmbedElement = getSelectedRawHtmlModelWidget(selection);
+            }
+            else {
+                htmlEmbedElement = writer.createElement('rawHtml');
+                model.insertObject(htmlEmbedElement, null, null, { setSelection: 'on' });
+            }
+            writer.setAttribute('value', value, htmlEmbedElement);
+        });
+    }
+}
+/**
+ * Checks if an HTML embed is allowed by the schema in the optimal insertion parent.
+ */
+function isHtmlEmbedAllowedInParent(selection, schema, model) {
+    const parent = getInsertHtmlEmbedParent(selection, model);
+    return schema.checkChild(parent, 'rawHtml');
+}
+/**
+ * Returns a node that will be used to insert a html embed with `model.insertContent` to check if a html embed element can be placed there.
+ */
+function getInsertHtmlEmbedParent(selection, model) {
+    const insertionRange = findOptimalInsertionRange(selection, model);
+    const parent = insertionRange.start.parent;
+    if (parent.isEmpty && !parent.is('rootElement')) {
+        return parent.parent;
+    }
+    return parent;
+}
+/**
+ * Returns the selected HTML embed element in the model, if any.
+ */
+function getSelectedRawHtmlModelWidget(selection) {
+    const selectedElement = selection.getSelectedElement();
+    if (selectedElement && selectedElement.is('element', 'rawHtml')) {
+        return selectedElement;
+    }
+    return null;
+}