platformimport

type APIError struct {
	Status int
	Body   string
}

type App struct {
	SourceID    string
	Name        string
	Project     string
	Environment string
	// Server names the source host the app runs on, empty when unreported.
	Server string
	// BuildPack is the source's own build method name, unmapped.
	BuildPack string
	// PrivateRepo is true when the source needs credentials to clone.
	PrivateRepo bool
	Kind        SourceKind
	Image       string
	// ImageID is the source host's local image ID, set by snapshot sources.
	ImageID string
	// SourceContainer is the running container's ID on the source host, set by live Docker sources.
	SourceContainer string
	// HostBuilt marks an image built on the source host and absent from any registry.
	HostBuilt   bool
	GitURL      string
	GitBranch   string
	BuildMethod string
	BuildPath   string
	Port        int
	Env         []Env
	Domains     []string
	Volumes     []Volume
	Replicas    int
	Health      *HealthCheck
	Crons       []Cron
	MemoryBytes int64
	NanoCPUs    int64
	Notes       []Note
}

type AppPlan struct {
	SourceID    string            `json:"source_id"`
	SourceName  string            `json:"source_name"`
	Name        string            `json:"name"`
	Image       string            `json:"image"`
	Port        int               `json:"port"`
	Env         map[string]string `json:"env,omitempty"`
	Secrets     map[string]string `json:"-"`
	Domains     []string          `json:"domains,omitempty"`
	Volumes     []VolumePlan      `json:"volumes,omitempty"`
	Replicas    int               `json:"replicas"`
	Health      *HealthPlan       `json:"health,omitempty"`
	MemoryBytes int64             `json:"memory_bytes,omitempty"`
	NanoCPUs    int64             `json:"nano_cpus,omitempty"`
	Labels      map[string]string `json:"labels"`
	Project     string            `json:"project,omitempty"`
	GitURL      string            `json:"git_url,omitempty"`
	GitBranch   string            `json:"git_branch,omitempty"`
	BuildMethod string            `json:"build_method,omitempty"`
	BuildPath   string            `json:"build_path,omitempty"`
	Crons       []CronPlan        `json:"crons,omitempty"`
	// UnreadSecrets names secret variables the source would not reveal.
	UnreadSecrets []string `json:"-"`
}

type Applier interface {
	CreateApp(ctx context.Context, p AppPlan) (warnings []string, err error)
	CreateDatabase(ctx context.Context, p DatabasePlan) (warnings []string, err error)
}

type BackupSchedule struct {
	Schedule string
	Enabled  bool
	// Remote is true when the source also uploads the backup to S3.
	Remote bool
}

type CapRoverSource struct {
	// contains filtered or unexported fields
}

type ClientOptions struct {
	Policy   NetworkPolicy
	Insecure bool
	// Team scopes a Vercel source to one team id or slug, other platforms reject it.
	Team string
}

type ComposeSource struct {
	Data []byte
}

type CoolifySource struct {
	// contains filtered or unexported fields
}

type Cron struct {
	Name     string
	Schedule string
	Command  string
}

type CronPlan struct {
	Name     string `json:"name"`
	Schedule string `json:"schedule"`
	Command  string `json:"command"`
}

type Database struct {
	SourceID string
	Name     string
	Project  string
	Engine   string
	Version  string
	// Environment and InternalHost are set by sources that give each
	// database an in-network hostname apps connect to.
	Environment  string
	InternalHost string
	// Server, User, DBName, Public and PublicPort describe how the source
	// exposes the database. No credential is ever read here.
	Server     string
	User       string
	DBName     string
	Public     bool
	PublicPort int
	Backups    []BackupSchedule
}

type DatabasePlan struct {
	SourceID   string `json:"source_id"`
	SourceName string `json:"source_name"`
	Name       string `json:"name"`
	Engine     string `json:"engine"`
	Version    string `json:"version"`
	Project    string `json:"project,omitempty"`
}

type Discovery struct {
	Platform    Platform
	Projects    []string
	Apps        []App
	Databases   []Database
	Unsupported []Unsupported
	// Services holds each one-click service's masked compose body and env.
	Services []Service
	Servers  []Server
	// Warnings are source reads that failed softly, so the plan lacks that detail.
	Warnings []string
}

type DockerSSHSource struct {
	Reader InspectReader
}

type DockerSource struct {
	Data []byte
}

type DokkuEnvSource struct {
	AppName string
	Data    string
}

type DokploySource struct {
	// contains filtered or unexported fields
}

type EmitApp struct {
	Name string
	// Image is the prebuilt image. Empty means use EmitOptions.ImageRepo.
	Image       string
	Port        int
	Replicas    int
	Env         map[string]string
	Secrets     []EmitSecret
	Domains     []string
	MemoryBytes int64
	// Memory is a ready "512Mi" string and wins over MemoryBytes.
	Memory     string
	NanoCPUs   int64
	HealthPath string
	Command    []string
	PreDeploy  string
	PostDeploy string
	// Connections maps an env var to the emitted database it reads from.
	Connections map[string]EmitConnection
	Jobs        []EmitJob
	// Notes are follow-ups for MIGRATION.md that the documents cannot express.
	Notes []string
}

type EmitConnection struct {
	Database string
	Field    string
}

type EmitDatabase struct {
	Name    string
	Engine  string
	Version string
}

type EmitFile struct {
	Name    string
	Content []byte
}

type EmitInput struct {
	// Source names where the data came from, for the checklist header.
	Source    string
	Apps      []EmitApp
	Databases []EmitDatabase
	// Notes are source-wide follow-ups for MIGRATION.md.
	Notes []string
}

type EmitJob struct {
	Name     string
	Schedule string
	Command  []string
	// Mode is "exec" to run in the app's running container; empty means a fresh one.
	Mode     string
	Timezone string
}

type EmitOptions struct {
	Stack       string
	Project     string
	Environment string
	// ImageRepo prefixes the image of an app that has none, as REPO/APP:latest.
	ImageRepo string
}

type EmitSecret struct {
	Name string
	Hint string
}

type Env struct {
	Key    string
	Value  string
	Secret bool
	// BuildTime marks a variable the source only exposes during the image build.
	BuildTime bool
}

type HealthCheck struct {
	Path            string
	IntervalSeconds int
	TimeoutSeconds  int
	Retries         int
}

type HealthPlan struct {
	Path            string
	IntervalSeconds int
	TimeoutSeconds  int
	Failures        int
}

type HerokuSource struct {
	// contains filtered or unexported fields
}

type InspectReader interface {
	InspectAll(ctx context.Context) ([]byte, error)
}

type Item struct {
	Kind       string   `json:"kind"`
	SourceID   string   `json:"source_id"`
	SourceName string   `json:"source_name"`
	Target     string   `json:"target,omitempty"`
	Status     string   `json:"status"`
	Reasons    []string `json:"reasons,omitempty"`
	Manual     []string `json:"manual,omitempty"`
}

type NetworkPolicy struct {
	AllowPrivate  bool
	AllowLoopback bool
}

type Note struct {
	// Area groups notes in the exit report, such as "webhook" or "command". Empty means general.
	Area   string
	Reason string
	Manual string
}

type Plan struct {
	Apps      []AppPlan
	Databases []DatabasePlan
	Report    Report
}

type PlanOptions struct {
	// Only restricts the plan to these source ids or source names. Empty means all.
	Only []string
	// Collision is CollisionSuffix (default) or CollisionSkip.
	Collision string
	// ExistingApps maps an import label value (platform:sourceID) to the
	// app already created for it. TakenApps is every app name in use.
	ExistingApps map[string]string
	TakenApps    map[string]bool
	// ExistingDatabases maps a database name to "engine:version".
	ExistingDatabases map[string]string
	// DBVersions is the engine version the user chose per engine, and
	// LatestDBVersions the newest catalog version per engine. Both fill in
	// databases whose source reports no version.
	DBVersions       map[string]string
	LatestDBVersions map[string]string
}

type Platform string

type RenderSource struct {
	// contains filtered or unexported fields
}

type Report struct {
	Platform Platform       `json:"platform"`
	Items    []Item         `json:"items"`
	Counts   map[string]int `json:"counts"`
	Notes    []string       `json:"notes,omitempty"`
}

type Server struct {
	Name    string
	Address string
	// Proxy names the reverse proxy the source runs there, empty when none.
	Proxy string
	// BuildServer is true when the source uses the host only to build images.
	BuildServer bool
	Reachable   bool
}

type Service struct {
	SourceID    string
	Name        string
	Project     string
	Environment string
	Server      string
	Type        string
	Compose     string
	Env         []Env
}

type Source interface {
	Discover(ctx context.Context) (*Discovery, error)
}

type SourceKind string

type Unsupported struct {
	Kind     string
	SourceID string
	Name     string
	Reason   string
	Manual   string
	// Context the source reported about the unsupported item, for display.
	Project     string
	Environment string
	Server      string
	Source      string
	Domains     []string
	Port        int
}

type VercelSource struct {

	// TeamID scopes every call to a team, empty means the token's personal account.
	TeamID string
	// contains filtered or unexported fields
}

type Volume struct {
	Name          string
	HostPath      string
	ContainerPath string
	ReadOnly      bool
	// SizeBytes is 0 when the source API does not report volume sizes.
	SizeBytes int64
}

type VolumePlan struct {
	Name          string
	HostPath      string
	ContainerPath string
	ReadOnly      bool
}