@effectstream/runtime 0.100.16 → 0.100.17
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -7
- package/package.json +14 -14
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @effectstream/runtime
|
|
2
2
|
|
|
3
|
-
The state-machine runtime
|
|
3
|
+
The state-machine runtime - the loop that ties sync, state machine,
|
|
4
4
|
database, events, and HTTP API together inside an EffectStream node.
|
|
5
5
|
Boot it with `init()` then drive it with `start(config)` and your node
|
|
6
6
|
is up.
|
|
@@ -71,15 +71,15 @@ runtime exposes a Fastify router.
|
|
|
71
71
|
|
|
72
72
|
## Key exports
|
|
73
73
|
|
|
74
|
-
- `init()`
|
|
75
|
-
- `start(config: StartConfig)`
|
|
74
|
+
- `init()` - `Operation<void>`. One-shot setup: OpenTelemetry, config validation, version pinning. Call before `start`.
|
|
75
|
+
- `start(config: StartConfig)` - `Operation<void>`. Run the node loop until cancelled.
|
|
76
76
|
|
|
77
77
|
Types and helpers re-exported alongside `init` / `start`:
|
|
78
78
|
|
|
79
|
-
- `DBMigrations`
|
|
80
|
-
- `StartConfig`, `StartConfigGameStateTransitions`, `StartConfigApiRouter`
|
|
81
|
-
- `PrimitiveConstructor<T>`
|
|
82
|
-
- `VERSION`
|
|
79
|
+
- `DBMigrations` - versioned SQL migrations passed into `start`.
|
|
80
|
+
- `StartConfig`, `StartConfigGameStateTransitions`, `StartConfigApiRouter` - `start`'s config types. Templates type-check against these implicitly but don't usually import them by name.
|
|
81
|
+
- `PrimitiveConstructor<T>` - extension point for new primitives.
|
|
82
|
+
- `VERSION` - `${number}.${number}.${number}` literal type for version pinning.
|
|
83
83
|
- Pagination helpers re-exported from `./api/pagination.ts`.
|
|
84
84
|
|
|
85
85
|
## Examples
|
package/package.json
CHANGED
|
@@ -1,29 +1,29 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@effectstream/runtime",
|
|
3
|
-
"version": "0.100.
|
|
3
|
+
"version": "0.100.17",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"homepage": "https://effectstream.github.io/docs/",
|
|
6
6
|
"repository": {
|
|
7
7
|
"type": "git",
|
|
8
|
-
"url": "https://github.com/
|
|
8
|
+
"url": "https://github.com/effectstream/effectstream",
|
|
9
9
|
"directory": "packages/node-sdk/runtime"
|
|
10
10
|
},
|
|
11
11
|
"bugs": {
|
|
12
|
-
"url": "https://github.com/
|
|
12
|
+
"url": "https://github.com/effectstream/effectstream/issues"
|
|
13
13
|
},
|
|
14
14
|
"exports": "./src/mod.ts",
|
|
15
15
|
"dependencies": {
|
|
16
|
-
"@effectstream/concise": "0.100.
|
|
17
|
-
"@effectstream/config": "0.100.
|
|
18
|
-
"@effectstream/coroutine": "0.100.
|
|
19
|
-
"@effectstream/crypto": "0.100.
|
|
20
|
-
"@effectstream/db": "0.100.
|
|
21
|
-
"@effectstream/event-client": "0.100.
|
|
22
|
-
"@effectstream/event-server": "0.100.
|
|
23
|
-
"@effectstream/log": "0.100.
|
|
24
|
-
"@effectstream/sm": "0.100.
|
|
25
|
-
"@effectstream/sync": "0.100.
|
|
26
|
-
"@effectstream/utils": "0.100.
|
|
16
|
+
"@effectstream/concise": "0.100.17",
|
|
17
|
+
"@effectstream/config": "0.100.17",
|
|
18
|
+
"@effectstream/coroutine": "0.100.17",
|
|
19
|
+
"@effectstream/crypto": "0.100.17",
|
|
20
|
+
"@effectstream/db": "0.100.17",
|
|
21
|
+
"@effectstream/event-client": "0.100.17",
|
|
22
|
+
"@effectstream/event-server": "0.100.17",
|
|
23
|
+
"@effectstream/log": "0.100.17",
|
|
24
|
+
"@effectstream/sm": "0.100.17",
|
|
25
|
+
"@effectstream/sync": "0.100.17",
|
|
26
|
+
"@effectstream/utils": "0.100.17",
|
|
27
27
|
"@fastify/cors": "^11.0.1",
|
|
28
28
|
"@metamask/json-rpc-engine": "^10.0.3",
|
|
29
29
|
"pg": "8.17.2",
|