@kerebron/extension-basic-editor 0.2.1 → 0.4.2

package/esm/editor/src/DummyEditorView.js

@@ -0,0 +1,277 @@
+// Headless View to be used on Server-side
+// TODO: remove all unnecessary props and methods
+/// An editor view manages the DOM structure that represents an
+/// editable document. Its state and behavior are determined by its
+/// [props](#view.DirectEditorProps).
+export class DummyEditorView {
+    /// Create a view. `place` may be a DOM node that the editor should
+    /// be appended to, a function that will place it into the document,
+    /// or an object whose `mount` property holds the node to use as the
+    /// document container. If it is `null`, the editor will not be
+    /// added to the document.
+    constructor(props) {
+        /// @internal
+        Object.defineProperty(this, "_props", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "directPlugins", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /// @internal
+        Object.defineProperty(this, "nodeViews", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "prevDirectPlugins", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: []
+        });
+        Object.defineProperty(this, "pluginViews", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: []
+        });
+        /// The view's current [state](#state.EditorState).
+        Object.defineProperty(this, "state", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /// Indicates whether the editor is currently [editable](#view.EditorProps.editable).
+        Object.defineProperty(this, "editable", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this._props = props;
+        this.state = props.state;
+        this.directPlugins = props.plugins || [];
+        this.directPlugins.forEach(checkStateComponent);
+        this.dispatch = this.dispatch.bind(this);
+        this.editable = getEditable(this);
+        this.nodeViews = buildNodeViews(this);
+        // TODO initInput(this)
+        this.updatePluginViews();
+    }
+    /// Holds `true` when a
+    /// [composition](https://w3c.github.io/uievents/#events-compositionevents)
+    /// is active.
+    get composing() {
+        return false;
+    }
+    get dom() {
+        return {
+            addEventListener() { },
+            removeEventListener() { },
+        };
+    }
+    /// The view's current [props](#view.EditorProps).
+    get props() {
+        if (this._props.state != this.state) {
+            let prev = this._props;
+            this._props = {};
+            for (let name in prev)
+                this._props[name] = prev[name];
+            this._props.state = this.state;
+        }
+        return this._props;
+    }
+    /// Update the view's props. Will immediately cause an update to
+    /// the DOM.
+    update(props) {
+        let prevProps = this._props;
+        this._props = props;
+        if (props.plugins) {
+            props.plugins.forEach(checkStateComponent);
+            this.directPlugins = props.plugins;
+        }
+        this.updateStateInner(props.state, prevProps);
+    }
+    /// Update the view by updating existing props object with the object
+    /// given as argument. Equivalent to `view.update(Object.assign({},
+    /// view.props, props))`.
+    setProps(props) {
+        let updated = {};
+        for (let name in this._props) {
+            updated[name] = this._props[name];
+        }
+        updated.state = this.state;
+        for (let name in props)
+            updated[name] = props[name];
+        this.update(updated);
+    }
+    /// Update the editor's `state` prop, without touching any of the
+    /// other props.
+    updateState(state) {
+        this.updateStateInner(state, this._props);
+    }
+    updateStateInner(state, prevProps) {
+        let prev = this.state, redraw = false, updateSel = false;
+        // When stored marks are added, stop composition, so that they can
+        // be displayed.
+        if (state.storedMarks && this.composing) {
+            // TODO clearComposition(this)
+            updateSel = true;
+        }
+        this.state = state;
+        let pluginsChanged = prev.plugins != state.plugins ||
+            this._props.plugins != prevProps.plugins;
+        if (pluginsChanged || this._props.plugins != prevProps.plugins ||
+            this._props.nodeViews != prevProps.nodeViews) {
+            let nodeViews = buildNodeViews(this);
+            if (changedNodeViews(nodeViews, this.nodeViews)) {
+                this.nodeViews = nodeViews;
+                redraw = true;
+            }
+        }
+        this.editable = getEditable(this);
+        let updateDoc = redraw;
+        if (updateDoc || !state.selection.eq(prev.selection))
+            updateSel = true;
+        if (updateSel) {
+            // Work around an issue in Chrome, IE, and Edge where changing
+            // the DOM around an active selection puts it into a broken
+            // state where the thing the user sees differs from the
+            // selection reported by the Selection object (#710, #973,
+            // #1011, #1013, #1035).
+            let forceSelUpdate = false;
+            if (updateDoc) {
+                // If the node that the selection points into is written to,
+                // Chrome sometimes starts misreporting the selection, so this
+                // tracks that and forces a selection reset when our update
+                // did write to the node.
+                // TODO if (this.composing) this.input.compositionNode = findCompositionNode(this)
+            }
+        }
+        this.updatePluginViews(prev);
+    }
+    /// @internal
+    scrollToSelection() {
+    }
+    destroyPluginViews() {
+        let view;
+        while (view = this.pluginViews.pop())
+            if (view.destroy)
+                view.destroy();
+    }
+    updatePluginViews(prevState) {
+        if (!prevState || prevState.plugins != this.state.plugins ||
+            this.directPlugins != this.prevDirectPlugins) {
+            this.prevDirectPlugins = this.directPlugins;
+            this.destroyPluginViews();
+            for (let i = 0; i < this.directPlugins.length; i++) {
+                let plugin = this.directPlugins[i];
+                if (plugin.spec.view) {
+                    this.pluginViews.push(plugin.spec.view(this));
+                }
+            }
+            for (let i = 0; i < this.state.plugins.length; i++) {
+                let plugin = this.state.plugins[i];
+                if (plugin.spec.view) {
+                    this.pluginViews.push(plugin.spec.view(this));
+                }
+            }
+        }
+        else {
+            for (let i = 0; i < this.pluginViews.length; i++) {
+                let pluginView = this.pluginViews[i];
+                if (pluginView.update)
+                    pluginView.update(this, prevState);
+            }
+        }
+    }
+    someProp(propName, f) {
+        let prop = this._props && this._props[propName], value;
+        if (prop != null && (value = f ? f(prop) : prop)) {
+            return value;
+        }
+        for (let i = 0; i < this.directPlugins.length; i++) {
+            let prop = this.directPlugins[i].props[propName];
+            if (prop != null && (value = f ? f(prop) : prop)) {
+                return value;
+            }
+        }
+        let plugins = this.state.plugins;
+        if (plugins) {
+            for (let i = 0; i < plugins.length; i++) {
+                let prop = plugins[i].props[propName];
+                if (prop != null && (value = f ? f(prop) : prop))
+                    return value;
+            }
+        }
+    }
+    /// Query whether the view has focus.
+    hasFocus() {
+        return false;
+    }
+    /// Focus the editor.
+    focus() {
+    }
+    /// Removes the editor from the DOM and destroys all [node
+    /// views](#view.NodeView).
+    destroy() {
+        this.destroyPluginViews();
+    }
+    /// This is true when the view has been
+    /// [destroyed](#view.DummyEditorView.destroy) (and thus should not be
+    /// used anymore).
+    get isDestroyed() {
+        return false;
+    }
+    /// Used for testing.
+    dispatchEvent(event) {
+    }
+}
+DummyEditorView.prototype.dispatch = function (tr) {
+    let dispatchTransaction = this.props.dispatchTransaction;
+    if (dispatchTransaction)
+        dispatchTransaction.call(this, tr);
+    else
+        this.updateState(this.state.apply(tr));
+};
+function getEditable(view) {
+    return !view.someProp('editable', (value) => value(view.state) === false);
+}
+function buildNodeViews(view) {
+    let result = Object.create(null);
+    function add(obj) {
+        for (let prop in obj) {
+            if (!Object.prototype.hasOwnProperty.call(result, prop)) {
+                result[prop] = obj[prop];
+            }
+        }
+    }
+    view.someProp('nodeViews', add);
+    view.someProp('markViews', add);
+    return result;
+}
+function changedNodeViews(a, b) {
+    let nA = 0, nB = 0;
+    for (let prop in a) {
+        if (a[prop] != b[prop])
+            return true;
+        nA++;
+    }
+    for (let _ in b)
+        nB++;
+    return nA != nB;
+}
+function checkStateComponent(plugin) {
+    if (plugin.spec.state || plugin.spec.filterTransaction ||
+        plugin.spec.appendTransaction) {
+        throw new RangeError('Plugins passed directly to the view must not have a state component');
+    }
+}

package/esm/editor/src/Extension.d.ts

@@ -1,25 +1,30 @@
-import { Plugin } from 'prosemirror-state';
+import type { Plugin } from 'prosemirror-state';
+import type { Node, Schema, SchemaSpec } from 'prosemirror-model';
 import { type CoreEditor } from './CoreEditor.js';
-import { InputRule } from './plugins/input-rules/InputRulesPlugin.js';
-import { Commands, CommandShortcuts } from './commands/mod.js';
-import { Schema, type SchemaSpec } from 'prosemirror-model';
+import type { InputRule } from './plugins/input-rules/InputRulesPlugin.js';
+import { CommandFactories, CommandShortcuts } from './commands/mod.js';
 export interface ExtensionConfig {
     [key: string]: any;
     requires: Array<Extension | string>;
 }
 export interface Converter {
-    fromDoc(document: unknown): void;
-    toDoc(content: unknown): any;
+    fromDoc(document: Node): Promise<Uint8Array>;
+    toDoc(content: Uint8Array): Promise<Node>;
 }
 export declare abstract class Extension {
     protected config: Partial<ExtensionConfig>;
     readonly type = "extension";
     abstract name: string;
-    protected constructor(config?: Partial<ExtensionConfig>);
+    protected editor: CoreEditor;
+    readonly conflicts?: Array<string>;
+    constructor(config?: Partial<ExtensionConfig>);
+    setEditor(editor: CoreEditor): void;
+    getEditor(): CoreEditor;
+    created(): void;
     getInputRules(): InputRule[];
-    getProseMirrorPlugins(editor: CoreEditor, schema: Schema): Plugin[];
-    getCommands(editor: CoreEditor): Partial<Commands>;
-    getKeyboardShortcuts(): Partial<CommandShortcuts>;
+    getProseMirrorPlugins(): Plugin[];
+    getCommandFactories(editor: CoreEditor): Partial<CommandFactories>;
+    getKeyboardShortcuts(editor: CoreEditor): Partial<CommandShortcuts>;
     getConverters(editor: CoreEditor, schema: Schema): Record<string, Converter>;
     setupSpec(spec: SchemaSpec): void;
 }

package/esm/editor/src/Extension.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Extension.d.ts","sourceRoot":"","sources":["../../../src/editor/src/Extension.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAE3C,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,2CAA2C,CAAC;AACtE,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAC/D,OAAO,EAAE,MAAM,EAAE,KAAK,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAE5D,MAAM,WAAW,eAAe;IAE9B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;IAEnB,QAAQ,EAAE,KAAK,CAAC,SAAS,GAAG,MAAM,CAAC,CAAC;CACrC;AAED,MAAM,WAAW,SAAS;IACxB,OAAO,CAAC,QAAQ,EAAE,OAAO,GAAG,IAAI,CAAC;IACjC,KAAK,CAAC,OAAO,EAAE,OAAO,GAAG,GAAG,CAAC;CAC9B;AAED,8BAAsB,SAAS;IAIP,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,eAAe,CAAC;IAHhE,QAAQ,CAAC,IAAI,eAAe;IAC5B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB,SAAS,aAAuB,MAAM,GAAE,OAAO,CAAC,eAAe,CAAM;IAGrE,aAAa,IAAI,SAAS,EAAE;IAI5B,qBAAqB,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE;IAInE,WAAW,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,QAAQ,CAAC;IAIlD,oBAAoB,IAAI,OAAO,CAAC,gBAAgB,CAAC;IAIjD,aAAa,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC;IAI5E,SAAS,CAAC,IAAI,EAAE,UAAU;CAE3B"}
+{"version":3,"file":"Extension.d.ts","sourceRoot":"","sources":["../../../src/editor/src/Extension.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAElE,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,2CAA2C,CAAC;AAC3E,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAEvE,MAAM,WAAW,eAAe;IAE9B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;IAEnB,QAAQ,EAAE,KAAK,CAAC,SAAS,GAAG,MAAM,CAAC,CAAC;CACrC;AAED,MAAM,WAAW,SAAS;IACxB,OAAO,CAAC,QAAQ,EAAE,IAAI,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAC7C,KAAK,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC3C;AAED,8BAAsB,SAAS;IAOV,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,eAAe,CAAC;IAN7D,QAAQ,CAAC,IAAI,eAAe;IAC5B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,MAAM,EAAG,UAAU,CAAC;IAE9B,QAAQ,CAAC,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;gBAEN,MAAM,GAAE,OAAO,CAAC,eAAe,CAAM;IAGlE,SAAS,CAAC,MAAM,EAAE,UAAU;IAI5B,SAAS;IAIT,OAAO;IAGP,aAAa,IAAI,SAAS,EAAE;IAI5B,qBAAqB,IAAI,MAAM,EAAE;IAIjC,mBAAmB,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAIlE,oBAAoB,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAInE,aAAa,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC;IAI5E,SAAS,CAAC,IAAI,EAAE,UAAU;CAE3B"}

package/esm/editor/src/Extension.js

@@ -12,17 +12,37 @@ export class Extension {
             writable: true,
             value: 'extension'
         });
+        Object.defineProperty(this, "editor", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "conflicts", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+    }
+    setEditor(editor) {
+        this.editor = editor;
+    }
+    getEditor() {
+        return this.editor;
+    }
+    created() {
     }
     getInputRules() {
         return [];
     }
-    getProseMirrorPlugins(editor, schema) {
+    getProseMirrorPlugins() {
         return [];
     }
-    getCommands(editor) {
+    getCommandFactories(editor) {
         return {};
     }
-    getKeyboardShortcuts() {
+    getKeyboardShortcuts(editor) {
         return {};
     }
     getConverters(editor, schema) {

package/esm/editor/src/ExtensionManager.d.ts

@@ -1,12 +1,12 @@
 import { Schema } from 'prosemirror-model';
 import { Plugin } from 'prosemirror-state';
 import { NodeViewConstructor } from 'prosemirror-view';
-import { Extension } from './Extension.js';
-import { AnyExtension } from './types.js';
+import { Converter, Extension } from './Extension.js';
+import { AnyExtension, AnyExtensionOrReq } from './types.js';
 import { CoreEditor } from './CoreEditor.js';
 import { Mark } from './Mark.js';
 import { Node } from './Node.js';
-import { type Command } from 'prosemirror-state';
+import { type CommandManager } from './commands/CommandManager.js';
 export declare function findDuplicates(items: any[]): any[];
 export declare function splitExtensions(extensions: Iterable<AnyExtension>): {
     baseExtensions: Extension[];
@@ -15,18 +15,18 @@ export declare function splitExtensions(extensions: Iterable<AnyExtension>): {
 };
 export declare class ExtensionManager {
     private editor;
+    private commandManager;
     readonly schema: Schema;
     private extensions;
     readonly plugins: Plugin[];
     readonly nodeViews: Record<string, NodeViewConstructor>;
-    readonly commandConstructors: {
-        [key: string]: () => Command;
-    };
-    private converters;
+    converters: Record<string, Converter>;
     private debug;
-    constructor(extensions: Set<AnyExtension>, editor: CoreEditor);
-    private getPlugins;
+    constructor(extensions: AnyExtensionOrReq[], editor: CoreEditor, commandManager: CommandManager);
+    getExtension<T extends Extension>(name: string): T | undefined;
+    private initPlugins;
     private setupExtensions;
     getSchemaByResolvedExtensions(editor: CoreEditor): Schema;
+    created(): void;
 }
 //# sourceMappingURL=ExtensionManager.d.ts.map

package/esm/editor/src/ExtensionManager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ExtensionManager.d.ts","sourceRoot":"","sources":["../../../src/editor/src/ExtensionManager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsB,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC/D,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAE3C,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAEvD,OAAO,EAAa,SAAS,EAAE,MAAM,gBAAgB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAMjC,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAGjD,wBAAgB,cAAc,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,GAAG,EAAE,CAIlD;AAED,wBAAgB,eAAe,CAAC,UAAU,EAAE,QAAQ,CAAC,YAAY,CAAC;;;;EAgBjE;AAED,qBAAa,gBAAgB;IAYgB,OAAO,CAAC,MAAM;IAXzD,SAAgB,MAAM,EAAE,MAAM,CAAC;IAE/B,OAAO,CAAC,UAAU,CAAgC;IAClD,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;IAC3B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAM;IAE7D,QAAQ,CAAC,mBAAmB,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,OAAO,CAAA;KAAE,CAAM;IACpE,OAAO,CAAC,UAAU,CAAiC;IAEnD,OAAO,CAAC,KAAK,CAAQ;gBAET,UAAU,EAAE,GAAG,CAAC,YAAY,CAAC,EAAU,MAAM,EAAE,UAAU;IAcrE,OAAO,CAAC,UAAU;IAkIlB,OAAO,CAAC,eAAe;IA6DvB,6BAA6B,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM;CA6C1D"}
+{"version":3,"file":"ExtensionManager.d.ts","sourceRoot":"","sources":["../../../src/editor/src/ExtensionManager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsB,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC/D,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAEvD,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAC7D,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AASjC,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAGnE,wBAAgB,cAAc,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,GAAG,EAAE,CAIlD;AAED,wBAAgB,eAAe,CAAC,UAAU,EAAE,QAAQ,CAAC,YAAY,CAAC;;;;EAgBjE;AAED,qBAAa,gBAAgB;IAazB,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,cAAc;IAbxB,SAAgB,MAAM,EAAE,MAAM,CAAC;IAE/B,OAAO,CAAC,UAAU,CAAgC;IAClD,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,CAAM;IAChC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAM;IAEtD,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAM;IAElD,OAAO,CAAC,KAAK,CAAQ;gBAGnB,UAAU,EAAE,iBAAiB,EAAE,EACvB,MAAM,EAAE,UAAU,EAClB,cAAc,EAAE,cAAc;IAcxC,YAAY,CAAC,CAAC,SAAS,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IAY9D,OAAO,CAAC,WAAW;IAkHnB,OAAO,CAAC,eAAe;IAwEvB,6BAA6B,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM;IAkDzD,OAAO;CAOR"}