Implement data node create and remove methods

Author: gohabereg

packages/dom-adapters/src/BlockToolAdapter/index.ts

@@ -3,7 +3,7 @@ import {
   BlockAddedEvent,
   BlockRemovedEvent,
   createDataKey,
-  type DataKey,
+  type DataKey, DataNodeAddedEvent, DataNodeRemovedEvent,
   type EditorJSModel,
   EventAction,
   EventType,
@@ -103,6 +103,8 @@ export class BlockToolAdapter implements BlockToolAdapterInterface {
     this.#formattingAdapter = formattingAdapter;
     this.#toolName = toolName;
 
+    this.#model.addEventListener(EventType.Changed, (event: ModelEvents) => this.#handleModelUpdate(event));
+
     eventBus.addEventListener(`ui:${BeforeInputUIEventName}`, (event: BeforeInputUIEvent) => {
       this.#processDelegatedBeforeInput(event);
     });
@@ -124,34 +126,64 @@ export class BlockToolAdapter implements BlockToolAdapterInterface {
 
     this.#attachedInputs.set(key, input);
 
-    this.#model.addEventListener(EventType.Changed, (event: ModelEvents) => this.#handleModelUpdate(event, input, key));
+    this.#model.createDataNode(
+      this.#config.userId,
+      this.#blockIndex,
+      key,
+      {
+        $t: 't',
+        value: '',
+      }
+    );
 
     const builder = new IndexBuilder();
 
     builder.addBlockIndex(this.#blockIndex).addDataKey(key);
 
     this.#caretAdapter.attachInput(input, builder.build());
 
-    try {
-      const value = this.#model.getText(this.#blockIndex, key);
-      const fragments = this.#model.getFragments(this.#blockIndex, key);
+    const value = this.#model.getText(this.#blockIndex, key);
+    const fragments = this.#model.getFragments(this.#blockIndex, key);
 
-      input.textContent = value;
+    input.textContent = value;
+
+    fragments.forEach(fragment => {
+      this.#formattingAdapter.formatElementContent(input, fragment);
+    });
+  }
+
+  /**
+   * Removes the input from the DOM by key
+   *
+   * @param keyRaw - key of the input to remove
+   */
+  public detachInput(keyRaw: string): void {
+    const key = createDataKey(keyRaw);
+    const input = this.#attachedInputs.get(key);
 
-      fragments.forEach(fragment => {
-        this.#formattingAdapter.formatElementContent(input, fragment);
-      });
-    } catch (_) {
-      // do nothing — TextNode is not created yet as there is no initial data in the model
+    if (!input) {
+      return;
     }
+
+    input.remove();
+    this.#caretAdapter.detachInput(
+      new IndexBuilder()
+        .addBlockIndex(this.#blockIndex)
+        .addDataKey(key)
+        .build()
+    );
+
+    this.#attachedInputs.delete(key);
+
+    this.#model.removeDataNode(this.#config.userId, this.#blockIndex, key);
   }
 
   /**
    * Check current selection and find it across all attached inputs
    *
    * @returns tuple of data key and input element or null if no focused input is found
    */
-  #findFocusedInput(): [DataKey, HTMLElement] | null {
+  #findFocusedInput(): [ DataKey, HTMLElement ] | null {
     const currentInput = Array.from(this.#attachedInputs.entries()).find(([_, input]) => {
       /**
        * Case 1: Input is a native input — check if it has selection
@@ -421,7 +453,7 @@ export class BlockToolAdapter implements BlockToolAdapterInterface {
       this.#config.userId,
       {
         name: this.#toolName,
-        data : {
+        data: {
           [key]: {
             $t: 't',
             value: newValueAfter,
@@ -454,32 +486,10 @@ export class BlockToolAdapter implements BlockToolAdapterInterface {
    * @param key - data key input is attached to
    */
   #handleModelUpdateForNativeInput(event: ModelEvents, input: HTMLInputElement | HTMLTextAreaElement, key: DataKey): void {
-    if (!(event instanceof TextAddedEvent) && !(event instanceof TextRemovedEvent)) {
-      return;
-    }
-
-    const { textRange, dataKey, blockIndex } = event.detail.index;
-
-    if (textRange === undefined) {
-      return;
-    }
-
-    /**
-     * Event is not related to the attached block
-     */
-    if (blockIndex !== this.#blockIndex) {
-      return;
-    }
-
-    /**
-     * Event is not related to the attached data key
-     */
-    if (dataKey !== key) {
-      return;
-    }
+    const { textRange } = event.detail.index;
 
     const currentElement = input;
-    const [start, end] = textRange;
+    const [start, end] = textRange!;
 
     const action = event.detail.action;
 
@@ -519,31 +529,10 @@ export class BlockToolAdapter implements BlockToolAdapterInterface {
    * @param key - data key input is attached to
    */
   #handleModelUpdateForContentEditableElement(event: ModelEvents, input: HTMLElement, key: DataKey): void {
-    if (!(event instanceof TextAddedEvent) && !(event instanceof TextRemovedEvent)) {
-      return;
-    }
-
-    const { textRange, dataKey, blockIndex } = event.detail.index;
-
-    if (blockIndex !== this.#blockIndex) {
-      return;
-    }
-
-    /**
-     * Event is not related to the attached data key
-     */
-    if (dataKey !== key) {
-      return;
-    }
-
-    if (textRange === undefined) {
-      return;
-    }
-
+    const { textRange } = event.detail.index;
     const action = event.detail.action;
 
-    const start = textRange[0];
-    const end = textRange[1];
+    const [start, end] = textRange!;
 
     const [startNode, startOffset] = getBoundaryPointByAbsoluteOffset(input, start);
     const [endNode, endOffset] = getBoundaryPointByAbsoluteOffset(input, end);
@@ -589,19 +578,50 @@ export class BlockToolAdapter implements BlockToolAdapterInterface {
    * @param input - attached input element
    * @param key - data key input is attached to
    */
-  #handleModelUpdate(event: ModelEvents, input: HTMLElement, key: DataKey): void {
+  #handleModelUpdate(event: ModelEvents): void {
     if (event instanceof BlockAddedEvent || event instanceof BlockRemovedEvent) {
       if (event.detail.index.blockIndex! <= this.#blockIndex) {
         this.#blockIndex += event.detail.action === EventAction.Added ? 1 : -1;
       }
+
+      return;
+    }
+
+    const { textRange, dataKey, blockIndex } = event.detail.index;
+
+    if (blockIndex !== this.#blockIndex) {
+      return;
+    }
+
+
+    if (event instanceof DataNodeRemovedEvent) {
+      this.detachInput(dataKey as string);
+
+      return;
+    }
+
+    if (event instanceof DataNodeAddedEvent) {
+      /**
+       * @todo Decide how to handle this case as only BlockTool knows how to render an input
+       */
+    }
+
+    if (!(event instanceof TextAddedEvent) && !(event instanceof TextRemovedEvent)) {
+      return;
+    }
+
+    const input = this.#attachedInputs.get(dataKey!);
+
+    if (!input || textRange === undefined) {
+      return;
     }
 
     const isInputNative = isNativeInput(input);
 
     if (isInputNative === true) {
-      this.#handleModelUpdateForNativeInput(event, input as HTMLInputElement | HTMLTextAreaElement, key);
+      this.#handleModelUpdateForNativeInput(event, input as HTMLInputElement | HTMLTextAreaElement, dataKey!);
     } else {
-      this.#handleModelUpdateForContentEditableElement(event, input, key);
+      this.#handleModelUpdateForContentEditableElement(event, input, dataKey!);
     }
   };
 }

packages/dom-adapters/src/CaretAdapter/index.ts

@@ -97,6 +97,14 @@ export class CaretAdapter extends EventTarget {
     this.#inputs.set(index.serialize(), input);
   }
 
+  /**
+   * Removes input from the caret adapter
+   * @param index - index of the input to remove
+   */
+  public detachInput(index: Index): void {
+    this.#inputs.delete(index.serialize());
+  }
+
   /**
    * Updates current user's caret index
    *

packages/model/src/EditorJSModel.spec.ts

@@ -22,6 +22,8 @@ describe('EditorJSModel', () => {
       'updateValue',
       'removeBlock',
       'moveBlock',
+      'createDataNode',
+      'removeDataNode',
       'getText',
       'insertText',
       'removeText',

packages/model/src/EditorJSModel.ts

@@ -257,6 +257,35 @@ export class EditorJSModel extends EventBus {
     this.#document.modifyData(index, data);
   }
 
+  /**
+   * Creates a data node (ValueNode or TextNode) with the specified key in the BlockNode at the specified index.
+   *
+   * @param _userId - user identifier which is being set to the context
+   * @param parameters - updateValue method parameters
+   * @param parameters.blockIndex - The index of the BlockNode to update
+   * @param parameters.dataKey - The key of the data node to create
+   * @param parameters.value - The initial value of the data node
+   * @throws Error if the index is out of bounds
+   */
+  @WithContext
+  public createDataNode(_userId: string | number, ...parameters: Parameters<EditorDocument['createDataNode']>): ReturnType<EditorDocument['createDataNode']> {
+    return this.#document.createDataNode(...parameters);
+  }
+
+  /**
+   * Removes a data node (ValueNode or TextNode) with the specified key in the BlockNode at the specified index.
+   *
+   * @param _userId - user identifier which is being set to the context
+   * @param parameters - updateValue method parameters
+   * @param parameters.blockIndex - The index of the BlockNode to update
+   * @param parameters.dataKey - The key of the data node to remove
+   * @throws Error if the index is out of bounds
+   */
+  @WithContext
+  public removeDataNode(_userId: string | number, ...parameters: Parameters<EditorDocument['removeDataNode']>): ReturnType<EditorDocument['removeDataNode']> {
+    return this.#document.removeDataNode(...parameters);
+  }
+
   /**
    * Updates the ValueNode data associated with the BlockNode at the specified index.
    *

packages/model/src/EventBus/events/DataNodeAddedEvent.ts

@@ -0,0 +1,22 @@
+import type { BlockNodeDataSerializedValue } from '../../entities/BlockNode/types/index.js';
+import type { Index } from '../../entities/Index/index.js';
+import { EventAction } from '../types/EventAction.js';
+import { BaseDocumentEvent } from './BaseEvent.js';
+
+
+/**
+ * DataNodeAdded Custom Event
+ */
+export class DataNodeAddedEvent extends BaseDocumentEvent<EventAction.Added,  BlockNodeDataSerializedValue> {
+  /**
+   * DataNodeAdded class constructor
+   *
+   * @param index - index of the added BlockNode in the document
+   * @param data - data serialized value
+   * @param userId - user identifier
+   */
+  constructor(index: Index, data: BlockNodeDataSerializedValue, userId: string | number) {
+    // Stryker disable next-line ObjectLiteral
+    super(index, EventAction.Added, data, userId);
+  }
+}

packages/model/src/EventBus/events/DataNodeRemovedEvent.ts

@@ -0,0 +1,22 @@
+import type { BlockNodeDataSerializedValue } from '../../entities/BlockNode/types/index.js';
+import type { Index } from '../../entities/Index/index.js';
+import { EventAction } from '../types/EventAction.js';
+import { BaseDocumentEvent } from './BaseEvent.js';
+
+
+/**
+ * DataNodeRemoved Custom Event
+ */
+export class DataNodeRemovedEvent extends BaseDocumentEvent<EventAction.Removed,  BlockNodeDataSerializedValue> {
+  /**
+   * DataNodeRemoved class constructor
+   *
+   * @param index - index of the added BlockNode in the document
+   * @param data - data serialized value
+   * @param userId - user identifier
+   */
+  constructor(index: Index, data: BlockNodeDataSerializedValue, userId: string | number) {
+    // Stryker disable next-line ObjectLiteral
+    super(index, EventAction.Removed, data, userId);
+  }
+}

packages/model/src/EventBus/events/index.ts

@@ -10,3 +10,5 @@ export * from './ValueModifiedEvent.js';
 export * from './CaretManagerCaretUpdatedEvent.js';
 export * from './CaretManagerCaretAddedEvent.js';
 export * from './CaretManagerCaretRemovedEvent.js';
+export * from './DataNodeAddedEvent.js';
+export * from './DataNodeRemovedEvent.js';