hubclient

type APIError struct {
	// Status is the HTTP status.
	Status int
	// Code is the machine-readable code when the hub sent one: an OAuth
	// error ("authorization_pending"), an apierror code ("FORBIDDEN"), or
	// the dashboard dialect's own ("executor_audience_denied").
	Code string
	// Message is the hub's prose.
	Message string
	// Remediation is the hub's "what to do about it", when it sent one apart
	// from the message.
	Remediation string
	// Details is the rest of what the hub said about the refusal: apierror's
	// "details" object — required_permission, role and scope for a missing
	// permission — or the dashboard dialect's other fields (executor_id,
	// alternatives, …). Values are as JSON decodes them.
	Details map[string]any
	// IntervalSeconds is the polling interval a device-flow error carried.
	IntervalSeconds int
}

type ApprovalItem struct {
	// Kind is grant_request or api_token.
	Kind string `json:"kind"`
	ID   string `json:"id"`
	// Deadline is when the item stops being decidable, RFC 3339; empty for a
	// token that never expires.
	Deadline          string        `json:"deadline,omitempty"`
	DeadlineInSeconds int64         `json:"deadline_in_seconds,omitempty"`
	Request           *GrantRequest `json:"request,omitempty"`
	Token             *WaitingToken `json:"token,omitempty"`
}

type Approvals struct {
	Items         []ApprovalItem `json:"items"`
	Count         int            `json:"count"`
	GrantRequests int            `json:"grant_requests"`
	APITokens     int            `json:"api_tokens"`
	NextDeadline  string         `json:"next_deadline,omitempty"`
	// Mine is the caller's own requests: pending, and those settled in the
	// last week.
	Mine  []GrantRequest `json:"mine"`
	Actor string         `json:"actor,omitempty"`
}

type AssignRepositoriesRequest struct {
	Secret     string   `json:"secret"`
	Repos      []string `json:"repos"`
	Access     string   `json:"access,omitempty"`
	TTLMinutes int      `json:"ttl_minutes,omitempty"`
	Branches   []string `json:"branches,omitempty"`
	// Replaces names a grant of this project's the new one supersedes.
	Replaces string `json:"replaces,omitempty"`
}

type AvailableRepository struct {
	ID       int64  `json:"id"`
	FullName string `json:"full_name"`
	Private  bool   `json:"private"`
}

type CatalogEntry struct {
	ID   string `json:"id"`
	Name string `json:"name"`
	Kind string `json:"kind"`
}

type Client struct {
	// Base is the hub's base URL, as NormalizeURL renders it.
	Base string
	// Credential is presented as `Authorization: Bearer …`; empty for the
	// two device endpoints, which are reached before there is one.
	Credential string
	// contains filtered or unexported fields
}

type CreateSecretRequest struct {
	Name     string            `json:"name"`
	Kind     string            `json:"kind"`
	Payload  string            `json:"payload"`
	Metadata map[string]string `json:"metadata,omitempty"`
	// Personal, when set, asks for a personal or a shared secret; unset lets
	// the hub decide, which is personal whenever the session has an identity.
	Personal *bool `json:"personal,omitempty"`
}

type DecidedRequest struct {
	Request GrantRequest `json:"request"`
	// GrantID is the grant an approval minted, and Note what the hub says
	// about when it takes effect.
	GrantID string `json:"grant_id,omitempty"`
	Note    string `json:"note,omitempty"`
}

type DeviceCode struct {
	DeviceCode              string `json:"device_code"`
	UserCode                string `json:"user_code"`
	VerificationURI         string `json:"verification_uri"`
	VerificationURIComplete string `json:"verification_uri_complete"`
	ExpiresIn               int    `json:"expires_in"`
	Interval                int    `json:"interval"`
}

type DeviceToken struct {
	TokenType   string `json:"token_type"`
	SessionID   string `json:"session_id"`
	ExpiresIn   int    `json:"expires_in"`
	IdleTimeout int    `json:"idle_timeout"`
	Revalidated bool   `json:"revalidated"`
	Identity    struct {
		Sub   string `json:"sub"`
		Email string `json:"email"`
		Name  string `json:"name"`
	} `json:"identity"`
}

type Executor struct {
	ID            string            `json:"id"`
	Name          string            `json:"name"`
	Kind          string            `json:"kind"`
	Status        string            `json:"status"`
	Registered    bool              `json:"registered"`
	Default       bool              `json:"default"`
	Isolation     string            `json:"isolation"`
	Health        string            `json:"health,omitempty"`
	Blocked       bool              `json:"blocked"`
	BlockedReason string            `json:"blocked_reason,omitempty"`
	SchedState    string            `json:"sched_state"`
	SchedReason   string            `json:"sched_reason,omitempty"`
	Schedulable   bool              `json:"schedulable"`
	Restricted    bool              `json:"restricted,omitempty"`
	Admitted      bool              `json:"admitted"`
	Labels        map[string]string `json:"labels,omitempty"`
	Virtual       *struct {
		Parent string `json:"parent"`
	} `json:"virtual,omitempty"`
}

type ExecutorList struct {
	Executors []Executor `json:"executors"`
	DefaultID string     `json:"default_id"`
}

type Feature struct {
	// Idx is the feature's own index in the caller's project list: what its
	// run, tasks and options are addressed by (`cloop remote run <idx>`).
	Idx         int    `json:"project_idx"`
	Path        string `json:"path"`
	Name        string `json:"name"`
	Status      string `json:"status"`
	Running     bool   `json:"running"`
	TotalTasks  int    `json:"total_tasks"`
	DoneTasks   int    `json:"done_tasks"`
	FailedTasks int    `json:"failed_tasks"`
	Feature     *struct {
		Slug       string     `json:"slug"`
		Title      string     `json:"title"`
		Branch     string     `json:"branch"`
		Base       string     `json:"base"`
		CreatedAt  time.Time  `json:"created_at"`
		CreatedBy  string     `json:"created_by,omitempty"`
		AutoPR     bool       `json:"auto_pr,omitempty"`
		AutoEvolve bool       `json:"auto_evolve,omitempty"`
		Innovate   bool       `json:"innovate,omitempty"`
		PR         *FeaturePR `json:"pr,omitempty"`
	} `json:"feature,omitempty"`
}

type FeatureList struct {
	Project  string    `json:"project"`
	Path     string    `json:"path"`
	Features []Feature `json:"features"`
	Max      int       `json:"max"`
}

type FeaturePR struct {
	Number    int       `json:"number"`
	URL       string    `json:"url"`
	State     string    `json:"state"`
	Repo      string    `json:"repo,omitempty"`
	Head      string    `json:"head,omitempty"`
	Base      string    `json:"base,omitempty"`
	Draft     bool      `json:"draft,omitempty"`
	CreatedAt time.Time `json:"created_at"`
}

type FeaturePRRequest struct {
	Title string `json:"title,omitempty"`
	Body  string `json:"body,omitempty"`
	Draft bool   `json:"draft,omitempty"`
}

type FeaturePRResult struct {
	PR          *FeaturePR `json:"pr"`
	Existing    bool       `json:"existing"`
	Pushed      bool       `json:"pushed"`
	Ahead       int        `json:"ahead"`
	Dirty       []string   `json:"dirty,omitempty"`
	TokenSource string     `json:"token_source"`
}

type File struct {
	// Default is the URL of the hub commands talk to when none is named.
	Default string `json:"default,omitempty"`
	// Hubs is keyed by NormalizeURL of each hub's URL.
	Hubs map[string]*Hub `json:"hubs"`
}

type FileGrantRequest struct {
	SecretRef     string   `json:"secret_ref"`
	Subject       string   `json:"subject"`
	Scope         string   `json:"scope,omitempty"`
	TTLMinutes    int      `json:"ttl_minutes"`
	WaitMinutes   int      `json:"wait_minutes,omitempty"`
	Justification string   `json:"justification"`
	Repos         []string `json:"repos,omitempty"`
	Permissions   []string `json:"permissions,omitempty"`
	Branches      []string `json:"branches,omitempty"`
	Namespaces    []string `json:"namespaces,omitempty"`
	Contexts      []string `json:"contexts,omitempty"`
	Hosts         []string `json:"hosts,omitempty"`
	Registries    []string `json:"registries,omitempty"`
	EnvKeys       []string `json:"env_keys,omitempty"`
	Writable      bool     `json:"writable,omitempty"`
}

type GitProxyStatus struct {
	Running  bool     `json:"running"`
	Required bool     `json:"required"`
	PushRefs []string `json:"push_refs,omitempty"`
}

type GrantRequest struct {
	ID             string    `json:"id"`
	RequestedBy    string    `json:"requested_by"`
	SecretID       string    `json:"secret_id"`
	SecretName     string    `json:"secret_name,omitempty"`
	Kind           string    `json:"kind,omitempty"`
	Subject        string    `json:"subject"`
	Constraints    string    `json:"constraints,omitempty"`
	Scope          string    `json:"scope,omitempty"`
	TTLMinutes     int       `json:"ttl_minutes"`
	Justification  string    `json:"justification"`
	State          string    `json:"state"`
	CreatedAt      time.Time `json:"created_at"`
	ExpiresAt      time.Time `json:"expires_at,omitempty"`
	DecidedBy      string    `json:"decided_by,omitempty"`
	DecidedAt      time.Time `json:"decided_at,omitempty"`
	DecisionNote   string    `json:"decision_note,omitempty"`
	GrantID        string    `json:"grant_id,omitempty"`
	GrantExpiresAt time.Time `json:"grant_expires_at,omitempty"`
	Mine           bool      `json:"mine"`
	Decidable      bool      `json:"decidable"`
	// Approvers says who may approve a pending request: the accounts and
	// groups the hub's policy gives secret.grant, other than the requester.
	// A hub older than Task 20417 does not say.
	Approvers []string `json:"approvers,omitempty"`
}

type GrantRequestList struct {
	Requests     []GrantRequest `json:"requests"`
	PendingCount int            `json:"pending_count"`
	CanDecide    bool           `json:"can_decide"`
	Actor        string         `json:"actor"`
}

type HarnessCandidate struct {
	ID       string   `json:"id"`
	Name     string   `json:"name"`
	Owner    string   `json:"owner,omitempty"`
	Personal bool     `json:"personal"`
	Mine     bool     `json:"mine"`
	Keys     []string `json:"keys"`
	Complete bool     `json:"complete"`
	Granted  bool     `json:"granted"`
}

type HarnessCredential struct {
	Applies     bool               `json:"applies"`
	State       string             `json:"state"`
	Provider    string             `json:"provider"`
	Needed      [][]string         `json:"needed"`
	SatisfiedBy *HarnessGrant      `json:"satisfied_by"`
	ExpiresAt   *time.Time         `json:"expires_at"`
	Reason      string             `json:"reason,omitempty"`
	Remedy      string             `json:"remedy,omitempty"`
	Candidates  []HarnessCandidate `json:"candidates"`
	CanPaste    bool               `json:"can_paste"`
	// BrokerUnavailable is why nothing can be granted on this hub at all.
	BrokerUnavailable string `json:"broker_unavailable,omitempty"`
	Granted           *struct {
		GrantID    string    `json:"grant_id"`
		SecretName string    `json:"secret_name"`
		EnvKeys    []string  `json:"env_keys"`
		ExpiresAt  time.Time `json:"expires_at"`
	} `json:"granted,omitempty"`
}

type HarnessGrant struct {
	GrantID    string     `json:"grant_id"`
	SecretID   string     `json:"secret_id"`
	SecretName string     `json:"secret_name"`
	Owner      string     `json:"owner,omitempty"`
	ExpiresAt  *time.Time `json:"expires_at"`
	Keys       []string   `json:"keys"`
}

type Hub struct {
	// URL is the hub's base URL as NormalizeURL renders it.
	URL string `json:"url"`
	// Credential is the terminal's session credential: the bearer the hub
	// authenticates this terminal by. Never printed.
	Credential string `json:"credential"`
	// SessionID is the session's public id — the credential's digest — as
	// the hub's Active Sessions table and audit trail name it.
	SessionID string `json:"session_id"`
	// CAFile is a PEM bundle to trust for this hub, for a hub whose
	// certificate is not signed by a public CA.
	CAFile string `json:"ca_file,omitempty"`

	Subject string `json:"subject,omitempty"`
	Email   string `json:"email,omitempty"`
	Name    string `json:"name,omitempty"`

	// SignedInAt is when the hub approved the session and ExpiresAt when it
	// ends at the latest; it may end sooner, idle or revoked.
	SignedInAt time.Time `json:"signed_in_at"`
	ExpiresAt  time.Time `json:"expires_at,omitempty"`
	// Client is the host name the terminal reported when it signed in.
	Client string `json:"client,omitempty"`
	// contains filtered or unexported fields
}

type LogEvents struct {
	// RunState is told each time the hub reports the run started or stopped.
	RunState func(running bool)
}

type LoginOptions struct {
	// HubURL is the hub to sign in to.
	HubURL string
	// CAFile is a PEM bundle to trust for the hub, kept with the credential.
	CAFile string
	// Hostname is what the terminal calls its machine on the approval page;
	// os.Hostname when empty.
	Hostname string
	// Out receives the instructions: the code and where to enter it.
	Out io.Writer
	// OpenBrowser, when set, is asked to open the approval page.
	OpenBrowser func(url string) error
}

type MintedToken struct {
	Token    string
	Server   string
	CASHA256 string
}

type NewProject struct {
	Dir string `json:"dir"`
	// Idx is the project's index in the caller's project list, -1 when the
	// hub could not find it there.
	Idx int `json:"project_idx"`
}

type NewProjectRequest struct {
	// Dir is the project's directory on the hub. Empty with Name set asks
	// the hub to place it under its projects root (ui.projects_root).
	Dir  string `json:"dir,omitempty"`
	Name string `json:"name,omitempty"`
	Goal string `json:"goal"`

	Provider string `json:"provider,omitempty"`
	Model    string `json:"model,omitempty"`
	Effort   string `json:"effort,omitempty"`

	// ExecutorID pins the project; Grants are opened with it. Both are
	// applied with the creation or not at all.
	ExecutorID string         `json:"executor_id,omitempty"`
	Grants     []ProjectGrant `json:"grants,omitempty"`
}

type Project struct {
	Idx         int    `json:"idx"`
	Name        string `json:"name"`
	Path        string `json:"path"`
	Status      string `json:"status"`
	Goal        string `json:"goal"`
	Running     bool   `json:"running"`
	TotalTasks  int    `json:"total_tasks"`
	DoneTasks   int    `json:"done_tasks"`
	FailedTasks int    `json:"failed_tasks"`
	ActiveTasks int    `json:"active_tasks"`
	Hidden      bool   `json:"hidden"`
}

type ProjectGrant struct {
	SecretRef   string   `json:"secret_ref"`
	Scope       string   `json:"scope,omitempty"`
	TTLMinutes  int      `json:"ttl_minutes,omitempty"`
	Repos       []string `json:"repos,omitempty"`
	Permissions []string `json:"permissions,omitempty"`
	Branches    []string `json:"branches,omitempty"`
	Namespaces  []string `json:"namespaces,omitempty"`
	Contexts    []string `json:"contexts,omitempty"`
	Hosts       []string `json:"hosts,omitempty"`
	Registries  []string `json:"registries,omitempty"`
	EnvKeys     []string `json:"env_keys,omitempty"`
	Writable    bool     `json:"writable,omitempty"`
}

type ProjectRepositories struct {
	Project     string           `json:"project"`
	Apps        []RepoApp        `json:"apps"`
	Assignments []RepoAssignment `json:"assignments"`
	GitProxy    GitProxyStatus   `json:"git_proxy"`
}

type RenewedShare struct {
	ID             string    `json:"id"`
	Name           string    `json:"name"`
	Renewal        string    `json:"renewal"`
	ServiceAccount string    `json:"service_account"`
	IssuedAt       time.Time `json:"issued_at"`
	ExpiresAt      time.Time `json:"expires_at"`
	Renewals       int       `json:"renewals"`
	Verified       bool      `json:"verified"`
	Sessions       int       `json:"sessions"`
}

type RepoApp struct {
	ID   string `json:"id"`
	Name string `json:"name"`
}

type RepoAssignment struct {
	GrantID           string    `json:"grant_id"`
	SecretID          string    `json:"secret_id"`
	SecretName        string    `json:"secret_name"`
	Kind              string    `json:"kind"`
	Repos             []string  `json:"repos"`
	Access            string    `json:"access"`
	Branches          []string  `json:"branches,omitempty"`
	BranchEnforcement string    `json:"branch_enforcement,omitempty"`
	Replaceable       bool      `json:"replaceable,omitempty"`
	ExpiresAt         time.Time `json:"expires_at"`
	CreatedAt         time.Time `json:"created_at"`
	CreatedBy         string    `json:"created_by,omitempty"`
}

type RevokedRepositories struct {
	GrantID string `json:"grant_id"`
	State   string `json:"state,omitempty"`
	Leases  int    `json:"leases,omitempty"`
	Note    string `json:"note,omitempty"`
}

type Secret struct {
	ID           string            `json:"id"`
	Name         string            `json:"name"`
	Kind         string            `json:"kind"`
	Metadata     map[string]string `json:"metadata"`
	CreatedAt    time.Time         `json:"created_at"`
	CreatedBy    string            `json:"created_by"`
	Owner        string            `json:"owner"`
	Personal     bool              `json:"personal"`
	Mine         bool              `json:"mine"`
	Grants       int               `json:"grants"`
	ActiveGrants int               `json:"active_grants"`
}

type SecretsList struct {
	Secrets []Secret `json:"secrets"`
	Broker  struct {
		SecretsAvailable bool   `json:"secrets_available"`
		Reason           string `json:"reason"`
		Remediation      string `json:"remediation"`
	} `json:"broker"`
	// KubeGuard is whether the hub delivers kubeconfigs through its
	// Kubernetes access monitor. A hub older than Task 20416 does not say,
	// which reads as no monitor.
	KubeGuard struct {
		Enabled bool `json:"enabled"`
		Running bool `json:"running"`
	} `json:"kube_guard"`
}

type StartFeatureRequest struct {
	Name        string   `json:"name"`
	Description string   `json:"description,omitempty"`
	Base        string   `json:"base,omitempty"`
	Tasks       []string `json:"tasks,omitempty"`
	AutoEvolve  bool     `json:"auto_evolve,omitempty"`
	Innovate    bool     `json:"innovate,omitempty"`
	Parallel    bool     `json:"parallel,omitempty"`
	MaxParallel int      `json:"max_parallel,omitempty"`
	AutoPR      bool     `json:"auto_pr,omitempty"`
}

type StartedFeature struct {
	Slug   string `json:"slug"`
	Branch string `json:"branch"`
	Base   string `json:"base"`
	Path   string `json:"path"`
	Idx    int    `json:"project_idx"`
}

type Task struct {
	ID          int    `json:"id"`
	Title       string `json:"title"`
	Description string `json:"description,omitempty"`
	Status      string `json:"status"`
	Priority    int    `json:"priority"`
}

type WaitingToken struct {
	ID        string   `json:"id"`
	Name      string   `json:"name"`
	Prefix    string   `json:"prefix"`
	Roles     []string `json:"roles"`
	CreatedBy string   `json:"created_by,omitempty"`
	CreatedAt string   `json:"created_at,omitempty"`
}