feat(core): implement Clipboard Plugin

packages/core/src/api/SelectionAPI.ts

@@ -2,7 +2,7 @@ import 'reflect-metadata';
 import { inject, injectable } from 'inversify';
 
 import { SelectionManager } from '../components/SelectionManager.js';
-import { Caret, CaretManagerEvents, createInlineToolName, EditorJSModel, EventType } from '@editorjs/model';
+import { Caret, CaretManagerEvents, createInlineToolName, EditorJSModel, EventType, BlockNodeSerialized } from '@editorjs/model';
 import { CoreConfigValidated } from '@editorjs/sdk';
 import { SelectionAPI as SelectionApiInterface } from '@editorjs/sdk';
 import { TOKENS } from '../tokens.js';
@@ -70,4 +70,11 @@ export class SelectionAPI implements SelectionApiInterface {
   public getCaret(userId = this.#config.userId): Caret | undefined {
     return this.#model.getCaret(userId);
   }
+
+  /**
+   *
+   */
+  public get selectedBlocks(): BlockNodeSerialized[] | null {
+    return this.#selectionManager.selectedBlocks();
+  }
 }

packages/core/src/components/SelectionManager.ts

@@ -4,7 +4,7 @@ import {
   createInlineToolData,
   FormattingAction,
   InlineFragment,
-  InlineToolName
+  InlineToolName, BlockNodeSerialized
 } from '@editorjs/model';
 import { CaretManagerCaretUpdatedEvent, Index, EditorJSModel, createInlineToolName } from '@editorjs/model';
 import { EventType } from '@editorjs/model';
@@ -177,4 +177,32 @@ export class SelectionManager {
       }
     }
   };
+
+  /**
+   *
+   */
+  public selectedBlocks(): BlockNodeSerialized[] | null {
+    const userCaret = this.#model.getCaret(this.#config.userId);
+    const index = userCaret?.index ?? null;
+
+    if (index === null) {
+      return null;
+    }
+
+    if (index.isBlockIndex) {
+      const { blockIndex } = index;
+
+      return [this.#model.serialized.blocks[blockIndex!]];
+    }
+
+    if (index.compositeSegments !== undefined) {
+      return index.compositeSegments.map((segment) => {
+        const { blockIndex } = segment;
+
+        return this.#model.serialized.blocks[blockIndex!];
+      });
+    }
+
+    return null;
+  }
 }

packages/core/src/index.ts

@@ -24,6 +24,8 @@ import { BlockRenderer } from './components/BlockRenderer.js';
 import { SelectionManager } from './components/SelectionManager.js';
 import { TOKENS } from './tokens.js';
 import { UndoRedoManager } from './components/UndoRedoManager.js';
+import { ClipboardPlugin } from './plugins/ClipboardPlugin.js';
+
 /**
  * If no holder is provided via config, the editor will be appended to the element with this id
  */
@@ -107,6 +109,7 @@ export default class Core {
     this.use(ShortcutsPlugin);
     this.use(CollaborationManager);
     this.use(DOMAdapters);
+    this.use(ClipboardPlugin);
   }
 
   /**

packages/core/src/plugins/ClipboardPlugin.ts

@@ -0,0 +1,76 @@
+import type { CopyUIEvent, EditorAPI, EditorjsPlugin, EditorjsPluginParams } from '@editorjs/sdk';
+import { CopyUIEventName } from '@editorjs/sdk';
+import { PluginType } from '@editorjs/sdk';
+
+/**
+ * @todo update doc
+ */
+export class ClipboardPlugin implements EditorjsPlugin {
+  public static readonly type = PluginType.Plugin;
+
+  readonly #api: EditorAPI;
+
+  /**
+   * @param params @todo update doc
+   */
+  constructor(params: EditorjsPluginParams) {
+    const { api, eventBus } = params;
+
+    this.#api = api;
+
+    eventBus.addEventListener(`ui:${CopyUIEventName}`, (e: CopyUIEvent) => {
+      const { nativeEvent } = e.detail;
+
+      const selectedBlocks = this.#api.selection.selectedBlocks;
+
+      /**
+       * Don't override native event if there are no blocks selected
+       */
+      if (selectedBlocks === null || selectedBlocks.length === 0) {
+        return;
+      }
+
+      const currentDOMSelection = window.getSelection();
+
+      if (!currentDOMSelection) {
+        return;
+      }
+
+      const selectionAsPlainText = currentDOMSelection.toString();
+      const selectionAsHTML = this.#parseDOMSelectionToHTML(currentDOMSelection);
+
+      nativeEvent.preventDefault();
+
+      nativeEvent.clipboardData?.setData('text/plain', selectionAsPlainText);
+      nativeEvent.clipboardData?.setData('text/html', selectionAsHTML);
+      nativeEvent.clipboardData?.setData('application/x-editor-js', JSON.stringify(selectedBlocks));
+    });
+  }
+
+  /**
+   * @todo update doc
+   */
+  public destroy(): void {
+    // do nothing
+  }
+
+  /**
+   *
+   * @param selection
+   */
+  #parseDOMSelectionToHTML(selection: Selection): string {
+    if (selection.rangeCount === 0) {
+      return '';
+    }
+
+    const container = document.createElement('div');
+
+    for (let i = 0; i < selection.rangeCount; i++) {
+      const range = selection.getRangeAt(i);
+
+      container.appendChild(range.cloneContents());
+    }
+
+    return container.innerHTML;
+  }
+}

packages/model/src/entities/Index/index.ts

@@ -279,4 +279,12 @@ export class Index {
     /* Stryker disable next-line ConditionalExpression, LogicalOperator -- compound data-index predicate; .isDataIndex specs cover field combinations */
     return this.blockIndex !== undefined && this.tuneName === undefined && this.dataKey !== undefined && this.textRange === undefined;
   }
+
+  /**
+   * Returns true if index points to a composite index
+   */
+  public get isCompositeIndex(): boolean {
+    /* Stryker disable next-line ConditionalExpression, LogicalOperator -- compound composite-index predicate; .isCompositeIndex specs cover field combinations */
+    return this.compositeSegments !== undefined && this.compositeSegments.length > 0 && this.blockIndex === undefined && this.tuneName === undefined && this.dataKey === undefined && this.textRange === undefined;
+  }
 }

packages/sdk/src/api/SelectionAPI.ts

@@ -1,4 +1,4 @@
-import type { Caret, CaretManagerEvents } from '@editorjs/model';
+import type { Caret, CaretManagerEvents, BlockNodeSerialized } from '@editorjs/model';
 
 /**
  * Selection API interface
@@ -31,4 +31,9 @@ export interface SelectionAPI {
    * @param userId - user id. If not provided, returns for current user
    */
   getCaret(userId?: string | number): Caret | undefined;
+
+  /**
+   *
+   */
+  get selectedBlocks(): BlockNodeSerialized[] | null;
 }

packages/sdk/src/entities/EventBus/events/ui/CopyUIEvent.ts

@@ -0,0 +1,29 @@
+import { UIEventBase } from './UIEventBase.js';
+
+/**
+ * Name of the copy UI event (dispatched as `ui:copy`)
+ */
+export const CopyUIEventName = 'copy';
+
+/**
+ * Payload @todo update doc
+ */
+export interface CopyUIEventPayload {
+  /**
+   * Native ClipboardEvent
+   * UI does not call .preventDefault() for this event
+   */
+  nativeEvent: ClipboardEvent;
+}
+
+/**
+ * Delegated copy event from the editor @todo update doc
+ */
+export class CopyUIEvent extends UIEventBase<CopyUIEventPayload> {
+  /**
+   * @param payload - carries the original DOM `ClipboardEvent` as `nativeEvent` for providing rich clipboard data
+   */
+  constructor(payload: CopyUIEventPayload) {
+    super(CopyUIEventName, payload);
+  }
+}

packages/sdk/src/entities/EventBus/events/ui/index.ts

@@ -1,3 +1,4 @@
 export * from './UIEventBase.js';
 export * from './BeforeInputUIEvent.js';
 export * from './KeydownUIEvent.js';
+export * from './CopyUIEvent.js';

packages/ui/src/Blocks/Blocks.ts

@@ -1,6 +1,6 @@
 import type {
   BlockAddedCoreEvent,
-  BlockRemovedCoreEvent, EditorAPI,
+  BlockRemovedCoreEvent, CopyUIEvent, EditorAPI,
   EditorjsPlugin,
   EditorjsPluginParams
 } from '@editorjs/sdk';
@@ -9,7 +9,11 @@ import {
   UiComponentType,
   BeforeInputUIEvent
 } from '@editorjs/sdk';
-import type { EventBus } from '@editorjs/sdk';
+import type { EventBus,
+  BlockAddedCoreEvent,
+  BlockRemovedCoreEvent, CopyUIEventPayload,
+  EditorjsPlugin,
+  EditorjsPluginParams } from '@editorjs/sdk';
 import Style from './Blocks.module.pcss';
 import { isNativeInput, make } from '@editorjs/dom';
 import { BlocksHolderRenderedUIEvent, BlockSelectedUIEvent } from './events/index.js';
@@ -138,6 +142,14 @@ export class BlocksUI implements EditorjsPlugin {
       e.preventDefault();
     });
 
+    blocksHolder.addEventListener('copy', (e) => {
+      const payload: CopyUIEventPayload = {
+        nativeEvent: e,
+      };
+
+      this.#eventBus.dispatchEvent(new CopyUIEvent(payload));
+    });
+
     return blocksHolder;
   }