@hocuspocus/provider 1.0.0-alpha.12 → 1.0.0-alpha.16
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.
- package/CHANGELOG.md +35 -0
- package/dist/hocuspocus-provider.cjs +153 -84
- package/dist/hocuspocus-provider.cjs.map +1 -1
- package/dist/hocuspocus-provider.esm.js +153 -84
- package/dist/hocuspocus-provider.esm.js.map +1 -1
- package/dist/packages/provider/src/HocuspocusProvider.d.ts +81 -14
- package/dist/packages/provider/src/IncomingMessage.d.ts +1 -0
- package/dist/packages/provider/src/MessageReceiver.d.ts +2 -0
- package/dist/packages/provider/src/MessageSender.d.ts +2 -8
- package/dist/packages/provider/src/OutgoingMessage.d.ts +2 -1
- package/dist/packages/provider/src/types.d.ts +10 -2
- package/dist/packages/server/src/Connection.d.ts +2 -2
- package/dist/packages/server/src/Document.d.ts +2 -2
- package/dist/packages/server/src/Hocuspocus.d.ts +12 -4
- package/dist/packages/server/src/types.d.ts +4 -0
- package/package.json +3 -2
- package/src/HocuspocusProvider.ts +207 -107
- package/src/IncomingMessage.ts +5 -0
- package/src/MessageReceiver.ts +26 -1
- package/src/MessageSender.ts +2 -15
- package/src/OutgoingMessage.ts +5 -1
- package/src/types.ts +17 -2
package/src/IncomingMessage.ts
CHANGED
|
@@ -9,6 +9,7 @@ import {
|
|
|
9
9
|
createEncoder,
|
|
10
10
|
writeVarUint,
|
|
11
11
|
writeVarUint8Array,
|
|
12
|
+
length,
|
|
12
13
|
} from 'lib0/encoding'
|
|
13
14
|
import { MessageType } from './types'
|
|
14
15
|
|
|
@@ -41,4 +42,8 @@ export class IncomingMessage {
|
|
|
41
42
|
writeVarUint8Array(data: Uint8Array) {
|
|
42
43
|
return writeVarUint8Array(this.encoder, data)
|
|
43
44
|
}
|
|
45
|
+
|
|
46
|
+
length() {
|
|
47
|
+
return length(this.encoder)
|
|
48
|
+
}
|
|
44
49
|
}
|
package/src/MessageReceiver.ts
CHANGED
|
@@ -4,17 +4,27 @@ import { MessageType } from './types'
|
|
|
4
4
|
import { HocuspocusProvider } from './HocuspocusProvider'
|
|
5
5
|
import { IncomingMessage } from './IncomingMessage'
|
|
6
6
|
import { readAuthMessage } from '../../../shared/protocols/auth'
|
|
7
|
+
import { OutgoingMessage } from './OutgoingMessage'
|
|
7
8
|
|
|
8
9
|
export class MessageReceiver {
|
|
9
10
|
|
|
10
11
|
message: IncomingMessage
|
|
11
12
|
|
|
13
|
+
broadcasted = false
|
|
14
|
+
|
|
12
15
|
constructor(message: IncomingMessage) {
|
|
13
16
|
this.message = message
|
|
14
17
|
}
|
|
15
18
|
|
|
19
|
+
public setBroadcasted(value: boolean) {
|
|
20
|
+
this.broadcasted = value
|
|
21
|
+
|
|
22
|
+
return this
|
|
23
|
+
}
|
|
24
|
+
|
|
16
25
|
public apply(provider: HocuspocusProvider, emitSynced = true) {
|
|
17
|
-
const
|
|
26
|
+
const { message } = this
|
|
27
|
+
const type = message.readVarUint()
|
|
18
28
|
|
|
19
29
|
switch (type) {
|
|
20
30
|
case MessageType.Sync:
|
|
@@ -36,6 +46,19 @@ export class MessageReceiver {
|
|
|
36
46
|
default:
|
|
37
47
|
throw new Error(`Can’t apply message of unknown type: ${type}`)
|
|
38
48
|
}
|
|
49
|
+
|
|
50
|
+
// Reply
|
|
51
|
+
if (message.length() > 1) {
|
|
52
|
+
if (this.broadcasted) {
|
|
53
|
+
// TODO: Some weird TypeScript error
|
|
54
|
+
// @ts-ignore
|
|
55
|
+
provider.broadcast(OutgoingMessage, { encoder: message.encoder })
|
|
56
|
+
} else {
|
|
57
|
+
// TODO: Some weird TypeScript error
|
|
58
|
+
// @ts-ignore
|
|
59
|
+
provider.send(OutgoingMessage, { encoder: message.encoder })
|
|
60
|
+
}
|
|
61
|
+
}
|
|
39
62
|
}
|
|
40
63
|
|
|
41
64
|
private applySyncMessage(provider: HocuspocusProvider, emitSynced: boolean) {
|
|
@@ -43,6 +66,7 @@ export class MessageReceiver {
|
|
|
43
66
|
|
|
44
67
|
message.writeVarUint(MessageType.Sync)
|
|
45
68
|
|
|
69
|
+
// Apply update
|
|
46
70
|
const syncMessageType = readSyncMessage(
|
|
47
71
|
message.decoder,
|
|
48
72
|
message.encoder,
|
|
@@ -50,6 +74,7 @@ export class MessageReceiver {
|
|
|
50
74
|
provider,
|
|
51
75
|
)
|
|
52
76
|
|
|
77
|
+
// Synced once we receive Step2
|
|
53
78
|
if (emitSynced && syncMessageType === messageYjsSyncStep2) {
|
|
54
79
|
provider.synced = true
|
|
55
80
|
}
|
package/src/MessageSender.ts
CHANGED
|
@@ -1,12 +1,6 @@
|
|
|
1
1
|
import { Encoder, toUint8Array } from 'lib0/encoding'
|
|
2
2
|
import * as bc from 'lib0/broadcastchannel'
|
|
3
|
-
import {
|
|
4
|
-
import { AwarenessMessage } from './OutgoingMessages/AwarenessMessage'
|
|
5
|
-
import { QueryAwarenessMessage } from './OutgoingMessages/QueryAwarenessMessage'
|
|
6
|
-
import { SyncStepOneMessage } from './OutgoingMessages/SyncStepOneMessage'
|
|
7
|
-
import { SyncStepTwoMessage } from './OutgoingMessages/SyncStepTwoMessage'
|
|
8
|
-
import { UpdateMessage } from './OutgoingMessages/UpdateMessage'
|
|
9
|
-
import { Constructable } from './types'
|
|
3
|
+
import { ConstructableOutgoingMessage } from './types'
|
|
10
4
|
|
|
11
5
|
export class MessageSender {
|
|
12
6
|
|
|
@@ -14,14 +8,7 @@ export class MessageSender {
|
|
|
14
8
|
|
|
15
9
|
message: any
|
|
16
10
|
|
|
17
|
-
constructor(Message:
|
|
18
|
-
Constructable<AuthenticationMessage> |
|
|
19
|
-
Constructable<AwarenessMessage> |
|
|
20
|
-
Constructable<QueryAwarenessMessage> |
|
|
21
|
-
Constructable<SyncStepOneMessage> |
|
|
22
|
-
Constructable<SyncStepTwoMessage> |
|
|
23
|
-
Constructable<UpdateMessage>,
|
|
24
|
-
args: any = {}) {
|
|
11
|
+
constructor(Message: ConstructableOutgoingMessage, args: any = {}) {
|
|
25
12
|
this.message = new Message()
|
|
26
13
|
this.encoder = this.message.get(args)
|
|
27
14
|
}
|
package/src/OutgoingMessage.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { Encoder, createEncoder, toUint8Array } from 'lib0/encoding'
|
|
2
|
-
import { MessageType, OutgoingMessageInterface } from './types'
|
|
2
|
+
import { MessageType, OutgoingMessageArguments, OutgoingMessageInterface } from './types'
|
|
3
3
|
|
|
4
4
|
export class OutgoingMessage implements OutgoingMessageInterface {
|
|
5
5
|
encoder: Encoder
|
|
@@ -10,6 +10,10 @@ export class OutgoingMessage implements OutgoingMessageInterface {
|
|
|
10
10
|
this.encoder = createEncoder()
|
|
11
11
|
}
|
|
12
12
|
|
|
13
|
+
get(args: Partial<OutgoingMessageArguments>) {
|
|
14
|
+
return args.encoder
|
|
15
|
+
}
|
|
16
|
+
|
|
13
17
|
toUint8Array() {
|
|
14
18
|
return toUint8Array(this.encoder)
|
|
15
19
|
}
|
package/src/types.ts
CHANGED
|
@@ -1,6 +1,12 @@
|
|
|
1
1
|
import { Awareness } from 'y-protocols/awareness'
|
|
2
2
|
import * as Y from 'yjs'
|
|
3
|
-
import
|
|
3
|
+
import { Encoder } from 'lib0/encoding'
|
|
4
|
+
import { AuthenticationMessage } from './OutgoingMessages/AuthenticationMessage'
|
|
5
|
+
import { AwarenessMessage } from './OutgoingMessages/AwarenessMessage'
|
|
6
|
+
import { QueryAwarenessMessage } from './OutgoingMessages/QueryAwarenessMessage'
|
|
7
|
+
import { SyncStepOneMessage } from './OutgoingMessages/SyncStepOneMessage'
|
|
8
|
+
import { SyncStepTwoMessage } from './OutgoingMessages/SyncStepTwoMessage'
|
|
9
|
+
import { UpdateMessage } from './OutgoingMessages/UpdateMessage'
|
|
4
10
|
|
|
5
11
|
export enum MessageType {
|
|
6
12
|
Sync = 0,
|
|
@@ -10,7 +16,7 @@ export enum MessageType {
|
|
|
10
16
|
}
|
|
11
17
|
|
|
12
18
|
export interface OutgoingMessageInterface {
|
|
13
|
-
encoder:
|
|
19
|
+
encoder: Encoder
|
|
14
20
|
type?: MessageType
|
|
15
21
|
}
|
|
16
22
|
|
|
@@ -21,8 +27,17 @@ export interface OutgoingMessageArguments {
|
|
|
21
27
|
clients: number[],
|
|
22
28
|
states: Map<number, { [key: string]: any; }>,
|
|
23
29
|
update: any,
|
|
30
|
+
encoder: Encoder,
|
|
24
31
|
}
|
|
25
32
|
|
|
26
33
|
export interface Constructable<T> {
|
|
27
34
|
new(...args: any) : T
|
|
28
35
|
}
|
|
36
|
+
|
|
37
|
+
export type ConstructableOutgoingMessage =
|
|
38
|
+
Constructable<AuthenticationMessage> |
|
|
39
|
+
Constructable<AwarenessMessage> |
|
|
40
|
+
Constructable<QueryAwarenessMessage> |
|
|
41
|
+
Constructable<SyncStepOneMessage> |
|
|
42
|
+
Constructable<SyncStepTwoMessage> |
|
|
43
|
+
Constructable<UpdateMessage>
|