@perstack/api-client 0.0.47 → 0.0.48

package/README.md

@@ -72,6 +72,14 @@ interface RequestOptions {
 }
 ```
 
+For streaming endpoints, an extended `StreamRequestOptions` is available:
+
+```typescript
+interface StreamRequestOptions extends RequestOptions {
+  streamIdleTimeout?: number  // Idle timeout in ms between chunks (default: client timeout)
+}
+```
+
 ---
 
 ### Applications API
@@ -355,51 +363,6 @@ for await (const checkpoint of client.jobs.checkpoints.stream("job-id")) {
 }
 ```
 
-#### Workspace
-
-Access the job's workspace files.
-
-##### `client.jobs.workspace.get(jobId, options?)`
-
-Get workspace metadata.
-
-```typescript
-const result = await client.jobs.workspace.get("job-id")
-if (result.ok) {
-  console.log("Branch:", result.data.data.workspace.branch)
-  console.log("Stats:", result.data.data.workspace.stats)
-}
-```
-
-##### `client.jobs.workspace.tree(jobId, params?, options?)`
-
-List files in the workspace.
-
-```typescript
-const result = await client.jobs.workspace.tree("job-id", {
-  path: "src/",         // Optional: subdirectory path
-  recursive: true,      // Optional: include subdirectories
-})
-
-if (result.ok) {
-  for (const item of result.data.data.items) {
-    console.log(`${item.type}: ${item.path}`)
-  }
-}
-```
-
-##### `client.jobs.workspace.blob(jobId, path, options?)`
-
-Download a file from the workspace.
-
-```typescript
-const result = await client.jobs.workspace.blob("job-id", "src/main.ts")
-if (result.ok) {
-  const content = await result.data.text()
-  console.log(content)
-}
-```
-
 ---
 
 ### Experts API
@@ -650,16 +613,39 @@ if (!jobResult.ok) {
 const jobId = jobResult.data.data.job.id
 
 // Stream checkpoints
-try {
-  for await (const checkpoint of client.jobs.checkpoints.stream(jobId)) {
-    console.log("Checkpoint:", checkpoint.id)
-    console.log("Activity:", checkpoint.activity)
+for await (const result of client.jobs.checkpoints.stream(jobId)) {
+  if (!result.ok) {
+    if (result.error.aborted) {
+      console.error("Stream timed out or was cancelled")
+    } else {
+      console.error("Stream error:", result.error.message)
+    }
+    break
   }
-} catch (error) {
-  console.error("Stream error:", error)
+  console.log("Checkpoint:", result.data.id)
 }
 ```
 
+### Stream Timeout Configuration
+
+The streaming endpoints support an idle timeout that aborts the stream if no data is received within the specified period:
+
+```typescript
+for await (const result of client.jobs.checkpoints.stream(jobId, {
+  streamIdleTimeout: 60000, // 60 second idle timeout
+})) {
+  if (!result.ok) {
+    if (result.error.aborted) {
+      console.error("Stream timed out or was cancelled")
+    }
+    break
+  }
+  console.log("Checkpoint:", result.data.id)
+}
+```
+
+By default, the stream idle timeout uses the client's configured timeout value (30 seconds if not specified).
+
 ### Advanced SSE Parsing
 
 For custom SSE parsing, the package exports utility functions:
@@ -706,6 +692,7 @@ import type {
   ApiResult,
   ApiError,
   RequestOptions,
+  StreamRequestOptions,
 
   // Application types
   Application,