@restless-stream/node 0.1.1 → 0.1.2

package/README.md

@@ -8,7 +8,7 @@ Use this package for server-side Node.js applications. Use `@restless-stream/cor
 
 ## Requirements
 
-- Node.js `>=20.19.0`.
+- Node.js `>=24`.
 - A Restless Stream account and API key.
 
 ## Installation
@@ -301,6 +301,98 @@ for await (const event of client.streams.subscribeWs({ wsUrl: session.wsUrl }))
 | `NodeSseHelperOptions` | Standalone SSE helper options. |
 | Core exports | Everything exported by `@restless-stream/core` is re-exported. |
 
+## Appendix: Creating an API Key
+
+API keys authenticate requests to the Restless Stream management API and runtime streams. Keys start with `rs_` followed by a hex string:
+
+```
+rs_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+```
+
+### Create a key in the dashboard
+
+1. Sign in at [restlessapi.stream](https://restlessapi.stream) and go to **API Keys** in the dashboard.
+
+![API Keys dashboard showing existing keys](docs/api-keys-dashboard.png)
+
+2. Click **Create API Key**, enter a name and optional description, and set an optional expiry date.
+
+![Create API Key modal form](docs/api-keys-create-modal.png)
+
+3. Copy the key immediately — it is shown only once after creation.
+
+```bash
+export RESTLESS_API_KEY="rs_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+```
+
+### Pass the key to the client
+
+```ts
+import { createNodeRestlessClient } from '@restless-stream/node';
+
+const client = createNodeRestlessClient({
+  apiKey: process.env.RESTLESS_API_KEY,
+});
+```
+
+## Sample Responses
+
+### `streams.validateApiKey()`
+
+```ts
+const result = await client.streams.validateApiKey();
+```
+
+**Response:**
+
+```json
+{
+  "id": "rs_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
+  "affected": true
+}
+```
+
+### `client.direct.subscribeWebSocket()` — live event via WebSocket
+
+```ts
+import { createNodeRestlessClient } from '@restless-stream/node';
+
+const client = createNodeRestlessClient({ apiKey: process.env.RESTLESS_API_KEY });
+
+for await (const event of client.direct.subscribeWebSocket(
+  { url: 'https://httpbin.org/get', method: 'GET', pollingInterval: 15 },
+  { reconnect: false },
+)) {
+  console.log(event);
+  break; // receive one event then stop
+}
+```
+
+**Event received:**
+
+```json
+{
+  "type": "update",
+  "meta": {
+    "timestamp": "2026-06-07T00:51:51.604+00:00",
+    "attempt_id": "f73b83fc-be23-4d38-a72d-bd9b0759bbc6",
+    "status": 200,
+    "latency_ms": 42
+  },
+  "data": {
+    "args": {},
+    "headers": {
+      "Accept": "*/*",
+      "Host": "httpbin.org",
+      "User-Agent": "Mozilla/5.0 (compatible; OurInternalService/1.0)",
+      "X-Amzn-Trace-Id": "Root=1-6a24c0a7-2d5742db01f24a04641abab9"
+    },
+    "origin": "140.82.14.127",
+    "url": "https://httpbin.org/get"
+  }
+}
+```
+
 ## Development
 
 ```bash

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@restless-stream/node",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Node.js SDK helpers for Restless Stream.",
   "license": "MIT",
   "repository": {
@@ -39,13 +39,13 @@
   },
   "dependencies": {
     "ws": "^8.18.0",
-    "@restless-stream/core": "0.1.1"
+    "@restless-stream/core": "0.1.2"
   },
   "devDependencies": {
     "@types/ws": "^8.18.1"
   },
   "engines": {
-    "node": ">=20.19.0"
+    "node": ">=24"
   },
   "sideEffects": false,
   "scripts": {