@ckeditor/ckeditor5-enter 35.3.2 → 36.0.0

package/LICENSE.md

@@ -2,7 +2,7 @@ Software License Agreement
 ==========================
 
 **CKEditor 5 enter feature** – https://github.com/ckeditor/ckeditor5-enter <br>
-Copyright (c) 2003-2022, [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).
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-enter",
-  "version": "35.3.2",
+  "version": "36.0.0",
   "description": "Enter feature for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -12,17 +12,17 @@
   ],
   "main": "src/index.js",
   "dependencies": {
-    "@ckeditor/ckeditor5-core": "^35.3.2",
-    "@ckeditor/ckeditor5-engine": "^35.3.2"
+    "@ckeditor/ckeditor5-core": "^36.0.0",
+    "@ckeditor/ckeditor5-engine": "^36.0.0"
   },
   "devDependencies": {
-    "@ckeditor/ckeditor5-basic-styles": "^35.3.2",
-    "@ckeditor/ckeditor5-editor-classic": "^35.3.2",
-    "@ckeditor/ckeditor5-heading": "^35.3.2",
-    "@ckeditor/ckeditor5-link": "^35.3.2",
-    "@ckeditor/ckeditor5-paragraph": "^35.3.2",
-    "@ckeditor/ckeditor5-typing": "^35.3.2",
-    "@ckeditor/ckeditor5-undo": "^35.3.2",
+    "@ckeditor/ckeditor5-basic-styles": "^36.0.0",
+    "@ckeditor/ckeditor5-editor-classic": "^36.0.0",
+    "@ckeditor/ckeditor5-heading": "^36.0.0",
+    "@ckeditor/ckeditor5-link": "^36.0.0",
+    "@ckeditor/ckeditor5-paragraph": "^36.0.0",
+    "@ckeditor/ckeditor5-typing": "^36.0.0",
+    "@ckeditor/ckeditor5-undo": "^36.0.0",
     "typescript": "^4.8.4",
     "webpack": "^5.58.1",
     "webpack-cli": "^4.9.0"

package/src/enter.js

@@ -1,15 +1,15 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @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 enter/enter
  */
-import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
+import { Plugin } from '@ckeditor/ckeditor5-core';
 import EnterCommand from './entercommand';
 import EnterObserver from './enterobserver';
 /**
- * This plugin handles the <kbd>Enter</kbd> key (hard line break) in the editor.
+ * This plugin handles the <kbd>Enter</kbd> keystroke (hard line break) in the editor.
  *
  * See also the {@link module:enter/shiftenter~ShiftEnter} plugin.
  *

package/src/entercommand.js

@@ -1,14 +1,14 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @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 enter/entercommand
  */
-import Command from '@ckeditor/ckeditor5-core/src/command';
+import { Command } from '@ckeditor/ckeditor5-core';
 import { getCopyOnEnterAttributes } from './utils';
 /**
- * Enter command. It is used by the {@link module:enter/enter~Enter Enter feature} to handle the <kbd>Enter</kbd> key.
+ * Enter command. It is used by the {@link module:enter/enter~Enter Enter feature} to handle the <kbd>Enter</kbd> keystroke.
  *
  * @extends module:core/command~Command
  */
@@ -17,60 +17,75 @@ export default class EnterCommand extends Command {
      * @inheritDoc
      */
     execute() {
-        const model = this.editor.model;
-        const doc = model.document;
-        model.change(writer => {
-            enterBlock(this.editor.model, writer, doc.selection, model.schema);
+        this.editor.model.change(writer => {
+            this.enterBlock(writer);
             this.fire('afterExecute', { writer });
         });
     }
-}
-// Creates a new block in the way that the <kbd>Enter</kbd> key is expected to work.
-//
-// @param {module:engine/model~Model} model
-// @param {module:engine/model/writer~Writer} writer
-// @param {module:engine/model/selection~Selection|module:engine/model/documentselection~DocumentSelection} selection
-// Selection on which the action should be performed.
-// @param {module:engine/model/schema~Schema} schema
-function enterBlock(model, writer, selection, schema) {
-    const isSelectionEmpty = selection.isCollapsed;
-    const range = selection.getFirstRange();
-    const startElement = range.start.parent;
-    const endElement = range.end.parent;
-    // Don't touch the roots and other limit elements.
-    if (schema.isLimit(startElement) || schema.isLimit(endElement)) {
-        // Delete the selected content but only if inside a single limit element.
-        // Abort, when crossing limit elements boundary (e.g. <limit1>x[x</limit1>donttouchme<limit2>y]y</limit2>).
-        // This is an edge case and it's hard to tell what should actually happen because such a selection
-        // is not entirely valid.
-        if (!isSelectionEmpty && startElement == endElement) {
-            model.deleteContent(selection);
-        }
-        return;
-    }
-    if (isSelectionEmpty) {
-        const attributesToCopy = getCopyOnEnterAttributes(writer.model.schema, selection.getAttributes());
-        splitBlock(writer, range.start);
-        writer.setSelectionAttribute(attributesToCopy);
-    }
-    else {
-        const leaveUnmerged = !(range.start.isAtStart && range.end.isAtEnd);
-        const isContainedWithinOneElement = (startElement == endElement);
-        model.deleteContent(selection, { leaveUnmerged });
-        if (leaveUnmerged) {
-            // Partially selected elements.
-            //
-            // <h>x[xx]x</h>		-> <h>x^x</h>			-> <h>x</h><h>^x</h>
-            if (isContainedWithinOneElement) {
-                splitBlock(writer, selection.focus);
+    /**
+     * Splits a block where the document selection is placed, in the way how the <kbd>Enter</kbd> key is expected to work:
+     *
+     *		<p>Foo[]bar</p>   ->   <p>Foo</p><p>[]bar</p>
+     *		<p>Foobar[]</p>   ->   <p>Foobar</p><p>[]</p>
+     *		<p>Fo[ob]ar</p>   ->   <p>Fo</p><p>[]ar</p>
+     *
+     * In some cases, the split will not happen:
+     *
+     *        // The selection parent is a limit element:
+     *        <figcaption>A[bc]d</figcaption>   ->   <figcaption>A[]d</figcaption>
+     *
+     *        // The selection spans over multiple elements:
+     *        <h>x[x</h><p>y]y<p>   ->   <h>x</h><p>[]y</p>
+     *
+     * @param writer Writer to use when performing the enter action.
+     * @returns `true` if a block was split, `false` otherwise.
+     */
+    enterBlock(writer) {
+        const model = this.editor.model;
+        const selection = model.document.selection;
+        const schema = model.schema;
+        const isSelectionEmpty = selection.isCollapsed;
+        const range = selection.getFirstRange();
+        const startElement = range.start.parent;
+        const endElement = range.end.parent;
+        // Don't touch the roots and other limit elements.
+        if (schema.isLimit(startElement) || schema.isLimit(endElement)) {
+            // Delete the selected content but only if inside a single limit element.
+            // Abort, when crossing limit elements boundary (e.g. <limit1>x[x</limit1>donttouchme<limit2>y]y</limit2>).
+            // This is an edge case and it's hard to tell what should actually happen because such a selection
+            // is not entirely valid.
+            if (!isSelectionEmpty && startElement == endElement) {
+                model.deleteContent(selection);
             }
-            // Selection over multiple elements.
-            //
-            // <h>x[x</h><p>y]y<p>	-> <h>x^</h><p>y</p>	-> <h>x</h><p>^y</p>
-            else {
-                writer.setSelection(endElement, 0);
+            return false;
+        }
+        if (isSelectionEmpty) {
+            const attributesToCopy = getCopyOnEnterAttributes(writer.model.schema, selection.getAttributes());
+            splitBlock(writer, range.start);
+            writer.setSelectionAttribute(attributesToCopy);
+            return true;
+        }
+        else {
+            const leaveUnmerged = !(range.start.isAtStart && range.end.isAtEnd);
+            const isContainedWithinOneElement = (startElement == endElement);
+            model.deleteContent(selection, { leaveUnmerged });
+            if (leaveUnmerged) {
+                // Partially selected elements.
+                //
+                // <h>x[xx]x</h>		-> <h>x^x</h>			-> <h>x</h><h>^x</h>
+                if (isContainedWithinOneElement) {
+                    splitBlock(writer, selection.focus);
+                    return true;
+                }
+                // Selection over multiple elements.
+                //
+                // <h>x[x</h><p>y]y<p>	-> <h>x^</h><p>y</p>	-> <h>x</h><p>^y</p>
+                else {
+                    writer.setSelection(endElement, 0);
+                }
             }
         }
+        return false;
     }
 }
 function splitBlock(writer, splitPos) {

package/src/enterobserver.js

@@ -1,13 +1,11 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @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 enter/enterobserver
  */
-import Observer from '@ckeditor/ckeditor5-engine/src/view/observer/observer';
-import DomEventData from '@ckeditor/ckeditor5-engine/src/view/observer/domeventdata';
-import BubblingEventInfo from '@ckeditor/ckeditor5-engine/src/view/observer/bubblingeventinfo';
+import { Observer, DomEventData, BubblingEventInfo } from '@ckeditor/ckeditor5-engine';
 const ENTER_EVENT_TYPES = {
     insertParagraph: { isSoft: false },
     insertLineBreak: { isSoft: true }

package/src/index.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @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
  */
 /**

package/src/shiftenter.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @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
  */
 /**
@@ -7,7 +7,7 @@
  */
 import ShiftEnterCommand from './shiftentercommand';
 import EnterObserver from './enterobserver';
-import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
+import { Plugin } from '@ckeditor/ckeditor5-core';
 /**
  * This plugin handles the <kbd>Shift</kbd>+<kbd>Enter</kbd> keystroke (soft line break) in the editor.
  *

package/src/shiftentercommand.js

@@ -1,11 +1,11 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @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 enter/shiftentercommand
  */
-import Command from '@ckeditor/ckeditor5-core/src/command';
+import { Command } from '@ckeditor/ckeditor5-core';
 import { getCopyOnEnterAttributes } from './utils';
 /**
  * ShiftEnter command. It is used by the {@link module:enter/shiftenter~ShiftEnter ShiftEnter feature} to handle

package/src/utils.js

@@ -1,9 +1,9 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @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
  */
 /**
- * Returns attributes that should be preserved on the enter key.
+ * Returns attributes that should be preserved on the enter keystroke.
  *
  * Filtering is realized based on `copyOnEnter` attribute property. Read more about attribute properties
  * {@link module:engine/model/schema~Schema#setAttributeProperties here}.