edytor 2.0.0 → 4.0.0

package/dist/edytor.svelte.js

@@ -6,8 +6,9 @@ import { onCut } from './events/onCut.js';
 import { isControlEvent, isKindControl } from './events/nativeInteractiveControl.js';
 import { onInput } from './events/onInput.js';
 import { onPaste } from './events/onPaste.js';
-import { onDragLeave, onTextDragEnd, onTextDragStart, preventUnsupportedDrop } from './events/onDrop.js';
+import { onTextDragEnd, onTextDragStart, preventUnsupportedDrop } from './events/onDrop.js';
 import { attachFocus, selectionIsInside, takeKeys } from './events/onFocus.js';
+import { attachPageHide } from './events/onPageHide.js';
 import { insertLineBreak, runIntent } from './events/beforeInputCommands.js';
 import { textPointAt } from './selection/selection.utils.js';
 import { Attempts } from './session/attempt.js';
@@ -29,7 +30,7 @@ import Announcer from './components/Announcer.svelte';
 import RemoteSelections from './collaboration/RemoteSelections.svelte';
 import Ranges from './components/Ranges.svelte';
 import { Handles } from './session/handles.js';
-import { id } from './utils.js';
+import { cleanups, id } from './utils.js';
 import { Y } from './crdt/engine.js';
 import { markName } from './crdt/text/marks.js';
 import { callEach } from './crdt/protocols/observable.js';
@@ -193,11 +194,10 @@ export class Edytor {
     // CRDT (v14) — the document is the composition owner: it holds the ONE
     // engine doc, the shared facade (only structural read/write surface),
     // the default local history and the shared awareness. Injected
-    // documents are borrowed; a view with no `document` option internally
-    // owns one (built around `doc`/`awareness` when those are injected).
+    // documents are borrowed; a view with no `document` option owns a fresh one.
     document;
-    /** @internal `true` when this view created its document — `destroy()` then releases it. */
-    ownsDocument = false;
+    /** `true` when this view created its document — `destroy()` then releases it. */
+    #owned = false;
     get doc() {
         return this.document.doc;
     }
@@ -297,7 +297,7 @@ export class Edytor {
         this.dispatcher.record({ operation: command, status: this.history.replay(command) });
     };
     constructor(options) {
-        const { readonly, hotkeys, plugins, document, doc, awareness, actor, requireHydration, presence, sync, value, onSelectionChange, labels, onChange, onDocChange, allowNesting } = options;
+        const { readonly, hotkeys, plugins, document, actor, requireHydration, presence, sync, value, onSelectionChange, labels, onChange, onDocChange, allowNesting } = options;
         for (const name of DOCUMENT_WRITES)
             Object.defineProperty(this, name, {
                 value: (...args) => this.dispatcher.operate(name, args)
@@ -306,21 +306,14 @@ export class Edytor {
             this.labels = labels;
         this.allowNesting = allowNesting === true;
         if (document !== undefined) {
-            if (DEV &&
-                (doc !== undefined ||
-                    awareness !== undefined ||
-                    actor !== undefined ||
-                    requireHydration !== undefined)) {
-                throw new Error('EdytorOptions: `document` cannot be combined with `doc`/`awareness`/`actor`/`requireHydration` — ' +
-                    'the document owns them (compose them via attachDocument first).');
+            if (DEV && (actor !== undefined || requireHydration !== undefined)) {
+                throw new Error('EdytorOptions: `document` cannot be combined with `actor`/`requireHydration`: set them on the document.');
             }
             this.document = document;
         }
         else {
-            // Legacy path — the view internally owns a document composed
-            // around the injected (or a fresh) doc/awareness.
-            this.document = attachDocument(doc ?? new Y.Doc(), { awareness, actor, requireHydration });
-            this.ownsDocument = true;
+            this.document = attachDocument(new Y.Doc(), { actor, requireHydration });
+            this.#owned = true;
         }
         this.readonly = readonly || false;
         this.onChange = onChange;
@@ -388,7 +381,7 @@ export class Edytor {
             // decision; every other view binds on the one readiness event
             // (`<Edytor>` decides an injected document at mount, once the
             // providers of its sibling views attached).
-            if (this.ownsDocument && !sync) {
+            if (this.#owned && !sync) {
                 this.sync(value || { children: [] });
             }
             else {
@@ -409,7 +402,7 @@ export class Edytor {
             // document-lifetime additive declarations, and an injected
             // document's are left for the views that legitimately share it.
             this.document.untrackOrigin(this.transaction);
-            if (this.ownsDocument) {
+            if (this.#owned) {
                 this.document.destroy();
             }
             throw error;
@@ -611,9 +604,7 @@ export class Edytor {
                     // A failed async handler (a command's hook or write) surfaces
                     // through the platform's error reporting; the DOM ignores
                     // the listener's promise.
-                    void Promise.resolve(result)
-                        .finally(clear)
-                        .catch((error) => typeof reportError === 'function' ? reportError(error) : console.error(error));
+                    void Promise.resolve(result).finally(clear).catch(reportError);
                 }
                 else {
                     clear();
@@ -804,7 +795,9 @@ export class Edytor {
                 keydown(event);
         }), 
         // Pointer and focus ownership, and the focus-time caret restore.
-        ...attachFocus(this, node), on(node, 'mousedown', this.selection.pointer.preventTripleClick), on(node, 'click', this.selection.pointer.tripleClick), 
+        ...attachFocus(this, node), 
+        // The page leaving for good ends the session's history.
+        attachPageHide(this), on(node, 'mousedown', this.selection.pointer.preventTripleClick), on(node, 'click', this.selection.pointer.tripleClick), 
         // Settle queued mutation repairs before the native menu opens —
         // spellcheck suggestions are computed against the DOM at this
         // moment (PM flushes its DOM observer on contextmenu for the
@@ -812,7 +805,7 @@ export class Edytor {
         on(node, 'contextmenu', () => void this.surface.flush()), on(node, 'beforeinput', this.#withUserInput(this.onBeforeInput)), 
         // An `input` records what the browser did; it says nothing new about
         // where the user wants the selection (a display still to land wins).
-        on(node, 'input', this.#withUserInput(this.onInput, { bumpSerial: false })), on(node, 'copy', this.onCopy), on(node, 'cut', this.#withUserInput(this.onCut)), on(node, 'paste', this.#withUserInput(this.onPaste)), on(node, 'dragstart', (event) => onTextDragStart(this, event)), on(node, 'dragend', () => onTextDragEnd(this)), on(node, 'dragover', (event) => preventUnsupportedDrop(event, this)), on(node, 'dragleave', (event) => onDragLeave(this, event)), on(node, 'drop', this.#withUserInput((event) => preventUnsupportedDrop(event, this))), on(node, 'compositionstart', this.onCompositionStart), on(node, 'compositionend', this.onCompositionEnd), detachSurface);
+        on(node, 'input', this.#withUserInput(this.onInput, { bumpSerial: false })), on(node, 'copy', this.onCopy), on(node, 'cut', this.#withUserInput(this.onCut)), on(node, 'paste', this.#withUserInput(this.onPaste)), on(node, 'dragstart', (event) => onTextDragStart(this, event)), on(node, 'dragend', () => onTextDragEnd(this)), on(node, 'dragover', (event) => preventUnsupportedDrop(event, this)), on(node, 'drop', this.#withUserInput((event) => preventUnsupportedDrop(event, this))), on(node, 'compositionstart', this.onCompositionStart), on(node, 'compositionend', this.onCompositionEnd), detachSurface);
         // Chrome lives in the overlay, outside the host: remote carets, then the plugins'.
         const detachOverlay = this.overlay.attach(node);
         const presence = mount(RemoteSelections, {
@@ -830,11 +823,7 @@ export class Edytor {
             props: { announcer: this.announcer }
         });
         this.off.push(() => unmount(presence), () => unmount(ranges), () => unmount(live), detachOverlay);
-        this.plugins.forEach((plugin) => {
-            const action = plugin.onEdytorAttached?.({ node });
-            if (typeof action === 'function')
-                this.off.push(action);
-        });
+        this.off.push(...cleanups(this.plugins, (plugin) => plugin.onEdytorAttached?.({ node })));
         return {
             destroy: () => {
                 if (selectionIsInside(node))
@@ -864,7 +853,7 @@ export class Edytor {
      * discarded.
      *
      * Releases every listener the editor holds on potentially-SHARED objects
-     * — an injected doc/awareness outlives a single editor, so an
+     * — an injected document outlives a single editor, so an
      * undestroyed mount leaks a facade `update` listener and the undo
      * manager's doc observers forever.
      *
@@ -908,7 +897,7 @@ export class Edytor {
         // awareness, doc) belong to the document — released exactly once,
         // and only when THIS view created it. A borrowed document keeps
         // serving its sibling views and headless consumers.
-        if (this.ownsDocument) {
+        if (this.#owned) {
             this.document.destroy();
         }
     };

package/dist/events/beforeInputCommands.js

@@ -209,14 +209,14 @@ const splitKeepingChildren = (edytor, [id, offset, born, tail], child) => {
         return REFUSED;
     if (!child)
         return facade.compose({ ...split, writes: [step] });
-    // The rank of a first child, and the document's answer on placing the kind there.
+    // The document's answer on placing the kind as a first child.
     const slot = facade.prepare.insertBlocks({ parent: id, index: 0 }, [
         { id: born, type: tail?.type ?? facade.defaultChild(id) }
     ]);
     const first = 'writes' in slot ? slot.writes[0] : undefined;
     if (first?.op !== 'insertBlocks')
         return REFUSED;
-    const placed = { ...step, parent: id, rank: first.ranks[0] };
+    const placed = { ...step, parent: id, index: 0 };
     return facade.compose({ ...split, writes: [placed] });
 };
 /**

package/dist/events/onBeforeInput.js

@@ -7,7 +7,7 @@ import { isAndroidChromeBrowser } from './events.utils.js';
 import { isNativeInteractiveControl, isNativeInteractiveEvent, ownsEvent } from './nativeInteractiveControl.js';
 import { runBeforeInputCommand } from './beforeInputCommands.js';
 import { deleteInText } from './beforeInputDeleteCommands.js';
-import { readDomText } from './onInput.js';
+import { readDomText } from '../surface/observer.svelte.js';
 /** The Android no-op-Backspace and model-owned drift deadlines (named, counted browser rules). */
 const NATIVE_INPUT_REPAIR_WINDOW_MS = 150;
 const dirOf = (inputType) => INTENTS[inputType]?.dir;

package/dist/events/onDrop.d.ts

@@ -31,9 +31,3 @@ export declare const onTextDragEnd: (edytor: Edytor) => undefined;
  *   which is the control's (`isControlDrop`).
  */
 export declare const preventUnsupportedDrop: (event: DragEvent, edytor: Edytor) => void | Promise<void>;
-/**
- * A drag leaving the host (to the page around it, or out of the window):
- * a file drag's indicator goes. Moving between the host's own elements is
- * no leave.
- */
-export declare const onDragLeave: (edytor: Edytor, event: DragEvent) => void;

package/dist/events/onDrop.js

@@ -13,8 +13,9 @@ import { viewUploads } from '../session/uploads.js';
  * `Files` is intentionally accepted (so the browser never opens a dropped
  * file in place of the page): with the view's uploads (a media plugin given
  * an `upload`), file drops route through the plugin `onPaste` hook with the
- * drop indicator's placement (`ViewUploads.drop`: a block per file the kinds
- * take there; unclaimed files insert nothing); without them a drop carrying
+ * placement the uploads' drop target resolved (`ViewUploads.drop`, Pragmatic's
+ * external adapter: a block per file the kinds take there; unclaimed files
+ * insert nothing); without them a drop carrying
  * files is ignored, its effect `none`.
  */
 const ACCEPTED_FOREIGN_DROP_TYPES = ['Files', 'text/html', 'text/plain', 'text/uri-list'];
@@ -188,21 +189,19 @@ export const preventUnsupportedDrop = (event, edytor) => {
         if (isAcceptedForeignDrop(root, event.dataTransfer)) {
             event.preventDefault();
             event.stopPropagation();
-            // Files show where they land (the block drag's indicator); none in a
-            // read-only view or one without uploads, which takes no file drop (the
-            // browser must not open the file).
-            const shown = drop && !ownsEvent(root, event) && drop.over(event);
+            // Where files land shows from the uploads' drop target (Pragmatic's
+            // external adapter); a read-only view or one without uploads takes no
+            // file drop, and the browser must not open the file.
             if (event.dataTransfer)
                 event.dataTransfer.dropEffect = files && (edytor.readonly || !drop) ? 'none' : 'copy';
-            if (drop && !shown)
-                drop.end();
         }
         return;
     }
     const accepted = isAcceptedForeignDrop(root, event.dataTransfer);
-    // Where the files land: the indicator's placement, re-resolved at the drop point.
-    const at = drop && accepted && !ownsEvent(root, event) ? drop.at(event) : null;
-    drop?.end();
+    // Where the files land: the placement the uploads' drop target resolved at
+    // the drop point (its window listener captures, so it ran first).
+    const placed = drop?.take() ?? null;
+    const at = accepted && !ownsEvent(root, event) ? placed : null;
     if (accepted && isControlDrop(root, event))
         return;
     event.preventDefault();
@@ -219,15 +218,3 @@ export const preventUnsupportedDrop = (event, edytor) => {
     if (!edytor.isComposing)
         return insertFromDrop(edytor, root, event, at);
 };
-/**
- * A drag leaving the host (to the page around it, or out of the window):
- * a file drag's indicator goes. Moving between the host's own elements is
- * no leave.
- */
-export const onDragLeave = (edytor, event) => {
-    const root = event.currentTarget;
-    const to = event.relatedTarget;
-    if (to instanceof Node && root.contains(to))
-        return;
-    viewUploads(edytor)?.drop.end();
-};

package/dist/events/onInput.d.ts

@@ -1,16 +1,4 @@
 import type { Edytor } from '../edytor.svelte.js';
-import type { Text } from '../text/text.svelte.js';
-/**
- * What the browser shows for `text`: its element's text nodes in order (WebKit's
- * converted-space wrappers read as plain spaces), the empty filler and the
- * trailing-newline marker stripped.
- */
-export declare const readDomText: (text: Text) => string;
-export declare const getCollapsedDomTextSelection: (edytor: Edytor) => {
-    text: Text;
-    offset: number;
-} | null;
-export declare const handleNativeLineBreakTextValue: (edytor: Edytor, text: Text, value: string) => Promise<boolean>;
 /**
  * An `input` event. Browser-made text is never adopted here: the mutation
  * queue is the only adopter (a native line break there runs as its

package/dist/events/onInput.js

@@ -1,76 +1,10 @@
-import { diffText } from '../utils/diffText.js';
-import { getDomSelectionSnapshot } from '../selection/domSelection.js';
-import { domOffsetIn } from '../selection/selection.utils.js';
 import { isControlEvent } from './nativeInteractiveControl.js';
-import { runOccurrence } from './onBeforeInput.js';
 import { attemptOf, kindOf } from '../session/attempt.js';
-const ZERO_WIDTH_SPACE = '\u200B';
-/**
- * What the browser shows for `text`: its element's text nodes in order (WebKit's
- * converted-space wrappers read as plain spaces), the empty filler and the
- * trailing-newline marker stripped.
- */
-export const readDomText = (text) => {
-    let value = '';
-    const node = text.node;
-    if (node) {
-        const walker = (node.ownerDocument ?? document).createTreeWalker(node, NodeFilter.SHOW_TEXT);
-        while (walker.nextNode()) {
-            const leaf = walker.currentNode;
-            value += leaf.parentElement?.closest('span.Apple-converted-space')
-                ? leaf.data.replaceAll('\u00A0', ' ')
-                : leaf.data;
-        }
-    }
-    // An empty text's filler shares its node with what the browser typed, on either side.
-    if (text.isEmpty)
-        return value.replaceAll(ZERO_WIDTH_SPACE, '');
-    if (text.endsWithNewline && value.endsWith(ZERO_WIDTH_SPACE)) {
-        value = value.slice(0, -ZERO_WIDTH_SPACE.length);
-    }
-    return value;
-};
-export const getCollapsedDomTextSelection = (edytor) => {
-    const selection = getDomSelectionSnapshot(edytor.node);
-    if (!selection?.anchorNode || !selection.isCollapsed) {
-        return null;
-    }
-    if (!edytor.node?.contains(selection.anchorNode)) {
-        return null;
-    }
-    const text = edytor.selection.getTextOfNode(selection.anchorNode);
-    if (!text?.node) {
-        return null;
-    }
-    // No model rule here: the DOM caret is read BEFORE the reconcile writes
-    // the model, so a native insertion legitimately sits past `text.length`
-    // (`selectText` clamps the final write).
-    return { text, offset: domOffsetIn(text, selection.anchorNode, selection.anchorOffset) };
-};
+import { getCollapsedDomTextSelection } from '../surface/observer.svelte.js';
 const getInputType = (event) => {
     const inputType = event.inputType;
     return typeof inputType === 'string' ? inputType : '';
 };
-const getNativeLineBreakInsertionIndexFromValue = (text, value) => {
-    const change = diffText(text.stringContent, value);
-    return change && !change.remove && /^[\r\n]+$/.test(change.insert) ? change.at : null;
-};
-export const handleNativeLineBreakTextValue = async (edytor, text, value) => {
-    if (!text.isInDocument)
-        return false;
-    const insertionIndex = getNativeLineBreakInsertionIndexFromValue(text, value);
-    if (insertionIndex === null) {
-        return false;
-    }
-    // The native line break is the key's occurrence: its intent, run by the model.
-    const inputType = edytor.attempts.confirm()?.inputType === 'insertLineBreak' || value.includes('\n')
-        ? 'insertLineBreak'
-        : 'insertParagraph';
-    text.refreshFromModel();
-    edytor.selection.selectText(text, insertionIndex);
-    await runOccurrence(edytor, { inputType, cancelable: false });
-    return true;
-};
 /**
  * An `input` no attempt expected (its engine sent no `beforeinput`): the
  * browser changed the text under its caret — a browser-owned attempt of its own.

package/dist/events/onPageHide.d.ts

@@ -0,0 +1,3 @@
+import type { Edytor } from '../edytor.svelte.js';
+/** End the view's session when its page leaves for good; answers the teardown. */
+export declare const attachPageHide: (edytor: Edytor) => (() => void);

package/dist/events/onPageHide.js

@@ -0,0 +1,16 @@
+/**
+ * The page leaves for good (installed by `Edytor.attach`): a `pagehide` the
+ * back/forward cache keeps nothing of. The view tells its document the
+ * session's history ended (`document.endHistory()`, `hist.release.end`): the
+ * history's rule releases what the session deleted. A page the cache keeps
+ * may come back with its history, and a lost connection fires nothing here:
+ * both keep it.
+ *
+ * The page's lifecycle is the sync layer's (`onPageLeave`, which the
+ * providers leave by too): the view subscribes to its `write` phase, run
+ * before the providers' teardown whatever order they subscribed in, so the
+ * release goes out on a socket or store that is still open.
+ */
+import { onPageLeave } from '../crdt/providers/room.js';
+/** End the view's session when its page leaves for good; answers the teardown. */
+export const attachPageHide = (edytor) => onPageLeave(() => edytor.document.endHistory(), 'write');