@dxos/react-ui-editor 0.3.11-main.514e6e4 → 0.3.11-main.525300b

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (93) hide show
  1. package/dist/lib/browser/index.mjs +1886 -329
  2. package/dist/lib/browser/index.mjs.map +4 -4
  3. package/dist/lib/browser/meta.json +1 -1
  4. package/dist/types/src/components/TextEditor/MarkdownEditor.stories.d.ts +1 -2
  5. package/dist/types/src/components/TextEditor/MarkdownEditor.stories.d.ts.map +1 -1
  6. package/dist/types/src/components/TextEditor/TextEditor.d.ts.map +1 -1
  7. package/dist/types/src/components/TextEditor/TextEditor.stories.d.ts +1 -1
  8. package/dist/types/src/components/TextEditor/automerge.stories.d.ts.map +1 -1
  9. package/dist/types/src/components/TextEditor/{comments.stories.d.ts → hooks.stories.d.ts} +9 -12
  10. package/dist/types/src/components/TextEditor/hooks.stories.d.ts.map +1 -0
  11. package/dist/types/src/components/Toolbar/Toolbar.d.ts +29 -0
  12. package/dist/types/src/components/Toolbar/Toolbar.d.ts.map +1 -0
  13. package/dist/types/src/components/Toolbar/Toolbar.stories.d.ts +25 -0
  14. package/dist/types/src/components/Toolbar/Toolbar.stories.d.ts.map +1 -0
  15. package/dist/types/src/components/Toolbar/index.d.ts +2 -0
  16. package/dist/types/src/components/Toolbar/index.d.ts.map +1 -0
  17. package/dist/types/src/components/index.d.ts +1 -0
  18. package/dist/types/src/components/index.d.ts.map +1 -1
  19. package/dist/types/src/extensions/automerge/automerge.d.ts.map +1 -1
  20. package/dist/types/src/extensions/automerge/automerge.spec.d.ts +2 -0
  21. package/dist/types/src/extensions/automerge/automerge.spec.d.ts.map +1 -0
  22. package/dist/types/src/extensions/automerge/automerge.test.d.ts +2 -0
  23. package/dist/types/src/extensions/automerge/automerge.test.d.ts.map +1 -0
  24. package/dist/types/src/extensions/automerge/defs.d.ts +5 -5
  25. package/dist/types/src/extensions/automerge/defs.d.ts.map +1 -1
  26. package/dist/types/src/extensions/automerge/semaphore.d.ts +2 -1
  27. package/dist/types/src/extensions/automerge/semaphore.d.ts.map +1 -1
  28. package/dist/types/src/extensions/automerge/update-automerge.d.ts.map +1 -1
  29. package/dist/types/src/extensions/awareness.d.ts +1 -1
  30. package/dist/types/src/extensions/basic.d.ts +1 -1
  31. package/dist/types/src/extensions/basic.d.ts.map +1 -1
  32. package/dist/types/src/extensions/comments.d.ts +11 -3
  33. package/dist/types/src/extensions/comments.d.ts.map +1 -1
  34. package/dist/types/src/extensions/markdown/bundle.d.ts +2 -2
  35. package/dist/types/src/extensions/markdown/bundle.d.ts.map +1 -1
  36. package/dist/types/src/extensions/markdown/code.d.ts.map +1 -1
  37. package/dist/types/src/extensions/markdown/formatting.d.ts +57 -0
  38. package/dist/types/src/extensions/markdown/formatting.d.ts.map +1 -0
  39. package/dist/types/src/extensions/markdown/formatting.test.d.ts +3 -0
  40. package/dist/types/src/extensions/markdown/formatting.test.d.ts.map +1 -0
  41. package/dist/types/src/extensions/markdown/index.d.ts +1 -0
  42. package/dist/types/src/extensions/markdown/index.d.ts.map +1 -1
  43. package/dist/types/src/extensions/markdown/link.d.ts.map +1 -1
  44. package/dist/types/src/hooks/index.d.ts +2 -0
  45. package/dist/types/src/hooks/index.d.ts.map +1 -1
  46. package/dist/types/src/hooks/useActionHandler.d.ts +4 -0
  47. package/dist/types/src/hooks/useActionHandler.d.ts.map +1 -0
  48. package/dist/types/src/hooks/useEditorView.d.ts +17 -0
  49. package/dist/types/src/hooks/useEditorView.d.ts.map +1 -0
  50. package/dist/types/src/hooks/useTextEditor.d.ts +36 -14
  51. package/dist/types/src/hooks/useTextEditor.d.ts.map +1 -1
  52. package/dist/types/src/hooks/useTextModel.d.ts +12 -0
  53. package/dist/types/src/hooks/useTextModel.d.ts.map +1 -1
  54. package/dist/types/src/index.d.ts +1 -1
  55. package/dist/types/src/index.d.ts.map +1 -1
  56. package/dist/types/src/themes/default.d.ts.map +1 -1
  57. package/package.json +39 -26
  58. package/src/components/TextEditor/MarkdownEditor.stories.tsx +11 -17
  59. package/src/components/TextEditor/TextEditor.tsx +27 -16
  60. package/src/components/TextEditor/automerge.stories.tsx +1 -2
  61. package/src/components/TextEditor/hooks.stories.tsx +111 -0
  62. package/src/components/Toolbar/Toolbar.stories.tsx +102 -0
  63. package/src/components/Toolbar/Toolbar.tsx +245 -0
  64. package/src/components/Toolbar/index.ts +5 -0
  65. package/src/components/index.ts +1 -0
  66. package/src/extensions/automerge/automerge.spec.tsx +76 -0
  67. package/src/extensions/automerge/automerge.test.ts +13 -0
  68. package/src/extensions/automerge/automerge.ts +26 -11
  69. package/src/extensions/automerge/cursor.ts +3 -3
  70. package/src/extensions/automerge/defs.ts +9 -9
  71. package/src/extensions/automerge/semaphore.ts +17 -19
  72. package/src/extensions/automerge/update-automerge.ts +12 -6
  73. package/src/extensions/automerge/update-codemirror.ts +5 -5
  74. package/src/extensions/awareness.ts +7 -4
  75. package/src/extensions/basic.ts +15 -13
  76. package/src/extensions/blast.ts +4 -1
  77. package/src/extensions/comments.ts +126 -68
  78. package/src/extensions/markdown/bundle.ts +10 -5
  79. package/src/extensions/markdown/code.ts +36 -13
  80. package/src/extensions/markdown/formatting.test.ts +481 -0
  81. package/src/extensions/markdown/formatting.ts +1198 -0
  82. package/src/extensions/markdown/heading.ts +1 -1
  83. package/src/extensions/markdown/index.ts +1 -0
  84. package/src/extensions/markdown/link.ts +12 -2
  85. package/src/hooks/index.ts +2 -0
  86. package/src/hooks/useActionHandler.ts +93 -0
  87. package/src/hooks/useEditorView.ts +29 -0
  88. package/src/hooks/useTextEditor.ts +143 -19
  89. package/src/hooks/useTextModel.ts +28 -9
  90. package/src/index.ts +1 -1
  91. package/src/themes/default.ts +11 -6
  92. package/dist/types/src/components/TextEditor/comments.stories.d.ts.map +0 -1
  93. package/src/components/TextEditor/comments.stories.tsx +0 -357
@@ -8,28 +8,28 @@ import { Annotation, StateEffect, type StateField, type EditorState, type Transa
8
8
 
9
9
  import { type ChangeFn, type ChangeOptions, type Doc, type Heads, type Prop } from '@dxos/automerge/automerge';
10
10
 
11
- // TODO(burdon): Rename.
12
11
  export type State = {
13
12
  path: Prop[];
14
13
  lastHeads: Heads;
15
14
  unreconciledTransactions: Transaction[];
16
15
  };
17
16
 
17
+ export const getPath = (state: EditorState, field: StateField<State>): Prop[] => state.field(field).path;
18
+ export const getLastHeads = (state: EditorState, field: StateField<State>): Heads => state.field(field).lastHeads;
19
+
18
20
  export type UpdateHeads = {
19
21
  newHeads: Heads;
20
22
  };
21
23
 
22
- export const effectType = StateEffect.define<UpdateHeads>({});
23
-
24
- export const reconcileAnnotationType = Annotation.define<unknown>();
24
+ export const updateHeadsEffect = StateEffect.define<UpdateHeads>({});
25
25
 
26
- export const getPath = (state: EditorState, field: StateField<State>): Prop[] => state.field(field).path;
27
-
28
- export const getLastHeads = (state: EditorState, field: StateField<State>): Heads => state.field(field).lastHeads;
26
+ export const updateHeads = (newHeads: Heads): StateEffect<UpdateHeads> => updateHeadsEffect.of({ newHeads });
29
27
 
30
- export const updateHeads = (newHeads: Heads): StateEffect<UpdateHeads> => effectType.of({ newHeads });
28
+ export const reconcileAnnotation = Annotation.define<boolean>();
31
29
 
32
- export const isReconcileTx = (tr: Transaction): boolean => !!tr.annotation(reconcileAnnotationType);
30
+ export const isReconcile = (tr: Transaction): boolean => {
31
+ return !!tr.annotation(reconcileAnnotation);
32
+ };
33
33
 
34
34
  export type IDocHandle<T = any> = {
35
35
  docSync(): Doc<T> | undefined;
@@ -7,13 +7,13 @@
7
7
  import { type StateField } from '@codemirror/state';
8
8
  import { type EditorView } from '@codemirror/view';
9
9
 
10
- import { next as automerge } from '@dxos/automerge/automerge';
10
+ import { next as A } from '@dxos/automerge/automerge';
11
11
 
12
12
  import {
13
13
  getLastHeads,
14
14
  getPath,
15
- isReconcileTx,
16
- reconcileAnnotationType,
15
+ isReconcile,
16
+ reconcileAnnotation,
17
17
  updateHeads,
18
18
  type IDocHandle,
19
19
  type State,
@@ -22,7 +22,7 @@ import { updateAutomerge } from './update-automerge';
22
22
  import { updateCodeMirror } from './update-codemirror';
23
23
 
24
24
  /**
25
- * Implements three-way merge (on each mutation/keystroke).
25
+ * Implements three-way merge (on each mutation).
26
26
  */
27
27
  export class PatchSemaphore {
28
28
  private _inReconcile = false;
@@ -33,13 +33,15 @@ export class PatchSemaphore {
33
33
  private readonly _state: StateField<State>
34
34
  ) {}
35
35
 
36
- // NOTE: Cannot destruct view.state.
37
36
  reconcile(view: EditorView) {
38
- if (this._inReconcile) {
39
- return;
37
+ if (!this._inReconcile) {
38
+ this._inReconcile = true;
39
+ this.doReconcile(view);
40
+ this._inReconcile = false;
40
41
  }
41
- this._inReconcile = true;
42
+ }
42
43
 
44
+ private doReconcile(view: EditorView) {
43
45
  const path = getPath(view.state, this._state);
44
46
 
45
47
  // Get the heads before the unreconciled transactions are applied.
@@ -47,14 +49,14 @@ export class PatchSemaphore {
47
49
  let selection = view.state.selection;
48
50
 
49
51
  // First undo all the unreconciled transactions.
50
- const transactions = view.state.field(this._state).unreconciledTransactions.filter((tx) => !isReconcileTx(tx));
52
+ const transactions = view.state.field(this._state).unreconciledTransactions.filter((tx) => !isReconcile(tx));
51
53
  const toInvert = transactions.slice().reverse();
52
- for (const tx of toInvert) {
53
- const inverted = tx.changes.invert(tx.startState.doc);
54
+ for (const tr of toInvert) {
55
+ const inverted = tr.changes.invert(tr.startState.doc);
54
56
  selection = selection.map(inverted);
55
57
  view.dispatch({
56
58
  changes: inverted,
57
- annotations: reconcileAnnotationType.of(true),
59
+ annotations: reconcileAnnotation.of(true),
58
60
  });
59
61
  }
60
62
 
@@ -63,21 +65,17 @@ export class PatchSemaphore {
63
65
  let newHeads = updateAutomerge(this._state, this._handle, transactions, view.state);
64
66
  if (newHeads === null || newHeads === undefined) {
65
67
  // TODO(alexjg): this is the call that's resetting the editor state on click.
66
- newHeads = automerge.getHeads(this._handle.docSync()!);
68
+ newHeads = A.getHeads(this._handle.docSync()!);
67
69
  }
68
70
 
69
71
  // Now get the diff between the updated state of the document and the heads and apply that to the codemirror doc.
70
- const diff = automerge.equals(oldHeads, newHeads)
71
- ? []
72
- : automerge.diff(this._handle.docSync()!, oldHeads, newHeads);
72
+ const diff = A.equals(oldHeads, newHeads) ? [] : A.diff(this._handle.docSync()!, oldHeads, newHeads);
73
73
  updateCodeMirror(view, selection, path, diff);
74
74
 
75
75
  // Update automerge state.
76
76
  view.dispatch({
77
77
  effects: updateHeads(newHeads),
78
- annotations: reconcileAnnotationType.of({}),
78
+ annotations: reconcileAnnotation.of(false),
79
79
  });
80
-
81
- this._inReconcile = false;
82
80
  }
83
81
  }
@@ -4,9 +4,9 @@
4
4
  // Ref: https://github.com/automerge/automerge-codemirror
5
5
  //
6
6
 
7
- import { type EditorState, type StateField, type Text, type Transaction } from '@codemirror/state';
7
+ import { type EditorState, type StateField, type Transaction, type Text } from '@codemirror/state';
8
8
 
9
- import { next as am, type Heads } from '@dxos/automerge/automerge';
9
+ import { next as A, type Heads } from '@dxos/automerge/automerge';
10
10
 
11
11
  import { type IDocHandle, type State } from './defs';
12
12
 
@@ -14,7 +14,7 @@ export const updateAutomerge = (
14
14
  field: StateField<State>,
15
15
  handle: IDocHandle,
16
16
  transactions: Transaction[],
17
- state: EditorState,
17
+ state: EditorState, // TODO(burdon): Just pass in the state field value?
18
18
  ): Heads | undefined => {
19
19
  const { lastHeads, path } = state.field(field);
20
20
 
@@ -31,12 +31,18 @@ export const updateAutomerge = (
31
31
  return undefined;
32
32
  }
33
33
 
34
- const newHeads = handle.changeAt(lastHeads, (doc: am.Doc<unknown>) => {
34
+ const newHeads = handle.changeAt(lastHeads, (doc: A.Doc<unknown>) => {
35
+ const invertedTransactions: { from: number; del: number; insert: Text }[] = [];
35
36
  for (const tr of transactions) {
36
- tr.changes.iterChanges((fromA: number, toA: number, _fromB: number, _toB: number, inserted: Text) => {
37
- am.splice(doc, path, fromA, toA - fromA, inserted.toString());
37
+ tr.changes.iterChanges((fromA, toA, _fromB, _toB, insert) => {
38
+ invertedTransactions.push({ from: fromA, del: toA - fromA, insert });
38
39
  });
39
40
  }
41
+
42
+ // TODO(burdon): Hack to apply in reverse order to properly apply range.
43
+ invertedTransactions.reverse().forEach(({ from, del, insert }) => {
44
+ A.splice(doc, path.slice(), from, del, insert.toString());
45
+ });
40
46
  });
41
47
 
42
48
  return newHeads ?? undefined;
@@ -16,7 +16,7 @@ import {
16
16
  type SpliceTextPatch,
17
17
  } from '@dxos/automerge/automerge';
18
18
 
19
- import { reconcileAnnotationType } from './defs';
19
+ import { reconcileAnnotation } from './defs';
20
20
 
21
21
  export const updateCodeMirror = (view: EditorView, selection: EditorSelection, target: Prop[], patches: Patch[]) => {
22
22
  for (const patch of patches) {
@@ -26,14 +26,14 @@ export const updateCodeMirror = (view: EditorView, selection: EditorSelection, t
26
26
  selection = selection.map(changeSet, 1);
27
27
  view.dispatch({
28
28
  changes: changeSet,
29
- annotations: reconcileAnnotationType.of({}),
29
+ annotations: reconcileAnnotation.of(false),
30
30
  });
31
31
  }
32
32
  }
33
33
 
34
34
  view.dispatch({
35
35
  selection,
36
- annotations: reconcileAnnotationType.of({}),
36
+ annotations: reconcileAnnotation.of(false),
37
37
  });
38
38
  };
39
39
 
@@ -57,7 +57,7 @@ const handleInsert = (target: Prop[], patch: InsertPatch): Array<ChangeSpec> =>
57
57
  return [];
58
58
  }
59
59
 
60
- const text = patch.values.map((v) => (v ? v.toString() : '')).join('');
60
+ const text = patch.values.map((value) => (value ? value.toString() : '')).join('');
61
61
  return [{ from: index, to: index, insert: text }];
62
62
  };
63
63
 
@@ -88,7 +88,7 @@ const handlePut = (target: Prop[], patch: PutPatch, state: EditorState): Array<C
88
88
 
89
89
  const length = state.doc.length;
90
90
  if (typeof patch.value !== 'string') {
91
- return []; // TODO(dmaretskyi): How to handle non string values?
91
+ return []; // TODO(dmaretskyi): How to handle non-string values?
92
92
  }
93
93
 
94
94
  return [{ from: 0, to: length, insert: patch.value as any }];
@@ -38,7 +38,7 @@ const dummyProvider: AwarenessProvider = {
38
38
  update: () => {},
39
39
  };
40
40
 
41
- export const AwarenessProvider = Facet.define<AwarenessProvider, AwarenessProvider>({
41
+ export const awarenessProvider = Facet.define<AwarenessProvider, AwarenessProvider>({
42
42
  combine: (providers) => providers[0] ?? dummyProvider,
43
43
  });
44
44
 
@@ -68,7 +68,7 @@ export type AwarenessState = {
68
68
  */
69
69
  export const awareness = (provider = dummyProvider): Extension => {
70
70
  return [
71
- AwarenessProvider.of(provider),
71
+ awarenessProvider.of(provider),
72
72
  ViewPlugin.fromClass(RemoteSelectionsDecorator, {
73
73
  decorations: (value) => value.decorations,
74
74
  }),
@@ -91,7 +91,7 @@ export class RemoteSelectionsDecorator implements PluginValue {
91
91
 
92
92
  constructor(view: EditorView) {
93
93
  this._cursorConverter = view.state.facet(Cursor.converter);
94
- this._provider = view.state.facet(AwarenessProvider);
94
+ this._provider = view.state.facet(awarenessProvider);
95
95
  this._provider.open();
96
96
  this._provider.remoteStateChange.on(this._ctx, () => {
97
97
  view.dispatch({ annotations: [RemoteSelectionChangedAnnotation.of([])] });
@@ -207,7 +207,10 @@ export class RemoteSelectionsDecorator implements PluginValue {
207
207
  }
208
208
 
209
209
  class RemoteCaretWidget extends WidgetType {
210
- constructor(private readonly _name: string, private readonly _color: string) {
210
+ constructor(
211
+ private readonly _name: string,
212
+ private readonly _color: string,
213
+ ) {
211
214
  super();
212
215
  }
213
216
 
@@ -10,6 +10,7 @@ import { oneDarkHighlightStyle } from '@codemirror/theme-one-dark';
10
10
  import { drawSelection, EditorView, highlightActiveLine, placeholder } from '@codemirror/view';
11
11
 
12
12
  import { type ThemeMode } from '@dxos/react-ui';
13
+ import { isNotFalsy } from '@dxos/util';
13
14
 
14
15
  import { type TextEditorProps } from '../components';
15
16
 
@@ -17,21 +18,22 @@ export type BasicBundleOptions = {
17
18
  themeMode?: ThemeMode;
18
19
  } & Pick<TextEditorProps, 'placeholder' | 'lineWrapping'>;
19
20
 
20
- export const basicBundle = ({
21
+ export const createBasicBundle = ({
21
22
  themeMode,
22
23
  placeholder: _placeholder,
23
24
  lineWrapping = true,
24
- }: BasicBundleOptions): Extension[] => [
25
- lineWrapping ? EditorView.lineWrapping : [],
25
+ }: BasicBundleOptions = {}): Extension[] =>
26
+ [
27
+ lineWrapping && EditorView.lineWrapping,
26
28
 
27
- // https://codemirror.net/docs/ref/#codemirror.minimalSetup
28
- bracketMatching(),
29
- closeBrackets(),
30
- drawSelection(),
31
- highlightActiveLine(),
32
- history(),
33
- _placeholder ? placeholder(_placeholder) : [],
29
+ // https://codemirror.net/docs/ref/#codemirror.minimalSetup
30
+ bracketMatching(),
31
+ closeBrackets(),
32
+ drawSelection(),
33
+ highlightActiveLine(),
34
+ history(),
35
+ _placeholder && placeholder(_placeholder),
34
36
 
35
- // https://github.com/codemirror/theme-one-dark
36
- themeMode === 'dark' ? syntaxHighlighting(oneDarkHighlightStyle) : syntaxHighlighting(defaultHighlightStyle),
37
- ];
37
+ // https://github.com/codemirror/theme-one-dark
38
+ themeMode === 'dark' ? syntaxHighlighting(oneDarkHighlightStyle) : syntaxHighlighting(defaultHighlightStyle),
39
+ ].filter(isNotFalsy);
@@ -125,7 +125,10 @@ class Blaster {
125
125
 
126
126
  _lastPoint = { x: 0, y: 0 };
127
127
 
128
- constructor(private readonly _node: HTMLElement, private readonly _options: BlastOptions) {
128
+ constructor(
129
+ private readonly _node: HTMLElement,
130
+ private readonly _options: BlastOptions,
131
+ ) {
129
132
  this._effect = this._options.effect === 1 ? new Effect1(_options) : new Effect2(_options);
130
133
  }
131
134
 
@@ -2,13 +2,13 @@
2
2
  // Copyright 2023 DXOS.org
3
3
  //
4
4
 
5
- import { type Extension, StateEffect, StateField, type Text } from '@codemirror/state';
5
+ import { invertedEffects } from '@codemirror/commands';
6
+ import { type Extension, Facet, StateEffect, StateField, type Text, type ChangeDesc } from '@codemirror/state';
6
7
  import { hoverTooltip, keymap, type Command, Decoration, EditorView, type Rect } from '@codemirror/view';
7
8
  import sortBy from 'lodash.sortby';
8
9
  import { useEffect } from 'react';
9
10
 
10
11
  import { debounce } from '@dxos/async';
11
- import { invariant } from '@dxos/invariant';
12
12
  import { nonNullable } from '@dxos/util';
13
13
 
14
14
  import { Cursor } from './cursor';
@@ -18,18 +18,26 @@ import { callbackWrapper } from '../util';
18
18
 
19
19
  // TODO(burdon): Reconcile with theme.
20
20
  const styles = EditorView.baseTheme({
21
- '& .cm-comment': {
21
+ '&light .cm-comment, &light .cm-comment-current': { mixBlendMode: 'darken' },
22
+ '&dark .cm-comment, &dark .cm-comment-current': { mixBlendMode: 'plus-lighter' },
23
+ '&light .cm-comment': {
22
24
  backgroundColor: getToken('extend.colors.yellow.50'),
23
25
  },
24
- '& .cm-comment-current': {
26
+ '&light .cm-comment-current': {
25
27
  backgroundColor: getToken('extend.colors.yellow.100'),
26
28
  },
29
+ '&dark .cm-comment': {
30
+ color: getToken('extend.colors.yellow.50'),
31
+ backgroundColor: getToken('extend.colors.yellow.900'),
32
+ },
33
+ '&dark .cm-comment-current': {
34
+ color: getToken('extend.colors.yellow.100'),
35
+ backgroundColor: getToken('extend.colors.yellow.950'),
36
+ },
27
37
  });
28
38
 
29
- const marks = {
30
- highlight: Decoration.mark({ class: 'cm-comment' }),
31
- highlightActive: Decoration.mark({ class: 'cm-comment-current' }),
32
- };
39
+ const commentMark = Decoration.mark({ class: 'cm-comment' });
40
+ const commentCurrentMark = Decoration.mark({ class: 'cm-comment-current' });
33
41
 
34
42
  type CommentState = {
35
43
  comment: Comment;
@@ -47,7 +55,7 @@ export type CommentsState = {
47
55
  selection: SelectionState;
48
56
  };
49
57
 
50
- export const setFocus = (view: EditorView, id: string, center = true) => {
58
+ export const focusComment = (view: EditorView, id: string, center = true) => {
51
59
  const comment = view.state.field(commentsState).comments.find((range) => range.comment.id === id);
52
60
  if (!comment?.comment.cursor) {
53
61
  return;
@@ -115,7 +123,7 @@ const commentsState = StateField.define<CommentsState>({
115
123
  /**
116
124
  * Decorate ranges.
117
125
  */
118
- const highlightDecorations = EditorView.decorations.compute([commentsState], (state) => {
126
+ const commentsDecorations = EditorView.decorations.compute([commentsState], (state) => {
119
127
  const {
120
128
  selection: { current },
121
129
  comments,
@@ -130,9 +138,9 @@ const highlightDecorations = EditorView.decorations.compute([commentsState], (st
130
138
  }
131
139
 
132
140
  if (comment.comment.id === current) {
133
- return marks.highlightActive.range(range.from, range.to);
141
+ return commentCurrentMark.range(range.from, range.to);
134
142
  } else {
135
- return marks.highlight.range(range.from, range.to);
143
+ return commentMark.range(range.from, range.to);
136
144
  }
137
145
  })
138
146
  .filter(nonNullable);
@@ -148,7 +156,7 @@ export type CommentsOptions = {
148
156
  /**
149
157
  * Called to create a new thread and return the thread id.
150
158
  */
151
- onCreate?: (cursor: string, location?: Rect | null) => string | undefined;
159
+ onCreate?: (params: { cursor: string; from: number; location?: Rect | null }) => string | undefined;
152
160
  /**
153
161
  * Selection cut/deleted.
154
162
  */
@@ -167,11 +175,11 @@ export type CommentsOptions = {
167
175
  onHover?: (el: Element, shortcut: string) => void;
168
176
  };
169
177
 
170
- // TODO(burdon): Handle cut/restore via undo (need to integrate with history?)
178
+ type TrackedComment = { id: string; from: number; to: number };
179
+
171
180
  const trackPastedComments = (onUpdate: NonNullable<CommentsOptions['onUpdate']>) => {
172
181
  // Tracks indexed selections within text.
173
- // TODO(burdon): Move to main state field?
174
- let tracked: { text: Text; comments: { id: string; from: number; to: number }[] } | null = null;
182
+ let tracked: { text: Text; comments: TrackedComment[] } | null = null;
175
183
 
176
184
  // Track cut or copy (enables cut-and-paste and copy-delete-paste to restore comment selection).
177
185
  const handleTrack = (event: Event, view: EditorView) => {
@@ -201,16 +209,48 @@ const trackPastedComments = (onUpdate: NonNullable<CommentsOptions['onUpdate']>)
201
209
  copy: handleTrack,
202
210
  }),
203
211
 
204
- // Handle paste.
205
- EditorView.updateListener.of(({ view, state, transactions }) => {
212
+ // Track deleted comments.
213
+ invertedEffects.of((tr) => {
214
+ const { comments } = tr.startState.field(commentsState);
215
+ const effects: StateEffect<any>[] = [];
216
+ tr.changes.iterChangedRanges((fromA, toA) => {
217
+ for (const {
218
+ comment: { id },
219
+ range: { from, to },
220
+ } of comments) {
221
+ if (from < to && from >= fromA && to <= toA) {
222
+ effects.push(restoreCommentEffect.of({ id, from, to }));
223
+ }
224
+ }
225
+ });
226
+
227
+ return effects;
228
+ }),
229
+
230
+ // Handle paste or the undo of comment deletion.
231
+ EditorView.updateListener.of((update) => {
232
+ const restore: TrackedComment[] = [];
233
+
234
+ for (let i = 0; i < update.transactions.length; i++) {
235
+ const tr = update.transactions[i];
236
+ for (let j = 0; j < restore.length; j++) {
237
+ restore[j] = mapTrackedComment(restore[j], tr.changes);
238
+ }
239
+ for (const effect of tr.effects) {
240
+ if (effect.is(restoreCommentEffect)) {
241
+ restore.push(effect.value);
242
+ }
243
+ }
244
+ }
245
+
206
246
  if (tracked) {
207
- const paste = transactions.find((tr) => tr.isUserEvent('input.paste'));
247
+ const paste = update.transactions.find((tr) => tr.isUserEvent('input.paste'));
208
248
  if (paste) {
209
249
  let found = -1;
210
250
  paste.changes.iterChanges((fromA, toA, fromB, toB, text) => {
211
251
  if (text.eq(tracked!.text)) {
212
- for (let i = transactions.indexOf(paste!) + 1; i < transactions.length; i++) {
213
- fromB = transactions[i].changes.mapPos(fromB);
252
+ for (let i = update.transactions.indexOf(paste!) + 1; i < update.transactions.length; i++) {
253
+ fromB = update.transactions[i].changes.mapPos(fromB);
214
254
  }
215
255
 
216
256
  found = fromB;
@@ -219,23 +259,78 @@ const trackPastedComments = (onUpdate: NonNullable<CommentsOptions['onUpdate']>)
219
259
 
220
260
  if (found > -1) {
221
261
  for (const moved of tracked.comments) {
222
- const range = {
223
- from: found + moved.from,
224
- to: found + moved.to,
225
- };
226
-
227
- const cursor = Cursor.getCursorFromRange(state, range);
228
- onUpdate(moved.id, cursor);
262
+ restore.push({ id: moved.id, from: found + moved.from, to: found + moved.to });
229
263
  }
230
264
  }
231
265
 
232
266
  tracked = null;
233
267
  }
234
268
  }
269
+
270
+ for (const comment of restore) {
271
+ const { comments } = update.startState.field(commentsState);
272
+ const exists = comments.some((c) => c.comment.id === comment.id && c.range.from < c.range.to);
273
+ if (!exists) {
274
+ const cursor = Cursor.getCursorFromRange(update.state, comment);
275
+ onUpdate(comment.id, cursor);
276
+ }
277
+ }
235
278
  }),
236
279
  ];
237
280
  };
238
281
 
282
+ const mapTrackedComment = (comment: TrackedComment, changes: ChangeDesc) => ({
283
+ id: comment.id,
284
+ from: changes.mapPos(comment.from, 1),
285
+ to: changes.mapPos(comment.to, 1),
286
+ });
287
+
288
+ // These are attached to undone/redone transactions in the editor for the purpose of restoring comments
289
+ // that were deleted by the original changes.
290
+ const restoreCommentEffect = StateEffect.define<TrackedComment>({ map: mapTrackedComment });
291
+
292
+ const optionsFacet = Facet.define<CommentsOptions, CommentsOptions>({
293
+ combine: (providers) => providers[0],
294
+ });
295
+
296
+ /**
297
+ * Create comment thread action.
298
+ */
299
+ export const createComment: Command = (view) => {
300
+ const options = view.state.facet(optionsFacet);
301
+ const { from, to } = view.state.selection.main;
302
+ if (from === to) {
303
+ return false;
304
+ }
305
+
306
+ // Don't allow selection at end of document.
307
+ if (to === view.state.doc.length) {
308
+ view.dispatch({
309
+ changes: {
310
+ from: to,
311
+ insert: '\n',
312
+ },
313
+ });
314
+ }
315
+
316
+ const cursor = Cursor.getCursorFromRange(view.state, { from, to });
317
+ if (cursor) {
318
+ // Create thread via callback.
319
+ const id = options.onCreate?.({ cursor, from, location: view.coordsAtPos(from) });
320
+ if (id) {
321
+ // Update range.
322
+ view.dispatch({
323
+ effects: setSelection.of({ current: id }),
324
+ selection: { anchor: to },
325
+ });
326
+
327
+ return true;
328
+ }
329
+ }
330
+
331
+ return false;
332
+ };
333
+
239
334
  /**
240
335
  * Comment threads.
241
336
  * 1). Updates the EditorModel to store relative selections for a set of comments threads.
@@ -252,47 +347,10 @@ export const comments = (options: CommentsOptions = {}): Extension => {
252
347
 
253
348
  const handleSelect = debounce((state: CommentsState) => options.onSelect?.(state), 200);
254
349
 
255
- /**
256
- * Create comment thread action.
257
- */
258
- const createCommentThread: Command = (view) => {
259
- invariant(options.onCreate);
260
- const { from, to } = view.state.selection.main;
261
- if (from === to) {
262
- return false;
263
- }
264
-
265
- // Don't allow selection at end of document.
266
- if (to === view.state.doc.length) {
267
- view.dispatch({
268
- changes: {
269
- from: to,
270
- insert: '\n',
271
- },
272
- });
273
- }
274
-
275
- const cursor = Cursor.getCursorFromRange(view.state, { from, to });
276
- if (cursor) {
277
- // Create thread via callback.
278
- const id = options.onCreate?.(cursor, view.coordsAtPos(from));
279
- if (id) {
280
- // Update range.
281
- view.dispatch({
282
- effects: setSelection.of({ current: id }),
283
- selection: { anchor: from },
284
- });
285
-
286
- return true;
287
- }
288
- }
289
-
290
- return false;
291
- };
292
-
293
350
  return [
351
+ optionsFacet.of(options),
294
352
  commentsState,
295
- highlightDecorations,
353
+ commentsDecorations,
296
354
  styles,
297
355
 
298
356
  //
@@ -302,7 +360,7 @@ export const comments = (options: CommentsOptions = {}): Extension => {
302
360
  ? keymap.of([
303
361
  {
304
362
  key: shortcut,
305
- run: callbackWrapper(createCommentThread),
363
+ run: callbackWrapper(createComment),
306
364
  },
307
365
  ])
308
366
  : [],
@@ -21,13 +21,14 @@ import {
21
21
  } from '@codemirror/view';
22
22
 
23
23
  import type { ThemeMode } from '@dxos/react-ui';
24
+ import { isNotFalsy } from '@dxos/util';
24
25
 
25
26
  import { markdownHighlightStyle, markdownTagsExtensions } from './highlight';
26
27
  import { type TextEditorProps } from '../../components';
27
28
 
28
29
  export type MarkdownBundleOptions = {
29
30
  themeMode?: ThemeMode;
30
- } & Pick<TextEditorProps, 'placeholder'>;
31
+ } & Pick<TextEditorProps, 'placeholder' | 'lineWrapping'>;
31
32
 
32
33
  /**
33
34
  * Markdown bundle.
@@ -36,11 +37,15 @@ export type MarkdownBundleOptions = {
36
37
  * https://codemirror.net/docs/ref/#codemirror.basicSetup
37
38
  */
38
39
  // TODO(burdon): Add Composer here: https://codemirror.net/docs/community
39
- export const markdownBundle = ({ themeMode, placeholder: _placeholder }: MarkdownBundleOptions): Extension[] => {
40
+ export const createMarkdownExtensions = ({
41
+ themeMode,
42
+ placeholder: _placeholder,
43
+ lineWrapping = true,
44
+ }: MarkdownBundleOptions = {}): Extension[] => {
40
45
  return [
46
+ lineWrapping && EditorView.lineWrapping,
41
47
  EditorState.allowMultipleSelections.of(true),
42
48
  EditorState.tabSize.of(2),
43
- EditorView.lineWrapping,
44
49
 
45
50
  // https://github.com/codemirror/basic-setup
46
51
  bracketMatching(),
@@ -51,7 +56,7 @@ export const markdownBundle = ({ themeMode, placeholder: _placeholder }: Markdow
51
56
  highlightActiveLine(),
52
57
  history(),
53
58
  indentOnInput(),
54
- _placeholder ? placeholder(_placeholder) : [],
59
+ _placeholder && placeholder(_placeholder),
55
60
 
56
61
  // Main extension.
57
62
  // https://github.com/codemirror/lang-markdown
@@ -92,5 +97,5 @@ export const markdownBundle = ({ themeMode, placeholder: _placeholder }: Markdow
92
97
  // https://codemirror.net/docs/ref/#commands.standardKeymap
93
98
  ...standardKeymap,
94
99
  ]),
95
- ];
100
+ ].filter(isNotFalsy);
96
101
  };