Skip to content

Commit d6aa89f

Browse files
Nick Ficanoclaude
andcommitted
chore: add TypeDoc API docs generation and satisfy strict lint
- add typedoc + typedoc-plugin-markdown with a docs:api script and typedoc.json config - ignore generated docs/api/ output - use bracketed process.env access across examples, docs, and recipes - sort reserved-event re-exports in core execution.ts Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 95bb976 commit d6aa89f

58 files changed

Lines changed: 311 additions & 137 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,4 @@ coverage/
1010
.vitest/
1111
*.tgz
1212
.effect-migration/
13+
docs/api/

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ import { ARCPClient, WebSocketTransport } from "@agentruntimecontrolprotocol/sdk
4848
const client = new ARCPClient({
4949
client: { name: "quickstart", version: "1.0.0" },
5050
authScheme: "bearer",
51-
token: process.env.ARCP_TOKEN,
51+
token: process.env["ARCP_TOKEN"],
5252
});
5353

5454
const transport = await WebSocketTransport.connect("wss://runtime.example.com/arcp");
@@ -96,7 +96,7 @@ import { ARCPClient, WebSocketTransport } from "@agentruntimecontrolprotocol/sdk
9696
const client = new ARCPClient({
9797
client: { name: "resumable", version: "1.0.0" },
9898
authScheme: "bearer",
99-
token: process.env.ARCP_TOKEN,
99+
token: process.env["ARCP_TOKEN"],
100100
});
101101

102102
const welcome = await client.connect(
@@ -114,7 +114,7 @@ client.on("job.event", (env) => {
114114
const client2 = new ARCPClient({
115115
client: { name: "resumable", version: "1.0.0" },
116116
authScheme: "bearer",
117-
token: process.env.ARCP_TOKEN,
117+
token: process.env["ARCP_TOKEN"],
118118
});
119119
await client2.resume(
120120
await WebSocketTransport.connect("wss://runtime.example.com/arcp"),
@@ -150,7 +150,7 @@ Iterate the ordered event stream — `log`, `thought`, `tool_call`, `tool_result
150150
const client = new ARCPClient({
151151
client: { name: "ack-demo", version: "1.0.0" },
152152
authScheme: "bearer",
153-
token: process.env.ARCP_TOKEN,
153+
token: process.env["ARCP_TOKEN"],
154154
autoAck: { intervalMs: 250, minSeqDelta: 32 }, // coalesced session.ack
155155
});
156156

@@ -215,7 +215,7 @@ Attach read-only to a job submitted elsewhere and observe its live stream (with
215215
const observer = new ARCPClient({
216216
client: { name: "dashboard", version: "1.0.0" },
217217
authScheme: "bearer",
218-
token: process.env.ARCP_TOKEN,
218+
token: process.env["ARCP_TOKEN"],
219219
});
220220
await observer.connect(await WebSocketTransport.connect("wss://runtime.example.com/arcp"));
221221

docs/guides/auth.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ sends a token in `session.hello`; the runtime verifies it via a
1010
const client = new ARCPClient({
1111
client: { name: "my-client", version: "1.0.0" },
1212
authScheme: "bearer",
13-
token: process.env.TOKEN,
13+
token: process.env["TOKEN"],
1414
});
1515
```
1616

docs/guides/sessions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ import { ARCPClient, WebSocketTransport } from "@agentruntimecontrolprotocol/sdk
3636
const client = new ARCPClient({
3737
client: { name: "my-client", version: "1.0.0" },
3838
authScheme: "bearer",
39-
token: process.env.TOKEN,
39+
token: process.env["TOKEN"],
4040
// optional v1.1 features the client wants enabled:
4141
features: ["heartbeat", "ack", "list_jobs", "subscribe"],
4242
handshakeTimeoutMs: 5000,

docs/packages/client.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import { ARCPClient } from "@agentruntimecontrolprotocol/client";
1919
const client = new ARCPClient({
2020
client: { name: "my-client", version: "1.0.0" },
2121
authScheme: "bearer",
22-
token: process.env.TOKEN,
22+
token: process.env["TOKEN"],
2323

2424
// optional:
2525
capabilities: { encodings: ["json"] },

examples/ack-backpressure/client.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99

1010
import { ARCPClient, WebSocketTransport } from "@agentruntimecontrolprotocol/sdk";
1111

12-
const URL = process.env.ARCP_DEMO_URL ?? "ws://127.0.0.1:7886/arcp";
13-
const TOKEN = process.env.ARCP_DEMO_TOKEN ?? "demo-token";
12+
const URL = process.env["ARCP_DEMO_URL"] ?? "ws://127.0.0.1:7886/arcp";
13+
const TOKEN = process.env["ARCP_DEMO_TOKEN"] ?? "demo-token";
1414

1515
async function main(): Promise<void> {
1616
const client = new ARCPClient({

examples/ack-backpressure/server.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ import {
1414
startWebSocketServer,
1515
} from "@agentruntimecontrolprotocol/sdk";
1616

17-
const PORT = Number(process.env.ARCP_DEMO_PORT ?? 7886);
18-
const TOKEN = process.env.ARCP_DEMO_TOKEN ?? "demo-token";
17+
const PORT = Number(process.env["ARCP_DEMO_PORT"] ?? 7886);
18+
const TOKEN = process.env["ARCP_DEMO_TOKEN"] ?? "demo-token";
1919

2020
async function main(): Promise<void> {
2121
const server = new ARCPServer({

examples/agent-versions/client.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@
1010

1111
import { ARCPClient, WebSocketTransport } from "@agentruntimecontrolprotocol/sdk";
1212

13-
const URL = process.env.ARCP_DEMO_URL ?? "ws://127.0.0.1:7889/arcp";
14-
const TOKEN = process.env.ARCP_DEMO_TOKEN ?? "demo-token";
13+
const URL = process.env["ARCP_DEMO_URL"] ?? "ws://127.0.0.1:7889/arcp";
14+
const TOKEN = process.env["ARCP_DEMO_TOKEN"] ?? "demo-token";
1515

1616
async function main(): Promise<void> {
1717
const client = new ARCPClient({

examples/agent-versions/server.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ import {
1313
startWebSocketServer,
1414
} from "@agentruntimecontrolprotocol/sdk";
1515

16-
const PORT = Number(process.env.ARCP_DEMO_PORT ?? 7889);
17-
const TOKEN = process.env.ARCP_DEMO_TOKEN ?? "demo-token";
16+
const PORT = Number(process.env["ARCP_DEMO_PORT"] ?? 7889);
17+
const TOKEN = process.env["ARCP_DEMO_TOKEN"] ?? "demo-token";
1818

1919
async function main(): Promise<void> {
2020
const server = new ARCPServer({

examples/bun/client.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88

99
import { ARCPClient, WebSocketTransport } from "@agentruntimecontrolprotocol/sdk";
1010

11-
const PORT = Number(process.env.ARCP_DEMO_PORT ?? 7898);
12-
const URL = process.env.ARCP_DEMO_URL ?? `ws://127.0.0.1:${PORT}/arcp`;
13-
const TOKEN = process.env.ARCP_DEMO_TOKEN ?? "demo-token";
11+
const PORT = Number(process.env["ARCP_DEMO_PORT"] ?? 7898);
12+
const URL = process.env["ARCP_DEMO_URL"] ?? `ws://127.0.0.1:${PORT}/arcp`;
13+
const TOKEN = process.env["ARCP_DEMO_TOKEN"] ?? "demo-token";
1414

1515
async function main(): Promise<void> {
1616
const client = new ARCPClient({

0 commit comments

Comments
 (0)