@opengeni/sdk 0.11.0 → 0.15.0

package/README.md

@@ -70,19 +70,41 @@ the explicit alternative: deliver now by interrupting the running turn.
 
 ```ts
 // Queue (default): stacks behind the running turn.
-await client.sendMessage(workspaceId, sessionId, "Also check the nginx config");
+await client.sendMessage(workspaceId, sessionId, {
+  text: "Also check the nginx config",
+  clientEventId: crypto.randomUUID(),
+});
 
 // Steer: send + promote to the queue front + interrupt the running turn.
-await client.steerMessage(workspaceId, sessionId, "Stop — prod is paging, look at that first");
+await client.steerMessage(workspaceId, sessionId, {
+  text: "Stop — prod is paging, look at that first",
+  clientEventId: crypto.randomUUID(),
+});
 
-// Manage the queue while it waits.
-const turns = await client.listTurns(workspaceId, sessionId);
-await client.updateQueuedTurn(workspaceId, sessionId, turnId, { prompt: "rewritten" });
-await client.reorderQueuedTurns(workspaceId, sessionId, [turnB, turnA]);
-await client.deleteQueuedTurn(workspaceId, sessionId, turnId);
+// Manage the server-authoritative queue while it waits.
+const queue = await client.getQueue(workspaceId, sessionId);
+const waiting = queue.items.at(-1)!;
+await client.moveQueueItem(workspaceId, sessionId, waiting.id, {
+  expectedQueueVersion: queue.version,
+  beforeTurnId: queue.items[0]?.id ?? null,
+  clientEventId: crypto.randomUUID(),
+});
+await client.editQueueItem(workspaceId, sessionId, waiting.id, {
+  expectedTurnVersion: waiting.version,
+  expectedDraftRevision: 0,
+  replaceDraft: false,
+  clientEventId: crypto.randomUUID(),
+});
 
-// Control events.
-await client.interrupt(workspaceId, sessionId, { reason: "stop and report" });
+// Pause/Resume is recursive workstream control; it creates no queue row.
+await client.pauseSession(workspaceId, sessionId, {
+  reason: "hold this workstream",
+  expectedControlEtag: queue.effectiveControl.controlEtag,
+});
+const paused = await client.getQueue(workspaceId, sessionId);
+await client.resumeSession(workspaceId, sessionId, {
+  expectedControlEtag: paused.effectiveControl.controlEtag,
+});
 await client.sendApprovalDecision(workspaceId, sessionId, { approvalId, decision: "approve" });
 ```
 
@@ -149,12 +171,12 @@ Every public endpoint group has typed methods:
 | Group | Methods |
 | --- | --- |
 | Access + workspaces | `getAccessContext`, `listWorkspaces`, `createWorkspace`, `getWorkspace`, `updateWorkspace` |
-| Sessions + events | `createSession`, `listSessions`, `getSession`, `updateSession`, `listEvents`, `sendEvent`, `sendMessage`, `steerMessage`, `interrupt`, `sendApprovalDecision`, `streamEvents`, `openEventStream` |
+| Sessions + events | `createSession`, `listSessions`, `getSession`, `updateSession`, `listEvents`, `sendEvent`, `sendMessage`, `steerMessage`, `pauseSession`, `resumeSession`, `sendApprovalDecision`, `streamEvents`, `openEventStream` |
 | Machines (bring-your-own-compute) | `listMachines`, `machineMetricsSeries`, `swapActiveSandbox`, `mintEnrollToken`, `lookupDeviceEnrollment`, `approveDeviceEnrollment`, `denyDeviceEnrollment` |
-| Turn queue | `listTurns`, `updateQueuedTurn`, `reorderQueuedTurns`, `deleteQueuedTurn` |
+| Turn queue | `getQueue`, `moveQueueItem`, `editQueueItem`, `steerQueueItem`, `deleteQueueItem` |
 | Goal | `getGoal`, `updateGoal`, `pauseGoal`, `resumeGoal` |
 | Scheduled tasks | `createScheduledTask`, `listScheduledTasks`, `getScheduledTask`, `updateScheduledTask`, `pauseScheduledTask`, `resumeScheduledTask`, `triggerScheduledTask`, `deleteScheduledTask`, `listScheduledTaskRuns` |
-| Environments | `listEnvironments`, `createEnvironment`, `getEnvironment`, `updateEnvironment`, `deleteEnvironment`, `setEnvironmentVariable`, `deleteEnvironmentVariable` (values are write-only) |
+| Variable sets | `listVariable sets`, `createVariable set`, `getVariable set`, `updateVariable set`, `deleteVariable set`, `setVariable setVariable`, `deleteVariable setVariable` (values are write-only) |
 | Files | `uploadFile`, `beginFileUpload`, `completeFileUpload`, `getFile`, `createFileDownloadUrl` |
 | Documents | `createDocumentBase`, `listDocumentBases`, `getDocumentBase`, `addDocument`, `listDocuments`, `reindexDocument`, `searchDocuments` |
 | Packs | `listPacks`, `registerPack`, `getPack`, `enablePack`, `deletePack`, `listPackInstallations` |