@dxos/react-ui-editor 0.3.10-next.e7dbe51 → 0.3.10

package/src/components/TextEditor/themes/default.ts

@@ -10,6 +10,11 @@ import { tokens } from '../../../styles';
 /**
  * Minimal styles.
  * https://codemirror.net/examples/styling
+ *
+ * Examples:
+ * - https://github.com/codemirror/view/blob/main/src/theme.ts
+ * - https://github.com/codemirror/theme-one-dark/blob/main/src/one-dark.ts
+ *
  * NOTE: Use one of '&', '&light', and '&dark' prefix to scope instance.
  * NOTE: `light` and `dark` selectors are preprocessed by CodeMirror and can only be in the base theme.
  */
@@ -32,6 +37,7 @@ export const defaultTheme: {
   },
   '& .cm-scroller': {
     overflow: 'visible',
+    fontFamily: get(tokens, 'fontFamily.mono', []).join(','),
   },
   '& .cm-content': {
     padding: 0,
@@ -50,10 +56,10 @@ export const defaultTheme: {
   //
   // Cursor
   //
-  '&light .cm-cursor': {
+  '&light .cm-cursor, &light .cm-dropCursor': {
     borderLeft: '2px solid black',
   },
-  '&dark .cm-cursor': {
+  '&dark .cm-cursor, &dark .cm-dropCursor': {
     borderLeft: '2px solid white',
   },
   '& .cm-placeholder': {
@@ -136,8 +142,59 @@ export const defaultTheme: {
   '& .cm-tooltip': {
     border: 'none',
   },
-  // '& .cm-tooltip-below': {},
-  // '& .cm-tooltip-autocomplete': {},
+  '& .cm-tooltip-below': {},
+
+  //
+  // autocomplete
+  //
+  '& .cm-tooltip-autocomplete': {
+    marginTop: '4px',
+    marginLeft: '-3px',
+  },
+  '& .cm-tooltip-autocomplete ul li': {},
+  '& .cm-tooltip-autocomplete ul li[aria-selected]': {},
+  '& .cm-completionIcon': {
+    display: 'none',
+  },
+  '& .cm-completionLabel': {
+    fontFamily: get(tokens, 'fontFamily.body', []).join(','),
+  },
+  '& .cm-completionMatchedText': {
+    textDecoration: 'none',
+  },
+
+  //
+  // widgets
+  //
+  '& .cm-widgetBuffer': {
+    display: 'none',
+    height: 0,
+  },
+
+  //
+  // table
+  //
+  '& .cm-table *': {
+    fontFamily: `${get(tokens, 'fontFamily.mono', []).join(',')} !important`,
+    textDecoration: 'none !important',
+  },
+  '& .cm-table-head': {
+    padding: '2px 16px 2px 0px',
+    borderBottom: `1px solid ${get(tokens, 'extend.colors.neutral.500')}`,
+    fontWeight: 100,
+    textAlign: 'left',
+    color: get(tokens, 'extend.colors.neutral.500'),
+  },
+  '& .cm-table-cell': {
+    padding: '2px 16px 2px 0px',
+  },
+
+  //
+  // image
+  //
+  '& .cm-image': {
+    margin: '0.5rem 0',
+  },
 
   //
   // font size
@@ -151,6 +208,43 @@ export const defaultTheme: {
     acc[`& .text-${fontSize} + .cm-widgetBuffer + .cm-ySelectionCaret`] = { height };
     return acc;
   }, {}),
+
+  /**
+   * Panels
+   * https://github.com/codemirror/search/blob/main/src/search.ts#L745
+   *
+   * Find/replace panel.
+   * <div class="cm-announced">...</div>
+   * <div class="cm-scroller">...</div>
+   * <div class="cm-panels cm-panels-bottom">
+   *   <div class="cm-search cm-panel">
+   *     <input class="cm-textfield" />
+   *     <button class="cm-button">...</button>
+   *     <label><input type="checkbox" />...</label>
+   *   </div>
+   * </div
+   */
+  '& .cm-panels': {
+    border: `1px solid ${get(tokens, 'extend.colors.neutral.200')}`,
+    borderBottom: 'none',
+  },
+  '& .cm-panel': {
+    background: get(tokens, 'extend.colors.neutral.50'),
+    fontFamily: get(tokens, 'fontFamily.body', []).join(','),
+  },
+  '& .cm-button': {
+    margin: '4px',
+    fontFamily: get(tokens, 'fontFamily.body', []).join(','),
+    background: get(tokens, 'extend.colors.neutral.100'),
+    border: 'none',
+  },
+
+  '& .cm-searchMatch': {
+    backgroundColor: get(tokens, 'extend.colors.yellow.100'),
+  },
+  '& .cm-searchMatch.cm-searchMatch-selected': {
+    backgroundColor: get(tokens, 'extend.colors.primary.100'),
+  },
 };
 
 export const textTheme: {

package/src/hooks/automerge/PatchSemaphore.ts

@@ -2,20 +2,24 @@
 // Copyright 2023 DXOS.org
 //
 
+// TODO(burdon): Additional copyright?
+
 import { type EditorView } from '@codemirror/view';
 
 import { next as automerge } from '@dxos/automerge/automerge';
 
-import amToCodemirror from './amToCodemirror';
-import codeMirrorToAm from './codeMirrorToAm';
 import { type IDocHandle } from './handle';
 import { type Field, isReconcileTx, getPath, reconcileAnnotationType, updateHeads, getLastHeads } from './plugin';
+import { automergeToCodemirror, codemirrorToAutomerge } from './translation';
 
 type Doc<T> = automerge.Doc<T>;
 type Heads = automerge.Heads;
 
 type ChangeFn = (atHeads: Heads, change: (doc: Doc<unknown>) => void) => Heads | undefined;
 
+/**
+ * TODO(burdon): Comment.
+ */
 export class PatchSemaphore {
   _field!: Field;
   _inReconcile = false;
@@ -39,7 +43,7 @@ export class PatchSemaphore {
 
     const transactions = view.state.field(this._field).unreconciledTransactions.filter((tx) => !isReconcileTx(tx));
 
-    // First undo all the unreconciled transactions
+    // First undo all the unreconciled transactions.
     const toInvert = transactions.slice().reverse();
     for (const tx of toInvert) {
       const inverted = tx.changes.invert(tx.startState.doc);
@@ -50,19 +54,18 @@ export class PatchSemaphore {
       });
     }
 
-    // now apply the unreconciled transactions to the document
-    let newHeads = codeMirrorToAm(this._field, handle, transactions, view.state);
+    // Apply the unreconciled transactions to the document.
+    let newHeads = codemirrorToAutomerge(this._field, handle, transactions, view.state);
 
-    // NOTE: null and undefined each come from automerge and repo respectively
+    // NOTE: null and undefined each come from automerge and repo respectively.
     if (newHeads === null || newHeads === undefined) {
       // TODO: @alexjg this is the call that's resetting the editor state on click
       newHeads = automerge.getHeads(handle.docSync()!);
     }
 
-    // now get the diff between the updated state of the document and the heads
-    // and apply that to the codemirror doc
+    // Now get the diff between the updated state of the document and the heads and apply that to the codemirror doc.
     const diff = automerge.equals(oldHeads, newHeads) ? [] : automerge.diff(handle.docSync()!, oldHeads, newHeads);
-    amToCodemirror(view, selection, path, diff);
+    automergeToCodemirror(view, selection, path, diff);
 
     view.dispatch({
       effects: updateHeads(newHeads),

package/src/hooks/automerge/automerge.stories.tsx

@@ -9,6 +9,7 @@ import { basicSetup } from 'codemirror';
 import get from 'lodash.get';
 import React, { useEffect, useRef, useState } from 'react';
 
+// TODO(burdon): Why separate imports?
 import { type Prop } from '@dxos/automerge/automerge';
 import { type DocHandle, Repo } from '@dxos/automerge/automerge-repo';
 
@@ -82,9 +83,10 @@ const Story = () => {
 };
 
 export default {
-  title: 'Automerge',
+  title: 'react-ui-editor/Automerge',
+  component: Editor,
 };
 
-export const AutomergeRepo = {
+export const Default = {
   render: () => <Story />,
 };

package/src/hooks/automerge/index.ts

@@ -2,5 +2,5 @@
 // Copyright 2023 DXOS.org
 //
 
-export { automergePlugin, type AutomergePlugin } from './plugin';
 export { type IDocHandle } from './handle';
+export { automergePlugin, type AutomergePlugin } from './plugin';

package/src/hooks/automerge/plugin.ts

@@ -78,6 +78,7 @@ export const automergePlugin = (handle: IDocHandle, path: Prop[]): AutomergePlug
       return result;
     },
   });
+
   const semaphore = new PatchSemaphore(stateField);
 
   const viewPlugin = ViewPlugin.fromClass(

package/src/hooks/automerge/{amToCodemirror.ts → translation/automerge-to-codemirror.ts}

@@ -2,6 +2,8 @@
 // Copyright 2023 DXOS.org
 //
 
+// TODO(burdon): Additional copyright?
+
 import { ChangeSet, type ChangeSpec, type EditorSelection, type EditorState } from '@codemirror/state';
 import { type EditorView } from '@codemirror/view';
 
@@ -14,9 +16,14 @@ import {
   type SpliceTextPatch,
 } from '@dxos/automerge/automerge';
 
-import { reconcileAnnotationType } from './plugin';
+import { reconcileAnnotationType } from '../plugin';
 
-export default (view: EditorView, selection: EditorSelection, target: Prop[], patches: Patch[]) => {
+export const automergeToCodemirror = (
+  view: EditorView,
+  selection: EditorSelection,
+  target: Prop[],
+  patches: Patch[],
+) => {
   for (const patch of patches) {
     const changeSpec = handlePatch(patch, target, view.state);
     if (changeSpec != null) {
@@ -28,6 +35,7 @@ export default (view: EditorView, selection: EditorSelection, target: Prop[], pa
       });
     }
   }
+
   view.dispatch({
     selection,
     annotations: reconcileAnnotationType.of({}),

package/src/hooks/automerge/{codeMirrorToAm.ts → translation/codemirror-to-automerge.ts}

@@ -2,14 +2,16 @@
 // Copyright 2023 DXOS.org
 //
 
+// TODO(burdon): Additional copyright?
+
 import { type EditorState, type Text, type Transaction } from '@codemirror/state';
 
 import { next as am, type Heads } from '@dxos/automerge/automerge';
 
-import { type IDocHandle } from './handle';
-import { type Field } from './plugin';
+import { type IDocHandle } from '../handle';
+import { type Field } from '../plugin';
 
-export default (
+export const codemirrorToAutomerge = (
   field: Field,
   handle: IDocHandle,
   transactions: Transaction[],
@@ -18,7 +20,7 @@ export default (
   const { lastHeads, path } = state.field(field);
 
   // We don't want to call `automerge.updateAt` if there are no changes.
-  // Otherwise later on `automerge.diff` will return empty patches that result in a no-op but still mess up the selection.
+  // Otherwise, later on `automerge.diff` will return empty patches that result in a no-op but still mess up the selection.
   let hasChanges = false;
   for (const tr of transactions) {
     tr.changes.iterChanges(() => {
@@ -37,5 +39,6 @@ export default (
       });
     }
   });
+
   return newHeads ?? undefined;
 };

package/src/hooks/automerge/translation/index.ts

@@ -0,0 +1,6 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+export * from './automerge-to-codemirror';
+export * from './codemirror-to-automerge';

package/src/hooks/useTextModel.ts

@@ -26,12 +26,19 @@ import { SpaceAwarenessProvider } from './yjs';
 // TODO(burdon): Move.
 type Awareness = awarenessProtocol.Awareness;
 
+export type DocumentRange = {
+  id: string;
+  from: number;
+  to: number;
+};
+
 // TODO(wittjosiah): Factor out to common package? @dxos/react-client?
 export type EditorModel = {
   id: string;
   // TODO(burdon): Remove.
   content: string | YText | YXmlFragment | DocAccessor;
   text: () => string;
+  ranges: DocumentRange[];
   extension?: Extension;
   awareness?: Awareness;
   peer?: {
@@ -80,6 +87,7 @@ const createYjsModel = ({ identity, space, text }: UseTextModelOptions): EditorM
     id: text.doc.guid,
     content: text.content,
     text: () => text.content!.toString(),
+    ranges: [],
     extension: yCollab(text.content as YText, provider?.awareness),
     awareness: provider?.awareness,
     peer: identity
@@ -99,6 +107,7 @@ const createAutomergeModel = ({ identity, text }: UseTextModelOptions): EditorMo
     id: obj.id,
     content: doc,
     text: () => get(doc.handle.docSync(), doc.path),
+    ranges: [],
     extension: automergePlugin(doc.handle, doc.path),
     peer: identity
       ? {

package/src/{components/TextEditor → hooks/yjs}/yjs.stories.tsx

@@ -12,10 +12,11 @@ import { ClientRepeater, textGenerator, useDataGenerator } from '@dxos/react-cli
 import { useId, Input } from '@dxos/react-ui';
 import { withTheme } from '@dxos/storybook-utils';
 
-import { MarkdownEditor } from './TextEditor';
+import { MarkdownEditor } from '../../components';
 import { Replicator, useYjsModel } from '../../testing';
 
 export default {
+  title: 'react-ui-editor/YJS',
   component: MarkdownEditor,
   decorators: [withTheme],
 };
@@ -50,7 +51,6 @@ const Story = () => {
 };
 
 export const Default = {
-  title: 'react-ui-editor/YJS',
   // TODO(wittjosiah): Decorator for doing this without clients being initialized?
   render: () => <ClientRepeater count={2} Component={Story} />,
 };

package/src/styles/markdown.ts

@@ -6,14 +6,20 @@ import { mx } from '@dxos/react-ui-theme';
 
 export type HeadingLevel = 1 | 2 | 3 | 4 | 5 | 6;
 
+// TODO(burdon): Better way to align vertically than negative margin? Font-specific?
 // https://tailwindcss.com/docs/font-weight
-export const heading: Record<HeadingLevel, string> = {
-  1: 'mbs-4 mbe-2 font-medium text-inherit no-underline text-4xl',
-  2: 'mbs-4 mbe-2 font-medium text-inherit no-underline text-3xl',
-  3: 'mbs-4 mbe-2 font-medium text-inherit no-underline text-2xl',
-  4: 'mbs-4 mbe-2 font-medium text-inherit no-underline text-xl',
-  5: 'mbs-4 mbe-2 font-medium text-inherit no-underline text-lg',
-  6: 'mbs-4 mbe-2 font-medium text-inherit no-underline',
+export const headings: Record<HeadingLevel, string[]> = {
+  1: ['mbs-4 mbe-2 font-medium text-inherit no-underline text-4xl', '-ml-[10px]'],
+  2: ['mbs-4 mbe-2 font-medium text-inherit no-underline text-3xl', '-ml-[8px]'],
+  3: ['mbs-4 mbe-2 font-medium text-inherit no-underline text-2xl', '-ml-[7px]'],
+  4: ['mbs-4 mbe-2 font-medium text-inherit no-underline text-xl', '-ml-[6px]'],
+  5: ['mbs-4 mbe-2 font-medium text-inherit no-underline text-lg', '-ml-[5px]'],
+  6: ['mbs-4 mbe-2 font-medium text-inherit no-underline', '-ml-[4px]'],
+};
+
+export const heading = (level: HeadingLevel, readonly?: boolean) => {
+  const [style, offset] = headings[level];
+  return mx(style, readonly && offset);
 };
 
 export const text = 'text-neutral-800 dark:text-neutral-200';
@@ -37,7 +43,8 @@ export const inlineUrl = mx(code, 'px-1');
 export const blockquote = mx('pl-1 mr-1 border-is-4 border-primary-500/70 dark:border-primary-500/30', light);
 
 // TODO(burdon): Replace with widget.
-export const horizontalRule = 'flex mlb-4 border-b text-neutral-100 dark:text-neutral-900 border-neutral-500/50';
+export const horizontalRule =
+  'flex mlb-4 border-b text-neutral-100 dark:text-neutral-900 border-neutral-200 dark:border-neutral-800';
 
 // TODO(thure): Tailwind was not seeing `[&>li:before]:content-["•"]` as a utility class, but it would work if instead of `"•"` it was `"X"`… why?
 export const unorderedList =

package/src/testing/replicator.ts

@@ -169,6 +169,7 @@ export class Replicator {
       id: doc.guid,
       text: () => content.toString(),
       content,
+      ranges: [],
       awareness: provider.awareness,
       peer: { id },
     };

package/dist/types/src/components/TextEditor/yjs.stories.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"yjs.stories.d.ts","sourceRoot":"","sources":["../../../../../src/components/TextEditor/yjs.stories.tsx"],"names":[],"mappings":"AAIA,OAAO,YAAY,CAAC;AAEpB,OAAO,KAAmB,MAAM,OAAO,CAAC;;;;;AAWxC,wBAGE;AA+BF,eAAO,MAAM,OAAO;;;CAInB,CAAC"}

package/dist/types/src/hooks/automerge/amToCodemirror.d.ts

@@ -1,6 +0,0 @@
-import { type EditorSelection } from '@codemirror/state';
-import { type EditorView } from '@codemirror/view';
-import { type Patch, type Prop } from '@dxos/automerge/automerge';
-declare const _default: (view: EditorView, selection: EditorSelection, target: Prop[], patches: Patch[]) => void;
-export default _default;
-//# sourceMappingURL=amToCodemirror.d.ts.map

package/dist/types/src/hooks/automerge/amToCodemirror.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"amToCodemirror.d.ts","sourceRoot":"","sources":["../../../../../src/hooks/automerge/amToCodemirror.ts"],"names":[],"mappings":"AAIA,OAAO,EAA8B,KAAK,eAAe,EAAoB,MAAM,mBAAmB,CAAC;AACvG,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEnD,OAAO,EAGL,KAAK,KAAK,EACV,KAAK,IAAI,EAGV,MAAM,2BAA2B,CAAC;+BAIb,UAAU,aAAa,eAAe,UAAU,IAAI,EAAE,WAAW,KAAK,EAAE;AAA9F,wBAgBE"}

package/dist/types/src/hooks/automerge/codeMirrorToAm.d.ts

@@ -1,7 +0,0 @@
-import { type EditorState, type Transaction } from '@codemirror/state';
-import { type Heads } from '@dxos/automerge/automerge';
-import { type IDocHandle } from './handle';
-import { type Field } from './plugin';
-declare const _default: (field: Field, handle: IDocHandle, transactions: Transaction[], state: EditorState) => Heads | undefined;
-export default _default;
-//# sourceMappingURL=codeMirrorToAm.d.ts.map

package/dist/types/src/hooks/automerge/codeMirrorToAm.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"codeMirrorToAm.d.ts","sourceRoot":"","sources":["../../../../../src/hooks/automerge/codeMirrorToAm.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,WAAW,EAAa,KAAK,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAElF,OAAO,EAAc,KAAK,KAAK,EAAE,MAAM,2BAA2B,CAAC;AAEnE,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,UAAU,CAAC;+CAI5B,UAAU,gBACJ,WAAW,EAAE,SACpB,WAAW,KACjB,KAAK,GAAG,SAAS;AALpB,wBA6BE"}