@dxos/react-ui-editor 0.3.11-main.68db74e → 0.3.11-main.69484a6

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 (180) hide show
  1. package/dist/lib/browser/index.mjs +1632 -1056
  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 +13 -15
  5. package/dist/types/src/components/TextEditor/MarkdownEditor.stories.d.ts.map +1 -1
  6. package/dist/types/src/components/TextEditor/TextEditor.d.ts +14 -6
  7. package/dist/types/src/components/TextEditor/TextEditor.d.ts.map +1 -1
  8. package/dist/types/src/components/TextEditor/TextEditor.stories.d.ts +1 -1
  9. package/dist/types/src/components/TextEditor/automerge.stories.d.ts.map +1 -1
  10. package/dist/types/src/components/TextEditor/comments.stories.d.ts +1 -1
  11. package/dist/types/src/components/TextEditor/comments.stories.d.ts.map +1 -1
  12. package/dist/types/src/components/TextEditor/{yjs.stories.d.ts → hooks.stories.d.ts} +13 -2
  13. package/dist/types/src/components/TextEditor/hooks.stories.d.ts.map +1 -0
  14. package/dist/types/src/components/Toolbar/Toolbar.d.ts +25 -0
  15. package/dist/types/src/components/Toolbar/Toolbar.d.ts.map +1 -0
  16. package/dist/types/src/components/Toolbar/Toolbar.stories.d.ts +23 -0
  17. package/dist/types/src/components/Toolbar/Toolbar.stories.d.ts.map +1 -0
  18. package/dist/types/src/components/Toolbar/index.d.ts +2 -0
  19. package/dist/types/src/components/Toolbar/index.d.ts.map +1 -0
  20. package/dist/types/src/components/index.d.ts +1 -0
  21. package/dist/types/src/components/index.d.ts.map +1 -1
  22. package/dist/types/src/extensions/autocomplete.d.ts.map +1 -1
  23. package/dist/types/src/extensions/automerge/automerge.d.ts.map +1 -1
  24. package/dist/types/src/extensions/automerge/automerge.spec.d.ts +2 -0
  25. package/dist/types/src/extensions/automerge/automerge.spec.d.ts.map +1 -0
  26. package/dist/types/src/extensions/automerge/automerge.test.d.ts +2 -0
  27. package/dist/types/src/extensions/automerge/automerge.test.d.ts.map +1 -0
  28. package/dist/types/src/extensions/automerge/defs.d.ts +9 -11
  29. package/dist/types/src/extensions/automerge/defs.d.ts.map +1 -1
  30. package/dist/types/src/extensions/automerge/index.d.ts +0 -1
  31. package/dist/types/src/extensions/automerge/index.d.ts.map +1 -1
  32. package/dist/types/src/extensions/automerge/semaphore.d.ts +8 -12
  33. package/dist/types/src/extensions/automerge/semaphore.d.ts.map +1 -1
  34. package/dist/types/src/extensions/automerge/update-automerge.d.ts +2 -2
  35. package/dist/types/src/extensions/automerge/update-automerge.d.ts.map +1 -1
  36. package/dist/types/src/extensions/awareness.d.ts +2 -2
  37. package/dist/types/src/extensions/awareness.d.ts.map +1 -1
  38. package/dist/types/src/extensions/basic.d.ts +4 -5
  39. package/dist/types/src/extensions/basic.d.ts.map +1 -1
  40. package/dist/types/src/extensions/comments.d.ts +35 -18
  41. package/dist/types/src/extensions/comments.d.ts.map +1 -1
  42. package/dist/types/src/extensions/cursor.d.ts +3 -3
  43. package/dist/types/src/extensions/cursor.d.ts.map +1 -1
  44. package/dist/types/src/extensions/index.d.ts +1 -7
  45. package/dist/types/src/extensions/index.d.ts.map +1 -1
  46. package/dist/types/src/extensions/markdown/bundle.d.ts +3 -6
  47. package/dist/types/src/extensions/markdown/bundle.d.ts.map +1 -1
  48. package/dist/types/src/extensions/markdown/code.d.ts.map +1 -0
  49. package/dist/types/src/extensions/markdown/formatting.d.ts +13 -0
  50. package/dist/types/src/extensions/markdown/formatting.d.ts.map +1 -0
  51. package/dist/types/src/extensions/markdown/heading.d.ts +6 -0
  52. package/dist/types/src/extensions/markdown/heading.d.ts.map +1 -0
  53. package/dist/types/src/extensions/markdown/highlight.d.ts.map +1 -1
  54. package/dist/types/src/extensions/markdown/hr.d.ts.map +1 -0
  55. package/dist/types/src/extensions/markdown/image.d.ts.map +1 -0
  56. package/dist/types/src/extensions/markdown/index.d.ts +8 -0
  57. package/dist/types/src/extensions/markdown/index.d.ts.map +1 -1
  58. package/dist/types/src/extensions/markdown/link.d.ts.map +1 -0
  59. package/dist/types/src/extensions/markdown/table.d.ts.map +1 -0
  60. package/dist/types/src/extensions/markdown/tasklist.d.ts +3 -0
  61. package/dist/types/src/extensions/markdown/tasklist.d.ts.map +1 -0
  62. package/dist/types/src/extensions/mention.d.ts.map +1 -1
  63. package/dist/types/src/extensions/outliner.d.ts +4 -0
  64. package/dist/types/src/extensions/outliner.d.ts.map +1 -0
  65. package/dist/types/src/hooks/awareness-provider.d.ts +7 -4
  66. package/dist/types/src/hooks/awareness-provider.d.ts.map +1 -1
  67. package/dist/types/src/hooks/defs.d.ts +25 -0
  68. package/dist/types/src/hooks/defs.d.ts.map +1 -0
  69. package/dist/types/src/hooks/index.d.ts +4 -2
  70. package/dist/types/src/hooks/index.d.ts.map +1 -1
  71. package/dist/types/src/hooks/useActionHandler.d.ts +4 -0
  72. package/dist/types/src/hooks/useActionHandler.d.ts.map +1 -0
  73. package/dist/types/src/hooks/useEditorView.d.ts +17 -0
  74. package/dist/types/src/hooks/useEditorView.d.ts.map +1 -0
  75. package/dist/types/src/hooks/useTextEditor.d.ts +39 -0
  76. package/dist/types/src/hooks/useTextEditor.d.ts.map +1 -0
  77. package/dist/types/src/hooks/useTextModel.d.ts +2 -27
  78. package/dist/types/src/hooks/useTextModel.d.ts.map +1 -1
  79. package/dist/types/src/styles/markdown.d.ts +2 -2
  80. package/dist/types/src/styles/markdown.d.ts.map +1 -1
  81. package/dist/types/src/util.d.ts +2 -0
  82. package/dist/types/src/util.d.ts.map +1 -1
  83. package/package.json +47 -37
  84. package/src/components/TextEditor/MarkdownEditor.stories.tsx +73 -82
  85. package/src/components/TextEditor/TextEditor.tsx +112 -75
  86. package/src/components/TextEditor/automerge.stories.tsx +1 -2
  87. package/src/components/TextEditor/comments.stories.tsx +113 -71
  88. package/src/components/TextEditor/hooks.stories.tsx +106 -0
  89. package/src/components/Toolbar/Toolbar.stories.tsx +90 -0
  90. package/src/components/Toolbar/Toolbar.tsx +166 -0
  91. package/src/components/Toolbar/index.ts +5 -0
  92. package/src/components/index.ts +1 -0
  93. package/src/extensions/autocomplete.ts +6 -3
  94. package/src/extensions/automerge/automerge.spec.tsx +76 -0
  95. package/src/extensions/automerge/automerge.test.ts +13 -0
  96. package/src/extensions/automerge/automerge.ts +54 -45
  97. package/src/extensions/automerge/cursor.ts +3 -3
  98. package/src/extensions/automerge/defs.ts +13 -34
  99. package/src/extensions/automerge/index.ts +0 -1
  100. package/src/extensions/automerge/semaphore.ts +33 -32
  101. package/src/extensions/automerge/update-automerge.ts +14 -8
  102. package/src/extensions/automerge/update-codemirror.ts +5 -5
  103. package/src/extensions/awareness.ts +18 -17
  104. package/src/extensions/basic.ts +17 -10
  105. package/src/extensions/comments.ts +316 -165
  106. package/src/extensions/cursor.ts +7 -3
  107. package/src/extensions/index.ts +1 -7
  108. package/src/extensions/markdown/bundle.ts +23 -28
  109. package/src/extensions/markdown/code.ts +150 -0
  110. package/src/extensions/markdown/formatting.ts +188 -0
  111. package/src/extensions/markdown/heading.ts +59 -0
  112. package/src/extensions/markdown/highlight.ts +9 -15
  113. package/src/extensions/markdown/hr.ts +71 -0
  114. package/src/extensions/markdown/index.ts +8 -0
  115. package/src/extensions/{link.ts → markdown/link.ts} +8 -5
  116. package/src/extensions/{tasklist.ts → markdown/tasklist.ts} +48 -33
  117. package/src/extensions/mention.ts +9 -2
  118. package/src/extensions/outliner.ts +12 -0
  119. package/src/hooks/awareness-provider.ts +24 -20
  120. package/src/hooks/defs.ts +42 -0
  121. package/src/hooks/index.ts +5 -2
  122. package/src/hooks/useActionHandler.ts +62 -0
  123. package/src/hooks/useEditorView.ts +29 -0
  124. package/src/hooks/useTextEditor.ts +153 -0
  125. package/src/hooks/useTextModel.ts +49 -55
  126. package/src/styles/markdown.ts +9 -10
  127. package/src/themes/default.ts +4 -4
  128. package/src/util.ts +26 -3
  129. package/dist/types/src/components/TextEditor/codemirror.stories.d.ts +0 -12
  130. package/dist/types/src/components/TextEditor/codemirror.stories.d.ts.map +0 -1
  131. package/dist/types/src/components/TextEditor/yjs.stories.d.ts.map +0 -1
  132. package/dist/types/src/extensions/code.d.ts.map +0 -1
  133. package/dist/types/src/extensions/hr.d.ts.map +0 -1
  134. package/dist/types/src/extensions/image.d.ts.map +0 -1
  135. package/dist/types/src/extensions/link.d.ts.map +0 -1
  136. package/dist/types/src/extensions/table.d.ts.map +0 -1
  137. package/dist/types/src/extensions/tasklist.d.ts +0 -7
  138. package/dist/types/src/extensions/tasklist.d.ts.map +0 -1
  139. package/dist/types/src/extensions/yjs/cursor.d.ts +0 -4
  140. package/dist/types/src/extensions/yjs/cursor.d.ts.map +0 -1
  141. package/dist/types/src/extensions/yjs/index.d.ts +0 -2
  142. package/dist/types/src/extensions/yjs/index.d.ts.map +0 -1
  143. package/dist/types/src/extensions/yjs/yjs.d.ts +0 -4
  144. package/dist/types/src/extensions/yjs/yjs.d.ts.map +0 -1
  145. package/dist/types/src/extensions/yjs/yjs.test.d.ts +0 -2
  146. package/dist/types/src/extensions/yjs/yjs.test.d.ts.map +0 -1
  147. package/dist/types/src/hooks/automerge.d.ts +0 -3
  148. package/dist/types/src/hooks/automerge.d.ts.map +0 -1
  149. package/dist/types/src/hooks/yjs.d.ts +0 -27
  150. package/dist/types/src/hooks/yjs.d.ts.map +0 -1
  151. package/dist/types/src/testing/index.d.ts +0 -3
  152. package/dist/types/src/testing/index.d.ts.map +0 -1
  153. package/dist/types/src/testing/proto/gen/schema.d.ts +0 -15
  154. package/dist/types/src/testing/proto/gen/schema.d.ts.map +0 -1
  155. package/dist/types/src/testing/proto/index.d.ts +0 -2
  156. package/dist/types/src/testing/proto/index.d.ts.map +0 -1
  157. package/dist/types/src/testing/replicator.d.ts +0 -45
  158. package/dist/types/src/testing/replicator.d.ts.map +0 -1
  159. package/src/components/TextEditor/codemirror.stories.ts +0 -115
  160. package/src/components/TextEditor/yjs.stories.tsx +0 -56
  161. package/src/extensions/code.ts +0 -106
  162. package/src/extensions/hr.ts +0 -73
  163. package/src/extensions/yjs/cursor.ts +0 -22
  164. package/src/extensions/yjs/index.ts +0 -5
  165. package/src/extensions/yjs/yjs.test.ts +0 -35
  166. package/src/extensions/yjs/yjs.ts +0 -16
  167. package/src/hooks/automerge.ts +0 -52
  168. package/src/hooks/yjs.ts +0 -156
  169. package/src/testing/index.ts +0 -6
  170. package/src/testing/proto/gen/schema.ts +0 -49
  171. package/src/testing/proto/index.ts +0 -5
  172. package/src/testing/proto/schema.proto +0 -15
  173. package/src/testing/replicator.ts +0 -184
  174. /package/dist/types/src/extensions/{code.d.ts → markdown/code.d.ts} +0 -0
  175. /package/dist/types/src/extensions/{hr.d.ts → markdown/hr.d.ts} +0 -0
  176. /package/dist/types/src/extensions/{image.d.ts → markdown/image.d.ts} +0 -0
  177. /package/dist/types/src/extensions/{link.d.ts → markdown/link.d.ts} +0 -0
  178. /package/dist/types/src/extensions/{table.d.ts → markdown/table.d.ts} +0 -0
  179. /package/src/extensions/{image.ts → markdown/image.ts} +0 -0
  180. /package/src/extensions/{table.ts → markdown/table.ts} +0 -0
@@ -49,9 +49,11 @@ export const defaultTheme: ThemeStyles = {
49
49
  '&.cm-focused': {
50
50
  outline: 'none',
51
51
  },
52
+
52
53
  '.cm-scroller': {
53
- overflow: 'visible',
54
+ // overflow: 'visible',
54
55
  fontFamily: get(tokens, 'fontFamily.mono', []).join(','),
56
+ lineHeight: 1.4,
55
57
  },
56
58
 
57
59
  '.cm-content': {
@@ -86,11 +88,9 @@ export const defaultTheme: ThemeStyles = {
86
88
  //
87
89
  '.cm-line': {
88
90
  paddingInline: 0,
89
- // TODO(burdon): Other values leave gaps between lines when highlighted.
90
- // lineHeight: 'normal',
91
91
  },
92
92
  '.cm-activeLine': {
93
- background: 'inherit',
93
+ background: 'transparent',
94
94
  },
95
95
 
96
96
  //
package/src/util.ts CHANGED
@@ -2,17 +2,40 @@
2
2
  // Copyright 2024 DXOS.org
3
3
  //
4
4
 
5
+ import type { Transaction } from '@codemirror/state';
6
+
5
7
  import { log } from '@dxos/log';
6
8
 
7
9
  /**
8
10
  * CodeMirror callbacks swallow errors so wrap handlers.
9
11
  */
10
- // TODO(burdon): Figure out how to systematize this.
12
+ // TODO(burdon): EditorView.exceptionSink should catch errors.
11
13
  export const callbackWrapper = <T extends Function>(fn: T): T =>
12
14
  ((...args: any[]) => {
13
15
  try {
14
16
  return fn(...args);
15
- } catch (error) {
16
- log.catch(error);
17
+ } catch (err) {
18
+ log.catch(err);
17
19
  }
18
20
  }) as unknown as T;
21
+
22
+ export const logChanges = (trs: readonly Transaction[]) => {
23
+ const changes = trs
24
+ .flatMap((tr) => {
25
+ if (tr.changes.empty) {
26
+ return undefined;
27
+ }
28
+
29
+ const changes: any[] = [];
30
+ tr.changes.iterChanges((fromA, toA, fromB, toB, inserted) =>
31
+ changes.push(JSON.stringify({ fromA, toA, fromB, toB, inserted: inserted.toString() })),
32
+ );
33
+
34
+ return changes;
35
+ })
36
+ .filter(Boolean);
37
+
38
+ if (changes.length) {
39
+ console.log('changes', changes);
40
+ }
41
+ };
@@ -1,12 +0,0 @@
1
- import { type StoryObj } from '@storybook/html';
2
- import { Client, type PublicKey } from '@dxos/react-client';
3
- declare const _default: {
4
- title: string;
5
- };
6
- export default _default;
7
- export declare const Default: StoryObj<{
8
- id: number;
9
- client: Client;
10
- spaceKey: PublicKey;
11
- }>;
12
- //# sourceMappingURL=codemirror.stories.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"codemirror.stories.d.ts","sourceRoot":"","sources":["../../../../../src/components/TextEditor/codemirror.stories.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAMhD,OAAO,EAAE,MAAM,EAAE,KAAK,SAAS,EAAE,MAAM,oBAAoB,CAAC;;;;AAU5D,wBAEE;AAqEF,eAAO,MAAM,OAAO,EAAE,QAAQ,CAAC;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,SAAS,CAAA;CAAE,CAoBjF,CAAC"}
@@ -1 +0,0 @@
1
- {"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,wBAIE;AA+BF,eAAO,MAAM,OAAO;;CAGnB,CAAC"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"code.d.ts","sourceRoot":"","sources":["../../../../src/extensions/code.ts"],"names":[],"mappings":"AAsDA,eAAO,MAAM,IAAI,+CAmDhB,CAAC"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"hr.d.ts","sourceRoot":"","sources":["../../../../src/extensions/hr.ts"],"names":[],"mappings":"AAkDA,eAAO,MAAM,EAAE,+CAsBd,CAAC"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"image.d.ts","sourceRoot":"","sources":["../../../../src/extensions/image.ts"],"names":[],"mappings":"AAKA,OAAO,EAAoB,KAAK,SAAS,EAA4C,MAAM,mBAAmB,CAAC;AAG/G,MAAM,MAAM,YAAY,GAAG,EAAE,CAAC;AAE9B,eAAO,MAAM,KAAK,aAAa,YAAY,KAAQ,SA8BlD,CAAC"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"link.d.ts","sourceRoot":"","sources":["../../../../src/extensions/link.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,SAAS,EAAmB,MAAM,mBAAmB,CAAC;AAkBpE,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,CAAC,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IAC7C,QAAQ,CAAC,EAAE,CAAC,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;CAC/C,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,IAAI,aAAa,WAAW,KAAQ,SAsDhD,CAAC"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"table.d.ts","sourceRoot":"","sources":["../../../../src/extensions/table.ts"],"names":[],"mappings":"AAKA,OAAO,EAAoB,KAAK,QAAQ,EAAmB,UAAU,EAAoB,MAAM,mBAAmB,CAAC;AASnH,MAAM,MAAM,YAAY,GAAG,EAAE,CAAC;AAE9B;;;GAGG;AACH,eAAO,MAAM,KAAK,aAAa,YAAY,8BAM1C,CAAC"}
@@ -1,7 +0,0 @@
1
- import { ViewPlugin, type DecorationSet, type ViewUpdate } from '@codemirror/view';
2
- export type TasklistOptions = {};
3
- export declare const tasklist: (options?: TasklistOptions) => ViewPlugin<{
4
- decorations: DecorationSet;
5
- update(update: ViewUpdate): void;
6
- }>;
7
- //# sourceMappingURL=tasklist.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"tasklist.d.ts","sourceRoot":"","sources":["../../../../src/extensions/tasklist.ts"],"names":[],"mappings":"AAMA,OAAO,EAAsC,UAAU,EAAE,KAAK,aAAa,EAAE,KAAK,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAyCvH,MAAM,MAAM,eAAe,GAAG,EAAE,CAAC;AAEjC,eAAO,MAAM,QAAQ,aAAa,eAAe;;mBAS5B,UAAU;EAc9B,CAAC"}
@@ -1,4 +0,0 @@
1
- import * as Y from 'yjs';
2
- import { type CursorConverter } from '../cursor';
3
- export declare const cursorConverter: (text: Y.Text) => CursorConverter;
4
- //# sourceMappingURL=cursor.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"cursor.d.ts","sourceRoot":"","sources":["../../../../../src/extensions/yjs/cursor.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAIzB,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,WAAW,CAAC;AAEjD,eAAO,MAAM,eAAe,SAAU,MAAM,KAAG,eAW7C,CAAC"}
@@ -1,2 +0,0 @@
1
- export * from './yjs';
2
- //# sourceMappingURL=index.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/extensions/yjs/index.ts"],"names":[],"mappings":"AAIA,cAAc,OAAO,CAAC"}
@@ -1,4 +0,0 @@
1
- import type * as YP from 'y-protocols/awareness';
2
- import type { YText } from '@dxos/text-model';
3
- export declare const yjs: (content: YText, awareness?: YP.Awareness) => import("@codemirror/state").Extension[];
4
- //# sourceMappingURL=yjs.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"yjs.d.ts","sourceRoot":"","sources":["../../../../../src/extensions/yjs/yjs.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAEjD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAK9C,eAAO,MAAM,GAAG,YAAa,KAAK,cAAc,GAAG,SAAS,4CAG3D,CAAC"}
@@ -1,2 +0,0 @@
1
- export {};
2
- //# sourceMappingURL=yjs.test.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"yjs.test.d.ts","sourceRoot":"","sources":["../../../../../src/extensions/yjs/yjs.test.ts"],"names":[],"mappings":""}
@@ -1,3 +0,0 @@
1
- import { type EditorModel, type UseTextModelProps } from './useTextModel';
2
- export declare const createAutomergeModel: ({ space, identity, text }: UseTextModelProps) => EditorModel;
3
- //# sourceMappingURL=automerge.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"automerge.d.ts","sourceRoot":"","sources":["../../../../src/hooks/automerge.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,KAAK,WAAW,EAAc,KAAK,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAItF,eAAO,MAAM,oBAAoB,8BAA+B,iBAAiB,KAAG,WAqCnF,CAAC"}
@@ -1,27 +0,0 @@
1
- import { Observable } from 'lib0/observable';
2
- import * as YP from 'y-protocols/awareness';
3
- import { type Doc } from 'yjs';
4
- import { type Space } from '@dxos/react-client/echo';
5
- import { type EditorModel, type UseTextModelProps } from './useTextModel';
6
- export declare const createYjsModel: ({ identity, space, text }: UseTextModelProps) => EditorModel;
7
- /**
8
- * Yjs awareness provider on top of a DXOS space.
9
- */
10
- export declare class YAwarenessProvider extends Observable<any> {
11
- private readonly _space;
12
- private readonly _awareness;
13
- private readonly _clientId;
14
- private readonly _channel;
15
- constructor({ space, doc, channel, awareness, }: {
16
- space: Space;
17
- doc: Doc;
18
- channel: string;
19
- awareness?: YP.Awareness;
20
- });
21
- get awareness(): YP.Awareness;
22
- private _handleAwarenessUpdate;
23
- private _handleSpaceMessage;
24
- private _readMessage;
25
- private _handleBeforeUnload;
26
- }
27
- //# sourceMappingURL=yjs.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"yjs.d.ts","sourceRoot":"","sources":["../../../../src/hooks/yjs.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAC5C,OAAO,EAAE,KAAK,GAAG,EAAE,MAAM,KAAK,CAAC;AAI/B,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,yBAAyB,CAAC;AAIrD,OAAO,EAAE,KAAK,WAAW,EAAc,KAAK,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAGtF,eAAO,MAAM,cAAc,8BAA+B,iBAAiB,KAAG,WAqB7E,CAAC;AAOF;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,UAAU,CAAC,GAAG,CAAC;IACrD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAQ;IAC/B,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAe;IAC1C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;gBAEtB,EACV,KAAK,EACL,GAAG,EACH,OAAO,EACP,SAAS,GACV,EAAE;QACD,KAAK,EAAE,KAAK,CAAC;QACb,GAAG,EAAE,GAAG,CAAC;QACT,OAAO,EAAE,MAAM,CAAC;QAChB,SAAS,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC;KAC1B;IA4BD,IAAI,SAAS,IAAI,EAAE,CAAC,SAAS,CAE5B;IAED,OAAO,CAAC,sBAAsB;IAS9B,OAAO,CAAC,mBAAmB;IAS3B,OAAO,CAAC,YAAY;IAoCpB,OAAO,CAAC,mBAAmB;CAG5B"}
@@ -1,3 +0,0 @@
1
- export * from './proto';
2
- export * from './replicator';
3
- //# sourceMappingURL=index.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/testing/index.ts"],"names":[],"mappings":"AAIA,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC"}
@@ -1,15 +0,0 @@
1
- /**
2
- * @generated @dxos/echo-typegen src/testing/proto/schema.proto
3
- **/
4
- import * as dxos_echo_schema from "@dxos/echo-schema";
5
- export declare const types: dxos_echo_schema.TypeCollection;
6
- export type EditorDocumentProps = {
7
- content: dxos_echo_schema.Text;
8
- };
9
- export declare class EditorDocument extends dxos_echo_schema.TypedObject<EditorDocumentProps> {
10
- static readonly schema: dxos_echo_schema.Schema;
11
- static filter(filter?: Partial<EditorDocumentProps> | dxos_echo_schema.OperatorFilter<EditorDocument>): dxos_echo_schema.Filter<EditorDocument>;
12
- constructor(initValues?: Partial<EditorDocumentProps>, opts?: dxos_echo_schema.TypedObjectOptions);
13
- content: dxos_echo_schema.Text;
14
- }
15
- //# sourceMappingURL=schema.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../../../../src/testing/proto/gen/schema.ts"],"names":[],"mappings":"AAAA;;IAEI;AAEJ,OAAO,KAAK,gBAAgB,MAAM,mBAAmB,CAAC;AAEtD,eAAO,MAAM,KAAK,iCAAwC,CAAC;AAE3D,MAAM,MAAM,mBAAmB,GAAG;IAChC,OAAO,EAAE,gBAAgB,CAAC,IAAI,CAAC;CAChC,CAAC;AAEF,qBAAa,cAAe,SAAQ,gBAAgB,CAAC,WAAW,CAAC,mBAAmB,CAAC;IACnF,gBAAwB,MAAM,EAAE,gBAAgB,CAAC,MAAM,CAAC;IAExD,MAAM,CAAC,MAAM,CACX,MAAM,CAAC,EACH,OAAO,CAAC,mBAAmB,CAAC,GAC5B,gBAAgB,CAAC,cAAc,CAAC,cAAc,CAAC,GAClD,gBAAgB,CAAC,MAAM,CAAC,cAAc,CAAC;gBAQxC,UAAU,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC,EACzC,IAAI,CAAC,EAAE,gBAAgB,CAAC,kBAAkB;IAIpC,OAAO,EAAE,gBAAgB,CAAC,IAAI,CAAC;CACxC"}
@@ -1,2 +0,0 @@
1
- export * from './gen/schema';
2
- //# sourceMappingURL=index.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/testing/proto/index.ts"],"names":[],"mappings":"AAIA,cAAc,cAAc,CAAC"}
@@ -1,45 +0,0 @@
1
- import { Observable } from 'lib0/observable';
2
- import * as YP from 'y-protocols/awareness';
3
- import { Doc } from 'yjs';
4
- import { Event } from '@dxos/async';
5
- import { TextKind } from '@dxos/protocols/proto/dxos/echo/model/text';
6
- import { type EditorModel } from '../hooks';
7
- type Awareness = YP.Awareness;
8
- /**
9
- * Yjs awareness provider in-memory.
10
- */
11
- export declare class AwarenessProvider extends Observable<any> {
12
- private readonly _remoteUpdate;
13
- private readonly _awareness;
14
- private readonly _doc;
15
- constructor({ update, doc, awareness }: {
16
- update: Event<Uint8Array>;
17
- doc: Doc;
18
- awareness?: Awareness;
19
- });
20
- get awareness(): Awareness;
21
- private _handleDocUpdate;
22
- private _handleAwarenessUpdate;
23
- private _handleRemoteUpdate;
24
- private _readMessage;
25
- private _handleBeforeUnload;
26
- }
27
- /**
28
- * This mocks the replication across the swarm.
29
- */
30
- export declare class Replicator {
31
- private readonly _kind;
32
- private readonly _update;
33
- private _peers;
34
- constructor(_kind: TextKind);
35
- setPeers(peers: EditorModel[]): void;
36
- createPeer: (id: string, doc?: Doc) => EditorModel;
37
- }
38
- export type UseYjsModelOptions = {
39
- replicator: Replicator;
40
- id: string;
41
- doc?: Doc;
42
- };
43
- export declare const useYjsModel: ({ replicator, id, doc }: UseYjsModelOptions) => EditorModel;
44
- export {};
45
- //# sourceMappingURL=replicator.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"replicator.d.ts","sourceRoot":"","sources":["../../../../src/testing/replicator.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,OAAO,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAE5C,OAAO,EAAE,GAAG,EAAE,MAAM,KAAK,CAAC;AAE1B,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAEpC,OAAO,EAAE,QAAQ,EAAE,MAAM,4CAA4C,CAAC;AAEtE,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,UAAU,CAAC;AAG5C,KAAK,SAAS,GAAG,EAAE,CAAC,SAAS,CAAC;AAM9B;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,UAAU,CAAC,GAAG,CAAC;IACpD,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAoB;IAClD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAY;IACvC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAM;gBAEf,EAAE,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,EAAE;QAAE,MAAM,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;QAAC,GAAG,EAAE,GAAG,CAAC;QAAC,SAAS,CAAC,EAAE,SAAS,CAAA;KAAE;IA4BtG,IAAI,SAAS,IAAI,SAAS,CAEzB;IAED,OAAO,CAAC,gBAAgB;IAQxB,OAAO,CAAC,sBAAsB;IAS9B,OAAO,CAAC,mBAAmB;IAS3B,OAAO,CAAC,YAAY;IA0CpB,OAAO,CAAC,mBAAmB;CAG5B;AAED;;GAEG;AACH,qBAAa,UAAU;IAIT,OAAO,CAAC,QAAQ,CAAC,KAAK;IAHlC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA2B;IACnD,OAAO,CAAC,MAAM,CAAqB;gBAEN,KAAK,EAAE,QAAQ;IAE5C,QAAQ,CAAC,KAAK,EAAE,WAAW,EAAE;IAI7B,UAAU,OAAQ,MAAM,QAAO,GAAG,KAAe,WAAW,CAoB1D;CACH;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,UAAU,EAAE,UAAU,CAAC;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,CAAC,EAAE,GAAG,CAAC;CACX,CAAC;AAEF,eAAO,MAAM,WAAW,4BAA6B,kBAAkB,KAAG,WAEzE,CAAC"}
@@ -1,115 +0,0 @@
1
- //
2
- // Copyright 2023 DXOS.org
3
- //
4
-
5
- import { markdown, markdownLanguage } from '@codemirror/lang-markdown';
6
- import { EditorState } from '@codemirror/state';
7
- import { EditorView } from '@codemirror/view';
8
- import { type StoryObj } from '@storybook/html';
9
- import { basicSetup } from 'codemirror';
10
- import { yCollab } from 'y-codemirror.next';
11
-
12
- import { EventSubscriptions } from '@dxos/async';
13
- import { generateName } from '@dxos/display-name';
14
- import { Client, type PublicKey } from '@dxos/react-client';
15
- import { type Space, TextObject } from '@dxos/react-client/echo';
16
- import { type Identity } from '@dxos/react-client/halo';
17
- import { joinCommonSpace, TestBuilder, textGenerator } from '@dxos/react-client/testing';
18
- import { YText } from '@dxos/text-model';
19
-
20
- import { YAwarenessProvider } from '../../hooks';
21
- import { cursorColor } from '../../styles';
22
- import { EditorDocument, types as schema } from '../../testing';
23
-
24
- export default {
25
- title: 'CodeMirror',
26
- };
27
-
28
- const testBuilder = new TestBuilder();
29
- const views: Record<number, EditorView> = {};
30
- const subscriptions = new EventSubscriptions();
31
-
32
- const updateEditor = async (id: number, editor: HTMLDivElement, identity: Identity, space: Space, text: TextObject) => {
33
- const doc = text.doc;
34
- const ytext = text.content;
35
- if (!(ytext instanceof YText) || !doc) {
36
- return;
37
- }
38
-
39
- const { awareness } = new YAwarenessProvider({ space, doc, channel: `yjs.awareness.${text.id}` });
40
- awareness.setLocalStateField('user', {
41
- name: identity.profile?.displayName ?? generateName(identity.identityKey.toHex()),
42
- // TODO(wittjosiah): Pick colours from theme based on identity key.
43
- color: cursorColor.color,
44
- colorLight: cursorColor.light,
45
- });
46
-
47
- const state = EditorState.create({
48
- doc: ytext.toString(),
49
- extensions: [basicSetup, markdown({ base: markdownLanguage }), yCollab(ytext, awareness)],
50
- });
51
-
52
- const view = views[id];
53
- if (view) {
54
- view.setState(state);
55
- } else {
56
- views[id] = new EditorView({ state, parent: editor });
57
- }
58
-
59
- if (id === 0) {
60
- subscriptions.clear();
61
- subscriptions.add(textGenerator({ text: ytext }));
62
- }
63
- };
64
-
65
- const setupEditor = async (id: number, client: Client, spaceKey: PublicKey, editor: HTMLDivElement) => {
66
- const space = await client.spaces.get(spaceKey)!;
67
- const query = space.db.query(EditorDocument.filter());
68
- query.subscribe(({ objects }) => {
69
- const text = objects[0]?.content;
70
- void (text && updateEditor(id, editor, client.halo.identity.get()!, space, text));
71
- });
72
-
73
- const text = query.objects[0]?.content;
74
- void (text && updateEditor(id, editor, client.halo.identity.get()!, space, text));
75
- };
76
-
77
- const setupSpace = async (count: number) => {
78
- const clients = [...Array(count)].map(() => new Client({ services: testBuilder.createLocal() }));
79
- await Promise.all(clients.map((client) => client.initialize()));
80
- await Promise.all(clients.map((client) => client.halo.createIdentity()));
81
- clients.map((client) => client.spaces.addSchema(schema));
82
-
83
- const space = await clients[0].spaces.create();
84
- const text = new TextObject('Hello, Storybook!');
85
- const document = new EditorDocument({ content: text });
86
- await space.db.add(document);
87
-
88
- await joinCommonSpace(clients, space.key);
89
-
90
- return { clients, spaceKey: space.key };
91
- };
92
-
93
- const count = 2;
94
-
95
- export const Default: StoryObj<{ id: number; client: Client; spaceKey: PublicKey }> = {
96
- render: ({ id, client, spaceKey }) => {
97
- const editor = document.createElement('div');
98
- editor.setAttribute('style', 'min-width: 0; flex: 1; padding: 1rem;');
99
- void setupEditor(id, client, spaceKey, editor);
100
- return editor;
101
- },
102
- decorators: [
103
- (story) => {
104
- const container = document.createElement('div');
105
- container.setAttribute('style', 'display: flex; justify-content: space-evenly');
106
- void setupSpace(count).then(({ clients, spaceKey }) => {
107
- clients.forEach((client, id) => {
108
- // TODO(wittjosiah): According to the docs these types should be compatible.
109
- container.appendChild(story({ args: { id, client, spaceKey } }) as HTMLElement);
110
- });
111
- });
112
- return container;
113
- },
114
- ],
115
- };
@@ -1,56 +0,0 @@
1
- //
2
- // Copyright 2023 DXOS.org
3
- //
4
-
5
- import '@dxosTheme';
6
-
7
- import React, { useState } from 'react';
8
-
9
- import { PublicKey } from '@dxos/react-client';
10
- import { TextKind } from '@dxos/react-client/echo';
11
- import { ClientRepeater, textGenerator, useDataGenerator } from '@dxos/react-client/testing';
12
- import { useId, Input } from '@dxos/react-ui';
13
- import { withTheme } from '@dxos/storybook-utils';
14
-
15
- import { MarkdownEditor } from './TextEditor';
16
- import { Replicator, useYjsModel } from '../../testing';
17
-
18
- export default {
19
- title: 'react-ui-editor/YJS',
20
- component: MarkdownEditor,
21
- decorators: [withTheme],
22
- };
23
-
24
- const replicator = new Replicator(TextKind.PLAIN);
25
-
26
- const Story = () => {
27
- const [generate, setGenerate] = useState(false);
28
- const generateId = useId('generate');
29
-
30
- const [id] = useState(PublicKey.random().toHex());
31
- const model = useYjsModel({ id, replicator });
32
-
33
- useDataGenerator({
34
- generator: generate ? textGenerator : undefined,
35
- options: { text: typeof model?.content !== 'string' ? (model?.content as any) : undefined },
36
- });
37
-
38
- return (
39
- <main className='flex flex-col flex-1 p-4 gap-4'>
40
- <div id={generateId} className='flex gap-2'>
41
- <Input.Root>
42
- <Input.Checkbox checked={generate} onCheckedChange={(checked) => setGenerate(!!checked)} />
43
- <Input.Label>Start</Input.Label>
44
- </Input.Root>
45
- </div>
46
- <div className='border'>
47
- <MarkdownEditor model={model} />
48
- </div>
49
- </main>
50
- );
51
- };
52
-
53
- export const Default = {
54
- // TODO(wittjosiah): Decorator for doing this without clients being initialized?
55
- render: () => <ClientRepeater count={2} Component={Story} />,
56
- };
@@ -1,106 +0,0 @@
1
- //
2
- // Copyright 2023 DXOS.org
3
- //
4
-
5
- import { type Range } from '@codemirror/state';
6
- import {
7
- ViewPlugin,
8
- type DecorationSet,
9
- EditorView,
10
- type ViewUpdate,
11
- Decoration,
12
- type BlockInfo,
13
- } from '@codemirror/view';
14
-
15
- import { mx } from '@dxos/react-ui-theme';
16
-
17
- import { getToken } from '../styles';
18
-
19
- const CODE_REGEX = /```[\s\S]*?```/gs;
20
-
21
- // TODO(burdon): Reconcile with theme.
22
- const styles = EditorView.baseTheme({
23
- '& .cm-codeblock': {
24
- fontFamily: getToken('fontFamily.mono', []).join(','),
25
- },
26
- '&light [aria-readonly="true"] .cm-codeblock': {
27
- background: getToken('extend.colors.neutral.50'),
28
- },
29
- '&dark [aria-readonly="true"] .cm-codeblock': {
30
- background: getToken('extend.colors.neutral.850'),
31
- },
32
- '& [aria-readonly="true"] .cm-codeblock': {
33
- display: 'block',
34
- paddingInline: '4px !important',
35
- },
36
- '& [aria-readonly="true"] .cm-codeblock-first': {
37
- paddingTop: '4px !important',
38
- borderTopLeftRadius: '4px',
39
- borderTopRightRadius: '4px',
40
- },
41
- '& [aria-readonly="true"] .cm-codeblock-last': {
42
- paddingBottom: '4px !important',
43
- borderBottomLeftRadius: '4px',
44
- borderBottomRightRadius: '4px',
45
- },
46
- });
47
-
48
- // TODO(burdon): Start from EditorView.lineBlockAt(pos).
49
- const getLineRange = (lines: BlockInfo[], from: number, to: number) => {
50
- const start = lines.findIndex((line) => line.from >= from);
51
- const end = lines.findIndex((line) => line.to >= to);
52
- return [start, end];
53
- };
54
-
55
- export const code = () => {
56
- const getDecorations = (view: EditorView) => {
57
- const decorations: Range<Decoration>[] = [];
58
- if (!view.hasFocus || view.state.readOnly) {
59
- const text = view.state.doc.sliceString(0);
60
- const matches = text.matchAll(CODE_REGEX);
61
- const blocks = view.viewportLineBlocks;
62
- for (const match of matches) {
63
- const range = getLineRange(blocks, match.index!, match.index! + match[0].length);
64
- for (let i = range[0]; i <= range[1]; i++) {
65
- const block = blocks[i];
66
- decorations.push(
67
- Decoration.line({
68
- class: mx('cm-codeblock', i === range[0] && 'cm-codeblock-first', i === range[1] && 'cm-codeblock-last'),
69
- }).range(block.from),
70
- );
71
- }
72
- }
73
- }
74
-
75
- return Decoration.set(decorations);
76
- };
77
-
78
- return [
79
- ViewPlugin.fromClass(
80
- class {
81
- hasFocus = false;
82
- decorations: DecorationSet;
83
- constructor(view: EditorView) {
84
- this.decorations = getDecorations(view);
85
- }
86
-
87
- update(update: ViewUpdate) {
88
- if (
89
- // TODO(burdon): Generalize for other extensions.
90
- this.hasFocus !== update.view.hasFocus ||
91
- update.startState.readOnly !== update.view.state.readOnly ||
92
- update.docChanged ||
93
- update.viewportChanged
94
- ) {
95
- this.hasFocus = update.view.hasFocus;
96
- this.decorations = getDecorations(update.view);
97
- }
98
- }
99
- },
100
- {
101
- decorations: (value) => value.decorations,
102
- },
103
- ),
104
- styles,
105
- ];
106
- };
@@ -1,73 +0,0 @@
1
- //
2
- // Copyright 2023 DXOS.org
3
- //
4
-
5
- import {
6
- Decoration,
7
- type DecorationSet,
8
- EditorView,
9
- MatchDecorator,
10
- ViewPlugin,
11
- type ViewUpdate,
12
- WidgetType,
13
- } from '@codemirror/view';
14
-
15
- import { getToken } from '../styles';
16
-
17
- // TODO(burdon): Reconcile with theme.
18
- const styles = EditorView.baseTheme({
19
- '& .cm-hr': {
20
- // TODO(burdon): ???
21
- // Note that block-level decorations should not have vertical margins,
22
- borderBottom: `1px solid ${getToken('extend.colors.neutral.200')}`,
23
- },
24
- });
25
-
26
- class HorizontalRuleWidget extends WidgetType {
27
- constructor(readonly _pos: number) {
28
- super();
29
- }
30
-
31
- override eq(other: this) {
32
- return this._pos === (other as any as HorizontalRuleWidget)._pos;
33
- }
34
-
35
- override toDOM(view: EditorView) {
36
- // TODO(burdon): Create <hr> element? Does this clash with markdown parser?
37
- const el = document.createElement('div');
38
- el.className = 'cm-hr';
39
- return el;
40
- }
41
- }
42
-
43
- const placeholderMatcher = new MatchDecorator({
44
- regexp: /^---$/g,
45
- decoration: (match, view, pos) =>
46
- Decoration.replace({
47
- widget: new HorizontalRuleWidget(pos),
48
- }),
49
- });
50
-
51
- export const hr = () => [
52
- styles,
53
- ViewPlugin.fromClass(
54
- class {
55
- rules: DecorationSet;
56
- constructor(view: EditorView) {
57
- this.rules = placeholderMatcher.createDeco(view);
58
- }
59
-
60
- update(update: ViewUpdate) {
61
- this.rules = placeholderMatcher.updateDeco(update, this.rules);
62
- }
63
- },
64
- {
65
- decorations: (instance) => instance.rules,
66
- // TODO(burdon): Is this really atomic (cursor can move into ---).
67
- provide: (plugin) =>
68
- EditorView.atomicRanges.of((view) => {
69
- return view.plugin(plugin)?.rules || Decoration.none;
70
- }),
71
- },
72
- ),
73
- ];