@skein-js/redis 0.1.0 → 0.2.1

package/README.md

@@ -1,48 +1,77 @@
 # @skein-js/redis
 
-> Redis job queue and cross-instance pub/sub streaming for skein-js.
+> Redis job queue (BullMQ) and cross-instance pub/sub streaming for skein-js.
 
-Part of **[skein-js](https://github.com/mainawycliffe/skein)** — a TypeScript [Agent Protocol](https://github.com/langchain-ai/agent-protocol) server for [LangGraph.js](https://github.com/langchain-ai/langgraphjs), and a drop-in replacement for the LangGraph CLI.
+Part of **[skein-js](../../README.md)** — a TypeScript [Agent Protocol](https://github.com/langchain-ai/agent-protocol) server for [LangGraph.js](https://github.com/langchain-ai/langgraphjs), and a drop-in replacement for the LangGraph CLI.
 
 **Status:** 🚧 Pre-alpha — implemented (BullMQ queue + Redis Streams/pub-sub bus); integration tests need Docker.
 
+> **Directory vs. name.** This package publishes as **`@skein-js/redis`** but lives on disk at
+> `packages/runtime-redis`.
+
 ## What it does
 
-Two `@skein-js/core` drivers for horizontal scaling:
+Two [`@skein-js/core`](../core) drivers for **horizontal scaling** — the piece LangGraph OSS does not
+provide:
 
 - **`RedisRunQueue`** — a durable background-run job queue on **[BullMQ](https://docs.bullmq.io)**.
   Multiple worker instances share one queue; BullMQ provides retries, backoff, concurrency, and
-  lease-based crash recovery (a stalled job whose worker died is moved back to the queue). Because
-  a run can be redelivered, delivery is **at-least-once** — the run worker makes this safe by
-  skipping any run already terminal in the store.
+  lease-based crash recovery (a stalled job whose worker died is moved back to the queue). Because a
+  run can be redelivered, delivery is **at-least-once** — the run worker makes this safe by skipping
+  any run already terminal in the store.
 - **`RedisRunEventBus`** — cross-instance SSE fan-out. Each run's frames go to a Redis Stream
   (durable replay for late joiners / reconnects via `afterSeq`) **and** a pub/sub channel (live
   tail), so a client connected to instance B can join a run executing on instance A.
 
+## Install
+
+```bash
+pnpm add @skein-js/redis
+```
+
+`ioredis` and `bullmq` are **bundled dependencies** — you do not install them separately. No peer
+dependencies. Needs a reachable Redis; the URL is passed to each constructor.
+
+## Usage
+
+Construct with a Redis URL — there is no migration step:
+
 ```ts
 import { RedisRunQueue, RedisRunEventBus } from "@skein-js/redis";
 
-const queue = new RedisRunQueue("redis://localhost:6379");
-const bus = new RedisRunEventBus("redis://localhost:6379");
-// Injected into the agent-protocol runtime as `deps.queue` / `deps.bus`.
+const queue = new RedisRunQueue(process.env.REDIS_URL!);
+const bus = new RedisRunEventBus(process.env.REDIS_URL!);
+// Injected into the engine as deps.queue / deps.bus.
+// …on shutdown, release the connections:
+await queue.dispose();
+await bus.dispose();
 ```
 
-## Reuse
+You normally get these via `skein dev --queue redis` / `skein up` and
+[`@skein-js/runtime`](../runtime), which reads `REDIS_URL` and constructs them for you.
 
-This package is the run **queue + pub/sub** — the piece LangGraph OSS does not provide. For
-Redis-backed _checkpointing_ (a different concern), use `@langchain/langgraph-checkpoint-redis`.
+## API
 
-## Install
+- **`class RedisRunQueue implements RunQueue`** — `new RedisRunQueue(url, options?)`.
+  `enqueue(run)` · `consume(process, options?)` → `RunConsumer` · `dispose()`.
+  **`RedisRunQueueOptions`** = `{ queueName?, attempts? }` (`queueName` default `"skein-runs"`, must
+  not contain `:`; `attempts` default `1`).
+- **`class RedisRunEventBus implements RunEventBus`** — `new RedisRunEventBus(url, options?)`.
+  `publish(runId, frame)` · `close(runId)` · `subscribe(runId, afterSeq = 0)` · `dispose()`.
+  **`RedisRunEventBusOptions`** = `{ keyPrefix?, streamTtlSeconds?, closedMarkerTtlSeconds?, closedCheckIntervalMs? }`
+  (defaults `"skein"`, `3600`, `86400`, `1000`).
 
-```bash
-pnpm add @skein-js/redis
-```
+> `close(runId)` ends one run's stream; `dispose()` tears down the whole driver's connections.
+
+## Reuse
+
+This package is the run **queue + pub/sub** — not a checkpointer. For Redis-backed _checkpointing_
+(a different concern), use `@langchain/langgraph-checkpoint-redis`.
 
 ## Learn more
 
-- [skein-js overview](../../docs/index.md)
-- [Reuse-first architecture](../../docs/reuse.md)
-- [Roadmap](../../docs/roadmap.md)
+- [Runs & Redis](../../docs/runs-and-redis.md) · [Streaming (SSE)](../../docs/streaming.md)
+- [skein-js overview](../../docs/index.md) · [Reuse-first architecture](../../docs/reuse.md) · [Root README](../../README.md)
 
 ## License
 

package/package.json

@@ -1,19 +1,20 @@
 {
   "name": "@skein-js/redis",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "description": "Redis job queue and cross-instance pub/sub streaming for skein-js.",
   "license": "Apache-2.0",
   "author": "Maina Wycliffe <wmmaina7@gmail.com>",
-  "homepage": "https://github.com/mainawycliffe/skein/tree/main/packages/runtime-redis#readme",
+  "homepage": "https://github.com/mainawycliffe/skein-js/tree/main/packages/runtime-redis#readme",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/mainawycliffe/skein.git",
+    "url": "git+https://github.com/mainawycliffe/skein-js.git",
     "directory": "packages/runtime-redis"
   },
   "bugs": {
-    "url": "https://github.com/mainawycliffe/skein/issues"
+    "url": "https://github.com/mainawycliffe/skein-js/issues"
   },
   "keywords": [
+    "typescript",
     "langgraph",
     "agent-protocol",
     "redis",
@@ -42,10 +43,10 @@
   "dependencies": {
     "ioredis": ">=5.4.0",
     "bullmq": ">=5.0.0",
-    "@skein-js/core": "0.1.0"
+    "@skein-js/core": "0.2.1"
   },
   "devDependencies": {
-    "@skein-js/test-support": "0.0.0"
+    "@skein-js/test-support": "0.2.1"
   },
   "publishConfig": {
     "access": "public"