domain

type APIToken struct {
	ID            uuid.UUID
	UserID        uuid.UUID
	Name          string
	DisplayPrefix string
	// Permissions restricts the token to a subset of its user's
	// permissions; nil means everything the user may do.
	Permissions []Permission
	ExpiresAt   *time.Time
	LastUsedAt  *time.Time
	CreatedAt   time.Time
	RevokedAt   *time.Time
}

type ActorKind string

type AgentEvent struct {
	Seq        int64
	OccurredAt time.Time
	// ServerID is nil for Node-level events.
	ServerID *uuid.UUID
	Kind     string
	Data     json.RawMessage
}

type Artifact struct {
	ID          uuid.UUID
	Template    string
	Version     string
	Build       string
	JavaVersion int
	SHA256      []byte
	Size        int64
	Source      ArtifactSource
	Verified    bool
	CreatedBy   *uuid.UUID
	CreatedAt   time.Time
}

type ArtifactRef struct {
	ID          uuid.UUID
	SHA256      []byte
	Size        int64
	JavaVersion int
}

type ArtifactSource string

type AuditEvent struct {
	ID         int64
	OccurredAt time.Time
	ActorKind  ActorKind
	// ActorUserID is set for user and API-token actors.
	ActorUserID *uuid.UUID
	// Action is a dotted name such as "server.start".
	Action     string
	TargetKind string
	TargetID   string
	Outcome    Outcome
	Details    json.RawMessage
}

type Backup struct {
	ID            uuid.UUID
	ServerID      uuid.UUID
	DestinationID uuid.UUID
	// NodeID took the backup; a Node-directory backup is stored there.
	NodeID      uuid.UUID
	ScheduleID  *uuid.UUID
	Trigger     BackupTrigger
	State       BackupState
	ObjectKey   string
	SizeBytes   int64
	SHA256      []byte
	Software    Software
	Plugins     []BackupPlugin
	Error       string
	RequestedBy *uuid.UUID
	StartedAt   time.Time
	FinishedAt  *time.Time
}

type BackupPlugin struct {
	PluginID         string `json:"pluginId"`
	CatalogVersionID string `json:"catalogVersionId,omitempty"`
	Name             string `json:"name"`
	Version          string `json:"version"`
}

type BackupState string

type BackupTrigger string

type BuiltinRole struct {
	Name        string
	Description string
	Permissions []Permission
}

type Candidate struct {
	ID          uuid.UUID
	Name        string
	AdminState  NodeAdminState
	Connection  NodeConnectionState
	Allocatable ResourceAmounts
	// Reserved is the sum of the reservations of every server on the Node,
	// whatever its state: resources are reserved, not observed.
	Reserved Resources
}

type Condition struct {
	// ID is unique per Node or server and stable while the condition is
	// active. Agent conditions use the Agent's ID.
	ID      string
	Source  ConditionSource
	Reason  ConditionReason
	Message string
	Since   time.Time
}

type ConditionReason string

type ConditionSource string

type Convergence string

type DataPart string

type DesiredServerState string

type Destination struct {
	ID           uuid.UUID
	Name         string
	Kind         DestinationKind
	Subdirectory string
	S3           S3Config
	AgeRecipient string
	AgeIdentity  string
	CreatedBy    *uuid.UUID
	CreatedAt    time.Time
	UpdatedAt    time.Time
}

type DestinationKind string

type Enum interface {
	~string
	Valid() bool
}

type Event struct {
	ID         int64
	OccurredAt time.Time
	Source     EventSource
	NodeID     *uuid.UUID
	ServerID   *uuid.UUID
	Kind       string
	Data       json.RawMessage
}

type EventSource string

type FileEntry struct {
	Name     string
	Kind     FileKind
	Size     int64
	Modified time.Time
}

type FileKind string

type Grant struct {
	RoleID      uuid.UUID
	Permissions []Permission
	Scope       Scope
}

type Network struct {
	Name        string
	Description string
	// HasLogo is true when a logo was uploaded.
	HasLogo bool
	// Address is the host name or IP address players connect to, and Port
	// the port (25565 by default).
	Address string
	Port    int
	// LobbyServerIDs are the members players are sent to when they join,
	// tried in order.
	LobbyServerIDs []uuid.UUID
	UpdatedAt      time.Time
}

type Node struct {
	ID         uuid.UUID
	Name       string
	AdminState NodeAdminState
	CreatedAt  time.Time
	Status     NodeStatus
	Conditions []Condition
	// Reserved is the CPU and memory reserved by the servers on the Node.
	Reserved Resources
	// Address is where other Nodes reach the Node's published ports, as
	// an administrator set it; empty to use Status.ObservedAddress.
	Address string
}

type NodeAdminState string

type NodeCertificate struct {
	Serial      string
	NodeID      uuid.UUID
	Fingerprint string
	NotBefore   time.Time
	NotAfter    time.Time
	RevokedAt   *time.Time
}

type NodeConnectionState string

type NodeStatus struct {
	ConnectionState NodeConnectionState
	AgentVersion    string
	Hostname        string
	OS              string
	Arch            string
	RuntimeName     string
	RuntimeVersion  string
	Allocatable     ResourceAmounts
	Usage           ResourceAmounts
	LastHeartbeatAt *time.Time
	ConnectedAt     *time.Time
	// ObservedAddress is the IP address the Node's Agent last connected
	// from.
	ObservedAddress string
}

type OperationError struct {
	Code    string
	Message string
}

type Outcome string

type Permission string

type PermissionInfo struct {
	Name        Permission
	Description string
}

type PermissionSummary struct {
	GlobalAdmin bool
	Global      []Permission
	Teams       []ScopedPermissions
	Servers     []ScopedPermissions
}

type PlannedPlugin struct {
	Version   PluginVersionInfo
	Confirmed bool
	// Dependency is true for plugins pulled in by another one.
	Dependency bool
}

type PluginArtifact struct {
	ID       uuid.UUID
	PluginID string
	Version  string
	// CatalogVersionID is empty for uploads.
	CatalogVersionID string
	FileName         string
	SHA256           []byte
	Size             int64
	Source           ArtifactSource
	Verified         bool
	CreatedBy        *uuid.UUID
	CreatedAt        time.Time
}

type PluginArtifactRef struct {
	ID     uuid.UUID
	SHA256 []byte
	Size   int64
}

type PluginCompatibility int

type PluginJar struct {
	FileName string
	Size     int64
	// PluginName and PluginVersion are what its plugin.yml declares;
	// empty when it has none.
	PluginName    string
	PluginVersion string
}

type PluginJars struct {
	Unmanaged []PluginJar
	Managed   []PluginJar
	Truncated bool
}

type PluginPlan struct {
	Plugins []PlannedPlugin
	// Missing names required dependencies that are not in the catalog
	// (only with force; otherwise planning fails).
	Missing []string
}

type PluginRef struct {
	PluginID string
	Artifact PluginArtifactRef
}

type PluginSource string

type PluginTarget struct {
	Template string
	// GameVersion is the server's Minecraft version.
	GameVersion string
	// Installed holds the catalog plugin IDs already on the server.
	Installed map[string]bool
}

type PluginVersionInfo struct {
	PluginID     string
	Name         string
	VersionID    string
	Version      string
	Platforms    []string
	GameVersions []string
	// Requires lists required dependencies that are in the catalog.
	Requires []string
	// MissingRequired names required dependencies that are not.
	MissingRequired []string
}

type Port struct {
	Name     string
	HostPort int
	Protocol PortProtocol
}

type PortProtocol string

type PortRange struct{ First, Last int }

type Principal struct {
	UserID uuid.UUID
	// GlobalAdmin bypasses resource permissions.
	GlobalAdmin bool
	// Disabled users are denied everything.
	Disabled bool
}

type Resource struct {
	TeamID   uuid.UUID
	ServerID uuid.UUID
}

type ResourceAmounts struct {
	// CPUMillis is CPU in thousandths of a core.
	CPUMillis   int64
	MemoryBytes int64
	DiskBytes   int64
}

type Resources struct {
	// CPUMillis is CPU in thousandths of a core (4 vCPU = 4000).
	CPUMillis   int64
	MemoryBytes int64
}

type RestartPolicy struct {
	// MaxRestarts within Window; zero disables automatic restarts.
	MaxRestarts int
	Window      time.Duration
}

type Role struct {
	ID          uuid.UUID
	Name        string
	Description string
	// Builtin roles are seeded by migrations and cannot be changed.
	Builtin     bool
	Permissions []Permission
	CreatedAt   time.Time
}

type RoleAssignment struct {
	ID        uuid.UUID
	RoleID    uuid.UUID
	UserID    *uuid.UUID
	TeamID    *uuid.UUID
	Scope     Scope
	CreatedAt time.Time
}

type RolePatch struct {
	Name        *string
	Description *string
	Permissions *[]Permission
}

type RuntimeState string

type S3Config struct {
	Endpoint        string
	Bucket          string
	Region          string
	Prefix          string
	AccessKeyID     string
	SecretAccessKey string
	// CAPEM adds certificates to trust for a self-signed endpoint.
	CAPEM string
}

type Schedule struct {
	ID            uuid.UUID
	ServerID      uuid.UUID
	Cron          string
	TimeZone      string
	Action        ScheduleAction
	DestinationID *uuid.UUID
	KeepLast      int
	KeepDays      int
	Command       string
	Enabled       bool
	CreatedBy     *uuid.UUID
	CreatedAt     time.Time
	UpdatedAt     time.Time
}

type ScheduleAction string

type Scope struct {
	Kind     ScopeKind
	TeamID   uuid.UUID
	ServerID uuid.UUID
}

type ScopeKind string

type ScopedPermissions struct {
	ID          uuid.UUID
	Permissions []Permission
}

type Server struct {
	ID     uuid.UUID
	Name   string
	TeamID uuid.UUID
	// NodeID is nil until placement assigns a Node.
	NodeID        *uuid.UUID
	Kind          WorkloadKind
	DesiredState  DesiredServerState
	Generation    int64
	Phase         ServerPhase
	Software      Software
	Resources     Resources
	RestartPolicy RestartPolicy
	Ports         []Port
	// AcknowledgedConditionIDs lists conditions an administrator
	// acknowledged, so a safety-stopped server may restart.
	AcknowledgedConditionIDs []string
	EULAAcceptedAt           *time.Time
	CreatedAt                time.Time
	// Artifact is the exact software the server runs; nil until
	// provisioning resolves it.
	Artifact *ArtifactRef
	// RestartCount grows with each restart request.
	RestartCount int64
	// InNetwork is true for a network member: players reach it through
	// the proxy.
	InNetwork bool
	// InitialProperties are server.properties values for its first start.
	InitialProperties map[string]string
}

type ServerPhase string

type ServerPlugin struct {
	// ID identifies the installation (catalog IDs contain slashes).
	ID       uuid.UUID
	ServerID uuid.UUID
	Source   PluginSource
	// PluginID is the catalog ID, or UploadPluginPrefix plus the name.
	PluginID string
	Name     string
	Version  string
	// CatalogVersionID is empty for uploads.
	CatalogVersionID string
	// Platforms and GameVersions are what the catalog said about this
	// version when it was installed, so compatibility can be checked again
	// after the catalog drops it. Empty for uploads.
	Platforms    []string
	GameVersions []string
	// Requires lists the catalog plugin IDs this version needs.
	Requires []string
	Artifact PluginArtifactRef
	// Verified is false for uploads: nothing vouches for them.
	Verified bool
	// CompatibilityConfirmed is false when it was installed with force.
	CompatibilityConfirmed bool
	// Dependency is true when it was installed because another plugin
	// requires it.
	Dependency  bool
	InstalledBy *uuid.UUID
	InstalledAt time.Time
	UpdatedAt   time.Time
}

type ServerStatus struct {
	// RuntimeState is empty until the Agent first reports.
	RuntimeState      RuntimeState
	AppliedGeneration int64
	Removed           bool
	Usage             ResourceAmounts
	ObservedAt        *time.Time
	Conditions        []Condition
}

type ServerSummary struct {
	ID           uuid.UUID
	Name         string
	Kind         WorkloadKind
	InNetwork    bool
	TeamID       uuid.UUID
	NodeID       *uuid.UUID
	DesiredState DesiredServerState
	Generation   int64
	Phase        ServerPhase
	// RuntimeState is empty until the Agent first reports.
	RuntimeState RuntimeState
	Removed      bool
	// NodeConnection is empty when no Node is assigned.
	NodeConnection NodeConnectionState
	// Software, Resources, GamePort (0 when unassigned) and the number of
	// conditions, for lists.
	Software       Software
	Resources      Resources
	GamePort       int
	ConditionCount int
}

type Session struct {
	ID         uuid.UUID
	UserID     uuid.UUID
	CreatedAt  time.Time
	LastSeenAt time.Time
	ExpiresAt  time.Time
}

type Software struct {
	Template string
	Version  string
	Build    string
}

type Team struct {
	ID   uuid.UUID
	Name string
}

type User struct {
	ID          uuid.UUID
	Username    string
	Email       string
	DisplayName string
	GlobalAdmin bool
	// PasswordChangeRequired limits the user to changing their password
	// until they do.
	PasswordChangeRequired bool
	DisabledAt             *time.Time
	CreatedAt              time.Time
}

type UserPatch struct {
	DisplayName *string
	Email       *string
	GlobalAdmin *bool
	Disabled    *bool
}

type Visibility struct {
	// All is true when every server is included.
	All       bool
	TeamIDs   []uuid.UUID
	ServerIDs []uuid.UUID
}

type Workflow struct {
	ID             uuid.UUID
	Kind           WorkflowKind
	ServerID       uuid.UUID
	BackupID       *uuid.UUID
	SourceServerID *uuid.UUID
	FromNodeID     *uuid.UUID
	ToNodeID       *uuid.UUID
	Parts          []DataPart
	SafetyBackupID *uuid.UUID
	// StartAfter starts the server once the workflow succeeds.
	StartAfter bool
	// PreviousPort is a migration's game port on the old Node.
	PreviousPort *int
	State        WorkflowState
	Step         string
	Error        string
	CreatedBy    *uuid.UUID
	CreatedAt    time.Time
	UpdatedAt    time.Time
}

type WorkflowKind string

type WorkflowState string

type WorkloadKind string