api

type Alert struct {
	Name        string    `json:"name" yaml:"name"`
	Title       string    `json:"title" yaml:"title"`
	Reason      string    `json:"reason" yaml:"reason"`
	Description string    `json:"description" yaml:"description"`
	StackName   string    `json:"stackName" yaml:"stackName"`
	StackEnv    string    `json:"stackEnv" yaml:"stackEnv"`
	DetailsUrl  string    `json:"detailsUrl" yaml:"detailsUrl"`
	AlertType   AlertType `json:"alertType" yaml:"alertType"`
}

type AlertSender interface {
	Send(Alert) error
}

type AlertType string

type AlertsConfig struct {
	MaxCPU    *MaxCPUConfig    `json:"maxCPU,omitempty" yaml:"maxCPU,omitempty"`
	MaxMemory *MaxMemoryConfig `json:"maxMemory,omitempty" yaml:"maxMemory,omitempty"`
	MaxErrors *MaxErrorConfig  `json:"maxErrors,omitempty" yaml:"maxErrors,omitempty"`
	Discord   *DiscordCfg      `json:"discord,omitempty" yaml:"discord,omitempty"`
	Slack     *SlackCfg        `json:"slack,omitempty" yaml:"slack,omitempty"`
	Telegram  *TelegramCfg     `json:"telegram,omitempty" yaml:"telegram,omitempty"`
}

type AuthConfig interface {
	WithProviderType
	CredentialsValue() string
	ProjectIdValue() string
}

type AuthDescriptor struct {
	Type    string `json:"type" yaml:"type"`
	Config  `json:",inline" yaml:",inline"`
	Inherit `json:",inline" yaml:",inline"`
}

type CiCdDescriptor struct {
	Type    string `json:"type" yaml:"type"`
	Config  `json:",inline" yaml:",inline"`
	Inherit `json:",inline" yaml:",inline"`
}

type ClientDescriptor struct {
	SchemaVersion string                           `json:"schemaVersion" yaml:"schemaVersion"`
	Defaults      map[string]interface{}           `json:"defaults,omitempty" yaml:"defaults,omitempty"` // Maximum flexibility - supports any user-defined YAML anchors, templates, and configuration
	Stacks        map[string]StackClientDescriptor `json:"stacks" yaml:"stacks"`
}

type CloudComposeConfigRegister map[string]ToCloudComposeConvertFunc

type CloudComposeDescriptor struct {
	StackName       string `json:"stackName" yaml:"stackName"`
	StackDescriptor `json:",inline" yaml:",inline"`
}

type CloudHelper interface {
	Run() error
	SetLogger(l logger.Logger)
}

type CloudHelperInitFunc func(opts ...CloudHelperOption) (CloudHelper, error)

type CloudHelperOption func(c CloudHelper) error

type CloudHelperType string

type CloudHelpersRegisterMap map[CloudHelperType]CloudHelperInitFunc

type CloudSingleImageConfigRegister map[string]ToCloudSingleImageConvertFunc

type CloudStaticSiteConfigRegister map[string]ToCloudStaticSiteConvertFunc

type CommonAlertConfig struct {
	Threshold   float64 `json:"threshold" yaml:"threshold"`
	PeriodSec   int     `json:"periodSec" yaml:"periodSec"`
	AlertName   string  `json:"alertName" yaml:"alertName"`
	Description string  `json:"description" yaml:"description"`
}

type ComputeEnvVariables struct {
	DiscordWebhookUrl string
	SlackWebhookUrl   string
	TelegramChatID    string
	TelegramToken     string
	AlertName         string
	AlertDescription  string
	StackName         string
	StackEnv          string
	CloudHelperType   string
	StackVersion      string
}

type Config struct {
	Config any `json:"config" yaml:"config"`
}

type ConfigFile struct {
	ProjectName        string `json:"projectName" yaml:"projectName"`
	PrivateKeyPath     string `yaml:"privateKeyPath,omitempty" json:"privateKeyPath,omitempty"`
	PublicKeyPath      string `yaml:"publicKeyPath,omitempty" json:"publicKeyPath,omitempty"`
	PrivateKey         string `yaml:"privateKey,omitempty" json:"privateKey,omitempty"`
	PrivateKeyPassword string `yaml:"privateKeyPassword,omitempty" json:"privateKeyPassword,omitempty"`
	PublicKey          string `yaml:"publicKey,omitempty" json:"publicKey,omitempty"`
	StacksDir          string `yaml:"stacksDir,omitempty" json:"stacksDir,omitempty"`
	ParentRepository   string `yaml:"parentRepository,omitempty" json:"parentRepository,omitempty"`
}

type ConfigReaderFunc func(config *Config) (Config, error)

type ConfigRegisterMap map[string]ConfigReaderFunc

type Container struct {
	ContainerImage `json:",inline" yaml:",inline"`
	Name           string `json:"name" yaml:"name"`
}

type ContainerImage struct {
	Name       string `json:"name" yaml:"name"`
	Dockerfile string `json:"dockerfile" yaml:"dockerfile"`
	Context    string `json:"context" yaml:"context"`

	Build    *ContainerImageBuild `json:"build" yaml:"build"`
	Platform ImagePlatform        `json:"platform" yaml:"platform"`
}

type ContainerImageBuild struct {
	Args map[string]string `json:"args" yaml:"args"`
}

type CorsConfig struct {
	AllowedOrigins string   `json:"allowedOrigins" yaml:"allowedOrigins"`
	AllowedMethods []string `json:"allowedMethods,omitempty" yaml:"allowedMethods"`
}

type Credentials struct {
	Credentials string `json:"credentials" yaml:"credentials"` // required for proper deserialization
}

type DeployParams struct {
	StackParams `json:",inline" yaml:",inline"`
	Vars        VariableValues `json:"vars" yaml:"vars"`
}

type DestroyParams struct {
	StackParams         `json:",inline" yaml:",inline"`
	DestroySecretsStack bool `json:"destroySecretsStack" yaml:"destroySecretsStack"`
}

type DestroyResult struct {
	Operations map[string]int `json:"operations" yaml:"operations"`
}

type DiscordCfg struct {
	WebhookUrl string `json:"webhookUrl" yaml:"webhookUrl"`
}

type DnsConfigAware interface {
	OverriddenBaseZone() string
}

type DnsRecord struct {
	Name     string           `json:"name" yaml:"name"`
	Type     string           `json:"type" yaml:"type"`
	ValueOut sdk.StringOutput `json:"valueOut" yaml:"valueOut"`
	Value    string           `json:"value" yaml:"value"`
	Proxied  bool             `json:"proxied" yaml:"proxied"`
}

type Headers map[string]string

type ImagePlatform string

type Inherit struct {
	Inherit string `json:"inherit" yaml:"inherit"`
}

type InitParams struct {
	ProjectName         string `json:"projectName" yaml:"projectName"`
	RootDir             string `json:"rootDir,omitempty" yaml:"rootDir"`
	Profile             string `json:"profile,omitempty" yaml:"profile"`
	SkipInitialCommit   bool   `json:"skipInitialCommit" yaml:"skipInitialCommit"`
	SkipProfileCreation bool   `json:"skipProfileCreation" yaml:"skipProfileCreation"`
	SkipScDirCreation   bool   `json:"skipScDirCreation" yaml:"skipScDirCreation"`
	IgnoreWorkdirErrors bool   `json:"skipCreateConfigDir" yaml:"skipCreateConfigDir"`
	GenerateKeyPair     bool   `json:"generateKeyPair" yaml:"generateKeyPair"`
}

type MaxCPUConfig struct {
	CommonAlertConfig `json:",inline" yaml:",inline"`
}

type MaxErrorConfig struct {
	CommonAlertConfig     `json:",inline" yaml:",inline"`
	ErrorLogMessageRegexp string `json:"errorLogMessageRegexp" yaml:"errorLogMessageRegexp"`
}

type MaxMemoryConfig struct {
	CommonAlertConfig `json:",inline" yaml:",inline"`
}

type OutputsResult struct {
	StackName string         `json:"stackName" yaml:"stackName"`
	Outputs   map[string]any `json:"outputs" yaml:"outputs"`
}

type ParentResourceDependency struct {
	Name string `json:"name" yaml:"name"`
}

type PerEnvResourcesDescriptor struct {
	Template  string                        `json:"template" yaml:"template"`
	Resources map[string]ResourceDescriptor `json:"resources" yaml:"resources"`
	Inherit   `json:",inline" yaml:",inline"`
}

type PerStackResourcesDescriptor struct {
	Registrar RegistrarDescriptor                  `json:"registrar" yaml:"registrar"`
	Resources map[string]PerEnvResourcesDescriptor `json:"resources" yaml:"resources"`
}

type PreviewResult struct {
	StackName  string         `json:"stackName" yaml:"stackName"`
	Summary    string         `json:"summary" yaml:"summary"`
	Operations map[string]int `json:"operations" yaml:"operations"`
}

type ProvisionParams struct {
	StacksDir   string   `json:"rootDir" yaml:"rootDir"`
	Profile     string   `json:"profile" yaml:"profile"`
	Stacks      []string `json:"stacks" yaml:"stacks"`
	SkipRefresh bool     `json:"skipRefresh" yaml:"skipRefresh"`
	SkipPreview bool     `json:"skipPreview" yaml:"skipPreview"`
	Timeouts    Timeouts `json:",inline" yaml:",inline"`
}

type Provisioner interface {
	ProvisionStack(ctx context.Context, cfg *ConfigFile, stack Stack, params ProvisionParams) error

	SetPublicKey(pubKey string)

	DeployStack(ctx context.Context, cfg *ConfigFile, stack Stack, params DeployParams) error

	DestroyChildStack(ctx context.Context, cfg *ConfigFile, stack Stack, params DestroyParams, preview bool) error

	PreviewStack(ctx context.Context, cfg *ConfigFile, parentStack Stack, params ProvisionParams) (*PreviewResult, error)

	PreviewChildStack(ctx context.Context, cfg *ConfigFile, parentStack Stack, params DeployParams) (*PreviewResult, error)

	OutputsStack(ctx context.Context, cfg *ConfigFile, stack Stack, params StackParams) (*OutputsResult, error)

	CancelStack(ctx context.Context, cfg *ConfigFile, stack Stack, params StackParams) error

	DestroyParentStack(ctx context.Context, cfg *ConfigFile, parentStack Stack, params DestroyParams, preview bool) error

	SetConfigReader(ProvisionerFieldConfigReaderFunc)
}

type ProvisionerDescriptor struct {
	Type    string `json:"type" yaml:"type"`
	Config  `json:",inline" yaml:",inline"`
	Inherit `json:",inline" yaml:",inline"`
	// contains filtered or unexported fields
}

type ProvisionerFieldConfigReadFunc func(config *Config) (Config, error)

type ProvisionerFieldConfigReaderFunc func(cType string, c *Config) (Config, error)

type ProvisionerFieldConfigRegister map[string]ProvisionerFieldConfigReadFunc

type ProvisionerInitFunc func(config Config, opts ...ProvisionerOption) (Provisioner, error)

type ProvisionerOption func(p Provisioner) error

type ProvisionerRegisterMap map[string]ProvisionerInitFunc

type ReadOpts struct {
	IgnoreServerMissing  bool
	IgnoreClientMissing  bool
	IgnoreSecretsMissing bool
	RequireClientConfigs []string
	RequireServerConfigs []string
	RequireSecretConfigs []string
}

type RefreshResult struct {
	Operations map[string]int `json:"operations" yaml:"operations"`
}

type RegistrarConfig interface {
	ProviderType() string
	DnsRecords() []DnsRecord
}

type RegistrarDescriptor struct {
	Type    string `json:"type" yaml:"type"`
	Config  `json:",inline" yaml:",inline"`
	Inherit `json:",inline" yaml:",inline"`
}

type RemoteImage struct {
	Name string `json:"name" yaml:"name"`
	Tag  string `json:"tag" yaml:"tag"`
}

type ResourceAware interface {
	Uses() []string
}

type ResourceDescriptor struct {
	Type    string `json:"type" yaml:"type"`
	Name    string `json:"name" yaml:"name"`
	Config  `json:",inline" yaml:",inline"`
	Inherit `json:",inline" yaml:",inline"`
}

type ResourceInput struct {
	Descriptor  *ResourceDescriptor `json:"descriptor" yaml:"descriptor"`
	StackParams *StackParams        `json:"deployParams" yaml:"deployParams"`
}

type ResourceOutput struct {
	Ref any `json:"ref" yaml:"ref"`
}

type SecretsConfigDescriptor struct {
	Type    string `json:"type" yaml:"type"`
	Config  `json:",inline" yaml:",inline"`
	Inherit `json:",inline" yaml:",inline"`
}

type SecretsDescriptor struct {
	SchemaVersion string                    `json:"schemaVersion" yaml:"schemaVersion"`
	Auth          map[string]AuthDescriptor `json:"auth" yaml:"auth"`
	Values        map[string]string         `json:"values" yaml:"values"`
}

type SecretsProviderConfig interface {
	AuthConfig
	IsProvisionEnabled() bool
	KeyUrl() string
}

type ServerDescriptor struct {
	SchemaVersion string                        `json:"schemaVersion" yaml:"schemaVersion"`
	Provisioner   ProvisionerDescriptor         `json:"provisioner" yaml:"provisioner"`
	Secrets       SecretsConfigDescriptor       `json:"secrets" yaml:"secrets"`
	CiCd          CiCdDescriptor                `json:"cicd" yaml:"cicd"`
	Templates     map[string]StackDescriptor    `json:"templates" yaml:"templates"`
	Resources     PerStackResourcesDescriptor   `json:"resources" yaml:"resources"`
	Variables     map[string]VariableDescriptor `json:"variables" yaml:"variables"`
}

type SimpleContainerLBConfig struct {
	Https        bool     `json:"https" yaml:"https"`
	ExtraHelpers []string `json:"extraHelpers" yaml:"extraHelpers"`
}

type SlackCfg struct {
	WebhookUrl string `json:"webhookUrl" yaml:"webhookUrl"`
}

type Stack struct {
	Name    string            `json:"name" yaml:"name"`
	Secrets SecretsDescriptor `json:"secrets" yaml:"secrets"`
	Server  ServerDescriptor  `json:"server" yaml:"server"`
	Client  ClientDescriptor  `json:"client" yaml:"client"`
}

type StackClientDescriptor struct {
	Type        string `json:"type" yaml:"type"`
	ParentStack string `json:"parent" yaml:"parent"`
	ParentEnv   string `json:"parentEnv" yaml:"parentEnv"`
	Template    string `json:"template" yaml:"template"`
	Config      Config `json:",inline" yaml:",inline"`
}

type StackConfigCompose struct {
	DockerComposeFile string                          `json:"dockerComposeFile" yaml:"dockerComposeFile"`
	Domain            string                          `json:"domain" yaml:"domain"`
	Prefix            string                          `json:"prefix" yaml:"prefix"`                   // prefix for service under LB (e.g. /<service>) default: empty
	ProxyKeepPrefix   bool                            `json:"proxyKeepPrefix" yaml:"proxyKeepPrefix"` // if prefix is specified, whether we need to keep it when proxying to service
	DomainProxied     *bool                           `json:"domainProxied" yaml:"domainProxied"`
	BaseDnsZone       string                          `json:"baseDnsZone" yaml:"baseDnsZone"` // only necessary if differs from parent stack
	Uses              []string                        `json:"uses" yaml:"uses"`
	Runs              []string                        `json:"runs" yaml:"runs"`
	Env               map[string]string               `json:"env" yaml:"env"`
	Secrets           map[string]string               `json:"secrets" yaml:"secrets"`
	Version           string                          `json:"version" yaml:"version"` // only when need to forcefully redeploy (e.g. aws secrets)
	Size              *StackConfigComposeSize         `json:"size,omitempty" yaml:"size,omitempty"`
	Scale             *StackConfigComposeScale        `json:"scale,omitempty" yaml:"scale,omitempty"`
	Dependencies      []StackConfigDependencyResource `json:"dependencies,omitempty" yaml:"dependencies,omitempty"` // when service wants to use resources from another service
	Alerts            *AlertsConfig                   `json:"alerts,omitempty" yaml:"alerts,omitempty"`
	TextVolumes       *[]TextVolume                   `json:"textVolumes" yaml:"textVolumes"`           // extra text volumes to mount to containers (e.g. for k8s deployments)
	Headers           *Headers                        `json:"headers" yaml:"headers"`                   // extra headers to add when serving requests
	LBConfig          *SimpleContainerLBConfig        `json:"lbConfig" yaml:"lbConfig"`                 // load balancer configuration (so far only applicable for k8s deployments)
	CloudExtras       *any                            `json:"cloudExtras" yaml:"cloudExtras"`           // when need to specify additional extra config for the specific cloud (e.g. AWS extra roles)
	StaticEgressIP    *bool                           `json:"staticEgressIP" yaml:"staticEgressIP"`     // when need to provision NAT with fixed egress IP address (e.g. AWS Lambda with static IP)
	ImagePullPolicy   *string                         `json:"imagePullPolicy" yaml:"imagePullPolicy"`   // applicable only for certain compute types, e.g. Kubernetes
	ClusterIPAddress  *string                         `json:"clusterIPAddress" yaml:"clusterIPAddress"` // applicable only for certain compute types, e.g. Kubernetes
}

type StackConfigComposeScale struct {
	Min int `yaml:"min" json:"min"`
	Max int `yaml:"max" json:"max"`

	Policy *StackConfigComposeScalePolicy `json:"policy" yaml:"policy"`
}

type StackConfigComposeScaleCpu struct {
	Max int `yaml:"max" json:"max"`
}

type StackConfigComposeScaleMemory struct {
	Max int `yaml:"max" json:"max"`
}

type StackConfigComposeScalePolicy struct {
	Cpu    *StackConfigComposeScaleCpu    `yaml:"cpu" json:"cpu"`
	Memory *StackConfigComposeScaleMemory `yaml:"memory" json:"memory"`
}

type StackConfigComposeSize struct {
	Name      string `yaml:"name" json:"name"`
	Cpu       string `yaml:"cpu" json:"cpu"`
	Memory    string `yaml:"memory" json:"memory"`
	Ephemeral string `yaml:"ephemeral" json:"ephemeral"`
}

type StackConfigDependencyResource struct {
	Name     string  `json:"name" yaml:"name"`
	Owner    string  `json:"owner" yaml:"owner"`
	Resource string  `json:"resource" yaml:"resource"`
	Env      *string `json:"env" yaml:"env"`
}

type StackConfigSingleImage struct {
	Image               *ContainerImage   `json:"image" yaml:"image"`
	Domain              string            `json:"domain" yaml:"domain"`
	BaseDnsZone         string            `json:"baseDnsZone" yaml:"baseDnsZone"` // only necessary if differs from parent stack
	Env                 map[string]string `json:"env" yaml:"env"`
	Secrets             map[string]string `json:"secrets" yaml:"secrets"`
	Min                 int               `yaml:"min" json:"min"`
	Max                 int               `yaml:"max" json:"max"`
	Version             string            `json:"version" yaml:"version"` // only when need to forcefully redeploy (e.g. aws secrets)
	Timeout             *int              `json:"timeout" yaml:"timeout"`
	BasePath            string            `json:"basePath" yaml:"basePath"`                       // base path where API will listen on (e.g. for aws apigateway -> lambda integration)
	MaxMemory           *int              `json:"maxMemory" yaml:"maxMemory"`                     // max memory to use for container
	MaxEphemeralStorage *int              `json:"maxEphemeralStorage" yaml:"maxEphemeralStorage"` // max ephemeral storage in MB
	Uses                []string          `json:"uses" yaml:"uses"`
	StaticEgressIP      *bool             `json:"staticEgressIP" yaml:"staticEgressIP"` // when need to provision NAT with fixed egress IP address (e.g. AWS Lambda with static IP)
	CloudExtras         *any              `json:"cloudExtras" yaml:"cloudExtras"`       // when need to specify additional extra config for the specific cloud (e.g. AWS extra roles)
}

type StackConfigStatic struct {
	BundleDir  string           `json:"bundleDir" yaml:"bundleDir"`
	Site       StaticSiteConfig `json:",inline" yaml:",inline"`
	BucketName string           `json:"bucketName" yaml:"bucketName"` // if necessary to override bucket name, only applicable in some clouds (e.g. gcp)
	Location   string           `json:"location" yaml:"location"`
}

type StackDescriptor struct {
	Type        string `json:"type" yaml:"type"`
	ParentStack string `json:"parentStack" yaml:"parentStack"`
	Config      `json:",inline" yaml:",inline"`
	Inherit     `json:",inline" yaml:",inline"`
}

type StackParams struct {
	StacksDir   string   `json:"stacksDir" yaml:"stacksDir"`
	StackDir    string   `json:"stackDir" yaml:"stackDir"`
	Profile     string   `json:"profile" yaml:"profile"`
	StackName   string   `json:"stack" yaml:"stack"`
	Environment string   `json:"environment" yaml:"environment"`
	ParentEnv   string   `json:"parentEnv" yaml:"parentEnv"`
	SkipRefresh bool     `json:"skipRefresh" yaml:"skipRefresh"`
	SkipPreview bool     `json:"skipPreview" yaml:"skipPreview"`
	Version     string   `json:"version" yaml:"version"`
	Timeouts    Timeouts `json:",inline" yaml:",inline"`
	Parent      bool     `json:"parent" yaml:"parent"`
}

type StacksMap map[string]Stack

type StateStorageConfig interface {
	AuthConfig
	StorageUrl() string
	IsProvisionEnabled() bool
}

type StaticSiteConfig struct {
	Domain             string      `json:"domain" yaml:"domain"`
	BaseDnsZone        string      `json:"baseDnsZone" yaml:"baseDnsZone"` // only necessary if differs from parent stack
	IndexDocument      string      `json:"indexDocument" yaml:"indexDocument"`
	ErrorDocument      string      `json:"errorDocument" yaml:"errorDocument"`
	ProvisionWwwDomain bool        `json:"provisionWwwDomain" yaml:"provisionWwwDomain"`
	CorsConfig         *CorsConfig `json:"corsConfig,omitempty" yaml:"corsConfig,omitempty"`
}

type TelegramCfg struct {
	ChatID string `json:"chatID" yaml:"chatID"`
	Token  string `json:"token" yaml:"token"`
}

type TextVolume struct {
	Content   string `json:"content" yaml:"content"`
	Name      string `json:"name" yaml:"name"`
	MountPath string `json:"mountPath" yaml:"mountPath"`
}

type Timeouts struct {
	ExecutionTimeout string `json:"executionTimeout" yaml:"executionTimeout"`
	PreviewTimeout   string `json:"previewTimeout" yaml:"previewTimeout"`
	DeployTimeout    string `json:"deployTimeout" yaml:"deployTimeout"`
}

type ToCloudComposeConvertFunc func(tpl any, composeCfg compose.Config, stackCfg *StackConfigCompose) (any, error)

type ToCloudSingleImageConvertFunc func(tpl any, stackCfg *StackConfigSingleImage) (any, error)

type ToCloudStaticSiteConvertFunc func(tpl any, rootDir, stackName string, stackCfg *StackConfigStatic) (any, error)

type UpdateResult struct {
	StackName  string         `json:"stackName" yaml:"stackName"`
	Summary    string         `json:"summary" yaml:"summary"`
	Operations map[string]int `json:"operations" yaml:"operations"`
}

type VariableDescriptor struct {
	Type  string `json:"type" yaml:"type"`
	Value string `json:"value" yaml:"value"`
}

type VariableValues map[string]any

type WithCopy[T any] interface {
	Copy() T
}

type WithDependencyProviders interface {
	DependencyProviders() map[string]AuthDescriptor
}

type WithDependsOnResources interface {
	DependsOnResources() []StackConfigDependencyResource
}

type WithParentDependencies interface {
	DependsOnResources() []ParentResourceDependency
}

type WithProviderType interface {
	ProviderType() string
}