@ckeditor/ckeditor5-typing 45.2.1 → 46.0.0-alpha.0

package/dist/index.js

@@ -4,7 +4,7 @@
  */
 import { Command, Plugin } from '@ckeditor/ckeditor5-core/dist/index.js';
 import { env, EventInfo, count, isInsideSurrogatePair, isInsideCombinedSymbol, isInsideEmojiSequence, keyCodes, ObservableMixin } from '@ckeditor/ckeditor5-utils/dist/index.js';
-import { Observer, FocusObserver, DomEventData, _tryFixingModelRange, LiveRange, BubblingEventInfo, MouseObserver, TouchObserver } from '@ckeditor/ckeditor5-engine/dist/index.js';
+import { Observer, FocusObserver, ViewDocumentDomEventData, _tryFixingModelRange, ModelLiveRange, BubblingEventInfo, MouseObserver, TouchObserver } from '@ckeditor/ckeditor5-engine/dist/index.js';
 import { debounce, escapeRegExp } from 'es-toolkit/compat';
 
 /**
@@ -19,7 +19,7 @@ import { debounce, escapeRegExp } from 'es-toolkit/compat';
  * Batches represent single undo steps, hence changes added to one single batch are undone together.
  *
  * The buffer has a configurable limit of atomic changes that it can accommodate. After the limit was
- * exceeded (see {@link ~ChangeBuffer#input}), a new batch is created in {@link ~ChangeBuffer#batch}.
+ * exceeded (see {@link ~TypingChangeBuffer#input}), a new batch is created in {@link ~TypingChangeBuffer#batch}.
  *
  * To use the change buffer you need to let it know about the number of changes that were added to the batch:
  *
@@ -30,7 +30,7 @@ import { debounce, escapeRegExp } from 'es-toolkit/compat';
  * buffer.batch.insert( pos, insertedCharacters );
  * buffer.input( insertedCharacters.length );
  * ```
- */ class ChangeBuffer {
+ */ class TypingChangeBuffer {
     /**
 	 * The model instance.
 	 */ model;
@@ -155,7 +155,7 @@ import { debounce, escapeRegExp } from 'es-toolkit/compat';
 	 * which can be contained in one batch in the command buffer.
 	 */ constructor(editor, undoStepSize){
         super(editor);
-        this._buffer = new ChangeBuffer(editor.model, undoStepSize);
+        this._buffer = new TypingChangeBuffer(editor.model, undoStepSize);
         // Since this command may execute on different selectable than selection, it should be checked directly in execute block.
         this._isEnabledBasedOnSelection = false;
     }
@@ -196,7 +196,7 @@ import { debounce, escapeRegExp } from 'es-toolkit/compat';
         model.enqueueChange(this._buffer.batch, (writer)=>{
             this._buffer.lock();
             // Store selection attributes before deleting old content to preserve formatting and link.
-            // This unifies the behavior between DocumentSelection and Selection provided as input option.
+            // This unifies the behavior between ModelDocumentSelection and Selection provided as input option.
             const selectionAttributes = Array.from(doc.selection.getAttributes());
             model.deleteContent(selection);
             if (text) {
@@ -231,7 +231,7 @@ const TYPING_INPUT_TYPES_ANDROID = [
     'insertCompositionText'
 ];
 /**
- * Text insertion observer introduces the {@link module:engine/view/document~Document#event:insertText} event.
+ * Text insertion observer introduces the {@link module:engine/view/document~ViewDocument#event:insertText} event.
  */ class InsertTextObserver extends Observer {
     /**
 	 * Instance of the focus observer. Insert text observer calls
@@ -259,7 +259,7 @@ const TYPING_INPUT_TYPES_ANDROID = [
             // so the selection is in the focused element).
             this.focusObserver.flush();
             const eventInfo = new EventInfo(viewDocument, 'insertText');
-            viewDocument.fire(eventInfo, new DomEventData(view, domEvent, {
+            viewDocument.fire(eventInfo, new ViewDocumentDomEventData(view, domEvent, {
                 text,
                 selection: view.createSelection(targetRanges),
                 isComposing
@@ -297,7 +297,7 @@ const TYPING_INPUT_TYPES_ANDROID = [
                 // 2. The last moment before it's locked is the `compositionstart` event.
                 // 3. The `SelectionObserver` is listening for `compositionstart` event and immediately converts
                 //    the selection. Handle this at the low priority so after the rendering is blocked.
-                viewDocument.fire('insertText', new DomEventData(view, domEvent, {
+                viewDocument.fire('insertText', new ViewDocumentDomEventData(view, domEvent, {
                     text: data,
                     isComposing: true
                 }));
@@ -627,7 +627,7 @@ const TYPING_INPUT_TYPES_ANDROID = [
         if (commandData.selection) {
             commandLiveData.selectionRanges = [];
             for (const range of commandData.selection.getRanges()){
-                commandLiveData.selectionRanges.push(LiveRange.fromRange(range));
+                commandLiveData.selectionRanges.push(ModelLiveRange.fromRange(range));
                 // Keep reference to the model element for later mutation checks.
                 this._affectedElements.add(range.start.parent);
             }
@@ -740,7 +740,7 @@ const TYPING_INPUT_TYPES_ANDROID = [
     buffer.unlock();
 }
 /**
- * Detaches a LiveRange and returns the static range from it.
+ * Detaches a ModelLiveRange and returns the static range from it.
  */ function detachLiveRange(liveRange) {
     const range = liveRange.toRange();
     liveRange.detach();
@@ -779,7 +779,7 @@ const TYPING_INPUT_TYPES_ANDROID = [
 	 */ constructor(editor, direction){
         super(editor);
         this.direction = direction;
-        this._buffer = new ChangeBuffer(editor.model, editor.config.get('typing.undoStep'));
+        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;
     }
@@ -796,7 +796,7 @@ const TYPING_INPUT_TYPES_ANDROID = [
 	 * @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~Document#event:delete} event data.
+	 * 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;
@@ -1045,7 +1045,9 @@ const DELETE_EVENT_TYPES = {
     }
 };
 /**
- * Delete observer introduces the {@link module:engine/view/document~Document#event:delete} event.
+ * Delete observer introduces the {@link module:engine/view/document~ViewDocument#event:delete} event.
+ *
+ * @internal
  */ class DeleteObserver extends Observer {
     /**
 	 * @inheritDoc
@@ -1096,7 +1098,7 @@ const DELETE_EVENT_TYPES = {
                 }
             }
             const eventInfo = new BubblingEventInfo(document, 'delete', targetRanges[0]);
-            document.fire(eventInfo, new DomEventData(view, domEvent, deleteData));
+            document.fire(eventInfo, new ViewDocumentDomEventData(view, domEvent, deleteData));
             // Stop the beforeinput event if `delete` event was stopped.
             // https://github.com/ckeditor/ckeditor5/issues/753
             if (eventInfo.stop.called) {
@@ -1138,7 +1140,7 @@ const DELETE_EVENT_TYPES = {
                 direction: getDeleteDirection(keyCode),
                 selectionToRemove: selection
             };
-            document.fire(eventInfo, new DomEventData(view, domEvent, deleteData));
+            document.fire(eventInfo, new ViewDocumentDomEventData(view, domEvent, deleteData));
         }
     });
     document.on('beforeinput', (evt, { inputType })=>{
@@ -1274,7 +1276,7 @@ const DELETE_EVENT_TYPES = {
                     direction: 'backward',
                     selectionToRemove: viewSelection
                 };
-                viewDocument.fire(eventInfo, new DomEventData(view, data.domEvent, deleteData));
+                viewDocument.fire(eventInfo, new ViewDocumentDomEventData(view, data.domEvent, deleteData));
             }
         });
         if (this.editor.plugins.has('UndoEditing')) {
@@ -1616,12 +1618,12 @@ const DELETE_EVENT_TYPES = {
 	 */ attributes;
     /**
 	 * The current UID of the overridden gravity, as returned by
-	 * {@link module:engine/model/writer~Writer#overrideSelectionGravity}.
+	 * {@link module:engine/model/writer~ModelWriter#overrideSelectionGravity}.
 	 */ _overrideUid;
     /**
 	 * A flag indicating that the automatic gravity restoration should not happen upon the next
 	 * gravity restoration.
-	 * {@link module:engine/model/selection~Selection#event:change:range} event.
+	 * {@link module:engine/model/selection~ModelSelection#event:change:range} event.
 	 */ _isNextGravityRestorationSkipped = false;
     /**
 	 * @inheritDoc
@@ -1719,7 +1721,7 @@ const DELETE_EVENT_TYPES = {
     }
     /**
 	 * Updates the document selection and the view according to the two–step caret movement state
-	 * when moving **forwards**. Executed upon `keypress` in the {@link module:engine/view/view~View}.
+	 * when moving **forwards**. Executed upon `keypress` in the {@link module:engine/view/view~EditingView}.
 	 *
 	 * @internal
 	 * @param eventData Data of the key press.
@@ -1778,7 +1780,7 @@ const DELETE_EVENT_TYPES = {
     }
     /**
 	 * Updates the document selection and the view according to the two–step caret movement state
-	 * when moving **backwards**. Executed upon `keypress` in the {@link module:engine/view/view~View}.
+	 * when moving **backwards**. Executed upon `keypress` in the {@link module:engine/view/view~EditingView}.
 	 *
 	 * @internal
 	 * @param eventData Data of the key press.
@@ -1875,8 +1877,8 @@ const DELETE_EVENT_TYPES = {
         return false;
     }
     /**
-	 * Starts listening to {@link module:engine/view/document~Document#event:mousedown} and
-	 * {@link module:engine/view/document~Document#event:selectionChange} and puts the selection before/after a 2-step node
+	 * Starts listening to {@link module:engine/view/document~ViewDocument#event:mousedown} and
+	 * {@link module:engine/view/document~ViewDocument#event:selectionChange} and puts the selection before/after a 2-step node
 	 * if clicked at the beginning/ending of the 2-step node.
 	 *
 	 * The purpose of this action is to allow typing around the 2-step node directly after a click.
@@ -2024,19 +2026,19 @@ const DELETE_EVENT_TYPES = {
         return !!this._overrideUid;
     }
     /**
-	 * Overrides the gravity using the {@link module:engine/model/writer~Writer model writer}
+	 * Overrides the gravity using the {@link module:engine/model/writer~ModelWriter model writer}
 	 * and stores the information about this fact in the {@link #_overrideUid}.
 	 *
-	 * A shorthand for {@link module:engine/model/writer~Writer#overrideSelectionGravity}.
+	 * A shorthand for {@link module:engine/model/writer~ModelWriter#overrideSelectionGravity}.
 	 */ _overrideGravity() {
         this._overrideUid = this.editor.model.change((writer)=>{
             return writer.overrideSelectionGravity();
         });
     }
     /**
-	 * Restores the gravity using the {@link module:engine/model/writer~Writer model writer}.
+	 * Restores the gravity using the {@link module:engine/model/writer~ModelWriter model writer}.
 	 *
-	 * A shorthand for {@link module:engine/model/writer~Writer#restoreSelectionGravity}.
+	 * A shorthand for {@link module:engine/model/writer~ModelWriter#restoreSelectionGravity}.
 	 */ _restoreGravity() {
         this.editor.model.change((writer)=>{
             writer.restoreSelectionGravity(this._overrideUid);
@@ -2057,7 +2059,7 @@ const DELETE_EVENT_TYPES = {
 /**
  * Applies the given attributes to the current selection using using the
  * values from the node before the current position. Uses
- * the {@link module:engine/model/writer~Writer model writer}.
+ * the {@link module:engine/model/writer~ModelWriter model writer}.
  */ function setSelectionAttributesFromTheNodeBefore(model, attributes, position) {
     const nodeBefore = position.nodeBefore;
     model.change((writer)=>{
@@ -2527,7 +2529,7 @@ const DEFAULT_TRANSFORMATIONS = [
  * Usage:
  *
  * ```ts
- * import inlineHighlight from '@ckeditor/ckeditor5-typing/src/utils/inlinehighlight';
+ * import { inlineHighlight } from '@ckeditor/ckeditor5-typing/src/utils/inlinehighlight';
  *
  * // Make `ck-link_selected` class be applied on an `a` element
  * // whenever the corresponding `linkHref` attribute element is selected.
@@ -2586,5 +2588,5 @@ const DEFAULT_TRANSFORMATIONS = [
     });
 }
 
-export { Delete, Input, InsertTextCommand, TextTransformation, TextWatcher, TwoStepCaretMovement, Typing, findAttributeRange, findAttributeRangeBound, getLastTextLine, inlineHighlight };
+export { Delete, DeleteCommand, Input, InsertTextCommand, TextTransformation, TextWatcher, TwoStepCaretMovement, Typing, TypingChangeBuffer, DeleteObserver as _DeleteObserver, findAttributeRange, findAttributeRangeBound, getLastTextLine, inlineHighlight };
 //# sourceMappingURL=index.js.map