model

type Cluster struct {
	// required: true
	ID uint `json:"id" gorm:"primaryKey"`
	// required: true
	CreatedAt time.Time `json:"createdAt"`
	// required: true
	UpdatedAt time.Time `json:"updatedAt"`
	// required: true
	Name string `json:"name" gorm:"uniqueIndex"`
	// required: true
	Description string `json:"description"`
	// required: true
	Autoscaled    bool    `json:"autoscaled"`
	Configuration []byte  `json:"-"`
	Groups        []Group `json:"groups,omitempty" gorm:"constraint:OnUpdate:CASCADE"`
}

type Database struct {
	ID                uint               `json:"id" gorm:"primaryKey"`
	CreatedAt         time.Time          `json:"createdAt"`
	UpdatedAt         time.Time          `json:"updatedAt"`
	Name              string             `json:"name" gorm:"index:database_name_group_idx,unique"`
	GroupName         string             `json:"groupName" gorm:"index:database_name_group_idx,unique"`
	Description       string             `json:"description" gorm:"type:text"`
	Url               string             `json:"url"` // s3... Path?
	ExternalDownloads []ExternalDownload `json:"externalDownloads" gorm:"constraint:OnUpdate:CASCADE,OnDelete:CASCADE;"`
	Lock              *Lock              `json:"lock" gorm:"constraint:OnUpdate:CASCADE,OnDelete:CASCADE;"`
	Slug              string             `json:"slug" gorm:"uniqueIndex"`
	Type              string             `json:"type"` // TODO: Strictly sql or fs?
	FilestoreID       uint               `json:"filestoreId"`
	Filestore         *Database          `json:"filestore" gorm:"foreignKey:ID"`
	UserID            uint               `json:"userId"`
	User              User               `json:"user"`
	Size              int64              `json:"size"`
}

type Deployment struct {
	ID        uint      `json:"id" gorm:"primaryKey"`
	CreatedAt time.Time `json:"createdAt"`
	UpdatedAt time.Time `json:"updatedAt"`

	UserID uint  `json:"userId"`
	User   *User `json:"user,omitempty"`

	Name        string `json:"name" gorm:"index:deployment_name_group_idx,unique"`
	Description string `json:"description"`
	GroupName   string `json:"groupName" gorm:"index:deployment_name_group_idx,unique; references:Name"`
	Group       *Group `json:"group,omitempty"`

	TTL uint `json:"ttl"`

	Instances []*DeploymentInstance `json:"instances" gorm:"constraint:OnUpdate:CASCADE,OnDelete:CASCADE"`
}

type DeploymentInstance struct {
	ID        uint      `json:"id" gorm:"primaryKey"`
	CreatedAt time.Time `json:"createdAt"`
	UpdatedAt time.Time `json:"updatedAt"`

	// TODO: FK to name of Deployment?
	Name      string `json:"name" gorm:"index:deployment_instance_name_group_stack_idx,unique"`
	Group     *Group `json:"group,omitempty"`
	GroupName string `json:"groupName" gorm:"index:deployment_instance_name_group_stack_idx,unique; references:Name"`
	//	Stack     *Stack `json:"stack,omitempty"`
	StackName string `json:"stackName" gorm:"index:deployment_instance_name_group_stack_idx,unique"`

	Lock *Lock `gorm:"foreignKey:InstanceID"`

	DeploymentID uint        `json:"deploymentId"`
	Deployment   *Deployment `json:"deployment,omitempty"`

	GormParameters []DeploymentInstanceParameter `json:"-" gorm:"foreignKey:DeploymentInstanceID; constraint:OnUpdate:CASCADE,OnDelete:CASCADE"`
	Parameters     DeploymentInstanceParameters  `json:"parameters" gorm:"-:all"`

	Public bool `json:"public"`

	DeployLog string `json:"deployLog" gorm:"type:text"`
}

type DeploymentInstanceParameter struct {
	DeploymentInstanceID uint   `json:"-" gorm:"primaryKey"`
	ParameterName        string `json:"-" gorm:"primaryKey"`
	StackName            string `json:"-"`
	Value                string `json:"value"`
}

type DeploymentInstanceParameters map[string]DeploymentInstanceParameter

type ExternalDownload struct {
	UUID       uuid.UUID `json:"uuid" gorm:"primaryKey;type:uuid"`
	Expiration uint      `json:"expiration"`
	DatabaseID uint      `json:"databaseId"`
}

type Group struct {
	Name        string    `json:"name" gorm:"primaryKey; unique;"`
	Namespace   string    `json:"namespace"`
	Description string    `json:"description" gorm:"type:text"`
	CreatedAt   time.Time `json:"createdAt"`
	UpdatedAt   time.Time `json:"updatedAt"`
	Hostname    string    `json:"hostname" gorm:"unique;"`
	Deployable  bool      `json:"deployable"`
	Users       []User    `json:"users" gorm:"many2many:user_groups;constraint:OnUpdate:CASCADE,OnDelete:CASCADE;"`
	AdminUsers  []User    `json:"adminUsers" gorm:"many2many:user_groups_admin;constraint:OnUpdate:CASCADE,OnDelete:CASCADE;"`
	ClusterID   *uint     `json:"clusterId"`
	Cluster     Cluster   `json:"cluster" gorm:"constraint:OnUpdate:CASCADE,OnDelete:SET NULL"`
}

type KubernetesResource string

type Lock struct {
	DatabaseID uint               `json:"databaseId" gorm:"primaryKey"`
	InstanceID uint               `json:"instanceId"`
	Instance   DeploymentInstance `json:"instance,omitempty"`
	UserID     uint               `json:"userId"`
	User       User               `json:"user,omitempty"`
}

type ParameterProvider interface {
	Provide(instance DeploymentInstance) (value string, err error)
}

type ParameterProviderFunc func(instance DeploymentInstance) (string, error)

type ParameterProviders map[string]ParameterProvider

type RequireCompanionFunc func(instance DeploymentInstanceParameter) (*Stack, error)

type Stack struct {
	Name             string          `json:"name"`
	Parameters       StackParameters `json:"parameters"`
	HostnamePattern  string          `json:"hostnamePattern"`
	HostnameVariable string          `json:"hostnameVariable"`
	// ParameterProviders provide parameters to other stacks.
	ParameterProviders ParameterProviders `json:"-"`
	// Requires these stacks to deploy an instance of this stack.
	Requires []Stack `json:"requires"`
	// Companions are optional stacks that can be deployed alongside this stack. Certain parameters can require a companion stack.
	Companions         []Stack `json:"companions"`
	KubernetesResource KubernetesResource
}

type StackParameter struct {
	// DisplayName is the user-friendly name of the parameter.
	DisplayName  string  `json:"displayName"`
	DefaultValue *string `json:"defaultValue,omitempty"`
	// Consumed signals that this parameter is provided by another stack i.e. one of the stacks required stacks.
	Consumed bool `json:"consumed"`
	// Validator ensures that the actual stack parameters are valid according to its rules.
	Validator func(value string) error `json:"-"`
	// Priority determines the order in which the parameter is shown.
	Priority         uint                 `json:"priority"`
	Sensitive        bool                 `json:"sensitive"`
	RequireCompanion RequireCompanionFunc `json:"-"`
}

type StackParameters map[string]StackParameter

type User struct {
	ID               uint           `json:"id" gorm:"primarykey"`
	CreatedAt        time.Time      `json:"createdAt"`
	UpdatedAt        time.Time      `json:"updatedAt"`
	Email            string         `json:"email" gorm:"index;unique"`
	EmailToken       uuid.UUID      `json:"-" gorm:"unique;type:uuid"`
	Validated        bool           `json:"validated"`
	Password         string         `json:"-"`
	PasswordToken    sql.NullString `json:"-"`
	PasswordTokenTTL uint           `json:"-"`
	Groups           []Group        `json:"groups" gorm:"many2many:user_groups;constraint:OnUpdate:CASCADE,OnDelete:CASCADE"`
	Databases        []Database     `json:"databases" gorm:"constraint:OnUpdate:CASCADE,OnDelete:CASCADE"`
	AdminGroups      []Group        `json:"adminGroups" gorm:"many2many:user_groups_admin;constraint:OnUpdate:CASCADE,OnDelete:CASCADE"`
}