Merge pull request #579 from prezly/refactor/dev-19138-drop-unused-ex…

…tension-interface-methods

[DEV-19138] Refactor - Drop unused extension interface methods

packages/slate-commons/src/types/Extension.ts

@@ -3,11 +3,9 @@ import type { Element, Node } from 'slate';
 import type { DecorateFactory } from './DecorateFactory';
 import type { DeserializeHtml } from './DeserializeHtml';
 import type { Normalize } from './Normalize';
-import type { OnDOMBeforeInput } from './OnDOMBeforeInput';
 import type { OnKeyDown } from './OnKeyDown';
 import type { RenderElement } from './RenderElement';
 import type { RenderLeaf } from './RenderLeaf';
-import type { Serialize } from './Serialize';
 import type { WithOverrides } from './WithOverrides';
 
 export interface Extension {
@@ -24,10 +22,8 @@ export interface Extension {
     isRichBlock?: (node: Node) => boolean;
     isVoid?: (node: Node) => boolean;
     normalizeNode?: Normalize | Normalize[];
-    onDOMBeforeInput?: OnDOMBeforeInput;
     onKeyDown?: OnKeyDown | null;
     renderElement?: RenderElement;
     renderLeaf?: RenderLeaf;
-    serialize?: Serialize;
     withOverrides?: WithOverrides;
 }

packages/slate-commons/src/types/index.ts

@@ -3,7 +3,6 @@ export type { DecorateFactory } from './DecorateFactory';
 export type { DeserializeHtml, DeserializeElement, DeserializeMarks } from './DeserializeHtml';
 export type { Extension } from './Extension';
 export type { Normalize } from './Normalize';
-export type { OnDOMBeforeInput } from './OnDOMBeforeInput';
 export type { OnKeyDown } from './OnKeyDown';
 export type { RenderElement } from './RenderElement';
 export type { RenderLeaf } from './RenderLeaf';

packages/slate-editor/src/index.ts

@@ -31,15 +31,13 @@ import type {
     DefaultTextBlockEditor,
     ElementsEqualityCheckEditor,
     RichBlocksAwareEditor,
-    SerializingEditor,
 } from '#modules/editor';
 
 type Editor = BaseEditor &
     HistoryEditor &
     DefaultTextBlockEditor<ParagraphNode> &
     ElementsEqualityCheckEditor &
     RichBlocksAwareEditor &
-    SerializingEditor &
     FlashEditor;
 
 declare module 'slate' {

packages/slate-editor/src/modules/editable/EditableWithExtensions.tsx

@@ -2,7 +2,6 @@
 import type {
     Decorate,
     Extension,
-    OnDOMBeforeInput,
     OnKeyDown,
     RenderElement,
     RenderLeaf,
@@ -14,7 +13,6 @@ import React, { useCallback, useMemo } from 'react';
 
 import {
     combineDecorate,
-    combineOnDOMBeforeInput,
     combineOnKeyDown,
     combineRenderElement,
     combineRenderLeaf,
@@ -37,9 +35,7 @@ export interface Props {
      */
     extensions?: Extension[];
     onCut?: (event: React.ClipboardEvent<HTMLDivElement>) => void;
-    onDOMBeforeInput?: OnDOMBeforeInput[];
-    // Dependencies of `onDOMBeforeInput`
-    onDOMBeforeInputDeps?: any[];
+    onDOMBeforeInput?: (event: InputEvent) => void;
     /**
      * Handlers when we press a key
      */
@@ -73,8 +69,7 @@ export function EditableWithExtensions({
     decorate,
     editor,
     extensions = [],
-    onDOMBeforeInput: onDOMBeforeInputList = [],
-    onDOMBeforeInputDeps = [],
+    onDOMBeforeInput,
     onKeyDown: onKeyDownList = [],
     onKeyDownDeps = [],
     renderElement: renderElementList = [],
@@ -90,10 +85,6 @@ export function EditableWithExtensions({
         },
         [decorate, editor, extensions],
     );
-    const combinedOnDOMBeforeInput = useCallback(
-        combineOnDOMBeforeInput(editor, extensions, onDOMBeforeInputList),
-        onDOMBeforeInputDeps,
-    );
     const combinedOnKeyDown = useCallback(
         combineOnKeyDown(editor, extensions, onKeyDownList),
         onKeyDownDeps,
@@ -113,7 +104,7 @@ export function EditableWithExtensions({
             className={classNames(className, 'notranslate')}
             translate="no"
             decorate={combinedDecorate}
-            onDOMBeforeInput={combinedOnDOMBeforeInput}
+            onDOMBeforeInput={onDOMBeforeInput}
             onKeyDown={combinedOnKeyDown}
             renderElement={combinedRenderElement}
             renderLeaf={combinedRenderLeaf}

packages/slate-editor/src/modules/editable/lib/index.ts

@@ -1,5 +1,4 @@
 export { combineDecorate } from './combineDecorate';
-export { combineOnDOMBeforeInput } from './combineOnDOMBeforeInput';
 export { combineOnKeyDown } from './combineOnKeyDown';
 export { combineRenderElement } from './combineRenderElement';
 export { combineRenderLeaf } from './combineRenderLeaf';

packages/slate-editor/src/modules/editor/Editor.tsx

@@ -846,9 +846,7 @@ export const Editor = forwardRef<EditorRef, EditorProps>((props, forwardedRef) =
     const hasCustomPlaceholder =
         withFloatingAddMenu && (isEditorFocused(editor) || isFloatingAddMenuOpen);
 
-    const onChange = useOnChange((value) => {
-        props.onChange(editor.serialize(value) as Value);
-    });
+    const onChange = useOnChange(props.onChange);
 
     const floatingSnippetRenderInput = useFunction(() => {
         return (

packages/slate-editor/src/modules/editor/createEditor.ts

@@ -18,7 +18,6 @@ import {
     withDeserializeHtml,
     withElementsEqualityCheck,
     withRichBlocks,
-    withSerialization,
 } from './plugins';
 
 export function createEditor(
@@ -42,7 +41,6 @@ export function createEditor(
         withDeserializeHtml(getExtensions),
         withRichBlocks(getExtensions),
         withElementsEqualityCheck(getExtensions),
-        withSerialization(getExtensions),
         ...overrides,
     ])(baseEditor);
 }

packages/slate-editor/src/modules/editor/index.ts

@@ -6,13 +6,11 @@ export {
     withDeserializeHtml,
     withElementsEqualityCheck,
     withRichBlocks,
-    withSerialization,
 } from './plugins';
 export type {
     DefaultTextBlockEditor,
     ElementsEqualityCheckEditor,
     RichBlocksAwareEditor,
-    SerializingEditor,
 } from './plugins';
 export type { EditorRef, EditorProps, Value } from './types';
 export { useEditorEvents } from './useEditorEvents';

packages/slate-editor/src/modules/editor/lib/isEditorValueEqual.test.ts

@@ -1,5 +1,3 @@
-import { withoutNodes } from '@prezly/slate-commons';
-import { isQuoteNode } from '@prezly/slate-types';
 import { createEditor as createSlateEditor } from 'slate';
 
 import { createEditor } from '#modules/editor';
@@ -63,21 +61,4 @@ describe('isEditorValueEqual', () => {
 
         expect(isEditorValueEqual(editor, a, b)).toBe(true);
     });
-
-    it('should run pre-serialization cleanup from extensions', () => {
-        const editor = createEditor(createSlateEditor(), () => [
-            {
-                id: 'PreSerializationCleanup',
-                serialize: (nodes) => withoutNodes(nodes, isQuoteNode),
-            },
-        ]);
-
-        const a = [
-            { type: 'paragraph', children: [{ text: 'A wise man once said:' }] },
-            { type: 'block-quote', children: [{ text: 'Hello' }] },
-        ];
-        const b = [{ type: 'paragraph', children: [{ text: 'A wise man once said:' }] }];
-
-        expect(isEditorValueEqual(editor, a, b)).toBe(true);
-    });
 });

packages/slate-editor/src/modules/editor/lib/isEditorValueEqual.ts

@@ -39,7 +39,7 @@ export function isEditorValueEqual<T extends Descendant>(
         );
     }
 
-    return a === b || compareLists(editor.serialize(a), editor.serialize(b));
+    return a === b || compareLists(a, b);
 }
 
 function isText(node: Descendant): node is Text {

packages/slate-editor/src/modules/editor/plugins/index.ts

@@ -5,4 +5,3 @@ export {
     withElementsEqualityCheck,
 } from './withElementsEqualityCheck';
 export { type RichBlocksAwareEditor, withRichBlocks } from './withRichBlocks';
-export { type SerializingEditor, withSerialization } from './withSerialization';