types

type AppSpec struct {
	Name     string                 `json:"name,omitempty" yaml:"name,omitempty"`
	Services map[string]ServiceSpec `json:"services" yaml:"services"`
	Networks map[string]NetworkSpec `json:"networks,omitempty" yaml:"networks,omitempty"`
	Volumes  map[string]VolumeSpec  `json:"volumes,omitempty" yaml:"volumes,omitempty"`
}

type CommandValue struct {
	Shell *string  `json:"-" yaml:"-"`
	Exec  []string `json:"-" yaml:"-"`
}

type Container interface {
	ContainerInfo() *dockerContainer.InspectResponse  // Container metadata.
	ID() ContainerID                                  // Container ID.
	IsRunning() bool                                  // Check if running.
	Name() string                                     // Container name.
	ImageID() ImageID                                 // Current image ID.
	ImageName() string                                // Image name with tag.
	Enabled() (bool, bool)                            // Enabled status and presence.
	IsMonitorOnly(params UpdateParams) bool           // Monitor-only check.
	Scope() (string, bool)                            // Scope value and presence.
	Links() []string                                  // Dependency links.
	ToRestart() bool                                  // Needs restart check.
	IsWatchtower() bool                               // Watchtower instance check.
	StopSignal() string                               // Custom stop signal.
	StopTimeout() *int                                // Custom stop timeout in seconds.
	HasImageInfo() bool                               // Image metadata presence.
	ImageInfo() *dockerImage.InspectResponse          // Image metadata.
	GetLifecyclePreCheckCommand() string              // Pre-check command.
	GetLifecyclePostCheckCommand() string             // Post-check command.
	GetLifecyclePreUpdateCommand() string             // Pre-update command.
	GetLifecyclePostUpdateCommand() string            // Post-update command.
	GetLifecycleUID() (int, bool)                     // UID for lifecycle hooks, with presence.
	GetLifecycleGID() (int, bool)                     // GID for lifecycle hooks, with presence.
	VerifyConfiguration() error                       // Config validation.
	SetStale(status bool)                             // Set stale status.
	IsStale() bool                                    // Stale status check.
	IsNoPull(params UpdateParams) bool                // No-pull check.
	SetLinkedToRestarting(status bool)                // Set linked-to-restarting status.
	IsLinkedToRestarting() bool                       // Linked-to-restarting check.
	PreUpdateTimeout() int                            // Pre-update timeout.
	PostUpdateTimeout() int                           // Post-update timeout.
	IsRestarting() bool                               // Restarting status check.
	GetCreateConfig() *dockerContainer.Config         // Creation config.
	GetCreateHostConfig() *dockerContainer.HostConfig // Host creation config.
	GetContainerChain() (string, bool)                // Container chain label value and presence.
}

type ContainerID string

type ContainerReport interface {
	ID() ContainerID             // Container ID.
	Name() string                // Container name.
	CurrentImageID() ImageID     // Original image ID.
	LatestImageID() ImageID      // Latest image ID.
	ImageName() string           // Image name with tag.
	Error() string               // Error message, if any.
	State() string               // Human-readable state.
	IsMonitorOnly() bool         // Monitor-only status.
	NewContainerID() ContainerID // New container ID after update.
}

type ConvertibleNotifier interface {
	// GetURL creates a shoutrrr URL from configuration.
	//
	// Parameters:
	//   - c: Cobra command with flags.
	//
	// Returns:
	//   - string: Generated URL.
	//   - error: Non-nil if URL creation fails, nil on success.
	GetURL(c *cobra.Command) (string, error)
}

type DelayNotifier interface {
	// GetDelay returns the delay duration for notifications.
	//
	// Returns:
	//   - time.Duration: Delay before sending.
	GetDelay() time.Duration
}

type DependsOnSpec struct {
	Names  []string                     `json:"-" yaml:"-"`
	Values map[string]ServiceDependency `json:"-" yaml:"-"`
}

type Filter func(FilterableContainer) bool

type FilterableContainer interface {
	Name() string          // Container name.
	IsWatchtower() bool    // Check if Watchtower instance.
	Enabled() (bool, bool) // Enabled status and presence.
	Scope() (string, bool) // Scope value and presence.
	ImageName() string     // Image name with tag.
}

type HealthcheckSpec struct {
	Test        CommandValue `json:"test,omitempty" yaml:"test,omitempty"`
	Interval    string       `json:"interval,omitempty" yaml:"interval,omitempty"`
	Timeout     string       `json:"timeout,omitempty" yaml:"timeout,omitempty"`
	StartPeriod string       `json:"start_period,omitempty" yaml:"start_period,omitempty"`
	StartIntvl  string       `json:"start_interval,omitempty" yaml:"start_interval,omitempty"`
	Retries     uint         `json:"retries,omitempty" yaml:"retries,omitempty"`
	Disable     bool         `json:"disable,omitempty" yaml:"disable,omitempty"`
}

type ImageID string

type ImageInspector interface {
	ImageInspectWithRaw(
		ctx context.Context,
		image string,
	) (dockerImage.InspectResponse, []byte, error)
}

type MappingOrList struct {
	Mapping map[string]*string `json:"-" yaml:"-"`
	List    []string           `json:"-" yaml:"-"`
}

type NamedVolumeOptions struct {
	NoCopy  bool   `json:"nocopy,omitempty" yaml:"nocopy,omitempty"`
	SubPath string `json:"subpath,omitempty" yaml:"subpath,omitempty"`
}

type NetworkSpec struct {
	Name       string            `json:"name,omitempty" yaml:"name,omitempty"`
	Driver     string            `json:"driver,omitempty" yaml:"driver,omitempty"`
	External   bool              `json:"external,omitempty" yaml:"external,omitempty"`
	Internal   bool              `json:"internal,omitempty" yaml:"internal,omitempty"`
	Attachable bool              `json:"attachable,omitempty" yaml:"attachable,omitempty"`
	Labels     MappingOrList     `json:"labels,omitempty" yaml:"labels,omitempty"`
	DriverOpts map[string]string `json:"driver_opts,omitempty" yaml:"driver_opts,omitempty"`
}

type Notifier interface {
	StartNotification(suppressSummary bool) // Begin queuing messages.
	SendNotification(reportType Report)     // Send queued messages with report.
	AddLogHook()                            // Add as logrus hook.
	GetNames() []string                     // Service names.
	GetURLs() []string                      // Service URLs.
	Close()                                 // Stop and flush notifications.

	// GetEntries returns all queued logrus entries that have been captured during the session.
	// This is used for notification splitting by container in log mode, allowing notifiers
	// to filter and send entries specific to individual containers rather than all entries together.
	GetEntries() []*logrus.Entry

	// SendFilteredEntries sends a subset of log entries with an optional report.
	// This method enables fine-grained notifications where only entries relevant to specific
	// containers are sent, supporting the --notification-split-by-container feature in log mode.
	// The report parameter may be nil when sending filtered log entries without session context.
	SendFilteredEntries(
		entries []*logrus.Entry,
		report Report,
	)

	// ShouldSendNotification checks if a notification should be sent for the given report based on the notifier's configuration.
	ShouldSendNotification(report Report) bool
}

type PortValue struct {
	Short  string             `json:"-" yaml:"-"`
	Config *ServicePortConfig `json:"-" yaml:"-"`
}

type RegistryCredentials struct {
	Username string // Registry username.
	Password string // Registry token or password.
}

type RemovedImageInfo struct {
	// ImageID is the ID of the image that was cleaned up.
	ImageID ImageID
	// ContainerID is the ID of the container that was using this image.
	ContainerID ContainerID
	// ImageName is the name/tag of the image that was cleaned up.
	ImageName string
	// ContainerName is the name of the container that was using this image before the update.
	ContainerName string
}

type Report interface {
	Scanned() []ContainerReport   // Scanned containers.
	Updated() []ContainerReport   // Updated containers.
	Failed() []ContainerReport    // Failed containers.
	Skipped() []ContainerReport   // Skipped containers.
	Stale() []ContainerReport     // Stale containers.
	Fresh() []ContainerReport     // Fresh containers.
	Restarted() []ContainerReport // Restarted containers (linked dependencies).
	All() []ContainerReport       // All unique containers.
}

type RunConfig struct {
	// Command is the cobra.Command instance representing the executed command, providing access to parsed flags.
	Command *cobra.Command
	// Names is a slice of container names explicitly provided as positional arguments, used for filtering.
	Names []string
	// Filter is the types.Filter function determining which containers are processed during updates.
	Filter Filter
	// FilterDesc is a human-readable description of the applied filter, used in logging and notifications.
	FilterDesc string
	// RunOnce indicates whether to perform a single update and exit, set via the --run-once flag.
	RunOnce bool
	// UpdateOnStart enables an immediate update check on startup, then continues with periodic updates, set via the --update-on-start flag.
	UpdateOnStart bool
	// EnableUpdateAPI enables the HTTP update API endpoint, set via the --http-api-update flag.
	EnableUpdateAPI bool
	// EnableMetricsAPI enables the HTTP metrics API endpoint, set via the --http-api-metrics flag.
	EnableMetricsAPI bool
	// UnblockHTTPAPI allows periodic polling alongside the HTTP API, set via the --http-api-periodic-polls flag.
	UnblockHTTPAPI bool
	// APIToken is the authentication token for HTTP API access, set via the --http-api-token flag.
	APIToken string
	// APIHost is the host to bind the HTTP API to, set via the --http-api-host flag (defaults to empty string).
	APIHost string
	// APIPort is the port for the HTTP API server, set via the --http-api-port flag (defaults to "8080").
	APIPort string
	// NoStartupMessage suppresses startup messages if true, set via the --no-startup-message flag.
	NoStartupMessage bool
}

type ServiceBindOptions struct {
	CreateHostPath bool   `json:"create_host_path,omitempty" yaml:"create_host_path,omitempty"`
	Propagation    string `json:"propagation,omitempty" yaml:"propagation,omitempty"`
	Selinux        string `json:"selinux,omitempty" yaml:"selinux,omitempty"`
}

type ServiceDependency struct {
	Condition string `json:"condition,omitempty" yaml:"condition,omitempty"`
	Restart   bool   `json:"restart,omitempty" yaml:"restart,omitempty"`
	Required  *bool  `json:"required,omitempty" yaml:"required,omitempty"`
}

type ServiceNetworkAttachment struct {
	Aliases      []string `json:"aliases,omitempty" yaml:"aliases,omitempty"`
	IPv4Address  string   `json:"ipv4_address,omitempty" yaml:"ipv4_address,omitempty"`
	IPv6Address  string   `json:"ipv6_address,omitempty" yaml:"ipv6_address,omitempty"`
	LinkLocalIPs []string `json:"link_local_ips,omitempty" yaml:"link_local_ips,omitempty"`
	Priority     int      `json:"priority,omitempty" yaml:"priority,omitempty"`
}

type ServiceNetworks struct {
	Names  []string                            `json:"-" yaml:"-"`
	Values map[string]ServiceNetworkAttachment `json:"-" yaml:"-"`
}

type ServicePortConfig struct {
	Name        string `json:"name,omitempty" yaml:"name,omitempty"`
	Mode        string `json:"mode,omitempty" yaml:"mode,omitempty"`
	HostIP      string `json:"host_ip,omitempty" yaml:"host_ip,omitempty"`
	Target      uint32 `json:"target,omitempty" yaml:"target,omitempty"`
	Published   string `json:"published,omitempty" yaml:"published,omitempty"`
	Protocol    string `json:"protocol,omitempty" yaml:"protocol,omitempty"`
	AppProtocol string `json:"app_protocol,omitempty" yaml:"app_protocol,omitempty"`
}

type ServiceSpec struct {
	ContainerName string                 `json:"container_name,omitempty" yaml:"container_name,omitempty"`
	Image         string                 `json:"image,omitempty" yaml:"image,omitempty"`
	Command       CommandValue           `json:"command,omitempty" yaml:"command,omitempty"`
	Entrypoint    CommandValue           `json:"entrypoint,omitempty" yaml:"entrypoint,omitempty"`
	Environment   MappingOrList          `json:"environment,omitempty" yaml:"environment,omitempty"`
	EnvFile       StringList             `json:"env_file,omitempty" yaml:"env_file,omitempty"`
	Volumes       []VolumeValue          `json:"volumes,omitempty" yaml:"volumes,omitempty"`
	Ports         []PortValue            `json:"ports,omitempty" yaml:"ports,omitempty"`
	Restart       string                 `json:"restart,omitempty" yaml:"restart,omitempty"`
	NetworkMode   string                 `json:"network_mode,omitempty" yaml:"network_mode,omitempty"`
	Networks      ServiceNetworks        `json:"networks,omitempty" yaml:"networks,omitempty"`
	DependsOn     DependsOnSpec          `json:"depends_on,omitempty" yaml:"depends_on,omitempty"`
	Privileged    bool                   `json:"privileged,omitempty" yaml:"privileged,omitempty"`
	TTY           bool                   `json:"tty,omitempty" yaml:"tty,omitempty"`
	StdinOpen     bool                   `json:"stdin_open,omitempty" yaml:"stdin_open,omitempty"`
	WorkingDir    string                 `json:"working_dir,omitempty" yaml:"working_dir,omitempty"`
	User          string                 `json:"user,omitempty" yaml:"user,omitempty"`
	Devices       StringList             `json:"devices,omitempty" yaml:"devices,omitempty"`
	CapAdd        StringList             `json:"cap_add,omitempty" yaml:"cap_add,omitempty"`
	CapDrop       StringList             `json:"cap_drop,omitempty" yaml:"cap_drop,omitempty"`
	DNS           StringList             `json:"dns,omitempty" yaml:"dns,omitempty"`
	ExtraHosts    StringList             `json:"extra_hosts,omitempty" yaml:"extra_hosts,omitempty"`
	Labels        MappingOrList          `json:"labels,omitempty" yaml:"labels,omitempty"`
	Healthcheck   *HealthcheckSpec       `json:"healthcheck,omitempty" yaml:"healthcheck,omitempty"`
	Extensions    map[string]interface{} `json:"-" yaml:",inline"`
}

type ServiceTarget struct {
	Name    string `json:"name,omitempty" yaml:"name,omitempty"`
	Service string `json:"service,omitempty" yaml:"service,omitempty"`
}

type ServiceTmpfsOptions struct {
	Mode uint32 `json:"mode,omitempty" yaml:"mode,omitempty"`
	Size int64  `json:"size,omitempty" yaml:"size,omitempty"`
}

type ServiceVolumeConfig struct {
	Type     string               `json:"type,omitempty" yaml:"type,omitempty"`
	Source   string               `json:"source,omitempty" yaml:"source,omitempty"`
	Target   string               `json:"target,omitempty" yaml:"target,omitempty"`
	ReadOnly bool                 `json:"read_only,omitempty" yaml:"read_only,omitempty"`
	Bind     *ServiceBindOptions  `json:"bind,omitempty" yaml:"bind,omitempty"`
	Volume   *NamedVolumeOptions  `json:"volume,omitempty" yaml:"volume,omitempty"`
	Tmpfs    *ServiceTmpfsOptions `json:"tmpfs,omitempty" yaml:"tmpfs,omitempty"`
}

type StringList struct {
	Values []string `json:"-" yaml:"-"`
}

type TokenResponse struct {
	Token string `json:"token"` // Authentication token.
}

type UpdateParams struct {
	Filter             Filter        // Container filter.
	Cleanup            bool          // Remove old images if true.
	NoRestart          bool          // Skip restarts if true.
	Timeout            time.Duration // Update timeout.
	MonitorOnly        bool          // Monitor without updating if true.
	NoPull             bool          // Skip image pulls if true.
	LifecycleHooks     bool          // Enable lifecycle hooks if true.
	RollingRestart     bool          // Use rolling restart if true.
	LabelPrecedence    bool          // Prioritize labels if true.
	PullFailureDelay   time.Duration // Delay after failed self-update pull.
	LifecycleUID       int           // Default UID for lifecycle hooks.
	LifecycleGID       int           // Default GID for lifecycle hooks.
	CPUCopyMode        string        // CPU copy mode for container recreation.
	RunOnce            bool          // Run once mode if true.
	SkipSelfUpdate     bool          // Skip Watchtower self-update if true.
	CurrentContainerID ContainerID   // ID of the current container being updated.
}

type VolumeSpec struct {
	Name       string            `json:"name,omitempty" yaml:"name,omitempty"`
	Driver     string            `json:"driver,omitempty" yaml:"driver,omitempty"`
	External   bool              `json:"external,omitempty" yaml:"external,omitempty"`
	DriverOpts map[string]string `json:"driver_opts,omitempty" yaml:"driver_opts,omitempty"`
	Labels     MappingOrList     `json:"labels,omitempty" yaml:"labels,omitempty"`
}

type VolumeValue struct {
	Short  string               `json:"-" yaml:"-"`
	Config *ServiceVolumeConfig `json:"-" yaml:"-"`
}