types

type CreateRequest struct {
	Name        string            `json:"name"`         // Name of the job
	ProjectName string            `json:"project_name"` // Project name of the job
	WebhookURL  string            `json:"webhook_url"`  // Webhook URL of the job
	Instances   []InstanceRequest `json:"instances"`    // Instances to create
}

type CreateUserRequest struct {
	Username     string          `json:"username" gorm:"not null;unique"`
	Email        string          `json:"email" gorm:""`
	Role         models.UserRole `json:"role" gorm:"index"`
	PublicSSHKey string          `json:"public_ssh_key" gorm:""`
}

type CreateUserResponse struct {
	UserID uint `json:"id"`
}

type DeleteInstanceRequest struct {
	ProjectName   string   `json:"project_name" validate:"required"`         // Project name
	InstanceNames []string `json:"instance_names" validate:"required,min=1"` // Instances to delete
}

type InstanceConfig struct {
	Region            string         `json:"region"`                // Region where to create the instance
	OwnerID           uint           `json:"owner_id"`              // Owner ID of the instance
	Size              string         `json:"size"`                  // Size/type of the instance
	Image             string         `json:"image"`                 // OS image to use
	SSHKeyID          string         `json:"ssh_key_id"`            // SSH key name to use
	Tags              []string       `json:"tags,omitempty"`        // Tags to apply to the instance
	NumberOfInstances int            `json:"number_of_instances"`   // Number of instances to create
	CustomName        string         `json:"custom_name,omitempty"` // Optional custom name for this specific instance
	Volumes           []VolumeConfig `json:"volumes,omitempty"`     // Volumes to attach to the instance
}

type InstanceInfo struct {
	ID             string            // Provider-specific instance ID
	Name           string            // Instance name
	PublicIP       string            // Public IP address
	Provider       models.ProviderID // Provider name (e.g., "do")
	Region         string            // Region where instance was created
	Size           string            // Instance size/type
	Tags           []string          // Tags of the instance
	Volumes        []string          `json:"volumes,omitempty"`         // List of attached volume IDs
	VolumeDetails  []VolumeDetails   `json:"volume_details,omitempty"`  // Detailed information about attached volumes
	PayloadPath    string            `json:"payload_path,omitempty"`    // Local path to the payload script on the API server
	ExecutePayload bool              `json:"execute_payload,omitempty"` // Whether to execute the payload after copying
}

type InstanceRequest struct {
	Provider          models.ProviderID `json:"provider"`                  // Cloud provider (e.g., "do")
	Region            string            `json:"region"`                    // Region where instances will be created
	Size              string            `json:"size"`                      // Instance size/type
	Image             string            `json:"image"`                     // OS image to use
	SSHKeyName        string            `json:"ssh_key_name"`              // Name of the SSH key to use
	Tags              []string          `json:"tags"`                      // Tags to apply to instances
	NumberOfInstances int               `json:"number_of_instances"`       // Number of instances to create
	Name              string            `json:"name"`                      // Optional custom name for instances
	Provision         bool              `json:"provision"`                 // Whether to run Ansible provisioning
	Volumes           []VolumeConfig    `json:"volumes"`                   // Optional volumes to attach
	OwnerID           uint              `json:"owner_id"`                  // Owner ID of the instance
	PayloadPath       string            `json:"payload_path,omitempty"`    // Local path to the payload script on the API server
	ExecutePayload    bool              `json:"execute_payload,omitempty"` // Whether to execute the payload after copying
	SSHKeyType        string            `json:"ssh_key_type,omitempty"`    // Type of the private SSH key for Ansible (e.g., "rsa", "ed25519"). Defaults to "rsa".
	SSHKeyPath        string            `json:"ssh_key_path,omitempty"`    // Custom path to the private SSH key file for Ansible. Overrides defaults.
}

type InstancesRequest struct {
	InstanceName string            `json:"instance_name"`
	ProjectName  string            `json:"project_name"`
	TaskName     string            `json:"-"` // used internally by the Infra API
	Instances    []InstanceRequest `json:"instances"`
	WebhookURL   string            `json:"webhook_url"`
	Action       string            `json:"action"`
	Provider     models.ProviderID `json:"provider"`
	Volumes      []VolumeConfig    `json:"volumes"`
}

type ListResponse[T any] struct {
	Rows       []T                `json:"rows"`
	Pagination PaginationResponse `json:"pagination"`
}

type PaginationResponse struct {
	Total  int `json:"total"`  // Total number of values
	Page   int `json:"page"`   // Current page number
	Limit  int `json:"limit"`  // Number of items per page
	Offset int `json:"offset"` // Offset from start of results
}

type PublicIPs struct {
	PublicIP string `json:"public_ip"`
}

type PublicIPsResponse struct {
	PublicIPs  []PublicIPs        `json:"public_ips"` // List of public IPs
	Pagination PaginationResponse `json:"pagination"` // Pagination information
}

type Response struct {
	ID     uint   `json:"id"`     // ID of the infrastructure job
	Status string `json:"status"` // Status of the infrastructure job
}

type Slug string

type SlugResponse struct {
	Slug  Slug        `json:"slug"`
	Error string      `json:"error"`
	Data  interface{} `json:"data"`
}

type TaskResponse struct {
	TaskName string `json:"task_name"` // Name of the task
}

type UserResponse struct {
	// This can be a single user or null when returning multiple users
	User models.User `json:"user,omitempty"`

	// This can be an array of users or null when returning a single user
	Users []models.User `json:"users,omitempty"`

	// Pagination info included only when returning multiple users
	Pagination *PaginationResponse `json:"pagination,omitempty"`
}

type VolumeConfig struct {
	Name       string `json:"name"`        // Name of the volume
	SizeGB     int    `json:"size_gb"`     // Size in gigabytes
	Region     string `json:"region"`      // Region where to create the volume
	FileSystem string `json:"filesystem"`  // File system type (optional)
	MountPoint string `json:"mount_point"` // Where to mount the volume
}

type VolumeDetails struct {
	ID         string `json:"id"`          // Volume ID
	Name       string `json:"name"`        // Volume name
	Region     string `json:"region"`      // Region where volume was created
	SizeGB     int    `json:"size_gb"`     // Size in gigabytes
	MountPoint string `json:"mount_point"` // Where the volume is mounted
}