@ckeditor/ckeditor5-typing 47.6.1-alpha.1 → 48.0.0-alpha.0

package/{src → dist}/texttransformation.d.ts

@@ -6,6 +6,8 @@
  * @module typing/texttransformation
  */
 import { Plugin, type Editor } from '@ckeditor/ckeditor5-core';
+import { Delete } from './delete.js';
+import { Input } from './input.js';
 /**
  * The text transformation plugin.
  */
@@ -13,7 +15,7 @@ export declare class TextTransformation extends Plugin {
     /**
      * @inheritDoc
      */
-    static get requires(): readonly ["Delete", "Input"];
+    static get requires(): readonly [typeof Delete, typeof Input];
     /**
      * @inheritDoc
      */

package/package.json

@@ -1,59 +1,40 @@
 {
   "name": "@ckeditor/ckeditor5-typing",
-  "version": "47.6.1-alpha.1",
+  "version": "48.0.0-alpha.0",
   "description": "Typing feature for CKEditor 5.",
+  "license": "SEE LICENSE IN LICENSE.md",
+  "author": "CKSource (http://cksource.com/)",
+  "homepage": "https://ckeditor.com/ckeditor-5",
+  "bugs": "https://github.com/ckeditor/ckeditor5/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ckeditor/ckeditor5.git",
+    "directory": "packages/ckeditor5-typing"
+  },
   "keywords": [
     "ckeditor",
     "ckeditor5",
     "ckeditor 5",
     "ckeditor5-feature",
-    "ckeditor5-plugin",
-    "ckeditor5-dll"
+    "ckeditor5-plugin"
   ],
   "type": "module",
-  "main": "src/index.js",
-  "dependencies": {
-    "@ckeditor/ckeditor5-core": "47.6.1-alpha.1",
-    "@ckeditor/ckeditor5-engine": "47.6.1-alpha.1",
-    "@ckeditor/ckeditor5-utils": "47.6.1-alpha.1",
-    "es-toolkit": "1.39.5"
+  "main": "./dist/index.js",
+  "exports": {
+    ".": "./dist/index.js",
+    "./dist/*": "./dist/*",
+    "./package.json": "./package.json"
   },
-  "author": "CKSource (http://cksource.com/)",
-  "license": "SEE LICENSE IN LICENSE.md",
-  "homepage": "https://ckeditor.com/ckeditor-5",
-  "bugs": "https://github.com/ckeditor/ckeditor5/issues",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/ckeditor/ckeditor5.git",
-    "directory": "packages/ckeditor5-typing"
+  "dependencies": {
+    "@ckeditor/ckeditor5-core": "48.0.0-alpha.0",
+    "@ckeditor/ckeditor5-engine": "48.0.0-alpha.0",
+    "@ckeditor/ckeditor5-utils": "48.0.0-alpha.0",
+    "es-toolkit": "1.45.1"
   },
   "files": [
     "dist",
-    "lang",
-    "src/**/*.js",
-    "src/**/*.d.ts",
-    "theme",
     "ckeditor5-metadata.json",
     "CHANGELOG.md"
   ],
-  "types": "src/index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./src/index.d.ts",
-      "import": "./src/index.js",
-      "default": "./src/index.js"
-    },
-    "./dist/*": {
-      "types": "./src/index.d.ts",
-      "import": "./dist/*",
-      "default": "./dist/*"
-    },
-    "./src/*": {
-      "types": "./src/*.d.ts",
-      "import": "./src/*",
-      "default": "./src/*"
-    },
-    "./ckeditor5-metadata.json": "./ckeditor5-metadata.json",
-    "./package.json": "./package.json"
-  }
+  "types": "./dist/index.d.ts"
 }

package/src/augmentation.js

@@ -1,5 +0,0 @@
-/**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-export {};

package/src/delete.js

@@ -1,122 +0,0 @@
-/**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module typing/delete
- */
-import { _tryFixingModelRange, BubblingEventInfo, ViewDocumentDomEventData } from '@ckeditor/ckeditor5-engine';
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import { keyCodes } from '@ckeditor/ckeditor5-utils';
-import { DeleteCommand } from './deletecommand.js';
-import { DeleteObserver } from './deleteobserver.js';
-/**
- * The delete and backspace feature. Handles keys such as <kbd>Delete</kbd> and <kbd>Backspace</kbd>, other
- * keystrokes and user actions that result in deleting content in the editor.
- */
-export class Delete extends Plugin {
-    /**
-     * Whether pressing backspace should trigger undo action
-     */
-    _undoOnBackspace;
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'Delete';
-    }
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin() {
-        return true;
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const editor = this.editor;
-        const view = editor.editing.view;
-        const viewDocument = view.document;
-        const modelDocument = editor.model.document;
-        view.addObserver(DeleteObserver);
-        this._undoOnBackspace = false;
-        const deleteForwardCommand = new DeleteCommand(editor, 'forward');
-        // Register `deleteForward` command and add `forwardDelete` command as an alias for backward compatibility.
-        editor.commands.add('deleteForward', deleteForwardCommand);
-        editor.commands.add('forwardDelete', deleteForwardCommand);
-        editor.commands.add('delete', new DeleteCommand(editor, 'backward'));
-        this.listenTo(viewDocument, 'delete', (evt, data) => {
-            // When not in composition, we handle the action, so prevent the default one.
-            // When in composition, it's the browser who modify the DOM (renderer is disabled).
-            if (!viewDocument.isComposing) {
-                data.preventDefault();
-            }
-            const { direction, sequence, selectionToRemove, unit } = data;
-            const commandName = direction === 'forward' ? 'deleteForward' : 'delete';
-            const commandData = { sequence };
-            if (unit == 'selection') {
-                const modelRanges = Array.from(selectionToRemove.getRanges())
-                    .map(viewRange => editor.editing.mapper.toModelRange(viewRange))
-                    .map(modelRange => _tryFixingModelRange(modelRange, editor.model.schema) || modelRange);
-                commandData.selection = editor.model.createSelection(modelRanges);
-            }
-            else {
-                commandData.unit = unit;
-            }
-            editor.execute(commandName, commandData);
-            view.scrollToTheSelection();
-        }, { priority: 'low' });
-        // Handle the Backspace key while at the beginning of a nested editable. See https://github.com/ckeditor/ckeditor5/issues/17383.
-        this.listenTo(viewDocument, 'keydown', (evt, data) => {
-            if (viewDocument.isComposing ||
-                data.keyCode != keyCodes.backspace ||
-                !modelDocument.selection.isCollapsed) {
-                return;
-            }
-            const ancestorLimit = editor.model.schema.getLimitElement(modelDocument.selection);
-            const limitStartPosition = editor.model.createPositionAt(ancestorLimit, 0);
-            if (limitStartPosition.isTouching(modelDocument.selection.getFirstPosition())) {
-                // Stop the beforeinput event as it could be invalid.
-                data.preventDefault();
-                // Create a fake delete event so all features can act on it and the target range is proper.
-                const modelRange = editor.model.schema.getNearestSelectionRange(limitStartPosition, 'forward');
-                if (!modelRange) {
-                    return;
-                }
-                const viewSelection = view.createSelection(editor.editing.mapper.toViewRange(modelRange));
-                const targetRange = viewSelection.getFirstRange();
-                const eventInfo = new BubblingEventInfo(document, 'delete', targetRange);
-                const deleteData = {
-                    unit: 'selection',
-                    direction: 'backward',
-                    selectionToRemove: viewSelection
-                };
-                viewDocument.fire(eventInfo, new ViewDocumentDomEventData(view, data.domEvent, deleteData));
-            }
-        });
-        if (this.editor.plugins.has('UndoEditing')) {
-            this.listenTo(viewDocument, 'delete', (evt, data) => {
-                if (this._undoOnBackspace && data.direction == 'backward' && data.sequence == 1 && data.unit == 'codePoint') {
-                    this._undoOnBackspace = false;
-                    editor.execute('undo');
-                    data.preventDefault();
-                    evt.stop();
-                }
-            }, { context: '$capture' });
-            this.listenTo(modelDocument, 'change', () => {
-                this._undoOnBackspace = false;
-            });
-        }
-    }
-    /**
-     * If the next user action after calling this method is pressing backspace, it would undo the last change.
-     *
-     * Requires {@link module:undo/undoediting~UndoEditing} plugin. If not loaded, does nothing.
-     */
-    requestUndoOnBackspace() {
-        if (this.editor.plugins.has('UndoEditing')) {
-            this._undoOnBackspace = true;
-        }
-    }
-}

package/src/deletecommand.js

@@ -1,212 +0,0 @@
-/**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module typing/deletecommand
- */
-import { Command } from '@ckeditor/ckeditor5-core';
-import { count } from '@ckeditor/ckeditor5-utils';
-import { TypingChangeBuffer } from './utils/changebuffer.js';
-// @if CK_DEBUG_TYPING // const { _buildLogMessage } = require( '@ckeditor/ckeditor5-engine/src/dev-utils/utils.js' );
-/**
- * The delete command. Used by the {@link module:typing/delete~Delete delete feature} to handle the <kbd>Delete</kbd> and
- * <kbd>Backspace</kbd> keys.
- */
-export class DeleteCommand extends Command {
-    /**
-     * The directionality of the delete describing in what direction it should
-     * consume the content when the selection is collapsed.
-     */
-    direction;
-    /**
-     * Delete's change buffer used to group subsequent changes into batches.
-     */
-    _buffer;
-    /**
-     * Creates an instance of the command.
-     *
-     * @param direction The directionality of the delete describing in what direction it
-     * should consume the content when the selection is collapsed.
-     */
-    constructor(editor, direction) {
-        super(editor);
-        this.direction = direction;
-        this._buffer = new TypingChangeBuffer(editor.model, editor.config.get('typing.undoStep'));
-        // Since this command may execute on different selectable than selection, it should be checked directly in execute block.
-        this._isEnabledBasedOnSelection = false;
-    }
-    /**
-     * The current change buffer.
-     */
-    get buffer() {
-        return this._buffer;
-    }
-    /**
-     * Executes the delete command. Depending on whether the selection is collapsed or not, deletes its content
-     * or a piece of content in the {@link #direction defined direction}.
-     *
-     * @fires execute
-     * @param options The command options.
-     * @param options.unit See {@link module:engine/model/utils/modifyselection~modifySelection}'s options.
-     * @param options.sequence A number describing which subsequent delete event it is without the key being released.
-     * See the {@link module:engine/view/document~ViewDocument#event:delete} event data.
-     * @param options.selection Selection to remove. If not set, current model selection will be used.
-     */
-    execute(options = {}) {
-        const model = this.editor.model;
-        const doc = model.document;
-        model.enqueueChange(this._buffer.batch, writer => {
-            this._buffer.lock();
-            const selection = writer.createSelection(options.selection || doc.selection);
-            // Don't execute command when selection is in non-editable place.
-            if (!model.canEditAt(selection)) {
-                return;
-            }
-            const sequence = options.sequence || 1;
-            // Do not replace the whole selected content if selection was collapsed.
-            // This prevents such situation:
-            //
-            // <h1></h1><p>[]</p>	-->  <h1>[</h1><p>]</p> 		-->  <p></p>
-            // starting content		-->   after `modifySelection`	-->  after `deleteContent`.
-            const doNotResetEntireContent = selection.isCollapsed;
-            // Try to extend the selection in the specified direction.
-            if (selection.isCollapsed) {
-                model.modifySelection(selection, {
-                    direction: this.direction,
-                    unit: options.unit,
-                    treatEmojiAsSingleUnit: true
-                });
-            }
-            // Check if deleting in an empty editor. See #61.
-            if (this._shouldEntireContentBeReplacedWithParagraph(sequence)) {
-                this._replaceEntireContentWithParagraph(writer);
-                return;
-            }
-            // Check if deleting in the first empty block.
-            // See https://github.com/ckeditor/ckeditor5/issues/8137.
-            if (this._shouldReplaceFirstBlockWithParagraph(selection, sequence)) {
-                this.editor.execute('paragraph', { selection });
-                return;
-            }
-            // If selection is still collapsed, then there's nothing to delete.
-            if (selection.isCollapsed) {
-                return;
-            }
-            let changeCount = 0;
-            selection.getFirstRange().getMinimalFlatRanges().forEach(range => {
-                changeCount += count(range.getWalker({ singleCharacters: true, ignoreElementEnd: true, shallow: true }));
-            });
-            // @if CK_DEBUG_TYPING // if ( ( window as any ).logCKETyping ) {
-            // @if CK_DEBUG_TYPING // 	console.log( ..._buildLogMessage( this, 'DeleteCommand',
-            // @if CK_DEBUG_TYPING // 		'Delete content',
-            // @if CK_DEBUG_TYPING // 		`[${ selection.getFirstPosition()!.path }]-[${ selection.getLastPosition()!.path }]`,
-            // @if CK_DEBUG_TYPING // 		options
-            // @if CK_DEBUG_TYPING // 	) );
-            // @if CK_DEBUG_TYPING // }
-            model.deleteContent(selection, {
-                doNotResetEntireContent,
-                direction: this.direction
-            });
-            this._buffer.input(changeCount);
-            writer.setSelection(selection);
-            this._buffer.unlock();
-        });
-    }
-    /**
-     * If the user keeps <kbd>Backspace</kbd> or <kbd>Delete</kbd> key pressed, the content of the current
-     * editable will be cleared. However, this will not yet lead to resetting the remaining block to a paragraph
-     * (which happens e.g. when the user does <kbd>Ctrl</kbd> + <kbd>A</kbd>, <kbd>Backspace</kbd>).
-     *
-     * But, if the user pressed the key in an empty editable for the first time,
-     * we want to replace the entire content with a paragraph if:
-     *
-     * * the current limit element is empty,
-     * * the paragraph is allowed in the limit element,
-     * * the limit doesn't already have a paragraph inside.
-     *
-     * See https://github.com/ckeditor/ckeditor5-typing/issues/61.
-     *
-     * @param sequence A number describing which subsequent delete event it is without the key being released.
-     */
-    _shouldEntireContentBeReplacedWithParagraph(sequence) {
-        // Does nothing if user pressed and held the "Backspace" or "Delete" key.
-        if (sequence > 1) {
-            return false;
-        }
-        const model = this.editor.model;
-        const doc = model.document;
-        const selection = doc.selection;
-        const limitElement = model.schema.getLimitElement(selection);
-        // If a collapsed selection contains the whole content it means that the content is empty
-        // (from the user perspective).
-        const limitElementIsEmpty = selection.isCollapsed && selection.containsEntireContent(limitElement);
-        if (!limitElementIsEmpty) {
-            return false;
-        }
-        if (!model.schema.checkChild(limitElement, 'paragraph')) {
-            return false;
-        }
-        const limitElementFirstChild = limitElement.getChild(0);
-        // Does nothing if the limit element already contains only a paragraph.
-        // We ignore the case when paragraph might have some inline elements (<p><inlineWidget>[]</inlineWidget></p>)
-        // because we don't support such cases yet and it's unclear whether inlineWidget shouldn't be a limit itself.
-        if (limitElementFirstChild && limitElementFirstChild.is('element', 'paragraph')) {
-            return false;
-        }
-        return true;
-    }
-    /**
-     * The entire content is replaced with the paragraph. Selection is moved inside the paragraph.
-     *
-     * @param writer The model writer.
-     */
-    _replaceEntireContentWithParagraph(writer) {
-        const model = this.editor.model;
-        const doc = model.document;
-        const selection = doc.selection;
-        const limitElement = model.schema.getLimitElement(selection);
-        const paragraph = writer.createElement('paragraph');
-        writer.remove(writer.createRangeIn(limitElement));
-        writer.insert(paragraph, limitElement);
-        writer.setSelection(paragraph, 0);
-    }
-    /**
-     * Checks if the selection is inside an empty element that is the first child of the limit element
-     * and should be replaced with a paragraph.
-     *
-     * @param selection The selection.
-     * @param sequence A number describing which subsequent delete event it is without the key being released.
-     */
-    _shouldReplaceFirstBlockWithParagraph(selection, sequence) {
-        const model = this.editor.model;
-        // Does nothing if user pressed and held the "Backspace" key or it was a "Delete" button.
-        if (sequence > 1 || this.direction != 'backward') {
-            return false;
-        }
-        if (!selection.isCollapsed) {
-            return false;
-        }
-        const position = selection.getFirstPosition();
-        const limitElement = model.schema.getLimitElement(position);
-        const limitElementFirstChild = limitElement.getChild(0);
-        // Only elements that are direct children of the limit element can be replaced.
-        // Unwrapping from a block quote should be handled in a dedicated feature.
-        if (position.parent != limitElementFirstChild) {
-            return false;
-        }
-        // A block should be replaced only if it was empty.
-        if (!selection.containsEntireContent(limitElementFirstChild)) {
-            return false;
-        }
-        // Replace with a paragraph only if it's allowed there.
-        if (!model.schema.checkChild(limitElement, 'paragraph')) {
-            return false;
-        }
-        // Does nothing if the limit element already contains only a paragraph.
-        if (limitElementFirstChild.name == 'paragraph') {
-            return false;
-        }
-        return true;
-    }
-}