@toshicloud/sdk 0.3.1 → 0.3.2

package/README.md

@@ -19,6 +19,8 @@ generated clients alike.
 
 In Node, with `@connectrpc/connect-node`:
 
+<!-- examples/quick-start.ts -->
+
 ```ts
 import { readFileSync } from "node:fs";
 import { createConnectTransport } from "@connectrpc/connect-node";
@@ -38,15 +40,21 @@ const toshi = createToshiClient({
 });
 
 const { projects } = await toshi.project.listProjects({});
+console.log(projects.length);
 ```
 
 In a browser, with `@connectrpc/connect-web`:
 
+<!-- examples/browser.ts -->
+
 ```ts
 import { createConnectTransport } from "@connectrpc/connect-web";
 import { createToshiClient } from "@toshicloud/sdk";
 
-const toshi = createToshiClient({
+// The token the browser app already holds.
+declare const token: string;
+
+export const toshi = createToshiClient({
   transport: (interceptors) =>
     createConnectTransport({ baseUrl: "https://toshi.example.com", interceptors }),
   token,
@@ -86,9 +94,12 @@ span the three types sit on `workload` itself: `listEvents`, `watchEvents`,
 `getOperation` and `waitOperation`. `run` sits at the top of the client, as
 `toshi run` sits at the top of the CLI.
 
+<!-- examples/client-shape.ts -->
+
 ```ts
 const { jobs } = await toshi.workload.jobs.list({ pageSize: 10 });
-const job = await toshi.workload.jobs.get({ id: jobs[0].id });
+const { job } = await toshi.workload.jobs.get({ id: jobs[0].id });
+console.log(job?.id);
 ```
 
 ### Retries
@@ -130,7 +141,10 @@ from a server error.
   `WatchEventsResponse` (`event`), and the output watch yields
   `WatchOutputResponse` (`stdout`, `stderr` or `end`).
 
+<!-- examples/watch-events.ts -->
+
 ```ts
+const id = "workload-id";
 const watch = await toshi.workload.watchEvents({ workloadId: id });
 for await (const { event } of watch) {
   console.log(event?.name);
@@ -151,7 +165,10 @@ client holds at most one buffer of input. `closeStdin` ends standard input
 after a pending write, and a later `write` is refused. `wait` settles when
 the command ends.
 
+<!-- examples/execute.ts -->
+
 ```ts
+const id = "sandbox-id";
 const proc = await toshi.workload.sandboxes.execute({
   sandboxId: id,
   command: { argv: ["cat"] },
@@ -184,6 +201,8 @@ job and its output, which is what `toshi run` does: `CreateJob`, then
 `WatchOutput`. It yields output chunks like an execution, and `wait()`
 resolves when the job exits 0 and rejects with `JobExitError` otherwise.
 
+<!-- examples/run-job.ts -->
+
 ```ts
 const run = await toshi.run({
   spec: { command: { argv: ["./test.sh"] } },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toshicloud/sdk",
-  "version": "0.3.1",
+  "version": "0.3.2",
   "description": "TypeScript client for the Toshi Workspace API",
   "license": "Apache-2.0",
   "packageManager": "pnpm@12.15.0+sha512.b3951d6d6ff4a9f13dc7cf56cd28d2b8eb37dbcc9c68e52e1e1191873ea9f82a017287ab50baadc5ccc494f036c67c0e47eb13608c2fa36f47711b61ea128e61",
@@ -18,7 +18,14 @@
   ],
   "sideEffects": false,
   "engines": {
-    "node": ">=24.22 <25"
+    "node": ">=22"
+  },
+  "devEngines": {
+    "runtime": {
+      "name": "node",
+      "version": ">=24.22 <25",
+      "onFail": "error"
+    }
   },
   "repository": {
     "type": "git",
@@ -38,6 +45,7 @@
   },
   "devDependencies": {
     "@connectrpc/connect-node": "2.2.0",
+    "@connectrpc/connect-web": "2.2.0",
     "@eslint/js": "10.0.1",
     "@types/node": "26.6.5",
     "@vitest/coverage-v8": "5.0.5",