@dxos/react-ui-editor 0.3.11-main.c8e9429 → 0.3.11-main.cc2fe2c

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 (143) hide show
  1. package/dist/lib/browser/index.mjs +1020 -1022
  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 -14
  5. package/dist/types/src/components/TextEditor/MarkdownEditor.stories.d.ts.map +1 -1
  6. package/dist/types/src/components/TextEditor/TextEditor.d.ts +13 -5
  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/comments.stories.d.ts.map +1 -1
  10. package/dist/types/src/extensions/autocomplete.d.ts.map +1 -1
  11. package/dist/types/src/extensions/automerge/automerge.d.ts.map +1 -1
  12. package/dist/types/src/extensions/automerge/defs.d.ts +6 -8
  13. package/dist/types/src/extensions/automerge/defs.d.ts.map +1 -1
  14. package/dist/types/src/extensions/automerge/semaphore.d.ts +6 -6
  15. package/dist/types/src/extensions/automerge/semaphore.d.ts.map +1 -1
  16. package/dist/types/src/extensions/automerge/update-automerge.d.ts +2 -2
  17. package/dist/types/src/extensions/awareness.d.ts +1 -1
  18. package/dist/types/src/extensions/awareness.d.ts.map +1 -1
  19. package/dist/types/src/extensions/basic.d.ts +4 -5
  20. package/dist/types/src/extensions/basic.d.ts.map +1 -1
  21. package/dist/types/src/extensions/comments.d.ts +18 -14
  22. package/dist/types/src/extensions/comments.d.ts.map +1 -1
  23. package/dist/types/src/extensions/cursor.d.ts +3 -3
  24. package/dist/types/src/extensions/cursor.d.ts.map +1 -1
  25. package/dist/types/src/extensions/index.d.ts +1 -7
  26. package/dist/types/src/extensions/index.d.ts.map +1 -1
  27. package/dist/types/src/extensions/markdown/bundle.d.ts +3 -6
  28. package/dist/types/src/extensions/markdown/bundle.d.ts.map +1 -1
  29. package/dist/types/src/extensions/markdown/code.d.ts.map +1 -0
  30. package/dist/types/src/extensions/markdown/heading.d.ts +6 -0
  31. package/dist/types/src/extensions/markdown/heading.d.ts.map +1 -0
  32. package/dist/types/src/extensions/markdown/highlight.d.ts.map +1 -1
  33. package/dist/types/src/extensions/markdown/hr.d.ts.map +1 -0
  34. package/dist/types/src/extensions/markdown/image.d.ts.map +1 -0
  35. package/dist/types/src/extensions/markdown/index.d.ts +7 -0
  36. package/dist/types/src/extensions/markdown/index.d.ts.map +1 -1
  37. package/dist/types/src/extensions/markdown/link.d.ts.map +1 -0
  38. package/dist/types/src/extensions/markdown/table.d.ts.map +1 -0
  39. package/dist/types/src/extensions/markdown/tasklist.d.ts +3 -0
  40. package/dist/types/src/extensions/markdown/tasklist.d.ts.map +1 -0
  41. package/dist/types/src/extensions/mention.d.ts.map +1 -1
  42. package/dist/types/src/extensions/outliner.d.ts +4 -0
  43. package/dist/types/src/extensions/outliner.d.ts.map +1 -0
  44. package/dist/types/src/hooks/awareness-provider.d.ts +7 -4
  45. package/dist/types/src/hooks/awareness-provider.d.ts.map +1 -1
  46. package/dist/types/src/hooks/defs.d.ts +25 -0
  47. package/dist/types/src/hooks/defs.d.ts.map +1 -0
  48. package/dist/types/src/hooks/index.d.ts +2 -2
  49. package/dist/types/src/hooks/index.d.ts.map +1 -1
  50. package/dist/types/src/hooks/useTextEditor.d.ts +17 -0
  51. package/dist/types/src/hooks/useTextEditor.d.ts.map +1 -0
  52. package/dist/types/src/hooks/useTextModel.d.ts +2 -27
  53. package/dist/types/src/hooks/useTextModel.d.ts.map +1 -1
  54. package/dist/types/src/styles/markdown.d.ts +2 -2
  55. package/dist/types/src/styles/markdown.d.ts.map +1 -1
  56. package/dist/types/src/themes/default.d.ts.map +1 -1
  57. package/dist/types/src/util.d.ts +2 -0
  58. package/dist/types/src/util.d.ts.map +1 -1
  59. package/package.json +31 -34
  60. package/src/components/TextEditor/MarkdownEditor.stories.tsx +69 -72
  61. package/src/components/TextEditor/TextEditor.tsx +91 -66
  62. package/src/components/TextEditor/comments.stories.tsx +45 -43
  63. package/src/extensions/autocomplete.ts +6 -3
  64. package/src/extensions/automerge/automerge.ts +35 -39
  65. package/src/extensions/automerge/defs.ts +8 -33
  66. package/src/extensions/automerge/semaphore.ts +17 -12
  67. package/src/extensions/automerge/update-automerge.ts +2 -2
  68. package/src/extensions/awareness.ts +14 -14
  69. package/src/extensions/basic.ts +22 -17
  70. package/src/extensions/comments.ts +161 -141
  71. package/src/extensions/cursor.ts +7 -3
  72. package/src/extensions/index.ts +1 -7
  73. package/src/extensions/markdown/bundle.ts +20 -30
  74. package/src/extensions/markdown/code.ts +127 -0
  75. package/src/extensions/markdown/heading.ts +59 -0
  76. package/src/extensions/markdown/highlight.ts +9 -15
  77. package/src/extensions/markdown/hr.ts +71 -0
  78. package/src/extensions/markdown/index.ts +7 -0
  79. package/src/extensions/{link.ts → markdown/link.ts} +1 -2
  80. package/src/extensions/{tasklist.ts → markdown/tasklist.ts} +48 -34
  81. package/src/extensions/mention.ts +9 -2
  82. package/src/extensions/outliner.ts +12 -0
  83. package/src/hooks/awareness-provider.ts +24 -20
  84. package/src/hooks/defs.ts +42 -0
  85. package/src/hooks/index.ts +2 -2
  86. package/src/hooks/useTextEditor.ts +29 -0
  87. package/src/hooks/useTextModel.ts +47 -56
  88. package/src/styles/markdown.ts +9 -10
  89. package/src/themes/default.ts +0 -2
  90. package/src/util.ts +26 -3
  91. package/dist/types/src/components/TextEditor/codemirror.stories.d.ts +0 -12
  92. package/dist/types/src/components/TextEditor/codemirror.stories.d.ts.map +0 -1
  93. package/dist/types/src/components/TextEditor/yjs.stories.d.ts +0 -12
  94. package/dist/types/src/components/TextEditor/yjs.stories.d.ts.map +0 -1
  95. package/dist/types/src/extensions/code.d.ts.map +0 -1
  96. package/dist/types/src/extensions/hr.d.ts.map +0 -1
  97. package/dist/types/src/extensions/image.d.ts.map +0 -1
  98. package/dist/types/src/extensions/link.d.ts.map +0 -1
  99. package/dist/types/src/extensions/table.d.ts.map +0 -1
  100. package/dist/types/src/extensions/tasklist.d.ts +0 -7
  101. package/dist/types/src/extensions/tasklist.d.ts.map +0 -1
  102. package/dist/types/src/extensions/yjs/cursor.d.ts +0 -4
  103. package/dist/types/src/extensions/yjs/cursor.d.ts.map +0 -1
  104. package/dist/types/src/extensions/yjs/index.d.ts +0 -2
  105. package/dist/types/src/extensions/yjs/index.d.ts.map +0 -1
  106. package/dist/types/src/extensions/yjs/yjs.d.ts +0 -4
  107. package/dist/types/src/extensions/yjs/yjs.d.ts.map +0 -1
  108. package/dist/types/src/extensions/yjs/yjs.test.d.ts +0 -2
  109. package/dist/types/src/extensions/yjs/yjs.test.d.ts.map +0 -1
  110. package/dist/types/src/hooks/automerge.d.ts +0 -3
  111. package/dist/types/src/hooks/automerge.d.ts.map +0 -1
  112. package/dist/types/src/hooks/yjs.d.ts +0 -27
  113. package/dist/types/src/hooks/yjs.d.ts.map +0 -1
  114. package/dist/types/src/testing/index.d.ts +0 -3
  115. package/dist/types/src/testing/index.d.ts.map +0 -1
  116. package/dist/types/src/testing/proto/gen/schema.d.ts +0 -15
  117. package/dist/types/src/testing/proto/gen/schema.d.ts.map +0 -1
  118. package/dist/types/src/testing/proto/index.d.ts +0 -2
  119. package/dist/types/src/testing/proto/index.d.ts.map +0 -1
  120. package/dist/types/src/testing/replicator.d.ts +0 -45
  121. package/dist/types/src/testing/replicator.d.ts.map +0 -1
  122. package/src/components/TextEditor/codemirror.stories.ts +0 -115
  123. package/src/components/TextEditor/yjs.stories.tsx +0 -56
  124. package/src/extensions/code.ts +0 -104
  125. package/src/extensions/hr.ts +0 -72
  126. package/src/extensions/yjs/cursor.ts +0 -22
  127. package/src/extensions/yjs/index.ts +0 -5
  128. package/src/extensions/yjs/yjs.test.ts +0 -35
  129. package/src/extensions/yjs/yjs.ts +0 -16
  130. package/src/hooks/automerge.ts +0 -52
  131. package/src/hooks/yjs.ts +0 -156
  132. package/src/testing/index.ts +0 -6
  133. package/src/testing/proto/gen/schema.ts +0 -49
  134. package/src/testing/proto/index.ts +0 -5
  135. package/src/testing/proto/schema.proto +0 -15
  136. package/src/testing/replicator.ts +0 -184
  137. /package/dist/types/src/extensions/{code.d.ts → markdown/code.d.ts} +0 -0
  138. /package/dist/types/src/extensions/{hr.d.ts → markdown/hr.d.ts} +0 -0
  139. /package/dist/types/src/extensions/{image.d.ts → markdown/image.d.ts} +0 -0
  140. /package/dist/types/src/extensions/{link.d.ts → markdown/link.d.ts} +0 -0
  141. /package/dist/types/src/extensions/{table.d.ts → markdown/table.d.ts} +0 -0
  142. /package/src/extensions/{image.ts → markdown/image.ts} +0 -0
  143. /package/src/extensions/{table.ts → markdown/table.ts} +0 -0
@@ -1,184 +0,0 @@
1
- //
2
- // Copyright 2023 DXOS.org
3
- //
4
-
5
- // TODO(wittjosiah): Remove. Use DXOS protocols to reduce duplicate functionality weighing down apps.
6
- import * as decoding from 'lib0/decoding';
7
- import * as encoding from 'lib0/encoding';
8
- import { Observable } from 'lib0/observable';
9
- import { useMemo } from 'react';
10
- import * as YP from 'y-protocols/awareness';
11
- import * as syncProtocol from 'y-protocols/sync';
12
- import { Doc } from 'yjs';
13
-
14
- import { Event } from '@dxos/async';
15
- import { log } from '@dxos/log';
16
- import { TextKind } from '@dxos/protocols/proto/dxos/echo/model/text';
17
-
18
- import { type EditorModel } from '../hooks';
19
- import { cursorColor } from '../styles';
20
-
21
- type Awareness = YP.Awareness;
22
-
23
- const messageSync = 0;
24
- const messageAwareness = 1;
25
- const messageQueryAwareness = 3;
26
-
27
- /**
28
- * Yjs awareness provider in-memory.
29
- */
30
- export class AwarenessProvider extends Observable<any> {
31
- private readonly _remoteUpdate: Event<Uint8Array>;
32
- private readonly _awareness: Awareness;
33
- private readonly _doc: Doc;
34
-
35
- constructor({ update, doc, awareness }: { update: Event<Uint8Array>; doc: Doc; awareness?: Awareness }) {
36
- super();
37
- this._remoteUpdate = update;
38
- this._doc = doc;
39
- this._awareness = awareness ?? new YP.Awareness(doc);
40
-
41
- this._doc.on('update', this._handleDocUpdate.bind(this));
42
- this._awareness.on('update', this._handleAwarenessUpdate.bind(this));
43
- this._remoteUpdate.on(this._handleRemoteUpdate.bind(this));
44
-
45
- if (typeof window !== 'undefined') {
46
- window.addEventListener('beforeunload', this._handleBeforeUnload.bind(this));
47
- } else if (typeof process !== 'undefined') {
48
- process.on('exit', this._handleBeforeUnload.bind(this));
49
- }
50
-
51
- // Post queryAwareness.
52
- const encoderAwarenessQuery = encoding.createEncoder();
53
- encoding.writeVarUint(encoderAwarenessQuery, messageQueryAwareness);
54
- void this._remoteUpdate.emit(encoding.toUint8Array(encoderAwarenessQuery));
55
-
56
- // Post local awareness state.
57
- const encoderAwarenessState = encoding.createEncoder();
58
- encoding.writeVarUint(encoderAwarenessState, messageAwareness);
59
- encoding.writeVarUint8Array(encoderAwarenessState, YP.encodeAwarenessUpdate(this.awareness, [this._doc.clientID]));
60
- void this._remoteUpdate.emit(encoding.toUint8Array(encoderAwarenessState));
61
- }
62
-
63
- get awareness(): Awareness {
64
- return this._awareness;
65
- }
66
-
67
- private _handleDocUpdate(update: Uint8Array, origin: any) {
68
- log('doc update', { update, origin });
69
- const encoder = encoding.createEncoder();
70
- encoding.writeVarUint(encoder, messageSync);
71
- syncProtocol.writeUpdate(encoder, update);
72
- this._remoteUpdate.emit(encoding.toUint8Array(encoder));
73
- }
74
-
75
- private _handleAwarenessUpdate({ added, updated, removed }: any, origin: any) {
76
- log('awareness update', { added, updated, removed, origin });
77
- const changedClients = added.concat(updated).concat(removed);
78
- const encoderAwareness = encoding.createEncoder();
79
- encoding.writeVarUint(encoderAwareness, messageAwareness);
80
- encoding.writeVarUint8Array(encoderAwareness, YP.encodeAwarenessUpdate(this._awareness, changedClients));
81
- this._remoteUpdate.emit(encoding.toUint8Array(encoderAwareness));
82
- }
83
-
84
- private _handleRemoteUpdate(payload: Uint8Array) {
85
- log('remote update', { payload });
86
- const data = new Uint8Array(Array.from(Object.values(payload)));
87
- const encoder = this._readMessage(data);
88
- if (encoder) {
89
- this._remoteUpdate.emit(encoding.toUint8Array(encoder));
90
- }
91
- }
92
-
93
- private _readMessage(message: Uint8Array) {
94
- const decoder = decoding.createDecoder(message);
95
- const encoder = encoding.createEncoder();
96
- const messageType = decoding.readVarUint(decoder);
97
-
98
- let sendReply = false;
99
- switch (messageType) {
100
- case messageSync: {
101
- encoding.writeVarUint(encoder, messageSync);
102
- syncProtocol.readSyncMessage(decoder, encoder, this._doc, this);
103
- break;
104
- }
105
-
106
- case messageAwareness: {
107
- YP.applyAwarenessUpdate(this._awareness, decoding.readVarUint8Array(decoder), this);
108
- break;
109
- }
110
-
111
- case messageQueryAwareness: {
112
- encoding.writeVarUint(encoder, messageAwareness);
113
- encoding.writeVarUint8Array(
114
- encoder,
115
- YP.encodeAwarenessUpdate(this._awareness, Array.from(this._awareness.getStates().keys())),
116
- );
117
- sendReply = true;
118
- break;
119
- }
120
-
121
- default: {
122
- console.error('Invalid message:', messageType);
123
- return encoder;
124
- }
125
- }
126
-
127
- if (!sendReply) {
128
- // Nothing has been written, no answer created.
129
- return null;
130
- }
131
-
132
- return encoder;
133
- }
134
-
135
- private _handleBeforeUnload() {
136
- YP.removeAwarenessStates(this._awareness, [this._doc.clientID], 'window unload');
137
- }
138
- }
139
-
140
- /**
141
- * This mocks the replication across the swarm.
142
- */
143
- export class Replicator {
144
- private readonly _update = new Event<Uint8Array>();
145
- private _peers: EditorModel[] = [];
146
-
147
- constructor(private readonly _kind: TextKind) {}
148
-
149
- setPeers(peers: EditorModel[]) {
150
- this._peers = peers;
151
- }
152
-
153
- createPeer = (id: string, doc: Doc = new Doc()): EditorModel => {
154
- const provider = new AwarenessProvider({ update: this._update, doc });
155
- provider.awareness.setLocalStateField('user', {
156
- name: 'Anonymous ' + Math.floor(Math.random() * 100),
157
- color: cursorColor.color,
158
- colorLight: cursorColor.light,
159
- });
160
-
161
- const field = 'content';
162
- const content = this._kind === TextKind.PLAIN ? doc.getText(field) : doc.getXmlFragment(field);
163
- const model: EditorModel = {
164
- id: doc.guid,
165
- text: () => content.toString(),
166
- content,
167
- awareness: provider.awareness,
168
- peer: { id },
169
- };
170
-
171
- this._peers.push(model);
172
- return model;
173
- };
174
- }
175
-
176
- export type UseYjsModelOptions = {
177
- replicator: Replicator;
178
- id: string;
179
- doc?: Doc;
180
- };
181
-
182
- export const useYjsModel = ({ replicator, id, doc }: UseYjsModelOptions): EditorModel => {
183
- return useMemo(() => replicator.createPeer(id, doc), [doc]);
184
- };
File without changes
File without changes