@kitware/wslink 2.5.0

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/.prettierrc.js ADDED
@@ -0,0 +1,8 @@
1
+ // .prettierrc.js
2
+ module.exports = {
3
+ trailingComma: "es5", // add trailing commas to objects, arrays, etc.
4
+ tabWidth: 2,
5
+ semi: true, // add semicolons at the end of statements
6
+ singleQuote: false, // use single quotes instead of double quotes
7
+ printWidth: 80, // specify the line length that the printer will wrap on
8
+ };
package/CHANGELOG.md ADDED
@@ -0,0 +1,551 @@
1
+ # [2.5.0](https://github.com/kitware/wslink/compare/v2.4.0...v2.5.0) (2025-10-20)
2
+
3
+
4
+ ### Features
5
+
6
+ * **symlinks:** add option to enable symlinks for static web serving ([d865d49](https://github.com/kitware/wslink/commit/d865d49272a970b82fbaee604168aafde553da5b))
7
+
8
+ # [2.4.0](https://github.com/kitware/wslink/compare/v2.3.4...v2.4.0) (2025-08-18)
9
+
10
+
11
+ ### Features
12
+
13
+ * **launcher:** allow to retry launcher request ([0b9b173](https://github.com/kitware/wslink/commit/0b9b173a044ed305dda111e0cac3821242d5f9b4))
14
+
15
+ ## [2.3.4](https://github.com/kitware/wslink/compare/v2.3.3...v2.3.4) (2025-05-20)
16
+
17
+
18
+ ### Bug Fixes
19
+
20
+ * **http-headers:** override settings on reload only if env available ([721eb54](https://github.com/kitware/wslink/commit/721eb5492bcca40e7ba77638c81d36667f151d86))
21
+
22
+ ## [2.3.3](https://github.com/kitware/wslink/compare/v2.3.2...v2.3.3) (2025-03-23)
23
+
24
+
25
+ ### Bug Fixes
26
+
27
+ * **HEART_BEAT:** properly reload env when overriden ([c5b7f3a](https://github.com/kitware/wslink/commit/c5b7f3a3ec5b89dbbd987b1887f3a552e511de13))
28
+
29
+ ## [2.3.2](https://github.com/kitware/wslink/compare/v2.3.1...v2.3.2) (2025-02-21)
30
+
31
+
32
+ ### Bug Fixes
33
+
34
+ * **emitter:** add EventEmitter tests and a way to specify allowed events ([b079e2e](https://github.com/kitware/wslink/commit/b079e2e1eeb1bbed35220d537ab64426946cbde7))
35
+
36
+ ## [2.3.1](https://github.com/kitware/wslink/compare/v2.3.0...v2.3.1) (2025-02-21)
37
+
38
+
39
+ ### Bug Fixes
40
+
41
+ * **typing:** remove typing messing up ParaView apps ([158bbda](https://github.com/kitware/wslink/commit/158bbda82977a3311f0a6580dda94dc3def85653))
42
+
43
+ # [2.3.0](https://github.com/kitware/wslink/compare/v2.2.2...v2.3.0) (2025-02-20)
44
+
45
+
46
+ ### Features
47
+
48
+ * **protocol:** log internal events through an object that can be subscribed to ([89175ba](https://github.com/kitware/wslink/commit/89175baee9f1956ab007368e577fff1d2709e30e))
49
+
50
+ ## [2.2.2](https://github.com/kitware/wslink/compare/v2.2.1...v2.2.2) (2025-01-07)
51
+
52
+
53
+ ### Bug Fixes
54
+
55
+ * **aiohttp:** use AppKey for state ([3a313f9](https://github.com/kitware/wslink/commit/3a313f9418498a6f9de66f45ecb7ca691ace45e5))
56
+
57
+ ## [2.2.1](https://github.com/kitware/wslink/compare/v2.2.0...v2.2.1) (2024-09-16)
58
+
59
+
60
+ ### Bug Fixes
61
+
62
+ * **NetworkMonitor:** add async completion() method ([62e4c68](https://github.com/kitware/wslink/commit/62e4c6812d111f3a50cbaeb9a7a4a988822efef5))
63
+
64
+ # [2.2.0](https://github.com/kitware/wslink/compare/v2.1.3...v2.2.0) (2024-09-16)
65
+
66
+
67
+ ### Features
68
+
69
+ * **NetworkMonitor:** add support for network completion monitoring ([3202aad](https://github.com/kitware/wslink/commit/3202aad42f71f2be156830412d77786f695684e9))
70
+
71
+ ## [2.1.3](https://github.com/kitware/wslink/compare/v2.1.2...v2.1.3) (2024-09-09)
72
+
73
+
74
+ ### Bug Fixes
75
+
76
+ * **generic:** proper api call ([c443c74](https://github.com/kitware/wslink/commit/c443c7490efcb0b030b303025946088af72c4476))
77
+
78
+ ## [2.1.2](https://github.com/kitware/wslink/compare/v2.1.1...v2.1.2) (2024-08-07)
79
+
80
+
81
+ ### Bug Fixes
82
+
83
+ * **js:** sessionManagerURL use baseURI ([bb4c34c](https://github.com/kitware/wslink/commit/bb4c34ce64f5056f1dc1b442edc2f79410983ac1))
84
+
85
+ ## [2.1.1](https://github.com/kitware/wslink/compare/v2.1.0...v2.1.1) (2024-06-20)
86
+
87
+
88
+ ### Bug Fixes
89
+
90
+ * add missing __future__ annotations for type hints ([472950f](https://github.com/kitware/wslink/commit/472950f98cee2175a507e664ef993eec471469fc))
91
+
92
+ # [2.1.0](https://github.com/kitware/wslink/compare/v2.0.5...v2.1.0) (2024-06-19)
93
+
94
+
95
+ ### Features
96
+
97
+ * **http:** add WSLINK_HTTP_HEADERS for HTTP header addon ([7d16203](https://github.com/kitware/wslink/commit/7d16203788c29ff234b693689e85491dc94c86e1))
98
+
99
+ ## [2.0.5](https://github.com/kitware/wslink/compare/v2.0.4...v2.0.5) (2024-06-06)
100
+
101
+
102
+ ### Bug Fixes
103
+
104
+ * **py:** add msg overhead in size limit ([5481a72](https://github.com/kitware/wslink/commit/5481a72148ff03bb11ed658952ab4c64f69950fe))
105
+
106
+ ## [2.0.4](https://github.com/kitware/wslink/compare/v2.0.3...v2.0.4) (2024-05-24)
107
+
108
+
109
+ ### Bug Fixes
110
+
111
+ * **header:** add default headers for shared_array_buffer ([0f9f22c](https://github.com/kitware/wslink/commit/0f9f22c2e9fb9db199d483bc6ad5fe7e26db8084))
112
+
113
+ ## [2.0.3](https://github.com/kitware/wslink/compare/v2.0.2...v2.0.3) (2024-05-20)
114
+
115
+
116
+ ### Bug Fixes
117
+
118
+ * **unchunker:** initial allowed message size to env var ([#158](https://github.com/kitware/wslink/issues/158)) ([488d637](https://github.com/kitware/wslink/commit/488d637eb9df2649444c5223c61669e142096a2b))
119
+
120
+ ## [2.0.2](https://github.com/kitware/wslink/compare/v2.0.1...v2.0.2) (2024-04-18)
121
+
122
+
123
+ ### Bug Fixes
124
+
125
+ * **jupyter:** properly handle generic ws for jupyter ([3bb84de](https://github.com/kitware/wslink/commit/3bb84dea56818f074628412fcc6c8063eaf87c01))
126
+
127
+ ## [2.0.1](https://github.com/kitware/wslink/compare/v2.0.0...v2.0.1) (2024-04-16)
128
+
129
+
130
+ ### Bug Fixes
131
+
132
+ * **cli:** remove shorthand args ([880951a](https://github.com/kitware/wslink/commit/880951a8bd3e5d4d8c2a916f602f71c10c61e84e))
133
+
134
+ # [2.0.0](https://github.com/kitware/wslink/compare/v1.12.4...v2.0.0) (2024-04-10)
135
+
136
+
137
+ ### Bug Fixes
138
+
139
+ * **python:** make msgpack/chunking compatible down to python 3.7 ([897ece7](https://github.com/kitware/wslink/commit/897ece73de93ddf4d0333d84ad778bf5e445ead7))
140
+
141
+
142
+ ### Features
143
+
144
+ * **chunking:** implement chunking of client/server messages ([a77a680](https://github.com/kitware/wslink/commit/a77a680326ae491eee023d01d990cdf3e5808f10))
145
+ * **msgpack:** use msgpack to serialize/deserialize messages ([4968ac1](https://github.com/kitware/wslink/commit/4968ac1cfab9aeaf1fcd0525319214f81ddd8973))
146
+
147
+
148
+ ### BREAKING CHANGES
149
+
150
+ * **chunking:** each message has a header and is possibly chunked
151
+ * **msgpack:** replace json serialization with msgpack
152
+
153
+ ## [1.12.4](https://github.com/kitware/wslink/compare/v1.12.3...v1.12.4) (2023-10-25)
154
+
155
+
156
+ ### Bug Fixes
157
+
158
+ * **logging:** implement scoped logging ([#152](https://github.com/kitware/wslink/issues/152)) ([07094c3](https://github.com/kitware/wslink/commit/07094c3d6ee502a5e35a1f9aa0c0e88fac377f9c)), closes [#151](https://github.com/kitware/wslink/issues/151)
159
+
160
+ ## [1.12.3](https://github.com/kitware/wslink/compare/v1.12.2...v1.12.3) (2023-10-05)
161
+
162
+
163
+ ### Bug Fixes
164
+
165
+ * **backend:** properly handle async run state for generic ([247b046](https://github.com/kitware/wslink/commit/247b0460f96c7277fb597b8dced80d81c65cba0a))
166
+
167
+ ## [1.12.2](https://github.com/kitware/wslink/compare/v1.12.1...v1.12.2) (2023-09-27)
168
+
169
+
170
+ ### Bug Fixes
171
+
172
+ * **ci:** semantic-release automation ([5967efc](https://github.com/kitware/wslink/commit/5967efc2811dcfa662dd51e4388c973c0403f4d5))
173
+
174
+ # [1.12.0](https://github.com/kitware/wslink/compare/v1.11.4...v1.12.0) (2023-09-27)
175
+
176
+
177
+ ### Features
178
+
179
+ * **jupyter:** Add jupyter backend ([db1bb39](https://github.com/kitware/wslink/commit/db1bb3943093b1f420bf30f4d887893b556fccc9))
180
+
181
+ ## [1.11.4](https://github.com/kitware/wslink/compare/v1.11.3...v1.11.4) (2023-09-06)
182
+
183
+
184
+ ### Bug Fixes
185
+
186
+ * **protocol:** const definition and usage ([0c34a25](https://github.com/kitware/wslink/commit/0c34a25456611cebf80be801b58c993bdee3b3f5))
187
+
188
+ ## [1.11.3](https://github.com/kitware/wslink/compare/v1.11.2...v1.11.3) (2023-09-05)
189
+
190
+
191
+ ### Bug Fixes
192
+
193
+ * **pub_manager:** handle old global publish manager ([d842b88](https://github.com/kitware/wslink/commit/d842b88d841f9c560bc534a5647f3ffcdcd1c070)), closes [#146](https://github.com/kitware/wslink/issues/146)
194
+
195
+ ## [1.11.2](https://github.com/kitware/wslink/compare/v1.11.1...v1.11.2) (2023-08-30)
196
+
197
+
198
+ ### Bug Fixes
199
+
200
+ * **publish_manager:** separation at server level for broadcast ([ffd269d](https://github.com/kitware/wslink/commit/ffd269d152abec57b8590f3c7e52172eb9841c91))
201
+
202
+ ## [1.11.1](https://github.com/kitware/wslink/compare/v1.11.0...v1.11.1) (2023-06-30)
203
+
204
+
205
+ ### Bug Fixes
206
+
207
+ * **aiohttp:** use app var instead of inheritance ([a0c7e64](https://github.com/kitware/wslink/commit/a0c7e64c6d18dd7e781ee59fae530fd29e130b00))
208
+ * **js:** Allow JS to use custom WebSocket implementation ([f7fad26](https://github.com/kitware/wslink/commit/f7fad26c58f3808c28cca0f20a3e90d8253c391c))
209
+
210
+ # [1.11.0](https://github.com/kitware/wslink/compare/v1.10.2...v1.11.0) (2023-06-09)
211
+
212
+
213
+ ### Features
214
+
215
+ * **backend:** Add generic backend ([d1b2b1b](https://github.com/kitware/wslink/commit/d1b2b1baa62f46215aed426fa1d90d3799cc3398))
216
+ * **backend:** Add tornado using the generic backend ([ee15e86](https://github.com/kitware/wslink/commit/ee15e86303b1e83d1c2bcb7a7b7e140012b9a22a))
217
+ * Rework code to simplify backends ([114c422](https://github.com/kitware/wslink/commit/114c4224b99cb67bacb44d43206fdc588fe22ce6))
218
+
219
+ ## [1.10.2](https://github.com/kitware/wslink/compare/v1.10.1...v1.10.2) (2023-05-19)
220
+
221
+
222
+ ### Bug Fixes
223
+
224
+ * **SmartConnect:** Allow delete to call exit later ([eeb7637](https://github.com/kitware/wslink/commit/eeb76372e55e6f0b1a9717c679400407997f303a))
225
+
226
+ ## [1.10.1](https://github.com/kitware/wslink/compare/v1.10.0...v1.10.1) (2023-02-15)
227
+
228
+
229
+ ### Bug Fixes
230
+
231
+ * **gracefulexit:** handle server exit for exec_mode=main ([9e06313](https://github.com/kitware/wslink/commit/9e063134b8e171116b374e80fa1ddcd790ca5109))
232
+ * **json5:** Bump version ([4d2e972](https://github.com/kitware/wslink/commit/4d2e9725199d3504897b2419880b07bdc606048c))
233
+
234
+ # [1.10.0](https://github.com/kitware/wslink/compare/v1.9.3...v1.10.0) (2022-12-20)
235
+
236
+
237
+ ### Features
238
+
239
+ * **launcher:** Make GET/DELETE endpoint optionals ([2dc2916](https://github.com/kitware/wslink/commit/2dc291639fc8fc709c9969df6f1872a19a9b51a0))
240
+
241
+ ## [1.9.3](https://github.com/kitware/wslink/compare/v1.9.2...v1.9.3) (2022-12-19)
242
+
243
+
244
+ ### Bug Fixes
245
+
246
+ * **launcher:** get/delete now works ([c95a23d](https://github.com/kitware/wslink/commit/c95a23d87d0360d68e1a58c3dbe63757e9268818))
247
+
248
+ ## [1.9.2](https://github.com/kitware/wslink/compare/v1.9.1...v1.9.2) (2022-12-08)
249
+
250
+
251
+ ### Bug Fixes
252
+
253
+ * **sessionManagerURL:** Make it path relative aware like default sessionURL ([7c351a3](https://github.com/kitware/wslink/commit/7c351a3d7a1b0b3ecd658ea99150ccee68a688ad))
254
+
255
+ ## [1.9.1](https://github.com/kitware/wslink/compare/v1.9.0...v1.9.1) (2022-11-01)
256
+
257
+
258
+ ### Bug Fixes
259
+
260
+ * **clientSession:** Make reverse connection subscriptable ([bb672ca](https://github.com/kitware/wslink/commit/bb672ca1ac5be92b015cb4479d4ac1409558de5c))
261
+ * **subscriptable:** fix typo ([13b60c5](https://github.com/kitware/wslink/commit/13b60c55f5e182232c8b1ced92db35ed52c92933))
262
+
263
+ # [1.9.0](https://github.com/kitware/wslink/compare/v1.8.4...v1.9.0) (2022-10-20)
264
+
265
+
266
+ ### Features
267
+
268
+ * **skip_last_active_client:** Better network handling for collaboration ([e4844e6](https://github.com/kitware/wslink/commit/e4844e6c395eb4de8b4223397108127ce24bfa25))
269
+
270
+ ## [1.8.4](https://github.com/kitware/wslink/compare/v1.8.3...v1.8.4) (2022-10-13)
271
+
272
+
273
+ ### Bug Fixes
274
+
275
+ * **ws_server:** handle client disconnection even in case of error ([0fa664e](https://github.com/kitware/wslink/commit/0fa664e9b04599c92337e1b9547fb8534fb90eca)), closes [#118](https://github.com/kitware/wslink/issues/118)
276
+
277
+ ## [1.8.3](https://github.com/kitware/wslink/compare/v1.8.2...v1.8.3) (2022-10-13)
278
+
279
+
280
+ ### Bug Fixes
281
+
282
+ * **security:** publish messages only to authenticated clients ([c630baa](https://github.com/kitware/wslink/commit/c630baae5a4b5daea74cbb63d3ab6edfb41b8c55))
283
+
284
+ ## [1.8.2](https://github.com/kitware/wslink/compare/v1.8.1...v1.8.2) (2022-08-24)
285
+
286
+
287
+ ### Bug Fixes
288
+
289
+ * **ssl:** forgot to import ssl from .ssl_context ([d1f5f71](https://github.com/kitware/wslink/commit/d1f5f71d3aa2c2bb060e72ec5d96dbf4f8fc9c19))
290
+
291
+ ## [1.8.1](https://github.com/kitware/wslink/compare/v1.8.0...v1.8.1) (2022-08-24)
292
+
293
+
294
+ ### Bug Fixes
295
+
296
+ * **ssl:** make import optional for ParaView ([be11056](https://github.com/kitware/wslink/commit/be1105641524f44127b97179924e57a29530cce6))
297
+
298
+ # [1.8.0](https://github.com/kitware/wslink/compare/v1.7.0...v1.8.0) (2022-08-24)
299
+
300
+
301
+ ### Features
302
+
303
+ * **SSL:** support ssl context ([00eed08](https://github.com/kitware/wslink/commit/00eed083ae6ac9679d48ba3193c727cd692a74e3))
304
+
305
+ # [1.7.0](https://github.com/kitware/wslink/compare/v1.6.6...v1.7.0) (2022-08-11)
306
+
307
+
308
+ ### Features
309
+
310
+ * **reverse-connection:** Add support for ClientWS and Relay service ([f62fef3](https://github.com/kitware/wslink/commit/f62fef31f310bbe28ee231184f4a3f78bb482b74))
311
+
312
+ ## [1.6.6](https://github.com/kitware/wslink/compare/v1.6.5...v1.6.6) (2022-07-05)
313
+
314
+
315
+ ### Bug Fixes
316
+
317
+ * **aiohttp:** Avoid newer, breaking versions ([de16350](https://github.com/kitware/wslink/commit/de1635053ca966c3732be4a86c860efe7608f28f))
318
+
319
+ ## [1.6.5](https://github.com/kitware/wslink/compare/v1.6.4...v1.6.5) (2022-06-03)
320
+
321
+
322
+ ### Bug Fixes
323
+
324
+ * **js:** Properly handle protocol mapping ([d02d41d](https://github.com/kitware/wslink/commit/d02d41de6755492115a8cb41fadd54662a696b60))
325
+
326
+ ## [1.6.4](https://github.com/kitware/wslink/compare/v1.6.3...v1.6.4) (2022-05-05)
327
+
328
+
329
+ ### Bug Fixes
330
+
331
+ * **ws_server:** Pass server at initialization ([758afe3](https://github.com/kitware/wslink/commit/758afe3a0b216fb706c9eed8af61e9b1a3135517))
332
+
333
+ ## [1.6.3](https://github.com/kitware/wslink/compare/v1.6.2...v1.6.3) (2022-05-04)
334
+
335
+
336
+ ### Bug Fixes
337
+
338
+ * **startup-msg:** Allow user to override startup message ([eda7a11](https://github.com/kitware/wslink/commit/eda7a11856ca719cbe54ec12c7aa10f3fa0fc25a))
339
+
340
+ ## [1.6.2](https://github.com/kitware/wslink/compare/v1.6.1...v1.6.2) (2022-05-04)
341
+
342
+
343
+ ### Bug Fixes
344
+
345
+ * **ws:** ensure valid ws before write ([3ba4e60](https://github.com/kitware/wslink/commit/3ba4e601e6fdcc04a5929df3e46e9ec3b26ded89))
346
+
347
+ ## [1.6.1](https://github.com/kitware/wslink/compare/v1.6.0...v1.6.1) (2022-04-28)
348
+
349
+
350
+ ### Bug Fixes
351
+
352
+ * **auth,log:** strip secret from logged messages ([dec6080](https://github.com/kitware/wslink/commit/dec60800d55aa90e8a38d7f2a6af08023e6497d4))
353
+
354
+ # [1.6.0](https://github.com/kitware/wslink/compare/v1.5.3...v1.6.0) (2022-04-26)
355
+
356
+
357
+ ### Features
358
+
359
+ * **timeout:** allow server without shutdown timeout ([3200728](https://github.com/kitware/wslink/commit/3200728c535c25bd30c031c0936a2c984fe3a7f8))
360
+
361
+ ## [1.5.3](https://github.com/kitware/wslink/compare/v1.5.2...v1.5.3) (2022-04-14)
362
+
363
+
364
+ ### Bug Fixes
365
+
366
+ * **security:** Allow to defer token validation to external method ([06bec0d](https://github.com/kitware/wslink/commit/06bec0d5d4b98da90310dc5eca6fc1add09e33e4))
367
+
368
+ ## [1.5.2](https://github.com/kitware/wslink/compare/v1.5.1...v1.5.2) (2022-04-08)
369
+
370
+
371
+ ### Bug Fixes
372
+
373
+ * **py3.6:** use get_event_loop instead of get_running_loop ([1b2343c](https://github.com/kitware/wslink/commit/1b2343c9a3ff514e79e93a45796cc2db914f129d))
374
+
375
+ ## [1.5.1](https://github.com/kitware/wslink/compare/v1.5.0...v1.5.1) (2022-04-04)
376
+
377
+
378
+ ### Bug Fixes
379
+
380
+ * **license:** include LICENSE file in wheel ([615b8d6](https://github.com/kitware/wslink/commit/615b8d6cd216388693867f58129230c84eaea782))
381
+
382
+ # [1.5.0](https://github.com/kitware/wslink/compare/v1.4.3...v1.5.0) (2022-04-01)
383
+
384
+
385
+ ### Features
386
+
387
+ * **exec_mode:** add exec_mode to start_webserver ([011d387](https://github.com/kitware/wslink/commit/011d387165c4859958f3f99b33227723dcf34944))
388
+
389
+ ## [1.4.3](https://github.com/kitware/wslink/compare/v1.4.2...v1.4.3) (2022-03-04)
390
+
391
+
392
+ ### Bug Fixes
393
+
394
+ * **queryString:** Keep queryString for index.html redicrect ([478ea09](https://github.com/kitware/wslink/commit/478ea096078c04b065210a55c941731be97343c7))
395
+
396
+ ## [1.4.2](https://github.com/kitware/wslink/compare/v1.4.1...v1.4.2) (2022-03-04)
397
+
398
+
399
+ ### Bug Fixes
400
+
401
+ * **relativePath:** add support for relative sessionURL and index.html ([4a53100](https://github.com/kitware/wslink/commit/4a5310095f1ffa23f45bbbccfe2f10a13a5e3e69))
402
+
403
+ ## [1.4.1](https://github.com/kitware/wslink/compare/v1.4.0...v1.4.1) (2022-02-09)
404
+
405
+
406
+ ### Bug Fixes
407
+
408
+ * **rpc:** better handling awaitable rpc ([e7eef8a](https://github.com/kitware/wslink/commit/e7eef8a11010682a44a1c0b845a2fe8ea4048623))
409
+
410
+ # [1.4.0](https://github.com/kitware/wslink/compare/v1.3.3...v1.4.0) (2022-02-08)
411
+
412
+
413
+ ### Features
414
+
415
+ * **heartbeat:** Control heartbeat with WSLINK_HEART_BEAT env ([2348bcb](https://github.com/kitware/wslink/commit/2348bcbcb66d0a59932c4aabcaa5227893871dcf))
416
+
417
+ ## [1.3.3](https://github.com/kitware/wslink/compare/v1.3.2...v1.3.3) (2022-01-24)
418
+
419
+
420
+ ### Bug Fixes
421
+
422
+ * **ts:** update the type definitions for subscribe ([e300fda](https://github.com/kitware/wslink/commit/e300fda999dd67569228f372e08949a5da08b390))
423
+
424
+ ## [1.3.2](https://github.com/kitware/wslink/compare/v1.3.1...v1.3.2) (2022-01-24)
425
+
426
+
427
+ ### Bug Fixes
428
+
429
+ * **js:** Add more type annotations ([5870064](https://github.com/kitware/wslink/commit/58700644712c4ed87144cf33ac086015b34bc4af))
430
+
431
+ ## [1.3.1](https://github.com/kitware/wslink/compare/v1.3.0...v1.3.1) (2022-01-03)
432
+
433
+
434
+ ### Bug Fixes
435
+
436
+ * **python:** use print for the startup message, not log.critical ([bee2f52](https://github.com/kitware/wslink/commit/bee2f520f010a6d2010a8039cd0b734489f10379))
437
+
438
+ # [1.3.0](https://github.com/kitware/wslink/compare/v1.2.1...v1.3.0) (2021-12-16)
439
+
440
+
441
+ ### Features
442
+
443
+ * **connection:** forward request+client_id to life cycle methods ([6c82264](https://github.com/kitware/wslink/commit/6c82264261344d245e3874a30bc65dfd7bb0fa6e))
444
+
445
+ ## [1.2.1](https://github.com/kitware/wslink/compare/v1.2.0...v1.2.1) (2021-12-12)
446
+
447
+
448
+ ### Bug Fixes
449
+
450
+ * **aiohttp:** register 30s heartbeat on ws ([2f0cc9a](https://github.com/kitware/wslink/commit/2f0cc9a212bfa5a538f5c34f62146e56fcf6fea8))
451
+
452
+ # [1.2.0](https://github.com/kitware/wslink/compare/v1.1.1...v1.2.0) (2021-12-06)
453
+
454
+
455
+ ### Features
456
+
457
+ * **port=0:** Add infrastructure to handle dynamically assigned port ([eca3e23](https://github.com/kitware/wslink/commit/eca3e238d86c18fd28d99869fe4bd93138727ec0))
458
+
459
+ ## [1.1.1](https://github.com/kitware/wslink/compare/v1.1.0...v1.1.1) (2021-11-19)
460
+
461
+
462
+ ### Bug Fixes
463
+
464
+ * **attachments:** Better scheduleing for free ([289f3df](https://github.com/kitware/wslink/commit/289f3dfaf186ffc72a1e3fd4eeae538c81254792))
465
+
466
+ # [1.1.0](https://github.com/kitware/wslink/compare/v1.0.7...v1.1.0) (2021-10-15)
467
+
468
+
469
+ ### Features
470
+
471
+ * **aiohttp:** Control max wslink msg with env var ([a30c5b2](https://github.com/kitware/wslink/commit/a30c5b2df908047a99ceed9d7fb89538ba251a94))
472
+
473
+ ## [1.0.7](https://github.com/kitware/wslink/compare/v1.0.6...v1.0.7) (2021-08-25)
474
+
475
+
476
+ ### Bug Fixes
477
+
478
+ * **cli:** Revert default host arg to localhost ([a39d8cf](https://github.com/kitware/wslink/commit/a39d8cf936d414c5aad21ed7bf590f791bfdb9ea))
479
+ * **static:** fix routes order definition for static content ([60457ab](https://github.com/kitware/wslink/commit/60457ab41bef4f0e6d1be94a605da0f6ea33b1a6))
480
+
481
+ ## [1.0.6](https://github.com/kitware/wslink/compare/v1.0.5...v1.0.6) (2021-08-20)
482
+
483
+
484
+ ### Bug Fixes
485
+
486
+ * **cli:** Update default --host arg to 0.0.0.0 ([ddbdda9](https://github.com/kitware/wslink/commit/ddbdda9af0b0cf05cfb4e660633d9c77d20f9e01))
487
+
488
+ ## [1.0.5](https://github.com/kitware/wslink/compare/v1.0.4...v1.0.5) (2021-08-13)
489
+
490
+
491
+ ### Bug Fixes
492
+
493
+ * **python:** prevent raise condition when sending attachements ([667e68e](https://github.com/kitware/wslink/commit/667e68e947d4e6b6ef253cfc06891fd703e0c592))
494
+
495
+ ## [1.0.4](https://github.com/kitware/wslink/compare/v1.0.3...v1.0.4) (2021-08-10)
496
+
497
+
498
+ ### Bug Fixes
499
+
500
+ * **JavaScript:** SmartConnector default decorator ([2973c8f](https://github.com/kitware/wslink/commit/2973c8f0038f6a5f4106820fae833aeea24ed281))
501
+
502
+ ## [1.0.3](https://github.com/kitware/wslink/compare/v1.0.2...v1.0.3) (2021-08-10)
503
+
504
+
505
+ ### Bug Fixes
506
+
507
+ * **javascript:** smartConnect will apply a default config decorator ([11ce5a6](https://github.com/kitware/wslink/commit/11ce5a66372bd338080a8527b2e8c8268ac8187b))
508
+ * **publish:** Only send publish msgs to each client once ([65ab38d](https://github.com/kitware/wslink/commit/65ab38dde2851dd8a590c4a0ccc967ba86f64bb1))
509
+
510
+ ## [1.0.2](https://github.com/kitware/wslink/compare/v1.0.1...v1.0.2) (2021-08-10)
511
+
512
+
513
+ ### Bug Fixes
514
+
515
+ * **http:** Automatically server index.html ([e43dde4](https://github.com/kitware/wslink/commit/e43dde43af797ed73f92d1b6a1b6adbd2078ea49))
516
+ * **scheduling:** Support scheduling tasks before server starts ([17c6750](https://github.com/kitware/wslink/commit/17c6750cc98424ae6e28067b08a34fbb428f19c1))
517
+
518
+ ## [1.0.1](https://github.com/kitware/wslink/compare/v1.0.0...v1.0.1) (2021-08-10)
519
+
520
+
521
+ ### Bug Fixes
522
+
523
+ * **js:** Small code cleanup ([58e025e](https://github.com/kitware/wslink/commit/58e025efd4f4f3f6deca3c8b88a6046d601fe183))
524
+ * **Python:** Better isolate backends implementations ([457b181](https://github.com/kitware/wslink/commit/457b181840804831272c5820ce77dfccf16c3d6e))
525
+
526
+ # [1.0.0](https://github.com/kitware/wslink/compare/v0.1.10...v1.0.0) (2021-08-09)
527
+
528
+
529
+ ### Bug Fixes
530
+
531
+ * **dependencies:** Move json5 from devDependencies to dependencies ([bcb2919](https://github.com/kitware/wslink/commit/bcb2919a54074acd1c1f5bca11210a38381dcfce))
532
+ * **dependencies:** update webpack for security updates. ([27d6744](https://github.com/kitware/wslink/commit/27d674431546f106db8d5a4c67beb79c479acefa))
533
+ * **deps:** Replace twisted/autobahn with asyncio/aiohttp ([2e804bb](https://github.com/kitware/wslink/commit/2e804bbde98c75f03a6268067ffd322c954644c2))
534
+ * **ProcessLauncher:** Allow user to provide custom http headers ([e831509](https://github.com/kitware/wslink/commit/e831509c7766c5315be1b3baf7c1ecf37c900d4f))
535
+ * **publish:** use manager to allow publish to all connected clients ([83b94ab](https://github.com/kitware/wslink/commit/83b94ab715c332f5a589d8649fa8bd80e879fcab))
536
+ * **python:** Automatic version handling ([964db33](https://github.com/kitware/wslink/commit/964db33dd806dafae2e7b7fd59e22aff521d1bb8))
537
+ * **python:** Fix exit methods ([a1627d0](https://github.com/kitware/wslink/commit/a1627d0d9b5784ba52efa1e915a2e7d283bd55fa))
538
+ * **SmartConnect:** Provide optional config decorator method ([9b6302f](https://github.com/kitware/wslink/commit/9b6302f68a1257cb834c1b4ab792a57853605edf))
539
+ * **twisted:** Update to 19.2.1 which is the same as PV ([b732f97](https://github.com/kitware/wslink/commit/b732f97dec10774d51342bbbeb5696ae37d6aa08))
540
+ * **version:** Update version to 0.1.12 ([71f8cce](https://github.com/kitware/wslink/commit/71f8cced0648b0729dcc9247fa31342016e86cbe))
541
+ * **version:** Update version to 0.1.13 ([6cc5441](https://github.com/kitware/wslink/commit/6cc544151079587228760eb8ccdf2ad5a7745c0e))
542
+ * **websocket:** allow publish before connect, as a no-op ([10bef95](https://github.com/kitware/wslink/commit/10bef955b826ff7bf678f19dfe02972f83844ba9))
543
+
544
+
545
+ ### BREAKING CHANGES
546
+
547
+ * **deps:** remove Py2 support and switch to aiohttp server
548
+
549
+ Re-implement the back-end using the websocket server implementation
550
+ from aiohttp, while leaving open the possibility of swapping out other
551
+ backends down the road.
package/LICENSE ADDED
@@ -0,0 +1,27 @@
1
+ Copyright (c) 2017, Kitware Inc.
2
+ All rights reserved.
3
+
4
+ Redistribution and use in source and binary forms, with or without modification,
5
+ are permitted provided that the following conditions are met:
6
+
7
+ 1. Redistributions of source code must retain the above copyright notice, this
8
+ list of conditions and the following disclaimer.
9
+
10
+ 2. Redistributions in binary form must reproduce the above copyright notice,
11
+ this list of conditions and the following disclaimer in the documentation and/or
12
+ other materials provided with the distribution.
13
+
14
+ 3. Neither the name of the copyright holder nor the names of its contributors
15
+ may be used to endorse or promote products derived from this software without
16
+ specific prior written permission.
17
+
18
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
19
+ ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20
+ WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21
+ DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
22
+ ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23
+ (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24
+ LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25
+ ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26
+ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27
+ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package/README.md ADDED
@@ -0,0 +1,36 @@
1
+ # wslink
2
+
3
+ Wslink allows easy, bi-directional communication between a python server and a
4
+ javascript client over a [websocket]. The client can make RPC calls to the
5
+ server, and the server can publish messages to topics that the client can
6
+ subscribe to. The server can include binary attachments in these messages, which
7
+ are communicated as a binary websocket message, avoiding the overhead of
8
+ encoding and decoding.
9
+
10
+ ## RPC and publish/subscribe
11
+
12
+ The initial users of wslink driving its development are [VTK] and [ParaViewWeb].
13
+ ParaViewWeb and vtkWeb require:
14
+
15
+ - RPC - a remote procedure call that can be fired by the client and return
16
+ sometime later with a response from the server, possibly an error.
17
+
18
+ - Publish/subscribe - client can subscribe to a topic provided by the server,
19
+ possibly with a filter on the parts of interest. When the topic has updated
20
+ results, the server publishes them to the client, without further action on
21
+ the client's part.
22
+
23
+ ## Get the whole story
24
+
25
+ This package is just the client side of wslink. See the [github repo] for the
26
+ full story - and to contribute or report issues!
27
+
28
+ ## License
29
+
30
+ Free to use in open-source and commercial projects, under the BSD-3-Clause
31
+ license.
32
+
33
+ [github repo]: https://github.com/kitware/wslink
34
+ [ParaViewWeb]: https://www.paraview.org/web/
35
+ [VTK]: http://www.vtk.org/
36
+ [websocket]: https://developer.mozilla.org/en-US/docs/Web/API/WebSocket