Skip to content

Clarify TypeScript docs and budget types #91

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nficano wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Clarify TypeScript docs and budget types #91

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/conformance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Section-by-section status lives in
| §7.4 Cancellation | full | 30s grace by default. |
| §7.5 Agent versions | full | Negotiated via `agent_versions` feature flag. |
| §7.6 Subscribe | full | Per-job cross-session subscription. |
| §8 Job events | full | All eight reserved kinds + `x-vendor.*`. |
| §8 Job events | full | All ten reserved kinds + `x-vendor.*`. |
| §8.2.1 Progress | full | Negotiated via `progress` feature flag. |
| §8.3 Sequence numbers | full | Session-scoped, strictly monotonic. |
| §8.4 Result chunks | full | Negotiated via `result_chunk` feature flag. |
Expand Down
6 changes: 3 additions & 3 deletions docs/guides/job-events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Job events (§8)

Every signal an agent emits during a job is one `job.event` envelope.
There are eight reserved kinds plus the `x-vendor.*` extension
namespace.
There are ten reserved kinds, including the v1.1 `progress` and
`result_chunk` additions, plus the `x-vendor.*` extension namespace.

## The eight kinds
## The ten kinds

| Kind | Body | Purpose |
| -------------- | ----------------------------------------------- | ------------------------------------------ |
Expand Down
2 changes: 1 addition & 1 deletion docs/packages/client.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ Returned by `submit()`.
| `agent?: string` | v1.1 — resolved agent ref including version. |
| `traceId?: TraceId` | Same id if you passed one in. |
| `leaseConstraints?: LeaseConstraints` | v1.1 lease constraints (`{ expires_at? }`). |
| `budget?: ReadonlyMap<string, number>` | v1.1 initial per-currency budget. |
| `budget?: Readonly<Record<string, number>>` | v1.1 initial per-currency budget; access with `budget?.USD` or `budget?.["USD"]`. |
| `credentials?: readonly IssuedCredential["wire"][]` | v1.1 provisioned credentials. |
| `done: Promise<JobResultPayload>` | Resolves on `job.result`, rejects on `job.error`. |
| `collectChunks(): Promise<Buffer \| string>` | v1.1 — assemble `result_chunk` stream. |
Expand Down