@liebstoeckel/live-server 0.3.5
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/LICENSE +373 -0
- package/README.md +67 -0
- package/package.json +52 -0
- package/src/cli.ts +211 -0
- package/src/discovery.ts +2 -0
- package/src/index.ts +40 -0
- package/src/inject.ts +39 -0
- package/src/manifest.ts +2 -0
- package/src/relay-client.ts +104 -0
- package/src/relay.ts +139 -0
- package/src/scope.ts +9 -0
- package/src/server.ts +129 -0
- package/src/session.ts +40 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,373 @@
|
|
|
1
|
+
Mozilla Public License Version 2.0
|
|
2
|
+
==================================
|
|
3
|
+
|
|
4
|
+
1. Definitions
|
|
5
|
+
--------------
|
|
6
|
+
|
|
7
|
+
1.1. "Contributor"
|
|
8
|
+
means each individual or legal entity that creates, contributes to
|
|
9
|
+
the creation of, or owns Covered Software.
|
|
10
|
+
|
|
11
|
+
1.2. "Contributor Version"
|
|
12
|
+
means the combination of the Contributions of others (if any) used
|
|
13
|
+
by a Contributor and that particular Contributor's Contribution.
|
|
14
|
+
|
|
15
|
+
1.3. "Contribution"
|
|
16
|
+
means Covered Software of a particular Contributor.
|
|
17
|
+
|
|
18
|
+
1.4. "Covered Software"
|
|
19
|
+
means Source Code Form to which the initial Contributor has attached
|
|
20
|
+
the notice in Exhibit A, the Executable Form of such Source Code
|
|
21
|
+
Form, and Modifications of such Source Code Form, in each case
|
|
22
|
+
including portions thereof.
|
|
23
|
+
|
|
24
|
+
1.5. "Incompatible With Secondary Licenses"
|
|
25
|
+
means
|
|
26
|
+
|
|
27
|
+
(a) that the initial Contributor has attached the notice described
|
|
28
|
+
in Exhibit B to the Covered Software; or
|
|
29
|
+
|
|
30
|
+
(b) that the Covered Software was made available under the terms of
|
|
31
|
+
version 1.1 or earlier of the License, but not also under the
|
|
32
|
+
terms of a Secondary License.
|
|
33
|
+
|
|
34
|
+
1.6. "Executable Form"
|
|
35
|
+
means any form of the work other than Source Code Form.
|
|
36
|
+
|
|
37
|
+
1.7. "Larger Work"
|
|
38
|
+
means a work that combines Covered Software with other material, in
|
|
39
|
+
a separate file or files, that is not Covered Software.
|
|
40
|
+
|
|
41
|
+
1.8. "License"
|
|
42
|
+
means this document.
|
|
43
|
+
|
|
44
|
+
1.9. "Licensable"
|
|
45
|
+
means having the right to grant, to the maximum extent possible,
|
|
46
|
+
whether at the time of the initial grant or subsequently, any and
|
|
47
|
+
all of the rights conveyed by this License.
|
|
48
|
+
|
|
49
|
+
1.10. "Modifications"
|
|
50
|
+
means any of the following:
|
|
51
|
+
|
|
52
|
+
(a) any file in Source Code Form that results from an addition to,
|
|
53
|
+
deletion from, or modification of the contents of Covered
|
|
54
|
+
Software; or
|
|
55
|
+
|
|
56
|
+
(b) any new file in Source Code Form that contains any Covered
|
|
57
|
+
Software.
|
|
58
|
+
|
|
59
|
+
1.11. "Patent Claims" of a Contributor
|
|
60
|
+
means any patent claim(s), including without limitation, method,
|
|
61
|
+
process, and apparatus claims, in any patent Licensable by such
|
|
62
|
+
Contributor that would be infringed, but for the grant of the
|
|
63
|
+
License, by the making, using, selling, offering for sale, having
|
|
64
|
+
made, import, or transfer of either its Contributions or its
|
|
65
|
+
Contributor Version.
|
|
66
|
+
|
|
67
|
+
1.12. "Secondary License"
|
|
68
|
+
means either the GNU General Public License, Version 2.0, the GNU
|
|
69
|
+
Lesser General Public License, Version 2.1, the GNU Affero General
|
|
70
|
+
Public License, Version 3.0, or any later versions of those
|
|
71
|
+
licenses.
|
|
72
|
+
|
|
73
|
+
1.13. "Source Code Form"
|
|
74
|
+
means the form of the work preferred for making modifications.
|
|
75
|
+
|
|
76
|
+
1.14. "You" (or "Your")
|
|
77
|
+
means an individual or a legal entity exercising rights under this
|
|
78
|
+
License. For legal entities, "You" includes any entity that
|
|
79
|
+
controls, is controlled by, or is under common control with You. For
|
|
80
|
+
purposes of this definition, "control" means (a) the power, direct
|
|
81
|
+
or indirect, to cause the direction or management of such entity,
|
|
82
|
+
whether by contract or otherwise, or (b) ownership of more than
|
|
83
|
+
fifty percent (50%) of the outstanding shares or beneficial
|
|
84
|
+
ownership of such entity.
|
|
85
|
+
|
|
86
|
+
2. License Grants and Conditions
|
|
87
|
+
--------------------------------
|
|
88
|
+
|
|
89
|
+
2.1. Grants
|
|
90
|
+
|
|
91
|
+
Each Contributor hereby grants You a world-wide, royalty-free,
|
|
92
|
+
non-exclusive license:
|
|
93
|
+
|
|
94
|
+
(a) under intellectual property rights (other than patent or trademark)
|
|
95
|
+
Licensable by such Contributor to use, reproduce, make available,
|
|
96
|
+
modify, display, perform, distribute, and otherwise exploit its
|
|
97
|
+
Contributions, either on an unmodified basis, with Modifications, or
|
|
98
|
+
as part of a Larger Work; and
|
|
99
|
+
|
|
100
|
+
(b) under Patent Claims of such Contributor to make, use, sell, offer
|
|
101
|
+
for sale, have made, import, and otherwise transfer either its
|
|
102
|
+
Contributions or its Contributor Version.
|
|
103
|
+
|
|
104
|
+
2.2. Effective Date
|
|
105
|
+
|
|
106
|
+
The licenses granted in Section 2.1 with respect to any Contribution
|
|
107
|
+
become effective for each Contribution on the date the Contributor first
|
|
108
|
+
distributes such Contribution.
|
|
109
|
+
|
|
110
|
+
2.3. Limitations on Grant Scope
|
|
111
|
+
|
|
112
|
+
The licenses granted in this Section 2 are the only rights granted under
|
|
113
|
+
this License. No additional rights or licenses will be implied from the
|
|
114
|
+
distribution or licensing of Covered Software under this License.
|
|
115
|
+
Notwithstanding Section 2.1(b) above, no patent license is granted by a
|
|
116
|
+
Contributor:
|
|
117
|
+
|
|
118
|
+
(a) for any code that a Contributor has removed from Covered Software;
|
|
119
|
+
or
|
|
120
|
+
|
|
121
|
+
(b) for infringements caused by: (i) Your and any other third party's
|
|
122
|
+
modifications of Covered Software, or (ii) the combination of its
|
|
123
|
+
Contributions with other software (except as part of its Contributor
|
|
124
|
+
Version); or
|
|
125
|
+
|
|
126
|
+
(c) under Patent Claims infringed by Covered Software in the absence of
|
|
127
|
+
its Contributions.
|
|
128
|
+
|
|
129
|
+
This License does not grant any rights in the trademarks, service marks,
|
|
130
|
+
or logos of any Contributor (except as may be necessary to comply with
|
|
131
|
+
the notice requirements in Section 3.4).
|
|
132
|
+
|
|
133
|
+
2.4. Subsequent Licenses
|
|
134
|
+
|
|
135
|
+
No Contributor makes additional grants as a result of Your choice to
|
|
136
|
+
distribute the Covered Software under a subsequent version of this
|
|
137
|
+
License (see Section 10.2) or under the terms of a Secondary License (if
|
|
138
|
+
permitted under the terms of Section 3.3).
|
|
139
|
+
|
|
140
|
+
2.5. Representation
|
|
141
|
+
|
|
142
|
+
Each Contributor represents that the Contributor believes its
|
|
143
|
+
Contributions are its original creation(s) or it has sufficient rights
|
|
144
|
+
to grant the rights to its Contributions conveyed by this License.
|
|
145
|
+
|
|
146
|
+
2.6. Fair Use
|
|
147
|
+
|
|
148
|
+
This License is not intended to limit any rights You have under
|
|
149
|
+
applicable copyright doctrines of fair use, fair dealing, or other
|
|
150
|
+
equivalents.
|
|
151
|
+
|
|
152
|
+
2.7. Conditions
|
|
153
|
+
|
|
154
|
+
Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
|
|
155
|
+
in Section 2.1.
|
|
156
|
+
|
|
157
|
+
3. Responsibilities
|
|
158
|
+
-------------------
|
|
159
|
+
|
|
160
|
+
3.1. Distribution of Source Form
|
|
161
|
+
|
|
162
|
+
All distribution of Covered Software in Source Code Form, including any
|
|
163
|
+
Modifications that You create or to which You contribute, must be under
|
|
164
|
+
the terms of this License. You must inform recipients that the Source
|
|
165
|
+
Code Form of the Covered Software is governed by the terms of this
|
|
166
|
+
License, and how they can obtain a copy of this License. You may not
|
|
167
|
+
attempt to alter or restrict the recipients' rights in the Source Code
|
|
168
|
+
Form.
|
|
169
|
+
|
|
170
|
+
3.2. Distribution of Executable Form
|
|
171
|
+
|
|
172
|
+
If You distribute Covered Software in Executable Form then:
|
|
173
|
+
|
|
174
|
+
(a) such Covered Software must also be made available in Source Code
|
|
175
|
+
Form, as described in Section 3.1, and You must inform recipients of
|
|
176
|
+
the Executable Form how they can obtain a copy of such Source Code
|
|
177
|
+
Form by reasonable means in a timely manner, at a charge no more
|
|
178
|
+
than the cost of distribution to the recipient; and
|
|
179
|
+
|
|
180
|
+
(b) You may distribute such Executable Form under the terms of this
|
|
181
|
+
License, or sublicense it under different terms, provided that the
|
|
182
|
+
license for the Executable Form does not attempt to limit or alter
|
|
183
|
+
the recipients' rights in the Source Code Form under this License.
|
|
184
|
+
|
|
185
|
+
3.3. Distribution of a Larger Work
|
|
186
|
+
|
|
187
|
+
You may create and distribute a Larger Work under terms of Your choice,
|
|
188
|
+
provided that You also comply with the requirements of this License for
|
|
189
|
+
the Covered Software. If the Larger Work is a combination of Covered
|
|
190
|
+
Software with a work governed by one or more Secondary Licenses, and the
|
|
191
|
+
Covered Software is not Incompatible With Secondary Licenses, this
|
|
192
|
+
License permits You to additionally distribute such Covered Software
|
|
193
|
+
under the terms of such Secondary License(s), so that the recipient of
|
|
194
|
+
the Larger Work may, at their option, further distribute the Covered
|
|
195
|
+
Software under the terms of either this License or such Secondary
|
|
196
|
+
License(s).
|
|
197
|
+
|
|
198
|
+
3.4. Notices
|
|
199
|
+
|
|
200
|
+
You may not remove or alter the substance of any license notices
|
|
201
|
+
(including copyright notices, patent notices, disclaimers of warranty,
|
|
202
|
+
or limitations of liability) contained within the Source Code Form of
|
|
203
|
+
the Covered Software, except that You may alter any license notices to
|
|
204
|
+
the extent required to remedy known factual inaccuracies.
|
|
205
|
+
|
|
206
|
+
3.5. Application of Additional Terms
|
|
207
|
+
|
|
208
|
+
You may choose to offer, and to charge a fee for, warranty, support,
|
|
209
|
+
indemnity or liability obligations to one or more recipients of Covered
|
|
210
|
+
Software. However, You may do so only on Your own behalf, and not on
|
|
211
|
+
behalf of any Contributor. You must make it absolutely clear that any
|
|
212
|
+
such warranty, support, indemnity, or liability obligation is offered by
|
|
213
|
+
You alone, and You hereby agree to indemnify every Contributor for any
|
|
214
|
+
liability incurred by such Contributor as a result of warranty, support,
|
|
215
|
+
indemnity or liability terms You offer. You may include additional
|
|
216
|
+
disclaimers of warranty and limitations of liability specific to any
|
|
217
|
+
jurisdiction.
|
|
218
|
+
|
|
219
|
+
4. Inability to Comply Due to Statute or Regulation
|
|
220
|
+
---------------------------------------------------
|
|
221
|
+
|
|
222
|
+
If it is impossible for You to comply with any of the terms of this
|
|
223
|
+
License with respect to some or all of the Covered Software due to
|
|
224
|
+
statute, judicial order, or regulation then You must: (a) comply with
|
|
225
|
+
the terms of this License to the maximum extent possible; and (b)
|
|
226
|
+
describe the limitations and the code they affect. Such description must
|
|
227
|
+
be placed in a text file included with all distributions of the Covered
|
|
228
|
+
Software under this License. Except to the extent prohibited by statute
|
|
229
|
+
or regulation, such description must be sufficiently detailed for a
|
|
230
|
+
recipient of ordinary skill to be able to understand it.
|
|
231
|
+
|
|
232
|
+
5. Termination
|
|
233
|
+
--------------
|
|
234
|
+
|
|
235
|
+
5.1. The rights granted under this License will terminate automatically
|
|
236
|
+
if You fail to comply with any of its terms. However, if You become
|
|
237
|
+
compliant, then the rights granted under this License from a particular
|
|
238
|
+
Contributor are reinstated (a) provisionally, unless and until such
|
|
239
|
+
Contributor explicitly and finally terminates Your grants, and (b) on an
|
|
240
|
+
ongoing basis, if such Contributor fails to notify You of the
|
|
241
|
+
non-compliance by some reasonable means prior to 60 days after You have
|
|
242
|
+
come back into compliance. Moreover, Your grants from a particular
|
|
243
|
+
Contributor are reinstated on an ongoing basis if such Contributor
|
|
244
|
+
notifies You of the non-compliance by some reasonable means, this is the
|
|
245
|
+
first time You have received notice of non-compliance with this License
|
|
246
|
+
from such Contributor, and You become compliant prior to 30 days after
|
|
247
|
+
Your receipt of the notice.
|
|
248
|
+
|
|
249
|
+
5.2. If You initiate litigation against any entity by asserting a patent
|
|
250
|
+
infringement claim (excluding declaratory judgment actions,
|
|
251
|
+
counter-claims, and cross-claims) alleging that a Contributor Version
|
|
252
|
+
directly or indirectly infringes any patent, then the rights granted to
|
|
253
|
+
You by any and all Contributors for the Covered Software under Section
|
|
254
|
+
2.1 of this License shall terminate.
|
|
255
|
+
|
|
256
|
+
5.3. In the event of termination under Sections 5.1 or 5.2 above, all
|
|
257
|
+
end user license agreements (excluding distributors and resellers) which
|
|
258
|
+
have been validly granted by You or Your distributors under this License
|
|
259
|
+
prior to termination shall survive termination.
|
|
260
|
+
|
|
261
|
+
************************************************************************
|
|
262
|
+
* *
|
|
263
|
+
* 6. Disclaimer of Warranty *
|
|
264
|
+
* ------------------------- *
|
|
265
|
+
* *
|
|
266
|
+
* Covered Software is provided under this License on an "as is" *
|
|
267
|
+
* basis, without warranty of any kind, either expressed, implied, or *
|
|
268
|
+
* statutory, including, without limitation, warranties that the *
|
|
269
|
+
* Covered Software is free of defects, merchantable, fit for a *
|
|
270
|
+
* particular purpose or non-infringing. The entire risk as to the *
|
|
271
|
+
* quality and performance of the Covered Software is with You. *
|
|
272
|
+
* Should any Covered Software prove defective in any respect, You *
|
|
273
|
+
* (not any Contributor) assume the cost of any necessary servicing, *
|
|
274
|
+
* repair, or correction. This disclaimer of warranty constitutes an *
|
|
275
|
+
* essential part of this License. No use of any Covered Software is *
|
|
276
|
+
* authorized under this License except under this disclaimer. *
|
|
277
|
+
* *
|
|
278
|
+
************************************************************************
|
|
279
|
+
|
|
280
|
+
************************************************************************
|
|
281
|
+
* *
|
|
282
|
+
* 7. Limitation of Liability *
|
|
283
|
+
* -------------------------- *
|
|
284
|
+
* *
|
|
285
|
+
* Under no circumstances and under no legal theory, whether tort *
|
|
286
|
+
* (including negligence), contract, or otherwise, shall any *
|
|
287
|
+
* Contributor, or anyone who distributes Covered Software as *
|
|
288
|
+
* permitted above, be liable to You for any direct, indirect, *
|
|
289
|
+
* special, incidental, or consequential damages of any character *
|
|
290
|
+
* including, without limitation, damages for lost profits, loss of *
|
|
291
|
+
* goodwill, work stoppage, computer failure or malfunction, or any *
|
|
292
|
+
* and all other commercial damages or losses, even if such party *
|
|
293
|
+
* shall have been informed of the possibility of such damages. This *
|
|
294
|
+
* limitation of liability shall not apply to liability for death or *
|
|
295
|
+
* personal injury resulting from such party's negligence to the *
|
|
296
|
+
* extent applicable law prohibits such limitation. Some *
|
|
297
|
+
* jurisdictions do not allow the exclusion or limitation of *
|
|
298
|
+
* incidental or consequential damages, so this exclusion and *
|
|
299
|
+
* limitation may not apply to You. *
|
|
300
|
+
* *
|
|
301
|
+
************************************************************************
|
|
302
|
+
|
|
303
|
+
8. Litigation
|
|
304
|
+
-------------
|
|
305
|
+
|
|
306
|
+
Any litigation relating to this License may be brought only in the
|
|
307
|
+
courts of a jurisdiction where the defendant maintains its principal
|
|
308
|
+
place of business and such litigation shall be governed by laws of that
|
|
309
|
+
jurisdiction, without reference to its conflict-of-law provisions.
|
|
310
|
+
Nothing in this Section shall prevent a party's ability to bring
|
|
311
|
+
cross-claims or counter-claims.
|
|
312
|
+
|
|
313
|
+
9. Miscellaneous
|
|
314
|
+
----------------
|
|
315
|
+
|
|
316
|
+
This License represents the complete agreement concerning the subject
|
|
317
|
+
matter hereof. If any provision of this License is held to be
|
|
318
|
+
unenforceable, such provision shall be reformed only to the extent
|
|
319
|
+
necessary to make it enforceable. Any law or regulation which provides
|
|
320
|
+
that the language of a contract shall be construed against the drafter
|
|
321
|
+
shall not be used to construe this License against a Contributor.
|
|
322
|
+
|
|
323
|
+
10. Versions of the License
|
|
324
|
+
---------------------------
|
|
325
|
+
|
|
326
|
+
10.1. New Versions
|
|
327
|
+
|
|
328
|
+
Mozilla Foundation is the license steward. Except as provided in Section
|
|
329
|
+
10.3, no one other than the license steward has the right to modify or
|
|
330
|
+
publish new versions of this License. Each version will be given a
|
|
331
|
+
distinguishing version number.
|
|
332
|
+
|
|
333
|
+
10.2. Effect of New Versions
|
|
334
|
+
|
|
335
|
+
You may distribute the Covered Software under the terms of the version
|
|
336
|
+
of the License under which You originally received the Covered Software,
|
|
337
|
+
or under the terms of any subsequent version published by the license
|
|
338
|
+
steward.
|
|
339
|
+
|
|
340
|
+
10.3. Modified Versions
|
|
341
|
+
|
|
342
|
+
If you create software not governed by this License, and you want to
|
|
343
|
+
create a new license for such software, you may create and use a
|
|
344
|
+
modified version of this License if you rename the license and remove
|
|
345
|
+
any references to the name of the license steward (except to note that
|
|
346
|
+
such modified license differs from this License).
|
|
347
|
+
|
|
348
|
+
10.4. Distributing Source Code Form that is Incompatible With Secondary
|
|
349
|
+
Licenses
|
|
350
|
+
|
|
351
|
+
If You choose to distribute Source Code Form that is Incompatible With
|
|
352
|
+
Secondary Licenses under the terms of this version of the License, the
|
|
353
|
+
notice described in Exhibit B of this License must be attached.
|
|
354
|
+
|
|
355
|
+
Exhibit A - Source Code Form License Notice
|
|
356
|
+
-------------------------------------------
|
|
357
|
+
|
|
358
|
+
This Source Code Form is subject to the terms of the Mozilla Public
|
|
359
|
+
License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
360
|
+
file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
|
361
|
+
|
|
362
|
+
If it is not possible or desirable to put the notice in a particular
|
|
363
|
+
file, then You may include the notice in a location (such as a LICENSE
|
|
364
|
+
file in a relevant directory) where a recipient would be likely to look
|
|
365
|
+
for such a notice.
|
|
366
|
+
|
|
367
|
+
You may add additional accurate notices of copyright ownership.
|
|
368
|
+
|
|
369
|
+
Exhibit B - "Incompatible With Secondary Licenses" Notice
|
|
370
|
+
---------------------------------------------------------
|
|
371
|
+
|
|
372
|
+
This Source Code Form is "Incompatible With Secondary Licenses", as
|
|
373
|
+
defined by the Mozilla Public License, v. 2.0.
|
package/README.md
ADDED
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# @liebstoeckel/live-server
|
|
2
|
+
|
|
3
|
+
> Live presenter and audience sync for liebstoeckel. `Bun.serve` plus Yjs over WebSocket on your LAN.
|
|
4
|
+
|
|
5
|
+
Part of [liebstoeckel](https://liebstoeckel.app), a code-first presentation framework. You write decks in MDX and TSX and build them into a single self-contained HTML file with no server or runtime dependencies. The same file works offline, and when you host it the deck runs a live session between the presenter and the audience. Built on Bun, React 19, Motion, and Tailwind v4.
|
|
6
|
+
|
|
7
|
+
> **Status: experimental, pre-1.0.** liebstoeckel is an evolving experiment, not yet production-ready. Before 1.0, breaking changes can land in any release without a major-version bump, so pin an exact version if you depend on it.
|
|
8
|
+
|
|
9
|
+
It serves a built deck and keeps everyone in step over WebSockets. The presenter drives navigation, the audience follows, and interactive plugins (polls, Q&A, reactions) share state through a Yjs document. Roles are handed out as unguessable URL tokens, so you open the presenter link yourself and hand the audience link to the room. Most people drive it through `liebstoeckel live` in [@liebstoeckel/cli](https://www.npmjs.com/package/@liebstoeckel/cli). Use this package directly when you want to embed the server.
|
|
10
|
+
|
|
11
|
+
## Install
|
|
12
|
+
|
|
13
|
+
```sh
|
|
14
|
+
bun add @liebstoeckel/live-server
|
|
15
|
+
bun add yjs # peer
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
> Bun-only, built on `Bun.serve`.
|
|
19
|
+
|
|
20
|
+
## Usage
|
|
21
|
+
|
|
22
|
+
```ts
|
|
23
|
+
import { startServer } from "@liebstoeckel/live-server";
|
|
24
|
+
|
|
25
|
+
const server = await startServer({ html: "dist/index.html" });
|
|
26
|
+
|
|
27
|
+
console.log(server.links.presenter); // open this yourself
|
|
28
|
+
console.log(server.links.viewer); // share this with the room
|
|
29
|
+
|
|
30
|
+
// …later
|
|
31
|
+
await server.stop();
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
`startServer({ html, port?, hostname? = "0.0.0.0", publicHost? })` resolves to a `LiveServer` with `session`, `hub`, `port`, `baseUrl`, `links`, `serverPlugins`, and `stop()`. It serves `GET /?t=<token>` and a `WS /sync?t=<token>` endpoint.
|
|
35
|
+
|
|
36
|
+
## Exports
|
|
37
|
+
|
|
38
|
+
| Entry | What |
|
|
39
|
+
|---|---|
|
|
40
|
+
| `@liebstoeckel/live-server` | `startServer`, `lanAddress`, session helpers (`createSession`, `roleForToken`, `buildLinks`), the `Hub` / `Peer` runtime, `injectBootstrap`, deck loaders (`classifyTargetPath`, `loadDeckHtml`), the manifest/discovery and relay-client helpers, and the `ServeOptions` / `LiveServer` / `Session` / `Role` / `Links` types |
|
|
41
|
+
| `@liebstoeckel/live-server/cli` | `runLive` (powers `liebstoeckel live`) |
|
|
42
|
+
|
|
43
|
+
## Gotchas
|
|
44
|
+
|
|
45
|
+
- Roles are URL tokens, not logins. Anyone with the presenter link can drive the deck, so treat it like a secret.
|
|
46
|
+
- It runs server-plugin code on the host and binds `0.0.0.0` by default, so only serve decks you trust on a network you trust.
|
|
47
|
+
- To share beyond the LAN, pair it with [@liebstoeckel/present-relay](https://docs.liebstoeckel.app/guides/relay/).
|
|
48
|
+
|
|
49
|
+
## Architecture
|
|
50
|
+
|
|
51
|
+
A `Bun.serve` HTTP and WebSocket server in front of a single-session Yjs relay. One deck is one process.
|
|
52
|
+
|
|
53
|
+
- `server.ts` holds `startServer`. It extracts the embedded plugin manifest, then rehydrates and runs any server plugins on the host (a plugin's default export gets `{ doc, session }` and may return a teardown). It serves `GET /?t=<token>` (the deck HTML with the live bootstrap injected) and upgrades `WS /sync?t=<token>`. Inbound frames are capped at 4 MB, and Bun's auto-ping `idleTimeout` prunes dead sockets.
|
|
54
|
+
- `relay.ts` holds the `Hub`, which owns the authoritative `Y.Doc`. New peers get full state when they join (late-join replay), and each peer's update broadcasts to every other peer, keyed by origin. Periodic no-op keepalive frames feed the client liveness watchdogs and prune dead peers. A failing send drops that peer instead of throwing.
|
|
55
|
+
- `session.ts` mints two unguessable hex tokens per session. `roleForToken` maps a URL token to `presenter` or `viewer`, and denies anything unknown. `buildLinks` formats the shareable URLs.
|
|
56
|
+
- `inject.ts` writes `window.__LIEBSTOECKEL_LIVE__` into `<head>` (the WebSocket URL, role, token, and viewer link), so the engine's live client activates instead of its standalone fallback.
|
|
57
|
+
- `manifest.ts` and `discovery.ts` re-export `@liebstoeckel/plugin-sdk` (manifest extract and embed, plus server-bundle rehydrate), so the build and the live server share one implementation.
|
|
58
|
+
- `relay-client.ts` is the WAN path. `uploadDeck` and `endSession` call a `present-relay` control API, and `runServerPluginsViaRelay` runs the deck's server plugins locally while connecting to the relay as the privileged `runner` peer, so deck code never runs on the relay.
|
|
59
|
+
- `cli.ts` holds `runLive`, which powers `liebstoeckel live`. It classifies the target (a built `.html` or a project directory, building through `@liebstoeckel/engine` when needed), then runs in LAN mode (`startServer`) or relay mode (`relay-client`), printing the local and LAN presenter and audience links.
|
|
60
|
+
|
|
61
|
+
## Links
|
|
62
|
+
|
|
63
|
+
- [Live presenting](https://docs.liebstoeckel.app/guides/live/) and the [relay guide](https://docs.liebstoeckel.app/guides/relay/)
|
|
64
|
+
- [Homepage](https://liebstoeckel.app)
|
|
65
|
+
- [Source and issues](https://github.com/liebstoeckel/liebstoeckel-app)
|
|
66
|
+
|
|
67
|
+
Licensed under [MPL-2.0](https://github.com/liebstoeckel/liebstoeckel-app/blob/main/LICENSE).
|
package/package.json
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@liebstoeckel/live-server",
|
|
3
|
+
"version": "0.3.5",
|
|
4
|
+
"description": "Live presenter and audience sync for liebstoeckel decks over Yjs and WebSocket.",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"liebstoeckel",
|
|
7
|
+
"slides",
|
|
8
|
+
"presentation-slides",
|
|
9
|
+
"ai-agents",
|
|
10
|
+
"ai",
|
|
11
|
+
"skills",
|
|
12
|
+
"yjs",
|
|
13
|
+
"crdt",
|
|
14
|
+
"websocket",
|
|
15
|
+
"bun"
|
|
16
|
+
],
|
|
17
|
+
"homepage": "https://liebstoeckel.app",
|
|
18
|
+
"bugs": "https://github.com/liebstoeckel/liebstoeckel-app/issues",
|
|
19
|
+
"repository": {
|
|
20
|
+
"type": "git",
|
|
21
|
+
"url": "git+https://github.com/liebstoeckel/liebstoeckel-app.git",
|
|
22
|
+
"directory": "packages/live-server"
|
|
23
|
+
},
|
|
24
|
+
"license": "MPL-2.0",
|
|
25
|
+
"author": "Leon Kaucher <contact@liebstoeckel.app>",
|
|
26
|
+
"publishConfig": {
|
|
27
|
+
"access": "public"
|
|
28
|
+
},
|
|
29
|
+
"files": [
|
|
30
|
+
"src",
|
|
31
|
+
"!src/**/*.test.ts",
|
|
32
|
+
"!src/**/*.test.tsx",
|
|
33
|
+
"LICENSE"
|
|
34
|
+
],
|
|
35
|
+
"engines": {
|
|
36
|
+
"bun": ">=1.3"
|
|
37
|
+
},
|
|
38
|
+
"type": "module",
|
|
39
|
+
"exports": {
|
|
40
|
+
".": "./src/index.ts",
|
|
41
|
+
"./cli": "./src/cli.ts"
|
|
42
|
+
},
|
|
43
|
+
"dependencies": {
|
|
44
|
+
"@liebstoeckel/engine": "^0.3.5",
|
|
45
|
+
"@liebstoeckel/plugin-sdk": "^0.3.4",
|
|
46
|
+
"@liebstoeckel/thumbnails": "^0.3.5",
|
|
47
|
+
"citty": "^0.2.2"
|
|
48
|
+
},
|
|
49
|
+
"peerDependencies": {
|
|
50
|
+
"yjs": "^13.6.31"
|
|
51
|
+
}
|
|
52
|
+
}
|
package/src/cli.ts
ADDED
|
@@ -0,0 +1,211 @@
|
|
|
1
|
+
#!/usr/bin/env bun
|
|
2
|
+
import { defineCommand, runMain } from "citty";
|
|
3
|
+
import { mkdtempSync, statSync } from "node:fs";
|
|
4
|
+
import { tmpdir } from "node:os";
|
|
5
|
+
import { dirname, join, resolve } from "node:path";
|
|
6
|
+
import { startServer } from "./server";
|
|
7
|
+
import { buildLinks } from "./session";
|
|
8
|
+
import { uploadDeck, runServerPluginsViaRelay, endSession } from "./relay-client";
|
|
9
|
+
|
|
10
|
+
export type TargetKind = "html" | "project" | "unknown";
|
|
11
|
+
|
|
12
|
+
/** Pure: decide how to treat a target path. */
|
|
13
|
+
export function classifyTargetPath(path: string, isDir: boolean): TargetKind {
|
|
14
|
+
if (/\.html?$/i.test(path)) return "html";
|
|
15
|
+
if (isDir || /package\.json$/i.test(path)) return "project";
|
|
16
|
+
return "unknown";
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
const TRUST_WARNING = `
|
|
20
|
+
⚠ liebstoeckel live server
|
|
21
|
+
This builds and runs the deck's code, including any plugins it bundles, server-side plugin code executes on THIS machine. Only run decks you trust.
|
|
22
|
+
`;
|
|
23
|
+
|
|
24
|
+
/** Resolve a target into deck HTML (building the project if needed). */
|
|
25
|
+
export async function loadDeckHtml(arg: string): Promise<string> {
|
|
26
|
+
const abs = resolve(arg);
|
|
27
|
+
const isDir = statSync(abs).isDirectory();
|
|
28
|
+
const kind = classifyTargetPath(abs, isDir);
|
|
29
|
+
if (kind === "html") return Bun.file(abs).text();
|
|
30
|
+
if (kind === "project") {
|
|
31
|
+
const dir = abs.endsWith("package.json") ? dirname(abs) : abs;
|
|
32
|
+
const { bundleDeck } = await import("@liebstoeckel/engine/build");
|
|
33
|
+
// Build to a throwaway dir, NOT the deck's own dist/. `liebstoeckel build` owns
|
|
34
|
+
// dist/<slug>.html (ADR 0068); a stray dist/index.html written here would shadow
|
|
35
|
+
// it for `push`'s default-file pick and confuse the two artifacts (ticket 0030).
|
|
36
|
+
const outdir = mkdtempSync(join(tmpdir(), "lst-live-"));
|
|
37
|
+
const prev = process.cwd();
|
|
38
|
+
process.chdir(dir);
|
|
39
|
+
try {
|
|
40
|
+
await bundleDeck({ entry: "./index.html", outdir, inlinePackage: false });
|
|
41
|
+
} finally {
|
|
42
|
+
process.chdir(prev);
|
|
43
|
+
}
|
|
44
|
+
return Bun.file(join(outdir, "index.html")).text();
|
|
45
|
+
}
|
|
46
|
+
throw new Error(`Cannot present target: ${arg} (expected a .html file or a deck project)`);
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
interface ThumbSettings {
|
|
50
|
+
enabled: boolean;
|
|
51
|
+
width?: number;
|
|
52
|
+
quality?: number;
|
|
53
|
+
scale?: number;
|
|
54
|
+
format?: "webp" | "jpeg" | "png";
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
/** The thumbnail-related flags shared by `live`, `thumbs`, and `build`. Capture is
|
|
58
|
+
* ON by default; `--no-thumbnails` flips `thumbnails` to false. */
|
|
59
|
+
export interface ThumbFlags {
|
|
60
|
+
thumbnails?: boolean;
|
|
61
|
+
format?: string;
|
|
62
|
+
width?: string;
|
|
63
|
+
quality?: string;
|
|
64
|
+
scale?: string;
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
/** Derive thumbnail settings from the parsed flags. Capture is ON unless
|
|
68
|
+
* `--no-thumbnails` was passed; an unknown `--format` and non-numeric sizes are
|
|
69
|
+
* ignored (mirrors `liebstoeckel thumbs`). Pure, the unit-test anchor. */
|
|
70
|
+
export function thumbSettings(f: ThumbFlags): ThumbSettings {
|
|
71
|
+
const num = (v: string | undefined): number | undefined => {
|
|
72
|
+
const n = v == null ? NaN : Number(v);
|
|
73
|
+
return Number.isFinite(n) ? n : undefined;
|
|
74
|
+
};
|
|
75
|
+
return {
|
|
76
|
+
enabled: f.thumbnails !== false,
|
|
77
|
+
width: num(f.width),
|
|
78
|
+
quality: num(f.quality),
|
|
79
|
+
scale: num(f.scale),
|
|
80
|
+
format: f.format === "webp" || f.format === "jpeg" || f.format === "png" ? f.format : undefined,
|
|
81
|
+
};
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
/** Capture + embed slide thumbnails into the deck HTML so the overview grid is
|
|
85
|
+
* instant and uniform. On by default. The gate/capture/embed/never-fatal policy
|
|
86
|
+
* lives in the thumbnails package's `withThumbnails`; this just wires it to the CLI
|
|
87
|
+
* (dynamic import so `--no-thumbnails` pays no playwright-core cost, and a missing
|
|
88
|
+
* module degrades to a hint rather than a crash). */
|
|
89
|
+
export async function addThumbnails(html: string, s: ThumbSettings): Promise<string> {
|
|
90
|
+
if (!s.enabled) return html;
|
|
91
|
+
let mod: typeof import("@liebstoeckel/thumbnails");
|
|
92
|
+
try {
|
|
93
|
+
mod = await import("@liebstoeckel/thumbnails");
|
|
94
|
+
} catch {
|
|
95
|
+
process.stderr.write("⚠ thumbnails skipped: @liebstoeckel/thumbnails not installed (pass --no-thumbnails to silence)\n");
|
|
96
|
+
return html;
|
|
97
|
+
}
|
|
98
|
+
process.stderr.write("▶ capturing slide thumbnails …\n");
|
|
99
|
+
const { html: out, manifest, skipped } = await mod.withThumbnails(html, {
|
|
100
|
+
width: s.width,
|
|
101
|
+
quality: s.quality,
|
|
102
|
+
scale: s.scale,
|
|
103
|
+
format: s.format,
|
|
104
|
+
onSlide: (i, n) => process.stderr.write(`\r slide ${i + 1}/${n} `),
|
|
105
|
+
});
|
|
106
|
+
if (skipped) {
|
|
107
|
+
process.stderr.write(`\r⚠ thumbnails skipped: ${skipped} \n`);
|
|
108
|
+
return html;
|
|
109
|
+
}
|
|
110
|
+
process.stderr.write(`\r✓ embedded ${Object.keys(manifest!.thumbs).length} thumbnails \n`);
|
|
111
|
+
return out;
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
/** LAN mode: serve the deck locally and relay Yjs over /sync. */
|
|
115
|
+
async function localMain(arg: string, thumbs: ThumbSettings, port?: number) {
|
|
116
|
+
process.stderr.write(TRUST_WARNING + "\n");
|
|
117
|
+
const html = await addThumbnails(await loadDeckHtml(arg), thumbs);
|
|
118
|
+
const live = await startServer({ html, port });
|
|
119
|
+
|
|
120
|
+
const local = buildLinks(`http://localhost:${live.port}`, live.session);
|
|
121
|
+
console.log(`\n▶ liebstoeckel live, session ${live.session.id}\n`);
|
|
122
|
+
console.log(` on this machine presenter ${local.presenter}`);
|
|
123
|
+
console.log(` audience ${local.viewer}`);
|
|
124
|
+
console.log(` on the network presenter ${live.links.presenter}`);
|
|
125
|
+
console.log(` audience ${live.links.viewer}`);
|
|
126
|
+
if (live.serverPlugins.length) console.log(`\n server plugins: ${live.serverPlugins.join(", ")}`);
|
|
127
|
+
|
|
128
|
+
const shutdown = () => {
|
|
129
|
+
live.stop();
|
|
130
|
+
process.exit(0);
|
|
131
|
+
};
|
|
132
|
+
process.on("SIGINT", shutdown);
|
|
133
|
+
process.on("SIGTERM", shutdown);
|
|
134
|
+
}
|
|
135
|
+
|
|
136
|
+
/** Relay mode: upload the deck to a public relay; run the deck's server plugins
|
|
137
|
+
* locally as the relay's privileged peer (deck code never runs on the relay). */
|
|
138
|
+
async function relayMain(arg: string, relayUrl: string, relayToken: string, thumbs: ThumbSettings) {
|
|
139
|
+
process.stderr.write(TRUST_WARNING + "\n");
|
|
140
|
+
const html = await addThumbnails(await loadDeckHtml(arg), thumbs);
|
|
141
|
+
process.stderr.write(`▶ uploading deck to ${relayUrl} …\n`);
|
|
142
|
+
const info = await uploadDeck(relayUrl, relayToken, html);
|
|
143
|
+
const runner = await runServerPluginsViaRelay({
|
|
144
|
+
html,
|
|
145
|
+
syncUrl: info.urls.sync,
|
|
146
|
+
runnerToken: info.runnerToken,
|
|
147
|
+
sessionId: info.id,
|
|
148
|
+
});
|
|
149
|
+
|
|
150
|
+
console.log(`\n▶ liebstoeckel live (relayed), session ${info.id}\n`);
|
|
151
|
+
console.log(` public presenter ${info.urls.presenter}`);
|
|
152
|
+
console.log(` audience ${info.urls.viewer}`);
|
|
153
|
+
if (runner.plugins.length) {
|
|
154
|
+
console.log(`\n server plugins (running locally): ${runner.plugins.join(", ")}`);
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
const shutdown = async () => {
|
|
158
|
+
runner.stop();
|
|
159
|
+
await endSession(relayUrl, relayToken, info.id);
|
|
160
|
+
process.exit(0);
|
|
161
|
+
};
|
|
162
|
+
process.on("SIGINT", () => void shutdown());
|
|
163
|
+
process.on("SIGTERM", () => void shutdown());
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
export const liveCommand = defineCommand({
|
|
167
|
+
meta: {
|
|
168
|
+
name: "live",
|
|
169
|
+
description: "present live (LAN by default, or through a public --relay)",
|
|
170
|
+
},
|
|
171
|
+
args: {
|
|
172
|
+
deck: {
|
|
173
|
+
type: "positional",
|
|
174
|
+
required: false,
|
|
175
|
+
description: "deck .html or deck source dir (default: cwd)",
|
|
176
|
+
valueHint: "deck.html|deck-dir",
|
|
177
|
+
},
|
|
178
|
+
dir: { type: "string", description: "deck directory (alternative to the positional)", valueHint: "deck" },
|
|
179
|
+
relay: { type: "string", description: "public relay URL to present through", valueHint: "url" },
|
|
180
|
+
"relay-token": { type: "string", description: "relay account token (or LIEBSTOECKEL_RELAY_TOKEN)", valueHint: "tok" },
|
|
181
|
+
port: { type: "string", description: "LAN listen port", valueHint: "N" },
|
|
182
|
+
thumbnails: {
|
|
183
|
+
type: "boolean",
|
|
184
|
+
default: true,
|
|
185
|
+
description: "capture slide thumbnails (needs Chromium)",
|
|
186
|
+
negativeDescription: "skip thumbnail capture",
|
|
187
|
+
},
|
|
188
|
+
format: { type: "string", description: "thumbnail image format", valueHint: "webp|jpeg|png" },
|
|
189
|
+
width: { type: "string", description: "thumbnail width in px", valueHint: "N" },
|
|
190
|
+
quality: { type: "string", description: "thumbnail image quality", valueHint: "N" },
|
|
191
|
+
scale: { type: "string", description: "thumbnail device scale factor", valueHint: "N" },
|
|
192
|
+
},
|
|
193
|
+
async run({ args }) {
|
|
194
|
+
// Deck targeting (ADR 0050): a leading positional, else --dir, else cwd.
|
|
195
|
+
const arg = args.deck ?? args.dir ?? ".";
|
|
196
|
+
const thumbs = thumbSettings(args);
|
|
197
|
+
const relayUrl = args.relay;
|
|
198
|
+
const relayToken = args["relay-token"] ?? process.env.LIEBSTOECKEL_RELAY_TOKEN;
|
|
199
|
+
if (relayUrl) {
|
|
200
|
+
if (!relayToken) {
|
|
201
|
+
console.error("--relay requires --relay-token <token> (or LIEBSTOECKEL_RELAY_TOKEN)");
|
|
202
|
+
process.exit(1);
|
|
203
|
+
}
|
|
204
|
+
await relayMain(arg, relayUrl, relayToken, thumbs);
|
|
205
|
+
} else {
|
|
206
|
+
await localMain(arg, thumbs, Number(args.port) || undefined);
|
|
207
|
+
}
|
|
208
|
+
},
|
|
209
|
+
});
|
|
210
|
+
|
|
211
|
+
if (import.meta.main) void runMain(liveCommand);
|
package/src/discovery.ts
ADDED
package/src/index.ts
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
export { startServer, lanAddress, type ServeOptions, type LiveServer } from "./server";
|
|
2
|
+
export { Hub, type Peer, type Send, type HubOptions, type AudiencePolicy } from "./relay";
|
|
3
|
+
export { audienceScopeFromHtml } from "./scope";
|
|
4
|
+
export {
|
|
5
|
+
buildAudienceScope,
|
|
6
|
+
authorizeAudienceUpdate,
|
|
7
|
+
tokenBucket,
|
|
8
|
+
type AudienceScope,
|
|
9
|
+
type PeerRole,
|
|
10
|
+
type TokenBucket,
|
|
11
|
+
} from "@liebstoeckel/plugin-sdk/authorize";
|
|
12
|
+
export { createSession, roleForToken, buildLinks, type Session, type Role, type Links } from "./session";
|
|
13
|
+
export { injectBootstrap, injectWatermark, type LiveBootstrap } from "./inject";
|
|
14
|
+
export {
|
|
15
|
+
embedManifest,
|
|
16
|
+
extractManifest,
|
|
17
|
+
encodeManifest,
|
|
18
|
+
parseManifest,
|
|
19
|
+
encodeServerBundle,
|
|
20
|
+
rehydrateServerBundle,
|
|
21
|
+
MANIFEST_ATTR,
|
|
22
|
+
type PluginManifest,
|
|
23
|
+
type PluginManifestEntry,
|
|
24
|
+
} from "./manifest";
|
|
25
|
+
export {
|
|
26
|
+
classifyPlugin,
|
|
27
|
+
discoverFromDeps,
|
|
28
|
+
discoverFromPackageJson,
|
|
29
|
+
fsLookup,
|
|
30
|
+
PLUGIN_KEYWORD,
|
|
31
|
+
type DiscoveredPlugin,
|
|
32
|
+
} from "./discovery";
|
|
33
|
+
export { classifyTargetPath, loadDeckHtml } from "./cli";
|
|
34
|
+
export {
|
|
35
|
+
uploadDeck,
|
|
36
|
+
endSession,
|
|
37
|
+
runServerPluginsViaRelay,
|
|
38
|
+
type RelaySessionInfo,
|
|
39
|
+
type RunnerHandle,
|
|
40
|
+
} from "./relay-client";
|
package/src/inject.ts
ADDED
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import type { Role } from "./session";
|
|
2
|
+
|
|
3
|
+
export interface LiveBootstrap {
|
|
4
|
+
ws: string; // websocket url
|
|
5
|
+
session: string;
|
|
6
|
+
role: Role;
|
|
7
|
+
token: string;
|
|
8
|
+
participant: string;
|
|
9
|
+
/** the read-only follow-along link (for the in-deck QR) */
|
|
10
|
+
viewer?: string;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/** Inject `window.__LIEBSTOECKEL_LIVE__` into <head> so the client knows a server
|
|
14
|
+
* is present (absence → standalone fallback). `</` is escaped to keep the inline
|
|
15
|
+
* script well-formed. */
|
|
16
|
+
export function injectBootstrap(html: string, boot: LiveBootstrap): string {
|
|
17
|
+
const json = JSON.stringify(boot).replace(/</g, "\\u003c");
|
|
18
|
+
const tag = `<script>window.__LIEBSTOECKEL_LIVE__=${json}</script>`;
|
|
19
|
+
if (html.includes("</head>")) return html.replace("</head>", `${tag}</head>`);
|
|
20
|
+
if (html.includes("<body")) return html.replace("<body", `${tag}<body`);
|
|
21
|
+
return tag + html;
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
const WATERMARK_HREF = "https://liebstoeckel.app";
|
|
25
|
+
|
|
26
|
+
/** Inject a small, unobtrusive "Published with liebstoeckel" provenance badge for the
|
|
27
|
+
* free-tier live audience view (ADR 0061 / ADR 0056). White-labelled (paid) sessions
|
|
28
|
+
* omit it. Inserted before the last </body>; self-contained inline styles (the deck
|
|
29
|
+
* runs in an opaque sandbox). The corner link opens in a new tab (allow-popups). */
|
|
30
|
+
export function injectWatermark(html: string): string {
|
|
31
|
+
const badge =
|
|
32
|
+
`<a href="${WATERMARK_HREF}" target="_blank" rel="noopener noreferrer"` +
|
|
33
|
+
` style="position:fixed;right:10px;bottom:10px;z-index:2147483647;` +
|
|
34
|
+
`font:500 11px/1 system-ui,sans-serif;color:#fff;background:rgba(0,0,0,.55);` +
|
|
35
|
+
`padding:5px 9px;border-radius:999px;text-decoration:none;letter-spacing:.02em;` +
|
|
36
|
+
`backdrop-filter:blur(4px);pointer-events:auto">Published with liebstoeckel</a>`;
|
|
37
|
+
const at = html.lastIndexOf("</body>");
|
|
38
|
+
return at >= 0 ? html.slice(0, at) + badge + html.slice(at) : html + badge;
|
|
39
|
+
}
|
package/src/manifest.ts
ADDED
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
import type * as Y from "yjs";
|
|
2
|
+
import { connectLive } from "@liebstoeckel/engine/live";
|
|
3
|
+
import { extractManifest, rehydrateServerBundle } from "./manifest";
|
|
4
|
+
|
|
5
|
+
export interface RelaySessionInfo {
|
|
6
|
+
id: string;
|
|
7
|
+
presenterToken: string;
|
|
8
|
+
viewerToken: string;
|
|
9
|
+
runnerToken: string;
|
|
10
|
+
expiresAt: number;
|
|
11
|
+
urls: { presenter: string; viewer: string; sync: string };
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
/** Upload a built deck to a relay and create a public session (tokens + urls).
|
|
15
|
+
* Audience write-scope + rate-limiting are enforced by default: a public viewer link
|
|
16
|
+
* invites strangers, so the relay must drop any audience update outside the plugins'
|
|
17
|
+
* declared `audienceWrites` (the scope is read from the deck's own embedded manifest).
|
|
18
|
+
* Pass `{ enforce: false }` only for a deliberately trusted audience. */
|
|
19
|
+
export async function uploadDeck(
|
|
20
|
+
relayUrl: string,
|
|
21
|
+
accountToken: string,
|
|
22
|
+
html: string,
|
|
23
|
+
opts: { enforce?: boolean } = {},
|
|
24
|
+
): Promise<RelaySessionInfo> {
|
|
25
|
+
const headers: Record<string, string> = {
|
|
26
|
+
authorization: `Bearer ${accountToken}`,
|
|
27
|
+
"content-type": "text/html",
|
|
28
|
+
};
|
|
29
|
+
if (opts.enforce !== false) headers["x-live-enforce"] = "1";
|
|
30
|
+
const res = await fetch(`${relayUrl.replace(/\/$/, "")}/api/sessions`, {
|
|
31
|
+
method: "POST",
|
|
32
|
+
headers,
|
|
33
|
+
body: html,
|
|
34
|
+
});
|
|
35
|
+
if (!res.ok) {
|
|
36
|
+
const msg = await res.text().catch(() => "");
|
|
37
|
+
throw new Error(`relay upload failed (${res.status} ${res.statusText})${msg ? `: ${msg}` : ""}`);
|
|
38
|
+
}
|
|
39
|
+
return (await res.json()) as RelaySessionInfo;
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
/** Tear down a relay session (best-effort). */
|
|
43
|
+
export async function endSession(relayUrl: string, accountToken: string, id: string): Promise<void> {
|
|
44
|
+
await fetch(`${relayUrl.replace(/\/$/, "")}/api/sessions/${id}`, {
|
|
45
|
+
method: "DELETE",
|
|
46
|
+
headers: { authorization: `Bearer ${accountToken}` },
|
|
47
|
+
}).catch(() => {});
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
export interface RunnerHandle {
|
|
51
|
+
plugins: string[];
|
|
52
|
+
stop(): void;
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
type ServerCtx = { doc: Y.Doc; session: { id: string } };
|
|
56
|
+
|
|
57
|
+
/** Run a deck's *server* plugins locally and apply their effects to the relay's
|
|
58
|
+
* shared doc by connecting as the privileged "runner" peer. The relay never runs
|
|
59
|
+
* deck code, it only relays the resulting Yjs updates to viewers. No-op (still
|
|
60
|
+
* resolves) for decks without any server plugins. */
|
|
61
|
+
export async function runServerPluginsViaRelay(opts: {
|
|
62
|
+
html: string;
|
|
63
|
+
/** ws(s)://<relay>/sync/<id> (no token) */
|
|
64
|
+
syncUrl: string;
|
|
65
|
+
runnerToken: string;
|
|
66
|
+
sessionId: string;
|
|
67
|
+
}): Promise<RunnerHandle> {
|
|
68
|
+
const manifest = extractManifest(opts.html);
|
|
69
|
+
const serverPlugins = (manifest?.plugins ?? []).filter((p) => p.hasServer && p.server);
|
|
70
|
+
if (serverPlugins.length === 0) return { plugins: [], stop() {} };
|
|
71
|
+
|
|
72
|
+
const sep = opts.syncUrl.includes("?") ? "&" : "?";
|
|
73
|
+
const conn = connectLive(
|
|
74
|
+
{
|
|
75
|
+
ws: `${opts.syncUrl}${sep}t=${encodeURIComponent(opts.runnerToken)}`,
|
|
76
|
+
session: opts.sessionId,
|
|
77
|
+
role: "presenter",
|
|
78
|
+
token: opts.runnerToken,
|
|
79
|
+
},
|
|
80
|
+
"runner",
|
|
81
|
+
);
|
|
82
|
+
|
|
83
|
+
const cleanups: Array<() => void> = [];
|
|
84
|
+
const plugins: string[] = [];
|
|
85
|
+
for (const p of serverPlugins) {
|
|
86
|
+
const mod = await rehydrateServerBundle(p.server!, p.name);
|
|
87
|
+
if (typeof mod.default === "function") {
|
|
88
|
+
const teardown = (mod.default as (ctx: ServerCtx) => unknown)({
|
|
89
|
+
doc: conn.doc,
|
|
90
|
+
session: { id: opts.sessionId },
|
|
91
|
+
});
|
|
92
|
+
if (typeof teardown === "function") cleanups.push(teardown as () => void);
|
|
93
|
+
plugins.push(p.name);
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
return {
|
|
98
|
+
plugins,
|
|
99
|
+
stop() {
|
|
100
|
+
for (const c of cleanups) c();
|
|
101
|
+
conn.close();
|
|
102
|
+
},
|
|
103
|
+
};
|
|
104
|
+
}
|
package/src/relay.ts
ADDED
|
@@ -0,0 +1,139 @@
|
|
|
1
|
+
import * as Y from "yjs";
|
|
2
|
+
import {
|
|
3
|
+
authorizeAudienceUpdate,
|
|
4
|
+
tokenBucket,
|
|
5
|
+
type AudienceScope,
|
|
6
|
+
type PeerRole,
|
|
7
|
+
type TokenBucket,
|
|
8
|
+
} from "@liebstoeckel/plugin-sdk/authorize";
|
|
9
|
+
|
|
10
|
+
export type Send = (data: Uint8Array) => void;
|
|
11
|
+
|
|
12
|
+
export interface Peer {
|
|
13
|
+
key: symbol;
|
|
14
|
+
/** feed an update received from this peer into the shared doc */
|
|
15
|
+
recv(data: Uint8Array): void;
|
|
16
|
+
/** detach this peer */
|
|
17
|
+
leave(): void;
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
export interface AudiencePolicy {
|
|
21
|
+
/** which doc areas an audience peer may write (ADR 0061). */
|
|
22
|
+
scope: AudienceScope;
|
|
23
|
+
/** per-audience-peer write rate limit; omit for no limit. */
|
|
24
|
+
rate?: { capacity: number; refillPerSec: number };
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
export interface HubOptions {
|
|
28
|
+
/** if set, periodically send a benign keepalive frame to every peer so quiet
|
|
29
|
+
* sessions still surface a "message" on the client (drives its watchdog) and
|
|
30
|
+
* dead peers are pruned. 0/undefined = off. */
|
|
31
|
+
keepaliveMs?: number;
|
|
32
|
+
/** if set, `audience`-role peers are write-scope enforced (ADR 0061): updates that
|
|
33
|
+
* touch anything outside the scope are dropped, not applied. Absent → no
|
|
34
|
+
* enforcement (every peer may write, the local/LAN trusted model, ADR 0012). */
|
|
35
|
+
audience?: AudiencePolicy;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
// A valid Yjs update for an empty doc: applying it is a no-op (no structs), but
|
|
39
|
+
// it's a real frame, so the client's message handler fires and resets its
|
|
40
|
+
// liveness watchdog without mutating any state.
|
|
41
|
+
const KEEPALIVE: Uint8Array = Y.encodeStateAsUpdate(new Y.Doc());
|
|
42
|
+
|
|
43
|
+
/** A minimal Yjs relay hub for one session: holds the authoritative doc, sends
|
|
44
|
+
* full state to newcomers, and broadcasts each update to every *other* peer.
|
|
45
|
+
* Server-plugin mutations (origin = undefined) broadcast to all. */
|
|
46
|
+
export class Hub {
|
|
47
|
+
readonly doc = new Y.Doc();
|
|
48
|
+
private peers = new Map<symbol, Send>();
|
|
49
|
+
private keepalive?: ReturnType<typeof setInterval>;
|
|
50
|
+
private readonly audience?: AudiencePolicy;
|
|
51
|
+
|
|
52
|
+
constructor(opts: HubOptions = {}) {
|
|
53
|
+
this.audience = opts.audience;
|
|
54
|
+
this.doc.on("update", (update: Uint8Array, origin: unknown) => {
|
|
55
|
+
for (const [key, send] of this.peers) {
|
|
56
|
+
if (key !== origin) this.deliver(key, send, update);
|
|
57
|
+
}
|
|
58
|
+
});
|
|
59
|
+
if (opts.keepaliveMs && opts.keepaliveMs > 0) {
|
|
60
|
+
this.keepalive = setInterval(() => {
|
|
61
|
+
for (const [key, send] of this.peers) this.deliver(key, send, KEEPALIVE);
|
|
62
|
+
}, opts.keepaliveMs);
|
|
63
|
+
// don't keep the process alive just for keepalives
|
|
64
|
+
(this.keepalive as { unref?: () => void }).unref?.();
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
/** Send to one peer; a failing send (dead/closing socket) drops that peer
|
|
69
|
+
* rather than throwing out of the broadcast loop and starving the others. */
|
|
70
|
+
private deliver(key: symbol, send: Send, data: Uint8Array): void {
|
|
71
|
+
try {
|
|
72
|
+
send(data);
|
|
73
|
+
} catch {
|
|
74
|
+
this.peers.delete(key);
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
get size(): number {
|
|
79
|
+
return this.peers.size;
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
/** Encode the full doc state as opaque Yjs update bytes, for persisting a session
|
|
83
|
+
* snapshot to object storage (ADR 0061). Persisting bytes runs no deck code. */
|
|
84
|
+
snapshot(): Uint8Array {
|
|
85
|
+
return Y.encodeStateAsUpdate(this.doc);
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
/** Seed the doc from a prior snapshot (re-seed on relay restart). No-op on garbage. */
|
|
89
|
+
seed(update: Uint8Array): void {
|
|
90
|
+
try {
|
|
91
|
+
Y.applyUpdate(this.doc, update);
|
|
92
|
+
} catch {
|
|
93
|
+
/* ignore bad seed */
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
join(send: Send, role: PeerRole = "presenter"): Peer {
|
|
98
|
+
const key = Symbol("peer");
|
|
99
|
+
this.peers.set(key, send);
|
|
100
|
+
// hand the newcomer the full current state (late-join replay)
|
|
101
|
+
this.deliver(key, send, Y.encodeStateAsUpdate(this.doc));
|
|
102
|
+
|
|
103
|
+
// An audience peer is write-scope enforced when a policy is configured (ADR 0061);
|
|
104
|
+
// presenter/runner peers are trusted and write the whole doc. With no policy the
|
|
105
|
+
// Hub is the open, trusted relay (ADR 0012), every peer may write.
|
|
106
|
+
const enforced = role === "audience" && this.audience !== undefined;
|
|
107
|
+
const bucket: TokenBucket | undefined =
|
|
108
|
+
enforced && this.audience!.rate
|
|
109
|
+
? tokenBucket(this.audience!.rate.capacity, this.audience!.rate.refillPerSec)
|
|
110
|
+
: undefined;
|
|
111
|
+
|
|
112
|
+
return {
|
|
113
|
+
key,
|
|
114
|
+
recv: (data) => {
|
|
115
|
+
// a malformed/garbage frame must never crash the relay or other peers
|
|
116
|
+
try {
|
|
117
|
+
if (enforced) {
|
|
118
|
+
if (bucket && !bucket.tryConsume(Date.now())) return; // rate-limited → drop
|
|
119
|
+
if (!authorizeAudienceUpdate(Y.encodeStateAsUpdate(this.doc), data, this.audience!.scope)) {
|
|
120
|
+
return; // out-of-scope write → drop, never applied/broadcast
|
|
121
|
+
}
|
|
122
|
+
}
|
|
123
|
+
Y.applyUpdate(this.doc, data, key);
|
|
124
|
+
} catch {
|
|
125
|
+
/* ignore bad update */
|
|
126
|
+
}
|
|
127
|
+
},
|
|
128
|
+
leave: () => {
|
|
129
|
+
this.peers.delete(key);
|
|
130
|
+
},
|
|
131
|
+
};
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
destroy(): void {
|
|
135
|
+
if (this.keepalive) clearInterval(this.keepalive);
|
|
136
|
+
this.peers.clear();
|
|
137
|
+
this.doc.destroy();
|
|
138
|
+
}
|
|
139
|
+
}
|
package/src/scope.ts
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { extractManifest } from "./manifest";
|
|
2
|
+
import { buildAudienceScope, type AudienceScope } from "@liebstoeckel/plugin-sdk/authorize";
|
|
3
|
+
|
|
4
|
+
// Build the audience write-scope for a session straight from the deck's own embedded
|
|
5
|
+
// plugin manifest (ADR 0061), the deck already carries it, so the relay needs no
|
|
6
|
+
// extra input to know which plugin fields an audience may write.
|
|
7
|
+
export function audienceScopeFromHtml(html: string): AudienceScope {
|
|
8
|
+
return buildAudienceScope(extractManifest(html));
|
|
9
|
+
}
|
package/src/server.ts
ADDED
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
import * as os from "node:os";
|
|
2
|
+
import { Hub } from "./relay";
|
|
3
|
+
import { createSession, roleForToken, buildLinks, type Session, type Links } from "./session";
|
|
4
|
+
import { injectBootstrap } from "./inject";
|
|
5
|
+
import { extractManifest, rehydrateServerBundle } from "./manifest";
|
|
6
|
+
|
|
7
|
+
/** First non-internal IPv4 address (for LAN links / QR). */
|
|
8
|
+
export function lanAddress(): string {
|
|
9
|
+
for (const list of Object.values(os.networkInterfaces())) {
|
|
10
|
+
for (const ni of list ?? []) {
|
|
11
|
+
if (ni.family === "IPv4" && !ni.internal) return ni.address;
|
|
12
|
+
}
|
|
13
|
+
}
|
|
14
|
+
return "127.0.0.1";
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
export interface ServeOptions {
|
|
18
|
+
/** built deck HTML (ideally with an embedded plugin manifest) */
|
|
19
|
+
html: string;
|
|
20
|
+
port?: number;
|
|
21
|
+
hostname?: string;
|
|
22
|
+
/** host used in the printed links / QR (defaults to the LAN address) */
|
|
23
|
+
publicHost?: string;
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
export interface LiveServer {
|
|
27
|
+
session: Session;
|
|
28
|
+
hub: Hub;
|
|
29
|
+
port: number;
|
|
30
|
+
baseUrl: string;
|
|
31
|
+
links: Links;
|
|
32
|
+
serverPlugins: string[];
|
|
33
|
+
stop(): void;
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
type WSData = { peer: ReturnType<Hub["join"]> | null };
|
|
37
|
+
|
|
38
|
+
/** cap inbound WS frames (Yjs updates for a poll-class deck are tiny) */
|
|
39
|
+
const MAX_FRAME_BYTES = 4 * 1024 * 1024;
|
|
40
|
+
|
|
41
|
+
/** Start a live session server for one deck. Rehydrates & runs any server plugins
|
|
42
|
+
* from the manifest, serves the deck with the live bootstrap injected, and relays
|
|
43
|
+
* Yjs over `/sync`. */
|
|
44
|
+
export async function startServer(opts: ServeOptions): Promise<LiveServer> {
|
|
45
|
+
const session = createSession();
|
|
46
|
+
const hub = new Hub({ keepaliveMs: 25_000 });
|
|
47
|
+
const cleanups: Array<() => void> = [];
|
|
48
|
+
const serverPlugins: string[] = [];
|
|
49
|
+
|
|
50
|
+
const manifest = extractManifest(opts.html);
|
|
51
|
+
if (manifest) {
|
|
52
|
+
for (const p of manifest.plugins) {
|
|
53
|
+
if (!p.hasServer || !p.server) continue;
|
|
54
|
+
const mod = await rehydrateServerBundle(p.server, p.name);
|
|
55
|
+
if (typeof mod.default === "function") {
|
|
56
|
+
// Runs the default instance; a multi-instance server plugin enumerates the rest
|
|
57
|
+
// from the doc index (readPluginInstances / observePluginIndex). ADR 0033/0034.
|
|
58
|
+
const teardown = (mod.default as (ctx: { doc: typeof hub.doc; session: { id: string }; instance: string }) => unknown)({
|
|
59
|
+
doc: hub.doc,
|
|
60
|
+
session: { id: session.id },
|
|
61
|
+
instance: "",
|
|
62
|
+
});
|
|
63
|
+
if (typeof teardown === "function") cleanups.push(teardown as () => void);
|
|
64
|
+
serverPlugins.push(p.name);
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
const server = Bun.serve<WSData>({
|
|
70
|
+
port: opts.port ?? 0,
|
|
71
|
+
hostname: opts.hostname ?? "0.0.0.0",
|
|
72
|
+
fetch(req, srv) {
|
|
73
|
+
const url = new URL(req.url);
|
|
74
|
+
const token = url.searchParams.get("t");
|
|
75
|
+
|
|
76
|
+
if (url.pathname === "/sync") {
|
|
77
|
+
if (!roleForToken(session, token)) return new Response("forbidden", { status: 403 });
|
|
78
|
+
const data: WSData = { peer: null };
|
|
79
|
+
return srv.upgrade(req, { data }) ? undefined : new Response("upgrade failed", { status: 400 });
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
if (url.pathname === "/") {
|
|
83
|
+
const role = roleForToken(session, token);
|
|
84
|
+
if (!role || !token) return new Response("Invalid or expired link.", { status: 403 });
|
|
85
|
+
const wsProto = url.protocol === "https:" ? "wss:" : "ws:";
|
|
86
|
+
const wsUrl = `${wsProto}//${url.host}/sync?t=${token}`;
|
|
87
|
+
const viewer = `${url.protocol}//${url.host}/?t=${session.viewerToken}`;
|
|
88
|
+
const body = injectBootstrap(opts.html, { ws: wsUrl, session: session.id, role, token, participant: "", viewer });
|
|
89
|
+
return new Response(body, { headers: { "content-type": "text/html; charset=utf-8" } });
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
return new Response("not found", { status: 404 });
|
|
93
|
+
},
|
|
94
|
+
websocket: {
|
|
95
|
+
// Bun auto-sends pings (sendPings default) and closes connections idle past
|
|
96
|
+
// this window, so a dead client is detected and its peer cleaned up.
|
|
97
|
+
idleTimeout: 120,
|
|
98
|
+
open(ws) {
|
|
99
|
+
ws.data.peer = hub.join((d) => ws.send(d));
|
|
100
|
+
},
|
|
101
|
+
message(ws, msg) {
|
|
102
|
+
if (typeof msg === "string") return;
|
|
103
|
+
const bytes = new Uint8Array(msg as unknown as ArrayBufferLike);
|
|
104
|
+
if (bytes.byteLength > MAX_FRAME_BYTES) return; // drop oversized frames
|
|
105
|
+
ws.data.peer?.recv(bytes); // recv is internally guarded
|
|
106
|
+
},
|
|
107
|
+
close(ws) {
|
|
108
|
+
ws.data.peer?.leave();
|
|
109
|
+
},
|
|
110
|
+
},
|
|
111
|
+
});
|
|
112
|
+
|
|
113
|
+
const host = opts.publicHost ?? lanAddress();
|
|
114
|
+
const port = server.port ?? 0;
|
|
115
|
+
const baseUrl = `http://${host}:${port}`;
|
|
116
|
+
return {
|
|
117
|
+
session,
|
|
118
|
+
hub,
|
|
119
|
+
port,
|
|
120
|
+
baseUrl,
|
|
121
|
+
links: buildLinks(baseUrl, session),
|
|
122
|
+
serverPlugins,
|
|
123
|
+
stop() {
|
|
124
|
+
for (const c of cleanups) c();
|
|
125
|
+
server.stop(true);
|
|
126
|
+
hub.destroy();
|
|
127
|
+
},
|
|
128
|
+
};
|
|
129
|
+
}
|
package/src/session.ts
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
export type Role = "presenter" | "viewer";
|
|
2
|
+
|
|
3
|
+
export interface Session {
|
|
4
|
+
id: string;
|
|
5
|
+
presenterToken: string;
|
|
6
|
+
viewerToken: string;
|
|
7
|
+
}
|
|
8
|
+
|
|
9
|
+
const hex = (bytes = 16): string => {
|
|
10
|
+
const a = new Uint8Array(bytes);
|
|
11
|
+
crypto.getRandomValues(a);
|
|
12
|
+
return Array.from(a, (b) => b.toString(16).padStart(2, "0")).join("");
|
|
13
|
+
};
|
|
14
|
+
|
|
15
|
+
/** Create a session with two unguessable tokens. `gen` is injectable for tests. */
|
|
16
|
+
export function createSession(gen: () => string = () => hex()): Session {
|
|
17
|
+
return { id: gen().slice(0, 8), presenterToken: gen(), viewerToken: gen() };
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
/** Resolve a role from a URL token. Unknown/missing → null (deny). */
|
|
21
|
+
export function roleForToken(s: Session, token: string | undefined | null): Role | null {
|
|
22
|
+
if (!token) return null;
|
|
23
|
+
if (token === s.presenterToken) return "presenter";
|
|
24
|
+
if (token === s.viewerToken) return "viewer";
|
|
25
|
+
return null;
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
export interface Links {
|
|
29
|
+
presenter: string;
|
|
30
|
+
viewer: string;
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
/** Build the shareable links. `base` is e.g. `http://192.168.1.5:4321`. */
|
|
34
|
+
export function buildLinks(base: string, s: Session): Links {
|
|
35
|
+
const b = base.replace(/\/$/, "");
|
|
36
|
+
return {
|
|
37
|
+
presenter: `${b}/?t=${s.presenterToken}`,
|
|
38
|
+
viewer: `${b}/?t=${s.viewerToken}`,
|
|
39
|
+
};
|
|
40
|
+
}
|