@agent-compose/sdk 0.7.0 → 0.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +66 -39
- package/dist/agent/__tests__/runtime-json-schema.test.d.ts +10 -0
- package/dist/agent/agent-context.d.ts +21 -1
- package/dist/agent/agent-loop.d.ts +24 -1
- package/dist/client.d.ts +338 -534
- package/dist/directives.d.ts +112 -0
- package/dist/display.d.ts +242 -0
- package/dist/errors.d.ts +24 -1
- package/dist/index.d.ts +24 -12
- package/dist/index.js +3545 -1667
- package/dist/pause/wrappers.d.ts +31 -9
- package/dist/runtimes/_acp-client.d.ts +46 -1
- package/dist/runtimes/_cli-agent.d.ts +49 -4
- package/dist/runtimes/_jsonl-guard.d.ts +103 -0
- package/dist/runtimes/amp.d.ts +2 -2
- package/dist/runtimes/claude-code.d.ts +59 -0
- package/dist/runtimes/claude-code.test.d.ts +14 -0
- package/dist/runtimes/claude.d.ts +16 -0
- package/dist/runtimes/claude.test.d.ts +8 -0
- package/dist/runtimes/codex.d.ts +9 -3
- package/dist/runtimes/cursor.d.ts +2 -2
- package/dist/runtimes/droid.d.ts +2 -2
- package/dist/runtimes/jsonl-guard.test.d.ts +19 -0
- package/dist/runtimes/openai-desktop.js +2691 -864
- package/dist/runtimes/opencode.d.ts +2 -2
- package/dist/runtimes/vercel.js +12 -1
- package/dist/sandbox/devbox.d.ts +42 -0
- package/dist/sandbox/exec-stream.d.ts +14 -0
- package/dist/sandbox/network-policy.d.ts +100 -0
- package/dist/sandbox/provider-def.d.ts +79 -0
- package/dist/sandbox/providers/desktop.d.ts +10 -0
- package/dist/sandbox/providers/e2b.d.ts +17 -0
- package/dist/sandbox/providers/local.d.ts +11 -0
- package/dist/sandbox/providers/vercel.d.ts +18 -0
- package/dist/sandbox/registry.d.ts +45 -0
- package/dist/sandbox/sizes.d.ts +68 -0
- package/dist/sandbox.d.ts +24 -299
- package/dist/step-invocation/__tests__/foreground-recovery.test.d.ts +1 -0
- package/dist/step-invocation/invoker.d.ts +10 -0
- package/dist/step-invocation/protocol.d.ts +5 -0
- package/dist/types/api-compliance.d.ts +71 -0
- package/dist/types/api-conversations.d.ts +492 -0
- package/dist/types/api-factory.d.ts +309 -0
- package/dist/types/api-projects.d.ts +131 -0
- package/dist/types/api-runs.d.ts +377 -0
- package/dist/types/api-scopes.d.ts +102 -0
- package/dist/types/conversation-stream.d.ts +191 -0
- package/dist/types/execution-context.d.ts +12 -2
- package/dist/types/protocol.d.ts +30 -1
- package/dist/types/sandbox-environment.d.ts +8 -5
- package/dist/types/sandbox.d.ts +74 -4
- package/dist/types/workflow-metadata.d.ts +33 -8
- package/dist/types/workflow-plan.d.ts +10 -0
- package/dist/types/workflow.d.ts +18 -205
- package/dist/utils/bundler.d.ts +12 -1
- package/dist/workflow-steps/index.d.ts +1 -1
- package/dist/workflow-steps/observability.d.ts +8 -1
- package/dist/workflow-steps/runner.d.ts +3 -3
- package/dist/workflow-steps/step.d.ts +15 -1
- package/dist/workflow-steps/types.d.ts +19 -5
- package/dist/workflow-steps/workflow.d.ts +22 -1
- package/dist/workflows/engine.d.ts +3 -2
- package/dist/workflows/invoke-child.d.ts +2 -2
- package/package.json +1 -1
- package/src/agent/agent-context.ts +186 -3
- package/src/agent/agent-loop.ts +31 -2
- package/src/client.ts +909 -621
- package/src/directives.ts +184 -0
- package/src/display.ts +788 -0
- package/src/errors.ts +39 -0
- package/src/index.ts +104 -10
- package/src/pause/wrappers.ts +44 -9
- package/src/runtimes/_acp-client.ts +72 -3
- package/src/runtimes/_cli-agent.ts +159 -36
- package/src/runtimes/_jsonl-guard.ts +219 -0
- package/src/runtimes/claude-code.ts +246 -0
- package/src/runtimes/claude.ts +32 -2
- package/src/runtimes/codex.ts +55 -3
- package/src/runtimes/openai-desktop.ts +59 -14
- package/src/sandbox/devbox.ts +48 -0
- package/src/sandbox/exec-stream.ts +48 -0
- package/src/sandbox/network-policy.ts +181 -0
- package/src/sandbox/provider-def.ts +94 -0
- package/src/sandbox/providers/desktop.ts +57 -0
- package/src/sandbox/providers/e2b.ts +354 -0
- package/src/sandbox/providers/local.ts +106 -0
- package/src/sandbox/providers/vercel.ts +331 -0
- package/src/sandbox/registry.ts +198 -0
- package/src/sandbox/sizes.ts +95 -0
- package/src/sandbox.ts +59 -1275
- package/src/step-invocation/invoker.ts +151 -28
- package/src/step-invocation/protocol.ts +8 -0
- package/src/types/api-compliance.ts +79 -0
- package/src/types/api-conversations.ts +522 -0
- package/src/types/api-factory.ts +336 -0
- package/src/types/api-projects.ts +140 -0
- package/src/types/api-runs.ts +412 -0
- package/src/types/api-scopes.ts +102 -0
- package/src/types/conversation-stream.ts +231 -0
- package/src/types/execution-context.ts +10 -2
- package/src/types/protocol.ts +33 -0
- package/src/types/sandbox-environment.ts +28 -9
- package/src/types/sandbox.ts +73 -4
- package/src/types/workflow-metadata.ts +35 -8
- package/src/types/workflow-plan.ts +11 -0
- package/src/types/workflow.ts +25 -292
- package/src/utils/bundler.ts +32 -5
- package/src/utils/errors.ts +16 -1
- package/src/workflow-steps/index.ts +1 -0
- package/src/workflow-steps/observability.ts +19 -8
- package/src/workflow-steps/runner.ts +4 -4
- package/src/workflow-steps/step.ts +49 -1
- package/src/workflow-steps/types.ts +20 -5
- package/src/workflow-steps/workflow.ts +22 -1
- package/src/workflows/engine.ts +3 -2
- package/src/workflows/invoke-child.ts +2 -2
package/dist/client.d.ts
CHANGED
|
@@ -10,524 +10,20 @@
|
|
|
10
10
|
* `register()` accepts pre-built sources — use the CLI (`agent-compose
|
|
11
11
|
* register`) or build sources yourself and pass them directly.
|
|
12
12
|
*/
|
|
13
|
-
import type { SandboxNetworkPolicy, SandboxSize } from "./sandbox.js";
|
|
14
13
|
import type { RunEvent } from "./types/events.js";
|
|
15
|
-
import type {
|
|
16
|
-
import type {
|
|
17
|
-
import type {
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
}
|
|
24
|
-
export
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
}
|
|
29
|
-
export interface RuntimeSourceInput {
|
|
30
|
-
name: string;
|
|
31
|
-
source: string;
|
|
32
|
-
}
|
|
33
|
-
/** GitHub provenance for a registered template's source file — stored as
|
|
34
|
-
* `metadata.source` on the registration. `cloud-build` stamps the built
|
|
35
|
-
* commit's sha; the dashboard's manual link path writes `sha: "manual"`. */
|
|
36
|
-
export interface TemplateSourceRef {
|
|
37
|
-
owner: string;
|
|
38
|
-
repo: string;
|
|
39
|
-
branch: string;
|
|
40
|
-
/** Repo-relative file path, e.g. `.agentc/workflows/workflow-deploy.ts`. */
|
|
41
|
-
path: string;
|
|
42
|
-
/** Commit sha the version was built from, or `"manual"` for hand-links. */
|
|
43
|
-
sha: string;
|
|
44
|
-
}
|
|
45
|
-
export interface RegisterWorkflowInput {
|
|
46
|
-
name: string;
|
|
47
|
-
source: string;
|
|
48
|
-
/** Structured attestation produced by `bundleWorkflow`. The server
|
|
49
|
-
* requires this on every registration; it proves the source was
|
|
50
|
-
* bundled by a `defineWorkflow`-aware toolchain. The server validates
|
|
51
|
-
* the manifest's shape and verifies `manifest.sourceHash` matches
|
|
52
|
-
* sha256(source) — the source bytes themselves are never parsed or
|
|
53
|
-
* executed on the server. */
|
|
54
|
-
manifest: WorkflowManifest;
|
|
55
|
-
version?: string;
|
|
56
|
-
/** Where the source file lives on GitHub — stored as `metadata.source`.
|
|
57
|
-
* Named `sourceRef` because `source` is the bundled code itself. */
|
|
58
|
-
sourceRef?: TemplateSourceRef;
|
|
59
|
-
schedule?: string;
|
|
60
|
-
runtimes?: RuntimeSourceInput[];
|
|
61
|
-
/** Human-readable description declared via
|
|
62
|
-
* `defineWorkflow({ description })`. Stored in template metadata and
|
|
63
|
-
* surfaced on the dashboard template card. */
|
|
64
|
-
description?: string;
|
|
65
|
-
networkPolicy?: unknown;
|
|
66
|
-
placeholders?: Record<string, string>;
|
|
67
|
-
/** All snapshot config — `bootFrom` (where to restore at run start),
|
|
68
|
-
* `save`, `retain`. See `WorkflowMetadata.snapshots`. */
|
|
69
|
-
snapshots?: SnapshotConfig;
|
|
70
|
-
/** Sandbox machine resources — size + provider (template defaults).
|
|
71
|
-
* See `WorkflowMetadata.resources`. */
|
|
72
|
-
resources?: SandboxResources;
|
|
73
|
-
/** Provider-neutral execution plan detected by the CLI bundler. */
|
|
74
|
-
workflowPlan?: WorkflowPlan;
|
|
75
|
-
/** Connector requirements declared via `defineWorkflow({ connectors })`
|
|
76
|
-
* (ADR-0007). Validated against the server's provider registry at
|
|
77
|
-
* registration; tokens are injected at the network layer at dispatch. */
|
|
78
|
-
connectors?: ConnectorRequirements;
|
|
79
|
-
/** Connector-catalogue operation tag — see `ConnectorOperationTag`. */
|
|
80
|
-
connectorOperation?: ConnectorOperationTag;
|
|
81
|
-
/** Tier-1 invoke ACL declared via `defineWorkflow({ invokePolicy })`.
|
|
82
|
-
* Only meaningful when the workflow also declares `connectors` — the
|
|
83
|
-
* server gates dispatch on it before binding any grant. */
|
|
84
|
-
invokePolicy?: InvokePolicy;
|
|
85
|
-
/** Input schema extracted from the workflow's `input` zod schema. */
|
|
86
|
-
inputSchema?: IOSchema;
|
|
87
|
-
/** Output schema extracted from the workflow's `output` zod schema. */
|
|
88
|
-
outputSchema?: IOSchema;
|
|
89
|
-
/** Set by `defineSandboxEnvironment` — marks an environment build so the
|
|
90
|
-
* server skips the /factory mount for its runs (#13). See
|
|
91
|
-
* `WorkflowMetadata.environmentBuild`. */
|
|
92
|
-
environmentBuild?: boolean;
|
|
93
|
-
/** Factory slug. Defaults to `"default"`. */
|
|
94
|
-
factorySlug?: string;
|
|
95
|
-
}
|
|
96
|
-
export type RunState = "running" | "success" | "failed" | "abandoned" | "canceled";
|
|
97
|
-
export interface InvokeWorkflowOptions {
|
|
98
|
-
/** Per-invocation snapshot config override. `snapshots.bootFrom`
|
|
99
|
-
* replaces the template's boot source; `snapshots.saveLatest` and
|
|
100
|
-
* `snapshots.retainSteps` override capture mode. Anything omitted
|
|
101
|
-
* falls back to the template's registered default. */
|
|
102
|
-
snapshots?: SnapshotConfig;
|
|
103
|
-
/** Per-invocation network policy override. Replaces the template-level
|
|
104
|
-
* policy for this run only — registered metadata is not mutated. */
|
|
105
|
-
networkPolicy?: SandboxNetworkPolicy;
|
|
106
|
-
/** Per-invocation placeholder override. Maps secret names referenced in
|
|
107
|
-
* `networkPolicy` ($VAR) to the values the runner should see for env
|
|
108
|
-
* vars after brokering. Replaces the template-level placeholders for
|
|
109
|
-
* this run only — registered metadata is not mutated. */
|
|
110
|
-
placeholders?: Record<string, string>;
|
|
111
|
-
/** Per-invocation machine-size override of the template's `resources.size`.
|
|
112
|
-
* `small` (default) | `medium` | `large`; omit → the template default,
|
|
113
|
-
* else `small`. Honoured on Vercel (→ vCPUs); E2B ignores it. */
|
|
114
|
-
size?: SandboxSize;
|
|
115
|
-
/** Explicit parent run id. Pass `null` to suppress ambient RUN_ID auto-detection. */
|
|
116
|
-
parentRunId?: string | null;
|
|
117
|
-
/** Agent loop inside the parent run that caused this invoke, when applicable. */
|
|
118
|
-
agentId?: string | null;
|
|
119
|
-
/** Factory slug. Defaults to `"default"`. */
|
|
120
|
-
factorySlug?: string;
|
|
121
|
-
/** Idempotency key — sent as the `Idempotency-Key` header. A repeat invoke
|
|
122
|
-
* with the same key inside the server's dedup window returns the original
|
|
123
|
-
* run instead of starting a new one (matches `resumePause`'s pattern). */
|
|
124
|
-
idempotencyKey?: string;
|
|
125
|
-
}
|
|
126
|
-
export interface InvokeAndWaitOptions extends InvokeWorkflowOptions {
|
|
127
|
-
timeoutMs?: number;
|
|
128
|
-
pollIntervalMs?: number;
|
|
129
|
-
}
|
|
130
|
-
export interface InvokeResult {
|
|
131
|
-
id: string;
|
|
132
|
-
}
|
|
133
|
-
export interface ListSnapshotsOptions {
|
|
134
|
-
/** Factory slug. Defaults to `"default"`. */
|
|
135
|
-
factorySlug?: string;
|
|
136
|
-
workflow?: string;
|
|
137
|
-
limit?: number;
|
|
138
|
-
/** Cursor returned as `next_cursor` from `listSnapshotsPage`. */
|
|
139
|
-
before?: string;
|
|
140
|
-
}
|
|
141
|
-
export interface TemplateRow {
|
|
142
|
-
name: string;
|
|
143
|
-
version: string;
|
|
144
|
-
factorySlug: string;
|
|
145
|
-
}
|
|
146
|
-
export interface ListTemplatesOptions {
|
|
147
|
-
factorySlug?: string;
|
|
148
|
-
}
|
|
149
|
-
/** A human member of your team — the people an agent (or you) can @-flag. */
|
|
150
|
-
export interface TeamMember {
|
|
151
|
-
/** Membership row id. */
|
|
152
|
-
id: string;
|
|
153
|
-
/** The user id — what you pass to `createMentions({ mentionedUserIds })`. */
|
|
154
|
-
userId: string;
|
|
155
|
-
role: string;
|
|
156
|
-
email: string;
|
|
157
|
-
name: string;
|
|
158
|
-
joinedAt: string;
|
|
159
|
-
}
|
|
160
|
-
/** A "you were flagged" ping, persisted server-side so it reaches the
|
|
161
|
-
* mentioned teammate in their Workbench. */
|
|
162
|
-
export interface Mention {
|
|
163
|
-
id: string;
|
|
164
|
-
factoryId: string;
|
|
165
|
-
mentionedUserId: string;
|
|
166
|
-
/** Who flagged: 'user' | 'api_key' | 'run' | 'system'. */
|
|
167
|
-
actorKind: string;
|
|
168
|
-
actorId: string | null;
|
|
169
|
-
actorLabel: string | null;
|
|
170
|
-
/** Where it lives: 'doc' | 'comment' | 'plan' | 'run'. */
|
|
171
|
-
contextKind: string;
|
|
172
|
-
contextPath: string | null;
|
|
173
|
-
/** Ready-made relative dashboard URL the Workbench card links to. */
|
|
174
|
-
contextUrl: string | null;
|
|
175
|
-
text: string;
|
|
176
|
-
runId: string | null;
|
|
177
|
-
seenAt: string | null;
|
|
178
|
-
resolvedAt: string | null;
|
|
179
|
-
createdAt: string;
|
|
180
|
-
}
|
|
181
|
-
export interface CreateMentionsInput {
|
|
182
|
-
/** Team-member user ids to flag (1–20). Discover them via `listMembers()`.
|
|
183
|
-
* Non-members are dropped server-side. */
|
|
184
|
-
mentionedUserIds: string[];
|
|
185
|
-
/** The flag message shown in the teammate's Workbench. */
|
|
186
|
-
text: string;
|
|
187
|
-
contextKind: "doc" | "comment" | "plan" | "run";
|
|
188
|
-
/** Factory-relative file path or comment thread id, when applicable. */
|
|
189
|
-
contextPath?: string;
|
|
190
|
-
/** Ready-made relative dashboard URL the Workbench card links to (e.g.
|
|
191
|
-
* `/factories/<slug>/files/view?path=<plan>`). */
|
|
192
|
-
contextUrl?: string;
|
|
193
|
-
runId?: string;
|
|
194
|
-
factorySlug?: string;
|
|
195
|
-
}
|
|
196
|
-
export interface CreateFactoryInput {
|
|
197
|
-
slug: string;
|
|
198
|
-
name: string;
|
|
199
|
-
description?: string;
|
|
200
|
-
}
|
|
201
|
-
export interface UpdateFactoryInput {
|
|
202
|
-
name?: string;
|
|
203
|
-
description?: string;
|
|
204
|
-
}
|
|
205
|
-
export interface ScheduleRow {
|
|
206
|
-
id: string;
|
|
207
|
-
name: string;
|
|
208
|
-
workflowName: string;
|
|
209
|
-
cron: string;
|
|
210
|
-
createdAt: string;
|
|
211
|
-
updatedAt: string;
|
|
212
|
-
nextFireAt: string | null;
|
|
213
|
-
lastFireAt: string | null;
|
|
214
|
-
}
|
|
215
|
-
export interface CreateScheduleInput {
|
|
216
|
-
/** Human-friendly schedule name. Unique within the factory. */
|
|
217
|
-
name: string;
|
|
218
|
-
/** The workflow this schedule should fire. Must already be registered
|
|
219
|
-
* in the same factory. */
|
|
220
|
-
workflow: string;
|
|
221
|
-
/** Cron expression (UTC). */
|
|
222
|
-
cron: string;
|
|
223
|
-
/** Factory to attach the schedule to. Defaults to `"default"`. */
|
|
224
|
-
factorySlug?: string;
|
|
225
|
-
}
|
|
226
|
-
export interface SecretOptions {
|
|
227
|
-
factorySlug?: string;
|
|
228
|
-
}
|
|
229
|
-
export interface SetSecretResult {
|
|
230
|
-
key: string;
|
|
231
|
-
}
|
|
232
|
-
export interface SecretListEntry {
|
|
233
|
-
key: string;
|
|
234
|
-
createdAt: string;
|
|
235
|
-
updatedAt: string;
|
|
236
|
-
}
|
|
237
|
-
export interface CreateApiKeyInput {
|
|
238
|
-
name?: string;
|
|
239
|
-
scopes?: string[];
|
|
240
|
-
expiresAt?: string;
|
|
241
|
-
factorySlug?: string;
|
|
242
|
-
}
|
|
243
|
-
export interface StreamRunLogsOptions {
|
|
244
|
-
lastEventId?: number;
|
|
245
|
-
signal?: AbortSignal;
|
|
246
|
-
}
|
|
247
|
-
export interface RunStatus<TOutput = unknown> {
|
|
248
|
-
id: string;
|
|
249
|
-
status: RunState;
|
|
250
|
-
output?: TOutput;
|
|
251
|
-
/** The run's latest (`saveLatest`) snapshot id, populated once the run has
|
|
252
|
-
* succeeded — the boot source to fork this run's evolved filesystem from
|
|
253
|
-
* (pass as `snapshots.bootFrom` on a follow-up invoke). `null` while the run
|
|
254
|
-
* is still in flight or when it captured no snapshot. Lets an orchestrator
|
|
255
|
-
* fork a child straight off the `invokeChild` result without a separate
|
|
256
|
-
* `listRunSnapshots` call. */
|
|
257
|
-
latestSnapshotId?: string | null;
|
|
258
|
-
}
|
|
259
|
-
/** ADR-0006 step 10 — actor record returned on a successful resume.
|
|
260
|
-
* Shape mirrors the server's `PauseResumeActor` type after the row
|
|
261
|
-
* has been stamped. Audit FKs (`userId` / `keyId` / `runId`) may be
|
|
262
|
-
* null when the referenced row was deleted between resume and the
|
|
263
|
-
* response render — the immutable `label` survives. */
|
|
264
|
-
export interface ResumePauseActor {
|
|
265
|
-
kind: "session_user" | "api_key" | "agent";
|
|
266
|
-
/** Better Auth user id when kind='session_user'. */
|
|
267
|
-
userId?: string | null;
|
|
268
|
-
/** api_keys.id when kind='api_key'. */
|
|
269
|
-
keyId?: string | null;
|
|
270
|
-
/** Caller-run id when kind='agent' (NOT the run being resumed). */
|
|
271
|
-
runId?: string | null;
|
|
272
|
-
/** Agent-instance within `runId` when kind='agent'. */
|
|
273
|
-
agentId?: string | null;
|
|
274
|
-
label: string;
|
|
275
|
-
}
|
|
276
|
-
/** Success branch of the resume HTTP response. The pause has reached
|
|
277
|
-
* a terminal state — `resolved` (workflow signal arrived), `expired`
|
|
278
|
-
* (TTL fired first), or `cancelled` (workflow terminated mid-pause).
|
|
279
|
-
* Only `resolved` carries the resume payload the user supplied. */
|
|
280
|
-
export interface ResumePauseSuccess {
|
|
281
|
-
status: "resolved" | "expired" | "cancelled";
|
|
282
|
-
pauseId: string;
|
|
283
|
-
resolvedAt: string | null;
|
|
284
|
-
resumePayload: unknown;
|
|
285
|
-
actor: ResumePauseActor | null;
|
|
286
|
-
}
|
|
287
|
-
/** Pending branch — the workflow accepted the signal but the row
|
|
288
|
-
* flip didn't observe within the route's 5s wait window. The
|
|
289
|
-
* operation is in-flight; retry with the same `Idempotency-Key`
|
|
290
|
-
* and the cache collapses the duplicate to a single canonical
|
|
291
|
-
* response. */
|
|
292
|
-
export interface ResumePausePending {
|
|
293
|
-
status: "pending";
|
|
294
|
-
pauseId: string;
|
|
295
|
-
timedOut: true;
|
|
296
|
-
}
|
|
297
|
-
export type ResumePauseResponse = ResumePauseSuccess | ResumePausePending;
|
|
298
|
-
export interface ResumePauseOptions {
|
|
299
|
-
/** Stripe-style retry-dedup key — same syntax as the workflow-invoke
|
|
300
|
-
* route: 1..255 chars of `[A-Za-z0-9_\-:.]`, no embedded CR/LF.
|
|
301
|
-
* Sent as the `Idempotency-Key` request header. (The server reads the
|
|
302
|
-
* header first, falling back to a body field for callers behind a
|
|
303
|
-
* header-stripping proxy; this client only sends the header.) */
|
|
304
|
-
idempotencyKey?: string;
|
|
305
|
-
/** Abort the HTTP request mid-wait (e.g. from a UI cancel button).
|
|
306
|
-
* The server's LISTEN tears down via the request's AbortSignal. */
|
|
307
|
-
signal?: AbortSignal;
|
|
308
|
-
}
|
|
309
|
-
export interface RequestAgentPauseOptions {
|
|
310
|
-
/** Human-readable note surfaced to the agent as the pause reason. */
|
|
311
|
-
reason?: string;
|
|
312
|
-
/** Your handle for answering this pause without the minted pauseId:
|
|
313
|
-
* pass the same value to `resumePauseByKey`. */
|
|
314
|
-
correlationKey?: string;
|
|
315
|
-
/** Abort the HTTP request. */
|
|
316
|
-
signal?: AbortSignal;
|
|
317
|
-
}
|
|
318
|
-
export interface AnswerSteerOptions extends ResumePauseOptions {
|
|
319
|
-
/** Who answered — surfaced to the agent as `[human steer from <actor>]`. */
|
|
320
|
-
actor?: string;
|
|
321
|
-
}
|
|
322
|
-
/** 202 envelope from a steer-pause request. The request is best-effort and
|
|
323
|
-
* fire-and-forget: it publishes a transient control message and returns
|
|
324
|
-
* immediately — the agent parks at its next iteration boundary (if it is
|
|
325
|
-
* `mode: "hitl"` and still running). Answer it via `answerSteerByKey`
|
|
326
|
-
* (pass the `correlationKey` you set here) or `answerSteer` (by pauseId). */
|
|
327
|
-
export interface RequestAgentPauseResponse {
|
|
328
|
-
status: "steer_requested";
|
|
329
|
-
runId: string;
|
|
330
|
-
agentId: string;
|
|
331
|
-
}
|
|
332
|
-
export interface SendAgentMessageOptions {
|
|
333
|
-
/** Transcript attribution. For non-session callers (API key, orchestrator)
|
|
334
|
-
* this names the sender; defaults to the caller's identity server-side. */
|
|
335
|
-
senderName?: string;
|
|
336
|
-
/** Abort the HTTP request. */
|
|
337
|
-
signal?: AbortSignal;
|
|
338
|
-
}
|
|
339
|
-
/** 202 envelope from a message-to-running-agent request. The message is queued
|
|
340
|
-
* durably and delivered mid-stream as the agent's next user turn — the workflow
|
|
341
|
-
* is NOT paused. `seq` is the message's per-run ordinal. */
|
|
342
|
-
export interface SendAgentMessageResponse {
|
|
343
|
-
status: "message_enqueued";
|
|
344
|
-
runId: string;
|
|
345
|
-
agentId: string;
|
|
346
|
-
seq: number;
|
|
347
|
-
}
|
|
348
|
-
export interface RunDetail<TOutput = unknown> {
|
|
349
|
-
runId: string;
|
|
350
|
-
title: string;
|
|
351
|
-
metadata: Record<string, unknown>;
|
|
352
|
-
outcome: string;
|
|
353
|
-
startedAt: string;
|
|
354
|
-
endedAt: string | null;
|
|
355
|
-
durationMs: number | null;
|
|
356
|
-
failureReason: string | null;
|
|
357
|
-
input: unknown;
|
|
358
|
-
output: TOutput | null;
|
|
359
|
-
lifecycleEvents: Array<{
|
|
360
|
-
at: string;
|
|
361
|
-
type: string;
|
|
362
|
-
payload: unknown;
|
|
363
|
-
}>;
|
|
364
|
-
children?: RunDetail[];
|
|
365
|
-
}
|
|
366
|
-
export interface TimelineEvent {
|
|
367
|
-
kind: string;
|
|
368
|
-
at: string;
|
|
369
|
-
seq: number;
|
|
370
|
-
type: string;
|
|
371
|
-
payload: Record<string, unknown>;
|
|
372
|
-
}
|
|
373
|
-
export type EventSubjectType = "run" | "agent" | "workflow" | "factory";
|
|
374
|
-
export interface EventRow {
|
|
375
|
-
id: string;
|
|
376
|
-
teamId: string;
|
|
377
|
-
subjectType: EventSubjectType | string;
|
|
378
|
-
subjectId: string;
|
|
379
|
-
runId: string | null;
|
|
380
|
-
agentId: string | null;
|
|
381
|
-
workflowId: string | null;
|
|
382
|
-
factoryId: string | null;
|
|
383
|
-
name: string;
|
|
384
|
-
body: unknown;
|
|
385
|
-
summary: string | null;
|
|
386
|
-
confidence: string | null;
|
|
387
|
-
timestamp: string;
|
|
388
|
-
attributes: Record<string, unknown>;
|
|
389
|
-
propagate: boolean;
|
|
390
|
-
idempotencyKey: string | null;
|
|
391
|
-
createdAt: string;
|
|
392
|
-
}
|
|
393
|
-
export interface RunArtifactRow {
|
|
394
|
-
path: string;
|
|
395
|
-
factorySlug: string | null;
|
|
396
|
-
sizeBytes: number | null;
|
|
397
|
-
lastWriteAt: string;
|
|
398
|
-
/** Opening text of the file (≤320 chars) — null for binary/empty. */
|
|
399
|
-
preview: string | null;
|
|
400
|
-
}
|
|
401
|
-
export interface FactoryFileWriteResult {
|
|
402
|
-
path: string;
|
|
403
|
-
contentHash: string;
|
|
404
|
-
sizeBytes: number;
|
|
405
|
-
created: boolean;
|
|
406
|
-
}
|
|
407
|
-
export interface ReportEventInput {
|
|
408
|
-
name: string;
|
|
409
|
-
body: unknown;
|
|
410
|
-
summary?: string;
|
|
411
|
-
confidence?: number;
|
|
412
|
-
timestamp?: string | Date;
|
|
413
|
-
attributes?: Record<string, unknown>;
|
|
414
|
-
propagate?: boolean;
|
|
415
|
-
idempotencyKey?: string;
|
|
416
|
-
}
|
|
417
|
-
export interface ListEventsOptions {
|
|
418
|
-
factorySlug?: string;
|
|
419
|
-
limit?: number;
|
|
420
|
-
/** Case-insensitive substring match. Server uses `ILIKE %name%`, so
|
|
421
|
-
* `"site"` matches `site.created`, `site.failed`, etc. Pass the
|
|
422
|
-
* full event name for an effectively-exact filter (any string is a
|
|
423
|
-
* substring of itself). */
|
|
424
|
-
name?: string;
|
|
425
|
-
/** Date-range lower bound: only include events at or after this
|
|
426
|
-
* timestamp. Used by the dashboard's range toggle (1h / 24h / 7d
|
|
427
|
-
* / 30d). Same semantics as `from` on the runs list endpoint. */
|
|
428
|
-
from?: string;
|
|
429
|
-
/** Timestamp cursor for "load older" pagination. Pass the
|
|
430
|
-
* `timestamp` of the last row from the previous page; the server
|
|
431
|
-
* returns rows strictly older than that. Distinct from `from`:
|
|
432
|
-
* `from` filters a date range, `before` walks the page boundary.
|
|
433
|
-
* Both can be supplied together for a paginated range-query. */
|
|
434
|
-
before?: string;
|
|
435
|
-
}
|
|
436
|
-
export interface ListEventsResult {
|
|
437
|
-
events: EventRow[];
|
|
438
|
-
has_more: boolean;
|
|
439
|
-
}
|
|
440
|
-
/** One captured stdout or stderr line from a run's sandbox subprocess.
|
|
441
|
-
* `id` is per-run monotonically increasing — pass the highest `id`
|
|
442
|
-
* you've seen as `afterId` to paginate forward. */
|
|
443
|
-
export interface RunLogLine {
|
|
444
|
-
id: number;
|
|
445
|
-
at: string;
|
|
446
|
-
stream: "stdout" | "stderr";
|
|
447
|
-
line: string;
|
|
448
|
-
}
|
|
449
|
-
export interface ListRunLogsOptions {
|
|
450
|
-
/** Return only lines with `id > afterId` (forward pagination). */
|
|
451
|
-
afterId?: number;
|
|
452
|
-
/** Max lines (server clamps to [1, 1000], defaults to 200). */
|
|
453
|
-
limit?: number;
|
|
454
|
-
/** Stream direction. `"asc"` (default) returns the oldest lines first
|
|
455
|
-
* — use with `afterId` to paginate forward. `"desc"` returns the newest
|
|
456
|
-
* lines first — use to fetch the last N lines of a finished run. */
|
|
457
|
-
direction?: "asc" | "desc";
|
|
458
|
-
}
|
|
459
|
-
/** Row shape returned by `GET /api-keys`. */
|
|
460
|
-
export interface ApiKey {
|
|
461
|
-
object: "api_key";
|
|
462
|
-
id: string;
|
|
463
|
-
name: string | null;
|
|
464
|
-
last4: string | null;
|
|
465
|
-
scopes: string[];
|
|
466
|
-
teamId: string;
|
|
467
|
-
createdByUserId: string | null;
|
|
468
|
-
/** Non-null when the key is restricted to a single factory. */
|
|
469
|
-
factoryId: string | null;
|
|
470
|
-
createdAt: string;
|
|
471
|
-
expiresAt: string | null;
|
|
472
|
-
lastUsedAt: string | null;
|
|
473
|
-
revokedAt: string | null;
|
|
474
|
-
}
|
|
475
|
-
/** Response from `POST /api-keys`. The `key` field is the plaintext token —
|
|
476
|
-
* shown once at creation, never retrievable again. */
|
|
477
|
-
export interface ApiKeyCreated extends ApiKey {
|
|
478
|
-
key: string;
|
|
479
|
-
}
|
|
480
|
-
/** Single rollup row from `GET /api/v1/usage`. */
|
|
481
|
-
export interface UsageRollupRow {
|
|
482
|
-
eventType: string;
|
|
483
|
-
unit: string;
|
|
484
|
-
total: number;
|
|
485
|
-
tags: Record<string, unknown>;
|
|
486
|
-
}
|
|
487
|
-
/** Response from `GET /api/v1/usage`. */
|
|
488
|
-
export interface UsageResponse {
|
|
489
|
-
object: "list";
|
|
490
|
-
data: UsageRollupRow[];
|
|
491
|
-
has_more: boolean;
|
|
492
|
-
from: string | null;
|
|
493
|
-
to: string | null;
|
|
494
|
-
}
|
|
495
|
-
/** Response from `POST /api/v1/workflows/:id/cancel`. The endpoint is
|
|
496
|
-
* idempotent: cancelling a run that's already terminal returns its current
|
|
497
|
-
* outcome verbatim (rather than throwing or pretending it just canceled),
|
|
498
|
-
* so `status` widens to every terminal value the server might surface. */
|
|
499
|
-
export interface CancelRunResponse {
|
|
500
|
-
runId: string;
|
|
501
|
-
status: "canceled" | "success" | "failed" | "abandoned";
|
|
502
|
-
canceledAt: string;
|
|
503
|
-
}
|
|
504
|
-
export interface SnapshotListEntry {
|
|
505
|
-
snapshotId: string;
|
|
506
|
-
kind: "latest" | "step";
|
|
507
|
-
stepIndex: number | null;
|
|
508
|
-
runId: string;
|
|
509
|
-
workflow: string | null;
|
|
510
|
-
version: string | null;
|
|
511
|
-
createdAt: string | null;
|
|
512
|
-
/** Provider-reported on-disk size, or null when unavailable. */
|
|
513
|
-
sizeBytes: number | null;
|
|
514
|
-
}
|
|
515
|
-
export interface SnapshotListResponse {
|
|
516
|
-
object: "list";
|
|
517
|
-
data: SnapshotListEntry[];
|
|
518
|
-
has_more: boolean;
|
|
519
|
-
next_cursor: string | null;
|
|
520
|
-
}
|
|
521
|
-
export interface RunSnapshotEntry {
|
|
522
|
-
snapshotId: string;
|
|
523
|
-
/** `"latest"` = current/last pointer on the run.
|
|
524
|
-
* `"step"` = retained per-step snapshot. */
|
|
525
|
-
kind: "latest" | "step";
|
|
526
|
-
stepIndex: number | null;
|
|
527
|
-
createdAt: string | null;
|
|
528
|
-
/** Provider-reported on-disk size, or null when unavailable. */
|
|
529
|
-
sizeBytes: number | null;
|
|
530
|
-
}
|
|
14
|
+
import type { ConversationStreamEvent } from "./types/conversation-stream.js";
|
|
15
|
+
import type { InvokeWorkflowOptions, InvokeAndWaitOptions, InvokeResult, StreamRunLogsOptions, RunStatus, ResumePauseOptions, ResumePauseResponse, AnswerSteerOptions, RequestAgentPauseOptions, RequestAgentPauseResponse, SendAgentMessageOptions, SendAgentMessageResponse, RunDetail, RunListEntry, ListRunsOptions, TimelineEvent, RunFundingResponse, EventRow, ReportEventInput, ListEventsOptions, ListEventsResult, RunArtifactRow, RunLogLine, ListRunLogsOptions, CancelRunResponse, ListSnapshotsOptions, SnapshotListResponse, SnapshotListEntry, RunSnapshotEntry } from "./types/api-runs.js";
|
|
16
|
+
import type { TeamMember, Mention, CreateMentionsInput, ConversationsPage, SessionsPage, ConversationDetail, ConversationThread, CreateCloudSessionInput, CloudSessionCreated, SessionPreview, PreviewOpened, OpenPreviewInput, SessionForked, SessionChangeSet, SessionMergeReport, SessionDiscardReport, SendConversationMessageInput, SendConversationMessageResult, ChannelSessionRow, SessionChannelMessagePosted, ConversationPresenceSnapshot, StreamConversationOptions, AgentListRow } from "./types/api-conversations.js";
|
|
17
|
+
import type { ConversationMemberRole, ConversationMember, ArtifactScope, SetScopeGrantsInput, SetTemplateScopeInput } from "./types/api-scopes.js";
|
|
18
|
+
import type { Project, ProjectsPage, ProjectRole, ProjectMember, ProjectObjectsPage, ProjectAddPreview, AddProjectObjectInput, AddProjectObjectResult, RefreshProjectObjectResult } from "./types/api-projects.js";
|
|
19
|
+
import type { RegisterResult, RegisterWorkflowInput, TemplateRow, TemplateDetail, ListTemplatesOptions, SearchFactoryFilesOptions, FactoryFileSearchResult, FactoryFileWriteResult, FactoryRow, CreateFactoryInput, UpdateFactoryInput, ScheduleRow, CreateScheduleInput, SecretOptions, SetSecretResult, SecretListEntry, CreateApiKeyInput, ApiKey, ApiKeyCreated, UsageResponse, DriveRepoLink, CreateDriveRepoLinkInput } from "./types/api-factory.js";
|
|
20
|
+
import type { ComplianceSession, RequestComplianceSessionInput, ListComplianceSessionsOptions, ComplianceSessionsPage, ListComplianceAccessesOptions, ComplianceAccessesPage } from "./types/api-compliance.js";
|
|
21
|
+
export type { RunState, InvokeWorkflowOptions, InvokeAndWaitOptions, InvokeResult, StreamRunLogsOptions, RunStatus, ResumePauseActor, ResumePauseSuccess, ResumePausePending, ResumePauseResponse, ResumePauseOptions, RequestAgentPauseOptions, AnswerSteerOptions, RequestAgentPauseResponse, SendAgentMessageOptions, SendAgentMessageResponse, RunDetail, RunListEntry, ListRunsOptions, TimelineEvent, FundingLane, RunFundingStamp, RunFundingUsageRow, RunFundingResponse, EventSubjectType, EventRow, RunArtifactRow, ReportEventInput, ListEventsOptions, ListEventsResult, RunLogLine, ListRunLogsOptions, CancelRunResponse, ListSnapshotsOptions, SnapshotListEntry, SnapshotListResponse, RunSnapshotEntry, } from "./types/api-runs.js";
|
|
22
|
+
export type { TeamMember, Mention, CreateMentionsInput, ConversationMessagePart, ConversationRow, ConversationMessageRow, ConversationsPage, SessionsPage, ConversationDetail, CreateCloudSessionInput, CloudSessionCreated, ConversationThread, SessionPreview, PreviewOpened, OpenPreviewInput, SessionForked, SessionFileChange, SessionChangeSet, SessionMergeReportDetail, SessionMergeReport, SessionDiscardReport, ConversationPageContext, SendConversationMessageInput, ConversationTurnState, SendConversationMessageResult, ConversationPresenceSnapshot, AgentListRow, StreamConversationOptions, ChannelSessionStatus, ChannelSessionRow, ChannelSessionsResponse, SessionChannelMessagePosted, } from "./types/api-conversations.js";
|
|
23
|
+
export type { ConversationMemberRole, ConversationMember, DocumentCapability, TemplateCapability, ScopeGrant, ArtifactScope, RunContext, SetScopeGrantsInput, SetTemplateScopeInput, } from "./types/api-scopes.js";
|
|
24
|
+
export type { Project, ProjectsPage, ProjectRole, ProjectMember, ProjectObject, ProjectObjectsPage, ProjectSkippedFile, ProjectPreviewFile, ProjectAddPreview, AddProjectObjectInput, AddProjectObjectResult, RefreshProjectObjectResult, } from "./types/api-projects.js";
|
|
25
|
+
export type { RegisterResult, RegisteredRuntime, RuntimeSourceInput, TemplateSourceRef, RegisterWorkflowInput, TemplateRow, TemplateDetail, ListTemplatesOptions, FactoryFileSearchRow, FactoryFolderSearchRow, SearchFactoryFilesOptions, FactoryFileSearchResult, FactoryFileWriteResult, PublicFileLinkState, FactoryRow, CreateFactoryInput, UpdateFactoryInput, ScheduleRow, CreateScheduleInput, SecretOptions, SetSecretResult, SecretListEntry, CreateApiKeyInput, ApiKey, ApiKeyCreated, UsageRollupRow, UsageResponse, DriveRepoLink, CreateDriveRepoLinkInput, } from "./types/api-factory.js";
|
|
26
|
+
export type { ComplianceScopeKind, ComplianceStatus, ComplianceSession, ComplianceAccess, RequestComplianceSessionInput, ListComplianceSessionsOptions, ComplianceSessionsPage, ListComplianceAccessesOptions, ComplianceAccessesPage, } from "./types/api-compliance.js";
|
|
531
27
|
export interface AgentComposeClientOptions {
|
|
532
28
|
/** Your team's API key — minted from the dashboard or `agentc keys create`.
|
|
533
29
|
* Required. Resolved from `process.env.AGENT_COMPOSE_API_KEY` when omitted. */
|
|
@@ -543,6 +39,13 @@ export declare class AgentComposeClient {
|
|
|
543
39
|
private readonly baseUrl;
|
|
544
40
|
private readonly apiKey;
|
|
545
41
|
constructor(options?: AgentComposeClientOptions);
|
|
42
|
+
/** Open an authenticated SSE stream and yield its parsed frames. Uses raw
|
|
43
|
+
* `fetch` (not ofetch) because SSE requires access to the response's
|
|
44
|
+
* `ReadableStream`, which ofetch consumes when parsing. Auth + base URL
|
|
45
|
+
* come from the same constructor inputs, and non-2xx responses throw the
|
|
46
|
+
* same `AgentComposeError`. Shared by `streamRunLogs` / `streamConversation`
|
|
47
|
+
* — per-event mapping stays at each call site. */
|
|
48
|
+
private openSseStream;
|
|
546
49
|
/** Register (or update) a workflow template inside a factory. Defaults to
|
|
547
50
|
* the team's `default` factory when `factorySlug` is omitted. */
|
|
548
51
|
register(payload: RegisterWorkflowInput): Promise<RegisterResult>;
|
|
@@ -658,11 +161,21 @@ export declare class AgentComposeClient {
|
|
|
658
161
|
sendAgentMessage(runId: string, agentId: string, message: string, opts?: SendAgentMessageOptions): Promise<SendAgentMessageResponse>;
|
|
659
162
|
/** Full run detail, including input/output and lifecycle events. */
|
|
660
163
|
getRun<TOutput = unknown>(runId: string): Promise<RunDetail<TOutput>>;
|
|
164
|
+
/** Recent runs in one factory, newest first by default. Bounded at the
|
|
165
|
+
* server (limit ≤ 200). `workflow` filters by the registered workflow
|
|
166
|
+
* name (substring) — `listRuns({ workflow: "report", limit: 1 })` is
|
|
167
|
+
* "the latest report run". */
|
|
168
|
+
listRuns(opts?: ListRunsOptions): Promise<RunListEntry[]>;
|
|
661
169
|
/** Ordered lifecycle timeline for one run. */
|
|
662
170
|
getRunTimeline(runId: string, opts?: {
|
|
663
171
|
limit?: number;
|
|
664
172
|
offset?: number;
|
|
665
173
|
}): Promise<TimelineEvent[]>;
|
|
174
|
+
/** One run's funding-lane surface (ADR-0048): per-step credential stamps
|
|
175
|
+
* recorded at resolution, plus the gateway-attested platform dollars —
|
|
176
|
+
* the only usage the ledger records (non-platform lanes are attribution,
|
|
177
|
+
* never metered). */
|
|
178
|
+
getRunFunding(runId: string): Promise<RunFundingResponse>;
|
|
666
179
|
/** Report a durable event against a run. Events are late-binding facts
|
|
667
180
|
* like quality.accepted, defect.regression, or intervention.override. */
|
|
668
181
|
reportEvent(runId: string, input: ReportEventInput): Promise<EventRow>;
|
|
@@ -675,11 +188,191 @@ export declare class AgentComposeClient {
|
|
|
675
188
|
factorySlug?: string;
|
|
676
189
|
contentType?: string;
|
|
677
190
|
}): Promise<FactoryFileWriteResult>;
|
|
678
|
-
/** Read one file's current content (or a specific revision) as
|
|
191
|
+
/** Read one file's current content (or a specific revision) as RAW BYTES —
|
|
192
|
+
* byte-exact for any content type. This is the wire truth; `getFactoryFile`
|
|
193
|
+
* is a UTF-8 decode over it. Binaries (images, archives) MUST come through
|
|
194
|
+
* here: a text decode is lossy (every non-UTF-8 sequence collapses to
|
|
195
|
+
* U+FFFD and the original bytes are unrecoverable). */
|
|
196
|
+
getFactoryFileBytes(path: string, opts?: {
|
|
197
|
+
factorySlug?: string;
|
|
198
|
+
revision?: number;
|
|
199
|
+
}): Promise<Uint8Array>;
|
|
200
|
+
/** Read one file's current content (or a specific revision) as text
|
|
201
|
+
* (UTF-8). For binary files use `getFactoryFileBytes` — decoding them to
|
|
202
|
+
* text corrupts the bytes irreversibly. */
|
|
679
203
|
getFactoryFile(path: string, opts?: {
|
|
680
204
|
factorySlug?: string;
|
|
681
205
|
revision?: number;
|
|
682
206
|
}): Promise<string>;
|
|
207
|
+
/** List conversations the caller can access, newest-activity first.
|
|
208
|
+
* Cursor-paginated: pass the previous page's `next_cursor`. */
|
|
209
|
+
listConversations(opts?: {
|
|
210
|
+
cursor?: string;
|
|
211
|
+
}): Promise<ConversationsPage>;
|
|
212
|
+
/** List the sessions the caller can ACCESS in one factory (their own +
|
|
213
|
+
* shared/project-reachable ones), newest first (kind='session' rows are
|
|
214
|
+
* excluded from listConversations by design). Session or user-bound driver credential only. */
|
|
215
|
+
listSessions(factoryId: string, opts?: {
|
|
216
|
+
cursor?: string;
|
|
217
|
+
}): Promise<SessionsPage>;
|
|
218
|
+
/** One conversation with its latest page of messages. */
|
|
219
|
+
getConversation(id: string): Promise<ConversationDetail>;
|
|
220
|
+
/** Provision a CLOUD-native session (ADR-0037 Phase 3b / ADR-0055 §9): a
|
|
221
|
+
* persistent server-side sandbox on the factory drive that keeps working
|
|
222
|
+
* after the caller's terminal (and laptop) closes. The session's TYPE is
|
|
223
|
+
* fixed at creation: `chat` hosts a coding runtime driven via ACP (open →
|
|
224
|
+
* the transcript, drive it like any conversation); `terminal`/`custom`
|
|
225
|
+
* are raw machine surfaces with no chat pane (open → the PTY). Omitting
|
|
226
|
+
* `type` lets the server derive it from `runtime` (the older-caller
|
|
227
|
+
* grandfather); send it explicitly. Requires the `invoke` scope and a
|
|
228
|
+
* user-bound credential. */
|
|
229
|
+
createCloudSession(input: CreateCloudSessionInput): Promise<CloudSessionCreated>;
|
|
230
|
+
/** One thread (root + replies, oldest→newest) inside a channel. */
|
|
231
|
+
getConversationThread(conversationId: string, rootId: string): Promise<ConversationThread>;
|
|
232
|
+
/** The sessions attached to a channel, newest attach first, each with its
|
|
233
|
+
* durable rail status (channel read gate). 404 on non-channels. */
|
|
234
|
+
listChannelSessions(channelId: string): Promise<ChannelSessionRow[]>;
|
|
235
|
+
/** Attach an existing session to a channel — an explicit share act
|
|
236
|
+
* (ADR-0052 consent): only the session's CREATOR may attach it, with
|
|
237
|
+
* channel role ≥ write and a human credential. Idempotent (re-attach is
|
|
238
|
+
* a no-op). Failures: 403 `human_credential_required` | `role_read_only`
|
|
239
|
+
* | `owner_required`; 400 `not_a_session`; 409 `attach_limit_reached`. */
|
|
240
|
+
attachChannelSession(channelId: string, sessionConversationId: string): Promise<void>;
|
|
241
|
+
/** Detach a session from a channel — either side ends the visit (channel
|
|
242
|
+
* role ≥ write, OR the session's creator). Forward-only: the channel's
|
|
243
|
+
* members lose the derived access; relay rows already in the session
|
|
244
|
+
* transcript stay; explicit shares survive. 404 when not attached. */
|
|
245
|
+
detachChannelSession(channelId: string, sessionConversationId: string): Promise<void>;
|
|
246
|
+
/** Post one message into a channel AS the calling session (ADR-0057 Seam
|
|
247
|
+
* 4) — progress, results, questions, attributed to the session (title +
|
|
248
|
+
* runtime mark). Session toolbelt credential ONLY (the calling session
|
|
249
|
+
* resolves from the key server-side — 403 `session_credential_required`
|
|
250
|
+
* otherwise); the session must be attached (409 `not_attached`). By
|
|
251
|
+
* default the post lands in the thread of the message that last
|
|
252
|
+
* addressed the session from that channel (the room when none);
|
|
253
|
+
* `threadRootId` overrides it — must be a root message in the channel
|
|
254
|
+
* (400 `invalid_thread_root`). The post never triggers any turn. */
|
|
255
|
+
postSessionChannelMessage(channelId: string, input: {
|
|
256
|
+
text: string;
|
|
257
|
+
threadRootId?: string;
|
|
258
|
+
}): Promise<SessionChannelMessagePosted>;
|
|
259
|
+
/** Open a dev preview on a cloud session: expose a port a dev server is
|
|
260
|
+
* LISTENING on inside the session sandbox at a member-gated proxy URL, and
|
|
261
|
+
* post an "Open preview" card to the transcript. Resumes a suspended VM
|
|
262
|
+
* (write-tier act — read members get 403). Returns the row + the proxy URL
|
|
263
|
+
* (never the raw sandbox host). */
|
|
264
|
+
openPreview(conversationId: string, input: OpenPreviewInput): Promise<PreviewOpened>;
|
|
265
|
+
/** The live dev previews on a cloud session (read-tier allowed). Rows carry
|
|
266
|
+
* `url: null` — a URL is minted on OPEN (short-lived, member-bound). */
|
|
267
|
+
listPreviews(conversationId: string): Promise<SessionPreview[]>;
|
|
268
|
+
/** Take a dev preview down (write-tier). Idempotent — `closed` is false when
|
|
269
|
+
* no active row matched. */
|
|
270
|
+
closePreview(conversationId: string, port: number): Promise<boolean>;
|
|
271
|
+
/** Fork a cloud session from HEAD: snapshot the VM + branch the drive + seed
|
|
272
|
+
* a new conversation from the transcript so far, booting from both. Returns
|
|
273
|
+
* the child conversation id to switch to. Write-tier; "Branch from here." */
|
|
274
|
+
forkSession(conversationId: string, input?: {
|
|
275
|
+
title?: string;
|
|
276
|
+
}): Promise<SessionForked>;
|
|
277
|
+
/** The session's proposed change set: files changed on its drive branch
|
|
278
|
+
* since it forked from `main` (read-tier — any conversation member).
|
|
279
|
+
* `state: "unbranched"` means the session predates branching and still
|
|
280
|
+
* writes `main` directly. The list reflects the branch's last flush and
|
|
281
|
+
* is advisory; a merge re-verifies against fresh state. 404 = not found
|
|
282
|
+
* or not a member (uniform). */
|
|
283
|
+
getSessionChanges(conversationId: string): Promise<SessionChangeSet>;
|
|
284
|
+
/** Approve the session's proposed changes: 3-way merge its branch into
|
|
285
|
+
* `main`, then continue the session on a fresh branch off post-merge
|
|
286
|
+
* `main`. Write-tier + human caller. Pass `opts.branch` (the branch you
|
|
287
|
+
* reviewed) to fail 409 `branch_changed` if it moved since.
|
|
288
|
+
*
|
|
289
|
+
* Failures: 403 `role_read_only` (read-only member) or a plain 403 for
|
|
290
|
+
* session toolbelt keys (agents cannot self-approve); 409 `turn_active`
|
|
291
|
+
* (a turn is running — retry when idle) | `branch_changed`; 400
|
|
292
|
+
* `no_branch` (session predates branching); 502 `quiesce_failed`
|
|
293
|
+
* (nothing changed — safe to retry) | `merge_failed` (branch retained,
|
|
294
|
+
* named in the body) | `rebranch_failed` (merge landed; retry safe). */
|
|
295
|
+
mergeSessionChanges(conversationId: string, opts?: {
|
|
296
|
+
branch?: string;
|
|
297
|
+
}): Promise<SessionMergeReport>;
|
|
298
|
+
/** Reject the session's proposed changes: abandon its branch (retained
|
|
299
|
+
* dormant, never deleted — an admin re-merge can recover a mistaken
|
|
300
|
+
* discard) and continue the session on a fresh branch off `main`.
|
|
301
|
+
* Write-tier + human caller; same 4xx/5xx contract as
|
|
302
|
+
* `mergeSessionChanges` minus the merge-step failures. */
|
|
303
|
+
discardSessionChanges(conversationId: string, opts?: {
|
|
304
|
+
branch?: string;
|
|
305
|
+
}): Promise<SessionDiscardReport>;
|
|
306
|
+
/** The conversation's member roster with roles. Solo conversations
|
|
307
|
+
* return an empty roster; a dm returns the pair. */
|
|
308
|
+
getConversationMembers(conversationId: string): Promise<ConversationMember[]>;
|
|
309
|
+
/** Invite members to a channel (requires `write` role). Per-invitee
|
|
310
|
+
* `role` is `'write'` (default) or `'read'` — `'owner'` is rejected
|
|
311
|
+
* with 400. Non-team userIds are dropped server-side. */
|
|
312
|
+
addConversationMembers(conversationId: string, members: Array<{
|
|
313
|
+
userId: string;
|
|
314
|
+
role?: "write" | "read";
|
|
315
|
+
}>): Promise<ConversationMember[]>;
|
|
316
|
+
/** Remove a member (conversation `owner` or team admin only).
|
|
317
|
+
* Throws 400 `last_owner` when the target is the roster's last owner. */
|
|
318
|
+
removeConversationMember(conversationId: string, userId: string): Promise<ConversationMember[]>;
|
|
319
|
+
/** Change a member's role (conversation `owner` or team admin only).
|
|
320
|
+
* Throws 400 `last_owner` when demoting the roster's last owner. */
|
|
321
|
+
setConversationMemberRole(conversationId: string, userId: string, role: ConversationMemberRole): Promise<ConversationMember[]>;
|
|
322
|
+
/** Send one message into a conversation. The message persists and fans
|
|
323
|
+
* out before this resolves; the response carries the server's
|
|
324
|
+
* authoritative turn verdict (`turnState`, ADR-0037 §4) — `queued` means
|
|
325
|
+
* a turn is already in flight and a coalesced follow-up will answer, not
|
|
326
|
+
* an error. Requires the `invoke` scope. */
|
|
327
|
+
sendConversationMessage(conversationId: string, input: SendConversationMessageInput): Promise<SendConversationMessageResult>;
|
|
328
|
+
/** Pre-warm a CLOUD session's sandbox (ADR-0040 §6): resumes the
|
|
329
|
+
* suspended VM without running a turn, so the resume latency rides the
|
|
330
|
+
* attach/focus gap instead of the first reply. Plain no-op
|
|
331
|
+
* (`warming: false`) for local/platform sessions; rate-limited
|
|
332
|
+
* server-side per session. Fire-and-forget by design — never block a
|
|
333
|
+
* surface on it. Requires the `invoke` scope. */
|
|
334
|
+
prewarmConversation(conversationId: string): Promise<{
|
|
335
|
+
warming: boolean;
|
|
336
|
+
rateLimited?: boolean;
|
|
337
|
+
}>;
|
|
338
|
+
/** Stop the conversation's LIVE agent turn (ADR-0037 §5). Conversation-
|
|
339
|
+
* scoped, not surface-scoped: any member can cancel, whichever surface
|
|
340
|
+
* started the turn. The canceled turn closes with a terminal error part
|
|
341
|
+
* (it is never re-run); a message sent after it stays queued and is
|
|
342
|
+
* answered next. `canceled: false` = nothing was in flight. Requires
|
|
343
|
+
* the `invoke` scope. */
|
|
344
|
+
cancelConversationTurn(conversationId: string): Promise<{
|
|
345
|
+
canceled: boolean;
|
|
346
|
+
}>;
|
|
347
|
+
/** Announce this client as ATTACHED to a conversation (ADR-0037 §6) —
|
|
348
|
+
* beat every ~30s while a surface shows the transcript. Each beat fans
|
|
349
|
+
* out one live-only `presence` event to every stream subscriber (the
|
|
350
|
+
* roster assembles client-side, keyed by `clientId`) and returns a
|
|
351
|
+
* fresh agent-liveness snapshot. Member-gated like the stream; no
|
|
352
|
+
* scope beyond conversation access — presence is a read-side beacon. */
|
|
353
|
+
heartbeatConversationPresence(conversationId: string, input: {
|
|
354
|
+
clientId: string;
|
|
355
|
+
surface: "dashboard" | "terminal";
|
|
356
|
+
}): Promise<ConversationPresenceSnapshot>;
|
|
357
|
+
/** Subscribe to a conversation's SSE stream as an async iterable of
|
|
358
|
+
* typed events, with two conversation-specific rules the consumer must
|
|
359
|
+
* uphold:
|
|
360
|
+
*
|
|
361
|
+
* - advance `lastEventId` ONLY from events that carry `id` (durable
|
|
362
|
+
* rows) — never from `part_partial` / `turn_state` / `presence`,
|
|
363
|
+
* which are live-only and would corrupt reconnect replay;
|
|
364
|
+
* - a conversation never "completes": the generator ends on the
|
|
365
|
+
* server's bounded-replay batch boundary (`replay.continue` — pass
|
|
366
|
+
* its `nextAfterSeq` back as `lastEventId` and reconnect at once) or
|
|
367
|
+
* its 2h stream lifetime. Callers loop with their tracked id. */
|
|
368
|
+
streamConversation(conversationId: string, opts?: StreamConversationOptions): AsyncGenerator<ConversationStreamEvent>;
|
|
369
|
+
/** List the team's agents (platform operators + local bridge agents).
|
|
370
|
+
* Bridge rows carry live presence (`online`) and the hosting machine's
|
|
371
|
+
* label — what the terminal/dashboard presence dots render from. */
|
|
372
|
+
listAgents(): Promise<AgentListRow[]>;
|
|
373
|
+
/** Search a factory drive's live files — path substring OR full-text match
|
|
374
|
+
* on extracted content. Cursor-paginated by path. */
|
|
375
|
+
searchFactoryFiles(query: string, opts?: SearchFactoryFilesOptions): Promise<FactoryFileSearchResult>;
|
|
683
376
|
/** List the human members of your team — the people you (or an agent) can
|
|
684
377
|
* @-flag with `createMentions`. Each row's `userId` is what
|
|
685
378
|
* `mentionedUserIds` expects. */
|
|
@@ -708,6 +401,96 @@ export declare class AgentComposeClient {
|
|
|
708
401
|
* `factorySlug` so callers can route per-template actions to the right
|
|
709
402
|
* factory. */
|
|
710
403
|
listTemplates(opts?: ListTemplatesOptions): Promise<TemplateRow[]>;
|
|
404
|
+
/** One template's detail (registration metadata + share scope). Falls
|
|
405
|
+
* back to the published registry for platform templates. */
|
|
406
|
+
getTemplate(name: string, opts?: {
|
|
407
|
+
factorySlug?: string;
|
|
408
|
+
}): Promise<TemplateDetail>;
|
|
409
|
+
/** Full-replace a template's share grants; optionally bind/unbind its
|
|
410
|
+
* owning conversation. Capabilities: `read|write|invoke|see_runs`. */
|
|
411
|
+
setTemplateScope(name: string, input: SetTemplateScopeInput, opts?: {
|
|
412
|
+
factorySlug?: string;
|
|
413
|
+
}): Promise<{
|
|
414
|
+
scope: ArtifactScope;
|
|
415
|
+
}>;
|
|
416
|
+
/** Full-replace a drive file's share grants. Capabilities: `read|write`. */
|
|
417
|
+
setFileScope(path: string, input: SetScopeGrantsInput, opts?: {
|
|
418
|
+
factorySlug?: string;
|
|
419
|
+
}): Promise<{
|
|
420
|
+
scope: ArtifactScope;
|
|
421
|
+
}>;
|
|
422
|
+
/** Share a drive file WITH a cloud session — the session becomes a grantee
|
|
423
|
+
* and the file appears in its fsgw mount. Fixed capabilities: the mount is
|
|
424
|
+
* concealment-only, so the session can read AND edit the file. Requires the
|
|
425
|
+
* `share` capability on the file (its owner or a team admin). The target
|
|
426
|
+
* must be a CLOUD session (local sessions never mount fsgw → 400
|
|
427
|
+
* `cloud_session_required`). No capabilities argument — semantics are fixed
|
|
428
|
+
* "open and edit". */
|
|
429
|
+
shareFileWithSession(factorySlug: string, input: {
|
|
430
|
+
path: string;
|
|
431
|
+
conversationId: string;
|
|
432
|
+
}): Promise<void>;
|
|
433
|
+
/** Revoke a file's share to a session (revocation-critical — re-conceals on
|
|
434
|
+
* the session's live mount within push latency). Idempotent. */
|
|
435
|
+
unshareFileWithSession(factorySlug: string, input: {
|
|
436
|
+
path: string;
|
|
437
|
+
conversationId: string;
|
|
438
|
+
}): Promise<void>;
|
|
439
|
+
/** List the projects the caller is a member of, newest-activity first.
|
|
440
|
+
* Cursor-paginated. A creator who has left sees nothing (no implicit
|
|
441
|
+
* creator authority) — membership is the sole gate. */
|
|
442
|
+
listProjects(opts?: {
|
|
443
|
+
cursor?: string;
|
|
444
|
+
}): Promise<ProjectsPage>;
|
|
445
|
+
/** Create a project. The caller is seeded as its first `owner` member. 409
|
|
446
|
+
* on a duplicate name within the team. */
|
|
447
|
+
createProject(name: string): Promise<Project>;
|
|
448
|
+
/** One project (with the caller's role + member/object counts). 404 when
|
|
449
|
+
* the caller is not a member. */
|
|
450
|
+
getProject(id: string): Promise<Project>;
|
|
451
|
+
/** Rename a project (requires `write` role). */
|
|
452
|
+
renameProject(id: string, name: string): Promise<Project>;
|
|
453
|
+
/** Delete a project (owner or team admin). Revokes every derived grant. */
|
|
454
|
+
deleteProject(id: string): Promise<void>;
|
|
455
|
+
/** The project's member roster with roles (member only). */
|
|
456
|
+
getProjectMembers(id: string): Promise<ProjectMember[]>;
|
|
457
|
+
/** Invite members (requires `write` role). Per-invitee `role` is `'write'`
|
|
458
|
+
* (default) or `'read'` — `'owner'` is never grantable at invite. Non-team
|
|
459
|
+
* userIds are dropped server-side; the full refreshed roster is returned. */
|
|
460
|
+
addProjectMembers(id: string, members: Array<{
|
|
461
|
+
userId: string;
|
|
462
|
+
role?: "write" | "read";
|
|
463
|
+
}>): Promise<ProjectMember[]>;
|
|
464
|
+
/** Remove a member — project owner/team admin, or self-leave. Throws 400
|
|
465
|
+
* `last_owner` when the target is the roster's last owner. */
|
|
466
|
+
removeProjectMember(id: string, userId: string): Promise<ProjectMember[]>;
|
|
467
|
+
/** Change a member's role (project owner or team admin). Throws 400
|
|
468
|
+
* `last_owner` when demoting the roster's last owner. */
|
|
469
|
+
setProjectMemberRole(id: string, userId: string, role: ProjectRole): Promise<ProjectMember[]>;
|
|
470
|
+
/** List a project's objects (member only), newest first. Cursor-paginated. */
|
|
471
|
+
listProjectObjects(id: string, opts?: {
|
|
472
|
+
cursor?: string;
|
|
473
|
+
}): Promise<ProjectObjectsPage>;
|
|
474
|
+
/** DRY-RUN preview of a session add: the files that WOULD be shared (from
|
|
475
|
+
* the caller's owned scopes) + any owned-but-skipped entries (paths
|
|
476
|
+
* concealed from the caller are omitted). Powers the consent dialog. Same
|
|
477
|
+
* gates as the add, but mutates nothing. */
|
|
478
|
+
previewProjectObject(id: string, input: {
|
|
479
|
+
conversationId: string;
|
|
480
|
+
}): Promise<ProjectAddPreview>;
|
|
481
|
+
/** Add an object to a project (requires `write` role AND authority on the
|
|
482
|
+
* object itself). A session add also materializes the caller-owned files in
|
|
483
|
+
* the session's context, returning them alongside the session object. */
|
|
484
|
+
addProjectObject(id: string, input: AddProjectObjectInput): Promise<AddProjectObjectResult>;
|
|
485
|
+
/** Re-materialize a session object's file context (add-only — never removes;
|
|
486
|
+
* picks up files scoped/created after the original add). Session objects
|
|
487
|
+
* only; caller must be the session owner and a project writer. */
|
|
488
|
+
refreshProjectObject(id: string, objectId: string): Promise<RefreshProjectObjectResult>;
|
|
489
|
+
/** Remove an object from a project (revocation-critical). Authorized for a
|
|
490
|
+
* project writer, the member who added it, OR — for a file object — the
|
|
491
|
+
* file's owner even without project membership (share implies unshare).
|
|
492
|
+
* Unauthorized → 404. */
|
|
493
|
+
removeProjectObject(id: string, objectId: string): Promise<void>;
|
|
711
494
|
/** List factories for the caller's team. */
|
|
712
495
|
listFactories(): Promise<FactoryRow[]>;
|
|
713
496
|
/** Create a factory. `slug` must be lowercase kebab-case and unique
|
|
@@ -737,10 +520,27 @@ export declare class AgentComposeClient {
|
|
|
737
520
|
deleteSchedule(id: string, factorySlug?: string): Promise<void>;
|
|
738
521
|
/** Create or update a workflow secret. Value is stored in GCP Secret Manager. */
|
|
739
522
|
setSecret(workflowName: string, key: string, value: string, opts?: SecretOptions): Promise<SetSecretResult>;
|
|
523
|
+
/** Both secret tiers list the same `{ secrets }` envelope — fetch + map the
|
|
524
|
+
* wire's `secretKey` to `SecretListEntry.key`. */
|
|
525
|
+
private listSecretEntries;
|
|
740
526
|
/** List secret keys registered for a workflow (metadata only — values are never returned). */
|
|
741
527
|
listSecrets(workflowName: string, opts?: SecretOptions): Promise<SecretListEntry[]>;
|
|
742
528
|
/** Delete a workflow secret. */
|
|
743
529
|
deleteSecret(workflowName: string, key: string, opts?: SecretOptions): Promise<void>;
|
|
530
|
+
/** List a factory's drive⇄repo links. */
|
|
531
|
+
listRepoLinks(opts?: {
|
|
532
|
+
factorySlug?: string;
|
|
533
|
+
}): Promise<DriveRepoLink[]>;
|
|
534
|
+
/** Link a drive directory to a GitHub repo + tracked branch (`manage`
|
|
535
|
+
* scope). Requires the drive to be graph-authoritative — 409 names the
|
|
536
|
+
* promotion prerequisite otherwise. */
|
|
537
|
+
createRepoLink(input: CreateDriveRepoLinkInput, opts?: {
|
|
538
|
+
factorySlug?: string;
|
|
539
|
+
}): Promise<DriveRepoLink>;
|
|
540
|
+
/** Unlink (§6.3: the prefix's files and history stay on the drive). */
|
|
541
|
+
deleteRepoLink(linkId: string, opts?: {
|
|
542
|
+
factorySlug?: string;
|
|
543
|
+
}): Promise<void>;
|
|
744
544
|
/** Create or update a factory-level secret. */
|
|
745
545
|
setFactorySecret(key: string, value: string, opts?: SecretOptions): Promise<SetSecretResult>;
|
|
746
546
|
/** List factory-level secret keys (metadata only — values are never returned). */
|
|
@@ -762,6 +562,25 @@ export declare class AgentComposeClient {
|
|
|
762
562
|
* run returns the current state without throwing. The server stamps the
|
|
763
563
|
* run as `canceled` and kills any live sandboxes. */
|
|
764
564
|
cancelRun(runId: string): Promise<CancelRunResponse>;
|
|
565
|
+
/** Request a break-glass compliance session — returns it `pending` until a
|
|
566
|
+
* team owner (≠ requester) approves. `scopeRef` is the factory id for
|
|
567
|
+
* factory scope; omit it for team scope. `ttlSeconds` is the session's
|
|
568
|
+
* lifetime once approved (15 min floor, 7 day ceiling). */
|
|
569
|
+
requestComplianceSession(input: RequestComplianceSessionInput): Promise<ComplianceSession>;
|
|
570
|
+
/** Approve a pending compliance session → active with its TTL. The caller
|
|
571
|
+
* must be a team owner ≠ the requester (or, when the requester is the sole
|
|
572
|
+
* owner, any admin ≠ requester). Throws 403 on self-approval or wrong role,
|
|
573
|
+
* 409 when the session is no longer pending. */
|
|
574
|
+
approveComplianceSession(sessionId: string): Promise<ComplianceSession>;
|
|
575
|
+
/** Revoke a pending or active compliance session — revocation always
|
|
576
|
+
* tightens, so any team owner/admin may do it. */
|
|
577
|
+
revokeComplianceSession(sessionId: string): Promise<ComplianceSession>;
|
|
578
|
+
/** List the team's compliance sessions, newest first. Optional `status`
|
|
579
|
+
* filter; opaque `cursor` pagination. */
|
|
580
|
+
listComplianceSessions(opts?: ListComplianceSessionsOptions): Promise<ComplianceSessionsPage>;
|
|
581
|
+
/** The documents touched under one compliance session — the individual
|
|
582
|
+
* per-document audit trail its reasoned entry authorized. */
|
|
583
|
+
listComplianceAccesses(sessionId: string, opts?: ListComplianceAccessesOptions): Promise<ComplianceAccessesPage>;
|
|
765
584
|
/** Stream lifecycle events for a run as an async iterable. Yields parsed
|
|
766
585
|
* `RunEvent` payloads in order; caller breaks on terminal events
|
|
767
586
|
* (`run_complete`, `run_failed`, `run_canceled`).
|
|
@@ -769,21 +588,6 @@ export declare class AgentComposeClient {
|
|
|
769
588
|
* `lastEventId` enables resume — pass the highest `seq` you've already
|
|
770
589
|
* processed to receive only events you missed.
|
|
771
590
|
*
|
|
772
|
-
* `event` can be used to abort the stream from the caller side.
|
|
773
|
-
*
|
|
774
|
-
* Uses raw `fetch` (not ofetch) because SSE requires access to the
|
|
775
|
-
* response's `ReadableStream`, which ofetch consumes when parsing. Auth
|
|
776
|
-
* + base URL are still sourced from the same constructor inputs, and
|
|
777
|
-
* non-2xx responses throw the same `AgentComposeError`. */
|
|
591
|
+
* `event` can be used to abort the stream from the caller side. */
|
|
778
592
|
streamRunLogs(runId: string, opts?: StreamRunLogsOptions): AsyncGenerator<RunEvent>;
|
|
779
593
|
}
|
|
780
|
-
/** A factory: a project-level grouping of workflows inside a team. */
|
|
781
|
-
export interface FactoryRow {
|
|
782
|
-
id: string;
|
|
783
|
-
teamId: string;
|
|
784
|
-
slug: string;
|
|
785
|
-
name: string;
|
|
786
|
-
description: string | null;
|
|
787
|
-
createdAt: string;
|
|
788
|
-
updatedAt: string;
|
|
789
|
-
}
|