@liveblocks/server 1.0.11 → 1.0.12
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/README.md +13 -47
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -16,56 +16,22 @@
|
|
|
16
16
|
<a href="https://bundlephobia.com/package/@liveblocks/server">
|
|
17
17
|
<img src="https://img.shields.io/bundlephobia/minzip/@liveblocks/server?style=flat&label=size&color=09f" alt="Size" />
|
|
18
18
|
</a>
|
|
19
|
-
<a href="
|
|
20
|
-
<img src="https://img.shields.io/
|
|
19
|
+
<a href="./LICENSE">
|
|
20
|
+
<img src="https://img.shields.io/badge/license-AGPL--3.0-f80?style=flat" alt="License" />
|
|
21
21
|
</a>
|
|
22
22
|
</p>
|
|
23
23
|
|
|
24
|
-
`@liveblocks/server` provides the
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
classDiagram
|
|
36
|
-
Room --> Store : store
|
|
37
|
-
Room --> "0+" Session : sessions
|
|
38
|
-
Session --> WebSocket
|
|
39
|
-
|
|
40
|
-
class Room {
|
|
41
|
-
+roomId
|
|
42
|
-
+load()
|
|
43
|
-
+createTicket(version) Ticket
|
|
44
|
-
+startBrowserSession(Ticket ticket, WebSocket socket)
|
|
45
|
-
+handleRaw(Ticket ticket, data)
|
|
46
|
-
+endBrowserSession(Ticket ticket, code, reason)
|
|
47
|
-
}
|
|
48
|
-
|
|
49
|
-
class Store {
|
|
50
|
-
+getString(key)
|
|
51
|
-
+getNumber(key)
|
|
52
|
-
+put(key, value)
|
|
53
|
-
}
|
|
54
|
-
|
|
55
|
-
class Session{
|
|
56
|
-
+version
|
|
57
|
-
+actor
|
|
58
|
-
+nonce
|
|
59
|
-
+createdAt
|
|
60
|
-
+lastPong
|
|
61
|
-
+sendPong()
|
|
62
|
-
+sendServerMsg()
|
|
63
|
-
}
|
|
64
|
-
|
|
65
|
-
class WebSocket {
|
|
66
|
-
+...
|
|
67
|
-
}
|
|
68
|
-
```
|
|
24
|
+
`@liveblocks/server` provides the core Liveblocks server functionality. It
|
|
25
|
+
powers both the Liveblocks production environment, and
|
|
26
|
+
[our dev server](https://liveblocks.io/docs/tools/dev-server), so the behavior
|
|
27
|
+
is identical. You typically don't need to install or use this package directly.
|
|
28
|
+
|
|
29
|
+
While `@liveblocks/server` contains the same core technology that powers
|
|
30
|
+
Liveblocks, we do not yet offer or recommend self-hosting or on-premises
|
|
31
|
+
deployment. The purpose of open sourcing the server package is to provide
|
|
32
|
+
transparency, and offer a great local development and testing experience. A
|
|
33
|
+
production-ready self-hosted deployment requires additional infrastructure and
|
|
34
|
+
expertise that are not yet easy to package.
|
|
69
35
|
|
|
70
36
|
## License
|
|
71
37
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@liveblocks/server",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.12",
|
|
4
4
|
"description": "Liveblocks backend server foundation.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -57,7 +57,7 @@
|
|
|
57
57
|
"dependencies": {
|
|
58
58
|
"@liveblocks/core": "3.14.0",
|
|
59
59
|
"async-mutex": "^0.4.0",
|
|
60
|
-
"decoders": "^2.8.0
|
|
60
|
+
"decoders": "^2.8.0",
|
|
61
61
|
"itertools": "^2.3.2",
|
|
62
62
|
"js-base64": "^3.7.5",
|
|
63
63
|
"nanoid": "^3",
|