basetools

type AppliedResource struct {
	Action    string `json:"action"`
	Kind      string `json:"kind"`
	Name      string `json:"name"`
	Namespace string `json:"namespace,omitempty"`
}

type ApplyOutput struct {
	Applied []AppliedResource `json:"applied"`
	// Next is the step from an accepted request to something actually
	// running. They are not the same thing.
	Next string `json:"next"`
}

type Condition struct {
	Type    string `json:"type"`
	Status  string `json:"status"`
	Reason  string `json:"reason,omitempty"`
	Message string `json:"message,omitempty"`
}

type LocationView struct {
	Name string `json:"name"`
	// Topology is everything the location declares about where it is — its
	// city, its region, and whatever else the platform publishes. A selector
	// that places by region is matched against exactly these keys.
	Topology map[string]string `json:"topology,omitempty"`
	// Ready reports whether the location is serving. A location can be offered
	// yet not ready; the two are worth telling apart before promising anything
	// will start there.
	Ready bool `json:"ready"`
}

type LocationsListOutput struct {
	Service   string         `json:"service"`
	Locations []LocationView `json:"locations"`
	// Note explains an empty list, so it is never read as a failure.
	Note string `json:"note,omitempty"`
}

type ManifestResult struct {
	// Index is this manifest's position in the list passed in.
	Index int `json:"index"`
	// Kind, Name and Namespace identify what it describes, where readable.
	Kind      string `json:"kind,omitempty"`
	Name      string `json:"name,omitempty"`
	Namespace string `json:"namespace,omitempty"`
	// Valid is false when the platform rejected it. Nothing can be planned or
	// applied until the manifest is fixed.
	Valid bool `json:"valid"`
	// Errors are the rejections, each with the field path the platform named.
	Errors []projectapi.FieldError `json:"errors,omitempty"`
	// Exists decides between create and update.
	Exists bool `json:"exists"`
	// Action is "create" or "update".
	Action string `json:"action,omitempty"`
	// Diff is what applying would change about the existing resource, from
	// what the platform said it would become. Empty for a create, and for an
	// update that changes nothing.
	Diff []string `json:"diff,omitempty"`
	// Manifest is the canonical form. Present in a plan, where it is what the
	// token covers and what apply must be handed back.
	Manifest string `json:"manifest,omitempty"`
}

type Options struct {
	// Project reads and writes as the caller. Required — with no project view
	// there is no identity to act as, and the tools are not built.
	Project *projectapi.Project
	// PlanTokenKey mints and checks the tokens binding a change to what a
	// person was shown. Empty leaves the change path out: a service that
	// cannot check a token must not issue one. See internal/plantoken.
	PlanTokenKey []byte
	// Logger receives operational warnings. Nil discards them.
	Logger *slog.Logger
	// Now is the clock, for tests. Nil uses time.Now.
	Now func() time.Time
}

type PlanOutput struct {
	// Valid is false when anything was rejected. There is then no token and
	// nothing can be applied.
	Valid bool `json:"valid"`
	// Results are in apply order, which the token covers.
	Results []ManifestResult `json:"results"`
	// PlanToken authorizes exactly these manifests in this order, and nothing
	// else.
	PlanToken string `json:"planToken,omitempty"`
	// ExpiresAt is when the token stops being accepted, in RFC 3339.
	ExpiresAt string `json:"expiresAt,omitempty"`
	// Note carries anything about the plan the person should hear.
	Note string `json:"note,omitempty"`
}

type QuotaGetOutput struct {
	Service   string     `json:"service,omitempty"`
	Resources []QuotaRow `json:"resources"`
	// Note explains an empty answer.
	Note string `json:"note,omitempty"`
}

type QuotaRow struct {
	// ResourceType is the platform's identifier, e.g.
	// "compute.datumapis.com/vcpus".
	ResourceType string `json:"resourceType"`
	// Unit is what the numbers below count, e.g. "vCPUs".
	Unit string `json:"unit"`
	// Limit, Used and Available are in Unit, not in whatever the platform
	// stores internally.
	Limit     int64 `json:"limit"`
	Used      int64 `json:"used"`
	Available int64 `json:"available"`
}

type ResourceSummary struct {
	Name      string `json:"name"`
	Namespace string `json:"namespace,omitempty"`
	// CreatedAt is when the resource was first accepted, in RFC 3339.
	CreatedAt string `json:"createdAt,omitempty"`
	// Conditions is what the platform is currently reporting about it.
	Conditions []Condition `json:"conditions,omitempty"`
	// Labels are carried through because a placement, a selector or a
	// provider's own tool is usually keyed on one.
	Labels map[string]string `json:"labels,omitempty"`
}

type ResourcesGetOutput struct {
	Kind       string `json:"kind"`
	APIVersion string `json:"apiVersion"`
	Name       string `json:"name"`
	Namespace  string `json:"namespace,omitempty"`
	// Manifest is the resource as YAML, with everything the platform owns
	// removed — so it can be edited and handed straight to resources_plan.
	Manifest string `json:"manifest"`
	// Conditions is what the platform is currently reporting about it. Kept
	// out of the manifest above, which is the desired state rather than the
	// observed one.
	Conditions []Condition `json:"conditions,omitempty"`
}

type ResourcesListOutput struct {
	Kind       string            `json:"kind"`
	APIVersion string            `json:"apiVersion"`
	Namespace  string            `json:"namespace,omitempty"`
	Resources  []ResourceSummary `json:"resources"`
	// Note says what was left out, when anything was.
	Note string `json:"note,omitempty"`
}

type SchemaGetOutput struct {
	Group   string `json:"group,omitempty"`
	Version string `json:"version"`
	Kind    string `json:"kind"`
	// Path is the part of the kind this describes, when one was asked for.
	Path string `json:"path,omitempty"`
	// Schema is the description itself: the fields, their types, which are
	// required, and what each is for.
	Schema map[string]any `json:"schema"`
	// Note says what was left out, when anything was.
	Note string `json:"note,omitempty"`
}

type ValidateOutput struct {
	Valid   bool             `json:"valid"`
	Results []ManifestResult `json:"results"`
}