@dxos/react-ui-editor 0.6.14-main.2b6a0f3 → 0.6.14-main.69511f5

package/dist/types/src/util/index.d.ts

@@ -0,0 +1,6 @@
+export * from './cursor';
+export * from './debug';
+export * from './dom';
+export * from './facet';
+export * from './react';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/src/util/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/util/index.ts"],"names":[],"mappings":"AAIA,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,OAAO,CAAC;AACtB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC"}

package/dist/types/src/util/react.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"react.d.ts","sourceRoot":"","sources":["../../../../src/util/react.tsx"],"names":[],"mappings":"AAIA,OAAc,EAAE,KAAK,SAAS,EAAE,MAAM,OAAO,CAAC;AAQ9C,MAAM,MAAM,cAAc,GAAG;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,eAAO,MAAM,aAAa,QAAS,MAAM,YAAY,cAAc,aAAa,SAAS,KAAG,WAU3F,CAAC;AAIF,eAAO,MAAM,UAAU,GAAI,CAAC,SAAS,OAAO,QAAQ,CAAC,QAAQ,SAAS,KAAG,CAGxE,CAAC"}

package/package.json

@@ -1,37 +1,22 @@
 {
   "name": "@dxos/react-ui-editor",
-  "version": "0.6.14-main.2b6a0f3",
+  "version": "0.6.14-main.69511f5",
   "description": "Document editing experience within a DXOS shell.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
   "license": "MIT",
   "author": "DXOS.org",
-  "sideEffects": false,
+  "sideEffects": true,
   "exports": {
     ".": {
+      "types": "./dist/types/src/index.d.ts",
       "browser": "./dist/lib/browser/index.mjs",
-      "node": {
-        "require": "./dist/lib/node/index.cjs",
-        "default": "./dist/lib/node-esm/index.mjs"
-      },
-      "types": "./dist/types/src/index.d.ts"
-    },
-    "./state": {
-      "browser": "./dist/lib/browser/state/index.mjs",
-      "node": {
-        "require": "./dist/lib/node/state/index.cjs",
-        "default": "./dist/lib/node-esm/state/index.mjs"
-      },
-      "types": "./dist/types/src/state/index.d.ts"
+      "node": "./dist/lib/node-esm/index.mjs"
     }
   },
   "types": "dist/types/src/index.d.ts",
   "typesVersions": {
-    "*": {
-      "state": [
-        "dist/types/src/state/index.d.ts"
-      ]
-    }
+    "*": {}
   },
   "files": [
     "dist",
@@ -65,17 +50,17 @@
     "lodash.sortby": "^4.7.0",
     "react-dropzone": "^14.2.3",
     "style-mod": "^4.1.0",
-    "@dxos/automerge": "0.6.14-main.2b6a0f3",
-    "@dxos/context": "0.6.14-main.2b6a0f3",
-    "@dxos/debug": "0.6.14-main.2b6a0f3",
-    "@dxos/display-name": "0.6.14-main.2b6a0f3",
-    "@dxos/async": "0.6.14-main.2b6a0f3",
-    "@dxos/echo-schema": "0.6.14-main.2b6a0f3",
-    "@dxos/invariant": "0.6.14-main.2b6a0f3",
-    "@dxos/log": "0.6.14-main.2b6a0f3",
-    "@dxos/protocols": "0.6.14-main.2b6a0f3",
-    "@dxos/react-hooks": "0.6.14-main.2b6a0f3",
-    "@dxos/util": "0.6.14-main.2b6a0f3"
+    "@dxos/async": "0.6.14-main.69511f5",
+    "@dxos/automerge": "0.6.14-main.69511f5",
+    "@dxos/context": "0.6.14-main.69511f5",
+    "@dxos/debug": "0.6.14-main.69511f5",
+    "@dxos/display-name": "0.6.14-main.69511f5",
+    "@dxos/invariant": "0.6.14-main.69511f5",
+    "@dxos/echo-schema": "0.6.14-main.69511f5",
+    "@dxos/protocols": "0.6.14-main.69511f5",
+    "@dxos/log": "0.6.14-main.69511f5",
+    "@dxos/react-hooks": "0.6.14-main.69511f5",
+    "@dxos/util": "0.6.14-main.69511f5"
   },
   "devDependencies": {
     "@phosphor-icons/react": "^2.1.5",
@@ -100,23 +85,23 @@
     "vite": "5.4.7",
     "vite-plugin-top-level-await": "^1.4.1",
     "vite-plugin-wasm": "^3.3.0",
-    "@dxos/automerge": "0.6.14-main.2b6a0f3",
-    "@dxos/echo-signals": "0.6.14-main.2b6a0f3",
-    "@dxos/config": "0.6.14-main.2b6a0f3",
-    "@dxos/keyboard": "0.6.14-main.2b6a0f3",
-    "@dxos/random": "0.6.14-main.2b6a0f3",
-    "@dxos/react-ui": "0.6.14-main.2b6a0f3",
-    "@dxos/react-client": "0.6.14-main.2b6a0f3",
-    "@dxos/react-ui-theme": "0.6.14-main.2b6a0f3",
-    "@dxos/storybook-utils": "0.6.14-main.2b6a0f3"
+    "@dxos/automerge": "0.6.14-main.69511f5",
+    "@dxos/config": "0.6.14-main.69511f5",
+    "@dxos/echo-signals": "0.6.14-main.69511f5",
+    "@dxos/keyboard": "0.6.14-main.69511f5",
+    "@dxos/random": "0.6.14-main.69511f5",
+    "@dxos/react-ui": "0.6.14-main.69511f5",
+    "@dxos/react-client": "0.6.14-main.69511f5",
+    "@dxos/react-ui-theme": "0.6.14-main.69511f5",
+    "@dxos/storybook-utils": "0.6.14-main.69511f5"
   },
   "peerDependencies": {
     "@phosphor-icons/react": "^2.1.5",
     "react": "~18.2.0",
     "react-dom": "~18.2.0",
-    "@dxos/react-client": "0.6.14-main.2b6a0f3",
-    "@dxos/react-ui": "0.6.14-main.2b6a0f3",
-    "@dxos/react-ui-theme": "0.6.14-main.2b6a0f3"
+    "@dxos/react-client": "0.6.14-main.69511f5",
+    "@dxos/react-ui": "0.6.14-main.69511f5",
+    "@dxos/react-ui-theme": "0.6.14-main.69511f5"
   },
   "publishConfig": {
     "access": "public"

package/src/TextEditor.stories.tsx

@@ -12,7 +12,7 @@ import { type EditorView } from '@codemirror/view';
 import { ArrowSquareOut, X } from '@phosphor-icons/react';
 import { effect, useSignal } from '@preact/signals-react';
 import defaultsDeep from 'lodash.defaultsdeep';
-import React, { type FC, type KeyboardEvent, useEffect, useState } from 'react';
+import React, { useEffect, useState, type FC, type KeyboardEvent } from 'react';
 import { createRoot } from 'react-dom/client';
 
 import { create, Expando } from '@dxos/echo-schema';
@@ -22,12 +22,11 @@ import { log } from '@dxos/log';
 import { faker } from '@dxos/random';
 import { createDocAccessor, createObject } from '@dxos/react-client/echo';
 import { Button, Input, useThemeContext } from '@dxos/react-ui';
-import { baseSurface, mx, getSize } from '@dxos/react-ui-theme';
+import { baseSurface, getSize, mx } from '@dxos/react-ui-theme';
 import { withLayout, withTheme } from '@dxos/storybook-utils';
 
 import { editorContent, editorGutter, editorMonospace } from './defaults';
 import {
-  InputModeExtensions,
   annotations,
   autocomplete,
   blast,
@@ -45,19 +44,22 @@ import {
   folding,
   formattingKeymap,
   image,
+  InputModeExtensions,
   linkTooltip,
   listener,
   mention,
+  selectionState,
   table,
   typewriter,
   type CommandAction,
   type CommentsOptions,
   type DebugNode,
+  type EditorSelectionState,
 } from './extensions';
-import { renderRoot } from './extensions/util';
 import { useTextEditor, type UseTextEditorProps } from './hooks';
-import { type Comment, type EditorSelectionState, state } from './state';
 import translations from './translations';
+import { type Comment } from './types';
+import { renderRoot } from './util';
 
 faker.seed(101);
 
@@ -416,7 +418,7 @@ export const Scrolling = {
   render: () => (
     <DefaultStory
       text={str('# Large Document', '', longText)}
-      extensions={state({
+      extensions={selectionState({
         setState: (id, state) => global.set(id, state),
         getState: (id) => global.get(id),
       })}

package/src/extensions/annotations.ts

@@ -7,7 +7,7 @@ import { Decoration, EditorView } from '@codemirror/view';
 
 import { isNotFalsy } from '@dxos/util';
 
-import { Cursor } from '../state';
+import { Cursor } from '../util';
 
 type Annotation = {
   cursor: string;

package/src/extensions/automerge/automerge.ts

@@ -13,7 +13,7 @@ import { type DocAccessor } from '@dxos/react-client/echo';
 import { cursorConverter } from './cursor';
 import { updateHeadsEffect, isReconcile, type State } from './defs';
 import { Syncer } from './sync';
-import { Cursor } from '../../state';
+import { Cursor } from '../../util';
 
 export const automerge = (accessor: DocAccessor): Extension => {
   const syncState = StateField.define<State>({

package/src/extensions/automerge/cursor.ts

@@ -5,7 +5,7 @@
 import { log } from '@dxos/log';
 import { type DocAccessor, fromCursor, toCursor } from '@dxos/react-client/echo';
 
-import { type CursorConverter } from '../../state';
+import { type CursorConverter } from '../../util';
 
 export const cursorConverter = (accessor: DocAccessor): CursorConverter => ({
   toCursor: (pos, assoc) => {

package/src/extensions/awareness/awareness.ts

@@ -16,7 +16,7 @@ import {
 import { Event } from '@dxos/async';
 import { Context } from '@dxos/context';
 
-import { singleValueFacet, Cursor, type CursorConverter } from '../../state';
+import { singleValueFacet, Cursor, type CursorConverter } from '../../util';
 
 export interface AwarenessProvider {
   remoteStateChange: Event<void>;

package/src/extensions/command/hint.ts

@@ -7,7 +7,7 @@ import { Decoration, EditorView, ViewPlugin, type ViewUpdate, WidgetType } from
 
 import { type CommandOptions } from './command';
 import { commandState } from './state';
-import { clientRectsFor, flattenRect } from '../util';
+import { clientRectsFor, flattenRect } from '../../util';
 
 class CommandHint extends WidgetType {
   constructor(readonly content: string | HTMLElement) {

package/src/extensions/command/state.ts

@@ -13,7 +13,7 @@ import {
 } from '@codemirror/view';
 
 import { type CommandOptions } from './command';
-import { singleValueFacet } from '../../state';
+import { singleValueFacet } from '../../util';
 
 type CommandState = {
   tooltip?: Tooltip | null;

package/src/extensions/comments.ts

@@ -28,10 +28,9 @@ import { debounce, type UnsubscribeCallback } from '@dxos/async';
 import { log } from '@dxos/log';
 import { nonNullable } from '@dxos/util';
 
-import { overlap } from './util';
-import { Cursor, documentId, singleValueFacet } from '../state';
-import { type Comment, type Range } from '../state';
-import { callbackWrapper } from '../util';
+import { documentId } from './selection';
+import { type Comment, type Range } from '../types';
+import { Cursor, overlap, singleValueFacet, callbackWrapper } from '../util';
 
 //
 // State management.

package/src/extensions/factories.ts

@@ -31,7 +31,8 @@ import { type HuePalette, hueTokens } from '@dxos/react-ui-theme';
 import { hexToHue, isNotFalsy } from '@dxos/util';
 
 import { automerge } from './automerge';
-import { awareness, SpaceAwarenessProvider } from './awareness';
+import { SpaceAwarenessProvider, awareness } from './awareness';
+import { focus } from './focus';
 import { type ThemeStyles, defaultTheme } from '../styles';
 
 //
@@ -52,6 +53,7 @@ export type BasicExtensionsOptions = {
   dropCursor?: boolean;
   drawSelection?: boolean;
   editable?: boolean;
+  focus?: boolean;
   highlightActiveLine?: boolean;
   history?: boolean;
   indentWithTab?: boolean;
@@ -72,6 +74,7 @@ const defaultBasicOptions: BasicExtensionsOptions = {
   closeBrackets: true,
   drawSelection: true,
   editable: true,
+  focus: true,
   history: true,
   keymap: 'standard',
   lineWrapping: true,
@@ -98,6 +101,7 @@ export const createBasicExtensions = (_props?: BasicExtensionsOptions): Extensio
     props.closeBrackets && closeBrackets(),
     props.dropCursor && dropCursor(),
     props.drawSelection && drawSelection({ cursorBlinkRate: 1_200 }),
+    props.focus && focus,
     props.highlightActiveLine && highlightActiveLine(),
     props.history && history(),
     props.lineNumbers && lineNumbers(),

package/src/extensions/focus.ts

@@ -0,0 +1,35 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { StateEffect, StateField } from '@codemirror/state';
+import { EditorView } from '@codemirror/view';
+
+const focusEffect = StateEffect.define<boolean>();
+
+export const focusField = StateField.define<boolean>({
+  create: () => false,
+  update: (value, tr) => {
+    for (const effect of tr.effects) {
+      if (effect.is(focusEffect)) {
+        return effect.value;
+      }
+    }
+    return value;
+  },
+});
+
+/**
+ * Manage focus.
+ */
+export const focus = [
+  focusField,
+  EditorView.domEventHandlers({
+    focus: (event, view) => {
+      setTimeout(() => view.dispatch({ effects: focusEffect.of(true) }));
+    },
+    blur: (event, view) => {
+      setTimeout(() => view.dispatch({ effects: focusEffect.of(false) }));
+    },
+  }),
+];

package/src/extensions/folding.tsx

@@ -9,7 +9,7 @@ import React from 'react';
 
 import { Icon } from '@dxos/react-ui';
 
-import { createElement, renderRoot } from './util';
+import { createElement, renderRoot } from '../util';
 
 export type FoldingOptions = {};
 

package/src/extensions/index.ts

@@ -12,9 +12,11 @@ export * from './comments';
 export * from './debug';
 export * from './dnd';
 export * from './factories';
+export * from './focus';
 export * from './folding';
 export * from './listener';
 export * from './markdown';
 export * from './mention';
 export * from './modes';
+export * from './selection';
 export * from './typewriter';

package/src/extensions/markdown/decorate.ts

@@ -15,7 +15,7 @@ import { image } from './image';
 import { formattingStyles, bulletListIndentationWidth, orderedListIndentationWidth } from './styles';
 import { table } from './table';
 import { theme, type HeadingLevel } from '../../styles';
-import { wrapWithCatch } from '../util';
+import { wrapWithCatch } from '../../util';
 
 /**
  * Unicode characters.

package/src/extensions/markdown/image.ts

@@ -3,43 +3,52 @@
 //
 
 import { syntaxTree } from '@codemirror/language';
-import { type EditorState, type Extension, StateField, type Transaction, type Range } from '@codemirror/state';
+import { type EditorState, type Extension, type Range, StateField, type Transaction } from '@codemirror/state';
 import { Decoration, type DecorationSet, EditorView, WidgetType } from '@codemirror/view';
 
+import { focusField } from '../focus';
+
 export type ImageOptions = {};
 
+/**
+ * Create image decorations.
+ */
 export const image = (_options: ImageOptions = {}): Extension => {
-  return StateField.define<DecorationSet>({
-    create: (state) => {
-      return Decoration.set(buildDecorations(0, state.doc.length, state));
-    },
-    update: (value: DecorationSet, tr: Transaction) => {
-      if (!tr.docChanged && !tr.selection) {
-        return value;
-      }
+  return [
+    StateField.define<DecorationSet>({
+      create: (state) => {
+        // Process all images.
+        return Decoration.set(buildDecorations(0, state.doc.length, state));
+      },
+      update: (value: DecorationSet, tr: Transaction) => {
+        if (!tr.docChanged && !tr.selection) {
+          return value;
+        }
 
-      // Find range of changes and cursor changes.
-      const cursor = tr.state.selection.main.head;
-      const oldCursor = tr.changes.mapPos(tr.startState.selection.main.head);
-      let from = Math.min(cursor, oldCursor);
-      let to = Math.max(cursor, oldCursor);
-      tr.changes.iterChangedRanges((fromA, toA, fromB, toB) => {
-        from = Math.min(from, fromB);
-        to = Math.max(to, toB);
-      });
-
-      // Expand to cover lines.
-      from = tr.state.doc.lineAt(from).from;
-      to = tr.state.doc.lineAt(to).to;
-      return value.map(tr.changes).update({
-        filterFrom: from,
-        filterTo: to,
-        filter: () => false,
-        add: buildDecorations(from, to, tr.state),
-      });
-    },
-    provide: (field) => EditorView.decorations.from(field),
-  });
+        // Find range of changes and cursor changes.
+        const cursor = tr.state.selection.main.head;
+        const oldCursor = tr.changes.mapPos(tr.startState.selection.main.head);
+        let from = Math.min(cursor, oldCursor);
+        let to = Math.max(cursor, oldCursor);
+        tr.changes.iterChangedRanges((fromA, toA, fromB, toB) => {
+          from = Math.min(from, fromB);
+          to = Math.max(to, toB);
+        });
+
+        // Expand to cover lines.
+        from = tr.state.doc.lineAt(from).from;
+        to = tr.state.doc.lineAt(to).to;
+
+        return value.map(tr.changes).update({
+          filterFrom: from,
+          filterTo: to,
+          filter: () => false,
+          add: buildDecorations(from, to, tr.state),
+        });
+      },
+      provide: (field) => EditorView.decorations.from(field),
+    }),
+  ];
 };
 
 const preloaded = new Set<string>();
@@ -55,15 +64,19 @@ const preloadImage = (url: string) => {
 const buildDecorations = (from: number, to: number, state: EditorState) => {
   const decorations: Range<Decoration>[] = [];
   const cursor = state.selection.main.head;
-
   syntaxTree(state).iterate({
     enter: (node) => {
       if (node.name === 'Image') {
         const urlNode = node.node.getChild('URL');
         if (urlNode) {
-          const hide = state.readOnly || cursor < node.from || cursor > node.to;
+          const hide = state.readOnly || cursor < node.from || cursor > node.to || !state.field(focusField);
+
           const url = state.sliceDoc(urlNode.from, urlNode.to);
-          // TODO(burdon): Doesn't load if scrolling with mouse.
+          // Some plugins might be using custom URLs; avoid attempts to render those URLs.
+          if (url.match(/^https?:\/\//) === null && url.match(/^file?:\/\//) === null) {
+            return;
+          }
+
           preloadImage(url);
           decorations.push(
             Decoration.replace({
@@ -94,14 +107,12 @@ class ImageWidget extends WidgetType {
     const img = document.createElement('img');
     img.setAttribute('src', this._url);
     img.setAttribute('class', 'cm-image');
-    // Images are hidden until successfully loaded to avoid flickering effects.
-    img.onload = () => img.classList.add('cm-loaded-image');
+    // If focused, hide image until successfully loaded to avoid flickering effects.
+    if (view.state.field(focusField)) {
+      img.onload = () => img.classList.add('cm-loaded-image');
+    } else {
+      img.classList.add('cm-loaded-image');
+    }
     return img;
   }
 }
-
-export type ImageUploadOptions = {
-  onSelect: () => { url: string };
-};
-
-export const imageUpload = (options: ImageOptions = {}) => {};

package/src/extensions/modes.ts

@@ -7,7 +7,7 @@ import { keymap } from '@codemirror/view';
 import { vim } from '@replit/codemirror-vim';
 import { vscodeKeymap } from '@replit/codemirror-vscode-keymap';
 
-import { singleValueFacet } from '../state';
+import { singleValueFacet } from '../util';
 
 export const focusEvent = 'focus.container';
 

package/src/{state/state.ts → extensions/selection.ts}

@@ -2,16 +2,19 @@
 // Copyright 2024 DXOS.org
 //
 
-import { type EditorState, type Extension, Transaction, type TransactionSpec } from '@codemirror/state';
+import { type Extension, Transaction, type TransactionSpec } from '@codemirror/state';
 import { EditorView, keymap } from '@codemirror/view';
 
 import { debounce } from '@dxos/async';
 import { invariant } from '@dxos/invariant';
 import { isNotFalsy } from '@dxos/util';
 
-import { documentId } from './doc';
+import { singleValueFacet } from '../util';
 
-const stateRestoreAnnotation = 'dxos.org/cm/state-restore';
+/**
+ * Currently edited document id as FQ string.
+ */
+export const documentId = singleValueFacet<string>();
 
 export type EditorSelection = {
   anchor: number;
@@ -23,13 +26,23 @@ export type EditorSelectionState = {
   selection?: EditorSelection;
 };
 
-export type EditorStateOptions = {
+export type EditorStateStore = {
   setState: (id: string, state: EditorSelectionState) => void;
   getState: (id: string) => EditorSelectionState | undefined;
 };
 
-const keyPrefix = 'dxos.org/react-ui-editor/state';
-export const localStorageStateStoreAdapter: EditorStateOptions = {
+const stateRestoreAnnotation = 'dxos.org/cm/state-restore';
+
+export const createEditorStateTransaction = ({ scrollTo, selection }: EditorSelectionState): TransactionSpec => {
+  return {
+    selection,
+    scrollIntoView: !scrollTo,
+    effects: scrollTo ? EditorView.scrollIntoView(scrollTo, { yMargin: 96 }) : undefined,
+    annotations: Transaction.userEvent.of(stateRestoreAnnotation),
+  };
+};
+
+export const createEditorStateStore = (keyPrefix: string): EditorStateStore => ({
   getState: (id) => {
     invariant(id);
     const state = localStorage.getItem(`${keyPrefix}/${id}`);
@@ -40,25 +53,12 @@ export const localStorageStateStoreAdapter: EditorStateOptions = {
     invariant(id);
     localStorage.setItem(`${keyPrefix}/${id}`, JSON.stringify(state));
   },
-};
-
-export const createEditorStateTransaction = (
-  state: EditorState,
-  { scrollTo, selection }: EditorSelectionState,
-): TransactionSpec => {
-  return {
-    selection,
-    scrollIntoView: !scrollTo,
-    effects: scrollTo ? EditorView.scrollIntoView(scrollTo, { yMargin: 96 }) : undefined,
-    annotations: Transaction.userEvent.of(stateRestoreAnnotation),
-  };
-};
+});
 
 /**
  * Track scrolling and selection state to be restored when switching to document.
  */
-// TODO(burdon): Rename.
-export const state = ({ getState, setState }: Partial<EditorStateOptions> = {}): Extension => {
+export const selectionState = ({ getState, setState }: Partial<EditorStateStore> = {}): Extension => {
   const setStateDebounced = debounce(setState!, 1_000);
 
   return [
@@ -90,7 +90,7 @@ export const state = ({ getState, setState }: Partial<EditorStateOptions> = {}):
           run: (view) => {
             const state = getState(view.state.facet(documentId));
             if (state) {
-              view.dispatch(createEditorStateTransaction(view.state, state));
+              view.dispatch(createEditorStateTransaction(state));
             }
             return true;
           },

package/src/hooks/useTextEditor.ts

@@ -19,8 +19,7 @@ import {
 import { log } from '@dxos/log';
 import { getProviderValue, isNotFalsy, type MaybeProvider } from '@dxos/util';
 
-import { editorInputMode } from '../extensions';
-import { type EditorSelection, documentId, createEditorStateTransaction } from '../state';
+import { editorInputMode, type EditorSelection, documentId, createEditorStateTransaction } from '../extensions';
 import { debugDispatcher } from '../util';
 
 export type UseTextEditor = {
@@ -150,7 +149,7 @@ export const useTextEditor = (
           return;
         }
 
-        view.dispatch(createEditorStateTransaction(view.state, { scrollTo, selection }));
+        view.dispatch(createEditorStateTransaction({ scrollTo, selection }));
       }
     }
   }, [view, scrollTo, selection]);

package/src/index.ts

@@ -14,7 +14,7 @@ export * from './components';
 export * from './defaults';
 export * from './extensions';
 export * from './hooks';
-export * from './state';
+export * from './types';
 export * from './util';
 
 export { translations };

package/src/{state → util}/cursor.ts

@@ -4,8 +4,15 @@
 
 import { type EditorState } from '@codemirror/state';
 
-import { type Range } from './types';
-import { singleValueFacet } from './util';
+import { singleValueFacet } from './facet';
+import { type Range } from '../types';
+
+/**
+ * Determines if two ranges overlap.
+ * A range is considered to overlap if there is any intersection
+ * between the two ranges, inclusive of their boundaries.
+ */
+export const overlap = (a: Range, b: Range): boolean => a.from <= b.to && a.to >= b.from;
 
 /**
  * Converts indexes into the text document into stable peer-independent cursors.
@@ -32,7 +39,6 @@ export class Cursor {
 
   static readonly getCursorFromRange = (state: EditorState, range: Range) => {
     const cursorConverter = state.facet(Cursor.converter);
-
     const from = cursorConverter.toCursor(range.from);
     const to = cursorConverter.toCursor(range.to, -1);
     return [from, to].join(':');