@effectstream/runtime 0.100.15 → 0.100.17

package/README.md

@@ -1,10 +1,15 @@
 # @effectstream/runtime
 
-The state-machine runtime — the loop that ties sync, state machine,
+The state-machine runtime - the loop that ties sync, state machine,
 database, events, and HTTP API together inside an EffectStream node.
 Boot it with `init()` then drive it with `start(config)` and your node
 is up.
 
+- The state-machine runtime that owns an Effectstream node's process model.
+- `init()` once, `start(config)` to run; ties sync, state machine, DB, events, and HTTP API together.
+- Used by every template.
+- Also reachable through `@effectstream/node-sdk/runtime`.
+
 ## Install
 
 ```bash
@@ -23,21 +28,27 @@ This package **owns the node's process model**. You don't pick parts of
 it; you call `init()` once at boot and then `start(config)`. The config
 brings together everything else:
 
+`init()` and `start()` are Effection operations, so they must be
+yielded inside an Effection `main()`:
+
 ```typescript
+import { main } from "effection";
 import { init, start } from "@effectstream/runtime";
 import { Stm } from "@effectstream/sm";
 import { config } from "./config.dev.ts";
 
-await init();
+await main(function* () {
+  yield* init();
 
-const gameStm = new Stm(grammar);
-gameStm.addStateTransition("join", function* () { /* ... */ });
+  const gameStm = new Stm(grammar);
+  gameStm.addStateTransition("join", function* () { /* ... */ });
 
-await start({
-  config,
-  gameStateTransitions: [gameStm],
-  apiRouter: undefined,           // optional Fastify route plugin
-  dbMigrations: [],               // SQL migrations
+  yield* start({
+    config,
+    gameStateTransitions: [gameStm],
+    apiRouter: undefined,           // optional Fastify route plugin
+    migrations: [],                 // SQL migrations
+  });
 });
 ```
 
@@ -60,30 +71,30 @@ runtime exposes a Fastify router.
 
 ## Key exports
 
-- `init()` — `Operation<void>`. One-shot setup: OpenTelemetry, config validation, version pinning. Call before `start`.
-- `start(config: StartConfig)` — `Operation<void>`. Run the node loop until cancelled.
+- `init()` - `Operation<void>`. One-shot setup: OpenTelemetry, config validation, version pinning. Call before `start`.
+- `start(config: StartConfig)` - `Operation<void>`. Run the node loop until cancelled.
 
 Types and helpers re-exported alongside `init` / `start`:
 
-- `DBMigrations` — versioned SQL migrations passed into `start`.
-- `StartConfig`, `StartConfigGameStateTransitions`, `StartConfigApiRouter` — `start`'s config types. Templates type-check against these implicitly but don't usually import them by name.
-- `PrimitiveConstructor<T>` — extension point for new primitives.
-- `VERSION` — `${number}.${number}.${number}` literal type for version pinning.
+- `DBMigrations` - versioned SQL migrations passed into `start`.
+- `StartConfig`, `StartConfigGameStateTransitions`, `StartConfigApiRouter` - `start`'s config types. Templates type-check against these implicitly but don't usually import them by name.
+- `PrimitiveConstructor<T>` - extension point for new primitives.
+- `VERSION` - `${number}.${number}.${number}` literal type for version pinning.
 - Pagination helpers re-exported from `./api/pagination.ts`.
 
 ## Examples
 
 The templates under
-[`templates/`](https://github.com/PaimaStudios/paima-engine/tree/main/templates)
+[`templates/`](https://github.com/effectstream/effectstream/tree/main/templates)
 are full working `init()` + `start()` examples. The simplest is
-[`templates/minimal/`](https://github.com/PaimaStudios/paima-engine/tree/main/templates/minimal).
+[`templates/minimal/`](https://github.com/effectstream/effectstream/tree/main/templates/minimal).
 
 End-to-end EVM sync test:
-[`e2e/evm/sync/`](https://github.com/PaimaStudios/paima-engine/tree/main/e2e/evm/sync).
+[`e2e/evm/sync/`](https://github.com/effectstream/effectstream/tree/main/e2e/evm/sync).
 
 Runnable: [`test/examples.test.ts`](./test/examples.test.ts).
 
 ## Links
 
 - Docs: https://effectstream.github.io/docs/packages/node/runtime
-- Source: https://github.com/PaimaStudios/paima-engine/tree/main/packages/node-sdk/runtime
+- Source: https://github.com/effectstream/effectstream/tree/main/packages/node-sdk/runtime

package/package.json

@@ -1,29 +1,29 @@
 {
   "name": "@effectstream/runtime",
-  "version": "0.100.15",
+  "version": "0.100.17",
   "license": "MIT",
   "homepage": "https://effectstream.github.io/docs/",
   "repository": {
     "type": "git",
-    "url": "https://github.com/PaimaStudios/paima-engine",
+    "url": "https://github.com/effectstream/effectstream",
     "directory": "packages/node-sdk/runtime"
   },
   "bugs": {
-    "url": "https://github.com/PaimaStudios/paima-engine/issues"
+    "url": "https://github.com/effectstream/effectstream/issues"
   },
   "exports": "./src/mod.ts",
   "dependencies": {
-    "@effectstream/concise": "0.100.15",
-    "@effectstream/config": "0.100.15",
-    "@effectstream/coroutine": "0.100.15",
-    "@effectstream/crypto": "0.100.15",
-    "@effectstream/db": "0.100.15",
-    "@effectstream/event-client": "0.100.15",
-    "@effectstream/event-server": "0.100.15",
-    "@effectstream/log": "0.100.15",
-    "@effectstream/sm": "0.100.15",
-    "@effectstream/sync": "0.100.15",
-    "@effectstream/utils": "0.100.15",
+    "@effectstream/concise": "0.100.17",
+    "@effectstream/config": "0.100.17",
+    "@effectstream/coroutine": "0.100.17",
+    "@effectstream/crypto": "0.100.17",
+    "@effectstream/db": "0.100.17",
+    "@effectstream/event-client": "0.100.17",
+    "@effectstream/event-server": "0.100.17",
+    "@effectstream/log": "0.100.17",
+    "@effectstream/sm": "0.100.17",
+    "@effectstream/sync": "0.100.17",
+    "@effectstream/utils": "0.100.17",
     "@fastify/cors": "^11.0.1",
     "@metamask/json-rpc-engine": "^10.0.3",
     "pg": "8.17.2",