@effectstream/node-sdk 0.100.14 → 0.100.16

package/README.md

@@ -0,0 +1,75 @@
+# @effectstream/node-sdk
+
+An umbrella package that re-exports every EffectStream runtime piece
+(runtime, state machine, sync, database, events, config, utils, concise
+schemas) under stable subpaths. Depend on this if you want a single
+name; import the underlying packages directly if you prefer.
+
+- Umbrella package: every Effectstream node piece reachable from one dependency.
+- Stable subpaths re-exporting the underlying packages (`/runtime`, `/sm`, `/db`, `/config`, ...).
+- Depend on this if you want a single name; import the underlying packages directly if you prefer.
+- Subpaths are thin re-exports, identical semantics to the source packages.
+
+## Install
+
+```bash
+bun add @effectstream/node-sdk
+# or
+npm install @effectstream/node-sdk
+```
+
+## Standalone usage
+
+Every piece is reachable from one dependency:
+
+```typescript
+import { init, start } from "@effectstream/node-sdk/runtime";
+import { Stm } from "@effectstream/node-sdk/sm";
+import { getConnection } from "@effectstream/node-sdk/db";
+import { ConfigBuilder, ConfigNetworkType } from "@effectstream/node-sdk/config";
+```
+
+The subpaths are thin re-exports — semantics are identical to importing
+from the underlying packages.
+
+## Inside EffectStream
+
+A namespace seam, not a runtime piece. Each subpath simply re-exports
+the corresponding package:
+
+```
+@effectstream/node-sdk/runtime    → @effectstream/runtime
+@effectstream/node-sdk/sm         → @effectstream/sm
+@effectstream/node-sdk/db         → @effectstream/db
+…
+```
+
+## Subpath exports
+
+- `@effectstream/node-sdk/runtime`: `init`, `start`, `StartConfig`, `DBMigrations`.
+- `@effectstream/node-sdk/sm`: `Stm` plus state-machine types and helpers.
+- `@effectstream/node-sdk/sm/builtin` ships built-in primitive type tags (ERC20, ERC721, ERC1155, Cardano transfer/mint-burn/pool-delegation, Midnight generic, NEAR, Avail, Celestia, ...).
+- `@effectstream/node-sdk/sm/grammar`: concise/grammar parsing utilities.
+- `@effectstream/node-sdk/sync` — `genSyncProtocols` and per-chain fetcher classes.
+- `@effectstream/node-sdk/db`: `getConnection`, query helpers, snapshot utilities.
+- `@effectstream/node-sdk/db/start-pglite`, `./db/apply-migrations`, `./db/db-wait`, `./db/pgtyped-update`, `./db/version`: DB operations scripts.
+- `@effectstream/node-sdk/db-emulator`: in-memory test DB migration runner.
+- `@effectstream/node-sdk/event-server`: local MQTT broker.
+- `@effectstream/node-sdk/config`: `ConfigBuilder` and friends.
+- `@effectstream/node-sdk/chain-types`, `./precompile`, `./concise`, `./coroutine` are pass-throughs to the same-named SDK packages.
+- `@effectstream/node-sdk/utils`, `./utils/node-env`, `./utils/runtime`: utility helpers.
+
+## Examples
+
+Runnable: [`test/examples.test.ts`](./test/examples.test.ts) — verifies
+each subpath resolves.
+
+For full working nodes, see:
+
+- [`templates/minimal/`](https://github.com/effectstream/effectstream/tree/main/templates/minimal)
+- [`templates/dice/`](https://github.com/effectstream/effectstream/tree/main/templates/dice)
+
+## Links
+
+- Docs: https://effectstream.github.io/docs/packages/node/node-sdk
+- Source: https://github.com/effectstream/effectstream/tree/main/packages/node-sdk/node

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@effectstream/node-sdk",
-  "version": "0.100.14",
+  "version": "0.100.16",
   "license": "MIT",
   "homepage": "https://effectstream.github.io/docs/",
   "repository": {
@@ -83,18 +83,18 @@
     }
   },
   "dependencies": {
-    "@effectstream/runtime": "0.100.14",
-    "@effectstream/sm": "0.100.14",
-    "@effectstream/sync": "0.100.14",
-    "@effectstream/db": "0.100.14",
-    "@effectstream/db-emulator": "0.100.14",
-    "@effectstream/coroutine": "0.100.14",
-    "@effectstream/event-server": "0.100.14",
-    "@effectstream/config": "0.100.14",
-    "@effectstream/chain-types": "0.100.14",
-    "@effectstream/precompile": "0.100.14",
-    "@effectstream/utils": "0.100.14",
-    "@effectstream/concise": "0.100.14"
+    "@effectstream/runtime": "0.100.16",
+    "@effectstream/sm": "0.100.16",
+    "@effectstream/sync": "0.100.16",
+    "@effectstream/db": "0.100.16",
+    "@effectstream/db-emulator": "0.100.16",
+    "@effectstream/coroutine": "0.100.16",
+    "@effectstream/event-server": "0.100.16",
+    "@effectstream/config": "0.100.16",
+    "@effectstream/chain-types": "0.100.16",
+    "@effectstream/precompile": "0.100.16",
+    "@effectstream/utils": "0.100.16",
+    "@effectstream/concise": "0.100.16"
   },
   "description": "Main application node SDK for EffectStream"
 }

package/test/examples.test.ts

@@ -0,0 +1,25 @@
+// Examples for the README — verify the subpath surface resolves.
+
+import { test, expect } from "bun:test";
+
+test("README: subpaths resolve to live modules", async () => {
+  const runtime = await import("../src/mod.ts");
+  expect(typeof runtime.init).toBe("function");
+  expect(typeof runtime.start).toBe("function");
+});
+
+test("README: state-machine subpath exposes Stm", async () => {
+  const sm = await import("../src/sm.ts");
+  expect("Stm" in sm).toBe(true);
+});
+
+test("README: db subpath exposes getConnection", async () => {
+  const db = await import("../src/db.ts");
+  expect(typeof db.getConnection).toBe("function");
+});
+
+test("README: concise re-export keeps generateStmInput in shape", async () => {
+  const concise = await import("../src/concise.ts");
+  expect(typeof concise.generateStmInput).toBe("function");
+  expect(typeof concise.parseStmInput).toBe("function");
+});