@mokei/host-protocol 0.13.1 → 0.15.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.
Files changed (16) hide show
  1. package/LICENSE +0 -0
  2. package/README.md +20 -1
  3. package/lib/flow-schemas.d.ts +764 -0
  4. package/lib/flow-schemas.d.ts.map +1 -0
  5. package/lib/flow-schemas.js +541 -0
  6. package/lib/index.d.ts +4672 -94
  7. package/lib/index.d.ts.map +1 -1
  8. package/lib/index.js +462 -7
  9. package/lib/monitor-schemas.d.ts +161 -0
  10. package/lib/monitor-schemas.d.ts.map +1 -0
  11. package/lib/monitor-schemas.js +207 -0
  12. package/lib/trace-schemas.d.ts +878 -0
  13. package/lib/trace-schemas.d.ts.map +1 -0
  14. package/lib/trace-schemas.js +269 -0
  15. package/package.json +8 -7
  16. package/CHANGELOG.md +0 -9
package/LICENSE CHANGED
File without changes
package/README.md CHANGED
@@ -1,9 +1,28 @@
1
1
  # Mokei Host protocol
2
2
 
3
+ `@mokei/host-protocol` defines the typed procedures and events used by Mokei hosts and clients.
4
+ Flow procedures cover flow definitions, runs, traces and pending inbox items.
5
+
3
6
  ## Installation
4
7
 
5
8
  ```sh
6
9
  npm install @mokei/host-protocol
7
10
  ```
8
11
 
9
- ## [Documentation](https://mokei.dev)
12
+ ## Monitor procedures
13
+
14
+ The monitor procedure group contains `monitor.attach` and `monitor.presence`. An attachment
15
+ registers a monitor server with the daemon for the lifetime of its stream. The daemon validates
16
+ that the supplied URL is an HTTP loopback URL with a port and root path.
17
+
18
+ Each browser tab opens a presence channel using its attachment ID. It reports visibility,
19
+ notification permission and the item currently open. The daemon pings tabs before relying on
20
+ their state. Tabs acknowledge notification and prompt attempts, and can receive withdrawals
21
+ when a delivery is no longer needed. Ping and acknowledgement replies expire after five seconds.
22
+
23
+ The daemon reserves `monitor.attach` for the monitor process. Browser sessions cannot register
24
+ attachments.
25
+
26
+ See the [flow service guide](../flow-host-node/README.md#monitor-surface) for routing behaviour.
27
+
28
+ ## [Documentation](https://mokei.dev)