Documentation
¶
Overview ¶
Package client provides an HTTP client for the BuildMax server API.
Index ¶
- Constants
- Variables
- func NewArtifactPublisher(serverURL, teamID string, token TokenFunc) tool.ArtifactPublisher
- func NewIssueClient(serverURL, teamID, issueID string, token TokenFunc) tool.IssueClient
- type AssignedIssue
- type Client
- func (c *Client) DownloadRelease(ctx context.Context, token, name, version string, allowYanked bool, ...) (string, error)
- func (c *Client) FindIssue(ctx context.Context, token, issueID string) (coreteam.Team, coreissue.Issue, error)
- func (c *Client) GetPlugin(ctx context.Context, token, name string) (*pluginwire.PluginResponse, error)
- func (c *Client) IssueThread(ctx context.Context, token, teamID, issueID string) ([]coreissue.Issue, []coreissue.Comment, int, error)
- func (c *Client) ListAssignedIssues(ctx context.Context, token, status string, limit int) ([]AssignedIssue, []error)
- func (c *Client) ListPlugins(ctx context.Context, token string) ([]coreplugin.Plugin, error)
- func (c *Client) ListServerModels(ctx context.Context, token string) ([]llmwire.Model, error)
- func (c *Client) ListTeamActivations(ctx context.Context, token, teamID string) (*pluginwire.ActivationsResponse, error)
- func (c *Client) ListTeams(ctx context.Context, token string) ([]coreteam.Team, error)
- func (c *Client) Login(ctx context.Context, email, otp, platform string) (*LoginResponse, error)
- func (c *Client) LoginWithPassword(ctx context.Context, email, password, platform string) (*LoginResponse, error)
- func (c *Client) Logout(ctx context.Context, refreshToken, accessToken string) error
- func (c *Client) PublishRelease(ctx context.Context, token, name string, body io.Reader, ...) (*coreplugin.Release, error)
- func (c *Client) Refresh(ctx context.Context, refreshToken string) (*RefreshResponse, error)
- func (c *Client) RequestOTP(ctx context.Context, email, intent string) error
- func (c *Client) SetIssueStatus(ctx context.Context, token, teamID, issueID, status string, version uint64) (coreissue.Issue, error)
- func (c *Client) SetPluginArchived(ctx context.Context, token, name string, archived bool) error
- func (c *Client) YankRelease(ctx context.Context, token, name, version, reason string) error
- type LoginResponse
- type LoginUser
- type RefreshResponse
- type TokenFunc
Constants ¶
const DefaultServerURL = "http://localhost:5678"
DefaultServerURL is where a client looks when nobody has named a server: the address buildmax-server listens on when it runs on this machine. It is the last fallback, not an assumption — settings.yaml's server_url wins, and a deployment behind an ingress publishes one origin for Portal and API that is not this one.
Variables ¶
var ErrRefreshRejected = errors.New("refresh token rejected")
ErrRefreshRejected means the server refused the refresh token: it is spent, revoked, expired, or was replayed. The session is over and only a new login will produce another.
Functions ¶
func NewArtifactPublisher ¶
func NewArtifactPublisher(serverURL, teamID string, token TokenFunc) tool.ArtifactPublisher
NewArtifactPublisher returns a publisher, or nil when this surface has no server to reach. Returning nil is what leaves the tool unregistered.
func NewIssueClient ¶
func NewIssueClient(serverURL, teamID, issueID string, token TokenFunc) tool.IssueClient
NewIssueClient scopes a local session to one Issue on one server.
The Issue and the team are fixed here, not passed per call, for the reason the worker client has no issue parameter either: a model that can name an Issue turns every instruction hidden in a comment thread into a working verb. See docs/design/issue-agent-access.md section 5.3.
Returns nil when anything needed is missing, so the caller registers no tools rather than tools that fail on every call.
Types ¶
type AssignedIssue ¶
AssignedIssue is one item of the caller's inbox, with the team it belongs to kept alongside it.
The team travels with the issue because a local surface has no current team: a login names a server and a person, and that person's work is spread across every team they are in. Anything the caller does next with this issue needs the team back.
type Client ¶
Client is a stateless HTTP client for the BuildMax server API.
func (*Client) DownloadRelease ¶
func (c *Client) DownloadRelease(ctx context.Context, token, name, version string, allowYanked bool, w io.Writer) (string, error)
DownloadRelease streams one release's bytes into w and returns the digest the server sent with them.
The bytes are copied straight through rather than collected: a package is bounded, but bounded at tens of megabytes, and the caller is writing to a staging file anyway.
func (*Client) FindIssue ¶
func (c *Client) FindIssue(ctx context.Context, token, issueID string) (coreteam.Team, coreissue.Issue, error)
FindIssue reports which of the caller's teams holds an issue, and the issue.
One request per team until one answers, because the server addresses an issue through its team and there is no route that resolves a bare issue id. Adding one would let anyone probe whether an id exists in a team they cannot see, which is a worse trade than a handful of requests a person makes once when starting work.
The issue comes back with the team because every caller needs it next: to print it, to say what a session is working on, or to read the version an update has to carry.
func (*Client) GetPlugin ¶
func (c *Client) GetPlugin(ctx context.Context, token, name string) (*pluginwire.PluginResponse, error)
GetPlugin returns one entry and every release published under it, withdrawn ones included and marked.
func (*Client) IssueThread ¶
func (c *Client) IssueThread(ctx context.Context, token, teamID, issueID string) ([]coreissue.Issue, []coreissue.Comment, int, error)
IssueThread reads an issue's children and recent comments for a person to look at. Same window as the agent gets, for the same reason.
func (*Client) ListAssignedIssues ¶
func (c *Client) ListAssignedIssues(ctx context.Context, token, status string, limit int) ([]AssignedIssue, []error)
ListAssignedIssues returns what the caller has been assigned, across every team they belong to.
One request per team, because the server has no cross-team listing and inventing one would put a route that reads every team a person is in behind a question only this inbox asks. A person's teams are few; if that stops being true, the fix is a route, not a wider fan-out here.
A team that fails is skipped rather than failing the inbox: an inbox missing one team's work is more useful than no inbox, and the caller is told which team could not be read.
func (*Client) ListPlugins ¶
ListPlugins returns the deployment's browsable catalog.
func (*Client) ListServerModels ¶
ListServerModels calls GET /api/llm/models and returns the models this deployment offers through the managed gateway. Being signed in is the whole authorization: every catalog model is available to every user.
The reply names models only. Which provider serves one, and with whose credential, stays on the server.
func (*Client) ListTeamActivations ¶
func (c *Client) ListTeamActivations(ctx context.Context, token, teamID string) (*pluginwire.ActivationsResponse, error)
ListTeamActivations returns what a team has activated for its background runs, and who fills that list.
It is a read only. Changing an activation stays in Portal, where the audit trail and the team's other shared automation already are; what this serves is somebody debugging a run who wants the answer without a browser.
func (*Client) Login ¶
Login calls POST /api/login with a single-use login code — the recovery path, used to claim a new account or replace a forgotten password. platform identifies the calling client ("cli", "desktop", "portal").
func (*Client) LoginWithPassword ¶
func (c *Client) LoginWithPassword(ctx context.Context, email, password, platform string) (*LoginResponse, error)
LoginWithPassword calls POST /api/login with a password, the everyday way in.
func (*Client) PublishRelease ¶
func (c *Client) PublishRelease( ctx context.Context, token, name string, body io.Reader, source coreplugin.ReleaseSource, ) (*coreplugin.Release, error)
PublishRelease uploads one package.
The body is the archive itself, streamed from the reader, and the claim about where it came from travels beside it. The server hashes and inspects what it receives, so nothing here is trusted on the far side.
func (*Client) Refresh ¶
Refresh calls POST /api/token/refresh, exchanging a refresh token for a new pair.
A rejected token returns ErrRefreshRejected, which the caller must be able to tell apart from the server being unreachable: one means sign in again, the other means try later.
func (*Client) RequestOTP ¶
RequestOTP calls POST /api/otp/request. intent is "login" or "signup".
func (*Client) SetIssueStatus ¶
func (c *Client) SetIssueStatus(ctx context.Context, token, teamID, issueID, status string, version uint64) (coreissue.Issue, error)
SetIssueStatus moves an issue, carrying the version it was read at.
A person's action, never a tool's: status is what the team reads to plan around, and `done` means a person accepted the work. See docs/design/issue-agent-access.md section 6.
The version is a parameter rather than something this re-reads, so the status a caller confirmed is the status of the issue they looked at. Re-reading here would turn a refused stale write into a silent one.
func (*Client) SetPluginArchived ¶
SetPluginArchived retires or restores a catalog entry.
type LoginResponse ¶
type LoginResponse struct {
// Token is AccessToken under the name it had before a login returned two
// credentials. A server older than that split sends only this one.
Token string `json:"token"`
AccessToken string `json:"access_token"`
// RefreshToken is empty when the server keeps no store for it, which means
// the login ends when the access token does.
RefreshToken string `json:"refresh_token"`
ExpiresIn int64 `json:"expires_in"`
User LoginUser `json:"user"`
}
LoginResponse is the successful result of POST /api/login.
func (*LoginResponse) Access ¶
func (r *LoginResponse) Access() string
Access returns the access token under whichever name the server used.
type LoginUser ¶
type LoginUser struct {
ID string `json:"id"`
Email string `json:"email"`
Name string `json:"name"`
}
LoginUser is the user subset returned in a login response.
type RefreshResponse ¶
type RefreshResponse struct {
AccessToken string `json:"access_token"`
RefreshToken string `json:"refresh_token"`
ExpiresIn int64 `json:"expires_in"`
}
RefreshResponse is the successful result of POST /api/token/refresh.
Source Files