@helipod/sync 0.1.0 → 0.1.3

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 (2) hide show
  1. package/README.md +23 -0
  2. package/package.json +11 -11
package/README.md ADDED
@@ -0,0 +1,23 @@
1
+ # @helipod/sync
2
+
3
+ The WebSocket sync tier of the Helipod engine: reactive query subscriptions and the
4
+ protocol that serves them.
5
+
6
+ This package implements the version-bracketed sync protocol, the subscription manager
7
+ that tracks each session's live queries, and the protocol handler that re-runs and
8
+ pushes query results when a committed write intersects a subscription's recorded read
9
+ set — range-precise invalidation, so a write only wakes the subscriptions whose data
10
+ it actually touched. It also handles reconnect resume (unchanged results are
11
+ acknowledged with a small marker instead of resent, and briefly disconnected
12
+ subscriptions can skip re-execution entirely) and per-session backpressure so a slow
13
+ client cannot stall the engine.
14
+
15
+ It talks only to abstract socket and executor interfaces, so the same code serves an
16
+ embedded single-process engine or a multi-node deployment.
17
+
18
+ > This is an internal package of the Helipod engine. Most applications should install
19
+ > [`helipod`](https://www.npmjs.com/package/helipod) instead.
20
+
21
+ Part of [Helipod](https://github.com/helipod-sh/helipod) — docs at https://helipod-six.vercel.app/docs
22
+
23
+ License: FSL-1.1-Apache-2.0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@helipod/sync",
3
- "version": "0.1.0",
3
+ "version": "0.1.3",
4
4
  "type": "module",
5
5
  "license": "FSL-1.1-Apache-2.0",
6
6
  "sideEffects": false,
@@ -18,22 +18,22 @@
18
18
  ],
19
19
  "scripts": {
20
20
  "build": "tsup",
21
- "test": "vitest run",
21
+ "test": "vitest run --testTimeout=60000 --hookTimeout=60000",
22
22
  "typecheck": "tsc --noEmit",
23
23
  "clean": "rm -rf dist .turbo"
24
24
  },
25
25
  "dependencies": {
26
- "@helipod/errors": "0.1.0",
27
- "@helipod/index-key-codec": "0.1.0",
28
- "@helipod/query-engine": "0.1.0",
29
- "@helipod/values": "0.1.0"
26
+ "@helipod/errors": "0.1.3",
27
+ "@helipod/index-key-codec": "0.1.3",
28
+ "@helipod/query-engine": "0.1.3",
29
+ "@helipod/values": "0.1.3"
30
30
  },
31
31
  "devDependencies": {
32
- "@helipod/docstore": "0.1.0",
33
- "@helipod/docstore-sqlite": "0.1.0",
34
- "@helipod/executor": "0.1.0",
35
- "@helipod/id-codec": "0.1.0",
36
- "@helipod/transactor": "0.1.0",
32
+ "@helipod/docstore": "0.1.3",
33
+ "@helipod/docstore-sqlite": "0.1.3",
34
+ "@helipod/executor": "0.1.3",
35
+ "@helipod/id-codec": "0.1.3",
36
+ "@helipod/transactor": "0.1.3",
37
37
  "@types/node": "^22.10.5",
38
38
  "tsup": "^8.3.5",
39
39
  "typescript": "^5.7.2",