@dxos/react-ui-editor 0.3.11-main.c244d7e → 0.3.11-main.c865ffb

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 (168) hide show
  1. package/dist/lib/browser/index.mjs +1385 -929
  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 +7 -11
  5. package/dist/types/src/components/TextEditor/MarkdownEditor.stories.d.ts.map +1 -1
  6. package/dist/types/src/components/TextEditor/TextEditor.d.ts +3 -2
  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/{yjs.stories.d.ts → hooks.stories.d.ts} +13 -2
  11. package/dist/types/src/components/TextEditor/hooks.stories.d.ts.map +1 -0
  12. package/dist/types/src/components/Toolbar/Toolbar.d.ts +25 -0
  13. package/dist/types/src/components/Toolbar/Toolbar.d.ts.map +1 -0
  14. package/dist/types/src/components/Toolbar/Toolbar.stories.d.ts +23 -0
  15. package/dist/types/src/components/Toolbar/Toolbar.stories.d.ts.map +1 -0
  16. package/dist/types/src/components/Toolbar/index.d.ts +2 -0
  17. package/dist/types/src/components/Toolbar/index.d.ts.map +1 -0
  18. package/dist/types/src/components/index.d.ts +1 -0
  19. package/dist/types/src/components/index.d.ts.map +1 -1
  20. package/dist/types/src/extensions/automerge/automerge.d.ts.map +1 -1
  21. package/dist/types/src/extensions/automerge/automerge.spec.d.ts +2 -0
  22. package/dist/types/src/extensions/automerge/automerge.spec.d.ts.map +1 -0
  23. package/dist/types/src/extensions/automerge/automerge.test.d.ts +2 -0
  24. package/dist/types/src/extensions/automerge/automerge.test.d.ts.map +1 -0
  25. package/dist/types/src/extensions/automerge/defs.d.ts +5 -5
  26. package/dist/types/src/extensions/automerge/defs.d.ts.map +1 -1
  27. package/dist/types/src/extensions/automerge/semaphore.d.ts +2 -1
  28. package/dist/types/src/extensions/automerge/semaphore.d.ts.map +1 -1
  29. package/dist/types/src/extensions/automerge/update-automerge.d.ts.map +1 -1
  30. package/dist/types/src/extensions/awareness.d.ts +2 -4
  31. package/dist/types/src/extensions/awareness.d.ts.map +1 -1
  32. package/dist/types/src/extensions/basic.d.ts +2 -2
  33. package/dist/types/src/extensions/basic.d.ts.map +1 -1
  34. package/dist/types/src/extensions/comments.d.ts +9 -5
  35. package/dist/types/src/extensions/comments.d.ts.map +1 -1
  36. package/dist/types/src/extensions/index.d.ts +0 -7
  37. package/dist/types/src/extensions/index.d.ts.map +1 -1
  38. package/dist/types/src/extensions/markdown/bundle.d.ts +2 -2
  39. package/dist/types/src/extensions/markdown/bundle.d.ts.map +1 -1
  40. package/dist/types/src/extensions/markdown/code.d.ts.map +1 -0
  41. package/dist/types/src/extensions/markdown/formatting.d.ts +13 -0
  42. package/dist/types/src/extensions/markdown/formatting.d.ts.map +1 -0
  43. package/dist/types/src/extensions/markdown/heading.d.ts +6 -0
  44. package/dist/types/src/extensions/markdown/heading.d.ts.map +1 -0
  45. package/dist/types/src/extensions/markdown/highlight.d.ts.map +1 -1
  46. package/dist/types/src/extensions/markdown/hr.d.ts.map +1 -0
  47. package/dist/types/src/extensions/markdown/image.d.ts.map +1 -0
  48. package/dist/types/src/extensions/markdown/index.d.ts +8 -0
  49. package/dist/types/src/extensions/markdown/index.d.ts.map +1 -1
  50. package/dist/types/src/extensions/markdown/link.d.ts.map +1 -0
  51. package/dist/types/src/extensions/markdown/table.d.ts.map +1 -0
  52. package/dist/types/src/extensions/markdown/tasklist.d.ts.map +1 -0
  53. package/dist/types/src/extensions/mention.d.ts.map +1 -1
  54. package/dist/types/src/hooks/awareness-provider.d.ts +7 -4
  55. package/dist/types/src/hooks/awareness-provider.d.ts.map +1 -1
  56. package/dist/types/src/hooks/defs.d.ts +1 -4
  57. package/dist/types/src/hooks/defs.d.ts.map +1 -1
  58. package/dist/types/src/hooks/index.d.ts +3 -2
  59. package/dist/types/src/hooks/index.d.ts.map +1 -1
  60. package/dist/types/src/hooks/useActionHandler.d.ts +4 -0
  61. package/dist/types/src/hooks/useActionHandler.d.ts.map +1 -0
  62. package/dist/types/src/hooks/useEditorView.d.ts +17 -0
  63. package/dist/types/src/hooks/useEditorView.d.ts.map +1 -0
  64. package/dist/types/src/hooks/useTextEditor.d.ts +39 -0
  65. package/dist/types/src/hooks/useTextEditor.d.ts.map +1 -0
  66. package/dist/types/src/hooks/useTextModel.d.ts +12 -0
  67. package/dist/types/src/hooks/useTextModel.d.ts.map +1 -1
  68. package/dist/types/src/index.d.ts +1 -1
  69. package/dist/types/src/index.d.ts.map +1 -1
  70. package/dist/types/src/styles/markdown.d.ts +2 -2
  71. package/dist/types/src/styles/markdown.d.ts.map +1 -1
  72. package/dist/types/src/themes/default.d.ts.map +1 -1
  73. package/package.json +46 -36
  74. package/src/components/TextEditor/MarkdownEditor.stories.tsx +41 -46
  75. package/src/components/TextEditor/TextEditor.tsx +46 -27
  76. package/src/components/TextEditor/automerge.stories.tsx +1 -2
  77. package/src/components/TextEditor/hooks.stories.tsx +106 -0
  78. package/src/components/Toolbar/Toolbar.stories.tsx +90 -0
  79. package/src/components/Toolbar/Toolbar.tsx +166 -0
  80. package/src/components/Toolbar/index.ts +5 -0
  81. package/src/components/index.ts +1 -0
  82. package/src/extensions/automerge/automerge.spec.tsx +76 -0
  83. package/src/extensions/automerge/automerge.test.ts +13 -0
  84. package/src/extensions/automerge/automerge.ts +44 -11
  85. package/src/extensions/automerge/cursor.ts +3 -3
  86. package/src/extensions/automerge/defs.ts +9 -9
  87. package/src/extensions/automerge/semaphore.ts +18 -24
  88. package/src/extensions/automerge/update-automerge.ts +12 -6
  89. package/src/extensions/automerge/update-codemirror.ts +5 -5
  90. package/src/extensions/awareness.ts +21 -35
  91. package/src/extensions/basic.ts +17 -15
  92. package/src/extensions/blast.ts +4 -1
  93. package/src/extensions/comments.ts +126 -78
  94. package/src/extensions/index.ts +0 -7
  95. package/src/extensions/markdown/bundle.ts +9 -8
  96. package/src/extensions/markdown/code.ts +150 -0
  97. package/src/extensions/markdown/formatting.ts +188 -0
  98. package/src/extensions/markdown/heading.ts +59 -0
  99. package/src/extensions/markdown/highlight.ts +9 -15
  100. package/src/extensions/{hr.ts → markdown/hr.ts} +3 -4
  101. package/src/extensions/markdown/index.ts +8 -0
  102. package/src/extensions/{link.ts → markdown/link.ts} +13 -4
  103. package/src/extensions/{tasklist.ts → markdown/tasklist.ts} +2 -3
  104. package/src/extensions/mention.ts +6 -4
  105. package/src/hooks/awareness-provider.ts +24 -20
  106. package/src/hooks/defs.ts +1 -6
  107. package/src/hooks/index.ts +3 -2
  108. package/src/hooks/useActionHandler.ts +62 -0
  109. package/src/hooks/useEditorView.ts +29 -0
  110. package/src/hooks/useTextEditor.ts +153 -0
  111. package/src/hooks/useTextModel.ts +65 -12
  112. package/src/index.ts +1 -1
  113. package/src/styles/markdown.ts +9 -10
  114. package/src/themes/default.ts +9 -6
  115. package/dist/types/src/components/TextEditor/codemirror.stories.d.ts +0 -12
  116. package/dist/types/src/components/TextEditor/codemirror.stories.d.ts.map +0 -1
  117. package/dist/types/src/components/TextEditor/comments.stories.d.ts +0 -26
  118. package/dist/types/src/components/TextEditor/comments.stories.d.ts.map +0 -1
  119. package/dist/types/src/components/TextEditor/yjs.stories.d.ts.map +0 -1
  120. package/dist/types/src/extensions/code.d.ts.map +0 -1
  121. package/dist/types/src/extensions/hr.d.ts.map +0 -1
  122. package/dist/types/src/extensions/image.d.ts.map +0 -1
  123. package/dist/types/src/extensions/link.d.ts.map +0 -1
  124. package/dist/types/src/extensions/table.d.ts.map +0 -1
  125. package/dist/types/src/extensions/tasklist.d.ts.map +0 -1
  126. package/dist/types/src/extensions/yjs/cursor.d.ts +0 -4
  127. package/dist/types/src/extensions/yjs/cursor.d.ts.map +0 -1
  128. package/dist/types/src/extensions/yjs/index.d.ts +0 -2
  129. package/dist/types/src/extensions/yjs/index.d.ts.map +0 -1
  130. package/dist/types/src/extensions/yjs/yjs.d.ts +0 -4
  131. package/dist/types/src/extensions/yjs/yjs.d.ts.map +0 -1
  132. package/dist/types/src/extensions/yjs/yjs.test.d.ts +0 -2
  133. package/dist/types/src/extensions/yjs/yjs.test.d.ts.map +0 -1
  134. package/dist/types/src/hooks/automerge.d.ts +0 -4
  135. package/dist/types/src/hooks/automerge.d.ts.map +0 -1
  136. package/dist/types/src/hooks/yjs.d.ts +0 -28
  137. package/dist/types/src/hooks/yjs.d.ts.map +0 -1
  138. package/dist/types/src/testing/index.d.ts +0 -3
  139. package/dist/types/src/testing/index.d.ts.map +0 -1
  140. package/dist/types/src/testing/proto/gen/schema.d.ts +0 -15
  141. package/dist/types/src/testing/proto/gen/schema.d.ts.map +0 -1
  142. package/dist/types/src/testing/proto/index.d.ts +0 -2
  143. package/dist/types/src/testing/proto/index.d.ts.map +0 -1
  144. package/dist/types/src/testing/replicator.d.ts +0 -45
  145. package/dist/types/src/testing/replicator.d.ts.map +0 -1
  146. package/src/components/TextEditor/codemirror.stories.ts +0 -115
  147. package/src/components/TextEditor/comments.stories.tsx +0 -357
  148. package/src/components/TextEditor/yjs.stories.tsx +0 -56
  149. package/src/extensions/code.ts +0 -104
  150. package/src/extensions/yjs/cursor.ts +0 -22
  151. package/src/extensions/yjs/index.ts +0 -5
  152. package/src/extensions/yjs/yjs.test.ts +0 -35
  153. package/src/extensions/yjs/yjs.ts +0 -16
  154. package/src/hooks/automerge.ts +0 -53
  155. package/src/hooks/yjs.ts +0 -157
  156. package/src/testing/index.ts +0 -6
  157. package/src/testing/proto/gen/schema.ts +0 -49
  158. package/src/testing/proto/index.ts +0 -5
  159. package/src/testing/proto/schema.proto +0 -15
  160. package/src/testing/replicator.ts +0 -184
  161. /package/dist/types/src/extensions/{code.d.ts → markdown/code.d.ts} +0 -0
  162. /package/dist/types/src/extensions/{hr.d.ts → markdown/hr.d.ts} +0 -0
  163. /package/dist/types/src/extensions/{image.d.ts → markdown/image.d.ts} +0 -0
  164. /package/dist/types/src/extensions/{link.d.ts → markdown/link.d.ts} +0 -0
  165. /package/dist/types/src/extensions/{table.d.ts → markdown/table.d.ts} +0 -0
  166. /package/dist/types/src/extensions/{tasklist.d.ts → markdown/tasklist.d.ts} +0 -0
  167. /package/src/extensions/{image.ts → markdown/image.ts} +0 -0
  168. /package/src/extensions/{table.ts → markdown/table.ts} +0 -0
@@ -1,28 +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 } from './defs';
6
- import { type UseTextModelProps } from './useTextModel';
7
- export declare const createYjsModel: ({ identity, space, text }: UseTextModelProps) => EditorModel;
8
- /**
9
- * Yjs awareness provider on top of a DXOS space.
10
- */
11
- export declare class YAwarenessProvider extends Observable<any> {
12
- private readonly _space;
13
- private readonly _awareness;
14
- private readonly _clientId;
15
- private readonly _channel;
16
- constructor({ space, doc, channel, awareness, }: {
17
- space: Space;
18
- doc: Doc;
19
- channel: string;
20
- awareness?: YP.Awareness;
21
- });
22
- get awareness(): YP.Awareness;
23
- private _handleAwarenessUpdate;
24
- private _handleSpaceMessage;
25
- private _readMessage;
26
- private _handleBeforeUnload;
27
- }
28
- //# 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,MAAM,QAAQ,CAAC;AACtD,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAGxD,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,357 +0,0 @@
1
- //
2
- // Copyright 2023 DXOS.org
3
- //
4
-
5
- import '@dxosTheme';
6
-
7
- import { type EditorView, keymap } from '@codemirror/view';
8
- import { faker } from '@faker-js/faker';
9
- import { Check, Trash } from '@phosphor-icons/react';
10
- import React, { type FC, useEffect, useMemo, useRef, useState } from 'react';
11
-
12
- import { getTextContent, TextObject } from '@dxos/echo-schema';
13
- import { PublicKey } from '@dxos/keys';
14
- import { log } from '@dxos/log';
15
- import { Button, DensityProvider } from '@dxos/react-ui';
16
- import { fixedInsetFlexLayout, mx } from '@dxos/react-ui-theme';
17
- import { withTheme } from '@dxos/storybook-utils';
18
-
19
- import { MarkdownEditor, TextEditor } from './TextEditor';
20
- import { comments, type CommentsOptions, setFocus, useComments } from '../../extensions';
21
- import { type Comment, type Range, useTextModel } from '../../hooks';
22
-
23
- faker.seed(101);
24
-
25
- //
26
- // Editor
27
- //
28
-
29
- const Editor: FC<{
30
- item: { text: TextObject };
31
- comments: Comment[];
32
- selected?: string;
33
- onCreateComment: CommentsOptions['onCreate'];
34
- onDeleteComment: CommentsOptions['onDelete'];
35
- onUpdateComment: CommentsOptions['onUpdate'];
36
- onSelectComment: CommentsOptions['onSelect'];
37
- }> = ({
38
- item,
39
- selected: selectedValue,
40
- comments: commentRanges,
41
- onCreateComment,
42
- onDeleteComment,
43
- onUpdateComment,
44
- onSelectComment,
45
- }) => {
46
- const model = useTextModel({ text: item.text });
47
- const view = useRef<EditorView>(null);
48
- const [selected, setSelected] = useState<string>();
49
- useEffect(() => {
50
- if (!view.current?.hasFocus && selectedValue !== selected) {
51
- setSelected(selectedValue);
52
- if (selectedValue) {
53
- setFocus(view.current!, selectedValue);
54
- }
55
- }
56
- }, [selected, commentRanges, selectedValue]);
57
-
58
- useComments(view.current, commentRanges);
59
-
60
- const extensions = useMemo(() => {
61
- return [
62
- comments({
63
- onCreate: onCreateComment,
64
- onDelete: onDeleteComment,
65
- onUpdate: onUpdateComment,
66
- onSelect: onSelectComment,
67
- }),
68
- ];
69
- }, []);
70
-
71
- if (!model) {
72
- return null;
73
- }
74
-
75
- // TODO(burdon): Highlight currently selected comment.
76
- return (
77
- <div className='flex grow overflow-y-scroll'>
78
- <MarkdownEditor ref={view} model={model} extensions={extensions} />
79
- </div>
80
- );
81
- };
82
-
83
- //
84
- // Comments thread
85
- //
86
-
87
- type CommentThread = {
88
- id: string;
89
- cursor?: string;
90
- range?: Range;
91
- yPos?: number;
92
- messages: TextObject[];
93
- };
94
-
95
- const Thread: FC<{
96
- thread: CommentThread;
97
- selected: boolean;
98
- onSelect: () => void;
99
- onResolve: () => void;
100
- }> = ({ thread, selected, onSelect, onResolve }) => {
101
- const [focus, setFocus] = useState(false);
102
- const [item, setItem] = useState({ text: new TextObject() });
103
- const model = useTextModel({ text: item.text });
104
- const editorRef = useRef<EditorView>(null);
105
-
106
- const containerRef = useRef<HTMLDivElement>(null);
107
- useEffect(() => {
108
- if (selected) {
109
- containerRef.current?.scrollIntoView({ block: 'center', behavior: 'smooth' });
110
- if (thread.messages.length === 0) {
111
- setFocus(true);
112
- }
113
- }
114
- }, [selected]);
115
-
116
- const handleCreateMessage = () => {
117
- const text = model?.text().trim();
118
- if (text?.length) {
119
- thread.messages.push(item.text);
120
- setItem({ text: new TextObject() });
121
- setFocus(true);
122
- }
123
- };
124
-
125
- if (!model) {
126
- return null;
127
- }
128
-
129
- return (
130
- <div
131
- className={mx(
132
- 'flex flex-col m-1 rounded shadow divide-y bg-white',
133
- selected && 'ring',
134
- !thread.cursor && 'opacity-50',
135
- )}
136
- >
137
- <div className='flex p-2 gap-2 items-center text-xs font-mono text-neutral-500 font-thin'>
138
- <span>id:{thread.id.slice(0, 4)}</span>
139
- <span>from:{thread.range?.from}</span>
140
- <span>to:{thread.range?.to}</span>
141
- <span>y:{thread.yPos}</span>
142
- <span className='grow' />
143
- {!thread.cursor && <Trash />}
144
- </div>
145
-
146
- {thread.messages.map((message, i) => (
147
- // TODO(burdon): Fix default editor padding so content doesn't jump on creating message.
148
- <div key={i} className='p-2' onClick={() => onSelect()}>
149
- {getTextContent(message)}
150
- </div>
151
- ))}
152
-
153
- <div ref={containerRef} onClick={() => onSelect()} className='flex'>
154
- <TextEditor
155
- ref={editorRef}
156
- autofocus={focus}
157
- model={model}
158
- placeholder={'Enter comment...'}
159
- slots={{ root: { className: 'grow p-2 rounded-b' } }}
160
- extensions={[
161
- keymap.of([
162
- {
163
- key: 'Enter',
164
- run: () => {
165
- handleCreateMessage();
166
- return true;
167
- },
168
- },
169
- ]),
170
- ]}
171
- />
172
- <Button variant='ghost' classNames='px-1' title='Resolve' onClick={onResolve}>
173
- <Check />
174
- </Button>
175
- </div>
176
- </div>
177
- );
178
- };
179
-
180
- const Sidebar: FC<{
181
- threads: CommentThread[];
182
- selected?: string;
183
- onSelect: (thread: string) => void;
184
- onResolve: (thread: string) => void;
185
- }> = ({ threads, selected, onSelect, onResolve }) => {
186
- // Sort by y-position.
187
- const sortedThreads = useMemo(() => {
188
- const sorted = [...threads];
189
- return sorted.sort(({ yPos: a = Infinity }, { yPos: b = Infinity }) => {
190
- return a < b ? -1 : a > b ? 1 : 0;
191
- });
192
- }, [threads]);
193
-
194
- return (
195
- <DensityProvider density='fine'>
196
- <div className='flex flex-col grow overflow-y-scroll py-4 gap-4'>
197
- {sortedThreads.map((thread) => (
198
- <Thread
199
- key={thread.id}
200
- thread={thread}
201
- selected={thread.id === selected}
202
- onSelect={() => onSelect(thread.id)}
203
- onResolve={() => onResolve(thread.id)}
204
- />
205
- ))}
206
- </div>
207
- </DensityProvider>
208
- );
209
- };
210
-
211
- //
212
- // Story container.
213
- //
214
-
215
- type StoryProps = {
216
- text?: string;
217
- autoCreate?: boolean;
218
- };
219
-
220
- const Story = ({ text, autoCreate }: StoryProps) => {
221
- const [item] = useState({ text: new TextObject(text) });
222
- const [threads, setThreads] = useState<CommentThread[]>([]);
223
- const [selected, setSelected] = useState<string>();
224
-
225
- const comments = useMemo<Comment[]>(() => threads.map(({ id, cursor }) => ({ id, cursor })), [threads]);
226
-
227
- // Filter by visibility.
228
- const visibleThreads = useMemo(() => threads.filter((thread) => thread.yPos !== undefined), [threads]);
229
-
230
- const handleCreateComment: CommentsOptions['onCreate'] = (cursor, location) => {
231
- const id = PublicKey.random().toHex();
232
- log.info('create', { id: id.slice(0, 4), cursor });
233
- setThreads((threads) => [
234
- ...threads,
235
- {
236
- id,
237
- cursor,
238
- yPos: location ? Math.floor(location.top) : undefined,
239
- messages: autoCreate
240
- ? faker.helpers.multiple(() => new TextObject(faker.lorem.sentence()), { count: { min: 1, max: 3 } })
241
- : [],
242
- },
243
- ]);
244
- setSelected(id);
245
- return id;
246
- };
247
-
248
- const handleDeleteComment: CommentsOptions['onDelete'] = (id) => {
249
- log.info('delete', { id: id.slice(0, 4) });
250
- setThreads((threads) =>
251
- threads.map((thread) => {
252
- if (thread.id === id) {
253
- thread.cursor = undefined;
254
- }
255
-
256
- return thread;
257
- }),
258
- );
259
-
260
- setSelected((selected) => (selected === id ? undefined : selected));
261
- };
262
-
263
- const handleUpdateComment: CommentsOptions['onUpdate'] = (id, cursor) => {
264
- log.info('update', { id: id.slice(0, 4), cursor });
265
- setThreads((threads) =>
266
- threads.map((thread) => {
267
- if (thread.id === id) {
268
- thread.cursor = cursor;
269
- }
270
-
271
- return thread;
272
- }),
273
- );
274
- };
275
-
276
- const handleSelectComment: CommentsOptions['onSelect'] = ({ comments, selection: { active, closest } }) => {
277
- log.info('select', { active: active?.slice(0, 4), closest: closest?.slice(0, 4) });
278
- setThreads((threads) =>
279
- threads.map((thread) => {
280
- const comment = comments.find(({ comment }) => comment.id === thread.id);
281
- if (comment) {
282
- thread.yPos = comment.location ? Math.floor(comment.location.top) : undefined;
283
- thread.range = { from: comment.range.from, to: comment.range.to };
284
- }
285
-
286
- return thread;
287
- }),
288
- );
289
-
290
- setSelected(active ?? closest);
291
- };
292
-
293
- const handleSelectThread = (id: string) => {
294
- setSelected(id);
295
- };
296
-
297
- const handleResolveThread = (id: string) => {
298
- setThreads((threads) => [...threads.filter((thread) => thread.id !== id)]);
299
- setSelected(undefined);
300
- };
301
-
302
- return (
303
- <div className={mx(fixedInsetFlexLayout, 'bg-neutral-100')}>
304
- <div className='flex justify-center h-full gap-8'>
305
- <div className='flex flex-col h-full w-[600px]'>
306
- <Editor
307
- item={item}
308
- selected={selected}
309
- comments={comments}
310
- onCreateComment={handleCreateComment}
311
- onDeleteComment={handleDeleteComment}
312
- onUpdateComment={handleUpdateComment}
313
- onSelectComment={handleSelectComment}
314
- />
315
- </div>
316
-
317
- <div className='flex flex-col h-full w-[300px]'>
318
- <Sidebar
319
- threads={visibleThreads}
320
- selected={selected}
321
- onSelect={handleSelectThread}
322
- onResolve={handleResolveThread}
323
- />
324
- </div>
325
- </div>
326
- </div>
327
- );
328
- };
329
-
330
- export default {
331
- title: 'react-ui-editor/comments',
332
- component: MarkdownEditor,
333
- decorators: [withTheme],
334
- render: (args: StoryProps) => <Story {...args} />,
335
- };
336
-
337
- const str = (...lines: string[]) => lines.join('\n');
338
-
339
- const document = str(
340
- '# Comments',
341
- '',
342
- str(...faker.helpers.multiple(() => [faker.lorem.paragraph({ min: 5, max: 10 }), ''], { count: 20 }).flat()),
343
- '',
344
- );
345
-
346
- export const Default = {
347
- args: {
348
- text: document,
349
- },
350
- };
351
-
352
- export const Testing = {
353
- args: {
354
- text: document,
355
- autoCreate: true,
356
- },
357
- };
@@ -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
- };